Repository URL to install this package:
|
Version:
8:3.0.2-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"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>FFmpeg: libavutil/fifo.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<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">3.0.2</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<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>
<!-- 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>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</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>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_8d855866ba5d436d839c7fc557836cd9.html">libavutil</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">fifo.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>a very simple circular buffer FIFO implementation
<a href="#details">More...</a></p>
<div class="textblock"><code>#include <stdint.h></code><br/>
<code>#include "<a class="el" href="avutil_8h_source.html">avutil.h</a>"</code><br/>
<code>#include "<a class="el" href="attributes_8h_source.html">attributes.h</a>"</code><br/>
</div>
<p><a href="fifo_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:adae9b18c5eed14fe851c5bb984ce374b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="fifo_8h.html#adae9b18c5eed14fe851c5bb984ce374b">av_fifo_alloc</a> (unsigned int size)</td></tr>
<tr class="memdesc:adae9b18c5eed14fe851c5bb984ce374b"><td class="mdescLeft"> </td><td class="mdescRight">Initialize an <a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a>. <a href="#adae9b18c5eed14fe851c5bb984ce374b">More...</a><br/></td></tr>
<tr class="separator:adae9b18c5eed14fe851c5bb984ce374b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ada874c149988db27a46f8f5447cef478"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="fifo_8h.html#ada874c149988db27a46f8f5447cef478">av_fifo_alloc_array</a> (size_t nmemb, size_t size)</td></tr>
<tr class="memdesc:ada874c149988db27a46f8f5447cef478"><td class="mdescLeft"> </td><td class="mdescRight">Initialize an <a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a>. <a href="#ada874c149988db27a46f8f5447cef478">More...</a><br/></td></tr>
<tr class="separator:ada874c149988db27a46f8f5447cef478"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac41532c140aacb9ad12a22c859f944aa"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="fifo_8h.html#ac41532c140aacb9ad12a22c859f944aa">av_fifo_free</a> (<a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a> *f)</td></tr>
<tr class="memdesc:ac41532c140aacb9ad12a22c859f944aa"><td class="mdescLeft"> </td><td class="mdescRight">Free an <a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a>. <a href="#ac41532c140aacb9ad12a22c859f944aa">More...</a><br/></td></tr>
<tr class="separator:ac41532c140aacb9ad12a22c859f944aa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a612be59edb6ab388a82d1487d1bd0c4d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="fifo_8h.html#a612be59edb6ab388a82d1487d1bd0c4d">av_fifo_freep</a> (<a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a> **f)</td></tr>
<tr class="memdesc:a612be59edb6ab388a82d1487d1bd0c4d"><td class="mdescLeft"> </td><td class="mdescRight">Free an <a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a> and reset pointer to NULL. <a href="#a612be59edb6ab388a82d1487d1bd0c4d">More...</a><br/></td></tr>
<tr class="separator:a612be59edb6ab388a82d1487d1bd0c4d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2f257d5cd93686b047c9b29ef6493e51"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="fifo_8h.html#a2f257d5cd93686b047c9b29ef6493e51">av_fifo_reset</a> (<a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a> *f)</td></tr>
<tr class="memdesc:a2f257d5cd93686b047c9b29ef6493e51"><td class="mdescLeft"> </td><td class="mdescRight">Reset the <a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a> to the state right after av_fifo_alloc, in particular it is emptied. <a href="#a2f257d5cd93686b047c9b29ef6493e51">More...</a><br/></td></tr>
<tr class="separator:a2f257d5cd93686b047c9b29ef6493e51"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a81f4cea70d96846df7111daccc5ecce2"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="fifo_8h.html#a81f4cea70d96846df7111daccc5ecce2">av_fifo_size</a> (const <a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a> *f)</td></tr>
<tr class="memdesc:a81f4cea70d96846df7111daccc5ecce2"><td class="mdescLeft"> </td><td class="mdescRight">Return the amount of data in bytes in the <a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a>, that is the amount of data you can read from it. <a href="#a81f4cea70d96846df7111daccc5ecce2">More...</a><br/></td></tr>
<tr class="separator:a81f4cea70d96846df7111daccc5ecce2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac1e0d8ee7f1568cb40fa95a740c60f13"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="fifo_8h.html#ac1e0d8ee7f1568cb40fa95a740c60f13">av_fifo_space</a> (const <a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a> *f)</td></tr>
<tr class="memdesc:ac1e0d8ee7f1568cb40fa95a740c60f13"><td class="mdescLeft"> </td><td class="mdescRight">Return the amount of space in bytes in the <a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a>, that is the amount of data you can write into it. <a href="#ac1e0d8ee7f1568cb40fa95a740c60f13">More...</a><br/></td></tr>
<tr class="separator:ac1e0d8ee7f1568cb40fa95a740c60f13"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae44de4980b66c0695a4cf7808c140181"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="fifo_8h.html#ae44de4980b66c0695a4cf7808c140181">av_fifo_generic_peek_at</a> (<a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a> *f, void *dest, int offset, int buf_size, void(*func)(void *, void *, int))</td></tr>
<tr class="memdesc:ae44de4980b66c0695a4cf7808c140181"><td class="mdescLeft"> </td><td class="mdescRight">Feed data at specific position from an <a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a> to a user-supplied callback. <a href="#ae44de4980b66c0695a4cf7808c140181">More...</a><br/></td></tr>
<tr class="separator:ae44de4980b66c0695a4cf7808c140181"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9fbc6be8766f3389eda0e37ca92cee65"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="fifo_8h.html#a9fbc6be8766f3389eda0e37ca92cee65">av_fifo_generic_peek</a> (<a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a> *f, void *dest, int buf_size, void(*func)(void *, void *, int))</td></tr>
<tr class="memdesc:a9fbc6be8766f3389eda0e37ca92cee65"><td class="mdescLeft"> </td><td class="mdescRight">Feed data from an <a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a> to a user-supplied callback. <a href="#a9fbc6be8766f3389eda0e37ca92cee65">More...</a><br/></td></tr>
<tr class="separator:a9fbc6be8766f3389eda0e37ca92cee65"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab708d2f19b7a9592caa278256787adb6"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="fifo_8h.html#ab708d2f19b7a9592caa278256787adb6">av_fifo_generic_read</a> (<a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a> *f, void *dest, int buf_size, void(*func)(void *, void *, int))</td></tr>
<tr class="memdesc:ab708d2f19b7a9592caa278256787adb6"><td class="mdescLeft"> </td><td class="mdescRight">Feed data from an <a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a> to a user-supplied callback. <a href="#ab708d2f19b7a9592caa278256787adb6">More...</a><br/></td></tr>
<tr class="separator:ab708d2f19b7a9592caa278256787adb6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae95c15dcdd266b4005f8919e4f571180"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="fifo_8h.html#ae95c15dcdd266b4005f8919e4f571180">av_fifo_generic_write</a> (<a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a> *f, void *src, int size, int(*func)(void *, void *, int))</td></tr>
<tr class="memdesc:ae95c15dcdd266b4005f8919e4f571180"><td class="mdescLeft"> </td><td class="mdescRight">Feed data from a user-supplied callback to an <a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a>. <a href="#ae95c15dcdd266b4005f8919e4f571180">More...</a><br/></td></tr>
<tr class="separator:ae95c15dcdd266b4005f8919e4f571180"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af50c043864cf09925aa4986e00a57067"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="fifo_8h.html#af50c043864cf09925aa4986e00a57067">av_fifo_realloc2</a> (<a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a> *f, unsigned int size)</td></tr>
<tr class="memdesc:af50c043864cf09925aa4986e00a57067"><td class="mdescLeft"> </td><td class="mdescRight">Resize an <a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a>. <a href="#af50c043864cf09925aa4986e00a57067">More...</a><br/></td></tr>
<tr class="separator:af50c043864cf09925aa4986e00a57067"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a44a36b44adf5b278eeea1cb6d5b7033b"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="fifo_8h.html#a44a36b44adf5b278eeea1cb6d5b7033b">av_fifo_grow</a> (<a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a> *f, unsigned int additional_space)</td></tr>
<tr class="memdesc:a44a36b44adf5b278eeea1cb6d5b7033b"><td class="mdescLeft"> </td><td class="mdescRight">Enlarge an <a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a>. <a href="#a44a36b44adf5b278eeea1cb6d5b7033b">More...</a><br/></td></tr>
<tr class="separator:a44a36b44adf5b278eeea1cb6d5b7033b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a037f66cc2b92aebbc363617387d39f6f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="fifo_8h.html#a037f66cc2b92aebbc363617387d39f6f">av_fifo_drain</a> (<a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a> *f, int size)</td></tr>
<tr class="memdesc:a037f66cc2b92aebbc363617387d39f6f"><td class="mdescLeft"> </td><td class="mdescRight">Read and discard the specified amount of data from an <a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a>. <a href="#a037f66cc2b92aebbc363617387d39f6f">More...</a><br/></td></tr>
<tr class="separator:a037f66cc2b92aebbc363617387d39f6f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa0212ac6ff8feab8846b9cc6df49149c"><td class="memItemLeft" align="right" valign="top">static uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="fifo_8h.html#aa0212ac6ff8feab8846b9cc6df49149c">av_fifo_peek2</a> (const <a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a> *f, int offs)</td></tr>
<tr class="memdesc:aa0212ac6ff8feab8846b9cc6df49149c"><td class="mdescLeft"> </td><td class="mdescRight">Return a pointer to the data stored in a FIFO buffer at a certain offset. <a href="#aa0212ac6ff8feab8846b9cc6df49149c">More...</a><br/></td></tr>
<tr class="separator:aa0212ac6ff8feab8846b9cc6df49149c"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>a very simple circular buffer FIFO implementation </p>
<p>Definition in file <a class="el" href="fifo_8h_source.html">fifo.h</a>.</p>
</div><h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="adae9b18c5eed14fe851c5bb984ce374b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a>* av_fifo_alloc </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>size</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize an <a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">size</td><td>of FIFO </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a> or NULL in case of memory allocation failure </dd></dl>
</div>
</div>
<a class="anchor" id="ada874c149988db27a46f8f5447cef478"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a>* av_fifo_alloc_array </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>nmemb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>size</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize an <a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">nmemb</td><td>number of elements </td></tr>
<tr><td class="paramname">size</td><td>size of the single element </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a> or NULL in case of memory allocation failure </dd></dl>
</div>
</div>
<a class="anchor" id="ac41532c140aacb9ad12a22c859f944aa"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void av_fifo_free </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a> * </td>
<td class="paramname"><em>f</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free an <a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">f</td><td><a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a> to free </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a612be59edb6ab388a82d1487d1bd0c4d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void av_fifo_freep </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a> ** </td>
<td class="paramname"><em>f</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free an <a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a> and reset pointer to NULL. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">f</td><td><a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a> to free </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a2f257d5cd93686b047c9b29ef6493e51"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void av_fifo_reset </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a> * </td>
<td class="paramname"><em>f</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Reset the <a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a> to the state right after av_fifo_alloc, in particular it is emptied. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">f</td><td><a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a> to reset </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a81f4cea70d96846df7111daccc5ecce2"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int av_fifo_size </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a> * </td>
<td class="paramname"><em>f</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the amount of data in bytes in the <a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a>, that is the amount of data you can read from it. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">f</td><td><a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a> to read from </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>size </dd></dl>
</div>
</div>
<a class="anchor" id="ac1e0d8ee7f1568cb40fa95a740c60f13"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int av_fifo_space </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a> * </td>
<td class="paramname"><em>f</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the amount of space in bytes in the <a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a>, that is the amount of data you can write into it. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">f</td><td><a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a> to write into </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>size </dd></dl>
</div>
</div>
<a class="anchor" id="ae44de4980b66c0695a4cf7808c140181"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int av_fifo_generic_peek_at </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a> * </td>
<td class="paramname"><em>f</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>dest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>buf_size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void(*)(void *, void *, int) </td>
<td class="paramname"><em>func</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Feed data at specific position from an <a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a> to a user-supplied callback. </p>
<p>Similar as av_fifo_gereric_read but without discarding data. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">f</td><td><a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a> to read from </td></tr>
<tr><td class="paramname">offset</td><td>offset from current read position </td></tr>
<tr><td class="paramname">buf_size</td><td>number of bytes to read </td></tr>
<tr><td class="paramname">func</td><td>generic read function </td></tr>
<tr><td class="paramname">dest</td><td>data destination </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a9fbc6be8766f3389eda0e37ca92cee65"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int av_fifo_generic_peek </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a> * </td>
<td class="paramname"><em>f</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>dest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>buf_size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void(*)(void *, void *, int) </td>
<td class="paramname"><em>func</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Feed data from an <a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a> to a user-supplied callback. </p>
<p>Similar as av_fifo_gereric_read but without discarding data. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">f</td><td><a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a> to read from </td></tr>
<tr><td class="paramname">buf_size</td><td>number of bytes to read </td></tr>
<tr><td class="paramname">func</td><td>generic read function </td></tr>
<tr><td class="paramname">dest</td><td>data destination </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ab708d2f19b7a9592caa278256787adb6"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int av_fifo_generic_read </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a> * </td>
<td class="paramname"><em>f</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>dest</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>buf_size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void(*)(void *, void *, int) </td>
<td class="paramname"><em>func</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Feed data from an <a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a> to a user-supplied callback. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">f</td><td><a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a> to read from </td></tr>
<tr><td class="paramname">buf_size</td><td>number of bytes to read </td></tr>
<tr><td class="paramname">func</td><td>generic read function </td></tr>
<tr><td class="paramname">dest</td><td>data destination </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ae95c15dcdd266b4005f8919e4f571180"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int av_fifo_generic_write </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a> * </td>
<td class="paramname"><em>f</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>src</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int(*)(void *, void *, int) </td>
<td class="paramname"><em>func</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Feed data from a user-supplied callback to an <a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">f</td><td><a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a> to write to </td></tr>
<tr><td class="paramname">src</td><td>data source; non-const since it may be used as a modifiable context by the function defined in func </td></tr>
<tr><td class="paramname">size</td><td>number of bytes to write </td></tr>
<tr><td class="paramname">func</td><td>generic write function; the first parameter is src, the second is dest_buf, the third is dest_buf_size. func must return the number of bytes written to dest_buf, or <= 0 to indicate no more data available to write. If func is NULL, src is interpreted as a simple byte array for source data. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the number of bytes written to the FIFO </dd></dl>
</div>
</div>
<a class="anchor" id="af50c043864cf09925aa4986e00a57067"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int av_fifo_realloc2 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a> * </td>
<td class="paramname"><em>f</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>size</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Resize an <a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a>. </p>
<p>In case of reallocation failure, the old FIFO is kept unchanged.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">f</td><td><a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a> to resize </td></tr>
<tr><td class="paramname">size</td><td>new <a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a> size in bytes </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><0 for failure, >=0 otherwise </dd></dl>
</div>
</div>
<a class="anchor" id="a44a36b44adf5b278eeea1cb6d5b7033b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int av_fifo_grow </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a> * </td>
<td class="paramname"><em>f</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>additional_space</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enlarge an <a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a>. </p>
<p>In case of reallocation failure, the old FIFO is kept unchanged. The new fifo size may be larger than the requested size.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">f</td><td><a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a> to resize </td></tr>
<tr><td class="paramname">additional_space</td><td>the amount of space in bytes to allocate in addition to <a class="el" href="fifo_8h.html#a81f4cea70d96846df7111daccc5ecce2" title="Return the amount of data in bytes in the AVFifoBuffer, that is the amount of data you can read from ...">av_fifo_size()</a> </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><0 for failure, >=0 otherwise </dd></dl>
</div>
</div>
<a class="anchor" id="a037f66cc2b92aebbc363617387d39f6f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void av_fifo_drain </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a> * </td>
<td class="paramname"><em>f</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>size</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Read and discard the specified amount of data from an <a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">f</td><td><a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a> to read from </td></tr>
<tr><td class="paramname">size</td><td>amount of data to read in bytes </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aa0212ac6ff8feab8846b9cc6df49149c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static uint8_t* av_fifo_peek2 </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a> * </td>
<td class="paramname"><em>f</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>offs</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return a pointer to the data stored in a FIFO buffer at a certain offset. </p>
<p>The FIFO buffer is not modified.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">f</td><td><a class="el" href="structAVFifoBuffer.html">AVFifoBuffer</a> to peek at, f must be non-NULL </td></tr>
<tr><td class="paramname">offs</td><td>an offset in bytes, its absolute value must be less than the used buffer size or the returned pointer will point outside to the buffer data. The used buffer size can be checked with <a class="el" href="fifo_8h.html#a81f4cea70d96846df7111daccc5ecce2" title="Return the amount of data in bytes in the AVFifoBuffer, that is the amount of data you can read from ...">av_fifo_size()</a>. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="fifo_8h_source.html#l00169">169</a> of file <a class="el" href="fifo_8h_source.html">fifo.h</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<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.8.6
</small></address>
</body>
</html>