2 * Copyright (C) 2020 Intel Corporation
3 * Author: He Junyan <junyan.he@intel.com>
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Library General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Library General Public License for more details.
15 * You should have received a copy of the GNU Library General Public
16 * License along with this library; if not, write to the0
17 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
18 * Boston, MA 02110-1301, USA.
22 * SECTION:element-vavp8dec
24 * @short_description: A VA-API based VP8 video decoder
26 * vavp8dec decodes VP8 bitstreams to VA surfaces using the
27 * installed and chosen [VA-API](https://01.org/linuxmedia/vaapi)
30 * The decoding surfaces can be mapped onto main memory as video
33 * ## Example launch line
35 * gst-launch-1.0 filesrc location=sample.webm ! parsebin ! vavp8dec ! autovideosink
46 #include "gstvavp8dec.h"
48 #include "gstvabasedec.h"
50 GST_DEBUG_CATEGORY_STATIC (gst_va_vp8dec_debug);
51 #ifndef GST_DISABLE_GST_DEBUG
52 #define GST_CAT_DEFAULT gst_va_vp8dec_debug
54 #define GST_CAT_DEFAULT NULL
57 #define GST_VA_VP8_DEC(obj) ((GstVaVp8Dec *) obj)
58 #define GST_VA_VP8_DEC_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), G_TYPE_FROM_INSTANCE (obj), GstVaVp8DecClass))
59 #define GST_VA_VP8_DEC_CLASS(klass) ((GstVaVp8DecClass *) klass)
61 typedef struct _GstVaVp8Dec GstVaVp8Dec;
62 typedef struct _GstVaVp8DecClass GstVaVp8DecClass;
64 struct _GstVaVp8DecClass
66 GstVaBaseDecClass parent_class;
74 static GstElementClass *parent_class = NULL;
77 static const gchar *src_caps_str =
78 GST_VIDEO_CAPS_MAKE_WITH_FEATURES (GST_CAPS_FEATURE_MEMORY_VA,
80 GST_VIDEO_CAPS_MAKE ("{ NV12 }");
83 static const gchar *sink_caps_str = "video/x-vp8";
86 gst_va_vp8_dec_negotiate (GstVideoDecoder * decoder)
88 GstCapsFeatures *capsfeatures = NULL;
89 GstVaBaseDec *base = GST_VA_BASE_DEC (decoder);
90 GstVaVp8Dec *self = GST_VA_VP8_DEC (decoder);
91 GstVideoFormat format = GST_VIDEO_FORMAT_UNKNOWN;
92 GstVp8Decoder *vp8dec = GST_VP8_DECODER (decoder);
94 /* Ignore downstream renegotiation request. */
95 if (!base->need_negotiation)
98 base->need_negotiation = FALSE;
100 if (gst_va_decoder_is_open (base->decoder)
101 && !gst_va_decoder_close (base->decoder))
104 if (!gst_va_decoder_open (base->decoder, base->profile, base->rt_format))
107 if (!gst_va_decoder_set_frame_size (base->decoder, base->width, base->height))
110 if (base->output_state)
111 gst_video_codec_state_unref (base->output_state);
113 gst_va_base_dec_get_preferred_format_and_caps_features (base, &format,
115 if (format == GST_VIDEO_FORMAT_UNKNOWN)
119 gst_video_decoder_set_output_state (decoder, format,
120 base->width, base->height, vp8dec->input_state);
122 base->output_state->caps = gst_video_info_to_caps (&base->output_state->info);
124 gst_caps_set_features_simple (base->output_state->caps, capsfeatures);
126 GST_INFO_OBJECT (self, "Negotiated caps %" GST_PTR_FORMAT,
127 base->output_state->caps);
129 return GST_VIDEO_DECODER_CLASS (parent_class)->negotiate (decoder);
133 _get_profile (GstVaVp8Dec * self, const GstVp8FrameHdr * frame_hdr)
136 if (frame_hdr->version > 3) {
137 GST_ERROR_OBJECT (self, "Unsupported vp8 version: %d", frame_hdr->version);
138 return VAProfileNone;
141 return VAProfileVP8Version0_3;
145 gst_va_vp8_dec_new_sequence (GstVp8Decoder * decoder,
146 const GstVp8FrameHdr * frame_hdr, gint max_dpb_size)
148 GstVaBaseDec *base = GST_VA_BASE_DEC (decoder);
149 GstVaVp8Dec *self = GST_VA_VP8_DEC (decoder);
152 gboolean negotiation_needed = FALSE;
154 GST_LOG_OBJECT (self, "new sequence");
156 profile = _get_profile (self, frame_hdr);
157 if (profile == VAProfileNone)
158 return GST_FLOW_NOT_NEGOTIATED;
160 if (!gst_va_decoder_has_profile (base->decoder, profile)) {
161 GST_ERROR_OBJECT (self, "Profile %s is not supported",
162 gst_va_profile_name (profile));
163 return GST_FLOW_NOT_NEGOTIATED;
166 /* VP8 always use 8 bits 4:2:0 */
167 rt_format = VA_RT_FORMAT_YUV420;
169 if (!gst_va_decoder_config_is_equal (base->decoder, profile,
170 rt_format, frame_hdr->width, frame_hdr->height)) {
171 base->profile = profile;
172 base->width = frame_hdr->width;
173 base->height = frame_hdr->height;
174 base->rt_format = rt_format;
175 negotiation_needed = TRUE;
178 base->min_buffers = 3 + 4; /* max num pic references + scratch surfaces */
180 base->need_negotiation = negotiation_needed;
186 gst_va_vp8_dec_new_picture (GstVp8Decoder * decoder,
187 GstVideoCodecFrame * frame, GstVp8Picture * picture)
189 GstVaVp8Dec *self = GST_VA_VP8_DEC (decoder);
190 GstVaDecodePicture *pic;
191 GstVaBaseDec *base = GST_VA_BASE_DEC (decoder);
194 ret = gst_va_base_dec_prepare_output_frame (base, frame);
195 if (ret != GST_FLOW_OK)
198 pic = gst_va_decode_picture_new (base->decoder, frame->output_buffer);
200 gst_vp8_picture_set_user_data (picture, pic,
201 (GDestroyNotify) gst_va_decode_picture_free);
203 GST_LOG_OBJECT (self, "New va decode picture %p - %#x", pic,
204 gst_va_decode_picture_get_surface (pic));
210 GST_WARNING_OBJECT (self,
211 "Failed to allocated output buffer, return %s",
212 gst_flow_get_name (ret));
218 _fill_quant_matrix (GstVp8Decoder * decoder, GstVp8Picture * picture,
219 GstVp8Parser * parser)
221 GstVaBaseDec *base = GST_VA_BASE_DEC (decoder);
222 GstVp8FrameHdr const *frame_hdr = &picture->frame_hdr;
223 GstVp8Segmentation *const seg = &parser->segmentation;
224 VAIQMatrixBufferVP8 iq_matrix = { };
225 const gint8 QI_MAX = 127;
229 /* Fill in VAIQMatrixBufferVP8 */
230 for (i = 0; i < 4; i++) {
231 if (seg->segmentation_enabled) {
232 qi_base = seg->quantizer_update_value[i];
233 if (!seg->segment_feature_mode) /* 0 means delta update */
234 qi_base += frame_hdr->quant_indices.y_ac_qi;
236 qi_base = frame_hdr->quant_indices.y_ac_qi;
239 iq_matrix.quantization_index[i][0] = CLAMP (qi, 0, QI_MAX);
240 qi = qi_base + frame_hdr->quant_indices.y_dc_delta;
241 iq_matrix.quantization_index[i][1] = CLAMP (qi, 0, QI_MAX);
242 qi = qi_base + frame_hdr->quant_indices.y2_dc_delta;
243 iq_matrix.quantization_index[i][2] = CLAMP (qi, 0, QI_MAX);
244 qi = qi_base + frame_hdr->quant_indices.y2_ac_delta;
245 iq_matrix.quantization_index[i][3] = CLAMP (qi, 0, QI_MAX);
246 qi = qi_base + frame_hdr->quant_indices.uv_dc_delta;
247 iq_matrix.quantization_index[i][4] = CLAMP (qi, 0, QI_MAX);
248 qi = qi_base + frame_hdr->quant_indices.uv_ac_delta;
249 iq_matrix.quantization_index[i][5] = CLAMP (qi, 0, QI_MAX);
252 return gst_va_decoder_add_param_buffer (base->decoder,
253 gst_vp8_picture_get_user_data (picture), VAIQMatrixBufferType, &iq_matrix,
258 _fill_probability_table (GstVp8Decoder * decoder, GstVp8Picture * picture)
260 GstVaBaseDec *base = GST_VA_BASE_DEC (decoder);
261 GstVp8FrameHdr const *frame_hdr = &picture->frame_hdr;
262 VAProbabilityDataBufferVP8 prob_table = { };
264 /* Fill in VAProbabilityDataBufferVP8 */
265 memcpy (prob_table.dct_coeff_probs, frame_hdr->token_probs.prob,
266 sizeof (frame_hdr->token_probs.prob));
268 return gst_va_decoder_add_param_buffer (base->decoder,
269 gst_vp8_picture_get_user_data (picture), VAProbabilityBufferType,
270 &prob_table, sizeof (prob_table));
274 _fill_picture (GstVp8Decoder * decoder, GstVp8Picture * picture,
275 GstVp8Parser * parser)
277 GstVaBaseDec *base = GST_VA_BASE_DEC (decoder);
278 GstVaDecodePicture *va_pic;
279 VAPictureParameterBufferVP8 pic_param;
280 GstVp8FrameHdr const *frame_hdr = &picture->frame_hdr;
281 GstVp8Segmentation *const seg = &parser->segmentation;
284 if (!_fill_quant_matrix (decoder, picture, parser))
287 if (!_fill_probability_table (decoder, picture))
291 pic_param = (VAPictureParameterBufferVP8) {
292 .frame_width = base->width,
293 .frame_height = base->height,
294 .last_ref_frame = VA_INVALID_SURFACE,
295 .golden_ref_frame = VA_INVALID_SURFACE,
296 .alt_ref_frame = VA_INVALID_SURFACE,
297 .out_of_loop_frame = VA_INVALID_SURFACE, // not used currently
298 .pic_fields.bits.key_frame = !frame_hdr->key_frame,
299 .pic_fields.bits.version = frame_hdr->version,
300 .pic_fields.bits.segmentation_enabled = seg->segmentation_enabled,
301 .pic_fields.bits.update_mb_segmentation_map =
302 seg->update_mb_segmentation_map,
303 .pic_fields.bits.update_segment_feature_data =
304 seg->update_segment_feature_data,
305 .pic_fields.bits.filter_type = frame_hdr->filter_type,
306 .pic_fields.bits.sharpness_level = frame_hdr->sharpness_level,
307 .pic_fields.bits.loop_filter_adj_enable =
308 parser->mb_lf_adjust.loop_filter_adj_enable,
309 .pic_fields.bits.mode_ref_lf_delta_update =
310 parser->mb_lf_adjust.mode_ref_lf_delta_update,
311 .pic_fields.bits.sign_bias_golden = frame_hdr->sign_bias_golden,
312 .pic_fields.bits.sign_bias_alternate = frame_hdr->sign_bias_alternate,
313 .pic_fields.bits.mb_no_coeff_skip = frame_hdr->mb_no_skip_coeff,
314 /* In decoding, the only loop filter settings that matter are those
315 in the frame header (9.1) */
316 .pic_fields.bits.loop_filter_disable = frame_hdr->loop_filter_level == 0,
317 .prob_skip_false = frame_hdr->prob_skip_false,
318 .prob_intra = frame_hdr->prob_intra,
319 .prob_last = frame_hdr->prob_last,
320 .prob_gf = frame_hdr->prob_gf,
321 .bool_coder_ctx.range = frame_hdr->rd_range,
322 .bool_coder_ctx.value = frame_hdr->rd_value,
323 .bool_coder_ctx.count = frame_hdr->rd_count,
327 if (!frame_hdr->key_frame) {
328 if (decoder->last_picture) {
329 va_pic = gst_vp8_picture_get_user_data (decoder->last_picture);
330 pic_param.last_ref_frame = gst_va_decode_picture_get_surface (va_pic);
332 if (decoder->golden_ref_picture) {
333 va_pic = gst_vp8_picture_get_user_data (decoder->golden_ref_picture);
334 pic_param.golden_ref_frame = gst_va_decode_picture_get_surface (va_pic);
336 if (decoder->alt_ref_picture) {
337 va_pic = gst_vp8_picture_get_user_data (decoder->alt_ref_picture);
338 pic_param.alt_ref_frame = gst_va_decode_picture_get_surface (va_pic);
342 for (i = 0; i < 3; i++)
343 pic_param.mb_segment_tree_probs[i] = seg->segment_prob[i];
345 for (i = 0; i < 4; i++) {
347 if (seg->segmentation_enabled) {
348 level = seg->lf_update_value[i];
349 /* 0 means delta update */
350 if (!seg->segment_feature_mode)
351 level += frame_hdr->loop_filter_level;
353 level = frame_hdr->loop_filter_level;
354 pic_param.loop_filter_level[i] = CLAMP (level, 0, 63);
356 pic_param.loop_filter_deltas_ref_frame[i] =
357 parser->mb_lf_adjust.ref_frame_delta[i];
358 pic_param.loop_filter_deltas_mode[i] =
359 parser->mb_lf_adjust.mb_mode_delta[i];
362 memcpy (pic_param.y_mode_probs, frame_hdr->mode_probs.y_prob,
363 sizeof (frame_hdr->mode_probs.y_prob));
364 memcpy (pic_param.uv_mode_probs, frame_hdr->mode_probs.uv_prob,
365 sizeof (frame_hdr->mode_probs.uv_prob));
366 memcpy (pic_param.mv_probs, frame_hdr->mv_probs.prob,
367 sizeof (frame_hdr->mv_probs));
369 va_pic = gst_vp8_picture_get_user_data (picture);
370 return gst_va_decoder_add_param_buffer (base->decoder, va_pic,
371 VAPictureParameterBufferType, &pic_param, sizeof (pic_param));
375 _add_slice (GstVp8Decoder * decoder, GstVp8Picture * picture,
376 GstVp8Parser * parser)
378 GstVaBaseDec *base = GST_VA_BASE_DEC (decoder);
379 GstVp8FrameHdr const *frame_hdr = &picture->frame_hdr;
380 VASliceParameterBufferVP8 slice_param;
381 GstVaDecodePicture *va_pic;
385 slice_param = (VASliceParameterBufferVP8) {
386 .slice_data_size = picture->size,
387 .slice_data_offset = frame_hdr->data_chunk_size,
388 .macroblock_offset = frame_hdr->header_size,
389 .num_of_partitions = (1 << frame_hdr->log2_nbr_of_dct_partitions) + 1,
393 slice_param.partition_size[0] =
394 frame_hdr->first_part_size - ((slice_param.macroblock_offset + 7) >> 3);
395 for (i = 1; i < slice_param.num_of_partitions; i++)
396 slice_param.partition_size[i] = frame_hdr->partition_size[i - 1];
397 for (; i < G_N_ELEMENTS (slice_param.partition_size); i++)
398 slice_param.partition_size[i] = 0;
400 va_pic = gst_vp8_picture_get_user_data (picture);
401 return gst_va_decoder_add_slice_buffer (base->decoder, va_pic, &slice_param,
402 sizeof (slice_param), (gpointer) picture->data, picture->size);
406 gst_va_vp8_dec_decode_picture (GstVp8Decoder * decoder, GstVp8Picture * picture,
407 GstVp8Parser * parser)
409 if (_fill_picture (decoder, picture, parser) &&
410 _add_slice (decoder, picture, parser))
413 return GST_FLOW_ERROR;
417 gst_va_vp8_dec_end_picture (GstVp8Decoder * decoder, GstVp8Picture * picture)
419 GstVaBaseDec *base = GST_VA_BASE_DEC (decoder);
420 GstVaDecodePicture *va_pic;
422 GST_LOG_OBJECT (base, "end picture %p, (system_frame_number %d)",
423 picture, picture->system_frame_number);
425 va_pic = gst_vp8_picture_get_user_data (picture);
427 if (!gst_va_decoder_decode (base->decoder, va_pic))
428 return GST_FLOW_ERROR;
434 gst_va_vp8_dec_output_picture (GstVp8Decoder * decoder,
435 GstVideoCodecFrame * frame, GstVp8Picture * picture)
437 GstVaBaseDec *base = GST_VA_BASE_DEC (decoder);
438 GstVaVp8Dec *self = GST_VA_VP8_DEC (decoder);
439 GstVideoDecoder *vdec = GST_VIDEO_DECODER (decoder);
442 GST_LOG_OBJECT (self,
443 "Outputting picture %p (system_frame_number %d)",
444 picture, picture->system_frame_number);
446 ret = gst_va_base_dec_process_output (base, frame, 0);
447 gst_vp8_picture_unref (picture);
450 return gst_video_decoder_finish_frame (vdec, frame);
451 return GST_FLOW_ERROR;
455 gst_va_vp8_dec_init (GTypeInstance * instance, gpointer g_class)
457 gst_va_base_dec_init (GST_VA_BASE_DEC (instance), GST_CAT_DEFAULT);
461 gst_va_vp8_dec_dispose (GObject * object)
463 gst_va_base_dec_close (GST_VIDEO_DECODER (object));
464 G_OBJECT_CLASS (parent_class)->dispose (object);
468 gst_va_vp8_dec_class_init (gpointer g_class, gpointer class_data)
470 GstCaps *src_doc_caps, *sink_doc_caps;
471 GObjectClass *gobject_class = G_OBJECT_CLASS (g_class);
472 GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
473 GstVp8DecoderClass *vp8decoder_class = GST_VP8_DECODER_CLASS (g_class);
474 GstVideoDecoderClass *decoder_class = GST_VIDEO_DECODER_CLASS (g_class);
475 struct CData *cdata = class_data;
478 if (cdata->description) {
479 long_name = g_strdup_printf ("VA-API VP8 Decoder in %s",
482 long_name = g_strdup ("VA-API VP8 Decoder");
485 gst_element_class_set_metadata (element_class, long_name,
486 "Codec/Decoder/Video/Hardware",
487 "VA-API based VP8 video decoder", "He Junyan <junyan.he@intel.com>");
489 sink_doc_caps = gst_caps_from_string (sink_caps_str);
490 src_doc_caps = gst_caps_from_string (src_caps_str);
492 parent_class = g_type_class_peek_parent (g_class);
495 * GstVaVp8Dec:device-path:
497 * It shows the DRM device path used for the VA operation, if any.
501 gst_va_base_dec_class_init (GST_VA_BASE_DEC_CLASS (g_class), VP8,
502 cdata->render_device_path, cdata->sink_caps, cdata->src_caps,
503 src_doc_caps, sink_doc_caps);
505 gobject_class->dispose = gst_va_vp8_dec_dispose;
507 decoder_class->negotiate = GST_DEBUG_FUNCPTR (gst_va_vp8_dec_negotiate);
509 vp8decoder_class->new_sequence =
510 GST_DEBUG_FUNCPTR (gst_va_vp8_dec_new_sequence);
511 vp8decoder_class->new_picture =
512 GST_DEBUG_FUNCPTR (gst_va_vp8_dec_new_picture);
513 vp8decoder_class->decode_picture =
514 GST_DEBUG_FUNCPTR (gst_va_vp8_dec_decode_picture);
515 vp8decoder_class->end_picture =
516 GST_DEBUG_FUNCPTR (gst_va_vp8_dec_end_picture);
517 vp8decoder_class->output_picture =
518 GST_DEBUG_FUNCPTR (gst_va_vp8_dec_output_picture);
521 g_free (cdata->description);
522 g_free (cdata->render_device_path);
523 gst_caps_unref (cdata->src_caps);
524 gst_caps_unref (cdata->sink_caps);
529 _register_debug_category (gpointer data)
531 GST_DEBUG_CATEGORY_INIT (gst_va_vp8dec_debug, "vavp8dec", 0,
538 gst_va_vp8_dec_register (GstPlugin * plugin, GstVaDevice * device,
539 GstCaps * sink_caps, GstCaps * src_caps, guint rank)
541 static GOnce debug_once = G_ONCE_INIT;
543 GTypeInfo type_info = {
544 .class_size = sizeof (GstVaVp8DecClass),
545 .class_init = gst_va_vp8_dec_class_init,
546 .instance_size = sizeof (GstVaVp8Dec),
547 .instance_init = gst_va_vp8_dec_init,
551 gchar *type_name, *feature_name;
553 g_return_val_if_fail (GST_IS_PLUGIN (plugin), FALSE);
554 g_return_val_if_fail (GST_IS_VA_DEVICE (device), FALSE);
555 g_return_val_if_fail (GST_IS_CAPS (sink_caps), FALSE);
556 g_return_val_if_fail (GST_IS_CAPS (src_caps), FALSE);
558 cdata = g_new (struct CData, 1);
559 cdata->description = NULL;
560 cdata->render_device_path = g_strdup (device->render_device_path);
561 cdata->sink_caps = gst_caps_ref (sink_caps);
562 cdata->src_caps = gst_caps_ref (src_caps);
564 /* class data will be leaked if the element never gets instantiated */
565 GST_MINI_OBJECT_FLAG_SET (cdata->sink_caps,
566 GST_MINI_OBJECT_FLAG_MAY_BE_LEAKED);
567 GST_MINI_OBJECT_FLAG_SET (src_caps, GST_MINI_OBJECT_FLAG_MAY_BE_LEAKED);
569 type_info.class_data = cdata;
571 /* The first decoder to be registered should use a constant name,
572 * like vavp8dec, for any additional decoders, we create unique
573 * names, using inserting the render device name. */
574 if (device->index == 0) {
575 type_name = g_strdup ("GstVaVp8Dec");
576 feature_name = g_strdup ("vavp8dec");
578 gchar *basename = g_path_get_basename (device->render_device_path);
579 type_name = g_strdup_printf ("GstVa%sVp8Dec", basename);
580 feature_name = g_strdup_printf ("va%svp8dec", basename);
581 cdata->description = basename;
583 /* lower rank for non-first device */
588 g_once (&debug_once, _register_debug_category, NULL);
590 type = g_type_register_static (GST_TYPE_VP8_DECODER,
591 type_name, &type_info, 0);
593 ret = gst_element_register (plugin, feature_name, rank, type);
596 g_free (feature_name);