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