indevs.texi 42.5 KB
Newer Older
1
@chapter Input Devices
2 3
@c man begin INPUT DEVICES

4
Input devices are configured elements in FFmpeg which enable accessing
5 6
the data coming from a multimedia device attached to your system.

7
When you configure your FFmpeg build, all the supported input devices
8 9
are enabled by default. You can list all available ones using the
configure option "--list-indevs".
10 11 12 13 14 15

You can disable all the input devices using the configure option
"--disable-indevs", and selectively enable an input device using the
option "--enable-indev=@var{INDEV}", or you can disable a particular
input device using the option "--disable-indev=@var{INDEV}".

16 17
The option "-devices" of the ff* tools will display the list of
supported input devices.
18 19 20 21 22 23 24 25 26 27

A description of the currently available input devices follows.

@section alsa

ALSA (Advanced Linux Sound Architecture) input device.

To enable this input device during configuration you need libasound
installed on your system.

28
This device allows capturing from an ALSA device. The name of the
29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44
device to capture has to be an ALSA card identifier.

An ALSA identifier has the syntax:
@example
hw:@var{CARD}[,@var{DEV}[,@var{SUBDEV}]]
@end example

where the @var{DEV} and @var{SUBDEV} components are optional.

The three arguments (in order: @var{CARD},@var{DEV},@var{SUBDEV})
specify card number or identifier, device number and subdevice number
(-1 means any).

To see the list of cards currently recognized by your system check the
files @file{/proc/asound/cards} and @file{/proc/asound/devices}.

45
For example to capture with @command{ffmpeg} from an ALSA device with
46 47 48 49 50 51 52 53
card id 0, you may run the command:
@example
ffmpeg -f alsa -i hw:0 alsaout.wav
@end example

For more information see:
@url{http://www.alsa-project.org/alsa-doc/alsa-lib/pcm.html}

54 55 56 57 58 59 60 61 62 63 64 65
@subsection Options

@table @option

@item sample_rate
Set the sample rate in Hz. Default is 48000.

@item channels
Set the number of channels. Default is 2.

@end table

66 67 68 69 70 71
@section avfoundation

AVFoundation input device.

AVFoundation is the currently recommended framework by Apple for streamgrabbing on OSX >= 10.7 as well as on iOS.

72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99
The input filename has to be given in the following syntax:
@example
-i "[[VIDEO]:[AUDIO]]"
@end example
The first entry selects the video input while the latter selects the audio input.
The stream has to be specified by the device name or the device index as shown by the device list.
Alternatively, the video and/or audio input device can be chosen by index using the
@option{
    -video_device_index <INDEX>
}
and/or
@option{
    -audio_device_index <INDEX>
}
, overriding any
device name or index given in the input filename.

All available devices can be enumerated by using @option{-list_devices true}, listing
all device names and corresponding indices.

There are two device name aliases:
@table @code

@item default
Select the AVFoundation default device of the corresponding type.

@item none
Do not record the corresponding media type.
100
This is equivalent to specifying an empty device name or index.
101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122

@end table

@subsection Options

AVFoundation supports the following options:

@table @option

@item -list_devices <TRUE|FALSE>
If set to true, a list of all available input devices is given showing all
device names and indices.

@item -video_device_index <INDEX>
Specify the video device by its index. Overrides anything given in the input filename.

@item -audio_device_index <INDEX>
Specify the audio device by its index. Overrides anything given in the input filename.

@item -pixel_format <FORMAT>
Request the video device to use a specific pixel format.
If the specified format is not supported, a list of available formats is given
Timothy Gu's avatar
Timothy Gu committed
123
and the first one in this list is used instead. Available pixel formats are:
124
@code{monob, rgb555be, rgb555le, rgb565be, rgb565le, rgb24, bgr24, 0rgb, bgr0, 0bgr, rgb0,
125
 bgr48be, uyvy422, yuva444p, yuva444p16le, yuv444p, yuv422p16, yuv422p10, yuv444p10,
126
 yuv420p, nv12, yuyv422, gray}
127

128 129 130 131 132 133 134 135 136 137 138 139 140
@item -framerate
Set the grabbing frame rate. Default is @code{ntsc}, corresponding to a
frame rate of @code{30000/1001}.

@item -video_size
Set the video frame size.

@item -capture_cursor
Capture the mouse pointer. Default is 0.

@item -capture_mouse_clicks
Capture the screen mouse clicks. Default is 0.

141 142 143 144 145 146 147 148
@end table

@subsection Examples

@itemize

@item
Print the list of AVFoundation supported devices and exit:
149
@example
150
$ ffmpeg -f avfoundation -list_devices true -i ""
151 152
@end example

153 154
@item
Record video from video device 0 and audio from audio device 0 into out.avi:
155
@example
156
$ ffmpeg -f avfoundation -i "0:0" out.avi
157 158
@end example

159 160
@item
Record video from video device 2 and audio from audio device 1 into out.avi:
161
@example
162
$ ffmpeg -f avfoundation -video_device_index 2 -i ":1" out.avi
163 164
@end example

165 166
@item
Record video from the system default video device using the pixel format bgr0 and do not record any audio into out.avi:
167
@example
168
$ ffmpeg -f avfoundation -pixel_format bgr0 -i "default:none" out.avi
169 170
@end example

171 172
@end itemize

173 174 175 176
@section bktr

BSD video input device.

177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206
@subsection Options

@table @option

@item framerate
Set the frame rate.

@item video_size
Set the video frame size. Default is @code{vga}.

@item standard

Available values are:
@table @samp
@item pal

@item ntsc

@item secam

@item paln

@item palm

@item ntscj

@end table

@end table

207 208 209 210 211 212 213 214 215 216
@section decklink

The decklink input device provides capture capabilities for Blackmagic
DeckLink devices.

To enable this input device, you need the Blackmagic DeckLink SDK and you
need to configure with the appropriate @code{--extra-cflags}
and @code{--extra-ldflags}.
On Windows, you need to run the IDL files through @command{widl}.

217 218 219
DeckLink is very picky about the formats it supports. Pixel format of the
input can be set with @option{raw_format}.
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 222
of channels can be 2, 8 or 16. Note that all audio channels are bundled in one single
audio track.
223 224 225 226 227 228 229 230 231 232 233 234 235

@subsection Options

@table @option

@item list_devices
If set to @option{true}, print a list of devices and exit.
Defaults to @option{false}.

@item list_formats
If set to @option{true}, print a list of supported formats and exit.
Defaults to @option{false}.

236 237 238 239 240 241
@item format_code <FourCC>
This sets the input video format to the format given by the FourCC. To see
the supported values of your device(s) use @option{list_formats}.
Note that there is a FourCC @option{'pal '} that can also be used
as @option{pal} (3 letters).

242
@item bm_v210
243
This is a deprecated option, you can use @option{raw_format} instead.
244 245 246
If set to @samp{1}, video is captured in 10 bit v210 instead
of uyvy422. Not all Blackmagic devices support this option.

247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262
@item raw_format
Set the pixel format of the captured video.
Available values are:
@table @samp
@item uyvy422

@item yuv422p10

@item argb

@item bgra

@item rgb10

@end table

263 264
@item teletext_lines
If set to nonzero, an additional teletext stream will be captured from the
265 266 267 268 269 270 271 272 273 274 275 276 277
vertical ancillary data. Both SD PAL (576i) and HD (1080i or 1080p)
sources are supported. In case of HD sources, OP47 packets are decoded.

This option is a bitmask of the SD PAL VBI lines captured, specifically lines 6
to 22, and lines 318 to 335. Line 6 is the LSB in the mask. Selected lines
which do not contain teletext information will be ignored. You can use the
special @option{all} constant to select all possible lines, or
@option{standard} to skip lines 6, 318 and 319, which are not compatible with
all receivers.

For SD sources, ffmpeg needs to be compiled with @code{--enable-libzvbi}. For
HD sources, on older (pre-4K) DeckLink card models you have to capture in 10
bit mode.
278

279 280 281 282
@item channels
Defines number of audio channels to capture. Must be @samp{2}, @samp{8} or @samp{16}.
Defaults to @samp{2}.

283 284 285 286
@item duplex_mode
Sets the decklink device duplex mode. Must be @samp{unset}, @samp{half} or @samp{full}.
Defaults to @samp{unset}.

287 288 289 290 291 292 293 294 295 296
@item video_input
Sets the video input source. Must be @samp{unset}, @samp{sdi}, @samp{hdmi},
@samp{optical_sdi}, @samp{component}, @samp{composite} or @samp{s_video}.
Defaults to @samp{unset}.

@item audio_input
Sets the audio input source. Must be @samp{unset}, @samp{embedded},
@samp{aes_ebu}, @samp{analog}, @samp{analog_xlr}, @samp{analog_rca} or
@samp{microphone}. Defaults to @samp{unset}.

297 298 299 300 301 302 303 304
@item video_pts
Sets the video packet timestamp source. Must be @samp{video}, @samp{audio},
@samp{reference} or @samp{wallclock}. Defaults to @samp{video}.

@item audio_pts
Sets the audio packet timestamp source. Must be @samp{video}, @samp{audio},
@samp{reference} or @samp{wallclock}. Defaults to @samp{audio}.

305 306 307 308
@item draw_bars
If set to @samp{true}, color bars are drawn in the event of a signal loss.
Defaults to @samp{true}.

309 310 311 312 313
@item queue_size
Sets maximum input buffer size in bytes. If the buffering reaches this value,
incoming frames will be dropped.
Defaults to @samp{1073741824}.

314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332
@end table

@subsection Examples

@itemize

@item
List input devices:
@example
ffmpeg -f decklink -list_devices 1 -i dummy
@end example

@item
List supported formats:
@example
ffmpeg -f decklink -list_formats 1 -i 'Intensity Pro'
@end example

@item
333
Capture video clip at 1080i50:
334
@example
335
ffmpeg -format_code Hi50 -f decklink -i 'Intensity Pro' -acodec copy -vcodec copy output.avi
336 337 338 339 340
@end example

@item
Capture video clip at 1080i50 10 bit:
@example
341
ffmpeg -bm_v210 1 -format_code Hi50 -f decklink -i 'UltraStudio Mini Recorder' -acodec copy -vcodec copy output.avi
342 343
@end example

344 345 346
@item
Capture video clip at 1080i50 with 16 audio channels:
@example
347
ffmpeg -channels 16 -format_code Hi50 -f decklink -i 'UltraStudio Mini Recorder' -acodec copy -vcodec copy output.avi
348 349
@end example

350 351
@end itemize

352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413
@section kmsgrab

KMS video input device.

Captures the KMS scanout framebuffer associated with a specified CRTC or plane as a
DRM object that can be passed to other hardware functions.

Requires either DRM master or CAP_SYS_ADMIN to run.

If you don't understand what all of that means, you probably don't want this.  Look at
@option{x11grab} instead.

@subsection Options

@table @option

@item device
DRM device to capture on.  Defaults to @option{/dev/dri/card0}.

@item format
Pixel format of the framebuffer.  Defaults to @option{bgr0}.

@item format_modifier
Format modifier to signal on output frames.  This is necessary to import correctly into
some APIs, but can't be autodetected.  See the libdrm documentation for possible values.

@item crtc_id
KMS CRTC ID to define the capture source.  The first active plane on the given CRTC
will be used.

@item plane_id
KMS plane ID to define the capture source.  Defaults to the first active plane found if
neither @option{crtc_id} nor @option{plane_id} are specified.

@item framerate
Framerate to capture at.  This is not synchronised to any page flipping or framebuffer
changes - it just defines the interval at which the framebuffer is sampled.  Sampling
faster than the framebuffer update rate will generate independent frames with the same
content.  Defaults to @code{30}.

@end table

@subsection Examples

@itemize

@item
Capture from the first active plane, download the result to normal frames and encode.
This will only work if the framebuffer is both linear and mappable - if not, the result
may be scrambled or fail to download.
@example
ffmpeg -f kmsgrab -i - -vf 'hwdownload,format=bgr0' output.mp4
@end example

@item
Capture from CRTC ID 42 at 60fps, map the result to VAAPI, convert to NV12 and encode as H.264.
@example
ffmpeg -crtc_id 42 -framerate 60 -f kmsgrab -i - -vf 'hwmap=derive_device=vaapi,scale_vaapi=w=1920:h=1080:format=nv12' -c:v h264_vaapi output.mp4
@end example

@end itemize

414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461
@section libndi_newtek

The libndi_newtek input device provides capture capabilities for using NDI (Network
Device Interface, standard created by NewTek).

Input filename is a NDI source name that could be found by sending -find_sources 1
to command line - it has no specific syntax but human-readable formatted.

To enable this input device, you need the NDI SDK and you
need to configure with the appropriate @code{--extra-cflags}
and @code{--extra-ldflags}.

@subsection Options

@table @option

@item find_sources
If set to @option{true}, print a list of found/available NDI sources and exit.
Defaults to @option{false}.

@item wait_sources
Override time to wait until the number of online sources have changed.
Defaults to @option{0.5}.

@item allow_video_fields
When this flag is @option{false}, all video that you receive will be progressive.
Defaults to @option{true}.

@end table

@subsection Examples

@itemize

@item
List input devices:
@example
ffmpeg -f libndi_newtek -find_sources 1 -i dummy
@end example

@item
Restream to NDI:
@example
ffmpeg -f libndi_newtek -i "DEV-5.INTERNAL.M1STEREO.TV (NDI_SOURCE_NAME_1)" -f libndi_newtek -y NDI_SOURCE_NAME_2
@end example

@end itemize

462 463 464 465
@section dshow

Windows DirectShow input device.

466
DirectShow support is enabled when FFmpeg is built with the mingw-w64 project.
467 468 469 470 471 472 473 474 475 476 477 478
Currently only audio and video devices are supported.

Multiple devices may be opened as separate inputs, but they may also be
opened on the same input, which should improve synchronism between them.

The input name should be in the format:

@example
@var{TYPE}=@var{NAME}[:@var{TYPE}=@var{NAME}]
@end example

where @var{TYPE} can be either @var{audio} or @var{video},
479
and @var{NAME} is the device's name or alternative name..
480 481 482 483 484 485 486 487 488 489 490 491 492

@subsection Options

If no options are specified, the device's defaults are used.
If the device does not support the requested options, it will
fail to open.

@table @option

@item video_size
Set the video size in the captured video.

@item framerate
493
Set the frame rate in the captured video.
494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510

@item sample_rate
Set the sample rate (in Hz) of the captured audio.

@item sample_size
Set the sample size (in bits) of the captured audio.

@item channels
Set the number of channels in the captured audio.

@item list_devices
If set to @option{true}, print a list of devices and exit.

@item list_options
If set to @option{true}, print a list of selected device's options
and exit.

511
@item video_device_number
512
Set video device number for devices with the same name (starts at 0,
513 514 515
defaults to 0).

@item audio_device_number
516
Set audio device number for devices with the same name (starts at 0,
517 518
defaults to 0).

519 520 521 522
@item pixel_format
Select pixel format to be used by DirectShow. This may only be set when
the video codec is not set or set to rawvideo.

523 524 525 526 527 528 529 530 531
@item audio_buffer_size
Set audio device buffer size in milliseconds (which can directly
impact latency, depending on the device).
Defaults to using the audio device's
default buffer size (typically some multiple of 500ms).
Setting this value too low can degrade performance.
See also
@url{http://msdn.microsoft.com/en-us/library/windows/desktop/dd377582(v=vs.85).aspx}

532 533 534 535 536 537
@item video_pin_name
Select video capture pin to use by name or alternative name.

@item audio_pin_name
Select audio capture pin to use by name or alternative name.

538 539 540
@item crossbar_video_input_pin_number
Select video input pin number for crossbar device. This will be
routed to the crossbar device's Video Decoder output pin.
541 542
Note that changing this value can affect future invocations
(sets a new default) until system reboot occurs.
543 544 545 546

@item crossbar_audio_input_pin_number
Select audio input pin number for crossbar device. This will be
routed to the crossbar device's Audio Decoder output pin.
547 548
Note that changing this value can affect future invocations
(sets a new default) until system reboot occurs.
549

550 551 552 553
@item show_video_device_dialog
If set to @option{true}, before capture starts, popup a display dialog
to the end user, allowing them to change video filter properties
and configurations manually.
554 555 556 557 558 559 560
Note that for crossbar devices, adjusting values in this dialog
may be needed at times to toggle between PAL (25 fps) and NTSC (29.97)
input frame rates, sizes, interlacing, etc.  Changing these values can
enable different scan rates/frame rates and avoiding green bars at
the bottom, flickering scan lines, etc.
Note that with some devices, changing these properties can also affect future
invocations (sets new defaults) until system reboot occurs.
561 562 563 564 565 566

@item show_audio_device_dialog
If set to @option{true}, before capture starts, popup a display dialog
to the end user, allowing them to change audio filter properties
and configurations manually.

567
@item show_video_crossbar_connection_dialog
568 569
If set to @option{true}, before capture starts, popup a display
dialog to the end user, allowing them to manually
570 571 572 573 574 575
modify crossbar pin routings, when it opens a video device.

@item show_audio_crossbar_connection_dialog
If set to @option{true}, before capture starts, popup a display
dialog to the end user, allowing them to manually
modify crossbar pin routings, when it opens an audio device.
576

577 578 579 580 581 582 583 584 585 586
@item show_analog_tv_tuner_dialog
If set to @option{true}, before capture starts, popup a display
dialog to the end user, allowing them to manually
modify TV channels and frequencies.

@item show_analog_tv_tuner_audio_dialog
If set to @option{true}, before capture starts, popup a display
dialog to the end user, allowing them to manually
modify TV audio (like mono vs. stereo, Language A,B or C).

587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610
@item audio_device_load
Load an audio capture filter device from file instead of searching
it by name. It may load additional parameters too, if the filter
supports the serialization of its properties to.
To use this an audio capture source has to be specified, but it can
be anything even fake one.

@item audio_device_save
Save the currently used audio capture filter device and its
parameters (if the filter supports it) to a file.
If a file with the same name exists it will be overwritten.

@item video_device_load
Load a video capture filter device from file instead of searching
it by name. It may load additional parameters too, if the filter
supports the serialization of its properties to.
To use this a video capture source has to be specified, but it can
be anything even fake one.

@item video_device_save
Save the currently used video capture filter device and its
parameters (if the filter supports it) to a file.
If a file with the same name exists it will be overwritten.

611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628
@end table

@subsection Examples

@itemize

@item
Print the list of DirectShow supported devices and exit:
@example
$ ffmpeg -list_devices true -f dshow -i dummy
@end example

@item
Open video device @var{Camera}:
@example
$ ffmpeg -f dshow -i video="Camera"
@end example

629 630 631 632 633 634
@item
Open second video device with name @var{Camera}:
@example
$ ffmpeg -f dshow -video_device_number 1 -i video="Camera"
@end example

635 636 637 638 639 640 641 642 643 644 645 646
@item
Open video device @var{Camera} and audio device @var{Microphone}:
@example
$ ffmpeg -f dshow -i video="Camera":audio="Microphone"
@end example

@item
Print the list of supported options in selected device and exit:
@example
$ ffmpeg -list_options true -f dshow -i video="Camera"
@end example

647 648 649
@item
Specify pin names to capture by name or alternative name, specify alternative device name:
@example
rogerdpack's avatar
rogerdpack committed
650
$ 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"
651 652
@end example

653 654 655 656 657 658 659
@item
Configure a crossbar device, specifying crossbar pins, allow user to adjust video capture properties at startup:
@example
$ ffmpeg -f dshow -show_video_device_dialog true -crossbar_video_input_pin_number 0
     -crossbar_audio_input_pin_number 3 -i video="AVerMedia BDA Analog Capture":audio="AVerMedia BDA Analog Capture"
@end example

660 661
@end itemize

662 663 664 665 666 667 668 669 670 671 672 673
@section fbdev

Linux framebuffer input device.

The Linux framebuffer is a graphic hardware-independent abstraction
layer to show graphics on a computer monitor, typically on the
console. It is accessed through a file device node, usually
@file{/dev/fb0}.

For more detailed information read the file
Documentation/fb/framebuffer.txt included in the Linux source tree.

674 675
See also @url{http://linux-fbdev.sourceforge.net/}, and fbset(1).

676
To record from the framebuffer device @file{/dev/fb0} with
677
@command{ffmpeg}:
678
@example
679
ffmpeg -f fbdev -framerate 10 -i /dev/fb0 out.avi
680 681 682 683
@end example

You can take a single screenshot image with the command:
@example
684
ffmpeg -f fbdev -framerate 1 -i /dev/fb0 -frames:v 1 screenshot.jpeg
685 686
@end example

687 688 689 690 691 692 693 694
@subsection Options

@table @option

@item framerate
Set the frame rate. Default is 25.

@end table
695

696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770
@section gdigrab

Win32 GDI-based screen capture device.

This device allows you to capture a region of the display on Windows.

There are two options for the input filename:
@example
desktop
@end example
or
@example
title=@var{window_title}
@end example

The first option will capture the entire desktop, or a fixed region of the
desktop. The second option will instead capture the contents of a single
window, regardless of its position on the screen.

For example, to grab the entire desktop using @command{ffmpeg}:
@example
ffmpeg -f gdigrab -framerate 6 -i desktop out.mpg
@end example

Grab a 640x480 region at position @code{10,20}:
@example
ffmpeg -f gdigrab -framerate 6 -offset_x 10 -offset_y 20 -video_size vga -i desktop out.mpg
@end example

Grab the contents of the window named "Calculator"
@example
ffmpeg -f gdigrab -framerate 6 -i title=Calculator out.mpg
@end example

@subsection Options

@table @option
@item draw_mouse
Specify whether to draw the mouse pointer. Use the value @code{0} to
not draw the pointer. Default value is @code{1}.

@item framerate
Set the grabbing frame rate. Default value is @code{ntsc},
corresponding to a frame rate of @code{30000/1001}.

@item show_region
Show grabbed region on screen.

If @var{show_region} is specified with @code{1}, then the grabbing
region will be indicated on screen. With this option, it is easy to
know what is being grabbed if only a portion of the screen is grabbed.

Note that @var{show_region} is incompatible with grabbing the contents
of a single window.

For example:
@example
ffmpeg -f gdigrab -show_region 1 -framerate 6 -video_size cif -offset_x 10 -offset_y 20 -i desktop out.mpg
@end example

@item video_size
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.

@item offset_x
When capturing a region with @var{video_size}, set the distance from the left edge of the screen or desktop.

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.

@item offset_y
When capturing a region with @var{video_size}, set the distance from the top edge of the screen or desktop.

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.

@end table

771 772 773 774
@section iec61883

FireWire DV/HDV input device using libiec61883.

775 776 777 778
To enable this input device, you need libiec61883, libraw1394 and
libavc1394 installed on your system. Use the configure option
@code{--enable-libiec61883} to compile with the device enabled.

779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798
The iec61883 capture device supports capturing from a video device
connected via IEEE1394 (FireWire), using libiec61883 and the new Linux
FireWire stack (juju). This is the default DV/HDV input method in Linux
Kernel 2.6.37 and later, since the old FireWire stack was removed.

Specify the FireWire port to be used as input file, or "auto"
to choose the first port connected.

@subsection Options

@table @option

@item dvtype
Override autodetection of DV/HDV. This should only be used if auto
detection does not work, or if usage of a different device type
should be prohibited. Treating a DV device as HDV (or vice versa) will
not work and result in undefined behavior.
The values @option{auto}, @option{dv} and @option{hdv} are supported.

@item dvbuffer
Lou Logan's avatar
Lou Logan committed
799
Set maximum size of buffer for incoming data, in frames. For DV, this
800 801 802
is an exact value. For HDV, it is not frame exact, since HDV does
not have a fixed frame size.

803
@item dvguid
804
Select the capture device by specifying its GUID. Capturing will only
805 806 807 808 809
be performed from the specified device and fails if no device with the
given GUID is found. This is useful to select the input if multiple
devices are connected at the same time.
Look at /sys/bus/firewire/devices to find out the GUIDs.

810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830
@end table

@subsection Examples

@itemize

@item
Grab and show the input of a FireWire DV/HDV device.
@example
ffplay -f iec61883 -i auto
@end example

@item
Grab and record the input of a FireWire DV/HDV device,
using a packet buffer of 100000 packets if the source is HDV.
@example
ffmpeg -f iec61883 -i auto -hdvbuffer 100000 out.mpg
@end example

@end itemize

831 832
@section jack

833
JACK input device.
834 835 836 837

To enable this input device during configuration you need libjack
installed on your system.

838
A JACK input device creates one or more JACK writable clients, one for
839 840 841
each audio channel, with name @var{client_name}:input_@var{N}, where
@var{client_name} is the name provided by the application, and @var{N}
is a number which identifies the channel.
842
Each writable client will send the acquired data to the FFmpeg input
843 844
device.

845 846
Once you have created one or more JACK readable clients, you need to
connect them to one or more JACK writable clients.
847

848 849 850
To connect or disconnect JACK clients you can use the @command{jack_connect}
and @command{jack_disconnect} programs, or do it through a graphical interface,
for example with @command{qjackctl}.
851

852
To list the JACK clients and their properties you can invoke the command
853
@command{jack_lsp}.
854

855
Follows an example which shows how to capture a JACK readable client
856
with @command{ffmpeg}.
857
@example
858
# Create a JACK writable client with name "ffmpeg".
859 860
$ ffmpeg -f jack -i ffmpeg -y out.wav

861
# Start the sample jack_metro readable client.
862 863
$ jack_metro -b 120 -d 0.2 -f 4000

864
# List the current JACK clients.
865 866 867 868 869 870 871 872
$ jack_lsp -c
system:capture_1
system:capture_2
system:playback_1
system:playback_2
ffmpeg:input_1
metro:120_bpm

873
# Connect metro to the ffmpeg writable client.
874 875 876 877 878 879
$ jack_connect metro:120_bpm ffmpeg:input_1
@end example

For more information read:
@url{http://jackaudio.org/}

880 881 882 883 884 885 886 887 888
@subsection Options

@table @option

@item channels
Set the number of channels. Default is 2.

@end table

889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910
@section lavfi

Libavfilter input virtual device.

This input device reads data from the open output pads of a libavfilter
filtergraph.

For each filtergraph open output, the input device will create a
corresponding stream which is mapped to the generated output. Currently
only video data is supported. The filtergraph is specified through the
option @option{graph}.

@subsection Options

@table @option

@item graph
Specify the filtergraph to use as input. Each video open output must be
labelled by a unique string of the form "out@var{N}", where @var{N} is a
number starting from 0 corresponding to the mapped input stream
generated by the device.
The first unlabelled output is automatically assigned to the "out0"
911
label, but all the others need to be specified explicitly.
912

913 914 915 916 917 918 919 920
The suffix "+subcc" can be appended to the output label to create an extra
stream with the closed captions packets attached to that output
(experimental; only for EIA-608 / CEA-708 for now).
The subcc streams are created after all the normal streams, in the order of
the corresponding stream.
For example, if there is "out19+subcc", "out7+subcc" and up to "out42", the
stream #43 is subcc for stream #7 and stream #44 is subcc for stream #19.

921 922
If not specified defaults to the filename specified for the input
device.
923 924 925 926 927 928

@item graph_file
Set the filename of the filtergraph to be read and sent to the other
filters. Syntax of the filtergraph is the same as the one specified by
the option @var{graph}.

929 930 931
@item dumpgraph
Dump graph to stderr.

932 933 934 935 936 937
@end table

@subsection Examples

@itemize
@item
938
Create a color video stream and play it back with @command{ffplay}:
939
@example
940
ffplay -f lavfi -graph "color=c=pink [out0]" dummy
941 942 943 944 945 946
@end example

@item
As the previous example, but use filename for specifying the graph
description, and omit the "out0" label:
@example
947
ffplay -f lavfi color=c=pink
948 949 950 951 952 953 954
@end example

@item
Create three different video test filtered sources and play them:
@example
ffplay -f lavfi -graph "testsrc [out0]; testsrc,hflip [out1]; testsrc,negate [out2]" test3
@end example
955 956 957

@item
Read an audio stream from a file using the amovie source and play it
958
back with @command{ffplay}:
959 960 961 962 963 964
@example
ffplay -f lavfi "amovie=test.wav"
@end example

@item
Read an audio stream and a video stream and play it back with
965
@command{ffplay}:
966 967 968 969
@example
ffplay -f lavfi "movie=test.avi[out0];amovie=test.wav[out1]"
@end example

970 971 972 973 974 975
@item
Dump decoded frames to images and closed captions to a file (experimental):
@example
ffmpeg -f lavfi -i "movie=test.ts[out0+subcc]" -map v frame%08d.png -map s -c copy -f rawvideo subcc.bin
@end example

976 977
@end itemize

978 979
@section libcdio

980
Audio-CD input device based on libcdio.
981 982

To enable this input device during configuration you need libcdio
983
installed on your system. It requires the configure option
984
@code{--enable-libcdio}.
985 986 987

This device allows playing and grabbing from an Audio-CD.

988
For example to copy with @command{ffmpeg} the entire Audio-CD in @file{/dev/sr0},
989 990 991 992 993
you may run the command:
@example
ffmpeg -f libcdio -i /dev/sr0 cd.wav
@end example

994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020
@subsection Options
@table @option
@item speed
Set drive reading speed. Default value is 0.

The speed is specified CD-ROM speed units. The speed is set through
the libcdio @code{cdio_cddap_speed_set} function. On many CD-ROM
drives, specifying a value too large will result in using the fastest
speed.

@item paranoia_mode
Set paranoia recovery mode flags. It accepts one of the following values:

@table @samp
@item disable
@item verify
@item overlap
@item neverskip
@item full
@end table

Default value is @samp{disable}.

For more information about the available recovery modes, consult the
paranoia project documentation.
@end table

1021 1022 1023 1024
@section libdc1394

IIDC1394 input device, based on libdc1394 and libraw1394.

1025 1026
Requires the configure option @code{--enable-libdc1394}.

1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058
@section openal

The OpenAL input device provides audio capture on all systems with a
working OpenAL 1.1 implementation.

To enable this input device during configuration, you need OpenAL
headers and libraries installed on your system, and need to configure
FFmpeg with @code{--enable-openal}.

OpenAL headers and libraries should be provided as part of your OpenAL
implementation, or as an additional download (an SDK). Depending on your
installation you may need to specify additional flags via the
@code{--extra-cflags} and @code{--extra-ldflags} for allowing the build
system to locate the OpenAL headers and libraries.

An incomplete list of OpenAL implementations follows:

@table @strong
@item Creative
The official Windows implementation, providing hardware acceleration
with supported devices and software fallback.
See @url{http://openal.org/}.
@item OpenAL Soft
Portable, open source (LGPL) software implementation. Includes
backends for the most common sound APIs on the Windows, Linux,
Solaris, and BSD operating systems.
See @url{http://kcat.strangesoft.net/openal.html}.
@item Apple
OpenAL is part of Core Audio, the official Mac OS X Audio interface.
See @url{http://developer.apple.com/technologies/mac/audio-and-video.html}
@end table

1059
This device allows one to capture from an audio input device handled
1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108
through OpenAL.

You need to specify the name of the device to capture in the provided
filename. If the empty string is provided, the device will
automatically select the default device. You can get the list of the
supported devices by using the option @var{list_devices}.

@subsection Options

@table @option

@item channels
Set the number of channels in the captured audio. Only the values
@option{1} (monaural) and @option{2} (stereo) are currently supported.
Defaults to @option{2}.

@item sample_size
Set the sample size (in bits) of the captured audio. Only the values
@option{8} and @option{16} are currently supported. Defaults to
@option{16}.

@item sample_rate
Set the sample rate (in Hz) of the captured audio.
Defaults to @option{44.1k}.

@item list_devices
If set to @option{true}, print a list of devices and exit.
Defaults to @option{false}.

@end table

@subsection Examples

Print the list of OpenAL supported devices and exit:
@example
$ ffmpeg -list_devices true -f openal -i dummy out.ogg
@end example

Capture from the OpenAL device @file{DR-BT101 via PulseAudio}:
@example
$ ffmpeg -f openal -i 'DR-BT101 via PulseAudio' out.ogg
@end example

Capture from the default device (note the empty string '' as filename):
@example
$ ffmpeg -f openal -i '' out.ogg
@end example

Capture from two devices simultaneously, writing to two different files,
1109
within the same @command{ffmpeg} command:
1110 1111 1112 1113 1114 1115
@example
$ ffmpeg -f openal -i 'DR-BT101 via PulseAudio' out1.ogg -f openal -i 'ALSA Default' out2.ogg
@end example
Note: not all OpenAL implementations support multiple simultaneous capture -
try the latest OpenAL Soft if the above does not work.

1116 1117 1118 1119 1120 1121
@section oss

Open Sound System input device.

The filename to provide to the input device is the device node
representing the OSS input device, and is usually set to
1122
@file{/dev/dsp}.
1123

1124
For example to grab from @file{/dev/dsp} using @command{ffmpeg} use the
1125 1126 1127 1128 1129 1130 1131 1132
command:
@example
ffmpeg -f oss -i /dev/dsp /tmp/oss.wav
@end example

For more information about OSS see:
@url{http://manuals.opensound.com/usersguide/dsp.html}

1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145
@subsection Options

@table @option

@item sample_rate
Set the sample rate in Hz. Default is 48000.

@item channels
Set the number of channels. Default is 2.

@end table


Luca Barbato's avatar
Luca Barbato committed
1146 1147
@section pulse

1148
PulseAudio input device.
Luca Barbato's avatar
Luca Barbato committed
1149

1150
To enable this output device you need to configure FFmpeg with @code{--enable-libpulse}.
Luca Barbato's avatar
Luca Barbato committed
1151 1152 1153 1154

The filename to provide to the input device is a source device or the
string "default"

1155
To list the PulseAudio source devices and their properties you can invoke
1156
the command @command{pactl list sources}.
Luca Barbato's avatar
Luca Barbato committed
1157

1158 1159
More information about PulseAudio can be found on @url{http://www.pulseaudio.org}.

1160 1161 1162
@subsection Options
@table @option
@item server
1163 1164
Connect to a specific PulseAudio server, specified by an IP address.
Default server is used when not provided.
Luca Barbato's avatar
Luca Barbato committed
1165

1166 1167 1168
@item name
Specify the application name PulseAudio will use when showing active clients,
by default it is the @code{LIBAVFORMAT_IDENT} string.
Luca Barbato's avatar
Luca Barbato committed
1169

1170 1171 1172
@item stream_name
Specify the stream name PulseAudio will use when showing active streams,
by default it is "record".
Luca Barbato's avatar
Luca Barbato committed
1173

1174
@item sample_rate
Luca Barbato's avatar
Luca Barbato committed
1175 1176
Specify the samplerate in Hz, by default 48kHz is used.

1177
@item channels
Luca Barbato's avatar
Luca Barbato committed
1178 1179
Specify the channels in use, by default 2 (stereo) is set.

1180 1181
@item frame_size
Specify the number of bytes per frame, by default it is set to 1024.
Luca Barbato's avatar
Luca Barbato committed
1182

1183 1184 1185
@item fragment_size
Specify the minimal buffering fragment in PulseAudio, it will affect the
audio latency. By default it is unset.
1186 1187 1188 1189

@item wallclock
Set the initial PTS using the current time. Default is 1.

1190
@end table
Luca Barbato's avatar
Luca Barbato committed
1191

1192 1193
@subsection Examples
Record a stream from default device:
Luca Barbato's avatar
Luca Barbato committed
1194
@example
1195
ffmpeg -f pulse -i default /tmp/pulse.wav
Luca Barbato's avatar
Luca Barbato committed
1196 1197
@end example

1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208
@section sndio

sndio input device.

To enable this input device during configuration you need libsndio
installed on your system.

The filename to provide to the input device is the device node
representing the sndio input device, and is usually set to
@file{/dev/audio0}.

1209
For example to grab from @file{/dev/audio0} using @command{ffmpeg} use the
1210 1211 1212 1213 1214
command:
@example
ffmpeg -f sndio -i /dev/audio0 /tmp/oss.wav
@end example

1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226
@subsection Options

@table @option

@item sample_rate
Set the sample rate in Hz. Default is 48000.

@item channels
Set the number of channels. Default is 2.

@end table

1227
@section video4linux2, v4l2
1228

1229
Video4Linux2 input video device.
1230

1231 1232 1233
"v4l2" can be used as alias for "video4linux2".

If FFmpeg is built with v4l-utils support (by using the
1234 1235
@code{--enable-libv4l2} configure option), it is possible to use it with the
@code{-use_libv4l2} input device option.
1236

1237 1238
The name of the device to grab is a file device node, usually Linux
systems tend to automatically create such nodes when the device
1239
(e.g. an USB webcam) is plugged into the system, and has a name of the
1240 1241 1242
kind @file{/dev/video@var{N}}, where @var{N} is a number associated to
the device.

1243
Video4Linux2 devices usually support a limited set of
1244
@var{width}x@var{height} sizes and frame rates. You can check which are
1245
supported using @command{-list_formats all} for Video4Linux2 devices.
1246 1247
Some devices, like TV cards, support one or more standards. It is possible
to list all the supported standards using @command{-list_standards all}.
1248

1249 1250 1251 1252 1253 1254 1255
The time base for the timestamps is 1 microsecond. Depending on the kernel
version and configuration, the timestamps may be derived from the real time
clock (origin at the Unix Epoch) or the monotonic clock (origin usually at
boot time, unaffected by NTP or manual changes to the clock). The
@option{-timestamps abs} or @option{-ts abs} option can be used to force
conversion into the real time clock.

1256
Some usage examples of the video4linux2 device with @command{ffmpeg}
1257
and @command{ffplay}:
1258
@itemize
1259 1260 1261 1262 1263
@item
List supported formats for a video4linux2 device:
@example
ffplay -f video4linux2 -list_formats all /dev/video0
@end example
1264

1265 1266
@item
Grab and show the input of a video4linux2 device:
1267
@example
1268
ffplay -f video4linux2 -framerate 30 -video_size hd720 /dev/video0
1269
@end example
1270

1271 1272
@item
Grab and record the input of a video4linux2 device, leave the
1273
frame rate and size as previously set:
1274
@example
1275
ffmpeg -f video4linux2 -input_format mjpeg -i /dev/video0 out.mpeg
1276
@end example
1277
@end itemize
1278

1279
For more information about Video4Linux, check @url{http://linuxtv.org/}.
1280

1281 1282 1283 1284 1285 1286 1287 1288 1289
@subsection Options

@table @option
@item standard
Set the standard. Must be the name of a supported standard. To get a
list of the supported standards, use the @option{list_standards}
option.

@item channel
1290 1291
Set the input channel number. Default to -1, which means using the
previously selected channel.
1292 1293 1294 1295 1296 1297 1298 1299 1300 1301

@item video_size
Set the video frame size. The argument must be a string in the form
@var{WIDTH}x@var{HEIGHT} or a valid size abbreviation.

@item pixel_format
Select the pixel format (only valid for raw video input).

@item input_format
Set the preferred pixel format (for raw video) or a codec name.
1302
This option allows one to select the input format, when several are
1303 1304 1305
available.

@item framerate
1306
Set the preferred video frame rate.
1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344

@item list_formats
List available formats (supported pixel formats, codecs, and frame
sizes) and exit.

Available values are:
@table @samp
@item all
Show all available (compressed and non-compressed) formats.

@item raw
Show only raw video (non-compressed) formats.

@item compressed
Show only compressed formats.
@end table

@item list_standards
List supported standards and exit.

Available values are:
@table @samp
@item all
Show all supported standards.
@end table

@item timestamps, ts
Set type of timestamps for grabbed frames.

Available values are:
@table @samp
@item default
Use timestamps from the kernel.

@item abs
Use absolute timestamps (wall clock).

@item mono2abs
1345
Force conversion from monotonic to absolute timestamps.
1346 1347 1348
@end table

Default value is @code{default}.
1349 1350 1351 1352

@item use_libv4l2
Use libv4l2 (v4l-utils) conversion functions. Default is 0.

1353 1354
@end table

1355 1356
@section vfwcap

Stefano Sabatini's avatar
Stefano Sabatini committed
1357
VfW (Video for Windows) capture input device.
1358

1359 1360 1361 1362
The filename passed as input is the capture driver number, ranging from
0 to 9. You may use "list" as filename to print a list of drivers. Any
other filename will be interpreted as device number 0.

1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375
@subsection Options

@table @option

@item video_size
Set the video frame size.

@item framerate
Set the grabbing frame rate. Default value is @code{ntsc},
corresponding to a frame rate of @code{30000/1001}.

@end table

1376 1377 1378 1379
@section x11grab

X11 video input device.

1380 1381 1382 1383
To enable this input device during configuration you need libxcb
installed on your system. It will be automatically detected during
configuration.

1384
This device allows one to capture a region of an X11 display.
1385

1386
The filename passed as input has the syntax:
1387 1388 1389 1390 1391
@example
[@var{hostname}]:@var{display_number}.@var{screen_number}[+@var{x_offset},@var{y_offset}]
@end example

@var{hostname}:@var{display_number}.@var{screen_number} specifies the
1392
X11 display name of the screen to grab from. @var{hostname} can be
1393
omitted, and defaults to "localhost". The environment variable
1394 1395 1396
@env{DISPLAY} contains the default display name.

@var{x_offset} and @var{y_offset} specify the offsets of the grabbed
1397
area with respect to the top-left border of the X11 screen. They
1398 1399
default to 0.

1400 1401
Check the X11 documentation (e.g. @command{man X}) for more detailed
information.
1402

1403 1404 1405
Use the @command{xdpyinfo} program for getting basic information about
the properties of your X11 display (e.g. grep for "name" or
"dimensions").
1406

1407
For example to grab from @file{:0.0} using @command{ffmpeg}:
1408
@example
1409
ffmpeg -f x11grab -framerate 25 -video_size cif -i :0.0 out.mpg
1410
@end example
1411

1412 1413
Grab at position @code{10,20}:
@example
1414
ffmpeg -f x11grab -framerate 25 -video_size cif -i :0.0+10,20 out.mpg
1415 1416
@end example

1417
@subsection Options
1418

1419
@table @option
1420
@item draw_mouse
1421
Specify whether to draw the mouse pointer. A value of @code{0} specifies
1422 1423
not to draw the pointer. Default value is @code{1}.

1424 1425 1426
@item follow_mouse
Make the grabbed area follow the mouse. The argument can be
@code{centered} or a number of pixels @var{PIXELS}.
1427 1428 1429 1430 1431 1432 1433 1434

When it is specified with "centered", the grabbing region follows the mouse
pointer and keeps the pointer at the center of region; otherwise, the region
follows only when the mouse pointer reaches within @var{PIXELS} (greater than
zero) to the edge of region.

For example:
@example
1435
ffmpeg -f x11grab -follow_mouse centered -framerate 25 -video_size cif -i :0.0 out.mpg
1436 1437
@end example

1438
To follow only when the mouse pointer reaches within 100 pixels to edge:
1439
@example
1440
ffmpeg -f x11grab -follow_mouse 100 -framerate 25 -video_size cif -i :0.0 out.mpg
1441 1442
@end example

1443 1444
@item framerate
Set the grabbing frame rate. Default value is @code{ntsc},
1445
corresponding to a frame rate of @code{30000/1001}.
1446

1447 1448 1449 1450 1451 1452
@item show_region
Show grabbed region on screen.

If @var{show_region} is specified with @code{1}, then the grabbing
region will be indicated on screen. With this option, it is easy to
know what is being grabbed if only a portion of the screen is grabbed.
1453

1454 1455 1456 1457
@item region_border
Set the region border thickness if @option{-show_region 1} is used.
Range is 1 to 128 and default is 3 (XCB-based x11grab only).

1458 1459
For example:
@example
1460
ffmpeg -f x11grab -show_region 1 -framerate 25 -video_size cif -i :0.0+10,20 out.mpg
1461
@end example
1462

1463 1464
With @var{follow_mouse}:
@example
1465
ffmpeg -f x11grab -follow_mouse centered -show_region 1 -framerate 25 -video_size cif -i :0.0 out.mpg
1466
@end example
1467 1468 1469

@item video_size
Set the video frame size. Default value is @code{vga}.
1470

1471 1472 1473 1474 1475 1476 1477
@item grab_x
@item grab_y
Set the grabbing region coordinates. They are expressed as offset from
the top left corner of the X11 window and correspond to the
@var{x_offset} and @var{y_offset} parameters in the device name. The
default value for both options is 0.
@end table
1478

1479
@c man end INPUT DEVICES