[FFmpeg-devel] [PATCH 4/4] doc/demuxers: add "Options", "Examples", "Syntax", etc. subsections

Timothy Gu timothygu99 at gmail.com
Sun Jan 5 04:24:32 CET 2014


More consistent with codec docs.

Signed-off-by: Timothy Gu <timothygu99 at gmail.com>
---
 doc/demuxers.texi | 24 ++++++++++++++++++++++--
 1 file changed, 22 insertions(+), 2 deletions(-)

diff --git a/doc/demuxers.texi b/doc/demuxers.texi
index bfc0bdc..185153d 100644
--- a/doc/demuxers.texi
+++ b/doc/demuxers.texi
@@ -35,6 +35,8 @@ Advanced Systems Format demuxer.
 
 This demuxer is used to demux ASF files and MMS network streams.
 
+ at subsection Options
+
 @table @option
 @item -no_resync_search @var{bool}
 Do not try to resynchronize by looking for a certain optional start code.
@@ -62,7 +64,7 @@ because the file is truncated, for example), it can cause artifacts. The
 @code{duration} directive can be used to override the duration stored in
 each file.
 
- at subsection Syntax
+ at subsection Input Syntax
 
 The script is a text file in extended-ASCII, with one directive per line.
 Empty lines, leading spaces and lines starting with '#' are ignored. The
@@ -120,6 +122,8 @@ Adobe Flash Video Format demuxer.
 
 This demuxer is used to demux FLV files and RTMP network streams.
 
+ at subsection Options
+
 @table @option
 @item -flv_metadata @var{bool}
 Allocate the streams according to the onMetaData array content.
@@ -142,6 +146,8 @@ For very large files, the @option{max_size} option may have to be adjusted.
 
 Play media from Internet services using the quvi project.
 
+ at subsection Options
+
 The demuxer accepts a @option{format} option to request a specific quality. It
 is by default set to @var{best}.
 
@@ -164,6 +170,8 @@ determine the format of the images contained in the files.
 The size, the pixel format, and the format of each image must be the
 same for all the files in the sequence.
 
+ at subsection Options
+
 This demuxer accepts the following options:
 @table @option
 @item framerate
@@ -283,6 +291,8 @@ ffmpeg -framerate 10 -pattern_type glob -i "*.png" out.mkv
 
 MPEG-2 transport stream demuxer.
 
+ at subsection Options
+
 @table @option
 
 @item fix_teletext_pts
@@ -300,6 +310,8 @@ This demuxer allows to read raw video data. Since there is no header
 specifying the assumed video parameters, the user must specify them
 in order to be able to decode the data correctly.
 
+ at subsection Options
+
 This demuxer accepts the following options:
 @table @option
 
@@ -313,6 +325,8 @@ Set the input video pixel format. Default value is @code{yuv420p}.
 Set the input video size. This value must be specified explicitly.
 @end table
 
+ at subsection Examples
+
 For example to read a rawvideo file @file{input.raw} with
 @command{ffplay}, assuming a pixel format of @code{rgb24}, a video
 size of @code{320x240}, and a frame rate of 10 images per second, use
@@ -325,6 +339,8 @@ ffplay -f rawvideo -pixel_format rgb24 -video_size 320x240 -framerate 10 input.r
 
 SBaGen script demuxer.
 
+ at subsection Input Syntax
+
 This demuxer reads the script language used by SBaGen
 @url{http://uazu.net/sbagen/} to generate binaural beats sessions. A SBG
 script looks like that:
@@ -359,6 +375,8 @@ TED does not provide links to the captions, but they can be guessed from the
 page. The file @file{tools/bookmarklets.html} from the FFmpeg source tree
 contains a bookmarklet to expose them.
 
+ at subsection Options
+
 This demuxer accepts the following option:
 @table @option
 @item start_time
@@ -367,7 +385,9 @@ Set the start time of the TED talk, in milliseconds. The default is 15000
 they include a 15s intro.
 @end table
 
-Example: convert the captions to a format most players understand:
+ at subsection Examples
+
+Convert the captions to a format most players understand:
 @example
 ffmpeg -i http://www.ted.com/talks/subtitles/id/1/lang/en talk1-en.srt
 @end example
-- 
1.8.3.2



More information about the ffmpeg-devel mailing list