[PATCH 1/1] Add the indevs.texi and outdevs.texi files.
Stefano Sabatini
stefano.sabatini-lala
Sun Jul 25 15:47:14 CEST 2010
---
Makefile | 5 +-
doc/ffmpeg-doc.texi | 2 +
doc/ffplay-doc.texi | 2 +
doc/ffprobe-doc.texi | 2 +
doc/indevs.texi | 205 ++++++++++++++++++++++++++++++++++++++++++++++++++
doc/outdevs.texi | 38 +++++++++
6 files changed, 252 insertions(+), 2 deletions(-)
create mode 100644 doc/indevs.texi
create mode 100644 doc/outdevs.texi
diff --git a/Makefile b/Makefile
index 8c0d5b6..3add5d1 100644
--- a/Makefile
+++ b/Makefile
@@ -115,8 +115,9 @@ documentation: $(addprefix doc/, developer.html faq.html general.html libavfilte
$(HTMLPAGES) $(MANPAGES): doc/fftools-common-opts.texi
-doc/ffmpeg.pod doc/ffmpeg-doc.html: doc/filters.texi
-doc/ffplay.pod doc/ffplay-doc.html: doc/filters.texi
+doc/ffmpeg.pod doc/ffmpeg-doc.html: doc/indevs.texi doc/filters.texi doc/outdevs.texi
+doc/ffplay.pod doc/ffplay-doc.html: doc/indevs.texi doc/filters.texi doc/outdevs.texi
+doc/ffprobe.pod doc/ffprobe-doc.html: doc/indevs.texi
doc/%.html: TAG = HTML
doc/%.html: doc/%.texi
diff --git a/doc/ffmpeg-doc.texi b/doc/ffmpeg-doc.texi
index 7e3abad..a4330cf 100644
--- a/doc/ffmpeg-doc.texi
+++ b/doc/ffmpeg-doc.texi
@@ -964,6 +964,8 @@ options have to be specified immediately after the name of the output
file to which you want to add them.
@c man end EXAMPLES
+ at include indevs.texi
+ at include outdevs.texi
@include filters.texi
@ignore
diff --git a/doc/ffplay-doc.texi b/doc/ffplay-doc.texi
index 5e8032f..a55f30c 100644
--- a/doc/ffplay-doc.texi
+++ b/doc/ffplay-doc.texi
@@ -153,6 +153,8 @@ Seek to percentage in file corresponding to fraction of width.
@c man end
+ at include indevs.texi
+ at include outdevs.texi
@include filters.texi
@ignore
diff --git a/doc/ffprobe-doc.texi b/doc/ffprobe-doc.texi
index a1a11c1..6792603 100644
--- a/doc/ffprobe-doc.texi
+++ b/doc/ffprobe-doc.texi
@@ -105,6 +105,8 @@ with name ``STREAM''.
@end table
@c man end
+ at include indevs.texi
+
@ignore
@setfilename ffprobe
diff --git a/doc/indevs.texi b/doc/indevs.texi
new file mode 100644
index 0000000..0864d0c
--- /dev/null
+++ b/doc/indevs.texi
@@ -0,0 +1,205 @@
+ at chapter Devices
+ at c man begin INPUT DEVICES
+
+Input devices are configured elements in FFmpeg which allows to access
+the data (also called "grabbing") coming from a multimedia device
+attached to your system.
+
+When you configure your FFmpeg build, by default FFmpeg will enable
+all the supported input devices. You can list them using the configure
+option "--list-indevs".
+
+You can disable all the input devices using the option
+"--disable-indevs", or you can disable a particular input devices using
+the option "--disable-indev=@var{INDEV}".
+
+If you disabled all input devices, you can selectively enable an input
+device using the option "--enable-indev=@var{INDEV}".
+
+The configure output will show the input devices included
+in your build.
+
+The option "-formats" of the ff* tools will display the list of
+enabled input devices (amongst the demuxers).
+
+Follows a description of the currently available input devices.
+
+ at section alsa
+
+ALSA (Advanced Linux Sound Architecture).
+
+To enable this input device during configuration you need libasound
+installed on your system.
+
+This device allows to capture from an ALSA device. The name of the
+device to capture has to be an ALSA card identifier.
+
+An ALSA identifier has the syntax:
+ at example
+hw:@var{CARD}[, at var{DEV}[, at var{SUBDEV}]]
+ at end example
+
+where the @var{DEV} and @var{SUBDEV} components are optional.
+
+The three arguments (in order: @var{CARD}, at var{DEV}, at var{SUBDEV})
+specify card number or identifier, device number and subdevice number
+(-1 means any).
+
+To see the list of cards currently recognized by your system, run the
+command, check the files @file{/proc/asound/cards} and
+ at file{/proc/asound/devices}.
+
+For example to capture with @file{ffmpeg} from an alsa device with
+card id 0, you may run the command:
+ at example
+ffmpeg -f alsa -i hw:0 alsaout.wav
+ at end example
+
+For more information see:
+ at url{http://www.alsa-project.org/alsa-doc/alsa-lib/pcm.html}
+
+ at section audio_beos
+
+BeOS audio input device.
+
+ at section bktr
+
+BSD video input device.
+
+ at section dv1394
+
+Linux DV 1394 input device.
+
+ at section jack
+
+Jack input device.
+
+To enable this input device during configuration you need libasound
+installed on your system.
+
+This device creates one or more jack writable clients, one for each
+channel, with name @var{filename}:input_ at var{N}, where @var{N} is a
+number which identifies the channel.
+
+One you have created one or more jack readable clients, you need to
+connect them to one or more jack readable client.
+
+To connect or disconnect jack clients you can use the program
+ at file{jack_connect} and @file{jack_disconnect} programs, or do it
+through a graphical interface, for example with @file{qjackctl}.
+
+To list the jack clients and their properties you can invoke the command
+ at file{jack_lsp}.
+
+Follows an example which shows how to capture a jack readable client
+with @file{ffmpeg}.
+
+ at example
+# create a jack ffmpeg writable client
+$ ffmpeg -f jack -i ffmpeg -y out.wav
+
+# start the sample jack_metro readable client
+$ jack_metro -b 120 -d 0.2 -f 4000
+
+# list the current jack clients
+$ jack_lsp -c
+system:capture_1
+system:capture_2
+system:playback_1
+system:playback_2
+ffmpeg:input_1
+metro:120_bpm
+
+# connect metro to the ffmpeg client
+$ jack_connect metro:120_bpm ffmpeg:input_1
+ at end example
+
+For more information read:
+ at url{http://jackaudio.org/}
+
+ at section libdc1394
+
+IIDC1394 grab interface interface, based on libdc1394 and libraw1394.
+
+ at section oss
+
+Open Sound System device.
+
+The filename to provide to the input device is the device node
+representing the OSS input device, and is usually set to
+ at file{/dev/dsp/}.
+
+For example to grab from @file{/dev/dsp/} using @file{ffmpeg} use the
+command:
+ at example
+ffmpeg -f oss -i /dev/dsp /tmp/oss.wav
+ at end example
+
+For more information about OSS see:
+ at url{http://manuals.opensound.com/usersguide/dsp.html}
+
+ at section video4linux and video4linux2
+
+Video4Linux and Video4Linux2 input video devices.
+
+The name of the device to grab is a file device node, usually Linux
+systems tend to automatically create such nodes when the device
+(e.g. an USB webcam) is plugged to the system, and have a name of the
+kind @file{/dev/video at var{N}}, where @var{N} is a number associated to
+the device.
+
+To capture the input from a v4l device run the command:
+ at example
+ffplay -s 320x240 -f video4linux /dev/video0
+ at end example
+
+If the size for the device is set to 0x0, the input device will
+try to autodetect the size to use.
+
+Video4Linux and Video4Linux devices only support a limited set of
+ at var{width}x at var{height} sizes and framerates. You can check which are
+supported for example using the command @file{dov4l} for Video4Linux
+devices, and the command @file{v4l-info} for Video4Linux2 devices.
+
+Video4Linux2 devices will try to autoadjust the size, and will set the
+nearest supported size to that provided.
+
+Video4Linux support is deprecated since Linux 2.6.30, and will be
+dropped in later versions.
+
+ at section vfwcap
+
+VFW (Video For Window) capture interface.
+
+ at section x11grab
+
+X11 video input device.
+
+This device allows to capture a region of an X11 display. The filename
+passed in input has this syntax:
+:@var{display}. at var{screen}[+ at var{x_offset}, at var{y_offset}]
+
+ at var{display}. at var{screen} specifies which display and screen of your X11
+server to grab.
+
+ at var{x_offset} and @var{y_offset} specify the offsets of the grabbed
+area with respect to the top/left border of the X11 screen image.
+
+Use the @file{dpyinfo} program for getting basic information about the
+properties of your X11 display screen (e.g. grep for "name" or
+"dimensions").
+
+For example to grab from @file{:0.0} using @file{ffmpeg}:
+
+ at example
+# 0.0 is display.screen number of your X11 server, same as the DISPLAY
+# environment variable.
+ffmpeg -f x11grab -s cif -i :0.0 /tmp/out.mpg
+
+# 0.0 is display.screen number of your X11 server, same as the DISPLAY
+# environment variable. 10 is the x-offset and 20 the y-offset for the
+# grabbing.
+ffmpeg -f x11grab -s cif -i :0.0+10,20 /tmp/out.mpg
+ at end example
+
+ at c man end INPUT DEVICES
diff --git a/doc/outdevs.texi b/doc/outdevs.texi
new file mode 100644
index 0000000..244f451
--- /dev/null
+++ b/doc/outdevs.texi
@@ -0,0 +1,38 @@
+ at chapter Output Devices
+ at c man begin OUTPUT DEVICES
+
+Output devices are configured elements in FFmpeg which allows to write
+the multimedia data to an output device attached to your system.
+
+When you configure your FFmpeg build, by default FFmpeg will enable
+all the supported output devices. You can list them using the configure
+option "--list-outdevs".
+
+You can disable all the output devices using the option
+"--disable-outdevs", or you can disable a particular output devices using
+the option "--disable-outdev=@var{OUTDEV}".
+
+If you disabled all output devices, you can selectively enable an output
+device using the option "--enable-outdev=@var{OUTDEV}".
+
+The configure output will show the output devices included
+in your build.
+
+The option "-formats" of the ff* tools will display the list of
+enabled output devices (amongst the muxers).
+
+Follows a description of the currently available output devices.
+
+ at section alsa
+
+ALSA (Advanced Linux Sound Architecture) output device.
+
+ at section audio_beos
+
+BeOS audio output interface.
+
+ at section oss
+
+OSS (Open Sound System) output device.
+
+ at c man end OUTPUT DEVICES
--
1.7.0.4
--7AUc2qLy4jB3hD7Z--
More information about the ffmpeg-devel
mailing list