doc/indevs: itemize examples for the v4l2 device
[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 @item dvguid
228 Select the capture device by specifying it's GUID. Capturing will only
229 be performed from the specified device and fails if no device with the
230 given GUID is found. This is useful to select the input if multiple
231 devices are connected at the same time.
232 Look at /sys/bus/firewire/devices to find out the GUIDs.
233
234 @end table
235
236 @subsection Examples
237
238 @itemize
239
240 @item
241 Grab and show the input of a FireWire DV/HDV device.
242 @example
243 ffplay -f iec61883 -i auto
244 @end example
245
246 @item
247 Grab and record the input of a FireWire DV/HDV device,
248 using a packet buffer of 100000 packets if the source is HDV.
249 @example
250 ffmpeg -f iec61883 -i auto -hdvbuffer 100000 out.mpg
251 @end example
252
253 @end itemize
254
255 @section jack
256
257 JACK input device.
258
259 To enable this input device during configuration you need libjack
260 installed on your system.
261
262 A JACK input device creates one or more JACK writable clients, one for
263 each audio channel, with name @var{client_name}:input_@var{N}, where
264 @var{client_name} is the name provided by the application, and @var{N}
265 is a number which identifies the channel.
266 Each writable client will send the acquired data to the FFmpeg input
267 device.
268
269 Once you have created one or more JACK readable clients, you need to
270 connect them to one or more JACK writable clients.
271
272 To connect or disconnect JACK clients you can use the @command{jack_connect}
273 and @command{jack_disconnect} programs, or do it through a graphical interface,
274 for example with @command{qjackctl}.
275
276 To list the JACK clients and their properties you can invoke the command
277 @command{jack_lsp}.
278
279 Follows an example which shows how to capture a JACK readable client
280 with @command{ffmpeg}.
281 @example
282 # Create a JACK writable client with name "ffmpeg".
283 $ ffmpeg -f jack -i ffmpeg -y out.wav
284
285 # Start the sample jack_metro readable client.
286 $ jack_metro -b 120 -d 0.2 -f 4000
287
288 # List the current JACK clients.
289 $ jack_lsp -c
290 system:capture_1
291 system:capture_2
292 system:playback_1
293 system:playback_2
294 ffmpeg:input_1
295 metro:120_bpm
296
297 # Connect metro to the ffmpeg writable client.
298 $ jack_connect metro:120_bpm ffmpeg:input_1
299 @end example
300
301 For more information read:
302 @url{http://jackaudio.org/}
303
304 @section lavfi
305
306 Libavfilter input virtual device.
307
308 This input device reads data from the open output pads of a libavfilter
309 filtergraph.
310
311 For each filtergraph open output, the input device will create a
312 corresponding stream which is mapped to the generated output. Currently
313 only video data is supported. The filtergraph is specified through the
314 option @option{graph}.
315
316 @subsection Options
317
318 @table @option
319
320 @item graph
321 Specify the filtergraph to use as input. Each video open output must be
322 labelled by a unique string of the form "out@var{N}", where @var{N} is a
323 number starting from 0 corresponding to the mapped input stream
324 generated by the device.
325 The first unlabelled output is automatically assigned to the "out0"
326 label, but all the others need to be specified explicitly.
327
328 If not specified defaults to the filename specified for the input
329 device.
330
331 @item graph_file
332 Set the filename of the filtergraph to be read and sent to the other
333 filters. Syntax of the filtergraph is the same as the one specified by
334 the option @var{graph}.
335
336 @end table
337
338 @subsection Examples
339
340 @itemize
341 @item
342 Create a color video stream and play it back with @command{ffplay}:
343 @example
344 ffplay -f lavfi -graph "color=c=pink [out0]" dummy
345 @end example
346
347 @item
348 As the previous example, but use filename for specifying the graph
349 description, and omit the "out0" label:
350 @example
351 ffplay -f lavfi color=c=pink
352 @end example
353
354 @item
355 Create three different video test filtered sources and play them:
356 @example
357 ffplay -f lavfi -graph "testsrc [out0]; testsrc,hflip [out1]; testsrc,negate [out2]" test3
358 @end example
359
360 @item
361 Read an audio stream from a file using the amovie source and play it
362 back with @command{ffplay}:
363 @example
364 ffplay -f lavfi "amovie=test.wav"
365 @end example
366
367 @item
368 Read an audio stream and a video stream and play it back with
369 @command{ffplay}:
370 @example
371 ffplay -f lavfi "movie=test.avi[out0];amovie=test.wav[out1]"
372 @end example
373
374 @end itemize
375
376 @section libdc1394
377
378 IIDC1394 input device, based on libdc1394 and libraw1394.
379
380 @section openal
381
382 The OpenAL input device provides audio capture on all systems with a
383 working OpenAL 1.1 implementation.
384
385 To enable this input device during configuration, you need OpenAL
386 headers and libraries installed on your system, and need to configure
387 FFmpeg with @code{--enable-openal}.
388
389 OpenAL headers and libraries should be provided as part of your OpenAL
390 implementation, or as an additional download (an SDK). Depending on your
391 installation you may need to specify additional flags via the
392 @code{--extra-cflags} and @code{--extra-ldflags} for allowing the build
393 system to locate the OpenAL headers and libraries.
394
395 An incomplete list of OpenAL implementations follows:
396
397 @table @strong
398 @item Creative
399 The official Windows implementation, providing hardware acceleration
400 with supported devices and software fallback.
401 See @url{http://openal.org/}.
402 @item OpenAL Soft
403 Portable, open source (LGPL) software implementation. Includes
404 backends for the most common sound APIs on the Windows, Linux,
405 Solaris, and BSD operating systems.
406 See @url{http://kcat.strangesoft.net/openal.html}.
407 @item Apple
408 OpenAL is part of Core Audio, the official Mac OS X Audio interface.
409 See @url{http://developer.apple.com/technologies/mac/audio-and-video.html}
410 @end table
411
412 This device allows to capture from an audio input device handled
413 through OpenAL.
414
415 You need to specify the name of the device to capture in the provided
416 filename. If the empty string is provided, the device will
417 automatically select the default device. You can get the list of the
418 supported devices by using the option @var{list_devices}.
419
420 @subsection Options
421
422 @table @option
423
424 @item channels
425 Set the number of channels in the captured audio. Only the values
426 @option{1} (monaural) and @option{2} (stereo) are currently supported.
427 Defaults to @option{2}.
428
429 @item sample_size
430 Set the sample size (in bits) of the captured audio. Only the values
431 @option{8} and @option{16} are currently supported. Defaults to
432 @option{16}.
433
434 @item sample_rate
435 Set the sample rate (in Hz) of the captured audio.
436 Defaults to @option{44.1k}.
437
438 @item list_devices
439 If set to @option{true}, print a list of devices and exit.
440 Defaults to @option{false}.
441
442 @end table
443
444 @subsection Examples
445
446 Print the list of OpenAL supported devices and exit:
447 @example
448 $ ffmpeg -list_devices true -f openal -i dummy out.ogg
449 @end example
450
451 Capture from the OpenAL device @file{DR-BT101 via PulseAudio}:
452 @example
453 $ ffmpeg -f openal -i 'DR-BT101 via PulseAudio' out.ogg
454 @end example
455
456 Capture from the default device (note the empty string '' as filename):
457 @example
458 $ ffmpeg -f openal -i '' out.ogg
459 @end example
460
461 Capture from two devices simultaneously, writing to two different files,
462 within the same @command{ffmpeg} command:
463 @example
464 $ ffmpeg -f openal -i 'DR-BT101 via PulseAudio' out1.ogg -f openal -i 'ALSA Default' out2.ogg
465 @end example
466 Note: not all OpenAL implementations support multiple simultaneous capture -
467 try the latest OpenAL Soft if the above does not work.
468
469 @section oss
470
471 Open Sound System input device.
472
473 The filename to provide to the input device is the device node
474 representing the OSS input device, and is usually set to
475 @file{/dev/dsp}.
476
477 For example to grab from @file{/dev/dsp} using @command{ffmpeg} use the
478 command:
479 @example
480 ffmpeg -f oss -i /dev/dsp /tmp/oss.wav
481 @end example
482
483 For more information about OSS see:
484 @url{http://manuals.opensound.com/usersguide/dsp.html}
485
486 @section pulse
487
488 pulseaudio input device.
489
490 To enable this input device during configuration you need libpulse-simple
491 installed in your system.
492
493 The filename to provide to the input device is a source device or the
494 string "default"
495
496 To list the pulse source devices and their properties you can invoke
497 the command @command{pactl list sources}.
498
499 @example
500 ffmpeg -f pulse -i default /tmp/pulse.wav
501 @end example
502
503 @subsection @var{server} AVOption
504
505 The syntax is:
506 @example
507 -server @var{server name}
508 @end example
509
510 Connects to a specific server.
511
512 @subsection @var{name} AVOption
513
514 The syntax is:
515 @example
516 -name @var{application name}
517 @end example
518
519 Specify the application name pulse will use when showing active clients,
520 by default it is the LIBAVFORMAT_IDENT string
521
522 @subsection @var{stream_name} AVOption
523
524 The syntax is:
525 @example
526 -stream_name @var{stream name}
527 @end example
528
529 Specify the stream name pulse will use when showing active streams,
530 by default it is "record"
531
532 @subsection @var{sample_rate} AVOption
533
534 The syntax is:
535 @example
536 -sample_rate @var{samplerate}
537 @end example
538
539 Specify the samplerate in Hz, by default 48kHz is used.
540
541 @subsection @var{channels} AVOption
542
543 The syntax is:
544 @example
545 -channels @var{N}
546 @end example
547
548 Specify the channels in use, by default 2 (stereo) is set.
549
550 @subsection @var{frame_size} AVOption
551
552 The syntax is:
553 @example
554 -frame_size @var{bytes}
555 @end example
556
557 Specify the number of byte per frame, by default it is set to 1024.
558
559 @subsection @var{fragment_size} AVOption
560
561 The syntax is:
562 @example
563 -fragment_size @var{bytes}
564 @end example
565
566 Specify the minimal buffering fragment in pulseaudio, it will affect the
567 audio latency. By default it is unset.
568
569 @section sndio
570
571 sndio input device.
572
573 To enable this input device during configuration you need libsndio
574 installed on your system.
575
576 The filename to provide to the input device is the device node
577 representing the sndio input device, and is usually set to
578 @file{/dev/audio0}.
579
580 For example to grab from @file{/dev/audio0} using @command{ffmpeg} use the
581 command:
582 @example
583 ffmpeg -f sndio -i /dev/audio0 /tmp/oss.wav
584 @end example
585
586 @section video4linux2, v4l2
587
588 Video4Linux2 input video device.
589
590 "v4l2" can be used as alias for "video4linux2".
591
592 If FFmpeg is built with v4l-utils support (by using the
593 @code{--enable-libv4l2} configure option), the device will always rely
594 on libv4l2.
595
596 The name of the device to grab is a file device node, usually Linux
597 systems tend to automatically create such nodes when the device
598 (e.g. an USB webcam) is plugged into the system, and has a name of the
599 kind @file{/dev/video@var{N}}, where @var{N} is a number associated to
600 the device.
601
602 Video4Linux2 devices usually support a limited set of
603 @var{width}x@var{height} sizes and framerates. You can check which are
604 supported using @command{-list_formats all} for Video4Linux2 devices.
605 Some devices, like TV cards, support one or more standards. It is possible
606 to list all the supported standards using @command{-list_standards all}.
607
608 The time base for the timestamps is 1 microsecond. Depending on the kernel
609 version and configuration, the timestamps may be derived from the real time
610 clock (origin at the Unix Epoch) or the monotonic clock (origin usually at
611 boot time, unaffected by NTP or manual changes to the clock). The
612 @option{-timestamps abs} or @option{-ts abs} option can be used to force
613 conversion into the real time clock.
614
615 Some usage examples of the video4linux2 device with @command{ffmpeg}
616 and @command{ffplay}:
617 @itemize
618 @item
619 Grab and show the input of a video4linux2 device:
620 @example
621 ffplay -f video4linux2 -framerate 30 -video_size hd720 /dev/video0
622 @end example
623
624 @item
625 Grab and record the input of a video4linux2 device, leave the
626 framerate and size as previously set:
627 @example
628 ffmpeg -f video4linux2 -input_format mjpeg -i /dev/video0 out.mpeg
629 @end example
630 @end itemize
631
632 For more information about Video4Linux, check @url{http://linuxtv.org/}.
633
634 @section vfwcap
635
636 VfW (Video for Windows) capture input device.
637
638 The filename passed as input is the capture driver number, ranging from
639 0 to 9. You may use "list" as filename to print a list of drivers. Any
640 other filename will be interpreted as device number 0.
641
642 @section x11grab
643
644 X11 video input device.
645
646 This device allows to capture a region of an X11 display.
647
648 The filename passed as input has the syntax:
649 @example
650 [@var{hostname}]:@var{display_number}.@var{screen_number}[+@var{x_offset},@var{y_offset}]
651 @end example
652
653 @var{hostname}:@var{display_number}.@var{screen_number} specifies the
654 X11 display name of the screen to grab from. @var{hostname} can be
655 omitted, and defaults to "localhost". The environment variable
656 @env{DISPLAY} contains the default display name.
657
658 @var{x_offset} and @var{y_offset} specify the offsets of the grabbed
659 area with respect to the top-left border of the X11 screen. They
660 default to 0.
661
662 Check the X11 documentation (e.g. man X) for more detailed information.
663
664 Use the @command{dpyinfo} program for getting basic information about the
665 properties of your X11 display (e.g. grep for "name" or "dimensions").
666
667 For example to grab from @file{:0.0} using @command{ffmpeg}:
668 @example
669 ffmpeg -f x11grab -r 25 -s cif -i :0.0 out.mpg
670 @end example
671
672 Grab at position @code{10,20}:
673 @example
674 ffmpeg -f x11grab -r 25 -s cif -i :0.0+10,20 out.mpg
675 @end example
676
677 @subsection Options
678
679 @table @option
680 @item draw_mouse
681 Specify whether to draw the mouse pointer. A value of @code{0} specify
682 not to draw the pointer. Default value is @code{1}.
683
684 @item follow_mouse
685 Make the grabbed area follow the mouse. The argument can be
686 @code{centered} or a number of pixels @var{PIXELS}.
687
688 When it is specified with "centered", the grabbing region follows the mouse
689 pointer and keeps the pointer at the center of region; otherwise, the region
690 follows only when the mouse pointer reaches within @var{PIXELS} (greater than
691 zero) to the edge of region.
692
693 For example:
694 @example
695 ffmpeg -f x11grab -follow_mouse centered -r 25 -s cif -i :0.0 out.mpg
696 @end example
697
698 To follow only when the mouse pointer reaches within 100 pixels to edge:
699 @example
700 ffmpeg -f x11grab -follow_mouse 100 -r 25 -s cif -i :0.0 out.mpg
701 @end example
702
703 @item framerate
704 Set the grabbing frame rate. Default value is @code{ntsc},
705 corresponding to a framerate of @code{30000/1001}.
706
707 @item show_region
708 Show grabbed region on screen.
709
710 If @var{show_region} is specified with @code{1}, then the grabbing
711 region will be indicated on screen. With this option, it is easy to
712 know what is being grabbed if only a portion of the screen is grabbed.
713
714 For example:
715 @example
716 ffmpeg -f x11grab -show_region 1 -r 25 -s cif -i :0.0+10,20 out.mpg
717 @end example
718
719 With @var{follow_mouse}:
720 @example
721 ffmpeg -f x11grab -follow_mouse centered -show_region 1 -r 25 -s cif -i :0.0 out.mpg
722 @end example
723
724 @item video_size
725 Set the video frame size. Default value is @code{vga}.
726 @end table
727
728 @c man end INPUT DEVICES