1
0
mirror of https://github.com/FFmpeg/FFmpeg.git synced 2025-08-15 14:13:16 +02:00

doc/filters: reference ffmpeg-utils manual for color and sizes options

Signed-off-by: Timothy Gu <timothygu99@gmail.com>
Signed-off-by: Stefano Sabatini <stefasab@gmail.com>
This commit is contained in:
Timothy Gu
2013-10-13 18:37:12 -07:00
committed by Stefano Sabatini
parent 155a5ff00d
commit 586b8ea248

View File

@@ -3191,8 +3191,8 @@ The expressions which specify the width and height of the box, if 0 they are int
the input width and height. Default to 0. the input width and height. Default to 0.
@item color, c @item color, c
Specify the color of the box to write, it can be the name of a color Specify the color of the box to write. For the general syntax of this option,
(case insensitive match) or a 0xRRGGBB[AA] sequence. If the special check the "Color" section in the ffmpeg-utils manual. If the special
value @code{invert} is used, the box edge color is the same as the value @code{invert} is used, the box edge color is the same as the
video with inverted luma. video with inverted luma.
@@ -3288,12 +3288,10 @@ input width and height, respectively, minus @code{thickness}, so image gets
framed. Default to 0. framed. Default to 0.
@item color, c @item color, c
Specify the color of the grid, it can be the name of a color Specify the color of the grid. For the general syntax of this option,
(case insensitive match) or a 0xRRGGBB[AA] sequence. If the special check the "Color" section in the ffmpeg-utils manual. If the special
value @code{invert} is used, the grid color is the same as the value @code{invert} is used, the grid color is the same as the
video with inverted luma. video with inverted luma.
Note that you can append opacity value (in range of 0.0 - 1.0)
to color name after @@ sign.
@item thickness, t @item thickness, t
The expression which sets the thickness of the grid line. Default value is @code{1}. The expression which sets the thickness of the grid line. Default value is @code{1}.
@@ -3373,9 +3371,9 @@ Value should be either 1 (enable) or 0 (disable).
The default value of @var{box} is 0. The default value of @var{box} is 0.
@item boxcolor @item boxcolor
The color to be used for drawing box around text. The color to be used for drawing box around text. For the syntax of this
Either a string (e.g. "yellow") or in 0xRRGGBB[AA] format option, check the "Color" section in the ffmpeg-utils manual.
(e.g. "0xff00ff"), possibly followed by an alpha specifier.
The default value of @var{boxcolor} is "white". The default value of @var{boxcolor} is "white".
@item expansion @item expansion
@@ -3388,9 +3386,9 @@ below for details.
If true, check and fix text coords to avoid clipping. If true, check and fix text coords to avoid clipping.
@item fontcolor @item fontcolor
The color to be used for drawing fonts. The color to be used for drawing fonts. For the syntax of this option, check
Either a string (e.g. "red") or in 0xRRGGBB[AA] format the "Color" section in the ffmpeg-utils manual.
(e.g. "0xff000033"), possibly followed by an alpha specifier.
The default value of @var{fontcolor} is "black". The default value of @var{fontcolor} is "black".
@item fontfile @item fontfile
@@ -3430,9 +3428,9 @@ For more information consult the documentation for the FT_LOAD_*
libfreetype flags. libfreetype flags.
@item shadowcolor @item shadowcolor
The color to be used for drawing a shadow behind the drawn text. It The color to be used for drawing a shadow behind the drawn text. For the
can be a color name (e.g. "yellow") or a string in the 0xRRGGBB[AA] syntax of this option, check the "Color" section in the ffmpeg-utils manual.
form (e.g. "0xff00ff"), possibly followed by an alpha specifier.
The default value of @var{shadowcolor} is "black". The default value of @var{shadowcolor} is "black".
@item shadowx @item shadowx
@@ -4357,9 +4355,9 @@ A '|'-separated list of parameters to pass to the frei0r effect.
A frei0r effect parameter can be a boolean (whose values are specified A frei0r effect parameter can be a boolean (whose values are specified
with "y" and "n"), a double, a color (specified by the syntax with "y" and "n"), a double, a color (specified by the syntax
@var{R}/@var{G}/@var{B}, @var{R}, @var{G}, and @var{B} being float @var{R}/@var{G}/@var{B}, (@var{R}, @var{G}, and @var{B} being float
numbers from 0.0 to 1.0) or by an @code{av_parse_color()} color numbers from 0.0 to 1.0) or by a color description specified in the "Color"
description), a position (specified by the syntax @var{X}/@var{Y}, section in the ffmpeg-utils manual), a position (specified by the syntax @var{X}/@var{Y},
@var{X} and @var{Y} being float numbers) and a string. @var{X} and @var{Y} being float numbers) and a string.
The number and kind of parameters depend on the loaded effect. If an The number and kind of parameters depend on the loaded effect. If an
@@ -5840,8 +5838,8 @@ expression, and vice versa.
The default value of @var{x} and @var{y} is 0. The default value of @var{x} and @var{y} is 0.
@item color @item color
Specify the color of the padded area, it can be the name of a color Specify the color of the padded area. For the syntax of this option,
(case insensitive match) or a 0xRRGGBB[AA] sequence. check the "Color" section in the ffmpeg-utils manual.
The default value of @var{color} is "black". The default value of @var{color} is "black".
@end table @end table
@@ -6421,9 +6419,11 @@ it. Default value is 1.
@item fillcolor, c @item fillcolor, c
Set the color used to fill the output area not covered by the rotated Set the color used to fill the output area not covered by the rotated
image. If the special value "none" is selected then no background is image. For the generalsyntax of this option, check the "Color" section in the
printed (useful for example if the background is never shown). Default ffmpeg-utils manual. If the special value "none" is selected then no
value is "black". background is printed (useful for example if the background is never shown).
Default value is "black".
@end table @end table
The expressions for the angle and the output size can contain the The expressions for the angle and the output size can contain the
@@ -6611,8 +6611,8 @@ complete list of values. If not explictly specified the filter applies
the default flags. the default flags.
@item size, s @item size, s
Set the video size, the value must be a valid abbreviation or in the Set the video size. For the syntax of this option, check the "Video size"
form @var{width}x@var{height}. section in the ffmpeg-utils manual.
@item in_color_matrix @item in_color_matrix
@item out_color_matrix @item out_color_matrix
@@ -6978,8 +6978,8 @@ sample aspect ratio of the input frame, expressed in the form
@var{num}/@var{den} @var{num}/@var{den}
@item s @item s
size of the input frame, expressed in the form size of the input frame. For the syntax of this option, check the "Video size"
@var{width}x@var{height} section in the ffmpeg-utils manual.
@item i @item i
interlaced mode ("P" for "progressive", "T" for top field first, "B" interlaced mode ("P" for "progressive", "T" for top field first, "B"
@@ -7247,8 +7247,10 @@ Set the filename of the subtitle file to read. It must be specified.
@item original_size @item original_size
Specify 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 was composed. For the syntax of this option, check the "Video size" section in
necessary to correctly scale the fonts if the aspect ratio has been changed. the ffmpeg-utils manual. Due to a misdesign in ASS aspect ratio arithmetic,
this is necessary to correctly scale the fonts if the aspect ratio has been
changed.
@item charenc @item charenc
Set subtitles input character encoding. @code{subtitles} filter only. Only Set subtitles input character encoding. @code{subtitles} filter only. Only
@@ -7358,8 +7360,8 @@ The filter accepts the following options:
@table @option @table @option
@item layout @item layout
Set the grid size (i.e. the number of lines and columns) in the form Set the grid size (i.e. the number of lines and columns). For the syntax of
"@var{w}x@var{h}". this option, check the "Video size" section in the ffmpeg-utils manual.
@item nb_frames @item nb_frames
Set the maximum number of frames to render in the given area. It must be less Set the maximum number of frames to render in the given area. It must be less
@@ -7375,9 +7377,9 @@ more advanced padding options (such as having different values for the edges),
refer to the pad video filter. refer to the pad video filter.
@item color @item color
Specify the color of the unused area, it can be the name of a color Specify the color of the unused areaFor the syntax of this option, check the
(case insensitive match) or a 0xRRGGBB[AA] sequence. "Color" section in the ffmpeg-utils manual. The default value of @var{color}
The default value of @var{color} is "black". is "black".
@end table @end table
@subsection Examples @subsection Examples
@@ -8145,7 +8147,9 @@ This source accepts the following options:
@table @option @table @option
@item video_size @item video_size
Specify the size (width and height) of the buffered video frames. Specify the size (width and height) of the buffered video frames. For the
syntax of this option, check the "Video size" section in the ffmpeg-utils
manual.
@item width @item width
Input video width. Input video width.
@@ -8245,7 +8249,8 @@ Set the cellular automaton rule, it is a number ranging from 0 to 255.
Default value is 110. Default value is 110.
@item size, s @item size, s
Set the size of the output video. Set the size of the output video. For the syntax of this option, check
the "Video size" section in the ffmpeg-utils manual.
If @option{filename} or @option{pattern} is specified, the size is set If @option{filename} or @option{pattern} is specified, the size is set
by default to the width of the specified initial state row, and the by default to the width of the specified initial state row, and the
@@ -8363,7 +8368,8 @@ Set frame rate, expressed as number of frames per second. Default
value is "25". value is "25".
@item size, s @item size, s
Set frame size. Default value is "640x480". Set frame size. For the syntax of this option, check the "Video
size" section in the ffmpeg-utils manual. Default value is "640x480".
@item start_scale @item start_scale
Set the initial scale value. Default value is 3.0. Set the initial scale value. Default value is 3.0.
@@ -8445,8 +8451,8 @@ This source accepts the following options:
@table @option @table @option
@item size @item size
The size of the video to generate, may be a string of the form The size of the video to generate. For the syntax of this option, check the
@var{width}x@var{height} or a frame size abbreviation. "Video size" section in the ffmpeg-utils manual.
@item framerate @item framerate
Framerate of the generated video, may be a string of the form Framerate of the generated video, may be a string of the form
@@ -8534,7 +8540,8 @@ cells, and will born a new cell if there are three alive cells around
a dead cell. a dead cell.
@item size, s @item size, s
Set the size of the output video. Set the size of the output video. For the syntax of this option, check the
"Video size" section in the ffmpeg-utils manual.
If @option{filename} is specified, the size is set by default to the If @option{filename} is specified, the size is set by default to the
same size of the input file. If @option{size} is set, it must contain same size of the input file. If @option{size} is set, it must contain
@@ -8562,6 +8569,9 @@ used to represent a dead cell.
@item mold_color @item mold_color
Set mold color, for definitely dead and moldy cells. Set mold color, for definitely dead and moldy cells.
For the syntax of these 3 color options, check the "Color" section in the
ffmpeg-utils manual.
@end table @end table
@subsection Examples @subsection Examples
@@ -8631,9 +8641,8 @@ The sources accept the following options:
@item color, c @item color, c
Specify the color of the source, only available in the @code{color} Specify the color of the source, only available in the @code{color}
source. It can be the name of a color (case insensitive match) or a source. For the syntax of this option, check the "Color" section in the
0xRRGGBB[AA] sequence, possibly followed by an alpha specifier. The ffmpeg-utils manual.
default value is "black".
@item level @item level
Specify the level of the Hald CLUT, only available in the @code{haldclutsrc} Specify the level of the Hald CLUT, only available in the @code{haldclutsrc}
@@ -8642,9 +8651,9 @@ pixels to be used as identity matrix for 3D lookup tables. Each component is
coded on a @code{1/(N*N)} scale. coded on a @code{1/(N*N)} scale.
@item size, s @item size, s
Specify the size of the sourced video, it may be a string of the form Specify the size of the sourced video. For the syntax of this option, check the
@var{width}x@var{height}, or the name of a size abbreviation. The "Video size" section in the ffmpeg-utils manual. The default value is
default value is "320x240". "320x240".
This option is not available with the @code{haldclutsrc} filter. This option is not available with the @code{haldclutsrc} filter.
@@ -8773,7 +8782,8 @@ Same as above but not rotated.
Default value is @samp{lissajous}. Default value is @samp{lissajous}.
@item size, s @item size, s
Set the video size for the output. Default value is @code{400x400}. Set the video size for the output. For the syntax of this option, check the "Video size"
section in the ffmpeg-utils manual. Default value is @code{400x400}.
@item rate, r @item rate, r
Set the output frame rate. Default value is @code{25}. Set the output frame rate. Default value is @code{25}.
@@ -8912,8 +8922,9 @@ option is set or no. The video stream will be the first output stream if
activated. Default is @code{0}. activated. Default is @code{0}.
@item size @item size
Set the video size. This option is for video only. Default and minimum Set the video size. This option is for video only. For the syntax of this
resolution is @code{640x480}. option, check the "Video size" section in the ffmpeg-utils manual. Default
and minimum resolution is @code{640x480}.
@item meter @item meter
Set the EBU scale meter. Default is @code{9}. Common values are @code{9} and Set the EBU scale meter. Default is @code{9}. Common values are @code{9} and
@@ -9555,7 +9566,9 @@ The filter accepts the following options:
@table @option @table @option
@item size, s @item size, s
Specify the video size for the output. Default value is @code{640x512}. Specify the video size for the output. For the syntax of this option, check
the "Video size" section in the ffmpeg-utils manual. Default value is
@code{640x512}.
@item slide @item slide
Specify if the spectrum should slide along the window. Default value is Specify if the spectrum should slide along the window. Default value is
@@ -9639,7 +9652,9 @@ The filter accepts the following options:
@table @option @table @option
@item size, s @item size, s
Specify the video size for the output. Default value is "600x240". Specify the video size for the output. For the syntax of this option, check
the "Video size" section in the ffmpeg-utils manual. Default value
is "600x240".
@item mode @item mode
Set display mode. Set display mode.