Subversion Repositories Kolibri OS

Rev

Blame | Last modification | View Log | RSS feed

  1. .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
  2. .\"
  3. .\" Standard preamble:
  4. .\" ========================================================================
  5. .de Sh \" Subsection heading
  6. .br
  7. .if t .Sp
  8. .ne 5
  9. .PP
  10. \fB\\$1\fR
  11. .PP
  12. ..
  13. .de Sp \" Vertical space (when we can't use .PP)
  14. .if t .sp .5v
  15. .if n .sp
  16. ..
  17. .de Vb \" Begin verbatim text
  18. .ft CW
  19. .nf
  20. .ne \\$1
  21. ..
  22. .de Ve \" End verbatim text
  23. .ft R
  24. .fi
  25. ..
  26. .\" Set up some character translations and predefined strings.  \*(-- will
  27. .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  28. .\" double quote, and \*(R" will give a right double quote.  | will give a
  29. .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
  30. .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
  31. .\" expand to `' in nroff, nothing in troff, for use with C<>.
  32. .tr \(*W-|\(bv\*(Tr
  33. .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  34. .ie n \{\
  35. .    ds -- \(*W-
  36. .    ds PI pi
  37. .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  38. .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  39. .    ds L" ""
  40. .    ds R" ""
  41. .    ds C` ""
  42. .    ds C' ""
  43. 'br\}
  44. .el\{\
  45. .    ds -- \|\(em\|
  46. .    ds PI \(*p
  47. .    ds L" ``
  48. .    ds R" ''
  49. 'br\}
  50. .\"
  51. .\" If the F register is turned on, we'll generate index entries on stderr for
  52. .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  53. .\" entries marked with X<> in POD.  Of course, you'll have to process the
  54. .\" output yourself in some meaningful fashion.
  55. .if \nF \{\
  56. .    de IX
  57. .    tm Index:\\$1\t\\n%\t"\\$2"
  58. ..
  59. .    nr % 0
  60. .    rr F
  61. .\}
  62. .\"
  63. .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
  64. .\" way too many mistakes in technical documents.
  65. .hy 0
  66. .if n .na
  67. .\"
  68. .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69. .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70. .    \" fudge factors for nroff and troff
  71. .if n \{\
  72. .    ds #H 0
  73. .    ds #V .8m
  74. .    ds #F .3m
  75. .    ds #[ \f1
  76. .    ds #] \fP
  77. .\}
  78. .if t \{\
  79. .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80. .    ds #V .6m
  81. .    ds #F 0
  82. .    ds #[ \&
  83. .    ds #] \&
  84. .\}
  85. .    \" simple accents for nroff and troff
  86. .if n \{\
  87. .    ds ' \&
  88. .    ds ` \&
  89. .    ds ^ \&
  90. .    ds , \&
  91. .    ds ~ ~
  92. .    ds /
  93. .\}
  94. .if t \{\
  95. .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96. .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97. .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98. .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99. .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
  100. .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
  101. .\}
  102. .    \" troff and (daisy-wheel) nroff accents
  103. .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
  104. .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
  105. .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
  106. .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
  107. .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
  108. .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
  109. .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
  110. .ds ae a\h'-(\w'a'u*4/10)'e
  111. .ds Ae A\h'-(\w'A'u*4/10)'E
  112. .    \" corrections for vroff
  113. .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
  114. .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
  115. .    \" for low resolution devices (crt and lpr)
  116. .if \n(.H>23 .if \n(.V>19 \
  117. \{\
  118. .    ds : e
  119. .    ds 8 ss
  120. .    ds o a
  121. .    ds d- d\h'-1'\(ga
  122. .    ds D- D\h'-1'\(hy
  123. .    ds th \o'bp'
  124. .    ds Th \o'LP'
  125. .    ds ae ae
  126. .    ds Ae AE
  127. .\}
  128. .rm #[ #] #H #V #F C
  129. .\" ========================================================================
  130. .\"
  131. .IX Title "FFMPEG-DEVICES 1"
  132. .TH FFMPEG-DEVICES 1 " " " " " "
  133. .SH "NAME"
  134. ffmpeg\-devices \- FFmpeg devices
  135. .SH "DESCRIPTION"
  136. .IX Header "DESCRIPTION"
  137. This document describes the input and output devices provided by the
  138. libavdevice library.
  139. .SH "DEVICE OPTIONS"
  140. .IX Header "DEVICE OPTIONS"
  141. The libavdevice library provides the same interface as
  142. libavformat. Namely, an input device is considered like a demuxer, and
  143. an output device like a muxer, and the interface and generic device
  144. options are the same provided by libavformat (see the ffmpeg-formats
  145. manual).
  146. .PP
  147. In addition each input or output device may support so-called private
  148. options, which are specific for that component.
  149. .PP
  150. Options may be set by specifying \-\fIoption\fR \fIvalue\fR in the
  151. FFmpeg tools, or by setting the value explicitly in the device
  152. \&\f(CW\*(C`AVFormatContext\*(C'\fR options or using the \fIlibavutil/opt.h\fR \s-1API\s0
  153. for programmatic use.
  154. .SH "INPUT DEVICES"
  155. .IX Header "INPUT DEVICES"
  156. Input devices are configured elements in FFmpeg which enable accessing
  157. the data coming from a multimedia device attached to your system.
  158. .PP
  159. When you configure your FFmpeg build, all the supported input devices
  160. are enabled by default. You can list all available ones using the
  161. configure option \*(L"\-\-list\-indevs\*(R".
  162. .PP
  163. You can disable all the input devices using the configure option
  164. \&\*(L"\-\-disable\-indevs\*(R", and selectively enable an input device using the
  165. option "\-\-enable\-indev=\fI\s-1INDEV\s0\fR\*(L", or you can disable a particular
  166. input device using the option \*(R"\-\-disable\-indev=\fI\s-1INDEV\s0\fR".
  167. .PP
  168. The option \*(L"\-devices\*(R" of the ff* tools will display the list of
  169. supported input devices.
  170. .PP
  171. A description of the currently available input devices follows.
  172. .Sh "alsa"
  173. .IX Subsection "alsa"
  174. \&\s-1ALSA\s0 (Advanced Linux Sound Architecture) input device.
  175. .PP
  176. To enable this input device during configuration you need libasound
  177. installed on your system.
  178. .PP
  179. This device allows capturing from an \s-1ALSA\s0 device. The name of the
  180. device to capture has to be an \s-1ALSA\s0 card identifier.
  181. .PP
  182. An \s-1ALSA\s0 identifier has the syntax:
  183. .PP
  184. .Vb 1
  185. \&        hw:<CARD>[,<DEV>[,<SUBDEV>]]
  186. .Ve
  187. .PP
  188. where the \fI\s-1DEV\s0\fR and \fI\s-1SUBDEV\s0\fR components are optional.
  189. .PP
  190. The three arguments (in order: \fI\s-1CARD\s0\fR,\fI\s-1DEV\s0\fR,\fI\s-1SUBDEV\s0\fR)
  191. specify card number or identifier, device number and subdevice number
  192. (\-1 means any).
  193. .PP
  194. To see the list of cards currently recognized by your system check the
  195. files \fI/proc/asound/cards\fR and \fI/proc/asound/devices\fR.
  196. .PP
  197. For example to capture with \fBffmpeg\fR from an \s-1ALSA\s0 device with
  198. card id 0, you may run the command:
  199. .PP
  200. .Vb 1
  201. \&        ffmpeg -f alsa -i hw:0 alsaout.wav
  202. .Ve
  203. .PP
  204. For more information see:
  205. <\fBhttp://www.alsa\-project.org/alsa\-doc/alsa\-lib/pcm.html\fR>
  206. .PP
  207. \fIOptions\fR
  208. .IX Subsection "Options"
  209. .IP "\fBsample_rate\fR" 4
  210. .IX Item "sample_rate"
  211. Set the sample rate in Hz. Default is 48000.
  212. .IP "\fBchannels\fR" 4
  213. .IX Item "channels"
  214. Set the number of channels. Default is 2.
  215. .Sh "avfoundation"
  216. .IX Subsection "avfoundation"
  217. AVFoundation input device.
  218. .PP
  219. AVFoundation is the currently recommended framework by Apple for streamgrabbing on \s-1OSX\s0 >= 10.7 as well as on iOS.
  220. The older QTKit framework has been marked deprecated since \s-1OSX\s0 version 10.7.
  221. .PP
  222. The input filename has to be given in the following syntax:
  223. .PP
  224. .Vb 1
  225. \&        -i "[[VIDEO]:[AUDIO]]"
  226. .Ve
  227. .PP
  228. The first entry selects the video input while the latter selects the audio input.
  229. The stream has to be specified by the device name or the device index as shown by the device list.
  230. Alternatively, the video and/or audio input device can be chosen by index using the
  231. .PP
  232. .Vb 1
  233. \&    B<-video_device_index E<lt>INDEXE<gt>>
  234. .Ve
  235. .PP
  236. and/or
  237. .PP
  238. .Vb 1
  239. \&    B<-audio_device_index E<lt>INDEXE<gt>>
  240. .Ve
  241. .PP
  242. , overriding any
  243. device name or index given in the input filename.
  244. .PP
  245. All available devices can be enumerated by using \fB\-list_devices true\fR, listing
  246. all device names and corresponding indices.
  247. .PP
  248. There are two device name aliases:
  249. .ie n .IP """default""" 4
  250. .el .IP "\f(CWdefault\fR" 4
  251. .IX Item "default"
  252. Select the AVFoundation default device of the corresponding type.
  253. .ie n .IP """none""" 4
  254. .el .IP "\f(CWnone\fR" 4
  255. .IX Item "none"
  256. Do not record the corresponding media type.
  257. This is equivalent to specifying an empty device name or index.
  258. .PP
  259. \fIOptions\fR
  260. .IX Subsection "Options"
  261. .PP
  262. AVFoundation supports the following options:
  263. .IP "\fB\-list_devices <TRUE|FALSE>\fR" 4
  264. .IX Item "-list_devices <TRUE|FALSE>"
  265. If set to true, a list of all available input devices is given showing all
  266. device names and indices.
  267. .IP "\fB\-video_device_index <\s-1INDEX\s0>\fR" 4
  268. .IX Item "-video_device_index <INDEX>"
  269. Specify the video device by its index. Overrides anything given in the input filename.
  270. .IP "\fB\-audio_device_index <\s-1INDEX\s0>\fR" 4
  271. .IX Item "-audio_device_index <INDEX>"
  272. Specify the audio device by its index. Overrides anything given in the input filename.
  273. .IP "\fB\-pixel_format <\s-1FORMAT\s0>\fR" 4
  274. .IX Item "-pixel_format <FORMAT>"
  275. Request the video device to use a specific pixel format.
  276. If the specified format is not supported, a list of available formats is given
  277. und the first one in this list is used instead. Available pixel formats are:
  278. \&\f(CW\*(C`monob, rgb555be, rgb555le, rgb565be, rgb565le, rgb24, bgr24, 0rgb, bgr0, 0bgr, rgb0,
  279.  bgr48be, uyvy422, yuva444p, yuva444p16le, yuv444p, yuv422p16, yuv422p10, yuv444p10,
  280.  yuv420p, nv12, yuyv422, gray\*(C'\fR
  281. .IP "\fB\-framerate\fR" 4
  282. .IX Item "-framerate"
  283. Set the grabbing frame rate. Default is \f(CW\*(C`ntsc\*(C'\fR, corresponding to a
  284. frame rate of \f(CW\*(C`30000/1001\*(C'\fR.
  285. .IP "\fB\-video_size\fR" 4
  286. .IX Item "-video_size"
  287. Set the video frame size.
  288. .IP "\fB\-capture_cursor\fR" 4
  289. .IX Item "-capture_cursor"
  290. Capture the mouse pointer. Default is 0.
  291. .IP "\fB\-capture_mouse_clicks\fR" 4
  292. .IX Item "-capture_mouse_clicks"
  293. Capture the screen mouse clicks. Default is 0.
  294. .PP
  295. \fIExamples\fR
  296. .IX Subsection "Examples"
  297. .IP "\(bu" 4
  298. Print the list of AVFoundation supported devices and exit:
  299. .Sp
  300. .Vb 1
  301. \&        $ ffmpeg -f avfoundation -list_devices true -i ""
  302. .Ve
  303. .IP "\(bu" 4
  304. Record video from video device 0 and audio from audio device 0 into out.avi:
  305. .Sp
  306. .Vb 1
  307. \&        $ ffmpeg -f avfoundation -i "0:0" out.avi
  308. .Ve
  309. .IP "\(bu" 4
  310. Record video from video device 2 and audio from audio device 1 into out.avi:
  311. .Sp
  312. .Vb 1
  313. \&        $ ffmpeg -f avfoundation -video_device_index 2 -i ":1" out.avi
  314. .Ve
  315. .IP "\(bu" 4
  316. Record video from the system default video device using the pixel format bgr0 and do not record any audio into out.avi:
  317. .Sp
  318. .Vb 1
  319. \&        $ ffmpeg -f avfoundation -pixel_format bgr0 -i "default:none" out.avi
  320. .Ve
  321. .Sh "bktr"
  322. .IX Subsection "bktr"
  323. \&\s-1BSD\s0 video input device.
  324. .PP
  325. \fIOptions\fR
  326. .IX Subsection "Options"
  327. .IP "\fBframerate\fR" 4
  328. .IX Item "framerate"
  329. Set the frame rate.
  330. .IP "\fBvideo_size\fR" 4
  331. .IX Item "video_size"
  332. Set the video frame size. Default is \f(CW\*(C`vga\*(C'\fR.
  333. .IP "\fBstandard\fR" 4
  334. .IX Item "standard"
  335. Available values are:
  336. .RS 4
  337. .IP "\fBpal\fR" 4
  338. .IX Item "pal"
  339. .PD 0
  340. .IP "\fBntsc\fR" 4
  341. .IX Item "ntsc"
  342. .IP "\fBsecam\fR" 4
  343. .IX Item "secam"
  344. .IP "\fBpaln\fR" 4
  345. .IX Item "paln"
  346. .IP "\fBpalm\fR" 4
  347. .IX Item "palm"
  348. .IP "\fBntscj\fR" 4
  349. .IX Item "ntscj"
  350. .RE
  351. .RS 4
  352. .RE
  353. .PD
  354. .Sh "decklink"
  355. .IX Subsection "decklink"
  356. The decklink input device provides capture capabilities for Blackmagic
  357. DeckLink devices.
  358. .PP
  359. To enable this input device, you need the Blackmagic DeckLink \s-1SDK\s0 and you
  360. need to configure with the appropriate \f(CW\*(C`\-\-extra\-cflags\*(C'\fR
  361. and \f(CW\*(C`\-\-extra\-ldflags\*(C'\fR.
  362. On Windows, you need to run the \s-1IDL\s0 files through \fBwidl\fR.
  363. .PP
  364. DeckLink is very picky about the formats it supports. Pixel format is
  365. uyvy422 or v210, framerate and video size must be determined for your device with
  366. \&\fB\-list_formats 1\fR. Audio sample rate is always 48 kHz and the number
  367. of channels can be 2, 8 or 16.
  368. .PP
  369. \fIOptions\fR
  370. .IX Subsection "Options"
  371. .IP "\fBlist_devices\fR" 4
  372. .IX Item "list_devices"
  373. If set to \fBtrue\fR, print a list of devices and exit.
  374. Defaults to \fBfalse\fR.
  375. .IP "\fBlist_formats\fR" 4
  376. .IX Item "list_formats"
  377. If set to \fBtrue\fR, print a list of supported formats and exit.
  378. Defaults to \fBfalse\fR.
  379. .IP "\fBbm_v210\fR" 4
  380. .IX Item "bm_v210"
  381. If set to \fB1\fR, video is captured in 10 bit v210 instead
  382. of uyvy422. Not all Blackmagic devices support this option.
  383. .PP
  384. \fIExamples\fR
  385. .IX Subsection "Examples"
  386. .IP "\(bu" 4
  387. List input devices:
  388. .Sp
  389. .Vb 1
  390. \&        ffmpeg -f decklink -list_devices 1 -i dummy
  391. .Ve
  392. .IP "\(bu" 4
  393. List supported formats:
  394. .Sp
  395. .Vb 1
  396. \&        ffmpeg -f decklink -list_formats 1 -i 'Intensity Pro'
  397. .Ve
  398. .IP "\(bu" 4
  399. Capture video clip at 1080i50 (format 11):
  400. .Sp
  401. .Vb 1
  402. \&        ffmpeg -f decklink -i 'Intensity Pro@11' -acodec copy -vcodec copy output.avi
  403. .Ve
  404. .IP "\(bu" 4
  405. Capture video clip at 1080i50 10 bit:
  406. .Sp
  407. .Vb 1
  408. \&        ffmpeg -bm_v210 1 -f decklink -i 'UltraStudio Mini Recorder@11' -acodec copy -vcodec copy output.avi
  409. .Ve
  410. .Sh "dshow"
  411. .IX Subsection "dshow"
  412. Windows DirectShow input device.
  413. .PP
  414. DirectShow support is enabled when FFmpeg is built with the mingw\-w64 project.
  415. Currently only audio and video devices are supported.
  416. .PP
  417. Multiple devices may be opened as separate inputs, but they may also be
  418. opened on the same input, which should improve synchronism between them.
  419. .PP
  420. The input name should be in the format:
  421. .PP
  422. .Vb 1
  423. \&        <TYPE>=<NAME>[:<TYPE>=<NAME>]
  424. .Ve
  425. .PP
  426. where \fI\s-1TYPE\s0\fR can be either \fIaudio\fR or \fIvideo\fR,
  427. and \fI\s-1NAME\s0\fR is the device's name or alternative name..
  428. .PP
  429. \fIOptions\fR
  430. .IX Subsection "Options"
  431. .PP
  432. If no options are specified, the device's defaults are used.
  433. If the device does not support the requested options, it will
  434. fail to open.
  435. .IP "\fBvideo_size\fR" 4
  436. .IX Item "video_size"
  437. Set the video size in the captured video.
  438. .IP "\fBframerate\fR" 4
  439. .IX Item "framerate"
  440. Set the frame rate in the captured video.
  441. .IP "\fBsample_rate\fR" 4
  442. .IX Item "sample_rate"
  443. Set the sample rate (in Hz) of the captured audio.
  444. .IP "\fBsample_size\fR" 4
  445. .IX Item "sample_size"
  446. Set the sample size (in bits) of the captured audio.
  447. .IP "\fBchannels\fR" 4
  448. .IX Item "channels"
  449. Set the number of channels in the captured audio.
  450. .IP "\fBlist_devices\fR" 4
  451. .IX Item "list_devices"
  452. If set to \fBtrue\fR, print a list of devices and exit.
  453. .IP "\fBlist_options\fR" 4
  454. .IX Item "list_options"
  455. If set to \fBtrue\fR, print a list of selected device's options
  456. and exit.
  457. .IP "\fBvideo_device_number\fR" 4
  458. .IX Item "video_device_number"
  459. Set video device number for devices with the same name (starts at 0,
  460. defaults to 0).
  461. .IP "\fBaudio_device_number\fR" 4
  462. .IX Item "audio_device_number"
  463. Set audio device number for devices with the same name (starts at 0,
  464. defaults to 0).
  465. .IP "\fBpixel_format\fR" 4
  466. .IX Item "pixel_format"
  467. Select pixel format to be used by DirectShow. This may only be set when
  468. the video codec is not set or set to rawvideo.
  469. .IP "\fBaudio_buffer_size\fR" 4
  470. .IX Item "audio_buffer_size"
  471. Set audio device buffer size in milliseconds (which can directly
  472. impact latency, depending on the device).
  473. Defaults to using the audio device's
  474. default buffer size (typically some multiple of 500ms).
  475. Setting this value too low can degrade performance.
  476. See also
  477. <\fBhttp://msdn.microsoft.com/en\-us/library/windows/desktop/dd377582(v=vs.85).aspx\fR>
  478. .IP "\fBvideo_pin_name\fR" 4
  479. .IX Item "video_pin_name"
  480. Select video capture pin to use by name or alternative name.
  481. .IP "\fBaudio_pin_name\fR" 4
  482. .IX Item "audio_pin_name"
  483. Select audio capture pin to use by name or alternative name.
  484. .IP "\fBcrossbar_video_input_pin_number\fR" 4
  485. .IX Item "crossbar_video_input_pin_number"
  486. Select video input pin number for crossbar device. This will be
  487. routed to the crossbar device's Video Decoder output pin.
  488. Note that changing this value can affect future invocations
  489. (sets a new default) until system reboot occurs.
  490. .IP "\fBcrossbar_audio_input_pin_number\fR" 4
  491. .IX Item "crossbar_audio_input_pin_number"
  492. Select audio input pin number for crossbar device. This will be
  493. routed to the crossbar device's Audio Decoder output pin.
  494. Note that changing this value can affect future invocations
  495. (sets a new default) until system reboot occurs.
  496. .IP "\fBshow_video_device_dialog\fR" 4
  497. .IX Item "show_video_device_dialog"
  498. If set to \fBtrue\fR, before capture starts, popup a display dialog
  499. to the end user, allowing them to change video filter properties
  500. and configurations manually.
  501. Note that for crossbar devices, adjusting values in this dialog
  502. may be needed at times to toggle between \s-1PAL\s0 (25 fps) and \s-1NTSC\s0 (29.97)
  503. input frame rates, sizes, interlacing, etc.  Changing these values can
  504. enable different scan rates/frame rates and avoiding green bars at
  505. the bottom, flickering scan lines, etc.
  506. Note that with some devices, changing these properties can also affect future
  507. invocations (sets new defaults) until system reboot occurs.
  508. .IP "\fBshow_audio_device_dialog\fR" 4
  509. .IX Item "show_audio_device_dialog"
  510. If set to \fBtrue\fR, before capture starts, popup a display dialog
  511. to the end user, allowing them to change audio filter properties
  512. and configurations manually.
  513. .IP "\fBshow_video_crossbar_connection_dialog\fR" 4
  514. .IX Item "show_video_crossbar_connection_dialog"
  515. If set to \fBtrue\fR, before capture starts, popup a display
  516. dialog to the end user, allowing them to manually
  517. modify crossbar pin routings, when it opens a video device.
  518. .IP "\fBshow_audio_crossbar_connection_dialog\fR" 4
  519. .IX Item "show_audio_crossbar_connection_dialog"
  520. If set to \fBtrue\fR, before capture starts, popup a display
  521. dialog to the end user, allowing them to manually
  522. modify crossbar pin routings, when it opens an audio device.
  523. .IP "\fBshow_analog_tv_tuner_dialog\fR" 4
  524. .IX Item "show_analog_tv_tuner_dialog"
  525. If set to \fBtrue\fR, before capture starts, popup a display
  526. dialog to the end user, allowing them to manually
  527. modify \s-1TV\s0 channels and frequencies.
  528. .IP "\fBshow_analog_tv_tuner_audio_dialog\fR" 4
  529. .IX Item "show_analog_tv_tuner_audio_dialog"
  530. If set to \fBtrue\fR, before capture starts, popup a display
  531. dialog to the end user, allowing them to manually
  532. modify \s-1TV\s0 audio (like mono vs. stereo, Language A,B or C).
  533. .IP "\fBaudio_device_load\fR" 4
  534. .IX Item "audio_device_load"
  535. Load an audio capture filter device from file instead of searching
  536. it by name. It may load additional parameters too, if the filter
  537. supports the serialization of its properties to.
  538. To use this an audio capture source has to be specified, but it can
  539. be anything even fake one.
  540. .IP "\fBaudio_device_save\fR" 4
  541. .IX Item "audio_device_save"
  542. Save the currently used audio capture filter device and its
  543. parameters (if the filter supports it) to a file.
  544. If a file with the same name exists it will be overwritten.
  545. .IP "\fBvideo_device_load\fR" 4
  546. .IX Item "video_device_load"
  547. Load a video capture filter device from file instead of searching
  548. it by name. It may load additional parameters too, if the filter
  549. supports the serialization of its properties to.
  550. To use this a video capture source has to be specified, but it can
  551. be anything even fake one.
  552. .IP "\fBvideo_device_save\fR" 4
  553. .IX Item "video_device_save"
  554. Save the currently used video capture filter device and its
  555. parameters (if the filter supports it) to a file.
  556. If a file with the same name exists it will be overwritten.
  557. .PP
  558. \fIExamples\fR
  559. .IX Subsection "Examples"
  560. .IP "\(bu" 4
  561. Print the list of DirectShow supported devices and exit:
  562. .Sp
  563. .Vb 1
  564. \&        $ ffmpeg -list_devices true -f dshow -i dummy
  565. .Ve
  566. .IP "\(bu" 4
  567. Open video device \fICamera\fR:
  568. .Sp
  569. .Vb 1
  570. \&        $ ffmpeg -f dshow -i video="Camera"
  571. .Ve
  572. .IP "\(bu" 4
  573. Open second video device with name \fICamera\fR:
  574. .Sp
  575. .Vb 1
  576. \&        $ ffmpeg -f dshow -video_device_number 1 -i video="Camera"
  577. .Ve
  578. .IP "\(bu" 4
  579. Open video device \fICamera\fR and audio device \fIMicrophone\fR:
  580. .Sp
  581. .Vb 1
  582. \&        $ ffmpeg -f dshow -i video="Camera":audio="Microphone"
  583. .Ve
  584. .IP "\(bu" 4
  585. Print the list of supported options in selected device and exit:
  586. .Sp
  587. .Vb 1
  588. \&        $ ffmpeg -list_options true -f dshow -i video="Camera"
  589. .Ve
  590. .IP "\(bu" 4
  591. Specify pin names to capture by name or alternative name, specify alternative device name:
  592. .Sp
  593. .Vb 1
  594. \&        $ ffmpeg -f dshow -audio_pin_name "Audio Out" -video_pin_name 2 -i video=video="@device_pnp_\e\e?\epci#ven_1a0a&dev_6200&subsys_62021461&rev_01#4&e2c7dd6&0&00e1#{65e8773d-8f56-11d0-a3b9-00a0c9223196}\e{ca465100-deb0-4d59-818f-8c477184adf6}":audio="Microphone"
  595. .Ve
  596. .IP "\(bu" 4
  597. Configure a crossbar device, specifying crossbar pins, allow user to adjust video capture properties at startup:
  598. .Sp
  599. .Vb 2
  600. \&        $ ffmpeg -f dshow -show_video_device_dialog true -crossbar_video_input_pin_number 0
  601. \&             -crossbar_audio_input_pin_number 3 -i video="AVerMedia BDA Analog Capture":audio="AVerMedia BDA Analog Capture"
  602. .Ve
  603. .Sh "dv1394"
  604. .IX Subsection "dv1394"
  605. Linux \s-1DV\s0 1394 input device.
  606. .PP
  607. \fIOptions\fR
  608. .IX Subsection "Options"
  609. .IP "\fBframerate\fR" 4
  610. .IX Item "framerate"
  611. Set the frame rate. Default is 25.
  612. .IP "\fBstandard\fR" 4
  613. .IX Item "standard"
  614. Available values are:
  615. .RS 4
  616. .IP "\fBpal\fR" 4
  617. .IX Item "pal"
  618. .PD 0
  619. .IP "\fBntsc\fR" 4
  620. .IX Item "ntsc"
  621. .RE
  622. .RS 4
  623. .PD
  624. .Sp
  625. Default value is \f(CW\*(C`ntsc\*(C'\fR.
  626. .RE
  627. .Sh "fbdev"
  628. .IX Subsection "fbdev"
  629. Linux framebuffer input device.
  630. .PP
  631. The Linux framebuffer is a graphic hardware-independent abstraction
  632. layer to show graphics on a computer monitor, typically on the
  633. console. It is accessed through a file device node, usually
  634. \&\fI/dev/fb0\fR.
  635. .PP
  636. For more detailed information read the file
  637. Documentation/fb/framebuffer.txt included in the Linux source tree.
  638. .PP
  639. See also <\fBhttp://linux\-fbdev.sourceforge.net/\fR>, and \fIfbset\fR\|(1).
  640. .PP
  641. To record from the framebuffer device \fI/dev/fb0\fR with
  642. \&\fBffmpeg\fR:
  643. .PP
  644. .Vb 1
  645. \&        ffmpeg -f fbdev -framerate 10 -i /dev/fb0 out.avi
  646. .Ve
  647. .PP
  648. You can take a single screenshot image with the command:
  649. .PP
  650. .Vb 1
  651. \&        ffmpeg -f fbdev -framerate 1 -i /dev/fb0 -frames:v 1 screenshot.jpeg
  652. .Ve
  653. .PP
  654. \fIOptions\fR
  655. .IX Subsection "Options"
  656. .IP "\fBframerate\fR" 4
  657. .IX Item "framerate"
  658. Set the frame rate. Default is 25.
  659. .Sh "gdigrab"
  660. .IX Subsection "gdigrab"
  661. Win32 GDI-based screen capture device.
  662. .PP
  663. This device allows you to capture a region of the display on Windows.
  664. .PP
  665. There are two options for the input filename:
  666. .PP
  667. .Vb 1
  668. \&        desktop
  669. .Ve
  670. .PP
  671. or
  672. .PP
  673. .Vb 1
  674. \&        title=<window_title>
  675. .Ve
  676. .PP
  677. The first option will capture the entire desktop, or a fixed region of the
  678. desktop. The second option will instead capture the contents of a single
  679. window, regardless of its position on the screen.
  680. .PP
  681. For example, to grab the entire desktop using \fBffmpeg\fR:
  682. .PP
  683. .Vb 1
  684. \&        ffmpeg -f gdigrab -framerate 6 -i desktop out.mpg
  685. .Ve
  686. .PP
  687. Grab a 640x480 region at position \f(CW\*(C`10,20\*(C'\fR:
  688. .PP
  689. .Vb 1
  690. \&        ffmpeg -f gdigrab -framerate 6 -offset_x 10 -offset_y 20 -video_size vga -i desktop out.mpg
  691. .Ve
  692. .PP
  693. Grab the contents of the window named \*(L"Calculator\*(R"
  694. .PP
  695. .Vb 1
  696. \&        ffmpeg -f gdigrab -framerate 6 -i title=Calculator out.mpg
  697. .Ve
  698. .PP
  699. \fIOptions\fR
  700. .IX Subsection "Options"
  701. .IP "\fBdraw_mouse\fR" 4
  702. .IX Item "draw_mouse"
  703. Specify whether to draw the mouse pointer. Use the value \f(CW0\fR to
  704. not draw the pointer. Default value is \f(CW1\fR.
  705. .IP "\fBframerate\fR" 4
  706. .IX Item "framerate"
  707. Set the grabbing frame rate. Default value is \f(CW\*(C`ntsc\*(C'\fR,
  708. corresponding to a frame rate of \f(CW\*(C`30000/1001\*(C'\fR.
  709. .IP "\fBshow_region\fR" 4
  710. .IX Item "show_region"
  711. Show grabbed region on screen.
  712. .Sp
  713. If \fIshow_region\fR is specified with \f(CW1\fR, then the grabbing
  714. region will be indicated on screen. With this option, it is easy to
  715. know what is being grabbed if only a portion of the screen is grabbed.
  716. .Sp
  717. Note that \fIshow_region\fR is incompatible with grabbing the contents
  718. of a single window.
  719. .Sp
  720. For example:
  721. .Sp
  722. .Vb 1
  723. \&        ffmpeg -f gdigrab -show_region 1 -framerate 6 -video_size cif -offset_x 10 -offset_y 20 -i desktop out.mpg
  724. .Ve
  725. .IP "\fBvideo_size\fR" 4
  726. .IX Item "video_size"
  727. Set the video frame size. The default is to capture the full screen if \fIdesktop\fR is selected, or the full window size if \fItitle=\fIwindow_title\fI\fR is selected.
  728. .IP "\fBoffset_x\fR" 4
  729. .IX Item "offset_x"
  730. When capturing a region with \fIvideo_size\fR, set the distance from the left edge of the screen or desktop.
  731. .Sp
  732. 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 \fIoffset_x\fR value to move the region to that monitor.
  733. .IP "\fBoffset_y\fR" 4
  734. .IX Item "offset_y"
  735. When capturing a region with \fIvideo_size\fR, set the distance from the top edge of the screen or desktop.
  736. .Sp
  737. 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 \fIoffset_y\fR value to move the region to that monitor.
  738. .Sh "iec61883"
  739. .IX Subsection "iec61883"
  740. FireWire \s-1DV/HDV\s0 input device using libiec61883.
  741. .PP
  742. To enable this input device, you need libiec61883, libraw1394 and
  743. libavc1394 installed on your system. Use the configure option
  744. \&\f(CW\*(C`\-\-enable\-libiec61883\*(C'\fR to compile with the device enabled.
  745. .PP
  746. The iec61883 capture device supports capturing from a video device
  747. connected via \s-1IEEE1394\s0 (FireWire), using libiec61883 and the new Linux
  748. FireWire stack (juju). This is the default \s-1DV/HDV\s0 input method in Linux
  749. Kernel 2.6.37 and later, since the old FireWire stack was removed.
  750. .PP
  751. Specify the FireWire port to be used as input file, or \*(L"auto\*(R"
  752. to choose the first port connected.
  753. .PP
  754. \fIOptions\fR
  755. .IX Subsection "Options"
  756. .IP "\fBdvtype\fR" 4
  757. .IX Item "dvtype"
  758. Override autodetection of \s-1DV/HDV\s0. This should only be used if auto
  759. detection does not work, or if usage of a different device type
  760. should be prohibited. Treating a \s-1DV\s0 device as \s-1HDV\s0 (or vice versa) will
  761. not work and result in undefined behavior.
  762. The values \fBauto\fR, \fBdv\fR and \fBhdv\fR are supported.
  763. .IP "\fBdvbuffer\fR" 4
  764. .IX Item "dvbuffer"
  765. Set maximum size of buffer for incoming data, in frames. For \s-1DV\s0, this
  766. is an exact value. For \s-1HDV\s0, it is not frame exact, since \s-1HDV\s0 does
  767. not have a fixed frame size.
  768. .IP "\fBdvguid\fR" 4
  769. .IX Item "dvguid"
  770. Select the capture device by specifying it's \s-1GUID\s0. Capturing will only
  771. be performed from the specified device and fails if no device with the
  772. given \s-1GUID\s0 is found. This is useful to select the input if multiple
  773. devices are connected at the same time.
  774. Look at /sys/bus/firewire/devices to find out the GUIDs.
  775. .PP
  776. \fIExamples\fR
  777. .IX Subsection "Examples"
  778. .IP "\(bu" 4
  779. Grab and show the input of a FireWire \s-1DV/HDV\s0 device.
  780. .Sp
  781. .Vb 1
  782. \&        ffplay -f iec61883 -i auto
  783. .Ve
  784. .IP "\(bu" 4
  785. Grab and record the input of a FireWire \s-1DV/HDV\s0 device,
  786. using a packet buffer of 100000 packets if the source is \s-1HDV\s0.
  787. .Sp
  788. .Vb 1
  789. \&        ffmpeg -f iec61883 -i auto -hdvbuffer 100000 out.mpg
  790. .Ve
  791. .Sh "jack"
  792. .IX Subsection "jack"
  793. \&\s-1JACK\s0 input device.
  794. .PP
  795. To enable this input device during configuration you need libjack
  796. installed on your system.
  797. .PP
  798. A \s-1JACK\s0 input device creates one or more \s-1JACK\s0 writable clients, one for
  799. each audio channel, with name \fIclient_name\fR:input_\fIN\fR, where
  800. \&\fIclient_name\fR is the name provided by the application, and \fIN\fR
  801. is a number which identifies the channel.
  802. Each writable client will send the acquired data to the FFmpeg input
  803. device.
  804. .PP
  805. Once you have created one or more \s-1JACK\s0 readable clients, you need to
  806. connect them to one or more \s-1JACK\s0 writable clients.
  807. .PP
  808. To connect or disconnect \s-1JACK\s0 clients you can use the \fBjack_connect\fR
  809. and \fBjack_disconnect\fR programs, or do it through a graphical interface,
  810. for example with \fBqjackctl\fR.
  811. .PP
  812. To list the \s-1JACK\s0 clients and their properties you can invoke the command
  813. \&\fBjack_lsp\fR.
  814. .PP
  815. Follows an example which shows how to capture a \s-1JACK\s0 readable client
  816. with \fBffmpeg\fR.
  817. .PP
  818. .Vb 2
  819. \&        # Create a JACK writable client with name "ffmpeg".
  820. \&        $ ffmpeg -f jack -i ffmpeg -y out.wav
  821. .Ve
  822. .PP
  823. .Vb 2
  824. \&        # Start the sample jack_metro readable client.
  825. \&        $ jack_metro -b 120 -d 0.2 -f 4000
  826. .Ve
  827. .PP
  828. .Vb 8
  829. \&        # List the current JACK clients.
  830. \&        $ jack_lsp -c
  831. \&        system:capture_1
  832. \&        system:capture_2
  833. \&        system:playback_1
  834. \&        system:playback_2
  835. \&        ffmpeg:input_1
  836. \&        metro:120_bpm
  837. .Ve
  838. .PP
  839. .Vb 2
  840. \&        # Connect metro to the ffmpeg writable client.
  841. \&        $ jack_connect metro:120_bpm ffmpeg:input_1
  842. .Ve
  843. .PP
  844. For more information read:
  845. <\fBhttp://jackaudio.org/\fR>
  846. .PP
  847. \fIOptions\fR
  848. .IX Subsection "Options"
  849. .IP "\fBchannels\fR" 4
  850. .IX Item "channels"
  851. Set the number of channels. Default is 2.
  852. .Sh "lavfi"
  853. .IX Subsection "lavfi"
  854. Libavfilter input virtual device.
  855. .PP
  856. This input device reads data from the open output pads of a libavfilter
  857. filtergraph.
  858. .PP
  859. For each filtergraph open output, the input device will create a
  860. corresponding stream which is mapped to the generated output. Currently
  861. only video data is supported. The filtergraph is specified through the
  862. option \fBgraph\fR.
  863. .PP
  864. \fIOptions\fR
  865. .IX Subsection "Options"
  866. .IP "\fBgraph\fR" 4
  867. .IX Item "graph"
  868. Specify the filtergraph to use as input. Each video open output must be
  869. labelled by a unique string of the form "out\fIN\fR", where \fIN\fR is a
  870. number starting from 0 corresponding to the mapped input stream
  871. generated by the device.
  872. The first unlabelled output is automatically assigned to the \*(L"out0\*(R"
  873. label, but all the others need to be specified explicitly.
  874. .Sp
  875. The suffix \*(L"+subcc\*(R" can be appended to the output label to create an extra
  876. stream with the closed captions packets attached to that output
  877. (experimental; only for \s-1EIA\-608\s0 / \s-1CEA\-708\s0 for now).
  878. The subcc streams are created after all the normal streams, in the order of
  879. the corresponding stream.
  880. For example, if there is \*(L"out19+subcc\*(R", \*(L"out7+subcc\*(R" and up to \*(L"out42\*(R", the
  881. stream #43 is subcc for stream #7 and stream #44 is subcc for stream #19.
  882. .Sp
  883. If not specified defaults to the filename specified for the input
  884. device.
  885. .IP "\fBgraph_file\fR" 4
  886. .IX Item "graph_file"
  887. Set the filename of the filtergraph to be read and sent to the other
  888. filters. Syntax of the filtergraph is the same as the one specified by
  889. the option \fIgraph\fR.
  890. .IP "\fBdumpgraph\fR" 4
  891. .IX Item "dumpgraph"
  892. Dump graph to stderr.
  893. .PP
  894. \fIExamples\fR
  895. .IX Subsection "Examples"
  896. .IP "\(bu" 4
  897. Create a color video stream and play it back with \fBffplay\fR:
  898. .Sp
  899. .Vb 1
  900. \&        ffplay -f lavfi -graph "color=c=pink [out0]" dummy
  901. .Ve
  902. .IP "\(bu" 4
  903. As the previous example, but use filename for specifying the graph
  904. description, and omit the \*(L"out0\*(R" label:
  905. .Sp
  906. .Vb 1
  907. \&        ffplay -f lavfi color=c=pink
  908. .Ve
  909. .IP "\(bu" 4
  910. Create three different video test filtered sources and play them:
  911. .Sp
  912. .Vb 1
  913. \&        ffplay -f lavfi -graph "testsrc [out0]; testsrc,hflip [out1]; testsrc,negate [out2]" test3
  914. .Ve
  915. .IP "\(bu" 4
  916. Read an audio stream from a file using the amovie source and play it
  917. back with \fBffplay\fR:
  918. .Sp
  919. .Vb 1
  920. \&        ffplay -f lavfi "amovie=test.wav"
  921. .Ve
  922. .IP "\(bu" 4
  923. Read an audio stream and a video stream and play it back with
  924. \&\fBffplay\fR:
  925. .Sp
  926. .Vb 1
  927. \&        ffplay -f lavfi "movie=test.avi[out0];amovie=test.wav[out1]"
  928. .Ve
  929. .IP "\(bu" 4
  930. Dump decoded frames to images and closed captions to a file (experimental):
  931. .Sp
  932. .Vb 1
  933. \&        ffmpeg -f lavfi -i "movie=test.ts[out0+subcc]" -map v frame%08d.png -map s -c copy -f rawvideo subcc.bin
  934. .Ve
  935. .Sh "libcdio"
  936. .IX Subsection "libcdio"
  937. Audio-CD input device based on libcdio.
  938. .PP
  939. To enable this input device during configuration you need libcdio
  940. installed on your system. It requires the configure option
  941. \&\f(CW\*(C`\-\-enable\-libcdio\*(C'\fR.
  942. .PP
  943. This device allows playing and grabbing from an Audio\-CD.
  944. .PP
  945. For example to copy with \fBffmpeg\fR the entire Audio-CD in \fI/dev/sr0\fR,
  946. you may run the command:
  947. .PP
  948. .Vb 1
  949. \&        ffmpeg -f libcdio -i /dev/sr0 cd.wav
  950. .Ve
  951. .PP
  952. \fIOptions\fR
  953. .IX Subsection "Options"
  954. .IP "\fBspeed\fR" 4
  955. .IX Item "speed"
  956. Set drive reading speed. Default value is 0.
  957. .Sp
  958. The speed is specified CD-ROM speed units. The speed is set through
  959. the libcdio \f(CW\*(C`cdio_cddap_speed_set\*(C'\fR function. On many CD-ROM
  960. drives, specifying a value too large will result in using the fastest
  961. speed.
  962. .IP "\fBparanoia_mode\fR" 4
  963. .IX Item "paranoia_mode"
  964. Set paranoia recovery mode flags. It accepts one of the following values:
  965. .RS 4
  966. .IP "\fBdisable\fR" 4
  967. .IX Item "disable"
  968. .PD 0
  969. .IP "\fBverify\fR" 4
  970. .IX Item "verify"
  971. .IP "\fBoverlap\fR" 4
  972. .IX Item "overlap"
  973. .IP "\fBneverskip\fR" 4
  974. .IX Item "neverskip"
  975. .IP "\fBfull\fR" 4
  976. .IX Item "full"
  977. .RE
  978. .RS 4
  979. .PD
  980. .Sp
  981. Default value is \fBdisable\fR.
  982. .Sp
  983. For more information about the available recovery modes, consult the
  984. paranoia project documentation.
  985. .RE
  986. .Sh "libdc1394"
  987. .IX Subsection "libdc1394"
  988. \&\s-1IIDC1394\s0 input device, based on libdc1394 and libraw1394.
  989. .PP
  990. Requires the configure option \f(CW\*(C`\-\-enable\-libdc1394\*(C'\fR.
  991. .Sh "openal"
  992. .IX Subsection "openal"
  993. The OpenAL input device provides audio capture on all systems with a
  994. working OpenAL 1.1 implementation.
  995. .PP
  996. To enable this input device during configuration, you need OpenAL
  997. headers and libraries installed on your system, and need to configure
  998. FFmpeg with \f(CW\*(C`\-\-enable\-openal\*(C'\fR.
  999. .PP
  1000. OpenAL headers and libraries should be provided as part of your OpenAL
  1001. implementation, or as an additional download (an \s-1SDK\s0). Depending on your
  1002. installation you may need to specify additional flags via the
  1003. \&\f(CW\*(C`\-\-extra\-cflags\*(C'\fR and \f(CW\*(C`\-\-extra\-ldflags\*(C'\fR for allowing the build
  1004. system to locate the OpenAL headers and libraries.
  1005. .PP
  1006. An incomplete list of OpenAL implementations follows:
  1007. .IP "\fBCreative\fR" 4
  1008. .IX Item "Creative"
  1009. The official Windows implementation, providing hardware acceleration
  1010. with supported devices and software fallback.
  1011. See <\fBhttp://openal.org/\fR>.
  1012. .IP "\fBOpenAL Soft\fR" 4
  1013. .IX Item "OpenAL Soft"
  1014. Portable, open source (\s-1LGPL\s0) software implementation. Includes
  1015. backends for the most common sound APIs on the Windows, Linux,
  1016. Solaris, and \s-1BSD\s0 operating systems.
  1017. See <\fBhttp://kcat.strangesoft.net/openal.html\fR>.
  1018. .IP "\fBApple\fR" 4
  1019. .IX Item "Apple"
  1020. OpenAL is part of Core Audio, the official Mac \s-1OS\s0 X Audio interface.
  1021. See <\fBhttp://developer.apple.com/technologies/mac/audio\-and\-video.html\fR>
  1022. .PP
  1023. This device allows one to capture from an audio input device handled
  1024. through OpenAL.
  1025. .PP
  1026. You need to specify the name of the device to capture in the provided
  1027. filename. If the empty string is provided, the device will
  1028. automatically select the default device. You can get the list of the
  1029. supported devices by using the option \fIlist_devices\fR.
  1030. .PP
  1031. \fIOptions\fR
  1032. .IX Subsection "Options"
  1033. .IP "\fBchannels\fR" 4
  1034. .IX Item "channels"
  1035. Set the number of channels in the captured audio. Only the values
  1036. \&\fB1\fR (monaural) and \fB2\fR (stereo) are currently supported.
  1037. Defaults to \fB2\fR.
  1038. .IP "\fBsample_size\fR" 4
  1039. .IX Item "sample_size"
  1040. Set the sample size (in bits) of the captured audio. Only the values
  1041. \&\fB8\fR and \fB16\fR are currently supported. Defaults to
  1042. \&\fB16\fR.
  1043. .IP "\fBsample_rate\fR" 4
  1044. .IX Item "sample_rate"
  1045. Set the sample rate (in Hz) of the captured audio.
  1046. Defaults to \fB44.1k\fR.
  1047. .IP "\fBlist_devices\fR" 4
  1048. .IX Item "list_devices"
  1049. If set to \fBtrue\fR, print a list of devices and exit.
  1050. Defaults to \fBfalse\fR.
  1051. .PP
  1052. \fIExamples\fR
  1053. .IX Subsection "Examples"
  1054. .PP
  1055. Print the list of OpenAL supported devices and exit:
  1056. .PP
  1057. .Vb 1
  1058. \&        $ ffmpeg -list_devices true -f openal -i dummy out.ogg
  1059. .Ve
  1060. .PP
  1061. Capture from the OpenAL device \fI\s-1DR\-BT101\s0 via PulseAudio\fR:
  1062. .PP
  1063. .Vb 1
  1064. \&        $ ffmpeg -f openal -i 'DR-BT101 via PulseAudio' out.ogg
  1065. .Ve
  1066. .PP
  1067. Capture from the default device (note the empty string '' as filename):
  1068. .PP
  1069. .Vb 1
  1070. \&        $ ffmpeg -f openal -i '' out.ogg
  1071. .Ve
  1072. .PP
  1073. Capture from two devices simultaneously, writing to two different files,
  1074. within the same \fBffmpeg\fR command:
  1075. .PP
  1076. .Vb 1
  1077. \&        $ ffmpeg -f openal -i 'DR-BT101 via PulseAudio' out1.ogg -f openal -i 'ALSA Default' out2.ogg
  1078. .Ve
  1079. .PP
  1080. Note: not all OpenAL implementations support multiple simultaneous capture \-
  1081. try the latest OpenAL Soft if the above does not work.
  1082. .Sh "oss"
  1083. .IX Subsection "oss"
  1084. Open Sound System input device.
  1085. .PP
  1086. The filename to provide to the input device is the device node
  1087. representing the \s-1OSS\s0 input device, and is usually set to
  1088. \&\fI/dev/dsp\fR.
  1089. .PP
  1090. For example to grab from \fI/dev/dsp\fR using \fBffmpeg\fR use the
  1091. command:
  1092. .PP
  1093. .Vb 1
  1094. \&        ffmpeg -f oss -i /dev/dsp /tmp/oss.wav
  1095. .Ve
  1096. .PP
  1097. For more information about \s-1OSS\s0 see:
  1098. <\fBhttp://manuals.opensound.com/usersguide/dsp.html\fR>
  1099. .PP
  1100. \fIOptions\fR
  1101. .IX Subsection "Options"
  1102. .IP "\fBsample_rate\fR" 4
  1103. .IX Item "sample_rate"
  1104. Set the sample rate in Hz. Default is 48000.
  1105. .IP "\fBchannels\fR" 4
  1106. .IX Item "channels"
  1107. Set the number of channels. Default is 2.
  1108. .Sh "pulse"
  1109. .IX Subsection "pulse"
  1110. PulseAudio input device.
  1111. .PP
  1112. To enable this output device you need to configure FFmpeg with \f(CW\*(C`\-\-enable\-libpulse\*(C'\fR.
  1113. .PP
  1114. The filename to provide to the input device is a source device or the
  1115. string \*(L"default\*(R"
  1116. .PP
  1117. To list the PulseAudio source devices and their properties you can invoke
  1118. the command \fBpactl list sources\fR.
  1119. .PP
  1120. More information about PulseAudio can be found on <\fBhttp://www.pulseaudio.org\fR>.
  1121. .PP
  1122. \fIOptions\fR
  1123. .IX Subsection "Options"
  1124. .IP "\fBserver\fR" 4
  1125. .IX Item "server"
  1126. Connect to a specific PulseAudio server, specified by an \s-1IP\s0 address.
  1127. Default server is used when not provided.
  1128. .IP "\fBname\fR" 4
  1129. .IX Item "name"
  1130. Specify the application name PulseAudio will use when showing active clients,
  1131. by default it is the \f(CW\*(C`LIBAVFORMAT_IDENT\*(C'\fR string.
  1132. .IP "\fBstream_name\fR" 4
  1133. .IX Item "stream_name"
  1134. Specify the stream name PulseAudio will use when showing active streams,
  1135. by default it is \*(L"record\*(R".
  1136. .IP "\fBsample_rate\fR" 4
  1137. .IX Item "sample_rate"
  1138. Specify the samplerate in Hz, by default 48kHz is used.
  1139. .IP "\fBchannels\fR" 4
  1140. .IX Item "channels"
  1141. Specify the channels in use, by default 2 (stereo) is set.
  1142. .IP "\fBframe_size\fR" 4
  1143. .IX Item "frame_size"
  1144. Specify the number of bytes per frame, by default it is set to 1024.
  1145. .IP "\fBfragment_size\fR" 4
  1146. .IX Item "fragment_size"
  1147. Specify the minimal buffering fragment in PulseAudio, it will affect the
  1148. audio latency. By default it is unset.
  1149. .IP "\fBwallclock\fR" 4
  1150. .IX Item "wallclock"
  1151. Set the initial \s-1PTS\s0 using the current time. Default is 1.
  1152. .PP
  1153. \fIExamples\fR
  1154. .IX Subsection "Examples"
  1155. .PP
  1156. Record a stream from default device:
  1157. .PP
  1158. .Vb 1
  1159. \&        ffmpeg -f pulse -i default /tmp/pulse.wav
  1160. .Ve
  1161. .Sh "qtkit"
  1162. .IX Subsection "qtkit"
  1163. QTKit input device.
  1164. .PP
  1165. The filename passed as input is parsed to contain either a device name or index.
  1166. The device index can also be given by using \-video_device_index.
  1167. A given device index will override any given device name.
  1168. If the desired device consists of numbers only, use \-video_device_index to identify it.
  1169. The default device will be chosen if an empty string  or the device name \*(L"default\*(R" is given.
  1170. The available devices can be enumerated by using \-list_devices.
  1171. .PP
  1172. .Vb 1
  1173. \&        ffmpeg -f qtkit -i "0" out.mpg
  1174. .Ve
  1175. .PP
  1176. .Vb 1
  1177. \&        ffmpeg -f qtkit -video_device_index 0 -i "" out.mpg
  1178. .Ve
  1179. .PP
  1180. .Vb 1
  1181. \&        ffmpeg -f qtkit -i "default" out.mpg
  1182. .Ve
  1183. .PP
  1184. .Vb 1
  1185. \&        ffmpeg -f qtkit -list_devices true -i ""
  1186. .Ve
  1187. .PP
  1188. \fIOptions\fR
  1189. .IX Subsection "Options"
  1190. .IP "\fBframe_rate\fR" 4
  1191. .IX Item "frame_rate"
  1192. Set frame rate. Default is 30.
  1193. .IP "\fBlist_devices\fR" 4
  1194. .IX Item "list_devices"
  1195. If set to \f(CW\*(C`true\*(C'\fR, print a list of devices and exit. Default is
  1196. \&\f(CW\*(C`false\*(C'\fR.
  1197. .IP "\fBvideo_device_index\fR" 4
  1198. .IX Item "video_device_index"
  1199. Select the video device by index for devices with the same name (starts at 0).
  1200. .Sh "sndio"
  1201. .IX Subsection "sndio"
  1202. sndio input device.
  1203. .PP
  1204. To enable this input device during configuration you need libsndio
  1205. installed on your system.
  1206. .PP
  1207. The filename to provide to the input device is the device node
  1208. representing the sndio input device, and is usually set to
  1209. \&\fI/dev/audio0\fR.
  1210. .PP
  1211. For example to grab from \fI/dev/audio0\fR using \fBffmpeg\fR use the
  1212. command:
  1213. .PP
  1214. .Vb 1
  1215. \&        ffmpeg -f sndio -i /dev/audio0 /tmp/oss.wav
  1216. .Ve
  1217. .PP
  1218. \fIOptions\fR
  1219. .IX Subsection "Options"
  1220. .IP "\fBsample_rate\fR" 4
  1221. .IX Item "sample_rate"
  1222. Set the sample rate in Hz. Default is 48000.
  1223. .IP "\fBchannels\fR" 4
  1224. .IX Item "channels"
  1225. Set the number of channels. Default is 2.
  1226. .Sh "video4linux2, v4l2"
  1227. .IX Subsection "video4linux2, v4l2"
  1228. Video4Linux2 input video device.
  1229. .PP
  1230. \&\*(L"v4l2\*(R" can be used as alias for \*(L"video4linux2\*(R".
  1231. .PP
  1232. If FFmpeg is built with v4l\-utils support (by using the
  1233. \&\f(CW\*(C`\-\-enable\-libv4l2\*(C'\fR configure option), it is possible to use it with the
  1234. \&\f(CW\*(C`\-use_libv4l2\*(C'\fR input device option.
  1235. .PP
  1236. The name of the device to grab is a file device node, usually Linux
  1237. systems tend to automatically create such nodes when the device
  1238. (e.g. an \s-1USB\s0 webcam) is plugged into the system, and has a name of the
  1239. kind \fI/dev/video\fIN\fI\fR, where \fIN\fR is a number associated to
  1240. the device.
  1241. .PP
  1242. Video4Linux2 devices usually support a limited set of
  1243. \&\fIwidth\fRx\fIheight\fR sizes and frame rates. You can check which are
  1244. supported using \fB\-list_formats all\fR for Video4Linux2 devices.
  1245. Some devices, like \s-1TV\s0 cards, support one or more standards. It is possible
  1246. to list all the supported standards using \fB\-list_standards all\fR.
  1247. .PP
  1248. The time base for the timestamps is 1 microsecond. Depending on the kernel
  1249. version and configuration, the timestamps may be derived from the real time
  1250. clock (origin at the Unix Epoch) or the monotonic clock (origin usually at
  1251. boot time, unaffected by \s-1NTP\s0 or manual changes to the clock). The
  1252. \&\fB\-timestamps abs\fR or \fB\-ts abs\fR option can be used to force
  1253. conversion into the real time clock.
  1254. .PP
  1255. Some usage examples of the video4linux2 device with \fBffmpeg\fR
  1256. and \fBffplay\fR:
  1257. .IP "\(bu" 4
  1258. List supported formats for a video4linux2 device:
  1259. .Sp
  1260. .Vb 1
  1261. \&        ffplay -f video4linux2 -list_formats all /dev/video0
  1262. .Ve
  1263. .IP "\(bu" 4
  1264. Grab and show the input of a video4linux2 device:
  1265. .Sp
  1266. .Vb 1
  1267. \&        ffplay -f video4linux2 -framerate 30 -video_size hd720 /dev/video0
  1268. .Ve
  1269. .IP "\(bu" 4
  1270. Grab and record the input of a video4linux2 device, leave the
  1271. frame rate and size as previously set:
  1272. .Sp
  1273. .Vb 1
  1274. \&        ffmpeg -f video4linux2 -input_format mjpeg -i /dev/video0 out.mpeg
  1275. .Ve
  1276. .PP
  1277. For more information about Video4Linux, check <\fBhttp://linuxtv.org/\fR>.
  1278. .PP
  1279. \fIOptions\fR
  1280. .IX Subsection "Options"
  1281. .IP "\fBstandard\fR" 4
  1282. .IX Item "standard"
  1283. Set the standard. Must be the name of a supported standard. To get a
  1284. list of the supported standards, use the \fBlist_standards\fR
  1285. option.
  1286. .IP "\fBchannel\fR" 4
  1287. .IX Item "channel"
  1288. Set the input channel number. Default to \-1, which means using the
  1289. previously selected channel.
  1290. .IP "\fBvideo_size\fR" 4
  1291. .IX Item "video_size"
  1292. Set the video frame size. The argument must be a string in the form
  1293. \&\fI\s-1WIDTH\s0\fRx\fI\s-1HEIGHT\s0\fR or a valid size abbreviation.
  1294. .IP "\fBpixel_format\fR" 4
  1295. .IX Item "pixel_format"
  1296. Select the pixel format (only valid for raw video input).
  1297. .IP "\fBinput_format\fR" 4
  1298. .IX Item "input_format"
  1299. Set the preferred pixel format (for raw video) or a codec name.
  1300. This option allows one to select the input format, when several are
  1301. available.
  1302. .IP "\fBframerate\fR" 4
  1303. .IX Item "framerate"
  1304. Set the preferred video frame rate.
  1305. .IP "\fBlist_formats\fR" 4
  1306. .IX Item "list_formats"
  1307. List available formats (supported pixel formats, codecs, and frame
  1308. sizes) and exit.
  1309. .Sp
  1310. Available values are:
  1311. .RS 4
  1312. .IP "\fBall\fR" 4
  1313. .IX Item "all"
  1314. Show all available (compressed and non\-compressed) formats.
  1315. .IP "\fBraw\fR" 4
  1316. .IX Item "raw"
  1317. Show only raw video (non\-compressed) formats.
  1318. .IP "\fBcompressed\fR" 4
  1319. .IX Item "compressed"
  1320. Show only compressed formats.
  1321. .RE
  1322. .RS 4
  1323. .RE
  1324. .IP "\fBlist_standards\fR" 4
  1325. .IX Item "list_standards"
  1326. List supported standards and exit.
  1327. .Sp
  1328. Available values are:
  1329. .RS 4
  1330. .IP "\fBall\fR" 4
  1331. .IX Item "all"
  1332. Show all supported standards.
  1333. .RE
  1334. .RS 4
  1335. .RE
  1336. .IP "\fBtimestamps, ts\fR" 4
  1337. .IX Item "timestamps, ts"
  1338. Set type of timestamps for grabbed frames.
  1339. .Sp
  1340. Available values are:
  1341. .RS 4
  1342. .IP "\fBdefault\fR" 4
  1343. .IX Item "default"
  1344. Use timestamps from the kernel.
  1345. .IP "\fBabs\fR" 4
  1346. .IX Item "abs"
  1347. Use absolute timestamps (wall clock).
  1348. .IP "\fBmono2abs\fR" 4
  1349. .IX Item "mono2abs"
  1350. Force conversion from monotonic to absolute timestamps.
  1351. .RE
  1352. .RS 4
  1353. .Sp
  1354. Default value is \f(CW\*(C`default\*(C'\fR.
  1355. .RE
  1356. .IP "\fBuse_libv4l2\fR" 4
  1357. .IX Item "use_libv4l2"
  1358. Use libv4l2 (v4l\-utils) conversion functions. Default is 0.
  1359. .Sh "vfwcap"
  1360. .IX Subsection "vfwcap"
  1361. VfW (Video for Windows) capture input device.
  1362. .PP
  1363. The filename passed as input is the capture driver number, ranging from
  1364. 0 to 9. You may use \*(L"list\*(R" as filename to print a list of drivers. Any
  1365. other filename will be interpreted as device number 0.
  1366. .PP
  1367. \fIOptions\fR
  1368. .IX Subsection "Options"
  1369. .IP "\fBvideo_size\fR" 4
  1370. .IX Item "video_size"
  1371. Set the video frame size.
  1372. .IP "\fBframerate\fR" 4
  1373. .IX Item "framerate"
  1374. Set the grabbing frame rate. Default value is \f(CW\*(C`ntsc\*(C'\fR,
  1375. corresponding to a frame rate of \f(CW\*(C`30000/1001\*(C'\fR.
  1376. .Sh "x11grab"
  1377. .IX Subsection "x11grab"
  1378. X11 video input device.
  1379. .PP
  1380. To enable this input device during configuration you need libxcb
  1381. installed on your system. It will be automatically detected during
  1382. configuration.
  1383. .PP
  1384. Alternatively, the configure option \fB\-\-enable\-x11grab\fR exists
  1385. for legacy Xlib users.
  1386. .PP
  1387. This device allows one to capture a region of an X11 display.
  1388. .PP
  1389. The filename passed as input has the syntax:
  1390. .PP
  1391. .Vb 1
  1392. \&        [<hostname>]:<display_number>.<screen_number>[+<x_offset>,<y_offset>]
  1393. .Ve
  1394. .PP
  1395. \&\fIhostname\fR:\fIdisplay_number\fR.\fIscreen_number\fR specifies the
  1396. X11 display name of the screen to grab from. \fIhostname\fR can be
  1397. omitted, and defaults to \*(L"localhost\*(R". The environment variable
  1398. \&\fB\s-1DISPLAY\s0\fR contains the default display name.
  1399. .PP
  1400. \&\fIx_offset\fR and \fIy_offset\fR specify the offsets of the grabbed
  1401. area with respect to the top-left border of the X11 screen. They
  1402. default to 0.
  1403. .PP
  1404. Check the X11 documentation (e.g. \fBman X\fR) for more detailed
  1405. information.
  1406. .PP
  1407. Use the \fBxdpyinfo\fR program for getting basic information about
  1408. the properties of your X11 display (e.g. grep for \*(L"name\*(R" or
  1409. \&\*(L"dimensions\*(R").
  1410. .PP
  1411. For example to grab from \fI:0.0\fR using \fBffmpeg\fR:
  1412. .PP
  1413. .Vb 1
  1414. \&        ffmpeg -f x11grab -framerate 25 -video_size cif -i :0.0 out.mpg
  1415. .Ve
  1416. .PP
  1417. Grab at position \f(CW\*(C`10,20\*(C'\fR:
  1418. .PP
  1419. .Vb 1
  1420. \&        ffmpeg -f x11grab -framerate 25 -video_size cif -i :0.0+10,20 out.mpg
  1421. .Ve
  1422. .PP
  1423. \fIOptions\fR
  1424. .IX Subsection "Options"
  1425. .IP "\fBdraw_mouse\fR" 4
  1426. .IX Item "draw_mouse"
  1427. Specify whether to draw the mouse pointer. A value of \f(CW0\fR specify
  1428. not to draw the pointer. Default value is \f(CW1\fR.
  1429. .IP "\fBfollow_mouse\fR" 4
  1430. .IX Item "follow_mouse"
  1431. Make the grabbed area follow the mouse. The argument can be
  1432. \&\f(CW\*(C`centered\*(C'\fR or a number of pixels \fI\s-1PIXELS\s0\fR.
  1433. .Sp
  1434. When it is specified with \*(L"centered\*(R", the grabbing region follows the mouse
  1435. pointer and keeps the pointer at the center of region; otherwise, the region
  1436. follows only when the mouse pointer reaches within \fI\s-1PIXELS\s0\fR (greater than
  1437. zero) to the edge of region.
  1438. .Sp
  1439. For example:
  1440. .Sp
  1441. .Vb 1
  1442. \&        ffmpeg -f x11grab -follow_mouse centered -framerate 25 -video_size cif -i :0.0 out.mpg
  1443. .Ve
  1444. .Sp
  1445. To follow only when the mouse pointer reaches within 100 pixels to edge:
  1446. .Sp
  1447. .Vb 1
  1448. \&        ffmpeg -f x11grab -follow_mouse 100 -framerate 25 -video_size cif -i :0.0 out.mpg
  1449. .Ve
  1450. .IP "\fBframerate\fR" 4
  1451. .IX Item "framerate"
  1452. Set the grabbing frame rate. Default value is \f(CW\*(C`ntsc\*(C'\fR,
  1453. corresponding to a frame rate of \f(CW\*(C`30000/1001\*(C'\fR.
  1454. .IP "\fBshow_region\fR" 4
  1455. .IX Item "show_region"
  1456. Show grabbed region on screen.
  1457. .Sp
  1458. If \fIshow_region\fR is specified with \f(CW1\fR, then the grabbing
  1459. region will be indicated on screen. With this option, it is easy to
  1460. know what is being grabbed if only a portion of the screen is grabbed.
  1461. .IP "\fBregion_border\fR" 4
  1462. .IX Item "region_border"
  1463. Set the region border thickness if \fB\-show_region 1\fR is used.
  1464. Range is 1 to 128 and default is 3 (XCB\-based x11grab only).
  1465. .Sp
  1466. For example:
  1467. .Sp
  1468. .Vb 1
  1469. \&        ffmpeg -f x11grab -show_region 1 -framerate 25 -video_size cif -i :0.0+10,20 out.mpg
  1470. .Ve
  1471. .Sp
  1472. With \fIfollow_mouse\fR:
  1473. .Sp
  1474. .Vb 1
  1475. \&        ffmpeg -f x11grab -follow_mouse centered -show_region 1 -framerate 25 -video_size cif -i :0.0 out.mpg
  1476. .Ve
  1477. .IP "\fBvideo_size\fR" 4
  1478. .IX Item "video_size"
  1479. Set the video frame size. Default value is \f(CW\*(C`vga\*(C'\fR.
  1480. .IP "\fBuse_shm\fR" 4
  1481. .IX Item "use_shm"
  1482. Use the MIT-SHM extension for shared memory. Default value is \f(CW1\fR.
  1483. It may be necessary to disable it for remote displays (legacy x11grab
  1484. only).
  1485. .PP
  1486. \fI\fIgrab_x\fI \fIgrab_y\fI AVOption\fR
  1487. .IX Subsection "grab_x grab_y AVOption"
  1488. .PP
  1489. The syntax is:
  1490. .PP
  1491. .Vb 1
  1492. \&        -grab_x <x_offset> -grab_y <y_offset>
  1493. .Ve
  1494. .PP
  1495. Set the grabbing region coordinates. They are expressed as offset from the top left
  1496. corner of the X11 window. The default value is 0.
  1497. .SH "OUTPUT DEVICES"
  1498. .IX Header "OUTPUT DEVICES"
  1499. Output devices are configured elements in FFmpeg that can write
  1500. multimedia data to an output device attached to your system.
  1501. .PP
  1502. When you configure your FFmpeg build, all the supported output devices
  1503. are enabled by default. You can list all available ones using the
  1504. configure option \*(L"\-\-list\-outdevs\*(R".
  1505. .PP
  1506. You can disable all the output devices using the configure option
  1507. \&\*(L"\-\-disable\-outdevs\*(R", and selectively enable an output device using the
  1508. option "\-\-enable\-outdev=\fI\s-1OUTDEV\s0\fR\*(L", or you can disable a particular
  1509. input device using the option \*(R"\-\-disable\-outdev=\fI\s-1OUTDEV\s0\fR".
  1510. .PP
  1511. The option \*(L"\-devices\*(R" of the ff* tools will display the list of
  1512. enabled output devices.
  1513. .PP
  1514. A description of the currently available output devices follows.
  1515. .Sh "alsa"
  1516. .IX Subsection "alsa"
  1517. \&\s-1ALSA\s0 (Advanced Linux Sound Architecture) output device.
  1518. .PP
  1519. \fIExamples\fR
  1520. .IX Subsection "Examples"
  1521. .IP "\(bu" 4
  1522. Play a file on default \s-1ALSA\s0 device:
  1523. .Sp
  1524. .Vb 1
  1525. \&        ffmpeg -i INPUT -f alsa default
  1526. .Ve
  1527. .IP "\(bu" 4
  1528. Play a file on soundcard 1, audio device 7:
  1529. .Sp
  1530. .Vb 1
  1531. \&        ffmpeg -i INPUT -f alsa hw:1,7
  1532. .Ve
  1533. .Sh "caca"
  1534. .IX Subsection "caca"
  1535. \&\s-1CACA\s0 output device.
  1536. .PP
  1537. This output device allows one to show a video stream in \s-1CACA\s0 window.
  1538. Only one \s-1CACA\s0 window is allowed per application, so you can
  1539. have only one instance of this output device in an application.
  1540. .PP
  1541. To enable this output device you need to configure FFmpeg with
  1542. \&\f(CW\*(C`\-\-enable\-libcaca\*(C'\fR.
  1543. libcaca is a graphics library that outputs text instead of pixels.
  1544. .PP
  1545. For more information about libcaca, check:
  1546. <\fBhttp://caca.zoy.org/wiki/libcaca\fR>
  1547. .PP
  1548. \fIOptions\fR
  1549. .IX Subsection "Options"
  1550. .IP "\fBwindow_title\fR" 4
  1551. .IX Item "window_title"
  1552. Set the \s-1CACA\s0 window title, if not specified default to the filename
  1553. specified for the output device.
  1554. .IP "\fBwindow_size\fR" 4
  1555. .IX Item "window_size"
  1556. Set the \s-1CACA\s0 window size, can be a string of the form
  1557. \&\fIwidth\fRx\fIheight\fR or a video size abbreviation.
  1558. If not specified it defaults to the size of the input video.
  1559. .IP "\fBdriver\fR" 4
  1560. .IX Item "driver"
  1561. Set display driver.
  1562. .IP "\fBalgorithm\fR" 4
  1563. .IX Item "algorithm"
  1564. Set dithering algorithm. Dithering is necessary
  1565. because the picture being rendered has usually far more colours than
  1566. the available palette.
  1567. The accepted values are listed with \f(CW\*(C`\-list_dither algorithms\*(C'\fR.
  1568. .IP "\fBantialias\fR" 4
  1569. .IX Item "antialias"
  1570. Set antialias method. Antialiasing smoothens the rendered
  1571. image and avoids the commonly seen staircase effect.
  1572. The accepted values are listed with \f(CW\*(C`\-list_dither antialiases\*(C'\fR.
  1573. .IP "\fBcharset\fR" 4
  1574. .IX Item "charset"
  1575. Set which characters are going to be used when rendering text.
  1576. The accepted values are listed with \f(CW\*(C`\-list_dither charsets\*(C'\fR.
  1577. .IP "\fBcolor\fR" 4
  1578. .IX Item "color"
  1579. Set color to be used when rendering text.
  1580. The accepted values are listed with \f(CW\*(C`\-list_dither colors\*(C'\fR.
  1581. .IP "\fBlist_drivers\fR" 4
  1582. .IX Item "list_drivers"
  1583. If set to \fBtrue\fR, print a list of available drivers and exit.
  1584. .IP "\fBlist_dither\fR" 4
  1585. .IX Item "list_dither"
  1586. List available dither options related to the argument.
  1587. The argument must be one of \f(CW\*(C`algorithms\*(C'\fR, \f(CW\*(C`antialiases\*(C'\fR,
  1588. \&\f(CW\*(C`charsets\*(C'\fR, \f(CW\*(C`colors\*(C'\fR.
  1589. .PP
  1590. \fIExamples\fR
  1591. .IX Subsection "Examples"
  1592. .IP "\(bu" 4
  1593. The following command shows the \fBffmpeg\fR output is an
  1594. \&\s-1CACA\s0 window, forcing its size to 80x25:
  1595. .Sp
  1596. .Vb 1
  1597. \&        ffmpeg -i INPUT -vcodec rawvideo -pix_fmt rgb24 -window_size 80x25 -f caca -
  1598. .Ve
  1599. .IP "\(bu" 4
  1600. Show the list of available drivers and exit:
  1601. .Sp
  1602. .Vb 1
  1603. \&        ffmpeg -i INPUT -pix_fmt rgb24 -f caca -list_drivers true -
  1604. .Ve
  1605. .IP "\(bu" 4
  1606. Show the list of available dither colors and exit:
  1607. .Sp
  1608. .Vb 1
  1609. \&        ffmpeg -i INPUT -pix_fmt rgb24 -f caca -list_dither colors -
  1610. .Ve
  1611. .Sh "decklink"
  1612. .IX Subsection "decklink"
  1613. The decklink output device provides playback capabilities for Blackmagic
  1614. DeckLink devices.
  1615. .PP
  1616. To enable this output device, you need the Blackmagic DeckLink \s-1SDK\s0 and you
  1617. need to configure with the appropriate \f(CW\*(C`\-\-extra\-cflags\*(C'\fR
  1618. and \f(CW\*(C`\-\-extra\-ldflags\*(C'\fR.
  1619. On Windows, you need to run the \s-1IDL\s0 files through \fBwidl\fR.
  1620. .PP
  1621. DeckLink is very picky about the formats it supports. Pixel format is always
  1622. uyvy422, framerate and video size must be determined for your device with
  1623. \&\fB\-list_formats 1\fR. Audio sample rate is always 48 kHz.
  1624. .PP
  1625. \fIOptions\fR
  1626. .IX Subsection "Options"
  1627. .IP "\fBlist_devices\fR" 4
  1628. .IX Item "list_devices"
  1629. If set to \fBtrue\fR, print a list of devices and exit.
  1630. Defaults to \fBfalse\fR.
  1631. .IP "\fBlist_formats\fR" 4
  1632. .IX Item "list_formats"
  1633. If set to \fBtrue\fR, print a list of supported formats and exit.
  1634. Defaults to \fBfalse\fR.
  1635. .IP "\fBpreroll\fR" 4
  1636. .IX Item "preroll"
  1637. Amount of time to preroll video in seconds.
  1638. Defaults to \fB0.5\fR.
  1639. .PP
  1640. \fIExamples\fR
  1641. .IX Subsection "Examples"
  1642. .IP "\(bu" 4
  1643. List output devices:
  1644. .Sp
  1645. .Vb 1
  1646. \&        ffmpeg -i test.avi -f decklink -list_devices 1 dummy
  1647. .Ve
  1648. .IP "\(bu" 4
  1649. List supported formats:
  1650. .Sp
  1651. .Vb 1
  1652. \&        ffmpeg -i test.avi -f decklink -list_formats 1 'DeckLink Mini Monitor'
  1653. .Ve
  1654. .IP "\(bu" 4
  1655. Play video clip:
  1656. .Sp
  1657. .Vb 1
  1658. \&        ffmpeg -i test.avi -f decklink -pix_fmt uyvy422 'DeckLink Mini Monitor'
  1659. .Ve
  1660. .IP "\(bu" 4
  1661. Play video clip with non-standard framerate or video size:
  1662. .Sp
  1663. .Vb 1
  1664. \&        ffmpeg -i test.avi -f decklink -pix_fmt uyvy422 -s 720x486 -r 24000/1001 'DeckLink Mini Monitor'
  1665. .Ve
  1666. .Sh "fbdev"
  1667. .IX Subsection "fbdev"
  1668. Linux framebuffer output device.
  1669. .PP
  1670. The Linux framebuffer is a graphic hardware-independent abstraction
  1671. layer to show graphics on a computer monitor, typically on the
  1672. console. It is accessed through a file device node, usually
  1673. \&\fI/dev/fb0\fR.
  1674. .PP
  1675. For more detailed information read the file
  1676. \&\fIDocumentation/fb/framebuffer.txt\fR included in the Linux source tree.
  1677. .PP
  1678. \fIOptions\fR
  1679. .IX Subsection "Options"
  1680. .IP "\fBxoffset\fR" 4
  1681. .IX Item "xoffset"
  1682. .PD 0
  1683. .IP "\fByoffset\fR" 4
  1684. .IX Item "yoffset"
  1685. .PD
  1686. Set x/y coordinate of top left corner. Default is 0.
  1687. .PP
  1688. \fIExamples\fR
  1689. .IX Subsection "Examples"
  1690. .PP
  1691. Play a file on framebuffer device \fI/dev/fb0\fR.
  1692. Required pixel format depends on current framebuffer settings.
  1693. .PP
  1694. .Vb 1
  1695. \&        ffmpeg -re -i INPUT -vcodec rawvideo -pix_fmt bgra -f fbdev /dev/fb0
  1696. .Ve
  1697. .PP
  1698. See also <\fBhttp://linux\-fbdev.sourceforge.net/\fR>, and \fIfbset\fR\|(1).
  1699. .Sh "opengl"
  1700. .IX Subsection "opengl"
  1701. OpenGL output device.
  1702. .PP
  1703. To enable this output device you need to configure FFmpeg with \f(CW\*(C`\-\-enable\-opengl\*(C'\fR.
  1704. .PP
  1705. This output device allows one to render to OpenGL context.
  1706. Context may be provided by application or default \s-1SDL\s0 window is created.
  1707. .PP
  1708. When device renders to external context, application must implement handlers for following messages:
  1709. \&\f(CW\*(C`AV_DEV_TO_APP_CREATE_WINDOW_BUFFER\*(C'\fR \- create OpenGL context on current thread.
  1710. \&\f(CW\*(C`AV_DEV_TO_APP_PREPARE_WINDOW_BUFFER\*(C'\fR \- make OpenGL context current.
  1711. \&\f(CW\*(C`AV_DEV_TO_APP_DISPLAY_WINDOW_BUFFER\*(C'\fR \- swap buffers.
  1712. \&\f(CW\*(C`AV_DEV_TO_APP_DESTROY_WINDOW_BUFFER\*(C'\fR \- destroy OpenGL context.
  1713. Application is also required to inform a device about current resolution by sending \f(CW\*(C`AV_APP_TO_DEV_WINDOW_SIZE\*(C'\fR message.
  1714. .PP
  1715. \fIOptions\fR
  1716. .IX Subsection "Options"
  1717. .IP "\fBbackground\fR" 4
  1718. .IX Item "background"
  1719. Set background color. Black is a default.
  1720. .IP "\fBno_window\fR" 4
  1721. .IX Item "no_window"
  1722. Disables default \s-1SDL\s0 window when set to non-zero value.
  1723. Application must provide OpenGL context and both \f(CW\*(C`window_size_cb\*(C'\fR and \f(CW\*(C`window_swap_buffers_cb\*(C'\fR callbacks when set.
  1724. .IP "\fBwindow_title\fR" 4
  1725. .IX Item "window_title"
  1726. Set the \s-1SDL\s0 window title, if not specified default to the filename specified for the output device.
  1727. Ignored when \fBno_window\fR is set.
  1728. .IP "\fBwindow_size\fR" 4
  1729. .IX Item "window_size"
  1730. Set preferred window size, can be a string of the form widthxheight or a video size abbreviation.
  1731. If not specified it defaults to the size of the input video, downscaled according to the aspect ratio.
  1732. Mostly usable when \fBno_window\fR is not set.
  1733. .PP
  1734. \fIExamples\fR
  1735. .IX Subsection "Examples"
  1736. .PP
  1737. Play a file on \s-1SDL\s0 window using OpenGL rendering:
  1738. .PP
  1739. .Vb 1
  1740. \&        ffmpeg  -i INPUT -f opengl "window title"
  1741. .Ve
  1742. .Sh "oss"
  1743. .IX Subsection "oss"
  1744. \&\s-1OSS\s0 (Open Sound System) output device.
  1745. .Sh "pulse"
  1746. .IX Subsection "pulse"
  1747. PulseAudio output device.
  1748. .PP
  1749. To enable this output device you need to configure FFmpeg with \f(CW\*(C`\-\-enable\-libpulse\*(C'\fR.
  1750. .PP
  1751. More information about PulseAudio can be found on <\fBhttp://www.pulseaudio.org\fR>
  1752. .PP
  1753. \fIOptions\fR
  1754. .IX Subsection "Options"
  1755. .IP "\fBserver\fR" 4
  1756. .IX Item "server"
  1757. Connect to a specific PulseAudio server, specified by an \s-1IP\s0 address.
  1758. Default server is used when not provided.
  1759. .IP "\fBname\fR" 4
  1760. .IX Item "name"
  1761. Specify the application name PulseAudio will use when showing active clients,
  1762. by default it is the \f(CW\*(C`LIBAVFORMAT_IDENT\*(C'\fR string.
  1763. .IP "\fBstream_name\fR" 4
  1764. .IX Item "stream_name"
  1765. Specify the stream name PulseAudio will use when showing active streams,
  1766. by default it is set to the specified output name.
  1767. .IP "\fBdevice\fR" 4
  1768. .IX Item "device"
  1769. Specify the device to use. Default device is used when not provided.
  1770. List of output devices can be obtained with command \fBpactl list sinks\fR.
  1771. .IP "\fBbuffer_size\fR" 4
  1772. .IX Item "buffer_size"
  1773. .PD 0
  1774. .IP "\fBbuffer_duration\fR" 4
  1775. .IX Item "buffer_duration"
  1776. .PD
  1777. Control the size and duration of the PulseAudio buffer. A small buffer
  1778. gives more control, but requires more frequent updates.
  1779. .Sp
  1780. \&\fBbuffer_size\fR specifies size in bytes while
  1781. \&\fBbuffer_duration\fR specifies duration in milliseconds.
  1782. .Sp
  1783. When both options are provided then the highest value is used
  1784. (duration is recalculated to bytes using stream parameters). If they
  1785. are set to 0 (which is default), the device will use the default
  1786. PulseAudio duration value. By default PulseAudio set buffer duration
  1787. to around 2 seconds.
  1788. .IP "\fBprebuf\fR" 4
  1789. .IX Item "prebuf"
  1790. Specify pre-buffering size in bytes. The server does not start with
  1791. playback before at least \fBprebuf\fR bytes are available in the
  1792. buffer. By default this option is initialized to the same value as
  1793. \&\fBbuffer_size\fR or \fBbuffer_duration\fR (whichever is bigger).
  1794. .IP "\fBminreq\fR" 4
  1795. .IX Item "minreq"
  1796. Specify minimum request size in bytes. The server does not request less
  1797. than \fBminreq\fR bytes from the client, instead waits until the buffer
  1798. is free enough to request more bytes at once. It is recommended to not set
  1799. this option, which will initialize this to a value that is deemed sensible
  1800. by the server.
  1801. .PP
  1802. \fIExamples\fR
  1803. .IX Subsection "Examples"
  1804. .PP
  1805. Play a file on default device on default server:
  1806. .PP
  1807. .Vb 1
  1808. \&        ffmpeg  -i INPUT -f pulse "stream name"
  1809. .Ve
  1810. .Sh "sdl"
  1811. .IX Subsection "sdl"
  1812. \&\s-1SDL\s0 (Simple DirectMedia Layer) output device.
  1813. .PP
  1814. This output device allows one to show a video stream in an \s-1SDL\s0
  1815. window. Only one \s-1SDL\s0 window is allowed per application, so you can
  1816. have only one instance of this output device in an application.
  1817. .PP
  1818. To enable this output device you need libsdl installed on your system
  1819. when configuring your build.
  1820. .PP
  1821. For more information about \s-1SDL\s0, check:
  1822. <\fBhttp://www.libsdl.org/\fR>
  1823. .PP
  1824. \fIOptions\fR
  1825. .IX Subsection "Options"
  1826. .IP "\fBwindow_title\fR" 4
  1827. .IX Item "window_title"
  1828. Set the \s-1SDL\s0 window title, if not specified default to the filename
  1829. specified for the output device.
  1830. .IP "\fBicon_title\fR" 4
  1831. .IX Item "icon_title"
  1832. Set the name of the iconified \s-1SDL\s0 window, if not specified it is set
  1833. to the same value of \fIwindow_title\fR.
  1834. .IP "\fBwindow_size\fR" 4
  1835. .IX Item "window_size"
  1836. Set the \s-1SDL\s0 window size, can be a string of the form
  1837. \&\fIwidth\fRx\fIheight\fR or a video size abbreviation.
  1838. If not specified it defaults to the size of the input video,
  1839. downscaled according to the aspect ratio.
  1840. .IP "\fBwindow_fullscreen\fR" 4
  1841. .IX Item "window_fullscreen"
  1842. Set fullscreen mode when non-zero value is provided.
  1843. Default value is zero.
  1844. .PP
  1845. \fIInteractive commands\fR
  1846. .IX Subsection "Interactive commands"
  1847. .PP
  1848. The window created by the device can be controlled through the
  1849. following interactive commands.
  1850. .IP "\fBq, \s-1ESC\s0\fR" 4
  1851. .IX Item "q, ESC"
  1852. Quit the device immediately.
  1853. .PP
  1854. \fIExamples\fR
  1855. .IX Subsection "Examples"
  1856. .PP
  1857. The following command shows the \fBffmpeg\fR output is an
  1858. \&\s-1SDL\s0 window, forcing its size to the qcif format:
  1859. .PP
  1860. .Vb 1
  1861. \&        ffmpeg -i INPUT -vcodec rawvideo -pix_fmt yuv420p -window_size qcif -f sdl "SDL output"
  1862. .Ve
  1863. .Sh "sndio"
  1864. .IX Subsection "sndio"
  1865. sndio audio output device.
  1866. .Sh "xv"
  1867. .IX Subsection "xv"
  1868. \&\s-1XV\s0 (XVideo) output device.
  1869. .PP
  1870. This output device allows one to show a video stream in a X Window System
  1871. window.
  1872. .PP
  1873. \fIOptions\fR
  1874. .IX Subsection "Options"
  1875. .IP "\fBdisplay_name\fR" 4
  1876. .IX Item "display_name"
  1877. Specify the hardware display name, which determines the display and
  1878. communications domain to be used.
  1879. .Sp
  1880. The display name or \s-1DISPLAY\s0 environment variable can be a string in
  1881. the format \fIhostname\fR[:\fInumber\fR[.\fIscreen_number\fR]].
  1882. .Sp
  1883. \&\fIhostname\fR specifies the name of the host machine on which the
  1884. display is physically attached. \fInumber\fR specifies the number of
  1885. the display server on that host machine. \fIscreen_number\fR specifies
  1886. the screen to be used on that server.
  1887. .Sp
  1888. If unspecified, it defaults to the value of the \s-1DISPLAY\s0 environment
  1889. variable.
  1890. .Sp
  1891. For example, \f(CW\*(C`dual\-headed:0.1\*(C'\fR would specify screen 1 of display
  1892. 0 on the machine named ``dual\-headed''.
  1893. .Sp
  1894. Check the X11 specification for more detailed information about the
  1895. display name format.
  1896. .IP "\fBwindow_id\fR" 4
  1897. .IX Item "window_id"
  1898. When set to non-zero value then device doesn't create new window,
  1899. but uses existing one with provided \fIwindow_id\fR. By default
  1900. this options is set to zero and device creates its own window.
  1901. .IP "\fBwindow_size\fR" 4
  1902. .IX Item "window_size"
  1903. Set the created window size, can be a string of the form
  1904. \&\fIwidth\fRx\fIheight\fR or a video size abbreviation. If not
  1905. specified it defaults to the size of the input video.
  1906. Ignored when \fIwindow_id\fR is set.
  1907. .IP "\fBwindow_x\fR" 4
  1908. .IX Item "window_x"
  1909. .PD 0
  1910. .IP "\fBwindow_y\fR" 4
  1911. .IX Item "window_y"
  1912. .PD
  1913. Set the X and Y window offsets for the created window. They are both
  1914. set to 0 by default. The values may be ignored by the window manager.
  1915. Ignored when \fIwindow_id\fR is set.
  1916. .IP "\fBwindow_title\fR" 4
  1917. .IX Item "window_title"
  1918. Set the window title, if not specified default to the filename
  1919. specified for the output device. Ignored when \fIwindow_id\fR is set.
  1920. .PP
  1921. For more information about XVideo see <\fBhttp://www.x.org/\fR>.
  1922. .PP
  1923. \fIExamples\fR
  1924. .IX Subsection "Examples"
  1925. .IP "\(bu" 4
  1926. Decode, display and encode video input with \fBffmpeg\fR at the
  1927. same time:
  1928. .Sp
  1929. .Vb 1
  1930. \&        ffmpeg -i INPUT OUTPUT -f xv display
  1931. .Ve
  1932. .IP "\(bu" 4
  1933. Decode and display the input video to multiple X11 windows:
  1934. .Sp
  1935. .Vb 1
  1936. \&        ffmpeg -i INPUT -f xv normal -vf negate -f xv negated
  1937. .Ve
  1938. .SH "SEE ALSO"
  1939. .IX Header "SEE ALSO"
  1940. \&\fIffmpeg\fR\|(1), \fIffplay\fR\|(1), \fIffprobe\fR\|(1), \fIffserver\fR\|(1), \fIlibavdevice\fR\|(3)
  1941. .SH "AUTHORS"
  1942. .IX Header "AUTHORS"
  1943. The FFmpeg developers.
  1944. .PP
  1945. For details about the authorship, see the Git history of the project
  1946. (git://source.ffmpeg.org/ffmpeg), e.g. by typing the command
  1947. \&\fBgit log\fR in the FFmpeg source directory, or browsing the
  1948. online repository at <\fBhttp://source.ffmpeg.org\fR>.
  1949. .PP
  1950. Maintainers for the specific components are listed in the file
  1951. \&\fI\s-1MAINTAINERS\s0\fR in the source code tree.
  1952.