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 "libavutil/crc.h"
32 #include "libavutil/opt.h"
33 #include "libavutil/imgutils.h"
34 #include "libavutil/pixdesc.h"
35 #include "avcodec.h"
36 #include "get_bits.h"
37 #include "internal.h"
38 #include "mathops.h"
39 #include "put_bits.h"
40 #include "rangecoder.h"
41 #include "thread.h"
42 
43 #ifdef __INTEL_COMPILER
44 #undef av_flatten
45 #define av_flatten
46 #endif
47 
48 #define MAX_PLANES 4
49 #define CONTEXT_SIZE 32
50 
51 #define MAX_QUANT_TABLES 8
52 #define MAX_CONTEXT_INPUTS 5
53 
54 #define AC_GOLOMB_RICE 0
55 #define AC_RANGE_DEFAULT_TAB 1
56 #define AC_RANGE_CUSTOM_TAB 2
57 #define AC_RANGE_DEFAULT_TAB_FORCE -2
58 
59 typedef struct VlcState {
60  int16_t drift;
61  uint16_t error_sum;
62  int8_t bias;
63  uint8_t count;
64 } VlcState;
65 
66 typedef struct PlaneContext {
70  uint8_t (*state)[CONTEXT_SIZE];
72  uint8_t interlace_bit_state[2];
73 } PlaneContext;
74 
75 #define MAX_SLICES 1024
76 
77 typedef struct FFV1Context {
78  AVClass *class;
83  uint64_t rc_stat[256][2];
84  uint64_t (*rc_stat2[MAX_QUANT_TABLES])[32][2];
85  int version;
87  int width, height;
91  int flags;
93  int key_frame;
95  struct FFV1Context *fsrc;
96 
99  int ac; ///< 1=range coder <-> 0=golomb rice
100  int ac_byte_count; ///< number of bytes used for AC coding
105  uint8_t state_transition[256];
109  int16_t *sample_buffer;
111 
112  int use32bit;
113 
114  int ec;
115  int intra;
119 
122 
125 
133  int slice_x;
134  int slice_y;
139 } FFV1Context;
140 
148 
149 static av_always_inline int fold(int diff, int bits)
150 {
151  if (bits == 8)
152  diff = (int8_t)diff;
153  else {
155  }
156 
157  return diff;
158 }
159 
160 static inline void update_vlc_state(VlcState *const state, const int v)
161 {
162  int drift = state->drift;
163  int count = state->count;
164  state->error_sum += FFABS(v);
165  drift += v;
166 
167  if (count == 128) { // FIXME: variable
168  count >>= 1;
169  drift >>= 1;
170  state->error_sum >>= 1;
171  }
172  count++;
173 
174  if (drift <= -count) {
175  state->bias = FFMAX(state->bias - 1, -128);
176 
177  drift = FFMAX(drift + count, -count + 1);
178  } else if (drift > 0) {
179  state->bias = FFMIN(state->bias + 1, 127);
180 
181  drift = FFMIN(drift - count, 0);
182  }
183 
184  state->drift = drift;
185  state->count = count;
186 }
187 
188 #define TYPE int16_t
189 #define RENAME(name) name
190 #include "ffv1_template.c"
191 #undef TYPE
192 #undef RENAME
193 
194 #define TYPE int32_t
195 #define RENAME(name) name ## 32
196 #include "ffv1_template.c"
197 #undef TYPE
198 #undef RENAME
199 
200 #endif /* AVCODEC_FFV1_H */
FFV1Context::chroma_v_shift
int chroma_v_shift
Definition: ffv1.h:89
FFV1Context::flags
int flags
Definition: ffv1.h:91
FFV1Context::key_frame_ok
int key_frame_ok
Definition: ffv1.h:117
update_vlc_state
static void update_vlc_state(VlcState *const state, const int v)
Definition: ffv1.h:160
opt.h
FFV1Context::context_count
int context_count[MAX_QUANT_TABLES]
Definition: ffv1.h:104
FFV1Context::ec
int ec
Definition: ffv1.h:114
FFV1Context::gb
GetBitContext gb
Definition: ffv1.h:81
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:303
pixdesc.h
internal.h
FFV1Context::last_picture
ThreadFrame last_picture
Definition: ffv1.h:94
FFV1Context::slice_x
int slice_x
Definition: ffv1.h:133
rangecoder.h
FFV1Context::slice_coding_mode
int slice_coding_mode
Definition: ffv1.h:136
PlaneContext::state
uint8_t(* state)[CONTEXT_SIZE]
Definition: ffv1.h:70
FFV1Context::num_h_slices
int num_h_slices
Definition: ffv1.h:130
FFV1Context::slice_context
struct FFV1Context * slice_context[MAX_SLICES]
Definition: ffv1.h:126
FFMAX
#define FFMAX(a, b)
Definition: macros.h:47
thread.h
FFV1Context::chroma_h_shift
int chroma_h_shift
Definition: ffv1.h:89
crc.h
FFV1Context::slice_rct_ry_coef
int slice_rct_ry_coef
Definition: ffv1.h:138
GetBitContext
Definition: get_bits.h:62
FFV1Context::sample_buffer32
int32_t * sample_buffer32
Definition: ffv1.h:110
CONTEXT_SIZE
#define CONTEXT_SIZE
Definition: ffv1.h:49
ff_ffv1_common_init
int ff_ffv1_common_init(AVCodecContext *avctx)
Definition: ffv1.c:41
FFV1Context::chroma_planes
int chroma_planes
Definition: ffv1.h:88
PlaneContext::context_count
int context_count
Definition: ffv1.h:69
FFV1Context::c
RangeCoder c
Definition: ffv1.h:80
FFV1Context::quant_tables
int16_t quant_tables[MAX_QUANT_TABLES][MAX_CONTEXT_INPUTS][256]
Definition: ffv1.h:103
FFV1Context::bits_per_raw_sample
int bits_per_raw_sample
Definition: ffv1.h:120
FFV1Context::use32bit
int use32bit
Definition: ffv1.h:112
FFV1Context::quant_table_count
int quant_table_count
Definition: ffv1.h:124
MAX_PLANES
#define MAX_PLANES
Definition: ffv1.h:48
FFV1Context::slice_count
int slice_count
Definition: ffv1.h:127
ff_ffv1_init_slice_state
int ff_ffv1_init_slice_state(FFV1Context *f, FFV1Context *fs)
Definition: ffv1.c:66
FFV1Context::ac_byte_count
int ac_byte_count
number of bytes used for AC coding
Definition: ffv1.h:100
FFV1Context::plane
PlaneContext plane[MAX_PLANES]
Definition: ffv1.h:101
FFV1Context::max_slice_count
int max_slice_count
Definition: ffv1.h:128
FFV1Context::slice_damaged
int slice_damaged
Definition: ffv1.h:116
bits
uint8_t bits
Definition: vp3data.h:141
FFV1Context::intra
int intra
Definition: ffv1.h:115
FFV1Context::quant_table
int16_t quant_table[MAX_CONTEXT_INPUTS][256]
Definition: ffv1.h:102
FFV1Context::fsrc
struct FFV1Context * fsrc
Definition: ffv1.h:95
FFV1Context::rc_stat
uint64_t rc_stat[256][2]
Definition: ffv1.h:83
ffv1_template.c
VlcState::error_sum
uint16_t error_sum
Definition: ffv1.h:61
get_bits.h
fold
static av_always_inline int fold(int diff, int bits)
Definition: ffv1.h:149
FFV1Context::ac
int ac
1=range coder <-> 0=golomb rice
Definition: ffv1.h:99
FFV1Context::plane_count
int plane_count
Definition: ffv1.h:98
f
#define f(width, name)
Definition: cbs_vp9.c:255
PutBitContext
Definition: put_bits.h:49
PlaneContext::interlace_bit_state
uint8_t interlace_bit_state[2]
Definition: ffv1.h:72
FFABS
#define FFABS(a)
Absolute value, Note, INT_MIN / INT64_MIN result in undefined behavior as they are not representable ...
Definition: common.h:65
FFV1Context::slice_height
int slice_height
Definition: ffv1.h:132
AVClass
Describe the class of an AVClass context structure.
Definition: log.h:66
PlaneContext::vlc_state
VlcState * vlc_state
Definition: ffv1.h:71
fs
#define fs(width, name, subs,...)
Definition: cbs_vp9.c:259
FFV1Context::num_v_slices
int num_v_slices
Definition: ffv1.h:129
FFV1Context::colorspace
int colorspace
Definition: ffv1.h:108
state
static struct @317 state
ff_ffv1_clear_slice_state
void ff_ffv1_clear_slice_state(FFV1Context *f, FFV1Context *fs)
Definition: ffv1.c:173
FFV1Context::state_transition
uint8_t state_transition[256]
Definition: ffv1.h:105
mathops.h
PlaneContext
Definition: ffv1.h:66
FFV1Context::width
int width
Definition: ffv1.h:87
FFV1Context::slice_reset_contexts
int slice_reset_contexts
Definition: ffv1.h:135
VlcState
Definition: ffv1.h:59
FFV1Context::height
int height
Definition: ffv1.h:87
FFV1Context::slice_width
int slice_width
Definition: ffv1.h:131
FFV1Context::slice_rct_by_coef
int slice_rct_by_coef
Definition: ffv1.h:137
FFV1Context::picture
ThreadFrame picture
Definition: ffv1.h:94
VlcState::count
uint8_t count
Definition: ffv1.h:63
FFV1Context::sample_buffer
int16_t * sample_buffer
Definition: ffv1.h:109
ff_ffv1_init_slices_state
int ff_ffv1_init_slices_state(FFV1Context *f)
Definition: ffv1.c:105
PlaneContext::quant_table_index
int quant_table_index
Definition: ffv1.h:68
VlcState::drift
int16_t drift
Definition: ffv1.h:60
FFV1Context::initial_states
uint8_t(*[MAX_QUANT_TABLES] initial_states)[32]
Definition: ffv1.h:106
ff_ffv1_allocate_initial_states
int ff_ffv1_allocate_initial_states(FFV1Context *f)
Definition: ffv1.c:158
FFV1Context::gob_count
int gob_count
Definition: ffv1.h:123
av_always_inline
#define av_always_inline
Definition: attributes.h:49
FFMIN
#define FFMIN(a, b)
Definition: macros.h:49
FFV1Context::slice_y
int slice_y
Definition: ffv1.h:134
MAX_CONTEXT_INPUTS
#define MAX_CONTEXT_INPUTS
Definition: ffv1.h:52
ff_ffv1_close
int ff_ffv1_close(AVCodecContext *avctx)
Definition: ffv1.c:201
FFV1Context::packed_at_lsb
int packed_at_lsb
Definition: ffv1.h:121
avcodec.h
FFV1Context::avctx
AVCodecContext * avctx
Definition: ffv1.h:79
FFV1Context::picture_number
int picture_number
Definition: ffv1.h:92
FFV1Context::rc_stat2
uint64_t(*[MAX_QUANT_TABLES] rc_stat2)[32][2]
Definition: ffv1.h:84
AVCodecContext
main external API structure.
Definition: avcodec.h:383
VlcState::bias
int8_t bias
Definition: ffv1.h:62
ThreadFrame
Definition: thread.h:34
FFV1Context::context_model
int context_model
Definition: ffv1.h:118
FFV1Context::pb
PutBitContext pb
Definition: ffv1.h:82
sign_extend
static av_const int sign_extend(int val, unsigned bits)
Definition: mathops.h:130
FFV1Context::key_frame
int key_frame
Definition: ffv1.h:93
ff_ffv1_init_slice_contexts
int ff_ffv1_init_slice_contexts(FFV1Context *f)
Definition: ffv1.c:116
MAX_QUANT_TABLES
#define MAX_QUANT_TABLES
Definition: ffv1.h:51
FFV1Context
Definition: ffv1.h:77
diff
static av_always_inline int diff(const uint32_t a, const uint32_t b)
Definition: vf_palettegen.c:136
FFV1Context::transparency
int transparency
Definition: ffv1.h:90
int32_t
int32_t
Definition: audioconvert.c:56
imgutils.h
FFV1Context::micro_version
int micro_version
Definition: ffv1.h:86
MAX_SLICES
#define MAX_SLICES
Definition: ffv1.h:75
FFV1Context::cur
AVFrame * cur
Definition: ffv1.h:97
RangeCoder
Definition: mss3.c:61
PlaneContext::quant_table
int16_t quant_table[MAX_CONTEXT_INPUTS][256]
Definition: ffv1.h:67
put_bits.h
FFV1Context::run_index
int run_index
Definition: ffv1.h:107
FFV1Context::version
int version
Definition: ffv1.h:85