docs/plugins/html/gst-plugins-good-plugins-flacenc.html

   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>flacenc</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
   7 <link rel="home" href="index.html" title="GStreamer Good Plugins 0.10 Plugins Reference Manual">
   8 <link rel="up" href="ch01.html" title="gst-plugins-good Elements">
   9 <link rel="prev" href="gst-plugins-good-plugins-flacdec.html" title="flacdec">
  10 <link rel="next" href="gst-plugins-good-plugins-flacparse.html" title="flacparse">
  11 <meta name="generator" content="GTK-Doc V1.17 (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="2">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="gst-plugins-good-plugins-flacdec.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">GStreamer Good Plugins 0.10 Plugins Reference Manual</th>
  21 <td><a accesskey="n" href="gst-plugins-good-plugins-flacparse.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#gst-plugins-good-plugins-flacenc.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-good-plugins-flacenc.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gst-plugins-good-plugins-flacenc.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#gst-plugins-good-plugins-flacenc.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
  31                    |
  32                   <a href="#gst-plugins-good-plugins-flacenc.properties" class="shortcut">Properties</a>
  33 </td></tr>
  34 </table>
  35 <div class="refentry">
  36 <a name="gst-plugins-good-plugins-flacenc"></a><div class="titlepage"></div>
  37 <div class="refnamediv"><table width="100%"><tr>
  38 <td valign="top">
  39 <h2><span class="refentrytitle"><a name="gst-plugins-good-plugins-flacenc.top_of_page"></a>flacenc</span></h2>
  40 <p>flacenc — Encodes audio with the FLAC lossless audio encoder</p>
  41 </td>
  42 <td valign="top" align="right"></td>
  43 </tr></table></div>
  44 <div class="refsynopsisdiv">
  45 <a name="gst-plugins-good-plugins-flacenc.synopsis"></a><h2>Synopsis</h2>
  46 <a name="GstFlacEnc"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-good-plugins-flacenc.html#GstFlacEnc-struct" title="struct GstFlacEnc">GstFlacEnc</a>;
  47 </pre>
  48 </div>
  49 <div class="refsect1">
  50 <a name="gst-plugins-good-plugins-flacenc.object-hierarchy"></a><h2>Object Hierarchy</h2>
  51 <pre class="synopsis">
  52   <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  53    +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
  54          +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
  55                +----GstFlacEnc
  56 </pre>
  57 </div>
  58 <div class="refsect1">
  59 <a name="gst-plugins-good-plugins-flacenc.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
  60 <p>
  61 GstFlacEnc implements
  62  <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstTagSetter.html">GstTagSetter</a> and  <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPreset.html">GstPreset</a>.</p>
  63 </div>
  64 <div class="refsect1">
  65 <a name="gst-plugins-good-plugins-flacenc.properties"></a><h2>Properties</h2>
  66 <pre class="synopsis">
  67   "<a class="link" href="gst-plugins-good-plugins-flacenc.html#GstFlacEnc--blocksize" title='The "blocksize" property'>blocksize</a>"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write / Construct
  68   "<a class="link" href="gst-plugins-good-plugins-flacenc.html#GstFlacEnc--escape-coding" title='The "escape-coding" property'>escape-coding</a>"            <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write / Construct
  69   "<a class="link" href="gst-plugins-good-plugins-flacenc.html#GstFlacEnc--exhaustive-model-search" title='The "exhaustive-model-search" property'>exhaustive-model-search</a>"  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write / Construct
  70   "<a class="link" href="gst-plugins-good-plugins-flacenc.html#GstFlacEnc--loose-mid-side-stereo" title='The "loose-mid-side-stereo" property'>loose-mid-side-stereo</a>"    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write / Construct
  71   "<a class="link" href="gst-plugins-good-plugins-flacenc.html#GstFlacEnc--max-lpc-order" title='The "max-lpc-order" property'>max-lpc-order</a>"            <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write / Construct
  72   "<a class="link" href="gst-plugins-good-plugins-flacenc.html#GstFlacEnc--max-residual-partition-order" title='The "max-residual-partition-order" property'>max-residual-partition-order</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write / Construct
  73   "<a class="link" href="gst-plugins-good-plugins-flacenc.html#GstFlacEnc--mid-side-stereo" title='The "mid-side-stereo" property'>mid-side-stereo</a>"          <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write / Construct
  74   "<a class="link" href="gst-plugins-good-plugins-flacenc.html#GstFlacEnc--min-residual-partition-order" title='The "min-residual-partition-order" property'>min-residual-partition-order</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write / Construct
  75   "<a class="link" href="gst-plugins-good-plugins-flacenc.html#GstFlacEnc--qlp-coeff-prec-search" title='The "qlp-coeff-prec-search" property'>qlp-coeff-prec-search</a>"    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write / Construct
  76   "<a class="link" href="gst-plugins-good-plugins-flacenc.html#GstFlacEnc--qlp-coeff-precision" title='The "qlp-coeff-precision" property'>qlp-coeff-precision</a>"      <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write / Construct
  77   "<a class="link" href="gst-plugins-good-plugins-flacenc.html#GstFlacEnc--quality" title='The "quality" property'>quality</a>"                  <span class="type">GstFlacEncQuality</span>     : Read / Write / Construct
  78   "<a class="link" href="gst-plugins-good-plugins-flacenc.html#GstFlacEnc--rice-parameter-search-dist" title='The "rice-parameter-search-dist" property'>rice-parameter-search-dist</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write / Construct
  79   "<a class="link" href="gst-plugins-good-plugins-flacenc.html#GstFlacEnc--streamable-subset" title='The "streamable-subset" property'>streamable-subset</a>"        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write / Construct
  80   "<a class="link" href="gst-plugins-good-plugins-flacenc.html#GstFlacEnc--padding" title='The "padding" property'>padding</a>"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write / Construct
  81   "<a class="link" href="gst-plugins-good-plugins-flacenc.html#GstFlacEnc--seekpoints" title='The "seekpoints" property'>seekpoints</a>"               <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write / Construct
  82 </pre>
  83 </div>
  84 <div class="refsect1">
  85 <a name="gst-plugins-good-plugins-flacenc.description"></a><h2>Description</h2>
  86 <p>
  87 flacenc encodes FLAC streams.
  88 <a class="ulink" href="http://flac.sourceforge.net/" target="_top">FLAC</a>
  89 is a Free Lossless Audio Codec.
  90 </p>
  91 <p>
  92 </p>
  93 <div class="refsect2">
  94 <a name="idp7616800"></a><h3>Example launch line</h3>
  95 <div class="informalexample">
  96   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
  97     <tbody>
  98       <tr>
  99         <td class="listing_lines" align="right"><pre>1</pre></td>
 100         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch audiotestsrc num<span class="gtkdoc opt">-</span>buffers<span class="gtkdoc opt">=</span><span class="number">100</span> <span class="gtkdoc opt">!</span> flacenc <span class="gtkdoc opt">!</span> filesink location<span class="gtkdoc opt">=</span>beep<span class="gtkdoc opt">.</span>flac</pre></td>
 101       </tr>
 102     </tbody>
 103   </table>
 104 </div>
 105
 106 </div>
 107 <p>
 108 </p>
 109 <div class="refsynopsisdiv">
 110 <h2>Synopsis</h2>
 111 <div class="refsect2">
 112 <a name="idp12770576"></a><h3>Element Information</h3>
 113 <div class="variablelist"><table border="0">
 114 <col align="left" valign="top">
 115 <tbody>
 116 <tr>
 117 <td><p><span class="term">plugin</span></p></td>
 118 <td>
 119             <a class="link" href="gst-plugins-good-plugins-plugin-flac.html#plugin-flac">flac</a>
 120           </td>
 121 </tr>
 122 <tr>
 123 <td><p><span class="term">author</span></p></td>
 124 <td>Wim Taymans &lt;wim.taymans@chello.be&gt;</td>
 125 </tr>
 126 <tr>
 127 <td><p><span class="term">class</span></p></td>
 128 <td>Codec/Encoder/Audio</td>
 129 </tr>
 130 </tbody>
 131 </table></div>
 132 </div>
 133 <hr>
 134 <div class="refsect2">
 135 <a name="idp13355632"></a><h3>Element Pads</h3>
 136 <div class="variablelist"><table border="0">
 137 <col align="left" valign="top">
 138 <tbody>
 139 <tr>
 140 <td><p><span class="term">name</span></p></td>
 141 <td>sink</td>
 142 </tr>
 143 <tr>
 144 <td><p><span class="term">direction</span></p></td>
 145 <td>sink</td>
 146 </tr>
 147 <tr>
 148 <td><p><span class="term">presence</span></p></td>
 149 <td>always</td>
 150 </tr>
 151 <tr>
 152 <td><p><span class="term">details</span></p></td>
 153 <td>audio/x-raw-int, endianness=(int)1234, signed=(boolean)true, width=(int)8, depth=(int)8, rate=(int)[ 1, 655350 ], channels=(int)[ 1, 8 ]</td>
 154 </tr>
 155 <tr>
 156 <td><p><span class="term"></span></p></td>
 157 <td> audio/x-raw-int, endianness=(int)1234, signed=(boolean)true, width=(int)16, depth=(int){ 12, 16 }, rate=(int)[ 1, 655350 ], channels=(int)[ 1, 8 ]</td>
 158 </tr>
 159 <tr>
 160 <td><p><span class="term"></span></p></td>
 161 <td> audio/x-raw-int, endianness=(int)1234, signed=(boolean)true, width=(int)32, depth=(int){ 20, 24 }, rate=(int)[ 1, 655350 ], channels=(int)[ 1, 8 ]</td>
 162 </tr>
 163 </tbody>
 164 </table></div>
 165 <div class="variablelist"><table border="0">
 166 <col align="left" valign="top">
 167 <tbody>
 168 <tr>
 169 <td><p><span class="term">name</span></p></td>
 170 <td>src</td>
 171 </tr>
 172 <tr>
 173 <td><p><span class="term">direction</span></p></td>
 174 <td>source</td>
 175 </tr>
 176 <tr>
 177 <td><p><span class="term">presence</span></p></td>
 178 <td>always</td>
 179 </tr>
 180 <tr>
 181 <td><p><span class="term">details</span></p></td>
 182 <td>audio/x-flac</td>
 183 </tr>
 184 </tbody>
 185 </table></div>
 186 </div>
 187 </div>
 188 <p>
 189 </p>
 190 </div>
 191 <div class="refsect1">
 192 <a name="gst-plugins-good-plugins-flacenc.details"></a><h2>Details</h2>
 193 <div class="refsect2">
 194 <a name="GstFlacEnc-struct"></a><h3>struct GstFlacEnc</h3>
 195 <pre class="programlisting">struct GstFlacEnc;</pre>
 196 <p>
 197 </p>
 198 </div>
 199 </div>
 200 <div class="refsect1">
 201 <a name="gst-plugins-good-plugins-flacenc.property-details"></a><h2>Property Details</h2>
 202 <div class="refsect2">
 203 <a name="GstFlacEnc--blocksize"></a><h3>The <code class="literal">"blocksize"</code> property</h3>
 204 <pre class="programlisting">  "blocksize"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write / Construct</pre>
 205 <p>Blocksize in samples.</p>
 206 <p>Allowed values: [16,65535]</p>
 207 <p>Default value: 4608</p>
 208 </div>
 209 <hr>
 210 <div class="refsect2">
 211 <a name="GstFlacEnc--escape-coding"></a><h3>The <code class="literal">"escape-coding"</code> property</h3>
 212 <pre class="programlisting">  "escape-coding"            <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write / Construct</pre>
 213 <p>search for escape codes in the entropy coding stage for slightly better compression.</p>
 214 <p>Default value: FALSE</p>
 215 </div>
 216 <hr>
 217 <div class="refsect2">
 218 <a name="GstFlacEnc--exhaustive-model-search"></a><h3>The <code class="literal">"exhaustive-model-search"</code> property</h3>
 219 <pre class="programlisting">  "exhaustive-model-search"  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write / Construct</pre>
 220 <p>do exhaustive search of LP coefficient quantization (expensive!).</p>
 221 <p>Default value: FALSE</p>
 222 </div>
 223 <hr>
 224 <div class="refsect2">
 225 <a name="GstFlacEnc--loose-mid-side-stereo"></a><h3>The <code class="literal">"loose-mid-side-stereo"</code> property</h3>
 226 <pre class="programlisting">  "loose-mid-side-stereo"    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write / Construct</pre>
 227 <p>Loose mid side stereo.</p>
 228 <p>Default value: FALSE</p>
 229 </div>
 230 <hr>
 231 <div class="refsect2">
 232 <a name="GstFlacEnc--max-lpc-order"></a><h3>The <code class="literal">"max-lpc-order"</code> property</h3>
 233 <pre class="programlisting">  "max-lpc-order"            <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write / Construct</pre>
 234 <p>Max LPC order; 0 =&gt; use only fixed predictors.</p>
 235 <p>Allowed values: &lt;= 32</p>
 236 <p>Default value: 8</p>
 237 </div>
 238 <hr>
 239 <div class="refsect2">
 240 <a name="GstFlacEnc--max-residual-partition-order"></a><h3>The <code class="literal">"max-residual-partition-order"</code> property</h3>
 241 <pre class="programlisting">  "max-residual-partition-order" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write / Construct</pre>
 242 <p>Max residual partition order (above 4 doesn't usually help much).</p>
 243 <p>Allowed values: &lt;= 16</p>
 244 <p>Default value: 3</p>
 245 </div>
 246 <hr>
 247 <div class="refsect2">
 248 <a name="GstFlacEnc--mid-side-stereo"></a><h3>The <code class="literal">"mid-side-stereo"</code> property</h3>
 249 <pre class="programlisting">  "mid-side-stereo"          <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write / Construct</pre>
 250 <p>Do mid side stereo (only for stereo input).</p>
 251 <p>Default value: TRUE</p>
 252 </div>
 253 <hr>
 254 <div class="refsect2">
 255 <a name="GstFlacEnc--min-residual-partition-order"></a><h3>The <code class="literal">"min-residual-partition-order"</code> property</h3>
 256 <pre class="programlisting">  "min-residual-partition-order" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write / Construct</pre>
 257 <p>Min residual partition order (above 4 doesn't usually help much).</p>
 258 <p>Allowed values: &lt;= 16</p>
 259 <p>Default value: 3</p>
 260 </div>
 261 <hr>
 262 <div class="refsect2">
 263 <a name="GstFlacEnc--qlp-coeff-prec-search"></a><h3>The <code class="literal">"qlp-coeff-prec-search"</code> property</h3>
 264 <pre class="programlisting">  "qlp-coeff-prec-search"    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write / Construct</pre>
 265 <p>false = use qlp_coeff_precision, true = search around qlp_coeff_precision, take best.</p>
 266 <p>Default value: FALSE</p>
 267 </div>
 268 <hr>
 269 <div class="refsect2">
 270 <a name="GstFlacEnc--qlp-coeff-precision"></a><h3>The <code class="literal">"qlp-coeff-precision"</code> property</h3>
 271 <pre class="programlisting">  "qlp-coeff-precision"      <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write / Construct</pre>
 272 <p>Precision in bits of quantized linear-predictor coefficients; 0 = automatic.</p>
 273 <p>Allowed values: &lt;= 32</p>
 274 <p>Default value: 0</p>
 275 </div>
 276 <hr>
 277 <div class="refsect2">
 278 <a name="GstFlacEnc--quality"></a><h3>The <code class="literal">"quality"</code> property</h3>
 279 <pre class="programlisting">  "quality"                  <span class="type">GstFlacEncQuality</span>     : Read / Write / Construct</pre>
 280 <p>Speed versus compression tradeoff.</p>
 281 <p>Default value: 5 - Default</p>
 282 </div>
 283 <hr>
 284 <div class="refsect2">
 285 <a name="GstFlacEnc--rice-parameter-search-dist"></a><h3>The <code class="literal">"rice-parameter-search-dist"</code> property</h3>
 286 <pre class="programlisting">  "rice-parameter-search-dist" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write / Construct</pre>
 287 <p>0 = try only calc'd parameter k; else try all [k-dist..k+dist] parameters, use best.</p>
 288 <p>Allowed values: &lt;= 15</p>
 289 <p>Default value: 0</p>
 290 </div>
 291 <hr>
 292 <div class="refsect2">
 293 <a name="GstFlacEnc--streamable-subset"></a><h3>The <code class="literal">"streamable-subset"</code> property</h3>
 294 <pre class="programlisting">  "streamable-subset"        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write / Construct</pre>
 295 <p>true to limit encoder to generating a Subset stream, else false.</p>
 296 <p>Default value: TRUE</p>
 297 </div>
 298 <hr>
 299 <div class="refsect2">
 300 <a name="GstFlacEnc--padding"></a><h3>The <code class="literal">"padding"</code> property</h3>
 301 <pre class="programlisting">  "padding"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write / Construct</pre>
 302 <p>
 303 Write a PADDING block with this length in bytes
 304 </p>
 305 <p>Default value: 0</p>
 306 <p class="since">Since 0.10.16</p>
 307 </div>
 308 <hr>
 309 <div class="refsect2">
 310 <a name="GstFlacEnc--seekpoints"></a><h3>The <code class="literal">"seekpoints"</code> property</h3>
 311 <pre class="programlisting">  "seekpoints"               <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write / Construct</pre>
 312 <p>
 313 Write a SEEKTABLE block with a specific number of seekpoints
 314 or with a specific interval spacing.
 315 </p>
 316 <p>Allowed values: &gt;= -2147483647</p>
 317 <p>Default value: 0</p>
 318 <p class="since">Since 0.10.18</p>
 319 </div>
 320 </div>
 321 <div class="refsect1">
 322 <a name="gst-plugins-good-plugins-flacenc.see-also"></a><h2>See Also</h2>
 323 <a class="link" href="gst-plugins-good-plugins-flacdec.html#GstFlacDec"><span class="type">GstFlacDec</span></a>
 324 </div>
 325 </div>
 326 <div class="footer">
 327 <hr>
 328           Generated by GTK-Doc V1.17</div>
 329 </body>
 330 </html>