gst/ffmpegcolorspace/gstffmpegcolorspace.c

   1 /* GStreamer
   2  * Copyright (C) <1999> Erik Walthinsen <omega@cse.ogi.edu>
   3  * This file:
   4  * Copyright (C) 2003 Ronald Bultje <rbultje@ronald.bitfreak.net>
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Library General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Library General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Library General Public
  17  * License along with this library; if not, write to the
  18  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  19  * Boston, MA 02111-1307, USA.
  20  */
  21
  22 /**
  23  * SECTION:element-ffmpegcolorspace
  24  *
  25  * Convert video frames between a great variety of colorspace formats.
  26  *
  27  * <refsect2>
  28  * <title>Example launch line</title>
  29  * |[
  30  * gst-launch -v videotestsrc ! video/x-raw-yuv,format=\(fourcc\)YUY2 ! ffmpegcolorspace ! ximagesink
  31  * ]|
  32  * </refsect2>
  33  */
  34
  35 #ifdef HAVE_CONFIG_H
  36 #  include "config.h"
  37 #endif
  38
  39 #include "gstffmpegcolorspace.h"
  40 #include "gstffmpegcodecmap.h"
  41
  42 GST_DEBUG_CATEGORY_STATIC (ffmpegcolorspace_debug);
  43 #define GST_CAT_DEFAULT ffmpegcolorspace_debug
  44
  45 /* elementfactory information */
  46 static const GstElementDetails ffmpegcsp_details =
  47 GST_ELEMENT_DETAILS ("FFMPEG Colorspace converter",
  48     "Filter/Converter/Video",
  49     "Converts video from one colorspace to another",
  50     "Ronald Bultje <rbultje@ronald.bitfreak.net>");
  51
  52
  53 /* Stereo signals and args */
  54 enum
  55 {
  56   /* FILL ME */
  57   LAST_SIGNAL
  58 };
  59
  60 enum
  61 {
  62   ARG_0,
  63 };
  64
  65 static GType gst_ffmpegcsp_get_type (void);
  66
  67 static void gst_ffmpegcsp_base_init (GstFFMpegCspClass * klass);
  68 static void gst_ffmpegcsp_class_init (GstFFMpegCspClass * klass);
  69 static void gst_ffmpegcsp_init (GstFFMpegCsp * space);
  70
  71 static gboolean gst_ffmpegcsp_set_caps (GstBaseTransform * btrans,
  72     GstCaps * incaps, GstCaps * outcaps);
  73 static gboolean gst_ffmpegcsp_get_unit_size (GstBaseTransform * btrans,
  74     GstCaps * caps, guint * size);
  75 static GstFlowReturn gst_ffmpegcsp_transform (GstBaseTransform * btrans,
  76     GstBuffer * inbuf, GstBuffer * outbuf);
  77 #if 0
  78 static GstFlowReturn gst_ffmpegcsp_transform_ip (GstBaseTransform * btrans,
  79     GstBuffer * inbuf);
  80 #endif
  81
  82 static GstPadTemplate *sinktempl, *srctempl;
  83 static GstElementClass *parent_class = NULL;
  84
  85 /*static guint gst_ffmpegcsp_signals[LAST_SIGNAL] = { 0 }; */
  86
  87 /* copies the given caps */
  88 static GstCaps *
  89 gst_ffmpegcsp_caps_remove_format_info (GstCaps * caps)
  90 {
  91   int i;
  92   GstStructure *structure;
  93   GstCaps *rgbcaps;
  94   GstCaps *graycaps;
  95
  96   caps = gst_caps_copy (caps);
  97
  98   for (i = 0; i < gst_caps_get_size (caps); i++) {
  99     structure = gst_caps_get_structure (caps, i);
 100
 101     gst_structure_set_name (structure, "video/x-raw-yuv");
 102     gst_structure_remove_field (structure, "format");
 103     gst_structure_remove_field (structure, "endianness");
 104     gst_structure_remove_field (structure, "depth");
 105     gst_structure_remove_field (structure, "bpp");
 106     gst_structure_remove_field (structure, "red_mask");
 107     gst_structure_remove_field (structure, "green_mask");
 108     gst_structure_remove_field (structure, "blue_mask");
 109     gst_structure_remove_field (structure, "alpha_mask");
 110     gst_structure_remove_field (structure, "palette_data");
 111   }
 112
 113   gst_caps_do_simplify (caps);
 114   rgbcaps = gst_caps_copy (caps);
 115
 116   for (i = 0; i < gst_caps_get_size (rgbcaps); i++) {
 117     structure = gst_caps_get_structure (rgbcaps, i);
 118
 119     gst_structure_set_name (structure, "video/x-raw-rgb");
 120   }
 121   graycaps = gst_caps_copy (caps);
 122
 123   for (i = 0; i < gst_caps_get_size (graycaps); i++) {
 124     structure = gst_caps_get_structure (graycaps, i);
 125
 126     gst_structure_set_name (structure, "video/x-raw-gray");
 127   }
 128
 129   gst_caps_append (caps, graycaps);
 130   gst_caps_append (caps, rgbcaps);
 131
 132   return caps;
 133 }
 134
 135 /* The caps can be transformed into any other caps with format info removed.
 136  * However, we should prefer passthrough, so if passthrough is possible,
 137  * put it first in the list. */
 138 static GstCaps *
 139 gst_ffmpegcsp_transform_caps (GstBaseTransform * btrans,
 140     GstPadDirection direction, GstCaps * caps)
 141 {
 142   GstCaps *template;
 143   GstCaps *result;
 144
 145   template = gst_ffmpegcsp_codectype_to_caps (CODEC_TYPE_VIDEO, NULL);
 146   result = gst_caps_intersect (caps, template);
 147   gst_caps_unref (template);
 148
 149   gst_caps_append (result, gst_ffmpegcsp_caps_remove_format_info (caps));
 150
 151   GST_DEBUG_OBJECT (btrans, "transformed %" GST_PTR_FORMAT " into %"
 152       GST_PTR_FORMAT, caps, result);
 153
 154   return result;
 155 }
 156
 157 static gboolean
 158 gst_ffmpegcsp_set_caps (GstBaseTransform * btrans, GstCaps * incaps,
 159     GstCaps * outcaps)
 160 {
 161   GstFFMpegCsp *space;
 162   GstStructure *structure;
 163   gint in_height, in_width;
 164   gint out_height, out_width;
 165   const GValue *in_framerate = NULL;
 166   const GValue *out_framerate = NULL;
 167   const GValue *in_par = NULL;
 168   const GValue *out_par = NULL;
 169   AVCodecContext *ctx;
 170   gboolean res;
 171
 172   space = GST_FFMPEGCSP (btrans);
 173
 174   /* parse in and output values */
 175   structure = gst_caps_get_structure (incaps, 0);
 176
 177   /* we have to have width and height */
 178   res = gst_structure_get_int (structure, "width", &in_width);
 179   res &= gst_structure_get_int (structure, "height", &in_height);
 180   if (!res)
 181     goto no_width_height;
 182
 183   /* and framerate */
 184   in_framerate = gst_structure_get_value (structure, "framerate");
 185   if (in_framerate == NULL || !GST_VALUE_HOLDS_FRACTION (in_framerate))
 186     goto no_framerate;
 187
 188   /* this is optional */
 189   in_par = gst_structure_get_value (structure, "pixel-aspect-ratio");
 190
 191   structure = gst_caps_get_structure (outcaps, 0);
 192
 193   /* we have to have width and height */
 194   res = gst_structure_get_int (structure, "width", &out_width);
 195   res &= gst_structure_get_int (structure, "height", &out_height);
 196   if (!res)
 197     goto no_width_height;
 198
 199   /* and framerate */
 200   out_framerate = gst_structure_get_value (structure, "framerate");
 201   if (out_framerate == NULL || !GST_VALUE_HOLDS_FRACTION (out_framerate))
 202     goto no_framerate;
 203
 204   /* this is optional */
 205   out_par = gst_structure_get_value (structure, "pixel-aspect-ratio");
 206
 207   /* these must match */
 208   if (in_width != out_width || in_height != out_height ||
 209       gst_value_compare (in_framerate, out_framerate) != GST_VALUE_EQUAL)
 210     goto format_mismatch;
 211
 212   /* if present, these must match too */
 213   if (in_par && out_par
 214       && gst_value_compare (in_par, out_par) != GST_VALUE_EQUAL)
 215     goto format_mismatch;
 216
 217   ctx = avcodec_alloc_context ();
 218
 219   space->width = ctx->width = in_width;
 220   space->height = ctx->height = in_height;
 221
 222   space->interlaced = FALSE;
 223   gst_structure_get_boolean (structure, "interlaced", &space->interlaced);
 224
 225   /* get from format */
 226   ctx->pix_fmt = PIX_FMT_NB;
 227   gst_ffmpegcsp_caps_with_codectype (CODEC_TYPE_VIDEO, incaps, ctx);
 228   if (ctx->pix_fmt == PIX_FMT_NB)
 229     goto invalid_in_caps;
 230   space->from_pixfmt = ctx->pix_fmt;
 231
 232   /* palette, only for from data */
 233   if (space->palette)
 234     av_free (space->palette);
 235   space->palette = ctx->palctrl;
 236   ctx->palctrl = NULL;
 237
 238   /* get to format */
 239   ctx->pix_fmt = PIX_FMT_NB;
 240   gst_ffmpegcsp_caps_with_codectype (CODEC_TYPE_VIDEO, outcaps, ctx);
 241   if (ctx->pix_fmt == PIX_FMT_NB)
 242     goto invalid_out_caps;
 243   space->to_pixfmt = ctx->pix_fmt;
 244
 245   GST_DEBUG ("reconfigured %d %d", space->from_pixfmt, space->to_pixfmt);
 246
 247   av_free (ctx);
 248
 249   return TRUE;
 250
 251   /* ERRORS */
 252 no_width_height:
 253   {
 254     GST_DEBUG_OBJECT (space, "did not specify width or height");
 255     space->from_pixfmt = PIX_FMT_NB;
 256     space->to_pixfmt = PIX_FMT_NB;
 257     return FALSE;
 258   }
 259 no_framerate:
 260   {
 261     GST_DEBUG_OBJECT (space, "did not specify framerate");
 262     space->from_pixfmt = PIX_FMT_NB;
 263     space->to_pixfmt = PIX_FMT_NB;
 264     return FALSE;
 265   }
 266 format_mismatch:
 267   {
 268     GST_DEBUG_OBJECT (space, "input and output formats do not match");
 269     space->from_pixfmt = PIX_FMT_NB;
 270     space->to_pixfmt = PIX_FMT_NB;
 271     return FALSE;
 272   }
 273 invalid_in_caps:
 274   {
 275     GST_DEBUG_OBJECT (space, "could not configure context for input format");
 276     av_free (ctx);
 277     space->from_pixfmt = PIX_FMT_NB;
 278     space->to_pixfmt = PIX_FMT_NB;
 279     return FALSE;
 280   }
 281 invalid_out_caps:
 282   {
 283     GST_DEBUG_OBJECT (space, "could not configure context for output format");
 284     av_free (ctx);
 285     space->from_pixfmt = PIX_FMT_NB;
 286     space->to_pixfmt = PIX_FMT_NB;
 287     return FALSE;
 288   }
 289 }
 290
 291 static GType
 292 gst_ffmpegcsp_get_type (void)
 293 {
 294   static GType ffmpegcsp_type = 0;
 295
 296   if (!ffmpegcsp_type) {
 297     static const GTypeInfo ffmpegcsp_info = {
 298       sizeof (GstFFMpegCspClass),
 299       (GBaseInitFunc) gst_ffmpegcsp_base_init,
 300       NULL,
 301       (GClassInitFunc) gst_ffmpegcsp_class_init,
 302       NULL,
 303       NULL,
 304       sizeof (GstFFMpegCsp),
 305       0,
 306       (GInstanceInitFunc) gst_ffmpegcsp_init,
 307     };
 308
 309     ffmpegcsp_type = g_type_register_static (GST_TYPE_BASE_TRANSFORM,
 310         "GstFFMpegCsp", &ffmpegcsp_info, 0);
 311   }
 312
 313   return ffmpegcsp_type;
 314 }
 315
 316 static void
 317 gst_ffmpegcsp_base_init (GstFFMpegCspClass * klass)
 318 {
 319   GstElementClass *element_class = GST_ELEMENT_CLASS (klass);
 320
 321   gst_element_class_add_pad_template (element_class, srctempl);
 322   gst_element_class_add_pad_template (element_class, sinktempl);
 323   gst_element_class_set_details (element_class, &ffmpegcsp_details);
 324 }
 325
 326 static void
 327 gst_ffmpegcsp_finalize (GObject * obj)
 328 {
 329   GstFFMpegCsp *space = GST_FFMPEGCSP (obj);
 330
 331   if (space->palette)
 332     av_free (space->palette);
 333
 334   G_OBJECT_CLASS (parent_class)->finalize (obj);
 335 }
 336
 337 static void
 338 gst_ffmpegcsp_class_init (GstFFMpegCspClass * klass)
 339 {
 340   GObjectClass *gobject_class;
 341   GstElementClass *gstelement_class;
 342   GstBaseTransformClass *gstbasetransform_class;
 343
 344   gobject_class = (GObjectClass *) klass;
 345   gstelement_class = (GstElementClass *) klass;
 346   gstbasetransform_class = (GstBaseTransformClass *) klass;
 347
 348   parent_class = g_type_class_peek_parent (klass);
 349
 350   gobject_class->finalize = GST_DEBUG_FUNCPTR (gst_ffmpegcsp_finalize);
 351
 352   gstbasetransform_class->transform_caps =
 353       GST_DEBUG_FUNCPTR (gst_ffmpegcsp_transform_caps);
 354   gstbasetransform_class->set_caps = GST_DEBUG_FUNCPTR (gst_ffmpegcsp_set_caps);
 355   gstbasetransform_class->get_unit_size =
 356       GST_DEBUG_FUNCPTR (gst_ffmpegcsp_get_unit_size);
 357   gstbasetransform_class->transform =
 358       GST_DEBUG_FUNCPTR (gst_ffmpegcsp_transform);
 359 #if 0
 360   gstbasetransform_class->transform_ip =
 361       GST_DEBUG_FUNCPTR (gst_ffmpegcsp_transform_ip);
 362 #endif
 363
 364   gstbasetransform_class->passthrough_on_same_caps = TRUE;
 365
 366   GST_DEBUG_CATEGORY_INIT (ffmpegcolorspace_debug, "ffmpegcolorspace", 0,
 367       "FFMPEG-based colorspace converter");
 368 }
 369
 370 static void
 371 gst_ffmpegcsp_init (GstFFMpegCsp * space)
 372 {
 373   gst_base_transform_set_qos_enabled (GST_BASE_TRANSFORM (space), TRUE);
 374   space->from_pixfmt = space->to_pixfmt = PIX_FMT_NB;
 375   space->palette = NULL;
 376 }
 377
 378 static gboolean
 379 gst_ffmpegcsp_get_unit_size (GstBaseTransform * btrans, GstCaps * caps,
 380     guint * size)
 381 {
 382   GstStructure *structure = NULL;
 383   AVCodecContext *ctx = NULL;
 384   gboolean ret = TRUE;
 385   gint width, height;
 386
 387   g_assert (size);
 388
 389   structure = gst_caps_get_structure (caps, 0);
 390   gst_structure_get_int (structure, "width", &width);
 391   gst_structure_get_int (structure, "height", &height);
 392
 393   ctx = avcodec_alloc_context ();
 394
 395   g_assert (ctx != NULL);
 396
 397   ctx->pix_fmt = PIX_FMT_NB;
 398
 399   gst_ffmpegcsp_caps_with_codectype (CODEC_TYPE_VIDEO, caps, ctx);
 400
 401   if (G_UNLIKELY (ctx->pix_fmt == PIX_FMT_NB)) {
 402     ret = FALSE;
 403     goto beach;
 404   }
 405
 406   *size = avpicture_get_size (ctx->pix_fmt, width, height);
 407
 408   /* ffmpeg frames have the palette after the frame data, whereas
 409    * GStreamer currently puts it into the caps as 'palette_data' field,
 410    * so for paletted data the frame size avpicture_get_size() returns is
 411    * 1024 bytes larger than what GStreamer expects. */
 412   if (gst_structure_has_field (structure, "palette_data") &&
 413       ctx->pix_fmt == PIX_FMT_PAL8) {
 414     *size -= 4 * 256;           /* = AVPALETTE_SIZE */
 415   }
 416
 417 beach:
 418
 419   if (ctx->palctrl)
 420     av_free (ctx->palctrl);
 421   av_free (ctx);
 422
 423   return ret;
 424 }
 425
 426 #if 0
 427 /* FIXME: Could use transform_ip to implement endianness swap type operations */
 428 static GstFlowReturn
 429 gst_ffmpegcsp_transform_ip (GstBaseTransform * btrans, GstBuffer * inbuf)
 430 {
 431   /* do nothing */
 432   return GST_FLOW_OK;
 433 }
 434 #endif
 435
 436 static GstFlowReturn
 437 gst_ffmpegcsp_transform (GstBaseTransform * btrans, GstBuffer * inbuf,
 438     GstBuffer * outbuf)
 439 {
 440   GstFFMpegCsp *space;
 441   gint result;
 442
 443   space = GST_FFMPEGCSP (btrans);
 444
 445   GST_DEBUG ("from %d -> to %d", space->from_pixfmt, space->to_pixfmt);
 446   if (space->from_pixfmt == PIX_FMT_NB || space->to_pixfmt == PIX_FMT_NB)
 447     goto unknown_format;
 448
 449   /* fill from with source data */
 450   gst_ffmpegcsp_avpicture_fill (&space->from_frame,
 451       GST_BUFFER_DATA (inbuf), space->from_pixfmt, space->width, space->height,
 452       space->interlaced);
 453
 454   /* fill optional palette */
 455   if (space->palette)
 456     space->from_frame.data[1] = (uint8_t *) space->palette->palette;
 457
 458   /* fill target frame */
 459   gst_ffmpegcsp_avpicture_fill (&space->to_frame,
 460       GST_BUFFER_DATA (outbuf), space->to_pixfmt, space->width, space->height,
 461       space->interlaced);
 462
 463   /* and convert */
 464   result = img_convert (&space->to_frame, space->to_pixfmt,
 465       &space->from_frame, space->from_pixfmt, space->width, space->height);
 466   if (result == -1)
 467     goto not_supported;
 468
 469   /* baseclass copies timestamps */
 470   GST_DEBUG ("from %d -> to %d done", space->from_pixfmt, space->to_pixfmt);
 471
 472   return GST_FLOW_OK;
 473
 474   /* ERRORS */
 475 unknown_format:
 476   {
 477     GST_ELEMENT_ERROR (space, CORE, NOT_IMPLEMENTED, (NULL),
 478         ("attempting to convert colorspaces between unknown formats"));
 479     return GST_FLOW_NOT_NEGOTIATED;
 480   }
 481 not_supported:
 482   {
 483     GST_ELEMENT_ERROR (space, CORE, NOT_IMPLEMENTED, (NULL),
 484         ("cannot convert between formats"));
 485     return GST_FLOW_NOT_SUPPORTED;
 486   }
 487 }
 488
 489 gboolean
 490 gst_ffmpegcolorspace_register (GstPlugin * plugin)
 491 {
 492   GstCaps *caps;
 493
 494   /* template caps */
 495   caps = gst_ffmpegcsp_codectype_to_caps (CODEC_TYPE_VIDEO, NULL);
 496
 497   /* build templates */
 498   srctempl = gst_pad_template_new ("src",
 499       GST_PAD_SRC, GST_PAD_ALWAYS, gst_caps_copy (caps));
 500
 501   /* the sink template will do palette handling as well... */
 502   sinktempl = gst_pad_template_new ("sink", GST_PAD_SINK, GST_PAD_ALWAYS, caps);
 503
 504   return gst_element_register (plugin, "ffmpegcolorspace",
 505       GST_RANK_NONE, GST_TYPE_FFMPEGCSP);
 506 }