blob: f3f1056b667a0cdcb9b48616f076e4c0b9d80dac [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>videoconvert: GStreamer Base Plugins 1.0 Plugins Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="GStreamer Base Plugins 1.0 Plugins Reference Manual">
<link rel="up" href="ch01.html" title="gst-plugins-base Elements">
<link rel="prev" href="gst-plugins-base-plugins-urisourcebin.html" title="urisourcebin">
<link rel="next" href="gst-plugins-base-plugins-videorate.html" title="videorate">
<meta name="generator" content="GTK-Doc V1.25 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
<a href="#gst-plugins-base-plugins-videoconvert.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
<a href="#gst-plugins-base-plugins-videoconvert.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span> 
<a href="#gst-plugins-base-plugins-videoconvert.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="gst-plugins-base-plugins-urisourcebin.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="gst-plugins-base-plugins-videorate.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="gst-plugins-base-plugins-videoconvert"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gst-plugins-base-plugins-videoconvert.top_of_page"></a>videoconvert</span></h2>
<p>videoconvert</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="gst-plugins-base-plugins-videoconvert.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type"><a href="../html/gst-plugins-base-libs-GstVideoDither.html#GstVideoDitherMethod"><span class="type">GstVideoDitherMethod</span></a></td>
<td class="property_name"><a class="link" href="gst-plugins-base-plugins-videoconvert.html#GstVideoConvert--dither" title="The “dither” property">dither</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">GstVideoAlphaMode</span></td>
<td class="property_name"><a class="link" href="gst-plugins-base-plugins-videoconvert.html#GstVideoConvert--alpha-mode" title="The “alpha-mode” property">alpha-mode</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></td>
<td class="property_name"><a class="link" href="gst-plugins-base-plugins-videoconvert.html#GstVideoConvert--alpha-value" title="The “alpha-value” property">alpha-value</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">GstVideoChromaMode</span></td>
<td class="property_name"><a class="link" href="gst-plugins-base-plugins-videoconvert.html#GstVideoConvert--chroma-mode" title="The “chroma-mode” property">chroma-mode</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="../html/gst-plugins-base-libs-GstVideoResampler.html#GstVideoResamplerMethod"><span class="type">GstVideoResamplerMethod</span></a></td>
<td class="property_name"><a class="link" href="gst-plugins-base-plugins-videoconvert.html#GstVideoConvert--chroma-resampler" title="The “chroma-resampler” property">chroma-resampler</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a></td>
<td class="property_name"><a class="link" href="gst-plugins-base-plugins-videoconvert.html#GstVideoConvert--dither-quantization" title="The “dither-quantization” property">dither-quantization</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">GstVideoGammaMode</span></td>
<td class="property_name"><a class="link" href="gst-plugins-base-plugins-videoconvert.html#GstVideoConvert--gamma-mode" title="The “gamma-mode” property">gamma-mode</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">GstVideoMatrixMode</span></td>
<td class="property_name"><a class="link" href="gst-plugins-base-plugins-videoconvert.html#GstVideoConvert--matrix-mode" title="The “matrix-mode” property">matrix-mode</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">GstVideoPrimariesMode</span></td>
<td class="property_name"><a class="link" href="gst-plugins-base-plugins-videoconvert.html#GstVideoConvert--primaries-mode" title="The “primaries-mode” property">primaries-mode</a></td>
<td class="property_flags">Read / Write</td>
</tr>
</tbody>
</table></div>
</div>
<a name="GstVideoConvert"></a><div class="refsect1">
<a name="gst-plugins-base-plugins-videoconvert.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="gst-plugins-base-plugins-videoconvert.html#GstVideoConvert-struct" title="struct GstVideoConvert">GstVideoConvert</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="gst-plugins-base-plugins-videoconvert.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobjectgobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
<span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobjectgobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
<span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0GstObject.html#GstObject-struct">GstObject</a>
<span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0GstElement.html#GstElement-struct">GstElement</a>
<span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-libs-1.0GstBaseTransform.html#GstBaseTransform-struct">GstBaseTransform</a>
<span class="lineart">╰──</span> <a href="../html/gst-plugins-base-libs-gstvideofilter.html#GstVideoFilter-struct">GstVideoFilter</a>
<span class="lineart">╰──</span> GstVideoConvert
</pre>
</div>
<div class="refsect1">
<a name="gst-plugins-base-plugins-videoconvert.description"></a><h2>Description</h2>
<p>Convert video frames between a great variety of video formats.</p>
<div class="refsect2">
<a name="id-1.2.53.7.3"></a><h3>Example launch line</h3>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1</pre></td>
<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 videotestsrc <span class="gtkdoc opt">!</span> video<span class="gtkdoc opt">/</span>x<span class="gtkdoc opt">-</span>raw<span class="gtkdoc opt">,</span>format<span class="gtkdoc opt">=</span>YUY2 <span class="gtkdoc opt">!</span> videoconvert <span class="gtkdoc opt">!</span> autovideosink</pre></td>
</tr>
</tbody>
</table>
</div>
This will output a test video (generated in YUY2 format) in a video
window. If the video sink selected does not support YUY2 videoconvert will
automatically convert the video to a format understood by the video sink.
</div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<div class="refsect2">
<a name="id-1.2.53.7.4.1"></a><h3>Element Information</h3>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">plugin</span></p></td>
<td>
<a class="link" href="gst-plugins-base-plugins-plugin-videoconvert.html#plugin-videoconvert">videoconvert</a>
</td>
</tr>
<tr>
<td><p><span class="term">author</span></p></td>
<td>GStreamer maintainers &lt;gstreamer-devel@lists.freedesktop.org&gt;</td>
</tr>
<tr>
<td><p><span class="term">class</span></p></td>
<td>Filter/Converter/Video</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="id-1.2.53.7.4.2"></a><h3>Element Pads</h3>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">name</span></p></td>
<td>sink</td>
</tr>
<tr>
<td><p><span class="term">direction</span></p></td>
<td>sink</td>
</tr>
<tr>
<td><p><span class="term">presence</span></p></td>
<td>always</td>
</tr>
<tr>
<td><p><span class="term">details</span></p></td>
<td>video/x-raw, format=(string){ I420, YV12, YUY2, UYVY, AYUV, RGBx, BGRx, xRGB, xBGR, RGBA, BGRA, ARGB, ABGR, RGB, BGR, Y41B, Y42B, YVYU, Y444, v210, v216, NV12, NV21, NV16, NV61, NV24, GRAY8, GRAY16_BE, GRAY16_LE, v308, IYU2, RGB16, BGR16, RGB15, BGR15, UYVP, A420, RGB8P, YUV9, YVU9, IYU1, ARGB64, AYUV64, r210, I420_10LE, I420_10BE, I422_10LE, I422_10BE, Y444_10LE, Y444_10BE, GBR, GBR_10LE, GBR_10BE, NV12_64Z32, A420_10LE, A420_10BE, A422_10LE, A422_10BE, A444_10LE, A444_10BE, P010_10LE, P010_10BE }, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
</tr>
<tr>
<td><p><span class="term"></span></p></td>
<td> video/x-raw(ANY), format=(string){ I420, YV12, YUY2, UYVY, AYUV, RGBx, BGRx, xRGB, xBGR, RGBA, BGRA, ARGB, ABGR, RGB, BGR, Y41B, Y42B, YVYU, Y444, v210, v216, NV12, NV21, NV16, NV61, NV24, GRAY8, GRAY16_BE, GRAY16_LE, v308, IYU2, RGB16, BGR16, RGB15, BGR15, UYVP, A420, RGB8P, YUV9, YVU9, IYU1, ARGB64, AYUV64, r210, I420_10LE, I420_10BE, I422_10LE, I422_10BE, Y444_10LE, Y444_10BE, GBR, GBR_10LE, GBR_10BE, NV12_64Z32, A420_10LE, A420_10BE, A422_10LE, A422_10BE, A444_10LE, A444_10BE, P010_10LE, P010_10BE }, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
</tr>
</tbody>
</table></div>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">name</span></p></td>
<td>src</td>
</tr>
<tr>
<td><p><span class="term">direction</span></p></td>
<td>source</td>
</tr>
<tr>
<td><p><span class="term">presence</span></p></td>
<td>always</td>
</tr>
<tr>
<td><p><span class="term">details</span></p></td>
<td>video/x-raw, format=(string){ I420, YV12, YUY2, UYVY, AYUV, RGBx, BGRx, xRGB, xBGR, RGBA, BGRA, ARGB, ABGR, RGB, BGR, Y41B, Y42B, YVYU, Y444, v210, v216, NV12, NV21, NV16, NV61, NV24, GRAY8, GRAY16_BE, GRAY16_LE, v308, IYU2, RGB16, BGR16, RGB15, BGR15, UYVP, A420, RGB8P, YUV9, YVU9, IYU1, ARGB64, AYUV64, r210, I420_10LE, I420_10BE, I422_10LE, I422_10BE, Y444_10LE, Y444_10BE, GBR, GBR_10LE, GBR_10BE, NV12_64Z32, A420_10LE, A420_10BE, A422_10LE, A422_10BE, A444_10LE, A444_10BE, P010_10LE, P010_10BE }, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
</tr>
<tr>
<td><p><span class="term"></span></p></td>
<td> video/x-raw(ANY), format=(string){ I420, YV12, YUY2, UYVY, AYUV, RGBx, BGRx, xRGB, xBGR, RGBA, BGRA, ARGB, ABGR, RGB, BGR, Y41B, Y42B, YVYU, Y444, v210, v216, NV12, NV21, NV16, NV61, NV24, GRAY8, GRAY16_BE, GRAY16_LE, v308, IYU2, RGB16, BGR16, RGB15, BGR15, UYVP, A420, RGB8P, YUV9, YVU9, IYU1, ARGB64, AYUV64, r210, I420_10LE, I420_10BE, I422_10LE, I422_10BE, Y444_10LE, Y444_10BE, GBR, GBR_10LE, GBR_10BE, NV12_64Z32, A420_10LE, A420_10BE, A422_10LE, A422_10BE, A444_10LE, A444_10BE, P010_10LE, P010_10BE }, width=(int)[ 1, 2147483647 ], height=(int)[ 1, 2147483647 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="gst-plugins-base-plugins-videoconvert.functions_details"></a><h2>Functions</h2>
<p></p>
</div>
<div class="refsect1">
<a name="gst-plugins-base-plugins-videoconvert.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GstVideoConvert-struct"></a><h3>struct GstVideoConvert</h3>
<pre class="programlisting">struct GstVideoConvert;</pre>
<p>Opaque object data structure.</p>
</div>
</div>
<div class="refsect1">
<a name="gst-plugins-base-plugins-videoconvert.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GstVideoConvert--dither"></a><h3>The <code class="literal">“dither”</code> property</h3>
<pre class="programlisting"> “dither” <a href="../html/gst-plugins-base-libs-GstVideoDither.html#GstVideoDitherMethod"><span class="type">GstVideoDitherMethod</span></a></pre>
<p>Apply dithering while converting.</p>
<p>Flags: Read / Write</p>
<p>Default value: GST_VIDEO_DITHER_BAYER</p>
</div>
<hr>
<div class="refsect2">
<a name="GstVideoConvert--alpha-mode"></a><h3>The <code class="literal">“alpha-mode”</code> property</h3>
<pre class="programlisting"> “alpha-mode” <span class="type">GstVideoAlphaMode</span></pre>
<p>Alpha Mode to use.</p>
<p>Flags: Read / Write</p>
<p>Default value: GST_VIDEO_ALPHA_MODE_COPY</p>
</div>
<hr>
<div class="refsect2">
<a name="GstVideoConvert--alpha-value"></a><h3>The <code class="literal">“alpha-value”</code> property</h3>
<pre class="programlisting"> “alpha-value” <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre>
<p>Alpha Value to use.</p>
<p>Flags: Read / Write</p>
<p>Allowed values: [0,1]</p>
<p>Default value: 1</p>
</div>
<hr>
<div class="refsect2">
<a name="GstVideoConvert--chroma-mode"></a><h3>The <code class="literal">“chroma-mode”</code> property</h3>
<pre class="programlisting"> “chroma-mode” <span class="type">GstVideoChromaMode</span></pre>
<p>Chroma Resampling Mode.</p>
<p>Flags: Read / Write</p>
<p>Default value: GST_VIDEO_CHROMA_MODE_FULL</p>
</div>
<hr>
<div class="refsect2">
<a name="GstVideoConvert--chroma-resampler"></a><h3>The <code class="literal">“chroma-resampler”</code> property</h3>
<pre class="programlisting"> “chroma-resampler” <a href="../html/gst-plugins-base-libs-GstVideoResampler.html#GstVideoResamplerMethod"><span class="type">GstVideoResamplerMethod</span></a></pre>
<p>Chroma resampler method.</p>
<p>Flags: Read / Write</p>
<p>Default value: GST_VIDEO_RESAMPLER_METHOD_LINEAR</p>
</div>
<hr>
<div class="refsect2">
<a name="GstVideoConvert--dither-quantization"></a><h3>The <code class="literal">“dither-quantization”</code> property</h3>
<pre class="programlisting"> “dither-quantization” <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#guint"><span class="type">guint</span></a></pre>
<p>Quantizer to use.</p>
<p>Flags: Read / Write</p>
<p>Default value: 1</p>
</div>
<hr>
<div class="refsect2">
<a name="GstVideoConvert--gamma-mode"></a><h3>The <code class="literal">“gamma-mode”</code> property</h3>
<pre class="programlisting"> “gamma-mode” <span class="type">GstVideoGammaMode</span></pre>
<p>Gamma Conversion Mode.</p>
<p>Flags: Read / Write</p>
<p>Default value: GST_VIDEO_GAMMA_MODE_NONE</p>
</div>
<hr>
<div class="refsect2">
<a name="GstVideoConvert--matrix-mode"></a><h3>The <code class="literal">“matrix-mode”</code> property</h3>
<pre class="programlisting"> “matrix-mode” <span class="type">GstVideoMatrixMode</span></pre>
<p>Matrix Conversion Mode.</p>
<p>Flags: Read / Write</p>
<p>Default value: GST_VIDEO_MATRIX_MODE_FULL</p>
</div>
<hr>
<div class="refsect2">
<a name="GstVideoConvert--primaries-mode"></a><h3>The <code class="literal">“primaries-mode”</code> property</h3>
<pre class="programlisting"> “primaries-mode” <span class="type">GstVideoPrimariesMode</span></pre>
<p>Primaries Conversion Mode.</p>
<p>Flags: Read / Write</p>
<p>Default value: GST_VIDEO_PRIMARIES_MODE_NONE</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>