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: Audio sample formats</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><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>
<div class="header">
<div class="summary">
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Audio sample formats</div> </div>
<div class="ingroups"><a class="el" href="group__lavu__audio.html">Audio related</a></div></div><!--header-->
<div class="contents">
<p>Audio sample format enumeration and related convenience functions.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lavu__sampfmts.html#gaf9a51ca15301871723577c730b5865c5">AVSampleFormat</a> { <br/>
  <a class="el" href="group__lavu__sampfmts.html#ggaf9a51ca15301871723577c730b5865c5ac5d4bb5b0fb0dc7316fb3c7a73029912">AV_SAMPLE_FMT_NONE</a> = -1,
<a class="el" href="group__lavu__sampfmts.html#ggaf9a51ca15301871723577c730b5865c5adf0f66f21492f8fd5db6debb8b3f932a">AV_SAMPLE_FMT_U8</a>,
<a class="el" href="group__lavu__sampfmts.html#ggaf9a51ca15301871723577c730b5865c5aea6132df57aebc3f76e10665395c46af">AV_SAMPLE_FMT_S16</a>,
<a class="el" href="group__lavu__sampfmts.html#ggaf9a51ca15301871723577c730b5865c5ab7ae6bb6718c07cd316778783a57a63b">AV_SAMPLE_FMT_S32</a>,
<br/>
  <a class="el" href="group__lavu__sampfmts.html#ggaf9a51ca15301871723577c730b5865c5a5251d62cc3c7f18e56bc8e0c48a27903">AV_SAMPLE_FMT_FLT</a>,
<a class="el" href="group__lavu__sampfmts.html#ggaf9a51ca15301871723577c730b5865c5ae35a2a6a7593723d9fe4bcefb2876606">AV_SAMPLE_FMT_DBL</a>,
<a class="el" href="group__lavu__sampfmts.html#ggaf9a51ca15301871723577c730b5865c5a6ab0109a23af37e29ea3a7282c00d311">AV_SAMPLE_FMT_U8P</a>,
<a class="el" href="group__lavu__sampfmts.html#ggaf9a51ca15301871723577c730b5865c5a35eaaad9da207aa4e63fa02fd67fae68">AV_SAMPLE_FMT_S16P</a>,
<br/>
  <a class="el" href="group__lavu__sampfmts.html#ggaf9a51ca15301871723577c730b5865c5aa215d25dfbf927aa362c837fed4b15a8">AV_SAMPLE_FMT_S32P</a>,
<a class="el" href="group__lavu__sampfmts.html#ggaf9a51ca15301871723577c730b5865c5a2d21c520e4ab21100b6440ec2d81ba1b">AV_SAMPLE_FMT_FLTP</a>,
<a class="el" href="group__lavu__sampfmts.html#ggaf9a51ca15301871723577c730b5865c5adf1348382a7c7473a425e05530989ae5">AV_SAMPLE_FMT_DBLP</a>,
<a class="el" href="group__lavu__sampfmts.html#ggaf9a51ca15301871723577c730b5865c5a8c2ef4962274b33e2828fb9629c104fd">AV_SAMPLE_FMT_NB</a>
<br/>
}</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Audio sample formats. <a href="group__lavu__sampfmts.html#gaf9a51ca15301871723577c730b5865c5">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lavu__sampfmts.html#ga31b9d149b2de9821a65f4f5612970838">av_get_sample_fmt_name</a> (enum <a class="el" href="group__lavu__sampfmts.html#gaf9a51ca15301871723577c730b5865c5">AVSampleFormat</a> sample_fmt)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the name of sample_fmt, or NULL if sample_fmt is not recognized. <a href="#ga31b9d149b2de9821a65f4f5612970838"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum <a class="el" href="group__lavu__sampfmts.html#gaf9a51ca15301871723577c730b5865c5">AVSampleFormat</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lavu__sampfmts.html#ga655c989b749667468e5e839e26fe63db">av_get_sample_fmt</a> (const char *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a sample format corresponding to name, or AV_SAMPLE_FMT_NONE on error. <a href="#ga655c989b749667468e5e839e26fe63db"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum <a class="el" href="group__lavu__sampfmts.html#gaf9a51ca15301871723577c730b5865c5">AVSampleFormat</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lavu__sampfmts.html#ga8e66c3f813ea02afcaa56a8a964c749a">av_get_alt_sample_fmt</a> (enum <a class="el" href="group__lavu__sampfmts.html#gaf9a51ca15301871723577c730b5865c5">AVSampleFormat</a> sample_fmt, int planar)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the planar<->packed alternative form of the given sample format, or AV_SAMPLE_FMT_NONE on error. <a href="#ga8e66c3f813ea02afcaa56a8a964c749a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum <a class="el" href="group__lavu__sampfmts.html#gaf9a51ca15301871723577c730b5865c5">AVSampleFormat</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lavu__sampfmts.html#ga7817ec0eff4dc6fc0962f31e6d138bca">av_get_packed_sample_fmt</a> (enum <a class="el" href="group__lavu__sampfmts.html#gaf9a51ca15301871723577c730b5865c5">AVSampleFormat</a> sample_fmt)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the packed alternative form of the given sample format. <a href="#ga7817ec0eff4dc6fc0962f31e6d138bca"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">enum <a class="el" href="group__lavu__sampfmts.html#gaf9a51ca15301871723577c730b5865c5">AVSampleFormat</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lavu__sampfmts.html#ga82caf838259d95cc6c4fd87633bb0e19">av_get_planar_sample_fmt</a> (enum <a class="el" href="group__lavu__sampfmts.html#gaf9a51ca15301871723577c730b5865c5">AVSampleFormat</a> sample_fmt)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the planar alternative form of the given sample format. <a href="#ga82caf838259d95cc6c4fd87633bb0e19"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lavu__sampfmts.html#gabdc8c2172c33fe9d36cbedaf3c5f83bb">av_get_sample_fmt_string</a> (char *buf, int buf_size, enum <a class="el" href="group__lavu__sampfmts.html#gaf9a51ca15301871723577c730b5865c5">AVSampleFormat</a> sample_fmt)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Generate a string corresponding to the sample format with sample_fmt, or a header if sample_fmt is negative. <a href="#gabdc8c2172c33fe9d36cbedaf3c5f83bb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lavu__sampfmts.html#ga0c3c218e1dd570ad4917c69a35a6c77d">av_get_bytes_per_sample</a> (enum <a class="el" href="group__lavu__sampfmts.html#gaf9a51ca15301871723577c730b5865c5">AVSampleFormat</a> sample_fmt)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return number of bytes per sample. <a href="#ga0c3c218e1dd570ad4917c69a35a6c77d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lavu__sampfmts.html#ga06ba8a64dc4382c422789a5d0b6bf592">av_sample_fmt_is_planar</a> (enum <a class="el" href="group__lavu__sampfmts.html#gaf9a51ca15301871723577c730b5865c5">AVSampleFormat</a> sample_fmt)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if the sample format is planar. <a href="#ga06ba8a64dc4382c422789a5d0b6bf592"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__lavu__sampfmts.html#gaa7368bc4e3a366b688e81938ed55eb06">av_samples_get_buffer_size</a> (int *linesize, int nb_channels, int nb_samples, enum <a class="el" href="group__lavu__sampfmts.html#gaf9a51ca15301871723577c730b5865c5">AVSampleFormat</a> sample_fmt, int align)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the required buffer size for the given audio parameters. <a href="#gaa7368bc4e3a366b688e81938ed55eb06"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<p>Audio sample format enumeration and related convenience functions. </p>
<hr/><h2>Enumeration Type Documentation</h2>
<a class="anchor" id="gaf9a51ca15301871723577c730b5865c5"></a><!-- doxytag: member="samplefmt.h::AVSampleFormat" ref="gaf9a51ca15301871723577c730b5865c5" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__lavu__sampfmts.html#gaf9a51ca15301871723577c730b5865c5">AVSampleFormat</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Audio sample formats. </p>
<ul>
<li>The data described by the sample format is always in native-endian order. Sample values can be expressed by native C types, hence the lack of a signed 24-bit sample format even though it is a common raw audio data format.</li>
</ul>
<ul>
<li>The floating-point formats are based on full volume being in the range [-1.0, 1.0]. Any values outside this range are beyond full volume level.</li>
</ul>
<ul>
<li>The data layout as used in <a class="el" href="group__lavu__sampmanip.html#ga673254a62fa75dab3211caf17c73c6eb" title="Fill plane data pointers and linesize for samples with sample format sample_fmt.">av_samples_fill_arrays()</a> and elsewhere in FFmpeg (such as <a class="el" href="structAVFrame.html" title="This structure describes decoded (raw) audio or video data.">AVFrame</a> in libavcodec) is as follows:</li>
</ul>
<dl class="user"><dt><b></b></dt><dd>For planar sample formats, each audio channel is in a separate data plane, and linesize is the buffer size, in bytes, for a single plane. All data planes must be the same size. For packed sample formats, only the first data plane is used, and samples for each channel are interleaved. In this case, linesize is the buffer size, in bytes, for the 1 plane. </dd></dl>
<dl><dt><b>Enumerator: </b></dt><dd><table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" id="ggaf9a51ca15301871723577c730b5865c5ac5d4bb5b0fb0dc7316fb3c7a73029912"></a><!-- doxytag: member="AV_SAMPLE_FMT_NONE" ref="ggaf9a51ca15301871723577c730b5865c5ac5d4bb5b0fb0dc7316fb3c7a73029912" args="" -->AV_SAMPLE_FMT_NONE</em> </td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggaf9a51ca15301871723577c730b5865c5adf0f66f21492f8fd5db6debb8b3f932a"></a><!-- doxytag: member="AV_SAMPLE_FMT_U8" ref="ggaf9a51ca15301871723577c730b5865c5adf0f66f21492f8fd5db6debb8b3f932a" args="" -->AV_SAMPLE_FMT_U8</em> </td><td>
<p>unsigned 8 bits </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggaf9a51ca15301871723577c730b5865c5aea6132df57aebc3f76e10665395c46af"></a><!-- doxytag: member="AV_SAMPLE_FMT_S16" ref="ggaf9a51ca15301871723577c730b5865c5aea6132df57aebc3f76e10665395c46af" args="" -->AV_SAMPLE_FMT_S16</em> </td><td>
<p>signed 16 bits </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggaf9a51ca15301871723577c730b5865c5ab7ae6bb6718c07cd316778783a57a63b"></a><!-- doxytag: member="AV_SAMPLE_FMT_S32" ref="ggaf9a51ca15301871723577c730b5865c5ab7ae6bb6718c07cd316778783a57a63b" args="" -->AV_SAMPLE_FMT_S32</em> </td><td>
<p>signed 32 bits </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggaf9a51ca15301871723577c730b5865c5a5251d62cc3c7f18e56bc8e0c48a27903"></a><!-- doxytag: member="AV_SAMPLE_FMT_FLT" ref="ggaf9a51ca15301871723577c730b5865c5a5251d62cc3c7f18e56bc8e0c48a27903" args="" -->AV_SAMPLE_FMT_FLT</em> </td><td>
<p>float </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggaf9a51ca15301871723577c730b5865c5ae35a2a6a7593723d9fe4bcefb2876606"></a><!-- doxytag: member="AV_SAMPLE_FMT_DBL" ref="ggaf9a51ca15301871723577c730b5865c5ae35a2a6a7593723d9fe4bcefb2876606" args="" -->AV_SAMPLE_FMT_DBL</em> </td><td>
<p>double </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggaf9a51ca15301871723577c730b5865c5a6ab0109a23af37e29ea3a7282c00d311"></a><!-- doxytag: member="AV_SAMPLE_FMT_U8P" ref="ggaf9a51ca15301871723577c730b5865c5a6ab0109a23af37e29ea3a7282c00d311" args="" -->AV_SAMPLE_FMT_U8P</em> </td><td>
<p>unsigned 8 bits, planar </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggaf9a51ca15301871723577c730b5865c5a35eaaad9da207aa4e63fa02fd67fae68"></a><!-- doxytag: member="AV_SAMPLE_FMT_S16P" ref="ggaf9a51ca15301871723577c730b5865c5a35eaaad9da207aa4e63fa02fd67fae68" args="" -->AV_SAMPLE_FMT_S16P</em> </td><td>
<p>signed 16 bits, planar </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggaf9a51ca15301871723577c730b5865c5aa215d25dfbf927aa362c837fed4b15a8"></a><!-- doxytag: member="AV_SAMPLE_FMT_S32P" ref="ggaf9a51ca15301871723577c730b5865c5aa215d25dfbf927aa362c837fed4b15a8" args="" -->AV_SAMPLE_FMT_S32P</em> </td><td>
<p>signed 32 bits, planar </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggaf9a51ca15301871723577c730b5865c5a2d21c520e4ab21100b6440ec2d81ba1b"></a><!-- doxytag: member="AV_SAMPLE_FMT_FLTP" ref="ggaf9a51ca15301871723577c730b5865c5a2d21c520e4ab21100b6440ec2d81ba1b" args="" -->AV_SAMPLE_FMT_FLTP</em> </td><td>
<p>float, planar </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggaf9a51ca15301871723577c730b5865c5adf1348382a7c7473a425e05530989ae5"></a><!-- doxytag: member="AV_SAMPLE_FMT_DBLP" ref="ggaf9a51ca15301871723577c730b5865c5adf1348382a7c7473a425e05530989ae5" args="" -->AV_SAMPLE_FMT_DBLP</em> </td><td>
<p>double, planar </p>
</td></tr>
<tr><td valign="top"><em><a class="anchor" id="ggaf9a51ca15301871723577c730b5865c5a8c2ef4962274b33e2828fb9629c104fd"></a><!-- doxytag: member="AV_SAMPLE_FMT_NB" ref="ggaf9a51ca15301871723577c730b5865c5a8c2ef4962274b33e2828fb9629c104fd" args="" -->AV_SAMPLE_FMT_NB</em> </td><td>
<p>Number of sample formats. DO NOT USE if linking dynamically. </p>
</td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="samplefmt_8h_source.html#l00059">59</a> of file <a class="el" href="samplefmt_8h_source.html">samplefmt.h</a>.</p>
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga31b9d149b2de9821a65f4f5612970838"></a><!-- doxytag: member="samplefmt.h::av_get_sample_fmt_name" ref="ga31b9d149b2de9821a65f4f5612970838" args="(enum AVSampleFormat sample_fmt)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* <a class="el" href="group__lavu__sampfmts.html#ga31b9d149b2de9821a65f4f5612970838">av_get_sample_fmt_name</a> </td>
<td>(</td>
<td class="paramtype">enum <a class="el" href="group__lavu__sampfmts.html#gaf9a51ca15301871723577c730b5865c5">AVSampleFormat</a> </td>
<td class="paramname"><em>sample_fmt</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the name of sample_fmt, or NULL if sample_fmt is not recognized. </p>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="decoding_encoding_8c-example.html#a22">decoding_encoding.c</a>, <a class="el" href="demuxing_decoding_8c-example.html#a73">demuxing_decoding.c</a>, <a class="el" href="filter_audio_8c-example.html#a14">filter_audio.c</a>, <a class="el" href="filtering_audio_8c-example.html#a42">filtering_audio.c</a>, <a class="el" href="resampling_audio_8c-example.html#a8">resampling_audio.c</a>, and <a class="el" href="transcoding_8c-example.html#a77">transcoding.c</a>.</dd>
</dl>
<p>Referenced by <a class="el" href="decoding__encoding_8c_source.html#l00103">audio_encode_example()</a>, <a class="el" href="demuxing__decoding_8c_source.html#l00197">get_format_from_sample_fmt()</a>, <a class="el" href="transcoding_8c_source.html#l00187">init_filter()</a>, <a class="el" href="filter__audio_8c_source.html#l00062">init_filter_graph()</a>, <a class="el" href="filtering__audio_8c_source.html#l00085">init_filters()</a>, and <a class="el" href="demuxing__decoding_8c_source.html#l00226">main()</a>.</p>
</div>
</div>
<a class="anchor" id="ga655c989b749667468e5e839e26fe63db"></a><!-- doxytag: member="samplefmt.h::av_get_sample_fmt" ref="ga655c989b749667468e5e839e26fe63db" args="(const char *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__lavu__sampfmts.html#gaf9a51ca15301871723577c730b5865c5">AVSampleFormat</a> <a class="el" href="group__lavu__sampfmts.html#ga655c989b749667468e5e839e26fe63db">av_get_sample_fmt</a> </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return a sample format corresponding to name, or AV_SAMPLE_FMT_NONE on error. </p>
</div>
</div>
<a class="anchor" id="ga8e66c3f813ea02afcaa56a8a964c749a"></a><!-- doxytag: member="samplefmt.h::av_get_alt_sample_fmt" ref="ga8e66c3f813ea02afcaa56a8a964c749a" args="(enum AVSampleFormat sample_fmt, int planar)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__lavu__sampfmts.html#gaf9a51ca15301871723577c730b5865c5">AVSampleFormat</a> <a class="el" href="group__lavu__sampfmts.html#ga8e66c3f813ea02afcaa56a8a964c749a">av_get_alt_sample_fmt</a> </td>
<td>(</td>
<td class="paramtype">enum <a class="el" href="group__lavu__sampfmts.html#gaf9a51ca15301871723577c730b5865c5">AVSampleFormat</a> </td>
<td class="paramname"><em>sample_fmt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>planar</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the planar<->packed alternative form of the given sample format, or AV_SAMPLE_FMT_NONE on error. </p>
<p>If the passed sample_fmt is already in the requested planar/packed format, the format returned is the same as the input. </p>
</div>
</div>
<a class="anchor" id="ga7817ec0eff4dc6fc0962f31e6d138bca"></a><!-- doxytag: member="samplefmt.h::av_get_packed_sample_fmt" ref="ga7817ec0eff4dc6fc0962f31e6d138bca" args="(enum AVSampleFormat sample_fmt)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__lavu__sampfmts.html#gaf9a51ca15301871723577c730b5865c5">AVSampleFormat</a> <a class="el" href="group__lavu__sampfmts.html#ga7817ec0eff4dc6fc0962f31e6d138bca">av_get_packed_sample_fmt</a> </td>
<td>(</td>
<td class="paramtype">enum <a class="el" href="group__lavu__sampfmts.html#gaf9a51ca15301871723577c730b5865c5">AVSampleFormat</a> </td>
<td class="paramname"><em>sample_fmt</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the packed alternative form of the given sample format. </p>
<p>If the passed sample_fmt is already in packed format, the format returned is the same as the input.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the packed alternative form of the given sample format or AV_SAMPLE_FMT_NONE on error. </dd></dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="demuxing_decoding_8c-example.html#a93">demuxing_decoding.c</a>.</dd>
</dl>
<p>Referenced by <a class="el" href="demuxing__decoding_8c_source.html#l00226">main()</a>.</p>
</div>
</div>
<a class="anchor" id="ga82caf838259d95cc6c4fd87633bb0e19"></a><!-- doxytag: member="samplefmt.h::av_get_planar_sample_fmt" ref="ga82caf838259d95cc6c4fd87633bb0e19" args="(enum AVSampleFormat sample_fmt)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__lavu__sampfmts.html#gaf9a51ca15301871723577c730b5865c5">AVSampleFormat</a> <a class="el" href="group__lavu__sampfmts.html#ga82caf838259d95cc6c4fd87633bb0e19">av_get_planar_sample_fmt</a> </td>
<td>(</td>
<td class="paramtype">enum <a class="el" href="group__lavu__sampfmts.html#gaf9a51ca15301871723577c730b5865c5">AVSampleFormat</a> </td>
<td class="paramname"><em>sample_fmt</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the planar alternative form of the given sample format. </p>
<p>If the passed sample_fmt is already in planar format, the format returned is the same as the input.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>the planar alternative form of the given sample format or AV_SAMPLE_FMT_NONE on error. </dd></dl>
</div>
</div>
<a class="anchor" id="gabdc8c2172c33fe9d36cbedaf3c5f83bb"></a><!-- doxytag: member="samplefmt.h::av_get_sample_fmt_string" ref="gabdc8c2172c33fe9d36cbedaf3c5f83bb" args="(char *buf, int buf_size, enum AVSampleFormat sample_fmt)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* <a class="el" href="group__lavu__sampfmts.html#gabdc8c2172c33fe9d36cbedaf3c5f83bb">av_get_sample_fmt_string</a> </td>
<td>(</td>
<td class="paramtype">char * </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">enum <a class="el" href="group__lavu__sampfmts.html#gaf9a51ca15301871723577c730b5865c5">AVSampleFormat</a> </td>
<td class="paramname"><em>sample_fmt</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Generate a string corresponding to the sample format with sample_fmt, or a header if sample_fmt is negative. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">buf</td><td>the buffer where to write the string </td></tr>
<tr><td class="paramname">buf_size</td><td>the size of buf </td></tr>
<tr><td class="paramname">sample_fmt</td><td>the number of the sample format to print the corresponding info string, or a negative value to print the corresponding header. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>the pointer to the filled buffer or NULL if sample_fmt is unknown or in case of other errors </dd></dl>
</div>
</div>
<a class="anchor" id="ga0c3c218e1dd570ad4917c69a35a6c77d"></a><!-- doxytag: member="samplefmt.h::av_get_bytes_per_sample" ref="ga0c3c218e1dd570ad4917c69a35a6c77d" args="(enum AVSampleFormat sample_fmt)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="group__lavu__sampfmts.html#ga0c3c218e1dd570ad4917c69a35a6c77d">av_get_bytes_per_sample</a> </td>
<td>(</td>
<td class="paramtype">enum <a class="el" href="group__lavu__sampfmts.html#gaf9a51ca15301871723577c730b5865c5">AVSampleFormat</a> </td>
<td class="paramname"><em>sample_fmt</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return number of bytes per sample. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">sample_fmt</td><td>the sample format </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>number of bytes per sample or zero if unknown for the given sample format </dd></dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="decoding_encoding_8c-example.html#a49">decoding_encoding.c</a>, <a class="el" href="demuxing_decoding_8c-example.html#a50">demuxing_decoding.c</a>, and <a class="el" href="filter_audio_8c-example.html#a39">filter_audio.c</a>.</dd>
</dl>
<p>Referenced by <a class="el" href="decoding__encoding_8c_source.html#l00242">audio_decode_example()</a>, <a class="el" href="demuxing__decoding_8c_source.html#l00070">decode_packet()</a>, and <a class="el" href="filter__audio_8c_source.html#l00215">process_output()</a>.</p>
</div>
</div>
<a class="anchor" id="ga06ba8a64dc4382c422789a5d0b6bf592"></a><!-- doxytag: member="samplefmt.h::av_sample_fmt_is_planar" ref="ga06ba8a64dc4382c422789a5d0b6bf592" args="(enum AVSampleFormat sample_fmt)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="group__lavu__sampfmts.html#ga06ba8a64dc4382c422789a5d0b6bf592">av_sample_fmt_is_planar</a> </td>
<td>(</td>
<td class="paramtype">enum <a class="el" href="group__lavu__sampfmts.html#gaf9a51ca15301871723577c730b5865c5">AVSampleFormat</a> </td>
<td class="paramname"><em>sample_fmt</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Check if the sample format is planar. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">sample_fmt</td><td>the sample format to inspect </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>1 if the sample format is planar, 0 if it is interleaved </dd></dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="demuxing_decoding_8c-example.html#a92">demuxing_decoding.c</a>, and <a class="el" href="filter_audio_8c-example.html#a35">filter_audio.c</a>.</dd>
</dl>
<p>Referenced by <a class="el" href="demuxing__decoding_8c_source.html#l00226">main()</a>, and <a class="el" href="filter__audio_8c_source.html#l00215">process_output()</a>.</p>
</div>
</div>
<a class="anchor" id="gaa7368bc4e3a366b688e81938ed55eb06"></a><!-- doxytag: member="samplefmt.h::av_samples_get_buffer_size" ref="gaa7368bc4e3a366b688e81938ed55eb06" args="(int *linesize, int nb_channels, int nb_samples, enum AVSampleFormat sample_fmt, int align)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="group__lavu__sampfmts.html#gaa7368bc4e3a366b688e81938ed55eb06">av_samples_get_buffer_size</a> </td>
<td>(</td>
<td class="paramtype">int * </td>
<td class="paramname"><em>linesize</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>nb_channels</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>nb_samples</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">enum <a class="el" href="group__lavu__sampfmts.html#gaf9a51ca15301871723577c730b5865c5">AVSampleFormat</a> </td>
<td class="paramname"><em>sample_fmt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>align</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the required buffer size for the given audio parameters. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">linesize</td><td>calculated linesize, may be NULL </td></tr>
<tr><td class="paramdir"></td><td class="paramname">nb_channels</td><td>the number of channels </td></tr>
<tr><td class="paramdir"></td><td class="paramname">nb_samples</td><td>the number of samples in a single channel </td></tr>
<tr><td class="paramdir"></td><td class="paramname">sample_fmt</td><td>the sample format </td></tr>
<tr><td class="paramdir"></td><td class="paramname">align</td><td>buffer size alignment (0 = default, 1 = no alignment) </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>required buffer size, or negative error code on failure </dd></dl>
<dl><dt><b>Examples: </b></dt><dd><a class="el" href="decoding_encoding_8c-example.html#a32">decoding_encoding.c</a>, and <a class="el" href="resampling_audio_8c-example.html#a26">resampling_audio.c</a>.</dd>
</dl>
<p>Referenced by <a class="el" href="decoding__encoding_8c_source.html#l00103">audio_encode_example()</a>, and <a class="el" href="resampling__audio_8c_source.html#l00081">main()</a>.</p>
</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>