2 * Copyright (c) 2010 The WebM project authors. All Rights Reserved.
4 * Use of this source code is governed by a BSD-style license
5 * that can be found in the LICENSE file in the root of the source
6 * tree. An additional intellectual property rights grant can be found
7 * in the file PATENTS. All contributing project authors may
8 * be found in the AUTHORS file in the root of the source tree.
14 #include "./vpx_config.h"
15 #include "./vpx_version.h"
17 #include "vpx/internal/vpx_codec_internal.h"
18 #include "vpx/vp8dx.h"
19 #include "vpx/vpx_decoder.h"
21 #include "vp9/common/vp9_frame_buffers.h"
23 #include "vp9/decoder/vp9_decoder.h"
24 #include "vp9/decoder/vp9_decodeframe.h"
25 #include "vp9/decoder/vp9_read_bit_buffer.h"
27 #include "vp9/vp9_iface_common.h"
29 #define VP9_CAP_POSTPROC (CONFIG_VP9_POSTPROC ? VPX_CODEC_CAP_POSTPROC : 0)
31 typedef vpx_codec_stream_info_t vp9_stream_info_t;
33 struct vpx_codec_alg_priv {
34 vpx_codec_priv_t base;
35 vpx_codec_dec_cfg_t cfg;
37 struct VP9Decoder *pbi;
39 vp8_postproc_cfg_t postproc_cfg;
40 vpx_decrypt_cb decrypt_cb;
45 int invert_tile_order;
46 int frame_parallel_decode; // frame-based threading.
49 // External frame buffer info to save for VP9 common.
50 void *ext_priv; // Private data associated with the external frame buffers.
51 vpx_get_frame_buffer_cb_fn_t get_ext_fb_cb;
52 vpx_release_frame_buffer_cb_fn_t release_ext_fb_cb;
55 static vpx_codec_err_t decoder_init(vpx_codec_ctx_t *ctx,
56 vpx_codec_priv_enc_mr_cfg_t *data) {
57 // This function only allocates space for the vpx_codec_alg_priv_t
58 // structure. More memory may be required at the time the stream
59 // information becomes known.
63 vpx_codec_alg_priv_t *const priv = vpx_calloc(1, sizeof(*priv));
65 return VPX_CODEC_MEM_ERROR;
67 ctx->priv = (vpx_codec_priv_t *)priv;
68 ctx->priv->init_flags = ctx->init_flags;
70 priv->si.sz = sizeof(priv->si);
72 priv->frame_parallel_decode =
73 (ctx->init_flags & VPX_CODEC_USE_FRAME_THREADING);
74 priv->frame_parallel_decode = 0; // Disable for now
76 if (ctx->config.dec) {
77 priv->cfg = *ctx->config.dec;
78 ctx->config.dec = &priv->cfg;
85 static vpx_codec_err_t decoder_destroy(vpx_codec_alg_priv_t *ctx) {
87 vp9_decoder_remove(ctx->pbi);
96 static int parse_bitdepth_colorspace_sampling(
97 BITSTREAM_PROFILE profile, struct vp9_read_bit_buffer *rb) {
100 if (profile >= PROFILE_2)
101 rb->bit_offset += 1; // Bit-depth 10 or 12.
102 colorspace = vp9_rb_read_literal(rb, 3);
103 if (colorspace != sRGB) {
104 rb->bit_offset += 1; // [16,235] (including xvycc) vs [0,255] range.
105 if (profile == PROFILE_1 || profile == PROFILE_3) {
106 rb->bit_offset += 2; // subsampling x/y.
107 rb->bit_offset += 1; // unused.
110 if (profile == PROFILE_1 || profile == PROFILE_3) {
111 rb->bit_offset += 1; // unused
113 // RGB is only available in version 1.
120 static vpx_codec_err_t decoder_peek_si_internal(const uint8_t *data,
121 unsigned int data_sz,
122 vpx_codec_stream_info_t *si,
124 vpx_decrypt_cb decrypt_cb,
125 void *decrypt_state) {
126 int intra_only_flag = 0;
127 uint8_t clear_buffer[9];
129 if (data + data_sz <= data)
130 return VPX_CODEC_INVALID_PARAM;
136 data_sz = MIN(sizeof(clear_buffer), data_sz);
137 decrypt_cb(decrypt_state, data, clear_buffer, data_sz);
144 struct vp9_read_bit_buffer rb = { data, data + data_sz, 0, NULL, NULL };
145 const int frame_marker = vp9_rb_read_literal(&rb, 2);
146 const BITSTREAM_PROFILE profile = vp9_read_profile(&rb);
148 if (frame_marker != VP9_FRAME_MARKER)
149 return VPX_CODEC_UNSUP_BITSTREAM;
151 if (profile >= MAX_PROFILES)
152 return VPX_CODEC_UNSUP_BITSTREAM;
154 if ((profile >= 2 && data_sz <= 1) || data_sz < 1)
155 return VPX_CODEC_UNSUP_BITSTREAM;
157 if (vp9_rb_read_bit(&rb)) { // show an existing frame
158 vp9_rb_read_literal(&rb, 3); // Frame buffer to show.
163 return VPX_CODEC_UNSUP_BITSTREAM;
165 si->is_kf = !vp9_rb_read_bit(&rb);
166 show_frame = vp9_rb_read_bit(&rb);
167 error_resilient = vp9_rb_read_bit(&rb);
170 if (!vp9_read_sync_code(&rb))
171 return VPX_CODEC_UNSUP_BITSTREAM;
173 if (!parse_bitdepth_colorspace_sampling(profile, &rb))
174 return VPX_CODEC_UNSUP_BITSTREAM;
175 vp9_read_frame_size(&rb, (int *)&si->w, (int *)&si->h);
177 intra_only_flag = show_frame ? 0 : vp9_rb_read_bit(&rb);
179 rb.bit_offset += error_resilient ? 0 : 2; // reset_frame_context
181 if (intra_only_flag) {
182 if (!vp9_read_sync_code(&rb))
183 return VPX_CODEC_UNSUP_BITSTREAM;
184 if (profile > PROFILE_0) {
185 if (!parse_bitdepth_colorspace_sampling(profile, &rb))
186 return VPX_CODEC_UNSUP_BITSTREAM;
188 rb.bit_offset += REF_FRAMES; // refresh_frame_flags
189 vp9_read_frame_size(&rb, (int *)&si->w, (int *)&si->h);
193 if (is_intra_only != NULL)
194 *is_intra_only = intra_only_flag;
198 static vpx_codec_err_t decoder_peek_si(const uint8_t *data,
199 unsigned int data_sz,
200 vpx_codec_stream_info_t *si) {
201 return decoder_peek_si_internal(data, data_sz, si, NULL, NULL, NULL);
204 static vpx_codec_err_t decoder_get_si(vpx_codec_alg_priv_t *ctx,
205 vpx_codec_stream_info_t *si) {
206 const size_t sz = (si->sz >= sizeof(vp9_stream_info_t))
207 ? sizeof(vp9_stream_info_t)
208 : sizeof(vpx_codec_stream_info_t);
209 memcpy(si, &ctx->si, sz);
210 si->sz = (unsigned int)sz;
215 static vpx_codec_err_t update_error_state(vpx_codec_alg_priv_t *ctx,
216 const struct vpx_internal_error_info *error) {
217 if (error->error_code)
218 ctx->base.err_detail = error->has_detail ? error->detail : NULL;
220 return error->error_code;
223 static void init_buffer_callbacks(vpx_codec_alg_priv_t *ctx) {
224 VP9_COMMON *const cm = &ctx->pbi->common;
227 cm->byte_alignment = ctx->byte_alignment;
229 if (ctx->get_ext_fb_cb != NULL && ctx->release_ext_fb_cb != NULL) {
230 cm->get_fb_cb = ctx->get_ext_fb_cb;
231 cm->release_fb_cb = ctx->release_ext_fb_cb;
232 cm->cb_priv = ctx->ext_priv;
234 cm->get_fb_cb = vp9_get_frame_buffer;
235 cm->release_fb_cb = vp9_release_frame_buffer;
237 if (vp9_alloc_internal_frame_buffers(&cm->int_frame_buffers))
238 vpx_internal_error(&cm->error, VPX_CODEC_MEM_ERROR,
239 "Failed to initialize internal frame buffers");
241 cm->cb_priv = &cm->int_frame_buffers;
245 static void set_default_ppflags(vp8_postproc_cfg_t *cfg) {
246 cfg->post_proc_flag = VP8_DEBLOCK | VP8_DEMACROBLOCK;
247 cfg->deblocking_level = 4;
248 cfg->noise_level = 0;
251 static void set_ppflags(const vpx_codec_alg_priv_t *ctx,
252 vp9_ppflags_t *flags) {
253 flags->post_proc_flag =
254 ctx->postproc_cfg.post_proc_flag;
256 flags->deblocking_level = ctx->postproc_cfg.deblocking_level;
257 flags->noise_level = ctx->postproc_cfg.noise_level;
260 static void init_decoder(vpx_codec_alg_priv_t *ctx) {
261 ctx->pbi = vp9_decoder_create();
262 if (ctx->pbi == NULL)
265 ctx->pbi->max_threads = ctx->cfg.threads;
266 ctx->pbi->inv_tile_order = ctx->invert_tile_order;
267 ctx->pbi->frame_parallel_decode = ctx->frame_parallel_decode;
269 // If postprocessing was enabled by the application and a
270 // configuration has not been provided, default it.
271 if (!ctx->postproc_cfg_set &&
272 (ctx->base.init_flags & VPX_CODEC_USE_POSTPROC))
273 set_default_ppflags(&ctx->postproc_cfg);
275 init_buffer_callbacks(ctx);
278 static vpx_codec_err_t decode_one(vpx_codec_alg_priv_t *ctx,
279 const uint8_t **data, unsigned int data_sz,
280 void *user_priv, int64_t deadline) {
281 YV12_BUFFER_CONFIG sd;
282 vp9_ppflags_t flags = {0, 0, 0};
283 VP9_COMMON *cm = NULL;
290 // Determine the stream parameters. Note that we rely on peek_si to
291 // validate that we have a buffer that does not wrap around the top
294 int is_intra_only = 0;
295 const vpx_codec_err_t res =
296 decoder_peek_si_internal(*data, data_sz, &ctx->si, &is_intra_only,
297 ctx->decrypt_cb, ctx->decrypt_state);
298 if (res != VPX_CODEC_OK)
301 if (!ctx->si.is_kf && !is_intra_only)
302 return VPX_CODEC_ERROR;
305 // Initialize the decoder instance on the first frame
306 if (ctx->pbi == NULL) {
308 if (ctx->pbi == NULL)
309 return VPX_CODEC_ERROR;
312 // Set these even if already initialized. The caller may have changed the
313 // decrypt config between frames.
314 ctx->pbi->decrypt_cb = ctx->decrypt_cb;
315 ctx->pbi->decrypt_state = ctx->decrypt_state;
317 cm = &ctx->pbi->common;
319 if (vp9_receive_compressed_data(ctx->pbi, data_sz, data))
320 return update_error_state(ctx, &cm->error);
322 if (ctx->base.init_flags & VPX_CODEC_USE_POSTPROC)
323 set_ppflags(ctx, &flags);
325 if (vp9_get_raw_frame(ctx->pbi, &sd, &flags))
326 return update_error_state(ctx, &cm->error);
328 yuvconfig2image(&ctx->img, &sd, user_priv);
329 ctx->img.fb_priv = cm->frame_bufs[cm->new_fb_idx].raw_frame_buffer.priv;
335 static vpx_codec_err_t decoder_decode(vpx_codec_alg_priv_t *ctx,
336 const uint8_t *data, unsigned int data_sz,
337 void *user_priv, long deadline) {
338 const uint8_t *data_start = data;
339 const uint8_t * const data_end = data + data_sz;
341 uint32_t frame_sizes[8];
344 if (data == NULL && data_sz == 0) {
349 // Reset flushed when receiving a valid frame.
352 res = vp9_parse_superframe_index(data, data_sz, frame_sizes, &frame_count,
353 ctx->decrypt_cb, ctx->decrypt_state);
354 if (res != VPX_CODEC_OK)
357 if (ctx->frame_parallel_decode) {
358 // Decode in frame parallel mode. When decoding in this mode, the frame
359 // passed to the decoder must be either a normal frame or a superframe with
360 // superframe index so the decoder could get each frame's start position
361 // in the superframe.
362 if (frame_count > 0) {
365 for (i = 0; i < frame_count; ++i) {
366 const uint8_t *data_start_copy = data_start;
367 const uint32_t frame_size = frame_sizes[i];
369 if (data_start < data
370 || frame_size > (uint32_t) (data_end - data_start)) {
371 ctx->base.err_detail = "Invalid frame size in index";
372 return VPX_CODEC_CORRUPT_FRAME;
375 res = decode_one(ctx, &data_start_copy, frame_size, user_priv,
377 if (res != VPX_CODEC_OK)
380 data_start += frame_size;
383 res = decode_one(ctx, &data_start, data_sz, user_priv, deadline);
384 if (res != VPX_CODEC_OK)
387 // Extra data detected after the frame.
388 if (data_start < data_end - 1) {
389 ctx->base.err_detail = "Fail to decode frame in parallel mode";
390 return VPX_CODEC_INCAPABLE;
394 // Decode in serial mode.
395 if (frame_count > 0) {
398 for (i = 0; i < frame_count; ++i) {
399 const uint8_t *data_start_copy = data_start;
400 const uint32_t frame_size = frame_sizes[i];
402 if (data_start < data
403 || frame_size > (uint32_t) (data_end - data_start)) {
404 ctx->base.err_detail = "Invalid frame size in index";
405 return VPX_CODEC_CORRUPT_FRAME;
408 res = decode_one(ctx, &data_start_copy, frame_size, user_priv,
410 if (res != VPX_CODEC_OK)
413 data_start += frame_size;
416 while (data_start < data_end) {
417 const uint32_t frame_size = (uint32_t) (data_end - data_start);
418 const vpx_codec_err_t res = decode_one(ctx, &data_start, frame_size,
419 user_priv, deadline);
420 if (res != VPX_CODEC_OK)
423 // Account for suboptimal termination by the encoder.
424 while (data_start < data_end) {
425 const uint8_t marker = read_marker(ctx->decrypt_cb,
426 ctx->decrypt_state, data_start);
438 static vpx_image_t *decoder_get_frame(vpx_codec_alg_priv_t *ctx,
439 vpx_codec_iter_t *iter) {
440 vpx_image_t *img = NULL;
442 if (ctx->img_avail) {
443 // iter acts as a flip flop, so an image is only returned on the first
444 // call to get_frame.
455 static vpx_codec_err_t decoder_set_fb_fn(
456 vpx_codec_alg_priv_t *ctx,
457 vpx_get_frame_buffer_cb_fn_t cb_get,
458 vpx_release_frame_buffer_cb_fn_t cb_release, void *cb_priv) {
459 if (cb_get == NULL || cb_release == NULL) {
460 return VPX_CODEC_INVALID_PARAM;
461 } else if (ctx->pbi == NULL) {
462 // If the decoder has already been initialized, do not accept changes to
463 // the frame buffer functions.
464 ctx->get_ext_fb_cb = cb_get;
465 ctx->release_ext_fb_cb = cb_release;
466 ctx->ext_priv = cb_priv;
470 return VPX_CODEC_ERROR;
473 static vpx_codec_err_t ctrl_set_reference(vpx_codec_alg_priv_t *ctx,
475 vpx_ref_frame_t *const data = va_arg(args, vpx_ref_frame_t *);
478 vpx_ref_frame_t *const frame = (vpx_ref_frame_t *)data;
479 YV12_BUFFER_CONFIG sd;
481 image2yuvconfig(&frame->img, &sd);
482 return vp9_set_reference_dec(&ctx->pbi->common,
483 (VP9_REFFRAME)frame->frame_type, &sd);
485 return VPX_CODEC_INVALID_PARAM;
489 static vpx_codec_err_t ctrl_copy_reference(vpx_codec_alg_priv_t *ctx,
491 vpx_ref_frame_t *data = va_arg(args, vpx_ref_frame_t *);
494 vpx_ref_frame_t *frame = (vpx_ref_frame_t *)data;
495 YV12_BUFFER_CONFIG sd;
497 image2yuvconfig(&frame->img, &sd);
499 return vp9_copy_reference_dec(ctx->pbi,
500 (VP9_REFFRAME)frame->frame_type, &sd);
502 return VPX_CODEC_INVALID_PARAM;
506 static vpx_codec_err_t ctrl_get_reference(vpx_codec_alg_priv_t *ctx,
508 vp9_ref_frame_t *data = va_arg(args, vp9_ref_frame_t *);
511 YV12_BUFFER_CONFIG* fb = get_ref_frame(&ctx->pbi->common, data->idx);
512 if (fb == NULL) return VPX_CODEC_ERROR;
514 yuvconfig2image(&data->img, fb, NULL);
517 return VPX_CODEC_INVALID_PARAM;
521 static vpx_codec_err_t ctrl_set_postproc(vpx_codec_alg_priv_t *ctx,
523 #if CONFIG_VP9_POSTPROC
524 vp8_postproc_cfg_t *data = va_arg(args, vp8_postproc_cfg_t *);
527 ctx->postproc_cfg_set = 1;
528 ctx->postproc_cfg = *((vp8_postproc_cfg_t *)data);
531 return VPX_CODEC_INVALID_PARAM;
536 return VPX_CODEC_INCAPABLE;
540 static vpx_codec_err_t ctrl_set_dbg_options(vpx_codec_alg_priv_t *ctx,
544 return VPX_CODEC_INCAPABLE;
547 static vpx_codec_err_t ctrl_get_last_ref_updates(vpx_codec_alg_priv_t *ctx,
549 int *const update_info = va_arg(args, int *);
553 *update_info = ctx->pbi->refresh_frame_flags;
555 return VPX_CODEC_ERROR;
558 return VPX_CODEC_INVALID_PARAM;
563 static vpx_codec_err_t ctrl_get_frame_corrupted(vpx_codec_alg_priv_t *ctx,
565 int *corrupted = va_arg(args, int *);
567 if (corrupted != NULL && ctx->pbi != NULL) {
568 const YV12_BUFFER_CONFIG *const frame = ctx->pbi->common.frame_to_show;
569 if (frame == NULL) return VPX_CODEC_ERROR;
570 *corrupted = frame->corrupted;
573 return VPX_CODEC_INVALID_PARAM;
577 static vpx_codec_err_t ctrl_get_display_size(vpx_codec_alg_priv_t *ctx,
579 int *const display_size = va_arg(args, int *);
583 const VP9_COMMON *const cm = &ctx->pbi->common;
584 display_size[0] = cm->display_width;
585 display_size[1] = cm->display_height;
587 return VPX_CODEC_ERROR;
591 return VPX_CODEC_INVALID_PARAM;
595 static vpx_codec_err_t ctrl_get_bit_depth(vpx_codec_alg_priv_t *ctx,
597 unsigned int *const bit_depth = va_arg(args, unsigned int *);
601 const VP9_COMMON *const cm = &ctx->pbi->common;
602 *bit_depth = cm->bit_depth;
605 return VPX_CODEC_ERROR;
608 return VPX_CODEC_INVALID_PARAM;
612 static vpx_codec_err_t ctrl_set_invert_tile_order(vpx_codec_alg_priv_t *ctx,
614 ctx->invert_tile_order = va_arg(args, int);
618 static vpx_codec_err_t ctrl_set_decryptor(vpx_codec_alg_priv_t *ctx,
620 vpx_decrypt_init *init = va_arg(args, vpx_decrypt_init *);
621 ctx->decrypt_cb = init ? init->decrypt_cb : NULL;
622 ctx->decrypt_state = init ? init->decrypt_state : NULL;
626 static vpx_codec_err_t ctrl_set_byte_alignment(vpx_codec_alg_priv_t *ctx,
628 const int legacy_byte_alignment = 0;
629 const int min_byte_alignment = 32;
630 const int max_byte_alignment = 1024;
631 const int byte_alignment = va_arg(args, int);
633 if (byte_alignment != legacy_byte_alignment &&
634 (byte_alignment < min_byte_alignment ||
635 byte_alignment > max_byte_alignment ||
636 (byte_alignment & (byte_alignment - 1)) != 0))
637 return VPX_CODEC_INVALID_PARAM;
639 ctx->byte_alignment = byte_alignment;
640 if (ctx->pbi != NULL) {
641 VP9_COMMON *const cm = &ctx->pbi->common;
642 cm->byte_alignment = byte_alignment;
647 static vpx_codec_ctrl_fn_map_t decoder_ctrl_maps[] = {
648 {VP8_COPY_REFERENCE, ctrl_copy_reference},
651 {VP8_SET_REFERENCE, ctrl_set_reference},
652 {VP8_SET_POSTPROC, ctrl_set_postproc},
653 {VP8_SET_DBG_COLOR_REF_FRAME, ctrl_set_dbg_options},
654 {VP8_SET_DBG_COLOR_MB_MODES, ctrl_set_dbg_options},
655 {VP8_SET_DBG_COLOR_B_MODES, ctrl_set_dbg_options},
656 {VP8_SET_DBG_DISPLAY_MV, ctrl_set_dbg_options},
657 {VP9_INVERT_TILE_DECODE_ORDER, ctrl_set_invert_tile_order},
658 {VPXD_SET_DECRYPTOR, ctrl_set_decryptor},
659 {VP9_SET_BYTE_ALIGNMENT, ctrl_set_byte_alignment},
662 {VP8D_GET_LAST_REF_UPDATES, ctrl_get_last_ref_updates},
663 {VP8D_GET_FRAME_CORRUPTED, ctrl_get_frame_corrupted},
664 {VP9_GET_REFERENCE, ctrl_get_reference},
665 {VP9D_GET_DISPLAY_SIZE, ctrl_get_display_size},
666 {VP9D_GET_BIT_DEPTH, ctrl_get_bit_depth},
671 #ifndef VERSION_STRING
672 #define VERSION_STRING
674 CODEC_INTERFACE(vpx_codec_vp9_dx) = {
675 "WebM Project VP9 Decoder" VERSION_STRING,
676 VPX_CODEC_INTERNAL_ABI_VERSION,
677 VPX_CODEC_CAP_DECODER | VP9_CAP_POSTPROC |
678 VPX_CODEC_CAP_EXTERNAL_FRAME_BUFFER, // vpx_codec_caps_t
679 decoder_init, // vpx_codec_init_fn_t
680 decoder_destroy, // vpx_codec_destroy_fn_t
681 decoder_ctrl_maps, // vpx_codec_ctrl_fn_map_t
683 decoder_peek_si, // vpx_codec_peek_si_fn_t
684 decoder_get_si, // vpx_codec_get_si_fn_t
685 decoder_decode, // vpx_codec_decode_fn_t
686 decoder_get_frame, // vpx_codec_frame_get_fn_t
687 decoder_set_fb_fn, // vpx_codec_set_fb_fn_t
691 NULL, // vpx_codec_enc_cfg_map_t
692 NULL, // vpx_codec_encode_fn_t
693 NULL, // vpx_codec_get_cx_data_fn_t
694 NULL, // vpx_codec_enc_config_set_fn_t
695 NULL, // vpx_codec_get_global_headers_fn_t
696 NULL, // vpx_codec_get_preview_frame_fn_t
697 NULL // vpx_codec_enc_mr_get_mem_loc_fn_t