/* GStreamer

 * Copyright (C) 2004 Benjamin Otte <in7y118@public.uni-hamburg.de>

 *

 * 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.

 */

/**

 * SECTION:element-theoradec

 * @see_also: theoraenc, oggdemux

 *

 * <refsect2>

 * <para>

 * This element decodes theora streams into raw video

 * <ulink url="http://www.theora.org/">Theora</ulink> is a royalty-free

 * video codec maintained by the <ulink url="http://www.xiph.org/">Xiph.org

 * Foundation</ulink>, based on the VP3 codec.

 * </para>

 * <para>

 * </para>

 * <title>Example pipeline</title>

 * <programlisting>

 * gst-launch -v filesrc location=videotestsrc.ogg ! oggdemux ! theoradec ! xvimagesink

 * </programlisting>

 * This example pipeline will decode an ogg stream and decodes the theora video. Refer to

 * the theoraenc example to create the ogg file.

 * </refsect2>

 *

 * Last reviewed on 2006-03-01 (0.10.4)

 */

#ifdef HAVE_CONFIG_H

#  include "config.h"

#endif

#include "gsttheoradec.h"

#include <gst/tag/tag.h>

#define GST_CAT_DEFAULT theoradec_debug

GST_DEBUG_CATEGORY_STATIC (GST_CAT_DEFAULT);

#define THEORA_DEF_CROP         TRUE

enum

{

  ARG_0,

  ARG_CROP

};

static const GstElementDetails theora_dec_details =

GST_ELEMENT_DETAILS ("Theora video decoder",

    "Codec/Decoder/Video",

    "decode raw theora streams to raw YUV video",

    "Benjamin Otte <in7y118@public.uni-hamburg.de>, "

    "Wim Taymans <wim@fluendo.com>");

static GstStaticPadTemplate theora_dec_src_factory =

GST_STATIC_PAD_TEMPLATE ("src",

    GST_PAD_SRC,

    GST_PAD_ALWAYS,

    GST_STATIC_CAPS ("video/x-raw-yuv, "

        "format = (fourcc) I420, "

        "framerate = (fraction) [0/1, MAX], "

        "width = (int) [ 1, MAX ], " "height = (int) [ 1, MAX ]")

    );

static GstStaticPadTemplate theora_dec_sink_factory =

GST_STATIC_PAD_TEMPLATE ("sink",

    GST_PAD_SINK,

    GST_PAD_ALWAYS,

    GST_STATIC_CAPS ("video/x-theora")

    );

GST_BOILERPLATE (GstTheoraDec, gst_theora_dec, GstElement, GST_TYPE_ELEMENT);

static void theora_dec_get_property (GObject * object, guint prop_id,

    GValue * value, GParamSpec * pspec);

static void theora_dec_set_property (GObject * object, guint prop_id,

    const GValue * value, GParamSpec * pspec);

static gboolean theora_dec_sink_event (GstPad * pad, GstEvent * event);

static GstFlowReturn theora_dec_chain (GstPad * pad, GstBuffer * buffer);

static GstStateChangeReturn theora_dec_change_state (GstElement * element,

    GstStateChange transition);

static gboolean theora_dec_src_event (GstPad * pad, GstEvent * event);

static gboolean theora_dec_src_query (GstPad * pad, GstQuery * query);

static gboolean theora_dec_src_convert (GstPad * pad,

    GstFormat src_format, gint64 src_value,

    GstFormat * dest_format, gint64 * dest_value);

static gboolean theora_dec_sink_convert (GstPad * pad,

    GstFormat src_format, gint64 src_value,

    GstFormat * dest_format, gint64 * dest_value);

static gboolean theora_dec_sink_query (GstPad * pad, GstQuery * query);

#if 0

static const GstFormat *theora_get_formats (GstPad * pad);

#endif

#if 0

static const GstEventMask *theora_get_event_masks (GstPad * pad);

#endif

static const GstQueryType *theora_get_query_types (GstPad * pad);

static void

gst_theora_dec_base_init (gpointer g_class)

{

  GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);

  gst_element_class_add_pad_template (element_class,

      gst_static_pad_template_get (&theora_dec_src_factory));

  gst_element_class_add_pad_template (element_class,

      gst_static_pad_template_get (&theora_dec_sink_factory));

  gst_element_class_set_details (element_class, &theora_dec_details);

}

static void

gst_theora_dec_class_init (GstTheoraDecClass * klass)

{

  GObjectClass *gobject_class = G_OBJECT_CLASS (klass);

  GstElementClass *gstelement_class = GST_ELEMENT_CLASS (klass);

  gobject_class->set_property = theora_dec_set_property;

  gobject_class->get_property = theora_dec_get_property;

  g_object_class_install_property (gobject_class, ARG_CROP,

      g_param_spec_boolean ("crop", "Crop",

          "Crop the image to the visible region", THEORA_DEF_CROP,

          (GParamFlags) G_PARAM_READWRITE));

  gstelement_class->change_state = theora_dec_change_state;

  GST_DEBUG_CATEGORY_INIT (theoradec_debug, "theoradec", 0, "Theora decoder");

}

static void

gst_theora_dec_init (GstTheoraDec * dec, GstTheoraDecClass * g_class)

{

  dec->sinkpad =

      gst_pad_new_from_static_template (&theora_dec_sink_factory, "sink");

  gst_pad_set_query_function (dec->sinkpad, theora_dec_sink_query);

  gst_pad_set_event_function (dec->sinkpad, theora_dec_sink_event);

  gst_pad_set_chain_function (dec->sinkpad, theora_dec_chain);

  gst_element_add_pad (GST_ELEMENT (dec), dec->sinkpad);

  dec->srcpad =

      gst_pad_new_from_static_template (&theora_dec_src_factory, "src");

  gst_pad_set_event_function (dec->srcpad, theora_dec_src_event);

  gst_pad_set_query_type_function (dec->srcpad, theora_get_query_types);

  gst_pad_set_query_function (dec->srcpad, theora_dec_src_query);

  gst_pad_use_fixed_caps (dec->srcpad);

  gst_element_add_pad (GST_ELEMENT (dec), dec->srcpad);

  dec->crop = THEORA_DEF_CROP;

  dec->gather = NULL;

  dec->decode = NULL;

  dec->queued = NULL;

}

static void

gst_theora_dec_reset (GstTheoraDec * dec)

{

  dec->need_keyframe = TRUE;

  dec->sent_newsegment = FALSE;

  dec->last_timestamp = -1;

  dec->granulepos = -1;

  dec->discont = TRUE;

  dec->frame_nr = -1;

  gst_segment_init (&dec->segment, GST_FORMAT_TIME);

  GST_OBJECT_LOCK (dec);

  dec->proportion = 1.0;

  dec->earliest_time = -1;

  GST_OBJECT_UNLOCK (dec);

  g_list_foreach (dec->queued, (GFunc) gst_mini_object_unref, NULL);

  g_list_free (dec->queued);

  dec->queued = NULL;

  g_list_foreach (dec->gather, (GFunc) gst_mini_object_unref, NULL);

  g_list_free (dec->gather);

  dec->gather = NULL;

  g_list_foreach (dec->decode, (GFunc) gst_mini_object_unref, NULL);

  g_list_free (dec->decode);

  dec->decode = NULL;

  if (dec->tags) {

    gst_tag_list_free (dec->tags);

    dec->tags = NULL;

  }

}

static int

_theora_ilog (unsigned int v)

{

  int ret = 0;

  while (v) {

    ret++;

    v >>= 1;

  }

  return (ret);

}

/* Return the frame number (starting from zero) corresponding to this 

 * granulepos */

static gint64

_theora_granule_frame (GstTheoraDec * dec, gint64 granulepos)

{

  guint ilog;

  gint framenum;

  if (granulepos == -1)

    return -1;

  ilog = dec->granule_shift;

  /* granulepos is last ilog bits for counting pframes since last iframe and 

   * bits in front of that for the framenumber of the last iframe. */

  framenum = granulepos >> ilog;

  framenum += granulepos - (framenum << ilog);

  /* This is 0-based for old bitstreams, 1-based for new. Fix up. */

  if (!dec->is_old_bitstream)

    framenum -= 1;

  GST_DEBUG_OBJECT (dec, "framecount=%d, ilog=%u", framenum, ilog);

  return framenum;

}

/* Return the frame start time corresponding to this granulepos */

static GstClockTime

_theora_granule_start_time (GstTheoraDec * dec, gint64 granulepos)

{

  gint64 framecount;

  /* invalid granule results in invalid time */

  if (granulepos == -1)

    return -1;

  /* get framecount */

  framecount = _theora_granule_frame (dec, granulepos);

  return gst_util_uint64_scale_int (framecount * GST_SECOND,

      dec->info.fps_denominator, dec->info.fps_numerator);

}

static gint64

_inc_granulepos (GstTheoraDec * dec, gint64 granulepos)

{

  gint framecount;

  if (granulepos == -1)

    return -1;

  framecount = _theora_granule_frame (dec, granulepos);

  return (framecount + 1 +

      (dec->is_old_bitstream ? 0 : 1)) << dec->granule_shift;

}

#if 0

static const GstFormat *

theora_get_formats (GstPad * pad)

{

  static GstFormat src_formats[] = {

    GST_FORMAT_DEFAULT,         /* frames in this case */

    GST_FORMAT_TIME,

    GST_FORMAT_BYTES,

    0

  };

  static GstFormat sink_formats[] = {

    GST_FORMAT_DEFAULT,

    GST_FORMAT_TIME,

    0

  };

  return (GST_PAD_IS_SRC (pad) ? src_formats : sink_formats);

}

#endif

#if 0

static const GstEventMask *

theora_get_event_masks (GstPad * pad)

{

  static const GstEventMask theora_src_event_masks[] = {

    {GST_EVENT_SEEK, GST_SEEK_METHOD_SET | GST_SEEK_FLAG_FLUSH},

    {0,}

  };

  return theora_src_event_masks;

}

#endif

static const GstQueryType *

theora_get_query_types (GstPad * pad)

{

  static const GstQueryType theora_src_query_types[] = {

    GST_QUERY_POSITION,

    GST_QUERY_DURATION,

    GST_QUERY_CONVERT,

    0

  };

  return theora_src_query_types;

}

static gboolean

theora_dec_src_convert (GstPad * pad,

    GstFormat src_format, gint64 src_value,

    GstFormat * dest_format, gint64 * dest_value)

{

  gboolean res = TRUE;

  GstTheoraDec *dec;

  guint64 scale = 1;

  if (src_format == *dest_format) {

    *dest_value = src_value;

    return TRUE;

  }

  dec = GST_THEORA_DEC (gst_pad_get_parent (pad));

  /* we need the info part before we can done something */

  if (!dec->have_header)

    goto no_header;

  switch (src_format) {

    case GST_FORMAT_BYTES:

      switch (*dest_format) {

        case GST_FORMAT_DEFAULT:

          *dest_value = gst_util_uint64_scale_int (src_value, 2,

              dec->info.height * dec->info.width * 3);

          break;

        case GST_FORMAT_TIME:

          /* seems like a rather silly conversion, implement me if you like */

        default:

          res = FALSE;

      }

      break;

    case GST_FORMAT_TIME:

      switch (*dest_format) {

        case GST_FORMAT_BYTES:

          scale = 3 * (dec->info.width * dec->info.height) / 2;

        case GST_FORMAT_DEFAULT:

          *dest_value = scale * gst_util_uint64_scale (src_value,

              dec->info.fps_numerator, dec->info.fps_denominator * GST_SECOND);

          break;

        default:

          res = FALSE;

      }

      break;

    case GST_FORMAT_DEFAULT:

      switch (*dest_format) {

        case GST_FORMAT_TIME:

          *dest_value = gst_util_uint64_scale (src_value,

              GST_SECOND * dec->info.fps_denominator, dec->info.fps_numerator);

          break;

        case GST_FORMAT_BYTES:

          *dest_value = gst_util_uint64_scale_int (src_value,

              3 * dec->info.width * dec->info.height, 2);

          break;

        default:

          res = FALSE;

      }

      break;

    default:

      res = FALSE;

  }

done:

  gst_object_unref (dec);

  return res;

  /* ERRORS */

no_header:

  {

    GST_DEBUG_OBJECT (dec, "no header yet, cannot convert");

    res = FALSE;

    goto done;

  }

}

static gboolean

theora_dec_sink_convert (GstPad * pad,

    GstFormat src_format, gint64 src_value,

    GstFormat * dest_format, gint64 * dest_value)

{

  gboolean res = TRUE;

  GstTheoraDec *dec;

  if (src_format == *dest_format) {

    *dest_value = src_value;

    return TRUE;

  }

  dec = GST_THEORA_DEC (gst_pad_get_parent (pad));

  /* we need the info part before we can done something */

  if (!dec->have_header)

    goto no_header;

  switch (src_format) {

    case GST_FORMAT_DEFAULT:

      switch (*dest_format) {

        case GST_FORMAT_TIME:

          *dest_value = _theora_granule_start_time (dec, src_value);

          break;

        default:

          res = FALSE;

      }

      break;

    case GST_FORMAT_TIME:

      switch (*dest_format) {

        case GST_FORMAT_DEFAULT:

        {

          guint rest;

          /* framecount */

          *dest_value = gst_util_uint64_scale (src_value,

              dec->info.fps_numerator, GST_SECOND * dec->info.fps_denominator);

          /* funny way of calculating granulepos in theora */

          rest = *dest_value / dec->info.keyframe_frequency_force;

          *dest_value -= rest;

          *dest_value <<= dec->granule_shift;

          *dest_value += rest;

          break;

        }

        default:

          res = FALSE;

          break;

      }

      break;

    default:

      res = FALSE;

  }

done:

  gst_object_unref (dec);

  return res;

  /* ERRORS */

no_header:

  {

    GST_DEBUG_OBJECT (dec, "no header yet, cannot convert");

    res = FALSE;

    goto done;

  }

}

static gboolean

theora_dec_src_query (GstPad * pad, GstQuery * query)

{

  GstTheoraDec *dec;

  gboolean res = FALSE;

  dec = GST_THEORA_DEC (gst_pad_get_parent (pad));

  switch (GST_QUERY_TYPE (query)) {

    case GST_QUERY_POSITION:

    {

      gint64 granulepos, value;

      GstFormat my_format, format;

      gint64 time;

      /* we can convert a granule position to everything */

      granulepos = dec->granulepos;

      GST_LOG_OBJECT (dec,

          "query %p: we have current granule: %lld", query, granulepos);

      /* parse format */

      gst_query_parse_position (query, &format, NULL);

      /* and convert to the final format in two steps with time as the 

       * intermediate step */

      my_format = GST_FORMAT_TIME;

      if (!(res =

              theora_dec_sink_convert (dec->sinkpad, GST_FORMAT_DEFAULT,

                  granulepos, &my_format, &time)))

        goto error;

      time = gst_segment_to_stream_time (&dec->segment, GST_FORMAT_TIME, time);

      GST_LOG_OBJECT (dec,

          "query %p: our time: %" GST_TIME_FORMAT, query, GST_TIME_ARGS (time));

      if (!(res =

              theora_dec_src_convert (pad, my_format, time, &format, &value)))

        goto error;

      gst_query_set_position (query, format, value);

      GST_LOG_OBJECT (dec,

          "query %p: we return %lld (format %u)", query, value, format);

      break;

    }

    case GST_QUERY_DURATION:

    {

      GstPad *peer;

      if (!(peer = gst_pad_get_peer (dec->sinkpad)))

        goto error;

      /* forward to peer for total */

      res = gst_pad_query (peer, query);

      gst_object_unref (peer);

      if (!res)

        goto error;

      break;

    }

    case GST_QUERY_CONVERT:

    {

      GstFormat src_fmt, dest_fmt;