4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
<title>audioconvert</title>
5
<title>GStreamer Base Plugins 1.0 Plugins Reference Manual: audioconvert</title>
6
6
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7
7
<link rel="home" href="index.html" title="GStreamer Base Plugins 1.0 Plugins Reference Manual">
8
8
<link rel="up" href="ch01.html" title="gst-plugins-base Elements">
9
9
<link rel="prev" href="gst-plugins-base-plugins-alsasrc.html" title="alsasrc">
10
10
<link rel="next" href="gst-plugins-base-plugins-audiorate.html" title="audiorate">
11
<meta name="generator" content="GTK-Doc V1.19 (XML mode)">
11
<meta name="generator" content="GTK-Doc V1.20 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
14
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">
17
<td><a accesskey="p" href="gst-plugins-base-plugins-alsasrc.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 Base Plugins 1.0 Plugins Reference Manual</th>
21
<td><a accesskey="n" href="gst-plugins-base-plugins-audiorate.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
23
<tr><td colspan="5" class="shortcuts">
24
<a href="#gst-plugins-base-plugins-audioconvert.synopsis" class="shortcut">Top</a>
26
<a href="#gst-plugins-base-plugins-audioconvert.description" class="shortcut">Description</a>
28
<a href="#gst-plugins-base-plugins-audioconvert.object-hierarchy" class="shortcut">Object Hierarchy</a>
30
<a href="#gst-plugins-base-plugins-audioconvert.properties" class="shortcut">Properties</a>
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><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-base-plugins-audioconvert.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
19
<a href="#gst-plugins-base-plugins-audioconvert.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span>
20
<a href="#gst-plugins-base-plugins-audioconvert.properties" class="shortcut">Properties</a></span>
22
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
23
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
24
<td><a accesskey="p" href="gst-plugins-base-plugins-alsasrc.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
25
<td><a accesskey="n" href="gst-plugins-base-plugins-audiorate.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
33
27
<div class="refentry">
34
28
<a name="gst-plugins-base-plugins-audioconvert"></a><div class="titlepage"></div>
35
29
<div class="refnamediv"><table width="100%"><tr>
37
31
<h2><span class="refentrytitle"><a name="gst-plugins-base-plugins-audioconvert.top_of_page"></a>audioconvert</span></h2>
38
32
<p>audioconvert — Convert audio to different formats</p>
40
<td valign="top" align="right"></td>
34
<td class="gallery_image" valign="top" align="right"></td>
41
35
</tr></table></div>
42
<div class="refsynopsisdiv">
43
<a name="gst-plugins-base-plugins-audioconvert.synopsis"></a><h2>Synopsis</h2>
44
<a name="GstAudioConvert"></a><pre class="synopsis">struct <a class="link" href="gst-plugins-base-plugins-audioconvert.html#GstAudioConvert-struct" title="struct GstAudioConvert">GstAudioConvert</a>;
45
enum <a class="link" href="gst-plugins-base-plugins-audioconvert.html#GstAudioConvertDithering" title="enum GstAudioConvertDithering">GstAudioConvertDithering</a>;
46
enum <a class="link" href="gst-plugins-base-plugins-audioconvert.html#GstAudioConvertNoiseShaping" title="enum GstAudioConvertNoiseShaping">GstAudioConvertNoiseShaping</a>;
36
<div class="refsect1">
37
<a name="gst-plugins-base-plugins-audioconvert.properties"></a><h2>Properties</h2>
38
<div class="informaltable"><table border="0">
40
<col width="150px" class="properties_type">
41
<col width="300px" class="properties_name">
42
<col width="200px" class="properties_flags">
46
<td class="property_type"><a class="link" href="gst-plugins-base-plugins-audioconvert.html#GstAudioConvertDithering" title="enum GstAudioConvertDithering"><span class="type">GstAudioConvertDithering</span></a></td>
47
<td class="property_name"><a class="link" href="gst-plugins-base-plugins-audioconvert.html#GstAudioConvert--dithering" title="The “dithering” property">dithering</a></td>
48
<td class="property_flags">Read / Write</td>
51
<td class="property_type"><a class="link" href="gst-plugins-base-plugins-audioconvert.html#GstAudioConvertNoiseShaping" title="enum GstAudioConvertNoiseShaping"><span class="type">GstAudioConvertNoiseShaping</span></a></td>
52
<td class="property_name"><a class="link" href="gst-plugins-base-plugins-audioconvert.html#GstAudioConvert--noise-shaping" title="The “noise-shaping” property">noise-shaping</a></td>
53
<td class="property_flags">Read / Write</td>
58
<a name="GstAudioConvert"></a><div class="refsect1">
59
<a name="gst-plugins-base-plugins-audioconvert.other"></a><h2>Types and Values</h2>
60
<div class="informaltable"><table width="100%" border="0">
62
<col width="150px" class="name">
63
<col class="description">
67
<td class="datatype_keyword">struct</td>
68
<td class="function_name"><a class="link" href="gst-plugins-base-plugins-audioconvert.html#GstAudioConvert-struct" title="struct GstAudioConvert">GstAudioConvert</a></td>
71
<td class="datatype_keyword">enum</td>
72
<td class="function_name"><a class="link" href="gst-plugins-base-plugins-audioconvert.html#GstAudioConvertDithering" title="enum GstAudioConvertDithering">GstAudioConvertDithering</a></td>
75
<td class="datatype_keyword">enum</td>
76
<td class="function_name"><a class="link" href="gst-plugins-base-plugins-audioconvert.html#GstAudioConvertNoiseShaping" title="enum GstAudioConvertNoiseShaping">GstAudioConvertNoiseShaping</a></td>
49
81
<div class="refsect1">
50
82
<a name="gst-plugins-base-plugins-audioconvert.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://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
54
+----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
55
+----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
56
+----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstBaseTransform.html">GstBaseTransform</a>
60
<div class="refsect1">
61
<a name="gst-plugins-base-plugins-audioconvert.properties"></a><h2>Properties</h2>
62
<pre class="synopsis">
63
"<a class="link" href="gst-plugins-base-plugins-audioconvert.html#GstAudioConvert--dithering" title='The "dithering" property'>dithering</a>" <a class="link" href="gst-plugins-base-plugins-audioconvert.html#GstAudioConvertDithering" title="enum GstAudioConvertDithering"><span class="type">GstAudioConvertDithering</span></a> : Read / Write
64
"<a class="link" href="gst-plugins-base-plugins-audioconvert.html#GstAudioConvert--noise-shaping" title='The "noise-shaping" property'>noise-shaping</a>" <a class="link" href="gst-plugins-base-plugins-audioconvert.html#GstAudioConvertNoiseShaping" title="enum GstAudioConvertNoiseShaping"><span class="type">GstAudioConvertNoiseShaping</span></a> : Read / Write
83
<pre class="screen"> <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
84
<span class="lineart">╰──</span> <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
85
<span class="lineart">╰──</span> <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
86
<span class="lineart">╰──</span> <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
87
<span class="lineart">╰──</span> <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstBaseTransform.html">GstBaseTransform</a>
88
<span class="lineart">╰──</span> GstAudioConvert
67
91
<div class="refsect1">
68
92
<a name="gst-plugins-base-plugins-audioconvert.description"></a><h2>Description</h2>
70
Audioconvert converts raw audio buffers between various possible formats.
93
<p>Audioconvert converts raw audio buffers between various possible formats.
71
94
It supports integer to float conversion, width/depth conversion,
72
signedness and endianness conversion and channel transformations.
95
signedness and endianness conversion and channel transformations.</p>
76
96
<div class="refsect2">
77
<a name="id-1.2.7.6.3.1"></a><h3>Example launch line</h3>
97
<a name="id-1.2.7.7.3"></a><h3>Example launch line</h3>
78
98
<div class="informalexample">
79
99
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
191
207
<div class="refsect1">
192
<a name="gst-plugins-base-plugins-audioconvert.details"></a><h2>Details</h2>
208
<a name="gst-plugins-base-plugins-audioconvert.functions_details"></a><h2>Functions</h2>
210
<div class="refsect1">
211
<a name="gst-plugins-base-plugins-audioconvert.other_details"></a><h2>Types and Values</h2>
193
212
<div class="refsect2">
194
213
<a name="GstAudioConvert-struct"></a><h3>struct GstAudioConvert</h3>
195
214
<pre class="programlisting">struct GstAudioConvert;</pre>
197
The audioconvert object structure.
215
<p>The audioconvert object structure.</p>
201
218
<div class="refsect2">
202
219
<a name="GstAudioConvertDithering"></a><h3>enum GstAudioConvertDithering</h3>
203
<pre class="programlisting">typedef enum {
208
} GstAudioConvertDithering;
211
Set of available dithering methods when converting audio.
213
<div class="variablelist"><table border="0" class="variablelist">
220
<p>Set of available dithering methods when converting audio.</p>
221
<div class="refsect3">
222
<a name="id-1.2.7.9.3.4"></a><h4>Members</h4>
223
<div class="informaltable"><table width="100%" border="0">
215
<col align="left" valign="top">
225
<col width="300px" class="enum_members_name">
226
<col class="enum_members_description">
227
<col width="200px" class="enum_members_annotations">
220
<td><p><a name="DITHER-NONE:CAPS"></a><span class="term"><code class="literal">DITHER_NONE</code></span></p></td>
225
<td><p><a name="DITHER-RPDF:CAPS"></a><span class="term"><code class="literal">DITHER_RPDF</code></span></p></td>
226
<td>Rectangular dithering
230
<td><p><a name="DITHER-TPDF:CAPS"></a><span class="term"><code class="literal">DITHER_TPDF</code></span></p></td>
231
<td>Triangular dithering (default)
235
<td><p><a name="DITHER-TPDF-HF:CAPS"></a><span class="term"><code class="literal">DITHER_TPDF_HF</code></span></p></td>
236
<td>High frequency triangular dithering
231
<td class="enum_member_name"><p><a name="DITHER-NONE:CAPS"></a>DITHER_NONE</p></td>
232
<td class="enum_member_description">
235
<td class="enum_member_annotations"> </td>
238
<td class="enum_member_name"><p><a name="DITHER-RPDF:CAPS"></a>DITHER_RPDF</p></td>
239
<td class="enum_member_description">
240
<p>Rectangular dithering</p>
242
<td class="enum_member_annotations"> </td>
245
<td class="enum_member_name"><p><a name="DITHER-TPDF:CAPS"></a>DITHER_TPDF</p></td>
246
<td class="enum_member_description">
247
<p>Triangular dithering (default)</p>
249
<td class="enum_member_annotations"> </td>
252
<td class="enum_member_name"><p><a name="DITHER-TPDF-HF:CAPS"></a>DITHER_TPDF_HF</p></td>
253
<td class="enum_member_description">
254
<p>High frequency triangular dithering</p>
256
<td class="enum_member_annotations"> </td>
243
263
<div class="refsect2">
244
264
<a name="GstAudioConvertNoiseShaping"></a><h3>enum GstAudioConvertNoiseShaping</h3>
245
<pre class="programlisting">typedef enum {
246
NOISE_SHAPING_NONE = 0,
247
NOISE_SHAPING_ERROR_FEEDBACK,
248
NOISE_SHAPING_SIMPLE,
249
NOISE_SHAPING_MEDIUM,
251
} GstAudioConvertNoiseShaping;
254
Set of available noise shaping methods
256
<div class="variablelist"><table border="0" class="variablelist">
265
<p>Set of available noise shaping methods</p>
266
<div class="refsect3">
267
<a name="id-1.2.7.9.4.4"></a><h4>Members</h4>
268
<div class="informaltable"><table width="100%" border="0">
258
<col align="left" valign="top">
270
<col width="300px" class="enum_members_name">
271
<col class="enum_members_description">
272
<col width="200px" class="enum_members_annotations">
263
<td><p><a name="NOISE-SHAPING-NONE:CAPS"></a><span class="term"><code class="literal">NOISE_SHAPING_NONE</code></span></p></td>
264
<td>No noise shaping (default)
268
<td><p><a name="NOISE-SHAPING-ERROR-FEEDBACK:CAPS"></a><span class="term"><code class="literal">NOISE_SHAPING_ERROR_FEEDBACK</code></span></p></td>
273
<td><p><a name="NOISE-SHAPING-SIMPLE:CAPS"></a><span class="term"><code class="literal">NOISE_SHAPING_SIMPLE</code></span></p></td>
274
<td>Simple 2-pole noise shaping
278
<td><p><a name="NOISE-SHAPING-MEDIUM:CAPS"></a><span class="term"><code class="literal">NOISE_SHAPING_MEDIUM</code></span></p></td>
279
<td>Medium 5-pole noise shaping
283
<td><p><a name="NOISE-SHAPING-HIGH:CAPS"></a><span class="term"><code class="literal">NOISE_SHAPING_HIGH</code></span></p></td>
284
<td>High 8-pole noise shaping
276
<td class="enum_member_name"><p><a name="NOISE-SHAPING-NONE:CAPS"></a>NOISE_SHAPING_NONE</p></td>
277
<td class="enum_member_description">
278
<p>No noise shaping (default)</p>
280
<td class="enum_member_annotations"> </td>
283
<td class="enum_member_name"><p><a name="NOISE-SHAPING-ERROR-FEEDBACK:CAPS"></a>NOISE_SHAPING_ERROR_FEEDBACK</p></td>
284
<td class="enum_member_description">
285
<p>Error feedback</p>
287
<td class="enum_member_annotations"> </td>
290
<td class="enum_member_name"><p><a name="NOISE-SHAPING-SIMPLE:CAPS"></a>NOISE_SHAPING_SIMPLE</p></td>
291
<td class="enum_member_description">
292
<p>Simple 2-pole noise shaping</p>
294
<td class="enum_member_annotations"> </td>
297
<td class="enum_member_name"><p><a name="NOISE-SHAPING-MEDIUM:CAPS"></a>NOISE_SHAPING_MEDIUM</p></td>
298
<td class="enum_member_description">
299
<p>Medium 5-pole noise shaping</p>
301
<td class="enum_member_annotations"> </td>
304
<td class="enum_member_name"><p><a name="NOISE-SHAPING-HIGH:CAPS"></a>NOISE_SHAPING_HIGH</p></td>
305
<td class="enum_member_description">
306
<p>High 8-pole noise shaping</p>
308
<td class="enum_member_annotations"> </td>
291
315
<div class="refsect1">
292
316
<a name="gst-plugins-base-plugins-audioconvert.property-details"></a><h2>Property Details</h2>
293
317
<div class="refsect2">
294
<a name="GstAudioConvert--dithering"></a><h3>The <code class="literal">"dithering"</code> property</h3>
295
<pre class="programlisting"> "dithering" <a class="link" href="gst-plugins-base-plugins-audioconvert.html#GstAudioConvertDithering" title="enum GstAudioConvertDithering"><span class="type">GstAudioConvertDithering</span></a> : Read / Write</pre>
318
<a name="GstAudioConvert--dithering"></a><h3>The <code class="literal">“dithering”</code> property</h3>
319
<pre class="programlisting"> “dithering” <a class="link" href="gst-plugins-base-plugins-audioconvert.html#GstAudioConvertDithering" title="enum GstAudioConvertDithering"><span class="type">GstAudioConvertDithering</span></a></pre>
296
320
<p>Selects between different dithering methods.</p>
321
<p>Flags: Read / Write</p>
297
322
<p>Default value: Triangular dithering (default)</p>
300
325
<div class="refsect2">
301
<a name="GstAudioConvert--noise-shaping"></a><h3>The <code class="literal">"noise-shaping"</code> property</h3>
302
<pre class="programlisting"> "noise-shaping" <a class="link" href="gst-plugins-base-plugins-audioconvert.html#GstAudioConvertNoiseShaping" title="enum GstAudioConvertNoiseShaping"><span class="type">GstAudioConvertNoiseShaping</span></a> : Read / Write</pre>
326
<a name="GstAudioConvert--noise-shaping"></a><h3>The <code class="literal">“noise-shaping”</code> property</h3>
327
<pre class="programlisting"> “noise-shaping” <a class="link" href="gst-plugins-base-plugins-audioconvert.html#GstAudioConvertNoiseShaping" title="enum GstAudioConvertNoiseShaping"><span class="type">GstAudioConvertNoiseShaping</span></a></pre>
303
328
<p>Selects between different noise shaping methods.</p>
329
<p>Flags: Read / Write</p>
304
330
<p>Default value: No noise shaping (default)</p>
308
334
<div class="footer">
310
Generated by GTK-Doc V1.19</div>
336
Generated by GTK-Doc V1.20</div>
b'\\ No newline at end of file'