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>smptealpha: GStreamer Good Plugins 1.0 Plugins Reference Manual</title> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="index.html" title="GStreamer Good Plugins 1.0 Plugins Reference Manual"> 8<link rel="up" href="ch01.html" title="gst-plugins-good Elements"> 9<link rel="prev" href="gst-plugins-good-plugins-shout2send.html" title="shout2send"> 10<link rel="next" href="gst-plugins-good-plugins-smpte.html" title="smpte"> 11<meta name="generator" content="GTK-Doc V1.28 (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="5"><tr valign="middle"> 16<td width="100%" align="left" class="shortcuts"> 17<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> 18 <a href="#gst-plugins-good-plugins-smptealpha.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 19 <a href="#gst-plugins-good-plugins-smptealpha.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> 20 <a href="#gst-plugins-good-plugins-smptealpha.properties" class="shortcut">Properties</a></span> 21</td> 22<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> 23<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> 24<td><a accesskey="p" href="gst-plugins-good-plugins-shout2send.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> 25<td><a accesskey="n" href="gst-plugins-good-plugins-smpte.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> 26</tr></table> 27<div class="refentry"> 28<a name="gst-plugins-good-plugins-smptealpha"></a><div class="titlepage"></div> 29<div class="refnamediv"><table width="100%"><tr> 30<td valign="top"> 31<h2><span class="refentrytitle"><a name="gst-plugins-good-plugins-smptealpha.top_of_page"></a>smptealpha</span></h2> 32<p>smptealpha</p> 33</td> 34<td class="gallery_image" valign="top" align="right"></td> 35</tr></table></div> 36<div class="refsect1"> 37<a name="gst-plugins-good-plugins-smptealpha.properties"></a><h2>Properties</h2> 38<div class="informaltable"><table class="informaltable" border="0"> 39<colgroup> 40<col width="150px" class="properties_type"> 41<col width="300px" class="properties_name"> 42<col width="200px" class="properties_flags"> 43</colgroup> 44<tbody> 45<tr> 46<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> 47<td class="property_name"><a class="link" href="gst-plugins-good-plugins-smptealpha.html#GstSMPTEAlpha--border" title="The “border” property">border</a></td> 48<td class="property_flags">Read / Write</td> 49</tr> 50<tr> 51<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> 52<td class="property_name"><a class="link" href="gst-plugins-good-plugins-smptealpha.html#GstSMPTEAlpha--depth" title="The “depth” property">depth</a></td> 53<td class="property_flags">Read / Write</td> 54</tr> 55<tr> 56<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></td> 57<td class="property_name"><a class="link" href="gst-plugins-good-plugins-smptealpha.html#GstSMPTEAlpha--position" title="The “position” property">position</a></td> 58<td class="property_flags">Read / Write</td> 59</tr> 60<tr> 61<td class="property_type"><span class="type">GstSMPTEAlphaTransitionType</span></td> 62<td class="property_name"><a class="link" href="gst-plugins-good-plugins-smptealpha.html#GstSMPTEAlpha--type" title="The “type” property">type</a></td> 63<td class="property_flags">Read / Write</td> 64</tr> 65<tr> 66<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> 67<td class="property_name"><a class="link" href="gst-plugins-good-plugins-smptealpha.html#GstSMPTEAlpha--invert" title="The “invert” property">invert</a></td> 68<td class="property_flags">Read / Write</td> 69</tr> 70</tbody> 71</table></div> 72</div> 73<a name="GstSMPTEAlpha"></a><div class="refsect1"> 74<a name="gst-plugins-good-plugins-smptealpha.other"></a><h2>Types and Values</h2> 75<div class="informaltable"><table class="informaltable" width="100%" border="0"> 76<colgroup> 77<col width="150px" class="name"> 78<col class="description"> 79</colgroup> 80<tbody><tr> 81<td class="datatype_keyword">struct</td> 82<td class="function_name"><a class="link" href="gst-plugins-good-plugins-smptealpha.html#GstSMPTEAlpha-struct" title="struct GstSMPTEAlpha">GstSMPTEAlpha</a></td> 83</tr></tbody> 84</table></div> 85</div> 86<div class="refsect1"> 87<a name="gst-plugins-good-plugins-smptealpha.object-hierarchy"></a><h2>Object Hierarchy</h2> 88<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> 89 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a> 90 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a> 91 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a> 92 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-libs-1.0/GstBaseTransform.html#GstBaseTransform-struct">GstBaseTransform</a> 93 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gst-plugins-base-libs-1.0/GstVideoFilter.html#GstVideoFilter-struct">GstVideoFilter</a> 94 <span class="lineart">╰──</span> GstSMPTEAlpha 95</pre> 96</div> 97<div class="refsect1"> 98<a name="gst-plugins-good-plugins-smptealpha.description"></a><h2>Description</h2> 99<p>smptealpha can accept an I420 or AYUV video stream. An alpha channel is added 100using an effect specific SMPTE mask in the I420 input case. In the AYUV case, 101the alpha channel is modified using the effect specific SMPTE mask.</p> 102<p>The <span class="type">“position”</span> property is a controllabe double between 0.0 and 1031.0 that specifies the position in the transition. 0.0 is the start of the 104transition with the alpha channel to complete opaque where 1.0 has the alpha 105channel set to completely transparent.</p> 106<p>The <span class="type">“depth”</span> property defines the precision in bits of the mask. 107A higher presision will create a mask with smoother gradients in order to 108avoid banding.</p> 109<div class="refsect2"> 110<a name="id-1.2.244.7.5"></a><h3>Sample pipelines</h3> 111<p> 112Here is a pipeline to demonstrate the smpte transition : 113</p> 114<pre class="programlisting"> 115gst-launch-1.0 -v videotestsrc ! smptealpha border=20000 type=44 116position=0.5 ! videomixer ! videoconvert ! ximagesink 117</pre> 118<p> 119This shows a midway bowtie-h transition a from a videotestsrc to a 120transparent image. The edges of the transition are smoothed with a 12120000 big border. 122</p> 123</div> 124<div class="refsynopsisdiv"> 125<h2>Synopsis</h2> 126<div class="refsect2"> 127<a name="id-1.2.244.7.6.1"></a><h3>Element Information</h3> 128<div class="variablelist"><table border="0" class="variablelist"> 129<colgroup> 130<col align="left" valign="top"> 131<col> 132</colgroup> 133<tbody> 134<tr> 135<td><p><span class="term">plugin</span></p></td> 136<td> 137 <a class="link" href="gst-plugins-good-plugins-plugin-smpte.html#plugin-smpte">smpte</a> 138 </td> 139</tr> 140<tr> 141<td><p><span class="term">author</span></p></td> 142<td>Wim Taymans <wim.taymans@gmail.com></td> 143</tr> 144<tr> 145<td><p><span class="term">class</span></p></td> 146<td>Filter/Editor/Video</td> 147</tr> 148</tbody> 149</table></div> 150</div> 151<hr> 152<div class="refsect2"> 153<a name="id-1.2.244.7.6.2"></a><h3>Element Pads</h3> 154<div class="variablelist"><table border="0" class="variablelist"> 155<colgroup> 156<col align="left" valign="top"> 157<col> 158</colgroup> 159<tbody> 160<tr> 161<td><p><span class="term">name</span></p></td> 162<td>sink</td> 163</tr> 164<tr> 165<td><p><span class="term">direction</span></p></td> 166<td>sink</td> 167</tr> 168<tr> 169<td><p><span class="term">presence</span></p></td> 170<td>always</td> 171</tr> 172<tr> 173<td><p><span class="term">details</span></p></td> 174<td>video/x-raw, format=(string)I420, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td> 175</tr> 176<tr> 177<td><p><span class="term"></span></p></td> 178<td> video/x-raw, format=(string)YV12, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td> 179</tr> 180<tr> 181<td><p><span class="term"></span></p></td> 182<td> video/x-raw, format=(string)AYUV, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td> 183</tr> 184<tr> 185<td><p><span class="term"></span></p></td> 186<td> video/x-raw, format=(string)ARGB, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td> 187</tr> 188<tr> 189<td><p><span class="term"></span></p></td> 190<td> video/x-raw, format=(string)BGRA, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td> 191</tr> 192<tr> 193<td><p><span class="term"></span></p></td> 194<td> video/x-raw, format=(string)RGBA, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td> 195</tr> 196<tr> 197<td><p><span class="term"></span></p></td> 198<td> video/x-raw, format=(string)ARGB, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td> 199</tr> 200</tbody> 201</table></div> 202<div class="variablelist"><table border="0" class="variablelist"> 203<colgroup> 204<col align="left" valign="top"> 205<col> 206</colgroup> 207<tbody> 208<tr> 209<td><p><span class="term">name</span></p></td> 210<td>src</td> 211</tr> 212<tr> 213<td><p><span class="term">direction</span></p></td> 214<td>source</td> 215</tr> 216<tr> 217<td><p><span class="term">presence</span></p></td> 218<td>always</td> 219</tr> 220<tr> 221<td><p><span class="term">details</span></p></td> 222<td>video/x-raw, format=(string)AYUV, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td> 223</tr> 224<tr> 225<td><p><span class="term"></span></p></td> 226<td> video/x-raw, format=(string)ARGB, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td> 227</tr> 228<tr> 229<td><p><span class="term"></span></p></td> 230<td> video/x-raw, format=(string)BGRA, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td> 231</tr> 232<tr> 233<td><p><span class="term"></span></p></td> 234<td> video/x-raw, format=(string)RGBA, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td> 235</tr> 236<tr> 237<td><p><span class="term"></span></p></td> 238<td> video/x-raw, format=(string)ARGB, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td> 239</tr> 240</tbody> 241</table></div> 242</div> 243</div> 244</div> 245<div class="refsect1"> 246<a name="gst-plugins-good-plugins-smptealpha.functions_details"></a><h2>Functions</h2> 247<p></p> 248</div> 249<div class="refsect1"> 250<a name="gst-plugins-good-plugins-smptealpha.other_details"></a><h2>Types and Values</h2> 251<div class="refsect2"> 252<a name="GstSMPTEAlpha-struct"></a><h3>struct GstSMPTEAlpha</h3> 253<pre class="programlisting">struct GstSMPTEAlpha;</pre> 254</div> 255</div> 256<div class="refsect1"> 257<a name="gst-plugins-good-plugins-smptealpha.property-details"></a><h2>Property Details</h2> 258<div class="refsect2"> 259<a name="GstSMPTEAlpha--border"></a><h3>The <code class="literal">“border”</code> property</h3> 260<pre class="programlisting"> “border” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 261<p>The border width of the transition.</p> 262<p>Flags: Read / Write</p> 263<p>Allowed values: >= 0</p> 264<p>Default value: 0</p> 265</div> 266<hr> 267<div class="refsect2"> 268<a name="GstSMPTEAlpha--depth"></a><h3>The <code class="literal">“depth”</code> property</h3> 269<pre class="programlisting"> “depth” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 270<p>Depth of the mask in bits.</p> 271<p>Flags: Read / Write</p> 272<p>Allowed values: [1,24]</p> 273<p>Default value: 16</p> 274</div> 275<hr> 276<div class="refsect2"> 277<a name="GstSMPTEAlpha--position"></a><h3>The <code class="literal">“position”</code> property</h3> 278<pre class="programlisting"> “position” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre> 279<p>Position of the transition effect.</p> 280<p>Flags: Read / Write</p> 281<p>Allowed values: [0,1]</p> 282<p>Default value: 0</p> 283</div> 284<hr> 285<div class="refsect2"> 286<a name="GstSMPTEAlpha--type"></a><h3>The <code class="literal">“type”</code> property</h3> 287<pre class="programlisting"> “type” <span class="type">GstSMPTEAlphaTransitionType</span></pre> 288<p>The type of transition to use.</p> 289<p>Flags: Read / Write</p> 290<p>Default value: A bar moves from left to right</p> 291</div> 292<hr> 293<div class="refsect2"> 294<a name="GstSMPTEAlpha--invert"></a><h3>The <code class="literal">“invert”</code> property</h3> 295<pre class="programlisting"> “invert” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> 296<p>Set to TRUE to invert the transition mask (ie. flip it horizontally).</p> 297<p>Flags: Read / Write</p> 298<p>Default value: FALSE</p> 299</div> 300</div> 301</div> 302<div class="footer"> 303<hr>Generated by GTK-Doc V1.28</div> 304</body> 305</html>
