2 @c man begin INPUT DEVICES
4 Input devices are configured elements in FFmpeg which enable accessing
5 the data coming from a multimedia device attached to your system.
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".
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}".
16 The option "-devices" of the ff* tools will display the list of
17 supported input devices.
19 A description of the currently available input devices follows.
23 ALSA (Advanced Linux Sound Architecture) input device.
25 To enable this input device during configuration you need libasound
26 installed on your system.
28 This device allows capturing from an ALSA device. The name of the
29 device to capture has to be an ALSA card identifier.
31 An ALSA identifier has the syntax:
33 hw:@var{CARD}[,@var{DEV}[,@var{SUBDEV}]]
36 where the @var{DEV} and @var{SUBDEV} components are optional.
38 The three arguments (in order: @var{CARD},@var{DEV},@var{SUBDEV})
39 specify card number or identifier, device number and subdevice number
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}.
45 For example to capture with @command{ffmpeg} from an ALSA device with
46 card id 0, you may run the command:
48 ffmpeg -f alsa -i hw:0 alsaout.wav
51 For more information see:
52 @url{http://www.alsa-project.org/alsa-doc/alsa-lib/pcm.html}
59 Set the sample rate in Hz. Default is 48000.
62 Set the number of channels. Default is 2.
68 AVFoundation input device.
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.
73 The input filename has to be given in the following syntax:
75 -i "[[VIDEO]:[AUDIO]]"
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
81 -video_device_index <INDEX>
85 -audio_device_index <INDEX>
88 device name or index given in the input filename.
90 All available devices can be enumerated by using @option{-list_devices true}, listing
91 all device names and corresponding indices.
93 There are two device name aliases:
97 Select the AVFoundation default device of the corresponding type.
100 Do not record the corresponding media type.
101 This is equivalent to specifying an empty device name or index.
107 AVFoundation supports the following options:
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.
115 @item -video_device_index <INDEX>
116 Specify the video device by its index. Overrides anything given in the input filename.
118 @item -audio_device_index <INDEX>
119 Specify the audio device by its index. Overrides anything given in the input filename.
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}
130 Set the grabbing frame rate. Default is @code{ntsc}, corresponding to a
131 frame rate of @code{30000/1001}.
134 Set the video frame size.
136 @item -capture_cursor
137 Capture the mouse pointer. Default is 0.
139 @item -capture_mouse_clicks
140 Capture the screen mouse clicks. Default is 0.
149 Print the list of AVFoundation supported devices and exit:
151 $ ffmpeg -f avfoundation -list_devices true -i ""
155 Record video from video device 0 and audio from audio device 0 into out.avi:
157 $ ffmpeg -f avfoundation -i "0:0" out.avi
161 Record video from video device 2 and audio from audio device 1 into out.avi:
163 $ ffmpeg -f avfoundation -video_device_index 2 -i ":1" out.avi
167 Record video from the system default video device using the pixel format bgr0 and do not record any audio into out.avi:
169 $ ffmpeg -f avfoundation -pixel_format bgr0 -i "default:none" out.avi
176 BSD video input device.
186 Set the video frame size. Default is @code{vga}.
190 Available values are:
210 The decklink input device provides capture capabilities for Blackmagic
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}.
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.
228 If set to @option{true}, print a list of devices and exit.
229 Defaults to @option{false}.
232 If set to @option{true}, print a list of supported formats and exit.
233 Defaults to @option{false}.
236 If set to @samp{1}, video is captured in 10 bit v210 instead
237 of uyvy422. Not all Blackmagic devices support this option.
248 ffmpeg -f decklink -list_devices 1 -i dummy
252 List supported formats:
254 ffmpeg -f decklink -list_formats 1 -i 'Intensity Pro'
258 Capture video clip at 1080i50 (format 11):
260 ffmpeg -f decklink -i 'Intensity Pro@@11' -acodec copy -vcodec copy output.avi
264 Capture video clip at 1080i50 10 bit:
266 ffmpeg -bm_v210 1 -f decklink -i 'UltraStudio Mini Recorder@@11' -acodec copy -vcodec copy output.avi
273 Windows DirectShow input device.
275 DirectShow support is enabled when FFmpeg is built with the mingw-w64 project.
276 Currently only audio and video devices are supported.
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.
281 The input name should be in the format:
284 @var{TYPE}=@var{NAME}[:@var{TYPE}=@var{NAME}]
287 where @var{TYPE} can be either @var{audio} or @var{video},
288 and @var{NAME} is the device's name or alternative name..
292 If no options are specified, the device's defaults are used.
293 If the device does not support the requested options, it will
299 Set the video size in the captured video.
302 Set the frame rate in the captured video.
305 Set the sample rate (in Hz) of the captured audio.
308 Set the sample size (in bits) of the captured audio.
311 Set the number of channels in the captured audio.
314 If set to @option{true}, print a list of devices and exit.
317 If set to @option{true}, print a list of selected device's options
320 @item video_device_number
321 Set video device number for devices with the same name (starts at 0,
324 @item audio_device_number
325 Set audio device number for devices with the same name (starts at 0,
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.
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.
339 @url{http://msdn.microsoft.com/en-us/library/windows/desktop/dd377582(v=vs.85).aspx}
342 Select video capture pin to use by name or alternative name.
345 Select audio capture pin to use by name or alternative name.
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.
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.
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.
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.
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.
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.
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.
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).
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.
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.
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.
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.
427 Print the list of DirectShow supported devices and exit:
429 $ ffmpeg -list_devices true -f dshow -i dummy
433 Open video device @var{Camera}:
435 $ ffmpeg -f dshow -i video="Camera"
439 Open second video device with name @var{Camera}:
441 $ ffmpeg -f dshow -video_device_number 1 -i video="Camera"
445 Open video device @var{Camera} and audio device @var{Microphone}:
447 $ ffmpeg -f dshow -i video="Camera":audio="Microphone"
451 Print the list of supported options in selected device and exit:
453 $ ffmpeg -list_options true -f dshow -i video="Camera"
457 Specify pin names to capture by name or alternative name, specify alternative device name:
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"
463 Configure a crossbar device, specifying crossbar pins, allow user to adjust video capture properties at startup:
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"
473 Linux DV 1394 input device.
480 Set the frame rate. Default is 25.
484 Available values are:
492 Default value is @code{ntsc}.
498 Linux framebuffer input device.
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
505 For more detailed information read the file
506 Documentation/fb/framebuffer.txt included in the Linux source tree.
508 See also @url{http://linux-fbdev.sourceforge.net/}, and fbset(1).
510 To record from the framebuffer device @file{/dev/fb0} with
513 ffmpeg -f fbdev -framerate 10 -i /dev/fb0 out.avi
516 You can take a single screenshot image with the command:
518 ffmpeg -f fbdev -framerate 1 -i /dev/fb0 -frames:v 1 screenshot.jpeg
526 Set the frame rate. Default is 25.
532 Win32 GDI-based screen capture device.
534 This device allows you to capture a region of the display on Windows.
536 There are two options for the input filename:
542 title=@var{window_title}
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.
549 For example, to grab the entire desktop using @command{ffmpeg}:
551 ffmpeg -f gdigrab -framerate 6 -i desktop out.mpg
554 Grab a 640x480 region at position @code{10,20}:
556 ffmpeg -f gdigrab -framerate 6 -offset_x 10 -offset_y 20 -video_size vga -i desktop out.mpg
559 Grab the contents of the window named "Calculator"
561 ffmpeg -f gdigrab -framerate 6 -i title=Calculator out.mpg
568 Specify whether to draw the mouse pointer. Use the value @code{0} to
569 not draw the pointer. Default value is @code{1}.
572 Set the grabbing frame rate. Default value is @code{ntsc},
573 corresponding to a frame rate of @code{30000/1001}.
576 Show grabbed region on screen.
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.
582 Note that @var{show_region} is incompatible with grabbing the contents
587 ffmpeg -f gdigrab -show_region 1 -framerate 6 -video_size cif -offset_x 10 -offset_y 20 -i desktop out.mpg
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.
594 When capturing a region with @var{video_size}, set the distance from the left edge of the screen or desktop.
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.
599 When capturing a region with @var{video_size}, set the distance from the top edge of the screen or desktop.
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.
607 FireWire DV/HDV input device using libiec61883.
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.
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.
618 Specify the FireWire port to be used as input file, or "auto"
619 to choose the first port connected.
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.
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.
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.
651 Grab and show the input of a FireWire DV/HDV device.
653 ffplay -f iec61883 -i auto
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.
660 ffmpeg -f iec61883 -i auto -hdvbuffer 100000 out.mpg
669 To enable this input device during configuration you need libjack
670 installed on your system.
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
679 Once you have created one or more JACK readable clients, you need to
680 connect them to one or more JACK writable clients.
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}.
686 To list the JACK clients and their properties you can invoke the command
689 Follows an example which shows how to capture a JACK readable client
690 with @command{ffmpeg}.
692 # Create a JACK writable client with name "ffmpeg".
693 $ ffmpeg -f jack -i ffmpeg -y out.wav
695 # Start the sample jack_metro readable client.
696 $ jack_metro -b 120 -d 0.2 -f 4000
698 # List the current JACK clients.
707 # Connect metro to the ffmpeg writable client.
708 $ jack_connect metro:120_bpm ffmpeg:input_1
711 For more information read:
712 @url{http://jackaudio.org/}
719 Set the number of channels. Default is 2.
725 Libavfilter input virtual device.
727 This input device reads data from the open output pads of a libavfilter
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}.
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.
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.
755 If not specified defaults to the filename specified for the input
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}.
764 Dump graph to stderr.
772 Create a color video stream and play it back with @command{ffplay}:
774 ffplay -f lavfi -graph "color=c=pink [out0]" dummy
778 As the previous example, but use filename for specifying the graph
779 description, and omit the "out0" label:
781 ffplay -f lavfi color=c=pink
785 Create three different video test filtered sources and play them:
787 ffplay -f lavfi -graph "testsrc [out0]; testsrc,hflip [out1]; testsrc,negate [out2]" test3
791 Read an audio stream from a file using the amovie source and play it
792 back with @command{ffplay}:
794 ffplay -f lavfi "amovie=test.wav"
798 Read an audio stream and a video stream and play it back with
801 ffplay -f lavfi "movie=test.avi[out0];amovie=test.wav[out1]"
805 Dump decoded frames to images and closed captions to a file (experimental):
807 ffmpeg -f lavfi -i "movie=test.ts[out0+subcc]" -map v frame%08d.png -map s -c copy -f rawvideo subcc.bin
814 Audio-CD input device based on libcdio.
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}.
820 This device allows playing and grabbing from an Audio-CD.
822 For example to copy with @command{ffmpeg} the entire Audio-CD in @file{/dev/sr0},
823 you may run the command:
825 ffmpeg -f libcdio -i /dev/sr0 cd.wav
831 Set drive reading speed. Default value is 0.
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
839 Set paranoia recovery mode flags. It accepts one of the following values:
849 Default value is @samp{disable}.
851 For more information about the available recovery modes, consult the
852 paranoia project documentation.
857 IIDC1394 input device, based on libdc1394 and libraw1394.
859 Requires the configure option @code{--enable-libdc1394}.
863 The OpenAL input device provides audio capture on all systems with a
864 working OpenAL 1.1 implementation.
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}.
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.
876 An incomplete list of OpenAL implementations follows:
880 The official Windows implementation, providing hardware acceleration
881 with supported devices and software fallback.
882 See @url{http://openal.org/}.
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}.
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}
893 This device allows one to capture from an audio input device handled
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}.
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}.
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
916 Set the sample rate (in Hz) of the captured audio.
917 Defaults to @option{44.1k}.
920 If set to @option{true}, print a list of devices and exit.
921 Defaults to @option{false}.
927 Print the list of OpenAL supported devices and exit:
929 $ ffmpeg -list_devices true -f openal -i dummy out.ogg
932 Capture from the OpenAL device @file{DR-BT101 via PulseAudio}:
934 $ ffmpeg -f openal -i 'DR-BT101 via PulseAudio' out.ogg
937 Capture from the default device (note the empty string '' as filename):
939 $ ffmpeg -f openal -i '' out.ogg
942 Capture from two devices simultaneously, writing to two different files,
943 within the same @command{ffmpeg} command:
945 $ ffmpeg -f openal -i 'DR-BT101 via PulseAudio' out1.ogg -f openal -i 'ALSA Default' out2.ogg
947 Note: not all OpenAL implementations support multiple simultaneous capture -
948 try the latest OpenAL Soft if the above does not work.
952 Open Sound System input device.
954 The filename to provide to the input device is the device node
955 representing the OSS input device, and is usually set to
958 For example to grab from @file{/dev/dsp} using @command{ffmpeg} use the
961 ffmpeg -f oss -i /dev/dsp /tmp/oss.wav
964 For more information about OSS see:
965 @url{http://manuals.opensound.com/usersguide/dsp.html}
972 Set the sample rate in Hz. Default is 48000.
975 Set the number of channels. Default is 2.
982 PulseAudio input device.
984 To enable this output device you need to configure FFmpeg with @code{--enable-libpulse}.
986 The filename to provide to the input device is a source device or the
989 To list the PulseAudio source devices and their properties you can invoke
990 the command @command{pactl list sources}.
992 More information about PulseAudio can be found on @url{http://www.pulseaudio.org}.
997 Connect to a specific PulseAudio server, specified by an IP address.
998 Default server is used when not provided.
1001 Specify the application name PulseAudio will use when showing active clients,
1002 by default it is the @code{LIBAVFORMAT_IDENT} string.
1005 Specify the stream name PulseAudio will use when showing active streams,
1006 by default it is "record".
1009 Specify the samplerate in Hz, by default 48kHz is used.
1012 Specify the channels in use, by default 2 (stereo) is set.
1015 Specify the number of bytes per frame, by default it is set to 1024.
1018 Specify the minimal buffering fragment in PulseAudio, it will affect the
1019 audio latency. By default it is unset.
1022 Set the initial PTS using the current time. Default is 1.
1026 @subsection Examples
1027 Record a stream from default device:
1029 ffmpeg -f pulse -i default /tmp/pulse.wav
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.
1044 ffmpeg -f qtkit -i "0" out.mpg
1048 ffmpeg -f qtkit -video_device_index 0 -i "" out.mpg
1052 ffmpeg -f qtkit -i "default" out.mpg
1056 ffmpeg -f qtkit -list_devices true -i ""
1064 Set frame rate. Default is 30.
1067 If set to @code{true}, print a list of devices and exit. Default is
1070 @item video_device_index
1071 Select the video device by index for devices with the same name (starts at 0).
1079 To enable this input device during configuration you need libsndio
1080 installed on your system.
1082 The filename to provide to the input device is the device node
1083 representing the sndio input device, and is usually set to
1086 For example to grab from @file{/dev/audio0} using @command{ffmpeg} use the
1089 ffmpeg -f sndio -i /dev/audio0 /tmp/oss.wav
1097 Set the sample rate in Hz. Default is 48000.
1100 Set the number of channels. Default is 2.
1104 @section video4linux2, v4l2
1106 Video4Linux2 input video device.
1108 "v4l2" can be used as alias for "video4linux2".
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.
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
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}.
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.
1133 Some usage examples of the video4linux2 device with @command{ffmpeg}
1134 and @command{ffplay}:
1137 List supported formats for a video4linux2 device:
1139 ffplay -f video4linux2 -list_formats all /dev/video0
1143 Grab and show the input of a video4linux2 device:
1145 ffplay -f video4linux2 -framerate 30 -video_size hd720 /dev/video0
1149 Grab and record the input of a video4linux2 device, leave the
1150 frame rate and size as previously set:
1152 ffmpeg -f video4linux2 -input_format mjpeg -i /dev/video0 out.mpeg
1156 For more information about Video4Linux, check @url{http://linuxtv.org/}.
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}
1167 Set the input channel number. Default to -1, which means using the
1168 previously selected channel.
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.
1175 Select the pixel format (only valid for raw video input).
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
1183 Set the preferred video frame rate.
1186 List available formats (supported pixel formats, codecs, and frame
1189 Available values are:
1192 Show all available (compressed and non-compressed) formats.
1195 Show only raw video (non-compressed) formats.
1198 Show only compressed formats.
1201 @item list_standards
1202 List supported standards and exit.
1204 Available values are:
1207 Show all supported standards.
1210 @item timestamps, ts
1211 Set type of timestamps for grabbed frames.
1213 Available values are:
1216 Use timestamps from the kernel.
1219 Use absolute timestamps (wall clock).
1222 Force conversion from monotonic to absolute timestamps.
1225 Default value is @code{default}.
1228 Use libv4l2 (v4l-utils) conversion functions. Default is 0.
1234 VfW (Video for Windows) capture input device.
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.
1245 Set the video frame size.
1248 Set the grabbing frame rate. Default value is @code{ntsc},
1249 corresponding to a frame rate of @code{30000/1001}.
1255 X11 video input device.
1257 To enable this input device during configuration you need libxcb
1258 installed on your system. It will be automatically detected during
1261 Alternatively, the configure option @option{--enable-x11grab} exists
1262 for legacy Xlib users.
1264 This device allows one to capture a region of an X11 display.
1266 The filename passed as input has the syntax:
1268 [@var{hostname}]:@var{display_number}.@var{screen_number}[+@var{x_offset},@var{y_offset}]
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.
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
1280 Check the X11 documentation (e.g. @command{man X}) for more detailed
1283 Use the @command{xdpyinfo} program for getting basic information about
1284 the properties of your X11 display (e.g. grep for "name" or
1287 For example to grab from @file{:0.0} using @command{ffmpeg}:
1289 ffmpeg -f x11grab -framerate 25 -video_size cif -i :0.0 out.mpg
1292 Grab at position @code{10,20}:
1294 ffmpeg -f x11grab -framerate 25 -video_size cif -i :0.0+10,20 out.mpg
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}.
1305 Make the grabbed area follow the mouse. The argument can be
1306 @code{centered} or a number of pixels @var{PIXELS}.
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.
1315 ffmpeg -f x11grab -follow_mouse centered -framerate 25 -video_size cif -i :0.0 out.mpg
1318 To follow only when the mouse pointer reaches within 100 pixels to edge:
1320 ffmpeg -f x11grab -follow_mouse 100 -framerate 25 -video_size cif -i :0.0 out.mpg
1324 Set the grabbing frame rate. Default value is @code{ntsc},
1325 corresponding to a frame rate of @code{30000/1001}.
1328 Show grabbed region on screen.
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.
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).
1340 ffmpeg -f x11grab -show_region 1 -framerate 25 -video_size cif -i :0.0+10,20 out.mpg
1343 With @var{follow_mouse}:
1345 ffmpeg -f x11grab -follow_mouse centered -show_region 1 -framerate 25 -video_size cif -i :0.0 out.mpg
1349 Set the video frame size. Default value is @code{vga}.
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
1358 Set the grabbing region coordinates. They are expressed as offset from
1359 the top left corner of the X11 window and correspond to the
1360 @var{x_offset} and @var{y_offset} parameters in the device name. The
1361 default value for both options is 0.
1364 @c man end INPUT DEVICES