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