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