From a46515115cd0ab552e7035afdb3f96a603e3a28f Mon Sep 17 00:00:00 2001
From: Anton Khirnov <wyskas@gmail.com>
Date: Mon, 27 Dec 2010 07:46:49 +0000
Subject: Metadata muxer

Dumps all metadata to a text file for easy manual editing.

Originally committed as revision 26101 to svn://svn.ffmpeg.org/ffmpeg/trunk
---
 doc/ffmpeg.texi   |  1 +
 doc/general.texi  |  2 ++
 doc/metadata.texi | 68 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 71 insertions(+)
 create mode 100644 doc/metadata.texi

(limited to 'doc')

diff --git a/doc/ffmpeg.texi b/doc/ffmpeg.texi
index 397c3b4756..d73ae46353 100644
--- a/doc/ffmpeg.texi
+++ b/doc/ffmpeg.texi
@@ -949,6 +949,7 @@ file to which you want to add them.
 @include protocols.texi
 @include bitstream_filters.texi
 @include filters.texi
+@include metadata.texi
 
 @ignore
 
diff --git a/doc/general.texi b/doc/general.texi
index a837098295..75c6f57da9 100644
--- a/doc/general.texi
+++ b/doc/general.texi
@@ -118,6 +118,8 @@ library:
     @tab VR native stream format, used by Leitch/Harris' video servers.
 @item Matroska                  @tab X @tab X
 @item Matroska audio            @tab X @tab
+@item FFmpeg metadata           @tab X @tab
+    @tab Metadata in text format.
 @item MAXIS XA                  @tab   @tab X
     @tab Used in Sim City 3000; file extension .xa.
 @item MD Studio                 @tab   @tab X
diff --git a/doc/metadata.texi b/doc/metadata.texi
new file mode 100644
index 0000000000..2a285757cc
--- /dev/null
+++ b/doc/metadata.texi
@@ -0,0 +1,68 @@
+@chapter Metadata
+@c man begin METADATA
+
+FFmpeg is able to dump metadata from media files into a simple UTF-8-encoded
+INI-like text file and then load it back using the metadata muxer/demuxer.
+
+The file format is as follows:
+@enumerate
+
+@item
+A file consists of a header and a number of metadata tags divided into sections,
+each on its own line.
+
+@item
+The header is a ';FFMETADATA' string, followed by a version number (now 1).
+
+@item
+Metadata tags are of the form 'key=value'
+
+@item
+Immediately after header follows global metadata
+
+@item
+After global metadata there may be sections with per-stream/per-chapter
+metadata.
+
+@item
+A section starts with the section name in uppercase (i.e. STREAM or CHAPTER) in
+brackets ('[', ']') and ends with next section or end of file.
+
+@item
+At the beginning of a chapter section there may be an optional timebase to be
+used for start/end values. It must be in form 'TIMEBASE=num/den', where num and
+den are integers. If the timebase is missing then start/end times are assumed to
+be in milliseconds.
+Next a chapter section must contain chapter start and end times in form
+'START=num', 'END=num', where num is a positive integer.
+
+@item
+Empty lines and lines starting with ';' or '#' are ignored.
+
+@item
+Metadata keys or values containing special characters ('=', ';', '#', '\' and a
+newline) must be escaped with a backslash '\'.
+
+@item
+Note that whitespace in metadata (e.g. foo = bar) is considered to be a part of
+the tag (in the example above key is 'foo ', value is ' bar').
+@end enumerate
+
+A ffmetadata file might look like this:
+@example
+;FFMETADATA1
+title=bike\\shed
+;this is a comment
+artist=FFmpeg troll team
+
+[CHAPTER]
+TIMEBASE=1/1000
+START=0
+#chapter ends at 0:01:00
+END=60000
+title=chapter \#1
+[STREAM]
+title=multi\
+line
+@end example
+@c man end METADATA
-- 
cgit v1.2.3