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: libavutil/audio_fifo.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">libavutil/audio_fifo.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="audio__fifo_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"> * Audio FIFO</span>
<a name="l00003"></a>00003 <span class="comment"> * Copyright (c) 2012 Justin Ruggles <justin.ruggles@gmail.com></span>
<a name="l00004"></a>00004 <span class="comment"> *</span>
<a name="l00005"></a>00005 <span class="comment"> * This file is part of FFmpeg.</span>
<a name="l00006"></a>00006 <span class="comment"> *</span>
<a name="l00007"></a>00007 <span class="comment"> * FFmpeg is free software; you can redistribute it and/or</span>
<a name="l00008"></a>00008 <span class="comment"> * modify it under the terms of the GNU Lesser General Public</span>
<a name="l00009"></a>00009 <span class="comment"> * License as published by the Free Software Foundation; either</span>
<a name="l00010"></a>00010 <span class="comment"> * version 2.1 of the License, or (at your option) any later version.</span>
<a name="l00011"></a>00011 <span class="comment"> *</span>
<a name="l00012"></a>00012 <span class="comment"> * FFmpeg is distributed in the hope that it will be useful,</span>
<a name="l00013"></a>00013 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00014"></a>00014 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span>
<a name="l00015"></a>00015 <span class="comment"> * Lesser General Public License for more details.</span>
<a name="l00016"></a>00016 <span class="comment"> *</span>
<a name="l00017"></a>00017 <span class="comment"> * You should have received a copy of the GNU Lesser General Public</span>
<a name="l00018"></a>00018 <span class="comment"> * License along with FFmpeg; if not, write to the Free Software</span>
<a name="l00019"></a>00019 <span class="comment"> * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA</span>
<a name="l00020"></a>00020 <span class="comment"> */</span>
<a name="l00021"></a>00021 <span class="comment"></span>
<a name="l00022"></a>00022 <span class="comment">/**</span>
<a name="l00023"></a>00023 <span class="comment"> * @file</span>
<a name="l00024"></a>00024 <span class="comment"> * Audio FIFO Buffer</span>
<a name="l00025"></a>00025 <span class="comment"> */</span>
<a name="l00026"></a>00026
<a name="l00027"></a>00027 <span class="preprocessor">#ifndef AVUTIL_AUDIO_FIFO_H</span>
<a name="l00028"></a>00028 <span class="preprocessor"></span><span class="preprocessor">#define AVUTIL_AUDIO_FIFO_H</span>
<a name="l00029"></a>00029 <span class="preprocessor"></span>
<a name="l00030"></a>00030 <span class="preprocessor">#include "<a class="code" href="avutil_8h.html" title="external API header">avutil.h</a>"</span>
<a name="l00031"></a>00031 <span class="preprocessor">#include "<a class="code" href="fifo_8h.html" title="a very simple circular buffer FIFO implementation">fifo.h</a>"</span>
<a name="l00032"></a>00032 <span class="preprocessor">#include "<a class="code" href="samplefmt_8h.html">samplefmt.h</a>"</span>
<a name="l00033"></a>00033 <span class="comment"></span>
<a name="l00034"></a>00034 <span class="comment">/**</span>
<a name="l00035"></a>00035 <span class="comment"> * @addtogroup lavu_audio</span>
<a name="l00036"></a>00036 <span class="comment"> * @{</span>
<a name="l00037"></a>00037 <span class="comment"> *</span>
<a name="l00038"></a>00038 <span class="comment"> * @defgroup lavu_audiofifo Audio FIFO Buffer</span>
<a name="l00039"></a>00039 <span class="comment"> * @{</span>
<a name="l00040"></a>00040 <span class="comment"> */</span>
<a name="l00041"></a>00041 <span class="comment"></span>
<a name="l00042"></a>00042 <span class="comment">/**</span>
<a name="l00043"></a>00043 <span class="comment"> * Context for an Audio FIFO Buffer.</span>
<a name="l00044"></a>00044 <span class="comment"> *</span>
<a name="l00045"></a>00045 <span class="comment"> * - Operates at the sample level rather than the byte level.</span>
<a name="l00046"></a>00046 <span class="comment"> * - Supports multiple channels with either planar or packed sample format.</span>
<a name="l00047"></a>00047 <span class="comment"> * - Automatic reallocation when writing to a full buffer.</span>
<a name="l00048"></a>00048 <span class="comment"> */</span>
<a name="l00049"></a><a class="code" href="group__lavu__audiofifo.html#ga328abb21e9abb2c455d2d9c212d5230f">00049</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="group__lavu__audiofifo.html#ga328abb21e9abb2c455d2d9c212d5230f" title="Context for an Audio FIFO Buffer.">AVAudioFifo</a> <a class="code" href="group__lavu__audiofifo.html#ga328abb21e9abb2c455d2d9c212d5230f" title="Context for an Audio FIFO Buffer.">AVAudioFifo</a>;
<a name="l00050"></a>00050 <span class="comment"></span>
<a name="l00051"></a>00051 <span class="comment">/**</span>
<a name="l00052"></a>00052 <span class="comment"> * Free an AVAudioFifo.</span>
<a name="l00053"></a>00053 <span class="comment"> *</span>
<a name="l00054"></a>00054 <span class="comment"> * @param af AVAudioFifo to free</span>
<a name="l00055"></a>00055 <span class="comment"> */</span>
<a name="l00056"></a>00056 <span class="keywordtype">void</span> <a class="code" href="group__lavu__audiofifo.html#ga74e029e47f7aa99217ad1f315c434875" title="Free an AVAudioFifo.">av_audio_fifo_free</a>(<a class="code" href="group__lavu__audiofifo.html#ga328abb21e9abb2c455d2d9c212d5230f" title="Context for an Audio FIFO Buffer.">AVAudioFifo</a> *af);
<a name="l00057"></a>00057 <span class="comment"></span>
<a name="l00058"></a>00058 <span class="comment">/**</span>
<a name="l00059"></a>00059 <span class="comment"> * Allocate an AVAudioFifo.</span>
<a name="l00060"></a>00060 <span class="comment"> *</span>
<a name="l00061"></a>00061 <span class="comment"> * @param sample_fmt sample format</span>
<a name="l00062"></a>00062 <span class="comment"> * @param channels number of channels</span>
<a name="l00063"></a>00063 <span class="comment"> * @param nb_samples initial allocation size, in samples</span>
<a name="l00064"></a>00064 <span class="comment"> * @return newly allocated AVAudioFifo, or NULL on error</span>
<a name="l00065"></a>00065 <span class="comment"> */</span>
<a name="l00066"></a>00066 <a class="code" href="group__lavu__audiofifo.html#ga328abb21e9abb2c455d2d9c212d5230f" title="Context for an Audio FIFO Buffer.">AVAudioFifo</a> *<a class="code" href="group__lavu__audiofifo.html#ga9d792394f0615a329aec47847f8f8784" title="Allocate an AVAudioFifo.">av_audio_fifo_alloc</a>(<span class="keyword">enum</span> <a class="code" href="group__lavu__sampfmts.html#gaf9a51ca15301871723577c730b5865c5" title="Audio sample formats.">AVSampleFormat</a> sample_fmt, <span class="keywordtype">int</span> channels,
<a name="l00067"></a>00067 <span class="keywordtype">int</span> nb_samples);
<a name="l00068"></a>00068 <span class="comment"></span>
<a name="l00069"></a>00069 <span class="comment">/**</span>
<a name="l00070"></a>00070 <span class="comment"> * Reallocate an AVAudioFifo.</span>
<a name="l00071"></a>00071 <span class="comment"> *</span>
<a name="l00072"></a>00072 <span class="comment"> * @param af AVAudioFifo to reallocate</span>
<a name="l00073"></a>00073 <span class="comment"> * @param nb_samples new allocation size, in samples</span>
<a name="l00074"></a>00074 <span class="comment"> * @return 0 if OK, or negative AVERROR code on failure</span>
<a name="l00075"></a>00075 <span class="comment"> */</span>
<a name="l00076"></a>00076 <span class="keywordtype">int</span> <a class="code" href="group__lavu__audiofifo.html#gae34e4eb0928f8e4539730d8c044c6139" title="Reallocate an AVAudioFifo.">av_audio_fifo_realloc</a>(<a class="code" href="group__lavu__audiofifo.html#ga328abb21e9abb2c455d2d9c212d5230f" title="Context for an Audio FIFO Buffer.">AVAudioFifo</a> *af, <span class="keywordtype">int</span> nb_samples);
<a name="l00077"></a>00077 <span class="comment"></span>
<a name="l00078"></a>00078 <span class="comment">/**</span>
<a name="l00079"></a>00079 <span class="comment"> * Write data to an AVAudioFifo.</span>
<a name="l00080"></a>00080 <span class="comment"> *</span>
<a name="l00081"></a>00081 <span class="comment"> * The AVAudioFifo will be reallocated automatically if the available space</span>
<a name="l00082"></a>00082 <span class="comment"> * is less than nb_samples.</span>
<a name="l00083"></a>00083 <span class="comment"> *</span>
<a name="l00084"></a>00084 <span class="comment"> * @see enum AVSampleFormat</span>
<a name="l00085"></a>00085 <span class="comment"> * The documentation for AVSampleFormat describes the data layout.</span>
<a name="l00086"></a>00086 <span class="comment"> *</span>
<a name="l00087"></a>00087 <span class="comment"> * @param af AVAudioFifo to write to</span>
<a name="l00088"></a>00088 <span class="comment"> * @param data audio data plane pointers</span>
<a name="l00089"></a>00089 <span class="comment"> * @param nb_samples number of samples to write</span>
<a name="l00090"></a>00090 <span class="comment"> * @return number of samples actually written, or negative AVERROR</span>
<a name="l00091"></a>00091 <span class="comment"> * code on failure. If successful, the number of samples</span>
<a name="l00092"></a>00092 <span class="comment"> * actually written will always be nb_samples.</span>
<a name="l00093"></a>00093 <span class="comment"> */</span>
<a name="l00094"></a>00094 <span class="keywordtype">int</span> <a class="code" href="group__lavu__audiofifo.html#ga0e7fadeea09c52a96eb4082a9e169bb4" title="Write data to an AVAudioFifo.">av_audio_fifo_write</a>(<a class="code" href="group__lavu__audiofifo.html#ga328abb21e9abb2c455d2d9c212d5230f" title="Context for an Audio FIFO Buffer.">AVAudioFifo</a> *af, <span class="keywordtype">void</span> **data, <span class="keywordtype">int</span> nb_samples);
<a name="l00095"></a>00095 <span class="comment"></span>
<a name="l00096"></a>00096 <span class="comment">/**</span>
<a name="l00097"></a>00097 <span class="comment"> * Read data from an AVAudioFifo.</span>
<a name="l00098"></a>00098 <span class="comment"> *</span>
<a name="l00099"></a>00099 <span class="comment"> * @see enum AVSampleFormat</span>
<a name="l00100"></a>00100 <span class="comment"> * The documentation for AVSampleFormat describes the data layout.</span>
<a name="l00101"></a>00101 <span class="comment"> *</span>
<a name="l00102"></a>00102 <span class="comment"> * @param af AVAudioFifo to read from</span>
<a name="l00103"></a>00103 <span class="comment"> * @param data audio data plane pointers</span>
<a name="l00104"></a>00104 <span class="comment"> * @param nb_samples number of samples to read</span>
<a name="l00105"></a>00105 <span class="comment"> * @return number of samples actually read, or negative AVERROR code</span>
<a name="l00106"></a>00106 <span class="comment"> * on failure. The number of samples actually read will not</span>
<a name="l00107"></a>00107 <span class="comment"> * be greater than nb_samples, and will only be less than</span>
<a name="l00108"></a>00108 <span class="comment"> * nb_samples if av_audio_fifo_size is less than nb_samples.</span>
<a name="l00109"></a>00109 <span class="comment"> */</span>
<a name="l00110"></a>00110 <span class="keywordtype">int</span> <a class="code" href="group__lavu__audiofifo.html#gab256fc29188d91311bd2fbd78eb356af" title="Read data from an AVAudioFifo.">av_audio_fifo_read</a>(<a class="code" href="group__lavu__audiofifo.html#ga328abb21e9abb2c455d2d9c212d5230f" title="Context for an Audio FIFO Buffer.">AVAudioFifo</a> *af, <span class="keywordtype">void</span> **data, <span class="keywordtype">int</span> nb_samples);
<a name="l00111"></a>00111 <span class="comment"></span>
<a name="l00112"></a>00112 <span class="comment">/**</span>
<a name="l00113"></a>00113 <span class="comment"> * Drain data from an AVAudioFifo.</span>
<a name="l00114"></a>00114 <span class="comment"> *</span>
<a name="l00115"></a>00115 <span class="comment"> * Removes the data without reading it.</span>
<a name="l00116"></a>00116 <span class="comment"> *</span>
<a name="l00117"></a>00117 <span class="comment"> * @param af AVAudioFifo to drain</span>
<a name="l00118"></a>00118 <span class="comment"> * @param nb_samples number of samples to drain</span>
<a name="l00119"></a>00119 <span class="comment"> * @return 0 if OK, or negative AVERROR code on failure</span>
<a name="l00120"></a>00120 <span class="comment"> */</span>
<a name="l00121"></a>00121 <span class="keywordtype">int</span> <a class="code" href="group__lavu__audiofifo.html#gacac9b187b9c27c5a0374f6f83224a77b" title="Drain data from an AVAudioFifo.">av_audio_fifo_drain</a>(<a class="code" href="group__lavu__audiofifo.html#ga328abb21e9abb2c455d2d9c212d5230f" title="Context for an Audio FIFO Buffer.">AVAudioFifo</a> *af, <span class="keywordtype">int</span> nb_samples);
<a name="l00122"></a>00122 <span class="comment"></span>
<a name="l00123"></a>00123 <span class="comment">/**</span>
<a name="l00124"></a>00124 <span class="comment"> * Reset the AVAudioFifo buffer.</span>
<a name="l00125"></a>00125 <span class="comment"> *</span>
<a name="l00126"></a>00126 <span class="comment"> * This empties all data in the buffer.</span>
<a name="l00127"></a>00127 <span class="comment"> *</span>
<a name="l00128"></a>00128 <span class="comment"> * @param af AVAudioFifo to reset</span>
<a name="l00129"></a>00129 <span class="comment"> */</span>
<a name="l00130"></a>00130 <span class="keywordtype">void</span> <a class="code" href="group__lavu__audiofifo.html#ga3f070386d11d425302437a3b60fc5dd0" title="Reset the AVAudioFifo buffer.">av_audio_fifo_reset</a>(<a class="code" href="group__lavu__audiofifo.html#ga328abb21e9abb2c455d2d9c212d5230f" title="Context for an Audio FIFO Buffer.">AVAudioFifo</a> *af);
<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"> * Get the current number of samples in the AVAudioFifo available for reading.</span>
<a name="l00134"></a>00134 <span class="comment"> *</span>
<a name="l00135"></a>00135 <span class="comment"> * @param af the AVAudioFifo to query</span>
<a name="l00136"></a>00136 <span class="comment"> * @return number of samples available for reading</span>
<a name="l00137"></a>00137 <span class="comment"> */</span>
<a name="l00138"></a>00138 <span class="keywordtype">int</span> <a class="code" href="group__lavu__audiofifo.html#gaa0a4742ecac52a999e8b4478d27f3b9b" title="Get the current number of samples in the AVAudioFifo available for reading.">av_audio_fifo_size</a>(<a class="code" href="group__lavu__audiofifo.html#ga328abb21e9abb2c455d2d9c212d5230f" title="Context for an Audio FIFO Buffer.">AVAudioFifo</a> *af);
<a name="l00139"></a>00139 <span class="comment"></span>
<a name="l00140"></a>00140 <span class="comment">/**</span>
<a name="l00141"></a>00141 <span class="comment"> * Get the current number of samples in the AVAudioFifo available for writing.</span>
<a name="l00142"></a>00142 <span class="comment"> *</span>
<a name="l00143"></a>00143 <span class="comment"> * @param af the AVAudioFifo to query</span>
<a name="l00144"></a>00144 <span class="comment"> * @return number of samples available for writing</span>
<a name="l00145"></a>00145 <span class="comment"> */</span>
<a name="l00146"></a>00146 <span class="keywordtype">int</span> <a class="code" href="group__lavu__audiofifo.html#ga2bed2f01fe34228ee8a73617b3177d00" title="Get the current number of samples in the AVAudioFifo available for writing.">av_audio_fifo_space</a>(<a class="code" href="group__lavu__audiofifo.html#ga328abb21e9abb2c455d2d9c212d5230f" title="Context for an Audio FIFO Buffer.">AVAudioFifo</a> *af);
<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"> * @}</span>
<a name="l00150"></a>00150 <span class="comment"> * @}</span>
<a name="l00151"></a>00151 <span class="comment"> */</span>
<a name="l00152"></a>00152
<a name="l00153"></a>00153 <span class="preprocessor">#endif </span><span class="comment">/* AVUTIL_AUDIO_FIFO_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>