doc: add Timecode documentation.
authorClément Bœsch <clement.boesch@smartjog.com>
Tue, 3 Jan 2012 09:47:42 +0000 (10:47 +0100)
committerClément Bœsch <ubitux@gmail.com>
Tue, 24 Jan 2012 15:20:21 +0000 (16:20 +0100)
doc/ffmpeg.texi
doc/ffprobe.texi
doc/general.texi

index e2f6add..d38ce41 100644 (file)
@@ -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.
+
+@item -timecode @var{hh}:@var{mm}:@var{ss}SEP@var{ff}
+Specify Timecode for writing. @var{SEP} is ':' for non drop timecode and ';'
+(or '.') for drop.
+@example
+ffmpeg -i input.mpg -timecode 01:02:03.04 -r 30000/1001 -s ntsc output.mpg
+@end example
 @end table
 
 @section Preset files
index 4382e66..c6e8cd9 100644 (file)
@@ -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/}.
 
+@chapter Timecode
+
+@command{ffprobe} supports Timecode extraction:
+
+@itemize
+
+@item MPEG1/2 timecode is extracted from the GOP, and is available in the video
+stream details (@option{-show_streams}, see @var{timecode}).
+
+@item MOV timecode is extracted from tmcd track, so is available in the tmcd
+stream metadatas (@option{-show_streams}, see @var{TAG:timecode}).
+
+@item DV and GXF timecodes are available in format metadata
+(@option{-show_format}, see @var{TAG:timecode}).
+
+@end itemize
+
 @c man end WRITERS
 
 @include decoders.texi
index b1b0e4b..e4139c8 100644 (file)
@@ -94,7 +94,7 @@ details), you must upgrade FFmpeg's license to GPL in order to use it.
 
 
 
-@chapter Supported File Formats and Codecs
+@chapter Supported File Formats, Codecs or Features
 
 You can use the @code{-formats} and @code{-codecs} options to have an exhaustive list.
 
@@ -866,4 +866,15 @@ performance on systems without hardware floating point support).
 
 @code{X} means that input/output is supported.
 
+@section Timecode
+
+@multitable @columnfractions .4 .1 .1
+@item Codec/format      @tab Read   @tab Write
+@item DV                @tab X      @tab X
+@item GXF               @tab X      @tab X
+@item MOV               @tab X      @tab
+@item MPEG1/2           @tab X      @tab X
+@item MXF               @tab        @tab X
+@end multitable
+
 @bye