1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 2<html> 3<head> 4<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 5<title>faac: GStreamer Bad Plugins 1.0 Plugins Reference Manual</title> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="index.html" title="GStreamer Bad Plugins 1.0 Plugins Reference Manual"> 8<link rel="up" href="ch01.html" title="gst-plugins-bad Elements"> 9<link rel="prev" href="gst-plugins-bad-plugins-exclusion.html" title="exclusion"> 10<link rel="next" href="gst-plugins-bad-plugins-faad.html" title="faad"> 11<meta name="generator" content="GTK-Doc V1.28 (XML mode)"> 12<link rel="stylesheet" href="style.css" type="text/css"> 13</head> 14<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 15<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> 16<td width="100%" align="left" class="shortcuts"> 17<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> 18 <a href="#gst-plugins-bad-plugins-faac.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 19 <a href="#gst-plugins-bad-plugins-faac.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span> 20 <a href="#gst-plugins-bad-plugins-faac.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span> 21 <a href="#gst-plugins-bad-plugins-faac.properties" class="shortcut">Properties</a></span> 22</td> 23<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> 24<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> 25<td><a accesskey="p" href="gst-plugins-bad-plugins-exclusion.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> 26<td><a accesskey="n" href="gst-plugins-bad-plugins-faad.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> 27</tr></table> 28<div class="refentry"> 29<a name="gst-plugins-bad-plugins-faac"></a><div class="titlepage"></div> 30<div class="refnamediv"><table width="100%"><tr> 31<td valign="top"> 32<h2><span class="refentrytitle"><a name="gst-plugins-bad-plugins-faac.top_of_page"></a>faac</span></h2> 33<p>faac</p> 34</td> 35<td class="gallery_image" valign="top" align="right"></td> 36</tr></table></div> 37<div class="refsect1"> 38<a name="gst-plugins-bad-plugins-faac.properties"></a><h2>Properties</h2> 39<div class="informaltable"><table class="informaltable" border="0"> 40<colgroup> 41<col width="150px" class="properties_type"> 42<col width="300px" class="properties_name"> 43<col width="200px" class="properties_flags"> 44</colgroup> 45<tbody> 46<tr> 47<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> 48<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-faac.html#GstFaac--bitrate" title="The “bitrate” property">bitrate</a></td> 49<td class="property_flags">Read / Write / Construct</td> 50</tr> 51<tr> 52<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> 53<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-faac.html#GstFaac--midside" title="The “midside” property">midside</a></td> 54<td class="property_flags">Read / Write / Construct</td> 55</tr> 56<tr> 57<td class="property_type"><span class="type">GstFaacOutputFormat</span></td> 58<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-faac.html#GstFaac--outputformat" title="The “outputformat” property">outputformat</a></td> 59<td class="property_flags">Read / Write</td> 60</tr> 61<tr> 62<td class="property_type"><span class="type">GstFaacProfile</span></td> 63<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-faac.html#GstFaac--profile" title="The “profile” property">profile</a></td> 64<td class="property_flags">Read / Write</td> 65</tr> 66<tr> 67<td class="property_type"><span class="type">GstFaacShortCtl</span></td> 68<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-faac.html#GstFaac--shortctl" title="The “shortctl” property">shortctl</a></td> 69<td class="property_flags">Read / Write / Construct</td> 70</tr> 71<tr> 72<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> 73<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-faac.html#GstFaac--tns" title="The “tns” property">tns</a></td> 74<td class="property_flags">Read / Write / Construct</td> 75</tr> 76<tr> 77<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> 78<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-faac.html#GstFaac--quality" title="The “quality” property">quality</a></td> 79<td class="property_flags">Read / Write / Construct</td> 80</tr> 81<tr> 82<td class="property_type"><span class="type">GstFaacBrtype</span></td> 83<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-faac.html#GstFaac--rate-control" title="The “rate-control” property">rate-control</a></td> 84<td class="property_flags">Read / Write / Construct</td> 85</tr> 86</tbody> 87</table></div> 88</div> 89<a name="GstFaac"></a><div class="refsect1"> 90<a name="gst-plugins-bad-plugins-faac.other"></a><h2>Types and Values</h2> 91<div class="informaltable"><table class="informaltable" width="100%" border="0"> 92<colgroup> 93<col width="150px" class="name"> 94<col class="description"> 95</colgroup> 96<tbody><tr> 97<td class="datatype_keyword">struct</td> 98<td class="function_name"><a class="link" href="gst-plugins-bad-plugins-faac.html#GstFaac-struct" title="struct GstFaac">GstFaac</a></td> 99</tr></tbody> 100</table></div> 101</div> 102<div class="refsect1"> 103<a name="gst-plugins-bad-plugins-faac.object-hierarchy"></a><h2>Object Hierarchy</h2> 104<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> 105 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a> 106 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a> 107 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a> 108 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gst-plugins-base-libs-1.0/GstAudioEncoder.html#GstAudioEncoder-struct">GstAudioEncoder</a> 109 <span class="lineart">╰──</span> GstFaac 110</pre> 111</div> 112<div class="refsect1"> 113<a name="gst-plugins-bad-plugins-faac.implemented-interfaces"></a><h2>Implemented Interfaces</h2> 114<p> 115GstFaac implements 116 <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstPreset.html#GstPreset-struct">GstPreset</a>.</p> 117</div> 118<div class="refsect1"> 119<a name="gst-plugins-bad-plugins-faac.description"></a><h2>Description</h2> 120<p>faac encodes raw audio to AAC (MPEG-4 part 3) streams.</p> 121<div class="refsect3"> 122<a name="id-1.2.80.8.3"></a><h4>Example launch line</h4> 123<div class="informalexample"> 124 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> 125 <tbody> 126 <tr> 127 <td class="listing_lines" align="right"><pre>1</pre></td> 128 <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch<span class="gtkdoc opt">-</span><span class="number">1.0</span> audiotestsrc wave<span class="gtkdoc opt">=</span>sine num<span class="gtkdoc opt">-</span>buffers<span class="gtkdoc opt">=</span><span class="number">100</span> <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> faac <span class="gtkdoc opt">!</span> matroskamux <span class="gtkdoc opt">!</span> filesink location<span class="gtkdoc opt">=</span>sine<span class="gtkdoc opt">.</span>mkv</pre></td> 129 </tr> 130 </tbody> 131 </table> 132</div> 133 134<p> Encode a sine beep as aac and write to matroska container.</p> 135</div> 136<div class="refsynopsisdiv"> 137<h2>Synopsis</h2> 138<div class="refsect2"> 139<a name="id-1.2.80.8.4.1"></a><h3>Element Information</h3> 140<div class="variablelist"><table border="0" class="variablelist"> 141<colgroup> 142<col align="left" valign="top"> 143<col> 144</colgroup> 145<tbody> 146<tr> 147<td><p><span class="term">plugin</span></p></td> 148<td> 149 <a class="link" href="gst-plugins-bad-plugins-plugin-faac.html#plugin-faac">faac</a> 150 </td> 151</tr> 152<tr> 153<td><p><span class="term">author</span></p></td> 154<td>Ronald Bultje <rbultje@ronald.bitfreak.net></td> 155</tr> 156<tr> 157<td><p><span class="term">class</span></p></td> 158<td>Codec/Encoder/Audio</td> 159</tr> 160</tbody> 161</table></div> 162</div> 163<hr> 164<div class="refsect2"> 165<a name="id-1.2.80.8.4.2"></a><h3>Element Pads</h3> 166<div class="variablelist"><table border="0" class="variablelist"> 167<colgroup> 168<col align="left" valign="top"> 169<col> 170</colgroup> 171<tbody> 172<tr> 173<td><p><span class="term">name</span></p></td> 174<td>sink</td> 175</tr> 176<tr> 177<td><p><span class="term">direction</span></p></td> 178<td>sink</td> 179</tr> 180<tr> 181<td><p><span class="term">presence</span></p></td> 182<td>always</td> 183</tr> 184<tr> 185<td><p><span class="term">details</span></p></td> 186<td>audio/x-raw, format=(string)S16LE, layout=(string)interleaved, rate=(int){ 8000, 11025, 12000, 16000, 22050, 24000, 32000, 44100, 48000, 64000, 88200, 96000 }, channels=(int)1</td> 187</tr> 188<tr> 189<td><p><span class="term"></span></p></td> 190<td> audio/x-raw, format=(string)S16LE, layout=(string)interleaved, rate=(int){ 8000, 11025, 12000, 16000, 22050, 24000, 32000, 44100, 48000, 64000, 88200, 96000 }, channels=(int)2, channel-mask=(bitmask)0x0000000000000003</td> 191</tr> 192<tr> 193<td><p><span class="term"></span></p></td> 194<td> audio/x-raw, format=(string)S16LE, layout=(string)interleaved, rate=(int){ 8000, 11025, 12000, 16000, 22050, 24000, 32000, 44100, 48000, 64000, 88200, 96000 }, channels=(int)3, channel-mask=(bitmask)0x0000000000000007</td> 195</tr> 196<tr> 197<td><p><span class="term"></span></p></td> 198<td> audio/x-raw, format=(string)S16LE, layout=(string)interleaved, rate=(int){ 8000, 11025, 12000, 16000, 22050, 24000, 32000, 44100, 48000, 64000, 88200, 96000 }, channels=(int)4, channel-mask=(bitmask)0x0000000000000107</td> 199</tr> 200<tr> 201<td><p><span class="term"></span></p></td> 202<td> audio/x-raw, format=(string)S16LE, layout=(string)interleaved, rate=(int){ 8000, 11025, 12000, 16000, 22050, 24000, 32000, 44100, 48000, 64000, 88200, 96000 }, channels=(int)5, channel-mask=(bitmask)0x0000000000000037</td> 203</tr> 204<tr> 205<td><p><span class="term"></span></p></td> 206<td> audio/x-raw, format=(string)S16LE, layout=(string)interleaved, rate=(int){ 8000, 11025, 12000, 16000, 22050, 24000, 32000, 44100, 48000, 64000, 88200, 96000 }, channels=(int)6, channel-mask=(bitmask)0x000000000000003f</td> 207</tr> 208</tbody> 209</table></div> 210<div class="variablelist"><table border="0" class="variablelist"> 211<colgroup> 212<col align="left" valign="top"> 213<col> 214</colgroup> 215<tbody> 216<tr> 217<td><p><span class="term">name</span></p></td> 218<td>src</td> 219</tr> 220<tr> 221<td><p><span class="term">direction</span></p></td> 222<td>source</td> 223</tr> 224<tr> 225<td><p><span class="term">presence</span></p></td> 226<td>always</td> 227</tr> 228<tr> 229<td><p><span class="term">details</span></p></td> 230<td>audio/mpeg, mpegversion=(int)4, channels=(int)[ 1, 6 ], rate=(int){ 8000, 11025, 12000, 16000, 22050, 24000, 32000, 44100, 48000, 64000, 88200, 96000 }, stream-format=(string){ adts, raw }, base-profile=(string){ main, lc, ssr, ltp }, framed=(boolean)true</td> 231</tr> 232<tr> 233<td><p><span class="term"></span></p></td> 234<td> audio/mpeg, mpegversion=(int)2, channels=(int)[ 1, 6 ], rate=(int){ 8000, 11025, 12000, 16000, 22050, 24000, 32000, 44100, 48000, 64000, 88200, 96000 }, stream-format=(string){ adts, raw }, profile=(string){ main, lc }, framed=(boolean)true</td> 235</tr> 236</tbody> 237</table></div> 238</div> 239</div> 240</div> 241<div class="refsect1"> 242<a name="gst-plugins-bad-plugins-faac.functions_details"></a><h2>Functions</h2> 243<p></p> 244</div> 245<div class="refsect1"> 246<a name="gst-plugins-bad-plugins-faac.other_details"></a><h2>Types and Values</h2> 247<div class="refsect2"> 248<a name="GstFaac-struct"></a><h3>struct GstFaac</h3> 249<pre class="programlisting">struct GstFaac;</pre> 250</div> 251</div> 252<div class="refsect1"> 253<a name="gst-plugins-bad-plugins-faac.property-details"></a><h2>Property Details</h2> 254<div class="refsect2"> 255<a name="GstFaac--bitrate"></a><h3>The <code class="literal">“bitrate”</code> property</h3> 256<pre class="programlisting"> “bitrate” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 257<p>Average Bitrate (ABR) in bits/sec.</p> 258<p>Flags: Read / Write / Construct</p> 259<p>Allowed values: [8000,320000]</p> 260<p>Default value: 128000</p> 261</div> 262<hr> 263<div class="refsect2"> 264<a name="GstFaac--midside"></a><h3>The <code class="literal">“midside”</code> property</h3> 265<pre class="programlisting"> “midside” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> 266<p>Allow mid/side encoding.</p> 267<p>Flags: Read / Write / Construct</p> 268<p>Default value: TRUE</p> 269</div> 270<hr> 271<div class="refsect2"> 272<a name="GstFaac--outputformat"></a><h3>The <code class="literal">“outputformat”</code> property</h3> 273<pre class="programlisting"> “outputformat” <span class="type">GstFaacOutputFormat</span></pre> 274<p>Format of output frames.</p> 275<p>Flags: Read / Write</p> 276<p>Default value: OUTPUTFORMAT_RAW</p> 277</div> 278<hr> 279<div class="refsect2"> 280<a name="GstFaac--profile"></a><h3>The <code class="literal">“profile”</code> property</h3> 281<pre class="programlisting"> “profile” <span class="type">GstFaacProfile</span></pre> 282<p>MPEG/AAC encoding profile.</p> 283<p>Flags: Read / Write</p> 284<p>Default value: LC</p> 285</div> 286<hr> 287<div class="refsect2"> 288<a name="GstFaac--shortctl"></a><h3>The <code class="literal">“shortctl”</code> property</h3> 289<pre class="programlisting"> “shortctl” <span class="type">GstFaacShortCtl</span></pre> 290<p>Block type encorcing.</p> 291<p>Flags: Read / Write / Construct</p> 292<p>Default value: SHORTCTL_NORMAL</p> 293</div> 294<hr> 295<div class="refsect2"> 296<a name="GstFaac--tns"></a><h3>The <code class="literal">“tns”</code> property</h3> 297<pre class="programlisting"> “tns” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> 298<p>Use temporal noise shaping.</p> 299<p>Flags: Read / Write / Construct</p> 300<p>Default value: FALSE</p> 301</div> 302<hr> 303<div class="refsect2"> 304<a name="GstFaac--quality"></a><h3>The <code class="literal">“quality”</code> property</h3> 305<pre class="programlisting"> “quality” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 306<p>Variable bitrate (VBR) quantizer quality in %.</p> 307<p>Flags: Read / Write / Construct</p> 308<p>Allowed values: [1,1000]</p> 309<p>Default value: 100</p> 310</div> 311<hr> 312<div class="refsect2"> 313<a name="GstFaac--rate-control"></a><h3>The <code class="literal">“rate-control”</code> property</h3> 314<pre class="programlisting"> “rate-control” <span class="type">GstFaacBrtype</span></pre> 315<p>Encoding bitrate type (VBR/ABR).</p> 316<p>Flags: Read / Write / Construct</p> 317<p>Default value: VBR</p> 318</div> 319</div> 320<div class="refsect1"> 321<a name="gst-plugins-bad-plugins-faac.see-also"></a><h2>See Also</h2> 322<p>faad</p> 323</div> 324</div> 325<div class="footer"> 326<hr>Generated by GTK-Doc V1.28</div> 327</body> 328</html>
