2 ** Copyright (C) 1999-2006 Erik de Castro Lopo <erikd@mega-nerd.com>
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.
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.
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.
20 ** sndfile.h -- system-wide definitions
22 ** API documentation is in the doc/ directory of the source code tarball
23 ** and at http://www.mega-nerd.com/libsndfile/api.html.
29 /* This is the version 1.0.X header file. */
34 /* For the Metrowerks CodeWarrior Pro Compiler (mainly MacOS) */
36 #if (defined (__MWERKS__))
39 #include <sys/types.h>
44 #endif /* __cplusplus */
46 /* The following file types can be read and written.
47 ** A file type would consist of a major type (ie SF_FORMAT_WAV) bitwise
48 ** ORed with a minor type (ie SF_FORMAT_PCM). SF_FORMAT_TYPEMASK and
49 ** SF_FORMAT_SUBMASK can be used to separate the major and minor file
54 { /* Major formats. */
55 SF_FORMAT_WAV
= 0x010000, /* Microsoft WAV format (little endian default). */
56 SF_FORMAT_AIFF
= 0x020000, /* Apple/SGI AIFF format (big endian). */
57 SF_FORMAT_AU
= 0x030000, /* Sun/NeXT AU format (big endian). */
58 SF_FORMAT_RAW
= 0x040000, /* RAW PCM data. */
59 SF_FORMAT_PAF
= 0x050000, /* Ensoniq PARIS file format. */
60 SF_FORMAT_SVX
= 0x060000, /* Amiga IFF / SVX8 / SV16 format. */
61 SF_FORMAT_NIST
= 0x070000, /* Sphere NIST format. */
62 SF_FORMAT_VOC
= 0x080000, /* VOC files. */
63 SF_FORMAT_IRCAM
= 0x0A0000, /* Berkeley/IRCAM/CARL */
64 SF_FORMAT_W64
= 0x0B0000, /* Sonic Foundry's 64 bit RIFF/WAV */
65 SF_FORMAT_MAT4
= 0x0C0000, /* Matlab (tm) V4.2 / GNU Octave 2.0 */
66 SF_FORMAT_MAT5
= 0x0D0000, /* Matlab (tm) V5.0 / GNU Octave 2.1 */
67 SF_FORMAT_PVF
= 0x0E0000, /* Portable Voice Format */
68 SF_FORMAT_XI
= 0x0F0000, /* Fasttracker 2 Extended Instrument */
69 SF_FORMAT_HTK
= 0x100000, /* HMM Tool Kit format */
70 SF_FORMAT_SDS
= 0x110000, /* Midi Sample Dump Standard */
71 SF_FORMAT_AVR
= 0x120000, /* Audio Visual Research */
72 SF_FORMAT_WAVEX
= 0x130000, /* MS WAVE with WAVEFORMATEX */
73 SF_FORMAT_SD2
= 0x160000, /* Sound Designer 2 */
74 SF_FORMAT_FLAC
= 0x170000, /* FLAC lossless file format */
75 SF_FORMAT_CAF
= 0x180000, /* Core Audio File format */
77 /* Subtypes from here on. */
79 SF_FORMAT_PCM_S8
= 0x0001, /* Signed 8 bit data */
80 SF_FORMAT_PCM_16
= 0x0002, /* Signed 16 bit data */
81 SF_FORMAT_PCM_24
= 0x0003, /* Signed 24 bit data */
82 SF_FORMAT_PCM_32
= 0x0004, /* Signed 32 bit data */
84 SF_FORMAT_PCM_U8
= 0x0005, /* Unsigned 8 bit data (WAV and RAW only) */
86 SF_FORMAT_FLOAT
= 0x0006, /* 32 bit float data */
87 SF_FORMAT_DOUBLE
= 0x0007, /* 64 bit float data */
89 SF_FORMAT_ULAW
= 0x0010, /* U-Law encoded. */
90 SF_FORMAT_ALAW
= 0x0011, /* A-Law encoded. */
91 SF_FORMAT_IMA_ADPCM
= 0x0012, /* IMA ADPCM. */
92 SF_FORMAT_MS_ADPCM
= 0x0013, /* Microsoft ADPCM. */
94 SF_FORMAT_GSM610
= 0x0020, /* GSM 6.10 encoding. */
95 SF_FORMAT_VOX_ADPCM
= 0x0021, /* OKI / Dialogix ADPCM */
97 SF_FORMAT_G721_32
= 0x0030, /* 32kbs G721 ADPCM encoding. */
98 SF_FORMAT_G723_24
= 0x0031, /* 24kbs G723 ADPCM encoding. */
99 SF_FORMAT_G723_40
= 0x0032, /* 40kbs G723 ADPCM encoding. */
101 SF_FORMAT_DWVW_12
= 0x0040, /* 12 bit Delta Width Variable Word encoding. */
102 SF_FORMAT_DWVW_16
= 0x0041, /* 16 bit Delta Width Variable Word encoding. */
103 SF_FORMAT_DWVW_24
= 0x0042, /* 24 bit Delta Width Variable Word encoding. */
104 SF_FORMAT_DWVW_N
= 0x0043, /* N bit Delta Width Variable Word encoding. */
106 SF_FORMAT_DPCM_8
= 0x0050, /* 8 bit differential PCM (XI only) */
107 SF_FORMAT_DPCM_16
= 0x0051, /* 16 bit differential PCM (XI only) */
109 /* Endian-ness options. */
111 SF_ENDIAN_FILE
= 0x00000000, /* Default file endian-ness. */
112 SF_ENDIAN_LITTLE
= 0x10000000, /* Force little endian-ness. */
113 SF_ENDIAN_BIG
= 0x20000000, /* Force big endian-ness. */
114 SF_ENDIAN_CPU
= 0x30000000, /* Force CPU endian-ness. */
116 SF_FORMAT_SUBMASK
= 0x0000FFFF,
117 SF_FORMAT_TYPEMASK
= 0x0FFF0000,
118 SF_FORMAT_ENDMASK
= 0x30000000
122 ** The following are the valid command numbers for the sf_command()
123 ** interface. The use of these commands is documented in the file
124 ** command.html in the doc directory of the source code distribution.
128 { SFC_GET_LIB_VERSION
= 0x1000,
129 SFC_GET_LOG_INFO
= 0x1001,
131 SFC_GET_NORM_DOUBLE
= 0x1010,
132 SFC_GET_NORM_FLOAT
= 0x1011,
133 SFC_SET_NORM_DOUBLE
= 0x1012,
134 SFC_SET_NORM_FLOAT
= 0x1013,
135 SFC_SET_SCALE_FLOAT_INT_READ
= 0x1014,
137 SFC_GET_SIMPLE_FORMAT_COUNT
= 0x1020,
138 SFC_GET_SIMPLE_FORMAT
= 0x1021,
140 SFC_GET_FORMAT_INFO
= 0x1028,
142 SFC_GET_FORMAT_MAJOR_COUNT
= 0x1030,
143 SFC_GET_FORMAT_MAJOR
= 0x1031,
144 SFC_GET_FORMAT_SUBTYPE_COUNT
= 0x1032,
145 SFC_GET_FORMAT_SUBTYPE
= 0x1033,
147 SFC_CALC_SIGNAL_MAX
= 0x1040,
148 SFC_CALC_NORM_SIGNAL_MAX
= 0x1041,
149 SFC_CALC_MAX_ALL_CHANNELS
= 0x1042,
150 SFC_CALC_NORM_MAX_ALL_CHANNELS
= 0x1043,
151 SFC_GET_SIGNAL_MAX
= 0x1044,
152 SFC_GET_MAX_ALL_CHANNELS
= 0x1045,
154 SFC_SET_ADD_PEAK_CHUNK
= 0x1050,
156 SFC_UPDATE_HEADER_NOW
= 0x1060,
157 SFC_SET_UPDATE_HEADER_AUTO
= 0x1061,
159 SFC_FILE_TRUNCATE
= 0x1080,
161 SFC_SET_RAW_START_OFFSET
= 0x1090,
163 SFC_SET_DITHER_ON_WRITE
= 0x10A0,
164 SFC_SET_DITHER_ON_READ
= 0x10A1,
166 SFC_GET_DITHER_INFO_COUNT
= 0x10A2,
167 SFC_GET_DITHER_INFO
= 0x10A3,
169 SFC_GET_EMBED_FILE_INFO
= 0x10B0,
171 SFC_SET_CLIPPING
= 0x10C0,
172 SFC_GET_CLIPPING
= 0x10C1,
174 SFC_GET_INSTRUMENT
= 0x10D0,
175 SFC_SET_INSTRUMENT
= 0x10D1,
177 SFC_GET_LOOP_INFO
= 0x10E0,
179 SFC_GET_BROADCAST_INFO
= 0x10F0,
180 SFC_SET_BROADCAST_INFO
= 0x10F1,
182 /* Following commands for testing only. */
183 SFC_TEST_IEEE_FLOAT_REPLACE
= 0x6001,
186 ** SFC_SET_ADD_* values are deprecated and will disappear at some
187 ** time in the future. They are guaranteed to be here up to and
188 ** including version 1.0.8 to avoid breakage of existng software.
189 ** They currently do nothing and will continue to do nothing.
191 SFC_SET_ADD_DITHER_ON_WRITE
= 0x1070,
192 SFC_SET_ADD_DITHER_ON_READ
= 0x1071
197 ** String types that can be set and read from files. Not all file types
198 ** support this and even the file types which support one, may not support
203 { SF_STR_TITLE
= 0x01,
204 SF_STR_COPYRIGHT
= 0x02,
205 SF_STR_SOFTWARE
= 0x03,
206 SF_STR_ARTIST
= 0x04,
207 SF_STR_COMMENT
= 0x05,
212 ** Use the following as the start and end index when doing metadata
216 #define SF_STR_FIRST SF_STR_TITLE
217 #define SF_STR_LAST SF_STR_DATE
220 { /* True and false */
224 /* Modes for opening files. */
230 /* Public error values. These are guaranteed to remain unchanged for the duration
231 ** of the library major version number.
232 ** There are also a large number of private error numbers which are internal to
233 ** the library which can change at any time.
237 { SF_ERR_NO_ERROR
= 0,
238 SF_ERR_UNRECOGNISED_FORMAT
= 1,
240 SF_ERR_MALFORMED_FILE
= 3,
241 SF_ERR_UNSUPPORTED_ENCODING
= 4
244 /* A SNDFILE* pointer can be passed around much like stdio.h's FILE* pointer. */
246 typedef struct SNDFILE_tag SNDFILE
;
248 /* The following typedef is system specific and is defined when libsndfile is.
249 ** compiled. sf_count_t can be one of loff_t (Linux), off_t (*BSD),
250 ** off64_t (Solaris), __int64_t (Win32) etc.
253 typedef @TYPEOF_SF_COUNT_T@ sf_count_t
;
255 #define SF_COUNT_MAX @SF_COUNT_MAX@
257 /* A pointer to a SF_INFO structure is passed to sf_open_read () and filled in.
258 ** On write, the SF_INFO structure is filled in by the user and passed into
263 { sf_count_t frames
; /* Used to be called samples. Changed to avoid confusion. */
271 typedef struct SF_INFO SF_INFO
;
273 /* The SF_FORMAT_INFO struct is used to retrieve information about the sound
274 ** file formats libsndfile supports using the sf_command () interface.
276 ** Using this interface will allow applications to support new file formats
277 ** and encoding types when libsndfile is upgraded, without requiring
278 ** re-compilation of the application.
280 ** Please consult the libsndfile documentation (particularly the information
281 ** on the sf_command () interface) for examples of its use.
287 const char *extension
;
291 ** Enums and typedefs for adding dither on read and write.
292 ** See the html documentation for sf_command(), SFC_SET_DITHER_ON_WRITE
293 ** and SFC_SET_DITHER_ON_READ.
297 { SFD_DEFAULT_LEVEL
= 0,
298 SFD_CUSTOM_LEVEL
= 0x40000000,
302 SFD_TRIANGULAR_PDF
= 502
311 /* Struct used to retrieve information about a file embedded within a
312 ** larger file. See SFC_GET_EMBED_FILE_INFO.
316 { sf_count_t offset
;
318 } SF_EMBED_FILE_INFO
;
321 ** Structs used to retrieve music sample information from a file.
326 ** The loop mode field in SF_INSTRUMENT will be one of the following.
336 char basenote
, detune
;
337 char velocity_lo
, velocity_hi
;
338 char key_lo
, key_hi
;
346 } loops
[16] ; /* make variable in a sensible way */
351 /* Struct used to retrieve loop information from a file.*/
354 short time_sig_num
; /* any positive integer > 0 */
355 short time_sig_den
; /* any positive power of 2 > 0 */
356 int loop_mode
; /* see SF_LOOP enum */
358 int num_beats
; /* this is NOT the amount of quarter notes !!!*/
359 /* a full bar of 4/4 is 4 beats */
360 /* a full bar of 7/8 is 7 beats */
362 float bpm
; /* suggestion, as it can be calculated using other fields:*/
363 /* file's lenght, file's sampleRate and our time_sig_den*/
364 /* -> bpms are always the amount of _quarter notes_ per minute */
366 int root_key
; /* MIDI note, or -1 for None */
371 /* Struct used to retrieve broadcast (EBU) information from a file.
372 ** Strongly (!) based on EBU "bext" chunk format used in Broadcast WAVE.
375 { char description
[256] ;
376 char originator
[32] ;
377 char originator_reference
[32] ;
378 char origination_date
[10] ;
379 char origination_time
[8] ;
380 int time_reference_low
;
381 int time_reference_high
;
384 char reserved
[190] ;
385 unsigned int coding_history_size
;
386 char coding_history
[256] ;
387 } SF_BROADCAST_INFO
;
389 typedef sf_count_t (*sf_vio_get_filelen
) (void *user_data
) ;
390 typedef sf_count_t (*sf_vio_seek
) (sf_count_t offset
, int whence
, void *user_data
) ;
391 typedef sf_count_t (*sf_vio_read
) (void *ptr
, sf_count_t count
, void *user_data
) ;
392 typedef sf_count_t (*sf_vio_write
) (const void *ptr
, sf_count_t count
, void *user_data
) ;
393 typedef sf_count_t (*sf_vio_tell
) (void *user_data
) ;
396 { sf_vio_get_filelen get_filelen
;
403 typedef struct SF_VIRTUAL_IO SF_VIRTUAL_IO
;
405 /* Open the specified file for read, write or both. On error, this will
406 ** return a NULL pointer. To find the error number, pass a NULL SNDFILE
407 ** to sf_perror () or sf_error_str ().
408 ** All calls to sf_open() should be matched with a call to sf_close().
411 SNDFILE
* sf_open (const char *path
, int mode
, SF_INFO
*sfinfo
) ;
413 /* Use the existing file descriptor to create a SNDFILE object. If close_desc
414 ** is TRUE, the file descriptor will be closed when sf_close() is called. If
415 ** it is FALSE, the descritor will not be closed.
416 ** When passed a descriptor like this, the library will assume that the start
417 ** of file header is at the current file offset. This allows sound files within
418 ** larger container files to be read and/or written.
419 ** On error, this will return a NULL pointer. To find the error number, pass a
420 ** NULL SNDFILE to sf_perror () or sf_error_str ().
421 ** All calls to sf_open_fd() should be matched with a call to sf_close().
425 SNDFILE
* sf_open_fd (int fd
, int mode
, SF_INFO
*sfinfo
, int close_desc
) ;
427 SNDFILE
* sf_open_virtual (SF_VIRTUAL_IO
*sfvirtual
, int mode
, SF_INFO
*sfinfo
, void *user_data
) ;
429 /* sf_error () returns a error number which can be translated to a text
430 ** string using sf_error_number().
433 int sf_error (SNDFILE
*sndfile
) ;
435 /* sf_strerror () returns to the caller a pointer to the current error message for
436 ** the given SNDFILE.
439 const char* sf_strerror (SNDFILE
*sndfile
) ;
441 /* sf_error_number () allows the retrieval of the error string for each internal
446 const char* sf_error_number (int errnum
) ;
448 /* The following three error functions are deprecated but they will remain in the
449 ** library for the forseeable future. The function sf_strerror() should be used
453 int sf_perror (SNDFILE
*sndfile
) ;
454 int sf_error_str (SNDFILE
*sndfile
, char* str
, size_t len
) ;
457 /* Return TRUE if fields of the SF_INFO struct are a valid combination of values. */
459 int sf_command (SNDFILE
*sndfile
, int command
, void *data
, int datasize
) ;
461 /* Return TRUE if fields of the SF_INFO struct are a valid combination of values. */
463 int sf_format_check (const SF_INFO
*info
) ;
465 /* Seek within the waveform data chunk of the SNDFILE. sf_seek () uses
466 ** the same values for whence (SEEK_SET, SEEK_CUR and SEEK_END) as
467 ** stdio.h function fseek ().
468 ** An offset of zero with whence set to SEEK_SET will position the
469 ** read / write pointer to the first data sample.
470 ** On success sf_seek returns the current position in (multi-channel)
471 ** samples from the start of the file.
472 ** Please see the libsndfile documentation for moving the read pointer
473 ** separately from the write pointer on files open in mode SFM_RDWR.
474 ** On error all of these functions return -1.
477 sf_count_t
sf_seek (SNDFILE
*sndfile
, sf_count_t frames
, int whence
) ;
479 /* Functions for retrieving and setting string data within sound files.
480 ** Not all file types support this features; AIFF and WAV do. For both
481 ** functions, the str_type parameter must be one of the SF_STR_* values
483 ** On error, sf_set_string() returns non-zero while sf_get_string()
487 int sf_set_string (SNDFILE
*sndfile
, int str_type
, const char* str
) ;
489 const char* sf_get_string (SNDFILE
*sndfile
, int str_type
) ;
491 /* Functions for reading/writing the waveform data of a sound file.
494 sf_count_t
sf_read_raw (SNDFILE
*sndfile
, void *ptr
, sf_count_t bytes
) ;
495 sf_count_t
sf_write_raw (SNDFILE
*sndfile
, const void *ptr
, sf_count_t bytes
) ;
497 /* Functions for reading and writing the data chunk in terms of frames.
498 ** The number of items actually read/written = frames * number of channels.
499 ** sf_xxxx_raw read/writes the raw data bytes from/to the file
500 ** sf_xxxx_short passes data in the native short format
501 ** sf_xxxx_int passes data in the native int format
502 ** sf_xxxx_float passes data in the native float format
503 ** sf_xxxx_double passes data in the native double format
504 ** All of these read/write function return number of frames read/written.
507 sf_count_t
sf_readf_short (SNDFILE
*sndfile
, short *ptr
, sf_count_t frames
) ;
508 sf_count_t
sf_writef_short (SNDFILE
*sndfile
, const short *ptr
, sf_count_t frames
) ;
510 sf_count_t
sf_readf_int (SNDFILE
*sndfile
, int *ptr
, sf_count_t frames
) ;
511 sf_count_t
sf_writef_int (SNDFILE
*sndfile
, const int *ptr
, sf_count_t frames
) ;
513 sf_count_t
sf_readf_float (SNDFILE
*sndfile
, float *ptr
, sf_count_t frames
) ;
514 sf_count_t
sf_writef_float (SNDFILE
*sndfile
, const float *ptr
, sf_count_t frames
) ;
516 sf_count_t
sf_readf_double (SNDFILE
*sndfile
, double *ptr
, sf_count_t frames
) ;
517 sf_count_t
sf_writef_double (SNDFILE
*sndfile
, const double *ptr
, sf_count_t frames
) ;
519 /* Functions for reading and writing the data chunk in terms of items.
520 ** Otherwise similar to above.
521 ** All of these read/write function return number of items read/written.
524 sf_count_t
sf_read_short (SNDFILE
*sndfile
, short *ptr
, sf_count_t items
) ;
525 sf_count_t
sf_write_short (SNDFILE
*sndfile
, const short *ptr
, sf_count_t items
) ;
527 sf_count_t
sf_read_int (SNDFILE
*sndfile
, int *ptr
, sf_count_t items
) ;
528 sf_count_t
sf_write_int (SNDFILE
*sndfile
, const int *ptr
, sf_count_t items
) ;
530 sf_count_t
sf_read_float (SNDFILE
*sndfile
, float *ptr
, sf_count_t items
) ;
531 sf_count_t
sf_write_float (SNDFILE
*sndfile
, const float *ptr
, sf_count_t items
) ;
533 sf_count_t
sf_read_double (SNDFILE
*sndfile
, double *ptr
, sf_count_t items
) ;
534 sf_count_t
sf_write_double (SNDFILE
*sndfile
, const double *ptr
, sf_count_t items
) ;
536 /* Close the SNDFILE and clean up all memory allocations associated with this
538 ** Returns 0 on success, or an error number.
541 int sf_close (SNDFILE
*sndfile
) ;
543 /* If the file is opened SFM_WRITE or SFM_RDWR, call fsync() on the file
544 ** to force the writing of data to disk. If the file is opened SFM_READ
545 ** no action is taken.
548 void sf_write_sync (SNDFILE
*sndfile
) ;
552 #endif /* __cplusplus */
554 #endif /* SNDFILE_H */