vp8dx.h 5.39 KB
Newer Older
John Koleszar's avatar
John Koleszar committed
1
/*
2
 * Copyright (c) 2016, Alliance for Open Media. All rights reserved
John Koleszar's avatar
John Koleszar committed
3
 *
4
5
6
7
8
9
 * This source code is subject to the terms of the BSD 2 Clause License and
 * the Alliance for Open Media Patent License 1.0. If the BSD 2 Clause License
 * was not distributed with this source code in the LICENSE file, you can
 * obtain it at www.aomedia.org/license/software. If the Alliance for Open
 * Media Patent License 1.0 was not distributed with this source code in the
 * PATENTS file, you can obtain it at www.aomedia.org/license/patent.
John Koleszar's avatar
John Koleszar committed
10
11
 */

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

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

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

31
/*!\name Algorithm interface for AV1
Jingning Han's avatar
Jingning Han committed
32
 *
33
 * This interface provides the capability to decode AV1 streams.
Jingning Han's avatar
Jingning Han committed
34
35
 * @{
 */
36
37
extern aom_codec_iface_t aom_codec_av1_dx_algo;
extern aom_codec_iface_t *aom_codec_av1_dx(void);
Jingning Han's avatar
Jingning Han committed
38
/*!@} - end algorithm interface member group*/
John Koleszar's avatar
John Koleszar committed
39

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

  /** check if the indicated frame is corrupted */
Adrian Grange's avatar
Adrian Grange committed
55
  AOMD_GET_FRAME_CORRUPTED,
John Koleszar's avatar
John Koleszar committed
56

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

62
  /** decryption function to decrypt encoded buffer data immediately
Adrian Grange's avatar
Adrian Grange committed
63
   * before decoding. Takes a aom_decrypt_init, which contains
64
   * a callback function and opaque context pointer.
65
   */
Adrian Grange's avatar
Adrian Grange committed
66
  AOMD_SET_DECRYPTOR,
Adrian Grange's avatar
Adrian Grange committed
67
 // AOMD_SET_DECRYPTOR = AOMD_SET_DECRYPTOR,
68

69
70
71
72
73
74
75
76
  /** 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). */
77
78
  VP9D_GET_DISPLAY_SIZE,

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

82
83
84
85
86
87
88
  /** 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,

89
90
91
92
93
94
95
96
  /** 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.
   */
97
98
  VP9_INVERT_TILE_DECODE_ORDER,

99
100
101
102
103
104
105
  /** 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,

Adrian Grange's avatar
Adrian Grange committed
106
  AOM_DECODER_CTRL_ID_MAX
John Koleszar's avatar
John Koleszar committed
107
};
108

109
/** Decrypt n bytes of data from input -> output, using the decrypt_state
Adrian Grange's avatar
Adrian Grange committed
110
 *  passed in AOMD_SET_DECRYPTOR.
111
 */
Adrian Grange's avatar
Adrian Grange committed
112
typedef void (*aom_decrypt_cb)(void *decrypt_state, const unsigned char *input,
113
114
                               unsigned char *output, int count);

Adrian Grange's avatar
Adrian Grange committed
115
116
117
118
/*!\brief Structure to hold decryption state
 *
 * Defines a structure to hold the decryption state and access function.
 */
Adrian Grange's avatar
Adrian Grange committed
119
typedef struct aom_decrypt_init {
clang-format's avatar
clang-format committed
120
  /*! Decrypt callback. */
Adrian Grange's avatar
Adrian Grange committed
121
  aom_decrypt_cb decrypt_cb;
122

clang-format's avatar
clang-format committed
123
124
  /*! Decryption state. */
  void *decrypt_state;
Adrian Grange's avatar
Adrian Grange committed
125
} aom_decrypt_init;
126

Adrian Grange's avatar
Adrian Grange committed
127
/*!\brief A deprecated alias for aom_decrypt_init.
128
 */
Adrian Grange's avatar
Adrian Grange committed
129
typedef aom_decrypt_init vp8_decrypt_init;
130

131
/*!\cond */
Adrian Grange's avatar
Adrian Grange committed
132
/*!\brief AOM decoder control function parameter type
133
 *
Adrian Grange's avatar
Adrian Grange committed
134
 * Defines the data types that AOMD control functions take. Note that
135
136
137
138
 * additional common controls are defined in vp8.h
 *
 */

Adrian Grange's avatar
Adrian Grange committed
139
140
141
142
143
144
AOM_CTRL_USE_TYPE(AOMD_GET_LAST_REF_UPDATES, int *)
#define AOM_CTRL_AOMD_GET_LAST_REF_UPDATES
AOM_CTRL_USE_TYPE(AOMD_GET_FRAME_CORRUPTED, int *)
#define AOM_CTRL_AOMD_GET_FRAME_CORRUPTED
AOM_CTRL_USE_TYPE(AOMD_GET_LAST_REF_USED, int *)
#define AOM_CTRL_AOMD_GET_LAST_REF_USED
Adrian Grange's avatar
Adrian Grange committed
145
146
AOM_CTRL_USE_TYPE(AOMD_SET_DECRYPTOR, aom_decrypt_init *)
#define AOM_CTRL_AOMD_SET_DECRYPTOR
Adrian Grange's avatar
Adrian Grange committed
147
148
//AOM_CTRL_USE_TYPE(AOMD_SET_DECRYPTOR, aom_decrypt_init *)
//#define AOM_CTRL_AOMD_SET_DECRYPTOR
Adrian Grange's avatar
Adrian Grange committed
149
150
151
152
153
154
155
156
AOM_CTRL_USE_TYPE(VP9D_GET_DISPLAY_SIZE, int *)
#define AOM_CTRL_VP9D_GET_DISPLAY_SIZE
AOM_CTRL_USE_TYPE(VP9D_GET_BIT_DEPTH, unsigned int *)
#define AOM_CTRL_VP9D_GET_BIT_DEPTH
AOM_CTRL_USE_TYPE(VP9D_GET_FRAME_SIZE, int *)
#define AOM_CTRL_VP9D_GET_FRAME_SIZE
AOM_CTRL_USE_TYPE(VP9_INVERT_TILE_DECODE_ORDER, int)
#define AOM_CTRL_VP9_INVERT_TILE_DECODE_ORDER
157

158
/*!\endcond */
John Koleszar's avatar
John Koleszar committed
159
160
/*! @} - end defgroup vp8_decoder */

161
162
163
#ifdef __cplusplus
}  // extern "C"
#endif
John Koleszar's avatar
John Koleszar committed
164

Adrian Grange's avatar
Adrian Grange committed
165
#endif  // AOM_AOMDX_H_