4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
<title>videoscale</title>
5
<title>GStreamer Base Plugins 1.0 Plugins Reference Manual: videoscale</title>
6
6
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7
7
<link rel="home" href="index.html" title="GStreamer Base Plugins 1.0 Plugins Reference Manual">
8
8
<link rel="up" href="ch01.html" title="gst-plugins-base Elements">
9
9
<link rel="prev" href="gst-plugins-base-plugins-videorate.html" title="videorate">
10
10
<link rel="next" href="gst-plugins-base-plugins-videotestsrc.html" title="videotestsrc">
11
<meta name="generator" content="GTK-Doc V1.19 (XML mode)">
11
<meta name="generator" content="GTK-Doc V1.20 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
14
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="2">
17
<td><a accesskey="p" href="gst-plugins-base-plugins-videorate.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20
<th width="100%" align="center">GStreamer Base Plugins 1.0 Plugins Reference Manual</th>
21
<td><a accesskey="n" href="gst-plugins-base-plugins-videotestsrc.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
23
<tr><td colspan="5" class="shortcuts">
24
<a href="#gst-plugins-base-plugins-videoscale.synopsis" class="shortcut">Top</a>
26
<a href="#gst-plugins-base-plugins-videoscale.description" class="shortcut">Description</a>
28
<a href="#gst-plugins-base-plugins-videoscale.object-hierarchy" class="shortcut">Object Hierarchy</a>
30
<a href="#gst-plugins-base-plugins-videoscale.properties" class="shortcut">Properties</a>
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><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-base-plugins-videoscale.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
19
<a href="#gst-plugins-base-plugins-videoscale.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span>
20
<a href="#gst-plugins-base-plugins-videoscale.properties" class="shortcut">Properties</a></span>
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-base-plugins-videorate.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
25
<td><a accesskey="n" href="gst-plugins-base-plugins-videotestsrc.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
33
27
<div class="refentry">
34
28
<a name="gst-plugins-base-plugins-videoscale"></a><div class="titlepage"></div>
35
29
<div class="refnamediv"><table width="100%"><tr>
37
31
<h2><span class="refentrytitle"><a name="gst-plugins-base-plugins-videoscale.top_of_page"></a>videoscale</span></h2>
38
32
<p>videoscale — Resizes video</p>
40
<td valign="top" align="right"></td>
34
<td class="gallery_image" valign="top" align="right"></td>
41
35
</tr></table></div>
42
<div class="refsynopsisdiv">
43
<a name="gst-plugins-base-plugins-videoscale.synopsis"></a><h2>Synopsis</h2>
44
<a name="GstVideoScale"></a><pre class="synopsis">struct <a class="link" href="gst-plugins-base-plugins-videoscale.html#GstVideoScale-struct" title="struct GstVideoScale">GstVideoScale</a>;
45
enum <a class="link" href="gst-plugins-base-plugins-videoscale.html#GstVideoScaleMethod" title="enum GstVideoScaleMethod">GstVideoScaleMethod</a>;
36
<div class="refsect1">
37
<a name="gst-plugins-base-plugins-videoscale.properties"></a><h2>Properties</h2>
38
<div class="informaltable"><table border="0">
40
<col width="150px" class="properties_type">
41
<col width="300px" class="properties_name">
42
<col width="200px" class="properties_flags">
46
<td class="property_type"><a class="link" href="gst-plugins-base-plugins-videoscale.html#GstVideoScaleMethod" title="enum GstVideoScaleMethod"><span class="type">GstVideoScaleMethod</span></a></td>
47
<td class="property_name"><a class="link" href="gst-plugins-base-plugins-videoscale.html#GstVideoScale--method" title="The “method” property">method</a></td>
48
<td class="property_flags">Read / Write</td>
51
<td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
52
<td class="property_name"><a class="link" href="gst-plugins-base-plugins-videoscale.html#GstVideoScale--add-borders" title="The “add-borders” property">add-borders</a></td>
53
<td class="property_flags">Read / Write</td>
56
<td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
57
<td class="property_name"><a class="link" href="gst-plugins-base-plugins-videoscale.html#GstVideoScale--dither" title="The “dither” property">dither</a></td>
58
<td class="property_flags">Read / Write / Construct</td>
61
<td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></td>
62
<td class="property_name"><a class="link" href="gst-plugins-base-plugins-videoscale.html#GstVideoScale--envelope" title="The “envelope” property">envelope</a></td>
63
<td class="property_flags">Read / Write / Construct</td>
66
<td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></td>
67
<td class="property_name"><a class="link" href="gst-plugins-base-plugins-videoscale.html#GstVideoScale--sharpen" title="The “sharpen” property">sharpen</a></td>
68
<td class="property_flags">Read / Write / Construct</td>
71
<td class="property_type"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></td>
72
<td class="property_name"><a class="link" href="gst-plugins-base-plugins-videoscale.html#GstVideoScale--sharpness" title="The “sharpness” property">sharpness</a></td>
73
<td class="property_flags">Read / Write / Construct</td>
78
<a name="GstVideoScale"></a><div class="refsect1">
79
<a name="gst-plugins-base-plugins-videoscale.other"></a><h2>Types and Values</h2>
80
<div class="informaltable"><table width="100%" border="0">
82
<col width="150px" class="name">
83
<col class="description">
87
<td class="datatype_keyword">struct</td>
88
<td class="function_name"><a class="link" href="gst-plugins-base-plugins-videoscale.html#GstVideoScale-struct" title="struct GstVideoScale">GstVideoScale</a></td>
91
<td class="datatype_keyword">enum</td>
92
<td class="function_name"><a class="link" href="gst-plugins-base-plugins-videoscale.html#GstVideoScaleMethod" title="enum GstVideoScaleMethod">GstVideoScaleMethod</a></td>
48
97
<div class="refsect1">
49
98
<a name="gst-plugins-base-plugins-videoscale.object-hierarchy"></a><h2>Object Hierarchy</h2>
50
<pre class="synopsis">
51
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
52
+----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
53
+----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
54
+----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
55
+----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstBaseTransform.html">GstBaseTransform</a>
56
+----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstvideofilter.html#GstVideoFilter">GstVideoFilter</a>
60
<div class="refsect1">
61
<a name="gst-plugins-base-plugins-videoscale.properties"></a><h2>Properties</h2>
62
<pre class="synopsis">
63
"<a class="link" href="gst-plugins-base-plugins-videoscale.html#GstVideoScale--method" title='The "method" property'>method</a>" <a class="link" href="gst-plugins-base-plugins-videoscale.html#GstVideoScaleMethod" title="enum GstVideoScaleMethod"><span class="type">GstVideoScaleMethod</span></a> : Read / Write
64
"<a class="link" href="gst-plugins-base-plugins-videoscale.html#GstVideoScale--add-borders" title='The "add-borders" property'>add-borders</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write
65
"<a class="link" href="gst-plugins-base-plugins-videoscale.html#GstVideoScale--dither" title='The "dither" property'>dither</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write / Construct
66
"<a class="link" href="gst-plugins-base-plugins-videoscale.html#GstVideoScale--envelope" title='The "envelope" property'>envelope</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> : Read / Write / Construct
67
"<a class="link" href="gst-plugins-base-plugins-videoscale.html#GstVideoScale--sharpen" title='The "sharpen" property'>sharpen</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> : Read / Write / Construct
68
"<a class="link" href="gst-plugins-base-plugins-videoscale.html#GstVideoScale--sharpness" title='The "sharpness" property'>sharpness</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> : Read / Write / Construct
99
<pre class="screen"> <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
100
<span class="lineart">╰──</span> <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
101
<span class="lineart">╰──</span> <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
102
<span class="lineart">╰──</span> <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
103
<span class="lineart">╰──</span> <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstBaseTransform.html">GstBaseTransform</a>
104
<span class="lineart">╰──</span> <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstvideofilter.html#GstVideoFilter">GstVideoFilter</a>
105
<span class="lineart">╰──</span> GstVideoScale
71
108
<div class="refsect1">
72
109
<a name="gst-plugins-base-plugins-videoscale.description"></a><h2>Description</h2>
74
This element resizes video frames. By default the element will try to
110
<p>This element resizes video frames. By default the element will try to
75
111
negotiate to the same size on the source and sinkpad so that no scaling
76
112
is needed. It is therefore safe to insert this element in a pipeline to
77
get more robust behaviour without any cost if no scaling is needed.
80
This element supports a wide range of color spaces including various YUV and
113
get more robust behaviour without any cost if no scaling is needed.</p>
114
<p>This element supports a wide range of color spaces including various YUV and
81
115
RGB formats and is therefore generally able to operate anywhere in a
86
117
<div class="refsect2">
87
<a name="id-1.2.38.6.4.1"></a><h3>Example pipelines</h3>
118
<a name="id-1.2.38.7.4"></a><h3>Example pipelines</h3>
88
119
<div class="informalexample">
89
120
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
211
238
<div class="refsect1">
212
<a name="gst-plugins-base-plugins-videoscale.details"></a><h2>Details</h2>
239
<a name="gst-plugins-base-plugins-videoscale.functions_details"></a><h2>Functions</h2>
241
<div class="refsect1">
242
<a name="gst-plugins-base-plugins-videoscale.other_details"></a><h2>Types and Values</h2>
213
243
<div class="refsect2">
214
244
<a name="GstVideoScale-struct"></a><h3>struct GstVideoScale</h3>
215
245
<pre class="programlisting">struct GstVideoScale;</pre>
217
Opaque data structure
246
<p>Opaque data structure</p>
221
249
<div class="refsect2">
222
250
<a name="GstVideoScaleMethod"></a><h3>enum GstVideoScaleMethod</h3>
223
<pre class="programlisting">typedef enum {
224
GST_VIDEO_SCALE_NEAREST,
225
GST_VIDEO_SCALE_BILINEAR,
226
GST_VIDEO_SCALE_4TAP,
227
GST_VIDEO_SCALE_LANCZOS
228
} GstVideoScaleMethod;
231
The videoscale method to use.
233
<div class="variablelist"><table border="0" class="variablelist">
251
<p>The videoscale method to use.</p>
252
<div class="refsect3">
253
<a name="id-1.2.38.9.3.4"></a><h4>Members</h4>
254
<div class="informaltable"><table width="100%" border="0">
235
<col align="left" valign="top">
256
<col width="300px" class="enum_members_name">
257
<col class="enum_members_description">
258
<col width="200px" class="enum_members_annotations">
240
<td><p><a name="GST-VIDEO-SCALE-NEAREST:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_SCALE_NEAREST</code></span></p></td>
241
<td>use nearest neighbour scaling (fast and ugly)
245
<td><p><a name="GST-VIDEO-SCALE-BILINEAR:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_SCALE_BILINEAR</code></span></p></td>
246
<td>use bilinear scaling (slower but prettier).
250
<td><p><a name="GST-VIDEO-SCALE-4TAP:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_SCALE_4TAP</code></span></p></td>
251
<td>use a 4-tap filter for scaling (slow).
255
<td><p><a name="GST-VIDEO-SCALE-LANCZOS:CAPS"></a><span class="term"><code class="literal">GST_VIDEO_SCALE_LANCZOS</code></span></p></td>
256
<td>use a multitap Lanczos filter for scaling (slow).
262
<td class="enum_member_name"><p><a name="GST-VIDEO-SCALE-NEAREST:CAPS"></a>GST_VIDEO_SCALE_NEAREST</p></td>
263
<td class="enum_member_description">
264
<p>use nearest neighbour scaling (fast and ugly)</p>
266
<td class="enum_member_annotations"> </td>
269
<td class="enum_member_name"><p><a name="GST-VIDEO-SCALE-BILINEAR:CAPS"></a>GST_VIDEO_SCALE_BILINEAR</p></td>
270
<td class="enum_member_description">
271
<p>use bilinear scaling (slower but prettier).</p>
273
<td class="enum_member_annotations"> </td>
276
<td class="enum_member_name"><p><a name="GST-VIDEO-SCALE-4TAP:CAPS"></a>GST_VIDEO_SCALE_4TAP</p></td>
277
<td class="enum_member_description">
278
<p>use a 4-tap filter for scaling (slow).</p>
280
<td class="enum_member_annotations"> </td>
283
<td class="enum_member_name"><p><a name="GST-VIDEO-SCALE-LANCZOS:CAPS"></a>GST_VIDEO_SCALE_LANCZOS</p></td>
284
<td class="enum_member_description">
285
<p>use a multitap Lanczos filter for scaling (slow).</p>
287
<td class="enum_member_annotations"> </td>
263
294
<div class="refsect1">
264
295
<a name="gst-plugins-base-plugins-videoscale.property-details"></a><h2>Property Details</h2>
265
296
<div class="refsect2">
266
<a name="GstVideoScale--method"></a><h3>The <code class="literal">"method"</code> property</h3>
267
<pre class="programlisting"> "method" <a class="link" href="gst-plugins-base-plugins-videoscale.html#GstVideoScaleMethod" title="enum GstVideoScaleMethod"><span class="type">GstVideoScaleMethod</span></a> : Read / Write</pre>
297
<a name="GstVideoScale--method"></a><h3>The <code class="literal">“method”</code> property</h3>
298
<pre class="programlisting"> “method” <a class="link" href="gst-plugins-base-plugins-videoscale.html#GstVideoScaleMethod" title="enum GstVideoScaleMethod"><span class="type">GstVideoScaleMethod</span></a></pre>
300
<p>Flags: Read / Write</p>
269
301
<p>Default value: Bilinear</p>
272
304
<div class="refsect2">
273
<a name="GstVideoScale--add-borders"></a><h3>The <code class="literal">"add-borders"</code> property</h3>
274
<pre class="programlisting"> "add-borders" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write</pre>
305
<a name="GstVideoScale--add-borders"></a><h3>The <code class="literal">“add-borders”</code> property</h3>
306
<pre class="programlisting"> “add-borders” <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
275
307
<p>Add black borders if necessary to keep the display aspect ratio.</p>
308
<p>Flags: Read / Write</p>
276
309
<p>Default value: TRUE</p>
279
312
<div class="refsect2">
280
<a name="GstVideoScale--dither"></a><h3>The <code class="literal">"dither"</code> property</h3>
281
<pre class="programlisting"> "dither" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write / Construct</pre>
313
<a name="GstVideoScale--dither"></a><h3>The <code class="literal">“dither”</code> property</h3>
314
<pre class="programlisting"> “dither” <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
282
315
<p>Add dither (only used for Lanczos method).</p>
316
<p>Flags: Read / Write / Construct</p>
283
317
<p>Default value: FALSE</p>
286
320
<div class="refsect2">
287
<a name="GstVideoScale--envelope"></a><h3>The <code class="literal">"envelope"</code> property</h3>
288
<pre class="programlisting"> "envelope" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> : Read / Write / Construct</pre>
321
<a name="GstVideoScale--envelope"></a><h3>The <code class="literal">“envelope”</code> property</h3>
322
<pre class="programlisting"> “envelope” <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre>
289
323
<p>Size of filter envelope.</p>
324
<p>Flags: Read / Write / Construct</p>
290
325
<p>Allowed values: [1,5]</p>
291
326
<p>Default value: 2</p>
294
329
<div class="refsect2">
295
<a name="GstVideoScale--sharpen"></a><h3>The <code class="literal">"sharpen"</code> property</h3>
296
<pre class="programlisting"> "sharpen" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> : Read / Write / Construct</pre>
330
<a name="GstVideoScale--sharpen"></a><h3>The <code class="literal">“sharpen”</code> property</h3>
331
<pre class="programlisting"> “sharpen” <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre>
297
332
<p>Sharpening.</p>
333
<p>Flags: Read / Write / Construct</p>
298
334
<p>Allowed values: [0,1]</p>
299
335
<p>Default value: 0</p>
302
338
<div class="refsect2">
303
<a name="GstVideoScale--sharpness"></a><h3>The <code class="literal">"sharpness"</code> property</h3>
304
<pre class="programlisting"> "sharpness" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> : Read / Write / Construct</pre>
339
<a name="GstVideoScale--sharpness"></a><h3>The <code class="literal">“sharpness”</code> property</h3>
340
<pre class="programlisting"> “sharpness” <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a></pre>
305
341
<p>Sharpness of filter.</p>
342
<p>Flags: Read / Write / Construct</p>
306
343
<p>Allowed values: [0.5,1.5]</p>
307
344
<p>Default value: 1</p>
310
347
<div class="refsect1">
311
348
<a name="gst-plugins-base-plugins-videoscale.see-also"></a><h2>See Also</h2>
312
videorate, videoconvert
349
<p>videorate, videoconvert</p>
315
352
<div class="footer">
317
Generated by GTK-Doc V1.19</div>
354
Generated by GTK-Doc V1.20</div>
b'\\ No newline at end of file'
added
removed
docs/plugins/html/gst-plugins-base-plugins-videoscale.html
