docs/plugins/html/gst-plugins-good-plugins-deinterleave.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>deinterleave</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   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-deinterlace.html" title="deinterlace">
  10 <link rel="next" href="gst-plugins-good-plugins-dicetv.html" title="dicetv">
  11 <meta name="generator" content="GTK-Doc V1.18 (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-deinterlace.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-dicetv.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-deinterleave.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-good-plugins-deinterleave.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gst-plugins-good-plugins-deinterleave.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#gst-plugins-good-plugins-deinterleave.properties" class="shortcut">Properties</a>
  31 </td></tr>
  32 </table>
  33 <div class="refentry">
  34 <a name="gst-plugins-good-plugins-deinterleave"></a><div class="titlepage"></div>
  35 <div class="refnamediv"><table width="100%"><tr>
  36 <td valign="top">
  37 <h2><span class="refentrytitle"><a name="gst-plugins-good-plugins-deinterleave.top_of_page"></a>deinterleave</span></h2>
  38 <p>deinterleave — Splits one interleaved multichannel audio stream into many mono audio streams</p>
  39 </td>
  40 <td valign="top" align="right"></td>
  41 </tr></table></div>
  42 <div class="refsynopsisdiv">
  43 <a name="gst-plugins-good-plugins-deinterleave.synopsis"></a><h2>Synopsis</h2>
  44 <a name="GstDeinterleave"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-good-plugins-deinterleave.html#GstDeinterleave-struct" title="struct GstDeinterleave">GstDeinterleave</a>;
  45 </pre>
  46 </div>
  47 <div class="refsect1">
  48 <a name="gst-plugins-good-plugins-deinterleave.object-hierarchy"></a><h2>Object Hierarchy</h2>
  49 <pre class="synopsis">
  50   <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  51    +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
  52          +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
  53                +----GstDeinterleave
  54 </pre>
  55 </div>
  56 <div class="refsect1">
  57 <a name="gst-plugins-good-plugins-deinterleave.properties"></a><h2>Properties</h2>
  58 <pre class="synopsis">
  59   "<a class="link" href="gst-plugins-good-plugins-deinterleave.html#GstDeinterleave--keep-positions" title='The "keep-positions" property'>keep-positions</a>"           <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  60 </pre>
  61 </div>
  62 <div class="refsect1">
  63 <a name="gst-plugins-good-plugins-deinterleave.description"></a><h2>Description</h2>
  64 <p>
  65 Splits one interleaved multichannel audio stream into many mono audio streams.
  66 </p>
  67 <p>
  68 This element handles all raw audio formats and supports changing the input caps as long as
  69 all downstream elements can handle the new caps and the number of channels and the channel
  70 positions stay the same. This restriction will be removed in later versions by adding or
  71 removing some source pads as required.
  72 </p>
  73 <p>
  74 In most cases a queue and an audioconvert element should be added after each source pad
  75 before further processing of the audio data.
  76 </p>
  77 <p>
  78 </p>
  79 <div class="refsect2">
  80 <a name="idp7963648"></a><h3>Example launch line</h3>
  81 <div class="informalexample">
  82   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
  83     <tbody>
  84       <tr>
  85         <td class="listing_lines" align="right"><pre>1</pre></td>
  86         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch filesrc location<span class="gtkdoc opt">=/</span>path<span class="gtkdoc opt">/</span>to<span class="gtkdoc opt">/</span>file<span class="gtkdoc opt">.</span>mp3 <span class="gtkdoc opt">!</span> decodebin <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> <span class="string">&quot;audio/x-raw-int,channels=2 ! deinterleave name=d  d.src0 ! queue ! audioconvert ! vorbisenc ! oggmux ! filesink location=channel1.ogg  d.src1 ! queue ! audioconvert ! vorbisenc ! oggmux ! filesink location=channel2.ogg</span></pre></td>
  87       </tr>
  88     </tbody>
  89   </table>
  90 </div>
  91  Decodes an MP3 file and encodes the left and right channel into separate
  92 Ogg Vorbis files.
  93 <div class="informalexample">
  94   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
  95     <tbody>
  96       <tr>
  97         <td class="listing_lines" align="right"><pre>1</pre></td>
  98         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch filesrc location<span class="gtkdoc opt">=</span>file<span class="gtkdoc opt">.</span>mp3 <span class="gtkdoc opt">!</span> decodebin <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> <span class="string">&quot;audio/x-raw-int,channels=2&quot;</span> <span class="gtkdoc opt">!</span> deinterleave name<span class="gtkdoc opt">=</span>d  interleave name<span class="gtkdoc opt">=</span>i <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> wavenc <span class="gtkdoc opt">!</span> filesink location<span class="gtkdoc opt">=</span>test<span class="gtkdoc opt">.</span>wav    d<span class="gtkdoc opt">.</span>src0 <span class="gtkdoc opt">!</span> queue <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> i<span class="gtkdoc opt">.</span>sink1    d<span class="gtkdoc opt">.</span>src1 <span class="gtkdoc opt">!</span> queue <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> i<span class="gtkdoc opt">.</span>sink0</pre></td>
  99       </tr>
 100     </tbody>
 101   </table>
 102 </div>
 103  Decodes and deinterleaves a Stereo MP3 file into separate channels and
 104 then interleaves the channels again to a WAV file with the channel with the
 105 channels exchanged.
 106 </div>
 107 <p>
 108 </p>
 109 <div class="refsynopsisdiv">
 110 <h2>Synopsis</h2>
 111 <div class="refsect2">
 112 <a name="idp7813632"></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-interleave.html#plugin-interleave">interleave</a>
 120           </td>
 121 </tr>
 122 <tr>
 123 <td><p><span class="term">author</span></p></td>
 124 <td>Andy Wingo &lt;wingo at pobox.com&gt;, Iain &lt;iain@prettypeople.org&gt;, Sebastian Dröge &lt;slomo@circular-chaos.org&gt;</td>
 125 </tr>
 126 <tr>
 127 <td><p><span class="term">class</span></p></td>
 128 <td>Filter/Converter/Audio</td>
 129 </tr>
 130 </tbody>
 131 </table></div>
 132 </div>
 133 <hr>
 134 <div class="refsect2">
 135 <a name="idp5841488"></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, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ], endianness=(int){ 1234, 4321 }, width=(int){ 8, 16, 24, 32 }, depth=(int)[ 1, 32 ], signed=(boolean){ true, false }</td>
 154 </tr>
 155 <tr>
 156 <td><p><span class="term"></span></p></td>
 157 <td> audio/x-raw-float, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ], endianness=(int){ 1234, 4321 }, width=(int){ 32, 64 }</td>
 158 </tr>
 159 </tbody>
 160 </table></div>
 161 <div class="variablelist"><table border="0">
 162 <col align="left" valign="top">
 163 <tbody>
 164 <tr>
 165 <td><p><span class="term">name</span></p></td>
 166 <td>src%d</td>
 167 </tr>
 168 <tr>
 169 <td><p><span class="term">direction</span></p></td>
 170 <td>source</td>
 171 </tr>
 172 <tr>
 173 <td><p><span class="term">presence</span></p></td>
 174 <td>sometimes</td>
 175 </tr>
 176 <tr>
 177 <td><p><span class="term">details</span></p></td>
 178 <td>audio/x-raw-int, rate=(int)[ 1, 2147483647 ], channels=(int)1, endianness=(int){ 1234, 4321 }, width=(int){ 8, 16, 24, 32 }, depth=(int)[ 1, 32 ], signed=(boolean){ true, false }</td>
 179 </tr>
 180 <tr>
 181 <td><p><span class="term"></span></p></td>
 182 <td> audio/x-raw-float, rate=(int)[ 1, 2147483647 ], channels=(int)1, endianness=(int){ 1234, 4321 }, width=(int){ 32, 64 }</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-deinterleave.details"></a><h2>Details</h2>
 193 <div class="refsect2">
 194 <a name="GstDeinterleave-struct"></a><h3>struct GstDeinterleave</h3>
 195 <pre class="programlisting">struct GstDeinterleave;</pre>
 196 <p>
 197 </p>
 198 </div>
 199 </div>
 200 <div class="refsect1">
 201 <a name="gst-plugins-good-plugins-deinterleave.property-details"></a><h2>Property Details</h2>
 202 <div class="refsect2">
 203 <a name="GstDeinterleave--keep-positions"></a><h3>The <code class="literal">"keep-positions"</code> property</h3>
 204 <pre class="programlisting">  "keep-positions"           <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 205 <p>
 206 Keep positions: When enable the caps on the output buffers will
 207 contain the original channel positions. This can be used to correctly
 208 interleave the output again later but can also lead to unwanted effects
 209 if the output should be handled as Mono.
 210 </p>
 211 <p>Default value: FALSE</p>
 212 </div>
 213 </div>
 214 <div class="refsect1">
 215 <a name="gst-plugins-good-plugins-deinterleave.see-also"></a><h2>See Also</h2>
 216 interleave
 217 </div>
 218 </div>
 219 <div class="footer">
 220 <hr>
 221           Generated by GTK-Doc V1.18</div>
 222 </body>
 223 </html>