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

This commit is contained in:
Stefano Sabatini 2012-11-26 23:38:32 +01:00
parent 8ddeae5ae7
commit d82331721e
3 changed files with 97 additions and 1 deletions

View File

@ -3,9 +3,10 @@ DOCLIBS-$(CONFIG_SWSCALE) += libswscale
DOCLIBS-$(CONFIG_SWRESAMPLE) += libswresample DOCLIBS-$(CONFIG_SWRESAMPLE) += libswresample
DOCLIBS-$(CONFIG_AVCODEC) += libavcodec DOCLIBS-$(CONFIG_AVCODEC) += libavcodec
DOCLIBS-$(CONFIG_AVFORMAT) += libavformat DOCLIBS-$(CONFIG_AVFORMAT) += libavformat
DOCLIBS-$(CONFIG_AVDEVICE) += libavdevice
DOCLIBS-$(CONFIG_AVFILTER) += libavfilter 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) MANPAGES = $(COMPONENTS:%=doc/%.1) $(DOCLIBS-yes:%=doc/%.3)
PODPAGES = $(COMPONENTS:%=doc/%.pod) $(DOCLIBS-yes:%=doc/%.pod) PODPAGES = $(COMPONENTS:%=doc/%.pod) $(DOCLIBS-yes:%=doc/%.pod)

57
doc/ffmpeg-devices.texi Normal file
View File

@ -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

38
doc/libavdevice.texi Normal file
View File

@ -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