vp8dx.h 5.38 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
 */

12
/*!\defgroup vp8_decoder WebM VP8/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 VP8 or VP9 within the aom Decoder
John Koleszar's avatar
John Koleszar committed
19 20
 *        interface.
 */
James Zern's avatar
James Zern committed
21 22
#ifndef VPX_VP8DX_H_
#define VPX_VP8DX_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 41
/*!\enum vp8_dec_control_id
 * \brief VP8 decoder control functions
42
 *
43 44 45
 * This set of macros define the control functions available for the VP8
 * 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 52 53 54 55 56
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
57 58 59 60 61
  /** control function to get info on which reference frames were used
   *  by the last decode
   */
  VP8D_GET_LAST_REF_USED,

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
   */
66 67
  VPXD_SET_DECRYPTOR,
  VP8D_SET_DECRYPTOR = VPXD_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,

John Koleszar's avatar
John Koleszar committed
106 107
  VP8_DECODER_CTRL_ID_MAX
};
108

109 110 111
/** Decrypt n bytes of data from input -> output, using the decrypt_state
 *  passed in VPXD_SET_DECRYPTOR.
 */
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 */
132
/*!\brief VP8 decoder control function parameter type
133
 *
134
 * Defines the data types that VP8D control functions take. Note that
135 136 137 138
 * additional common controls are defined in vp8.h
 *
 */

clang-format's avatar
clang-format committed
139
VPX_CTRL_USE_TYPE(VP8D_GET_LAST_REF_UPDATES, int *)
140
#define VPX_CTRL_VP8D_GET_LAST_REF_UPDATES
clang-format's avatar
clang-format committed
141
VPX_CTRL_USE_TYPE(VP8D_GET_FRAME_CORRUPTED, int *)
142
#define VPX_CTRL_VP8D_GET_FRAME_CORRUPTED
clang-format's avatar
clang-format committed
143
VPX_CTRL_USE_TYPE(VP8D_GET_LAST_REF_USED, int *)
144
#define VPX_CTRL_VP8D_GET_LAST_REF_USED
Adrian Grange's avatar
Adrian Grange committed
145
VPX_CTRL_USE_TYPE(VPXD_SET_DECRYPTOR, aom_decrypt_init *)
146
#define VPX_CTRL_VPXD_SET_DECRYPTOR
Adrian Grange's avatar
Adrian Grange committed
147
VPX_CTRL_USE_TYPE(VP8D_SET_DECRYPTOR, aom_decrypt_init *)
148
#define VPX_CTRL_VP8D_SET_DECRYPTOR
clang-format's avatar
clang-format committed
149
VPX_CTRL_USE_TYPE(VP9D_GET_DISPLAY_SIZE, int *)
150
#define VPX_CTRL_VP9D_GET_DISPLAY_SIZE
clang-format's avatar
clang-format committed
151
VPX_CTRL_USE_TYPE(VP9D_GET_BIT_DEPTH, unsigned int *)
152
#define VPX_CTRL_VP9D_GET_BIT_DEPTH
clang-format's avatar
clang-format committed
153
VPX_CTRL_USE_TYPE(VP9D_GET_FRAME_SIZE, int *)
154
#define VPX_CTRL_VP9D_GET_FRAME_SIZE
155
VPX_CTRL_USE_TYPE(VP9_INVERT_TILE_DECODE_ORDER, int)
156
#define VPX_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

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