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