docs/plugins/html/gst-plugins-good-plugins-smptealpha.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>smptealpha</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-smpte.html" title="smpte">
  10 <link rel="next" href="gst-plugins-good-plugins-souphttpsrc.html" title="souphttpsrc">
  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-smpte.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-souphttpsrc.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-smptealpha.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-good-plugins-smptealpha.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gst-plugins-good-plugins-smptealpha.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#gst-plugins-good-plugins-smptealpha.properties" class="shortcut">Properties</a>
  31 </td></tr>
  32 </table>
  33 <div class="refentry">
  34 <a name="gst-plugins-good-plugins-smptealpha"></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-smptealpha.top_of_page"></a>smptealpha</span></h2>
  38 <p>smptealpha — Apply the standard SMPTE transitions as alpha on video images</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-smptealpha.synopsis"></a><h2>Synopsis</h2>
  44 <a name="GstSMPTEAlpha"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-good-plugins-smptealpha.html#GstSMPTEAlpha-struct" title="struct GstSMPTEAlpha">GstSMPTEAlpha</a>;
  45 </pre>
  46 </div>
  47 <div class="refsect1">
  48 <a name="gst-plugins-good-plugins-smptealpha.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                +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstBaseTransform.html">GstBaseTransform</a>
  54                      +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstvideofilter.html#GstVideoFilter">GstVideoFilter</a>
  55                            +----GstSMPTEAlpha
  56 </pre>
  57 </div>
  58 <div class="refsect1">
  59 <a name="gst-plugins-good-plugins-smptealpha.properties"></a><h2>Properties</h2>
  60 <pre class="synopsis">
  61   "<a class="link" href="gst-plugins-good-plugins-smptealpha.html#GstSMPTEAlpha--border" title='The "border" property'>border</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-smptealpha.html#GstSMPTEAlpha--depth" title='The "depth" property'>depth</a>"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
  63   "<a class="link" href="gst-plugins-good-plugins-smptealpha.html#GstSMPTEAlpha--position" title='The "position" property'>position</a>"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write
  64   "<a class="link" href="gst-plugins-good-plugins-smptealpha.html#GstSMPTEAlpha--type" title='The "type" property'>type</a>"                     <span class="type">GstSMPTEAlphaTransitionType</span>  : Read / Write
  65   "<a class="link" href="gst-plugins-good-plugins-smptealpha.html#GstSMPTEAlpha--invert" title='The "invert" property'>invert</a>"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  66 </pre>
  67 </div>
  68 <div class="refsect1">
  69 <a name="gst-plugins-good-plugins-smptealpha.description"></a><h2>Description</h2>
  70 <p>
  71 smptealpha can accept an I420 or AYUV video stream. An alpha channel is added
  72 using an effect specific SMPTE mask in the I420 input case. In the AYUV case,
  73 the alpha channel is modified using the effect specific SMPTE mask.
  74 </p>
  75 <p>
  76 The <span class="type">"position"</span> property is a controllabe double between 0.0 and
  77 1.0 that specifies the position in the transition. 0.0 is the start of the
  78 transition with the alpha channel to complete opaque where 1.0 has the alpha
  79 channel set to completely transparent.
  80 </p>
  81 <p>
  82 The <span class="type">"depth"</span> property defines the precision in bits of the mask.
  83 A higher presision will create a mask with smoother gradients in order to
  84 avoid banding.
  85 </p>
  86 <p>
  87 </p>
  88 <div class="refsect2">
  89 <a name="idp20980288"></a><h3>Sample pipelines</h3>
  90 <p>
  91 Here is a pipeline to demonstrate the smpte transition :
  92 </p>
  93 <pre class="programlisting">
  94 gst-launch -v videotestsrc ! smptealpha border=20000 type=44
  95 position=0.5 ! videomixer ! ffmpegcolorspace ! ximagesink
  96 </pre>
  97 <p>
  98 This shows a midway bowtie-h transition a from a videotestsrc to a
  99 transparent image. The edges of the transition are smoothed with a
 100 20000 big border.
 101 </p>
 102 </div>
 103 <p>
 104 </p>
 105 <div class="refsynopsisdiv">
 106 <h2>Synopsis</h2>
 107 <div class="refsect2">
 108 <a name="idp19693408"></a><h3>Element Information</h3>
 109 <div class="variablelist"><table border="0">
 110 <col align="left" valign="top">
 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-smpte.html#plugin-smpte">smpte</a>
 116           </td>
 117 </tr>
 118 <tr>
 119 <td><p><span class="term">author</span></p></td>
 120 <td>Wim Taymans &lt;wim.taymans@gmail.com&gt;</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="idp15071024"></a><h3>Element Pads</h3>
 132 <div class="variablelist"><table border="0">
 133 <col align="left" valign="top">
 134 <tbody>
 135 <tr>
 136 <td><p><span class="term">name</span></p></td>
 137 <td>sink</td>
 138 </tr>
 139 <tr>
 140 <td><p><span class="term">direction</span></p></td>
 141 <td>sink</td>
 142 </tr>
 143 <tr>
 144 <td><p><span class="term">presence</span></p></td>
 145 <td>always</td>
 146 </tr>
 147 <tr>
 148 <td><p><span class="term">details</span></p></td>
 149 <td>video/x-raw-yuv, format=(fourcc)I420, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 150 </tr>
 151 <tr>
 152 <td><p><span class="term"></span></p></td>
 153 <td> video/x-raw-yuv, format=(fourcc)YV12, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 154 </tr>
 155 <tr>
 156 <td><p><span class="term"></span></p></td>
 157 <td> video/x-raw-yuv, format=(fourcc)AYUV, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
 158 </tr>
 159 <tr>
 160 <td><p><span class="term"></span></p></td>
 161 <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>
 162 </tr>
 163 <tr>
 164 <td><p><span class="term"></span></p></td>
 165 <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>
 166 </tr>
 167 <tr>
 168 <td><p><span class="term"></span></p></td>
 169 <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>
 170 </tr>
 171 <tr>
 172 <td><p><span class="term"></span></p></td>
 173 <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>
 174 </tr>
 175 </tbody>
 176 </table></div>
 177 <div class="variablelist"><table border="0">
 178 <col align="left" valign="top">
 179 <tbody>
 180 <tr>
 181 <td><p><span class="term">name</span></p></td>
 182 <td>src</td>
 183 </tr>
 184 <tr>
 185 <td><p><span class="term">direction</span></p></td>
 186 <td>source</td>
 187 </tr>
 188 <tr>
 189 <td><p><span class="term">presence</span></p></td>
 190 <td>always</td>
 191 </tr>
 192 <tr>
 193 <td><p><span class="term">details</span></p></td>
 194 <td>video/x-raw-yuv, format=(fourcc)AYUV, 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-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>
 199 </tr>
 200 <tr>
 201 <td><p><span class="term"></span></p></td>
 202 <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>
 203 </tr>
 204 <tr>
 205 <td><p><span class="term"></span></p></td>
 206 <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>
 207 </tr>
 208 <tr>
 209 <td><p><span class="term"></span></p></td>
 210 <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>
 211 </tr>
 212 </tbody>
 213 </table></div>
 214 </div>
 215 </div>
 216 <p>
 217 </p>
 218 </div>
 219 <div class="refsect1">
 220 <a name="gst-plugins-good-plugins-smptealpha.details"></a><h2>Details</h2>
 221 <div class="refsect2">
 222 <a name="GstSMPTEAlpha-struct"></a><h3>struct GstSMPTEAlpha</h3>
 223 <pre class="programlisting">struct GstSMPTEAlpha;</pre>
 224 <p>
 225 </p>
 226 </div>
 227 </div>
 228 <div class="refsect1">
 229 <a name="gst-plugins-good-plugins-smptealpha.property-details"></a><h2>Property Details</h2>
 230 <div class="refsect2">
 231 <a name="GstSMPTEAlpha--border"></a><h3>The <code class="literal">"border"</code> property</h3>
 232 <pre class="programlisting">  "border"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 233 <p>The border width of the transition.</p>
 234 <p>Allowed values: &gt;= 0</p>
 235 <p>Default value: 0</p>
 236 </div>
 237 <hr>
 238 <div class="refsect2">
 239 <a name="GstSMPTEAlpha--depth"></a><h3>The <code class="literal">"depth"</code> property</h3>
 240 <pre class="programlisting">  "depth"                    <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
 241 <p>Depth of the mask in bits.</p>
 242 <p>Allowed values: [1,24]</p>
 243 <p>Default value: 16</p>
 244 </div>
 245 <hr>
 246 <div class="refsect2">
 247 <a name="GstSMPTEAlpha--position"></a><h3>The <code class="literal">"position"</code> property</h3>
 248 <pre class="programlisting">  "position"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write</pre>
 249 <p>Position of the transition effect.</p>
 250 <p>Allowed values: [0,1]</p>
 251 <p>Default value: 0</p>
 252 </div>
 253 <hr>
 254 <div class="refsect2">
 255 <a name="GstSMPTEAlpha--type"></a><h3>The <code class="literal">"type"</code> property</h3>
 256 <pre class="programlisting">  "type"                     <span class="type">GstSMPTEAlphaTransitionType</span>  : Read / Write</pre>
 257 <p>The type of transition to use.</p>
 258 <p>Default value: A bar moves from left to right</p>
 259 </div>
 260 <hr>
 261 <div class="refsect2">
 262 <a name="GstSMPTEAlpha--invert"></a><h3>The <code class="literal">"invert"</code> property</h3>
 263 <pre class="programlisting">  "invert"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 264 <p>
 265 Set to TRUE to invert the transition mask (ie. flip it horizontally).
 266 </p>
 267 <p>Default value: FALSE</p>
 268 <p class="since">Since 0.10.23</p>
 269 </div>
 270 </div>
 271 </div>
 272 <div class="footer">
 273 <hr>
 274           Generated by GTK-Doc V1.18</div>
 275 </body>
 276 </html>