Tizen 2.0 Release
[framework/multimedia/gst-plugins-good0.10.git] / docs / plugins / html / gst-plugins-good-plugins-flacparse.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>flacparse</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-flacenc.html" title="flacenc">
10 <link rel="next" href="gst-plugins-good-plugins-flactag.html" title="flactag">
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-flacenc.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-flactag.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-flacparse.synopsis" class="shortcut">Top</a>
25                    | 
26                   <a href="#gst-plugins-good-plugins-flacparse.description" class="shortcut">Description</a>
27                    | 
28                   <a href="#gst-plugins-good-plugins-flacparse.object-hierarchy" class="shortcut">Object Hierarchy</a>
29                    | 
30                   <a href="#gst-plugins-good-plugins-flacparse.properties" class="shortcut">Properties</a>
31 </td></tr>
32 </table>
33 <div class="refentry">
34 <a name="gst-plugins-good-plugins-flacparse"></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-flacparse.top_of_page"></a>flacparse</span></h2>
38 <p>flacparse — Parses audio with the FLAC lossless audio codec</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-flacparse.synopsis"></a><h2>Synopsis</h2>
44 <a name="GstFlacParse"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-good-plugins-flacparse.html#GstFlacParse-struct" title="struct GstFlacParse">GstFlacParse</a>;
45 </pre>
46 </div>
47 <div class="refsect1">
48 <a name="gst-plugins-good-plugins-flacparse.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                +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/gstreamer-libs-GstBaseParse.html#GstBaseParse">GstBaseParse</a>
54                      +----GstFlacParse
55 </pre>
56 </div>
57 <div class="refsect1">
58 <a name="gst-plugins-good-plugins-flacparse.properties"></a><h2>Properties</h2>
59 <pre class="synopsis">
60   "<a class="link" href="gst-plugins-good-plugins-flacparse.html#GstFlacParse--check-frame-checksums" title='The "check-frame-checksums" property'>check-frame-checksums</a>"    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
61 </pre>
62 </div>
63 <div class="refsect1">
64 <a name="gst-plugins-good-plugins-flacparse.description"></a><h2>Description</h2>
65 <p>
66 The flacparse element will parse the header packets of the FLAC
67 stream and put them as the streamheader in the caps. This is used in the
68 multifdsink case where you want to stream live FLAC streams to multiple
69 clients, each client has to receive the streamheaders first before they can
70 consume the FLAC packets.
71 </p>
72 <p>
73 This element also makes sure that the buffers that it pushes out are properly
74 timestamped and that their offset and offset_end are set. The buffers that
75 flacparse outputs have all of the metadata that oggmux expects to receive,
76 which allows you to (for example) remux an ogg/flac or convert a native FLAC
77 format file to an ogg bitstream.
78 </p>
79 <p>
80 </p>
81 <div class="refsect2">
82 <a name="idp9905840"></a><h3>Example pipelines</h3>
83 <div class="informalexample">
84   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
85     <tbody>
86       <tr>
87         <td class="listing_lines" align="right"><pre>1
88 2</pre></td>
89         <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>flac <span class="gtkdoc opt">!</span> flacparse <span class="gtkdoc opt">!</span> identity \
90            <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>
91       </tr>
92     </tbody>
93   </table>
94 </div>
95  This pipeline converts a native FLAC format file to an ogg bitstream.
96 It also illustrates that the streamheader is set in the caps, and that each
97 buffer has the timestamp, duration, offset, and offset_end set.
98 </div>
99 <p>
100 </p>
101 <div class="refsynopsisdiv">
102 <h2>Synopsis</h2>
103 <div class="refsect2">
104 <a name="idp5330752"></a><h3>Element Information</h3>
105 <div class="variablelist"><table border="0">
106 <col align="left" valign="top">
107 <tbody>
108 <tr>
109 <td><p><span class="term">plugin</span></p></td>
110 <td>
111             audioparsers
112           </td>
113 </tr>
114 <tr>
115 <td><p><span class="term">author</span></p></td>
116 <td>Sebastian Dröge &lt;sebastian.droege@collabora.co.uk&gt;</td>
117 </tr>
118 <tr>
119 <td><p><span class="term">class</span></p></td>
120 <td>Codec/Parser/Audio</td>
121 </tr>
122 </tbody>
123 </table></div>
124 </div>
125 <hr>
126 <div class="refsect2">
127 <a name="idp10223776"></a><h3>Element Pads</h3>
128 <div class="variablelist"><table border="0">
129 <col align="left" valign="top">
130 <tbody>
131 <tr>
132 <td><p><span class="term">name</span></p></td>
133 <td>sink</td>
134 </tr>
135 <tr>
136 <td><p><span class="term">direction</span></p></td>
137 <td>sink</td>
138 </tr>
139 <tr>
140 <td><p><span class="term">presence</span></p></td>
141 <td>always</td>
142 </tr>
143 <tr>
144 <td><p><span class="term">details</span></p></td>
145 <td>audio/x-flac</td>
146 </tr>
147 </tbody>
148 </table></div>
149 <div class="variablelist"><table border="0">
150 <col align="left" valign="top">
151 <tbody>
152 <tr>
153 <td><p><span class="term">name</span></p></td>
154 <td>src</td>
155 </tr>
156 <tr>
157 <td><p><span class="term">direction</span></p></td>
158 <td>source</td>
159 </tr>
160 <tr>
161 <td><p><span class="term">presence</span></p></td>
162 <td>always</td>
163 </tr>
164 <tr>
165 <td><p><span class="term">details</span></p></td>
166 <td>audio/x-flac, framed=(boolean)true, channels=(int)[ 1, 8 ], rate=(int)[ 1, 655350 ]</td>
167 </tr>
168 </tbody>
169 </table></div>
170 </div>
171 </div>
172 <p>
173 </p>
174 </div>
175 <div class="refsect1">
176 <a name="gst-plugins-good-plugins-flacparse.details"></a><h2>Details</h2>
177 <div class="refsect2">
178 <a name="GstFlacParse-struct"></a><h3>struct GstFlacParse</h3>
179 <pre class="programlisting">struct GstFlacParse;</pre>
180 <p>
181 </p>
182 </div>
183 </div>
184 <div class="refsect1">
185 <a name="gst-plugins-good-plugins-flacparse.property-details"></a><h2>Property Details</h2>
186 <div class="refsect2">
187 <a name="GstFlacParse--check-frame-checksums"></a><h3>The <code class="literal">"check-frame-checksums"</code> property</h3>
188 <pre class="programlisting">  "check-frame-checksums"    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
189 <p>Check the overall checksums of every frame.</p>
190 <p>Default value: FALSE</p>
191 </div>
192 </div>
193 <div class="refsect1">
194 <a name="gst-plugins-good-plugins-flacparse.see-also"></a><h2>See Also</h2>
195 flacdec, oggdemux, vorbisparse
196 </div>
197 </div>
198 <div class="footer">
199 <hr>
200           Generated by GTK-Doc V1.18</div>
201 </body>
202 </html>