1/**
2 * VP8 compatible video decoder
3 *
4 * Copyright (C) 2010 David Conrad
5 * Copyright (C) 2010 Ronald S. Bultje
6 * Copyright (C) 2010 Jason Garrett-Glaser
7 *
8 * This file is part of Libav.
9 *
10 * Libav is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU Lesser General Public
12 * License as published by the Free Software Foundation; either
13 * version 2.1 of the License, or (at your option) any later version.
14 *
15 * Libav is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18 * Lesser General Public License for more details.
19 *
20 * You should have received a copy of the GNU Lesser General Public
21 * License along with Libav; if not, write to the Free Software
22 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23 */
24
25#ifndef AVCODEC_VP8_H
26#define AVCODEC_VP8_H
27
28#include "vp56.h"
29#include "vp56data.h"
30#include "vp8dsp.h"
31#include "h264pred.h"
32
33#define VP8_MAX_QUANT 127
34
35enum dct_token {
36    DCT_0,
37    DCT_1,
38    DCT_2,
39    DCT_3,
40    DCT_4,
41    DCT_CAT1,
42    DCT_CAT2,
43    DCT_CAT3,
44    DCT_CAT4,
45    DCT_CAT5,
46    DCT_CAT6,
47    DCT_EOB,
48
49    NUM_DCT_TOKENS
50};
51
52// used to signal 4x4 intra pred in luma MBs
53#define MODE_I4x4 4
54
55enum inter_mvmode {
56    VP8_MVMODE_ZERO = MODE_I4x4 + 1,
57    VP8_MVMODE_MV,
58    VP8_MVMODE_SPLIT
59};
60
61enum inter_splitmvmode {
62    VP8_SPLITMVMODE_16x8 = 0,    ///< 2 16x8 blocks (vertical)
63    VP8_SPLITMVMODE_8x16,        ///< 2 8x16 blocks (horizontal)
64    VP8_SPLITMVMODE_8x8,         ///< 2x2 blocks of 8x8px each
65    VP8_SPLITMVMODE_4x4,         ///< 4x4 blocks of 4x4px each
66    VP8_SPLITMVMODE_NONE,        ///< (only used in prediction) no split MVs
67};
68
69typedef struct {
70    uint8_t filter_level;
71    uint8_t inner_limit;
72    uint8_t inner_filter;
73} VP8FilterStrength;
74
75typedef struct {
76    uint8_t skip;
77    // todo: make it possible to check for at least (i4x4 or split_mv)
78    // in one op. are others needed?
79    uint8_t mode;
80    uint8_t ref_frame;
81    uint8_t partitioning;
82    VP56mv mv;
83    VP56mv bmv[16];
84} VP8Macroblock;
85
86typedef struct {
87    AVCodecContext *avctx;
88    AVFrame *framep[4];
89    AVFrame *next_framep[4];
90    uint8_t *edge_emu_buffer;
91
92    uint16_t mb_width;   /* number of horizontal MB */
93    uint16_t mb_height;  /* number of vertical MB */
94    int linesize;
95    int uvlinesize;
96
97    uint8_t keyframe;
98    uint8_t deblock_filter;
99    uint8_t mbskip_enabled;
100    uint8_t segment;             ///< segment of the current macroblock
101    uint8_t chroma_pred_mode;    ///< 8x8c pred mode of the current macroblock
102    uint8_t profile;
103    VP56mv mv_min;
104    VP56mv mv_max;
105
106    int8_t sign_bias[4]; ///< one state [0, 1] per ref frame type
107    int ref_count[3];
108
109    /**
110     * Base parameters for segmentation, i.e. per-macroblock parameters.
111     * These must be kept unchanged even if segmentation is not used for
112     * a frame, since the values persist between interframes.
113     */
114    struct {
115        uint8_t enabled;
116        uint8_t absolute_vals;
117        uint8_t update_map;
118        int8_t base_quant[4];
119        int8_t filter_level[4];     ///< base loop filter level
120    } segmentation;
121
122    struct {
123        uint8_t simple;
124        uint8_t level;
125        uint8_t sharpness;
126    } filter;
127
128    VP8Macroblock *macroblocks;
129    VP8FilterStrength *filter_strength;
130
131    uint8_t *intra4x4_pred_mode_top;
132    uint8_t intra4x4_pred_mode_left[4];
133
134    /**
135     * Macroblocks can have one of 4 different quants in a frame when
136     * segmentation is enabled.
137     * If segmentation is disabled, only the first segment's values are used.
138     */
139    struct {
140        // [0] - DC qmul  [1] - AC qmul
141        int16_t luma_qmul[2];
142        int16_t luma_dc_qmul[2];    ///< luma dc-only block quant
143        int16_t chroma_qmul[2];
144    } qmat[4];
145
146    struct {
147        uint8_t enabled;    ///< whether each mb can have a different strength based on mode/ref
148
149        /**
150         * filter strength adjustment for the following macroblock modes:
151         * [0-3] - i16x16 (always zero)
152         * [4]   - i4x4
153         * [5]   - zero mv
154         * [6]   - inter modes except for zero or split mv
155         * [7]   - split mv
156         *  i16x16 modes never have any adjustment
157         */
158        int8_t mode[VP8_MVMODE_SPLIT+1];
159
160        /**
161         * filter strength adjustment for macroblocks that reference:
162         * [0] - intra / VP56_FRAME_CURRENT
163         * [1] - VP56_FRAME_PREVIOUS
164         * [2] - VP56_FRAME_GOLDEN
165         * [3] - altref / VP56_FRAME_GOLDEN2
166         */
167        int8_t ref[4];
168    } lf_delta;
169
170    /**
171     * Cache of the top row needed for intra prediction
172     * 16 for luma, 8 for each chroma plane
173     */
174    uint8_t (*top_border)[16+8+8];
175
176    /**
177     * For coeff decode, we need to know whether the above block had non-zero
178     * coefficients. This means for each macroblock, we need data for 4 luma
179     * blocks, 2 u blocks, 2 v blocks, and the luma dc block, for a total of 9
180     * per macroblock. We keep the last row in top_nnz.
181     */
182    uint8_t (*top_nnz)[9];
183    DECLARE_ALIGNED(8, uint8_t, left_nnz)[9];
184
185    /**
186     * This is the index plus one of the last non-zero coeff
187     * for each of the blocks in the current macroblock.
188     * So, 0 -> no coeffs
189     *     1 -> dc-only (special transform)
190     *     2+-> full transform
191     */
192    DECLARE_ALIGNED(16, uint8_t, non_zero_count_cache)[6][4];
193    VP56RangeCoder c;   ///< header context, includes mb modes and motion vectors
194    DECLARE_ALIGNED(16, DCTELEM, block)[6][4][16];
195    DECLARE_ALIGNED(16, DCTELEM, block_dc)[16];
196    uint8_t intra4x4_pred_mode_mb[16];
197
198    /**
199     * These are all of the updatable probabilities for binary decisions.
200     * They are only implictly reset on keyframes, making it quite likely
201     * for an interframe to desync if a prior frame's header was corrupt
202     * or missing outright!
203     */
204    struct {
205        uint8_t segmentid[3];
206        uint8_t mbskip;
207        uint8_t intra;
208        uint8_t last;
209        uint8_t golden;
210        uint8_t pred16x16[4];
211        uint8_t pred8x8c[3];
212        uint8_t token[4][16][3][NUM_DCT_TOKENS-1];
213        uint8_t mvc[2][19];
214    } prob[2];
215
216    VP8Macroblock *macroblocks_base;
217    int invisible;
218    int update_last;    ///< update VP56_FRAME_PREVIOUS with the current one
219    int update_golden;  ///< VP56_FRAME_NONE if not updated, or which frame to copy if so
220    int update_altref;
221
222    /**
223     * If this flag is not set, all the probability updates
224     * are discarded after this frame is decoded.
225     */
226    int update_probabilities;
227
228    /**
229     * All coefficients are contained in separate arith coding contexts.
230     * There can be 1, 2, 4, or 8 of these after the header context.
231     */
232    int num_coeff_partitions;
233    VP56RangeCoder coeff_partition[8];
234    DSPContext dsp;
235    VP8DSPContext vp8dsp;
236    H264PredContext hpc;
237    vp8_mc_func put_pixels_tab[3][3][3];
238    AVFrame frames[5];
239
240    /**
241     * A list of segmentation_map buffers that are to be free()'ed in
242     * the next decoding iteration. We can't free() them right away
243     * because the map may still be used by subsequent decoding threads.
244     * Unused if frame threading is off.
245     */
246    uint8_t *segmentation_maps[5];
247    int num_maps_to_be_freed;
248    int maps_are_invalid;
249} VP8Context;
250
251#endif /* AVCODEC_VP8_H */
252