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