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