Re: [FFmpeg-devel] [PATCH 4/4] doc/muxers/avi: apply misc changes
On date Wednesday 2024-01-10 15:58:42 -0600, Marth64 wrote: > LGTM Thanks, applied this and the other doc/muxers pending patches. ___ ffmpeg-devel mailing list ffmpeg-devel@ffmpeg.org https://ffmpeg.org/mailman/listinfo/ffmpeg-devel To unsubscribe, visit link above, or email ffmpeg-devel-requ...@ffmpeg.org with subject "unsubscribe".
Re: [FFmpeg-devel] [PATCH 4/4] doc/muxers/avi: apply misc changes
LGTM
On Wed, Jan 10, 2024 at 3:38 PM Stefano Sabatini wrote:
> In particular:
> * sort options by name
> * apply misc formatting and consistency fixes
> * add introduction explaining the need to set some options
> ---
> doc/muxers.texi | 28
> 1 file changed, 16 insertions(+), 12 deletions(-)
>
> diff --git a/doc/muxers.texi b/doc/muxers.texi
> index 7ed5ed50a5..1c88816c3c 100644
> --- a/doc/muxers.texi
> +++ b/doc/muxers.texi
> @@ -794,15 +794,24 @@ It accepts a single audio stream.
>
> @anchor{avi}
> @section avi
> -
> Audio Video Interleaved muxer.
>
> -@subsection Options
> +AVI is a proprietary format developed by Microsoft, and later formally
> specified
> +through the Open DML specification.
>
> -It accepts the following options:
> +Because of differences in players implementations, it might be required
> to set
> +some options to make sure that the generated output can be correctly
> played by
> +the target player.
>
> +@subsection Options
> @table @option
> -@item reserve_index_space
> +@item flipped_raw_rgb @var{bool}
> +If set to @code{true}, store positive height for raw RGB bitmaps, which
> +indicates bitmap is stored bottom-up. Note that this option does not flip
> the
> +bitmap which has to be done manually beforehand, e.g. by using the
> @samp{vflip}
> +filter. Default is @code{false} and indicates bitmap is stored top down.
> +
> +@item reserve_index_space @var{size}
> Reserve the specified amount of bytes for the OpenDML master index of each
> stream within the file header. By default additional master indexes are
> embedded within the data packets if there is no space left in the first
> master
> @@ -815,20 +824,15 @@ The required index space depends on the output file
> size and should be about 16
> bytes per gigabyte. When this option is omitted or set to zero the
> necessary
> index space is guessed.
>
> -@item write_channel_mask
> +Default value is @code{0}.
> +
> +@item write_channel_mask @var{bool}
> Write the channel layout mask into the audio stream header.
>
> This option is enabled by default. Disabling the channel mask can be
> useful in
> specific scenarios, e.g. when merging multiple audio streams into one for
> compatibility with software that only supports a single audio stream in
> AVI
> (see @ref{amerge,,the "amerge" section in the ffmpeg-filters
> manual,ffmpeg-filters}).
> -
> -@item flipped_raw_rgb
> -If set to true, store positive height for raw RGB bitmaps, which indicates
> -bitmap is stored bottom-up. Note that this option does not flip the bitmap
> -which has to be done manually beforehand, e.g. by using the vflip filter.
> -Default is @var{false} and indicates bitmap is stored top down.
> -
> @end table
>
> @anchor{chromaprint}
> --
> 2.34.1
>
> ___
> ffmpeg-devel mailing list
> ffmpeg-devel@ffmpeg.org
> https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
>
> To unsubscribe, visit link above, or email
> ffmpeg-devel-requ...@ffmpeg.org with subject "unsubscribe".
>
___
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-requ...@ffmpeg.org with subject "unsubscribe".
[FFmpeg-devel] [PATCH 4/4] doc/muxers/avi: apply misc changes
In particular:
* sort options by name
* apply misc formatting and consistency fixes
* add introduction explaining the need to set some options
---
doc/muxers.texi | 28
1 file changed, 16 insertions(+), 12 deletions(-)
diff --git a/doc/muxers.texi b/doc/muxers.texi
index 7ed5ed50a5..1c88816c3c 100644
--- a/doc/muxers.texi
+++ b/doc/muxers.texi
@@ -794,15 +794,24 @@ It accepts a single audio stream.
@anchor{avi}
@section avi
-
Audio Video Interleaved muxer.
-@subsection Options
+AVI is a proprietary format developed by Microsoft, and later formally
specified
+through the Open DML specification.
-It accepts the following options:
+Because of differences in players implementations, it might be required to set
+some options to make sure that the generated output can be correctly played by
+the target player.
+@subsection Options
@table @option
-@item reserve_index_space
+@item flipped_raw_rgb @var{bool}
+If set to @code{true}, store positive height for raw RGB bitmaps, which
+indicates bitmap is stored bottom-up. Note that this option does not flip the
+bitmap which has to be done manually beforehand, e.g. by using the @samp{vflip}
+filter. Default is @code{false} and indicates bitmap is stored top down.
+
+@item reserve_index_space @var{size}
Reserve the specified amount of bytes for the OpenDML master index of each
stream within the file header. By default additional master indexes are
embedded within the data packets if there is no space left in the first master
@@ -815,20 +824,15 @@ The required index space depends on the output file size
and should be about 16
bytes per gigabyte. When this option is omitted or set to zero the necessary
index space is guessed.
-@item write_channel_mask
+Default value is @code{0}.
+
+@item write_channel_mask @var{bool}
Write the channel layout mask into the audio stream header.
This option is enabled by default. Disabling the channel mask can be useful in
specific scenarios, e.g. when merging multiple audio streams into one for
compatibility with software that only supports a single audio stream in AVI
(see @ref{amerge,,the "amerge" section in the ffmpeg-filters
manual,ffmpeg-filters}).
-
-@item flipped_raw_rgb
-If set to true, store positive height for raw RGB bitmaps, which indicates
-bitmap is stored bottom-up. Note that this option does not flip the bitmap
-which has to be done manually beforehand, e.g. by using the vflip filter.
-Default is @var{false} and indicates bitmap is stored top down.
-
@end table
@anchor{chromaprint}
--
2.34.1
___
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-requ...@ffmpeg.org with subject "unsubscribe".
[FFmpeg-devel] [PATCH 4/4] doc/muxers/avi: apply misc changes
In particular:
* sort options by name
* apply misc formatting and consistency fixes
* add introduction explaining the need to set some options
---
doc/muxers.texi | 28
1 file changed, 16 insertions(+), 12 deletions(-)
diff --git a/doc/muxers.texi b/doc/muxers.texi
index 7ed5ed50a5..1c88816c3c 100644
--- a/doc/muxers.texi
+++ b/doc/muxers.texi
@@ -794,15 +794,24 @@ It accepts a single audio stream.
@anchor{avi}
@section avi
-
Audio Video Interleaved muxer.
-@subsection Options
+AVI is a proprietary format developed by Microsoft, and later formally
specified
+through the Open DML specification.
-It accepts the following options:
+Because of differences in players implementations, it might be required to set
+some options to make sure that the generated output can be correctly played by
+the target player.
+@subsection Options
@table @option
-@item reserve_index_space
+@item flipped_raw_rgb @var{bool}
+If set to @code{true}, store positive height for raw RGB bitmaps, which
+indicates bitmap is stored bottom-up. Note that this option does not flip the
+bitmap which has to be done manually beforehand, e.g. by using the @samp{vflip}
+filter. Default is @code{false} and indicates bitmap is stored top down.
+
+@item reserve_index_space @var{size}
Reserve the specified amount of bytes for the OpenDML master index of each
stream within the file header. By default additional master indexes are
embedded within the data packets if there is no space left in the first master
@@ -815,20 +824,15 @@ The required index space depends on the output file size
and should be about 16
bytes per gigabyte. When this option is omitted or set to zero the necessary
index space is guessed.
-@item write_channel_mask
+Default value is @code{0}.
+
+@item write_channel_mask @var{bool}
Write the channel layout mask into the audio stream header.
This option is enabled by default. Disabling the channel mask can be useful in
specific scenarios, e.g. when merging multiple audio streams into one for
compatibility with software that only supports a single audio stream in AVI
(see @ref{amerge,,the "amerge" section in the ffmpeg-filters
manual,ffmpeg-filters}).
-
-@item flipped_raw_rgb
-If set to true, store positive height for raw RGB bitmaps, which indicates
-bitmap is stored bottom-up. Note that this option does not flip the bitmap
-which has to be done manually beforehand, e.g. by using the vflip filter.
-Default is @var{false} and indicates bitmap is stored top down.
-
@end table
@anchor{chromaprint}
--
2.34.1
___
ffmpeg-devel mailing list
ffmpeg-devel@ffmpeg.org
https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
To unsubscribe, visit link above, or email
ffmpeg-devel-requ...@ffmpeg.org with subject "unsubscribe".
