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