<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>libfishsound: fishsound.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.5.8 -->
<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>fishsound.h</h1><a href="fishsound_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_H__</span>
<a name="l00034"></a>00034 <span class="preprocessor"></span><span class="preprocessor">#define __FISH_SOUND_H__</span>
<a name="l00035"></a>00035 <span class="preprocessor"></span>
<a name="l00036"></a>00036 <span class="preprocessor">#include <<a class="code" href="constants_8h.html" title="Constants used by libfishsound.">fishsound/constants.h</a>></span>
<a name="l00037"></a>00037
<a name="l00404"></a><a class="code" href="structFishSoundInfo.html">00404</a> <span class="keyword">typedef</span> <span class="keyword">struct </span>{
<a name="l00406"></a><a class="code" href="structFishSoundInfo.html#9b19fb535b78f4df6cd4a275a595e736">00406</a> <span class="keywordtype">int</span> samplerate;
<a name="l00407"></a>00407
<a name="l00409"></a><a class="code" href="structFishSoundInfo.html#c1e2bc71184e6311f54ff6bcd9160123">00409</a> <span class="keywordtype">int</span> channels;
<a name="l00410"></a>00410
<a name="l00412"></a><a class="code" href="structFishSoundInfo.html#3fd250e7150ce5eb58737f715264e913">00412</a> <span class="keywordtype">int</span> format;
<a name="l00413"></a>00413 } <a class="code" href="structFishSoundInfo.html" title="Info about a particular encoder/decoder instance.">FishSoundInfo</a>;
<a name="l00414"></a>00414
<a name="l00418"></a><a class="code" href="structFishSoundFormat.html">00418</a> <span class="keyword">typedef</span> <span class="keyword">struct </span>{
<a name="l00420"></a><a class="code" href="structFishSoundFormat.html#d8e6fadc27abace836321a7f92971c2b">00420</a> <span class="keywordtype">int</span> format;
<a name="l00421"></a>00421
<a name="l00423"></a><a class="code" href="structFishSoundFormat.html#cb3416e65b3622a229f5eb835edc1ac0">00423</a> <span class="keyword">const</span> <span class="keywordtype">char</span> * name;
<a name="l00424"></a>00424
<a name="l00426"></a><a class="code" href="structFishSoundFormat.html#da9c478e59bad75dc2a0b4cb012534b9">00426</a> <span class="keyword">const</span> <span class="keywordtype">char</span> * extension;
<a name="l00427"></a>00427 } <a class="code" href="structFishSoundFormat.html" title="Info about a particular sound format.">FishSoundFormat</a>;
<a name="l00428"></a>00428
<a name="l00433"></a><a class="code" href="fishsound_8h.html#8cfb7dfb102ad1af9ff35046aed3ccd9">00433</a> <span class="keyword">typedef</span> <span class="keywordtype">void</span> * <a class="code" href="fishsound_8h.html#8cfb7dfb102ad1af9ff35046aed3ccd9" title="An opaque handle to a FishSound.">FishSound</a>;
<a name="l00434"></a>00434
<a name="l00435"></a>00435 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00436"></a>00436 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
<a name="l00437"></a>00437 <span class="preprocessor">#endif</span>
<a name="l00438"></a>00438 <span class="preprocessor"></span>
<a name="l00456"></a>00456 <span class="keywordtype">int</span>
<a name="l00457"></a>00457 <a class="code" href="fishsound_8h.html#2776f39cfa1540b1da3c9d423de15ae9" title="Identify a codec based on the first few bytes of data.">fish_sound_identify</a> (<span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> * buf, <span class="keywordtype">long</span> bytes);
<a name="l00458"></a>00458
<a name="l00465"></a>00465 <a class="code" href="fishsound_8h.html#8cfb7dfb102ad1af9ff35046aed3ccd9" title="An opaque handle to a FishSound.">FishSound</a> * <a class="code" href="fishsound_8h.html#decddfef35cbbddcc8a76b28c365c527" title="Instantiate a new FishSound* handle.">fish_sound_new</a> (<span class="keywordtype">int</span> mode, <a class="code" href="structFishSoundInfo.html" title="Info about a particular encoder/decoder instance.">FishSoundInfo</a> * fsinfo);
<a name="l00466"></a>00466
<a name="l00472"></a>00472 <span class="keywordtype">long</span> <a class="code" href="fishsound_8h.html#b1672c542e09528b3dad3ee694b124d8" title="Flush any internally buffered data, forcing encode.">fish_sound_flush</a> (<a class="code" href="fishsound_8h.html#8cfb7dfb102ad1af9ff35046aed3ccd9" title="An opaque handle to a FishSound.">FishSound</a> * fsound);
<a name="l00473"></a>00473
<a name="l00483"></a>00483 <span class="keywordtype">int</span> <a class="code" href="fishsound_8h.html#546a521c2c3c3a2ee614ae3981fbc29f" title="Reset the codec state of a FishSound object.">fish_sound_reset</a> (<a class="code" href="fishsound_8h.html#8cfb7dfb102ad1af9ff35046aed3ccd9" title="An opaque handle to a FishSound.">FishSound</a> * fsound);
<a name="l00484"></a>00484
<a name="l00490"></a>00490 <span class="keywordtype">int</span> <a class="code" href="fishsound_8h.html#002e2dee1a7f736699dba5bec0a81426" title="Delete a FishSound object.">fish_sound_delete</a> (<a class="code" href="fishsound_8h.html#8cfb7dfb102ad1af9ff35046aed3ccd9" title="An opaque handle to a FishSound.">FishSound</a> * fsound);
<a name="l00491"></a>00491
<a name="l00500"></a>00500 <span class="keywordtype">int</span> <a class="code" href="fishsound_8h.html#35c5182901b71a2514bc9a8f2ec839c7" title="Command interface.">fish_sound_command</a> (<a class="code" href="fishsound_8h.html#8cfb7dfb102ad1af9ff35046aed3ccd9" title="An opaque handle to a FishSound.">FishSound</a> * fsound, <span class="keywordtype">int</span> command, <span class="keywordtype">void</span> * data,
<a name="l00501"></a>00501 <span class="keywordtype">int</span> datasize);
<a name="l00502"></a>00502
<a name="l00510"></a>00510 <span class="keywordtype">int</span> <a class="code" href="fishsound_8h.html#7bc2b75ad943e2da3147bf33882860c8" title="Query whether a FishSound object is using interleaved PCM.">fish_sound_get_interleave</a> (<a class="code" href="fishsound_8h.html#8cfb7dfb102ad1af9ff35046aed3ccd9" title="An opaque handle to a FishSound.">FishSound</a> * fsound);
<a name="l00511"></a>00511
<a name="l00529"></a>00529 <span class="keywordtype">long</span> <a class="code" href="fishsound_8h.html#d991f9f6887487f5d833de9480bcbe43" title="Query the current frame number of a FishSound object.">fish_sound_get_frameno</a> (<a class="code" href="fishsound_8h.html#8cfb7dfb102ad1af9ff35046aed3ccd9" title="An opaque handle to a FishSound.">FishSound</a> * fsound);
<a name="l00530"></a>00530
<a name="l00544"></a>00544 <span class="keywordtype">int</span> <a class="code" href="fishsound_8h.html#0d508075ecdd834ab5a4504f5e85f66b" title="Set the current frame number of a FishSound object.">fish_sound_set_frameno</a> (<a class="code" href="fishsound_8h.html#8cfb7dfb102ad1af9ff35046aed3ccd9" title="An opaque handle to a FishSound.">FishSound</a> * fsound, <span class="keywordtype">long</span> frameno);
<a name="l00545"></a>00545
<a name="l00576"></a>00576 <span class="keywordtype">int</span> <a class="code" href="fishsound_8h.html#6f4818e09b8323d8461331f46f13ab6a" title="Prepare truncation details for the next block of data.">fish_sound_prepare_truncation</a> (<a class="code" href="fishsound_8h.html#8cfb7dfb102ad1af9ff35046aed3ccd9" title="An opaque handle to a FishSound.">FishSound</a> * fsound, <span class="keywordtype">long</span> next_granulepos,
<a name="l00577"></a>00577 <span class="keywordtype">int</span> next_eos);
<a name="l00578"></a>00578
<a name="l00579"></a>00579 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00580"></a>00580 <span class="preprocessor"></span>}
<a name="l00581"></a>00581 <span class="preprocessor">#endif</span>
<a name="l00582"></a>00582 <span class="preprocessor"></span>
<a name="l00583"></a>00583 <span class="preprocessor">#include <<a class="code" href="decode_8h.html" title="Decode functions and callback prototypes.">fishsound/decode.h</a>></span>
<a name="l00584"></a>00584 <span class="preprocessor">#include <<a class="code" href="encode_8h.html" title="Encode functions and callback prototypes.">fishsound/encode.h</a>></span>
<a name="l00585"></a>00585 <span class="preprocessor">#include <<a class="code" href="comments_8h.html" title="Encoding and decoding of comments.">fishsound/comments.h</a>></span>
<a name="l00586"></a>00586
<a name="l00587"></a>00587 <span class="preprocessor">#include <<a class="code" href="deprecated_8h.html" title="Deprecated interfaces.">fishsound/deprecated.h</a>></span>
<a name="l00588"></a>00588
<a name="l00589"></a>00589 <span class="preprocessor">#endif </span><span class="comment">/* __FISH_SOUND_H__ */</span>
</pre></div></div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Feb 3 22:16:44 2010 for libfishsound by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
</body>
</html>
