[FFmpeg-cvslog] r24543 - in trunk: Makefile doc/ffmpeg-doc.texi doc/ffplay-doc.texi doc/ffprobe-doc.texi doc/indevs.texi doc/outdevs.texi
stefano
subversion
Tue Jul 27 15:10:59 CEST 2010
Author: stefano
Date: Tue Jul 27 15:10:59 2010
New Revision: 24543
Log:
Add the indevs.texi and outdevs.texi files.
Added:
trunk/doc/indevs.texi
trunk/doc/outdevs.texi
Modified:
trunk/Makefile
trunk/doc/ffmpeg-doc.texi
trunk/doc/ffplay-doc.texi
trunk/doc/ffprobe-doc.texi
Modified: trunk/Makefile
==============================================================================
--- trunk/Makefile Tue Jul 27 13:57:51 2010 (r24542)
+++ trunk/Makefile Tue Jul 27 15:10:59 2010 (r24543)
@@ -115,8 +115,9 @@ documentation: $(addprefix doc/, develop
$(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
Modified: trunk/doc/ffmpeg-doc.texi
==============================================================================
--- trunk/doc/ffmpeg-doc.texi Tue Jul 27 13:57:51 2010 (r24542)
+++ trunk/doc/ffmpeg-doc.texi Tue Jul 27 15:10:59 2010 (r24543)
@@ -964,6 +964,8 @@ options have to be specified immediately
file to which you want to add them.
@c man end EXAMPLES
+ at include indevs.texi
+ at include outdevs.texi
@include filters.texi
@ignore
Modified: trunk/doc/ffplay-doc.texi
==============================================================================
--- trunk/doc/ffplay-doc.texi Tue Jul 27 13:57:51 2010 (r24542)
+++ trunk/doc/ffplay-doc.texi Tue Jul 27 15:10:59 2010 (r24543)
@@ -153,6 +153,8 @@ Seek to percentage in file corresponding
@c man end
+ at include indevs.texi
+ at include outdevs.texi
@include filters.texi
@ignore
Modified: trunk/doc/ffprobe-doc.texi
==============================================================================
--- trunk/doc/ffprobe-doc.texi Tue Jul 27 13:57:51 2010 (r24542)
+++ trunk/doc/ffprobe-doc.texi Tue Jul 27 15:10:59 2010 (r24543)
@@ -105,6 +105,8 @@ with name ``STREAM''.
@end table
@c man end
+ at include indevs.texi
+
@ignore
@setfilename ffprobe
Added: trunk/doc/indevs.texi
==============================================================================
--- /dev/null 00:00:00 1970 (empty, because file is newly added)
+++ trunk/doc/indevs.texi Tue Jul 27 15:10:59 2010 (r24543)
@@ -0,0 +1,208 @@
+ at chapter Devices
+ at c man begin INPUT DEVICES
+
+Input devices are configured elements in FFmpeg which allow to access
+the data coming from a multimedia device attached to your system.
+
+When you configure your FFmpeg build, all the supported input devices
+are enabled by default. You can list them using the configure option
+"--list-indevs".
+
+You can disable all the input devices using the configure option
+"--disable-indevs", and selectively enable an input device using the
+option "--enable-indev=@var{INDEV}", or you can disable a particular
+input device using the option "--disable-indev=@var{INDEV}".
+
+The option "-formats" of the ff* tools will display the list of
+supported input devices (amongst the demuxers).
+
+A description of the currently available input devices follows.
+
+ at section alsa
+
+ALSA (Advanced Linux Sound Architecture) input device.
+
+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 check the
+files @file{/proc/asound/cards} and @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 libjack
+installed on your system.
+
+A jack input device creates one or more jack writable clients, one for
+each audio channel, with name @var{client_name}:input_ at var{N}, where
+ at var{client_name} is the name provided by the application, and @var{N}
+is a number which identifies the channel.
+Each writable client will send the acquired data to the FFmpeg input
+device.
+
+Once you have created one or more jack readable clients, you need to
+connect them to one or more jack writable clients.
+
+To connect or disconnect jack clients you can use the
+ 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 writable client with name "ffmpeg"
+$ 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 writable 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 input device, based on libdc1394 and libraw1394.
+
+ at section oss
+
+Open Sound System input 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 has a name of the
+kind @file{/dev/video at var{N}}, where @var{N} is a number associated to
+the device.
+
+Video4Linux and Video4Linux2 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.
+
+If the size for the device is set to 0x0, the input device will
+try to autodetect the size to use.
+
+Video4Linux support is deprecated since Linux 2.6.30, and will be
+dropped in later versions.
+
+Follow some usage examples of the video4linux devices with the ff*
+tools.
+ at example
+# grab and show the input of a video4linux device
+ffplay -s 320x240 -f video4linux /dev/video0
+
+# grab and show the input of a video4linux2 device, autoadjust size
+ffplay -f video4linux2 /dev/video0
+
+# grab and record the input of a video4linux2 device, autoadjust size
+ffmpeg -f video4linux2 -i /dev/video0 out.mpeg
+ at end example
+
+ at section vfwcap
+
+VFW (Video For Window) catpure input device.
+
+ at section x11grab
+
+X11 video input device.
+
+This device allows to capture a region of an X11 display.
+
+The filename passed in input has the syntax:
+ at example
+[@var{hostname}]:@var{display_number}. at var{screen_number}[+ at var{x_offset}, at var{y_offset}]
+ at end example
+
+ at var{hostname}:@var{display_number}. at var{screen_number} specifies the
+X11 display name of the screen to grab from. @var{hostname} can be not
+specified, and defaults to "localhost". The environment variable
+ at env{DISPLAY} contains the default display name.
+
+ 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. They
+default to 0.
+
+Check the X11 documentation (e.g. man X) for more detailed information.
+
+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
+ffmpeg -f x11grab -r 25 -s cif -i :0.0 out.mpg
+
+# grab at position 10,20
+ffmpeg -f x11grab -25 -s cif -i :0.0+10,20 out.mpg
+ at end example
+
+ at c man end INPUT DEVICES
Added: trunk/doc/outdevs.texi
==============================================================================
--- /dev/null 00:00:00 1970 (empty, because file is newly added)
+++ trunk/doc/outdevs.texi Tue Jul 27 15:10:59 2010 (r24543)
@@ -0,0 +1,33 @@
+ at chapter Output Devices
+ at c man begin OUTPUT DEVICES
+
+Output devices are configured elements in FFmpeg which allow to write
+multimedia data to an output device attached to your system.
+
+When you configure your FFmpeg build, all the supported output devices
+are enabled by default. You can list them using the configure option
+"--list-outdevs".
+
+You can disable all the output devices using the configure option
+"--disable-outdevs", and selectively enable an output device using the
+option "--enable-outdev=@var{OUTDEV}", or you can disable a particular
+input device using the option "--disable-outdev=@var{OUTDEV}".
+
+The option "-formats" of the ff* tools will display the list of
+enabled output devices (amongst the muxers).
+
+A description of the currently available output devices follows.
+
+ at section alsa
+
+ALSA (Advanced Linux Sound Architecture) output device.
+
+ at section audio_beos
+
+BeOS audio output device.
+
+ at section oss
+
+OSS (Open Sound System) output device.
+
+ at c man end OUTPUT DEVICES
More information about the ffmpeg-cvslog
mailing list