2 * Copyright (C) <1999> Erik Walthinsen <omega@cse.ogi.edu>
3 * <2005> Wim Taymans <wim@fluendo.com>
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Library General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Library General Public License for more details.
15 * You should have received a copy of the GNU Library General Public
16 * License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 * Boston, MA 02111-1307, USA.
22 * SECTION:element-dvdec
24 * dvdec decodes DV video into raw video. The element expects a full DV frame
25 * as input, which is 120000 bytes for NTSC and 144000 for PAL video.
27 * This element can perform simple frame dropping with the #GstDVDec:drop-factor
28 * property. Setting this property to a value N > 1 will only decode every
32 * <title>Example launch line</title>
34 * gst-launch filesrc location=test.dv ! dvdemux name=demux ! dvdec ! xvimagesink
35 * ]| This pipeline decodes and renders the raw DV stream to a videosink.
38 * Last reviewed on 2006-02-28 (0.10.3)
46 #include <gst/video/video.h>
47 #include <gst/video/gstvideometa.h>
48 #include <gst/video/gstvideopool.h>
52 /* sizes of one input buffer */
53 #define NTSC_HEIGHT 480
54 #define NTSC_BUFFER 120000
55 #define NTSC_FRAMERATE_NUMERATOR 30000
56 #define NTSC_FRAMERATE_DENOMINATOR 1001
58 #define PAL_HEIGHT 576
59 #define PAL_BUFFER 144000
60 #define PAL_FRAMERATE_NUMERATOR 25
61 #define PAL_FRAMERATE_DENOMINATOR 1
63 #define PAL_NORMAL_PAR_X 59
64 #define PAL_NORMAL_PAR_Y 54
65 #define PAL_WIDE_PAR_X 118
66 #define PAL_WIDE_PAR_Y 81
68 #define NTSC_NORMAL_PAR_X 10
69 #define NTSC_NORMAL_PAR_Y 11
70 #define NTSC_WIDE_PAR_X 40
71 #define NTSC_WIDE_PAR_Y 33
73 #define DV_DEFAULT_QUALITY DV_QUALITY_BEST
74 #define DV_DEFAULT_DECODE_NTH 1
76 GST_DEBUG_CATEGORY_STATIC (dvdec_debug);
77 #define GST_CAT_DEFAULT dvdec_debug
88 const gint qualities[] = {
92 DV_QUALITY_DC | DV_QUALITY_COLOR,
93 DV_QUALITY_AC_1 | DV_QUALITY_COLOR,
94 DV_QUALITY_AC_2 | DV_QUALITY_COLOR
97 static GstStaticPadTemplate sink_temp = GST_STATIC_PAD_TEMPLATE ("sink",
100 GST_STATIC_CAPS ("video/x-dv, systemstream = (boolean) false")
103 static GstStaticPadTemplate src_temp = GST_STATIC_PAD_TEMPLATE ("src",
106 GST_STATIC_CAPS ("video/x-raw, "
107 "format = (string) { YUY2, BGRx, RGB }, "
108 "framerate = (fraction) [ 1/1, 60/1 ], "
109 "width = (int) 720, " "height = (int) { 576, 480 }")
112 #define GST_TYPE_DVDEC_QUALITY (gst_dvdec_quality_get_type())
114 gst_dvdec_quality_get_type (void)
116 static GType qtype = 0;
119 static const GEnumValue values[] = {
120 {0, "Monochrome, DC (Fastest)", "fastest"},
121 {1, "Monochrome, first AC coefficient", "monochrome-ac"},
122 {2, "Monochrome, highest quality", "monochrome-best"},
123 {3, "Colour, DC, fastest", "colour-fastest"},
124 {4, "Colour, using only the first AC coefficient", "colour-ac"},
125 {5, "Highest quality colour decoding", "best"},
129 qtype = g_enum_register_static ("GstDVDecQualityEnum", values);
134 #define gst_dvdec_parent_class parent_class
135 G_DEFINE_TYPE (GstDVDec, gst_dvdec, GST_TYPE_ELEMENT);
137 static GstFlowReturn gst_dvdec_chain (GstPad * pad, GstObject * parent,
139 static gboolean gst_dvdec_sink_event (GstPad * pad, GstObject * parent,
142 static GstStateChangeReturn gst_dvdec_change_state (GstElement * element,
143 GstStateChange transition);
145 static void gst_dvdec_set_property (GObject * object, guint prop_id,
146 const GValue * value, GParamSpec * pspec);
147 static void gst_dvdec_get_property (GObject * object, guint prop_id,
148 GValue * value, GParamSpec * pspec);
151 gst_dvdec_class_init (GstDVDecClass * klass)
153 GObjectClass *gobject_class;
154 GstElementClass *gstelement_class;
156 gobject_class = (GObjectClass *) klass;
157 gstelement_class = (GstElementClass *) klass;
159 gobject_class->set_property = gst_dvdec_set_property;
160 gobject_class->get_property = gst_dvdec_get_property;
162 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_CLAMP_LUMA,
163 g_param_spec_boolean ("clamp-luma", "Clamp luma", "Clamp luma",
164 FALSE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
165 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_CLAMP_CHROMA,
166 g_param_spec_boolean ("clamp-chroma", "Clamp chroma", "Clamp chroma",
167 FALSE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
168 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_QUALITY,
169 g_param_spec_enum ("quality", "Quality", "Decoding quality",
170 GST_TYPE_DVDEC_QUALITY, DV_DEFAULT_QUALITY,
171 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
172 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_DECODE_NTH,
173 g_param_spec_int ("drop-factor", "Drop Factor", "Only decode Nth frame",
174 1, G_MAXINT, DV_DEFAULT_DECODE_NTH,
175 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
177 gstelement_class->change_state = GST_DEBUG_FUNCPTR (gst_dvdec_change_state);
179 gst_element_class_add_pad_template (gstelement_class,
180 gst_static_pad_template_get (&sink_temp));
181 gst_element_class_add_pad_template (gstelement_class,
182 gst_static_pad_template_get (&src_temp));
184 gst_element_class_set_static_metadata (gstelement_class, "DV video decoder",
185 "Codec/Decoder/Video",
186 "Uses libdv to decode DV video (smpte314) (libdv.sourceforge.net)",
187 "Erik Walthinsen <omega@cse.ogi.edu>," "Wim Taymans <wim@fluendo.com>");
189 GST_DEBUG_CATEGORY_INIT (dvdec_debug, "dvdec", 0, "DV decoding element");
193 gst_dvdec_init (GstDVDec * dvdec)
195 dvdec->sinkpad = gst_pad_new_from_static_template (&sink_temp, "sink");
196 gst_pad_set_chain_function (dvdec->sinkpad, gst_dvdec_chain);
197 gst_pad_set_event_function (dvdec->sinkpad, gst_dvdec_sink_event);
198 gst_element_add_pad (GST_ELEMENT (dvdec), dvdec->sinkpad);
200 dvdec->srcpad = gst_pad_new_from_static_template (&src_temp, "src");
201 gst_pad_use_fixed_caps (dvdec->srcpad);
202 gst_element_add_pad (GST_ELEMENT (dvdec), dvdec->srcpad);
204 dvdec->framerate_numerator = 0;
205 dvdec->framerate_denominator = 0;
207 dvdec->drop_factor = 1;
209 dvdec->clamp_luma = FALSE;
210 dvdec->clamp_chroma = FALSE;
211 dvdec->quality = DV_DEFAULT_QUALITY;
215 gst_dvdec_sink_setcaps (GstDVDec * dvdec, GstCaps * caps)
218 const GValue *par = NULL, *rate = NULL;
220 /* first parse the caps */
221 s = gst_caps_get_structure (caps, 0);
223 /* we allow framerate and PAR to be overwritten. framerate is mandatory. */
224 if (!(rate = gst_structure_get_value (s, "framerate")))
226 par = gst_structure_get_value (s, "pixel-aspect-ratio");
229 dvdec->par_x = gst_value_get_fraction_numerator (par);
230 dvdec->par_y = gst_value_get_fraction_denominator (par);
231 dvdec->need_par = FALSE;
235 dvdec->need_par = TRUE;
237 dvdec->framerate_numerator = gst_value_get_fraction_numerator (rate);
238 dvdec->framerate_denominator = gst_value_get_fraction_denominator (rate);
239 dvdec->sink_negotiated = TRUE;
240 dvdec->src_negotiated = FALSE;
247 GST_DEBUG_OBJECT (dvdec, "no framerate specified in caps");
253 gst_dvdec_negotiate_pool (GstDVDec * dec, GstCaps * caps, GstVideoInfo * info)
257 guint size, min, max;
258 GstStructure *config;
260 /* find a pool for the negotiated caps now */
261 query = gst_query_new_allocation (caps, TRUE);
263 if (!gst_pad_peer_query (dec->srcpad, query)) {
264 GST_DEBUG_OBJECT (dec, "didn't get downstream ALLOCATION hints");
267 if (gst_query_get_n_allocation_pools (query) > 0) {
268 /* we got configuration from our peer, parse them */
269 gst_query_parse_nth_allocation_pool (query, 0, &pool, &size, &min, &max);
270 size = MAX (size, info->size);
278 /* we did not get a pool, make one ourselves then */
279 pool = gst_video_buffer_pool_new ();
283 gst_buffer_pool_set_active (dec->pool, FALSE);
284 gst_object_unref (dec->pool);
288 config = gst_buffer_pool_get_config (pool);
289 gst_buffer_pool_config_set_params (config, caps, size, min, max);
291 if (gst_query_find_allocation_meta (query, GST_VIDEO_META_API_TYPE, NULL)) {
292 /* just set the option, if the pool can support it we will transparently use
293 * it through the video info API. We could also see if the pool support this
294 * option and only activate it then. */
295 gst_buffer_pool_config_add_option (config,
296 GST_BUFFER_POOL_OPTION_VIDEO_META);
298 gst_buffer_pool_set_config (pool, config);
301 gst_buffer_pool_set_active (pool, TRUE);
303 gst_query_unref (query);
307 gst_dvdec_src_negotiate (GstDVDec * dvdec)
311 /* no PAR was specified in input, derive from encoded data */
312 if (dvdec->need_par) {
315 dvdec->par_x = PAL_WIDE_PAR_X;
316 dvdec->par_y = PAL_WIDE_PAR_Y;
318 dvdec->par_x = PAL_NORMAL_PAR_X;
319 dvdec->par_y = PAL_NORMAL_PAR_Y;
323 dvdec->par_x = NTSC_WIDE_PAR_X;
324 dvdec->par_y = NTSC_WIDE_PAR_Y;
326 dvdec->par_x = NTSC_NORMAL_PAR_X;
327 dvdec->par_y = NTSC_NORMAL_PAR_Y;
330 GST_DEBUG_OBJECT (dvdec, "Inferred PAR %d/%d from video format",
331 dvdec->par_x, dvdec->par_y);
334 /* ignoring rgb, bgr0 for now */
337 gst_video_info_set_format (&dvdec->vinfo, GST_VIDEO_FORMAT_YUY2,
339 dvdec->vinfo.fps_n = dvdec->framerate_numerator;
340 dvdec->vinfo.fps_d = dvdec->framerate_denominator;
341 dvdec->vinfo.par_n = dvdec->par_x;
342 dvdec->vinfo.par_d = dvdec->par_y;
343 if (dvdec->interlaced) {
344 dvdec->vinfo.interlace_mode = GST_VIDEO_INTERLACE_MODE_INTERLEAVED;
346 dvdec->vinfo.interlace_mode = GST_VIDEO_INTERLACE_MODE_PROGRESSIVE;
349 othercaps = gst_video_info_to_caps (&dvdec->vinfo);
350 gst_pad_set_caps (dvdec->srcpad, othercaps);
352 gst_dvdec_negotiate_pool (dvdec, othercaps, &dvdec->vinfo);
353 gst_caps_unref (othercaps);
355 dvdec->src_negotiated = TRUE;
361 gst_dvdec_sink_event (GstPad * pad, GstObject * parent, GstEvent * event)
366 dvdec = GST_DVDEC (parent);
368 switch (GST_EVENT_TYPE (event)) {
369 case GST_EVENT_FLUSH_STOP:
370 gst_segment_init (&dvdec->segment, GST_FORMAT_UNDEFINED);
372 case GST_EVENT_SEGMENT:{
373 const GstSegment *segment;
375 gst_event_parse_segment (event, &segment);
377 GST_DEBUG_OBJECT (dvdec, "Got NEWSEGMENT %" GST_SEGMENT_FORMAT, &segment);
379 gst_segment_copy_into (segment, &dvdec->segment);
386 gst_event_parse_caps (event, &caps);
387 gst_dvdec_sink_setcaps (dvdec, caps);
388 gst_event_unref (event);
399 res = gst_pad_push_event (dvdec->srcpad, event);
405 gst_dvdec_chain (GstPad * pad, GstObject * parent, GstBuffer * buf)
409 guint8 *outframe_ptrs[3];
410 gint outframe_pitches[3];
414 GstFlowReturn ret = GST_FLOW_OK;
416 guint64 cstart, cstop;
419 dvdec = GST_DVDEC (parent);
421 gst_buffer_map (buf, &map, GST_MAP_READ);
424 /* buffer should be at least the size of one NTSC frame, this should
425 * be enough to decode the header. */
426 if (G_UNLIKELY (map.size < NTSC_BUFFER))
429 /* preliminary dropping. unref and return if outside of configured segment */
430 if ((dvdec->segment.format == GST_FORMAT_TIME) &&
431 (!(gst_segment_clip (&dvdec->segment, GST_FORMAT_TIME,
432 GST_BUFFER_TIMESTAMP (buf),
433 GST_BUFFER_TIMESTAMP (buf) + GST_BUFFER_DURATION (buf),
437 if (G_UNLIKELY (dv_parse_header (dvdec->decoder, inframe) < 0))
438 goto parse_header_error;
441 PAL = dv_system_50_fields (dvdec->decoder);
442 wide = dv_format_wide (dvdec->decoder);
444 /* check the buffer is of right size after we know if we are
445 * dealing with PAL or NTSC */
446 length = (PAL ? PAL_BUFFER : NTSC_BUFFER);
447 if (G_UNLIKELY (map.size < length))
450 dv_parse_packs (dvdec->decoder, inframe);
452 if (dvdec->video_offset % dvdec->drop_factor != 0)
455 /* renegotiate on change */
456 if (PAL != dvdec->PAL || wide != dvdec->wide) {
457 dvdec->src_negotiated = FALSE;
462 dvdec->height = (dvdec->PAL ? PAL_HEIGHT : NTSC_HEIGHT);
464 dvdec->interlaced = !dv_is_progressive (dvdec->decoder);
466 /* negotiate if not done yet */
467 if (!dvdec->src_negotiated) {
468 if (!gst_dvdec_src_negotiate (dvdec))
472 if (gst_pad_check_reconfigure (dvdec->srcpad)) {
475 caps = gst_pad_get_current_caps (dvdec->srcpad);
476 gst_dvdec_negotiate_pool (dvdec, caps, &dvdec->vinfo);
477 gst_caps_unref (caps);
480 ret = gst_buffer_pool_acquire_buffer (dvdec->pool, &outbuf, NULL);
481 if (G_UNLIKELY (ret != GST_FLOW_OK))
484 gst_video_frame_map (&frame, &dvdec->vinfo, outbuf, GST_MAP_WRITE);
486 outframe_ptrs[0] = GST_VIDEO_FRAME_COMP_DATA (&frame, 0);
487 outframe_pitches[0] = GST_VIDEO_FRAME_COMP_STRIDE (&frame, 0);
489 /* the rest only matters for YUY2 */
490 if (dvdec->bpp < 3) {
491 outframe_ptrs[1] = GST_VIDEO_FRAME_COMP_DATA (&frame, 1);
492 outframe_ptrs[2] = GST_VIDEO_FRAME_COMP_DATA (&frame, 2);
494 outframe_pitches[1] = GST_VIDEO_FRAME_COMP_STRIDE (&frame, 1);
495 outframe_pitches[2] = GST_VIDEO_FRAME_COMP_STRIDE (&frame, 2);
498 GST_DEBUG_OBJECT (dvdec, "decoding and pushing buffer");
499 dv_decode_full_frame (dvdec->decoder, inframe,
500 e_dv_color_yuv, outframe_ptrs, outframe_pitches);
502 gst_video_frame_unmap (&frame);
504 GST_BUFFER_FLAG_UNSET (outbuf, GST_VIDEO_BUFFER_FLAG_TFF);
506 GST_BUFFER_OFFSET (outbuf) = GST_BUFFER_OFFSET (buf);
507 GST_BUFFER_OFFSET_END (outbuf) = GST_BUFFER_OFFSET_END (buf);
508 GST_BUFFER_TIMESTAMP (outbuf) = cstart;
509 GST_BUFFER_DURATION (outbuf) = cstop - cstart;
511 ret = gst_pad_push (dvdec->srcpad, outbuf);
514 dvdec->video_offset++;
517 gst_buffer_unmap (buf, &map);
518 gst_buffer_unref (buf);
525 GST_ELEMENT_ERROR (dvdec, STREAM, DECODE,
526 (NULL), ("Input buffer too small"));
527 ret = GST_FLOW_ERROR;
532 GST_ELEMENT_ERROR (dvdec, STREAM, DECODE,
533 (NULL), ("Error parsing DV header"));
534 ret = GST_FLOW_ERROR;
539 GST_DEBUG_OBJECT (dvdec, "could not negotiate output");
540 ret = GST_FLOW_NOT_NEGOTIATED;
545 GST_DEBUG_OBJECT (dvdec, "could not allocate buffer");
551 GST_DEBUG_OBJECT (dvdec,
552 "dropping buffer since it's out of the configured segment");
557 static GstStateChangeReturn
558 gst_dvdec_change_state (GstElement * element, GstStateChange transition)
560 GstDVDec *dvdec = GST_DVDEC (element);
561 GstStateChangeReturn ret;
564 switch (transition) {
565 case GST_STATE_CHANGE_NULL_TO_READY:
567 case GST_STATE_CHANGE_READY_TO_PAUSED:
569 dv_decoder_new (0, dvdec->clamp_luma, dvdec->clamp_chroma);
570 dvdec->decoder->quality = qualities[dvdec->quality];
571 dv_set_error_log (dvdec->decoder, NULL);
572 gst_video_info_init (&dvdec->vinfo);
573 gst_segment_init (&dvdec->segment, GST_FORMAT_UNDEFINED);
574 dvdec->src_negotiated = FALSE;
575 dvdec->sink_negotiated = FALSE;
577 * Enable this function call when libdv2 0.100 or higher is more
580 /* dv_set_quality (dvdec->decoder, qualities [dvdec->quality]); */
582 case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
588 ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
590 switch (transition) {
591 case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
593 case GST_STATE_CHANGE_PAUSED_TO_READY:
594 dv_decoder_free (dvdec->decoder);
595 dvdec->decoder = NULL;
597 gst_buffer_pool_set_active (dvdec->pool, FALSE);
598 gst_object_unref (dvdec->pool);
602 case GST_STATE_CHANGE_READY_TO_NULL:
611 gst_dvdec_set_property (GObject * object, guint prop_id, const GValue * value,
614 GstDVDec *dvdec = GST_DVDEC (object);
617 case PROP_CLAMP_LUMA:
618 dvdec->clamp_luma = g_value_get_boolean (value);
620 case PROP_CLAMP_CHROMA:
621 dvdec->clamp_chroma = g_value_get_boolean (value);
624 dvdec->quality = g_value_get_enum (value);
625 if ((dvdec->quality < 0) || (dvdec->quality > 5))
628 case PROP_DECODE_NTH:
629 dvdec->drop_factor = g_value_get_int (value);
632 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
638 gst_dvdec_get_property (GObject * object, guint prop_id, GValue * value,
641 GstDVDec *dvdec = GST_DVDEC (object);
644 case PROP_CLAMP_LUMA:
645 g_value_set_boolean (value, dvdec->clamp_luma);
647 case PROP_CLAMP_CHROMA:
648 g_value_set_boolean (value, dvdec->clamp_chroma);
651 g_value_set_enum (value, dvdec->quality);
653 case PROP_DECODE_NTH:
654 g_value_set_int (value, dvdec->drop_factor);
657 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);