doc/eval.texi

   1 @chapter Expression Evaluation
   2 @c man begin EXPRESSION EVALUATION
   3
   4 When evaluating an arithemetic expression, FFmpeg uses an internal
   5 formula evaluator, implemented through the @file{libavutil/eval.h}
   6 interface.
   7
   8 An expression may contain unary, binary operators, constants, and
   9 functions.
  10
  11 Two expressions @var{expr1} and @var{expr2} can be combined to form
  12 another expression "@var{expr1};@var{expr2}".
  13 @var{expr1} and @var{expr2} are evaluated in turn, and the new
  14 expression evaluates to the value of @var{expr2}.
  15
  16 The following binary operators are available: @code{+}, @code{-},
  17 @code{*}, @code{/}, @code{^}.
  18
  19 The following unary operators are available: @code{+}, @code{-}.
  20
  21 The following functions are available:
  22 @table @option
  23 @item sinh(x)
  24 @item cosh(x)
  25 @item tanh(x)
  26 @item sin(x)
  27 @item cos(x)
  28 @item tan(x)
  29 @item atan(x)
  30 @item asin(x)
  31 @item acos(x)
  32 @item exp(x)
  33 @item log(x)
  34 @item abs(x)
  35 @item squish(x)
  36 @item gauss(x)
  37 @item isnan(x)
  38 Return 1.0 if @var{x} is NAN, 0.0 otherwise.
  39
  40 @item mod(x, y)
  41 @item max(x, y)
  42 @item min(x, y)
  43 @item eq(x, y)
  44 @item gte(x, y)
  45 @item gt(x, y)
  46 @item lte(x, y)
  47 @item lt(x, y)
  48 @item st(var, expr)
  49 Allow to store the value of the expression @var{expr} in an internal
  50 variable. @var{var} specifies the number of the variable where to
  51 store the value, and it is a value ranging from 0 to 9. The function
  52 returns the value stored in the internal variable.
  53
  54 @item ld(var)
  55 Allow to load the value of the internal variable with number
  56 @var{var}, which was previosly stored with st(@var{var}, @var{expr}).
  57 The function returns the loaded value.
  58
  59 @item while(cond, expr)
  60 Evaluate expression @var{expr} while the expression @var{cond} is
  61 non-zero, and returns the value of the last @var{expr} evaluation, or
  62 NAN if @var{cond} was always false.
  63
  64 @item ceil(expr)
  65 Round the value of expression @var{expr} upwards to the nearest
  66 integer. For example, "ceil(1.5)" is "2.0".
  67
  68 @item floor(expr)
  69 Round the value of expression @var{expr} downwards to the nearest
  70 integer. For example, "floor(-1.5)" is "-2.0".
  71
  72 @item trunc(expr)
  73 Round the value of expression @var{expr} towards zero to the nearest
  74 integer. For example, "trunc(-1.5)" is "-1.0".
  75
  76 @item sqrt(expr)
  77 Compute the square root of @var{expr}. This is equivalent to
  78 "(@var{expr})^.5".
  79
  80 @item not(expr)
  81 Return 1.0 if @var{expr} is zero, 0.0 otherwise.
  82
  83 @item pow(x, y)
  84 Compute the power of @var{x} elevated @var{y}, it is equivalent to
  85 "(@var{x})^(@var{y})".
  86 @end table
  87
  88 Note that:
  89
  90 @code{*} works like AND
  91
  92 @code{+} works like OR
  93
  94 thus
  95 @example
  96 if A then B else C
  97 @end example
  98 is equivalent to
  99 @example
 100 A*B + not(A)*C
 101 @end example
 102
 103 In your C code, you can extend the list of unary and binary functions,
 104 and define recognized constants, so that they are available for your
 105 expressions.
 106
 107 The evaluator also recognizes the International System number
 108 postfixes. If 'i' is appended after the postfix, powers of 2 are used
 109 instead of powers of 10. The 'B' postfix multiplies the value for 8,
 110 and can be appended after another postfix or used alone. This allows
 111 using for example 'KB', 'MiB', 'G' and 'B' as postfix.
 112
 113 Follows the list of available International System postfixes, with
 114 indication of the corresponding powers of 10 and of 2.
 115 @table @option
 116 @item y
 117 -24 / -80
 118 @item z
 119 -21 / -70
 120 @item a
 121 -18 / -60
 122 @item f
 123 -15 / -50
 124 @item p
 125 -12 / -40
 126 @item n
 127 -9 / -30
 128 @item u
 129 -6 / -20
 130 @item m
 131 -3 / -10
 132 @item c
 133 -2
 134 @item d
 135 -1
 136 @item h
 137 2
 138 @item k
 139 3 / 10
 140 @item K
 141 3 / 10
 142 @item M
 143 6 / 20
 144 @item G
 145 9 / 30
 146 @item T
 147 12 / 40
 148 @item P
 149 15 / 40
 150 @item E
 151 18 / 50
 152 @item Z
 153 21 / 60
 154 @item Y
 155 24 / 70
 156 @end table
 157
 158 @c man end