FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
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/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 #define AC_RANGE_DEFAULT_TAB_FORCE -2
60 
61 typedef struct VlcState {
62  int16_t drift;
63  uint16_t error_sum;
64  int8_t bias;
66 } VlcState;
67 
68 typedef struct PlaneContext {
75 } PlaneContext;
76 
77 #define MAX_SLICES 256
78 
79 typedef struct FFV1Context {
80  AVClass *class;
85  uint64_t rc_stat[256][2];
86  uint64_t (*rc_stat2[MAX_QUANT_TABLES])[32][2];
87  int version;
89  int width, height;
93  int flags;
95  int key_frame;
97  struct FFV1Context *fsrc;
98 
101  int ac; ///< 1=range coder <-> 0=golomb rice
102  int ac_byte_count; ///< number of bytes used for AC coding
111  int16_t *sample_buffer;
113 
114  int use32bit;
115 
116  int ec;
117  int intra;
121 
124 
127 
135  int slice_x;
136  int slice_y;
141 } FFV1Context;
142 
150 
151 static av_always_inline int fold(int diff, int bits)
152 {
153  if (bits == 8)
154  diff = (int8_t)diff;
155  else {
156  diff += 1 << (bits - 1);
157  diff = av_mod_uintp2(diff, bits);
158  diff -= 1 << (bits - 1);
159  }
160 
161  return diff;
162 }
163 
164 static inline void update_vlc_state(VlcState *const state, const int v)
165 {
166  int drift = state->drift;
167  int count = state->count;
168  state->error_sum += FFABS(v);
169  drift += v;
170 
171  if (count == 128) { // FIXME: variable
172  count >>= 1;
173  drift >>= 1;
174  state->error_sum >>= 1;
175  }
176  count++;
177 
178  if (drift <= -count) {
179  if (state->bias > -128)
180  state->bias--;
181 
182  drift += count;
183  if (drift <= -count)
184  drift = -count + 1;
185  } else if (drift > 0) {
186  if (state->bias < 127)
187  state->bias++;
188 
189  drift -= count;
190  if (drift > 0)
191  drift = 0;
192  }
193 
194  state->drift = drift;
195  state->count = count;
196 }
197 
198 #define TYPE int16_t
199 #define RENAME(name) name
200 #include "ffv1_template.c"
201 #undef TYPE
202 #undef RENAME
203 
204 #define TYPE int32_t
205 #define RENAME(name) name ## 32
206 #include "ffv1_template.c"
207 #undef TYPE
208 #undef RENAME
209 
210 #endif /* AVCODEC_FFV1_H */
static av_always_inline int fold(int diff, int bits)
Definition: ffv1.h:151
This structure describes decoded (raw) audio or video data.
Definition: frame.h:184
int flags
Definition: ffv1.h:93
int ff_ffv1_init_slice_contexts(FFV1Context *f)
Definition: ffv1.c:117
misc image utilities
int16_t quant_table[MAX_CONTEXT_INPUTS][256]
Definition: ffv1.h:69
int quant_table_count
Definition: ffv1.h:126
int slice_height
Definition: ffv1.h:134
#define MAX_CONTEXT_INPUTS
Definition: ffv1.h:54
int16_t * sample_buffer
Definition: ffv1.h:111
int version
Definition: ffv1.h:87
int micro_version
Definition: ffv1.h:88
Range coder.
uint64_t(*[MAX_QUANT_TABLES] rc_stat2)[32][2]
Definition: ffv1.h:86
int height
Definition: ffv1.h:89
int slice_reset_contexts
Definition: ffv1.h:137
int slice_rct_by_coef
Definition: ffv1.h:139
int plane_count
Definition: ffv1.h:100
int slice_damaged
Definition: ffv1.h:118
ThreadFrame picture
Definition: ffv1.h:96
uint64_t rc_stat[256][2]
Definition: ffv1.h:85
PutBitContext pb
Definition: ffv1.h:84
uint8_t bits
Definition: crc.c:296
uint8_t
AVOptions.
int8_t bias
Definition: ffv1.h:64
Multithreading support functions.
RangeCoder c
Definition: ffv1.h:82
int slice_y
Definition: ffv1.h:136
uint8_t(*[MAX_QUANT_TABLES] initial_states)[32]
Definition: ffv1.h:108
ThreadFrame last_picture
Definition: ffv1.h:96
Public header for CRC hash function implementation.
uint8_t count
Definition: ffv1.h:65
int ff_ffv1_allocate_initial_states(FFV1Context *f)
Definition: ffv1.c:167
bitstream reader API header.
VlcState * vlc_state
Definition: ffv1.h:73
high precision timer, useful to profile code
int bits_per_raw_sample
Definition: ffv1.h:122
int slice_width
Definition: ffv1.h:133
GetBitContext gb
Definition: ffv1.h:83
AVFrame * cur
Definition: ffv1.h:99
int16_t quant_tables[MAX_QUANT_TABLES][MAX_CONTEXT_INPUTS][256]
Definition: ffv1.h:105
int context_count
Definition: ffv1.h:71
simple assert() macros that are a bit more flexible than ISO C assert().
GLsizei count
Definition: opengl_enc.c:109
int ac
1=range coder <-> 0=golomb rice
Definition: ffv1.h:101
int16_t quant_table[MAX_CONTEXT_INPUTS][256]
Definition: ffv1.h:104
int run_index
Definition: ffv1.h:109
int ff_ffv1_init_slices_state(FFV1Context *f)
Definition: ffv1.c:106
Definition: ffv1.h:61
int ff_ffv1_close(AVCodecContext *avctx)
Definition: ffv1.c:210
uint8_t state_transition[256]
Definition: ffv1.h:107
int key_frame
Definition: ffv1.h:95
int num_h_slices
Definition: ffv1.h:132
#define MAX_QUANT_TABLES
Definition: ffv1.h:53
int colorspace
Definition: ffv1.h:110
int32_t
#define MAX_PLANES
Definition: ffv1.h:50
static void update_vlc_state(VlcState *const state, const int v)
Definition: ffv1.h:164
int slice_count
Definition: ffv1.h:129
int max_slice_count
Definition: ffv1.h:130
#define FFABS(a)
Absolute value, Note, INT_MIN / INT64_MIN result in undefined behavior as they are not representable ...
Definition: common.h:72
int ac_byte_count
number of bytes used for AC coding
Definition: ffv1.h:102
int16_t drift
Definition: ffv1.h:62
int packed_at_lsb
Definition: ffv1.h:123
int context_count[MAX_QUANT_TABLES]
Definition: ffv1.h:106
Libavcodec external API header.
main external API structure.
Definition: avcodec.h:1659
int intra
Definition: ffv1.h:117
Describe the class of an AVClass context structure.
Definition: log.h:67
int use32bit
Definition: ffv1.h:114
int picture_number
Definition: ffv1.h:94
uint16_t error_sum
Definition: ffv1.h:63
int32_t * sample_buffer32
Definition: ffv1.h:112
int key_frame_ok
Definition: ffv1.h:119
#define CONTEXT_SIZE
Definition: ffv1.h:51
int gob_count
Definition: ffv1.h:125
int quant_table_index
Definition: ffv1.h:70
int context_model
Definition: ffv1.h:120
common internal api header.
uint8_t(* state)[CONTEXT_SIZE]
Definition: ffv1.h:72
int slice_coding_mode
Definition: ffv1.h:138
int chroma_h_shift
Definition: ffv1.h:91
PlaneContext plane[MAX_PLANES]
Definition: ffv1.h:103
int ff_ffv1_init_slice_state(FFV1Context *f, FFV1Context *fs)
Definition: ffv1.c:67
int transparency
Definition: ffv1.h:92
static av_always_inline int diff(const uint32_t a, const uint32_t b)
struct FFV1Context * fsrc
Definition: ffv1.h:97
int chroma_v_shift
Definition: ffv1.h:91
#define MAX_SLICES
Definition: ffv1.h:77
int chroma_planes
Definition: ffv1.h:90
struct FFV1Context * slice_context[MAX_SLICES]
Definition: ffv1.h:128
uint8_t interlace_bit_state[2]
Definition: ffv1.h:74
int ff_ffv1_common_init(AVCodecContext *avctx)
Definition: ffv1.c:42
#define av_always_inline
Definition: attributes.h:39
int ec
Definition: ffv1.h:116
static struct @230 state
int num_v_slices
Definition: ffv1.h:131
void ff_ffv1_clear_slice_state(FFV1Context *f, FFV1Context *fs)
Definition: ffv1.c:182
AVCodecContext * avctx
Definition: ffv1.h:81
int slice_x
Definition: ffv1.h:135
int width
Definition: ffv1.h:89
int slice_rct_ry_coef
Definition: ffv1.h:140
bitstream writer API