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>dewarp: 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-decklinkvideosrc.html" title="decklinkvideosrc"> 10<link rel="next" href="gst-plugins-bad-plugins-dfbvideosink.html" title="dfbvideosink"> 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-dewarp.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 19 <a href="#gst-plugins-bad-plugins-dewarp.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> 20 <a href="#gst-plugins-bad-plugins-dewarp.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-decklinkvideosrc.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-dfbvideosink.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-dewarp"></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-dewarp.top_of_page"></a>dewarp</span></h2> 32<p>dewarp</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-dewarp.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 class="link" href="gst-plugins-bad-plugins-dewarp.html#GstDewarpDisplayMode" title="enum GstDewarpDisplayMode"><span class="type">GstDewarpDisplayMode</span></a></td> 47<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-dewarp.html#GstDewarp--display-mode" title="The “display-mode” property">display-mode</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#gdouble"><span class="type">gdouble</span></a></td> 52<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-dewarp.html#GstDewarp--inner-radius" title="The “inner-radius” property">inner-radius</a></td> 53<td class="property_flags">Read / Write</td> 54</tr> 55<tr> 56<td class="property_type"><a class="link" href="gst-plugins-bad-plugins-dewarp.html#GstDewarpInterpolationMode" title="enum GstDewarpInterpolationMode"><span class="type">GstDewarpInterpolationMode</span></a></td> 57<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-dewarp.html#GstDewarp--interpolation-method" title="The “interpolation-method” property">interpolation-method</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-dewarp.html#GstDewarp--outer-radius" title="The “outer-radius” property">outer-radius</a></td> 63<td class="property_flags">Read / Write</td> 64</tr> 65<tr> 66<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></td> 67<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-dewarp.html#GstDewarp--x-center" title="The “x-center” property">x-center</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-dewarp.html#GstDewarp--x-remap-correction" title="The “x-remap-correction” property">x-remap-correction</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#gdouble"><span class="type">gdouble</span></a></td> 77<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-dewarp.html#GstDewarp--y-center" title="The “y-center” property">y-center</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-dewarp.html#GstDewarp--y-remap-correction" title="The “y-remap-correction” property">y-remap-correction</a></td> 83<td class="property_flags">Read / Write</td> 84</tr> 85</tbody> 86</table></div> 87</div> 88<a name="GstDewarp"></a><div class="refsect1"> 89<a name="gst-plugins-bad-plugins-dewarp.other"></a><h2>Types and Values</h2> 90<div class="informaltable"><table class="informaltable" width="100%" border="0"> 91<colgroup> 92<col width="150px" class="name"> 93<col class="description"> 94</colgroup> 95<tbody> 96<tr> 97<td class="datatype_keyword">struct</td> 98<td class="function_name"><a class="link" href="gst-plugins-bad-plugins-dewarp.html#GstDewarp-struct" title="struct GstDewarp">GstDewarp</a></td> 99</tr> 100<tr> 101<td class="datatype_keyword">enum</td> 102<td class="function_name"><a class="link" href="gst-plugins-bad-plugins-dewarp.html#GstDewarpDisplayMode" title="enum GstDewarpDisplayMode">GstDewarpDisplayMode</a></td> 103</tr> 104<tr> 105<td class="datatype_keyword">enum</td> 106<td class="function_name"><a class="link" href="gst-plugins-bad-plugins-dewarp.html#GstDewarpInterpolationMode" title="enum GstDewarpInterpolationMode">GstDewarpInterpolationMode</a></td> 107</tr> 108</tbody> 109</table></div> 110</div> 111<div class="refsect1"> 112<a name="gst-plugins-bad-plugins-dewarp.object-hierarchy"></a><h2>Object Hierarchy</h2> 113<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> 114 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a> 115 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a> 116 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a> 117 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-libs-1.0/GstBaseTransform.html#GstBaseTransform-struct">GstBaseTransform</a> 118 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gst-plugins-base-libs-1.0/GstVideoFilter.html#GstVideoFilter-struct">GstVideoFilter</a> 119 <span class="lineart">╰──</span> GstOpencvVideoFilter 120 <span class="lineart">╰──</span> GstDewarp 121</pre> 122</div> 123<div class="refsect1"> 124<a name="gst-plugins-bad-plugins-dewarp.description"></a><h2>Description</h2> 125<p>Dewarp fisheye images</p> 126<div class="refsect2"> 127<a name="id-1.2.58.7.3"></a><h3>Example launch line</h3> 128<div class="informalexample"> 129 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> 130 <tbody> 131 <tr> 132 <td class="listing_lines" align="right"><pre>1</pre></td> 133 <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> videoconvert <span class="gtkdoc opt">!</span> circle radius<span class="gtkdoc opt">=</span><span class="number">0.1</span> height<span class="gtkdoc opt">=</span><span class="number">80</span> <span class="gtkdoc opt">!</span> dewarp outer<span class="gtkdoc opt">-</span>radius<span class="gtkdoc opt">=</span><span class="number">0.35</span> inner<span class="gtkdoc opt">-</span>radius<span class="gtkdoc opt">=</span><span class="number">0.1</span> <span class="gtkdoc opt">!</span> videoconvert <span class="gtkdoc opt">!</span> xvimagesink</pre></td> 134 </tr> 135 </tbody> 136 </table> 137</div> 138 139</div> 140<div class="refsynopsisdiv"> 141<h2>Synopsis</h2> 142<div class="refsect2"> 143<a name="id-1.2.58.7.4.1"></a><h3>Element Information</h3> 144<div class="variablelist"><table border="0" class="variablelist"> 145<colgroup> 146<col align="left" valign="top"> 147<col> 148</colgroup> 149<tbody> 150<tr> 151<td><p><span class="term">plugin</span></p></td> 152<td> 153 <a class="link" href="gst-plugins-bad-plugins-plugin-opencv.html#plugin-opencv">opencv</a> 154 </td> 155</tr> 156<tr> 157<td><p><span class="term">author</span></p></td> 158<td>Nicola Murino <nicola.murino@gmail.com></td> 159</tr> 160<tr> 161<td><p><span class="term">class</span></p></td> 162<td>Filter/Effect/Video</td> 163</tr> 164</tbody> 165</table></div> 166</div> 167<hr> 168<div class="refsect2"> 169<a name="id-1.2.58.7.4.2"></a><h3>Element Pads</h3> 170<div class="variablelist"><table border="0" class="variablelist"> 171<colgroup> 172<col align="left" valign="top"> 173<col> 174</colgroup> 175<tbody> 176<tr> 177<td><p><span class="term">name</span></p></td> 178<td>sink</td> 179</tr> 180<tr> 181<td><p><span class="term">direction</span></p></td> 182<td>sink</td> 183</tr> 184<tr> 185<td><p><span class="term">presence</span></p></td> 186<td>always</td> 187</tr> 188<tr> 189<td><p><span class="term">details</span></p></td> 190<td>video/x-raw, format=(string)RGBA, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td> 191</tr> 192</tbody> 193</table></div> 194<div class="variablelist"><table border="0" class="variablelist"> 195<colgroup> 196<col align="left" valign="top"> 197<col> 198</colgroup> 199<tbody> 200<tr> 201<td><p><span class="term">name</span></p></td> 202<td>src</td> 203</tr> 204<tr> 205<td><p><span class="term">direction</span></p></td> 206<td>source</td> 207</tr> 208<tr> 209<td><p><span class="term">presence</span></p></td> 210<td>always</td> 211</tr> 212<tr> 213<td><p><span class="term">details</span></p></td> 214<td>video/x-raw, format=(string)RGBA, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td> 215</tr> 216</tbody> 217</table></div> 218</div> 219</div> 220</div> 221<div class="refsect1"> 222<a name="gst-plugins-bad-plugins-dewarp.functions_details"></a><h2>Functions</h2> 223<p></p> 224</div> 225<div class="refsect1"> 226<a name="gst-plugins-bad-plugins-dewarp.other_details"></a><h2>Types and Values</h2> 227<div class="refsect2"> 228<a name="GstDewarp-struct"></a><h3>struct GstDewarp</h3> 229<pre class="programlisting">struct GstDewarp;</pre> 230</div> 231<hr> 232<div class="refsect2"> 233<a name="GstDewarpDisplayMode"></a><h3>enum GstDewarpDisplayMode</h3> 234<div class="refsect3"> 235<a name="GstDewarpDisplayMode.members"></a><h4>Members</h4> 236<div class="informaltable"><table class="informaltable" width="100%" border="0"> 237<colgroup> 238<col width="300px" class="enum_members_name"> 239<col class="enum_members_description"> 240<col width="200px" class="enum_members_annotations"> 241</colgroup> 242<tbody> 243<tr> 244<td class="enum_member_name"><p><a name="GST-DEWARP-DISPLAY-PANORAMA:CAPS"></a>GST_DEWARP_DISPLAY_PANORAMA</p></td> 245<td> </td> 246<td> </td> 247</tr> 248<tr> 249<td class="enum_member_name"><p><a name="GST-DEWARP-DISPLAY-DOUBLE-PANORAMA:CAPS"></a>GST_DEWARP_DISPLAY_DOUBLE_PANORAMA</p></td> 250<td> </td> 251<td> </td> 252</tr> 253<tr> 254<td class="enum_member_name"><p><a name="GST-DEWARP-DISPLAY-QUAD-VIEW:CAPS"></a>GST_DEWARP_DISPLAY_QUAD_VIEW</p></td> 255<td> </td> 256<td> </td> 257</tr> 258</tbody> 259</table></div> 260</div> 261</div> 262<hr> 263<div class="refsect2"> 264<a name="GstDewarpInterpolationMode"></a><h3>enum GstDewarpInterpolationMode</h3> 265<div class="refsect3"> 266<a name="GstDewarpInterpolationMode.members"></a><h4>Members</h4> 267<div class="informaltable"><table class="informaltable" width="100%" border="0"> 268<colgroup> 269<col width="300px" class="enum_members_name"> 270<col class="enum_members_description"> 271<col width="200px" class="enum_members_annotations"> 272</colgroup> 273<tbody> 274<tr> 275<td class="enum_member_name"><p><a name="GST-DEWARP-INTER-NEAREST:CAPS"></a>GST_DEWARP_INTER_NEAREST</p></td> 276<td> </td> 277<td> </td> 278</tr> 279<tr> 280<td class="enum_member_name"><p><a name="GST-DEWARP-INTER-LINEAR:CAPS"></a>GST_DEWARP_INTER_LINEAR</p></td> 281<td> </td> 282<td> </td> 283</tr> 284<tr> 285<td class="enum_member_name"><p><a name="GST-DEWARP-INTER-CUBIC:CAPS"></a>GST_DEWARP_INTER_CUBIC</p></td> 286<td> </td> 287<td> </td> 288</tr> 289<tr> 290<td class="enum_member_name"><p><a name="GST-DEWARP-INTER-LANCZOS4:CAPS"></a>GST_DEWARP_INTER_LANCZOS4</p></td> 291<td> </td> 292<td> </td> 293</tr> 294</tbody> 295</table></div> 296</div> 297</div> 298</div> 299<div class="refsect1"> 300<a name="gst-plugins-bad-plugins-dewarp.property-details"></a><h2>Property Details</h2> 301<div class="refsect2"> 302<a name="GstDewarp--display-mode"></a><h3>The <code class="literal">“display-mode”</code> property</h3> 303<pre class="programlisting"> “display-mode” <a class="link" href="gst-plugins-bad-plugins-dewarp.html#GstDewarpDisplayMode" title="enum GstDewarpDisplayMode"><span class="type">GstDewarpDisplayMode</span></a></pre> 304<p>How to display the dewarped image.</p> 305<p>Flags: Read / Write</p> 306<p>Default value: Single panorama image</p> 307</div> 308<hr> 309<div class="refsect2"> 310<a name="GstDewarp--inner-radius"></a><h3>The <code class="literal">“inner-radius”</code> property</h3> 311<pre class="programlisting"> “inner-radius” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre> 312<p>Inner radius of the fisheye image donut. If outer radius <= inner radius the element will work in passthrough mode.</p> 313<p>Flags: Read / Write</p> 314<p>Allowed values: [0,1]</p> 315<p>Default value: 0</p> 316</div> 317<hr> 318<div class="refsect2"> 319<a name="GstDewarp--interpolation-method"></a><h3>The <code class="literal">“interpolation-method”</code> property</h3> 320<pre class="programlisting"> “interpolation-method” <a class="link" href="gst-plugins-bad-plugins-dewarp.html#GstDewarpInterpolationMode" title="enum GstDewarpInterpolationMode"><span class="type">GstDewarpInterpolationMode</span></a></pre> 321<p>Interpolation method to use.</p> 322<p>Flags: Read / Write</p> 323<p>Default value: A bilinear interpolation</p> 324</div> 325<hr> 326<div class="refsect2"> 327<a name="GstDewarp--outer-radius"></a><h3>The <code class="literal">“outer-radius”</code> property</h3> 328<pre class="programlisting"> “outer-radius” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre> 329<p>Outer radius of the fisheye image donut. If outer radius <= inner radius the element will work in passthrough mode.</p> 330<p>Flags: Read / Write</p> 331<p>Allowed values: [0,1]</p> 332<p>Default value: 0</p> 333</div> 334<hr> 335<div class="refsect2"> 336<a name="GstDewarp--x-center"></a><h3>The <code class="literal">“x-center”</code> property</h3> 337<pre class="programlisting"> “x-center” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre> 338<p>X axis center of the fisheye image.</p> 339<p>Flags: Read / Write</p> 340<p>Allowed values: [0,1]</p> 341<p>Default value: 0.5</p> 342</div> 343<hr> 344<div class="refsect2"> 345<a name="GstDewarp--x-remap-correction"></a><h3>The <code class="literal">“x-remap-correction”</code> property</h3> 346<pre class="programlisting"> “x-remap-correction” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre> 347<p>Correction factor for remapping on x axis. A correction is needed if the fisheye image is not inside a circle.</p> 348<p>Flags: Read / Write</p> 349<p>Allowed values: [0.1,10]</p> 350<p>Default value: 1</p> 351</div> 352<hr> 353<div class="refsect2"> 354<a name="GstDewarp--y-center"></a><h3>The <code class="literal">“y-center”</code> property</h3> 355<pre class="programlisting"> “y-center” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre> 356<p>Y axis center of the fisheye image.</p> 357<p>Flags: Read / Write</p> 358<p>Allowed values: [0,1]</p> 359<p>Default value: 0.5</p> 360</div> 361<hr> 362<div class="refsect2"> 363<a name="GstDewarp--y-remap-correction"></a><h3>The <code class="literal">“y-remap-correction”</code> property</h3> 364<pre class="programlisting"> “y-remap-correction” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre> 365<p>Correction factor for remapping on y axis. A correction is needed if the fisheye image is not inside a circle.</p> 366<p>Flags: Read / Write</p> 367<p>Allowed values: [0.1,10]</p> 368<p>Default value: 1</p> 369</div> 370</div> 371</div> 372<div class="footer"> 373<hr>Generated by GTK-Doc V1.28</div> 374</body> 375</html>
