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 "./vp8_rtcd.h"
15 #include "./vpx_dsp_rtcd.h"
16 #include "./vpx_scale_rtcd.h"
17 #include "vpx/vpx_decoder.h"
18 #include "vpx/vp8dx.h"
19 #include "vpx/internal/vpx_codec_internal.h"
20 #include "vpx_version.h"
21 #include "common/alloccommon.h"
22 #include "common/common.h"
23 #include "common/onyxd.h"
24 #include "decoder/onyxd_int.h"
25 #include "vpx_dsp/vpx_dsp_common.h"
26 #include "vpx_mem/vpx_mem.h"
27 #include "vpx_ports/system_state.h"
28 #if CONFIG_ERROR_CONCEALMENT
29 #include "decoder/error_concealment.h"
31 #include "decoder/decoderthreading.h"
33 #define VP8_CAP_POSTPROC (CONFIG_POSTPROC ? VPX_CODEC_CAP_POSTPROC : 0)
34 #define VP8_CAP_ERROR_CONCEALMENT \
35 (CONFIG_ERROR_CONCEALMENT ? VPX_CODEC_CAP_ERROR_CONCEALMENT : 0)
37 typedef vpx_codec_stream_info_t vp8_stream_info_t;
39 /* Structures for handling memory allocations */
40 typedef enum { VP8_SEG_ALG_PRIV = 256, VP8_SEG_MAX } mem_seg_id_t;
41 #define NELEMENTS(x) ((int)(sizeof(x) / sizeof(x[0])))
43 struct vpx_codec_alg_priv {
44 vpx_codec_priv_t base;
45 vpx_codec_dec_cfg_t cfg;
49 vp8_postproc_cfg_t postproc_cfg;
50 vpx_decrypt_cb decrypt_cb;
54 struct frame_buffers yv12_frame_buffers;
56 FRAGMENT_DATA fragments;
59 static int vp8_init_ctx(vpx_codec_ctx_t *ctx) {
60 vpx_codec_alg_priv_t *priv =
61 (vpx_codec_alg_priv_t *)vpx_calloc(1, sizeof(*priv));
64 ctx->priv = (vpx_codec_priv_t *)priv;
65 ctx->priv->init_flags = ctx->init_flags;
67 priv->si.sz = sizeof(priv->si);
68 priv->decrypt_cb = NULL;
69 priv->decrypt_state = NULL;
71 if (ctx->config.dec) {
72 /* Update the reference to the config structure to an internal copy. */
73 priv->cfg = *ctx->config.dec;
74 ctx->config.dec = &priv->cfg;
80 static vpx_codec_err_t vp8_init(vpx_codec_ctx_t *ctx,
81 vpx_codec_priv_enc_mr_cfg_t *data) {
82 vpx_codec_err_t res = VPX_CODEC_OK;
83 vpx_codec_alg_priv_t *priv = NULL;
90 /* This function only allocates space for the vpx_codec_alg_priv_t
91 * structure. More memory may be required at the time the stream
92 * information becomes known.
95 if (vp8_init_ctx(ctx)) return VPX_CODEC_MEM_ERROR;
96 priv = (vpx_codec_alg_priv_t *)ctx->priv;
98 /* initialize number of fragments to zero */
99 priv->fragments.count = 0;
100 /* is input fragments enabled? */
101 priv->fragments.enabled =
102 (priv->base.init_flags & VPX_CODEC_USE_INPUT_FRAGMENTS);
104 /*post processing level initialized to do nothing */
106 priv = (vpx_codec_alg_priv_t *)ctx->priv;
112 static vpx_codec_err_t vp8_destroy(vpx_codec_alg_priv_t *ctx) {
113 vp8_remove_decoder_instances(&ctx->yv12_frame_buffers);
120 static vpx_codec_err_t vp8_peek_si_internal(const uint8_t *data,
121 unsigned int data_sz,
122 vpx_codec_stream_info_t *si,
123 vpx_decrypt_cb decrypt_cb,
124 void *decrypt_state) {
125 vpx_codec_err_t res = VPX_CODEC_OK;
127 assert(data != NULL);
129 if (data + data_sz <= data) {
130 res = VPX_CODEC_INVALID_PARAM;
132 /* Parse uncompresssed part of key frame header.
133 * 3 bytes:- including version, frame type and an offset
134 * 3 bytes:- sync code (0x9d, 0x01, 0x2a)
135 * 4 bytes:- including image width and height in the lowest 14 bits
136 * of each 2-byte value.
138 uint8_t clear_buffer[10];
139 const uint8_t *clear = data;
141 int n = VPXMIN(sizeof(clear_buffer), data_sz);
142 decrypt_cb(decrypt_state, data, clear_buffer, n);
143 clear = clear_buffer;
147 if (data_sz >= 10 && !(clear[0] & 0x01)) /* I-Frame */
151 /* vet via sync code */
152 if (clear[3] != 0x9d || clear[4] != 0x01 || clear[5] != 0x2a) {
153 return VPX_CODEC_UNSUP_BITSTREAM;
156 si->w = (clear[6] | (clear[7] << 8)) & 0x3fff;
157 si->h = (clear[8] | (clear[9] << 8)) & 0x3fff;
159 /*printf("w=%d, h=%d\n", si->w, si->h);*/
160 if (!(si->h && si->w)) res = VPX_CODEC_CORRUPT_FRAME;
162 res = VPX_CODEC_UNSUP_BITSTREAM;
169 static vpx_codec_err_t vp8_peek_si(const uint8_t *data, unsigned int data_sz,
170 vpx_codec_stream_info_t *si) {
171 return vp8_peek_si_internal(data, data_sz, si, NULL, NULL);
174 static vpx_codec_err_t vp8_get_si(vpx_codec_alg_priv_t *ctx,
175 vpx_codec_stream_info_t *si) {
178 if (si->sz >= sizeof(vp8_stream_info_t)) {
179 sz = sizeof(vp8_stream_info_t);
181 sz = sizeof(vpx_codec_stream_info_t);
184 memcpy(si, &ctx->si, sz);
190 static vpx_codec_err_t update_error_state(
191 vpx_codec_alg_priv_t *ctx, const struct vpx_internal_error_info *error) {
194 if ((res = error->error_code)) {
195 ctx->base.err_detail = error->has_detail ? error->detail : NULL;
201 static void yuvconfig2image(vpx_image_t *img, const YV12_BUFFER_CONFIG *yv12,
203 /** vpx_img_wrap() doesn't allow specifying independent strides for
204 * the Y, U, and V planes, nor other alignment adjustments that
205 * might be representable by a YV12_BUFFER_CONFIG, so we just
206 * initialize all the fields.*/
207 img->fmt = VPX_IMG_FMT_I420;
208 img->w = yv12->y_stride;
209 img->h = (yv12->y_height + 2 * VP8BORDERINPIXELS + 15) & ~15;
210 img->d_w = img->r_w = yv12->y_width;
211 img->d_h = img->r_h = yv12->y_height;
212 img->x_chroma_shift = 1;
213 img->y_chroma_shift = 1;
214 img->planes[VPX_PLANE_Y] = yv12->y_buffer;
215 img->planes[VPX_PLANE_U] = yv12->u_buffer;
216 img->planes[VPX_PLANE_V] = yv12->v_buffer;
217 img->planes[VPX_PLANE_ALPHA] = NULL;
218 img->stride[VPX_PLANE_Y] = yv12->y_stride;
219 img->stride[VPX_PLANE_U] = yv12->uv_stride;
220 img->stride[VPX_PLANE_V] = yv12->uv_stride;
221 img->stride[VPX_PLANE_ALPHA] = yv12->y_stride;
224 img->user_priv = user_priv;
225 img->img_data = yv12->buffer_alloc;
226 img->img_data_owner = 0;
227 img->self_allocd = 0;
230 static int update_fragments(vpx_codec_alg_priv_t *ctx, const uint8_t *data,
231 unsigned int data_sz, vpx_codec_err_t *res) {
234 if (ctx->fragments.count == 0) {
235 /* New frame, reset fragment pointers and sizes */
236 memset((void *)ctx->fragments.ptrs, 0, sizeof(ctx->fragments.ptrs));
237 memset(ctx->fragments.sizes, 0, sizeof(ctx->fragments.sizes));
239 if (ctx->fragments.enabled && !(data == NULL && data_sz == 0)) {
240 /* Store a pointer to this fragment and return. We haven't
241 * received the complete frame yet, so we will wait with decoding.
243 ctx->fragments.ptrs[ctx->fragments.count] = data;
244 ctx->fragments.sizes[ctx->fragments.count] = data_sz;
245 ctx->fragments.count++;
246 if (ctx->fragments.count > (1 << EIGHT_PARTITION) + 1) {
247 ctx->fragments.count = 0;
248 *res = VPX_CODEC_INVALID_PARAM;
254 if (!ctx->fragments.enabled && (data == NULL && data_sz == 0)) {
258 if (!ctx->fragments.enabled) {
259 ctx->fragments.ptrs[0] = data;
260 ctx->fragments.sizes[0] = data_sz;
261 ctx->fragments.count = 1;
267 static vpx_codec_err_t vp8_decode(vpx_codec_alg_priv_t *ctx,
268 const uint8_t *data, unsigned int data_sz,
269 void *user_priv, long deadline) {
270 vpx_codec_err_t res = VPX_CODEC_OK;
271 unsigned int resolution_change = 0;
274 if (!ctx->fragments.enabled && (data == NULL && data_sz == 0)) {
278 /* Update the input fragment data */
279 if (update_fragments(ctx, data, data_sz, &res) <= 0) return res;
281 /* Determine the stream parameters. Note that we rely on peek_si to
282 * validate that we have a buffer that does not wrap around the top
288 res = vp8_peek_si_internal(ctx->fragments.ptrs[0], ctx->fragments.sizes[0],
289 &ctx->si, ctx->decrypt_cb, ctx->decrypt_state);
291 if ((res == VPX_CODEC_UNSUP_BITSTREAM) && !ctx->si.is_kf) {
292 /* the peek function returns an error for non keyframes, however for
293 * this case, it is not an error */
297 if (!ctx->decoder_init && !ctx->si.is_kf) res = VPX_CODEC_UNSUP_BITSTREAM;
299 if ((ctx->si.h != h) || (ctx->si.w != w)) resolution_change = 1;
301 /* Initialize the decoder instance on the first frame*/
302 if (!res && !ctx->decoder_init) {
305 oxcf.Width = ctx->si.w;
306 oxcf.Height = ctx->si.h;
308 oxcf.postprocess = 0;
309 oxcf.max_threads = ctx->cfg.threads;
310 oxcf.error_concealment =
311 (ctx->base.init_flags & VPX_CODEC_USE_ERROR_CONCEALMENT);
313 /* If postprocessing was enabled by the application and a
314 * configuration has not been provided, default it.
316 if (!ctx->postproc_cfg_set &&
317 (ctx->base.init_flags & VPX_CODEC_USE_POSTPROC)) {
318 ctx->postproc_cfg.post_proc_flag =
319 VP8_DEBLOCK | VP8_DEMACROBLOCK | VP8_MFQE;
320 ctx->postproc_cfg.deblocking_level = 4;
321 ctx->postproc_cfg.noise_level = 0;
324 res = vp8_create_decoder_instances(&ctx->yv12_frame_buffers, &oxcf);
325 if (res == VPX_CODEC_OK) ctx->decoder_init = 1;
328 /* Set these even if already initialized. The caller may have changed the
329 * decrypt config between frames.
331 if (ctx->decoder_init) {
332 ctx->yv12_frame_buffers.pbi[0]->decrypt_cb = ctx->decrypt_cb;
333 ctx->yv12_frame_buffers.pbi[0]->decrypt_state = ctx->decrypt_state;
337 VP8D_COMP *pbi = ctx->yv12_frame_buffers.pbi[0];
338 if (resolution_change) {
339 VP8_COMMON *const pc = &pbi->common;
340 MACROBLOCKD *const xd = &pbi->mb;
341 #if CONFIG_MULTITHREAD
344 pc->Width = ctx->si.w;
345 pc->Height = ctx->si.h;
347 int prev_mb_rows = pc->mb_rows;
349 if (setjmp(pbi->common.error.jmp)) {
350 pbi->common.error.setjmp = 0;
351 /* on failure clear the cached resolution to ensure a full
352 * reallocation is attempted on resync. */
355 vpx_clear_system_state();
356 /* same return value as used in vp8dx_receive_compressed_data */
360 pbi->common.error.setjmp = 1;
362 if (pc->Width <= 0) {
364 vpx_internal_error(&pc->error, VPX_CODEC_CORRUPT_FRAME,
365 "Invalid frame width");
368 if (pc->Height <= 0) {
370 vpx_internal_error(&pc->error, VPX_CODEC_CORRUPT_FRAME,
371 "Invalid frame height");
374 if (vp8_alloc_frame_buffers(pc, pc->Width, pc->Height)) {
375 vpx_internal_error(&pc->error, VPX_CODEC_MEM_ERROR,
376 "Failed to allocate frame buffers");
379 xd->pre = pc->yv12_fb[pc->lst_fb_idx];
380 xd->dst = pc->yv12_fb[pc->new_fb_idx];
382 #if CONFIG_MULTITHREAD
383 for (i = 0; i < pbi->allocated_decoding_thread_count; ++i) {
384 pbi->mb_row_di[i].mbd.dst = pc->yv12_fb[pc->new_fb_idx];
385 vp8_build_block_doffsets(&pbi->mb_row_di[i].mbd);
388 vp8_build_block_doffsets(&pbi->mb);
390 /* allocate memory for last frame MODE_INFO array */
391 #if CONFIG_ERROR_CONCEALMENT
393 if (pbi->ec_enabled) {
394 /* old prev_mip was released by vp8_de_alloc_frame_buffers()
395 * called in vp8_alloc_frame_buffers() */
396 pc->prev_mip = vpx_calloc((pc->mb_cols + 1) * (pc->mb_rows + 1),
400 vp8_de_alloc_frame_buffers(pc);
401 vpx_internal_error(&pc->error, VPX_CODEC_MEM_ERROR,
403 "last frame MODE_INFO array");
406 pc->prev_mi = pc->prev_mip + pc->mode_info_stride + 1;
408 if (vp8_alloc_overlap_lists(pbi))
409 vpx_internal_error(&pc->error, VPX_CODEC_MEM_ERROR,
410 "Failed to allocate overlap lists "
411 "for error concealment");
416 #if CONFIG_MULTITHREAD
417 if (pbi->b_multithreaded_rd) {
418 vp8mt_alloc_temp_buffers(pbi, pc->Width, prev_mb_rows);
425 pbi->common.error.setjmp = 0;
427 /* required to get past the first get_free_fb() call */
428 pbi->common.fb_idx_ref_cnt[0] = 0;
431 /* update the pbi fragment data */
432 pbi->fragments = ctx->fragments;
434 ctx->user_priv = user_priv;
435 if (vp8dx_receive_compressed_data(pbi, data_sz, data, deadline)) {
436 res = update_error_state(ctx, &pbi->common.error);
439 /* get ready for the next series of fragments */
440 ctx->fragments.count = 0;
446 static vpx_image_t *vp8_get_frame(vpx_codec_alg_priv_t *ctx,
447 vpx_codec_iter_t *iter) {
448 vpx_image_t *img = NULL;
450 /* iter acts as a flip flop, so an image is only returned on the first
453 if (!(*iter) && ctx->yv12_frame_buffers.pbi[0]) {
454 YV12_BUFFER_CONFIG sd;
455 int64_t time_stamp = 0, time_end_stamp = 0;
459 if (ctx->base.init_flags & VPX_CODEC_USE_POSTPROC) {
460 flags.post_proc_flag = ctx->postproc_cfg.post_proc_flag;
461 flags.deblocking_level = ctx->postproc_cfg.deblocking_level;
462 flags.noise_level = ctx->postproc_cfg.noise_level;
465 if (0 == vp8dx_get_raw_frame(ctx->yv12_frame_buffers.pbi[0], &sd,
466 &time_stamp, &time_end_stamp, &flags)) {
467 yuvconfig2image(&ctx->img, &sd, ctx->user_priv);
477 static vpx_codec_err_t image2yuvconfig(const vpx_image_t *img,
478 YV12_BUFFER_CONFIG *yv12) {
479 const int y_w = img->d_w;
480 const int y_h = img->d_h;
481 const int uv_w = (img->d_w + 1) / 2;
482 const int uv_h = (img->d_h + 1) / 2;
483 vpx_codec_err_t res = VPX_CODEC_OK;
484 yv12->y_buffer = img->planes[VPX_PLANE_Y];
485 yv12->u_buffer = img->planes[VPX_PLANE_U];
486 yv12->v_buffer = img->planes[VPX_PLANE_V];
488 yv12->y_crop_width = y_w;
489 yv12->y_crop_height = y_h;
491 yv12->y_height = y_h;
492 yv12->uv_crop_width = uv_w;
493 yv12->uv_crop_height = uv_h;
494 yv12->uv_width = uv_w;
495 yv12->uv_height = uv_h;
497 yv12->y_stride = img->stride[VPX_PLANE_Y];
498 yv12->uv_stride = img->stride[VPX_PLANE_U];
500 yv12->border = (img->stride[VPX_PLANE_Y] - img->d_w) / 2;
504 static vpx_codec_err_t vp8_set_reference(vpx_codec_alg_priv_t *ctx,
506 vpx_ref_frame_t *data = va_arg(args, vpx_ref_frame_t *);
509 vpx_ref_frame_t *frame = (vpx_ref_frame_t *)data;
510 YV12_BUFFER_CONFIG sd;
512 image2yuvconfig(&frame->img, &sd);
514 return vp8dx_set_reference(ctx->yv12_frame_buffers.pbi[0],
515 frame->frame_type, &sd);
517 return VPX_CODEC_INVALID_PARAM;
521 static vpx_codec_err_t vp8_get_reference(vpx_codec_alg_priv_t *ctx,
523 vpx_ref_frame_t *data = va_arg(args, vpx_ref_frame_t *);
526 vpx_ref_frame_t *frame = (vpx_ref_frame_t *)data;
527 YV12_BUFFER_CONFIG sd;
529 image2yuvconfig(&frame->img, &sd);
531 return vp8dx_get_reference(ctx->yv12_frame_buffers.pbi[0],
532 frame->frame_type, &sd);
534 return VPX_CODEC_INVALID_PARAM;
538 static vpx_codec_err_t vp8_set_postproc(vpx_codec_alg_priv_t *ctx,
541 vp8_postproc_cfg_t *data = va_arg(args, vp8_postproc_cfg_t *);
544 ctx->postproc_cfg_set = 1;
545 ctx->postproc_cfg = *((vp8_postproc_cfg_t *)data);
548 return VPX_CODEC_INVALID_PARAM;
554 return VPX_CODEC_INCAPABLE;
558 static vpx_codec_err_t vp8_get_last_ref_updates(vpx_codec_alg_priv_t *ctx,
560 int *update_info = va_arg(args, int *);
563 VP8D_COMP *pbi = (VP8D_COMP *)ctx->yv12_frame_buffers.pbi[0];
565 *update_info = pbi->common.refresh_alt_ref_frame * (int)VP8_ALTR_FRAME +
566 pbi->common.refresh_golden_frame * (int)VP8_GOLD_FRAME +
567 pbi->common.refresh_last_frame * (int)VP8_LAST_FRAME;
571 return VPX_CODEC_INVALID_PARAM;
575 extern int vp8dx_references_buffer(VP8_COMMON *oci, int ref_frame);
576 static vpx_codec_err_t vp8_get_last_ref_frame(vpx_codec_alg_priv_t *ctx,
578 int *ref_info = va_arg(args, int *);
581 VP8D_COMP *pbi = (VP8D_COMP *)ctx->yv12_frame_buffers.pbi[0];
582 VP8_COMMON *oci = &pbi->common;
584 (vp8dx_references_buffer(oci, ALTREF_FRAME) ? VP8_ALTR_FRAME : 0) |
585 (vp8dx_references_buffer(oci, GOLDEN_FRAME) ? VP8_GOLD_FRAME : 0) |
586 (vp8dx_references_buffer(oci, LAST_FRAME) ? VP8_LAST_FRAME : 0);
590 return VPX_CODEC_INVALID_PARAM;
594 static vpx_codec_err_t vp8_get_frame_corrupted(vpx_codec_alg_priv_t *ctx,
596 int *corrupted = va_arg(args, int *);
597 VP8D_COMP *pbi = (VP8D_COMP *)ctx->yv12_frame_buffers.pbi[0];
599 if (corrupted && pbi) {
600 const YV12_BUFFER_CONFIG *const frame = pbi->common.frame_to_show;
601 if (frame == NULL) return VPX_CODEC_ERROR;
602 *corrupted = frame->corrupted;
605 return VPX_CODEC_INVALID_PARAM;
609 static vpx_codec_err_t vp8_set_decryptor(vpx_codec_alg_priv_t *ctx,
611 vpx_decrypt_init *init = va_arg(args, vpx_decrypt_init *);
614 ctx->decrypt_cb = init->decrypt_cb;
615 ctx->decrypt_state = init->decrypt_state;
617 ctx->decrypt_cb = NULL;
618 ctx->decrypt_state = NULL;
623 vpx_codec_ctrl_fn_map_t vp8_ctf_maps[] = {
624 { VP8_SET_REFERENCE, vp8_set_reference },
625 { VP8_COPY_REFERENCE, vp8_get_reference },
626 { VP8_SET_POSTPROC, vp8_set_postproc },
627 { VP8D_GET_LAST_REF_UPDATES, vp8_get_last_ref_updates },
628 { VP8D_GET_FRAME_CORRUPTED, vp8_get_frame_corrupted },
629 { VP8D_GET_LAST_REF_USED, vp8_get_last_ref_frame },
630 { VPXD_SET_DECRYPTOR, vp8_set_decryptor },
634 #ifndef VERSION_STRING
635 #define VERSION_STRING
637 CODEC_INTERFACE(vpx_codec_vp8_dx) = {
638 "WebM Project VP8 Decoder" VERSION_STRING,
639 VPX_CODEC_INTERNAL_ABI_VERSION,
640 VPX_CODEC_CAP_DECODER | VP8_CAP_POSTPROC | VP8_CAP_ERROR_CONCEALMENT |
641 VPX_CODEC_CAP_INPUT_FRAGMENTS,
642 /* vpx_codec_caps_t caps; */
643 vp8_init, /* vpx_codec_init_fn_t init; */
644 vp8_destroy, /* vpx_codec_destroy_fn_t destroy; */
645 vp8_ctf_maps, /* vpx_codec_ctrl_fn_map_t *ctrl_maps; */
647 vp8_peek_si, /* vpx_codec_peek_si_fn_t peek_si; */
648 vp8_get_si, /* vpx_codec_get_si_fn_t get_si; */
649 vp8_decode, /* vpx_codec_decode_fn_t decode; */
650 vp8_get_frame, /* vpx_codec_frame_get_fn_t frame_get; */
654 /* encoder functions */
655 0, NULL, /* vpx_codec_enc_cfg_map_t */
656 NULL, /* vpx_codec_encode_fn_t */
657 NULL, /* vpx_codec_get_cx_data_fn_t */
658 NULL, /* vpx_codec_enc_config_set_fn_t */
659 NULL, /* vpx_codec_get_global_headers_fn_t */
660 NULL, /* vpx_codec_get_preview_frame_fn_t */
661 NULL /* vpx_codec_enc_mr_get_mem_loc_fn_t */