sndfile.h
上传用户:tjmskj2
上传日期:2020-08-17
资源大小:577k
文件大小:14k
源码类别:

midi

开发平台:

C/C++

  1. /*
  2. ** Copyright (C) 1999-2003 Erik de Castro Lopo <erikd@zip.com.au>
  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. ** sndfile.h -- system-wide definitions
  20. **
  21. ** API documentation is in the doc/ directory of the source code tarball
  22. ** and at http://www.zip.com.au/~erikd/libsndfile/api.html.
  23. */
  24. #ifndef SNDFILE_H
  25. #define SNDFILE_H
  26. /* This is the version 1.0.X header file. */
  27. #define SNDFILE_1
  28. #include <stdio.h>
  29. #include <stdlib.h>
  30. /* For the Metrowerks CodeWarrior Pro Compiler (mainly MacOS) */
  31. #if (defined (__MWERKS__))
  32. #include <unix.h>
  33. #else
  34. #include <sys/types.h>
  35. #endif
  36. #ifdef __cplusplus
  37. extern "C" {
  38. #endif /* __cplusplus */
  39. /* The following file types can be read and written.
  40. ** A file type would consist of a major type (ie SF_FORMAT_WAV) bitwise
  41. ** ORed with a minor type (ie SF_FORMAT_PCM). SF_FORMAT_TYPEMASK and
  42. ** SF_FORMAT_SUBMASK can be used to separate the major and minor file
  43. ** types.
  44. */
  45. enum
  46. { /* Major formats. */
  47. SF_FORMAT_WAV = 0x010000, /* Microsoft WAV format (little endian). */
  48. SF_FORMAT_AIFF = 0x020000, /* Apple/SGI AIFF format (big endian). */
  49. SF_FORMAT_AU = 0x030000, /* Sun/NeXT AU format (big endian). */
  50. SF_FORMAT_RAW = 0x040000, /* RAW PCM data. */
  51. SF_FORMAT_PAF = 0x050000, /* Ensoniq PARIS file format. */
  52. SF_FORMAT_SVX = 0x060000, /* Amiga IFF / SVX8 / SV16 format. */
  53. SF_FORMAT_NIST = 0x070000, /* Sphere NIST format. */
  54. SF_FORMAT_VOC = 0x080000, /* VOC files. */
  55. SF_FORMAT_IRCAM = 0x0A0000, /* Berkeley/IRCAM/CARL */
  56. SF_FORMAT_W64 = 0x0B0000, /* Sonic Foundry's 64 bit RIFF/WAV */
  57. SF_FORMAT_MAT4 = 0x0C0000, /* Matlab (tm) V4.2 / GNU Octave 2.0 */
  58. SF_FORMAT_MAT5 = 0x0D0000, /* Matlab (tm) V5.0 / GNU Octave 2.1 */
  59. SF_FORMAT_PVF = 0x0E0000, /* Portable Voice Format */
  60. SF_FORMAT_XI = 0x0F0000, /* Fasttracker 2 Extended Instrument */
  61. SF_FORMAT_HTK = 0x100000, /* HMM Tool Kit format */
  62. /* Subtypes from here on. */
  63. SF_FORMAT_PCM_S8 = 0x0001, /* Signed 8 bit data */
  64. SF_FORMAT_PCM_16 = 0x0002, /* Signed 16 bit data */
  65. SF_FORMAT_PCM_24 = 0x0003, /* Signed 24 bit data */
  66. SF_FORMAT_PCM_32 = 0x0004, /* Signed 32 bit data */
  67. SF_FORMAT_PCM_U8 = 0x0005, /* Unsigned 8 bit data (WAV and RAW only) */
  68. SF_FORMAT_FLOAT = 0x0006, /* 32 bit float data */
  69. SF_FORMAT_DOUBLE = 0x0007, /* 64 bit float data */
  70. SF_FORMAT_ULAW = 0x0010, /* U-Law encoded. */
  71. SF_FORMAT_ALAW = 0x0011, /* A-Law encoded. */
  72. SF_FORMAT_IMA_ADPCM = 0x0012, /* IMA ADPCM. */
  73. SF_FORMAT_MS_ADPCM = 0x0013, /* Microsoft ADPCM. */
  74. SF_FORMAT_GSM610 = 0x0020, /* GSM 6.10 encoding. */
  75. SF_FORMAT_VOX_ADPCM = 0x0021, /* OKI / Dialogix ADPCM */
  76. SF_FORMAT_G721_32 = 0x0030, /* 32kbs G721 ADPCM encoding. */
  77. SF_FORMAT_G723_24 = 0x0031, /* 24kbs G723 ADPCM encoding. */
  78. SF_FORMAT_G723_40 = 0x0032, /* 40kbs G723 ADPCM encoding. */
  79. SF_FORMAT_DWVW_12 = 0x0040,  /* 12 bit Delta Width Variable Word encoding. */
  80. SF_FORMAT_DWVW_16 = 0x0041,  /* 16 bit Delta Width Variable Word encoding. */
  81. SF_FORMAT_DWVW_24 = 0x0042,  /* 24 bit Delta Width Variable Word encoding. */
  82. SF_FORMAT_DWVW_N = 0x0043,  /* N bit Delta Width Variable Word encoding. */
  83. SF_FORMAT_DPCM_8 = 0x0050, /* 8 bit differential PCM (XI only) */
  84. SF_FORMAT_DPCM_16 = 0x0051, /* 16 bit differential PCM (XI only) */
  85. /* Endian-ness options. */
  86. SF_ENDIAN_FILE = 0x00000000, /* Default file endian-ness. */
  87. SF_ENDIAN_LITTLE = 0x10000000, /* Force little endian-ness. */
  88. SF_ENDIAN_BIG = 0x20000000, /* Force big endian-ness. */
  89. SF_ENDIAN_CPU = 0x30000000, /* Force CPU endian-ness. */
  90. SF_FORMAT_SUBMASK = 0x0000FFFF,
  91. SF_FORMAT_TYPEMASK = 0x0FFF0000,
  92. SF_FORMAT_ENDMASK = 0x30000000
  93. } ;
  94. /*
  95. ** The following are the valid command numbers for the sf_command()
  96. ** interface.  The use of these commands is documented in the file
  97. ** command.html in the doc directory of the source code distribution.
  98. */
  99. enum
  100. { SFC_GET_LIB_VERSION = 0x1000,
  101. SFC_GET_LOG_INFO = 0x1001,
  102. SFC_GET_NORM_DOUBLE = 0x1010,
  103. SFC_GET_NORM_FLOAT = 0x1011,
  104. SFC_SET_NORM_DOUBLE = 0x1012,
  105. SFC_SET_NORM_FLOAT = 0x1013,
  106. SFC_GET_SIMPLE_FORMAT_COUNT = 0x1020,
  107. SFC_GET_SIMPLE_FORMAT = 0x1021,
  108. SFC_GET_FORMAT_INFO = 0x1028,
  109. SFC_GET_FORMAT_MAJOR_COUNT = 0x1030,
  110. SFC_GET_FORMAT_MAJOR = 0x1031,
  111. SFC_GET_FORMAT_SUBTYPE_COUNT = 0x1032,
  112. SFC_GET_FORMAT_SUBTYPE = 0x1033,
  113. SFC_CALC_SIGNAL_MAX = 0x1040,
  114. SFC_CALC_NORM_SIGNAL_MAX = 0x1041,
  115. SFC_CALC_MAX_ALL_CHANNELS = 0x1042,
  116. SFC_CALC_NORM_MAX_ALL_CHANNELS = 0x1043,
  117. SFC_SET_ADD_PEAK_CHUNK = 0x1050,
  118. SFC_UPDATE_HEADER_NOW = 0x1060,
  119. SFC_SET_UPDATE_HEADER_AUTO = 0x1061,
  120. SFC_FILE_TRUNCATE = 0x1080,
  121. SFC_SET_RAW_START_OFFSET = 0x1090,
  122. SFC_SET_DITHER_ON_WRITE = 0x10A0,
  123. SFC_SET_DITHER_ON_READ = 0x10A1,
  124. SFC_GET_DITHER_INFO_COUNT = 0x10A2,
  125. SFC_GET_DITHER_INFO = 0x10A3,
  126. SFC_GET_EMBED_FILE_INFO = 0x10B0,
  127. /* Following commands for testing only. */
  128. SFC_TEST_IEEE_FLOAT_REPLACE = 0x6001,
  129. /*
  130. ** SFC_SET_ADD_* values are deprecated and will disappear at some
  131. ** time in the future. They are guaranteed to be here up to and 
  132. ** including version 1.0.8 to avoid breakage of existng software. 
  133. ** They currently do nothing and will continue to do nothing. 
  134. */
  135. SFC_SET_ADD_DITHER_ON_WRITE = 0x1070,
  136. SFC_SET_ADD_DITHER_ON_READ = 0x1071
  137. } ;
  138. /*
  139. ** String types that can be set and read from files. Not all file types
  140. ** support this and even the file types which support one, may not support
  141. ** all string types.
  142. */
  143. enum
  144. { SF_STR_TITLE = 0x01,
  145. SF_STR_COPYRIGHT = 0x02,
  146. SF_STR_SOFTWARE = 0x03,
  147. SF_STR_ARTIST = 0x04,
  148. SF_STR_COMMENT = 0x05,
  149. SF_STR_DATE = 0x06
  150. } ;
  151. enum
  152. { /* True and false */
  153. SF_FALSE = 0,
  154. SF_TRUE = 1,
  155. /* Modes for opening files. */
  156. SFM_READ = 0x10,
  157. SFM_WRITE = 0x20,
  158. SFM_RDWR = 0x30
  159. } ;
  160. /* Pubic error values. These are guaranteed to remain unchanged for the duration
  161. ** of the library major version number. 
  162. ** There are also a large number of private error numbers which are internal to
  163. ** the library which can change at any time.
  164. */
  165. enum
  166. { SF_ERR_NO_ERROR      = 0,
  167. SF_ERR_UNRECOGNISED_FORMAT = 1,
  168. SF_ERR_SYSTEM = 2
  169. } ;
  170. /* A SNDFILE* pointer can be passed around much like stdio.h's FILE* pointer. */
  171. typedef void SNDFILE ;
  172. typedef __int64 sf_count_t ;
  173. /* A pointer to a SF_INFO structure is passed to sf_open_read () and filled in.
  174. ** On write, the SF_INFO structure is filled in by the user and passed into
  175. ** sf_open_write ().
  176. */
  177. struct SF_INFO
  178. { sf_count_t frames ; /* Used to be called samples.  Changed to avoid confusion. */
  179. int samplerate ;
  180. int channels ;
  181. int format ;
  182. int sections ;
  183. int seekable ;
  184. } ;
  185. typedef struct SF_INFO SF_INFO ;
  186. /* The SF_FORMAT_INFO struct is used to retrieve information about the sound
  187. ** file formats libsndfile supports using the sf_command () interface.
  188. **
  189. ** Using this interface will allow applications to support new file formats
  190. ** and encoding types when libsndfile is upgraded, without requiring
  191. ** re-compilation of the application.
  192. **
  193. ** Please consult the libsndfile documentation (particularly the information
  194. ** on the sf_command () interface) for examples of its use.
  195. */
  196. typedef struct
  197. { int format ;
  198. const char  *name ;
  199. const char  *extension ;
  200. } SF_FORMAT_INFO ;
  201. /*
  202. ** Enums and typedefs for adding dither on read and write. 
  203. ** See the html documentation for sf_command(), SFC_SET_DITHER_ON_WRITE 
  204. ** and SFC_SET_DITHER_ON_READ.
  205. */
  206. enum
  207. { SFD_DEFAULT_LEVEL = 0,
  208. SFD_CUSTOM_LEVEL = 0x40000000,
  209. SFD_NO_DITHER = 500,
  210. SFD_WHITE = 501,
  211. SFD_TRIANGULAR_PDF = 502
  212. } ;
  213. typedef struct
  214. { int type ;
  215. double level ;
  216. const char *name ;
  217. } SF_DITHER_INFO ;
  218. /* Struct used to retrieve information about a file embedded within a
  219. ** larger file. See SF_GET_EMBED_FILE_INFO.
  220. */
  221. typedef struct
  222. { sf_count_t offset ;
  223. sf_count_t length ;
  224. } SF_EMBED_FILE_INFO ;
  225. /* Open the specified file for read, write or both. On error, this will
  226. ** return a NULL pointer. To find the error number, pass a NULL SNDFILE
  227. ** to sf_perror () or sf_error_str ().
  228. ** All calls to sf_open() should be matched with a call to sf_close().
  229. */
  230. SNDFILE*  sf_open (const char *path, int mode, SF_INFO *sfinfo) ;
  231. /* Use the existing file descriptor to create a SNDFILE object. If close_desc
  232. ** is TRUE, the file descriptor will be closed when sf_close() is called. If
  233. ** it is FALSE, the descritor will not be closed.
  234. ** When passed a descriptor like this, the library will assume that the start
  235. ** of file header is at the current file offset. This allows sound files within
  236. ** larger container files to be read and/or written.
  237. ** On error, this will return a NULL pointer. To find the error number, pass a 
  238. ** NULL SNDFILE to sf_perror () or sf_error_str ().
  239. ** All calls to sf_open_fd() should be matched with a call to sf_close().
  240. */
  241. SNDFILE*  sf_open_fd (int fd, int mode, SF_INFO *sfinfo, int close_desc) ;
  242. /* sf_error () returns a error number which can be translated to a text 
  243. ** string using sf_error_number().
  244. */
  245. int sf_error (SNDFILE *sndfile) ;
  246. /* sf_strerror () returns to the caller a pointer to the current error message for 
  247. ** the given SNDFILE.
  248. */
  249. const char* sf_strerror (SNDFILE *sndfile) ;
  250. /* sf_error_number () allows the retrieval of the error string for each internal
  251. ** error number. 
  252. **
  253. */
  254. const char* sf_error_number (int errnum) ;
  255. /* The following three error functions are deprecated but they will remain in the
  256. ** library for the forseeable future. The function sf_strerror() should be used
  257. ** in their place.
  258. */
  259. int sf_perror (SNDFILE *sndfile) ;
  260. int sf_error_str (SNDFILE *sndfile, char* str, size_t len) ;
  261. /* Return TRUE if fields of the SF_INFO struct are a valid combination of values. */
  262. int sf_command (SNDFILE *sndfile, int command, void *data, int datasize) ;
  263. /* Return TRUE if fields of the SF_INFO struct are a valid combination of values. */
  264. int sf_format_check (const SF_INFO *info) ;
  265. /* Seek within the waveform data chunk of the SNDFILE. sf_seek () uses
  266. ** the same values for whence (SEEK_SET, SEEK_CUR and SEEK_END) as
  267. ** stdio.h function fseek ().
  268. ** An offset of zero with whence set to SEEK_SET will position the
  269. ** read / write pointer to the first data sample.
  270. ** On success sf_seek returns the current position in (multi-channel)
  271. ** samples from the start of the file.
  272. ** Please see the libsndfile documentation for moving the read pointer
  273. ** separately from the write pointer on files open in mode SFM_RDWR.
  274. ** On error all of these functions return -1.
  275. */
  276. sf_count_t sf_seek  (SNDFILE *sndfile, sf_count_t frames, int whence) ;
  277. /* Functions for retrieving and setting string data within sound files.
  278. ** Not all file types support this features; AIFF and WAV do. For both
  279. ** functions, the str_type parameter must be one of the SF_STR_* values
  280. ** defined above.
  281. ** On error, sf_set_string() returns non-zero while sf_get_string()
  282. ** returns NULL.
  283. */
  284. int sf_set_string (SNDFILE *sndfile, int str_type, const char* str) ;
  285. const char* sf_get_string (SNDFILE *sndfile, int str_type) ;
  286. /* Functions for reading/writing the waveform data of a sound file.
  287. */
  288. sf_count_t sf_read_raw (SNDFILE *sndfile, void *ptr, sf_count_t bytes) ;
  289. sf_count_t sf_write_raw  (SNDFILE *sndfile, void *ptr, sf_count_t bytes) ;
  290. /* Functions for reading and writing the data chunk in terms of frames.
  291. ** The number of items actually read/written = frames * number of channels.
  292. **     sf_xxxx_raw read/writes the raw data bytes from/to the file
  293. **     sf_xxxx_short passes data in the native short format
  294. **     sf_xxxx_int passes data in the native int format
  295. **     sf_xxxx_float passes data in the native float format
  296. **     sf_xxxx_double passes data in the native double format
  297. ** All of these read/write function return number of frames read/written.
  298. */
  299. sf_count_t sf_readf_short (SNDFILE *sndfile, short *ptr, sf_count_t frames) ;
  300. sf_count_t sf_writef_short (SNDFILE *sndfile, short *ptr, sf_count_t frames) ;
  301. sf_count_t sf_readf_int (SNDFILE *sndfile, int *ptr, sf_count_t frames) ;
  302. sf_count_t sf_writef_int  (SNDFILE *sndfile, int *ptr, sf_count_t frames) ;
  303. sf_count_t sf_readf_float (SNDFILE *sndfile, float *ptr, sf_count_t frames) ;
  304. sf_count_t sf_writef_float (SNDFILE *sndfile, float *ptr, sf_count_t frames) ;
  305. sf_count_t sf_readf_double (SNDFILE *sndfile, double *ptr, sf_count_t frames) ;
  306. sf_count_t sf_writef_double(SNDFILE *sndfile, double *ptr, sf_count_t frames) ;
  307. /* Functions for reading and writing the data chunk in terms of items.
  308. ** Otherwise similar to above.
  309. ** All of these read/write function return number of items read/written.
  310. */
  311. sf_count_t sf_read_short (SNDFILE *sndfile, short *ptr, sf_count_t items) ;
  312. sf_count_t sf_write_short (SNDFILE *sndfile, short *ptr, sf_count_t items) ;
  313. sf_count_t sf_read_int (SNDFILE *sndfile, int *ptr, sf_count_t items) ;
  314. sf_count_t sf_write_int  (SNDFILE *sndfile, int *ptr, sf_count_t items) ;
  315. sf_count_t sf_read_float (SNDFILE *sndfile, float *ptr, sf_count_t items) ;
  316. sf_count_t sf_write_float (SNDFILE *sndfile, float *ptr, sf_count_t items) ;
  317. sf_count_t sf_read_double (SNDFILE *sndfile, double *ptr, sf_count_t items) ;
  318. sf_count_t sf_write_double (SNDFILE *sndfile, double *ptr, sf_count_t items) ;
  319. /* Close the SNDFILE and clean up all memory allocations associated with this
  320. ** file. 
  321. ** Returns 0 on success, or an error number. 
  322. */
  323. int sf_close (SNDFILE *sndfile) ;
  324. #ifdef __cplusplus
  325. } /* extern "C" */
  326. #endif /* __cplusplus */
  327. #endif /* SNDFILE_H */