vaapidecode: parse source data until a frame is obtained.
[platform/upstream/gstreamer-vaapi.git] / gst / vaapi / gstvaapidecode.c
1 /*
2  *  gstvaapidecode.c - VA-API video decoder
3  *
4  *  Copyright (C) 2010-2011 Splitted-Desktop Systems
5  *    Author: Gwenole Beauchesne <gwenole.beauchesne@splitted-desktop.com>
6  *  Copyright (C) 2011-2014 Intel Corporation
7  *    Author: Gwenole Beauchesne <gwenole.beauchesne@intel.com>
8  *
9  *  This library is free software; you can redistribute it and/or
10  *  modify it under the terms of the GNU Lesser General Public License
11  *  as published by the Free Software Foundation; either version 2.1
12  *  of the License, or (at your option) any later version.
13  *
14  *  This library is distributed in the hope that it will be useful,
15  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
16  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17  *  Lesser General Public License for more details.
18  *
19  *  You should have received a copy of the GNU Lesser General Public
20  *  License along with this library; if not, write to the Free
21  *  Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
22  *  Boston, MA 02110-1301 USA
23 */
24
25 /**
26  * SECTION:gstvaapidecode
27  * @short_description: A VA-API based video decoder
28  *
29  * vaapidecode decodes from raw bitstreams to surfaces suitable for
30  * the vaapisink element.
31  */
32
33 #include "gst/vaapi/sysdeps.h"
34 #include <gst/vaapi/gstvaapidisplay.h>
35
36 #include "gstvaapidecode.h"
37 #include "gstvaapipluginutil.h"
38 #include "gstvaapivideobuffer.h"
39 #if GST_CHECK_VERSION(1,1,0) && USE_GLX
40 #include "gstvaapivideometa_texture.h"
41 #endif
42 #if GST_CHECK_VERSION(1,0,0)
43 #include "gstvaapivideobufferpool.h"
44 #include "gstvaapivideomemory.h"
45 #endif
46
47 #include <gst/vaapi/gstvaapidecoder_h264.h>
48 #include <gst/vaapi/gstvaapidecoder_jpeg.h>
49 #include <gst/vaapi/gstvaapidecoder_mpeg2.h>
50 #include <gst/vaapi/gstvaapidecoder_mpeg4.h>
51 #include <gst/vaapi/gstvaapidecoder_vc1.h>
52 #include <gst/vaapi/gstvaapidecoder_vp8.h>
53
54 #define GST_PLUGIN_NAME "vaapidecode"
55 #define GST_PLUGIN_DESC "A VA-API based video decoder"
56
57 #define GST_VAAPI_DECODE_FLOW_PARSE_DATA        GST_FLOW_CUSTOM_SUCCESS_2
58
59 GST_DEBUG_CATEGORY_STATIC(gst_debug_vaapidecode);
60 #define GST_CAT_DEFAULT gst_debug_vaapidecode
61
62 /* Default templates */
63 #define GST_CAPS_CODEC(CODEC) CODEC "; "
64
65 static const char gst_vaapidecode_sink_caps_str[] =
66     GST_CAPS_CODEC("video/mpeg, mpegversion=2, systemstream=(boolean)false")
67     GST_CAPS_CODEC("video/mpeg, mpegversion=4")
68     GST_CAPS_CODEC("video/x-divx")
69     GST_CAPS_CODEC("video/x-xvid")
70     GST_CAPS_CODEC("video/x-h263")
71     GST_CAPS_CODEC("video/x-h264")
72     GST_CAPS_CODEC("video/x-wmv")
73     GST_CAPS_CODEC("video/x-vp8")
74     GST_CAPS_CODEC("image/jpeg")
75     ;
76
77 static const char gst_vaapidecode_src_caps_str[] =
78 #if GST_CHECK_VERSION(1,1,0)
79     GST_VIDEO_CAPS_MAKE_WITH_FEATURES(
80         GST_CAPS_FEATURE_MEMORY_VAAPI_SURFACE, "{ ENCODED, NV12, I420, YV12 }") ";"
81     GST_VIDEO_CAPS_MAKE_WITH_FEATURES(
82         GST_CAPS_FEATURE_META_GST_VIDEO_GL_TEXTURE_UPLOAD_META, "RGBA") ";"
83     GST_VIDEO_CAPS_MAKE("{ NV12, I420, YV12 }");
84 #else
85     GST_VAAPI_SURFACE_CAPS;
86 #endif
87
88 static GstStaticPadTemplate gst_vaapidecode_sink_factory =
89     GST_STATIC_PAD_TEMPLATE(
90         "sink",
91         GST_PAD_SINK,
92         GST_PAD_ALWAYS,
93         GST_STATIC_CAPS(gst_vaapidecode_sink_caps_str));
94
95 static GstStaticPadTemplate gst_vaapidecode_src_factory =
96     GST_STATIC_PAD_TEMPLATE(
97         "src",
98         GST_PAD_SRC,
99         GST_PAD_ALWAYS,
100         GST_STATIC_CAPS(gst_vaapidecode_src_caps_str));
101
102 G_DEFINE_TYPE_WITH_CODE(
103     GstVaapiDecode,
104     gst_vaapidecode,
105     GST_TYPE_VIDEO_DECODER,
106     GST_VAAPI_PLUGIN_BASE_INIT_INTERFACES)
107
108 static gboolean
109 gst_vaapidecode_update_src_caps(GstVaapiDecode *decode,
110     const GstVideoCodecState *ref_state);
111
112 static void
113 gst_vaapi_decoder_state_changed(GstVaapiDecoder *decoder,
114     const GstVideoCodecState *codec_state, gpointer user_data)
115 {
116     GstVaapiDecode * const decode = GST_VAAPIDECODE(user_data);
117     GstVideoDecoder * const vdec = GST_VIDEO_DECODER(decode);
118
119     g_assert(decode->decoder == decoder);
120
121     gst_vaapidecode_update_src_caps(decode, codec_state);
122     gst_video_decoder_negotiate(vdec);
123 }
124
125 static inline gboolean
126 gst_vaapidecode_update_sink_caps(GstVaapiDecode *decode, GstCaps *caps)
127 {
128     gst_caps_replace(&decode->sinkpad_caps, caps);
129     return TRUE;
130 }
131
132 static gboolean
133 gst_vaapidecode_update_src_caps(GstVaapiDecode *decode,
134     const GstVideoCodecState *ref_state)
135 {
136     GstVideoDecoder * const vdec = GST_VIDEO_DECODER(decode);
137     GstVideoCodecState *state;
138     GstVideoInfo *vi, vis;
139 #if GST_CHECK_VERSION(1,1,0)
140     GstCapsFeatures *features = NULL;
141     GstVaapiCapsFeature feature;
142
143     feature = gst_vaapi_find_preferred_caps_feature(
144         GST_VIDEO_DECODER_SRC_PAD(vdec),
145         GST_VIDEO_INFO_FORMAT(&ref_state->info));
146 #endif
147
148     state = gst_video_decoder_set_output_state(vdec,
149         GST_VIDEO_INFO_FORMAT(&ref_state->info),
150         ref_state->info.width, ref_state->info.height,
151         (GstVideoCodecState *)ref_state);
152     if (!state)
153         return FALSE;
154
155     vi = &state->info;
156     if (GST_VIDEO_INFO_FORMAT(vi) == GST_VIDEO_FORMAT_ENCODED) {
157         gst_video_info_init(&vis);
158         gst_video_info_set_format(&vis, GST_VIDEO_FORMAT_NV12,
159             GST_VIDEO_INFO_WIDTH(vi), GST_VIDEO_INFO_HEIGHT(vi));
160         vi->size = vis.size;
161     }
162     gst_video_codec_state_unref(state);
163
164 #if GST_CHECK_VERSION(1,1,0)
165     vis = *vi;
166     switch (feature) {
167     case GST_VAAPI_CAPS_FEATURE_GL_TEXTURE_UPLOAD_META:
168         gst_video_info_set_format(&vis, GST_VIDEO_FORMAT_RGBA,
169             GST_VIDEO_INFO_WIDTH(vi), GST_VIDEO_INFO_HEIGHT(vi));
170         features = gst_caps_features_new(
171             GST_CAPS_FEATURE_META_GST_VIDEO_GL_TEXTURE_UPLOAD_META, NULL);
172         break;
173     default:
174         if (GST_VIDEO_INFO_FORMAT(vi) == GST_VIDEO_FORMAT_ENCODED) {
175             /* XXX: this is a workaround until auto-plugging is fixed when
176             format=ENCODED + memory:VASurface caps feature are provided.
177             Meanwhile, providing a random format here works but this is
178             a terribly wrong thing per se. */
179             gst_video_info_set_format(&vis, GST_VIDEO_FORMAT_NV12,
180                 GST_VIDEO_INFO_WIDTH(vi), GST_VIDEO_INFO_HEIGHT(vi));
181 #if GST_CHECK_VERSION(1,3,0)
182             if (feature == GST_VAAPI_CAPS_FEATURE_VAAPI_SURFACE)
183                 features = gst_caps_features_new(
184                     GST_CAPS_FEATURE_MEMORY_VAAPI_SURFACE, NULL);
185 #endif
186         }
187         break;
188     }
189     state->caps = gst_video_info_to_caps(&vis);
190     if (features)
191         gst_caps_set_features(state->caps, 0, features);
192 #else
193     /* XXX: gst_video_info_to_caps() from GStreamer 0.10 does not
194        reconstruct suitable caps for "encoded" video formats */
195     state->caps = gst_caps_from_string(GST_VAAPI_SURFACE_CAPS_NAME);
196     if (!state->caps)
197         return FALSE;
198
199     gst_caps_set_simple(state->caps,
200         "type", G_TYPE_STRING, "vaapi",
201         "opengl", G_TYPE_BOOLEAN, USE_GLX,
202         "width", G_TYPE_INT, vi->width,
203         "height", G_TYPE_INT, vi->height,
204         "framerate", GST_TYPE_FRACTION, vi->fps_n, vi->fps_d,
205         "pixel-aspect-ratio", GST_TYPE_FRACTION, vi->par_n, vi->par_d,
206         NULL);
207
208     gst_caps_set_interlaced(state->caps, vi);
209 #endif
210     gst_caps_replace(&decode->srcpad_caps, state->caps);
211     return TRUE;
212 }
213
214 static void
215 gst_vaapidecode_release(GstVaapiDecode *decode)
216 {
217     g_mutex_lock(&decode->decoder_mutex);
218     g_cond_signal(&decode->decoder_ready);
219     g_mutex_unlock(&decode->decoder_mutex);
220 }
221
222 static GstFlowReturn
223 gst_vaapidecode_decode_frame(GstVideoDecoder *vdec, GstVideoCodecFrame *frame)
224 {
225     GstVaapiDecode * const decode = GST_VAAPIDECODE(vdec);
226     GstVaapiDecoderStatus status;
227     GstFlowReturn ret;
228
229     /* Decode current frame */
230     for (;;) {
231         status = gst_vaapi_decoder_decode(decode->decoder, frame);
232         if (status == GST_VAAPI_DECODER_STATUS_ERROR_NO_SURFACE) {
233             GST_VIDEO_DECODER_STREAM_UNLOCK(vdec);
234             g_mutex_lock(&decode->decoder_mutex);
235             g_cond_wait(&decode->decoder_ready, &decode->decoder_mutex);
236             g_mutex_unlock(&decode->decoder_mutex);
237             GST_VIDEO_DECODER_STREAM_LOCK(vdec);
238             if (decode->decoder_loop_status < 0)
239                 goto error_decode_loop;
240             continue;
241         }
242         if (status != GST_VAAPI_DECODER_STATUS_SUCCESS)
243             goto error_decode;
244         break;
245     }
246
247     /* Try to report back early any error that occured in the decode task */
248     GST_VIDEO_DECODER_STREAM_UNLOCK(vdec);
249     GST_VIDEO_DECODER_STREAM_LOCK(vdec);
250     return decode->decoder_loop_status;
251
252     /* ERRORS */
253 error_decode_loop:
254     {
255         GST_ERROR("decode loop error %d", decode->decoder_loop_status);
256         gst_video_decoder_drop_frame(vdec, frame);
257         return decode->decoder_loop_status;
258     }
259 error_decode:
260     {
261         GST_ERROR("decode error %d", status);
262         switch (status) {
263         case GST_VAAPI_DECODER_STATUS_ERROR_UNSUPPORTED_CODEC:
264         case GST_VAAPI_DECODER_STATUS_ERROR_UNSUPPORTED_PROFILE:
265         case GST_VAAPI_DECODER_STATUS_ERROR_UNSUPPORTED_CHROMA_FORMAT:
266             ret = GST_FLOW_NOT_SUPPORTED;
267             break;
268         default:
269             ret = GST_FLOW_ERROR;
270             break;
271         }
272         gst_video_decoder_drop_frame(vdec, frame);
273         return ret;
274     }
275 }
276
277 static GstFlowReturn
278 gst_vaapidecode_push_decoded_frame(GstVideoDecoder *vdec,
279     GstVideoCodecFrame *out_frame)
280 {
281     GstVaapiDecode * const decode = GST_VAAPIDECODE(vdec);
282     GstVaapiSurfaceProxy *proxy;
283     GstFlowReturn ret;
284 #if GST_CHECK_VERSION(1,0,0)
285     const GstVaapiRectangle *crop_rect;
286     GstVaapiVideoMeta *meta;
287     guint flags;
288 #endif
289
290     if (!GST_VIDEO_CODEC_FRAME_IS_DECODE_ONLY(out_frame)) {
291         proxy = gst_video_codec_frame_get_user_data(out_frame);
292
293         gst_vaapi_surface_proxy_set_destroy_notify(proxy,
294             (GDestroyNotify)gst_vaapidecode_release, decode);
295
296 #if GST_CHECK_VERSION(1,0,0)
297         ret = gst_video_decoder_allocate_output_frame(vdec, out_frame);
298         if (ret != GST_FLOW_OK)
299             goto error_create_buffer;
300
301         meta = gst_buffer_get_vaapi_video_meta(out_frame->output_buffer);
302         if (!meta)
303             goto error_get_meta;
304         gst_vaapi_video_meta_set_surface_proxy(meta, proxy);
305
306         flags = gst_vaapi_surface_proxy_get_flags(proxy);
307         if (flags & GST_VAAPI_SURFACE_PROXY_FLAG_INTERLACED) {
308             guint out_flags = GST_VIDEO_BUFFER_FLAG_INTERLACED;
309             if (flags & GST_VAAPI_SURFACE_PROXY_FLAG_TFF)
310                 out_flags |= GST_VIDEO_BUFFER_FLAG_TFF;
311             if (flags & GST_VAAPI_SURFACE_PROXY_FLAG_RFF)
312                 out_flags |= GST_VIDEO_BUFFER_FLAG_RFF;
313             if (flags & GST_VAAPI_SURFACE_PROXY_FLAG_ONEFIELD)
314                 out_flags |= GST_VIDEO_BUFFER_FLAG_ONEFIELD;
315             GST_BUFFER_FLAG_SET(out_frame->output_buffer, out_flags);
316         }
317
318         crop_rect = gst_vaapi_surface_proxy_get_crop_rect(proxy);
319         if (crop_rect) {
320             GstVideoCropMeta * const crop_meta =
321                 gst_buffer_add_video_crop_meta(out_frame->output_buffer);
322             if (crop_meta) {
323                 crop_meta->x = crop_rect->x;
324                 crop_meta->y = crop_rect->y;
325                 crop_meta->width = crop_rect->width;
326                 crop_meta->height = crop_rect->height;
327             }
328         }
329
330 #if GST_CHECK_VERSION(1,1,0) && USE_GLX
331         if (decode->has_texture_upload_meta)
332             gst_buffer_ensure_texture_upload_meta(out_frame->output_buffer);
333 #endif
334 #else
335         out_frame->output_buffer =
336             gst_vaapi_video_buffer_new_with_surface_proxy(proxy);
337         if (!out_frame->output_buffer)
338             goto error_create_buffer;
339 #endif
340     }
341
342     ret = gst_video_decoder_finish_frame(vdec, out_frame);
343     if (ret != GST_FLOW_OK)
344         goto error_commit_buffer;
345
346     gst_video_codec_frame_unref(out_frame);
347     return GST_FLOW_OK;
348
349     /* ERRORS */
350 error_create_buffer:
351     {
352         const GstVaapiID surface_id =
353             gst_vaapi_surface_get_id(GST_VAAPI_SURFACE_PROXY_SURFACE(proxy));
354
355         GST_ERROR("video sink failed to create video buffer for proxy'ed "
356                   "surface %" GST_VAAPI_ID_FORMAT,
357                   GST_VAAPI_ID_ARGS(surface_id));
358         gst_video_decoder_drop_frame(vdec, out_frame);
359         gst_video_codec_frame_unref(out_frame);
360         return GST_FLOW_ERROR;
361     }
362 #if GST_CHECK_VERSION(1,0,0)
363 error_get_meta:
364     {
365         GST_ERROR("failed to get vaapi video meta attached to video buffer");
366         gst_video_decoder_drop_frame(vdec, out_frame);
367         gst_video_codec_frame_unref(out_frame);
368         return GST_FLOW_ERROR;
369     }
370 #endif
371 error_commit_buffer:
372     {
373         if (ret != GST_FLOW_FLUSHING)
374             GST_ERROR("video sink rejected the video buffer (error %d)", ret);
375         gst_video_codec_frame_unref(out_frame);
376         return ret;
377     }
378 }
379
380 static GstFlowReturn
381 gst_vaapidecode_handle_frame(GstVideoDecoder *vdec, GstVideoCodecFrame *frame)
382 {
383     GstFlowReturn ret;
384
385     /* Make sure to release the base class stream lock so that decode
386        loop can call gst_video_decoder_finish_frame() without blocking */
387     GST_VIDEO_DECODER_STREAM_UNLOCK(vdec);
388     ret = gst_vaapidecode_decode_frame(vdec, frame);
389     GST_VIDEO_DECODER_STREAM_LOCK(vdec);
390     return ret;
391 }
392
393 static void
394 gst_vaapidecode_decode_loop(GstVaapiDecode *decode)
395 {
396     GstVideoDecoder * const vdec = GST_VIDEO_DECODER(decode);
397     GstVaapiDecoderStatus status;
398     GstVideoCodecFrame *out_frame;
399     GstFlowReturn ret;
400
401     status = gst_vaapi_decoder_get_frame_with_timeout(decode->decoder,
402         &out_frame, 100000);
403
404     GST_VIDEO_DECODER_STREAM_LOCK(vdec);
405     switch (status) {
406     case GST_VAAPI_DECODER_STATUS_SUCCESS:
407         ret = gst_vaapidecode_push_decoded_frame(vdec, out_frame);
408         break;
409     case GST_VAAPI_DECODER_STATUS_ERROR_NO_DATA:
410         ret = GST_VIDEO_DECODER_FLOW_NEED_DATA;
411         break;
412     default:
413         ret = GST_FLOW_ERROR;
414         break;
415     }
416     decode->decoder_loop_status = ret;
417     GST_VIDEO_DECODER_STREAM_UNLOCK(vdec);
418
419     if (ret == GST_FLOW_OK)
420         return;
421
422     /* If invoked from gst_vaapidecode_finish(), then return right
423        away no matter the errors, or the GstVaapiDecoder needs further
424        data to complete decoding (there no more data to feed in) */
425     if (decode->decoder_finish) {
426         g_mutex_lock(&decode->decoder_mutex);
427         g_cond_signal(&decode->decoder_finish_done);
428         g_mutex_unlock(&decode->decoder_mutex);
429         return;
430     }
431
432     /* Suspend the task if an error occurred */
433     if (ret != GST_VIDEO_DECODER_FLOW_NEED_DATA)
434         gst_pad_pause_task(GST_VAAPI_PLUGIN_BASE_SRC_PAD(decode));
435 }
436
437 static gboolean
438 gst_vaapidecode_flush(GstVideoDecoder *vdec)
439 {
440     GstVaapiDecode * const decode = GST_VAAPIDECODE(vdec);
441     GstVaapiDecoderStatus status;
442
443     /* If there is something in GstVideoDecoder's output adapter, then
444        submit the frame for decoding */
445     if (decode->current_frame_size) {
446         gst_video_decoder_have_frame(vdec);
447         decode->current_frame_size = 0;
448     }
449
450     status = gst_vaapi_decoder_flush(decode->decoder);
451     if (status != GST_VAAPI_DECODER_STATUS_SUCCESS)
452         goto error_flush;
453     return TRUE;
454
455     /* ERRORS */
456 error_flush:
457     {
458         GST_ERROR("failed to flush decoder (status %d)", status);
459         return FALSE;
460     }
461 }
462
463 static GstFlowReturn
464 gst_vaapidecode_finish(GstVideoDecoder *vdec)
465 {
466     GstVaapiDecode * const decode = GST_VAAPIDECODE(vdec);
467     GstFlowReturn ret = GST_FLOW_OK;
468
469     if (!gst_vaapidecode_flush(vdec))
470         ret = GST_FLOW_OK;
471
472     /* Make sure the decode loop function has a chance to return, thus
473        possibly unlocking gst_video_decoder_finish_frame() */
474     GST_VIDEO_DECODER_STREAM_UNLOCK(vdec);
475     g_mutex_lock(&decode->decoder_mutex);
476     decode->decoder_finish = TRUE;
477     g_cond_wait(&decode->decoder_finish_done, &decode->decoder_mutex);
478     g_mutex_unlock(&decode->decoder_mutex);
479     gst_pad_stop_task(GST_VAAPI_PLUGIN_BASE_SRC_PAD(decode));
480     GST_VIDEO_DECODER_STREAM_LOCK(vdec);
481     return ret;
482 }
483
484 #if GST_CHECK_VERSION(1,0,0)
485 static gboolean
486 gst_vaapidecode_decide_allocation(GstVideoDecoder *vdec, GstQuery *query)
487 {
488     GstVaapiDecode * const decode = GST_VAAPIDECODE(vdec);
489     GstCaps *caps = NULL;
490     GstBufferPool *pool;
491     GstStructure *config;
492     GstVideoInfo vi;
493     guint size, min, max;
494     gboolean need_pool, update_pool;
495     gboolean has_video_meta = FALSE;
496     GstVideoCodecState *state;
497 #if GST_CHECK_VERSION(1,1,0) && USE_GLX
498     GstCapsFeatures *features, *features2;
499 #endif
500
501     gst_query_parse_allocation(query, &caps, &need_pool);
502
503     if (!caps)
504         goto error_no_caps;
505
506     state = gst_video_decoder_get_output_state(vdec);
507
508     decode->has_texture_upload_meta = FALSE;
509     has_video_meta = gst_query_find_allocation_meta(query, GST_VIDEO_META_API_TYPE, NULL);
510 #if GST_CHECK_VERSION(1,1,0) && USE_GLX
511     if (has_video_meta)
512         decode->has_texture_upload_meta = gst_query_find_allocation_meta(query,
513             GST_VIDEO_GL_TEXTURE_UPLOAD_META_API_TYPE, NULL);
514
515     features = gst_caps_get_features(state->caps, 0);
516     features2 = gst_caps_features_new(GST_CAPS_FEATURE_META_GST_VIDEO_GL_TEXTURE_UPLOAD_META, NULL);
517
518     /* Update src caps if feature is not handled downstream */
519     if (!decode->has_texture_upload_meta &&
520         gst_caps_features_is_equal(features, features2))
521         gst_vaapidecode_update_src_caps (decode, state);
522     gst_caps_features_free(features2);
523 #endif
524
525     gst_video_codec_state_unref(state);
526
527     gst_video_info_init(&vi);
528     gst_video_info_from_caps(&vi, caps);
529     if (GST_VIDEO_INFO_FORMAT(&vi) == GST_VIDEO_FORMAT_ENCODED)
530         gst_video_info_set_format(&vi, GST_VIDEO_FORMAT_NV12,
531             GST_VIDEO_INFO_WIDTH(&vi), GST_VIDEO_INFO_HEIGHT(&vi));
532
533     g_return_val_if_fail(GST_VAAPI_PLUGIN_BASE_DISPLAY(decode) != NULL, FALSE);
534
535     if (gst_query_get_n_allocation_pools(query) > 0) {
536         gst_query_parse_nth_allocation_pool(query, 0, &pool, &size, &min, &max);
537         size = MAX(size, vi.size);
538         update_pool = TRUE;
539     }
540     else {
541         pool = NULL;
542         size = vi.size;
543         min = max = 0;
544         update_pool = FALSE;
545     }
546
547     if (!pool || !gst_buffer_pool_has_option(pool,
548             GST_BUFFER_POOL_OPTION_VAAPI_VIDEO_META)) {
549         GST_INFO("no pool or doesn't support GstVaapiVideoMeta, "
550             "making new pool");
551         pool = gst_vaapi_video_buffer_pool_new(
552             GST_VAAPI_PLUGIN_BASE_DISPLAY(decode));
553         if (!pool)
554             goto error_create_pool;
555
556         config = gst_buffer_pool_get_config(pool);
557         gst_buffer_pool_config_set_params(config, caps, size, min, max);
558         gst_buffer_pool_config_add_option(config,
559             GST_BUFFER_POOL_OPTION_VAAPI_VIDEO_META);
560         gst_buffer_pool_set_config(pool, config);
561     }
562
563     if (has_video_meta) {
564         config = gst_buffer_pool_get_config(pool);
565         gst_buffer_pool_config_add_option(config,
566             GST_BUFFER_POOL_OPTION_VIDEO_META);
567 #if GST_CHECK_VERSION(1,1,0) && USE_GLX
568         if (decode->has_texture_upload_meta)
569             gst_buffer_pool_config_add_option(config,
570                 GST_BUFFER_POOL_OPTION_VIDEO_GL_TEXTURE_UPLOAD_META);
571 #endif
572         gst_buffer_pool_set_config(pool, config);
573     }
574
575     if (update_pool)
576         gst_query_set_nth_allocation_pool(query, 0, pool, size, min, max);
577     else
578         gst_query_add_allocation_pool(query, pool, size, min, max);
579     if (pool)
580         gst_object_unref(pool);
581     return TRUE;
582
583     /* ERRORS */
584 error_no_caps:
585     {
586         GST_ERROR("no caps specified");
587         return FALSE;
588     }
589 error_create_pool:
590     {
591         GST_ERROR("failed to create buffer pool");
592         return FALSE;
593     }
594 }
595 #endif
596
597 static inline gboolean
598 gst_vaapidecode_ensure_display(GstVaapiDecode *decode)
599 {
600     return gst_vaapi_plugin_base_ensure_display(GST_VAAPI_PLUGIN_BASE(decode));
601 }
602
603 static inline guint
604 gst_vaapi_codec_from_caps(GstCaps *caps)
605 {
606     return gst_vaapi_profile_get_codec(gst_vaapi_profile_from_caps(caps));
607 }
608
609 static gboolean
610 gst_vaapidecode_create(GstVaapiDecode *decode, GstCaps *caps)
611 {
612     GstVaapiDisplay *dpy;
613
614     if (!gst_vaapidecode_ensure_display(decode))
615         return FALSE;
616     dpy = GST_VAAPI_PLUGIN_BASE_DISPLAY(decode);
617
618     switch (gst_vaapi_codec_from_caps(caps)) {
619     case GST_VAAPI_CODEC_MPEG2:
620         decode->decoder = gst_vaapi_decoder_mpeg2_new(dpy, caps);
621         break;
622     case GST_VAAPI_CODEC_MPEG4:
623     case GST_VAAPI_CODEC_H263:
624         decode->decoder = gst_vaapi_decoder_mpeg4_new(dpy, caps);
625         break;
626     case GST_VAAPI_CODEC_H264:
627         decode->decoder = gst_vaapi_decoder_h264_new(dpy, caps);
628         break;
629     case GST_VAAPI_CODEC_WMV3:
630     case GST_VAAPI_CODEC_VC1:
631         decode->decoder = gst_vaapi_decoder_vc1_new(dpy, caps);
632         break;
633 #if USE_JPEG_DECODER
634     case GST_VAAPI_CODEC_JPEG:
635         decode->decoder = gst_vaapi_decoder_jpeg_new(dpy, caps);
636         break;
637 #endif
638 #if USE_VP8_DECODER
639     case GST_VAAPI_CODEC_VP8:
640         decode->decoder = gst_vaapi_decoder_vp8_new(dpy, caps);
641         break;
642 #endif
643     default:
644         decode->decoder = NULL;
645         break;
646     }
647     if (!decode->decoder)
648         return FALSE;
649
650     gst_vaapi_decoder_set_codec_state_changed_func(decode->decoder,
651         gst_vaapi_decoder_state_changed, decode);
652
653     decode->decoder_caps = gst_caps_ref(caps);
654     return gst_pad_start_task(GST_VAAPI_PLUGIN_BASE_SRC_PAD(decode),
655         (GstTaskFunction)gst_vaapidecode_decode_loop, decode, NULL);
656 }
657
658 static void
659 gst_vaapidecode_destroy(GstVaapiDecode *decode)
660 {
661     gst_pad_stop_task(GST_VAAPI_PLUGIN_BASE_SRC_PAD(decode));
662     gst_vaapi_decoder_replace(&decode->decoder, NULL);
663     gst_caps_replace(&decode->decoder_caps, NULL);
664     gst_vaapidecode_release(decode);
665 }
666
667 static gboolean
668 gst_vaapidecode_reset_full(GstVaapiDecode *decode, GstCaps *caps, gboolean hard)
669 {
670     GstVaapiCodec codec;
671
672     decode->has_texture_upload_meta = FALSE;
673
674     /* Reset tracked frame size */
675     decode->current_frame_size = 0;
676
677     /* Reset timers if hard reset was requested (e.g. seek) */
678     if (hard) {
679         GstVideoDecoder * const vdec = GST_VIDEO_DECODER(decode);
680         GstVideoCodecFrame *out_frame = NULL;
681
682         gst_vaapi_decoder_flush(decode->decoder);
683         GST_VIDEO_DECODER_STREAM_UNLOCK(vdec);
684         gst_pad_stop_task(GST_VAAPI_PLUGIN_BASE_SRC_PAD(decode));
685         GST_VIDEO_DECODER_STREAM_LOCK(vdec);
686         decode->decoder_loop_status = GST_FLOW_OK;
687
688         /* Purge all decoded frames as we don't need them (e.g. seek) */
689         while (gst_vaapi_decoder_get_frame_with_timeout(decode->decoder,
690                    &out_frame, 0) == GST_VAAPI_DECODER_STATUS_SUCCESS) {
691             gst_video_codec_frame_unref(out_frame);
692             out_frame = NULL;
693         }
694     }
695
696     /* Only reset decoder if codec type changed */
697     else if (decode->decoder && decode->decoder_caps) {
698         if (gst_caps_is_always_compatible(caps, decode->decoder_caps))
699             return TRUE;
700         codec = gst_vaapi_codec_from_caps(caps);
701         if (codec == gst_vaapi_decoder_get_codec(decode->decoder))
702             return TRUE;
703     }
704
705     gst_vaapidecode_destroy(decode);
706     return gst_vaapidecode_create(decode, caps);
707 }
708
709 static void
710 gst_vaapidecode_finalize(GObject *object)
711 {
712     GstVaapiDecode * const decode = GST_VAAPIDECODE(object);
713
714     gst_caps_replace(&decode->sinkpad_caps, NULL);
715     gst_caps_replace(&decode->srcpad_caps,  NULL);
716     gst_caps_replace(&decode->allowed_caps, NULL);
717
718     g_cond_clear(&decode->decoder_finish_done);
719     g_cond_clear(&decode->decoder_ready);
720     g_mutex_clear(&decode->decoder_mutex);
721
722     gst_vaapi_plugin_base_finalize(GST_VAAPI_PLUGIN_BASE(object));
723     G_OBJECT_CLASS(gst_vaapidecode_parent_class)->finalize(object);
724 }
725
726 static gboolean
727 gst_vaapidecode_open(GstVideoDecoder *vdec)
728 {
729     GstVaapiDecode * const decode = GST_VAAPIDECODE(vdec);
730     GstVaapiDisplay * const old_display = GST_VAAPI_PLUGIN_BASE_DISPLAY(decode);
731     gboolean success;
732
733     if (!gst_vaapi_plugin_base_open(GST_VAAPI_PLUGIN_BASE(decode)))
734         return FALSE;
735
736     /* Let GstVideoContext ask for a proper display to its neighbours */
737     /* Note: steal old display that may be allocated from get_caps()
738        so that to retain a reference to it, thus avoiding extra
739        initialization steps if we turn out to simply re-use the
740        existing (cached) VA display */
741     GST_VAAPI_PLUGIN_BASE_DISPLAY(decode) = NULL;
742     success = gst_vaapidecode_ensure_display(decode);
743     if (old_display)
744         gst_vaapi_display_unref(old_display);
745     return success;
746 }
747
748 static gboolean
749 gst_vaapidecode_close(GstVideoDecoder *vdec)
750 {
751     GstVaapiDecode * const decode = GST_VAAPIDECODE(vdec);
752
753     gst_vaapidecode_destroy(decode);
754     gst_vaapi_plugin_base_close(GST_VAAPI_PLUGIN_BASE(decode));
755     return TRUE;
756 }
757
758 static gboolean
759 gst_vaapidecode_reset(GstVideoDecoder *vdec, gboolean hard)
760 {
761     GstVaapiDecode * const decode = GST_VAAPIDECODE(vdec);
762
763     /* In GStreamer 1.0 context, this means a flush */
764     if (decode->decoder && !hard && !gst_vaapidecode_flush(vdec))
765         return FALSE;
766     return gst_vaapidecode_reset_full(decode, decode->sinkpad_caps, hard);
767 }
768
769 static gboolean
770 gst_vaapidecode_set_format(GstVideoDecoder *vdec, GstVideoCodecState *state)
771 {
772     GstVaapiPluginBase * const plugin = GST_VAAPI_PLUGIN_BASE(vdec);
773     GstVaapiDecode * const decode = GST_VAAPIDECODE(vdec);
774
775     if (!gst_vaapidecode_update_sink_caps(decode, state->caps))
776         return FALSE;
777     if (!gst_vaapidecode_update_src_caps(decode, state))
778         return FALSE;
779     if (!gst_video_decoder_negotiate(vdec))
780         return FALSE;
781     if (!gst_vaapi_plugin_base_set_caps(plugin, decode->sinkpad_caps,
782             decode->srcpad_caps))
783         return FALSE;
784     if (!gst_vaapidecode_reset_full(decode, decode->sinkpad_caps, FALSE))
785         return FALSE;
786     return TRUE;
787 }
788
789 static GstFlowReturn
790 gst_vaapidecode_parse_frame(GstVideoDecoder *vdec,
791     GstVideoCodecFrame *frame, GstAdapter *adapter, gboolean at_eos)
792 {
793     GstVaapiDecode * const decode = GST_VAAPIDECODE(vdec);
794     GstVaapiDecoderStatus status;
795     GstFlowReturn ret;
796     guint got_unit_size;
797     gboolean got_frame;
798
799     status = gst_vaapi_decoder_parse(decode->decoder, frame,
800         adapter, at_eos, &got_unit_size, &got_frame);
801
802     switch (status) {
803     case GST_VAAPI_DECODER_STATUS_SUCCESS:
804         if (got_unit_size > 0) {
805             gst_video_decoder_add_to_frame(vdec, got_unit_size);
806             decode->current_frame_size += got_unit_size;
807         }
808         if (got_frame) {
809             ret = gst_video_decoder_have_frame(vdec);
810             decode->current_frame_size = 0;
811         }
812         else
813             ret = GST_VAAPI_DECODE_FLOW_PARSE_DATA;
814         break;
815     case GST_VAAPI_DECODER_STATUS_ERROR_NO_DATA:
816         ret = GST_VIDEO_DECODER_FLOW_NEED_DATA;
817         break;
818     case GST_VAAPI_DECODER_STATUS_ERROR_UNSUPPORTED_CODEC:
819     case GST_VAAPI_DECODER_STATUS_ERROR_UNSUPPORTED_PROFILE:
820     case GST_VAAPI_DECODER_STATUS_ERROR_UNSUPPORTED_CHROMA_FORMAT:
821         GST_WARNING("parse error %d", status);
822         ret = GST_FLOW_NOT_SUPPORTED;
823         decode->current_frame_size = 0;
824         break;
825     default:
826         GST_ERROR("parse error %d", status);
827         ret = GST_FLOW_EOS;
828         decode->current_frame_size = 0;
829         break;
830     }
831     return ret;
832 }
833
834 static GstFlowReturn
835 gst_vaapidecode_parse(GstVideoDecoder *vdec,
836     GstVideoCodecFrame *frame, GstAdapter *adapter, gboolean at_eos)
837 {
838     GstFlowReturn ret;
839
840     do {
841         ret = gst_vaapidecode_parse_frame(vdec, frame, adapter, at_eos);
842     } while (ret == GST_VAAPI_DECODE_FLOW_PARSE_DATA);
843     return ret;
844 }
845
846 static GstStateChangeReturn
847 gst_vaapidecode_change_state (GstElement * element, GstStateChange transition)
848 {
849     GstVaapiDecode * const decode = GST_VAAPIDECODE(element);
850
851     switch (transition) {
852     case GST_STATE_CHANGE_PAUSED_TO_READY:
853         gst_pad_stop_task(GST_VAAPI_PLUGIN_BASE_SRC_PAD(decode));
854         break;
855     default:
856         break;
857     }
858     return GST_ELEMENT_CLASS(gst_vaapidecode_parent_class)->change_state(
859         element, transition);
860 }
861
862 static void
863 gst_vaapidecode_class_init(GstVaapiDecodeClass *klass)
864 {
865     GObjectClass * const object_class = G_OBJECT_CLASS(klass);
866     GstElementClass * const element_class = GST_ELEMENT_CLASS(klass);
867     GstVideoDecoderClass * const vdec_class = GST_VIDEO_DECODER_CLASS(klass);
868     GstPadTemplate *pad_template;
869
870     GST_DEBUG_CATEGORY_INIT(gst_debug_vaapidecode,
871                             GST_PLUGIN_NAME, 0, GST_PLUGIN_DESC);
872
873     gst_vaapi_plugin_base_class_init(GST_VAAPI_PLUGIN_BASE_CLASS(klass));
874
875     object_class->finalize   = gst_vaapidecode_finalize;
876
877     element_class->change_state =
878         GST_DEBUG_FUNCPTR(gst_vaapidecode_change_state);
879
880     vdec_class->open         = GST_DEBUG_FUNCPTR(gst_vaapidecode_open);
881     vdec_class->close        = GST_DEBUG_FUNCPTR(gst_vaapidecode_close);
882     vdec_class->set_format   = GST_DEBUG_FUNCPTR(gst_vaapidecode_set_format);
883     vdec_class->reset        = GST_DEBUG_FUNCPTR(gst_vaapidecode_reset);
884     vdec_class->parse        = GST_DEBUG_FUNCPTR(gst_vaapidecode_parse);
885     vdec_class->handle_frame = GST_DEBUG_FUNCPTR(gst_vaapidecode_handle_frame);
886     vdec_class->finish       = GST_DEBUG_FUNCPTR(gst_vaapidecode_finish);
887
888 #if GST_CHECK_VERSION(1,0,0)
889     vdec_class->decide_allocation =
890         GST_DEBUG_FUNCPTR(gst_vaapidecode_decide_allocation);
891 #endif
892
893     gst_element_class_set_static_metadata(element_class,
894         "VA-API decoder",
895         "Codec/Decoder/Video",
896         GST_PLUGIN_DESC,
897         "Gwenole Beauchesne <gwenole.beauchesne@intel.com>");
898
899     /* sink pad */
900     pad_template = gst_static_pad_template_get(&gst_vaapidecode_sink_factory);
901     gst_element_class_add_pad_template(element_class, pad_template);
902
903     /* src pad */
904     pad_template = gst_static_pad_template_get(&gst_vaapidecode_src_factory);
905     gst_element_class_add_pad_template(element_class, pad_template);
906 }
907
908 static gboolean
909 gst_vaapidecode_ensure_allowed_caps(GstVaapiDecode *decode)
910 {
911     GstCaps *caps, *allowed_caps;
912     GArray *profiles;
913     guint i;
914
915     if (decode->allowed_caps)
916         return TRUE;
917
918     if (!gst_vaapidecode_ensure_display(decode))
919         goto error_no_display;
920
921     profiles = gst_vaapi_display_get_decode_profiles(
922         GST_VAAPI_PLUGIN_BASE_DISPLAY(decode));
923     if (!profiles)
924         goto error_no_profiles;
925
926     allowed_caps = gst_caps_new_empty();
927     if (!allowed_caps)
928         goto error_no_memory;
929
930     for (i = 0; i < profiles->len; i++) {
931         const GstVaapiProfile profile =
932             g_array_index(profiles, GstVaapiProfile, i);
933         const gchar *media_type_name;
934
935         media_type_name = gst_vaapi_profile_get_media_type_name(profile);
936         if (!media_type_name)
937             continue;
938
939         caps = gst_caps_from_string(media_type_name);
940         if (!caps)
941             continue;
942         allowed_caps = gst_caps_merge(allowed_caps, caps);
943     }
944     decode->allowed_caps = allowed_caps;
945
946     g_array_unref(profiles);
947     return TRUE;
948
949     /* ERRORS */
950 error_no_display:
951     {
952         GST_ERROR("failed to retrieve VA display");
953         return FALSE;
954     }
955 error_no_profiles:
956     {
957         GST_ERROR("failed to retrieve VA decode profiles");
958         return FALSE;
959     }
960 error_no_memory:
961     {
962         GST_ERROR("failed to allocate allowed-caps set");
963         g_array_unref(profiles);
964         return FALSE;
965     }
966 }
967
968 static GstCaps *
969 gst_vaapidecode_get_caps(GstPad *pad)
970 {
971     GstVaapiDecode * const decode = GST_VAAPIDECODE(GST_OBJECT_PARENT(pad));
972
973     if (!gst_vaapidecode_ensure_allowed_caps(decode))
974         return gst_caps_new_empty();
975
976     return gst_caps_ref(decode->allowed_caps);
977 }
978
979 static gboolean
980 gst_vaapidecode_query(GST_PAD_QUERY_FUNCTION_ARGS)
981 {
982     GstVaapiDecode * const decode =
983         GST_VAAPIDECODE(gst_pad_get_parent_element(pad));
984     GstVaapiPluginBase * const plugin = GST_VAAPI_PLUGIN_BASE(decode);
985     gboolean res;
986
987     GST_INFO_OBJECT(decode, "query type %s", GST_QUERY_TYPE_NAME(query));
988
989     if (gst_vaapi_reply_to_query(query, plugin->display)) {
990         GST_DEBUG("sharing display %p", plugin->display);
991         res = TRUE;
992     }
993     else if (GST_PAD_IS_SINK(pad)) {
994         switch (GST_QUERY_TYPE(query)) {
995 #if GST_CHECK_VERSION(1,0,0)
996         case GST_QUERY_CAPS: {
997             GstCaps * const caps = gst_vaapidecode_get_caps(pad);
998             gst_query_set_caps_result(query, caps);
999             gst_caps_unref(caps);
1000             res = TRUE;
1001             break;
1002         }
1003 #endif
1004         default:
1005             res = GST_PAD_QUERY_FUNCTION_CALL(plugin->sinkpad_query, pad,
1006                 parent, query);
1007             break;
1008         }
1009     }
1010     else
1011         res = GST_PAD_QUERY_FUNCTION_CALL(plugin->srcpad_query, pad,
1012             parent, query);
1013
1014     gst_object_unref(decode);
1015     return res;
1016 }
1017
1018 static void
1019 gst_vaapidecode_init(GstVaapiDecode *decode)
1020 {
1021     GstVideoDecoder * const vdec = GST_VIDEO_DECODER(decode);
1022     GstPad *pad;
1023
1024     gst_vaapi_plugin_base_init(GST_VAAPI_PLUGIN_BASE(decode), GST_CAT_DEFAULT);
1025
1026     decode->decoder             = NULL;
1027     decode->decoder_caps        = NULL;
1028     decode->allowed_caps        = NULL;
1029     decode->decoder_loop_status = GST_FLOW_OK;
1030
1031     g_mutex_init(&decode->decoder_mutex);
1032     g_cond_init(&decode->decoder_ready);
1033     g_cond_init(&decode->decoder_finish_done);
1034
1035     gst_video_decoder_set_packetized(vdec, FALSE);
1036
1037     /* Pad through which data comes in to the element */
1038     pad = GST_VAAPI_PLUGIN_BASE_SINK_PAD(decode);
1039     gst_pad_set_query_function(pad, gst_vaapidecode_query);
1040 #if !GST_CHECK_VERSION(1,0,0)
1041     gst_pad_set_getcaps_function(pad, gst_vaapidecode_get_caps);
1042 #endif
1043
1044     /* Pad through which data goes out of the element */
1045     pad = GST_VAAPI_PLUGIN_BASE_SRC_PAD(decode);
1046     gst_pad_set_query_function(pad, gst_vaapidecode_query);
1047 }