libsndfile/sndfile.h

   1 /*
   2 ** Copyright (C) 1999-2009 Erik de Castro Lopo <erikd@mega-nerd.com>
   3 **
   4 ** This program is free software; you can redistribute it and/or modify
   5 ** it under the terms of the GNU Lesser General Public License as published by
   6 ** the Free Software Foundation; either version 2.1 of the License, or
   7 ** (at your option) any later version.
   8 **
   9 ** This program is distributed in the hope that it will be useful,
  10 ** but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 ** GNU Lesser General Public License for more details.
  13 **
  14 ** You should have received a copy of the GNU Lesser General Public License
  15 ** along with this program; if not, write to the Free Software
  16 ** Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  17 */
  18
  19 /*
  20 ** sndfile.h -- system-wide definitions
  21 **
  22 ** API documentation is in the doc/ directory of the source code tarball
  23 ** and at http://www.mega-nerd.com/libsndfile/api.html.
  24 */
  25
  26 #ifndef SNDFILE_H
  27 #define SNDFILE_H
  28
  29 /* This is the version 1.0.X header file. */
  30 #define SNDFILE_1
  31
  32 #include <stdio.h>
  33 #include <sys/types.h>
  34
  35 #ifdef __cplusplus
  36 extern "C" {
  37 #endif  /* __cplusplus */
  38
  39 /* The following file types can be read and written.
  40 ** A file type would consist of a major type (ie SF_FORMAT_WAV) bitwise
  41 ** ORed with a minor type (ie SF_FORMAT_PCM). SF_FORMAT_TYPEMASK and
  42 ** SF_FORMAT_SUBMASK can be used to separate the major and minor file
  43 ** types.
  44 */
  45
  46 enum
  47 {       /* Major formats. */
  48         SF_FORMAT_WAV                   = 0x010000,             /* Microsoft WAV format (little endian default). */
  49         SF_FORMAT_AIFF                  = 0x020000,             /* Apple/SGI AIFF format (big endian). */
  50         SF_FORMAT_AU                    = 0x030000,             /* Sun/NeXT AU format (big endian). */
  51         SF_FORMAT_RAW                   = 0x040000,             /* RAW PCM data. */
  52         SF_FORMAT_PAF                   = 0x050000,             /* Ensoniq PARIS file format. */
  53         SF_FORMAT_SVX                   = 0x060000,             /* Amiga IFF / SVX8 / SV16 format. */
  54         SF_FORMAT_NIST                  = 0x070000,             /* Sphere NIST format. */
  55         SF_FORMAT_VOC                   = 0x080000,             /* VOC files. */
  56         SF_FORMAT_IRCAM                 = 0x0A0000,             /* Berkeley/IRCAM/CARL */
  57         SF_FORMAT_W64                   = 0x0B0000,             /* Sonic Foundry's 64 bit RIFF/WAV */
  58         SF_FORMAT_MAT4                  = 0x0C0000,             /* Matlab (tm) V4.2 / GNU Octave 2.0 */
  59         SF_FORMAT_MAT5                  = 0x0D0000,             /* Matlab (tm) V5.0 / GNU Octave 2.1 */
  60         SF_FORMAT_PVF                   = 0x0E0000,             /* Portable Voice Format */
  61         SF_FORMAT_XI                    = 0x0F0000,             /* Fasttracker 2 Extended Instrument */
  62         SF_FORMAT_HTK                   = 0x100000,             /* HMM Tool Kit format */
  63         SF_FORMAT_SDS                   = 0x110000,             /* Midi Sample Dump Standard */
  64         SF_FORMAT_AVR                   = 0x120000,             /* Audio Visual Research */
  65         SF_FORMAT_WAVEX                 = 0x130000,             /* MS WAVE with WAVEFORMATEX */
  66         SF_FORMAT_SD2                   = 0x160000,             /* Sound Designer 2 */
  67         SF_FORMAT_FLAC                  = 0x170000,             /* FLAC lossless file format */
  68         SF_FORMAT_CAF                   = 0x180000,             /* Core Audio File format */
  69         SF_FORMAT_WVE                   = 0x190000,             /* Psion WVE format */
  70         SF_FORMAT_OGG                   = 0x200000,             /* Xiph OGG container */
  71         SF_FORMAT_MPC2K                 = 0x210000,             /* Akai MPC 2000 sampler */
  72         SF_FORMAT_RF64                  = 0x220000,             /* RF64 WAV file */
  73
  74         /* Subtypes from here on. */
  75
  76         SF_FORMAT_PCM_S8                = 0x0001,               /* Signed 8 bit data */
  77         SF_FORMAT_PCM_16                = 0x0002,               /* Signed 16 bit data */
  78         SF_FORMAT_PCM_24                = 0x0003,               /* Signed 24 bit data */
  79         SF_FORMAT_PCM_32                = 0x0004,               /* Signed 32 bit data */
  80
  81         SF_FORMAT_PCM_U8                = 0x0005,               /* Unsigned 8 bit data (WAV and RAW only) */
  82
  83         SF_FORMAT_FLOAT                 = 0x0006,               /* 32 bit float data */
  84         SF_FORMAT_DOUBLE                = 0x0007,               /* 64 bit float data */
  85
  86         SF_FORMAT_ULAW                  = 0x0010,               /* U-Law encoded. */
  87         SF_FORMAT_ALAW                  = 0x0011,               /* A-Law encoded. */
  88         SF_FORMAT_IMA_ADPCM             = 0x0012,               /* IMA ADPCM. */
  89         SF_FORMAT_MS_ADPCM              = 0x0013,               /* Microsoft ADPCM. */
  90
  91         SF_FORMAT_GSM610                = 0x0020,               /* GSM 6.10 encoding. */
  92         SF_FORMAT_VOX_ADPCM             = 0x0021,               /* OKI / Dialogix ADPCM */
  93
  94         SF_FORMAT_G721_32               = 0x0030,               /* 32kbs G721 ADPCM encoding. */
  95         SF_FORMAT_G723_24               = 0x0031,               /* 24kbs G723 ADPCM encoding. */
  96         SF_FORMAT_G723_40               = 0x0032,               /* 40kbs G723 ADPCM encoding. */
  97
  98         SF_FORMAT_DWVW_12               = 0x0040,               /* 12 bit Delta Width Variable Word encoding. */
  99         SF_FORMAT_DWVW_16               = 0x0041,               /* 16 bit Delta Width Variable Word encoding. */
 100         SF_FORMAT_DWVW_24               = 0x0042,               /* 24 bit Delta Width Variable Word encoding. */
 101         SF_FORMAT_DWVW_N                = 0x0043,               /* N bit Delta Width Variable Word encoding. */
 102
 103         SF_FORMAT_DPCM_8                = 0x0050,               /* 8 bit differential PCM (XI only) */
 104         SF_FORMAT_DPCM_16               = 0x0051,               /* 16 bit differential PCM (XI only) */
 105
 106         SF_FORMAT_VORBIS                = 0x0060,               /* Xiph Vorbis encoding. */
 107
 108         /* Endian-ness options. */
 109
 110         SF_ENDIAN_FILE                  = 0x00000000,   /* Default file endian-ness. */
 111         SF_ENDIAN_LITTLE                = 0x10000000,   /* Force little endian-ness. */
 112         SF_ENDIAN_BIG                   = 0x20000000,   /* Force big endian-ness. */
 113         SF_ENDIAN_CPU                   = 0x30000000,   /* Force CPU endian-ness. */
 114
 115         SF_FORMAT_SUBMASK               = 0x0000FFFF,
 116         SF_FORMAT_TYPEMASK              = 0x0FFF0000,
 117         SF_FORMAT_ENDMASK               = 0x30000000
 118 } ;
 119
 120 /*
 121 ** The following are the valid command numbers for the sf_command()
 122 ** interface.  The use of these commands is documented in the file
 123 ** command.html in the doc directory of the source code distribution.
 124 */
 125
 126 enum
 127 {       SFC_GET_LIB_VERSION                             = 0x1000,
 128         SFC_GET_LOG_INFO                                = 0x1001,
 129         SFC_GET_CURRENT_SF_INFO                 = 0x1002,
 130
 131
 132         SFC_GET_NORM_DOUBLE                             = 0x1010,
 133         SFC_GET_NORM_FLOAT                              = 0x1011,
 134         SFC_SET_NORM_DOUBLE                             = 0x1012,
 135         SFC_SET_NORM_FLOAT                              = 0x1013,
 136         SFC_SET_SCALE_FLOAT_INT_READ    = 0x1014,
 137         SFC_SET_SCALE_INT_FLOAT_WRITE   = 0x1015,
 138
 139         SFC_GET_SIMPLE_FORMAT_COUNT             = 0x1020,
 140         SFC_GET_SIMPLE_FORMAT                   = 0x1021,
 141
 142         SFC_GET_FORMAT_INFO                             = 0x1028,
 143
 144         SFC_GET_FORMAT_MAJOR_COUNT              = 0x1030,
 145         SFC_GET_FORMAT_MAJOR                    = 0x1031,
 146         SFC_GET_FORMAT_SUBTYPE_COUNT    = 0x1032,
 147         SFC_GET_FORMAT_SUBTYPE                  = 0x1033,
 148
 149         SFC_CALC_SIGNAL_MAX                             = 0x1040,
 150         SFC_CALC_NORM_SIGNAL_MAX                = 0x1041,
 151         SFC_CALC_MAX_ALL_CHANNELS               = 0x1042,
 152         SFC_CALC_NORM_MAX_ALL_CHANNELS  = 0x1043,
 153         SFC_GET_SIGNAL_MAX                              = 0x1044,
 154         SFC_GET_MAX_ALL_CHANNELS                = 0x1045,
 155
 156         SFC_SET_ADD_PEAK_CHUNK                  = 0x1050,
 157         SFC_SET_ADD_HEADER_PAD_CHUNK    = 0x1051,
 158
 159         SFC_UPDATE_HEADER_NOW                   = 0x1060,
 160         SFC_SET_UPDATE_HEADER_AUTO              = 0x1061,
 161
 162         SFC_FILE_TRUNCATE                               = 0x1080,
 163
 164         SFC_SET_RAW_START_OFFSET                = 0x1090,
 165
 166         SFC_SET_DITHER_ON_WRITE                 = 0x10A0,
 167         SFC_SET_DITHER_ON_READ                  = 0x10A1,
 168
 169         SFC_GET_DITHER_INFO_COUNT               = 0x10A2,
 170         SFC_GET_DITHER_INFO                             = 0x10A3,
 171
 172         SFC_GET_EMBED_FILE_INFO                 = 0x10B0,
 173
 174         SFC_SET_CLIPPING                                = 0x10C0,
 175         SFC_GET_CLIPPING                                = 0x10C1,
 176
 177         SFC_GET_INSTRUMENT                              = 0x10D0,
 178         SFC_SET_INSTRUMENT                              = 0x10D1,
 179
 180         SFC_GET_LOOP_INFO                               = 0x10E0,
 181
 182         SFC_GET_BROADCAST_INFO                  = 0x10F0,
 183         SFC_SET_BROADCAST_INFO                  = 0x10F1,
 184
 185         SFC_GET_CHANNEL_MAP_INFO                = 0x1100,
 186         SFC_SET_CHANNEL_MAP_INFO                = 0x1101,
 187
 188         SFC_RAW_DATA_NEEDS_ENDSWAP              = 0x1110,
 189
 190         /* Support for Wavex Ambisonics Format */
 191         SFC_WAVEX_SET_AMBISONIC                 = 0x1200,
 192         SFC_WAVEX_GET_AMBISONIC                 = 0x1201,
 193
 194         SFC_SET_VBR_ENCODING_QUALITY    = 0x1300,
 195
 196         /* Following commands for testing only. */
 197         SFC_TEST_IEEE_FLOAT_REPLACE             = 0x6001,
 198
 199         /*
 200         ** SFC_SET_ADD_* values are deprecated and will disappear at some
 201         ** time in the future. They are guaranteed to be here up to and
 202         ** including version 1.0.8 to avoid breakage of existng software.
 203         ** They currently do nothing and will continue to do nothing.
 204         */
 205         SFC_SET_ADD_DITHER_ON_WRITE             = 0x1070,
 206         SFC_SET_ADD_DITHER_ON_READ              = 0x1071
 207 } ;
 208
 209
 210 /*
 211 ** String types that can be set and read from files. Not all file types
 212 ** support this and even the file types which support one, may not support
 213 ** all string types.
 214 */
 215
 216 enum
 217 {       SF_STR_TITLE                                    = 0x01,
 218         SF_STR_COPYRIGHT                                = 0x02,
 219         SF_STR_SOFTWARE                                 = 0x03,
 220         SF_STR_ARTIST                                   = 0x04,
 221         SF_STR_COMMENT                                  = 0x05,
 222         SF_STR_DATE                                             = 0x06,
 223         SF_STR_ALBUM                                    = 0x07,
 224         SF_STR_LICENSE                                  = 0x08
 225 } ;
 226
 227 /*
 228 ** Use the following as the start and end index when doing metadata
 229 ** transcoding.
 230 */
 231
 232 #define SF_STR_FIRST    SF_STR_TITLE
 233 #define SF_STR_LAST             SF_STR_LICENSE
 234
 235 enum
 236 {       /* True and false */
 237         SF_FALSE        = 0,
 238         SF_TRUE         = 1,
 239
 240         /* Modes for opening files. */
 241         SFM_READ        = 0x10,
 242         SFM_WRITE       = 0x20,
 243         SFM_RDWR        = 0x30,
 244
 245         SF_AMBISONIC_NONE               = 0x40,
 246         SF_AMBISONIC_B_FORMAT   = 0x41
 247 } ;
 248
 249 /* Public error values. These are guaranteed to remain unchanged for the duration
 250 ** of the library major version number.
 251 ** There are also a large number of private error numbers which are internal to
 252 ** the library which can change at any time.
 253 */
 254
 255 enum
 256 {       SF_ERR_NO_ERROR                         = 0,
 257         SF_ERR_UNRECOGNISED_FORMAT      = 1,
 258         SF_ERR_SYSTEM                           = 2,
 259         SF_ERR_MALFORMED_FILE           = 3,
 260         SF_ERR_UNSUPPORTED_ENCODING     = 4
 261 } ;
 262
 263
 264 /* Channel map values (used with SFC_SET/GET_CHANNEL_MAP).
 265 */
 266
 267 enum
 268 {       SF_CHANNEL_MAP_INVALID = 0,
 269         SF_CHANNEL_MAP_MONO = 1,
 270         SF_CHANNEL_MAP_LEFT,
 271         SF_CHANNEL_MAP_RIGHT,
 272         SF_CHANNEL_MAP_CENTER,
 273         SF_CHANNEL_MAP_FRONT_LEFT,
 274         SF_CHANNEL_MAP_FRONT_RIGHT,
 275         SF_CHANNEL_MAP_FRONT_CENTER,
 276         SF_CHANNEL_MAP_REAR_CENTER,
 277         SF_CHANNEL_MAP_REAR_LEFT,
 278         SF_CHANNEL_MAP_REAR_RIGHT,
 279         SF_CHANNEL_MAP_LFE,
 280         SF_CHANNEL_MAP_FRONT_LEFT_OF_CENTER,
 281         SF_CHANNEL_MAP_FRONT_RIGHT_OF_CENTER,
 282         SF_CHANNEL_MAP_SIDE_LEFT,
 283         SF_CHANNEL_MAP_SIDE_RIGHT,
 284         SF_CHANNEL_MAP_TOP_CENTER,
 285         SF_CHANNEL_MAP_TOP_FRONT_LEFT,
 286         SF_CHANNEL_MAP_TOP_FRONT_RIGHT,
 287         SF_CHANNEL_MAP_TOP_FRONT_CENTER,
 288         SF_CHANNEL_MAP_TOP_REAR_LEFT,
 289         SF_CHANNEL_MAP_TOP_REAR_RIGHT,
 290         SF_CHANNEL_MAP_TOP_REAR_CENTER
 291 } ;
 292
 293
 294 /* A SNDFILE* pointer can be passed around much like stdio.h's FILE* pointer. */
 295
 296 typedef struct SNDFILE_tag      SNDFILE ;
 297
 298 /* The following typedef is system specific and is defined when libsndfile is
 299 ** compiled. sf_count_t can be one of loff_t (Linux), off_t (*BSD), off64_t
 300 ** (Solaris), __int64_t (Win32) etc. On windows, we need to allow the same
 301 ** header file to be compiler by both GCC and the microsoft compiler.
 302 */
 303
 304 #if (defined (_MSCVER) || defined (_MSC_VER))
 305 typedef __int64_t       sf_count_t ;
 306 #define SF_COUNT_MAX            0x7fffffffffffffffi64
 307 #else
 308 typedef off_t   sf_count_t ;
 309 #define SF_COUNT_MAX            0x7FFFFFFFFFFFFFFFLL
 310 #endif
 311
 312
 313 /* A pointer to a SF_INFO structure is passed to sf_open_read () and filled in.
 314 ** On write, the SF_INFO structure is filled in by the user and passed into
 315 ** sf_open_write ().
 316 */
 317
 318 struct SF_INFO
 319 {       sf_count_t      frames ;                /* Used to be called samples.  Changed to avoid confusion. */
 320         int                     samplerate ;
 321         int                     channels ;
 322         int                     format ;
 323         int                     sections ;
 324         int                     seekable ;
 325 } ;
 326
 327 typedef struct SF_INFO SF_INFO ;
 328
 329 /* The SF_FORMAT_INFO struct is used to retrieve information about the sound
 330 ** file formats libsndfile supports using the sf_command () interface.
 331 **
 332 ** Using this interface will allow applications to support new file formats
 333 ** and encoding types when libsndfile is upgraded, without requiring
 334 ** re-compilation of the application.
 335 **
 336 ** Please consult the libsndfile documentation (particularly the information
 337 ** on the sf_command () interface) for examples of its use.
 338 */
 339
 340 typedef struct
 341 {       int                     format ;
 342         const char      *name ;
 343         const char      *extension ;
 344 } SF_FORMAT_INFO ;
 345
 346 /*
 347 ** Enums and typedefs for adding dither on read and write.
 348 ** See the html documentation for sf_command(), SFC_SET_DITHER_ON_WRITE
 349 ** and SFC_SET_DITHER_ON_READ.
 350 */
 351
 352 enum
 353 {       SFD_DEFAULT_LEVEL       = 0,
 354         SFD_CUSTOM_LEVEL        = 0x40000000,
 355
 356         SFD_NO_DITHER           = 500,
 357         SFD_WHITE                       = 501,
 358         SFD_TRIANGULAR_PDF      = 502
 359 } ;
 360
 361 typedef struct
 362 {       int                     type ;
 363         double          level ;
 364         const char      *name ;
 365 } SF_DITHER_INFO ;
 366
 367 /* Struct used to retrieve information about a file embedded within a
 368 ** larger file. See SFC_GET_EMBED_FILE_INFO.
 369 */
 370
 371 typedef struct
 372 {       sf_count_t      offset ;
 373         sf_count_t      length ;
 374 } SF_EMBED_FILE_INFO ;
 375
 376 /*
 377 **      Structs used to retrieve music sample information from a file.
 378 */
 379
 380 enum
 381 {       /*
 382         **      The loop mode field in SF_INSTRUMENT will be one of the following.
 383         */
 384         SF_LOOP_NONE = 800,
 385         SF_LOOP_FORWARD,
 386         SF_LOOP_BACKWARD,
 387         SF_LOOP_ALTERNATING
 388 } ;
 389
 390 typedef struct
 391 {       int gain ;
 392         char basenote, detune ;
 393         char velocity_lo, velocity_hi ;
 394         char key_lo, key_hi ;
 395         int loop_count ;
 396
 397         struct
 398         {       int mode ;
 399                 unsigned int start ;
 400                 unsigned int end ;
 401                 unsigned int count ;
 402         } loops [16] ; /* make variable in a sensible way */
 403 } SF_INSTRUMENT ;
 404
 405
 406
 407 /* Struct used to retrieve loop information from a file.*/
 408 typedef struct
 409 {
 410         short   time_sig_num ;  /* any positive integer    > 0  */
 411         short   time_sig_den ;  /* any positive power of 2 > 0  */
 412         int             loop_mode ;             /* see SF_LOOP enum             */
 413
 414         int             num_beats ;             /* this is NOT the amount of quarter notes !!!*/
 415                                                         /* a full bar of 4/4 is 4 beats */
 416                                                         /* a full bar of 7/8 is 7 beats */
 417
 418         float   bpm ;                   /* suggestion, as it can be calculated using other fields:*/
 419                                                         /* file's lenght, file's sampleRate and our time_sig_den*/
 420                                                         /* -> bpms are always the amount of _quarter notes_ per minute */
 421
 422         int     root_key ;                      /* MIDI note, or -1 for None */
 423         int future [6] ;
 424 } SF_LOOP_INFO ;
 425
 426
 427 /*      Struct used to retrieve broadcast (EBU) information from a file.
 428 **      Strongly (!) based on EBU "bext" chunk format used in Broadcast WAVE.
 429 */
 430 #define SF_BROADCAST_INFO_VAR(coding_hist_size) \
 431                         struct \
 432                         {       char                    description [256] ; \
 433                                 char                    originator [32] ; \
 434                                 char                    originator_reference [32] ; \
 435                                 char                    origination_date [10] ; \
 436                                 char                    origination_time [8] ; \
 437                                 unsigned int    time_reference_low ; \
 438                                 unsigned int    time_reference_high ; \
 439                                 short                   version ; \
 440                                 char                    umid [64] ; \
 441                                 char                    reserved [190] ; \
 442                                 unsigned int    coding_history_size ; \
 443                                 char                    coding_history [coding_hist_size] ; \
 444                         }
 445
 446 /* SF_BROADCAST_INFO is the above struct with coding_history field of 256 bytes. */
 447 typedef SF_BROADCAST_INFO_VAR (256) SF_BROADCAST_INFO ;
 448
 449
 450 /*      Virtual I/O functionality. */
 451
 452 typedef sf_count_t              (*sf_vio_get_filelen)   (void *user_data) ;
 453 typedef sf_count_t              (*sf_vio_seek)          (sf_count_t offset, int whence, void *user_data) ;
 454 typedef sf_count_t              (*sf_vio_read)          (void *ptr, sf_count_t count, void *user_data) ;
 455 typedef sf_count_t              (*sf_vio_write)         (const void *ptr, sf_count_t count, void *user_data) ;
 456 typedef sf_count_t              (*sf_vio_tell)          (void *user_data) ;
 457
 458 struct SF_VIRTUAL_IO
 459 {       sf_vio_get_filelen      get_filelen ;
 460         sf_vio_seek                     seek ;
 461         sf_vio_read                     read ;
 462         sf_vio_write            write ;
 463         sf_vio_tell                     tell ;
 464 } ;
 465
 466 typedef struct SF_VIRTUAL_IO SF_VIRTUAL_IO ;
 467
 468 /* Open the specified file for read, write or both. On error, this will
 469 ** return a NULL pointer. To find the error number, pass a NULL SNDFILE
 470 ** to sf_strerror ().
 471 ** All calls to sf_open() should be matched with a call to sf_close().
 472 */
 473
 474 SNDFILE*        sf_open         (const char *path, int mode, SF_INFO *sfinfo) ;
 475
 476 /* Use the existing file descriptor to create a SNDFILE object. If close_desc
 477 ** is TRUE, the file descriptor will be closed when sf_close() is called. If
 478 ** it is FALSE, the descritor will not be closed.
 479 ** When passed a descriptor like this, the library will assume that the start
 480 ** of file header is at the current file offset. This allows sound files within
 481 ** larger container files to be read and/or written.
 482 ** On error, this will return a NULL pointer. To find the error number, pass a
 483 ** NULL SNDFILE to sf_strerror ().
 484 ** All calls to sf_open_fd() should be matched with a call to sf_close().
 485
 486 */
 487
 488 SNDFILE*        sf_open_fd      (int fd, int mode, SF_INFO *sfinfo, int close_desc) ;
 489
 490 SNDFILE*        sf_open_virtual (SF_VIRTUAL_IO *sfvirtual, int mode, SF_INFO *sfinfo, void *user_data) ;
 491
 492 /* sf_error () returns a error number which can be translated to a text
 493 ** string using sf_error_number().
 494 */
 495
 496 int             sf_error                (SNDFILE *sndfile) ;
 497
 498 /* sf_strerror () returns to the caller a pointer to the current error message for
 499 ** the given SNDFILE.
 500 */
 501
 502 const char* sf_strerror (SNDFILE *sndfile) ;
 503
 504 /* sf_error_number () allows the retrieval of the error string for each internal
 505 ** error number.
 506 **
 507 */
 508
 509 const char*     sf_error_number (int errnum) ;
 510
 511 /* The following two error functions are deprecated but they will remain in the
 512 ** library for the forseeable future. The function sf_strerror() should be used
 513 ** in their place.
 514 */
 515
 516 int             sf_perror               (SNDFILE *sndfile) ;
 517 int             sf_error_str    (SNDFILE *sndfile, char* str, size_t len) ;
 518
 519
 520 /* Return TRUE if fields of the SF_INFO struct are a valid combination of values. */
 521
 522 int             sf_command      (SNDFILE *sndfile, int command, void *data, int datasize) ;
 523
 524 /* Return TRUE if fields of the SF_INFO struct are a valid combination of values. */
 525
 526 int             sf_format_check (const SF_INFO *info) ;
 527
 528 /* Seek within the waveform data chunk of the SNDFILE. sf_seek () uses
 529 ** the same values for whence (SEEK_SET, SEEK_CUR and SEEK_END) as
 530 ** stdio.h function fseek ().
 531 ** An offset of zero with whence set to SEEK_SET will position the
 532 ** read / write pointer to the first data sample.
 533 ** On success sf_seek returns the current position in (multi-channel)
 534 ** samples from the start of the file.
 535 ** Please see the libsndfile documentation for moving the read pointer
 536 ** separately from the write pointer on files open in mode SFM_RDWR.
 537 ** On error all of these functions return -1.
 538 */
 539
 540 sf_count_t      sf_seek                 (SNDFILE *sndfile, sf_count_t frames, int whence) ;
 541
 542 /* Functions for retrieving and setting string data within sound files.
 543 ** Not all file types support this features; AIFF and WAV do. For both
 544 ** functions, the str_type parameter must be one of the SF_STR_* values
 545 ** defined above.
 546 ** On error, sf_set_string() returns non-zero while sf_get_string()
 547 ** returns NULL.
 548 */
 549
 550 int sf_set_string (SNDFILE *sndfile, int str_type, const char* str) ;
 551
 552 const char* sf_get_string (SNDFILE *sndfile, int str_type) ;
 553
 554 /* Return the library version string. */
 555
 556 const char * sf_version_string (void) ;
 557
 558 /* Functions for reading/writing the waveform data of a sound file.
 559 */
 560
 561 sf_count_t      sf_read_raw             (SNDFILE *sndfile, void *ptr, sf_count_t bytes) ;
 562 sf_count_t      sf_write_raw    (SNDFILE *sndfile, const void *ptr, sf_count_t bytes) ;
 563
 564 /* Functions for reading and writing the data chunk in terms of frames.
 565 ** The number of items actually read/written = frames * number of channels.
 566 **     sf_xxxx_raw              read/writes the raw data bytes from/to the file
 567 **     sf_xxxx_short    passes data in the native short format
 568 **     sf_xxxx_int              passes data in the native int format
 569 **     sf_xxxx_float    passes data in the native float format
 570 **     sf_xxxx_double   passes data in the native double format
 571 ** All of these read/write function return number of frames read/written.
 572 */
 573
 574 sf_count_t      sf_readf_short  (SNDFILE *sndfile, short *ptr, sf_count_t frames) ;
 575 sf_count_t      sf_writef_short (SNDFILE *sndfile, const short *ptr, sf_count_t frames) ;
 576
 577 sf_count_t      sf_readf_int    (SNDFILE *sndfile, int *ptr, sf_count_t frames) ;
 578 sf_count_t      sf_writef_int   (SNDFILE *sndfile, const int *ptr, sf_count_t frames) ;
 579
 580 sf_count_t      sf_readf_float  (SNDFILE *sndfile, float *ptr, sf_count_t frames) ;
 581 sf_count_t      sf_writef_float (SNDFILE *sndfile, const float *ptr, sf_count_t frames) ;
 582
 583 sf_count_t      sf_readf_double         (SNDFILE *sndfile, double *ptr, sf_count_t frames) ;
 584 sf_count_t      sf_writef_double        (SNDFILE *sndfile, const double *ptr, sf_count_t frames) ;
 585
 586 /* Functions for reading and writing the data chunk in terms of items.
 587 ** Otherwise similar to above.
 588 ** All of these read/write function return number of items read/written.
 589 */
 590
 591 sf_count_t      sf_read_short   (SNDFILE *sndfile, short *ptr, sf_count_t items) ;
 592 sf_count_t      sf_write_short  (SNDFILE *sndfile, const short *ptr, sf_count_t items) ;
 593
 594 sf_count_t      sf_read_int             (SNDFILE *sndfile, int *ptr, sf_count_t items) ;
 595 sf_count_t      sf_write_int    (SNDFILE *sndfile, const int *ptr, sf_count_t items) ;
 596
 597 sf_count_t      sf_read_float   (SNDFILE *sndfile, float *ptr, sf_count_t items) ;
 598 sf_count_t      sf_write_float  (SNDFILE *sndfile, const float *ptr, sf_count_t items) ;
 599
 600 sf_count_t      sf_read_double  (SNDFILE *sndfile, double *ptr, sf_count_t items) ;
 601 sf_count_t      sf_write_double (SNDFILE *sndfile, const double *ptr, sf_count_t items) ;
 602
 603 /* Close the SNDFILE and clean up all memory allocations associated with this
 604 ** file.
 605 ** Returns 0 on success, or an error number.
 606 */
 607
 608 int             sf_close                (SNDFILE *sndfile) ;
 609
 610 /* If the file is opened SFM_WRITE or SFM_RDWR, call fsync() on the file
 611 ** to force the writing of data to disk. If the file is opened SFM_READ
 612 ** no action is taken.
 613 */
 614
 615 void    sf_write_sync   (SNDFILE *sndfile) ;
 616
 617 #ifdef __cplusplus
 618 }               /* extern "C" */
 619 #endif  /* __cplusplus */
 620
 621 #endif  /* SNDFILE_H */