[FFmpeg-devel] [PATCH] Add demuxers.texi file and document the image2 demuxers.

[Stefano Sabatini]

---
 Makefile          |    6 ++--
 doc/demuxers.texi |   60 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 doc/ffmpeg.texi   |    1 +
 doc/ffplay.texi   |    1 +
 doc/ffprobe.texi  |    1 +
 5 files changed, 66 insertions(+), 3 deletions(-)
 create mode 100644 doc/demuxers.texi

diff --git a/Makefile b/Makefile
index 6731103..d158507 100644
--- a/Makefile
+++ b/Makefile
@@ -116,9 +116,9 @@ documentation: $(addprefix doc/, developer.html faq.html general.html libavfilte
 
 $(HTMLPAGES) $(PODPAGES): doc/fftools-common-opts.texi
 
-doc/ffmpeg.pod doc/ffmpeg.html: doc/bitstream_filters.texi doc/eval.texi doc/indevs.texi doc/filters.texi doc/outdevs.texi doc/protocols.texi doc/metadata.texi
-doc/ffplay.pod doc/ffplay.html: doc/eval.texi doc/indevs.texi doc/filters.texi doc/outdevs.texi doc/protocols.texi
-doc/ffprobe.pod doc/ffprobe.html: doc/indevs.texi doc/protocols.texi
+doc/ffmpeg.pod doc/ffmpeg.html: doc/demuxers.texi doc/bitstream_filters.texi doc/eval.texi doc/indevs.texi doc/filters.texi doc/outdevs.texi doc/protocols.texi doc/metadata.texi
+doc/ffplay.pod doc/ffplay.html: doc/demuxers.texi doc/eval.texi doc/indevs.texi doc/filters.texi doc/outdevs.texi doc/protocols.texi
+doc/ffprobe.pod doc/ffprobe.html: doc/demuxers.texi doc/indevs.texi doc/protocols.texi
 doc/libavfilter.html: doc/filters.texi
 
 doc/%.html: TAG = HTML
diff --git a/doc/demuxers.texi b/doc/demuxers.texi
new file mode 100644
index 0000000..4956bf4
--- /dev/null
+++ b/doc/demuxers.texi
@@ -0,0 +1,60 @@
+ at chapter Demuxers
+ at c man begin DEMUXERS
+
+Demuxers are configured elements in FFmpeg which allow to read the
+multimedia streams from a particular type of file.
+
+When you configure your FFmpeg build, all the supported demuxers
+are enabled by default. You can list all available ones using the
+configure option "--list-demuxers".
+
+You can disable all the demuxers using the configure option
+"--disable-demuxers", and selectively enable a single demuxer with
+the option "--enable-demuxer=@var{DEMUXER}", or disable a single one
+using with the option "--disable-demuxer=@var{DEMUXER}".
+
+The option "-formats" of the ff* tools will display the list of
+enabled demuxers.
+
+A description of some of the currently available demuxers follows.
+
+ at section image2
+
+Image file demuxer.
+
+This demuxer reads from a list of image files specified by a pattern.
+
+Each file name must contain a sequence of numeric digits representing
+a number which has to be unique for each file. The first number has to
+be a number inclusively contained between 0 and 4, and the numbers
+must be sequential.
+
+The pattern must contain the string "%d" or "%0 at var{N}d", which
+specify the position of the characters representing the seqential
+number in each filename matched by the pattern. If the form
+"%d0 at var{N}d" is used, the string representing the sequential number
+for each file is 0-padded and @var{N} is the total number of 0-padded
+digits contained in the filename. The pattern may contain the string
+"%%" for representing the character '%'.
+
+The pattern may contain a suffix which is used to automatically
+determine the type of image contained in the file, which must be one
+of the supported image files.
+
+For example the pattern "foo-%03d.bmp" will match a sequence of
+filenames of the form @file{foo-001.bmp}, @file{foo-002.bmp}, ...,
+ at file{foo-010.bmp}, etc.; the pattern "b%%a%%r-%d.jpg" will match a
+sequence of filenames of the form @file{b%a%r-1.jpg},
+ at file{b%a%r-2.jpg}, ..., @file{b%a%r-10.jpg}, etc.
+
+The size and the pixel format of each image must be the same for all
+the files in the sequence.
+
+The following example shows how to use ffmpeg for creating a video
+from the images in the "img-%03d.jpeg" file sequence @file{img-001.jpeg},
+ at file{img-002.jpeg}, ...:
+ at example
+ffmpeg -f image2 -i img-%03d.jpeg -r 12 -s WxH out.avi
+ at end example
+
+ at c man end INPUT DEVICES
diff --git a/doc/ffmpeg.texi b/doc/ffmpeg.texi
index d73ae46..abe0ac1 100644
--- a/doc/ffmpeg.texi
+++ b/doc/ffmpeg.texi
@@ -944,6 +944,7 @@ file to which you want to add them.
 @c man end EXAMPLES
 
 @include eval.texi
+ at include demuxers.texi
 @include indevs.texi
 @include outdevs.texi
 @include protocols.texi
diff --git a/doc/ffplay.texi b/doc/ffplay.texi
index 07c8875..c9c38da 100644
--- a/doc/ffplay.texi
+++ b/doc/ffplay.texi
@@ -154,6 +154,7 @@ Seek to percentage in file corresponding to fraction of width.
 @c man end
 
 @include eval.texi
+ at include demuxers.texi
 @include indevs.texi
 @include outdevs.texi
 @include protocols.texi
diff --git a/doc/ffprobe.texi b/doc/ffprobe.texi
index 0b5c11a..8f3a5a9 100644
--- a/doc/ffprobe.texi
+++ b/doc/ffprobe.texi
@@ -109,6 +109,7 @@ with name "STREAM".
 @end table
 @c man end
 
+ at include demuxers.texi
 @include protocols.texi
 @include indevs.texi
 
-- 
1.7.2.3