| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| <html> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>videomark</title> |
| <meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> |
| <link rel="home" href="index.html" title="GStreamer Bad Plugins 1.0 Plugins Reference Manual"> |
| <link rel="up" href="ch01.html" title="gst-plugins-bad Elements"> |
| <link rel="prev" href="gst-plugins-bad-plugins-videodetect.html" title="videodetect"> |
| <link rel="next" href="gst-plugins-bad-plugins-videoparse.html" title="videoparse"> |
| <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-bad-plugins-videodetect.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 Bad Plugins 1.0 Plugins Reference Manual</th> |
| <td><a accesskey="n" href="gst-plugins-bad-plugins-videoparse.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-bad-plugins-videomark.synopsis" class="shortcut">Top</a> |
| | |
| <a href="#gst-plugins-bad-plugins-videomark.description" class="shortcut">Description</a> |
| | |
| <a href="#gst-plugins-bad-plugins-videomark.properties" class="shortcut">Properties</a> |
| </td></tr> |
| </table> |
| <div class="refentry"> |
| <a name="gst-plugins-bad-plugins-videomark"></a><div class="titlepage"></div> |
| <div class="refnamediv"><table width="100%"><tr> |
| <td valign="top"> |
| <h2><span class="refentrytitle"><a name="gst-plugins-bad-plugins-videomark.top_of_page"></a>videomark</span></h2> |
| <p>videomark — Marks a video signal with a pattern</p> |
| </td> |
| <td valign="top" align="right"></td> |
| </tr></table></div> |
| <div class="refsynopsisdiv"> |
| <a name="gst-plugins-bad-plugins-videomark.synopsis"></a><h2>Synopsis</h2> |
| <pre class="synopsis">struct <a class="link" href="gst-plugins-bad-plugins-videomark.html#GstVideoMark" title="struct GstVideoMark">GstVideoMark</a>; |
| </pre> |
| </div> |
| <div class="refsect1"> |
| <a name="gst-plugins-bad-plugins-videomark.properties"></a><h2>Properties</h2> |
| <pre class="synopsis"> |
| "<a class="link" href="gst-plugins-bad-plugins-videomark.html#GstVideoMark--enabled" title='The "enabled" property'>enabled</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write / Construct |
| "<a class="link" href="gst-plugins-bad-plugins-videomark.html#GstVideoMark--pattern-count" title='The "pattern-count" property'>pattern-count</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write / Construct |
| "<a class="link" href="gst-plugins-bad-plugins-videomark.html#GstVideoMark--pattern-data" title='The "pattern-data" property'>pattern-data</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-bad-plugins-videomark.html#GstVideoMark--pattern-data-count" title='The "pattern-data-count" property'>pattern-data-count</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write / Construct |
| "<a class="link" href="gst-plugins-bad-plugins-videomark.html#GstVideoMark--pattern-height" title='The "pattern-height" property'>pattern-height</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write / Construct |
| "<a class="link" href="gst-plugins-bad-plugins-videomark.html#GstVideoMark--pattern-width" title='The "pattern-width" property'>pattern-width</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write / Construct |
| "<a class="link" href="gst-plugins-bad-plugins-videomark.html#GstVideoMark--bottom-offset" title='The "bottom-offset" property'>bottom-offset</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write / Construct |
| "<a class="link" href="gst-plugins-bad-plugins-videomark.html#GstVideoMark--left-offset" title='The "left-offset" property'>left-offset</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write / Construct |
| "<a class="link" href="gst-plugins-bad-plugins-videomark.html#GstVideoMark--pattern-data-uint64" title='The "pattern-data-uint64" property'>pattern-data-uint64</a>" <span class="type">guint64</span> : Read / Write / Construct |
| </pre> |
| </div> |
| <div class="refsect1"> |
| <a name="gst-plugins-bad-plugins-videomark.description"></a><h2>Description</h2> |
| <p> |
| This plugin produces <span class="type">"pattern-count"</span> squares in the bottom left |
| corner of the video frames. The squares have a width and height of |
| respectively <a class="link" href="gst-plugins-bad-plugins-videomark.html#GstVideoMark--pattern-width" title='The "pattern-width" property'><span class="type">"pattern-width"</span></a> and <a class="link" href="gst-plugins-bad-plugins-videomark.html#GstVideoMark--pattern-height" title='The "pattern-height" property'><span class="type">"pattern-height"</span></a>. |
| Even squares will be black and odd squares will be white. |
| </p> |
| <p> |
| After writing the pattern, <a class="link" href="gst-plugins-bad-plugins-videomark.html#GstVideoMark--pattern-data-count" title='The "pattern-data-count" property'><span class="type">"pattern-data-count"</span></a> squares after the |
| pattern squares are produced as the bitarray given in |
| <a class="link" href="gst-plugins-bad-plugins-videomark.html#GstVideoMark--pattern-data" title='The "pattern-data" property'><span class="type">"pattern-data"</span></a>. 1 bits will produce white squares and 0 bits will |
| produce black squares. |
| </p> |
| <p> |
| The element can be enabled with the <a class="link" href="gst-plugins-bad-plugins-videomark.html#GstVideoMark--enabled" title='The "enabled" property'><span class="type">"enabled"</span></a> property. It is |
| mostly used together with the <a class="link" href="gst-plugins-bad-plugins-videodetect.html#GstVideoDetect" title="struct GstVideoDetect"><span class="type">GstVideoDetect</span></a> plugin. |
| </p> |
| <p> |
| </p> |
| <div class="refsect2"> |
| <a name="idp21917808"></a><h3>Example launch line</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 videotestsrc <span class="gtkdoc opt">!</span> videomark <span class="gtkdoc opt">!</span> ximagesink</pre></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| Add the default black/white squares at the bottom left of the video frames. |
| </div> |
| <p> |
| </p> |
| <p> |
| Last reviewed on 2007-06-01 (0.10.6) |
| </p> |
| <div class="refsynopsisdiv"> |
| <h2>Synopsis</h2> |
| <div class="refsect2"> |
| <a name="idp21920880"></a><h3>Element Information</h3> |
| <div class="variablelist"><table border="0"> |
| <col align="left" valign="top"> |
| <tbody> |
| <tr> |
| <td><p><span class="term">plugin</span></p></td> |
| <td> |
| <a class="link" href="gst-plugins-bad-plugins-plugin-videosignal.html#plugin-videosignal">videosignal</a> |
| </td> |
| </tr> |
| <tr> |
| <td><p><span class="term">author</span></p></td> |
| <td>Wim Taymans <wim@fluendo.com></td> |
| </tr> |
| <tr> |
| <td><p><span class="term">class</span></p></td> |
| <td>Filter/Effect/Video</td> |
| </tr> |
| </tbody> |
| </table></div> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="idp22800128"></a><h3>Element Pads</h3> |
| <div class="variablelist"><table border="0"> |
| <col align="left" valign="top"> |
| <tbody> |
| <tr> |
| <td><p><span class="term">name</span></p></td> |
| <td>sink</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-yuv, format=(fourcc){ I420, YV12, Y41B, Y42B, Y444, YUY2, UYVY, AYUV, YVYU }, 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"> |
| <col align="left" valign="top"> |
| <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-yuv, format=(fourcc){ I420, YV12, Y41B, Y42B, Y444, YUY2, UYVY, AYUV, YVYU }, 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-bad-plugins-videomark.details"></a><h2>Details</h2> |
| <div class="refsect2"> |
| <a name="GstVideoMark"></a><h3>struct GstVideoMark</h3> |
| <pre class="programlisting">struct GstVideoMark { |
| GstVideoFilter videofilter; |
| |
| gint width, height; |
| GstVideoFormat format; |
| |
| gint pattern_width; |
| gint pattern_height; |
| gint pattern_count; |
| gint pattern_data_count; |
| guint64 pattern_data; |
| gboolean enabled; |
| gint left_offset; |
| gint bottom_offset; |
| }; |
| </pre> |
| <p> |
| Opaque datastructure. |
| </p> |
| </div> |
| </div> |
| <div class="refsect1"> |
| <a name="gst-plugins-bad-plugins-videomark.property-details"></a><h2>Property Details</h2> |
| <div class="refsect2"> |
| <a name="GstVideoMark--enabled"></a><h3>The <code class="literal">"enabled"</code> property</h3> |
| <pre class="programlisting"> "enabled" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write / Construct</pre> |
| <p>Enable or disable the filter.</p> |
| <p>Default value: TRUE</p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GstVideoMark--pattern-count"></a><h3>The <code class="literal">"pattern-count"</code> property</h3> |
| <pre class="programlisting"> "pattern-count" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write / Construct</pre> |
| <p>The number of pattern markers.</p> |
| <p>Allowed values: >= 0</p> |
| <p>Default value: 4</p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GstVideoMark--pattern-data"></a><h3>The <code class="literal">"pattern-data"</code> property</h3> |
| <pre class="programlisting"> "pattern-data" <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 extra data pattern markers.</p> |
| <p>Allowed values: >= 0</p> |
| <p>Default value: 10</p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GstVideoMark--pattern-data-count"></a><h3>The <code class="literal">"pattern-data-count"</code> property</h3> |
| <pre class="programlisting"> "pattern-data-count" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write / Construct</pre> |
| <p>The number of extra data pattern markers.</p> |
| <p>Allowed values: [0,64]</p> |
| <p>Default value: 5</p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GstVideoMark--pattern-height"></a><h3>The <code class="literal">"pattern-height"</code> property</h3> |
| <pre class="programlisting"> "pattern-height" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write / Construct</pre> |
| <p>The height of the pattern markers.</p> |
| <p>Allowed values: >= 1</p> |
| <p>Default value: 16</p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GstVideoMark--pattern-width"></a><h3>The <code class="literal">"pattern-width"</code> property</h3> |
| <pre class="programlisting"> "pattern-width" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write / Construct</pre> |
| <p>The width of the pattern markers.</p> |
| <p>Allowed values: >= 1</p> |
| <p>Default value: 4</p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GstVideoMark--bottom-offset"></a><h3>The <code class="literal">"bottom-offset"</code> property</h3> |
| <pre class="programlisting"> "bottom-offset" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write / Construct</pre> |
| <p>The offset from the bottom border where the pattern starts.</p> |
| <p>Allowed values: >= 0</p> |
| <p>Default value: 0</p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GstVideoMark--left-offset"></a><h3>The <code class="literal">"left-offset"</code> property</h3> |
| <pre class="programlisting"> "left-offset" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write / Construct</pre> |
| <p>The offset from the left border where the pattern starts.</p> |
| <p>Allowed values: >= 0</p> |
| <p>Default value: 0</p> |
| </div> |
| <hr> |
| <div class="refsect2"> |
| <a name="GstVideoMark--pattern-data-uint64"></a><h3>The <code class="literal">"pattern-data-uint64"</code> property</h3> |
| <pre class="programlisting"> "pattern-data-uint64" <span class="type">guint64</span> : Read / Write / Construct</pre> |
| <p>The extra data pattern markers.</p> |
| <p>Default value: 10</p> |
| </div> |
| </div> |
| <div class="refsect1"> |
| <a name="gst-plugins-bad-plugins-videomark.see-also"></a><h2>See Also</h2> |
| <a class="link" href="gst-plugins-bad-plugins-videodetect.html#GstVideoDetect" title="struct GstVideoDetect"><span class="type">GstVideoDetect</span></a> |
| </div> |
| </div> |
| <div class="footer"> |
| <hr> |
| Generated by GTK-Doc V1.18</div> |
| </body> |
| </html> |
