<!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>Jack2: samplerate.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.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Jack2 <span id="projectnumber">1.9.7</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<div class="header">
<div class="headertitle">
<h1>samplerate.h</h1> </div>
</div>
<div class="contents">
<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) 2002-2008 Erik de Castro Lopo <erikd@mega-nerd.com></span>
<a name="l00003"></a>00003 <span class="comment">**</span>
<a name="l00004"></a>00004 <span class="comment">** This program is free software; you can redistribute it and/or modify</span>
<a name="l00005"></a>00005 <span class="comment">** it under the terms of the GNU General Public License as published by</span>
<a name="l00006"></a>00006 <span class="comment">** the Free Software Foundation; either version 2 of the License, or</span>
<a name="l00007"></a>00007 <span class="comment">** (at your option) any later version.</span>
<a name="l00008"></a>00008 <span class="comment">**</span>
<a name="l00009"></a>00009 <span class="comment">** This program is distributed in the hope that it will be useful,</span>
<a name="l00010"></a>00010 <span class="comment">** but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00011"></a>00011 <span class="comment">** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<a name="l00012"></a>00012 <span class="comment">** GNU General Public License for more details.</span>
<a name="l00013"></a>00013 <span class="comment">**</span>
<a name="l00014"></a>00014 <span class="comment">** You should have received a copy of the GNU General Public License</span>
<a name="l00015"></a>00015 <span class="comment">** along with this program; if not, write to the Free Software</span>
<a name="l00016"></a>00016 <span class="comment">** Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.</span>
<a name="l00017"></a>00017 <span class="comment">*/</span>
<a name="l00018"></a>00018
<a name="l00019"></a>00019 <span class="comment">/*</span>
<a name="l00020"></a>00020 <span class="comment">** This code is part of Secret Rabibt Code aka libsamplerate. A commercial</span>
<a name="l00021"></a>00021 <span class="comment">** use license for this code is available, please see:</span>
<a name="l00022"></a>00022 <span class="comment">** http://www.mega-nerd.com/SRC/procedure.html</span>
<a name="l00023"></a>00023 <span class="comment">*/</span>
<a name="l00024"></a>00024
<a name="l00025"></a>00025 <span class="comment">/*</span>
<a name="l00026"></a>00026 <span class="comment">** API documentation is available here:</span>
<a name="l00027"></a>00027 <span class="comment">** http://www.mega-nerd.com/SRC/api.html</span>
<a name="l00028"></a>00028 <span class="comment">*/</span>
<a name="l00029"></a>00029
<a name="l00030"></a>00030 <span class="preprocessor">#ifndef SAMPLERATE_H</span>
<a name="l00031"></a>00031 <span class="preprocessor"></span><span class="preprocessor">#define SAMPLERATE_H</span>
<a name="l00032"></a>00032 <span class="preprocessor"></span>
<a name="l00033"></a>00033 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00034"></a>00034 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
<a name="l00035"></a>00035 <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span>
<a name="l00036"></a>00036
<a name="l00037"></a>00037
<a name="l00038"></a>00038 <span class="comment">/* Opaque data type SRC_STATE. */</span>
<a name="l00039"></a>00039 <span class="keyword">typedef</span> <span class="keyword">struct </span>SRC_STATE_tag SRC_STATE ;
<a name="l00040"></a>00040
<a name="l00041"></a>00041 <span class="comment">/* SRC_DATA is used to pass data to src_simple() and src_process(). */</span>
<a name="l00042"></a><a class="code" href="structSRC__DATA.html">00042</a> <span class="keyword">typedef</span> <span class="keyword">struct</span>
<a name="l00043"></a>00043 { <span class="keywordtype">float</span> *data_in, *data_out ;
<a name="l00044"></a>00044
<a name="l00045"></a>00045 <span class="keywordtype">long</span> input_frames, output_frames ;
<a name="l00046"></a>00046 <span class="keywordtype">long</span> input_frames_used, output_frames_gen ;
<a name="l00047"></a>00047
<a name="l00048"></a>00048 <span class="keywordtype">int</span> end_of_input ;
<a name="l00049"></a>00049
<a name="l00050"></a>00050 <span class="keywordtype">double</span> src_ratio ;
<a name="l00051"></a>00051 } <a class="code" href="structSRC__DATA.html">SRC_DATA</a> ;
<a name="l00052"></a>00052
<a name="l00053"></a>00053 <span class="comment">/* SRC_CB_DATA is used with callback based API. */</span>
<a name="l00054"></a><a class="code" href="structSRC__CB__DATA.html">00054</a> <span class="keyword">typedef</span> <span class="keyword">struct</span>
<a name="l00055"></a>00055 { <span class="keywordtype">long</span> frames ;
<a name="l00056"></a>00056 <span class="keywordtype">float</span> *data_in ;
<a name="l00057"></a>00057 } <a class="code" href="structSRC__CB__DATA.html">SRC_CB_DATA</a> ;
<a name="l00058"></a>00058
<a name="l00059"></a>00059 <span class="comment">/*</span>
<a name="l00060"></a>00060 <span class="comment">** User supplied callback function type for use with src_callback_new()</span>
<a name="l00061"></a>00061 <span class="comment">** and src_callback_read(). First parameter is the same pointer that was</span>
<a name="l00062"></a>00062 <span class="comment">** passed into src_callback_new(). Second parameter is pointer to a</span>
<a name="l00063"></a>00063 <span class="comment">** pointer. The user supplied callback function must modify *data to</span>
<a name="l00064"></a>00064 <span class="comment">** point to the start of the user supplied float array. The user supplied</span>
<a name="l00065"></a>00065 <span class="comment">** function must return the number of frames that **data points to.</span>
<a name="l00066"></a>00066 <span class="comment">*/</span>
<a name="l00067"></a>00067
<a name="l00068"></a>00068 <span class="keyword">typedef</span> long (*src_callback_t) (<span class="keywordtype">void</span> *cb_data, <span class="keywordtype">float</span> **data) ;
<a name="l00069"></a>00069
<a name="l00070"></a>00070 <span class="comment">/*</span>
<a name="l00071"></a>00071 <span class="comment">** Standard initialisation function : return an anonymous pointer to the</span>
<a name="l00072"></a>00072 <span class="comment">** internal state of the converter. Choose a converter from the enums below.</span>
<a name="l00073"></a>00073 <span class="comment">** Error returned in *error.</span>
<a name="l00074"></a>00074 <span class="comment">*/</span>
<a name="l00075"></a>00075
<a name="l00076"></a>00076 SRC_STATE* src_new (<span class="keywordtype">int</span> converter_type, <span class="keywordtype">int</span> channels, <span class="keywordtype">int</span> *error) ;
<a name="l00077"></a>00077
<a name="l00078"></a>00078 <span class="comment">/*</span>
<a name="l00079"></a>00079 <span class="comment">** Initilisation for callback based API : return an anonymous pointer to the</span>
<a name="l00080"></a>00080 <span class="comment">** internal state of the converter. Choose a converter from the enums below.</span>
<a name="l00081"></a>00081 <span class="comment">** The cb_data pointer can point to any data or be set to NULL. Whatever the</span>
<a name="l00082"></a>00082 <span class="comment">** value, when processing, user supplied function "func" gets called with</span>
<a name="l00083"></a>00083 <span class="comment">** cb_data as first parameter.</span>
<a name="l00084"></a>00084 <span class="comment">*/</span>
<a name="l00085"></a>00085
<a name="l00086"></a>00086 SRC_STATE* src_callback_new (src_callback_t func, <span class="keywordtype">int</span> converter_type, <span class="keywordtype">int</span> channels,
<a name="l00087"></a>00087 <span class="keywordtype">int</span> *error, <span class="keywordtype">void</span>* cb_data) ;
<a name="l00088"></a>00088
<a name="l00089"></a>00089 <span class="comment">/*</span>
<a name="l00090"></a>00090 <span class="comment">** Cleanup all internal allocations.</span>
<a name="l00091"></a>00091 <span class="comment">** Always returns NULL.</span>
<a name="l00092"></a>00092 <span class="comment">*/</span>
<a name="l00093"></a>00093
<a name="l00094"></a>00094 SRC_STATE* src_delete (SRC_STATE *state) ;
<a name="l00095"></a>00095
<a name="l00096"></a>00096 <span class="comment">/*</span>
<a name="l00097"></a>00097 <span class="comment">** Standard processing function.</span>
<a name="l00098"></a>00098 <span class="comment">** Returns non zero on error.</span>
<a name="l00099"></a>00099 <span class="comment">*/</span>
<a name="l00100"></a>00100
<a name="l00101"></a>00101 <span class="keywordtype">int</span> src_process (SRC_STATE *state, <a class="code" href="structSRC__DATA.html">SRC_DATA</a> *data) ;
<a name="l00102"></a>00102
<a name="l00103"></a>00103 <span class="comment">/*</span>
<a name="l00104"></a>00104 <span class="comment">** Callback based processing function. Read up to frames worth of data from</span>
<a name="l00105"></a>00105 <span class="comment">** the converter int *data and return frames read or -1 on error.</span>
<a name="l00106"></a>00106 <span class="comment">*/</span>
<a name="l00107"></a>00107 <span class="keywordtype">long</span> src_callback_read (SRC_STATE *state, <span class="keywordtype">double</span> src_ratio, <span class="keywordtype">long</span> frames, <span class="keywordtype">float</span> *data) ;
<a name="l00108"></a>00108
<a name="l00109"></a>00109 <span class="comment">/*</span>
<a name="l00110"></a>00110 <span class="comment">** Simple interface for performing a single conversion from input buffer to</span>
<a name="l00111"></a>00111 <span class="comment">** output buffer at a fixed conversion ratio.</span>
<a name="l00112"></a>00112 <span class="comment">** Simple interface does not require initialisation as it can only operate on</span>
<a name="l00113"></a>00113 <span class="comment">** a single buffer worth of audio.</span>
<a name="l00114"></a>00114 <span class="comment">*/</span>
<a name="l00115"></a>00115
<a name="l00116"></a>00116 <span class="keywordtype">int</span> src_simple (<a class="code" href="structSRC__DATA.html">SRC_DATA</a> *data, <span class="keywordtype">int</span> converter_type, <span class="keywordtype">int</span> channels) ;
<a name="l00117"></a>00117
<a name="l00118"></a>00118 <span class="comment">/*</span>
<a name="l00119"></a>00119 <span class="comment">** This library contains a number of different sample rate converters,</span>
<a name="l00120"></a>00120 <span class="comment">** numbered 0 through N.</span>
<a name="l00121"></a>00121 <span class="comment">**</span>
<a name="l00122"></a>00122 <span class="comment">** Return a string giving either a name or a more full description of each</span>
<a name="l00123"></a>00123 <span class="comment">** sample rate converter or NULL if no sample rate converter exists for</span>
<a name="l00124"></a>00124 <span class="comment">** the given value. The converters are sequentially numbered from 0 to N.</span>
<a name="l00125"></a>00125 <span class="comment">*/</span>
<a name="l00126"></a>00126
<a name="l00127"></a>00127 <span class="keyword">const</span> <span class="keywordtype">char</span> *src_get_name (<span class="keywordtype">int</span> converter_type) ;
<a name="l00128"></a>00128 <span class="keyword">const</span> <span class="keywordtype">char</span> *src_get_description (<span class="keywordtype">int</span> converter_type) ;
<a name="l00129"></a>00129 <span class="keyword">const</span> <span class="keywordtype">char</span> *src_get_version (<span class="keywordtype">void</span>) ;
<a name="l00130"></a>00130
<a name="l00131"></a>00131 <span class="comment">/*</span>
<a name="l00132"></a>00132 <span class="comment">** Set a new SRC ratio. This allows step responses</span>
<a name="l00133"></a>00133 <span class="comment">** in the conversion ratio.</span>
<a name="l00134"></a>00134 <span class="comment">** Returns non zero on error.</span>
<a name="l00135"></a>00135 <span class="comment">*/</span>
<a name="l00136"></a>00136
<a name="l00137"></a>00137 <span class="keywordtype">int</span> src_set_ratio (SRC_STATE *state, <span class="keywordtype">double</span> new_ratio) ;
<a name="l00138"></a>00138
<a name="l00139"></a>00139 <span class="comment">/*</span>
<a name="l00140"></a>00140 <span class="comment">** Reset the internal SRC state.</span>
<a name="l00141"></a>00141 <span class="comment">** Does not modify the quality settings.</span>
<a name="l00142"></a>00142 <span class="comment">** Does not free any memory allocations.</span>
<a name="l00143"></a>00143 <span class="comment">** Returns non zero on error.</span>
<a name="l00144"></a>00144 <span class="comment">*/</span>
<a name="l00145"></a>00145
<a name="l00146"></a>00146 <span class="keywordtype">int</span> src_reset (SRC_STATE *state) ;
<a name="l00147"></a>00147
<a name="l00148"></a>00148 <span class="comment">/*</span>
<a name="l00149"></a>00149 <span class="comment">** Return TRUE if ratio is a valid conversion ratio, FALSE</span>
<a name="l00150"></a>00150 <span class="comment">** otherwise.</span>
<a name="l00151"></a>00151 <span class="comment">*/</span>
<a name="l00152"></a>00152
<a name="l00153"></a>00153 <span class="keywordtype">int</span> src_is_valid_ratio (<span class="keywordtype">double</span> ratio) ;
<a name="l00154"></a>00154
<a name="l00155"></a>00155 <span class="comment">/*</span>
<a name="l00156"></a>00156 <span class="comment">** Return an error number.</span>
<a name="l00157"></a>00157 <span class="comment">*/</span>
<a name="l00158"></a>00158
<a name="l00159"></a>00159 <span class="keywordtype">int</span> src_error (SRC_STATE *state) ;
<a name="l00160"></a>00160
<a name="l00161"></a>00161 <span class="comment">/*</span>
<a name="l00162"></a>00162 <span class="comment">** Convert the error number into a string.</span>
<a name="l00163"></a>00163 <span class="comment">*/</span>
<a name="l00164"></a>00164 <span class="keyword">const</span> <span class="keywordtype">char</span>* src_strerror (<span class="keywordtype">int</span> error) ;
<a name="l00165"></a>00165
<a name="l00166"></a>00166 <span class="comment">/*</span>
<a name="l00167"></a>00167 <span class="comment">** The following enums can be used to set the interpolator type</span>
<a name="l00168"></a>00168 <span class="comment">** using the function src_set_converter().</span>
<a name="l00169"></a>00169 <span class="comment">*/</span>
<a name="l00170"></a>00170
<a name="l00171"></a>00171 <span class="keyword">enum</span>
<a name="l00172"></a>00172 {
<a name="l00173"></a>00173 SRC_SINC_BEST_QUALITY = 0,
<a name="l00174"></a>00174 SRC_SINC_MEDIUM_QUALITY = 1,
<a name="l00175"></a>00175 SRC_SINC_FASTEST = 2,
<a name="l00176"></a>00176 SRC_ZERO_ORDER_HOLD = 3,
<a name="l00177"></a>00177 SRC_LINEAR = 4,
<a name="l00178"></a>00178 } ;
<a name="l00179"></a>00179
<a name="l00180"></a>00180 <span class="comment">/*</span>
<a name="l00181"></a>00181 <span class="comment">** Extra helper functions for converting from short to float and</span>
<a name="l00182"></a>00182 <span class="comment">** back again.</span>
<a name="l00183"></a>00183 <span class="comment">*/</span>
<a name="l00184"></a>00184
<a name="l00185"></a>00185 <span class="keywordtype">void</span> src_short_to_float_array (<span class="keyword">const</span> <span class="keywordtype">short</span> *in, <span class="keywordtype">float</span> *out, <span class="keywordtype">int</span> len) ;
<a name="l00186"></a>00186 <span class="keywordtype">void</span> src_float_to_short_array (<span class="keyword">const</span> <span class="keywordtype">float</span> *in, <span class="keywordtype">short</span> *out, <span class="keywordtype">int</span> len) ;
<a name="l00187"></a>00187
<a name="l00188"></a>00188 <span class="keywordtype">void</span> src_int_to_float_array (<span class="keyword">const</span> <span class="keywordtype">int</span> *in, <span class="keywordtype">float</span> *out, <span class="keywordtype">int</span> len) ;
<a name="l00189"></a>00189 <span class="keywordtype">void</span> src_float_to_int_array (<span class="keyword">const</span> <span class="keywordtype">float</span> *in, <span class="keywordtype">int</span> *out, <span class="keywordtype">int</span> len) ;
<a name="l00190"></a>00190
<a name="l00191"></a>00191
<a name="l00192"></a>00192 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00193"></a>00193 <span class="preprocessor"></span>} <span class="comment">/* extern "C" */</span>
<a name="l00194"></a>00194 <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span>
<a name="l00195"></a>00195
<a name="l00196"></a>00196 <span class="preprocessor">#endif </span><span class="comment">/* SAMPLERATE_H */</span>
<a name="l00197"></a>00197
</pre></div></div>
</div>
<hr size="1"><address style="text-align: right;"><small>
Generated for Jack2 by <a href="http://www.doxygen.org/
index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a>
1.7.3</small></address>
</body>
</html>
