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>simplevideomarkdetect: GStreamer Bad Plugins 1.0 Plugins Reference Manual</title> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="index.html" title="GStreamer Bad Plugins 1.0 Plugins Reference Manual"> 8<link rel="up" href="ch01.html" title="gst-plugins-bad Elements"> 9<link rel="prev" href="gst-plugins-bad-plugins-shmsrc.html" title="shmsrc"> 10<link rel="next" href="gst-plugins-bad-plugins-simplevideomark.html" title="simplevideomark"> 11<meta name="generator" content="GTK-Doc V1.28 (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="5"><tr valign="middle"> 16<td width="100%" align="left" class="shortcuts"> 17<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> 18 <a href="#gst-plugins-bad-plugins-simplevideomarkdetect.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 19 <a href="#gst-plugins-bad-plugins-simplevideomarkdetect.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> 20 <a href="#gst-plugins-bad-plugins-simplevideomarkdetect.properties" class="shortcut">Properties</a></span> 21</td> 22<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> 23<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> 24<td><a accesskey="p" href="gst-plugins-bad-plugins-shmsrc.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> 25<td><a accesskey="n" href="gst-plugins-bad-plugins-simplevideomark.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> 26</tr></table> 27<div class="refentry"> 28<a name="gst-plugins-bad-plugins-simplevideomarkdetect"></a><div class="titlepage"></div> 29<div class="refnamediv"><table width="100%"><tr> 30<td valign="top"> 31<h2><span class="refentrytitle"><a name="gst-plugins-bad-plugins-simplevideomarkdetect.top_of_page"></a>simplevideomarkdetect</span></h2> 32<p>simplevideomarkdetect</p> 33</td> 34<td class="gallery_image" valign="top" align="right"></td> 35</tr></table></div> 36<div class="refsect1"> 37<a name="gst-plugins-bad-plugins-simplevideomarkdetect.properties"></a><h2>Properties</h2> 38<div class="informaltable"><table class="informaltable" border="0"> 39<colgroup> 40<col width="150px" class="properties_type"> 41<col width="300px" class="properties_name"> 42<col width="200px" class="properties_flags"> 43</colgroup> 44<tbody> 45<tr> 46<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> 47<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-simplevideomarkdetect.html#GstSimpleVideoMarkDetect--bottom-offset" title="The “bottom-offset” property">bottom-offset</a></td> 48<td class="property_flags">Read / Write / Construct</td> 49</tr> 50<tr> 51<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> 52<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-simplevideomarkdetect.html#GstSimpleVideoMarkDetect--left-offset" title="The “left-offset” property">left-offset</a></td> 53<td class="property_flags">Read / Write / Construct</td> 54</tr> 55<tr> 56<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> 57<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-simplevideomarkdetect.html#GstSimpleVideoMarkDetect--message" title="The “message” property">message</a></td> 58<td class="property_flags">Read / Write / Construct</td> 59</tr> 60<tr> 61<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></td> 62<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-simplevideomarkdetect.html#GstSimpleVideoMarkDetect--pattern-center" title="The “pattern-center” property">pattern-center</a></td> 63<td class="property_flags">Read / Write / Construct</td> 64</tr> 65<tr> 66<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> 67<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-simplevideomarkdetect.html#GstSimpleVideoMarkDetect--pattern-count" title="The “pattern-count” property">pattern-count</a></td> 68<td class="property_flags">Read / Write / Construct</td> 69</tr> 70<tr> 71<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> 72<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-simplevideomarkdetect.html#GstSimpleVideoMarkDetect--pattern-data-count" title="The “pattern-data-count” property">pattern-data-count</a></td> 73<td class="property_flags">Read / Write / Construct</td> 74</tr> 75<tr> 76<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> 77<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-simplevideomarkdetect.html#GstSimpleVideoMarkDetect--pattern-height" title="The “pattern-height” property">pattern-height</a></td> 78<td class="property_flags">Read / Write / Construct</td> 79</tr> 80<tr> 81<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></td> 82<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-simplevideomarkdetect.html#GstSimpleVideoMarkDetect--pattern-sensitivity" title="The “pattern-sensitivity” property">pattern-sensitivity</a></td> 83<td class="property_flags">Read / Write / Construct</td> 84</tr> 85<tr> 86<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> 87<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-simplevideomarkdetect.html#GstSimpleVideoMarkDetect--pattern-width" title="The “pattern-width” property">pattern-width</a></td> 88<td class="property_flags">Read / Write / Construct</td> 89</tr> 90</tbody> 91</table></div> 92</div> 93<a name="GstSimpleVideoMarkDetect"></a><div class="refsect1"> 94<a name="gst-plugins-bad-plugins-simplevideomarkdetect.other"></a><h2>Types and Values</h2> 95<div class="informaltable"><table class="informaltable" width="100%" border="0"> 96<colgroup> 97<col width="150px" class="name"> 98<col class="description"> 99</colgroup> 100<tbody><tr> 101<td class="datatype_keyword">struct</td> 102<td class="function_name"><a class="link" href="gst-plugins-bad-plugins-simplevideomarkdetect.html#GstSimpleVideoMarkDetect-struct" title="struct GstSimpleVideoMarkDetect">GstSimpleVideoMarkDetect</a></td> 103</tr></tbody> 104</table></div> 105</div> 106<div class="refsect1"> 107<a name="gst-plugins-bad-plugins-simplevideomarkdetect.object-hierarchy"></a><h2>Object Hierarchy</h2> 108<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> 109 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a> 110 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a> 111 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a> 112 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-libs-1.0/GstBaseTransform.html#GstBaseTransform-struct">GstBaseTransform</a> 113 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gst-plugins-base-libs-1.0/GstVideoFilter.html#GstVideoFilter-struct">GstVideoFilter</a> 114 <span class="lineart">╰──</span> GstSimpleVideoMarkDetect 115</pre> 116</div> 117<div class="refsect1"> 118<a name="gst-plugins-bad-plugins-simplevideomarkdetect.description"></a><h2>Description</h2> 119<p>This plugin detects <a class="link" href="gst-plugins-bad-plugins-simplevideomarkdetect.html#GstSimpleVideoMarkDetect--pattern-count" title="The “pattern-count” property"><span class="type">“pattern-count”</span></a> squares in the bottom left 120corner of the video frames. The squares have a width and height of 121respectively <a class="link" href="gst-plugins-bad-plugins-simplevideomarkdetect.html#GstSimpleVideoMarkDetect--pattern-width" title="The “pattern-width” property"><span class="type">“pattern-width”</span></a> and <a class="link" href="gst-plugins-bad-plugins-simplevideomarkdetect.html#GstSimpleVideoMarkDetect--pattern-height" title="The “pattern-height” property"><span class="type">“pattern-height”</span></a>. 122Even squares must be black and odd squares must be white.</p> 123<p>When the pattern has been found, <a class="link" href="gst-plugins-bad-plugins-simplevideomarkdetect.html#GstSimpleVideoMarkDetect--pattern-data-count" title="The “pattern-data-count” property"><span class="type">“pattern-data-count”</span></a> squares 124after the pattern squares are read as a bitarray. White squares represent a 1 125bit and black squares a 0 bit. The bitarray will will included in the element 126message that is posted (see below).</p> 127<p>After the pattern has been found and the data pattern has been read, an 128element message called <code class="literal">GstSimpleVideoMarkDetect</code> will 129be posted on the bus. If the pattern is no longer found in the frame, the 130same element message is posted with the have-pattern field set to <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>. 131The message is only posted if the <a class="link" href="gst-plugins-bad-plugins-simplevideomarkdetect.html#GstSimpleVideoMarkDetect--message" title="The “message” property"><span class="type">“message”</span></a> property is <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>.</p> 132<p>The message's structure contains these fields:</p> 133<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> 134<li class="listitem"><p><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a><code class="literal">have-pattern</code>: if the pattern was found. This field will be set to <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> for as long as 135the pattern was found in the frame and set to FALSE for the first frame 136that does not contain the pattern anymore.</p></li> 137<li class="listitem"><p><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstClock.html#GstClockTime"><span class="type">GstClockTime</span></a> <code class="literal">timestamp</code>: the timestamp of the buffer that triggered the message.</p></li> 138<li class="listitem"><p><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstClock.html#GstClockTime"><span class="type">GstClockTime</span></a> <code class="literal">stream-time</code>: the stream time of the buffer.</p></li> 139<li class="listitem"><p><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstClock.html#GstClockTime"><span class="type">GstClockTime</span></a> <code class="literal">running-time</code>: the running_time of the buffer.</p></li> 140<li class="listitem"><p><a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstClock.html#GstClockTime"><span class="type">GstClockTime</span></a> <code class="literal">duration</code>: the duration of the buffer.</p></li> 141<li class="listitem"><p><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> <code class="literal">data</code>: the data-pattern found after the pattern or 0 when have-signal is <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.</p></li> 142</ul></div> 143<div class="refsect3"> 144<a name="id-1.2.198.7.7"></a><h4>Example launch line</h4> 145<div class="informalexample"> 146 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> 147 <tbody> 148 <tr> 149 <td class="listing_lines" align="right"><pre>1</pre></td> 150 <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> videotestsrc <span class="gtkdoc opt">!</span> simplevideomarkdetect <span class="gtkdoc opt">!</span> videoconvert <span class="gtkdoc opt">!</span> ximagesink</pre></td> 151 </tr> 152 </tbody> 153 </table> 154</div> 155 156<p></p> 157</div> 158<div class="refsynopsisdiv"> 159<h2>Synopsis</h2> 160<div class="refsect2"> 161<a name="id-1.2.198.7.8.1"></a><h3>Element Information</h3> 162<div class="variablelist"><table border="0" class="variablelist"> 163<colgroup> 164<col align="left" valign="top"> 165<col> 166</colgroup> 167<tbody> 168<tr> 169<td><p><span class="term">plugin</span></p></td> 170<td> 171 <a class="link" href="gst-plugins-bad-plugins-plugin-videosignal.html#plugin-videosignal">videosignal</a> 172 </td> 173</tr> 174<tr> 175<td><p><span class="term">author</span></p></td> 176<td>Wim Taymans <wim@fluendo.com></td> 177</tr> 178<tr> 179<td><p><span class="term">class</span></p></td> 180<td>Filter/Effect/Video</td> 181</tr> 182</tbody> 183</table></div> 184</div> 185<hr> 186<div class="refsect2"> 187<a name="id-1.2.198.7.8.2"></a><h3>Element Pads</h3> 188<div class="variablelist"><table border="0" class="variablelist"> 189<colgroup> 190<col align="left" valign="top"> 191<col> 192</colgroup> 193<tbody> 194<tr> 195<td><p><span class="term">name</span></p></td> 196<td>sink</td> 197</tr> 198<tr> 199<td><p><span class="term">direction</span></p></td> 200<td>sink</td> 201</tr> 202<tr> 203<td><p><span class="term">presence</span></p></td> 204<td>always</td> 205</tr> 206<tr> 207<td><p><span class="term">details</span></p></td> 208<td>video/x-raw, format=(string){ I420, YV12, Y41B, Y42B, Y444, YUY2, UYVY, AYUV, YVYU }, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td> 209</tr> 210</tbody> 211</table></div> 212<div class="variablelist"><table border="0" class="variablelist"> 213<colgroup> 214<col align="left" valign="top"> 215<col> 216</colgroup> 217<tbody> 218<tr> 219<td><p><span class="term">name</span></p></td> 220<td>src</td> 221</tr> 222<tr> 223<td><p><span class="term">direction</span></p></td> 224<td>source</td> 225</tr> 226<tr> 227<td><p><span class="term">presence</span></p></td> 228<td>always</td> 229</tr> 230<tr> 231<td><p><span class="term">details</span></p></td> 232<td>video/x-raw, format=(string){ I420, YV12, Y41B, Y42B, Y444, YUY2, UYVY, AYUV, YVYU }, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td> 233</tr> 234</tbody> 235</table></div> 236</div> 237</div> 238</div> 239<div class="refsect1"> 240<a name="gst-plugins-bad-plugins-simplevideomarkdetect.functions_details"></a><h2>Functions</h2> 241<p></p> 242</div> 243<div class="refsect1"> 244<a name="gst-plugins-bad-plugins-simplevideomarkdetect.other_details"></a><h2>Types and Values</h2> 245<div class="refsect2"> 246<a name="GstSimpleVideoMarkDetect-struct"></a><h3>struct GstSimpleVideoMarkDetect</h3> 247<pre class="programlisting">struct GstSimpleVideoMarkDetect;</pre> 248</div> 249</div> 250<div class="refsect1"> 251<a name="gst-plugins-bad-plugins-simplevideomarkdetect.property-details"></a><h2>Property Details</h2> 252<div class="refsect2"> 253<a name="GstSimpleVideoMarkDetect--bottom-offset"></a><h3>The <code class="literal">“bottom-offset”</code> property</h3> 254<pre class="programlisting"> “bottom-offset” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 255<p>The offset from the bottom border where the pattern starts.</p> 256<p>Flags: Read / Write / Construct</p> 257<p>Allowed values: >= 0</p> 258<p>Default value: 0</p> 259</div> 260<hr> 261<div class="refsect2"> 262<a name="GstSimpleVideoMarkDetect--left-offset"></a><h3>The <code class="literal">“left-offset”</code> property</h3> 263<pre class="programlisting"> “left-offset” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 264<p>The offset from the left border where the pattern starts.</p> 265<p>Flags: Read / Write / Construct</p> 266<p>Allowed values: >= 0</p> 267<p>Default value: 0</p> 268</div> 269<hr> 270<div class="refsect2"> 271<a name="GstSimpleVideoMarkDetect--message"></a><h3>The <code class="literal">“message”</code> property</h3> 272<pre class="programlisting"> “message” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> 273<p>Post detected data as bus messages.</p> 274<p>Flags: Read / Write / Construct</p> 275<p>Default value: TRUE</p> 276</div> 277<hr> 278<div class="refsect2"> 279<a name="GstSimpleVideoMarkDetect--pattern-center"></a><h3>The <code class="literal">“pattern-center”</code> property</h3> 280<pre class="programlisting"> “pattern-center” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre> 281<p>The center of the black/white separation (0.0 = lowest, 1.0 highest).</p> 282<p>Flags: Read / Write / Construct</p> 283<p>Allowed values: [0,1]</p> 284<p>Default value: 0.5</p> 285</div> 286<hr> 287<div class="refsect2"> 288<a name="GstSimpleVideoMarkDetect--pattern-count"></a><h3>The <code class="literal">“pattern-count”</code> property</h3> 289<pre class="programlisting"> “pattern-count” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 290<p>The number of pattern markers.</p> 291<p>Flags: Read / Write / Construct</p> 292<p>Allowed values: >= 0</p> 293<p>Default value: 4</p> 294</div> 295<hr> 296<div class="refsect2"> 297<a name="GstSimpleVideoMarkDetect--pattern-data-count"></a><h3>The <code class="literal">“pattern-data-count”</code> property</h3> 298<pre class="programlisting"> “pattern-data-count” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 299<p>The number of extra data pattern markers.</p> 300<p>Flags: Read / Write / Construct</p> 301<p>Allowed values: >= 0</p> 302<p>Default value: 5</p> 303</div> 304<hr> 305<div class="refsect2"> 306<a name="GstSimpleVideoMarkDetect--pattern-height"></a><h3>The <code class="literal">“pattern-height”</code> property</h3> 307<pre class="programlisting"> “pattern-height” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 308<p>The height of the pattern markers.</p> 309<p>Flags: Read / Write / Construct</p> 310<p>Allowed values: >= 1</p> 311<p>Default value: 16</p> 312</div> 313<hr> 314<div class="refsect2"> 315<a name="GstSimpleVideoMarkDetect--pattern-sensitivity"></a><h3>The <code class="literal">“pattern-sensitivity”</code> property</h3> 316<pre class="programlisting"> “pattern-sensitivity” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre> 317<p>The sensitivity around the center for detecting the markers (0.0 = lowest, 1.0 highest).</p> 318<p>Flags: Read / Write / Construct</p> 319<p>Allowed values: [0,1]</p> 320<p>Default value: 0.3</p> 321</div> 322<hr> 323<div class="refsect2"> 324<a name="GstSimpleVideoMarkDetect--pattern-width"></a><h3>The <code class="literal">“pattern-width”</code> property</h3> 325<pre class="programlisting"> “pattern-width” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 326<p>The width of the pattern markers.</p> 327<p>Flags: Read / Write / Construct</p> 328<p>Allowed values: >= 1</p> 329<p>Default value: 4</p> 330</div> 331</div> 332<div class="refsect1"> 333<a name="gst-plugins-bad-plugins-simplevideomarkdetect.see-also"></a><h2>See Also</h2> 334<p><span class="type">GstVideoMark</span></p> 335</div> 336</div> 337<div class="footer"> 338<hr>Generated by GTK-Doc V1.28</div> 339</body> 340</html>
