FFmpeg
ffv1.h
Go to the documentation of this file.
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 "avcodec.h"
32 #include "get_bits.h"
33 #include "mathops.h"
34 #include "progressframe.h"
35 #include "put_bits.h"
36 #include "rangecoder.h"
37 
38 #ifdef __INTEL_COMPILER
39 #undef av_flatten
40 #define av_flatten
41 #endif
42 
43 #define MAX_PLANES 4
44 #define CONTEXT_SIZE 32
45 
46 #define MAX_QUANT_TABLES 8
47 #define MAX_QUANT_TABLE_SIZE 256
48 #define MAX_QUANT_TABLE_MASK (MAX_QUANT_TABLE_SIZE - 1)
49 #define MAX_CONTEXT_INPUTS 5
50 
51 #define AC_GOLOMB_RICE 0
52 #define AC_RANGE_DEFAULT_TAB 1
53 #define AC_RANGE_CUSTOM_TAB 2
54 #define AC_RANGE_DEFAULT_TAB_FORCE -2
55 
56 typedef struct VlcState {
57  uint32_t error_sum;
58  int16_t drift;
59  int8_t bias;
60  uint8_t count;
61 } VlcState;
62 
63 typedef struct PlaneContext {
66  uint8_t (*state)[CONTEXT_SIZE];
68 } PlaneContext;
69 
70 #define MAX_SLICES 1024
71 
72 typedef struct FFV1SliceContext {
73  int16_t *sample_buffer;
75 
78  int slice_x;
79  int slice_y;
80  int sx, sy;
81 
82  int run_index;
86 
87  // RefStruct reference, array of MAX_PLANES elements
91 
92  int ac_byte_count; ///< number of bytes used for AC coding
93 
94  union {
95  // decoder-only
96  struct {
99  };
100 
101  // encoder-only
102  struct {
103  uint64_t rc_stat[256][2];
104  uint64_t (*rc_stat2[MAX_QUANT_TABLES])[32][2];
105  };
106  };
108 
109 typedef struct FFV1Context {
110  AVClass *class;
112  uint64_t rc_stat[256][2];
113  uint64_t (*rc_stat2[MAX_QUANT_TABLES])[32][2];
114  int version;
116  int width, height;
120  int flags;
124  uint32_t crcref;
125 
128  int ac; ///< 1=range coder <-> 0=golomb rice
131  uint8_t state_transition[256];
134 
135  int use32bit;
136 
137  int ec;
138  int intra;
141  int qtable;
142 
145 
148 
153 
155  /* RefStruct object, per-slice damage flags shared between frame threads.
156  *
157  * After a frame thread marks some slice as finished with
158  * ff_progress_frame_report(), the corresponding array element must not be
159  * accessed by this thread anymore, as from then on it is owned by the next
160  * thread.
161  */
162  uint8_t *slice_damaged;
163  /* Frame damage flag, used to delay announcing progress, since ER is
164  * applied after all the slices are decoded.
165  * NOT shared between frame threads.
166  */
167  uint8_t frame_damaged;
168 } FFV1Context;
169 
177 int ff_ffv1_close(AVCodecContext *avctx);
178 int ff_need_new_slices(int width, int num_h_slices, int chroma_shift);
179 
180 /**
181  * This is intended for both width and height
182  */
183 int ff_slice_coord(const FFV1Context *f, int width, int sx, int num_h_slices, int chroma_shift);
184 
185 static av_always_inline int fold(int diff, int bits)
186 {
187  if (bits == 8)
188  diff = (int8_t)diff;
189  else {
191  }
192 
193  return diff;
194 }
195 
196 static inline void update_vlc_state(VlcState *const state, const int v)
197 {
198  int drift = state->drift;
199  int count = state->count;
200  state->error_sum += FFABS(v);
201  drift += v;
202 
203  if (count == 128) { // FIXME: variable
204  count >>= 1;
205  drift >>= 1;
206  state->error_sum >>= 1;
207  }
208  count++;
209 
210  if (drift <= -count) {
211  state->bias = FFMAX(state->bias - 1, -128);
212 
213  drift = FFMAX(drift + count, -count + 1);
214  } else if (drift > 0) {
215  state->bias = FFMIN(state->bias + 1, 127);
216 
217  drift = FFMIN(drift - count, 0);
218  }
219 
220  state->drift = drift;
221  state->count = count;
222 }
223 
224 #endif /* AVCODEC_FFV1_H */
FFV1Context::chroma_v_shift
int chroma_v_shift
Definition: ffv1.h:118
FFV1SliceContext::slice_height
int slice_height
Definition: ffv1.h:77
FFV1Context::flags
int flags
Definition: ffv1.h:120
FFV1Context::key_frame_ok
int key_frame_ok
Definition: ffv1.h:139
update_vlc_state
static void update_vlc_state(VlcState *const state, const int v)
Definition: ffv1.h:196
FFV1Context::last_picture
ProgressFrame last_picture
Definition: ffv1.h:123
FFV1Context::context_count
int context_count[MAX_QUANT_TABLES]
Definition: ffv1.h:130
ff_ffv1_clear_slice_state
void ff_ffv1_clear_slice_state(const FFV1Context *f, FFV1SliceContext *sc)
Definition: ffv1.c:200
FFV1SliceContext::plane
PlaneContext * plane
Definition: ffv1.h:88
FFV1Context::ec
int ec
Definition: ffv1.h:137
int64_t
long long int64_t
Definition: coverity.c:34
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:389
FFV1Context::crcref
uint32_t crcref
Definition: ffv1.h:124
MAX_QUANT_TABLE_SIZE
#define MAX_QUANT_TABLE_SIZE
Definition: ffv1.h:47
rangecoder.h
PlaneContext::state
uint8_t(* state)[CONTEXT_SIZE]
Definition: ffv1.h:66
FFV1Context::num_h_slices
int num_h_slices
Definition: ffv1.h:152
FFV1SliceContext::pb
PutBitContext pb
Definition: ffv1.h:89
FFMAX
#define FFMAX(a, b)
Definition: macros.h:47
FFV1Context::quant_tables
int16_t quant_tables[MAX_QUANT_TABLES][MAX_CONTEXT_INPUTS][MAX_QUANT_TABLE_SIZE]
Definition: ffv1.h:129
FFV1Context::chroma_h_shift
int chroma_h_shift
Definition: ffv1.h:118
FFV1SliceContext::slice_x
int slice_x
Definition: ffv1.h:78
CONTEXT_SIZE
#define CONTEXT_SIZE
Definition: ffv1.h:44
ff_ffv1_common_init
int ff_ffv1_common_init(AVCodecContext *avctx)
Definition: ffv1.c:36
FFV1Context::chroma_planes
int chroma_planes
Definition: ffv1.h:117
PlaneContext::context_count
int context_count
Definition: ffv1.h:65
progressframe.h
FFV1Context::bits_per_raw_sample
int bits_per_raw_sample
Definition: ffv1.h:143
FFV1SliceContext::sample_buffer
int16_t * sample_buffer
Definition: ffv1.h:73
FFV1Context::use32bit
int use32bit
Definition: ffv1.h:135
FFV1Context::quant_table_count
int quant_table_count
Definition: ffv1.h:147
FFV1Context::slice_count
int slice_count
Definition: ffv1.h:149
FFV1Context::max_slice_count
int max_slice_count
Definition: ffv1.h:150
bits
uint8_t bits
Definition: vp3data.h:128
FFV1Context::intra
int intra
Definition: ffv1.h:138
FFV1Context::rc_stat
uint64_t rc_stat[256][2]
Definition: ffv1.h:112
FFV1SliceContext::rc_stat2
uint64_t(*[MAX_QUANT_TABLES] rc_stat2)[32][2]
Definition: ffv1.h:104
get_bits.h
fold
static av_always_inline int fold(int diff, int bits)
Definition: ffv1.h:185
FFV1Context::ac
int ac
1=range coder <-> 0=golomb rice
Definition: ffv1.h:128
FFV1Context::plane_count
int plane_count
Definition: ffv1.h:127
FFV1Context::slice_damaged
uint8_t * slice_damaged
Definition: ffv1.h:162
PutBitContext
Definition: put_bits.h:50
FFABS
#define FFABS(a)
Absolute value, Note, INT_MIN / INT64_MIN result in undefined behavior as they are not representable ...
Definition: common.h:74
FFV1SliceContext::sx
int sx
Definition: ffv1.h:80
AVClass
Describe the class of an AVClass context structure.
Definition: log.h:75
PlaneContext::vlc_state
VlcState * vlc_state
Definition: ffv1.h:67
FFV1Context::num_v_slices
int num_v_slices
Definition: ffv1.h:151
FFV1Context::colorspace
int colorspace
Definition: ffv1.h:133
state
static struct @466 state
FFV1Context::slices
FFV1SliceContext * slices
Definition: ffv1.h:154
FFV1Context::state_transition
uint8_t state_transition[256]
Definition: ffv1.h:131
mathops.h
PlaneContext
Definition: ffv1.h:63
FFV1Context::width
int width
Definition: ffv1.h:116
VlcState
Definition: ffv1.h:56
FFV1Context::height
int height
Definition: ffv1.h:116
FFV1SliceContext::slice_width
int slice_width
Definition: ffv1.h:76
f
f
Definition: af_crystalizer.c:122
ff_ffv1_planes_alloc
PlaneContext * ff_ffv1_planes_alloc(void)
Definition: ffv1.c:68
VlcState::count
uint8_t count
Definition: ffv1.h:60
ff_ffv1_init_slice_state
int ff_ffv1_init_slice_state(const FFV1Context *f, FFV1SliceContext *sc)
Definition: ffv1.c:74
diff
static av_always_inline int diff(const struct color_info *a, const struct color_info *b, const int trans_thresh)
Definition: vf_paletteuse.c:166
FFV1Context::picture
ProgressFrame picture
Definition: ffv1.h:123
FFV1SliceContext::slice_rct_by_coef
int slice_rct_by_coef
Definition: ffv1.h:84
ff_ffv1_init_slices_state
int ff_ffv1_init_slices_state(FFV1Context *f)
Definition: ffv1.c:112
FFV1SliceContext::rc_stat
uint64_t rc_stat[256][2]
Definition: ffv1.h:103
PlaneContext::quant_table_index
int quant_table_index
Definition: ffv1.h:64
VlcState::drift
int16_t drift
Definition: ffv1.h:58
ff_slice_coord
int ff_slice_coord(const FFV1Context *f, int width, int sx, int num_h_slices, int chroma_shift)
This is intended for both width and height.
Definition: ffv1.c:129
FFV1Context::initial_states
uint8_t(*[MAX_QUANT_TABLES] initial_states)[32]
Definition: ffv1.h:132
FFV1SliceContext::c
RangeCoder c
Definition: ffv1.h:90
ff_ffv1_allocate_initial_states
int ff_ffv1_allocate_initial_states(FFV1Context *f)
Definition: ffv1.c:185
ff_need_new_slices
int ff_need_new_slices(int width, int num_h_slices, int chroma_shift)
Definition: ffv1.c:122
FFV1Context::gob_count
int gob_count
Definition: ffv1.h:146
FFV1SliceContext::slice_rct_ry_coef
int slice_rct_ry_coef
Definition: ffv1.h:85
av_always_inline
#define av_always_inline
Definition: attributes.h:49
FFMIN
#define FFMIN(a, b)
Definition: macros.h:49
FFV1SliceContext::sample_buffer32
int32_t * sample_buffer32
Definition: ffv1.h:74
FFV1SliceContext
Definition: ffv1.h:72
MAX_CONTEXT_INPUTS
#define MAX_CONTEXT_INPUTS
Definition: ffv1.h:49
ff_ffv1_close
int ff_ffv1_close(AVCodecContext *avctx)
Definition: ffv1.c:225
FFV1Context::packed_at_lsb
int packed_at_lsb
Definition: ffv1.h:144
avcodec.h
FFV1Context::avctx
AVCodecContext * avctx
Definition: ffv1.h:111
FFV1Context::qtable
int qtable
Definition: ffv1.h:141
FFV1SliceContext::slice_y
int slice_y
Definition: ffv1.h:79
FFV1Context::picture_number
int64_t picture_number
Definition: ffv1.h:121
FFV1Context::rc_stat2
uint64_t(*[MAX_QUANT_TABLES] rc_stat2)[32][2]
Definition: ffv1.h:113
AVCodecContext
main external API structure.
Definition: avcodec.h:451
VlcState::bias
int8_t bias
Definition: ffv1.h:59
FFV1Context::context_model
int context_model
Definition: ffv1.h:140
sign_extend
static av_const int sign_extend(int val, unsigned bits)
Definition: mathops.h:131
FFV1Context::key_frame
int key_frame
Definition: ffv1.h:122
FFV1SliceContext::sy
int sy
Definition: ffv1.h:80
VlcState::error_sum
uint32_t error_sum
Definition: ffv1.h:57
ff_ffv1_init_slice_contexts
int ff_ffv1_init_slice_contexts(FFV1Context *f)
Definition: ffv1.c:142
MAX_QUANT_TABLES
#define MAX_QUANT_TABLES
Definition: ffv1.h:46
FFV1Context
Definition: ffv1.h:109
FFV1Context::transparency
int transparency
Definition: ffv1.h:119
ProgressFrame
The ProgressFrame structure.
Definition: progressframe.h:73
FFV1SliceContext::run_index
int run_index
Definition: ffv1.h:82
int32_t
int32_t
Definition: audioconvert.c:56
FFV1SliceContext::slice_reset_contexts
int slice_reset_contexts
Definition: ffv1.h:97
FFV1Context::cur_enc_frame
const AVFrame * cur_enc_frame
Definition: ffv1.h:126
FFV1Context::micro_version
int micro_version
Definition: ffv1.h:115
RangeCoder
Definition: mss3.c:63
width
#define width
Definition: dsp.h:85
FFV1SliceContext::ac_byte_count
int ac_byte_count
number of bytes used for AC coding
Definition: ffv1.h:92
FFV1SliceContext::slice_damaged
int slice_damaged
Definition: ffv1.h:98
put_bits.h
FFV1SliceContext::slice_coding_mode
int slice_coding_mode
Definition: ffv1.h:83
FFV1Context::version
int version
Definition: ffv1.h:114
FFV1Context::frame_damaged
uint8_t frame_damaged
Definition: ffv1.h:167