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>
50 /* sizes of one input buffer */
51 #define NTSC_HEIGHT 480
52 #define NTSC_BUFFER 120000
53 #define NTSC_FRAMERATE_NUMERATOR 30000
54 #define NTSC_FRAMERATE_DENOMINATOR 1001
56 #define PAL_HEIGHT 576
57 #define PAL_BUFFER 144000
58 #define PAL_FRAMERATE_NUMERATOR 25
59 #define PAL_FRAMERATE_DENOMINATOR 1
61 #define PAL_NORMAL_PAR_X 59
62 #define PAL_NORMAL_PAR_Y 54
63 #define PAL_WIDE_PAR_X 118
64 #define PAL_WIDE_PAR_Y 81
66 #define NTSC_NORMAL_PAR_X 10
67 #define NTSC_NORMAL_PAR_Y 11
68 #define NTSC_WIDE_PAR_X 40
69 #define NTSC_WIDE_PAR_Y 33
71 #define DV_DEFAULT_QUALITY DV_QUALITY_BEST
72 #define DV_DEFAULT_DECODE_NTH 1
74 GST_DEBUG_CATEGORY_STATIC (dvdec_debug);
75 #define GST_CAT_DEFAULT dvdec_debug
86 const gint qualities[] = {
90 DV_QUALITY_DC | DV_QUALITY_COLOR,
91 DV_QUALITY_AC_1 | DV_QUALITY_COLOR,
92 DV_QUALITY_AC_2 | DV_QUALITY_COLOR
95 static GstStaticPadTemplate sink_temp = GST_STATIC_PAD_TEMPLATE ("sink",
98 GST_STATIC_CAPS ("video/x-dv, systemstream = (boolean) false")
101 static GstStaticPadTemplate src_temp = GST_STATIC_PAD_TEMPLATE ("src",
104 GST_STATIC_CAPS ("video/x-raw-yuv, "
105 "format = (fourcc) YUY2, "
106 "width = (int) 720, "
107 "framerate = (fraction) [ 1/1, 60/1 ];"
111 "endianness = (int) " G_STRINGIFY (G_BIG_ENDIAN) ", "
112 "red_mask = (int) 0x0000ff00, "
113 "green_mask = (int) 0x00ff0000, "
114 "blue_mask = (int) 0xff000000, "
115 "width = (int) 720, "
116 "framerate = (fraction) [ 1/1, 60/1 ];"
120 "endianness = (int) " G_STRINGIFY (G_BIG_ENDIAN) ", "
121 "red_mask = (int) 0x00ff0000, "
122 "green_mask = (int) 0x0000ff00, "
123 "blue_mask = (int) 0x000000ff, "
124 "width = (int) 720, " "framerate = (fraction) [ 1/1, 60/1 ]")
127 #define GST_TYPE_DVDEC_QUALITY (gst_dvdec_quality_get_type())
129 gst_dvdec_quality_get_type (void)
131 static GType qtype = 0;
134 static const GEnumValue values[] = {
135 {0, "Monochrome, DC (Fastest)", "fastest"},
136 {1, "Monochrome, first AC coefficient", "monochrome-ac"},
137 {2, "Monochrome, highest quality", "monochrome-best"},
138 {3, "Colour, DC, fastest", "colour-fastest"},
139 {4, "Colour, using only the first AC coefficient", "colour-ac"},
140 {5, "Highest quality colour decoding", "best"},
144 qtype = g_enum_register_static ("GstDVDecQualityEnum", values);
149 GST_BOILERPLATE (GstDVDec, gst_dvdec, GstElement, GST_TYPE_ELEMENT);
151 static void gst_dvdec_finalize (GObject * object);
152 static gboolean gst_dvdec_sink_setcaps (GstPad * pad, GstCaps * caps);
153 static GstFlowReturn gst_dvdec_chain (GstPad * pad, GstBuffer * buffer);
154 static gboolean gst_dvdec_sink_event (GstPad * pad, GstEvent * event);
156 static GstStateChangeReturn gst_dvdec_change_state (GstElement * element,
157 GstStateChange transition);
159 static void gst_dvdec_set_property (GObject * object, guint prop_id,
160 const GValue * value, GParamSpec * pspec);
161 static void gst_dvdec_get_property (GObject * object, guint prop_id,
162 GValue * value, GParamSpec * pspec);
165 gst_dvdec_base_init (gpointer g_class)
167 GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
169 gst_element_class_add_pad_template (element_class,
170 gst_static_pad_template_get (&sink_temp));
171 gst_element_class_add_pad_template (element_class,
172 gst_static_pad_template_get (&src_temp));
174 gst_element_class_set_details_simple (element_class, "DV video decoder",
175 "Codec/Decoder/Video",
176 "Uses libdv to decode DV video (smpte314) (libdv.sourceforge.net)",
177 "Erik Walthinsen <omega@cse.ogi.edu>," "Wim Taymans <wim@fluendo.com>");
179 GST_DEBUG_CATEGORY_INIT (dvdec_debug, "dvdec", 0, "DV decoding element");
183 gst_dvdec_class_init (GstDVDecClass * klass)
185 GObjectClass *gobject_class;
186 GstElementClass *gstelement_class;
188 gobject_class = (GObjectClass *) klass;
189 gstelement_class = (GstElementClass *) klass;
191 gobject_class->finalize = gst_dvdec_finalize;
192 gobject_class->set_property = gst_dvdec_set_property;
193 gobject_class->get_property = gst_dvdec_get_property;
195 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_CLAMP_LUMA,
196 g_param_spec_boolean ("clamp-luma", "Clamp luma", "Clamp luma",
197 FALSE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
198 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_CLAMP_CHROMA,
199 g_param_spec_boolean ("clamp-chroma", "Clamp chroma", "Clamp chroma",
200 FALSE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
201 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_QUALITY,
202 g_param_spec_enum ("quality", "Quality", "Decoding quality",
203 GST_TYPE_DVDEC_QUALITY, DV_DEFAULT_QUALITY,
204 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
205 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_DECODE_NTH,
206 g_param_spec_int ("drop-factor", "Drop Factor", "Only decode Nth frame",
207 1, G_MAXINT, DV_DEFAULT_DECODE_NTH,
208 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
210 gstelement_class->change_state = gst_dvdec_change_state;
214 gst_dvdec_init (GstDVDec * dvdec, GstDVDecClass * g_class)
216 dvdec->sinkpad = gst_pad_new_from_static_template (&sink_temp, "sink");
217 gst_pad_set_setcaps_function (dvdec->sinkpad,
218 GST_DEBUG_FUNCPTR (gst_dvdec_sink_setcaps));
219 gst_pad_set_chain_function (dvdec->sinkpad, gst_dvdec_chain);
220 gst_pad_set_event_function (dvdec->sinkpad, gst_dvdec_sink_event);
221 gst_element_add_pad (GST_ELEMENT (dvdec), dvdec->sinkpad);
223 dvdec->srcpad = gst_pad_new_from_static_template (&src_temp, "src");
224 gst_pad_use_fixed_caps (dvdec->srcpad);
225 gst_element_add_pad (GST_ELEMENT (dvdec), dvdec->srcpad);
227 dvdec->framerate_numerator = 0;
228 dvdec->framerate_denominator = 0;
230 dvdec->drop_factor = 1;
232 dvdec->clamp_luma = FALSE;
233 dvdec->clamp_chroma = FALSE;
234 dvdec->quality = DV_DEFAULT_QUALITY;
235 dvdec->segment = gst_segment_new ();
239 gst_dvdec_finalize (GObject * object)
241 GstDVDec *dvdec = GST_DVDEC (object);
243 gst_segment_free (dvdec->segment);
245 G_OBJECT_CLASS (parent_class)->finalize (object);
249 gst_dvdec_sink_setcaps (GstPad * pad, GstCaps * caps)
253 const GValue *par = NULL, *rate = NULL;
255 dvdec = GST_DVDEC (gst_pad_get_parent (pad));
257 /* first parse the caps */
258 s = gst_caps_get_structure (caps, 0);
260 /* we allow framerate and PAR to be overwritten. framerate is mandatory. */
261 if (!(rate = gst_structure_get_value (s, "framerate")))
263 par = gst_structure_get_value (s, "pixel-aspect-ratio");
266 dvdec->par_x = gst_value_get_fraction_numerator (par);
267 dvdec->par_y = gst_value_get_fraction_denominator (par);
268 dvdec->need_par = FALSE;
272 dvdec->need_par = TRUE;
274 dvdec->framerate_numerator = gst_value_get_fraction_numerator (rate);
275 dvdec->framerate_denominator = gst_value_get_fraction_denominator (rate);
276 dvdec->sink_negotiated = TRUE;
277 dvdec->src_negotiated = FALSE;
279 gst_object_unref (dvdec);
286 GST_DEBUG_OBJECT (dvdec, "no framerate specified in caps");
287 gst_object_unref (dvdec);
293 gst_dvdec_src_negotiate (GstDVDec * dvdec)
297 /* no PAR was specified in input, derive from encoded data */
298 if (dvdec->need_par) {
301 dvdec->par_x = PAL_WIDE_PAR_X;
302 dvdec->par_y = PAL_WIDE_PAR_Y;
304 dvdec->par_x = PAL_NORMAL_PAR_X;
305 dvdec->par_y = PAL_NORMAL_PAR_Y;
309 dvdec->par_x = NTSC_WIDE_PAR_X;
310 dvdec->par_y = NTSC_WIDE_PAR_Y;
312 dvdec->par_x = NTSC_NORMAL_PAR_X;
313 dvdec->par_y = NTSC_NORMAL_PAR_Y;
316 GST_DEBUG_OBJECT (dvdec, "Inferred PAR %d/%d from video format",
317 dvdec->par_x, dvdec->par_y);
320 /* ignoring rgb, bgr0 for now */
323 othercaps = gst_caps_new_simple ("video/x-raw-yuv",
324 "format", GST_TYPE_FOURCC, GST_STR_FOURCC ("YUY2"),
325 "width", G_TYPE_INT, 720,
326 "height", G_TYPE_INT, dvdec->height,
327 "framerate", GST_TYPE_FRACTION, dvdec->framerate_numerator,
328 dvdec->framerate_denominator,
329 "pixel-aspect-ratio", GST_TYPE_FRACTION, dvdec->par_x,
330 dvdec->par_y, "interlaced", G_TYPE_BOOLEAN, dvdec->interlaced, NULL);
332 gst_pad_set_caps (dvdec->srcpad, othercaps);
333 gst_caps_unref (othercaps);
335 dvdec->src_negotiated = TRUE;
341 gst_dvdec_sink_event (GstPad * pad, GstEvent * event)
346 dvdec = GST_DVDEC (gst_pad_get_parent (pad));
348 switch (GST_EVENT_TYPE (event)) {
349 case GST_EVENT_FLUSH_STOP:
350 gst_segment_init (dvdec->segment, GST_FORMAT_UNDEFINED);
352 case GST_EVENT_NEWSEGMENT:{
354 gdouble rate, applied_rate;
356 gint64 start, stop, position;
358 gst_event_parse_new_segment_full (event, &update, &rate, &applied_rate,
359 &format, &start, &stop, &position);
361 GST_DEBUG_OBJECT (dvdec, "Got NEWSEGMENT [%" GST_TIME_FORMAT
362 " - %" GST_TIME_FORMAT " / %" GST_TIME_FORMAT "]",
363 GST_TIME_ARGS (start), GST_TIME_ARGS (stop),
364 GST_TIME_ARGS (position));
366 gst_segment_set_newsegment_full (dvdec->segment, update, rate,
367 applied_rate, format, start, stop, position);
374 res = gst_pad_push_event (dvdec->srcpad, event);
380 gst_dvdec_chain (GstPad * pad, GstBuffer * buf)
385 guint8 *outframe_ptrs[3];
386 gint outframe_pitches[3];
388 GstFlowReturn ret = GST_FLOW_OK;
390 gint64 cstart, cstop;
393 dvdec = GST_DVDEC (gst_pad_get_parent (pad));
394 inframe = GST_BUFFER_DATA (buf);
396 /* buffer should be at least the size of one NTSC frame, this should
397 * be enough to decode the header. */
398 if (G_UNLIKELY (GST_BUFFER_SIZE (buf) < NTSC_BUFFER))
401 /* preliminary dropping. unref and return if outside of configured segment */
402 if ((dvdec->segment->format == GST_FORMAT_TIME) &&
403 (!(gst_segment_clip (dvdec->segment, GST_FORMAT_TIME,
404 GST_BUFFER_TIMESTAMP (buf),
405 GST_BUFFER_TIMESTAMP (buf) + GST_BUFFER_DURATION (buf),
409 if (G_UNLIKELY (dv_parse_header (dvdec->decoder, inframe) < 0))
410 goto parse_header_error;
413 PAL = dv_system_50_fields (dvdec->decoder);
414 wide = dv_format_wide (dvdec->decoder);
416 /* check the buffer is of right size after we know if we are
417 * dealing with PAL or NTSC */
418 length = (PAL ? PAL_BUFFER : NTSC_BUFFER);
419 if (G_UNLIKELY (GST_BUFFER_SIZE (buf) < length))
422 dv_parse_packs (dvdec->decoder, inframe);
424 if (dvdec->video_offset % dvdec->drop_factor != 0)
427 /* renegotiate on change */
428 if (PAL != dvdec->PAL || wide != dvdec->wide) {
429 dvdec->src_negotiated = FALSE;
434 dvdec->height = (dvdec->PAL ? PAL_HEIGHT : NTSC_HEIGHT);
436 dvdec->interlaced = !dv_is_progressive (dvdec->decoder);
438 /* negotiate if not done yet */
439 if (!dvdec->src_negotiated) {
440 if (!gst_dvdec_src_negotiate (dvdec))
445 gst_pad_alloc_buffer_and_set_caps (dvdec->srcpad, 0,
446 (720 * dvdec->height) * dvdec->bpp,
447 GST_PAD_CAPS (dvdec->srcpad), &outbuf);
448 if (G_UNLIKELY (ret != GST_FLOW_OK))
451 outframe = GST_BUFFER_DATA (outbuf);
453 outframe_ptrs[0] = outframe;
454 outframe_pitches[0] = 720 * dvdec->bpp;
456 /* the rest only matters for YUY2 */
457 if (dvdec->bpp < 3) {
458 outframe_ptrs[1] = outframe_ptrs[0] + 720 * dvdec->height;
459 outframe_ptrs[2] = outframe_ptrs[1] + 360 * dvdec->height;
461 outframe_pitches[1] = dvdec->height / 2;
462 outframe_pitches[2] = outframe_pitches[1];
465 GST_DEBUG_OBJECT (dvdec, "decoding and pushing buffer");
466 dv_decode_full_frame (dvdec->decoder, inframe,
467 e_dv_color_yuv, outframe_ptrs, outframe_pitches);
469 GST_BUFFER_FLAG_UNSET (outbuf, GST_VIDEO_BUFFER_TFF);
471 GST_BUFFER_OFFSET (outbuf) = GST_BUFFER_OFFSET (buf);
472 GST_BUFFER_OFFSET_END (outbuf) = GST_BUFFER_OFFSET_END (buf);
473 GST_BUFFER_TIMESTAMP (outbuf) = cstart;
474 GST_BUFFER_DURATION (outbuf) = cstop - cstart;
476 ret = gst_pad_push (dvdec->srcpad, outbuf);
479 dvdec->video_offset++;
482 gst_buffer_unref (buf);
483 gst_object_unref (dvdec);
490 GST_ELEMENT_ERROR (dvdec, STREAM, DECODE,
491 (NULL), ("Input buffer too small"));
492 ret = GST_FLOW_ERROR;
497 GST_ELEMENT_ERROR (dvdec, STREAM, DECODE,
498 (NULL), ("Error parsing DV header"));
499 ret = GST_FLOW_ERROR;
504 GST_DEBUG_OBJECT (dvdec, "could not negotiate output");
505 ret = GST_FLOW_NOT_NEGOTIATED;
510 GST_DEBUG_OBJECT (dvdec, "could not allocate buffer");
516 GST_DEBUG_OBJECT (dvdec,
517 "dropping buffer since it's out of the configured segment");
522 static GstStateChangeReturn
523 gst_dvdec_change_state (GstElement * element, GstStateChange transition)
525 GstDVDec *dvdec = GST_DVDEC (element);
526 GstStateChangeReturn ret;
529 switch (transition) {
530 case GST_STATE_CHANGE_NULL_TO_READY:
532 case GST_STATE_CHANGE_READY_TO_PAUSED:
534 dv_decoder_new (0, dvdec->clamp_luma, dvdec->clamp_chroma);
535 dvdec->decoder->quality = qualities[dvdec->quality];
536 dv_set_error_log (dvdec->decoder, NULL);
537 gst_segment_init (dvdec->segment, GST_FORMAT_UNDEFINED);
538 dvdec->src_negotiated = FALSE;
539 dvdec->sink_negotiated = FALSE;
541 * Enable this function call when libdv2 0.100 or higher is more
544 /* dv_set_quality (dvdec->decoder, qualities [dvdec->quality]); */
546 case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
552 ret = parent_class->change_state (element, transition);
554 switch (transition) {
555 case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
557 case GST_STATE_CHANGE_PAUSED_TO_READY:
558 dv_decoder_free (dvdec->decoder);
559 dvdec->decoder = NULL;
561 case GST_STATE_CHANGE_READY_TO_NULL:
570 gst_dvdec_set_property (GObject * object, guint prop_id, const GValue * value,
573 GstDVDec *dvdec = GST_DVDEC (object);
576 case PROP_CLAMP_LUMA:
577 dvdec->clamp_luma = g_value_get_boolean (value);
579 case PROP_CLAMP_CHROMA:
580 dvdec->clamp_chroma = g_value_get_boolean (value);
583 dvdec->quality = g_value_get_enum (value);
584 if ((dvdec->quality < 0) || (dvdec->quality > 5))
587 case PROP_DECODE_NTH:
588 dvdec->drop_factor = g_value_get_int (value);
591 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
597 gst_dvdec_get_property (GObject * object, guint prop_id, GValue * value,
600 GstDVDec *dvdec = GST_DVDEC (object);
603 case PROP_CLAMP_LUMA:
604 g_value_set_boolean (value, dvdec->clamp_luma);
606 case PROP_CLAMP_CHROMA:
607 g_value_set_boolean (value, dvdec->clamp_chroma);
610 g_value_set_enum (value, dvdec->quality);
612 case PROP_DECODE_NTH:
613 g_value_set_int (value, dvdec->drop_factor);
616 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);