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/gstvideopool.h>
51 /* sizes of one input buffer */
52 #define NTSC_HEIGHT 480
53 #define NTSC_BUFFER 120000
54 #define NTSC_FRAMERATE_NUMERATOR 30000
55 #define NTSC_FRAMERATE_DENOMINATOR 1001
57 #define PAL_HEIGHT 576
58 #define PAL_BUFFER 144000
59 #define PAL_FRAMERATE_NUMERATOR 25
60 #define PAL_FRAMERATE_DENOMINATOR 1
62 #define PAL_NORMAL_PAR_X 59
63 #define PAL_NORMAL_PAR_Y 54
64 #define PAL_WIDE_PAR_X 118
65 #define PAL_WIDE_PAR_Y 81
67 #define NTSC_NORMAL_PAR_X 10
68 #define NTSC_NORMAL_PAR_Y 11
69 #define NTSC_WIDE_PAR_X 40
70 #define NTSC_WIDE_PAR_Y 33
72 #define DV_DEFAULT_QUALITY DV_QUALITY_BEST
73 #define DV_DEFAULT_DECODE_NTH 1
75 GST_DEBUG_CATEGORY_STATIC (dvdec_debug);
76 #define GST_CAT_DEFAULT dvdec_debug
87 const gint qualities[] = {
91 DV_QUALITY_DC | DV_QUALITY_COLOR,
92 DV_QUALITY_AC_1 | DV_QUALITY_COLOR,
93 DV_QUALITY_AC_2 | DV_QUALITY_COLOR
96 static GstStaticPadTemplate sink_temp = GST_STATIC_PAD_TEMPLATE ("sink",
99 GST_STATIC_CAPS ("video/x-dv, systemstream = (boolean) false")
102 static GstStaticPadTemplate src_temp = GST_STATIC_PAD_TEMPLATE ("src",
105 GST_STATIC_CAPS ("video/x-raw, "
106 "format = (string) { YUY2, BGRx, RGB }, "
107 "framerate = (fraction) [ 1/1, 60/1 ], "
108 "width = (int) 720, " "height = (int) { 576, 480 }")
111 #define GST_TYPE_DVDEC_QUALITY (gst_dvdec_quality_get_type())
113 gst_dvdec_quality_get_type (void)
115 static GType qtype = 0;
118 static const GEnumValue values[] = {
119 {0, "Monochrome, DC (Fastest)", "fastest"},
120 {1, "Monochrome, first AC coefficient", "monochrome-ac"},
121 {2, "Monochrome, highest quality", "monochrome-best"},
122 {3, "Colour, DC, fastest", "colour-fastest"},
123 {4, "Colour, using only the first AC coefficient", "colour-ac"},
124 {5, "Highest quality colour decoding", "best"},
128 qtype = g_enum_register_static ("GstDVDecQualityEnum", values);
133 #define gst_dvdec_parent_class parent_class
134 G_DEFINE_TYPE (GstDVDec, gst_dvdec, GST_TYPE_ELEMENT);
136 static GstFlowReturn gst_dvdec_chain (GstPad * pad, GstObject * parent,
138 static gboolean gst_dvdec_sink_event (GstPad * pad, GstObject * parent,
141 static GstStateChangeReturn gst_dvdec_change_state (GstElement * element,
142 GstStateChange transition);
144 static void gst_dvdec_set_property (GObject * object, guint prop_id,
145 const GValue * value, GParamSpec * pspec);
146 static void gst_dvdec_get_property (GObject * object, guint prop_id,
147 GValue * value, GParamSpec * pspec);
150 gst_dvdec_class_init (GstDVDecClass * klass)
152 GObjectClass *gobject_class;
153 GstElementClass *gstelement_class;
155 gobject_class = (GObjectClass *) klass;
156 gstelement_class = (GstElementClass *) klass;
158 gobject_class->set_property = gst_dvdec_set_property;
159 gobject_class->get_property = gst_dvdec_get_property;
161 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_CLAMP_LUMA,
162 g_param_spec_boolean ("clamp-luma", "Clamp luma", "Clamp luma",
163 FALSE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
164 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_CLAMP_CHROMA,
165 g_param_spec_boolean ("clamp-chroma", "Clamp chroma", "Clamp chroma",
166 FALSE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
167 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_QUALITY,
168 g_param_spec_enum ("quality", "Quality", "Decoding quality",
169 GST_TYPE_DVDEC_QUALITY, DV_DEFAULT_QUALITY,
170 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
171 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_DECODE_NTH,
172 g_param_spec_int ("drop-factor", "Drop Factor", "Only decode Nth frame",
173 1, G_MAXINT, DV_DEFAULT_DECODE_NTH,
174 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
176 gstelement_class->change_state = GST_DEBUG_FUNCPTR (gst_dvdec_change_state);
178 gst_element_class_add_pad_template (gstelement_class,
179 gst_static_pad_template_get (&sink_temp));
180 gst_element_class_add_pad_template (gstelement_class,
181 gst_static_pad_template_get (&src_temp));
183 gst_element_class_set_details_simple (gstelement_class, "DV video decoder",
184 "Codec/Decoder/Video",
185 "Uses libdv to decode DV video (smpte314) (libdv.sourceforge.net)",
186 "Erik Walthinsen <omega@cse.ogi.edu>," "Wim Taymans <wim@fluendo.com>");
188 GST_DEBUG_CATEGORY_INIT (dvdec_debug, "dvdec", 0, "DV decoding element");
192 gst_dvdec_init (GstDVDec * dvdec)
194 dvdec->sinkpad = gst_pad_new_from_static_template (&sink_temp, "sink");
195 gst_pad_set_chain_function (dvdec->sinkpad, gst_dvdec_chain);
196 gst_pad_set_event_function (dvdec->sinkpad, gst_dvdec_sink_event);
197 gst_element_add_pad (GST_ELEMENT (dvdec), dvdec->sinkpad);
199 dvdec->srcpad = gst_pad_new_from_static_template (&src_temp, "src");
200 gst_pad_use_fixed_caps (dvdec->srcpad);
201 gst_element_add_pad (GST_ELEMENT (dvdec), dvdec->srcpad);
203 dvdec->framerate_numerator = 0;
204 dvdec->framerate_denominator = 0;
206 dvdec->drop_factor = 1;
208 dvdec->clamp_luma = FALSE;
209 dvdec->clamp_chroma = FALSE;
210 dvdec->quality = DV_DEFAULT_QUALITY;
214 gst_dvdec_sink_setcaps (GstDVDec * dvdec, GstCaps * caps)
217 const GValue *par = NULL, *rate = NULL;
219 /* first parse the caps */
220 s = gst_caps_get_structure (caps, 0);
222 /* we allow framerate and PAR to be overwritten. framerate is mandatory. */
223 if (!(rate = gst_structure_get_value (s, "framerate")))
225 par = gst_structure_get_value (s, "pixel-aspect-ratio");
228 dvdec->par_x = gst_value_get_fraction_numerator (par);
229 dvdec->par_y = gst_value_get_fraction_denominator (par);
230 dvdec->need_par = FALSE;
234 dvdec->need_par = TRUE;
236 dvdec->framerate_numerator = gst_value_get_fraction_numerator (rate);
237 dvdec->framerate_denominator = gst_value_get_fraction_denominator (rate);
238 dvdec->sink_negotiated = TRUE;
239 dvdec->src_negotiated = FALSE;
246 GST_DEBUG_OBJECT (dvdec, "no framerate specified in caps");
252 gst_dvdec_negotiate_pool (GstDVDec * dec, GstCaps * caps, GstVideoInfo * info)
255 GstBufferPool *pool = NULL;
256 guint size, min, max, prefix, alignment;
257 GstStructure *config;
259 /* find a pool for the negotiated caps now */
260 query = gst_query_new_allocation (caps, TRUE);
262 if (gst_pad_peer_query (dec->srcpad, query)) {
263 GST_DEBUG_OBJECT (dec, "got downstream ALLOCATION hints");
264 /* we got configuration from our peer, parse them */
265 gst_query_parse_allocation_params (query, &size, &min, &max, &prefix,
267 size = MAX (size, info->size);
269 GST_DEBUG_OBJECT (dec, "didn't get downstream ALLOCATION hints");
277 /* we did not get a pool, make one ourselves then */
278 pool = gst_buffer_pool_new ();
282 gst_object_unref (dec->pool);
285 config = gst_buffer_pool_get_config (pool);
286 gst_buffer_pool_config_set (config, caps, size, min, max, prefix, alignment);
287 /* just set the option, if the pool can support it we will transparently use
288 * it through the video info API. We could also see if the pool support this
289 * option and only activate it then. */
290 gst_buffer_pool_config_add_option (config, GST_BUFFER_POOL_OPTION_VIDEO_META);
292 gst_buffer_pool_set_config (pool, config);
294 gst_buffer_pool_set_active (pool, TRUE);
296 gst_query_unref (query);
300 gst_dvdec_src_negotiate (GstDVDec * dvdec)
304 /* no PAR was specified in input, derive from encoded data */
305 if (dvdec->need_par) {
308 dvdec->par_x = PAL_WIDE_PAR_X;
309 dvdec->par_y = PAL_WIDE_PAR_Y;
311 dvdec->par_x = PAL_NORMAL_PAR_X;
312 dvdec->par_y = PAL_NORMAL_PAR_Y;
316 dvdec->par_x = NTSC_WIDE_PAR_X;
317 dvdec->par_y = NTSC_WIDE_PAR_Y;
319 dvdec->par_x = NTSC_NORMAL_PAR_X;
320 dvdec->par_y = NTSC_NORMAL_PAR_Y;
323 GST_DEBUG_OBJECT (dvdec, "Inferred PAR %d/%d from video format",
324 dvdec->par_x, dvdec->par_y);
327 /* ignoring rgb, bgr0 for now */
330 gst_video_info_set_format (&dvdec->vinfo, GST_VIDEO_FORMAT_YUY2,
332 dvdec->vinfo.fps_n = dvdec->framerate_numerator;
333 dvdec->vinfo.fps_d = dvdec->framerate_denominator;
334 dvdec->vinfo.par_n = dvdec->par_x;
335 dvdec->vinfo.par_d = dvdec->par_y;
336 if (dvdec->interlaced) {
337 dvdec->vinfo.interlace_mode = GST_VIDEO_INTERLACE_MODE_INTERLEAVED;
338 dvdec->vinfo.flags |= GST_VIDEO_FLAG_INTERLACED;
340 dvdec->vinfo.interlace_mode = GST_VIDEO_INTERLACE_MODE_PROGRESSIVE;
341 dvdec->vinfo.flags &= GST_VIDEO_FLAG_INTERLACED;
344 othercaps = gst_video_info_to_caps (&dvdec->vinfo);
345 gst_pad_set_caps (dvdec->srcpad, othercaps);
347 gst_dvdec_negotiate_pool (dvdec, othercaps, &dvdec->vinfo);
348 gst_caps_unref (othercaps);
350 dvdec->src_negotiated = TRUE;
356 gst_dvdec_sink_event (GstPad * pad, GstObject * parent, GstEvent * event)
361 dvdec = GST_DVDEC (parent);
363 switch (GST_EVENT_TYPE (event)) {
364 case GST_EVENT_FLUSH_STOP:
365 gst_segment_init (&dvdec->segment, GST_FORMAT_UNDEFINED);
367 case GST_EVENT_SEGMENT:{
368 const GstSegment *segment;
370 gst_event_parse_segment (event, &segment);
372 GST_DEBUG_OBJECT (dvdec, "Got NEWSEGMENT %" GST_SEGMENT_FORMAT, &segment);
374 gst_segment_copy_into (segment, &dvdec->segment);
381 gst_event_parse_caps (event, &caps);
382 gst_dvdec_sink_setcaps (dvdec, caps);
383 gst_event_unref (event);
394 res = gst_pad_push_event (dvdec->srcpad, event);
400 gst_dvdec_chain (GstPad * pad, GstObject * parent, GstBuffer * buf)
404 guint8 *outframe_ptrs[3];
405 gint outframe_pitches[3];
409 GstFlowReturn ret = GST_FLOW_OK;
411 guint64 cstart, cstop;
414 dvdec = GST_DVDEC (parent);
416 gst_buffer_map (buf, &map, GST_MAP_READ);
419 /* buffer should be at least the size of one NTSC frame, this should
420 * be enough to decode the header. */
421 if (G_UNLIKELY (map.size < NTSC_BUFFER))
424 /* preliminary dropping. unref and return if outside of configured segment */
425 if ((dvdec->segment.format == GST_FORMAT_TIME) &&
426 (!(gst_segment_clip (&dvdec->segment, GST_FORMAT_TIME,
427 GST_BUFFER_TIMESTAMP (buf),
428 GST_BUFFER_TIMESTAMP (buf) + GST_BUFFER_DURATION (buf),
432 if (G_UNLIKELY (dv_parse_header (dvdec->decoder, inframe) < 0))
433 goto parse_header_error;
436 PAL = dv_system_50_fields (dvdec->decoder);
437 wide = dv_format_wide (dvdec->decoder);
439 /* check the buffer is of right size after we know if we are
440 * dealing with PAL or NTSC */
441 length = (PAL ? PAL_BUFFER : NTSC_BUFFER);
442 if (G_UNLIKELY (map.size < length))
445 dv_parse_packs (dvdec->decoder, inframe);
447 if (dvdec->video_offset % dvdec->drop_factor != 0)
450 /* renegotiate on change */
451 if (PAL != dvdec->PAL || wide != dvdec->wide) {
452 dvdec->src_negotiated = FALSE;
457 dvdec->height = (dvdec->PAL ? PAL_HEIGHT : NTSC_HEIGHT);
459 dvdec->interlaced = !dv_is_progressive (dvdec->decoder);
461 /* negotiate if not done yet */
462 if (!dvdec->src_negotiated) {
463 if (!gst_dvdec_src_negotiate (dvdec))
467 if (gst_pad_check_reconfigure (dvdec->srcpad)) {
470 caps = gst_pad_get_current_caps (dvdec->srcpad);
471 gst_dvdec_negotiate_pool (dvdec, caps, &dvdec->vinfo);
472 gst_caps_unref (caps);
475 ret = gst_buffer_pool_acquire_buffer (dvdec->pool, &outbuf, NULL);
476 if (G_UNLIKELY (ret != GST_FLOW_OK))
479 gst_video_frame_map (&frame, &dvdec->vinfo, outbuf, GST_MAP_WRITE);
481 outframe_ptrs[0] = GST_VIDEO_FRAME_COMP_DATA (&frame, 0);
482 outframe_pitches[0] = GST_VIDEO_FRAME_COMP_STRIDE (&frame, 0);
484 /* the rest only matters for YUY2 */
485 if (dvdec->bpp < 3) {
486 outframe_ptrs[1] = GST_VIDEO_FRAME_COMP_DATA (&frame, 1);
487 outframe_ptrs[2] = GST_VIDEO_FRAME_COMP_DATA (&frame, 2);
489 outframe_pitches[1] = GST_VIDEO_FRAME_COMP_STRIDE (&frame, 1);
490 outframe_pitches[2] = GST_VIDEO_FRAME_COMP_STRIDE (&frame, 2);
493 GST_DEBUG_OBJECT (dvdec, "decoding and pushing buffer");
494 dv_decode_full_frame (dvdec->decoder, inframe,
495 e_dv_color_yuv, outframe_ptrs, outframe_pitches);
497 gst_video_frame_unmap (&frame);
499 GST_BUFFER_FLAG_UNSET (outbuf, GST_VIDEO_BUFFER_FLAG_TFF);
501 GST_BUFFER_OFFSET (outbuf) = GST_BUFFER_OFFSET (buf);
502 GST_BUFFER_OFFSET_END (outbuf) = GST_BUFFER_OFFSET_END (buf);
503 GST_BUFFER_TIMESTAMP (outbuf) = cstart;
504 GST_BUFFER_DURATION (outbuf) = cstop - cstart;
506 ret = gst_pad_push (dvdec->srcpad, outbuf);
509 dvdec->video_offset++;
512 gst_buffer_unmap (buf, &map);
513 gst_buffer_unref (buf);
520 GST_ELEMENT_ERROR (dvdec, STREAM, DECODE,
521 (NULL), ("Input buffer too small"));
522 ret = GST_FLOW_ERROR;
527 GST_ELEMENT_ERROR (dvdec, STREAM, DECODE,
528 (NULL), ("Error parsing DV header"));
529 ret = GST_FLOW_ERROR;
534 GST_DEBUG_OBJECT (dvdec, "could not negotiate output");
535 ret = GST_FLOW_NOT_NEGOTIATED;
540 GST_DEBUG_OBJECT (dvdec, "could not allocate buffer");
546 GST_DEBUG_OBJECT (dvdec,
547 "dropping buffer since it's out of the configured segment");
552 static GstStateChangeReturn
553 gst_dvdec_change_state (GstElement * element, GstStateChange transition)
555 GstDVDec *dvdec = GST_DVDEC (element);
556 GstStateChangeReturn ret;
559 switch (transition) {
560 case GST_STATE_CHANGE_NULL_TO_READY:
562 case GST_STATE_CHANGE_READY_TO_PAUSED:
564 dv_decoder_new (0, dvdec->clamp_luma, dvdec->clamp_chroma);
565 dvdec->decoder->quality = qualities[dvdec->quality];
566 dv_set_error_log (dvdec->decoder, NULL);
567 gst_video_info_init (&dvdec->vinfo);
568 gst_segment_init (&dvdec->segment, GST_FORMAT_UNDEFINED);
569 dvdec->src_negotiated = FALSE;
570 dvdec->sink_negotiated = FALSE;
572 * Enable this function call when libdv2 0.100 or higher is more
575 /* dv_set_quality (dvdec->decoder, qualities [dvdec->quality]); */
577 case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
583 ret = GST_ELEMENT_CLASS (parent_class)->change_state (element, transition);
585 switch (transition) {
586 case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
588 case GST_STATE_CHANGE_PAUSED_TO_READY:
589 dv_decoder_free (dvdec->decoder);
590 dvdec->decoder = NULL;
592 gst_buffer_pool_set_active (dvdec->pool, FALSE);
593 gst_object_unref (dvdec->pool);
597 case GST_STATE_CHANGE_READY_TO_NULL:
606 gst_dvdec_set_property (GObject * object, guint prop_id, const GValue * value,
609 GstDVDec *dvdec = GST_DVDEC (object);
612 case PROP_CLAMP_LUMA:
613 dvdec->clamp_luma = g_value_get_boolean (value);
615 case PROP_CLAMP_CHROMA:
616 dvdec->clamp_chroma = g_value_get_boolean (value);
619 dvdec->quality = g_value_get_enum (value);
620 if ((dvdec->quality < 0) || (dvdec->quality > 5))
623 case PROP_DECODE_NTH:
624 dvdec->drop_factor = g_value_get_int (value);
627 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
633 gst_dvdec_get_property (GObject * object, guint prop_id, GValue * value,
636 GstDVDec *dvdec = GST_DVDEC (object);
639 case PROP_CLAMP_LUMA:
640 g_value_set_boolean (value, dvdec->clamp_luma);
642 case PROP_CLAMP_CHROMA:
643 g_value_set_boolean (value, dvdec->clamp_chroma);
646 g_value_set_enum (value, dvdec->quality);
648 case PROP_DECODE_NTH:
649 g_value_set_int (value, dvdec->drop_factor);
652 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);