indevs.texi 6.09 KB
Newer Older
1
@chapter Input Devices
2 3 4 5 6 7
@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
8 9
are enabled by default. You can list all available ones using the
configure option "--list-indevs".
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27

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.

@section alsa

ALSA (Advanced Linux Sound Architecture) input device.

To enable this input device during configuration you need libasound
installed on your system.

28
This device allows capturing from an ALSA device. The name of the
29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44
device to capture has to be an ALSA card identifier.

An ALSA identifier has the syntax:
@example
hw:@var{CARD}[,@var{DEV}[,@var{SUBDEV}]]
@end example

where the @var{DEV} and @var{SUBDEV} components are optional.

The three arguments (in order: @var{CARD},@var{DEV},@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}.

45
For example to capture with @file{ffmpeg} from an ALSA device with
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63
card id 0, you may run the command:
@example
ffmpeg -f alsa -i hw:0 alsaout.wav
@end example

For more information see:
@url{http://www.alsa-project.org/alsa-doc/alsa-lib/pcm.html}

@section bktr

BSD video input device.

@section dv1394

Linux DV 1394 input device.

@section jack

64
JACK input device.
65 66 67 68

To enable this input device during configuration you need libjack
installed on your system.

69
A JACK input device creates one or more JACK writable clients, one for
70 71 72 73 74 75
each audio channel, with name @var{client_name}:input_@var{N}, where
@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.

76 77
Once you have created one or more JACK readable clients, you need to
connect them to one or more JACK writable clients.
78

79
To connect or disconnect JACK clients you can use the
80 81 82
@file{jack_connect} and @file{jack_disconnect} programs, or do it
through a graphical interface, for example with @file{qjackctl}.

83
To list the JACK clients and their properties you can invoke the command
84 85
@file{jack_lsp}.

86
Follows an example which shows how to capture a JACK readable client
87 88
with @file{ffmpeg}.
@example
89
# Create a JACK writable client with name "ffmpeg".
90 91
$ ffmpeg -f jack -i ffmpeg -y out.wav

92
# Start the sample jack_metro readable client.
93 94
$ jack_metro -b 120 -d 0.2 -f 4000

95
# List the current JACK clients.
96 97 98 99 100 101 102 103
$ jack_lsp -c
system:capture_1
system:capture_2
system:playback_1
system:playback_2
ffmpeg:input_1
metro:120_bpm

104
# Connect metro to the ffmpeg writable client.
105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120
$ jack_connect metro:120_bpm ffmpeg:input_1
@end example

For more information read:
@url{http://jackaudio.org/}

@section libdc1394

IIDC1394 input device, based on libdc1394 and libraw1394.

@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
121
@file{/dev/dsp}.
122

123
For example to grab from @file{/dev/dsp} using @file{ffmpeg} use the
124 125 126 127 128 129 130 131 132 133 134 135 136 137
command:
@example
ffmpeg -f oss -i /dev/dsp /tmp/oss.wav
@end example

For more information about OSS see:
@url{http://manuals.opensound.com/usersguide/dsp.html}

@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
138
(e.g. an USB webcam) is plugged into the system, and has a name of the
139 140 141 142 143
kind @file{/dev/video@var{N}}, where @var{N} is a number associated to
the device.

Video4Linux and Video4Linux2 devices only support a limited set of
@var{width}x@var{height} sizes and framerates. You can check which are
144 145
supported for example with the command @file{dov4l} for Video4Linux
devices and the command @file{v4l-info} for Video4Linux2 devices.
146 147 148 149 150 151 152 153 154 155

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.
@example
156
# Grab and show the input of a video4linux device.
157 158
ffplay -s 320x240 -f video4linux /dev/video0

159
# Grab and show the input of a video4linux2 device, autoadjust size.
160 161
ffplay -f video4linux2 /dev/video0

162
# Grab and record the input of a video4linux2 device, autoadjust size.
163 164 165 166 167
ffmpeg -f video4linux2 -i /dev/video0 out.mpeg
@end example

@section vfwcap

Stefano Sabatini's avatar
Stefano Sabatini committed
168
VfW (Video for Windows) capture input device.
169 170 171 172 173 174 175

@section x11grab

X11 video input device.

This device allows to capture a region of an X11 display.

176
The filename passed as input has the syntax:
177 178 179 180 181
@example
[@var{hostname}]:@var{display_number}.@var{screen_number}[+@var{x_offset},@var{y_offset}]
@end example

@var{hostname}:@var{display_number}.@var{screen_number} specifies the
182 183
X11 display name of the screen to grab from. @var{hostname} can be
ommitted, and defaults to "localhost". The environment variable
184 185 186
@env{DISPLAY} contains the default display name.

@var{x_offset} and @var{y_offset} specify the offsets of the grabbed
187
area with respect to the top-left border of the X11 screen. They
188 189 190 191 192
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
193
properties of your X11 display (e.g. grep for "name" or "dimensions").
194 195 196 197 198

For example to grab from @file{:0.0} using @file{ffmpeg}:
@example
ffmpeg -f x11grab -r 25 -s cif -i :0.0 out.mpg

199
# Grab at position 10,20.
200 201 202 203
ffmpeg -f x11grab -25 -s cif -i :0.0+10,20 out.mpg
@end example

@c man end INPUT DEVICES