[FFmpeg-cvslog] doc: add libavdevice.texi and ffmpeg-devices.texi files

[Stefano Sabatini]

ffmpeg | branch: master | Stefano Sabatini <stefasab at gmail.com> | Mon Nov 26 23:38:32 2012 +0100| [d82331721ee6c6e3168399d5b4ab039183b6f9ae] | committer: Stefano Sabatini

doc: add libavdevice.texi and ffmpeg-devices.texi files

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

 doc/Makefile            |    3 ++-
 doc/ffmpeg-devices.texi |   57 +++++++++++++++++++++++++++++++++++++++++++++++
 doc/libavdevice.texi    |   38 +++++++++++++++++++++++++++++++
 3 files changed, 97 insertions(+), 1 deletion(-)

diff --git a/doc/Makefile b/doc/Makefile
index 1dea375..55cf362 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -3,9 +3,10 @@ DOCLIBS-$(CONFIG_SWSCALE) += libswscale
 DOCLIBS-$(CONFIG_SWRESAMPLE) += libswresample
 DOCLIBS-$(CONFIG_AVCODEC) += libavcodec
 DOCLIBS-$(CONFIG_AVFORMAT) += libavformat
+DOCLIBS-$(CONFIG_AVDEVICE) += libavdevice
 DOCLIBS-$(CONFIG_AVFILTER) += libavfilter
 
-COMPONENTS=$(PROGS-yes) ffmpeg-codecs ffmpeg-filters ffmpeg-resampler ffmpeg-scaler ffmpeg-formats
+COMPONENTS=$(PROGS-yes) ffmpeg-codecs ffmpeg-devices ffmpeg-filters ffmpeg-resampler ffmpeg-scaler ffmpeg-formats
 
 MANPAGES    = $(COMPONENTS:%=doc/%.1)    $(DOCLIBS-yes:%=doc/%.3)
 PODPAGES    = $(COMPONENTS:%=doc/%.pod)  $(DOCLIBS-yes:%=doc/%.pod)
diff --git a/doc/ffmpeg-devices.texi b/doc/ffmpeg-devices.texi
new file mode 100644
index 0000000..542dae8
--- /dev/null
+++ b/doc/ffmpeg-devices.texi
@@ -0,0 +1,57 @@
+\input texinfo @c -*- texinfo -*-
+
+ at settitle FFmpeg Devices Documentation
+ at titlepage
+ at center @titlefont{FFmpeg Devices Documentation}
+ at end titlepage
+
+ at top
+
+ at contents
+
+ at chapter Description
+ at c man begin DESCRIPTION
+
+This document describes the input and output devices provided by the
+libavdevice library.
+
+ at c man end DESCRIPTION
+
+ at chapter Device Options
+ at c man begin DEVICE OPTIONS
+
+The libavdevice library provides the same interface as
+libavformat. Namely, an input device is considered like a demuxer, and
+an output device like a muxer, and the interface and generic device
+options are the same provided by libavformat (see the @ref{FFmpeg
+formats} manual page).
+
+In addition each input or output device 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 device
+ at code{AVFormatContext} options or using the @file{libavutil/opt.h} API
+for programmatic use.
+
+ at c man end DEVICE OPTIONS
+
+ at include indevs.texi
+ at include outdevs.texi
+
+ at ignore
+
+ at setfilename ffmpeg-devices
+ at settitle FFmpeg devices
+
+ at c man begin SEEALSO
+ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libavformat(3), libavdevice(3)
+ at c man end
+
+ at c man begin AUTHORS
+See Git history (git://source.ffmpeg.org/ffmpeg)
+ at c man end
+
+ at end ignore
+
+ at bye
diff --git a/doc/libavdevice.texi b/doc/libavdevice.texi
new file mode 100644
index 0000000..d6e17ae
--- /dev/null
+++ b/doc/libavdevice.texi
@@ -0,0 +1,38 @@
+\input texinfo @c -*- texinfo -*-
+
+ at settitle Libavdevice Documentation
+ at titlepage
+ at center @titlefont{Libavdevice Documentation}
+ at end titlepage
+
+ at top
+
+ at contents
+
+ at chapter Description
+ at c man begin DESCRIPTION
+
+The libavdevice library provides a generic framework for grabbing from
+and rendering to many common multimedia input/output devices, and
+supports several input and output devices, including Video4Linux2,
+VfW, DShow, and ALSA.
+
+ at c man end DESCRIPTION
+
+ at ignore
+
+ at setfilename libavdevice
+ at settitle multimedia device handling library
+
+ at c man begin SEEALSO
+ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libavutil(3),
+libavcodec(3), libavformat(3), ffmpeg-devices(1)
+ at c man end
+
+ at c man begin AUTHORS
+See Git history (git://source.ffmpeg.org/ffmpeg)
+ at c man end
+
+ at end ignore
+
+ at bye