<!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: deprecated.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.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>
</div>
<div class="contents">
<h1>deprecated.h File Reference</h1>Deprecated interfaces.
<a href="#_details">More...</a>
<p>
<p>
<a href="deprecated_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="decode_8h.html#bc40e3343ebff3d1418835569079b2c8">FishSoundDecoded_Float</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="deprecated_8h.html#30f4221d1810083d5907749dcacf8df3">FishSoundDecoded</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">DEPRECATED TYPE. <a href="#30f4221d1810083d5907749dcacf8df3"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="deprecated_8h.html#dd6f678e9e38d3b27bd8e5b95c2547f1">fish_sound_set_decoded_callback</a> (<a class="el" href="fishsound_8h.html#8cfb7dfb102ad1af9ff35046aed3ccd9">FishSound</a> *fsound, <a class="el" href="deprecated_8h.html#30f4221d1810083d5907749dcacf8df3">FishSoundDecoded</a> decoded, void *user_data)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">DEPRECATED FUNCTION. <a href="#dd6f678e9e38d3b27bd8e5b95c2547f1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="deprecated_8h.html#8e6b76134675d948015fe4afa3fe4104">fish_sound_set_interleave</a> (<a class="el" href="fishsound_8h.html#8cfb7dfb102ad1af9ff35046aed3ccd9">FishSound</a> *fsound, int interleave)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">DEPRECATED FUNCTION. <a href="#8e6b76134675d948015fe4afa3fe4104"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="deprecated_8h.html#6cd1117b2d09f0f9589c8b10cccae75c">fish_sound_encode</a> (<a class="el" href="fishsound_8h.html#8cfb7dfb102ad1af9ff35046aed3ccd9">FishSound</a> *fsound, float **pcm, long frames)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">DEPRECATED FUNCTION. <a href="#6cd1117b2d09f0f9589c8b10cccae75c"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Deprecated interfaces.
<p>
<hr><h2>Typedef Documentation</h2>
<a class="anchor" name="30f4221d1810083d5907749dcacf8df3"></a><!-- doxytag: member="deprecated.h::FishSoundDecoded" ref="30f4221d1810083d5907749dcacf8df3" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="decode_8h.html#bc40e3343ebff3d1418835569079b2c8">FishSoundDecoded_Float</a> <a class="el" href="deprecated_8h.html#30f4221d1810083d5907749dcacf8df3">FishSoundDecoded</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
DEPRECATED TYPE.
<p>
Signature of a callback for libfishsound to call when it has decoded PCM audio data, and you want this provided as floats using the current interleave method as set by <a class="el" href="deprecated_8h.html#8e6b76134675d948015fe4afa3fe4104" title="DEPRECATED FUNCTION.">fish_sound_set_interleave()</a>.
</div>
</div><p>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="6cd1117b2d09f0f9589c8b10cccae75c"></a><!-- doxytag: member="deprecated.h::fish_sound_encode" ref="6cd1117b2d09f0f9589c8b10cccae75c" args="(FishSound *fsound, float **pcm, long frames)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long fish_sound_encode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="fishsound_8h.html#8cfb7dfb102ad1af9ff35046aed3ccd9">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>
DEPRECATED FUNCTION.
<p>
Encode a block of audio <dl compact><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>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The number of frames encoded </dd></dl>
<dl class="note" compact><dt><b>Note:</b></dt><dd>For multichannel audio, the audio data is interpreted according to the current PCM style </dd></dl>
</div>
</div><p>
<a class="anchor" name="dd6f678e9e38d3b27bd8e5b95c2547f1"></a><!-- doxytag: member="deprecated.h::fish_sound_set_decoded_callback" ref="dd6f678e9e38d3b27bd8e5b95c2547f1" args="(FishSound *fsound, FishSoundDecoded decoded, void *user_data)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int fish_sound_set_decoded_callback </td>
<td>(</td>
<td class="paramtype"><a class="el" href="fishsound_8h.html#8cfb7dfb102ad1af9ff35046aed3ccd9">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="deprecated_8h.html#30f4221d1810083d5907749dcacf8df3">FishSoundDecoded</a> </td>
<td class="paramname"> <em>decoded</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>
DEPRECATED FUNCTION.
<p>
Set the callback for libfishsound to call when it has a block of decoded PCM audio ready, and you want this provided as floats using the current interleave method as set by <a class="el" href="deprecated_8h.html#8e6b76134675d948015fe4afa3fe4104" title="DEPRECATED FUNCTION.">fish_sound_set_interleave()</a>. This function, and <a class="el" href="deprecated_8h.html#8e6b76134675d948015fe4afa3fe4104" title="DEPRECATED FUNCTION.">fish_sound_set_interleave()</a>, have been superceded by the typesafe fish_sound_set_decoded_TYPE() callbacks, such as <a class="el" href="decode_8h.html#e821800e11efe106676d7ce4c743328a" title="Set the callback for libfishsound to call when it has a block of decoded PCM audio...">fish_sound_set_decoded_float()</a> or <a class="el" href="decode_8h.html#3a4055f579b841a5c05d2a2865f5e939" title="Set the callback for libfishsound to call when it has a block of decoded PCM audio...">fish_sound_set_decoded_float_ilv()</a>.<p>
<dl compact><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_DECODE) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>decoded</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>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0 on success, -1 on failure </dd></dl>
</div>
</div><p>
<a class="anchor" name="8e6b76134675d948015fe4afa3fe4104"></a><!-- doxytag: member="deprecated.h::fish_sound_set_interleave" ref="8e6b76134675d948015fe4afa3fe4104" args="(FishSound *fsound, int interleave)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int fish_sound_set_interleave </td>
<td>(</td>
<td class="paramtype"><a class="el" href="fishsound_8h.html#8cfb7dfb102ad1af9ff35046aed3ccd9">FishSound</a> * </td>
<td class="paramname"> <em>fsound</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>interleave</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
DEPRECATED FUNCTION.
<p>
Set the PCM format used by a FishSound object. The default value is non-interleaved. Prior to libfishsound 0.7.0, you would (optionally) specify whether you wanted to receive interleaved or per-channel PCM data using <a class="el" href="deprecated_8h.html#8e6b76134675d948015fe4afa3fe4104" title="DEPRECATED FUNCTION.">fish_sound_set_interleave()</a>, the default being per-channel (non-interleaved) PCM. Whether or not your decoded callback expects interleaved or non-interleaved data is now implied by the particular fish_sound_set_decoded_TYPE() method you use to set it, such as <a class="el" href="decode_8h.html#e821800e11efe106676d7ce4c743328a" title="Set the callback for libfishsound to call when it has a block of decoded PCM audio...">fish_sound_set_decoded_float()</a> or <a class="el" href="decode_8h.html#3a4055f579b841a5c05d2a2865f5e939" title="Set the callback for libfishsound to call when it has a block of decoded PCM audio...">fish_sound_set_decoded_float_ilv()</a>.<p>
<dl compact><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 </td></tr>
<tr><td valign="top"></td><td valign="top"><em>interleave</em> </td><td>Whether to use interleaved PCM or not. Valid values are 0 for non-interleaved, and 1 for interleaved. </td></tr>
</table>
</dl>
<dl compact><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>Success </td></tr>
<tr><td valign="top"></td><td valign="top"><em>-1</em> </td><td>Invalid <em>fsound</em> </td></tr>
</table>
</dl>
</div>
</div><p>
</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>
