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

j^'s avatar
j^ committed
61 62
static GstElementDetails theora_dec_details =
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 175 176 177 178 179 180 181 182
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);
}

183
/* FIXME: copy from libtheora, theora should somehow make this available for seeking */
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
184 185 186 187 188 189
static int
_theora_ilog (unsigned int v)
{
  int ret = 0;

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

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

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

205
  ilog = dec->granule_shift;
206

207 208 209 210
  /* 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);
211 212 213

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

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

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

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

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

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

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

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

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

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

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


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

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

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

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

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

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_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 406 407

          /* funny way of calculating granulepos in theora */
          rest = *dest_value / dec->info.keyframe_frequency_force;
          *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
}
432 433

static gboolean
Wim Taymans's avatar
Wim Taymans committed
434
theora_dec_src_query (GstPad * pad, GstQuery * query)
435
{
436 437
  GstTheoraDec *dec;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

508
  return res;
509

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

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

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

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

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

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

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

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

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

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

Benjamin Otte's avatar
Benjamin Otte committed
587 588 589
      gst_event_unref (event);
      break;
    }
590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608
    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
609 610 611 612
    default:
      res = gst_pad_event_default (pad, event);
      break;
  }
613 614
done:
  gst_object_unref (dec);
Benjamin Otte's avatar
Benjamin Otte committed
615 616

  return res;
617

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

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

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

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

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

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

      if (rate <= 0.0)
        goto newseg_wrong_rate;

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

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

679
  return ret;
680 681 682 683

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

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

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

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

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

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

729 730 731 732 733 734 735
  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);
736 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

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

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

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

  return GST_FLOW_OK;
}

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

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

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

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

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

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

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

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

  return result;
}

886 887 888 889 890 891 892 893 894 895 896 897 898 899 900
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
901
  if (!dec->have_header)
902 903 904 905 906 907 908 909 910 911 912
    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;
  }

913
  /* this does the decoding */
914
  if (theora_decode_packetin (&dec->state, packet))
915 916 917 918 919 920 921 922 923 924 925 926
    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);
927

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

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

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

Andy Wingo Wingo's avatar
Andy Wingo Wingo committed
974
    dest_y = GST_BUFFER_DATA (out);
975 976 977 978 979 980 981 982 983 984 985 986
    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;
    }

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

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

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

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

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

  return result;

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