theoradec.c 30.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
20
21
22
23
24
25
26
27
28
/* 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.
 */

#ifdef HAVE_CONFIG_H
#  include "config.h"
#endif

#include <gst/gst.h>
#include <theora/theora.h>
#include <string.h>
#include <gst/tag/tag.h>

Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
29
30
GST_DEBUG_CATEGORY (theoradec_debug);
#define GST_CAT_DEFAULT theoradec_debug
Benjamin Otte's avatar
Benjamin Otte committed
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

#define GST_TYPE_THEORA_DEC \
  (gst_theora_dec_get_type())
#define GST_THEORA_DEC(obj) \
  (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_THEORA_DEC,GstTheoraDec))
#define GST_THEORA_DEC_CLASS(klass) \
  (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_THEORA_DEC,GstTheoraDec))
#define GST_IS_THEORA_DEC(obj) \
  (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_THEORA_DEC))
#define GST_IS_THEORA_DEC_CLASS(obj) \
  (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_THEORA_DEC))

typedef struct _GstTheoraDec GstTheoraDec;
typedef struct _GstTheoraDecClass GstTheoraDecClass;

Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
46
47
48
49
50
51
52
53
54
55
56
57
58
struct _GstTheoraDec
{
  GstElement element;

  GstPad *sinkpad;
  GstPad *srcpad;

  theora_state state;
  theora_info info;
  theora_comment comment;

  guint packetno;
  guint64 granulepos;
59

60
  gboolean initialized;
61
  gboolean need_keyframe;
62
63
  gint width, height;
  gint offset_x, offset_y;
64
65

  gboolean crop;
66
67

  GList *queued;
Benjamin Otte's avatar
Benjamin Otte committed
68
69
};

Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
70
71
struct _GstTheoraDecClass
{
Benjamin Otte's avatar
Benjamin Otte committed
72
73
74
  GstElementClass parent_class;
};

75
76
77
78
79
80
81
#define THEORA_DEF_CROP		TRUE
enum
{
  ARG_0,
  ARG_CROP
};

Benjamin Otte's avatar
Benjamin Otte committed
82
83
static GstElementDetails theora_dec_details = {
  "TheoraDec",
84
  "Codec/Decoder/Video",
Benjamin Otte's avatar
Benjamin Otte committed
85
  "decode raw theora streams to raw YUV video",
86
87
  "Benjamin Otte <in7y118@public.uni-hamburg.de>, "
      "Wim Taymans <wim@fluendo.com>",
Benjamin Otte's avatar
Benjamin Otte committed
88
89
90
};

static GstStaticPadTemplate theora_dec_src_factory =
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
91
92
93
94
GST_STATIC_PAD_TEMPLATE ("src",
    GST_PAD_SRC,
    GST_PAD_ALWAYS,
    GST_STATIC_CAPS ("video/x-raw-yuv, "
95
96
97
        "format = (fourcc) I420, "
        "framerate = (double) [0, MAX], "
        "width = (int) [ 1, MAX ], " "height = (int) [ 1, MAX ]")
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
98
    );
Benjamin Otte's avatar
Benjamin Otte committed
99
100

static GstStaticPadTemplate theora_dec_sink_factory =
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
101
102
103
104
105
GST_STATIC_PAD_TEMPLATE ("sink",
    GST_PAD_SINK,
    GST_PAD_ALWAYS,
    GST_STATIC_CAPS ("video/x-theora")
    );
Benjamin Otte's avatar
Benjamin Otte committed
106
107

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

109
110
111
112
113
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);

114
115
static gboolean theora_dec_sink_event (GstPad * pad, GstEvent * event);
static GstFlowReturn theora_dec_chain (GstPad * pad, GstBuffer * buffer);
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
116
117
static GstElementStateReturn theora_dec_change_state (GstElement * element);
static gboolean theora_dec_src_event (GstPad * pad, GstEvent * event);
Wim Taymans's avatar
Wim Taymans committed
118
static gboolean theora_dec_src_query (GstPad * pad, GstQuery * query);
119
120
121
122
123
124
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
125
static gboolean theora_dec_sink_query (GstPad * pad, GstQuery * query);
126
static GstCaps *theora_dec_src_getcaps (GstPad * pad);
Wim Taymans's avatar
Wim Taymans committed
127
128

#if 0
129
static const GstFormat *theora_get_formats (GstPad * pad);
Wim Taymans's avatar
Wim Taymans committed
130
131
#endif
#if 0
132
static const GstEventMask *theora_get_event_masks (GstPad * pad);
Wim Taymans's avatar
Wim Taymans committed
133
#endif
134
static const GstQueryType *theora_get_query_types (GstPad * pad);
Benjamin Otte's avatar
Benjamin Otte committed
135
136
137
138
139
140


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
141
142

  gst_element_class_add_pad_template (element_class,
Benjamin Otte's avatar
Benjamin Otte committed
143
144
145
146
147
148
149
      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
150
gst_theora_dec_class_init (GstTheoraDecClass * klass)
Benjamin Otte's avatar
Benjamin Otte committed
151
{
152
  GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
Benjamin Otte's avatar
Benjamin Otte committed
153
154
  GstElementClass *gstelement_class = GST_ELEMENT_CLASS (klass);

155
156
157
158
159
160
161
162
  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
163
  gstelement_class->change_state = theora_dec_change_state;
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
164
165

  GST_DEBUG_CATEGORY_INIT (theoradec_debug, "theoradec", 0, "Theora decoder");
Benjamin Otte's avatar
Benjamin Otte committed
166
167
168
}

static void
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
169
gst_theora_dec_init (GstTheoraDec * dec)
Benjamin Otte's avatar
Benjamin Otte committed
170
{
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
171
172
173
  dec->sinkpad =
      gst_pad_new_from_template (gst_static_pad_template_get
      (&theora_dec_sink_factory), "sink");
Wim Taymans's avatar
Wim Taymans committed
174
  gst_pad_set_query_function (dec->sinkpad, theora_dec_sink_query);
175
  gst_pad_set_event_function (dec->sinkpad, theora_dec_sink_event);
Benjamin Otte's avatar
Benjamin Otte committed
176
177
178
  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
179
180
181
  dec->srcpad =
      gst_pad_new_from_template (gst_static_pad_template_get
      (&theora_dec_src_factory), "src");
182
  gst_pad_set_getcaps_function (dec->srcpad, theora_dec_src_getcaps);
Benjamin Otte's avatar
Benjamin Otte committed
183
  gst_pad_set_event_function (dec->srcpad, theora_dec_src_event);
184
  gst_pad_set_query_type_function (dec->srcpad, theora_get_query_types);
185
  gst_pad_set_query_function (dec->srcpad, theora_dec_src_query);
186

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

189
  dec->crop = THEORA_DEF_CROP;
190
  dec->queued = NULL;
Benjamin Otte's avatar
Benjamin Otte committed
191
}
192
193

/* FIXME: copy from libtheora, theora should somehow make this available for seeking */
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
194
195
196
197
198
199
static int
_theora_ilog (unsigned int v)
{
  int ret = 0;

  while (v) {
200
    ret++;
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
201
    v >>= 1;
202
  }
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
203
  return (ret);
204
205
}

206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
static void
_inc_granulepos (GstTheoraDec * dec)
{
  guint ilog;
  gint framecount;

  if (dec->granulepos == -1)
    return;

  ilog = _theora_ilog (dec->info.keyframe_frequency_force - 1);

  framecount = dec->granulepos >> ilog;
  framecount += dec->granulepos - (framecount << ilog);

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

  framecount++;

  dec->granulepos = (framecount << ilog);
}

Wim Taymans's avatar
Wim Taymans committed
227
#if 0
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
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
245
#endif
246

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

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

  return theora_src_query_types;
}


273
static gboolean
274
275
276
theora_dec_src_convert (GstPad * pad,
    GstFormat src_format, gint64 src_value,
    GstFormat * dest_format, gint64 * dest_value)
277
{
278
279
280
281
  gboolean res = TRUE;
  GstTheoraDec *dec;
  guint64 scale = 1;

282
  dec = GST_THEORA_DEC (GST_PAD_PARENT (pad));
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
283

284
  /* we need the info part before we can done something */
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
285
286
287
  if (dec->packetno < 1)
    return FALSE;

Wim Taymans's avatar
Wim Taymans committed
288
289
290
291
292
  if (src_format == *dest_format) {
    *dest_value = src_value;
    return TRUE;
  }

293
294
295
296
297
298
299
300
301
302
303
304
305
  switch (src_format) {
    case GST_FORMAT_BYTES:
      switch (*dest_format) {
        case GST_FORMAT_DEFAULT:
          *dest_value =
              src_value * 2 / (dec->info.height * dec->info.width * 3);
          break;
        case GST_FORMAT_TIME:
          /* seems like a rather silly conversion, implement me if you like */
        default:
          res = FALSE;
      }
      break;
306
    case GST_FORMAT_TIME:
307
308
      switch (*dest_format) {
        case GST_FORMAT_BYTES:
309
          scale = 3 * (dec->info.width * dec->info.height) / 2;
310
        case GST_FORMAT_DEFAULT:
311
312
313
          *dest_value =
              scale * (((guint64) src_value * dec->info.fps_numerator) /
              (dec->info.fps_denominator * GST_SECOND));
314
315
316
317
          break;
        default:
          res = FALSE;
      }
318
319
      break;
    case GST_FORMAT_DEFAULT:
320
321
322
323
324
325
326
327
328
329
330
331
      switch (*dest_format) {
        case GST_FORMAT_TIME:
          *dest_value = src_value * (GST_SECOND * dec->info.fps_denominator /
              dec->info.fps_numerator);
          break;
        case GST_FORMAT_BYTES:
          *dest_value =
              src_value * 3 * (dec->info.width * dec->info.height) / 2;
          break;
        default:
          res = FALSE;
      }
332
333
      break;
    default:
334
      res = FALSE;
335
  }
336
337

  return res;
338
339
}

Benjamin Otte's avatar
Benjamin Otte committed
340
static gboolean
341
342
343
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
344
{
345
346
  gboolean res = TRUE;
  GstTheoraDec *dec;
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
347

348
  dec = GST_THEORA_DEC (GST_PAD_PARENT (pad));
349
350

  /* we need the info part before we can done something */
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
351
352
353
  if (dec->packetno < 1)
    return FALSE;

Wim Taymans's avatar
Wim Taymans committed
354
355
356
357
358
  if (src_format == *dest_format) {
    *dest_value = src_value;
    return TRUE;
  }

359
  switch (src_format) {
Benjamin Otte's avatar
Benjamin Otte committed
360
    case GST_FORMAT_DEFAULT:
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
    {
      guint64 framecount;
      guint ilog;

      ilog = _theora_ilog (dec->info.keyframe_frequency_force - 1);

      /* 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 = src_value >> ilog;
      framecount += src_value - (framecount << ilog);

      switch (*dest_format) {
        case GST_FORMAT_TIME:
          *dest_value = framecount * (GST_SECOND * dec->info.fps_denominator /
              dec->info.fps_numerator);
          break;
        default:
          res = FALSE;
      }
380
      break;
381
    }
382
383
384
385
386
387
    case GST_FORMAT_TIME:
    {
      switch (*dest_format) {
        case GST_FORMAT_DEFAULT:
        {
          guint ilog = _theora_ilog (dec->info.keyframe_frequency_force - 1);
388
          guint rest;
389

390
          /* framecount */
391
392
          *dest_value = src_value * dec->info.fps_numerator /
              (GST_SECOND * dec->info.fps_denominator);
393
394
395
396

          /* funny way of calculating granulepos in theora */
          rest = *dest_value / dec->info.keyframe_frequency_force;
          *dest_value -= rest;
397
          *dest_value <<= ilog;
398
          *dest_value += rest;
399
400
401
402
403
404
405
406
          break;
        }
        default:
          res = FALSE;
          break;
      }
      break;
    }
Benjamin Otte's avatar
Benjamin Otte committed
407
    default:
408
      res = FALSE;
Benjamin Otte's avatar
Benjamin Otte committed
409
  }
410
411

  return res;
Benjamin Otte's avatar
Benjamin Otte committed
412
}
413
414

static gboolean
Wim Taymans's avatar
Wim Taymans committed
415
theora_dec_src_query (GstPad * pad, GstQuery * query)
416
{
417
  GstTheoraDec *dec = GST_THEORA_DEC (GST_PAD_PARENT (pad));
Wim Taymans's avatar
Wim Taymans committed
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
  gboolean res = FALSE;

  switch (GST_QUERY_TYPE (query)) {
    case GST_QUERY_POSITION:
    {
      gint64 granulepos, total, value;
      GstFormat my_format, format;
      gint64 time;

      /* forward to peer for total */
      if (!(res = gst_pad_query (GST_PAD_PEER (dec->sinkpad), query)))
        goto error;

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

434
435
436
      GST_LOG_OBJECT (dec,
          "query %p: we have current granule: %lld", query, granulepos);

Wim Taymans's avatar
Wim Taymans committed
437
438
439
      /* parse total time from peer and format */
      gst_query_parse_position (query, &format, NULL, &total);

440
441
442
443
      GST_LOG_OBJECT (dec,
          "query %p: peer returned total: %lld (format %u)",
          query, total, format);

Wim Taymans's avatar
Wim Taymans committed
444
445
446
447
448
449
450
451
      /* 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;

452
453
454
      GST_LOG_OBJECT (dec,
          "query %p: our time: %" GST_TIME_FORMAT, query, GST_TIME_ARGS (time));

Wim Taymans's avatar
Wim Taymans committed
455
456
457
458
459
460
461
      if (!(res =
              theora_dec_src_convert (pad, my_format, time, &format, &value)))
        goto error;

      gst_query_set_position (query, format, value, total);

      GST_LOG_OBJECT (dec,
462
463
          "query %p: we return %lld and %lld (format %u)",
          query, value, total, format);
Wim Taymans's avatar
Wim Taymans committed
464
465
466
467
468
469
470
471
472

      break;
    }
    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);
473
      if (!(res =
Wim Taymans's avatar
Wim Taymans committed
474
475
              theora_dec_src_convert (pad, src_fmt, src_val, &dest_fmt,
                  &dest_val)))
476
477
478
        goto error;

      gst_query_set_convert (query, src_fmt, src_val, dest_fmt, dest_val);
Wim Taymans's avatar
Wim Taymans committed
479
480
481
482
483
      break;
    }
    default:
      res = FALSE;
      break;
484
  }
485
  return res;
486

Wim Taymans's avatar
Wim Taymans committed
487
error:
488
  GST_DEBUG ("query failed");
Wim Taymans's avatar
Wim Taymans committed
489
490
491
492
493
494
495
496
497
498
499
500
501
  return res;
}

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

Wim Taymans's avatar
Wim Taymans committed
503
504
505
506
507
508
509
510
511
512
513
514
515
      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:
      res = FALSE;
      break;
  }
516

Wim Taymans's avatar
Wim Taymans committed
517
518
error:
  return res;
519
520
}

Benjamin Otte's avatar
Benjamin Otte committed
521
static gboolean
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
522
theora_dec_src_event (GstPad * pad, GstEvent * event)
Benjamin Otte's avatar
Benjamin Otte committed
523
524
525
{
  gboolean res = TRUE;
  GstTheoraDec *dec;
526
  GstFormat format;
Benjamin Otte's avatar
Benjamin Otte committed
527

528
  dec = GST_THEORA_DEC (GST_PAD_PARENT (pad));
Benjamin Otte's avatar
Benjamin Otte committed
529
530

  switch (GST_EVENT_TYPE (event)) {
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
531
    case GST_EVENT_SEEK:{
532
      gint64 value;
Scott Wheeler Wheeler's avatar
Scott Wheeler Wheeler committed
533
      GstEvent *real_seek;
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
534

535
536
537
538
539
540
541
      /* we have to ask our peer to seek to time here as we know
       * nothing about how to generate a granulepos from the src
       * formats or anything.
       * 
       * First bring the requested format to time 
       */
      format = GST_FORMAT_TIME;
Wim Taymans's avatar
Wim Taymans committed
542
543
      if (!(res = theora_dec_src_convert (pad, GST_EVENT_SEEK_FORMAT (event),
                  GST_EVENT_SEEK_OFFSET (event), &format, &value)))
544
        goto error;
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
545

546
      /* then seek with time on the peer */
Scott Wheeler Wheeler's avatar
Scott Wheeler Wheeler committed
547
      real_seek = gst_event_new_seek (
548
549
550
551
552
          (GST_EVENT_SEEK_TYPE (event) & ~GST_SEEK_FORMAT_MASK) |
          format, value);

      res = gst_pad_send_event (GST_PAD_PEER (dec->sinkpad), real_seek);

Benjamin Otte's avatar
Benjamin Otte committed
553
554
555
556
557
558
559
560
561
      gst_event_unref (event);
      break;
    }
    default:
      res = gst_pad_event_default (pad, event);
      break;
  }

  return res;
562
563
564
565

error:
  gst_event_unref (event);
  return res;
Benjamin Otte's avatar
Benjamin Otte committed
566
567
}

568
569
570
571
572
573
574
575
576
577
578
579
static GstCaps *
theora_dec_src_getcaps (GstPad * pad)
{
  GstCaps *caps;

  GST_LOCK (pad);
  caps = GST_PAD_CAPS (pad);
  GST_UNLOCK (pad);

  if (caps)
    return gst_caps_ref (caps);
  else
580
    return gst_caps_ref ((GstCaps *) gst_pad_get_pad_template_caps (pad));
581
582
}

583
584
static gboolean
theora_dec_sink_event (GstPad * pad, GstEvent * event)
Benjamin Otte's avatar
Benjamin Otte committed
585
{
586
  gint64 start_value, end_value, time, bytes;
587
  gboolean ret = TRUE;
588
589
590
  GstTheoraDec *dec;

  dec = GST_THEORA_DEC (GST_PAD_PARENT (pad));
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
591

Benjamin Otte's avatar
Benjamin Otte committed
592
593
594
  GST_LOG_OBJECT (dec, "handling event");
  switch (GST_EVENT_TYPE (event)) {
    case GST_EVENT_DISCONTINUOUS:
595
      GST_STREAM_LOCK (pad);
596
597
598
      if (gst_event_discont_get_value (event, GST_FORMAT_DEFAULT,
              &start_value, &end_value)) {
        dec->granulepos = start_value;
599
        GST_DEBUG_OBJECT (dec,
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
600
            "setting granuleposition to %" G_GUINT64_FORMAT " after discont",
601
            start_value);
Benjamin Otte's avatar
Benjamin Otte committed
602
      } else {
603
604
        GST_WARNING_OBJECT (dec,
            "discont event didn't include offset, we might set it wrong now");
605
        dec->granulepos = -1;
Benjamin Otte's avatar
Benjamin Otte committed
606
      }
607
      if (dec->packetno < 3) {
608
609
610
611
        if (dec->granulepos != 0)
          GST_ELEMENT_ERROR (dec, STREAM, DECODE, (NULL),
              ("can't handle discont before parsing first 3 packets"));
        dec->packetno = 0;
612
613
614
        gst_pad_push_event (dec->srcpad, gst_event_new_discontinuous (FALSE,
                GST_FORMAT_TIME, (guint64) 0, GST_FORMAT_DEFAULT,
                (guint64) 0, GST_FORMAT_BYTES, (guint64) 0, 0));
615
      } else {
616
617
618
619
620
621
        GstFormat time_format, default_format, bytes_format;

        time_format = GST_FORMAT_TIME;
        default_format = GST_FORMAT_DEFAULT;
        bytes_format = GST_FORMAT_BYTES;

622
        /* if one of them works, all of them work */
623
624
625
        if (theora_dec_sink_convert (dec->sinkpad, GST_FORMAT_DEFAULT,
                dec->granulepos, &time_format, &time)
            && theora_dec_src_convert (dec->srcpad, GST_FORMAT_TIME, time,
626
                &default_format, &start_value)
627
628
            && theora_dec_src_convert (dec->srcpad, GST_FORMAT_TIME, time,
                &bytes_format, &bytes)) {
629
630
631
632
          gst_pad_push_event (dec->srcpad,
              gst_event_new_discontinuous (FALSE, GST_FORMAT_TIME,
                  time, GST_FORMAT_DEFAULT, start_value, GST_FORMAT_BYTES,
                  bytes, 0));
633
          /* store new framenumber */
634
          dec->packetno = start_value + 3;
635
636
637
638
        } else {
          GST_ERROR_OBJECT (dec,
              "failed to parse data for DISCONT event, not sending any");
        }
639
640
        /* sync to keyframe */
        dec->need_keyframe = TRUE;
641
      }
642
      GST_STREAM_UNLOCK (pad);
643
      gst_event_unref (event);
Benjamin Otte's avatar
Benjamin Otte committed
644
645
      break;
    default:
646
      ret = gst_pad_event_default (dec->sinkpad, event);
Benjamin Otte's avatar
Benjamin Otte committed
647
648
      break;
  }
649
  return ret;
Benjamin Otte's avatar
Benjamin Otte committed
650
651
}

652
653
654
655
#define ROUND_UP_2(x) (((x) + 1) & ~1)
#define ROUND_UP_4(x) (((x) + 3) & ~3)
#define ROUND_UP_8(x) (((x) + 7) & ~7)

656
static GstFlowReturn
657
theora_handle_comment_packet (GstTheoraDec * dec, ogg_packet * packet)
Benjamin Otte's avatar
Benjamin Otte committed
658
{
659
  gchar *encoder = NULL;
Benjamin Otte's avatar
Benjamin Otte committed
660
  GstBuffer *buf;
661
662
663
664
665
  GstTagList *list;

  GST_DEBUG ("parsing comment packet");

  buf = gst_buffer_new_and_alloc (packet->bytes);
666
  memcpy (GST_BUFFER_DATA (buf), packet->packet, packet->bytes);
667

668
669
  list =
      gst_tag_list_from_vorbiscomment_buffer (buf, (guint8 *) "\201theora", 7,
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
      &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_NOMINAL_BITRATE, dec->info.target_bitrate,
      GST_TAG_VIDEO_CODEC, "Theora", NULL);

  //gst_element_found_tags_for_pad (GST_ELEMENT (dec), dec->srcpad, 0, list);
689
  gst_tag_list_free (list);
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
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
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844

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

  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'),
      "framerate", G_TYPE_DOUBLE,
      ((gdouble) dec->info.fps_numerator) / dec->info.fps_denominator,
      "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);

  dec->initialized = TRUE;

  return GST_FLOW_OK;
}

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

  GST_DEBUG ("parsing header packet");

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

  switch (packet->packetno) {
    case 1:
      res = theora_handle_comment_packet (dec, packet);
      break;
    case 2:
      res = theora_handle_type_packet (dec, packet);
      break;
    default:
      /* ignore */
      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;
  }
}

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;

  if (!dec->initialized)
    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;
  }

  if (theora_decode_packetin (&dec->state, packet))
    goto could_not_read;

  if (theora_decode_YUVout (&dec->state, &yuv) < 0)
    goto decode_error;

  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 */
Wim Taymans's avatar
Wim Taymans committed
845
846
847
  result = gst_pad_alloc_buffer (dec->srcpad, GST_BUFFER_OFFSET_NONE, out_size,
      GST_PAD_CAPS (dec->srcpad), &out);
  if (result != GST_FLOW_OK)
848
849
850
851
852
    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
853
   * 1 row/column of luma samples with one chroma sample in colorspace conversion. 
Wim Taymans's avatar
Wim Taymans committed
854
   * We compensate for this by adding a black border around the image when the
855
   * offset or size is odd (see above).
856
857
   */
  {
Andy Wingo Wingo's avatar
Andy Wingo Wingo committed
858
859
860
    guchar *dest_y, *src_y;
    guchar *dest_u, *src_u;
    guchar *dest_v, *src_v;
861

Andy Wingo Wingo's avatar
Andy Wingo Wingo committed
862
    dest_y = GST_BUFFER_DATA (out);
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
    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;
    }

    src_u = yuv.u + dec->offset_x / 2 + dec->offset_y / 2 * yuv.uv_stride;
    src_v = yuv.v + dec->offset_x / 2 + dec->offset_y / 2 * yuv.uv_stride;

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

  GST_BUFFER_OFFSET (out) = dec->packetno - 4;
  GST_BUFFER_OFFSET_END (out) = dec->packetno - 3;
  GST_BUFFER_DURATION (out) =
      GST_SECOND * ((gdouble) dec->info.fps_denominator) /
      dec->info.fps_numerator;
  GST_BUFFER_TIMESTAMP (out) = outtime;

  result = gst_pad_push (dec->srcpad, out);

  return result;

  /* ERRORS */
not_initialized:
  {
    GST_ELEMENT_ERROR (GST_ELEMENT (dec), STREAM, DECODE,
        (NULL), ("no header sent yet (packet no is %d)", packet->packetno));
    return GST_FLOW_ERROR;
  }
dropping:
  {
    GST_WARNING_OBJECT (dec, "dropping frame because we need a keyframe");
    return GST_FLOW_OK;
  }
could_not_read:
  {
    GST_ELEMENT_ERROR (GST_ELEMENT (dec), STREAM, DECODE,
        (NULL), ("theora decoder did not read data packet"));
    return GST_FLOW_ERROR;
  }
decode_error:
  {
    GST_ELEMENT_ERROR (GST_ELEMENT (dec), STREAM, DECODE,
        (NULL), ("couldn't read out YUV image"));
    return GST_FLOW_ERROR;
  }
wrong_dimensions:
  {
    GST_ELEMENT_ERROR (GST_ELEMENT (dec), STREAM, DECODE,
        (NULL), ("dimensions of image do not match header"));
    return GST_FLOW_ERROR;
  }
no_buffer:
  {
    return GST_FLOW_OK;
  }
}

static GstFlowReturn
theora_dec_chain (GstPad * pad, GstBuffer * buf)
{
Benjamin Otte's avatar
Benjamin Otte committed
939
940
  GstTheoraDec *dec;
  ogg_packet packet;
941
  guint64 offset_end;
942
  GstClockTime outtime;
943
  GstFlowReturn result = GST_FLOW_OK;
Benjamin Otte's avatar
Benjamin Otte committed
944

945
  dec = GST_THEORA_DEC (GST_PAD_PARENT (pad));
Benjamin Otte's avatar
Benjamin Otte committed
946

947
  if (dec->packetno >= 3) {
948
949
    /* try timestamp first */
    outtime = GST_BUFFER_TIMESTAMP (buf);
950

951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
    if (outtime == -1) {
      gboolean need_flush = FALSE;

      /* the offset end field in theora is actually the time of
       * this frame, not the end time */
      offset_end = GST_BUFFER_OFFSET_END (buf);
      GST_DEBUG_OBJECT (dec, "got buffer with granule %lld", offset_end);

      if (offset_end != -1) {
        if (dec->granulepos == -1) {
          GST_DEBUG_OBJECT (dec, "first buffer with granule");
          need_flush = TRUE;
        }
        dec->granulepos = offset_end;
      }
      if (dec->granulepos == -1) {
        /* we need to wait for a buffer with at least a timestamp or an 
         * offset before we can generate valid timestamps */
        dec->queued = g_list_append (dec->queued, buf);
        GST_DEBUG_OBJECT (dec, "queued buffer");
        return GST_FLOW_OK;
      } else {
        /* granulepos to time */
        outtime =
            GST_SECOND * theora_granule_time (&dec->state, dec->granulepos);

        GST_DEBUG_OBJECT (dec, "granulepos=%lld outtime=%" GST_TIME_FORMAT,
            dec->granulepos, GST_TIME_ARGS (outtime));

        if (need_flush) {
          GList *walk;
          GstClockTime patch;
          gint64 len;
          gint64 old_granule = dec->granulepos;

          dec->granulepos = -1;

          len = g_list_length (dec->queued);

          GST_DEBUG_OBJECT (dec, "first buffer with granule, flushing");

          /* now resubmit all queued buffers with corrected timestamps */
          for (walk = dec->queued; walk; walk = g_list_next (walk)) {
            GstBuffer *qbuffer = GST_BUFFER (walk->data);

            patch = outtime - (GST_SECOND * len * dec->info.fps_denominator) /
                dec->info.fps_numerator,
                GST_DEBUG_OBJECT (dec, "patch buffer %lld %lld", len, patch);
            GST_BUFFER_TIMESTAMP (qbuffer) = patch;

            /* buffers are unreffed in chain function */
            theora_dec_chain (pad, qbuffer);
            len--;
          }
          g_list_free (dec->queued);
          dec->queued = NULL;

          dec->granulepos = old_granule;
        }
      }
    } else {
      GST_DEBUG_OBJECT (dec, "got buffer with timestamp %lld", outtime);
    }
1014
1015
1016
  } else {
    /* we don't know yet */
    outtime = -1;
1017
1018
  }

Benjamin Otte's avatar
Benjamin Otte committed
1019
1020
1021
  /* make ogg_packet out of the buffer */
  packet.packet = GST_BUFFER_DATA (buf);
  packet.bytes = GST_BUFFER_SIZE (buf);
1022
  packet.granulepos = dec->granulepos;
1023
  packet.packetno = dec->packetno;
1024
1025
  packet.b_o_s = (packet.packetno == 0) ? 1 : 0;
  packet.e_o_s = 0;
1026

1027
1028
  GST_DEBUG_OBJECT (dec, "header=%d packetno=%lld, outtime=%" GST_TIME_FORMAT,
      packet.packet[0], packet.packetno, GST_TIME_ARGS (outtime));
1029

Benjamin Otte's avatar
Benjamin Otte committed
1030
1031
  /* switch depending on packet type */
  if (packet.packet[0] & 0x80) {
1032
1033
    if (packet.packetno > 3) {
      GST_WARNING_OBJECT (GST_OBJECT (dec), "Ignoring header");
1034
      goto done;
1035
    }
1036
    result = theora_handle_header_packet (dec, &packet);
Benjamin Otte's avatar
Benjamin Otte committed
1037
  } else {
1038
    result = theora_handle_data_packet (dec, &packet, outtime);
Benjamin Otte's avatar
Benjamin Otte committed
1039
  }
1040

1041
done:
1042
  dec->packetno++;
1043
  _inc_granulepos (dec);
1044
1045

  gst_buffer_unref (buf);
1046
1047

  return result;
Benjamin Otte's avatar
Benjamin Otte committed
1048
1049
1050
}

static GstElementStateReturn
Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
1051
theora_dec_change_state (GstElement * element)
Benjamin Otte's avatar
Benjamin Otte committed
1052
1053
{
  GstTheoraDec *dec = GST_THEORA_DEC (element);
1054
1055
  gint transition;
  GstElementStateReturn ret;
Benjamin Otte's avatar
Benjamin Otte committed
1056

1057
1058
1059
  transition = GST_STATE_TRANSITION (element);

  switch (transition) {
Benjamin Otte's avatar
Benjamin Otte committed
1060
1061
1062
1063
1064
    case GST_STATE_NULL_TO_READY:
      break;
    case GST_STATE_READY_TO_PAUSED:
      theora_info_init (&dec->info);
      theora_comment_init (&dec->comment);
1065
      dec->need_keyframe = TRUE;
1066
      dec->initialized = FALSE;
1067
      dec->granulepos = -1;
Benjamin Otte's avatar
Benjamin Otte committed
1068
1069
1070
      break;
    case GST_STATE_PAUSED_TO_PLAYING:
      break;
1071
1072
1073
1074
1075
1076
1077
    default:
      break;
  }

  ret = parent_class->change_state (element);

  switch (transition) {
Benjamin Otte's avatar
Benjamin Otte committed
1078
1079
1080
1081
1082
1083
1084
    case GST_STATE_PLAYING_TO_PAUSED:
      break;
    case GST_STATE_PAUSED_TO_READY:
      theora_clear (&dec->state);
      theora_comment_clear (&dec->comment);
      theora_info_clear (&dec->info);
      dec->packetno = 0;
1085
      dec->granulepos = -1;
Benjamin Otte's avatar
Benjamin Otte committed
1086
1087
1088
1089
1090
1091
1092
      break;
    case GST_STATE_READY_TO_NULL:
      break;
    default:
      break;
  }

1093
  return ret;
Benjamin Otte's avatar
Benjamin Otte committed
1094
}
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126

static void
theora_dec_set_property (GObject * object, guint prop_id,
    const GValue * value, GParamSpec * pspec)
{
  GstTheoraDec *dec = GST_THEORA_DEC (object);

  switch (prop_id) {
    case ARG_CROP:
      dec->crop = g_value_get_boolean (value);
      break;
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
  }
}

static void
theora_dec_get_property (GObject * object, guint prop_id,
    GValue * value, GParamSpec * pspec)
{
  GstTheoraDec *dec = GST_THEORA_DEC (object);

  switch (prop_id) {
    case ARG_CROP:
      g_value_set_boolean (value, dec->crop);
      break;
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
  }
}