michael@0: /*
michael@0:  *  Copyright (c) 2010 The WebM project authors. All Rights Reserved.
michael@0:  *
michael@0:  *  Use of this source code is governed by a BSD-style license
michael@0:  *  that can be found in the LICENSE file in the root of the source
michael@0:  *  tree. An additional intellectual property rights grant can be found
michael@0:  *  in the file PATENTS.  All contributing project authors may
michael@0:  *  be found in the AUTHORS file in the root of the source tree.
michael@0:  */
michael@0: 
michael@0: /*!\defgroup vp8 VP8
michael@0:  * \ingroup codecs
michael@0:  * VP8 is vpx's newest video compression algorithm that uses motion
michael@0:  * compensated prediction, Discrete Cosine Transform (DCT) coding of the
michael@0:  * prediction error signal and context dependent entropy coding techniques
michael@0:  * based on arithmetic principles. It features:
michael@0:  *  - YUV 4:2:0 image format
michael@0:  *  - Macro-block based coding (16x16 luma plus two 8x8 chroma)
michael@0:  *  - 1/4 (1/8) pixel accuracy motion compensated prediction
michael@0:  *  - 4x4 DCT transform
michael@0:  *  - 128 level linear quantizer
michael@0:  *  - In loop deblocking filter
michael@0:  *  - Context-based entropy coding
michael@0:  *
michael@0:  * @{
michael@0:  */
michael@0: /*!\file
michael@0:  * \brief Provides controls common to both the VP8 encoder and decoder.
michael@0:  */
michael@0: #ifndef VP8_H
michael@0: #define VP8_H
michael@0: 
michael@0: #include "./vpx_codec.h"
michael@0: #include "./vpx_image.h"
michael@0: 
michael@0: #ifdef __cplusplus
michael@0: extern "C" {
michael@0: #endif
michael@0: 
michael@0: /*!\brief Control functions
michael@0:  *
michael@0:  * The set of macros define the control functions of VP8 interface
michael@0:  */
michael@0: enum vp8_com_control_id {
michael@0:   VP8_SET_REFERENCE           = 1,    /**< pass in an external frame into decoder to be used as reference frame */
michael@0:   VP8_COPY_REFERENCE          = 2,    /**< get a copy of reference frame from the decoder */
michael@0:   VP8_SET_POSTPROC            = 3,    /**< set the decoder's post processing settings  */
michael@0:   VP8_SET_DBG_COLOR_REF_FRAME = 4,    /**< set the reference frames to color for each macroblock */
michael@0:   VP8_SET_DBG_COLOR_MB_MODES  = 5,    /**< set which macro block modes to color */
michael@0:   VP8_SET_DBG_COLOR_B_MODES   = 6,    /**< set which blocks modes to color */
michael@0:   VP8_SET_DBG_DISPLAY_MV      = 7,    /**< set which motion vector modes to draw */
michael@0: 
michael@0:   /* TODO(jkoleszar): The encoder incorrectly reuses some of these values (5+)
michael@0:    * for its control ids. These should be migrated to something like the
michael@0:    * VP8_DECODER_CTRL_ID_START range next time we're ready to break the ABI.
michael@0:    */
michael@0:   VP9_GET_REFERENCE           = 128,  /**< get a pointer to a reference frame */
michael@0:   VP8_COMMON_CTRL_ID_MAX,
michael@0:   VP8_DECODER_CTRL_ID_START   = 256
michael@0: };
michael@0: 
michael@0: /*!\brief post process flags
michael@0:  *
michael@0:  * The set of macros define VP8 decoder post processing flags
michael@0:  */
michael@0: enum vp8_postproc_level {
michael@0:   VP8_NOFILTERING             = 0,
michael@0:   VP8_DEBLOCK                 = 1 << 0,
michael@0:   VP8_DEMACROBLOCK            = 1 << 1,
michael@0:   VP8_ADDNOISE                = 1 << 2,
michael@0:   VP8_DEBUG_TXT_FRAME_INFO    = 1 << 3, /**< print frame information */
michael@0:   VP8_DEBUG_TXT_MBLK_MODES    = 1 << 4, /**< print macro block modes over each macro block */
michael@0:   VP8_DEBUG_TXT_DC_DIFF       = 1 << 5, /**< print dc diff for each macro block */
michael@0:   VP8_DEBUG_TXT_RATE_INFO     = 1 << 6, /**< print video rate info (encoder only) */
michael@0:   VP8_MFQE                    = 1 << 10
michael@0: };
michael@0: 
michael@0: /*!\brief post process flags
michael@0:  *
michael@0:  * This define a structure that describe the post processing settings. For
michael@0:  * the best objective measure (using the PSNR metric) set post_proc_flag
michael@0:  * to VP8_DEBLOCK and deblocking_level to 1.
michael@0:  */
michael@0: 
michael@0: typedef struct vp8_postproc_cfg {
michael@0:   int post_proc_flag;         /**< the types of post processing to be done, should be combination of "vp8_postproc_level" */
michael@0:   int deblocking_level;       /**< the strength of deblocking, valid range [0, 16] */
michael@0:   int noise_level;            /**< the strength of additive noise, valid range [0, 16] */
michael@0: } vp8_postproc_cfg_t;
michael@0: 
michael@0: /*!\brief reference frame type
michael@0:  *
michael@0:  * The set of macros define the type of VP8 reference frames
michael@0:  */
michael@0: typedef enum vpx_ref_frame_type {
michael@0:   VP8_LAST_FRAME = 1,
michael@0:   VP8_GOLD_FRAME = 2,
michael@0:   VP8_ALTR_FRAME = 4
michael@0: } vpx_ref_frame_type_t;
michael@0: 
michael@0: /*!\brief reference frame data struct
michael@0:  *
michael@0:  * Define the data struct to access vp8 reference frames.
michael@0:  */
michael@0: typedef struct vpx_ref_frame {
michael@0:   vpx_ref_frame_type_t  frame_type;   /**< which reference frame */
michael@0:   vpx_image_t           img;          /**< reference frame data in image format */
michael@0: } vpx_ref_frame_t;
michael@0: 
michael@0: /*!\brief VP9 specific reference frame data struct
michael@0:  *
michael@0:  * Define the data struct to access vp9 reference frames.
michael@0:  */
michael@0: typedef struct vp9_ref_frame {
michael@0:   int idx; /**< frame index to get (input) */
michael@0:   vpx_image_t  img; /**< img structure to populate (output) */
michael@0: } vp9_ref_frame_t;
michael@0: 
michael@0: /*!\brief vp8 decoder control function parameter type
michael@0:  *
michael@0:  * defines the data type for each of VP8 decoder control function requires
michael@0:  */
michael@0: VPX_CTRL_USE_TYPE(VP8_SET_REFERENCE,           vpx_ref_frame_t *)
michael@0: VPX_CTRL_USE_TYPE(VP8_COPY_REFERENCE,          vpx_ref_frame_t *)
michael@0: VPX_CTRL_USE_TYPE(VP8_SET_POSTPROC,            vp8_postproc_cfg_t *)
michael@0: VPX_CTRL_USE_TYPE(VP8_SET_DBG_COLOR_REF_FRAME, int)
michael@0: VPX_CTRL_USE_TYPE(VP8_SET_DBG_COLOR_MB_MODES,  int)
michael@0: VPX_CTRL_USE_TYPE(VP8_SET_DBG_COLOR_B_MODES,   int)
michael@0: VPX_CTRL_USE_TYPE(VP8_SET_DBG_DISPLAY_MV,      int)
michael@0: VPX_CTRL_USE_TYPE(VP9_GET_REFERENCE,           vp9_ref_frame_t *)
michael@0: 
michael@0: /*! @} - end defgroup vp8 */
michael@0: 
michael@0: #ifdef __cplusplus
michael@0: }  // extern "C"
michael@0: #endif
michael@0: 
michael@0: #endif