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/samplefmt.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/samplefmt.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="samplefmt_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"> * This file is part of FFmpeg.</span>
<a name="l00003"></a>00003 <span class="comment"> *</span>
<a name="l00004"></a>00004 <span class="comment"> * FFmpeg is free software; you can redistribute it and/or</span>
<a name="l00005"></a>00005 <span class="comment"> * modify it under the terms of the GNU Lesser General Public</span>
<a name="l00006"></a>00006 <span class="comment"> * License as published by the Free Software Foundation; either</span>
<a name="l00007"></a>00007 <span class="comment"> * version 2.1 of the License, or (at your option) any later version.</span>
<a name="l00008"></a>00008 <span class="comment"> *</span>
<a name="l00009"></a>00009 <span class="comment"> * FFmpeg is distributed in the hope that it will be useful,</span>
<a name="l00010"></a>00010 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00011"></a>00011 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span>
<a name="l00012"></a>00012 <span class="comment"> * Lesser General Public License for more details.</span>
<a name="l00013"></a>00013 <span class="comment"> *</span>
<a name="l00014"></a>00014 <span class="comment"> * You should have received a copy of the GNU Lesser General Public</span>
<a name="l00015"></a>00015 <span class="comment"> * License along with FFmpeg; if not, write to the Free Software</span>
<a name="l00016"></a>00016 <span class="comment"> * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA</span>
<a name="l00017"></a>00017 <span class="comment"> */</span>
<a name="l00018"></a>00018
<a name="l00019"></a>00019 <span class="preprocessor">#ifndef AVUTIL_SAMPLEFMT_H</span>
<a name="l00020"></a>00020 <span class="preprocessor"></span><span class="preprocessor">#define AVUTIL_SAMPLEFMT_H</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span>
<a name="l00022"></a>00022 <span class="preprocessor">#include <stdint.h></span>
<a name="l00023"></a>00023
<a name="l00024"></a>00024 <span class="preprocessor">#include "<a class="code" href="avutil_8h.html" title="external API header">avutil.h</a>"</span>
<a name="l00025"></a>00025 <span class="preprocessor">#include "<a class="code" href="attributes_8h.html" title="Macro definitions for various function/variable attributes.">attributes.h</a>"</span>
<a name="l00026"></a>00026 <span class="comment"></span>
<a name="l00027"></a>00027 <span class="comment">/**</span>
<a name="l00028"></a>00028 <span class="comment"> * @addtogroup lavu_audio</span>
<a name="l00029"></a>00029 <span class="comment"> * @{</span>
<a name="l00030"></a>00030 <span class="comment"> *</span>
<a name="l00031"></a>00031 <span class="comment"> * @defgroup lavu_sampfmts Audio sample formats</span>
<a name="l00032"></a>00032 <span class="comment"> *</span>
<a name="l00033"></a>00033 <span class="comment"> * Audio sample format enumeration and related convenience functions.</span>
<a name="l00034"></a>00034 <span class="comment"> * @{</span>
<a name="l00035"></a>00035 <span class="comment"> *</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">/**</span>
<a name="l00039"></a>00039 <span class="comment"> * Audio sample formats</span>
<a name="l00040"></a>00040 <span class="comment"> *</span>
<a name="l00041"></a>00041 <span class="comment"> * - The data described by the sample format is always in native-endian order.</span>
<a name="l00042"></a>00042 <span class="comment"> * Sample values can be expressed by native C types, hence the lack of a signed</span>
<a name="l00043"></a>00043 <span class="comment"> * 24-bit sample format even though it is a common raw audio data format.</span>
<a name="l00044"></a>00044 <span class="comment"> *</span>
<a name="l00045"></a>00045 <span class="comment"> * - The floating-point formats are based on full volume being in the range</span>
<a name="l00046"></a>00046 <span class="comment"> * [-1.0, 1.0]. Any values outside this range are beyond full volume level.</span>
<a name="l00047"></a>00047 <span class="comment"> *</span>
<a name="l00048"></a>00048 <span class="comment"> * - The data layout as used in av_samples_fill_arrays() and elsewhere in FFmpeg</span>
<a name="l00049"></a>00049 <span class="comment"> * (such as AVFrame in libavcodec) is as follows:</span>
<a name="l00050"></a>00050 <span class="comment"> *</span>
<a name="l00051"></a>00051 <span class="comment"> * @par</span>
<a name="l00052"></a>00052 <span class="comment"> * For planar sample formats, each audio channel is in a separate data plane,</span>
<a name="l00053"></a>00053 <span class="comment"> * and linesize is the buffer size, in bytes, for a single plane. All data</span>
<a name="l00054"></a>00054 <span class="comment"> * planes must be the same size. For packed sample formats, only the first data</span>
<a name="l00055"></a>00055 <span class="comment"> * plane is used, and samples for each channel are interleaved. In this case,</span>
<a name="l00056"></a>00056 <span class="comment"> * linesize is the buffer size, in bytes, for the 1 plane.</span>
<a name="l00057"></a>00057 <span class="comment"> *</span>
<a name="l00058"></a>00058 <span class="comment"> */</span>
<a name="l00059"></a><a class="code" href="group__lavu__sampfmts.html#gaf9a51ca15301871723577c730b5865c5">00059</a> <span class="keyword">enum</span> <a class="code" href="group__lavu__sampfmts.html#gaf9a51ca15301871723577c730b5865c5" title="Audio sample formats.">AVSampleFormat</a> {
<a name="l00060"></a><a class="code" href="group__lavu__sampfmts.html#ggaf9a51ca15301871723577c730b5865c5ac5d4bb5b0fb0dc7316fb3c7a73029912">00060</a> <a class="code" href="group__lavu__sampfmts.html#ggaf9a51ca15301871723577c730b5865c5ac5d4bb5b0fb0dc7316fb3c7a73029912">AV_SAMPLE_FMT_NONE</a> = -1,
<a name="l00061"></a><a class="code" href="group__lavu__sampfmts.html#ggaf9a51ca15301871723577c730b5865c5adf0f66f21492f8fd5db6debb8b3f932a">00061</a> <a class="code" href="group__lavu__sampfmts.html#ggaf9a51ca15301871723577c730b5865c5adf0f66f21492f8fd5db6debb8b3f932a" title="unsigned 8 bits">AV_SAMPLE_FMT_U8</a>, <span class="comment">///< unsigned 8 bits</span>
<a name="l00062"></a><a class="code" href="group__lavu__sampfmts.html#ggaf9a51ca15301871723577c730b5865c5aea6132df57aebc3f76e10665395c46af">00062</a> <span class="comment"></span> <a class="code" href="group__lavu__sampfmts.html#ggaf9a51ca15301871723577c730b5865c5aea6132df57aebc3f76e10665395c46af" title="signed 16 bits">AV_SAMPLE_FMT_S16</a>, <span class="comment">///< signed 16 bits</span>
<a name="l00063"></a><a class="code" href="group__lavu__sampfmts.html#ggaf9a51ca15301871723577c730b5865c5ab7ae6bb6718c07cd316778783a57a63b">00063</a> <span class="comment"></span> <a class="code" href="group__lavu__sampfmts.html#ggaf9a51ca15301871723577c730b5865c5ab7ae6bb6718c07cd316778783a57a63b" title="signed 32 bits">AV_SAMPLE_FMT_S32</a>, <span class="comment">///< signed 32 bits</span>
<a name="l00064"></a><a class="code" href="group__lavu__sampfmts.html#ggaf9a51ca15301871723577c730b5865c5a5251d62cc3c7f18e56bc8e0c48a27903">00064</a> <span class="comment"></span> <a class="code" href="group__lavu__sampfmts.html#ggaf9a51ca15301871723577c730b5865c5a5251d62cc3c7f18e56bc8e0c48a27903" title="float">AV_SAMPLE_FMT_FLT</a>, <span class="comment">///< float</span>
<a name="l00065"></a><a class="code" href="group__lavu__sampfmts.html#ggaf9a51ca15301871723577c730b5865c5ae35a2a6a7593723d9fe4bcefb2876606">00065</a> <span class="comment"></span> <a class="code" href="group__lavu__sampfmts.html#ggaf9a51ca15301871723577c730b5865c5ae35a2a6a7593723d9fe4bcefb2876606" title="double">AV_SAMPLE_FMT_DBL</a>, <span class="comment">///< double</span>
<a name="l00066"></a>00066 <span class="comment"></span>
<a name="l00067"></a><a class="code" href="group__lavu__sampfmts.html#ggaf9a51ca15301871723577c730b5865c5a6ab0109a23af37e29ea3a7282c00d311">00067</a> <a class="code" href="group__lavu__sampfmts.html#ggaf9a51ca15301871723577c730b5865c5a6ab0109a23af37e29ea3a7282c00d311" title="unsigned 8 bits, planar">AV_SAMPLE_FMT_U8P</a>, <span class="comment">///< unsigned 8 bits, planar</span>
<a name="l00068"></a><a class="code" href="group__lavu__sampfmts.html#ggaf9a51ca15301871723577c730b5865c5a35eaaad9da207aa4e63fa02fd67fae68">00068</a> <span class="comment"></span> <a class="code" href="group__lavu__sampfmts.html#ggaf9a51ca15301871723577c730b5865c5a35eaaad9da207aa4e63fa02fd67fae68" title="signed 16 bits, planar">AV_SAMPLE_FMT_S16P</a>, <span class="comment">///< signed 16 bits, planar</span>
<a name="l00069"></a><a class="code" href="group__lavu__sampfmts.html#ggaf9a51ca15301871723577c730b5865c5aa215d25dfbf927aa362c837fed4b15a8">00069</a> <span class="comment"></span> <a class="code" href="group__lavu__sampfmts.html#ggaf9a51ca15301871723577c730b5865c5aa215d25dfbf927aa362c837fed4b15a8" title="signed 32 bits, planar">AV_SAMPLE_FMT_S32P</a>, <span class="comment">///< signed 32 bits, planar</span>
<a name="l00070"></a><a class="code" href="group__lavu__sampfmts.html#ggaf9a51ca15301871723577c730b5865c5a2d21c520e4ab21100b6440ec2d81ba1b">00070</a> <span class="comment"></span> <a class="code" href="group__lavu__sampfmts.html#ggaf9a51ca15301871723577c730b5865c5a2d21c520e4ab21100b6440ec2d81ba1b" title="float, planar">AV_SAMPLE_FMT_FLTP</a>, <span class="comment">///< float, planar</span>
<a name="l00071"></a><a class="code" href="group__lavu__sampfmts.html#ggaf9a51ca15301871723577c730b5865c5adf1348382a7c7473a425e05530989ae5">00071</a> <span class="comment"></span> <a class="code" href="group__lavu__sampfmts.html#ggaf9a51ca15301871723577c730b5865c5adf1348382a7c7473a425e05530989ae5" title="double, planar">AV_SAMPLE_FMT_DBLP</a>, <span class="comment">///< double, planar</span>
<a name="l00072"></a>00072 <span class="comment"></span>
<a name="l00073"></a><a class="code" href="group__lavu__sampfmts.html#ggaf9a51ca15301871723577c730b5865c5a8c2ef4962274b33e2828fb9629c104fd">00073</a> <a class="code" href="group__lavu__sampfmts.html#ggaf9a51ca15301871723577c730b5865c5a8c2ef4962274b33e2828fb9629c104fd" title="Number of sample formats. DO NOT USE if linking dynamically.">AV_SAMPLE_FMT_NB</a> <span class="comment">///< Number of sample formats. DO NOT USE if linking dynamically</span>
<a name="l00074"></a>00074 <span class="comment"></span>};
<a name="l00075"></a>00075 <span class="comment"></span>
<a name="l00076"></a>00076 <span class="comment">/**</span>
<a name="l00077"></a>00077 <span class="comment"> * Return the name of sample_fmt, or NULL if sample_fmt is not</span>
<a name="l00078"></a>00078 <span class="comment"> * recognized.</span>
<a name="l00079"></a>00079 <span class="comment"> */</span>
<a name="l00080"></a>00080 <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="group__lavu__sampfmts.html#ga31b9d149b2de9821a65f4f5612970838" title="Return the name of sample_fmt, or NULL if sample_fmt is not recognized.">av_get_sample_fmt_name</a>(<span class="keyword">enum</span> <a class="code" href="group__lavu__sampfmts.html#gaf9a51ca15301871723577c730b5865c5" title="Audio sample formats.">AVSampleFormat</a> sample_fmt);
<a name="l00081"></a>00081 <span class="comment"></span>
<a name="l00082"></a>00082 <span class="comment">/**</span>
<a name="l00083"></a>00083 <span class="comment"> * Return a sample format corresponding to name, or AV_SAMPLE_FMT_NONE</span>
<a name="l00084"></a>00084 <span class="comment"> * on error.</span>
<a name="l00085"></a>00085 <span class="comment"> */</span>
<a name="l00086"></a>00086 <span class="keyword">enum</span> <a class="code" href="group__lavu__sampfmts.html#gaf9a51ca15301871723577c730b5865c5" title="Audio sample formats.">AVSampleFormat</a> <a class="code" href="group__lavu__sampfmts.html#ga655c989b749667468e5e839e26fe63db" title="Return a sample format corresponding to name, or AV_SAMPLE_FMT_NONE on error.">av_get_sample_fmt</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *name);
<a name="l00087"></a>00087 <span class="comment"></span>
<a name="l00088"></a>00088 <span class="comment">/**</span>
<a name="l00089"></a>00089 <span class="comment"> * Return the planar<->packed alternative form of the given sample format, or</span>
<a name="l00090"></a>00090 <span class="comment"> * AV_SAMPLE_FMT_NONE on error. If the passed sample_fmt is already in the</span>
<a name="l00091"></a>00091 <span class="comment"> * requested planar/packed format, the format returned is the same as the</span>
<a name="l00092"></a>00092 <span class="comment"> * input.</span>
<a name="l00093"></a>00093 <span class="comment"> */</span>
<a name="l00094"></a>00094 <span class="keyword">enum</span> <a class="code" href="group__lavu__sampfmts.html#gaf9a51ca15301871723577c730b5865c5" title="Audio sample formats.">AVSampleFormat</a> <a class="code" href="group__lavu__sampfmts.html#ga8e66c3f813ea02afcaa56a8a964c749a" title="Return the planar<->packed alternative form of the given sample format, or AV_SAMPLE_FMT_NONE on erro...">av_get_alt_sample_fmt</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> planar);
<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"> * Get the packed alternative form of the given sample format.</span>
<a name="l00098"></a>00098 <span class="comment"> *</span>
<a name="l00099"></a>00099 <span class="comment"> * If the passed sample_fmt is already in packed format, the format returned is</span>
<a name="l00100"></a>00100 <span class="comment"> * the same as the input.</span>
<a name="l00101"></a>00101 <span class="comment"> *</span>
<a name="l00102"></a>00102 <span class="comment"> * @return the packed alternative form of the given sample format or</span>
<a name="l00103"></a>00103 <span class="comment"> AV_SAMPLE_FMT_NONE on error.</span>
<a name="l00104"></a>00104 <span class="comment"> */</span>
<a name="l00105"></a>00105 <span class="keyword">enum</span> <a class="code" href="group__lavu__sampfmts.html#gaf9a51ca15301871723577c730b5865c5" title="Audio sample formats.">AVSampleFormat</a> <a class="code" href="group__lavu__sampfmts.html#ga7817ec0eff4dc6fc0962f31e6d138bca" title="Get the packed alternative form of the given sample format.">av_get_packed_sample_fmt</a>(<span class="keyword">enum</span> <a class="code" href="group__lavu__sampfmts.html#gaf9a51ca15301871723577c730b5865c5" title="Audio sample formats.">AVSampleFormat</a> sample_fmt);
<a name="l00106"></a>00106 <span class="comment"></span>
<a name="l00107"></a>00107 <span class="comment">/**</span>
<a name="l00108"></a>00108 <span class="comment"> * Get the planar alternative form of the given sample format.</span>
<a name="l00109"></a>00109 <span class="comment"> *</span>
<a name="l00110"></a>00110 <span class="comment"> * If the passed sample_fmt is already in planar format, the format returned is</span>
<a name="l00111"></a>00111 <span class="comment"> * the same as the input.</span>
<a name="l00112"></a>00112 <span class="comment"> *</span>
<a name="l00113"></a>00113 <span class="comment"> * @return the planar alternative form of the given sample format or</span>
<a name="l00114"></a>00114 <span class="comment"> AV_SAMPLE_FMT_NONE on error.</span>
<a name="l00115"></a>00115 <span class="comment"> */</span>
<a name="l00116"></a>00116 <span class="keyword">enum</span> <a class="code" href="group__lavu__sampfmts.html#gaf9a51ca15301871723577c730b5865c5" title="Audio sample formats.">AVSampleFormat</a> <a class="code" href="group__lavu__sampfmts.html#ga82caf838259d95cc6c4fd87633bb0e19" title="Get the planar alternative form of the given sample format.">av_get_planar_sample_fmt</a>(<span class="keyword">enum</span> <a class="code" href="group__lavu__sampfmts.html#gaf9a51ca15301871723577c730b5865c5" title="Audio sample formats.">AVSampleFormat</a> sample_fmt);
<a name="l00117"></a>00117 <span class="comment"></span>
<a name="l00118"></a>00118 <span class="comment">/**</span>
<a name="l00119"></a>00119 <span class="comment"> * Generate a string corresponding to the sample format with</span>
<a name="l00120"></a>00120 <span class="comment"> * sample_fmt, or a header if sample_fmt is negative.</span>
<a name="l00121"></a>00121 <span class="comment"> *</span>
<a name="l00122"></a>00122 <span class="comment"> * @param buf the buffer where to write the string</span>
<a name="l00123"></a>00123 <span class="comment"> * @param buf_size the size of buf</span>
<a name="l00124"></a>00124 <span class="comment"> * @param sample_fmt the number of the sample format to print the</span>
<a name="l00125"></a>00125 <span class="comment"> * corresponding info string, or a negative value to print the</span>
<a name="l00126"></a>00126 <span class="comment"> * corresponding header.</span>
<a name="l00127"></a>00127 <span class="comment"> * @return the pointer to the filled buffer or NULL if sample_fmt is</span>
<a name="l00128"></a>00128 <span class="comment"> * unknown or in case of other errors</span>
<a name="l00129"></a>00129 <span class="comment"> */</span>
<a name="l00130"></a>00130 <span class="keywordtype">char</span> *<a class="code" href="group__lavu__sampfmts.html#gabdc8c2172c33fe9d36cbedaf3c5f83bb" title="Generate a string corresponding to the sample format with sample_fmt, or a header if sample_fmt is ne...">av_get_sample_fmt_string</a>(<span class="keywordtype">char</span> *buf, <span class="keywordtype">int</span> buf_size, <span class="keyword">enum</span> <a class="code" href="group__lavu__sampfmts.html#gaf9a51ca15301871723577c730b5865c5" title="Audio sample formats.">AVSampleFormat</a> sample_fmt);
<a name="l00131"></a>00131 <span class="comment"></span>
<a name="l00132"></a>00132 <span class="comment">/**</span>
<a name="l00133"></a>00133 <span class="comment"> * Return number of bytes per sample.</span>
<a name="l00134"></a>00134 <span class="comment"> *</span>
<a name="l00135"></a>00135 <span class="comment"> * @param sample_fmt the sample format</span>
<a name="l00136"></a>00136 <span class="comment"> * @return number of bytes per sample or zero if unknown for the given</span>
<a name="l00137"></a>00137 <span class="comment"> * sample format</span>
<a name="l00138"></a>00138 <span class="comment"> */</span>
<a name="l00139"></a>00139 <span class="keywordtype">int</span> <a class="code" href="group__lavu__sampfmts.html#ga0c3c218e1dd570ad4917c69a35a6c77d" title="Return number of bytes per sample.">av_get_bytes_per_sample</a>(<span class="keyword">enum</span> <a class="code" href="group__lavu__sampfmts.html#gaf9a51ca15301871723577c730b5865c5" title="Audio sample formats.">AVSampleFormat</a> sample_fmt);
<a name="l00140"></a>00140 <span class="comment"></span>
<a name="l00141"></a>00141 <span class="comment">/**</span>
<a name="l00142"></a>00142 <span class="comment"> * Check if the sample format is planar.</span>
<a name="l00143"></a>00143 <span class="comment"> *</span>
<a name="l00144"></a>00144 <span class="comment"> * @param sample_fmt the sample format to inspect</span>
<a name="l00145"></a>00145 <span class="comment"> * @return 1 if the sample format is planar, 0 if it is interleaved</span>
<a name="l00146"></a>00146 <span class="comment"> */</span>
<a name="l00147"></a>00147 <span class="keywordtype">int</span> <a class="code" href="group__lavu__sampfmts.html#ga06ba8a64dc4382c422789a5d0b6bf592" title="Check if the sample format is planar.">av_sample_fmt_is_planar</a>(<span class="keyword">enum</span> <a class="code" href="group__lavu__sampfmts.html#gaf9a51ca15301871723577c730b5865c5" title="Audio sample formats.">AVSampleFormat</a> sample_fmt);
<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"> * Get the required buffer size for the given audio parameters.</span>
<a name="l00151"></a>00151 <span class="comment"> *</span>
<a name="l00152"></a>00152 <span class="comment"> * @param[out] linesize calculated linesize, may be NULL</span>
<a name="l00153"></a>00153 <span class="comment"> * @param nb_channels the number of channels</span>
<a name="l00154"></a>00154 <span class="comment"> * @param nb_samples the number of samples in a single channel</span>
<a name="l00155"></a>00155 <span class="comment"> * @param sample_fmt the sample format</span>
<a name="l00156"></a>00156 <span class="comment"> * @param align buffer size alignment (0 = default, 1 = no alignment)</span>
<a name="l00157"></a>00157 <span class="comment"> * @return required buffer size, or negative error code on failure</span>
<a name="l00158"></a>00158 <span class="comment"> */</span>
<a name="l00159"></a>00159 <span class="keywordtype">int</span> <a class="code" href="group__lavu__sampfmts.html#gaa7368bc4e3a366b688e81938ed55eb06" title="Get the required buffer size for the given audio parameters.">av_samples_get_buffer_size</a>(<span class="keywordtype">int</span> *linesize, <span class="keywordtype">int</span> nb_channels, <span class="keywordtype">int</span> nb_samples,
<a name="l00160"></a>00160 <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> align);
<a name="l00161"></a>00161 <span class="comment"></span>
<a name="l00162"></a>00162 <span class="comment">/**</span>
<a name="l00163"></a>00163 <span class="comment"> * @}</span>
<a name="l00164"></a>00164 <span class="comment"> *</span>
<a name="l00165"></a>00165 <span class="comment"> * @defgroup lavu_sampmanip Samples manipulation</span>
<a name="l00166"></a>00166 <span class="comment"> *</span>
<a name="l00167"></a>00167 <span class="comment"> * Functions that manipulate audio samples</span>
<a name="l00168"></a>00168 <span class="comment"> * @{</span>
<a name="l00169"></a>00169 <span class="comment"> */</span>
<a name="l00170"></a>00170 <span class="comment"></span>
<a name="l00171"></a>00171 <span class="comment">/**</span>
<a name="l00172"></a>00172 <span class="comment"> * Fill plane data pointers and linesize for samples with sample</span>
<a name="l00173"></a>00173 <span class="comment"> * format sample_fmt.</span>
<a name="l00174"></a>00174 <span class="comment"> *</span>
<a name="l00175"></a>00175 <span class="comment"> * The audio_data array is filled with the pointers to the samples data planes:</span>
<a name="l00176"></a>00176 <span class="comment"> * for planar, set the start point of each channel's data within the buffer,</span>
<a name="l00177"></a>00177 <span class="comment"> * for packed, set the start point of the entire buffer only.</span>
<a name="l00178"></a>00178 <span class="comment"> *</span>
<a name="l00179"></a>00179 <span class="comment"> * The value pointed to by linesize is set to the aligned size of each</span>
<a name="l00180"></a>00180 <span class="comment"> * channel's data buffer for planar layout, or to the aligned size of the</span>
<a name="l00181"></a>00181 <span class="comment"> * buffer for all channels for packed layout.</span>
<a name="l00182"></a>00182 <span class="comment"> *</span>
<a name="l00183"></a>00183 <span class="comment"> * The buffer in buf must be big enough to contain all the samples</span>
<a name="l00184"></a>00184 <span class="comment"> * (use av_samples_get_buffer_size() to compute its minimum size),</span>
<a name="l00185"></a>00185 <span class="comment"> * otherwise the audio_data pointers will point to invalid data.</span>
<a name="l00186"></a>00186 <span class="comment"> *</span>
<a name="l00187"></a>00187 <span class="comment"> * @see enum AVSampleFormat</span>
<a name="l00188"></a>00188 <span class="comment"> * The documentation for AVSampleFormat describes the data layout.</span>
<a name="l00189"></a>00189 <span class="comment"> *</span>
<a name="l00190"></a>00190 <span class="comment"> * @param[out] audio_data array to be filled with the pointer for each channel</span>
<a name="l00191"></a>00191 <span class="comment"> * @param[out] linesize calculated linesize, may be NULL</span>
<a name="l00192"></a>00192 <span class="comment"> * @param buf the pointer to a buffer containing the samples</span>
<a name="l00193"></a>00193 <span class="comment"> * @param nb_channels the number of channels</span>
<a name="l00194"></a>00194 <span class="comment"> * @param nb_samples the number of samples in a single channel</span>
<a name="l00195"></a>00195 <span class="comment"> * @param sample_fmt the sample format</span>
<a name="l00196"></a>00196 <span class="comment"> * @param align buffer size alignment (0 = default, 1 = no alignment)</span>
<a name="l00197"></a>00197 <span class="comment"> * @return >=0 on success or a negative error code on failure</span>
<a name="l00198"></a>00198 <span class="comment"> * @todo return minimum size in bytes required for the buffer in case</span>
<a name="l00199"></a>00199 <span class="comment"> * of success at the next bump</span>
<a name="l00200"></a>00200 <span class="comment"> */</span>
<a name="l00201"></a>00201 <span class="keywordtype">int</span> <a class="code" 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>(uint8_t **audio_data, <span class="keywordtype">int</span> *linesize,
<a name="l00202"></a>00202 <span class="keyword">const</span> uint8_t *buf,
<a name="l00203"></a>00203 <span class="keywordtype">int</span> nb_channels, <span class="keywordtype">int</span> nb_samples,
<a name="l00204"></a>00204 <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> align);
<a name="l00205"></a>00205 <span class="comment"></span>
<a name="l00206"></a>00206 <span class="comment">/**</span>
<a name="l00207"></a>00207 <span class="comment"> * Allocate a samples buffer for nb_samples samples, and fill data pointers and</span>
<a name="l00208"></a>00208 <span class="comment"> * linesize accordingly.</span>
<a name="l00209"></a>00209 <span class="comment"> * The allocated samples buffer can be freed by using av_freep(&audio_data[0])</span>
<a name="l00210"></a>00210 <span class="comment"> * Allocated data will be initialized to silence.</span>
<a name="l00211"></a>00211 <span class="comment"> *</span>
<a name="l00212"></a>00212 <span class="comment"> * @see enum AVSampleFormat</span>
<a name="l00213"></a>00213 <span class="comment"> * The documentation for AVSampleFormat describes the data layout.</span>
<a name="l00214"></a>00214 <span class="comment"> *</span>
<a name="l00215"></a>00215 <span class="comment"> * @param[out] audio_data array to be filled with the pointer for each channel</span>
<a name="l00216"></a>00216 <span class="comment"> * @param[out] linesize aligned size for audio buffer(s), may be NULL</span>
<a name="l00217"></a>00217 <span class="comment"> * @param nb_channels number of audio channels</span>
<a name="l00218"></a>00218 <span class="comment"> * @param nb_samples number of samples per channel</span>
<a name="l00219"></a>00219 <span class="comment"> * @param align buffer size alignment (0 = default, 1 = no alignment)</span>
<a name="l00220"></a>00220 <span class="comment"> * @return >=0 on success or a negative error code on failure</span>
<a name="l00221"></a>00221 <span class="comment"> * @todo return the size of the allocated buffer in case of success at the next bump</span>
<a name="l00222"></a>00222 <span class="comment"> * @see av_samples_fill_arrays()</span>
<a name="l00223"></a>00223 <span class="comment"> * @see av_samples_alloc_array_and_samples()</span>
<a name="l00224"></a>00224 <span class="comment"> */</span>
<a name="l00225"></a>00225 <span class="keywordtype">int</span> <a class="code" href="group__lavu__sampmanip.html#ga4db4c77f928d32c7d8854732f50b8c04" title="Allocate a samples buffer for nb_samples samples, and fill data pointers and linesize accordingly...">av_samples_alloc</a>(uint8_t **audio_data, <span class="keywordtype">int</span> *linesize, <span class="keywordtype">int</span> nb_channels,
<a name="l00226"></a>00226 <span class="keywordtype">int</span> nb_samples, <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> align);
<a name="l00227"></a>00227 <span class="comment"></span>
<a name="l00228"></a>00228 <span class="comment">/**</span>
<a name="l00229"></a>00229 <span class="comment"> * Allocate a data pointers array, samples buffer for nb_samples</span>
<a name="l00230"></a>00230 <span class="comment"> * samples, and fill data pointers and linesize accordingly.</span>
<a name="l00231"></a>00231 <span class="comment"> *</span>
<a name="l00232"></a>00232 <span class="comment"> * This is the same as av_samples_alloc(), but also allocates the data</span>
<a name="l00233"></a>00233 <span class="comment"> * pointers array.</span>
<a name="l00234"></a>00234 <span class="comment"> *</span>
<a name="l00235"></a>00235 <span class="comment"> * @see av_samples_alloc()</span>
<a name="l00236"></a>00236 <span class="comment"> */</span>
<a name="l00237"></a>00237 <span class="keywordtype">int</span> <a class="code" href="group__lavu__sampmanip.html#gae8b9f22f2f659d023f111390d9545273" title="Allocate a data pointers array, samples buffer for nb_samples samples, and fill data pointers and lin...">av_samples_alloc_array_and_samples</a>(uint8_t ***audio_data, <span class="keywordtype">int</span> *linesize, <span class="keywordtype">int</span> nb_channels,
<a name="l00238"></a>00238 <span class="keywordtype">int</span> nb_samples, <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> align);
<a name="l00239"></a>00239 <span class="comment"></span>
<a name="l00240"></a>00240 <span class="comment">/**</span>
<a name="l00241"></a>00241 <span class="comment"> * Copy samples from src to dst.</span>
<a name="l00242"></a>00242 <span class="comment"> *</span>
<a name="l00243"></a>00243 <span class="comment"> * @param dst destination array of pointers to data planes</span>
<a name="l00244"></a>00244 <span class="comment"> * @param src source array of pointers to data planes</span>
<a name="l00245"></a>00245 <span class="comment"> * @param dst_offset offset in samples at which the data will be written to dst</span>
<a name="l00246"></a>00246 <span class="comment"> * @param src_offset offset in samples at which the data will be read from src</span>
<a name="l00247"></a>00247 <span class="comment"> * @param nb_samples number of samples to be copied</span>
<a name="l00248"></a>00248 <span class="comment"> * @param nb_channels number of audio channels</span>
<a name="l00249"></a>00249 <span class="comment"> * @param sample_fmt audio sample format</span>
<a name="l00250"></a>00250 <span class="comment"> */</span>
<a name="l00251"></a>00251 <span class="keywordtype">int</span> <a class="code" href="group__lavu__sampmanip.html#ga5fdc6b1118f3ba7ad9ac9f67308b9597" title="Copy samples from src to dst.">av_samples_copy</a>(uint8_t **dst, uint8_t * <span class="keyword">const</span> *src, <span class="keywordtype">int</span> dst_offset,
<a name="l00252"></a>00252 <span class="keywordtype">int</span> src_offset, <span class="keywordtype">int</span> nb_samples, <span class="keywordtype">int</span> nb_channels,
<a name="l00253"></a>00253 <span class="keyword">enum</span> <a class="code" href="group__lavu__sampfmts.html#gaf9a51ca15301871723577c730b5865c5" title="Audio sample formats.">AVSampleFormat</a> sample_fmt);
<a name="l00254"></a>00254 <span class="comment"></span>
<a name="l00255"></a>00255 <span class="comment">/**</span>
<a name="l00256"></a>00256 <span class="comment"> * Fill an audio buffer with silence.</span>
<a name="l00257"></a>00257 <span class="comment"> *</span>
<a name="l00258"></a>00258 <span class="comment"> * @param audio_data array of pointers to data planes</span>
<a name="l00259"></a>00259 <span class="comment"> * @param offset offset in samples at which to start filling</span>
<a name="l00260"></a>00260 <span class="comment"> * @param nb_samples number of samples to fill</span>
<a name="l00261"></a>00261 <span class="comment"> * @param nb_channels number of audio channels</span>
<a name="l00262"></a>00262 <span class="comment"> * @param sample_fmt audio sample format</span>
<a name="l00263"></a>00263 <span class="comment"> */</span>
<a name="l00264"></a>00264 <span class="keywordtype">int</span> <a class="code" href="group__lavu__sampmanip.html#ga6f287e5c4f426a8be8a8b5b8f708a05c" title="Fill an audio buffer with silence.">av_samples_set_silence</a>(uint8_t **audio_data, <span class="keywordtype">int</span> offset, <span class="keywordtype">int</span> nb_samples,
<a name="l00265"></a>00265 <span class="keywordtype">int</span> nb_channels, <span class="keyword">enum</span> <a class="code" href="group__lavu__sampfmts.html#gaf9a51ca15301871723577c730b5865c5" title="Audio sample formats.">AVSampleFormat</a> sample_fmt);
<a name="l00266"></a>00266 <span class="comment"></span>
<a name="l00267"></a>00267 <span class="comment">/**</span>
<a name="l00268"></a>00268 <span class="comment"> * @}</span>
<a name="l00269"></a>00269 <span class="comment"> * @}</span>
<a name="l00270"></a>00270 <span class="comment"> */</span>
<a name="l00271"></a>00271 <span class="preprocessor">#endif </span><span class="comment">/* AVUTIL_SAMPLEFMT_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>