gstffmpegdec.c 15.5 KB
Newer Older
Andy Wingo Wingo's avatar
Andy Wingo Wingo committed
1
/* GStreamer
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
 * Copyright (C) <1999> Erik Walthinsen <omega@cse.ogi.edu>
 *
 * 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.
 */

20
#ifdef HAVE_CONFIG_H
21
#include "config.h"
22
#endif
23

24
#include <assert.h>
25
#include <string.h>
26

27 28 29 30 31
#ifdef HAVE_FFMPEG_UNINSTALLED
#include <avcodec.h>
#else
#include <ffmpeg/avcodec.h>
#endif
32 33 34

#include <gst/gst.h>

35
#include "gstffmpegcodecmap.h"
36

37 38 39 40 41 42 43 44 45 46
typedef struct _GstFFMpegDec GstFFMpegDec;

struct _GstFFMpegDec {
  GstElement element;

  /* We need to keep track of our pads, so we do so here. */
  GstPad *srcpad;
  GstPad *sinkpad;

  AVCodecContext *context;
47
  AVFrame *picture;
48
  gboolean opened;
49 50 51 52 53 54 55 56
};

typedef struct _GstFFMpegDecClass GstFFMpegDecClass;

struct _GstFFMpegDecClass {
  GstElementClass parent_class;

  AVCodec *in_plugin;
57
  GstPadTemplate *srctempl, *sinktempl;
58 59
};

Ronald S. Bultje's avatar
Bla  
Ronald S. Bultje committed
60 61 62
typedef struct _GstFFMpegDecClassParams GstFFMpegDecClassParams;

struct _GstFFMpegDecClassParams {
63
  AVCodec *in_plugin;
Ronald S. Bultje's avatar
Bla  
Ronald S. Bultje committed
64 65
  GstCaps *srccaps, *sinkcaps;
};
66

67 68 69 70 71 72 73 74 75 76
#define GST_TYPE_FFMPEGDEC \
  (gst_ffmpegdec_get_type())
#define GST_FFMPEGDEC(obj) \
  (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_FFMPEGDEC,GstFFMpegDec))
#define GST_FFMPEGDEC_CLASS(klass) \
  (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_FFMPEGDEC,GstFFMpegDecClass))
#define GST_IS_FFMPEGDEC(obj) \
  (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_FFMPEGDEC))
#define GST_IS_FFMPEGDEC_CLASS(obj) \
  (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_FFMPEGDEC))
77 78 79 80 81 82 83 84 85 86 87 88 89 90

enum {
  /* FILL ME */
  LAST_SIGNAL
};

enum {
  ARG_0,
  /* FILL ME */
};

static GHashTable *global_plugins;

/* A number of functon prototypes are given so we can refer to them later. */
Ronald S. Bultje's avatar
Bla  
Ronald S. Bultje committed
91
static void	gst_ffmpegdec_base_init		(GstFFMpegDecClass *klass);
92 93
static void	gst_ffmpegdec_class_init	(GstFFMpegDecClass *klass);
static void	gst_ffmpegdec_init		(GstFFMpegDec *ffmpegdec);
94 95 96
static void	gst_ffmpegdec_dispose		(GObject      *object);

static GstPadLinkReturn	gst_ffmpegdec_connect	(GstPad    *pad,
David Schleef's avatar
David Schleef committed
97
						 const GstCaps  *caps);
98
static void	gst_ffmpegdec_chain		(GstPad    *pad,
99
						 GstData   *data);
100

101 102
static GstElementStateReturn
		gst_ffmpegdec_change_state	(GstElement *element);
103

104
#if 0
105 106 107 108 109
/* some sort of bufferpool handling, but different */
static int	gst_ffmpegdec_get_buffer	(AVCodecContext *context,
						 AVFrame        *picture);
static void	gst_ffmpegdec_release_buffer	(AVCodecContext *context,
						 AVFrame        *picture);
110
#endif
111 112 113

static GstElementClass *parent_class = NULL;

114
/*static guint gst_ffmpegdec_signals[LAST_SIGNAL] = { 0 }; */
115

Ronald S. Bultje's avatar
Bla  
Ronald S. Bultje committed
116 117 118 119 120 121
static void
gst_ffmpegdec_base_init (GstFFMpegDecClass *klass)
{
  GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
  GstElementClass *element_class = GST_ELEMENT_CLASS (klass);
  GstFFMpegDecClassParams *params;
Benjamin Otte's avatar
Benjamin Otte committed
122
  GstElementDetails details;
Ronald S. Bultje's avatar
Bla  
Ronald S. Bultje committed
123 124 125 126
  GstPadTemplate *sinktempl, *srctempl;

  params = g_hash_table_lookup (global_plugins,
		GINT_TO_POINTER (G_OBJECT_CLASS_TYPE (gobject_class)));
127 128 129 130
  if (!params)
    params = g_hash_table_lookup (global_plugins,
		GINT_TO_POINTER (0));
  g_assert (params);
Ronald S. Bultje's avatar
Bla  
Ronald S. Bultje committed
131 132

  /* construct the element details struct */
Benjamin Otte's avatar
Benjamin Otte committed
133
  details.longname = g_strdup_printf("FFMPEG %s decoder",
Ronald S. Bultje's avatar
Bla  
Ronald S. Bultje committed
134
				      params->in_plugin->name);
Benjamin Otte's avatar
Benjamin Otte committed
135
  details.klass = g_strdup_printf("Codec/Decoder/%s",
Ronald S. Bultje's avatar
Bla  
Ronald S. Bultje committed
136 137
				   (params->in_plugin->type == CODEC_TYPE_VIDEO) ?
				   "Video" : "Audio");
Benjamin Otte's avatar
Benjamin Otte committed
138
  details.description = g_strdup_printf("FFMPEG %s decoder",
Ronald S. Bultje's avatar
Bla  
Ronald S. Bultje committed
139
					 params->in_plugin->name);
Benjamin Otte's avatar
Benjamin Otte committed
140 141 142 143 144 145
  details.author = "Wim Taymans <wim.taymans@chello.be>, "
		  "Ronald Bultje <rbultje@ronald.bitfreak.net>";
  gst_element_class_set_details (element_class, &details);
  g_free (details.longname);
  g_free (details.klass);
  g_free (details.description);
Ronald S. Bultje's avatar
Bla  
Ronald S. Bultje committed
146 147 148

  /* pad templates */
  sinktempl = gst_pad_template_new ("sink", GST_PAD_SINK,
David Schleef's avatar
David Schleef committed
149
				    GST_PAD_ALWAYS, params->sinkcaps);
Ronald S. Bultje's avatar
Bla  
Ronald S. Bultje committed
150
  srctempl = gst_pad_template_new ("src", GST_PAD_SRC,
David Schleef's avatar
David Schleef committed
151
				   GST_PAD_ALWAYS, params->srccaps);
Ronald S. Bultje's avatar
Bla  
Ronald S. Bultje committed
152 153 154 155 156 157 158 159 160

  gst_element_class_add_pad_template (element_class, srctempl);
  gst_element_class_add_pad_template (element_class, sinktempl);

  klass->in_plugin = params->in_plugin;
  klass->srctempl = srctempl;
  klass->sinktempl = sinktempl;
}

161 162 163 164 165 166 167 168 169
static void
gst_ffmpegdec_class_init (GstFFMpegDecClass *klass)
{
  GObjectClass *gobject_class;
  GstElementClass *gstelement_class;

  gobject_class = (GObjectClass*)klass;
  gstelement_class = (GstElementClass*)klass;

170
  parent_class = g_type_class_peek_parent (klass);
171

172 173 174 175 176 177 178 179 180 181 182 183 184 185
  gobject_class->dispose = gst_ffmpegdec_dispose;
  gstelement_class->change_state = gst_ffmpegdec_change_state;
}

static void
gst_ffmpegdec_init (GstFFMpegDec *ffmpegdec)
{
  GstFFMpegDecClass *oclass = (GstFFMpegDecClass*)(G_OBJECT_GET_CLASS (ffmpegdec));

  /* setup pads */
  ffmpegdec->sinkpad = gst_pad_new_from_template (oclass->sinktempl, "sink");
  gst_pad_set_link_function (ffmpegdec->sinkpad, gst_ffmpegdec_connect);
  gst_pad_set_chain_function (ffmpegdec->sinkpad, gst_ffmpegdec_chain);
  ffmpegdec->srcpad = gst_pad_new_from_template (oclass->srctempl, "src");
186
  gst_pad_use_explicit_caps (ffmpegdec->srcpad);
187 188 189 190 191 192 193 194 195 196 197 198 199 200 201

  gst_element_add_pad (GST_ELEMENT (ffmpegdec), ffmpegdec->sinkpad);
  gst_element_add_pad (GST_ELEMENT (ffmpegdec), ffmpegdec->srcpad);

  /* some ffmpeg data */
  ffmpegdec->context = avcodec_alloc_context();
  ffmpegdec->picture = avcodec_alloc_frame();

  ffmpegdec->opened = FALSE;
}

static void
gst_ffmpegdec_dispose (GObject *object)
{
  GstFFMpegDec *ffmpegdec = (GstFFMpegDec *) object;
202 203 204 205

  G_OBJECT_CLASS (parent_class)->dispose (object);
  /* old session should have been closed in element_class->dispose */
  g_assert (!ffmpegdec->opened);
206

207 208 209
  /* clean up remaining allocated data */
  av_free (ffmpegdec->context);
  av_free (ffmpegdec->picture);
210 211
}

Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
212
static GstPadLinkReturn
213
gst_ffmpegdec_connect (GstPad  *pad,
David Schleef's avatar
David Schleef committed
214
		       const GstCaps *caps)
215 216 217 218
{
  GstFFMpegDec *ffmpegdec = (GstFFMpegDec *)(gst_pad_get_parent (pad));
  GstFFMpegDecClass *oclass = (GstFFMpegDecClass*)(G_OBJECT_GET_CLASS (ffmpegdec));

219 220 221 222 223
  /* close old session */
  if (ffmpegdec->opened) {
    avcodec_close (ffmpegdec->context);
    ffmpegdec->opened = FALSE;
  }
224

225 226
  /* set defaults */
  avcodec_get_context_defaults (ffmpegdec->context);
227

228
#if 0
229 230 231
  /* set buffer functions */
  ffmpegdec->context->get_buffer = gst_ffmpegdec_get_buffer;
  ffmpegdec->context->release_buffer = gst_ffmpegdec_release_buffer;
232
#endif
233

234 235 236
  /* get size and so */
  gst_ffmpeg_caps_to_codectype (oclass->in_plugin->type,
				caps, ffmpegdec->context);
237

238 239 240 241 242
  /* we dont send complete frames - FIXME: we need a 'framed' property
   * in caps */
  if (oclass->in_plugin->capabilities & CODEC_CAP_TRUNCATED &&
      (ffmpegdec->context->codec_id == CODEC_ID_MPEG1VIDEO ||
       ffmpegdec->context->codec_id == CODEC_ID_MPEG2VIDEO))
243 244
    ffmpegdec->context->flags |= CODEC_FLAG_TRUNCATED;

245 246 247
  /* do *not* draw edges */
  ffmpegdec->context->flags |= CODEC_FLAG_EMU_EDGE;

248 249 250
  /* open codec - we don't select an output pix_fmt yet,
   * simply because we don't know! We only get it
   * during playback... */
251
  if (avcodec_open (ffmpegdec->context, oclass->in_plugin) < 0) {
252 253
    avcodec_close (ffmpegdec->context);
    GST_DEBUG ("ffdec_%s: Failed to open FFMPEG codec",
254
		oclass->in_plugin->name);
255
    return GST_PAD_LINK_REFUSED;
256
  }
257 258 259 260

  /* done! */
  ffmpegdec->opened = TRUE;

261
  return GST_PAD_LINK_OK;
262 263
}

264
#if 0
265 266 267 268 269 270 271 272 273
static int
gst_ffmpegdec_get_buffer (AVCodecContext *context,
			  AVFrame        *picture)
{
  GstBuffer *buf = NULL;
  gulong bufsize = 0;

  switch (context->codec_type) {
    case CODEC_TYPE_VIDEO:
274
      bufsize = avpicture_get_size (context->pix_fmt,
275 276 277 278 279 280
				    context->width,
				    context->height);
      buf = gst_buffer_new_and_alloc (bufsize);
      avpicture_fill ((AVPicture *) picture, GST_BUFFER_DATA (buf),
		      context->pix_fmt,
		      context->width, context->height);
281 282 283 284 285 286
      break;

    case CODEC_TYPE_AUDIO:
    default:
      g_assert (0);
      break;
287 288
  }

289 290 291 292 293 294 295 296 297 298 299 300 301
  /* tell ffmpeg we own this buffer
   *
   * we also use an evil hack (keep buffer in base[0])
   * to keep a reference to the buffer in release_buffer(),
   * so that we can ref() it here and unref() it there
   * so that we don't need to copy data */
  picture->type = FF_BUFFER_TYPE_USER;
  picture->age = G_MAXINT;
  picture->base[0] = (int8_t *) buf;
  gst_buffer_ref (buf);

  return 0;
}
302

303 304 305 306 307 308 309 310 311 312 313 314 315
static void
gst_ffmpegdec_release_buffer (AVCodecContext *context,
			      AVFrame        *picture)
{
  gint i;
  GstBuffer *buf = GST_BUFFER (picture->base[0]);
  gst_buffer_unref (buf);

  /* zero out the reference in ffmpeg */
  for (i=0;i<4;i++) {
    picture->data[i] = NULL;
    picture->linesize[i] = 0;
  }
316
}
317
#endif
318 319

static void
320
gst_ffmpegdec_chain (GstPad    *pad,
321
		     GstData *_data)
322
{
323
  GstBuffer *inbuf = GST_BUFFER (_data);
324
  GstBuffer *outbuf = NULL;
325
  GstFFMpegDec *ffmpegdec = (GstFFMpegDec *)(gst_pad_get_parent (pad));
326
  GstFFMpegDecClass *oclass = (GstFFMpegDecClass*)(G_OBJECT_GET_CLASS (ffmpegdec));
327
  guchar *data;
328 329 330
  gint size, len = 0;
  gint have_data;

Ronald S. Bultje's avatar
Ronald S. Bultje committed
331
  if (!ffmpegdec->opened) {
332
    GST_ELEMENT_ERROR (ffmpegdec, CORE, NEGOTIATION, (NULL),
333 334
		       ("ffdec_%s: input format was not set before data start",
		       oclass->in_plugin->name));
Ronald S. Bultje's avatar
Ronald S. Bultje committed
335 336 337
    return;
  }

338 339 340 341
  /* FIXME: implement event awareness (especially EOS
   * (av_close_codec ()) and FLUSH/DISCONT
   * (avcodec_flush_buffers ()))
   */
342 343 344 345 346 347 348

  data = GST_BUFFER_DATA (inbuf);
  size = GST_BUFFER_SIZE (inbuf);

  do {
    ffmpegdec->context->frame_number++;

349 350
    switch (oclass->in_plugin->type) {
      case CODEC_TYPE_VIDEO:
351
	/* workarounds, functions write to buffers:
352 353 354
	 *  libavcodec/svq1.c:svq1_decode_frame writes to the given buffer.
         *  libavcodec/svq3.c:svq3_decode_slice_header too.
         * ffmpeg devs know about it and will fix it (they said). */
355 356
	if (oclass->in_plugin->id == CODEC_ID_SVQ1 ||
            oclass->in_plugin->id == CODEC_ID_SVQ3) {
357 358 359 360
	  inbuf = gst_buffer_copy_on_write(inbuf);
	  data = GST_BUFFER_DATA (inbuf);
	  size = GST_BUFFER_SIZE (inbuf);
	}
361 362 363 364
        len = avcodec_decode_video (ffmpegdec->context,
				    ffmpegdec->picture,
				    &have_data,
				    data, size);
365
        if (have_data) {
366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383
          /* libavcodec constantly crashes on stupid buffer allocation
           * errors inside. This drives me crazy, so we let it allocate
           * it's own buffers and copy to our own buffer afterwards... */
          AVPicture pic;
          gint size = avpicture_get_size (ffmpegdec->context->pix_fmt,
					  ffmpegdec->context->width,
					  ffmpegdec->context->height);
          outbuf = gst_buffer_new_and_alloc (size);
          avpicture_fill (&pic, GST_BUFFER_DATA (outbuf),
			  ffmpegdec->context->pix_fmt,
			  ffmpegdec->context->width,
			  ffmpegdec->context->height);
          img_convert (&pic, ffmpegdec->context->pix_fmt,
		       (AVPicture *) ffmpegdec->picture,
		       ffmpegdec->context->pix_fmt,
		       ffmpegdec->context->width,
		       ffmpegdec->context->height);

384 385 386
          /* this isn't necessarily true, but it's better than nothing */
          GST_BUFFER_DURATION (outbuf) = GST_BUFFER_DURATION (inbuf);
        }
387
        break;
388

389
      case CODEC_TYPE_AUDIO:
390
        outbuf = gst_buffer_new_and_alloc (AVCODEC_MAX_AUDIO_FRAME_SIZE);
391
        len = avcodec_decode_audio (ffmpegdec->context,
392
				    (int16_t *) GST_BUFFER_DATA (outbuf),
393 394
				    &have_data,
				    data, size);
395

396 397 398 399 400 401 402 403
        if (have_data) {
          GST_BUFFER_SIZE (outbuf) = have_data;
          GST_BUFFER_DURATION (outbuf) = (have_data * GST_SECOND) /
					   (ffmpegdec->context->channels *
					    ffmpegdec->context->sample_rate);
        } else {
          gst_buffer_unref (outbuf);
        } 
404 405 406 407 408
        break;
      default:
	g_assert(0);
        break;
    }
409 410

    if (len < 0) {
411 412
      g_warning ("ffdec_%s: decoding error",
		 oclass->in_plugin->name);
413 414 415
      break;
    }

416
    if (have_data) {
417
      if (!GST_PAD_CAPS (ffmpegdec->srcpad)) {
418 419 420 421
        GstCaps *caps;
        caps = gst_ffmpeg_codectype_to_caps (oclass->in_plugin->type,
					     ffmpegdec->context);
        if (caps == NULL ||
422
            !gst_pad_set_explicit_caps (ffmpegdec->srcpad, caps)) {
423
          GST_ELEMENT_ERROR (ffmpegdec, CORE, NEGOTIATION, (NULL),
424 425
			     ("Failed to link ffmpeg decoder (%s) to next element",
			     oclass->in_plugin->name));
426 427
          return;
        }
428 429 430
      }

      GST_BUFFER_TIMESTAMP (outbuf) = GST_BUFFER_TIMESTAMP (inbuf);
431

432
      gst_pad_push (ffmpegdec->srcpad, GST_DATA (outbuf));
433 434 435 436
    } 

    size -= len;
    data += len;
437
  } while (size > 0);
438 439 440 441

  gst_buffer_unref (inbuf);
}

442 443
static GstElementStateReturn
gst_ffmpegdec_change_state (GstElement *element)
444
{
445 446 447 448 449 450 451 452 453
  GstFFMpegDec *ffmpegdec = (GstFFMpegDec *) element;
  gint transition = GST_STATE_TRANSITION (element);

  switch (transition) {
    case GST_STATE_PAUSED_TO_READY:
      if (ffmpegdec->opened) {
        avcodec_close (ffmpegdec->context);
        ffmpegdec->opened = FALSE;
      }
454 455 456
      break;
  }

457 458
  if (GST_ELEMENT_CLASS (parent_class)->change_state)
    return GST_ELEMENT_CLASS (parent_class)->change_state (element);
459

460
  return GST_STATE_SUCCESS;
461 462 463 464 465 466 467
}

gboolean
gst_ffmpegdec_register (GstPlugin *plugin)
{
  GTypeInfo typeinfo = {
    sizeof(GstFFMpegDecClass),      
Ronald S. Bultje's avatar
Bla  
Ronald S. Bultje committed
468
    (GBaseInitFunc)gst_ffmpegdec_base_init,
469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484
    NULL,
    (GClassInitFunc)gst_ffmpegdec_class_init,
    NULL,
    NULL,
    sizeof(GstFFMpegDec),
    0,
    (GInstanceInitFunc)gst_ffmpegdec_init,
  };
  GType type;
  AVCodec *in_plugin;
  
  in_plugin = first_avcodec;

  global_plugins = g_hash_table_new (NULL, NULL);

  while (in_plugin) {
485
    GstFFMpegDecClassParams *params;
Ronald S. Bultje's avatar
Bla  
Ronald S. Bultje committed
486 487
    GstCaps *srccaps, *sinkcaps;
    gchar *type_name;
488

Ronald S. Bultje's avatar
Ronald S. Bultje committed
489 490 491
    /* no quasi-codecs, please */
    if (in_plugin->id == CODEC_ID_RAWVIDEO ||
	(in_plugin->id >= CODEC_ID_PCM_S16LE &&
Ronald S. Bultje's avatar
Ronald S. Bultje committed
492
	 in_plugin->id <= CODEC_ID_PCM_ALAW)) {
Ronald S. Bultje's avatar
Ronald S. Bultje committed
493
      goto next;
494
    }
Ronald S. Bultje's avatar
Ronald S. Bultje committed
495 496 497

    /* only decoders */
    if (!in_plugin->decode) {
498 499
      goto next;
    }
500 501

    /* first make sure we've got a supported type */
502
    sinkcaps = gst_ffmpeg_codecid_to_caps (in_plugin->id, NULL, FALSE);
503 504 505 506
    srccaps  = gst_ffmpeg_codectype_to_caps (in_plugin->type, NULL);
    if (!sinkcaps || !srccaps)
      goto next;

507
    /* construct the type */
Ronald S. Bultje's avatar
Ronald S. Bultje committed
508
    type_name = g_strdup_printf("ffdec_%s", in_plugin->name);
509

510
    /* if it's already registered, drop it */
511 512 513 514 515
    if (g_type_from_name(type_name)) {
      g_free(type_name);
      goto next;
    }

516 517 518 519 520 521 522 523
    params = g_new0 (GstFFMpegDecClassParams, 1);
    params->in_plugin = in_plugin;
    params->srccaps = srccaps;
    params->sinkcaps = sinkcaps;
    g_hash_table_insert (global_plugins, 
		         GINT_TO_POINTER (0), 
			 (gpointer) params);
    
524 525 526
    /* create the gtype now
     * (Ronald) MPEG-4 gets a higher priority because it has been well-
     * tested and by far outperforms divxdec/xviddec - so we prefer it. */
527
    type = g_type_register_static(GST_TYPE_ELEMENT, type_name , &typeinfo, 0);
528 529 530
    if (!gst_element_register (plugin, type_name,
			       (in_plugin->id == CODEC_ID_MPEG4) ?
			       GST_RANK_PRIMARY : GST_RANK_MARGINAL, type)) {
David Schleef's avatar
David Schleef committed
531
      g_free (type_name);
Ronald S. Bultje's avatar
Bla  
Ronald S. Bultje committed
532
      return FALSE;
David Schleef's avatar
David Schleef committed
533 534 535
    }

    g_free (type_name);
536

537 538 539
    g_hash_table_insert (global_plugins, 
		         GINT_TO_POINTER (type), 
			 (gpointer) params);
540 541 542 543

next:
    in_plugin = in_plugin->next;
  }
544
  g_hash_table_remove (global_plugins, GINT_TO_POINTER (0));
545 546 547

  return TRUE;
}