Git init
[framework/multimedia/gst-plugins-good0.10.git] / docs / plugins / html / gst-plugins-good-plugins-dvdec.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>dvdec</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
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-dv1394src.html" title="dv1394src">
10 <link rel="next" href="gst-plugins-good-plugins-dvdemux.html" title="dvdemux">
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-good-plugins-dv1394src.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-dvdemux.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-dvdec.synopsis" class="shortcut">Top</a>
25                    | 
26                   <a href="#gst-plugins-good-plugins-dvdec.description" class="shortcut">Description</a>
27                    | 
28                   <a href="#gst-plugins-good-plugins-dvdec.object-hierarchy" class="shortcut">Object Hierarchy</a>
29                    | 
30                   <a href="#gst-plugins-good-plugins-dvdec.properties" class="shortcut">Properties</a>
31 </td></tr>
32 </table>
33 <div class="refentry">
34 <a name="gst-plugins-good-plugins-dvdec"></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-dvdec.top_of_page"></a>dvdec</span></h2>
38 <p>dvdec — Uses libdv to decode DV video (smpte314) (libdv.sourceforge.net)</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-dvdec.synopsis"></a><h2>Synopsis</h2>
44 <a name="GstDVDec"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-good-plugins-dvdec.html#GstDVDec-struct" title="struct GstDVDec">GstDVDec</a>;
45 </pre>
46 </div>
47 <div class="refsect1">
48 <a name="gst-plugins-good-plugins-dvdec.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                +----GstDVDec
54 </pre>
55 </div>
56 <div class="refsect1">
57 <a name="gst-plugins-good-plugins-dvdec.properties"></a><h2>Properties</h2>
58 <pre class="synopsis">
59   "<a class="link" href="gst-plugins-good-plugins-dvdec.html#GstDVDec--clamp-chroma" title='The "clamp-chroma" property'>clamp-chroma</a>"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
60   "<a class="link" href="gst-plugins-good-plugins-dvdec.html#GstDVDec--clamp-luma" title='The "clamp-luma" property'>clamp-luma</a>"               <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
61   "<a class="link" href="gst-plugins-good-plugins-dvdec.html#GstDVDec--drop-factor" title='The "drop-factor" property'>drop-factor</a>"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
62   "<a class="link" href="gst-plugins-good-plugins-dvdec.html#GstDVDec--quality" title='The "quality" property'>quality</a>"                  <span class="type">GstDVDecQualityEnum</span>   : Read / Write
63 </pre>
64 </div>
65 <div class="refsect1">
66 <a name="gst-plugins-good-plugins-dvdec.description"></a><h2>Description</h2>
67 <p>
68 dvdec decodes DV video into raw video. The element expects a full DV frame
69 as input, which is 120000 bytes for NTSC and 144000 for PAL video.
70 </p>
71 <p>
72 This element can perform simple frame dropping with the <a class="link" href="gst-plugins-good-plugins-dvdec.html#GstDVDec--drop-factor" title='The "drop-factor" property'><span class="type">"drop-factor"</span></a>
73 property. Setting this property to a value N &gt; 1 will only decode every 
74 Nth frame.
75 </p>
76 <p>
77 </p>
78 <div class="refsect2">
79 <a name="idp11347584"></a><h3>Example launch line</h3>
80 <div class="informalexample">
81   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
82     <tbody>
83       <tr>
84         <td class="listing_lines" align="right"><pre>1</pre></td>
85         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch filesrc location<span class="gtkdoc opt">=</span>test<span class="gtkdoc opt">.</span>dv <span class="gtkdoc opt">!</span> dvdemux name<span class="gtkdoc opt">=</span>demux <span class="gtkdoc opt">!</span> dvdec <span class="gtkdoc opt">!</span> xvimagesink</pre></td>
86       </tr>
87     </tbody>
88   </table>
89 </div>
90  This pipeline decodes and renders the raw DV stream to a videosink.
91 </div>
92 <p>
93 </p>
94 <p>
95 Last reviewed on 2006-02-28 (0.10.3)
96 </p>
97 <div class="refsynopsisdiv">
98 <h2>Synopsis</h2>
99 <div class="refsect2">
100 <a name="idp8815024"></a><h3>Element Information</h3>
101 <div class="variablelist"><table border="0">
102 <col align="left" valign="top">
103 <tbody>
104 <tr>
105 <td><p><span class="term">plugin</span></p></td>
106 <td>
107             <a class="link" href="gst-plugins-good-plugins-plugin-dv.html#plugin-dv">dv</a>
108           </td>
109 </tr>
110 <tr>
111 <td><p><span class="term">author</span></p></td>
112 <td>Erik Walthinsen &lt;omega@cse.ogi.edu&gt;,Wim Taymans &lt;wim@fluendo.com&gt;</td>
113 </tr>
114 <tr>
115 <td><p><span class="term">class</span></p></td>
116 <td>Codec/Decoder/Video</td>
117 </tr>
118 </tbody>
119 </table></div>
120 </div>
121 <hr>
122 <div class="refsect2">
123 <a name="idp7665168"></a><h3>Element Pads</h3>
124 <div class="variablelist"><table border="0">
125 <col align="left" valign="top">
126 <tbody>
127 <tr>
128 <td><p><span class="term">name</span></p></td>
129 <td>sink</td>
130 </tr>
131 <tr>
132 <td><p><span class="term">direction</span></p></td>
133 <td>sink</td>
134 </tr>
135 <tr>
136 <td><p><span class="term">presence</span></p></td>
137 <td>always</td>
138 </tr>
139 <tr>
140 <td><p><span class="term">details</span></p></td>
141 <td>video/x-dv, systemstream=(boolean)false</td>
142 </tr>
143 </tbody>
144 </table></div>
145 <div class="variablelist"><table border="0">
146 <col align="left" valign="top">
147 <tbody>
148 <tr>
149 <td><p><span class="term">name</span></p></td>
150 <td>src</td>
151 </tr>
152 <tr>
153 <td><p><span class="term">direction</span></p></td>
154 <td>source</td>
155 </tr>
156 <tr>
157 <td><p><span class="term">presence</span></p></td>
158 <td>always</td>
159 </tr>
160 <tr>
161 <td><p><span class="term">details</span></p></td>
162 <td>video/x-raw-yuv, format=(fourcc)YUY2, width=(int)720, framerate=(fraction)[ 1/1, 60/1 ]</td>
163 </tr>
164 <tr>
165 <td><p><span class="term"></span></p></td>
166 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)24, endianness=(int)4321, red_mask=(int)65280, green_mask=(int)16711680, blue_mask=(int)-16777216, width=(int)720, framerate=(fraction)[ 1/1, 60/1 ]</td>
167 </tr>
168 <tr>
169 <td><p><span class="term"></span></p></td>
170 <td> video/x-raw-rgb, bpp=(int)24, depth=(int)24, endianness=(int)4321, red_mask=(int)16711680, green_mask=(int)65280, blue_mask=(int)255, width=(int)720, framerate=(fraction)[ 1/1, 60/1 ]</td>
171 </tr>
172 </tbody>
173 </table></div>
174 </div>
175 </div>
176 <p>
177 </p>
178 </div>
179 <div class="refsect1">
180 <a name="gst-plugins-good-plugins-dvdec.details"></a><h2>Details</h2>
181 <div class="refsect2">
182 <a name="GstDVDec-struct"></a><h3>struct GstDVDec</h3>
183 <pre class="programlisting">struct GstDVDec;</pre>
184 <p>
185 </p>
186 </div>
187 </div>
188 <div class="refsect1">
189 <a name="gst-plugins-good-plugins-dvdec.property-details"></a><h2>Property Details</h2>
190 <div class="refsect2">
191 <a name="GstDVDec--clamp-chroma"></a><h3>The <code class="literal">"clamp-chroma"</code> property</h3>
192 <pre class="programlisting">  "clamp-chroma"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
193 <p>Clamp chroma.</p>
194 <p>Default value: FALSE</p>
195 </div>
196 <hr>
197 <div class="refsect2">
198 <a name="GstDVDec--clamp-luma"></a><h3>The <code class="literal">"clamp-luma"</code> property</h3>
199 <pre class="programlisting">  "clamp-luma"               <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
200 <p>Clamp luma.</p>
201 <p>Default value: FALSE</p>
202 </div>
203 <hr>
204 <div class="refsect2">
205 <a name="GstDVDec--drop-factor"></a><h3>The <code class="literal">"drop-factor"</code> property</h3>
206 <pre class="programlisting">  "drop-factor"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
207 <p>Only decode Nth frame.</p>
208 <p>Allowed values: &gt;= 1</p>
209 <p>Default value: 1</p>
210 </div>
211 <hr>
212 <div class="refsect2">
213 <a name="GstDVDec--quality"></a><h3>The <code class="literal">"quality"</code> property</h3>
214 <pre class="programlisting">  "quality"                  <span class="type">GstDVDecQualityEnum</span>   : Read / Write</pre>
215 <p>Decoding quality.</p>
216 <p>Default value: Highest quality colour decoding</p>
217 </div>
218 </div>
219 </div>
220 <div class="footer">
221 <hr>
222           Generated by GTK-Doc V1.17</div>
223 </body>
224 </html>