ext/divx/gstdivxdec.c

/* GStreamer divx decoder plugin
 * Copyright (C) 2003 Ronald Bultje <rbultje@ronald.bitfreak.net>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

#include <string.h>
#include "gstdivxdec.h"
#include <gst/video/video.h>

static GstStaticPadTemplate sink_template = GST_STATIC_PAD_TEMPLATE ("sink",
    GST_PAD_SINK,
    GST_PAD_ALWAYS,
    GST_STATIC_CAPS ("video/x-divx, "
        "divxversion = (int) [ 3, 5 ], "
        "width = (int) [ 16, 4096 ], "
        "height = (int) [ 16, 4096 ], " "framerate = (fraction) [0/1, MAX]")
    );

static GstStaticPadTemplate src_template = GST_STATIC_PAD_TEMPLATE ("src",
    GST_PAD_SRC,
    GST_PAD_ALWAYS,
    GST_STATIC_CAPS (GST_VIDEO_CAPS_YUV ("{ I420, YUY2, YV12, UYVY }")
        /* FIXME: 15/16/24/32bpp RGB */
    )
    );


/* DivxDec signals and args */
enum
{
  /* FILL ME */
  LAST_SIGNAL
};

enum
{
  ARG_0
      /* FILL ME */
};


static void gst_divxdec_base_init (GstDivxDecClass * klass);
static void gst_divxdec_class_init (GstDivxDecClass * klass);
static void gst_divxdec_init (GstDivxDec * divxdec);
static void gst_divxdec_dispose (GObject * object);
static GstFlowReturn gst_divxdec_chain (GstPad * pad, GstBuffer * buf);
static gboolean gst_divxdec_connect (GstPad * pad, GstCaps * vscapslist);
static gboolean gst_divxdec_negotiate (GstDivxDec * divxdec);
static GstStateChangeReturn
gst_divxdec_change_state (GstElement * element, GstStateChange transition);
static GstElementClass *parent_class = NULL;

/* static guint gst_divxdec_signals[LAST_SIGNAL] = { 0 }; */


static const gchar *
gst_divxdec_error (int errorcode)
{
  const gchar *error;

  switch (errorcode) {
    case DEC_OK:
      error = "No error";
      break;
    case DEC_MEMORY:
      error = "Invalid memory";
      break;
    case DEC_BAD_FORMAT:
      error = "Invalid format";
      break;
    case DEC_INVALID_ARGUMENT:
      error = "Invalid argument";
      break;
    case DEC_NOT_IMPLEMENTED:
      error = "Not implemented";
      break;
    default:
      error = "Unknown error";
      break;
  }

  return error;
}

GType
gst_divxdec_get_type (void)
{
  static GType divxdec_type = 0;

  if (!divxdec_type) {
    static const GTypeInfo divxdec_info = {
      sizeof (GstDivxDecClass),
      (GBaseInitFunc) gst_divxdec_base_init,
      NULL,
      (GClassInitFunc) gst_divxdec_class_init,
      NULL,
      NULL,
      sizeof (GstDivxDec),
      0,
      (GInstanceInitFunc) gst_divxdec_init,
    };

    divxdec_type = g_type_register_static (GST_TYPE_ELEMENT,
        "GstDivxDec", &divxdec_info, 0);
  }
  return divxdec_type;
}


static void
gst_divxdec_base_init (GstDivxDecClass * klass)
{
  GstElementClass *element_class = GST_ELEMENT_CLASS (klass);

  gst_element_class_add_pad_template (element_class,
      gst_static_pad_template_get (&sink_template));
  gst_element_class_add_pad_template (element_class,
      gst_static_pad_template_get (&src_template));

  gst_element_class_set_details_simple (element_class,
      "Divx4linux video decoder", "Codec/Decoder/Video",
      "Divx decoder based on divxdecore",
      "Ronald Bultje <rbultje@ronald.bitfreak.net>");
}


static void
gst_divxdec_class_init (GstDivxDecClass * klass)
{
  GstElementClass *gstelement_class = GST_ELEMENT_CLASS (klass);
  GObjectClass *gobject_class = (GObjectClass *) klass;

  parent_class = g_type_class_peek_parent (klass);

  gstelement_class->change_state = gst_divxdec_change_state;
  gobject_class->dispose = gst_divxdec_dispose;
}


static void
gst_divxdec_init (GstDivxDec * divxdec)
{
  /* create the sink pad */
  divxdec->sinkpad = gst_pad_new_from_static_template (&sink_template, "sink");
  gst_element_add_pad (GST_ELEMENT (divxdec), divxdec->sinkpad);
  gst_pad_set_chain_function (divxdec->sinkpad, gst_divxdec_chain);
  gst_pad_set_setcaps_function (divxdec->sinkpad, gst_divxdec_connect);

  /* create the src pad */
  divxdec->srcpad = gst_pad_new_from_static_template (&src_template, "src");
  gst_element_add_pad (GST_ELEMENT (divxdec), divxdec->srcpad);
  gst_pad_use_fixed_caps (divxdec->srcpad);

  /* bitrate, etc. */
  divxdec->width = divxdec->height = divxdec->csp = divxdec->bitcnt = -1;
  divxdec->version = 0;

  /* set divx handle to NULL */
  divxdec->handle = NULL;
}


static void
gst_divxdec_unset (GstDivxDec * divxdec)
{
  if (divxdec->handle) {
    /* unref this instance */
    decore (divxdec->handle, DEC_OPT_RELEASE, NULL, NULL);
    divxdec->handle = NULL;
  }
}


static gboolean
gst_divxdec_setup (GstDivxDec * divxdec)
{
  void *handle;
  DEC_INIT xinit;
  DivXBitmapInfoHeader output;
  int ret;

  /* initialize the handle */
  memset (&xinit, 0, sizeof (DEC_INIT));
  xinit.smooth_playback = 0;
  switch (divxdec->version) {
    case 3:
      xinit.codec_version = 311;
      break;
    case 4:
      xinit.codec_version = 400;
      break;
    case 5:
      xinit.codec_version = 500;
      break;
    default:
      xinit.codec_version = 0;
      break;
  }
  if ((ret = decore (&handle, DEC_OPT_INIT, &xinit, NULL)) != 0) {
    GST_ELEMENT_ERROR (divxdec, LIBRARY, INIT, (NULL),
        ("divx library error: %s (%d)", gst_divxdec_error (ret), ret));
    return FALSE;
  }

  /* we've got a handle now */
  divxdec->handle = handle;

  /* initialise parameters, see divx documentation */
  memset (&output, 0, sizeof (DivXBitmapInfoHeader));
  output.biSize = sizeof (DivXBitmapInfoHeader);
  output.biWidth = divxdec->width;
  output.biHeight = divxdec->height;
  output.biBitCount = divxdec->bitcnt;
  output.biCompression = divxdec->csp;

  if ((ret = decore (divxdec->handle, DEC_OPT_SETOUT, &output, NULL)) != 0) {
    GST_ELEMENT_ERROR (divxdec, LIBRARY, SETTINGS, (NULL),
        ("error setting output: %s (%d)", gst_divxdec_error (ret), ret));
    gst_divxdec_unset (divxdec);
    return FALSE;
  }
  return TRUE;
}

static void
gst_divxdec_dispose (GObject * object)
{
  GstDivxDec *divxdec = GST_DIVXDEC (object);

  gst_divxdec_unset (divxdec);
  G_OBJECT_CLASS (parent_class)->dispose (object);
}

static GstFlowReturn
gst_divxdec_chain (GstPad * pad, GstBuffer * buf)
{
  GstDivxDec *divxdec;
  GstBuffer *outbuf;
  DEC_FRAME xframe;
  int res;
  GstFlowReturn ret;

  divxdec = GST_DIVXDEC (gst_pad_get_parent (pad));
  if (!divxdec->handle) {
    if (gst_divxdec_negotiate (divxdec) <= 0) {
      goto not_negotiated;
    }
  }

  outbuf = gst_buffer_new_and_alloc (divxdec->width *
      divxdec->height * divxdec->bpp / 8);
  GST_BUFFER_TIMESTAMP (outbuf) = GST_BUFFER_TIMESTAMP (buf);
  GST_BUFFER_SIZE (outbuf) = divxdec->width *
      divxdec->height * divxdec->bpp / 8;

  /* encode and so ... */
  xframe.bitstream = (void *) GST_BUFFER_DATA (buf);
  xframe.bmp = (void *) GST_BUFFER_DATA (outbuf);
  xframe.length = GST_BUFFER_SIZE (buf);
  xframe.stride = 0;
  xframe.render_flag = 1;

  if ((res = decore (divxdec->handle, DEC_OPT_FRAME, &xframe, NULL))) {
    goto not_decoding;
  }

  gst_buffer_set_caps (outbuf, GST_PAD_CAPS (divxdec->srcpad));
  ret = gst_pad_push (divxdec->srcpad, outbuf);
  goto cleanup;

not_negotiated:
  {
    GST_ELEMENT_ERROR (divxdec, CORE, TOO_LAZY, (NULL),
        ("No format set - aborting"));
    ret = GST_FLOW_NOT_NEGOTIATED;
    goto cleanup;
  }

not_decoding:
  {
    GST_ELEMENT_ERROR (divxdec, STREAM, DECODE, (NULL),
        ("Error decoding divx frame: %s (%d)", gst_divxdec_error (res), res));
    gst_buffer_unref (outbuf);
    ret = GST_FLOW_ERROR;
    goto cleanup;
  }

cleanup:

  gst_buffer_unref (buf);
  gst_object_unref (divxdec);
  return ret;

}


/* FIXME: moved all the bits out here that are broken so the syntax
 * stays clear */

/*
  {
  GST_MAKE_FOURCC ('R', 'G', 'B', ' '), 32, 32,
  #if (G_BYTE_ORDER == G_BIG_ENDIAN)
  GST_MAKE_FOURCC ('A', 'B', 'G', 'R'), 32}

  ,
  #else
  0, 32}

  ,
  #endif
  {
  GST_MAKE_FOURCC ('R', 'G', 'B', ' '), 24, 24,
  #if (G_BYTE_ORDER == G_BIG_ENDIAN)
  GST_MAKE_FOURCC ('A', 'B', 'G', 'R'), 24}

  ,
  #else
  0, 24}

  ,
  #endif
  {
  GST_MAKE_FOURCC ('R', 'G', 'B', ' '), 16, 16, 3, 16}

  , {
  GST_MAKE_FOURCC ('R', 'G', 'B', ' '), 15, 16, 0, 16}

  ,
  #endif
  if (fmt_list[i].fourcc == GST_MAKE_FOURCC ('R', 'G', 'B', ' ')) {
  guint32 r_mask = 0, b_mask = 0, g_mask = 0;
  gint endianness = 0;

  switch (fmt_list[i].depth) {
  case 15:
  endianness = G_BYTE_ORDER;
  r_mask = 0xf800;
  g_mask = 0x07c0;
  b_mask = 0x003e;
  break;
  case 16:
  endianness = G_BYTE_ORDER;
  r_mask = 0xf800;
  g_mask = 0x07e0;
  b_mask = 0x001f;
  break;
  case 24:
  endianness = G_BIG_ENDIAN;
  r_mask = GST_VIDEO_BYTE1_MASK_24_INT;
  g_mask = GST_VIDEO_BYTE2_MASK_24_INT;
  b_mask = GST_VIDEO_BYTE3_MASK_24_INT break;
  case 32:
  endianness = G_BIG_ENDIAN;
  r_mask = GST_VIDEO_BYTE1_MASK_32_INT;
  g_mask = GST_VIDEO_BYTE2_MASK_32_INT;
  b_mask = GST_VIDEO_BYTE3_MASK_32_INT break;
  }
  caps = GST_CAPS_NEW ("divxdec_src_pad_rgb",
  "video/x-raw-rgb",
  "width", GST_PROPS_INT (divxdec->width),
  "height", GST_PROPS_INT (divxdec->height),
  "framerate", GST_PROPS_FLOAT (divxdec->fps),
  "depth", GST_PROPS_INT (fmt_list[i].depth),
  "bpp", GST_PROPS_INT (fmt_list[i].bpp),
  "endianness", GST_PROPS_INT (endianness),
  "red_mask", GST_PROPS_INT (r_mask),
  "green_mask", GST_PROPS_INT (g_mask),
  "blue_mask", GST_PROPS_INT (b_mask));
  } else {
  #endif

  #endif
*/

static gboolean
gst_divxdec_negotiate (GstDivxDec * divxdec)
{
  GstCaps *caps = NULL;
  gint i;
  gint par_num, par_den;
  gboolean ret = FALSE;

  struct
  {
    guint32 fourcc;
    gint depth, bpp;
    guint32 csp;
    gint bitcnt;
  }

  fmt_list[] = {
    {
    GST_MAKE_FOURCC ('Y', 'U', 'Y', '2'), 16, 16,
          GST_MAKE_FOURCC ('Y', 'U', 'Y', '2'), 0}
    , {
    GST_MAKE_FOURCC ('U', 'Y', 'V', 'Y'), 16, 16,
          GST_MAKE_FOURCC ('U', 'Y', 'V', 'Y'), 0}
    , {
    GST_MAKE_FOURCC ('I', '4', '2', '0'), 12, 12,
          GST_MAKE_FOURCC ('I', '4', '2', '0'), 0}
    , {
    GST_MAKE_FOURCC ('Y', 'V', '1', '2'), 12, 12,
          GST_MAKE_FOURCC ('Y', 'V', '1', '2'), 0}
    , {
    0, 0, 0, 0, 0}
  };

  GST_DEBUG_OBJECT (divxdec, "fps %d/%d, PAR %d/%d",
      divxdec->fps_n, divxdec->fps_d, divxdec->par_n, divxdec->par_d);

  /* calculate par
   * the info.aspect_* values reflect PAR;
   * 0:0 is allowed and can be interpreted as 1:1, so correct for it */
  par_num = divxdec->par_n;
  par_den = divxdec->par_d;
  if (par_num == 0 && par_den == 0) {
    par_num = par_den = 1;
  }

  for (i = 0; fmt_list[i].fourcc != 0; i++) {
    divxdec->csp = fmt_list[i].csp;

    caps = gst_caps_new_simple ("video/x-raw-yuv",
        "width", G_TYPE_INT, divxdec->width,
        "height", G_TYPE_INT, divxdec->height,
        "framerate", GST_TYPE_FRACTION, divxdec->fps_n, divxdec->fps_d,
        "pixel-aspect-ratio", GST_TYPE_FRACTION, par_num, par_den,
        "format", GST_TYPE_FOURCC, fmt_list[i].fourcc, NULL);

    if (caps) {

      if (gst_divxdec_setup (divxdec) &&
          gst_pad_set_caps (divxdec->srcpad, caps)) {
        divxdec->csp = fmt_list[i].csp;
        divxdec->bpp = fmt_list[i].bpp;
        divxdec->bitcnt = fmt_list[i].bitcnt;
        ret = TRUE;
        goto done;
      }

      gst_caps_unref (caps);
      caps = NULL;

    }

  }

  /* if we got here - it's not good */

done:

  if (caps) {
    gst_caps_unref (caps);
  }

  return ret;
}


static gboolean
gst_divxdec_connect (GstPad * pad, GstCaps * caps)
{
  GstDivxDec *divxdec;
  const GValue *par;
  const GValue *fps;
  gboolean ret = FALSE;

  GstStructure *structure = gst_caps_get_structure (caps, 0);

  divxdec = GST_DIVXDEC (gst_pad_get_parent (pad));

  /* if there's something old around, remove it */
  if (divxdec->handle) {
    gst_divxdec_unset (divxdec);
  }

  /* if we get here, we know the input is divx. we
   * only need to bother with the output colorspace */
  gst_structure_get_int (structure, "width", &divxdec->width);
  gst_structure_get_int (structure, "height", &divxdec->height);
  gst_structure_get_int (structure, "divxversion", &divxdec->version);

  /* get pixel aspect ratio if it's set */
  par = gst_structure_get_value (structure, "pixel-aspect-ratio");
  if (par) {
    divxdec->par_n = gst_value_get_fraction_numerator (par),
        divxdec->par_d = gst_value_get_fraction_denominator (par);
  }

  fps = gst_structure_get_value (structure, "framerate");
  if (fps != NULL) {
    divxdec->fps_n = gst_value_get_fraction_numerator (fps);
    divxdec->fps_d = gst_value_get_fraction_denominator (fps);
  } else {
    divxdec->fps_n = -1;
  }

  ret = gst_divxdec_negotiate (divxdec);
  gst_object_unref (divxdec);

  return ret;
}

static GstStateChangeReturn
gst_divxdec_change_state (GstElement * element, GstStateChange transition)
{
  GstStateChangeReturn ret;

  switch (transition) {
    case GST_STATE_CHANGE_NULL_TO_READY:
      break;
    case GST_STATE_CHANGE_PAUSED_TO_PLAYING:
      break;
    default:
      break;
  }

  ret = parent_class->change_state (element, transition);

  switch (transition) {
    case GST_STATE_CHANGE_PLAYING_TO_PAUSED:
      break;
    case GST_STATE_CHANGE_PAUSED_TO_READY:
      break;
    case GST_STATE_CHANGE_READY_TO_NULL:
      break;
    default:
      break;
  }

  return ret;
}


static gboolean
plugin_init (GstPlugin * plugin)
{
  int lib_version;

  lib_version = decore (NULL, DEC_OPT_VERSION, 0, 0);
  if (lib_version != DECORE_VERSION) {
    g_warning ("Version mismatch! This plugin was compiled for "
        "DivX version %d, while your library has version %d!",
        DECORE_VERSION, lib_version);
    return FALSE;
  }

  return gst_element_register (plugin, "divxdec",
      GST_RANK_SECONDARY, GST_TYPE_DIVXDEC);
}


GST_PLUGIN_DEFINE (GST_VERSION_MAJOR,
    GST_VERSION_MINOR,
    divxdec,
    "DivX decoder",
    plugin_init,
    "5.03", GST_LICENSE_UNKNOWN, "divx4linux", "http://www.divx.com/");