• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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: GStreamer Good 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 Good Plugins 1.0 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.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">|</span18                  <a href="#gst-plugins-good-plugins-wavpackenc.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span19                  <a href="#gst-plugins-good-plugins-wavpackenc.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span20                  <a href="#gst-plugins-good-plugins-wavpackenc.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties">  <span class="dim">|</span21                  <a href="#gst-plugins-good-plugins-wavpackenc.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-good-plugins-wavpackdec.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
26<td><a accesskey="n" href="gst-plugins-good-plugins-wavpackparse.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-good-plugins-wavpackenc"></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-good-plugins-wavpackenc.top_of_page"></a>wavpackenc</span></h2>
33<p>wavpackenc</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-good-plugins-wavpackenc.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#guint"><span class="type">guint</span></a></td>
48<td class="property_name"><a class="link" href="gst-plugins-good-plugins-wavpackenc.html#GstWavpackEnc--bitrate" title="The “bitrate” property">bitrate</a></td>
49<td class="property_flags">Read / Write</td>
50</tr>
51<tr>
52<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></td>
53<td class="property_name"><a class="link" href="gst-plugins-good-plugins-wavpackenc.html#GstWavpackEnc--bits-per-sample" title="The “bits-per-sample” property">bits-per-sample</a></td>
54<td class="property_flags">Read / Write</td>
55</tr>
56<tr>
57<td class="property_type"><span class="type">GstWavpackEncCorrectionMode</span></td>
58<td class="property_name"><a class="link" href="gst-plugins-good-plugins-wavpackenc.html#GstWavpackEnc--correction-mode" title="The “correction-mode” property">correction-mode</a></td>
59<td class="property_flags">Read / Write</td>
60</tr>
61<tr>
62<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td>
63<td class="property_name"><a class="link" href="gst-plugins-good-plugins-wavpackenc.html#GstWavpackEnc--extra-processing" title="The “extra-processing” property">extra-processing</a></td>
64<td class="property_flags">Read / Write</td>
65</tr>
66<tr>
67<td class="property_type"><span class="type">GstWavpackEncJSMode</span></td>
68<td class="property_name"><a class="link" href="gst-plugins-good-plugins-wavpackenc.html#GstWavpackEnc--joint-stereo-mode" title="The “joint-stereo-mode” property">joint-stereo-mode</a></td>
69<td class="property_flags">Read / Write</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-good-plugins-wavpackenc.html#GstWavpackEnc--md5" title="The “md5” property">md5</a></td>
74<td class="property_flags">Read / Write</td>
75</tr>
76<tr>
77<td class="property_type"><span class="type">GstWavpackEncMode</span></td>
78<td class="property_name"><a class="link" href="gst-plugins-good-plugins-wavpackenc.html#GstWavpackEnc--mode" title="The “mode” property">mode</a></td>
79<td class="property_flags">Read / Write</td>
80</tr>
81</tbody>
82</table></div>
83</div>
84<a name="GstWavpackEnc"></a><div class="refsect1">
85<a name="gst-plugins-good-plugins-wavpackenc.other"></a><h2>Types and Values</h2>
86<div class="informaltable"><table class="informaltable" width="100%" border="0">
87<colgroup>
88<col width="150px" class="name">
89<col class="description">
90</colgroup>
91<tbody><tr>
92<td class="datatype_keyword">struct</td>
93<td class="function_name"><a class="link" href="gst-plugins-good-plugins-wavpackenc.html#GstWavpackEnc-struct" title="struct GstWavpackEnc">GstWavpackEnc</a></td>
94</tr></tbody>
95</table></div>
96</div>
97<div class="refsect1">
98<a name="gst-plugins-good-plugins-wavpackenc.object-hierarchy"></a><h2>Object Hierarchy</h2>
99<pre class="screen">    <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
100    <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
101        <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a>
102            <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a>
103                <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gst-plugins-base-libs-1.0/GstAudioEncoder.html#GstAudioEncoder-struct">GstAudioEncoder</a>
104                    <span class="lineart">╰──</span> GstWavpackEnc
105</pre>
106</div>
107<div class="refsect1">
108<a name="gst-plugins-good-plugins-wavpackenc.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
109<p>
110GstWavpackEnc implements
111 <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstPreset.html#GstPreset-struct">GstPreset</a>.</p>
112</div>
113<div class="refsect1">
114<a name="gst-plugins-good-plugins-wavpackenc.description"></a><h2>Description</h2>
115<p>WavpackEnc encodes raw audio into a framed Wavpack stream.</p>
116<a class="ulink" href="http://www.wavpack.com/" target="_top">Wavpack</a> is an open-source
117<p>audio codec that features both lossless and lossy encoding.</p>
118<div class="refsect2">
119<a name="id-1.2.279.8.5"></a><h3>Example launch line</h3>
120<div class="informalexample">
121  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
122    <tbody>
123      <tr>
124        <td class="listing_lines" align="right"><pre>1</pre></td>
125        <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 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>
126      </tr>
127    </tbody>
128  </table>
129</div>
130 This pipeline encodes audio from audiotestsrc into a Wavpack file. The audioconvert element is needed
131as the Wavpack encoder only accepts input with 32 bit width.
132<div class="informalexample">
133  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
134    <tbody>
135      <tr>
136        <td class="listing_lines" align="right"><pre>1</pre></td>
137        <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> cdda<span class="gtkdoc opt">:</span><span class="gtkdoc slc">//1 ! audioconvert ! wavpackenc ! filesink location=track1.wv</span></pre></td>
138      </tr>
139    </tbody>
140  </table>
141</div>
142 This pipeline encodes audio from an audio CD into a Wavpack file using
143lossless encoding (the file output will be fairly large).
144<div class="informalexample">
145  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
146    <tbody>
147      <tr>
148        <td class="listing_lines" align="right"><pre>1</pre></td>
149        <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> cdda<span class="gtkdoc opt">:</span><span class="gtkdoc slc">//1 ! audioconvert ! wavpackenc bitrate=128000 ! filesink location=track1.wv</span></pre></td>
150      </tr>
151    </tbody>
152  </table>
153</div>
154 This pipeline encodes audio from an audio CD into a Wavpack file using
155lossy encoding at a certain bitrate (the file will be fairly small).
156</div>
157<div class="refsynopsisdiv">
158<h2>Synopsis</h2>
159<div class="refsect2">
160<a name="id-1.2.279.8.6.1"></a><h3>Element Information</h3>
161<div class="variablelist"><table border="0" class="variablelist">
162<colgroup>
163<col align="left" valign="top">
164<col>
165</colgroup>
166<tbody>
167<tr>
168<td><p><span class="term">plugin</span></p></td>
169<td>
170            <a class="link" href="gst-plugins-good-plugins-plugin-wavpack.html#plugin-wavpack">wavpack</a>
171          </td>
172</tr>
173<tr>
174<td><p><span class="term">author</span></p></td>
175<td>Sebastian Dröge &lt;slomo@circular-chaos.org&gt;</td>
176</tr>
177<tr>
178<td><p><span class="term">class</span></p></td>
179<td>Codec/Encoder/Audio</td>
180</tr>
181</tbody>
182</table></div>
183</div>
184<hr>
185<div class="refsect2">
186<a name="id-1.2.279.8.6.2"></a><h3>Element Pads</h3>
187<div class="variablelist"><table border="0" class="variablelist">
188<colgroup>
189<col align="left" valign="top">
190<col>
191</colgroup>
192<tbody>
193<tr>
194<td><p><span class="term">name</span></p></td>
195<td>sink</td>
196</tr>
197<tr>
198<td><p><span class="term">direction</span></p></td>
199<td>sink</td>
200</tr>
201<tr>
202<td><p><span class="term">presence</span></p></td>
203<td>always</td>
204</tr>
205<tr>
206<td><p><span class="term">details</span></p></td>
207<td>audio/x-raw, format=(string)S32LE, layout=(string)interleaved, channels=(int)[ 1, 8 ], rate=(int)[ 6000, 192000 ]</td>
208</tr>
209</tbody>
210</table></div>
211<div class="variablelist"><table border="0" class="variablelist">
212<colgroup>
213<col align="left" valign="top">
214<col>
215</colgroup>
216<tbody>
217<tr>
218<td><p><span class="term">name</span></p></td>
219<td>src</td>
220</tr>
221<tr>
222<td><p><span class="term">direction</span></p></td>
223<td>source</td>
224</tr>
225<tr>
226<td><p><span class="term">presence</span></p></td>
227<td>always</td>
228</tr>
229<tr>
230<td><p><span class="term">details</span></p></td>
231<td>audio/x-wavpack, depth=(int)[ 1, 32 ], channels=(int)[ 1, 8 ], rate=(int)[ 6000, 192000 ], framed=(boolean)true</td>
232</tr>
233</tbody>
234</table></div>
235<div class="variablelist"><table border="0" class="variablelist">
236<colgroup>
237<col align="left" valign="top">
238<col>
239</colgroup>
240<tbody>
241<tr>
242<td><p><span class="term">name</span></p></td>
243<td>wvcsrc</td>
244</tr>
245<tr>
246<td><p><span class="term">direction</span></p></td>
247<td>source</td>
248</tr>
249<tr>
250<td><p><span class="term">presence</span></p></td>
251<td>sometimes</td>
252</tr>
253<tr>
254<td><p><span class="term">details</span></p></td>
255<td>audio/x-wavpack-correction, framed=(boolean)true</td>
256</tr>
257</tbody>
258</table></div>
259</div>
260</div>
261</div>
262<div class="refsect1">
263<a name="gst-plugins-good-plugins-wavpackenc.functions_details"></a><h2>Functions</h2>
264<p></p>
265</div>
266<div class="refsect1">
267<a name="gst-plugins-good-plugins-wavpackenc.other_details"></a><h2>Types and Values</h2>
268<div class="refsect2">
269<a name="GstWavpackEnc-struct"></a><h3>struct GstWavpackEnc</h3>
270<pre class="programlisting">struct GstWavpackEnc;</pre>
271</div>
272</div>
273<div class="refsect1">
274<a name="gst-plugins-good-plugins-wavpackenc.property-details"></a><h2>Property Details</h2>
275<div class="refsect2">
276<a name="GstWavpackEnc--bitrate"></a><h3>The <code class="literal">“bitrate”</code> property</h3>
277<pre class="programlisting">  “bitrate”                  <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre>
278<p>Try to encode with this average bitrate (bits/sec). This enables lossy encoding, values smaller than 24000 disable it again.</p>
279<p>Flags: Read / Write</p>
280<p>Allowed values: &lt;= 9600000</p>
281<p>Default value: 0</p>
282</div>
283<hr>
284<div class="refsect2">
285<a name="GstWavpackEnc--bits-per-sample"></a><h3>The <code class="literal">“bits-per-sample”</code> property</h3>
286<pre class="programlisting">  “bits-per-sample”          <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre>
287<p>Try to encode with this amount of bits per sample. This enables lossy encoding, values smaller than 2.0 disable it again.</p>
288<p>Flags: Read / Write</p>
289<p>Allowed values: [0,24]</p>
290<p>Default value: 0</p>
291</div>
292<hr>
293<div class="refsect2">
294<a name="GstWavpackEnc--correction-mode"></a><h3>The <code class="literal">“correction-mode”</code> property</h3>
295<pre class="programlisting">  “correction-mode”          <span class="type">GstWavpackEncCorrectionMode</span></pre>
296<p>Use this mode for the correction stream. Only works in lossy mode!.</p>
297<p>Flags: Read / Write</p>
298<p>Default value: Create no correction file</p>
299</div>
300<hr>
301<div class="refsect2">
302<a name="GstWavpackEnc--extra-processing"></a><h3>The <code class="literal">“extra-processing”</code> property</h3>
303<pre class="programlisting">  “extra-processing”         <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre>
304<p>Use better but slower filters for better compression/quality.</p>
305<p>Flags: Read / Write</p>
306<p>Allowed values: &lt;= 6</p>
307<p>Default value: 0</p>
308</div>
309<hr>
310<div class="refsect2">
311<a name="GstWavpackEnc--joint-stereo-mode"></a><h3>The <code class="literal">“joint-stereo-mode”</code> property</h3>
312<pre class="programlisting">  “joint-stereo-mode”        <span class="type">GstWavpackEncJSMode</span></pre>
313<p>Use this joint-stereo mode.</p>
314<p>Flags: Read / Write</p>
315<p>Default value: auto</p>
316</div>
317<hr>
318<div class="refsect2">
319<a name="GstWavpackEnc--md5"></a><h3>The <code class="literal">“md5”</code> property</h3>
320<pre class="programlisting">  “md5”                      <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
321<p>Store MD5 hash of raw samples within the file.</p>
322<p>Flags: Read / Write</p>
323<p>Default value: FALSE</p>
324</div>
325<hr>
326<div class="refsect2">
327<a name="GstWavpackEnc--mode"></a><h3>The <code class="literal">“mode”</code> property</h3>
328<pre class="programlisting">  “mode”                     <span class="type">GstWavpackEncMode</span></pre>
329<p>Speed versus compression tradeoff.</p>
330<p>Flags: Read / Write</p>
331<p>Default value: Normal Compression</p>
332</div>
333</div>
334</div>
335<div class="footer">
336<hr>Generated by GTK-Doc V1.28</div>
337</body>
338</html>