PageRenderTime 57ms CodeModel.GetById 21ms RepoModel.GetById 0ms app.codeStats 0ms

/Main/GStreamer/Source/gst-plugins-good/docs/plugins/html/gst-plugins-good-plugins-smpte.html

http://ossbuild.googlecode.com/
HTML | 256 lines | 256 code | 0 blank | 0 comment | 0 complexity | b377956af2e292a38b67b7097232ed24 MD5 | raw file
Possible License(s): MPL-2.0-no-copyleft-exception, GPL-2.0, AGPL-1.0, LGPL-2.1, LGPL-2.0, GPL-3.0, LGPL-3.0, CC-BY-SA-3.0
  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>smpte</title>
  6. <meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
  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-smokeenc.html" title="smokeenc">
  10. <link rel="next" href="gst-plugins-good-plugins-smptealpha.html" title="smptealpha">
  11. <meta name="generator" content="GTK-Doc V1.17 (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-smokeenc.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-smptealpha.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-smpte.synopsis" class="shortcut">Top</a>
  25.  | 
  26. <a href="#gst-plugins-good-plugins-smpte.description" class="shortcut">Description</a>
  27.  | 
  28. <a href="#gst-plugins-good-plugins-smpte.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29.  | 
  30. <a href="#gst-plugins-good-plugins-smpte.properties" class="shortcut">Properties</a>
  31. </td></tr>
  32. </table>
  33. <div class="refentry">
  34. <a name="gst-plugins-good-plugins-smpte"></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-smpte.top_of_page"></a>smpte</span></h2>
  38. <p>smpte — Apply the standard SMPTE transitions 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-smpte.synopsis"></a><h2>Synopsis</h2>
  44. <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>;
  45. </pre>
  46. </div>
  47. <div class="refsect1">
  48. <a name="gst-plugins-good-plugins-smpte.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. +----GstSMPTE
  54. </pre>
  55. </div>
  56. <div class="refsect1">
  57. <a name="gst-plugins-good-plugins-smpte.properties"></a><h2>Properties</h2>
  58. <pre class="synopsis">
  59. "<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
  60. "<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
  61. "<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
  62. "<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
  63. "<a class="link" href="gst-plugins-good-plugins-smpte.html#GstSMPTE--duration" title='The "duration" property'>duration</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> : Read / Write
  64. "<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
  65. </pre>
  66. </div>
  67. <div class="refsect1">
  68. <a name="gst-plugins-good-plugins-smpte.description"></a><h2>Description</h2>
  69. <p>
  70. smpte can accept I420 video streams with the same width, height and
  71. framerate. The two incomming buffers are blended together using an effect
  72. specific alpha mask.
  73. </p>
  74. <p>
  75. The <span class="type">"depth"</span> property defines the presision in bits of the mask. A
  76. higher presision will create a mask with smoother gradients in order to avoid
  77. banding.
  78. </p>
  79. <p>
  80. </p>
  81. <div class="refsect2">
  82. <a name="idp18824368"></a><h3>Sample pipelines</h3>
  83. <div class="informalexample">
  84. <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
  85. <tbody>
  86. <tr>
  87. <td class="listing_lines" align="right"><pre>1</pre></td>
  88. <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch <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> ffmpegcolorspace <span class="gtkdoc opt">!</span> ximagesink videotestsrc <span class="gtkdoc opt">!</span> s<span class="gtkdoc opt">.</span></pre></td>
  89. </tr>
  90. </tbody>
  91. </table>
  92. </div>
  93. A pipeline to demonstrate the smpte transition.
  94. It shows a pinwheel transition a from a snow videotestsrc to an smpte
  95. pattern videotestsrc. The transition will take 2 seconds to complete. The
  96. edges of the transition are smoothed with a 20000 big border.
  97. </div>
  98. <p>
  99. </p>
  100. <div class="refsynopsisdiv">
  101. <h2>Synopsis</h2>
  102. <div class="refsect2">
  103. <a name="idp21054496"></a><h3>Element Information</h3>
  104. <div class="variablelist"><table border="0">
  105. <col align="left" valign="top">
  106. <tbody>
  107. <tr>
  108. <td><p><span class="term">plugin</span></p></td>
  109. <td>
  110. <a class="link" href="gst-plugins-good-plugins-plugin-smpte.html#plugin-smpte">smpte</a>
  111. </td>
  112. </tr>
  113. <tr>
  114. <td><p><span class="term">author</span></p></td>
  115. <td>Wim Taymans &lt;wim.taymans@chello.be&gt;</td>
  116. </tr>
  117. <tr>
  118. <td><p><span class="term">class</span></p></td>
  119. <td>Filter/Editor/Video</td>
  120. </tr>
  121. </tbody>
  122. </table></div>
  123. </div>
  124. <hr>
  125. <div class="refsect2">
  126. <a name="idp19797456"></a><h3>Element Pads</h3>
  127. <div class="variablelist"><table border="0">
  128. <col align="left" valign="top">
  129. <tbody>
  130. <tr>
  131. <td><p><span class="term">name</span></p></td>
  132. <td>sink1</td>
  133. </tr>
  134. <tr>
  135. <td><p><span class="term">direction</span></p></td>
  136. <td>sink</td>
  137. </tr>
  138. <tr>
  139. <td><p><span class="term">presence</span></p></td>
  140. <td>always</td>
  141. </tr>
  142. <tr>
  143. <td><p><span class="term">details</span></p></td>
  144. <td>video/x-raw-yuv, format=(fourcc)I420, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
  145. </tr>
  146. </tbody>
  147. </table></div>
  148. <div class="variablelist"><table border="0">
  149. <col align="left" valign="top">
  150. <tbody>
  151. <tr>
  152. <td><p><span class="term">name</span></p></td>
  153. <td>sink2</td>
  154. </tr>
  155. <tr>
  156. <td><p><span class="term">direction</span></p></td>
  157. <td>sink</td>
  158. </tr>
  159. <tr>
  160. <td><p><span class="term">presence</span></p></td>
  161. <td>always</td>
  162. </tr>
  163. <tr>
  164. <td><p><span class="term">details</span></p></td>
  165. <td>video/x-raw-yuv, format=(fourcc)I420, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
  166. </tr>
  167. </tbody>
  168. </table></div>
  169. <div class="variablelist"><table border="0">
  170. <col align="left" valign="top">
  171. <tbody>
  172. <tr>
  173. <td><p><span class="term">name</span></p></td>
  174. <td>src</td>
  175. </tr>
  176. <tr>
  177. <td><p><span class="term">direction</span></p></td>
  178. <td>source</td>
  179. </tr>
  180. <tr>
  181. <td><p><span class="term">presence</span></p></td>
  182. <td>always</td>
  183. </tr>
  184. <tr>
  185. <td><p><span class="term">details</span></p></td>
  186. <td>video/x-raw-yuv, format=(fourcc)I420, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
  187. </tr>
  188. </tbody>
  189. </table></div>
  190. </div>
  191. </div>
  192. <p>
  193. </p>
  194. </div>
  195. <div class="refsect1">
  196. <a name="gst-plugins-good-plugins-smpte.details"></a><h2>Details</h2>
  197. <div class="refsect2">
  198. <a name="GstSMPTE-struct"></a><h3>struct GstSMPTE</h3>
  199. <pre class="programlisting">struct GstSMPTE;</pre>
  200. <p>
  201. </p>
  202. </div>
  203. </div>
  204. <div class="refsect1">
  205. <a name="gst-plugins-good-plugins-smpte.property-details"></a><h2>Property Details</h2>
  206. <div class="refsect2">
  207. <a name="GstSMPTE--border"></a><h3>The <code class="literal">"border"</code> property</h3>
  208. <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>
  209. <p>The border width of the transition.</p>
  210. <p>Allowed values: &gt;= 0</p>
  211. <p>Default value: 0</p>
  212. </div>
  213. <hr>
  214. <div class="refsect2">
  215. <a name="GstSMPTE--depth"></a><h3>The <code class="literal">"depth"</code> property</h3>
  216. <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>
  217. <p>Depth of the mask in bits.</p>
  218. <p>Allowed values: [1,24]</p>
  219. <p>Default value: 16</p>
  220. </div>
  221. <hr>
  222. <div class="refsect2">
  223. <a name="GstSMPTE--fps"></a><h3>The <code class="literal">"fps"</code> property</h3>
  224. <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>
  225. <p>Frames per second if no input files are given (deprecated).</p>
  226. <p>Allowed values: &gt;= 0</p>
  227. <p>Default value: 0</p>
  228. </div>
  229. <hr>
  230. <div class="refsect2">
  231. <a name="GstSMPTE--type"></a><h3>The <code class="literal">"type"</code> property</h3>
  232. <pre class="programlisting"> "type" <span class="type">GstSMPTETransitionType</span> : Read / Write</pre>
  233. <p>The type of transition to use.</p>
  234. <p>Default value: A bar moves from left to right</p>
  235. </div>
  236. <hr>
  237. <div class="refsect2">
  238. <a name="GstSMPTE--duration"></a><h3>The <code class="literal">"duration"</code> property</h3>
  239. <pre class="programlisting"> "duration" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> : Read / Write</pre>
  240. <p>Duration of the transition effect in nanoseconds.</p>
  241. <p>Default value: 1000000000</p>
  242. </div>
  243. <hr>
  244. <div class="refsect2">
  245. <a name="GstSMPTE--invert"></a><h3>The <code class="literal">"invert"</code> property</h3>
  246. <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>
  247. <p>Invert transition mask.</p>
  248. <p>Default value: FALSE</p>
  249. </div>
  250. </div>
  251. </div>
  252. <div class="footer">
  253. <hr>
  254. Generated by GTK-Doc V1.17</div>
  255. </body>
  256. </html>