<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>libfishsound: constants.h Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.6.2-20100208 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>Globals</span></a></li> </ul> </div> <h1>constants.h</h1><a href="constants_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span> <a name="l00002"></a>00002 <span class="comment"> Copyright (C) 2003 Commonwealth Scientific and Industrial Research</span> <a name="l00003"></a>00003 <span class="comment"> Organisation (CSIRO) Australia</span> <a name="l00004"></a>00004 <span class="comment"></span> <a name="l00005"></a>00005 <span class="comment"> Redistribution and use in source and binary forms, with or without</span> <a name="l00006"></a>00006 <span class="comment"> modification, are permitted provided that the following conditions</span> <a name="l00007"></a>00007 <span class="comment"> are met:</span> <a name="l00008"></a>00008 <span class="comment"></span> <a name="l00009"></a>00009 <span class="comment"> - Redistributions of source code must retain the above copyright</span> <a name="l00010"></a>00010 <span class="comment"> notice, this list of conditions and the following disclaimer.</span> <a name="l00011"></a>00011 <span class="comment"></span> <a name="l00012"></a>00012 <span class="comment"> - Redistributions in binary form must reproduce the above copyright</span> <a name="l00013"></a>00013 <span class="comment"> notice, this list of conditions and the following disclaimer in the</span> <a name="l00014"></a>00014 <span class="comment"> documentation and/or other materials provided with the distribution.</span> <a name="l00015"></a>00015 <span class="comment"></span> <a name="l00016"></a>00016 <span class="comment"> - Neither the name of CSIRO Australia nor the names of its</span> <a name="l00017"></a>00017 <span class="comment"> contributors may be used to endorse or promote products derived from</span> <a name="l00018"></a>00018 <span class="comment"> this software without specific prior written permission.</span> <a name="l00019"></a>00019 <span class="comment"></span> <a name="l00020"></a>00020 <span class="comment"> THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS</span> <a name="l00021"></a>00021 <span class="comment"> ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT</span> <a name="l00022"></a>00022 <span class="comment"> LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A</span> <a name="l00023"></a>00023 <span class="comment"> PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE ORGANISATION OR</span> <a name="l00024"></a>00024 <span class="comment"> CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,</span> <a name="l00025"></a>00025 <span class="comment"> EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,</span> <a name="l00026"></a>00026 <span class="comment"> PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR</span> <a name="l00027"></a>00027 <span class="comment"> PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF</span> <a name="l00028"></a>00028 <span class="comment"> LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING</span> <a name="l00029"></a>00029 <span class="comment"> NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS</span> <a name="l00030"></a>00030 <span class="comment"> SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span> <a name="l00031"></a>00031 <span class="comment">*/</span> <a name="l00032"></a>00032 <a name="l00033"></a>00033 <span class="preprocessor">#ifndef __FISH_SOUND_CONSTANTS_H__</span> <a name="l00034"></a>00034 <span class="preprocessor"></span><span class="preprocessor">#define __FISH_SOUND_CONSTANTS_H__</span> <a name="l00035"></a>00035 <span class="preprocessor"></span> <a name="l00041"></a><a class="code" href="constants_8h.html#ac949e5a5c7f16cc7fd9d096a39608f34">00041</a> <span class="keyword">typedef</span> <span class="keyword">enum</span> <a class="code" href="constants_8h.html#ac949e5a5c7f16cc7fd9d096a39608f34" title="Mode of operation (encode or decode).">_FishSoundMode</a> { <a name="l00043"></a><a class="code" href="constants_8h.html#ac949e5a5c7f16cc7fd9d096a39608f34a6c1e6f5a1f6342f9c36416d9ee9753ae">00043</a> <a class="code" href="constants_8h.html#ac949e5a5c7f16cc7fd9d096a39608f34a6c1e6f5a1f6342f9c36416d9ee9753ae" title="Decode.">FISH_SOUND_DECODE</a> = 0x10, <a name="l00044"></a>00044 <a name="l00046"></a><a class="code" href="constants_8h.html#ac949e5a5c7f16cc7fd9d096a39608f34a3270a746cfa774a469f9783b6848279d">00046</a> <a class="code" href="constants_8h.html#ac949e5a5c7f16cc7fd9d096a39608f34a3270a746cfa774a469f9783b6848279d" title="Encode.">FISH_SOUND_ENCODE</a> = 0x20 <a name="l00047"></a>00047 } <a class="code" href="constants_8h.html#a9d9c3b4fa48a4b733a4ea8014fca8d98" title="Mode of operation (encode or decode).">FishSoundMode</a>; <a name="l00048"></a>00048 <a name="l00050"></a><a class="code" href="constants_8h.html#aff8c305ecaa5b4dc29894d5d3fefbc08">00050</a> <span class="keyword">typedef</span> <span class="keyword">enum</span> <a class="code" href="constants_8h.html#aff8c305ecaa5b4dc29894d5d3fefbc08" title="Identifiers for supported codecs.">_FishSoundCodecID</a> { <a name="l00052"></a><a class="code" href="constants_8h.html#aff8c305ecaa5b4dc29894d5d3fefbc08a1d6c7c1c4837bc1953fe3ae1962206cb">00052</a> <a class="code" href="constants_8h.html#aff8c305ecaa5b4dc29894d5d3fefbc08a1d6c7c1c4837bc1953fe3ae1962206cb" title="Unknown.">FISH_SOUND_UNKNOWN</a> = 0x00, <a name="l00053"></a>00053 <a name="l00055"></a><a class="code" href="constants_8h.html#aff8c305ecaa5b4dc29894d5d3fefbc08a219b41711c75ec89b1841e804139ceb1">00055</a> <a class="code" href="constants_8h.html#aff8c305ecaa5b4dc29894d5d3fefbc08a219b41711c75ec89b1841e804139ceb1" title="Vorbis.">FISH_SOUND_VORBIS</a> = 0x01, <a name="l00056"></a>00056 <a name="l00058"></a><a class="code" href="constants_8h.html#aff8c305ecaa5b4dc29894d5d3fefbc08aa708255d1f23a5a5db6f1c2d60778eb9">00058</a> <a class="code" href="constants_8h.html#aff8c305ecaa5b4dc29894d5d3fefbc08aa708255d1f23a5a5db6f1c2d60778eb9" title="Speex.">FISH_SOUND_SPEEX</a> = 0x02, <a name="l00059"></a>00059 <a name="l00061"></a><a class="code" href="constants_8h.html#aff8c305ecaa5b4dc29894d5d3fefbc08a528dd24db0ba08599924e7476efd0469">00061</a> <a class="code" href="constants_8h.html#aff8c305ecaa5b4dc29894d5d3fefbc08a528dd24db0ba08599924e7476efd0469" title="Flac.">FISH_SOUND_FLAC</a> = 0x03 <a name="l00062"></a>00062 } <a class="code" href="constants_8h.html#aecd02a43422e57cac405a5430289122d" title="Identifiers for supported codecs.">FishSoundCodecID</a>; <a name="l00063"></a>00063 <a name="l00065"></a><a class="code" href="constants_8h.html#a8c3fed4bcbe1fa029b21e433684d22d9">00065</a> <span class="keyword">typedef</span> <span class="keyword">enum</span> <a class="code" href="constants_8h.html#a8c3fed4bcbe1fa029b21e433684d22d9" title="Decode callback return values.">_FishSoundStopCtl</a> { <a name="l00067"></a><a class="code" href="constants_8h.html#a8c3fed4bcbe1fa029b21e433684d22d9a52b16425c46db26ba17e4dc346af4cd0">00067</a> <a class="code" href="constants_8h.html#a8c3fed4bcbe1fa029b21e433684d22d9a52b16425c46db26ba17e4dc346af4cd0" title="Continue calling decode callbacks.">FISH_SOUND_CONTINUE</a> = 0, <a name="l00068"></a>00068 <a name="l00070"></a><a class="code" href="constants_8h.html#a8c3fed4bcbe1fa029b21e433684d22d9aee1cd144f456275b2294055ad636e4a0">00070</a> <a class="code" href="constants_8h.html#a8c3fed4bcbe1fa029b21e433684d22d9aee1cd144f456275b2294055ad636e4a0" title="Stop calling callbacks, but retain buffered data.">FISH_SOUND_STOP_OK</a> = 1, <a name="l00071"></a>00071 <a name="l00073"></a><a class="code" href="constants_8h.html#a8c3fed4bcbe1fa029b21e433684d22d9ae25023d0fdd1cc19780661163243f1a2">00073</a> <a class="code" href="constants_8h.html#a8c3fed4bcbe1fa029b21e433684d22d9ae25023d0fdd1cc19780661163243f1a2" title="Stop calling callbacks, and purge buffered data.">FISH_SOUND_STOP_ERR</a> = -1 <a name="l00074"></a>00074 } <a class="code" href="constants_8h.html#a73ef8d2d14c2d8314dff3b8f3fce4b77" title="Decode callback return values.">FishSoundStopCtl</a>; <a name="l00075"></a>00075 <a name="l00077"></a><a class="code" href="constants_8h.html#a7a185639e7fea0051f22b28fdb852048">00077</a> <span class="keyword">typedef</span> <span class="keyword">enum</span> <a class="code" href="constants_8h.html#a7a185639e7fea0051f22b28fdb852048" title="Command codes.">_FishSoundCommand</a> { <a name="l00079"></a><a class="code" href="constants_8h.html#a7a185639e7fea0051f22b28fdb852048aaec6ad00ae908f69f8136e240641d02d">00079</a> <a class="code" href="constants_8h.html#a7a185639e7fea0051f22b28fdb852048aaec6ad00ae908f69f8136e240641d02d" title="No operation.">FISH_SOUND_COMMAND_NOP</a> = 0x0000, <a name="l00080"></a>00080 <a name="l00082"></a><a class="code" href="constants_8h.html#a7a185639e7fea0051f22b28fdb852048acd9f0a7348d01ca7ea3ce461245ac1dd">00082</a> <a class="code" href="constants_8h.html#a7a185639e7fea0051f22b28fdb852048acd9f0a7348d01ca7ea3ce461245ac1dd" title="Retrieve the FishSoundInfo.">FISH_SOUND_GET_INFO</a> = 0x1000, <a name="l00083"></a>00083 <a name="l00085"></a><a class="code" href="constants_8h.html#a7a185639e7fea0051f22b28fdb852048a5c3a09a7d6a091dfeadf3570ec5c946e">00085</a> <a class="code" href="constants_8h.html#a7a185639e7fea0051f22b28fdb852048a5c3a09a7d6a091dfeadf3570ec5c946e" title="Query if multichannel audio should be interpreted as interleaved.">FISH_SOUND_GET_INTERLEAVE</a> = 0x2000, <a name="l00086"></a>00086 <a name="l00088"></a><a class="code" href="constants_8h.html#a7a185639e7fea0051f22b28fdb852048ae026d28834d67d6df88e57f1d9f4a031">00088</a> <a class="code" href="constants_8h.html#a7a185639e7fea0051f22b28fdb852048ae026d28834d67d6df88e57f1d9f4a031" title="Set to 1 to interleave, 0 to non-interleave.">FISH_SOUND_SET_INTERLEAVE</a> = 0x2001, <a name="l00089"></a>00089 <a name="l00090"></a>00090 FISH_SOUND_SET_ENCODE_VBR = 0x4000, <a name="l00091"></a>00091 <a name="l00092"></a>00092 FISH_SOUND_COMMAND_MAX <a name="l00093"></a>00093 } <a class="code" href="constants_8h.html#a18b0ff610b82227e8dced33c6b7944f5" title="Command codes.">FishSoundCommand</a>; <a name="l00094"></a>00094 <a name="l00096"></a><a class="code" href="constants_8h.html#aa31123e4a584a5d35b9ed87c9b43e235">00096</a> <span class="keyword">typedef</span> <span class="keyword">enum</span> <a class="code" href="constants_8h.html#aa31123e4a584a5d35b9ed87c9b43e235" title="Error values.">_FishSoundError</a> { <a name="l00098"></a><a class="code" href="constants_8h.html#aa31123e4a584a5d35b9ed87c9b43e235a398c3bfdfe8e7030de26d13393d0f77c">00098</a> <a class="code" href="constants_8h.html#aa31123e4a584a5d35b9ed87c9b43e235a398c3bfdfe8e7030de26d13393d0f77c" title="No error.">FISH_SOUND_OK</a> = 0, <a name="l00099"></a>00099 <a name="l00101"></a><a class="code" href="constants_8h.html#aa31123e4a584a5d35b9ed87c9b43e235aa80028f76bb6cc1cdd092e9eeef99730">00101</a> <a class="code" href="constants_8h.html#aa31123e4a584a5d35b9ed87c9b43e235aa80028f76bb6cc1cdd092e9eeef99730" title="generic error">FISH_SOUND_ERR_GENERIC</a> = -1, <a name="l00102"></a>00102 <a name="l00104"></a><a class="code" href="constants_8h.html#aa31123e4a584a5d35b9ed87c9b43e235a96b7865eacdd843cd2b53e6d3427bd26">00104</a> <a class="code" href="constants_8h.html#aa31123e4a584a5d35b9ed87c9b43e235a96b7865eacdd843cd2b53e6d3427bd26" title="Not a valid FishSound* handle.">FISH_SOUND_ERR_BAD</a> = -2, <a name="l00105"></a>00105 <a name="l00107"></a><a class="code" href="constants_8h.html#aa31123e4a584a5d35b9ed87c9b43e235aad5c4cda6fecfb092ee39df81795d2a8">00107</a> <a class="code" href="constants_8h.html#aa31123e4a584a5d35b9ed87c9b43e235aad5c4cda6fecfb092ee39df81795d2a8" title="The requested operation is not suitable for this FishSound* handle.">FISH_SOUND_ERR_INVALID</a> = -3, <a name="l00108"></a>00108 <a name="l00110"></a><a class="code" href="constants_8h.html#aa31123e4a584a5d35b9ed87c9b43e235a0c3f04fa2357d23d7948ef5e8a167273">00110</a> <a class="code" href="constants_8h.html#aa31123e4a584a5d35b9ed87c9b43e235a0c3f04fa2357d23d7948ef5e8a167273" title="Out of memory.">FISH_SOUND_ERR_OUT_OF_MEMORY</a> = -4, <a name="l00111"></a>00111 <a name="l00113"></a><a class="code" href="constants_8h.html#aa31123e4a584a5d35b9ed87c9b43e235a6e34ea5172345c82c43437a0708c6567">00113</a> <a class="code" href="constants_8h.html#aa31123e4a584a5d35b9ed87c9b43e235a6e34ea5172345c82c43437a0708c6567" title="Functionality disabled at build time.">FISH_SOUND_ERR_DISABLED</a> = -10, <a name="l00114"></a>00114 <a name="l00116"></a><a class="code" href="constants_8h.html#aa31123e4a584a5d35b9ed87c9b43e235a03320f8b346b8bcb984421c4c72cf347">00116</a> <a class="code" href="constants_8h.html#aa31123e4a584a5d35b9ed87c9b43e235a03320f8b346b8bcb984421c4c72cf347" title="Too few bytes passed to fish_sound_identify().">FISH_SOUND_ERR_SHORT_IDENTIFY</a> = -20, <a name="l00117"></a>00117 <a name="l00119"></a><a class="code" href="constants_8h.html#aa31123e4a584a5d35b9ed87c9b43e235a1782c042f659a9fb415292a722b04150">00119</a> <a class="code" href="constants_8h.html#aa31123e4a584a5d35b9ed87c9b43e235a1782c042f659a9fb415292a722b04150" title="Comment violates VorbisComment restrictions.">FISH_SOUND_ERR_COMMENT_INVALID</a> = -21 <a name="l00120"></a>00120 } <a class="code" href="constants_8h.html#a8977064c438e05393156a731c9c8ae86" title="Error values.">FishSoundError</a>; <a name="l00121"></a>00121 <a name="l00122"></a>00122 <span class="preprocessor">#endif </span><span class="comment">/* __FISH_SOUND_CONSTANTS_H__ */</span> </pre></div></div> <hr class="footer"/><address style="text-align: right;"><small>Generated by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2-20100208 </small></address> </body> </html>