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 *const priv = vpx_calloc(1, sizeof(*priv));
63 return VPX_CODEC_MEM_ERROR;
65 ctx->priv = (vpx_codec_priv_t *)priv;
66 ctx->priv->init_flags = ctx->init_flags;
68 priv->si.sz = sizeof(priv->si);
70 priv->frame_parallel_decode =
71 (ctx->init_flags & VPX_CODEC_USE_FRAME_THREADING);
72 priv->frame_parallel_decode = 0; // Disable for now
74 if (ctx->config.dec) {
75 priv->cfg = *ctx->config.dec;
76 ctx->config.dec = &priv->cfg;
83 static vpx_codec_err_t decoder_destroy(vpx_codec_alg_priv_t *ctx) {
85 vp9_decoder_remove(ctx->pbi);
94 static int parse_bitdepth_colorspace_sampling(
95 BITSTREAM_PROFILE profile, struct vp9_read_bit_buffer *rb) {
98 if (profile >= PROFILE_2)
99 rb->bit_offset += 1; // Bit-depth 10 or 12.
100 colorspace = vp9_rb_read_literal(rb, 3);
101 if (colorspace != sRGB) {
102 rb->bit_offset += 1; // [16,235] (including xvycc) vs [0,255] range.
103 if (profile == PROFILE_1 || profile == PROFILE_3) {
104 rb->bit_offset += 2; // subsampling x/y.
105 rb->bit_offset += 1; // unused.
108 if (profile == PROFILE_1 || profile == PROFILE_3) {
109 rb->bit_offset += 1; // unused
111 // RGB is only available in version 1.
118 static vpx_codec_err_t decoder_peek_si_internal(const uint8_t *data,
119 unsigned int data_sz,
120 vpx_codec_stream_info_t *si,
122 vpx_decrypt_cb decrypt_cb,
123 void *decrypt_state) {
124 int intra_only_flag = 0;
125 uint8_t clear_buffer[9];
127 if (data + data_sz <= data)
128 return VPX_CODEC_INVALID_PARAM;
134 data_sz = MIN(sizeof(clear_buffer), data_sz);
135 decrypt_cb(decrypt_state, data, clear_buffer, data_sz);
142 struct vp9_read_bit_buffer rb = { data, data + data_sz, 0, NULL, NULL };
143 const int frame_marker = vp9_rb_read_literal(&rb, 2);
144 const BITSTREAM_PROFILE profile = vp9_read_profile(&rb);
146 if (frame_marker != VP9_FRAME_MARKER)
147 return VPX_CODEC_UNSUP_BITSTREAM;
149 if (profile >= MAX_PROFILES) return VPX_CODEC_UNSUP_BITSTREAM;
151 if (vp9_rb_read_bit(&rb)) { // show an existing frame
152 vp9_rb_read_literal(&rb, 3); // Frame buffer to show.
157 return VPX_CODEC_UNSUP_BITSTREAM;
159 si->is_kf = !vp9_rb_read_bit(&rb);
160 show_frame = vp9_rb_read_bit(&rb);
161 error_resilient = vp9_rb_read_bit(&rb);
164 if (!vp9_read_sync_code(&rb))
165 return VPX_CODEC_UNSUP_BITSTREAM;
167 if (!parse_bitdepth_colorspace_sampling(profile, &rb))
168 return VPX_CODEC_UNSUP_BITSTREAM;
169 vp9_read_frame_size(&rb, (int *)&si->w, (int *)&si->h);
171 intra_only_flag = show_frame ? 0 : vp9_rb_read_bit(&rb);
173 rb.bit_offset += error_resilient ? 0 : 2; // reset_frame_context
175 if (intra_only_flag) {
176 if (!vp9_read_sync_code(&rb))
177 return VPX_CODEC_UNSUP_BITSTREAM;
178 if (profile > PROFILE_0) {
179 if (!parse_bitdepth_colorspace_sampling(profile, &rb))
180 return VPX_CODEC_UNSUP_BITSTREAM;
182 rb.bit_offset += REF_FRAMES; // refresh_frame_flags
183 vp9_read_frame_size(&rb, (int *)&si->w, (int *)&si->h);
187 if (is_intra_only != NULL)
188 *is_intra_only = intra_only_flag;
192 static vpx_codec_err_t decoder_peek_si(const uint8_t *data,
193 unsigned int data_sz,
194 vpx_codec_stream_info_t *si) {
195 return decoder_peek_si_internal(data, data_sz, si, NULL, NULL, NULL);
198 static vpx_codec_err_t decoder_get_si(vpx_codec_alg_priv_t *ctx,
199 vpx_codec_stream_info_t *si) {
200 const size_t sz = (si->sz >= sizeof(vp9_stream_info_t))
201 ? sizeof(vp9_stream_info_t)
202 : sizeof(vpx_codec_stream_info_t);
203 memcpy(si, &ctx->si, sz);
204 si->sz = (unsigned int)sz;
209 static vpx_codec_err_t update_error_state(vpx_codec_alg_priv_t *ctx,
210 const struct vpx_internal_error_info *error) {
211 if (error->error_code)
212 ctx->base.err_detail = error->has_detail ? error->detail : NULL;
214 return error->error_code;
217 static void init_buffer_callbacks(vpx_codec_alg_priv_t *ctx) {
218 VP9_COMMON *const cm = &ctx->pbi->common;
222 if (ctx->get_ext_fb_cb != NULL && ctx->release_ext_fb_cb != NULL) {
223 cm->get_fb_cb = ctx->get_ext_fb_cb;
224 cm->release_fb_cb = ctx->release_ext_fb_cb;
225 cm->cb_priv = ctx->ext_priv;
227 cm->get_fb_cb = vp9_get_frame_buffer;
228 cm->release_fb_cb = vp9_release_frame_buffer;
230 if (vp9_alloc_internal_frame_buffers(&cm->int_frame_buffers))
231 vpx_internal_error(&cm->error, VPX_CODEC_MEM_ERROR,
232 "Failed to initialize internal frame buffers");
234 cm->cb_priv = &cm->int_frame_buffers;
238 static void set_default_ppflags(vp8_postproc_cfg_t *cfg) {
239 cfg->post_proc_flag = VP8_DEBLOCK | VP8_DEMACROBLOCK;
240 cfg->deblocking_level = 4;
241 cfg->noise_level = 0;
244 static void set_ppflags(const vpx_codec_alg_priv_t *ctx,
245 vp9_ppflags_t *flags) {
246 flags->post_proc_flag =
247 ctx->postproc_cfg.post_proc_flag;
249 flags->deblocking_level = ctx->postproc_cfg.deblocking_level;
250 flags->noise_level = ctx->postproc_cfg.noise_level;
253 static void init_decoder(vpx_codec_alg_priv_t *ctx) {
254 ctx->pbi = vp9_decoder_create();
255 if (ctx->pbi == NULL)
258 ctx->pbi->max_threads = ctx->cfg.threads;
259 ctx->pbi->inv_tile_order = ctx->invert_tile_order;
260 ctx->pbi->frame_parallel_decode = ctx->frame_parallel_decode;
262 // If postprocessing was enabled by the application and a
263 // configuration has not been provided, default it.
264 if (!ctx->postproc_cfg_set &&
265 (ctx->base.init_flags & VPX_CODEC_USE_POSTPROC))
266 set_default_ppflags(&ctx->postproc_cfg);
268 init_buffer_callbacks(ctx);
271 static vpx_codec_err_t decode_one(vpx_codec_alg_priv_t *ctx,
272 const uint8_t **data, unsigned int data_sz,
273 void *user_priv, int64_t deadline) {
274 YV12_BUFFER_CONFIG sd;
275 vp9_ppflags_t flags = {0, 0, 0};
276 VP9_COMMON *cm = NULL;
283 // Determine the stream parameters. Note that we rely on peek_si to
284 // validate that we have a buffer that does not wrap around the top
287 int is_intra_only = 0;
288 const vpx_codec_err_t res =
289 decoder_peek_si_internal(*data, data_sz, &ctx->si, &is_intra_only,
290 ctx->decrypt_cb, ctx->decrypt_state);
291 if (res != VPX_CODEC_OK)
294 if (!ctx->si.is_kf && !is_intra_only)
295 return VPX_CODEC_ERROR;
298 // Initialize the decoder instance on the first frame
299 if (ctx->pbi == NULL) {
301 if (ctx->pbi == NULL)
302 return VPX_CODEC_ERROR;
305 // Set these even if already initialized. The caller may have changed the
306 // decrypt config between frames.
307 ctx->pbi->decrypt_cb = ctx->decrypt_cb;
308 ctx->pbi->decrypt_state = ctx->decrypt_state;
310 cm = &ctx->pbi->common;
312 if (vp9_receive_compressed_data(ctx->pbi, data_sz, data))
313 return update_error_state(ctx, &cm->error);
315 if (ctx->base.init_flags & VPX_CODEC_USE_POSTPROC)
316 set_ppflags(ctx, &flags);
318 if (vp9_get_raw_frame(ctx->pbi, &sd, &flags))
319 return update_error_state(ctx, &cm->error);
321 yuvconfig2image(&ctx->img, &sd, user_priv);
322 ctx->img.fb_priv = cm->frame_bufs[cm->new_fb_idx].raw_frame_buffer.priv;
328 static vpx_codec_err_t decoder_decode(vpx_codec_alg_priv_t *ctx,
329 const uint8_t *data, unsigned int data_sz,
330 void *user_priv, long deadline) {
331 const uint8_t *data_start = data;
332 const uint8_t * const data_end = data + data_sz;
334 uint32_t frame_sizes[8];
337 if (data == NULL && data_sz == 0) {
342 // Reset flushed when receiving a valid frame.
345 res = vp9_parse_superframe_index(data, data_sz, frame_sizes, &frame_count,
346 ctx->decrypt_cb, ctx->decrypt_state);
347 if (res != VPX_CODEC_OK)
350 if (ctx->frame_parallel_decode) {
351 // Decode in frame parallel mode. When decoding in this mode, the frame
352 // passed to the decoder must be either a normal frame or a superframe with
353 // superframe index so the decoder could get each frame's start position
354 // in the superframe.
355 if (frame_count > 0) {
358 for (i = 0; i < frame_count; ++i) {
359 const uint8_t *data_start_copy = data_start;
360 const uint32_t frame_size = frame_sizes[i];
362 if (data_start < data
363 || frame_size > (uint32_t) (data_end - data_start)) {
364 ctx->base.err_detail = "Invalid frame size in index";
365 return VPX_CODEC_CORRUPT_FRAME;
368 res = decode_one(ctx, &data_start_copy, frame_size, user_priv,
370 if (res != VPX_CODEC_OK)
373 data_start += frame_size;
376 res = decode_one(ctx, &data_start, data_sz, user_priv, deadline);
377 if (res != VPX_CODEC_OK)
380 // Extra data detected after the frame.
381 if (data_start < data_end - 1) {
382 ctx->base.err_detail = "Fail to decode frame in parallel mode";
383 return VPX_CODEC_INCAPABLE;
387 // Decode in serial mode.
388 if (frame_count > 0) {
391 for (i = 0; i < frame_count; ++i) {
392 const uint8_t *data_start_copy = data_start;
393 const uint32_t frame_size = frame_sizes[i];
395 if (data_start < data
396 || frame_size > (uint32_t) (data_end - data_start)) {
397 ctx->base.err_detail = "Invalid frame size in index";
398 return VPX_CODEC_CORRUPT_FRAME;
401 res = decode_one(ctx, &data_start_copy, frame_size, user_priv,
403 if (res != VPX_CODEC_OK)
406 data_start += frame_size;
409 while (data_start < data_end) {
410 const uint32_t frame_size = (uint32_t) (data_end - data_start);
411 const vpx_codec_err_t res = decode_one(ctx, &data_start, frame_size,
412 user_priv, deadline);
413 if (res != VPX_CODEC_OK)
416 // Account for suboptimal termination by the encoder.
417 while (data_start < data_end) {
418 const uint8_t marker = read_marker(ctx->decrypt_cb,
419 ctx->decrypt_state, data_start);
431 static vpx_image_t *decoder_get_frame(vpx_codec_alg_priv_t *ctx,
432 vpx_codec_iter_t *iter) {
433 vpx_image_t *img = NULL;
435 if (ctx->img_avail) {
436 // iter acts as a flip flop, so an image is only returned on the first
437 // call to get_frame.
448 static vpx_codec_err_t decoder_set_fb_fn(
449 vpx_codec_alg_priv_t *ctx,
450 vpx_get_frame_buffer_cb_fn_t cb_get,
451 vpx_release_frame_buffer_cb_fn_t cb_release, void *cb_priv) {
452 if (cb_get == NULL || cb_release == NULL) {
453 return VPX_CODEC_INVALID_PARAM;
454 } else if (ctx->pbi == NULL) {
455 // If the decoder has already been initialized, do not accept changes to
456 // the frame buffer functions.
457 ctx->get_ext_fb_cb = cb_get;
458 ctx->release_ext_fb_cb = cb_release;
459 ctx->ext_priv = cb_priv;
463 return VPX_CODEC_ERROR;
466 static vpx_codec_err_t ctrl_set_reference(vpx_codec_alg_priv_t *ctx,
468 vpx_ref_frame_t *const data = va_arg(args, vpx_ref_frame_t *);
471 vpx_ref_frame_t *const frame = (vpx_ref_frame_t *)data;
472 YV12_BUFFER_CONFIG sd;
474 image2yuvconfig(&frame->img, &sd);
475 return vp9_set_reference_dec(&ctx->pbi->common,
476 (VP9_REFFRAME)frame->frame_type, &sd);
478 return VPX_CODEC_INVALID_PARAM;
482 static vpx_codec_err_t ctrl_copy_reference(vpx_codec_alg_priv_t *ctx,
484 vpx_ref_frame_t *data = va_arg(args, vpx_ref_frame_t *);
487 vpx_ref_frame_t *frame = (vpx_ref_frame_t *)data;
488 YV12_BUFFER_CONFIG sd;
490 image2yuvconfig(&frame->img, &sd);
492 return vp9_copy_reference_dec(ctx->pbi,
493 (VP9_REFFRAME)frame->frame_type, &sd);
495 return VPX_CODEC_INVALID_PARAM;
499 static vpx_codec_err_t ctrl_get_reference(vpx_codec_alg_priv_t *ctx,
501 vp9_ref_frame_t *data = va_arg(args, vp9_ref_frame_t *);
504 YV12_BUFFER_CONFIG* fb = get_ref_frame(&ctx->pbi->common, data->idx);
505 if (fb == NULL) return VPX_CODEC_ERROR;
507 yuvconfig2image(&data->img, fb, NULL);
510 return VPX_CODEC_INVALID_PARAM;
514 static vpx_codec_err_t ctrl_set_postproc(vpx_codec_alg_priv_t *ctx,
516 #if CONFIG_VP9_POSTPROC
517 vp8_postproc_cfg_t *data = va_arg(args, vp8_postproc_cfg_t *);
520 ctx->postproc_cfg_set = 1;
521 ctx->postproc_cfg = *((vp8_postproc_cfg_t *)data);
524 return VPX_CODEC_INVALID_PARAM;
529 return VPX_CODEC_INCAPABLE;
533 static vpx_codec_err_t ctrl_set_dbg_options(vpx_codec_alg_priv_t *ctx,
537 return VPX_CODEC_INCAPABLE;
540 static vpx_codec_err_t ctrl_get_last_ref_updates(vpx_codec_alg_priv_t *ctx,
542 int *const update_info = va_arg(args, int *);
546 *update_info = ctx->pbi->refresh_frame_flags;
548 return VPX_CODEC_ERROR;
551 return VPX_CODEC_INVALID_PARAM;
556 static vpx_codec_err_t ctrl_get_frame_corrupted(vpx_codec_alg_priv_t *ctx,
558 int *corrupted = va_arg(args, int *);
560 if (corrupted != NULL && ctx->pbi != NULL) {
561 const YV12_BUFFER_CONFIG *const frame = ctx->pbi->common.frame_to_show;
562 if (frame == NULL) return VPX_CODEC_ERROR;
563 *corrupted = frame->corrupted;
566 return VPX_CODEC_INVALID_PARAM;
570 static vpx_codec_err_t ctrl_get_display_size(vpx_codec_alg_priv_t *ctx,
572 int *const display_size = va_arg(args, int *);
576 const VP9_COMMON *const cm = &ctx->pbi->common;
577 display_size[0] = cm->display_width;
578 display_size[1] = cm->display_height;
580 return VPX_CODEC_ERROR;
584 return VPX_CODEC_INVALID_PARAM;
588 static vpx_codec_err_t ctrl_get_bit_depth(vpx_codec_alg_priv_t *ctx,
590 unsigned int *const bit_depth = va_arg(args, unsigned int *);
594 const VP9_COMMON *const cm = &ctx->pbi->common;
595 *bit_depth = cm->bit_depth;
598 return VPX_CODEC_ERROR;
601 return VPX_CODEC_INVALID_PARAM;
605 static vpx_codec_err_t ctrl_set_invert_tile_order(vpx_codec_alg_priv_t *ctx,
607 ctx->invert_tile_order = va_arg(args, int);
611 static vpx_codec_err_t ctrl_set_decryptor(vpx_codec_alg_priv_t *ctx,
613 vpx_decrypt_init *init = va_arg(args, vpx_decrypt_init *);
614 ctx->decrypt_cb = init ? init->decrypt_cb : NULL;
615 ctx->decrypt_state = init ? init->decrypt_state : NULL;
619 static vpx_codec_ctrl_fn_map_t decoder_ctrl_maps[] = {
620 {VP8_COPY_REFERENCE, ctrl_copy_reference},
623 {VP8_SET_REFERENCE, ctrl_set_reference},
624 {VP8_SET_POSTPROC, ctrl_set_postproc},
625 {VP8_SET_DBG_COLOR_REF_FRAME, ctrl_set_dbg_options},
626 {VP8_SET_DBG_COLOR_MB_MODES, ctrl_set_dbg_options},
627 {VP8_SET_DBG_COLOR_B_MODES, ctrl_set_dbg_options},
628 {VP8_SET_DBG_DISPLAY_MV, ctrl_set_dbg_options},
629 {VP9_INVERT_TILE_DECODE_ORDER, ctrl_set_invert_tile_order},
630 {VPXD_SET_DECRYPTOR, ctrl_set_decryptor},
633 {VP8D_GET_LAST_REF_UPDATES, ctrl_get_last_ref_updates},
634 {VP8D_GET_FRAME_CORRUPTED, ctrl_get_frame_corrupted},
635 {VP9_GET_REFERENCE, ctrl_get_reference},
636 {VP9D_GET_DISPLAY_SIZE, ctrl_get_display_size},
637 {VP9D_GET_BIT_DEPTH, ctrl_get_bit_depth},
642 #ifndef VERSION_STRING
643 #define VERSION_STRING
645 CODEC_INTERFACE(vpx_codec_vp9_dx) = {
646 "WebM Project VP9 Decoder" VERSION_STRING,
647 VPX_CODEC_INTERNAL_ABI_VERSION,
648 VPX_CODEC_CAP_DECODER | VP9_CAP_POSTPROC |
649 VPX_CODEC_CAP_EXTERNAL_FRAME_BUFFER, // vpx_codec_caps_t
650 decoder_init, // vpx_codec_init_fn_t
651 decoder_destroy, // vpx_codec_destroy_fn_t
652 decoder_ctrl_maps, // vpx_codec_ctrl_fn_map_t
654 decoder_peek_si, // vpx_codec_peek_si_fn_t
655 decoder_get_si, // vpx_codec_get_si_fn_t
656 decoder_decode, // vpx_codec_decode_fn_t
657 decoder_get_frame, // vpx_codec_frame_get_fn_t
658 decoder_set_fb_fn, // vpx_codec_set_fb_fn_t
662 NULL, // vpx_codec_enc_cfg_map_t
663 NULL, // vpx_codec_encode_fn_t
664 NULL, // vpx_codec_get_cx_data_fn_t
665 NULL, // vpx_codec_enc_config_set_fn_t
666 NULL, // vpx_codec_get_global_headers_fn_t
667 NULL, // vpx_codec_get_preview_frame_fn_t
668 NULL // vpx_codec_enc_mr_get_mem_loc_fn_t