<!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: encode.h File Reference</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>
</div>
<div class="contents">
<h1>encode.h File Reference</h1>
<p>Encode functions and callback prototypes.
<a href="#_details">More...</a></p>
<p><a href="encode_8h_source.html">Go to the source code of this file.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef int(* </td><td class="memItemRight" valign="bottom"><a class="el" href="encode_8h.html#a7611595d35d3a08253341783adb2c0c9">FishSoundEncoded</a> )(<a class="el" href="fishsound_8h.html#a8cfb7dfb102ad1af9ff35046aed3ccd9">FishSound</a> *fsound, unsigned char *buf, long bytes, void *user_data)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Signature of a callback for libfishsound to call when it has encoded data. <a href="#a7611595d35d3a08253341783adb2c0c9"></a><br/></td></tr>
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="encode_8h.html#a31549d7a9181bfd33945c3f516f05d12">fish_sound_set_encoded_callback</a> (<a class="el" href="fishsound_8h.html#a8cfb7dfb102ad1af9ff35046aed3ccd9">FishSound</a> *fsound, <a class="el" href="encode_8h.html#a7611595d35d3a08253341783adb2c0c9">FishSoundEncoded</a> encoded, void *user_data)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the callback for libfishsound to call when it has a block of encoded data ready. <a href="#a31549d7a9181bfd33945c3f516f05d12"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="encode_8h.html#ad06e3a04cde6e56a0accfc948c9748a6">fish_sound_encode_float</a> (<a class="el" href="fishsound_8h.html#a8cfb7dfb102ad1af9ff35046aed3ccd9">FishSound</a> *fsound, float *pcm[], long frames)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Encode a block of PCM audio given as non-interleaved floats. <a href="#ad06e3a04cde6e56a0accfc948c9748a6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="encode_8h.html#a71608dd5615a314a16e2bc4522e5fbde">fish_sound_encode_float_ilv</a> (<a class="el" href="fishsound_8h.html#a8cfb7dfb102ad1af9ff35046aed3ccd9">FishSound</a> *fsound, float **pcm, long frames)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Encode a block of audio given as interleaved floats. <a href="#a71608dd5615a314a16e2bc4522e5fbde"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Encode functions and callback prototypes. </p>
<hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="a7611595d35d3a08253341783adb2c0c9"></a><!-- doxytag: member="encode.h::FishSoundEncoded" ref="a7611595d35d3a08253341783adb2c0c9" args=")(FishSound *fsound, unsigned char *buf, long bytes, void *user_data)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef int(* <a class="el" href="encode_8h.html#a7611595d35d3a08253341783adb2c0c9">FishSoundEncoded</a>)(<a class="el" href="fishsound_8h.html#a8cfb7dfb102ad1af9ff35046aed3ccd9">FishSound</a> *fsound, unsigned char *buf, long bytes, void *user_data)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Signature of a callback for libfishsound to call when it has encoded data. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>fsound</em> </td><td>The FishSound* handle </td></tr>
<tr><td valign="top"></td><td valign="top"><em>buf</em> </td><td>The encoded data </td></tr>
<tr><td valign="top"></td><td valign="top"><em>bytes</em> </td><td>The count of bytes encoded </td></tr>
<tr><td valign="top"></td><td valign="top"><em>user_data</em> </td><td>Arbitrary user data </td></tr>
</table>
</dd>
</dl>
<dl><dt><b>Return values:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>0</em> </td><td>to continue </td></tr>
<tr><td valign="top"></td><td valign="top"><em>non-zero</em> </td><td>to stop encoding immediately and return control to the <a class="el" href="deprecated_8h.html#a6cd1117b2d09f0f9589c8b10cccae75c" title="DEPRECATED FUNCTION.">fish_sound_encode()</a> caller </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ad06e3a04cde6e56a0accfc948c9748a6"></a><!-- doxytag: member="encode.h::fish_sound_encode_float" ref="ad06e3a04cde6e56a0accfc948c9748a6" args="(FishSound *fsound, float *pcm[], long frames)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long fish_sound_encode_float </td>
<td>(</td>
<td class="paramtype"><a class="el" href="fishsound_8h.html#a8cfb7dfb102ad1af9ff35046aed3ccd9">FishSound</a> * </td>
<td class="paramname"> <em>fsound</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float * </td>
<td class="paramname"> <em>pcm</em>[], </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"> <em>frames</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Encode a block of PCM audio given as non-interleaved floats. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>fsound</em> </td><td>A FishSound* handle (created with mode FISH_SOUND_ENCODE) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>pcm</em> </td><td>The audio data to encode </td></tr>
<tr><td valign="top"></td><td valign="top"><em>frames</em> </td><td>A count of frames to encode </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The number of frames encoded </dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>For multichannel audio, the audio data is interpreted according to the current PCM style </dd></dl>
</div>
</div>
<a class="anchor" id="a71608dd5615a314a16e2bc4522e5fbde"></a><!-- doxytag: member="encode.h::fish_sound_encode_float_ilv" ref="a71608dd5615a314a16e2bc4522e5fbde" args="(FishSound *fsound, float **pcm, long frames)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long fish_sound_encode_float_ilv </td>
<td>(</td>
<td class="paramtype"><a class="el" href="fishsound_8h.html#a8cfb7dfb102ad1af9ff35046aed3ccd9">FishSound</a> * </td>
<td class="paramname"> <em>fsound</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float ** </td>
<td class="paramname"> <em>pcm</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"> <em>frames</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Encode a block of audio given as interleaved floats. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>fsound</em> </td><td>A FishSound* handle (created with mode FISH_SOUND_ENCODE) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>pcm</em> </td><td>The audio data to encode </td></tr>
<tr><td valign="top"></td><td valign="top"><em>frames</em> </td><td>A count of frames to encode </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The number of frames encoded </dd></dl>
<dl class="note"><dt><b>Note:</b></dt><dd>For multichannel audio, the audio data is interpreted according to the current PCM style </dd></dl>
</div>
</div>
<a class="anchor" id="a31549d7a9181bfd33945c3f516f05d12"></a><!-- doxytag: member="encode.h::fish_sound_set_encoded_callback" ref="a31549d7a9181bfd33945c3f516f05d12" args="(FishSound *fsound, FishSoundEncoded encoded, void *user_data)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int fish_sound_set_encoded_callback </td>
<td>(</td>
<td class="paramtype"><a class="el" href="fishsound_8h.html#a8cfb7dfb102ad1af9ff35046aed3ccd9">FishSound</a> * </td>
<td class="paramname"> <em>fsound</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="encode_8h.html#a7611595d35d3a08253341783adb2c0c9">FishSoundEncoded</a> </td>
<td class="paramname"> <em>encoded</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>user_data</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the callback for libfishsound to call when it has a block of encoded data ready. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>fsound</em> </td><td>A FishSound* handle (created with mode FISH_SOUND_ENCODE) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>encoded</em> </td><td>The callback to call </td></tr>
<tr><td valign="top"></td><td valign="top"><em>user_data</em> </td><td>Arbitrary user data to pass to the callback </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 on success, -1 on failure </dd></dl>
</div>
</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>
distrib
>
Fedora
>
13
>
i386
>
media
>
updates
>
by-pkgid
>
e00b64b902be9cec16072aebc13bf07b
>
files
>
28
