diff mbox series

[FFmpeg-devel] doc/muxers: add ffmetadata

Message ID 20240312105517.342536-1-stefasab@gmail.com
State New
Headers show
Series [FFmpeg-devel] doc/muxers: add ffmetadata | expand

Checks

Context Check Description
andriy/make_x86 success Make finished
andriy/make_fate_x86 success Make fate finished

Commit Message

Stefano Sabatini March 12, 2024, 10:55 a.m. UTC
---
 doc/metadata.texi |  1 +
 doc/muxers.texi   | 16 ++++++++++++++++
 2 files changed, 17 insertions(+)

Comments

Gyan Doshi March 12, 2024, 11:03 a.m. UTC | #1
On 2024-03-12 04:25 pm, Stefano Sabatini wrote:
> ---
>   doc/metadata.texi |  1 +
>   doc/muxers.texi   | 16 ++++++++++++++++
>   2 files changed, 17 insertions(+)
>
> diff --git a/doc/metadata.texi b/doc/metadata.texi
> index be91059a98..e081da7735 100644
> --- a/doc/metadata.texi
> +++ b/doc/metadata.texi
> @@ -1,3 +1,4 @@
> +@anchor{metadata}
>   @chapter Metadata
>   @c man begin METADATA
>   
> diff --git a/doc/muxers.texi b/doc/muxers.texi
> index a697e4b153..0aaef2b520 100644
> --- a/doc/muxers.texi
> +++ b/doc/muxers.texi
> @@ -1429,6 +1429,22 @@ Use @command{ffmpeg} to convert the input:
>   ffmpeg -i INPUT -s:v 720x480 -pix_fmt yuv411p -r 29.97 -ac 2 -ar 48000 -y out.dv
>   @end example
>   
> +@section ffmetadata
> +FFmpeg metadata muxer.
> +
> +This muxer writes the streams metadata in the @samp{ffmetadata}
> +format.
> +
> +See @ref{metadata,,the Metadata chapter,ffmpeg-formats} for
> +information about the format.
> +
> +@subsection Example
> +Copy an input file and insert metadata information from an @file{metadata.ffmeta} file in
> +@samp{ffmetadata} format:
> +@example
> +ffmpeg -i INPUT -i metadata.ffmeta -map_metadata 1 -codec copy OUTPUT
> +@end example
> +

The above example is for the demuxer only. Better to include an initial 
step showing export.

Regards,
Gyan
Stefano Sabatini March 12, 2024, 5:09 p.m. UTC | #2
On date Tuesday 2024-03-12 16:33:20 +0530, Gyan Doshi wrote:
> On 2024-03-12 04:25 pm, Stefano Sabatini wrote:
> > ---
> >   doc/metadata.texi |  1 +
> >   doc/muxers.texi   | 16 ++++++++++++++++
> >   2 files changed, 17 insertions(+)
> > 

Updated.
diff mbox series

Patch

diff --git a/doc/metadata.texi b/doc/metadata.texi
index be91059a98..e081da7735 100644
--- a/doc/metadata.texi
+++ b/doc/metadata.texi
@@ -1,3 +1,4 @@ 
+@anchor{metadata}
 @chapter Metadata
 @c man begin METADATA
 
diff --git a/doc/muxers.texi b/doc/muxers.texi
index a697e4b153..0aaef2b520 100644
--- a/doc/muxers.texi
+++ b/doc/muxers.texi
@@ -1429,6 +1429,22 @@  Use @command{ffmpeg} to convert the input:
 ffmpeg -i INPUT -s:v 720x480 -pix_fmt yuv411p -r 29.97 -ac 2 -ar 48000 -y out.dv
 @end example
 
+@section ffmetadata
+FFmpeg metadata muxer.
+
+This muxer writes the streams metadata in the @samp{ffmetadata}
+format.
+
+See @ref{metadata,,the Metadata chapter,ffmpeg-formats} for
+information about the format.
+
+@subsection Example
+Copy an input file and insert metadata information from an @file{metadata.ffmeta} file in
+@samp{ffmetadata} format:
+@example
+ffmpeg -i INPUT -i metadata.ffmeta -map_metadata 1 -codec copy OUTPUT
+@end example
+
 @anchor{fifo}
 @section fifo
 FIFO (First-In First-Out) muxer.