[FFmpeg-devel] [PATCH] doc: add Timecode documentation.

[Clément Bœsch]

From: Clément Bœsch <clement.boesch at smartjog.com>

---
 doc/ffmpeg.texi  |    7 +++++++
 doc/ffprobe.texi |   17 +++++++++++++++++
 doc/general.texi |   13 ++++++++++++-
 3 files changed, 36 insertions(+), 1 deletions(-)

diff --git a/doc/ffmpeg.texi b/doc/ffmpeg.texi
index e2f6add..92573ef 100644
--- a/doc/ffmpeg.texi
+++ b/doc/ffmpeg.texi
@@ -978,6 +978,13 @@ ffmpeg -i file.mov -an -vn -sbsf mov2textsub -c:s copy -f rawvideo sub.txt
 
 @item -tag[:@var{stream_specifier}] @var{codec_tag} (@emph{per-stream})
 Force a tag/fourcc for matching streams.
+
+ at item -timecode @var{hh}:@var{mm}:@var{ss}SEP at var{ff}
+Specify Timecode for writing. @var{SEP} is ':' for non drop timecode and ';'
+(or '.') for drop.
+ at example
+ffmepg -i input.mpg -timecode 01:02:03.04 -r 30000/1001 -s ntsc out.mpg
+ at end example
 @end table
 
 @section Preset files
diff --git a/doc/ffprobe.texi b/doc/ffprobe.texi
index 4382e66..c6e8cd9 100644
--- a/doc/ffprobe.texi
+++ b/doc/ffprobe.texi
@@ -292,6 +292,23 @@ This option automatically sets @option{fully_qualified} to 1.
 For more information about the XML format, see
 @url{http://www.w3.org/XML/}.
 
+ at chapter Timecode
+
+ at command{ffprobe} supports Timecode extraction:
+
+ at itemize
+
+ at item MPEG1/2 timecode is extracted from the GOP, and is available in the video
+stream details (@option{-show_streams}, see @var{timecode}).
+
+ at item MOV timecode is extracted from tmcd track, so is available in the tmcd
+stream metadatas (@option{-show_streams}, see @var{TAG:timecode}).
+
+ at item DV and GXF timecodes are available in format metadata
+(@option{-show_format}, see @var{TAG:timecode}).
+
+ at end itemize
+
 @c man end WRITERS
 
 @include decoders.texi
diff --git a/doc/general.texi b/doc/general.texi
index b5847c9..0afcf25 100644
--- a/doc/general.texi
+++ b/doc/general.texi
@@ -94,7 +94,7 @@ details), you must upgrade FFmpeg's license to GPL in order to use it.
 
 
 
- at chapter Supported File Formats and Codecs
+ at chapter Supported File Formats, Codecs or Features
 
 You can use the @code{-formats} and @code{-codecs} options to have an exhaustive list.
 
@@ -864,4 +864,15 @@ performance on systems without hardware floating point support).
 
 @code{X} means that input/output is supported.
 
+ at section Timecode
+
+ at multitable @columnfractions .4 .1 .1
+ at item Codec/format      @tab Read   @tab Write
+ at item DV                @tab X      @tab X
+ at item GXF               @tab X      @tab X
+ at item MOV               @tab X      @tab
+ at item MPEG1/2           @tab X      @tab X
+ at item MXF               @tab        @tab X
+ at end multitable
+
 @bye
-- 
1.7.8.3