vp8dec: Call gst_video_decoder_negotiate()
[vjaquez-gstreamer:gst-plugins-bad.git] / ext / vp8 / gstvp8dec.c
1 /* VP8
2  * Copyright (C) 2006 David Schleef <ds@schleef.org>
3  * Copyright (C) 2008,2009,2010 Entropy Wave Inc
4  * Copyright (C) 2010 Sebastian Dröge <sebastian.droege@collabora.co.uk>
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Library General Public
8  * License as published by the Free Software Foundation; either
9  * version 2 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Library General Public License for more details.
15  *
16  * You should have received a copy of the GNU Library General Public
17  * License along with this library; if not, write to the
18  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19  * Boston, MA 02111-1307, USA.
20  *
21  */
22 /**
23  * SECTION:element-vp8dec
24  * @see_also: vp8enc, matroskademux
25  *
26  * This element decodes VP8 streams into raw video.
27  * <ulink url="http://www.webmproject.org">VP8</ulink> is a royalty-free
28  * video codec maintained by <ulink url="http://www.google.com/">Google
29  * </ulink>. It's the successor of On2 VP3, which was the base of the
30  * Theora video codec.
31  *
32  * <refsect2>
33  * <title>Example pipeline</title>
34  * |[
35  * gst-launch -v filesrc location=videotestsrc.webm ! matroskademux ! vp8dec ! xvimagesink
36  * ]| This example pipeline will decode a WebM stream and decodes the VP8 video.
37  * </refsect2>
38  */
39
40 #ifdef HAVE_CONFIG_H
41 #include "config.h"
42 #endif
43
44 #ifdef HAVE_VP8_DECODER
45
46 #include <string.h>
47
48 #include "gstvp8dec.h"
49 #include "gstvp8utils.h"
50
51 #include <gst/video/gstvideometa.h>
52 #include <gst/video/gstvideopool.h>
53
54 GST_DEBUG_CATEGORY_STATIC (gst_vp8dec_debug);
55 #define GST_CAT_DEFAULT gst_vp8dec_debug
56
57 #ifndef HAVE_VP8_MFQE
58 #define VP8_MFQE (1<<10)
59 #endif
60
61 #define DEFAULT_POST_PROCESSING FALSE
62 #define DEFAULT_POST_PROCESSING_FLAGS (VP8_DEBLOCK | VP8_DEMACROBLOCK | VP8_MFQE)
63 #define DEFAULT_DEBLOCKING_LEVEL 4
64 #define DEFAULT_NOISE_LEVEL 0
65 #define DEFAULT_THREADS 1
66
67 enum
68 {
69   PROP_0,
70   PROP_POST_PROCESSING,
71   PROP_POST_PROCESSING_FLAGS,
72   PROP_DEBLOCKING_LEVEL,
73   PROP_NOISE_LEVEL,
74   PROP_THREADS
75 };
76
77 #define C_FLAGS(v) ((guint) v)
78 #define GST_VP8_DEC_TYPE_POST_PROCESSING_FLAGS (gst_vp8_dec_post_processing_flags_get_type())
79 static GType
80 gst_vp8_dec_post_processing_flags_get_type (void)
81 {
82   static const GFlagsValue values[] = {
83     {C_FLAGS (VP8_DEBLOCK), "Deblock", "deblock"},
84     {C_FLAGS (VP8_DEMACROBLOCK), "Demacroblock", "demacroblock"},
85     {C_FLAGS (VP8_ADDNOISE), "Add noise", "addnoise"},
86     {C_FLAGS (VP8_MFQE), "Multi-frame quality enhancement", "mfqe"},
87     {0, NULL, NULL}
88   };
89   static volatile GType id = 0;
90
91   if (g_once_init_enter ((gsize *) & id)) {
92     GType _id;
93
94     _id = g_flags_register_static ("GstVP8DecPostProcessingFlags", values);
95
96     g_once_init_leave ((gsize *) & id, _id);
97   }
98
99   return id;
100 }
101
102 #undef C_FLAGS
103
104 static void gst_vp8_dec_set_property (GObject * object, guint prop_id,
105     const GValue * value, GParamSpec * pspec);
106 static void gst_vp8_dec_get_property (GObject * object, guint prop_id,
107     GValue * value, GParamSpec * pspec);
108
109 static gboolean gst_vp8_dec_start (GstVideoDecoder * decoder);
110 static gboolean gst_vp8_dec_stop (GstVideoDecoder * decoder);
111 static gboolean gst_vp8_dec_set_format (GstVideoDecoder * decoder,
112     GstVideoCodecState * state);
113 static gboolean gst_vp8_dec_reset (GstVideoDecoder * decoder, gboolean hard);
114 static GstFlowReturn gst_vp8_dec_handle_frame (GstVideoDecoder * decoder,
115     GstVideoCodecFrame * frame);
116 static gboolean gst_vp8_dec_decide_allocation (GstVideoDecoder * decoder,
117     GstQuery * query);
118
119 static GstStaticPadTemplate gst_vp8_dec_sink_template =
120 GST_STATIC_PAD_TEMPLATE ("sink",
121     GST_PAD_SINK,
122     GST_PAD_ALWAYS,
123     GST_STATIC_CAPS ("video/x-vp8")
124     );
125
126 static GstStaticPadTemplate gst_vp8_dec_src_template =
127 GST_STATIC_PAD_TEMPLATE ("src",
128     GST_PAD_SRC,
129     GST_PAD_ALWAYS,
130     GST_STATIC_CAPS (GST_VIDEO_CAPS_MAKE ("I420"))
131     );
132
133 #define parent_class gst_vp8_dec_parent_class
134 G_DEFINE_TYPE (GstVP8Dec, gst_vp8_dec, GST_TYPE_VIDEO_DECODER);
135
136 static void
137 gst_vp8_dec_class_init (GstVP8DecClass * klass)
138 {
139   GObjectClass *gobject_class;
140   GstElementClass *element_class;
141   GstVideoDecoderClass *base_video_decoder_class;
142
143   gobject_class = G_OBJECT_CLASS (klass);
144   element_class = GST_ELEMENT_CLASS (klass);
145   base_video_decoder_class = GST_VIDEO_DECODER_CLASS (klass);
146
147   gobject_class->set_property = gst_vp8_dec_set_property;
148   gobject_class->get_property = gst_vp8_dec_get_property;
149
150   g_object_class_install_property (gobject_class, PROP_POST_PROCESSING,
151       g_param_spec_boolean ("post-processing", "Post Processing",
152           "Enable post processing", DEFAULT_POST_PROCESSING,
153           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
154
155   g_object_class_install_property (gobject_class, PROP_POST_PROCESSING_FLAGS,
156       g_param_spec_flags ("post-processing-flags", "Post Processing Flags",
157           "Flags to control post processing",
158           GST_VP8_DEC_TYPE_POST_PROCESSING_FLAGS, DEFAULT_POST_PROCESSING_FLAGS,
159           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
160
161   g_object_class_install_property (gobject_class, PROP_DEBLOCKING_LEVEL,
162       g_param_spec_uint ("deblocking-level", "Deblocking Level",
163           "Deblocking level",
164           0, 16, DEFAULT_DEBLOCKING_LEVEL,
165           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
166
167   g_object_class_install_property (gobject_class, PROP_NOISE_LEVEL,
168       g_param_spec_uint ("noise-level", "Noise Level",
169           "Noise level",
170           0, 16, DEFAULT_NOISE_LEVEL,
171           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
172
173   g_object_class_install_property (gobject_class, PROP_THREADS,
174       g_param_spec_uint ("threads", "Max Threads",
175           "Maximum number of decoding threads",
176           1, 16, DEFAULT_THREADS, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
177
178   gst_element_class_add_pad_template (element_class,
179       gst_static_pad_template_get (&gst_vp8_dec_src_template));
180   gst_element_class_add_pad_template (element_class,
181       gst_static_pad_template_get (&gst_vp8_dec_sink_template));
182
183   gst_element_class_set_details_simple (element_class,
184       "On2 VP8 Decoder",
185       "Codec/Decoder/Video",
186       "Decode VP8 video streams", "David Schleef <ds@entropywave.com>");
187
188   base_video_decoder_class->start = GST_DEBUG_FUNCPTR (gst_vp8_dec_start);
189   base_video_decoder_class->stop = GST_DEBUG_FUNCPTR (gst_vp8_dec_stop);
190   base_video_decoder_class->reset = GST_DEBUG_FUNCPTR (gst_vp8_dec_reset);
191   base_video_decoder_class->set_format =
192       GST_DEBUG_FUNCPTR (gst_vp8_dec_set_format);
193   base_video_decoder_class->handle_frame =
194       GST_DEBUG_FUNCPTR (gst_vp8_dec_handle_frame);
195   base_video_decoder_class->decide_allocation = gst_vp8_dec_decide_allocation;
196
197   GST_DEBUG_CATEGORY_INIT (gst_vp8dec_debug, "vp8dec", 0, "VP8 Decoder");
198 }
199
200 static void
201 gst_vp8_dec_init (GstVP8Dec * gst_vp8_dec)
202 {
203   GstVideoDecoder *decoder = (GstVideoDecoder *) gst_vp8_dec;
204
205   GST_DEBUG_OBJECT (gst_vp8_dec, "gst_vp8_dec_init");
206   gst_video_decoder_set_packetized (decoder, TRUE);
207   gst_vp8_dec->post_processing = DEFAULT_POST_PROCESSING;
208   gst_vp8_dec->post_processing_flags = DEFAULT_POST_PROCESSING_FLAGS;
209   gst_vp8_dec->deblocking_level = DEFAULT_DEBLOCKING_LEVEL;
210   gst_vp8_dec->noise_level = DEFAULT_NOISE_LEVEL;
211 }
212
213 static void
214 gst_vp8_dec_set_property (GObject * object, guint prop_id,
215     const GValue * value, GParamSpec * pspec)
216 {
217   GstVP8Dec *dec;
218
219   g_return_if_fail (GST_IS_VP8_DEC (object));
220   dec = GST_VP8_DEC (object);
221
222   GST_DEBUG_OBJECT (object, "gst_vp8_dec_set_property");
223   switch (prop_id) {
224     case PROP_POST_PROCESSING:
225       dec->post_processing = g_value_get_boolean (value);
226       break;
227     case PROP_POST_PROCESSING_FLAGS:
228       dec->post_processing_flags = g_value_get_flags (value);
229       break;
230     case PROP_DEBLOCKING_LEVEL:
231       dec->deblocking_level = g_value_get_uint (value);
232       break;
233     case PROP_NOISE_LEVEL:
234       dec->noise_level = g_value_get_uint (value);
235       break;
236     case PROP_THREADS:
237       dec->threads = g_value_get_uint (value);
238       break;
239     default:
240       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
241       break;
242   }
243 }
244
245 static void
246 gst_vp8_dec_get_property (GObject * object, guint prop_id, GValue * value,
247     GParamSpec * pspec)
248 {
249   GstVP8Dec *dec;
250
251   g_return_if_fail (GST_IS_VP8_DEC (object));
252   dec = GST_VP8_DEC (object);
253
254   switch (prop_id) {
255     case PROP_POST_PROCESSING:
256       g_value_set_boolean (value, dec->post_processing);
257       break;
258     case PROP_POST_PROCESSING_FLAGS:
259       g_value_set_flags (value, dec->post_processing_flags);
260       break;
261     case PROP_DEBLOCKING_LEVEL:
262       g_value_set_uint (value, dec->deblocking_level);
263       break;
264     case PROP_NOISE_LEVEL:
265       g_value_set_uint (value, dec->noise_level);
266       break;
267     case PROP_THREADS:
268       g_value_set_uint (value, dec->threads);
269       break;
270     default:
271       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
272       break;
273   }
274 }
275
276 static gboolean
277 gst_vp8_dec_start (GstVideoDecoder * decoder)
278 {
279   GstVP8Dec *gst_vp8_dec = GST_VP8_DEC (decoder);
280
281   GST_DEBUG_OBJECT (gst_vp8_dec, "start");
282   gst_vp8_dec->decoder_inited = FALSE;
283
284   return TRUE;
285 }
286
287 static gboolean
288 gst_vp8_dec_stop (GstVideoDecoder * base_video_decoder)
289 {
290   GstVP8Dec *gst_vp8_dec = GST_VP8_DEC (base_video_decoder);
291
292   GST_DEBUG_OBJECT (gst_vp8_dec, "stop");
293   if (gst_vp8_dec->decoder_inited)
294     vpx_codec_destroy (&gst_vp8_dec->decoder);
295   gst_vp8_dec->decoder_inited = FALSE;
296   return TRUE;
297 }
298
299 static gboolean
300 gst_vp8_dec_set_format (GstVideoDecoder * decoder, GstVideoCodecState * state)
301 {
302   GstVP8Dec *gst_vp8_dec = GST_VP8_DEC (decoder);
303
304   GST_DEBUG_OBJECT (gst_vp8_dec, "set_format");
305   gst_vp8_dec->decoder_inited = FALSE;
306
307   if (gst_vp8_dec->input_state)
308     gst_video_codec_state_unref (gst_vp8_dec->input_state);
309   gst_vp8_dec->input_state = gst_video_codec_state_ref (state);
310
311   return TRUE;
312 }
313
314 static gboolean
315 gst_vp8_dec_reset (GstVideoDecoder * base_video_decoder, gboolean hard)
316 {
317   GstVP8Dec *decoder;
318
319   GST_DEBUG_OBJECT (base_video_decoder, "reset");
320
321   decoder = GST_VP8_DEC (base_video_decoder);
322
323   if (decoder->output_state) {
324     gst_video_codec_state_unref (decoder->output_state);
325     decoder->output_state = NULL;
326   }
327   if (hard && decoder->input_state) {
328     gst_video_codec_state_unref (decoder->input_state);
329     decoder->input_state = NULL;
330   }
331   if (decoder->decoder_inited)
332     vpx_codec_destroy (&decoder->decoder);
333   decoder->decoder_inited = FALSE;
334
335   return TRUE;
336 }
337
338 static void
339 gst_vp8_dec_send_tags (GstVP8Dec * dec)
340 {
341   GstTagList *list;
342
343   list = gst_tag_list_new_empty ();
344   gst_tag_list_add (list, GST_TAG_MERGE_REPLACE,
345       GST_TAG_VIDEO_CODEC, "VP8 video", NULL);
346
347   gst_pad_push_event (GST_VIDEO_DECODER_SRC_PAD (dec),
348       gst_event_new_tag (list));
349 }
350
351 static void
352 gst_vp8_dec_image_to_buffer (GstVP8Dec * dec, const vpx_image_t * img,
353     GstBuffer * buffer)
354 {
355   int deststride, srcstride, height, width, line, comp;
356   guint8 *dest, *src;
357   GstVideoFrame frame;
358   GstVideoInfo *info = &dec->output_state->info;
359
360   if (!gst_video_frame_map (&frame, info, buffer, GST_MAP_WRITE)) {
361     GST_ERROR_OBJECT (dec, "Could not map video buffer");
362   }
363
364   for (comp = 0; comp < 3; comp++) {
365     dest = GST_VIDEO_FRAME_COMP_DATA (&frame, comp);
366     src = img->planes[comp];
367     width = GST_VIDEO_FRAME_COMP_WIDTH (&frame, comp);
368     height = GST_VIDEO_FRAME_COMP_HEIGHT (&frame, comp);
369     deststride = GST_VIDEO_FRAME_COMP_STRIDE (&frame, comp);
370     srcstride = img->stride[comp];
371
372     /* FIXME (Edward) : Do a plane memcpy is srcstride == deststride instead
373      * of copying line by line */
374     for (line = 0; line < height; line++) {
375       memcpy (dest, src, width);
376       dest += deststride;
377       src += srcstride;
378     }
379   }
380
381   gst_video_frame_unmap (&frame);
382 }
383
384 static GstFlowReturn
385 open_codec (GstVP8Dec * dec, GstVideoCodecFrame * frame)
386 {
387   int flags = 0;
388   vpx_codec_stream_info_t stream_info;
389   vpx_codec_caps_t caps;
390   vpx_codec_dec_cfg_t cfg;
391   GstVideoCodecState *state = dec->input_state;
392   vpx_codec_err_t status;
393   GstMapInfo minfo;
394
395   memset (&stream_info, 0, sizeof (stream_info));
396   memset (&cfg, 0, sizeof (cfg));
397   stream_info.sz = sizeof (stream_info);
398
399   if (!gst_buffer_map (frame->input_buffer, &minfo, GST_MAP_READ)) {
400     GST_ERROR_OBJECT (dec, "Failed to map input buffer");
401     return GST_FLOW_ERROR;
402   }
403
404   status = vpx_codec_peek_stream_info (&vpx_codec_vp8_dx_algo,
405       minfo.data, minfo.size, &stream_info);
406
407   gst_buffer_unmap (frame->input_buffer, &minfo);
408
409   if (status != VPX_CODEC_OK || !stream_info.is_kf) {
410     GST_WARNING_OBJECT (dec, "No keyframe, skipping");
411     gst_video_decoder_finish_frame (GST_VIDEO_DECODER (dec), frame);
412     return GST_FLOW_OK;
413   }
414
415   g_assert (dec->output_state == NULL);
416   dec->output_state =
417       gst_video_decoder_set_output_state (GST_VIDEO_DECODER (dec),
418       GST_VIDEO_FORMAT_I420, stream_info.w, stream_info.h, state);
419   gst_video_decoder_negotiate (GST_VIDEO_DECODER (dec));
420   gst_vp8_dec_send_tags (dec);
421
422   cfg.w = stream_info.w;
423   cfg.h = stream_info.h;
424   cfg.threads = dec->threads;
425
426   caps = vpx_codec_get_caps (&vpx_codec_vp8_dx_algo);
427
428   if (dec->post_processing) {
429     if (!(caps & VPX_CODEC_CAP_POSTPROC)) {
430       GST_WARNING_OBJECT (dec, "Decoder does not support post processing");
431     } else {
432       flags |= VPX_CODEC_USE_POSTPROC;
433     }
434   }
435
436   status =
437       vpx_codec_dec_init (&dec->decoder, &vpx_codec_vp8_dx_algo, &cfg, flags);
438   if (status != VPX_CODEC_OK) {
439     GST_ELEMENT_ERROR (dec, LIBRARY, INIT,
440         ("Failed to initialize VP8 decoder"), ("%s",
441             gst_vpx_error_name (status)));
442     return GST_FLOW_ERROR;
443   }
444
445   if ((caps & VPX_CODEC_CAP_POSTPROC) && dec->post_processing) {
446     vp8_postproc_cfg_t pp_cfg = { 0, };
447
448 #ifndef HAVE_VP8_MFQE
449     pp_cfg.post_proc_flag = (dec->post_processing_flags & (~VP8_MFQE));
450 #else
451     pp_cfg.post_proc_flag = dec->post_processing_flags;
452 #endif
453     pp_cfg.deblocking_level = dec->deblocking_level;
454     pp_cfg.noise_level = dec->noise_level;
455
456     status = vpx_codec_control (&dec->decoder, VP8_SET_POSTPROC, &pp_cfg);
457     if (status != VPX_CODEC_OK) {
458       GST_WARNING_OBJECT (dec, "Couldn't set postprocessing settings: %s",
459           gst_vpx_error_name (status));
460     }
461   }
462
463   dec->decoder_inited = TRUE;
464
465   return GST_FLOW_OK;
466 }
467
468 static GstFlowReturn
469 gst_vp8_dec_handle_frame (GstVideoDecoder * decoder, GstVideoCodecFrame * frame)
470 {
471   GstVP8Dec *dec;
472   GstFlowReturn ret = GST_FLOW_OK;
473   vpx_codec_err_t status;
474   vpx_codec_iter_t iter = NULL;
475   vpx_image_t *img;
476   long decoder_deadline = 0;
477   GstClockTimeDiff deadline;
478   GstMapInfo minfo;
479
480   GST_DEBUG_OBJECT (decoder, "handle_frame");
481
482   dec = GST_VP8_DEC (decoder);
483
484   if (!dec->decoder_inited)
485     ret = open_codec (dec, frame);
486
487   deadline = gst_video_decoder_get_max_decode_time (decoder, frame);
488   if (deadline < 0) {
489     decoder_deadline = 1;
490   } else if (deadline == G_MAXINT64) {
491     decoder_deadline = 0;
492   } else {
493     decoder_deadline = MAX (1, deadline / GST_MSECOND);
494   }
495
496   if (!gst_buffer_map (frame->input_buffer, &minfo, GST_MAP_READ)) {
497     GST_ERROR_OBJECT (dec, "Failed to map input buffer");
498     return GST_FLOW_ERROR;
499   }
500
501   status = vpx_codec_decode (&dec->decoder,
502       minfo.data, minfo.size, NULL, decoder_deadline);
503
504   gst_buffer_unmap (frame->input_buffer, &minfo);
505
506   if (status) {
507     GST_ELEMENT_ERROR (decoder, LIBRARY, ENCODE,
508         ("Failed to decode frame"), ("%s", gst_vpx_error_name (status)));
509     return GST_FLOW_ERROR;
510   }
511
512   img = vpx_codec_get_frame (&dec->decoder, &iter);
513   if (img) {
514     if (deadline < 0) {
515       GST_LOG_OBJECT (dec, "Skipping late frame (%f s past deadline)",
516           (double) -deadline / GST_SECOND);
517       gst_video_decoder_drop_frame (decoder, frame);
518     } else {
519       ret = gst_video_decoder_allocate_output_frame (decoder, frame);
520
521       if (ret == GST_FLOW_OK) {
522         gst_vp8_dec_image_to_buffer (dec, img, frame->output_buffer);
523         ret = gst_video_decoder_finish_frame (decoder, frame);
524       } else {
525         gst_video_decoder_finish_frame (decoder, frame);
526       }
527     }
528
529     vpx_img_free (img);
530
531     while ((img = vpx_codec_get_frame (&dec->decoder, &iter))) {
532       GST_WARNING_OBJECT (decoder, "Multiple decoded frames... dropping");
533       vpx_img_free (img);
534     }
535   } else {
536     /* Invisible frame */
537     GST_VIDEO_CODEC_FRAME_SET_DECODE_ONLY (frame);
538     gst_video_decoder_finish_frame (decoder, frame);
539   }
540
541   return ret;
542 }
543
544 static gboolean
545 gst_vp8_dec_decide_allocation (GstVideoDecoder * bdec, GstQuery * query)
546 {
547   GstBufferPool *pool;
548   GstStructure *config;
549
550   if (!GST_VIDEO_DECODER_CLASS (parent_class)->decide_allocation (bdec, query))
551     return FALSE;
552
553   g_assert (gst_query_get_n_allocation_pools (query) > 0);
554   gst_query_parse_nth_allocation_pool (query, 0, &pool, NULL, NULL, NULL);
555   g_assert (pool != NULL);
556
557   config = gst_buffer_pool_get_config (pool);
558   if (gst_query_find_allocation_meta (query, GST_VIDEO_META_API_TYPE, NULL)) {
559     gst_buffer_pool_config_add_option (config,
560         GST_BUFFER_POOL_OPTION_VIDEO_META);
561   }
562   gst_buffer_pool_set_config (pool, config);
563   gst_object_unref (pool);
564
565   return TRUE;
566 }
567
568 #endif /* HAVE_VP8_DECODER */