gsttheoradec.c 48 KB
Newer Older
Benjamin Otte's avatar
Benjamin Otte committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
/* 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.
 */

Wim Taymans's avatar
Wim Taymans committed
20 21 22 23 24 25 26 27
/**
 * SECTION:element-theoradec
 * @see_also: theoraenc, oggdemux
 *
 * 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.
28 29
 *
 * <refsect2>
Wim Taymans's avatar
Wim Taymans committed
30
 * <title>Example pipeline</title>
31
 * |[
Wim Taymans's avatar
Wim Taymans committed
32
 * gst-launch -v filesrc location=videotestsrc.ogg ! oggdemux ! theoradec ! xvimagesink
33
 * ]| This example pipeline will decode an ogg stream and decodes the theora video. Refer to
Wim Taymans's avatar
Wim Taymans committed
34 35 36 37 38 39
 * the theoraenc example to create the ogg file.
 * </refsect2>
 *
 * Last reviewed on 2006-03-01 (0.10.4)
 */

Benjamin Otte's avatar
Benjamin Otte committed
40 41 42 43
#ifdef HAVE_CONFIG_H
#  include "config.h"
#endif

Wim Taymans's avatar
Wim Taymans committed
44
#include "gsttheoradec.h"
Benjamin Otte's avatar
Benjamin Otte committed
45
#include <gst/tag/tag.h>
46
#include <gst/video/video.h>
Wim Taymans's avatar
Wim Taymans committed
47
#include <gst/video/gstvideometa.h>
48
#include <gst/video/gstvideopool.h>
Benjamin Otte's avatar
Benjamin Otte committed
49

Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
50
#define GST_CAT_DEFAULT theoradec_debug
51
GST_DEBUG_CATEGORY_STATIC (GST_CAT_DEFAULT);
Benjamin Otte's avatar
Benjamin Otte committed
52

Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
53
#define THEORA_DEF_CROP         TRUE
54 55 56 57 58
#define THEORA_DEF_TELEMETRY_MV 0
#define THEORA_DEF_TELEMETRY_MBMODE 0
#define THEORA_DEF_TELEMETRY_QI 0
#define THEORA_DEF_TELEMETRY_BITS 0

59 60
enum
{
61
  PROP_0,
62 63 64 65 66
  PROP_CROP,
  PROP_TELEMETRY_MV,
  PROP_TELEMETRY_MBMODE,
  PROP_TELEMETRY_QI,
  PROP_TELEMETRY_BITS
67 68
};

Benjamin Otte's avatar
Benjamin Otte committed
69
static GstStaticPadTemplate theora_dec_src_factory =
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
70 71 72
GST_STATIC_PAD_TEMPLATE ("src",
    GST_PAD_SRC,
    GST_PAD_ALWAYS,
73 74
    GST_STATIC_CAPS ("video/x-raw, "
        "format = (string) { I420, Y42B, Y444 }, "
75
        "framerate = (fraction) [0/1, MAX], "
76
        "width = (int) [ 1, MAX ], " "height = (int) [ 1, MAX ]")
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
77
    );
Benjamin Otte's avatar
Benjamin Otte committed
78 79

static GstStaticPadTemplate theora_dec_sink_factory =
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
80 81 82 83 84
GST_STATIC_PAD_TEMPLATE ("sink",
    GST_PAD_SINK,
    GST_PAD_ALWAYS,
    GST_STATIC_CAPS ("video/x-theora")
    );
Benjamin Otte's avatar
Benjamin Otte committed
85

86 87
#define gst_theora_dec_parent_class parent_class
G_DEFINE_TYPE (GstTheoraDec, gst_theora_dec, GST_TYPE_ELEMENT);
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
88

89 90 91 92 93
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);

94
static gboolean theora_dec_setcaps (GstTheoraDec * dec, GstCaps * caps);
95 96
static gboolean theora_dec_sink_event (GstPad * pad, GstEvent * event);
static GstFlowReturn theora_dec_chain (GstPad * pad, GstBuffer * buffer);
97 98
static GstStateChangeReturn theora_dec_change_state (GstElement * element,
    GstStateChange transition);
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
99
static gboolean theora_dec_src_event (GstPad * pad, GstEvent * event);
100
static gboolean theora_dec_src_query (GstPad * pad, GstQuery * query);
101 102 103
static gboolean theora_dec_src_convert (GstPad * pad,
    GstFormat src_format, gint64 src_value,
    GstFormat * dest_format, gint64 * dest_value);
Wim Taymans's avatar
Wim Taymans committed
104 105

#if 0
106
static const GstFormat *theora_get_formats (GstPad * pad);
Wim Taymans's avatar
Wim Taymans committed
107 108
#endif
#if 0
109
static const GstEventMask *theora_get_event_masks (GstPad * pad);
Wim Taymans's avatar
Wim Taymans committed
110
#endif
Benjamin Otte's avatar
Benjamin Otte committed
111

112 113 114 115 116 117 118
static gboolean
gst_theora_dec_ctl_is_supported (int req)
{
  /* should return TH_EFAULT or TH_EINVAL if supported, and TH_EIMPL if not */
  return (th_decode_ctl (NULL, req, NULL, 0) != TH_EIMPL);
}

Benjamin Otte's avatar
Benjamin Otte committed
119
static void
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
120
gst_theora_dec_class_init (GstTheoraDecClass * klass)
Benjamin Otte's avatar
Benjamin Otte committed
121
{
122
  GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
Benjamin Otte's avatar
Benjamin Otte committed
123 124
  GstElementClass *gstelement_class = GST_ELEMENT_CLASS (klass);

125 126 127
  gobject_class->set_property = theora_dec_set_property;
  gobject_class->get_property = theora_dec_get_property;

128
  g_object_class_install_property (gobject_class, PROP_CROP,
129 130
      g_param_spec_boolean ("crop", "Crop",
          "Crop the image to the visible region", THEORA_DEF_CROP,
131
          (GParamFlags) G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
132

133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175
  if (gst_theora_dec_ctl_is_supported (TH_DECCTL_SET_TELEMETRY_MV)) {
    g_object_class_install_property (gobject_class, PROP_TELEMETRY_MV,
        g_param_spec_int ("visualize-motion-vectors",
            "Visualize motion vectors",
            "Show motion vector selection overlaid on image. "
            "Value gives a mask for motion vector (MV) modes to show",
            0, 0xffff, THEORA_DEF_TELEMETRY_MV,
            G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
  }

  if (gst_theora_dec_ctl_is_supported (TH_DECCTL_SET_TELEMETRY_MBMODE)) {
    g_object_class_install_property (gobject_class, PROP_TELEMETRY_MBMODE,
        g_param_spec_int ("visualize-macroblock-modes",
            "Visualize macroblock modes",
            "Show macroblock mode selection overlaid on image. "
            "Value gives a mask for macroblock (MB) modes to show",
            0, 0xffff, THEORA_DEF_TELEMETRY_MBMODE,
            G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
  }

  if (gst_theora_dec_ctl_is_supported (TH_DECCTL_SET_TELEMETRY_QI)) {
    g_object_class_install_property (gobject_class, PROP_TELEMETRY_QI,
        g_param_spec_int ("visualize-quantization-modes",
            "Visualize adaptive quantization modes",
            "Show adaptive quantization mode selection overlaid on image. "
            "Value gives a mask for quantization (QI) modes to show",
            0, 0xffff, THEORA_DEF_TELEMETRY_QI,
            G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
  }

  if (gst_theora_dec_ctl_is_supported (TH_DECCTL_SET_TELEMETRY_BITS)) {
    /* FIXME: make this a boolean instead? The value scales the bars so
     * they're less wide. Default is to use full width, and anything else
     * doesn't seem particularly useful, since the smaller bars just disappear
     * then (they almost disappear for a value of 2 already). */
    g_object_class_install_property (gobject_class, PROP_TELEMETRY_BITS,
        g_param_spec_int ("visualize-bit-usage",
            "Visualize bitstream usage breakdown",
            "Sets the bitstream breakdown visualization mode. "
            "Values influence the width of the bit usage bars to show",
            0, 0xff, THEORA_DEF_TELEMETRY_BITS,
            G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
  }
176

177 178 179 180 181 182 183 184 185
  gst_element_class_add_pad_template (gstelement_class,
      gst_static_pad_template_get (&theora_dec_src_factory));
  gst_element_class_add_pad_template (gstelement_class,
      gst_static_pad_template_get (&theora_dec_sink_factory));
  gst_element_class_set_details_simple (gstelement_class,
      "Theora video decoder", "Codec/Decoder/Video",
      "decode raw theora streams to raw YUV video",
      "Benjamin Otte <otte@gnome.org>, Wim Taymans <wim@fluendo.com>");

Benjamin Otte's avatar
Benjamin Otte committed
186
  gstelement_class->change_state = theora_dec_change_state;
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
187 188

  GST_DEBUG_CATEGORY_INIT (theoradec_debug, "theoradec", 0, "Theora decoder");
Benjamin Otte's avatar
Benjamin Otte committed
189 190 191
}

static void
192
gst_theora_dec_init (GstTheoraDec * dec)
Benjamin Otte's avatar
Benjamin Otte committed
193
{
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
194
  dec->sinkpad =
195
      gst_pad_new_from_static_template (&theora_dec_sink_factory, "sink");
196
  gst_pad_set_event_function (dec->sinkpad, theora_dec_sink_event);
Benjamin Otte's avatar
Benjamin Otte committed
197 198 199
  gst_pad_set_chain_function (dec->sinkpad, theora_dec_chain);
  gst_element_add_pad (GST_ELEMENT (dec), dec->sinkpad);

Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
200
  dec->srcpad =
201
      gst_pad_new_from_static_template (&theora_dec_src_factory, "src");
Benjamin Otte's avatar
Benjamin Otte committed
202
  gst_pad_set_event_function (dec->srcpad, theora_dec_src_event);
203
  gst_pad_set_query_function (dec->srcpad, theora_dec_src_query);
204
  gst_pad_use_fixed_caps (dec->srcpad);
205

Benjamin Otte's avatar
Benjamin Otte committed
206 207
  gst_element_add_pad (GST_ELEMENT (dec), dec->srcpad);

208
  dec->crop = THEORA_DEF_CROP;
209 210 211 212
  dec->telemetry_mv = THEORA_DEF_TELEMETRY_MV;
  dec->telemetry_mbmode = THEORA_DEF_TELEMETRY_MBMODE;
  dec->telemetry_qi = THEORA_DEF_TELEMETRY_QI;
  dec->telemetry_bits = THEORA_DEF_TELEMETRY_BITS;
213 214
  dec->gather = NULL;
  dec->decode = NULL;
215
  dec->queued = NULL;
Wim Taymans's avatar
Wim Taymans committed
216
  dec->pendingevents = NULL;
Benjamin Otte's avatar
Benjamin Otte committed
217
}
218

219 220 221 222 223
static void
gst_theora_dec_reset (GstTheoraDec * dec)
{
  dec->need_keyframe = TRUE;
  dec->last_timestamp = -1;
224 225
  dec->discont = TRUE;
  dec->frame_nr = -1;
Wim Taymans's avatar
Wim Taymans committed
226
  dec->seqnum = gst_util_seqnum_next ();
227 228
  dec->dropped = 0;
  dec->processed = 0;
229 230 231 232 233 234
  gst_segment_init (&dec->segment, GST_FORMAT_TIME);

  GST_OBJECT_LOCK (dec);
  dec->proportion = 1.0;
  dec->earliest_time = -1;
  GST_OBJECT_UNLOCK (dec);
235

236
  g_list_foreach (dec->queued, (GFunc) gst_mini_object_unref, NULL);
237 238
  g_list_free (dec->queued);
  dec->queued = NULL;
239 240 241 242 243 244
  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;
Wim Taymans's avatar
Wim Taymans committed
245 246 247
  g_list_foreach (dec->pendingevents, (GFunc) gst_mini_object_unref, NULL);
  g_list_free (dec->pendingevents);
  dec->pendingevents = NULL;
248 249 250 251 252

  if (dec->tags) {
    gst_tag_list_free (dec->tags);
    dec->tags = NULL;
  }
253 254
}

Wim Taymans's avatar
Wim Taymans committed
255
#if 0
256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272
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);
}
Wim Taymans's avatar
Wim Taymans committed
273
#endif
274

Wim Taymans's avatar
Wim Taymans committed
275
#if 0
276 277 278 279 280 281 282 283 284 285
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;
}
Wim Taymans's avatar
Wim Taymans committed
286
#endif
287

288
static gboolean
289 290 291
theora_dec_src_convert (GstPad * pad,
    GstFormat src_format, gint64 src_value,
    GstFormat * dest_format, gint64 * dest_value)
292
{
293 294 295 296
  gboolean res = TRUE;
  GstTheoraDec *dec;
  guint64 scale = 1;

Wim Taymans's avatar
Wim Taymans committed
297 298 299 300 301
  if (src_format == *dest_format) {
    *dest_value = src_value;
    return TRUE;
  }

302 303 304 305 306 307
  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;

308 309 310 311
  switch (src_format) {
    case GST_FORMAT_BYTES:
      switch (*dest_format) {
        case GST_FORMAT_DEFAULT:
312
          *dest_value = gst_util_uint64_scale_int (src_value, 8,
313
              dec->info.pic_height * dec->info.pic_width * dec->output_bpp);
314 315 316 317 318 319 320
          break;
        case GST_FORMAT_TIME:
          /* seems like a rather silly conversion, implement me if you like */
        default:
          res = FALSE;
      }
      break;
321
    case GST_FORMAT_TIME:
322 323
      switch (*dest_format) {
        case GST_FORMAT_BYTES:
324 325 326
          scale =
              dec->output_bpp * (dec->info.pic_width * dec->info.pic_height) /
              8;
327
        case GST_FORMAT_DEFAULT:
328
          *dest_value = scale * gst_util_uint64_scale (src_value,
329
              dec->info.fps_numerator, dec->info.fps_denominator * GST_SECOND);
330 331 332 333
          break;
        default:
          res = FALSE;
      }
334 335
      break;
    case GST_FORMAT_DEFAULT:
336 337
      switch (*dest_format) {
        case GST_FORMAT_TIME:
338
          *dest_value = gst_util_uint64_scale (src_value,
339
              GST_SECOND * dec->info.fps_denominator, dec->info.fps_numerator);
340 341
          break;
        case GST_FORMAT_BYTES:
342
          *dest_value = gst_util_uint64_scale_int (src_value,
343
              dec->output_bpp * dec->info.pic_width * dec->info.pic_height, 8);
344 345 346 347
          break;
        default:
          res = FALSE;
      }
348 349
      break;
    default:
350
      res = FALSE;
351
  }
352 353
done:
  gst_object_unref (dec);
354
  return res;
355 356 357 358 359 360 361 362

  /* ERRORS */
no_header:
  {
    GST_DEBUG_OBJECT (dec, "no header yet, cannot convert");
    res = FALSE;
    goto done;
  }
363 364
}

Wim Taymans's avatar
Wim Taymans committed
365
#if 0
Benjamin Otte's avatar
Benjamin Otte committed
366
static gboolean
367 368 369
theora_dec_sink_convert (GstPad * pad,
    GstFormat src_format, gint64 src_value,
    GstFormat * dest_format, gint64 * dest_value)
Benjamin Otte's avatar
Benjamin Otte committed
370
{
371 372
  gboolean res = TRUE;
  GstTheoraDec *dec;
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
373

Wim Taymans's avatar
Wim Taymans committed
374 375 376 377 378
  if (src_format == *dest_format) {
    *dest_value = src_value;
    return TRUE;
  }

379 380 381 382 383 384
  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;

385
  switch (src_format) {
Benjamin Otte's avatar
Benjamin Otte committed
386
    case GST_FORMAT_DEFAULT:
387 388
      switch (*dest_format) {
        case GST_FORMAT_TIME:
389
          *dest_value = _theora_granule_start_time (dec, src_value);
390 391 392 393
          break;
        default:
          res = FALSE;
      }
394
      break;
395 396 397 398
    case GST_FORMAT_TIME:
      switch (*dest_format) {
        case GST_FORMAT_DEFAULT:
        {
399
          guint rest;
400

401
          /* framecount */
402
          *dest_value = gst_util_uint64_scale (src_value,
403
              dec->info.fps_numerator, GST_SECOND * dec->info.fps_denominator);
404 405

          /* funny way of calculating granulepos in theora */
406
          rest = *dest_value / dec->info.keyframe_granule_shift;
407
          *dest_value -= rest;
408
          *dest_value <<= dec->granule_shift;
409
          *dest_value += rest;
410 411 412 413 414 415 416
          break;
        }
        default:
          res = FALSE;
          break;
      }
      break;
Benjamin Otte's avatar
Benjamin Otte committed
417
    default:
418
      res = FALSE;
Benjamin Otte's avatar
Benjamin Otte committed
419
  }
420 421
done:
  gst_object_unref (dec);
422
  return res;
423 424 425 426 427 428 429 430

  /* ERRORS */
no_header:
  {
    GST_DEBUG_OBJECT (dec, "no header yet, cannot convert");
    res = FALSE;
    goto done;
  }
Benjamin Otte's avatar
Benjamin Otte committed
431
}
Wim Taymans's avatar
Wim Taymans committed
432
#endif
433 434

static gboolean
435
theora_dec_src_query (GstPad * pad, GstQuery * query)
436
{
437 438
  GstTheoraDec *dec;

Wim Taymans's avatar
Wim Taymans committed
439 440
  gboolean res = FALSE;

441 442
  dec = GST_THEORA_DEC (gst_pad_get_parent (pad));

443
  switch (GST_QUERY_TYPE (query)) {
Wim Taymans's avatar
Wim Taymans committed
444 445
    case GST_QUERY_POSITION:
    {
Wim Taymans's avatar
Wim Taymans committed
446
      gint64 value;
Wim Taymans's avatar
Wim Taymans committed
447
      GstFormat format;
Wim Taymans's avatar
Wim Taymans committed
448 449
      gint64 time;

Wim Taymans's avatar
Wim Taymans committed
450
      /* parse format */
451
      gst_query_parse_position (query, &format, NULL);
452

Wim Taymans's avatar
Wim Taymans committed
453
      time = dec->last_timestamp;
454
      time = gst_segment_to_stream_time (&dec->segment, GST_FORMAT_TIME, time);
455

456
      GST_LOG_OBJECT (dec,
457
          "query %p: our time: %" GST_TIME_FORMAT, query, GST_TIME_ARGS (time));
458

Wim Taymans's avatar
Wim Taymans committed
459
      if (!(res =
Wim Taymans's avatar
Wim Taymans committed
460 461
              theora_dec_src_convert (pad, GST_FORMAT_TIME, time, &format,
                  &value)))
Wim Taymans's avatar
Wim Taymans committed
462 463
        goto error;

464
      gst_query_set_position (query, format, value);
Wim Taymans's avatar
Wim Taymans committed
465 466

      GST_LOG_OBJECT (dec,
467
          "query %p: we return %" G_GINT64_FORMAT " (format %u)", query, value,
468
          format);
Wim Taymans's avatar
Wim Taymans committed
469 470
      break;
    }
Wim Taymans's avatar
Wim Taymans committed
471
    case GST_QUERY_DURATION:
472
    {
Wim Taymans's avatar
Wim Taymans committed
473
      /* forward to peer for total */
Wim Taymans's avatar
Wim Taymans committed
474
      res = gst_pad_peer_query (dec->sinkpad, query);
475
      if (!res)
Wim Taymans's avatar
Wim Taymans committed
476
        goto error;
477

Wim Taymans's avatar
Wim Taymans committed
478
      break;
479
    }
Wim Taymans's avatar
Wim Taymans committed
480 481 482 483 484
    case GST_QUERY_CONVERT:
    {
      GstFormat src_fmt, dest_fmt;
      gint64 src_val, dest_val;

485
      gst_query_parse_convert (query, &src_fmt, &src_val, &dest_fmt, &dest_val);
486
      if (!(res =
Wim Taymans's avatar
Wim Taymans committed
487 488
              theora_dec_src_convert (pad, src_fmt, src_val, &dest_fmt,
                  &dest_val)))
489 490
        goto error;

491
      gst_query_set_convert (query, src_fmt, src_val, dest_fmt, dest_val);
Wim Taymans's avatar
Wim Taymans committed
492 493 494
      break;
    }
    default:
495
      res = gst_pad_query_default (pad, query);
Wim Taymans's avatar
Wim Taymans committed
496
      break;
497
  }
498 499 500
done:
  gst_object_unref (dec);

501
  return res;
502

503
  /* ERRORS */
Wim Taymans's avatar
Wim Taymans committed
504
error:
505 506 507 508
  {
    GST_DEBUG_OBJECT (dec, "query failed");
    goto done;
  }
Wim Taymans's avatar
Wim Taymans committed
509 510
}

Benjamin Otte's avatar
Benjamin Otte committed
511
static gboolean
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
512
theora_dec_src_event (GstPad * pad, GstEvent * event)
Benjamin Otte's avatar
Benjamin Otte committed
513 514 515 516
{
  gboolean res = TRUE;
  GstTheoraDec *dec;

517
  dec = GST_THEORA_DEC (gst_pad_get_parent (pad));
Benjamin Otte's avatar
Benjamin Otte committed
518 519

  switch (GST_EVENT_TYPE (event)) {
520 521
    case GST_EVENT_SEEK:
    {
522 523
      GstFormat format, tformat;
      gdouble rate;
Scott Wheeler Wheeler's avatar
Scott Wheeler Wheeler committed
524
      GstEvent *real_seek;
525 526 527 528
      GstSeekFlags flags;
      GstSeekType cur_type, stop_type;
      gint64 cur, stop;
      gint64 tcur, tstop;
Wim Taymans's avatar
Wim Taymans committed
529
      guint32 seqnum;
530 531 532

      gst_event_parse_seek (event, &rate, &format, &flags, &cur_type, &cur,
          &stop_type, &stop);
Wim Taymans's avatar
Wim Taymans committed
533
      seqnum = gst_event_get_seqnum (event);
534
      gst_event_unref (event);
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
535

536 537 538 539 540 541
      /* we have to ask our peer to seek to time here as we know
       * nothing about how to generate a granulepos from the src
       * formats or anything.
       * 
       * First bring the requested format to time 
       */
542 543
      tformat = GST_FORMAT_TIME;
      if (!(res = theora_dec_src_convert (pad, format, cur, &tformat, &tcur)))
544
        goto convert_error;
545
      if (!(res = theora_dec_src_convert (pad, format, stop, &tformat, &tstop)))
546
        goto convert_error;
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
547

548
      /* then seek with time on the peer */
549 550
      real_seek = gst_event_new_seek (rate, GST_FORMAT_TIME,
          flags, cur_type, tcur, stop_type, tstop);
Wim Taymans's avatar
Wim Taymans committed
551
      gst_event_set_seqnum (real_seek, seqnum);
552

553
      res = gst_pad_push_event (dec->sinkpad, real_seek);
Benjamin Otte's avatar
Benjamin Otte committed
554 555
      break;
    }
556 557 558 559 560 561
    case GST_EVENT_QOS:
    {
      gdouble proportion;
      GstClockTimeDiff diff;
      GstClockTime timestamp;

Wim Taymans's avatar
Wim Taymans committed
562
      gst_event_parse_qos (event, NULL, &proportion, &diff, &timestamp);
563 564 565

      /* we cannot randomly skip frame decoding since we don't have
       * B frames. we can however use the timestamp and diff to not
566 567
       * push late frames. This would at least save us the time to
       * crop/memcpy the data. */
568 569 570 571 572
      GST_OBJECT_LOCK (dec);
      dec->proportion = proportion;
      dec->earliest_time = timestamp + diff;
      GST_OBJECT_UNLOCK (dec);

573 574 575
      GST_DEBUG_OBJECT (dec, "got QoS %" GST_TIME_FORMAT ", %" G_GINT64_FORMAT,
          GST_TIME_ARGS (timestamp), diff);

576
      res = gst_pad_push_event (dec->sinkpad, event);
577 578
      break;
    }
Benjamin Otte's avatar
Benjamin Otte committed
579
    default:
580
      res = gst_pad_push_event (dec->sinkpad, event);
Benjamin Otte's avatar
Benjamin Otte committed
581 582
      break;
  }
583 584
done:
  gst_object_unref (dec);
Benjamin Otte's avatar
Benjamin Otte committed
585 586

  return res;
587

588 589 590 591 592 593
  /* ERRORS */
convert_error:
  {
    GST_DEBUG_OBJECT (dec, "could not convert format");
    goto done;
  }
594 595
}

596 597
static gboolean
theora_dec_sink_event (GstPad * pad, GstEvent * event)
Benjamin Otte's avatar
Benjamin Otte committed
598
{
599
  gboolean ret = FALSE;
600 601
  GstTheoraDec *dec;

Wim Taymans's avatar
Wim Taymans committed
602
  dec = GST_THEORA_DEC (gst_pad_get_parent (pad));
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
603

Benjamin Otte's avatar
Benjamin Otte committed
604 605
  GST_LOG_OBJECT (dec, "handling event");
  switch (GST_EVENT_TYPE (event)) {
606 607 608 609 610 611 612
    case GST_EVENT_FLUSH_START:
      ret = gst_pad_push_event (dec->srcpad, event);
      break;
    case GST_EVENT_FLUSH_STOP:
      gst_theora_dec_reset (dec);
      ret = gst_pad_push_event (dec->srcpad, event);
      break;
Wim Taymans's avatar
Wim Taymans committed
613 614 615
    case GST_EVENT_EOS:
      ret = gst_pad_push_event (dec->srcpad, event);
      break;
Wim Taymans's avatar
Wim Taymans committed
616
    case GST_EVENT_SEGMENT:
617
    {
618
      const GstSegment *segment;
619

Wim Taymans's avatar
Wim Taymans committed
620
      gst_event_parse_segment (event, &segment);
621

622
      /* we need TIME format */
623
      if (segment->format != GST_FORMAT_TIME)
624 625
        goto newseg_wrong_format;

626
      GST_DEBUG_OBJECT (dec, "segment: %" GST_SEGMENT_FORMAT, segment);
627

628
      /* now configure the values */
629
      gst_segment_copy_into (segment, &dec->segment);
Wim Taymans's avatar
Wim Taymans committed
630
      dec->seqnum = gst_event_get_seqnum (event);
631

Wim Taymans's avatar
Wim Taymans committed
632
      /* We don't forward this unless/until the decoder is initialised */
633 634 635
      if (dec->have_header) {
        ret = gst_pad_push_event (dec->srcpad, event);
      } else {
Wim Taymans's avatar
Wim Taymans committed
636
        dec->pendingevents = g_list_append (dec->pendingevents, event);
637 638
        ret = TRUE;
      }
Benjamin Otte's avatar
Benjamin Otte committed
639
      break;
640
    }
641 642 643 644 645 646
    case GST_EVENT_CAPS:
    {
      GstCaps *caps;

      gst_event_parse_caps (event, &caps);
      ret = theora_dec_setcaps (dec, caps);
Wim Taymans's avatar
Wim Taymans committed
647
      gst_event_unref (event);
648 649
      break;
    }
650 651 652 653 654 655 656 657 658 659 660 661
    case GST_EVENT_TAG:
    {
      if (dec->have_header)
        /* and forward */
        ret = gst_pad_push_event (dec->srcpad, event);
      else {
        /* store it to send once we're initialized */
        dec->pendingevents = g_list_append (dec->pendingevents, event);
        ret = TRUE;
      }
      break;
    }
Benjamin Otte's avatar
Benjamin Otte committed
662
    default:
663
      ret = gst_pad_event_default (pad, event);
Benjamin Otte's avatar
Benjamin Otte committed
664 665
      break;
  }
666
done:
Wim Taymans's avatar
Wim Taymans committed
667 668
  gst_object_unref (dec);

669
  return ret;
670 671 672 673

  /* ERRORS */
newseg_wrong_format:
  {
674
    GST_DEBUG_OBJECT (dec, "received non TIME newsegment");
675
    gst_event_unref (event);
676 677
    goto done;
  }
Benjamin Otte's avatar
Benjamin Otte committed
678 679
}

680
static gboolean
681
theora_dec_setcaps (GstTheoraDec * dec, GstCaps * caps)
682 683
{
  GstStructure *s;
684
  const GValue *codec_data;
685 686 687 688 689 690 691

  s = gst_caps_get_structure (caps, 0);

  /* parse the par, this overrides the encoded par */
  dec->have_par = gst_structure_get_fraction (s, "pixel-aspect-ratio",
      &dec->par_num, &dec->par_den);

692 693 694
  if ((codec_data = gst_structure_get_value (s, "codec_data"))) {
    if (G_VALUE_TYPE (codec_data) == GST_TYPE_BUFFER) {
      GstBuffer *buffer;
695 696
      guint8 *data, *ptr;
      gsize size, left;
697 698 699 700 701
      guint offset;

      buffer = gst_value_get_buffer (codec_data);

      offset = 0;
702
      data = gst_buffer_map (buffer, &size, NULL, GST_MAP_READ);
703

704 705 706 707
      ptr = data;
      left = size;

      while (left > 2) {
708 709 710
        guint psize;
        GstBuffer *buf;

711
        psize = (ptr[0] << 8) | ptr[1];
712
        /* skip header */
713 714
        ptr += 2;
        left -= 2;
715 716 717
        offset += 2;

        /* make sure we don't read too much */
718
        psize = MIN (psize, left);
719

Wim Taymans's avatar
Wim Taymans committed
720 721
        buf =
            gst_buffer_copy_region (buffer, GST_BUFFER_COPY_ALL, offset, psize);
722 723 724 725 726 727

        /* first buffer is a discont buffer */
        if (offset == 2)
          GST_BUFFER_FLAG_SET (buf, GST_BUFFER_FLAG_DISCONT);

        /* now feed it to the decoder we can ignore the error */
728
        theora_dec_chain (dec->sinkpad, buf);
729 730

        /* skip the data */
731 732
        left -= psize;
        ptr += psize;
733 734
        offset += psize;
      }
735
      gst_buffer_unmap (buffer, data, size);
736 737 738
    }
  }

739 740 741
  return TRUE;
}

742
static GstFlowReturn
743
theora_handle_comment_packet (GstTheoraDec * dec, ogg_packet * packet)
Benjamin Otte's avatar
Benjamin Otte committed
744
{
745 746 747
  gchar *encoder = NULL;
  GstTagList *list;

748
  GST_DEBUG_OBJECT (dec, "parsing comment packet");
749

750
  list =
751 752
      gst_tag_list_from_vorbiscomment (packet->packet, packet->bytes,
      (guint8 *) "\201theora", 7, &encoder);
753 754 755

  if (!list) {
    GST_ERROR_OBJECT (dec, "couldn't decode comments");
756
    list = gst_tag_list_new_empty ();
757 758 759 760 761 762 763 764 765 766
  }
  if (encoder) {
    gst_tag_list_add (list, GST_TAG_MERGE_REPLACE,
        GST_TAG_ENCODER, encoder, NULL);
    g_free (encoder);
  }
  gst_tag_list_add (list, GST_TAG_MERGE_REPLACE,
      GST_TAG_ENCODER_VERSION, dec->info.version_major,
      GST_TAG_VIDEO_CODEC, "Theora", NULL);

767 768 769 770 771 772
  if (dec->info.target_bitrate > 0) {
    gst_tag_list_add (list, GST_TAG_MERGE_REPLACE,
        GST_TAG_BITRATE, dec->info.target_bitrate,
        GST_TAG_NOMINAL_BITRATE, dec->info.target_bitrate, NULL);
  }

773
  dec->tags = list;
774 775 776 777

  return GST_FLOW_OK;
}

Wim Taymans's avatar
Wim Taymans committed
778
static GstFlowReturn
Wim Taymans's avatar
Wim Taymans committed
779
theora_negotiate_pool (GstTheoraDec * dec, GstCaps * caps, GstVideoInfo * info)
Wim Taymans's avatar
Wim Taymans committed
780 781 782
{
  GstQuery *query;
  GstBufferPool *pool = NULL;
783
  guint size, min, max, prefix, alignment;
784
  GstStructure *config;
Wim Taymans's avatar
Wim Taymans committed
785 786 787 788

  /* find a pool for the negotiated caps now */
  query = gst_query_new_allocation (caps, TRUE);

789
  if (gst_pad_peer_query (dec->srcpad, query)) {
Wim Taymans's avatar
Wim Taymans committed
790 791
    GST_DEBUG_OBJECT (dec, "got downstream ALLOCATION hints");
    /* we got configuration from our peer, parse them */
792 793
    gst_query_parse_allocation_params (query, &size, &min, &max, &prefix,
        &alignment, &pool);
Wim Taymans's avatar
the  
Wim Taymans committed
794
    size = MAX (size, info->size);
Wim Taymans's avatar
Wim Taymans committed
795 796
  } else {
    GST_DEBUG_OBJECT (dec, "didn't get downstream ALLOCATION hints");
Wim Taymans's avatar
the  
Wim Taymans committed
797
    size = info->size;
798 799
    min = max = 0;
    prefix = 0;
Wim Taymans's avatar
Wim Taymans committed
800
    alignment = 0;
Wim Taymans's avatar
Wim Taymans committed
801 802 803 804 805 806 807 808 809 810 811
  }

  if (pool == NULL) {
    /* we did not get a pool, make one ourselves then */
    pool = gst_buffer_pool_new ();
  }

  if (dec->pool)
    gst_object_unref (dec->pool);
  dec->pool = pool;

812 813
  config = gst_buffer_pool_get_config (pool);
  gst_buffer_pool_config_set (config, caps, size, min, max, prefix, alignment);
814
  /* just set the option, if the pool can support it we will transparently use
815
   * it through the video info API. We could also see if the pool support this
816
   * option and only activate it then. */
Wim Taymans's avatar
Wim Taymans committed
817
  gst_buffer_pool_config_add_option (config, GST_BUFFER_POOL_OPTION_VIDEO_META);
818

Wim Taymans's avatar
Wim Taymans committed
819 820
  /* check if downstream supports cropping */
  dec->use_cropping =
Wim Taymans's avatar
Wim Taymans committed
821
      gst_query_has_allocation_meta (query, GST_VIDEO_CROP_META_API);
Wim Taymans's avatar
Wim Taymans committed
822

Wim Taymans's avatar
Wim Taymans committed
823
  gst_buffer_pool_set_config (pool, config);
Wim Taymans's avatar
Wim Taymans committed
824 825 826
  /* and activate */
  gst_buffer_pool_set_active (pool, TRUE);

Wim Taymans's avatar
Wim Taymans committed
827 828
  gst_query_unref (query);

Wim Taymans's avatar
Wim Taymans committed
829 830 831
  return GST_FLOW_OK;
}

832 833 834 835
static GstFlowReturn
theora_handle_type_packet (GstTheoraDec * dec, ogg_packet * packet)
{
  GstCaps *caps;
Wim Taymans's avatar
Wim Taymans committed
836 837
  GstVideoFormat format;
  gint width, height;
838
  gint par_num, par_den;
839
  GstFlowReturn ret = GST_FLOW_OK;
Wim Taymans's avatar
Wim Taymans committed
840
  GList *walk;
841 842 843 844 845 846 847

  GST_DEBUG_OBJECT (dec, "fps %d/%d, PAR %d/%d",
      dec->info.fps_numerator, dec->info.fps_denominator,
      dec->info.aspect_numerator, dec->info.aspect_denominator);

  /* calculate par
   * the info.aspect_* values reflect PAR;
848
   * 0:x and x:0 are allowed and can be interpreted as 1:1.
849
   */
850 851 852 853 854 855 856 857 858 859
  if (dec->have_par) {
    /* we had a par on the sink caps, override the encoded par */
    GST_DEBUG_OBJECT (dec, "overriding with input PAR");
    par_num = dec->par_num;
    par_den = dec->par_den;
  } else {
    /* take encoded par */
    par_num = dec->info.aspect_numerator;
    par_den = dec->info.aspect_denominator;
  }
860
  if (par_num == 0 || par_den == 0) {
861 862 863 864 865
    par_num = par_den = 1;
  }
  /* theora has:
   *
   *  width/height : dimension of the encoded frame 
866 867
   *  pic_width/pic_height : dimension of the visible part
   *  pic_x/pic_y : offset in encoded frame where visible part starts
868
   */
869 870
  GST_DEBUG_OBJECT (dec, "dimension %dx%d, PAR %d/%d", dec->info.pic_width,
      dec->info.pic_height, par_num, par_den);
871
  GST_DEBUG_OBJECT (dec, "frame dimension %dx%d, offset %d:%d",
872 873
      dec->info.pic_width, dec->info.pic_height,
      dec->info.pic_x, dec->info.pic_y);
874

Wim Taymans's avatar
Wim Taymans committed
875 876 877
  switch (dec->info.pixel_fmt) {
    case TH_PF_444:
      dec->output_bpp = 24;
Wim Taymans's avatar
Wim Taymans committed
878
      format = GST_VIDEO_FORMAT_Y444;
Wim Taymans's avatar
Wim Taymans committed
879 880 881
      break;
    case TH_PF_420:
      dec->output_bpp = 12;     /* Average bits per pixel. */
Wim Taymans's avatar
Wim Taymans committed
882
      format = GST_VIDEO_FORMAT_I420;
Wim Taymans's avatar
Wim Taymans committed
883 884 885
      break;
    case TH_PF_422:
      dec->output_bpp = 16;
Wim Taymans's avatar
Wim Taymans committed
886
      format = GST_VIDEO_FORMAT_Y42B;
Wim Taymans's avatar
Wim Taymans committed
887 888 889
      break;
    default:
      goto invalid_format;
890
  }
891 892

  if (dec->crop) {
Wim Taymans's avatar
Wim Taymans committed
893 894
    width = dec->info.pic_width;
    height = dec->info.pic_height;
895 896 897 898 899 900 901 902 903 904 905 906 907
    dec->offset_x = dec->info.pic_x;
    dec->offset_y = dec->info.pic_y;
    /* Ensure correct offsets in chroma for formats that need it
     * by rounding the offset. libtheora will add proper pixels,
     * so no need to handle them ourselves. */
    if (dec->offset_x & 1 && dec->info.pixel_fmt != TH_PF_444) {
      dec->offset_x--;
    }
    if (dec->offset_y & 1 && dec->info.pixel_fmt == TH_PF_420) {
      dec->offset_y--;
    }
  } else {
    /* no cropping, use the encoded dimensions */