utils.texi 14.1 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259
@chapter Syntax
@c man begin SYNTAX

This section documents the syntax and formats employed by the FFmpeg
libraries and tools.

@anchor{quoting_and_escaping}
@section Quoting and escaping

FFmpeg adopts the following quoting and escaping mechanism, unless
explicitly specified. The following rules are applied:

@itemize
@item
@code{'} and @code{\} are special characters (respectively used for
quoting and escaping). In addition to them, there might be other
special characters depending on the specific syntax where the escaping
and quoting are employed.

@item
A special character is escaped by prefixing it with a '\'.

@item
All characters enclosed between '' are included literally in the
parsed string. The quote character @code{'} itself cannot be quoted,
so you may need to close the quote and escape it.

@item
Leading and trailing whitespaces, unless escaped or quoted, are
removed from the parsed string.
@end itemize

Note that you may need to add a second level of escaping when using
the command line or a script, which depends on the syntax of the
adopted shell language.

The function @code{av_get_token} defined in
@file{libavutil/avstring.h} can be used to parse a token quoted or
escaped according to the rules defined above.

The tool @file{tools/ffescape} in the FFmpeg source tree can be used
to automatically quote or escape a string in a script.

@subsection Examples

@itemize
@item
Escape the string @code{Crime d'Amour} containing the @code{'} special
character:
@example
Crime d\'Amour
@end example

@item
The string above contains a quote, so the @code{'} needs to be escaped
when quoting it:
@example
'Crime d'\''Amour'
@end example

@item
Include leading or trailing whitespaces using quoting:
@example
'  this string starts and ends with whitespaces  '
@end example

@item
Escaping and quoting can be mixed together:
@example
' The string '\'string\'' is a string '
@end example

@item
To include a literal @code{\} you can use either escaping or quoting:
@example
'c:\foo' can be written as c:\\foo
@end example
@end itemize

@anchor{date syntax}
@section Date

The accepted syntax is:
@example
[(YYYY-MM-DD|YYYYMMDD)[T|t| ]]((HH:MM:SS[.m...]]])|(HHMMSS[.m...]]]))[Z]
now
@end example

If the value is "now" it takes the current time.

Time is local time unless Z is appended, in which case it is
interpreted as UTC.
If the year-month-day part is not specified it takes the current
year-month-day.

@anchor{time duration syntax}
@section Time duration

The accepted syntax is:
@example
[-][HH:]MM:SS[.m...]
[-]S+[.m...]
@end example

@var{HH} expresses the number of hours, @var{MM} the number a of minutes
and @var{SS} the number of seconds.

@anchor{video size syntax}
@section Video size
Specify the size of the sourced video, it may be a string of the form
@var{width}x@var{height}, or the name of a size abbreviation.

The following abbreviations are recognized:
@table @samp
@item ntsc
720x480
@item pal
720x576
@item qntsc
352x240
@item qpal
352x288
@item sntsc
640x480
@item spal
768x576
@item film
352x240
@item ntsc-film
352x240
@item sqcif
128x96
@item qcif
176x144
@item cif
352x288
@item 4cif
704x576
@item 16cif
1408x1152
@item qqvga
160x120
@item qvga
320x240
@item vga
640x480
@item svga
800x600
@item xga
1024x768
@item uxga
1600x1200
@item qxga
2048x1536
@item sxga
1280x1024
@item qsxga
2560x2048
@item hsxga
5120x4096
@item wvga
852x480
@item wxga
1366x768
@item wsxga
1600x1024
@item wuxga
1920x1200
@item woxga
2560x1600
@item wqsxga
3200x2048
@item wquxga
3840x2400
@item whsxga
6400x4096
@item whuxga
7680x4800
@item cga
320x200
@item ega
640x350
@item hd480
852x480
@item hd720
1280x720
@item hd1080
1920x1080
@item 2k
2048x1080
@item 2kflat
1998x1080
@item 2kscope
2048x858
@item 4k
4096x2160
@item 4kflat
3996x2160
@item 4kscope
4096x1716
@end table

@anchor{video rate syntax}
@section Video rate

Specify the frame rate of a video, expressed as the number of frames
generated per second. It has to be a string in the format
@var{frame_rate_num}/@var{frame_rate_den}, an integer number, a float
number or a valid video frame rate abbreviation.

The following abbreviations are recognized:
@table @samp
@item ntsc
30000/1001
@item pal
25/1
@item qntsc
30000/1001
@item qpal
25/1
@item sntsc
30000/1001
@item spal
25/1
@item film
24/1
@item ntsc-film
24000/1001
@end table

@anchor{ratio syntax}
@section Ratio

A ratio can be expressed as an expression, or in the form
@var{numerator}:@var{denominator}.

Note that a ratio with infinite (1/0) or negative value is
considered valid, so you should check on the returned value if you
want to exclude those values.

The undefined value can be expressed using the "0:0" string.

@anchor{color syntax}
@section Color

It can be the name of a color (case insensitive match) or a
[0x|#]RRGGBB[AA] sequence, possibly followed by "@@" and a string
representing the alpha component.

The alpha component may be a string composed by "0x" followed by an
hexadecimal number or a decimal number between 0.0 and 1.0, which
represents the opacity value (0x00/0.0 means completely transparent,
0xff/1.0 completely opaque).
If the alpha component is not specified then 0xff is assumed.

The string "random" will result in a random color.

@c man end SYNTAX

Stefano Sabatini's avatar
Stefano Sabatini committed
260 261 262
@chapter Expression Evaluation
@c man begin EXPRESSION EVALUATION

263
When evaluating an arithmetic expression, FFmpeg uses an internal
Stefano Sabatini's avatar
Stefano Sabatini committed
264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281
formula evaluator, implemented through the @file{libavutil/eval.h}
interface.

An expression may contain unary, binary operators, constants, and
functions.

Two expressions @var{expr1} and @var{expr2} can be combined to form
another expression "@var{expr1};@var{expr2}".
@var{expr1} and @var{expr2} are evaluated in turn, and the new
expression evaluates to the value of @var{expr2}.

The following binary operators are available: @code{+}, @code{-},
@code{*}, @code{/}, @code{^}.

The following unary operators are available: @code{+}, @code{-}.

The following functions are available:
@table @option
282 283
@item abs(x)
Compute absolute value of @var{x}.
284

285 286
@item acos(x)
Compute arccosine of @var{x}.
287

288 289
@item asin(x)
Compute arcsine of @var{x}.
290

291 292 293
@item atan(x)
Compute arctangent of @var{x}.

294 295 296 297
@item between(x, min, max)
Return 1 if @var{x} is greater than or equal to @var{min} and lesser than or
equal to @var{max}, 0 otherwise.

298 299 300 301 302 303 304 305 306 307 308
@item bitand(x, y)
@item bitor(x, y)
Compute bitwise and/or operation on @var{x} and @var{y}.

The results of the evaluation of @var{x} and @var{y} are converted to
integers before executing the bitwise operation.

Note that both the conversion to integer and the conversion back to
floating point can lose precision. Beware of unexpected results for
large numbers (usually 2^53 and larger).

309 310 311
@item ceil(expr)
Round the value of expression @var{expr} upwards to the nearest
integer. For example, "ceil(1.5)" is "2.0".
312

Stefano Sabatini's avatar
Stefano Sabatini committed
313
@item cos(x)
314 315
Compute cosine of @var{x}.

316 317
@item cosh(x)
Compute hyperbolic cosine of @var{x}.
318

319 320
@item eq(x, y)
Return 1 if @var{x} and @var{y} are equivalent, 0 otherwise.
321

Stefano Sabatini's avatar
Stefano Sabatini committed
322
@item exp(x)
323 324
Compute exponential of @var{x} (with base @code{e}, the Euler's number).

325 326 327
@item floor(expr)
Round the value of expression @var{expr} downwards to the nearest
integer. For example, "floor(-1.5)" is "-2.0".
328

Stefano Sabatini's avatar
Stefano Sabatini committed
329
@item gauss(x)
330 331 332
Compute Gauss function of @var{x}, corresponding to
@code{exp(-x*x/2) / sqrt(2*PI)}.

333 334 335
@item gcd(x, y)
Return the greatest common divisor of @var{x} and @var{y}. If both @var{x} and
@var{y} are 0 or either or both are less than zero then behavior is undefined.
336

337 338
@item gt(x, y)
Return 1 if @var{x} is greater than @var{y}, 0 otherwise.
339

340 341
@item gte(x, y)
Return 1 if @var{x} is greater than or equal to @var{y}, 0 otherwise.
342

343 344 345 346 347
@item hypot(x, y)
This function is similar to the C function with the same name; it returns
"sqrt(@var{x}*@var{x} + @var{y}*@var{y})", the length of the hypotenuse of a
right triangle with sides of length @var{x} and @var{y}, or the distance of the
point (@var{x}, @var{y}) from the origin.
348

349 350 351
@item if(x, y)
Evaluate @var{x}, and if the result is non-zero return the result of
the evaluation of @var{y}, return 0 otherwise.
352

353 354 355
@item if(x, y, z)
Evaluate @var{x}, and if the result is non-zero return the evaluation
result of @var{y}, otherwise the evaluation result of @var{z}.
356

357 358 359
@item ifnot(x, y)
Evaluate @var{x}, and if the result is zero return the result of the
evaluation of @var{y}, return 0 otherwise.
360

361 362 363
@item ifnot(x, y, z)
Evaluate @var{x}, and if the result is zero return the evaluation
result of @var{y}, otherwise the evaluation result of @var{z}.
364

365 366
@item isinf(x)
Return 1.0 if @var{x} is +/-INFINITY, 0.0 otherwise.
367

368 369
@item isnan(x)
Return 1.0 if @var{x} is NAN, 0.0 otherwise.
Stefano Sabatini's avatar
Stefano Sabatini committed
370 371 372

@item ld(var)
Allow to load the value of the internal variable with number
373
@var{var}, which was previously stored with st(@var{var}, @var{expr}).
Stefano Sabatini's avatar
Stefano Sabatini committed
374 375
The function returns the loaded value.

376 377
@item log(x)
Compute natural logarithm of @var{x}.
378

379 380
@item lt(x, y)
Return 1 if @var{x} is lesser than @var{y}, 0 otherwise.
381

382 383
@item lte(x, y)
Return 1 if @var{x} is lesser than or equal to @var{y}, 0 otherwise.
384

385 386
@item max(x, y)
Return the maximum between @var{x} and @var{y}.
387

388 389 390 391 392
@item min(x, y)
Return the maximum between @var{x} and @var{y}.

@item mod(x, y)
Compute the remainder of division of @var{x} by @var{y}.
393 394 395

@item not(expr)
Return 1.0 if @var{expr} is zero, 0.0 otherwise.
396 397 398 399

@item pow(x, y)
Compute the power of @var{x} elevated @var{y}, it is equivalent to
"(@var{x})^(@var{y})".
400

401 402 403 404 405 406 407 408
@item print(t)
@item print(t, l)
Print the value of expression @var{t} with loglevel @var{l}. If
@var{l} is not specified then a default log level is used.
Returns the value of the expression printed.

Prints t with loglevel l

409 410 411 412
@item random(x)
Return a pseudo random value between 0.0 and 1.0. @var{x} is the index of the
internal variable which will be used to save the seed/state.

413 414 415
@item root(expr, max)
Find an input value for which the function represented by @var{expr}
with argument @var{ld(0)} is 0 in the interval 0..@var{max}.
416

417 418
The expression in @var{expr} must denote a continuous function or the
result is undefined.
419

420 421 422 423 424
@var{ld(0)} is used to represent the function input value, which means
that the given expression will be evaluated multiple times with
various input values that the expression can access through
@code{ld(0)}. When the expression evaluates to 0 then the
corresponding input value will be returned.
425

426 427
@item sin(x)
Compute sine of @var{x}.
428

429 430
@item sinh(x)
Compute hyperbolic sine of @var{x}.
431

432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450
@item sqrt(expr)
Compute the square root of @var{expr}. This is equivalent to
"(@var{expr})^.5".

@item squish(x)
Compute expression @code{1/(1 + exp(4*x))}.

@item st(var, expr)
Allow to store the value of the expression @var{expr} in an internal
variable. @var{var} specifies the number of the variable where to
store the value, and it is a value ranging from 0 to 9. The function
returns the value stored in the internal variable.
Note, Variables are currently not shared between expressions.

@item tan(x)
Compute tangent of @var{x}.

@item tanh(x)
Compute hyperbolic tangent of @var{x}.
451

452 453 454 455 456 457 458 459 460 461 462 463 464 465
@item taylor(expr, x)
@item taylor(expr, x, id)
Evaluate a Taylor series at @var{x}, given an expression representing
the @code{ld(id)}-th derivative of a function at 0.

When the series does not converge the result is undefined.

@var{ld(id)} is used to represent the derivative order in @var{expr},
which means that the given expression will be evaluated multiple times
with various input values that the expression can access through
@code{ld(id)}. If @var{id} is not specified then 0 is assumed.

Note, when you have the derivatives at y instead of 0,
@code{taylor(expr, x-y)} can be used.
466

467
@item time(0)
468
Return the current (wallclock) time in seconds.
469

470 471 472
@item trunc(expr)
Round the value of expression @var{expr} towards zero to the nearest
integer. For example, "trunc(-1.5)" is "-1.0".
473

474 475 476 477
@item while(cond, expr)
Evaluate expression @var{expr} while the expression @var{cond} is
non-zero, and returns the value of the last @var{expr} evaluation, or
NAN if @var{cond} was always false.
Stefano Sabatini's avatar
Stefano Sabatini committed
478 479
@end table

480 481 482
The following constants are available:
@table @option
@item PI
483
area of the unit disc, approximately 3.14
484
@item E
485
exp(1) (Euler's number), approximately 2.718
486
@item PHI
487
golden ratio (1+sqrt(5))/2, approximately 1.618
488 489
@end table

490 491
Assuming that an expression is considered "true" if it has a non-zero
value, note that:
Stefano Sabatini's avatar
Stefano Sabatini committed
492 493 494 495 496

@code{*} works like AND

@code{+} works like OR

497
For example the construct:
Stefano Sabatini's avatar
Stefano Sabatini committed
498
@example
499
if (A AND B) then C
Stefano Sabatini's avatar
Stefano Sabatini committed
500
@end example
501
is equivalent to:
Stefano Sabatini's avatar
Stefano Sabatini committed
502
@example
503
if(A*B, C)
Stefano Sabatini's avatar
Stefano Sabatini committed
504 505 506 507 508 509
@end example

In your C code, you can extend the list of unary and binary functions,
and define recognized constants, so that they are available for your
expressions.

510 511 512 513 514 515 516 517
The evaluator also recognizes the International System unit prefixes.
If 'i' is appended after the prefix, binary prefixes are used, which
are based on powers of 1024 instead of powers of 1000.
The 'B' postfix multiplies the value by 8, and can be appended after a
unit prefix or used alone. This allows using for example 'KB', 'MiB',
'G' and 'B' as number postfix.

The list of available International System prefixes follows, with
Stefano Sabatini's avatar
Stefano Sabatini committed
518 519 520
indication of the corresponding powers of 10 and of 2.
@table @option
@item y
521
10^-24 / 2^-80
Stefano Sabatini's avatar
Stefano Sabatini committed
522
@item z
523
10^-21 / 2^-70
Stefano Sabatini's avatar
Stefano Sabatini committed
524
@item a
525
10^-18 / 2^-60
Stefano Sabatini's avatar
Stefano Sabatini committed
526
@item f
527
10^-15 / 2^-50
Stefano Sabatini's avatar
Stefano Sabatini committed
528
@item p
529
10^-12 / 2^-40
Stefano Sabatini's avatar
Stefano Sabatini committed
530
@item n
531
10^-9 / 2^-30
Stefano Sabatini's avatar
Stefano Sabatini committed
532
@item u
533
10^-6 / 2^-20
Stefano Sabatini's avatar
Stefano Sabatini committed
534
@item m
535
10^-3 / 2^-10
Stefano Sabatini's avatar
Stefano Sabatini committed
536
@item c
537
10^-2
Stefano Sabatini's avatar
Stefano Sabatini committed
538
@item d
539
10^-1
Stefano Sabatini's avatar
Stefano Sabatini committed
540
@item h
541
10^2
Stefano Sabatini's avatar
Stefano Sabatini committed
542
@item k
543
10^3 / 2^10
Stefano Sabatini's avatar
Stefano Sabatini committed
544
@item K
545
10^3 / 2^10
Stefano Sabatini's avatar
Stefano Sabatini committed
546
@item M
547
10^6 / 2^20
Stefano Sabatini's avatar
Stefano Sabatini committed
548
@item G
549
10^9 / 2^30
Stefano Sabatini's avatar
Stefano Sabatini committed
550
@item T
551
10^12 / 2^40
Stefano Sabatini's avatar
Stefano Sabatini committed
552
@item P
553
10^15 / 2^40
Stefano Sabatini's avatar
Stefano Sabatini committed
554
@item E
555
10^18 / 2^50
Stefano Sabatini's avatar
Stefano Sabatini committed
556
@item Z
557
10^21 / 2^60
Stefano Sabatini's avatar
Stefano Sabatini committed
558
@item Y
559
10^24 / 2^70
Stefano Sabatini's avatar
Stefano Sabatini committed
560 561 562
@end table

@c man end
563 564 565 566 567

@chapter OpenCL Options
@c man begin OPENCL OPTIONS

When FFmpeg is configured with @code{--enable-opencl}, it is possible
568 569 570
to set the options for the global OpenCL context.

The list of supported options follows:
571 572 573

@table @option
@item build_options
574 575 576
Set build options used to compile the registered kernels.

See reference "OpenCL Specification Version: 1.2 chapter 5.6.4".
577 578

@item platform_idx
579 580 581
Select the index of the platform to run OpenCL code.

The specified index must be one of the indexes in the device list
582
which can be obtained with @code{av_opencl_get_device_list()}.
583 584

@item device_idx
585 586 587
Select the index of the device used to run OpenCL code.

The specifed index must be one of the indexes in the device list which
588
can be obtained with @code{av_opencl_get_device_list()}.
589 590 591 592

@end table

@c man end OPENCL OPTIONS