Subversion Repositories Kolibri OS

Rev

Go to most recent revision | 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 "2013-12-14" " " " "
  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 allow to access
  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"\-formats\*(R" of the ff* tools will display the list of
  169. supported input devices (amongst the demuxers).
  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. .Sh "bktr"
  207. .IX Subsection "bktr"
  208. \&\s-1BSD\s0 video input device.
  209. .Sh "dshow"
  210. .IX Subsection "dshow"
  211. Windows DirectShow input device.
  212. .PP
  213. DirectShow support is enabled when FFmpeg is built with the mingw\-w64 project.
  214. Currently only audio and video devices are supported.
  215. .PP
  216. Multiple devices may be opened as separate inputs, but they may also be
  217. opened on the same input, which should improve synchronism between them.
  218. .PP
  219. The input name should be in the format:
  220. .PP
  221. .Vb 1
  222. \&        <TYPE>=<NAME>[:<TYPE>=<NAME>]
  223. .Ve
  224. .PP
  225. where \fI\s-1TYPE\s0\fR can be either \fIaudio\fR or \fIvideo\fR,
  226. and \fI\s-1NAME\s0\fR is the device's name.
  227. .PP
  228. \fIOptions\fR
  229. .IX Subsection "Options"
  230. .PP
  231. If no options are specified, the device's defaults are used.
  232. If the device does not support the requested options, it will
  233. fail to open.
  234. .IP "\fBvideo_size\fR" 4
  235. .IX Item "video_size"
  236. Set the video size in the captured video.
  237. .IP "\fBframerate\fR" 4
  238. .IX Item "framerate"
  239. Set the frame rate in the captured video.
  240. .IP "\fBsample_rate\fR" 4
  241. .IX Item "sample_rate"
  242. Set the sample rate (in Hz) of the captured audio.
  243. .IP "\fBsample_size\fR" 4
  244. .IX Item "sample_size"
  245. Set the sample size (in bits) of the captured audio.
  246. .IP "\fBchannels\fR" 4
  247. .IX Item "channels"
  248. Set the number of channels in the captured audio.
  249. .IP "\fBlist_devices\fR" 4
  250. .IX Item "list_devices"
  251. If set to \fBtrue\fR, print a list of devices and exit.
  252. .IP "\fBlist_options\fR" 4
  253. .IX Item "list_options"
  254. If set to \fBtrue\fR, print a list of selected device's options
  255. and exit.
  256. .IP "\fBvideo_device_number\fR" 4
  257. .IX Item "video_device_number"
  258. Set video device number for devices with same name (starts at 0,
  259. defaults to 0).
  260. .IP "\fBaudio_device_number\fR" 4
  261. .IX Item "audio_device_number"
  262. Set audio device number for devices with same name (starts at 0,
  263. defaults to 0).
  264. .IP "\fBpixel_format\fR" 4
  265. .IX Item "pixel_format"
  266. Select pixel format to be used by DirectShow. This may only be set when
  267. the video codec is not set or set to rawvideo.
  268. .IP "\fBaudio_buffer_size\fR" 4
  269. .IX Item "audio_buffer_size"
  270. Set audio device buffer size in milliseconds (which can directly
  271. impact latency, depending on the device).
  272. Defaults to using the audio device's
  273. default buffer size (typically some multiple of 500ms).
  274. Setting this value too low can degrade performance.
  275. See also
  276. <\fBhttp://msdn.microsoft.com/en\-us/library/windows/desktop/dd377582(v=vs.85).aspx\fR>
  277. .PP
  278. \fIExamples\fR
  279. .IX Subsection "Examples"
  280. .IP "\(bu" 4
  281. Print the list of DirectShow supported devices and exit:
  282. .Sp
  283. .Vb 1
  284. \&        $ ffmpeg -list_devices true -f dshow -i dummy
  285. .Ve
  286. .IP "\(bu" 4
  287. Open video device \fICamera\fR:
  288. .Sp
  289. .Vb 1
  290. \&        $ ffmpeg -f dshow -i video="Camera"
  291. .Ve
  292. .IP "\(bu" 4
  293. Open second video device with name \fICamera\fR:
  294. .Sp
  295. .Vb 1
  296. \&        $ ffmpeg -f dshow -video_device_number 1 -i video="Camera"
  297. .Ve
  298. .IP "\(bu" 4
  299. Open video device \fICamera\fR and audio device \fIMicrophone\fR:
  300. .Sp
  301. .Vb 1
  302. \&        $ ffmpeg -f dshow -i video="Camera":audio="Microphone"
  303. .Ve
  304. .IP "\(bu" 4
  305. Print the list of supported options in selected device and exit:
  306. .Sp
  307. .Vb 1
  308. \&        $ ffmpeg -list_options true -f dshow -i video="Camera"
  309. .Ve
  310. .Sh "dv1394"
  311. .IX Subsection "dv1394"
  312. Linux \s-1DV\s0 1394 input device.
  313. .Sh "fbdev"
  314. .IX Subsection "fbdev"
  315. Linux framebuffer input device.
  316. .PP
  317. The Linux framebuffer is a graphic hardware-independent abstraction
  318. layer to show graphics on a computer monitor, typically on the
  319. console. It is accessed through a file device node, usually
  320. \&\fI/dev/fb0\fR.
  321. .PP
  322. For more detailed information read the file
  323. Documentation/fb/framebuffer.txt included in the Linux source tree.
  324. .PP
  325. To record from the framebuffer device \fI/dev/fb0\fR with
  326. \&\fBffmpeg\fR:
  327. .PP
  328. .Vb 1
  329. \&        ffmpeg -f fbdev -r 10 -i /dev/fb0 out.avi
  330. .Ve
  331. .PP
  332. You can take a single screenshot image with the command:
  333. .PP
  334. .Vb 1
  335. \&        ffmpeg -f fbdev -frames:v 1 -r 1 -i /dev/fb0 screenshot.jpeg
  336. .Ve
  337. .PP
  338. See also <\fBhttp://linux\-fbdev.sourceforge.net/\fR>, and \fIfbset\fR\|(1).
  339. .Sh "iec61883"
  340. .IX Subsection "iec61883"
  341. FireWire \s-1DV/HDV\s0 input device using libiec61883.
  342. .PP
  343. To enable this input device, you need libiec61883, libraw1394 and
  344. libavc1394 installed on your system. Use the configure option
  345. \&\f(CW\*(C`\-\-enable\-libiec61883\*(C'\fR to compile with the device enabled.
  346. .PP
  347. The iec61883 capture device supports capturing from a video device
  348. connected via \s-1IEEE1394\s0 (FireWire), using libiec61883 and the new Linux
  349. FireWire stack (juju). This is the default \s-1DV/HDV\s0 input method in Linux
  350. Kernel 2.6.37 and later, since the old FireWire stack was removed.
  351. .PP
  352. Specify the FireWire port to be used as input file, or \*(L"auto\*(R"
  353. to choose the first port connected.
  354. .PP
  355. \fIOptions\fR
  356. .IX Subsection "Options"
  357. .IP "\fBdvtype\fR" 4
  358. .IX Item "dvtype"
  359. Override autodetection of \s-1DV/HDV\s0. This should only be used if auto
  360. detection does not work, or if usage of a different device type
  361. should be prohibited. Treating a \s-1DV\s0 device as \s-1HDV\s0 (or vice versa) will
  362. not work and result in undefined behavior.
  363. The values \fBauto\fR, \fBdv\fR and \fBhdv\fR are supported.
  364. .IP "\fBdvbuffer\fR" 4
  365. .IX Item "dvbuffer"
  366. Set maxiumum size of buffer for incoming data, in frames. For \s-1DV\s0, this
  367. is an exact value. For \s-1HDV\s0, it is not frame exact, since \s-1HDV\s0 does
  368. not have a fixed frame size.
  369. .IP "\fBdvguid\fR" 4
  370. .IX Item "dvguid"
  371. Select the capture device by specifying it's \s-1GUID\s0. Capturing will only
  372. be performed from the specified device and fails if no device with the
  373. given \s-1GUID\s0 is found. This is useful to select the input if multiple
  374. devices are connected at the same time.
  375. Look at /sys/bus/firewire/devices to find out the GUIDs.
  376. .PP
  377. \fIExamples\fR
  378. .IX Subsection "Examples"
  379. .IP "\(bu" 4
  380. Grab and show the input of a FireWire \s-1DV/HDV\s0 device.
  381. .Sp
  382. .Vb 1
  383. \&        ffplay -f iec61883 -i auto
  384. .Ve
  385. .IP "\(bu" 4
  386. Grab and record the input of a FireWire \s-1DV/HDV\s0 device,
  387. using a packet buffer of 100000 packets if the source is \s-1HDV\s0.
  388. .Sp
  389. .Vb 1
  390. \&        ffmpeg -f iec61883 -i auto -hdvbuffer 100000 out.mpg
  391. .Ve
  392. .Sh "jack"
  393. .IX Subsection "jack"
  394. \&\s-1JACK\s0 input device.
  395. .PP
  396. To enable this input device during configuration you need libjack
  397. installed on your system.
  398. .PP
  399. A \s-1JACK\s0 input device creates one or more \s-1JACK\s0 writable clients, one for
  400. each audio channel, with name \fIclient_name\fR:input_\fIN\fR, where
  401. \&\fIclient_name\fR is the name provided by the application, and \fIN\fR
  402. is a number which identifies the channel.
  403. Each writable client will send the acquired data to the FFmpeg input
  404. device.
  405. .PP
  406. Once you have created one or more \s-1JACK\s0 readable clients, you need to
  407. connect them to one or more \s-1JACK\s0 writable clients.
  408. .PP
  409. To connect or disconnect \s-1JACK\s0 clients you can use the \fBjack_connect\fR
  410. and \fBjack_disconnect\fR programs, or do it through a graphical interface,
  411. for example with \fBqjackctl\fR.
  412. .PP
  413. To list the \s-1JACK\s0 clients and their properties you can invoke the command
  414. \&\fBjack_lsp\fR.
  415. .PP
  416. Follows an example which shows how to capture a \s-1JACK\s0 readable client
  417. with \fBffmpeg\fR.
  418. .PP
  419. .Vb 2
  420. \&        # Create a JACK writable client with name "ffmpeg".
  421. \&        $ ffmpeg -f jack -i ffmpeg -y out.wav
  422. .Ve
  423. .PP
  424. .Vb 2
  425. \&        # Start the sample jack_metro readable client.
  426. \&        $ jack_metro -b 120 -d 0.2 -f 4000
  427. .Ve
  428. .PP
  429. .Vb 8
  430. \&        # List the current JACK clients.
  431. \&        $ jack_lsp -c
  432. \&        system:capture_1
  433. \&        system:capture_2
  434. \&        system:playback_1
  435. \&        system:playback_2
  436. \&        ffmpeg:input_1
  437. \&        metro:120_bpm
  438. .Ve
  439. .PP
  440. .Vb 2
  441. \&        # Connect metro to the ffmpeg writable client.
  442. \&        $ jack_connect metro:120_bpm ffmpeg:input_1
  443. .Ve
  444. .PP
  445. For more information read:
  446. <\fBhttp://jackaudio.org/\fR>
  447. .Sh "lavfi"
  448. .IX Subsection "lavfi"
  449. Libavfilter input virtual device.
  450. .PP
  451. This input device reads data from the open output pads of a libavfilter
  452. filtergraph.
  453. .PP
  454. For each filtergraph open output, the input device will create a
  455. corresponding stream which is mapped to the generated output. Currently
  456. only video data is supported. The filtergraph is specified through the
  457. option \fBgraph\fR.
  458. .PP
  459. \fIOptions\fR
  460. .IX Subsection "Options"
  461. .IP "\fBgraph\fR" 4
  462. .IX Item "graph"
  463. Specify the filtergraph to use as input. Each video open output must be
  464. labelled by a unique string of the form "out\fIN\fR", where \fIN\fR is a
  465. number starting from 0 corresponding to the mapped input stream
  466. generated by the device.
  467. The first unlabelled output is automatically assigned to the \*(L"out0\*(R"
  468. label, but all the others need to be specified explicitly.
  469. .Sp
  470. If not specified defaults to the filename specified for the input
  471. device.
  472. .IP "\fBgraph_file\fR" 4
  473. .IX Item "graph_file"
  474. Set the filename of the filtergraph to be read and sent to the other
  475. filters. Syntax of the filtergraph is the same as the one specified by
  476. the option \fIgraph\fR.
  477. .PP
  478. \fIExamples\fR
  479. .IX Subsection "Examples"
  480. .IP "\(bu" 4
  481. Create a color video stream and play it back with \fBffplay\fR:
  482. .Sp
  483. .Vb 1
  484. \&        ffplay -f lavfi -graph "color=c=pink [out0]" dummy
  485. .Ve
  486. .IP "\(bu" 4
  487. As the previous example, but use filename for specifying the graph
  488. description, and omit the \*(L"out0\*(R" label:
  489. .Sp
  490. .Vb 1
  491. \&        ffplay -f lavfi color=c=pink
  492. .Ve
  493. .IP "\(bu" 4
  494. Create three different video test filtered sources and play them:
  495. .Sp
  496. .Vb 1
  497. \&        ffplay -f lavfi -graph "testsrc [out0]; testsrc,hflip [out1]; testsrc,negate [out2]" test3
  498. .Ve
  499. .IP "\(bu" 4
  500. Read an audio stream from a file using the amovie source and play it
  501. back with \fBffplay\fR:
  502. .Sp
  503. .Vb 1
  504. \&        ffplay -f lavfi "amovie=test.wav"
  505. .Ve
  506. .IP "\(bu" 4
  507. Read an audio stream and a video stream and play it back with
  508. \&\fBffplay\fR:
  509. .Sp
  510. .Vb 1
  511. \&        ffplay -f lavfi "movie=test.avi[out0];amovie=test.wav[out1]"
  512. .Ve
  513. .Sh "libdc1394"
  514. .IX Subsection "libdc1394"
  515. \&\s-1IIDC1394\s0 input device, based on libdc1394 and libraw1394.
  516. .Sh "openal"
  517. .IX Subsection "openal"
  518. The OpenAL input device provides audio capture on all systems with a
  519. working OpenAL 1.1 implementation.
  520. .PP
  521. To enable this input device during configuration, you need OpenAL
  522. headers and libraries installed on your system, and need to configure
  523. FFmpeg with \f(CW\*(C`\-\-enable\-openal\*(C'\fR.
  524. .PP
  525. OpenAL headers and libraries should be provided as part of your OpenAL
  526. implementation, or as an additional download (an \s-1SDK\s0). Depending on your
  527. installation you may need to specify additional flags via the
  528. \&\f(CW\*(C`\-\-extra\-cflags\*(C'\fR and \f(CW\*(C`\-\-extra\-ldflags\*(C'\fR for allowing the build
  529. system to locate the OpenAL headers and libraries.
  530. .PP
  531. An incomplete list of OpenAL implementations follows:
  532. .IP "\fBCreative\fR" 4
  533. .IX Item "Creative"
  534. The official Windows implementation, providing hardware acceleration
  535. with supported devices and software fallback.
  536. See <\fBhttp://openal.org/\fR>.
  537. .IP "\fBOpenAL Soft\fR" 4
  538. .IX Item "OpenAL Soft"
  539. Portable, open source (\s-1LGPL\s0) software implementation. Includes
  540. backends for the most common sound APIs on the Windows, Linux,
  541. Solaris, and \s-1BSD\s0 operating systems.
  542. See <\fBhttp://kcat.strangesoft.net/openal.html\fR>.
  543. .IP "\fBApple\fR" 4
  544. .IX Item "Apple"
  545. OpenAL is part of Core Audio, the official Mac \s-1OS\s0 X Audio interface.
  546. See <\fBhttp://developer.apple.com/technologies/mac/audio\-and\-video.html\fR>
  547. .PP
  548. This device allows to capture from an audio input device handled
  549. through OpenAL.
  550. .PP
  551. You need to specify the name of the device to capture in the provided
  552. filename. If the empty string is provided, the device will
  553. automatically select the default device. You can get the list of the
  554. supported devices by using the option \fIlist_devices\fR.
  555. .PP
  556. \fIOptions\fR
  557. .IX Subsection "Options"
  558. .IP "\fBchannels\fR" 4
  559. .IX Item "channels"
  560. Set the number of channels in the captured audio. Only the values
  561. \&\fB1\fR (monaural) and \fB2\fR (stereo) are currently supported.
  562. Defaults to \fB2\fR.
  563. .IP "\fBsample_size\fR" 4
  564. .IX Item "sample_size"
  565. Set the sample size (in bits) of the captured audio. Only the values
  566. \&\fB8\fR and \fB16\fR are currently supported. Defaults to
  567. \&\fB16\fR.
  568. .IP "\fBsample_rate\fR" 4
  569. .IX Item "sample_rate"
  570. Set the sample rate (in Hz) of the captured audio.
  571. Defaults to \fB44.1k\fR.
  572. .IP "\fBlist_devices\fR" 4
  573. .IX Item "list_devices"
  574. If set to \fBtrue\fR, print a list of devices and exit.
  575. Defaults to \fBfalse\fR.
  576. .PP
  577. \fIExamples\fR
  578. .IX Subsection "Examples"
  579. .PP
  580. Print the list of OpenAL supported devices and exit:
  581. .PP
  582. .Vb 1
  583. \&        $ ffmpeg -list_devices true -f openal -i dummy out.ogg
  584. .Ve
  585. .PP
  586. Capture from the OpenAL device \fI\s-1DR\-BT101\s0 via PulseAudio\fR:
  587. .PP
  588. .Vb 1
  589. \&        $ ffmpeg -f openal -i 'DR-BT101 via PulseAudio' out.ogg
  590. .Ve
  591. .PP
  592. Capture from the default device (note the empty string '' as filename):
  593. .PP
  594. .Vb 1
  595. \&        $ ffmpeg -f openal -i '' out.ogg
  596. .Ve
  597. .PP
  598. Capture from two devices simultaneously, writing to two different files,
  599. within the same \fBffmpeg\fR command:
  600. .PP
  601. .Vb 1
  602. \&        $ ffmpeg -f openal -i 'DR-BT101 via PulseAudio' out1.ogg -f openal -i 'ALSA Default' out2.ogg
  603. .Ve
  604. .PP
  605. Note: not all OpenAL implementations support multiple simultaneous capture \-
  606. try the latest OpenAL Soft if the above does not work.
  607. .Sh "oss"
  608. .IX Subsection "oss"
  609. Open Sound System input device.
  610. .PP
  611. The filename to provide to the input device is the device node
  612. representing the \s-1OSS\s0 input device, and is usually set to
  613. \&\fI/dev/dsp\fR.
  614. .PP
  615. For example to grab from \fI/dev/dsp\fR using \fBffmpeg\fR use the
  616. command:
  617. .PP
  618. .Vb 1
  619. \&        ffmpeg -f oss -i /dev/dsp /tmp/oss.wav
  620. .Ve
  621. .PP
  622. For more information about \s-1OSS\s0 see:
  623. <\fBhttp://manuals.opensound.com/usersguide/dsp.html\fR>
  624. .Sh "pulse"
  625. .IX Subsection "pulse"
  626. PulseAudio input device.
  627. .PP
  628. To enable this output device you need to configure FFmpeg with \f(CW\*(C`\-\-enable\-libpulse\*(C'\fR.
  629. .PP
  630. The filename to provide to the input device is a source device or the
  631. string \*(L"default\*(R"
  632. .PP
  633. To list the PulseAudio source devices and their properties you can invoke
  634. the command \fBpactl list sources\fR.
  635. .PP
  636. More information about PulseAudio can be found on <\fBhttp://www.pulseaudio.org\fR>.
  637. .PP
  638. \fIOptions\fR
  639. .IX Subsection "Options"
  640. .IP "\fBserver\fR" 4
  641. .IX Item "server"
  642. Connect to a specific PulseAudio server, specified by an \s-1IP\s0 address.
  643. Default server is used when not provided.
  644. .IP "\fBname\fR" 4
  645. .IX Item "name"
  646. Specify the application name PulseAudio will use when showing active clients,
  647. by default it is the \f(CW\*(C`LIBAVFORMAT_IDENT\*(C'\fR string.
  648. .IP "\fBstream_name\fR" 4
  649. .IX Item "stream_name"
  650. Specify the stream name PulseAudio will use when showing active streams,
  651. by default it is \*(L"record\*(R".
  652. .IP "\fBsample_rate\fR" 4
  653. .IX Item "sample_rate"
  654. Specify the samplerate in Hz, by default 48kHz is used.
  655. .IP "\fBchannels\fR" 4
  656. .IX Item "channels"
  657. Specify the channels in use, by default 2 (stereo) is set.
  658. .IP "\fBframe_size\fR" 4
  659. .IX Item "frame_size"
  660. Specify the number of bytes per frame, by default it is set to 1024.
  661. .IP "\fBfragment_size\fR" 4
  662. .IX Item "fragment_size"
  663. Specify the minimal buffering fragment in PulseAudio, it will affect the
  664. audio latency. By default it is unset.
  665. .PP
  666. \fIExamples\fR
  667. .IX Subsection "Examples"
  668. .PP
  669. Record a stream from default device:
  670. .PP
  671. .Vb 1
  672. \&        ffmpeg -f pulse -i default /tmp/pulse.wav
  673. .Ve
  674. .Sh "sndio"
  675. .IX Subsection "sndio"
  676. sndio input device.
  677. .PP
  678. To enable this input device during configuration you need libsndio
  679. installed on your system.
  680. .PP
  681. The filename to provide to the input device is the device node
  682. representing the sndio input device, and is usually set to
  683. \&\fI/dev/audio0\fR.
  684. .PP
  685. For example to grab from \fI/dev/audio0\fR using \fBffmpeg\fR use the
  686. command:
  687. .PP
  688. .Vb 1
  689. \&        ffmpeg -f sndio -i /dev/audio0 /tmp/oss.wav
  690. .Ve
  691. .Sh "video4linux2, v4l2"
  692. .IX Subsection "video4linux2, v4l2"
  693. Video4Linux2 input video device.
  694. .PP
  695. \&\*(L"v4l2\*(R" can be used as alias for \*(L"video4linux2\*(R".
  696. .PP
  697. If FFmpeg is built with v4l\-utils support (by using the
  698. \&\f(CW\*(C`\-\-enable\-libv4l2\*(C'\fR configure option), it is possible to use it with the
  699. \&\f(CW\*(C`\-use_libv4l2\*(C'\fR input device option.
  700. .PP
  701. The name of the device to grab is a file device node, usually Linux
  702. systems tend to automatically create such nodes when the device
  703. (e.g. an \s-1USB\s0 webcam) is plugged into the system, and has a name of the
  704. kind \fI/dev/video\fIN\fI\fR, where \fIN\fR is a number associated to
  705. the device.
  706. .PP
  707. Video4Linux2 devices usually support a limited set of
  708. \&\fIwidth\fRx\fIheight\fR sizes and frame rates. You can check which are
  709. supported using \fB\-list_formats all\fR for Video4Linux2 devices.
  710. Some devices, like \s-1TV\s0 cards, support one or more standards. It is possible
  711. to list all the supported standards using \fB\-list_standards all\fR.
  712. .PP
  713. The time base for the timestamps is 1 microsecond. Depending on the kernel
  714. version and configuration, the timestamps may be derived from the real time
  715. clock (origin at the Unix Epoch) or the monotonic clock (origin usually at
  716. boot time, unaffected by \s-1NTP\s0 or manual changes to the clock). The
  717. \&\fB\-timestamps abs\fR or \fB\-ts abs\fR option can be used to force
  718. conversion into the real time clock.
  719. .PP
  720. Some usage examples of the video4linux2 device with \fBffmpeg\fR
  721. and \fBffplay\fR:
  722. .IP "\(bu" 4
  723. Grab and show the input of a video4linux2 device:
  724. .Sp
  725. .Vb 1
  726. \&        ffplay -f video4linux2 -framerate 30 -video_size hd720 /dev/video0
  727. .Ve
  728. .IP "\(bu" 4
  729. Grab and record the input of a video4linux2 device, leave the
  730. frame rate and size as previously set:
  731. .Sp
  732. .Vb 1
  733. \&        ffmpeg -f video4linux2 -input_format mjpeg -i /dev/video0 out.mpeg
  734. .Ve
  735. .PP
  736. For more information about Video4Linux, check <\fBhttp://linuxtv.org/\fR>.
  737. .PP
  738. \fIOptions\fR
  739. .IX Subsection "Options"
  740. .IP "\fBstandard\fR" 4
  741. .IX Item "standard"
  742. Set the standard. Must be the name of a supported standard. To get a
  743. list of the supported standards, use the \fBlist_standards\fR
  744. option.
  745. .IP "\fBchannel\fR" 4
  746. .IX Item "channel"
  747. Set the input channel number. Default to \-1, which means using the
  748. previously selected channel.
  749. .IP "\fBvideo_size\fR" 4
  750. .IX Item "video_size"
  751. Set the video frame size. The argument must be a string in the form
  752. \&\fI\s-1WIDTH\s0\fRx\fI\s-1HEIGHT\s0\fR or a valid size abbreviation.
  753. .IP "\fBpixel_format\fR" 4
  754. .IX Item "pixel_format"
  755. Select the pixel format (only valid for raw video input).
  756. .IP "\fBinput_format\fR" 4
  757. .IX Item "input_format"
  758. Set the preferred pixel format (for raw video) or a codec name.
  759. This option allows to select the input format, when several are
  760. available.
  761. .IP "\fBframerate\fR" 4
  762. .IX Item "framerate"
  763. Set the preferred video frame rate.
  764. .IP "\fBlist_formats\fR" 4
  765. .IX Item "list_formats"
  766. List available formats (supported pixel formats, codecs, and frame
  767. sizes) and exit.
  768. .Sp
  769. Available values are:
  770. .RS 4
  771. .IP "\fBall\fR" 4
  772. .IX Item "all"
  773. Show all available (compressed and non\-compressed) formats.
  774. .IP "\fBraw\fR" 4
  775. .IX Item "raw"
  776. Show only raw video (non\-compressed) formats.
  777. .IP "\fBcompressed\fR" 4
  778. .IX Item "compressed"
  779. Show only compressed formats.
  780. .RE
  781. .RS 4
  782. .RE
  783. .IP "\fBlist_standards\fR" 4
  784. .IX Item "list_standards"
  785. List supported standards and exit.
  786. .Sp
  787. Available values are:
  788. .RS 4
  789. .IP "\fBall\fR" 4
  790. .IX Item "all"
  791. Show all supported standards.
  792. .RE
  793. .RS 4
  794. .RE
  795. .IP "\fBtimestamps, ts\fR" 4
  796. .IX Item "timestamps, ts"
  797. Set type of timestamps for grabbed frames.
  798. .Sp
  799. Available values are:
  800. .RS 4
  801. .IP "\fBdefault\fR" 4
  802. .IX Item "default"
  803. Use timestamps from the kernel.
  804. .IP "\fBabs\fR" 4
  805. .IX Item "abs"
  806. Use absolute timestamps (wall clock).
  807. .IP "\fBmono2abs\fR" 4
  808. .IX Item "mono2abs"
  809. Force conversion from monotonic to absolute timestamps.
  810. .RE
  811. .RS 4
  812. .Sp
  813. Default value is \f(CW\*(C`default\*(C'\fR.
  814. .RE
  815. .Sh "vfwcap"
  816. .IX Subsection "vfwcap"
  817. VfW (Video for Windows) capture input device.
  818. .PP
  819. The filename passed as input is the capture driver number, ranging from
  820. 0 to 9. You may use \*(L"list\*(R" as filename to print a list of drivers. Any
  821. other filename will be interpreted as device number 0.
  822. .Sh "x11grab"
  823. .IX Subsection "x11grab"
  824. X11 video input device.
  825. .PP
  826. This device allows to capture a region of an X11 display.
  827. .PP
  828. The filename passed as input has the syntax:
  829. .PP
  830. .Vb 1
  831. \&        [<hostname>]:<display_number>.<screen_number>[+<x_offset>,<y_offset>]
  832. .Ve
  833. .PP
  834. \&\fIhostname\fR:\fIdisplay_number\fR.\fIscreen_number\fR specifies the
  835. X11 display name of the screen to grab from. \fIhostname\fR can be
  836. omitted, and defaults to \*(L"localhost\*(R". The environment variable
  837. \&\fB\s-1DISPLAY\s0\fR contains the default display name.
  838. .PP
  839. \&\fIx_offset\fR and \fIy_offset\fR specify the offsets of the grabbed
  840. area with respect to the top-left border of the X11 screen. They
  841. default to 0.
  842. .PP
  843. Check the X11 documentation (e.g. man X) for more detailed information.
  844. .PP
  845. Use the \fBdpyinfo\fR program for getting basic information about the
  846. properties of your X11 display (e.g. grep for \*(L"name\*(R" or \*(L"dimensions\*(R").
  847. .PP
  848. For example to grab from \fI:0.0\fR using \fBffmpeg\fR:
  849. .PP
  850. .Vb 1
  851. \&        ffmpeg -f x11grab -framerate 25 -video_size cif -i :0.0 out.mpg
  852. .Ve
  853. .PP
  854. Grab at position \f(CW\*(C`10,20\*(C'\fR:
  855. .PP
  856. .Vb 1
  857. \&        ffmpeg -f x11grab -framerate 25 -video_size cif -i :0.0+10,20 out.mpg
  858. .Ve
  859. .PP
  860. \fIOptions\fR
  861. .IX Subsection "Options"
  862. .IP "\fBdraw_mouse\fR" 4
  863. .IX Item "draw_mouse"
  864. Specify whether to draw the mouse pointer. A value of \f(CW0\fR specify
  865. not to draw the pointer. Default value is \f(CW1\fR.
  866. .IP "\fBfollow_mouse\fR" 4
  867. .IX Item "follow_mouse"
  868. Make the grabbed area follow the mouse. The argument can be
  869. \&\f(CW\*(C`centered\*(C'\fR or a number of pixels \fI\s-1PIXELS\s0\fR.
  870. .Sp
  871. When it is specified with \*(L"centered\*(R", the grabbing region follows the mouse
  872. pointer and keeps the pointer at the center of region; otherwise, the region
  873. follows only when the mouse pointer reaches within \fI\s-1PIXELS\s0\fR (greater than
  874. zero) to the edge of region.
  875. .Sp
  876. For example:
  877. .Sp
  878. .Vb 1
  879. \&        ffmpeg -f x11grab -follow_mouse centered -framerate 25 -video_size cif -i :0.0 out.mpg
  880. .Ve
  881. .Sp
  882. To follow only when the mouse pointer reaches within 100 pixels to edge:
  883. .Sp
  884. .Vb 1
  885. \&        ffmpeg -f x11grab -follow_mouse 100 -framerate 25 -video_size cif -i :0.0 out.mpg
  886. .Ve
  887. .IP "\fBframerate\fR" 4
  888. .IX Item "framerate"
  889. Set the grabbing frame rate. Default value is \f(CW\*(C`ntsc\*(C'\fR,
  890. corresponding to a frame rate of \f(CW\*(C`30000/1001\*(C'\fR.
  891. .IP "\fBshow_region\fR" 4
  892. .IX Item "show_region"
  893. Show grabbed region on screen.
  894. .Sp
  895. If \fIshow_region\fR is specified with \f(CW1\fR, then the grabbing
  896. region will be indicated on screen. With this option, it is easy to
  897. know what is being grabbed if only a portion of the screen is grabbed.
  898. .Sp
  899. For example:
  900. .Sp
  901. .Vb 1
  902. \&        ffmpeg -f x11grab -show_region 1 -framerate 25 -video_size cif -i :0.0+10,20 out.mpg
  903. .Ve
  904. .Sp
  905. With \fIfollow_mouse\fR:
  906. .Sp
  907. .Vb 1
  908. \&        ffmpeg -f x11grab -follow_mouse centered -show_region 1 -framerate 25 -video_size cif -i :0.0 out.mpg
  909. .Ve
  910. .IP "\fBvideo_size\fR" 4
  911. .IX Item "video_size"
  912. Set the video frame size. Default value is \f(CW\*(C`vga\*(C'\fR.
  913. .SH "OUTPUT DEVICES"
  914. .IX Header "OUTPUT DEVICES"
  915. Output devices are configured elements in FFmpeg that can write
  916. multimedia data to an output device attached to your system.
  917. .PP
  918. When you configure your FFmpeg build, all the supported output devices
  919. are enabled by default. You can list all available ones using the
  920. configure option \*(L"\-\-list\-outdevs\*(R".
  921. .PP
  922. You can disable all the output devices using the configure option
  923. \&\*(L"\-\-disable\-outdevs\*(R", and selectively enable an output device using the
  924. option "\-\-enable\-outdev=\fI\s-1OUTDEV\s0\fR\*(L", or you can disable a particular
  925. input device using the option \*(R"\-\-disable\-outdev=\fI\s-1OUTDEV\s0\fR".
  926. .PP
  927. The option \*(L"\-formats\*(R" of the ff* tools will display the list of
  928. enabled output devices (amongst the muxers).
  929. .PP
  930. A description of the currently available output devices follows.
  931. .Sh "alsa"
  932. .IX Subsection "alsa"
  933. \&\s-1ALSA\s0 (Advanced Linux Sound Architecture) output device.
  934. .Sh "caca"
  935. .IX Subsection "caca"
  936. \&\s-1CACA\s0 output device.
  937. .PP
  938. This output device allows to show a video stream in \s-1CACA\s0 window.
  939. Only one \s-1CACA\s0 window is allowed per application, so you can
  940. have only one instance of this output device in an application.
  941. .PP
  942. To enable this output device you need to configure FFmpeg with
  943. \&\f(CW\*(C`\-\-enable\-libcaca\*(C'\fR.
  944. libcaca is a graphics library that outputs text instead of pixels.
  945. .PP
  946. For more information about libcaca, check:
  947. <\fBhttp://caca.zoy.org/wiki/libcaca\fR>
  948. .PP
  949. \fIOptions\fR
  950. .IX Subsection "Options"
  951. .IP "\fBwindow_title\fR" 4
  952. .IX Item "window_title"
  953. Set the \s-1CACA\s0 window title, if not specified default to the filename
  954. specified for the output device.
  955. .IP "\fBwindow_size\fR" 4
  956. .IX Item "window_size"
  957. Set the \s-1CACA\s0 window size, can be a string of the form
  958. \&\fIwidth\fRx\fIheight\fR or a video size abbreviation.
  959. If not specified it defaults to the size of the input video.
  960. .IP "\fBdriver\fR" 4
  961. .IX Item "driver"
  962. Set display driver.
  963. .IP "\fBalgorithm\fR" 4
  964. .IX Item "algorithm"
  965. Set dithering algorithm. Dithering is necessary
  966. because the picture being rendered has usually far more colours than
  967. the available palette.
  968. The accepted values are listed with \f(CW\*(C`\-list_dither algorithms\*(C'\fR.
  969. .IP "\fBantialias\fR" 4
  970. .IX Item "antialias"
  971. Set antialias method. Antialiasing smoothens the rendered
  972. image and avoids the commonly seen staircase effect.
  973. The accepted values are listed with \f(CW\*(C`\-list_dither antialiases\*(C'\fR.
  974. .IP "\fBcharset\fR" 4
  975. .IX Item "charset"
  976. Set which characters are going to be used when rendering text.
  977. The accepted values are listed with \f(CW\*(C`\-list_dither charsets\*(C'\fR.
  978. .IP "\fBcolor\fR" 4
  979. .IX Item "color"
  980. Set color to be used when rendering text.
  981. The accepted values are listed with \f(CW\*(C`\-list_dither colors\*(C'\fR.
  982. .IP "\fBlist_drivers\fR" 4
  983. .IX Item "list_drivers"
  984. If set to \fBtrue\fR, print a list of available drivers and exit.
  985. .IP "\fBlist_dither\fR" 4
  986. .IX Item "list_dither"
  987. List available dither options related to the argument.
  988. The argument must be one of \f(CW\*(C`algorithms\*(C'\fR, \f(CW\*(C`antialiases\*(C'\fR,
  989. \&\f(CW\*(C`charsets\*(C'\fR, \f(CW\*(C`colors\*(C'\fR.
  990. .PP
  991. \fIExamples\fR
  992. .IX Subsection "Examples"
  993. .IP "\(bu" 4
  994. The following command shows the \fBffmpeg\fR output is an
  995. \&\s-1CACA\s0 window, forcing its size to 80x25:
  996. .Sp
  997. .Vb 1
  998. \&        ffmpeg -i INPUT -vcodec rawvideo -pix_fmt rgb24 -window_size 80x25 -f caca -
  999. .Ve
  1000. .IP "\(bu" 4
  1001. Show the list of available drivers and exit:
  1002. .Sp
  1003. .Vb 1
  1004. \&        ffmpeg -i INPUT -pix_fmt rgb24 -f caca -list_drivers true -
  1005. .Ve
  1006. .IP "\(bu" 4
  1007. Show the list of available dither colors and exit:
  1008. .Sp
  1009. .Vb 1
  1010. \&        ffmpeg -i INPUT -pix_fmt rgb24 -f caca -list_dither colors -
  1011. .Ve
  1012. .Sh "fbdev"
  1013. .IX Subsection "fbdev"
  1014. Linux framebuffer output device.
  1015. .PP
  1016. The Linux framebuffer is a graphic hardware-independent abstraction
  1017. layer to show graphics on a computer monitor, typically on the
  1018. console. It is accessed through a file device node, usually
  1019. \&\fI/dev/fb0\fR.
  1020. .PP
  1021. For more detailed information read the file
  1022. \&\fIDocumentation/fb/framebuffer.txt\fR included in the Linux source tree.
  1023. .PP
  1024. \fIOptions\fR
  1025. .IX Subsection "Options"
  1026. .IP "\fBxoffset\fR" 4
  1027. .IX Item "xoffset"
  1028. .PD 0
  1029. .IP "\fByoffset\fR" 4
  1030. .IX Item "yoffset"
  1031. .PD
  1032. Set x/y coordinate of top left corner. Default is 0.
  1033. .PP
  1034. \fIExamples\fR
  1035. .IX Subsection "Examples"
  1036. .PP
  1037. Play a file on framebuffer device \fI/dev/fb0\fR.
  1038. Required pixel format depends on current framebuffer settings.
  1039. .PP
  1040. .Vb 1
  1041. \&        ffmpeg -re -i INPUT -vcodec rawvideo -pix_fmt bgra -f fbdev /dev/fb0
  1042. .Ve
  1043. .PP
  1044. See also <\fBhttp://linux\-fbdev.sourceforge.net/\fR>, and \fIfbset\fR\|(1).
  1045. .Sh "oss"
  1046. .IX Subsection "oss"
  1047. \&\s-1OSS\s0 (Open Sound System) output device.
  1048. .Sh "pulse"
  1049. .IX Subsection "pulse"
  1050. PulseAudio output device.
  1051. .PP
  1052. To enable this output device you need to configure FFmpeg with \f(CW\*(C`\-\-enable\-libpulse\*(C'\fR.
  1053. .PP
  1054. More information about PulseAudio can be found on <\fBhttp://www.pulseaudio.org\fR>
  1055. .PP
  1056. \fIOptions\fR
  1057. .IX Subsection "Options"
  1058. .IP "\fBserver\fR" 4
  1059. .IX Item "server"
  1060. Connect to a specific PulseAudio server, specified by an \s-1IP\s0 address.
  1061. Default server is used when not provided.
  1062. .IP "\fBname\fR" 4
  1063. .IX Item "name"
  1064. Specify the application name PulseAudio will use when showing active clients,
  1065. by default it is the \f(CW\*(C`LIBAVFORMAT_IDENT\*(C'\fR string.
  1066. .IP "\fBstream_name\fR" 4
  1067. .IX Item "stream_name"
  1068. Specify the stream name PulseAudio will use when showing active streams,
  1069. by default it is set to the specified output name.
  1070. .IP "\fBdevice\fR" 4
  1071. .IX Item "device"
  1072. Specify the device to use. Default device is used when not provided.
  1073. List of output devices can be obtained with command \fBpactl list sinks\fR.
  1074. .PP
  1075. \fIExamples\fR
  1076. .IX Subsection "Examples"
  1077. .PP
  1078. Play a file on default device on default server:
  1079. .PP
  1080. .Vb 1
  1081. \&        ffmpeg  -i INPUT -f pulse "stream name"
  1082. .Ve
  1083. .Sh "sdl"
  1084. .IX Subsection "sdl"
  1085. \&\s-1SDL\s0 (Simple DirectMedia Layer) output device.
  1086. .PP
  1087. This output device allows to show a video stream in an \s-1SDL\s0
  1088. window. Only one \s-1SDL\s0 window is allowed per application, so you can
  1089. have only one instance of this output device in an application.
  1090. .PP
  1091. To enable this output device you need libsdl installed on your system
  1092. when configuring your build.
  1093. .PP
  1094. For more information about \s-1SDL\s0, check:
  1095. <\fBhttp://www.libsdl.org/\fR>
  1096. .PP
  1097. \fIOptions\fR
  1098. .IX Subsection "Options"
  1099. .IP "\fBwindow_title\fR" 4
  1100. .IX Item "window_title"
  1101. Set the \s-1SDL\s0 window title, if not specified default to the filename
  1102. specified for the output device.
  1103. .IP "\fBicon_title\fR" 4
  1104. .IX Item "icon_title"
  1105. Set the name of the iconified \s-1SDL\s0 window, if not specified it is set
  1106. to the same value of \fIwindow_title\fR.
  1107. .IP "\fBwindow_size\fR" 4
  1108. .IX Item "window_size"
  1109. Set the \s-1SDL\s0 window size, can be a string of the form
  1110. \&\fIwidth\fRx\fIheight\fR or a video size abbreviation.
  1111. If not specified it defaults to the size of the input video,
  1112. downscaled according to the aspect ratio.
  1113. .IP "\fBwindow_fullscreen\fR" 4
  1114. .IX Item "window_fullscreen"
  1115. Set fullscreen mode when non-zero value is provided.
  1116. Zero is a default.
  1117. .PP
  1118. \fIExamples\fR
  1119. .IX Subsection "Examples"
  1120. .PP
  1121. The following command shows the \fBffmpeg\fR output is an
  1122. \&\s-1SDL\s0 window, forcing its size to the qcif format:
  1123. .PP
  1124. .Vb 1
  1125. \&        ffmpeg -i INPUT -vcodec rawvideo -pix_fmt yuv420p -window_size qcif -f sdl "SDL output"
  1126. .Ve
  1127. .Sh "sndio"
  1128. .IX Subsection "sndio"
  1129. sndio audio output device.
  1130. .Sh "xv"
  1131. .IX Subsection "xv"
  1132. \&\s-1XV\s0 (XVideo) output device.
  1133. .PP
  1134. This output device allows to show a video stream in a X Window System
  1135. window.
  1136. .PP
  1137. \fIOptions\fR
  1138. .IX Subsection "Options"
  1139. .IP "\fBdisplay_name\fR" 4
  1140. .IX Item "display_name"
  1141. Specify the hardware display name, which determines the display and
  1142. communications domain to be used.
  1143. .Sp
  1144. The display name or \s-1DISPLAY\s0 environment variable can be a string in
  1145. the format \fIhostname\fR[:\fInumber\fR[.\fIscreen_number\fR]].
  1146. .Sp
  1147. \&\fIhostname\fR specifies the name of the host machine on which the
  1148. display is physically attached. \fInumber\fR specifies the number of
  1149. the display server on that host machine. \fIscreen_number\fR specifies
  1150. the screen to be used on that server.
  1151. .Sp
  1152. If unspecified, it defaults to the value of the \s-1DISPLAY\s0 environment
  1153. variable.
  1154. .Sp
  1155. For example, \f(CW\*(C`dual\-headed:0.1\*(C'\fR would specify screen 1 of display
  1156. 0 on the machine named ``dual\-headed''.
  1157. .Sp
  1158. Check the X11 specification for more detailed information about the
  1159. display name format.
  1160. .IP "\fBwindow_size\fR" 4
  1161. .IX Item "window_size"
  1162. Set the created window size, can be a string of the form
  1163. \&\fIwidth\fRx\fIheight\fR or a video size abbreviation. If not
  1164. specified it defaults to the size of the input video.
  1165. .IP "\fBwindow_x\fR" 4
  1166. .IX Item "window_x"
  1167. .PD 0
  1168. .IP "\fBwindow_y\fR" 4
  1169. .IX Item "window_y"
  1170. .PD
  1171. Set the X and Y window offsets for the created window. They are both
  1172. set to 0 by default. The values may be ignored by the window manager.
  1173. .IP "\fBwindow_title\fR" 4
  1174. .IX Item "window_title"
  1175. Set the window title, if not specified default to the filename
  1176. specified for the output device.
  1177. .PP
  1178. For more information about XVideo see <\fBhttp://www.x.org/\fR>.
  1179. .PP
  1180. \fIExamples\fR
  1181. .IX Subsection "Examples"
  1182. .IP "\(bu" 4
  1183. Decode, display and encode video input with \fBffmpeg\fR at the
  1184. same time:
  1185. .Sp
  1186. .Vb 1
  1187. \&        ffmpeg -i INPUT OUTPUT -f xv display
  1188. .Ve
  1189. .IP "\(bu" 4
  1190. Decode and display the input video to multiple X11 windows:
  1191. .Sp
  1192. .Vb 1
  1193. \&        ffmpeg -i INPUT -f xv normal -vf negate -f xv negated
  1194. .Ve
  1195. .SH "SEE ALSO"
  1196. .IX Header "SEE ALSO"
  1197. \&\fIffmpeg\fR\|(1), \fIffplay\fR\|(1), \fIffprobe\fR\|(1), \fIffserver\fR\|(1), \fIlibavdevice\fR\|(3)
  1198. .SH "AUTHORS"
  1199. .IX Header "AUTHORS"
  1200. The FFmpeg developers.
  1201. .PP
  1202. For details about the authorship, see the Git history of the project
  1203. (git://source.ffmpeg.org/ffmpeg), e.g. by typing the command
  1204. \&\fBgit log\fR in the FFmpeg source directory, or browsing the
  1205. online repository at <\fBhttp://source.ffmpeg.org\fR>.
  1206. .PP
  1207. Maintainers for the specific components are listed in the file
  1208. \&\fI\s-1MAINTAINERS\s0\fR in the source code tree.
  1209.