[FFmpeg-cvslog] doc: move ffmpeg-formats.texi content to separated file

Stefano Sabatini git at videolan.org
Fri Apr 5 10:16:57 CEST 2013


ffmpeg | branch: master | Stefano Sabatini <stefasab at gmail.com> | Sat Mar 30 17:02:53 2013 +0100| [2086c7e17345a50db9017d743a7403211809cb73] | committer: Stefano Sabatini

doc: move ffmpeg-formats.texi content to separated file

This should simplify inclusion in monolithic tool manuals.

> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=2086c7e17345a50db9017d743a7403211809cb73
---

 doc/ffmpeg-formats.texi |  147 +----------------------------------------------
 doc/formats.texi        |  146 ++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 147 insertions(+), 146 deletions(-)

diff --git a/doc/ffmpeg-formats.texi b/doc/ffmpeg-formats.texi
index 1dce6e7..e205caa 100644
--- a/doc/ffmpeg-formats.texi
+++ b/doc/ffmpeg-formats.texi
@@ -17,152 +17,7 @@ provided by the libavformat library.
 
 @c man end DESCRIPTION
 
- at chapter Format Options
- at c man begin FORMAT OPTIONS
-
-The libavformat library provides some generic global options, which
-can be set on all the muxers and demuxers. In addition each muxer or
-demuxer may support so-called private options, which are specific for
-that component.
-
-Options may be set by specifying - at var{option} @var{value} in the
-FFmpeg tools, or by setting the value explicitly in the
- at code{AVFormatContext} options or using the @file{libavutil/opt.h} API
-for programmatic use.
-
-The list of supported options follows:
-
- at table @option
- at item avioflags @var{flags} (@emph{input/output})
-Possible values:
- at table @samp
- at item direct
-Reduce buffering.
- at end table
-
- at item probesize @var{integer} (@emph{input})
-Set probing size in bytes, i.e. the size of the data to analyze to get
-stream information. A higher value will allow to detect more
-information in case it is dispersed into the stream, but will increase
-latency. Must be an integer not lesser than 32. It is 5000000 by default.
-
- at item packetsize @var{integer} (@emph{output})
-Set packet size.
-
- at item fflags @var{flags} (@emph{input/output})
-Set format flags.
-
-Possible values:
- at table @samp
- at item ignidx
-Ignore index.
- at item genpts
-Generate PTS.
- at item nofillin
-Do not fill in missing values that can be exactly calculated.
- at item noparse
-Disable AVParsers, this needs @code{+nofillin} too.
- at item igndts
-Ignore DTS.
- at item discardcorrupt
-Discard corrupted frames.
- at item sortdts
-Try to interleave output packets by DTS.
- at item keepside
-Do not merge side data.
- at item latm
-Enable RTP MP4A-LATM payload.
- at item nobuffer
-Reduce the latency introduced by optional buffering
- at end table
-
- at item analyzeduration @var{integer} (@emph{input})
-Specify how many microseconds are analyzed to probe the input. A
-higher value will allow to detect more accurate information, but will
-increase latency. It defaults to 5,000,000 microseconds = 5 seconds.
-
- at item cryptokey @var{hexadecimal string} (@emph{input})
-Set decryption key.
-
- at item indexmem @var{integer} (@emph{input})
-Set max memory used for timestamp index (per stream).
-
- at item rtbufsize @var{integer} (@emph{input})
-Set max memory used for buffering real-time frames.
-
- at item fdebug @var{flags} (@emph{input/output})
-Print specific debug info.
-
-Possible values:
- at table @samp
- at item ts
- at end table
-
- at item max_delay @var{integer} (@emph{input/output})
-Set maximum muxing or demuxing delay in microseconds.
-
- at item fpsprobesize @var{integer} (@emph{input})
-Set number of frames used to probe fps.
-
- at item audio_preload @var{integer} (@emph{output})
-Set microseconds by which audio packets should be interleaved earlier.
-
- at item chunk_duration @var{integer} (@emph{output})
-Set microseconds for each chunk.
-
- at item chunk_size @var{integer} (@emph{output})
-Set size in bytes for each chunk.
-
- at item err_detect, f_err_detect @var{flags} (@emph{input})
-Set error detection flags. @code{f_err_detect} is deprecated and
-should be used only via the @command{ffmpeg} tool.
-
-Possible values:
- at table @samp
- at item crccheck
-Verify embedded CRCs.
- at item bitstream
-Detect bitstream specification deviations.
- at item buffer
-Detect improper bitstream length.
- at item explode
-Abort decoding on minor error detection.
- at item careful
-Consider things that violate the spec and have not been seen in the
-wild as errors.
- at item compliant
-Consider all spec non compliancies as errors.
- at item aggressive
-Consider things that a sane encoder should not do as an error.
- at end table
-
- at item use_wallclock_as_timestamps @var{integer} (@emph{input})
-Use wallclock as timestamps.
-
- at item avoid_negative_ts @var{integer} (@emph{output})
-Shift timestamps to make them positive. A value of 1 enables shifting,
-a value of 0 disables it, the default value of -1 enables shifting
-when required by the target format.
-
-When shifting is enabled, all output timestamps are shifted by the
-same amount. Audio, video, and subtitles desynching and relative
-timestamp differences are preserved compared to how they would have
-been without shifting.
-
-Also note that this affects only leading negative timestamps, and not
-non-monotonic negative timestamps.
-
- at item flush_packets @var{integer} (@emph{output})
-Flush the underlying I/O stream after each packet. Default 1 enables it, and
-has the effect of reducing the latency; 0 disables it and may slightly
-increase performance in some cases.
- at end table
-
- at c man end FORMAT OPTIONS
-
- at include demuxers.texi
- at include muxers.texi
- at include metadata.texi
+ at include formats.texi
 
 @chapter See Also
 
diff --git a/doc/formats.texi b/doc/formats.texi
new file mode 100644
index 0000000..44e4532
--- /dev/null
+++ b/doc/formats.texi
@@ -0,0 +1,146 @@
+ at chapter Format Options
+ at c man begin FORMAT OPTIONS
+
+The libavformat library provides some generic global options, which
+can be set on all the muxers and demuxers. In addition each muxer or
+demuxer may support so-called private options, which are specific for
+that component.
+
+Options may be set by specifying - at var{option} @var{value} in the
+FFmpeg tools, or by setting the value explicitly in the
+ at code{AVFormatContext} options or using the @file{libavutil/opt.h} API
+for programmatic use.
+
+The list of supported options follows:
+
+ at table @option
+ at item avioflags @var{flags} (@emph{input/output})
+Possible values:
+ at table @samp
+ at item direct
+Reduce buffering.
+ at end table
+
+ at item probesize @var{integer} (@emph{input})
+Set probing size in bytes, i.e. the size of the data to analyze to get
+stream information. A higher value will allow to detect more
+information in case it is dispersed into the stream, but will increase
+latency. Must be an integer not lesser than 32. It is 5000000 by default.
+
+ at item packetsize @var{integer} (@emph{output})
+Set packet size.
+
+ at item fflags @var{flags} (@emph{input/output})
+Set format flags.
+
+Possible values:
+ at table @samp
+ at item ignidx
+Ignore index.
+ at item genpts
+Generate PTS.
+ at item nofillin
+Do not fill in missing values that can be exactly calculated.
+ at item noparse
+Disable AVParsers, this needs @code{+nofillin} too.
+ at item igndts
+Ignore DTS.
+ at item discardcorrupt
+Discard corrupted frames.
+ at item sortdts
+Try to interleave output packets by DTS.
+ at item keepside
+Do not merge side data.
+ at item latm
+Enable RTP MP4A-LATM payload.
+ at item nobuffer
+Reduce the latency introduced by optional buffering
+ at end table
+
+ at item analyzeduration @var{integer} (@emph{input})
+Specify how many microseconds are analyzed to probe the input. A
+higher value will allow to detect more accurate information, but will
+increase latency. It defaults to 5,000,000 microseconds = 5 seconds.
+
+ at item cryptokey @var{hexadecimal string} (@emph{input})
+Set decryption key.
+
+ at item indexmem @var{integer} (@emph{input})
+Set max memory used for timestamp index (per stream).
+
+ at item rtbufsize @var{integer} (@emph{input})
+Set max memory used for buffering real-time frames.
+
+ at item fdebug @var{flags} (@emph{input/output})
+Print specific debug info.
+
+Possible values:
+ at table @samp
+ at item ts
+ at end table
+
+ at item max_delay @var{integer} (@emph{input/output})
+Set maximum muxing or demuxing delay in microseconds.
+
+ at item fpsprobesize @var{integer} (@emph{input})
+Set number of frames used to probe fps.
+
+ at item audio_preload @var{integer} (@emph{output})
+Set microseconds by which audio packets should be interleaved earlier.
+
+ at item chunk_duration @var{integer} (@emph{output})
+Set microseconds for each chunk.
+
+ at item chunk_size @var{integer} (@emph{output})
+Set size in bytes for each chunk.
+
+ at item err_detect, f_err_detect @var{flags} (@emph{input})
+Set error detection flags. @code{f_err_detect} is deprecated and
+should be used only via the @command{ffmpeg} tool.
+
+Possible values:
+ at table @samp
+ at item crccheck
+Verify embedded CRCs.
+ at item bitstream
+Detect bitstream specification deviations.
+ at item buffer
+Detect improper bitstream length.
+ at item explode
+Abort decoding on minor error detection.
+ at item careful
+Consider things that violate the spec and have not been seen in the
+wild as errors.
+ at item compliant
+Consider all spec non compliancies as errors.
+ at item aggressive
+Consider things that a sane encoder should not do as an error.
+ at end table
+
+ at item use_wallclock_as_timestamps @var{integer} (@emph{input})
+Use wallclock as timestamps.
+
+ at item avoid_negative_ts @var{integer} (@emph{output})
+Shift timestamps to make them positive. A value of 1 enables shifting,
+a value of 0 disables it, the default value of -1 enables shifting
+when required by the target format.
+
+When shifting is enabled, all output timestamps are shifted by the
+same amount. Audio, video, and subtitles desynching and relative
+timestamp differences are preserved compared to how they would have
+been without shifting.
+
+Also note that this affects only leading negative timestamps, and not
+non-monotonic negative timestamps.
+
+ at item flush_packets @var{integer} (@emph{output})
+Flush the underlying I/O stream after each packet. Default 1 enables it, and
+has the effect of reducing the latency; 0 disables it and may slightly
+increase performance in some cases.
+ at end table
+
+ at c man end FORMAT OPTIONS
+
+ at include demuxers.texi
+ at include muxers.texi
+ at include metadata.texi



More information about the ffmpeg-cvslog mailing list