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