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