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_version.h"
16 #include "vpx/internal/vpx_codec_internal.h"
17 #include "vpx/vp8dx.h"
18 #include "vpx/vpx_decoder.h"
20 #include "vp9/common/vp9_frame_buffers.h"
22 #include "vp9/decoder/vp9_decoder.h"
23 #include "vp9/decoder/vp9_decodeframe.h"
24 #include "vp9/decoder/vp9_read_bit_buffer.h"
26 #include "vp9/vp9_iface_common.h"
28 #define VP9_CAP_POSTPROC (CONFIG_VP9_POSTPROC ? VPX_CODEC_CAP_POSTPROC : 0)
30 typedef vpx_codec_stream_info_t vp9_stream_info_t;
32 struct vpx_codec_alg_priv {
33 vpx_codec_priv_t base;
34 vpx_codec_dec_cfg_t cfg;
36 struct VP9Decoder *pbi;
38 vp8_postproc_cfg_t postproc_cfg;
39 vpx_decrypt_cb decrypt_cb;
44 int invert_tile_order;
45 int frame_parallel_decode; // frame-based threading.
47 // External frame buffer info to save for VP9 common.
48 void *ext_priv; // Private data associated with the external frame buffers.
49 vpx_get_frame_buffer_cb_fn_t get_ext_fb_cb;
50 vpx_release_frame_buffer_cb_fn_t release_ext_fb_cb;
53 static vpx_codec_err_t decoder_init(vpx_codec_ctx_t *ctx,
54 vpx_codec_priv_enc_mr_cfg_t *data) {
55 // This function only allocates space for the vpx_codec_alg_priv_t
56 // structure. More memory may be required at the time the stream
57 // information becomes known.
61 vpx_codec_alg_priv_t *alg_priv = vpx_memalign(32, sizeof(*alg_priv));
63 return VPX_CODEC_MEM_ERROR;
67 ctx->priv = (vpx_codec_priv_t *)alg_priv;
68 ctx->priv->sz = sizeof(*ctx->priv);
69 ctx->priv->iface = ctx->iface;
70 ctx->priv->alg_priv = alg_priv;
71 ctx->priv->alg_priv->si.sz = sizeof(ctx->priv->alg_priv->si);
72 ctx->priv->init_flags = ctx->init_flags;
73 ctx->priv->alg_priv->flushed = 0;
74 ctx->priv->alg_priv->frame_parallel_decode =
75 (ctx->init_flags & VPX_CODEC_USE_FRAME_THREADING);
77 // Disable frame parallel decoding for now.
78 ctx->priv->alg_priv->frame_parallel_decode = 0;
80 if (ctx->config.dec) {
81 // Update the reference to the config structure to an internal copy.
82 ctx->priv->alg_priv->cfg = *ctx->config.dec;
83 ctx->config.dec = &ctx->priv->alg_priv->cfg;
90 static vpx_codec_err_t decoder_destroy(vpx_codec_alg_priv_t *ctx) {
92 vp9_decoder_remove(ctx->pbi);
101 static int parse_bitdepth_colorspace_sampling(
102 BITSTREAM_PROFILE profile, struct vp9_read_bit_buffer *rb) {
105 if (profile >= PROFILE_2)
106 rb->bit_offset += 1; // Bit-depth 10 or 12.
107 colorspace = vp9_rb_read_literal(rb, 3);
108 if (colorspace != sRGB) {
109 rb->bit_offset += 1; // [16,235] (including xvycc) vs [0,255] range.
110 if (profile == PROFILE_1 || profile == PROFILE_3) {
111 rb->bit_offset += 2; // subsampling x/y.
112 rb->bit_offset += 1; // unused.
115 if (profile == PROFILE_1 || profile == PROFILE_3) {
116 rb->bit_offset += 1; // unused
118 // RGB is only available in version 1.
125 static vpx_codec_err_t decoder_peek_si_internal(const uint8_t *data,
126 unsigned int data_sz,
127 vpx_codec_stream_info_t *si,
129 vpx_decrypt_cb decrypt_cb,
130 void *decrypt_state) {
131 int intra_only_flag = 0;
132 uint8_t clear_buffer[9];
134 if (data + data_sz <= data)
135 return VPX_CODEC_INVALID_PARAM;
141 data_sz = MIN(sizeof(clear_buffer), data_sz);
142 decrypt_cb(decrypt_state, data, clear_buffer, data_sz);
149 struct vp9_read_bit_buffer rb = { data, data + data_sz, 0, NULL, NULL };
150 const int frame_marker = vp9_rb_read_literal(&rb, 2);
151 const BITSTREAM_PROFILE profile = vp9_read_profile(&rb);
153 if (frame_marker != VP9_FRAME_MARKER)
154 return VPX_CODEC_UNSUP_BITSTREAM;
156 if (profile >= MAX_PROFILES) return VPX_CODEC_UNSUP_BITSTREAM;
158 if (vp9_rb_read_bit(&rb)) { // show an existing frame
159 vp9_rb_read_literal(&rb, 3); // Frame buffer to show.
164 return VPX_CODEC_UNSUP_BITSTREAM;
166 si->is_kf = !vp9_rb_read_bit(&rb);
167 show_frame = vp9_rb_read_bit(&rb);
168 error_resilient = vp9_rb_read_bit(&rb);
171 if (!vp9_read_sync_code(&rb))
172 return VPX_CODEC_UNSUP_BITSTREAM;
174 if (!parse_bitdepth_colorspace_sampling(profile, &rb))
175 return VPX_CODEC_UNSUP_BITSTREAM;
176 vp9_read_frame_size(&rb, (int *)&si->w, (int *)&si->h);
178 intra_only_flag = show_frame ? 0 : vp9_rb_read_bit(&rb);
180 rb.bit_offset += error_resilient ? 0 : 2; // reset_frame_context
182 if (intra_only_flag) {
183 if (!vp9_read_sync_code(&rb))
184 return VPX_CODEC_UNSUP_BITSTREAM;
185 if (profile > PROFILE_0) {
186 if (!parse_bitdepth_colorspace_sampling(profile, &rb))
187 return VPX_CODEC_UNSUP_BITSTREAM;
189 rb.bit_offset += REF_FRAMES; // refresh_frame_flags
190 vp9_read_frame_size(&rb, (int *)&si->w, (int *)&si->h);
194 if (is_intra_only != NULL)
195 *is_intra_only = intra_only_flag;
199 static vpx_codec_err_t decoder_peek_si(const uint8_t *data,
200 unsigned int data_sz,
201 vpx_codec_stream_info_t *si) {
202 return decoder_peek_si_internal(data, data_sz, si, NULL, NULL, NULL);
205 static vpx_codec_err_t decoder_get_si(vpx_codec_alg_priv_t *ctx,
206 vpx_codec_stream_info_t *si) {
207 const size_t sz = (si->sz >= sizeof(vp9_stream_info_t))
208 ? sizeof(vp9_stream_info_t)
209 : sizeof(vpx_codec_stream_info_t);
210 memcpy(si, &ctx->si, sz);
211 si->sz = (unsigned int)sz;
216 static vpx_codec_err_t update_error_state(vpx_codec_alg_priv_t *ctx,
217 const struct vpx_internal_error_info *error) {
218 if (error->error_code)
219 ctx->base.err_detail = error->has_detail ? error->detail : NULL;
221 return error->error_code;
224 static void init_buffer_callbacks(vpx_codec_alg_priv_t *ctx) {
225 VP9_COMMON *const cm = &ctx->pbi->common;
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 INLINE uint8_t read_marker(vpx_decrypt_cb decrypt_cb,
337 const uint8_t *data) {
340 decrypt_cb(decrypt_state, data, &marker, 1);
346 static vpx_codec_err_t parse_superframe_index(const uint8_t *data,
348 uint32_t sizes[8], int *count,
349 vpx_decrypt_cb decrypt_cb,
350 void *decrypt_state) {
351 // A chunk ending with a byte matching 0xc0 is an invalid chunk unless
352 // it is a super frame index. If the last byte of real video compression
353 // data is 0xc0 the encoder must add a 0 byte. If we have the marker but
354 // not the associated matching marker byte at the front of the index we have
355 // an invalid bitstream and need to return an error.
360 marker = read_marker(decrypt_cb, decrypt_state, data + data_sz - 1);
363 if ((marker & 0xe0) == 0xc0) {
364 const uint32_t frames = (marker & 0x7) + 1;
365 const uint32_t mag = ((marker >> 3) & 0x3) + 1;
366 const size_t index_sz = 2 + mag * frames;
368 // This chunk is marked as having a superframe index but doesn't have
369 // enough data for it, thus it's an invalid superframe index.
370 if (data_sz < index_sz)
371 return VPX_CODEC_CORRUPT_FRAME;
374 const uint8_t marker2 = read_marker(decrypt_cb, decrypt_state,
375 data + data_sz - index_sz);
377 // This chunk is marked as having a superframe index but doesn't have
378 // the matching marker byte at the front of the index therefore it's an
380 if (marker != marker2)
381 return VPX_CODEC_CORRUPT_FRAME;
385 // Found a valid superframe index.
387 const uint8_t *x = &data[data_sz - index_sz + 1];
389 // Frames has a maximum of 8 and mag has a maximum of 4.
390 uint8_t clear_buffer[32];
391 assert(sizeof(clear_buffer) >= frames * mag);
393 decrypt_cb(decrypt_state, x, clear_buffer, frames * mag);
397 for (i = 0; i < frames; ++i) {
398 uint32_t this_sz = 0;
400 for (j = 0; j < mag; ++j)
401 this_sz |= (*x++) << (j * 8);
410 static vpx_codec_err_t decoder_decode(vpx_codec_alg_priv_t *ctx,
411 const uint8_t *data, unsigned int data_sz,
412 void *user_priv, long deadline) {
413 const uint8_t *data_start = data;
414 const uint8_t * const data_end = data + data_sz;
416 uint32_t frame_sizes[8];
419 if (data == NULL && data_sz == 0) {
424 // Reset flushed when receiving a valid frame.
427 res = parse_superframe_index(data, data_sz, frame_sizes, &frame_count,
428 ctx->decrypt_cb, ctx->decrypt_state);
429 if (res != VPX_CODEC_OK)
432 if (ctx->frame_parallel_decode) {
433 // Decode in frame parallel mode. When decoding in this mode, the frame
434 // passed to the decoder must be either a normal frame or a superframe with
435 // superframe index so the decoder could get each frame's start position
436 // in the superframe.
437 if (frame_count > 0) {
440 for (i = 0; i < frame_count; ++i) {
441 const uint8_t *data_start_copy = data_start;
442 const uint32_t frame_size = frame_sizes[i];
444 if (data_start < data
445 || frame_size > (uint32_t) (data_end - data_start)) {
446 ctx->base.err_detail = "Invalid frame size in index";
447 return VPX_CODEC_CORRUPT_FRAME;
450 res = decode_one(ctx, &data_start_copy, frame_size, user_priv,
452 if (res != VPX_CODEC_OK)
455 data_start += frame_size;
458 res = decode_one(ctx, &data_start, data_sz, user_priv, deadline);
459 if (res != VPX_CODEC_OK)
462 // Extra data detected after the frame.
463 if (data_start < data_end - 1) {
464 ctx->base.err_detail = "Fail to decode frame in parallel mode";
465 return VPX_CODEC_INCAPABLE;
469 // Decode in serial mode.
470 if (frame_count > 0) {
473 for (i = 0; i < frame_count; ++i) {
474 const uint8_t *data_start_copy = data_start;
475 const uint32_t frame_size = frame_sizes[i];
477 if (data_start < data
478 || frame_size > (uint32_t) (data_end - data_start)) {
479 ctx->base.err_detail = "Invalid frame size in index";
480 return VPX_CODEC_CORRUPT_FRAME;
483 res = decode_one(ctx, &data_start_copy, frame_size, user_priv,
485 if (res != VPX_CODEC_OK)
488 data_start += frame_size;
491 while (data_start < data_end) {
492 const uint32_t frame_size = (uint32_t) (data_end - data_start);
493 const vpx_codec_err_t res = decode_one(ctx, &data_start, frame_size,
494 user_priv, deadline);
495 if (res != VPX_CODEC_OK)
498 // Account for suboptimal termination by the encoder.
499 while (data_start < data_end) {
500 const uint8_t marker = read_marker(ctx->decrypt_cb,
501 ctx->decrypt_state, data_start);
513 static vpx_image_t *decoder_get_frame(vpx_codec_alg_priv_t *ctx,
514 vpx_codec_iter_t *iter) {
515 vpx_image_t *img = NULL;
517 if (ctx->img_avail) {
518 // iter acts as a flip flop, so an image is only returned on the first
519 // call to get_frame.
530 static vpx_codec_err_t decoder_set_fb_fn(
531 vpx_codec_alg_priv_t *ctx,
532 vpx_get_frame_buffer_cb_fn_t cb_get,
533 vpx_release_frame_buffer_cb_fn_t cb_release, void *cb_priv) {
534 if (cb_get == NULL || cb_release == NULL) {
535 return VPX_CODEC_INVALID_PARAM;
536 } else if (ctx->pbi == NULL) {
537 // If the decoder has already been initialized, do not accept changes to
538 // the frame buffer functions.
539 ctx->get_ext_fb_cb = cb_get;
540 ctx->release_ext_fb_cb = cb_release;
541 ctx->ext_priv = cb_priv;
545 return VPX_CODEC_ERROR;
548 static vpx_codec_err_t ctrl_set_reference(vpx_codec_alg_priv_t *ctx,
550 vpx_ref_frame_t *const data = va_arg(args, vpx_ref_frame_t *);
553 vpx_ref_frame_t *const frame = (vpx_ref_frame_t *)data;
554 YV12_BUFFER_CONFIG sd;
556 image2yuvconfig(&frame->img, &sd);
557 return vp9_set_reference_dec(&ctx->pbi->common,
558 (VP9_REFFRAME)frame->frame_type, &sd);
560 return VPX_CODEC_INVALID_PARAM;
564 static vpx_codec_err_t ctrl_copy_reference(vpx_codec_alg_priv_t *ctx,
566 vpx_ref_frame_t *data = va_arg(args, vpx_ref_frame_t *);
569 vpx_ref_frame_t *frame = (vpx_ref_frame_t *)data;
570 YV12_BUFFER_CONFIG sd;
572 image2yuvconfig(&frame->img, &sd);
574 return vp9_copy_reference_dec(ctx->pbi,
575 (VP9_REFFRAME)frame->frame_type, &sd);
577 return VPX_CODEC_INVALID_PARAM;
581 static vpx_codec_err_t ctrl_get_reference(vpx_codec_alg_priv_t *ctx,
583 vp9_ref_frame_t *data = va_arg(args, vp9_ref_frame_t *);
586 YV12_BUFFER_CONFIG* fb;
588 vp9_get_reference_dec(ctx->pbi, data->idx, &fb);
589 yuvconfig2image(&data->img, fb, NULL);
592 return VPX_CODEC_INVALID_PARAM;
596 static vpx_codec_err_t ctrl_set_postproc(vpx_codec_alg_priv_t *ctx,
598 #if CONFIG_VP9_POSTPROC
599 vp8_postproc_cfg_t *data = va_arg(args, vp8_postproc_cfg_t *);
602 ctx->postproc_cfg_set = 1;
603 ctx->postproc_cfg = *((vp8_postproc_cfg_t *)data);
606 return VPX_CODEC_INVALID_PARAM;
611 return VPX_CODEC_INCAPABLE;
615 static vpx_codec_err_t ctrl_set_dbg_options(vpx_codec_alg_priv_t *ctx,
619 return VPX_CODEC_INCAPABLE;
622 static vpx_codec_err_t ctrl_get_last_ref_updates(vpx_codec_alg_priv_t *ctx,
624 int *const update_info = va_arg(args, int *);
628 *update_info = ctx->pbi->refresh_frame_flags;
630 return VPX_CODEC_ERROR;
633 return VPX_CODEC_INVALID_PARAM;
638 static vpx_codec_err_t ctrl_get_frame_corrupted(vpx_codec_alg_priv_t *ctx,
640 int *corrupted = va_arg(args, int *);
644 *corrupted = ctx->pbi->common.frame_to_show->corrupted;
646 return VPX_CODEC_ERROR;
649 return VPX_CODEC_INVALID_PARAM;
653 static vpx_codec_err_t ctrl_get_display_size(vpx_codec_alg_priv_t *ctx,
655 int *const display_size = va_arg(args, int *);
659 const VP9_COMMON *const cm = &ctx->pbi->common;
660 display_size[0] = cm->display_width;
661 display_size[1] = cm->display_height;
663 return VPX_CODEC_ERROR;
667 return VPX_CODEC_INVALID_PARAM;
671 static vpx_codec_err_t ctrl_set_invert_tile_order(vpx_codec_alg_priv_t *ctx,
673 ctx->invert_tile_order = va_arg(args, int);
677 static vpx_codec_err_t ctrl_set_decryptor(vpx_codec_alg_priv_t *ctx,
679 vpx_decrypt_init *init = va_arg(args, vpx_decrypt_init *);
680 ctx->decrypt_cb = init ? init->decrypt_cb : NULL;
681 ctx->decrypt_state = init ? init->decrypt_state : NULL;
685 static vpx_codec_ctrl_fn_map_t decoder_ctrl_maps[] = {
686 {VP8_COPY_REFERENCE, ctrl_copy_reference},
689 {VP8_SET_REFERENCE, ctrl_set_reference},
690 {VP8_SET_POSTPROC, ctrl_set_postproc},
691 {VP8_SET_DBG_COLOR_REF_FRAME, ctrl_set_dbg_options},
692 {VP8_SET_DBG_COLOR_MB_MODES, ctrl_set_dbg_options},
693 {VP8_SET_DBG_COLOR_B_MODES, ctrl_set_dbg_options},
694 {VP8_SET_DBG_DISPLAY_MV, ctrl_set_dbg_options},
695 {VP9_INVERT_TILE_DECODE_ORDER, ctrl_set_invert_tile_order},
696 {VPXD_SET_DECRYPTOR, ctrl_set_decryptor},
699 {VP8D_GET_LAST_REF_UPDATES, ctrl_get_last_ref_updates},
700 {VP8D_GET_FRAME_CORRUPTED, ctrl_get_frame_corrupted},
701 {VP9_GET_REFERENCE, ctrl_get_reference},
702 {VP9D_GET_DISPLAY_SIZE, ctrl_get_display_size},
707 #ifndef VERSION_STRING
708 #define VERSION_STRING
710 CODEC_INTERFACE(vpx_codec_vp9_dx) = {
711 "WebM Project VP9 Decoder" VERSION_STRING,
712 VPX_CODEC_INTERNAL_ABI_VERSION,
713 VPX_CODEC_CAP_DECODER | VP9_CAP_POSTPROC |
714 VPX_CODEC_CAP_EXTERNAL_FRAME_BUFFER, // vpx_codec_caps_t
715 decoder_init, // vpx_codec_init_fn_t
716 decoder_destroy, // vpx_codec_destroy_fn_t
717 decoder_ctrl_maps, // vpx_codec_ctrl_fn_map_t
718 NOT_IMPLEMENTED, // vpx_codec_get_mmap_fn_t
719 NOT_IMPLEMENTED, // vpx_codec_set_mmap_fn_t
721 decoder_peek_si, // vpx_codec_peek_si_fn_t
722 decoder_get_si, // vpx_codec_get_si_fn_t
723 decoder_decode, // vpx_codec_decode_fn_t
724 decoder_get_frame, // vpx_codec_frame_get_fn_t
725 decoder_set_fb_fn, // vpx_codec_set_fb_fn_t
729 NOT_IMPLEMENTED, // vpx_codec_enc_cfg_map_t
730 NOT_IMPLEMENTED, // vpx_codec_encode_fn_t
731 NOT_IMPLEMENTED, // vpx_codec_get_cx_data_fn_t
732 NOT_IMPLEMENTED, // vpx_codec_enc_config_set_fn_t
733 NOT_IMPLEMENTED, // vpx_codec_get_global_headers_fn_t
734 NOT_IMPLEMENTED, // vpx_codec_get_preview_frame_fn_t
735 NOT_IMPLEMENTED // vpx_codec_enc_mr_get_mem_loc_fn_t