1 /* 2 ** Copyright (C) 1999-2016 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 <stdint.h> 34 #include <sys/types.h> 35 36 #ifdef __cplusplus 37 extern "C" { 38 #endif /* __cplusplus */ 39 40 /* The following file types can be read and written. 41 ** A file type would consist of a major type (ie SF_FORMAT_WAV) bitwise 42 ** ORed with a minor type (ie SF_FORMAT_PCM). SF_FORMAT_TYPEMASK and 43 ** SF_FORMAT_SUBMASK can be used to separate the major and minor file 44 ** types. 45 */ 46 47 enum 48 { /* Major formats. */ 49 SF_FORMAT_WAV = 0x010000, /* Microsoft WAV format (little endian default). */ 50 SF_FORMAT_AIFF = 0x020000, /* Apple/SGI AIFF format (big endian). */ 51 SF_FORMAT_AU = 0x030000, /* Sun/NeXT AU format (big endian). */ 52 SF_FORMAT_RAW = 0x040000, /* RAW PCM data. */ 53 SF_FORMAT_PAF = 0x050000, /* Ensoniq PARIS file format. */ 54 SF_FORMAT_SVX = 0x060000, /* Amiga IFF / SVX8 / SV16 format. */ 55 SF_FORMAT_NIST = 0x070000, /* Sphere NIST format. */ 56 SF_FORMAT_VOC = 0x080000, /* VOC files. */ 57 SF_FORMAT_IRCAM = 0x0A0000, /* Berkeley/IRCAM/CARL */ 58 SF_FORMAT_W64 = 0x0B0000, /* Sonic Foundry's 64 bit RIFF/WAV */ 59 SF_FORMAT_MAT4 = 0x0C0000, /* Matlab (tm) V4.2 / GNU Octave 2.0 */ 60 SF_FORMAT_MAT5 = 0x0D0000, /* Matlab (tm) V5.0 / GNU Octave 2.1 */ 61 SF_FORMAT_PVF = 0x0E0000, /* Portable Voice Format */ 62 SF_FORMAT_XI = 0x0F0000, /* Fasttracker 2 Extended Instrument */ 63 SF_FORMAT_HTK = 0x100000, /* HMM Tool Kit format */ 64 SF_FORMAT_SDS = 0x110000, /* Midi Sample Dump Standard */ 65 SF_FORMAT_AVR = 0x120000, /* Audio Visual Research */ 66 SF_FORMAT_WAVEX = 0x130000, /* MS WAVE with WAVEFORMATEX */ 67 SF_FORMAT_SD2 = 0x160000, /* Sound Designer 2 */ 68 SF_FORMAT_FLAC = 0x170000, /* FLAC lossless file format */ 69 SF_FORMAT_CAF = 0x180000, /* Core Audio File format */ 70 SF_FORMAT_WVE = 0x190000, /* Psion WVE format */ 71 SF_FORMAT_OGG = 0x200000, /* Xiph OGG container */ 72 SF_FORMAT_MPC2K = 0x210000, /* Akai MPC 2000 sampler */ 73 SF_FORMAT_RF64 = 0x220000, /* RF64 WAV file */ 74 75 /* Subtypes from here on. */ 76 77 SF_FORMAT_PCM_S8 = 0x0001, /* Signed 8 bit data */ 78 SF_FORMAT_PCM_16 = 0x0002, /* Signed 16 bit data */ 79 SF_FORMAT_PCM_24 = 0x0003, /* Signed 24 bit data */ 80 SF_FORMAT_PCM_32 = 0x0004, /* Signed 32 bit data */ 81 82 SF_FORMAT_PCM_U8 = 0x0005, /* Unsigned 8 bit data (WAV and RAW only) */ 83 84 SF_FORMAT_FLOAT = 0x0006, /* 32 bit float data */ 85 SF_FORMAT_DOUBLE = 0x0007, /* 64 bit float data */ 86 87 SF_FORMAT_ULAW = 0x0010, /* U-Law encoded. */ 88 SF_FORMAT_ALAW = 0x0011, /* A-Law encoded. */ 89 SF_FORMAT_IMA_ADPCM = 0x0012, /* IMA ADPCM. */ 90 SF_FORMAT_MS_ADPCM = 0x0013, /* Microsoft ADPCM. */ 91 92 SF_FORMAT_GSM610 = 0x0020, /* GSM 6.10 encoding. */ 93 SF_FORMAT_VOX_ADPCM = 0x0021, /* OKI / Dialogix ADPCM */ 94 95 SF_FORMAT_G721_32 = 0x0030, /* 32kbs G721 ADPCM encoding. */ 96 SF_FORMAT_G723_24 = 0x0031, /* 24kbs G723 ADPCM encoding. */ 97 SF_FORMAT_G723_40 = 0x0032, /* 40kbs G723 ADPCM encoding. */ 98 99 SF_FORMAT_DWVW_12 = 0x0040, /* 12 bit Delta Width Variable Word encoding. */ 100 SF_FORMAT_DWVW_16 = 0x0041, /* 16 bit Delta Width Variable Word encoding. */ 101 SF_FORMAT_DWVW_24 = 0x0042, /* 24 bit Delta Width Variable Word encoding. */ 102 SF_FORMAT_DWVW_N = 0x0043, /* N bit Delta Width Variable Word encoding. */ 103 104 SF_FORMAT_DPCM_8 = 0x0050, /* 8 bit differential PCM (XI only) */ 105 SF_FORMAT_DPCM_16 = 0x0051, /* 16 bit differential PCM (XI only) */ 106 107 SF_FORMAT_VORBIS = 0x0060, /* Xiph Vorbis encoding. */ 108 109 SF_FORMAT_ALAC_16 = 0x0070, /* Apple Lossless Audio Codec (16 bit). */ 110 SF_FORMAT_ALAC_20 = 0x0071, /* Apple Lossless Audio Codec (20 bit). */ 111 SF_FORMAT_ALAC_24 = 0x0072, /* Apple Lossless Audio Codec (24 bit). */ 112 SF_FORMAT_ALAC_32 = 0x0073, /* Apple Lossless Audio Codec (32 bit). */ 113 114 /* Endian-ness options. */ 115 116 SF_ENDIAN_FILE = 0x00000000, /* Default file endian-ness. */ 117 SF_ENDIAN_LITTLE = 0x10000000, /* Force little endian-ness. */ 118 SF_ENDIAN_BIG = 0x20000000, /* Force big endian-ness. */ 119 SF_ENDIAN_CPU = 0x30000000, /* Force CPU endian-ness. */ 120 121 SF_FORMAT_SUBMASK = 0x0000FFFF, 122 SF_FORMAT_TYPEMASK = 0x0FFF0000, 123 SF_FORMAT_ENDMASK = 0x30000000 124 } ; 125 126 /* 127 ** The following are the valid command numbers for the sf_command() 128 ** interface. The use of these commands is documented in the file 129 ** command.html in the doc directory of the source code distribution. 130 */ 131 132 enum 133 { SFC_GET_LIB_VERSION = 0x1000, 134 SFC_GET_LOG_INFO = 0x1001, 135 SFC_GET_CURRENT_SF_INFO = 0x1002, 136 137 138 SFC_GET_NORM_DOUBLE = 0x1010, 139 SFC_GET_NORM_FLOAT = 0x1011, 140 SFC_SET_NORM_DOUBLE = 0x1012, 141 SFC_SET_NORM_FLOAT = 0x1013, 142 SFC_SET_SCALE_FLOAT_INT_READ = 0x1014, 143 SFC_SET_SCALE_INT_FLOAT_WRITE = 0x1015, 144 145 SFC_GET_SIMPLE_FORMAT_COUNT = 0x1020, 146 SFC_GET_SIMPLE_FORMAT = 0x1021, 147 148 SFC_GET_FORMAT_INFO = 0x1028, 149 150 SFC_GET_FORMAT_MAJOR_COUNT = 0x1030, 151 SFC_GET_FORMAT_MAJOR = 0x1031, 152 SFC_GET_FORMAT_SUBTYPE_COUNT = 0x1032, 153 SFC_GET_FORMAT_SUBTYPE = 0x1033, 154 155 SFC_CALC_SIGNAL_MAX = 0x1040, 156 SFC_CALC_NORM_SIGNAL_MAX = 0x1041, 157 SFC_CALC_MAX_ALL_CHANNELS = 0x1042, 158 SFC_CALC_NORM_MAX_ALL_CHANNELS = 0x1043, 159 SFC_GET_SIGNAL_MAX = 0x1044, 160 SFC_GET_MAX_ALL_CHANNELS = 0x1045, 161 162 SFC_SET_ADD_PEAK_CHUNK = 0x1050, 163 SFC_SET_ADD_HEADER_PAD_CHUNK = 0x1051, 164 165 SFC_UPDATE_HEADER_NOW = 0x1060, 166 SFC_SET_UPDATE_HEADER_AUTO = 0x1061, 167 168 SFC_FILE_TRUNCATE = 0x1080, 169 170 SFC_SET_RAW_START_OFFSET = 0x1090, 171 172 SFC_SET_DITHER_ON_WRITE = 0x10A0, 173 SFC_SET_DITHER_ON_READ = 0x10A1, 174 175 SFC_GET_DITHER_INFO_COUNT = 0x10A2, 176 SFC_GET_DITHER_INFO = 0x10A3, 177 178 SFC_GET_EMBED_FILE_INFO = 0x10B0, 179 180 SFC_SET_CLIPPING = 0x10C0, 181 SFC_GET_CLIPPING = 0x10C1, 182 183 SFC_GET_CUE_COUNT = 0x10CD, 184 SFC_GET_CUE = 0x10CE, 185 SFC_SET_CUE = 0x10CF, 186 187 SFC_GET_INSTRUMENT = 0x10D0, 188 SFC_SET_INSTRUMENT = 0x10D1, 189 190 SFC_GET_LOOP_INFO = 0x10E0, 191 192 SFC_GET_BROADCAST_INFO = 0x10F0, 193 SFC_SET_BROADCAST_INFO = 0x10F1, 194 195 SFC_GET_CHANNEL_MAP_INFO = 0x1100, 196 SFC_SET_CHANNEL_MAP_INFO = 0x1101, 197 198 SFC_RAW_DATA_NEEDS_ENDSWAP = 0x1110, 199 200 /* Support for Wavex Ambisonics Format */ 201 SFC_WAVEX_SET_AMBISONIC = 0x1200, 202 SFC_WAVEX_GET_AMBISONIC = 0x1201, 203 204 /* 205 ** RF64 files can be set so that on-close, writable files that have less 206 ** than 4GB of data in them are converted to RIFF/WAV, as per EBU 207 ** recommendations. 208 */ 209 SFC_RF64_AUTO_DOWNGRADE = 0x1210, 210 211 SFC_SET_VBR_ENCODING_QUALITY = 0x1300, 212 SFC_SET_COMPRESSION_LEVEL = 0x1301, 213 214 /* Cart Chunk support */ 215 SFC_SET_CART_INFO = 0x1400, 216 SFC_GET_CART_INFO = 0x1401, 217 218 /* Following commands for testing only. */ 219 SFC_TEST_IEEE_FLOAT_REPLACE = 0x6001, 220 221 /* 222 ** SFC_SET_ADD_* values are deprecated and will disappear at some 223 ** time in the future. They are guaranteed to be here up to and 224 ** including version 1.0.8 to avoid breakage of existing software. 225 ** They currently do nothing and will continue to do nothing. 226 */ 227 SFC_SET_ADD_DITHER_ON_WRITE = 0x1070, 228 SFC_SET_ADD_DITHER_ON_READ = 0x1071 229 } ; 230 231 232 /* 233 ** String types that can be set and read from files. Not all file types 234 ** support this and even the file types which support one, may not support 235 ** all string types. 236 */ 237 238 enum 239 { SF_STR_TITLE = 0x01, 240 SF_STR_COPYRIGHT = 0x02, 241 SF_STR_SOFTWARE = 0x03, 242 SF_STR_ARTIST = 0x04, 243 SF_STR_COMMENT = 0x05, 244 SF_STR_DATE = 0x06, 245 SF_STR_ALBUM = 0x07, 246 SF_STR_LICENSE = 0x08, 247 SF_STR_TRACKNUMBER = 0x09, 248 SF_STR_GENRE = 0x10 249 } ; 250 251 /* 252 ** Use the following as the start and end index when doing metadata 253 ** transcoding. 254 */ 255 256 #define SF_STR_FIRST SF_STR_TITLE 257 #define SF_STR_LAST SF_STR_GENRE 258 259 enum 260 { /* True and false */ 261 SF_FALSE = 0, 262 SF_TRUE = 1, 263 264 /* Modes for opening files. */ 265 SFM_READ = 0x10, 266 SFM_WRITE = 0x20, 267 SFM_RDWR = 0x30, 268 269 SF_AMBISONIC_NONE = 0x40, 270 SF_AMBISONIC_B_FORMAT = 0x41 271 } ; 272 273 /* Public error values. These are guaranteed to remain unchanged for the duration 274 ** of the library major version number. 275 ** There are also a large number of private error numbers which are internal to 276 ** the library which can change at any time. 277 */ 278 279 enum 280 { SF_ERR_NO_ERROR = 0, 281 SF_ERR_UNRECOGNISED_FORMAT = 1, 282 SF_ERR_SYSTEM = 2, 283 SF_ERR_MALFORMED_FILE = 3, 284 SF_ERR_UNSUPPORTED_ENCODING = 4 285 } ; 286 287 288 /* Channel map values (used with SFC_SET/GET_CHANNEL_MAP). 289 */ 290 291 enum 292 { SF_CHANNEL_MAP_INVALID = 0, 293 SF_CHANNEL_MAP_MONO = 1, 294 SF_CHANNEL_MAP_LEFT, /* Apple calls this 'Left' */ 295 SF_CHANNEL_MAP_RIGHT, /* Apple calls this 'Right' */ 296 SF_CHANNEL_MAP_CENTER, /* Apple calls this 'Center' */ 297 SF_CHANNEL_MAP_FRONT_LEFT, 298 SF_CHANNEL_MAP_FRONT_RIGHT, 299 SF_CHANNEL_MAP_FRONT_CENTER, 300 SF_CHANNEL_MAP_REAR_CENTER, /* Apple calls this 'Center Surround', Msft calls this 'Back Center' */ 301 SF_CHANNEL_MAP_REAR_LEFT, /* Apple calls this 'Left Surround', Msft calls this 'Back Left' */ 302 SF_CHANNEL_MAP_REAR_RIGHT, /* Apple calls this 'Right Surround', Msft calls this 'Back Right' */ 303 SF_CHANNEL_MAP_LFE, /* Apple calls this 'LFEScreen', Msft calls this 'Low Frequency' */ 304 SF_CHANNEL_MAP_FRONT_LEFT_OF_CENTER, /* Apple calls this 'Left Center' */ 305 SF_CHANNEL_MAP_FRONT_RIGHT_OF_CENTER, /* Apple calls this 'Right Center */ 306 SF_CHANNEL_MAP_SIDE_LEFT, /* Apple calls this 'Left Surround Direct' */ 307 SF_CHANNEL_MAP_SIDE_RIGHT, /* Apple calls this 'Right Surround Direct' */ 308 SF_CHANNEL_MAP_TOP_CENTER, /* Apple calls this 'Top Center Surround' */ 309 SF_CHANNEL_MAP_TOP_FRONT_LEFT, /* Apple calls this 'Vertical Height Left' */ 310 SF_CHANNEL_MAP_TOP_FRONT_RIGHT, /* Apple calls this 'Vertical Height Right' */ 311 SF_CHANNEL_MAP_TOP_FRONT_CENTER, /* Apple calls this 'Vertical Height Center' */ 312 SF_CHANNEL_MAP_TOP_REAR_LEFT, /* Apple and MS call this 'Top Back Left' */ 313 SF_CHANNEL_MAP_TOP_REAR_RIGHT, /* Apple and MS call this 'Top Back Right' */ 314 SF_CHANNEL_MAP_TOP_REAR_CENTER, /* Apple and MS call this 'Top Back Center' */ 315 316 SF_CHANNEL_MAP_AMBISONIC_B_W, 317 SF_CHANNEL_MAP_AMBISONIC_B_X, 318 SF_CHANNEL_MAP_AMBISONIC_B_Y, 319 SF_CHANNEL_MAP_AMBISONIC_B_Z, 320 321 SF_CHANNEL_MAP_MAX 322 } ; 323 324 325 /* A SNDFILE* pointer can be passed around much like stdio.h's FILE* pointer. */ 326 327 typedef struct SNDFILE_tag SNDFILE ; 328 329 /* The following typedef is system specific and is defined when libsndfile is 330 ** compiled. sf_count_t will be a 64 bit value when the underlying OS allows 331 ** 64 bit file offsets. 332 ** On windows, we need to allow the same header file to be compiler by both GCC 333 ** and the Microsoft compiler. 334 */ 335 336 #if (defined (_MSCVER) || defined (_MSC_VER) && (_MSC_VER < 1310)) 337 typedef __int64 sf_count_t ; 338 #define SF_COUNT_MAX 0x7fffffffffffffffi64 339 #else 340 typedef int64_t sf_count_t ; 341 #define SF_COUNT_MAX 0x7FFFFFFFFFFFFFFFLL 342 #endif 343 344 345 /* A pointer to a SF_INFO structure is passed to sf_open () and filled in. 346 ** On write, the SF_INFO structure is filled in by the user and passed into 347 ** sf_open (). 348 */ 349 350 struct SF_INFO 351 { sf_count_t frames ; /* Used to be called samples. Changed to avoid confusion. */ 352 int samplerate ; 353 int channels ; 354 int format ; 355 int sections ; 356 int seekable ; 357 } ; 358 359 typedef struct SF_INFO SF_INFO ; 360 361 /* The SF_FORMAT_INFO struct is used to retrieve information about the sound 362 ** file formats libsndfile supports using the sf_command () interface. 363 ** 364 ** Using this interface will allow applications to support new file formats 365 ** and encoding types when libsndfile is upgraded, without requiring 366 ** re-compilation of the application. 367 ** 368 ** Please consult the libsndfile documentation (particularly the information 369 ** on the sf_command () interface) for examples of its use. 370 */ 371 372 typedef struct 373 { int format ; 374 const char *name ; 375 const char *extension ; 376 } SF_FORMAT_INFO ; 377 378 /* 379 ** Enums and typedefs for adding dither on read and write. 380 ** See the html documentation for sf_command(), SFC_SET_DITHER_ON_WRITE 381 ** and SFC_SET_DITHER_ON_READ. 382 */ 383 384 enum 385 { SFD_DEFAULT_LEVEL = 0, 386 SFD_CUSTOM_LEVEL = 0x40000000, 387 388 SFD_NO_DITHER = 500, 389 SFD_WHITE = 501, 390 SFD_TRIANGULAR_PDF = 502 391 } ; 392 393 typedef struct 394 { int type ; 395 double level ; 396 const char *name ; 397 } SF_DITHER_INFO ; 398 399 /* Struct used to retrieve information about a file embedded within a 400 ** larger file. See SFC_GET_EMBED_FILE_INFO. 401 */ 402 403 typedef struct 404 { sf_count_t offset ; 405 sf_count_t length ; 406 } SF_EMBED_FILE_INFO ; 407 408 /* 409 ** Struct used to retrieve cue marker information from a file 410 */ 411 412 typedef struct 413 { int32_t indx ; 414 uint32_t position ; 415 int32_t fcc_chunk ; 416 int32_t chunk_start ; 417 int32_t block_start ; 418 uint32_t sample_offset ; 419 char name [256] ; 420 } SF_CUE_POINT ; 421 422 #define SF_CUES_VAR(count) \ 423 struct \ 424 { uint32_t cue_count ; \ 425 SF_CUE_POINT cue_points [count] ; \ 426 } 427 428 typedef SF_CUES_VAR (100) SF_CUES ; 429 430 /* 431 ** Structs used to retrieve music sample information from a file. 432 */ 433 434 enum 435 { /* 436 ** The loop mode field in SF_INSTRUMENT will be one of the following. 437 */ 438 SF_LOOP_NONE = 800, 439 SF_LOOP_FORWARD, 440 SF_LOOP_BACKWARD, 441 SF_LOOP_ALTERNATING 442 } ; 443 444 typedef struct 445 { int gain ; 446 char basenote, detune ; 447 char velocity_lo, velocity_hi ; 448 char key_lo, key_hi ; 449 int loop_count ; 450 451 struct 452 { int mode ; 453 uint32_t start ; 454 uint32_t end ; 455 uint32_t count ; 456 } loops [16] ; /* make variable in a sensible way */ 457 } SF_INSTRUMENT ; 458 459 460 461 /* Struct used to retrieve loop information from a file.*/ 462 typedef struct 463 { 464 short time_sig_num ; /* any positive integer > 0 */ 465 short time_sig_den ; /* any positive power of 2 > 0 */ 466 int loop_mode ; /* see SF_LOOP enum */ 467 468 int num_beats ; /* this is NOT the amount of quarter notes !!!*/ 469 /* a full bar of 4/4 is 4 beats */ 470 /* a full bar of 7/8 is 7 beats */ 471 472 float bpm ; /* suggestion, as it can be calculated using other fields:*/ 473 /* file's length, file's sampleRate and our time_sig_den*/ 474 /* -> bpms are always the amount of _quarter notes_ per minute */ 475 476 int root_key ; /* MIDI note, or -1 for None */ 477 int future [6] ; 478 } SF_LOOP_INFO ; 479 480 481 /* Struct used to retrieve broadcast (EBU) information from a file. 482 ** Strongly (!) based on EBU "bext" chunk format used in Broadcast WAVE. 483 */ 484 #define SF_BROADCAST_INFO_VAR(coding_hist_size) \ 485 struct \ 486 { char description [256] ; \ 487 char originator [32] ; \ 488 char originator_reference [32] ; \ 489 char origination_date [10] ; \ 490 char origination_time [8] ; \ 491 uint32_t time_reference_low ; \ 492 uint32_t time_reference_high ; \ 493 short version ; \ 494 char umid [64] ; \ 495 char reserved [190] ; \ 496 uint32_t coding_history_size ; \ 497 char coding_history [coding_hist_size] ; \ 498 } 499 500 /* SF_BROADCAST_INFO is the above struct with coding_history field of 256 bytes. */ 501 typedef SF_BROADCAST_INFO_VAR (256) SF_BROADCAST_INFO ; 502 503 struct SF_CART_TIMER 504 { char usage [4] ; 505 int32_t value ; 506 } ; 507 508 typedef struct SF_CART_TIMER SF_CART_TIMER ; 509 510 #define SF_CART_INFO_VAR(p_tag_text_size) \ 511 struct \ 512 { char version [4] ; \ 513 char title [64] ; \ 514 char artist [64] ; \ 515 char cut_id [64] ; \ 516 char client_id [64] ; \ 517 char category [64] ; \ 518 char classification [64] ; \ 519 char out_cue [64] ; \ 520 char start_date [10] ; \ 521 char start_time [8] ; \ 522 char end_date [10] ; \ 523 char end_time [8] ; \ 524 char producer_app_id [64] ; \ 525 char producer_app_version [64] ; \ 526 char user_def [64] ; \ 527 int32_t level_reference ; \ 528 SF_CART_TIMER post_timers [8] ; \ 529 char reserved [276] ; \ 530 char url [1024] ; \ 531 uint32_t tag_text_size ; \ 532 char tag_text [p_tag_text_size] ; \ 533 } 534 535 typedef SF_CART_INFO_VAR (256) SF_CART_INFO ; 536 537 /* Virtual I/O functionality. */ 538 539 typedef sf_count_t (*sf_vio_get_filelen) (void *user_data) ; 540 typedef sf_count_t (*sf_vio_seek) (sf_count_t offset, int whence, void *user_data) ; 541 typedef sf_count_t (*sf_vio_read) (void *ptr, sf_count_t count, void *user_data) ; 542 typedef sf_count_t (*sf_vio_write) (const void *ptr, sf_count_t count, void *user_data) ; 543 typedef sf_count_t (*sf_vio_tell) (void *user_data) ; 544 545 struct SF_VIRTUAL_IO 546 { sf_vio_get_filelen get_filelen ; 547 sf_vio_seek seek ; 548 sf_vio_read read ; 549 sf_vio_write write ; 550 sf_vio_tell tell ; 551 } ; 552 553 typedef struct SF_VIRTUAL_IO SF_VIRTUAL_IO ; 554 555 556 /* Open the specified file for read, write or both. On error, this will 557 ** return a NULL pointer. To find the error number, pass a NULL SNDFILE 558 ** to sf_strerror (). 559 ** All calls to sf_open() should be matched with a call to sf_close(). 560 */ 561 562 SNDFILE* sf_open (const char *path, int mode, SF_INFO *sfinfo) ; 563 564 565 /* Use the existing file descriptor to create a SNDFILE object. If close_desc 566 ** is TRUE, the file descriptor will be closed when sf_close() is called. If 567 ** it is FALSE, the descriptor will not be closed. 568 ** When passed a descriptor like this, the library will assume that the start 569 ** of file header is at the current file offset. This allows sound files within 570 ** larger container files to be read and/or written. 571 ** On error, this will return a NULL pointer. To find the error number, pass a 572 ** NULL SNDFILE to sf_strerror (). 573 ** All calls to sf_open_fd() should be matched with a call to sf_close(). 574 575 */ 576 577 SNDFILE* sf_open_fd (int fd, int mode, SF_INFO *sfinfo, int close_desc) ; 578 579 SNDFILE* sf_open_virtual (SF_VIRTUAL_IO *sfvirtual, int mode, SF_INFO *sfinfo, void *user_data) ; 580 581 582 /* sf_error () returns a error number which can be translated to a text 583 ** string using sf_error_number(). 584 */ 585 586 int sf_error (SNDFILE *sndfile) ; 587 588 589 /* sf_strerror () returns to the caller a pointer to the current error message for 590 ** the given SNDFILE. 591 */ 592 593 const char* sf_strerror (SNDFILE *sndfile) ; 594 595 596 /* sf_error_number () allows the retrieval of the error string for each internal 597 ** error number. 598 ** 599 */ 600 601 const char* sf_error_number (int errnum) ; 602 603 604 /* The following two error functions are deprecated but they will remain in the 605 ** library for the foreseeable future. The function sf_strerror() should be used 606 ** in their place. 607 */ 608 609 int sf_perror (SNDFILE *sndfile) ; 610 int sf_error_str (SNDFILE *sndfile, char* str, size_t len) ; 611 612 613 /* Return TRUE if fields of the SF_INFO struct are a valid combination of values. */ 614 615 int sf_command (SNDFILE *sndfile, int command, void *data, int datasize) ; 616 617 618 /* Return TRUE if fields of the SF_INFO struct are a valid combination of values. */ 619 620 int sf_format_check (const SF_INFO *info) ; 621 622 623 /* Seek within the waveform data chunk of the SNDFILE. sf_seek () uses 624 ** the same values for whence (SEEK_SET, SEEK_CUR and SEEK_END) as 625 ** stdio.h function fseek (). 626 ** An offset of zero with whence set to SEEK_SET will position the 627 ** read / write pointer to the first data sample. 628 ** On success sf_seek returns the current position in (multi-channel) 629 ** samples from the start of the file. 630 ** Please see the libsndfile documentation for moving the read pointer 631 ** separately from the write pointer on files open in mode SFM_RDWR. 632 ** On error all of these functions return -1. 633 */ 634 635 enum 636 { SF_SEEK_SET = SEEK_SET, 637 SF_SEEK_CUR = SEEK_CUR, 638 SF_SEEK_END = SEEK_END 639 } ; 640 641 sf_count_t sf_seek (SNDFILE *sndfile, sf_count_t frames, int whence) ; 642 643 644 /* Functions for retrieving and setting string data within sound files. 645 ** Not all file types support this features; AIFF and WAV do. For both 646 ** functions, the str_type parameter must be one of the SF_STR_* values 647 ** defined above. 648 ** On error, sf_set_string() returns non-zero while sf_get_string() 649 ** returns NULL. 650 */ 651 652 int sf_set_string (SNDFILE *sndfile, int str_type, const char* str) ; 653 654 const char* sf_get_string (SNDFILE *sndfile, int str_type) ; 655 656 657 /* Return the library version string. */ 658 659 const char * sf_version_string (void) ; 660 661 /* Return the current byterate at this point in the file. The byte rate in this 662 ** case is the number of bytes per second of audio data. For instance, for a 663 ** stereo, 18 bit PCM encoded file with an 16kHz sample rate, the byte rate 664 ** would be 2 (stereo) * 2 (two bytes per sample) * 16000 => 64000 bytes/sec. 665 ** For some file formats the returned value will be accurate and exact, for some 666 ** it will be a close approximation, for some it will be the average bitrate for 667 ** the whole file and for some it will be a time varying value that was accurate 668 ** when the file was most recently read or written. 669 ** To get the bitrate, multiple this value by 8. 670 ** Returns -1 for unknown. 671 */ 672 int sf_current_byterate (SNDFILE *sndfile) ; 673 674 /* Functions for reading/writing the waveform data of a sound file. 675 */ 676 677 sf_count_t sf_read_raw (SNDFILE *sndfile, void *ptr, sf_count_t bytes) ; 678 sf_count_t sf_write_raw (SNDFILE *sndfile, const void *ptr, sf_count_t bytes) ; 679 680 681 /* Functions for reading and writing the data chunk in terms of frames. 682 ** The number of items actually read/written = frames * number of channels. 683 ** sf_xxxx_raw read/writes the raw data bytes from/to the file 684 ** sf_xxxx_short passes data in the native short format 685 ** sf_xxxx_int passes data in the native int format 686 ** sf_xxxx_float passes data in the native float format 687 ** sf_xxxx_double passes data in the native double format 688 ** All of these read/write function return number of frames read/written. 689 */ 690 691 sf_count_t sf_readf_short (SNDFILE *sndfile, short *ptr, sf_count_t frames) ; 692 sf_count_t sf_writef_short (SNDFILE *sndfile, const short *ptr, sf_count_t frames) ; 693 694 sf_count_t sf_readf_int (SNDFILE *sndfile, int *ptr, sf_count_t frames) ; 695 sf_count_t sf_writef_int (SNDFILE *sndfile, const int *ptr, sf_count_t frames) ; 696 697 sf_count_t sf_readf_float (SNDFILE *sndfile, float *ptr, sf_count_t frames) ; 698 sf_count_t sf_writef_float (SNDFILE *sndfile, const float *ptr, sf_count_t frames) ; 699 700 sf_count_t sf_readf_double (SNDFILE *sndfile, double *ptr, sf_count_t frames) ; 701 sf_count_t sf_writef_double (SNDFILE *sndfile, const double *ptr, sf_count_t frames) ; 702 703 704 /* Functions for reading and writing the data chunk in terms of items. 705 ** Otherwise similar to above. 706 ** All of these read/write function return number of items read/written. 707 */ 708 709 sf_count_t sf_read_short (SNDFILE *sndfile, short *ptr, sf_count_t items) ; 710 sf_count_t sf_write_short (SNDFILE *sndfile, const short *ptr, sf_count_t items) ; 711 712 sf_count_t sf_read_int (SNDFILE *sndfile, int *ptr, sf_count_t items) ; 713 sf_count_t sf_write_int (SNDFILE *sndfile, const int *ptr, sf_count_t items) ; 714 715 sf_count_t sf_read_float (SNDFILE *sndfile, float *ptr, sf_count_t items) ; 716 sf_count_t sf_write_float (SNDFILE *sndfile, const float *ptr, sf_count_t items) ; 717 718 sf_count_t sf_read_double (SNDFILE *sndfile, double *ptr, sf_count_t items) ; 719 sf_count_t sf_write_double (SNDFILE *sndfile, const double *ptr, sf_count_t items) ; 720 721 722 /* Close the SNDFILE and clean up all memory allocations associated with this 723 ** file. 724 ** Returns 0 on success, or an error number. 725 */ 726 727 int sf_close (SNDFILE *sndfile) ; 728 729 730 /* If the file is opened SFM_WRITE or SFM_RDWR, call fsync() on the file 731 ** to force the writing of data to disk. If the file is opened SFM_READ 732 ** no action is taken. 733 */ 734 735 void sf_write_sync (SNDFILE *sndfile) ; 736 737 738 739 /* The function sf_wchar_open() is Windows Only! 740 ** Open a file passing in a Windows Unicode filename. Otherwise, this is 741 ** the same as sf_open(). 742 ** 743 ** In order for this to work, you need to do the following: 744 ** 745 ** #include <windows.h> 746 ** #define ENABLE_SNDFILE_WINDOWS_PROTOTYPES 1 747 ** #including <sndfile.h> 748 */ 749 750 #if (defined (ENABLE_SNDFILE_WINDOWS_PROTOTYPES) && ENABLE_SNDFILE_WINDOWS_PROTOTYPES) 751 SNDFILE* sf_wchar_open (LPCWSTR wpath, int mode, SF_INFO *sfinfo) ; 752 #endif 753 754 755 756 757 /* Getting and setting of chunks from within a sound file. 758 ** 759 ** These functions allow the getting and setting of chunks within a sound file 760 ** (for those formats which allow it). 761 ** 762 ** These functions fail safely. Specifically, they will not allow you to overwrite 763 ** existing chunks or add extra versions of format specific reserved chunks but 764 ** should allow you to retrieve any and all chunks (may not be implemented for 765 ** all chunks or all file formats). 766 */ 767 768 struct SF_CHUNK_INFO 769 { char id [64] ; /* The chunk identifier. */ 770 unsigned id_size ; /* The size of the chunk identifier. */ 771 unsigned datalen ; /* The size of that data. */ 772 void *data ; /* Pointer to the data. */ 773 } ; 774 775 typedef struct SF_CHUNK_INFO SF_CHUNK_INFO ; 776 777 /* Set the specified chunk info (must be done before any audio data is written 778 ** to the file). This will fail for format specific reserved chunks. 779 ** The chunk_info->data pointer must be valid until the file is closed. 780 ** Returns SF_ERR_NO_ERROR on success or non-zero on failure. 781 */ 782 int sf_set_chunk (SNDFILE * sndfile, const SF_CHUNK_INFO * chunk_info) ; 783 784 /* 785 ** An opaque structure to an iterator over the all chunks of a given id 786 */ 787 typedef struct SF_CHUNK_ITERATOR SF_CHUNK_ITERATOR ; 788 789 /* Get an iterator for all chunks matching chunk_info. 790 ** The iterator will point to the first chunk matching chunk_info. 791 ** Chunks are matching, if (chunk_info->id) matches the first 792 ** (chunk_info->id_size) bytes of a chunk found in the SNDFILE* handle. 793 ** If chunk_info is NULL, an iterator to all chunks in the SNDFILE* handle 794 ** is returned. 795 ** The values of chunk_info->datalen and chunk_info->data are ignored. 796 ** If no matching chunks are found in the sndfile, NULL is returned. 797 ** The returned iterator will stay valid until one of the following occurs: 798 ** a) The sndfile is closed. 799 ** b) A new chunk is added using sf_set_chunk(). 800 ** c) Another chunk iterator function is called on the same SNDFILE* handle 801 ** that causes the iterator to be modified. 802 ** The memory for the iterator belongs to the SNDFILE* handle and is freed when 803 ** sf_close() is called. 804 */ 805 SF_CHUNK_ITERATOR * 806 sf_get_chunk_iterator (SNDFILE * sndfile, const SF_CHUNK_INFO * chunk_info) ; 807 808 /* Iterate through chunks by incrementing the iterator. 809 ** Increments the iterator and returns a handle to the new one. 810 ** After this call, iterator will no longer be valid, and you must use the 811 ** newly returned handle from now on. 812 ** The returned handle can be used to access the next chunk matching 813 ** the criteria as defined in sf_get_chunk_iterator(). 814 ** If iterator points to the last chunk, this will free all resources 815 ** associated with iterator and return NULL. 816 ** The returned iterator will stay valid until sf_get_chunk_iterator_next 817 ** is called again, the sndfile is closed or a new chunk us added. 818 */ 819 SF_CHUNK_ITERATOR * 820 sf_next_chunk_iterator (SF_CHUNK_ITERATOR * iterator) ; 821 822 823 /* Get the size of the specified chunk. 824 ** If the specified chunk exists, the size will be returned in the 825 ** datalen field of the SF_CHUNK_INFO struct. 826 ** Additionally, the id of the chunk will be copied to the id 827 ** field of the SF_CHUNK_INFO struct and it's id_size field will 828 ** be updated accordingly. 829 ** If the chunk doesn't exist chunk_info->datalen will be zero, and the 830 ** id and id_size fields will be undefined. 831 ** The function will return SF_ERR_NO_ERROR on success or non-zero on 832 ** failure. 833 */ 834 int 835 sf_get_chunk_size (const SF_CHUNK_ITERATOR * it, SF_CHUNK_INFO * chunk_info) ; 836 837 /* Get the specified chunk data. 838 ** If the specified chunk exists, up to chunk_info->datalen bytes of 839 ** the chunk data will be copied into the chunk_info->data buffer 840 ** (allocated by the caller) and the chunk_info->datalen field 841 ** updated to reflect the size of the data. The id and id_size 842 ** field will be updated according to the retrieved chunk 843 ** If the chunk doesn't exist chunk_info->datalen will be zero, and the 844 ** id and id_size fields will be undefined. 845 ** The function will return SF_ERR_NO_ERROR on success or non-zero on 846 ** failure. 847 */ 848 int 849 sf_get_chunk_data (const SF_CHUNK_ITERATOR * it, SF_CHUNK_INFO * chunk_info) ; 850 851 852 #ifdef __cplusplus 853 } /* extern "C" */ 854 #endif /* __cplusplus */ 855 856 #endif /* SNDFILE_H */ 857 858