Statistics
| Branch: | Revision:

ffmpeg / doc / indevs.texi @ 15d59d2c

History | View | Annotate | Download (6.96 KB)

1
@chapter Input Devices
2
@c man begin INPUT DEVICES
3

    
4
Input devices are configured elements in Libav which allow to access
5
the data coming from a multimedia device attached to your system.
6

    
7
When you configure your Libav build, all the supported input devices
8
are enabled by default. You can list all available ones using the
9
configure option "--list-indevs".
10

    
11
You can disable all the input devices using the configure option
12
"--disable-indevs", and selectively enable an input device using the
13
option "--enable-indev=@var{INDEV}", or you can disable a particular
14
input device using the option "--disable-indev=@var{INDEV}".
15

    
16
The option "-formats" of the ff* tools will display the list of
17
supported input devices (amongst the demuxers).
18

    
19
A description of the currently available input devices follows.
20

    
21
@section alsa
22

    
23
ALSA (Advanced Linux Sound Architecture) input device.
24

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

    
28
This device allows capturing from an ALSA device. The name of the
29
device to capture has to be an ALSA card identifier.
30

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

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

    
38
The three arguments (in order: @var{CARD},@var{DEV},@var{SUBDEV})
39
specify card number or identifier, device number and subdevice number
40
(-1 means any).
41

    
42
To see the list of cards currently recognized by your system check the
43
files @file{/proc/asound/cards} and @file{/proc/asound/devices}.
44

    
45
For example to capture with @file{ffmpeg} from an ALSA device with
46
card id 0, you may run the command:
47
@example
48
ffmpeg -f alsa -i hw:0 alsaout.wav
49
@end example
50

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

    
54
@section bktr
55

    
56
BSD video input device.
57

    
58
@section dv1394
59

    
60
Linux DV 1394 input device.
61

    
62
@section jack
63

    
64
JACK input device.
65

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

    
69
A JACK input device creates one or more JACK writable clients, one for
70
each audio channel, with name @var{client_name}:input_@var{N}, where
71
@var{client_name} is the name provided by the application, and @var{N}
72
is a number which identifies the channel.
73
Each writable client will send the acquired data to the Libav input
74
device.
75

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

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

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

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

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

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

    
104
# Connect metro to the ffmpeg writable client.
105
$ jack_connect metro:120_bpm ffmpeg:input_1
106
@end example
107

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

    
111
@section libdc1394
112

    
113
IIDC1394 input device, based on libdc1394 and libraw1394.
114

    
115
@section oss
116

    
117
Open Sound System input device.
118

    
119
The filename to provide to the input device is the device node
120
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
command:
125
@example
126
ffmpeg -f oss -i /dev/dsp /tmp/oss.wav
127
@end example
128

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

    
132
@section sndio
133

    
134
sndio input device.
135

    
136
To enable this input device during configuration you need libsndio
137
installed on your system.
138

    
139
The filename to provide to the input device is the device node
140
representing the sndio input device, and is usually set to
141
@file{/dev/audio0}.
142

    
143
For example to grab from @file{/dev/audio0} using @file{ffmpeg} use the
144
command:
145
@example
146
ffmpeg -f sndio -i /dev/audio0 /tmp/oss.wav
147
@end example
148

    
149
@section video4linux and video4linux2
150

    
151
Video4Linux and Video4Linux2 input video devices.
152

    
153
The name of the device to grab is a file device node, usually Linux
154
systems tend to automatically create such nodes when the device
155
(e.g. an USB webcam) is plugged into the system, and has a name of the
156
kind @file{/dev/video@var{N}}, where @var{N} is a number associated to
157
the device.
158

    
159
Video4Linux and Video4Linux2 devices only support a limited set of
160
@var{width}x@var{height} sizes and framerates. You can check which are
161
supported for example with the command @file{dov4l} for Video4Linux
162
devices and the command @file{v4l-info} for Video4Linux2 devices.
163

    
164
If the size for the device is set to 0x0, the input device will
165
try to autodetect the size to use.
166
Only for the video4linux2 device, if the frame rate is set to 0/0 the
167
input device will use the frame rate value already set in the driver.
168

    
169
Video4Linux support is deprecated since Linux 2.6.30, and will be
170
dropped in later versions.
171

    
172
Follow some usage examples of the video4linux devices with the ff*
173
tools.
174
@example
175
# Grab and show the input of a video4linux device, frame rate is set
176
# to the default of 25/1.
177
ffplay -s 320x240 -f video4linux /dev/video0
178

    
179
# Grab and show the input of a video4linux2 device, autoadjust size.
180
ffplay -f video4linux2 /dev/video0
181

    
182
# Grab and record the input of a video4linux2 device, autoadjust size,
183
# frame rate value defaults to 0/0 so it is read from the video4linux2
184
# driver.
185
ffmpeg -f video4linux2 -i /dev/video0 out.mpeg
186
@end example
187

    
188
@section vfwcap
189

    
190
VfW (Video for Windows) capture input device.
191

    
192
The filename passed as input is the capture driver number, ranging from
193
0 to 9. You may use "list" as filename to print a list of drivers. Any
194
other filename will be interpreted as device number 0.
195

    
196
@section x11grab
197

    
198
X11 video input device.
199

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

    
202
The filename passed as input has the syntax:
203
@example
204
[@var{hostname}]:@var{display_number}.@var{screen_number}[+@var{x_offset},@var{y_offset}]
205
@end example
206

    
207
@var{hostname}:@var{display_number}.@var{screen_number} specifies the
208
X11 display name of the screen to grab from. @var{hostname} can be
209
ommitted, and defaults to "localhost". The environment variable
210
@env{DISPLAY} contains the default display name.
211

    
212
@var{x_offset} and @var{y_offset} specify the offsets of the grabbed
213
area with respect to the top-left border of the X11 screen. They
214
default to 0.
215

    
216
Check the X11 documentation (e.g. man X) for more detailed information.
217

    
218
Use the @file{dpyinfo} program for getting basic information about the
219
properties of your X11 display (e.g. grep for "name" or "dimensions").
220

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

    
225
# Grab at position 10,20.
226
ffmpeg -f x11grab -25 -s cif -i :0.0+10,20 out.mpg
227
@end example
228

    
229
@c man end INPUT DEVICES