theoradec.c 31.7 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
};

Benjamin Otte's avatar
Benjamin Otte committed
61 62
static GstElementDetails theora_dec_details = {
  "TheoraDec",
63
  "Codec/Decoder/Video",
Benjamin Otte's avatar
Benjamin Otte committed
64
  "decode raw theora streams to raw YUV video",
65 66
  "Benjamin Otte <in7y118@public.uni-hamburg.de>, "
      "Wim Taymans <wim@fluendo.com>",
Benjamin Otte's avatar
Benjamin Otte committed
67 68 69
};

static GstStaticPadTemplate theora_dec_src_factory =
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
70 71 72 73
GST_STATIC_PAD_TEMPLATE ("src",
    GST_PAD_SRC,
    GST_PAD_ALWAYS,
    GST_STATIC_CAPS ("video/x-raw-yuv, "
74
        "format = (fourcc) I420, "
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

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

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

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

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


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
120 121

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

134 135 136 137 138 139 140 141
  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
142
  gstelement_class->change_state = theora_dec_change_state;
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
143 144

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

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

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

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

170 171 172 173 174 175 176 177 178 179 180 181 182 183
static void
gst_theora_dec_reset (GstTheoraDec * dec)
{
  dec->need_keyframe = TRUE;
  dec->last_timestamp = -1;
  dec->granulepos = -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);
}

184
/* FIXME: copy from libtheora, theora should somehow make this available for seeking */
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 285 286 287 288 289 290 291

static const GstQueryType *
theora_get_query_types (GstPad * pad)
{
  static const GstQueryType theora_src_query_types[] = {
    GST_QUERY_POSITION,
    0
  };

  return theora_src_query_types;
}


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

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

306 307 308 309 310 311
  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;

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

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

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

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

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

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

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

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

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

static gboolean
Wim Taymans's avatar
Wim Taymans committed
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));

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

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

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

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

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

467
      time = (time - dec->segment.start) + dec->segment.time;
468

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

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

Wim Taymans's avatar
Wim Taymans committed
476
      gst_query_set_position (query, format, value);
Wim Taymans's avatar
Wim Taymans committed
477 478

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

      break;
    }
Wim Taymans's avatar
Wim Taymans committed
483 484 485 486 487
    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
488 489 490 491 492 493
    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);
494
      if (!(res =
Wim Taymans's avatar
Wim Taymans committed
495 496
              theora_dec_src_convert (pad, src_fmt, src_val, &dest_fmt,
                  &dest_val)))
497 498 499
        goto error;

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

509
  return res;
510

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

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

Wim Taymans's avatar
Wim Taymans committed
530 531 532 533 534 535 536 537 538 539
      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:
540
      res = gst_pad_query_default (pad, query);
Wim Taymans's avatar
Wim Taymans committed
541 542
      break;
  }
543

Wim Taymans's avatar
Wim Taymans committed
544 545
error:
  return res;
546 547
}

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

554
  dec = GST_THEORA_DEC (gst_pad_get_parent (pad));
Benjamin Otte's avatar
Benjamin Otte committed
555 556

  switch (GST_EVENT_TYPE (event)) {
557 558
    case GST_EVENT_SEEK:
    {
559 560
      GstFormat format, tformat;
      gdouble rate;
Scott Wheeler Wheeler's avatar
Scott Wheeler Wheeler committed
561
      GstEvent *real_seek;
562 563 564 565 566 567 568
      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);
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
569

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

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

586
      res = gst_pad_push_event (dec->sinkpad, real_seek);
587

Benjamin Otte's avatar
Benjamin Otte committed
588 589 590
      gst_event_unref (event);
      break;
    }
591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609
    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
       * push late frames. */
      GST_OBJECT_LOCK (dec);
      dec->proportion = proportion;
      dec->earliest_time = timestamp + diff;
      GST_OBJECT_UNLOCK (dec);

      res = gst_pad_event_default (pad, event);
      break;
    }
Benjamin Otte's avatar
Benjamin Otte committed
610 611 612 613
    default:
      res = gst_pad_event_default (pad, event);
      break;
  }
614 615
done:
  gst_object_unref (dec);
Benjamin Otte's avatar
Benjamin Otte committed
616 617

  return res;
618

619 620 621 622 623 624 625
  /* ERRORS */
convert_error:
  {
    GST_DEBUG_OBJECT (dec, "could not convert format");
    gst_event_unref (event);
    goto done;
  }
626 627
}

628 629
static gboolean
theora_dec_sink_event (GstPad * pad, GstEvent * event)
Benjamin Otte's avatar
Benjamin Otte committed
630
{
631
  gboolean ret = FALSE;
632 633
  GstTheoraDec *dec;

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

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

655 656
      gst_event_parse_new_segment (event, &update, &rate, &format, &start,
          &stop, &time);
657 658 659 660 661 662 663 664

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

      if (rate <= 0.0)
        goto newseg_wrong_rate;

665 666 667
      /* now configure the values */
      gst_segment_set_newsegment (&dec->segment, update,
          rate, format, start, stop, time);
668

669
      /* and forward */
Wim Taymans's avatar
Wim Taymans committed
670
      ret = gst_pad_push_event (dec->srcpad, event);
Benjamin Otte's avatar
Benjamin Otte committed
671
      break;
672
    }
Benjamin Otte's avatar
Benjamin Otte committed
673
    default:
Wim Taymans's avatar
Wim Taymans committed
674
      ret = gst_pad_push_event (dec->srcpad, event);
Benjamin Otte's avatar
Benjamin Otte committed
675 676
      break;
  }
677
done:
Wim Taymans's avatar
Wim Taymans committed
678 679
  gst_object_unref (dec);

680
  return ret;
681 682 683 684

  /* ERRORS */
newseg_wrong_format:
  {
685
    GST_DEBUG_OBJECT (dec, "received non TIME newsegment");
686 687 688 689
    goto done;
  }
newseg_wrong_rate:
  {
690
    GST_DEBUG_OBJECT (dec, "negative rates not supported yet");
691 692
    goto done;
  }
Benjamin Otte's avatar
Benjamin Otte committed
693 694
}

695 696 697 698
#define ROUND_UP_2(x) (((x) + 1) & ~1)
#define ROUND_UP_4(x) (((x) + 3) & ~3)
#define ROUND_UP_8(x) (((x) + 7) & ~7)

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

706
  GST_DEBUG_OBJECT (dec, "parsing comment packet");
707 708

  buf = gst_buffer_new_and_alloc (packet->bytes);
709
  memcpy (GST_BUFFER_DATA (buf), packet->packet, packet->bytes);
710

711 712
  list =
      gst_tag_list_from_vorbiscomment_buffer (buf, (guint8 *) "\201theora", 7,
713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729
      &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);

730 731 732 733 734 735 736
  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);
737 738 739 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 777 778 779 780 781 782 783 784 785 786

  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. */
    dec->width = ROUND_UP_2 (dec->info.frame_width + (dec->info.offset_x & 1));
    dec->height =
        ROUND_UP_2 (dec->info.frame_height + (dec->info.offset_y & 1));
    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;
  }

787 788
  dec->granule_shift = _theora_ilog (dec->info.keyframe_frequency_force - 1);

789 790 791 792 793 794 795 796
  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'),
797 798
      "framerate", GST_TYPE_FRACTION,
      dec->info.fps_numerator, dec->info.fps_denominator,
799 800 801 802 803
      "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
804
  dec->have_header = TRUE;
805 806 807 808 809 810 811 812 813

  return GST_FLOW_OK;
}

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

814
  GST_DEBUG_OBJECT (dec, "parsing header packet");
815 816 817 818

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

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

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

Wim Taymans's avatar
Wim Taymans committed
852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868
  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;

869 870
        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
871 872 873

        GST_DEBUG_OBJECT (dec, "patch buffer %lld %lld", size, time);
        GST_BUFFER_TIMESTAMP (buffer) = time;
874
        /* ignore the result.. */
Wim Taymans's avatar
Wim Taymans committed
875 876 877 878 879 880 881 882
        gst_pad_push (dec->srcpad, buffer);
        size--;
      }
      g_list_free (dec->queued);
      dec->queued = NULL;
    }
    result = gst_pad_push (dec->srcpad, buf);
  }
883 884 885 886

  return result;
}

887 888 889 890 891 892 893 894 895 896 897 898 899 900 901
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;

Wim Taymans's avatar
Wim Taymans committed
902
  if (!dec->have_header)
903 904 905 906 907 908 909 910 911 912 913
    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) {
    dec->need_keyframe = FALSE;
  } else if (dec->need_keyframe) {
    goto dropping;
  }

914
  /* this does the decoding */
915
  if (theora_decode_packetin (&dec->state, packet))
916 917 918 919 920 921 922 923 924 925 926 927
    goto decode_error;

  if (outtime != -1) {
    gboolean need_skip;

    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) */
    need_skip = dec->earliest_time != -1 && outtime <= dec->earliest_time;
    GST_OBJECT_UNLOCK (dec);
928

929 930 931 932 933 934
    if (need_skip)
      goto dropping_qos;
  }

  /* this does postprocessing and set up the decoded frame
   * pointers in our yuv variable */
935
  if (theora_decode_YUVout (&dec->state, &yuv) < 0)
936
    goto no_yuv;
937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955

  if ((yuv.y_width != dec->info.width) || (yuv.y_height != dec->info.height))
    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. */
  stride_y = ROUND_UP_4 (width);
  stride_uv = ROUND_UP_8 (width) / 2;

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

  /* now copy over the area contained in offset_x,offset_y,
   * frame_width, frame_height */
956 957 958
  result =
      gst_pad_alloc_buffer_and_set_caps (dec->srcpad, GST_BUFFER_OFFSET_NONE,
      out_size, GST_PAD_CAPS (dec->srcpad), &out);
Wim Taymans's avatar
Wim Taymans committed
959
  if (result != GST_FLOW_OK)
960 961 962 963 964
    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
965
   * 1 row/column of luma samples with one chroma sample in colorspace conversion. 
Wim Taymans's avatar
Wim Taymans committed
966
   * We compensate for this by adding a black border around the image when the
967
   * offset or size is odd (see above).
968 969
   */
  {
Andy Wingo Wingo's avatar
Andy Wingo Wingo committed
970 971 972
    guchar *dest_y, *src_y;
    guchar *dest_u, *src_u;
    guchar *dest_v, *src_v;
973
    guint offset;
974

Andy Wingo Wingo's avatar
Andy Wingo Wingo committed
975
    dest_y = GST_BUFFER_DATA (out);
976 977 978 979 980 981 982 983 984 985 986 987
    dest_u = dest_y + stride_y * height;
    dest_v = dest_u + stride_uv * cheight;

    src_y = yuv.y + dec->offset_x + dec->offset_y * yuv.y_stride;

    for (i = 0; i < height; i++) {
      memcpy (dest_y, src_y, width);

      dest_y += stride_y;
      src_y += yuv.y_stride;
    }

988 989 990 991
    offset = dec->offset_x / 2 + dec->offset_y / 2 * yuv.uv_stride;

    src_u = yuv.u + offset;
    src_v = yuv.v + offset;
992 993 994 995 996 997 998 999 1000 1001 1002 1003

    for (i = 0; i < cheight; i++) {
      memcpy (dest_u, src_u, cwidth);
      memcpy (dest_v, src_v, cwidth);

      dest_u += stride_uv;
      src_u += yuv.uv_stride;
      dest_v += stride_uv;
      src_v += yuv.uv_stride;
    }
  }

1004
  /* FIXME, frame_nr not correct */
Wim Taymans's avatar
Wim Taymans committed
1005 1006 1007
  GST_BUFFER_OFFSET (out) = dec->frame_nr;
  dec->frame_nr++;
  GST_BUFFER_OFFSET_END (out) = dec->frame_nr;
1008
  GST_BUFFER_DURATION (out) =
1009 1010
      gst_util_uint64_scale_int (GST_SECOND, dec->info.fps_denominator,
      dec->info.fps_numerator);
1011 1012
  GST_BUFFER_TIMESTAMP (out) = outtime;

1013
  result = theora_dec_push (dec, out);
1014 1015 1016 1017 1018 1019 1020

  return result;

  /* ERRORS */
not_initialized:
  {
    GST_ELEMENT_ERROR (GST_ELEMENT (dec), STREAM, DECODE,
Wim Taymans's avatar
Wim Taymans committed
1021
        (NULL), ("no header sent yet"));
1022 1023 1024 1025 1026 1027 1028
    return GST_FLOW_ERROR;
  }
dropping:
  {
    GST_WARNING_OBJECT (dec, "dropping frame because we need a keyframe");
    return GST_FLOW_OK;
  }
1029 1030 1031 1032 1033 1034 1035
dropping_qos:
  {
    dec->frame_nr++;
    GST_WARNING_OBJECT (dec, "dropping frame because of QoS");
    return GST_FLOW_OK;
  }
decode_error:
1036 1037
  {
    GST_ELEMENT_ERROR (GST_ELEMENT (dec), STREAM, DECODE,
1038
        (NULL), ("theora decoder did not decode data packet"));
1039 1040
    return GST_FLOW_ERROR;
  }