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