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.
12 /*!\defgroup vp8_decoder WebM VP8 Decoder
18 * \brief Provides definitions for using the VP8 algorithm within the vpx Decoder
28 /* Include controls common to both the encoder and decoder */
31 /*!\name Algorithm interface for VP8
33 * This interface provides the capability to decode raw VP8 streams, as would
34 * be found in AVI files and other non-Flash uses.
37 extern vpx_codec_iface_t vpx_codec_vp8_dx_algo;
38 extern vpx_codec_iface_t *vpx_codec_vp8_dx(void);
40 /* TODO(jkoleszar): These move to VP9 in a later patch set. */
41 extern vpx_codec_iface_t vpx_codec_vp9_dx_algo;
42 extern vpx_codec_iface_t *vpx_codec_vp9_dx(void);
43 /*!@} - end algorithm interface member group*/
46 /*!\enum vp8_dec_control_id
47 * \brief VP8 decoder control functions
49 * This set of macros define the control functions available for the VP8
52 * \sa #vpx_codec_control
54 enum vp8_dec_control_id {
55 /** control function to get info on which reference frames were updated
58 VP8D_GET_LAST_REF_UPDATES = VP8_DECODER_CTRL_ID_START,
60 /** check if the indicated frame is corrupted */
61 VP8D_GET_FRAME_CORRUPTED,
63 /** control function to get info on which reference frames were used
66 VP8D_GET_LAST_REF_USED,
68 /** decryption function to decrypt encoded buffer data immediately
69 * before decoding. Takes a vpx_decrypt_init, which contains
70 * a callback function and opaque context pointer.
73 VP8D_SET_DECRYPTOR = VPXD_SET_DECRYPTOR,
75 /** control function to get the display dimensions for the current frame. */
76 VP9D_GET_DISPLAY_SIZE,
78 /** control function to get the bit depth of the stream. */
82 VP9_INVERT_TILE_DECODE_ORDER,
84 VP8_DECODER_CTRL_ID_MAX
87 /** Decrypt n bytes of data from input -> output, using the decrypt_state
88 * passed in VPXD_SET_DECRYPTOR.
90 typedef void (*vpx_decrypt_cb)(void *decrypt_state, const unsigned char *input,
91 unsigned char *output, int count);
93 /*!\brief Structure to hold decryption state
95 * Defines a structure to hold the decryption state and access function.
97 typedef struct vpx_decrypt_init {
98 /*! Decrypt callback. */
99 vpx_decrypt_cb decrypt_cb;
101 /*! Decryption state. */
105 /*!\brief A deprecated alias for vpx_decrypt_init.
107 typedef vpx_decrypt_init vp8_decrypt_init;
110 /*!\brief VP8 decoder control function parameter type
112 * Defines the data types that VP8D control functions take. Note that
113 * additional common controls are defined in vp8.h
118 VPX_CTRL_USE_TYPE(VP8D_GET_LAST_REF_UPDATES, int *)
119 VPX_CTRL_USE_TYPE(VP8D_GET_FRAME_CORRUPTED, int *)
120 VPX_CTRL_USE_TYPE(VP8D_GET_LAST_REF_USED, int *)
121 VPX_CTRL_USE_TYPE(VPXD_SET_DECRYPTOR, vpx_decrypt_init *)
122 VPX_CTRL_USE_TYPE(VP8D_SET_DECRYPTOR, vpx_decrypt_init *)
123 VPX_CTRL_USE_TYPE(VP9D_GET_DISPLAY_SIZE, int *)
124 VPX_CTRL_USE_TYPE(VP9D_GET_BIT_DEPTH, unsigned int *)
125 VPX_CTRL_USE_TYPE(VP9_INVERT_TILE_DECODE_ORDER, int)
127 /*! @} - end defgroup vp8_decoder */
133 #endif // VPX_VP8DX_H_