ext/dv/gstdvdec.c

   1 /* GStreamer
   2  * Copyright (C) <1999> Erik Walthinsen <omega@cse.ogi.edu>
   3  *               <2005> Wim Taymans <wim@fluendo.com>
   4  *
   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.
   9  *
  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.
  14  *
  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.
  19  */
  20
  21 /**
  22  * SECTION:element-dvdec
  23  *
  24  * <refsect2>
  25  * <para>
  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.
  28  * </para>
  29  * <para>
  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
  32  * Nth frame.
  33  * </para>
  34  * <title>Example launch line</title>
  35  * <para>
  36  * <programlisting>
  37  * gst-launch filesrc location=test.dv ! dvdemux name=demux ! dvdec ! xvimagesink
  38  * </programlisting>
  39  * This pipeline decodes and renders the raw DV stream to a videosink.
  40  * </para>
  41  * Last reviewed on 2006-02-28 (0.10.3)
  42  * </refsect2>
  43  */
  44
  45 #ifdef HAVE_CONFIG_H
  46 #include "config.h"
  47 #endif
  48 #include <string.h>
  49 #include <math.h>
  50
  51 #include "gstdvdec.h"
  52
  53
  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>");
  59
  60 /* sizes of one input buffer */
  61 #define NTSC_BUFFER 120000
  62 #define PAL_BUFFER 144000
  63
  64 #define DV_DEFAULT_QUALITY DV_QUALITY_BEST
  65 #define DV_DEFAULT_DECODE_NTH 1
  66
  67 GST_DEBUG_CATEGORY_STATIC (dvdec_debug);
  68 #define GST_CAT_DEFAULT dvdec_debug
  69
  70 enum
  71 {
  72   PROP_0,
  73   PROP_CLAMP_LUMA,
  74   PROP_CLAMP_CHROMA,
  75   PROP_QUALITY,
  76   PROP_DECODE_NTH
  77 };
  78
  79 const gint qualities[] = {
  80   DV_QUALITY_DC,
  81   DV_QUALITY_AC_1,
  82   DV_QUALITY_AC_2,
  83   DV_QUALITY_DC | DV_QUALITY_COLOR,
  84   DV_QUALITY_AC_1 | DV_QUALITY_COLOR,
  85   DV_QUALITY_AC_2 | DV_QUALITY_COLOR
  86 };
  87
  88 static GstStaticPadTemplate sink_temp = GST_STATIC_PAD_TEMPLATE ("sink",
  89     GST_PAD_SINK,
  90     GST_PAD_ALWAYS,
  91     GST_STATIC_CAPS ("video/x-dv, systemstream = (boolean) false")
  92     );
  93
  94 static GstStaticPadTemplate src_temp = GST_STATIC_PAD_TEMPLATE ("src",
  95     GST_PAD_SRC,
  96     GST_PAD_ALWAYS,
  97     GST_STATIC_CAPS ("video/x-raw-yuv, "
  98         "format = (fourcc) YUY2, "
  99         "width = (int) 720, "
 100         "framerate = (fraction) [ 1/1, 60/1 ];"
 101         "video/x-raw-rgb, "
 102         "bpp = (int) 32, "
 103         "depth = (int) 24, "
 104         "endianness = (int) " G_STRINGIFY (G_BIG_ENDIAN) ", "
 105         "red_mask =   (int) 0x0000ff00, "
 106         "green_mask = (int) 0x00ff0000, "
 107         "blue_mask =  (int) 0xff000000, "
 108         "width = (int) 720, "
 109         "framerate = (fraction) [ 1/1, 60/1 ];"
 110         "video/x-raw-rgb, "
 111         "bpp = (int) 24, "
 112         "depth = (int) 24, "
 113         "endianness = (int) " G_STRINGIFY (G_BIG_ENDIAN) ", "
 114         "red_mask =   (int) 0x00ff0000, "
 115         "green_mask = (int) 0x0000ff00, "
 116         "blue_mask =  (int) 0x000000ff, "
 117         "width = (int) 720, " "framerate = (fraction) [ 1/1, 60/1 ]")
 118     );
 119
 120 #define GST_TYPE_DVDEC_QUALITY (gst_dvdec_quality_get_type())
 121 GType
 122 gst_dvdec_quality_get_type (void)
 123 {
 124   static GType qtype = 0;
 125
 126   if (qtype == 0) {
 127     static const GEnumValue values[] = {
 128       {0, "Monochrome, DC (Fastest)", "fastest"},
 129       {1, "Monochrome, first AC coefficient", "monochrome-ac"},
 130       {2, "Monochrome, highest quality", "monochrome-best"},
 131       {3, "Colour, DC, fastest", "colour-fastest"},
 132       {4, "Colour, using only the first AC coefficient", "colour-ac"},
 133       {5, "Highest quality colour decoding", "best"},
 134       {0, NULL, NULL},
 135     };
 136
 137     qtype = g_enum_register_static ("GstDVDecQualityEnum", values);
 138   }
 139   return qtype;
 140 }
 141
 142 GST_BOILERPLATE (GstDVDec, gst_dvdec, GstElement, GST_TYPE_ELEMENT);
 143
 144 static void gst_dvdec_finalize (GObject * object);
 145 static gboolean gst_dvdec_sink_setcaps (GstPad * pad, GstCaps * caps);
 146 static GstFlowReturn gst_dvdec_chain (GstPad * pad, GstBuffer * buffer);
 147 static gboolean gst_dvdec_sink_event (GstPad * pad, GstEvent * event);
 148
 149 static GstStateChangeReturn gst_dvdec_change_state (GstElement * element,
 150     GstStateChange transition);
 151
 152 static void gst_dvdec_set_property (GObject * object, guint prop_id,
 153     const GValue * value, GParamSpec * pspec);
 154 static void gst_dvdec_get_property (GObject * object, guint prop_id,
 155     GValue * value, GParamSpec * pspec);
 156
 157 static void
 158 gst_dvdec_base_init (gpointer g_class)
 159 {
 160   GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
 161
 162   gst_element_class_add_pad_template (element_class,
 163       gst_static_pad_template_get (&sink_temp));
 164   gst_element_class_add_pad_template (element_class,
 165       gst_static_pad_template_get (&src_temp));
 166
 167   gst_element_class_set_details (element_class, &dvdec_details);
 168
 169   GST_DEBUG_CATEGORY_INIT (dvdec_debug, "dvdec", 0, "DV decoding element");
 170 }
 171
 172 static void
 173 gst_dvdec_class_init (GstDVDecClass * klass)
 174 {
 175   GObjectClass *gobject_class;
 176   GstElementClass *gstelement_class;
 177
 178   gobject_class = (GObjectClass *) klass;
 179   gstelement_class = (GstElementClass *) klass;
 180
 181   gobject_class->finalize = gst_dvdec_finalize;
 182   gobject_class->set_property = gst_dvdec_set_property;
 183   gobject_class->get_property = gst_dvdec_get_property;
 184
 185   g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_CLAMP_LUMA,
 186       g_param_spec_boolean ("clamp_luma", "Clamp luma", "Clamp luma",
 187           FALSE, G_PARAM_READWRITE));
 188   g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_CLAMP_CHROMA,
 189       g_param_spec_boolean ("clamp_chroma", "Clamp chroma", "Clamp chroma",
 190           FALSE, G_PARAM_READWRITE));
 191   g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_QUALITY,
 192       g_param_spec_enum ("quality", "Quality", "Decoding quality",
 193           GST_TYPE_DVDEC_QUALITY, DV_DEFAULT_QUALITY, G_PARAM_READWRITE));
 194   g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_DECODE_NTH,
 195       g_param_spec_int ("drop-factor", "Drop Factor", "Only decode Nth frame",
 196           1, G_MAXINT, DV_DEFAULT_DECODE_NTH, G_PARAM_READWRITE));
 197
 198   gstelement_class->change_state = gst_dvdec_change_state;
 199
 200   /* table initialization, only do once */
 201   dv_init (0, 0);
 202 }
 203
 204 static void
 205 gst_dvdec_init (GstDVDec * dvdec, GstDVDecClass * g_class)
 206 {
 207   dvdec->sinkpad =
 208       gst_pad_new_from_template (gst_static_pad_template_get (&sink_temp),
 209       "sink");
 210   gst_pad_set_setcaps_function (dvdec->sinkpad,
 211       GST_DEBUG_FUNCPTR (gst_dvdec_sink_setcaps));
 212   gst_pad_set_chain_function (dvdec->sinkpad, gst_dvdec_chain);
 213   gst_pad_set_event_function (dvdec->sinkpad, gst_dvdec_sink_event);
 214   gst_element_add_pad (GST_ELEMENT (dvdec), dvdec->sinkpad);
 215
 216   dvdec->srcpad =
 217       gst_pad_new_from_template (gst_static_pad_template_get (&src_temp),
 218       "src");
 219
 220   gst_pad_use_fixed_caps (dvdec->srcpad);
 221
 222   gst_element_add_pad (GST_ELEMENT (dvdec), dvdec->srcpad);
 223
 224   dvdec->framerate_numerator = 0;
 225   dvdec->framerate_denominator = 0;
 226   dvdec->height = 0;
 227   dvdec->wide = FALSE;
 228   dvdec->drop_factor = 1;
 229
 230   dvdec->clamp_luma = FALSE;
 231   dvdec->clamp_chroma = FALSE;
 232   dvdec->quality = DV_DEFAULT_QUALITY;
 233   dvdec->segment = gst_segment_new ();
 234 }
 235
 236 static void
 237 gst_dvdec_finalize (GObject * object)
 238 {
 239   GstDVDec *dvdec = GST_DVDEC (object);
 240
 241   gst_segment_free (dvdec->segment);
 242
 243   G_OBJECT_CLASS (parent_class)->finalize (object);
 244 }
 245
 246 static gboolean
 247 gst_dvdec_sink_setcaps (GstPad * pad, GstCaps * caps)
 248 {
 249   GstDVDec *dvdec;
 250   GstStructure *s;
 251   GstCaps *othercaps;
 252   gboolean gotpar = FALSE;
 253   const GValue *par = NULL, *rate = NULL;
 254
 255   dvdec = GST_DVDEC (gst_pad_get_parent (pad));
 256
 257   /* first parse the caps */
 258   s = gst_caps_get_structure (caps, 0);
 259
 260   if (!gst_structure_get_int (s, "height", &dvdec->height))
 261     goto error;
 262   if ((par = gst_structure_get_value (s, "pixel-aspect-ratio")))
 263     gotpar = TRUE;
 264   if (!(rate = gst_structure_get_value (s, "framerate")))
 265     goto error;
 266
 267   dvdec->framerate_numerator = gst_value_get_fraction_numerator (rate);
 268   dvdec->framerate_denominator = gst_value_get_fraction_denominator (rate);
 269
 270   /* ignoring rgb, bgr0 for now */
 271
 272   dvdec->bpp = 2;
 273
 274   othercaps = gst_caps_new_simple ("video/x-raw-yuv",
 275       "format", GST_TYPE_FOURCC, GST_STR_FOURCC ("YUY2"),
 276       "width", G_TYPE_INT, 720,
 277       "height", G_TYPE_INT, dvdec->height,
 278       "framerate", GST_TYPE_FRACTION, dvdec->framerate_numerator,
 279       dvdec->framerate_denominator, NULL);
 280   if (gotpar)
 281     gst_structure_set_value (gst_caps_get_structure (othercaps, 0),
 282         "pixel-aspect-ratio", par);
 283
 284   gst_pad_set_caps (dvdec->srcpad, othercaps);
 285
 286   gst_caps_unref (othercaps);
 287
 288   gst_object_unref (dvdec);
 289
 290   return TRUE;
 291
 292 error:
 293   {
 294     gst_object_unref (dvdec);
 295
 296     return FALSE;
 297   }
 298 }
 299
 300 static gboolean
 301 gst_dvdec_sink_event (GstPad * pad, GstEvent * event)
 302 {
 303   GstDVDec *dvdec;
 304   gboolean res = TRUE;
 305
 306   dvdec = GST_DVDEC (gst_pad_get_parent (pad));
 307
 308   switch (GST_EVENT_TYPE (event)) {
 309     case GST_EVENT_FLUSH_STOP:
 310       gst_segment_init (dvdec->segment, GST_FORMAT_UNDEFINED);
 311       break;
 312     case GST_EVENT_NEWSEGMENT:{
 313       gboolean update;
 314       gdouble rate, applied_rate;
 315       GstFormat format;
 316       gint64 start, stop, position;
 317
 318       gst_event_parse_new_segment_full (event, &update, &rate, &applied_rate,
 319           &format, &start, &stop, &position);
 320
 321       GST_DEBUG_OBJECT (dvdec, "Got NEWSEGMENT [%" GST_TIME_FORMAT
 322           " - %" GST_TIME_FORMAT " / %" GST_TIME_FORMAT "]",
 323           GST_TIME_ARGS (start), GST_TIME_ARGS (stop),
 324           GST_TIME_ARGS (position));
 325
 326       gst_segment_set_newsegment_full (dvdec->segment, update, rate,
 327           applied_rate, format, start, stop, position);
 328       break;
 329     }
 330     default:
 331       break;
 332   }
 333
 334   res = gst_pad_push_event (dvdec->srcpad, event);
 335
 336   return res;
 337 }
 338
 339 static GstFlowReturn
 340 gst_dvdec_chain (GstPad * pad, GstBuffer * buf)
 341 {
 342   GstDVDec *dvdec;
 343   guint8 *inframe;
 344   guint8 *outframe;
 345   guint8 *outframe_ptrs[3];
 346   gint outframe_pitches[3];
 347   GstBuffer *outbuf;
 348   GstFlowReturn ret = GST_FLOW_OK;
 349   guint length;
 350   gint64 cstart, cstop;
 351
 352   dvdec = GST_DVDEC (gst_pad_get_parent (pad));
 353   inframe = GST_BUFFER_DATA (buf);
 354
 355   /* buffer should be at least the size of one NTSC frame, this should
 356    * be enough to decode the header. */
 357   if (G_UNLIKELY (GST_BUFFER_SIZE (buf) < NTSC_BUFFER))
 358     goto wrong_size;
 359
 360   /* preliminary dropping. unref and return if outside of configured segment */
 361   if ((dvdec->segment->format == GST_FORMAT_TIME) &&
 362       (!(gst_segment_clip (dvdec->segment, GST_FORMAT_TIME,
 363                   GST_BUFFER_TIMESTAMP (buf),
 364                   GST_BUFFER_TIMESTAMP (buf) + GST_BUFFER_DURATION (buf),
 365                   &cstart, &cstop))))
 366     goto dropping;
 367
 368   if (G_UNLIKELY (dv_parse_header (dvdec->decoder, inframe) < 0))
 369     goto parse_header_error;
 370
 371   /* check the buffer is of right size after we know if we are
 372    * dealing with PAL or NTSC */
 373   length = (dvdec->PAL ? PAL_BUFFER : NTSC_BUFFER);
 374   if (G_UNLIKELY (GST_BUFFER_SIZE (buf) < length))
 375     goto wrong_size;
 376
 377   dv_parse_packs (dvdec->decoder, inframe);
 378
 379   if (dvdec->video_offset % dvdec->drop_factor != 0)
 380     goto skip;
 381
 382   ret =
 383       gst_pad_alloc_buffer_and_set_caps (dvdec->srcpad, 0,
 384       (720 * dvdec->height) * dvdec->bpp,
 385       GST_PAD_CAPS (dvdec->srcpad), &outbuf);
 386   if (G_UNLIKELY (ret != GST_FLOW_OK))
 387     goto no_buffer;
 388
 389   outframe = GST_BUFFER_DATA (outbuf);
 390
 391   outframe_ptrs[0] = outframe;
 392   outframe_pitches[0] = 720 * dvdec->bpp;
 393
 394   /* the rest only matters for YUY2 */
 395   if (dvdec->bpp < 3) {
 396     outframe_ptrs[1] = outframe_ptrs[0] + 720 * dvdec->height;
 397     outframe_ptrs[2] = outframe_ptrs[1] + 360 * dvdec->height;
 398
 399     outframe_pitches[1] = dvdec->height / 2;
 400     outframe_pitches[2] = outframe_pitches[1];
 401   }
 402
 403   GST_DEBUG_OBJECT (dvdec, "decoding and pushing buffer");
 404   dv_decode_full_frame (dvdec->decoder, inframe,
 405       e_dv_color_yuv, outframe_ptrs, outframe_pitches);
 406
 407   GST_BUFFER_OFFSET (outbuf) = GST_BUFFER_OFFSET (buf);
 408   GST_BUFFER_OFFSET_END (outbuf) = GST_BUFFER_OFFSET_END (buf);
 409   GST_BUFFER_TIMESTAMP (outbuf) = cstart;
 410   GST_BUFFER_DURATION (outbuf) = cstop - cstart;
 411
 412   ret = gst_pad_push (dvdec->srcpad, outbuf);
 413
 414 skip:
 415   dvdec->video_offset++;
 416
 417 done:
 418   gst_buffer_unref (buf);
 419   gst_object_unref (dvdec);
 420
 421   return ret;
 422
 423   /* ERRORS */
 424 wrong_size:
 425   {
 426     GST_ELEMENT_ERROR (dvdec, STREAM, DECODE,
 427         (NULL), ("Input buffer too small"));
 428     ret = GST_FLOW_ERROR;
 429     goto done;
 430   }
 431 parse_header_error:
 432   {
 433     GST_ELEMENT_ERROR (dvdec, STREAM, DECODE,
 434         (NULL), ("Error parsing DV header"));
 435     ret = GST_FLOW_ERROR;
 436     goto done;
 437   }
 438 no_buffer:
 439   {
 440     GST_DEBUG_OBJECT (dvdec, "could not allocate buffer");
 441     goto done;
 442   }
 443
 444 dropping:
 445   {
 446     GST_DEBUG_OBJECT (dvdec,
 447         "dropping buffer since it's out of the configured segment");
 448     goto done;
 449   }
 450 }
 451
 452 static GstStateChangeReturn
 453 gst_dvdec_change_state (GstElement * element, GstStateChange transition)
 454 {
 455   GstDVDec *dvdec = GST_DVDEC (element);
 456   GstStateChangeReturn ret;
 457
 458
 459   switch (transition) {
 460     case GST_STATE_CHANGE_NULL_TO_READY:
 461       break;
 462     case GST_STATE_CHANGE_READY_TO_PAUSED:
 463       dvdec->decoder =
 464           dv_decoder_new (0, dvdec->clamp_luma, dvdec->clamp_chroma);
 465       dvdec->decoder->quality = qualities[dvdec->quality];
 466       dv_set_error_log (dvdec->decoder, NULL);
 467       gst_segment_init (dvdec->segment, GST_FORMAT_UNDEFINED);
 468       /*
 469        * Enable this function call when libdv2 0.100 or higher is more
 470        * common
 471        */
 472       /* dv_set_quality (dvdec->decoder, qualities [dvdec->quality]); */
 473       break;
 474     case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
 475       break;
 476     default:
 477       break;
 478   }
 479
 480   ret = parent_class->change_state (element, transition);
 481
 482   switch (transition) {
 483     case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
 484       break;
 485     case GST_STATE_CHANGE_PAUSED_TO_READY:
 486       dv_decoder_free (dvdec->decoder);
 487       dvdec->decoder = NULL;
 488       break;
 489     case GST_STATE_CHANGE_READY_TO_NULL:
 490       break;
 491     default:
 492       break;
 493   }
 494   return ret;
 495 }
 496
 497 static void
 498 gst_dvdec_set_property (GObject * object, guint prop_id, const GValue * value,
 499     GParamSpec * pspec)
 500 {
 501   GstDVDec *dvdec = GST_DVDEC (object);
 502
 503   switch (prop_id) {
 504     case PROP_CLAMP_LUMA:
 505       dvdec->clamp_luma = g_value_get_boolean (value);
 506       break;
 507     case PROP_CLAMP_CHROMA:
 508       dvdec->clamp_chroma = g_value_get_boolean (value);
 509       break;
 510     case PROP_QUALITY:
 511       dvdec->quality = g_value_get_enum (value);
 512       if ((dvdec->quality < 0) || (dvdec->quality > 5))
 513         dvdec->quality = 0;
 514       break;
 515     case PROP_DECODE_NTH:
 516       dvdec->drop_factor = g_value_get_int (value);
 517       break;
 518     default:
 519       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 520       break;
 521   }
 522 }
 523
 524 static void
 525 gst_dvdec_get_property (GObject * object, guint prop_id, GValue * value,
 526     GParamSpec * pspec)
 527 {
 528   GstDVDec *dvdec = GST_DVDEC (object);
 529
 530   switch (prop_id) {
 531     case PROP_CLAMP_LUMA:
 532       g_value_set_boolean (value, dvdec->clamp_luma);
 533       break;
 534     case PROP_CLAMP_CHROMA:
 535       g_value_set_boolean (value, dvdec->clamp_chroma);
 536       break;
 537     case PROP_QUALITY:
 538       g_value_set_enum (value, dvdec->quality);
 539       break;
 540     case PROP_DECODE_NTH:
 541       g_value_set_int (value, dvdec->drop_factor);
 542       break;
 543     default:
 544       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 545       break;
 546   }
 547 }