diff options
author | Vignesh Venkatasubramanian <vigneshv-at-google.com@ffmpeg.org> | 2022-06-29 10:14:26 -0700 |
---|---|---|
committer | Paul B Mahol <onemda@gmail.com> | 2022-07-04 19:49:31 +0200 |
commit | aa8905a1b13c6ac206d532afbad953dc71319247 (patch) | |
tree | 52fbfc9eaeda60e3a39f400f9a1cf1c964db104f /doc | |
parent | 0afdc95767ea7f70cec91f76f5d3398e08edb61f (diff) |
avfilter/xstack: Add support for fixed size grid
Add a short hand parameter for making a fixed size grid. The existing
xstack layout parameter syntax gets tedious if all one wants is a
matrix like grid of the input streams. Add a grid option to the xstack
filter that simplifies this use case by simply specifying the number of
rows and columns instead of specific x/y co-ordinate for each stream.
Also updating the filter documentation to explain the new option.
Signed-off-by: Vignesh Venkatasubramanian <vigneshv@google.com>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/filters.texi | 22 |
1 files changed, 20 insertions, 2 deletions
diff --git a/doc/filters.texi b/doc/filters.texi index e525e87b3c..5a889895c6 100644 --- a/doc/filters.texi +++ b/doc/filters.texi @@ -24381,8 +24381,26 @@ the output video frame will be filled. Similarly, videos can overlap each other if their position doesn't leave enough space for the full frame of adjoining videos. -For 2 inputs, a default layout of @code{0_0|w0_0} is set. In all other cases, -a layout must be set by the user. +For 2 inputs, a default layout of @code{0_0|w0_0} (equivalent to +@code{grid=2x1}) is set. In all other cases, a layout or a grid must be set by +the user. Either @code{grid} or @code{layout} can be specified at a time. +Specifying both will result in an error. + +@item grid +Specify a fixed size grid of inputs. +This option is used to create a fixed size grid of the input streams. Set the +grid size in the form @code{COLUMNSxROWS}. There must be @code{ROWS * COLUMNS} +input streams and they will be arranged as a grid with @code{ROWS} rows and +@code{COLUMNS} columns. When using this option, each input stream within a row +must have the same height and all the rows must have the same width. + +If @code{grid} is set, then @code{inputs} option is ignored and is implicitly +set to @code{ROWS * COLUMNS}. + +For 2 inputs, a default grid of @code{2x1} (equivalent to +@code{layout=0_0|w0_0}) is set. In all other cases, a layout or a grid must be +set by the user. Either @code{grid} or @code{layout} can be specified at a time. +Specifying both will result in an error. @item shortest If set to 1, force the output to terminate when the shortest input |