Why Gemfury?
Push, build, and install
RubyGems
npm packages
Python packages
Maven artifacts
PHP packages
Go Modules
Debian packages
RPM packages
NuGet packages
showbox-public / ffmpeg-doc deb
Repository URL to install this package:
|
Version:
7:2.7.1-1ubuntu3 ▾
|
<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>FFmpeg: libavresample/avresample.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">FFmpeg
 <span id="projectnumber">2.7.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.6.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<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>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</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>Globals</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="headertitle">
<div class="title">libavresample/avresample.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="avresample_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) 2012 Justin Ruggles <justin.ruggles@gmail.com></span>
<a name="l00003"></a>00003 <span class="comment"> *</span>
<a name="l00004"></a>00004 <span class="comment"> * This file is part of FFmpeg.</span>
<a name="l00005"></a>00005 <span class="comment"> *</span>
<a name="l00006"></a>00006 <span class="comment"> * FFmpeg is free software; you can redistribute it and/or</span>
<a name="l00007"></a>00007 <span class="comment"> * modify it under the terms of the GNU Lesser General Public</span>
<a name="l00008"></a>00008 <span class="comment"> * License as published by the Free Software Foundation; either</span>
<a name="l00009"></a>00009 <span class="comment"> * version 2.1 of the License, or (at your option) any later version.</span>
<a name="l00010"></a>00010 <span class="comment"> *</span>
<a name="l00011"></a>00011 <span class="comment"> * FFmpeg is distributed in the hope that it will be useful,</span>
<a name="l00012"></a>00012 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00013"></a>00013 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span>
<a name="l00014"></a>00014 <span class="comment"> * Lesser General Public License for more details.</span>
<a name="l00015"></a>00015 <span class="comment"> *</span>
<a name="l00016"></a>00016 <span class="comment"> * You should have received a copy of the GNU Lesser General Public</span>
<a name="l00017"></a>00017 <span class="comment"> * License along with FFmpeg; if not, write to the Free Software</span>
<a name="l00018"></a>00018 <span class="comment"> * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA</span>
<a name="l00019"></a>00019 <span class="comment"> */</span>
<a name="l00020"></a>00020
<a name="l00021"></a>00021 <span class="preprocessor">#ifndef AVRESAMPLE_AVRESAMPLE_H</span>
<a name="l00022"></a>00022 <span class="preprocessor"></span><span class="preprocessor">#define AVRESAMPLE_AVRESAMPLE_H</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00024"></a>00024 <span class="comment">/**</span>
<a name="l00025"></a>00025 <span class="comment"> * @file</span>
<a name="l00026"></a>00026 <span class="comment"> * @ingroup lavr</span>
<a name="l00027"></a>00027 <span class="comment"> * external API header</span>
<a name="l00028"></a>00028 <span class="comment"> */</span>
<a name="l00029"></a>00029 <span class="comment"></span>
<a name="l00030"></a>00030 <span class="comment">/**</span>
<a name="l00031"></a>00031 <span class="comment"> * @defgroup lavr Libavresample</span>
<a name="l00032"></a>00032 <span class="comment"> * @{</span>
<a name="l00033"></a>00033 <span class="comment"> *</span>
<a name="l00034"></a>00034 <span class="comment"> * Libavresample (lavr) is a library that handles audio resampling, sample</span>
<a name="l00035"></a>00035 <span class="comment"> * format conversion and mixing.</span>
<a name="l00036"></a>00036 <span class="comment"> *</span>
<a name="l00037"></a>00037 <span class="comment"> * Interaction with lavr is done through AVAudioResampleContext, which is</span>
<a name="l00038"></a>00038 <span class="comment"> * allocated with avresample_alloc_context(). It is opaque, so all parameters</span>
<a name="l00039"></a>00039 <span class="comment"> * must be set with the @ref avoptions API.</span>
<a name="l00040"></a>00040 <span class="comment"> *</span>
<a name="l00041"></a>00041 <span class="comment"> * For example the following code will setup conversion from planar float sample</span>
<a name="l00042"></a>00042 <span class="comment"> * format to interleaved signed 16-bit integer, downsampling from 48kHz to</span>
<a name="l00043"></a>00043 <span class="comment"> * 44.1kHz and downmixing from 5.1 channels to stereo (using the default mixing</span>
<a name="l00044"></a>00044 <span class="comment"> * matrix):</span>
<a name="l00045"></a>00045 <span class="comment"> * @code</span>
<a name="l00046"></a>00046 <span class="comment"> * AVAudioResampleContext *avr = avresample_alloc_context();</span>
<a name="l00047"></a>00047 <span class="comment"> * av_opt_set_int(avr, "in_channel_layout", AV_CH_LAYOUT_5POINT1, 0);</span>
<a name="l00048"></a>00048 <span class="comment"> * av_opt_set_int(avr, "out_channel_layout", AV_CH_LAYOUT_STEREO, 0);</span>
<a name="l00049"></a>00049 <span class="comment"> * av_opt_set_int(avr, "in_sample_rate", 48000, 0);</span>
<a name="l00050"></a>00050 <span class="comment"> * av_opt_set_int(avr, "out_sample_rate", 44100, 0);</span>
<a name="l00051"></a>00051 <span class="comment"> * av_opt_set_int(avr, "in_sample_fmt", AV_SAMPLE_FMT_FLTP, 0);</span>
<a name="l00052"></a>00052 <span class="comment"> * av_opt_set_int(avr, "out_sample_fmt", AV_SAMPLE_FMT_S16, 0);</span>
<a name="l00053"></a>00053 <span class="comment"> * @endcode</span>
<a name="l00054"></a>00054 <span class="comment"> *</span>
<a name="l00055"></a>00055 <span class="comment"> * Once the context is initialized, it must be opened with avresample_open(). If</span>
<a name="l00056"></a>00056 <span class="comment"> * you need to change the conversion parameters, you must close the context with</span>
<a name="l00057"></a>00057 <span class="comment"> * avresample_close(), change the parameters as described above, then reopen it</span>
<a name="l00058"></a>00058 <span class="comment"> * again.</span>
<a name="l00059"></a>00059 <span class="comment"> *</span>
<a name="l00060"></a>00060 <span class="comment"> * The conversion itself is done by repeatedly calling avresample_convert().</span>
<a name="l00061"></a>00061 <span class="comment"> * Note that the samples may get buffered in two places in lavr. The first one</span>
<a name="l00062"></a>00062 <span class="comment"> * is the output FIFO, where the samples end up if the output buffer is not</span>
<a name="l00063"></a>00063 <span class="comment"> * large enough. The data stored in there may be retrieved at any time with</span>
<a name="l00064"></a>00064 <span class="comment"> * avresample_read(). The second place is the resampling delay buffer,</span>
<a name="l00065"></a>00065 <span class="comment"> * applicable only when resampling is done. The samples in it require more input</span>
<a name="l00066"></a>00066 <span class="comment"> * before they can be processed. Their current amount is returned by</span>
<a name="l00067"></a>00067 <span class="comment"> * avresample_get_delay(). At the end of conversion the resampling buffer can be</span>
<a name="l00068"></a>00068 <span class="comment"> * flushed by calling avresample_convert() with NULL input.</span>
<a name="l00069"></a>00069 <span class="comment"> *</span>
<a name="l00070"></a>00070 <span class="comment"> * The following code demonstrates the conversion loop assuming the parameters</span>
<a name="l00071"></a>00071 <span class="comment"> * from above and caller-defined functions get_input() and handle_output():</span>
<a name="l00072"></a>00072 <span class="comment"> * @code</span>
<a name="l00073"></a>00073 <span class="comment"> * uint8_t **input;</span>
<a name="l00074"></a>00074 <span class="comment"> * int in_linesize, in_samples;</span>
<a name="l00075"></a>00075 <span class="comment"> *</span>
<a name="l00076"></a>00076 <span class="comment"> * while (get_input(&input, &in_linesize, &in_samples)) {</span>
<a name="l00077"></a>00077 <span class="comment"> * uint8_t *output</span>
<a name="l00078"></a>00078 <span class="comment"> * int out_linesize;</span>
<a name="l00079"></a>00079 <span class="comment"> * int out_samples = avresample_get_out_samples(avr, in_samples);</span>
<a name="l00080"></a>00080 <span class="comment"> *</span>
<a name="l00081"></a>00081 <span class="comment"> * av_samples_alloc(&output, &out_linesize, 2, out_samples,</span>
<a name="l00082"></a>00082 <span class="comment"> * AV_SAMPLE_FMT_S16, 0);</span>
<a name="l00083"></a>00083 <span class="comment"> * out_samples = avresample_convert(avr, &output, out_linesize, out_samples,</span>
<a name="l00084"></a>00084 <span class="comment"> * input, in_linesize, in_samples);</span>
<a name="l00085"></a>00085 <span class="comment"> * handle_output(output, out_linesize, out_samples);</span>
<a name="l00086"></a>00086 <span class="comment"> * av_freep(&output);</span>
<a name="l00087"></a>00087 <span class="comment"> * }</span>
<a name="l00088"></a>00088 <span class="comment"> * @endcode</span>
<a name="l00089"></a>00089 <span class="comment"> *</span>
<a name="l00090"></a>00090 <span class="comment"> * When the conversion is finished and the FIFOs are flushed if required, the</span>
<a name="l00091"></a>00091 <span class="comment"> * conversion context and everything associated with it must be freed with</span>
<a name="l00092"></a>00092 <span class="comment"> * avresample_free().</span>
<a name="l00093"></a>00093 <span class="comment"> */</span>
<a name="l00094"></a>00094
<a name="l00095"></a>00095 <span class="preprocessor">#include "<a class="code" href="avutil_8h.html" title="external API header">libavutil/avutil.h</a>"</span>
<a name="l00096"></a>00096 <span class="preprocessor">#include "<a class="code" href="channel__layout_8h.html" title="audio channel layout utility functions">libavutil/channel_layout.h</a>"</span>
<a name="l00097"></a>00097 <span class="preprocessor">#include "<a class="code" href="dict_8h.html" title="Public dictionary API.">libavutil/dict.h</a>"</span>
<a name="l00098"></a>00098 <span class="preprocessor">#include "<a class="code" href="frame_8h.html" title="reference-counted frame API">libavutil/frame.h</a>"</span>
<a name="l00099"></a>00099 <span class="preprocessor">#include "<a class="code" href="log_8h.html">libavutil/log.h</a>"</span>
<a name="l00100"></a>00100 <span class="preprocessor">#include "<a class="code" href="mathematics_8h.html">libavutil/mathematics.h</a>"</span>
<a name="l00101"></a>00101
<a name="l00102"></a>00102 <span class="preprocessor">#include "<a class="code" href="libavresample_2version_8h.html" title="Libavresample version macros.">libavresample/version.h</a>"</span>
<a name="l00103"></a>00103
<a name="l00104"></a><a class="code" href="group__lavr.html#gaee1afc173c8d1eefe0e1d8a881b7df26">00104</a> <span class="preprocessor">#define AVRESAMPLE_MAX_CHANNELS 32</span>
<a name="l00105"></a>00105 <span class="preprocessor"></span>
<a name="l00106"></a><a class="code" href="group__lavr.html#gabe4ee61779da95d51dff716ef5b275a3">00106</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="group__lavr.html#gabe4ee61779da95d51dff716ef5b275a3">AVAudioResampleContext</a> <a class="code" href="group__lavr.html#gabe4ee61779da95d51dff716ef5b275a3">AVAudioResampleContext</a>;
<a name="l00107"></a>00107 <span class="comment"></span>
<a name="l00108"></a>00108 <span class="comment">/** Mixing Coefficient Types */</span>
<a name="l00109"></a><a class="code" href="group__lavr.html#gaaaa652e3ad8554a0dca126e8571735dd">00109</a> <span class="keyword">enum</span> <a class="code" href="group__lavr.html#gaaaa652e3ad8554a0dca126e8571735dd" title="Mixing Coefficient Types.">AVMixCoeffType</a> {
<a name="l00110"></a><a class="code" href="group__lavr.html#ggaaaa652e3ad8554a0dca126e8571735ddab01d45f335057a1f930b0b677adb3a60">00110</a> <a class="code" href="group__lavr.html#ggaaaa652e3ad8554a0dca126e8571735ddab01d45f335057a1f930b0b677adb3a60">AV_MIX_COEFF_TYPE_Q8</a>, <span class="comment">/** 16-bit 8.8 fixed-point */</span>
<a name="l00111"></a><a class="code" href="group__lavr.html#ggaaaa652e3ad8554a0dca126e8571735ddaf459c8599c850abd5d0308cd8609af68">00111</a> <a class="code" href="group__lavr.html#ggaaaa652e3ad8554a0dca126e8571735ddaf459c8599c850abd5d0308cd8609af68" title="16-bit 8.8 fixed-point">AV_MIX_COEFF_TYPE_Q15</a>, <span class="comment">/** 32-bit 17.15 fixed-point */</span>
<a name="l00112"></a><a class="code" href="group__lavr.html#ggaaaa652e3ad8554a0dca126e8571735dda5d6c3ee92cc045714ac2ec4c83588841">00112</a> <a class="code" href="group__lavr.html#ggaaaa652e3ad8554a0dca126e8571735dda5d6c3ee92cc045714ac2ec4c83588841" title="32-bit 17.15 fixed-point">AV_MIX_COEFF_TYPE_FLT</a>, <span class="comment">/** floating-point */</span>
<a name="l00113"></a><a class="code" href="group__lavr.html#ggaaaa652e3ad8554a0dca126e8571735dda2672ba31292b1fb0a861b035466964a9">00113</a> <a class="code" href="group__lavr.html#ggaaaa652e3ad8554a0dca126e8571735dda2672ba31292b1fb0a861b035466964a9" title="floating-point">AV_MIX_COEFF_TYPE_NB</a>, <span class="comment">/** Number of coeff types. Not part of ABI */</span>
<a name="l00114"></a>00114 };
<a name="l00115"></a>00115 <span class="comment"></span>
<a name="l00116"></a>00116 <span class="comment">/** Resampling Filter Types */</span>
<a name="l00117"></a><a class="code" href="group__lavr.html#ga3813087032c02f1e84f0ca2962b09400">00117</a> <span class="keyword">enum</span> <a class="code" href="group__lavr.html#ga3813087032c02f1e84f0ca2962b09400" title="Resampling Filter Types.">AVResampleFilterType</a> {
<a name="l00118"></a><a class="code" href="group__lavr.html#gga3813087032c02f1e84f0ca2962b09400ac8d3b66c4c4bd02418ce0b882fb7d4fa">00118</a> <a class="code" href="group__lavr.html#gga3813087032c02f1e84f0ca2962b09400ac8d3b66c4c4bd02418ce0b882fb7d4fa" title="Cubic.">AV_RESAMPLE_FILTER_TYPE_CUBIC</a>, <span class="comment">/**< Cubic */</span>
<a name="l00119"></a><a class="code" href="group__lavr.html#gga3813087032c02f1e84f0ca2962b09400ace0cbc5bda3d6fa26b054b2fa7702886">00119</a> <a class="code" href="group__lavr.html#gga3813087032c02f1e84f0ca2962b09400ace0cbc5bda3d6fa26b054b2fa7702886" title="Blackman Nuttall Windowed Sinc.">AV_RESAMPLE_FILTER_TYPE_BLACKMAN_NUTTALL</a>, <span class="comment">/**< Blackman Nuttall Windowed Sinc */</span>
<a name="l00120"></a><a class="code" href="group__lavr.html#gga3813087032c02f1e84f0ca2962b09400af552d08855b8a5f4b46f6328633c8f1f">00120</a> <a class="code" href="group__lavr.html#gga3813087032c02f1e84f0ca2962b09400af552d08855b8a5f4b46f6328633c8f1f" title="Kaiser Windowed Sinc.">AV_RESAMPLE_FILTER_TYPE_KAISER</a>, <span class="comment">/**< Kaiser Windowed Sinc */</span>
<a name="l00121"></a>00121 };
<a name="l00122"></a>00122
<a name="l00123"></a><a class="code" href="group__lavr.html#ga302491313b02acca1a822249caa8cb10">00123</a> <span class="keyword">enum</span> <a class="code" href="group__lavr.html#ga302491313b02acca1a822249caa8cb10">AVResampleDitherMethod</a> {
<a name="l00124"></a><a class="code" href="group__lavr.html#gga302491313b02acca1a822249caa8cb10a4f892b254f02b3ebf775169f786e966b">00124</a> <a class="code" href="group__lavr.html#gga302491313b02acca1a822249caa8cb10a4f892b254f02b3ebf775169f786e966b" title="Do not use dithering.">AV_RESAMPLE_DITHER_NONE</a>, <span class="comment">/**< Do not use dithering */</span>
<a name="l00125"></a><a class="code" href="group__lavr.html#gga302491313b02acca1a822249caa8cb10a6e6841e6042d8059db5fdebe67d783ad">00125</a> <a class="code" href="group__lavr.html#gga302491313b02acca1a822249caa8cb10a6e6841e6042d8059db5fdebe67d783ad" title="Rectangular Dither.">AV_RESAMPLE_DITHER_RECTANGULAR</a>, <span class="comment">/**< Rectangular Dither */</span>
<a name="l00126"></a><a class="code" href="group__lavr.html#gga302491313b02acca1a822249caa8cb10a4d9b50692d2a3cdf6c3cfeb7f14ccfc6">00126</a> <a class="code" href="group__lavr.html#gga302491313b02acca1a822249caa8cb10a4d9b50692d2a3cdf6c3cfeb7f14ccfc6" title="Triangular Dither.">AV_RESAMPLE_DITHER_TRIANGULAR</a>, <span class="comment">/**< Triangular Dither*/</span>
<a name="l00127"></a><a class="code" href="group__lavr.html#gga302491313b02acca1a822249caa8cb10a261d5a5101aeff5e7ff5813787481bd6">00127</a> <a class="code" href="group__lavr.html#gga302491313b02acca1a822249caa8cb10a261d5a5101aeff5e7ff5813787481bd6" title="Triangular Dither with High Pass.">AV_RESAMPLE_DITHER_TRIANGULAR_HP</a>, <span class="comment">/**< Triangular Dither with High Pass */</span>
<a name="l00128"></a><a class="code" href="group__lavr.html#gga302491313b02acca1a822249caa8cb10aa1abacc1c6e8c448959bc49316b8f566">00128</a> <a class="code" href="group__lavr.html#gga302491313b02acca1a822249caa8cb10aa1abacc1c6e8c448959bc49316b8f566" title="Triangular Dither with Noise Shaping.">AV_RESAMPLE_DITHER_TRIANGULAR_NS</a>, <span class="comment">/**< Triangular Dither with Noise Shaping */</span>
<a name="l00129"></a><a class="code" href="group__lavr.html#gga302491313b02acca1a822249caa8cb10ac9e29d7f4af2590ba9a59429d88d57c0">00129</a> <a class="code" href="group__lavr.html#gga302491313b02acca1a822249caa8cb10ac9e29d7f4af2590ba9a59429d88d57c0" title="Number of dither types.">AV_RESAMPLE_DITHER_NB</a>, <span class="comment">/**< Number of dither types. Not part of ABI. */</span>
<a name="l00130"></a>00130 };
<a name="l00131"></a>00131 <span class="comment"></span>
<a name="l00132"></a>00132 <span class="comment">/**</span>
<a name="l00133"></a>00133 <span class="comment"> * Return the LIBAVRESAMPLE_VERSION_INT constant.</span>
<a name="l00134"></a>00134 <span class="comment"> */</span>
<a name="l00135"></a>00135 <span class="keywordtype">unsigned</span> <a class="code" href="group__lavr.html#gaedabbb0590c33b7b9ce1ce213629dd3e" title="Return the LIBAVRESAMPLE_VERSION_INT constant.">avresample_version</a>(<span class="keywordtype">void</span>);
<a name="l00136"></a>00136 <span class="comment"></span>
<a name="l00137"></a>00137 <span class="comment">/**</span>
<a name="l00138"></a>00138 <span class="comment"> * Return the libavresample build-time configuration.</span>
<a name="l00139"></a>00139 <span class="comment"> * @return configure string</span>
<a name="l00140"></a>00140 <span class="comment"> */</span>
<a name="l00141"></a>00141 <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="group__lavr.html#ga59d94ba578f9d7a90fd5d82ee6f361b4" title="Return the libavresample build-time configuration.">avresample_configuration</a>(<span class="keywordtype">void</span>);
<a name="l00142"></a>00142 <span class="comment"></span>
<a name="l00143"></a>00143 <span class="comment">/**</span>
<a name="l00144"></a>00144 <span class="comment"> * Return the libavresample license.</span>
<a name="l00145"></a>00145 <span class="comment"> */</span>
<a name="l00146"></a>00146 <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="group__lavr.html#ga7e3794756514c6ccf42580c2a840d16c" title="Return the libavresample license.">avresample_license</a>(<span class="keywordtype">void</span>);
<a name="l00147"></a>00147 <span class="comment"></span>
<a name="l00148"></a>00148 <span class="comment">/**</span>
<a name="l00149"></a>00149 <span class="comment"> * Get the AVClass for AVAudioResampleContext.</span>
<a name="l00150"></a>00150 <span class="comment"> *</span>
<a name="l00151"></a>00151 <span class="comment"> * Can be used in combination with AV_OPT_SEARCH_FAKE_OBJ for examining options</span>
<a name="l00152"></a>00152 <span class="comment"> * without allocating a context.</span>
<a name="l00153"></a>00153 <span class="comment"> *</span>
<a name="l00154"></a>00154 <span class="comment"> * @see av_opt_find().</span>
<a name="l00155"></a>00155 <span class="comment"> *</span>
<a name="l00156"></a>00156 <span class="comment"> * @return AVClass for AVAudioResampleContext</span>
<a name="l00157"></a>00157 <span class="comment"> */</span>
<a name="l00158"></a>00158 <span class="keyword">const</span> <a class="code" href="structAVClass.html" title="Describe the class of an AVClass context structure.">AVClass</a> *<a class="code" href="group__lavr.html#ga40d8eeb3181386e30e5b02289e469a73" title="Get the AVClass for AVAudioResampleContext.">avresample_get_class</a>(<span class="keywordtype">void</span>);
<a name="l00159"></a>00159 <span class="comment"></span>
<a name="l00160"></a>00160 <span class="comment">/**</span>
<a name="l00161"></a>00161 <span class="comment"> * Allocate AVAudioResampleContext and set options.</span>
<a name="l00162"></a>00162 <span class="comment"> *</span>
<a name="l00163"></a>00163 <span class="comment"> * @return allocated audio resample context, or NULL on failure</span>
<a name="l00164"></a>00164 <span class="comment"> */</span>
<a name="l00165"></a>00165 <a class="code" href="group__lavr.html#gabe4ee61779da95d51dff716ef5b275a3">AVAudioResampleContext</a> *<a class="code" href="group__lavr.html#ga5b1bcb7a35446a07ce330a0ca2b38b72" title="Allocate AVAudioResampleContext and set options.">avresample_alloc_context</a>(<span class="keywordtype">void</span>);
<a name="l00166"></a>00166 <span class="comment"></span>
<a name="l00167"></a>00167 <span class="comment">/**</span>
<a name="l00168"></a>00168 <span class="comment"> * Initialize AVAudioResampleContext.</span>
<a name="l00169"></a>00169 <span class="comment"> * @note The context must be configured using the AVOption API.</span>
<a name="l00170"></a>00170 <span class="comment"> *</span>
<a name="l00171"></a>00171 <span class="comment"> * @see av_opt_set_int()</span>
<a name="l00172"></a>00172 <span class="comment"> * @see av_opt_set_dict()</span>
<a name="l00173"></a>00173 <span class="comment"> *</span>
<a name="l00174"></a>00174 <span class="comment"> * @param avr audio resample context</span>
<a name="l00175"></a>00175 <span class="comment"> * @return 0 on success, negative AVERROR code on failure</span>
<a name="l00176"></a>00176 <span class="comment"> */</span>
<a name="l00177"></a>00177 <span class="keywordtype">int</span> <a class="code" href="group__lavr.html#gafc59c68689be880494ff24d10fd85143" title="Initialize AVAudioResampleContext.">avresample_open</a>(<a class="code" href="group__lavr.html#gabe4ee61779da95d51dff716ef5b275a3">AVAudioResampleContext</a> *avr);
<a name="l00178"></a>00178 <span class="comment"></span>
<a name="l00179"></a>00179 <span class="comment">/**</span>
<a name="l00180"></a>00180 <span class="comment"> * Check whether an AVAudioResampleContext is open or closed.</span>
<a name="l00181"></a>00181 <span class="comment"> *</span>
<a name="l00182"></a>00182 <span class="comment"> * @param avr AVAudioResampleContext to check</span>
<a name="l00183"></a>00183 <span class="comment"> * @return 1 if avr is open, 0 if avr is closed.</span>
<a name="l00184"></a>00184 <span class="comment"> */</span>
<a name="l00185"></a>00185 <span class="keywordtype">int</span> <a class="code" href="group__lavr.html#ga56519a7b3646ca435e64cb247c173c60" title="Check whether an AVAudioResampleContext is open or closed.">avresample_is_open</a>(<a class="code" href="group__lavr.html#gabe4ee61779da95d51dff716ef5b275a3">AVAudioResampleContext</a> *avr);
<a name="l00186"></a>00186 <span class="comment"></span>
<a name="l00187"></a>00187 <span class="comment">/**</span>
<a name="l00188"></a>00188 <span class="comment"> * Close AVAudioResampleContext.</span>
<a name="l00189"></a>00189 <span class="comment"> *</span>
<a name="l00190"></a>00190 <span class="comment"> * This closes the context, but it does not change the parameters. The context</span>
<a name="l00191"></a>00191 <span class="comment"> * can be reopened with avresample_open(). It does, however, clear the output</span>
<a name="l00192"></a>00192 <span class="comment"> * FIFO and any remaining leftover samples in the resampling delay buffer. If</span>
<a name="l00193"></a>00193 <span class="comment"> * there was a custom matrix being used, that is also cleared.</span>
<a name="l00194"></a>00194 <span class="comment"> *</span>
<a name="l00195"></a>00195 <span class="comment"> * @see avresample_convert()</span>
<a name="l00196"></a>00196 <span class="comment"> * @see avresample_set_matrix()</span>
<a name="l00197"></a>00197 <span class="comment"> *</span>
<a name="l00198"></a>00198 <span class="comment"> * @param avr audio resample context</span>
<a name="l00199"></a>00199 <span class="comment"> */</span>
<a name="l00200"></a>00200 <span class="keywordtype">void</span> <a class="code" href="group__lavr.html#ga30751a8c6923418a090281669362bf79" title="Close AVAudioResampleContext.">avresample_close</a>(<a class="code" href="group__lavr.html#gabe4ee61779da95d51dff716ef5b275a3">AVAudioResampleContext</a> *avr);
<a name="l00201"></a>00201 <span class="comment"></span>
<a name="l00202"></a>00202 <span class="comment">/**</span>
<a name="l00203"></a>00203 <span class="comment"> * Free AVAudioResampleContext and associated AVOption values.</span>
<a name="l00204"></a>00204 <span class="comment"> *</span>
<a name="l00205"></a>00205 <span class="comment"> * This also calls avresample_close() before freeing.</span>
<a name="l00206"></a>00206 <span class="comment"> *</span>
<a name="l00207"></a>00207 <span class="comment"> * @param avr audio resample context</span>
<a name="l00208"></a>00208 <span class="comment"> */</span>
<a name="l00209"></a>00209 <span class="keywordtype">void</span> <a class="code" href="group__lavr.html#ga1d0782fe9a331b823c6d0dda5dbc63a5" title="Free AVAudioResampleContext and associated AVOption values.">avresample_free</a>(<a class="code" href="group__lavr.html#gabe4ee61779da95d51dff716ef5b275a3">AVAudioResampleContext</a> **avr);
<a name="l00210"></a>00210 <span class="comment"></span>
<a name="l00211"></a>00211 <span class="comment">/**</span>
<a name="l00212"></a>00212 <span class="comment"> * Generate a channel mixing matrix.</span>
<a name="l00213"></a>00213 <span class="comment"> *</span>
<a name="l00214"></a>00214 <span class="comment"> * This function is the one used internally by libavresample for building the</span>
<a name="l00215"></a>00215 <span class="comment"> * default mixing matrix. It is made public just as a utility function for</span>
<a name="l00216"></a>00216 <span class="comment"> * building custom matrices.</span>
<a name="l00217"></a>00217 <span class="comment"> *</span>
<a name="l00218"></a>00218 <span class="comment"> * @param in_layout input channel layout</span>
<a name="l00219"></a>00219 <span class="comment"> * @param out_layout output channel layout</span>
<a name="l00220"></a>00220 <span class="comment"> * @param center_mix_level mix level for the center channel</span>
<a name="l00221"></a>00221 <span class="comment"> * @param surround_mix_level mix level for the surround channel(s)</span>
<a name="l00222"></a>00222 <span class="comment"> * @param lfe_mix_level mix level for the low-frequency effects channel</span>
<a name="l00223"></a>00223 <span class="comment"> * @param normalize if 1, coefficients will be normalized to prevent</span>
<a name="l00224"></a>00224 <span class="comment"> * overflow. if 0, coefficients will not be</span>
<a name="l00225"></a>00225 <span class="comment"> * normalized.</span>
<a name="l00226"></a>00226 <span class="comment"> * @param[out] matrix mixing coefficients; matrix[i + stride * o] is</span>
<a name="l00227"></a>00227 <span class="comment"> * the weight of input channel i in output channel o.</span>
<a name="l00228"></a>00228 <span class="comment"> * @param stride distance between adjacent input channels in the</span>
<a name="l00229"></a>00229 <span class="comment"> * matrix array</span>
<a name="l00230"></a>00230 <span class="comment"> * @param matrix_encoding matrixed stereo downmix mode (e.g. dplii)</span>
<a name="l00231"></a>00231 <span class="comment"> * @return 0 on success, negative AVERROR code on failure</span>
<a name="l00232"></a>00232 <span class="comment"> */</span>
<a name="l00233"></a>00233 <span class="keywordtype">int</span> <a class="code" href="group__lavr.html#ga496a46260f4a5f5854ecc21f0f0011c8" title="Generate a channel mixing matrix.">avresample_build_matrix</a>(uint64_t in_layout, uint64_t out_layout,
<a name="l00234"></a>00234 <span class="keywordtype">double</span> center_mix_level, <span class="keywordtype">double</span> surround_mix_level,
<a name="l00235"></a>00235 <span class="keywordtype">double</span> lfe_mix_level, <span class="keywordtype">int</span> normalize, <span class="keywordtype">double</span> *matrix,
<a name="l00236"></a>00236 <span class="keywordtype">int</span> stride, <span class="keyword">enum</span> <a class="code" href="group__channel__mask__c.html#gabd576ea664e3ac5d31f3362064fe13e6">AVMatrixEncoding</a> matrix_encoding);
<a name="l00237"></a>00237 <span class="comment"></span>
<a name="l00238"></a>00238 <span class="comment">/**</span>
<a name="l00239"></a>00239 <span class="comment"> * Get the current channel mixing matrix.</span>
<a name="l00240"></a>00240 <span class="comment"> *</span>
<a name="l00241"></a>00241 <span class="comment"> * If no custom matrix has been previously set or the AVAudioResampleContext is</span>
<a name="l00242"></a>00242 <span class="comment"> * not open, an error is returned.</span>
<a name="l00243"></a>00243 <span class="comment"> *</span>
<a name="l00244"></a>00244 <span class="comment"> * @param avr audio resample context</span>
<a name="l00245"></a>00245 <span class="comment"> * @param matrix mixing coefficients; matrix[i + stride * o] is the weight of</span>
<a name="l00246"></a>00246 <span class="comment"> * input channel i in output channel o.</span>
<a name="l00247"></a>00247 <span class="comment"> * @param stride distance between adjacent input channels in the matrix array</span>
<a name="l00248"></a>00248 <span class="comment"> * @return 0 on success, negative AVERROR code on failure</span>
<a name="l00249"></a>00249 <span class="comment"> */</span>
<a name="l00250"></a>00250 <span class="keywordtype">int</span> <a class="code" href="group__lavr.html#ga74d920b2dd1af265d7186a33f60e08e0" title="Get the current channel mixing matrix.">avresample_get_matrix</a>(<a class="code" href="group__lavr.html#gabe4ee61779da95d51dff716ef5b275a3">AVAudioResampleContext</a> *avr, <span class="keywordtype">double</span> *matrix,
<a name="l00251"></a>00251 <span class="keywordtype">int</span> stride);
<a name="l00252"></a>00252 <span class="comment"></span>
<a name="l00253"></a>00253 <span class="comment">/**</span>
<a name="l00254"></a>00254 <span class="comment"> * Set channel mixing matrix.</span>
<a name="l00255"></a>00255 <span class="comment"> *</span>
<a name="l00256"></a>00256 <span class="comment"> * Allows for setting a custom mixing matrix, overriding the default matrix</span>
<a name="l00257"></a>00257 <span class="comment"> * generated internally during avresample_open(). This function can be called</span>
<a name="l00258"></a>00258 <span class="comment"> * anytime on an allocated context, either before or after calling</span>
<a name="l00259"></a>00259 <span class="comment"> * avresample_open(), as long as the channel layouts have been set.</span>
<a name="l00260"></a>00260 <span class="comment"> * avresample_convert() always uses the current matrix.</span>
<a name="l00261"></a>00261 <span class="comment"> * Calling avresample_close() on the context will clear the current matrix.</span>
<a name="l00262"></a>00262 <span class="comment"> *</span>
<a name="l00263"></a>00263 <span class="comment"> * @see avresample_close()</span>
<a name="l00264"></a>00264 <span class="comment"> *</span>
<a name="l00265"></a>00265 <span class="comment"> * @param avr audio resample context</span>
<a name="l00266"></a>00266 <span class="comment"> * @param matrix mixing coefficients; matrix[i + stride * o] is the weight of</span>
<a name="l00267"></a>00267 <span class="comment"> * input channel i in output channel o.</span>
<a name="l00268"></a>00268 <span class="comment"> * @param stride distance between adjacent input channels in the matrix array</span>
<a name="l00269"></a>00269 <span class="comment"> * @return 0 on success, negative AVERROR code on failure</span>
<a name="l00270"></a>00270 <span class="comment"> */</span>
<a name="l00271"></a>00271 <span class="keywordtype">int</span> <a class="code" href="group__lavr.html#ga3311c71aa573523c04882809143a9107" title="Set channel mixing matrix.">avresample_set_matrix</a>(<a class="code" href="group__lavr.html#gabe4ee61779da95d51dff716ef5b275a3">AVAudioResampleContext</a> *avr, <span class="keyword">const</span> <span class="keywordtype">double</span> *matrix,
<a name="l00272"></a>00272 <span class="keywordtype">int</span> stride);
<a name="l00273"></a>00273 <span class="comment"></span>
<a name="l00274"></a>00274 <span class="comment">/**</span>
<a name="l00275"></a>00275 <span class="comment"> * Set a customized input channel mapping.</span>
<a name="l00276"></a>00276 <span class="comment"> *</span>
<a name="l00277"></a>00277 <span class="comment"> * This function can only be called when the allocated context is not open.</span>
<a name="l00278"></a>00278 <span class="comment"> * Also, the input channel layout must have already been set.</span>
<a name="l00279"></a>00279 <span class="comment"> *</span>
<a name="l00280"></a>00280 <span class="comment"> * Calling avresample_close() on the context will clear the channel mapping.</span>
<a name="l00281"></a>00281 <span class="comment"> *</span>
<a name="l00282"></a>00282 <span class="comment"> * The map for each input channel specifies the channel index in the source to</span>
<a name="l00283"></a>00283 <span class="comment"> * use for that particular channel, or -1 to mute the channel. Source channels</span>
<a name="l00284"></a>00284 <span class="comment"> * can be duplicated by using the same index for multiple input channels.</span>
<a name="l00285"></a>00285 <span class="comment"> *</span>
<a name="l00286"></a>00286 <span class="comment"> * Examples:</span>
<a name="l00287"></a>00287 <span class="comment"> *</span>
<a name="l00288"></a>00288 <span class="comment"> * Reordering 5.1 AAC order (C,L,R,Ls,Rs,LFE) to FFmpeg order (L,R,C,LFE,Ls,Rs):</span>
<a name="l00289"></a>00289 <span class="comment"> * { 1, 2, 0, 5, 3, 4 }</span>
<a name="l00290"></a>00290 <span class="comment"> *</span>
<a name="l00291"></a>00291 <span class="comment"> * Muting the 3rd channel in 4-channel input:</span>
<a name="l00292"></a>00292 <span class="comment"> * { 0, 1, -1, 3 }</span>
<a name="l00293"></a>00293 <span class="comment"> *</span>
<a name="l00294"></a>00294 <span class="comment"> * Duplicating the left channel of stereo input:</span>
<a name="l00295"></a>00295 <span class="comment"> * { 0, 0 }</span>
<a name="l00296"></a>00296 <span class="comment"> *</span>
<a name="l00297"></a>00297 <span class="comment"> * @param avr audio resample context</span>
<a name="l00298"></a>00298 <span class="comment"> * @param channel_map customized input channel mapping</span>
<a name="l00299"></a>00299 <span class="comment"> * @return 0 on success, negative AVERROR code on failure</span>
<a name="l00300"></a>00300 <span class="comment"> */</span>
<a name="l00301"></a>00301 <span class="keywordtype">int</span> <a class="code" href="group__lavr.html#gafc3b3ffa44345e07babdd69267527cfc" title="Set a customized input channel mapping.">avresample_set_channel_mapping</a>(<a class="code" href="group__lavr.html#gabe4ee61779da95d51dff716ef5b275a3">AVAudioResampleContext</a> *avr,
<a name="l00302"></a>00302 <span class="keyword">const</span> <span class="keywordtype">int</span> *channel_map);
<a name="l00303"></a>00303 <span class="comment"></span>
<a name="l00304"></a>00304 <span class="comment">/**</span>
<a name="l00305"></a>00305 <span class="comment"> * Set compensation for resampling.</span>
<a name="l00306"></a>00306 <span class="comment"> *</span>
<a name="l00307"></a>00307 <span class="comment"> * This can be called anytime after avresample_open(). If resampling is not</span>
<a name="l00308"></a>00308 <span class="comment"> * automatically enabled because of a sample rate conversion, the</span>
<a name="l00309"></a>00309 <span class="comment"> * "force_resampling" option must have been set to 1 when opening the context</span>
<a name="l00310"></a>00310 <span class="comment"> * in order to use resampling compensation.</span>
<a name="l00311"></a>00311 <span class="comment"> *</span>
<a name="l00312"></a>00312 <span class="comment"> * @param avr audio resample context</span>
<a name="l00313"></a>00313 <span class="comment"> * @param sample_delta compensation delta, in samples</span>
<a name="l00314"></a>00314 <span class="comment"> * @param compensation_distance compensation distance, in samples</span>
<a name="l00315"></a>00315 <span class="comment"> * @return 0 on success, negative AVERROR code on failure</span>
<a name="l00316"></a>00316 <span class="comment"> */</span>
<a name="l00317"></a>00317 <span class="keywordtype">int</span> <a class="code" href="group__lavr.html#ga2c7722a7b56ed3c4a44174611316d6ab" title="Set compensation for resampling.">avresample_set_compensation</a>(<a class="code" href="group__lavr.html#gabe4ee61779da95d51dff716ef5b275a3">AVAudioResampleContext</a> *avr, <span class="keywordtype">int</span> sample_delta,
<a name="l00318"></a>00318 <span class="keywordtype">int</span> compensation_distance);
<a name="l00319"></a>00319 <span class="comment"></span>
<a name="l00320"></a>00320 <span class="comment">/**</span>
<a name="l00321"></a>00321 <span class="comment"> * Provide the upper bound on the number of samples the configured</span>
<a name="l00322"></a>00322 <span class="comment"> * conversion would output.</span>
<a name="l00323"></a>00323 <span class="comment"> *</span>
<a name="l00324"></a>00324 <span class="comment"> * @param avr audio resample context</span>
<a name="l00325"></a>00325 <span class="comment"> * @param in_nb_samples number of input samples</span>
<a name="l00326"></a>00326 <span class="comment"> *</span>
<a name="l00327"></a>00327 <span class="comment"> * @return number of samples or AVERROR(EINVAL) if the value</span>
<a name="l00328"></a>00328 <span class="comment"> * would exceed INT_MAX</span>
<a name="l00329"></a>00329 <span class="comment"> */</span>
<a name="l00330"></a>00330
<a name="l00331"></a>00331 <span class="keywordtype">int</span> <a class="code" href="group__lavr.html#ga16a346512f238e128ba567209b7ac103" title="Provide the upper bound on the number of samples the configured conversion would output.">avresample_get_out_samples</a>(<a class="code" href="group__lavr.html#gabe4ee61779da95d51dff716ef5b275a3">AVAudioResampleContext</a> *avr, <span class="keywordtype">int</span> in_nb_samples);
<a name="l00332"></a>00332 <span class="comment"></span>
<a name="l00333"></a>00333 <span class="comment">/**</span>
<a name="l00334"></a>00334 <span class="comment"> * Convert input samples and write them to the output FIFO.</span>
<a name="l00335"></a>00335 <span class="comment"> *</span>
<a name="l00336"></a>00336 <span class="comment"> * The upper bound on the number of output samples can be obtained through</span>
<a name="l00337"></a>00337 <span class="comment"> * avresample_get_out_samples().</span>
<a name="l00338"></a>00338 <span class="comment"> *</span>
<a name="l00339"></a>00339 <span class="comment"> * The output data can be NULL or have fewer allocated samples than required.</span>
<a name="l00340"></a>00340 <span class="comment"> * In this case, any remaining samples not written to the output will be added</span>
<a name="l00341"></a>00341 <span class="comment"> * to an internal FIFO buffer, to be returned at the next call to this function</span>
<a name="l00342"></a>00342 <span class="comment"> * or to avresample_read().</span>
<a name="l00343"></a>00343 <span class="comment"> *</span>
<a name="l00344"></a>00344 <span class="comment"> * If converting sample rate, there may be data remaining in the internal</span>
<a name="l00345"></a>00345 <span class="comment"> * resampling delay buffer. avresample_get_delay() tells the number of remaining</span>
<a name="l00346"></a>00346 <span class="comment"> * samples. To get this data as output, call avresample_convert() with NULL</span>
<a name="l00347"></a>00347 <span class="comment"> * input.</span>
<a name="l00348"></a>00348 <span class="comment"> *</span>
<a name="l00349"></a>00349 <span class="comment"> * At the end of the conversion process, there may be data remaining in the</span>
<a name="l00350"></a>00350 <span class="comment"> * internal FIFO buffer. avresample_available() tells the number of remaining</span>
<a name="l00351"></a>00351 <span class="comment"> * samples. To get this data as output, either call avresample_convert() with</span>
<a name="l00352"></a>00352 <span class="comment"> * NULL input or call avresample_read().</span>
<a name="l00353"></a>00353 <span class="comment"> *</span>
<a name="l00354"></a>00354 <span class="comment"> * @see avresample_get_out_samples()</span>
<a name="l00355"></a>00355 <span class="comment"> * @see avresample_read()</span>
<a name="l00356"></a>00356 <span class="comment"> * @see avresample_get_delay()</span>
<a name="l00357"></a>00357 <span class="comment"> *</span>
<a name="l00358"></a>00358 <span class="comment"> * @param avr audio resample context</span>
<a name="l00359"></a>00359 <span class="comment"> * @param output output data pointers</span>
<a name="l00360"></a>00360 <span class="comment"> * @param out_plane_size output plane size, in bytes.</span>
<a name="l00361"></a>00361 <span class="comment"> * This can be 0 if unknown, but that will lead to</span>
<a name="l00362"></a>00362 <span class="comment"> * optimized functions not being used directly on the</span>
<a name="l00363"></a>00363 <span class="comment"> * output, which could slow down some conversions.</span>
<a name="l00364"></a>00364 <span class="comment"> * @param out_samples maximum number of samples that the output buffer can hold</span>
<a name="l00365"></a>00365 <span class="comment"> * @param input input data pointers</span>
<a name="l00366"></a>00366 <span class="comment"> * @param in_plane_size input plane size, in bytes</span>
<a name="l00367"></a>00367 <span class="comment"> * This can be 0 if unknown, but that will lead to</span>
<a name="l00368"></a>00368 <span class="comment"> * optimized functions not being used directly on the</span>
<a name="l00369"></a>00369 <span class="comment"> * input, which could slow down some conversions.</span>
<a name="l00370"></a>00370 <span class="comment"> * @param in_samples number of input samples to convert</span>
<a name="l00371"></a>00371 <span class="comment"> * @return number of samples written to the output buffer,</span>
<a name="l00372"></a>00372 <span class="comment"> * not including converted samples added to the internal</span>
<a name="l00373"></a>00373 <span class="comment"> * output FIFO</span>
<a name="l00374"></a>00374 <span class="comment"> */</span>
<a name="l00375"></a>00375 <span class="keywordtype">int</span> <a class="code" href="group__lavr.html#ga396ac8bcc2959dcedad01f91bab8145e" title="Convert input samples and write them to the output FIFO.">avresample_convert</a>(<a class="code" href="group__lavr.html#gabe4ee61779da95d51dff716ef5b275a3">AVAudioResampleContext</a> *avr, uint8_t **output,
<a name="l00376"></a>00376 <span class="keywordtype">int</span> out_plane_size, <span class="keywordtype">int</span> out_samples, uint8_t **input,
<a name="l00377"></a>00377 <span class="keywordtype">int</span> in_plane_size, <span class="keywordtype">int</span> in_samples);
<a name="l00378"></a>00378 <span class="comment"></span>
<a name="l00379"></a>00379 <span class="comment">/**</span>
<a name="l00380"></a>00380 <span class="comment"> * Return the number of samples currently in the resampling delay buffer.</span>
<a name="l00381"></a>00381 <span class="comment"> *</span>
<a name="l00382"></a>00382 <span class="comment"> * When resampling, there may be a delay between the input and output. Any</span>
<a name="l00383"></a>00383 <span class="comment"> * unconverted samples in each call are stored internally in a delay buffer.</span>
<a name="l00384"></a>00384 <span class="comment"> * This function allows the user to determine the current number of samples in</span>
<a name="l00385"></a>00385 <span class="comment"> * the delay buffer, which can be useful for synchronization.</span>
<a name="l00386"></a>00386 <span class="comment"> *</span>
<a name="l00387"></a>00387 <span class="comment"> * @see avresample_convert()</span>
<a name="l00388"></a>00388 <span class="comment"> *</span>
<a name="l00389"></a>00389 <span class="comment"> * @param avr audio resample context</span>
<a name="l00390"></a>00390 <span class="comment"> * @return number of samples currently in the resampling delay buffer</span>
<a name="l00391"></a>00391 <span class="comment"> */</span>
<a name="l00392"></a>00392 <span class="keywordtype">int</span> <a class="code" href="group__lavr.html#ga66240ec48b20c7a688ea0cd5fae6db15" title="Return the number of samples currently in the resampling delay buffer.">avresample_get_delay</a>(<a class="code" href="group__lavr.html#gabe4ee61779da95d51dff716ef5b275a3">AVAudioResampleContext</a> *avr);
<a name="l00393"></a>00393 <span class="comment"></span>
<a name="l00394"></a>00394 <span class="comment">/**</span>
<a name="l00395"></a>00395 <span class="comment"> * Return the number of available samples in the output FIFO.</span>
<a name="l00396"></a>00396 <span class="comment"> *</span>
<a name="l00397"></a>00397 <span class="comment"> * During conversion, if the user does not specify an output buffer or</span>
<a name="l00398"></a>00398 <span class="comment"> * specifies an output buffer that is smaller than what is needed, remaining</span>
<a name="l00399"></a>00399 <span class="comment"> * samples that are not written to the output are stored to an internal FIFO</span>
<a name="l00400"></a>00400 <span class="comment"> * buffer. The samples in the FIFO can be read with avresample_read() or</span>
<a name="l00401"></a>00401 <span class="comment"> * avresample_convert().</span>
<a name="l00402"></a>00402 <span class="comment"> *</span>
<a name="l00403"></a>00403 <span class="comment"> * @see avresample_read()</span>
<a name="l00404"></a>00404 <span class="comment"> * @see avresample_convert()</span>
<a name="l00405"></a>00405 <span class="comment"> *</span>
<a name="l00406"></a>00406 <span class="comment"> * @param avr audio resample context</span>
<a name="l00407"></a>00407 <span class="comment"> * @return number of samples available for reading</span>
<a name="l00408"></a>00408 <span class="comment"> */</span>
<a name="l00409"></a>00409 <span class="keywordtype">int</span> <a class="code" href="group__lavr.html#ga1ed549e1e347ab11bb81883b9ce6bca2" title="Return the number of available samples in the output FIFO.">avresample_available</a>(<a class="code" href="group__lavr.html#gabe4ee61779da95d51dff716ef5b275a3">AVAudioResampleContext</a> *avr);
<a name="l00410"></a>00410 <span class="comment"></span>
<a name="l00411"></a>00411 <span class="comment">/**</span>
<a name="l00412"></a>00412 <span class="comment"> * Read samples from the output FIFO.</span>
<a name="l00413"></a>00413 <span class="comment"> *</span>
<a name="l00414"></a>00414 <span class="comment"> * During conversion, if the user does not specify an output buffer or</span>
<a name="l00415"></a>00415 <span class="comment"> * specifies an output buffer that is smaller than what is needed, remaining</span>
<a name="l00416"></a>00416 <span class="comment"> * samples that are not written to the output are stored to an internal FIFO</span>
<a name="l00417"></a>00417 <span class="comment"> * buffer. This function can be used to read samples from that internal FIFO.</span>
<a name="l00418"></a>00418 <span class="comment"> *</span>
<a name="l00419"></a>00419 <span class="comment"> * @see avresample_available()</span>
<a name="l00420"></a>00420 <span class="comment"> * @see avresample_convert()</span>
<a name="l00421"></a>00421 <span class="comment"> *</span>
<a name="l00422"></a>00422 <span class="comment"> * @param avr audio resample context</span>
<a name="l00423"></a>00423 <span class="comment"> * @param output output data pointers. May be NULL, in which case</span>
<a name="l00424"></a>00424 <span class="comment"> * nb_samples of data is discarded from output FIFO.</span>
<a name="l00425"></a>00425 <span class="comment"> * @param nb_samples number of samples to read from the FIFO</span>
<a name="l00426"></a>00426 <span class="comment"> * @return the number of samples written to output</span>
<a name="l00427"></a>00427 <span class="comment"> */</span>
<a name="l00428"></a>00428 <span class="keywordtype">int</span> <a class="code" href="group__lavr.html#gae115c3f6edea41ae634583737bc554f9" title="Read samples from the output FIFO.">avresample_read</a>(<a class="code" href="group__lavr.html#gabe4ee61779da95d51dff716ef5b275a3">AVAudioResampleContext</a> *avr, uint8_t **output, <span class="keywordtype">int</span> nb_samples);
<a name="l00429"></a>00429 <span class="comment"></span>
<a name="l00430"></a>00430 <span class="comment">/**</span>
<a name="l00431"></a>00431 <span class="comment"> * Convert the samples in the input AVFrame and write them to the output AVFrame.</span>
<a name="l00432"></a>00432 <span class="comment"> *</span>
<a name="l00433"></a>00433 <span class="comment"> * Input and output AVFrames must have channel_layout, sample_rate and format set.</span>
<a name="l00434"></a>00434 <span class="comment"> *</span>
<a name="l00435"></a>00435 <span class="comment"> * The upper bound on the number of output samples is obtained through</span>
<a name="l00436"></a>00436 <span class="comment"> * avresample_get_out_samples().</span>
<a name="l00437"></a>00437 <span class="comment"> *</span>
<a name="l00438"></a>00438 <span class="comment"> * If the output AVFrame does not have the data pointers allocated the nb_samples</span>
<a name="l00439"></a>00439 <span class="comment"> * field will be set using avresample_get_out_samples() and av_frame_get_buffer()</span>
<a name="l00440"></a>00440 <span class="comment"> * is called to allocate the frame.</span>
<a name="l00441"></a>00441 <span class="comment"> *</span>
<a name="l00442"></a>00442 <span class="comment"> * The output AVFrame can be NULL or have fewer allocated samples than required.</span>
<a name="l00443"></a>00443 <span class="comment"> * In this case, any remaining samples not written to the output will be added</span>
<a name="l00444"></a>00444 <span class="comment"> * to an internal FIFO buffer, to be returned at the next call to this function</span>
<a name="l00445"></a>00445 <span class="comment"> * or to avresample_convert() or to avresample_read().</span>
<a name="l00446"></a>00446 <span class="comment"> *</span>
<a name="l00447"></a>00447 <span class="comment"> * If converting sample rate, there may be data remaining in the internal</span>
<a name="l00448"></a>00448 <span class="comment"> * resampling delay buffer. avresample_get_delay() tells the number of</span>
<a name="l00449"></a>00449 <span class="comment"> * remaining samples. To get this data as output, call this function or</span>
<a name="l00450"></a>00450 <span class="comment"> * avresample_convert() with NULL input.</span>
<a name="l00451"></a>00451 <span class="comment"> *</span>
<a name="l00452"></a>00452 <span class="comment"> * At the end of the conversion process, there may be data remaining in the</span>
<a name="l00453"></a>00453 <span class="comment"> * internal FIFO buffer. avresample_available() tells the number of remaining</span>
<a name="l00454"></a>00454 <span class="comment"> * samples. To get this data as output, either call this function or</span>
<a name="l00455"></a>00455 <span class="comment"> * avresample_convert() with NULL input or call avresample_read().</span>
<a name="l00456"></a>00456 <span class="comment"> *</span>
<a name="l00457"></a>00457 <span class="comment"> * If the AVAudioResampleContext configuration does not match the output and</span>
<a name="l00458"></a>00458 <span class="comment"> * input AVFrame settings the conversion does not take place and depending on</span>
<a name="l00459"></a>00459 <span class="comment"> * which AVFrame is not matching AVERROR_OUTPUT_CHANGED, AVERROR_INPUT_CHANGED</span>
<a name="l00460"></a>00460 <span class="comment"> * or AVERROR_OUTPUT_CHANGED|AVERROR_INPUT_CHANGED is returned.</span>
<a name="l00461"></a>00461 <span class="comment"> *</span>
<a name="l00462"></a>00462 <span class="comment"> * @see avresample_get_out_samples()</span>
<a name="l00463"></a>00463 <span class="comment"> * @see avresample_available()</span>
<a name="l00464"></a>00464 <span class="comment"> * @see avresample_convert()</span>
<a name="l00465"></a>00465 <span class="comment"> * @see avresample_read()</span>
<a name="l00466"></a>00466 <span class="comment"> * @see avresample_get_delay()</span>
<a name="l00467"></a>00467 <span class="comment"> *</span>
<a name="l00468"></a>00468 <span class="comment"> * @param avr audio resample context</span>
<a name="l00469"></a>00469 <span class="comment"> * @param output output AVFrame</span>
<a name="l00470"></a>00470 <span class="comment"> * @param input input AVFrame</span>
<a name="l00471"></a>00471 <span class="comment"> * @return 0 on success, AVERROR on failure or nonmatching</span>
<a name="l00472"></a>00472 <span class="comment"> * configuration.</span>
<a name="l00473"></a>00473 <span class="comment"> */</span>
<a name="l00474"></a>00474 <span class="keywordtype">int</span> <a class="code" href="group__lavr.html#gac3060330c9004aa7e88ba8d9d90b0689" title="Convert the samples in the input AVFrame and write them to the output AVFrame.">avresample_convert_frame</a>(<a class="code" href="group__lavr.html#gabe4ee61779da95d51dff716ef5b275a3">AVAudioResampleContext</a> *avr,
<a name="l00475"></a>00475 <a class="code" href="structAVFrame.html" title="This structure describes decoded (raw) audio or video data.">AVFrame</a> *output, <a class="code" href="structAVFrame.html" title="This structure describes decoded (raw) audio or video data.">AVFrame</a> *input);
<a name="l00476"></a>00476 <span class="comment"></span>
<a name="l00477"></a>00477 <span class="comment">/**</span>
<a name="l00478"></a>00478 <span class="comment"> * Configure or reconfigure the AVAudioResampleContext using the information</span>
<a name="l00479"></a>00479 <span class="comment"> * provided by the AVFrames.</span>
<a name="l00480"></a>00480 <span class="comment"> *</span>
<a name="l00481"></a>00481 <span class="comment"> * The original resampling context is reset even on failure.</span>
<a name="l00482"></a>00482 <span class="comment"> * The function calls avresample_close() internally if the context is open.</span>
<a name="l00483"></a>00483 <span class="comment"> *</span>
<a name="l00484"></a>00484 <span class="comment"> * @see avresample_open();</span>
<a name="l00485"></a>00485 <span class="comment"> * @see avresample_close();</span>
<a name="l00486"></a>00486 <span class="comment"> *</span>
<a name="l00487"></a>00487 <span class="comment"> * @param avr audio resample context</span>
<a name="l00488"></a>00488 <span class="comment"> * @param output output AVFrame</span>
<a name="l00489"></a>00489 <span class="comment"> * @param input input AVFrame</span>
<a name="l00490"></a>00490 <span class="comment"> * @return 0 on success, AVERROR on failure.</span>
<a name="l00491"></a>00491 <span class="comment"> */</span>
<a name="l00492"></a>00492 <span class="keywordtype">int</span> <a class="code" href="group__lavr.html#ga7528c331f29fc476b264b2de31f17f1e" title="Configure or reconfigure the AVAudioResampleContext using the information provided by the AVFrames...">avresample_config</a>(<a class="code" href="group__lavr.html#gabe4ee61779da95d51dff716ef5b275a3">AVAudioResampleContext</a> *avr, <a class="code" href="structAVFrame.html" title="This structure describes decoded (raw) audio or video data.">AVFrame</a> *out, <a class="code" href="structAVFrame.html" title="This structure describes decoded (raw) audio or video data.">AVFrame</a> *in);
<a name="l00493"></a>00493 <span class="comment"></span>
<a name="l00494"></a>00494 <span class="comment">/**</span>
<a name="l00495"></a>00495 <span class="comment"> * @}</span>
<a name="l00496"></a>00496 <span class="comment"> */</span>
<a name="l00497"></a>00497
<a name="l00498"></a>00498 <span class="preprocessor">#endif </span><span class="comment">/* AVRESAMPLE_AVRESAMPLE_H */</span>
</pre></div></div><!-- contents -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Defines</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.6.1
</small></address>
</body>
</html>