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