vp8dx.h 5.81 KB
Newer Older
John Koleszar's avatar
John Koleszar committed
1
/*
2
 *  Copyright (c) 2010 The WebM project authors. All Rights Reserved.
John Koleszar's avatar
John Koleszar committed
3
 *
4
 *  Use of this source code is governed by a BSD-style license
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
7
 *  in the file PATENTS.  All contributing project authors may
8
 *  be found in the AUTHORS file in the root of the source tree.
John Koleszar's avatar
John Koleszar committed
9
10
 */

11
/*!\defgroup vp8_decoder WebM VP8/VP9 Decoder
John Koleszar's avatar
John Koleszar committed
12
13
14
15
 * \ingroup vp8
 *
 * @{
 */
James Zern's avatar
James Zern committed
16
/*!\file
17
 * \brief Provides definitions for using VP8 or VP9 within the vpx Decoder
John Koleszar's avatar
John Koleszar committed
18
19
 *        interface.
 */
James Zern's avatar
James Zern committed
20
21
#ifndef VPX_VP8DX_H_
#define VPX_VP8DX_H_
22
23
24
25

#ifdef __cplusplus
extern "C" {
#endif
John Koleszar's avatar
John Koleszar committed
26

27
28
29
/* Include controls common to both the encoder and decoder */
#include "./vp8.h"

Jingning Han's avatar
Jingning Han committed
30
31
32
33
34
/*!\name Algorithm interface for VP10
 *
 * This interface provides the capability to decode VP10 streams.
 * @{
 */
clang-format's avatar
clang-format committed
35
extern vpx_codec_iface_t vpx_codec_vp10_dx_algo;
Jingning Han's avatar
Jingning Han committed
36
37
extern vpx_codec_iface_t *vpx_codec_vp10_dx(void);
/*!@} - end algorithm interface member group*/
John Koleszar's avatar
John Koleszar committed
38

Adrian Grange's avatar
Adrian Grange committed
39
40
/*!\enum vp8_dec_control_id
 * \brief VP8 decoder control functions
41
 *
42
43
44
45
 * This set of macros define the control functions available for the VP8
 * decoder interface.
 *
 * \sa #vpx_codec_control
46
 */
John Koleszar's avatar
John Koleszar committed
47
48
49
50
51
52
53
54
55
enum vp8_dec_control_id {
  /** control function to get info on which reference frames were updated
   *  by the last decode
   */
  VP8D_GET_LAST_REF_UPDATES = VP8_DECODER_CTRL_ID_START,

  /** check if the indicated frame is corrupted */
  VP8D_GET_FRAME_CORRUPTED,

John Koleszar's avatar
John Koleszar committed
56
57
58
59
60
  /** control function to get info on which reference frames were used
   *  by the last decode
   */
  VP8D_GET_LAST_REF_USED,

61
  /** decryption function to decrypt encoded buffer data immediately
62
   * before decoding. Takes a vpx_decrypt_init, which contains
63
   * a callback function and opaque context pointer.
64
   */
65
66
  VPXD_SET_DECRYPTOR,
  VP8D_SET_DECRYPTOR = VPXD_SET_DECRYPTOR,
67

68
69
70
71
72
73
74
75
  /** control function to get the dimensions that the current frame is decoded
   * at. This may be different to the intended display size for the frame as
   * specified in the wrapper or frame header (see VP9D_GET_DISPLAY_SIZE). */
  VP9D_GET_FRAME_SIZE,

  /** control function to get the current frame's intended display dimensions
   * (as specified in the wrapper or frame header). This may be different to
   * the decoded dimensions of this frame (see VP9D_GET_FRAME_SIZE). */
76
77
  VP9D_GET_DISPLAY_SIZE,

78
79
80
  /** control function to get the bit depth of the stream. */
  VP9D_GET_BIT_DEPTH,

81
82
83
84
85
86
87
  /** control function to set the byte alignment of the planes in the reference
   * buffers. Valid values are power of 2, from 32 to 1024. A value of 0 sets
   * legacy alignment. I.e. Y plane is aligned to 32 bytes, U plane directly
   * follows Y plane, and V plane directly follows U plane. Default value is 0.
   */
  VP9_SET_BYTE_ALIGNMENT,

88
89
90
91
92
93
94
95
  /** control function to invert the decoding order to from right to left. The
   * function is used in a test to confirm the decoding independence of tile
   * columns. The function may be used in application where this order
   * of decoding is desired.
   *
   * TODO(yaowu): Rework the unit test that uses this control, and in a future
   *              release, this test-only control shall be removed.
   */
96
97
  VP9_INVERT_TILE_DECODE_ORDER,

98
99
100
101
102
103
104
  /** control function to set the skip loop filter flag. Valid values are
   * integers. The decoder will skip the loop filter when its value is set to
   * nonzero. If the loop filter is skipped the decoder may accumulate decode
   * artifacts. The default value is 0.
   */
  VP9_SET_SKIP_LOOP_FILTER,

105
106
107
108
109
110
111
112
113
114
  VP8_DECODER_CTRL_ID_MAX,

  /** control function to set the range of tile decoding. A value that is
   * greater and equal to zero indicates only the specific row/column is
   * decoded. A value that is -1 indicates the whole row/column is decoded.
   * A special case is both values are -1 that means the whole frame is
   * decoded.
   */
  VP10_SET_DECODE_TILE_ROW,
  VP10_SET_DECODE_TILE_COL
John Koleszar's avatar
John Koleszar committed
115
};
116

117
118
119
120
121
122
/** Decrypt n bytes of data from input -> output, using the decrypt_state
 *  passed in VPXD_SET_DECRYPTOR.
 */
typedef void (*vpx_decrypt_cb)(void *decrypt_state, const unsigned char *input,
                               unsigned char *output, int count);

Adrian Grange's avatar
Adrian Grange committed
123
124
125
126
/*!\brief Structure to hold decryption state
 *
 * Defines a structure to hold the decryption state and access function.
 */
127
typedef struct vpx_decrypt_init {
clang-format's avatar
clang-format committed
128
129
  /*! Decrypt callback. */
  vpx_decrypt_cb decrypt_cb;
130

clang-format's avatar
clang-format committed
131
132
  /*! Decryption state. */
  void *decrypt_state;
133
134
135
136
137
138
} vpx_decrypt_init;

/*!\brief A deprecated alias for vpx_decrypt_init.
 */
typedef vpx_decrypt_init vp8_decrypt_init;

139
/*!\cond */
140
/*!\brief VP8 decoder control function parameter type
141
 *
142
 * Defines the data types that VP8D control functions take. Note that
143
144
145
146
 * additional common controls are defined in vp8.h
 *
 */

clang-format's avatar
clang-format committed
147
VPX_CTRL_USE_TYPE(VP8D_GET_LAST_REF_UPDATES, int *)
148
#define VPX_CTRL_VP8D_GET_LAST_REF_UPDATES
clang-format's avatar
clang-format committed
149
VPX_CTRL_USE_TYPE(VP8D_GET_FRAME_CORRUPTED, int *)
150
#define VPX_CTRL_VP8D_GET_FRAME_CORRUPTED
clang-format's avatar
clang-format committed
151
VPX_CTRL_USE_TYPE(VP8D_GET_LAST_REF_USED, int *)
152
#define VPX_CTRL_VP8D_GET_LAST_REF_USED
clang-format's avatar
clang-format committed
153
VPX_CTRL_USE_TYPE(VPXD_SET_DECRYPTOR, vpx_decrypt_init *)
154
#define VPX_CTRL_VPXD_SET_DECRYPTOR
clang-format's avatar
clang-format committed
155
VPX_CTRL_USE_TYPE(VP8D_SET_DECRYPTOR, vpx_decrypt_init *)
156
#define VPX_CTRL_VP8D_SET_DECRYPTOR
clang-format's avatar
clang-format committed
157
VPX_CTRL_USE_TYPE(VP9D_GET_DISPLAY_SIZE, int *)
158
#define VPX_CTRL_VP9D_GET_DISPLAY_SIZE
clang-format's avatar
clang-format committed
159
VPX_CTRL_USE_TYPE(VP9D_GET_BIT_DEPTH, unsigned int *)
160
#define VPX_CTRL_VP9D_GET_BIT_DEPTH
clang-format's avatar
clang-format committed
161
VPX_CTRL_USE_TYPE(VP9D_GET_FRAME_SIZE, int *)
162
#define VPX_CTRL_VP9D_GET_FRAME_SIZE
163
VPX_CTRL_USE_TYPE(VP9_INVERT_TILE_DECODE_ORDER, int)
164
#define VPX_CTRL_VP9_INVERT_TILE_DECODE_ORDER
clang-format's avatar
clang-format committed
165
VPX_CTRL_USE_TYPE(VP10_SET_DECODE_TILE_ROW, int)
166
#define VPX_CTRL_VP10_SET_DECODE_TILE_ROW
clang-format's avatar
clang-format committed
167
VPX_CTRL_USE_TYPE(VP10_SET_DECODE_TILE_COL, int)
168
#define VPX_CTRL_VP10_SET_DECODE_TILE_COL
169
/*!\endcond */
John Koleszar's avatar
John Koleszar committed
170
171
/*! @} - end defgroup vp8_decoder */

172
173
174
#ifdef __cplusplus
}  // extern "C"
#endif
John Koleszar's avatar
John Koleszar committed
175

James Zern's avatar
James Zern committed
176
#endif  // VPX_VP8DX_H_