aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorClément Bœsch <ubitux@gmail.com>2013-04-11 21:59:53 +0200
committerClément Bœsch <ubitux@gmail.com>2013-04-11 22:05:03 +0200
commit71ef1ec7b482d7222717faae0a51f2fd4ef3bdf2 (patch)
tree541abb032c77f2a99faf6d69807fcc9b32b6cb0c /doc
parent647fe2e77733edf6e3a15c490056211bc38ccc20 (diff)
downloadffmpeg-71ef1ec7b482d7222717faae0a51f2fd4ef3bdf2.tar.gz
lavfi/aspect: switch to an AVOptions-based system.
This is heavily based on 2831b307 by Anton Khirnov <anton@khirnov.net>
Diffstat (limited to 'doc')
-rw-r--r--doc/filters.texi40
1 files changed, 20 insertions, 20 deletions
diff --git a/doc/filters.texi b/doc/filters.texi
index c6cf678c73..f812d8329d 100644
--- a/doc/filters.texi
+++ b/doc/filters.texi
@@ -5030,18 +5030,10 @@ Keep in mind that the sample aspect ratio set by the @code{setsar}
filter may be changed by later filters in the filterchain, e.g. if
another "setsar" or a "setdar" filter is applied.
-The @code{setdar} and @code{setsar} filters accept a string in the
-form @var{num}:@var{den} expressing an aspect ratio, or the following
-named options, expressed as a sequence of @var{key}=@var{value} pairs,
-separated by ":".
+The filters accept the following options:
@table @option
-@item max
-Set the maximum integer value to use for expressing numerator and
-denominator when reducing the expressed aspect ratio to a rational.
-Default value is @code{100}.
-
-@item r, ratio, dar, sar:
+@item r, ratio, dar (@code{setdar} only), sar (@code{setsar} only)
Set the aspect ratio used by the filter.
The parameter can be a floating point number string, an expression, or
@@ -5050,33 +5042,41 @@ a string of the form @var{num}:@var{den}, where @var{num} and
the parameter is not specified, it is assumed the value "0".
In case the form "@var{num}:@var{den}" the @code{:} character should
be escaped.
+
+@item max
+Set the maximum integer value to use for expressing numerator and
+denominator when reducing the expressed aspect ratio to a rational.
+Default value is @code{100}.
+
@end table
-If the keys are omitted in the named options list, the specifed values
-are assumed to be @var{ratio} and @var{max} in that order.
+@subsection Examples
-For example to change the display aspect ratio to 16:9, specify:
+@itemize
+
+@item
+To change the display aspect ratio to 16:9, specify one of the following:
@example
-setdar='16:9'
-# the above is equivalent to
-setdar=1.77777
+setdar=dar=1.77777
setdar=dar=16/9
setdar=dar=1.77777
@end example
+@item
To change the sample aspect ratio to 10:11, specify:
@example
-setsar='10:11'
-# the above is equivalent to
-setsar='sar=10/11'
+setsar=sar=10/11
@end example
+@item
To set a display aspect ratio of 16:9, and specify a maximum integer value of
1000 in the aspect ratio reduction, use the command:
@example
-setdar=ratio='16:9':max=1000
+setdar=ratio=16/9:max=1000
@end example
+@end itemize
+
@anchor{setfield}
@section setfield