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>shapewipe: 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-shagadelictv.html" title="shagadelictv"> 10<link rel="next" href="gst-plugins-good-plugins-shout2send.html" title="shout2send"> 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-shapewipe.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 19 <a href="#gst-plugins-good-plugins-shapewipe.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> 20 <a href="#gst-plugins-good-plugins-shapewipe.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-shagadelictv.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-shout2send.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-shapewipe"></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-shapewipe.top_of_page"></a>shapewipe</span></h2> 32<p>shapewipe</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-shapewipe.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#gfloat"><span class="type">gfloat</span></a></td> 47<td class="property_name"><a class="link" href="gst-plugins-good-plugins-shapewipe.html#GstShapeWipe--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#gfloat"><span class="type">gfloat</span></a></td> 52<td class="property_name"><a class="link" href="gst-plugins-good-plugins-shapewipe.html#GstShapeWipe--position" title="The “position” property">position</a></td> 53<td class="property_flags">Read / Write</td> 54</tr> 55</tbody> 56</table></div> 57</div> 58<a name="GstShapeWipe"></a><div class="refsect1"> 59<a name="gst-plugins-good-plugins-shapewipe.other"></a><h2>Types and Values</h2> 60<div class="informaltable"><table class="informaltable" width="100%" border="0"> 61<colgroup> 62<col width="150px" class="name"> 63<col class="description"> 64</colgroup> 65<tbody><tr> 66<td class="datatype_keyword">struct</td> 67<td class="function_name"><a class="link" href="gst-plugins-good-plugins-shapewipe.html#GstShapeWipe-struct" title="struct GstShapeWipe">GstShapeWipe</a></td> 68</tr></tbody> 69</table></div> 70</div> 71<div class="refsect1"> 72<a name="gst-plugins-good-plugins-shapewipe.object-hierarchy"></a><h2>Object Hierarchy</h2> 73<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> 74 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a> 75 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a> 76 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a> 77 <span class="lineart">╰──</span> GstShapeWipe 78</pre> 79</div> 80<div class="refsect1"> 81<a name="gst-plugins-good-plugins-shapewipe.description"></a><h2>Description</h2> 82<p>The shapewipe element provides custom transitions on video streams 83based on a grayscale bitmap. The state of the transition can be 84controlled by the position property and an optional blended border 85can be added by the border property.</p> 86<p>Transition bitmaps can be downloaded from the</p> 87<a class="ulink" href="http://cinelerra.org/transitions.php" target="_top">Cinelerra transition</a><p>page.</p> 88<div class="refsect2"> 89<a name="id-1.2.242.7.6"></a><h3>Example launch line</h3> 90<div class="informalexample"> 91 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> 92 <tbody> 93 <tr> 94 <td class="listing_lines" align="right"><pre>1</pre></td> 95 <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch<span class="gtkdoc opt">-</span><span class="number">1.0</span> <span class="gtkdoc opt">-</span>v videotestsrc <span class="gtkdoc opt">!</span> video<span class="gtkdoc opt">/</span>x<span class="gtkdoc opt">-</span>raw<span class="gtkdoc opt">,</span>format<span class="gtkdoc opt">=</span>AYUV<span class="gtkdoc opt">,</span>width<span class="gtkdoc opt">=</span><span class="number">640</span><span class="gtkdoc opt">,</span>height<span class="gtkdoc opt">=</span><span class="number">480</span> <span class="gtkdoc opt">!</span> shapewipe position<span class="gtkdoc opt">=</span><span class="number">0.5</span> name<span class="gtkdoc opt">=</span>shape <span class="gtkdoc opt">!</span> videomixer name<span class="gtkdoc opt">=</span>mixer <span class="gtkdoc opt">!</span> videoconvert <span class="gtkdoc opt">!</span> autovideosink filesrc location<span class="gtkdoc opt">=</span>mask<span class="gtkdoc opt">.</span>png <span class="gtkdoc opt">!</span> typefind <span class="gtkdoc opt">!</span> decodebin <span class="gtkdoc opt">!</span> videoconvert <span class="gtkdoc opt">!</span> videoscale <span class="gtkdoc opt">!</span> queue <span class="gtkdoc opt">!</span> shape<span class="gtkdoc opt">.</span>mask_sink videotestsrc pattern<span class="gtkdoc opt">=</span>snow <span class="gtkdoc opt">!</span> video<span class="gtkdoc opt">/</span>x<span class="gtkdoc opt">-</span>raw<span class="gtkdoc opt">,</span>format<span class="gtkdoc opt">=</span>AYUV<span class="gtkdoc opt">,</span>width<span class="gtkdoc opt">=</span><span class="number">640</span><span class="gtkdoc opt">,</span>height<span class="gtkdoc opt">=</span><span class="number">480</span> <span class="gtkdoc opt">!</span> queue <span class="gtkdoc opt">!</span> mixer<span class="gtkdoc opt">.</span></pre></td> 96 </tr> 97 </tbody> 98 </table> 99</div> 100 This pipeline adds the transition from mask.png with position 0.5 to an SMPTE test screen and snow. 101</div> 102<div class="refsynopsisdiv"> 103<h2>Synopsis</h2> 104<div class="refsect2"> 105<a name="id-1.2.242.7.7.1"></a><h3>Element Information</h3> 106<div class="variablelist"><table border="0" class="variablelist"> 107<colgroup> 108<col align="left" valign="top"> 109<col> 110</colgroup> 111<tbody> 112<tr> 113<td><p><span class="term">plugin</span></p></td> 114<td> 115 <a class="link" href="gst-plugins-good-plugins-plugin-shapewipe.html#plugin-shapewipe">shapewipe</a> 116 </td> 117</tr> 118<tr> 119<td><p><span class="term">author</span></p></td> 120<td>Sebastian Dröge <sebastian.droege@collabora.co.uk></td> 121</tr> 122<tr> 123<td><p><span class="term">class</span></p></td> 124<td>Filter/Editor/Video</td> 125</tr> 126</tbody> 127</table></div> 128</div> 129<hr> 130<div class="refsect2"> 131<a name="id-1.2.242.7.7.2"></a><h3>Element Pads</h3> 132<div class="variablelist"><table border="0" class="variablelist"> 133<colgroup> 134<col align="left" valign="top"> 135<col> 136</colgroup> 137<tbody> 138<tr> 139<td><p><span class="term">name</span></p></td> 140<td>mask_sink</td> 141</tr> 142<tr> 143<td><p><span class="term">direction</span></p></td> 144<td>sink</td> 145</tr> 146<tr> 147<td><p><span class="term">presence</span></p></td> 148<td>always</td> 149</tr> 150<tr> 151<td><p><span class="term">details</span></p></td> 152<td>video/x-raw, format=(string)GRAY8, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)0/1</td> 153</tr> 154<tr> 155<td><p><span class="term"></span></p></td> 156<td> video/x-raw, format=(string)GRAY16_LE, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)0/1</td> 157</tr> 158</tbody> 159</table></div> 160<div class="variablelist"><table border="0" class="variablelist"> 161<colgroup> 162<col align="left" valign="top"> 163<col> 164</colgroup> 165<tbody> 166<tr> 167<td><p><span class="term">name</span></p></td> 168<td>video_sink</td> 169</tr> 170<tr> 171<td><p><span class="term">direction</span></p></td> 172<td>sink</td> 173</tr> 174<tr> 175<td><p><span class="term">presence</span></p></td> 176<td>always</td> 177</tr> 178<tr> 179<td><p><span class="term">details</span></p></td> 180<td>video/x-raw, format=(string){ AYUV, ARGB, BGRA, ABGR, RGBA }, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td> 181</tr> 182</tbody> 183</table></div> 184<div class="variablelist"><table border="0" class="variablelist"> 185<colgroup> 186<col align="left" valign="top"> 187<col> 188</colgroup> 189<tbody> 190<tr> 191<td><p><span class="term">name</span></p></td> 192<td>src</td> 193</tr> 194<tr> 195<td><p><span class="term">direction</span></p></td> 196<td>source</td> 197</tr> 198<tr> 199<td><p><span class="term">presence</span></p></td> 200<td>always</td> 201</tr> 202<tr> 203<td><p><span class="term">details</span></p></td> 204<td>video/x-raw, format=(string){ AYUV, ARGB, BGRA, ABGR, RGBA }, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td> 205</tr> 206</tbody> 207</table></div> 208</div> 209</div> 210</div> 211<div class="refsect1"> 212<a name="gst-plugins-good-plugins-shapewipe.functions_details"></a><h2>Functions</h2> 213<p></p> 214</div> 215<div class="refsect1"> 216<a name="gst-plugins-good-plugins-shapewipe.other_details"></a><h2>Types and Values</h2> 217<div class="refsect2"> 218<a name="GstShapeWipe-struct"></a><h3>struct GstShapeWipe</h3> 219<pre class="programlisting">struct GstShapeWipe;</pre> 220</div> 221</div> 222<div class="refsect1"> 223<a name="gst-plugins-good-plugins-shapewipe.property-details"></a><h2>Property Details</h2> 224<div class="refsect2"> 225<a name="GstShapeWipe--border"></a><h3>The <code class="literal">“border”</code> property</h3> 226<pre class="programlisting"> “border” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a></pre> 227<p>Border of the mask.</p> 228<p>Flags: Read / Write</p> 229<p>Allowed values: [0,1]</p> 230<p>Default value: 0</p> 231</div> 232<hr> 233<div class="refsect2"> 234<a name="GstShapeWipe--position"></a><h3>The <code class="literal">“position”</code> property</h3> 235<pre class="programlisting"> “position” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a></pre> 236<p>Position of the mask.</p> 237<p>Flags: Read / Write</p> 238<p>Allowed values: [0,1]</p> 239<p>Default value: 0</p> 240</div> 241</div> 242</div> 243<div class="footer"> 244<hr>Generated by GTK-Doc V1.28</div> 245</body> 246</html>
