doc: Remove non-existing decklink options.
[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 enable accessing
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 "-devices" of the ff* tools will display the list of
17 supported input devices.
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 avfoundation
55
56 AVFoundation input device.
57
58 AVFoundation is the currently recommended framework by Apple for streamgrabbing on OSX >= 10.7 as well as on iOS.
59 The older QTKit framework has been marked deprecated since OSX version 10.7.
60
61 The input filename has to be given in the following syntax:
62 @example
63 -i "[[VIDEO]:[AUDIO]]"
64 @end example
65 The first entry selects the video input while the latter selects the audio input.
66 The stream has to be specified by the device name or the device index as shown by the device list.
67 Alternatively, the video and/or audio input device can be chosen by index using the
68 @option{
69     -video_device_index <INDEX>
70 }
71 and/or
72 @option{
73     -audio_device_index <INDEX>
74 }
75 , overriding any
76 device name or index given in the input filename.
77
78 All available devices can be enumerated by using @option{-list_devices true}, listing
79 all device names and corresponding indices.
80
81 There are two device name aliases:
82 @table @code
83
84 @item default
85 Select the AVFoundation default device of the corresponding type.
86
87 @item none
88 Do not record the corresponding media type.
89 This is equivalent to specifying an empty device name or index.
90
91 @end table
92
93 @subsection Options
94
95 AVFoundation supports the following options:
96
97 @table @option
98
99 @item -list_devices <TRUE|FALSE>
100 If set to true, a list of all available input devices is given showing all
101 device names and indices.
102
103 @item -video_device_index <INDEX>
104 Specify the video device by its index. Overrides anything given in the input filename.
105
106 @item -audio_device_index <INDEX>
107 Specify the audio device by its index. Overrides anything given in the input filename.
108
109 @item -pixel_format <FORMAT>
110 Request the video device to use a specific pixel format.
111 If the specified format is not supported, a list of available formats is given
112 und the first one in this list is used instead. Available pixel formats are:
113 @code{monob, rgb555be, rgb555le, rgb565be, rgb565le, rgb24, bgr24, 0rgb, bgr0, 0bgr, rgb0,
114  bgr48be, uyvy422, yuva444p, yuva444p16le, yuv444p, yuv422p16, yuv422p10, yuv444p10,
115  yuv420p, nv12, yuyv422, gray}
116
117 @end table
118
119 @subsection Examples
120
121 @itemize
122
123 @item
124 Print the list of AVFoundation supported devices and exit:
125 @example
126 $ ffmpeg -f avfoundation -list_devices true -i ""
127 @end example
128
129 @item
130 Record video from video device 0 and audio from audio device 0 into out.avi:
131 @example
132 $ ffmpeg -f avfoundation -i "0:0" out.avi
133 @end example
134
135 @item
136 Record video from video device 2 and audio from audio device 1 into out.avi:
137 @example
138 $ ffmpeg -f avfoundation -video_device_index 2 -i ":1" out.avi
139 @end example
140
141 @item
142 Record video from the system default video device using the pixel format bgr0 and do not record any audio into out.avi:
143 @example
144 $ ffmpeg -f avfoundation -pixel_format bgr0 -i "default:none" out.avi
145 @end example
146
147 @end itemize
148
149 @section bktr
150
151 BSD video input device.
152
153 @section decklink
154
155 The decklink input device provides capture capabilities for Blackmagic
156 DeckLink devices.
157
158 To enable this input device, you need the Blackmagic DeckLink SDK and you
159 need to configure with the appropriate @code{--extra-cflags}
160 and @code{--extra-ldflags}.
161 On Windows, you need to run the IDL files through @command{widl}.
162
163 DeckLink is very picky about the formats it supports. Pixel format is
164 uyvy422 or v210, framerate and video size must be determined for your device with
165 @command{-list_formats 1}. Audio sample rate is always 48 kHz and the number
166 of channels can be 2, 8 or 16.
167
168 @subsection Options
169
170 @table @option
171
172 @item list_devices
173 If set to @option{true}, print a list of devices and exit.
174 Defaults to @option{false}.
175
176 @item list_formats
177 If set to @option{true}, print a list of supported formats and exit.
178 Defaults to @option{false}.
179
180 @item bm_v210
181 If set to @samp{1}, video is captured in 10 bit v210 instead
182 of uyvy422. Not all Blackmagic devices support this option.
183
184 @end table
185
186 @subsection Examples
187
188 @itemize
189
190 @item
191 List input devices:
192 @example
193 ffmpeg -f decklink -list_devices 1 -i dummy
194 @end example
195
196 @item
197 List supported formats:
198 @example
199 ffmpeg -f decklink -list_formats 1 -i 'Intensity Pro'
200 @end example
201
202 @item
203 Capture video clip at 1080i50 (format 11):
204 @example
205 ffmpeg -f decklink -i 'Intensity Pro@@11' -acodec copy -vcodec copy output.avi
206 @end example
207
208 @item
209 Capture video clip at 1080i50 10 bit:
210 @example
211 ffmpeg -bm_v210 1 -f decklink -i 'UltraStudio Mini Recorder@@11' -acodec copy -vcodec copy output.avi
212 @end example
213
214 @item
215 Capture video clip at 720p50 with 32bit audio:
216 @example
217 ffmpeg -bm_audiodepth 32 -f decklink -i 'UltraStudio Mini Recorder@@14' -acodec copy -vcodec copy output.avi
218 @end example
219
220 @item
221 Capture video clip at 576i50 with 8 audio channels:
222 @example
223 ffmpeg -bm_channels 8 -f decklink -i 'UltraStudio Mini Recorder@@3' -acodec copy -vcodec copy output.avi
224 @end example
225
226 @end itemize
227
228 @section dshow
229
230 Windows DirectShow input device.
231
232 DirectShow support is enabled when FFmpeg is built with the mingw-w64 project.
233 Currently only audio and video devices are supported.
234
235 Multiple devices may be opened as separate inputs, but they may also be
236 opened on the same input, which should improve synchronism between them.
237
238 The input name should be in the format:
239
240 @example
241 @var{TYPE}=@var{NAME}[:@var{TYPE}=@var{NAME}]
242 @end example
243
244 where @var{TYPE} can be either @var{audio} or @var{video},
245 and @var{NAME} is the device's name or alternative name..
246
247 @subsection Options
248
249 If no options are specified, the device's defaults are used.
250 If the device does not support the requested options, it will
251 fail to open.
252
253 @table @option
254
255 @item video_size
256 Set the video size in the captured video.
257
258 @item framerate
259 Set the frame rate in the captured video.
260
261 @item sample_rate
262 Set the sample rate (in Hz) of the captured audio.
263
264 @item sample_size
265 Set the sample size (in bits) of the captured audio.
266
267 @item channels
268 Set the number of channels in the captured audio.
269
270 @item list_devices
271 If set to @option{true}, print a list of devices and exit.
272
273 @item list_options
274 If set to @option{true}, print a list of selected device's options
275 and exit.
276
277 @item video_device_number
278 Set video device number for devices with same name (starts at 0,
279 defaults to 0).
280
281 @item audio_device_number
282 Set audio device number for devices with same name (starts at 0,
283 defaults to 0).
284
285 @item pixel_format
286 Select pixel format to be used by DirectShow. This may only be set when
287 the video codec is not set or set to rawvideo.
288
289 @item audio_buffer_size
290 Set audio device buffer size in milliseconds (which can directly
291 impact latency, depending on the device).
292 Defaults to using the audio device's
293 default buffer size (typically some multiple of 500ms).
294 Setting this value too low can degrade performance.
295 See also
296 @url{http://msdn.microsoft.com/en-us/library/windows/desktop/dd377582(v=vs.85).aspx}
297
298 @item video_pin_name
299 Select video capture pin to use by name or alternative name.
300
301 @item audio_pin_name
302 Select audio capture pin to use by name or alternative name.
303
304 @item crossbar_video_input_pin_number
305 Select video input pin number for crossbar device. This will be
306 routed to the crossbar device's Video Decoder output pin.
307 Note that changing this value can affect future invocations
308 (sets a new default) until system reboot occurs.
309
310 @item crossbar_audio_input_pin_number
311 Select audio input pin number for crossbar device. This will be
312 routed to the crossbar device's Audio Decoder output pin.
313 Note that changing this value can affect future invocations
314 (sets a new default) until system reboot occurs.
315
316 @item show_video_device_dialog
317 If set to @option{true}, before capture starts, popup a display dialog
318 to the end user, allowing them to change video filter properties
319 and configurations manually.
320 Note that for crossbar devices, adjusting values in this dialog
321 may be needed at times to toggle between PAL (25 fps) and NTSC (29.97)
322 input frame rates, sizes, interlacing, etc.  Changing these values can
323 enable different scan rates/frame rates and avoiding green bars at
324 the bottom, flickering scan lines, etc.
325 Note that with some devices, changing these properties can also affect future
326 invocations (sets new defaults) until system reboot occurs.
327
328 @item show_audio_device_dialog
329 If set to @option{true}, before capture starts, popup a display dialog
330 to the end user, allowing them to change audio filter properties
331 and configurations manually.
332
333 @item show_video_crossbar_connection_dialog
334 If set to @option{true}, before capture starts, popup a display
335 dialog to the end user, allowing them to manually
336 modify crossbar pin routings, when it opens a video device.
337
338 @item show_audio_crossbar_connection_dialog
339 If set to @option{true}, before capture starts, popup a display
340 dialog to the end user, allowing them to manually
341 modify crossbar pin routings, when it opens an audio device.
342
343 @item show_analog_tv_tuner_dialog
344 If set to @option{true}, before capture starts, popup a display
345 dialog to the end user, allowing them to manually
346 modify TV channels and frequencies.
347
348 @item show_analog_tv_tuner_audio_dialog
349 If set to @option{true}, before capture starts, popup a display
350 dialog to the end user, allowing them to manually
351 modify TV audio (like mono vs. stereo, Language A,B or C).
352
353 @end table
354
355 @subsection Examples
356
357 @itemize
358
359 @item
360 Print the list of DirectShow supported devices and exit:
361 @example
362 $ ffmpeg -list_devices true -f dshow -i dummy
363 @end example
364
365 @item
366 Open video device @var{Camera}:
367 @example
368 $ ffmpeg -f dshow -i video="Camera"
369 @end example
370
371 @item
372 Open second video device with name @var{Camera}:
373 @example
374 $ ffmpeg -f dshow -video_device_number 1 -i video="Camera"
375 @end example
376
377 @item
378 Open video device @var{Camera} and audio device @var{Microphone}:
379 @example
380 $ ffmpeg -f dshow -i video="Camera":audio="Microphone"
381 @end example
382
383 @item
384 Print the list of supported options in selected device and exit:
385 @example
386 $ ffmpeg -list_options true -f dshow -i video="Camera"
387 @end example
388
389 @item
390 Specify pin names to capture by name or alternative name, specify alternative device name:
391 @example
392 $ ffmpeg -f dshow -audio_pin_name "Audio Out" -video_pin_name 2 -i video=video="@@device_pnp_\\?\pci#ven_1a0a&dev_6200&subsys_62021461&rev_01#4&e2c7dd6&0&00e1#@{65e8773d-8f56-11d0-a3b9-00a0c9223196@}\@{ca465100-deb0-4d59-818f-8c477184adf6@}":audio="Microphone"
393 @end example
394
395 @item
396 Configure a crossbar device, specifying crossbar pins, allow user to adjust video capture properties at startup:
397 @example
398 $ ffmpeg -f dshow -show_video_device_dialog true -crossbar_video_input_pin_number 0
399      -crossbar_audio_input_pin_number 3 -i video="AVerMedia BDA Analog Capture":audio="AVerMedia BDA Analog Capture"
400 @end example
401
402 @end itemize
403
404 @section dv1394
405
406 Linux DV 1394 input device.
407
408 @section fbdev
409
410 Linux framebuffer input device.
411
412 The Linux framebuffer is a graphic hardware-independent abstraction
413 layer to show graphics on a computer monitor, typically on the
414 console. It is accessed through a file device node, usually
415 @file{/dev/fb0}.
416
417 For more detailed information read the file
418 Documentation/fb/framebuffer.txt included in the Linux source tree.
419
420 To record from the framebuffer device @file{/dev/fb0} with
421 @command{ffmpeg}:
422 @example
423 ffmpeg -f fbdev -r 10 -i /dev/fb0 out.avi
424 @end example
425
426 You can take a single screenshot image with the command:
427 @example
428 ffmpeg -f fbdev -frames:v 1 -r 1 -i /dev/fb0 screenshot.jpeg
429 @end example
430
431 See also @url{http://linux-fbdev.sourceforge.net/}, and fbset(1).
432
433 @section gdigrab
434
435 Win32 GDI-based screen capture device.
436
437 This device allows you to capture a region of the display on Windows.
438
439 There are two options for the input filename:
440 @example
441 desktop
442 @end example
443 or
444 @example
445 title=@var{window_title}
446 @end example
447
448 The first option will capture the entire desktop, or a fixed region of the
449 desktop. The second option will instead capture the contents of a single
450 window, regardless of its position on the screen.
451
452 For example, to grab the entire desktop using @command{ffmpeg}:
453 @example
454 ffmpeg -f gdigrab -framerate 6 -i desktop out.mpg
455 @end example
456
457 Grab a 640x480 region at position @code{10,20}:
458 @example
459 ffmpeg -f gdigrab -framerate 6 -offset_x 10 -offset_y 20 -video_size vga -i desktop out.mpg
460 @end example
461
462 Grab the contents of the window named "Calculator"
463 @example
464 ffmpeg -f gdigrab -framerate 6 -i title=Calculator out.mpg
465 @end example
466
467 @subsection Options
468
469 @table @option
470 @item draw_mouse
471 Specify whether to draw the mouse pointer. Use the value @code{0} to
472 not draw the pointer. Default value is @code{1}.
473
474 @item framerate
475 Set the grabbing frame rate. Default value is @code{ntsc},
476 corresponding to a frame rate of @code{30000/1001}.
477
478 @item show_region
479 Show grabbed region on screen.
480
481 If @var{show_region} is specified with @code{1}, then the grabbing
482 region will be indicated on screen. With this option, it is easy to
483 know what is being grabbed if only a portion of the screen is grabbed.
484
485 Note that @var{show_region} is incompatible with grabbing the contents
486 of a single window.
487
488 For example:
489 @example
490 ffmpeg -f gdigrab -show_region 1 -framerate 6 -video_size cif -offset_x 10 -offset_y 20 -i desktop out.mpg
491 @end example
492
493 @item video_size
494 Set the video frame size. The default is to capture the full screen if @file{desktop} is selected, or the full window size if @file{title=@var{window_title}} is selected.
495
496 @item offset_x
497 When capturing a region with @var{video_size}, set the distance from the left edge of the screen or desktop.
498
499 Note that the offset calculation is from the top left corner of the primary monitor on Windows. If you have a monitor positioned to the left of your primary monitor, you will need to use a negative @var{offset_x} value to move the region to that monitor.
500
501 @item offset_y
502 When capturing a region with @var{video_size}, set the distance from the top edge of the screen or desktop.
503
504 Note that the offset calculation is from the top left corner of the primary monitor on Windows. If you have a monitor positioned above your primary monitor, you will need to use a negative @var{offset_y} value to move the region to that monitor.
505
506 @end table
507
508 @section iec61883
509
510 FireWire DV/HDV input device using libiec61883.
511
512 To enable this input device, you need libiec61883, libraw1394 and
513 libavc1394 installed on your system. Use the configure option
514 @code{--enable-libiec61883} to compile with the device enabled.
515
516 The iec61883 capture device supports capturing from a video device
517 connected via IEEE1394 (FireWire), using libiec61883 and the new Linux
518 FireWire stack (juju). This is the default DV/HDV input method in Linux
519 Kernel 2.6.37 and later, since the old FireWire stack was removed.
520
521 Specify the FireWire port to be used as input file, or "auto"
522 to choose the first port connected.
523
524 @subsection Options
525
526 @table @option
527
528 @item dvtype
529 Override autodetection of DV/HDV. This should only be used if auto
530 detection does not work, or if usage of a different device type
531 should be prohibited. Treating a DV device as HDV (or vice versa) will
532 not work and result in undefined behavior.
533 The values @option{auto}, @option{dv} and @option{hdv} are supported.
534
535 @item dvbuffer
536 Set maximum size of buffer for incoming data, in frames. For DV, this
537 is an exact value. For HDV, it is not frame exact, since HDV does
538 not have a fixed frame size.
539
540 @item dvguid
541 Select the capture device by specifying it's GUID. Capturing will only
542 be performed from the specified device and fails if no device with the
543 given GUID is found. This is useful to select the input if multiple
544 devices are connected at the same time.
545 Look at /sys/bus/firewire/devices to find out the GUIDs.
546
547 @end table
548
549 @subsection Examples
550
551 @itemize
552
553 @item
554 Grab and show the input of a FireWire DV/HDV device.
555 @example
556 ffplay -f iec61883 -i auto
557 @end example
558
559 @item
560 Grab and record the input of a FireWire DV/HDV device,
561 using a packet buffer of 100000 packets if the source is HDV.
562 @example
563 ffmpeg -f iec61883 -i auto -hdvbuffer 100000 out.mpg
564 @end example
565
566 @end itemize
567
568 @section jack
569
570 JACK input device.
571
572 To enable this input device during configuration you need libjack
573 installed on your system.
574
575 A JACK input device creates one or more JACK writable clients, one for
576 each audio channel, with name @var{client_name}:input_@var{N}, where
577 @var{client_name} is the name provided by the application, and @var{N}
578 is a number which identifies the channel.
579 Each writable client will send the acquired data to the FFmpeg input
580 device.
581
582 Once you have created one or more JACK readable clients, you need to
583 connect them to one or more JACK writable clients.
584
585 To connect or disconnect JACK clients you can use the @command{jack_connect}
586 and @command{jack_disconnect} programs, or do it through a graphical interface,
587 for example with @command{qjackctl}.
588
589 To list the JACK clients and their properties you can invoke the command
590 @command{jack_lsp}.
591
592 Follows an example which shows how to capture a JACK readable client
593 with @command{ffmpeg}.
594 @example
595 # Create a JACK writable client with name "ffmpeg".
596 $ ffmpeg -f jack -i ffmpeg -y out.wav
597
598 # Start the sample jack_metro readable client.
599 $ jack_metro -b 120 -d 0.2 -f 4000
600
601 # List the current JACK clients.
602 $ jack_lsp -c
603 system:capture_1
604 system:capture_2
605 system:playback_1
606 system:playback_2
607 ffmpeg:input_1
608 metro:120_bpm
609
610 # Connect metro to the ffmpeg writable client.
611 $ jack_connect metro:120_bpm ffmpeg:input_1
612 @end example
613
614 For more information read:
615 @url{http://jackaudio.org/}
616
617 @section lavfi
618
619 Libavfilter input virtual device.
620
621 This input device reads data from the open output pads of a libavfilter
622 filtergraph.
623
624 For each filtergraph open output, the input device will create a
625 corresponding stream which is mapped to the generated output. Currently
626 only video data is supported. The filtergraph is specified through the
627 option @option{graph}.
628
629 @subsection Options
630
631 @table @option
632
633 @item graph
634 Specify the filtergraph to use as input. Each video open output must be
635 labelled by a unique string of the form "out@var{N}", where @var{N} is a
636 number starting from 0 corresponding to the mapped input stream
637 generated by the device.
638 The first unlabelled output is automatically assigned to the "out0"
639 label, but all the others need to be specified explicitly.
640
641 The suffix "+subcc" can be appended to the output label to create an extra
642 stream with the closed captions packets attached to that output
643 (experimental; only for EIA-608 / CEA-708 for now).
644 The subcc streams are created after all the normal streams, in the order of
645 the corresponding stream.
646 For example, if there is "out19+subcc", "out7+subcc" and up to "out42", the
647 stream #43 is subcc for stream #7 and stream #44 is subcc for stream #19.
648
649 If not specified defaults to the filename specified for the input
650 device.
651
652 @item graph_file
653 Set the filename of the filtergraph to be read and sent to the other
654 filters. Syntax of the filtergraph is the same as the one specified by
655 the option @var{graph}.
656
657 @end table
658
659 @subsection Examples
660
661 @itemize
662 @item
663 Create a color video stream and play it back with @command{ffplay}:
664 @example
665 ffplay -f lavfi -graph "color=c=pink [out0]" dummy
666 @end example
667
668 @item
669 As the previous example, but use filename for specifying the graph
670 description, and omit the "out0" label:
671 @example
672 ffplay -f lavfi color=c=pink
673 @end example
674
675 @item
676 Create three different video test filtered sources and play them:
677 @example
678 ffplay -f lavfi -graph "testsrc [out0]; testsrc,hflip [out1]; testsrc,negate [out2]" test3
679 @end example
680
681 @item
682 Read an audio stream from a file using the amovie source and play it
683 back with @command{ffplay}:
684 @example
685 ffplay -f lavfi "amovie=test.wav"
686 @end example
687
688 @item
689 Read an audio stream and a video stream and play it back with
690 @command{ffplay}:
691 @example
692 ffplay -f lavfi "movie=test.avi[out0];amovie=test.wav[out1]"
693 @end example
694
695 @item
696 Dump decoded frames to images and closed captions to a file (experimental):
697 @example
698 ffmpeg -f lavfi -i "movie=test.ts[out0+subcc]" -map v frame%08d.png -map s -c copy -f rawvideo subcc.bin
699 @end example
700
701 @end itemize
702
703 @section libcdio
704
705 Audio-CD input device based on libcdio.
706
707 To enable this input device during configuration you need libcdio
708 installed on your system. It requires the configure option
709 @code{--enable-libcdio}.
710
711 This device allows playing and grabbing from an Audio-CD.
712
713 For example to copy with @command{ffmpeg} the entire Audio-CD in @file{/dev/sr0},
714 you may run the command:
715 @example
716 ffmpeg -f libcdio -i /dev/sr0 cd.wav
717 @end example
718
719 @subsection Options
720 @table @option
721 @item speed
722 Set drive reading speed. Default value is 0.
723
724 The speed is specified CD-ROM speed units. The speed is set through
725 the libcdio @code{cdio_cddap_speed_set} function. On many CD-ROM
726 drives, specifying a value too large will result in using the fastest
727 speed.
728
729 @item paranoia_mode
730 Set paranoia recovery mode flags. It accepts one of the following values:
731
732 @table @samp
733 @item disable
734 @item verify
735 @item overlap
736 @item neverskip
737 @item full
738 @end table
739
740 Default value is @samp{disable}.
741
742 For more information about the available recovery modes, consult the
743 paranoia project documentation.
744 @end table
745
746 @section libdc1394
747
748 IIDC1394 input device, based on libdc1394 and libraw1394.
749
750 Requires the configure option @code{--enable-libdc1394}.
751
752 @section openal
753
754 The OpenAL input device provides audio capture on all systems with a
755 working OpenAL 1.1 implementation.
756
757 To enable this input device during configuration, you need OpenAL
758 headers and libraries installed on your system, and need to configure
759 FFmpeg with @code{--enable-openal}.
760
761 OpenAL headers and libraries should be provided as part of your OpenAL
762 implementation, or as an additional download (an SDK). Depending on your
763 installation you may need to specify additional flags via the
764 @code{--extra-cflags} and @code{--extra-ldflags} for allowing the build
765 system to locate the OpenAL headers and libraries.
766
767 An incomplete list of OpenAL implementations follows:
768
769 @table @strong
770 @item Creative
771 The official Windows implementation, providing hardware acceleration
772 with supported devices and software fallback.
773 See @url{http://openal.org/}.
774 @item OpenAL Soft
775 Portable, open source (LGPL) software implementation. Includes
776 backends for the most common sound APIs on the Windows, Linux,
777 Solaris, and BSD operating systems.
778 See @url{http://kcat.strangesoft.net/openal.html}.
779 @item Apple
780 OpenAL is part of Core Audio, the official Mac OS X Audio interface.
781 See @url{http://developer.apple.com/technologies/mac/audio-and-video.html}
782 @end table
783
784 This device allows one to capture from an audio input device handled
785 through OpenAL.
786
787 You need to specify the name of the device to capture in the provided
788 filename. If the empty string is provided, the device will
789 automatically select the default device. You can get the list of the
790 supported devices by using the option @var{list_devices}.
791
792 @subsection Options
793
794 @table @option
795
796 @item channels
797 Set the number of channels in the captured audio. Only the values
798 @option{1} (monaural) and @option{2} (stereo) are currently supported.
799 Defaults to @option{2}.
800
801 @item sample_size
802 Set the sample size (in bits) of the captured audio. Only the values
803 @option{8} and @option{16} are currently supported. Defaults to
804 @option{16}.
805
806 @item sample_rate
807 Set the sample rate (in Hz) of the captured audio.
808 Defaults to @option{44.1k}.
809
810 @item list_devices
811 If set to @option{true}, print a list of devices and exit.
812 Defaults to @option{false}.
813
814 @end table
815
816 @subsection Examples
817
818 Print the list of OpenAL supported devices and exit:
819 @example
820 $ ffmpeg -list_devices true -f openal -i dummy out.ogg
821 @end example
822
823 Capture from the OpenAL device @file{DR-BT101 via PulseAudio}:
824 @example
825 $ ffmpeg -f openal -i 'DR-BT101 via PulseAudio' out.ogg
826 @end example
827
828 Capture from the default device (note the empty string '' as filename):
829 @example
830 $ ffmpeg -f openal -i '' out.ogg
831 @end example
832
833 Capture from two devices simultaneously, writing to two different files,
834 within the same @command{ffmpeg} command:
835 @example
836 $ ffmpeg -f openal -i 'DR-BT101 via PulseAudio' out1.ogg -f openal -i 'ALSA Default' out2.ogg
837 @end example
838 Note: not all OpenAL implementations support multiple simultaneous capture -
839 try the latest OpenAL Soft if the above does not work.
840
841 @section oss
842
843 Open Sound System input device.
844
845 The filename to provide to the input device is the device node
846 representing the OSS input device, and is usually set to
847 @file{/dev/dsp}.
848
849 For example to grab from @file{/dev/dsp} using @command{ffmpeg} use the
850 command:
851 @example
852 ffmpeg -f oss -i /dev/dsp /tmp/oss.wav
853 @end example
854
855 For more information about OSS see:
856 @url{http://manuals.opensound.com/usersguide/dsp.html}
857
858 @section pulse
859
860 PulseAudio input device.
861
862 To enable this output device you need to configure FFmpeg with @code{--enable-libpulse}.
863
864 The filename to provide to the input device is a source device or the
865 string "default"
866
867 To list the PulseAudio source devices and their properties you can invoke
868 the command @command{pactl list sources}.
869
870 More information about PulseAudio can be found on @url{http://www.pulseaudio.org}.
871
872 @subsection Options
873 @table @option
874 @item server
875 Connect to a specific PulseAudio server, specified by an IP address.
876 Default server is used when not provided.
877
878 @item name
879 Specify the application name PulseAudio will use when showing active clients,
880 by default it is the @code{LIBAVFORMAT_IDENT} string.
881
882 @item stream_name
883 Specify the stream name PulseAudio will use when showing active streams,
884 by default it is "record".
885
886 @item sample_rate
887 Specify the samplerate in Hz, by default 48kHz is used.
888
889 @item channels
890 Specify the channels in use, by default 2 (stereo) is set.
891
892 @item frame_size
893 Specify the number of bytes per frame, by default it is set to 1024.
894
895 @item fragment_size
896 Specify the minimal buffering fragment in PulseAudio, it will affect the
897 audio latency. By default it is unset.
898 @end table
899
900 @subsection Examples
901 Record a stream from default device:
902 @example
903 ffmpeg -f pulse -i default /tmp/pulse.wav
904 @end example
905
906 @section qtkit
907
908 QTKit input device.
909
910 The filename passed as input is parsed to contain either a device name or index.
911 The device index can also be given by using -video_device_index.
912 A given device index will override any given device name.
913 If the desired device consists of numbers only, use -video_device_index to identify it.
914 The default device will be chosen if an empty string  or the device name "default" is given.
915 The available devices can be enumerated by using -list_devices.
916
917 @example
918 ffmpeg -f qtkit -i "0" out.mpg
919 @end example
920
921 @example
922 ffmpeg -f qtkit -video_device_index 0 -i "" out.mpg
923 @end example
924
925 @example
926 ffmpeg -f qtkit -i "default" out.mpg
927 @end example
928
929 @example
930 ffmpeg -f qtkit -list_devices true -i ""
931 @end example
932
933 @section sndio
934
935 sndio input device.
936
937 To enable this input device during configuration you need libsndio
938 installed on your system.
939
940 The filename to provide to the input device is the device node
941 representing the sndio input device, and is usually set to
942 @file{/dev/audio0}.
943
944 For example to grab from @file{/dev/audio0} using @command{ffmpeg} use the
945 command:
946 @example
947 ffmpeg -f sndio -i /dev/audio0 /tmp/oss.wav
948 @end example
949
950 @section video4linux2, v4l2
951
952 Video4Linux2 input video device.
953
954 "v4l2" can be used as alias for "video4linux2".
955
956 If FFmpeg is built with v4l-utils support (by using the
957 @code{--enable-libv4l2} configure option), it is possible to use it with the
958 @code{-use_libv4l2} input device option.
959
960 The name of the device to grab is a file device node, usually Linux
961 systems tend to automatically create such nodes when the device
962 (e.g. an USB webcam) is plugged into the system, and has a name of the
963 kind @file{/dev/video@var{N}}, where @var{N} is a number associated to
964 the device.
965
966 Video4Linux2 devices usually support a limited set of
967 @var{width}x@var{height} sizes and frame rates. You can check which are
968 supported using @command{-list_formats all} for Video4Linux2 devices.
969 Some devices, like TV cards, support one or more standards. It is possible
970 to list all the supported standards using @command{-list_standards all}.
971
972 The time base for the timestamps is 1 microsecond. Depending on the kernel
973 version and configuration, the timestamps may be derived from the real time
974 clock (origin at the Unix Epoch) or the monotonic clock (origin usually at
975 boot time, unaffected by NTP or manual changes to the clock). The
976 @option{-timestamps abs} or @option{-ts abs} option can be used to force
977 conversion into the real time clock.
978
979 Some usage examples of the video4linux2 device with @command{ffmpeg}
980 and @command{ffplay}:
981 @itemize
982 @item
983 List supported formats for a video4linux2 device:
984 @example
985 ffplay -f video4linux2 -list_formats all /dev/video0
986 @end example
987
988 @item
989 Grab and show the input of a video4linux2 device:
990 @example
991 ffplay -f video4linux2 -framerate 30 -video_size hd720 /dev/video0
992 @end example
993
994 @item
995 Grab and record the input of a video4linux2 device, leave the
996 frame rate and size as previously set:
997 @example
998 ffmpeg -f video4linux2 -input_format mjpeg -i /dev/video0 out.mpeg
999 @end example
1000 @end itemize
1001
1002 For more information about Video4Linux, check @url{http://linuxtv.org/}.
1003
1004 @subsection Options
1005
1006 @table @option
1007 @item standard
1008 Set the standard. Must be the name of a supported standard. To get a
1009 list of the supported standards, use the @option{list_standards}
1010 option.
1011
1012 @item channel
1013 Set the input channel number. Default to -1, which means using the
1014 previously selected channel.
1015
1016 @item video_size
1017 Set the video frame size. The argument must be a string in the form
1018 @var{WIDTH}x@var{HEIGHT} or a valid size abbreviation.
1019
1020 @item pixel_format
1021 Select the pixel format (only valid for raw video input).
1022
1023 @item input_format
1024 Set the preferred pixel format (for raw video) or a codec name.
1025 This option allows one to select the input format, when several are
1026 available.
1027
1028 @item framerate
1029 Set the preferred video frame rate.
1030
1031 @item list_formats
1032 List available formats (supported pixel formats, codecs, and frame
1033 sizes) and exit.
1034
1035 Available values are:
1036 @table @samp
1037 @item all
1038 Show all available (compressed and non-compressed) formats.
1039
1040 @item raw
1041 Show only raw video (non-compressed) formats.
1042
1043 @item compressed
1044 Show only compressed formats.
1045 @end table
1046
1047 @item list_standards
1048 List supported standards and exit.
1049
1050 Available values are:
1051 @table @samp
1052 @item all
1053 Show all supported standards.
1054 @end table
1055
1056 @item timestamps, ts
1057 Set type of timestamps for grabbed frames.
1058
1059 Available values are:
1060 @table @samp
1061 @item default
1062 Use timestamps from the kernel.
1063
1064 @item abs
1065 Use absolute timestamps (wall clock).
1066
1067 @item mono2abs
1068 Force conversion from monotonic to absolute timestamps.
1069 @end table
1070
1071 Default value is @code{default}.
1072 @end table
1073
1074 @section vfwcap
1075
1076 VfW (Video for Windows) capture input device.
1077
1078 The filename passed as input is the capture driver number, ranging from
1079 0 to 9. You may use "list" as filename to print a list of drivers. Any
1080 other filename will be interpreted as device number 0.
1081
1082 @section x11grab
1083
1084 X11 video input device.
1085
1086 To enable this input device during configuration you need libxcb
1087 installed on your system. It will be automatically detected during
1088 configuration.
1089
1090 Alternatively, the configure option @option{--enable-x11grab} exists
1091 for legacy Xlib users.
1092
1093 This device allows one to capture a region of an X11 display.
1094
1095 The filename passed as input has the syntax:
1096 @example
1097 [@var{hostname}]:@var{display_number}.@var{screen_number}[+@var{x_offset},@var{y_offset}]
1098 @end example
1099
1100 @var{hostname}:@var{display_number}.@var{screen_number} specifies the
1101 X11 display name of the screen to grab from. @var{hostname} can be
1102 omitted, and defaults to "localhost". The environment variable
1103 @env{DISPLAY} contains the default display name.
1104
1105 @var{x_offset} and @var{y_offset} specify the offsets of the grabbed
1106 area with respect to the top-left border of the X11 screen. They
1107 default to 0.
1108
1109 Check the X11 documentation (e.g. @command{man X}) for more detailed
1110 information.
1111
1112 Use the @command{xdpyinfo} program for getting basic information about
1113 the properties of your X11 display (e.g. grep for "name" or
1114 "dimensions").
1115
1116 For example to grab from @file{:0.0} using @command{ffmpeg}:
1117 @example
1118 ffmpeg -f x11grab -framerate 25 -video_size cif -i :0.0 out.mpg
1119 @end example
1120
1121 Grab at position @code{10,20}:
1122 @example
1123 ffmpeg -f x11grab -framerate 25 -video_size cif -i :0.0+10,20 out.mpg
1124 @end example
1125
1126 @subsection Options
1127
1128 @table @option
1129 @item draw_mouse
1130 Specify whether to draw the mouse pointer. A value of @code{0} specify
1131 not to draw the pointer. Default value is @code{1}.
1132
1133 @item follow_mouse
1134 Make the grabbed area follow the mouse. The argument can be
1135 @code{centered} or a number of pixels @var{PIXELS}.
1136
1137 When it is specified with "centered", the grabbing region follows the mouse
1138 pointer and keeps the pointer at the center of region; otherwise, the region
1139 follows only when the mouse pointer reaches within @var{PIXELS} (greater than
1140 zero) to the edge of region.
1141
1142 For example:
1143 @example
1144 ffmpeg -f x11grab -follow_mouse centered -framerate 25 -video_size cif -i :0.0 out.mpg
1145 @end example
1146
1147 To follow only when the mouse pointer reaches within 100 pixels to edge:
1148 @example
1149 ffmpeg -f x11grab -follow_mouse 100 -framerate 25 -video_size cif -i :0.0 out.mpg
1150 @end example
1151
1152 @item framerate
1153 Set the grabbing frame rate. Default value is @code{ntsc},
1154 corresponding to a frame rate of @code{30000/1001}.
1155
1156 @item show_region
1157 Show grabbed region on screen.
1158
1159 If @var{show_region} is specified with @code{1}, then the grabbing
1160 region will be indicated on screen. With this option, it is easy to
1161 know what is being grabbed if only a portion of the screen is grabbed.
1162
1163 @item region_border
1164 Set the region border thickness if @option{-show_region 1} is used.
1165 Range is 1 to 128 and default is 3 (XCB-based x11grab only).
1166
1167 For example:
1168 @example
1169 ffmpeg -f x11grab -show_region 1 -framerate 25 -video_size cif -i :0.0+10,20 out.mpg
1170 @end example
1171
1172 With @var{follow_mouse}:
1173 @example
1174 ffmpeg -f x11grab -follow_mouse centered -show_region 1 -framerate 25 -video_size cif -i :0.0 out.mpg
1175 @end example
1176
1177 @item video_size
1178 Set the video frame size. Default value is @code{vga}.
1179
1180 @item use_shm
1181 Use the MIT-SHM extension for shared memory. Default value is @code{1}.
1182 It may be necessary to disable it for remote displays (legacy x11grab
1183 only).
1184 @end table
1185
1186 @subsection @var{grab_x} @var{grab_y} AVOption
1187
1188 The syntax is:
1189 @example
1190 -grab_x @var{x_offset} -grab_y @var{y_offset}
1191 @end example
1192
1193 Set the grabbing region coordinates. They are expressed as offset from the top left
1194 corner of the X11 window. The default value is 0.
1195
1196
1197 @c man end INPUT DEVICES