vp8.h 4.83 KB
 John Koleszar committed May 18, 2010 1 ``````/* `````` John Koleszar committed Sep 09, 2010 2 `````` * Copyright (c) 2010 The WebM project authors. All Rights Reserved. `````` John Koleszar committed May 18, 2010 3 `````` * `````` John Koleszar committed Jun 18, 2010 4 `````` * Use of this source code is governed by a BSD-style license `````` John Koleszar committed Jun 04, 2010 5 6 `````` * that can be found in the LICENSE file in the root of the source * tree. An additional intellectual property rights grant can be found `````` John Koleszar committed Jun 18, 2010 7 `````` * in the file PATENTS. All contributing project authors may `````` John Koleszar committed Jun 04, 2010 8 `````` * be found in the AUTHORS file in the root of the source tree. `````` John Koleszar committed May 18, 2010 9 10 11 12 13 14 15 16 `````` */ /*!\defgroup vp8 VP8 * \ingroup codecs * VP8 is vpx's newest video compression algorithm that uses motion * compensated prediction, Discrete Cosine Transform (DCT) coding of the * prediction error signal and context dependent entropy coding techniques `````` James Zern committed Feb 16, 2011 17 `````` * based on arithmetic principles. It features: `````` John Koleszar committed May 18, 2010 18 19 20 21 22 23 24 25 26 27 `````` * - YUV 4:2:0 image format * - Macro-block based coding (16x16 luma plus two 8x8 chroma) * - 1/4 (1/8) pixel accuracy motion compensated prediction * - 4x4 DCT transform * - 128 level linear quantizer * - In loop deblocking filter * - Context-based entropy coding * * @{ */ `````` James Zern committed Feb 16, 2011 28 ``````/*!\file `````` John Koleszar committed May 18, 2010 29 30 `````` * \brief Provides controls common to both the VP8 encoder and decoder. */ `````` John Koleszar committed Nov 06, 2012 31 32 ``````#ifndef VP8_H #define VP8_H `````` Dmitry Kovalev committed Sep 30, 2013 33 34 35 36 `````` #ifdef __cplusplus extern "C" { #endif `````` John Koleszar committed May 18, 2010 37 38 39 40 41 `````` /*!\brief Control functions * * The set of macros define the control functions of VP8 interface */ `````` John Koleszar committed Jul 17, 2012 42 43 44 45 46 47 48 49 ``````enum vp8_com_control_id { VP8_SET_REFERENCE = 1, /**< pass in an external frame into decoder to be used as reference frame */ VP8_COPY_REFERENCE = 2, /**< get a copy of reference frame from the decoder */ VP8_SET_POSTPROC = 3, /**< set the decoder's post processing settings */ VP8_SET_DBG_COLOR_REF_FRAME = 4, /**< set the reference frames to color for each macroblock */ VP8_SET_DBG_COLOR_MB_MODES = 5, /**< set which macro block modes to color */ VP8_SET_DBG_COLOR_B_MODES = 6, /**< set which blocks modes to color */ VP8_SET_DBG_DISPLAY_MV = 7, /**< set which motion vector modes to draw */ `````` John Koleszar committed Mar 13, 2013 50 51 52 53 54 55 `````` /* TODO(jkoleszar): The encoder incorrectly reuses some of these values (5+) * for its control ids. These should be migrated to something like the * VP8_DECODER_CTRL_ID_START range next time we're ready to break the ABI. */ VP9_GET_REFERENCE = 128, /**< get a pointer to a reference frame */ `````` John Koleszar committed Jul 17, 2012 56 `````` VP8_COMMON_CTRL_ID_MAX, `````` John Koleszar committed Nov 06, 2012 57 `````` VP8_DECODER_CTRL_ID_START = 256 `````` John Koleszar committed May 18, 2010 58 59 60 61 62 63 ``````}; /*!\brief post process flags * * The set of macros define VP8 decoder post processing flags */ `````` John Koleszar committed Jul 17, 2012 64 65 66 67 68 69 70 71 72 ``````enum vp8_postproc_level { VP8_NOFILTERING = 0, VP8_DEBLOCK = 1 << 0, VP8_DEMACROBLOCK = 1 << 1, VP8_ADDNOISE = 1 << 2, VP8_DEBUG_TXT_FRAME_INFO = 1 << 3, /**< print frame information */ VP8_DEBUG_TXT_MBLK_MODES = 1 << 4, /**< print macro block modes over each macro block */ VP8_DEBUG_TXT_DC_DIFF = 1 << 5, /**< print dc diff for each macro block */ VP8_DEBUG_TXT_RATE_INFO = 1 << 6, /**< print video rate info (encoder only) */ `````` John Koleszar committed Nov 06, 2012 73 `````` VP8_MFQE = 1 << 10 `````` John Koleszar committed May 18, 2010 74 75 76 77 78 ``````}; /*!\brief post process flags * * This define a structure that describe the post processing settings. For `````` James Zern committed Feb 16, 2011 79 `````` * the best objective measure (using the PSNR metric) set post_proc_flag `````` John Koleszar committed May 18, 2010 80 81 82 `````` * to VP8_DEBLOCK and deblocking_level to 1. */ `````` John Koleszar committed Jul 17, 2012 83 84 85 86 ``````typedef struct vp8_postproc_cfg { int post_proc_flag; /**< the types of post processing to be done, should be combination of "vp8_postproc_level" */ int deblocking_level; /**< the strength of deblocking, valid range [0, 16] */ int noise_level; /**< the strength of additive noise, valid range [0, 16] */ `````` John Koleszar committed May 18, 2010 87 88 89 90 91 92 ``````} vp8_postproc_cfg_t; /*!\brief reference frame type * * The set of macros define the type of VP8 reference frames */ `````` John Koleszar committed Jul 17, 2012 93 94 95 96 ``````typedef enum vpx_ref_frame_type { VP8_LAST_FRAME = 1, VP8_GOLD_FRAME = 2, VP8_ALTR_FRAME = 4 `````` John Koleszar committed May 18, 2010 97 98 99 100 101 102 103 ``````} vpx_ref_frame_type_t; /*!\brief reference frame data struct * * define the data struct to access vp8 reference frames */ `````` John Koleszar committed Jul 17, 2012 104 105 106 ``````typedef struct vpx_ref_frame { vpx_ref_frame_type_t frame_type; /**< which reference frame */ vpx_image_t img; /**< reference frame data in image format */ `````` John Koleszar committed May 18, 2010 107 108 ``````} vpx_ref_frame_t; `````` John Koleszar committed Mar 13, 2013 109 110 111 112 ``````typedef struct vp9_ref_frame { int idx; /**< frame index to get (input) */ vpx_image_t img; /**< img structure to populate (output) */ } vp9_ref_frame_t; `````` John Koleszar committed May 18, 2010 113 `````` `````` James Zern committed Feb 16, 2011 114 ``````/*!\brief vp8 decoder control function parameter type `````` John Koleszar committed May 18, 2010 115 `````` * `````` Fritz Koenig committed Nov 10, 2010 116 `````` * defines the data type for each of VP8 decoder control function requires `````` John Koleszar committed May 18, 2010 117 118 119 120 121 `````` */ VPX_CTRL_USE_TYPE(VP8_SET_REFERENCE, vpx_ref_frame_t *) VPX_CTRL_USE_TYPE(VP8_COPY_REFERENCE, vpx_ref_frame_t *) VPX_CTRL_USE_TYPE(VP8_SET_POSTPROC, vp8_postproc_cfg_t *) `````` Fritz Koenig committed Nov 10, 2010 122 123 124 125 ``````VPX_CTRL_USE_TYPE(VP8_SET_DBG_COLOR_REF_FRAME, int) VPX_CTRL_USE_TYPE(VP8_SET_DBG_COLOR_MB_MODES, int) VPX_CTRL_USE_TYPE(VP8_SET_DBG_COLOR_B_MODES, int) VPX_CTRL_USE_TYPE(VP8_SET_DBG_DISPLAY_MV, int) `````` John Koleszar committed Mar 13, 2013 126 ``````VPX_CTRL_USE_TYPE(VP9_GET_REFERENCE, vp9_ref_frame_t *) `````` John Koleszar committed May 18, 2010 127 128 129 130 `````` /*! @} - end defgroup vp8 */ `````` Dmitry Kovalev committed Sep 30, 2013 131 132 133 134 ``````#ifdef __cplusplus } // extern "C" #endif `````` John Koleszar committed May 18, 2010 135 ``#endif``