FFmpeg
function.c
Go to the documentation of this file.
1 /*
2  * Copyright © 2025, Niklas Haas
3  * Copyright © 2018, VideoLAN and dav1d authors
4  * Copyright © 2018, Two Orioles, LLC
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions are met:
9  *
10  * 1. Redistributions of source code must retain the above copyright notice,
11  * this list of conditions and the following disclaimer.
12  *
13  * 2. Redistributions in binary form must reproduce the above copyright notice,
14  * this list of conditions and the following disclaimer in the documentation
15  * and/or other materials provided with the distribution.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
21  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27  * POSSIBILITY OF SUCH DAMAGE.
28  */
29 
30 #include <stdio.h>
31 #include <stdlib.h>
32 
33 #include "function.h"
34 #include "internal.h"
35 
36 /* Deallocate a tree */
37 static void func_uninit(CheckasmFunc *const f)
38 {
39  if (!f)
40  return;
41 
42  CheckasmFuncVersion *v = f->versions.next;
43  while (v) {
44  CheckasmFuncVersion *next = v->next;
45  free(v->suffix);
46  free(v);
47  v = next;
48  }
49 
50  CheckasmFunc *const left = f->child[0];
51  CheckasmFunc *const right = f->child[1];
52  free(f->report_name);
53  free(f);
54 
55  func_uninit(right);
57 }
58 
60 {
62  memset(tree, 0, sizeof(*tree));
63 }
64 
65 #define is_digit(x) ((x) >= '0' && (x) <= '9')
66 
67 /* ASCIIbetical sort except preserving natural order for numbers */
68 static int cmp_func_names(const char *a, const char *b)
69 {
70  const char *const start = a;
71 
72  int ascii_diff, digit_diff;
73  for (; !(ascii_diff = *(const unsigned char *) a - *(const unsigned char *) b) && *a;
74  a++, b++)
75  ;
76  for (; is_digit(*a) && is_digit(*b); a++, b++)
77  ;
78 
79  if (a > start && is_digit(a[-1]) && (digit_diff = is_digit(*a) - is_digit(*b)))
80  return digit_diff;
81 
82  return ascii_diff;
83 }
84 
85 /* Perform a tree rotation in the specified direction and return the new root */
86 static CheckasmFunc *tree_rotate(CheckasmFunc *const f, const int dir)
87 {
88  CheckasmFunc *const r = f->child[dir ^ 1];
89 
90  f->child[dir ^ 1] = r->child[dir];
91  r->child[dir] = f;
92  r->color = f->color;
93  f->color = 0;
94  return r;
95 }
96 
97 #define is_red(f) ((f) && !(f)->color)
98 
99 /* Balance a left-leaning red-black tree at the specified node */
100 static void tree_balance(CheckasmFunc **const root)
101 {
102  CheckasmFunc *const f = *root;
103 
104  if (is_red(f->child[0]) && is_red(f->child[1])) {
105  f->color ^= 1;
106  f->child[0]->color = f->child[1]->color = 1;
107  } else if (!is_red(f->child[0]) && is_red(f->child[1]))
108  *root = tree_rotate(f, 0); /* Rotate left */
109  else if (is_red(f->child[0]) && is_red(f->child[0]->child[0]))
110  *root = tree_rotate(f, 1); /* Rotate right */
111 }
112 
113 /* Get a node with the specified name, creating it if it doesn't exist; returns
114  * 1 if a new node was inserted, 0 otherwise. */
115 static int func_get(CheckasmFunc **const root, const char *const name,
116  CheckasmFunc **const out_func)
117 {
118  CheckasmFunc *f = *root;
119  if (!f) {
120  /* Allocate and insert a new node into the tree */
121  const size_t name_length = strlen(name) + 1;
122  f = checkasm_mallocz(offsetof(CheckasmFunc, name) + name_length);
123  memcpy(f->name, name, name_length);
124  *out_func = *root = f;
125  return 1;
126  }
127 
128  /* Search the tree for a matching node */
129  const int cmp = cmp_func_names(name, f->name);
130  if (!cmp) {
131  *out_func = f;
132  return 0;
133  }
134 
135  int inserted = func_get(&f->child[cmp > 0], name, out_func);
136  if (inserted)
137  tree_balance(root); /* Rebalance the tree on the way up */
138  return inserted;
139 }
140 
142 {
144  int inserted = func_get(&tree->root, name, &func);
145  if (inserted)
146  tree->root->color = 1; /* Ensure root is black */
147  return func;
148 }
func
int(* func)(AVBPrint *dst, const char *in, const char *arg)
Definition: jacosubdec.c:66
func_uninit
static void func_uninit(CheckasmFunc *const f)
Definition: function.c:37
name
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 name
Definition: writing_filters.txt:88
CheckasmFuncTree::root
CheckasmFunc * root
Definition: function.h:62
r
const char * r
Definition: vf_curves.c:127
CheckasmFunc
Definition: function.h:50
CheckasmFuncVersion::suffix
char * suffix
Definition: function.h:44
b
#define b
Definition: input.c:43
tree_balance
static void tree_balance(CheckasmFunc **const root)
Definition: function.c:100
func_get
static int func_get(CheckasmFunc **const root, const char *const name, CheckasmFunc **const out_func)
Definition: function.c:115
checkasm_func_tree_uninit
void checkasm_func_tree_uninit(CheckasmFuncTree *tree)
Definition: function.c:59
CheckasmFuncVersion
Definition: function.h:41
checkasm_mallocz
static void * checkasm_mallocz(const size_t size)
Definition: internal.h:180
CheckasmFuncTree
Definition: function.h:61
NULL
#define NULL
Definition: coverity.c:32
CheckasmFunc::color
uint8_t color
Definition: function.h:57
f
f
Definition: af_crystalizer.c:122
cmp
static av_always_inline int cmp(MPVEncContext *const s, const int x, const int y, const int subx, const int suby, const int size, const int h, int ref_index, int src_index, me_cmp_func cmp_func, me_cmp_func chroma_cmp_func, const int flags)
compares a block (either a full macroblock or a partition thereof) against a proposed motion-compensa...
Definition: motion_est.c:263
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
function.h
CheckasmFuncVersion::next
struct CheckasmFuncVersion * next
Definition: function.h:42
cmp_func_names
static int cmp_func_names(const char *a, const char *b)
Definition: function.c:68
left
Tag MUST be and< 10hcoeff half pel interpolation filter coefficients, hcoeff[0] are the 2 middle coefficients[1] are the next outer ones and so on, resulting in a filter like:...eff[2], hcoeff[1], hcoeff[0], hcoeff[0], hcoeff[1], hcoeff[2] ... the sign of the coefficients is not explicitly stored but alternates after each coeff and coeff[0] is positive, so ...,+,-,+,-,+,+,-,+,-,+,... hcoeff[0] is not explicitly stored but found by subtracting the sum of all stored coefficients with signs from 32 hcoeff[0]=32 - hcoeff[1] - hcoeff[2] - ... a good choice for hcoeff and htaps is htaps=6 hcoeff={40,-10, 2} an alternative which requires more computations at both encoder and decoder side and may or may not be better is htaps=8 hcoeff={42,-14, 6,-2}ref_frames minimum of the number of available reference frames and max_ref_frames for example the first frame after a key frame always has ref_frames=1spatial_decomposition_type wavelet type 0 is a 9/7 symmetric compact integer wavelet 1 is a 5/3 symmetric compact integer wavelet others are reserved stored as delta from last, last is reset to 0 if always_reset||keyframeqlog quality(logarithmic quantizer scale) stored as delta from last, last is reset to 0 if always_reset||keyframemv_scale stored as delta from last, last is reset to 0 if always_reset||keyframe FIXME check that everything works fine if this changes between framesqbias dequantization bias stored as delta from last, last is reset to 0 if always_reset||keyframeblock_max_depth maximum depth of the block tree stored as delta from last, last is reset to 0 if always_reset||keyframequant_table quantization tableHighlevel bitstream structure:==============================--------------------------------------------|Header|--------------------------------------------|------------------------------------|||Block0||||split?||||yes no||||......... intra?||||:Block01 :yes no||||:Block02 :....... ..........||||:Block03 ::y DC ::ref index:||||:Block04 ::cb DC ::motion x :||||......... :cr DC ::motion y :||||....... ..........|||------------------------------------||------------------------------------|||Block1|||...|--------------------------------------------|------------ ------------ ------------|||Y subbands||Cb subbands||Cr subbands||||--- ---||--- ---||--- ---|||||LL0||HL0||||LL0||HL0||||LL0||HL0|||||--- ---||--- ---||--- ---||||--- ---||--- ---||--- ---|||||LH0||HH0||||LH0||HH0||||LH0||HH0|||||--- ---||--- ---||--- ---||||--- ---||--- ---||--- ---|||||HL1||LH1||||HL1||LH1||||HL1||LH1|||||--- ---||--- ---||--- ---||||--- ---||--- ---||--- ---|||||HH1||HL2||||HH1||HL2||||HH1||HL2|||||...||...||...|||------------ ------------ ------------|--------------------------------------------Decoding process:=================------------|||Subbands|------------||||------------|Intra DC||||LL0 subband prediction ------------|\ Dequantization ------------------- \||Reference frames|\ IDWT|------- -------|Motion \|||Frame 0||Frame 1||Compensation . OBMC v -------|------- -------|--------------. \------> Frame n output Frame Frame<----------------------------------/|...|------------------- Range Coder:============Binary Range Coder:------------------- The implemented range coder is an adapted version based upon "Range encoding: an algorithm for removing redundancy from a digitised message." by G. N. N. Martin. The symbols encoded by the Snow range coder are bits(0|1). The associated probabilities are not fix but change depending on the symbol mix seen so far. bit seen|new state ---------+----------------------------------------------- 0|256 - state_transition_table[256 - old_state];1|state_transition_table[old_state];state_transition_table={ 0, 0, 0, 0, 0, 0, 0, 0, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 114, 115, 116, 117, 118, 119, 120, 121, 122, 123, 124, 125, 126, 127, 128, 129, 130, 131, 132, 133, 133, 134, 135, 136, 137, 138, 139, 140, 141, 142, 143, 144, 145, 146, 147, 148, 149, 150, 151, 152, 152, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 171, 172, 173, 174, 175, 176, 177, 178, 179, 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 190, 191, 192, 194, 194, 195, 196, 197, 198, 199, 200, 201, 202, 202, 204, 205, 206, 207, 208, 209, 209, 210, 211, 212, 213, 215, 215, 216, 217, 218, 219, 220, 220, 222, 223, 224, 225, 226, 227, 227, 229, 229, 230, 231, 232, 234, 234, 235, 236, 237, 238, 239, 240, 241, 242, 243, 244, 245, 246, 247, 248, 248, 0, 0, 0, 0, 0, 0, 0};FIXME Range Coding of integers:------------------------- FIXME Neighboring Blocks:===================left and top are set to the respective blocks unless they are outside of the image in which case they are set to the Null block top-left is set to the top left block unless it is outside of the image in which case it is set to the left block if this block has no larger parent block or it is at the left side of its parent block and the top right block is not outside of the image then the top right block is used for top-right else the top-left block is used Null block y, cb, cr are 128 level, ref, mx and my are 0 Motion Vector Prediction:=========================1. the motion vectors of all the neighboring blocks are scaled to compensate for the difference of reference frames scaled_mv=(mv *(256 *(current_reference+1)/(mv.reference+1))+128)> the median of the scaled left
Definition: snow.txt:386
tree
CheckasmFuncTree tree
Definition: checkasm.c:79
is_digit
#define is_digit(x)
Definition: function.c:65
is_red
#define is_red(f)
Definition: function.c:97
internal.h
checkasm_func_get
CheckasmFunc * checkasm_func_get(CheckasmFuncTree *tree, const char *const name)
Definition: function.c:141
tree_rotate
static CheckasmFunc * tree_rotate(CheckasmFunc *const f, const int dir)
Definition: function.c:86