docs/plugins/html/gst-plugins-base-plugins-vorbisparse.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>vorbisparse</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
   7 <link rel="home" href="index.html" title="GStreamer Base Plugins 0.10 Plugins Reference Manual">
   8 <link rel="up" href="ch01.html" title="gst-plugins-base Elements">
   9 <link rel="prev" href="gst-plugins-base-plugins-vorbisenc.html" title="vorbisenc">
  10 <link rel="next" href="gst-plugins-base-plugins-vorbistag.html" title="vorbistag">
  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-base-plugins-vorbisenc.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 0.10 Plugins Reference Manual</th>
  21 <td><a accesskey="n" href="gst-plugins-base-plugins-vorbistag.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-base-plugins-vorbisparse.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-base-plugins-vorbisparse.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gst-plugins-base-plugins-vorbisparse.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29 </td></tr>
  30 </table>
  31 <div class="refentry">
  32 <a name="gst-plugins-base-plugins-vorbisparse"></a><div class="titlepage"></div>
  33 <div class="refnamediv"><table width="100%"><tr>
  34 <td valign="top">
  35 <h2><span class="refentrytitle"><a name="gst-plugins-base-plugins-vorbisparse.top_of_page"></a>vorbisparse</span></h2>
  36 <p>vorbisparse — parse raw vorbis streams</p>
  37 </td>
  38 <td valign="top" align="right"></td>
  39 </tr></table></div>
  40 <div class="refsynopsisdiv">
  41 <a name="gst-plugins-base-plugins-vorbisparse.synopsis"></a><h2>Synopsis</h2>
  42 <a name="GstVorbisParse"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-base-plugins-vorbisparse.html#GstVorbisParse-struct" title="struct GstVorbisParse">GstVorbisParse</a>;
  43 </pre>
  44 </div>
  45 <div class="refsect1">
  46 <a name="gst-plugins-base-plugins-vorbisparse.object-hierarchy"></a><h2>Object Hierarchy</h2>
  47 <pre class="synopsis">
  48   <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  49    +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
  50          +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
  51                +----GstVorbisParse
  52                      +----<a class="link" href="gst-plugins-base-plugins-vorbistag.html#GstVorbisTag">GstVorbisTag</a>
  53 </pre>
  54 </div>
  55 <div class="refsect1">
  56 <a name="gst-plugins-base-plugins-vorbisparse.description"></a><h2>Description</h2>
  57 <p>
  58 The vorbisparse element will parse the header packets of the Vorbis
  59 stream and put them as the streamheader in the caps. This is used in the
  60 multifdsink case where you want to stream live vorbis streams to multiple
  61 clients, each client has to receive the streamheaders first before they can
  62 consume the vorbis packets.
  63 </p>
  64 <p>
  65 This element also makes sure that the buffers that it pushes out are properly
  66 timestamped and that their offset and offset_end are set. The buffers that
  67 vorbisparse outputs have all of the metadata that oggmux expects to receive,
  68 which allows you to (for example) remux an ogg/vorbis file.
  69 </p>
  70 <p>
  71 </p>
  72 <div class="refsect2">
  73 <a name="idp7959088"></a><h3>Example pipelines</h3>
  74 <div class="informalexample">
  75   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
  76     <tbody>
  77       <tr>
  78         <td class="listing_lines" align="right"><pre>1</pre></td>
  79         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch <span class="gtkdoc opt">-</span>v filesrc location<span class="gtkdoc opt">=</span>sine<span class="gtkdoc opt">.</span>ogg <span class="gtkdoc opt">!</span> oggdemux <span class="gtkdoc opt">!</span> vorbisparse <span class="gtkdoc opt">!</span> fakesink</pre></td>
  80       </tr>
  81     </tbody>
  82   </table>
  83 </div>
  84  This pipeline shows that the streamheader is set in the caps, and that each
  85 buffer has the timestamp, duration, offset, and offset_end set.
  86 <div class="informalexample">
  87   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
  88     <tbody>
  89       <tr>
  90         <td class="listing_lines" align="right"><pre>1
  91 2</pre></td>
  92         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch filesrc location<span class="gtkdoc opt">=</span>sine<span class="gtkdoc opt">.</span>ogg <span class="gtkdoc opt">!</span> oggdemux <span class="gtkdoc opt">!</span> vorbisparse \
  93            <span class="gtkdoc opt">!</span> oggmux <span class="gtkdoc opt">!</span> filesink location<span class="gtkdoc opt">=</span>sine<span class="gtkdoc opt">-</span>remuxed<span class="gtkdoc opt">.</span>ogg</pre></td>
  94       </tr>
  95     </tbody>
  96   </table>
  97 </div>
  98  This pipeline shows remuxing. sine-remuxed.ogg might not be exactly the same
  99 as sine.ogg, but they should produce exactly the same decoded data.
 100 </div>
 101 <p>
 102 </p>
 103 <p>
 104 Last reviewed on 2006-04-01 (0.10.4.1)
 105 </p>
 106 <div class="refsynopsisdiv">
 107 <h2>Synopsis</h2>
 108 <div class="refsect2">
 109 <a name="idp10657648"></a><h3>Element Information</h3>
 110 <div class="variablelist"><table border="0">
 111 <col align="left" valign="top">
 112 <tbody>
 113 <tr>
 114 <td><p><span class="term">plugin</span></p></td>
 115 <td>
 116             <a class="link" href="gst-plugins-base-plugins-plugin-vorbis.html#plugin-vorbis">vorbis</a>
 117           </td>
 118 </tr>
 119 <tr>
 120 <td><p><span class="term">author</span></p></td>
 121 <td>Thomas Vander Stichele &lt;thomas at apestaart dot org&gt;</td>
 122 </tr>
 123 <tr>
 124 <td><p><span class="term">class</span></p></td>
 125 <td>Codec/Parser/Audio</td>
 126 </tr>
 127 </tbody>
 128 </table></div>
 129 </div>
 130 <hr>
 131 <div class="refsect2">
 132 <a name="idp14996624"></a><h3>Element Pads</h3>
 133 <div class="variablelist"><table border="0">
 134 <col align="left" valign="top">
 135 <tbody>
 136 <tr>
 137 <td><p><span class="term">name</span></p></td>
 138 <td>sink</td>
 139 </tr>
 140 <tr>
 141 <td><p><span class="term">direction</span></p></td>
 142 <td>sink</td>
 143 </tr>
 144 <tr>
 145 <td><p><span class="term">presence</span></p></td>
 146 <td>always</td>
 147 </tr>
 148 <tr>
 149 <td><p><span class="term">details</span></p></td>
 150 <td>audio/x-vorbis</td>
 151 </tr>
 152 </tbody>
 153 </table></div>
 154 <div class="variablelist"><table border="0">
 155 <col align="left" valign="top">
 156 <tbody>
 157 <tr>
 158 <td><p><span class="term">name</span></p></td>
 159 <td>src</td>
 160 </tr>
 161 <tr>
 162 <td><p><span class="term">direction</span></p></td>
 163 <td>source</td>
 164 </tr>
 165 <tr>
 166 <td><p><span class="term">presence</span></p></td>
 167 <td>always</td>
 168 </tr>
 169 <tr>
 170 <td><p><span class="term">details</span></p></td>
 171 <td>audio/x-vorbis</td>
 172 </tr>
 173 </tbody>
 174 </table></div>
 175 </div>
 176 </div>
 177 <p>
 178 </p>
 179 </div>
 180 <div class="refsect1">
 181 <a name="gst-plugins-base-plugins-vorbisparse.details"></a><h2>Details</h2>
 182 <div class="refsect2">
 183 <a name="GstVorbisParse-struct"></a><h3>struct GstVorbisParse</h3>
 184 <pre class="programlisting">struct GstVorbisParse;</pre>
 185 <p>
 186 Opaque data structure.
 187 </p>
 188 </div>
 189 </div>
 190 <div class="refsect1">
 191 <a name="gst-plugins-base-plugins-vorbisparse.see-also"></a><h2>See Also</h2>
 192 vorbisdec, oggdemux, theoraparse
 193 </div>
 194 </div>
 195 <div class="footer">
 196 <hr>
 197           Generated by GTK-Doc V1.17</div>
 198 </body>
 199 </html>