ffv1: Convert to the new bitstream reader
[ffmpeg.git] / libavcodec / ffv1.h
1 /*
2  * FFV1 codec for libavcodec
3  *
4  * Copyright (c) 2003-2012 Michael Niedermayer <michaelni@gmx.at>
5  *
6  * This file is part of Libav.
7  *
8  * Libav is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public
10  * License as published by the Free Software Foundation; either
11  * version 2.1 of the License, or (at your option) any later version.
12  *
13  * Libav is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with Libav; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21  */
22
23 #ifndef AVCODEC_FFV1_H
24 #define AVCODEC_FFV1_H
25
26 #include <stdint.h>
27
28 #include "avcodec.h"
29 #include "bitstream.h"
30 #include "put_bits.h"
31 #include "rangecoder.h"
32
33 #define MAX_PLANES 4
34 #define CONTEXT_SIZE 32
35
36 #define MAX_QUANT_TABLES 8
37 #define MAX_CONTEXT_INPUTS 5
38
39 #define AC_GOLOMB_RICE          0
40 #define AC_RANGE_DEFAULT_TAB    1
41 #define AC_RANGE_CUSTOM_TAB     2
42
43 extern const uint8_t ff_log2_run[41];
44
45 extern const int8_t ffv1_quant5_10bit[256];
46 extern const int8_t ffv1_quant5[256];
47 extern const int8_t ffv1_quant9_10bit[256];
48 extern const int8_t ffv1_quant11[256];
49 extern const uint8_t ffv1_ver2_state[256];
50
51 typedef struct VlcState {
52     int16_t drift;
53     uint16_t error_sum;
54     int8_t bias;
55     uint8_t count;
56 } VlcState;
57
58 typedef struct PlaneContext {
59     int16_t quant_table[MAX_CONTEXT_INPUTS][256];
60     int quant_table_index;
61     int context_count;
62     uint8_t (*state)[CONTEXT_SIZE];
63     VlcState *vlc_state;
64     uint8_t interlace_bit_state[2];
65 } PlaneContext;
66
67 #define MAX_SLICES 256
68
69 typedef struct FFV1Context {
70     AVClass *class;
71     AVCodecContext *avctx;
72     RangeCoder c;
73     BitstreamContext bc;
74     PutBitContext pb;
75     uint64_t rc_stat[256][2];
76     uint64_t (*rc_stat2[MAX_QUANT_TABLES])[32][2];
77     int version;
78     int minor_version;
79     int width, height;
80     int chroma_planes;
81     int chroma_h_shift, chroma_v_shift;
82     int transparency;
83     int flags;
84     int picture_number;
85     int key_frame;
86     const AVFrame *frame;
87     AVFrame *last_picture;
88
89     AVFrame *cur;
90     int plane_count;
91     int ac;     // 1 = range coder <-> 0 = golomb rice
92     int ac_byte_count;      // number of bytes used for AC coding
93     PlaneContext plane[MAX_PLANES];
94     int16_t quant_table[MAX_CONTEXT_INPUTS][256];
95     int16_t quant_tables[MAX_QUANT_TABLES][MAX_CONTEXT_INPUTS][256];
96     int context_count[MAX_QUANT_TABLES];
97     uint8_t state_transition[256];
98     uint8_t (*initial_states[MAX_QUANT_TABLES])[32];
99     int run_index;
100     int colorspace;
101     int16_t *sample_buffer;
102
103     int ec;
104     int slice_damaged;
105     int key_frame_ok;
106     int context_model;
107
108     int bits_per_raw_sample;
109     int packed_at_lsb;
110
111     int gob_count;
112     int quant_table_count;
113
114     struct FFV1Context *slice_context[MAX_SLICES];
115     int slice_count;
116     int num_v_slices;
117     int num_h_slices;
118     int slice_width;
119     int slice_height;
120     int slice_x;
121     int slice_y;
122 } FFV1Context;
123
124 static av_always_inline int fold(int diff, int bits)
125 {
126     if (bits == 8)
127         diff = (int8_t)diff;
128     else {
129         diff +=  1 << (bits  - 1);
130         diff &= (1 <<  bits) - 1;
131         diff -=  1 << (bits  - 1);
132     }
133
134     return diff;
135 }
136
137 static inline int predict(int16_t *src, int16_t *last)
138 {
139     const int LT = last[-1];
140     const int T  = last[0];
141     const int L  = src[-1];
142
143     return mid_pred(L, L + T - LT, T);
144 }
145
146 static inline int get_context(PlaneContext *p, int16_t *src,
147                               int16_t *last, int16_t *last2)
148 {
149     const int LT = last[-1];
150     const int T  = last[0];
151     const int RT = last[1];
152     const int L  = src[-1];
153
154     if (p->quant_table[3][127]) {
155         const int TT = last2[0];
156         const int LL = src[-2];
157         return p->quant_table[0][(L - LT) & 0xFF] +
158                p->quant_table[1][(LT - T) & 0xFF] +
159                p->quant_table[2][(T - RT) & 0xFF] +
160                p->quant_table[3][(LL - L) & 0xFF] +
161                p->quant_table[4][(TT - T) & 0xFF];
162     } else
163         return p->quant_table[0][(L - LT) & 0xFF] +
164                p->quant_table[1][(LT - T) & 0xFF] +
165                p->quant_table[2][(T - RT) & 0xFF];
166 }
167
168 static inline void update_vlc_state(VlcState *const state, const int v)
169 {
170     int drift = state->drift;
171     int count = state->count;
172     state->error_sum += FFABS(v);
173     drift            += v;
174
175     if (count == 128) { // FIXME: variable
176         count            >>= 1;
177         drift            >>= 1;
178         state->error_sum >>= 1;
179     }
180     count++;
181
182     if (drift <= -count) {
183         if (state->bias > -128)
184             state->bias--;
185
186         drift += count;
187         if (drift <= -count)
188             drift = -count + 1;
189     } else if (drift > 0) {
190         if (state->bias < 127)
191             state->bias++;
192
193         drift -= count;
194         if (drift > 0)
195             drift = 0;
196     }
197
198     state->drift = drift;
199     state->count = count;
200 }
201
202 int ffv1_common_init(AVCodecContext *avctx);
203 int ffv1_init_slice_state(FFV1Context *f, FFV1Context *fs);
204 int ffv1_init_slice_contexts(FFV1Context *f);
205 int ffv1_allocate_initial_states(FFV1Context *f);
206 void ffv1_clear_slice_state(FFV1Context *f, FFV1Context *fs);
207 int ffv1_close(AVCodecContext *avctx);
208
209 #endif /* AVCODEC_FFV1_H */