1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>videobalance</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-vertigotv.html" title="vertigotv">
10 <link rel="next" href="gst-plugins-good-plugins-videobox.html" title="videobox">
11 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
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-good-plugins-vertigotv.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-videobox.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-good-plugins-videobalance.synopsis" class="shortcut">Top</a>
26 <a href="#gst-plugins-good-plugins-videobalance.description" class="shortcut">Description</a>
28 <a href="#gst-plugins-good-plugins-videobalance.object-hierarchy" class="shortcut">Object Hierarchy</a>
30 <a href="#gst-plugins-good-plugins-videobalance.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
32 <a href="#gst-plugins-good-plugins-videobalance.properties" class="shortcut">Properties</a>
35 <div class="refentry">
36 <a name="gst-plugins-good-plugins-videobalance"></a><div class="titlepage"></div>
37 <div class="refnamediv"><table width="100%"><tr>
39 <h2><span class="refentrytitle"><a name="gst-plugins-good-plugins-videobalance.top_of_page"></a>videobalance</span></h2>
40 <p>videobalance — Adjusts brightness, contrast, hue, saturation on a video stream</p>
42 <td valign="top" align="right"></td>
44 <div class="refsynopsisdiv">
45 <a name="gst-plugins-good-plugins-videobalance.synopsis"></a><h2>Synopsis</h2>
46 <a name="GstVideoBalance"></a><pre class="synopsis">struct <a class="link" href="gst-plugins-good-plugins-videobalance.html#GstVideoBalance-struct" title="struct GstVideoBalance">GstVideoBalance</a>;
49 <div class="refsect1">
50 <a name="gst-plugins-good-plugins-videobalance.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://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
54 +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
55 +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstBaseTransform.html">GstBaseTransform</a>
56 +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstvideofilter.html#GstVideoFilter">GstVideoFilter</a>
60 <div class="refsect1">
61 <a name="gst-plugins-good-plugins-videobalance.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
63 GstVideoBalance implements
64 <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstImplementsInterface.html">GstImplementsInterface</a> and <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstcolorbalance.html#GstColorBalance">GstColorBalance</a>.</p>
66 <div class="refsect1">
67 <a name="gst-plugins-good-plugins-videobalance.properties"></a><h2>Properties</h2>
68 <pre class="synopsis">
69 "<a class="link" href="gst-plugins-good-plugins-videobalance.html#GstVideoBalance--brightness" title='The "brightness" property'>brightness</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> : Read / Write
70 "<a class="link" href="gst-plugins-good-plugins-videobalance.html#GstVideoBalance--contrast" title='The "contrast" property'>contrast</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> : Read / Write
71 "<a class="link" href="gst-plugins-good-plugins-videobalance.html#GstVideoBalance--hue" title='The "hue" property'>hue</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> : Read / Write
72 "<a class="link" href="gst-plugins-good-plugins-videobalance.html#GstVideoBalance--saturation" title='The "saturation" property'>saturation</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> : Read / Write
75 <div class="refsect1">
76 <a name="gst-plugins-good-plugins-videobalance.description"></a><h2>Description</h2>
78 Adjusts brightness, contrast, hue, saturation on a video stream.
82 <div class="refsect2">
83 <a name="idp18698688"></a><h3>Example launch line</h3>
84 <div class="informalexample">
85 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
88 <td class="listing_lines" align="right"><pre>1</pre></td>
89 <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch videotestsrc <span class="gtkdoc opt">!</span> videobalance saturation<span class="gtkdoc opt">=</span><span class="number">0.0</span> <span class="gtkdoc opt">!</span> ffmpegcolorspace <span class="gtkdoc opt">!</span> ximagesink</pre></td>
94 This pipeline converts the image to black and white by setting the
100 Last reviewed on 2010-04-18 (0.10.22)
102 <div class="refsynopsisdiv">
104 <div class="refsect2">
105 <a name="idp22511296"></a><h3>Element Information</h3>
106 <div class="variablelist"><table border="0">
107 <col align="left" valign="top">
110 <td><p><span class="term">plugin</span></p></td>
112 <a class="link" href="gst-plugins-good-plugins-plugin-videofilter.html#plugin-videofilter">videofilter</a>
116 <td><p><span class="term">author</span></p></td>
117 <td>David Schleef <ds@schleef.org></td>
120 <td><p><span class="term">class</span></p></td>
121 <td>Filter/Effect/Video</td>
127 <div class="refsect2">
128 <a name="idp21410416"></a><h3>Element Pads</h3>
129 <div class="variablelist"><table border="0">
130 <col align="left" valign="top">
133 <td><p><span class="term">name</span></p></td>
137 <td><p><span class="term">direction</span></p></td>
141 <td><p><span class="term">presence</span></p></td>
145 <td><p><span class="term">details</span></p></td>
146 <td>video/x-raw-yuv, format=(fourcc)AYUV, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
149 <td><p><span class="term"></span></p></td>
150 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)32, endianness=(int)4321, red_mask=(int)16711680, green_mask=(int)65280, blue_mask=(int)255, alpha_mask=(int)-16777216, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
153 <td><p><span class="term"></span></p></td>
154 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)32, endianness=(int)4321, red_mask=(int)65280, green_mask=(int)16711680, blue_mask=(int)-16777216, alpha_mask=(int)255, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
157 <td><p><span class="term"></span></p></td>
158 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)32, endianness=(int)4321, red_mask=(int)255, green_mask=(int)65280, blue_mask=(int)16711680, alpha_mask=(int)-16777216, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
161 <td><p><span class="term"></span></p></td>
162 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)32, endianness=(int)4321, red_mask=(int)-16777216, green_mask=(int)16711680, blue_mask=(int)65280, alpha_mask=(int)255, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
165 <td><p><span class="term"></span></p></td>
166 <td> video/x-raw-yuv, format=(fourcc)Y444, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
169 <td><p><span class="term"></span></p></td>
170 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)24, endianness=(int)4321, red_mask=(int)16711680, green_mask=(int)65280, blue_mask=(int)255, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
173 <td><p><span class="term"></span></p></td>
174 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)24, endianness=(int)4321, red_mask=(int)-16777216, green_mask=(int)16711680, blue_mask=(int)65280, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
177 <td><p><span class="term"></span></p></td>
178 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)24, endianness=(int)4321, red_mask=(int)255, green_mask=(int)65280, blue_mask=(int)16711680, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
181 <td><p><span class="term"></span></p></td>
182 <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)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
185 <td><p><span class="term"></span></p></td>
186 <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)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
189 <td><p><span class="term"></span></p></td>
190 <td> video/x-raw-rgb, bpp=(int)24, depth=(int)24, endianness=(int)4321, red_mask=(int)255, green_mask=(int)65280, blue_mask=(int)16711680, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
193 <td><p><span class="term"></span></p></td>
194 <td> video/x-raw-yuv, format=(fourcc)Y42B, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
197 <td><p><span class="term"></span></p></td>
198 <td> video/x-raw-yuv, format=(fourcc)YUY2, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
201 <td><p><span class="term"></span></p></td>
202 <td> video/x-raw-yuv, format=(fourcc)UYVY, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
205 <td><p><span class="term"></span></p></td>
206 <td> video/x-raw-yuv, format=(fourcc)YVYU, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
209 <td><p><span class="term"></span></p></td>
210 <td> video/x-raw-yuv, format=(fourcc)I420, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
213 <td><p><span class="term"></span></p></td>
214 <td> video/x-raw-yuv, format=(fourcc)YV12, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
217 <td><p><span class="term"></span></p></td>
218 <td> video/x-raw-yuv, format=(fourcc)IYUV, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
221 <td><p><span class="term"></span></p></td>
222 <td> video/x-raw-yuv, format=(fourcc)Y41B, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
226 <div class="variablelist"><table border="0">
227 <col align="left" valign="top">
230 <td><p><span class="term">name</span></p></td>
234 <td><p><span class="term">direction</span></p></td>
238 <td><p><span class="term">presence</span></p></td>
242 <td><p><span class="term">details</span></p></td>
243 <td>video/x-raw-yuv, format=(fourcc)AYUV, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
246 <td><p><span class="term"></span></p></td>
247 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)32, endianness=(int)4321, red_mask=(int)16711680, green_mask=(int)65280, blue_mask=(int)255, alpha_mask=(int)-16777216, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
250 <td><p><span class="term"></span></p></td>
251 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)32, endianness=(int)4321, red_mask=(int)65280, green_mask=(int)16711680, blue_mask=(int)-16777216, alpha_mask=(int)255, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
254 <td><p><span class="term"></span></p></td>
255 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)32, endianness=(int)4321, red_mask=(int)255, green_mask=(int)65280, blue_mask=(int)16711680, alpha_mask=(int)-16777216, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
258 <td><p><span class="term"></span></p></td>
259 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)32, endianness=(int)4321, red_mask=(int)-16777216, green_mask=(int)16711680, blue_mask=(int)65280, alpha_mask=(int)255, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
262 <td><p><span class="term"></span></p></td>
263 <td> video/x-raw-yuv, format=(fourcc)Y444, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
266 <td><p><span class="term"></span></p></td>
267 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)24, endianness=(int)4321, red_mask=(int)16711680, green_mask=(int)65280, blue_mask=(int)255, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
270 <td><p><span class="term"></span></p></td>
271 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)24, endianness=(int)4321, red_mask=(int)-16777216, green_mask=(int)16711680, blue_mask=(int)65280, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
274 <td><p><span class="term"></span></p></td>
275 <td> video/x-raw-rgb, bpp=(int)32, depth=(int)24, endianness=(int)4321, red_mask=(int)255, green_mask=(int)65280, blue_mask=(int)16711680, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
278 <td><p><span class="term"></span></p></td>
279 <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)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
282 <td><p><span class="term"></span></p></td>
283 <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)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
286 <td><p><span class="term"></span></p></td>
287 <td> video/x-raw-rgb, bpp=(int)24, depth=(int)24, endianness=(int)4321, red_mask=(int)255, green_mask=(int)65280, blue_mask=(int)16711680, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
290 <td><p><span class="term"></span></p></td>
291 <td> video/x-raw-yuv, format=(fourcc)Y42B, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
294 <td><p><span class="term"></span></p></td>
295 <td> video/x-raw-yuv, format=(fourcc)YUY2, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
298 <td><p><span class="term"></span></p></td>
299 <td> video/x-raw-yuv, format=(fourcc)UYVY, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
302 <td><p><span class="term"></span></p></td>
303 <td> video/x-raw-yuv, format=(fourcc)YVYU, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
306 <td><p><span class="term"></span></p></td>
307 <td> video/x-raw-yuv, format=(fourcc)I420, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
310 <td><p><span class="term"></span></p></td>
311 <td> video/x-raw-yuv, format=(fourcc)YV12, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
314 <td><p><span class="term"></span></p></td>
315 <td> video/x-raw-yuv, format=(fourcc)IYUV, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
318 <td><p><span class="term"></span></p></td>
319 <td> video/x-raw-yuv, format=(fourcc)Y41B, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
328 <div class="refsect1">
329 <a name="gst-plugins-good-plugins-videobalance.details"></a><h2>Details</h2>
330 <div class="refsect2">
331 <a name="GstVideoBalance-struct"></a><h3>struct GstVideoBalance</h3>
332 <pre class="programlisting">struct GstVideoBalance;</pre>
334 Opaque data structure.
338 <div class="refsect1">
339 <a name="gst-plugins-good-plugins-videobalance.property-details"></a><h2>Property Details</h2>
340 <div class="refsect2">
341 <a name="GstVideoBalance--brightness"></a><h3>The <code class="literal">"brightness"</code> property</h3>
342 <pre class="programlisting"> "brightness" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> : Read / Write</pre>
344 <p>Allowed values: [-1,1]</p>
345 <p>Default value: 0</p>
348 <div class="refsect2">
349 <a name="GstVideoBalance--contrast"></a><h3>The <code class="literal">"contrast"</code> property</h3>
350 <pre class="programlisting"> "contrast" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> : Read / Write</pre>
352 <p>Allowed values: [0,2]</p>
353 <p>Default value: 1</p>
356 <div class="refsect2">
357 <a name="GstVideoBalance--hue"></a><h3>The <code class="literal">"hue"</code> property</h3>
358 <pre class="programlisting"> "hue" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> : Read / Write</pre>
360 <p>Allowed values: [-1,1]</p>
361 <p>Default value: 0</p>
364 <div class="refsect2">
365 <a name="GstVideoBalance--saturation"></a><h3>The <code class="literal">"saturation"</code> property</h3>
366 <pre class="programlisting"> "saturation" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> : Read / Write</pre>
368 <p>Allowed values: [0,2]</p>
369 <p>Default value: 1</p>
375 Generated by GTK-Doc V1.18</div>