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

4
Input devices are configured elements in FFmpeg which allow to access
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 66
@section avfoundation

AVFoundation input device.

AVFoundation is the currently recommended framework by Apple for streamgrabbing on OSX >= 10.7 as well as on iOS.
The older QTKit framework has been marked deprecated since OSX version 10.7.

The filename passed as input is parsed to contain either a device name or index.
The device index can also be given by using -video_device_index.
A given device index will override any given device name.
If the desired device consists of numbers only, use -video_device_index to identify it.
The default device will be chosen if an empty string  or the device name "default" is given.
The available devices can be enumerated by using -list_devices.
67 68 69 70 71
The pixel format can be set using -pixel_format.
Available formats:
 monob, rgb555be, rgb555le, rgb565be, rgb565le, rgb24, bgr24, 0rgb, bgr0, 0bgr, rgb0,
 bgr48be, uyvy422, yuva444p, yuva444p16le, yuv444p, yuv422p16, yuv422p10, yuv444p10,
 yuv420p, nv12, yuyv422, gray
72 73 74 75 76 77 78 79 80 81

@example
ffmpeg -f avfoundation -i "0" out.mpg
@end example

@example
ffmpeg -f avfoundation -video_device_index 0 -i "" out.mpg
@end example

@example
82
ffmpeg -f avfoundation -pixel_format bgr0 -i "default" out.mpg
83 84 85 86 87 88
@end example

@example
ffmpeg -f avfoundation -list_devices true -i ""
@end example

89 90 91 92
@section bktr

BSD video input device.

93 94 95 96
@section dshow

Windows DirectShow input device.

97
DirectShow support is enabled when FFmpeg is built with the mingw-w64 project.
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123
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},
and @var{NAME} is the device's name.

@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
124
Set the frame rate in the captured video.
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141

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

142 143 144 145 146 147 148 149
@item video_device_number
Set video device number for devices with same name (starts at 0,
defaults to 0).

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

150 151 152 153
@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.

154 155 156 157 158 159 160 161 162
@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}

163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180
@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

181 182 183 184 185 186
@item
Open second video device with name @var{Camera}:
@example
$ ffmpeg -f dshow -video_device_number 1 -i video="Camera"
@end example

187 188 189 190 191 192 193 194 195 196 197 198 199 200
@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

@end itemize

201 202 203 204
@section dv1394

Linux DV 1394 input device.

205 206 207 208 209 210 211 212 213 214 215 216
@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.

217
To record from the framebuffer device @file{/dev/fb0} with
218
@command{ffmpeg}:
219 220 221 222 223 224
@example
ffmpeg -f fbdev -r 10 -i /dev/fb0 out.avi
@end example

You can take a single screenshot image with the command:
@example
225
ffmpeg -f fbdev -frames:v 1 -r 1 -i /dev/fb0 screenshot.jpeg
226 227 228 229
@end example

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

230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304
@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

305 306 307 308
@section iec61883

FireWire DV/HDV input device using libiec61883.

309 310 311 312
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.

313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336
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
Set maxiumum size of buffer for incoming data, in frames. For DV, this
is an exact value. For HDV, it is not frame exact, since HDV does
not have a fixed frame size.

337 338 339 340 341 342 343
@item dvguid
Select the capture device by specifying it's GUID. Capturing will only
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.

344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364
@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

365 366
@section jack

367
JACK input device.
368 369 370 371

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

372
A JACK input device creates one or more JACK writable clients, one for
373 374 375
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.
376
Each writable client will send the acquired data to the FFmpeg input
377 378
device.

379 380
Once you have created one or more JACK readable clients, you need to
connect them to one or more JACK writable clients.
381

382 383 384
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}.
385

386
To list the JACK clients and their properties you can invoke the command
387
@command{jack_lsp}.
388

389
Follows an example which shows how to capture a JACK readable client
390
with @command{ffmpeg}.
391
@example
392
# Create a JACK writable client with name "ffmpeg".
393 394
$ ffmpeg -f jack -i ffmpeg -y out.wav

395
# Start the sample jack_metro readable client.
396 397
$ jack_metro -b 120 -d 0.2 -f 4000

398
# List the current JACK clients.
399 400 401 402 403 404 405 406
$ jack_lsp -c
system:capture_1
system:capture_2
system:playback_1
system:playback_2
ffmpeg:input_1
metro:120_bpm

407
# Connect metro to the ffmpeg writable client.
408 409 410 411 412 413
$ jack_connect metro:120_bpm ffmpeg:input_1
@end example

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

414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435
@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"
436
label, but all the others need to be specified explicitly.
437 438 439

If not specified defaults to the filename specified for the input
device.
440 441 442 443 444 445

@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}.

446 447 448 449 450 451
@end table

@subsection Examples

@itemize
@item
452
Create a color video stream and play it back with @command{ffplay}:
453
@example
454
ffplay -f lavfi -graph "color=c=pink [out0]" dummy
455 456 457 458 459 460
@end example

@item
As the previous example, but use filename for specifying the graph
description, and omit the "out0" label:
@example
461
ffplay -f lavfi color=c=pink
462 463 464 465 466 467 468
@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
469 470 471

@item
Read an audio stream from a file using the amovie source and play it
472
back with @command{ffplay}:
473 474 475 476 477 478
@example
ffplay -f lavfi "amovie=test.wav"
@end example

@item
Read an audio stream and a video stream and play it back with
479
@command{ffplay}:
480 481 482 483
@example
ffplay -f lavfi "movie=test.avi[out0];amovie=test.wav[out1]"
@end example

484 485
@end itemize

486 487 488 489 490
@section libcdio

Audio-CD input device based on cdio.

To enable this input device during configuration you need libcdio
491 492
installed on your system. Requires the configure option
@code{--enable-libcdio}.
493 494 495 496 497 498 499 500 501

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

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

502 503 504 505
@section libdc1394

IIDC1394 input device, based on libdc1394 and libraw1394.

506 507
Requires the configure option @code{--enable-libdc1394}.

508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539
@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

540
This device allows one to capture from an audio input device handled
541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589
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,
590
within the same @command{ffmpeg} command:
591 592 593 594 595 596
@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.

597 598 599 600 601 602
@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
603
@file{/dev/dsp}.
604

605
For example to grab from @file{/dev/dsp} using @command{ffmpeg} use the
606 607 608 609 610 611 612 613
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}

Luca Barbato's avatar
Luca Barbato committed
614 615
@section pulse

616
PulseAudio input device.
Luca Barbato's avatar
Luca Barbato committed
617

618
To enable this output device you need to configure FFmpeg with @code{--enable-libpulse}.
Luca Barbato's avatar
Luca Barbato committed
619 620 621 622

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

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

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

628 629 630
@subsection Options
@table @option
@item server
631 632
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
633

634 635 636
@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
637

638 639 640
@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
641

642
@item sample_rate
Luca Barbato's avatar
Luca Barbato committed
643 644
Specify the samplerate in Hz, by default 48kHz is used.

645
@item channels
Luca Barbato's avatar
Luca Barbato committed
646 647
Specify the channels in use, by default 2 (stereo) is set.

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

651 652 653 654
@item fragment_size
Specify the minimal buffering fragment in PulseAudio, it will affect the
audio latency. By default it is unset.
@end table
Luca Barbato's avatar
Luca Barbato committed
655

656 657
@subsection Examples
Record a stream from default device:
Luca Barbato's avatar
Luca Barbato committed
658
@example
659
ffmpeg -f pulse -i default /tmp/pulse.wav
Luca Barbato's avatar
Luca Barbato committed
660 661
@end example

662 663 664 665
@section qtkit

QTKit input device.

666 667 668 669 670 671
The filename passed as input is parsed to contain either a device name or index.
The device index can also be given by using -video_device_index.
A given device index will override any given device name.
If the desired device consists of numbers only, use -video_device_index to identify it.
The default device will be chosen if an empty string  or the device name "default" is given.
The available devices can be enumerated by using -list_devices.
672 673

@example
674
ffmpeg -f qtkit -i "0" out.mpg
675 676
@end example

677 678 679 680 681 682 683 684 685 686 687 688
@example
ffmpeg -f qtkit -video_device_index 0 -i "" out.mpg
@end example

@example
ffmpeg -f qtkit -i "default" out.mpg
@end example

@example
ffmpeg -f qtkit -list_devices true -i ""
@end example

689 690 691 692 693 694 695 696 697 698 699
@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}.

700
For example to grab from @file{/dev/audio0} using @command{ffmpeg} use the
701 702 703 704 705
command:
@example
ffmpeg -f sndio -i /dev/audio0 /tmp/oss.wav
@end example

706
@section video4linux2, v4l2
707

708
Video4Linux2 input video device.
709

710 711 712
"v4l2" can be used as alias for "video4linux2".

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

716 717
The name of the device to grab is a file device node, usually Linux
systems tend to automatically create such nodes when the device
718
(e.g. an USB webcam) is plugged into the system, and has a name of the
719 720 721
kind @file{/dev/video@var{N}}, where @var{N} is a number associated to
the device.

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

728 729 730 731 732 733 734
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.

735
Some usage examples of the video4linux2 device with @command{ffmpeg}
736
and @command{ffplay}:
737 738 739
@itemize
@item
Grab and show the input of a video4linux2 device:
740
@example
741
ffplay -f video4linux2 -framerate 30 -video_size hd720 /dev/video0
742
@end example
743

744 745
@item
Grab and record the input of a video4linux2 device, leave the
746
frame rate and size as previously set:
747
@example
748
ffmpeg -f video4linux2 -input_format mjpeg -i /dev/video0 out.mpeg
749
@end example
750
@end itemize
751

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

754 755 756 757 758 759 760 761 762
@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
763 764
Set the input channel number. Default to -1, which means using the
previously selected channel.
765 766 767 768 769 770 771 772 773 774

@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.
775
This option allows one to select the input format, when several are
776 777 778
available.

@item framerate
779
Set the preferred video frame rate.
780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817

@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
818
Force conversion from monotonic to absolute timestamps.
819 820 821 822 823
@end table

Default value is @code{default}.
@end table

824 825
@section vfwcap

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

828 829 830 831
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.

832 833 834 835
@section x11grab

X11 video input device.

836 837 838
Depends on X11, Xext, and Xfixes. Requires the configure option
@code{--enable-x11grab}.

839
This device allows one to capture a region of an X11 display.
840

841
The filename passed as input has the syntax:
842 843 844 845 846
@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
847
X11 display name of the screen to grab from. @var{hostname} can be
848
omitted, and defaults to "localhost". The environment variable
849 850 851
@env{DISPLAY} contains the default display name.

@var{x_offset} and @var{y_offset} specify the offsets of the grabbed
852
area with respect to the top-left border of the X11 screen. They
853 854 855 856
default to 0.

Check the X11 documentation (e.g. man X) for more detailed information.

857
Use the @command{dpyinfo} program for getting basic information about the
858
properties of your X11 display (e.g. grep for "name" or "dimensions").
859

860
For example to grab from @file{:0.0} using @command{ffmpeg}:
861
@example
862
ffmpeg -f x11grab -framerate 25 -video_size cif -i :0.0 out.mpg
863
@end example
864

865 866
Grab at position @code{10,20}:
@example
867
ffmpeg -f x11grab -framerate 25 -video_size cif -i :0.0+10,20 out.mpg
868 869
@end example

870
@subsection Options
871

872
@table @option
873 874 875 876
@item draw_mouse
Specify whether to draw the mouse pointer. A value of @code{0} specify
not to draw the pointer. Default value is @code{1}.

877 878 879
@item follow_mouse
Make the grabbed area follow the mouse. The argument can be
@code{centered} or a number of pixels @var{PIXELS}.
880 881 882 883 884 885 886 887

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
888
ffmpeg -f x11grab -follow_mouse centered -framerate 25 -video_size cif -i :0.0 out.mpg
889 890
@end example

891
To follow only when the mouse pointer reaches within 100 pixels to edge:
892
@example
893
ffmpeg -f x11grab -follow_mouse 100 -framerate 25 -video_size cif -i :0.0 out.mpg
894 895
@end example

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

900 901 902 903 904 905
@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.
906 907 908

For example:
@example
909
ffmpeg -f x11grab -show_region 1 -framerate 25 -video_size cif -i :0.0+10,20 out.mpg
910
@end example
911

912 913
With @var{follow_mouse}:
@example
914
ffmpeg -f x11grab -follow_mouse centered -show_region 1 -framerate 25 -video_size cif -i :0.0 out.mpg
915
@end example
916 917 918

@item video_size
Set the video frame size. Default value is @code{vga}.
919 920 921 922

@item use_shm
Use the MIT-SHM extension for shared memory. Default value is @code{1}.
It may be necessary to disable it for remote displays.
923
@end table
924 925

@c man end INPUT DEVICES