Commit e8d172d0 authored by Wim Taymans's avatar Wim Taymans
Browse files

docs/plugins/: Added videoscale to docs.

Original commit message from CVS:
* docs/plugins/Makefile.am:
* docs/plugins/gst-plugins-base-plugins-docs.sgml:
* docs/plugins/gst-plugins-base-plugins-sections.txt:
Added videoscale to docs.
* gst/videorate/gstvideorate.c: (gst_video_rate_flush_prev),
(gst_video_rate_swap_prev), (gst_video_rate_event),
(gst_video_rate_chain):
Fix typo in docs.
* gst/videoscale/gstvideoscale.c: (gst_video_scale_class_init),
(gst_video_scale_init), (gst_video_scale_prepare_size),
(gst_video_scale_set_caps), (gst_video_scale_get_unit_size),
(gst_video_scale_fixate_caps), (gst_video_scale_transform):
* gst/videoscale/gstvideoscale.h:
Added docs, examples.
Some code cleanups.
Post errors instead of g_warning.
parent 852caec1
2006-03-02 Wim Taymans <wim@fluendo.com>
* docs/plugins/Makefile.am:
* docs/plugins/gst-plugins-base-plugins-docs.sgml:
* docs/plugins/gst-plugins-base-plugins-sections.txt:
Added videoscale to docs.
* gst/videorate/gstvideorate.c: (gst_video_rate_flush_prev),
(gst_video_rate_swap_prev), (gst_video_rate_event),
(gst_video_rate_chain):
Fix typo in docs.
* gst/videoscale/gstvideoscale.c: (gst_video_scale_class_init),
(gst_video_scale_init), (gst_video_scale_prepare_size),
(gst_video_scale_set_caps), (gst_video_scale_get_unit_size),
(gst_video_scale_fixate_caps), (gst_video_scale_transform):
* gst/videoscale/gstvideoscale.h:
Added docs, examples.
Some code cleanups.
Post errors instead of g_warning.
2006-03-02 Wim Taymans <wim@fluendo.com>
 
* docs/libs/gst-plugins-base-libs-docs.sgml:
......
......@@ -94,6 +94,7 @@ EXTRA_HFILES = \
$(top_srcdir)/gst/tcp/gstmultifdsink.h \
$(top_srcdir)/gst/tcp/gsttcpserversink.h \
$(top_srcdir)/gst/videorate/gstvideorate.h \
$(top_srcdir)/gst/videoscale/gstvideoscale.h \
$(top_srcdir)/gst/videotestsrc/gstvideotestsrc.h \
$(top_srcdir)/gst/volume/gstvolume.h \
$(top_srcdir)/sys/ximage/ximagesink.h \
......
......@@ -29,6 +29,7 @@
<xi:include href="xml/element-textrender.xml" />
<xi:include href="xml/element-timeoverlay.xml" />
<xi:include href="xml/element-videorate.xml" />
<xi:include href="xml/element-videoscale.xml" />
<xi:include href="xml/element-videotestsrc.xml" />
<xi:include href="xml/element-volume.xml" />
<xi:include href="xml/element-vorbisdec.xml" />
......
......@@ -262,6 +262,22 @@ GST_VIDEO_RATE_CLASS
GST_IS_VIDEO_RATE_CLASS
</SECTION>
<SECTION>
<FILE>element-videoscale</FILE>
<TITLE>videoscale</TITLE>
GstVideoScale
GstVideoScaleMethod
<SUBSECTION Standard>
GstVideoScaleClass
GST_CAT_DEFAULT
GST_VIDEO_SCALE
GST_IS_VIDEO_SCALE
GST_TYPE_VIDEO_SCALE
gst_video_scale_get_type
GST_VIDEO_SCALE_CLASS
GST_IS_VIDEO_SCALE_CLASS
</SECTION>
<SECTION>
<FILE>element-videotestsrc</FILE>
<TITLE>videotestsrc</TITLE>
......
......@@ -24,7 +24,7 @@
* <refsect2>
* <para>
* This element converts video from one framerate to another. This operation
* is performed by dropping and duplicating frames, no fance algorithm is
* is performed by dropping and duplicating frames, no fancy algorithm is
* used to interpolate frames (yet).
* </para>
* <para>
......
......@@ -18,6 +18,42 @@
* Boston, MA 02111-1307, USA.
*/
/**
* SECTION:element-videoscale
* @short_description: rescale video
* @see_also: videorate, ffmpegcolorspace
*
* <refsect2>
* <para>
* This element resizes video frames. By default the element will try to
* negotiate to the same size on the source and sinkpad so that no scaling
* is needed. It is therefore safe to insert this element in a pipeline to
* get more robust behaviour without any cost if no scaling is needed.
* </para>
* <para>
* This element supports a wide range of color spaces including various YUV and
* RGB formats and is therefore generally able to operate anywhere in a pipeline.
* </para>
* <title>Example pipelines</title>
* <para>
* <programlisting>
* gst-launch -v filesrc location=videotestsrc.ogg ! oggdemux ! theoradec ! ffmpegcolorspace ! videoscale ! ximagesink
* </programlisting>
* Decode an Ogg/Theora and display the video using ximagesink. Since ximagesink cannot
* perform scaling, the video scaling will be performed by videoscale when you resize the
* video window.
* To create the test Ogg/Theora file refer to the documentation of theoraenc.
* </para>
* <para>
* <programlisting>
* gst-launch -v filesrc location=videotestsrc.ogg ! oggdemux ! theoradec ! videoscale ! video/x-raw-yuv, width=50 ! xvimagesink
* </programlisting>
* Decode an Ogg/Theora and display the video using xvimagesink with a width of 50.
* </para>
* </refsect2>
*
* Last reviewed on 2006-03-02 (0.10.4)
*/
#ifdef HAVE_CONFIG_H
#include "config.h"
......@@ -41,6 +77,8 @@ GST_ELEMENT_DETAILS ("Video scaler",
"Resizes video",
"Wim Taymans <wim.taymans@chello.be>");
#define DEFAULT_PROP_METHOD GST_VIDEO_SCALE_NEAREST
enum
{
PROP_0,
......@@ -214,7 +252,7 @@ gst_video_scale_class_init (GstVideoScaleClass * klass)
g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_METHOD,
g_param_spec_enum ("method", "method", "method",
GST_TYPE_VIDEO_SCALE_METHOD, 0, G_PARAM_READWRITE));
GST_TYPE_VIDEO_SCALE_METHOD, DEFAULT_PROP_METHOD, G_PARAM_READWRITE));
trans_class->transform_caps =
GST_DEBUG_FUNCPTR (gst_video_scale_transform_caps);
......@@ -237,8 +275,7 @@ gst_video_scale_init (GstVideoScale * videoscale)
gst_pad_set_event_function (trans->srcpad, gst_video_scale_handle_src_event);
videoscale->tmp_buf = NULL;
videoscale->method = GST_VIDEO_SCALE_NEAREST;
/*videoscale->method = GST_VIDEO_SCALE_BILINEAR; */
videoscale->method = DEFAULT_PROP_METHOD;
}
......@@ -320,7 +357,7 @@ gst_video_scale_get_format (GstCaps * caps)
/* calculate the size of a buffer */
static gboolean
gst_video_scale_prepare_size (gint format,
gst_video_scale_prepare_size (GstVideoScale * videoscale, gint format,
VSImage * img, gint width, gint height, guint * size)
{
gboolean res = TRUE;
......@@ -375,12 +412,18 @@ gst_video_scale_prepare_size (gint format,
*size = img->stride * img->height;
break;
default:
g_warning ("don't know how to scale");
res = FALSE;
break;
goto unknown_format;
}
return res;
/* ERRORS */
unknown_format:
{
GST_ELEMENT_ERROR (videoscale, STREAM, NOT_IMPLEMENTED, (NULL),
("Unsupported format %d", videoscale->format));
return FALSE;
}
}
static gboolean
......@@ -413,15 +456,16 @@ gst_video_scale_set_caps (GstBaseTransform * trans, GstCaps * in, GstCaps * out)
if (!ret)
goto done;
ret = gst_video_scale_prepare_size (videoscale->format,
&videoscale->src, videoscale->from_width, videoscale->from_height,
&videoscale->src_size);
ret &= gst_video_scale_prepare_size (videoscale->format,
&videoscale->dest, videoscale->to_width, videoscale->to_height,
&videoscale->dest_size);
if (!(ret = gst_video_scale_prepare_size (videoscale, videoscale->format,
&videoscale->src, videoscale->from_width, videoscale->from_height,
&videoscale->src_size)))
/* prepare size has posted an error when it returns FALSE */
goto done;
if (!ret)
if (!(ret = gst_video_scale_prepare_size (videoscale, videoscale->format,
&videoscale->dest, videoscale->to_width, videoscale->to_height,
&videoscale->dest_size)))
/* prepare size has posted an error when it returns FALSE */
goto done;
if (videoscale->tmp_buf)
......@@ -453,7 +497,8 @@ gst_video_scale_get_unit_size (GstBaseTransform * trans, GstCaps * caps,
if (!parse_caps (caps, &format, &width, &height))
return FALSE;
if (!gst_video_scale_prepare_size (format, &img, width, height, size))
if (!gst_video_scale_prepare_size (videoscale, format, &img, width, height,
size))
return FALSE;
return TRUE;
......@@ -479,8 +524,8 @@ gst_video_scale_fixate_caps (GstBaseTransform * base, GstPadDirection direction,
if (from_par && to_par) {
GValue to_ratio = { 0, }; /* w/h of output video */
int from_w, from_h, from_par_n, from_par_d, to_par_n, to_par_d;
int count = 0, w = 0, h = 0, num, den;
gint from_w, from_h, from_par_n, from_par_d, to_par_n, to_par_d;
gint count = 0, w = 0, h = 0, num, den;
/* if both width and height are already fixed, we can't do anything
* about it anymore */
......@@ -639,7 +684,7 @@ gst_video_scale_transform (GstBaseTransform * trans, GstBuffer * in,
vs_image_scale_nearest_RGB555 (dest, src, videoscale->tmp_buf);
break;
default:
g_warning ("don't know how to scale");
goto unsupported;
}
break;
case GST_VIDEO_SCALE_BILINEAR:
......@@ -680,18 +725,32 @@ gst_video_scale_transform (GstBaseTransform * trans, GstBuffer * in,
vs_image_scale_linear_RGB555 (dest, src, videoscale->tmp_buf);
break;
default:
g_warning ("don't know how to scale");
goto unsupported;
}
break;
default:
ret = GST_FLOW_ERROR;
break;
goto unknown_mode;
}
GST_LOG_OBJECT (videoscale, "pushing buffer of %d bytes",
GST_BUFFER_SIZE (out));
return ret;
/* ERRORS */
unsupported:
{
GST_ELEMENT_ERROR (videoscale, STREAM, NOT_IMPLEMENTED, (NULL),
("Unsupported format %d for scaling method %d",
videoscale->format, videoscale->method));
return GST_FLOW_ERROR;
}
unknown_mode:
{
GST_ELEMENT_ERROR (videoscale, STREAM, NOT_IMPLEMENTED, (NULL),
("Unknown scaling method %d", videoscale->method));
return GST_FLOW_ERROR;
}
}
static gboolean
......
......@@ -17,11 +17,9 @@
* Boston, MA 02111-1307, USA.
*/
#ifndef __GST_VIDEO_SCALE_H__
#define __GST_VIDEO_SCALE_H__
#include <gst/gst.h>
#include <gst/base/gstbasetransform.h>
......@@ -29,11 +27,9 @@
G_BEGIN_DECLS
GST_DEBUG_CATEGORY_EXTERN (video_scale_debug);
#define GST_CAT_DEFAULT video_scale_debug
#define GST_TYPE_VIDEO_SCALE \
(gst_video_scale_get_type())
#define GST_VIDEO_SCALE(obj) \
......@@ -45,17 +41,26 @@ GST_DEBUG_CATEGORY_EXTERN (video_scale_debug);
#define GST_IS_VIDEO_SCALE_CLASS(obj) \
(G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_VIDEO_SCALE))
/**
* GstVideoScaleMethod:
* @GST_VIDEO_SCALE_NEAREST: use nearest neighbour scaling (fast and ugly)
* @GST_VIDEO_SCALE_BILINEAR: use bilinear scaling (slower but prettier).
*
* The videoscale method to use.
*/
typedef enum {
GST_VIDEO_SCALE_NEAREST,
GST_VIDEO_SCALE_BILINEAR,
} GstVideoScaleMethod;
typedef struct _GstVideoScale GstVideoScale;
typedef struct _GstVideoScaleClass GstVideoScaleClass;
/**
* GstVideoScale:
*
* Opaque data structure
*/
struct _GstVideoScale {
GstBaseTransform element;
......@@ -72,7 +77,7 @@ struct _GstVideoScale {
gint from_width;
gint from_height;
/* private */
/*< private >*/
guint8 *tmp_buf;
};
......@@ -80,11 +85,8 @@ struct _GstVideoScaleClass {
GstBaseTransformClass parent_class;
};
GType gst_video_scale_get_type(void);
G_END_DECLS
#endif /* __GST_VIDEO_SCALE_H__ */
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment