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.
48 // External frame buffer info to save for VP9 common.
49 void *ext_priv; // Private data associated with the external frame buffers.
50 vpx_get_frame_buffer_cb_fn_t get_ext_fb_cb;
51 vpx_release_frame_buffer_cb_fn_t release_ext_fb_cb;
54 static vpx_codec_err_t decoder_init(vpx_codec_ctx_t *ctx,
55 vpx_codec_priv_enc_mr_cfg_t *data) {
56 // This function only allocates space for the vpx_codec_alg_priv_t
57 // structure. More memory may be required at the time the stream
58 // information becomes known.
62 vpx_codec_alg_priv_t *const priv = vpx_calloc(1, sizeof(*priv));
64 return VPX_CODEC_MEM_ERROR;
66 ctx->priv = (vpx_codec_priv_t *)priv;
67 ctx->priv->init_flags = ctx->init_flags;
69 priv->si.sz = sizeof(priv->si);
71 priv->frame_parallel_decode =
72 (ctx->init_flags & VPX_CODEC_USE_FRAME_THREADING);
73 priv->frame_parallel_decode = 0; // Disable for now
75 if (ctx->config.dec) {
76 priv->cfg = *ctx->config.dec;
77 ctx->config.dec = &priv->cfg;
84 static vpx_codec_err_t decoder_destroy(vpx_codec_alg_priv_t *ctx) {
86 vp9_decoder_remove(ctx->pbi);
95 static int parse_bitdepth_colorspace_sampling(
96 BITSTREAM_PROFILE profile, struct vp9_read_bit_buffer *rb) {
99 if (profile >= PROFILE_2)
100 rb->bit_offset += 1; // Bit-depth 10 or 12.
101 colorspace = vp9_rb_read_literal(rb, 3);
102 if (colorspace != sRGB) {
103 rb->bit_offset += 1; // [16,235] (including xvycc) vs [0,255] range.
104 if (profile == PROFILE_1 || profile == PROFILE_3) {
105 rb->bit_offset += 2; // subsampling x/y.
106 rb->bit_offset += 1; // unused.
109 if (profile == PROFILE_1 || profile == PROFILE_3) {
110 rb->bit_offset += 1; // unused
112 // RGB is only available in version 1.
119 static vpx_codec_err_t decoder_peek_si_internal(const uint8_t *data,
120 unsigned int data_sz,
121 vpx_codec_stream_info_t *si,
123 vpx_decrypt_cb decrypt_cb,
124 void *decrypt_state) {
125 int intra_only_flag = 0;
126 uint8_t clear_buffer[9];
128 if (data + data_sz <= data)
129 return VPX_CODEC_INVALID_PARAM;
135 data_sz = MIN(sizeof(clear_buffer), data_sz);
136 decrypt_cb(decrypt_state, data, clear_buffer, data_sz);
143 struct vp9_read_bit_buffer rb = { data, data + data_sz, 0, NULL, NULL };
144 const int frame_marker = vp9_rb_read_literal(&rb, 2);
145 const BITSTREAM_PROFILE profile = vp9_read_profile(&rb);
147 if (frame_marker != VP9_FRAME_MARKER)
148 return VPX_CODEC_UNSUP_BITSTREAM;
150 if (profile >= MAX_PROFILES) return VPX_CODEC_UNSUP_BITSTREAM;
152 if (vp9_rb_read_bit(&rb)) { // show an existing frame
153 vp9_rb_read_literal(&rb, 3); // Frame buffer to show.
158 return VPX_CODEC_UNSUP_BITSTREAM;
160 si->is_kf = !vp9_rb_read_bit(&rb);
161 show_frame = vp9_rb_read_bit(&rb);
162 error_resilient = vp9_rb_read_bit(&rb);
165 if (!vp9_read_sync_code(&rb))
166 return VPX_CODEC_UNSUP_BITSTREAM;
168 if (!parse_bitdepth_colorspace_sampling(profile, &rb))
169 return VPX_CODEC_UNSUP_BITSTREAM;
170 vp9_read_frame_size(&rb, (int *)&si->w, (int *)&si->h);
172 intra_only_flag = show_frame ? 0 : vp9_rb_read_bit(&rb);
174 rb.bit_offset += error_resilient ? 0 : 2; // reset_frame_context
176 if (intra_only_flag) {
177 if (!vp9_read_sync_code(&rb))
178 return VPX_CODEC_UNSUP_BITSTREAM;
179 if (profile > PROFILE_0) {
180 if (!parse_bitdepth_colorspace_sampling(profile, &rb))
181 return VPX_CODEC_UNSUP_BITSTREAM;
183 rb.bit_offset += REF_FRAMES; // refresh_frame_flags
184 vp9_read_frame_size(&rb, (int *)&si->w, (int *)&si->h);
188 if (is_intra_only != NULL)
189 *is_intra_only = intra_only_flag;
193 static vpx_codec_err_t decoder_peek_si(const uint8_t *data,
194 unsigned int data_sz,
195 vpx_codec_stream_info_t *si) {
196 return decoder_peek_si_internal(data, data_sz, si, NULL, NULL, NULL);
199 static vpx_codec_err_t decoder_get_si(vpx_codec_alg_priv_t *ctx,
200 vpx_codec_stream_info_t *si) {
201 const size_t sz = (si->sz >= sizeof(vp9_stream_info_t))
202 ? sizeof(vp9_stream_info_t)
203 : sizeof(vpx_codec_stream_info_t);
204 memcpy(si, &ctx->si, sz);
205 si->sz = (unsigned int)sz;
210 static vpx_codec_err_t update_error_state(vpx_codec_alg_priv_t *ctx,
211 const struct vpx_internal_error_info *error) {
212 if (error->error_code)
213 ctx->base.err_detail = error->has_detail ? error->detail : NULL;
215 return error->error_code;
218 static void init_buffer_callbacks(vpx_codec_alg_priv_t *ctx) {
219 VP9_COMMON *const cm = &ctx->pbi->common;
223 if (ctx->get_ext_fb_cb != NULL && ctx->release_ext_fb_cb != NULL) {
224 cm->get_fb_cb = ctx->get_ext_fb_cb;
225 cm->release_fb_cb = ctx->release_ext_fb_cb;
226 cm->cb_priv = ctx->ext_priv;
228 cm->get_fb_cb = vp9_get_frame_buffer;
229 cm->release_fb_cb = vp9_release_frame_buffer;
231 if (vp9_alloc_internal_frame_buffers(&cm->int_frame_buffers))
232 vpx_internal_error(&cm->error, VPX_CODEC_MEM_ERROR,
233 "Failed to initialize internal frame buffers");
235 cm->cb_priv = &cm->int_frame_buffers;
239 static void set_default_ppflags(vp8_postproc_cfg_t *cfg) {
240 cfg->post_proc_flag = VP8_DEBLOCK | VP8_DEMACROBLOCK;
241 cfg->deblocking_level = 4;
242 cfg->noise_level = 0;
245 static void set_ppflags(const vpx_codec_alg_priv_t *ctx,
246 vp9_ppflags_t *flags) {
247 flags->post_proc_flag =
248 ctx->postproc_cfg.post_proc_flag;
250 flags->deblocking_level = ctx->postproc_cfg.deblocking_level;
251 flags->noise_level = ctx->postproc_cfg.noise_level;
254 static void init_decoder(vpx_codec_alg_priv_t *ctx) {
255 ctx->pbi = vp9_decoder_create();
256 if (ctx->pbi == NULL)
259 ctx->pbi->max_threads = ctx->cfg.threads;
260 ctx->pbi->inv_tile_order = ctx->invert_tile_order;
261 ctx->pbi->frame_parallel_decode = ctx->frame_parallel_decode;
263 // If postprocessing was enabled by the application and a
264 // configuration has not been provided, default it.
265 if (!ctx->postproc_cfg_set &&
266 (ctx->base.init_flags & VPX_CODEC_USE_POSTPROC))
267 set_default_ppflags(&ctx->postproc_cfg);
269 init_buffer_callbacks(ctx);
272 static vpx_codec_err_t decode_one(vpx_codec_alg_priv_t *ctx,
273 const uint8_t **data, unsigned int data_sz,
274 void *user_priv, int64_t deadline) {
275 YV12_BUFFER_CONFIG sd;
276 vp9_ppflags_t flags = {0, 0, 0};
277 VP9_COMMON *cm = NULL;
284 // Determine the stream parameters. Note that we rely on peek_si to
285 // validate that we have a buffer that does not wrap around the top
288 int is_intra_only = 0;
289 const vpx_codec_err_t res =
290 decoder_peek_si_internal(*data, data_sz, &ctx->si, &is_intra_only,
291 ctx->decrypt_cb, ctx->decrypt_state);
292 if (res != VPX_CODEC_OK)
295 if (!ctx->si.is_kf && !is_intra_only)
296 return VPX_CODEC_ERROR;
299 // Initialize the decoder instance on the first frame
300 if (ctx->pbi == NULL) {
302 if (ctx->pbi == NULL)
303 return VPX_CODEC_ERROR;
306 // Set these even if already initialized. The caller may have changed the
307 // decrypt config between frames.
308 ctx->pbi->decrypt_cb = ctx->decrypt_cb;
309 ctx->pbi->decrypt_state = ctx->decrypt_state;
311 cm = &ctx->pbi->common;
313 if (vp9_receive_compressed_data(ctx->pbi, data_sz, data))
314 return update_error_state(ctx, &cm->error);
316 if (ctx->base.init_flags & VPX_CODEC_USE_POSTPROC)
317 set_ppflags(ctx, &flags);
319 if (vp9_get_raw_frame(ctx->pbi, &sd, &flags))
320 return update_error_state(ctx, &cm->error);
322 yuvconfig2image(&ctx->img, &sd, user_priv);
323 ctx->img.fb_priv = cm->frame_bufs[cm->new_fb_idx].raw_frame_buffer.priv;
329 static vpx_codec_err_t decoder_decode(vpx_codec_alg_priv_t *ctx,
330 const uint8_t *data, unsigned int data_sz,
331 void *user_priv, long deadline) {
332 const uint8_t *data_start = data;
333 const uint8_t * const data_end = data + data_sz;
335 uint32_t frame_sizes[8];
338 if (data == NULL && data_sz == 0) {
343 // Reset flushed when receiving a valid frame.
346 res = vp9_parse_superframe_index(data, data_sz, frame_sizes, &frame_count,
347 ctx->decrypt_cb, ctx->decrypt_state);
348 if (res != VPX_CODEC_OK)
351 if (ctx->frame_parallel_decode) {
352 // Decode in frame parallel mode. When decoding in this mode, the frame
353 // passed to the decoder must be either a normal frame or a superframe with
354 // superframe index so the decoder could get each frame's start position
355 // in the superframe.
356 if (frame_count > 0) {
359 for (i = 0; i < frame_count; ++i) {
360 const uint8_t *data_start_copy = data_start;
361 const uint32_t frame_size = frame_sizes[i];
363 if (data_start < data
364 || frame_size > (uint32_t) (data_end - data_start)) {
365 ctx->base.err_detail = "Invalid frame size in index";
366 return VPX_CODEC_CORRUPT_FRAME;
369 res = decode_one(ctx, &data_start_copy, frame_size, user_priv,
371 if (res != VPX_CODEC_OK)
374 data_start += frame_size;
377 res = decode_one(ctx, &data_start, data_sz, user_priv, deadline);
378 if (res != VPX_CODEC_OK)
381 // Extra data detected after the frame.
382 if (data_start < data_end - 1) {
383 ctx->base.err_detail = "Fail to decode frame in parallel mode";
384 return VPX_CODEC_INCAPABLE;
388 // Decode in serial mode.
389 if (frame_count > 0) {
392 for (i = 0; i < frame_count; ++i) {
393 const uint8_t *data_start_copy = data_start;
394 const uint32_t frame_size = frame_sizes[i];
396 if (data_start < data
397 || frame_size > (uint32_t) (data_end - data_start)) {
398 ctx->base.err_detail = "Invalid frame size in index";
399 return VPX_CODEC_CORRUPT_FRAME;
402 res = decode_one(ctx, &data_start_copy, frame_size, user_priv,
404 if (res != VPX_CODEC_OK)
407 data_start += frame_size;
410 while (data_start < data_end) {
411 const uint32_t frame_size = (uint32_t) (data_end - data_start);
412 const vpx_codec_err_t res = decode_one(ctx, &data_start, frame_size,
413 user_priv, deadline);
414 if (res != VPX_CODEC_OK)
417 // Account for suboptimal termination by the encoder.
418 while (data_start < data_end) {
419 const uint8_t marker = read_marker(ctx->decrypt_cb,
420 ctx->decrypt_state, data_start);
432 static vpx_image_t *decoder_get_frame(vpx_codec_alg_priv_t *ctx,
433 vpx_codec_iter_t *iter) {
434 vpx_image_t *img = NULL;
436 if (ctx->img_avail) {
437 // iter acts as a flip flop, so an image is only returned on the first
438 // call to get_frame.
449 static vpx_codec_err_t decoder_set_fb_fn(
450 vpx_codec_alg_priv_t *ctx,
451 vpx_get_frame_buffer_cb_fn_t cb_get,
452 vpx_release_frame_buffer_cb_fn_t cb_release, void *cb_priv) {
453 if (cb_get == NULL || cb_release == NULL) {
454 return VPX_CODEC_INVALID_PARAM;
455 } else if (ctx->pbi == NULL) {
456 // If the decoder has already been initialized, do not accept changes to
457 // the frame buffer functions.
458 ctx->get_ext_fb_cb = cb_get;
459 ctx->release_ext_fb_cb = cb_release;
460 ctx->ext_priv = cb_priv;
464 return VPX_CODEC_ERROR;
467 static vpx_codec_err_t ctrl_set_reference(vpx_codec_alg_priv_t *ctx,
469 vpx_ref_frame_t *const data = va_arg(args, vpx_ref_frame_t *);
472 vpx_ref_frame_t *const frame = (vpx_ref_frame_t *)data;
473 YV12_BUFFER_CONFIG sd;
475 image2yuvconfig(&frame->img, &sd);
476 return vp9_set_reference_dec(&ctx->pbi->common,
477 (VP9_REFFRAME)frame->frame_type, &sd);
479 return VPX_CODEC_INVALID_PARAM;
483 static vpx_codec_err_t ctrl_copy_reference(vpx_codec_alg_priv_t *ctx,
485 vpx_ref_frame_t *data = va_arg(args, vpx_ref_frame_t *);
488 vpx_ref_frame_t *frame = (vpx_ref_frame_t *)data;
489 YV12_BUFFER_CONFIG sd;
491 image2yuvconfig(&frame->img, &sd);
493 return vp9_copy_reference_dec(ctx->pbi,
494 (VP9_REFFRAME)frame->frame_type, &sd);
496 return VPX_CODEC_INVALID_PARAM;
500 static vpx_codec_err_t ctrl_get_reference(vpx_codec_alg_priv_t *ctx,
502 vp9_ref_frame_t *data = va_arg(args, vp9_ref_frame_t *);
505 YV12_BUFFER_CONFIG* fb = get_ref_frame(&ctx->pbi->common, data->idx);
506 if (fb == NULL) return VPX_CODEC_ERROR;
508 yuvconfig2image(&data->img, fb, NULL);
511 return VPX_CODEC_INVALID_PARAM;
515 static vpx_codec_err_t ctrl_set_postproc(vpx_codec_alg_priv_t *ctx,
517 #if CONFIG_VP9_POSTPROC
518 vp8_postproc_cfg_t *data = va_arg(args, vp8_postproc_cfg_t *);
521 ctx->postproc_cfg_set = 1;
522 ctx->postproc_cfg = *((vp8_postproc_cfg_t *)data);
525 return VPX_CODEC_INVALID_PARAM;
530 return VPX_CODEC_INCAPABLE;
534 static vpx_codec_err_t ctrl_set_dbg_options(vpx_codec_alg_priv_t *ctx,
538 return VPX_CODEC_INCAPABLE;
541 static vpx_codec_err_t ctrl_get_last_ref_updates(vpx_codec_alg_priv_t *ctx,
543 int *const update_info = va_arg(args, int *);
547 *update_info = ctx->pbi->refresh_frame_flags;
549 return VPX_CODEC_ERROR;
552 return VPX_CODEC_INVALID_PARAM;
557 static vpx_codec_err_t ctrl_get_frame_corrupted(vpx_codec_alg_priv_t *ctx,
559 int *corrupted = va_arg(args, int *);
561 if (corrupted != NULL && ctx->pbi != NULL) {
562 const YV12_BUFFER_CONFIG *const frame = ctx->pbi->common.frame_to_show;
563 if (frame == NULL) return VPX_CODEC_ERROR;
564 *corrupted = frame->corrupted;
567 return VPX_CODEC_INVALID_PARAM;
571 static vpx_codec_err_t ctrl_get_display_size(vpx_codec_alg_priv_t *ctx,
573 int *const display_size = va_arg(args, int *);
577 const VP9_COMMON *const cm = &ctx->pbi->common;
578 display_size[0] = cm->display_width;
579 display_size[1] = cm->display_height;
581 return VPX_CODEC_ERROR;
585 return VPX_CODEC_INVALID_PARAM;
589 static vpx_codec_err_t ctrl_get_bit_depth(vpx_codec_alg_priv_t *ctx,
591 unsigned int *const bit_depth = va_arg(args, unsigned int *);
595 const VP9_COMMON *const cm = &ctx->pbi->common;
596 *bit_depth = cm->bit_depth;
599 return VPX_CODEC_ERROR;
602 return VPX_CODEC_INVALID_PARAM;
606 static vpx_codec_err_t ctrl_set_invert_tile_order(vpx_codec_alg_priv_t *ctx,
608 ctx->invert_tile_order = va_arg(args, int);
612 static vpx_codec_err_t ctrl_set_decryptor(vpx_codec_alg_priv_t *ctx,
614 vpx_decrypt_init *init = va_arg(args, vpx_decrypt_init *);
615 ctx->decrypt_cb = init ? init->decrypt_cb : NULL;
616 ctx->decrypt_state = init ? init->decrypt_state : NULL;
620 static vpx_codec_ctrl_fn_map_t decoder_ctrl_maps[] = {
621 {VP8_COPY_REFERENCE, ctrl_copy_reference},
624 {VP8_SET_REFERENCE, ctrl_set_reference},
625 {VP8_SET_POSTPROC, ctrl_set_postproc},
626 {VP8_SET_DBG_COLOR_REF_FRAME, ctrl_set_dbg_options},
627 {VP8_SET_DBG_COLOR_MB_MODES, ctrl_set_dbg_options},
628 {VP8_SET_DBG_COLOR_B_MODES, ctrl_set_dbg_options},
629 {VP8_SET_DBG_DISPLAY_MV, ctrl_set_dbg_options},
630 {VP9_INVERT_TILE_DECODE_ORDER, ctrl_set_invert_tile_order},
631 {VPXD_SET_DECRYPTOR, ctrl_set_decryptor},
634 {VP8D_GET_LAST_REF_UPDATES, ctrl_get_last_ref_updates},
635 {VP8D_GET_FRAME_CORRUPTED, ctrl_get_frame_corrupted},
636 {VP9_GET_REFERENCE, ctrl_get_reference},
637 {VP9D_GET_DISPLAY_SIZE, ctrl_get_display_size},
638 {VP9D_GET_BIT_DEPTH, ctrl_get_bit_depth},
643 #ifndef VERSION_STRING
644 #define VERSION_STRING
646 CODEC_INTERFACE(vpx_codec_vp9_dx) = {
647 "WebM Project VP9 Decoder" VERSION_STRING,
648 VPX_CODEC_INTERNAL_ABI_VERSION,
649 VPX_CODEC_CAP_DECODER | VP9_CAP_POSTPROC |
650 VPX_CODEC_CAP_EXTERNAL_FRAME_BUFFER, // vpx_codec_caps_t
651 decoder_init, // vpx_codec_init_fn_t
652 decoder_destroy, // vpx_codec_destroy_fn_t
653 decoder_ctrl_maps, // vpx_codec_ctrl_fn_map_t
655 decoder_peek_si, // vpx_codec_peek_si_fn_t
656 decoder_get_si, // vpx_codec_get_si_fn_t
657 decoder_decode, // vpx_codec_decode_fn_t
658 decoder_get_frame, // vpx_codec_frame_get_fn_t
659 decoder_set_fb_fn, // vpx_codec_set_fb_fn_t
663 NULL, // vpx_codec_enc_cfg_map_t
664 NULL, // vpx_codec_encode_fn_t
665 NULL, // vpx_codec_get_cx_data_fn_t
666 NULL, // vpx_codec_enc_config_set_fn_t
667 NULL, // vpx_codec_get_global_headers_fn_t
668 NULL, // vpx_codec_get_preview_frame_fn_t
669 NULL // vpx_codec_enc_mr_get_mem_loc_fn_t