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>fieldanalysis: 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-festival.html" title="festival"> 10<link rel="next" href="gst-plugins-bad-plugins-fisheye.html" title="fisheye"> 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-fieldanalysis.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 19 <a href="#gst-plugins-bad-plugins-fieldanalysis.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> 20 <a href="#gst-plugins-bad-plugins-fieldanalysis.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-festival.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-fisheye.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-fieldanalysis"></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-fieldanalysis.top_of_page"></a>fieldanalysis</span></h2> 32<p>fieldanalysis</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-fieldanalysis.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#guint64"><span class="type">guint64</span></a></td> 47<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-fieldanalysis.html#GstFieldAnalysis--block-height" title="The “block-height” property">block-height</a></td> 48<td class="property_flags">Read / Write</td> 49</tr> 50<tr> 51<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a></td> 52<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-fieldanalysis.html#GstFieldAnalysis--block-threshold" title="The “block-threshold” property">block-threshold</a></td> 53<td class="property_flags">Read / Write</td> 54</tr> 55<tr> 56<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a></td> 57<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-fieldanalysis.html#GstFieldAnalysis--block-width" title="The “block-width” property">block-width</a></td> 58<td class="property_flags">Read / Write</td> 59</tr> 60<tr> 61<td class="property_type"><span class="type">FieldAnalysisCombMethod</span></td> 62<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-fieldanalysis.html#GstFieldAnalysis--comb-method" title="The “comb-method” property">comb-method</a></td> 63<td class="property_flags">Read / Write</td> 64</tr> 65<tr> 66<td class="property_type"><span class="type">GstFieldAnalysisFieldMetric</span></td> 67<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-fieldanalysis.html#GstFieldAnalysis--field-metric" title="The “field-metric” property">field-metric</a></td> 68<td class="property_flags">Read / Write</td> 69</tr> 70<tr> 71<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a></td> 72<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-fieldanalysis.html#GstFieldAnalysis--field-threshold" title="The “field-threshold” property">field-threshold</a></td> 73<td class="property_flags">Read / Write</td> 74</tr> 75<tr> 76<td class="property_type"><span class="type">GstFieldAnalysisFrameMetric</span></td> 77<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-fieldanalysis.html#GstFieldAnalysis--frame-metric" title="The “frame-metric” property">frame-metric</a></td> 78<td class="property_flags">Read / Write</td> 79</tr> 80<tr> 81<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a></td> 82<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-fieldanalysis.html#GstFieldAnalysis--frame-threshold" title="The “frame-threshold” property">frame-threshold</a></td> 83<td class="property_flags">Read / Write</td> 84</tr> 85<tr> 86<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a></td> 87<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-fieldanalysis.html#GstFieldAnalysis--ignored-lines" title="The “ignored-lines” property">ignored-lines</a></td> 88<td class="property_flags">Read / Write</td> 89</tr> 90<tr> 91<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td> 92<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-fieldanalysis.html#GstFieldAnalysis--noise-floor" title="The “noise-floor” property">noise-floor</a></td> 93<td class="property_flags">Read / Write</td> 94</tr> 95<tr> 96<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a></td> 97<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-fieldanalysis.html#GstFieldAnalysis--spatial-threshold" title="The “spatial-threshold” property">spatial-threshold</a></td> 98<td class="property_flags">Read / Write</td> 99</tr> 100</tbody> 101</table></div> 102</div> 103<a name="GstFieldAnalysis"></a><div class="refsect1"> 104<a name="gst-plugins-bad-plugins-fieldanalysis.other"></a><h2>Types and Values</h2> 105<div class="informaltable"><table class="informaltable" width="100%" border="0"> 106<colgroup> 107<col width="150px" class="name"> 108<col class="description"> 109</colgroup> 110<tbody><tr> 111<td class="datatype_keyword">struct</td> 112<td class="function_name"><a class="link" href="gst-plugins-bad-plugins-fieldanalysis.html#GstFieldAnalysis-struct" title="struct GstFieldAnalysis">GstFieldAnalysis</a></td> 113</tr></tbody> 114</table></div> 115</div> 116<div class="refsect1"> 117<a name="gst-plugins-bad-plugins-fieldanalysis.object-hierarchy"></a><h2>Object Hierarchy</h2> 118<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> 119 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a> 120 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a> 121 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a> 122 <span class="lineart">╰──</span> GstFieldAnalysis 123</pre> 124</div> 125<div class="refsect1"> 126<a name="gst-plugins-bad-plugins-fieldanalysis.description"></a><h2>Description</h2> 127<p>Analyse fields from video buffers to identify whether the buffers are 128progressive/telecined/interlaced and, if telecined, the telecine pattern 129used.</p> 130<div class="refsect3"> 131<a name="id-1.2.90.7.3"></a><h4>Example launch line</h4> 132<div class="informalexample"> 133 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> 134 <tbody> 135 <tr> 136 <td class="listing_lines" align="right"><pre>1</pre></td> 137 <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>v uridecodebin uri<span class="gtkdoc opt">=/</span>path<span class="gtkdoc opt">/</span>to<span class="gtkdoc opt">/</span>foo<span class="gtkdoc opt">.</span>bar <span class="gtkdoc opt">!</span> fieldanalysis <span class="gtkdoc opt">!</span> deinterlace <span class="gtkdoc opt">!</span> videoconvert <span class="gtkdoc opt">!</span> autovideosink</pre></td> 138 </tr> 139 </tbody> 140 </table> 141</div> 142 143<p> This pipeline will analyse a video stream with default metrics and thresholds and output progressive frames.</p> 144</div> 145<div class="refsynopsisdiv"> 146<h2>Synopsis</h2> 147<div class="refsect2"> 148<a name="id-1.2.90.7.4.1"></a><h3>Element Information</h3> 149<div class="variablelist"><table border="0" class="variablelist"> 150<colgroup> 151<col align="left" valign="top"> 152<col> 153</colgroup> 154<tbody> 155<tr> 156<td><p><span class="term">plugin</span></p></td> 157<td> 158 <a class="link" href="gst-plugins-bad-plugins-plugin-fieldanalysis.html#plugin-fieldanalysis">fieldanalysis</a> 159 </td> 160</tr> 161<tr> 162<td><p><span class="term">author</span></p></td> 163<td>Robert Swain <robert.swain@collabora.co.uk></td> 164</tr> 165<tr> 166<td><p><span class="term">class</span></p></td> 167<td>Filter/Analysis/Video</td> 168</tr> 169</tbody> 170</table></div> 171</div> 172<hr> 173<div class="refsect2"> 174<a name="id-1.2.90.7.4.2"></a><h3>Element Pads</h3> 175<div class="variablelist"><table border="0" class="variablelist"> 176<colgroup> 177<col align="left" valign="top"> 178<col> 179</colgroup> 180<tbody> 181<tr> 182<td><p><span class="term">name</span></p></td> 183<td>sink</td> 184</tr> 185<tr> 186<td><p><span class="term">direction</span></p></td> 187<td>sink</td> 188</tr> 189<tr> 190<td><p><span class="term">presence</span></p></td> 191<td>always</td> 192</tr> 193<tr> 194<td><p><span class="term">details</span></p></td> 195<td>video/x-raw, format=(string){ YUY2, UYVY, Y42B, I420, YV12 }, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td> 196</tr> 197</tbody> 198</table></div> 199<div class="variablelist"><table border="0" class="variablelist"> 200<colgroup> 201<col align="left" valign="top"> 202<col> 203</colgroup> 204<tbody> 205<tr> 206<td><p><span class="term">name</span></p></td> 207<td>src</td> 208</tr> 209<tr> 210<td><p><span class="term">direction</span></p></td> 211<td>source</td> 212</tr> 213<tr> 214<td><p><span class="term">presence</span></p></td> 215<td>always</td> 216</tr> 217<tr> 218<td><p><span class="term">details</span></p></td> 219<td>video/x-raw, format=(string){ YUY2, UYVY, Y42B, I420, YV12 }, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td> 220</tr> 221</tbody> 222</table></div> 223</div> 224</div> 225</div> 226<div class="refsect1"> 227<a name="gst-plugins-bad-plugins-fieldanalysis.functions_details"></a><h2>Functions</h2> 228<p></p> 229</div> 230<div class="refsect1"> 231<a name="gst-plugins-bad-plugins-fieldanalysis.other_details"></a><h2>Types and Values</h2> 232<div class="refsect2"> 233<a name="GstFieldAnalysis-struct"></a><h3>struct GstFieldAnalysis</h3> 234<pre class="programlisting">struct GstFieldAnalysis;</pre> 235</div> 236</div> 237<div class="refsect1"> 238<a name="gst-plugins-bad-plugins-fieldanalysis.property-details"></a><h2>Property Details</h2> 239<div class="refsect2"> 240<a name="GstFieldAnalysis--block-height"></a><h3>The <code class="literal">“block-height”</code> property</h3> 241<pre class="programlisting"> “block-height” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a></pre> 242<p>Block height for windowed comb detection.</p> 243<p>Flags: Read / Write</p> 244<p>Default value: 16</p> 245</div> 246<hr> 247<div class="refsect2"> 248<a name="GstFieldAnalysis--block-threshold"></a><h3>The <code class="literal">“block-threshold”</code> property</h3> 249<pre class="programlisting"> “block-threshold” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a></pre> 250<p>Block threshold for windowed comb detection.</p> 251<p>Flags: Read / Write</p> 252<p>Default value: 80</p> 253</div> 254<hr> 255<div class="refsect2"> 256<a name="GstFieldAnalysis--block-width"></a><h3>The <code class="literal">“block-width”</code> property</h3> 257<pre class="programlisting"> “block-width” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a></pre> 258<p>Block width for windowed comb detection.</p> 259<p>Flags: Read / Write</p> 260<p>Allowed values: >= 1</p> 261<p>Default value: 16</p> 262</div> 263<hr> 264<div class="refsect2"> 265<a name="GstFieldAnalysis--comb-method"></a><h3>The <code class="literal">“comb-method”</code> property</h3> 266<pre class="programlisting"> “comb-method” <span class="type">FieldAnalysisCombMethod</span></pre> 267<p>Metric to be used for identifying comb artifacts if using windowed comb detection.</p> 268<p>Flags: Read / Write</p> 269<p>Default value: 5-tap [1,-3,4,-3,1] vertical filter result is larger than spatial threshold*6</p> 270</div> 271<hr> 272<div class="refsect2"> 273<a name="GstFieldAnalysis--field-metric"></a><h3>The <code class="literal">“field-metric”</code> property</h3> 274<pre class="programlisting"> “field-metric” <span class="type">GstFieldAnalysisFieldMetric</span></pre> 275<p>Metric to be used for comparing same parity fields to decide if they are a repeated field for telecine.</p> 276<p>Flags: Read / Write</p> 277<p>Default value: Sum of Squared Differences</p> 278</div> 279<hr> 280<div class="refsect2"> 281<a name="GstFieldAnalysis--field-threshold"></a><h3>The <code class="literal">“field-threshold”</code> property</h3> 282<pre class="programlisting"> “field-threshold” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a></pre> 283<p>Threshold for field metric decisions.</p> 284<p>Flags: Read / Write</p> 285<p>Allowed values: >= 0</p> 286<p>Default value: 0.08</p> 287</div> 288<hr> 289<div class="refsect2"> 290<a name="GstFieldAnalysis--frame-metric"></a><h3>The <code class="literal">“frame-metric”</code> property</h3> 291<pre class="programlisting"> “frame-metric” <span class="type">GstFieldAnalysisFrameMetric</span></pre> 292<p>Metric to be used for comparing opposite parity fields to decide if they are a progressive frame.</p> 293<p>Flags: Read / Write</p> 294<p>Default value: 5-tap [1,-3,4,-3,1] Vertical Filter</p> 295</div> 296<hr> 297<div class="refsect2"> 298<a name="GstFieldAnalysis--frame-threshold"></a><h3>The <code class="literal">“frame-threshold”</code> property</h3> 299<pre class="programlisting"> “frame-threshold” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a></pre> 300<p>Threshold for frame metric decisions.</p> 301<p>Flags: Read / Write</p> 302<p>Allowed values: >= 0</p> 303<p>Default value: 0.002</p> 304</div> 305<hr> 306<div class="refsect2"> 307<a name="GstFieldAnalysis--ignored-lines"></a><h3>The <code class="literal">“ignored-lines”</code> property</h3> 308<pre class="programlisting"> “ignored-lines” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a></pre> 309<p>Ignore this many lines from the top and bottom for windowed comb detection.</p> 310<p>Flags: Read / Write</p> 311<p>Allowed values: >= 2</p> 312<p>Default value: 2</p> 313</div> 314<hr> 315<div class="refsect2"> 316<a name="GstFieldAnalysis--noise-floor"></a><h3>The <code class="literal">“noise-floor”</code> property</h3> 317<pre class="programlisting"> “noise-floor” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre> 318<p>Noise floor for appropriate metrics (per-pixel metric values with a score less than this will be ignored).</p> 319<p>Flags: Read / Write</p> 320<p>Default value: 16</p> 321</div> 322<hr> 323<div class="refsect2"> 324<a name="GstFieldAnalysis--spatial-threshold"></a><h3>The <code class="literal">“spatial-threshold”</code> property</h3> 325<pre class="programlisting"> “spatial-threshold” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a></pre> 326<p>Threshold for combing metric decisions.</p> 327<p>Flags: Read / Write</p> 328<p>Allowed values: >= 0</p> 329<p>Default value: 9</p> 330</div> 331</div> 332</div> 333<div class="footer"> 334<hr>Generated by GTK-Doc V1.28</div> 335</body> 336</html>
