summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorStefano Sabatini <stefasab@gmail.com>2012-10-15 10:06:52 +0200
committerStefano Sabatini <stefasab@gmail.com>2012-10-15 22:40:08 +0200
commitfaa1cb50ed7d2258932475ff571b7662f0089514 (patch)
tree24a27911afc56069d552e7636115de8b996e1800 /doc
parent22c5cc239c253a5940346915dc9aebf171b4ac48 (diff)
lavfi/ass: extend syntax for ass filter
Make the filter accept named options for the first argument, and update documentation accordingly.
Diffstat (limited to 'doc')
-rw-r--r--doc/filters.texi21
1 files changed, 14 insertions, 7 deletions
diff --git a/doc/filters.texi b/doc/filters.texi
index 1e5b52876e..916655ab1a 100644
--- a/doc/filters.texi
+++ b/doc/filters.texi
@@ -1230,26 +1230,33 @@ using the libass library.
To enable compilation of this filter you need to configure FFmpeg with
@code{--enable-libass}.
-This filter accepts the syntax: @var{ass_filename}[:@var{options}],
-where @var{ass_filename} is the filename of the ASS file to read, and
-@var{options} is an optional sequence of @var{key}=@var{value} pairs,
-separated by ":".
-
-A description of the accepted options follows.
+This filter accepts the following named options, expressed as a
+sequence of @var{key}=@var{value} pairs, separated by ":".
@table @option
+@item filename, f
+Set the filename of the ASS file to read. It must be specified.
+
@item original_size
-Specifies the size of the original video, the video for which the ASS file
+Specify the size of the original video, the video for which the ASS file
was composed. Due to a misdesign in ASS aspect ratio arithmetic, this is
necessary to correctly scale the fonts if the aspect ratio has been changed.
@end table
+If the first key is not specified, it is assumed that the first value
+specifies the @option{filename}.
+
For example, to render the file @file{sub.ass} on top of the input
video, use the command:
@example
ass=sub.ass
@end example
+which is equivalent to:
+@example
+ass=filename=sub.ass
+@end example
+
@section bbox
Compute the bounding box for the non-black pixels in the input frame