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/vpx_decoder.h"
15 #include "vpx/vp8dx.h"
16 #include "vpx/internal/vpx_codec_internal.h"
17 #include "vpx_version.h"
18 #include "common/onyxd.h"
19 #include "decoder/onyxd_int.h"
21 #define VP8_CAP_POSTPROC (CONFIG_POSTPROC ? VPX_CODEC_CAP_POSTPROC : 0)
22 #define VP8_CAP_ERROR_CONCEALMENT (CONFIG_ERROR_CONCEALMENT ? \
23 VPX_CODEC_CAP_ERROR_CONCEALMENT : 0)
25 typedef vpx_codec_stream_info_t vp8_stream_info_t;
27 /* Structures for handling memory allocations */
30 VP8_SEG_ALG_PRIV = 256,
33 #define NELEMENTS(x) ((int)(sizeof(x)/sizeof(x[0])))
35 static unsigned long vp8_priv_sz(const vpx_codec_dec_cfg_t *si, vpx_codec_flags_t);
43 unsigned long(*calc_sz)(const vpx_codec_dec_cfg_t *, vpx_codec_flags_t);
46 static const mem_req_t vp8_mem_req_segs[] =
48 {VP8_SEG_ALG_PRIV, 0, 8, VPX_CODEC_MEM_ZERO, vp8_priv_sz},
49 {VP8_SEG_MAX, 0, 0, 0, NULL}
52 struct vpx_codec_alg_priv
54 vpx_codec_priv_t base;
55 vpx_codec_mmap_t mmaps[NELEMENTS(vp8_mem_req_segs)-1];
56 vpx_codec_dec_cfg_t cfg;
62 vp8_postproc_cfg_t postproc_cfg;
63 #if CONFIG_POSTPROC_VISUALIZER
64 unsigned int dbg_postproc_flag;
65 int dbg_color_ref_frame_flag;
66 int dbg_color_mb_modes_flag;
67 int dbg_color_b_modes_flag;
68 int dbg_display_mv_flag;
75 static unsigned long vp8_priv_sz(const vpx_codec_dec_cfg_t *si, vpx_codec_flags_t flags)
77 /* Although this declaration is constant, we can't use it in the requested
78 * segments list because we want to define the requested segments list
79 * before defining the private type (so that the number of memory maps is
83 return sizeof(vpx_codec_alg_priv_t);
87 static void vp8_mmap_dtor(vpx_codec_mmap_t *mmap)
92 static vpx_codec_err_t vp8_mmap_alloc(vpx_codec_mmap_t *mmap)
97 align = mmap->align ? mmap->align - 1 : 0;
99 if (mmap->flags & VPX_CODEC_MEM_ZERO)
100 mmap->priv = calloc(1, mmap->sz + align);
102 mmap->priv = malloc(mmap->sz + align);
104 res = (mmap->priv) ? VPX_CODEC_OK : VPX_CODEC_MEM_ERROR;
105 mmap->base = (void *)((((uintptr_t)mmap->priv) + align) & ~(uintptr_t)align);
106 mmap->dtor = vp8_mmap_dtor;
110 static vpx_codec_err_t vp8_validate_mmaps(const vp8_stream_info_t *si,
111 const vpx_codec_mmap_t *mmaps,
112 vpx_codec_flags_t init_flags)
115 vpx_codec_err_t res = VPX_CODEC_OK;
117 for (i = 0; i < NELEMENTS(vp8_mem_req_segs) - 1; i++)
119 /* Ensure the segment has been allocated */
122 res = VPX_CODEC_MEM_ERROR;
126 /* Verify variable size segment is big enough for the current si. */
127 if (vp8_mem_req_segs[i].calc_sz)
129 vpx_codec_dec_cfg_t cfg;
134 if (mmaps[i].sz < vp8_mem_req_segs[i].calc_sz(&cfg, init_flags))
136 res = VPX_CODEC_MEM_ERROR;
145 static void vp8_init_ctx(vpx_codec_ctx_t *ctx, const vpx_codec_mmap_t *mmap)
149 ctx->priv = mmap->base;
150 ctx->priv->sz = sizeof(*ctx->priv);
151 ctx->priv->iface = ctx->iface;
152 ctx->priv->alg_priv = mmap->base;
154 for (i = 0; i < NELEMENTS(ctx->priv->alg_priv->mmaps); i++)
155 ctx->priv->alg_priv->mmaps[i].id = vp8_mem_req_segs[i].id;
157 ctx->priv->alg_priv->mmaps[0] = *mmap;
158 ctx->priv->alg_priv->si.sz = sizeof(ctx->priv->alg_priv->si);
159 ctx->priv->init_flags = ctx->init_flags;
163 /* Update the reference to the config structure to an internal copy. */
164 ctx->priv->alg_priv->cfg = *ctx->config.dec;
165 ctx->config.dec = &ctx->priv->alg_priv->cfg;
169 static void *mmap_lkup(vpx_codec_alg_priv_t *ctx, unsigned int id)
173 for (i = 0; i < NELEMENTS(ctx->mmaps); i++)
174 if (ctx->mmaps[i].id == id)
175 return ctx->mmaps[i].base;
179 static void vp8_finalize_mmaps(vpx_codec_alg_priv_t *ctx)
181 /* nothing to clean up */
184 static vpx_codec_err_t vp8_init(vpx_codec_ctx_t *ctx)
186 vpx_codec_err_t res = VPX_CODEC_OK;
188 /* This function only allocates space for the vpx_codec_alg_priv_t
189 * structure. More memory may be required at the time the stream
190 * information becomes known.
194 vpx_codec_mmap_t mmap;
196 mmap.id = vp8_mem_req_segs[0].id;
197 mmap.sz = sizeof(vpx_codec_alg_priv_t);
198 mmap.align = vp8_mem_req_segs[0].align;
199 mmap.flags = vp8_mem_req_segs[0].flags;
201 res = vp8_mmap_alloc(&mmap);
205 vp8_init_ctx(ctx, &mmap);
207 ctx->priv->alg_priv->defer_alloc = 1;
208 /*post processing level initialized to do nothing */
215 static vpx_codec_err_t vp8_destroy(vpx_codec_alg_priv_t *ctx)
219 vp8dx_remove_decompressor(ctx->pbi);
221 for (i = NELEMENTS(ctx->mmaps) - 1; i >= 0; i--)
223 if (ctx->mmaps[i].dtor)
224 ctx->mmaps[i].dtor(&ctx->mmaps[i]);
230 static vpx_codec_err_t vp8_peek_si(const uint8_t *data,
231 unsigned int data_sz,
232 vpx_codec_stream_info_t *si)
234 vpx_codec_err_t res = VPX_CODEC_OK;
236 if(data + data_sz <= data)
237 res = VPX_CODEC_INVALID_PARAM;
240 /* Parse uncompresssed part of key frame header.
241 * 3 bytes:- including version, frame type and an offset
242 * 3 bytes:- sync code (0x9d, 0x01, 0x2a)
243 * 4 bytes:- including image width and height in the lowest 14 bits
244 * of each 2-byte value.
248 if (data_sz >= 10 && !(data[0] & 0x01)) /* I-Frame */
250 const uint8_t *c = data + 3;
253 /* vet via sync code */
254 if (c[0] != 0x9d || c[1] != 0x01 || c[2] != 0x2a)
255 res = VPX_CODEC_UNSUP_BITSTREAM;
257 si->w = (c[3] | (c[4] << 8)) & 0x3fff;
258 si->h = (c[5] | (c[6] << 8)) & 0x3fff;
260 /*printf("w=%d, h=%d\n", si->w, si->h);*/
261 if (!(si->h | si->w))
262 res = VPX_CODEC_UNSUP_BITSTREAM;
265 res = VPX_CODEC_UNSUP_BITSTREAM;
272 static vpx_codec_err_t vp8_get_si(vpx_codec_alg_priv_t *ctx,
273 vpx_codec_stream_info_t *si)
278 if (si->sz >= sizeof(vp8_stream_info_t))
279 sz = sizeof(vp8_stream_info_t);
281 sz = sizeof(vpx_codec_stream_info_t);
283 memcpy(si, &ctx->si, sz);
290 static vpx_codec_err_t
291 update_error_state(vpx_codec_alg_priv_t *ctx,
292 const struct vpx_internal_error_info *error)
296 if ((res = error->error_code))
297 ctx->base.err_detail = error->has_detail
304 static void yuvconfig2image(vpx_image_t *img,
305 const YV12_BUFFER_CONFIG *yv12,
308 /** vpx_img_wrap() doesn't allow specifying independent strides for
309 * the Y, U, and V planes, nor other alignment adjustments that
310 * might be representable by a YV12_BUFFER_CONFIG, so we just
311 * initialize all the fields.*/
312 img->fmt = yv12->clrtype == REG_YUV ?
313 VPX_IMG_FMT_I420 : VPX_IMG_FMT_VPXI420;
314 img->w = yv12->y_stride;
315 img->h = (yv12->y_height + 2 * VP8BORDERINPIXELS + 15) & ~15;
316 img->d_w = yv12->y_width;
317 img->d_h = yv12->y_height;
318 img->x_chroma_shift = 1;
319 img->y_chroma_shift = 1;
320 img->planes[VPX_PLANE_Y] = yv12->y_buffer;
321 img->planes[VPX_PLANE_U] = yv12->u_buffer;
322 img->planes[VPX_PLANE_V] = yv12->v_buffer;
323 img->planes[VPX_PLANE_ALPHA] = NULL;
324 img->stride[VPX_PLANE_Y] = yv12->y_stride;
325 img->stride[VPX_PLANE_U] = yv12->uv_stride;
326 img->stride[VPX_PLANE_V] = yv12->uv_stride;
327 img->stride[VPX_PLANE_ALPHA] = yv12->y_stride;
329 img->user_priv = user_priv;
330 img->img_data = yv12->buffer_alloc;
331 img->img_data_owner = 0;
332 img->self_allocd = 0;
335 static vpx_codec_err_t vp8_decode(vpx_codec_alg_priv_t *ctx,
337 unsigned int data_sz,
341 vpx_codec_err_t res = VPX_CODEC_OK;
345 /* Determine the stream parameters. Note that we rely on peek_si to
346 * validate that we have a buffer that does not wrap around the top
350 res = ctx->base.iface->dec.peek_si(data, data_sz, &ctx->si);
353 /* Perform deferred allocations, if required */
354 if (!res && ctx->defer_alloc)
358 for (i = 1; !res && i < NELEMENTS(ctx->mmaps); i++)
360 vpx_codec_dec_cfg_t cfg;
364 ctx->mmaps[i].id = vp8_mem_req_segs[i].id;
365 ctx->mmaps[i].sz = vp8_mem_req_segs[i].sz;
366 ctx->mmaps[i].align = vp8_mem_req_segs[i].align;
367 ctx->mmaps[i].flags = vp8_mem_req_segs[i].flags;
369 if (!ctx->mmaps[i].sz)
370 ctx->mmaps[i].sz = vp8_mem_req_segs[i].calc_sz(&cfg,
371 ctx->base.init_flags);
373 res = vp8_mmap_alloc(&ctx->mmaps[i]);
377 vp8_finalize_mmaps(ctx);
379 ctx->defer_alloc = 0;
382 /* Initialize the decoder instance on the first frame*/
383 if (!res && !ctx->decoder_init)
385 res = vp8_validate_mmaps(&ctx->si, ctx->mmaps, ctx->base.init_flags);
394 oxcf.Width = ctx->si.w;
395 oxcf.Height = ctx->si.h;
397 oxcf.postprocess = 0;
398 oxcf.max_threads = ctx->cfg.threads;
399 oxcf.error_concealment =
400 (ctx->base.init_flags & VPX_CODEC_USE_ERROR_CONCEALMENT);
401 oxcf.input_fragments =
402 (ctx->base.init_flags & VPX_CODEC_USE_INPUT_FRAGMENTS);
404 optr = vp8dx_create_decompressor(&oxcf);
406 /* If postprocessing was enabled by the application and a
407 * configuration has not been provided, default it.
409 if (!ctx->postproc_cfg_set
410 && (ctx->base.init_flags & VPX_CODEC_USE_POSTPROC))
412 ctx->postproc_cfg.post_proc_flag =
413 VP8_DEBLOCK | VP8_DEMACROBLOCK;
414 ctx->postproc_cfg.deblocking_level = 4;
415 ctx->postproc_cfg.noise_level = 0;
419 res = VPX_CODEC_ERROR;
424 ctx->decoder_init = 1;
427 if (!res && ctx->pbi)
429 YV12_BUFFER_CONFIG sd;
430 int64_t time_stamp = 0, time_end_stamp = 0;
431 vp8_ppflags_t flags = {0};
433 if (ctx->base.init_flags & VPX_CODEC_USE_POSTPROC)
435 flags.post_proc_flag= ctx->postproc_cfg.post_proc_flag
436 #if CONFIG_POSTPROC_VISUALIZER
438 | ((ctx->dbg_color_ref_frame_flag != 0) ? VP8D_DEBUG_CLR_FRM_REF_BLKS : 0)
439 | ((ctx->dbg_color_mb_modes_flag != 0) ? VP8D_DEBUG_CLR_BLK_MODES : 0)
440 | ((ctx->dbg_color_b_modes_flag != 0) ? VP8D_DEBUG_CLR_BLK_MODES : 0)
441 | ((ctx->dbg_display_mv_flag != 0) ? VP8D_DEBUG_DRAW_MV : 0)
444 flags.deblocking_level = ctx->postproc_cfg.deblocking_level;
445 flags.noise_level = ctx->postproc_cfg.noise_level;
446 #if CONFIG_POSTPROC_VISUALIZER
447 flags.display_ref_frame_flag= ctx->dbg_color_ref_frame_flag;
448 flags.display_mb_modes_flag = ctx->dbg_color_mb_modes_flag;
449 flags.display_b_modes_flag = ctx->dbg_color_b_modes_flag;
450 flags.display_mv_flag = ctx->dbg_display_mv_flag;
454 if (vp8dx_receive_compressed_data(ctx->pbi, data_sz, data, deadline))
456 VP8D_COMP *pbi = (VP8D_COMP *)ctx->pbi;
457 res = update_error_state(ctx, &pbi->common.error);
460 if (!res && 0 == vp8dx_get_raw_frame(ctx->pbi, &sd, &time_stamp, &time_end_stamp, &flags))
462 yuvconfig2image(&ctx->img, &sd, user_priv);
470 static vpx_image_t *vp8_get_frame(vpx_codec_alg_priv_t *ctx,
471 vpx_codec_iter_t *iter)
473 vpx_image_t *img = NULL;
477 /* iter acts as a flip flop, so an image is only returned on the first
492 vpx_codec_err_t vp8_xma_get_mmap(const vpx_codec_ctx_t *ctx,
493 vpx_codec_mmap_t *mmap,
494 vpx_codec_iter_t *iter)
497 const mem_req_t *seg_iter = *iter;
499 /* Get address of next segment request */
503 seg_iter = vp8_mem_req_segs;
504 else if (seg_iter->id != VP8_SEG_MAX)
507 *iter = (vpx_codec_iter_t)seg_iter;
509 if (seg_iter->id != VP8_SEG_MAX)
511 mmap->id = seg_iter->id;
512 mmap->sz = seg_iter->sz;
513 mmap->align = seg_iter->align;
514 mmap->flags = seg_iter->flags;
517 mmap->sz = seg_iter->calc_sz(ctx->config.dec, ctx->init_flags);
522 res = VPX_CODEC_LIST_END;
524 while (!mmap->sz && res != VPX_CODEC_LIST_END);
529 static vpx_codec_err_t vp8_xma_set_mmap(vpx_codec_ctx_t *ctx,
530 const vpx_codec_mmap_t *mmap)
532 vpx_codec_err_t res = VPX_CODEC_MEM_ERROR;
537 if (mmap->id == VP8_SEG_ALG_PRIV)
541 vp8_init_ctx(ctx, mmap);
549 if (!res && ctx->priv->alg_priv)
551 for (i = 0; i < NELEMENTS(ctx->priv->alg_priv->mmaps); i++)
553 if (ctx->priv->alg_priv->mmaps[i].id == mmap->id)
554 if (!ctx->priv->alg_priv->mmaps[i].base)
556 ctx->priv->alg_priv->mmaps[i] = *mmap;
560 done &= (ctx->priv->alg_priv->mmaps[i].base != NULL);
566 vp8_finalize_mmaps(ctx->priv->alg_priv);
567 res = ctx->iface->init(ctx);
573 static vpx_codec_err_t image2yuvconfig(const vpx_image_t *img,
574 YV12_BUFFER_CONFIG *yv12)
576 vpx_codec_err_t res = VPX_CODEC_OK;
577 yv12->y_buffer = img->planes[VPX_PLANE_Y];
578 yv12->u_buffer = img->planes[VPX_PLANE_U];
579 yv12->v_buffer = img->planes[VPX_PLANE_V];
581 yv12->y_width = img->d_w;
582 yv12->y_height = img->d_h;
583 yv12->uv_width = yv12->y_width / 2;
584 yv12->uv_height = yv12->y_height / 2;
586 yv12->y_stride = img->stride[VPX_PLANE_Y];
587 yv12->uv_stride = img->stride[VPX_PLANE_U];
589 yv12->border = (img->stride[VPX_PLANE_Y] - img->d_w) / 2;
590 yv12->clrtype = (img->fmt == VPX_IMG_FMT_VPXI420 || img->fmt == VPX_IMG_FMT_VPXYV12);
596 static vpx_codec_err_t vp8_set_reference(vpx_codec_alg_priv_t *ctx,
601 vpx_ref_frame_t *data = va_arg(args, vpx_ref_frame_t *);
605 vpx_ref_frame_t *frame = (vpx_ref_frame_t *)data;
606 YV12_BUFFER_CONFIG sd;
608 image2yuvconfig(&frame->img, &sd);
610 return vp8dx_set_reference(ctx->pbi, frame->frame_type, &sd);
613 return VPX_CODEC_INVALID_PARAM;
617 static vpx_codec_err_t vp8_get_reference(vpx_codec_alg_priv_t *ctx,
622 vpx_ref_frame_t *data = va_arg(args, vpx_ref_frame_t *);
626 vpx_ref_frame_t *frame = (vpx_ref_frame_t *)data;
627 YV12_BUFFER_CONFIG sd;
629 image2yuvconfig(&frame->img, &sd);
631 return vp8dx_get_reference(ctx->pbi, frame->frame_type, &sd);
634 return VPX_CODEC_INVALID_PARAM;
638 static vpx_codec_err_t vp8_set_postproc(vpx_codec_alg_priv_t *ctx,
643 vp8_postproc_cfg_t *data = va_arg(args, vp8_postproc_cfg_t *);
647 ctx->postproc_cfg_set = 1;
648 ctx->postproc_cfg = *((vp8_postproc_cfg_t *)data);
652 return VPX_CODEC_INVALID_PARAM;
655 return VPX_CODEC_INCAPABLE;
659 static vpx_codec_err_t vp8_set_dbg_options(vpx_codec_alg_priv_t *ctx,
663 #if CONFIG_POSTPROC_VISUALIZER && CONFIG_POSTPROC
664 int data = va_arg(args, int);
666 #define MAP(id, var) case id: var = data; break;
670 MAP (VP8_SET_DBG_COLOR_REF_FRAME, ctx->dbg_color_ref_frame_flag);
671 MAP (VP8_SET_DBG_COLOR_MB_MODES, ctx->dbg_color_mb_modes_flag);
672 MAP (VP8_SET_DBG_COLOR_B_MODES, ctx->dbg_color_b_modes_flag);
673 MAP (VP8_SET_DBG_DISPLAY_MV, ctx->dbg_display_mv_flag);
678 return VPX_CODEC_INCAPABLE;
682 static vpx_codec_err_t vp8_get_last_ref_updates(vpx_codec_alg_priv_t *ctx,
686 int *update_info = va_arg(args, int *);
687 VP8D_COMP *pbi = (VP8D_COMP *)ctx->pbi;
691 *update_info = pbi->common.refresh_alt_ref_frame * (int) VP8_ALTR_FRAME
692 + pbi->common.refresh_golden_frame * (int) VP8_GOLD_FRAME
693 + pbi->common.refresh_last_frame * (int) VP8_LAST_FRAME;
698 return VPX_CODEC_INVALID_PARAM;
702 static vpx_codec_err_t vp8_get_frame_corrupted(vpx_codec_alg_priv_t *ctx,
707 int *corrupted = va_arg(args, int *);
711 VP8D_COMP *pbi = (VP8D_COMP *)ctx->pbi;
712 *corrupted = pbi->common.frame_to_show->corrupted;
717 return VPX_CODEC_INVALID_PARAM;
721 vpx_codec_ctrl_fn_map_t vp8_ctf_maps[] =
723 {VP8_SET_REFERENCE, vp8_set_reference},
724 {VP8_COPY_REFERENCE, vp8_get_reference},
725 {VP8_SET_POSTPROC, vp8_set_postproc},
726 {VP8_SET_DBG_COLOR_REF_FRAME, vp8_set_dbg_options},
727 {VP8_SET_DBG_COLOR_MB_MODES, vp8_set_dbg_options},
728 {VP8_SET_DBG_COLOR_B_MODES, vp8_set_dbg_options},
729 {VP8_SET_DBG_DISPLAY_MV, vp8_set_dbg_options},
730 {VP8D_GET_LAST_REF_UPDATES, vp8_get_last_ref_updates},
731 {VP8D_GET_FRAME_CORRUPTED, vp8_get_frame_corrupted},
736 #ifndef VERSION_STRING
737 #define VERSION_STRING
739 CODEC_INTERFACE(vpx_codec_vp8_dx) =
741 "WebM Project VP8 Decoder" VERSION_STRING,
742 VPX_CODEC_INTERNAL_ABI_VERSION,
743 VPX_CODEC_CAP_DECODER | VP8_CAP_POSTPROC | VP8_CAP_ERROR_CONCEALMENT |
744 VPX_CODEC_CAP_INPUT_FRAGMENTS,
745 /* vpx_codec_caps_t caps; */
746 vp8_init, /* vpx_codec_init_fn_t init; */
747 vp8_destroy, /* vpx_codec_destroy_fn_t destroy; */
748 vp8_ctf_maps, /* vpx_codec_ctrl_fn_map_t *ctrl_maps; */
749 vp8_xma_get_mmap, /* vpx_codec_get_mmap_fn_t get_mmap; */
750 vp8_xma_set_mmap, /* vpx_codec_set_mmap_fn_t set_mmap; */
752 vp8_peek_si, /* vpx_codec_peek_si_fn_t peek_si; */
753 vp8_get_si, /* vpx_codec_get_si_fn_t get_si; */
754 vp8_decode, /* vpx_codec_decode_fn_t decode; */
755 vp8_get_frame, /* vpx_codec_frame_get_fn_t frame_get; */
757 { /* encoder functions */
768 * BEGIN BACKWARDS COMPATIBILITY SHIM.
770 vpx_codec_iface_t vpx_codec_vp8_algo =
772 "WebM Project VP8 Decoder (Deprecated API)" VERSION_STRING,
773 VPX_CODEC_INTERNAL_ABI_VERSION,
774 VPX_CODEC_CAP_DECODER | VP8_CAP_POSTPROC | VP8_CAP_ERROR_CONCEALMENT,
775 /* vpx_codec_caps_t caps; */
776 vp8_init, /* vpx_codec_init_fn_t init; */
777 vp8_destroy, /* vpx_codec_destroy_fn_t destroy; */
778 vp8_ctf_maps, /* vpx_codec_ctrl_fn_map_t *ctrl_maps; */
779 vp8_xma_get_mmap, /* vpx_codec_get_mmap_fn_t get_mmap; */
780 vp8_xma_set_mmap, /* vpx_codec_set_mmap_fn_t set_mmap; */
782 vp8_peek_si, /* vpx_codec_peek_si_fn_t peek_si; */
783 vp8_get_si, /* vpx_codec_get_si_fn_t get_si; */
784 vp8_decode, /* vpx_codec_decode_fn_t decode; */
785 vp8_get_frame, /* vpx_codec_frame_get_fn_t frame_get; */
787 { /* encoder functions */