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>cvsmooth: 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-cvlaplace.html" title="cvlaplace"> 10<link rel="next" href="gst-plugins-bad-plugins-cvsobel.html" title="cvsobel"> 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-cvsmooth.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 19 <a href="#gst-plugins-bad-plugins-cvsmooth.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> 20 <a href="#gst-plugins-bad-plugins-cvsmooth.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-cvlaplace.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-cvsobel.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-cvsmooth"></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-cvsmooth.top_of_page"></a>cvsmooth</span></h2> 32<p>cvsmooth</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-cvsmooth.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-cvsmooth.html#GstCvSmooth--param1" title="The “param1” property">param1</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#gint"><span class="type">gint</span></a></td> 52<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-cvsmooth.html#GstCvSmooth--param2" title="The “param2” property">param2</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#gdouble"><span class="type">gdouble</span></a></td> 57<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-cvsmooth.html#GstCvSmooth--param3" title="The “param3” property">param3</a></td> 58<td class="property_flags">Read / Write</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-cvsmooth.html#GstCvSmooth--param4" title="The “param4” property">param4</a></td> 63<td class="property_flags">Read / Write</td> 64</tr> 65<tr> 66<td class="property_type"><span class="type">GstCvSmoothTypeType</span></td> 67<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-cvsmooth.html#GstCvSmooth--type" title="The “type” property">type</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#gdouble"><span class="type">gdouble</span></a></td> 72<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-cvsmooth.html#GstCvSmooth--color" title="The “color” property">color</a></td> 73<td class="property_flags">Read / Write</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-cvsmooth.html#GstCvSmooth--height" title="The “height” property">height</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#gdouble"><span class="type">gdouble</span></a></td> 82<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-cvsmooth.html#GstCvSmooth--spatial" title="The “spatial” property">spatial</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#gint"><span class="type">gint</span></a></td> 87<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-cvsmooth.html#GstCvSmooth--width" title="The “width” property">width</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#gint"><span class="type">gint</span></a></td> 92<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-cvsmooth.html#GstCvSmooth--kernel-height" title="The “kernel-height” property">kernel-height</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#gint"><span class="type">gint</span></a></td> 97<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-cvsmooth.html#GstCvSmooth--kernel-width" title="The “kernel-width” property">kernel-width</a></td> 98<td class="property_flags">Read / Write</td> 99</tr> 100<tr> 101<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> 102<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-cvsmooth.html#GstCvSmooth--position-x" title="The “position-x” property">position-x</a></td> 103<td class="property_flags">Read / Write</td> 104</tr> 105<tr> 106<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td> 107<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-cvsmooth.html#GstCvSmooth--position-y" title="The “position-y” property">position-y</a></td> 108<td class="property_flags">Read / Write</td> 109</tr> 110</tbody> 111</table></div> 112</div> 113<a name="GstCvSmooth"></a><div class="refsect1"> 114<a name="gst-plugins-bad-plugins-cvsmooth.other"></a><h2>Types and Values</h2> 115<div class="informaltable"><table class="informaltable" width="100%" border="0"> 116<colgroup> 117<col width="150px" class="name"> 118<col class="description"> 119</colgroup> 120<tbody><tr> 121<td class="datatype_keyword">struct</td> 122<td class="function_name"><a class="link" href="gst-plugins-bad-plugins-cvsmooth.html#GstCvSmooth-struct" title="struct GstCvSmooth">GstCvSmooth</a></td> 123</tr></tbody> 124</table></div> 125</div> 126<div class="refsect1"> 127<a name="gst-plugins-bad-plugins-cvsmooth.object-hierarchy"></a><h2>Object Hierarchy</h2> 128<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> 129 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a> 130 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a> 131 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a> 132 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-libs-1.0/GstBaseTransform.html#GstBaseTransform-struct">GstBaseTransform</a> 133 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gst-plugins-base-libs-1.0/GstVideoFilter.html#GstVideoFilter-struct">GstVideoFilter</a> 134 <span class="lineart">╰──</span> GstOpencvVideoFilter 135 <span class="lineart">╰──</span> GstCvSmooth 136</pre> 137</div> 138<div class="refsect1"> 139<a name="gst-plugins-bad-plugins-cvsmooth.description"></a><h2>Description</h2> 140<p>Smooths the image using thes cvSmooth OpenCV function.</p> 141<div class="refsect2"> 142<a name="id-1.2.49.7.3"></a><h3>Example launch line</h3> 143<div class="informalexample"> 144 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> 145 <tbody> 146 <tr> 147 <td class="listing_lines" align="right"><pre>1</pre></td> 148 <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> cvsmooth <span class="gtkdoc opt">!</span> videoconvert <span class="gtkdoc opt">!</span> autovideosink</pre></td> 149 </tr> 150 </tbody> 151 </table> 152</div> 153 154</div> 155<div class="refsynopsisdiv"> 156<h2>Synopsis</h2> 157<div class="refsect2"> 158<a name="id-1.2.49.7.4.1"></a><h3>Element Information</h3> 159<div class="variablelist"><table border="0" class="variablelist"> 160<colgroup> 161<col align="left" valign="top"> 162<col> 163</colgroup> 164<tbody> 165<tr> 166<td><p><span class="term">plugin</span></p></td> 167<td> 168 <a class="link" href="gst-plugins-bad-plugins-plugin-opencv.html#plugin-opencv">opencv</a> 169 </td> 170</tr> 171<tr> 172<td><p><span class="term">author</span></p></td> 173<td>Thiago Santos<thiago.sousa.santos@collabora.co.uk></td> 174</tr> 175<tr> 176<td><p><span class="term">class</span></p></td> 177<td>Transform/Effect/Video</td> 178</tr> 179</tbody> 180</table></div> 181</div> 182<hr> 183<div class="refsect2"> 184<a name="id-1.2.49.7.4.2"></a><h3>Element Pads</h3> 185<div class="variablelist"><table border="0" class="variablelist"> 186<colgroup> 187<col align="left" valign="top"> 188<col> 189</colgroup> 190<tbody> 191<tr> 192<td><p><span class="term">name</span></p></td> 193<td>sink</td> 194</tr> 195<tr> 196<td><p><span class="term">direction</span></p></td> 197<td>sink</td> 198</tr> 199<tr> 200<td><p><span class="term">presence</span></p></td> 201<td>always</td> 202</tr> 203<tr> 204<td><p><span class="term">details</span></p></td> 205<td>video/x-raw, format=(string)RGB, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td> 206</tr> 207<tr> 208<td><p><span class="term"></span></p></td> 209<td> video/x-raw, format=(string)BGR, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td> 210</tr> 211<tr> 212<td><p><span class="term"></span></p></td> 213<td> video/x-raw, format=(string)GRAY8, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td> 214</tr> 215</tbody> 216</table></div> 217<div class="variablelist"><table border="0" class="variablelist"> 218<colgroup> 219<col align="left" valign="top"> 220<col> 221</colgroup> 222<tbody> 223<tr> 224<td><p><span class="term">name</span></p></td> 225<td>src</td> 226</tr> 227<tr> 228<td><p><span class="term">direction</span></p></td> 229<td>source</td> 230</tr> 231<tr> 232<td><p><span class="term">presence</span></p></td> 233<td>always</td> 234</tr> 235<tr> 236<td><p><span class="term">details</span></p></td> 237<td>video/x-raw, format=(string)RGB, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td> 238</tr> 239<tr> 240<td><p><span class="term"></span></p></td> 241<td> video/x-raw, format=(string)BGR, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td> 242</tr> 243<tr> 244<td><p><span class="term"></span></p></td> 245<td> video/x-raw, format=(string)GRAY8, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td> 246</tr> 247</tbody> 248</table></div> 249</div> 250</div> 251</div> 252<div class="refsect1"> 253<a name="gst-plugins-bad-plugins-cvsmooth.functions_details"></a><h2>Functions</h2> 254<p></p> 255</div> 256<div class="refsect1"> 257<a name="gst-plugins-bad-plugins-cvsmooth.other_details"></a><h2>Types and Values</h2> 258<div class="refsect2"> 259<a name="GstCvSmooth-struct"></a><h3>struct GstCvSmooth</h3> 260<pre class="programlisting">struct GstCvSmooth;</pre> 261</div> 262</div> 263<div class="refsect1"> 264<a name="gst-plugins-bad-plugins-cvsmooth.property-details"></a><h2>Property Details</h2> 265<div class="refsect2"> 266<a name="GstCvSmooth--param1"></a><h3>The <code class="literal">“param1”</code> property</h3> 267<pre class="programlisting"> “param1” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 268<p>The aperture width (Must be positive and odd).Check cvSmooth OpenCV docs: http://opencv.willowgarage.com/documentation/image_filtering.html#cvSmooth.</p> 269<p>Flags: Read / Write</p> 270<p>Allowed values: >= 1</p> 271<p>Default value: 3</p> 272</div> 273<hr> 274<div class="refsect2"> 275<a name="GstCvSmooth--param2"></a><h3>The <code class="literal">“param2”</code> property</h3> 276<pre class="programlisting"> “param2” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 277<p>The aperture height, if zero, the width is used.(Must be positive and odd or zero, unuset in median and bilateral types). Check cvSmooth OpenCV docs: http://opencv.willowgarage.com/documentation/image_filtering.html#cvSmooth.</p> 278<p>Flags: Read / Write</p> 279<p>Allowed values: >= 0</p> 280<p>Default value: 0</p> 281</div> 282<hr> 283<div class="refsect2"> 284<a name="GstCvSmooth--param3"></a><h3>The <code class="literal">“param3”</code> property</h3> 285<pre class="programlisting"> “param3” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre> 286<p>If type is gaussian, this means the standard deviation.If type is bilateral, this means the color-sigma. If zero, Default values are used.Check cvSmooth OpenCV docs: http://opencv.willowgarage.com/documentation/image_filtering.html#cvSmooth.</p> 287<p>Flags: Read / Write</p> 288<p>Allowed values: >= 0</p> 289<p>Default value: 0</p> 290</div> 291<hr> 292<div class="refsect2"> 293<a name="GstCvSmooth--param4"></a><h3>The <code class="literal">“param4”</code> property</h3> 294<pre class="programlisting"> “param4” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre> 295<p>Only used in bilateral type, means the spatial-sigma.Check cvSmooth OpenCV docs: http://opencv.willowgarage.com/documentation/image_filtering.html#cvSmooth.</p> 296<p>Flags: Read / Write</p> 297<p>Allowed values: >= 0</p> 298<p>Default value: 0</p> 299</div> 300<hr> 301<div class="refsect2"> 302<a name="GstCvSmooth--type"></a><h3>The <code class="literal">“type”</code> property</h3> 303<pre class="programlisting"> “type” <span class="type">GstCvSmoothTypeType</span></pre> 304<p>Smooth Type.</p> 305<p>Flags: Read / Write</p> 306<p>Default value: CV Gaussian</p> 307</div> 308<hr> 309<div class="refsect2"> 310<a name="GstCvSmooth--color"></a><h3>The <code class="literal">“color”</code> property</h3> 311<pre class="programlisting"> “color” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre> 312<p>If type is gaussian, this means the standard deviation.If type is bilateral, this means the color-sigma. If zero, Default values are used.</p> 313<p>Flags: Read / Write</p> 314<p>Allowed values: >= 0</p> 315<p>Default value: 0</p> 316</div> 317<hr> 318<div class="refsect2"> 319<a name="GstCvSmooth--height"></a><h3>The <code class="literal">“height”</code> property</h3> 320<pre class="programlisting"> “height” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 321<p>Height of the area to blur (in pixels).</p> 322<p>Flags: Read / Write</p> 323<p>Allowed values: >= 0</p> 324<p>Default value: 2147483647</p> 325</div> 326<hr> 327<div class="refsect2"> 328<a name="GstCvSmooth--spatial"></a><h3>The <code class="literal">“spatial”</code> property</h3> 329<pre class="programlisting"> “spatial” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre> 330<p>Only used in bilateral type, means the spatial-sigma.</p> 331<p>Flags: Read / Write</p> 332<p>Allowed values: >= 0</p> 333<p>Default value: 0</p> 334</div> 335<hr> 336<div class="refsect2"> 337<a name="GstCvSmooth--width"></a><h3>The <code class="literal">“width”</code> property</h3> 338<pre class="programlisting"> “width” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 339<p>Width of the area to blur (in pixels).</p> 340<p>Flags: Read / Write</p> 341<p>Allowed values: >= 0</p> 342<p>Default value: 2147483647</p> 343</div> 344<hr> 345<div class="refsect2"> 346<a name="GstCvSmooth--kernel-height"></a><h3>The <code class="literal">“kernel-height”</code> property</h3> 347<pre class="programlisting"> “kernel-height” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 348<p>The gaussian kernel height (must be positive and odd).</p> 349<p>Flags: Read / Write</p> 350<p>Allowed values: >= 0</p> 351<p>Default value: 3</p> 352</div> 353<hr> 354<div class="refsect2"> 355<a name="GstCvSmooth--kernel-width"></a><h3>The <code class="literal">“kernel-width”</code> property</h3> 356<pre class="programlisting"> “kernel-width” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 357<p>The gaussian kernel width (must be positive and odd).If type is median, this means the aperture linear size.Check OpenCV docs: http://docs.opencv.org/2.4/modules/imgproc/doc/filtering.htm.</p> 358<p>Flags: Read / Write</p> 359<p>Allowed values: >= 1</p> 360<p>Default value: 3</p> 361</div> 362<hr> 363<div class="refsect2"> 364<a name="GstCvSmooth--position-x"></a><h3>The <code class="literal">“position-x”</code> property</h3> 365<pre class="programlisting"> “position-x” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 366<p>Starting x position for blur (in pixels).</p> 367<p>Flags: Read / Write</p> 368<p>Allowed values: >= 0</p> 369<p>Default value: 0</p> 370</div> 371<hr> 372<div class="refsect2"> 373<a name="GstCvSmooth--position-y"></a><h3>The <code class="literal">“position-y”</code> property</h3> 374<pre class="programlisting"> “position-y” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre> 375<p>Starting y position for blur (in pixels).</p> 376<p>Flags: Read / Write</p> 377<p>Allowed values: >= 0</p> 378<p>Default value: 0</p> 379</div> 380</div> 381</div> 382<div class="footer"> 383<hr>Generated by GTK-Doc V1.28</div> 384</body> 385</html>
