Google Git
Sign in
coral / mtk-gst-plugins-good-debian / 5f0bab00cdb35b85ff8dfd099c23d4f368a71abd / . / docs / plugins / html / gst-plugins-good-plugins-smpte.html
blob: 9772eb7c404d7139c811ffd2f01685b774b6c91c [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>smpte</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="GStreamer Good Plugins 1.0 Plugins Reference Manual">
<link rel="up" href="ch01.html" title="gst-plugins-good Elements">
<link rel="prev" href="gst-plugins-good-plugins-shapewipe.html" title="shapewipe">
<link rel="next" href="gst-plugins-good-plugins-smptealpha.html" title="smptealpha">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="gst-plugins-good-plugins-shapewipe.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GStreamer Good Plugins 1.0 Plugins Reference Manual</th>
<td><a accesskey="n" href="gst-plugins-good-plugins-smptealpha.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#gst-plugins-good-plugins-smpte.synopsis" class="shortcut">Top</a>
 | 
<a href="#gst-plugins-good-plugins-smpte.description" class="shortcut">Description</a>
 | 
<a href="#gst-plugins-good-plugins-smpte.object-hierarchy" class="shortcut">Object Hierarchy</a>
 | 
<a href="#gst-plugins-good-plugins-smpte.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry">
<a name="gst-plugins-good-plugins-smpte"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gst-plugins-good-plugins-smpte.top_of_page"></a>smpte</span></h2>
<p>smpte — Apply the standard SMPTE transitions on video images</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="gst-plugins-good-plugins-smpte.synopsis"></a><h2>Synopsis</h2>
<a name="GstSMPTE"></a><pre class="synopsis">struct <a class="link" href="gst-plugins-good-plugins-smpte.html#GstSMPTE-struct" title="struct GstSMPTE">GstSMPTE</a>;
</pre>
</div>
<div class="refsect1">
<a name="gst-plugins-good-plugins-smpte.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
+----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
+----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
+----GstSMPTE
</pre>
</div>
<div class="refsect1">
<a name="gst-plugins-good-plugins-smpte.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="gst-plugins-good-plugins-smpte.html#GstSMPTE--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
"<a class="link" href="gst-plugins-good-plugins-smpte.html#GstSMPTE--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
"<a class="link" href="gst-plugins-good-plugins-smpte.html#GstSMPTE--fps" title='The "fps" property'>fps</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> : Read / Write
"<a class="link" href="gst-plugins-good-plugins-smpte.html#GstSMPTE--type" title='The "type" property'>type</a>" <span class="type">GstSMPTETransitionType</span> : Read / Write
"<a class="link" href="gst-plugins-good-plugins-smpte.html#GstSMPTE--duration" title='The "duration" property'>duration</a>" <span class="type">guint64</span> : Read / Write
"<a class="link" href="gst-plugins-good-plugins-smpte.html#GstSMPTE--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
</pre>
</div>
<div class="refsect1">
<a name="gst-plugins-good-plugins-smpte.description"></a><h2>Description</h2>
<p>
smpte can accept I420 video streams with the same width, height and
framerate. The two incomming buffers are blended together using an effect
specific alpha mask.
</p>
<p>
The <span class="type">"depth"</span> property defines the presision in bits of the mask. A
higher presision will create a mask with smoother gradients in order to avoid
banding.
</p>
<p>
</p>
<div class="refsect2">
<a name="idp17804352"></a><h3>Sample pipelines</h3>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1</pre></td>
<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 pattern<span class="gtkdoc opt">=</span><span class="number">1</span> <span class="gtkdoc opt">!</span> smpte name<span class="gtkdoc opt">=</span>s border<span class="gtkdoc opt">=</span><span class="number">20000</span> type<span class="gtkdoc opt">=</span><span class="number">234</span> duration<span class="gtkdoc opt">=</span><span class="number">2000000000</span> <span class="gtkdoc opt">!</span> videoconvert <span class="gtkdoc opt">!</span> ximagesink videotestsrc <span class="gtkdoc opt">!</span> s<span class="gtkdoc opt">.</span></pre></td>
</tr>
</tbody>
</table>
</div>
A pipeline to demonstrate the smpte transition.
It shows a pinwheel transition a from a snow videotestsrc to an smpte
pattern videotestsrc. The transition will take 2 seconds to complete. The
edges of the transition are smoothed with a 20000 big border.
</div>
<p>
</p>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<div class="refsect2">
<a name="idp20131088"></a><h3>Element Information</h3>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">plugin</span></p></td>
<td>
<a class="link" href="gst-plugins-good-plugins-plugin-smpte.html#plugin-smpte">smpte</a>
</td>
</tr>
<tr>
<td><p><span class="term">author</span></p></td>
<td>Wim Taymans &lt;wim.taymans@chello.be&gt;</td>
</tr>
<tr>
<td><p><span class="term">class</span></p></td>
<td>Filter/Editor/Video</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="idp18767456"></a><h3>Element Pads</h3>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">name</span></p></td>
<td>sink1</td>
</tr>
<tr>
<td><p><span class="term">direction</span></p></td>
<td>sink</td>
</tr>
<tr>
<td><p><span class="term">presence</span></p></td>
<td>always</td>
</tr>
<tr>
<td><p><span class="term">details</span></p></td>
<td>video/x-raw, format=(string)I420, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
</tr>
</tbody>
</table></div>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">name</span></p></td>
<td>sink2</td>
</tr>
<tr>
<td><p><span class="term">direction</span></p></td>
<td>sink</td>
</tr>
<tr>
<td><p><span class="term">presence</span></p></td>
<td>always</td>
</tr>
<tr>
<td><p><span class="term">details</span></p></td>
<td>video/x-raw, format=(string)I420, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
</tr>
</tbody>
</table></div>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">name</span></p></td>
<td>src</td>
</tr>
<tr>
<td><p><span class="term">direction</span></p></td>
<td>source</td>
</tr>
<tr>
<td><p><span class="term">presence</span></p></td>
<td>always</td>
</tr>
<tr>
<td><p><span class="term">details</span></p></td>
<td>video/x-raw, format=(string)I420, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<p>
</p>
</div>
<div class="refsect1">
<a name="gst-plugins-good-plugins-smpte.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GstSMPTE-struct"></a><h3>struct GstSMPTE</h3>
<pre class="programlisting">struct GstSMPTE;</pre>
<p>
</p>
</div>
</div>
<div class="refsect1">
<a name="gst-plugins-good-plugins-smpte.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GstSMPTE--border"></a><h3>The <code class="literal">"border"</code> property</h3>
<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>
<p>The border width of the transition.</p>
<p>Allowed values: &gt;= 0</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="GstSMPTE--depth"></a><h3>The <code class="literal">"depth"</code> property</h3>
<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>
<p>Depth of the mask in bits.</p>
<p>Allowed values: [1,24]</p>
<p>Default value: 16</p>
</div>
<hr>
<div class="refsect2">
<a name="GstSMPTE--fps"></a><h3>The <code class="literal">"fps"</code> property</h3>
<pre class="programlisting"> "fps" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> : Read / Write</pre>
<p>Frames per second if no input files are given (deprecated).</p>
<p>Allowed values: &gt;= 0</p>
<p>Default value: 0</p>
</div>
<hr>
<div class="refsect2">
<a name="GstSMPTE--type"></a><h3>The <code class="literal">"type"</code> property</h3>
<pre class="programlisting"> "type" <span class="type">GstSMPTETransitionType</span> : Read / Write</pre>
<p>The type of transition to use.</p>
<p>Default value: A bar moves from left to right</p>
</div>
<hr>
<div class="refsect2">
<a name="GstSMPTE--duration"></a><h3>The <code class="literal">"duration"</code> property</h3>
<pre class="programlisting"> "duration" <span class="type">guint64</span> : Read / Write</pre>
<p>Duration of the transition effect in nanoseconds.</p>
<p>Default value: 1000000000</p>
</div>
<hr>
<div class="refsect2">
<a name="GstSMPTE--invert"></a><h3>The <code class="literal">"invert"</code> property</h3>
<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>
<p>Invert transition mask.</p>
<p>Default value: FALSE</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>