theoradec.c 32.8 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 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43
/**
 * 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)
 */

Benjamin Otte's avatar
Benjamin Otte committed
44 45 46 47
#ifdef HAVE_CONFIG_H
#  include "config.h"
#endif

Wim Taymans's avatar
Wim Taymans committed
48
#include "gsttheoradec.h"
Benjamin Otte's avatar
Benjamin Otte committed
49 50
#include <gst/tag/tag.h>

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

Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
54
#define THEORA_DEF_CROP         TRUE
55 56 57 58 59 60
enum
{
  ARG_0,
  ARG_CROP
};

Stefan Kost's avatar
Stefan Kost committed
61
static const GstElementDetails theora_dec_details =
j^'s avatar
j^ committed
62
GST_ELEMENT_DETAILS ("Theora video decoder",
63 64 65 66
    "Codec/Decoder/Video",
    "decode raw theora streams to raw YUV video",
    "Benjamin Otte <in7y118@public.uni-hamburg.de>, "
    "Wim Taymans <wim@fluendo.com>");
Benjamin Otte's avatar
Benjamin Otte committed
67 68

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

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

GST_BOILERPLATE (GstTheoraDec, gst_theora_dec, GstElement, GST_TYPE_ELEMENT);
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
86

87 88 89 90 91
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);

92 93
static gboolean theora_dec_sink_event (GstPad * pad, GstEvent * event);
static GstFlowReturn theora_dec_chain (GstPad * pad, GstBuffer * buffer);
94 95
static GstStateChangeReturn theora_dec_change_state (GstElement * element,
    GstStateChange transition);
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
96
static gboolean theora_dec_src_event (GstPad * pad, GstEvent * event);
Wim Taymans's avatar
Wim Taymans committed
97
static gboolean theora_dec_src_query (GstPad * pad, GstQuery * query);
98 99 100 101 102 103
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);
Wim Taymans's avatar
Wim Taymans committed
104 105 106
static gboolean theora_dec_sink_query (GstPad * pad, GstQuery * query);

#if 0
107
static const GstFormat *theora_get_formats (GstPad * pad);
Wim Taymans's avatar
Wim Taymans committed
108 109
#endif
#if 0
110
static const GstEventMask *theora_get_event_masks (GstPad * pad);
Wim Taymans's avatar
Wim Taymans committed
111
#endif
112
static const GstQueryType *theora_get_query_types (GstPad * pad);
Benjamin Otte's avatar
Benjamin Otte committed
113 114 115 116 117 118


static void
gst_theora_dec_base_init (gpointer g_class)
{
  GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
119 120

  gst_element_class_add_pad_template (element_class,
Benjamin Otte's avatar
Benjamin Otte committed
121 122 123 124 125 126 127
      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
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
128
gst_theora_dec_class_init (GstTheoraDecClass * klass)
Benjamin Otte's avatar
Benjamin Otte committed
129
{
130
  GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
Benjamin Otte's avatar
Benjamin Otte committed
131 132
  GstElementClass *gstelement_class = GST_ELEMENT_CLASS (klass);

133 134 135 136 137 138 139 140
  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));

Benjamin Otte's avatar
Benjamin Otte committed
141
  gstelement_class->change_state = theora_dec_change_state;
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
142 143

  GST_DEBUG_CATEGORY_INIT (theoradec_debug, "theoradec", 0, "Theora decoder");
Benjamin Otte's avatar
Benjamin Otte committed
144 145 146
}

static void
147
gst_theora_dec_init (GstTheoraDec * dec, GstTheoraDecClass * g_class)
Benjamin Otte's avatar
Benjamin Otte committed
148
{
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
149
  dec->sinkpad =
150
      gst_pad_new_from_static_template (&theora_dec_sink_factory, "sink");
Wim Taymans's avatar
Wim Taymans committed
151
  gst_pad_set_query_function (dec->sinkpad, theora_dec_sink_query);
152
  gst_pad_set_event_function (dec->sinkpad, theora_dec_sink_event);
Benjamin Otte's avatar
Benjamin Otte committed
153 154 155
  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
156
  dec->srcpad =
157
      gst_pad_new_from_static_template (&theora_dec_src_factory, "src");
Benjamin Otte's avatar
Benjamin Otte committed
158
  gst_pad_set_event_function (dec->srcpad, theora_dec_src_event);
159
  gst_pad_set_query_type_function (dec->srcpad, theora_get_query_types);
160
  gst_pad_set_query_function (dec->srcpad, theora_dec_src_query);
161
  gst_pad_use_fixed_caps (dec->srcpad);
162

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

165
  dec->crop = THEORA_DEF_CROP;
166
  dec->queued = NULL;
Benjamin Otte's avatar
Benjamin Otte committed
167
}
168

169 170 171 172 173 174
static void
gst_theora_dec_reset (GstTheoraDec * dec)
{
  dec->need_keyframe = TRUE;
  dec->last_timestamp = -1;
  dec->granulepos = -1;
175 176
  dec->discont = TRUE;
  dec->frame_nr = -1;
177 178 179 180 181 182 183 184
  gst_segment_init (&dec->segment, GST_FORMAT_TIME);

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

Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
185 186 187 188 189 190
static int
_theora_ilog (unsigned int v)
{
  int ret = 0;

  while (v) {
191
    ret++;
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
192
    v >>= 1;
193
  }
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
194
  return (ret);
195 196
}

197 198
static gint64
_theora_granule_frame (GstTheoraDec * dec, gint64 granulepos)
199 200 201 202
{
  guint ilog;
  gint framecount;

203 204
  if (granulepos == -1)
    return -1;
205

206
  ilog = dec->granule_shift;
207

208 209 210 211
  /* granulepos is last ilog bits for counting pframes since last iframe and 
   * bits in front of that for the framenumber of the last iframe. */
  framecount = granulepos >> ilog;
  framecount += granulepos - (framecount << ilog);
212 213 214

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

215 216 217 218 219 220 221 222
  return framecount;
}

static GstClockTime
_theora_granule_time (GstTheoraDec * dec, gint64 granulepos)
{
  gint framecount;

223
  /* invalid granule results in invalid time */
224 225 226
  if (granulepos == -1)
    return -1;

227
  /* get framecount */
228
  framecount = _theora_granule_frame (dec, granulepos);
229 230 231 232 233 234 235 236 237 238 239 240

  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;
241

242 243 244
  framecount = _theora_granule_frame (dec, granulepos);

  return (framecount + 1) << dec->granule_shift;
245 246
}

Wim Taymans's avatar
Wim Taymans committed
247
#if 0
248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264
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
265
#endif
266

Wim Taymans's avatar
Wim Taymans committed
267
#if 0
268 269 270 271 272 273 274 275 276 277
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
278
#endif
279 280 281 282 283 284

static const GstQueryType *
theora_get_query_types (GstPad * pad)
{
  static const GstQueryType theora_src_query_types[] = {
    GST_QUERY_POSITION,
285 286
    GST_QUERY_DURATION,
    GST_QUERY_CONVERT,
287 288 289 290 291 292 293
    0
  };

  return theora_src_query_types;
}


294
static gboolean
295 296 297
theora_dec_src_convert (GstPad * pad,
    GstFormat src_format, gint64 src_value,
    GstFormat * dest_format, gint64 * dest_value)
298
{
299 300 301 302
  gboolean res = TRUE;
  GstTheoraDec *dec;
  guint64 scale = 1;

Wim Taymans's avatar
Wim Taymans committed
303 304 305 306 307
  if (src_format == *dest_format) {
    *dest_value = src_value;
    return TRUE;
  }

308 309 310 311 312 313
  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;

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

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

Benjamin Otte's avatar
Benjamin Otte committed
369
static gboolean
370 371 372
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
373
{
374 375
  gboolean res = TRUE;
  GstTheoraDec *dec;
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
376

Wim Taymans's avatar
Wim Taymans committed
377 378 379 380 381
  if (src_format == *dest_format) {
    *dest_value = src_value;
    return TRUE;
  }

382 383 384 385 386 387
  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;

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

404
          /* framecount */
405
          *dest_value = gst_util_uint64_scale (src_value,
406
              dec->info.fps_numerator, GST_SECOND * dec->info.fps_denominator);
407 408 409 410

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

  /* ERRORS */
no_header:
  {
    GST_DEBUG_OBJECT (dec, "no header yet, cannot convert");
    res = FALSE;
    goto done;
  }
Benjamin Otte's avatar
Benjamin Otte committed
434
}
435 436

static gboolean
Wim Taymans's avatar
Wim Taymans committed
437
theora_dec_src_query (GstPad * pad, GstQuery * query)
438
{
439 440
  GstTheoraDec *dec;

Wim Taymans's avatar
Wim Taymans committed
441 442
  gboolean res = FALSE;

443 444
  dec = GST_THEORA_DEC (gst_pad_get_parent (pad));

Wim Taymans's avatar
Wim Taymans committed
445 446 447
  switch (GST_QUERY_TYPE (query)) {
    case GST_QUERY_POSITION:
    {
Wim Taymans's avatar
Wim Taymans committed
448
      gint64 granulepos, value;
Wim Taymans's avatar
Wim Taymans committed
449 450 451 452 453 454
      GstFormat my_format, format;
      gint64 time;

      /* we can convert a granule position to everything */
      granulepos = dec->granulepos;

455 456 457
      GST_LOG_OBJECT (dec,
          "query %p: we have current granule: %lld", query, granulepos);

Wim Taymans's avatar
Wim Taymans committed
458 459
      /* parse format */
      gst_query_parse_position (query, &format, NULL);
460

Wim Taymans's avatar
Wim Taymans committed
461 462 463 464 465 466 467 468
      /* 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;

469
      time = (time - dec->segment.start) + dec->segment.time;
470

471 472 473
      GST_LOG_OBJECT (dec,
          "query %p: our time: %" GST_TIME_FORMAT, query, GST_TIME_ARGS (time));

Wim Taymans's avatar
Wim Taymans committed
474 475 476 477
      if (!(res =
              theora_dec_src_convert (pad, my_format, time, &format, &value)))
        goto error;

Wim Taymans's avatar
Wim Taymans committed
478
      gst_query_set_position (query, format, value);
Wim Taymans's avatar
Wim Taymans committed
479 480

      GST_LOG_OBJECT (dec,
Wim Taymans's avatar
Wim Taymans committed
481
          "query %p: we return %lld (format %u)", query, value, format);
Wim Taymans's avatar
Wim Taymans committed
482 483 484

      break;
    }
Wim Taymans's avatar
Wim Taymans committed
485 486 487 488 489
    case GST_QUERY_DURATION:
      /* forward to peer for total */
      if (!(res = gst_pad_query (GST_PAD_PEER (dec->sinkpad), query)))
        goto error;
      break;
Wim Taymans's avatar
Wim Taymans committed
490 491 492 493 494 495
    case GST_QUERY_CONVERT:
    {
      GstFormat src_fmt, dest_fmt;
      gint64 src_val, dest_val;

      gst_query_parse_convert (query, &src_fmt, &src_val, &dest_fmt, &dest_val);
496
      if (!(res =
Wim Taymans's avatar
Wim Taymans committed
497 498
              theora_dec_src_convert (pad, src_fmt, src_val, &dest_fmt,
                  &dest_val)))
499 500 501
        goto error;

      gst_query_set_convert (query, src_fmt, src_val, dest_fmt, dest_val);
Wim Taymans's avatar
Wim Taymans committed
502 503 504
      break;
    }
    default:
505
      res = gst_pad_query_default (pad, query);
Wim Taymans's avatar
Wim Taymans committed
506
      break;
507
  }
508 509 510
done:
  gst_object_unref (dec);

511
  return res;
512

513
  /* ERRORS */
Wim Taymans's avatar
Wim Taymans committed
514
error:
515 516 517 518
  {
    GST_DEBUG_OBJECT (dec, "query failed");
    goto done;
  }
Wim Taymans's avatar
Wim Taymans committed
519 520 521 522 523 524 525 526 527 528 529 530
}

static gboolean
theora_dec_sink_query (GstPad * pad, GstQuery * query)
{
  gboolean res = FALSE;

  switch (GST_QUERY_TYPE (query)) {
    case GST_QUERY_CONVERT:
    {
      GstFormat src_fmt, dest_fmt;
      gint64 src_val, dest_val;
531

Wim Taymans's avatar
Wim Taymans committed
532 533 534 535 536 537 538 539 540 541
      gst_query_parse_convert (query, &src_fmt, &src_val, &dest_fmt, &dest_val);
      if (!(res =
              theora_dec_sink_convert (pad, src_fmt, src_val, &dest_fmt,
                  &dest_val)))
        goto error;

      gst_query_set_convert (query, src_fmt, src_val, dest_fmt, dest_val);
      break;
    }
    default:
542
      res = gst_pad_query_default (pad, query);
Wim Taymans's avatar
Wim Taymans committed
543 544
      break;
  }
545

Wim Taymans's avatar
Wim Taymans committed
546 547
error:
  return res;
548 549
}

Benjamin Otte's avatar
Benjamin Otte committed
550
static gboolean
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
551
theora_dec_src_event (GstPad * pad, GstEvent * event)
Benjamin Otte's avatar
Benjamin Otte committed
552 553 554 555
{
  gboolean res = TRUE;
  GstTheoraDec *dec;

556
  dec = GST_THEORA_DEC (gst_pad_get_parent (pad));
Benjamin Otte's avatar
Benjamin Otte committed
557 558

  switch (GST_EVENT_TYPE (event)) {
559 560
    case GST_EVENT_SEEK:
    {
561 562
      GstFormat format, tformat;
      gdouble rate;
Scott Wheeler Wheeler's avatar
Scott Wheeler Wheeler committed
563
      GstEvent *real_seek;
564 565 566 567 568 569 570
      GstSeekFlags flags;
      GstSeekType cur_type, stop_type;
      gint64 cur, stop;
      gint64 tcur, tstop;

      gst_event_parse_seek (event, &rate, &format, &flags, &cur_type, &cur,
          &stop_type, &stop);
571
      gst_event_unref (event);
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
572

573 574 575 576 577 578
      /* 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 
       */
579 580
      tformat = GST_FORMAT_TIME;
      if (!(res = theora_dec_src_convert (pad, format, cur, &tformat, &tcur)))
581
        goto convert_error;
582
      if (!(res = theora_dec_src_convert (pad, format, stop, &tformat, &tstop)))
583
        goto convert_error;
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
584

585
      /* then seek with time on the peer */
586 587
      real_seek = gst_event_new_seek (rate, GST_FORMAT_TIME,
          flags, cur_type, tcur, stop_type, tstop);
588

589
      res = gst_pad_push_event (dec->sinkpad, real_seek);
590

Benjamin Otte's avatar
Benjamin Otte committed
591 592
      break;
    }
593 594 595 596 597 598 599 600 601 602
    case GST_EVENT_QOS:
    {
      gdouble proportion;
      GstClockTimeDiff diff;
      GstClockTime timestamp;

      gst_event_parse_qos (event, &proportion, &diff, &timestamp);

      /* we cannot randomly skip frame decoding since we don't have
       * B frames. we can however use the timestamp and diff to not
603 604
       * push late frames. This would at least save us the time to
       * crop/memcpy the data. */
605 606 607 608 609
      GST_OBJECT_LOCK (dec);
      dec->proportion = proportion;
      dec->earliest_time = timestamp + diff;
      GST_OBJECT_UNLOCK (dec);

610 611 612
      GST_DEBUG_OBJECT (dec, "got QoS %" GST_TIME_FORMAT ", %" G_GINT64_FORMAT,
          GST_TIME_ARGS (timestamp), diff);

613
      res = gst_pad_push_event (dec->sinkpad, event);
614 615
      break;
    }
Benjamin Otte's avatar
Benjamin Otte committed
616
    default:
617
      res = gst_pad_push_event (dec->sinkpad, event);
Benjamin Otte's avatar
Benjamin Otte committed
618 619
      break;
  }
620 621
done:
  gst_object_unref (dec);
Benjamin Otte's avatar
Benjamin Otte committed
622 623

  return res;
624

625 626 627 628 629 630
  /* ERRORS */
convert_error:
  {
    GST_DEBUG_OBJECT (dec, "could not convert format");
    goto done;
  }
631 632
}

633 634
static gboolean
theora_dec_sink_event (GstPad * pad, GstEvent * event)
Benjamin Otte's avatar
Benjamin Otte committed
635
{
636
  gboolean ret = FALSE;
637 638
  GstTheoraDec *dec;

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

Benjamin Otte's avatar
Benjamin Otte committed
641 642
  GST_LOG_OBJECT (dec, "handling event");
  switch (GST_EVENT_TYPE (event)) {
643 644 645 646 647 648 649
    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
650 651 652
    case GST_EVENT_EOS:
      ret = gst_pad_push_event (dec->srcpad, event);
      break;
653
    case GST_EVENT_NEWSEGMENT:
654
    {
655
      gboolean update;
656 657
      GstFormat format;
      gdouble rate;
Wim Taymans's avatar
Wim Taymans committed
658
      gint64 start, stop, time;
659

660 661
      gst_event_parse_new_segment (event, &update, &rate, &format, &start,
          &stop, &time);
662 663 664 665 666 667 668 669

      /* we need TIME and a positive rate */
      if (format != GST_FORMAT_TIME)
        goto newseg_wrong_format;

      if (rate <= 0.0)
        goto newseg_wrong_rate;

670 671 672
      /* now configure the values */
      gst_segment_set_newsegment (&dec->segment, update,
          rate, format, start, stop, time);
673

674
      /* and forward */
Wim Taymans's avatar
Wim Taymans committed
675
      ret = gst_pad_push_event (dec->srcpad, event);
Benjamin Otte's avatar
Benjamin Otte committed
676
      break;
677
    }
Benjamin Otte's avatar
Benjamin Otte committed
678
    default:
Wim Taymans's avatar
Wim Taymans committed
679
      ret = gst_pad_push_event (dec->srcpad, event);
Benjamin Otte's avatar
Benjamin Otte committed
680 681
      break;
  }
682
done:
Wim Taymans's avatar
Wim Taymans committed
683 684
  gst_object_unref (dec);

685
  return ret;
686 687 688 689

  /* ERRORS */
newseg_wrong_format:
  {
690
    GST_DEBUG_OBJECT (dec, "received non TIME newsegment");
691
    gst_event_unref (event);
692 693 694 695
    goto done;
  }
newseg_wrong_rate:
  {
696
    GST_DEBUG_OBJECT (dec, "negative rates not supported yet");
697
    gst_event_unref (event);
698 699
    goto done;
  }
Benjamin Otte's avatar
Benjamin Otte committed
700 701
}

702
static GstFlowReturn
703
theora_handle_comment_packet (GstTheoraDec * dec, ogg_packet * packet)
Benjamin Otte's avatar
Benjamin Otte committed
704
{
705
  gchar *encoder = NULL;
Benjamin Otte's avatar
Benjamin Otte committed
706
  GstBuffer *buf;
707 708
  GstTagList *list;

709
  GST_DEBUG_OBJECT (dec, "parsing comment packet");
710 711

  buf = gst_buffer_new_and_alloc (packet->bytes);
712
  memcpy (GST_BUFFER_DATA (buf), packet->packet, packet->bytes);
713

714 715
  list =
      gst_tag_list_from_vorbiscomment_buffer (buf, (guint8 *) "\201theora", 7,
716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732
      &encoder);

  gst_buffer_unref (buf);

  if (!list) {
    GST_ERROR_OBJECT (dec, "couldn't decode comments");
    list = gst_tag_list_new ();
  }
  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);

733 734 735 736 737 738 739
  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);
  }

  gst_element_found_tags_for_pad (GST_ELEMENT (dec), dec->srcpad, list);
740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776

  return GST_FLOW_OK;
}

static GstFlowReturn
theora_handle_type_packet (GstTheoraDec * dec, ogg_packet * packet)
{
  GstCaps *caps;
  gint par_num, par_den;

  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;
   * 0:0 is allowed and can be interpreted as 1:1, so correct for it */
  par_num = dec->info.aspect_numerator;
  par_den = dec->info.aspect_denominator;
  if (par_num == 0 && par_den == 0) {
    par_num = par_den = 1;
  }
  /* theora has:
   *
   *  width/height : dimension of the encoded frame 
   *  frame_width/frame_height : dimension of the visible part
   *  offset_x/offset_y : offset in encoded frame where visible part starts
   */
  GST_DEBUG_OBJECT (dec, "dimension %dx%d, PAR %d/%d", dec->info.width,
      dec->info.height, par_num, par_den);
  GST_DEBUG_OBJECT (dec, "frame dimension %dx%d, offset %d:%d",
      dec->info.frame_width, dec->info.frame_height,
      dec->info.offset_x, dec->info.offset_y);

  if (dec->crop) {
    /* add black borders to make width/height/offsets even. we need this because
     * we cannot express an offset to the peer plugin. */
777 778
    dec->width =
        GST_ROUND_UP_2 (dec->info.frame_width + (dec->info.offset_x & 1));
779
    dec->height =
780
        GST_ROUND_UP_2 (dec->info.frame_height + (dec->info.offset_y & 1));
781 782 783 784 785 786 787 788 789 790
    dec->offset_x = dec->info.offset_x & ~1;
    dec->offset_y = dec->info.offset_y & ~1;
  } else {
    /* no cropping, use the encoded dimensions */
    dec->width = dec->info.width;
    dec->height = dec->info.height;
    dec->offset_x = 0;
    dec->offset_y = 0;
  }

791 792
  dec->granule_shift = _theora_ilog (dec->info.keyframe_frequency_force - 1);

793 794 795 796 797 798 799 800
  GST_DEBUG_OBJECT (dec, "after fixup frame dimension %dx%d, offset %d:%d",
      dec->width, dec->height, dec->offset_x, dec->offset_y);

  /* done */
  theora_decode_init (&dec->state, &dec->info);

  caps = gst_caps_new_simple ("video/x-raw-yuv",
      "format", GST_TYPE_FOURCC, GST_MAKE_FOURCC ('I', '4', '2', '0'),
801 802
      "framerate", GST_TYPE_FRACTION,
      dec->info.fps_numerator, dec->info.fps_denominator,
803 804 805 806 807
      "pixel-aspect-ratio", GST_TYPE_FRACTION, par_num, par_den,
      "width", G_TYPE_INT, dec->width, "height", G_TYPE_INT, dec->height, NULL);
  gst_pad_set_caps (dec->srcpad, caps);
  gst_caps_unref (caps);

Wim Taymans's avatar
Wim Taymans committed
808
  dec->have_header = TRUE;
809 810 811 812 813 814 815 816 817

  return GST_FLOW_OK;
}

static GstFlowReturn
theora_handle_header_packet (GstTheoraDec * dec, ogg_packet * packet)
{
  GstFlowReturn res;

818
  GST_DEBUG_OBJECT (dec, "parsing header packet");
819 820 821 822

  if (theora_decode_header (&dec->info, &dec->comment, packet))
    goto header_read_error;

Wim Taymans's avatar
Wim Taymans committed
823 824
  switch (packet->packet[0]) {
    case 0x81:
825 826
      res = theora_handle_comment_packet (dec, packet);
      break;
Wim Taymans's avatar
Wim Taymans committed
827
    case 0x82:
828 829 830 831
      res = theora_handle_type_packet (dec, packet);
      break;
    default:
      /* ignore */
Wim Taymans's avatar
Wim Taymans committed
832 833 834
      g_warning ("unknown theora header packet found");
    case 0x80:
      /* nothing special, this is the identification header */
835 836 837 838 839 840 841 842 843 844 845 846 847 848
      res = GST_FLOW_OK;
      break;
  }
  return res;

  /* ERRORS */
header_read_error:
  {
    GST_ELEMENT_ERROR (GST_ELEMENT (dec), STREAM, DECODE,
        (NULL), ("couldn't read header packet"));
    return GST_FLOW_ERROR;
  }
}

849
/* FIXME, this needs to be moved to the demuxer */
850 851 852 853
static GstFlowReturn
theora_dec_push (GstTheoraDec * dec, GstBuffer * buf)
{
  GstFlowReturn result;
Wim Taymans's avatar
Wim Taymans committed
854
  GstClockTime outtime = GST_BUFFER_TIMESTAMP (buf);
855

Wim Taymans's avatar
Wim Taymans committed
856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872
  if (outtime == GST_CLOCK_TIME_NONE) {
    dec->queued = g_list_append (dec->queued, buf);
    GST_DEBUG_OBJECT (dec, "queued buffer");
    result = GST_FLOW_OK;
  } else {
    if (dec->queued) {
      gint64 size;
      GList *walk;

      GST_DEBUG_OBJECT (dec, "first buffer with time %" GST_TIME_FORMAT,
          GST_TIME_ARGS (outtime));

      size = g_list_length (dec->queued);
      for (walk = dec->queued; walk; walk = g_list_next (walk)) {
        GstBuffer *buffer = GST_BUFFER (walk->data);
        GstClockTime time;

873 874
        time = outtime - gst_util_uint64_scale_int (size * GST_SECOND,
            dec->info.fps_denominator, dec->info.fps_numerator);
Wim Taymans's avatar
Wim Taymans committed
875 876 877

        GST_DEBUG_OBJECT (dec, "patch buffer %lld %lld", size, time);
        GST_BUFFER_TIMESTAMP (buffer) = time;
878 879 880 881 882

        if (dec->discont) {
          GST_BUFFER_FLAG_SET (buffer, GST_BUFFER_FLAG_DISCONT);
          dec->discont = FALSE;
        }
883
        /* ignore the result.. */
Wim Taymans's avatar
Wim Taymans committed
884 885 886 887 888 889
        gst_pad_push (dec->srcpad, buffer);
        size--;
      }
      g_list_free (dec->queued);
      dec->queued = NULL;
    }
890 891 892 893
    if (dec->discont) {
      GST_BUFFER_FLAG_SET (buf, GST_BUFFER_FLAG_DISCONT);
      dec->discont = FALSE;
    }
Wim Taymans's avatar
Wim Taymans committed
894 895
    result = gst_pad_push (dec->srcpad, buf);
  }
896 897 898 899

  return result;
}

900 901 902 903 904 905 906 907 908 909 910 911 912 913 914
static GstFlowReturn
theora_handle_data_packet (GstTheoraDec * dec, ogg_packet * packet,
    GstClockTime outtime)
{
  /* normal data packet */
  yuv_buffer yuv;
  GstBuffer *out;
  guint i;
  gboolean keyframe;
  gint out_size;
  gint stride_y, stride_uv;
  gint width, height;
  gint cwidth, cheight;
  GstFlowReturn result;

915
  if (G_UNLIKELY (!dec->have_header))
916 917 918 919 920 921
    goto not_initialized;

  /* the second most significant bit of the first data byte is cleared 
   * for keyframes */
  keyframe = (packet->packet[0] & 0x40) == 0;
  if (keyframe) {
922
    GST_DEBUG_OBJECT (dec, "we have a keyframe");
923 924 925 926 927
    dec->need_keyframe = FALSE;
  } else if (dec->need_keyframe) {
    goto dropping;
  }

928 929
  GST_DEBUG_OBJECT (dec, "parsing data packet");

930
  /* this does the decoding */
931
  if (G_UNLIKELY (theora_decode_packetin (&dec->state, packet)))
932 933 934 935
    goto decode_error;

  if (outtime != -1) {
    gboolean need_skip;
936 937 938 939 940
    GstClockTime qostime;

    /* qos needs to be done on running time */
    qostime = gst_segment_to_running_time (&dec->segment, GST_FORMAT_TIME,
        outtime);
941 942 943 944 945 946

    GST_OBJECT_LOCK (dec);
    /* check for QoS, don't perform the last steps of getting and
     * pushing the buffers that are known to be late. */
    /* FIXME, we can also entirely skip decoding if the next valid buffer is 
     * known to be after a keyframe (using the granule_shift) */
947
    need_skip = dec->earliest_time != -1 && qostime <= dec->earliest_time;
948
    GST_OBJECT_UNLOCK (dec);
949

950 951 952 953 954 955
    if (need_skip)
      goto dropping_qos;
  }

  /* this does postprocessing and set up the decoded frame
   * pointers in our yuv variable */
956
  if (G_UNLIKELY (theora_decode_YUVout (&dec->state, &yuv) < 0))
957
    goto no_yuv;
958

959 960
  if (G_UNLIKELY ((yuv.y_width != dec->info.width)
          || (yuv.y_height != dec->info.height)))
961 962 963 964 965 966 967 968 969 970
    goto wrong_dimensions;

  width = dec->width;
  height = dec->height;
  cwidth = width / 2;
  cheight = height / 2;

  /* should get the stride from the caps, for now we round up to the nearest
   * multiple of 4 because some element needs it. chroma needs special 
   * treatment, see videotestsrc. */
971 972
  stride_y = GST_ROUND_UP_4 (width);
  stride_uv = GST_ROUND_UP_8 (width) / 2;
973 974 975 976 977

  out_size = stride_y * height + stride_uv * cheight * 2;

  /* now copy over the area contained in offset_x,offset_y,
   * frame_width, frame_height */
978 979 980
  result =
      gst_pad_alloc_buffer_and_set_caps (dec->srcpad, GST_BUFFER_OFFSET_NONE,
      out_size, GST_PAD_CAPS (dec->srcpad), &out);
981
  if (G_UNLIKELY (result != GST_FLOW_OK))
982 983 984 985 986
    goto no_buffer;

  /* copy the visible region to the destination. This is actually pretty
   * complicated and gstreamer doesn't support all the needed caps to do this
   * correctly. For example, when we have an odd offset, we should only combine
987
   * 1 row/column of luma samples with one chroma sample in colorspace conversion. 
Wim Taymans's avatar
Wim Taymans committed
988
   * We compensate for this by adding a black border around the image when the
989
   * offset or size is odd (see above).
990 991
   */
  {
Andy Wingo Wingo's avatar
Andy Wingo Wingo committed
992 993 994
    guchar *dest_y, *src_y;
    guchar *dest_u, *src_u;
    guchar *dest_v, *src_v;
995
    gint offset;
996

Andy Wingo Wingo's avatar
Andy Wingo Wingo committed
997
    dest_y = GST_BUFFER_DATA (out