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) return VPX_CODEC_UNSUP_BITSTREAM;
153 if (vp9_rb_read_bit(&rb)) { // show an existing frame
154 vp9_rb_read_literal(&rb, 3); // Frame buffer to show.
159 return VPX_CODEC_UNSUP_BITSTREAM;
161 si->is_kf = !vp9_rb_read_bit(&rb);
162 show_frame = vp9_rb_read_bit(&rb);
163 error_resilient = vp9_rb_read_bit(&rb);
166 if (!vp9_read_sync_code(&rb))
167 return VPX_CODEC_UNSUP_BITSTREAM;
169 if (!parse_bitdepth_colorspace_sampling(profile, &rb))
170 return VPX_CODEC_UNSUP_BITSTREAM;
171 vp9_read_frame_size(&rb, (int *)&si->w, (int *)&si->h);
173 intra_only_flag = show_frame ? 0 : vp9_rb_read_bit(&rb);
175 rb.bit_offset += error_resilient ? 0 : 2; // reset_frame_context
177 if (intra_only_flag) {
178 if (!vp9_read_sync_code(&rb))
179 return VPX_CODEC_UNSUP_BITSTREAM;
180 if (profile > PROFILE_0) {
181 if (!parse_bitdepth_colorspace_sampling(profile, &rb))
182 return VPX_CODEC_UNSUP_BITSTREAM;
184 rb.bit_offset += REF_FRAMES; // refresh_frame_flags
185 vp9_read_frame_size(&rb, (int *)&si->w, (int *)&si->h);
189 if (is_intra_only != NULL)
190 *is_intra_only = intra_only_flag;
194 static vpx_codec_err_t decoder_peek_si(const uint8_t *data,
195 unsigned int data_sz,
196 vpx_codec_stream_info_t *si) {
197 return decoder_peek_si_internal(data, data_sz, si, NULL, NULL, NULL);
200 static vpx_codec_err_t decoder_get_si(vpx_codec_alg_priv_t *ctx,
201 vpx_codec_stream_info_t *si) {
202 const size_t sz = (si->sz >= sizeof(vp9_stream_info_t))
203 ? sizeof(vp9_stream_info_t)
204 : sizeof(vpx_codec_stream_info_t);
205 memcpy(si, &ctx->si, sz);
206 si->sz = (unsigned int)sz;
211 static vpx_codec_err_t update_error_state(vpx_codec_alg_priv_t *ctx,
212 const struct vpx_internal_error_info *error) {
213 if (error->error_code)
214 ctx->base.err_detail = error->has_detail ? error->detail : NULL;
216 return error->error_code;
219 static void init_buffer_callbacks(vpx_codec_alg_priv_t *ctx) {
220 VP9_COMMON *const cm = &ctx->pbi->common;
223 cm->byte_alignment = ctx->byte_alignment;
225 if (ctx->get_ext_fb_cb != NULL && ctx->release_ext_fb_cb != NULL) {
226 cm->get_fb_cb = ctx->get_ext_fb_cb;
227 cm->release_fb_cb = ctx->release_ext_fb_cb;
228 cm->cb_priv = ctx->ext_priv;
230 cm->get_fb_cb = vp9_get_frame_buffer;
231 cm->release_fb_cb = vp9_release_frame_buffer;
233 if (vp9_alloc_internal_frame_buffers(&cm->int_frame_buffers))
234 vpx_internal_error(&cm->error, VPX_CODEC_MEM_ERROR,
235 "Failed to initialize internal frame buffers");
237 cm->cb_priv = &cm->int_frame_buffers;
241 static void set_default_ppflags(vp8_postproc_cfg_t *cfg) {
242 cfg->post_proc_flag = VP8_DEBLOCK | VP8_DEMACROBLOCK;
243 cfg->deblocking_level = 4;
244 cfg->noise_level = 0;
247 static void set_ppflags(const vpx_codec_alg_priv_t *ctx,
248 vp9_ppflags_t *flags) {
249 flags->post_proc_flag =
250 ctx->postproc_cfg.post_proc_flag;
252 flags->deblocking_level = ctx->postproc_cfg.deblocking_level;
253 flags->noise_level = ctx->postproc_cfg.noise_level;
256 static void init_decoder(vpx_codec_alg_priv_t *ctx) {
257 ctx->pbi = vp9_decoder_create();
258 if (ctx->pbi == NULL)
261 ctx->pbi->max_threads = ctx->cfg.threads;
262 ctx->pbi->inv_tile_order = ctx->invert_tile_order;
263 ctx->pbi->frame_parallel_decode = ctx->frame_parallel_decode;
265 // If postprocessing was enabled by the application and a
266 // configuration has not been provided, default it.
267 if (!ctx->postproc_cfg_set &&
268 (ctx->base.init_flags & VPX_CODEC_USE_POSTPROC))
269 set_default_ppflags(&ctx->postproc_cfg);
271 init_buffer_callbacks(ctx);
274 static vpx_codec_err_t decode_one(vpx_codec_alg_priv_t *ctx,
275 const uint8_t **data, unsigned int data_sz,
276 void *user_priv, int64_t deadline) {
277 YV12_BUFFER_CONFIG sd;
278 vp9_ppflags_t flags = {0, 0, 0};
279 VP9_COMMON *cm = NULL;
286 // Determine the stream parameters. Note that we rely on peek_si to
287 // validate that we have a buffer that does not wrap around the top
290 int is_intra_only = 0;
291 const vpx_codec_err_t res =
292 decoder_peek_si_internal(*data, data_sz, &ctx->si, &is_intra_only,
293 ctx->decrypt_cb, ctx->decrypt_state);
294 if (res != VPX_CODEC_OK)
297 if (!ctx->si.is_kf && !is_intra_only)
298 return VPX_CODEC_ERROR;
301 // Initialize the decoder instance on the first frame
302 if (ctx->pbi == NULL) {
304 if (ctx->pbi == NULL)
305 return VPX_CODEC_ERROR;
308 // Set these even if already initialized. The caller may have changed the
309 // decrypt config between frames.
310 ctx->pbi->decrypt_cb = ctx->decrypt_cb;
311 ctx->pbi->decrypt_state = ctx->decrypt_state;
313 cm = &ctx->pbi->common;
315 if (vp9_receive_compressed_data(ctx->pbi, data_sz, data))
316 return update_error_state(ctx, &cm->error);
318 if (ctx->base.init_flags & VPX_CODEC_USE_POSTPROC)
319 set_ppflags(ctx, &flags);
321 if (vp9_get_raw_frame(ctx->pbi, &sd, &flags))
322 return update_error_state(ctx, &cm->error);
324 yuvconfig2image(&ctx->img, &sd, user_priv);
325 ctx->img.fb_priv = cm->frame_bufs[cm->new_fb_idx].raw_frame_buffer.priv;
331 static vpx_codec_err_t decoder_decode(vpx_codec_alg_priv_t *ctx,
332 const uint8_t *data, unsigned int data_sz,
333 void *user_priv, long deadline) {
334 const uint8_t *data_start = data;
335 const uint8_t * const data_end = data + data_sz;
337 uint32_t frame_sizes[8];
340 if (data == NULL && data_sz == 0) {
345 // Reset flushed when receiving a valid frame.
348 res = vp9_parse_superframe_index(data, data_sz, frame_sizes, &frame_count,
349 ctx->decrypt_cb, ctx->decrypt_state);
350 if (res != VPX_CODEC_OK)
353 if (ctx->frame_parallel_decode) {
354 // Decode in frame parallel mode. When decoding in this mode, the frame
355 // passed to the decoder must be either a normal frame or a superframe with
356 // superframe index so the decoder could get each frame's start position
357 // in the superframe.
358 if (frame_count > 0) {
361 for (i = 0; i < frame_count; ++i) {
362 const uint8_t *data_start_copy = data_start;
363 const uint32_t frame_size = frame_sizes[i];
365 if (data_start < data
366 || frame_size > (uint32_t) (data_end - data_start)) {
367 ctx->base.err_detail = "Invalid frame size in index";
368 return VPX_CODEC_CORRUPT_FRAME;
371 res = decode_one(ctx, &data_start_copy, frame_size, user_priv,
373 if (res != VPX_CODEC_OK)
376 data_start += frame_size;
379 res = decode_one(ctx, &data_start, data_sz, user_priv, deadline);
380 if (res != VPX_CODEC_OK)
383 // Extra data detected after the frame.
384 if (data_start < data_end - 1) {
385 ctx->base.err_detail = "Fail to decode frame in parallel mode";
386 return VPX_CODEC_INCAPABLE;
390 // Decode in serial mode.
391 if (frame_count > 0) {
394 for (i = 0; i < frame_count; ++i) {
395 const uint8_t *data_start_copy = data_start;
396 const uint32_t frame_size = frame_sizes[i];
398 if (data_start < data
399 || frame_size > (uint32_t) (data_end - data_start)) {
400 ctx->base.err_detail = "Invalid frame size in index";
401 return VPX_CODEC_CORRUPT_FRAME;
404 res = decode_one(ctx, &data_start_copy, frame_size, user_priv,
406 if (res != VPX_CODEC_OK)
409 data_start += frame_size;
412 while (data_start < data_end) {
413 const uint32_t frame_size = (uint32_t) (data_end - data_start);
414 const vpx_codec_err_t res = decode_one(ctx, &data_start, frame_size,
415 user_priv, deadline);
416 if (res != VPX_CODEC_OK)
419 // Account for suboptimal termination by the encoder.
420 while (data_start < data_end) {
421 const uint8_t marker = read_marker(ctx->decrypt_cb,
422 ctx->decrypt_state, data_start);
434 static vpx_image_t *decoder_get_frame(vpx_codec_alg_priv_t *ctx,
435 vpx_codec_iter_t *iter) {
436 vpx_image_t *img = NULL;
438 if (ctx->img_avail) {
439 // iter acts as a flip flop, so an image is only returned on the first
440 // call to get_frame.
451 static vpx_codec_err_t decoder_set_fb_fn(
452 vpx_codec_alg_priv_t *ctx,
453 vpx_get_frame_buffer_cb_fn_t cb_get,
454 vpx_release_frame_buffer_cb_fn_t cb_release, void *cb_priv) {
455 if (cb_get == NULL || cb_release == NULL) {
456 return VPX_CODEC_INVALID_PARAM;
457 } else if (ctx->pbi == NULL) {
458 // If the decoder has already been initialized, do not accept changes to
459 // the frame buffer functions.
460 ctx->get_ext_fb_cb = cb_get;
461 ctx->release_ext_fb_cb = cb_release;
462 ctx->ext_priv = cb_priv;
466 return VPX_CODEC_ERROR;
469 static vpx_codec_err_t ctrl_set_reference(vpx_codec_alg_priv_t *ctx,
471 vpx_ref_frame_t *const data = va_arg(args, vpx_ref_frame_t *);
474 vpx_ref_frame_t *const frame = (vpx_ref_frame_t *)data;
475 YV12_BUFFER_CONFIG sd;
477 image2yuvconfig(&frame->img, &sd);
478 return vp9_set_reference_dec(&ctx->pbi->common,
479 (VP9_REFFRAME)frame->frame_type, &sd);
481 return VPX_CODEC_INVALID_PARAM;
485 static vpx_codec_err_t ctrl_copy_reference(vpx_codec_alg_priv_t *ctx,
487 vpx_ref_frame_t *data = va_arg(args, vpx_ref_frame_t *);
490 vpx_ref_frame_t *frame = (vpx_ref_frame_t *)data;
491 YV12_BUFFER_CONFIG sd;
493 image2yuvconfig(&frame->img, &sd);
495 return vp9_copy_reference_dec(ctx->pbi,
496 (VP9_REFFRAME)frame->frame_type, &sd);
498 return VPX_CODEC_INVALID_PARAM;
502 static vpx_codec_err_t ctrl_get_reference(vpx_codec_alg_priv_t *ctx,
504 vp9_ref_frame_t *data = va_arg(args, vp9_ref_frame_t *);
507 YV12_BUFFER_CONFIG* fb = get_ref_frame(&ctx->pbi->common, data->idx);
508 if (fb == NULL) return VPX_CODEC_ERROR;
510 yuvconfig2image(&data->img, fb, NULL);
513 return VPX_CODEC_INVALID_PARAM;
517 static vpx_codec_err_t ctrl_set_postproc(vpx_codec_alg_priv_t *ctx,
519 #if CONFIG_VP9_POSTPROC
520 vp8_postproc_cfg_t *data = va_arg(args, vp8_postproc_cfg_t *);
523 ctx->postproc_cfg_set = 1;
524 ctx->postproc_cfg = *((vp8_postproc_cfg_t *)data);
527 return VPX_CODEC_INVALID_PARAM;
532 return VPX_CODEC_INCAPABLE;
536 static vpx_codec_err_t ctrl_set_dbg_options(vpx_codec_alg_priv_t *ctx,
540 return VPX_CODEC_INCAPABLE;
543 static vpx_codec_err_t ctrl_get_last_ref_updates(vpx_codec_alg_priv_t *ctx,
545 int *const update_info = va_arg(args, int *);
549 *update_info = ctx->pbi->refresh_frame_flags;
551 return VPX_CODEC_ERROR;
554 return VPX_CODEC_INVALID_PARAM;
559 static vpx_codec_err_t ctrl_get_frame_corrupted(vpx_codec_alg_priv_t *ctx,
561 int *corrupted = va_arg(args, int *);
563 if (corrupted != NULL && ctx->pbi != NULL) {
564 const YV12_BUFFER_CONFIG *const frame = ctx->pbi->common.frame_to_show;
565 if (frame == NULL) return VPX_CODEC_ERROR;
566 *corrupted = frame->corrupted;
569 return VPX_CODEC_INVALID_PARAM;
573 static vpx_codec_err_t ctrl_get_display_size(vpx_codec_alg_priv_t *ctx,
575 int *const display_size = va_arg(args, int *);
579 const VP9_COMMON *const cm = &ctx->pbi->common;
580 display_size[0] = cm->display_width;
581 display_size[1] = cm->display_height;
583 return VPX_CODEC_ERROR;
587 return VPX_CODEC_INVALID_PARAM;
591 static vpx_codec_err_t ctrl_get_bit_depth(vpx_codec_alg_priv_t *ctx,
593 unsigned int *const bit_depth = va_arg(args, unsigned int *);
597 const VP9_COMMON *const cm = &ctx->pbi->common;
598 *bit_depth = cm->bit_depth;
601 return VPX_CODEC_ERROR;
604 return VPX_CODEC_INVALID_PARAM;
608 static vpx_codec_err_t ctrl_set_invert_tile_order(vpx_codec_alg_priv_t *ctx,
610 ctx->invert_tile_order = va_arg(args, int);
614 static vpx_codec_err_t ctrl_set_decryptor(vpx_codec_alg_priv_t *ctx,
616 vpx_decrypt_init *init = va_arg(args, vpx_decrypt_init *);
617 ctx->decrypt_cb = init ? init->decrypt_cb : NULL;
618 ctx->decrypt_state = init ? init->decrypt_state : NULL;
622 static vpx_codec_err_t ctrl_set_byte_alignment(vpx_codec_alg_priv_t *ctx,
624 const int legacy_byte_alignment = 0;
625 const int min_byte_alignment = 32;
626 const int max_byte_alignment = 1024;
627 const int byte_alignment = va_arg(args, int);
629 if (byte_alignment != legacy_byte_alignment &&
630 (byte_alignment < min_byte_alignment ||
631 byte_alignment > max_byte_alignment ||
632 (byte_alignment & (byte_alignment - 1)) != 0))
633 return VPX_CODEC_INVALID_PARAM;
635 ctx->byte_alignment = byte_alignment;
636 if (ctx->pbi != NULL) {
637 VP9_COMMON *const cm = &ctx->pbi->common;
638 cm->byte_alignment = byte_alignment;
643 static vpx_codec_ctrl_fn_map_t decoder_ctrl_maps[] = {
644 {VP8_COPY_REFERENCE, ctrl_copy_reference},
647 {VP8_SET_REFERENCE, ctrl_set_reference},
648 {VP8_SET_POSTPROC, ctrl_set_postproc},
649 {VP8_SET_DBG_COLOR_REF_FRAME, ctrl_set_dbg_options},
650 {VP8_SET_DBG_COLOR_MB_MODES, ctrl_set_dbg_options},
651 {VP8_SET_DBG_COLOR_B_MODES, ctrl_set_dbg_options},
652 {VP8_SET_DBG_DISPLAY_MV, ctrl_set_dbg_options},
653 {VP9_INVERT_TILE_DECODE_ORDER, ctrl_set_invert_tile_order},
654 {VPXD_SET_DECRYPTOR, ctrl_set_decryptor},
655 {VP9_SET_BYTE_ALIGNMENT, ctrl_set_byte_alignment},
658 {VP8D_GET_LAST_REF_UPDATES, ctrl_get_last_ref_updates},
659 {VP8D_GET_FRAME_CORRUPTED, ctrl_get_frame_corrupted},
660 {VP9_GET_REFERENCE, ctrl_get_reference},
661 {VP9D_GET_DISPLAY_SIZE, ctrl_get_display_size},
662 {VP9D_GET_BIT_DEPTH, ctrl_get_bit_depth},
667 #ifndef VERSION_STRING
668 #define VERSION_STRING
670 CODEC_INTERFACE(vpx_codec_vp9_dx) = {
671 "WebM Project VP9 Decoder" VERSION_STRING,
672 VPX_CODEC_INTERNAL_ABI_VERSION,
673 VPX_CODEC_CAP_DECODER | VP9_CAP_POSTPROC |
674 VPX_CODEC_CAP_EXTERNAL_FRAME_BUFFER, // vpx_codec_caps_t
675 decoder_init, // vpx_codec_init_fn_t
676 decoder_destroy, // vpx_codec_destroy_fn_t
677 decoder_ctrl_maps, // vpx_codec_ctrl_fn_map_t
679 decoder_peek_si, // vpx_codec_peek_si_fn_t
680 decoder_get_si, // vpx_codec_get_si_fn_t
681 decoder_decode, // vpx_codec_decode_fn_t
682 decoder_get_frame, // vpx_codec_frame_get_fn_t
683 decoder_set_fb_fn, // vpx_codec_set_fb_fn_t
687 NULL, // vpx_codec_enc_cfg_map_t
688 NULL, // vpx_codec_encode_fn_t
689 NULL, // vpx_codec_get_cx_data_fn_t
690 NULL, // vpx_codec_enc_config_set_fn_t
691 NULL, // vpx_codec_get_global_headers_fn_t
692 NULL, // vpx_codec_get_preview_frame_fn_t
693 NULL // vpx_codec_enc_mr_get_mem_loc_fn_t