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
26 * dvdec decodes DV video into raw video. The element expects a full DV frame
27 * as input, which is 120000 bytes for NTSC and 144000 for PAL video.
30 * This element can perform simple frame dropping with the drop-factor
31 * property. Setting this property to a value N > 1 will only decode every
34 * <title>Example launch line</title>
37 * gst-launch filesrc location=test.dv ! dvdemux name=demux ! dvdec ! xvimagesink
39 * This pipeline decodes and renders the raw DV stream to a videosink.
41 * Last reviewed on 2006-02-28 (0.10.3)
54 static const GstElementDetails dvdec_details =
55 GST_ELEMENT_DETAILS ("DV video decoder",
56 "Codec/Decoder/Video",
57 "Uses libdv to decode DV video (smpte314) (libdv.sourceforge.net)",
58 "Erik Walthinsen <omega@cse.ogi.edu>," "Wim Taymans <wim@fluendo.com>");
60 /* sizes of one input buffer */
61 #define NTSC_HEIGHT 480
62 #define NTSC_BUFFER 120000
63 #define NTSC_FRAMERATE_NUMERATOR 30000
64 #define NTSC_FRAMERATE_DENOMINATOR 1001
66 #define PAL_HEIGHT 576
67 #define PAL_BUFFER 144000
68 #define PAL_FRAMERATE_NUMERATOR 25
69 #define PAL_FRAMERATE_DENOMINATOR 1
71 #define PAL_NORMAL_PAR_X 59
72 #define PAL_NORMAL_PAR_Y 54
73 #define PAL_WIDE_PAR_X 118
74 #define PAL_WIDE_PAR_Y 81
76 #define NTSC_NORMAL_PAR_X 10
77 #define NTSC_NORMAL_PAR_Y 11
78 #define NTSC_WIDE_PAR_X 40
79 #define NTSC_WIDE_PAR_Y 33
81 #define DV_DEFAULT_QUALITY DV_QUALITY_BEST
82 #define DV_DEFAULT_DECODE_NTH 1
84 GST_DEBUG_CATEGORY_STATIC (dvdec_debug);
85 #define GST_CAT_DEFAULT dvdec_debug
96 const gint qualities[] = {
100 DV_QUALITY_DC | DV_QUALITY_COLOR,
101 DV_QUALITY_AC_1 | DV_QUALITY_COLOR,
102 DV_QUALITY_AC_2 | DV_QUALITY_COLOR
105 static GstStaticPadTemplate sink_temp = GST_STATIC_PAD_TEMPLATE ("sink",
108 GST_STATIC_CAPS ("video/x-dv, systemstream = (boolean) false")
111 static GstStaticPadTemplate src_temp = GST_STATIC_PAD_TEMPLATE ("src",
114 GST_STATIC_CAPS ("video/x-raw-yuv, "
115 "format = (fourcc) YUY2, "
116 "width = (int) 720, "
117 "framerate = (fraction) [ 1/1, 60/1 ];"
121 "endianness = (int) " G_STRINGIFY (G_BIG_ENDIAN) ", "
122 "red_mask = (int) 0x0000ff00, "
123 "green_mask = (int) 0x00ff0000, "
124 "blue_mask = (int) 0xff000000, "
125 "width = (int) 720, "
126 "framerate = (fraction) [ 1/1, 60/1 ];"
130 "endianness = (int) " G_STRINGIFY (G_BIG_ENDIAN) ", "
131 "red_mask = (int) 0x00ff0000, "
132 "green_mask = (int) 0x0000ff00, "
133 "blue_mask = (int) 0x000000ff, "
134 "width = (int) 720, " "framerate = (fraction) [ 1/1, 60/1 ]")
137 #define GST_TYPE_DVDEC_QUALITY (gst_dvdec_quality_get_type())
139 gst_dvdec_quality_get_type (void)
141 static GType qtype = 0;
144 static const GEnumValue values[] = {
145 {0, "Monochrome, DC (Fastest)", "fastest"},
146 {1, "Monochrome, first AC coefficient", "monochrome-ac"},
147 {2, "Monochrome, highest quality", "monochrome-best"},
148 {3, "Colour, DC, fastest", "colour-fastest"},
149 {4, "Colour, using only the first AC coefficient", "colour-ac"},
150 {5, "Highest quality colour decoding", "best"},
154 qtype = g_enum_register_static ("GstDVDecQualityEnum", values);
159 GST_BOILERPLATE (GstDVDec, gst_dvdec, GstElement, GST_TYPE_ELEMENT);
161 static void gst_dvdec_finalize (GObject * object);
162 static gboolean gst_dvdec_sink_setcaps (GstPad * pad, GstCaps * caps);
163 static GstFlowReturn gst_dvdec_chain (GstPad * pad, GstBuffer * buffer);
164 static gboolean gst_dvdec_sink_event (GstPad * pad, GstEvent * event);
166 static GstStateChangeReturn gst_dvdec_change_state (GstElement * element,
167 GstStateChange transition);
169 static void gst_dvdec_set_property (GObject * object, guint prop_id,
170 const GValue * value, GParamSpec * pspec);
171 static void gst_dvdec_get_property (GObject * object, guint prop_id,
172 GValue * value, GParamSpec * pspec);
175 gst_dvdec_base_init (gpointer g_class)
177 GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
179 gst_element_class_add_pad_template (element_class,
180 gst_static_pad_template_get (&sink_temp));
181 gst_element_class_add_pad_template (element_class,
182 gst_static_pad_template_get (&src_temp));
184 gst_element_class_set_details (element_class, &dvdec_details);
186 GST_DEBUG_CATEGORY_INIT (dvdec_debug, "dvdec", 0, "DV decoding element");
190 gst_dvdec_class_init (GstDVDecClass * klass)
192 GObjectClass *gobject_class;
193 GstElementClass *gstelement_class;
195 gobject_class = (GObjectClass *) klass;
196 gstelement_class = (GstElementClass *) klass;
198 gobject_class->finalize = gst_dvdec_finalize;
199 gobject_class->set_property = gst_dvdec_set_property;
200 gobject_class->get_property = gst_dvdec_get_property;
202 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_CLAMP_LUMA,
203 g_param_spec_boolean ("clamp_luma", "Clamp luma", "Clamp luma",
204 FALSE, G_PARAM_READWRITE));
205 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_CLAMP_CHROMA,
206 g_param_spec_boolean ("clamp_chroma", "Clamp chroma", "Clamp chroma",
207 FALSE, G_PARAM_READWRITE));
208 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_QUALITY,
209 g_param_spec_enum ("quality", "Quality", "Decoding quality",
210 GST_TYPE_DVDEC_QUALITY, DV_DEFAULT_QUALITY, G_PARAM_READWRITE));
211 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_DECODE_NTH,
212 g_param_spec_int ("drop-factor", "Drop Factor", "Only decode Nth frame",
213 1, G_MAXINT, DV_DEFAULT_DECODE_NTH, G_PARAM_READWRITE));
215 gstelement_class->change_state = gst_dvdec_change_state;
217 /* table initialization, only do once */
222 gst_dvdec_init (GstDVDec * dvdec, GstDVDecClass * g_class)
224 dvdec->sinkpad = gst_pad_new_from_static_template (&sink_temp, "sink");
225 gst_pad_set_setcaps_function (dvdec->sinkpad,
226 GST_DEBUG_FUNCPTR (gst_dvdec_sink_setcaps));
227 gst_pad_set_chain_function (dvdec->sinkpad, gst_dvdec_chain);
228 gst_pad_set_event_function (dvdec->sinkpad, gst_dvdec_sink_event);
229 gst_element_add_pad (GST_ELEMENT (dvdec), dvdec->sinkpad);
231 dvdec->srcpad = gst_pad_new_from_static_template (&src_temp, "src");
232 gst_pad_use_fixed_caps (dvdec->srcpad);
233 gst_element_add_pad (GST_ELEMENT (dvdec), dvdec->srcpad);
235 dvdec->framerate_numerator = 0;
236 dvdec->framerate_denominator = 0;
238 dvdec->drop_factor = 1;
240 dvdec->clamp_luma = FALSE;
241 dvdec->clamp_chroma = FALSE;
242 dvdec->quality = DV_DEFAULT_QUALITY;
243 dvdec->segment = gst_segment_new ();
247 gst_dvdec_finalize (GObject * object)
249 GstDVDec *dvdec = GST_DVDEC (object);
251 gst_segment_free (dvdec->segment);
253 G_OBJECT_CLASS (parent_class)->finalize (object);
257 gst_dvdec_sink_setcaps (GstPad * pad, GstCaps * caps)
261 const GValue *par = NULL, *rate = NULL;
263 dvdec = GST_DVDEC (gst_pad_get_parent (pad));
265 /* first parse the caps */
266 s = gst_caps_get_structure (caps, 0);
268 /* we allow framerate and PAR to be overwritten. framerate is mandatory. */
269 if (!(rate = gst_structure_get_value (s, "framerate")))
271 par = gst_structure_get_value (s, "pixel-aspect-ratio");
274 dvdec->par_x = gst_value_get_fraction_numerator (par);
275 dvdec->par_y = gst_value_get_fraction_denominator (par);
276 dvdec->need_par = FALSE;
280 dvdec->need_par = TRUE;
282 dvdec->framerate_numerator = gst_value_get_fraction_numerator (rate);
283 dvdec->framerate_denominator = gst_value_get_fraction_denominator (rate);
284 dvdec->sink_negotiated = TRUE;
285 dvdec->src_negotiated = FALSE;
287 gst_object_unref (dvdec);
294 GST_DEBUG_OBJECT (dvdec, "no framerate specified in caps");
295 gst_object_unref (dvdec);
301 gst_dvdec_src_negotiate (GstDVDec * dvdec)
305 /* no PAR was specified in input, derive from encoded data */
306 if (dvdec->need_par) {
309 dvdec->par_x = PAL_WIDE_PAR_X;
310 dvdec->par_y = PAL_WIDE_PAR_Y;
312 dvdec->par_x = PAL_NORMAL_PAR_X;
313 dvdec->par_y = PAL_NORMAL_PAR_Y;
317 dvdec->par_x = NTSC_WIDE_PAR_X;
318 dvdec->par_y = NTSC_WIDE_PAR_Y;
320 dvdec->par_x = NTSC_NORMAL_PAR_X;
321 dvdec->par_y = NTSC_NORMAL_PAR_Y;
324 GST_DEBUG_OBJECT (dvdec, "Inferred PAR %d/%d from video format",
325 dvdec->par_x, dvdec->par_y);
328 /* ignoring rgb, bgr0 for now */
331 othercaps = gst_caps_new_simple ("video/x-raw-yuv",
332 "format", GST_TYPE_FOURCC, GST_STR_FOURCC ("YUY2"),
333 "width", G_TYPE_INT, 720,
334 "height", G_TYPE_INT, dvdec->height,
335 "framerate", GST_TYPE_FRACTION, dvdec->framerate_numerator,
336 dvdec->framerate_denominator,
337 "pixel-aspect-ratio", GST_TYPE_FRACTION, dvdec->par_x,
340 gst_pad_set_caps (dvdec->srcpad, othercaps);
341 gst_caps_unref (othercaps);
343 dvdec->src_negotiated = TRUE;
349 gst_dvdec_sink_event (GstPad * pad, GstEvent * event)
354 dvdec = GST_DVDEC (gst_pad_get_parent (pad));
356 switch (GST_EVENT_TYPE (event)) {
357 case GST_EVENT_FLUSH_STOP:
358 gst_segment_init (dvdec->segment, GST_FORMAT_UNDEFINED);
360 case GST_EVENT_NEWSEGMENT:{
362 gdouble rate, applied_rate;
364 gint64 start, stop, position;
366 gst_event_parse_new_segment_full (event, &update, &rate, &applied_rate,
367 &format, &start, &stop, &position);
369 GST_DEBUG_OBJECT (dvdec, "Got NEWSEGMENT [%" GST_TIME_FORMAT
370 " - %" GST_TIME_FORMAT " / %" GST_TIME_FORMAT "]",
371 GST_TIME_ARGS (start), GST_TIME_ARGS (stop),
372 GST_TIME_ARGS (position));
374 gst_segment_set_newsegment_full (dvdec->segment, update, rate,
375 applied_rate, format, start, stop, position);
382 res = gst_pad_push_event (dvdec->srcpad, event);
388 gst_dvdec_chain (GstPad * pad, GstBuffer * buf)
393 guint8 *outframe_ptrs[3];
394 gint outframe_pitches[3];
396 GstFlowReturn ret = GST_FLOW_OK;
398 gint64 cstart, cstop;
401 dvdec = GST_DVDEC (gst_pad_get_parent (pad));
402 inframe = GST_BUFFER_DATA (buf);
404 /* buffer should be at least the size of one NTSC frame, this should
405 * be enough to decode the header. */
406 if (G_UNLIKELY (GST_BUFFER_SIZE (buf) < NTSC_BUFFER))
409 /* preliminary dropping. unref and return if outside of configured segment */
410 if ((dvdec->segment->format == GST_FORMAT_TIME) &&
411 (!(gst_segment_clip (dvdec->segment, GST_FORMAT_TIME,
412 GST_BUFFER_TIMESTAMP (buf),
413 GST_BUFFER_TIMESTAMP (buf) + GST_BUFFER_DURATION (buf),
417 if (G_UNLIKELY (dv_parse_header (dvdec->decoder, inframe) < 0))
418 goto parse_header_error;
421 PAL = dv_system_50_fields (dvdec->decoder);
422 wide = dv_format_wide (dvdec->decoder);
424 /* check the buffer is of right size after we know if we are
425 * dealing with PAL or NTSC */
426 length = (PAL ? PAL_BUFFER : NTSC_BUFFER);
427 if (G_UNLIKELY (GST_BUFFER_SIZE (buf) < length))
430 dv_parse_packs (dvdec->decoder, inframe);
432 if (dvdec->video_offset % dvdec->drop_factor != 0)
435 /* renegotiate on change */
436 if (PAL != dvdec->PAL || wide != dvdec->wide) {
437 dvdec->src_negotiated = FALSE;
442 dvdec->height = (dvdec->PAL ? PAL_HEIGHT : NTSC_HEIGHT);
445 /* negotiate if not done yet */
446 if (!dvdec->src_negotiated) {
447 if (!gst_dvdec_src_negotiate (dvdec))
452 gst_pad_alloc_buffer_and_set_caps (dvdec->srcpad, 0,
453 (720 * dvdec->height) * dvdec->bpp,
454 GST_PAD_CAPS (dvdec->srcpad), &outbuf);
455 if (G_UNLIKELY (ret != GST_FLOW_OK))
458 outframe = GST_BUFFER_DATA (outbuf);
460 outframe_ptrs[0] = outframe;
461 outframe_pitches[0] = 720 * dvdec->bpp;
463 /* the rest only matters for YUY2 */
464 if (dvdec->bpp < 3) {
465 outframe_ptrs[1] = outframe_ptrs[0] + 720 * dvdec->height;
466 outframe_ptrs[2] = outframe_ptrs[1] + 360 * dvdec->height;
468 outframe_pitches[1] = dvdec->height / 2;
469 outframe_pitches[2] = outframe_pitches[1];
472 GST_DEBUG_OBJECT (dvdec, "decoding and pushing buffer");
473 dv_decode_full_frame (dvdec->decoder, inframe,
474 e_dv_color_yuv, outframe_ptrs, outframe_pitches);
476 GST_BUFFER_OFFSET (outbuf) = GST_BUFFER_OFFSET (buf);
477 GST_BUFFER_OFFSET_END (outbuf) = GST_BUFFER_OFFSET_END (buf);
478 GST_BUFFER_TIMESTAMP (outbuf) = cstart;
479 GST_BUFFER_DURATION (outbuf) = cstop - cstart;
481 ret = gst_pad_push (dvdec->srcpad, outbuf);
484 dvdec->video_offset++;
487 gst_buffer_unref (buf);
488 gst_object_unref (dvdec);
495 GST_ELEMENT_ERROR (dvdec, STREAM, DECODE,
496 (NULL), ("Input buffer too small"));
497 ret = GST_FLOW_ERROR;
502 GST_ELEMENT_ERROR (dvdec, STREAM, DECODE,
503 (NULL), ("Error parsing DV header"));
504 ret = GST_FLOW_ERROR;
509 GST_DEBUG_OBJECT (dvdec, "could not negotiate output");
510 ret = GST_FLOW_NOT_NEGOTIATED;
515 GST_DEBUG_OBJECT (dvdec, "could not allocate buffer");
521 GST_DEBUG_OBJECT (dvdec,
522 "dropping buffer since it's out of the configured segment");
527 static GstStateChangeReturn
528 gst_dvdec_change_state (GstElement * element, GstStateChange transition)
530 GstDVDec *dvdec = GST_DVDEC (element);
531 GstStateChangeReturn ret;
534 switch (transition) {
535 case GST_STATE_CHANGE_NULL_TO_READY:
537 case GST_STATE_CHANGE_READY_TO_PAUSED:
539 dv_decoder_new (0, dvdec->clamp_luma, dvdec->clamp_chroma);
540 dvdec->decoder->quality = qualities[dvdec->quality];
541 dv_set_error_log (dvdec->decoder, NULL);
542 gst_segment_init (dvdec->segment, GST_FORMAT_UNDEFINED);
543 dvdec->src_negotiated = FALSE;
544 dvdec->sink_negotiated = FALSE;
546 * Enable this function call when libdv2 0.100 or higher is more
549 /* dv_set_quality (dvdec->decoder, qualities [dvdec->quality]); */
551 case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
557 ret = parent_class->change_state (element, transition);
559 switch (transition) {
560 case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
562 case GST_STATE_CHANGE_PAUSED_TO_READY:
563 dv_decoder_free (dvdec->decoder);
564 dvdec->decoder = NULL;
566 case GST_STATE_CHANGE_READY_TO_NULL:
575 gst_dvdec_set_property (GObject * object, guint prop_id, const GValue * value,
578 GstDVDec *dvdec = GST_DVDEC (object);
581 case PROP_CLAMP_LUMA:
582 dvdec->clamp_luma = g_value_get_boolean (value);
584 case PROP_CLAMP_CHROMA:
585 dvdec->clamp_chroma = g_value_get_boolean (value);
588 dvdec->quality = g_value_get_enum (value);
589 if ((dvdec->quality < 0) || (dvdec->quality > 5))
592 case PROP_DECODE_NTH:
593 dvdec->drop_factor = g_value_get_int (value);
596 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
602 gst_dvdec_get_property (GObject * object, guint prop_id, GValue * value,
605 GstDVDec *dvdec = GST_DVDEC (object);
608 case PROP_CLAMP_LUMA:
609 g_value_set_boolean (value, dvdec->clamp_luma);
611 case PROP_CLAMP_CHROMA:
612 g_value_set_boolean (value, dvdec->clamp_chroma);
615 g_value_set_enum (value, dvdec->quality);
617 case PROP_DECODE_NTH:
618 g_value_set_int (value, dvdec->drop_factor);
621 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);