doc: add libavdevice.texi and ffmpeg-devices.texi files
authorStefano Sabatini <stefasab@gmail.com>
Mon, 26 Nov 2012 22:38:32 +0000 (23:38 +0100)
committerStefano Sabatini <stefasab@gmail.com>
Tue, 27 Nov 2012 22:35:25 +0000 (23:35 +0100)
doc/Makefile
doc/ffmpeg-devices.texi [new file with mode: 0644]
doc/libavdevice.texi [new file with mode: 0644]

index 1dea375..55cf362 100644 (file)
@@ -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 (file)
index 0000000..542dae8
--- /dev/null
@@ -0,0 +1,57 @@
+\input texinfo @c -*- texinfo -*-
+
+@settitle FFmpeg Devices Documentation
+@titlepage
+@center @titlefont{FFmpeg Devices Documentation}
+@end titlepage
+
+@top
+
+@contents
+
+@chapter Description
+@c man begin DESCRIPTION
+
+This document describes the input and output devices provided by the
+libavdevice library.
+
+@c man end DESCRIPTION
+
+@chapter Device Options
+@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 -@var{option} @var{value} in the
+FFmpeg tools, or by setting the value explicitly in the device
+@code{AVFormatContext} options or using the @file{libavutil/opt.h} API
+for programmatic use.
+
+@c man end DEVICE OPTIONS
+
+@include indevs.texi
+@include outdevs.texi
+
+@ignore
+
+@setfilename ffmpeg-devices
+@settitle FFmpeg devices
+
+@c man begin SEEALSO
+ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libavformat(3), libavdevice(3)
+@c man end
+
+@c man begin AUTHORS
+See Git history (git://source.ffmpeg.org/ffmpeg)
+@c man end
+
+@end ignore
+
+@bye
diff --git a/doc/libavdevice.texi b/doc/libavdevice.texi
new file mode 100644 (file)
index 0000000..d6e17ae
--- /dev/null
@@ -0,0 +1,38 @@
+\input texinfo @c -*- texinfo -*-
+
+@settitle Libavdevice Documentation
+@titlepage
+@center @titlefont{Libavdevice Documentation}
+@end titlepage
+
+@top
+
+@contents
+
+@chapter Description
+@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.
+
+@c man end DESCRIPTION
+
+@ignore
+
+@setfilename libavdevice
+@settitle multimedia device handling library
+
+@c man begin SEEALSO
+ffmpeg(1), ffplay(1), ffprobe(1), ffserver(1), libavutil(3),
+libavcodec(3), libavformat(3), ffmpeg-devices(1)
+@c man end
+
+@c man begin AUTHORS
+See Git history (git://source.ffmpeg.org/ffmpeg)
+@c man end
+
+@end ignore
+
+@bye