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>videoanalyse: 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-vdpaumpegdec.html" title="vdpaumpegdec"> 10<link rel="next" href="gst-plugins-bad-plugins-videodiff.html" title="videodiff"> 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-videoanalyse.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 19 <a href="#gst-plugins-bad-plugins-videoanalyse.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> 20 <a href="#gst-plugins-bad-plugins-videoanalyse.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-vdpaumpegdec.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-videodiff.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-videoanalyse"></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-videoanalyse.top_of_page"></a>videoanalyse</span></h2> 32<p>videoanalyse</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-videoanalyse.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><tr> 45<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> 46<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-videoanalyse.html#GstVideoAnalyse--message" title="The “message” property">message</a></td> 47<td class="property_flags">Read / Write / Construct</td> 48</tr></tbody> 49</table></div> 50</div> 51<a name="GstVideoAnalyse"></a><div class="refsect1"> 52<a name="gst-plugins-bad-plugins-videoanalyse.other"></a><h2>Types and Values</h2> 53<div class="informaltable"><table class="informaltable" width="100%" border="0"> 54<colgroup> 55<col width="150px" class="name"> 56<col class="description"> 57</colgroup> 58<tbody><tr> 59<td class="datatype_keyword">struct</td> 60<td class="function_name"><a class="link" href="gst-plugins-bad-plugins-videoanalyse.html#GstVideoAnalyse-struct" title="struct GstVideoAnalyse">GstVideoAnalyse</a></td> 61</tr></tbody> 62</table></div> 63</div> 64<div class="refsect1"> 65<a name="gst-plugins-bad-plugins-videoanalyse.object-hierarchy"></a><h2>Object Hierarchy</h2> 66<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> 67 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a> 68 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a> 69 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a> 70 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-libs-1.0/GstBaseTransform.html#GstBaseTransform-struct">GstBaseTransform</a> 71 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gst-plugins-base-libs-1.0/GstVideoFilter.html#GstVideoFilter-struct">GstVideoFilter</a> 72 <span class="lineart">╰──</span> GstVideoAnalyse 73</pre> 74</div> 75<div class="refsect1"> 76<a name="gst-plugins-bad-plugins-videoanalyse.description"></a><h2>Description</h2> 77<p>This plugin analyses every video frame and if the <a class="link" href="gst-plugins-bad-plugins-videoanalyse.html#GstVideoAnalyse--message" title="The “message” property"><span class="type">“message”</span></a> 78property is <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, posts an element message with video statistics called 79<code class="literal">GstVideoAnalyse</code>.</p> 80<p>The message's structure contains these fields:</p> 81<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> 82<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> 83<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> 84<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> 85<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> 86<li class="listitem"><p><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a><code class="literal">luma-average</code>: the average brightness of the frame. Range: 0.0-1.0</p></li> 87<li class="listitem"><p><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a><code class="literal">luma-variance</code>: the brightness variance of the frame.</p></li> 88</ul></div> 89<div class="refsect3"> 90<a name="id-1.2.234.7.5"></a><h4>Example launch line</h4> 91<div class="informalexample"> 92 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> 93 <tbody> 94 <tr> 95 <td class="listing_lines" align="right"><pre>1</pre></td> 96 <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>m videotestsrc <span class="gtkdoc opt">!</span> videoanalyse <span class="gtkdoc opt">!</span> videoconvert <span class="gtkdoc opt">!</span> ximagesink</pre></td> 97 </tr> 98 </tbody> 99 </table> 100</div> 101 102<p> This pipeline emits messages to the console for each frame that has been analysed.</p> 103</div> 104<div class="refsynopsisdiv"> 105<h2>Synopsis</h2> 106<div class="refsect2"> 107<a name="id-1.2.234.7.6.1"></a><h3>Element Information</h3> 108<div class="variablelist"><table border="0" class="variablelist"> 109<colgroup> 110<col align="left" valign="top"> 111<col> 112</colgroup> 113<tbody> 114<tr> 115<td><p><span class="term">plugin</span></p></td> 116<td> 117 <a class="link" href="gst-plugins-bad-plugins-plugin-videosignal.html#plugin-videosignal">videosignal</a> 118 </td> 119</tr> 120<tr> 121<td><p><span class="term">author</span></p></td> 122<td>Wim Taymans <wim@fluendo.com></td> 123</tr> 124<tr> 125<td><p><span class="term">class</span></p></td> 126<td>Filter/Analyzer/Video</td> 127</tr> 128</tbody> 129</table></div> 130</div> 131<hr> 132<div class="refsect2"> 133<a name="id-1.2.234.7.6.2"></a><h3>Element Pads</h3> 134<div class="variablelist"><table border="0" class="variablelist"> 135<colgroup> 136<col align="left" valign="top"> 137<col> 138</colgroup> 139<tbody> 140<tr> 141<td><p><span class="term">name</span></p></td> 142<td>sink</td> 143</tr> 144<tr> 145<td><p><span class="term">direction</span></p></td> 146<td>sink</td> 147</tr> 148<tr> 149<td><p><span class="term">presence</span></p></td> 150<td>always</td> 151</tr> 152<tr> 153<td><p><span class="term">details</span></p></td> 154<td>video/x-raw, format=(string){ I420, YV12, Y444, Y42B, Y41B }, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td> 155</tr> 156</tbody> 157</table></div> 158<div class="variablelist"><table border="0" class="variablelist"> 159<colgroup> 160<col align="left" valign="top"> 161<col> 162</colgroup> 163<tbody> 164<tr> 165<td><p><span class="term">name</span></p></td> 166<td>src</td> 167</tr> 168<tr> 169<td><p><span class="term">direction</span></p></td> 170<td>source</td> 171</tr> 172<tr> 173<td><p><span class="term">presence</span></p></td> 174<td>always</td> 175</tr> 176<tr> 177<td><p><span class="term">details</span></p></td> 178<td>video/x-raw, format=(string){ I420, YV12, Y444, Y42B, Y41B }, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td> 179</tr> 180</tbody> 181</table></div> 182</div> 183</div> 184</div> 185<div class="refsect1"> 186<a name="gst-plugins-bad-plugins-videoanalyse.functions_details"></a><h2>Functions</h2> 187<p></p> 188</div> 189<div class="refsect1"> 190<a name="gst-plugins-bad-plugins-videoanalyse.other_details"></a><h2>Types and Values</h2> 191<div class="refsect2"> 192<a name="GstVideoAnalyse-struct"></a><h3>struct GstVideoAnalyse</h3> 193<pre class="programlisting">struct GstVideoAnalyse;</pre> 194</div> 195</div> 196<div class="refsect1"> 197<a name="gst-plugins-bad-plugins-videoanalyse.property-details"></a><h2>Property Details</h2> 198<div class="refsect2"> 199<a name="GstVideoAnalyse--message"></a><h3>The <code class="literal">“message”</code> property</h3> 200<pre class="programlisting"> “message” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> 201<p>Post statics messages.</p> 202<p>Flags: Read / Write / Construct</p> 203<p>Default value: TRUE</p> 204</div> 205</div> 206</div> 207<div class="footer"> 208<hr>Generated by GTK-Doc V1.28</div> 209</body> 210</html>
