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>grabcut: 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-gmedec.html" title="gmedec"> 10<link rel="next" href="gst-plugins-bad-plugins-gsmdec.html" title="gsmdec"> 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-grabcut.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 19 <a href="#gst-plugins-bad-plugins-grabcut.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> 20 <a href="#gst-plugins-bad-plugins-grabcut.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-gmedec.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-gsmdec.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-grabcut"></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-grabcut.top_of_page"></a>grabcut</span></h2> 32<p>grabcut</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-grabcut.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#gfloat"><span class="type">gfloat</span></a></td> 47<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-grabcut.html#GstGrabcut--scale" title="The “scale” property">scale</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#gboolean"><span class="type">gboolean</span></a></td> 52<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-grabcut.html#GstGrabcut--test-mode" title="The “test-mode” property">test-mode</a></td> 53<td class="property_flags">Read / Write</td> 54</tr> 55</tbody> 56</table></div> 57</div> 58<a name="GstGrabcut"></a><div class="refsect1"> 59<a name="gst-plugins-bad-plugins-grabcut.other"></a><h2>Types and Values</h2> 60<div class="informaltable"><table class="informaltable" width="100%" border="0"> 61<colgroup> 62<col width="150px" class="name"> 63<col class="description"> 64</colgroup> 65<tbody><tr> 66<td class="datatype_keyword">struct</td> 67<td class="function_name"><a class="link" href="gst-plugins-bad-plugins-grabcut.html#GstGrabcut-struct" title="struct GstGrabcut">GstGrabcut</a></td> 68</tr></tbody> 69</table></div> 70</div> 71<div class="refsect1"> 72<a name="gst-plugins-bad-plugins-grabcut.object-hierarchy"></a><h2>Object Hierarchy</h2> 73<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> 74 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a> 75 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a> 76 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a> 77 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-libs-1.0/GstBaseTransform.html#GstBaseTransform-struct">GstBaseTransform</a> 78 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gst-plugins-base-libs-1.0/GstVideoFilter.html#GstVideoFilter-struct">GstVideoFilter</a> 79 <span class="lineart">╰──</span> GstOpencvVideoFilter 80 <span class="lineart">╰──</span> GstGrabcut 81</pre> 82</div> 83<div class="refsect1"> 84<a name="gst-plugins-bad-plugins-grabcut.description"></a><h2>Description</h2> 85<p>This element is a wrapper around OpenCV grabcut implementation. GrabCut is an 86image segmentation method based on graph cuts technique. It can be seen as a 87way of fine-grain segmenting the image from some FG and BG "seed" areas. The 88OpenCV implementation follows the article [1]. 89The "seed" areas are taken in this element from either an input bounding box 90coming from a face detection, or from alpha channel values. The input box is 91taken from a "face" event such as the one generated from the 'facedetect' 92element. The Alpha channel values should be one of the following (cv.hpp): 93enum{ 94 GC_BGD = 0, //!< background 95 GC_FGD = 1, //!< foreground 96 GC_PR_BGD = 2, //!< most probably background 97 GC_PR_FGD = 3 //!< most probably foreground 98}; 99with values over GC_PR_FGD interpreted as GC_PR_FGD. IN CASE OF no alpha mask 100input (all 0's or all 1's), the 'GstOpenCvFaceDetect-face' downstream event 101is used to create a bbox of PR_FG elements. If both foreground alpha 102is not specified and there is no face detection, nothing is done.</p> 103<p>[1] C. Rother, V. Kolmogorov, and A. Blake, "GrabCut: Interactive foreground 104extraction using iterated graph cuts, ACM Trans. Graph., vol. 23, pp. 309–314, 1052004.</p> 106<div class="refsect2"> 107<a name="id-1.2.99.7.4"></a><h3>Example launch line</h3> 108<div class="informalexample"> 109 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> 110 <tbody> 111 <tr> 112 <td class="listing_lines" align="right"><pre>1</pre></td> 113 <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>gst<span class="gtkdoc opt">-</span>debug<span class="gtkdoc opt">=</span>grabcut<span class="gtkdoc opt">=</span><span class="number">4</span> v4l2src device<span class="gtkdoc opt">=/</span>dev<span class="gtkdoc opt">/</span>video0 <span class="gtkdoc opt">!</span> videoconvert <span class="gtkdoc opt">!</span> grabcut <span class="gtkdoc opt">!</span> videoconvert <span class="gtkdoc opt">!</span> video<span class="gtkdoc opt">/</span>x<span class="gtkdoc opt">-</span>raw<span class="gtkdoc opt">,</span>width<span class="gtkdoc opt">=</span><span class="number">320</span><span class="gtkdoc opt">,</span>height<span class="gtkdoc opt">=</span><span class="number">240</span> <span class="gtkdoc opt">!</span> ximagesink</pre></td> 114 </tr> 115 </tbody> 116 </table> 117</div> 118 119Another example launch line 120<div class="informalexample"> 121 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> 122 <tbody> 123 <tr> 124 <td class="listing_lines" align="right"><pre>1</pre></td> 125 <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>gst<span class="gtkdoc opt">-</span>debug<span class="gtkdoc opt">=</span>grabcut<span class="gtkdoc opt">=</span><span class="number">4</span> v4l2src device<span class="gtkdoc opt">=/</span>dev<span class="gtkdoc opt">/</span>video0 <span class="gtkdoc opt">!</span> videoconvert <span class="gtkdoc opt">!</span> facedetect display<span class="gtkdoc opt">=</span><span class="number">0</span> <span class="gtkdoc opt">!</span> videoconvert <span class="gtkdoc opt">!</span> grabcut test<span class="gtkdoc opt">-</span>mode<span class="gtkdoc opt">=</span><span class="keyword">true</span> <span class="gtkdoc opt">!</span> videoconvert <span class="gtkdoc opt">!</span> video<span class="gtkdoc opt">/</span>x<span class="gtkdoc opt">-</span>raw<span class="gtkdoc opt">,</span>width<span class="gtkdoc opt">=</span><span class="number">320</span><span class="gtkdoc opt">,</span>height<span class="gtkdoc opt">=</span><span class="number">240</span> <span class="gtkdoc opt">!</span> ximagesink</pre></td> 126 </tr> 127 </tbody> 128 </table> 129</div> 130 131</div> 132<div class="refsynopsisdiv"> 133<h2>Synopsis</h2> 134<div class="refsect2"> 135<a name="id-1.2.99.7.5.1"></a><h3>Element Information</h3> 136<div class="variablelist"><table border="0" class="variablelist"> 137<colgroup> 138<col align="left" valign="top"> 139<col> 140</colgroup> 141<tbody> 142<tr> 143<td><p><span class="term">plugin</span></p></td> 144<td> 145 <a class="link" href="gst-plugins-bad-plugins-plugin-opencv.html#plugin-opencv">opencv</a> 146 </td> 147</tr> 148<tr> 149<td><p><span class="term">author</span></p></td> 150<td>Miguel Casas-Sanchez <miguelecasassanchez@gmail.com></td> 151</tr> 152<tr> 153<td><p><span class="term">class</span></p></td> 154<td>Filter/Effect/Video</td> 155</tr> 156</tbody> 157</table></div> 158</div> 159<hr> 160<div class="refsect2"> 161<a name="id-1.2.99.7.5.2"></a><h3>Element Pads</h3> 162<div class="variablelist"><table border="0" class="variablelist"> 163<colgroup> 164<col align="left" valign="top"> 165<col> 166</colgroup> 167<tbody> 168<tr> 169<td><p><span class="term">name</span></p></td> 170<td>sink</td> 171</tr> 172<tr> 173<td><p><span class="term">direction</span></p></td> 174<td>sink</td> 175</tr> 176<tr> 177<td><p><span class="term">presence</span></p></td> 178<td>always</td> 179</tr> 180<tr> 181<td><p><span class="term">details</span></p></td> 182<td>video/x-raw, format=(string)RGBA, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td> 183</tr> 184</tbody> 185</table></div> 186<div class="variablelist"><table border="0" class="variablelist"> 187<colgroup> 188<col align="left" valign="top"> 189<col> 190</colgroup> 191<tbody> 192<tr> 193<td><p><span class="term">name</span></p></td> 194<td>src</td> 195</tr> 196<tr> 197<td><p><span class="term">direction</span></p></td> 198<td>source</td> 199</tr> 200<tr> 201<td><p><span class="term">presence</span></p></td> 202<td>always</td> 203</tr> 204<tr> 205<td><p><span class="term">details</span></p></td> 206<td>video/x-raw, format=(string)RGBA, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td> 207</tr> 208</tbody> 209</table></div> 210</div> 211</div> 212</div> 213<div class="refsect1"> 214<a name="gst-plugins-bad-plugins-grabcut.functions_details"></a><h2>Functions</h2> 215<p></p> 216</div> 217<div class="refsect1"> 218<a name="gst-plugins-bad-plugins-grabcut.other_details"></a><h2>Types and Values</h2> 219<div class="refsect2"> 220<a name="GstGrabcut-struct"></a><h3>struct GstGrabcut</h3> 221<pre class="programlisting">struct GstGrabcut;</pre> 222</div> 223</div> 224<div class="refsect1"> 225<a name="gst-plugins-bad-plugins-grabcut.property-details"></a><h2>Property Details</h2> 226<div class="refsect2"> 227<a name="GstGrabcut--scale"></a><h3>The <code class="literal">“scale”</code> property</h3> 228<pre class="programlisting"> “scale” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a></pre> 229<p>Grow factor for the face bounding box, if present.</p> 230<p>Flags: Read / Write</p> 231<p>Allowed values: [1,4]</p> 232<p>Default value: 1.6</p> 233</div> 234<hr> 235<div class="refsect2"> 236<a name="GstGrabcut--test-mode"></a><h3>The <code class="literal">“test-mode”</code> property</h3> 237<pre class="programlisting"> “test-mode” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> 238<p>If true, the output RGB is overwritten with the segmented foreground. Alpha channel same as normal case .</p> 239<p>Flags: Read / Write</p> 240<p>Default value: FALSE</p> 241</div> 242</div> 243</div> 244<div class="footer"> 245<hr>Generated by GTK-Doc V1.28</div> 246</body> 247</html>