docs/plugins/html/gst-plugins-good-plugins-wavpackenc.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>wavpackenc</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-wavpackdec.html" title="wavpackdec">
  10 <link rel="next" href="gst-plugins-good-plugins-wavpackparse.html" title="wavpackparse">
  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-wavpackdec.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-wavpackparse.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-wavpackenc.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-good-plugins-wavpackenc.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gst-plugins-good-plugins-wavpackenc.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#gst-plugins-good-plugins-wavpackenc.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
  31                    |
  32                   <a href="#gst-plugins-good-plugins-wavpackenc.properties" class="shortcut">Properties</a>
  33 </td></tr>
  34 </table>
  35 <div class="refentry">
  36 <a name="gst-plugins-good-plugins-wavpackenc"></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-wavpackenc.top_of_page"></a>wavpackenc</span></h2>
  40 <p>wavpackenc — Encodes audio with the Wavpack lossless/lossy audio codec</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-wavpackenc.synopsis"></a><h2>Synopsis</h2>
  46 <a name="GstWavpackEnc"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-good-plugins-wavpackenc.html#GstWavpackEnc-struct" title="struct GstWavpackEnc">GstWavpackEnc</a>;
  47 </pre>
  48 </div>
  49 <div class="refsect1">
  50 <a name="gst-plugins-good-plugins-wavpackenc.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                +----GstWavpackEnc
  56 </pre>
  57 </div>
  58 <div class="refsect1">
  59 <a name="gst-plugins-good-plugins-wavpackenc.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
  60 <p>
  61 GstWavpackEnc implements
  62  <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-wavpackenc.properties"></a><h2>Properties</h2>
  66 <pre class="synopsis">
  67   "<a class="link" href="gst-plugins-good-plugins-wavpackenc.html#GstWavpackEnc--bitrate" title='The "bitrate" property'>bitrate</a>"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write
  68   "<a class="link" href="gst-plugins-good-plugins-wavpackenc.html#GstWavpackEnc--bits-per-sample" title='The "bits-per-sample" property'>bits-per-sample</a>"          <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write
  69   "<a class="link" href="gst-plugins-good-plugins-wavpackenc.html#GstWavpackEnc--correction-mode" title='The "correction-mode" property'>correction-mode</a>"          <span class="type">GstWavpackEncCorrectionMode</span>  : Read / Write
  70   "<a class="link" href="gst-plugins-good-plugins-wavpackenc.html#GstWavpackEnc--extra-processing" title='The "extra-processing" property'>extra-processing</a>"         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write
  71   "<a class="link" href="gst-plugins-good-plugins-wavpackenc.html#GstWavpackEnc--joint-stereo-mode" title='The "joint-stereo-mode" property'>joint-stereo-mode</a>"        <span class="type">GstWavpackEncJSMode</span>   : Read / Write
  72   "<a class="link" href="gst-plugins-good-plugins-wavpackenc.html#GstWavpackEnc--md5" title='The "md5" property'>md5</a>"                      <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  73   "<a class="link" href="gst-plugins-good-plugins-wavpackenc.html#GstWavpackEnc--mode" title='The "mode" property'>mode</a>"                     <span class="type">GstWavpackEncMode</span>     : Read / Write
  74 </pre>
  75 </div>
  76 <div class="refsect1">
  77 <a name="gst-plugins-good-plugins-wavpackenc.description"></a><h2>Description</h2>
  78 <p>
  79 WavpackEnc encodes raw audio into a framed Wavpack stream.
  80 <a class="ulink" href="http://www.wavpack.com/" target="_top">Wavpack</a> is an open-source
  81 audio codec that features both lossless and lossy encoding.
  82 </p>
  83 <p>
  84 </p>
  85 <div class="refsect2">
  86 <a name="idp20263248"></a><h3>Example launch line</h3>
  87 <div class="informalexample">
  88   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
  89     <tbody>
  90       <tr>
  91         <td class="listing_lines" align="right"><pre>1</pre></td>
  92         <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">500</span> <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> wavpackenc <span class="gtkdoc opt">!</span> filesink location<span class="gtkdoc opt">=</span>sinewave<span class="gtkdoc opt">.</span>wv</pre></td>
  93       </tr>
  94     </tbody>
  95   </table>
  96 </div>
  97  This pipeline encodes audio from audiotestsrc into a Wavpack file. The audioconvert element is needed
  98 as the Wavpack encoder only accepts input with 32 bit width (and every depth between 1 and 32 bits).
  99 <div class="informalexample">
 100   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 101     <tbody>
 102       <tr>
 103         <td class="listing_lines" align="right"><pre>1</pre></td>
 104         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch cdda<span class="gtkdoc opt">:</span><span class="gtkdoc slc">//1 ! audioconvert ! wavpackenc ! filesink location=track1.wv</span></pre></td>
 105       </tr>
 106     </tbody>
 107   </table>
 108 </div>
 109  This pipeline encodes audio from an audio CD into a Wavpack file using
 110 lossless encoding (the file output will be fairly large).
 111 <div class="informalexample">
 112   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 113     <tbody>
 114       <tr>
 115         <td class="listing_lines" align="right"><pre>1</pre></td>
 116         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch cdda<span class="gtkdoc opt">:</span><span class="gtkdoc slc">//1 ! audioconvert ! wavpackenc bitrate=128000 ! filesink location=track1.wv</span></pre></td>
 117       </tr>
 118     </tbody>
 119   </table>
 120 </div>
 121  This pipeline encodes audio from an audio CD into a Wavpack file using
 122 lossy encoding at a certain bitrate (the file will be fairly small).
 123 </div>
 124 <p>
 125 </p>
 126 <div class="refsynopsisdiv">
 127 <h2>Synopsis</h2>
 128 <div class="refsect2">
 129 <a name="idp7713696"></a><h3>Element Information</h3>
 130 <div class="variablelist"><table border="0">
 131 <col align="left" valign="top">
 132 <tbody>
 133 <tr>
 134 <td><p><span class="term">plugin</span></p></td>
 135 <td>
 136             <a class="link" href="gst-plugins-good-plugins-plugin-wavpack.html#plugin-wavpack">wavpack</a>
 137           </td>
 138 </tr>
 139 <tr>
 140 <td><p><span class="term">author</span></p></td>
 141 <td>Sebastian Dröge &lt;slomo@circular-chaos.org&gt;</td>
 142 </tr>
 143 <tr>
 144 <td><p><span class="term">class</span></p></td>
 145 <td>Codec/Encoder/Audio</td>
 146 </tr>
 147 </tbody>
 148 </table></div>
 149 </div>
 150 <hr>
 151 <div class="refsect2">
 152 <a name="idp22649264"></a><h3>Element Pads</h3>
 153 <div class="variablelist"><table border="0">
 154 <col align="left" valign="top">
 155 <tbody>
 156 <tr>
 157 <td><p><span class="term">name</span></p></td>
 158 <td>sink</td>
 159 </tr>
 160 <tr>
 161 <td><p><span class="term">direction</span></p></td>
 162 <td>sink</td>
 163 </tr>
 164 <tr>
 165 <td><p><span class="term">presence</span></p></td>
 166 <td>always</td>
 167 </tr>
 168 <tr>
 169 <td><p><span class="term">details</span></p></td>
 170 <td>audio/x-raw-int, width=(int)32, depth=(int)[ 1, 32 ], endianness=(int)1234, channels=(int)[ 1, 8 ], rate=(int)[ 6000, 192000 ], signed=(boolean)true</td>
 171 </tr>
 172 </tbody>
 173 </table></div>
 174 <div class="variablelist"><table border="0">
 175 <col align="left" valign="top">
 176 <tbody>
 177 <tr>
 178 <td><p><span class="term">name</span></p></td>
 179 <td>src</td>
 180 </tr>
 181 <tr>
 182 <td><p><span class="term">direction</span></p></td>
 183 <td>source</td>
 184 </tr>
 185 <tr>
 186 <td><p><span class="term">presence</span></p></td>
 187 <td>always</td>
 188 </tr>
 189 <tr>
 190 <td><p><span class="term">details</span></p></td>
 191 <td>audio/x-wavpack, width=(int)[ 1, 32 ], channels=(int)[ 1, 2 ], rate=(int)[ 6000, 192000 ], framed=(boolean)true</td>
 192 </tr>
 193 </tbody>
 194 </table></div>
 195 <div class="variablelist"><table border="0">
 196 <col align="left" valign="top">
 197 <tbody>
 198 <tr>
 199 <td><p><span class="term">name</span></p></td>
 200 <td>wvcsrc</td>
 201 </tr>
 202 <tr>
 203 <td><p><span class="term">direction</span></p></td>
 204 <td>source</td>
 205 </tr>
 206 <tr>
 207 <td><p><span class="term">presence</span></p></td>
 208 <td>sometimes</td>
 209 </tr>
 210 <tr>
 211 <td><p><span class="term">details</span></p></td>
 212 <td>audio/x-wavpack-correction, framed=(boolean)true</td>
 213 </tr>
 214 </tbody>
 215 </table></div>
 216 </div>
 217 </div>
 218 <p>
 219 </p>
 220 </div>
 221 <div class="refsect1">
 222 <a name="gst-plugins-good-plugins-wavpackenc.details"></a><h2>Details</h2>
 223 <div class="refsect2">
 224 <a name="GstWavpackEnc-struct"></a><h3>struct GstWavpackEnc</h3>
 225 <pre class="programlisting">struct GstWavpackEnc;</pre>
 226 <p>
 227 </p>
 228 </div>
 229 </div>
 230 <div class="refsect1">
 231 <a name="gst-plugins-good-plugins-wavpackenc.property-details"></a><h2>Property Details</h2>
 232 <div class="refsect2">
 233 <a name="GstWavpackEnc--bitrate"></a><h3>The <code class="literal">"bitrate"</code> property</h3>
 234 <pre class="programlisting">  "bitrate"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write</pre>
 235 <p>Try to encode with this average bitrate (bits/sec). This enables lossy encoding, values smaller than 24000 disable it again.</p>
 236 <p>Allowed values: &lt;= 9600000</p>
 237 <p>Default value: 0</p>
 238 </div>
 239 <hr>
 240 <div class="refsect2">
 241 <a name="GstWavpackEnc--bits-per-sample"></a><h3>The <code class="literal">"bits-per-sample"</code> property</h3>
 242 <pre class="programlisting">  "bits-per-sample"          <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write</pre>
 243 <p>Try to encode with this amount of bits per sample. This enables lossy encoding, values smaller than 2.0 disable it again.</p>
 244 <p>Allowed values: [0,24]</p>
 245 <p>Default value: 0</p>
 246 </div>
 247 <hr>
 248 <div class="refsect2">
 249 <a name="GstWavpackEnc--correction-mode"></a><h3>The <code class="literal">"correction-mode"</code> property</h3>
 250 <pre class="programlisting">  "correction-mode"          <span class="type">GstWavpackEncCorrectionMode</span>  : Read / Write</pre>
 251 <p>Use this mode for the correction stream. Only works in lossy mode!.</p>
 252 <p>Default value: Create no correction file</p>
 253 </div>
 254 <hr>
 255 <div class="refsect2">
 256 <a name="GstWavpackEnc--extra-processing"></a><h3>The <code class="literal">"extra-processing"</code> property</h3>
 257 <pre class="programlisting">  "extra-processing"         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write</pre>
 258 <p>Use better but slower filters for better compression/quality.</p>
 259 <p>Allowed values: &lt;= 6</p>
 260 <p>Default value: 0</p>
 261 </div>
 262 <hr>
 263 <div class="refsect2">
 264 <a name="GstWavpackEnc--joint-stereo-mode"></a><h3>The <code class="literal">"joint-stereo-mode"</code> property</h3>
 265 <pre class="programlisting">  "joint-stereo-mode"        <span class="type">GstWavpackEncJSMode</span>   : Read / Write</pre>
 266 <p>Use this joint-stereo mode.</p>
 267 <p>Default value: auto</p>
 268 </div>
 269 <hr>
 270 <div class="refsect2">
 271 <a name="GstWavpackEnc--md5"></a><h3>The <code class="literal">"md5"</code> property</h3>
 272 <pre class="programlisting">  "md5"                      <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 273 <p>Store MD5 hash of raw samples within the file.</p>
 274 <p>Default value: FALSE</p>
 275 </div>
 276 <hr>
 277 <div class="refsect2">
 278 <a name="GstWavpackEnc--mode"></a><h3>The <code class="literal">"mode"</code> property</h3>
 279 <pre class="programlisting">  "mode"                     <span class="type">GstWavpackEncMode</span>     : Read / Write</pre>
 280 <p>Speed versus compression tradeoff.</p>
 281 <p>Default value: Normal Compression</p>
 282 </div>
 283 </div>
 284 </div>
 285 <div class="footer">
 286 <hr>
 287           Generated by GTK-Doc V1.17</div>
 288 </body>
 289 </html>