cannam@91: /* cannam@91: ** Copyright (C) 1999-2011Erik de Castro Lopo cannam@91: ** cannam@91: ** This program is free software; you can redistribute it and/or modify cannam@91: ** it under the terms of the GNU Lesser General Public License as published by cannam@91: ** the Free Software Foundation; either version 2.1 of the License, or cannam@91: ** (at your option) any later version. cannam@91: ** cannam@91: ** This program is distributed in the hope that it will be useful, cannam@91: ** but WITHOUT ANY WARRANTY; without even the implied warranty of cannam@91: ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the cannam@91: ** GNU Lesser General Public License for more details. cannam@91: ** cannam@91: ** You should have received a copy of the GNU Lesser General Public License cannam@91: ** along with this program; if not, write to the Free Software cannam@91: ** Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. cannam@91: */ cannam@91: cannam@91: /* cannam@91: ** sndfile.h -- system-wide definitions cannam@91: ** cannam@91: ** API documentation is in the doc/ directory of the source code tarball cannam@91: ** and at http://www.mega-nerd.com/libsndfile/api.html. cannam@91: */ cannam@91: cannam@91: #ifndef SNDFILE_H cannam@91: #define SNDFILE_H cannam@91: cannam@91: /* This is the version 1.0.X header file. */ cannam@91: #define SNDFILE_1 cannam@91: cannam@91: #include cannam@91: #include cannam@91: cannam@91: #ifdef __cplusplus cannam@91: extern "C" { cannam@91: #endif /* __cplusplus */ cannam@91: cannam@91: /* The following file types can be read and written. cannam@91: ** A file type would consist of a major type (ie SF_FORMAT_WAV) bitwise cannam@91: ** ORed with a minor type (ie SF_FORMAT_PCM). SF_FORMAT_TYPEMASK and cannam@91: ** SF_FORMAT_SUBMASK can be used to separate the major and minor file cannam@91: ** types. cannam@91: */ cannam@91: cannam@91: enum cannam@91: { /* Major formats. */ cannam@91: SF_FORMAT_WAV = 0x010000, /* Microsoft WAV format (little endian default). */ cannam@91: SF_FORMAT_AIFF = 0x020000, /* Apple/SGI AIFF format (big endian). */ cannam@91: SF_FORMAT_AU = 0x030000, /* Sun/NeXT AU format (big endian). */ cannam@91: SF_FORMAT_RAW = 0x040000, /* RAW PCM data. */ cannam@91: SF_FORMAT_PAF = 0x050000, /* Ensoniq PARIS file format. */ cannam@91: SF_FORMAT_SVX = 0x060000, /* Amiga IFF / SVX8 / SV16 format. */ cannam@91: SF_FORMAT_NIST = 0x070000, /* Sphere NIST format. */ cannam@91: SF_FORMAT_VOC = 0x080000, /* VOC files. */ cannam@91: SF_FORMAT_IRCAM = 0x0A0000, /* Berkeley/IRCAM/CARL */ cannam@91: SF_FORMAT_W64 = 0x0B0000, /* Sonic Foundry's 64 bit RIFF/WAV */ cannam@91: SF_FORMAT_MAT4 = 0x0C0000, /* Matlab (tm) V4.2 / GNU Octave 2.0 */ cannam@91: SF_FORMAT_MAT5 = 0x0D0000, /* Matlab (tm) V5.0 / GNU Octave 2.1 */ cannam@91: SF_FORMAT_PVF = 0x0E0000, /* Portable Voice Format */ cannam@91: SF_FORMAT_XI = 0x0F0000, /* Fasttracker 2 Extended Instrument */ cannam@91: SF_FORMAT_HTK = 0x100000, /* HMM Tool Kit format */ cannam@91: SF_FORMAT_SDS = 0x110000, /* Midi Sample Dump Standard */ cannam@91: SF_FORMAT_AVR = 0x120000, /* Audio Visual Research */ cannam@91: SF_FORMAT_WAVEX = 0x130000, /* MS WAVE with WAVEFORMATEX */ cannam@91: SF_FORMAT_SD2 = 0x160000, /* Sound Designer 2 */ cannam@91: SF_FORMAT_FLAC = 0x170000, /* FLAC lossless file format */ cannam@91: SF_FORMAT_CAF = 0x180000, /* Core Audio File format */ cannam@91: SF_FORMAT_WVE = 0x190000, /* Psion WVE format */ cannam@91: SF_FORMAT_OGG = 0x200000, /* Xiph OGG container */ cannam@91: SF_FORMAT_MPC2K = 0x210000, /* Akai MPC 2000 sampler */ cannam@91: SF_FORMAT_RF64 = 0x220000, /* RF64 WAV file */ cannam@91: cannam@91: /* Subtypes from here on. */ cannam@91: cannam@91: SF_FORMAT_PCM_S8 = 0x0001, /* Signed 8 bit data */ cannam@91: SF_FORMAT_PCM_16 = 0x0002, /* Signed 16 bit data */ cannam@91: SF_FORMAT_PCM_24 = 0x0003, /* Signed 24 bit data */ cannam@91: SF_FORMAT_PCM_32 = 0x0004, /* Signed 32 bit data */ cannam@91: cannam@91: SF_FORMAT_PCM_U8 = 0x0005, /* Unsigned 8 bit data (WAV and RAW only) */ cannam@91: cannam@91: SF_FORMAT_FLOAT = 0x0006, /* 32 bit float data */ cannam@91: SF_FORMAT_DOUBLE = 0x0007, /* 64 bit float data */ cannam@91: cannam@91: SF_FORMAT_ULAW = 0x0010, /* U-Law encoded. */ cannam@91: SF_FORMAT_ALAW = 0x0011, /* A-Law encoded. */ cannam@91: SF_FORMAT_IMA_ADPCM = 0x0012, /* IMA ADPCM. */ cannam@91: SF_FORMAT_MS_ADPCM = 0x0013, /* Microsoft ADPCM. */ cannam@91: cannam@91: SF_FORMAT_GSM610 = 0x0020, /* GSM 6.10 encoding. */ cannam@91: SF_FORMAT_VOX_ADPCM = 0x0021, /* OKI / Dialogix ADPCM */ cannam@91: cannam@91: SF_FORMAT_G721_32 = 0x0030, /* 32kbs G721 ADPCM encoding. */ cannam@91: SF_FORMAT_G723_24 = 0x0031, /* 24kbs G723 ADPCM encoding. */ cannam@91: SF_FORMAT_G723_40 = 0x0032, /* 40kbs G723 ADPCM encoding. */ cannam@91: cannam@91: SF_FORMAT_DWVW_12 = 0x0040, /* 12 bit Delta Width Variable Word encoding. */ cannam@91: SF_FORMAT_DWVW_16 = 0x0041, /* 16 bit Delta Width Variable Word encoding. */ cannam@91: SF_FORMAT_DWVW_24 = 0x0042, /* 24 bit Delta Width Variable Word encoding. */ cannam@91: SF_FORMAT_DWVW_N = 0x0043, /* N bit Delta Width Variable Word encoding. */ cannam@91: cannam@91: SF_FORMAT_DPCM_8 = 0x0050, /* 8 bit differential PCM (XI only) */ cannam@91: SF_FORMAT_DPCM_16 = 0x0051, /* 16 bit differential PCM (XI only) */ cannam@91: cannam@91: SF_FORMAT_VORBIS = 0x0060, /* Xiph Vorbis encoding. */ cannam@91: cannam@91: /* Endian-ness options. */ cannam@91: cannam@91: SF_ENDIAN_FILE = 0x00000000, /* Default file endian-ness. */ cannam@91: SF_ENDIAN_LITTLE = 0x10000000, /* Force little endian-ness. */ cannam@91: SF_ENDIAN_BIG = 0x20000000, /* Force big endian-ness. */ cannam@91: SF_ENDIAN_CPU = 0x30000000, /* Force CPU endian-ness. */ cannam@91: cannam@91: SF_FORMAT_SUBMASK = 0x0000FFFF, cannam@91: SF_FORMAT_TYPEMASK = 0x0FFF0000, cannam@91: SF_FORMAT_ENDMASK = 0x30000000 cannam@91: } ; cannam@91: cannam@91: /* cannam@91: ** The following are the valid command numbers for the sf_command() cannam@91: ** interface. The use of these commands is documented in the file cannam@91: ** command.html in the doc directory of the source code distribution. cannam@91: */ cannam@91: cannam@91: enum cannam@91: { SFC_GET_LIB_VERSION = 0x1000, cannam@91: SFC_GET_LOG_INFO = 0x1001, cannam@91: SFC_GET_CURRENT_SF_INFO = 0x1002, cannam@91: cannam@91: cannam@91: SFC_GET_NORM_DOUBLE = 0x1010, cannam@91: SFC_GET_NORM_FLOAT = 0x1011, cannam@91: SFC_SET_NORM_DOUBLE = 0x1012, cannam@91: SFC_SET_NORM_FLOAT = 0x1013, cannam@91: SFC_SET_SCALE_FLOAT_INT_READ = 0x1014, cannam@91: SFC_SET_SCALE_INT_FLOAT_WRITE = 0x1015, cannam@91: cannam@91: SFC_GET_SIMPLE_FORMAT_COUNT = 0x1020, cannam@91: SFC_GET_SIMPLE_FORMAT = 0x1021, cannam@91: cannam@91: SFC_GET_FORMAT_INFO = 0x1028, cannam@91: cannam@91: SFC_GET_FORMAT_MAJOR_COUNT = 0x1030, cannam@91: SFC_GET_FORMAT_MAJOR = 0x1031, cannam@91: SFC_GET_FORMAT_SUBTYPE_COUNT = 0x1032, cannam@91: SFC_GET_FORMAT_SUBTYPE = 0x1033, cannam@91: cannam@91: SFC_CALC_SIGNAL_MAX = 0x1040, cannam@91: SFC_CALC_NORM_SIGNAL_MAX = 0x1041, cannam@91: SFC_CALC_MAX_ALL_CHANNELS = 0x1042, cannam@91: SFC_CALC_NORM_MAX_ALL_CHANNELS = 0x1043, cannam@91: SFC_GET_SIGNAL_MAX = 0x1044, cannam@91: SFC_GET_MAX_ALL_CHANNELS = 0x1045, cannam@91: cannam@91: SFC_SET_ADD_PEAK_CHUNK = 0x1050, cannam@91: SFC_SET_ADD_HEADER_PAD_CHUNK = 0x1051, cannam@91: cannam@91: SFC_UPDATE_HEADER_NOW = 0x1060, cannam@91: SFC_SET_UPDATE_HEADER_AUTO = 0x1061, cannam@91: cannam@91: SFC_FILE_TRUNCATE = 0x1080, cannam@91: cannam@91: SFC_SET_RAW_START_OFFSET = 0x1090, cannam@91: cannam@91: SFC_SET_DITHER_ON_WRITE = 0x10A0, cannam@91: SFC_SET_DITHER_ON_READ = 0x10A1, cannam@91: cannam@91: SFC_GET_DITHER_INFO_COUNT = 0x10A2, cannam@91: SFC_GET_DITHER_INFO = 0x10A3, cannam@91: cannam@91: SFC_GET_EMBED_FILE_INFO = 0x10B0, cannam@91: cannam@91: SFC_SET_CLIPPING = 0x10C0, cannam@91: SFC_GET_CLIPPING = 0x10C1, cannam@91: cannam@91: SFC_GET_INSTRUMENT = 0x10D0, cannam@91: SFC_SET_INSTRUMENT = 0x10D1, cannam@91: cannam@91: SFC_GET_LOOP_INFO = 0x10E0, cannam@91: cannam@91: SFC_GET_BROADCAST_INFO = 0x10F0, cannam@91: SFC_SET_BROADCAST_INFO = 0x10F1, cannam@91: cannam@91: SFC_GET_CHANNEL_MAP_INFO = 0x1100, cannam@91: SFC_SET_CHANNEL_MAP_INFO = 0x1101, cannam@91: cannam@91: SFC_RAW_DATA_NEEDS_ENDSWAP = 0x1110, cannam@91: cannam@91: /* Support for Wavex Ambisonics Format */ cannam@91: SFC_WAVEX_SET_AMBISONIC = 0x1200, cannam@91: SFC_WAVEX_GET_AMBISONIC = 0x1201, cannam@91: cannam@91: SFC_SET_VBR_ENCODING_QUALITY = 0x1300, cannam@91: cannam@91: /* Following commands for testing only. */ cannam@91: SFC_TEST_IEEE_FLOAT_REPLACE = 0x6001, cannam@91: cannam@91: /* cannam@91: ** SFC_SET_ADD_* values are deprecated and will disappear at some cannam@91: ** time in the future. They are guaranteed to be here up to and cannam@91: ** including version 1.0.8 to avoid breakage of existng software. cannam@91: ** They currently do nothing and will continue to do nothing. cannam@91: */ cannam@91: SFC_SET_ADD_DITHER_ON_WRITE = 0x1070, cannam@91: SFC_SET_ADD_DITHER_ON_READ = 0x1071 cannam@91: } ; cannam@91: cannam@91: cannam@91: /* cannam@91: ** String types that can be set and read from files. Not all file types cannam@91: ** support this and even the file types which support one, may not support cannam@91: ** all string types. cannam@91: */ cannam@91: cannam@91: enum cannam@91: { SF_STR_TITLE = 0x01, cannam@91: SF_STR_COPYRIGHT = 0x02, cannam@91: SF_STR_SOFTWARE = 0x03, cannam@91: SF_STR_ARTIST = 0x04, cannam@91: SF_STR_COMMENT = 0x05, cannam@91: SF_STR_DATE = 0x06, cannam@91: SF_STR_ALBUM = 0x07, cannam@91: SF_STR_LICENSE = 0x08, cannam@91: SF_STR_TRACKNUMBER = 0x09, cannam@91: SF_STR_GENRE = 0x10 cannam@91: } ; cannam@91: cannam@91: /* cannam@91: ** Use the following as the start and end index when doing metadata cannam@91: ** transcoding. cannam@91: */ cannam@91: cannam@91: #define SF_STR_FIRST SF_STR_TITLE cannam@91: #define SF_STR_LAST SF_STR_GENRE cannam@91: cannam@91: enum cannam@91: { /* True and false */ cannam@91: SF_FALSE = 0, cannam@91: SF_TRUE = 1, cannam@91: cannam@91: /* Modes for opening files. */ cannam@91: SFM_READ = 0x10, cannam@91: SFM_WRITE = 0x20, cannam@91: SFM_RDWR = 0x30, cannam@91: cannam@91: SF_AMBISONIC_NONE = 0x40, cannam@91: SF_AMBISONIC_B_FORMAT = 0x41 cannam@91: } ; cannam@91: cannam@91: /* Public error values. These are guaranteed to remain unchanged for the duration cannam@91: ** of the library major version number. cannam@91: ** There are also a large number of private error numbers which are internal to cannam@91: ** the library which can change at any time. cannam@91: */ cannam@91: cannam@91: enum cannam@91: { SF_ERR_NO_ERROR = 0, cannam@91: SF_ERR_UNRECOGNISED_FORMAT = 1, cannam@91: SF_ERR_SYSTEM = 2, cannam@91: SF_ERR_MALFORMED_FILE = 3, cannam@91: SF_ERR_UNSUPPORTED_ENCODING = 4 cannam@91: } ; cannam@91: cannam@91: cannam@91: /* Channel map values (used with SFC_SET/GET_CHANNEL_MAP). cannam@91: */ cannam@91: cannam@91: enum cannam@91: { SF_CHANNEL_MAP_INVALID = 0, cannam@91: SF_CHANNEL_MAP_MONO = 1, cannam@91: SF_CHANNEL_MAP_LEFT, /* Apple calls this 'Left' */ cannam@91: SF_CHANNEL_MAP_RIGHT, /* Apple calls this 'Right' */ cannam@91: SF_CHANNEL_MAP_CENTER, /* Apple calls this 'Center' */ cannam@91: SF_CHANNEL_MAP_FRONT_LEFT, cannam@91: SF_CHANNEL_MAP_FRONT_RIGHT, cannam@91: SF_CHANNEL_MAP_FRONT_CENTER, cannam@91: SF_CHANNEL_MAP_REAR_CENTER, /* Apple calls this 'Center Surround', Msft calls this 'Back Center' */ cannam@91: SF_CHANNEL_MAP_REAR_LEFT, /* Apple calls this 'Left Surround', Msft calls this 'Back Left' */ cannam@91: SF_CHANNEL_MAP_REAR_RIGHT, /* Apple calls this 'Right Surround', Msft calls this 'Back Right' */ cannam@91: SF_CHANNEL_MAP_LFE, /* Apple calls this 'LFEScreen', Msft calls this 'Low Frequency' */ cannam@91: SF_CHANNEL_MAP_FRONT_LEFT_OF_CENTER, /* Apple calls this 'Left Center' */ cannam@91: SF_CHANNEL_MAP_FRONT_RIGHT_OF_CENTER, /* Apple calls this 'Right Center */ cannam@91: SF_CHANNEL_MAP_SIDE_LEFT, /* Apple calls this 'Left Surround Direct' */ cannam@91: SF_CHANNEL_MAP_SIDE_RIGHT, /* Apple calls this 'Right Surround Direct' */ cannam@91: SF_CHANNEL_MAP_TOP_CENTER, /* Apple calls this 'Top Center Surround' */ cannam@91: SF_CHANNEL_MAP_TOP_FRONT_LEFT, /* Apple calls this 'Vertical Height Left' */ cannam@91: SF_CHANNEL_MAP_TOP_FRONT_RIGHT, /* Apple calls this 'Vertical Height Right' */ cannam@91: SF_CHANNEL_MAP_TOP_FRONT_CENTER, /* Apple calls this 'Vertical Height Center' */ cannam@91: SF_CHANNEL_MAP_TOP_REAR_LEFT, /* Apple and MS call this 'Top Back Left' */ cannam@91: SF_CHANNEL_MAP_TOP_REAR_RIGHT, /* Apple and MS call this 'Top Back Right' */ cannam@91: SF_CHANNEL_MAP_TOP_REAR_CENTER, /* Apple and MS call this 'Top Back Center' */ cannam@91: cannam@91: SF_CHANNEL_MAP_AMBISONIC_B_W, cannam@91: SF_CHANNEL_MAP_AMBISONIC_B_X, cannam@91: SF_CHANNEL_MAP_AMBISONIC_B_Y, cannam@91: SF_CHANNEL_MAP_AMBISONIC_B_Z, cannam@91: cannam@91: SF_CHANNEL_MAP_MAX cannam@91: } ; cannam@91: cannam@91: cannam@91: /* A SNDFILE* pointer can be passed around much like stdio.h's FILE* pointer. */ cannam@91: cannam@91: typedef struct SNDFILE_tag SNDFILE ; cannam@91: cannam@91: /* The following typedef is system specific and is defined when libsndfile is cannam@91: ** compiled. sf_count_t will be a 64 bit value when the underlying OS allows cannam@91: ** 64 bit file offsets. cannam@91: ** On windows, we need to allow the same header file to be compiler by both GCC cannam@91: ** and the Microsoft compiler. cannam@91: */ cannam@91: cannam@91: #if (defined (_MSCVER) || defined (_MSC_VER)) cannam@91: typedef __int64 sf_count_t ; cannam@91: #define SF_COUNT_MAX 0x7fffffffffffffffi64 cannam@91: #else cannam@91: typedef off_t sf_count_t ; cannam@91: #define SF_COUNT_MAX 0x7FFFFFFF cannam@91: #endif cannam@91: cannam@91: cannam@91: /* A pointer to a SF_INFO structure is passed to sf_open () and filled in. cannam@91: ** On write, the SF_INFO structure is filled in by the user and passed into cannam@91: ** sf_open (). cannam@91: */ cannam@91: cannam@91: struct SF_INFO cannam@91: { sf_count_t frames ; /* Used to be called samples. Changed to avoid confusion. */ cannam@91: int samplerate ; cannam@91: int channels ; cannam@91: int format ; cannam@91: int sections ; cannam@91: int seekable ; cannam@91: } ; cannam@91: cannam@91: typedef struct SF_INFO SF_INFO ; cannam@91: cannam@91: /* The SF_FORMAT_INFO struct is used to retrieve information about the sound cannam@91: ** file formats libsndfile supports using the sf_command () interface. cannam@91: ** cannam@91: ** Using this interface will allow applications to support new file formats cannam@91: ** and encoding types when libsndfile is upgraded, without requiring cannam@91: ** re-compilation of the application. cannam@91: ** cannam@91: ** Please consult the libsndfile documentation (particularly the information cannam@91: ** on the sf_command () interface) for examples of its use. cannam@91: */ cannam@91: cannam@91: typedef struct cannam@91: { int format ; cannam@91: const char *name ; cannam@91: const char *extension ; cannam@91: } SF_FORMAT_INFO ; cannam@91: cannam@91: /* cannam@91: ** Enums and typedefs for adding dither on read and write. cannam@91: ** See the html documentation for sf_command(), SFC_SET_DITHER_ON_WRITE cannam@91: ** and SFC_SET_DITHER_ON_READ. cannam@91: */ cannam@91: cannam@91: enum cannam@91: { SFD_DEFAULT_LEVEL = 0, cannam@91: SFD_CUSTOM_LEVEL = 0x40000000, cannam@91: cannam@91: SFD_NO_DITHER = 500, cannam@91: SFD_WHITE = 501, cannam@91: SFD_TRIANGULAR_PDF = 502 cannam@91: } ; cannam@91: cannam@91: typedef struct cannam@91: { int type ; cannam@91: double level ; cannam@91: const char *name ; cannam@91: } SF_DITHER_INFO ; cannam@91: cannam@91: /* Struct used to retrieve information about a file embedded within a cannam@91: ** larger file. See SFC_GET_EMBED_FILE_INFO. cannam@91: */ cannam@91: cannam@91: typedef struct cannam@91: { sf_count_t offset ; cannam@91: sf_count_t length ; cannam@91: } SF_EMBED_FILE_INFO ; cannam@91: cannam@91: /* cannam@91: ** Structs used to retrieve music sample information from a file. cannam@91: */ cannam@91: cannam@91: enum cannam@91: { /* cannam@91: ** The loop mode field in SF_INSTRUMENT will be one of the following. cannam@91: */ cannam@91: SF_LOOP_NONE = 800, cannam@91: SF_LOOP_FORWARD, cannam@91: SF_LOOP_BACKWARD, cannam@91: SF_LOOP_ALTERNATING cannam@91: } ; cannam@91: cannam@91: typedef struct cannam@91: { int gain ; cannam@91: char basenote, detune ; cannam@91: char velocity_lo, velocity_hi ; cannam@91: char key_lo, key_hi ; cannam@91: int loop_count ; cannam@91: cannam@91: struct cannam@91: { int mode ; cannam@91: unsigned int start ; cannam@91: unsigned int end ; cannam@91: unsigned int count ; cannam@91: } loops [16] ; /* make variable in a sensible way */ cannam@91: } SF_INSTRUMENT ; cannam@91: cannam@91: cannam@91: cannam@91: /* Struct used to retrieve loop information from a file.*/ cannam@91: typedef struct cannam@91: { cannam@91: short time_sig_num ; /* any positive integer > 0 */ cannam@91: short time_sig_den ; /* any positive power of 2 > 0 */ cannam@91: int loop_mode ; /* see SF_LOOP enum */ cannam@91: cannam@91: int num_beats ; /* this is NOT the amount of quarter notes !!!*/ cannam@91: /* a full bar of 4/4 is 4 beats */ cannam@91: /* a full bar of 7/8 is 7 beats */ cannam@91: cannam@91: float bpm ; /* suggestion, as it can be calculated using other fields:*/ cannam@91: /* file's lenght, file's sampleRate and our time_sig_den*/ cannam@91: /* -> bpms are always the amount of _quarter notes_ per minute */ cannam@91: cannam@91: int root_key ; /* MIDI note, or -1 for None */ cannam@91: int future [6] ; cannam@91: } SF_LOOP_INFO ; cannam@91: cannam@91: cannam@91: /* Struct used to retrieve broadcast (EBU) information from a file. cannam@91: ** Strongly (!) based on EBU "bext" chunk format used in Broadcast WAVE. cannam@91: */ cannam@91: #define SF_BROADCAST_INFO_VAR(coding_hist_size) \ cannam@91: struct \ cannam@91: { char description [256] ; \ cannam@91: char originator [32] ; \ cannam@91: char originator_reference [32] ; \ cannam@91: char origination_date [10] ; \ cannam@91: char origination_time [8] ; \ cannam@91: unsigned int time_reference_low ; \ cannam@91: unsigned int time_reference_high ; \ cannam@91: short version ; \ cannam@91: char umid [64] ; \ cannam@91: char reserved [190] ; \ cannam@91: unsigned int coding_history_size ; \ cannam@91: char coding_history [coding_hist_size] ; \ cannam@91: } cannam@91: cannam@91: /* SF_BROADCAST_INFO is the above struct with coding_history field of 256 bytes. */ cannam@91: typedef SF_BROADCAST_INFO_VAR (256) SF_BROADCAST_INFO ; cannam@91: cannam@91: cannam@91: /* Virtual I/O functionality. */ cannam@91: cannam@91: typedef sf_count_t (*sf_vio_get_filelen) (void *user_data) ; cannam@91: typedef sf_count_t (*sf_vio_seek) (sf_count_t offset, int whence, void *user_data) ; cannam@91: typedef sf_count_t (*sf_vio_read) (void *ptr, sf_count_t count, void *user_data) ; cannam@91: typedef sf_count_t (*sf_vio_write) (const void *ptr, sf_count_t count, void *user_data) ; cannam@91: typedef sf_count_t (*sf_vio_tell) (void *user_data) ; cannam@91: cannam@91: struct SF_VIRTUAL_IO cannam@91: { sf_vio_get_filelen get_filelen ; cannam@91: sf_vio_seek seek ; cannam@91: sf_vio_read read ; cannam@91: sf_vio_write write ; cannam@91: sf_vio_tell tell ; cannam@91: } ; cannam@91: cannam@91: typedef struct SF_VIRTUAL_IO SF_VIRTUAL_IO ; cannam@91: cannam@91: cannam@91: /* Open the specified file for read, write or both. On error, this will cannam@91: ** return a NULL pointer. To find the error number, pass a NULL SNDFILE cannam@91: ** to sf_strerror (). cannam@91: ** All calls to sf_open() should be matched with a call to sf_close(). cannam@91: */ cannam@91: cannam@91: SNDFILE* sf_open (const char *path, int mode, SF_INFO *sfinfo) ; cannam@91: cannam@91: cannam@91: /* Use the existing file descriptor to create a SNDFILE object. If close_desc cannam@91: ** is TRUE, the file descriptor will be closed when sf_close() is called. If cannam@91: ** it is FALSE, the descritor will not be closed. cannam@91: ** When passed a descriptor like this, the library will assume that the start cannam@91: ** of file header is at the current file offset. This allows sound files within cannam@91: ** larger container files to be read and/or written. cannam@91: ** On error, this will return a NULL pointer. To find the error number, pass a cannam@91: ** NULL SNDFILE to sf_strerror (). cannam@91: ** All calls to sf_open_fd() should be matched with a call to sf_close(). cannam@91: cannam@91: */ cannam@91: cannam@91: SNDFILE* sf_open_fd (int fd, int mode, SF_INFO *sfinfo, int close_desc) ; cannam@91: cannam@91: SNDFILE* sf_open_virtual (SF_VIRTUAL_IO *sfvirtual, int mode, SF_INFO *sfinfo, void *user_data) ; cannam@91: cannam@91: cannam@91: /* sf_error () returns a error number which can be translated to a text cannam@91: ** string using sf_error_number(). cannam@91: */ cannam@91: cannam@91: int sf_error (SNDFILE *sndfile) ; cannam@91: cannam@91: cannam@91: /* sf_strerror () returns to the caller a pointer to the current error message for cannam@91: ** the given SNDFILE. cannam@91: */ cannam@91: cannam@91: const char* sf_strerror (SNDFILE *sndfile) ; cannam@91: cannam@91: cannam@91: /* sf_error_number () allows the retrieval of the error string for each internal cannam@91: ** error number. cannam@91: ** cannam@91: */ cannam@91: cannam@91: const char* sf_error_number (int errnum) ; cannam@91: cannam@91: cannam@91: /* The following two error functions are deprecated but they will remain in the cannam@91: ** library for the forseeable future. The function sf_strerror() should be used cannam@91: ** in their place. cannam@91: */ cannam@91: cannam@91: int sf_perror (SNDFILE *sndfile) ; cannam@91: int sf_error_str (SNDFILE *sndfile, char* str, size_t len) ; cannam@91: cannam@91: cannam@91: /* Return TRUE if fields of the SF_INFO struct are a valid combination of values. */ cannam@91: cannam@91: int sf_command (SNDFILE *sndfile, int command, void *data, int datasize) ; cannam@91: cannam@91: cannam@91: /* Return TRUE if fields of the SF_INFO struct are a valid combination of values. */ cannam@91: cannam@91: int sf_format_check (const SF_INFO *info) ; cannam@91: cannam@91: cannam@91: /* Seek within the waveform data chunk of the SNDFILE. sf_seek () uses cannam@91: ** the same values for whence (SEEK_SET, SEEK_CUR and SEEK_END) as cannam@91: ** stdio.h function fseek (). cannam@91: ** An offset of zero with whence set to SEEK_SET will position the cannam@91: ** read / write pointer to the first data sample. cannam@91: ** On success sf_seek returns the current position in (multi-channel) cannam@91: ** samples from the start of the file. cannam@91: ** Please see the libsndfile documentation for moving the read pointer cannam@91: ** separately from the write pointer on files open in mode SFM_RDWR. cannam@91: ** On error all of these functions return -1. cannam@91: */ cannam@91: cannam@91: sf_count_t sf_seek (SNDFILE *sndfile, sf_count_t frames, int whence) ; cannam@91: cannam@91: cannam@91: /* Functions for retrieving and setting string data within sound files. cannam@91: ** Not all file types support this features; AIFF and WAV do. For both cannam@91: ** functions, the str_type parameter must be one of the SF_STR_* values cannam@91: ** defined above. cannam@91: ** On error, sf_set_string() returns non-zero while sf_get_string() cannam@91: ** returns NULL. cannam@91: */ cannam@91: cannam@91: int sf_set_string (SNDFILE *sndfile, int str_type, const char* str) ; cannam@91: cannam@91: const char* sf_get_string (SNDFILE *sndfile, int str_type) ; cannam@91: cannam@91: cannam@91: /* Return the library version string. */ cannam@91: cannam@91: const char * sf_version_string (void) ; cannam@91: cannam@91: cannam@91: /* Functions for reading/writing the waveform data of a sound file. cannam@91: */ cannam@91: cannam@91: sf_count_t sf_read_raw (SNDFILE *sndfile, void *ptr, sf_count_t bytes) ; cannam@91: sf_count_t sf_write_raw (SNDFILE *sndfile, const void *ptr, sf_count_t bytes) ; cannam@91: cannam@91: cannam@91: /* Functions for reading and writing the data chunk in terms of frames. cannam@91: ** The number of items actually read/written = frames * number of channels. cannam@91: ** sf_xxxx_raw read/writes the raw data bytes from/to the file cannam@91: ** sf_xxxx_short passes data in the native short format cannam@91: ** sf_xxxx_int passes data in the native int format cannam@91: ** sf_xxxx_float passes data in the native float format cannam@91: ** sf_xxxx_double passes data in the native double format cannam@91: ** All of these read/write function return number of frames read/written. cannam@91: */ cannam@91: cannam@91: sf_count_t sf_readf_short (SNDFILE *sndfile, short *ptr, sf_count_t frames) ; cannam@91: sf_count_t sf_writef_short (SNDFILE *sndfile, const short *ptr, sf_count_t frames) ; cannam@91: cannam@91: sf_count_t sf_readf_int (SNDFILE *sndfile, int *ptr, sf_count_t frames) ; cannam@91: sf_count_t sf_writef_int (SNDFILE *sndfile, const int *ptr, sf_count_t frames) ; cannam@91: cannam@91: sf_count_t sf_readf_float (SNDFILE *sndfile, float *ptr, sf_count_t frames) ; cannam@91: sf_count_t sf_writef_float (SNDFILE *sndfile, const float *ptr, sf_count_t frames) ; cannam@91: cannam@91: sf_count_t sf_readf_double (SNDFILE *sndfile, double *ptr, sf_count_t frames) ; cannam@91: sf_count_t sf_writef_double (SNDFILE *sndfile, const double *ptr, sf_count_t frames) ; cannam@91: cannam@91: cannam@91: /* Functions for reading and writing the data chunk in terms of items. cannam@91: ** Otherwise similar to above. cannam@91: ** All of these read/write function return number of items read/written. cannam@91: */ cannam@91: cannam@91: sf_count_t sf_read_short (SNDFILE *sndfile, short *ptr, sf_count_t items) ; cannam@91: sf_count_t sf_write_short (SNDFILE *sndfile, const short *ptr, sf_count_t items) ; cannam@91: cannam@91: sf_count_t sf_read_int (SNDFILE *sndfile, int *ptr, sf_count_t items) ; cannam@91: sf_count_t sf_write_int (SNDFILE *sndfile, const int *ptr, sf_count_t items) ; cannam@91: cannam@91: sf_count_t sf_read_float (SNDFILE *sndfile, float *ptr, sf_count_t items) ; cannam@91: sf_count_t sf_write_float (SNDFILE *sndfile, const float *ptr, sf_count_t items) ; cannam@91: cannam@91: sf_count_t sf_read_double (SNDFILE *sndfile, double *ptr, sf_count_t items) ; cannam@91: sf_count_t sf_write_double (SNDFILE *sndfile, const double *ptr, sf_count_t items) ; cannam@91: cannam@91: cannam@91: /* Close the SNDFILE and clean up all memory allocations associated with this cannam@91: ** file. cannam@91: ** Returns 0 on success, or an error number. cannam@91: */ cannam@91: cannam@91: int sf_close (SNDFILE *sndfile) ; cannam@91: cannam@91: cannam@91: /* If the file is opened SFM_WRITE or SFM_RDWR, call fsync() on the file cannam@91: ** to force the writing of data to disk. If the file is opened SFM_READ cannam@91: ** no action is taken. cannam@91: */ cannam@91: cannam@91: void sf_write_sync (SNDFILE *sndfile) ; cannam@91: cannam@91: cannam@91: cannam@91: /* The function sf_wchar_open() is Windows Only! cannam@91: ** Open a file passing in a Windows Unicode filename. Otherwise, this is cannam@91: ** the same as sf_open(). cannam@91: ** cannam@91: ** In order for this to work, you need to do the following: cannam@91: ** cannam@91: ** #include cannam@91: ** #define ENABLE_SNDFILE_WINDOWS_PROTOTYPES 1 cannam@91: ** #including cannam@91: */ cannam@91: cannam@91: #if (defined (ENABLE_SNDFILE_WINDOWS_PROTOTYPES) && ENABLE_SNDFILE_WINDOWS_PROTOTYPES) cannam@91: SNDFILE* sf_wchar_open (LPCWSTR wpath, int mode, SF_INFO *sfinfo) ; cannam@91: #endif cannam@91: cannam@91: cannam@91: cannam@91: #ifdef __cplusplus cannam@91: } /* extern "C" */ cannam@91: #endif /* __cplusplus */ cannam@91: cannam@91: #endif /* SNDFILE_H */ cannam@91: