1 /* 2 * Copyright (c) 2010 The WebM project authors. All Rights Reserved. 3 * 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. 9 */ 10 11 12 /*!\defgroup vp8 VP8 13 * \ingroup codecs 14 * VP8 is vpx's newest video compression algorithm that uses motion 15 * compensated prediction, Discrete Cosine Transform (DCT) coding of the 16 * prediction error signal and context dependent entropy coding techniques 17 * based on arithmatic principles. It features: 18 * - YUV 4:2:0 image format 19 * - Macro-block based coding (16x16 luma plus two 8x8 chroma) 20 * - 1/4 (1/8) pixel accuracy motion compensated prediction 21 * - 4x4 DCT transform 22 * - 128 level linear quantizer 23 * - In loop deblocking filter 24 * - Context-based entropy coding 25 * 26 * @{ 27 */ 28 /*!\file vp8.h 29 * \brief Provides controls common to both the VP8 encoder and decoder. 30 */ 31 #ifndef VP8_H 32 #define VP8_H 33 #include "vpx/vpx_codec_impl_top.h" 34 35 /*!\brief Control functions 36 * 37 * The set of macros define the control functions of VP8 interface 38 */ 39 enum vp8_dec_control_id 40 { 41 VP8_SET_REFERENCE = 1, /**< pass in an external frame into decoder to be used as reference frame */ 42 VP8_COPY_REFERENCE = 2, /**< get a copy of reference frame from the decoder */ 43 VP8_SET_POSTPROC = 3, /**< set decoder's the post processing settings */ 44 VP8_COMMON_CTRL_ID_MAX 45 }; 46 47 /*!\brief post process flags 48 * 49 * The set of macros define VP8 decoder post processing flags 50 */ 51 enum vp8_postproc_level 52 { 53 VP8_NOFILTERING = 0, 54 VP8_DEBLOCK = 1, 55 VP8_DEMACROBLOCK = 2, 56 VP8_ADDNOISE = 4 57 }; 58 59 /*!\brief post process flags 60 * 61 * This define a structure that describe the post processing settings. For 62 * the best objective measure (using thet PSNR metric) set post_proc_flag 63 * to VP8_DEBLOCK and deblocking_level to 1. 64 */ 65 66 typedef struct vp8_postproc_cfg 67 { 68 int post_proc_flag; /**< the types of post processing to be done, should be combination of "vp8_postproc_level" */ 69 int deblocking_level; /**< the strength of deblocking, valid range [0, 16] */ 70 int noise_level; /**< the strength of additive noise, valid range [0, 16] */ 71 } vp8_postproc_cfg_t; 72 73 /*!\brief reference frame type 74 * 75 * The set of macros define the type of VP8 reference frames 76 */ 77 typedef enum vpx_ref_frame_type 78 { 79 VP8_LAST_FRAME = 1, 80 VP8_GOLD_FRAME = 2, 81 VP8_ALTR_FRAME = 4 82 } vpx_ref_frame_type_t; 83 84 /*!\brief reference frame data struct 85 * 86 * define the data struct to access vp8 reference frames 87 */ 88 89 typedef struct vpx_ref_frame 90 { 91 vpx_ref_frame_type_t frame_type; /**< which reference frame */ 92 vpx_image_t img; /**< reference frame data in image format */ 93 } vpx_ref_frame_t; 94 95 96 /*!\brief vp8 decoder control funciton parameter type 97 * 98 * defines the data type for each of VP8 decoder control funciton requires 99 */ 100 101 VPX_CTRL_USE_TYPE(VP8_SET_REFERENCE, vpx_ref_frame_t *) 102 VPX_CTRL_USE_TYPE(VP8_COPY_REFERENCE, vpx_ref_frame_t *) 103 VPX_CTRL_USE_TYPE(VP8_SET_POSTPROC, vp8_postproc_cfg_t *) 104 105 106 /*! @} - end defgroup vp8 */ 107 108 #if !defined(VPX_CODEC_DISABLE_COMPAT) || !VPX_CODEC_DISABLE_COMPAT 109 /* The following definitions are provided for backward compatibility with 110 * the VP8 1.0.x SDK. USE IN PRODUCTION CODE IS NOT RECOMMENDED. 111 */ 112 113 DECLSPEC_DEPRECATED extern vpx_codec_iface_t vpx_codec_vp8_algo DEPRECATED; 114 #endif 115 116 #include "vpx/vpx_codec_impl_bottom.h" 117 #endif 118