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: libavcodec/vorbis_parser.h File Reference</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="summary">
<a href="#define-members">Defines</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">libavcodec/vorbis_parser.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A public API for Vorbis parsing.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include <stdint.h></code><br/>
</div>
<p><a href="vorbis__parser_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="define-members"></a>
Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="vorbis__parser_8h.html#a9205506ccac8f073592f93efa841dd29">VORBIS_FLAG_HEADER</a>   0x00000001</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="vorbis__parser_8h.html#a837f7868aa92752a2727f6b66d9cf7ea">VORBIS_FLAG_COMMENT</a>   0x00000002</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="vorbis__parser_8h.html#a03a79f9bda327495ba1a9ad16574c583">VORBIS_FLAG_SETUP</a>   0x00000004</td></tr>
<tr><td colspan="2"><h2><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="vorbis__parser_8h.html#afe7b8c3bcf03727e31e1a6bedf4d1846">AVVorbisParseContext</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="vorbis__parser_8h.html#afe7b8c3bcf03727e31e1a6bedf4d1846">AVVorbisParseContext</a></td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="vorbis__parser_8h.html#afe7b8c3bcf03727e31e1a6bedf4d1846">AVVorbisParseContext</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="vorbis__parser_8h.html#ae9124f78020f66109fd657ab248d0eee">av_vorbis_parse_init</a> (const uint8_t *extradata, int extradata_size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Allocate and initialize the Vorbis parser using headers in the extradata. <a href="#ae9124f78020f66109fd657ab248d0eee"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="vorbis__parser_8h.html#a09d3132681826153f26ff5a9ee36a30d">av_vorbis_parse_free</a> (<a class="el" href="vorbis__parser_8h.html#afe7b8c3bcf03727e31e1a6bedf4d1846">AVVorbisParseContext</a> **s)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Free the parser and everything associated with it. <a href="#a09d3132681826153f26ff5a9ee36a30d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="vorbis__parser_8h.html#a1e1b41858faedc564fc7a01b0eb910d9">av_vorbis_parse_frame_flags</a> (<a class="el" href="vorbis__parser_8h.html#afe7b8c3bcf03727e31e1a6bedf4d1846">AVVorbisParseContext</a> *s, const uint8_t *buf, int buf_size, int *flags)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the duration for a Vorbis packet. <a href="#a1e1b41858faedc564fc7a01b0eb910d9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="vorbis__parser_8h.html#a38e589e502d8e826a20de786212de7dd">av_vorbis_parse_frame</a> (<a class="el" href="vorbis__parser_8h.html#afe7b8c3bcf03727e31e1a6bedf4d1846">AVVorbisParseContext</a> *s, const uint8_t *buf, int buf_size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the duration for a Vorbis packet. <a href="#a38e589e502d8e826a20de786212de7dd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="vorbis__parser_8h.html#aed1dc9b8a89052c3203469e59b390a92">av_vorbis_parse_reset</a> (<a class="el" href="vorbis__parser_8h.html#afe7b8c3bcf03727e31e1a6bedf4d1846">AVVorbisParseContext</a> *s)</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A public API for Vorbis parsing. </p>
<p>Determines the duration for each packet. </p>
<p>Definition in file <a class="el" href="vorbis__parser_8h_source.html">vorbis_parser.h</a>.</p>
</div><hr/><h2>Define Documentation</h2>
<a class="anchor" id="a9205506ccac8f073592f93efa841dd29"></a><!-- doxytag: member="vorbis_parser.h::VORBIS_FLAG_HEADER" ref="a9205506ccac8f073592f93efa841dd29" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define <a class="el" href="vorbis__parser_8h.html#a9205506ccac8f073592f93efa841dd29">VORBIS_FLAG_HEADER</a>   0x00000001</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="vorbis__parser_8h_source.html#l00048">48</a> of file <a class="el" href="vorbis__parser_8h_source.html">vorbis_parser.h</a>.</p>
</div>
</div>
<a class="anchor" id="a837f7868aa92752a2727f6b66d9cf7ea"></a><!-- doxytag: member="vorbis_parser.h::VORBIS_FLAG_COMMENT" ref="a837f7868aa92752a2727f6b66d9cf7ea" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define <a class="el" href="vorbis__parser_8h.html#a837f7868aa92752a2727f6b66d9cf7ea">VORBIS_FLAG_COMMENT</a>   0x00000002</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="vorbis__parser_8h_source.html#l00049">49</a> of file <a class="el" href="vorbis__parser_8h_source.html">vorbis_parser.h</a>.</p>
</div>
</div>
<a class="anchor" id="a03a79f9bda327495ba1a9ad16574c583"></a><!-- doxytag: member="vorbis_parser.h::VORBIS_FLAG_SETUP" ref="a03a79f9bda327495ba1a9ad16574c583" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define <a class="el" href="vorbis__parser_8h.html#a03a79f9bda327495ba1a9ad16574c583">VORBIS_FLAG_SETUP</a>   0x00000004</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="vorbis__parser_8h_source.html#l00050">50</a> of file <a class="el" href="vorbis__parser_8h_source.html">vorbis_parser.h</a>.</p>
</div>
</div>
<hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="afe7b8c3bcf03727e31e1a6bedf4d1846"></a><!-- doxytag: member="vorbis_parser.h::AVVorbisParseContext" ref="afe7b8c3bcf03727e31e1a6bedf4d1846" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="vorbis__parser_8h.html#afe7b8c3bcf03727e31e1a6bedf4d1846">AVVorbisParseContext</a> <a class="el" href="vorbis__parser_8h.html#afe7b8c3bcf03727e31e1a6bedf4d1846">AVVorbisParseContext</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="vorbis__parser_8h_source.html#l00032">32</a> of file <a class="el" href="vorbis__parser_8h_source.html">vorbis_parser.h</a>.</p>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ae9124f78020f66109fd657ab248d0eee"></a><!-- doxytag: member="vorbis_parser.h::av_vorbis_parse_init" ref="ae9124f78020f66109fd657ab248d0eee" args="(const uint8_t *extradata, int extradata_size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="vorbis__parser_8h.html#afe7b8c3bcf03727e31e1a6bedf4d1846">AVVorbisParseContext</a>* <a class="el" href="vorbis__parser_8h.html#ae9124f78020f66109fd657ab248d0eee">av_vorbis_parse_init</a> </td>
<td>(</td>
<td class="paramtype">const uint8_t * </td>
<td class="paramname"><em>extradata</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>extradata_size</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Allocate and initialize the Vorbis parser using headers in the extradata. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">avctx</td><td>codec context </td></tr>
<tr><td class="paramname">s</td><td>Vorbis parser context </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a09d3132681826153f26ff5a9ee36a30d"></a><!-- doxytag: member="vorbis_parser.h::av_vorbis_parse_free" ref="a09d3132681826153f26ff5a9ee36a30d" args="(AVVorbisParseContext **s)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="vorbis__parser_8h.html#a09d3132681826153f26ff5a9ee36a30d">av_vorbis_parse_free</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="vorbis__parser_8h.html#afe7b8c3bcf03727e31e1a6bedf4d1846">AVVorbisParseContext</a> ** </td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Free the parser and everything associated with it. </p>
</div>
</div>
<a class="anchor" id="a1e1b41858faedc564fc7a01b0eb910d9"></a><!-- doxytag: member="vorbis_parser.h::av_vorbis_parse_frame_flags" ref="a1e1b41858faedc564fc7a01b0eb910d9" args="(AVVorbisParseContext *s, const uint8_t *buf, int buf_size, int *flags)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="vorbis__parser_8h.html#a1e1b41858faedc564fc7a01b0eb910d9">av_vorbis_parse_frame_flags</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="vorbis__parser_8h.html#afe7b8c3bcf03727e31e1a6bedf4d1846">AVVorbisParseContext</a> * </td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const uint8_t * </td>
<td class="paramname"><em>buf</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">int * </td>
<td class="paramname"><em>flags</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the duration for a Vorbis packet. </p>
<p>If <code>flags</code> is <code>NULL</code>, special frames are considered invalid.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td>Vorbis parser context </td></tr>
<tr><td class="paramname">buf</td><td>buffer containing a Vorbis frame </td></tr>
<tr><td class="paramname">buf_size</td><td>size of the buffer </td></tr>
<tr><td class="paramname">flags</td><td>flags for special frames </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a38e589e502d8e826a20de786212de7dd"></a><!-- doxytag: member="vorbis_parser.h::av_vorbis_parse_frame" ref="a38e589e502d8e826a20de786212de7dd" args="(AVVorbisParseContext *s, const uint8_t *buf, int buf_size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="vorbis__parser_8h.html#a38e589e502d8e826a20de786212de7dd">av_vorbis_parse_frame</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="vorbis__parser_8h.html#afe7b8c3bcf03727e31e1a6bedf4d1846">AVVorbisParseContext</a> * </td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const uint8_t * </td>
<td class="paramname"><em>buf</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></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the duration for a Vorbis packet. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td>Vorbis parser context </td></tr>
<tr><td class="paramname">buf</td><td>buffer containing a Vorbis frame </td></tr>
<tr><td class="paramname">buf_size</td><td>size of the buffer </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aed1dc9b8a89052c3203469e59b390a92"></a><!-- doxytag: member="vorbis_parser.h::av_vorbis_parse_reset" ref="aed1dc9b8a89052c3203469e59b390a92" args="(AVVorbisParseContext *s)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="vorbis__parser_8h.html#aed1dc9b8a89052c3203469e59b390a92">av_vorbis_parse_reset</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="vorbis__parser_8h.html#afe7b8c3bcf03727e31e1a6bedf4d1846">AVVorbisParseContext</a> * </td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</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>