ffmpeg-utils.1 36 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475
  1. .\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
  2. .\"
  3. .\" Standard preamble:
  4. .\" ========================================================================
  5. .de Sp \" Vertical space (when we can't use .PP)
  6. .if t .sp .5v
  7. .if n .sp
  8. ..
  9. .de Vb \" Begin verbatim text
  10. .ft CW
  11. .nf
  12. .ne \\$1
  13. ..
  14. .de Ve \" End verbatim text
  15. .ft R
  16. .fi
  17. ..
  18. .\" Set up some character translations and predefined strings. \*(-- will
  19. .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20. .\" double quote, and \*(R" will give a right double quote. \*(C+ will
  21. .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
  22. .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
  23. .\" nothing in troff, for use with C<>.
  24. .tr \(*W-
  25. .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26. .ie n \{\
  27. . ds -- \(*W-
  28. . ds PI pi
  29. . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30. . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
  31. . ds L" ""
  32. . ds R" ""
  33. . ds C` ""
  34. . ds C' ""
  35. 'br\}
  36. .el\{\
  37. . ds -- \|\(em\|
  38. . ds PI \(*p
  39. . ds L" ``
  40. . ds R" ''
  41. . ds C`
  42. . ds C'
  43. 'br\}
  44. .\"
  45. .\" Escape single quotes in literal strings from groff's Unicode transform.
  46. .ie \n(.g .ds Aq \(aq
  47. .el .ds Aq '
  48. .\"
  49. .\" If the F register is >0, we'll generate index entries on stderr for
  50. .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51. .\" entries marked with X<> in POD. Of course, you'll have to process the
  52. .\" output yourself in some meaningful fashion.
  53. .\"
  54. .\" Avoid warning from groff about undefined register 'F'.
  55. .de IX
  56. ..
  57. .nr rF 0
  58. .if \n(.g .if rF .nr rF 1
  59. .if (\n(rF:(\n(.g==0)) \{\
  60. . if \nF \{\
  61. . de IX
  62. . tm Index:\\$1\t\\n%\t"\\$2"
  63. ..
  64. . if !\nF==2 \{\
  65. . nr % 0
  66. . nr F 2
  67. . \}
  68. . \}
  69. .\}
  70. .rr rF
  71. .\"
  72. .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  73. .\" Fear. Run. Save yourself. No user-serviceable parts.
  74. . \" fudge factors for nroff and troff
  75. .if n \{\
  76. . ds #H 0
  77. . ds #V .8m
  78. . ds #F .3m
  79. . ds #[ \f1
  80. . ds #] \fP
  81. .\}
  82. .if t \{\
  83. . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84. . ds #V .6m
  85. . ds #F 0
  86. . ds #[ \&
  87. . ds #] \&
  88. .\}
  89. . \" simple accents for nroff and troff
  90. .if n \{\
  91. . ds ' \&
  92. . ds ` \&
  93. . ds ^ \&
  94. . ds , \&
  95. . ds ~ ~
  96. . ds /
  97. .\}
  98. .if t \{\
  99. . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  100. . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  101. . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  102. . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  103. . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
  104. . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
  105. .\}
  106. . \" troff and (daisy-wheel) nroff accents
  107. .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
  108. .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
  109. .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
  110. .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
  111. .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
  112. .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
  113. .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
  114. .ds ae a\h'-(\w'a'u*4/10)'e
  115. .ds Ae A\h'-(\w'A'u*4/10)'E
  116. . \" corrections for vroff
  117. .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
  118. .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
  119. . \" for low resolution devices (crt and lpr)
  120. .if \n(.H>23 .if \n(.V>19 \
  121. \{\
  122. . ds : e
  123. . ds 8 ss
  124. . ds o a
  125. . ds d- d\h'-1'\(ga
  126. . ds D- D\h'-1'\(hy
  127. . ds th \o'bp'
  128. . ds Th \o'LP'
  129. . ds ae ae
  130. . ds Ae AE
  131. .\}
  132. .rm #[ #] #H #V #F C
  133. .\" ========================================================================
  134. .\"
  135. .IX Title "FFMPEG-UTILS 1"
  136. .TH FFMPEG-UTILS 1 " " " " " "
  137. .\" For nroff, turn off justification. Always turn off hyphenation; it makes
  138. .\" way too many mistakes in technical documents.
  139. .if n .ad l
  140. .nh
  141. .SH "NAME"
  142. ffmpeg\-utils \- FFmpeg utilities
  143. .SH "DESCRIPTION"
  144. .IX Header "DESCRIPTION"
  145. This document describes some generic features and utilities provided
  146. by the libavutil library.
  147. .SH "SYNTAX"
  148. .IX Header "SYNTAX"
  149. This section documents the syntax and formats employed by the FFmpeg
  150. libraries and tools.
  151. .SS "Quoting and escaping"
  152. .IX Subsection "Quoting and escaping"
  153. FFmpeg adopts the following quoting and escaping mechanism, unless
  154. explicitly specified. The following rules are applied:
  155. .IP "\(bu" 4
  156. \&\fB'\fR and \fB\e\fR are special characters (respectively used for
  157. quoting and escaping). In addition to them, there might be other
  158. special characters depending on the specific syntax where the escaping
  159. and quoting are employed.
  160. .IP "\(bu" 4
  161. A special character is escaped by prefixing it with a \fB\e\fR.
  162. .IP "\(bu" 4
  163. All characters enclosed between \fB''\fR are included literally in the
  164. parsed string. The quote character \fB'\fR itself cannot be quoted,
  165. so you may need to close the quote and escape it.
  166. .IP "\(bu" 4
  167. Leading and trailing whitespaces, unless escaped or quoted, are
  168. removed from the parsed string.
  169. .PP
  170. Note that you may need to add a second level of escaping when using
  171. the command line or a script, which depends on the syntax of the
  172. adopted shell language.
  173. .PP
  174. The function \f(CW\*(C`av_get_token\*(C'\fR defined in
  175. \&\fIlibavutil/avstring.h\fR can be used to parse a token quoted or
  176. escaped according to the rules defined above.
  177. .PP
  178. The tool \fItools/ffescape\fR in the FFmpeg source tree can be used
  179. to automatically quote or escape a string in a script.
  180. .PP
  181. \fIExamples\fR
  182. .IX Subsection "Examples"
  183. .IP "\(bu" 4
  184. Escape the string \f(CW\*(C`Crime d\*(AqAmour\*(C'\fR containing the \f(CW\*(C`\*(Aq\*(C'\fR special
  185. character:
  186. .Sp
  187. .Vb 1
  188. \& Crime d\e\*(AqAmour
  189. .Ve
  190. .IP "\(bu" 4
  191. The string above contains a quote, so the \f(CW\*(C`\*(Aq\*(C'\fR needs to be escaped
  192. when quoting it:
  193. .Sp
  194. .Vb 1
  195. \& \*(AqCrime d\*(Aq\e\*(Aq\*(AqAmour\*(Aq
  196. .Ve
  197. .IP "\(bu" 4
  198. Include leading or trailing whitespaces using quoting:
  199. .Sp
  200. .Vb 1
  201. \& \*(Aq this string starts and ends with whitespaces \*(Aq
  202. .Ve
  203. .IP "\(bu" 4
  204. Escaping and quoting can be mixed together:
  205. .Sp
  206. .Vb 1
  207. \& \*(Aq The string \*(Aq\e\*(Aqstring\e\*(Aq\*(Aq is a string \*(Aq
  208. .Ve
  209. .IP "\(bu" 4
  210. To include a literal \fB\e\fR you can use either escaping or quoting:
  211. .Sp
  212. .Vb 1
  213. \& \*(Aqc:\efoo\*(Aq can be written as c:\e\efoo
  214. .Ve
  215. .SS "Date"
  216. .IX Subsection "Date"
  217. The accepted syntax is:
  218. .PP
  219. .Vb 2
  220. \& [(YYYY\-MM\-DD|YYYYMMDD)[T|t| ]]((HH:MM:SS[.m...]]])|(HHMMSS[.m...]]]))[Z]
  221. \& now
  222. .Ve
  223. .PP
  224. If the value is \*(L"now\*(R" it takes the current time.
  225. .PP
  226. Time is local time unless Z is appended, in which case it is
  227. interpreted as \s-1UTC.\s0
  228. If the year-month-day part is not specified it takes the current
  229. year-month-day.
  230. .SS "Time duration"
  231. .IX Subsection "Time duration"
  232. There are two accepted syntaxes for expressing time duration.
  233. .PP
  234. .Vb 1
  235. \& [\-][<HH>:]<MM>:<SS>[.<m>...]
  236. .Ve
  237. .PP
  238. \&\fI\s-1HH\s0\fR expresses the number of hours, \fI\s-1MM\s0\fR the number of minutes
  239. for a maximum of 2 digits, and \fI\s-1SS\s0\fR the number of seconds for a
  240. maximum of 2 digits. The \fIm\fR at the end expresses decimal value for
  241. \&\fI\s-1SS\s0\fR.
  242. .PP
  243. \&\fIor\fR
  244. .PP
  245. .Vb 1
  246. \& [\-]<S>+[.<m>...][s|ms|us]
  247. .Ve
  248. .PP
  249. \&\fIS\fR expresses the number of seconds, with the optional decimal part
  250. \&\fIm\fR. The optional literal suffixes \fBs\fR, \fBms\fR or \fBus\fR
  251. indicate to interpret the value as seconds, milliseconds or microseconds,
  252. respectively.
  253. .PP
  254. In both expressions, the optional \fB\-\fR indicates negative duration.
  255. .PP
  256. \fIExamples\fR
  257. .IX Subsection "Examples"
  258. .PP
  259. The following examples are all valid time duration:
  260. .IP "\fB55\fR" 4
  261. .IX Item "55"
  262. 55 seconds
  263. .IP "\fB0.2\fR" 4
  264. .IX Item "0.2"
  265. 0.2 seconds
  266. .IP "\fB200ms\fR" 4
  267. .IX Item "200ms"
  268. 200 milliseconds, that's 0.2s
  269. .IP "\fB200000us\fR" 4
  270. .IX Item "200000us"
  271. 200000 microseconds, that's 0.2s
  272. .IP "\fB12:03:45\fR" 4
  273. .IX Item "12:03:45"
  274. 12 hours, 03 minutes and 45 seconds
  275. .IP "\fB23.189\fR" 4
  276. .IX Item "23.189"
  277. 23.189 seconds
  278. .SS "Video size"
  279. .IX Subsection "Video size"
  280. Specify the size of the sourced video, it may be a string of the form
  281. \&\fIwidth\fRx\fIheight\fR, or the name of a size abbreviation.
  282. .PP
  283. The following abbreviations are recognized:
  284. .IP "\fBntsc\fR" 4
  285. .IX Item "ntsc"
  286. 720x480
  287. .IP "\fBpal\fR" 4
  288. .IX Item "pal"
  289. 720x576
  290. .IP "\fBqntsc\fR" 4
  291. .IX Item "qntsc"
  292. 352x240
  293. .IP "\fBqpal\fR" 4
  294. .IX Item "qpal"
  295. 352x288
  296. .IP "\fBsntsc\fR" 4
  297. .IX Item "sntsc"
  298. 640x480
  299. .IP "\fBspal\fR" 4
  300. .IX Item "spal"
  301. 768x576
  302. .IP "\fBfilm\fR" 4
  303. .IX Item "film"
  304. 352x240
  305. .IP "\fBntsc-film\fR" 4
  306. .IX Item "ntsc-film"
  307. 352x240
  308. .IP "\fBsqcif\fR" 4
  309. .IX Item "sqcif"
  310. 128x96
  311. .IP "\fBqcif\fR" 4
  312. .IX Item "qcif"
  313. 176x144
  314. .IP "\fBcif\fR" 4
  315. .IX Item "cif"
  316. 352x288
  317. .IP "\fB4cif\fR" 4
  318. .IX Item "4cif"
  319. 704x576
  320. .IP "\fB16cif\fR" 4
  321. .IX Item "16cif"
  322. 1408x1152
  323. .IP "\fBqqvga\fR" 4
  324. .IX Item "qqvga"
  325. 160x120
  326. .IP "\fBqvga\fR" 4
  327. .IX Item "qvga"
  328. 320x240
  329. .IP "\fBvga\fR" 4
  330. .IX Item "vga"
  331. 640x480
  332. .IP "\fBsvga\fR" 4
  333. .IX Item "svga"
  334. 800x600
  335. .IP "\fBxga\fR" 4
  336. .IX Item "xga"
  337. 1024x768
  338. .IP "\fBuxga\fR" 4
  339. .IX Item "uxga"
  340. 1600x1200
  341. .IP "\fBqxga\fR" 4
  342. .IX Item "qxga"
  343. 2048x1536
  344. .IP "\fBsxga\fR" 4
  345. .IX Item "sxga"
  346. 1280x1024
  347. .IP "\fBqsxga\fR" 4
  348. .IX Item "qsxga"
  349. 2560x2048
  350. .IP "\fBhsxga\fR" 4
  351. .IX Item "hsxga"
  352. 5120x4096
  353. .IP "\fBwvga\fR" 4
  354. .IX Item "wvga"
  355. 852x480
  356. .IP "\fBwxga\fR" 4
  357. .IX Item "wxga"
  358. 1366x768
  359. .IP "\fBwsxga\fR" 4
  360. .IX Item "wsxga"
  361. 1600x1024
  362. .IP "\fBwuxga\fR" 4
  363. .IX Item "wuxga"
  364. 1920x1200
  365. .IP "\fBwoxga\fR" 4
  366. .IX Item "woxga"
  367. 2560x1600
  368. .IP "\fBwqsxga\fR" 4
  369. .IX Item "wqsxga"
  370. 3200x2048
  371. .IP "\fBwquxga\fR" 4
  372. .IX Item "wquxga"
  373. 3840x2400
  374. .IP "\fBwhsxga\fR" 4
  375. .IX Item "whsxga"
  376. 6400x4096
  377. .IP "\fBwhuxga\fR" 4
  378. .IX Item "whuxga"
  379. 7680x4800
  380. .IP "\fBcga\fR" 4
  381. .IX Item "cga"
  382. 320x200
  383. .IP "\fBega\fR" 4
  384. .IX Item "ega"
  385. 640x350
  386. .IP "\fBhd480\fR" 4
  387. .IX Item "hd480"
  388. 852x480
  389. .IP "\fBhd720\fR" 4
  390. .IX Item "hd720"
  391. 1280x720
  392. .IP "\fBhd1080\fR" 4
  393. .IX Item "hd1080"
  394. 1920x1080
  395. .IP "\fB2k\fR" 4
  396. .IX Item "2k"
  397. 2048x1080
  398. .IP "\fB2kflat\fR" 4
  399. .IX Item "2kflat"
  400. 1998x1080
  401. .IP "\fB2kscope\fR" 4
  402. .IX Item "2kscope"
  403. 2048x858
  404. .IP "\fB4k\fR" 4
  405. .IX Item "4k"
  406. 4096x2160
  407. .IP "\fB4kflat\fR" 4
  408. .IX Item "4kflat"
  409. 3996x2160
  410. .IP "\fB4kscope\fR" 4
  411. .IX Item "4kscope"
  412. 4096x1716
  413. .IP "\fBnhd\fR" 4
  414. .IX Item "nhd"
  415. 640x360
  416. .IP "\fBhqvga\fR" 4
  417. .IX Item "hqvga"
  418. 240x160
  419. .IP "\fBwqvga\fR" 4
  420. .IX Item "wqvga"
  421. 400x240
  422. .IP "\fBfwqvga\fR" 4
  423. .IX Item "fwqvga"
  424. 432x240
  425. .IP "\fBhvga\fR" 4
  426. .IX Item "hvga"
  427. 480x320
  428. .IP "\fBqhd\fR" 4
  429. .IX Item "qhd"
  430. 960x540
  431. .IP "\fB2kdci\fR" 4
  432. .IX Item "2kdci"
  433. 2048x1080
  434. .IP "\fB4kdci\fR" 4
  435. .IX Item "4kdci"
  436. 4096x2160
  437. .IP "\fBuhd2160\fR" 4
  438. .IX Item "uhd2160"
  439. 3840x2160
  440. .IP "\fBuhd4320\fR" 4
  441. .IX Item "uhd4320"
  442. 7680x4320
  443. .SS "Video rate"
  444. .IX Subsection "Video rate"
  445. Specify the frame rate of a video, expressed as the number of frames
  446. generated per second. It has to be a string in the format
  447. \&\fIframe_rate_num\fR/\fIframe_rate_den\fR, an integer number, a float
  448. number or a valid video frame rate abbreviation.
  449. .PP
  450. The following abbreviations are recognized:
  451. .IP "\fBntsc\fR" 4
  452. .IX Item "ntsc"
  453. 30000/1001
  454. .IP "\fBpal\fR" 4
  455. .IX Item "pal"
  456. 25/1
  457. .IP "\fBqntsc\fR" 4
  458. .IX Item "qntsc"
  459. 30000/1001
  460. .IP "\fBqpal\fR" 4
  461. .IX Item "qpal"
  462. 25/1
  463. .IP "\fBsntsc\fR" 4
  464. .IX Item "sntsc"
  465. 30000/1001
  466. .IP "\fBspal\fR" 4
  467. .IX Item "spal"
  468. 25/1
  469. .IP "\fBfilm\fR" 4
  470. .IX Item "film"
  471. 24/1
  472. .IP "\fBntsc-film\fR" 4
  473. .IX Item "ntsc-film"
  474. 24000/1001
  475. .SS "Ratio"
  476. .IX Subsection "Ratio"
  477. A ratio can be expressed as an expression, or in the form
  478. \&\fInumerator\fR:\fIdenominator\fR.
  479. .PP
  480. Note that a ratio with infinite (1/0) or negative value is
  481. considered valid, so you should check on the returned value if you
  482. want to exclude those values.
  483. .PP
  484. The undefined value can be expressed using the \*(L"0:0\*(R" string.
  485. .SS "Color"
  486. .IX Subsection "Color"
  487. It can be the name of a color as defined below (case insensitive match) or a
  488. \&\f(CW\*(C`[0x|#]RRGGBB[AA]\*(C'\fR sequence, possibly followed by @ and a string
  489. representing the alpha component.
  490. .PP
  491. The alpha component may be a string composed by \*(L"0x\*(R" followed by an
  492. hexadecimal number or a decimal number between 0.0 and 1.0, which
  493. represents the opacity value (\fB0x00\fR or \fB0.0\fR means completely
  494. transparent, \fB0xff\fR or \fB1.0\fR completely opaque). If the alpha
  495. component is not specified then \fB0xff\fR is assumed.
  496. .PP
  497. The string \fBrandom\fR will result in a random color.
  498. .PP
  499. The following names of colors are recognized:
  500. .IP "\fBAliceBlue\fR" 4
  501. .IX Item "AliceBlue"
  502. 0xF0F8FF
  503. .IP "\fBAntiqueWhite\fR" 4
  504. .IX Item "AntiqueWhite"
  505. 0xFAEBD7
  506. .IP "\fBAqua\fR" 4
  507. .IX Item "Aqua"
  508. 0x00FFFF
  509. .IP "\fBAquamarine\fR" 4
  510. .IX Item "Aquamarine"
  511. 0x7FFFD4
  512. .IP "\fBAzure\fR" 4
  513. .IX Item "Azure"
  514. 0xF0FFFF
  515. .IP "\fBBeige\fR" 4
  516. .IX Item "Beige"
  517. 0xF5F5DC
  518. .IP "\fBBisque\fR" 4
  519. .IX Item "Bisque"
  520. 0xFFE4C4
  521. .IP "\fBBlack\fR" 4
  522. .IX Item "Black"
  523. 0x000000
  524. .IP "\fBBlanchedAlmond\fR" 4
  525. .IX Item "BlanchedAlmond"
  526. 0xFFEBCD
  527. .IP "\fBBlue\fR" 4
  528. .IX Item "Blue"
  529. 0x0000FF
  530. .IP "\fBBlueViolet\fR" 4
  531. .IX Item "BlueViolet"
  532. 0x8A2BE2
  533. .IP "\fBBrown\fR" 4
  534. .IX Item "Brown"
  535. 0xA52A2A
  536. .IP "\fBBurlyWood\fR" 4
  537. .IX Item "BurlyWood"
  538. 0xDEB887
  539. .IP "\fBCadetBlue\fR" 4
  540. .IX Item "CadetBlue"
  541. 0x5F9EA0
  542. .IP "\fBChartreuse\fR" 4
  543. .IX Item "Chartreuse"
  544. 0x7FFF00
  545. .IP "\fBChocolate\fR" 4
  546. .IX Item "Chocolate"
  547. 0xD2691E
  548. .IP "\fBCoral\fR" 4
  549. .IX Item "Coral"
  550. 0xFF7F50
  551. .IP "\fBCornflowerBlue\fR" 4
  552. .IX Item "CornflowerBlue"
  553. 0x6495ED
  554. .IP "\fBCornsilk\fR" 4
  555. .IX Item "Cornsilk"
  556. 0xFFF8DC
  557. .IP "\fBCrimson\fR" 4
  558. .IX Item "Crimson"
  559. 0xDC143C
  560. .IP "\fBCyan\fR" 4
  561. .IX Item "Cyan"
  562. 0x00FFFF
  563. .IP "\fBDarkBlue\fR" 4
  564. .IX Item "DarkBlue"
  565. 0x00008B
  566. .IP "\fBDarkCyan\fR" 4
  567. .IX Item "DarkCyan"
  568. 0x008B8B
  569. .IP "\fBDarkGoldenRod\fR" 4
  570. .IX Item "DarkGoldenRod"
  571. 0xB8860B
  572. .IP "\fBDarkGray\fR" 4
  573. .IX Item "DarkGray"
  574. 0xA9A9A9
  575. .IP "\fBDarkGreen\fR" 4
  576. .IX Item "DarkGreen"
  577. 0x006400
  578. .IP "\fBDarkKhaki\fR" 4
  579. .IX Item "DarkKhaki"
  580. 0xBDB76B
  581. .IP "\fBDarkMagenta\fR" 4
  582. .IX Item "DarkMagenta"
  583. 0x8B008B
  584. .IP "\fBDarkOliveGreen\fR" 4
  585. .IX Item "DarkOliveGreen"
  586. 0x556B2F
  587. .IP "\fBDarkorange\fR" 4
  588. .IX Item "Darkorange"
  589. 0xFF8C00
  590. .IP "\fBDarkOrchid\fR" 4
  591. .IX Item "DarkOrchid"
  592. 0x9932CC
  593. .IP "\fBDarkRed\fR" 4
  594. .IX Item "DarkRed"
  595. 0x8B0000
  596. .IP "\fBDarkSalmon\fR" 4
  597. .IX Item "DarkSalmon"
  598. 0xE9967A
  599. .IP "\fBDarkSeaGreen\fR" 4
  600. .IX Item "DarkSeaGreen"
  601. 0x8FBC8F
  602. .IP "\fBDarkSlateBlue\fR" 4
  603. .IX Item "DarkSlateBlue"
  604. 0x483D8B
  605. .IP "\fBDarkSlateGray\fR" 4
  606. .IX Item "DarkSlateGray"
  607. 0x2F4F4F
  608. .IP "\fBDarkTurquoise\fR" 4
  609. .IX Item "DarkTurquoise"
  610. 0x00CED1
  611. .IP "\fBDarkViolet\fR" 4
  612. .IX Item "DarkViolet"
  613. 0x9400D3
  614. .IP "\fBDeepPink\fR" 4
  615. .IX Item "DeepPink"
  616. 0xFF1493
  617. .IP "\fBDeepSkyBlue\fR" 4
  618. .IX Item "DeepSkyBlue"
  619. 0x00BFFF
  620. .IP "\fBDimGray\fR" 4
  621. .IX Item "DimGray"
  622. 0x696969
  623. .IP "\fBDodgerBlue\fR" 4
  624. .IX Item "DodgerBlue"
  625. 0x1E90FF
  626. .IP "\fBFireBrick\fR" 4
  627. .IX Item "FireBrick"
  628. 0xB22222
  629. .IP "\fBFloralWhite\fR" 4
  630. .IX Item "FloralWhite"
  631. 0xFFFAF0
  632. .IP "\fBForestGreen\fR" 4
  633. .IX Item "ForestGreen"
  634. 0x228B22
  635. .IP "\fBFuchsia\fR" 4
  636. .IX Item "Fuchsia"
  637. 0xFF00FF
  638. .IP "\fBGainsboro\fR" 4
  639. .IX Item "Gainsboro"
  640. 0xDCDCDC
  641. .IP "\fBGhostWhite\fR" 4
  642. .IX Item "GhostWhite"
  643. 0xF8F8FF
  644. .IP "\fBGold\fR" 4
  645. .IX Item "Gold"
  646. 0xFFD700
  647. .IP "\fBGoldenRod\fR" 4
  648. .IX Item "GoldenRod"
  649. 0xDAA520
  650. .IP "\fBGray\fR" 4
  651. .IX Item "Gray"
  652. 0x808080
  653. .IP "\fBGreen\fR" 4
  654. .IX Item "Green"
  655. 0x008000
  656. .IP "\fBGreenYellow\fR" 4
  657. .IX Item "GreenYellow"
  658. 0xADFF2F
  659. .IP "\fBHoneyDew\fR" 4
  660. .IX Item "HoneyDew"
  661. 0xF0FFF0
  662. .IP "\fBHotPink\fR" 4
  663. .IX Item "HotPink"
  664. 0xFF69B4
  665. .IP "\fBIndianRed\fR" 4
  666. .IX Item "IndianRed"
  667. 0xCD5C5C
  668. .IP "\fBIndigo\fR" 4
  669. .IX Item "Indigo"
  670. 0x4B0082
  671. .IP "\fBIvory\fR" 4
  672. .IX Item "Ivory"
  673. 0xFFFFF0
  674. .IP "\fBKhaki\fR" 4
  675. .IX Item "Khaki"
  676. 0xF0E68C
  677. .IP "\fBLavender\fR" 4
  678. .IX Item "Lavender"
  679. 0xE6E6FA
  680. .IP "\fBLavenderBlush\fR" 4
  681. .IX Item "LavenderBlush"
  682. 0xFFF0F5
  683. .IP "\fBLawnGreen\fR" 4
  684. .IX Item "LawnGreen"
  685. 0x7CFC00
  686. .IP "\fBLemonChiffon\fR" 4
  687. .IX Item "LemonChiffon"
  688. 0xFFFACD
  689. .IP "\fBLightBlue\fR" 4
  690. .IX Item "LightBlue"
  691. 0xADD8E6
  692. .IP "\fBLightCoral\fR" 4
  693. .IX Item "LightCoral"
  694. 0xF08080
  695. .IP "\fBLightCyan\fR" 4
  696. .IX Item "LightCyan"
  697. 0xE0FFFF
  698. .IP "\fBLightGoldenRodYellow\fR" 4
  699. .IX Item "LightGoldenRodYellow"
  700. 0xFAFAD2
  701. .IP "\fBLightGreen\fR" 4
  702. .IX Item "LightGreen"
  703. 0x90EE90
  704. .IP "\fBLightGrey\fR" 4
  705. .IX Item "LightGrey"
  706. 0xD3D3D3
  707. .IP "\fBLightPink\fR" 4
  708. .IX Item "LightPink"
  709. 0xFFB6C1
  710. .IP "\fBLightSalmon\fR" 4
  711. .IX Item "LightSalmon"
  712. 0xFFA07A
  713. .IP "\fBLightSeaGreen\fR" 4
  714. .IX Item "LightSeaGreen"
  715. 0x20B2AA
  716. .IP "\fBLightSkyBlue\fR" 4
  717. .IX Item "LightSkyBlue"
  718. 0x87CEFA
  719. .IP "\fBLightSlateGray\fR" 4
  720. .IX Item "LightSlateGray"
  721. 0x778899
  722. .IP "\fBLightSteelBlue\fR" 4
  723. .IX Item "LightSteelBlue"
  724. 0xB0C4DE
  725. .IP "\fBLightYellow\fR" 4
  726. .IX Item "LightYellow"
  727. 0xFFFFE0
  728. .IP "\fBLime\fR" 4
  729. .IX Item "Lime"
  730. 0x00FF00
  731. .IP "\fBLimeGreen\fR" 4
  732. .IX Item "LimeGreen"
  733. 0x32CD32
  734. .IP "\fBLinen\fR" 4
  735. .IX Item "Linen"
  736. 0xFAF0E6
  737. .IP "\fBMagenta\fR" 4
  738. .IX Item "Magenta"
  739. 0xFF00FF
  740. .IP "\fBMaroon\fR" 4
  741. .IX Item "Maroon"
  742. 0x800000
  743. .IP "\fBMediumAquaMarine\fR" 4
  744. .IX Item "MediumAquaMarine"
  745. 0x66CDAA
  746. .IP "\fBMediumBlue\fR" 4
  747. .IX Item "MediumBlue"
  748. 0x0000CD
  749. .IP "\fBMediumOrchid\fR" 4
  750. .IX Item "MediumOrchid"
  751. 0xBA55D3
  752. .IP "\fBMediumPurple\fR" 4
  753. .IX Item "MediumPurple"
  754. 0x9370D8
  755. .IP "\fBMediumSeaGreen\fR" 4
  756. .IX Item "MediumSeaGreen"
  757. 0x3CB371
  758. .IP "\fBMediumSlateBlue\fR" 4
  759. .IX Item "MediumSlateBlue"
  760. 0x7B68EE
  761. .IP "\fBMediumSpringGreen\fR" 4
  762. .IX Item "MediumSpringGreen"
  763. 0x00FA9A
  764. .IP "\fBMediumTurquoise\fR" 4
  765. .IX Item "MediumTurquoise"
  766. 0x48D1CC
  767. .IP "\fBMediumVioletRed\fR" 4
  768. .IX Item "MediumVioletRed"
  769. 0xC71585
  770. .IP "\fBMidnightBlue\fR" 4
  771. .IX Item "MidnightBlue"
  772. 0x191970
  773. .IP "\fBMintCream\fR" 4
  774. .IX Item "MintCream"
  775. 0xF5FFFA
  776. .IP "\fBMistyRose\fR" 4
  777. .IX Item "MistyRose"
  778. 0xFFE4E1
  779. .IP "\fBMoccasin\fR" 4
  780. .IX Item "Moccasin"
  781. 0xFFE4B5
  782. .IP "\fBNavajoWhite\fR" 4
  783. .IX Item "NavajoWhite"
  784. 0xFFDEAD
  785. .IP "\fBNavy\fR" 4
  786. .IX Item "Navy"
  787. 0x000080
  788. .IP "\fBOldLace\fR" 4
  789. .IX Item "OldLace"
  790. 0xFDF5E6
  791. .IP "\fBOlive\fR" 4
  792. .IX Item "Olive"
  793. 0x808000
  794. .IP "\fBOliveDrab\fR" 4
  795. .IX Item "OliveDrab"
  796. 0x6B8E23
  797. .IP "\fBOrange\fR" 4
  798. .IX Item "Orange"
  799. 0xFFA500
  800. .IP "\fBOrangeRed\fR" 4
  801. .IX Item "OrangeRed"
  802. 0xFF4500
  803. .IP "\fBOrchid\fR" 4
  804. .IX Item "Orchid"
  805. 0xDA70D6
  806. .IP "\fBPaleGoldenRod\fR" 4
  807. .IX Item "PaleGoldenRod"
  808. 0xEEE8AA
  809. .IP "\fBPaleGreen\fR" 4
  810. .IX Item "PaleGreen"
  811. 0x98FB98
  812. .IP "\fBPaleTurquoise\fR" 4
  813. .IX Item "PaleTurquoise"
  814. 0xAFEEEE
  815. .IP "\fBPaleVioletRed\fR" 4
  816. .IX Item "PaleVioletRed"
  817. 0xD87093
  818. .IP "\fBPapayaWhip\fR" 4
  819. .IX Item "PapayaWhip"
  820. 0xFFEFD5
  821. .IP "\fBPeachPuff\fR" 4
  822. .IX Item "PeachPuff"
  823. 0xFFDAB9
  824. .IP "\fBPeru\fR" 4
  825. .IX Item "Peru"
  826. 0xCD853F
  827. .IP "\fBPink\fR" 4
  828. .IX Item "Pink"
  829. 0xFFC0CB
  830. .IP "\fBPlum\fR" 4
  831. .IX Item "Plum"
  832. 0xDDA0DD
  833. .IP "\fBPowderBlue\fR" 4
  834. .IX Item "PowderBlue"
  835. 0xB0E0E6
  836. .IP "\fBPurple\fR" 4
  837. .IX Item "Purple"
  838. 0x800080
  839. .IP "\fBRed\fR" 4
  840. .IX Item "Red"
  841. 0xFF0000
  842. .IP "\fBRosyBrown\fR" 4
  843. .IX Item "RosyBrown"
  844. 0xBC8F8F
  845. .IP "\fBRoyalBlue\fR" 4
  846. .IX Item "RoyalBlue"
  847. 0x4169E1
  848. .IP "\fBSaddleBrown\fR" 4
  849. .IX Item "SaddleBrown"
  850. 0x8B4513
  851. .IP "\fBSalmon\fR" 4
  852. .IX Item "Salmon"
  853. 0xFA8072
  854. .IP "\fBSandyBrown\fR" 4
  855. .IX Item "SandyBrown"
  856. 0xF4A460
  857. .IP "\fBSeaGreen\fR" 4
  858. .IX Item "SeaGreen"
  859. 0x2E8B57
  860. .IP "\fBSeaShell\fR" 4
  861. .IX Item "SeaShell"
  862. 0xFFF5EE
  863. .IP "\fBSienna\fR" 4
  864. .IX Item "Sienna"
  865. 0xA0522D
  866. .IP "\fBSilver\fR" 4
  867. .IX Item "Silver"
  868. 0xC0C0C0
  869. .IP "\fBSkyBlue\fR" 4
  870. .IX Item "SkyBlue"
  871. 0x87CEEB
  872. .IP "\fBSlateBlue\fR" 4
  873. .IX Item "SlateBlue"
  874. 0x6A5ACD
  875. .IP "\fBSlateGray\fR" 4
  876. .IX Item "SlateGray"
  877. 0x708090
  878. .IP "\fBSnow\fR" 4
  879. .IX Item "Snow"
  880. 0xFFFAFA
  881. .IP "\fBSpringGreen\fR" 4
  882. .IX Item "SpringGreen"
  883. 0x00FF7F
  884. .IP "\fBSteelBlue\fR" 4
  885. .IX Item "SteelBlue"
  886. 0x4682B4
  887. .IP "\fBTan\fR" 4
  888. .IX Item "Tan"
  889. 0xD2B48C
  890. .IP "\fBTeal\fR" 4
  891. .IX Item "Teal"
  892. 0x008080
  893. .IP "\fBThistle\fR" 4
  894. .IX Item "Thistle"
  895. 0xD8BFD8
  896. .IP "\fBTomato\fR" 4
  897. .IX Item "Tomato"
  898. 0xFF6347
  899. .IP "\fBTurquoise\fR" 4
  900. .IX Item "Turquoise"
  901. 0x40E0D0
  902. .IP "\fBViolet\fR" 4
  903. .IX Item "Violet"
  904. 0xEE82EE
  905. .IP "\fBWheat\fR" 4
  906. .IX Item "Wheat"
  907. 0xF5DEB3
  908. .IP "\fBWhite\fR" 4
  909. .IX Item "White"
  910. 0xFFFFFF
  911. .IP "\fBWhiteSmoke\fR" 4
  912. .IX Item "WhiteSmoke"
  913. 0xF5F5F5
  914. .IP "\fBYellow\fR" 4
  915. .IX Item "Yellow"
  916. 0xFFFF00
  917. .IP "\fBYellowGreen\fR" 4
  918. .IX Item "YellowGreen"
  919. 0x9ACD32
  920. .SS "Channel Layout"
  921. .IX Subsection "Channel Layout"
  922. A channel layout specifies the spatial disposition of the channels in
  923. a multi-channel audio stream. To specify a channel layout, FFmpeg
  924. makes use of a special syntax.
  925. .PP
  926. Individual channels are identified by an id, as given by the table
  927. below:
  928. .IP "\fB\s-1FL\s0\fR" 4
  929. .IX Item "FL"
  930. front left
  931. .IP "\fB\s-1FR\s0\fR" 4
  932. .IX Item "FR"
  933. front right
  934. .IP "\fB\s-1FC\s0\fR" 4
  935. .IX Item "FC"
  936. front center
  937. .IP "\fB\s-1LFE\s0\fR" 4
  938. .IX Item "LFE"
  939. low frequency
  940. .IP "\fB\s-1BL\s0\fR" 4
  941. .IX Item "BL"
  942. back left
  943. .IP "\fB\s-1BR\s0\fR" 4
  944. .IX Item "BR"
  945. back right
  946. .IP "\fB\s-1FLC\s0\fR" 4
  947. .IX Item "FLC"
  948. front left-of-center
  949. .IP "\fB\s-1FRC\s0\fR" 4
  950. .IX Item "FRC"
  951. front right-of-center
  952. .IP "\fB\s-1BC\s0\fR" 4
  953. .IX Item "BC"
  954. back center
  955. .IP "\fB\s-1SL\s0\fR" 4
  956. .IX Item "SL"
  957. side left
  958. .IP "\fB\s-1SR\s0\fR" 4
  959. .IX Item "SR"
  960. side right
  961. .IP "\fB\s-1TC\s0\fR" 4
  962. .IX Item "TC"
  963. top center
  964. .IP "\fB\s-1TFL\s0\fR" 4
  965. .IX Item "TFL"
  966. top front left
  967. .IP "\fB\s-1TFC\s0\fR" 4
  968. .IX Item "TFC"
  969. top front center
  970. .IP "\fB\s-1TFR\s0\fR" 4
  971. .IX Item "TFR"
  972. top front right
  973. .IP "\fB\s-1TBL\s0\fR" 4
  974. .IX Item "TBL"
  975. top back left
  976. .IP "\fB\s-1TBC\s0\fR" 4
  977. .IX Item "TBC"
  978. top back center
  979. .IP "\fB\s-1TBR\s0\fR" 4
  980. .IX Item "TBR"
  981. top back right
  982. .IP "\fB\s-1DL\s0\fR" 4
  983. .IX Item "DL"
  984. downmix left
  985. .IP "\fB\s-1DR\s0\fR" 4
  986. .IX Item "DR"
  987. downmix right
  988. .IP "\fB\s-1WL\s0\fR" 4
  989. .IX Item "WL"
  990. wide left
  991. .IP "\fB\s-1WR\s0\fR" 4
  992. .IX Item "WR"
  993. wide right
  994. .IP "\fB\s-1SDL\s0\fR" 4
  995. .IX Item "SDL"
  996. surround direct left
  997. .IP "\fB\s-1SDR\s0\fR" 4
  998. .IX Item "SDR"
  999. surround direct right
  1000. .IP "\fB\s-1LFE2\s0\fR" 4
  1001. .IX Item "LFE2"
  1002. low frequency 2
  1003. .PP
  1004. Standard channel layout compositions can be specified by using the
  1005. following identifiers:
  1006. .IP "\fBmono\fR" 4
  1007. .IX Item "mono"
  1008. \&\s-1FC\s0
  1009. .IP "\fBstereo\fR" 4
  1010. .IX Item "stereo"
  1011. \&\s-1FL+FR\s0
  1012. .IP "\fB2.1\fR" 4
  1013. .IX Item "2.1"
  1014. \&\s-1FL+FR+LFE\s0
  1015. .IP "\fB3.0\fR" 4
  1016. .IX Item "3.0"
  1017. \&\s-1FL+FR+FC\s0
  1018. .IP "\fB3.0(back)\fR" 4
  1019. .IX Item "3.0(back)"
  1020. \&\s-1FL+FR+BC\s0
  1021. .IP "\fB4.0\fR" 4
  1022. .IX Item "4.0"
  1023. \&\s-1FL+FR+FC+BC\s0
  1024. .IP "\fBquad\fR" 4
  1025. .IX Item "quad"
  1026. \&\s-1FL+FR+BL+BR\s0
  1027. .IP "\fBquad(side)\fR" 4
  1028. .IX Item "quad(side)"
  1029. \&\s-1FL+FR+SL+SR\s0
  1030. .IP "\fB3.1\fR" 4
  1031. .IX Item "3.1"
  1032. \&\s-1FL+FR+FC+LFE\s0
  1033. .IP "\fB5.0\fR" 4
  1034. .IX Item "5.0"
  1035. \&\s-1FL+FR+FC+BL+BR\s0
  1036. .IP "\fB5.0(side)\fR" 4
  1037. .IX Item "5.0(side)"
  1038. \&\s-1FL+FR+FC+SL+SR\s0
  1039. .IP "\fB4.1\fR" 4
  1040. .IX Item "4.1"
  1041. \&\s-1FL+FR+FC+LFE+BC\s0
  1042. .IP "\fB5.1\fR" 4
  1043. .IX Item "5.1"
  1044. \&\s-1FL+FR+FC+LFE+BL+BR\s0
  1045. .IP "\fB5.1(side)\fR" 4
  1046. .IX Item "5.1(side)"
  1047. \&\s-1FL+FR+FC+LFE+SL+SR\s0
  1048. .IP "\fB6.0\fR" 4
  1049. .IX Item "6.0"
  1050. \&\s-1FL+FR+FC+BC+SL+SR\s0
  1051. .IP "\fB6.0(front)\fR" 4
  1052. .IX Item "6.0(front)"
  1053. \&\s-1FL+FR+FLC+FRC+SL+SR\s0
  1054. .IP "\fBhexagonal\fR" 4
  1055. .IX Item "hexagonal"
  1056. \&\s-1FL+FR+FC+BL+BR+BC\s0
  1057. .IP "\fB6.1\fR" 4
  1058. .IX Item "6.1"
  1059. \&\s-1FL+FR+FC+LFE+BC+SL+SR\s0
  1060. .IP "\fB6.1\fR" 4
  1061. .IX Item "6.1"
  1062. \&\s-1FL+FR+FC+LFE+BL+BR+BC\s0
  1063. .IP "\fB6.1(front)\fR" 4
  1064. .IX Item "6.1(front)"
  1065. \&\s-1FL+FR+LFE+FLC+FRC+SL+SR\s0
  1066. .IP "\fB7.0\fR" 4
  1067. .IX Item "7.0"
  1068. \&\s-1FL+FR+FC+BL+BR+SL+SR\s0
  1069. .IP "\fB7.0(front)\fR" 4
  1070. .IX Item "7.0(front)"
  1071. \&\s-1FL+FR+FC+FLC+FRC+SL+SR\s0
  1072. .IP "\fB7.1\fR" 4
  1073. .IX Item "7.1"
  1074. \&\s-1FL+FR+FC+LFE+BL+BR+SL+SR\s0
  1075. .IP "\fB7.1(wide)\fR" 4
  1076. .IX Item "7.1(wide)"
  1077. \&\s-1FL+FR+FC+LFE+BL+BR+FLC+FRC\s0
  1078. .IP "\fB7.1(wide\-side)\fR" 4
  1079. .IX Item "7.1(wide-side)"
  1080. \&\s-1FL+FR+FC+LFE+FLC+FRC+SL+SR\s0
  1081. .IP "\fBoctagonal\fR" 4
  1082. .IX Item "octagonal"
  1083. \&\s-1FL+FR+FC+BL+BR+BC+SL+SR\s0
  1084. .IP "\fBhexadecagonal\fR" 4
  1085. .IX Item "hexadecagonal"
  1086. \&\s-1FL+FR+FC+BL+BR+BC+SL+SR+WL+WR+TBL+TBR+TBC+TFC+TFL+TFR\s0
  1087. .IP "\fBdownmix\fR" 4
  1088. .IX Item "downmix"
  1089. \&\s-1DL+DR\s0
  1090. .PP
  1091. A custom channel layout can be specified as a sequence of terms, separated by
  1092. \&'+' or '|'. Each term can be:
  1093. .IP "\(bu" 4
  1094. the name of a standard channel layout (e.g. \fBmono\fR,
  1095. \&\fBstereo\fR, \fB4.0\fR, \fBquad\fR, \fB5.0\fR, etc.)
  1096. .IP "\(bu" 4
  1097. the name of a single channel (e.g. \fB\s-1FL\s0\fR, \fB\s-1FR\s0\fR, \fB\s-1FC\s0\fR, \fB\s-1LFE\s0\fR, etc.)
  1098. .IP "\(bu" 4
  1099. a number of channels, in decimal, followed by 'c', yielding the default channel
  1100. layout for that number of channels (see the function
  1101. \&\f(CW\*(C`av_get_default_channel_layout\*(C'\fR). Note that not all channel counts have a
  1102. default layout.
  1103. .IP "\(bu" 4
  1104. a number of channels, in decimal, followed by 'C', yielding an unknown channel
  1105. layout with the specified number of channels. Note that not all channel layout
  1106. specification strings support unknown channel layouts.
  1107. .IP "\(bu" 4
  1108. a channel layout mask, in hexadecimal starting with \*(L"0x\*(R" (see the
  1109. \&\f(CW\*(C`AV_CH_*\*(C'\fR macros in \fIlibavutil/channel_layout.h\fR.
  1110. .PP
  1111. Before libavutil version 53 the trailing character \*(L"c\*(R" to specify a number of
  1112. channels was optional, but now it is required, while a channel layout mask can
  1113. also be specified as a decimal number (if and only if not followed by \*(L"c\*(R" or \*(L"C\*(R").
  1114. .PP
  1115. See also the function \f(CW\*(C`av_get_channel_layout\*(C'\fR defined in
  1116. \&\fIlibavutil/channel_layout.h\fR.
  1117. .SH "EXPRESSION EVALUATION"
  1118. .IX Header "EXPRESSION EVALUATION"
  1119. When evaluating an arithmetic expression, FFmpeg uses an internal
  1120. formula evaluator, implemented through the \fIlibavutil/eval.h\fR
  1121. interface.
  1122. .PP
  1123. An expression may contain unary, binary operators, constants, and
  1124. functions.
  1125. .PP
  1126. Two expressions \fIexpr1\fR and \fIexpr2\fR can be combined to form
  1127. another expression "\fIexpr1\fR;\fIexpr2\fR".
  1128. \&\fIexpr1\fR and \fIexpr2\fR are evaluated in turn, and the new
  1129. expression evaluates to the value of \fIexpr2\fR.
  1130. .PP
  1131. The following binary operators are available: \f(CW\*(C`+\*(C'\fR, \f(CW\*(C`\-\*(C'\fR,
  1132. \&\f(CW\*(C`*\*(C'\fR, \f(CW\*(C`/\*(C'\fR, \f(CW\*(C`^\*(C'\fR.
  1133. .PP
  1134. The following unary operators are available: \f(CW\*(C`+\*(C'\fR, \f(CW\*(C`\-\*(C'\fR.
  1135. .PP
  1136. The following functions are available:
  1137. .IP "\fBabs(x)\fR" 4
  1138. .IX Item "abs(x)"
  1139. Compute absolute value of \fIx\fR.
  1140. .IP "\fBacos(x)\fR" 4
  1141. .IX Item "acos(x)"
  1142. Compute arccosine of \fIx\fR.
  1143. .IP "\fBasin(x)\fR" 4
  1144. .IX Item "asin(x)"
  1145. Compute arcsine of \fIx\fR.
  1146. .IP "\fBatan(x)\fR" 4
  1147. .IX Item "atan(x)"
  1148. Compute arctangent of \fIx\fR.
  1149. .IP "\fBatan2(x, y)\fR" 4
  1150. .IX Item "atan2(x, y)"
  1151. Compute principal value of the arc tangent of \fIy\fR/\fIx\fR.
  1152. .IP "\fBbetween(x, min, max)\fR" 4
  1153. .IX Item "between(x, min, max)"
  1154. Return 1 if \fIx\fR is greater than or equal to \fImin\fR and lesser than or
  1155. equal to \fImax\fR, 0 otherwise.
  1156. .IP "\fBbitand(x, y)\fR" 4
  1157. .IX Item "bitand(x, y)"
  1158. .PD 0
  1159. .IP "\fBbitor(x, y)\fR" 4
  1160. .IX Item "bitor(x, y)"
  1161. .PD
  1162. Compute bitwise and/or operation on \fIx\fR and \fIy\fR.
  1163. .Sp
  1164. The results of the evaluation of \fIx\fR and \fIy\fR are converted to
  1165. integers before executing the bitwise operation.
  1166. .Sp
  1167. Note that both the conversion to integer and the conversion back to
  1168. floating point can lose precision. Beware of unexpected results for
  1169. large numbers (usually 2^53 and larger).
  1170. .IP "\fBceil(expr)\fR" 4
  1171. .IX Item "ceil(expr)"
  1172. Round the value of expression \fIexpr\fR upwards to the nearest
  1173. integer. For example, \*(L"ceil(1.5)\*(R" is \*(L"2.0\*(R".
  1174. .IP "\fBclip(x, min, max)\fR" 4
  1175. .IX Item "clip(x, min, max)"
  1176. Return the value of \fIx\fR clipped between \fImin\fR and \fImax\fR.
  1177. .IP "\fBcos(x)\fR" 4
  1178. .IX Item "cos(x)"
  1179. Compute cosine of \fIx\fR.
  1180. .IP "\fBcosh(x)\fR" 4
  1181. .IX Item "cosh(x)"
  1182. Compute hyperbolic cosine of \fIx\fR.
  1183. .IP "\fBeq(x, y)\fR" 4
  1184. .IX Item "eq(x, y)"
  1185. Return 1 if \fIx\fR and \fIy\fR are equivalent, 0 otherwise.
  1186. .IP "\fBexp(x)\fR" 4
  1187. .IX Item "exp(x)"
  1188. Compute exponential of \fIx\fR (with base \f(CW\*(C`e\*(C'\fR, the Euler's number).
  1189. .IP "\fBfloor(expr)\fR" 4
  1190. .IX Item "floor(expr)"
  1191. Round the value of expression \fIexpr\fR downwards to the nearest
  1192. integer. For example, \*(L"floor(\-1.5)\*(R" is \*(L"\-2.0\*(R".
  1193. .IP "\fBgauss(x)\fR" 4
  1194. .IX Item "gauss(x)"
  1195. Compute Gauss function of \fIx\fR, corresponding to
  1196. \&\f(CW\*(C`exp(\-x*x/2) / sqrt(2*PI)\*(C'\fR.
  1197. .IP "\fBgcd(x, y)\fR" 4
  1198. .IX Item "gcd(x, y)"
  1199. Return the greatest common divisor of \fIx\fR and \fIy\fR. If both \fIx\fR and
  1200. \&\fIy\fR are 0 or either or both are less than zero then behavior is undefined.
  1201. .IP "\fBgt(x, y)\fR" 4
  1202. .IX Item "gt(x, y)"
  1203. Return 1 if \fIx\fR is greater than \fIy\fR, 0 otherwise.
  1204. .IP "\fBgte(x, y)\fR" 4
  1205. .IX Item "gte(x, y)"
  1206. Return 1 if \fIx\fR is greater than or equal to \fIy\fR, 0 otherwise.
  1207. .IP "\fBhypot(x, y)\fR" 4
  1208. .IX Item "hypot(x, y)"
  1209. This function is similar to the C function with the same name; it returns
  1210. "sqrt(\fIx\fR*\fIx\fR + \fIy\fR*\fIy\fR)", the length of the hypotenuse of a
  1211. right triangle with sides of length \fIx\fR and \fIy\fR, or the distance of the
  1212. point (\fIx\fR, \fIy\fR) from the origin.
  1213. .IP "\fBif(x, y)\fR" 4
  1214. .IX Item "if(x, y)"
  1215. Evaluate \fIx\fR, and if the result is non-zero return the result of
  1216. the evaluation of \fIy\fR, return 0 otherwise.
  1217. .IP "\fBif(x, y, z)\fR" 4
  1218. .IX Item "if(x, y, z)"
  1219. Evaluate \fIx\fR, and if the result is non-zero return the evaluation
  1220. result of \fIy\fR, otherwise the evaluation result of \fIz\fR.
  1221. .IP "\fBifnot(x, y)\fR" 4
  1222. .IX Item "ifnot(x, y)"
  1223. Evaluate \fIx\fR, and if the result is zero return the result of the
  1224. evaluation of \fIy\fR, return 0 otherwise.
  1225. .IP "\fBifnot(x, y, z)\fR" 4
  1226. .IX Item "ifnot(x, y, z)"
  1227. Evaluate \fIx\fR, and if the result is zero return the evaluation
  1228. result of \fIy\fR, otherwise the evaluation result of \fIz\fR.
  1229. .IP "\fBisinf(x)\fR" 4
  1230. .IX Item "isinf(x)"
  1231. Return 1.0 if \fIx\fR is +/\-INFINITY, 0.0 otherwise.
  1232. .IP "\fBisnan(x)\fR" 4
  1233. .IX Item "isnan(x)"
  1234. Return 1.0 if \fIx\fR is \s-1NAN, 0.0\s0 otherwise.
  1235. .IP "\fBld(var)\fR" 4
  1236. .IX Item "ld(var)"
  1237. Load the value of the internal variable with number
  1238. \&\fIvar\fR, which was previously stored with st(\fIvar\fR, \fIexpr\fR).
  1239. The function returns the loaded value.
  1240. .IP "\fBlerp(x, y, z)\fR" 4
  1241. .IX Item "lerp(x, y, z)"
  1242. Return linear interpolation between \fIx\fR and \fIy\fR by amount of \fIz\fR.
  1243. .IP "\fBlog(x)\fR" 4
  1244. .IX Item "log(x)"
  1245. Compute natural logarithm of \fIx\fR.
  1246. .IP "\fBlt(x, y)\fR" 4
  1247. .IX Item "lt(x, y)"
  1248. Return 1 if \fIx\fR is lesser than \fIy\fR, 0 otherwise.
  1249. .IP "\fBlte(x, y)\fR" 4
  1250. .IX Item "lte(x, y)"
  1251. Return 1 if \fIx\fR is lesser than or equal to \fIy\fR, 0 otherwise.
  1252. .IP "\fBmax(x, y)\fR" 4
  1253. .IX Item "max(x, y)"
  1254. Return the maximum between \fIx\fR and \fIy\fR.
  1255. .IP "\fBmin(x, y)\fR" 4
  1256. .IX Item "min(x, y)"
  1257. Return the minimum between \fIx\fR and \fIy\fR.
  1258. .IP "\fBmod(x, y)\fR" 4
  1259. .IX Item "mod(x, y)"
  1260. Compute the remainder of division of \fIx\fR by \fIy\fR.
  1261. .IP "\fBnot(expr)\fR" 4
  1262. .IX Item "not(expr)"
  1263. Return 1.0 if \fIexpr\fR is zero, 0.0 otherwise.
  1264. .IP "\fBpow(x, y)\fR" 4
  1265. .IX Item "pow(x, y)"
  1266. Compute the power of \fIx\fR elevated \fIy\fR, it is equivalent to
  1267. "(\fIx\fR)^(\fIy\fR)".
  1268. .IP "\fBprint(t)\fR" 4
  1269. .IX Item "print(t)"
  1270. .PD 0
  1271. .IP "\fBprint(t, l)\fR" 4
  1272. .IX Item "print(t, l)"
  1273. .PD
  1274. Print the value of expression \fIt\fR with loglevel \fIl\fR. If
  1275. \&\fIl\fR is not specified then a default log level is used.
  1276. Returns the value of the expression printed.
  1277. .Sp
  1278. Prints t with loglevel l
  1279. .IP "\fBrandom(x)\fR" 4
  1280. .IX Item "random(x)"
  1281. Return a pseudo random value between 0.0 and 1.0. \fIx\fR is the index of the
  1282. internal variable which will be used to save the seed/state.
  1283. .IP "\fBroot(expr, max)\fR" 4
  1284. .IX Item "root(expr, max)"
  1285. Find an input value for which the function represented by \fIexpr\fR
  1286. with argument \fI\f(BIld\fI\|(0)\fR is 0 in the interval 0..\fImax\fR.
  1287. .Sp
  1288. The expression in \fIexpr\fR must denote a continuous function or the
  1289. result is undefined.
  1290. .Sp
  1291. \&\fI\f(BIld\fI\|(0)\fR is used to represent the function input value, which means
  1292. that the given expression will be evaluated multiple times with
  1293. various input values that the expression can access through
  1294. \&\f(CWld(0)\fR. When the expression evaluates to 0 then the
  1295. corresponding input value will be returned.
  1296. .IP "\fBround(expr)\fR" 4
  1297. .IX Item "round(expr)"
  1298. Round the value of expression \fIexpr\fR to the nearest integer. For example, \*(L"round(1.5)\*(R" is \*(L"2.0\*(R".
  1299. .IP "\fBsgn(x)\fR" 4
  1300. .IX Item "sgn(x)"
  1301. Compute sign of \fIx\fR.
  1302. .IP "\fBsin(x)\fR" 4
  1303. .IX Item "sin(x)"
  1304. Compute sine of \fIx\fR.
  1305. .IP "\fBsinh(x)\fR" 4
  1306. .IX Item "sinh(x)"
  1307. Compute hyperbolic sine of \fIx\fR.
  1308. .IP "\fBsqrt(expr)\fR" 4
  1309. .IX Item "sqrt(expr)"
  1310. Compute the square root of \fIexpr\fR. This is equivalent to
  1311. "(\fIexpr\fR)^.5".
  1312. .IP "\fBsquish(x)\fR" 4
  1313. .IX Item "squish(x)"
  1314. Compute expression \f(CW\*(C`1/(1 + exp(4*x))\*(C'\fR.
  1315. .IP "\fBst(var, expr)\fR" 4
  1316. .IX Item "st(var, expr)"
  1317. Store the value of the expression \fIexpr\fR in an internal
  1318. variable. \fIvar\fR specifies the number of the variable where to
  1319. store the value, and it is a value ranging from 0 to 9. The function
  1320. returns the value stored in the internal variable.
  1321. Note, Variables are currently not shared between expressions.
  1322. .IP "\fBtan(x)\fR" 4
  1323. .IX Item "tan(x)"
  1324. Compute tangent of \fIx\fR.
  1325. .IP "\fBtanh(x)\fR" 4
  1326. .IX Item "tanh(x)"
  1327. Compute hyperbolic tangent of \fIx\fR.
  1328. .IP "\fBtaylor(expr, x)\fR" 4
  1329. .IX Item "taylor(expr, x)"
  1330. .PD 0
  1331. .IP "\fBtaylor(expr, x, id)\fR" 4
  1332. .IX Item "taylor(expr, x, id)"
  1333. .PD
  1334. Evaluate a Taylor series at \fIx\fR, given an expression representing
  1335. the \f(CW\*(C`ld(id)\*(C'\fR\-th derivative of a function at 0.
  1336. .Sp
  1337. When the series does not converge the result is undefined.
  1338. .Sp
  1339. \&\fIld(id)\fR is used to represent the derivative order in \fIexpr\fR,
  1340. which means that the given expression will be evaluated multiple times
  1341. with various input values that the expression can access through
  1342. \&\f(CW\*(C`ld(id)\*(C'\fR. If \fIid\fR is not specified then 0 is assumed.
  1343. .Sp
  1344. Note, when you have the derivatives at y instead of 0,
  1345. \&\f(CW\*(C`taylor(expr, x\-y)\*(C'\fR can be used.
  1346. .IP "\fB\fBtime\fB\|(0)\fR" 4
  1347. .IX Item "time"
  1348. Return the current (wallclock) time in seconds.
  1349. .IP "\fBtrunc(expr)\fR" 4
  1350. .IX Item "trunc(expr)"
  1351. Round the value of expression \fIexpr\fR towards zero to the nearest
  1352. integer. For example, \*(L"trunc(\-1.5)\*(R" is \*(L"\-1.0\*(R".
  1353. .IP "\fBwhile(cond, expr)\fR" 4
  1354. .IX Item "while(cond, expr)"
  1355. Evaluate expression \fIexpr\fR while the expression \fIcond\fR is
  1356. non-zero, and returns the value of the last \fIexpr\fR evaluation, or
  1357. \&\s-1NAN\s0 if \fIcond\fR was always false.
  1358. .PP
  1359. The following constants are available:
  1360. .IP "\fB\s-1PI\s0\fR" 4
  1361. .IX Item "PI"
  1362. area of the unit disc, approximately 3.14
  1363. .IP "\fBE\fR" 4
  1364. .IX Item "E"
  1365. \&\fBexp\fR\|(1) (Euler's number), approximately 2.718
  1366. .IP "\fB\s-1PHI\s0\fR" 4
  1367. .IX Item "PHI"
  1368. golden ratio (1+\fBsqrt\fR\|(5))/2, approximately 1.618
  1369. .PP
  1370. Assuming that an expression is considered \*(L"true\*(R" if it has a non-zero
  1371. value, note that:
  1372. .PP
  1373. \&\f(CW\*(C`*\*(C'\fR works like \s-1AND\s0
  1374. .PP
  1375. \&\f(CW\*(C`+\*(C'\fR works like \s-1OR\s0
  1376. .PP
  1377. For example the construct:
  1378. .PP
  1379. .Vb 1
  1380. \& if (A AND B) then C
  1381. .Ve
  1382. .PP
  1383. is equivalent to:
  1384. .PP
  1385. .Vb 1
  1386. \& if(A*B, C)
  1387. .Ve
  1388. .PP
  1389. In your C code, you can extend the list of unary and binary functions,
  1390. and define recognized constants, so that they are available for your
  1391. expressions.
  1392. .PP
  1393. The evaluator also recognizes the International System unit prefixes.
  1394. If 'i' is appended after the prefix, binary prefixes are used, which
  1395. are based on powers of 1024 instead of powers of 1000.
  1396. The 'B' postfix multiplies the value by 8, and can be appended after a
  1397. unit prefix or used alone. This allows using for example '\s-1KB\s0', 'MiB',
  1398. \&'G' and 'B' as number postfix.
  1399. .PP
  1400. The list of available International System prefixes follows, with
  1401. indication of the corresponding powers of 10 and of 2.
  1402. .IP "\fBy\fR" 4
  1403. .IX Item "y"
  1404. 10^\-24 / 2^\-80
  1405. .IP "\fBz\fR" 4
  1406. .IX Item "z"
  1407. 10^\-21 / 2^\-70
  1408. .IP "\fBa\fR" 4
  1409. .IX Item "a"
  1410. 10^\-18 / 2^\-60
  1411. .IP "\fBf\fR" 4
  1412. .IX Item "f"
  1413. 10^\-15 / 2^\-50
  1414. .IP "\fBp\fR" 4
  1415. .IX Item "p"
  1416. 10^\-12 / 2^\-40
  1417. .IP "\fBn\fR" 4
  1418. .IX Item "n"
  1419. 10^\-9 / 2^\-30
  1420. .IP "\fBu\fR" 4
  1421. .IX Item "u"
  1422. 10^\-6 / 2^\-20
  1423. .IP "\fBm\fR" 4
  1424. .IX Item "m"
  1425. 10^\-3 / 2^\-10
  1426. .IP "\fBc\fR" 4
  1427. .IX Item "c"
  1428. 10^\-2
  1429. .IP "\fBd\fR" 4
  1430. .IX Item "d"
  1431. 10^\-1
  1432. .IP "\fBh\fR" 4
  1433. .IX Item "h"
  1434. 10^2
  1435. .IP "\fBk\fR" 4
  1436. .IX Item "k"
  1437. 10^3 / 2^10
  1438. .IP "\fBK\fR" 4
  1439. .IX Item "K"
  1440. 10^3 / 2^10
  1441. .IP "\fBM\fR" 4
  1442. .IX Item "M"
  1443. 10^6 / 2^20
  1444. .IP "\fBG\fR" 4
  1445. .IX Item "G"
  1446. 10^9 / 2^30
  1447. .IP "\fBT\fR" 4
  1448. .IX Item "T"
  1449. 10^12 / 2^40
  1450. .IP "\fBP\fR" 4
  1451. .IX Item "P"
  1452. 10^15 / 2^40
  1453. .IP "\fBE\fR" 4
  1454. .IX Item "E"
  1455. 10^18 / 2^50
  1456. .IP "\fBZ\fR" 4
  1457. .IX Item "Z"
  1458. 10^21 / 2^60
  1459. .IP "\fBY\fR" 4
  1460. .IX Item "Y"
  1461. 10^24 / 2^70
  1462. .SH "SEE ALSO"
  1463. .IX Header "SEE ALSO"
  1464. \&\fBffmpeg\fR\|(1), \fBffplay\fR\|(1), \fBffprobe\fR\|(1), \fBlibavutil\fR\|(3)
  1465. .SH "AUTHORS"
  1466. .IX Header "AUTHORS"
  1467. The FFmpeg developers.
  1468. .PP
  1469. For details about the authorship, see the Git history of the project
  1470. (https://git.ffmpeg.org/ffmpeg), e.g. by typing the command
  1471. \&\fBgit log\fR in the FFmpeg source directory, or browsing the
  1472. online repository at <\fBhttps://git.ffmpeg.org/ffmpeg\fR>.
  1473. .PP
  1474. Maintainers for the specific components are listed in the file
  1475. \&\fI\s-1MAINTAINERS\s0\fR in the source code tree.