ffv1: split decoder and encoder
[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 FFmpeg.
7  *
8  * FFmpeg 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  * FFmpeg 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 FFmpeg; 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 /**
27  * @file
28  * FF Video Codec 1 (a lossless codec)
29  */
30
31 #include "libavutil/avassert.h"
32 #include "libavutil/crc.h"
33 #include "libavutil/opt.h"
34 #include "libavutil/imgutils.h"
35 #include "libavutil/pixdesc.h"
36 #include "libavutil/timer.h"
37 #include "avcodec.h"
38 #include "internal.h"
39 #include "dsputil.h"
40 #include "rangecoder.h"
41 #include "golomb.h"
42 #include "mathops.h"
43
44 #ifdef __INTEL_COMPILER
45 #undef av_flatten
46 #define av_flatten
47 #endif
48
49 #define MAX_PLANES 4
50 #define CONTEXT_SIZE 32
51
52 #define MAX_QUANT_TABLES 8
53 #define MAX_CONTEXT_INPUTS 5
54
55 extern const uint8_t ff_log2_run[41];
56
57 typedef struct VlcState {
58     int16_t drift;
59     uint16_t error_sum;
60     int8_t bias;
61     uint8_t count;
62 } VlcState;
63
64 typedef struct PlaneContext {
65     int16_t quant_table[MAX_CONTEXT_INPUTS][256];
66     int quant_table_index;
67     int context_count;
68     uint8_t (*state)[CONTEXT_SIZE];
69     VlcState *vlc_state;
70     uint8_t interlace_bit_state[2];
71 } PlaneContext;
72
73 #define MAX_SLICES 256
74
75 typedef struct FFV1Context {
76     AVClass *class;
77     AVCodecContext *avctx;
78     RangeCoder c;
79     GetBitContext gb;
80     PutBitContext pb;
81     uint64_t rc_stat[256][2];
82     uint64_t (*rc_stat2[MAX_QUANT_TABLES])[32][2];
83     int version;
84     int minor_version;
85     int width, height;
86     int chroma_h_shift, chroma_v_shift;
87     int chroma_planes;
88     int transparency;
89     int flags;
90     int picture_number;
91     AVFrame picture;
92     AVFrame last_picture;
93     int plane_count;
94     int ac;                              ///< 1=range coder <-> 0=golomb rice
95     int ac_byte_count;                   ///< number of bytes used for AC coding
96     PlaneContext plane[MAX_PLANES];
97     int16_t quant_table[MAX_CONTEXT_INPUTS][256];
98     int16_t quant_tables[MAX_QUANT_TABLES][MAX_CONTEXT_INPUTS][256];
99     int context_count[MAX_QUANT_TABLES];
100     uint8_t state_transition[256];
101     uint8_t (*initial_states[MAX_QUANT_TABLES])[32];
102     int run_index;
103     int colorspace;
104     int16_t *sample_buffer;
105     int gob_count;
106     int packed_at_lsb;
107     int ec;
108     int slice_damaged;
109     int key_frame_ok;
110
111     int quant_table_count;
112
113     DSPContext dsp;
114
115     struct FFV1Context *slice_context[MAX_SLICES];
116     int slice_count;
117     int num_v_slices;
118     int num_h_slices;
119     int slice_width;
120     int slice_height;
121     int slice_x;
122     int slice_y;
123     int bits_per_raw_sample;
124 } FFV1Context;
125
126 int ffv1_common_init(AVCodecContext *avctx);
127 int ffv1_init_slice_state(FFV1Context *f, FFV1Context *fs);
128 int ffv1_init_slices_state(FFV1Context *f);
129 int ffv1_init_slice_contexts(FFV1Context *f);
130 int ffv1_allocate_initial_states(FFV1Context *f);
131 void ffv1_clear_slice_state(FFV1Context *f, FFV1Context *fs);
132 int ffv1_common_end(AVCodecContext *avctx);
133
134 static av_always_inline int fold(int diff, int bits)
135 {
136     if (bits == 8)
137         diff = (int8_t)diff;
138     else {
139         diff +=  1 << (bits  - 1);
140         diff &= (1 <<  bits) - 1;
141         diff -=  1 << (bits  - 1);
142     }
143
144     return diff;
145 }
146
147 static inline int predict(int16_t *src, int16_t *last)
148 {
149     const int LT = last[-1];
150     const int T  = last[0];
151     const int L  = src[-1];
152
153     return mid_pred(L, L + T - LT, T);
154 }
155
156 static inline int get_context(PlaneContext *p, int16_t *src,
157                               int16_t *last, int16_t *last2)
158 {
159     const int LT = last[-1];
160     const int T  = last[0];
161     const int RT = last[1];
162     const int L  = src[-1];
163
164     if (p->quant_table[3][127]) {
165         const int TT = last2[0];
166         const int LL = src[-2];
167         return p->quant_table[0][(L - LT) & 0xFF] +
168                p->quant_table[1][(LT - T) & 0xFF] +
169                p->quant_table[2][(T - RT) & 0xFF] +
170                p->quant_table[3][(LL - L) & 0xFF] +
171                p->quant_table[4][(TT - T) & 0xFF];
172     } else
173         return p->quant_table[0][(L - LT) & 0xFF] +
174                p->quant_table[1][(LT - T) & 0xFF] +
175                p->quant_table[2][(T - RT) & 0xFF];
176 }
177
178 static inline void update_vlc_state(VlcState *const state, const int v)
179 {
180     int drift = state->drift;
181     int count = state->count;
182     state->error_sum += FFABS(v);
183     drift            += v;
184
185     if (count == 128) { // FIXME: variable
186         count            >>= 1;
187         drift            >>= 1;
188         state->error_sum >>= 1;
189     }
190     count++;
191
192     if (drift <= -count) {
193         if (state->bias > -128)
194             state->bias--;
195
196         drift += count;
197         if (drift <= -count)
198             drift = -count + 1;
199     } else if (drift > 0) {
200         if (state->bias < 127)
201             state->bias++;
202
203         drift -= count;
204         if (drift > 0)
205             drift = 0;
206     }
207
208     state->drift = drift;
209     state->count = count;
210 }
211
212 #endif /* AVCODEC_FFV1_H */