docs/plugins/html/gst-plugins-good-plugins-shapewipe.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>shapewipe</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-shagadelictv.html" title="shagadelictv">
  10 <link rel="next" href="gst-plugins-good-plugins-smokedec.html" title="smokedec">
  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-shagadelictv.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-smokedec.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-shapewipe.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-good-plugins-shapewipe.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gst-plugins-good-plugins-shapewipe.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#gst-plugins-good-plugins-shapewipe.properties" class="shortcut">Properties</a>
  31 </td></tr>
  32 </table>
  33 <div class="refentry">
  34 <a name="gst-plugins-good-plugins-shapewipe"></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-shapewipe.top_of_page"></a>shapewipe</span></h2>
  38 <p>shapewipe — Adds a shape wipe transition to a video stream</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-shapewipe.synopsis"></a><h2>Synopsis</h2>
  44 <a name="GstShapeWipe"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-good-plugins-shapewipe.html#GstShapeWipe-struct" title="struct GstShapeWipe">GstShapeWipe</a>;
  45 </pre>
  46 </div>
  47 <div class="refsect1">
  48 <a name="gst-plugins-good-plugins-shapewipe.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                +----GstShapeWipe
  54 </pre>
  55 </div>
  56 <div class="refsect1">
  57 <a name="gst-plugins-good-plugins-shapewipe.properties"></a><h2>Properties</h2>
  58 <pre class="synopsis">
  59   "<a class="link" href="gst-plugins-good-plugins-shapewipe.html#GstShapeWipe--border" title='The "border" property'>border</a>"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a>                : Read / Write
  60   "<a class="link" href="gst-plugins-good-plugins-shapewipe.html#GstShapeWipe--position" title='The "position" property'>position</a>"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a>                : Read / Write
  61 </pre>
  62 </div>
  63 <div class="refsect1">
  64 <a name="gst-plugins-good-plugins-shapewipe.description"></a><h2>Description</h2>
  65 <p>
  66 The shapewipe element provides custom transitions on video streams
  67 based on a grayscale bitmap. The state of the transition can be
  68 controlled by the position property and an optional blended border
  69 can be added by the border property.
  70 </p>
  71 <p>
  72 Transition bitmaps can be downloaded from the
  73 <a class="ulink" href="http://cinelerra.org/transitions.php" target="_top">Cinelerra transition</a>
  74 page.
  75 </p>
  76 <p>
  77 </p>
  78 <div class="refsect2">
  79 <a name="idp19852704"></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 <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>yuv<span class="gtkdoc opt">,</span>format<span class="gtkdoc opt">=(</span>fourcc<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> ffmpegcolorspace <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> decodebin2 <span class="gtkdoc opt">!</span> ffmpegcolorspace <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>yuv<span class="gtkdoc opt">,</span>format<span class="gtkdoc opt">=(</span>fourcc<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>
  86       </tr>
  87     </tbody>
  88   </table>
  89 </div>
  90  This pipeline adds the transition from mask.png with position 0.5 to an SMPTE test screen and snow.
  91 </div>
  92 <p>
  93 </p>
  94 <div class="refsynopsisdiv">
  95 <h2>Synopsis</h2>
  96 <div class="refsect2">
  97 <a name="idp19556048"></a><h3>Element Information</h3>
  98 <div class="variablelist"><table border="0">
  99 <col align="left" valign="top">
 100 <tbody>
 101 <tr>
 102 <td><p><span class="term">plugin</span></p></td>
 103 <td>
 104             <a class="link" href="gst-plugins-good-plugins-plugin-shapewipe.html#plugin-shapewipe">shapewipe</a>
 105           </td>
 106 </tr>
 107 <tr>
 108 <td><p><span class="term">author</span></p></td>
 109 <td>Sebastian Dröge &lt;sebastian.droege@collabora.co.uk&gt;</td>
 110 </tr>
 111 <tr>
 112 <td><p><span class="term">class</span></p></td>
 113 <td>Filter/Editor/Video</td>
 114 </tr>
 115 </tbody>
 116 </table></div>
 117 </div>
 118 <hr>
 119 <div class="refsect2">
 120 <a name="idp19645552"></a><h3>Element Pads</h3>
 121 <div class="variablelist"><table border="0">
 122 <col align="left" valign="top">
 123 <tbody>
 124 <tr>
 125 <td><p><span class="term">name</span></p></td>
 126 <td>mask_sink</td>
 127 </tr>
 128 <tr>
 129 <td><p><span class="term">direction</span></p></td>
 130 <td>sink</td>
 131 </tr>
 132 <tr>
 133 <td><p><span class="term">presence</span></p></td>
 134 <td>always</td>
 135 </tr>
 136 <tr>
 137 <td><p><span class="term">details</span></p></td>
 138 <td>video/x-raw-gray, bpp=(int)8, depth=(int)8, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)0/1</td>
 139 </tr>
 140 <tr>
 141 <td><p><span class="term"></span></p></td>
 142 <td> video/x-raw-gray, bpp=(int)16, depth=(int)16, endianness=(int)1234, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)0/1</td>
 143 </tr>
 144 </tbody>
 145 </table></div>
 146 <div class="variablelist"><table border="0">
 147 <col align="left" valign="top">
 148 <tbody>
 149 <tr>
 150 <td><p><span class="term">name</span></p></td>
 151 <td>video_sink</td>
 152 </tr>
 153 <tr>
 154 <td><p><span class="term">direction</span></p></td>
 155 <td>sink</td>
 156 </tr>
 157 <tr>
 158 <td><p><span class="term">presence</span></p></td>
 159 <td>always</td>
 160 </tr>
 161 <tr>
 162 <td><p><span class="term">details</span></p></td>
 163 <td>video/x-raw-yuv, format=(fourcc)AYUV, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 164 </tr>
 165 <tr>
 166 <td><p><span class="term"></span></p></td>
 167 <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>
 168 </tr>
 169 <tr>
 170 <td><p><span class="term"></span></p></td>
 171 <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>
 172 </tr>
 173 <tr>
 174 <td><p><span class="term"></span></p></td>
 175 <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>
 176 </tr>
 177 <tr>
 178 <td><p><span class="term"></span></p></td>
 179 <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>
 180 </tr>
 181 </tbody>
 182 </table></div>
 183 <div class="variablelist"><table border="0">
 184 <col align="left" valign="top">
 185 <tbody>
 186 <tr>
 187 <td><p><span class="term">name</span></p></td>
 188 <td>src</td>
 189 </tr>
 190 <tr>
 191 <td><p><span class="term">direction</span></p></td>
 192 <td>source</td>
 193 </tr>
 194 <tr>
 195 <td><p><span class="term">presence</span></p></td>
 196 <td>always</td>
 197 </tr>
 198 <tr>
 199 <td><p><span class="term">details</span></p></td>
 200 <td>video/x-raw-yuv, format=(fourcc)AYUV, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 201 </tr>
 202 <tr>
 203 <td><p><span class="term"></span></p></td>
 204 <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>
 205 </tr>
 206 <tr>
 207 <td><p><span class="term"></span></p></td>
 208 <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>
 209 </tr>
 210 <tr>
 211 <td><p><span class="term"></span></p></td>
 212 <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>
 213 </tr>
 214 <tr>
 215 <td><p><span class="term"></span></p></td>
 216 <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>
 217 </tr>
 218 </tbody>
 219 </table></div>
 220 </div>
 221 </div>
 222 <p>
 223 </p>
 224 </div>
 225 <div class="refsect1">
 226 <a name="gst-plugins-good-plugins-shapewipe.details"></a><h2>Details</h2>
 227 <div class="refsect2">
 228 <a name="GstShapeWipe-struct"></a><h3>struct GstShapeWipe</h3>
 229 <pre class="programlisting">struct GstShapeWipe;</pre>
 230 <p>
 231 </p>
 232 </div>
 233 </div>
 234 <div class="refsect1">
 235 <a name="gst-plugins-good-plugins-shapewipe.property-details"></a><h2>Property Details</h2>
 236 <div class="refsect2">
 237 <a name="GstShapeWipe--border"></a><h3>The <code class="literal">"border"</code> property</h3>
 238 <pre class="programlisting">  "border"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a>                : Read / Write</pre>
 239 <p>Border of the mask.</p>
 240 <p>Allowed values: [0,1]</p>
 241 <p>Default value: 0</p>
 242 </div>
 243 <hr>
 244 <div class="refsect2">
 245 <a name="GstShapeWipe--position"></a><h3>The <code class="literal">"position"</code> property</h3>
 246 <pre class="programlisting">  "position"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a>                : Read / Write</pre>
 247 <p>Position of the mask.</p>
 248 <p>Allowed values: [0,1]</p>
 249 <p>Default value: 0</p>
 250 </div>
 251 </div>
 252 </div>
 253 <div class="footer">
 254 <hr>
 255           Generated by GTK-Doc V1.18</div>
 256 </body>
 257 </html>