gstffmpegdec.c 15 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 21
#include "config.h"

22
#include <assert.h>
23
#include <string.h>
24

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

#include <gst/gst.h>

33
#include "gstffmpegcodecmap.h"
34

35 36 37 38 39 40 41 42 43 44
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;
45
  AVFrame *picture;
46
  gboolean opened;
47 48 49 50 51 52 53 54
};

typedef struct _GstFFMpegDecClass GstFFMpegDecClass;

struct _GstFFMpegDecClass {
  GstElementClass parent_class;

  AVCodec *in_plugin;
55
  GstPadTemplate *srctempl, *sinktempl;
56 57
};

Ronald S. Bultje's avatar
Bla  
Ronald S. Bultje committed
58 59 60
typedef struct _GstFFMpegDecClassParams GstFFMpegDecClassParams;

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

65 66 67 68 69 70 71 72 73 74
#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))
75 76 77 78 79 80 81 82 83 84 85 86 87 88

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
89
static void	gst_ffmpegdec_base_init		(GstFFMpegDecClass *klass);
90 91
static void	gst_ffmpegdec_class_init	(GstFFMpegDecClass *klass);
static void	gst_ffmpegdec_init		(GstFFMpegDec *ffmpegdec);
92 93 94
static void	gst_ffmpegdec_dispose		(GObject      *object);

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

99 100
static GstElementStateReturn
		gst_ffmpegdec_change_state	(GstElement *element);
101

102
#if 0
103 104 105 106 107
/* 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);
108
#endif
109 110 111

static GstElementClass *parent_class = NULL;

112
/*static guint gst_ffmpegdec_signals[LAST_SIGNAL] = { 0 }; */
113

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

  params = g_hash_table_lookup (global_plugins,
		GINT_TO_POINTER (G_OBJECT_CLASS_TYPE (gobject_class)));
125 126 127 128
  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
129 130 131 132 133

  /* construct the element details struct */
  details = g_new0 (GstElementDetails, 1);
  details->longname = g_strdup_printf("FFMPEG %s decoder",
				      params->in_plugin->name);
134
  details->klass = g_strdup_printf("Codec/Decoder/%s",
Ronald S. Bultje's avatar
Bla  
Ronald S. Bultje committed
135 136 137 138 139 140 141 142 143
				   (params->in_plugin->type == CODEC_TYPE_VIDEO) ?
				   "Video" : "Audio");
  details->description = g_strdup_printf("FFMPEG %s decoder",
					 params->in_plugin->name);
  details->author = g_strdup("Wim Taymans <wim.taymans@chello.be>\n"
			     "Ronald Bultje <rbultje@ronald.bitfreak.net>");

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

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

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

157 158 159 160 161 162 163 164 165
static void
gst_ffmpegdec_class_init (GstFFMpegDecClass *klass)
{
  GObjectClass *gobject_class;
  GstElementClass *gstelement_class;

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

166
  parent_class = g_type_class_peek_parent (klass);
167

168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196
  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");

  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;
197 198 199 200

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

202 203 204
  /* clean up remaining allocated data */
  av_free (ffmpegdec->context);
  av_free (ffmpegdec->picture);
205 206
}

Thomas Vander Stichele's avatar
Thomas Vander Stichele committed
207
static GstPadLinkReturn
208
gst_ffmpegdec_connect (GstPad  *pad,
David Schleef's avatar
David Schleef committed
209
		       const GstCaps *caps)
210 211 212 213
{
  GstFFMpegDec *ffmpegdec = (GstFFMpegDec *)(gst_pad_get_parent (pad));
  GstFFMpegDecClass *oclass = (GstFFMpegDecClass*)(G_OBJECT_GET_CLASS (ffmpegdec));

214 215 216 217 218
  /* close old session */
  if (ffmpegdec->opened) {
    avcodec_close (ffmpegdec->context);
    ffmpegdec->opened = FALSE;
  }
219

220 221
  /* set defaults */
  avcodec_get_context_defaults (ffmpegdec->context);
222

223
#if 0
224 225 226
  /* set buffer functions */
  ffmpegdec->context->get_buffer = gst_ffmpegdec_get_buffer;
  ffmpegdec->context->release_buffer = gst_ffmpegdec_release_buffer;
227
#endif
228

229 230 231
  /* get size and so */
  gst_ffmpeg_caps_to_codectype (oclass->in_plugin->type,
				caps, ffmpegdec->context);
232

233 234 235 236
  /* we dont send complete frames */
  if (oclass->in_plugin->capabilities & CODEC_CAP_TRUNCATED)
    ffmpegdec->context->flags |= CODEC_FLAG_TRUNCATED;

237 238 239
  /* do *not* draw edges */
  ffmpegdec->context->flags |= CODEC_FLAG_EMU_EDGE;

240 241 242
  /* open codec - we don't select an output pix_fmt yet,
   * simply because we don't know! We only get it
   * during playback... */
243
  if (avcodec_open (ffmpegdec->context, oclass->in_plugin) < 0) {
244 245
    avcodec_close (ffmpegdec->context);
    GST_DEBUG ("ffdec_%s: Failed to open FFMPEG codec",
246
		oclass->in_plugin->name);
247
    return GST_PAD_LINK_REFUSED;
248
  }
249 250 251 252

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

253
  return GST_PAD_LINK_OK;
254 255
}

256
#if 0
257 258 259 260 261 262 263 264 265
static int
gst_ffmpegdec_get_buffer (AVCodecContext *context,
			  AVFrame        *picture)
{
  GstBuffer *buf = NULL;
  gulong bufsize = 0;

  switch (context->codec_type) {
    case CODEC_TYPE_VIDEO:
266
      bufsize = avpicture_get_size (context->pix_fmt,
267 268 269 270 271 272
				    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);
273 274 275 276 277 278
      break;

    case CODEC_TYPE_AUDIO:
    default:
      g_assert (0);
      break;
279 280
  }

281 282 283 284 285 286 287 288 289 290 291 292 293
  /* 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;
}
294

295 296 297 298 299 300 301 302 303 304 305 306 307
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;
  }
308
}
309
#endif
310 311

static void
312
gst_ffmpegdec_chain (GstPad    *pad,
313
		     GstData *_data)
314
{
315
  GstBuffer *inbuf = GST_BUFFER (_data);
316
  GstBuffer *outbuf = NULL;
317
  GstFFMpegDec *ffmpegdec = (GstFFMpegDec *)(gst_pad_get_parent (pad));
318
  GstFFMpegDecClass *oclass = (GstFFMpegDecClass*)(G_OBJECT_GET_CLASS (ffmpegdec));
319
  guchar *data;
320 321 322
  gint size, len = 0;
  gint have_data;

Ronald S. Bultje's avatar
Ronald S. Bultje committed
323
  if (!ffmpegdec->opened) {
324 325 326
    gst_element_error (GST_ELEMENT (ffmpegdec),
		       "ffdec_%s: input format was not set before data-start",
		       oclass->in_plugin->name);
Ronald S. Bultje's avatar
Ronald S. Bultje committed
327 328 329
    return;
  }

330 331 332 333
  /* FIXME: implement event awareness (especially EOS
   * (av_close_codec ()) and FLUSH/DISCONT
   * (avcodec_flush_buffers ()))
   */
334 335 336 337 338 339 340

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

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

341 342
    switch (oclass->in_plugin->type) {
      case CODEC_TYPE_VIDEO:
343
	/* workarounds, functions write to buffers:
344 345 346
	 *  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). */
347 348
	if (oclass->in_plugin->id == CODEC_ID_SVQ1 ||
            oclass->in_plugin->id == CODEC_ID_SVQ3) {
349 350 351 352
	  inbuf = gst_buffer_copy_on_write(inbuf);
	  data = GST_BUFFER_DATA (inbuf);
	  size = GST_BUFFER_SIZE (inbuf);
	}
353 354 355 356
        len = avcodec_decode_video (ffmpegdec->context,
				    ffmpegdec->picture,
				    &have_data,
				    data, size);
357
        if (have_data) {
358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375
          /* 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);

376 377 378
          /* this isn't necessarily true, but it's better than nothing */
          GST_BUFFER_DURATION (outbuf) = GST_BUFFER_DURATION (inbuf);
        }
379
        break;
380

381
      case CODEC_TYPE_AUDIO:
382
        outbuf = gst_buffer_new_and_alloc (AVCODEC_MAX_AUDIO_FRAME_SIZE);
383
        len = avcodec_decode_audio (ffmpegdec->context,
384
				    (int16_t *) GST_BUFFER_DATA (outbuf),
385 386
				    &have_data,
				    data, size);
387 388 389 390 391 392 393 394
        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);
        } 
395 396 397 398 399
        break;
      default:
	g_assert(0);
        break;
    }
400 401

    if (len < 0) {
402 403
      g_warning ("ffdec_%s: decoding error",
		 oclass->in_plugin->name);
404 405 406
      break;
    }

407
    if (have_data) {
408
      if (!GST_PAD_CAPS (ffmpegdec->srcpad)) {
409 410 411 412 413
        GstCaps *caps;
        caps = gst_ffmpeg_codectype_to_caps (oclass->in_plugin->type,
					     ffmpegdec->context);
        if (caps == NULL ||
            gst_pad_try_set_caps (ffmpegdec->srcpad, caps) <= 0) {
414 415 416
          gst_element_error (GST_ELEMENT (ffmpegdec),
			     "Failed to link ffmpeg decoder (%s) to next element",
			     oclass->in_plugin->name);
417 418
          return;
        }
419 420 421
      }

      GST_BUFFER_TIMESTAMP (outbuf) = GST_BUFFER_TIMESTAMP (inbuf);
422

423
      gst_pad_push (ffmpegdec->srcpad, GST_DATA (outbuf));
424 425 426 427
    } 

    size -= len;
    data += len;
428
  } while (size > 0);
429 430 431 432

  gst_buffer_unref (inbuf);
}

433 434
static GstElementStateReturn
gst_ffmpegdec_change_state (GstElement *element)
435
{
436 437 438 439 440 441 442 443 444
  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;
      }
445 446 447
      break;
  }

448 449
  if (GST_ELEMENT_CLASS (parent_class)->change_state)
    return GST_ELEMENT_CLASS (parent_class)->change_state (element);
450

451
  return GST_STATE_SUCCESS;
452 453 454 455 456 457 458
}

gboolean
gst_ffmpegdec_register (GstPlugin *plugin)
{
  GTypeInfo typeinfo = {
    sizeof(GstFFMpegDecClass),      
Ronald S. Bultje's avatar
Bla  
Ronald S. Bultje committed
459
    (GBaseInitFunc)gst_ffmpegdec_base_init,
460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475
    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) {
476
    GstFFMpegDecClassParams *params;
Ronald S. Bultje's avatar
Bla  
Ronald S. Bultje committed
477 478
    GstCaps *srccaps, *sinkcaps;
    gchar *type_name;
479

Ronald S. Bultje's avatar
Ronald S. Bultje committed
480 481 482
    /* 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
483
	 in_plugin->id <= CODEC_ID_PCM_ALAW)) {
Ronald S. Bultje's avatar
Ronald S. Bultje committed
484
      goto next;
485
    }
Ronald S. Bultje's avatar
Ronald S. Bultje committed
486 487 488

    /* only decoders */
    if (!in_plugin->decode) {
489 490
      goto next;
    }
491 492 493 494 495 496 497

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

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

501
    /* if it's already registered, drop it */
502 503 504 505 506
    if (g_type_from_name(type_name)) {
      g_free(type_name);
      goto next;
    }

507 508 509 510 511 512 513 514
    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);
    
Ronald S. Bultje's avatar
Bla  
Ronald S. Bultje committed
515
    /* create the gtype now */
516
    type = g_type_register_static(GST_TYPE_ELEMENT, type_name , &typeinfo, 0);
Ronald S. Bultje's avatar
Bla  
Ronald S. Bultje committed
517 518
    if (!gst_element_register (plugin, type_name, GST_RANK_MARGINAL, type))
      return FALSE;
519

520 521 522
    g_hash_table_insert (global_plugins, 
		         GINT_TO_POINTER (type), 
			 (gpointer) params);
523 524 525 526

next:
    in_plugin = in_plugin->next;
  }
527
  g_hash_table_remove (global_plugins, GINT_TO_POINTER (0));
528 529 530

  return TRUE;
}