tests/Makefile: fix ffprobe test dependancy
[ffmpeg.git] / doc / indevs.texi
1 @chapter Input Devices
2 @c man begin INPUT DEVICES
3
4 Input devices are configured elements in FFmpeg which allow to access
5 the data coming from a multimedia device attached to your system.
6
7 When you configure your FFmpeg 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 @command{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 dshow
59
60 Windows DirectShow input device.
61
62 DirectShow support is enabled when FFmpeg is built with the mingw-w64 project.
63 Currently only audio and video devices are supported.
64
65 Multiple devices may be opened as separate inputs, but they may also be
66 opened on the same input, which should improve synchronism between them.
67
68 The input name should be in the format:
69
70 @example
71 @var{TYPE}=@var{NAME}[:@var{TYPE}=@var{NAME}]
72 @end example
73
74 where @var{TYPE} can be either @var{audio} or @var{video},
75 and @var{NAME} is the device's name.
76
77 @subsection Options
78
79 If no options are specified, the device's defaults are used.
80 If the device does not support the requested options, it will
81 fail to open.
82
83 @table @option
84
85 @item video_size
86 Set the video size in the captured video.
87
88 @item framerate
89 Set the framerate in the captured video.
90
91 @item sample_rate
92 Set the sample rate (in Hz) of the captured audio.
93
94 @item sample_size
95 Set the sample size (in bits) of the captured audio.
96
97 @item channels
98 Set the number of channels in the captured audio.
99
100 @item list_devices
101 If set to @option{true}, print a list of devices and exit.
102
103 @item list_options
104 If set to @option{true}, print a list of selected device's options
105 and exit.
106
107 @item video_device_number
108 Set video device number for devices with same name (starts at 0,
109 defaults to 0).
110
111 @item audio_device_number
112 Set audio device number for devices with same name (starts at 0,
113 defaults to 0).
114
115 @item pixel_format
116 Select pixel format to be used by DirectShow. This may only be set when
117 the video codec is not set or set to rawvideo.
118
119 @item audio_buffer_size
120 Set audio device buffer size in milliseconds (which can directly
121 impact latency, depending on the device).
122 Defaults to using the audio device's
123 default buffer size (typically some multiple of 500ms).
124 Setting this value too low can degrade performance.
125 See also
126 @url{http://msdn.microsoft.com/en-us/library/windows/desktop/dd377582(v=vs.85).aspx}
127
128 @end table
129
130 @subsection Examples
131
132 @itemize
133
134 @item
135 Print the list of DirectShow supported devices and exit:
136 @example
137 $ ffmpeg -list_devices true -f dshow -i dummy
138 @end example
139
140 @item
141 Open video device @var{Camera}:
142 @example
143 $ ffmpeg -f dshow -i video="Camera"
144 @end example
145
146 @item
147 Open second video device with name @var{Camera}:
148 @example
149 $ ffmpeg -f dshow -video_device_number 1 -i video="Camera"
150 @end example
151
152 @item
153 Open video device @var{Camera} and audio device @var{Microphone}:
154 @example
155 $ ffmpeg -f dshow -i video="Camera":audio="Microphone"
156 @end example
157
158 @item
159 Print the list of supported options in selected device and exit:
160 @example
161 $ ffmpeg -list_options true -f dshow -i video="Camera"
162 @end example
163
164 @end itemize
165
166 @section dv1394
167
168 Linux DV 1394 input device.
169
170 @section fbdev
171
172 Linux framebuffer input device.
173
174 The Linux framebuffer is a graphic hardware-independent abstraction
175 layer to show graphics on a computer monitor, typically on the
176 console. It is accessed through a file device node, usually
177 @file{/dev/fb0}.
178
179 For more detailed information read the file
180 Documentation/fb/framebuffer.txt included in the Linux source tree.
181
182 To record from the framebuffer device @file{/dev/fb0} with
183 @command{ffmpeg}:
184 @example
185 ffmpeg -f fbdev -r 10 -i /dev/fb0 out.avi
186 @end example
187
188 You can take a single screenshot image with the command:
189 @example
190 ffmpeg -f fbdev -frames:v 1 -r 1 -i /dev/fb0 screenshot.jpeg
191 @end example
192
193 See also @url{http://linux-fbdev.sourceforge.net/}, and fbset(1).
194
195 @section iec61883
196
197 FireWire DV/HDV input device using libiec61883.
198
199 To enable this input device, you need libiec61883, libraw1394 and
200 libavc1394 installed on your system. Use the configure option
201 @code{--enable-libiec61883} to compile with the device enabled.
202
203 The iec61883 capture device supports capturing from a video device
204 connected via IEEE1394 (FireWire), using libiec61883 and the new Linux
205 FireWire stack (juju). This is the default DV/HDV input method in Linux
206 Kernel 2.6.37 and later, since the old FireWire stack was removed.
207
208 Specify the FireWire port to be used as input file, or "auto"
209 to choose the first port connected.
210
211 @subsection Options
212
213 @table @option
214
215 @item dvtype
216 Override autodetection of DV/HDV. This should only be used if auto
217 detection does not work, or if usage of a different device type
218 should be prohibited. Treating a DV device as HDV (or vice versa) will
219 not work and result in undefined behavior.
220 The values @option{auto}, @option{dv} and @option{hdv} are supported.
221
222 @item dvbuffer
223 Set maxiumum size of buffer for incoming data, in frames. For DV, this
224 is an exact value. For HDV, it is not frame exact, since HDV does
225 not have a fixed frame size.
226
227 @end table
228
229 @subsection Examples
230
231 @itemize
232
233 @item
234 Grab and show the input of a FireWire DV/HDV device.
235 @example
236 ffplay -f iec61883 -i auto
237 @end example
238
239 @item
240 Grab and record the input of a FireWire DV/HDV device,
241 using a packet buffer of 100000 packets if the source is HDV.
242 @example
243 ffmpeg -f iec61883 -i auto -hdvbuffer 100000 out.mpg
244 @end example
245
246 @end itemize
247
248 @section jack
249
250 JACK input device.
251
252 To enable this input device during configuration you need libjack
253 installed on your system.
254
255 A JACK input device creates one or more JACK writable clients, one for
256 each audio channel, with name @var{client_name}:input_@var{N}, where
257 @var{client_name} is the name provided by the application, and @var{N}
258 is a number which identifies the channel.
259 Each writable client will send the acquired data to the FFmpeg input
260 device.
261
262 Once you have created one or more JACK readable clients, you need to
263 connect them to one or more JACK writable clients.
264
265 To connect or disconnect JACK clients you can use the @command{jack_connect}
266 and @command{jack_disconnect} programs, or do it through a graphical interface,
267 for example with @command{qjackctl}.
268
269 To list the JACK clients and their properties you can invoke the command
270 @command{jack_lsp}.
271
272 Follows an example which shows how to capture a JACK readable client
273 with @command{ffmpeg}.
274 @example
275 # Create a JACK writable client with name "ffmpeg".
276 $ ffmpeg -f jack -i ffmpeg -y out.wav
277
278 # Start the sample jack_metro readable client.
279 $ jack_metro -b 120 -d 0.2 -f 4000
280
281 # List the current JACK clients.
282 $ jack_lsp -c
283 system:capture_1
284 system:capture_2
285 system:playback_1
286 system:playback_2
287 ffmpeg:input_1
288 metro:120_bpm
289
290 # Connect metro to the ffmpeg writable client.
291 $ jack_connect metro:120_bpm ffmpeg:input_1
292 @end example
293
294 For more information read:
295 @url{http://jackaudio.org/}
296
297 @section lavfi
298
299 Libavfilter input virtual device.
300
301 This input device reads data from the open output pads of a libavfilter
302 filtergraph.
303
304 For each filtergraph open output, the input device will create a
305 corresponding stream which is mapped to the generated output. Currently
306 only video data is supported. The filtergraph is specified through the
307 option @option{graph}.
308
309 @subsection Options
310
311 @table @option
312
313 @item graph
314 Specify the filtergraph to use as input. Each video open output must be
315 labelled by a unique string of the form "out@var{N}", where @var{N} is a
316 number starting from 0 corresponding to the mapped input stream
317 generated by the device.
318 The first unlabelled output is automatically assigned to the "out0"
319 label, but all the others need to be specified explicitly.
320
321 If not specified defaults to the filename specified for the input
322 device.
323 @end table
324
325 @subsection Examples
326
327 @itemize
328 @item
329 Create a color video stream and play it back with @command{ffplay}:
330 @example
331 ffplay -f lavfi -graph "color=pink [out0]" dummy
332 @end example
333
334 @item
335 As the previous example, but use filename for specifying the graph
336 description, and omit the "out0" label:
337 @example
338 ffplay -f lavfi color=pink
339 @end example
340
341 @item
342 Create three different video test filtered sources and play them:
343 @example
344 ffplay -f lavfi -graph "testsrc [out0]; testsrc,hflip [out1]; testsrc,negate [out2]" test3
345 @end example
346
347 @item
348 Read an audio stream from a file using the amovie source and play it
349 back with @command{ffplay}:
350 @example
351 ffplay -f lavfi "amovie=test.wav"
352 @end example
353
354 @item
355 Read an audio stream and a video stream and play it back with
356 @command{ffplay}:
357 @example
358 ffplay -f lavfi "movie=test.avi[out0];amovie=test.wav[out1]"
359 @end example
360
361 @end itemize
362
363 @section libdc1394
364
365 IIDC1394 input device, based on libdc1394 and libraw1394.
366
367 @section openal
368
369 The OpenAL input device provides audio capture on all systems with a
370 working OpenAL 1.1 implementation.
371
372 To enable this input device during configuration, you need OpenAL
373 headers and libraries installed on your system, and need to configure
374 FFmpeg with @code{--enable-openal}.
375
376 OpenAL headers and libraries should be provided as part of your OpenAL
377 implementation, or as an additional download (an SDK). Depending on your
378 installation you may need to specify additional flags via the
379 @code{--extra-cflags} and @code{--extra-ldflags} for allowing the build
380 system to locate the OpenAL headers and libraries.
381
382 An incomplete list of OpenAL implementations follows:
383
384 @table @strong
385 @item Creative
386 The official Windows implementation, providing hardware acceleration
387 with supported devices and software fallback.
388 See @url{http://openal.org/}.
389 @item OpenAL Soft
390 Portable, open source (LGPL) software implementation. Includes
391 backends for the most common sound APIs on the Windows, Linux,
392 Solaris, and BSD operating systems.
393 See @url{http://kcat.strangesoft.net/openal.html}.
394 @item Apple
395 OpenAL is part of Core Audio, the official Mac OS X Audio interface.
396 See @url{http://developer.apple.com/technologies/mac/audio-and-video.html}
397 @end table
398
399 This device allows to capture from an audio input device handled
400 through OpenAL.
401
402 You need to specify the name of the device to capture in the provided
403 filename. If the empty string is provided, the device will
404 automatically select the default device. You can get the list of the
405 supported devices by using the option @var{list_devices}.
406
407 @subsection Options
408
409 @table @option
410
411 @item channels
412 Set the number of channels in the captured audio. Only the values
413 @option{1} (monaural) and @option{2} (stereo) are currently supported.
414 Defaults to @option{2}.
415
416 @item sample_size
417 Set the sample size (in bits) of the captured audio. Only the values
418 @option{8} and @option{16} are currently supported. Defaults to
419 @option{16}.
420
421 @item sample_rate
422 Set the sample rate (in Hz) of the captured audio.
423 Defaults to @option{44.1k}.
424
425 @item list_devices
426 If set to @option{true}, print a list of devices and exit.
427 Defaults to @option{false}.
428
429 @end table
430
431 @subsection Examples
432
433 Print the list of OpenAL supported devices and exit:
434 @example
435 $ ffmpeg -list_devices true -f openal -i dummy out.ogg
436 @end example
437
438 Capture from the OpenAL device @file{DR-BT101 via PulseAudio}:
439 @example
440 $ ffmpeg -f openal -i 'DR-BT101 via PulseAudio' out.ogg
441 @end example
442
443 Capture from the default device (note the empty string '' as filename):
444 @example
445 $ ffmpeg -f openal -i '' out.ogg
446 @end example
447
448 Capture from two devices simultaneously, writing to two different files,
449 within the same @command{ffmpeg} command:
450 @example
451 $ ffmpeg -f openal -i 'DR-BT101 via PulseAudio' out1.ogg -f openal -i 'ALSA Default' out2.ogg
452 @end example
453 Note: not all OpenAL implementations support multiple simultaneous capture -
454 try the latest OpenAL Soft if the above does not work.
455
456 @section oss
457
458 Open Sound System input device.
459
460 The filename to provide to the input device is the device node
461 representing the OSS input device, and is usually set to
462 @file{/dev/dsp}.
463
464 For example to grab from @file{/dev/dsp} using @command{ffmpeg} use the
465 command:
466 @example
467 ffmpeg -f oss -i /dev/dsp /tmp/oss.wav
468 @end example
469
470 For more information about OSS see:
471 @url{http://manuals.opensound.com/usersguide/dsp.html}
472
473 @section pulse
474
475 pulseaudio input device.
476
477 To enable this input device during configuration you need libpulse-simple
478 installed in your system.
479
480 The filename to provide to the input device is a source device or the
481 string "default"
482
483 To list the pulse source devices and their properties you can invoke
484 the command @command{pactl list sources}.
485
486 @example
487 ffmpeg -f pulse -i default /tmp/pulse.wav
488 @end example
489
490 @subsection @var{server} AVOption
491
492 The syntax is:
493 @example
494 -server @var{server name}
495 @end example
496
497 Connects to a specific server.
498
499 @subsection @var{name} AVOption
500
501 The syntax is:
502 @example
503 -name @var{application name}
504 @end example
505
506 Specify the application name pulse will use when showing active clients,
507 by default it is the LIBAVFORMAT_IDENT string
508
509 @subsection @var{stream_name} AVOption
510
511 The syntax is:
512 @example
513 -stream_name @var{stream name}
514 @end example
515
516 Specify the stream name pulse will use when showing active streams,
517 by default it is "record"
518
519 @subsection @var{sample_rate} AVOption
520
521 The syntax is:
522 @example
523 -sample_rate @var{samplerate}
524 @end example
525
526 Specify the samplerate in Hz, by default 48kHz is used.
527
528 @subsection @var{channels} AVOption
529
530 The syntax is:
531 @example
532 -channels @var{N}
533 @end example
534
535 Specify the channels in use, by default 2 (stereo) is set.
536
537 @subsection @var{frame_size} AVOption
538
539 The syntax is:
540 @example
541 -frame_size @var{bytes}
542 @end example
543
544 Specify the number of byte per frame, by default it is set to 1024.
545
546 @subsection @var{fragment_size} AVOption
547
548 The syntax is:
549 @example
550 -fragment_size @var{bytes}
551 @end example
552
553 Specify the minimal buffering fragment in pulseaudio, it will affect the
554 audio latency. By default it is unset.
555
556 @section sndio
557
558 sndio input device.
559
560 To enable this input device during configuration you need libsndio
561 installed on your system.
562
563 The filename to provide to the input device is the device node
564 representing the sndio input device, and is usually set to
565 @file{/dev/audio0}.
566
567 For example to grab from @file{/dev/audio0} using @command{ffmpeg} use the
568 command:
569 @example
570 ffmpeg -f sndio -i /dev/audio0 /tmp/oss.wav
571 @end example
572
573 @section video4linux2
574
575 Video4Linux2 input video device.
576
577 The name of the device to grab is a file device node, usually Linux
578 systems tend to automatically create such nodes when the device
579 (e.g. an USB webcam) is plugged into the system, and has a name of the
580 kind @file{/dev/video@var{N}}, where @var{N} is a number associated to
581 the device.
582
583 Video4Linux2 devices usually support a limited set of
584 @var{width}x@var{height} sizes and framerates. You can check which are
585 supported using @command{-list_formats all} for Video4Linux2 devices.
586
587 Some usage examples of the video4linux2 devices with ffmpeg and ffplay:
588
589 The time base for the timestamps is 1 microsecond. Depending on the kernel
590 version and configuration, the timestamps may be derived from the real time
591 clock (origin at the Unix Epoch) or the monotonic clock (origin usually at
592 boot time, unaffected by NTP or manual changes to the clock). The
593 @option{-timestamps abs} or @option{-ts abs} option can be used to force
594 conversion into the real time clock.
595
596 Note that if FFmpeg is build with v4l-utils support ("--enable-libv4l2"
597 option), it will always be used.
598 @example
599 # Grab and show the input of a video4linux2 device.
600 ffplay -f video4linux2 -framerate 30 -video_size hd720 /dev/video0
601
602 # Grab and record the input of a video4linux2 device, leave the
603 framerate and size as previously set.
604 ffmpeg -f video4linux2 -input_format mjpeg -i /dev/video0 out.mpeg
605 @end example
606
607 "v4l" and "v4l2" can be used as aliases for the respective "video4linux" and
608 "video4linux2".
609
610 @section vfwcap
611
612 VfW (Video for Windows) capture input device.
613
614 The filename passed as input is the capture driver number, ranging from
615 0 to 9. You may use "list" as filename to print a list of drivers. Any
616 other filename will be interpreted as device number 0.
617
618 @section x11grab
619
620 X11 video input device.
621
622 This device allows to capture a region of an X11 display.
623
624 The filename passed as input has the syntax:
625 @example
626 [@var{hostname}]:@var{display_number}.@var{screen_number}[+@var{x_offset},@var{y_offset}]
627 @end example
628
629 @var{hostname}:@var{display_number}.@var{screen_number} specifies the
630 X11 display name of the screen to grab from. @var{hostname} can be
631 omitted, and defaults to "localhost". The environment variable
632 @env{DISPLAY} contains the default display name.
633
634 @var{x_offset} and @var{y_offset} specify the offsets of the grabbed
635 area with respect to the top-left border of the X11 screen. They
636 default to 0.
637
638 Check the X11 documentation (e.g. man X) for more detailed information.
639
640 Use the @command{dpyinfo} program for getting basic information about the
641 properties of your X11 display (e.g. grep for "name" or "dimensions").
642
643 For example to grab from @file{:0.0} using @command{ffmpeg}:
644 @example
645 ffmpeg -f x11grab -r 25 -s cif -i :0.0 out.mpg
646 @end example
647
648 Grab at position @code{10,20}:
649 @example
650 ffmpeg -f x11grab -r 25 -s cif -i :0.0+10,20 out.mpg
651 @end example
652
653 @subsection Options
654
655 @table @option
656 @item draw_mouse
657 Specify whether to draw the mouse pointer. A value of @code{0} specify
658 not to draw the pointer. Default value is @code{1}.
659
660 @item follow_mouse
661 Make the grabbed area follow the mouse. The argument can be
662 @code{centered} or a number of pixels @var{PIXELS}.
663
664 When it is specified with "centered", the grabbing region follows the mouse
665 pointer and keeps the pointer at the center of region; otherwise, the region
666 follows only when the mouse pointer reaches within @var{PIXELS} (greater than
667 zero) to the edge of region.
668
669 For example:
670 @example
671 ffmpeg -f x11grab -follow_mouse centered -r 25 -s cif -i :0.0 out.mpg
672 @end example
673
674 To follow only when the mouse pointer reaches within 100 pixels to edge:
675 @example
676 ffmpeg -f x11grab -follow_mouse 100 -r 25 -s cif -i :0.0 out.mpg
677 @end example
678
679 @item framerate
680 Set the grabbing frame rate. Default value is @code{ntsc},
681 corresponding to a framerate of @code{30000/1001}.
682
683 @item show_region
684 Show grabbed region on screen.
685
686 If @var{show_region} is specified with @code{1}, then the grabbing
687 region will be indicated on screen. With this option, it is easy to
688 know what is being grabbed if only a portion of the screen is grabbed.
689
690 For example:
691 @example
692 ffmpeg -f x11grab -show_region 1 -r 25 -s cif -i :0.0+10,20 out.mpg
693 @end example
694
695 With @var{follow_mouse}:
696 @example
697 ffmpeg -f x11grab -follow_mouse centered -show_region 1 -r 25 -s cif -i :0.0 out.mpg
698 @end example
699
700 @item video_size
701 Set the video frame size. Default value is @code{vga}.
702 @end table
703
704 @c man end INPUT DEVICES