FFmpeg  4.3
ffv1enc_template.c
Go to the documentation of this file.
1 /*
2  * FFV1 encoder template
3  *
4  * Copyright (c) 2003-2016 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 
24  TYPE *sample[3],
25  int plane_index, int bits)
26 {
27  PlaneContext *const p = &s->plane[plane_index];
28  RangeCoder *const c = &s->c;
29  int x;
30  int run_index = s->run_index;
31  int run_count = 0;
32  int run_mode = 0;
33 
34  if (s->ac != AC_GOLOMB_RICE) {
35  if (c->bytestream_end - c->bytestream < w * 35) {
36  av_log(s->avctx, AV_LOG_ERROR, "encoded frame too large\n");
37  return AVERROR_INVALIDDATA;
38  }
39  } else {
40  if (s->pb.buf_end - s->pb.buf - (put_bits_count(&s->pb) >> 3) < w * 4) {
41  av_log(s->avctx, AV_LOG_ERROR, "encoded frame too large\n");
42  return AVERROR_INVALIDDATA;
43  }
44  }
45 
46  if (s->slice_coding_mode == 1) {
47  for (x = 0; x < w; x++) {
48  int i;
49  int v = sample[0][x];
50  for (i = bits-1; i>=0; i--) {
51  uint8_t state = 128;
52  put_rac(c, &state, (v>>i) & 1);
53  }
54  }
55  return 0;
56  }
57 
58  for (x = 0; x < w; x++) {
59  int diff, context;
60 
61  context = RENAME(get_context)(p, sample[0] + x, sample[1] + x, sample[2] + x);
62  diff = sample[0][x] - RENAME(predict)(sample[0] + x, sample[1] + x);
63 
64  if (context < 0) {
65  context = -context;
66  diff = -diff;
67  }
68 
69  diff = fold(diff, bits);
70 
71  if (s->ac != AC_GOLOMB_RICE) {
72  if (s->flags & AV_CODEC_FLAG_PASS1) {
73  put_symbol_inline(c, p->state[context], diff, 1, s->rc_stat,
74  s->rc_stat2[p->quant_table_index][context]);
75  } else {
77  }
78  } else {
79  if (context == 0)
80  run_mode = 1;
81 
82  if (run_mode) {
83  if (diff) {
84  while (run_count >= 1 << ff_log2_run[run_index]) {
85  run_count -= 1 << ff_log2_run[run_index];
86  run_index++;
87  put_bits(&s->pb, 1, 1);
88  }
89 
90  put_bits(&s->pb, 1 + ff_log2_run[run_index], run_count);
91  if (run_index)
92  run_index--;
93  run_count = 0;
94  run_mode = 0;
95  if (diff > 0)
96  diff--;
97  } else {
98  run_count++;
99  }
100  }
101 
102  ff_dlog(s->avctx, "count:%d index:%d, mode:%d, x:%d pos:%d\n",
103  run_count, run_index, run_mode, x,
104  (int)put_bits_count(&s->pb));
105 
106  if (run_mode == 0)
107  put_vlc_symbol(&s->pb, &p->vlc_state[context], diff, bits);
108  }
109  }
110  if (run_mode) {
111  while (run_count >= 1 << ff_log2_run[run_index]) {
112  run_count -= 1 << ff_log2_run[run_index];
113  run_index++;
114  put_bits(&s->pb, 1, 1);
115  }
116 
117  if (run_count)
118  put_bits(&s->pb, 1, 1);
119  }
120  s->run_index = run_index;
121 
122  return 0;
123 }
124 
125 static int RENAME(encode_rgb_frame)(FFV1Context *s, const uint8_t *src[4],
126  int w, int h, const int stride[4])
127 {
128  int x, y, p, i;
129  const int ring_size = s->context_model ? 3 : 2;
130  TYPE *sample[4][3];
131  int lbd = s->bits_per_raw_sample <= 8;
132  int packed = !src[1];
133  int bits = s->bits_per_raw_sample > 0 ? s->bits_per_raw_sample : 8;
134  int offset = 1 << bits;
135  int transparency = s->transparency;
136  int packed_size = (3 + transparency)*2;
137 
138  s->run_index = 0;
139 
140  memset(RENAME(s->sample_buffer), 0, ring_size * MAX_PLANES *
141  (w + 6) * sizeof(*RENAME(s->sample_buffer)));
142 
143  for (y = 0; y < h; y++) {
144  for (i = 0; i < ring_size; i++)
145  for (p = 0; p < MAX_PLANES; p++)
146  sample[p][i]= RENAME(s->sample_buffer) + p*ring_size*(w+6) + ((h+i-y)%ring_size)*(w+6) + 3;
147 
148  for (x = 0; x < w; x++) {
149  int b, g, r, av_uninit(a);
150  if (lbd) {
151  unsigned v = *((const uint32_t*)(src[0] + x*4 + stride[0]*y));
152  b = v & 0xFF;
153  g = (v >> 8) & 0xFF;
154  r = (v >> 16) & 0xFF;
155  a = v >> 24;
156  } else if (packed) {
157  const uint16_t *p = ((const uint16_t*)(src[0] + x*packed_size + stride[0]*y));
158  r = p[0];
159  g = p[1];
160  b = p[2];
161  if (transparency)
162  a = p[3];
163  } else if (sizeof(TYPE) == 4 || transparency) {
164  g = *((const uint16_t *)(src[0] + x*2 + stride[0]*y));
165  b = *((const uint16_t *)(src[1] + x*2 + stride[1]*y));
166  r = *((const uint16_t *)(src[2] + x*2 + stride[2]*y));
167  if (transparency)
168  a = *((const uint16_t *)(src[3] + x*2 + stride[3]*y));
169  } else {
170  b = *((const uint16_t *)(src[0] + x*2 + stride[0]*y));
171  g = *((const uint16_t *)(src[1] + x*2 + stride[1]*y));
172  r = *((const uint16_t *)(src[2] + x*2 + stride[2]*y));
173  }
174 
175  if (s->slice_coding_mode != 1) {
176  b -= g;
177  r -= g;
178  g += (b * s->slice_rct_by_coef + r * s->slice_rct_ry_coef) >> 2;
179  b += offset;
180  r += offset;
181  }
182 
183  sample[0][0][x] = g;
184  sample[1][0][x] = b;
185  sample[2][0][x] = r;
186  sample[3][0][x] = a;
187  }
188  for (p = 0; p < 3 + transparency; p++) {
189  int ret;
190  sample[p][0][-1] = sample[p][1][0 ];
191  sample[p][1][ w] = sample[p][1][w-1];
192  if (lbd && s->slice_coding_mode == 0)
193  ret = RENAME(encode_line)(s, w, sample[p], (p + 1) / 2, 9);
194  else
195  ret = RENAME(encode_line)(s, w, sample[p], (p + 1) / 2, bits + (s->slice_coding_mode != 1));
196  if (ret < 0)
197  return ret;
198  }
199  }
200  return 0;
201 }
202 
stride
int stride
Definition: mace.c:144
put_symbol_inline
static av_always_inline av_flatten void put_symbol_inline(RangeCoder *c, uint8_t *state, int v, int is_signed, uint64_t rc_stat[256][2], uint64_t rc_stat2[32][2])
Definition: ffv1enc.c:184
put_bits
static void put_bits(Jpeg2000EncoderContext *s, int val, int n)
put n times val bit
Definition: j2kenc.c:208
b
#define b
Definition: input.c:41
PlaneContext::state
uint8_t(* state)[CONTEXT_SIZE]
Definition: ffv1.h:71
ring_size
static int ring_size(RingBuffer *ring)
Definition: async.c:105
x
FFmpeg Automated Testing Environment ************************************Introduction Using FATE from your FFmpeg source directory Submitting the results to the FFmpeg result aggregation server Uploading new samples to the fate suite FATE makefile targets and variables Makefile targets Makefile variables Examples Introduction **************FATE is an extended regression suite on the client side and a means for results aggregation and presentation on the server side The first part of this document explains how you can use FATE from your FFmpeg source directory to test your ffmpeg binary The second part describes how you can run FATE to submit the results to FFmpeg’s FATE server In any way you can have a look at the publicly viewable FATE results by visiting this as it can be seen if some test on some platform broke with their recent contribution This usually happens on the platforms the developers could not test on The second part of this document describes how you can run FATE to submit your results to FFmpeg’s FATE server If you want to submit your results be sure to check that your combination of OS and compiler is not already listed on the above mentioned website In the third part you can find a comprehensive listing of FATE makefile targets and variables Using FATE from your FFmpeg source directory **********************************************If you want to run FATE on your machine you need to have the samples in place You can get the samples via the build target fate rsync Use this command from the top level source this will cause FATE to fail NOTE To use a custom wrapper to run the pass ‘ target exec’ to ‘configure’ or set the TARGET_EXEC Make variable Submitting the results to the FFmpeg result aggregation server ****************************************************************To submit your results to the server you should run fate through the shell script ‘tests fate sh’ from the FFmpeg sources This script needs to be invoked with a configuration file as its first argument tests fate sh path to fate_config A configuration file template with comments describing the individual configuration variables can be found at ‘doc fate_config sh template’ Create a configuration that suits your based on the configuration template The ‘slot’ configuration variable can be any string that is not yet but it is suggested that you name it adhering to the following pattern ‘ARCH OS COMPILER COMPILER VERSION’ The configuration file itself will be sourced in a shell therefore all shell features may be used This enables you to setup the environment as you need it for your build For your first test runs the ‘fate_recv’ variable should be empty or commented out This will run everything as normal except that it will omit the submission of the results to the server The following files should be present in $workdir as specified in the configuration it may help to try out the ‘ssh’ command with one or more ‘ v’ options You should get detailed output concerning your SSH configuration and the authentication process The only thing left is to automate the execution of the fate sh script and the synchronisation of the samples directory Uploading new samples to the fate suite *****************************************If you need a sample uploaded send a mail to samples request This is for developers who have an account on the fate suite server If you upload new please make sure they are as small as space on each network bandwidth and so on benefit from smaller test cases Also keep in mind older checkouts use existing sample that means in practice generally do not remove or overwrite files as it likely would break older checkouts or releases Also all needed samples for a commit should be ideally before the push If you need an account for frequently uploading samples or you wish to help others by doing that send a mail to ffmpeg devel rsync vauL Duo x
Definition: fate.txt:150
AV_LOG_ERROR
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:176
s
#define s(width, name)
Definition: cbs_vp9.c:257
MAX_PLANES
#define MAX_PLANES
Definition: ffv1.h:49
g
const char * g
Definition: vf_curves.c:115
bits
uint8_t bits
Definition: vp3data.h:202
fold
static av_always_inline int fold(int diff, int bits)
Definition: ffv1.h:150
context
it s the only field you need to keep assuming you have a context There is some magic you don t need to care about around this just let it vf default minimum maximum flags name is the option keep it simple and lowercase description are in without and describe what they for example set the foo of the bar offset is the offset of the field in your context
Definition: writing_filters.txt:91
NULL
#define NULL
Definition: coverity.c:32
PlaneContext::vlc_state
VlcState * vlc_state
Definition: ffv1.h:72
AC_GOLOMB_RICE
#define AC_GOLOMB_RICE
Definition: ffv1.h:55
ff_log2_run
const uint8_t ff_log2_run[41]
Definition: bitstream.c:39
src
#define src
Definition: vp8dsp.c:254
TYPE
#define TYPE
Definition: ffv1.h:195
PlaneContext
Definition: ffv1.h:67
c
Undefined Behavior In the C some operations are like signed integer dereferencing freed accessing outside allocated Undefined Behavior must not occur in a C it is not safe even if the output of undefined operations is unused The unsafety may seem nit picking but Optimizing compilers have in fact optimized code on the assumption that no undefined Behavior occurs Optimizing code based on wrong assumptions can and has in some cases lead to effects beyond the output of computations The signed integer overflow problem in speed critical code Code which is highly optimized and works with signed integers sometimes has the problem that often the output of the computation does not c
Definition: undefined.txt:32
ff_dlog
#define ff_dlog(a,...)
Definition: tableprint_vlc.h:29
sample
#define sample
Definition: flacdsp_template.c:44
state
static struct @314 state
encode_line
static av_always_inline int RENAME() encode_line(FFV1Context *s, int w, TYPE *sample[3], int plane_index, int bits)
Definition: ffv1enc_template.c:23
a
The reader does not expect b to be semantically here and if the code is changed by maybe adding a a division or other the signedness will almost certainly be mistaken To avoid this confusion a new type was SUINT is the C unsigned type but it holds a signed int to use the same example SUINT a
Definition: undefined.txt:41
offset
it s the only field you need to keep assuming you have a context There is some magic you don t need to care about around this just let it vf offset
Definition: writing_filters.txt:86
PlaneContext::quant_table_index
int quant_table_index
Definition: ffv1.h:69
r
#define r
Definition: input.c:40
put_vlc_symbol
static void put_vlc_symbol(PutBitContext *pb, VlcState *const state, int v, int bits)
Definition: ffv1enc.c:239
i
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:269
put_bits_count
static int put_bits_count(PutBitContext *s)
Definition: put_bits.h:67
predict
static av_always_inline void predict(PredictorState *ps, float *coef, int output_enable)
Definition: aacdec.c:174
RENAME
#define RENAME(name)
Definition: ffv1.h:196
av_always_inline
#define av_always_inline
Definition: attributes.h:49
uint8_t
uint8_t
Definition: audio_convert.c:194
av_uninit
#define av_uninit(x)
Definition: attributes.h:154
ret
ret
Definition: filter_design.txt:187
w
FFmpeg Automated Testing Environment ************************************Introduction Using FATE from your FFmpeg source directory Submitting the results to the FFmpeg result aggregation server Uploading new samples to the fate suite FATE makefile targets and variables Makefile targets Makefile variables Examples Introduction **************FATE is an extended regression suite on the client side and a means for results aggregation and presentation on the server side The first part of this document explains how you can use FATE from your FFmpeg source directory to test your ffmpeg binary The second part describes how you can run FATE to submit the results to FFmpeg’s FATE server In any way you can have a look at the publicly viewable FATE results by visiting this as it can be seen if some test on some platform broke with their recent contribution This usually happens on the platforms the developers could not test on The second part of this document describes how you can run FATE to submit your results to FFmpeg’s FATE server If you want to submit your results be sure to check that your combination of OS and compiler is not already listed on the above mentioned website In the third part you can find a comprehensive listing of FATE makefile targets and variables Using FATE from your FFmpeg source directory **********************************************If you want to run FATE on your machine you need to have the samples in place You can get the samples via the build target fate rsync Use this command from the top level source this will cause FATE to fail NOTE To use a custom wrapper to run the pass ‘ target exec’ to ‘configure’ or set the TARGET_EXEC Make variable Submitting the results to the FFmpeg result aggregation server ****************************************************************To submit your results to the server you should run fate through the shell script ‘tests fate sh’ from the FFmpeg sources This script needs to be invoked with a configuration file as its first argument tests fate sh path to fate_config A configuration file template with comments describing the individual configuration variables can be found at ‘doc fate_config sh template’ Create a configuration that suits your based on the configuration template The ‘slot’ configuration variable can be any string that is not yet but it is suggested that you name it adhering to the following pattern ‘ARCH OS COMPILER COMPILER VERSION’ The configuration file itself will be sourced in a shell therefore all shell features may be used This enables you to setup the environment as you need it for your build For your first test runs the ‘fate_recv’ variable should be empty or commented out This will run everything as normal except that it will omit the submission of the results to the server The following files should be present in $workdir as specified in the configuration it may help to try out the ‘ssh’ command with one or more ‘ v’ options You should get detailed output concerning your SSH configuration and the authentication process The only thing left is to automate the execution of the fate sh script and the synchronisation of the samples directory Uploading new samples to the fate suite *****************************************If you need a sample uploaded send a mail to samples request This is for developers who have an account on the fate suite server If you upload new please make sure they are as small as space on each network bandwidth and so on benefit from smaller test cases Also keep in mind older checkouts use existing sample that means in practice generally do not remove or overwrite files as it likely would break older checkouts or releases Also all needed samples for a commit should be ideally before the push If you need an account for frequently uploading samples or you wish to help others by doing that send a mail to ffmpeg devel rsync vauL Duo ug o o w
Definition: fate.txt:150
put_rac
#define put_rac(C, S, B)
FFV1Context
Definition: ffv1.h:78
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:91
encode_rgb_frame
static int RENAME() encode_rgb_frame(FFV1Context *s, const uint8_t *src[4], int w, int h, const int stride[4])
Definition: ffv1enc_template.c:125
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:28
AVERROR_INVALIDDATA
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:59
h
h
Definition: vp9dsp_template.c:2038
RangeCoder
Definition: mss3.c:61
FFV1Context::run_index
int run_index
Definition: ffv1.h:108
get_context
static int RENAME() get_context(PlaneContext *p, TYPE *src, TYPE *last, TYPE *last2)
Definition: ffv1_template.c:32
AV_CODEC_FLAG_PASS1
#define AV_CODEC_FLAG_PASS1
Use internal 2pass ratecontrol in first pass mode.
Definition: avcodec.h:296