logo

oasis

Own branch of Oasis Linux (upstream: <https://git.sr.ht/~mcf/oasis/>) git clone https://anongit.hacktivis.me/git/oasis.git

mpv.1 (641728B)

    

  1. .\" Man page generated from reStructuredText.
  2. .
  3. .TH MPV 1 "" "" "multimedia"
  4. .SH NAME
  5. mpv \- a media player
  6. .
  7. .nr rst2man-indent-level 0
  8. .
  9. .de1 rstReportMargin
  10. \\$1 \\n[an-margin]
  11. level \\n[rst2man-indent-level]
  12. level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
  13. -
  14. \\n[rst2man-indent0]
  15. \\n[rst2man-indent1]
  16. \\n[rst2man-indent2]
  17. ..
  18. .de1 INDENT
  19. .\" .rstReportMargin pre:
  20. . RS \\$1
  21. . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
  22. . nr rst2man-indent-level +1
  23. .\" .rstReportMargin post:
  24. ..
  25. .de UNINDENT
  26. . RE
  27. .\" indent \\n[an-margin]
  28. .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
  29. .nr rst2man-indent-level -1
  30. .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
  31. .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
  32. ..
  33. .SH SYNOPSIS
  34. .nf
  35. \fBmpv\fP [options] [file|URL|PLAYLIST|\-]
  36. \fBmpv\fP [options] files
  37. .fi
  38. .sp
  39. .SH DESCRIPTION
  40. .sp
  41. \fBmpv\fP is a media player based on MPlayer and mplayer2. It supports a wide variety of video
  42. file formats, audio and video codecs, and subtitle types. Special input URL
  43. types are available to read input from a variety of sources other than disk
  44. files. Depending on platform, a variety of different video and audio output
  45. methods are supported.
  46. .sp
  47. Usage examples to get you started quickly can be found at the end of this man
  48. page.
  49. .SH INTERACTIVE CONTROL
  50. .sp
  51. mpv has a fully configurable, command\-driven control layer which allows you
  52. to control mpv using keyboard, mouse, or remote control (there is no
  53. LIRC support \- configure remotes as input devices instead).
  54. .sp
  55. See the \fB\-\-input\-\fP options for ways to customize it.
  56. .sp
  57. The following listings are not necessarily complete. See \fBetc/input.conf\fP for
  58. a list of default bindings. User \fBinput.conf\fP files and Lua scripts can
  59. define additional key bindings.
  60. .SS Keyboard Control
  61. .INDENT 0.0
  62. .TP
  63. .B LEFT and RIGHT
  64. Seek backward/forward 5 seconds. Shift+arrow does a 1 second exact seek
  65. (see \fB\-\-hr\-seek\fP).
  66. .TP
  67. .B UP and DOWN
  68. Seek forward/backward 1 minute. Shift+arrow does a 5 second exact seek (see
  69. \fB\-\-hr\-seek\fP).
  70. .TP
  71. .B Ctrl+LEFT and Ctrl+RIGHT
  72. Seek to the previous/next subtitle. Subject to some restrictions and
  73. might not always work; see \fBsub\-seek\fP command.
  74. .TP
  75. .B Ctrl+Shift+Left and Ctrl+Shift+Right
  76. Adjust subtitle delay so that the next or previous subtitle is displayed
  77. now. This is especially useful to sync subtitles to audio.
  78. .TP
  79. .B [ and ]
  80. Decrease/increase current playback speed by 10%.
  81. .TP
  82. .B { and }
  83. Halve/double current playback speed.
  84. .TP
  85. .B BACKSPACE
  86. Reset playback speed to normal.
  87. .TP
  88. .B Shift+BACKSPACE
  89. Undo the last seek. This works only if the playlist entry was not changed.
  90. Hitting it a second time will go back to the original position.
  91. See \fBrevert\-seek\fP command for details.
  92. .TP
  93. .B Shift+Ctrl+BACKSPACE
  94. Mark the current position. This will then be used by \fBShift+BACKSPACE\fP
  95. as revert position (once you seek back, the marker will be reset). You can
  96. use this to seek around in the file and then return to the exact position
  97. where you left off.
  98. .TP
  99. .B < and >
  100. Go backward/forward in the playlist.
  101. .TP
  102. .B ENTER
  103. Go forward in the playlist.
  104. .TP
  105. .B p / SPACE
  106. Pause (pressing again unpauses).
  107. .TP
  108. .B \&.
  109. Step forward. Pressing once will pause, every consecutive press will
  110. play one frame and then go into pause mode again.
  111. .UNINDENT
  112. .INDENT 0.0
  113. .TP
  114. .B ,
  115. Step backward. Pressing once will pause, every consecutive press will
  116. play one frame in reverse and then go into pause mode again.
  117. .TP
  118. .B q
  119. Stop playing and quit.
  120. .TP
  121. .B Q
  122. Like \fBq\fP, but store the current playback position. Playing the same file
  123. later will resume at the old playback position if possible.
  124. .TP
  125. .B / and *
  126. Decrease/increase volume.
  127. .TP
  128. .B 9 and 0
  129. Decrease/increase volume.
  130. .TP
  131. .B m
  132. Mute sound.
  133. .TP
  134. .B _
  135. Cycle through the available video tracks.
  136. .TP
  137. .B #
  138. Cycle through the available audio tracks.
  139. .TP
  140. .B f
  141. Toggle fullscreen (see also \fB\-\-fs\fP).
  142. .TP
  143. .B ESC
  144. Exit fullscreen mode.
  145. .TP
  146. .B T
  147. Toggle stay\-on\-top (see also \fB\-\-ontop\fP).
  148. .TP
  149. .B w and W
  150. Decrease/increase pan\-and\-scan range. The \fBe\fP key does the same as
  151. \fBW\fP currently, but use is discouraged.
  152. .TP
  153. .B o (also P)
  154. Show progression bar, elapsed time and total duration on the OSD.
  155. .TP
  156. .B O
  157. Toggle OSD states between normal and playback time/duration.
  158. .TP
  159. .B v
  160. Toggle subtitle visibility.
  161. .TP
  162. .B j and J
  163. Cycle through the available subtitles.
  164. .TP
  165. .B z and Z
  166. Adjust subtitle delay by +/\- 0.1 seconds. The \fBx\fP key does the same as
  167. \fBZ\fP currently, but use is discouraged.
  168. .TP
  169. .B l
  170. Set/clear A\-B loop points. See \fBab\-loop\fP command for details.
  171. .TP
  172. .B L
  173. Toggle infinite looping.
  174. .TP
  175. .B Ctrl + and Ctrl \-
  176. Adjust audio delay (A/V sync) by +/\- 0.1 seconds.
  177. .TP
  178. .B u
  179. Switch between applying no style overrides to SSA/ASS subtitles, and
  180. overriding them almost completely with the normal subtitle style. See
  181. \fB\-\-sub\-ass\-override\fP for more info.
  182. .TP
  183. .B V
  184. Toggle subtitle VSFilter aspect compatibility mode. See
  185. \fB\-\-sub\-ass\-vsfilter\-aspect\-compat\fP for more info.
  186. .TP
  187. .B r and R
  188. Move subtitles up/down. The \fBt\fP key does the same as \fBR\fP currently, but
  189. use is discouraged.
  190. .TP
  191. .B s
  192. Take a screenshot.
  193. .TP
  194. .B S
  195. Take a screenshot, without subtitles. (Whether this works depends on VO
  196. driver support.)
  197. .TP
  198. .B Ctrl s
  199. Take a screenshot, as the window shows it (with subtitles, OSD, and scaled
  200. video).
  201. .TP
  202. .B PGUP and PGDWN
  203. Seek to the beginning of the previous/next chapter. In most cases,
  204. "previous" will actually go to the beginning of the current chapter; see
  205. \fB\-\-chapter\-seek\-threshold\fP\&.
  206. .TP
  207. .B Shift+PGUP and Shift+PGDWN
  208. Seek backward or forward by 10 minutes. (This used to be mapped to
  209. PGUP/PGDWN without Shift.)
  210. .TP
  211. .B d
  212. Activate/deactivate deinterlacer.
  213. .TP
  214. .B A
  215. Cycle aspect ratio override.
  216. .TP
  217. .B Ctrl h
  218. Toggle hardware video decoding on/off.
  219. .TP
  220. .B Alt+LEFT, Alt+RIGHT, Alt+UP, Alt+DOWN
  221. Move the video rectangle (panning).
  222. .TP
  223. .B Alt + and Alt \-
  224. Combining \fBAlt\fP with the \fB+\fP or \fB\-\fP keys changes video zoom.
  225. .TP
  226. .B Alt+BACKSPACE
  227. Reset the pan/zoom settings.
  228. .TP
  229. .B F8
  230. Show the playlist and the current position in it (useful only if a UI window
  231. is used, broken on the terminal).
  232. .TP
  233. .B F9
  234. Show the list of audio and subtitle streams (useful only if a UI window  is
  235. used, broken on the terminal).
  236. .TP
  237. .B i and I
  238. Show/toggle an overlay displaying statistics about the currently playing
  239. file such as codec, framerate, number of dropped frames and so on. See
  240. \fI\%STATS\fP for more information.
  241. .TP
  242. .B del
  243. Cycles visibility between never / auto (mouse\-move) / always
  244. .TP
  245. .B \(ga
  246. Show the console. (ESC closes it again. See \fI\%CONSOLE\fP\&.)
  247. .UNINDENT
  248. .sp
  249. (The following keys are valid only when using a video output that supports the
  250. corresponding adjustment.)
  251. .INDENT 0.0
  252. .TP
  253. .B 1 and 2
  254. Adjust contrast.
  255. .TP
  256. .B 3 and 4
  257. Adjust brightness.
  258. .TP
  259. .B 5 and 6
  260. Adjust gamma.
  261. .TP
  262. .B 7 and 8
  263. Adjust saturation.
  264. .TP
  265. .B Alt+0 (and command+0 on OSX)
  266. Resize video window to half its original size.
  267. .TP
  268. .B Alt+1 (and command+1 on OSX)
  269. Resize video window to its original size.
  270. .TP
  271. .B Alt+2 (and command+2 on OSX)
  272. Resize video window to double its original size.
  273. .TP
  274. .B command + f (OSX only)
  275. Toggle fullscreen (see also \fB\-\-fs\fP).
  276. .UNINDENT
  277. .sp
  278. (The following keys are valid if you have a keyboard with multimedia keys.)
  279. .INDENT 0.0
  280. .TP
  281. .B PAUSE
  282. Pause.
  283. .TP
  284. .B STOP
  285. Stop playing and quit.
  286. .TP
  287. .B PREVIOUS and NEXT
  288. Seek backward/forward 1 minute.
  289. .UNINDENT
  290. .sp
  291. If you miss some older key bindings, look at \fBetc/restore\-old\-bindings.conf\fP
  292. in the mpv git repository.
  293. .SS Mouse Control
  294. .INDENT 0.0
  295. .TP
  296. .B Left double click
  297. Toggle fullscreen on/off.
  298. .TP
  299. .B Right click
  300. Toggle pause on/off.
  301. .TP
  302. .B Forward/Back button
  303. Skip to next/previous entry in playlist.
  304. .TP
  305. .B Wheel up/down
  306. Seek forward/backward 10 seconds.
  307. .TP
  308. .B Wheel left/right
  309. Decrease/increase volume.
  310. .UNINDENT
  311. .SH USAGE
  312. .sp
  313. Command line arguments starting with \fB\-\fP are interpreted as options,
  314. everything else as filenames or URLs. All options except \fIflag\fP options (or
  315. choice options which include \fByes\fP) require a parameter in the form
  316. \fB\-\-option=value\fP\&.
  317. .sp
  318. One exception is the lone \fB\-\fP (without anything else), which means media data
  319. will be read from stdin. Also, \fB\-\-\fP (without anything else) will make the
  320. player interpret all following arguments as filenames, even if they start with
  321. \fB\-\fP\&. (To play a file named \fB\-\fP, you need to use \fB\&./\-\fP\&.)
  322. .sp
  323. Every \fIflag\fP option has a \fIno\-flag\fP counterpart, e.g. the opposite of the
  324. \fB\-\-fs\fP option is \fB\-\-no\-fs\fP\&. \fB\-\-fs=yes\fP is same as \fB\-\-fs\fP, \fB\-\-fs=no\fP
  325. is the same as \fB\-\-no\-fs\fP\&.
  326. .sp
  327. If an option is marked as \fI(XXX only)\fP, it will only work in combination with
  328. the \fIXXX\fP option or if \fIXXX\fP is compiled in.
  329. .SS Legacy option syntax
  330. .sp
  331. The \fB\-\-option=value\fP syntax is not strictly enforced, and the alternative
  332. legacy syntax \fB\-option value\fP and \fB\-option=value\fP will also work. This is
  333. mostly  for compatibility with MPlayer. Using these should be avoided. Their
  334. semantics can change any time in the future.
  335. .sp
  336. For example, the alternative syntax will consider an argument following the
  337. option a filename. \fBmpv \-fs no\fP will attempt to play a file named \fBno\fP,
  338. because \fB\-\-fs\fP is a flag option that requires no parameter. If an option
  339. changes and its parameter becomes optional, then a command line using the
  340. alternative syntax will break.
  341. .sp
  342. Until mpv 0.31.0, there was no difference whether an option started with \fB\-\-\fP
  343. or a single \fB\-\fP\&. Newer mpv releases strictly expect that you pass the option
  344. value after a \fB=\fP\&. For example, before \fBmpv \-\-log\-file f.txt\fP would write
  345. a log to \fBf.txt\fP, but now this command line fails, as \fB\-\-log\-file\fP expects
  346. an option value, and \fBf.txt\fP is simply considered a normal file to be played
  347. (as in \fBmpv f.txt\fP).
  348. .sp
  349. The future plan is that \fB\-option value\fP will not work anymore, and options
  350. with a single \fB\-\fP behave the same as \fB\-\-\fP options.
  351. .SS Escaping spaces and other special characters
  352. .sp
  353. Keep in mind that the shell will partially parse and mangle the arguments you
  354. pass to mpv. For example, you might need to quote or escape options and
  355. filenames:
  356. .INDENT 0.0
  357. .INDENT 3.5
  358. \fBmpv "filename with spaces.mkv" \-\-title="window title"\fP
  359. .UNINDENT
  360. .UNINDENT
  361. .sp
  362. It gets more complicated if the suboption parser is involved. The suboption
  363. parser puts several options into a single string, and passes them to a
  364. component at once, instead of using multiple options on the level of the
  365. command line.
  366. .sp
  367. The suboption parser can quote strings with \fB"\fP and \fB[...]\fP\&.
  368. Additionally, there is a special form of quoting with \fB%n%\fP described below.
  369. .sp
  370. For example, assume the hypothetical \fBfoo\fP filter can take multiple options:
  371. .INDENT 0.0
  372. .INDENT 3.5
  373. \fBmpv test.mkv \-\-vf=foo:option1=value1:option2:option3=value3,bar\fP
  374. .UNINDENT
  375. .UNINDENT
  376. .sp
  377. This passes \fBoption1\fP and \fBoption3\fP to the \fBfoo\fP filter, with \fBoption2\fP
  378. as flag (implicitly \fBoption2=yes\fP), and adds a \fBbar\fP filter after that. If
  379. an option contains spaces or characters like \fB,\fP or \fB:\fP, you need to quote
  380. them:
  381. .INDENT 0.0
  382. .INDENT 3.5
  383. \fBmpv \(aq\-\-vf=foo:option1="option value with spaces",bar\(aq\fP
  384. .UNINDENT
  385. .UNINDENT
  386. .sp
  387. Shells may actually strip some quotes from the string passed to the commandline,
  388. so the example quotes the string twice, ensuring that mpv receives the \fB"\fP
  389. quotes.
  390. .sp
  391. The \fB[...]\fP form of quotes wraps everything between \fB[\fP and \fB]\fP\&. It\(aqs
  392. useful with shells that don\(aqt interpret these characters in the middle of
  393. an argument (like bash). These quotes are balanced (since mpv 0.9.0): the \fB[\fP
  394. and \fB]\fP nest, and the quote terminates on the last \fB]\fP that has no matching
  395. \fB[\fP within the string. (For example, \fB[a[b]c]\fP results in \fBa[b]c\fP\&.)
  396. .sp
  397. The fixed\-length quoting syntax is intended for use with external
  398. scripts and programs.
  399. .sp
  400. It is started with \fB%\fP and has the following format:
  401. .INDENT 0.0
  402. .INDENT 3.5
  403. .sp
  404. .nf
  405. .ft C
  406. %n%string_of_length_n
  407. .ft P
  408. .fi
  409. .UNINDENT
  410. .UNINDENT
  411. .INDENT 0.0
  412. .INDENT 3.5
  413. .IP "Examples"
  414. .sp
  415. \fBmpv \(aq\-\-vf=foo:option1=%11%quoted text\(aq test.avi\fP
  416. .sp
  417. Or in a script:
  418. .sp
  419. \fBmpv \-\-vf=foo:option1=%\(gaexpr length "$NAME"\(ga%"$NAME" test.avi\fP
  420. .UNINDENT
  421. .UNINDENT
  422. .sp
  423. Suboptions passed to the client API are also subject to escaping. Using
  424. \fBmpv_set_option_string()\fP is exactly like passing \fB\-\-name=data\fP to the
  425. command line (but without shell processing of the string). Some options
  426. support passing values in a more structured way instead of flat strings, and
  427. can avoid the suboption parsing mess. For example, \fB\-\-vf\fP supports
  428. \fBMPV_FORMAT_NODE\fP, which lets you pass suboptions as a nested data structure
  429. of maps and arrays.
  430. .SS Paths
  431. .sp
  432. Some care must be taken when passing arbitrary paths and filenames to mpv. For
  433. example, paths starting with \fB\-\fP will be interpreted as options. Likewise,
  434. if a path contains the sequence \fB://\fP, the string before that might be
  435. interpreted as protocol prefix, even though \fB://\fP can be part of a legal
  436. UNIX path. To avoid problems with arbitrary paths, you should be sure that
  437. absolute paths passed to mpv start with \fB/\fP, and prefix relative paths with
  438. \fB\&./\fP\&.
  439. .sp
  440. Using the \fBfile://\fP pseudo\-protocol is discouraged, because it involves
  441. strange URL unescaping rules.
  442. .sp
  443. The name \fB\-\fP itself is interpreted as stdin, and will cause mpv to disable
  444. console controls. (Which makes it suitable for playing data piped to stdin.)
  445. .sp
  446. The special argument \fB\-\-\fP can be used to stop mpv from interpreting the
  447. following arguments as options.
  448. .sp
  449. When using the client API, you should strictly avoid using \fBmpv_command_string\fP
  450. for invoking the \fBloadfile\fP command, and instead prefer e.g. \fBmpv_command\fP
  451. to avoid the need for filename escaping.
  452. .sp
  453. For paths passed to suboptions, the situation is further complicated by the
  454. need to escape special characters. To work this around, the path can be
  455. additionally wrapped in the fixed\-length syntax, e.g. \fB%n%string_of_length_n\fP
  456. (see above).
  457. .sp
  458. Some mpv options interpret paths starting with \fB~\fP\&. Currently, the prefix
  459. \fB~~/\fP expands to the mpv configuration directory (usually \fB~/.config/mpv/\fP).
  460. \fB~/\fP expands to the user\(aqs home directory. (The trailing \fB/\fP is always
  461. required.) There are the following paths as well:
  462. .TS
  463. center;
  464. |l|l|.
  465. _
  466. T{
  467. Name
  468. T}	T{
  469. Meaning
  470. T}
  471. _
  472. T{
  473. \fB~~home/\fP
  474. T}	T{
  475. same as \fB~~/\fP
  476. T}
  477. _
  478. T{
  479. \fB~~global/\fP
  480. T}	T{
  481. the global config path, if available (not on win32)
  482. T}
  483. _
  484. T{
  485. \fB~~osxbundle/\fP
  486. T}	T{
  487. the OSX bundle resource path (OSX only)
  488. T}
  489. _
  490. T{
  491. \fB~~desktop/\fP
  492. T}	T{
  493. the path to the desktop (win32, OSX)
  494. T}
  495. _
  496. .TE
  497. .SS Per\-File Options
  498. .sp
  499. When playing multiple files, any option given on the command line usually
  500. affects all files. Example:
  501. .INDENT 0.0
  502. .INDENT 3.5
  503. .sp
  504. .nf
  505. .ft C
  506. mpv \-\-a file1.mkv \-\-b file2.mkv \-\-c
  507. .ft P
  508. .fi
  509. .UNINDENT
  510. .UNINDENT
  511. .TS
  512. center;
  513. |l|l|.
  514. _
  515. T{
  516. File
  517. T}	T{
  518. Active options
  519. T}
  520. _
  521. T{
  522. file1.mkv
  523. T}	T{
  524. \fB\-\-a \-\-b \-\-c\fP
  525. T}
  526. _
  527. T{
  528. file2.mkv
  529. T}	T{
  530. \fB\-\-a \-\-b \-\-c\fP
  531. T}
  532. _
  533. .TE
  534. .sp
  535. (This is different from MPlayer and mplayer2.)
  536. .sp
  537. Also, if any option is changed at runtime (via input commands), they are not
  538. reset when a new file is played.
  539. .sp
  540. Sometimes, it is useful to change options per\-file. This can be achieved by
  541. adding the special per\-file markers \fB\-\-{\fP and \fB\-\-}\fP\&. (Note that you must
  542. escape these on some shells.) Example:
  543. .INDENT 0.0
  544. .INDENT 3.5
  545. .sp
  546. .nf
  547. .ft C
  548. mpv \-\-a file1.mkv \-\-b \-\-\e{ \-\-c file2.mkv \-\-d file3.mkv \-\-e \-\-\e} file4.mkv \-\-f
  549. .ft P
  550. .fi
  551. .UNINDENT
  552. .UNINDENT
  553. .TS
  554. center;
  555. |l|l|.
  556. _
  557. T{
  558. File
  559. T}	T{
  560. Active options
  561. T}
  562. _
  563. T{
  564. file1.mkv
  565. T}	T{
  566. \fB\-\-a \-\-b \-\-f\fP
  567. T}
  568. _
  569. T{
  570. file2.mkv
  571. T}	T{
  572. \fB\-\-a \-\-b \-\-f \-\-c \-\-d \-\-e\fP
  573. T}
  574. _
  575. T{
  576. file3.mkv
  577. T}	T{
  578. \fB\-\-a \-\-b \-\-f \-\-c \-\-d \-\-e\fP
  579. T}
  580. _
  581. T{
  582. file4.mkv
  583. T}	T{
  584. \fB\-\-a \-\-b \-\-f\fP
  585. T}
  586. _
  587. .TE
  588. .sp
  589. Additionally, any file\-local option changed at runtime is reset when the current
  590. file stops playing. If option \fB\-\-c\fP is changed during playback of
  591. \fBfile2.mkv\fP, it is reset when advancing to \fBfile3.mkv\fP\&. This only affects
  592. file\-local options. The option \fB\-\-a\fP is never reset here.
  593. .SS List Options
  594. .sp
  595. Some options which store lists of option values can have action suffixes. For
  596. example, the \fB\-\-display\-tags\fP option takes a \fB,\fP\-separated list of tags, but
  597. the option also allows you to append a single tag with \fB\-\-display\-tags\-append\fP,
  598. and the tag name can for example contain a literal \fB,\fP without the need for
  599. escaping.
  600. .SS String list and path list options
  601. .sp
  602. String lists are separated by \fB,\fP\&. The strings are not parsed or interpreted
  603. by the option system itself. However, most
  604. .sp
  605. Path or file list options use \fB:\fP (Unix) or \fB;\fP (Windows) as separator,
  606. instead of \fB,\fP\&.
  607. .sp
  608. They support the following operations:
  609. .TS
  610. center;
  611. |l|l|.
  612. _
  613. T{
  614. Suffix
  615. T}	T{
  616. Meaning
  617. T}
  618. _
  619. T{
  620. \-set
  621. T}	T{
  622. Set a list of items (using the list separator, interprets escapes)
  623. T}
  624. _
  625. T{
  626. \-append
  627. T}	T{
  628. Append single item (does not interpret escapes)
  629. T}
  630. _
  631. T{
  632. \-add
  633. T}	T{
  634. Append 1 or more items (same syntax as \-set)
  635. T}
  636. _
  637. T{
  638. \-pre
  639. T}	T{
  640. Prepend 1 or more items (same syntax as \-set)
  641. T}
  642. _
  643. T{
  644. \-clr
  645. T}	T{
  646. Clear the option (remove all items)
  647. T}
  648. _
  649. T{
  650. \-remove
  651. T}	T{
  652. Delete item if present (does not interpret escapes)
  653. T}
  654. _
  655. T{
  656. \-del
  657. T}	T{
  658. Delete 1 or more items by integer index (deprecated)
  659. T}
  660. _
  661. T{
  662. \-toggle
  663. T}	T{
  664. Append an item, or remove if if it already exists (no escapes)
  665. T}
  666. _
  667. .TE
  668. .sp
  669. \fB\-append\fP is meant as a simple way to append a single item without having
  670. to escape the argument (you may still need to escape on the shell level).
  671. .SS Key/value list options
  672. .sp
  673. A key/value list is a list of key/value string pairs. In programming languages,
  674. this type of data structure is often called a map or a dictionary. The order
  675. normally does not matter, although in some cases the order might matter.
  676. .sp
  677. They support the following operations:
  678. .TS
  679. center;
  680. |l|l|.
  681. _
  682. T{
  683. Suffix
  684. T}	T{
  685. Meaning
  686. T}
  687. _
  688. T{
  689. \-set
  690. T}	T{
  691. Set a list of items (using \fB,\fP as separator)
  692. T}
  693. _
  694. T{
  695. \-append
  696. T}	T{
  697. Append a single item (escapes for the key, no escapes for the value)
  698. T}
  699. _
  700. T{
  701. \-add
  702. T}	T{
  703. Append 1 or more items (same syntax as \-set)
  704. T}
  705. _
  706. T{
  707. \-remove
  708. T}	T{
  709. Delete item by key if present (does not interpret escapes)
  710. T}
  711. _
  712. .TE
  713. .sp
  714. Keys are unique within the list. If an already present key is set, the existing
  715. key is removed before the new value is appended.
  716. .SS Filter options
  717. .sp
  718. This is a very complex option type for the \fB\-\-af\fP and \fB\-\-vf\fP options only.
  719. They often require complicated escaping. See \fI\%VIDEO FILTERS\fP for details. They
  720. support the following operations:
  721. .TS
  722. center;
  723. |l|l|.
  724. _
  725. T{
  726. Suffix
  727. T}	T{
  728. Meaning
  729. T}
  730. _
  731. T{
  732. \-set
  733. T}	T{
  734. Set a list of filters (using \fB,\fP as separator)
  735. T}
  736. _
  737. T{
  738. \-append
  739. T}	T{
  740. Append single filter
  741. T}
  742. _
  743. T{
  744. \-add
  745. T}	T{
  746. Append 1 or more filters (same syntax as \-set)
  747. T}
  748. _
  749. T{
  750. \-pre
  751. T}	T{
  752. Prepend 1 or more filters (same syntax as \-set)
  753. T}
  754. _
  755. T{
  756. \-clr
  757. T}	T{
  758. Clear the option (remove all filters)
  759. T}
  760. _
  761. T{
  762. \-remove
  763. T}	T{
  764. Delete filter if present
  765. T}
  766. _
  767. T{
  768. \-del
  769. T}	T{
  770. Delete 1 or more filters by integer index or filter label (deprecated)
  771. T}
  772. _
  773. T{
  774. \-toggle
  775. T}	T{
  776. Append a filter, or remove if if it already exists
  777. T}
  778. _
  779. T{
  780. \-help
  781. T}	T{
  782. Pseudo operation that prints a help text to the terminal
  783. T}
  784. _
  785. .TE
  786. .SS General
  787. .sp
  788. Without suffix, the operation used is normally \fB\-set\fP\&.
  789. .sp
  790. Although some operations allow specifying multiple items, using this is strongly
  791. discouraged and deprecated, except for \fB\-set\fP\&. There is a chance that
  792. operations like \fB\-add\fP and \fB\-pre\fP will work like \fB\-append\fP and accept a
  793. single, unescaped item only (so the \fB,\fP separator will not be interpreted and
  794. is passed on as part of the value).
  795. .sp
  796. Some options (like \fB\-\-sub\-file\fP, \fB\-\-audio\-file\fP, \fB\-\-glsl\-shader\fP) are
  797. aliases for the proper option with \fB\-append\fP action. For example,
  798. \fB\-\-sub\-file\fP is an alias for \fB\-\-sub\-files\-append\fP\&.
  799. .sp
  800. Options of this type can be changed at runtime using the \fBchange\-list\fP
  801. command, which takes the suffix (without the \fB\-\fP) as separate operation
  802. parameter.
  803. .SH CONFIGURATION FILES
  804. .SS Location and Syntax
  805. .sp
  806. You can put all of the options in configuration files which will be read every
  807. time mpv is run. The system\-wide configuration file \(aqmpv.conf\(aq is in your
  808. configuration directory (e.g. \fB/etc/mpv\fP or \fB/usr/local/etc/mpv\fP), the
  809. user\-specific one is \fB~/.config/mpv/mpv.conf\fP\&. For details and platform
  810. specifics (in particular Windows paths) see the \fI\%FILES\fP section.
  811. .sp
  812. User\-specific options override system\-wide options and options given on the
  813. command line override either. The syntax of the configuration files is
  814. \fBoption=value\fP\&. Everything after a \fI#\fP is considered a comment. Options
  815. that work without values can be enabled by setting them to \fIyes\fP and disabled by
  816. setting them to \fIno\fP\&. Even suboptions can be specified in this way.
  817. .INDENT 0.0
  818. .INDENT 3.5
  819. .IP "Example configuration file"
  820. .INDENT 0.0
  821. .INDENT 3.5
  822. .sp
  823. .nf
  824. .ft C
  825. # Use GPU\-accelerated video output by default.
  826. vo=gpu
  827. # Use quotes for text that can contain spaces:
  828. status\-msg="Time: ${time\-pos}"
  829. .ft P
  830. .fi
  831. .UNINDENT
  832. .UNINDENT
  833. .UNINDENT
  834. .UNINDENT
  835. .SS Escaping spaces and special characters
  836. .sp
  837. This is done like with command line options. The shell is not involved here,
  838. but option values still need to be quoted as a whole if it contains certain
  839. characters like spaces. A config entry can be quoted with \fB"\fP,
  840. as well as with the fixed\-length syntax (\fB%n%\fP) mentioned before. This is like
  841. passing the exact contents of the quoted string as command line option. C\-style
  842. escapes are currently _not_ interpreted on this level, although some options do
  843. this manually. (This is a mess and should probably be changed at some point.)
  844. .SS Putting Command Line Options into the Configuration File
  845. .sp
  846. Almost all command line options can be put into the configuration file. Here
  847. is a small guide:
  848. .TS
  849. center;
  850. |l|l|.
  851. _
  852. T{
  853. Option
  854. T}	T{
  855. Configuration file entry
  856. T}
  857. _
  858. T{
  859. \fB\-\-flag\fP
  860. T}	T{
  861. \fBflag\fP
  862. T}
  863. _
  864. T{
  865. \fB\-opt val\fP
  866. T}	T{
  867. \fBopt=val\fP
  868. T}
  869. _
  870. T{
  871. \fB\-\-opt=val\fP
  872. T}	T{
  873. \fBopt=val\fP
  874. T}
  875. _
  876. T{
  877. \fB\-opt "has spaces"\fP
  878. T}	T{
  879. \fBopt="has spaces"\fP
  880. T}
  881. _
  882. .TE
  883. .SS File\-specific Configuration Files
  884. .sp
  885. You can also write file\-specific configuration files. If you wish to have a
  886. configuration file for a file called \(aqvideo.avi\(aq, create a file named
  887. \(aqvideo.avi.conf\(aq with the file\-specific options in it and put it in
  888. \fB~/.config/mpv/\fP\&. You can also put the configuration file in the same directory
  889. as the file to be played. Both require you to set the \fB\-\-use\-filedir\-conf\fP
  890. option (either on the command line or in your global config file). If a
  891. file\-specific configuration file is found in the same directory, no
  892. file\-specific configuration is loaded from \fB~/.config/mpv\fP\&. In addition, the
  893. \fB\-\-use\-filedir\-conf\fP option enables directory\-specific configuration files.
  894. For this, mpv first tries to load a mpv.conf from the same directory
  895. as the file played and then tries to load any file\-specific configuration.
  896. .SS Profiles
  897. .sp
  898. To ease working with different configurations, profiles can be defined in the
  899. configuration files. A profile starts with its name in square brackets,
  900. e.g. \fB[my\-profile]\fP\&. All following options will be part of the profile. A
  901. description (shown by \fB\-\-profile=help\fP) can be defined with the
  902. \fBprofile\-desc\fP option. To end the profile, start another one or use the
  903. profile name \fBdefault\fP to continue with normal options.
  904. .sp
  905. You can list profiles with \fB\-\-profile=help\fP, and show the contents of a
  906. profile with \fB\-\-show\-profile=<name>\fP (replace \fB<name>\fP with the profile
  907. name). You can apply profiles on start with the \fB\-\-profile=<name>\fP option,
  908. or at runtime with the \fBapply\-profile <name>\fP command.
  909. .INDENT 0.0
  910. .INDENT 3.5
  911. .IP "Example mpv config file with profiles"
  912. .INDENT 0.0
  913. .INDENT 3.5
  914. .sp
  915. .nf
  916. .ft C
  917. # normal top\-level option
  918. fullscreen=yes
  920. # a profile that can be enabled with \-\-profile=big\-cache
  921. [big\-cache]
  922. cache=yes
  923. demuxer\-max\-bytes=123400KiB
  924. demuxer\-readahead\-secs=20
  926. [slow]
  927. profile\-desc="some profile name"
  928. # reference a builtin profile
  929. profile=gpu\-hq
  931. [fast]
  932. vo=vdpau
  934. # using a profile again extends it
  935. [slow]
  936. framedrop=no
  937. # you can also include other profiles
  938. profile=big\-cache
  939. .ft P
  940. .fi
  941. .UNINDENT
  942. .UNINDENT
  943. .UNINDENT
  944. .UNINDENT
  945. .SS Auto profiles
  946. .sp
  947. Some profiles are loaded automatically. The following example demonstrates this:
  948. .INDENT 0.0
  949. .INDENT 3.5
  950. .IP "Auto profile loading"
  951. .INDENT 0.0
  952. .INDENT 3.5
  953. .sp
  954. .nf
  955. .ft C
  956. [extension.mkv]
  957. profile\-desc="profile for .mkv files"
  958. vf=flip
  959. .ft P
  960. .fi
  961. .UNINDENT
  962. .UNINDENT
  963. .UNINDENT
  964. .UNINDENT
  965. .sp
  966. The profile name follows the schema \fBtype.name\fP, where type can be
  967. \fBprotocol\fP for the input/output protocol in use (see \fB\-\-list\-protocols\fP),
  968. and \fBextension\fP for the extension of the path of the currently played file
  969. (\fInot\fP the file format).
  970. .sp
  971. This feature is very limited, and there are no other auto profiles.
  972. .SH USING MPV FROM OTHER PROGRAMS OR SCRIPTS
  973. .sp
  974. There are three choices for using mpv from other programs or scripts:
  975. .INDENT 0.0
  976. .INDENT 3.5
  977. .INDENT 0.0
  978. .IP 1. 3
  979. Calling it as UNIX process. If you do this, \fIdo not parse terminal output\fP\&.
  980. The terminal output is intended for humans, and may change any time. In
  981. addition, terminal behavior itself may change any time. Compatibility
  982. cannot be guaranteed.
  983. .sp
  984. Your code should work even if you pass \fB\-\-no\-terminal\fP\&. Do not attempt
  985. to simulate user input by sending terminal control codes to mpv\(aqs stdin.
  986. If you need interactive control, using \fB\-\-input\-ipc\-server\fP is
  987. recommended. This gives you access to the \fI\%JSON IPC\fP  over unix domain
  988. sockets (or named pipes on Windows).
  989. .sp
  990. Depending on what you do, passing \fB\-\-no\-config\fP or \fB\-\-config\-dir\fP may
  991. be a good idea to avoid conflicts with the normal mpv user configuration
  992. intended for CLI playback.
  993. .sp
  994. Using \fB\-\-input\-ipc\-server\fP is also suitable for purposes like remote
  995. control (however, the IPC protocol itself is not "secure" and not
  996. intended to be so).
  997. .IP 2. 3
  998. Using libmpv. This is generally recommended when mpv is used as playback
  999. backend for a completely different application. The provided C API is
  1000. very close to CLI mechanisms and the scripting API.
  1001. .sp
  1002. Note that even though libmpv has different defaults, it can be configured
  1003. to work exactly like the CLI player (except command line parsing is
  1004. unavailable).
  1005. .sp
  1006. See \fI\%EMBEDDING INTO OTHER PROGRAMS (LIBMPV)\fP\&.
  1007. .IP 3. 3
  1008. As a user script (\fI\%LUA SCRIPTING\fP, \fI\%JAVASCRIPT\fP, \fI\%C PLUGINS\fP). This is
  1009. recommended when the goal is to "enhance" the CLI player. Scripts get
  1010. access to the entire client API of mpv.
  1011. .sp
  1012. This is the standard way to create third\-party extensions for the player.
  1013. .UNINDENT
  1014. .UNINDENT
  1015. .UNINDENT
  1016. .sp
  1017. All these access the client API, which is the sum of the various mechanisms
  1018. provided by the player core, as documented here: \fI\%OPTIONS\fP,
  1019. \fI\%List of Input Commands\fP, \fI\%Properties\fP, \fI\%List of events\fP (also see C API),
  1020. \fI\%Hooks\fP\&.
  1021. .SH TAKING SCREENSHOTS
  1022. .sp
  1023. Screenshots of the currently played file can be taken using the \(aqscreenshot\(aq
  1024. input mode command, which is by default bound to the \fBs\fP key. Files named
  1025. \fBmpv\-shotNNNN.jpg\fP will be saved in the working directory, using the first
  1026. available number \- no files will be overwritten. In pseudo\-GUI mode, the
  1027. screenshot will be saved somewhere else. See \fI\%PSEUDO GUI MODE\fP\&.
  1028. .sp
  1029. A screenshot will usually contain the unscaled video contents at the end of the
  1030. video filter chain and subtitles. By default, \fBS\fP takes screenshots without
  1031. subtitles, while \fBs\fP includes subtitles.
  1032. .sp
  1033. Unlike with MPlayer, the \fBscreenshot\fP video filter is not required. This
  1034. filter was never required in mpv, and has been removed.
  1035. .SH TERMINAL STATUS LINE
  1036. .sp
  1037. During playback, mpv shows the playback status on the terminal. It looks like
  1038. something like this:
  1039. .INDENT 0.0
  1040. .INDENT 3.5
  1041. \fBAV: 00:03:12 / 00:24:25 (13%) A\-V: \-0.000\fP
  1042. .UNINDENT
  1043. .UNINDENT
  1044. .sp
  1045. The status line can be overridden with the \fB\-\-term\-status\-msg\fP option.
  1046. .sp
  1047. The following is a list of things that can show up in the status line. Input
  1048. properties, that can be used to get the same information manually, are also
  1049. listed.
  1050. .INDENT 0.0
  1051. .IP \(bu 2
  1052. \fBAV:\fP or \fBV:\fP (video only) or \fBA:\fP (audio only)
  1053. .IP \(bu 2
  1054. The current time position in \fBHH:MM:SS\fP format (\fBplayback\-time\fP property)
  1055. .IP \(bu 2
  1056. The total file duration (absent if unknown) (\fBlength\fP property)
  1057. .IP \(bu 2
  1058. Playback speed, e.g. \(ga\(ga x2.0\(ga\(ga. Only visible if the speed is not normal. This
  1059. is the user\-requested speed, and not the actual speed  (usually they should
  1060. be the same, unless playback is too slow). (\fBspeed\fP property.)
  1061. .IP \(bu 2
  1062. Playback percentage, e.g. \fB(13%)\fP\&. How much of the file has been played.
  1063. Normally calculated out of playback position and duration, but can fallback
  1064. to other methods (like byte position) if these are not available.
  1065. (\fBpercent\-pos\fP property.)
  1066. .IP \(bu 2
  1067. The audio/video sync as \fBA\-V:  0.000\fP\&. This is the difference between
  1068. audio and video time. Normally it should be 0 or close to 0. If it\(aqs growing,
  1069. it might indicate a playback problem. (\fBavsync\fP property.)
  1070. .IP \(bu 2
  1071. Total A/V sync change, e.g. \fBct: \-0.417\fP\&. Normally invisible. Can show up
  1072. if there is audio "missing", or not enough frames can be dropped. Usually
  1073. this will indicate a problem. (\fBtotal\-avsync\-change\fP property.)
  1074. .IP \(bu 2
  1075. Encoding state in \fB{...}\fP, only shown in encoding mode.
  1076. .IP \(bu 2
  1077. Display sync state. If display sync is active (\fBdisplay\-sync\-active\fP
  1078. property), this shows \fBDS: 2.500/13\fP, where the first number is average
  1079. number of vsyncs per video frame (e.g. 2.5 when playing 24Hz videos on 60Hz
  1080. screens), which might jitter if the ratio doesn\(aqt round off, or there are
  1081. mistimed frames (\fBvsync\-ratio\fP), and the second number of estimated number
  1082. of vsyncs which took too long (\fBvo\-delayed\-frame\-count\fP property). The
  1083. latter is a heuristic, as it\(aqs generally not possible to determine this with
  1084. certainty.
  1085. .IP \(bu 2
  1086. Dropped frames, e.g. \fBDropped: 4\fP\&. Shows up only if the count is not 0. Can
  1087. grow if the video framerate is higher than that of the display, or if video
  1088. rendering is too slow. May also be incremented on "hiccups" and when the video
  1089. frame couldn\(aqt be displayed on time. (\fBvo\-drop\-frame\-count\fP property.)
  1090. If the decoder drops frames, the number of decoder\-dropped frames is appended
  1091. to the display as well, e.g.: \fBDropped: 4/34\fP\&. This happens only if
  1092. decoder frame dropping is enabled with the \fB\-\-framedrop\fP options.
  1093. (\fBdrop\-frame\-count\fP property.)
  1094. .IP \(bu 2
  1095. Cache state, e.g. \fBCache:  2s/134KB\fP\&. Visible if the stream cache is enabled.
  1096. The first value shows the amount of video buffered in the demuxer in seconds,
  1097. the second value shows the estimated size of the buffered amount in kilobytes.
  1098. (\fBdemuxer\-cache\-duration\fP and \fBdemuxer\-cache\-state\fP properties.)
  1099. .UNINDENT
  1100. .SH LOW LATENCY PLAYBACK
  1101. .sp
  1102. mpv is optimized for normal video playback, meaning it actually tries to buffer
  1103. as much data as it seems to make sense. This will increase latency. Reducing
  1104. latency is possible only by specifically disabling features which increase
  1105. latency.
  1106. .sp
  1107. The builtin \fBlow\-latency\fP profile tries to apply some of the options which can
  1108. reduce latency. You can use  \fB\-\-profile=low\-latency\fP to apply all of them. You
  1109. can list the contents with \fB\-\-show\-profile=low\-latency\fP (some of the options
  1110. are quite obscure, and may change every mpv release).
  1111. .sp
  1112. Be aware that some of the options can reduce playback quality.
  1113. .sp
  1114. Most latency is actually caused by inconvenient timing behavior. You can disable
  1115. this with \fB\-\-untimed\fP, but it will likely break, unless the stream has no
  1116. audio, and the input feeds data to the player at a constant rate.
  1117. .sp
  1118. Another common problem is with MJPEG streams. These do not signal the correct
  1119. framerate. Using \fB\-\-untimed\fP or \fB\-\-no\-correct\-pts \-\-fps=60\fP might help.
  1120. .sp
  1121. For livestreams, data can build up due to pausing the stream, due to slightly
  1122. lower playback rate, or "buffering" pauses. If the demuxer cache is enabled,
  1123. these can be skipped manually. The experimental \fBdrop\-buffers\fP command can
  1124. be used to discard any buffered data, though it\(aqs very disruptive.
  1125. .sp
  1126. In some cases, manually tuning TCP buffer sizes and such can help to reduce
  1127. latency.
  1128. .sp
  1129. Additional options that can be tried:
  1130. .INDENT 0.0
  1131. .IP \(bu 2
  1132. \fB\-\-opengl\-glfinish=yes\fP, can reduce buffering in the graphics driver
  1133. .IP \(bu 2
  1134. \fB\-\-opengl\-swapinterval=0\fP, same
  1135. .IP \(bu 2
  1136. \fB\-\-vo=xv\fP, same
  1137. .IP \(bu 2
  1138. without audio \fB\-\-framedrop=no \-\-speed=1.01\fP may help for live sources
  1139. (results can be mixed)
  1140. .UNINDENT
  1141. .SH PROTOCOLS
  1142. .sp
  1143. \fBhttp://...\fP, \fBhttps://\fP, ...
  1144. .INDENT 0.0
  1145. .INDENT 3.5
  1146. Many network protocols are supported, but the protocol prefix must always
  1147. be specified. mpv will never attempt to guess whether a filename is
  1148. actually a network address. A protocol prefix is always required.
  1149. .sp
  1150. Note that not all prefixes are documented here. Undocumented prefixes are
  1151. either aliases to documented protocols, or are just redirections to
  1152. protocols implemented and documented in FFmpeg.
  1153. .sp
  1154. \fBdata:\fP is supported in FFmpeg (not in Libav), but needs to be in the
  1155. format \fBdata://\fP\&. This is done to avoid ambiguity with filenames. You
  1156. can also prefix it with \fBlavf://\fP or \fBffmpeg://\fP\&.
  1157. .UNINDENT
  1158. .UNINDENT
  1159. .sp
  1160. \fBytdl://...\fP
  1161. .INDENT 0.0
  1162. .INDENT 3.5
  1163. By default, the youtube\-dl hook script only looks at http(s) URLs. Prefixing
  1164. an URL with \fBytdl://\fP forces it to be always processed by the script. This
  1165. can also be used to invoke special youtube\-dl functionality like playing a
  1166. video by ID or invoking search.
  1167. .sp
  1168. Keep in mind that you can\(aqt pass youtube\-dl command line options by this,
  1169. and you have to use \fB\-\-ytdl\-raw\-options\fP instead.
  1170. .UNINDENT
  1171. .UNINDENT
  1172. .sp
  1173. \fB\-\fP
  1174. .INDENT 0.0
  1175. .INDENT 3.5
  1176. Play data from stdin.
  1177. .UNINDENT
  1178. .UNINDENT
  1179. .sp
  1180. \fBsmb://PATH\fP
  1181. .INDENT 0.0
  1182. .INDENT 3.5
  1183. Play a path from  Samba share.
  1184. .UNINDENT
  1185. .UNINDENT
  1186. .sp
  1187. \fBbd://[title][/device]\fP \fB\-\-bluray\-device=PATH\fP
  1188. .INDENT 0.0
  1189. .INDENT 3.5
  1190. Play a Blu\-ray disc. Since libbluray 1.0.1, you can read from ISO files
  1191. by passing them to \fB\-\-bluray\-device\fP\&.
  1192. .sp
  1193. \fBtitle\fP can be: \fBlongest\fP or \fBfirst\fP (selects the default
  1194. playlist); \fBmpls/<number>\fP (selects <number>.mpls playlist);
  1195. \fB<number>\fP (select playlist with the same index). mpv will list
  1196. the available playlists on loading.
  1197. .sp
  1198. \fBbluray://\fP is an alias.
  1199. .UNINDENT
  1200. .UNINDENT
  1201. .sp
  1202. \fBdvd://[title][/device]\fP \fB\-\-dvd\-device=PATH\fP
  1203. .INDENT 0.0
  1204. .INDENT 3.5
  1205. Play a DVD. DVD menus are not supported. If no title is given, the longest
  1206. title is auto\-selected. Without \fB\-\-dvd\-device\fP, it will probably try
  1207. to open an actual optical drive, if available and implemented for the OS.
  1208. .sp
  1209. \fBdvdnav://\fP is an old alias for \fBdvd://\fP and does exactly the same
  1210. thing.
  1211. .UNINDENT
  1212. .UNINDENT
  1213. .sp
  1214. \fBdvb://[cardnumber@]channel\fP \fB\-\-dvbin\-...\fP
  1215. .INDENT 0.0
  1216. .INDENT 3.5
  1217. Digital TV via DVB. (Linux only.)
  1218. .UNINDENT
  1219. .UNINDENT
  1220. .sp
  1221. \fBmf://[filemask|@listfile]\fP \fB\-\-mf\-...\fP
  1222. .INDENT 0.0
  1223. .INDENT 3.5
  1224. Play a series of images as video.
  1225. .UNINDENT
  1226. .UNINDENT
  1227. .sp
  1228. \fBcdda://[device]\fP \fB\-\-cdrom\-device=PATH\fP \fB\-\-cdda\-...\fP
  1229. .INDENT 0.0
  1230. .INDENT 3.5
  1231. Play CD.
  1232. .UNINDENT
  1233. .UNINDENT
  1234. .sp
  1235. \fBlavf://...\fP
  1236. .INDENT 0.0
  1237. .INDENT 3.5
  1238. Access any FFmpeg/Libav libavformat protocol. Basically, this passed the
  1239. string after the \fB//\fP directly to libavformat.
  1240. .UNINDENT
  1241. .UNINDENT
  1242. .sp
  1243. \fBav://type:options\fP
  1244. .INDENT 0.0
  1245. .INDENT 3.5
  1246. This is intended for using libavdevice inputs. \fBtype\fP is the libavdevice
  1247. demuxer name, and \fBoptions\fP is the (pseudo\-)filename passed to the
  1248. demuxer.
  1249. .INDENT 0.0
  1250. .INDENT 3.5
  1251. .IP "Example"
  1252. .INDENT 0.0
  1253. .INDENT 3.5
  1254. .sp
  1255. .nf
  1256. .ft C
  1257. mpv av://v4l2:/dev/video0 \-\-profile=low\-latency \-\-untimed
  1258. .ft P
  1259. .fi
  1260. .UNINDENT
  1261. .UNINDENT
  1262. .sp
  1263. This plays video from the first v4l input with nearly the lowest latency
  1264. possible. It\(aqs a good replacement for the removed \fBtv://\fP input.
  1265. Using \fB\-\-untimed\fP is a hack to output a captured frame immediately,
  1266. instead of respecting the input framerate. (There may be better ways to
  1267. handle this in the future.)
  1268. .UNINDENT
  1269. .UNINDENT
  1270. .sp
  1271. \fBavdevice://\fP is an alias.
  1272. .UNINDENT
  1273. .UNINDENT
  1274. .sp
  1275. \fBfile://PATH\fP
  1276. .INDENT 0.0
  1277. .INDENT 3.5
  1278. A local path as URL. Might be useful in some special use\-cases. Note that
  1279. \fBPATH\fP itself should start with a third \fB/\fP to make the path an
  1280. absolute path.
  1281. .UNINDENT
  1282. .UNINDENT
  1283. .sp
  1284. \fBappending://PATH\fP
  1285. .INDENT 0.0
  1286. .INDENT 3.5
  1287. Play a local file, but assume it\(aqs being appended to. This is useful for
  1288. example for files that are currently being downloaded to disk. This will
  1289. block playback, and stop playback only if no new data was appended after
  1290. a timeout of about 2 seconds.
  1291. .sp
  1292. Using this is still a bit of a bad idea, because there is no way to detect
  1293. if a file is actually being appended, or if it\(aqs still written. If you\(aqre
  1294. trying to play the  output of some program, consider using a pipe
  1295. (\fBsomething | mpv \-\fP). If it really has to be a file on disk, use tail to
  1296. make it wait forever, e.g. \fBtail \-f \-c +0 file.mkv | mpv \-\fP\&.
  1297. .UNINDENT
  1298. .UNINDENT
  1299. .sp
  1300. \fBfd://123\fP
  1301. .INDENT 0.0
  1302. .INDENT 3.5
  1303. Read data from the given file descriptor (for example 123). This is similar
  1304. to piping data to stdin via \fB\-\fP, but can use an arbitrary file descriptor.
  1305. mpv may modify some file descriptor properties when the stream layer "opens"
  1306. it.
  1307. .UNINDENT
  1308. .UNINDENT
  1309. .sp
  1310. \fBfdclose://123\fP
  1311. .INDENT 0.0
  1312. .INDENT 3.5
  1313. Like \fBfd://\fP, but the file descriptor is closed after use. When using this
  1314. you need to ensure that the same fd URL will only be used once.
  1315. .UNINDENT
  1316. .UNINDENT
  1317. .sp
  1318. \fBedl://[edl specification as in edl\-mpv.rst]\fP
  1319. .INDENT 0.0
  1320. .INDENT 3.5
  1321. Stitch together parts of multiple files and play them.
  1322. .UNINDENT
  1323. .UNINDENT
  1324. .sp
  1325. \fBnull://\fP
  1326. .INDENT 0.0
  1327. .INDENT 3.5
  1328. Simulate an empty file. If opened for writing, it will discard all data.
  1329. The \fBnull\fP demuxer will specifically pass autoprobing if this protocol
  1330. is used (while it\(aqs not automatically invoked for empty files).
  1331. .UNINDENT
  1332. .UNINDENT
  1333. .sp
  1334. \fBmemory://data\fP
  1335. .INDENT 0.0
  1336. .INDENT 3.5
  1337. Use the \fBdata\fP part as source data.
  1338. .UNINDENT
  1339. .UNINDENT
  1340. .sp
  1341. \fBhex://data\fP
  1342. .INDENT 0.0
  1343. .INDENT 3.5
  1344. Like \fBmemory://\fP, but the string is interpreted as hexdump.
  1345. .UNINDENT
  1346. .UNINDENT
  1347. .SH PSEUDO GUI MODE
  1348. .sp
  1349. mpv has no official GUI, other than the OSC (\fI\%ON SCREEN CONTROLLER\fP), which
  1350. is not a full GUI and is not meant to be. However, to compensate for the lack
  1351. of expected GUI behavior, mpv will in some cases start with some settings
  1352. changed to behave slightly more like a GUI mode.
  1353. .sp
  1354. Currently this happens only in the following cases:
  1355. .INDENT 0.0
  1356. .IP \(bu 2
  1357. if started using the \fBmpv.desktop\fP file on Linux (e.g. started from menus
  1358. or file associations provided by desktop environments)
  1359. .IP \(bu 2
  1360. if started from explorer.exe on Windows (technically, if it was started on
  1361. Windows, and all of the stdout/stderr/stdin handles are unset)
  1362. .IP \(bu 2
  1363. started out of the bundle on OSX
  1364. .IP \(bu 2
  1365. if you manually use \fB\-\-player\-operation\-mode=pseudo\-gui\fP on the command line
  1366. .UNINDENT
  1367. .sp
  1368. This mode applies options from the builtin profile \fBbuiltin\-pseudo\-gui\fP, but
  1369. only if these haven\(aqt been set in the user\(aqs config file or on the command line.
  1370. Also, for compatibility with the old pseudo\-gui behavior, the options in the
  1371. \fBpseudo\-gui\fP profile are applied unconditionally. In addition, the profile
  1372. makes sure to enable the pseudo\-GUI mode, so that \fB\-\-profile=pseudo\-gui\fP
  1373. works like in older mpv releases. The profiles are currently defined as follows:
  1374. .INDENT 0.0
  1375. .INDENT 3.5
  1376. .sp
  1377. .nf
  1378. .ft C
  1379. [builtin\-pseudo\-gui]
  1380. terminal=no
  1381. force\-window=yes
  1382. idle=once
  1383. screenshot\-directory=~~desktop/
  1384. [pseudo\-gui]
  1385. player\-operation\-mode=pseudo\-gui
  1386. .ft P
  1387. .fi
  1388. .UNINDENT
  1389. .UNINDENT
  1390. .sp
  1391. \fBWARNING:\fP
  1392. .INDENT 0.0
  1393. .INDENT 3.5
  1394. Currently, you can extend the \fBpseudo\-gui\fP profile in the config file the
  1395. normal way. This is deprecated. In future mpv releases, the behavior might
  1396. change, and not apply your additional settings, and/or use a different
  1397. profile name.
  1398. .UNINDENT
  1399. .UNINDENT
  1400. .SH OPTIONS
  1401. .SS Track Selection
  1402. .INDENT 0.0
  1403. .TP
  1404. .B \fB\-\-alang=<languagecode[,languagecode,...]>\fP
  1405. Specify a priority list of audio languages to use. Different container
  1406. formats employ different language codes. DVDs use ISO 639\-1 two\-letter
  1407. language codes, Matroska, MPEG\-TS and NUT use ISO 639\-2 three\-letter
  1408. language codes, while OGM uses a free\-form identifier. See also \fB\-\-aid\fP\&.
  1409. .sp
  1410. This is a string list option. See \fI\%List Options\fP for details.
  1411. .INDENT 7.0
  1412. .INDENT 3.5
  1413. .IP "Examples"
  1414. .INDENT 0.0
  1415. .IP \(bu 2
  1416. \fBmpv dvd://1 \-\-alang=hu,en\fP chooses the Hungarian language track
  1417. on a DVD and falls back on English if Hungarian is not available.
  1418. .IP \(bu 2
  1419. \fBmpv \-\-alang=jpn example.mkv\fP plays a Matroska file with Japanese
  1420. audio.
  1421. .UNINDENT
  1422. .UNINDENT
  1423. .UNINDENT
  1424. .TP
  1425. .B \fB\-\-slang=<languagecode[,languagecode,...]>\fP
  1426. Specify a priority list of subtitle languages to use. Different container
  1427. formats employ different language codes. DVDs use ISO 639\-1 two letter
  1428. language codes, Matroska uses ISO 639\-2 three letter language codes while
  1429. OGM uses a free\-form identifier. See also \fB\-\-sid\fP\&.
  1430. .sp
  1431. This is a string list option. See \fI\%List Options\fP for details.
  1432. .INDENT 7.0
  1433. .INDENT 3.5
  1434. .IP "Examples"
  1435. .INDENT 0.0
  1436. .IP \(bu 2
  1437. \fBmpv dvd://1 \-\-slang=hu,en\fP chooses the Hungarian subtitle track on
  1438. a DVD and falls back on English if Hungarian is not available.
  1439. .IP \(bu 2
  1440. \fBmpv \-\-slang=jpn example.mkv\fP plays a Matroska file with Japanese
  1441. subtitles.
  1442. .UNINDENT
  1443. .UNINDENT
  1444. .UNINDENT
  1445. .TP
  1446. .B \fB\-\-vlang=<...>\fP
  1447. Equivalent to \fB\-\-alang\fP and \fB\-\-slang\fP, for video tracks.
  1448. .sp
  1449. This is a string list option. See \fI\%List Options\fP for details.
  1450. .TP
  1451. .B \fB\-\-aid=<ID|auto|no>\fP
  1452. Select audio track. \fBauto\fP selects the default, \fBno\fP disables audio.
  1453. See also \fB\-\-alang\fP\&. mpv normally prints available audio tracks on the
  1454. terminal when starting playback of a file.
  1455. .sp
  1456. \fB\-\-audio\fP is an alias for \fB\-\-aid\fP\&.
  1457. .sp
  1458. \fB\-\-aid=no\fP or \fB\-\-audio=no\fP or \fB\-\-no\-audio\fP disables audio playback.
  1459. (The latter variant does not work with the client API.)
  1460. .TP
  1461. .B \fB\-\-sid=<ID|auto|no>\fP
  1462. Display the subtitle stream specified by \fB<ID>\fP\&. \fBauto\fP selects
  1463. the default, \fBno\fP disables subtitles.
  1464. .sp
  1465. \fB\-\-sub\fP is an alias for \fB\-\-sid\fP\&.
  1466. .sp
  1467. \fB\-\-sid=no\fP or \fB\-\-sub=no\fP or \fB\-\-no\-sub\fP disables subtitle decoding.
  1468. (The latter variant does not work with the client API.)
  1469. .TP
  1470. .B \fB\-\-vid=<ID|auto|no>\fP
  1471. Select video channel. \fBauto\fP selects the default, \fBno\fP disables video.
  1472. .sp
  1473. \fB\-\-video\fP is an alias for \fB\-\-vid\fP\&.
  1474. .sp
  1475. \fB\-\-vid=no\fP or \fB\-\-video=no\fP or \fB\-\-no\-video\fP disables video playback.
  1476. (The latter variant does not work with the client API.)
  1477. .sp
  1478. If video is disabled, mpv will try to download the audio only if media is
  1479. streamed with youtube\-dl, because it saves bandwidth. This is done by
  1480. setting the ytdl_format to "bestaudio/best" in the ytdl_hook.lua script.
  1481. .TP
  1482. .B \fB\-\-edition=<ID|auto>\fP
  1483. (Matroska files only)
  1484. Specify the edition (set of chapters) to use, where 0 is the first. If set
  1485. to \fBauto\fP (the default), mpv will choose the first edition declared as a
  1486. default, or if there is no default, the first edition defined.
  1487. .TP
  1488. .B \fB\-\-track\-auto\-selection=<yes|no>\fP
  1489. Enable the default track auto\-selection (default: yes). Enabling this will
  1490. make the player select streams according to \fB\-\-aid\fP, \fB\-\-alang\fP, and
  1491. others. If it is disabled, no tracks are selected. In addition, the player
  1492. will not exit if no tracks are selected, and wait instead (this wait mode
  1493. is similar to pausing, but the pause option is not set).
  1494. .sp
  1495. This is useful with \fB\-\-lavfi\-complex\fP: you can start playback in this
  1496. mode, and then set select tracks at runtime by setting the filter graph.
  1497. Note that if \fB\-\-lavfi\-complex\fP is set before playback is started, the
  1498. referenced tracks are always selected.
  1499. .UNINDENT
  1500. .SS Playback Control
  1501. .INDENT 0.0
  1502. .TP
  1503. .B \fB\-\-start=<relative time>\fP
  1504. Seek to given time position.
  1505. .sp
  1506. The general format for times is \fB[+|\-][[hh:]mm:]ss[.ms]\fP\&. If the time is
  1507. prefixed with \fB\-\fP, the time is considered relative from the end of the
  1508. file (as signaled by the demuxer/the file). A \fB+\fP is usually ignored (but
  1509. see below).
  1510. .sp
  1511. The following alternative time specifications are recognized:
  1512. .sp
  1513. \fBpp%\fP seeks to percent position pp (0\-100).
  1514. .sp
  1515. \fB#c\fP seeks to chapter number c. (Chapters start from 1.)
  1516. .sp
  1517. \fBnone\fP resets any previously set option (useful for libmpv).
  1518. .sp
  1519. If \fB\-\-rebase\-start\-time=no\fP is given, then prefixing times with \fB+\fP
  1520. makes the time relative to the start of the file. A timestamp without
  1521. prefix is considered an absolute time, i.e. should seek to a frame with a
  1522. timestamp as the file contains it. As a bug, but also a hidden feature,
  1523. putting 1 or more spaces before the \fB+\fP or \fB\-\fP always interprets the
  1524. time as absolute, which can be used to seek to negative timestamps (useful
  1525. for debugging at most).
  1526. .INDENT 7.0
  1527. .INDENT 3.5
  1528. .IP "Examples"
  1529. .INDENT 0.0
  1530. .TP
  1531. .B \fB\-\-start=+56\fP, \fB\-\-start=00:56\fP
  1532. Seeks to the start time + 56 seconds.
  1533. .TP
  1534. .B \fB\-\-start=\-56\fP, \fB\-\-start=\-00:56\fP
  1535. Seeks to the end time \- 56 seconds.
  1536. .TP
  1537. .B \fB\-\-start=01:10:00\fP
  1538. Seeks to 1 hour 10 min.
  1539. .TP
  1540. .B \fB\-\-start=50%\fP
  1541. Seeks to the middle of the file.
  1542. .TP
  1543. .B \fB\-\-start=30 \-\-end=40\fP
  1544. Seeks to 30 seconds, plays 10 seconds, and exits.
  1545. .TP
  1546. .B \fB\-\-start=\-3:20 \-\-length=10\fP
  1547. Seeks to 3 minutes and 20 seconds before the end of the file, plays
  1548. 10 seconds, and exits.
  1549. .TP
  1550. .B \fB\-\-start=\(aq#2\(aq \-\-end=\(aq#4\(aq\fP
  1551. Plays chapters 2 and 3, and exits.
  1552. .UNINDENT
  1553. .UNINDENT
  1554. .UNINDENT
  1555. .TP
  1556. .B \fB\-\-end=<relative time>\fP
  1557. Stop at given time. Use \fB\-\-length\fP if the time should be relative
  1558. to \fB\-\-start\fP\&. See \fB\-\-start\fP for valid option values and examples.
  1559. .TP
  1560. .B \fB\-\-length=<relative time>\fP
  1561. Stop after a given time relative to the start time.
  1562. See \fB\-\-start\fP for valid option values and examples.
  1563. .sp
  1564. If both \fB\-\-end\fP and \fB\-\-length\fP are provided, playback will stop when it
  1565. reaches either of the two endpoints.
  1566. .sp
  1567. Obscurity note: this does not work correctly if \fB\-\-rebase\-start\-time=no\fP,
  1568. and the specified time is not an "absolute" time, as defined in the
  1569. \fB\-\-start\fP option description.
  1570. .TP
  1571. .B \fB\-\-rebase\-start\-time=<yes|no>\fP
  1572. Whether to move the file start time to \fB00:00:00\fP (default: yes). This
  1573. is less awkward for files which start at a random timestamp, such as
  1574. transport streams. On the other hand, if there are timestamp resets, the
  1575. resulting behavior can be rather weird. For this reason, and in case you
  1576. are actually interested in the real timestamps, this behavior can be
  1577. disabled with \fBno\fP\&.
  1578. .TP
  1579. .B \fB\-\-speed=<0.01\-100>\fP
  1580. Slow down or speed up playback by the factor given as parameter.
  1581. .sp
  1582. If \fB\-\-audio\-pitch\-correction\fP (on by default) is used, playing with a
  1583. speed higher than normal automatically inserts the \fBscaletempo\fP audio
  1584. filter.
  1585. .TP
  1586. .B \fB\-\-pause\fP
  1587. Start the player in paused state.
  1588. .TP
  1589. .B \fB\-\-shuffle\fP
  1590. Play files in random order.
  1591. .TP
  1592. .B \fB\-\-playlist\-start=<auto|index>\fP
  1593. Set which file on the internal playlist to start playback with. The index
  1594. is an integer, with 0 meaning the first file. The value \fBauto\fP means that
  1595. the selection of the entry to play is left to the playback resume mechanism
  1596. (default). If an entry with the given index doesn\(aqt exist, the behavior is
  1597. unspecified and might change in future mpv versions. The same applies if
  1598. the playlist contains further playlists (don\(aqt expect any reasonable
  1599. behavior). Passing a playlist file to mpv should work with this option,
  1600. though. E.g. \fBmpv playlist.m3u \-\-playlist\-start=123\fP will work as expected,
  1601. as long as \fBplaylist.m3u\fP does not link to further playlists.
  1602. .sp
  1603. The value \fBno\fP is a deprecated alias for \fBauto\fP\&.
  1604. .TP
  1605. .B \fB\-\-playlist=<filename>\fP
  1606. Play files according to a playlist file (Supports some common formats. If
  1607. no format is detected, it will be treated as list of files, separated by
  1608. newline characters. Note that XML playlist formats are not supported.)
  1609. .sp
  1610. You can play playlists directly and without this option, however, this
  1611. option disables any security mechanisms that might be in place. You may
  1612. also need this option to load plaintext files as playlist.
  1613. .sp
  1614. \fBWARNING:\fP
  1615. .INDENT 7.0
  1616. .INDENT 3.5
  1617. The way mpv uses playlist files via \fB\-\-playlist\fP is not safe against
  1618. maliciously constructed files. Such files may trigger harmful actions.
  1619. This has been the case for all mpv and MPlayer versions, but
  1620. unfortunately this fact was not well documented earlier, and some people
  1621. have even misguidedly recommended use of \fB\-\-playlist\fP with untrusted
  1622. sources. Do NOT use \fB\-\-playlist\fP with random internet sources or files
  1623. you do not trust!
  1624. .sp
  1625. Playlist can contain entries using other protocols, such as local files,
  1626. or (most severely), special protocols like \fBavdevice://\fP, which are
  1627. inherently unsafe.
  1628. .UNINDENT
  1629. .UNINDENT
  1630. .TP
  1631. .B \fB\-\-chapter\-merge\-threshold=<number>\fP
  1632. Threshold for merging almost consecutive ordered chapter parts in
  1633. milliseconds (default: 100). Some Matroska files with ordered chapters
  1634. have inaccurate chapter end timestamps, causing a small gap between the
  1635. end of one chapter and the start of the next one when they should match.
  1636. If the end of one playback part is less than the given threshold away from
  1637. the start of the next one then keep playing video normally over the
  1638. chapter change instead of doing a seek.
  1639. .TP
  1640. .B \fB\-\-chapter\-seek\-threshold=<seconds>\fP
  1641. Distance in seconds from the beginning of a chapter within which a backward
  1642. chapter seek will go to the previous chapter (default: 5.0). Past this
  1643. threshold, a backward chapter seek will go to the beginning of the current
  1644. chapter instead. A negative value means always go back to the previous
  1645. chapter.
  1646. .TP
  1647. .B \fB\-\-hr\-seek=<no|absolute|yes>\fP
  1648. Select when to use precise seeks that are not limited to keyframes. Such
  1649. seeks require decoding video from the previous keyframe up to the target
  1650. position and so can take some time depending on decoding performance. For
  1651. some video formats, precise seeks are disabled. This option selects the
  1652. default choice to use for seeks; it is possible to explicitly override that
  1653. default in the definition of key bindings and in input commands.
  1654. .INDENT 7.0
  1655. .TP
  1656. .B no
  1657. Never use precise seeks.
  1658. .TP
  1659. .B absolute
  1660. Use precise seeks if the seek is to an absolute position in the
  1661. file, such as a chapter seek, but not for relative seeks like
  1662. the default behavior of arrow keys (default).
  1663. .TP
  1664. .B yes
  1665. Use precise seeks whenever possible.
  1666. .TP
  1667. .B always
  1668. Same as \fByes\fP (for compatibility).
  1669. .UNINDENT
  1670. .TP
  1671. .B \fB\-\-hr\-seek\-demuxer\-offset=<seconds>\fP
  1672. This option exists to work around failures to do precise seeks (as in
  1673. \fB\-\-hr\-seek\fP) caused by bugs or limitations in the demuxers for some file
  1674. formats. Some demuxers fail to seek to a keyframe before the given target
  1675. position, going to a later position instead. The value of this option is
  1676. subtracted from the time stamp given to the demuxer. Thus, if you set this
  1677. option to 1.5 and try to do a precise seek to 60 seconds, the demuxer is
  1678. told to seek to time 58.5, which hopefully reduces the chance that it
  1679. erroneously goes to some time later than 60 seconds. The downside of
  1680. setting this option is that precise seeks become slower, as video between
  1681. the earlier demuxer position and the real target may be unnecessarily
  1682. decoded.
  1683. .TP
  1684. .B \fB\-\-hr\-seek\-framedrop=<yes|no>\fP
  1685. Allow the video decoder to drop frames during seek, if these frames are
  1686. before the seek target. If this is enabled, precise seeking can be faster,
  1687. but if you\(aqre using video filters which modify timestamps or add new
  1688. frames, it can lead to precise seeking skipping the target frame. This
  1689. e.g. can break frame backstepping when deinterlacing is enabled.
  1690. .sp
  1691. Default: \fByes\fP
  1692. .TP
  1693. .B \fB\-\-index=<mode>\fP
  1694. Controls how to seek in files. Note that if the index is missing from a
  1695. file, it will be built on the fly by default, so you don\(aqt need to change
  1696. this. But it might help with some broken files.
  1697. .INDENT 7.0
  1698. .TP
  1699. .B default
  1700. use an index if the file has one, or build it if missing
  1701. .TP
  1702. .B recreate
  1703. don\(aqt read or use the file\(aqs index
  1704. .UNINDENT
  1705. .sp
  1706. \fBNOTE:\fP
  1707. .INDENT 7.0
  1708. .INDENT 3.5
  1709. This option only works if the underlying media supports seeking
  1710. (i.e. not with stdin, pipe, etc).
  1711. .UNINDENT
  1712. .UNINDENT
  1713. .TP
  1714. .B \fB\-\-load\-unsafe\-playlists\fP
  1715. Load URLs from playlists which are considered unsafe (default: no). This
  1716. includes special protocols and anything that doesn\(aqt refer to normal files.
  1717. Local files and HTTP links on the other hand are always considered safe.
  1718. .sp
  1719. In addition, if a playlist is loaded while this is set, the added playlist
  1720. entries are not marked as originating from network or potentially unsafe
  1721. location. (Instead, the behavior is as if the playlist entries were provided
  1722. directly to mpv command line or \fBloadfile\fP command.)
  1723. .sp
  1724. Note that \fB\-\-playlist\fP always loads all entries, so you use that instead
  1725. if you really have the need for this functionality.
  1726. .TP
  1727. .B \fB\-\-access\-references=<yes|no>\fP
  1728. Follow any references in the file being opened (default: yes). Disabling
  1729. this is helpful if the file is automatically scanned (e.g. thumbnail
  1730. generation). If the thumbnail scanner for example encounters a playlist
  1731. file, which contains network URLs, and the scanner should not open these,
  1732. enabling this option will prevent it. This option also disables ordered
  1733. chapters, mov reference files, opening of archives, and a number of other
  1734. features.
  1735. .sp
  1736. On older FFmpeg versions, this will not work in some cases. Some FFmpeg
  1737. demuxers might not respect this option.
  1738. .sp
  1739. This option does not prevent opening of paired subtitle files and such. Use
  1740. \fB\-\-autoload\-files=no\fP to prevent this.
  1741. .sp
  1742. This option does not always work if you open non\-files (for example using
  1743. \fBdvd://directory\fP would open a whole bunch of files in the given
  1744. directory). Prefixing the filename with \fB\&./\fP if it doesn\(aqt start with
  1745. a \fB/\fP will avoid this.
  1746. .TP
  1747. .B \fB\-\-loop\-playlist=<N|inf|force|no>\fP, \fB\-\-loop\-playlist\fP
  1748. Loops playback \fBN\fP times. A value of \fB1\fP plays it one time (default),
  1749. \fB2\fP two times, etc. \fBinf\fP means forever. \fBno\fP is the same as \fB1\fP and
  1750. disables looping. If several files are specified on command line, the
  1751. entire playlist is looped. \fB\-\-loop\-playlist\fP is the same as
  1752. \fB\-\-loop\-playlist=inf\fP\&.
  1753. .sp
  1754. The \fBforce\fP mode is like \fBinf\fP, but does not skip playlist entries
  1755. which have been marked as failing. This means the player might waste CPU
  1756. time trying to loop a file that doesn\(aqt exist. But it might be useful for
  1757. playing webradios under very bad network conditions.
  1758. .TP
  1759. .B \fB\-\-loop\-file=<N|inf|no>\fP, \fB\-\-loop=<N|inf|no>\fP
  1760. Loop a single file N times. \fBinf\fP means forever, \fBno\fP means normal
  1761. playback. For compatibility, \fB\-\-loop\-file\fP and \fB\-\-loop\-file=yes\fP are
  1762. also accepted, and are the same as \fB\-\-loop\-file=inf\fP\&.
  1763. .sp
  1764. The difference to \fB\-\-loop\-playlist\fP is that this doesn\(aqt loop the playlist,
  1765. just the file itself. If the playlist contains only a single file, the
  1766. difference between the two option is that this option performs a seek on
  1767. loop, instead of reloading the file.
  1768. .sp
  1769. \fB\-\-loop\fP is an alias for this option.
  1770. .TP
  1771. .B \fB\-\-ab\-loop\-a=<time>\fP, \fB\-\-ab\-loop\-b=<time>\fP
  1772. Set loop points. If playback passes the \fBb\fP timestamp, it will seek to
  1773. the \fBa\fP timestamp. Seeking past the \fBb\fP point doesn\(aqt loop (this is
  1774. intentional).
  1775. .sp
  1776. If \fBa\fP is after \fBb\fP, the behavior is as if the points were given in
  1777. the right order, and the player will seek to \fBb\fP after crossing through
  1778. \fBa\fP\&. This is different from old behavior, where looping was disabled (and
  1779. as a bug, looped back to \fBa\fP on the end of the file).
  1780. .sp
  1781. If either options are set to \fBno\fP (or unset), looping is disabled. This
  1782. is different from old behavior, where an unset \fBa\fP implied the start of
  1783. the file, and an unset \fBb\fP the end of the file.
  1784. .sp
  1785. The loop\-points can be adjusted at runtime with the corresponding
  1786. properties. See also \fBab\-loop\fP command.
  1787. .TP
  1788. .B \fB\-\-ordered\-chapters\fP, \fB\-\-no\-ordered\-chapters\fP
  1789. Enabled by default.
  1790. Disable support for Matroska ordered chapters. mpv will not load or
  1791. search for video segments from other files, and will also ignore any
  1792. chapter order specified for the main file.
  1793. .TP
  1794. .B \fB\-\-ordered\-chapters\-files=<playlist\-file>\fP
  1795. Loads the given file as playlist, and tries to use the files contained in
  1796. it as reference files when opening a Matroska file that uses ordered
  1797. chapters. This overrides the normal mechanism for loading referenced
  1798. files by scanning the same directory the main file is located in.
  1799. .sp
  1800. Useful for loading ordered chapter files that are not located on the local
  1801. filesystem, or if the referenced files are in different directories.
  1802. .sp
  1803. Note: a playlist can be as simple as a text file containing filenames
  1804. separated by newlines.
  1805. .TP
  1806. .B \fB\-\-chapters\-file=<filename>\fP
  1807. Load chapters from this file, instead of using the chapter metadata found
  1808. in the main file.
  1809. .sp
  1810. This accepts a media file (like mkv) or even a pseudo\-format like ffmetadata
  1811. and uses its chapters to replace the current file\(aqs chapters. This doesn\(aqt
  1812. work with OGM or XML chapters directly.
  1813. .TP
  1814. .B \fB\-\-sstep=<sec>\fP
  1815. Skip <sec> seconds after every frame.
  1816. .sp
  1817. \fBNOTE:\fP
  1818. .INDENT 7.0
  1819. .INDENT 3.5
  1820. Without \fB\-\-hr\-seek\fP, skipping will snap to keyframes.
  1821. .UNINDENT
  1822. .UNINDENT
  1823. .TP
  1824. .B \fB\-\-stop\-playback\-on\-init\-failure=<yes|no>\fP
  1825. Stop playback if either audio or video fails to initialize (default: no).
  1826. With \fBno\fP, playback will continue in video\-only or audio\-only mode if one
  1827. of them fails. This doesn\(aqt affect playback of audio\-only or video\-only
  1828. files.
  1829. .TP
  1830. .B \fB\-\-play\-dir=<forward|+|backward|\->\fP
  1831. Control the playback direction (default: forward). Setting \fBbackward\fP
  1832. will attempt to play the file in reverse direction, with decreasing
  1833. playback time. If this is set on playback starts, playback will start from
  1834. the end of the file. If this is changed at during playback, a hr\-seek will
  1835. be issued to change the direction.
  1836. .sp
  1837. \fB+\fP and \fB\-\fP are aliases for \fBforward\fP and \fBbackward\fP\&.
  1838. .sp
  1839. The rest of this option description pertains to the \fBbackward\fP mode.
  1840. .sp
  1841. \fBNOTE:\fP
  1842. .INDENT 7.0
  1843. .INDENT 3.5
  1844. Backward playback is extremely fragile. It may not always work, is much
  1845. slower than forward playback, and breaks certain other features. How
  1846. well it works depends mainly on the file being played. Generally, it
  1847. will show good results (or results at all) only if the stars align.
  1848. .UNINDENT
  1849. .UNINDENT
  1850. .sp
  1851. mpv, as well as most media formats, were designed for forward playback
  1852. only. Backward playback is bolted on top of mpv, and tries to make a medium
  1853. effort to make backward playback work. Depending on your use\-case, another
  1854. tool may work much better.
  1855. .sp
  1856. Backward playback is not exactly a 1st class feature. Implementation
  1857. tradeoffs were made, that are bad for backward playback, but in turn do not
  1858. cause disadvantages for normal playback. Various possible optimizations are
  1859. not implemented in order to keep the complexity down. Normally, a media
  1860. player is highly pipelined (future data is prepared in separate threads, so
  1861. it is available in realtime when the next stage needs it), but backward
  1862. playback will essentially stall the pipeline at various random points.
  1863. .sp
  1864. For example, for intra\-only codecs are trivially backward playable, and
  1865. tools built around them may make efficient use of them (consider video
  1866. editors or camera viewers). mpv won\(aqt be efficient in this case, because it
  1867. uses its generic backward playback algorithm, that on top of it is not very
  1868. optimized.
  1869. .sp
  1870. If you just want to quickly go backward through the video and just show
  1871. "keyframes", just use forward playback, and hold down the left cursor key
  1872. (which on CLI with default config sends many small relative seek commands).
  1873. .sp
  1874. The implementation consists of mostly 3 parts:
  1875. .INDENT 7.0
  1876. .IP \(bu 2
  1877. Backward demuxing. This relies on the demuxer cache, so the demuxer cache
  1878. should (or must, didn\(aqt test it) be enabled, and its size will affect
  1879. performance. If the cache is too small or too large, quadratic runtime
  1880. behavior may result.
  1881. .IP \(bu 2
  1882. Backward decoding. The decoder library used (libavcodec) does not support
  1883. this. It is emulated by feeding bits of data in forward, putting the
  1884. result in a queue, returning the queue data to the VO in reverse, and
  1885. then starting over at an earlier position. This can require buffering an
  1886. extreme amount of decoded data, and also completely breaks pipelining.
  1887. .IP \(bu 2
  1888. Backward output. This is relatively simple, because the decoder returns
  1889. the frames in the needed order. However, this may cause various problems
  1890. because filters see audio and video going backward.
  1891. .UNINDENT
  1892. .sp
  1893. Known problems:
  1894. .INDENT 7.0
  1895. .IP \(bu 2
  1896. It\(aqs fragile. If anything doesn\(aqt work, random non\-useful behavior may
  1897. occur. In simple cases, the player will just play nonsense and artifacts.
  1898. In other cases, it may get stuck or heat the CPU. (Exceeding memory usage
  1899. significantly beyond the user\-set limits would be a bug, though.)
  1900. .IP \(bu 2
  1901. Performance and resource usage isn\(aqt good. In part this is inherent to
  1902. backward playback of normal media formats, and in parts due to
  1903. implementation choices and tradeoffs.
  1904. .IP \(bu 2
  1905. This is extremely reliant on good demuxer behavior. Although backward
  1906. demuxing requires no special demuxer support, it is required that the
  1907. demuxer performs seeks reliably, fulfills some specific requirements
  1908. about packet metadata, and has deterministic behavior.
  1909. .IP \(bu 2
  1910. Starting playback exactly from the end may or may not work, depending on
  1911. seeking behavior and file duration detection.
  1912. .IP \(bu 2
  1913. Some container formats, audio, and video codecs are not supported due to
  1914. their behavior. There is no list, and the player usually does not detect
  1915. them. Certain live streams (including TV captures) may exhibit problems
  1916. in particular, as well as some lossy audio codecs. h264 intra\-refresh is
  1917. known not to work due to problems with libavcodec. WAV and some other raw
  1918. audio formats tend to have problems \- there are hacks for dealing with
  1919. them, which may or may not work.
  1920. .IP \(bu 2
  1921. Backward demuxing of subtitles is not supported. Subtitle display still
  1922. works for some external text subtitle formats. (These are fully read into
  1923. memory, and only backward display is needed.) Text subtitles that are
  1924. cached in the subtitle renderer also have a chance to be displayed
  1925. correctly.
  1926. .IP \(bu 2
  1927. Some features dealing with playback of broken or hard to deal with files
  1928. will not work fully (such as timestamp correction).
  1929. .IP \(bu 2
  1930. If demuxer low level seeks (i.e. seeking the actual demuxer instead of
  1931. just within the demuxer cache) are performed by backward playback, the
  1932. created seek ranges may not join, because not enough overlap is achieved.
  1933. .IP \(bu 2
  1934. Trying to use this with hardware video decoding will probably exhaust all
  1935. your GPU memory and then crash a thing or two. Or it will fail because
  1936. \fB\-\-hwdec\-extra\-frames\fP will certainly be set too low.
  1937. .IP \(bu 2
  1938. Stream recording is broken. \fB\-\-stream\-record\fP may keep working if you
  1939. backward play within a cached region only.
  1940. .IP \(bu 2
  1941. Relative seeks may behave weird. Small seeks backward (towards smaller
  1942. time, i.e. \fBseek \-1\fP) may not really seek properly, and audio will
  1943. remain muted for a while. Using hr\-seek is recommended, which should have
  1944. none of these problems.
  1945. .IP \(bu 2
  1946. Some things are just weird. For example, while seek commands manipulate
  1947. playback time in the expected way (provided they work correctly), the
  1948. framestep commands are transposed. Backstepping will perform very
  1949. expensive work to step forward by 1 frame.
  1950. .UNINDENT
  1951. .sp
  1952. Tuning:
  1953. .INDENT 7.0
  1954. .IP \(bu 2
  1955. Remove all \fB\-\-vf\fP/\fB\-\-af\fP filters you have set. Disable hardware
  1956. decoding. Disable idiotic nonsense like SPDIF passthrough.
  1957. .IP \(bu 2
  1958. Increasing \fB\-\-video\-reversal\-buffer\fP might help if reversal queue
  1959. overflow is reported, which may happen in high bitrate video, or video
  1960. with large GOP. Hardware decoding mostly ignores this, and you need to
  1961. increase \fB\-\-hwdec\-extra\-frames\fP instead (until you get playback without
  1962. logged errors).
  1963. .IP \(bu 2
  1964. The demuxer cache is essential for backward demuxing. Make sure to set
  1965. \fB\-\-demuxer\-seekable\-cache\fP (or just use \fB\-\-cache\fP). The cache size
  1966. might matter. If it\(aqs too small, a queue overflow will be logged, and
  1967. backward playback cannot continue, or it performs too many low level
  1968. seeks. If it\(aqs too large, implementation tradeoffs may cause general
  1969. performance issues. Use \fB\-\-demuxer\-max\-bytes\fP to potentially increase
  1970. the amount of packets the demuxer layer can queue for reverse demuxing
  1971. (basically it\(aqs the \fB\-\-video\-reversal\-buffer\fP equivalent for the
  1972. demuxer layer).
  1973. .IP \(bu 2
  1974. \fB\-\-demuxer\-backward\-playback\-step\fP also factors into how many seeks may
  1975. be performed, and whether backward demuxing could break due to queue
  1976. overflow. If it\(aqs set too high, the backstep operation needs to search
  1977. through more packets all the time, even if the cache is large enough.
  1978. .IP \(bu 2
  1979. Setting \fB\-\-demuxer\-cache\-wait\fP may be useful to cache the entire file
  1980. into the demuxer cache. Set \fB\-\-demuxer\-max\-bytes\fP to a large size to
  1981. make sure it can read the entire cache; \fB\-\-demuxer\-max\-back\-bytes\fP
  1982. should also be set to a large size to prevent that tries to trim the
  1983. cache.
  1984. .IP \(bu 2
  1985. If audio artifacts are audible, even though the AO does not underrun,
  1986. increasing \fB\-\-audio\-backward\-overlap\fP might help in some cases.
  1987. .UNINDENT
  1988. .TP
  1989. .B \fB\-\-video\-reversal\-buffer=<bytesize>\fP, \fB\-\-audio\-reversal\-buffer=<bytesize>\fP
  1990. For backward decoding. Backward decoding decodes forward in steps, and then
  1991. reverses the decoder output. These options control the approximate maximum
  1992. amount of bytes that can be buffered. The main use of this is to avoid
  1993. unbounded resource usage; during normal backward playback, it\(aqs not supposed
  1994. to hit the limit, and if it does, it will drop frames and complain about it.
  1995. .sp
  1996. Use this option if you get reversal queue overflow errors during backward
  1997. playback. Increase the size until the warning disappears. Usually, the video
  1998. buffer will overflow first, especially if it\(aqs high resolution video.
  1999. .sp
  2000. This does not work correctly if video hardware decoding is used. The video
  2001. frame size will not include the referenced GPU and driver memory. Some
  2002. hardware decoders may also be limited by \fB\-\-hwdec\-extra\-frames\fP\&.
  2003. .sp
  2004. How large the queue size needs to be depends entirely on the way the media
  2005. was encoded. Audio typically requires a very small buffer, while video can
  2006. require excessively large buffers.
  2007. .sp
  2008. (Technically, this allows the last frame to exceed the limit. Also, this
  2009. does not account for other buffered frames, such as inside the decoder or
  2010. the video output.)
  2011. .sp
  2012. This does not affect demuxer cache behavior at all.
  2013. .sp
  2014. See \fB\-\-list\-options\fP for defaults and value range. \fB<bytesize>\fP options
  2015. accept suffixes such as \fBKiB\fP and \fBMiB\fP\&.
  2016. .TP
  2017. .B \fB\-\-video\-backward\-overlap=<auto|number>\fP, \fB\-\-audio\-backward\-overlap=<auto|number>\fP
  2018. Number of overlapping keyframe ranges to use for backward decoding (default:
  2019. auto) ("keyframe" to be understood as in the mpv/ffmpeg specific meaning).
  2020. Backward decoding works by forward decoding in small steps. Some codecs
  2021. cannot restart decoding from any packet (even if it\(aqs marked as seek point),
  2022. which becomes noticeable with backward decoding (in theory this is a problem
  2023. with seeking too, but \fB\-\-hr\-seek\-demuxer\-offset\fP can fix it for seeking).
  2024. In particular, MDCT based audio codecs are affected.
  2025. .sp
  2026. The solution is to feed a previous packet to the decoder each time, and then
  2027. discard the output. This option controls how many packets to feed. The
  2028. \fBauto\fP choice is currently hardcoded to 0 for video, and uses 1 for lossy
  2029. audio, 0 for lossless audio. For some specific lossy audio codecs, this is
  2030. set to 2.
  2031. .sp
  2032. \fB\-\-video\-backward\-overlap\fP can potentially handle intra\-refresh video,
  2033. depending on the exact conditions. You may have to use the
  2034. \fB\-\-vd\-lavc\-show\-all\fP option as well.
  2035. .TP
  2036. .B \fB\-\-video\-backward\-batch=<number>\fP, \fB\-\-audio\-backward\-batch=<number>\fP
  2037. Number of keyframe ranges to decode at once when backward decoding (default:
  2038. 1 for video, 10 for audio). Another pointless tuning parameter nobody should
  2039. use. This should affect performance only. In theory, setting a number higher
  2040. than 1 for audio will reduce overhead due to less frequent backstep
  2041. operations and less redundant decoding work due to fewer decoded overlap
  2042. frames (see \fB\-\-audio\-backward\-overlap\fP). On the other hand, it requires
  2043. a larger reversal buffer, and could make playback less smooth due to
  2044. breaking pipelining (e.g. by decoding a lot, and then doing nothing for a
  2045. while).
  2046. .sp
  2047. It probably never makes sense to set \fB\-\-video\-backward\-batch\fP\&. But in
  2048. theory, it could help with intra\-only video codecs by reducing backstep
  2049. operations.
  2050. .TP
  2051. .B \fB\-\-demuxer\-backward\-playback\-step=<seconds>\fP
  2052. Number of seconds the demuxer should seek back to get new packets during
  2053. backward playback (default: 60). This is useful for tuning backward
  2054. playback, see \fB\-\-play\-dir\fP for details.
  2055. .sp
  2056. Setting this to a very low value or 0 may make the player think seeking is
  2057. broken, or may make it perform multiple seeks.
  2058. .sp
  2059. Setting this to a high value may lead to quadratic runtime behavior.
  2060. .UNINDENT
  2061. .SS Program Behavior
  2062. .INDENT 0.0
  2063. .TP
  2064. .B \fB\-\-help\fP, \fB\-\-h\fP
  2065. Show short summary of options.
  2066. .sp
  2067. You can also pass a string to this option, which will list all top\-level
  2068. options which contain the string in the name, e.g. \fB\-\-h=scale\fP for all
  2069. options that contain the word \fBscale\fP\&. The special string \fB*\fP lists
  2070. all top\-level options.
  2071. .TP
  2072. .B \fB\-v\fP
  2073. Increment verbosity level, one level for each \fB\-v\fP found on the command
  2074. line.
  2075. .TP
  2076. .B \fB\-\-version, \-V\fP
  2077. Print version string and exit.
  2078. .TP
  2079. .B \fB\-\-no\-config\fP
  2080. Do not load default configuration files. This prevents loading of both the
  2081. user\-level and system\-wide \fBmpv.conf\fP and \fBinput.conf\fP files. Other
  2082. configuration files are blocked as well, such as resume playback files.
  2083. .sp
  2084. \fBNOTE:\fP
  2085. .INDENT 7.0
  2086. .INDENT 3.5
  2087. Files explicitly requested by command line options, like
  2088. \fB\-\-include\fP or \fB\-\-use\-filedir\-conf\fP, will still be loaded.
  2089. .UNINDENT
  2090. .UNINDENT
  2091. .sp
  2092. See also: \fB\-\-config\-dir\fP\&.
  2093. .TP
  2094. .B \fB\-\-list\-options\fP
  2095. Prints all available options.
  2096. .TP
  2097. .B \fB\-\-list\-properties\fP
  2098. Print a list of the available properties.
  2099. .TP
  2100. .B \fB\-\-list\-protocols\fP
  2101. Print a list of the supported protocols.
  2102. .TP
  2103. .B \fB\-\-log\-file=<path>\fP
  2104. Opens the given path for writing, and print log messages to it. Existing
  2105. files will be truncated. The log level is at least \fB\-v \-v\fP, but
  2106. can be raised via \fB\-\-msg\-level\fP (the option cannot lower it below the
  2107. forced minimum log level).
  2108. .TP
  2109. .B \fB\-\-config\-dir=<path>\fP
  2110. Force a different configuration directory. If this is set, the given
  2111. directory is used to load configuration files, and all other configuration
  2112. directories are ignored. This means the global mpv configuration directory
  2113. as well as per\-user directories are ignored, and overrides through
  2114. environment variables (\fBMPV_HOME\fP) are also ignored.
  2115. .sp
  2116. Note that the \fB\-\-no\-config\fP option takes precedence over this option.
  2117. .TP
  2118. .B \fB\-\-save\-position\-on\-quit\fP
  2119. Always save the current playback position on quit. When this file is
  2120. played again later, the player will seek to the old playback position on
  2121. start. This does not happen if playback of a file is stopped in any other
  2122. way than quitting. For example, going to the next file in the playlist
  2123. will not save the position, and start playback at beginning the next time
  2124. the file is played.
  2125. .sp
  2126. This behavior is disabled by default, but is always available when quitting
  2127. the player with Shift+Q.
  2128. .TP
  2129. .B \fB\-\-watch\-later\-directory=<path>\fP
  2130. The directory in which to store the "watch later" temporary files.
  2131. .sp
  2132. The default is a subdirectory named "watch_later" underneath the
  2133. config directory (usually \fB~/.config/mpv/\fP).
  2134. .TP
  2135. .B \fB\-\-dump\-stats=<filename>\fP
  2136. Write certain statistics to the given file. The file is truncated on
  2137. opening. The file will contain raw samples, each with a timestamp. To
  2138. make this file into a readable, the script \fBTOOLS/stats\-conv.py\fP can be
  2139. used (which currently displays it as a graph).
  2140. .sp
  2141. This option is useful for debugging only.
  2142. .TP
  2143. .B \fB\-\-idle=<no|yes|once>\fP
  2144. Makes mpv wait idly instead of quitting when there is no file to play.
  2145. Mostly useful in input mode, where mpv can be controlled through input
  2146. commands. (Default: \fBno\fP)
  2147. .sp
  2148. \fBonce\fP will only idle at start and let the player close once the
  2149. first playlist has finished playing back.
  2150. .TP
  2151. .B \fB\-\-include=<configuration\-file>\fP
  2152. Specify configuration file to be parsed after the default ones.
  2153. .TP
  2154. .B \fB\-\-load\-scripts=<yes|no>\fP
  2155. If set to \fBno\fP, don\(aqt auto\-load scripts from the \fBscripts\fP
  2156. configuration subdirectory (usually \fB~/.config/mpv/scripts/\fP).
  2157. (Default: \fByes\fP)
  2158. .TP
  2159. .B \fB\-\-script=<filename>\fP, \fB\-\-scripts=file1.lua:file2.lua:...\fP
  2160. Load a Lua script. The second option allows you to load multiple scripts by
  2161. separating them with the path separator (\fB:\fP on Unix, \fB;\fP on Windows).
  2162. .sp
  2163. \fB\-\-scripts\fP is a path list option. See \fI\%List Options\fP for details.
  2164. .TP
  2165. .B \fB\-\-script\-opts=key1=value1,key2=value2,...\fP
  2166. Set options for scripts. A script can query an option by key. If an
  2167. option is used and what semantics the option value has depends entirely on
  2168. the loaded scripts. Values not claimed by any scripts are ignored.
  2169. .sp
  2170. This is a key/value list option. See \fI\%List Options\fP for details.
  2171. .TP
  2172. .B \fB\-\-merge\-files\fP
  2173. Pretend that all files passed to mpv are concatenated into a single, big
  2174. file. This uses timeline/EDL support internally.
  2175. .TP
  2176. .B \fB\-\-no\-resume\-playback\fP
  2177. Do not restore playback position from the \fBwatch_later\fP configuration
  2178. subdirectory (usually \fB~/.config/mpv/watch_later/\fP).
  2179. See \fBquit\-watch\-later\fP input command.
  2180. .TP
  2181. .B \fB\-\-resume\-playback\-check\-mtime\fP
  2182. Only restore the playback position from the \fBwatch_later\fP configuration
  2183. subdirectory (usually \fB~/.config/mpv/watch_later/\fP) if the file\(aqs
  2184. modification time is the same as at the time of saving. This may prevent
  2185. skipping forward in files with the same name which have different content.
  2186. (Default: \fBno\fP)
  2187. .TP
  2188. .B \fB\-\-profile=<profile1,profile2,...>\fP
  2189. Use the given profile(s), \fB\-\-profile=help\fP displays a list of the
  2190. defined profiles.
  2191. .TP
  2192. .B \fB\-\-reset\-on\-next\-file=<all|option1,option2,...>\fP
  2193. Normally, mpv will try to keep all settings when playing the next file on
  2194. the playlist, even if they were changed by the user during playback. (This
  2195. behavior is the opposite of MPlayer\(aqs, which tries to reset all settings
  2196. when starting next file.)
  2197. .sp
  2198. Default: Do not reset anything.
  2199. .sp
  2200. This can be changed with this option. It accepts a list of options, and
  2201. mpv will reset the value of these options on playback start to the initial
  2202. value. The initial value is either the default value, or as set by the
  2203. config file or command line.
  2204. .sp
  2205. In some cases, this might not work as expected. For example, \fB\-\-volume\fP
  2206. will only be reset if it is explicitly set in the config file or the
  2207. command line.
  2208. .sp
  2209. The special name \fBall\fP resets as many options as possible.
  2210. .sp
  2211. This is a string list option. See \fI\%List Options\fP for details.
  2212. .INDENT 7.0
  2213. .INDENT 3.5
  2214. .IP "Examples"
  2215. .INDENT 0.0
  2216. .IP \(bu 2
  2217. \fB\-\-reset\-on\-next\-file=pause\fP
  2218. Reset pause mode when switching to the next file.
  2219. .IP \(bu 2
  2220. \fB\-\-reset\-on\-next\-file=fullscreen,speed\fP
  2221. Reset fullscreen and playback speed settings if they were changed
  2222. during playback.
  2223. .IP \(bu 2
  2224. \fB\-\-reset\-on\-next\-file=all\fP
  2225. Try to reset all settings that were changed during playback.
  2226. .UNINDENT
  2227. .UNINDENT
  2228. .UNINDENT
  2229. .TP
  2230. .B \fB\-\-write\-filename\-in\-watch\-later\-config\fP
  2231. Prepend the watch later config files with the name of the file they refer
  2232. to. This is simply written as comment on the top of the file.
  2233. .sp
  2234. \fBWARNING:\fP
  2235. .INDENT 7.0
  2236. .INDENT 3.5
  2237. This option may expose privacy\-sensitive information and is thus
  2238. disabled by default.
  2239. .UNINDENT
  2240. .UNINDENT
  2241. .TP
  2242. .B \fB\-\-ignore\-path\-in\-watch\-later\-config\fP
  2243. Ignore path (i.e. use filename only) when using watch later feature.
  2244. (Default: disabled)
  2245. .TP
  2246. .B \fB\-\-show\-profile=<profile>\fP
  2247. Show the description and content of a profile. Lists all profiles if no
  2248. parameter is provided.
  2249. .TP
  2250. .B \fB\-\-use\-filedir\-conf\fP
  2251. Look for a file\-specific configuration file in the same directory as the
  2252. file that is being played. See \fI\%File\-specific Configuration Files\fP\&.
  2253. .sp
  2254. \fBWARNING:\fP
  2255. .INDENT 7.0
  2256. .INDENT 3.5
  2257. May be dangerous if playing from untrusted media.
  2258. .UNINDENT
  2259. .UNINDENT
  2260. .TP
  2261. .B \fB\-\-ytdl\fP, \fB\-\-no\-ytdl\fP
  2262. Enable the youtube\-dl hook\-script. It will look at the input URL, and will
  2263. play the video located on the website. This works with many streaming sites,
  2264. not just the one that the script is named after. This requires a recent
  2265. version of youtube\-dl to be installed on the system. (Enabled by default.)
  2266. .sp
  2267. If the script can\(aqt do anything with an URL, it will do nothing.
  2268. .sp
  2269. The \fBtry_ytdl_first\fP script option accepts a boolean \(aqyes\(aq or \(aqno\(aq, and if
  2270. \(aqyes\(aq will try parsing the URL with youtube\-dl first, instead of the default
  2271. where it\(aqs only after mpv failed to open it. This mostly depends on whether
  2272. most of your URLs need youtube\-dl parsing.
  2273. .sp
  2274. The \fBexclude\fP script option accepts a \fB|\fP\-separated list of URL patterns
  2275. which mpv should not use with youtube\-dl. The patterns are matched after
  2276. the \fBhttp(s)://\fP part of the URL.
  2277. .sp
  2278. \fB^\fP matches the beginning of the URL, \fB$\fP matches its end, and you
  2279. should use \fB%\fP before any of the characters \fB^$()%|,.[]*+\-?\fP to match
  2280. that character.
  2281. .INDENT 7.0
  2282. .INDENT 3.5
  2283. .IP "Examples"
  2284. .INDENT 0.0
  2285. .IP \(bu 2
  2286. \fB\-\-script\-opts=ytdl_hook\-exclude=\(aq^youtube%.com\(aq\fP
  2287. will exclude any URL that starts with \fBhttp://youtube.com\fP or
  2288. \fBhttps://youtube.com\fP\&.
  2289. .IP \(bu 2
  2290. \fB\-\-script\-opts=ytdl_hook\-exclude=\(aq%.mkv$|%.mp4$\(aq\fP
  2291. will exclude any URL that ends with \fB\&.mkv\fP or \fB\&.mp4\fP\&.
  2292. .UNINDENT
  2293. .UNINDENT
  2294. .UNINDENT
  2295. .sp
  2296. See more lua patterns here: \fI\%https://www.lua.org/manual/5.1/manual.html#5.4.1\fP
  2297. .sp
  2298. The \fBuse_manifests\fP script option makes mpv use the master manifest URL for
  2299. formats like HLS and DASH, if available, allowing for video/audio selection
  2300. in runtime. It\(aqs disabled ("no") by default for performance reasons.
  2301. .TP
  2302. .B \fB\-\-ytdl\-format=<best|worst|mp4|webm|...>\fP
  2303. Video format/quality that is directly passed to youtube\-dl. The possible
  2304. values are specific to the website and the video, for a given url the
  2305. available formats can be found with the command
  2306. \fByoutube\-dl \-\-list\-formats URL\fP\&. See youtube\-dl\(aqs documentation for
  2307. available aliases.
  2308. (Default: youtube\-dl\(aqs default, currently \fBbestvideo+bestaudio/best\fP)
  2309. .TP
  2310. .B \fB\-\-ytdl\-raw\-options=<key>=<value>[,<key>=<value>[,...]]\fP
  2311. Pass arbitrary options to youtube\-dl. Parameter and argument should be
  2312. passed as a key\-value pair. Options without argument must include \fB=\fP\&.
  2313. .sp
  2314. There is no sanity checking so it\(aqs possible to break things (i.e.
  2315. passing invalid parameters to youtube\-dl).
  2316. .sp
  2317. A proxy URL can be passed for youtube\-dl to use it in parsing the website.
  2318. This is useful for geo\-restricted URLs. After youtube\-dl parsing, some
  2319. URLs also require a proxy for playback, so this can pass that proxy
  2320. information to mpv. Take note that SOCKS proxies aren\(aqt supported and
  2321. https URLs also bypass the proxy. This is a limitation in FFmpeg.
  2322. .sp
  2323. This is a key/value list option. See \fI\%List Options\fP for details.
  2324. .INDENT 7.0
  2325. .INDENT 3.5
  2326. .IP "Example"
  2327. .INDENT 0.0
  2328. .IP \(bu 2
  2329. \fB\-\-ytdl\-raw\-options=username=user,password=pass\fP
  2330. .IP \(bu 2
  2331. \fB\-\-ytdl\-raw\-options=force\-ipv6=\fP
  2332. .IP \(bu 2
  2333. \fB\-\-ytdl\-raw\-options=proxy=[http://127.0.0.1:3128]\fP
  2334. .IP \(bu 2
  2335. \fB\-\-ytdl\-raw\-options\-append=proxy=http://127.0.0.1:3128\fP
  2336. .UNINDENT
  2337. .UNINDENT
  2338. .UNINDENT
  2339. .TP
  2340. .B \fB\-\-load\-stats\-overlay=<yes|no>\fP
  2341. Enable the builtin script that shows useful playback information on a key
  2342. binding (default: yes). By default, the \fBi\fP key is used (\fBI\fP to make
  2343. the overlay permanent).
  2344. .TP
  2345. .B \fB\-\-load\-osd\-console=<yes|no>\fP
  2346. Enable the builtin script that shows a console on a key binding and lets
  2347. you enter commands (default: yes). By default,. The \fB\'\fP key is used to
  2348. show the console, and \fBESC\fP to hide it again. (This is based on  a user
  2349. script called \fBrepl.lua\fP\&.)
  2350. .TP
  2351. .B \fB\-\-player\-operation\-mode=<cplayer|pseudo\-gui>\fP
  2352. For enabling "pseudo GUI mode", which means that the defaults for some
  2353. options are changed. This option should not normally be used directly, but
  2354. only by mpv internally, or mpv\-provided scripts, config files, or .desktop
  2355. files.
  2356. .UNINDENT
  2357. .SS Video
  2358. .INDENT 0.0
  2359. .TP
  2360. .B \fB\-\-vo=<driver>\fP
  2361. Specify the video output backend to be used. See \fI\%VIDEO OUTPUT DRIVERS\fP for
  2362. details and descriptions of available drivers.
  2363. .TP
  2364. .B \fB\-\-vd=<...>\fP
  2365. Specify a priority list of video decoders to be used, according to their
  2366. family and name. See \fB\-\-ad\fP for further details. Both of these options
  2367. use the same syntax and semantics; the only difference is that they
  2368. operate on different codec lists.
  2369. .sp
  2370. \fBNOTE:\fP
  2371. .INDENT 7.0
  2372. .INDENT 3.5
  2373. See \fB\-\-vd=help\fP for a full list of available decoders.
  2374. .UNINDENT
  2375. .UNINDENT
  2376. .TP
  2377. .B \fB\-\-vf=<filter1[=parameter1:parameter2:...],filter2,...>\fP
  2378. Specify a list of video filters to apply to the video stream. See
  2379. \fI\%VIDEO FILTERS\fP for details and descriptions of the available filters.
  2380. The option variants \fB\-\-vf\-add\fP, \fB\-\-vf\-pre\fP, \fB\-\-vf\-del\fP and
  2381. \fB\-\-vf\-clr\fP exist to modify a previously specified list, but you
  2382. should not need these for typical use.
  2383. .TP
  2384. .B \fB\-\-untimed\fP
  2385. Do not sleep when outputting video frames. Useful for benchmarks when used
  2386. with \fB\-\-no\-audio.\fP
  2387. .TP
  2388. .B \fB\-\-framedrop=<mode>\fP
  2389. Skip displaying some frames to maintain A/V sync on slow systems, or
  2390. playing high framerate video on video outputs that have an upper framerate
  2391. limit.
  2392. .sp
  2393. The argument selects the drop methods, and can be one of the following:
  2394. .INDENT 7.0
  2395. .TP
  2396. .B <no>
  2397. Disable any frame dropping. Not recommended, for testing only.
  2398. .TP
  2399. .B <vo>
  2400. Drop late frames on video output (default). This still decodes and
  2401. filters all frames, but doesn\(aqt render them on the VO. Drops are
  2402. indicated in the terminal status line as \fBDropped:\fP field.
  2403. .sp
  2404. In audio sync. mode, this drops frames that are outdated at the time of
  2405. display. If the decoder is too slow, in theory all frames would have to
  2406. be dropped (because all frames are too late) \- to avoid this, frame
  2407. dropping stops  if the effective framerate is below 10 FPS.
  2408. .sp
  2409. In display\-sync. modes (see \fB\-\-video\-sync\fP), this affects only how
  2410. A/V drops or repeats frames. If this mode is disabled, A/V desync will
  2411. in theory not affect video scheduling anymore (much like the
  2412. \fBdisplay\-resample\-desync\fP mode). However, even if disabled, frames
  2413. will still be skipped (i.e. dropped) according to the ratio between
  2414. video and display frequencies.
  2415. .sp
  2416. This is the recommended mode, and the default.
  2417. .TP
  2418. .B <decoder>
  2419. Old, decoder\-based framedrop mode. (This is the same as \fB\-\-framedrop=yes\fP
  2420. in mpv 0.5.x and before.) This tells the decoder to skip frames (unless
  2421. they are needed to decode future frames). May help with slow systems,
  2422. but can produce unwatchable choppy output, or even freeze the display
  2423. completely.
  2424. .sp
  2425. This uses a heuristic which may not make sense, and in  general cannot
  2426. achieve good results, because the decoder\(aqs frame dropping cannot be
  2427. controlled in a predictable manner. Not recommended.
  2428. .sp
  2429. Even if you want to use this, prefer \fBdecoder+vo\fP for better results.
  2430. .sp
  2431. The \fB\-\-vd\-lavc\-framedrop\fP option controls what frames to drop.
  2432. .TP
  2433. .B <decoder+vo>
  2434. Enable both modes. Not recommended. Better than just \fBdecoder\fP mode.
  2435. .UNINDENT
  2436. .sp
  2437. \fBNOTE:\fP
  2438. .INDENT 7.0
  2439. .INDENT 3.5
  2440. \fB\-\-vo=vdpau\fP has its own code for the \fBvo\fP framedrop mode. Slight
  2441. differences to other VOs are possible.
  2442. .UNINDENT
  2443. .UNINDENT
  2444. .TP
  2445. .B \fB\-\-video\-latency\-hacks=<yes|no>\fP
  2446. Enable some things which tend to reduce video latency by 1 or 2 frames
  2447. (default: no). Note that this option might be removed without notice once
  2448. the player\(aqs timing code does not inherently need to do these things
  2449. anymore.
  2450. .sp
  2451. This does:
  2452. .INDENT 7.0
  2453. .IP \(bu 2
  2454. Use the demuxer reported FPS for frame dropping. This avoids that the
  2455. player needs to decode 1 frame in advance, lowering total latency in
  2456. effect. This also means that if the demuxer reported FPS is wrong, or
  2457. the video filter chain changes FPS (e.g. deinterlacing), then it could
  2458. drop too many or not enough frames.
  2459. .IP \(bu 2
  2460. Disable waiting for the first video frame. Normally the player waits for
  2461. the first video frame to be fully rendered before starting playback
  2462. properly. Some VOs will lazily initialize stuff when rendering the first
  2463. frame, so if this is not done, there is some likeliness that the VO has
  2464. to drop some frames if rendering the first frame takes longer than needed.
  2465. .UNINDENT
  2466. .TP
  2467. .B \fB\-\-override\-display\-fps=<fps>\fP
  2468. Set the display FPS used with the \fB\-\-video\-sync=display\-*\fP modes. By
  2469. default, a detected value is used. Keep in mind that setting an incorrect
  2470. value (even if slightly incorrect) can ruin video playback. On multi\-monitor
  2471. systems, there is a chance that the detected value is from the wrong
  2472. monitor.
  2473. .sp
  2474. Set this option only if you have reason to believe the automatically
  2475. determined value is wrong.
  2476. .TP
  2477. .B \fB\-\-display\-fps=<fps>\fP
  2478. Deprecated alias for \fB\-\-override\-display\-fps\fP\&.
  2479. .TP
  2480. .B \fB\-\-hwdec=<api>\fP
  2481. Specify the hardware video decoding API that should be used if possible.
  2482. Whether hardware decoding is actually done depends on the video codec. If
  2483. hardware decoding is not possible, mpv will fall back on software decoding.
  2484. .sp
  2485. Hardware decoding is not enabled by default, because it is typically an
  2486. additional source of errors. It is worth using only if your CPU is too
  2487. slow to decode a specific video.
  2488. .sp
  2489. \fBNOTE:\fP
  2490. .INDENT 7.0
  2491. .INDENT 3.5
  2492. Use the \fBCtrl+h\fP shortcut to toggle hardware decoding at runtime. It
  2493. toggles this option between \fBauto\fP and \fBno\fP\&.
  2494. .sp
  2495. Always enabling HW decoding by putting it into the config file is
  2496. discouraged. If you use the Ubuntu package, delete \fB/etc/mpv/mpv.conf\fP,
  2497. as the package tries to enable HW decoding by default by setting
  2498. \fBhwdec=vaapi\fP (which is less than ideal, and may even cause
  2499. sub\-optimal wrappers to be used). Or at least change it to
  2500. \fBhwdec=auto\-safe\fP\&.
  2501. .UNINDENT
  2502. .UNINDENT
  2503. .sp
  2504. Use one of the auto modes if you want to enable hardware decoding.
  2505. Explicitly selecting the mode is mostly meant for testing and debugging.
  2506. It\(aqs a bad idea to put explicit selection into the config file if you
  2507. want thing to just keep working after updates and so on.
  2508. .sp
  2509. \fBNOTE:\fP
  2510. .INDENT 7.0
  2511. .INDENT 3.5
  2512. Even if enabled, hardware decoding is still only white\-listed for some
  2513. codecs. See \fB\-\-hwdec\-codecs\fP to enable hardware decoding in more cases.
  2514. .UNINDENT
  2515. .UNINDENT
  2516. .INDENT 7.0
  2517. .INDENT 3.5
  2518. .IP "Which method to choose?"
  2519. .INDENT 0.0
  2520. .IP \(bu 2
  2521. If you only want to enable hardware decoding at runtime, don\(aqt set the
  2522. parameter, or put \fBhwdec=no\fP into your \fBmpv.conf\fP (relevant on
  2523. distros which force\-enable it by default, such as on Ubuntu). Use the
  2524. \fBCtrl+h\fP default binding to enable it at runtime.
  2525. .IP \(bu 2
  2526. If you\(aqre not sure, but want hardware decoding always enabled by
  2527. default, put \fBhwdec=auto\-safe\fP into your \fBmpv.conf\fP, and
  2528. acknowledge that this use case is not "really" supported and may cause
  2529. problems.
  2530. .IP \(bu 2
  2531. If you want to test available hardware decoding methods, pass
  2532. \fB\-\-hwdec=auto \-\-hwdec\-codecs=all\fP and look at the terminal output.
  2533. .IP \(bu 2
  2534. If you\(aqre a developer, or want to perform elaborate tests, you may
  2535. need any of the other possible option values.
  2536. .UNINDENT
  2537. .UNINDENT
  2538. .UNINDENT
  2539. .sp
  2540. \fB<api>\fP can be one of the following:
  2541. .INDENT 7.0
  2542. .TP
  2543. .B no
  2544. always use software decoding (default)
  2545. .TP
  2546. .B auto
  2547. forcibly enable any hw decoder found (see below)
  2548. .TP
  2549. .B yes
  2550. exactly the same as \fBauto\fP
  2551. .TP
  2552. .B auto\-safe
  2553. enable any whitelisted hw decoder (see below)
  2554. .TP
  2555. .B auto\-copy
  2556. enable best hw decoder with copy\-back (see below)
  2557. .TP
  2558. .B vdpau
  2559. requires \fB\-\-vo=gpu\fP with X11, or \fB\-\-vo=vdpau\fP (Linux only)
  2560. .TP
  2561. .B vdpau\-copy
  2562. copies video back into system RAM (Linux with some GPUs only)
  2563. .TP
  2564. .B vaapi
  2565. requires \fB\-\-vo=gpu\fP or \fB\-\-vo=vaapi\fP (Linux only)
  2566. .TP
  2567. .B vaapi\-copy
  2568. copies video back into system RAM (Linux with some GPUs only)
  2569. .TP
  2570. .B videotoolbox
  2571. requires \fB\-\-vo=gpu\fP (OS X 10.8 and up),
  2572. or \fB\-\-vo=libmpv\fP (iOS 9.0 and up)
  2573. .TP
  2574. .B videotoolbox\-copy
  2575. copies video back into system RAM (OS X 10.8 or iOS 9.0 and up)
  2576. .TP
  2577. .B dxva2
  2578. requires \fB\-\-vo=gpu\fP with \fB\-\-gpu\-context=d3d11\fP,
  2579. \fB\-\-gpu\-context=angle\fP or \fB\-\-gpu\-context=dxinterop\fP
  2580. (Windows only)
  2581. .TP
  2582. .B dxva2\-copy
  2583. copies video back to system RAM (Windows only)
  2584. .TP
  2585. .B d3d11va
  2586. requires \fB\-\-vo=gpu\fP with \fB\-\-gpu\-context=d3d11\fP or
  2587. \fB\-\-gpu\-context=angle\fP (Windows 8+ only)
  2588. .TP
  2589. .B d3d11va\-copy
  2590. copies video back to system RAM (Windows 8+ only)
  2591. .TP
  2592. .B mediacodec
  2593. requires \fB\-\-vo=mediacodec_embed\fP (Android only)
  2594. .TP
  2595. .B mediacodec\-copy
  2596. copies video back to system RAM (Android only)
  2597. .TP
  2598. .B mmal
  2599. requires \fB\-\-vo=gpu\fP (Raspberry Pi only \- default if available)
  2600. .TP
  2601. .B mmal\-copy
  2602. copies video back to system RAM (Raspberry Pi only)
  2603. .TP
  2604. .B nvdec
  2605. requires \fB\-\-vo=gpu\fP (Any platform CUDA is available)
  2606. .TP
  2607. .B nvdec\-copy
  2608. copies video back to system RAM (Any platform CUDA is available)
  2609. .TP
  2610. .B cuda
  2611. requires \fB\-\-vo=gpu\fP (Any platform CUDA is available)
  2612. .TP
  2613. .B cuda\-copy
  2614. copies video back to system RAM (Any platform CUDA is available)
  2615. .TP
  2616. .B crystalhd
  2617. copies video back to system RAM (Any platform supported by hardware)
  2618. .TP
  2619. .B rkmpp
  2620. requires \fB\-\-vo=gpu\fP (some RockChip devices only)
  2621. .UNINDENT
  2622. .sp
  2623. \fBauto\fP tries to automatically enable hardware decoding using the first
  2624. available method. This still depends what VO you are using. For example,
  2625. if you are not using \fB\-\-vo=gpu\fP or \fB\-\-vo=vdpau\fP, vdpau decoding will
  2626. never be enabled. Also note that if the first found method doesn\(aqt actually
  2627. work, it will always fall back to software decoding, instead of trying the
  2628. next method (might matter on some Linux systems).
  2629. .sp
  2630. \fBauto\-safe\fP is similar to \fBauto\fP, but allows only whitelisted methods
  2631. that are considered "safe". This is supposed to be a reasonable way to
  2632. enable hardware decdoding by default in a config file (even though you
  2633. shouldn\(aqt do that anyway; prefer runtime enabling with \fBCtrl+h\fP). Unlike
  2634. \fBauto\fP, this will not try to enable unknown or known\-to\-be\-bad methods. In
  2635. addition, this may disable hardware decoding in other situations when it\(aqs
  2636. known to cause problems, but currently this mechanism is quite primitive.
  2637. (As an example for something that still causes problems: certain
  2638. combinations of HEVC and Intel chips on Windows tend to cause mpv to crash,
  2639. most likely due to driver bugs.)
  2640. .sp
  2641. \fBauto\-copy\-safe\fP selects the union of methods selected with \fBauto\-safe\fP
  2642. and \fBauto\-copy\fP\&.
  2643. .sp
  2644. \fBauto\-copy\fP selects only modes that copy the video data back to system
  2645. memory after decoding. This selects modes like \fBvaapi\-copy\fP (and so on).
  2646. If none of these work, hardware decoding is disabled. This mode is usually
  2647. guaranteed to incur no additional quality loss compared to software
  2648. decoding (assuming modern codecs and an error free video stream), and will
  2649. allow CPU processing with video filters. This mode works with all video
  2650. filters and VOs.
  2651. .sp
  2652. Because these copy the decoded video back to system RAM, they\(aqre often less
  2653. efficient than the direct modes, and may not help too much over software
  2654. decoding.
  2655. .sp
  2656. \fBNOTE:\fP
  2657. .INDENT 7.0
  2658. .INDENT 3.5
  2659. Most non\-copy methods only work with the OpenGL GPU backend. Currently,
  2660. only the \fBvaapi\fP, \fBnvdec\fP and \fBcuda\fP methods work with Vulkan.
  2661. .UNINDENT
  2662. .UNINDENT
  2663. .sp
  2664. The \fBvaapi\fP mode, if used with \fB\-\-vo=gpu\fP, requires Mesa 11, and most
  2665. likely works with Intel and AMD GPUs only. It also requires the opengl EGL
  2666. backend.
  2667. .sp
  2668. \fBnvdec\fP and \fBnvdec\-copy\fP are the newest, and recommended method to do
  2669. hardware decoding on Nvidia GPUs.
  2670. .sp
  2671. \fBcuda\fP and \fBcuda\-copy\fP are an older implementation of hardware decoding
  2672. on Nvidia GPUs that uses Nvidia\(aqs bitstream parsers rather than FFmpeg\(aqs.
  2673. This can lead to feature deficiencies, such as incorrect playback of HDR
  2674. content, and \fBnvdec\fP/\fBnvdec\-copy\fP should always be preferred unless you
  2675. specifically need Nvidia\(aqs deinterlacing algorithms. To use this
  2676. deinterlacing you must pass the option:
  2677. \fBvd\-lavc\-o=deint=[weave|bob|adaptive]\fP\&.
  2678. Pass \fBweave\fP (or leave the option unset) to not attempt any
  2679. deinterlacing.
  2680. .INDENT 7.0
  2681. .INDENT 3.5
  2682. .IP "Quality reduction with hardware decoding"
  2683. .sp
  2684. In theory, hardware decoding does not reduce video quality (at least
  2685. for the codecs h264 and HEVC). However, due to restrictions in video
  2686. output APIs, as well as bugs in the actual hardware decoders, there can
  2687. be some loss, or even blatantly incorrect results.
  2688. .sp
  2689. In some cases, RGB conversion is forced, which means the RGB conversion
  2690. is performed by the hardware decoding API, instead of the shaders
  2691. used by \fB\-\-vo=gpu\fP\&. This means certain colorspaces may not display
  2692. correctly, and certain filtering (such as debanding) cannot be applied
  2693. in an ideal way. This will also usually force the use of low quality
  2694. chroma scalers instead of the one specified by \fB\-\-cscale\fP\&. In other
  2695. cases, hardware decoding can also reduce the bit depth of the decoded
  2696. image, which can introduce banding or precision loss for 10\-bit files.
  2697. .sp
  2698. \fBvdpau\fP always does RGB conversion in hardware, which does not
  2699. support newer colorspaces like BT.2020 correctly. However, \fBvdpau\fP
  2700. doesn\(aqt support 10 bit or HDR encodings, so these limitations are
  2701. unlikely to be relevant.
  2702. .sp
  2703. \fBvaapi\fP and \fBd3d11va\fP are safe. Enabling deinterlacing (or simply
  2704. their respective post\-processing filters) will possibly at least reduce
  2705. color quality by converting the output to a 8 bit format.
  2706. .sp
  2707. \fBdxva2\fP is not safe. It appears to always use BT.601 for forced RGB
  2708. conversion, but actual behavior depends on the GPU drivers. Some drivers
  2709. appear to convert to limited range RGB, which gives a faded appearance.
  2710. In addition to driver\-specific behavior, global system settings might
  2711. affect this additionally. This can give incorrect results even with
  2712. completely ordinary video sources.
  2713. .sp
  2714. \fBrpi\fP always uses the hardware overlay renderer, even with
  2715. \fB\-\-vo=gpu\fP\&.
  2716. .sp
  2717. \fBcuda\fP should usually be safe, but depending on how a file/stream
  2718. has been mixed, it has been reported to corrupt the timestamps causing
  2719. glitched, flashing frames. It can also sometimes cause massive
  2720. framedrops for unknown reasons. Caution is advised, and \fBnvdec\fP
  2721. should always be preferred.
  2722. .sp
  2723. \fBcrystalhd\fP is not safe. It always converts to 4:2:2 YUV, which
  2724. may be lossy, depending on how chroma sub\-sampling is done during
  2725. conversion. It also discards the top left pixel of each frame for
  2726. some reason.
  2727. .sp
  2728. All other methods, in particular the copy\-back methods (like
  2729. \fBdxva2\-copy\fP etc.) should hopefully be safe, although they can still
  2730. cause random decoding issues. At the very least, they shouldn\(aqt affect
  2731. the colors of the image.
  2732. .sp
  2733. In particular, \fBauto\-copy\fP will only select "safe" modes
  2734. (although potentially slower than other methods), but there\(aqs still no
  2735. guarantee the chosen hardware decoder will actually work correctly.
  2736. .sp
  2737. In general, it\(aqs very strongly advised to avoid hardware decoding
  2738. unless \fBabsolutely\fP necessary, i.e. if your CPU is insufficient to
  2739. decode the file in questions. If you run into any weird decoding issues,
  2740. frame glitches or discoloration, and you have \fB\-\-hwdec\fP turned on,
  2741. the first thing you should try is disabling it.
  2742. .UNINDENT
  2743. .UNINDENT
  2744. .TP
  2745. .B \fB\-\-gpu\-hwdec\-interop=<auto|all|no|name>\fP
  2746. This option is for troubleshooting hwdec interop issues. Since it\(aqs a
  2747. debugging option, its semantics may change at any time.
  2748. .sp
  2749. This is useful for the \fBgpu\fP and \fBlibmpv\fP VOs for selecting which
  2750. hwdec interop context to use exactly. Effectively it also can be used
  2751. to block loading of certain backends.
  2752. .sp
  2753. If set to \fBauto\fP (default), the behavior depends on the VO: for \fBgpu\fP,
  2754. it does nothing, and the interop context is loaded on demand (when the
  2755. decoder probes for \fB\-\-hwdec\fP support). For \fBlibmpv\fP, which has
  2756. has no on\-demand loading, this is equivalent to \fBall\fP\&.
  2757. .sp
  2758. The empty string is equivalent to \fBauto\fP\&.
  2759. .sp
  2760. If set to \fBall\fP, it attempts to load all interop contexts at GL context
  2761. creation time.
  2762. .sp
  2763. Other than that, a specific backend can be set, and the list of them can
  2764. be queried with \fBhelp\fP (mpv CLI only).
  2765. .sp
  2766. Runtime changes to this are ignored (the current option value is used
  2767. whenever the renderer is created).
  2768. .sp
  2769. The old aliases \fB\-\-opengl\-hwdec\-interop\fP and \fB\-\-hwdec\-preload\fP are
  2770. barely related to this anymore, but will be somewhat compatible in some
  2771. cases.
  2772. .TP
  2773. .B \fB\-\-hwdec\-extra\-frames=<N>\fP
  2774. Number of GPU frames hardware decoding should preallocate (default: see
  2775. \fB\-\-list\-options\fP output). If this is too low, frame allocation may fail
  2776. during decoding, and video frames might get dropped and/or corrupted.
  2777. Setting it too high simply wastes GPU memory and has no advantages.
  2778. .sp
  2779. This value is used only for hardware decoding APIs which require
  2780. preallocating surfaces (known examples include \fBd3d11va\fP and \fBvaapi\fP).
  2781. For other APIs, frames are allocated as needed. The details depend on the
  2782. libavcodec implementations of the hardware decoders.
  2783. .sp
  2784. The required number of surfaces depends on dynamic runtime situations. The
  2785. default is a fixed value that is thought to be sufficient for most uses. But
  2786. in certain situations, it may not be enough.
  2787. .TP
  2788. .B \fB\-\-hwdec\-image\-format=<name>\fP
  2789. Set the internal pixel format used by hardware decoding via \fB\-\-hwdec\fP
  2790. (default \fBno\fP). The special value \fBno\fP selects an implementation
  2791. specific standard format. Most decoder implementations support only one
  2792. format, and will fail to initialize if the format is not supported.
  2793. .sp
  2794. Some implementations might support multiple formats. In particular,
  2795. videotoolbox is known to require \fBuyvy422\fP for good performance on some
  2796. older hardware. d3d11va can always use \fByuv420p\fP, which uses an opaque
  2797. format, with likely no advantages.
  2798. .TP
  2799. .B \fB\-\-cuda\-decode\-device=<auto|0..>\fP
  2800. Choose the GPU device used for decoding when using the \fBcuda\fP or
  2801. \fBnvdec\fP hwdecs with the OpenGL GPU backend, and with the \fBcuda\-copy\fP
  2802. or \fBnvdec\-copy\fP hwdecs in all cases.
  2803. .sp
  2804. For the OpenGL GPU backend, the default device used for decoding is the one
  2805. being used to provide \fBgpu\fP output (and in the vast majority of cases,
  2806. only one GPU will be present).
  2807. .sp
  2808. For the \fBcopy\fP hwdecs, the default device will be the first device
  2809. enumerated by the CUDA libraries \- however that is done.
  2810. .sp
  2811. For the Vulkan GPU backend, decoding must always happen on the display
  2812. device, and this option has no effect.
  2813. .TP
  2814. .B \fB\-\-vaapi\-device=<device file>\fP
  2815. Choose the DRM device for \fBvaapi\-copy\fP\&. This should be the path to a
  2816. DRM device file. (Default: \fB/dev/dri/renderD128\fP)
  2817. .TP
  2818. .B \fB\-\-panscan=<0.0\-1.0>\fP
  2819. Enables pan\-and\-scan functionality (cropping the sides of e.g. a 16:9
  2820. video to make it fit a 4:3 display without black bands). The range
  2821. controls how much of the image is cropped. May not work with all video
  2822. output drivers.
  2823. .sp
  2824. This option has no effect if \fB\-\-video\-unscaled\fP option is used.
  2825. .TP
  2826. .B \fB\-\-video\-aspect\-override=<ratio|no>\fP
  2827. Override video aspect ratio, in case aspect information is incorrect or
  2828. missing in the file being played.
  2829. .sp
  2830. These values have special meaning:
  2831. .INDENT 7.0
  2832. .TP
  2833. .B 0
  2834. disable aspect ratio handling, pretend the video has square pixels
  2835. .TP
  2836. .B no
  2837. same as \fB0\fP
  2838. .TP
  2839. .B \-1
  2840. use the video stream or container aspect (default)
  2841. .UNINDENT
  2842. .sp
  2843. But note that handling of these special values might change in the future.
  2844. .INDENT 7.0
  2845. .INDENT 3.5
  2846. .IP "Examples"
  2847. .INDENT 0.0
  2848. .IP \(bu 2
  2849. \fB\-\-video\-aspect\-override=4:3\fP  or \fB\-\-video\-aspect\-override=1.3333\fP
  2850. .IP \(bu 2
  2851. \fB\-\-video\-aspect\-override=16:9\fP or \fB\-\-video\-aspect\-override=1.7777\fP
  2852. .IP \(bu 2
  2853. \fB\-\-no\-video\-aspect\-override\fP or \fB\-\-video\-aspect\-override=no\fP
  2854. .UNINDENT
  2855. .UNINDENT
  2856. .UNINDENT
  2857. .TP
  2858. .B \fB\-\-video\-aspect\-method=<bitstream|container>\fP
  2859. This sets the default video aspect determination method (if the aspect is
  2860. _not_ overridden by the user with \fB\-\-video\-aspect\-override\fP or others).
  2861. .INDENT 7.0
  2862. .TP
  2863. .B container
  2864. Strictly prefer the container aspect ratio. This is apparently
  2865. the default behavior with VLC, at least with Matroska. Note that
  2866. if the container has no aspect ratio set, the behavior is the
  2867. same as with bitstream.
  2868. .TP
  2869. .B bitstream
  2870. Strictly prefer the bitstream aspect ratio, unless the bitstream
  2871. aspect ratio is not set. This is apparently the default behavior
  2872. with XBMC/kodi, at least with Matroska.
  2873. .UNINDENT
  2874. .sp
  2875. The current default for mpv is \fBcontainer\fP\&.
  2876. .sp
  2877. Normally you should not set this. Try the various choices if you encounter
  2878. video that has the wrong aspect ratio in mpv, but seems to be correct in
  2879. other players.
  2880. .TP
  2881. .B \fB\-\-video\-unscaled=<no|yes|downscale\-big>\fP
  2882. Disable scaling of the video. If the window is larger than the video,
  2883. black bars are added. Otherwise, the video is cropped, unless the option
  2884. is set to \fBdownscale\-big\fP, in which case the video is fit to window. The
  2885. video still can be influenced by the other \fB\-\-video\-...\fP options. This
  2886. option disables the effect of \fB\-\-panscan\fP\&.
  2887. .sp
  2888. Note that the scaler algorithm may still be used, even if the video isn\(aqt
  2889. scaled. For example, this can influence chroma conversion. The video will
  2890. also still be scaled in one dimension if the source uses non\-square pixels
  2891. (e.g. anamorphic widescreen DVDs).
  2892. .sp
  2893. This option is disabled if the \fB\-\-no\-keepaspect\fP option is used.
  2894. .TP
  2895. .B \fB\-\-video\-pan\-x=<value>\fP, \fB\-\-video\-pan\-y=<value>\fP
  2896. Moves the displayed video rectangle by the given value in the X or Y
  2897. direction. The unit is in fractions of the size of the scaled video (the
  2898. full size, even if parts of the video are not visible due to panscan or
  2899. other options).
  2900. .sp
  2901. For example, displaying a 1280x720 video fullscreen on a 1680x1050 screen
  2902. with \fB\-\-video\-pan\-x=\-0.1\fP would move the video 168 pixels to the left
  2903. (making 128 pixels of the source video invisible).
  2904. .sp
  2905. This option is disabled if the \fB\-\-no\-keepaspect\fP option is used.
  2906. .TP
  2907. .B \fB\-\-video\-rotate=<0\-359|no>\fP
  2908. Rotate the video clockwise, in degrees. Currently supports 90° steps only.
  2909. If \fBno\fP is given, the video is never rotated, even if the file has
  2910. rotation metadata. (The rotation value is added to the rotation metadata,
  2911. which means the value \fB0\fP would rotate the video according to the
  2912. rotation metadata.)
  2913. .TP
  2914. .B \fB\-\-video\-zoom=<value>\fP
  2915. Adjust the video display scale factor by the given value. The parameter is
  2916. given log 2. For example, \fB\-\-video\-zoom=0\fP is unscaled,
  2917. \fB\-\-video\-zoom=1\fP is twice the size, \fB\-\-video\-zoom=\-2\fP is one fourth of
  2918. the size, and so on.
  2919. .sp
  2920. This option is disabled if the \fB\-\-no\-keepaspect\fP option is used.
  2921. .TP
  2922. .B \fB\-\-video\-align\-x=<\-1\-1>\fP, \fB\-\-video\-align\-y=<\-1\-1>\fP
  2923. Moves the video rectangle within the black borders, which are usually added
  2924. to pad the video to screen if video and screen aspect ratios are different.
  2925. \fB\-\-video\-align\-y=\-1\fP would move the video to the top of the screen
  2926. (leaving a border only on the bottom), a value of \fB0\fP centers it
  2927. (default), and a value of \fB1\fP would put the video at the bottom of the
  2928. screen.
  2929. .sp
  2930. If video and screen aspect match perfectly, these options do nothing.
  2931. .sp
  2932. This option is disabled if the \fB\-\-no\-keepaspect\fP option is used.
  2933. .TP
  2934. .B \fB\-\-video\-margin\-ratio\-left=<val>\fP, \fB\-\-video\-margin\-ratio\-right=<val>\fP, \fB\-\-video\-margin\-ratio\-top=<val>\fP, \fB\-\-video\-margin\-ratio\-bottom=<val>\fP
  2935. Set extra video margins on each border (default: 0). Each value is a ratio
  2936. of the window size, using a range 0.0\-1.0. For example, setting the option
  2937. \fB\-\-video\-margin\-ratio\-right=0.2\fP at a window size of 1000 pixels will add
  2938. a 200 pixels border on the right side of the window.
  2939. .sp
  2940. The video is "boxed" by these margins. The window size is not changed. In
  2941. particular it does not enlarge the window, and the margins will cause the
  2942. video to be downscaled by default. This may or may not change in the future.
  2943. .sp
  2944. The margins are applied after 90° video rotation, but before any other video
  2945. transformations.
  2946. .sp
  2947. This option is disabled if the \fB\-\-no\-keepaspect\fP option is used.
  2948. .sp
  2949. Subtitles still may use the margins, depending on \fB\-\-sub\-use\-margins\fP and
  2950. similar options.
  2951. .sp
  2952. These options were created for the OSC. Some odd decisions, such as making
  2953. the margin values a ratio (instead of pixels), were made for the sake of
  2954. the OSC. It\(aqs possible that these options may be replaced by ones that are
  2955. more generally useful. The behavior of these options may change to fit
  2956. OSC requirements better, too.
  2957. .TP
  2958. .B \fB\-\-correct\-pts\fP, \fB\-\-no\-correct\-pts\fP
  2959. \fB\-\-no\-correct\-pts\fP switches mpv to a mode where video timing is
  2960. determined using a fixed framerate value (either using the \fB\-\-fps\fP
  2961. option, or using file information). Sometimes, files with very broken
  2962. timestamps can be played somewhat well in this mode. Note that video
  2963. filters, subtitle rendering, seeking (including hr\-seeks and backstepping),
  2964. and audio synchronization can be completely broken in this mode.
  2965. .TP
  2966. .B \fB\-\-fps=<float>\fP
  2967. Override video framerate. Useful if the original value is wrong or missing.
  2968. .sp
  2969. \fBNOTE:\fP
  2970. .INDENT 7.0
  2971. .INDENT 3.5
  2972. Works in \fB\-\-no\-correct\-pts\fP mode only.
  2973. .UNINDENT
  2974. .UNINDENT
  2975. .TP
  2976. .B \fB\-\-deinterlace=<yes|no>\fP
  2977. Enable or disable interlacing (default: no).
  2978. Interlaced video shows ugly comb\-like artifacts, which are visible on
  2979. fast movement. Enabling this typically inserts the yadif video filter in
  2980. order to deinterlace the video, or lets the video output apply deinterlacing
  2981. if supported.
  2982. .sp
  2983. This behaves exactly like the \fBdeinterlace\fP input property (usually
  2984. mapped to \fBd\fP).
  2985. .sp
  2986. Keep in mind that this \fBwill\fP conflict with manually inserted
  2987. deinterlacing filters, unless you take care. (Since mpv 0.27.0, even the
  2988. hardware deinterlace filters will conflict. Also since that version,
  2989. \fB\-\-deinterlace=auto\fP was removed, which used to mean that the default
  2990. interlacing option of possibly inserted video filters was used.)
  2991. .sp
  2992. Note that this will make video look worse if it\(aqs not actually interlaced.
  2993. .TP
  2994. .B \fB\-\-frames=<number>\fP
  2995. Play/convert only first \fB<number>\fP video frames, then quit.
  2996. .sp
  2997. \fB\-\-frames=0\fP loads the file, but immediately quits before initializing
  2998. playback. (Might be useful for scripts which just want to determine some
  2999. file properties.)
  3000. .sp
  3001. For audio\-only playback, any value greater than 0 will quit playback
  3002. immediately after initialization. The value 0 works as with video.
  3003. .TP
  3004. .B \fB\-\-video\-output\-levels=<outputlevels>\fP
  3005. RGB color levels used with YUV to RGB conversion. Normally, output devices
  3006. such as PC monitors use full range color levels. However, some TVs and
  3007. video monitors expect studio RGB levels. Providing full range output to a
  3008. device expecting studio level input results in crushed blacks and whites,
  3009. the reverse in dim gray blacks and dim whites.
  3010. .sp
  3011. Not all VOs support this option. Some will silently ignore it.
  3012. .sp
  3013. Available color ranges are:
  3014. .INDENT 7.0
  3015. .TP
  3016. .B auto
  3017. automatic selection (equals to full range) (default)
  3018. .TP
  3019. .B limited
  3020. limited range (16\-235 per component), studio levels
  3021. .TP
  3022. .B full
  3023. full range (0\-255 per component), PC levels
  3024. .UNINDENT
  3025. .sp
  3026. \fBNOTE:\fP
  3027. .INDENT 7.0
  3028. .INDENT 3.5
  3029. It is advisable to use your graphics driver\(aqs color range option
  3030. instead, if available.
  3031. .UNINDENT
  3032. .UNINDENT
  3033. .TP
  3034. .B \fB\-\-hwdec\-codecs=<codec1,codec2,...|all>\fP
  3035. Allow hardware decoding for a given list of codecs only. The special value
  3036. \fBall\fP always allows all codecs.
  3037. .sp
  3038. You can get the list of allowed codecs with \fBmpv \-\-vd=help\fP\&. Remove the
  3039. prefix, e.g. instead of \fBlavc:h264\fP use \fBh264\fP\&.
  3040. .sp
  3041. By default, this is set to \fBh264,vc1,hevc,vp9\fP\&. Note that
  3042. the hardware acceleration special codecs like \fBh264_vdpau\fP are not
  3043. relevant anymore, and in fact have been removed from Libav in this form.
  3044. .sp
  3045. This is usually only needed with broken GPUs, where a codec is reported
  3046. as supported, but decoding causes more problems than it solves.
  3047. .INDENT 7.0
  3048. .INDENT 3.5
  3049. .IP "Example"
  3050. .INDENT 0.0
  3051. .TP
  3052. .B \fBmpv \-\-hwdec=vdpau \-\-vo=vdpau \-\-hwdec\-codecs=h264,mpeg2video\fP
  3053. Enable vdpau decoding for h264 and mpeg2 only.
  3054. .UNINDENT
  3055. .UNINDENT
  3056. .UNINDENT
  3057. .TP
  3058. .B \fB\-\-vd\-lavc\-check\-hw\-profile=<yes|no>\fP
  3059. Check hardware decoder profile (default: yes). If \fBno\fP is set, the
  3060. highest profile of the hardware decoder is unconditionally selected, and
  3061. decoding is forced even if the profile of the video is higher than that.
  3062. The result is most likely broken decoding, but may also help if the
  3063. detected or reported profiles are somehow incorrect.
  3064. .TP
  3065. .B \fB\-\-vd\-lavc\-software\-fallback=<yes|no|N>\fP
  3066. Fallback to software decoding if the hardware\-accelerated decoder fails
  3067. (default: 3). If this is a number, then fallback will be triggered if
  3068. N frames fail to decode in a row. 1 is equivalent to \fByes\fP\&.
  3069. .sp
  3070. Setting this to a higher number might break the playback start fallback: if
  3071. a fallback happens, parts of the file will be skipped, approximately by to
  3072. the number of packets that could not be decoded. Values below an unspecified
  3073. count will not have this problem, because mpv retains the packets.
  3074. .TP
  3075. .B \fB\-\-vd\-lavc\-dr=<yes|no>\fP
  3076. Enable direct rendering (default: yes). If this is set to \fByes\fP, the
  3077. video will be decoded directly to GPU video memory (or staging buffers).
  3078. This can speed up video upload, and may help with large resolutions or
  3079. slow hardware. This works only with the following VOs:
  3080. .INDENT 7.0
  3081. .INDENT 3.5
  3082. .INDENT 0.0
  3083. .IP \(bu 2
  3084. \fBgpu\fP: requires at least OpenGL 4.4 or Vulkan.
  3085. .UNINDENT
  3086. .UNINDENT
  3087. .UNINDENT
  3088. .sp
  3089. (In particular, this can\(aqt be made work with \fBopengl\-cb\fP, but the libmpv
  3090. render API has optional support.)
  3091. .sp
  3092. Using video filters of any kind that write to the image data (or output
  3093. newly allocated frames) will silently disable the DR code path.
  3094. .TP
  3095. .B \fB\-\-vd\-lavc\-bitexact\fP
  3096. Only use bit\-exact algorithms in all decoding steps (for codec testing).
  3097. .TP
  3098. .B \fB\-\-vd\-lavc\-fast\fP (MPEG\-2, MPEG\-4, and H.264 only)
  3099. Enable optimizations which do not comply with the format specification and
  3100. potentially cause problems, like simpler dequantization, simpler motion
  3101. compensation, assuming use of the default quantization matrix, assuming YUV
  3102. 4:2:0 and skipping a few checks to detect damaged bitstreams.
  3103. .TP
  3104. .B \fB\-\-vd\-lavc\-o=<key>=<value>[,<key>=<value>[,...]]\fP
  3105. Pass AVOptions to libavcodec decoder. Note, a patch to make the \fBo=\fP
  3106. unneeded and pass all unknown options through the AVOption system is
  3107. welcome. A full list of AVOptions can be found in the FFmpeg manual.
  3108. .sp
  3109. Some options which used to be direct options can be set with this
  3110. mechanism, like \fBbug\fP, \fBgray\fP, \fBidct\fP, \fBec\fP, \fBvismv\fP,
  3111. \fBskip_top\fP (was \fBst\fP), \fBskip_bottom\fP (was \fBsb\fP), \fBdebug\fP\&.
  3112. .sp
  3113. This is a key/value list option. See \fI\%List Options\fP for details.
  3114. .INDENT 7.0
  3115. .INDENT 3.5
  3116. .IP "Example"
  3117. .sp
  3118. \fB\-\-vd\-lavc\-o=debug=pict\fP
  3119. .UNINDENT
  3120. .UNINDENT
  3121. .TP
  3122. .B \fB\-\-vd\-lavc\-show\-all=<yes|no>\fP
  3123. Show even broken/corrupt frames (default: no). If this option is set to
  3124. no, libavcodec won\(aqt output frames that were either decoded before an
  3125. initial keyframe was decoded, or frames that are recognized as corrupted.
  3126. .TP
  3127. .B \fB\-\-vd\-lavc\-skiploopfilter=<skipvalue> (H.264 only)\fP
  3128. Skips the loop filter (AKA deblocking) during H.264 decoding. Since
  3129. the filtered frame is supposed to be used as reference for decoding
  3130. dependent frames, this has a worse effect on quality than not doing
  3131. deblocking on e.g. MPEG\-2 video. But at least for high bitrate HDTV,
  3132. this provides a big speedup with little visible quality loss.
  3133. .sp
  3134. \fB<skipvalue>\fP can be one of the following:
  3135. .INDENT 7.0
  3136. .TP
  3137. .B none
  3138. Never skip.
  3139. .TP
  3140. .B default
  3141. Skip useless processing steps (e.g. 0 size packets in AVI).
  3142. .TP
  3143. .B nonref
  3144. Skip frames that are not referenced (i.e. not used for
  3145. decoding other frames, the error cannot "build up").
  3146. .TP
  3147. .B bidir
  3148. Skip B\-Frames.
  3149. .TP
  3150. .B nonkey
  3151. Skip all frames except keyframes.
  3152. .TP
  3153. .B all
  3154. Skip all frames.
  3155. .UNINDENT
  3156. .TP
  3157. .B \fB\-\-vd\-lavc\-skipidct=<skipvalue> (MPEG\-1/2 only)\fP
  3158. Skips the IDCT step. This degrades quality a lot in almost all cases
  3159. (see skiploopfilter for available skip values).
  3160. .TP
  3161. .B \fB\-\-vd\-lavc\-skipframe=<skipvalue>\fP
  3162. Skips decoding of frames completely. Big speedup, but jerky motion and
  3163. sometimes bad artifacts (see skiploopfilter for available skip values).
  3164. .TP
  3165. .B \fB\-\-vd\-lavc\-framedrop=<skipvalue>\fP
  3166. Set framedropping mode used with \fB\-\-framedrop\fP (see skiploopfilter for
  3167. available skip values).
  3168. .TP
  3169. .B \fB\-\-vd\-lavc\-threads=<N>\fP
  3170. Number of threads to use for decoding. Whether threading is actually
  3171. supported depends on codec (default: 0). 0 means autodetect number of cores
  3172. on the machine and use that, up to the maximum of 16. You can set more than
  3173. 16 threads manually.
  3174. .TP
  3175. .B \fB\-\-vd\-lavc\-assume\-old\-x264=<yes|no>\fP
  3176. Assume the video was encoded by an old, buggy x264 version (default: no).
  3177. Normally, this is autodetected by libavcodec. But if the bitstream contains
  3178. no x264 version info (or it was somehow skipped), and the stream was in fact
  3179. encoded by an old x264 version (build 150 or earlier), and if the stream
  3180. uses \fB4:4:4\fP chroma, then libavcodec will by default show corrupted video.
  3181. This option sets the libavcodec \fBx264_build\fP option to \fB150\fP, which
  3182. means that if the stream contains no version info, or was not encoded by
  3183. x264 at all, it assumes it was encoded by the old version. Enabling this
  3184. option is pretty safe if you want your broken files to work, but in theory
  3185. this can break on streams not encoded by x264, or if a stream encoded by a
  3186. newer x264 version contains no version info.
  3187. .TP
  3188. .B \fB\-\-swapchain\-depth=<N>\fP
  3189. Allow up to N in\-flight frames. This essentially controls the frame
  3190. latency. Increasing the swapchain depth can improve pipelining and prevent
  3191. missed vsyncs, but increases visible latency. This option only mandates an
  3192. upper limit, the implementation can use a lower latency than requested
  3193. internally. A setting of 1 means that the VO will wait for every frame to
  3194. become visible before starting to render the next frame. (Default: 3)
  3195. .UNINDENT
  3196. .SS Audio
  3197. .INDENT 0.0
  3198. .TP
  3199. .B \fB\-\-audio\-pitch\-correction=<yes|no>\fP
  3200. If this is enabled (default), playing with a speed different from normal
  3201. automatically inserts the \fBscaletempo\fP audio filter. For details, see
  3202. audio filter section.
  3203. .TP
  3204. .B \fB\-\-audio\-device=<name>\fP
  3205. Use the given audio device. This consists of the audio output name, e.g.
  3206. \fBalsa\fP, followed by \fB/\fP, followed by the audio output specific device
  3207. name. The default value for this option is \fBauto\fP, which tries every audio
  3208. output in preference order with the default device.
  3209. .sp
  3210. You can list audio devices with \fB\-\-audio\-device=help\fP\&. This outputs the
  3211. device name in quotes, followed by a description. The device name is what
  3212. you have to pass to the \fB\-\-audio\-device\fP option. The list of audio devices
  3213. can be retrieved by API by using the \fBaudio\-device\-list\fP property.
  3214. .sp
  3215. While the option normally takes one of the strings as indicated by the
  3216. methods above, you can also force the device for most AOs by building it
  3217. manually. For example \fBname/foobar\fP forces the AO \fBname\fP to use the
  3218. device \fBfoobar\fP\&. However, the \fB\-\-ao\fP option will strictly force a
  3219. specific AO. To avoid confusion, don\(aqt use \fB\-\-ao\fP and \fB\-\-audio\-device\fP
  3220. together.
  3221. .INDENT 7.0
  3222. .INDENT 3.5
  3223. .IP "Example for ALSA"
  3224. .sp
  3225. MPlayer and mplayer2 required you to replace any \(aq,\(aq with \(aq.\(aq and
  3226. any \(aq:\(aq with \(aq=\(aq in the ALSA device name. For example, to use the
  3227. device named \fBdmix:default\fP, you had to do:
  3228. .INDENT 0.0
  3229. .INDENT 3.5
  3230. \fB\-ao alsa:device=dmix=default\fP
  3231. .UNINDENT
  3232. .UNINDENT
  3233. .sp
  3234. In mpv you could instead use:
  3235. .INDENT 0.0
  3236. .INDENT 3.5
  3237. \fB\-\-audio\-device=alsa/dmix:default\fP
  3238. .UNINDENT
  3239. .UNINDENT
  3240. .UNINDENT
  3241. .UNINDENT
  3242. .TP
  3243. .B \fB\-\-audio\-exclusive=<yes|no>\fP
  3244. Enable exclusive output mode. In this mode, the system is usually locked
  3245. out, and only mpv will be able to output audio.
  3246. .sp
  3247. This only works for some audio outputs, such as \fBwasapi\fP and
  3248. \fBcoreaudio\fP\&. Other audio outputs silently ignore this options. They either
  3249. have no concept of exclusive mode, or the mpv side of the implementation is
  3250. missing.
  3251. .TP
  3252. .B \fB\-\-audio\-fallback\-to\-null=<yes|no>\fP
  3253. If no audio device can be opened, behave as if \fB\-\-ao=null\fP was given. This
  3254. is useful in combination with \fB\-\-audio\-device\fP: instead of causing an
  3255. error if the selected device does not exist, the client API user (or a
  3256. Lua script) could let playback continue normally, and check the
  3257. \fBcurrent\-ao\fP and \fBaudio\-device\-list\fP properties to make high\-level
  3258. decisions about how to continue.
  3259. .TP
  3260. .B \fB\-\-ao=<driver>\fP
  3261. Specify the audio output drivers to be used. See \fI\%AUDIO OUTPUT DRIVERS\fP for
  3262. details and descriptions of available drivers.
  3263. .TP
  3264. .B \fB\-\-af=<filter1[=parameter1:parameter2:...],filter2,...>\fP
  3265. Specify a list of audio filters to apply to the audio stream. See
  3266. \fI\%AUDIO FILTERS\fP for details and descriptions of the available filters.
  3267. The option variants \fB\-\-af\-add\fP, \fB\-\-af\-pre\fP, \fB\-\-af\-del\fP and
  3268. \fB\-\-af\-clr\fP exist to modify a previously specified list, but you
  3269. should not need these for typical use.
  3270. .TP
  3271. .B \fB\-\-audio\-spdif=<codecs>\fP
  3272. List of codecs for which compressed audio passthrough should be used. This
  3273. works for both classic S/PDIF and HDMI.
  3274. .sp
  3275. Possible codecs are \fBac3\fP, \fBdts\fP, \fBdts\-hd\fP, \fBeac3\fP, \fBtruehd\fP\&.
  3276. Multiple codecs can be specified by separating them with \fB,\fP\&. \fBdts\fP
  3277. refers to low bitrate DTS core, while \fBdts\-hd\fP refers to DTS MA (receiver
  3278. and OS support varies). If both \fBdts\fP and \fBdts\-hd\fP are specified, it
  3279. behaves equivalent to specifying \fBdts\-hd\fP only.
  3280. .sp
  3281. In earlier mpv versions you could use \fB\-\-ad\fP to force the spdif wrapper.
  3282. This does not work anymore.
  3283. .INDENT 7.0
  3284. .INDENT 3.5
  3285. .IP "Warning"
  3286. .sp
  3287. There is not much reason to use this. HDMI supports uncompressed
  3288. multichannel PCM, and mpv supports lossless DTS\-HD decoding via
  3289. FFmpeg\(aqs new DCA decoder (based on libdcadec).
  3290. .UNINDENT
  3291. .UNINDENT
  3292. .TP
  3293. .B \fB\-\-ad=<decoder1,decoder2,...[\-]>\fP
  3294. Specify a priority list of audio decoders to be used, according to their
  3295. decoder name. When determining which decoder to use, the first decoder that
  3296. matches the audio format is selected. If that is unavailable, the next
  3297. decoder is used. Finally, it tries all other decoders that are not
  3298. explicitly selected or rejected by the option.
  3299. .sp
  3300. \fB\-\fP at the end of the list suppresses fallback on other available
  3301. decoders not on the \fB\-\-ad\fP list. \fB+\fP in front of an entry forces the
  3302. decoder. Both of these should not normally be used, because they break
  3303. normal decoder auto\-selection! Both of these methods are deprecated.
  3304. .INDENT 7.0
  3305. .INDENT 3.5
  3306. .IP "Examples"
  3307. .INDENT 0.0
  3308. .TP
  3309. .B \fB\-\-ad=mp3float\fP
  3310. Prefer the FFmpeg/Libav \fBmp3float\fP decoder over all other MP3
  3311. decoders.
  3312. .TP
  3313. .B \fB\-\-ad=help\fP
  3314. List all available decoders.
  3315. .UNINDENT
  3316. .UNINDENT
  3317. .UNINDENT
  3318. .INDENT 7.0
  3319. .INDENT 3.5
  3320. .IP "Warning"
  3321. .sp
  3322. Enabling compressed audio passthrough (AC3 and DTS via SPDIF/HDMI) with
  3323. this option is not possible. Use \fB\-\-audio\-spdif\fP instead.
  3324. .UNINDENT
  3325. .UNINDENT
  3326. .TP
  3327. .B \fB\-\-volume=<value>\fP
  3328. Set the startup volume. 0 means silence, 100 means no volume reduction or
  3329. amplification. Negative values can be passed for compatibility, but are
  3330. treated as 0.
  3331. .sp
  3332. Since mpv 0.18.1, this always controls the internal mixer (aka "softvol").
  3333. .TP
  3334. .B \fB\-\-replaygain=<no|track|album>\fP
  3335. Adjust volume gain according to replaygain values stored in the file
  3336. metadata. With \fB\-\-replaygain=no\fP (the default), perform no adjustment.
  3337. With \fB\-\-replaygain=track\fP, apply track gain. With \fB\-\-replaygain=album\fP,
  3338. apply album gain if present and fall back to track gain otherwise.
  3339. .TP
  3340. .B \fB\-\-replaygain\-preamp=<db>\fP
  3341. Pre\-amplification gain in dB to apply to the selected replaygain gain
  3342. (default: 0).
  3343. .TP
  3344. .B \fB\-\-replaygain\-clip=<yes|no>\fP
  3345. Prevent clipping caused by replaygain by automatically lowering the
  3346. gain (default). Use \fB\-\-replaygain\-clip=no\fP to disable this.
  3347. .TP
  3348. .B \fB\-\-replaygain\-fallback=<db>\fP
  3349. Gain in dB to apply if the file has no replay gain tags. This option
  3350. is always applied if the replaygain logic is somehow inactive. If this
  3351. is applied, no other replaygain options are applied.
  3352. .TP
  3353. .B \fB\-\-audio\-delay=<sec>\fP
  3354. Audio delay in seconds (positive or negative float value). Positive values
  3355. delay the audio, and negative values delay the video.
  3356. .TP
  3357. .B \fB\-\-mute=<yes|no|auto>\fP
  3358. Set startup audio mute status (default: no).
  3359. .sp
  3360. \fBauto\fP is a deprecated possible value that is equivalent to \fBno\fP\&.
  3361. .sp
  3362. See also: \fB\-\-volume\fP\&.
  3363. .TP
  3364. .B \fB\-\-softvol=<no|yes|auto>\fP
  3365. Deprecated/unfunctional. Before mpv 0.18.1, this used to control whether
  3366. to use the volume controls of the audio output driver or the internal mpv
  3367. volume filter.
  3368. .sp
  3369. The current behavior is that softvol is always enabled, i.e. as if this
  3370. option is set to \fByes\fP\&. The other behaviors are not available anymore,
  3371. although \fBauto\fP almost matches current behavior in most cases.
  3372. .sp
  3373. The \fBno\fP behavior is still partially available through the \fBao\-volume\fP
  3374. and \fBao\-mute\fP properties. But there are no options to reset these.
  3375. .TP
  3376. .B \fB\-\-audio\-demuxer=<[+]name>\fP
  3377. Use this audio demuxer type when using \fB\-\-audio\-file\fP\&. Use a \(aq+\(aq before
  3378. the name to force it; this will skip some checks. Give the demuxer name as
  3379. printed by \fB\-\-audio\-demuxer=help\fP\&.
  3380. .TP
  3381. .B \fB\-\-ad\-lavc\-ac3drc=<level>\fP
  3382. Select the Dynamic Range Compression level for AC\-3 audio streams.
  3383. \fB<level>\fP is a float value ranging from 0 to 1, where 0 means no
  3384. compression (which is the default) and 1 means full compression (make loud
  3385. passages more silent and vice versa). Values up to 6 are also accepted, but
  3386. are purely experimental. This option only shows an effect if the AC\-3 stream
  3387. contains the required range compression information.
  3388. .sp
  3389. The standard mandates that DRC is enabled by default, but mpv (and some
  3390. other players) ignore this for the sake of better audio quality.
  3391. .TP
  3392. .B \fB\-\-ad\-lavc\-downmix=<yes|no>\fP
  3393. Whether to request audio channel downmixing from the decoder (default: yes).
  3394. Some decoders, like AC\-3, AAC and DTS, can remix audio on decoding. The
  3395. requested number of output channels is set with the \fB\-\-audio\-channels\fP option.
  3396. Useful for playing surround audio on a stereo system.
  3397. .TP
  3398. .B \fB\-\-ad\-lavc\-threads=<0\-16>\fP
  3399. Number of threads to use for decoding. Whether threading is actually
  3400. supported depends on codec. As of this writing, it\(aqs supported for some
  3401. lossless codecs only. 0 means autodetect number of cores on the
  3402. machine and use that, up to the maximum of 16 (default: 1).
  3403. .TP
  3404. .B \fB\-\-ad\-lavc\-o=<key>=<value>[,<key>=<value>[,...]]\fP
  3405. Pass AVOptions to libavcodec decoder. Note, a patch to make the o=
  3406. unneeded and pass all unknown options through the AVOption system is
  3407. welcome. A full list of AVOptions can be found in the FFmpeg manual.
  3408. .sp
  3409. This is a key/value list option. See \fI\%List Options\fP for details.
  3410. .TP
  3411. .B \fB\-\-ad\-spdif\-dtshd=<yes|no>\fP, \fB\-\-dtshd\fP, \fB\-\-no\-dtshd\fP
  3412. If DTS is passed through, use DTS\-HD.
  3413. .INDENT 7.0
  3414. .INDENT 3.5
  3415. .IP "Warning"
  3416. .sp
  3417. This and enabling passthrough via \fB\-\-ad\fP are deprecated in favor of
  3418. using \fB\-\-audio\-spdif=dts\-hd\fP\&.
  3419. .UNINDENT
  3420. .UNINDENT
  3421. .TP
  3422. .B \fB\-\-audio\-channels=<auto\-safe|auto|layouts>\fP
  3423. Control which audio channels are output (e.g. surround vs. stereo). There
  3424. are the following possibilities:
  3425. .INDENT 7.0
  3426. .IP \(bu 2
  3427. .INDENT 2.0
  3428. .TP
  3429. .B \fB\-\-audio\-channels=auto\-safe\fP
  3430. Use the system\(aqs preferred channel layout. If there is none (such
  3431. as when accessing a hardware device instead of the system mixer),
  3432. force stereo. Some audio outputs might simply accept any layout and
  3433. do downmixing on their own.
  3434. .sp
  3435. This is the default.
  3436. .UNINDENT
  3437. .IP \(bu 2
  3438. .INDENT 2.0
  3439. .TP
  3440. .B \fB\-\-audio\-channels=auto\fP
  3441. Send the audio device whatever it accepts, preferring the audio\(aqs
  3442. original channel layout. Can cause issues with HDMI (see the warning
  3443. below).
  3444. .UNINDENT
  3445. .IP \(bu 2
  3446. .INDENT 2.0
  3447. .TP
  3448. .B \fB\-\-audio\-channels=layout1,layout2,...\fP
  3449. List of \fB,\fP\-separated channel layouts which should be allowed.
  3450. Technically, this only adjusts the filter chain output to the best
  3451. matching layout in the list, and passes the result to the audio API.
  3452. It\(aqs possible that the audio API will select a different channel
  3453. layout.
  3454. .sp
  3455. Using this mode is recommended for direct hardware output, especially
  3456. over HDMI (see HDMI warning below).
  3457. .UNINDENT
  3458. .IP \(bu 2
  3459. .INDENT 2.0
  3460. .TP
  3461. .B \fB\-\-audio\-channels=stereo\fP
  3462. Force  a plain stereo downmix. This is a special\-case of the previous
  3463. item. (See paragraphs below for implications.)
  3464. .UNINDENT
  3465. .UNINDENT
  3466. .sp
  3467. If a list of layouts is given, each item can be either an explicit channel
  3468. layout name (like \fB5.1\fP), or a channel number. Channel numbers refer to
  3469. default layouts, e.g. 2 channels refer to stereo, 6 refers to 5.1.
  3470. .sp
  3471. See \fB\-\-audio\-channels=help\fP output for defined default layouts. This also
  3472. lists speaker names, which can be used to express arbitrary channel
  3473. layouts (e.g. \fBfl\-fr\-lfe\fP is 2.1).
  3474. .sp
  3475. If the list of channel layouts has only 1 item, the decoder is asked to
  3476. produce according output. This sometimes triggers decoder\-downmix, which
  3477. might be different from the normal mpv downmix. (Only some decoders support
  3478. remixing audio, like AC\-3, AAC or DTS. You can use \fB\-\-ad\-lavc\-downmix=no\fP
  3479. to make the decoder always output its native layout.) One consequence is
  3480. that \fB\-\-audio\-channels=stereo\fP triggers decoder downmix, while \fBauto\fP
  3481. or \fBauto\-safe\fP never will, even if they end up selecting stereo. This
  3482. happens because the decision whether to use decoder downmix happens long
  3483. before the audio device is opened.
  3484. .sp
  3485. If the channel layout of the media file (i.e. the decoder) and the AO\(aqs
  3486. channel layout don\(aqt match, mpv will attempt to insert a conversion filter.
  3487. You may need to change the channel layout of the system mixer to achieve
  3488. your desired output as mpv does not have control over it. Another
  3489. work\-around for this on some AOs is to use \fB\-\-audio\-exclusive=yes\fP to
  3490. circumvent the system mixer entirely.
  3491. .INDENT 7.0
  3492. .INDENT 3.5
  3493. .IP "Warning"
  3494. .sp
  3495. Using \fBauto\fP can cause issues when using audio over HDMI. The OS will
  3496. typically report all channel layouts that _can_ go over HDMI, even if
  3497. the receiver does not support them. If a receiver gets an unsupported
  3498. channel layout, random things can happen, such as dropping the
  3499. additional channels, or adding noise.
  3500. .sp
  3501. You are recommended to set an explicit whitelist of the layouts you
  3502. want. For example, most A/V receivers connected via HDMI and that can
  3503. do 7.1 would  be served by: \fB\-\-audio\-channels=7.1,5.1,stereo\fP
  3504. .UNINDENT
  3505. .UNINDENT
  3506. .TP
  3507. .B \fB\-\-audio\-display=<no|attachment>\fP
  3508. Setting this option to \fBattachment\fP (default) will display image
  3509. attachments (e.g. album cover art) when playing audio files. It will
  3510. display the first image found, and additional images are available as
  3511. video tracks.
  3512. .sp
  3513. Setting this option to \fBno\fP disables display of video entirely when
  3514. playing audio files.
  3515. .sp
  3516. This option has no influence on files with normal video tracks.
  3517. .TP
  3518. .B \fB\-\-audio\-files=<files>\fP
  3519. Play audio from an external file while viewing a video.
  3520. .sp
  3521. This is a path list option. See \fI\%List Options\fP for details.
  3522. .TP
  3523. .B \fB\-\-audio\-file=<file>\fP
  3524. CLI/config file only alias for \fB\-\-audio\-files\-append\fP\&. Each use of this
  3525. option will add a new audio track. The details are similar to how
  3526. \fB\-\-sub\-file\fP works.
  3527. .TP
  3528. .B \fB\-\-audio\-format=<format>\fP
  3529. Select the sample format used for output from the audio filter layer to
  3530. the sound card. The values that \fB<format>\fP can adopt are listed below in
  3531. the description of the \fBformat\fP audio filter.
  3532. .TP
  3533. .B \fB\-\-audio\-samplerate=<Hz>\fP
  3534. Select the output sample rate to be used (of course sound cards have
  3535. limits on this). If the sample frequency selected is different from that
  3536. of the current media, the lavrresample audio filter will be inserted into
  3537. the audio filter layer to compensate for the difference.
  3538. .TP
  3539. .B \fB\-\-gapless\-audio=<no|yes|weak>\fP
  3540. Try to play consecutive audio files with no silence or disruption at the
  3541. point of file change. Default: \fBweak\fP\&.
  3542. .INDENT 7.0
  3543. .TP
  3544. .B no
  3545. Disable gapless audio.
  3546. .TP
  3547. .B yes
  3548. The audio device is opened using parameters chosen for the first
  3549. file played and is then kept open for gapless playback. This
  3550. means that if the first file for example has a low sample rate, then
  3551. the following files may get resampled to the same low sample rate,
  3552. resulting in reduced sound quality. If you play files with different
  3553. parameters, consider using options such as \fB\-\-audio\-samplerate\fP
  3554. and \fB\-\-audio\-format\fP to explicitly select what the shared output
  3555. format will be.
  3556. .TP
  3557. .B weak
  3558. Normally, the audio device is kept open (using the format it was
  3559. first initialized with). If the audio format the decoder output
  3560. changes, the audio device is closed and reopened. This means that
  3561. you will normally get gapless audio with files that were encoded
  3562. using the same settings, but might not be gapless in other cases.
  3563. The exact conditions under which the audio device is kept open is
  3564. an implementation detail, and can change from version to version.
  3565. Currently, the device is kept even if the sample format changes,
  3566. but the sample formats are convertible.
  3567. If video is still going on when there is still audio, trying to use
  3568. gapless is also explicitly given up.
  3569. .UNINDENT
  3570. .sp
  3571. \fBNOTE:\fP
  3572. .INDENT 7.0
  3573. .INDENT 3.5
  3574. This feature is implemented in a simple manner and relies on audio
  3575. output device buffering to continue playback while moving from one file
  3576. to another. If playback of the new file starts slowly, for example
  3577. because it is played from a remote network location or because you have
  3578. specified cache settings that require time for the initial cache fill,
  3579. then the buffered audio may run out before playback of the new file
  3580. can start.
  3581. .UNINDENT
  3582. .UNINDENT
  3583. .TP
  3584. .B \fB\-\-initial\-audio\-sync\fP, \fB\-\-no\-initial\-audio\-sync\fP
  3585. When starting a video file or after events such as seeking, mpv will by
  3586. default modify the audio stream to make it start from the same timestamp
  3587. as video, by either inserting silence at the start or cutting away the
  3588. first samples. Disabling this option makes the player behave like older
  3589. mpv versions did: video and audio are both started immediately even if
  3590. their start timestamps differ, and then video timing is gradually adjusted
  3591. if necessary to reach correct synchronization later.
  3592. .TP
  3593. .B \fB\-\-volume\-max=<100.0\-1000.0>\fP, \fB\-\-softvol\-max=<...>\fP
  3594. Set the maximum amplification level in percent (default: 130). A value of
  3595. 130 will allow you to adjust the volume up to about double the normal level.
  3596. .sp
  3597. \fB\-\-softvol\-max\fP is a deprecated alias and should not be used.
  3598. .TP
  3599. .B \fB\-\-audio\-file\-auto=<no|exact|fuzzy|all>\fP, \fB\-\-no\-audio\-file\-auto\fP
  3600. Load additional audio files matching the video filename. The parameter
  3601. specifies how external audio files are matched.
  3602. .INDENT 7.0
  3603. .TP
  3604. .B no
  3605. Don\(aqt automatically load external audio files (default).
  3606. .TP
  3607. .B exact
  3608. Load the media filename with audio file extension.
  3609. .TP
  3610. .B fuzzy
  3611. Load all audio files containing media filename.
  3612. .TP
  3613. .B all
  3614. Load all audio files in the current and \fB\-\-audio\-file\-paths\fP
  3615. directories.
  3616. .UNINDENT
  3617. .TP
  3618. .B \fB\-\-audio\-file\-paths=<path1:path2:...>\fP
  3619. Equivalent to \fB\-\-sub\-file\-paths\fP option, but for auto\-loaded audio files.
  3620. .sp
  3621. This is a path list option. See \fI\%List Options\fP for details.
  3622. .TP
  3623. .B \fB\-\-audio\-client\-name=<name>\fP
  3624. The application name the player reports to the audio API. Can be useful
  3625. if you want to force a different audio profile (e.g. with PulseAudio),
  3626. or to set your own application name when using libmpv.
  3627. .TP
  3628. .B \fB\-\-audio\-buffer=<seconds>\fP
  3629. Set the audio output minimum buffer. The audio device might actually create
  3630. a larger buffer if it pleases. If the device creates a smaller buffer,
  3631. additional audio is buffered in an additional software buffer.
  3632. .sp
  3633. Making this larger will make soft\-volume and other filters react slower,
  3634. introduce additional issues on playback speed change, and block the
  3635. player on audio format changes. A smaller buffer might lead to audio
  3636. dropouts.
  3637. .sp
  3638. This option should be used for testing only. If a non\-default value helps
  3639. significantly, the mpv developers should be contacted.
  3640. .sp
  3641. Default: 0.2 (200 ms).
  3642. .TP
  3643. .B \fB\-\-audio\-stream\-silence=<yes|no>\fP
  3644. Cash\-grab consumer audio hardware (such as A/V receivers) often ignore
  3645. initial audio sent over HDMI. This can happen every time audio over HDMI
  3646. is stopped and resumed. In order to compensate for this, you can enable
  3647. this option to not to stop and restart audio on seeks, and fill the gaps
  3648. with silence. Likewise, when pausing playback, audio is not stopped, and
  3649. silence is played while paused. Note that if no audio track is selected,
  3650. the audio device will still be closed immediately.
  3651. .sp
  3652. Not all AOs support this.
  3653. .TP
  3654. .B \fB\-\-audio\-wait\-open=<secs>\fP
  3655. This makes sense for use with \fB\-\-audio\-stream\-silence=yes\fP\&. If this option
  3656. is given, the player will wait for the given amount of seconds after opening
  3657. the audio device before sending actual audio data to it. Useful if your
  3658. expensive hardware discards the first 1 or 2 seconds of audio data sent to
  3659. it. If \fB\-\-audio\-stream\-silence=yes\fP is not set, this option will likely
  3660. just waste time.
  3661. .UNINDENT
  3662. .SS Subtitles
  3663. .sp
  3664. \fBNOTE:\fP
  3665. .INDENT 0.0
  3666. .INDENT 3.5
  3667. Changing styling and position does not work with all subtitles. Image\-based
  3668. subtitles (DVD, Bluray/PGS, DVB) cannot changed for fundamental reasons.
  3669. Subtitles in ASS format are normally not changed intentionally, but
  3670. overriding them can be controlled with \fB\-\-sub\-ass\-override\fP\&.
  3671. .sp
  3672. Previously some options working on text subtitles were called
  3673. \fB\-\-sub\-text\-*\fP, they are now named \fB\-\-sub\-*\fP, and those specifically
  3674. for ASS have been renamed from \fB\-\-ass\-*\fP to \fB\-\-sub\-ass\-*\fP\&.
  3675. They are now all in this section.
  3676. .UNINDENT
  3677. .UNINDENT
  3678. .INDENT 0.0
  3679. .TP
  3680. .B \fB\-\-sub\-demuxer=<[+]name>\fP
  3681. Force subtitle demuxer type for \fB\-\-sub\-file\fP\&. Give the demuxer name as
  3682. printed by \fB\-\-sub\-demuxer=help\fP\&.
  3683. .TP
  3684. .B \fB\-\-sub\-delay=<sec>\fP
  3685. Delays subtitles by \fB<sec>\fP seconds. Can be negative.
  3686. .TP
  3687. .B \fB\-\-sub\-files=<file\-list>\fP, \fB\-\-sub\-file=<filename>\fP
  3688. Add a subtitle file to the list of external subtitles.
  3689. .sp
  3690. If you use \fB\-\-sub\-file\fP only once, this subtitle file is displayed by
  3691. default.
  3692. .sp
  3693. If \fB\-\-sub\-file\fP is used multiple times, the subtitle to use can be
  3694. switched at runtime by cycling subtitle tracks. It\(aqs possible to show
  3695. two subtitles at once: use \fB\-\-sid\fP to select the first subtitle index,
  3696. and \fB\-\-secondary\-sid\fP to select the second index. (The index is printed
  3697. on the terminal output after the \fB\-\-sid=\fP in the list of streams.)
  3698. .sp
  3699. \fB\-\-sub\-files\fP is a path list option (see \fI\%List Options\fP  for details), and
  3700. can take multiple file names separated by \fB:\fP (Unix) or \fB;\fP (Windows),
  3701. while  \fB\-\-sub\-file\fP takes a single filename, but can be used multiple
  3702. times to add multiple files. Technically, \fB\-\-sub\-file\fP is a CLI/config
  3703. file only alias for  \fB\-\-sub\-files\-append\fP\&.
  3704. .TP
  3705. .B \fB\-\-secondary\-sid=<ID|auto|no>\fP
  3706. Select a secondary subtitle stream. This is similar to \fB\-\-sid\fP\&. If a
  3707. secondary subtitle is selected, it will be rendered as toptitle (i.e. on
  3708. the top of the screen) alongside the normal subtitle, and provides a way
  3709. to render two subtitles at once.
  3710. .sp
  3711. There are some caveats associated with this feature. For example, bitmap
  3712. subtitles will always be rendered in their usual position, so selecting a
  3713. bitmap subtitle as secondary subtitle will result in overlapping subtitles.
  3714. Secondary subtitles are never shown on the terminal if video is disabled.
  3715. .sp
  3716. \fBNOTE:\fP
  3717. .INDENT 7.0
  3718. .INDENT 3.5
  3719. Styling and interpretation of any formatting tags is disabled for the
  3720. secondary subtitle. Internally, the same mechanism as \fB\-\-no\-sub\-ass\fP
  3721. is used to strip the styling.
  3722. .UNINDENT
  3723. .UNINDENT
  3724. .sp
  3725. \fBNOTE:\fP
  3726. .INDENT 7.0
  3727. .INDENT 3.5
  3728. If the main subtitle stream contains formatting tags which display the
  3729. subtitle at the top of the screen, it will overlap with the secondary
  3730. subtitle. To prevent this, you could use \fB\-\-no\-sub\-ass\fP to disable
  3731. styling in the main subtitle stream.
  3732. .UNINDENT
  3733. .UNINDENT
  3734. .TP
  3735. .B \fB\-\-sub\-scale=<0\-100>\fP
  3736. Factor for the text subtitle font size (default: 1).
  3737. .sp
  3738. \fBNOTE:\fP
  3739. .INDENT 7.0
  3740. .INDENT 3.5
  3741. This affects ASS subtitles as well, and may lead to incorrect subtitle
  3742. rendering. Use with care, or use \fB\-\-sub\-font\-size\fP instead.
  3743. .UNINDENT
  3744. .UNINDENT
  3745. .TP
  3746. .B \fB\-\-sub\-scale\-by\-window=<yes|no>\fP
  3747. Whether to scale subtitles with the window size (default: yes). If this is
  3748. disabled, changing the window size won\(aqt change the subtitle font size.
  3749. .sp
  3750. Like \fB\-\-sub\-scale\fP, this can break ASS subtitles.
  3751. .TP
  3752. .B \fB\-\-sub\-scale\-with\-window=<yes|no>\fP
  3753. Make the subtitle font size relative to the window, instead of the video.
  3754. This is useful if you always want the same font size, even if the video
  3755. doesn\(aqt cover the window fully, e.g. because screen aspect and window
  3756. aspect mismatch (and the player adds black bars).
  3757. .sp
  3758. Default: yes.
  3759. .sp
  3760. This option is misnamed. The difference to the confusingly similar sounding
  3761. option \fB\-\-sub\-scale\-by\-window\fP is that \fB\-\-sub\-scale\-with\-window\fP still
  3762. scales with the approximate window size, while the other option disables
  3763. this scaling.
  3764. .sp
  3765. Affects plain text subtitles only (or ASS if \fB\-\-sub\-ass\-override\fP is set
  3766. high enough).
  3767. .TP
  3768. .B \fB\-\-sub\-ass\-scale\-with\-window=<yes|no>\fP
  3769. Like \fB\-\-sub\-scale\-with\-window\fP, but affects subtitles in ASS format only.
  3770. Like \fB\-\-sub\-scale\fP, this can break ASS subtitles.
  3771. .sp
  3772. Default: no.
  3773. .TP
  3774. .B \fB\-\-embeddedfonts=<yes|no>\fP
  3775. Use fonts embedded in Matroska container files and ASS scripts (default:
  3776. yes). These fonts can be used for SSA/ASS subtitle rendering.
  3777. .TP
  3778. .B \fB\-\-sub\-pos=<0\-100>\fP
  3779. Specify the position of subtitles on the screen. The value is the vertical
  3780. position of the subtitle in % of the screen height.
  3781. .sp
  3782. \fBNOTE:\fP
  3783. .INDENT 7.0
  3784. .INDENT 3.5
  3785. This affects ASS subtitles as well, and may lead to incorrect subtitle
  3786. rendering. Use with care, or use \fB\-\-sub\-margin\-y\fP instead.
  3787. .UNINDENT
  3788. .UNINDENT
  3789. .TP
  3790. .B \fB\-\-sub\-speed=<0.1\-10.0>\fP
  3791. Multiply the subtitle event timestamps with the given value. Can be used
  3792. to fix the playback speed for frame\-based subtitle formats. Affects text
  3793. subtitles only.
  3794. .INDENT 7.0
  3795. .INDENT 3.5
  3796. .IP "Example"
  3797. .sp
  3798. \fB\-\-sub\-speed=25/23.976\fP plays frame based subtitles which have been
  3799. loaded assuming a framerate of 23.976 at 25 FPS.
  3800. .UNINDENT
  3801. .UNINDENT
  3802. .TP
  3803. .B \fB\-\-sub\-ass\-force\-style=<[Style.]Param=Value[,...]>\fP
  3804. Override some style or script info parameters.
  3805. .sp
  3806. This is a string list option. See \fI\%List Options\fP for details.
  3807. .INDENT 7.0
  3808. .INDENT 3.5
  3809. .IP "Examples"
  3810. .INDENT 0.0
  3811. .IP \(bu 2
  3812. \fB\-\-sub\-ass\-force\-style=FontName=Arial,Default.Bold=1\fP
  3813. .IP \(bu 2
  3814. \fB\-\-sub\-ass\-force\-style=PlayResY=768\fP
  3815. .UNINDENT
  3816. .UNINDENT
  3817. .UNINDENT
  3818. .sp
  3819. \fBNOTE:\fP
  3820. .INDENT 7.0
  3821. .INDENT 3.5
  3822. Using this option may lead to incorrect subtitle rendering.
  3823. .UNINDENT
  3824. .UNINDENT
  3825. .TP
  3826. .B \fB\-\-sub\-ass\-hinting=<none|light|normal|native>\fP
  3827. Set font hinting type. <type> can be:
  3828. .INDENT 7.0
  3829. .TP
  3830. .B none
  3831. no hinting (default)
  3832. .TP
  3833. .B light
  3834. FreeType autohinter, light mode
  3835. .TP
  3836. .B normal
  3837. FreeType autohinter, normal mode
  3838. .TP
  3839. .B native
  3840. font native hinter
  3841. .UNINDENT
  3842. .INDENT 7.0
  3843. .INDENT 3.5
  3844. .IP "Warning"
  3845. .sp
  3846. Enabling hinting can lead to mispositioned text (in situations it\(aqs
  3847. supposed to match up video background), or reduce the smoothness
  3848. of animations with some badly authored ASS scripts. It is recommended
  3849. to not use this option, unless really needed.
  3850. .UNINDENT
  3851. .UNINDENT
  3852. .TP
  3853. .B \fB\-\-sub\-ass\-line\-spacing=<value>\fP
  3854. Set line spacing value for SSA/ASS renderer.
  3855. .TP
  3856. .B \fB\-\-sub\-ass\-shaper=<simple|complex>\fP
  3857. Set the text layout engine used by libass.
  3858. .INDENT 7.0
  3859. .TP
  3860. .B simple
  3861. uses Fribidi only, fast, doesn\(aqt render some languages correctly
  3862. .TP
  3863. .B complex
  3864. uses HarfBuzz, slower, wider language support
  3865. .UNINDENT
  3866. .sp
  3867. \fBcomplex\fP is the default. If libass hasn\(aqt been compiled against HarfBuzz,
  3868. libass silently reverts to \fBsimple\fP\&.
  3869. .TP
  3870. .B \fB\-\-sub\-ass\-styles=<filename>\fP
  3871. Load all SSA/ASS styles found in the specified file and use them for
  3872. rendering text subtitles. The syntax of the file is exactly like the \fB[V4
  3873. Styles]\fP / \fB[V4+ Styles]\fP section of SSA/ASS.
  3874. .sp
  3875. \fBNOTE:\fP
  3876. .INDENT 7.0
  3877. .INDENT 3.5
  3878. Using this option may lead to incorrect subtitle rendering.
  3879. .UNINDENT
  3880. .UNINDENT
  3881. .TP
  3882. .B \fB\-\-sub\-ass\-override=<yes|no|force|scale|strip>\fP
  3883. Control whether user style overrides should be applied. Note that all of
  3884. these overrides try to be somewhat smart about figuring out whether or not
  3885. a subtitle is considered a "sign".
  3886. .INDENT 7.0
  3887. .TP
  3888. .B no
  3889. Render subtitles as specified by the subtitle scripts, without
  3890. overrides.
  3891. .TP
  3892. .B yes
  3893. Apply all the \fB\-\-sub\-ass\-*\fP style override options. Changing the
  3894. default for any of these options can lead to incorrect subtitle
  3895. rendering (default).
  3896. .TP
  3897. .B force
  3898. Like \fByes\fP, but also force all \fB\-\-sub\-*\fP options. Can break
  3899. rendering easily.
  3900. .TP
  3901. .B scale
  3902. Like \fByes\fP, but also apply \fB\-\-sub\-scale\fP\&.
  3903. .TP
  3904. .B strip
  3905. Radically strip all ASS tags and styles from the subtitle. This
  3906. is equivalent to the old \fB\-\-no\-ass\fP / \fB\-\-no\-sub\-ass\fP options.
  3907. .UNINDENT
  3908. .sp
  3909. This also controls some bitmap subtitle overrides, as well as HTML tags in
  3910. formats like SRT, despite the name of the option.
  3911. .TP
  3912. .B \fB\-\-sub\-ass\-force\-margins\fP
  3913. Enables placing toptitles and subtitles in black borders when they are
  3914. available, if the subtitles are in the ASS format.
  3915. .sp
  3916. Default: no.
  3917. .TP
  3918. .B \fB\-\-sub\-use\-margins\fP
  3919. Enables placing toptitles and subtitles in black borders when they are
  3920. available, if the subtitles are in a plain text format  (or ASS if
  3921. \fB\-\-sub\-ass\-override\fP is set high enough).
  3922. .sp
  3923. Default: yes.
  3924. .sp
  3925. Renamed from \fB\-\-sub\-ass\-use\-margins\fP\&. To place ASS subtitles in the borders
  3926. too (like the old option did), also add \fB\-\-sub\-ass\-force\-margins\fP\&.
  3927. .TP
  3928. .B \fB\-\-sub\-ass\-vsfilter\-aspect\-compat=<yes|no>\fP
  3929. Stretch SSA/ASS subtitles when playing anamorphic videos for compatibility
  3930. with traditional VSFilter behavior. This switch has no effect when the
  3931. video is stored with square pixels.
  3932. .sp
  3933. The renderer historically most commonly used for the SSA/ASS subtitle
  3934. formats, VSFilter, had questionable behavior that resulted in subtitles
  3935. being stretched too if the video was stored in anamorphic format that
  3936. required scaling for display.  This behavior is usually undesirable and
  3937. newer VSFilter versions may behave differently. However, many existing
  3938. scripts compensate for the stretching by modifying things in the opposite
  3939. direction.  Thus, if such scripts are displayed "correctly", they will not
  3940. appear as intended.  This switch enables emulation of the old VSFilter
  3941. behavior (undesirable but expected by many existing scripts).
  3942. .sp
  3943. Enabled by default.
  3944. .TP
  3945. .B \fB\-\-sub\-ass\-vsfilter\-blur\-compat=<yes|no>\fP
  3946. Scale \fB\eblur\fP tags by video resolution instead of script resolution
  3947. (enabled by default). This is bug in VSFilter, which according to some,
  3948. can\(aqt be fixed anymore in the name of compatibility.
  3949. .sp
  3950. Note that this uses the actual video resolution for calculating the
  3951. offset scale factor, not what the video filter chain or the video output
  3952. use.
  3953. .TP
  3954. .B \fB\-\-sub\-ass\-vsfilter\-color\-compat=<basic|full|force\-601|no>\fP
  3955. Mangle colors like (xy\-)vsfilter do (default: basic). Historically, VSFilter
  3956. was not color space aware. This was no problem as long as the color space
  3957. used for SD video (BT.601) was used. But when everything switched to HD
  3958. (BT.709), VSFilter was still converting RGB colors to BT.601, rendered
  3959. them into the video frame, and handled the frame to the video output, which
  3960. would use BT.709 for conversion to RGB. The result were mangled subtitle
  3961. colors. Later on, bad hacks were added on top of the ASS format to control
  3962. how colors are to be mangled.
  3963. .INDENT 7.0
  3964. .TP
  3965. .B basic
  3966. Handle only BT.601\->BT.709 mangling, if the subtitles seem to
  3967. indicate that this is required (default).
  3968. .TP
  3969. .B full
  3970. Handle the full \fBYCbCr Matrix\fP header with all video color spaces
  3971. supported by libass and mpv. This might lead to bad breakages in
  3972. corner cases and is not strictly needed for compatibility
  3973. (hopefully), which is why this is not default.
  3974. .TP
  3975. .B force\-601
  3976. Force BT.601\->BT.709 mangling, regardless of subtitle headers
  3977. or video color space.
  3978. .TP
  3979. .B no
  3980. Disable color mangling completely. All colors are RGB.
  3981. .UNINDENT
  3982. .sp
  3983. Choosing anything other than \fBno\fP will make the subtitle color depend on
  3984. the video color space, and it\(aqs for example in theory not possible to reuse
  3985. a subtitle script with another video file. The \fB\-\-sub\-ass\-override\fP
  3986. option doesn\(aqt affect how this option is interpreted.
  3987. .TP
  3988. .B \fB\-\-stretch\-dvd\-subs=<yes|no>\fP
  3989. Stretch DVD subtitles when playing anamorphic videos for better looking
  3990. fonts on badly mastered DVDs. This switch has no effect when the
  3991. video is stored with square pixels \- which for DVD input cannot be the case
  3992. though.
  3993. .sp
  3994. Many studios tend to use bitmap fonts designed for square pixels when
  3995. authoring DVDs, causing the fonts to look stretched on playback on DVD
  3996. players. This option fixes them, however at the price of possibly
  3997. misaligning some subtitles (e.g. sign translations).
  3998. .sp
  3999. Disabled by default.
  4000. .TP
  4001. .B \fB\-\-stretch\-image\-subs\-to\-screen=<yes|no>\fP
  4002. Stretch DVD and other image subtitles to the screen, ignoring the video
  4003. margins. This has a similar effect as \fB\-\-sub\-use\-margins\fP for text
  4004. subtitles, except that the text itself will be stretched, not only just
  4005. repositioned. (At least in general it is unavoidable, as an image bitmap
  4006. can in theory consist of a single bitmap covering the whole screen, and
  4007. the player won\(aqt know where exactly the text parts are located.)
  4008. .sp
  4009. This option does not display subtitles correctly. Use with care.
  4010. .sp
  4011. Disabled by default.
  4012. .TP
  4013. .B \fB\-\-image\-subs\-video\-resolution=<yes|no>\fP
  4014. Override the image subtitle resolution with the video resolution
  4015. (default: no). Normally, the subtitle canvas is fit into the video canvas
  4016. (e.g. letterboxed). Setting this option uses the video size as subtitle
  4017. canvas size. Can be useful to test broken subtitles, which often happen
  4018. when the video was trancoded, while attempting to keep the old subtitles.
  4019. .TP
  4020. .B \fB\-\-sub\-ass\fP, \fB\-\-no\-sub\-ass\fP
  4021. Render ASS subtitles natively (enabled by default).
  4022. .sp
  4023. \fBNOTE:\fP
  4024. .INDENT 7.0
  4025. .INDENT 3.5
  4026. This has been deprecated by \fB\-\-sub\-ass\-override=strip\fP\&. You also
  4027. may need \fB\-\-embeddedfonts=no\fP to get the same behavior. Also,
  4028. using \fB\-\-sub\-ass\-override=style\fP should give better results
  4029. without breaking subtitles too much.
  4030. .UNINDENT
  4031. .UNINDENT
  4032. .sp
  4033. If \fB\-\-no\-sub\-ass\fP is specified, all tags and style declarations are
  4034. stripped and ignored on display. The subtitle renderer uses the font style
  4035. as specified by the \fB\-\-sub\-\fP options instead.
  4036. .sp
  4037. \fBNOTE:\fP
  4038. .INDENT 7.0
  4039. .INDENT 3.5
  4040. Using \fB\-\-no\-sub\-ass\fP may lead to incorrect or completely broken
  4041. rendering of ASS/SSA subtitles. It can sometimes be useful to forcibly
  4042. override the styling of ASS subtitles, but should be avoided in general.
  4043. .UNINDENT
  4044. .UNINDENT
  4045. .TP
  4046. .B \fB\-\-sub\-auto=<no|exact|fuzzy|all>\fP, \fB\-\-no\-sub\-auto\fP
  4047. Load additional subtitle files matching the video filename. The parameter
  4048. specifies how external subtitle files are matched. \fBexact\fP is enabled by
  4049. default.
  4050. .INDENT 7.0
  4051. .TP
  4052. .B no
  4053. Don\(aqt automatically load external subtitle files.
  4054. .TP
  4055. .B exact
  4056. Load the media filename with subtitle file extension (default).
  4057. .TP
  4058. .B fuzzy
  4059. Load all subs containing media filename.
  4060. .TP
  4061. .B all
  4062. Load all subs in the current and \fB\-\-sub\-file\-paths\fP directories.
  4063. .UNINDENT
  4064. .TP
  4065. .B \fB\-\-sub\-codepage=<codepage>\fP
  4066. You can use this option to specify the subtitle codepage. uchardet will be
  4067. used to guess the charset. (If mpv was not compiled with uchardet, then
  4068. \fButf\-8\fP is the effective default.)
  4069. .sp
  4070. The default value for this option is \fBauto\fP, which enables autodetection.
  4071. .sp
  4072. The following steps are taken to determine the final codepage, in order:
  4073. .INDENT 7.0
  4074. .IP \(bu 2
  4075. if the specific codepage has a \fB+\fP, use that codepage
  4076. .IP \(bu 2
  4077. if the data looks like UTF\-8, assume it is UTF\-8
  4078. .IP \(bu 2
  4079. if \fB\-\-sub\-codepage\fP is set to a specific codepage, use that
  4080. .IP \(bu 2
  4081. run uchardet, and if successful, use that
  4082. .IP \(bu 2
  4083. otherwise, use \fBUTF\-8\-BROKEN\fP
  4084. .UNINDENT
  4085. .INDENT 7.0
  4086. .INDENT 3.5
  4087. .IP "Examples"
  4088. .INDENT 0.0
  4089. .IP \(bu 2
  4090. \fB\-\-sub\-codepage=latin2\fP Use Latin 2 if input is not UTF\-8.
  4091. .IP \(bu 2
  4092. \fB\-\-sub\-codepage=+cp1250\fP Always force recoding to cp1250.
  4093. .UNINDENT
  4094. .UNINDENT
  4095. .UNINDENT
  4096. .sp
  4097. The pseudo codepage \fBUTF\-8\-BROKEN\fP is used internally. If it\(aqs set,
  4098. subtitles are interpreted as UTF\-8 with "Latin 1" as fallback for bytes
  4099. which are not valid UTF\-8 sequences. iconv is never involved in this mode.
  4100. .sp
  4101. This option changed in mpv 0.23.0. Support for the old syntax was fully
  4102. removed in mpv 0.24.0.
  4103. .TP
  4104. .B \fB\-\-sub\-fix\-timing=<yes|no>\fP
  4105. Adjust subtitle timing is to remove minor gaps or overlaps between
  4106. subtitles (if the difference is smaller than 210 ms, the gap or overlap
  4107. is removed).
  4108. .TP
  4109. .B \fB\-\-sub\-forced\-only\fP
  4110. Display only forced subtitles for the DVD subtitle stream selected by e.g.
  4111. \fB\-\-slang\fP\&.
  4112. .TP
  4113. .B \fB\-\-sub\-fps=<rate>\fP
  4114. Specify the framerate of the subtitle file (default: video fps). Affects
  4115. text subtitles only.
  4116. .sp
  4117. \fBNOTE:\fP
  4118. .INDENT 7.0
  4119. .INDENT 3.5
  4120. \fB<rate>\fP > video fps speeds the subtitles up for frame\-based
  4121. subtitle files and slows them down for time\-based ones.
  4122. .UNINDENT
  4123. .UNINDENT
  4124. .sp
  4125. See also: \fB\-\-sub\-speed\fP\&.
  4126. .TP
  4127. .B \fB\-\-sub\-gauss=<0.0\-3.0>\fP
  4128. Apply Gaussian blur to image subtitles (default: 0). This can help to make
  4129. pixelated DVD/Vobsubs look nicer. A value other than 0 also switches to
  4130. software subtitle scaling. Might be slow.
  4131. .sp
  4132. \fBNOTE:\fP
  4133. .INDENT 7.0
  4134. .INDENT 3.5
  4135. Never applied to text subtitles.
  4136. .UNINDENT
  4137. .UNINDENT
  4138. .TP
  4139. .B \fB\-\-sub\-gray\fP
  4140. Convert image subtitles to grayscale. Can help to make yellow DVD/Vobsubs
  4141. look nicer.
  4142. .sp
  4143. \fBNOTE:\fP
  4144. .INDENT 7.0
  4145. .INDENT 3.5
  4146. Never applied to text subtitles.
  4147. .UNINDENT
  4148. .UNINDENT
  4149. .TP
  4150. .B \fB\-\-sub\-paths=<path1:path2:...>\fP
  4151. Deprecated, use \fB\-\-sub\-file\-paths\fP\&.
  4152. .TP
  4153. .B \fB\-\-sub\-file\-paths=<path\-list>\fP
  4154. Specify extra directories to search for subtitles matching the video.
  4155. Multiple directories can be separated by ":" (";" on Windows).
  4156. Paths can be relative or absolute. Relative paths are interpreted relative
  4157. to video file directory.
  4158. If the file is a URL, only absolute paths and \fBsub\fP configuration
  4159. subdirectory will be scanned.
  4160. .INDENT 7.0
  4161. .INDENT 3.5
  4162. .IP "Example"
  4163. .sp
  4164. Assuming that \fB/path/to/video/video.avi\fP is played and
  4165. \fB\-\-sub\-file\-paths=sub:subtitles\fP is specified, mpv
  4166. searches for subtitle files in these directories:
  4167. .INDENT 0.0
  4168. .IP \(bu 2
  4169. \fB/path/to/video/\fP
  4170. .IP \(bu 2
  4171. \fB/path/to/video/sub/\fP
  4172. .IP \(bu 2
  4173. \fB/path/to/video/subtitles/\fP
  4174. .IP \(bu 2
  4175. the \fBsub\fP configuration subdirectory (usually \fB~/.config/mpv/sub/\fP)
  4176. .UNINDENT
  4177. .UNINDENT
  4178. .UNINDENT
  4179. .sp
  4180. This is a path list option. See \fI\%List Options\fP for details.
  4181. .TP
  4182. .B \fB\-\-sub\-visibility\fP, \fB\-\-no\-sub\-visibility\fP
  4183. Can be used to disable display of subtitles, but still select and decode
  4184. them.
  4185. .TP
  4186. .B \fB\-\-sub\-clear\-on\-seek\fP
  4187. (Obscure, rarely useful.) Can be used to play broken mkv files with
  4188. duplicate ReadOrder fields. ReadOrder is the first field in a
  4189. Matroska\-style ASS subtitle packets. It should be unique, and libass
  4190. uses it for fast elimination of duplicates. This option disables caching
  4191. of subtitles across seeks, so after a seek libass can\(aqt eliminate subtitle
  4192. packets with the same ReadOrder as earlier packets.
  4193. .TP
  4194. .B \fB\-\-teletext\-page=<1\-999>\fP
  4195. This works for \fBdvb_teletext\fP subtitle streams, and if FFmpeg has been
  4196. compiled with support for it.
  4197. .TP
  4198. .B \fB\-\-sub\-font=<name>\fP
  4199. Specify font to use for subtitles that do not themselves
  4200. specify a particular font. The default is \fBsans\-serif\fP\&.
  4201. .INDENT 7.0
  4202. .INDENT 3.5
  4203. .IP "Examples"
  4204. .INDENT 0.0
  4205. .IP \(bu 2
  4206. \fB\-\-sub\-font=\(aqBitstream Vera Sans\(aq\fP
  4207. .IP \(bu 2
  4208. \fB\-\-sub\-font=\(aqComic Sans MS\(aq\fP
  4209. .UNINDENT
  4210. .UNINDENT
  4211. .UNINDENT
  4212. .sp
  4213. \fBNOTE:\fP
  4214. .INDENT 7.0
  4215. .INDENT 3.5
  4216. The \fB\-\-sub\-font\fP option (and many other style related \fB\-\-sub\-\fP
  4217. options) are ignored when ASS\-subtitles are rendered, unless the
  4218. \fB\-\-no\-sub\-ass\fP option is specified.
  4219. .sp
  4220. This used to support fontconfig patterns. Starting with libass 0.13.0,
  4221. this stopped working.
  4222. .UNINDENT
  4223. .UNINDENT
  4224. .TP
  4225. .B \fB\-\-sub\-font\-size=<size>\fP
  4226. Specify the sub font size. The unit is the size in scaled pixels at a
  4227. window height of 720. The actual pixel size is scaled with the window
  4228. height: if the window height is larger or smaller than 720, the actual size
  4229. of the text increases or decreases as well.
  4230. .sp
  4231. Default: 55.
  4232. .TP
  4233. .B \fB\-\-sub\-back\-color=<color>\fP
  4234. See \fB\-\-sub\-color\fP\&. Color used for sub text background. You can use
  4235. \fB\-\-sub\-shadow\-offset\fP to change its size relative to the text.
  4236. .TP
  4237. .B \fB\-\-sub\-blur=<0..20.0>\fP
  4238. Gaussian blur factor. 0 means no blur applied (default).
  4239. .TP
  4240. .B \fB\-\-sub\-bold=<yes|no>\fP
  4241. Format text on bold.
  4242. .TP
  4243. .B \fB\-\-sub\-italic=<yes|no>\fP
  4244. Format text on italic.
  4245. .TP
  4246. .B \fB\-\-sub\-border\-color=<color>\fP
  4247. See \fB\-\-sub\-color\fP\&. Color used for the sub font border.
  4248. .sp
  4249. \fBNOTE:\fP
  4250. .INDENT 7.0
  4251. .INDENT 3.5
  4252. ignored when \fB\-\-sub\-back\-color\fP is
  4253. specified (or more exactly: when that option is not set to completely
  4254. transparent).
  4255. .UNINDENT
  4256. .UNINDENT
  4257. .TP
  4258. .B \fB\-\-sub\-border\-size=<size>\fP
  4259. Size of the sub font border in scaled pixels (see \fB\-\-sub\-font\-size\fP
  4260. for details). A value of 0 disables borders.
  4261. .sp
  4262. Default: 3.
  4263. .TP
  4264. .B \fB\-\-sub\-color=<color>\fP
  4265. Specify the color used for unstyled text subtitles.
  4266. .sp
  4267. The color is specified in the form \fBr/g/b\fP, where each color component
  4268. is specified as number in the range 0.0 to 1.0. It\(aqs also possible to
  4269. specify the transparency by using \fBr/g/b/a\fP, where the alpha value 0
  4270. means fully transparent, and 1.0 means opaque. If the alpha component is
  4271. not given, the color is 100% opaque.
  4272. .sp
  4273. Passing a single number to the option sets the sub to gray, and the form
  4274. \fBgray/a\fP lets you specify alpha additionally.
  4275. .INDENT 7.0
  4276. .INDENT 3.5
  4277. .IP "Examples"
  4278. .INDENT 0.0
  4279. .IP \(bu 2
  4280. \fB\-\-sub\-color=1.0/0.0/0.0\fP set sub to opaque red
  4281. .IP \(bu 2
  4282. \fB\-\-sub\-color=1.0/0.0/0.0/0.75\fP set sub to opaque red with 75% alpha
  4283. .IP \(bu 2
  4284. \fB\-\-sub\-color=0.5/0.75\fP set sub to 50% gray with 75% alpha
  4285. .UNINDENT
  4286. .UNINDENT
  4287. .UNINDENT
  4288. .sp
  4289. Alternatively, the color can be specified as a RGB hex triplet in the form
  4290. \fB#RRGGBB\fP, where each 2\-digit group expresses a color value in the
  4291. range 0 (\fB00\fP) to 255 (\fBFF\fP). For example, \fB#FF0000\fP is red.
  4292. This is similar to web colors. Alpha is given with \fB#AARRGGBB\fP\&.
  4293. .INDENT 7.0
  4294. .INDENT 3.5
  4295. .IP "Examples"
  4296. .INDENT 0.0
  4297. .IP \(bu 2
  4298. \fB\-\-sub\-color=\(aq#FF0000\(aq\fP set sub to opaque red
  4299. .IP \(bu 2
  4300. \fB\-\-sub\-color=\(aq#C0808080\(aq\fP set sub to 50% gray with 75% alpha
  4301. .UNINDENT
  4302. .UNINDENT
  4303. .UNINDENT
  4304. .TP
  4305. .B \fB\-\-sub\-margin\-x=<size>\fP
  4306. Left and right screen margin for the subs in scaled pixels (see
  4307. \fB\-\-sub\-font\-size\fP for details).
  4308. .sp
  4309. This option specifies the distance of the sub to the left, as well as at
  4310. which distance from the right border long sub text will be broken.
  4311. .sp
  4312. Default: 25.
  4313. .TP
  4314. .B \fB\-\-sub\-margin\-y=<size>\fP
  4315. Top and bottom screen margin for the subs in scaled pixels (see
  4316. \fB\-\-sub\-font\-size\fP for details).
  4317. .sp
  4318. This option specifies the vertical margins of unstyled text subtitles.
  4319. If you just want to raise the vertical subtitle position, use \fB\-\-sub\-pos\fP\&.
  4320. .sp
  4321. Default: 22.
  4322. .TP
  4323. .B \fB\-\-sub\-align\-x=<left|center|right>\fP
  4324. Control to which corner of the screen text subtitles should be
  4325. aligned to (default: \fBcenter\fP).
  4326. .sp
  4327. Never applied to ASS subtitles, except in \fB\-\-no\-sub\-ass\fP mode. Likewise,
  4328. this does not apply to image subtitles.
  4329. .TP
  4330. .B \fB\-\-sub\-align\-y=<top|center|bottom>\fP
  4331. Vertical position (default: \fBbottom\fP).
  4332. Details see \fB\-\-sub\-align\-x\fP\&.
  4333. .TP
  4334. .B \fB\-\-sub\-justify=<auto|left|center|right>\fP
  4335. Control how multi line subs are justified irrespective of where they
  4336. are aligned (default: \fBauto\fP which justifies as defined by
  4337. \fB\-\-sub\-align\-y\fP).
  4338. Left justification is recommended to make the subs easier to read
  4339. as it is easier for the eyes.
  4340. .TP
  4341. .B \fB\-\-sub\-ass\-justify=<yes|no>\fP
  4342. Applies justification as defined by \fB\-\-sub\-justify\fP on ASS subtitles
  4343. if \fB\-\-sub\-ass\-override\fP is not set to \fBno\fP\&.
  4344. Default: \fBno\fP\&.
  4345. .TP
  4346. .B \fB\-\-sub\-shadow\-color=<color>\fP
  4347. See \fB\-\-sub\-color\fP\&. Color used for sub text shadow.
  4348. .TP
  4349. .B \fB\-\-sub\-shadow\-offset=<size>\fP
  4350. Displacement of the sub text shadow in scaled pixels (see
  4351. \fB\-\-sub\-font\-size\fP for details). A value of 0 disables shadows.
  4352. .sp
  4353. Default: 0.
  4354. .TP
  4355. .B \fB\-\-sub\-spacing=<size>\fP
  4356. Horizontal sub font spacing in scaled pixels (see \fB\-\-sub\-font\-size\fP
  4357. for details). This value is added to the normal letter spacing. Negative
  4358. values are allowed.
  4359. .sp
  4360. Default: 0.
  4361. .TP
  4362. .B \fB\-\-sub\-filter\-sdh=<yes|no>\fP
  4363. Applies filter removing subtitle additions for the deaf or hard\-of\-hearing (SDH).
  4364. This is intended for English, but may in part work for other languages too.
  4365. The intention is that it can be always enabled so may not remove
  4366. all parts added.
  4367. It removes speaker labels (like MAN:), upper case text in parentheses and
  4368. any text in brackets.
  4369. .sp
  4370. Default: \fBno\fP\&.
  4371. .TP
  4372. .B \fB\-\-sub\-filter\-sdh\-harder=<yes|no>\fP
  4373. Do harder SDH filtering (if enabled by \fB\-\-sub\-filter\-sdh\fP).
  4374. Will also remove speaker labels and text within parentheses using both
  4375. lower and upper case letters.
  4376. .sp
  4377. Default: \fBno\fP\&.
  4378. .TP
  4379. .B \fB\-\-sub\-create\-cc\-track=<yes|no>\fP
  4380. For every video stream, create a closed captions track (default: no). The
  4381. only purpose is to make the track available for selection at the start of
  4382. playback, instead of creating it lazily. This applies only to
  4383. \fBATSC A53 Part 4 Closed Captions\fP (displayed by mpv as subtitle tracks
  4384. using the codec \fBeia_608\fP). The CC track is marked "default" and selected
  4385. according to the normal subtitle track selection rules. You can then use
  4386. \fB\-\-sid\fP to explicitly select the correct track too.
  4387. .sp
  4388. If the video stream contains no closed captions, or if no video is being
  4389. decoded, the CC track will remain empty and will not show any text.
  4390. .TP
  4391. .B \fB\-\-sub\-font\-provider=<auto|none|fontconfig>\fP
  4392. Which libass font provider backend to use (default: auto). \fBauto\fP will
  4393. attempt to use the native font provider: fontconfig on Linux, CoreText on
  4394. OSX, DirectWrite on Windows. \fBfontconfig\fP forces fontconfig, if libass
  4395. was built with support (if not, it behaves like \fBnone\fP).
  4396. .sp
  4397. The \fBnone\fP font provider effectively disables system fonts. It will still
  4398. attempt to use embedded fonts (unless \fB\-\-embeddedfonts=no\fP is set; this is
  4399. the same behavior as with all other font providers), \fBsubfont.ttf\fP if
  4400. provided, and fonts in  the \fBfonts\fP sub\-directory if provided. (The
  4401. fallback is more strict than that of other font providers, and if a font
  4402. name does not match, it may prefer not to render any text that uses the
  4403. missing font.)
  4404. .UNINDENT
  4405. .SS Window
  4406. .INDENT 0.0
  4407. .TP
  4408. .B \fB\-\-title=<string>\fP
  4409. Set the window title. This is used for the video window, and if possible,
  4410. also sets the audio stream title.
  4411. .sp
  4412. Properties are expanded. (See \fI\%Property Expansion\fP\&.)
  4413. .sp
  4414. \fBWARNING:\fP
  4415. .INDENT 7.0
  4416. .INDENT 3.5
  4417. There is a danger of this causing significant CPU usage, depending on
  4418. the properties used. Changing the window title is often a slow
  4419. operation, and if the title changes every frame, playback can be ruined.
  4420. .UNINDENT
  4421. .UNINDENT
  4422. .TP
  4423. .B \fB\-\-screen=<default|0\-32>\fP
  4424. In multi\-monitor configurations (i.e. a single desktop that spans across
  4425. multiple displays), this option tells mpv which screen to display the
  4426. video on.
  4427. .INDENT 7.0
  4428. .INDENT 3.5
  4429. .IP "Note (X11)"
  4430. .sp
  4431. This option does not work properly with all window managers. In these
  4432. cases, you can try to use \fB\-\-geometry\fP to position the window
  4433. explicitly. It\(aqs also possible that the window manager provides native
  4434. features to control which screens application windows should use.
  4435. .UNINDENT
  4436. .UNINDENT
  4437. .sp
  4438. See also \fB\-\-fs\-screen\fP\&.
  4439. .TP
  4440. .B \fB\-\-fullscreen\fP, \fB\-\-fs\fP
  4441. Fullscreen playback.
  4442. .TP
  4443. .B \fB\-\-fs\-screen=<all|current|0\-32>\fP
  4444. In multi\-monitor configurations (i.e. a single desktop that spans across
  4445. multiple displays), this option tells mpv which screen to go fullscreen to.
  4446. If \fBcurrent\fP is used mpv will fallback on what the user provided with
  4447. the \fBscreen\fP option.
  4448. .INDENT 7.0
  4449. .INDENT 3.5
  4450. .IP "Note (X11)"
  4451. .sp
  4452. This option works properly only with window managers which
  4453. understand the EWMH \fB_NET_WM_FULLSCREEN_MONITORS\fP hint.
  4454. .UNINDENT
  4455. .UNINDENT
  4456. .INDENT 7.0
  4457. .INDENT 3.5
  4458. .IP "Note (OS X)"
  4459. .sp
  4460. \fBall\fP does not work on OS X and will behave like \fBcurrent\fP\&.
  4461. .UNINDENT
  4462. .UNINDENT
  4463. .sp
  4464. See also \fB\-\-screen\fP\&.
  4465. .TP
  4466. .B \fB\-\-keep\-open=<yes|no|always>\fP
  4467. Do not terminate when playing or seeking beyond the end of the file, and
  4468. there is not next file to be played (and \fB\-\-loop\fP is not used).
  4469. Instead, pause the player. When trying to seek beyond end of the file, the
  4470. player will attempt to seek to the last frame.
  4471. .sp
  4472. Normally, this will act like \fBset pause yes\fP on EOF, unless the
  4473. \fB\-\-keep\-open\-pause=no\fP option is set.
  4474. .sp
  4475. The following arguments can be given:
  4476. .INDENT 7.0
  4477. .TP
  4478. .B no
  4479. If the current file ends, go to the next file or terminate.
  4480. (Default.)
  4481. .TP
  4482. .B yes
  4483. Don\(aqt terminate if the current file is the last playlist entry.
  4484. Equivalent to \fB\-\-keep\-open\fP without arguments.
  4485. .TP
  4486. .B always
  4487. Like \fByes\fP, but also applies to files before the last playlist
  4488. entry. This means playback will never automatically advance to
  4489. the next file.
  4490. .UNINDENT
  4491. .sp
  4492. \fBNOTE:\fP
  4493. .INDENT 7.0
  4494. .INDENT 3.5
  4495. This option is not respected when using \fB\-\-frames\fP\&. Explicitly
  4496. skipping to the next file if the binding uses \fBforce\fP will terminate
  4497. playback as well.
  4498. .sp
  4499. Also, if errors or unusual circumstances happen, the player can quit
  4500. anyway.
  4501. .UNINDENT
  4502. .UNINDENT
  4503. .sp
  4504. Since mpv 0.6.0, this doesn\(aqt pause if there is a next file in the playlist,
  4505. or the playlist is looped. Approximately, this will pause when the player
  4506. would normally exit, but in practice there are corner cases in which this
  4507. is not the case (e.g. \fBmpv \-\-keep\-open file.mkv /dev/null\fP will play
  4508. file.mkv normally, then fail to open \fB/dev/null\fP, then exit). (In
  4509. mpv 0.8.0, \fBalways\fP was introduced, which restores the old behavior.)
  4510. .TP
  4511. .B \fB\-\-keep\-open\-pause=<yes|no>\fP
  4512. If set to \fBno\fP, instead of pausing when \fB\-\-keep\-open\fP is active, just
  4513. stop at end of file and continue playing forward when you seek backwards
  4514. until end where it stops again. Default: \fByes\fP\&.
  4515. .TP
  4516. .B \fB\-\-image\-display\-duration=<seconds|inf>\fP
  4517. If the current file is an image, play the image for the given amount of
  4518. seconds (default: 1). \fBinf\fP means the file is kept open forever (until
  4519. the user stops playback manually).
  4520. .sp
  4521. Unlike \fB\-\-keep\-open\fP, the player is not paused, but simply continues
  4522. playback until the time has elapsed. (It should not use any resources
  4523. during "playback".)
  4524. .sp
  4525. This affects image files, which are defined as having only 1 video frame
  4526. and no audio. The player may recognize certain non\-images as images, for
  4527. example if \fB\-\-length\fP is used to reduce the length to 1 frame, or if
  4528. you seek to the last frame.
  4529. .sp
  4530. This option does not affect the framerate used for \fBmf://\fP or
  4531. \fB\-\-merge\-files\fP\&. For that, use \fB\-\-mf\-fps\fP instead.
  4532. .sp
  4533. Setting \fB\-\-image\-display\-duration\fP hides the OSC and does not track
  4534. playback time on the command\-line output, and also does not duplicate
  4535. the image frame when encoding. To force the player into "dumb mode"
  4536. and actually count out seconds, or to duplicate the image when
  4537. encoding, you need to use \fB\-\-demuxer=lavf \-\-demuxer\-lavf\-o=loop=1\fP,
  4538. and use \fB\-\-length\fP or \fB\-\-frames\fP to stop after a particular time.
  4539. .TP
  4540. .B \fB\-\-force\-window=<yes|no|immediate>\fP
  4541. Create a video output window even if there is no video. This can be useful
  4542. when pretending that mpv is a GUI application. Currently, the window
  4543. always has the size 640x480, and is subject to \fB\-\-geometry\fP,
  4544. \fB\-\-autofit\fP, and similar options.
  4545. .sp
  4546. \fBWARNING:\fP
  4547. .INDENT 7.0
  4548. .INDENT 3.5
  4549. The window is created only after initialization (to make sure default
  4550. window placement still works if the video size is different from the
  4551. \fB\-\-force\-window\fP default window size). This can be a problem if
  4552. initialization doesn\(aqt work perfectly, such as when opening URLs with
  4553. bad network connection, or opening broken video files. The \fBimmediate\fP
  4554. mode can be used to create the window always on program start, but this
  4555. may cause other issues.
  4556. .UNINDENT
  4557. .UNINDENT
  4558. .TP
  4559. .B \fB\-\-taskbar\-progress\fP, \fB\-\-no\-taskbar\-progress\fP
  4560. (Windows only)
  4561. Enable/disable playback progress rendering in taskbar (Windows 7 and above).
  4562. .sp
  4563. Enabled by default.
  4564. .TP
  4565. .B \fB\-\-snap\-window\fP
  4566. (Windows only) Snap the player window to screen edges.
  4567. .TP
  4568. .B \fB\-\-ontop\fP
  4569. Makes the player window stay on top of other windows.
  4570. .sp
  4571. On Windows, if combined with fullscreen mode, this causes mpv to be
  4572. treated as exclusive fullscreen window that bypasses the Desktop Window
  4573. Manager.
  4574. .TP
  4575. .B \fB\-\-ontop\-level=<window|system|level>\fP
  4576. (OS X only)
  4577. Sets the level of an ontop window (default: window).
  4578. .INDENT 7.0
  4579. .TP
  4580. .B window
  4581. On top of all other windows.
  4582. .TP
  4583. .B system
  4584. On top of system elements like Taskbar, Menubar and Dock.
  4585. .TP
  4586. .B level
  4587. A level as integer.
  4588. .UNINDENT
  4589. .TP
  4590. .B \fB\-\-border\fP, \fB\-\-no\-border\fP
  4591. Play video with window border and decorations. Since this is on by
  4592. default, use \fB\-\-no\-border\fP to disable the standard window decorations.
  4593. .TP
  4594. .B \fB\-\-fit\-border\fP, \fB\-\-no\-fit\-border\fP
  4595. (Windows only) Fit the whole window with border and decorations on the
  4596. screen. Since this is on by default, use \fB\-\-no\-fit\-border\fP to make mpv
  4597. try to only fit client area with video on the screen. This behavior only
  4598. applied to window/video with size exceeding size of the screen.
  4599. .TP
  4600. .B \fB\-\-on\-all\-workspaces\fP
  4601. (X11 only)
  4602. Show the video window on all virtual desktops.
  4603. .TP
  4604. .B \fB\-\-geometry=<[W[xH]][+\-x+\-y]>\fP, \fB\-\-geometry=<x:y>\fP
  4605. Adjust the initial window position or size. \fBW\fP and \fBH\fP set the window
  4606. size in pixels. \fBx\fP and \fBy\fP set the window position, measured in pixels
  4607. from the top\-left corner of the screen to the top\-left corner of the image
  4608. being displayed. If a percentage sign (\fB%\fP) is given after the argument,
  4609. it turns the value into a percentage of the screen size in that direction.
  4610. Positions are specified similar to the standard X11 \fB\-\-geometry\fP option
  4611. format, in which e.g. +10\-50 means "place 10 pixels from the left border and
  4612. 50 pixels from the lower border" and "\-\-20+\-10" means "place 20 pixels
  4613. beyond the right and 10 pixels beyond the top border".
  4614. .sp
  4615. If an external window is specified using the \fB\-\-wid\fP option, this
  4616. option is ignored.
  4617. .sp
  4618. The coordinates are relative to the screen given with \fB\-\-screen\fP for the
  4619. video output drivers that fully support \fB\-\-screen\fP\&.
  4620. .sp
  4621. \fBNOTE:\fP
  4622. .INDENT 7.0
  4623. .INDENT 3.5
  4624. Generally only supported by GUI VOs. Ignored for encoding.
  4625. .UNINDENT
  4626. .UNINDENT
  4627. .\" admonition: Note (OS X)
  4628. .\" 
  4629. .\" On Mac OS X the origin of the screen coordinate system is located on the
  4630. .\" bottom-left corner. For instance, ``0:0`` will place the window at the
  4631. .\" bottom-left of the screen.
  4632. .
  4633. .INDENT 7.0
  4634. .INDENT 3.5
  4635. .IP "Note (X11)"
  4636. .sp
  4637. This option does not work properly with all window managers.
  4638. .UNINDENT
  4639. .UNINDENT
  4640. .INDENT 7.0
  4641. .INDENT 3.5
  4642. .IP "Examples"
  4643. .INDENT 0.0
  4644. .TP
  4645. .B \fB50:40\fP
  4646. Places the window at x=50, y=40.
  4647. .TP
  4648. .B \fB50%:50%\fP
  4649. Places the window in the middle of the screen.
  4650. .TP
  4651. .B \fB100%:100%\fP
  4652. Places the window at the bottom right corner of the screen.
  4653. .TP
  4654. .B \fB50%\fP
  4655. Sets the window width to half the screen width. Window height is set
  4656. so that the window has the video aspect ratio.
  4657. .TP
  4658. .B \fB50%x50%\fP
  4659. Forces the window width and height to half the screen width and
  4660. height. Will show black borders to compensate for the video aspect
  4661. ratio (with most VOs and without \fB\-\-no\-keepaspect\fP).
  4662. .TP
  4663. .B \fB50%+10+10\fP
  4664. Sets the window to half the screen widths, and positions it 10
  4665. pixels below/left of the top left corner of the screen.
  4666. .UNINDENT
  4667. .UNINDENT
  4668. .UNINDENT
  4669. .sp
  4670. See also \fB\-\-autofit\fP and \fB\-\-autofit\-larger\fP for fitting the window into
  4671. a given size without changing aspect ratio.
  4672. .TP
  4673. .B \fB\-\-autofit=<[W[xH]]>\fP
  4674. Set the initial window size to a maximum size specified by \fBWxH\fP, without
  4675. changing the window\(aqs aspect ratio. The size is measured in pixels, or if
  4676. a number is followed by a percentage sign (\fB%\fP), in percents of the
  4677. screen size.
  4678. .sp
  4679. This option never changes the aspect ratio of the window. If the aspect
  4680. ratio mismatches, the window\(aqs size is reduced until it fits into the
  4681. specified size.
  4682. .sp
  4683. Window position is not taken into account, nor is it modified by this
  4684. option (the window manager still may place the window differently depending
  4685. on size). Use \fB\-\-geometry\fP to change the window position. Its effects
  4686. are applied after this option.
  4687. .sp
  4688. See \fB\-\-geometry\fP for details how this is handled with multi\-monitor
  4689. setups.
  4690. .sp
  4691. Use \fB\-\-autofit\-larger\fP instead if you just want to limit the maximum size
  4692. of the window, rather than always forcing a window size.
  4693. .sp
  4694. Use \fB\-\-geometry\fP if you want to force both window width and height to a
  4695. specific size.
  4696. .sp
  4697. \fBNOTE:\fP
  4698. .INDENT 7.0
  4699. .INDENT 3.5
  4700. Generally only supported by GUI VOs. Ignored for encoding.
  4701. .UNINDENT
  4702. .UNINDENT
  4703. .INDENT 7.0
  4704. .INDENT 3.5
  4705. .IP "Examples"
  4706. .INDENT 0.0
  4707. .TP
  4708. .B \fB70%\fP
  4709. Make the window width 70% of the screen size, keeping aspect ratio.
  4710. .TP
  4711. .B \fB1000\fP
  4712. Set the window width to 1000 pixels, keeping aspect ratio.
  4713. .TP
  4714. .B \fB70%x60%\fP
  4715. Make the window as large as possible, without being wider than 70%
  4716. of the screen width, or higher than 60% of the screen height.
  4717. .UNINDENT
  4718. .UNINDENT
  4719. .UNINDENT
  4720. .TP
  4721. .B \fB\-\-autofit\-larger=<[W[xH]]>\fP
  4722. This option behaves exactly like \fB\-\-autofit\fP, except the window size is
  4723. only changed if the window would be larger than the specified size.
  4724. .INDENT 7.0
  4725. .INDENT 3.5
  4726. .IP "Example"
  4727. .INDENT 0.0
  4728. .TP
  4729. .B \fB90%x80%\fP
  4730. If the video is larger than 90% of the screen width or 80% of the
  4731. screen height, make the window smaller until either its width is 90%
  4732. of the screen, or its height is 80% of the screen.
  4733. .UNINDENT
  4734. .UNINDENT
  4735. .UNINDENT
  4736. .TP
  4737. .B \fB\-\-autofit\-smaller=<[W[xH]]>\fP
  4738. This option behaves exactly like \fB\-\-autofit\fP, except that it sets the
  4739. minimum size of the window (just as \fB\-\-autofit\-larger\fP sets the maximum).
  4740. .INDENT 7.0
  4741. .INDENT 3.5
  4742. .IP "Example"
  4743. .INDENT 0.0
  4744. .TP
  4745. .B \fB500x500\fP
  4746. Make the window at least 500 pixels wide and 500 pixels high
  4747. (depending on the video aspect ratio, the width or height will be
  4748. larger than 500 in order to keep the aspect ratio the same).
  4749. .UNINDENT
  4750. .UNINDENT
  4751. .UNINDENT
  4752. .TP
  4753. .B \fB\-\-window\-scale=<factor>\fP
  4754. Resize the video window to a multiple (or fraction) of the video size. This
  4755. option is applied before \fB\-\-autofit\fP and other options are applied (so
  4756. they override this option).
  4757. .sp
  4758. For example, \fB\-\-window\-scale=0.5\fP would show the window at half the
  4759. video size.
  4760. .TP
  4761. .B \fB\-\-window\-minimized=<yes|no>\fP
  4762. Whether the video window is minimized or not. Setting this will minimize,
  4763. or unminimze, the video window if the current VO supports it. Note that
  4764. some VOs may support minimization while not supporting unminimization
  4765. (eg: Wayland).
  4766. .sp
  4767. Whether this option and \fB\-\-window\-maximized\fP work on program start or
  4768. at runtime, and whether they\(aqre (at runtime) updated to reflect the actual
  4769. window state, heavily depends on the VO and the windowing system. Some VOs
  4770. simply do not implement them or parts of them, while other VOs may be
  4771. restricted by the windowing systems (especially Wayland).
  4772. .TP
  4773. .B \fB\-\-window\-maximized=<yes|no>\fP
  4774. Whether the video window is maximized or not. Setting this will maximize,
  4775. or unmaximize, the video window if the current VO supports it. See
  4776. \fB\-\-window\-minimized\fP for further remarks.
  4777. .TP
  4778. .B \fB\-\-cursor\-autohide=<number|no|always>\fP
  4779. Make mouse cursor automatically hide after given number of milliseconds.
  4780. \fBno\fP will disable cursor autohide. \fBalways\fP means the cursor will stay
  4781. hidden.
  4782. .TP
  4783. .B \fB\-\-cursor\-autohide\-fs\-only\fP
  4784. If this option is given, the cursor is always visible in windowed mode. In
  4785. fullscreen mode, the cursor is shown or hidden according to
  4786. \fB\-\-cursor\-autohide\fP\&.
  4787. .TP
  4788. .B \fB\-\-no\-fixed\-vo\fP, \fB\-\-fixed\-vo\fP
  4789. \fB\-\-no\-fixed\-vo\fP enforces closing and reopening the video window for
  4790. multiple files (one (un)initialization for each file).
  4791. .TP
  4792. .B \fB\-\-force\-rgba\-osd\-rendering\fP
  4793. Change how some video outputs render the OSD and text subtitles. This
  4794. does not change appearance of the subtitles and only has performance
  4795. implications. For VOs which support native ASS rendering (like \fBgpu\fP,
  4796. \fBvdpau\fP, \fBdirect3d\fP), this can be slightly faster or slower,
  4797. depending on GPU drivers and hardware. For other VOs, this just makes
  4798. rendering slower.
  4799. .TP
  4800. .B \fB\-\-force\-window\-position\fP
  4801. Forcefully move mpv\(aqs video output window to default location whenever
  4802. there is a change in video parameters, video stream or file. This used to
  4803. be the default behavior. Currently only affects X11 VOs.
  4804. .TP
  4805. .B \fB\-\-no\-keepaspect\fP, \fB\-\-keepaspect\fP
  4806. \fB\-\-no\-keepaspect\fP will always stretch the video to window size, and will
  4807. disable the window manager hints that force the window aspect ratio.
  4808. (Ignored in fullscreen mode.)
  4809. .TP
  4810. .B \fB\-\-no\-keepaspect\-window\fP, \fB\-\-keepaspect\-window\fP
  4811. \fB\-\-keepaspect\-window\fP (the default) will lock the window size to the
  4812. video aspect. \fB\-\-no\-keepaspect\-window\fP disables this behavior, and will
  4813. instead add black bars if window aspect and video aspect mismatch. Whether
  4814. this actually works depends on the VO backend.
  4815. (Ignored in fullscreen mode.)
  4816. .TP
  4817. .B \fB\-\-monitoraspect=<ratio>\fP
  4818. Set the aspect ratio of your monitor or TV screen. A value of 0 disables a
  4819. previous setting (e.g. in the config file). Overrides the
  4820. \fB\-\-monitorpixelaspect\fP setting if enabled.
  4821. .sp
  4822. See also \fB\-\-monitorpixelaspect\fP and \fB\-\-video\-aspect\-override\fP\&.
  4823. .INDENT 7.0
  4824. .INDENT 3.5
  4825. .IP "Examples"
  4826. .INDENT 0.0
  4827. .IP \(bu 2
  4828. \fB\-\-monitoraspect=4:3\fP  or \fB\-\-monitoraspect=1.3333\fP
  4829. .IP \(bu 2
  4830. \fB\-\-monitoraspect=16:9\fP or \fB\-\-monitoraspect=1.7777\fP
  4831. .UNINDENT
  4832. .UNINDENT
  4833. .UNINDENT
  4834. .TP
  4835. .B \fB\-\-hidpi\-window\-scale\fP, \fB\-\-no\-hidpi\-window\-scale\fP
  4836. (OS X, X11, and Wayland only)
  4837. Scale the window size according to the backing scale factor (default: yes).
  4838. On regular HiDPI resolutions the window opens with double the size but appears
  4839. as having the same size as on none\-HiDPI resolutions. This is the default OS X
  4840. behavior.
  4841. .TP
  4842. .B \fB\-\-native\-fs\fP, \fB\-\-no\-native\-fs\fP
  4843. (OS X only)
  4844. Uses the native fullscreen mechanism of the OS (default: yes).
  4845. .TP
  4846. .B \fB\-\-monitorpixelaspect=<ratio>\fP
  4847. Set the aspect of a single pixel of your monitor or TV screen (default:
  4848. 1). A value of 1 means square pixels (correct for (almost?) all LCDs). See
  4849. also \fB\-\-monitoraspect\fP and \fB\-\-video\-aspect\-override\fP\&.
  4850. .TP
  4851. .B \fB\-\-stop\-screensaver\fP, \fB\-\-no\-stop\-screensaver\fP
  4852. Turns off the screensaver (or screen blanker and similar mechanisms) at
  4853. startup and turns it on again on exit (default: yes). The screensaver is
  4854. always re\-enabled when the player is paused.
  4855. .sp
  4856. This is not supported on all video outputs or platforms. Sometimes it is
  4857. implemented, but does not work (especially with Linux "desktops").
  4858. .TP
  4859. .B \fB\-\-wid=<ID>\fP
  4860. This tells mpv to attach to an existing window. If a VO is selected that
  4861. supports this option, it will use that window for video output. mpv will
  4862. scale the video to the size of this window, and will add black bars to
  4863. compensate if the aspect ratio of the video is different.
  4864. .sp
  4865. On X11, the ID is interpreted as a \fBWindow\fP on X11. Unlike
  4866. MPlayer/mplayer2, mpv always creates its own window, and sets the wid
  4867. window as parent. The window will always be resized to cover the parent
  4868. window fully. The value \fB0\fP is interpreted specially, and mpv will
  4869. draw directly on the root window.
  4870. .sp
  4871. On win32, the ID is interpreted as \fBHWND\fP\&. Pass it as value cast to
  4872. \fBintptr_t\fP\&. mpv will create its own window, and set the wid window as
  4873. parent, like with X11.
  4874. .sp
  4875. On OSX/Cocoa, the ID is interpreted as \fBNSView*\fP\&. Pass it as value cast
  4876. to \fBintptr_t\fP\&. mpv will create its own sub\-view. Because OSX does not
  4877. support window embedding of foreign processes, this works only with libmpv,
  4878. and will crash when used from the command line.
  4879. .sp
  4880. On Android, the ID is interpreted as \fBandroid.view.Surface\fP\&. Pass it as a
  4881. value cast to \fBintptr_t\fP\&. Use with \fB\-\-vo=mediacodec_embed\fP and
  4882. \fB\-\-hwdec=mediacodec\fP for direct rendering using MediaCodec, or with
  4883. \fB\-\-vo=gpu \-\-gpu\-context=android\fP (with or without \fB\-\-hwdec=mediacodec\-copy\fP).
  4884. .TP
  4885. .B \fB\-\-no\-window\-dragging\fP
  4886. Don\(aqt move the window when clicking on it and moving the mouse pointer.
  4887. .TP
  4888. .B \fB\-\-x11\-name\fP
  4889. Set the window class name for X11\-based video output methods.
  4890. .TP
  4891. .B \fB\-\-x11\-netwm=<yes|no|auto>\fP
  4892. (X11 only)
  4893. Control the use of NetWM protocol features.
  4894. .sp
  4895. This may or may not help with broken window managers. This provides some
  4896. functionality that was implemented by the now removed \fB\-\-fstype\fP option.
  4897. Actually, it is not known to the developers to which degree this option
  4898. was needed, so feedback is welcome.
  4899. .sp
  4900. Specifically, \fByes\fP will force use of NetWM fullscreen support, even if
  4901. not advertised by the WM. This can be useful for WMs that are broken on
  4902. purpose, like XMonad. (XMonad supposedly doesn\(aqt advertise fullscreen
  4903. support, because Flash uses it. Apparently, applications which want to
  4904. use fullscreen anyway are supposed to either ignore the NetWM support hints,
  4905. or provide a workaround. Shame on XMonad for deliberately breaking X
  4906. protocols (as if X isn\(aqt bad enough already).
  4907. .sp
  4908. By default, NetWM support is autodetected (\fBauto\fP).
  4909. .sp
  4910. This option might be removed in the future.
  4911. .TP
  4912. .B \fB\-\-x11\-bypass\-compositor=<yes|no|fs\-only|never>\fP
  4913. If set to \fByes\fP, then ask the compositor to unredirect the mpv window
  4914. (default: \fBfs\-only\fP). This uses the \fB_NET_WM_BYPASS_COMPOSITOR\fP hint.
  4915. .sp
  4916. \fBfs\-only\fP asks the window manager to disable the compositor only in
  4917. fullscreen mode.
  4918. .sp
  4919. \fBno\fP sets \fB_NET_WM_BYPASS_COMPOSITOR\fP to 0, which is the default value
  4920. as declared by the EWMH specification, i.e. no change is done.
  4921. .sp
  4922. \fBnever\fP asks the window manager to never disable the compositor.
  4923. .UNINDENT
  4924. .SS Disc Devices
  4925. .INDENT 0.0
  4926. .TP
  4927. .B \fB\-\-cdrom\-device=<path>\fP
  4928. Specify the CD\-ROM device (default: \fB/dev/cdrom\fP).
  4929. .TP
  4930. .B \fB\-\-dvd\-device=<path>\fP
  4931. Specify the DVD device or .iso filename (default: \fB/dev/dvd\fP). You can
  4932. also specify a directory that contains files previously copied directly
  4933. from a DVD (with e.g. vobcopy).
  4934. .INDENT 7.0
  4935. .INDENT 3.5
  4936. .IP "Example"
  4937. .sp
  4938. \fBmpv dvd:// \-\-dvd\-device=/path/to/dvd/\fP
  4939. .UNINDENT
  4940. .UNINDENT
  4941. .TP
  4942. .B \fB\-\-bluray\-device=<path>\fP
  4943. (Blu\-ray only)
  4944. Specify the Blu\-ray disc location. Must be a directory with Blu\-ray
  4945. structure.
  4946. .INDENT 7.0
  4947. .INDENT 3.5
  4948. .IP "Example"
  4949. .sp
  4950. \fBmpv bd:// \-\-bluray\-device=/path/to/bd/\fP
  4951. .UNINDENT
  4952. .UNINDENT
  4953. .TP
  4954. .B \fB\-\-cdda\-...\fP
  4955. These options can be used to tune the CD Audio reading feature of mpv.
  4956. .TP
  4957. .B \fB\-\-cdda\-speed=<value>\fP
  4958. Set CD spin speed.
  4959. .TP
  4960. .B \fB\-\-cdda\-paranoia=<0\-2>\fP
  4961. Set paranoia level. Values other than 0 seem to break playback of
  4962. anything but the first track.
  4963. .INDENT 7.0
  4964. .TP
  4965. .B 0
  4966. disable checking (default)
  4967. .TP
  4968. .B 1
  4969. overlap checking only
  4970. .TP
  4971. .B 2
  4972. full data correction and verification
  4973. .UNINDENT
  4974. .TP
  4975. .B \fB\-\-cdda\-sector\-size=<value>\fP
  4976. Set atomic read size.
  4977. .TP
  4978. .B \fB\-\-cdda\-overlap=<value>\fP
  4979. Force minimum overlap search during verification to <value> sectors.
  4980. .TP
  4981. .B \fB\-\-cdda\-toc\-bias\fP
  4982. Assume that the beginning offset of track 1 as reported in the TOC
  4983. will be addressed as LBA 0. Some discs need this for getting track
  4984. boundaries correctly.
  4985. .TP
  4986. .B \fB\-\-cdda\-toc\-offset=<value>\fP
  4987. Add \fB<value>\fP sectors to the values reported when addressing tracks.
  4988. May be negative.
  4989. .TP
  4990. .B \fB\-\-cdda\-skip=<yes|no>\fP
  4991. (Never) accept imperfect data reconstruction.
  4992. .TP
  4993. .B \fB\-\-cdda\-cdtext=<yes|no>\fP
  4994. Print CD text. This is disabled by default, because it ruins performance
  4995. with CD\-ROM drives for unknown reasons.
  4996. .TP
  4997. .B \fB\-\-dvd\-speed=<speed>\fP
  4998. Try to limit DVD speed (default: 0, no change). DVD base speed is 1385
  4999. kB/s, so an 8x drive can read at speeds up to 11080 kB/s. Slower speeds
  5000. make the drive more quiet. For watching DVDs, 2700 kB/s should be quiet and
  5001. fast enough. mpv resets the speed to the drive default value on close.
  5002. Values of at least 100 mean speed in kB/s. Values less than 100 mean
  5003. multiples of 1385 kB/s, i.e. \fB\-\-dvd\-speed=8\fP selects 11080 kB/s.
  5004. .sp
  5005. \fBNOTE:\fP
  5006. .INDENT 7.0
  5007. .INDENT 3.5
  5008. You need write access to the DVD device to change the speed.
  5009. .UNINDENT
  5010. .UNINDENT
  5011. .TP
  5012. .B \fB\-\-dvd\-angle=<ID>\fP
  5013. Some DVDs contain scenes that can be viewed from multiple angles.
  5014. This option tells mpv which angle to use (default: 1).
  5015. .UNINDENT
  5016. .SS Equalizer
  5017. .INDENT 0.0
  5018. .TP
  5019. .B \fB\-\-brightness=<\-100\-100>\fP
  5020. Adjust the brightness of the video signal (default: 0). Not supported by
  5021. all video output drivers.
  5022. .TP
  5023. .B \fB\-\-contrast=<\-100\-100>\fP
  5024. Adjust the contrast of the video signal (default: 0). Not supported by all
  5025. video output drivers.
  5026. .TP
  5027. .B \fB\-\-saturation=<\-100\-100>\fP
  5028. Adjust the saturation of the video signal (default: 0). You can get
  5029. grayscale output with this option. Not supported by all video output
  5030. drivers.
  5031. .TP
  5032. .B \fB\-\-gamma=<\-100\-100>\fP
  5033. Adjust the gamma of the video signal (default: 0). Not supported by all
  5034. video output drivers.
  5035. .TP
  5036. .B \fB\-\-hue=<\-100\-100>\fP
  5037. Adjust the hue of the video signal (default: 0). You can get a colored
  5038. negative of the image with this option. Not supported by all video output
  5039. drivers.
  5040. .UNINDENT
  5041. .SS Demuxer
  5042. .INDENT 0.0
  5043. .TP
  5044. .B \fB\-\-demuxer=<[+]name>\fP
  5045. Force demuxer type. Use a \(aq+\(aq before the name to force it; this will skip
  5046. some checks. Give the demuxer name as printed by \fB\-\-demuxer=help\fP\&.
  5047. .TP
  5048. .B \fB\-\-demuxer\-lavf\-analyzeduration=<value>\fP
  5049. Maximum length in seconds to analyze the stream properties.
  5050. .TP
  5051. .B \fB\-\-demuxer\-lavf\-probe\-info=<yes|no|auto|nostreams>\fP
  5052. Whether to probe stream information (default: auto). Technically, this
  5053. controls whether libavformat\(aqs \fBavformat_find_stream_info()\fP function
  5054. is called. Usually it\(aqs safer to call it, but it can also make startup
  5055. slower.
  5056. .sp
  5057. The \fBauto\fP choice (the default) tries to skip this for a few know\-safe
  5058. whitelisted formats, while calling it for everything else.
  5059. .sp
  5060. The \fBnostreams\fP choice only calls it if and only if the file seems to
  5061. contain no streams after opening (helpful in cases when calling the function
  5062. is needed to detect streams at all, such as with FLV files).
  5063. .TP
  5064. .B \fB\-\-demuxer\-lavf\-probescore=<1\-100>\fP
  5065. Minimum required libavformat probe score. Lower values will require
  5066. less data to be loaded (makes streams start faster), but makes file
  5067. format detection less reliable. Can be used to force auto\-detected
  5068. libavformat demuxers, even if libavformat considers the detection not
  5069. reliable enough. (Default: 26.)
  5070. .TP
  5071. .B \fB\-\-demuxer\-lavf\-allow\-mimetype=<yes|no>\fP
  5072. Allow deriving the format from the HTTP MIME type (default: yes). Set
  5073. this to no in case playing things from HTTP mysteriously fails, even
  5074. though the same files work from local disk.
  5075. .sp
  5076. This is default in order to reduce latency when opening HTTP streams.
  5077. .TP
  5078. .B \fB\-\-demuxer\-lavf\-format=<name>\fP
  5079. Force a specific libavformat demuxer.
  5080. .TP
  5081. .B \fB\-\-demuxer\-lavf\-hacks=<yes|no>\fP
  5082. By default, some formats will be handled differently from other formats
  5083. by explicitly checking for them. Most of these compensate for weird or
  5084. imperfect behavior from libavformat demuxers. Passing \fBno\fP disables
  5085. these. For debugging and testing only.
  5086. .TP
  5087. .B \fB\-\-demuxer\-lavf\-o=<key>=<value>[,<key>=<value>[,...]]\fP
  5088. Pass AVOptions to libavformat demuxer.
  5089. .sp
  5090. Note, a patch to make the \fIo=\fP unneeded and pass all unknown options
  5091. through the AVOption system is welcome. A full list of AVOptions can
  5092. be found in the FFmpeg manual. Note that some options may conflict
  5093. with mpv options.
  5094. .sp
  5095. This is a key/value list option. See \fI\%List Options\fP for details.
  5096. .INDENT 7.0
  5097. .INDENT 3.5
  5098. .IP "Example"
  5099. .sp
  5100. \fB\-\-demuxer\-lavf\-o=fflags=+ignidx\fP
  5101. .UNINDENT
  5102. .UNINDENT
  5103. .TP
  5104. .B \fB\-\-demuxer\-lavf\-probesize=<value>\fP
  5105. Maximum amount of data to probe during the detection phase. In the
  5106. case of MPEG\-TS this value identifies the maximum number of TS packets
  5107. to scan.
  5108. .TP
  5109. .B \fB\-\-demuxer\-lavf\-buffersize=<value>\fP
  5110. Size of the stream read buffer allocated for libavformat in bytes
  5111. (default: 32768). Lowering the size could lower latency. Note that
  5112. libavformat might reallocate the buffer internally, or not fully use all
  5113. of it.
  5114. .TP
  5115. .B \fB\-\-demuxer\-lavf\-linearize\-timestamps=<yes|no|auto>\fP
  5116. Attempt to linearize timestamp resets in demuxed streams (default: auto).
  5117. This was tested only for single audio streams. It\(aqs unknown whether it
  5118. works correctly for video (but likely won\(aqt). Note that the implementation
  5119. is slightly incorrect either way, and will introduce a discontinuity by
  5120. about 1 codec frame size.
  5121. .sp
  5122. The \fBauto\fP mode enables this for OGG audio stream. This covers the common
  5123. and annoying case of OGG web radio streams. Some of these will reset
  5124. timestamps to 0 every time a new song begins. This breaks the mpv seekable
  5125. cache, which can\(aqt deal with timestamp resets. Note that FFmpeg/libavformat\(aqs
  5126. seeking API can\(aqt deal with this either; it\(aqs likely that if this option
  5127. breaks this even more, while if it\(aqs disabled, you can at least seek within
  5128. the first song in the stream. Well, you won\(aqt get anything useful either
  5129. way if the seek is outside of mpv\(aqs cache.
  5130. .TP
  5131. .B \fB\-\-demuxer\-lavf\-propagate\-opts=<yes|no>\fP
  5132. Propagate FFmpeg\-level options to recursively opened connections (default:
  5133. yes). This is needed because FFmpeg will apply these settings to nested
  5134. AVIO contexts automatically. On the other hand, this could break in certain
  5135. situations \- it\(aqs the FFmpeg API, you just can\(aqt win.
  5136. .sp
  5137. This affects in particular the \fB\-\-timeout\fP option and anything passed
  5138. with \fB\-\-demuxer\-lavf\-o\fP\&.
  5139. .sp
  5140. If this option is deemed unnecessary at some point in the future, it will
  5141. be removed without notice.
  5142. .TP
  5143. .B \fB\-\-demuxer\-mkv\-subtitle\-preroll=<yes|index|no>\fP, \fB\-\-mkv\-subtitle\-preroll\fP
  5144. Try harder to show embedded soft subtitles when seeking somewhere. Normally,
  5145. it can happen that the subtitle at the seek target is not shown due to how
  5146. some container file formats are designed. The subtitles appear only if
  5147. seeking before or exactly to the position a subtitle first appears. To
  5148. make this worse, subtitles are often timed to appear a very small amount
  5149. before the associated video frame, so that seeking to the video frame
  5150. typically does not demux the subtitle at that position.
  5151. .sp
  5152. Enabling this option makes the demuxer start reading data a bit before the
  5153. seek target, so that subtitles appear correctly. Note that this makes
  5154. seeking slower, and is not guaranteed to always work. It only works if the
  5155. subtitle is close enough to the seek target.
  5156. .sp
  5157. Works with the internal Matroska demuxer only. Always enabled for absolute
  5158. and hr\-seeks, and this option changes behavior with relative or imprecise
  5159. seeks only.
  5160. .sp
  5161. You can use the \fB\-\-demuxer\-mkv\-subtitle\-preroll\-secs\fP option to specify
  5162. how much data the demuxer should pre\-read at most in order to find subtitle
  5163. packets that may overlap. Setting this to 0 will effectively disable this
  5164. preroll mechanism. Setting a very large value can make seeking very slow,
  5165. and an extremely large value would completely reread the entire file from
  5166. start to seek target on every seek \- seeking can become slower towards the
  5167. end of the file. The details are messy, and the value is actually rounded
  5168. down to the cluster with the previous video keyframe.
  5169. .sp
  5170. Some files, especially files muxed with newer mkvmerge versions, have
  5171. information embedded that can be used to determine what subtitle packets
  5172. overlap with a seek target. In these cases, mpv will reduce the amount
  5173. of data read to a minimum. (Although it will still read \fIall\fP data between
  5174. the cluster that contains the first wanted subtitle packet, and the seek
  5175. target.) If the \fBindex\fP choice (which is the default) is specified, then
  5176. prerolling will be done only if this information is actually available. If
  5177. this method is used, the maximum amount of data to skip can be additionally
  5178. controlled by \fB\-\-demuxer\-mkv\-subtitle\-preroll\-secs\-index\fP (it still uses
  5179. the value of the option without \fB\-index\fP if that is higher).
  5180. .sp
  5181. See also \fB\-\-hr\-seek\-demuxer\-offset\fP option. This option can achieve a
  5182. similar effect, but only if hr\-seek is active. It works with any demuxer,
  5183. but makes seeking much slower, as it has to decode audio and video data
  5184. instead of just skipping over it.
  5185. .sp
  5186. \fB\-\-mkv\-subtitle\-preroll\fP is a deprecated alias.
  5187. .TP
  5188. .B \fB\-\-demuxer\-mkv\-subtitle\-preroll\-secs=<value>\fP
  5189. See \fB\-\-demuxer\-mkv\-subtitle\-preroll\fP\&.
  5190. .TP
  5191. .B \fB\-\-demuxer\-mkv\-subtitle\-preroll\-secs\-index=<value>\fP
  5192. See \fB\-\-demuxer\-mkv\-subtitle\-preroll\fP\&.
  5193. .TP
  5194. .B \fB\-\-demuxer\-mkv\-probe\-video\-duration=<yes|no|full>\fP
  5195. When opening the file, seek to the end of it, and check what timestamp the
  5196. last video packet has, and report that as file duration. This is strictly
  5197. for compatibility with Haali only. In this mode, it\(aqs possible that opening
  5198. will be slower (especially when playing over http), or that behavior with
  5199. broken files is much worse. So don\(aqt use this option.
  5200. .sp
  5201. The \fByes\fP mode merely uses the index and reads a small number of blocks
  5202. from the end of the file. The \fBfull\fP mode actually traverses the entire
  5203. file and can make a reliable estimate even without an index present (such
  5204. as partial files).
  5205. .TP
  5206. .B \fB\-\-demuxer\-rawaudio\-channels=<value>\fP
  5207. Number of channels (or channel layout) if \fB\-\-demuxer=rawaudio\fP is used
  5208. (default: stereo).
  5209. .TP
  5210. .B \fB\-\-demuxer\-rawaudio\-format=<value>\fP
  5211. Sample format for \fB\-\-demuxer=rawaudio\fP (default: s16le).
  5212. Use \fB\-\-demuxer\-rawaudio\-format=help\fP to get a list of all formats.
  5213. .TP
  5214. .B \fB\-\-demuxer\-rawaudio\-rate=<value>\fP
  5215. Sample rate for \fB\-\-demuxer=rawaudio\fP (default: 44 kHz).
  5216. .TP
  5217. .B \fB\-\-demuxer\-rawvideo\-fps=<value>\fP
  5218. Rate in frames per second for \fB\-\-demuxer=rawvideo\fP (default: 25.0).
  5219. .TP
  5220. .B \fB\-\-demuxer\-rawvideo\-w=<value>\fP, \fB\-\-demuxer\-rawvideo\-h=<value>\fP
  5221. Image dimension in pixels for \fB\-\-demuxer=rawvideo\fP\&.
  5222. .INDENT 7.0
  5223. .INDENT 3.5
  5224. .IP "Example"
  5225. .sp
  5226. Play a raw YUV sample:
  5227. .INDENT 0.0
  5228. .INDENT 3.5
  5229. .sp
  5230. .nf
  5231. .ft C
  5232. mpv sample\-720x576.yuv \-\-demuxer=rawvideo \e
  5233. \-\-demuxer\-rawvideo\-w=720 \-\-demuxer\-rawvideo\-h=576
  5234. .ft P
  5235. .fi
  5236. .UNINDENT
  5237. .UNINDENT
  5238. .UNINDENT
  5239. .UNINDENT
  5240. .TP
  5241. .B \fB\-\-demuxer\-rawvideo\-format=<value>\fP
  5242. Color space (fourcc) in hex or string for \fB\-\-demuxer=rawvideo\fP
  5243. (default: \fBYV12\fP).
  5244. .TP
  5245. .B \fB\-\-demuxer\-rawvideo\-mp\-format=<value>\fP
  5246. Color space by internal video format for \fB\-\-demuxer=rawvideo\fP\&. Use
  5247. \fB\-\-demuxer\-rawvideo\-mp\-format=help\fP for a list of possible formats.
  5248. .TP
  5249. .B \fB\-\-demuxer\-rawvideo\-codec=<value>\fP
  5250. Set the video codec instead of selecting the rawvideo codec when using
  5251. \fB\-\-demuxer=rawvideo\fP\&. This uses the same values as codec names in
  5252. \fB\-\-vd\fP (but it does not accept decoder names).
  5253. .TP
  5254. .B \fB\-\-demuxer\-rawvideo\-size=<value>\fP
  5255. Frame size in bytes when using \fB\-\-demuxer=rawvideo\fP\&.
  5256. .TP
  5257. .B \fB\-\-demuxer\-cue\-codepage=<codepage>\fP
  5258. Specify the CUE sheet codepage. (See \fB\-\-sub\-codepage\fP for details.)
  5259. .TP
  5260. .B \fB\-\-demuxer\-max\-bytes=<bytesize>\fP
  5261. This controls how much the demuxer is allowed to buffer ahead. The demuxer
  5262. will normally try to read ahead as much as necessary, or as much is
  5263. requested with \fB\-\-demuxer\-readahead\-secs\fP\&. The option can be used to
  5264. restrict the maximum readahead. This limits excessive readahead in case of
  5265. broken files or desynced playback. The demuxer will stop reading additional
  5266. packets as soon as one of the limits is reached. (The limits still can be
  5267. slightly overstepped due to technical reasons.)
  5268. .sp
  5269. Set these limits higher if you get a packet queue overflow warning, and
  5270. you think normal playback would be possible with a larger packet queue.
  5271. .sp
  5272. See \fB\-\-list\-options\fP for defaults and value range. \fB<bytesize>\fP options
  5273. accept suffixes such as \fBKiB\fP and \fBMiB\fP\&.
  5274. .TP
  5275. .B \fB\-\-demuxer\-max\-back\-bytes=<bytesize>\fP
  5276. This controls how much past data the demuxer is allowed to preserve. This
  5277. is useful only if the \fB\-\-demuxer\-seekable\-cache\fP option is enabled.
  5278. Unlike the forward cache, there is no control how many seconds are actually
  5279. cached \- it will simply use as much memory this option allows. Setting this
  5280. option to 0 will strictly disable any back buffer, but this will lead to
  5281. the situation that the forward seek range starts after the current playback
  5282. position (as it removes past packets that are seek points).
  5283. .sp
  5284. If the end of the file is reached, the remaining unused forward buffer space
  5285. is "donated" to the backbuffer (unless the backbuffer size is set to 0).
  5286. This still limits the total cache usage to the sum of the forward and
  5287. backward cache, and effectively makes better use of the total allowed memory
  5288. budget. (The opposite does not happen: free backward buffer is never
  5289. "donated" to the forward buffer.)
  5290. .sp
  5291. Keep in mind that other buffers in the player (like decoders) will cause the
  5292. demuxer to cache "future" frames in the back buffer, which can skew the
  5293. impression about how much data the backbuffer contains.
  5294. .sp
  5295. See \fB\-\-list\-options\fP for defaults and value range.
  5296. .TP
  5297. .B \fB\-\-demuxer\-seekable\-cache=<yes|no|auto>\fP
  5298. This controls whether seeking can use the demuxer cache (default: auto). If
  5299. enabled, short seek offsets will not trigger a low level demuxer seek
  5300. (which means for example that slow network round trips or FFmpeg seek bugs
  5301. can be avoided). If a seek cannot happen within the cached range, a low
  5302. level seek will be triggered. Seeking outside of the cache will start a new
  5303. cached range, but can discard the old cache range if the demuxer exhibits
  5304. certain unsupported behavior.
  5305. .sp
  5306. Keep in mind that some events can flush the cache or force a low level
  5307. seek anyway, such as switching tracks, or attempting to seek before the
  5308. start or after the end of the file.
  5309. .sp
  5310. The special value \fBauto\fP means \fByes\fP in the same situation as
  5311. \fB\-\-cache\-secs\fP is used (i.e. when the stream appears to be a network
  5312. stream or the stream cache is enabled).
  5313. .TP
  5314. .B \fB\-\-demuxer\-thread=<yes|no>\fP
  5315. Run the demuxer in a separate thread, and let it prefetch a certain amount
  5316. of packets (default: yes). Having this enabled leads to smoother playback,
  5317. enables features like prefetching, and prevents that stuck network freezes
  5318. the player. On the other hand, it can add overhead, or the background
  5319. prefetching can hog CPU resources.
  5320. .sp
  5321. Disabling this option is not recommended. Use it for debugging only.
  5322. .TP
  5323. .B \fB\-\-demuxer\-termination\-timeout=<seconds>\fP
  5324. Number of seconds the player should wait to shutdown the demuxer (default:
  5325. 0.1). The player will wait up to this much time before it closes the
  5326. stream layer forcefully. Forceful closing usually means the network I/O is
  5327. given no chance to close its connections gracefully (of course the OS can
  5328. still close TCP connections properly), and might result in annoying messages
  5329. being logged, and in some cases, confused remote servers.
  5330. .sp
  5331. This timeout is usually only applied when loading has finished properly. If
  5332. loading is aborted by the user, or in some corner cases like removing
  5333. external tracks sourced from network during playback, forceful closing is
  5334. always used.
  5335. .TP
  5336. .B \fB\-\-demuxer\-readahead\-secs=<seconds>\fP
  5337. If \fB\-\-demuxer\-thread\fP is enabled, this controls how much the demuxer
  5338. should buffer ahead in seconds (default: 1). As long as no packet has
  5339. a timestamp difference higher than the readahead amount relative to the
  5340. last packet returned to the decoder, the demuxer keeps reading.
  5341. .sp
  5342. Note that the \fB\-\-cache\-secs\fP option will override this value if a cache
  5343. is enabled, and the value is larger.
  5344. .sp
  5345. (This value tends to be fuzzy, because many file formats don\(aqt store linear
  5346. timestamps.)
  5347. .TP
  5348. .B \fB\-\-prefetch\-playlist=<yes|no>\fP
  5349. Prefetch next playlist entry while playback of the current entry is ending
  5350. (default: no). This merely opens the URL of the next playlist entry as soon
  5351. as the current URL is fully read.
  5352. .sp
  5353. This does \fBnot\fP work with URLs resolved by the \fByoutube\-dl\fP wrapper,
  5354. and it won\(aqt.
  5355. .sp
  5356. This does not affect HLS (\fB\&.m3u8\fP URLs) \- HLS prefetching depends on the
  5357. demuxer cache settings and is on by default.
  5358. .sp
  5359. This can give subtly wrong results if per\-file options are used, or if
  5360. options are changed in the time window between prefetching start and next
  5361. file played.
  5362. .sp
  5363. This can occasionally make wrong prefetching decisions. For example, it
  5364. can\(aqt predict whether you go backwards in the playlist, and assumes you
  5365. won\(aqt edit the playlist.
  5366. .sp
  5367. Highly experimental.
  5368. .TP
  5369. .B \fB\-\-force\-seekable=<yes|no>\fP
  5370. If the player thinks that the media is not seekable (e.g. playing from a
  5371. pipe, or it\(aqs an http stream with a server that doesn\(aqt support range
  5372. requests), seeking will be disabled. This option can forcibly enable it.
  5373. For seeks within the cache, there\(aqs a good chance of success.
  5374. .TP
  5375. .B \fB\-\-demuxer\-cache\-wait=<yes|no>\fP
  5376. Before starting playback, read data until either the end of the file was
  5377. reached, or the demuxer cache has reached maximum capacity. Only once this
  5378. is done, playback starts. This intentionally happens before the initial
  5379. seek triggered with \fB\-\-start\fP\&. This does not change any runtime behavior
  5380. after the initial caching. This option is useless if the file cannot be
  5381. cached completely.
  5382. .TP
  5383. .B \fB\-\-rar\-list\-all\-volumes=<yes|no>\fP
  5384. When opening multi\-volume rar files, open all volumes to create a full list
  5385. of contained files (default: no). If disabled, only the archive entries
  5386. whose headers are located within the first volume are listed (and thus
  5387. played when opening a .rar file with mpv). Doing so speeds up opening, and
  5388. the typical idiotic use\-case of playing uncompressed multi\-volume rar files
  5389. that contain a single media file is made faster.
  5390. .sp
  5391. Opening is still slow, because for unknown, idiotic, and unnecessary reasons
  5392. libarchive opens all volumes anyway when playing the main file, even though
  5393. mpv iterated no archive entries yet.
  5394. .UNINDENT
  5395. .SS Input
  5396. .INDENT 0.0
  5397. .TP
  5398. .B \fB\-\-native\-keyrepeat\fP
  5399. Use system settings for keyrepeat delay and rate, instead of
  5400. \fB\-\-input\-ar\-delay\fP and \fB\-\-input\-ar\-rate\fP\&. (Whether this applies
  5401. depends on the VO backend and how it handles keyboard input. Does not
  5402. apply to terminal input.)
  5403. .TP
  5404. .B \fB\-\-input\-ar\-delay\fP
  5405. Delay in milliseconds before we start to autorepeat a key (0 to disable).
  5406. .TP
  5407. .B \fB\-\-input\-ar\-rate\fP
  5408. Number of key presses to generate per second on autorepeat.
  5409. .TP
  5410. .B \fB\-\-input\-conf=<filename>\fP
  5411. Specify input configuration file other than the default location in the mpv
  5412. configuration directory (usually \fB~/.config/mpv/input.conf\fP).
  5413. .TP
  5414. .B \fB\-\-no\-input\-default\-bindings\fP
  5415. Disable mpv default (built\-in) key bindings.
  5416. .TP
  5417. .B \fB\-\-input\-cmdlist\fP
  5418. Prints all commands that can be bound to keys.
  5419. .TP
  5420. .B \fB\-\-input\-doubleclick\-time=<milliseconds>\fP
  5421. Time in milliseconds to recognize two consecutive button presses as a
  5422. double\-click (default: 300).
  5423. .TP
  5424. .B \fB\-\-input\-keylist\fP
  5425. Prints all keys that can be bound to commands.
  5426. .TP
  5427. .B \fB\-\-input\-key\-fifo\-size=<2\-65000>\fP
  5428. Specify the size of the FIFO that buffers key events (default: 7). If it
  5429. is too small, some events may be lost. The main disadvantage of setting it
  5430. to a very large value is that if you hold down a key triggering some
  5431. particularly slow command then the player may be unresponsive while it
  5432. processes all the queued commands.
  5433. .TP
  5434. .B \fB\-\-input\-test\fP
  5435. Input test mode. Instead of executing commands on key presses, mpv
  5436. will show the keys and the bound commands on the OSD. Has to be used
  5437. with a dummy video, and the normal ways to quit the player will not
  5438. work (key bindings that normally quit will be shown on OSD only, just
  5439. like any other binding). See \fI\%INPUT.CONF\fP\&.
  5440. .TP
  5441. .B \fB\-\-input\-file=<filename>\fP
  5442. Deprecated. Use \fB\-\-input\-ipc\-server\fP\&.
  5443. .sp
  5444. Read commands from the given file. Mostly useful with a FIFO. Since
  5445. mpv 0.7.0 also understands JSON commands (see \fI\%JSON IPC\fP), but you can\(aqt
  5446. get replies or events. Use \fB\-\-input\-ipc\-server\fP for something
  5447. bi\-directional. On MS Windows, JSON commands are not available.
  5448. .sp
  5449. This can also specify a direct file descriptor with \fBfd://N\fP (UNIX only).
  5450. In this case, JSON replies will be written if the FD is writable.
  5451. .sp
  5452. \fBNOTE:\fP
  5453. .INDENT 7.0
  5454. .INDENT 3.5
  5455. When the given file is a FIFO mpv opens both ends, so you can do several
  5456. \fIecho "seek 10" > mp_pipe\fP and the pipe will stay valid.
  5457. .UNINDENT
  5458. .UNINDENT
  5459. .TP
  5460. .B \fB\-\-input\-terminal\fP, \fB\-\-no\-input\-terminal\fP
  5461. \fB\-\-no\-input\-terminal\fP prevents the player from reading key events from
  5462. standard input. Useful when reading data from standard input. This is
  5463. automatically enabled when \fB\-\fP is found on the command line. There are
  5464. situations where you have to set it manually, e.g. if you open
  5465. \fB/dev/stdin\fP (or the equivalent on your system), use stdin in a playlist
  5466. or intend to read from stdin later on via the loadfile or loadlist input
  5467. commands.
  5468. .TP
  5469. .B \fB\-\-input\-ipc\-server=<filename>\fP
  5470. Enable the IPC support and create the listening socket at the given path.
  5471. .sp
  5472. On Linux and Unix, the given path is a regular filesystem path. On Windows,
  5473. named pipes are used, so the path refers to the pipe namespace
  5474. (\fB\e\e.\epipe\e<name>\fP). If the \fB\e\e.\epipe\e\fP prefix is missing, mpv will add
  5475. it automatically before creating the pipe, so
  5476. \fB\-\-input\-ipc\-server=/tmp/mpv\-socket\fP and
  5477. \fB\-\-input\-ipc\-server=\e\e.\epipe\etmp\empv\-socket\fP are equivalent for IPC on
  5478. Windows.
  5479. .sp
  5480. See \fI\%JSON IPC\fP for details.
  5481. .TP
  5482. .B \fB\-\-input\-gamepad=<yes|no>\fP
  5483. Enable/disable SDL2 Gamepad support. Disabled by default.
  5484. .TP
  5485. .B \fB\-\-input\-cursor\fP, \fB\-\-no\-input\-cursor\fP
  5486. Permit mpv to receive pointer events reported by the video output
  5487. driver. Necessary to use the OSC, or to select the buttons in DVD menus.
  5488. Support depends on the VO in use.
  5489. .TP
  5490. .B \fB\-\-input\-media\-keys=<yes|no>\fP
  5491. (OS X and Windows only)
  5492. Enable/disable media keys support. Enabled by default (except for libmpv).
  5493. .TP
  5494. .B \fB\-\-input\-right\-alt\-gr\fP, \fB\-\-no\-input\-right\-alt\-gr\fP
  5495. (Cocoa and Windows only)
  5496. Use the right Alt key as Alt Gr to produce special characters. If disabled,
  5497. count the right Alt as an Alt modifier key. Enabled by default.
  5498. .TP
  5499. .B \fB\-\-input\-vo\-keyboard=<yes|no>\fP
  5500. Disable all keyboard input on for VOs which can\(aqt participate in proper
  5501. keyboard input dispatching. May not affect all VOs. Generally useful for
  5502. embedding only.
  5503. .sp
  5504. On X11, a sub\-window with input enabled grabs all keyboard input as long
  5505. as it is 1. a child of a focused window, and 2. the mouse is inside of
  5506. the sub\-window. It can steal away all keyboard input from the
  5507. application embedding the mpv window, and on the other hand, the mpv
  5508. window will receive no input if the mouse is outside of the mpv window,
  5509. even though mpv has focus. Modern toolkits work around this weird X11
  5510. behavior, but naively embedding foreign windows breaks it.
  5511. .sp
  5512. The only way to handle this reasonably is using the XEmbed protocol, which
  5513. was designed to solve these problems. GTK provides \fBGtkSocket\fP, which
  5514. supports XEmbed. Qt doesn\(aqt seem to provide anything working in newer
  5515. versions.
  5516. .sp
  5517. If the embedder supports XEmbed, input should work with default settings
  5518. and with this option disabled. Note that \fBinput\-default\-bindings\fP is
  5519. disabled by default in libmpv as well \- it should be enabled if you want
  5520. the mpv default key bindings.
  5521. .sp
  5522. (This option was renamed from \fB\-\-input\-x11\-keyboard\fP\&.)
  5523. .UNINDENT
  5524. .SS OSD
  5525. .INDENT 0.0
  5526. .TP
  5527. .B \fB\-\-osc\fP, \fB\-\-no\-osc\fP
  5528. Whether to load the on\-screen\-controller (default: yes).
  5529. .TP
  5530. .B \fB\-\-no\-osd\-bar\fP, \fB\-\-osd\-bar\fP
  5531. Disable display of the OSD bar.
  5532. .sp
  5533. You can configure this on a per\-command basis in input.conf using \fBosd\-\fP
  5534. prefixes, see \fBInput Command Prefixes\fP\&. If you want to disable the OSD
  5535. completely, use \fB\-\-osd\-level=0\fP\&.
  5536. .TP
  5537. .B \fB\-\-osd\-on\-seek=<no,bar,msg,msg\-bar>\fP
  5538. Set what is displayed on the OSD during seeks. The default is \fBbar\fP\&.
  5539. .sp
  5540. You can configure this on a per\-command basis in input.conf using \fBosd\-\fP
  5541. prefixes, see \fBInput Command Prefixes\fP\&.
  5542. .TP
  5543. .B \fB\-\-osd\-duration=<time>\fP
  5544. Set the duration of the OSD messages in ms (default: 1000).
  5545. .TP
  5546. .B \fB\-\-osd\-font=<name>\fP
  5547. Specify font to use for OSD. The default is \fBsans\-serif\fP\&.
  5548. .INDENT 7.0
  5549. .INDENT 3.5
  5550. .IP "Examples"
  5551. .INDENT 0.0
  5552. .IP \(bu 2
  5553. \fB\-\-osd\-font=\(aqBitstream Vera Sans\(aq\fP
  5554. .IP \(bu 2
  5555. \fB\-\-osd\-font=\(aqComic Sans MS\(aq\fP
  5556. .UNINDENT
  5557. .UNINDENT
  5558. .UNINDENT
  5559. .TP
  5560. .B \fB\-\-osd\-font\-size=<size>\fP
  5561. Specify the OSD font size. See \fB\-\-sub\-font\-size\fP for details.
  5562. .sp
  5563. Default: 55.
  5564. .TP
  5565. .B \fB\-\-osd\-msg1=<string>\fP
  5566. Show this string as message on OSD with OSD level 1 (visible by default).
  5567. The message will be visible by default, and as long as no other message
  5568. covers it, and the OSD level isn\(aqt changed (see \fB\-\-osd\-level\fP).
  5569. Expands properties; see \fI\%Property Expansion\fP\&.
  5570. .TP
  5571. .B \fB\-\-osd\-msg2=<string>\fP
  5572. Similar to \fB\-\-osd\-msg1\fP, but for OSD level 2. If this is an empty string
  5573. (default), then the playback time is shown.
  5574. .TP
  5575. .B \fB\-\-osd\-msg3=<string>\fP
  5576. Similar to \fB\-\-osd\-msg1\fP, but for OSD level 3. If this is an empty string
  5577. (default), then the playback time, duration, and some more information is
  5578. shown.
  5579. .sp
  5580. This is used for the \fBshow\-progress\fP command (by default mapped to \fBP\fP),
  5581. and when seeking if enabled with \fB\-\-osd\-on\-seek\fP or by \fBosd\-\fP prefixes
  5582. in input.conf (see \fBInput Command Prefixes\fP).
  5583. .sp
  5584. \fB\-\-osd\-status\-msg\fP is a legacy equivalent (but with a minor difference).
  5585. .TP
  5586. .B \fB\-\-osd\-status\-msg=<string>\fP
  5587. Show a custom string during playback instead of the standard status text.
  5588. This overrides the status text used for \fB\-\-osd\-level=3\fP, when using the
  5589. \fBshow\-progress\fP command (by default mapped to \fBP\fP), and when seeking if
  5590. enabled with \fB\-\-osd\-on\-seek\fP or \fBosd\-\fP prefixes in input.conf (see
  5591. \fBInput Command Prefixes\fP). Expands properties. See \fI\%Property Expansion\fP\&.
  5592. .sp
  5593. This option has been replaced with \fB\-\-osd\-msg3\fP\&. The only difference is
  5594. that this option implicitly includes \fB${osd\-sym\-cc}\fP\&. This option is
  5595. ignored if \fB\-\-osd\-msg3\fP is not empty.
  5596. .TP
  5597. .B \fB\-\-osd\-playing\-msg=<string>\fP
  5598. Show a message on OSD when playback starts. The string is expanded for
  5599. properties, e.g. \fB\-\-osd\-playing\-msg=\(aqfile: ${filename}\(aq\fP will show the
  5600. message \fBfile:\fP followed by a space and the currently played filename.
  5601. .sp
  5602. See \fI\%Property Expansion\fP\&.
  5603. .TP
  5604. .B \fB\-\-osd\-bar\-align\-x=<\-1\-1>\fP
  5605. Position of the OSD bar. \-1 is far left, 0 is centered, 1 is far right.
  5606. Fractional values (like 0.5) are allowed.
  5607. .TP
  5608. .B \fB\-\-osd\-bar\-align\-y=<\-1\-1>\fP
  5609. Position of the OSD bar. \-1 is top, 0 is centered, 1 is bottom.
  5610. Fractional values (like 0.5) are allowed.
  5611. .TP
  5612. .B \fB\-\-osd\-bar\-w=<1\-100>\fP
  5613. Width of the OSD bar, in percentage of the screen width (default: 75).
  5614. A value of 50 means the bar is half the screen wide.
  5615. .TP
  5616. .B \fB\-\-osd\-bar\-h=<0.1\-50>\fP
  5617. Height of the OSD bar, in percentage of the screen height (default: 3.125).
  5618. .TP
  5619. .B \fB\-\-osd\-back\-color=<color>\fP
  5620. See \fB\-\-osd\-color\fP\&. Color used for OSD text background.
  5621. .TP
  5622. .B \fB\-\-osd\-blur=<0..20.0>\fP
  5623. Gaussian blur factor. 0 means no blur applied (default).
  5624. .TP
  5625. .B \fB\-\-osd\-bold=<yes|no>\fP
  5626. Format text on bold.
  5627. .TP
  5628. .B \fB\-\-osd\-italic=<yes|no>\fP
  5629. Format text on italic.
  5630. .TP
  5631. .B \fB\-\-osd\-border\-color=<color>\fP
  5632. See \fB\-\-osd\-color\fP\&. Color used for the OSD font border.
  5633. .sp
  5634. \fBNOTE:\fP
  5635. .INDENT 7.0
  5636. .INDENT 3.5
  5637. ignored when \fB\-\-osd\-back\-color\fP is
  5638. specified (or more exactly: when that option is not set to completely
  5639. transparent).
  5640. .UNINDENT
  5641. .UNINDENT
  5642. .TP
  5643. .B \fB\-\-osd\-border\-size=<size>\fP
  5644. Size of the OSD font border in scaled pixels (see \fB\-\-sub\-font\-size\fP
  5645. for details). A value of 0 disables borders.
  5646. .sp
  5647. Default: 3.
  5648. .TP
  5649. .B \fB\-\-osd\-color=<color>\fP
  5650. Specify the color used for OSD.
  5651. See \fB\-\-sub\-color\fP for details.
  5652. .TP
  5653. .B \fB\-\-osd\-fractions\fP
  5654. Show OSD times with fractions of seconds (in millisecond precision). Useful
  5655. to see the exact timestamp of a video frame.
  5656. .TP
  5657. .B \fB\-\-osd\-level=<0\-3>\fP
  5658. Specifies which mode the OSD should start in.
  5659. .INDENT 7.0
  5660. .TP
  5661. .B 0
  5662. OSD completely disabled (subtitles only)
  5663. .TP
  5664. .B 1
  5665. enabled (shows up only on user interaction)
  5666. .TP
  5667. .B 2
  5668. enabled + current time visible by default
  5669. .TP
  5670. .B 3
  5671. enabled + \fB\-\-osd\-status\-msg\fP (current time and status by default)
  5672. .UNINDENT
  5673. .TP
  5674. .B \fB\-\-osd\-margin\-x=<size>\fP
  5675. Left and right screen margin for the OSD in scaled pixels (see
  5676. \fB\-\-sub\-font\-size\fP for details).
  5677. .sp
  5678. This option specifies the distance of the OSD to the left, as well as at
  5679. which distance from the right border long OSD text will be broken.
  5680. .sp
  5681. Default: 25.
  5682. .TP
  5683. .B \fB\-\-osd\-margin\-y=<size>\fP
  5684. Top and bottom screen margin for the OSD in scaled pixels (see
  5685. \fB\-\-sub\-font\-size\fP for details).
  5686. .sp
  5687. This option specifies the vertical margins of the OSD.
  5688. .sp
  5689. Default: 22.
  5690. .TP
  5691. .B \fB\-\-osd\-align\-x=<left|center|right>\fP
  5692. Control to which corner of the screen OSD should be
  5693. aligned to (default: \fBleft\fP).
  5694. .TP
  5695. .B \fB\-\-osd\-align\-y=<top|center|bottom>\fP
  5696. Vertical position (default: \fBtop\fP).
  5697. Details see \fB\-\-osd\-align\-x\fP\&.
  5698. .TP
  5699. .B \fB\-\-osd\-scale=<factor>\fP
  5700. OSD font size multiplier, multiplied with \fB\-\-osd\-font\-size\fP value.
  5701. .TP
  5702. .B \fB\-\-osd\-scale\-by\-window=<yes|no>\fP
  5703. Whether to scale the OSD with the window size (default: yes). If this is
  5704. disabled, \fB\-\-osd\-font\-size\fP and other OSD options that use scaled pixels
  5705. are always in actual pixels. The effect is that changing the window size
  5706. won\(aqt change the OSD font size.
  5707. .TP
  5708. .B \fB\-\-osd\-shadow\-color=<color>\fP
  5709. See \fB\-\-sub\-color\fP\&. Color used for OSD shadow.
  5710. .TP
  5711. .B \fB\-\-osd\-shadow\-offset=<size>\fP
  5712. Displacement of the OSD shadow in scaled pixels (see
  5713. \fB\-\-sub\-font\-size\fP for details). A value of 0 disables shadows.
  5714. .sp
  5715. Default: 0.
  5716. .TP
  5717. .B \fB\-\-osd\-spacing=<size>\fP
  5718. Horizontal OSD/sub font spacing in scaled pixels (see \fB\-\-sub\-font\-size\fP
  5719. for details). This value is added to the normal letter spacing. Negative
  5720. values are allowed.
  5721. .sp
  5722. Default: 0.
  5723. .TP
  5724. .B \fB\-\-video\-osd=<yes|no>\fP
  5725. Enabled OSD rendering on the video window (default: yes). This can be used
  5726. in situations where terminal OSD is preferred. If you just want to disable
  5727. all OSD rendering, use \fB\-\-osd\-level=0\fP\&.
  5728. .sp
  5729. It does not affect subtitles or overlays created by scripts (in particular,
  5730. the OSC needs to be disabled with \fB\-\-no\-osc\fP).
  5731. .sp
  5732. This option is somewhat experimental and could be replaced by another
  5733. mechanism in the future.
  5734. .TP
  5735. .B \fB\-\-osd\-font\-provider=<...>\fP
  5736. See \fB\-\-sub\-font\-provider\fP for details and accepted values. Note that
  5737. unlike subtitles, OSD never uses embedded fonts from media files.
  5738. .UNINDENT
  5739. .SS Screenshot
  5740. .INDENT 0.0
  5741. .TP
  5742. .B \fB\-\-screenshot\-format=<type>\fP
  5743. Set the image file type used for saving screenshots.
  5744. .sp
  5745. Available choices:
  5746. .INDENT 7.0
  5747. .TP
  5748. .B png
  5749. PNG
  5750. .TP
  5751. .B jpg
  5752. JPEG (default)
  5753. .TP
  5754. .B jpeg
  5755. JPEG (alias for jpg)
  5756. .TP
  5757. .B webp
  5758. WebP
  5759. .UNINDENT
  5760. .TP
  5761. .B \fB\-\-screenshot\-tag\-colorspace=<yes|no>\fP
  5762. Tag screenshots with the appropriate colorspace.
  5763. .sp
  5764. Note that not all formats are supported.
  5765. .sp
  5766. Default: \fBno\fP\&.
  5767. .TP
  5768. .B \fB\-\-screenshot\-high\-bit\-depth=<yes|no>\fP
  5769. If possible, write screenshots with a bit depth similar to the source
  5770. video (default: yes). This is interesting in particular for PNG, as this
  5771. sometimes triggers writing 16 bit PNGs with huge file sizes. This will also
  5772. include an unused alpha channel in the resulting files if 16 bit is used.
  5773. .TP
  5774. .B \fB\-\-screenshot\-template=<template>\fP
  5775. Specify the filename template used to save screenshots. The template
  5776. specifies the filename without file extension, and can contain format
  5777. specifiers, which will be substituted when taking a screenshot.
  5778. By default, the template is \fBmpv\-shot%n\fP, which results in filenames like
  5779. \fBmpv\-shot0012.png\fP for example.
  5780. .sp
  5781. The template can start with a relative or absolute path, in order to
  5782. specify a directory location where screenshots should be saved.
  5783. .sp
  5784. If the final screenshot filename points to an already existing file, the
  5785. file will not be overwritten. The screenshot will either not be saved, or if
  5786. the template contains \fB%n\fP, saved using different, newly generated
  5787. filename.
  5788. .sp
  5789. Allowed format specifiers:
  5790. .INDENT 7.0
  5791. .TP
  5792. .B \fB%[#][0X]n\fP
  5793. A sequence number, padded with zeros to length X (default: 04). E.g.
  5794. passing the format \fB%04n\fP will yield \fB0012\fP on the 12th screenshot.
  5795. The number is incremented every time a screenshot is taken or if the
  5796. file already exists. The length \fBX\fP must be in the range 0\-9. With
  5797. the optional # sign, mpv will use the lowest available number. For
  5798. example, if you take three screenshots\-\-0001, 0002, 0003\-\-and delete
  5799. the first two, the next two screenshots will not be 0004 and 0005, but
  5800. 0001 and 0002 again.
  5801. .TP
  5802. .B \fB%f\fP
  5803. Filename of the currently played video.
  5804. .TP
  5805. .B \fB%F\fP
  5806. Same as \fB%f\fP, but strip the file extension, including the dot.
  5807. .TP
  5808. .B \fB%x\fP
  5809. Directory path of the currently played video. If the video is not on
  5810. the filesystem (but e.g. \fBhttp://\fP), this expand to an empty string.
  5811. .TP
  5812. .B \fB%X{fallback}\fP
  5813. Same as \fB%x\fP, but if the video file is not on the filesystem, return
  5814. the fallback string inside the \fB{...}\fP\&.
  5815. .TP
  5816. .B \fB%p\fP
  5817. Current playback time, in the same format as used in the OSD. The
  5818. result is a string of the form "HH:MM:SS". For example, if the video is
  5819. at the time position 5 minutes and 34 seconds, \fB%p\fP will be replaced
  5820. with "00:05:34".
  5821. .TP
  5822. .B \fB%P\fP
  5823. Similar to \fB%p\fP, but extended with the playback time in milliseconds.
  5824. It is formatted as "HH:MM:SS.mmm", with "mmm" being the millisecond
  5825. part of the playback time.
  5826. .sp
  5827. \fBNOTE:\fP
  5828. .INDENT 7.0
  5829. .INDENT 3.5
  5830. This is a simple way for getting unique per\-frame timestamps. (Frame
  5831. numbers would be more intuitive, but are not easily implementable
  5832. because container formats usually use time stamps for identifying
  5833. frames.)
  5834. .UNINDENT
  5835. .UNINDENT
  5836. .TP
  5837. .B \fB%wX\fP
  5838. Specify the current playback time using the format string \fBX\fP\&.
  5839. \fB%p\fP is like \fB%wH:%wM:%wS\fP, and \fB%P\fP is like \fB%wH:%wM:%wS.%wT\fP\&.
  5840. .INDENT 7.0
  5841. .TP
  5842. .B Valid format specifiers:
  5843. .INDENT 7.0
  5844. .TP
  5845. .B \fB%wH\fP
  5846. hour (padded with 0 to two digits)
  5847. .TP
  5848. .B \fB%wh\fP
  5849. hour (not padded)
  5850. .TP
  5851. .B \fB%wM\fP
  5852. minutes (00\-59)
  5853. .TP
  5854. .B \fB%wm\fP
  5855. total minutes (includes hours, unlike \fB%wM\fP)
  5856. .TP
  5857. .B \fB%wS\fP
  5858. seconds (00\-59)
  5859. .TP
  5860. .B \fB%ws\fP
  5861. total seconds (includes hours and minutes)
  5862. .TP
  5863. .B \fB%wf\fP
  5864. like \fB%ws\fP, but as float
  5865. .TP
  5866. .B \fB%wT\fP
  5867. milliseconds (000\-999)
  5868. .UNINDENT
  5869. .UNINDENT
  5870. .TP
  5871. .B \fB%tX\fP
  5872. Specify the current local date/time using the format \fBX\fP\&. This format
  5873. specifier uses the UNIX \fBstrftime()\fP function internally, and inserts
  5874. the result of passing "%X" to \fBstrftime\fP\&. For example, \fB%tm\fP will
  5875. insert the number of the current month as number. You have to use
  5876. multiple \fB%tX\fP specifiers to build a full date/time string.
  5877. .TP
  5878. .B \fB%{prop[:fallback text]}\fP
  5879. Insert the value of the input property \(aqprop\(aq. E.g. \fB%{filename}\fP is
  5880. the same as \fB%f\fP\&. If the property does not exist or is not available,
  5881. an error text is inserted, unless a fallback is specified.
  5882. .TP
  5883. .B \fB%%\fP
  5884. Replaced with the \fB%\fP character itself.
  5885. .UNINDENT
  5886. .TP
  5887. .B \fB\-\-screenshot\-directory=<path>\fP
  5888. Store screenshots in this directory. This path is joined with the filename
  5889. generated by \fB\-\-screenshot\-template\fP\&. If the template filename is already
  5890. absolute, the directory is ignored.
  5891. .sp
  5892. If the directory does not exist, it is created on the first screenshot. If
  5893. it is not a directory, an error is generated when trying to write a
  5894. screenshot.
  5895. .sp
  5896. This option is not set by default, and thus will write screenshots to the
  5897. directory from which mpv was started. In pseudo\-gui mode
  5898. (see \fI\%PSEUDO GUI MODE\fP), this is set to the desktop.
  5899. .TP
  5900. .B \fB\-\-screenshot\-jpeg\-quality=<0\-100>\fP
  5901. Set the JPEG quality level. Higher means better quality. The default is 90.
  5902. .TP
  5903. .B \fB\-\-screenshot\-jpeg\-source\-chroma=<yes|no>\fP
  5904. Write JPEG files with the same chroma subsampling as the video
  5905. (default: yes). If disabled, the libjpeg default is used.
  5906. .TP
  5907. .B \fB\-\-screenshot\-png\-compression=<0\-9>\fP
  5908. Set the PNG compression level. Higher means better compression. This will
  5909. affect the file size of the written screenshot file and the time it takes
  5910. to write a screenshot. Too high compression might occupy enough CPU time to
  5911. interrupt playback. The default is 7.
  5912. .TP
  5913. .B \fB\-\-screenshot\-png\-filter=<0\-5>\fP
  5914. Set the filter applied prior to PNG compression. 0 is none, 1 is "sub", 2 is
  5915. "up", 3 is "average", 4 is "Paeth", and 5 is "mixed". This affects the level
  5916. of compression that can be achieved. For most images, "mixed" achieves the
  5917. best compression ratio, hence it is the default.
  5918. .TP
  5919. .B \fB\-\-screenshot\-webp\-lossless=<yes|no>\fP
  5920. Write lossless WebP files. \fB\-\-screenshot\-webp\-quality\fP is ignored if this
  5921. is set. The default is no.
  5922. .TP
  5923. .B \fB\-\-screenshot\-webp\-quality=<0\-100>\fP
  5924. Set the WebP quality level. Higher means better quality. The default is 75.
  5925. .TP
  5926. .B \fB\-\-screenshot\-webp\-compression=<0\-6>\fP
  5927. Set the WebP compression level. Higher means better compression, but takes
  5928. more CPU time. Note that this also affects the screenshot quality when used
  5929. with lossy WebP files. The default is 4.
  5930. .UNINDENT
  5931. .SS Software Scaler
  5932. .INDENT 0.0
  5933. .TP
  5934. .B \fB\-\-sws\-scaler=<name>\fP
  5935. Specify the software scaler algorithm to be used with \fB\-\-vf=scale\fP\&. This
  5936. also affects video output drivers which lack hardware acceleration,
  5937. e.g. \fBx11\fP\&. See also \fB\-\-vf=scale\fP\&.
  5938. .sp
  5939. To get a list of available scalers, run \fB\-\-sws\-scaler=help\fP\&.
  5940. .sp
  5941. Default: \fBbicubic\fP\&.
  5942. .TP
  5943. .B \fB\-\-sws\-lgb=<0\-100>\fP
  5944. Software scaler Gaussian blur filter (luma). See \fB\-\-sws\-scaler\fP\&.
  5945. .TP
  5946. .B \fB\-\-sws\-cgb=<0\-100>\fP
  5947. Software scaler Gaussian blur filter (chroma). See \fB\-\-sws\-scaler\fP\&.
  5948. .TP
  5949. .B \fB\-\-sws\-ls=<\-100\-100>\fP
  5950. Software scaler sharpen filter (luma). See \fB\-\-sws\-scaler\fP\&.
  5951. .TP
  5952. .B \fB\-\-sws\-cs=<\-100\-100>\fP
  5953. Software scaler sharpen filter (chroma). See \fB\-\-sws\-scaler\fP\&.
  5954. .TP
  5955. .B \fB\-\-sws\-chs=<h>\fP
  5956. Software scaler chroma horizontal shifting. See \fB\-\-sws\-scaler\fP\&.
  5957. .TP
  5958. .B \fB\-\-sws\-cvs=<v>\fP
  5959. Software scaler chroma vertical shifting. See \fB\-\-sws\-scaler\fP\&.
  5960. .TP
  5961. .B \fB\-\-sws\-bitexact=<yes|no>\fP
  5962. Unknown functionality (default: no). Consult libswscale source code. The
  5963. primary purpose of this, as far as libswscale API goes), is to produce
  5964. exactly the same output for the same input on all platforms (output has the
  5965. same "bits" everywhere, thus "bitexact"). Typically disables optimizations.
  5966. .TP
  5967. .B \fB\-\-sws\-fast=<yes|no>\fP
  5968. Allow optimizations that help with performance, but reduce quality (default:
  5969. no).
  5970. .sp
  5971. VOs like \fBdrm\fP and \fBx11\fP will benefit a lot from using \fB\-\-sws\-fast\fP\&.
  5972. You may need to set other options, like \fB\-\-sws\-scaler\fP\&. The builtin
  5973. \fBsws\-fast\fP profile sets this option and some others to gain performance
  5974. for reduced quality.
  5975. .TP
  5976. .B \fB\-\-sws\-allow\-zimg=<yes|no>\fP
  5977. Allow using zimg (if the component using the internal swscale wrapper
  5978. explicitly allows so). In this case, zimg \fImay\fP be used, if the internal
  5979. zimg wrapper supports the input and output formats. It will silently
  5980. fall back to libswscale if one of these conditions does not apply.
  5981. .sp
  5982. If zimg is used, the other \fB\-\-sws\-\fP options are ignored, and the
  5983. \fB\-\-zimg\-\fP options are used instead.
  5984. .sp
  5985. If the internal component using the swscale wrapper hooks up logging
  5986. correctly, a verbose priority log message will indicate whether zimg is
  5987. being used.
  5988. .sp
  5989. Most things which need software conversion can make use of this.
  5990. .TP
  5991. .B \fB\-\-zimg\-scaler=<point|bilinear|bicubic|spline16|spline36|lanczos>\fP
  5992. Zimg luma scaler to use (default: lanczos).
  5993. .TP
  5994. .B \fB\-\-zimg\-scaler\-param\-a=<default|float>\fP, \fB\-\-zimg\-scaler\-param\-b=<default|float>\fP
  5995. Set scaler parameters. By default, these are set to the special string
  5996. \fBdefault\fP, which maps to a scaler\-specific default value. Ignored if the
  5997. scaler is not tunable.
  5998. .INDENT 7.0
  5999. .TP
  6000. .B \fBlanczos\fP
  6001. \fB\-\-zimg\-scaler\-param\-a\fP is the number of taps.
  6002. .TP
  6003. .B \fBbicubic\fP
  6004. a and b are the bicubic b and c parameters.
  6005. .UNINDENT
  6006. .TP
  6007. .B \fB\-\-zimg\-scaler\-chroma=...\fP
  6008. Same as \fB\-\-zimg\-scaler\fP, for for chroma interpolation (default: bilinear).
  6009. .TP
  6010. .B \fB\-\-zimg\-scaler\-chroma\-param\-a\fP, \fB\-\-zimg\-scaler\-chroma\-param\-b\fP
  6011. Same as \fB\-\-zimg\-scaler\-param\-a\fP / \fB\-\-zimg\-scaler\-param\-b\fP, for chroma.
  6012. .TP
  6013. .B \fB\-\-zimg\-dither=<no|ordered|random|error\-diffusion>\fP
  6014. Dithering (default: random).
  6015. .TP
  6016. .B \fB\-\-zimg\-fast=<yes|no>\fP
  6017. Allow optimizations that help with performance, but reduce quality (default:
  6018. yes). Currently, this may simplify gamma conversion operations.
  6019. .UNINDENT
  6020. .SS Audio Resampler
  6021. .sp
  6022. This controls the default options of any resampling done by mpv (but not within
  6023. libavfilter, within the system audio API resampler, or any other places).
  6024. .sp
  6025. It also sets the defaults for the \fBlavrresample\fP audio filter.
  6026. .INDENT 0.0
  6027. .TP
  6028. .B \fB\-\-audio\-resample\-filter\-size=<length>\fP
  6029. Length of the filter with respect to the lower sampling rate. (default:
  6030. 16)
  6031. .TP
  6032. .B \fB\-\-audio\-resample\-phase\-shift=<count>\fP
  6033. Log2 of the number of polyphase entries. (..., 10\->1024, 11\->2048,
  6034. 12\->4096, ...) (default: 10\->1024)
  6035. .TP
  6036. .B \fB\-\-audio\-resample\-cutoff=<cutoff>\fP
  6037. Cutoff frequency (0.0\-1.0), default set depending upon filter length.
  6038. .TP
  6039. .B \fB\-\-audio\-resample\-linear=<yes|no>\fP
  6040. If set then filters will be linearly interpolated between polyphase
  6041. entries. (default: no)
  6042. .TP
  6043. .B \fB\-\-audio\-normalize\-downmix=<yes|no>\fP
  6044. Enable/disable normalization if surround audio is downmixed to stereo
  6045. (default: no). If this is disabled, downmix can cause clipping. If it\(aqs
  6046. enabled, the output might be too quiet. It depends on the source audio.
  6047. .sp
  6048. Technically, this changes the \fBnormalize\fP suboption of the
  6049. \fBlavrresample\fP audio filter, which performs the downmixing.
  6050. .sp
  6051. If downmix happens outside of mpv for some reason, or in the decoder
  6052. (decoder downmixing), or in the audio output (system mixer), this has no
  6053. effect.
  6054. .TP
  6055. .B \fB\-\-audio\-resample\-max\-output\-size=<length>\fP
  6056. Limit maximum size of audio frames filtered at once, in ms (default: 40).
  6057. The output size size is limited in order to make resample speed changes
  6058. react faster. This is necessary especially if decoders or filters output
  6059. very large frame sizes (like some lossless codecs or some DRC filters).
  6060. This option does not affect the resampling algorithm in any way.
  6061. .sp
  6062. For testing/debugging only. Can be removed or changed any time.
  6063. .TP
  6064. .B \fB\-\-audio\-swresample\-o=<string>\fP
  6065. Set AVOptions on the SwrContext or AVAudioResampleContext. These should
  6066. be documented by FFmpeg or Libav.
  6067. .sp
  6068. This is a key/value list option. See \fI\%List Options\fP for details.
  6069. .UNINDENT
  6070. .SS Terminal
  6071. .INDENT 0.0
  6072. .TP
  6073. .B \fB\-\-quiet\fP
  6074. Make console output less verbose; in particular, prevents the status line
  6075. (i.e. AV: 3.4 (00:00:03.37) / 5320.6 ...) from being displayed.
  6076. Particularly useful on slow terminals or broken ones which do not properly
  6077. handle carriage return (i.e. \fB\er\fP).
  6078. .sp
  6079. See also: \fB\-\-really\-quiet\fP and \fB\-\-msg\-level\fP\&.
  6080. .TP
  6081. .B \fB\-\-really\-quiet\fP
  6082. Display even less output and status messages than with \fB\-\-quiet\fP\&.
  6083. .TP
  6084. .B \fB\-\-no\-terminal\fP, \fB\-\-terminal\fP
  6085. Disable any use of the terminal and stdin/stdout/stderr. This completely
  6086. silences any message output.
  6087. .sp
  6088. Unlike \fB\-\-really\-quiet\fP, this disables input and terminal initialization
  6089. as well.
  6090. .TP
  6091. .B \fB\-\-no\-msg\-color\fP
  6092. Disable colorful console output on terminals.
  6093. .TP
  6094. .B \fB\-\-msg\-level=<module1=level1,module2=level2,...>\fP
  6095. Control verbosity directly for each module. The \fBall\fP module changes the
  6096. verbosity of all the modules. The verbosity changes from this option are
  6097. applied in order from left to right, and each item can override a previous
  6098. one.
  6099. .sp
  6100. Run mpv with \fB\-\-msg\-level=all=trace\fP to see all messages mpv outputs. You
  6101. can use the module names printed in the output (prefixed to each line in
  6102. \fB[...]\fP) to limit the output to interesting modules.
  6103. .sp
  6104. This also affects \fB\-\-log\-file\fP, and in certain cases libmpv API logging.
  6105. .sp
  6106. \fBNOTE:\fP
  6107. .INDENT 7.0
  6108. .INDENT 3.5
  6109. Some messages are printed before the command line is parsed and are
  6110. therefore not affected by \fB\-\-msg\-level\fP\&. To control these messages,
  6111. you have to use the \fBMPV_VERBOSE\fP environment variable; see
  6112. \fI\%ENVIRONMENT VARIABLES\fP for details.
  6113. .UNINDENT
  6114. .UNINDENT
  6115. .sp
  6116. Available levels:
  6117. .INDENT 7.0
  6118. .INDENT 3.5
  6119. .INDENT 0.0
  6120. .TP
  6121. .B no
  6122. complete silence
  6123. .TP
  6124. .B fatal
  6125. fatal messages only
  6126. .TP
  6127. .B error
  6128. error messages
  6129. .TP
  6130. .B warn
  6131. warning messages
  6132. .TP
  6133. .B info
  6134. informational messages
  6135. .TP
  6136. .B status
  6137. status messages (default)
  6138. .TP
  6139. .B v
  6140. verbose messages
  6141. .TP
  6142. .B debug
  6143. debug messages
  6144. .TP
  6145. .B trace
  6146. very noisy debug messages
  6147. .UNINDENT
  6148. .UNINDENT
  6149. .UNINDENT
  6150. .INDENT 7.0
  6151. .INDENT 3.5
  6152. .IP "Example"
  6153. .INDENT 0.0
  6154. .INDENT 3.5
  6155. .sp
  6156. .nf
  6157. .ft C
  6158. mpv \-\-msg\-level=ao/sndio=no
  6159. .ft P
  6160. .fi
  6161. .UNINDENT
  6162. .UNINDENT
  6163. .sp
  6164. Completely silences the output of ao_sndio, which uses the log
  6165. prefix \fB[ao/sndio]\fP\&.
  6166. .INDENT 0.0
  6167. .INDENT 3.5
  6168. .sp
  6169. .nf
  6170. .ft C
  6171. mpv \-\-msg\-level=all=warn,ao/alsa=error
  6172. .ft P
  6173. .fi
  6174. .UNINDENT
  6175. .UNINDENT
  6176. .sp
  6177. Only show warnings or worse, and let the ao_alsa output show errors
  6178. only.
  6179. .UNINDENT
  6180. .UNINDENT
  6181. .TP
  6182. .B \fB\-\-term\-osd=<auto|no|force>\fP
  6183. Control whether OSD messages are shown on the console when no video output
  6184. is available (default: auto).
  6185. .INDENT 7.0
  6186. .TP
  6187. .B auto
  6188. use terminal OSD if no video output active
  6189. .TP
  6190. .B no
  6191. disable terminal OSD
  6192. .TP
  6193. .B force
  6194. use terminal OSD even if video output active
  6195. .UNINDENT
  6196. .sp
  6197. The \fBauto\fP mode also enables terminal OSD if \fB\-\-video\-osd=no\fP was set.
  6198. .TP
  6199. .B \fB\-\-term\-osd\-bar\fP, \fB\-\-no\-term\-osd\-bar\fP
  6200. Enable printing a progress bar under the status line on the terminal.
  6201. (Disabled by default.)
  6202. .TP
  6203. .B \fB\-\-term\-osd\-bar\-chars=<string>\fP
  6204. Customize the \fB\-\-term\-osd\-bar\fP feature. The string is expected to
  6205. consist of 5 characters (start, left space, position indicator,
  6206. right space, end). You can use Unicode characters, but note that double\-
  6207. width characters will not be treated correctly.
  6208. .sp
  6209. Default: \fB[\-+\-]\fP\&.
  6210. .TP
  6211. .B \fB\-\-term\-playing\-msg=<string>\fP
  6212. Print out a string after starting playback. The string is expanded for
  6213. properties, e.g. \fB\-\-term\-playing\-msg=\(aqfile: ${filename}\(aq\fP will print the string
  6214. \fBfile:\fP followed by a space and the currently played filename.
  6215. .sp
  6216. See \fI\%Property Expansion\fP\&.
  6217. .TP
  6218. .B \fB\-\-term\-status\-msg=<string>\fP
  6219. Print out a custom string during playback instead of the standard status
  6220. line. Expands properties. See \fI\%Property Expansion\fP\&.
  6221. .TP
  6222. .B \fB\-\-msg\-module\fP
  6223. Prepend module name to each console message.
  6224. .TP
  6225. .B \fB\-\-msg\-time\fP
  6226. Prepend timing information to each console message.
  6227. .UNINDENT
  6228. .SS Cache
  6229. .INDENT 0.0
  6230. .TP
  6231. .B \fB\-\-cache=<yes|no|auto>\fP
  6232. Decide whether to use network cache settings (default: auto).
  6233. .sp
  6234. If enabled, use up to \fB\-\-cache\-secs\fP for the cache size (but still limited
  6235. to \fB\-\-demuxer\-max\-bytes\fP). \fB\-\-demuxer\-seekable\-cache=auto\fP behaves as if
  6236. it was set to \fByes\fP\&. If disabled, \fB\-\-cache\-pause\fP and related are
  6237. implicitly disabled.
  6238. .sp
  6239. The \fBauto\fP choice enables this depending on whether the stream is thought
  6240. to involve network accesses or other slow media (this is an imperfect
  6241. heuristic).
  6242. .sp
  6243. Before mpv 0.30.0, this used to accept a number, which specified the size
  6244. of the cache in kilobytes. Use e.g. \fB\-\-cache \-\-demuxer\-max\-bytes=123k\fP
  6245. instead.
  6246. .TP
  6247. .B \fB\-\-no\-cache\fP
  6248. Turn off input stream caching. See \fB\-\-cache\fP\&.
  6249. .TP
  6250. .B \fB\-\-cache\-secs=<seconds>\fP
  6251. How many seconds of audio/video to prefetch if the cache is active. This
  6252. overrides the \fB\-\-demuxer\-readahead\-secs\fP option if and only if the cache
  6253. is enabled and the value is larger. The default value is set to something
  6254. very high, so the actually achieved readahead will usually be limited by
  6255. the value of the \fB\-\-demuxer\-max\-bytes\fP option. Setting this option is
  6256. usually only useful for limiting readahead.
  6257. .TP
  6258. .B \fB\-\-cache\-on\-disk=<yes|no>\fP
  6259. Write packet data to a temporary file, instead of keeping them in memory.
  6260. This makes sense only with \fB\-\-cache\fP\&. If the normal cache is disabled,
  6261. this option is ignored.
  6262. .sp
  6263. You need to set \fB\-\-cache\-dir\fP to use this.
  6264. .sp
  6265. The cache file is append\-only. Even if the player appears to prune data, the
  6266. file space freed by it is not reused. The cache file is deleted when
  6267. playback is closed.
  6268. .sp
  6269. Note that packet metadata is still kept in memory. \fB\-\-demuxer\-max\-bytes\fP
  6270. and related options are applied to metadata \fIonly\fP\&. The size of this
  6271. metadata  varies, but 50 MB per hour of media is typical. The cache
  6272. statistics will report this metadats size, instead of the size of the cache
  6273. file. If the metadata hits the size limits, the metadata is pruned (but not
  6274. the cache file).
  6275. .sp
  6276. When the media is closed, the cache file is deleted. A cache file is
  6277. generally worthless after the media is closed, and it\(aqs hard to retrieve
  6278. any media data from it (it\(aqs not supported by design).
  6279. .sp
  6280. If the option is enabled at runtime, the cache file is created, but old data
  6281. will remain in the memory cache. If the option is disabled at runtime, old
  6282. data remains in the disk cache, and the cache file is not closed until the
  6283. media is closed. If the option is disabled and enabled again, it will
  6284. continue to use the cache file that was opened first.
  6285. .TP
  6286. .B \fB\-\-cache\-dir=<path>\fP
  6287. Directory where to create temporary files (default: none).
  6288. .sp
  6289. Currently, this is used for \fB\-\-cache\-on\-disk\fP only.
  6290. .TP
  6291. .B \fB\-\-cache\-pause=<yes|no>\fP
  6292. Whether the player should automatically pause when the cache runs out of
  6293. data and stalls decoding/playback (default: yes). If enabled, it will
  6294. pause and unpause once more data is available, aka "buffering".
  6295. .TP
  6296. .B \fB\-\-cache\-pause\-wait=<seconds>\fP
  6297. Number of seconds the packet cache should have buffered before starting
  6298. playback again if "buffering" was entered (default: 1). This can be used
  6299. to control how long the player rebuffers if \fB\-\-cache\-pause\fP is enabled,
  6300. and the demuxer underruns. If the given time is higher than the maximum
  6301. set with \fB\-\-cache\-secs\fP or  \fB\-\-demuxer\-readahead\-secs\fP, or prefetching
  6302. ends before that for some other reason (like file end or maximum configured
  6303. cache size reached), playback resumes earlier.
  6304. .TP
  6305. .B \fB\-\-cache\-pause\-initial=<yes|no>\fP
  6306. Enter "buffering" mode before starting playback (default: no). This can be
  6307. used to ensure playback starts smoothly, in exchange for waiting some time
  6308. to prefetch network data (as controlled by \fB\-\-cache\-pause\-wait\fP). For
  6309. example, some common behavior is that playback starts, but network caches
  6310. immediately underrun when trying to decode more data as playback progresses.
  6311. .sp
  6312. Another thing that can happen is that the network prefetching is so CPU
  6313. demanding (due to demuxing in the background) that playback drops frames
  6314. at first. In these cases, it helps enabling this option, and setting
  6315. \fB\-\-cache\-secs\fP and \fB\-\-cache\-pause\-wait\fP to roughly the same value.
  6316. .sp
  6317. This option also triggers when playback is restarted after seeking.
  6318. .TP
  6319. .B \fB\-\-cache\-unlink\-files=<immediate|whendone|no>\fP
  6320. Whether or when to unlink cache files (default: immediate). This affects
  6321. cache files which are inherently temporary, and which make no sense to
  6322. remain on disk after the player terminates. This is a debugging option.
  6323. .INDENT 7.0
  6324. .TP
  6325. .B \fBimmediate\fP
  6326. Unlink cache file after they were created. The cache files won\(aqt be
  6327. visible anymore, even though they\(aqre in use. This ensures they are
  6328. guaranteed to be removed from disk when the player terminates, even if
  6329. it crashes.
  6330. .TP
  6331. .B \fBwhendone\fP
  6332. Delete cache files after they are closed.
  6333. .TP
  6334. .B \fBno\fP
  6335. Don\(aqt delete cache files. They will consume disk space without having a
  6336. use.
  6337. .UNINDENT
  6338. .sp
  6339. Currently, this is used for \fB\-\-cache\-on\-disk\fP only.
  6340. .TP
  6341. .B \fB\-\-stream\-buffer\-size=<bytesize>\fP
  6342. Size of the low level stream byte buffer (default: 128KB). This is used as
  6343. buffer between demuxer and low level I/O (e.g. sockets). Generally, this
  6344. can be very small, and the main purpose is similar to the internal buffer
  6345. FILE in the C standard library will have.
  6346. .sp
  6347. Half of the buffer is always used for guaranteed seek back, which is
  6348. important for unseekable input.
  6349. .sp
  6350. There are known cases where this can help performance to set a large buffer:
  6351. .INDENT 7.0
  6352. .INDENT 3.5
  6353. .INDENT 0.0
  6354. .IP 1. 3
  6355. mp4 files. libavformat may trigger many small seeks in both
  6356. directions, depending on how the file was muxed.
  6357. .IP 2. 3
  6358. Certain network filesystems, which do not have a cache, and where
  6359. small reads can be inefficient.
  6360. .UNINDENT
  6361. .UNINDENT
  6362. .UNINDENT
  6363. .sp
  6364. In other cases, setting this to a large value can reduce performance.
  6365. .sp
  6366. Usually, read accesses are at half the buffer size, but it may happen that
  6367. accesses are done alternating with smaller and larger sizes (this is due to
  6368. the internal ring buffer wrap\-around).
  6369. .sp
  6370. See \fB\-\-list\-options\fP for defaults and value range. \fB<bytesize>\fP options
  6371. accept suffixes such as \fBKiB\fP and \fBMiB\fP\&.
  6372. .UNINDENT
  6373. .SS Network
  6374. .INDENT 0.0
  6375. .TP
  6376. .B \fB\-\-user\-agent=<string>\fP
  6377. Use \fB<string>\fP as user agent for HTTP streaming.
  6378. .TP
  6379. .B \fB\-\-cookies\fP, \fB\-\-no\-cookies\fP
  6380. Support cookies when making HTTP requests. Disabled by default.
  6381. .TP
  6382. .B \fB\-\-cookies\-file=<filename>\fP
  6383. Read HTTP cookies from <filename>. The file is assumed to be in Netscape
  6384. format.
  6385. .TP
  6386. .B \fB\-\-http\-header\-fields=<field1,field2>\fP
  6387. Set custom HTTP fields when accessing HTTP stream.
  6388. .sp
  6389. This is a string list option. See \fI\%List Options\fP for details.
  6390. .INDENT 7.0
  6391. .INDENT 3.5
  6392. .IP "Example"
  6393. .INDENT 0.0
  6394. .INDENT 3.5
  6395. .sp
  6396. .nf
  6397. .ft C
  6398. mpv \-\-http\-header\-fields=\(aqField1: value1\(aq,\(aqField2: value2\(aq \e
  6399. http://localhost:1234
  6400. .ft P
  6401. .fi
  6402. .UNINDENT
  6403. .UNINDENT
  6404. .sp
  6405. Will generate HTTP request:
  6406. .INDENT 0.0
  6407. .INDENT 3.5
  6408. .sp
  6409. .nf
  6410. .ft C
  6411. GET / HTTP/1.0
  6412. Host: localhost:1234
  6413. User\-Agent: MPlayer
  6414. Icy\-MetaData: 1
  6415. Field1: value1
  6416. Field2: value2
  6417. Connection: close
  6418. .ft P
  6419. .fi
  6420. .UNINDENT
  6421. .UNINDENT
  6422. .UNINDENT
  6423. .UNINDENT
  6424. .TP
  6425. .B \fB\-\-http\-proxy=<proxy>\fP
  6426. URL of the HTTP/HTTPS proxy. If this is set, the \fBhttp_proxy\fP environment
  6427. is ignored. The \fBno_proxy\fP environment variable is still respected. This
  6428. option is silently ignored if it does not start with \fBhttp://\fP\&. Proxies
  6429. are not used for https URLs. Setting this option does not try to make the
  6430. ytdl script use the proxy.
  6431. .TP
  6432. .B \fB\-\-tls\-ca\-file=<filename>\fP
  6433. Certificate authority database file for use with TLS. (Silently fails with
  6434. older FFmpeg or Libav versions.)
  6435. .TP
  6436. .B \fB\-\-tls\-verify\fP
  6437. Verify peer certificates when using TLS (e.g. with \fBhttps://...\fP).
  6438. (Silently fails with older FFmpeg or Libav versions.)
  6439. .TP
  6440. .B \fB\-\-tls\-cert\-file\fP
  6441. A file containing a certificate to use in the handshake with the
  6442. peer.
  6443. .TP
  6444. .B \fB\-\-tls\-key\-file\fP
  6445. A file containing the private key for the certificate.
  6446. .TP
  6447. .B \fB\-\-referrer=<string>\fP
  6448. Specify a referrer path or URL for HTTP requests.
  6449. .TP
  6450. .B \fB\-\-network\-timeout=<seconds>\fP
  6451. Specify the network timeout in seconds (default: 60 seconds). This affects
  6452. at least HTTP. The special value 0 uses the FFmpeg/Libav defaults. If a
  6453. protocol is used which does not support timeouts, this option is silently
  6454. ignored.
  6455. .sp
  6456. \fBWARNING:\fP
  6457. .INDENT 7.0
  6458. .INDENT 3.5
  6459. This breaks the RTSP protocol, because of inconsistent FFmpeg API
  6460. regarding its internal timeout option. Not only does the RTSP timeout
  6461. option accept different units (seconds instead of microseconds, causing
  6462. mpv to pass it huge values), it will also overflow FFmpeg internal
  6463. calculations. The worst is that merely setting the option will put RTSP
  6464. into listening mode, which breaks any client uses. At time of this
  6465. writing, the fix was not made effective yet. For this reason, this
  6466. option is ignored (or should be ignored) on RTSP URLs. You can still
  6467. set the timeout option directly with \fB\-\-demuxer\-lavf\-o\fP\&.
  6468. .UNINDENT
  6469. .UNINDENT
  6470. .TP
  6471. .B \fB\-\-rtsp\-transport=<lavf|udp|tcp|http>\fP
  6472. Select RTSP transport method (default: tcp). This selects the underlying
  6473. network transport when playing \fBrtsp://...\fP URLs. The value \fBlavf\fP
  6474. leaves the decision to libavformat.
  6475. .TP
  6476. .B \fB\-\-hls\-bitrate=<no|min|max|<rate>>\fP
  6477. If HLS streams are played, this option controls what streams are selected
  6478. by default. The option allows the following parameters:
  6479. .INDENT 7.0
  6480. .TP
  6481. .B no
  6482. Don\(aqt do anything special. Typically, this will simply pick the
  6483. first audio/video streams it can find.
  6484. .TP
  6485. .B min
  6486. Pick the streams with the lowest bitrate.
  6487. .TP
  6488. .B max
  6489. Same, but highest bitrate. (Default.)
  6490. .UNINDENT
  6491. .sp
  6492. Additionally, if the option is a number, the stream with the highest rate
  6493. equal or below the option value is selected.
  6494. .sp
  6495. The bitrate as used is sent by the server, and there\(aqs no guarantee it\(aqs
  6496. actually meaningful.
  6497. .UNINDENT
  6498. .SS DVB
  6499. .INDENT 0.0
  6500. .TP
  6501. .B \fB\-\-dvbin\-prog=<string>\fP
  6502. This defines the program to tune to. Usually, you may specify this
  6503. by using a stream URI like \fB"dvb://ZDF HD"\fP, but you can tune to a
  6504. different channel by writing to this property at runtime.
  6505. Also see \fBdvbin\-channel\-switch\-offset\fP for more useful channel
  6506. switching functionality.
  6507. .TP
  6508. .B \fB\-\-dvbin\-card=<0\-15>\fP
  6509. Specifies using card number 0\-15 (default: 0).
  6510. .TP
  6511. .B \fB\-\-dvbin\-file=<filename>\fP
  6512. Instructs mpv to read the channels list from \fB<filename>\fP\&. The default is
  6513. in the mpv configuration directory (usually \fB~/.config/mpv\fP) with the
  6514. filename \fBchannels.conf.{sat,ter,cbl,atsc}\fP (based on your card type) or
  6515. \fBchannels.conf\fP as a last resort.
  6516. For DVB\-S/2 cards, a VDR 1.7.x format channel list is recommended
  6517. as it allows tuning to DVB\-S2 channels, enabling subtitles and
  6518. decoding the PMT (which largely improves the demuxing).
  6519. Classic mplayer format channel lists are still supported (without
  6520. these improvements), and for other card types, only limited VDR
  6521. format channel list support is implemented (patches welcome).
  6522. For channels with dynamic PID switching or incomplete
  6523. \fBchannels.conf\fP, \fB\-\-dvbin\-full\-transponder\fP or the magic PID
  6524. \fB8192\fP are recommended.
  6525. .TP
  6526. .B \fB\-\-dvbin\-timeout=<1\-30>\fP
  6527. Maximum number of seconds to wait when trying to tune a frequency before
  6528. giving up (default: 30).
  6529. .TP
  6530. .B \fB\-\-dvbin\-full\-transponder=<yes|no>\fP
  6531. Apply no filters on program PIDs, only tune to frequency and pass full
  6532. transponder to demuxer.
  6533. The player frontend selects the streams from the full TS in this case,
  6534. so the program which is shown initially may not match the chosen channel.
  6535. Switching between the programs is possible by cycling the \fBprogram\fP
  6536. property.
  6537. This is useful to record multiple programs on a single transponder,
  6538. or to work around issues in the \fBchannels.conf\fP\&.
  6539. It is also recommended to use this for channels which switch PIDs
  6540. on\-the\-fly, e.g. for regional news.
  6541. .sp
  6542. Default: \fBno\fP
  6543. .TP
  6544. .B \fB\-\-dvbin\-channel\-switch\-offset=<integer>\fP
  6545. This value is not meant for setting via configuration, but used in channel
  6546. switching. An \fBinput.conf\fP can \fBcycle\fP this value \fBup\fP and \fBdown\fP
  6547. to perform channel switching. This number effectively gives the offset
  6548. to the initially tuned to channel in the channel list.
  6549. .sp
  6550. An example \fBinput.conf\fP could contain:
  6551. \fBH cycle dvbin\-channel\-switch\-offset up\fP, \fBK cycle dvbin\-channel\-switch\-offset down\fP
  6552. .UNINDENT
  6553. .SS ALSA audio output options
  6554. .INDENT 0.0
  6555. .TP
  6556. .B \fB\-\-alsa\-device=<device>\fP
  6557. Deprecated, use \fB\-\-audio\-device\fP (requires \fBalsa/\fP prefix).
  6558. .TP
  6559. .B \fB\-\-alsa\-resample=yes\fP
  6560. Enable ALSA resampling plugin. (This is disabled by default, because
  6561. some drivers report incorrect audio delay in some cases.)
  6562. .TP
  6563. .B \fB\-\-alsa\-mixer\-device=<device>\fP
  6564. Set the mixer device used with \fBao\-volume\fP (default: \fBdefault\fP).
  6565. .TP
  6566. .B \fB\-\-alsa\-mixer\-name=<name>\fP
  6567. Set the name of the mixer element (default: \fBMaster\fP). This is for
  6568. example \fBPCM\fP or \fBMaster\fP\&.
  6569. .TP
  6570. .B \fB\-\-alsa\-mixer\-index=<number>\fP
  6571. Set the index of the mixer channel (default: 0). Consider the output of
  6572. "\fBamixer scontrols\fP", then the index is the number that follows the
  6573. name of the element.
  6574. .TP
  6575. .B \fB\-\-alsa\-non\-interleaved\fP
  6576. Allow output of non\-interleaved formats (if the audio decoder uses
  6577. this format). Currently disabled by default, because some popular
  6578. ALSA plugins are utterly broken with non\-interleaved formats.
  6579. .TP
  6580. .B \fB\-\-alsa\-ignore\-chmap\fP
  6581. Don\(aqt read or set the channel map of the ALSA device \- only request the
  6582. required number of channels, and then pass the audio as\-is to it. This
  6583. option most likely should not be used. It can be useful for debugging,
  6584. or for static setups with a specially engineered ALSA configuration (in
  6585. this case you should always force the same layout with \fB\-\-audio\-channels\fP,
  6586. or it will work only for files which use the layout implicit to your
  6587. ALSA device).
  6588. .TP
  6589. .B \fB\-\-alsa\-buffer\-time=<microseconds>\fP
  6590. Set the requested buffer time in microseconds. A value of 0 skips requesting
  6591. anything from the ALSA API. This and the \fB\-\-alsa\-periods\fP option uses the
  6592. ALSA \fBnear\fP functions to set the requested parameters. If doing so results
  6593. in an empty configuration set, setting these parameters is skipped.
  6594. .sp
  6595. Both options control the buffer size. A low buffer size can lead to higher
  6596. CPU usage and audio dropouts, while a high buffer size can lead to higher
  6597. latency in volume changes and other filtering.
  6598. .TP
  6599. .B \fB\-\-alsa\-periods=<number>\fP
  6600. Number of periods requested from the ALSA API. See \fB\-\-alsa\-buffer\-time\fP
  6601. for further remarks.
  6602. .UNINDENT
  6603. .SS GPU renderer options
  6604. .sp
  6605. The following video options are currently all specific to \fB\-\-vo=gpu\fP and
  6606. \fB\-\-vo=libmpv\fP only, which are the only VOs that implement them.
  6607. .INDENT 0.0
  6608. .TP
  6609. .B \fB\-\-scale=<filter>\fP
  6610. The filter function to use when upscaling video.
  6611. .INDENT 7.0
  6612. .TP
  6613. .B \fBbilinear\fP
  6614. Bilinear hardware texture filtering (fastest, very low quality). This
  6615. is the default for compatibility reasons.
  6616. .TP
  6617. .B \fBspline36\fP
  6618. Mid quality and speed. This is the default when using \fBgpu\-hq\fP\&.
  6619. .TP
  6620. .B \fBlanczos\fP
  6621. Lanczos scaling. Provides mid quality and speed. Generally worse than
  6622. \fBspline36\fP, but it results in a slightly sharper image which is good
  6623. for some content types. The number of taps can be controlled with
  6624. \fBscale\-radius\fP, but is best left unchanged.
  6625. .sp
  6626. (This filter is an alias for \fBsinc\fP\-windowed \fBsinc\fP)
  6627. .TP
  6628. .B \fBewa_lanczos\fP
  6629. Elliptic weighted average Lanczos scaling. Also known as Jinc.
  6630. Relatively slow, but very good quality. The radius can be controlled
  6631. with \fBscale\-radius\fP\&. Increasing the radius makes the filter sharper
  6632. but adds more ringing.
  6633. .sp
  6634. (This filter is an alias for \fBjinc\fP\-windowed \fBjinc\fP)
  6635. .TP
  6636. .B \fBewa_lanczossharp\fP
  6637. A slightly sharpened version of ewa_lanczos, preconfigured to use an
  6638. ideal radius and parameter. If your hardware can run it, this is
  6639. probably what you should use by default.
  6640. .TP
  6641. .B \fBmitchell\fP
  6642. Mitchell\-Netravali. The \fBB\fP and \fBC\fP parameters can be set with
  6643. \fB\-\-scale\-param1\fP and \fB\-\-scale\-param2\fP\&. This filter is very good at
  6644. downscaling (see \fB\-\-dscale\fP).
  6645. .TP
  6646. .B \fBoversample\fP
  6647. A version of nearest neighbour that (naively) oversamples pixels, so
  6648. that pixels overlapping edges get linearly interpolated instead of
  6649. rounded. This essentially removes the small imperfections and judder
  6650. artifacts caused by nearest\-neighbour interpolation, in exchange for
  6651. adding some blur. This filter is good at temporal interpolation, and
  6652. also known as "smoothmotion" (see \fB\-\-tscale\fP).
  6653. .TP
  6654. .B \fBlinear\fP
  6655. A \fB\-\-tscale\fP filter.
  6656. .UNINDENT
  6657. .sp
  6658. There are some more filters, but most are not as useful. For a complete
  6659. list, pass \fBhelp\fP as value, e.g.:
  6660. .INDENT 7.0
  6661. .INDENT 3.5
  6662. .sp
  6663. .nf
  6664. .ft C
  6665. mpv \-\-scale=help
  6666. .ft P
  6667. .fi
  6668. .UNINDENT
  6669. .UNINDENT
  6670. .TP
  6671. .B \fB\-\-cscale=<filter>\fP
  6672. As \fB\-\-scale\fP, but for interpolating chroma information. If the image is
  6673. not subsampled, this option is ignored entirely.
  6674. .TP
  6675. .B \fB\-\-dscale=<filter>\fP
  6676. Like \fB\-\-scale\fP, but apply these filters on downscaling instead. If this
  6677. option is unset, the filter implied by \fB\-\-scale\fP will be applied.
  6678. .TP
  6679. .B \fB\-\-tscale=<filter>\fP
  6680. The filter used for interpolating the temporal axis (frames). This is only
  6681. used if \fB\-\-interpolation\fP is enabled. The only valid choices for
  6682. \fB\-\-tscale\fP are separable convolution filters (use \fB\-\-tscale=help\fP to
  6683. get a list). The default is \fBmitchell\fP\&.
  6684. .sp
  6685. Common \fB\-\-tscale\fP choices include \fBoversample\fP, \fBlinear\fP,
  6686. \fBcatmull_rom\fP, \fBmitchell\fP, \fBgaussian\fP, or \fBbicubic\fP\&. These are
  6687. listed in increasing order of smoothness/blurriness, with \fBbicubic\fP
  6688. being the smoothest/blurriest and \fBoversample\fP being the sharpest/least
  6689. smooth.
  6690. .TP
  6691. .B \fB\-\-scale\-param1=<value>\fP, \fB\-\-scale\-param2=<value>\fP, \fB\-\-cscale\-param1=<value>\fP, \fB\-\-cscale\-param2=<value>\fP, \fB\-\-dscale\-param1=<value>\fP, \fB\-\-dscale\-param2=<value>\fP, \fB\-\-tscale\-param1=<value>\fP, \fB\-\-tscale\-param2=<value>\fP
  6692. Set filter parameters. By default, these are set to the special string
  6693. \fBdefault\fP, which maps to a scaler\-specific default value. Ignored if the
  6694. filter is not tunable. Currently, this affects the following filter
  6695. parameters:
  6696. .INDENT 7.0
  6697. .TP
  6698. .B bcspline
  6699. Spline parameters (\fBB\fP and \fBC\fP). Defaults to 0.5 for both.
  6700. .TP
  6701. .B gaussian
  6702. Scale parameter (\fBt\fP). Increasing this makes the result blurrier.
  6703. Defaults to 1.
  6704. .TP
  6705. .B oversample
  6706. Minimum distance to an edge before interpolation is used. Setting this
  6707. to 0 will always interpolate edges, whereas setting it to 0.5 will
  6708. never interpolate, thus behaving as if the regular nearest neighbour
  6709. algorithm was used. Defaults to 0.0.
  6710. .UNINDENT
  6711. .TP
  6712. .B \fB\-\-scale\-blur=<value>\fP, \fB\-\-scale\-wblur=<value>\fP, \fB\-\-cscale\-blur=<value>\fP, \fB\-\-cscale\-wblur=<value>\fP, \fB\-\-dscale\-blur=<value>\fP, \fB\-\-dscale\-wblur=<value>\fP, \fB\-\-tscale\-blur=<value>\fP, \fB\-\-tscale\-wblur=<value>\fP
  6713. Kernel/window scaling factor (also known as a blur factor). Decreasing this
  6714. makes the result sharper, increasing it makes it blurrier (default 0). If
  6715. set to 0, the kernel\(aqs preferred blur factor is used. Note that setting
  6716. this too low (eg. 0.5) leads to bad results. It\(aqs generally recommended to
  6717. stick to values between 0.8 and 1.2.
  6718. .TP
  6719. .B \fB\-\-scale\-clamp=<0.0\-1.0>\fP, \fB\-\-cscale\-clamp\fP, \fB\-\-dscale\-clamp\fP, \fB\-\-tscale\-clamp\fP
  6720. Specifies a weight bias to multiply into negative coefficients. Specifying
  6721. \fB\-\-scale\-clamp=1\fP has the effect of removing negative weights completely,
  6722. thus effectively clamping the value range to [0\-1]. Values between 0.0 and
  6723. 1.0 can be specified to apply only a moderate diminishment of negative
  6724. weights. This is especially useful for \fB\-\-tscale\fP, where it reduces
  6725. excessive ringing artifacts in the temporal domain (which typically
  6726. manifest themselves as short flashes or fringes of black, mostly around
  6727. moving edges) in exchange for potentially adding more blur. The default for
  6728. \fB\-\-tscale\-clamp\fP is 1.0, the others default to 0.0.
  6729. .TP
  6730. .B \fB\-\-scale\-cutoff=<value>\fP, \fB\-\-cscale\-cutoff=<value>\fP, \fB\-\-dscale\-cutoff=<value>\fP
  6731. Cut off the filter kernel prematurely once the value range drops below
  6732. this threshold. Doing so allows more aggressive pruning of skippable
  6733. coefficients by disregarding parts of the LUT which are effectively zeroed
  6734. out by the window function. Only affects polar (EWA) filters. The default
  6735. is 0.001 for each, which is perceptually transparent but provides a 10%\-20%
  6736. speedup, depending on the exact radius and filter kernel chosen.
  6737. .TP
  6738. .B \fB\-\-scale\-taper=<value>\fP, \fB\-\-scale\-wtaper=<value>\fP, \fB\-\-dscale\-taper=<value>\fP, \fB\-\-dscale\-wtaper=<value>\fP, \fB\-\-cscale\-taper=<value>\fP, \fB\-\-cscale\-wtaper=<value>\fP, \fB\-\-tscale\-taper=<value>\fP, \fB\-\-tscale\-wtaper=<value>\fP
  6739. Kernel/window taper factor. Increasing this flattens the filter function.
  6740. Value range is 0 to 1. A value of 0 (the default) means no flattening, a
  6741. value of 1 makes the filter completely flat (equivalent to a box function).
  6742. Values in between mean that some portion will be flat and the actual filter
  6743. function will be squeezed into the space in between.
  6744. .TP
  6745. .B \fB\-\-scale\-radius=<value>\fP, \fB\-\-cscale\-radius=<value>\fP, \fB\-\-dscale\-radius=<value>\fP, \fB\-\-tscale\-radius=<value>\fP
  6746. Set radius for tunable filters, must be a float number between 0.5 and
  6747. 16.0. Defaults to the filter\(aqs preferred radius if not specified. Doesn\(aqt
  6748. work for every scaler and VO combination.
  6749. .sp
  6750. Note that depending on filter implementation details and video scaling
  6751. ratio, the radius that actually being used might be different (most likely
  6752. being increased a bit).
  6753. .TP
  6754. .B \fB\-\-scale\-antiring=<value>\fP, \fB\-\-cscale\-antiring=<value>\fP, \fB\-\-dscale\-antiring=<value>\fP, \fB\-\-tscale\-antiring=<value>\fP
  6755. Set the antiringing strength. This tries to eliminate ringing, but can
  6756. introduce other artifacts in the process. Must be a float number between
  6757. 0.0 and 1.0. The default value of 0.0 disables antiringing entirely.
  6758. .sp
  6759. Note that this doesn\(aqt affect the special filters \fBbilinear\fP and
  6760. \fBbicubic_fast\fP, nor does it affect any polar (EWA) scalers.
  6761. .TP
  6762. .B \fB\-\-scale\-window=<window>\fP, \fB\-\-cscale\-window=<window>\fP, \fB\-\-dscale\-window=<window>\fP, \fB\-\-tscale\-window=<window>\fP
  6763. (Advanced users only) Choose a custom windowing function for the kernel.
  6764. Defaults to the filter\(aqs preferred window if unset. Use
  6765. \fB\-\-scale\-window=help\fP to get a list of supported windowing functions.
  6766. .TP
  6767. .B \fB\-\-scale\-wparam=<window>\fP, \fB\-\-cscale\-wparam=<window>\fP, \fB\-\-cscale\-wparam=<window>\fP, \fB\-\-tscale\-wparam=<window>\fP
  6768. (Advanced users only) Configure the parameter for the window function given
  6769. by \fB\-\-scale\-window\fP etc. By default, these are set to the special string
  6770. \fBdefault\fP, which maps to a window\-specific default value. Ignored if the
  6771. window is not tunable. Currently, this affects the following window
  6772. parameters:
  6773. .INDENT 7.0
  6774. .TP
  6775. .B kaiser
  6776. Window parameter (alpha). Defaults to 6.33.
  6777. .TP
  6778. .B blackman
  6779. Window parameter (alpha). Defaults to 0.16.
  6780. .TP
  6781. .B gaussian
  6782. Scale parameter (t). Increasing this makes the window wider. Defaults
  6783. to 1.
  6784. .UNINDENT
  6785. .TP
  6786. .B \fB\-\-scaler\-lut\-size=<4..10>\fP
  6787. Set the size of the lookup texture for scaler kernels (default: 6). The
  6788. actual size of the texture is \fB2^N\fP for an option value of \fBN\fP\&. So the
  6789. lookup texture with the default setting uses 64 samples.
  6790. .sp
  6791. All weights are linearly interpolated from those samples, so increasing
  6792. the size of lookup table might improve the accuracy of scaler.
  6793. .TP
  6794. .B \fB\-\-scaler\-resizes\-only\fP
  6795. Disable the scaler if the video image is not resized. In that case,
  6796. \fBbilinear\fP is used instead of whatever is set with \fB\-\-scale\fP\&. Bilinear
  6797. will reproduce the source image perfectly if no scaling is performed.
  6798. Enabled by default. Note that this option never affects \fB\-\-cscale\fP\&.
  6799. .TP
  6800. .B \fB\-\-correct\-downscaling\fP
  6801. When using convolution based filters, extend the filter size when
  6802. downscaling. Increases quality, but reduces performance while downscaling.
  6803. .sp
  6804. This will perform slightly sub\-optimally for anamorphic video (but still
  6805. better than without it) since it will extend the size to match only the
  6806. milder of the scale factors between the axes.
  6807. .TP
  6808. .B \fB\-\-linear\-downscaling\fP
  6809. Scale in linear light when downscaling. It should only be used with a
  6810. \fB\-\-fbo\-format\fP that has at least 16 bit precision. This option
  6811. has no effect on HDR content.
  6812. .TP
  6813. .B \fB\-\-linear\-upscaling\fP
  6814. Scale in linear light when upscaling. Like \fB\-\-linear\-downscaling\fP, it
  6815. should only be used with a \fB\-\-fbo\-format\fP that has at least 16 bits
  6816. precisions. This is not usually recommended except for testing/specific
  6817. purposes. Users are advised to either enable \fB\-\-sigmoid\-upscaling\fP or
  6818. keep both options disabled (i.e. scaling in gamma light).
  6819. .TP
  6820. .B \fB\-\-sigmoid\-upscaling\fP
  6821. When upscaling, use a sigmoidal color transform to avoid emphasizing
  6822. ringing artifacts. This is incompatible with and replaces
  6823. \fB\-\-linear\-upscaling\fP\&. (Note that sigmoidization also requires
  6824. linearization, so the \fBLINEAR\fP rendering step fires in both cases)
  6825. .TP
  6826. .B \fB\-\-sigmoid\-center\fP
  6827. The center of the sigmoid curve used for \fB\-\-sigmoid\-upscaling\fP, must be a
  6828. float between 0.0 and 1.0. Defaults to 0.75 if not specified.
  6829. .TP
  6830. .B \fB\-\-sigmoid\-slope\fP
  6831. The slope of the sigmoid curve used for \fB\-\-sigmoid\-upscaling\fP, must be a
  6832. float between 1.0 and 20.0. Defaults to 6.5 if not specified.
  6833. .TP
  6834. .B \fB\-\-interpolation\fP
  6835. Reduce stuttering caused by mismatches in the video fps and display refresh
  6836. rate (also known as judder).
  6837. .sp
  6838. \fBWARNING:\fP
  6839. .INDENT 7.0
  6840. .INDENT 3.5
  6841. This requires setting the \fB\-\-video\-sync\fP option to one
  6842. of the \fBdisplay\-\fP modes, or it will be silently disabled.
  6843. This was not required before mpv 0.14.0.
  6844. .UNINDENT
  6845. .UNINDENT
  6846. .sp
  6847. This essentially attempts to interpolate the missing frames by convoluting
  6848. the video along the temporal axis. The filter used can be controlled using
  6849. the \fB\-\-tscale\fP setting.
  6850. .TP
  6851. .B \fB\-\-interpolation\-threshold=<0..1,\-1>\fP
  6852. Threshold below which frame ratio interpolation gets disabled (default:
  6853. \fB0.0001\fP). This is calculated as \fBabs(disphz/vfps \- 1) < threshold\fP,
  6854. where \fBvfps\fP is the speed\-adjusted video FPS, and \fBdisphz\fP the
  6855. display refresh rate. (The speed\-adjusted video FPS is roughly equal to
  6856. the normal video FPS, but with slowdown and speedup applied. This matters
  6857. if you use \fB\-\-video\-sync=display\-resample\fP to make video run synchronously
  6858. to the display FPS, or if you change the \fBspeed\fP property.)
  6859. .sp
  6860. The default is intended to almost always enable interpolation if the
  6861. playback rate is even slightly different from the display refresh rate. But
  6862. note that if you use e.g. \fB\-\-video\-sync=display\-vdrop\fP, small deviations
  6863. in the rate can disable interpolation and introduce a discontinuity every
  6864. other minute.
  6865. .sp
  6866. Set this to \fB\-1\fP to disable this logic.
  6867. .TP
  6868. .B \fB\-\-opengl\-pbo\fP
  6869. Enable use of PBOs. On some drivers this can be faster, especially if the
  6870. source video size is huge (e.g. so called "4K" video). On other drivers it
  6871. might be slower or cause latency issues.
  6872. .TP
  6873. .B \fB\-\-dither\-depth=<N|no|auto>\fP
  6874. Set dither target depth to N. Default: no.
  6875. .INDENT 7.0
  6876. .TP
  6877. .B no
  6878. Disable any dithering done by mpv.
  6879. .TP
  6880. .B auto
  6881. Automatic selection. If output bit depth cannot be detected, 8 bits per
  6882. component are assumed.
  6883. .TP
  6884. .B 8
  6885. Dither to 8 bit output.
  6886. .UNINDENT
  6887. .sp
  6888. Note that the depth of the connected video display device cannot be
  6889. detected. Often, LCD panels will do dithering on their own, which conflicts
  6890. with this option and leads to ugly output.
  6891. .TP
  6892. .B \fB\-\-dither\-size\-fruit=<2\-8>\fP
  6893. Set the size of the dither matrix (default: 6). The actual size of the
  6894. matrix is \fB(2^N) x (2^N)\fP for an option value of \fBN\fP, so a value of 6
  6895. gives a size of 64x64. The matrix is generated at startup time, and a large
  6896. matrix can take rather long to compute (seconds).
  6897. .sp
  6898. Used in \fB\-\-dither=fruit\fP mode only.
  6899. .TP
  6900. .B \fB\-\-dither=<fruit|ordered|error\-diffusion|no>\fP
  6901. Select dithering algorithm (default: fruit). (Normally, the
  6902. \fB\-\-dither\-depth\fP option controls whether dithering is enabled.)
  6903. .sp
  6904. The \fBerror\-diffusion\fP option requires compute shader support. It also
  6905. requires large amount of shared memory to run, the size of which depends on
  6906. both the kernel (see \fB\-\-error\-diffusion\fP option below) and the height of
  6907. video window. It will fallback to \fBfruit\fP dithering if there is no enough
  6908. shared memory to run the shader.
  6909. .TP
  6910. .B \fB\-\-temporal\-dither\fP
  6911. Enable temporal dithering. (Only active if dithering is enabled in
  6912. general.) This changes between 8 different dithering patterns on each frame
  6913. by changing the orientation of the tiled dithering matrix. Unfortunately,
  6914. this can lead to flicker on LCD displays, since these have a high reaction
  6915. time.
  6916. .TP
  6917. .B \fB\-\-temporal\-dither\-period=<1\-128>\fP
  6918. Determines how often the dithering pattern is updated when
  6919. \fB\-\-temporal\-dither\fP is in use. 1 (the default) will update on every video
  6920. frame, 2 on every other frame, etc.
  6921. .TP
  6922. .B \fB\-\-error\-diffusion=<kernel>\fP
  6923. The error diffusion kernel to use when \fB\-\-dither=error\-diffusion\fP is set.
  6924. .INDENT 7.0
  6925. .TP
  6926. .B \fBsimple\fP
  6927. Propagate error to only two adjacent pixels. Fastest but low quality.
  6928. .TP
  6929. .B \fBsierra\-lite\fP
  6930. Fast with reasonable quality. This is the default.
  6931. .TP
  6932. .B \fBfloyd\-steinberg\fP
  6933. Most notable error diffusion kernel.
  6934. .TP
  6935. .B \fBatkinson\fP
  6936. Looks different from other kernels because only fraction of errors will
  6937. be propagated during dithering. A typical use case of this kernel is
  6938. saving dithered screenshot (in window mode). This kernel produces
  6939. slightly smaller file, with still reasonable dithering quality.
  6940. .UNINDENT
  6941. .sp
  6942. There are other kernels (use \fB\-\-error\-diffusion=help\fP to list) but most of
  6943. them are much slower and demanding even larger amount of shared memory.
  6944. Among these kernels, \fBburkes\fP achieves a good balance between performance
  6945. and quality, and probably is the one you want to try first.
  6946. .TP
  6947. .B \fB\-\-gpu\-debug\fP
  6948. Enables GPU debugging. What this means depends on the API type. For OpenGL,
  6949. it calls \fBglGetError()\fP, and requests a debug context. For Vulkan, it
  6950. enables validation layers.
  6951. .TP
  6952. .B \fB\-\-opengl\-swapinterval=<n>\fP
  6953. Interval in displayed frames between two buffer swaps. 1 is equivalent to
  6954. enable VSYNC, 0 to disable VSYNC. Defaults to 1 if not specified.
  6955. .sp
  6956. Note that this depends on proper OpenGL vsync support. On some platforms
  6957. and drivers, this only works reliably when in fullscreen mode. It may also
  6958. require driver\-specific hacks if using multiple monitors, to ensure mpv
  6959. syncs to the right one. Compositing window managers can also lead to bad
  6960. results, as can missing or incorrect display FPS information (see
  6961. \fB\-\-override\-display\-fps\fP).
  6962. .TP
  6963. .B \fB\-\-vulkan\-swap\-mode=<mode>\fP
  6964. Controls the presentation mode of the vulkan swapchain. This is similar
  6965. to the \fB\-\-opengl\-swapinterval\fP option.
  6966. .INDENT 7.0
  6967. .TP
  6968. .B auto
  6969. Use the preferred swapchain mode for the vulkan context. (Default)
  6970. .TP
  6971. .B fifo
  6972. Non\-tearing, vsync blocked. Similar to "VSync on".
  6973. .TP
  6974. .B fifo\-relaxed
  6975. Tearing, vsync blocked. Late frames will tear instead of stuttering.
  6976. .TP
  6977. .B mailbox
  6978. Non\-tearing, not vsync blocked. Similar to "triple buffering".
  6979. .TP
  6980. .B immediate
  6981. Tearing, not vsync blocked. Similar to "VSync off".
  6982. .UNINDENT
  6983. .TP
  6984. .B \fB\-\-vulkan\-queue\-count=<1..8>\fP
  6985. Controls the number of VkQueues used for rendering (limited by how many
  6986. your device supports). In theory, using more queues could enable some
  6987. parallelism between frames (when using a \fB\-\-swapchain\-depth\fP higher than
  6988. 1), but it can also slow things down on hardware where there\(aqs no true
  6989. parallelism between queues. (Default: 1)
  6990. .TP
  6991. .B \fB\-\-vulkan\-async\-transfer\fP
  6992. Enables the use of async transfer queues on supported vulkan devices. Using
  6993. them allows transfer operations like texture uploads and blits to happen
  6994. concurrently with the actual rendering, thus improving overall throughput
  6995. and power consumption. Enabled by default, and should be relatively safe.
  6996. .TP
  6997. .B \fB\-\-vulkan\-async\-compute\fP
  6998. Enables the use of async compute queues on supported vulkan devices. Using
  6999. this, in theory, allows out\-of\-order scheduling of compute shaders with
  7000. graphics shaders, thus enabling the hardware to do more effective work while
  7001. waiting for pipeline bubbles and memory operations. Not beneficial on all
  7002. GPUs. It\(aqs worth noting that if async compute is enabled, and the device
  7003. supports more compute queues than graphics queues (bound by the restrictions
  7004. set by \fB\-\-vulkan\-queue\-count\fP), mpv will internally try and prefer the
  7005. use of compute shaders over fragment shaders wherever possible. Enabled by
  7006. default, although Nvidia users may want to disable it.
  7007. .TP
  7008. .B \fB\-\-d3d11\-warp=<yes|no|auto>\fP
  7009. Use WARP (Windows Advanced Rasterization Platform) with the D3D11 GPU
  7010. backend (default: auto). This is a high performance software renderer. By
  7011. default, it is only used when the system has no hardware adapters that
  7012. support D3D11. While the extended GPU features will work with WARP, they
  7013. can be very slow.
  7014. .TP
  7015. .B \fB\-\-d3d11\-feature\-level=<12_1|12_0|11_1|11_0|10_1|10_0|9_3|9_2|9_1>\fP
  7016. Select a specific feature level when using the D3D11 GPU backend. By
  7017. default, the highest available feature level is used. This option can be
  7018. used to select a lower feature level, which is mainly useful for debugging.
  7019. Most extended GPU features will not work at 9_x feature levels.
  7020. .TP
  7021. .B \fB\-\-d3d11\-flip=<yes|no>\fP
  7022. Enable flip\-model presentation, which avoids unnecessarily copying the
  7023. backbuffer by sharing surfaces with the DWM (default: yes). This may cause
  7024. performance issues with older drivers. If flip\-model presentation is not
  7025. supported (for example, on Windows 7 without the platform update), mpv will
  7026. automatically fall back to the older bitblt presentation model.
  7027. .TP
  7028. .B \fB\-\-d3d11\-sync\-interval=<0..4>\fP
  7029. Schedule each frame to be presented for this number of VBlank intervals.
  7030. (default: 1) Setting to 1 will enable VSync, setting to 0 will disable it.
  7031. .TP
  7032. .B \fB\-\-d3d11\-adapter=<adapter name|help>\fP
  7033. Select a specific D3D11 adapter to utilize for D3D11 rendering.
  7034. Will pick the default adapter if unset. Alternatives are listed
  7035. when the name "help" is given.
  7036. .sp
  7037. Checks for matches based on the start of the string, case
  7038. insensitive. Thus, if the description of the adapter starts with
  7039. the vendor name, that can be utilized as the selection parameter.
  7040. .sp
  7041. Hardware decoders utilizing the D3D11 rendering abstraction\(aqs helper
  7042. functionality to receive a device, such as D3D11VA or DXVA2\(aqs DXGI
  7043. mode, will be affected by this choice.
  7044. .TP
  7045. .B \fB\-\-d3d11\-output\-format=<auto|rgba8|bgra8|rgb10_a2|rgba16f>\fP
  7046. Select a specific D3D11 output format to utilize for D3D11 rendering.
  7047. "auto" is the default, which will pick either rgba8 or rgb10_a2 depending
  7048. on the configured desktop bit depth. rgba16f and bgra8 are left out of
  7049. the autodetection logic, and are available for manual testing.
  7050. .sp
  7051. \fBNOTE:\fP
  7052. .INDENT 7.0
  7053. .INDENT 3.5
  7054. Desktop bit depth querying is only available from an API available
  7055. from Windows 10. Thus on older systems it will only automatically
  7056. utilize the rgba8 output format.
  7057. .UNINDENT
  7058. .UNINDENT
  7059. .TP
  7060. .B \fB\-\-d3d11\-output\-csp=<auto|srgb|linear|pq|bt.2020>\fP
  7061. Select a specific D3D11 output color space to utilize for D3D11 rendering.
  7062. "auto" is the default, which will select the color space of the desktop
  7063. on which the swap chain is located.
  7064. .sp
  7065. Values other than "srgb" and "pq" have had issues in testing, so they
  7066. are mostly available for manual testing.
  7067. .sp
  7068. \fBNOTE:\fP
  7069. .INDENT 7.0
  7070. .INDENT 3.5
  7071. Swap chain color space configuration is only available from an API
  7072. available from Windows 10. Thus on older systems it will not work.
  7073. .UNINDENT
  7074. .UNINDENT
  7075. .TP
  7076. .B \fB\-\-d3d11va\-zero\-copy=<yes|no>\fP
  7077. By default, when using hardware decoding with \fB\-\-gpu\-api=d3d11\fP, the
  7078. video image will be copied (GPU\-to\-GPU) from the decoder surface to a
  7079. shader resource. Set this option to avoid that copy by sampling directly
  7080. from the decoder image. This may increase performance and reduce power
  7081. usage, but can cause the image to be sampled incorrectly on the bottom and
  7082. right edges due to padding, and may invoke driver bugs, since Direct3D 11
  7083. technically does not allow sampling from a decoder surface (though most
  7084. drivers support it.)
  7085. .sp
  7086. Currently only relevant for \fB\-\-gpu\-api=d3d11\fP\&.
  7087. .TP
  7088. .B \fB\-\-wayland\-frame\-wait\-offset=<\-500..3000>\fP
  7089. Control the amount of offset (in microseconds) to add to wayland\(aqs frame wait
  7090. (default 1000). The wayland context assumes that if frame callback or presentation
  7091. feedback isn\(aqt received within a certain amount of time then the video is being
  7092. rendered offscreen. The time it waits is equal to how long it takes your monitor
  7093. to display a frame (i.e. 1/refresh rate) plus the offset. In general, staying
  7094. close to your monitor\(aqs refresh rate is preferred, but with a small offset in
  7095. case a frame takes a little long to display.
  7096. .TP
  7097. .B \fB\-\-wayland\-disable\-vsync=<yes|no>\fP
  7098. Disable vsync for the wayland contexts (default: no). Useful for benchmarking
  7099. the wayland context when combined with \fBvideo\-sync=display\-desync\fP,
  7100. \fB\-\-no\-audio\fP, and \fB\-\-untimed=yes\fP\&. Only works with \fB\-\-gpu\-context=wayland\fP
  7101. and \fB\-\-gpu\-context=waylandvk\fP\&.
  7102. .TP
  7103. .B \fB\-\-spirv\-compiler=<compiler>\fP
  7104. Controls which compiler is used to translate GLSL to SPIR\-V. This is
  7105. (currently) only relevant for \fB\-\-gpu\-api=vulkan\fP and \fI\-\-gpu\-api=d3d11\fP\&.
  7106. The possible choices are currently only:
  7107. .INDENT 7.0
  7108. .TP
  7109. .B auto
  7110. Use the first available compiler. (Default)
  7111. .TP
  7112. .B shaderc
  7113. Use libshaderc, which is an API wrapper around glslang. This is
  7114. generally the most preferred, if available.
  7115. .UNINDENT
  7116. .sp
  7117. \fBNOTE:\fP
  7118. .INDENT 7.0
  7119. .INDENT 3.5
  7120. This option is deprecated, since there is only one reasonable value.
  7121. It may be removed in the future.
  7122. .UNINDENT
  7123. .UNINDENT
  7124. .TP
  7125. .B \fB\-\-glsl\-shader=<file>\fP, \fB\-\-glsl\-shaders=<file\-list>\fP
  7126. Custom GLSL hooks. These are a flexible way to add custom fragment shaders,
  7127. which can be injected at almost arbitrary points in the rendering pipeline,
  7128. and access all previous intermediate textures.
  7129. .sp
  7130. Each use of the \fB\-\-glsl\-shader\fP option will add another file to the
  7131. internal list of shaders, while \fB\-\-glsl\-shaders\fP takes a list of files,
  7132. and overwrites the internal list with it. The latter is a path list option
  7133. (see \fI\%List Options\fP for details).
  7134. .INDENT 7.0
  7135. .INDENT 3.5
  7136. .IP "Warning"
  7137. .sp
  7138. The syntax is not stable yet and may change any time.
  7139. .UNINDENT
  7140. .UNINDENT
  7141. .sp
  7142. The general syntax of a user shader looks like this:
  7143. .INDENT 7.0
  7144. .INDENT 3.5
  7145. .sp
  7146. .nf
  7147. .ft C
  7148. //!METADATA ARGS...
  7149. //!METADATA ARGS...
  7151. vec4 hook() {
  7152.    ...
  7153.    return something;
  7154. }
  7156. //!METADATA ARGS...
  7157. //!METADATA ARGS...
  7159. \&...
  7160. .ft P
  7161. .fi
  7162. .UNINDENT
  7163. .UNINDENT
  7164. .sp
  7165. Each section of metadata, along with the non\-metadata lines after it,
  7166. defines a single block. There are currently two types of blocks, HOOKs and
  7167. TEXTUREs.
  7168. .sp
  7169. A \fBTEXTURE\fP block can set the following options:
  7170. .INDENT 7.0
  7171. .TP
  7172. .B TEXTURE <name> (required)
  7173. The name of this texture. Hooks can then bind the texture under this
  7174. name using BIND. This must be the first option of the texture block.
  7175. .TP
  7176. .B SIZE <width> [<height>] [<depth>] (required)
  7177. The dimensions of the texture. The height and depth are optional. The
  7178. type of texture (1D, 2D or 3D) depends on the number of components
  7179. specified.
  7180. .TP
  7181. .B FORMAT <name> (required)
  7182. The texture format for the samples. Supported texture formats are listed
  7183. in debug logging when the \fBgpu\fP VO is initialized (look for
  7184. \fBTexture formats:\fP). Usually, this follows OpenGL naming conventions.
  7185. For example, \fBrgb16\fP provides 3 channels with normalized 16 bit
  7186. components. One oddity are float formats: for example, \fBrgba16f\fP has
  7187. 16 bit internal precision, but the texture data is provided as 32 bit
  7188. floats, and the driver converts the data on texture upload.
  7189. .sp
  7190. Although format names follow a common naming convention, not all of them
  7191. are available on all hardware, drivers, GL versions, and so on.
  7192. .TP
  7193. .B FILTER <LINEAR|NEAREST>
  7194. The min/magnification filter used when sampling from this texture.
  7195. .TP
  7196. .B BORDER <CLAMP|REPEAT|MIRROR>
  7197. The border wrapping mode used when sampling from this texture.
  7198. .UNINDENT
  7199. .sp
  7200. Following the metadata is a string of bytes in hexadecimal notation that
  7201. define the raw texture data, corresponding to the format specified by
  7202. \fIFORMAT\fP, on a single line with no extra whitespace.
  7203. .sp
  7204. A \fBHOOK\fP block can set the following options:
  7205. .INDENT 7.0
  7206. .TP
  7207. .B HOOK <name> (required)
  7208. The texture which to hook into. May occur multiple times within a
  7209. metadata block, up to a predetermined limit. See below for a list of
  7210. hookable textures.
  7211. .TP
  7212. .B DESC <title>
  7213. User\-friendly description of the pass. This is the name used when
  7214. representing this shader in the list of passes for property
  7215. \fIvo\-passes\fP\&.
  7216. .TP
  7217. .B BIND <name>
  7218. Loads a texture (either coming from mpv or from a \fBTEXTURE\fP block)
  7219. and makes it available to the pass. When binding textures from mpv,
  7220. this will also set up macros to facilitate accessing it properly. See
  7221. below for a list. By default, no textures are bound. The special name
  7222. HOOKED can be used to refer to the texture that triggered this pass.
  7223. .TP
  7224. .B SAVE <name>
  7225. Gives the name of the texture to save the result of this pass into. By
  7226. default, this is set to the special name HOOKED which has the effect of
  7227. overwriting the hooked texture.
  7228. .TP
  7229. .B WIDTH <szexpr>, HEIGHT <szexpr>
  7230. Specifies the size of the resulting texture for this pass. \fBszexpr\fP
  7231. refers to an expression in RPN (reverse polish notation), using the
  7232. operators + \- * / > < !, floating point literals, and references to
  7233. sizes of existing texture (such as MAIN.width or CHROMA.height),
  7234. OUTPUT, or NATIVE_CROPPED (size of an input texture cropped after
  7235. pan\-and\-scan, video\-align\-x/y, video\-pan\-x/y, etc. and possibly
  7236. prescaled). By default, these are set to HOOKED.w and HOOKED.h,
  7237. espectively.
  7238. .TP
  7239. .B WHEN <szexpr>
  7240. Specifies a condition that needs to be true (non\-zero) for the shader
  7241. stage to be evaluated. If it fails, it will silently be omitted. (Note
  7242. that a shader stage like this which has a dependency on an optional
  7243. hook point can still cause that hook point to be saved, which has some
  7244. minor overhead)
  7245. .TP
  7246. .B OFFSET <ox oy | ALIGN>
  7247. Indicates a pixel shift (offset) introduced by this pass. These pixel
  7248. offsets will be accumulated and corrected during the next scaling pass
  7249. (\fBcscale\fP or \fBscale\fP). The default values are 0 0 which correspond
  7250. to no shift. Note that offsets are ignored when not overwriting the
  7251. hooked texture.
  7252. .sp
  7253. A special value of \fBALIGN\fP will attempt to fix existing offset of
  7254. HOOKED by align it with reference. It requires HOOKED to be resizable
  7255. (see below). It works transparently with fragment shader. For compute
  7256. shader, the predefined \fBtexmap\fP macro is required to handle coordinate
  7257. mapping.
  7258. .TP
  7259. .B COMPONENTS <n>
  7260. Specifies how many components of this pass\(aqs output are relevant and
  7261. should be stored in the texture, up to 4 (rgba). By default, this value
  7262. is equal to the number of components in HOOKED.
  7263. .TP
  7264. .B COMPUTE <bw> <bh> [<tw> <th>]
  7265. Specifies that this shader should be treated as a compute shader, with
  7266. the block size bw and bh. The compute shader will be dispatched with
  7267. however many blocks are necessary to completely tile over the output.
  7268. Within each block, there will bw tw*th threads, forming a single work
  7269. group. In other words: tw and th specify the work group size, which can
  7270. be different from the block size. So for example, a compute shader with
  7271. bw, bh = 32 and tw, th = 8 running on a 500x500 texture would dispatch
  7272. 16x16 blocks (rounded up), each with 8x8 threads.
  7273. .sp
  7274. Compute shaders in mpv are treated a bit different from fragment
  7275. shaders. Instead of defining a \fBvec4 hook\fP that produces an output
  7276. sample, you directly define \fBvoid hook\fP which writes to a fixed
  7277. writeonly image unit named \fBout_image\fP (this is bound by mpv) using
  7278. \fIimageStore\fP\&. To help translate texture coordinates in the absence of
  7279. vertices, mpv provides a special function \fBNAME_map(id)\fP to map from
  7280. the texel space of the output image to the texture coordinates for all
  7281. bound textures. In particular, \fBNAME_pos\fP is equivalent to
  7282. \fBNAME_map(gl_GlobalInvocationID)\fP, although using this only really
  7283. makes sense if (tw,th) == (bw,bh).
  7284. .UNINDENT
  7285. .sp
  7286. Each bound mpv texture (via \fBBIND\fP) will make available the following
  7287. definitions to that shader pass, where NAME is the name of the bound
  7288. texture:
  7289. .INDENT 7.0
  7290. .TP
  7291. .B vec4 NAME_tex(vec2 pos)
  7292. The sampling function to use to access the texture at a certain spot
  7293. (in texture coordinate space, range [0,1]). This takes care of any
  7294. necessary normalization conversions.
  7295. .TP
  7296. .B vec4 NAME_texOff(vec2 offset)
  7297. Sample the texture at a certain offset in pixels. This works like
  7298. NAME_tex but additionally takes care of necessary rotations, so that
  7299. sampling at e.g. vec2(\-1,0) is always one pixel to the left.
  7300. .TP
  7301. .B vec2 NAME_pos
  7302. The local texture coordinate of that texture, range [0,1].
  7303. .TP
  7304. .B vec2 NAME_size
  7305. The (rotated) size in pixels of the texture.
  7306. .TP
  7307. .B mat2 NAME_rot
  7308. The rotation matrix associated with this texture. (Rotates pixel space
  7309. to texture coordinates)
  7310. .TP
  7311. .B vec2 NAME_pt
  7312. The (unrotated) size of a single pixel, range [0,1].
  7313. .TP
  7314. .B float NAME_mul
  7315. The coefficient that needs to be multiplied into the texture contents
  7316. in order to normalize it to the range [0,1].
  7317. .TP
  7318. .B sampler NAME_raw
  7319. The raw bound texture itself. The use of this should be avoided unless
  7320. absolutely necessary.
  7321. .UNINDENT
  7322. .sp
  7323. Normally, users should use either NAME_tex or NAME_texOff to read from the
  7324. texture. For some shaders however , it can be better for performance to do
  7325. custom sampling from NAME_raw, in which case care needs to be taken to
  7326. respect NAME_mul and NAME_rot.
  7327. .sp
  7328. In addition to these parameters, the following uniforms are also globally
  7329. available:
  7330. .INDENT 7.0
  7331. .TP
  7332. .B float random
  7333. A random number in the range [0\-1], different per frame.
  7334. .TP
  7335. .B int frame
  7336. A simple count of frames rendered, increases by one per frame and never
  7337. resets (regardless of seeks).
  7338. .TP
  7339. .B vec2 input_size
  7340. The size in pixels of the input image (possibly cropped and prescaled).
  7341. .TP
  7342. .B vec2 target_size
  7343. The size in pixels of the visible part of the scaled (and possibly
  7344. cropped) image.
  7345. .TP
  7346. .B vec2 tex_offset
  7347. Texture offset introduced by user shaders or options like panscan, video\-align\-x/y, video\-pan\-x/y.
  7348. .UNINDENT
  7349. .sp
  7350. Internally, vo_gpu may generate any number of the following textures.
  7351. Whenever a texture is rendered and saved by vo_gpu, all of the passes
  7352. that have hooked into it will run, in the order they were added by the
  7353. user. This is a list of the legal hook points:
  7354. .INDENT 7.0
  7355. .TP
  7356. .B RGB, LUMA, CHROMA, ALPHA, XYZ (resizable)
  7357. Source planes (raw). Which of these fire depends on the image format of
  7358. the source.
  7359. .TP
  7360. .B CHROMA_SCALED, ALPHA_SCALED (fixed)
  7361. Source planes (upscaled). These only fire on subsampled content.
  7362. .TP
  7363. .B NATIVE (resizable)
  7364. The combined image, in the source colorspace, before conversion to RGB.
  7365. .TP
  7366. .B MAINPRESUB (resizable)
  7367. The image, after conversion to RGB, but before
  7368. \fB\-\-blend\-subtitles=video\fP is applied.
  7369. .TP
  7370. .B MAIN (resizable)
  7371. The main image, after conversion to RGB but before upscaling.
  7372. .TP
  7373. .B LINEAR (fixed)
  7374. Linear light image, before scaling. This only fires when
  7375. \fB\-\-linear\-upscaling\fP, \fB\-\-linear\-downscaling\fP or
  7376. \fB\-\-sigmoid\-upscaling\fP is in effect.
  7377. .TP
  7378. .B SIGMOID (fixed)
  7379. Sigmoidized light, before scaling. This only fires when
  7380. \fB\-\-sigmoid\-upscaling\fP is in effect.
  7381. .TP
  7382. .B PREKERNEL (fixed)
  7383. The image immediately before the scaler kernel runs.
  7384. .TP
  7385. .B POSTKERNEL (fixed)
  7386. The image immediately after the scaler kernel runs.
  7387. .TP
  7388. .B SCALED (fixed)
  7389. The final upscaled image, before color management.
  7390. .TP
  7391. .B OUTPUT (fixed)
  7392. The final output image, after color management but before dithering and
  7393. drawing to screen.
  7394. .UNINDENT
  7395. .sp
  7396. Only the textures labelled with \fBresizable\fP may be transformed by the
  7397. pass. When overwriting a texture marked \fBfixed\fP, the WIDTH, HEIGHT and
  7398. OFFSET must be left at their default values.
  7399. .TP
  7400. .B \fB\-\-glsl\-shader=<file>\fP
  7401. CLI/config file only alias for \fB\-\-glsl\-shaders\-append\fP\&.
  7402. .TP
  7403. .B \fB\-\-deband\fP
  7404. Enable the debanding algorithm. This greatly reduces the amount of visible
  7405. banding, blocking and other quantization artifacts, at the expense of
  7406. very slightly blurring some of the finest details. In practice, it\(aqs
  7407. virtually always an improvement \- the only reason to disable it would be
  7408. for performance.
  7409. .TP
  7410. .B \fB\-\-deband\-iterations=<1..16>\fP
  7411. The number of debanding steps to perform per sample. Each step reduces a
  7412. bit more banding, but takes time to compute. Note that the strength of each
  7413. step falls off very quickly, so high numbers (>4) are practically useless.
  7414. (Default 1)
  7415. .TP
  7416. .B \fB\-\-deband\-threshold=<0..4096>\fP
  7417. The debanding filter\(aqs cut\-off threshold. Higher numbers increase the
  7418. debanding strength dramatically but progressively diminish image details.
  7419. (Default 64)
  7420. .TP
  7421. .B \fB\-\-deband\-range=<1..64>\fP
  7422. The debanding filter\(aqs initial radius. The radius increases linearly for
  7423. each iteration. A higher radius will find more gradients, but a lower
  7424. radius will smooth more aggressively. (Default 16)
  7425. .sp
  7426. If you increase the \fB\-\-deband\-iterations\fP, you should probably decrease
  7427. this to compensate.
  7428. .TP
  7429. .B \fB\-\-deband\-grain=<0..4096>\fP
  7430. Add some extra noise to the image. This significantly helps cover up
  7431. remaining quantization artifacts. Higher numbers add more noise. (Default
  7432. 48)
  7433. .TP
  7434. .B \fB\-\-sharpen=<value>\fP
  7435. If set to a value other than 0, enable an unsharp masking filter. Positive
  7436. values will sharpen the image (but add more ringing and aliasing). Negative
  7437. values will blur the image. If your GPU is powerful enough, consider
  7438. alternatives like the \fBewa_lanczossharp\fP scale filter, or the
  7439. \fB\-\-scale\-blur\fP option.
  7440. .TP
  7441. .B \fB\-\-opengl\-glfinish\fP
  7442. Call \fBglFinish()\fP before swapping buffers (default: disabled). Slower,
  7443. but might improve results when doing framedropping. Can completely ruin
  7444. performance. The details depend entirely on the OpenGL driver.
  7445. .TP
  7446. .B \fB\-\-opengl\-waitvsync\fP
  7447. Call \fBglXWaitVideoSyncSGI\fP after each buffer swap (default: disabled).
  7448. This may or may not help with video timing accuracy and frame drop. It\(aqs
  7449. possible that this makes video output slower, or has no effect at all.
  7450. .sp
  7451. X11/GLX only.
  7452. .TP
  7453. .B \fB\-\-opengl\-dwmflush=<no|windowed|yes|auto>\fP
  7454. Calls \fBDwmFlush\fP after swapping buffers on Windows (default: auto). It
  7455. also sets \fBSwapInterval(0)\fP to ignore the OpenGL timing. Values are: no
  7456. (disabled), windowed (only in windowed mode), yes (also in full screen).
  7457. .sp
  7458. The value \fBauto\fP will try to determine whether the compositor is active,
  7459. and calls \fBDwmFlush\fP only if it seems to be.
  7460. .sp
  7461. This may help to get more consistent frame intervals, especially with
  7462. high\-fps clips \- which might also reduce dropped frames. Typically, a value
  7463. of \fBwindowed\fP should be enough, since full screen may bypass the DWM.
  7464. .sp
  7465. Windows only.
  7466. .TP
  7467. .B \fB\-\-angle\-d3d11\-feature\-level=<11_0|10_1|10_0|9_3>\fP
  7468. Selects a specific feature level when using the ANGLE backend with D3D11.
  7469. By default, the highest available feature level is used. This option can be
  7470. used to select a lower feature level, which is mainly useful for debugging.
  7471. Note that OpenGL ES 3.0 is only supported at feature level 10_1 or higher.
  7472. Most extended OpenGL features will not work at lower feature levels
  7473. (similar to \fB\-\-gpu\-dumb\-mode\fP).
  7474. .sp
  7475. Windows with ANGLE only.
  7476. .TP
  7477. .B \fB\-\-angle\-d3d11\-warp=<yes|no|auto>\fP
  7478. Use WARP (Windows Advanced Rasterization Platform) when using the ANGLE
  7479. backend with D3D11 (default: auto). This is a high performance software
  7480. renderer. By default, it is used when the Direct3D hardware does not
  7481. support Direct3D 11 feature level 9_3. While the extended OpenGL features
  7482. will work with WARP, they can be very slow.
  7483. .sp
  7484. Windows with ANGLE only.
  7485. .TP
  7486. .B \fB\-\-angle\-egl\-windowing=<yes|no|auto>\fP
  7487. Use ANGLE\(aqs built in EGL windowing functions to create a swap chain
  7488. (default: auto). If this is set to \fBno\fP and the D3D11 renderer is in use,
  7489. ANGLE\(aqs built in swap chain will not be used and a custom swap chain that
  7490. is optimized for video rendering will be created instead. If set to
  7491. \fBauto\fP, a custom swap chain will be used for D3D11 and the built in swap
  7492. chain will be used for D3D9. This option is mainly for debugging purposes,
  7493. in case the custom swap chain has poor performance or does not work.
  7494. .sp
  7495. If set to \fByes\fP, the \fB\-\-angle\-max\-frame\-latency\fP,
  7496. \fB\-\-angle\-swapchain\-length\fP and \fB\-\-angle\-flip\fP options will have no
  7497. effect.
  7498. .sp
  7499. Windows with ANGLE only.
  7500. .TP
  7501. .B \fB\-\-angle\-flip=<yes|no>\fP
  7502. Enable flip\-model presentation, which avoids unnecessarily copying the
  7503. backbuffer by sharing surfaces with the DWM (default: yes). This may cause
  7504. performance issues with older drivers. If flip\-model presentation is not
  7505. supported (for example, on Windows 7 without the platform update), mpv will
  7506. automatically fall back to the older bitblt presentation model.
  7507. .sp
  7508. If set to \fBno\fP, the \fB\-\-angle\-swapchain\-length\fP option will have no
  7509. effect.
  7510. .sp
  7511. Windows with ANGLE only.
  7512. .TP
  7513. .B \fB\-\-angle\-renderer=<d3d9|d3d11|auto>\fP
  7514. Forces a specific renderer when using the ANGLE backend (default: auto). In
  7515. auto mode this will pick D3D11 for systems that support Direct3D 11 feature
  7516. level 9_3 or higher, and D3D9 otherwise. This option is mainly for
  7517. debugging purposes. Normally there is no reason to force a specific
  7518. renderer, though \fB\-\-angle\-renderer=d3d9\fP may give slightly better
  7519. performance on old hardware. Note that the D3D9 renderer only supports
  7520. OpenGL ES 2.0, so most extended OpenGL features will not work if this
  7521. renderer is selected (similar to \fB\-\-gpu\-dumb\-mode\fP).
  7522. .sp
  7523. Windows with ANGLE only.
  7524. .TP
  7525. .B \fB\-\-cocoa\-force\-dedicated\-gpu=<yes|no>\fP
  7526. Deactivates the automatic graphics switching and forces the dedicated GPU.
  7527. (default: no)
  7528. .sp
  7529. OS X only.
  7530. .TP
  7531. .B \fB\-\-cocoa\-cb\-sw\-renderer=<yes|no|auto>\fP
  7532. Use the Apple Software Renderer when using cocoa\-cb (default: auto). If set
  7533. to \fBno\fP the software renderer is never used and instead fails when a the
  7534. usual pixel format could not be created, \fByes\fP will always only use the
  7535. software renderer, and \fBauto\fP only falls back to the software renderer
  7536. when the usual pixel format couldn\(aqt be created.
  7537. .sp
  7538. OS X only.
  7539. .TP
  7540. .B \fB\-\-cocoa\-cb\-10bit\-context=<yes|no>\fP
  7541. Creates a 10bit capable pixel format for the context creation (default: yes).
  7542. Instead of 8bit integer framebuffer a 16bit half\-float framebuffer is
  7543. requested.
  7544. .sp
  7545. OS X only.
  7546. .TP
  7547. .B \fB\-\-macos\-title\-bar\-appearance=<appearance>\fP
  7548. Sets the appearance of the title bar (default: auto). Not all combinations
  7549. of appearances and \fB\-\-macos\-title\-bar\-material\fP materials make sense or
  7550. are unique. Appearances that are not supported by you current macOS version
  7551. fall back to the default value.
  7552. macOS and cocoa\-cb only
  7553. .sp
  7554. \fB<appearance>\fP can be one of the following:
  7555. .INDENT 7.0
  7556. .TP
  7557. .B auto
  7558. Detects the system settings and sets the title
  7559. bar appearance appropriately. On macOS 10.14 it
  7560. also detects run time changes.
  7561. .TP
  7562. .B aqua
  7563. The standard macOS Light appearance.
  7564. .TP
  7565. .B darkAqua
  7566. The standard macOS Dark appearance. (macOS 10.14+)
  7567. .TP
  7568. .B vibrantLight
  7569. Light vibrancy appearance with.
  7570. .TP
  7571. .B vibrantDark
  7572. Dark vibrancy appearance with.
  7573. .TP
  7574. .B aquaHighContrast
  7575. Light Accessibility appearance. (macOS 10.14+)
  7576. .TP
  7577. .B darkAquaHighContrast
  7578. Dark Accessibility appearance. (macOS 10.14+)
  7579. .TP
  7580. .B vibrantLightHighContrast
  7581. Light vibrancy Accessibility appearance.
  7582. (macOS 10.14+)
  7583. .TP
  7584. .B vibrantDarkHighContrast
  7585. Dark vibrancy Accessibility appearance.
  7586. (macOS 10.14+)
  7587. .UNINDENT
  7588. .TP
  7589. .B \fB\-\-macos\-title\-bar\-material=<material>\fP
  7590. Sets the material of the title bar (default: titlebar). All deprecated
  7591. materials should not be used on macOS 10.14+ because their functionality
  7592. is not guaranteed. Not all combinations of materials and
  7593. \fB\-\-macos\-title\-bar\-appearance\fP appearances make sense or are unique.
  7594. Materials that are not supported by you current macOS version fall back to
  7595. the default value.
  7596. macOS and cocoa\-cb only
  7597. .sp
  7598. \fB<material>\fP can be one of the following:
  7599. .INDENT 7.0
  7600. .TP
  7601. .B titlebar
  7602. The standard macOS titel bar material.
  7603. .TP
  7604. .B selection
  7605. The standard macOS selection material.
  7606. .TP
  7607. .B menu
  7608. The standard macOS menu material. (macOS 10.11+)
  7609. .TP
  7610. .B popover
  7611. The standard macOS popover material. (macOS 10.11+)
  7612. .TP
  7613. .B sidebar
  7614. The standard macOS sidebar material. (macOS 10.11+)
  7615. .TP
  7616. .B headerView
  7617. The standard macOS header view material.
  7618. (macOS 10.14+)
  7619. .TP
  7620. .B sheet
  7621. The standard macOS sheet material. (macOS 10.14+)
  7622. .TP
  7623. .B windowBackground
  7624. The standard macOS window background material.
  7625. (macOS 10.14+)
  7626. .TP
  7627. .B hudWindow
  7628. The standard macOS hudWindow material. (macOS 10.14+)
  7629. .TP
  7630. .B fullScreen
  7631. The standard macOS full screen material.
  7632. (macOS 10.14+)
  7633. .TP
  7634. .B toolTip
  7635. The standard macOS tool tip material. (macOS 10.14+)
  7636. .TP
  7637. .B contentBackground
  7638. The standard macOS content background material.
  7639. (macOS 10.14+)
  7640. .TP
  7641. .B underWindowBackground
  7642. The standard macOS under window background material.
  7643. (macOS 10.14+)
  7644. .TP
  7645. .B underPageBackground
  7646. The standard macOS under page background material.
  7647. (deprecated in macOS 10.14+)
  7648. .TP
  7649. .B dark
  7650. The standard macOS dark material.
  7651. (deprecated in macOS 10.14+)
  7652. .TP
  7653. .B light
  7654. The standard macOS light material.
  7655. (macOS 10.14+)
  7656. .TP
  7657. .B mediumLight
  7658. The standard macOS mediumLight material.
  7659. (macOS 10.11+, deprecated in macOS 10.14+)
  7660. .TP
  7661. .B ultraDark
  7662. The standard macOS ultraDark material.
  7663. (macOS 10.11+ deprecated in macOS 10.14+)
  7664. .UNINDENT
  7665. .TP
  7666. .B \fB\-\-macos\-title\-bar\-color=<color>\fP
  7667. Sets the color of the title bar (default: completely transparent). Is
  7668. influenced by \fB\-\-macos\-title\-bar\-appearance\fP and
  7669. \fB\-\-macos\-title\-bar\-material\fP\&.
  7670. See \fB\-\-sub\-color\fP for color syntax.
  7671. .TP
  7672. .B \fB\-\-macos\-fs\-animation\-duration=<default|0\-1000>\fP
  7673. Sets the fullscreen resize animation duration in ms (default: default).
  7674. The default value is slightly less than the system\(aqs animation duration
  7675. (500ms) to prevent some problems when the end of an async animation happens
  7676. at the same time as the end of the system wide fullscreen animation. Setting
  7677. anything higher than 500ms will only prematurely cancel the resize animation
  7678. after the system wide animation ended. The upper limit is still set at
  7679. 1000ms since it\(aqs possible that Apple or the user changes the system
  7680. defaults. Anything higher than 1000ms though seems too long and shouldn\(aqt be
  7681. set anyway.
  7682. OS X and cocoa\-cb only
  7683. .TP
  7684. .B \fB\-\-android\-surface\-size=<WxH>\fP
  7685. Set dimensions of the rendering surface used by the Android gpu context.
  7686. Needs to be set by the embedding application if the dimensions change during
  7687. runtime (i.e. if the device is rotated), via the surfaceChanged callback.
  7688. .sp
  7689. Android with \fB\-\-gpu\-context=android\fP only.
  7690. .TP
  7691. .B \fB\-\-gpu\-sw\fP
  7692. Continue even if a software renderer is detected.
  7693. .TP
  7694. .B \fB\-\-gpu\-context=<sys>\fP
  7695. The value \fBauto\fP (the default) selects the GPU context. You can also pass
  7696. \fBhelp\fP to get a complete list of compiled in backends (sorted by
  7697. autoprobe order).
  7698. .INDENT 7.0
  7699. .TP
  7700. .B auto
  7701. auto\-select (default)
  7702. .TP
  7703. .B cocoa
  7704. Cocoa/OS X (deprecated, use \-\-vo=libmpv instead)
  7705. .TP
  7706. .B win
  7707. Win32/WGL
  7708. .TP
  7709. .B winvk
  7710. VK_KHR_win32_surface
  7711. .TP
  7712. .B angle
  7713. Direct3D11 through the OpenGL ES translation layer ANGLE. This supports
  7714. almost everything the \fBwin\fP backend does (if the ANGLE build is new
  7715. enough).
  7716. .TP
  7717. .B dxinterop (experimental)
  7718. Win32, using WGL for rendering and Direct3D 9Ex for presentation. Works
  7719. on Nvidia and AMD. Newer Intel chips with the latest drivers may also
  7720. work.
  7721. .TP
  7722. .B d3d11
  7723. Win32, with native Direct3D 11 rendering.
  7724. .TP
  7725. .B x11
  7726. X11/GLX
  7727. .TP
  7728. .B x11vk
  7729. VK_KHR_xlib_surface
  7730. .TP
  7731. .B wayland
  7732. Wayland/EGL
  7733. .TP
  7734. .B waylandvk
  7735. VK_KHR_wayland_surface
  7736. .TP
  7737. .B drm
  7738. DRM/EGL
  7739. .TP
  7740. .B x11egl
  7741. X11/EGL
  7742. .TP
  7743. .B android
  7744. Android/EGL. Requires \fB\-\-wid\fP be set to an \fBandroid.view.Surface\fP\&.
  7745. .UNINDENT
  7746. .TP
  7747. .B \fB\-\-gpu\-api=<type>\fP
  7748. Controls which type of graphics APIs will be accepted:
  7749. .INDENT 7.0
  7750. .TP
  7751. .B auto
  7752. Use any available API (default)
  7753. .TP
  7754. .B opengl
  7755. Allow only OpenGL (requires OpenGL 2.1+ or GLES 2.0+)
  7756. .TP
  7757. .B vulkan
  7758. Allow only Vulkan (requires a valid/working \fB\-\-spirv\-compiler\fP)
  7759. .TP
  7760. .B d3d11
  7761. Allow only \fB\-\-gpu\-context=d3d11\fP
  7762. .UNINDENT
  7763. .TP
  7764. .B \fB\-\-opengl\-es=<mode>\fP
  7765. Controls which type of OpenGL context will be accepted:
  7766. .INDENT 7.0
  7767. .TP
  7768. .B auto
  7769. Allow all types of OpenGL (default)
  7770. .TP
  7771. .B yes
  7772. Only allow GLES
  7773. .TP
  7774. .B no
  7775. Only allow desktop/core GL
  7776. .UNINDENT
  7777. .TP
  7778. .B \fB\-\-opengl\-restrict=<version>\fP
  7779. Restricts all OpenGL versions above a certain version. Versions are encoded
  7780. in hundreds, i.e. OpenGL 4.5 \-> 450. As an example, \-\-opengl\-restrict=300
  7781. would restrict OpenGL 3.0 and higher, effectively only allowing 2.x
  7782. contexts. Note that this only imposes a limit on context creation APIs, the
  7783. actual OpenGL context may still have a higher OpenGL version. (Default: 0)
  7784. .TP
  7785. .B \fB\-\-fbo\-format=<fmt>\fP
  7786. Selects the internal format of textures used for FBOs. The format can
  7787. influence performance and quality of the video output. \fBfmt\fP can be one
  7788. of: rgb8, rgb10, rgb10_a2, rgb16, rgb16f, rgb32f, rgba12, rgba16, rgba16f,
  7789. rgba16hf, rgba32f.
  7790. .sp
  7791. Default: \fBauto\fP, which first attempts to utilize 16bit float
  7792. (rgba16f, rgba16hf), and falls back to rgba16 if those are not available.
  7793. Finally, attempts to utilize rgb10_a2 or rgba8 if all of the previous formats
  7794. are not available.
  7795. .TP
  7796. .B \fB\-\-gamma\-factor=<0.1..2.0>\fP
  7797. Set an additional raw gamma factor (default: 1.0). If gamma is adjusted in
  7798. other ways (like with the \fB\-\-gamma\fP option or key bindings and the
  7799. \fBgamma\fP property), the value is multiplied with the other gamma value.
  7800. .sp
  7801. Recommended values based on the environmental brightness:
  7802. .INDENT 7.0
  7803. .TP
  7804. .B 1.0
  7805. Pitch black or dimly lit room (default)
  7806. .TP
  7807. .B 1.1
  7808. Moderately lit room, home
  7809. .TP
  7810. .B 1.2
  7811. Brightly illuminated room, office
  7812. .UNINDENT
  7813. .sp
  7814. NOTE: This is based around the assumptions of typical movie content, which
  7815. contains an implicit end\-to\-end of about 0.8 from scene to display. For
  7816. bright environments it can be useful to cancel that out.
  7817. .TP
  7818. .B \fB\-\-gamma\-auto\fP
  7819. Automatically corrects the gamma value depending on ambient lighting
  7820. conditions (adding a gamma boost for bright rooms).
  7821. .sp
  7822. With ambient illuminance of 16 lux, mpv will pick the 1.0 gamma value (no
  7823. boost), and slightly increase the boost up until 1.2 for 256 lux.
  7824. .sp
  7825. NOTE: Only implemented on OS X.
  7826. .TP
  7827. .B \fB\-\-target\-prim=<value>\fP
  7828. Specifies the primaries of the display. Video colors will be adapted to
  7829. this colorspace when ICC color management is not being used. Valid values
  7830. are:
  7831. .INDENT 7.0
  7832. .TP
  7833. .B auto
  7834. Disable any adaptation, except for atypical color spaces. Specifically,
  7835. wide/unusual gamuts get automatically adapted to BT.709, while standard
  7836. gamut (i.e. BT.601 and BT.709) content is not touched. (default)
  7837. .TP
  7838. .B bt.470m
  7839. ITU\-R BT.470 M
  7840. .TP
  7841. .B bt.601\-525
  7842. ITU\-R BT.601 (525\-line SD systems, eg. NTSC), SMPTE 170M/240M
  7843. .TP
  7844. .B bt.601\-625
  7845. ITU\-R BT.601 (625\-line SD systems, eg. PAL/SECAM), ITU\-R BT.470 B/G
  7846. .TP
  7847. .B bt.709
  7848. ITU\-R BT.709 (HD), IEC 61966\-2\-4 (sRGB), SMPTE RP177 Annex B
  7849. .TP
  7850. .B bt.2020
  7851. ITU\-R BT.2020 (UHD)
  7852. .TP
  7853. .B apple
  7854. Apple RGB
  7855. .TP
  7856. .B adobe
  7857. Adobe RGB (1998)
  7858. .TP
  7859. .B prophoto
  7860. ProPhoto RGB (ROMM)
  7861. .TP
  7862. .B cie1931
  7863. CIE 1931 RGB (not to be confused with CIE XYZ)
  7864. .TP
  7865. .B dci\-p3
  7866. DCI\-P3 (Digital Cinema Colorspace), SMPTE RP431\-2
  7867. .TP
  7868. .B v\-gamut
  7869. Panasonic V\-Gamut (VARICAM) primaries
  7870. .TP
  7871. .B s\-gamut
  7872. Sony S\-Gamut (S\-Log) primaries
  7873. .UNINDENT
  7874. .TP
  7875. .B \fB\-\-target\-trc=<value>\fP
  7876. Specifies the transfer characteristics (gamma) of the display. Video colors
  7877. will be adjusted to this curve when ICC color management is not being used.
  7878. Valid values are:
  7879. .INDENT 7.0
  7880. .TP
  7881. .B auto
  7882. Disable any adaptation, except for atypical transfers. Specifically,
  7883. HDR or linear light source material gets automatically converted to
  7884. gamma 2.2, while SDR content is not touched. (default)
  7885. .TP
  7886. .B bt.1886
  7887. ITU\-R BT.1886 curve (assuming infinite contrast)
  7888. .TP
  7889. .B srgb
  7890. IEC 61966\-2\-4 (sRGB)
  7891. .TP
  7892. .B linear
  7893. Linear light output
  7894. .TP
  7895. .B gamma1.8
  7896. Pure power curve (gamma 1.8), also used for Apple RGB
  7897. .TP
  7898. .B gamma2.0
  7899. Pure power curve (gamma 2.0)
  7900. .TP
  7901. .B gamma2.2
  7902. Pure power curve (gamma 2.2)
  7903. .TP
  7904. .B gamma2.4
  7905. Pure power curve (gamma 2.4)
  7906. .TP
  7907. .B gamma2.6
  7908. Pure power curve (gamma 2.6)
  7909. .TP
  7910. .B gamma2.8
  7911. Pure power curve (gamma 2.8), also used for BT.470\-BG
  7912. .TP
  7913. .B prophoto
  7914. ProPhoto RGB (ROMM)
  7915. .TP
  7916. .B pq
  7917. ITU\-R BT.2100 PQ (Perceptual quantizer) curve, aka SMPTE ST2084
  7918. .TP
  7919. .B hlg
  7920. ITU\-R BT.2100 HLG (Hybrid Log\-gamma) curve, aka ARIB STD\-B67
  7921. .TP
  7922. .B v\-log
  7923. Panasonic V\-Log (VARICAM) curve
  7924. .TP
  7925. .B s\-log1
  7926. Sony S\-Log1 curve
  7927. .TP
  7928. .B s\-log2
  7929. Sony S\-Log2 curve
  7930. .UNINDENT
  7931. .sp
  7932. \fBNOTE:\fP
  7933. .INDENT 7.0
  7934. .INDENT 3.5
  7935. When using HDR output formats, mpv will encode to the specified
  7936. curve but it will not set any HDMI flags or other signalling that might
  7937. be required for the target device to correctly display the HDR signal.
  7938. The user should independently guarantee this before using these signal
  7939. formats for display.
  7940. .UNINDENT
  7941. .UNINDENT
  7942. .TP
  7943. .B \fB\-\-target\-peak=<auto|nits>\fP
  7944. Specifies the measured peak brightness of the output display, in cd/m^2
  7945. (AKA nits). The interpretation of this brightness depends on the configured
  7946. \fB\-\-target\-trc\fP\&. In all cases, it imposes a limit on the signal values
  7947. that will be sent to the display. If the source exceeds this brightness
  7948. level, a tone mapping filter will be inserted. For HLG, it has the
  7949. additional effect of parametrizing the inverse OOTF, in order to get
  7950. colorimetrically consistent results with the mastering display. For SDR, or
  7951. when using an ICC (profile (\fB\-\-icc\-profile\fP), setting this to a value
  7952. above 100 essentially causes the display to be treated as if it were an HDR
  7953. display in disguise. (See the note below)
  7954. .sp
  7955. In \fBauto\fP mode (the default), the chosen peak is an appropriate value
  7956. based on the TRC in use. For SDR curves, it uses 100. For HDR curves, it
  7957. uses 100 * the transfer function\(aqs nominal peak.
  7958. .sp
  7959. \fBNOTE:\fP
  7960. .INDENT 7.0
  7961. .INDENT 3.5
  7962. When using an SDR transfer function, this is normally not needed, and
  7963. setting it may lead to very unexpected results. The one time it \fIis\fP
  7964. useful is if you want to calibrate a HDR display using traditional
  7965. transfer functions and calibration equipment. In such cases, you can
  7966. set your HDR display to a high brightness such as 800 cd/m^2, and then
  7967. calibrate it to a standard curve like gamma2.8. Setting this value to
  7968. 800 would then instruct mpv to essentially treat it as an HDR display
  7969. with the given peak. This may be a good alternative in environments
  7970. where PQ or HLG input to the display is not possible, and makes it
  7971. possible to use HDR displays with mpv regardless of operating system
  7972. support for HDMI HDR metadata.
  7973. .sp
  7974. In such a configuration, we highly recommend setting \fB\-\-tone\-mapping\fP
  7975. to \fBmobius\fP or even \fBclip\fP\&.
  7976. .UNINDENT
  7977. .UNINDENT
  7978. .TP
  7979. .B \fB\-\-tone\-mapping=<value>\fP
  7980. Specifies the algorithm used for tone\-mapping images onto the target
  7981. display. This is relevant for both HDR\->SDR conversion as well as gamut
  7982. reduction (e.g. playing back BT.2020 content on a standard gamut display).
  7983. Valid values are:
  7984. .INDENT 7.0
  7985. .TP
  7986. .B clip
  7987. Hard\-clip any out\-of\-range values. Use this when you care about
  7988. perfect color accuracy for in\-range values at the cost of completely
  7989. distorting out\-of\-range values. Not generally recommended.
  7990. .TP
  7991. .B mobius
  7992. Generalization of Reinhard to a Möbius transform with linear section.
  7993. Smoothly maps out\-of\-range values while retaining contrast and colors
  7994. for in\-range material as much as possible. Use this when you care about
  7995. color accuracy more than detail preservation. This is somewhere in
  7996. between \fBclip\fP and \fBreinhard\fP, depending on the value of
  7997. \fB\-\-tone\-mapping\-param\fP\&.
  7998. .TP
  7999. .B reinhard
  8000. Reinhard tone mapping algorithm. Very simple continuous curve.
  8001. Preserves overall image brightness but uses nonlinear contrast, which
  8002. results in flattening of details and degradation in color accuracy.
  8003. .TP
  8004. .B hable
  8005. Similar to \fBreinhard\fP but preserves both dark and bright details
  8006. better (slightly sigmoidal), at the cost of slightly darkening /
  8007. desaturating everything. Developed by John Hable for use in video
  8008. games. Use this when you care about detail preservation more than
  8009. color/brightness accuracy. This is roughly equivalent to
  8010. \fB\-\-tone\-mapping=reinhard \-\-tone\-mapping\-param=0.24\fP\&. If possible,
  8011. you should also enable \fB\-\-hdr\-compute\-peak\fP for the best results.
  8012. (Default)
  8013. .TP
  8014. .B gamma
  8015. Fits a logarithmic transfer between the tone curves.
  8016. .TP
  8017. .B linear
  8018. Linearly stretches the entire reference gamut to (a linear multiple of)
  8019. the display.
  8020. .UNINDENT
  8021. .TP
  8022. .B \fB\-\-tone\-mapping\-param=<value>\fP
  8023. Set tone mapping parameters. By default, this is set to the special string
  8024. \fBdefault\fP, which maps to an algorithm\-specific default value. Ignored if
  8025. the tone mapping algorithm is not tunable. This affects the following tone
  8026. mapping algorithms:
  8027. .INDENT 7.0
  8028. .TP
  8029. .B clip
  8030. Specifies an extra linear coefficient to multiply into the signal
  8031. before clipping. Defaults to 1.0.
  8032. .TP
  8033. .B mobius
  8034. Specifies the transition point from linear to mobius transform. Every
  8035. value below this point is guaranteed to be mapped 1:1. The higher the
  8036. value, the more accurate the result will be, at the cost of losing
  8037. bright details. Defaults to 0.3, which due to the steep initial slope
  8038. still preserves in\-range colors fairly accurately.
  8039. .TP
  8040. .B reinhard
  8041. Specifies the local contrast coefficient at the display peak. Defaults
  8042. to 0.5, which means that in\-gamut values will be about half as bright
  8043. as when clipping.
  8044. .TP
  8045. .B gamma
  8046. Specifies the exponent of the function. Defaults to 1.8.
  8047. .TP
  8048. .B linear
  8049. Specifies the scale factor to use while stretching. Defaults to 1.0.
  8050. .UNINDENT
  8051. .TP
  8052. .B \fB\-\-tone\-mapping\-max\-boost=<1.0..10.0>\fP
  8053. Upper limit for how much the tone mapping algorithm is allowed to boost
  8054. the average brightness by over\-exposing the image. The default value of 1.0
  8055. allows no additional brightness boost. A value of 2.0 would allow
  8056. over\-exposing by a factor of 2, and so on. Raising this setting can help
  8057. reveal details that would otherwise be hidden in dark scenes, but raising
  8058. it too high will make dark scenes appear unnaturally bright.
  8059. .TP
  8060. .B \fB\-\-hdr\-compute\-peak=<auto|yes|no>\fP
  8061. Compute the HDR peak and frame average brightness per\-frame instead of
  8062. relying on tagged metadata. These values are averaged over local regions as
  8063. well as over several frames to prevent the value from jittering around too
  8064. much. This option basically gives you dynamic, per\-scene tone mapping.
  8065. Requires compute shaders, which is a fairly recent OpenGL feature, and will
  8066. probably also perform horribly on some drivers, so enable at your own risk.
  8067. The special value \fBauto\fP (default) will enable HDR peak computation
  8068. automatically if compute shaders and SSBOs are supported.
  8069. .TP
  8070. .B \fB\-\-hdr\-peak\-decay\-rate=<1.0..1000.0>\fP
  8071. The decay rate used for the HDR peak detection algorithm (default: 100.0).
  8072. This is only relevant when \fB\-\-hdr\-compute\-peak\fP is enabled. Higher values
  8073. make the peak decay more slowly, leading to more stable values at the cost
  8074. of more "eye adaptation"\-like effects (although this is mitigated somewhat
  8075. by \fB\-\-hdr\-scene\-threshold\fP). A value of 1.0 (the lowest possible) disables
  8076. all averaging, meaning each frame\(aqs value is used directly as measured,
  8077. but doing this is not recommended for "noisy" sources since it may lead
  8078. to excessive flicker. (In signal theory terms, this controls the time
  8079. constant "tau" of an IIR low pass filter)
  8080. .TP
  8081. .B \fB\-\-hdr\-scene\-threshold\-low=<0.0..100.0>\fP, \fB\-\-hdr\-scene\-threshold\-high=<0.0..100.0>\fP
  8082. The lower and upper thresholds (in dB) for a brightness difference
  8083. to be considered a scene change (default: 5.5 low, 10.0 high). This is only
  8084. relevant when \fB\-\-hdr\-compute\-peak\fP is enabled. Normally, small
  8085. fluctuations in the frame brightness are compensated for by the peak
  8086. averaging mechanism, but for large jumps in the brightness this can result
  8087. in the frame remaining too bright or too dark for up to several seconds,
  8088. depending on the value of \fB\-\-hdr\-peak\-decay\-rate\fP\&. To counteract this,
  8089. when the brightness between the running average and the current frame
  8090. exceeds the low threshold, mpv will make the averaging filter more
  8091. aggressive, up to the limit of the high threshold (at which point the
  8092. filter becomes instant).
  8093. .TP
  8094. .B \fB\-\-tone\-mapping\-desaturate=<0.0..1.0>\fP
  8095. Apply desaturation for highlights (default: 0.75). The parameter controls
  8096. the strength of the desaturation curve. A value of 0.0 completely disables
  8097. it, while a value of 1.0 means that overly bright colors will tend towards
  8098. white. (This is not always the case, especially not for highlights that are
  8099. near primary colors)
  8100. .sp
  8101. Values in between apply progressively more/less aggressive desaturation.
  8102. This setting helps prevent unnaturally oversaturated colors for
  8103. super\-highlights, by (smoothly) turning them into less saturated (per
  8104. channel tone mapped) colors instead. This makes images feel more natural,
  8105. at the cost of chromatic distortions for out\-of\-range colors. The default
  8106. value of 0.75 provides a good balance. Setting this to 0.0 preserves the
  8107. chromatic accuracy of the tone mapping process.
  8108. .TP
  8109. .B \fB\-\-tone\-mapping\-desaturate\-exponent=<0.0..20.0>\fP
  8110. This setting controls the exponent of the desaturation curve, which
  8111. controls how bright a color needs to be in order to start being
  8112. desaturated. The default of 1.5 provides a reasonable balance.  Decreasing
  8113. this exponent makes the curve more aggressive.
  8114. .TP
  8115. .B \fB\-\-gamut\-warning\fP
  8116. If enabled, mpv will mark all clipped/out\-of\-gamut pixels that exceed a
  8117. given threshold (currently hard\-coded to 101%). The affected pixels will be
  8118. inverted to make them stand out. Note: This option applies after the
  8119. effects of all of mpv\(aqs color space transformation / tone mapping options,
  8120. so it\(aqs a good idea to combine this with \fB\-\-tone\-mapping=clip\fP and use
  8121. \fB\-\-target\-prim\fP to set the gamut to simulate. For example,
  8122. \fB\-\-target\-prim=bt.709\fP would make mpv highlight all pixels that exceed the
  8123. gamut of a standard gamut (sRGB) display. This option also does not work
  8124. well with ICC profiles, since the 3DLUTs are always generated against the
  8125. source color space and have chromatically\-accurate clipping built in.
  8126. .TP
  8127. .B \fB\-\-use\-embedded\-icc\-profile\fP
  8128. Load the embedded ICC profile contained in media files such as PNG images.
  8129. (Default: yes). Note that this option only works when also using a display
  8130. ICC profile (\fB\-\-icc\-profile\fP or \fB\-\-icc\-profile\-auto\fP), and also
  8131. requires LittleCMS 2 support.
  8132. .TP
  8133. .B \fB\-\-icc\-profile=<file>\fP
  8134. Load an ICC profile and use it to transform video RGB to screen output.
  8135. Needs LittleCMS 2 support compiled in. This option overrides the
  8136. \fB\-\-target\-prim\fP, \fB\-\-target\-trc\fP and \fB\-\-icc\-profile\-auto\fP options.
  8137. .TP
  8138. .B \fB\-\-icc\-profile\-auto\fP
  8139. Automatically select the ICC display profile currently specified by the
  8140. display settings of the operating system.
  8141. .sp
  8142. NOTE: On Windows, the default profile must be an ICC profile. WCS profiles
  8143. are not supported.
  8144. .sp
  8145. Applications using libmpv with the render API need to provide the ICC
  8146. profile via \fBMPV_RENDER_PARAM_ICC_PROFILE\fP\&.
  8147. .TP
  8148. .B \fB\-\-icc\-cache\-dir=<dirname>\fP
  8149. Store and load the 3D LUTs created from the ICC profile in this directory.
  8150. This can be used to speed up loading, since LittleCMS 2 can take a while to
  8151. create a 3D LUT. Note that these files contain uncompressed LUTs. Their
  8152. size depends on the \fB\-\-icc\-3dlut\-size\fP, and can be very big.
  8153. .sp
  8154. NOTE: This is not cleaned automatically, so old, unused cache files may
  8155. stick around indefinitely.
  8156. .TP
  8157. .B \fB\-\-icc\-intent=<value>\fP
  8158. Specifies the ICC intent used for the color transformation (when using
  8159. \fB\-\-icc\-profile\fP).
  8160. .INDENT 7.0
  8161. .TP
  8162. .B 0
  8163. perceptual
  8164. .TP
  8165. .B 1
  8166. relative colorimetric (default)
  8167. .TP
  8168. .B 2
  8169. saturation
  8170. .TP
  8171. .B 3
  8172. absolute colorimetric
  8173. .UNINDENT
  8174. .TP
  8175. .B \fB\-\-icc\-3dlut\-size=<r>x<g>x<b>\fP
  8176. Size of the 3D LUT generated from the ICC profile in each dimension.
  8177. Default is 64x64x64. Sizes may range from 2 to 512.
  8178. .TP
  8179. .B \fB\-\-icc\-contrast=<0\-1000000|inf>\fP
  8180. Specifies an upper limit on the target device\(aqs contrast ratio. This is
  8181. detected automatically from the profile if possible, but for some profiles
  8182. it might be missing, causing the contrast to be assumed as infinite. As a
  8183. result, video may appear darker than intended. This only affects BT.1886
  8184. content. The default of 0 means no limit if the detected contrast is less
  8185. than 100000, and limits to 1000 otherwise. Use \fB\-\-icc\-contrast=inf\fP to
  8186. preserve the infinite contrast (most likely when using OLED displays).
  8187. .TP
  8188. .B \fB\-\-blend\-subtitles=<yes|video|no>\fP
  8189. Blend subtitles directly onto upscaled video frames, before interpolation
  8190. and/or color management (default: no). Enabling this causes subtitles to be
  8191. affected by \fB\-\-icc\-profile\fP, \fB\-\-target\-prim\fP, \fB\-\-target\-trc\fP,
  8192. \fB\-\-interpolation\fP, \fB\-\-gamma\-factor\fP and \fB\-\-glsl\-shaders\fP\&. It also
  8193. increases subtitle performance when using \fB\-\-interpolation\fP\&.
  8194. .sp
  8195. The downside of enabling this is that it restricts subtitles to the visible
  8196. portion of the video, so you can\(aqt have subtitles exist in the black
  8197. margins below a video (for example).
  8198. .sp
  8199. If \fBvideo\fP is selected, the behavior is similar to \fByes\fP, but subs are
  8200. drawn at the video\(aqs native resolution, and scaled along with the video.
  8201. .sp
  8202. \fBWARNING:\fP
  8203. .INDENT 7.0
  8204. .INDENT 3.5
  8205. This changes the way subtitle colors are handled. Normally,
  8206. subtitle colors are assumed to be in sRGB and color managed as
  8207. such. Enabling this makes them treated as being in the video\(aqs
  8208. color space instead. This is good if you want things like
  8209. softsubbed ASS signs to match the video colors, but may cause
  8210. SRT subtitles or similar to look slightly off.
  8211. .UNINDENT
  8212. .UNINDENT
  8213. .TP
  8214. .B \fB\-\-alpha=<blend\-tiles|blend|yes|no>\fP
  8215. Decides what to do if the input has an alpha component.
  8216. .INDENT 7.0
  8217. .TP
  8218. .B blend\-tiles
  8219. Blend the frame against a 16x16 gray/white tiles background (default).
  8220. .TP
  8221. .B blend
  8222. Blend the frame against the background color (\fB\-\-background\fP, normally
  8223. black).
  8224. .TP
  8225. .B yes
  8226. Try to create a framebuffer with alpha component. This only makes sense
  8227. if the video contains alpha information (which is extremely rare). May
  8228. not be supported on all platforms. If alpha framebuffers are
  8229. unavailable, it silently falls back on a normal framebuffer. Note that
  8230. if you set the \fB\-\-fbo\-format\fP option to a non\-default value, a
  8231. format with alpha must be specified, or this won\(aqt work.
  8232. This does not work on X11 with EGL and Mesa (freedesktop bug 67676).
  8233. .TP
  8234. .B no
  8235. Ignore alpha component.
  8236. .UNINDENT
  8237. .TP
  8238. .B \fB\-\-opengl\-rectangle\-textures\fP
  8239. Force use of rectangle textures (default: no). Normally this shouldn\(aqt have
  8240. any advantages over normal textures. Note that hardware decoding overrides
  8241. this flag. Could be removed any time.
  8242. .TP
  8243. .B \fB\-\-background=<color>\fP
  8244. Color used to draw parts of the mpv window not covered by video. See
  8245. \fB\-\-osd\-color\fP option how colors are defined.
  8246. .TP
  8247. .B \fB\-\-gpu\-tex\-pad\-x\fP, \fB\-\-gpu\-tex\-pad\-y\fP
  8248. Enlarge the video source textures by this many pixels. For debugging only
  8249. (normally textures are sized exactly, but due to hardware decoding interop
  8250. we may have to deal with additional padding, which can be tested with these
  8251. options). Could be removed any time.
  8252. .TP
  8253. .B \fB\-\-opengl\-early\-flush=<yes|no|auto>\fP
  8254. Call \fBglFlush()\fP after rendering a frame and before attempting to display
  8255. it (default: auto). Can fix stuttering in some cases, in other cases
  8256. probably causes it. The \fBauto\fP mode will call \fBglFlush()\fP only if
  8257. the renderer is going to wait for a while after rendering, instead of
  8258. flipping GL front and backbuffers immediately (i.e. it doesn\(aqt call it
  8259. in display\-sync mode).
  8260. .sp
  8261. On OSX this is always deactivated because it only causes performance
  8262. problems and other regressions.
  8263. .TP
  8264. .B \fB\-\-gpu\-dumb\-mode=<yes|no|auto>\fP
  8265. This mode is extremely restricted, and will disable most extended
  8266. features. That includes high quality scalers and custom shaders!
  8267. .sp
  8268. It is intended for hardware that does not support FBOs (including GLES,
  8269. which supports it insufficiently), or to get some more performance out of
  8270. bad or old hardware.
  8271. .sp
  8272. This mode is forced automatically if needed, and this option is mostly
  8273. useful for debugging. The default of \fBauto\fP will enable it automatically
  8274. if nothing uses features which require FBOs.
  8275. .sp
  8276. This option might be silently removed in the future.
  8277. .TP
  8278. .B \fB\-\-gpu\-shader\-cache\-dir=<dirname>\fP
  8279. Store and load compiled GLSL shaders in this directory. Normally, shader
  8280. compilation is very fast, so this is usually not needed. It mostly matters
  8281. for GPU APIs that require internally recompiling shaders to other languages,
  8282. for example anything based on ANGLE or Vulkan. Enabling this can improve
  8283. startup performance on these platforms.
  8284. .sp
  8285. NOTE: This is not cleaned automatically, so old, unused cache files may
  8286. stick around indefinitely.
  8287. .UNINDENT
  8288. .SS Miscellaneous
  8289. .INDENT 0.0
  8290. .TP
  8291. .B \fB\-\-display\-tags=tag1,tags2,...\fP
  8292. Set the list of tags that should be displayed on the terminal. Tags that
  8293. are in the list, but are not present in the played file, will not be shown.
  8294. If a value ends with \fB*\fP, all tags are matched by prefix (though there
  8295. is no general globbing). Just passing \fB*\fP essentially filtering.
  8296. .sp
  8297. The default includes a common list of tags, call mpv with \fB\-\-list\-options\fP
  8298. to see it.
  8299. .sp
  8300. This is a string list option. See \fI\%List Options\fP for details.
  8301. .TP
  8302. .B \fB\-\-mc=<seconds/frame>\fP
  8303. Maximum A\-V sync correction per frame (in seconds)
  8304. .TP
  8305. .B \fB\-\-autosync=<factor>\fP
  8306. Gradually adjusts the A/V sync based on audio delay measurements.
  8307. Specifying \fB\-\-autosync=0\fP, the default, will cause frame timing to be
  8308. based entirely on audio delay measurements. Specifying \fB\-\-autosync=1\fP
  8309. will do the same, but will subtly change the A/V correction algorithm. An
  8310. uneven video framerate in a video which plays fine with \fB\-\-no\-audio\fP can
  8311. often be helped by setting this to an integer value greater than 1. The
  8312. higher the value, the closer the timing will be to \fB\-\-no\-audio\fP\&. Try
  8313. \fB\-\-autosync=30\fP to smooth out problems with sound drivers which do not
  8314. implement a perfect audio delay measurement. With this value, if large A/V
  8315. sync offsets occur, they will only take about 1 or 2 seconds to settle
  8316. out. This delay in reaction time to sudden A/V offsets should be the only
  8317. side effect of turning this option on, for all sound drivers.
  8318. .TP
  8319. .B \fB\-\-video\-timing\-offset=<seconds>\fP
  8320. Control how long before video display target time the frame should be
  8321. rendered (default: 0.050). If a video frame should be displayed at a
  8322. certain time, the VO will start rendering the frame earlier, and then will
  8323. perform a blocking wait until the display time, and only then "swap" the
  8324. frame to display. The rendering cannot start before the previous frame is
  8325. displayed, so this value is implicitly limited by the video framerate. With
  8326. normal video frame rates, the default value will ensure that rendering is
  8327. always immediately started after the previous frame was displayed. On the
  8328. other hand, setting a too high value can reduce responsiveness with low
  8329. FPS value.
  8330. .sp
  8331. For client API users using the render API (or the deprecated \fBopengl\-cb\fP
  8332. API), this option is interesting, because you can stop the render API
  8333. from limiting your FPS (see \fBmpv_render_context_render()\fP documentation).
  8334. .sp
  8335. This applies only to audio timing modes (e.g. \fB\-\-video\-sync=audio\fP). In
  8336. other modes (\fB\-\-video\-sync=display\-...\fP), video timing relies on vsync
  8337. blocking, and this option is not used.
  8338. .TP
  8339. .B \fB\-\-video\-sync=<audio|...>\fP
  8340. How the player synchronizes audio and video.
  8341. .sp
  8342. If you use this option, you usually want to set it to \fBdisplay\-resample\fP
  8343. to enable a timing mode that tries to not skip or repeat frames when for
  8344. example playing 24fps video on a 24Hz screen.
  8345. .sp
  8346. The modes starting with \fBdisplay\-\fP try to output video frames completely
  8347. synchronously to the display, using the detected display vertical refresh
  8348. rate as a hint how fast frames will be displayed on average. These modes
  8349. change video speed slightly to match the display. See \fB\-\-video\-sync\-...\fP
  8350. options for fine tuning. The robustness of this mode is further reduced by
  8351. making a some idealized assumptions, which may not always apply in reality.
  8352. Behavior can depend on the VO and the system\(aqs video and audio drivers.
  8353. Media files must use constant framerate. Section\-wise VFR might work as well
  8354. with some container formats (but not e.g. mkv).
  8355. .sp
  8356. Under some circumstances, the player automatically reverts to \fBaudio\fP mode
  8357. for some time or permanently. This can happen on very low framerate video,
  8358. or if the framerate cannot be detected.
  8359. .sp
  8360. Also in display\-sync modes it can happen that interruptions to video
  8361. playback (such as toggling fullscreen mode, or simply resizing the window)
  8362. will skip the video frames that should have been displayed, while \fBaudio\fP
  8363. mode will display them after the renderer has resumed (typically resulting
  8364. in a short A/V desync and the video "catching up").
  8365. .sp
  8366. Before mpv 0.30.0, there was a fallback to \fBaudio\fP mode on severe A/V
  8367. desync. This was changed for the sake of not sporadically stopping. Now,
  8368. \fBdisplay\-desync\fP does what it promises and may desync with audio by an
  8369. arbitrary amount, until it is manually fixed with a seek.
  8370. .sp
  8371. These modes also require a vsync blocked presentation mode. For OpenGL, this
  8372. translates to \fB\-\-opengl\-swapinterval=1\fP\&. For Vulkan, it translates to
  8373. \fB\-\-vulkan\-swap\-mode=fifo\fP (or \fBfifo\-relaxed\fP).
  8374. .sp
  8375. The modes with \fBdesync\fP in their names do not attempt to keep audio/video
  8376. in sync. They will slowly (or quickly) desync, until e.g. the next seek
  8377. happens. These modes are meant for testing, not serious use.
  8378. .INDENT 7.0
  8379. .TP
  8380. .B audio
  8381. Time video frames to audio. This is the most robust
  8382. mode, because the player doesn\(aqt have to assume anything
  8383. about how the display behaves. The disadvantage is that
  8384. it can lead to occasional frame drops or repeats. If
  8385. audio is disabled, this uses the system clock. This is
  8386. the default mode.
  8387. .TP
  8388. .B display\-resample
  8389. Resample audio to match the video. This mode will also
  8390. try to adjust audio speed to compensate for other drift.
  8391. (This means it will play the audio at a different speed
  8392. every once in a while to reduce the A/V difference.)
  8393. .TP
  8394. .B display\-resample\-vdrop
  8395. Resample audio to match the video. Drop video
  8396. frames to compensate for drift.
  8397. .TP
  8398. .B display\-resample\-desync
  8399. Like the previous mode, but no A/V compensation.
  8400. .TP
  8401. .B display\-vdrop
  8402. Drop or repeat video frames to compensate desyncing
  8403. video. (Although it should have the same effects as
  8404. \fBaudio\fP, the implementation is very different.)
  8405. .TP
  8406. .B display\-adrop
  8407. Drop or repeat audio data to compensate desyncing
  8408. video. See \fB\-\-video\-sync\-adrop\-size\fP\&. This mode will
  8409. cause severe audio artifacts if the real monitor
  8410. refresh rate is too different from the reported or
  8411. forced rate.
  8412. .TP
  8413. .B display\-desync
  8414. Sync video to display, and let audio play on its own.
  8415. .TP
  8416. .B desync
  8417. Sync video according to system clock, and let audio play
  8418. on its own.
  8419. .UNINDENT
  8420. .TP
  8421. .B \fB\-\-video\-sync\-max\-video\-change=<value>\fP
  8422. Maximum speed difference in percent that is applied to video with
  8423. \fB\-\-video\-sync=display\-...\fP (default: 1). Display sync mode will be
  8424. disabled if the monitor and video refresh way do not match within the
  8425. given range. It tries multiples as well: playing 30 fps video on a 60 Hz
  8426. screen will duplicate every second frame. Playing 24 fps video on a 60 Hz
  8427. screen will play video in a 2\-3\-2\-3\-... pattern.
  8428. .sp
  8429. The default settings are not loose enough to speed up 23.976 fps video to
  8430. 25 fps. We consider the pitch change too extreme to allow this behavior
  8431. by default. Set this option to a value of \fB5\fP to enable it.
  8432. .sp
  8433. Note that in the \fB\-\-video\-sync=display\-resample\fP mode, audio speed will
  8434. additionally be changed by a small amount if necessary for A/V sync. See
  8435. \fB\-\-video\-sync\-max\-audio\-change\fP\&.
  8436. .TP
  8437. .B \fB\-\-video\-sync\-max\-audio\-change=<value>\fP
  8438. Maximum \fIadditional\fP speed difference in percent that is applied to audio
  8439. with \fB\-\-video\-sync=display\-...\fP (default: 0.125). Normally, the player
  8440. plays the audio at the speed of the video. But if the difference between
  8441. audio and video position is too high, e.g. due to drift or other timing
  8442. errors, it will attempt to speed up or slow down audio by this additional
  8443. factor. Too low values could lead to video frame dropping or repeating if
  8444. the A/V desync cannot be compensated, too high values could lead to chaotic
  8445. frame dropping due to the audio "overshooting" and skipping multiple video
  8446. frames before the sync logic can react.
  8447. .TP
  8448. .B \fB\-\-video\-sync\-adrop\-size=<value>\fP
  8449. For the \fB\-\-video\-sync=display\-adrop\fP mode. This mode duplicates/drops
  8450. audio data to keep audio in sync with video. To avoid audio artifacts on
  8451. jitter (which would add/remove samples all the time), this is done in
  8452. relatively large, fixed units, controlled by this option. The unit is
  8453. seconds.
  8454. .TP
  8455. .B \fB\-\-mf\-fps=<value>\fP
  8456. Framerate used when decoding from multiple PNG or JPEG files with \fBmf://\fP
  8457. (default: 1).
  8458. .TP
  8459. .B \fB\-\-mf\-type=<value>\fP
  8460. Input file type for \fBmf://\fP (available: jpeg, png, tga, sgi). By default,
  8461. this is guessed from the file extension.
  8462. .TP
  8463. .B \fB\-\-stream\-dump=<destination\-filename>\fP
  8464. Instead of playing a file, read its byte stream and write it to the given
  8465. destination file. The destination is overwritten. Can be useful to test
  8466. network\-related behavior.
  8467. .TP
  8468. .B \fB\-\-stream\-lavf\-o=opt1=value1,opt2=value2,...\fP
  8469. Set AVOptions on streams opened with libavformat. Unknown or misspelled
  8470. options are silently ignored. (They are mentioned in the terminal output
  8471. in verbose mode, i.e. \fB\-\-v\fP\&. In general we can\(aqt print errors, because
  8472. other options such as e.g. user agent are not available with all protocols,
  8473. and printing errors for unknown options would end up being too noisy.)
  8474. .sp
  8475. This is a key/value list option. See \fI\%List Options\fP for details.
  8476. .TP
  8477. .B \fB\-\-vo\-mmcss\-profile=<name>\fP
  8478. (Windows only.)
  8479. Set the MMCSS profile for the video renderer thread (default: \fBPlayback\fP).
  8480. .TP
  8481. .B \fB\-\-priority=<prio>\fP
  8482. (Windows only.)
  8483. Set process priority for mpv according to the predefined priorities
  8484. available under Windows.
  8485. .sp
  8486. Possible values of \fB<prio>\fP:
  8487. idle|belownormal|normal|abovenormal|high|realtime
  8488. .sp
  8489. \fBWARNING:\fP
  8490. .INDENT 7.0
  8491. .INDENT 3.5
  8492. Using realtime priority can cause system lockup.
  8493. .UNINDENT
  8494. .UNINDENT
  8495. .TP
  8496. .B \fB\-\-force\-media\-title=<string>\fP
  8497. Force the contents of the \fBmedia\-title\fP property to this value. Useful
  8498. for scripts which want to set a title, without overriding the user\(aqs
  8499. setting in \fB\-\-title\fP\&.
  8500. .TP
  8501. .B \fB\-\-external\-files=<file\-list>\fP
  8502. Load a file and add all of its tracks. This is useful to play different
  8503. files together (for example audio from one file, video from another), or
  8504. for advanced \fB\-\-lavfi\-complex\fP used (like playing two video files at
  8505. the same time).
  8506. .sp
  8507. Unlike \fB\-\-sub\-files\fP and \fB\-\-audio\-files\fP, this includes all tracks, and
  8508. does not cause default stream selection over the "proper" file. This makes
  8509. it slightly less intrusive. (In mpv 0.28.0 and before, this was not quite
  8510. strictly enforced.)
  8511. .sp
  8512. This is a path list option. See \fI\%List Options\fP for details.
  8513. .TP
  8514. .B \fB\-\-external\-file=<file>\fP
  8515. CLI/config file only alias for \fB\-\-external\-files\-append\fP\&. Each use of this
  8516. option will add a new external files.
  8517. .TP
  8518. .B \fB\-\-autoload\-files=<yes|no>\fP
  8519. Automatically load/select external files (default: yes).
  8520. .sp
  8521. If set to \fBno\fP, then do not automatically load external files as specified
  8522. by \fB\-\-sub\-auto\fP and \fB\-\-audio\-file\-auto\fP\&. If external files are forcibly
  8523. added (like with \fB\-\-sub\-files\fP), they will not be auto\-selected.
  8524. .sp
  8525. This does not affect playlist expansion, redirection, or other loading of
  8526. referenced files like with ordered chapters.
  8527. .TP
  8528. .B \fB\-\-record\-file=<file>\fP
  8529. Deprecated, use \fB\-\-stream\-record\fP, or the \fBdump\-cache\fP command.
  8530. .sp
  8531. Record the current stream to the given target file. The target file will
  8532. always be overwritten without asking.
  8533. .sp
  8534. This was deprecated because it isn\(aqt very nice to use. For one, seeking
  8535. while this is enabled will be directly reflected in the output, which was
  8536. not useful and annoying.
  8537. .TP
  8538. .B \fB\-\-stream\-record=<file>\fP
  8539. Write received/read data from the demuxer to the given output file. The
  8540. output file will always be overwritten without asking. The output format
  8541. is determined by the extension of the output file.
  8542. .sp
  8543. Switching streams or seeking during recording might result in recording
  8544. being stopped and/or broken files. Use with care.
  8545. .sp
  8546. Seeking outside of the demuxer cache will result in "skips" in the output
  8547. file, but seeking within  the demuxer cache should not affect recording. One
  8548. exception is when you seek back far enough to exceed the forward buffering
  8549. size, in which case the cache stops actively reading. This will return in
  8550. dropped data if it\(aqs a live stream.
  8551. .sp
  8552. If this is set at runtime, the old file is closed, and the new file is
  8553. opened. Note that this will write only data that is appended at the end of
  8554. the cache, and the already cached data cannot be written. You can try the
  8555. \fBdump\-cache\fP command as an alternative.
  8556. .sp
  8557. External files (\fB\-\-audio\-file\fP etc.) are ignored by this, it works on the
  8558. "main" file only. Using this with files using ordered chapters or EDL files
  8559. will also not work correctly in general.
  8560. .sp
  8561. There are some glitches with this because it uses FFmpeg\(aqs libavformat for
  8562. writing the output file. For example, it\(aqs typical that it will only work if
  8563. the output format is the same as the input format. This is the case even if
  8564. it works with the \fBffmpeg\fP tool. One reason for this is that \fBffmpeg\fP
  8565. and its libraries contain certain hacks and workarounds for these issues,
  8566. that are unavailable to outside users.
  8567. .sp
  8568. This replaces \fB\-\-record\-file\fP\&. It is similar to the ancient/removed
  8569. \fB\-\-stream\-capture\fP/\fB\-capture\fP options, and provides better behavior in
  8570. most cases (i.e. actually works).
  8571. .TP
  8572. .B \fB\-\-lavfi\-complex=<string>\fP
  8573. Set a "complex" libavfilter filter, which means a single filter graph can
  8574. take input from multiple source audio and video tracks. The graph can result
  8575. in a single audio or video output (or both).
  8576. .sp
  8577. Currently, the filter graph labels are used to select the participating
  8578. input tracks and audio/video output. The following rules apply:
  8579. .INDENT 7.0
  8580. .IP \(bu 2
  8581. A label of the form \fBaidN\fP selects audio track N as input (e.g.
  8582. \fBaid1\fP).
  8583. .IP \(bu 2
  8584. A label of the form \fBvidN\fP selects video track N as input.
  8585. .IP \(bu 2
  8586. A label named \fBao\fP will be connected to the audio output.
  8587. .IP \(bu 2
  8588. A label named \fBvo\fP will be connected to the video output.
  8589. .UNINDENT
  8590. .sp
  8591. Each label can be used only once. If you want to use e.g. an audio stream
  8592. for multiple filters, you need to use the \fBasplit\fP filter. Multiple
  8593. video or audio outputs are not possible, but you can use filters to merge
  8594. them into one.
  8595. .sp
  8596. It\(aqs not possible to change the tracks connected to the filter at runtime,
  8597. unless you explicitly change the \fBlavfi\-complex\fP property and set new
  8598. track assignments. When the graph is changed, the track selection is changed
  8599. according to the used labels as well.
  8600. .sp
  8601. Other tracks, as long as they\(aqre not connected to the filter, and the
  8602. corresponding output is not connected to the filter, can still be freely
  8603. changed with the normal methods.
  8604. .sp
  8605. Note that the normal filter chains (\fB\-\-af\fP, \fB\-\-vf\fP) are applied between
  8606. the complex graphs (e.g. \fBao\fP label) and the actual output.
  8607. .INDENT 7.0
  8608. .INDENT 3.5
  8609. .IP "Examples"
  8610. .INDENT 0.0
  8611. .IP \(bu 2
  8612. \fB\-\-lavfi\-complex=\(aq[aid1] [aid2] amix [ao]\(aq\fP
  8613. Play audio track 1 and 2 at the same time.
  8614. .IP \(bu 2
  8615. \fB\-\-lavfi\-complex=\(aq[vid1] [vid2] vstack [vo]\(aq\fP
  8616. Stack video track 1 and 2 and play them at the same time. Note that
  8617. both tracks need to have the same width, or filter initialization
  8618. will fail (you can add \fBscale\fP filters before the \fBvstack\fP filter
  8619. to fix the size).
  8620. To load a video track from another file, you can use
  8621. \fB\-\-external\-file=other.mkv\fP\&.
  8622. .IP \(bu 2
  8623. \fB\-\-lavfi\-complex=\(aq[aid1] asplit [t1] [ao] ; [t1] showvolume [t2] ; [vid1] [t2] overlay [vo]\(aq\fP
  8624. Play audio track 1, and overlay the measured volume for each speaker
  8625. over video track 1.
  8626. .IP \(bu 2
  8627. \fBnull:// \-\-lavfi\-complex=\(aqlife [vo]\(aq\fP
  8628. A libavfilter source\-only filter (Conways\(aq Life Game).
  8629. .UNINDENT
  8630. .UNINDENT
  8631. .UNINDENT
  8632. .sp
  8633. See the FFmpeg libavfilter documentation for details on the available
  8634. filters.
  8635. .TP
  8636. .B \fB\-\-metadata\-codepage=<codepage>\fP
  8637. Codepage for various input metadata (default: \fButf\-8\fP). This affects how
  8638. file tags, chapter titles, etc. are interpreted. You can for example set
  8639. this to \fBauto\fP to enable autodetection of the codepage. (This is not the
  8640. default because non\-UTF\-8 codepages are an obscure fringe use\-case.)
  8641. .sp
  8642. See \fB\-\-sub\-codepage\fP option on how codepages are specified and further
  8643. details regarding autodetection and codepage conversion. (The underlying
  8644. code is the same.)
  8645. .sp
  8646. Conversion is not applied to metadata that is updated at runtime.
  8647. .UNINDENT
  8648. .SS Debugging
  8649. .INDENT 0.0
  8650. .TP
  8651. .B \fB\-\-unittest=<name>\fP
  8652. Run an internal unit test. There are multiple, and the name specifies which.
  8653. .sp
  8654. The special value \fBall\-simple\fP runs all tests which do not need further
  8655. setup (other arguments and such). Some tests may need additional arguments
  8656. to do anything useful.
  8657. .sp
  8658. On success, the player binary exits with exit status 0, otherwise it returns
  8659. with an undefined non\-0 exit status (it may crash or abort itself on test
  8660. failures).
  8661. .sp
  8662. This is only enabled if built with \fB\-\-enable\-tests\fP, and should normally
  8663. be enabled and used by developers only.
  8664. .UNINDENT
  8665. .SH AUDIO OUTPUT DRIVERS
  8666. .sp
  8667. Audio output drivers are interfaces to different audio output facilities. The
  8668. syntax is:
  8669. .INDENT 0.0
  8670. .TP
  8671. .B \fB\-\-ao=<driver1,driver2,...[,]>\fP
  8672. Specify a priority list of audio output drivers to be used.
  8673. .UNINDENT
  8674. .sp
  8675. If the list has a trailing \(aq,\(aq, mpv will fall back on drivers not contained
  8676. in the list.
  8677. .sp
  8678. \fBNOTE:\fP
  8679. .INDENT 0.0
  8680. .INDENT 3.5
  8681. See \fB\-\-ao=help\fP for a list of compiled\-in audio output drivers. The
  8682. driver \fB\-\-ao=alsa\fP is preferred. \fB\-\-ao=pulse\fP is preferred on systems
  8683. where PulseAudio is used. On BSD systems, \fB\-\-ao=oss\fP or \fB\-\-ao=sndio\fP
  8684. may work (the latter being experimental).
  8685. .UNINDENT
  8686. .UNINDENT
  8687. .sp
  8688. Available audio output drivers are:
  8689. .INDENT 0.0
  8690. .TP
  8691. .B \fBalsa\fP (Linux only)
  8692. ALSA audio output driver
  8693. .sp
  8694. See \fI\%ALSA audio output options\fP for options specific to this AO.
  8695. .sp
  8696. \fBWARNING:\fP
  8697. .INDENT 7.0
  8698. .INDENT 3.5
  8699. To get multichannel/surround audio, use \fB\-\-audio\-channels=auto\fP\&. The
  8700. default for this option is \fBauto\-safe\fP, which makes this audio output
  8701. explicitly reject multichannel output, as there is no way to detect
  8702. whether a certain channel layout is actually supported.
  8703. .sp
  8704. You can also try \fI\%using the upmix plugin\fP\&.
  8705. This setup enables multichannel audio on the \fBdefault\fP device
  8706. with automatic upmixing with shared access, so playing stereo
  8707. and multichannel audio at the same time will work as expected.
  8708. .UNINDENT
  8709. .UNINDENT
  8710. .TP
  8711. .B \fBoss\fP
  8712. OSS audio output driver
  8713. .sp
  8714. The following global options are supported by this audio output:
  8715. .INDENT 7.0
  8716. .TP
  8717. .B \fB\-\-oss\-mixer\-device\fP
  8718. Sets the audio mixer device (default: \fB/dev/mixer\fP).
  8719. .TP
  8720. .B \fB\-\-oss\-mixer\-channel\fP
  8721. Sets the audio mixer channel (default: \fBpcm\fP). Other valid values
  8722. include \fBvol, pcm, line\fP\&. For a complete list of options look for
  8723. \fBSOUND_DEVICE_NAMES\fP in \fB/usr/include/linux/soundcard.h\fP\&.
  8724. .UNINDENT
  8725. .TP
  8726. .B \fBjack\fP
  8727. JACK (Jack Audio Connection Kit) audio output driver.
  8728. .sp
  8729. The following global options are supported by this audio output:
  8730. .INDENT 7.0
  8731. .TP
  8732. .B \fB\-\-jack\-port=<name>\fP
  8733. Connects to the ports with the given name (default: physical ports).
  8734. .TP
  8735. .B \fB\-\-jack\-name=<client>\fP
  8736. Client name that is passed to JACK (default: \fBmpv\fP). Useful
  8737. if you want to have certain connections established automatically.
  8738. .TP
  8739. .B \fB\-\-jack\-autostart=<yes|no>\fP
  8740. Automatically start jackd if necessary (default: disabled). Note that
  8741. this tends to be unreliable and will flood stdout with server messages.
  8742. .TP
  8743. .B \fB\-\-jack\-connect=<yes|no>\fP
  8744. Automatically create connections to output ports (default: enabled).
  8745. When enabled, the maximum number of output channels will be limited to
  8746. the number of available output ports.
  8747. .TP
  8748. .B \fB\-\-jack\-std\-channel\-layout=<waveext|any>\fP
  8749. Select the standard channel layout (default: waveext). JACK itself has no
  8750. notion of channel layouts (i.e. assigning which speaker a given
  8751. channel is supposed to map to) \- it just takes whatever the application
  8752. outputs, and reroutes it to whatever the user defines. This means the
  8753. user and the application are in charge of dealing with the channel
  8754. layout. \fBwaveext\fP uses WAVE_FORMAT_EXTENSIBLE order, which, even
  8755. though it was defined by Microsoft, is the standard on many systems.
  8756. The value \fBany\fP makes JACK accept whatever comes from the audio
  8757. filter chain, regardless of channel layout and without reordering. This
  8758. mode is probably not very useful, other than for debugging or when used
  8759. with fixed setups.
  8760. .UNINDENT
  8761. .TP
  8762. .B \fBcoreaudio\fP (Mac OS X only)
  8763. Native Mac OS X audio output driver using AudioUnits and the CoreAudio
  8764. sound server.
  8765. .sp
  8766. Automatically redirects to \fBcoreaudio_exclusive\fP when playing compressed
  8767. formats.
  8768. .sp
  8769. The following global options are supported by this audio output:
  8770. .INDENT 7.0
  8771. .TP
  8772. .B \fB\-\-coreaudio\-change\-physical\-format=<yes|no>\fP
  8773. Change the physical format to one similar to the requested audio format
  8774. (default: no). This has the advantage that multichannel audio output
  8775. will actually work. The disadvantage is that it will change the
  8776. system\-wide audio settings. This is equivalent to changing the \fBFormat\fP
  8777. setting in the \fBAudio Devices\fP dialog in the \fBAudio MIDI Setup\fP
  8778. utility. Note that this does not affect the selected speaker setup.
  8779. .TP
  8780. .B \fB\-\-coreaudio\-spdif\-hack=<yes|no>\fP
  8781. Try to pass through AC3/DTS data as PCM. This is useful for drivers
  8782. which do not report AC3 support. It converts the AC3 data to float,
  8783. and assumes the driver will do the inverse conversion, which means
  8784. a typical A/V receiver will pick it up as compressed IEC framed AC3
  8785. stream, ignoring that it\(aqs marked as PCM. This disables normal AC3
  8786. passthrough (even if the device reports it as supported). Use with
  8787. extreme care.
  8788. .UNINDENT
  8789. .TP
  8790. .B \fBcoreaudio_exclusive\fP (Mac OS X only)
  8791. Native Mac OS X audio output driver using direct device access and
  8792. exclusive mode (bypasses the sound server).
  8793. .TP
  8794. .B \fBopenal\fP
  8795. OpenAL audio output driver
  8796. .INDENT 7.0
  8797. .TP
  8798. .B \fB\-\-openal\-num\-buffers=<2\-128>\fP
  8799. Specify the number of audio buffers to use. Lower values are better for
  8800. lower CPU usage. Default: 4.
  8801. .TP
  8802. .B \fB\-\-openal\-num\-samples=<256\-32768>\fP
  8803. Specify the number of complete samples to use for each buffer. Higher
  8804. values are better for lower CPU usage. Default: 8192.
  8805. .TP
  8806. .B \fB\-\-openal\-direct\-channels=<yes|no>\fP
  8807. Enable OpenAL Soft\(aqs direct channel extension when available to avoid
  8808. tinting the sound with ambisonics or HRTF.
  8809. Channels are dropped when when they are not available as downmixing
  8810. will be disabled. Default: no.
  8811. .UNINDENT
  8812. .TP
  8813. .B \fBpulse\fP
  8814. PulseAudio audio output driver
  8815. .sp
  8816. The following global options are supported by this audio output:
  8817. .INDENT 7.0
  8818. .TP
  8819. .B \fB\-\-pulse\-host=<host>\fP
  8820. Specify the host to use. An empty <host> string uses a local connection,
  8821. "localhost" uses network transfer (most likely not what you want).
  8822. .TP
  8823. .B \fB\-\-pulse\-buffer=<1\-2000|native>\fP
  8824. Set the audio buffer size in milliseconds. A higher value buffers
  8825. more data, and has a lower probability of buffer underruns. A smaller
  8826. value makes the audio stream react faster, e.g. to playback speed
  8827. changes.
  8828. .TP
  8829. .B \fB\-\-pulse\-latency\-hacks=<yes|no>\fP
  8830. Enable hacks to workaround PulseAudio timing bugs (default: no). If
  8831. enabled, mpv will do elaborate latency calculations on its own. If
  8832. disabled, it will use PulseAudio automatically updated timing
  8833. information. Disabling this might help with e.g. networked audio or
  8834. some plugins, while enabling it might help in some unknown situations
  8835. (it used to be required to get good behavior on old PulseAudio versions).
  8836. .sp
  8837. If you have stuttering video when using pulse, try to enable this
  8838. option. (Or try to update PulseAudio.)
  8839. .TP
  8840. .B \fB\-\-pulse\-allow\-suspended=<yes|no>\fP
  8841. Allow mpv to use PulseAudio even if the sink is suspended (default: no).
  8842. Can be useful if PulseAudio is running as a bridge to jack and mpv has its sink\-input set to the one jack is using.
  8843. .UNINDENT
  8844. .TP
  8845. .B \fBsdl\fP
  8846. SDL 1.2+ audio output driver. Should work on any platform supported by SDL
  8847. 1.2, but may require the \fBSDL_AUDIODRIVER\fP environment variable to be set
  8848. appropriately for your system.
  8849. .sp
  8850. \fBNOTE:\fP
  8851. .INDENT 7.0
  8852. .INDENT 3.5
  8853. This driver is for compatibility with extremely foreign
  8854. environments, such as systems where none of the other drivers
  8855. are available.
  8856. .UNINDENT
  8857. .UNINDENT
  8858. .sp
  8859. The following global options are supported by this audio output:
  8860. .INDENT 7.0
  8861. .TP
  8862. .B \fB\-\-sdl\-buflen=<length>\fP
  8863. Sets the audio buffer length in seconds. Is used only as a hint by the
  8864. sound system. Playing a file with \fB\-v\fP will show the requested and
  8865. obtained exact buffer size. A value of 0 selects the sound system
  8866. default.
  8867. .TP
  8868. .B \fB\-\-sdl\-bufcnt=<count>\fP
  8869. Sets the number of extra audio buffers in mpv. Usually needs not be
  8870. changed.
  8871. .UNINDENT
  8872. .TP
  8873. .B \fBnull\fP
  8874. Produces no audio output but maintains video playback speed. You can use
  8875. \fB\-\-ao=null \-\-ao\-null\-untimed\fP for benchmarking.
  8876. .sp
  8877. The following global options are supported by this audio output:
  8878. .INDENT 7.0
  8879. .TP
  8880. .B \fB\-\-ao\-null\-untimed\fP
  8881. Do not simulate timing of a perfect audio device. This means audio
  8882. decoding will go as fast as possible, instead of timing it to the
  8883. system clock.
  8884. .TP
  8885. .B \fB\-\-ao\-null\-buffer\fP
  8886. Simulated buffer length in seconds.
  8887. .TP
  8888. .B \fB\-\-ao\-null\-outburst\fP
  8889. Simulated chunk size in samples.
  8890. .TP
  8891. .B \fB\-\-ao\-null\-speed\fP
  8892. Simulated audio playback speed as a multiplier. Usually, a real audio
  8893. device will not go exactly as fast as the system clock. It will deviate
  8894. just a little, and this option helps to simulate this.
  8895. .TP
  8896. .B \fB\-\-ao\-null\-latency\fP
  8897. Simulated device latency. This is additional to EOF.
  8898. .TP
  8899. .B \fB\-\-ao\-null\-broken\-eof\fP
  8900. Simulate broken audio drivers, which always add the fixed device
  8901. latency to the reported audio playback position.
  8902. .TP
  8903. .B \fB\-\-ao\-null\-broken\-delay\fP
  8904. Simulate broken audio drivers, which don\(aqt report latency correctly.
  8905. .TP
  8906. .B \fB\-\-ao\-null\-channel\-layouts\fP
  8907. If not empty, this is a \fB,\fP separated list of channel layouts the
  8908. AO allows. This can be used to test channel layout selection.
  8909. .TP
  8910. .B \fB\-\-ao\-null\-format\fP
  8911. Force the audio output format the AO will accept. If unset accepts any.
  8912. .UNINDENT
  8913. .TP
  8914. .B \fBpcm\fP
  8915. Raw PCM/WAVE file writer audio output
  8916. .sp
  8917. The following global options are supported by this audio output:
  8918. .INDENT 7.0
  8919. .TP
  8920. .B \fB\-\-ao\-pcm\-waveheader=<yes|no>\fP
  8921. Include or do not include the WAVE header (default: included). When
  8922. not included, raw PCM will be generated.
  8923. .TP
  8924. .B \fB\-\-ao\-pcm\-file=<filename>\fP
  8925. Write the sound to \fB<filename>\fP instead of the default
  8926. \fBaudiodump.wav\fP\&. If \fBno\-waveheader\fP is specified, the default is
  8927. \fBaudiodump.pcm\fP\&.
  8928. .TP
  8929. .B \fB\-\-ao\-pcm\-append=<yes|no>\fP
  8930. Append to the file, instead of overwriting it. Always use this with the
  8931. \fBno\-waveheader\fP option \- with \fBwaveheader\fP it\(aqs broken, because
  8932. it will write a WAVE header every time the file is opened.
  8933. .UNINDENT
  8934. .TP
  8935. .B \fBrsound\fP
  8936. Audio output to an RSound daemon. Use \fB\-\-audio\-device=rsound/<hostname>\fP
  8937. to set the host name (with \fB<hostname>\fP replaced, without the \fB< >\fP).
  8938. .sp
  8939. \fBNOTE:\fP
  8940. .INDENT 7.0
  8941. .INDENT 3.5
  8942. Completely useless, unless you intend to run RSound. Not to be
  8943. confused with RoarAudio, which is something completely
  8944. different.
  8945. .UNINDENT
  8946. .UNINDENT
  8947. .TP
  8948. .B \fBsndio\fP
  8949. Audio output to the OpenBSD sndio sound system
  8950. .sp
  8951. \fBNOTE:\fP
  8952. .INDENT 7.0
  8953. .INDENT 3.5
  8954. Experimental. There are known bugs and issues.
  8955. .UNINDENT
  8956. .UNINDENT
  8957. .sp
  8958. (Note: only supports mono, stereo, 4.0, 5.1 and 7.1 channel
  8959. layouts.)
  8960. .TP
  8961. .B \fBwasapi\fP
  8962. Audio output to the Windows Audio Session API.
  8963. .UNINDENT
  8964. .SH VIDEO OUTPUT DRIVERS
  8965. .sp
  8966. Video output drivers are interfaces to different video output facilities. The
  8967. syntax is:
  8968. .INDENT 0.0
  8969. .TP
  8970. .B \fB\-\-vo=<driver1,driver2,...[,]>\fP
  8971. Specify a priority list of video output drivers to be used.
  8972. .UNINDENT
  8973. .sp
  8974. If the list has a trailing \fB,\fP, mpv will fall back on drivers not contained
  8975. in the list.
  8976. .sp
  8977. \fBNOTE:\fP
  8978. .INDENT 0.0
  8979. .INDENT 3.5
  8980. See \fB\-\-vo=help\fP for a list of compiled\-in video output drivers.
  8981. .sp
  8982. The recommended output driver is \fB\-\-vo=gpu\fP, which is the default. All
  8983. other drivers are for compatibility or special purposes. If the default
  8984. does not work, it will fallback to other drivers (in the same order as
  8985. listed by \fB\-\-vo=help\fP).
  8986. .UNINDENT
  8987. .UNINDENT
  8988. .sp
  8989. Available video output drivers are:
  8990. .INDENT 0.0
  8991. .TP
  8992. .B \fBxv\fP (X11 only)
  8993. Uses the XVideo extension to enable hardware\-accelerated display. This is
  8994. the most compatible VO on X, but may be low\-quality, and has issues with
  8995. OSD and subtitle display.
  8996. .sp
  8997. \fBNOTE:\fP
  8998. .INDENT 7.0
  8999. .INDENT 3.5
  9000. This driver is for compatibility with old systems.
  9001. .UNINDENT
  9002. .UNINDENT
  9003. .sp
  9004. The following global options are supported by this video output:
  9005. .INDENT 7.0
  9006. .TP
  9007. .B \fB\-\-xv\-adaptor=<number>\fP
  9008. Select a specific XVideo adapter (check xvinfo results).
  9009. .TP
  9010. .B \fB\-\-xv\-port=<number>\fP
  9011. Select a specific XVideo port.
  9012. .TP
  9013. .B \fB\-\-xv\-ck=<cur|use|set>\fP
  9014. Select the source from which the color key is taken (default: cur).
  9015. .INDENT 7.0
  9016. .TP
  9017. .B cur
  9018. The default takes the color key currently set in Xv.
  9019. .TP
  9020. .B use
  9021. Use but do not set the color key from mpv (use the \fB\-\-colorkey\fP
  9022. option to change it).
  9023. .TP
  9024. .B set
  9025. Same as use but also sets the supplied color key.
  9026. .UNINDENT
  9027. .TP
  9028. .B \fB\-\-xv\-ck\-method=<none|man|bg|auto>\fP
  9029. Sets the color key drawing method (default: man).
  9030. .INDENT 7.0
  9031. .TP
  9032. .B none
  9033. Disables color\-keying.
  9034. .TP
  9035. .B man
  9036. Draw the color key manually (reduces flicker in some cases).
  9037. .TP
  9038. .B bg
  9039. Set the color key as window background.
  9040. .TP
  9041. .B auto
  9042. Let Xv draw the color key.
  9043. .UNINDENT
  9044. .TP
  9045. .B \fB\-\-xv\-colorkey=<number>\fP
  9046. Changes the color key to an RGB value of your choice. \fB0x000000\fP is
  9047. black and \fB0xffffff\fP is white.
  9048. .TP
  9049. .B \fB\-\-xv\-buffers=<number>\fP
  9050. Number of image buffers to use for the internal ringbuffer (default: 2).
  9051. Increasing this will use more memory, but might help with the X server
  9052. not responding quickly enough if video FPS is close to or higher than
  9053. the display refresh rate.
  9054. .UNINDENT
  9055. .TP
  9056. .B \fBx11\fP (X11 only)
  9057. Shared memory video output driver without hardware acceleration that works
  9058. whenever X11 is present.
  9059. .sp
  9060. Since mpv 0.30.0, you may need to use \fB\-\-profile=sw\-fast\fP to get decent
  9061. performance.
  9062. .sp
  9063. \fBNOTE:\fP
  9064. .INDENT 7.0
  9065. .INDENT 3.5
  9066. This is a fallback only, and should not be normally used.
  9067. .UNINDENT
  9068. .UNINDENT
  9069. .TP
  9070. .B \fBvdpau\fP (X11 only)
  9071. Uses the VDPAU interface to display and optionally also decode video.
  9072. Hardware decoding is used with \fB\-\-hwdec=vdpau\fP\&.
  9073. .sp
  9074. \fBNOTE:\fP
  9075. .INDENT 7.0
  9076. .INDENT 3.5
  9077. Earlier versions of mpv (and MPlayer, mplayer2) provided sub\-options
  9078. to tune vdpau post\-processing, like \fBdeint\fP, \fBsharpen\fP, \fBdenoise\fP,
  9079. \fBchroma\-deint\fP, \fBpullup\fP, \fBhqscaling\fP\&. These sub\-options are
  9080. deprecated, and you should use the \fBvdpaupp\fP video filter instead.
  9081. .UNINDENT
  9082. .UNINDENT
  9083. .sp
  9084. The following global options are supported by this video output:
  9085. .INDENT 7.0
  9086. .TP
  9087. .B \fB\-\-vo\-vdpau\-sharpen=<\-1\-1>\fP
  9088. (Deprecated. See note about \fBvdpaupp\fP\&.)
  9089. .sp
  9090. For positive values, apply a sharpening algorithm to the video, for
  9091. negative values a blurring algorithm (default: 0).
  9092. .TP
  9093. .B \fB\-\-vo\-vdpau\-denoise=<0\-1>\fP
  9094. (Deprecated. See note about \fBvdpaupp\fP\&.)
  9095. .sp
  9096. Apply a noise reduction algorithm to the video (default: 0; no noise
  9097. reduction).
  9098. .TP
  9099. .B \fB\-\-vo\-vdpau\-deint=<\-4\-4>\fP
  9100. (Deprecated. See note about \fBvdpaupp\fP\&.)
  9101. .sp
  9102. Select deinterlacing mode (default: 0). In older versions (as well as
  9103. MPlayer/mplayer2) you could use this option to enable deinterlacing.
  9104. This doesn\(aqt work anymore, and deinterlacing is enabled with either
  9105. the \fBd\fP key (by default mapped to the command \fBcycle deinterlace\fP),
  9106. or the \fB\-\-deinterlace\fP option. Also, to select the default deint mode,
  9107. you should use something like \fB\-\-vf\-defaults=vdpaupp:deint\-mode=temporal\fP
  9108. instead of this sub\-option.
  9109. .INDENT 7.0
  9110. .TP
  9111. .B 0
  9112. Pick the \fBvdpaupp\fP video filter default, which corresponds to 3.
  9113. .TP
  9114. .B 1
  9115. Show only first field.
  9116. .TP
  9117. .B 2
  9118. Bob deinterlacing.
  9119. .TP
  9120. .B 3
  9121. Motion\-adaptive temporal deinterlacing. May lead to A/V desync
  9122. with slow video hardware and/or high resolution.
  9123. .TP
  9124. .B 4
  9125. Motion\-adaptive temporal deinterlacing with edge\-guided spatial
  9126. interpolation. Needs fast video hardware.
  9127. .UNINDENT
  9128. .TP
  9129. .B \fB\-\-vo\-vdpau\-chroma\-deint\fP
  9130. (Deprecated. See note about \fBvdpaupp\fP\&.)
  9131. .sp
  9132. Makes temporal deinterlacers operate both on luma and chroma (default).
  9133. Use no\-chroma\-deint to solely use luma and speed up advanced
  9134. deinterlacing. Useful with slow video memory.
  9135. .TP
  9136. .B \fB\-\-vo\-vdpau\-pullup\fP
  9137. (Deprecated. See note about \fBvdpaupp\fP\&.)
  9138. .sp
  9139. Try to apply inverse telecine, needs motion adaptive temporal
  9140. deinterlacing.
  9141. .TP
  9142. .B \fB\-\-vo\-vdpau\-hqscaling=<0\-9>\fP
  9143. (Deprecated. See note about \fBvdpaupp\fP\&.)
  9144. .INDENT 7.0
  9145. .TP
  9146. .B 0
  9147. Use default VDPAU scaling (default).
  9148. .TP
  9149. .B 1\-9
  9150. Apply high quality VDPAU scaling (needs capable hardware).
  9151. .UNINDENT
  9152. .TP
  9153. .B \fB\-\-vo\-vdpau\-fps=<number>\fP
  9154. Override autodetected display refresh rate value (the value is needed
  9155. for framedrop to allow video playback rates higher than display
  9156. refresh rate, and for vsync\-aware frame timing adjustments). Default 0
  9157. means use autodetected value. A positive value is interpreted as a
  9158. refresh rate in Hz and overrides the autodetected value. A negative
  9159. value disables all timing adjustment and framedrop logic.
  9160. .TP
  9161. .B \fB\-\-vo\-vdpau\-composite\-detect\fP
  9162. NVIDIA\(aqs current VDPAU implementation behaves somewhat differently
  9163. under a compositing window manager and does not give accurate frame
  9164. timing information. With this option enabled, the player tries to
  9165. detect whether a compositing window manager is active. If one is
  9166. detected, the player disables timing adjustments as if the user had
  9167. specified \fBfps=\-1\fP (as they would be based on incorrect input). This
  9168. means timing is somewhat less accurate than without compositing, but
  9169. with the composited mode behavior of the NVIDIA driver, there is no
  9170. hard playback speed limit even without the disabled logic. Enabled by
  9171. default, use \fB\-\-vo\-vdpau\-composite\-detect=no\fP to disable.
  9172. .TP
  9173. .B \fB\-\-vo\-vdpau\-queuetime\-windowed=<number>\fP and \fBqueuetime\-fs=<number>\fP
  9174. Use VDPAU\(aqs presentation queue functionality to queue future video
  9175. frame changes at most this many milliseconds in advance (default: 50).
  9176. See below for additional information.
  9177. .TP
  9178. .B \fB\-\-vo\-vdpau\-output\-surfaces=<2\-15>\fP
  9179. Allocate this many output surfaces to display video frames (default:
  9180. 3). See below for additional information.
  9181. .TP
  9182. .B \fB\-\-vo\-vdpau\-colorkey=<#RRGGBB|#AARRGGBB>\fP
  9183. Set the VDPAU presentation queue background color, which in practice
  9184. is the colorkey used if VDPAU operates in overlay mode (default:
  9185. \fB#020507\fP, some shade of black). If the alpha component of this value
  9186. is 0, the default VDPAU colorkey will be used instead (which is usually
  9187. green).
  9188. .TP
  9189. .B \fB\-\-vo\-vdpau\-force\-yuv\fP
  9190. Never accept RGBA input. This means mpv will insert a filter to convert
  9191. to a YUV format before the VO. Sometimes useful to force availability
  9192. of certain YUV\-only features, like video equalizer or deinterlacing.
  9193. .UNINDENT
  9194. .sp
  9195. Using the VDPAU frame queuing functionality controlled by the queuetime
  9196. options makes mpv\(aqs frame flip timing less sensitive to system CPU load and
  9197. allows mpv to start decoding the next frame(s) slightly earlier, which can
  9198. reduce jitter caused by individual slow\-to\-decode frames. However, the
  9199. NVIDIA graphics drivers can make other window behavior such as window moves
  9200. choppy if VDPAU is using the blit queue (mainly happens if you have the
  9201. composite extension enabled) and this feature is active. If this happens on
  9202. your system and it bothers you then you can set the queuetime value to 0 to
  9203. disable this feature. The settings to use in windowed and fullscreen mode
  9204. are separate because there should be no reason to disable this for
  9205. fullscreen mode (as the driver issue should not affect the video itself).
  9206. .sp
  9207. You can queue more frames ahead by increasing the queuetime values and the
  9208. \fBoutput_surfaces\fP count (to ensure enough surfaces to buffer video for a
  9209. certain time ahead you need at least as many surfaces as the video has
  9210. frames during that time, plus two). This could help make video smoother in
  9211. some cases. The main downsides are increased video RAM requirements for
  9212. the surfaces and laggier display response to user commands (display
  9213. changes only become visible some time after they\(aqre queued). The graphics
  9214. driver implementation may also have limits on the length of maximum
  9215. queuing time or number of queued surfaces that work well or at all.
  9216. .TP
  9217. .B \fBdirect3d\fP (Windows only)
  9218. Video output driver that uses the Direct3D interface.
  9219. .sp
  9220. \fBNOTE:\fP
  9221. .INDENT 7.0
  9222. .INDENT 3.5
  9223. This driver is for compatibility with systems that don\(aqt provide
  9224. proper OpenGL drivers, and where ANGLE does not perform well.
  9225. .UNINDENT
  9226. .UNINDENT
  9227. .sp
  9228. \fBNOTE:\fP
  9229. .INDENT 7.0
  9230. .INDENT 3.5
  9231. Before to 0.21.0, \fBdirect3d_shaders\fP and \fBdirect3d\fP were
  9232. different, with \fBdirect3d\fP not using shader by default. Now
  9233. both use shaders by default, and \fBdirect3d_shaders\fP is a
  9234. deprecated alias. Use the \fB\-\-vo\-direct3d\-prefer\-stretchrect\fP
  9235. or the \fB\-\-vo\-direct3d\-disable\-shaders\fP options to get the old
  9236. behavior of \fBdirect3d\fP\&.
  9237. .UNINDENT
  9238. .UNINDENT
  9239. .sp
  9240. The following global options are supported by this video output:
  9241. .INDENT 7.0
  9242. .TP
  9243. .B \fB\-\-vo\-direct3d\-prefer\-stretchrect\fP
  9244. Use \fBIDirect3DDevice9::StretchRect\fP over other methods if possible.
  9245. .TP
  9246. .B \fB\-\-vo\-direct3d\-disable\-stretchrect\fP
  9247. Never render the video using \fBIDirect3DDevice9::StretchRect\fP\&.
  9248. .TP
  9249. .B \fB\-\-vo\-direct3d\-disable\-textures\fP
  9250. Never render the video using D3D texture rendering. Rendering with
  9251. textures + shader will still be allowed. Add \fBdisable\-shaders\fP to
  9252. completely disable video rendering with textures.
  9253. .TP
  9254. .B \fB\-\-vo\-direct3d\-disable\-shaders\fP
  9255. Never use shaders when rendering video.
  9256. .TP
  9257. .B \fB\-\-vo\-direct3d\-only\-8bit\fP
  9258. Never render YUV video with more than 8 bits per component.
  9259. Using this flag will force software conversion to 8\-bit.
  9260. .TP
  9261. .B \fB\-\-vo\-direct3d\-disable\-texture\-align\fP
  9262. Normally texture sizes are always aligned to 16. With this option
  9263. enabled, the video texture will always have exactly the same size as
  9264. the video itself.
  9265. .UNINDENT
  9266. .sp
  9267. Debug options. These might be incorrect, might be removed in the future,
  9268. might crash, might cause slow downs, etc. Contact the developers if you
  9269. actually need any of these for performance or proper operation.
  9270. .INDENT 7.0
  9271. .TP
  9272. .B \fB\-\-vo\-direct3d\-force\-power\-of\-2\fP
  9273. Always force textures to power of 2, even if the device reports
  9274. non\-power\-of\-2 texture sizes as supported.
  9275. .TP
  9276. .B \fB\-\-vo\-direct3d\-texture\-memory=<mode>\fP
  9277. Only affects operation with shaders/texturing enabled, and (E)OSD.
  9278. Possible values:
  9279. .INDENT 7.0
  9280. .TP
  9281. .B \fBdefault\fP (default)
  9282. Use \fBD3DPOOL_DEFAULT\fP, with a \fBD3DPOOL_SYSTEMMEM\fP texture for
  9283. locking. If the driver supports \fBD3DDEVCAPS_TEXTURESYSTEMMEMORY\fP,
  9284. \fBD3DPOOL_SYSTEMMEM\fP is used directly.
  9285. .TP
  9286. .B \fBdefault\-pool\fP
  9287. Use \fBD3DPOOL_DEFAULT\fP\&. (Like \fBdefault\fP, but never use a
  9288. shadow\-texture.)
  9289. .TP
  9290. .B \fBdefault\-pool\-shadow\fP
  9291. Use \fBD3DPOOL_DEFAULT\fP, with a \fBD3DPOOL_SYSTEMMEM\fP texture for
  9292. locking. (Like \fBdefault\fP, but always force the shadow\-texture.)
  9293. .TP
  9294. .B \fBmanaged\fP
  9295. Use \fBD3DPOOL_MANAGED\fP\&.
  9296. .TP
  9297. .B \fBscratch\fP
  9298. Use \fBD3DPOOL_SCRATCH\fP, with a \fBD3DPOOL_SYSTEMMEM\fP texture for
  9299. locking.
  9300. .UNINDENT
  9301. .TP
  9302. .B \fB\-\-vo\-direct3d\-swap\-discard\fP
  9303. Use \fBD3DSWAPEFFECT_DISCARD\fP, which might be faster.
  9304. Might be slower too, as it must(?) clear every frame.
  9305. .TP
  9306. .B \fB\-\-vo\-direct3d\-exact\-backbuffer\fP
  9307. Always resize the backbuffer to window size.
  9308. .UNINDENT
  9309. .TP
  9310. .B \fBgpu\fP
  9311. General purpose, customizable, GPU\-accelerated video output driver. It
  9312. supports extended scaling methods, dithering, color management, custom
  9313. shaders, HDR, and more.
  9314. .sp
  9315. See \fI\%GPU renderer options\fP for options specific to this VO.
  9316. .sp
  9317. By default, it tries to use fast and fail\-safe settings. Use the
  9318. \fBgpu\-hq\fP profile to use this driver with defaults set to high quality
  9319. rendering. The profile can be applied with \fB\-\-profile=gpu\-hq\fP and its
  9320. contents can be viewed with \fB\-\-show\-profile=gpu\-hq\fP\&.
  9321. .sp
  9322. This VO abstracts over several possible graphics APIs and windowing
  9323. contexts, which can be influenced using the \fB\-\-gpu\-api\fP and
  9324. \fB\-\-gpu\-context\fP options.
  9325. .sp
  9326. Hardware decoding over OpenGL\-interop is supported to some degree. Note
  9327. that in this mode, some corner case might not be gracefully handled, and
  9328. color space conversion and chroma upsampling is generally in the hand of
  9329. the hardware decoder APIs.
  9330. .sp
  9331. \fBgpu\fP makes use of FBOs by default. Sometimes you can achieve better
  9332. quality or performance by changing the \fB\-\-gpu\-fbo\-format\fP option to
  9333. \fBrgb16f\fP, \fBrgb32f\fP or \fBrgb\fP\&. Known problems include Mesa/Intel not
  9334. accepting \fBrgb16\fP, Mesa sometimes not being compiled with float texture
  9335. support, and some OS X setups being very slow with \fBrgb16\fP but fast
  9336. with \fBrgb32f\fP\&. If you have problems, you can also try enabling the
  9337. \fB\-\-gpu\-dumb\-mode=yes\fP option.
  9338. .TP
  9339. .B \fBsdl\fP
  9340. SDL 2.0+ Render video output driver, depending on system with or without
  9341. hardware acceleration. Should work on all platforms supported by SDL 2.0.
  9342. For tuning, refer to your copy of the file \fBSDL_hints.h\fP\&.
  9343. .sp
  9344. \fBNOTE:\fP
  9345. .INDENT 7.0
  9346. .INDENT 3.5
  9347. This driver is for compatibility with systems that don\(aqt provide
  9348. proper graphics drivers.
  9349. .UNINDENT
  9350. .UNINDENT
  9351. .sp
  9352. The following global options are supported by this video output:
  9353. .INDENT 7.0
  9354. .TP
  9355. .B \fB\-\-sdl\-sw\fP
  9356. Continue even if a software renderer is detected.
  9357. .TP
  9358. .B \fB\-\-sdl\-switch\-mode\fP
  9359. Instruct SDL to switch the monitor video mode when going fullscreen.
  9360. .UNINDENT
  9361. .TP
  9362. .B \fBvaapi\fP
  9363. Intel VA API video output driver with support for hardware decoding. Note
  9364. that there is absolutely no reason to use this, other than compatibility.
  9365. This is low quality, and has issues with OSD.
  9366. .sp
  9367. \fBNOTE:\fP
  9368. .INDENT 7.0
  9369. .INDENT 3.5
  9370. This driver is for compatibility with crappy systems. You can
  9371. use vaapi hardware decoding with \fB\-\-vo=gpu\fP too.
  9372. .UNINDENT
  9373. .UNINDENT
  9374. .sp
  9375. The following global options are supported by this video output:
  9376. .INDENT 7.0
  9377. .TP
  9378. .B \fB\-\-vo\-vaapi\-scaling=<algorithm>\fP
  9379. .INDENT 7.0
  9380. .TP
  9381. .B default
  9382. Driver default (mpv default as well).
  9383. .TP
  9384. .B fast
  9385. Fast, but low quality.
  9386. .TP
  9387. .B hq
  9388. Unspecified driver dependent high\-quality scaling, slow.
  9389. .TP
  9390. .B nla
  9391. \fBnon\-linear anamorphic scaling\fP
  9392. .UNINDENT
  9393. .TP
  9394. .B \fB\-\-vo\-vaapi\-deint\-mode=<mode>\fP
  9395. Select deinterlacing algorithm. Note that by default deinterlacing is
  9396. initially always off, and needs to be enabled with the \fBd\fP key
  9397. (default key binding for \fBcycle deinterlace\fP).
  9398. .sp
  9399. This option doesn\(aqt apply if libva supports video post processing (vpp).
  9400. In this case, the default for \fBdeint\-mode\fP is \fBno\fP, and enabling
  9401. deinterlacing via user interaction using the methods mentioned above
  9402. actually inserts the \fBvavpp\fP video filter. If vpp is not actually
  9403. supported with the libva backend in use, you can use this option to
  9404. forcibly enable VO based deinterlacing.
  9405. .INDENT 7.0
  9406. .TP
  9407. .B no
  9408. Don\(aqt allow deinterlacing (default for newer libva).
  9409. .TP
  9410. .B first\-field
  9411. Show only first field.
  9412. .TP
  9413. .B bob
  9414. bob deinterlacing (default for older libva).
  9415. .UNINDENT
  9416. .TP
  9417. .B \fB\-\-vo\-vaapi\-scaled\-osd=<yes|no>\fP
  9418. If enabled, then the OSD is rendered at video resolution and scaled to
  9419. display resolution. By default, this is disabled, and the OSD is
  9420. rendered at display resolution if the driver supports it.
  9421. .UNINDENT
  9422. .TP
  9423. .B \fBnull\fP
  9424. Produces no video output. Useful for benchmarking.
  9425. .sp
  9426. Usually, it\(aqs better to disable video with \fB\-\-no\-video\fP instead.
  9427. .sp
  9428. The following global options are supported by this video output:
  9429. .INDENT 7.0
  9430. .TP
  9431. .B \fB\-\-vo\-null\-fps=<value>\fP
  9432. Simulate display FPS. This artificially limits how many frames the
  9433. VO accepts per second.
  9434. .UNINDENT
  9435. .TP
  9436. .B \fBcaca\fP
  9437. Color ASCII art video output driver that works on a text console.
  9438. .sp
  9439. \fBNOTE:\fP
  9440. .INDENT 7.0
  9441. .INDENT 3.5
  9442. This driver is a joke.
  9443. .UNINDENT
  9444. .UNINDENT
  9445. .TP
  9446. .B \fBtct\fP
  9447. Color Unicode art video output driver that works on a text console.
  9448. Depends on support of true color by modern terminals to display the images
  9449. at full color range. On Windows it requires an ansi terminal such as mintty.
  9450. .sp
  9451. Since mpv 0.30.0, you may need to use \fB\-\-profile=sw\-fast\fP to get decent
  9452. performance.
  9453. .INDENT 7.0
  9454. .TP
  9455. .B \fB\-\-vo\-tct\-algo=<algo>\fP
  9456. Select how to write the pixels to the terminal.
  9457. .INDENT 7.0
  9458. .TP
  9459. .B half\-blocks
  9460. Uses unicode LOWER HALF BLOCK character to achieve higher vertical
  9461. resolution. (Default.)
  9462. .TP
  9463. .B plain
  9464. Uses spaces. Causes vertical resolution to drop twofolds, but in
  9465. theory works in more places.
  9466. .UNINDENT
  9467. .TP
  9468. .B \fB\-\-vo\-tct\-width=<width>\fP  \fB\-\-vo\-tct\-height=<height>\fP
  9469. Assume the terminal has the specified character width and/or height.
  9470. These default to 80x25 if the terminal size cannot be determined.
  9471. .TP
  9472. .B \fB\-\-vo\-tct\-256=<yes|no>\fP (default: no)
  9473. Use 256 colors \- for terminals which don\(aqt support true color.
  9474. .UNINDENT
  9475. .TP
  9476. .B \fBimage\fP
  9477. Output each frame into an image file in the current directory. Each file
  9478. takes the frame number padded with leading zeros as name.
  9479. .sp
  9480. The following global options are supported by this video output:
  9481. .INDENT 7.0
  9482. .TP
  9483. .B \fB\-\-vo\-image\-format=<format>\fP
  9484. Select the image file format.
  9485. .INDENT 7.0
  9486. .TP
  9487. .B jpg
  9488. JPEG files, extension .jpg. (Default.)
  9489. .TP
  9490. .B jpeg
  9491. JPEG files, extension .jpeg.
  9492. .TP
  9493. .B png
  9494. PNG files.
  9495. .TP
  9496. .B webp
  9497. WebP files.
  9498. .UNINDENT
  9499. .TP
  9500. .B \fB\-\-vo\-image\-png\-compression=<0\-9>\fP
  9501. PNG compression factor (speed vs. file size tradeoff) (default: 7)
  9502. .TP
  9503. .B \fB\-\-vo\-image\-png\-filter=<0\-5>\fP
  9504. Filter applied prior to PNG compression (0 = none; 1 = sub; 2 = up;
  9505. 3 = average; 4 = Paeth; 5 = mixed) (default: 5)
  9506. .TP
  9507. .B \fB\-\-vo\-image\-jpeg\-quality=<0\-100>\fP
  9508. JPEG quality factor (default: 90)
  9509. .TP
  9510. .B \fB\-\-vo\-image\-jpeg\-optimize=<0\-100>\fP
  9511. JPEG optimization factor (default: 100)
  9512. .TP
  9513. .B \fB\-\-vo\-image\-webp\-lossless=<yes|no>\fP
  9514. Enable writing lossless WebP files (default: no)
  9515. .TP
  9516. .B \fB\-\-vo\-image\-webp\-quality=<0\-100>\fP
  9517. WebP quality (default: 75)
  9518. .TP
  9519. .B \fB\-\-vo\-image\-webp\-compression=<0\-6>\fP
  9520. WebP compression factor (default: 4)
  9521. .TP
  9522. .B \fB\-\-vo\-image\-outdir=<dirname>\fP
  9523. Specify the directory to save the image files to (default: \fB\&./\fP).
  9524. .UNINDENT
  9525. .TP
  9526. .B \fBlibmpv\fP
  9527. For use with libmpv direct embedding. As a special case, on OS X it
  9528. is used like a normal VO within mpv (cocoa\-cb). Otherwise useless in any
  9529. other contexts.
  9530. (See \fB<mpv/render.h>\fP\&.)
  9531. .sp
  9532. This also supports many of the options the \fBgpu\fP VO has, depending on the
  9533. backend.
  9534. .TP
  9535. .B \fBrpi\fP (Raspberry Pi)
  9536. Native video output on the Raspberry Pi using the MMAL API.
  9537. .sp
  9538. This is deprecated. Use \fB\-\-vo=gpu\fP instead, which is the default and
  9539. provides the same functionality. The \fBrpi\fP VO will be removed in
  9540. mpv 0.23.0. Its functionality was folded into \-\-vo=gpu, which now uses
  9541. RPI hardware decoding by treating it as a hardware overlay (without applying
  9542. GL filtering). Also to be changed in 0.23.0: the \-\-fs flag will be reset to
  9543. "no" by default (like on the other platforms).
  9544. .sp
  9545. The following deprecated global options are supported by this video output:
  9546. .INDENT 7.0
  9547. .TP
  9548. .B \fB\-\-rpi\-display=<number>\fP
  9549. Select the display number on which the video overlay should be shown
  9550. (default: 0).
  9551. .TP
  9552. .B \fB\-\-rpi\-layer=<number>\fP
  9553. Select the dispmanx layer on which the video overlay should be shown
  9554. (default: \-10). Note that mpv will also use the 2 layers above the
  9555. selected layer, to handle the window background and OSD. Actual video
  9556. rendering will happen on the layer above the selected layer.
  9557. .TP
  9558. .B \fB\-\-rpi\-background=<yes|no>\fP
  9559. Whether to render a black background behind the video (default: no).
  9560. Normally it\(aqs better to kill the console framebuffer instead, which
  9561. gives better performance.
  9562. .TP
  9563. .B \fB\-\-rpi\-osd=<yes|no>\fP
  9564. Enabled by default. If disabled with \fBno\fP, no OSD layer is created.
  9565. This also means there will be no subtitles rendered.
  9566. .UNINDENT
  9567. .TP
  9568. .B \fBdrm\fP (Direct Rendering Manager)
  9569. Video output driver using Kernel Mode Setting / Direct Rendering Manager.
  9570. Should be used when one doesn\(aqt want to install full\-blown graphical
  9571. environment (e.g. no X). Does not support hardware acceleration (if you
  9572. need this, check the \fBdrm\fP backend for \fBgpu\fP VO).
  9573. .sp
  9574. Since mpv 0.30.0, you may need to use \fB\-\-profile=sw\-fast\fP to get decent
  9575. performance.
  9576. .sp
  9577. The following global options are supported by this video output:
  9578. .INDENT 7.0
  9579. .TP
  9580. .B \fB\-\-drm\-connector=[<gpu_number>.]<name>\fP
  9581. Select the connector to use (usually this is a monitor.) If \fB<name>\fP
  9582. is empty or \fBauto\fP, mpv renders the output on the first available
  9583. connector. Use \fB\-\-drm\-connector=help\fP to get a list of available
  9584. connectors. When using multiple graphic cards, use the \fB<gpu_number>\fP
  9585. argument to disambiguate.
  9586. (default: empty)
  9587. .TP
  9588. .B \fB\-\-drm\-mode=<preferred|highest|N|WxH[@R]>\fP
  9589. Mode to use (resolution and frame rate).
  9590. Possible values:
  9591. .INDENT 7.0
  9592. .TP
  9593. .B preferred
  9594. Use the preferred mode for the screen on the selected
  9595. connector. (default)
  9596. .TP
  9597. .B highest
  9598. Use the mode with the highest resolution available on the
  9599. selected connector.
  9600. .TP
  9601. .B N
  9602. Select mode by index.
  9603. .TP
  9604. .B WxH[@R]
  9605. Specify mode by width, height, and optionally refresh rate.
  9606. In case several modes match, selects the mode that comes
  9607. first in the EDID list of modes.
  9608. .UNINDENT
  9609. .sp
  9610. Use \fB\-\-drm\-mode=help\fP to get a list of available modes for all active
  9611. connectors.
  9612. .TP
  9613. .B \fB\-\-drm\-atomic=<no|auto>\fP
  9614. Toggle use of atomic modesetting. Mostly useful for debugging.
  9615. .INDENT 7.0
  9616. .TP
  9617. .B no
  9618. Use legacy modesetting.
  9619. .TP
  9620. .B auto
  9621. Use atomic modesetting, falling back to legacy modesetting if
  9622. not available. (default)
  9623. .UNINDENT
  9624. .sp
  9625. Note: Only affects \fBgpu\-context=drm\fP\&. \fBvo=drm\fP supports legacy
  9626. modesetting only.
  9627. .TP
  9628. .B \fB\-\-drm\-draw\-plane=<primary|overlay|N>\fP
  9629. Select the DRM plane to which video and OSD is drawn to, under normal
  9630. circumstances. The plane can be specified as \fBprimary\fP, which will
  9631. pick the first applicable primary plane; \fBoverlay\fP, which will pick
  9632. the first applicable overlay plane; or by index. The index is zero
  9633. based, and related to the CRTC.
  9634. (default: primary)
  9635. .sp
  9636. When using this option with the drmprime\-drm hwdec interop, only the OSD
  9637. is rendered to this plane.
  9638. .TP
  9639. .B \fB\-\-drm\-drmprime\-video\-plane=<primary|overlay|N>\fP
  9640. Select the DRM plane to use for video with the drmprime\-drm hwdec
  9641. interop (used by e.g. the rkmpp hwdec on RockChip SoCs, and v4l2 hwdec:s
  9642. on various other SoC:s). The plane is unused otherwise. This option
  9643. accepts the same values as \fB\-\-drm\-draw\-plane\fP\&. (default: overlay)
  9644. .sp
  9645. To be able to successfully play 4K video on various SoCs you might need
  9646. to set \fB\-\-drm\-draw\-plane=overlay \-\-drm\-drmprime\-video\-plane=primary\fP
  9647. and setting \fB\-\-drm\-draw\-surface\-size=1920x1080\fP, to render the OSD at a
  9648. lower resolution (the video when handled by the hwdec will be on the
  9649. drmprime\-video plane and at full 4K resolution)
  9650. .TP
  9651. .B \fB\-\-drm\-format=<xrgb8888|xrgb2101010>\fP
  9652. Select the DRM format to use (default: xrgb8888). This allows you to
  9653. choose the bit depth of the DRM mode. xrgb8888 is your usual 24 bit per
  9654. pixel/8 bits per channel packed RGB format with 8 bits of padding.
  9655. xrgb2101010 is a packed 30 bits per pixel/10 bits per channel packed RGB
  9656. format with 2 bits of padding.
  9657. .sp
  9658. There are cases when xrgb2101010 will work with the \fBdrm\fP VO, but not
  9659. with the \fBdrm\fP backend for the \fBgpu\fP VO. This is because with the
  9660. \fBgpu\fP VO, in addition to requiring support in your DRM driver,
  9661. requires support for xrgb2101010 in your EGL driver
  9662. .TP
  9663. .B \fB\-\-drm\-draw\-surface\-size=<[WxH]>\fP
  9664. Sets the size of the surface used on the draw plane. The surface will
  9665. then be upscaled to the current screen resolution. This option can be
  9666. useful when used together with the drmprime\-drm hwdec interop at high
  9667. resolutions, as it allows scaling the draw plane (which in this case
  9668. only handles the OSD) down to a size the GPU can handle.
  9669. .sp
  9670. When used without the drmprime\-drm hwdec interop this option will just
  9671. cause the video to get rendered at a different resolution and then
  9672. scaled to screen size.
  9673. .sp
  9674. Note: this option is only available with DRM atomic support.
  9675. (default: display resolution)
  9676. .UNINDENT
  9677. .TP
  9678. .B \fBmediacodec_embed\fP (Android)
  9679. Renders \fBIMGFMT_MEDIACODEC\fP frames directly to an \fBandroid.view.Surface\fP\&.
  9680. Requires \fB\-\-hwdec=mediacodec\fP for hardware decoding, along with
  9681. \fB\-\-vo=mediacodec_embed\fP and \fB\-\-wid=(intptr_t)(*android.view.Surface)\fP\&.
  9682. .sp
  9683. Since this video output driver uses native decoding and rendering routines,
  9684. many of mpv\(aqs features (subtitle rendering, OSD/OSC, video filters, etc)
  9685. are not available with this driver.
  9686. .sp
  9687. To use hardware decoding with \fB\-\-vo=gpu\fP instead, use
  9688. \fB\-\-hwdec=mediacodec\-copy\fP along with \fB\-\-gpu\-context=android\fP\&.
  9689. .TP
  9690. .B \fBwlshm\fP (Wayland only)
  9691. Shared memory video output driver without hardware acceleration that works
  9692. whenever Wayland is present.
  9693. .sp
  9694. Since mpv 0.30.0, you may need to use \fB\-\-profile=sw\-fast\fP to get decent
  9695. performance.
  9696. .sp
  9697. \fBNOTE:\fP
  9698. .INDENT 7.0
  9699. .INDENT 3.5
  9700. This is a fallback only, and should not be normally used.
  9701. .UNINDENT
  9702. .UNINDENT
  9703. .UNINDENT
  9704. .SH AUDIO FILTERS
  9705. .sp
  9706. Audio filters allow you to modify the audio stream and its properties. The
  9707. syntax is:
  9708. .INDENT 0.0
  9709. .TP
  9710. .B \fB\-\-af=...\fP
  9711. Setup a chain of audio filters. See \fB\-\-vf\fP (\fI\%VIDEO FILTERS\fP) for the
  9712. full syntax.
  9713. .UNINDENT
  9714. .sp
  9715. \fBNOTE:\fP
  9716. .INDENT 0.0
  9717. .INDENT 3.5
  9718. To get a full list of available audio filters, see \fB\-\-af=help\fP\&.
  9719. .sp
  9720. Also, keep in mind that most actual filters are available via the \fBlavfi\fP
  9721. wrapper, which gives you access to most of libavfilter\(aqs filters. This
  9722. includes all filters that have been ported from MPlayer to libavfilter.
  9723. .sp
  9724. The \fB\-\-vf\fP description describes how libavfilter can be used and how to
  9725. workaround deprecated mpv filters.
  9726. .UNINDENT
  9727. .UNINDENT
  9728. .sp
  9729. See \fB\-\-vf\fP group of options for info on how \fB\-\-af\-defaults\fP, \fB\-\-af\-add\fP,
  9730. \fB\-\-af\-pre\fP, \fB\-\-af\-del\fP, \fB\-\-af\-clr\fP, and possibly others work.
  9731. .sp
  9732. Available filters are:
  9733. .INDENT 0.0
  9734. .TP
  9735. .B \fBlavcac3enc[=options]\fP
  9736. Encode multi\-channel audio to AC\-3 at runtime using libavcodec. Supports
  9737. 16\-bit native\-endian input format, maximum 6 channels. The output is
  9738. big\-endian when outputting a raw AC\-3 stream, native\-endian when
  9739. outputting to S/PDIF. If the input sample rate is not 48 kHz, 44.1 kHz or
  9740. 32 kHz, it will be resampled to 48 kHz.
  9741. .INDENT 7.0
  9742. .TP
  9743. .B \fBtospdif=<yes|no>\fP
  9744. Output raw AC\-3 stream if \fBno\fP, output to S/PDIF for
  9745. pass\-through if \fByes\fP (default).
  9746. .TP
  9747. .B \fBbitrate=<rate>\fP
  9748. The bitrate use for the AC\-3 stream. Set it to 384 to get 384 kbps.
  9749. .sp
  9750. The default is 640. Some receivers might not be able to handle this.
  9751. .sp
  9752. Valid values: 32, 40, 48, 56, 64, 80, 96, 112, 128,
  9753. 160, 192, 224, 256, 320, 384, 448, 512, 576, 640.
  9754. .sp
  9755. The special value \fBauto\fP selects a default bitrate based on the
  9756. input channel number:
  9757. .INDENT 7.0
  9758. .TP
  9759. .B 1ch
  9760. 96
  9761. .TP
  9762. .B 2ch
  9763. 192
  9764. .TP
  9765. .B 3ch
  9766. 224
  9767. .TP
  9768. .B 4ch
  9769. 384
  9770. .TP
  9771. .B 5ch
  9772. 448
  9773. .TP
  9774. .B 6ch
  9775. 448
  9776. .UNINDENT
  9777. .TP
  9778. .B \fBminch=<n>\fP
  9779. If the input channel number is less than \fB<minch>\fP, the filter will
  9780. detach itself (default: 3).
  9781. .TP
  9782. .B \fBencoder=<name>\fP
  9783. Select the libavcodec encoder used. Currently, this should be an AC\-3
  9784. encoder, and using another codec will fail horribly.
  9785. .UNINDENT
  9786. .TP
  9787. .B \fBformat=format:srate:channels:out\-srate:out\-channels\fP
  9788. Does not do any format conversion itself. Rather, it may cause the
  9789. filter system to insert necessary conversion filters before or after this
  9790. filter if needed. It is primarily useful for controlling the audio format
  9791. going into other filters. To specify the format for audio output, see
  9792. \fB\-\-audio\-format\fP, \fB\-\-audio\-samplerate\fP, and \fB\-\-audio\-channels\fP\&. This
  9793. filter is able to force a particular format, whereas \fB\-\-audio\-*\fP
  9794. may be overridden by the ao based on output compatibility.
  9795. .sp
  9796. All parameters are optional. The first 3 parameters restrict what the filter
  9797. accepts as input. They will therefore cause conversion filters to be
  9798. inserted before this one.  The \fBout\-\fP parameters tell the filters or audio
  9799. outputs following this filter how to interpret the data without actually
  9800. doing a conversion. Setting these will probably just break things unless you
  9801. really know you want this for some reason, such as testing or dealing with
  9802. broken media.
  9803. .INDENT 7.0
  9804. .TP
  9805. .B \fB<format>\fP
  9806. Force conversion to this format. Use \fB\-\-af=format=format=help\fP to get
  9807. a list of valid formats.
  9808. .TP
  9809. .B \fB<srate>\fP
  9810. Force conversion to a specific sample rate. The rate is an integer,
  9811. 48000 for example.
  9812. .TP
  9813. .B \fB<channels>\fP
  9814. Force mixing to a specific channel layout. See \fB\-\-audio\-channels\fP option
  9815. for possible values.
  9816. .UNINDENT
  9817. .sp
  9818. \fB<out\-srate>\fP
  9819. .sp
  9820. \fB<out\-channels>\fP
  9821. .sp
  9822. \fINOTE\fP: this filter used to be named \fBforce\fP\&. The old \fBformat\fP filter
  9823. used to do conversion itself, unlike this one which lets the filter system
  9824. handle the conversion.
  9825. .TP
  9826. .B \fBscaletempo[=option1:option2:...]\fP
  9827. Scales audio tempo without altering pitch, optionally synced to playback
  9828. speed (default).
  9829. .sp
  9830. This works by playing \(aqstride\(aq ms of audio at normal speed then consuming
  9831. \(aqstride*scale\(aq ms of input audio. It pieces the strides together by
  9832. blending \(aqoverlap\(aq% of stride with audio following the previous stride. It
  9833. optionally performs a short statistical analysis on the next \(aqsearch\(aq ms
  9834. of audio to determine the best overlap position.
  9835. .INDENT 7.0
  9836. .TP
  9837. .B \fBscale=<amount>\fP
  9838. Nominal amount to scale tempo. Scales this amount in addition to
  9839. speed. (default: 1.0)
  9840. .TP
  9841. .B \fBstride=<amount>\fP
  9842. Length in milliseconds to output each stride. Too high of a value will
  9843. cause noticeable skips at high scale amounts and an echo at low scale
  9844. amounts. Very low values will alter pitch. Increasing improves
  9845. performance. (default: 60)
  9846. .TP
  9847. .B \fBoverlap=<percent>\fP
  9848. Percentage of stride to overlap. Decreasing improves performance.
  9849. (default: .20)
  9850. .TP
  9851. .B \fBsearch=<amount>\fP
  9852. Length in milliseconds to search for best overlap position. Decreasing
  9853. improves performance greatly. On slow systems, you will probably want
  9854. to set this very low. (default: 14)
  9855. .TP
  9856. .B \fBspeed=<tempo|pitch|both|none>\fP
  9857. Set response to speed change.
  9858. .INDENT 7.0
  9859. .TP
  9860. .B tempo
  9861. Scale tempo in sync with speed (default).
  9862. .TP
  9863. .B pitch
  9864. Reverses effect of filter. Scales pitch without altering tempo.
  9865. Add this to your \fBinput.conf\fP to step by musical semi\-tones:
  9866. .INDENT 7.0
  9867. .INDENT 3.5
  9868. .sp
  9869. .nf
  9870. .ft C
  9871. [ multiply speed 0.9438743126816935
  9872. ] multiply speed 1.059463094352953
  9873. .ft P
  9874. .fi
  9875. .UNINDENT
  9876. .UNINDENT
  9877. .sp
  9878. \fBWARNING:\fP
  9879. .INDENT 7.0
  9880. .INDENT 3.5
  9881. Loses sync with video.
  9882. .UNINDENT
  9883. .UNINDENT
  9884. .TP
  9885. .B both
  9886. Scale both tempo and pitch.
  9887. .TP
  9888. .B none
  9889. Ignore speed changes.
  9890. .UNINDENT
  9891. .UNINDENT
  9892. .INDENT 7.0
  9893. .INDENT 3.5
  9894. .IP "Examples"
  9895. .INDENT 0.0
  9896. .TP
  9897. .B \fBmpv \-\-af=scaletempo \-\-speed=1.2 media.ogg\fP
  9898. Would play media at 1.2x normal speed, with audio at normal
  9899. pitch. Changing playback speed would change audio tempo to match.
  9900. .TP
  9901. .B \fBmpv \-\-af=scaletempo=scale=1.2:speed=none \-\-speed=1.2 media.ogg\fP
  9902. Would play media at 1.2x normal speed, with audio at normal
  9903. pitch, but changing playback speed would have no effect on audio
  9904. tempo.
  9905. .TP
  9906. .B \fBmpv \-\-af=scaletempo=stride=30:overlap=.50:search=10 media.ogg\fP
  9907. Would tweak the quality and performance parameters.
  9908. .TP
  9909. .B \fBmpv \-\-af=scaletempo=scale=1.2:speed=pitch audio.ogg\fP
  9910. Would play media at 1.2x normal speed, with audio at normal pitch.
  9911. Changing playback speed would change pitch, leaving audio tempo at
  9912. 1.2x.
  9913. .UNINDENT
  9914. .UNINDENT
  9915. .UNINDENT
  9916. .TP
  9917. .B \fBrubberband\fP
  9918. High quality pitch correction with librubberband. This can be used in place
  9919. of \fBscaletempo\fP, and will be used to adjust audio pitch when playing
  9920. at speed different from normal. It can also be used to adjust audio pitch
  9921. without changing playback speed.
  9922. .INDENT 7.0
  9923. .TP
  9924. .B \fB<pitch\-scale>\fP
  9925. Sets the pitch scaling factor. Frequencies are multiplied by this value.
  9926. .UNINDENT
  9927. .sp
  9928. This filter has a number of additional sub\-options. You can list them with
  9929. \fBmpv \-\-af=rubberband=help\fP\&. This will also show the default values
  9930. for each option. The options are not documented here, because they are
  9931. merely passed to librubberband. Look at the librubberband documentation
  9932. to learn what each option does:
  9933. \fI\%http://breakfastquay.com/rubberband/code\-doc/classRubberBand_1_1RubberBandStretcher.html\fP
  9934. (The mapping of the mpv rubberband filter sub\-option names and values to
  9935. those of librubberband follows a simple pattern: \fB"Option" + Name + Value\fP\&.)
  9936. .sp
  9937. This filter supports the following \fBaf\-command\fP commands:
  9938. .INDENT 7.0
  9939. .TP
  9940. .B \fBset\-pitch\fP
  9941. Set the \fB<pitch\-scale>\fP argument dynamically. This can be used to
  9942. change the playback pitch at runtime. Note that speed is controlled
  9943. using the standard \fBspeed\fP property, not \fBaf\-command\fP\&.
  9944. .TP
  9945. .B \fBmultiply\-pitch <factor>\fP
  9946. Multiply the current value of \fB<pitch\-scale>\fP dynamically.  For
  9947. example: 0.5 to go down by an octave, 1.5 to go up by a perfect fifth.
  9948. If you want to go up or down by semi\-tones, use 1.059463094352953 and
  9949. 0.9438743126816935
  9950. .UNINDENT
  9951. .TP
  9952. .B \fBlavfi=graph\fP
  9953. Filter audio using FFmpeg\(aqs libavfilter.
  9954. .INDENT 7.0
  9955. .TP
  9956. .B \fB<graph>\fP
  9957. Libavfilter graph. See \fBlavfi\fP video filter for details \- the graph
  9958. syntax is the same.
  9959. .sp
  9960. \fBWARNING:\fP
  9961. .INDENT 7.0
  9962. .INDENT 3.5
  9963. Don\(aqt forget to quote libavfilter graphs as described in the lavfi
  9964. video filter section.
  9965. .UNINDENT
  9966. .UNINDENT
  9967. .TP
  9968. .B \fBo=<string>\fP
  9969. AVOptions.
  9970. .TP
  9971. .B \fBfix\-pts=<yes|no>\fP
  9972. Determine PTS based on sample count (default: no). If this is enabled,
  9973. the player won\(aqt rely on libavfilter passing through PTS accurately.
  9974. Instead, it pass a sample count as PTS to libavfilter, and compute the
  9975. PTS used by mpv based on that and the input PTS. This helps with filters
  9976. which output a recomputed PTS instead of the original PTS (including
  9977. filters which require the PTS to start at 0). mpv normally expects
  9978. filters to not touch the PTS (or only to the extent of changing frame
  9979. boundaries), so this is not the default, but it will be needed to use
  9980. broken filters. In practice, these broken filters will either cause slow
  9981. A/V desync over time (with some files), or break playback completely if
  9982. you seek or start playback from the middle of a file.
  9983. .UNINDENT
  9984. .UNINDENT
  9985. .SH VIDEO FILTERS
  9986. .sp
  9987. Video filters allow you to modify the video stream and its properties. All of
  9988. the information described in this section applies to audio filters as well
  9989. (generally using the prefix \fB\-\-af\fP instead of \fB\-\-vf\fP).
  9990. .sp
  9991. The exact syntax is:
  9992. .INDENT 0.0
  9993. .TP
  9994. .B \fB\-\-vf=<filter1[=parameter1:parameter2:...],filter2,...>\fP
  9995. Setup a chain of video filters. This consists on the filter name, and an
  9996. option list of parameters after \fB=\fP\&. The parameters are separated by
  9997. \fB:\fP (not \fB,\fP, as that starts a new filter entry).
  9998. .sp
  9999. Before the filter name, a label can be specified with \fB@name:\fP, where
  10000. name is an arbitrary user\-given name, which identifies the filter. This
  10001. is only needed if you want to toggle the filter at runtime.
  10002. .sp
  10003. A \fB!\fP before the filter name means the filter is disabled by default. It
  10004. will be skipped on filter creation. This is also useful for runtime filter
  10005. toggling.
  10006. .sp
  10007. See the \fBvf\fP command (and \fBtoggle\fP sub\-command) for further explanations
  10008. and examples.
  10009. .sp
  10010. The general filter entry syntax is:
  10011. .INDENT 7.0
  10012. .INDENT 3.5
  10013. \fB["@"<label\-name>":"] ["!"] <filter\-name> [ "=" <filter\-parameter\-list> ]\fP
  10014. .UNINDENT
  10015. .UNINDENT
  10016. .sp
  10017. or for the special "toggle" syntax (see \fBvf\fP command):
  10018. .INDENT 7.0
  10019. .INDENT 3.5
  10020. \fB"@"<label\-name>\fP
  10021. .UNINDENT
  10022. .UNINDENT
  10023. .sp
  10024. and the \fBfilter\-parameter\-list\fP:
  10025. .INDENT 7.0
  10026. .INDENT 3.5
  10027. \fB<filter\-parameter> | <filter\-parameter> "," <filter\-parameter\-list>\fP
  10028. .UNINDENT
  10029. .UNINDENT
  10030. .sp
  10031. and \fBfilter\-parameter\fP:
  10032. .INDENT 7.0
  10033. .INDENT 3.5
  10034. \fB( <param\-name> "=" <param\-value> ) | <param\-value>\fP
  10035. .UNINDENT
  10036. .UNINDENT
  10037. .sp
  10038. \fBparam\-value\fP can further be quoted in \fB[\fP / \fB]\fP in case the value
  10039. contains characters like \fB,\fP or \fB=\fP\&. This is used in particular with
  10040. the \fBlavfi\fP filter, which uses a very similar syntax as mpv (MPlayer
  10041. historically) to specify filters and their parameters.
  10042. .UNINDENT
  10043. .sp
  10044. Filters can be manipulated at run time. You can use \fB@\fP labels as described
  10045. above in combination with the \fBvf\fP command (see \fI\%COMMAND INTERFACE\fP) to get
  10046. more control over this. Initially disabled filters with \fB!\fP are useful for
  10047. this as well.
  10048. .sp
  10049. You can also set defaults for each filter. The defaults are applied before the
  10050. normal filter parameters. This is deprecated and never worked for the
  10051. libavfilter bridge.
  10052. .INDENT 0.0
  10053. .TP
  10054. .B \fB\-\-vf\-defaults=<filter1[=parameter1:parameter2:...],filter2,...>\fP
  10055. Set defaults for each filter. (Deprecated. \fB\-\-af\-defaults\fP is deprecated
  10056. as well.)
  10057. .UNINDENT
  10058. .sp
  10059. \fBNOTE:\fP
  10060. .INDENT 0.0
  10061. .INDENT 3.5
  10062. To get a full list of available video filters, see \fB\-\-vf=help\fP and
  10063. \fI\%http://ffmpeg.org/ffmpeg\-filters.html\fP .
  10064. .sp
  10065. Also, keep in mind that most actual filters are available via the \fBlavfi\fP
  10066. wrapper, which gives you access to most of libavfilter\(aqs filters. This
  10067. includes all filters that have been ported from MPlayer to libavfilter.
  10068. .sp
  10069. Most builtin filters are deprecated in some ways, unless they\(aqre only available
  10070. in mpv (such as filters which deal with mpv specifics, or which are
  10071. implemented in mpv only).
  10072. .sp
  10073. If a filter is not builtin, the \fBlavfi\-bridge\fP will be automatically
  10074. tried. This bridge does not support help output, and does not verify
  10075. parameters before the filter is actually used. Although the mpv syntax
  10076. is rather similar to libavfilter\(aqs, it\(aqs not the same. (Which means not
  10077. everything accepted by vf_lavfi\(aqs \fBgraph\fP option will be accepted by
  10078. \fB\-\-vf\fP\&.)
  10079. .sp
  10080. You can also prefix the filter name with \fBlavfi\-\fP to force the wrapper.
  10081. This is helpful if the filter name collides with a deprecated mpv builtin
  10082. filter. For example \fB\-\-vf=lavfi\-scale=args\fP would use libavfilter\(aqs
  10083. \fBscale\fP filter over mpv\(aqs deprecated builtin one.
  10084. .UNINDENT
  10085. .UNINDENT
  10086. .sp
  10087. Video filters are managed in lists. There are a few commands to manage the
  10088. filter list.
  10089. .INDENT 0.0
  10090. .TP
  10091. .B \fB\-\-vf\-append=filter\fP
  10092. Appends the filter given as arguments to the filter list.
  10093. .TP
  10094. .B \fB\-\-vf\-add=filter\fP
  10095. Appends the filter given as arguments to the filter list. (Passing multiple
  10096. filters is currently still possible, but deprecated.)
  10097. .TP
  10098. .B \fB\-\-vf\-pre=filter\fP
  10099. Prepends the filters given as arguments to the filter list. (Passing
  10100. multiple filters is currently still possible, but deprecated.)
  10101. .TP
  10102. .B \fB\-\-vf\-remove=filter\fP
  10103. Deletes the filter from the list. The filter can be either given the way it
  10104. was added (filter name and its full argument list), or by label (prefixed
  10105. with \fB@\fP). Matching of filters works as follows: if either of the compared
  10106. filters has a label set, only the labels are compared. If none of the
  10107. filters have a label, the filter name, arguments, and argument order are
  10108. compared. (Passing multiple filters is currently still possible, but
  10109. deprecated.)
  10110. .TP
  10111. .B \fB\-vf\-toggle=filter\fP
  10112. Add the given filter to the list if it was not present yet, or remove it
  10113. from the list if it was present. Matching of filters works as described in
  10114. \fB\-\-vf\-remove\fP\&.
  10115. .TP
  10116. .B \fB\-\-vf\-del=filter\fP
  10117. Sort of like \fB\-\-vf\-remove\fP, but also accepts an index number. Index
  10118. numbers start at 0, negative numbers address the end of the list (\-1 is the
  10119. last). Deprecated.
  10120. .TP
  10121. .B \fB\-\-vf\-clr\fP
  10122. Completely empties the filter list.
  10123. .UNINDENT
  10124. .sp
  10125. With filters that support it, you can access parameters by their name.
  10126. .INDENT 0.0
  10127. .TP
  10128. .B \fB\-\-vf=<filter>=help\fP
  10129. Prints the parameter names and parameter value ranges for a particular
  10130. filter.
  10131. .UNINDENT
  10132. .sp
  10133. Available mpv\-only filters are:
  10134. .INDENT 0.0
  10135. .TP
  10136. .B \fBformat=fmt=<value>:colormatrix=<value>:...\fP
  10137. Applies video parameter overrides, with optional conversion. By default,
  10138. this overrides the video\(aqs parameters without conversion (except for the
  10139. \fBfmt\fP parameter), but can be made to perform an appropriate conversion
  10140. with \fBconvert=yes\fP for parameters for which conversion is supported.
  10141. .INDENT 7.0
  10142. .TP
  10143. .B \fB<fmt>\fP
  10144. Image format name, e.g. rgb15, bgr24, 420p, etc. (default: don\(aqt change).
  10145. .sp
  10146. This filter always performs conversion to the given format.
  10147. .sp
  10148. \fBNOTE:\fP
  10149. .INDENT 7.0
  10150. .INDENT 3.5
  10151. For a list of available formats, use \fB\-\-vf=format=fmt=help\fP\&.
  10152. .UNINDENT
  10153. .UNINDENT
  10154. .TP
  10155. .B \fB<convert=yes|no>\fP
  10156. Force conversion of color parameters (default: no).
  10157. .sp
  10158. If this is disabled (the default), the only conversion that is possibly
  10159. performed is format conversion if \fB<fmt>\fP is set. All other parameters
  10160. (like \fB<colormatrix>\fP) are forced without conversion. This mode is
  10161. typically useful when files have been incorrectly tagged.
  10162. .sp
  10163. If this is enabled, libswscale or zimg is used if any of the parameters
  10164. mismatch. zimg is used of the input/output image formats are supported
  10165. by mpv\(aqs zimg wrapper, and if \fB\-\-sws\-allow\-zimg=yes\fP is used. Both
  10166. libraries may not support all kinds of conversions. This typically
  10167. results in silent incorrect conversion. zimg has in many cases a better
  10168. chance of performing the conversion correctly.
  10169. .sp
  10170. In both cases, the color parameters are set on the output stage of the
  10171. image format conversion (if \fBfmt\fP was set). The difference is that
  10172. with \fBconvert=no\fP, the color parameters are not passed on to the
  10173. converter.
  10174. .sp
  10175. If input and output video parameters are the same, conversion is always
  10176. skipped.
  10177. .INDENT 7.0
  10178. .INDENT 3.5
  10179. .IP "Examples"
  10180. .INDENT 0.0
  10181. .TP
  10182. .B \fBmpv test.mkv \-\-vf=format:colormatrix=ycgco\fP
  10183. Results in incorrect colors (if test.mkv was tagged correctly).
  10184. .TP
  10185. .B \fBmpv test.mkv \-\-vf=format:colormatrix=ycgco:convert=yes \-\-sws\-allow\-zimg\fP
  10186. Results in true conversion to \fBycgco\fP, assuming the renderer
  10187. supports it (\fB\-\-vo=gpu\fP normally does). You can add \fB\-\-vo=xv\fP
  10188. to force a VO which definitely does not support it, which should
  10189. show incorrect colors as confirmation.
  10190. .sp
  10191. Using \fB\-\-sws\-allow\-zimg=no\fP (or disabling zimg at build time)
  10192. will use libswscale, which cannot perform this conversion as
  10193. of this writing.
  10194. .UNINDENT
  10195. .UNINDENT
  10196. .UNINDENT
  10197. .TP
  10198. .B \fB<colormatrix>\fP
  10199. Controls the YUV to RGB color space conversion when playing video. There
  10200. are various standards. Normally, BT.601 should be used for SD video, and
  10201. BT.709 for HD video. (This is done by default.) Using incorrect color space
  10202. results in slightly under or over saturated and shifted colors.
  10203. .sp
  10204. These options are not always supported. Different video outputs provide
  10205. varying degrees of support. The \fBgpu\fP and \fBvdpau\fP video output
  10206. drivers usually offer full support. The \fBxv\fP output can set the color
  10207. space if the system video driver supports it, but not input and output
  10208. levels. The \fBscale\fP video filter can configure color space and input
  10209. levels, but only if the output format is RGB (if the video output driver
  10210. supports RGB output, you can force this with \fB\-vf scale,format=rgba\fP).
  10211. .sp
  10212. If this option is set to \fBauto\fP (which is the default), the video\(aqs
  10213. color space flag will be used. If that flag is unset, the color space
  10214. will be selected automatically. This is done using a simple heuristic that
  10215. attempts to distinguish SD and HD video. If the video is larger than
  10216. 1279x576 pixels, BT.709 (HD) will be used; otherwise BT.601 (SD) is
  10217. selected.
  10218. .sp
  10219. Available color spaces are:
  10220. .INDENT 7.0
  10221. .TP
  10222. .B auto
  10223. automatic selection (default)
  10224. .TP
  10225. .B bt.601
  10226. ITU\-R BT.601 (SD)
  10227. .TP
  10228. .B bt.709
  10229. ITU\-R BT.709 (HD)
  10230. .TP
  10231. .B bt.2020\-ncl
  10232. ITU\-R BT.2020 non\-constant luminance system
  10233. .TP
  10234. .B bt.2020\-cl
  10235. ITU\-R BT.2020 constant luminance system
  10236. .TP
  10237. .B smpte\-240m
  10238. SMPTE\-240M
  10239. .UNINDENT
  10240. .TP
  10241. .B \fB<colorlevels>\fP
  10242. YUV color levels used with YUV to RGB conversion. This option is only
  10243. necessary when playing broken files which do not follow standard color
  10244. levels or which are flagged wrong. If the video does not specify its
  10245. color range, it is assumed to be limited range.
  10246. .sp
  10247. The same limitations as with \fB<colormatrix>\fP apply.
  10248. .sp
  10249. Available color ranges are:
  10250. .INDENT 7.0
  10251. .TP
  10252. .B auto
  10253. automatic selection (normally limited range) (default)
  10254. .TP
  10255. .B limited
  10256. limited range (16\-235 for luma, 16\-240 for chroma)
  10257. .TP
  10258. .B full
  10259. full range (0\-255 for both luma and chroma)
  10260. .UNINDENT
  10261. .TP
  10262. .B \fB<primaries>\fP
  10263. RGB primaries the source file was encoded with. Normally this should be set
  10264. in the file header, but when playing broken or mistagged files this can be
  10265. used to override the setting.
  10266. .sp
  10267. This option only affects video output drivers that perform color
  10268. management, for example \fBgpu\fP with the \fBtarget\-prim\fP or
  10269. \fBicc\-profile\fP suboptions set.
  10270. .sp
  10271. If this option is set to \fBauto\fP (which is the default), the video\(aqs
  10272. primaries flag will be used. If that flag is unset, the color space will
  10273. be selected automatically, using the following heuristics: If the
  10274. \fB<colormatrix>\fP is set or determined as BT.2020 or BT.709, the
  10275. corresponding primaries are used. Otherwise, if the video height is
  10276. exactly 576 (PAL), BT.601\-625 is used. If it\(aqs exactly 480 or 486 (NTSC),
  10277. BT.601\-525 is used. If the video resolution is anything else, BT.709 is
  10278. used.
  10279. .sp
  10280. Available primaries are:
  10281. .INDENT 7.0
  10282. .TP
  10283. .B auto
  10284. automatic selection (default)
  10285. .TP
  10286. .B bt.601\-525
  10287. ITU\-R BT.601 (SD) 525\-line systems (NTSC, SMPTE\-C)
  10288. .TP
  10289. .B bt.601\-625
  10290. ITU\-R BT.601 (SD) 625\-line systems (PAL, SECAM)
  10291. .TP
  10292. .B bt.709
  10293. ITU\-R BT.709 (HD) (same primaries as sRGB)
  10294. .TP
  10295. .B bt.2020
  10296. ITU\-R BT.2020 (UHD)
  10297. .TP
  10298. .B apple
  10299. Apple RGB
  10300. .TP
  10301. .B adobe
  10302. Adobe RGB (1998)
  10303. .TP
  10304. .B prophoto
  10305. ProPhoto RGB (ROMM)
  10306. .TP
  10307. .B cie1931
  10308. CIE 1931 RGB
  10309. .TP
  10310. .B dci\-p3
  10311. DCI\-P3 (Digital Cinema)
  10312. .TP
  10313. .B v\-gamut
  10314. Panasonic V\-Gamut primaries
  10315. .UNINDENT
  10316. .TP
  10317. .B \fB<gamma>\fP
  10318. Gamma function the source file was encoded with. Normally this should be set
  10319. in the file header, but when playing broken or mistagged files this can be
  10320. used to override the setting.
  10321. .sp
  10322. This option only affects video output drivers that perform color management.
  10323. .sp
  10324. If this option is set to \fBauto\fP (which is the default), the gamma will
  10325. be set to BT.1886 for YCbCr content, sRGB for RGB content and Linear for
  10326. XYZ content.
  10327. .sp
  10328. Available gamma functions are:
  10329. .INDENT 7.0
  10330. .TP
  10331. .B auto
  10332. automatic selection (default)
  10333. .TP
  10334. .B bt.1886
  10335. ITU\-R BT.1886 (EOTF corresponding to BT.601/BT.709/BT.2020)
  10336. .TP
  10337. .B srgb
  10338. IEC 61966\-2\-4 (sRGB)
  10339. .TP
  10340. .B linear
  10341. Linear light
  10342. .TP
  10343. .B gamma1.8
  10344. Pure power curve (gamma 1.8)
  10345. .TP
  10346. .B gamma2.0
  10347. Pure power curve (gamma 2.0)
  10348. .TP
  10349. .B gamma2.2
  10350. Pure power curve (gamma 2.2)
  10351. .TP
  10352. .B gamma2.4
  10353. Pure power curve (gamma 2.4)
  10354. .TP
  10355. .B gamma2.6
  10356. Pure power curve (gamma 2.6)
  10357. .TP
  10358. .B gamma2.8
  10359. Pure power curve (gamma 2.8)
  10360. .TP
  10361. .B prophoto
  10362. ProPhoto RGB (ROMM) curve
  10363. .TP
  10364. .B pq
  10365. ITU\-R BT.2100 PQ (Perceptual quantizer) curve
  10366. .TP
  10367. .B hlg
  10368. ITU\-R BT.2100 HLG (Hybrid Log\-gamma) curve
  10369. .TP
  10370. .B v\-log
  10371. Panasonic V\-Log transfer curve
  10372. .TP
  10373. .B s\-log1
  10374. Sony S\-Log1 transfer curve
  10375. .TP
  10376. .B s\-log2
  10377. Sony S\-Log2 transfer curve
  10378. .UNINDENT
  10379. .TP
  10380. .B \fB<sig\-peak>\fP
  10381. Reference peak illumination for the video file, relative to the
  10382. signal\(aqs reference white level. This is mostly interesting for HDR, but
  10383. it can also be used tone map SDR content to simulate a different
  10384. exposure. Normally inferred from tags such as MaxCLL or mastering
  10385. metadata.
  10386. .sp
  10387. The default of 0.0 will default to the source\(aqs nominal peak luminance.
  10388. .TP
  10389. .B \fB<light>\fP
  10390. .INDENT 7.0
  10391. .INDENT 3.5
  10392. Light type of the scene. This is mostly correctly inferred based on the
  10393. gamma function, but it can be useful to override this when viewing raw
  10394. camera footage (e.g. V\-Log), which is normally scene\-referred instead
  10395. of display\-referred.
  10396. .sp
  10397. Available light types are:
  10398. .UNINDENT
  10399. .UNINDENT
  10400. .INDENT 7.0
  10401. .TP
  10402. .B auto
  10403. Automatic selection (default)
  10404. .TP
  10405. .B display
  10406. Display\-referred light (most content)
  10407. .TP
  10408. .B hlg
  10409. Scene\-referred using the HLG OOTF (e.g. HLG content)
  10410. .TP
  10411. .B 709\-1886
  10412. Scene\-referred using the BT709+BT1886 interaction
  10413. .TP
  10414. .B gamma1.2
  10415. Scene\-referred using a pure power OOTF (gamma=1.2)
  10416. .UNINDENT
  10417. .TP
  10418. .B \fB<stereo\-in>\fP
  10419. Set the stereo mode the video is assumed to be encoded in. Use
  10420. \fB\-\-vf format:stereo\-in=help\fP to list all available modes. Check with
  10421. the \fBstereo3d\fP filter documentation to see what the names mean.
  10422. .TP
  10423. .B \fB<stereo\-out>\fP
  10424. Set the stereo mode the video should be displayed as. Takes the
  10425. same values as the \fBstereo\-in\fP option.
  10426. .TP
  10427. .B \fB<rotate>\fP
  10428. Set the rotation the video is assumed to be encoded with in degrees.
  10429. The special value \fB\-1\fP uses the input format.
  10430. .TP
  10431. .B \fB<dw>\fP, \fB<dh>\fP
  10432. Set the display size. Note that setting the display size such that
  10433. the video is scaled in both directions instead of just changing the
  10434. aspect ratio is an implementation detail, and might change later.
  10435. .TP
  10436. .B \fB<dar>\fP
  10437. Set the display aspect ratio of the video frame. This is a float,
  10438. but values such as \fB[16:9]\fP can be passed too (\fB[...]\fP for quoting
  10439. to prevent the option parser from interpreting the \fB:\fP character).
  10440. .UNINDENT
  10441. .TP
  10442. .B \fBlavfi=graph[:sws\-flags[:o=opts]]\fP
  10443. Filter video using FFmpeg\(aqs libavfilter.
  10444. .INDENT 7.0
  10445. .TP
  10446. .B \fB<graph>\fP
  10447. The libavfilter graph string. The filter must have a single video input
  10448. pad and a single video output pad.
  10449. .sp
  10450. See \fI\%https://ffmpeg.org/ffmpeg\-filters.html\fP for syntax and available
  10451. filters.
  10452. .sp
  10453. \fBWARNING:\fP
  10454. .INDENT 7.0
  10455. .INDENT 3.5
  10456. If you want to use the full filter syntax with this option, you have
  10457. to quote the filter graph in order to prevent mpv\(aqs syntax and the
  10458. filter graph syntax from clashing. To prevent a quoting and escaping
  10459. mess, consider using \fB\-\-lavfi\-complex\fP if you know which video
  10460. track you want to use from the input file. (There is only one video
  10461. track for nearly all video files anyway.)
  10462. .UNINDENT
  10463. .UNINDENT
  10464. .INDENT 7.0
  10465. .INDENT 3.5
  10466. .IP "Examples"
  10467. .INDENT 0.0
  10468. .TP
  10469. .B \fB\-\-vf=lavfi=[gradfun=20:30,vflip]\fP
  10470. \fBgradfun\fP filter with nonsense parameters, followed by a
  10471. \fBvflip\fP filter. (This demonstrates how libavfilter takes a
  10472. graph and not just a single filter.) The filter graph string is
  10473. quoted with \fB[\fP and \fB]\fP\&. This requires no additional quoting
  10474. or escaping with some shells (like bash), while others (like
  10475. zsh) require additional \fB"\fP quotes around the option string.
  10476. .TP
  10477. .B \fB\(aq\-\-vf=lavfi="gradfun=20:30,vflip"\(aq\fP
  10478. Same as before, but uses quoting that should be safe with all
  10479. shells. The outer \fB\(aq\fP quotes make sure that the shell does not
  10480. remove the \fB"\fP quotes needed by mpv.
  10481. .TP
  10482. .B \fB\(aq\-\-vf=lavfi=graph="gradfun=radius=30:strength=20,vflip"\(aq\fP
  10483. Same as before, but uses named parameters for everything.
  10484. .UNINDENT
  10485. .UNINDENT
  10486. .UNINDENT
  10487. .TP
  10488. .B \fB<sws\-flags>\fP
  10489. If libavfilter inserts filters for pixel format conversion, this
  10490. option gives the flags which should be passed to libswscale. This
  10491. option is numeric and takes a bit\-wise combination of \fBSWS_\fP flags.
  10492. .sp
  10493. See \fBhttp://git.videolan.org/?p=ffmpeg.git;a=blob;f=libswscale/swscale.h\fP\&.
  10494. .TP
  10495. .B \fB<o>\fP
  10496. Set AVFilterGraph options. These should be documented by FFmpeg.
  10497. .INDENT 7.0
  10498. .INDENT 3.5
  10499. .IP "Example"
  10500. .INDENT 0.0
  10501. .TP
  10502. .B \fB\(aq\-\-vf=lavfi=yadif:o="threads=2,thread_type=slice"\(aq\fP
  10503. forces a specific threading configuration.
  10504. .UNINDENT
  10505. .UNINDENT
  10506. .UNINDENT
  10507. .UNINDENT
  10508. .TP
  10509. .B \fBsub=[=bottom\-margin:top\-margin]\fP
  10510. Moves subtitle rendering to an arbitrary point in the filter chain, or force
  10511. subtitle rendering in the video filter as opposed to using video output OSD
  10512. support.
  10513. .INDENT 7.0
  10514. .TP
  10515. .B \fB<bottom\-margin>\fP
  10516. Adds a black band at the bottom of the frame. The SSA/ASS renderer can
  10517. place subtitles there (with \fB\-\-sub\-use\-margins\fP).
  10518. .TP
  10519. .B \fB<top\-margin>\fP
  10520. Black band on the top for toptitles  (with \fB\-\-sub\-use\-margins\fP).
  10521. .UNINDENT
  10522. .INDENT 7.0
  10523. .INDENT 3.5
  10524. .IP "Examples"
  10525. .INDENT 0.0
  10526. .TP
  10527. .B \fB\-\-vf=sub,eq\fP
  10528. Moves sub rendering before the eq filter. This will put both
  10529. subtitle colors and video under the influence of the video equalizer
  10530. settings.
  10531. .UNINDENT
  10532. .UNINDENT
  10533. .UNINDENT
  10534. .TP
  10535. .B \fBvapoursynth=file:buffered\-frames:concurrent\-frames\fP
  10536. Loads a VapourSynth filter script. This is intended for streamed
  10537. processing: mpv actually provides a source filter, instead of using a
  10538. native VapourSynth video source. The mpv source will answer frame
  10539. requests only within a small window of frames (the size of this window
  10540. is controlled with the \fBbuffered\-frames\fP parameter), and requests outside
  10541. of that will return errors. As such, you can\(aqt use the full power of
  10542. VapourSynth, but you can use certain filters.
  10543. .sp
  10544. \fBWARNING:\fP
  10545. .INDENT 7.0
  10546. .INDENT 3.5
  10547. Do not use this filter, unless you have expert knowledge in VapourSynth,
  10548. and know how to fix bugs in the mpv VapourSynth wrapper code.
  10549. .UNINDENT
  10550. .UNINDENT
  10551. .sp
  10552. If you just want to play video generated by VapourSynth (i.e. using
  10553. a native VapourSynth video source), it\(aqs better to use \fBvspipe\fP and a
  10554. pipe or FIFO to feed the video to mpv. The same applies if the filter script
  10555. requires random frame access (see \fBbuffered\-frames\fP parameter).
  10556. .INDENT 7.0
  10557. .TP
  10558. .B \fBfile\fP
  10559. Filename of the script source. Currently, this is always a python
  10560. script (\fB\&.vpy\fP in VapourSynth convention).
  10561. .sp
  10562. The variable \fBvideo_in\fP is set to the mpv video source, and it is
  10563. expected that the script reads video from it. (Otherwise, mpv will
  10564. decode no video, and the video packet queue will overflow, eventually
  10565. leading to only audio playing, or worse.)
  10566. .sp
  10567. The filter graph created by the script is also expected to pass through
  10568. timestamps using the \fB_DurationNum\fP and \fB_DurationDen\fP frame
  10569. properties.
  10570. .sp
  10571. See the end of the option list for a full list of script variables
  10572. defined by mpv.
  10573. .INDENT 7.0
  10574. .INDENT 3.5
  10575. .IP "Example:"
  10576. .INDENT 0.0
  10577. .INDENT 3.5
  10578. .sp
  10579. .nf
  10580. .ft C
  10581. import vapoursynth as vs
  10582. core = vs.get_core()
  10583. core.std.AddBorders(video_in, 10, 10, 20, 20).set_output()
  10584. .ft P
  10585. .fi
  10586. .UNINDENT
  10587. .UNINDENT
  10588. .UNINDENT
  10589. .UNINDENT
  10590. .sp
  10591. \fBWARNING:\fP
  10592. .INDENT 7.0
  10593. .INDENT 3.5
  10594. The script will be reloaded on every seek. This is done to reset
  10595. the filter properly on discontinuities.
  10596. .UNINDENT
  10597. .UNINDENT
  10598. .TP
  10599. .B \fBbuffered\-frames\fP
  10600. Maximum number of decoded video frames that should be buffered before
  10601. the filter (default: 4). This specifies the maximum number of frames
  10602. the script can request in backward direction.
  10603. .sp
  10604. E.g. if \fBbuffered\-frames=5\fP, and the script just requested frame 15,
  10605. it can still request frame 10, but frame 9 is not available anymore.
  10606. If it requests frame 30, mpv will decode 15 more frames, and keep only
  10607. frames 25\-30.
  10608. .sp
  10609. The only reason why this buffer exists is to serve the random access
  10610. requests the VapourSynth filter can make.
  10611. .sp
  10612. The VapourSynth API has a \fBgetFrameAsync\fP function, which takes an
  10613. absolute frame number. Source filters must respond to all requests. For
  10614. example, a source filter can request frame 2432, and then frame 3.
  10615. Source filters  typically implement this by pre\-indexing the entire
  10616. file.
  10617. .sp
  10618. mpv on the other hand is stream oriented, and does not allow filters to
  10619. seek. (And it would not make sense to allow it, because it would ruin
  10620. performance.) Filters get frames sequentially in playback direction, and
  10621. cannot request them out of order.
  10622. .sp
  10623. To compensate for this mismatch, mpv allows the filter to access frames
  10624. within a certain window. \fBbuffered\-frames\fP controls the size of this
  10625. window. Most VapourSynth filters happen to work with this, because mpv
  10626. requests frames sequentially increasing from it, and most filters only
  10627. require frames "close" to the requested frame.
  10628. .sp
  10629. If the filter requests a frame that has a higher frame number than the
  10630. highest buffered frame, new frames will be decoded until the requested
  10631. frame number is reached. Excessive frames will be flushed out in a FIFO
  10632. manner (there are only at most \fBbuffered\-frames\fP in this buffer).
  10633. .sp
  10634. If the filter requests a frame that has a lower frame number than the
  10635. lowest buffered frame, the request cannot be satisfied, and an error
  10636. is returned to the filter. This kind of error is not supposed to happen
  10637. in a "proper" VapourSynth environment. What exactly happens depends on
  10638. the filters involved.
  10639. .sp
  10640. Increasing this buffer will not improve performance. Rather, it will
  10641. waste memory, and slow down seeks (when enough frames to fill the buffer
  10642. need to be decoded at once). It is only needed to prevent the error
  10643. described in the previous paragraph.
  10644. .sp
  10645. How many frames a filter requires depends on filter implementation
  10646. details, and mpv has no way of knowing. A scale filter might need only
  10647. 1 frame, an interpolation filter may require a small number of frames,
  10648. and the \fBReverse\fP filter will require an infinite number of frames.
  10649. .sp
  10650. If you want reliable operation to the full extend VapourSynth is
  10651. capable, use \fBvspipe\fP\&.
  10652. .sp
  10653. The actual number of buffered frames also depends on the value of the
  10654. \fBconcurrent\-frames\fP option. Currently, both option values are
  10655. multiplied to get the final buffer size.
  10656. .TP
  10657. .B \fBconcurrent\-frames\fP
  10658. Number of frames that should be requested in parallel. The
  10659. level of concurrency depends on the filter and how quickly mpv can
  10660. decode video to feed the filter. This value should probably be
  10661. proportional to the number of cores on your machine. Most time,
  10662. making it higher than the number of cores can actually make it
  10663. slower.
  10664. .sp
  10665. Technically, mpv will call the VapourSynth \fBgetFrameAsync\fP function
  10666. in a loop, until there are \fBconcurrent\-frames\fP frames that have not
  10667. been returned by the filter yet. This also assumes that the rest of the
  10668. mpv filter chain reads the output of the \fBvapoursynth\fP filter quickly
  10669. enough. (For example, if you pause the player, filtering will stop very
  10670. soon, because the filtered frames are waiting in a queue.)
  10671. .sp
  10672. Actual concurrency depends on many other factors.
  10673. .sp
  10674. By default, this uses the special value \fBauto\fP, which sets the option
  10675. to the number of detected logical CPU cores.
  10676. .UNINDENT
  10677. .sp
  10678. The following \fB\&.vpy\fP script variables are defined by mpv:
  10679. .INDENT 7.0
  10680. .TP
  10681. .B \fBvideo_in\fP
  10682. The mpv video source as vapoursynth clip. Note that this has an
  10683. incorrect (very high) length set, which confuses many filters. This is
  10684. necessary, because the true number of frames is unknown. You can use the
  10685. \fBTrim\fP filter on the clip to reduce the length.
  10686. .TP
  10687. .B \fBvideo_in_dw\fP, \fBvideo_in_dh\fP
  10688. Display size of the video. Can be different from video size if the
  10689. video does not use square pixels (e.g. DVD).
  10690. .TP
  10691. .B \fBcontainer_fps\fP
  10692. FPS value as reported by file headers. This value can be wrong or
  10693. completely broken (e.g. 0 or NaN). Even if the value is correct,
  10694. if another filter changes the real FPS (by dropping or inserting
  10695. frames), the value of this variable will not be useful. Note that
  10696. the \fB\-\-fps\fP command line option overrides this value.
  10697. .sp
  10698. Useful for some filters which insist on having a FPS.
  10699. .TP
  10700. .B \fBdisplay_fps\fP
  10701. Refresh rate of the current display. Note that this value can be 0.
  10702. .UNINDENT
  10703. .TP
  10704. .B \fBvavpp\fP
  10705. VA\-API video post processing. Requires the system to support VA\-API,
  10706. i.e. Linux/BSD only. Works with \fB\-\-vo=vaapi\fP and \fB\-\-vo=gpu\fP only.
  10707. Currently deinterlaces. This filter is automatically inserted if
  10708. deinterlacing is requested (either using the \fBd\fP key, by default mapped to
  10709. the command \fBcycle deinterlace\fP, or the \fB\-\-deinterlace\fP option).
  10710. .INDENT 7.0
  10711. .TP
  10712. .B \fBdeint=<method>\fP
  10713. Select the deinterlacing algorithm.
  10714. .INDENT 7.0
  10715. .TP
  10716. .B no
  10717. Don\(aqt perform deinterlacing.
  10718. .TP
  10719. .B auto
  10720. Select the best quality deinterlacing algorithm (default). This
  10721. goes by the order of the options as documented, with
  10722. \fBmotion\-compensated\fP being considered best quality.
  10723. .TP
  10724. .B first\-field
  10725. Show only first field.
  10726. .TP
  10727. .B bob
  10728. bob deinterlacing.
  10729. .TP
  10730. .B weave, motion\-adaptive, motion\-compensated
  10731. Advanced deinterlacing algorithms. Whether these actually work
  10732. depends on the GPU hardware, the GPU drivers, driver bugs, and
  10733. mpv bugs.
  10734. .UNINDENT
  10735. .TP
  10736. .B \fB<interlaced\-only>\fP
  10737. .INDENT 7.0
  10738. .TP
  10739. .B no
  10740. Deinterlace all frames (default).
  10741. .TP
  10742. .B yes
  10743. Only deinterlace frames marked as interlaced.
  10744. .UNINDENT
  10745. .TP
  10746. .B \fBreversal\-bug=<yes|no>\fP
  10747. .INDENT 7.0
  10748. .TP
  10749. .B no
  10750. Use the API as it was interpreted by older Mesa drivers. While
  10751. this interpretation was more obvious and inuitive, it was
  10752. apparently wrong, and not shared by Intel driver developers.
  10753. .TP
  10754. .B yes
  10755. Use Intel interpretation of surface forward and backwards
  10756. references (default). This is what Intel drivers and newer Mesa
  10757. drivers expect. Matters only for the advanced deinterlacing
  10758. algorithms.
  10759. .UNINDENT
  10760. .UNINDENT
  10761. .TP
  10762. .B \fBvdpaupp\fP
  10763. VDPAU video post processing. Works with \fB\-\-vo=vdpau\fP and \fB\-\-vo=gpu\fP
  10764. only. This filter is automatically inserted if deinterlacing is requested
  10765. (either using the \fBd\fP key, by default mapped to the command
  10766. \fBcycle deinterlace\fP, or the \fB\-\-deinterlace\fP option). When enabling
  10767. deinterlacing, it is always preferred over software deinterlacer filters
  10768. if the \fBvdpau\fP VO is used, and also if \fBgpu\fP is used and hardware
  10769. decoding was activated at least once (i.e. vdpau was loaded).
  10770. .INDENT 7.0
  10771. .TP
  10772. .B \fBsharpen=<\-1\-1>\fP
  10773. For positive values, apply a sharpening algorithm to the video, for
  10774. negative values a blurring algorithm (default: 0).
  10775. .TP
  10776. .B \fBdenoise=<0\-1>\fP
  10777. Apply a noise reduction algorithm to the video (default: 0; no noise
  10778. reduction).
  10779. .TP
  10780. .B \fBdeint=<yes|no>\fP
  10781. Whether deinterlacing is enabled (default: no). If enabled, it will use
  10782. the mode selected with \fBdeint\-mode\fP\&.
  10783. .TP
  10784. .B \fBdeint\-mode=<first\-field|bob|temporal|temporal\-spatial>\fP
  10785. Select deinterlacing mode (default: temporal).
  10786. .sp
  10787. Note that there\(aqs currently a mechanism that allows the \fBvdpau\fP VO to
  10788. change the \fBdeint\-mode\fP of auto\-inserted \fBvdpaupp\fP filters. To avoid
  10789. confusion, it\(aqs recommended not to use the \fB\-\-vo=vdpau\fP suboptions
  10790. related to filtering.
  10791. .INDENT 7.0
  10792. .TP
  10793. .B first\-field
  10794. Show only first field.
  10795. .TP
  10796. .B bob
  10797. Bob deinterlacing.
  10798. .TP
  10799. .B temporal
  10800. Motion\-adaptive temporal deinterlacing. May lead to A/V desync
  10801. with slow video hardware and/or high resolution.
  10802. .TP
  10803. .B temporal\-spatial
  10804. Motion\-adaptive temporal deinterlacing with edge\-guided spatial
  10805. interpolation. Needs fast video hardware.
  10806. .UNINDENT
  10807. .TP
  10808. .B \fBchroma\-deint\fP
  10809. Makes temporal deinterlacers operate both on luma and chroma (default).
  10810. Use no\-chroma\-deint to solely use luma and speed up advanced
  10811. deinterlacing. Useful with slow video memory.
  10812. .TP
  10813. .B \fBpullup\fP
  10814. Try to apply inverse telecine, needs motion adaptive temporal
  10815. deinterlacing.
  10816. .TP
  10817. .B \fBinterlaced\-only=<yes|no>\fP
  10818. If \fByes\fP, only deinterlace frames marked as interlaced (default: no).
  10819. .TP
  10820. .B \fBhqscaling=<0\-9>\fP
  10821. .INDENT 7.0
  10822. .TP
  10823. .B 0
  10824. Use default VDPAU scaling (default).
  10825. .TP
  10826. .B 1\-9
  10827. Apply high quality VDPAU scaling (needs capable hardware).
  10828. .UNINDENT
  10829. .UNINDENT
  10830. .TP
  10831. .B \fBd3d11vpp\fP
  10832. Direct3D 11 video post processing. Currently requires D3D11 hardware
  10833. decoding for use.
  10834. .INDENT 7.0
  10835. .TP
  10836. .B \fBdeint=<yes|no>\fP
  10837. Whether deinterlacing is enabled (default: no).
  10838. .TP
  10839. .B \fBinterlaced\-only=<yes|no>\fP
  10840. If \fByes\fP, only deinterlace frames marked as interlaced (default: no).
  10841. .TP
  10842. .B \fBmode=<blend|bob|adaptive|mocomp|ivctc|none>\fP
  10843. Tries to select a video processor with the given processing capability.
  10844. If a video processor supports multiple capabilities, it is not clear
  10845. which algorithm is actually selected. \fBnone\fP always falls back. On
  10846. most if not all hardware, this option will probably do nothing, because
  10847. a video processor usually supports all modes or none.
  10848. .UNINDENT
  10849. .TP
  10850. .B \fBfingerprint=...\fP
  10851. Compute video frame fingerprints and provide them as metadata. Actually, it
  10852. currently barely deserved to be called \fBfingerprint\fP, because it does not
  10853. compute "proper" fingerprints, only tiny downscaled images (but which can be
  10854. used to compute image hashes or for similarity matching).
  10855. .sp
  10856. The main purpose of this filter is to support the \fBskip\-logo.lua\fP script.
  10857. If this script is dropped, or mpv ever gains a way to load user\-defined
  10858. filters (other than VapourSynth), this filter will be removed. Due to the
  10859. "special" nature of this filter, it will be removed without warning.
  10860. .sp
  10861. The intended way to read from the filter is using \fBvf\-metadata\fP (also
  10862. see \fBclear\-on\-query\fP filter parameter). The property will return a list
  10863. of key/value pairs as follows:
  10864. .INDENT 7.0
  10865. .INDENT 3.5
  10866. .sp
  10867. .nf
  10868. .ft C
  10869. fp0.pts = 1.2345
  10870. fp0.hex = 1234abcdef...bcde
  10871. fp1.pts = 1.4567
  10872. fp1.hex = abcdef1234...6789
  10873. \&...
  10874. fpN.pts = ...
  10875. fpN.hex = ...
  10876. type = gray\-hex\-16x16
  10877. .ft P
  10878. .fi
  10879. .UNINDENT
  10880. .UNINDENT
  10881. .sp
  10882. Each \fBfp<N>\fP entry is for a frame. The \fBpts\fP entry specifies the
  10883. timestamp of the frame (within the filter chain; in simple cases this is
  10884. the same as the display timestamp). The \fBhex\fP field is the hex encoded
  10885. fingerprint, whose size and meaning depend on the \fBtype\fP filter option.
  10886. The \fBtype\fP field has the same value as the option the filter was created
  10887. with.
  10888. .sp
  10889. This returns the frames that were filtered since the last query of the
  10890. property. If \fBclear\-on\-query=no\fP was set, a query doesn\(aqt reset the list
  10891. of frames. In both cases, a maximum of 10 frames is returned. If there are
  10892. more frames, the oldest frames are discarded. Frames are returned in filter
  10893. order.
  10894. .sp
  10895. (This doesn\(aqt return a structured list for the per\-frame details because the
  10896. internals of the \fBvf\-metadata\fP mechanism suck. The returned format may
  10897. change in the future.)
  10898. .sp
  10899. This filter uses zimg for speed and profit. However, it will fallback to
  10900. libswscale in a number of situations: lesser pixel formats, unaligned data
  10901. pointers or strides, or if zimg fails to initialize for unknown reasons. In
  10902. these cases, the filter will use more CPU. Also, it will output different
  10903. fingerprints, because libswscale cannot perform the full range expansion we
  10904. normally request from zimg. As a consequence, the filter may be slower and
  10905. not work correctly in random situations.
  10906. .INDENT 7.0
  10907. .TP
  10908. .B \fBtype=...\fP
  10909. What fingerprint to compute. Available types are:
  10910. .INDENT 7.0
  10911. .TP
  10912. .B gray\-hex\-8x8
  10913. grayscale, 8 bit, 8x8 size
  10914. .TP
  10915. .B gray\-hex\-16x16
  10916. grayscale, 8 bit, 16x16 size (default)
  10917. .UNINDENT
  10918. .sp
  10919. Both types simply remove all colors, downscale the image, concatenate
  10920. all pixel values to a byte array, and convert the array to a hex string.
  10921. .TP
  10922. .B \fBclear\-on\-query=yes|no\fP
  10923. Clear the list of frame fingerprints if the \fBvf\-metadata\fP property for
  10924. this filter is queried (default: yes). This requires some care by the
  10925. user. Some types of accesses might query the filter multiple times,
  10926. which leads to lost frames.
  10927. .TP
  10928. .B \fBprint=yes|no\fP
  10929. Print computed fingerprints the the terminal (default: no). This is
  10930. mostly for testing and such. Scripts should use \fBvf\-metadata\fP to
  10931. read information from this filter instead.
  10932. .UNINDENT
  10933. .TP
  10934. .B \fBgpu=...\fP
  10935. Convert video to RGB using the OpenGL renderer normally used with
  10936. \fB\-\-vo=gpu\fP\&. This requires that the EGL implementation supports off\-screen
  10937. rendering on the default display. (This is the case with Mesa.)
  10938. .sp
  10939. Sub\-options:
  10940. .INDENT 7.0
  10941. .TP
  10942. .B \fBw=<pixels>\fP, \fBh=<pixels>\fP
  10943. Size of the output in pixels (default: 0). If not positive, this will
  10944. use the size of the first filtered input frame.
  10945. .UNINDENT
  10946. .sp
  10947. \fBWARNING:\fP
  10948. .INDENT 7.0
  10949. .INDENT 3.5
  10950. This is highly experimental. Performance is bad, and it will not work
  10951. everywhere in the first place. Some features are not supported.
  10952. .UNINDENT
  10953. .UNINDENT
  10954. .sp
  10955. \fBWARNING:\fP
  10956. .INDENT 7.0
  10957. .INDENT 3.5
  10958. This does not do OSD rendering. If you see OSD, then it has been
  10959. rendered by the VO backend. (Subtitles are rendered by the \fBgpu\fP
  10960. filter, if possible.)
  10961. .UNINDENT
  10962. .UNINDENT
  10963. .sp
  10964. \fBWARNING:\fP
  10965. .INDENT 7.0
  10966. .INDENT 3.5
  10967. If you use this with encoding mode, keep in mind that encoding mode will
  10968. convert the RGB filter\(aqs output back to yuv420p in software, using the
  10969. configured software scaler. Using \fBzimg\fP might improve this, but in
  10970. any case it might go against your goals when using this filter.
  10971. .UNINDENT
  10972. .UNINDENT
  10973. .sp
  10974. \fBWARNING:\fP
  10975. .INDENT 7.0
  10976. .INDENT 3.5
  10977. Do not use this with \fB\-\-vo=gpu\fP\&. It will apply filtering twice, since
  10978. most \fB\-\-vo=gpu\fP options are unconditionally applied to the \fBgpu\fP
  10979. filter. There is no mechanism in mpv to prevent this.
  10980. .UNINDENT
  10981. .UNINDENT
  10982. .UNINDENT
  10983. .SH ENCODING
  10984. .sp
  10985. You can encode files from one format/codec to another using this facility.
  10986. .INDENT 0.0
  10987. .TP
  10988. .B \fB\-\-o=<filename>\fP
  10989. Enables encoding mode and specifies the output file name.
  10990. .TP
  10991. .B \fB\-\-of=<format>\fP
  10992. Specifies the output format (overrides autodetection by the file name
  10993. extension of the file specified by \fB\-o\fP). See \fB\-\-of=help\fP for a full
  10994. list of supported formats.
  10995. .TP
  10996. .B \fB\-\-ofopts=<options>\fP
  10997. Specifies the output format options for libavformat.
  10998. See \fB\-\-ofopts=help\fP for a full list of supported options.
  10999. .sp
  11000. This is a key/value list option. See \fI\%List Options\fP for details.
  11001. .INDENT 7.0
  11002. .TP
  11003. .B \fB\-\-ofopts\-add=<option>\fP
  11004. Appends the option given as an argument to the options list. (Passing
  11005. multiple options is currently still possible, but deprecated.)
  11006. .TP
  11007. .B \fB\-\-ofopts=""\fP
  11008. Completely empties the options list.
  11009. .UNINDENT
  11010. .TP
  11011. .B \fB\-\-oac=<codec>\fP
  11012. Specifies the output audio codec. See \fB\-\-oac=help\fP for a full list of
  11013. supported codecs.
  11014. .TP
  11015. .B \fB\-\-oaoffset=<value>\fP
  11016. Shifts audio data by the given time (in seconds) by adding/removing
  11017. samples at the start. Deprecated.
  11018. .TP
  11019. .B \fB\-\-oacopts=<options>\fP
  11020. Specifies the output audio codec options for libavcodec.
  11021. See \fB\-\-oacopts=help\fP for a full list of supported options.
  11022. .INDENT 7.0
  11023. .INDENT 3.5
  11024. .IP "Example"
  11025. .INDENT 0.0
  11026. .TP
  11027. .B "\fB\-\-oac=libmp3lame \-\-oacopts=b=128000\fP"
  11028. selects 128 kbps MP3 encoding.
  11029. .UNINDENT
  11030. .UNINDENT
  11031. .UNINDENT
  11032. .sp
  11033. This is a key/value list option. See \fI\%List Options\fP for details.
  11034. .INDENT 7.0
  11035. .TP
  11036. .B \fB\-\-oacopts\-add=<option>\fP
  11037. Appends the option given as an argument to the options list. (Passing
  11038. multiple options is currently still possible, but deprecated.)
  11039. .TP
  11040. .B \fB\-\-oacopts=""\fP
  11041. Completely empties the options list.
  11042. .UNINDENT
  11043. .TP
  11044. .B \fB\-\-oafirst\fP
  11045. Force the audio stream to become the first stream in the output.
  11046. By default, the order is unspecified. Deprecated.
  11047. .TP
  11048. .B \fB\-\-ovc=<codec>\fP
  11049. Specifies the output video codec. See \fB\-\-ovc=help\fP for a full list of
  11050. supported codecs.
  11051. .TP
  11052. .B \fB\-\-ovoffset=<value>\fP
  11053. Shifts video data by the given time (in seconds) by shifting the pts
  11054. values. Deprecated.
  11055. .TP
  11056. .B \fB\-\-ovcopts=<options>\fP
  11057. Specifies the output video codec options for libavcodec.
  11058. See \-\-ovcopts=help for a full list of supported options.
  11059. .INDENT 7.0
  11060. .INDENT 3.5
  11061. .IP "Examples"
  11062. .INDENT 0.0
  11063. .TP
  11064. .B \fB"\-\-ovc=mpeg4 \-\-ovcopts=qscale=5"\fP
  11065. selects constant quantizer scale 5 for MPEG\-4 encoding.
  11066. .TP
  11067. .B \fB"\-\-ovc=libx264 \-\-ovcopts=crf=23"\fP
  11068. selects VBR quality factor 23 for H.264 encoding.
  11069. .UNINDENT
  11070. .UNINDENT
  11071. .UNINDENT
  11072. .sp
  11073. This is a key/value list option. See \fI\%List Options\fP for details.
  11074. .INDENT 7.0
  11075. .TP
  11076. .B \fB\-\-ovcopts\-add=<option>\fP
  11077. Appends the option given as an argument to the options list. (Passing
  11078. multiple options is currently still possible, but deprecated.)
  11079. .TP
  11080. .B \fB\-\-ovcopts=""\fP
  11081. Completely empties the options list.
  11082. .UNINDENT
  11083. .TP
  11084. .B \fB\-\-ovfirst\fP
  11085. Force the video stream to become the first stream in the output.
  11086. By default, the order is unspecified. Deprecated.
  11087. .TP
  11088. .B \fB\-\-orawts\fP
  11089. Copies input pts to the output video (not supported by some output
  11090. container formats, e.g. AVI). In this mode, discontinuities are not fixed
  11091. and all pts are passed through as\-is. Never seek backwards or use multiple
  11092. input files in this mode!
  11093. .TP
  11094. .B \fB\-\-no\-ocopy\-metadata\fP
  11095. Turns off copying of metadata from input files to output files when
  11096. encoding (which is enabled by default).
  11097. .TP
  11098. .B \fB\-\-oset\-metadata=<metadata\-tag[,metadata\-tag,...]>\fP
  11099. Specifies metadata to include in the output file.
  11100. Supported keys vary between output formats. For example, Matroska (MKV) and
  11101. FLAC allow almost arbitrary keys, while support in MP4 and MP3 is more
  11102. limited.
  11103. .sp
  11104. This is a key/value list option. See \fI\%List Options\fP for details.
  11105. .INDENT 7.0
  11106. .INDENT 3.5
  11107. .IP "Example"
  11108. .INDENT 0.0
  11109. .TP
  11110. .B "\fB\-\-oset\-metadata=title="Output title",comment="Another tag"\fP"
  11111. adds a title and a comment to the output file.
  11112. .UNINDENT
  11113. .UNINDENT
  11114. .UNINDENT
  11115. .TP
  11116. .B \fB\-\-oremove\-metadata=<metadata\-tag[,metadata\-tag,...]>\fP
  11117. Specifies metadata to exclude from the output file when copying from the
  11118. input file.
  11119. .sp
  11120. This is a string list option. See \fI\%List Options\fP for details.
  11121. .INDENT 7.0
  11122. .INDENT 3.5
  11123. .IP "Example"
  11124. .INDENT 0.0
  11125. .TP
  11126. .B "\fB\-\-oremove\-metadata=comment,genre\fP"
  11127. excludes copying of the the comment and genre tags to the output
  11128. file.
  11129. .UNINDENT
  11130. .UNINDENT
  11131. .UNINDENT
  11132. .UNINDENT
  11133. .SH COMMAND INTERFACE
  11134. .sp
  11135. The mpv core can be controlled with commands and properties. A number of ways
  11136. to interact with the player use them: key bindings (\fBinput.conf\fP), OSD
  11137. (showing information with properties), JSON IPC, the client API (\fBlibmpv\fP),
  11138. and the classic slave mode.
  11139. .SS input.conf
  11140. .sp
  11141. The input.conf file consists of a list of key bindings, for example:
  11142. .INDENT 0.0
  11143. .INDENT 3.5
  11144. .sp
  11145. .nf
  11146. .ft C
  11147. s screenshot      # take a screenshot with the s key
  11148. LEFT seek 15      # map the left\-arrow key to seeking forward by 15 seconds
  11149. .ft P
  11150. .fi
  11151. .UNINDENT
  11152. .UNINDENT
  11153. .sp
  11154. Each line maps a key to an input command. Keys are specified with their literal
  11155. value (upper case if combined with \fBShift\fP), or a name for special keys. For
  11156. example, \fBa\fP maps to the \fBa\fP key without shift, and \fBA\fP maps to \fBa\fP
  11157. with shift.
  11158. .sp
  11159. The file is located in the mpv configuration directory (normally at
  11160. \fB~/.config/mpv/input.conf\fP depending on platform). The default bindings are
  11161. defined here:
  11162. .INDENT 0.0
  11163. .INDENT 3.5
  11164. .sp
  11165. .nf
  11166. .ft C
  11167. https://github.com/mpv\-player/mpv/blob/master/etc/input.conf
  11168. .ft P
  11169. .fi
  11170. .UNINDENT
  11171. .UNINDENT
  11172. .sp
  11173. A list of special keys can be obtained with
  11174. .INDENT 0.0
  11175. .INDENT 3.5
  11176. \fBmpv \-\-input\-keylist\fP
  11177. .UNINDENT
  11178. .UNINDENT
  11179. .sp
  11180. In general, keys can be combined with \fBShift\fP, \fBCtrl\fP and \fBAlt\fP:
  11181. .INDENT 0.0
  11182. .INDENT 3.5
  11183. .sp
  11184. .nf
  11185. .ft C
  11186. ctrl+q quit
  11187. .ft P
  11188. .fi
  11189. .UNINDENT
  11190. .UNINDENT
  11191. .sp
  11192. \fBmpv\fP can be started in input test mode, which displays key bindings and the
  11193. commands they\(aqre bound to on the OSD, instead of executing the commands:
  11194. .INDENT 0.0
  11195. .INDENT 3.5
  11196. .sp
  11197. .nf
  11198. .ft C
  11199. mpv \-\-input\-test \-\-force\-window \-\-idle
  11200. .ft P
  11201. .fi
  11202. .UNINDENT
  11203. .UNINDENT
  11204. .sp
  11205. (Only closing the window will make \fBmpv\fP exit, pressing normal keys will
  11206. merely display the binding, even if mapped to quit.)
  11207. .sp
  11208. Also see \fI\%Key names\fP\&.
  11209. .SS input.conf syntax
  11210. .sp
  11211. \fB[Shift+][Ctrl+][Alt+][Meta+]<key> [{<section>}] <command> ( ; <command> )*\fP
  11212. .sp
  11213. Note that by default, the right Alt key can be used to create special
  11214. characters, and thus does not register as a modifier. The option
  11215. \fB\-\-no\-input\-right\-alt\-gr\fP changes this behavior.
  11216. .sp
  11217. Newlines always start a new binding. \fB#\fP starts a comment (outside of quoted
  11218. string arguments). To bind commands to the \fB#\fP key, \fBSHARP\fP can be used.
  11219. .sp
  11220. \fB<key>\fP is either the literal character the key produces (ASCII or Unicode
  11221. character), or a symbolic name (as printed by \fB\-\-input\-keylist\fP).
  11222. .sp
  11223. \fB<section>\fP (braced with \fB{\fP and \fB}\fP) is the input section for this
  11224. command.
  11225. .sp
  11226. \fB<command>\fP is the command itself. It consists of the command name and
  11227. multiple (or none) commands, all separated by whitespace. String arguments
  11228. need to be quoted with \fB"\fP\&. Details see \fBFlat command syntax\fP\&.
  11229. .sp
  11230. You can bind multiple commands to one key. For example:
  11231. .nf
  11232. a show\-text "command 1" ; show\-text "command 2"
  11233. .fi
  11234. .sp
  11235. .sp
  11236. It\(aqs also possible to bind a command to a sequence of keys:
  11237. .nf
  11238. a\-b\-c show\-text "command run after a, b, c have been pressed"
  11239. .fi
  11240. .sp
  11241. .sp
  11242. (This is not shown in the general command syntax.)
  11243. .sp
  11244. If \fBa\fP or \fBa\-b\fP or \fBb\fP are already bound, this will run the first command
  11245. that matches, and the multi\-key command will never be called. Intermediate keys
  11246. can be remapped to \fBignore\fP in order to avoid this issue. The maximum number
  11247. of (non\-modifier) keys for combinations is currently 4.
  11248. .SS Key names
  11249. .sp
  11250. All mouse and keyboard input is to converted to mpv\-specific key names. Key
  11251. names are either special symbolic identifiers representing a physical key, or a
  11252. text key names, which are unicode code points encoded as UTF\-8. These are what
  11253. keyboard input would normally produce, for example \fBa\fP for the A key. As a
  11254. consequence, mpv uses input translated by the current OS keyboard layout, rather
  11255. than physical scan codes.
  11256. .sp
  11257. Currently there is the hardcoded assumption that every text key can be
  11258. represented as a single unicode code point (in NFKC form).
  11259. .sp
  11260. All key names can be combined with the modifiers \fBShift\fP, \fBCtrl\fP, \fBAlt\fP,
  11261. \fBMeta\fP\&. They must be prefixed to the actual key name, where each modifier
  11262. is followed by a \fB+\fP (for example \fBctrl+q\fP).
  11263. .sp
  11264. Symbolic key names and modifier names are case\-insensitive. Unicode key names
  11265. are case\-sensitive because input bindings typically respect the shift key.
  11266. .sp
  11267. Another type of key names are hexadecimal key names, that serve as fallback
  11268. for special keys that are neither unicode, nor have a special mpv defined name.
  11269. They will break as soon as mpv adds proper names for them, but can enable you
  11270. to use a key at all if that does not happen.
  11271. .sp
  11272. All symbolic names are listed by \fB\-\-input\-keylist\fP\&. \fB\-\-input\-test\fP is a
  11273. special mode that prints all input on the OSD.
  11274. .sp
  11275. Comments on some symbolic names:
  11276. .INDENT 0.0
  11277. .TP
  11278. .B \fBKP*\fP
  11279. Keypad names. Behavior varies by backend (whether they implement this, and
  11280. on how they treat numlock), but typically, mpv tries to map keys on the
  11281. keypad to separate names, even if they produce the same text as normal keys.
  11282. .TP
  11283. .B \fBMOUSE_BTN*\fP, \fBMBTN*\fP
  11284. Various mouse buttons.
  11285. .sp
  11286. Depending on backend, the mouse wheel might also be represented as a button.
  11287. In addition, \fBMOUSE_BTN3\fP to \fBMOUSE_BTN6\fP are deprecated aliases for
  11288. \fBWHEEL_UP\fP, \fBWHEEL_DOWN\fP, \fBWHEEL_LEFT\fP, \fBWHEEL_RIGHT\fP\&.
  11289. .sp
  11290. \fBMBTN*\fP are aliases for \fBMOUSE_BTN*\fP\&.
  11291. .TP
  11292. .B \fBWHEEL_*\fP
  11293. Mouse wheels (typically).
  11294. .TP
  11295. .B \fBAXIS_*\fP
  11296. Deprecated aliases for \fBWHEEL_*\fP\&.
  11297. .TP
  11298. .B \fB*_DBL\fP
  11299. Mouse button double clicks.
  11300. .TP
  11301. .B \fBMOUSE_MOVE\fP, \fBMOUSE_ENTER\fP, \fBMOUSE_LEAVE\fP
  11302. Emitted by mouse move events. Enter/leave happens when the mouse enters or
  11303. leave the mpv window (or the current mouse region, using the deprecated
  11304. mouse region input section mechanism).
  11305. .TP
  11306. .B \fBCLOSE_WIN\fP
  11307. Pseudo key emitted when closing the mpv window using the OS window manager
  11308. (for example, by clicking the close button in the window title bar).
  11309. .TP
  11310. .B \fBGAMEPAD_*\fP
  11311. Keys emitted by the SDL gamepad backend.
  11312. .TP
  11313. .B \fBUNMAPPED\fP
  11314. Pseudo\-key that matches any unmapped key. (You should probably avoid this
  11315. if possible, because it might change behavior or get removed in the future.)
  11316. .TP
  11317. .B \fBANY_UNICODE\fP
  11318. Pseudo\-key that matches any key that produces text. (You should probably
  11319. avoid this if possible, because it might change behavior or get removed in
  11320. the future.)
  11321. .UNINDENT
  11322. .SS Flat command syntax
  11323. .sp
  11324. This is the syntax used in input.conf, and referred to "input.conf syntax" in
  11325. a number of other places.
  11326. .sp
  11327. \fB<command> ::= [<prefixes>] <command_name> (<argument>)*\fP
  11328. \fB<argument> ::= (<string> | " <quoted_string> " )\fP
  11329. .sp
  11330. \fBcommand_name\fP is an unquoted string with the command name itself. See
  11331. \fI\%List of Input Commands\fP for a list.
  11332. .sp
  11333. Arguments are separated by whitespace. This applies even to string arguments.
  11334. For this reason, string arguments should be quoted with \fB"\fP\&. If a string
  11335. argument contains spaces or certain special characters, quoting and possibly
  11336. escaping is mandatory, or the command cannot be parsed correctly.
  11337. .sp
  11338. Inside quotes, C\-style escaping can be used. JSON escapes according to RFC 8259,
  11339. minus surrogate pair escapes, should be a safe subset that can be used.
  11340. .SS Commands specified as arrays
  11341. .sp
  11342. This applies to certain APIs, such as \fBmp.commandv()\fP or
  11343. \fBmp.command_native()\fP (with array parameters) in Lua scripting, or
  11344. \fBmpv_command()\fP or \fBmpv_command_node()\fP (with MPV_FORMAT_NODE_ARRAY) in the
  11345. C libmpv client API.
  11346. .sp
  11347. The command as well as all arguments are passed as a single array. Similar to
  11348. the \fI\%Flat command syntax\fP, you can first pass prefixes as strings (each as
  11349. separate array item), then the command name as string, and then each argument
  11350. as string or a native value.
  11351. .sp
  11352. Since these APIs pass arguments as separate strings or native values, they do
  11353. not expect quotes, and do support escaping. Technically, there is the input.conf
  11354. parser, which first splits the command string into arguments, and then invokes
  11355. argument parsers for each argument. The input.conf parser normally handles
  11356. quotes and escaping. The array command APIs mentioned above pass strings
  11357. directly to the argument parsers, or can sidestep them by the ability to pass
  11358. non\-string values.
  11359. .sp
  11360. Sometimes commands have string arguments, that in turn are actually parsed by
  11361. other components (e.g. filter strings with \fBvf add\fP) \- in these cases, you
  11362. you would have to double\-escape in input.conf, but not with the array APIs.
  11363. .sp
  11364. For complex commands, consider using \fI\%Named arguments\fP instead, which should
  11365. give slightly more compatibility. Some commands do not support named arguments
  11366. and inherently take an array, though.
  11367. .SS Named arguments
  11368. .sp
  11369. This applies to certain APIs, such as \fBmp.command_native()\fP (with tables that
  11370. have string keys) in Lua scripting, or \fBmpv_command_node()\fP (with
  11371. MPV_FORMAT_NODE_MAP) in the C libmpv client API.
  11372. .sp
  11373. Like with array commands, quoting and escaping is inherently not needed in the
  11374. normal case.
  11375. .sp
  11376. The name of each command is defined in each command description in the
  11377. \fI\%List of Input Commands\fP\&. \fB\-\-input\-cmdlist\fP also lists them.
  11378. .sp
  11379. Some commands do not support named arguments (e.g. \fBrun\fP command). You need
  11380. to use APIs that pass arguments as arrays.
  11381. .sp
  11382. Named arguments are not supported in the "flat" input.conf syntax, which means
  11383. you cannot use them for key bindings in input.conf at all.
  11384. .SS List of Input Commands
  11385. .sp
  11386. Commands with parameters have the parameter name enclosed in \fB<\fP / \fB>\fP\&.
  11387. Don\(aqt add those to the actual command. Optional arguments are enclosed in
  11388. \fB[\fP / \fB]\fP\&. If you don\(aqt pass them, they will be set to a default value.
  11389. .sp
  11390. Remember to quote string arguments in input.conf (see \fI\%Flat command syntax\fP).
  11391. .INDENT 0.0
  11392. .TP
  11393. .B \fBignore\fP
  11394. Use this to "block" keys that should be unbound, and do nothing. Useful for
  11395. disabling default bindings, without disabling all bindings with
  11396. \fB\-\-no\-input\-default\-bindings\fP\&.
  11397. .TP
  11398. .B \fBseek <target> [<flags>]\fP
  11399. Change the playback position. By default, seeks by a relative amount of
  11400. seconds.
  11401. .sp
  11402. The second argument consists of flags controlling the seek mode:
  11403. .INDENT 7.0
  11404. .TP
  11405. .B relative (default)
  11406. Seek relative to current position (a negative value seeks backwards).
  11407. .TP
  11408. .B absolute
  11409. Seek to a given time (a negative value starts from the end of the file).
  11410. .TP
  11411. .B absolute\-percent
  11412. Seek to a given percent position.
  11413. .TP
  11414. .B relative\-percent
  11415. Seek relative to current position in percent.
  11416. .TP
  11417. .B keyframes
  11418. Always restart playback at keyframe boundaries (fast).
  11419. .TP
  11420. .B exact
  11421. Always do exact/hr/precise seeks (slow).
  11422. .UNINDENT
  11423. .sp
  11424. Multiple flags can be combined, e.g.: \fBabsolute+keyframes\fP\&.
  11425. .sp
  11426. By default, \fBkeyframes\fP is used for \fBrelative\fP, \fBrelative\-percent\fP,
  11427. and \fBabsolute\-percent\fP seeks, while \fBexact\fP is used for \fBabsolute\fP
  11428. seeks.
  11429. .sp
  11430. Before mpv 0.9, the \fBkeyframes\fP and \fBexact\fP flags had to be passed as
  11431. 3rd parameter (essentially using a space instead of \fB+\fP). The 3rd
  11432. parameter is still parsed, but is considered deprecated.
  11433. .TP
  11434. .B \fBrevert\-seek [<flags>]\fP
  11435. Undoes the \fBseek\fP command, and some other commands that seek (but not
  11436. necessarily all of them). Calling this command once will jump to the
  11437. playback position before the seek. Calling it a second time undoes the
  11438. \fBrevert\-seek\fP command itself. This only works within a single file.
  11439. .sp
  11440. The first argument is optional, and can change the behavior:
  11441. .INDENT 7.0
  11442. .TP
  11443. .B mark
  11444. Mark the current time position. The next normal \fBrevert\-seek\fP command
  11445. will seek back to this point, no matter how many seeks happened since
  11446. last time.
  11447. .UNINDENT
  11448. .sp
  11449. Using it without any arguments gives you the default behavior.
  11450. .TP
  11451. .B \fBframe\-step\fP
  11452. Play one frame, then pause. Does nothing with audio\-only playback.
  11453. .TP
  11454. .B \fBframe\-back\-step\fP
  11455. Go back by one frame, then pause. Note that this can be very slow (it tries
  11456. to be precise, not fast), and sometimes fails to behave as expected. How
  11457. well this works depends on whether precise seeking works correctly (e.g.
  11458. see the \fB\-\-hr\-seek\-demuxer\-offset\fP option). Video filters or other video
  11459. post\-processing that modifies timing of frames (e.g. deinterlacing) should
  11460. usually work, but might make backstepping silently behave incorrectly in
  11461. corner cases. Using \fB\-\-hr\-seek\-framedrop=no\fP should help, although it
  11462. might make precise seeking slower.
  11463. .sp
  11464. This does not work with audio\-only playback.
  11465. .TP
  11466. .B \fBset <name> <value>\fP
  11467. Set the given property or option to the given value.
  11468. .TP
  11469. .B \fBadd <name> [<value>]\fP
  11470. Add the given value to the property or option. On overflow or underflow,
  11471. clamp the property to the maximum. If \fB<value>\fP is omitted, assume \fB1\fP\&.
  11472. .TP
  11473. .B \fBcycle <name> [<value>]\fP
  11474. Cycle the given property or option. The second argument can be \fBup\fP or
  11475. \fBdown\fP to set the cycle direction. On overflow, set the property back to
  11476. the minimum, on underflow set it to the maximum. If \fBup\fP or \fBdown\fP is
  11477. omitted, assume \fBup\fP\&.
  11478. .TP
  11479. .B \fBmultiply <name> <value>\fP
  11480. Similar to \fBadd\fP, but multiplies the property or option with the numeric
  11481. value.
  11482. .TP
  11483. .B \fBscreenshot <flags>\fP
  11484. Take a screenshot.
  11485. .sp
  11486. Multiple flags are available (some can be combined with \fB+\fP):
  11487. .INDENT 7.0
  11488. .TP
  11489. .B <subtitles> (default)
  11490. Save the video image, in its original resolution, and with subtitles.
  11491. Some video outputs may still include the OSD in the output under certain
  11492. circumstances.
  11493. .TP
  11494. .B <video>
  11495. Like \fBsubtitles\fP, but typically without OSD or subtitles. The exact
  11496. behavior depends on the selected video output.
  11497. .TP
  11498. .B <window>
  11499. Save the contents of the mpv window. Typically scaled, with OSD and
  11500. subtitles. The exact behavior depends on the selected video output, and
  11501. if no support is available, this will act like \fBvideo\fP\&.
  11502. .TP
  11503. .B <each\-frame>
  11504. Take a screenshot each frame. Issue this command again to stop taking
  11505. screenshots. Note that you should disable frame\-dropping when using
  11506. this mode \- or you might receive duplicate images in cases when a
  11507. frame was dropped. This flag can be combined with the other flags,
  11508. e.g. \fBvideo+each\-frame\fP\&.
  11509. .UNINDENT
  11510. .sp
  11511. Older mpv versions required passing \fBsingle\fP and \fBeach\-frame\fP as
  11512. second argument (and did not have flags). This syntax is still understood,
  11513. but deprecated and might be removed in the future.
  11514. .sp
  11515. If you combine this command with another one using \fB;\fP, you can use the
  11516. \fBasync\fP flag to make encoding/writing the image file asynchronous. For
  11517. normal standalone commands, this is always asynchronous, and the flag has
  11518. no effect. (This behavior changed with mpv 0.29.0.)
  11519. .TP
  11520. .B \fBscreenshot\-to\-file <filename> <flags>\fP
  11521. Take a screenshot and save it to a given file. The format of the file will
  11522. be guessed by the extension (and \fB\-\-screenshot\-format\fP is ignored \- the
  11523. behavior when the extension is missing or unknown is arbitrary).
  11524. .sp
  11525. The second argument is like the first argument to \fBscreenshot\fP and
  11526. supports \fBsubtitles\fP, \fBvideo\fP, \fBwindow\fP\&.
  11527. .sp
  11528. If the file already exists, it\(aqs overwritten.
  11529. .sp
  11530. Like all input command parameters, the filename is subject to property
  11531. expansion as described in \fI\%Property Expansion\fP\&.
  11532. .TP
  11533. .B \fBplaylist\-next <flags>\fP
  11534. Go to the next entry on the playlist.
  11535. .sp
  11536. First argument:
  11537. .INDENT 7.0
  11538. .TP
  11539. .B weak (default)
  11540. If the last file on the playlist is currently played, do nothing.
  11541. .TP
  11542. .B force
  11543. Terminate playback if there are no more files on the playlist.
  11544. .UNINDENT
  11545. .TP
  11546. .B \fBplaylist\-prev <flags>\fP
  11547. Go to the previous entry on the playlist.
  11548. .sp
  11549. First argument:
  11550. .INDENT 7.0
  11551. .TP
  11552. .B weak (default)
  11553. If the first file on the playlist is currently played, do nothing.
  11554. .TP
  11555. .B force
  11556. Terminate playback if the first file is being played.
  11557. .UNINDENT
  11558. .TP
  11559. .B \fBloadfile <url> [<flags> [<options>]]\fP
  11560. Load the given file or URL and play it.
  11561. .sp
  11562. Second argument:
  11563. .INDENT 7.0
  11564. .TP
  11565. .B <replace> (default)
  11566. Stop playback of the current file, and play the new file immediately.
  11567. .TP
  11568. .B <append>
  11569. Append the file to the playlist.
  11570. .TP
  11571. .B <append\-play>
  11572. Append the file, and if nothing is currently playing, start playback.
  11573. (Always starts with the added file, even if the playlist was not empty
  11574. before running this command.)
  11575. .UNINDENT
  11576. .sp
  11577. The third argument is a list of options and values which should be set
  11578. while the file is playing. It is of the form \fBopt1=value1,opt2=value2,..\fP\&.
  11579. Not all options can be changed this way. Some options require a restart
  11580. of the player.
  11581. .TP
  11582. .B \fBloadlist <url> [<flags>]\fP
  11583. Load the given playlist file or URL (like \fB\-\-playlist\fP).
  11584. .sp
  11585. Second argument:
  11586. .INDENT 7.0
  11587. .TP
  11588. .B <replace> (default)
  11589. Stop playback and replace the internal playlist with the new one.
  11590. .TP
  11591. .B <append>
  11592. Append the new playlist at the end of the current internal playlist.
  11593. .UNINDENT
  11594. .TP
  11595. .B \fBplaylist\-clear\fP
  11596. Clear the playlist, except the currently played file.
  11597. .TP
  11598. .B \fBplaylist\-remove <index>\fP
  11599. Remove the playlist entry at the given index. Index values start counting
  11600. with 0. The special value \fBcurrent\fP removes the current entry. Note that
  11601. removing the current entry also stops playback and starts playing the next
  11602. entry.
  11603. .TP
  11604. .B \fBplaylist\-move <index1> <index2>\fP
  11605. Move the playlist entry at index1, so that it takes the place of the
  11606. entry index2. (Paradoxically, the moved playlist entry will not have
  11607. the index value index2 after moving if index1 was lower than index2,
  11608. because index2 refers to the target entry, not the index the entry
  11609. will have after moving.)
  11610. .TP
  11611. .B \fBplaylist\-shuffle\fP
  11612. Shuffle the playlist. This is similar to what is done on start if the
  11613. \fB\-\-shuffle\fP option is used.
  11614. .TP
  11615. .B \fBplaylist\-unshuffle\fP
  11616. Attempt to revert the previous \fBplaylist\-shuffle\fP command. This works
  11617. only once (multiple successive \fBplaylist\-unshuffle\fP commands do nothing).
  11618. May not work correctly if new recursive playlists have been opened since
  11619. a \fBplaylist\-shuffle\fP command.
  11620. .TP
  11621. .B \fBrun <command> [<arg1> [<arg2> [...]]]\fP
  11622. Run the given command. Unlike in MPlayer/mplayer2 and earlier versions of
  11623. mpv (0.2.x and older), this doesn\(aqt call the shell. Instead, the command
  11624. is run directly, with each argument passed separately. Each argument is
  11625. expanded like in \fI\%Property Expansion\fP\&.
  11626. .sp
  11627. This command has a variable number of arguments, and cannot be used with
  11628. named arguments.
  11629. .sp
  11630. The program is run in a detached way. mpv doesn\(aqt wait until the command
  11631. is completed, but continues playback right after spawning it.
  11632. .sp
  11633. To get the old behavior, use \fB/bin/sh\fP and \fB\-c\fP as the first two
  11634. arguments.
  11635. .INDENT 7.0
  11636. .INDENT 3.5
  11637. .IP "Example"
  11638. .sp
  11639. \fBrun "/bin/sh" "\-c" "echo ${title} > /tmp/playing"\fP
  11640. .sp
  11641. This is not a particularly good example, because it doesn\(aqt handle
  11642. escaping, and a specially prepared file might allow an attacker to
  11643. execute arbitrary shell commands. It is recommended to write a small
  11644. shell script, and call that with \fBrun\fP\&.
  11645. .UNINDENT
  11646. .UNINDENT
  11647. .TP
  11648. .B \fBsubprocess\fP
  11649. Similar to \fBrun\fP, but gives more control about process execution to the
  11650. caller, and does does not detach the process.
  11651. .sp
  11652. You can avoid blocking until the process terminates by running this command
  11653. asynchronously. (For example \fBmp.command_native_async()\fP in Lua scripting.)
  11654. .sp
  11655. This has the following named arguments. The order of them is not guaranteed,
  11656. so you should always call them with named arguments, see \fI\%Named arguments\fP\&.
  11657. .INDENT 7.0
  11658. .TP
  11659. .B \fBargs\fP (\fBMPV_FORMAT_NODE_ARRAY[MPV_FORMAT_STRING]\fP)
  11660. Array of strings with the command as first argument, and subsequent
  11661. command line arguments following. This is just like the \fBrun\fP command
  11662. argument list.
  11663. .sp
  11664. The first array entry is either an absolute path to the executable, or
  11665. a filename with no path components, in which case the \fBPATH\fP
  11666. environment variable. On Unix, this is equivalent to \fBposix_spawnp\fP
  11667. and \fBexecvp\fP behavior.
  11668. .TP
  11669. .B \fBplayback_only\fP (\fBMPV_FORMAT_FLAG\fP)
  11670. Boolean indicating whether the process should be killed when playback
  11671. terminates (optional, default: yes). If enabled, stopping playback
  11672. will automatically kill the process, and you can\(aqt start it outside of
  11673. playback.
  11674. .TP
  11675. .B \fBcapture_size\fP (\fBMPV_FORMAT_INT64\fP)
  11676. Integer setting the maximum number of stdout plus stderr bytes that can
  11677. be captured (optional, default: 64MB). If the number of bytes exceeds
  11678. this, capturing is stopped. The limit is per captured stream.
  11679. .TP
  11680. .B \fBcapture_stdout\fP (\fBMPV_FORMAT_FLAG\fP)
  11681. Capture all data the process outputs to stdout and return it once the
  11682. process ends (optional, default: no).
  11683. .TP
  11684. .B \fBcapture_stderr\fP (\fBMPV_FORMAT_FLAG\fP)
  11685. Same as \fBcapture_stdout\fP, but for stderr.
  11686. .UNINDENT
  11687. .sp
  11688. The command returns the following result (as \fBMPV_FORMAT_NODE_MAP\fP):
  11689. .INDENT 7.0
  11690. .TP
  11691. .B \fBstatus\fP (\fBMPV_FORMAT_INT64\fP)
  11692. The raw exit status of the process. It will be negative on error. The
  11693. meaning of negative values is undefined, other than meaning error (and
  11694. does not necessarily correspond to OS low level exit status values).
  11695. .sp
  11696. On Windows, it can happen that a negative return value is returned
  11697. even if the process exits gracefully, because the win32 \fBUINT\fP exit
  11698. code is assigned to an \fBint\fP variable before being set as \fBint64_t\fP
  11699. field in the result map. This might be fixed later.
  11700. .TP
  11701. .B \fBstdout\fP (\fBMPV_FORMAT_BYTE_ARRAY\fP)
  11702. Captured stdout stream, limited to \fBcapture_size\fP\&.
  11703. .TP
  11704. .B \fBstderr\fP (\fBMPV_FORMAT_BYTE_ARRAY\fP)
  11705. Same as \fBstdout\fP, but for stderr.
  11706. .TP
  11707. .B \fBerror_string\fP (\fBMPV_FORMAT_STRING\fP)
  11708. Empty string if the process exited gracefully. The string \fBkilled\fP if
  11709. the process was terminated in an unusual way. The string \fBinit\fP if the
  11710. process could not be started.
  11711. .sp
  11712. On Windows, \fBkilled\fP is only returned when the process has been
  11713. killed by mpv as a result of \fBplayback_only\fP being set to \fByes\fP\&.
  11714. .TP
  11715. .B \fBkilled_by_us\fP (\fBMPV_FORMAT_FLAG\fP)
  11716. Set to \fByes\fP if the process has been killed by mpv, for example as a
  11717. result of \fBplayback_only\fP being set to \fByes\fP, aborting the command
  11718. (e.g. by \fBmp.abort_async_command()\fP), or if the player is about to
  11719. exit.
  11720. .UNINDENT
  11721. .sp
  11722. Note that the command itself will always return success as long as the
  11723. parameters are correct. Whether the process could be spawned or whether
  11724. it was somehow killed or returned an error status has to be queried from
  11725. the result value.
  11726. .sp
  11727. This command can be asynchronously aborted via API.
  11728. .sp
  11729. In all cases, the subprocess will be terminated on player exit. Also see
  11730. \fI\%Asynchronous command details\fP\&. Only the \fBrun\fP command can start
  11731. processes in a truly detached way.
  11732. .INDENT 7.0
  11733. .INDENT 3.5
  11734. .IP "Warning"
  11735. .sp
  11736. Don\(aqt forget to set the \fBplayback_only\fP field if you want the command
  11737. run while the player is in idle mode, or if you don\(aqt want that end of
  11738. playback kills the command.
  11739. .UNINDENT
  11740. .UNINDENT
  11741. .TP
  11742. .B \fBquit [<code>]\fP
  11743. Exit the player. If an argument is given, it\(aqs used as process exit code.
  11744. .TP
  11745. .B \fBquit\-watch\-later [<code>]\fP
  11746. Exit player, and store current playback position. Playing that file later
  11747. will seek to the previous position on start. The (optional) argument is
  11748. exactly as in the \fBquit\fP command.
  11749. .TP
  11750. .B \fBsub\-add <url> [<flags> [<title> [<lang>]]]\fP
  11751. Load the given subtitle file or stream. By default, it is selected as
  11752. current subtitle  after loading.
  11753. .sp
  11754. The \fBflags\fP argument is one of the following values:
  11755. .sp
  11756. <select>
  11757. .INDENT 7.0
  11758. .INDENT 3.5
  11759. Select the subtitle immediately (default).
  11760. .UNINDENT
  11761. .UNINDENT
  11762. .sp
  11763. <auto>
  11764. .INDENT 7.0
  11765. .INDENT 3.5
  11766. Don\(aqt select the subtitle. (Or in some special situations, let the
  11767. default stream selection mechanism decide.)
  11768. .UNINDENT
  11769. .UNINDENT
  11770. .sp
  11771. <cached>
  11772. .INDENT 7.0
  11773. .INDENT 3.5
  11774. Select the subtitle. If a subtitle with the same filename was already
  11775. added, that one is selected, instead of loading a duplicate entry.
  11776. (In this case, title/language are ignored, and if the was changed since
  11777. it was loaded, these changes won\(aqt be reflected.)
  11778. .UNINDENT
  11779. .UNINDENT
  11780. .sp
  11781. The \fBtitle\fP argument sets the track title in the UI.
  11782. .sp
  11783. The \fBlang\fP argument sets the track language, and can also influence
  11784. stream selection with \fBflags\fP set to \fBauto\fP\&.
  11785. .TP
  11786. .B \fBsub\-remove [<id>]\fP
  11787. Remove the given subtitle track. If the \fBid\fP argument is missing, remove
  11788. the current track. (Works on external subtitle files only.)
  11789. .TP
  11790. .B \fBsub\-reload [<id>]\fP
  11791. Reload the given subtitle tracks. If the \fBid\fP argument is missing, reload
  11792. the current track. (Works on external subtitle files only.)
  11793. .sp
  11794. This works by unloading and re\-adding the subtitle track.
  11795. .TP
  11796. .B \fBsub\-step <skip>\fP
  11797. Change subtitle timing such, that the subtitle event after the next
  11798. \fB<skip>\fP subtitle events is displayed. \fB<skip>\fP can be negative to step
  11799. backwards.
  11800. .TP
  11801. .B \fBsub\-seek <skip>\fP
  11802. Seek to the next (skip set to 1) or the previous (skip set to \-1) subtitle.
  11803. This is similar to \fBsub\-step\fP, except that it seeks video and audio
  11804. instead of adjusting the subtitle delay.
  11805. .sp
  11806. For embedded subtitles (like with Matroska), this works only with subtitle
  11807. events that have already been displayed, or are within a short prefetch
  11808. range.
  11809. .TP
  11810. .B \fBprint\-text <text>\fP
  11811. Print text to stdout. The string can contain properties (see
  11812. \fI\%Property Expansion\fP). Take care to put the argument in quotes.
  11813. .TP
  11814. .B \fBshow\-text <text> [<duration>|\-1 [<level>]]\fP
  11815. Show text on the OSD. The string can contain properties, which are expanded
  11816. as described in \fI\%Property Expansion\fP\&. This can be used to show playback
  11817. time, filename, and so on.
  11818. .INDENT 7.0
  11819. .TP
  11820. .B <duration>
  11821. The time in ms to show the message for. By default, it uses the same
  11822. value as \fB\-\-osd\-duration\fP\&.
  11823. .TP
  11824. .B <level>
  11825. The minimum OSD level to show the text at (see \fB\-\-osd\-level\fP).
  11826. .UNINDENT
  11827. .TP
  11828. .B \fBexpand\-text <string>\fP
  11829. Property\-expand the argument and return the expanded string. This can be
  11830. used only through the client API or from a script using
  11831. \fBmp.command_native\fP\&. (see \fI\%Property Expansion\fP).
  11832. .TP
  11833. .B \fBexpand\-path "<string>"\fP
  11834. Expand a path\(aqs double\-tilde placeholders into a platform\-specific path.
  11835. As \fBexpand\-text\fP, this can only be used through the client API or from
  11836. a script using \fBmp.command_native\fP\&.
  11837. .INDENT 7.0
  11838. .INDENT 3.5
  11839. .IP "Example"
  11840. .sp
  11841. \fBmp.osd_message(mp.command_native({"expand\-path", "~~home/"}))\fP
  11842. .sp
  11843. This line of Lua would show the location of the user\(aqs mpv
  11844. configuration directory on the OSD.
  11845. .UNINDENT
  11846. .UNINDENT
  11847. .TP
  11848. .B \fBshow\-progress\fP
  11849. Show the progress bar, the elapsed time and the total duration of the file
  11850. on the OSD.
  11851. .TP
  11852. .B \fBwrite\-watch\-later\-config\fP
  11853. Write the resume config file that the \fBquit\-watch\-later\fP command writes,
  11854. but continue playback normally.
  11855. .TP
  11856. .B \fBstop\fP
  11857. Stop playback and clear playlist. With default settings, this is
  11858. essentially like \fBquit\fP\&. Useful for the client API: playback can be
  11859. stopped without terminating the player.
  11860. .TP
  11861. .B \fBmouse <x> <y> [<button> [<mode>]]\fP
  11862. Send a mouse event with given coordinate (\fB<x>\fP, \fB<y>\fP).
  11863. .sp
  11864. Second argument:
  11865. .INDENT 7.0
  11866. .TP
  11867. .B <button>
  11868. The button number of clicked mouse button. This should be one of 0\-19.
  11869. If \fB<button>\fP is omitted, only the position will be updated.
  11870. .UNINDENT
  11871. .sp
  11872. Third argument:
  11873. .INDENT 7.0
  11874. .TP
  11875. .B <single> (default)
  11876. The mouse event represents regular single click.
  11877. .TP
  11878. .B <double>
  11879. The mouse event represents double\-click.
  11880. .UNINDENT
  11881. .TP
  11882. .B \fBkeypress <name>\fP
  11883. Send a key event through mpv\(aqs input handler, triggering whatever
  11884. behavior is configured to that key. \fBname\fP uses the \fBinput.conf\fP
  11885. naming scheme for keys and modifiers. Useful for the client API: key events
  11886. can be sent to libmpv to handle internally.
  11887. .TP
  11888. .B \fBkeydown <name>\fP
  11889. Similar to \fBkeypress\fP, but sets the \fBKEYDOWN\fP flag so that if the key is
  11890. bound to a repeatable command, it will be run repeatedly with mpv\(aqs key
  11891. repeat timing until the \fBkeyup\fP command is called.
  11892. .TP
  11893. .B \fBkeyup [<name>]\fP
  11894. Set the \fBKEYUP\fP flag, stopping any repeated behavior that had been
  11895. triggered. \fBname\fP is optional. If \fBname\fP is not given or is an
  11896. empty string, \fBKEYUP\fP will be set on all keys. Otherwise, \fBKEYUP\fP will
  11897. only be set on the key specified by \fBname\fP\&.
  11898. .TP
  11899. .B \fBkeybind <name> <command>\fP
  11900. Binds a key to an input command. \fBcommand\fP must be a complete command
  11901. containing all the desired arguments and flags. Both \fBname\fP and
  11902. \fBcommand\fP use the \fBinput.conf\fP naming scheme. This is primarily
  11903. useful for the client API.
  11904. .TP
  11905. .B \fBaudio\-add <url> [<flags> [<title> [<lang>]]]\fP
  11906. Load the given audio file. See \fBsub\-add\fP command.
  11907. .TP
  11908. .B \fBaudio\-remove [<id>]\fP
  11909. Remove the given audio track. See \fBsub\-remove\fP command.
  11910. .TP
  11911. .B \fBaudio\-reload [<id>]\fP
  11912. Reload the given audio tracks. See \fBsub\-reload\fP command.
  11913. .TP
  11914. .B \fBvideo\-add <url> [<flags> [<title> [<lang>]]]\fP
  11915. Load the given video file. See \fBsub\-add\fP command.
  11916. .TP
  11917. .B \fBvideo\-remove [<id>]\fP
  11918. Remove the given video track. See \fBsub\-remove\fP command.
  11919. .TP
  11920. .B \fBvideo\-reload [<id>]\fP
  11921. Reload the given video tracks. See \fBsub\-reload\fP command.
  11922. .TP
  11923. .B \fBrescan\-external\-files [<mode>]\fP
  11924. Rescan external files according to the current \fB\-\-sub\-auto\fP and
  11925. \fB\-\-audio\-file\-auto\fP settings. This can be used to auto\-load external
  11926. files \fIafter\fP the file was loaded.
  11927. .sp
  11928. The \fBmode\fP argument is one of the following:
  11929. .INDENT 7.0
  11930. .TP
  11931. .B <reselect> (default)
  11932. Select the default audio and subtitle streams, which typically selects
  11933. external files with the highest preference. (The implementation is not
  11934. perfect, and could be improved on request.)
  11935. .TP
  11936. .B <keep\-selection>
  11937. Do not change current track selections.
  11938. .UNINDENT
  11939. .UNINDENT
  11940. .SS Input Commands that are Possibly Subject to Change
  11941. .INDENT 0.0
  11942. .TP
  11943. .B \fBaf <operation> <value>\fP
  11944. Change audio filter chain. See \fBvf\fP command.
  11945. .TP
  11946. .B \fBvf <operation> <value>\fP
  11947. Change video filter chain.
  11948. .sp
  11949. The semantics are exactly the same as with option parsing (see
  11950. \fI\%VIDEO FILTERS\fP). As such the text below is a redundant and incomplete
  11951. summary.
  11952. .sp
  11953. The first argument decides what happens:
  11954. .INDENT 7.0
  11955. .TP
  11956. .B <set>
  11957. Overwrite the previous filter chain with the new one.
  11958. .TP
  11959. .B <add>
  11960. Append the new filter chain to the previous one.
  11961. .TP
  11962. .B <toggle>
  11963. Check if the given filter (with the exact parameters) is already
  11964. in the video chain. If yes, remove the filter. If no, add the filter.
  11965. (If several filters are passed to the command, this is done for
  11966. each filter.)
  11967. .sp
  11968. A special variant is combining this with labels, and using \fB@name\fP
  11969. without filter name and parameters as filter entry. This toggles the
  11970. enable/disable flag.
  11971. .TP
  11972. .B <del>
  11973. Remove the given filters from the video chain. Unlike in the other
  11974. cases, the second parameter is a comma separated list of filter names
  11975. or integer indexes. \fB0\fP would denote the first filter. Negative
  11976. indexes start from the last filter, and \fB\-1\fP denotes the last
  11977. filter. Deprecated.
  11978. .TP
  11979. .B <clr>
  11980. Remove all filters. Note that like the other sub\-commands, this does
  11981. not control automatically inserted filters.
  11982. .UNINDENT
  11983. .sp
  11984. The argument is always needed. E.g. in case of \fBclr\fP use \fBvf clr ""\fP\&.
  11985. .sp
  11986. You can assign labels to filter by prefixing them with \fB@name:\fP (where
  11987. \fBname\fP is a user\-chosen arbitrary identifier). Labels can be used to
  11988. refer to filters by name in all of the filter chain modification commands.
  11989. For \fBadd\fP, using an already used label will replace the existing filter.
  11990. .sp
  11991. The \fBvf\fP command shows the list of requested filters on the OSD after
  11992. changing the filter chain. This is roughly equivalent to
  11993. \fBshow\-text ${vf}\fP\&. Note that auto\-inserted filters for format conversion
  11994. are not shown on the list, only what was requested by the user.
  11995. .sp
  11996. Normally, the commands will check whether the video chain is recreated
  11997. successfully, and will undo the operation on failure. If the command is run
  11998. before video is configured (can happen if the command is run immediately
  11999. after opening a file and before a video frame is decoded), this check can\(aqt
  12000. be run. Then it can happen that creating the video chain fails.
  12001. .INDENT 7.0
  12002. .INDENT 3.5
  12003. .IP "Example for input.conf"
  12004. .INDENT 0.0
  12005. .IP \(bu 2
  12006. \fBa vf set flip\fP turn video upside\-down on the \fBa\fP key
  12007. .IP \(bu 2
  12008. \fBb vf set ""\fP remove all video filters on \fBb\fP
  12009. .IP \(bu 2
  12010. \fBc vf toggle gradfun\fP toggle debanding on \fBc\fP
  12011. .UNINDENT
  12012. .UNINDENT
  12013. .UNINDENT
  12014. .INDENT 7.0
  12015. .INDENT 3.5
  12016. .IP "Example how to toggle disabled filters at runtime"
  12017. .INDENT 0.0
  12018. .IP \(bu 2
  12019. Add something like \fBvf\-add=@deband:!gradfun\fP to \fBmpv.conf\fP\&.
  12020. The \fB@deband:\fP is the label, an arbitrary, user\-given name for this
  12021. filter entry. The \fB!\fP before the filter name disables the filter by
  12022. default. Everything after this is the normal filter name and possibly
  12023. filter parameters, like in the normal \fB\-\-vf\fP syntax.
  12024. .IP \(bu 2
  12025. Add \fBa vf toggle @deband\fP to \fBinput.conf\fP\&. This toggles the
  12026. "disabled" flag for the filter with the label \fBdeband\fP when the
  12027. \fBa\fP key is hit.
  12028. .UNINDENT
  12029. .UNINDENT
  12030. .UNINDENT
  12031. .TP
  12032. .B \fBcycle\-values [<"!reverse">] <property> <value1> [<value2> [...]]\fP
  12033. Cycle through a list of values. Each invocation of the command will set the
  12034. given property to the next value in the list. The command will use the
  12035. current value of the property/option, and use it to determine the current
  12036. position in the list of values. Once it has found it, it will set the
  12037. next value in the list (wrapping around to the first item if needed).
  12038. .sp
  12039. This command has a variable number of arguments, and cannot be used with
  12040. named arguments.
  12041. .sp
  12042. The special argument \fB!reverse\fP can be used to cycle the value list in
  12043. reverse. The only advantage is that you don\(aqt need to reverse the value
  12044. list yourself when adding a second key binding for cycling backwards.
  12045. .TP
  12046. .B \fBenable\-section <name> [<flags>]\fP
  12047. This command is deprecated, except for mpv\-internal uses.
  12048. .sp
  12049. Enable all key bindings in the named input section.
  12050. .sp
  12051. The enabled input sections form a stack. Bindings in sections on the top of
  12052. the stack are preferred to lower sections. This command puts the section
  12053. on top of the stack. If the section was already on the stack, it is
  12054. implicitly removed beforehand. (A section cannot be on the stack more than
  12055. once.)
  12056. .sp
  12057. The \fBflags\fP parameter can be a combination (separated by \fB+\fP) of the
  12058. following flags:
  12059. .INDENT 7.0
  12060. .TP
  12061. .B <exclusive>
  12062. All sections enabled before the newly enabled section are disabled.
  12063. They will be re\-enabled as soon as all exclusive sections above them
  12064. are removed. In other words, the new section shadows all previous
  12065. sections.
  12066. .TP
  12067. .B <allow\-hide\-cursor>
  12068. This feature can\(aqt be used through the public API.
  12069. .TP
  12070. .B <allow\-vo\-dragging>
  12071. Same.
  12072. .UNINDENT
  12073. .TP
  12074. .B \fBdisable\-section <name>\fP
  12075. This command is deprecated, except for mpv\-internal uses.
  12076. .sp
  12077. Disable the named input section. Undoes \fBenable\-section\fP\&.
  12078. .TP
  12079. .B \fBdefine\-section <name> <contents> [<flags>]\fP
  12080. This command is deprecated, except for mpv\-internal uses.
  12081. .sp
  12082. Create a named input section, or replace the contents of an already existing
  12083. input section. The \fBcontents\fP parameter uses the same syntax as the
  12084. \fBinput.conf\fP file (except that using the section syntax in it is not
  12085. allowed), including the need to separate bindings with a newline character.
  12086. .sp
  12087. If the \fBcontents\fP parameter is an empty string, the section is removed.
  12088. .sp
  12089. The section with the name \fBdefault\fP is the normal input section.
  12090. .sp
  12091. In general, input sections have to be enabled with the \fBenable\-section\fP
  12092. command, or they are ignored.
  12093. .sp
  12094. The last parameter has the following meaning:
  12095. .INDENT 7.0
  12096. .TP
  12097. .B <default> (also used if parameter omitted)
  12098. Use a key binding defined by this section only if the user hasn\(aqt
  12099. already bound this key to a command.
  12100. .TP
  12101. .B <force>
  12102. Always bind a key. (The input section that was made active most recently
  12103. wins if there are ambiguities.)
  12104. .UNINDENT
  12105. .sp
  12106. This command can be used to dispatch arbitrary keys to a script or a client
  12107. API user. If the input section defines \fBscript\-binding\fP commands, it is
  12108. also possible to get separate events on key up/down, and relatively detailed
  12109. information about the key state. The special key name \fBunmapped\fP can be
  12110. used to match any unmapped key.
  12111. .TP
  12112. .B \fBoverlay\-add <id> <x> <y> <file> <offset> <fmt> <w> <h> <stride>\fP
  12113. Add an OSD overlay sourced from raw data. This might be useful for scripts
  12114. and applications controlling mpv, and which want to display things on top
  12115. of the video window.
  12116. .sp
  12117. Overlays are usually displayed in screen resolution, but with some VOs,
  12118. the resolution is reduced to that of the video\(aqs. You can read the
  12119. \fBosd\-width\fP and \fBosd\-height\fP properties. At least with \fB\-\-vo\-xv\fP and
  12120. anamorphic video (such as DVD), \fBosd\-par\fP should be read as well, and the
  12121. overlay should be aspect\-compensated.
  12122. .sp
  12123. This has the following named arguments. The order of them is not guaranteed,
  12124. so you should always call them with named arguments, see \fI\%Named arguments\fP\&.
  12125. .sp
  12126. \fBid\fP is an integer between 0 and 63 identifying the overlay element. The
  12127. ID can be used to add multiple overlay parts, update a part by using this
  12128. command with an already existing ID, or to remove a part with
  12129. \fBoverlay\-remove\fP\&. Using a previously unused ID will add a new overlay,
  12130. while reusing an ID will update it.
  12131. .sp
  12132. \fBx\fP and \fBy\fP specify the position where the OSD should be displayed.
  12133. .sp
  12134. \fBfile\fP specifies the file the raw image data is read from. It can be
  12135. either a numeric UNIX file descriptor prefixed with \fB@\fP (e.g. \fB@4\fP),
  12136. or a filename. The file will be mapped into memory with \fBmmap()\fP,
  12137. copied, and unmapped before the command returns (changed in mpv 0.18.1).
  12138. .sp
  12139. It is also possible to pass a raw memory address for use as bitmap memory
  12140. by passing a memory address as integer prefixed with an \fB&\fP character.
  12141. Passing the wrong thing here will crash the player. This mode might be
  12142. useful for use with libmpv. The \fBoffset\fP parameter is simply added to the
  12143. memory address (since mpv 0.8.0, ignored before).
  12144. .sp
  12145. \fBoffset\fP is the byte offset of the first pixel in the source file.
  12146. (The current implementation always mmap\(aqs the whole file from position 0 to
  12147. the end of the image, so large offsets should be avoided. Before mpv 0.8.0,
  12148. the offset was actually passed directly to \fBmmap\fP, but it was changed to
  12149. make using it easier.)
  12150. .sp
  12151. \fBfmt\fP is a string identifying the image format. Currently, only \fBbgra\fP
  12152. is defined. This format has 4 bytes per pixels, with 8 bits per component.
  12153. The least significant 8 bits are blue, and the most significant 8 bits
  12154. are alpha (in little endian, the components are B\-G\-R\-A, with B as first
  12155. byte). This uses premultiplied alpha: every color component is already
  12156. multiplied with the alpha component. This means the numeric value of each
  12157. component is equal to or smaller than the alpha component. (Violating this
  12158. rule will lead to different results with different VOs: numeric overflows
  12159. resulting from blending broken alpha values is considered something that
  12160. shouldn\(aqt happen, and consequently implementations don\(aqt ensure that you
  12161. get predictable behavior in this case.)
  12162. .sp
  12163. \fBw\fP, \fBh\fP, and \fBstride\fP specify the size of the overlay. \fBw\fP is the
  12164. visible width of the overlay, while \fBstride\fP gives the width in bytes in
  12165. memory. In the simple case, and with the \fBbgra\fP format, \fBstride==4*w\fP\&.
  12166. In general, the total amount of memory accessed is \fBstride * h\fP\&.
  12167. (Technically, the minimum size would be \fBstride * (h \- 1) + w * 4\fP, but
  12168. for simplicity, the player will access all \fBstride * h\fP bytes.)
  12169. .sp
  12170. \fBNOTE:\fP
  12171. .INDENT 7.0
  12172. .INDENT 3.5
  12173. Before mpv 0.18.1, you had to do manual "double buffering" when updating
  12174. an overlay by replacing it with a different memory buffer. Since mpv
  12175. 0.18.1, the memory is simply copied and doesn\(aqt reference any of the
  12176. memory indicated by the command\(aqs arguments after the commend returns.
  12177. If you want to use this command before mpv 0.18.1, reads the old docs
  12178. to see how to handle this correctly.
  12179. .UNINDENT
  12180. .UNINDENT
  12181. .TP
  12182. .B \fBoverlay\-remove <id>\fP
  12183. Remove an overlay added with \fBoverlay\-add\fP and the same ID. Does nothing
  12184. if no overlay with this ID exists.
  12185. .TP
  12186. .B \fBosd\-overlay\fP
  12187. Add/update/remove an OSD overlay.
  12188. .sp
  12189. (Although this sounds similar to \fBoverlay\-add\fP, \fBosd\-overlay\fP is for
  12190. text overlays, while \fBoverlay\-add\fP is for bitmaps. Maybe \fBoverlay\-add\fP
  12191. will be merged into \fBosd\-overlay\fP to remove this oddity.)
  12192. .sp
  12193. You can use this to add text overlays in ASS format. ASS has advanced
  12194. positioning and rendering tags, which can be used to render almost any kind
  12195. of vector graphics.
  12196. .sp
  12197. This command accepts the following parameters:
  12198. .INDENT 7.0
  12199. .TP
  12200. .B \fBid\fP
  12201. Arbitrary integer that identifies the overlay. Multiple overlays can be
  12202. added by calling this command with different \fBid\fP parameters. Calling
  12203. this command with the same \fBid\fP replaces the previously set overlay.
  12204. .sp
  12205. There is a separate namespace for each libmpv client (i.e. IPC
  12206. connection, script), so IDs can be made up and assigned by the API user
  12207. without conflicting with other API users.
  12208. .sp
  12209. If the libmpv client is destroyed, all overlays associated with it are
  12210. also deleted. In particular, connecting via \fB\-\-input\-ipc\-server\fP,
  12211. adding an overlay, and disconnecting will remove the overlay immediately
  12212. again.
  12213. .TP
  12214. .B \fBformat\fP
  12215. String that gives the type of the overlay. Accepts the following values:
  12216. .INDENT 7.0
  12217. .TP
  12218. .B \fBass\-events\fP
  12219. The \fBdata\fP parameter is a string. The string is split on the
  12220. newline character. Every line is turned into the \fBText\fP part of
  12221. a \fBDialogue\fP ASS event. Timing is unused (but behavior of timing
  12222. dependent ASS tags may change in future mpv versions).
  12223. .sp
  12224. Note that it\(aqs better to put multiple lines into \fBdata\fP, instead
  12225. of adding multiple OSD overlays.
  12226. .sp
  12227. This provides 2 ASS \fBStyles\fP\&. \fBOSD\fP contains the text style as
  12228. defined by the current \fB\-\-osd\-...\fP options. \fBDefault\fP is
  12229. similar, and contains style that \fBOSD\fP would have if all options
  12230. were set to the default.
  12231. .sp
  12232. In addition, the \fBres_x\fP and \fBres_y\fP options specify the value
  12233. of the ASS \fBPlayResX\fP and \fBPlayResY\fP header fields. If \fBres_y\fP
  12234. is set to 0, \fBPlayResY\fP is initialized to an arbitrary default
  12235. value (but note that the default for this command is 720, not 0).
  12236. If \fBres_x\fP is set to 0, \fBPlayResX\fP is set based on \fBres_y\fP
  12237. such that a virtual ASS pixel has a square pixel aspect ratio.
  12238. .TP
  12239. .B \fBnone\fP
  12240. Special value that causes the overlay to be removed. Most parameters
  12241. other than \fBid\fP and \fBformat\fP are mostly ignored.
  12242. .UNINDENT
  12243. .TP
  12244. .B \fBdata\fP
  12245. String defining the overlay contents according to the \fBformat\fP
  12246. parameter.
  12247. .TP
  12248. .B \fBres_x\fP, \fBres_y\fP
  12249. Used if \fBformat\fP is set to \fBass\-events\fP (see description there).
  12250. Optional, defaults to 0/720.
  12251. .TP
  12252. .B \fBz\fP
  12253. The Z order of the overlay. Optional, defaults to 0.
  12254. .sp
  12255. Note that Z order between different overlays of different formats is
  12256. static, and cannot be changed (currently, this means that bitmap
  12257. overlays added by \fBoverlay\-add\fP are always on top of the ASS overlays
  12258. added by \fBosd\-overlay\fP). In addition, the builtin OSD components are
  12259. always below any of the custom OSD. (This includes subtitles of any kind
  12260. as well as text rendered by \fBshow\-text\fP\&.)
  12261. .sp
  12262. It\(aqs possible that future mpv versions will randomly change how Z order
  12263. between different OSD formats and builtin OSD is handled.
  12264. .UNINDENT
  12265. .sp
  12266. Note: always use named arguments (\fBmpv_command_node()\fP). Scripts should
  12267. use the \fBmp.create_osd_overlay()\fP helper instead of invoking this command
  12268. directly.
  12269. .TP
  12270. .B \fBscript\-message [<arg1> [<arg2> [...]]]\fP
  12271. Send a message to all clients, and pass it the following list of arguments.
  12272. What this message means, how many arguments it takes, and what the arguments
  12273. mean is fully up to the receiver and the sender. Every client receives the
  12274. message, so be careful about name clashes (or use \fBscript\-message\-to\fP).
  12275. .sp
  12276. This command has a variable number of arguments, and cannot be used with
  12277. named arguments.
  12278. .TP
  12279. .B \fBscript\-message\-to <target> [<arg1> [<arg2> [...]]]\fP
  12280. Same as \fBscript\-message\fP, but send it only to the client named
  12281. \fB<target>\fP\&. Each client (scripts etc.) has a unique name. For example,
  12282. Lua scripts can get their name via \fBmp.get_script_name()\fP\&.
  12283. .sp
  12284. This command has a variable number of arguments, and cannot be used with
  12285. named arguments.
  12286. .TP
  12287. .B \fBscript\-binding <name>\fP
  12288. Invoke a script\-provided key binding. This can be used to remap key
  12289. bindings provided by external Lua scripts.
  12290. .sp
  12291. The argument is the name of the binding.
  12292. .sp
  12293. It can optionally be prefixed with the name of the script, using \fB/\fP as
  12294. separator, e.g. \fBscript\-binding scriptname/bindingname\fP\&.
  12295. .sp
  12296. For completeness, here is how this command works internally. The details
  12297. could change any time. On any matching key event, \fBscript\-message\-to\fP
  12298. or \fBscript\-message\fP is called (depending on whether the script name is
  12299. included), with the following arguments:
  12300. .INDENT 7.0
  12301. .IP 1. 3
  12302. The string \fBkey\-binding\fP\&.
  12303. .IP 2. 3
  12304. The name of the binding (as established above).
  12305. .IP 3. 3
  12306. The key state as string (see below).
  12307. .IP 4. 3
  12308. The key name (since mpv 0.15.0).
  12309. .IP 5. 3
  12310. The text the key would produce, or empty string if not applicable.
  12311. .UNINDENT
  12312. .sp
  12313. The 5th argument is only set if no modifiers are present (using the shift
  12314. key with a letter is normally not emitted as having a modifier, and results
  12315. in upper case text instead, but some backends may mess up).
  12316. .sp
  12317. The key state consists of 2 characters:
  12318. .INDENT 7.0
  12319. .IP 1. 3
  12320. One of \fBd\fP (key was pressed down), \fBu\fP (was released), \fBr\fP (key
  12321. is still down, and was repeated; only if key repeat is enabled for this
  12322. binding), \fBp\fP (key was pressed; happens if up/down can\(aqt be tracked).
  12323. .IP 2. 3
  12324. Whether the event originates from the mouse, either \fBm\fP (mouse button)
  12325. or \fB\-\fP (something else).
  12326. .UNINDENT
  12327. .sp
  12328. Future versions can add more arguments and more key state characters to
  12329. support more input peculiarities.
  12330. .TP
  12331. .B \fBab\-loop\fP
  12332. Cycle through A\-B loop states. The first command will set the \fBA\fP point
  12333. (the \fBab\-loop\-a\fP property); the second the \fBB\fP point, and the third
  12334. will clear both points.
  12335. .TP
  12336. .B \fBdrop\-buffers\fP
  12337. Drop audio/video/demuxer buffers, and restart from fresh. Might help with
  12338. unseekable streams that are going out of sync.
  12339. This command might be changed or removed in the future.
  12340. .TP
  12341. .B \fBscreenshot\-raw [<flags>]\fP
  12342. Return a screenshot in memory. This can be used only through the client
  12343. API. The MPV_FORMAT_NODE_MAP returned by this command has the \fBw\fP, \fBh\fP,
  12344. \fBstride\fP fields set to obvious contents. The \fBformat\fP field is set to
  12345. \fBbgr0\fP by default. This format is organized as \fBB8G8R8X8\fP (where \fBB\fP
  12346. is the LSB). The contents of the padding \fBX\fP are undefined. The \fBdata\fP
  12347. field is of type MPV_FORMAT_BYTE_ARRAY with the actual image data. The image
  12348. is freed as soon as the result mpv_node is freed. As usual with client API
  12349. semantics, you are not allowed to write to the image data.
  12350. .sp
  12351. The \fBstride\fP is the number of bytes from a pixel at \fB(x0, y0)\fP to the
  12352. pixel at \fB(x0, y0 + 1)\fP\&. This can be larger than \fBw * 4\fP if the image
  12353. was cropped, or if there is padding. This number can be negative as well.
  12354. You access a pixel with \fBbyte_index = y * stride + x * 4\fP (assuming the
  12355. \fBbgr0\fP format).
  12356. .sp
  12357. The \fBflags\fP argument is like the first argument to \fBscreenshot\fP and
  12358. supports \fBsubtitles\fP, \fBvideo\fP, \fBwindow\fP\&.
  12359. .TP
  12360. .B \fBvf\-command <label> <command> <argument>\fP
  12361. Send a command to the filter with the given \fB<label>\fP\&. Use \fBall\fP to send
  12362. it to all filters at once. The command and argument string is filter
  12363. specific. Currently, this only works with the \fBlavfi\fP filter \- see
  12364. the libavfilter documentation for which commands a filter supports.
  12365. .sp
  12366. Note that the \fB<label>\fP is a mpv filter label, not a libavfilter filter
  12367. name.
  12368. .TP
  12369. .B \fBaf\-command <label> <command> <argument>\fP
  12370. Same as \fBvf\-command\fP, but for audio filters.
  12371. .TP
  12372. .B \fBapply\-profile <name>\fP
  12373. Apply the contents of a named profile. This is like using \fBprofile=name\fP
  12374. in a config file, except you can map it to a key binding to change it at
  12375. runtime.
  12376. .sp
  12377. There is no such thing as "unapplying" a profile \- applying a profile
  12378. merely sets all option values listed within the profile.
  12379. .TP
  12380. .B \fBload\-script <filename>\fP
  12381. Load a script, similar to the \fB\-\-script\fP option. Whether this waits for
  12382. the script to finish initialization or not changed multiple times, and the
  12383. future behavior is left undefined.
  12384. .TP
  12385. .B \fBchange\-list <name> <operation> <value>\fP
  12386. This command changes list options as described in \fI\%List Options\fP\&. The
  12387. \fB<name>\fP parameter is the normal option name, while \fB<operation>\fP is
  12388. the suffix or action used on the option.
  12389. .sp
  12390. Some operations take no value, but the command still requires the value
  12391. parameter. In these cases, the value must be an empty string.
  12392. .INDENT 7.0
  12393. .INDENT 3.5
  12394. .IP "Example"
  12395. .sp
  12396. \fBchange\-list glsl\-shaders append file.glsl\fP
  12397. .sp
  12398. Add a filename to the \fBglsl\-shaders\fP list. The command line
  12399. equivalent is \fB\-\-glsl\-shaders\-append=file.glsl\fP or alternatively
  12400. \fB\-\-glsl\-shader=file.glsl\fP\&.
  12401. .UNINDENT
  12402. .UNINDENT
  12403. .TP
  12404. .B \fBdump\-cache <start> <end> <filename>\fP
  12405. Dump the current cache to the given filename. The \fB<filename>\fP file is
  12406. overwritten if it already exists. \fB<start>\fP and \fB<end>\fP give the
  12407. time range of what to dump. If no data is cached at the given time range,
  12408. nothing may be dumped (creating a file with no packets).
  12409. .sp
  12410. Dumping a larger part of the cache will freeze the player. No effort was
  12411. made to fix this, as this feature was meant mostly for creating small
  12412. excerpts.
  12413. .sp
  12414. See \fB\-\-stream\-record\fP for various caveats that mostly apply to this
  12415. command too, as both use the same underlying code for writing the output
  12416. file.
  12417. .sp
  12418. If \fB<filename>\fP is an empty string, an ongoing \fBdump\-cache\fP is stopped.
  12419. .sp
  12420. If \fB<end>\fP is \fBno\fP, then continuous dumping is enabled. Then, after
  12421. dumping the existing parts of the cache, anything read from network is
  12422. appended to the cache as well. This behaves similar to \fB\-\-stream\-record\fP
  12423. (although it does not conflict with that option, and they can be both active
  12424. at the same time).
  12425. .sp
  12426. If the \fB<end>\fP time is after the cache, the command will _not_ wait and
  12427. write newly received data to it.
  12428. .sp
  12429. The end of the resulting file may be slightly damaged or incomplete at the
  12430. end. (Not enough effort was made to ensure that the end lines up properly.)
  12431. .sp
  12432. Note that this command will finish only once dumping ends. That means it
  12433. works similar to the \fBscreenshot\fP command, just that it can block much
  12434. longer. If continuous dumping is used, the command will not finish until
  12435. playback is stopped, an error happens, another \fBdump\-cache\fP command is
  12436. run, or an API like \fBmp.abort_async_command\fP was called to explicitly stop
  12437. the command. See \fI\%Synchronous vs. Asynchronous\fP\&.
  12438. .sp
  12439. \fBNOTE:\fP
  12440. .INDENT 7.0
  12441. .INDENT 3.5
  12442. This was mostly created for network streams. For local files, there may
  12443. be much better methods to create excerpts and such. There are tons of
  12444. much more user\-friendly Lua scripts, that will reencode parts of a file
  12445. by spawning a separate instance of \fBffmpeg\fP\&. With network streams,
  12446. this is not that easily possible, as the stream would have to be
  12447. downloaded again. Even if \fB\-\-stream\-record\fP is used to record the
  12448. stream to the local filesystem, there may be problems, because the
  12449. recorded file is still written to.
  12450. .UNINDENT
  12451. .UNINDENT
  12452. .sp
  12453. This command is experimental, and all details about it may change in the
  12454. future.
  12455. .TP
  12456. .B \fBab\-loop\-dump\-cache <filename>\fP
  12457. Essentially calls \fBdump\-cache\fP with the current AB\-loop points as
  12458. arguments. Like \fBdump\-cache\fP, this will overwrite the file at
  12459. \fB<filename>\fP\&. Likewise, if the B point is set to \fBno\fP, it will enter
  12460. continuous dumping after the existing cache was dumped.
  12461. .sp
  12462. The author reserves the right to remove this command if enough motivation
  12463. is found to move this functionality to a trivial Lua script.
  12464. .TP
  12465. .B \fBab\-loop\-align\-cache\fP
  12466. Re\-adjust the A/B loop points to the start and end within the cache the
  12467. \fBab\-loop\-dump\-cache\fP command will (probably) dump. Basically, it aligns
  12468. the times on keyframes. The guess might be off especially at the end (due to
  12469. granularity issues due to remuxing). If the cache shrinks in the meantime,
  12470. the points set by the command will not be the effective parameters either.
  12471. .sp
  12472. This command has an even more uncertain future than \fBab\-loop\-dump\-cache\fP
  12473. and might disappear without replacement if the author decides it\(aqs useless.
  12474. .UNINDENT
  12475. .sp
  12476. Undocumented commands: \fBao\-reload\fP (experimental/internal).
  12477. .SS Hooks
  12478. .sp
  12479. Hooks are synchronous events between player core and a script or similar. This
  12480. applies to client API (including the Lua scripting interface). Normally,
  12481. events are supposed to be asynchronous, and the hook API provides an awkward
  12482. and obscure way to handle events that require stricter coordination. There are
  12483. no API stability guarantees made. Not following the protocol exactly can make
  12484. the player freeze randomly. Basically, nobody should use this API.
  12485. .sp
  12486. The C API is described in the header files. The Lua API is described in the
  12487. Lua section.
  12488. .sp
  12489. The following hooks are currently defined:
  12490. .INDENT 0.0
  12491. .TP
  12492. .B \fBon_load\fP
  12493. Called when a file is to be opened, before anything is actually done.
  12494. For example, you could read and write the \fBstream\-open\-filename\fP
  12495. property to redirect an URL to something else (consider support for
  12496. streaming sites which rarely give the user a direct media URL), or
  12497. you could set per\-file options with by setting the property
  12498. \fBfile\-local\-options/<option name>\fP\&. The player will wait until all
  12499. hooks are run.
  12500. .TP
  12501. .B \fBon_load_fail\fP
  12502. Called after after a file has been opened, but failed to. This can be
  12503. used to provide a fallback in case native demuxers failed to recognize
  12504. the file, instead of always running before the native demuxers like
  12505. \fBon_load\fP\&. Demux will only be retried if \fBstream\-open\-filename\fP
  12506. was changed.
  12507. .TP
  12508. .B \fBon_preloaded\fP
  12509. Called after a file has been opened, and before tracks are selected and
  12510. decoders are created. This has some usefulness if an API users wants
  12511. to select tracks manually, based on the set of available tracks. It\(aqs
  12512. also useful to initialize \fB\-\-lavfi\-complex\fP in a specific way by API,
  12513. without having to "probe" the available streams at first.
  12514. .sp
  12515. Note that this does not yet apply default track selection. Which operations
  12516. exactly can be done and not be done, and what information is available and
  12517. what is not yet available yet, is all subject to change.
  12518. .TP
  12519. .B \fBon_unload\fP
  12520. Run before closing a file, and before actually uninitializing
  12521. everything. It\(aqs not possible to resume playback in this state.
  12522. .UNINDENT
  12523. .SS Legacy hook API
  12524. .sp
  12525. \fBWARNING:\fP
  12526. .INDENT 0.0
  12527. .INDENT 3.5
  12528. The legacy API is deprecated and will be removed soon.
  12529. .UNINDENT
  12530. .UNINDENT
  12531. .sp
  12532. There are two special commands involved. Also, the client must listen for
  12533. client messages (\fBMPV_EVENT_CLIENT_MESSAGE\fP in the C API).
  12534. .INDENT 0.0
  12535. .TP
  12536. .B \fBhook\-add <hook\-name> <id> <priority>\fP
  12537. Subscribe to the hook identified by the first argument (basically, the
  12538. name of event). The \fBid\fP argument is an arbitrary integer chosen by the
  12539. user. \fBpriority\fP is used to sort all hook handlers globally across all
  12540. clients. Each client can register multiple hook handlers (even for the
  12541. same hook\-name). Once the hook is registered, it cannot be unregistered.
  12542. .sp
  12543. When a specific event happens, all registered handlers are run serially.
  12544. This uses a protocol every client has to follow explicitly. When a hook
  12545. handler is run, a client message (\fBMPV_EVENT_CLIENT_MESSAGE\fP) is sent to
  12546. the client which registered the hook. This message has the following
  12547. arguments:
  12548. .INDENT 7.0
  12549. .IP 1. 3
  12550. the string \fBhook_run\fP
  12551. .IP 2. 3
  12552. the \fBid\fP argument the hook was registered with as string (this can be
  12553. used to correctly handle multiple hooks registered by the same client,
  12554. as long as the \fBid\fP argument is unique in the client)
  12555. .IP 3. 3
  12556. something undefined, used by the hook mechanism to track hook execution
  12557. .UNINDENT
  12558. .sp
  12559. Upon receiving this message, the client can handle the event. While doing
  12560. this, the player core will still react to requests, but playback will
  12561. typically be stopped.
  12562. .sp
  12563. When the client is done, it must continue the core\(aqs hook execution by
  12564. running the \fBhook\-ack\fP command.
  12565. .TP
  12566. .B \fBhook\-ack <string>\fP
  12567. Run the next hook in the global chain of hooks. The argument is the 3rd
  12568. argument of the client message that starts hook execution for the
  12569. current client.
  12570. .UNINDENT
  12571. .SS Input Command Prefixes
  12572. .sp
  12573. These prefixes are placed between key name and the actual command. Multiple
  12574. prefixes can be specified. They are separated by whitespace.
  12575. .INDENT 0.0
  12576. .TP
  12577. .B \fBosd\-auto\fP
  12578. Use the default behavior for this command. This is the default for
  12579. \fBinput.conf\fP commands. Some libmpv/scripting/IPC APIs do not use this as
  12580. default, but use \fBno\-osd\fP instead.
  12581. .TP
  12582. .B \fBno\-osd\fP
  12583. Do not use any OSD for this command.
  12584. .TP
  12585. .B \fBosd\-bar\fP
  12586. If possible, show a bar with this command. Seek commands will show the
  12587. progress bar, property changing commands may show the newly set value.
  12588. .TP
  12589. .B \fBosd\-msg\fP
  12590. If possible, show an OSD message with this command. Seek command show
  12591. the current playback time, property changing commands show the newly set
  12592. value as text.
  12593. .TP
  12594. .B \fBosd\-msg\-bar\fP
  12595. Combine osd\-bar and osd\-msg.
  12596. .TP
  12597. .B \fBraw\fP
  12598. Do not expand properties in string arguments. (Like \fB"${property\-name}"\fP\&.)
  12599. This is the default for some libmpv/scripting/IPC APIs.
  12600. .TP
  12601. .B \fBexpand\-properties\fP
  12602. All string arguments are expanded as described in \fI\%Property Expansion\fP\&.
  12603. This is the default for \fBinput.conf\fP commands.
  12604. .TP
  12605. .B \fBrepeatable\fP
  12606. For some commands, keeping a key pressed doesn\(aqt run the command repeatedly.
  12607. This prefix forces enabling key repeat in any case.
  12608. .TP
  12609. .B \fBasync\fP
  12610. Allow asynchronous execution (if possible). Note that only a few commands
  12611. will support this (usually this is explicitly documented). Some commands
  12612. are asynchronous by default (or rather, their effects might manifest
  12613. after completion of the command). The semantics of this flag might change
  12614. in the future. Set it only if you don\(aqt rely on the effects of this command
  12615. being fully realized when it returns. See \fI\%Synchronous vs. Asynchronous\fP\&.
  12616. .TP
  12617. .B \fBsync\fP
  12618. Allow synchronous execution (if possible). Normally, all commands are
  12619. synchronous by default, but some are asynchronous by default for
  12620. compatibility with older behavior.
  12621. .UNINDENT
  12622. .sp
  12623. All of the osd prefixes are still overridden by the global \fB\-\-osd\-level\fP
  12624. settings.
  12625. .SS Synchronous vs. Asynchronous
  12626. .sp
  12627. The \fBasync\fP and \fBsync\fP prefix matter only for how the issuer of the command
  12628. waits on the completion of the command. Normally it does not affect how the
  12629. command behaves by itself. There are the following cases:
  12630. .INDENT 0.0
  12631. .IP \(bu 2
  12632. Normal input.conf commands are always run asynchronously. Slow running
  12633. commands are queued up or run in parallel.
  12634. .IP \(bu 2
  12635. "Multi" input.conf commands (1 key binding, concatenated with \fB;\fP) will be
  12636. executed in order, except for commands that are async (either prefixed with
  12637. \fBasync\fP, or async by default for some commands). The async commands are
  12638. run in a detached manner, possibly in parallel to the remaining sync commands
  12639. in the list.
  12640. .IP \(bu 2
  12641. Normal Lua and libmpv commands (e.g. \fBmpv_command()\fP) are run in a blocking
  12642. manner, unless the \fBasync\fP prefix is used, or the command is async by
  12643. default. This means in the sync case the caller will block, even if the core
  12644. continues playback. Async mode runs the command in a detached manner.
  12645. .IP \(bu 2
  12646. Async libmpv command API (e.g. \fBmpv_command_async()\fP) never blocks the
  12647. caller, and always notify their completion with a message. The \fBsync\fP and
  12648. \fBasync\fP prefixes make no difference.
  12649. .IP \(bu 2
  12650. Lua also provides APIs for running async commands, which behave similar to the
  12651. C counterparts.
  12652. .IP \(bu 2
  12653. In all cases, async mode can still run commands in a synchronous manner, even
  12654. in detached mode. This can for example happen in cases when a command does not
  12655. have an  asynchronous implementation. The async libmpv API still never blocks
  12656. the caller in these cases.
  12657. .UNINDENT
  12658. .sp
  12659. Before mpv 0.29.0, the \fBasync\fP prefix was only used by screenshot commands,
  12660. and made them run the file saving code in a detached manner. This is the
  12661. default now, and \fBasync\fP changes behavior only in the ways mentioned above.
  12662. .sp
  12663. Currently the following commands have different waiting characteristics with
  12664. sync vs. async: sub\-add, audio\-add, sub\-reload, audio\-reload,
  12665. rescan\-external\-files, screenshot, screenshot\-to\-file, dump\-cache,
  12666. ab\-loop\-dump\-cache.
  12667. .SS Asynchronous command details
  12668. .sp
  12669. On the API level, every asynchronous command is bound to the context which
  12670. started it. For example, an asynchronous command started by \fBmpv_command_async\fP
  12671. is bound to the \fBmpv_handle\fP passed to the function. Only this \fBmpv_handle\fP
  12672. receives the completion notification (\fBMPV_EVENT_COMMAND_REPLY\fP), and only
  12673. this handle can abort a still running command directly. If the \fBmpv_handle\fP is
  12674. destroyed, any still running async. commands started by it are terminated.
  12675. .sp
  12676. The scripting APIs and JSON IPC give each script/connection its own implicit
  12677. \fBmpv_handle\fP\&.
  12678. .sp
  12679. If the player is closed, the core may abort all pending async. commands on its
  12680. own (like a forced \fBmpv_abort_async_command()\fP call for each pending command
  12681. on behalf of the API user). This happens at the same time \fBMPV_EVENT_SHUTDOWN\fP
  12682. is sent, and there is no way to prevent this.
  12683. .SS Input Sections
  12684. .sp
  12685. Input sections group a set of bindings, and enable or disable them at once.
  12686. In \fBinput.conf\fP, each key binding is assigned to an input section, rather
  12687. than actually having explicit text sections.
  12688. .sp
  12689. See also: \fBenable\-section\fP and \fBdisable\-section\fP commands.
  12690. .sp
  12691. Predefined bindings:
  12692. .INDENT 0.0
  12693. .TP
  12694. .B \fBdefault\fP
  12695. Bindings without input section are implicitly assigned to this section. It
  12696. is enabled by default during normal playback.
  12697. .TP
  12698. .B \fBencode\fP
  12699. Section which is active in encoding mode. It is enabled exclusively, so
  12700. that bindings in the \fBdefault\fP sections are ignored.
  12701. .UNINDENT
  12702. .SS Properties
  12703. .sp
  12704. Properties are used to set mpv options during runtime, or to query arbitrary
  12705. information. They can be manipulated with the \fBset\fP/\fBadd\fP/\fBcycle\fP
  12706. commands, and retrieved with \fBshow\-text\fP, or anything else that uses property
  12707. expansion. (See \fI\%Property Expansion\fP\&.)
  12708. .sp
  12709. The property name is annotated with RW to indicate whether the property is
  12710. generally writable.
  12711. .sp
  12712. If an option is referenced, the property will normally take/return exactly the
  12713. same values as the option. In these cases, properties are merely a way to change
  12714. an option at runtime.
  12715. .SS Property list
  12716. .sp
  12717. \fBNOTE:\fP
  12718. .INDENT 0.0
  12719. .INDENT 3.5
  12720. Most options can be set as runtime via properties as well. Just remove the
  12721. leading \fB\-\-\fP from the option name. These are not documented. Only
  12722. properties which do not exist as option with the same name, or which have
  12723. very different behavior from the options are documented below.
  12724. .UNINDENT
  12725. .UNINDENT
  12726. .INDENT 0.0
  12727. .TP
  12728. .B \fBaudio\-speed\-correction\fP, \fBvideo\-speed\-correction\fP
  12729. Factor multiplied with \fBspeed\fP at which the player attempts to play the
  12730. file. Usually it\(aqs exactly 1. (Display sync mode will make this useful.)
  12731. .sp
  12732. OSD formatting will display it in the form of \fB+1.23456%\fP, with the number
  12733. being \fB(raw \- 1) * 100\fP for the given raw property value.
  12734. .TP
  12735. .B \fBdisplay\-sync\-active\fP
  12736. Return whether \fB\-\-video\-sync=display\fP is actually active.
  12737. .TP
  12738. .B \fBfilename\fP
  12739. Currently played file, with path stripped. If this is an URL, try to undo
  12740. percent encoding as well. (The result is not necessarily correct, but
  12741. looks better for display purposes. Use the \fBpath\fP property to get an
  12742. unmodified filename.)
  12743. .sp
  12744. This has a sub\-property:
  12745. .INDENT 7.0
  12746. .TP
  12747. .B \fBfilename/no\-ext\fP
  12748. Like the \fBfilename\fP property, but if the text contains a \fB\&.\fP, strip
  12749. all text after the last \fB\&.\fP\&. Usually this removes the file extension.
  12750. .UNINDENT
  12751. .TP
  12752. .B \fBfile\-size\fP
  12753. Length in bytes of the source file/stream. (This is the same as
  12754. \fB${stream\-end}\fP\&. For segmented/multi\-part files, this will return the
  12755. size of the main or manifest file, whatever it is.)
  12756. .TP
  12757. .B \fBestimated\-frame\-count\fP
  12758. Total number of frames in current file.
  12759. .sp
  12760. \fBNOTE:\fP
  12761. .INDENT 7.0
  12762. .INDENT 3.5
  12763. This is only an estimate. (It\(aqs computed from two unreliable
  12764. quantities: fps and stream length.)
  12765. .UNINDENT
  12766. .UNINDENT
  12767. .TP
  12768. .B \fBestimated\-frame\-number\fP
  12769. Number of current frame in current stream.
  12770. .sp
  12771. \fBNOTE:\fP
  12772. .INDENT 7.0
  12773. .INDENT 3.5
  12774. This is only an estimate. (It\(aqs computed from two unreliable
  12775. quantities: fps and possibly rounded timestamps.)
  12776. .UNINDENT
  12777. .UNINDENT
  12778. .TP
  12779. .B \fBpath\fP
  12780. Full path of the currently played file. Usually this is exactly the same
  12781. string you pass on the mpv command line or the \fBloadfile\fP command, even
  12782. if it\(aqs a relative path. If you expect an absolute path, you will have to
  12783. determine it yourself, for example by using the \fBworking\-directory\fP
  12784. property.
  12785. .TP
  12786. .B \fBstream\-open\-filename\fP
  12787. The full path to the currently played media. This is different only from
  12788. \fBpath\fP in special cases. In particular, if \fB\-\-ytdl=yes\fP is used, and
  12789. the URL is detected by \fByoutube\-dl\fP, then the script will set this
  12790. property to the actual media URL. This property should be set only during
  12791. the \fBon_load\fP or \fBon_load_fail\fP hooks, otherwise it will have no effect
  12792. (or may do something implementation defined in the future). The property is
  12793. reset if playback of the current media ends.
  12794. .TP
  12795. .B \fBmedia\-title\fP
  12796. If the currently played file has a \fBtitle\fP tag, use that.
  12797. .sp
  12798. Otherwise, return the \fBfilename\fP property.
  12799. .TP
  12800. .B \fBfile\-format\fP
  12801. Symbolic name of the file format. In some cases, this is a comma\-separated
  12802. list of format names, e.g. mp4 is \fBmov,mp4,m4a,3gp,3g2,mj2\fP (the list
  12803. may grow in the future for any format).
  12804. .TP
  12805. .B \fBcurrent\-demuxer\fP
  12806. Name of the current demuxer. (This is useless.)
  12807. .sp
  12808. (Renamed from \fBdemuxer\fP\&.)
  12809. .TP
  12810. .B \fBstream\-path\fP
  12811. Filename (full path) of the stream layer filename. (This is probably
  12812. useless and is almost never different from \fBpath\fP\&.)
  12813. .TP
  12814. .B \fBstream\-pos\fP
  12815. Raw byte position in source stream. Technically, this returns the position
  12816. of the most recent packet passed to a decoder.
  12817. .TP
  12818. .B \fBstream\-end\fP
  12819. Raw end position in bytes in source stream.
  12820. .TP
  12821. .B \fBduration\fP
  12822. Duration of the current file in seconds. If the duration is unknown, the
  12823. property is unavailable. Note that the file duration is not always exactly
  12824. known, so this is an estimate.
  12825. .sp
  12826. This replaces the \fBlength\fP property, which was deprecated after the
  12827. mpv 0.9 release. (The semantics are the same.)
  12828. .TP
  12829. .B \fBavsync\fP
  12830. Last A/V synchronization difference. Unavailable if audio or video is
  12831. disabled.
  12832. .TP
  12833. .B \fBtotal\-avsync\-change\fP
  12834. Total A\-V sync correction done. Unavailable if audio or video is
  12835. disabled.
  12836. .TP
  12837. .B \fBdecoder\-frame\-drop\-count\fP
  12838. Video frames dropped by decoder, because video is too far behind audio (when
  12839. using \fB\-\-framedrop=decoder\fP). Sometimes, this may be incremented in other
  12840. situations, e.g. when video packets are damaged, or the decoder doesn\(aqt
  12841. follow the usual rules. Unavailable if video is disabled.
  12842. .sp
  12843. \fBdrop\-frame\-count\fP is a deprecated alias.
  12844. .TP
  12845. .B \fBframe\-drop\-count\fP
  12846. Frames dropped by VO (when using \fB\-\-framedrop=vo\fP).
  12847. .sp
  12848. \fBvo\-drop\-frame\-count\fP is a deprecated alias.
  12849. .TP
  12850. .B \fBmistimed\-frame\-count\fP
  12851. Number of video frames that were not timed correctly in display\-sync mode
  12852. for the sake of keeping A/V sync. This does not include external
  12853. circumstances, such as video rendering being too slow or the graphics
  12854. driver somehow skipping a vsync. It does not include rounding errors either
  12855. (which can happen especially with bad source timestamps). For example,
  12856. using the \fBdisplay\-desync\fP mode should never change this value from 0.
  12857. .TP
  12858. .B \fBvsync\-ratio\fP
  12859. For how many vsyncs a frame is displayed on average. This is available if
  12860. display\-sync is active only. For 30 FPS video on a 60 Hz screen, this will
  12861. be 2. This is the moving average of what actually has been scheduled, so
  12862. 24 FPS on 60 Hz will never remain exactly on 2.5, but jitter depending on
  12863. the last frame displayed.
  12864. .TP
  12865. .B \fBvo\-delayed\-frame\-count\fP
  12866. Estimated number of frames delayed due to external circumstances in
  12867. display\-sync mode. Note that in general, mpv has to guess that this is
  12868. happening, and the guess can be inaccurate.
  12869. .TP
  12870. .B \fBpercent\-pos\fP (RW)
  12871. Position in current file (0\-100). The advantage over using this instead of
  12872. calculating it out of other properties is that it properly falls back to
  12873. estimating the playback position from the byte position, if the file
  12874. duration is not known.
  12875. .TP
  12876. .B \fBtime\-pos\fP (RW)
  12877. Position in current file in seconds.
  12878. .TP
  12879. .B \fBtime\-start\fP
  12880. Deprecated. Always returns 0. Before mpv 0.14, this used to return the start
  12881. time of the file (could affect e.g. transport streams). See
  12882. \fB\-\-rebase\-start\-time\fP option.
  12883. .TP
  12884. .B \fBtime\-remaining\fP
  12885. Remaining length of the file in seconds. Note that the file duration is not
  12886. always exactly known, so this is an estimate.
  12887. .TP
  12888. .B \fBaudio\-pts\fP (R)
  12889. Current audio playback position in current file in seconds. Unlike time\-pos,
  12890. this updates more often than once per frame. For audio\-only files, it is
  12891. mostly equivalent to time\-pos, while for video\-only files this property is
  12892. not available.
  12893. .TP
  12894. .B \fBplaytime\-remaining\fP
  12895. \fBtime\-remaining\fP scaled by the current \fBspeed\fP\&.
  12896. .TP
  12897. .B \fBplayback\-time\fP (RW)
  12898. Position in current file in seconds. Unlike \fBtime\-pos\fP, the time is
  12899. clamped to the range of the file. (Inaccurate file durations etc. could
  12900. make it go out of range. Useful on attempts to seek outside of the file,
  12901. as the seek target time is considered the current position during seeking.)
  12902. .TP
  12903. .B \fBchapter\fP (RW)
  12904. Current chapter number. The number of the first chapter is 0.
  12905. .TP
  12906. .B \fBedition\fP (RW)
  12907. Current MKV edition number. Setting this property to a different value will
  12908. restart playback. The number of the first edition is 0.
  12909. .sp
  12910. Before mpv 0.31.0, this showed the actual edition selected at runtime, if
  12911. you didn\(aqt set the option or property manually. With mpv 0.31.0 and later,
  12912. this strictly returns the user\-set option or property value, and the
  12913. \fBcurrent\-edition\fP property was added to return the runtime selected
  12914. edition (this matters with \fB\-\-edition=auto\fP, the default).
  12915. .TP
  12916. .B \fBcurrent\-edition\fP
  12917. Currently selected edition. This property is unavailable if no file is
  12918. loaded, or the file has no editions. (Matroska files make a difference
  12919. between having no editions and a single edition, which will be reflected by
  12920. the property, although in practice it does not matter.)
  12921. .TP
  12922. .B \fBchapters\fP
  12923. Number of chapters.
  12924. .TP
  12925. .B \fBeditions\fP
  12926. Number of MKV editions.
  12927. .TP
  12928. .B \fBedition\-list\fP
  12929. List of editions, current entry marked. Currently, the raw property value
  12930. is useless.
  12931. .sp
  12932. This has a number of sub\-properties. Replace \fBN\fP with the 0\-based edition
  12933. index.
  12934. .INDENT 7.0
  12935. .TP
  12936. .B \fBedition\-list/count\fP
  12937. Number of editions. If there are no editions, this can be 0 or 1 (1
  12938. if there\(aqs a useless dummy edition).
  12939. .TP
  12940. .B \fBedition\-list/N/id\fP
  12941. Edition ID as integer. Use this to set the \fBedition\fP property.
  12942. Currently, this is the same as the edition index.
  12943. .TP
  12944. .B \fBedition\-list/N/default\fP
  12945. \fByes\fP if this is the default edition, \fBno\fP otherwise.
  12946. .TP
  12947. .B \fBedition\-list/N/title\fP
  12948. Edition title as stored in the file. Not always available.
  12949. .UNINDENT
  12950. .sp
  12951. When querying the property with the client API using \fBMPV_FORMAT_NODE\fP,
  12952. or with Lua \fBmp.get_property_native\fP, this will return a mpv_node with
  12953. the following contents:
  12954. .INDENT 7.0
  12955. .INDENT 3.5
  12956. .sp
  12957. .nf
  12958. .ft C
  12959. MPV_FORMAT_NODE_ARRAY
  12960.     MPV_FORMAT_NODE_MAP (for each edition)
  12961.         "id"                MPV_FORMAT_INT64
  12962.         "title"             MPV_FORMAT_STRING
  12963.         "default"           MPV_FORMAT_FLAG
  12964. .ft P
  12965. .fi
  12966. .UNINDENT
  12967. .UNINDENT
  12968. .TP
  12969. .B \fBmetadata\fP
  12970. Metadata key/value pairs.
  12971. .sp
  12972. If the property is accessed with Lua\(aqs \fBmp.get_property_native\fP, this
  12973. returns a table with metadata keys mapping to metadata values. If it is
  12974. accessed with the client API, this returns a \fBMPV_FORMAT_NODE_MAP\fP,
  12975. with tag keys mapping to tag values.
  12976. .sp
  12977. For OSD, it returns a formatted list. Trying to retrieve this property as
  12978. a raw string doesn\(aqt work.
  12979. .sp
  12980. This has a number of sub\-properties:
  12981. .INDENT 7.0
  12982. .TP
  12983. .B \fBmetadata/by\-key/<key>\fP
  12984. Value of metadata entry \fB<key>\fP\&.
  12985. .TP
  12986. .B \fBmetadata/list/count\fP
  12987. Number of metadata entries.
  12988. .TP
  12989. .B \fBmetadata/list/N/key\fP
  12990. Key name of the Nth metadata entry. (The first entry is \fB0\fP).
  12991. .TP
  12992. .B \fBmetadata/list/N/value\fP
  12993. Value of the Nth metadata entry.
  12994. .TP
  12995. .B \fBmetadata/<key>\fP
  12996. Old version of \fBmetadata/by\-key/<key>\fP\&. Use is discouraged, because
  12997. the metadata key string could conflict with other sub\-properties.
  12998. .UNINDENT
  12999. .sp
  13000. The layout of this property might be subject to change. Suggestions are
  13001. welcome how exactly this property should work.
  13002. .sp
  13003. When querying the property with the client API using \fBMPV_FORMAT_NODE\fP,
  13004. or with Lua \fBmp.get_property_native\fP, this will return a mpv_node with
  13005. the following contents:
  13006. .INDENT 7.0
  13007. .INDENT 3.5
  13008. .sp
  13009. .nf
  13010. .ft C
  13011. MPV_FORMAT_NODE_MAP
  13012.     (key and string value for each metadata entry)
  13013. .ft P
  13014. .fi
  13015. .UNINDENT
  13016. .UNINDENT
  13017. .TP
  13018. .B \fBfiltered\-metadata\fP
  13019. Like \fBmetadata\fP, but includes only fields listed in the \fB\-\-display\-tags\fP
  13020. option. This is the same set of tags that is printed to the terminal.
  13021. .TP
  13022. .B \fBchapter\-metadata\fP
  13023. Metadata of current chapter. Works similar to \fBmetadata\fP property. It
  13024. also allows the same access methods (using sub\-properties).
  13025. .sp
  13026. Per\-chapter metadata is very rare. Usually, only the chapter name
  13027. (\fBtitle\fP) is set.
  13028. .sp
  13029. For accessing other information, like chapter start, see the
  13030. \fBchapter\-list\fP property.
  13031. .TP
  13032. .B \fBvf\-metadata/<filter\-label>\fP
  13033. Metadata added by video filters. Accessed by the filter label,
  13034. which, if not explicitly specified using the \fB@filter\-label:\fP syntax,
  13035. will be \fB<filter\-name>NN\fP\&.
  13036. .sp
  13037. Works similar to \fBmetadata\fP property. It allows the same access
  13038. methods (using sub\-properties).
  13039. .sp
  13040. An example of this kind of metadata are the cropping parameters
  13041. added by \fB\-\-vf=lavfi=cropdetect\fP\&.
  13042. .TP
  13043. .B \fBaf\-metadata/<filter\-label>\fP
  13044. Equivalent to \fBvf\-metadata/<filter\-label>\fP, but for audio filters.
  13045. .TP
  13046. .B \fBidle\-active\fP
  13047. Return \fByes\fP if no file is loaded, but the player is staying around
  13048. because of the \fB\-\-idle\fP option.
  13049. .sp
  13050. (Renamed from \fBidle\fP\&.)
  13051. .TP
  13052. .B \fBcore\-idle\fP
  13053. Return \fByes\fP if the playback core is paused, otherwise \fBno\fP\&. This can
  13054. be different \fBpause\fP in special situations, such as when the player
  13055. pauses itself due to low network cache.
  13056. .sp
  13057. This also returns \fByes\fP if playback is restarting or if nothing is
  13058. playing at all. In other words, it\(aqs only \fBno\fP if there\(aqs actually
  13059. video playing. (Behavior since mpv 0.7.0.)
  13060. .TP
  13061. .B \fBcache\-speed\fP (R)
  13062. Current I/O read speed between the cache and the lower layer (like network).
  13063. This gives the number bytes per seconds over a 1 second window (using
  13064. the type \fBMPV_FORMAT_INT64\fP for the client API).
  13065. .TP
  13066. .B \fBdemuxer\-cache\-duration\fP
  13067. Approximate duration of video buffered in the demuxer, in seconds. The
  13068. guess is very unreliable, and often the property will not be available
  13069. at all, even if data is buffered.
  13070. .TP
  13071. .B \fBdemuxer\-cache\-time\fP
  13072. Approximate time of video buffered in the demuxer, in seconds. Same as
  13073. \fBdemuxer\-cache\-duration\fP but returns the last timestamp of buffered
  13074. data in demuxer.
  13075. .TP
  13076. .B \fBdemuxer\-cache\-idle\fP
  13077. Returns \fByes\fP if the demuxer is idle, which means the demuxer cache is
  13078. filled to the requested amount, and is currently not reading more data.
  13079. .TP
  13080. .B \fBdemuxer\-cache\-state\fP
  13081. Various undocumented or half\-documented things.
  13082. .sp
  13083. Each entry in \fBseekable\-ranges\fP represents a region in the demuxer cache
  13084. that can be seeked to. If there are multiple demuxers active, this only
  13085. returns information about the "main" demuxer, but might be changed in
  13086. future to return unified information about all demuxers. The ranges are in
  13087. arbitrary order. Often, ranges will overlap for a bit, before being joined.
  13088. In broken corner cases, ranges may overlap all over the place.
  13089. .sp
  13090. The end of a seek range is usually smaller than the value returned by the
  13091. \fBdemuxer\-cache\-time\fP property, because that property returns the guessed
  13092. buffering amount, while the seek ranges represent the buffered data that
  13093. can actually be used for cached seeking.
  13094. .sp
  13095. \fBbof\-cached\fP indicates whether the seek range with the lowest timestamp
  13096. points to the beginning of the stream (BOF). This implies you cannot seek
  13097. before this position at all. \fBeof\-cached\fP indicates whether the seek range
  13098. with the highest timestamp points to the end of the stream (EOF). If both
  13099. \fBbof\-cached\fP and \fBeof\-cached\fP are set to \fByes\fP, and there\(aqs only 1
  13100. cache range, the entire stream is cached.
  13101. .sp
  13102. \fBfw\-bytes\fP is the number of bytes of packets buffered in the range
  13103. starting from the current decoding position. This is a rough estimate
  13104. (may not account correctly for various overhead), and stops at the
  13105. demuxer position (it ignores seek ranges after it).
  13106. .sp
  13107. \fBfile\-cache\-bytes\fP is the number of bytes stored in the file cache. This
  13108. includes all overhead, and possibly unused data (like pruned data). This
  13109. member is missing if the file cache is not active.
  13110. .sp
  13111. When querying the property with the client API using \fBMPV_FORMAT_NODE\fP,
  13112. or with Lua \fBmp.get_property_native\fP, this will return a mpv_node with
  13113. the following contents:
  13114. .INDENT 7.0
  13115. .INDENT 3.5
  13116. .sp
  13117. .nf
  13118. .ft C
  13119. MPV_FORMAT_NODE_MAP
  13120.     "seekable\-ranges"   MPV_FORMAT_NODE_ARRAY
  13121.         MPV_FORMAT_NODE_MAP
  13122.             "start"             MPV_FORMAT_DOUBLE
  13123.             "end"               MPV_FORMAT_DOUBLE
  13124.     "bof\-cached"        MPV_FORMAT_FLAG
  13125.     "eof\-cached"        MPV_FORMAT_FLAG
  13126.     "fw\-bytes"          MPV_FORMAT_INT64
  13127.     "file\-cache\-bytes"  MPV_FORMAT_INT64
  13128. .ft P
  13129. .fi
  13130. .UNINDENT
  13131. .UNINDENT
  13132. .sp
  13133. Other fields (might be changed or removed in the future):
  13134. .INDENT 7.0
  13135. .TP
  13136. .B \fBeof\fP
  13137. True if the reader thread has hit the end of the file.
  13138. .TP
  13139. .B \fBunderrun\fP
  13140. True if the reader thread could not satisfy a decoder\(aqs request for a
  13141. new packet.
  13142. .TP
  13143. .B \fBidle\fP
  13144. True if the thread is currently not reading.
  13145. .TP
  13146. .B \fBtotal\-bytes\fP
  13147. Sum of packet bytes (plus some overhead estimation) of the entire packet
  13148. queue, including cached seekable ranges.
  13149. .UNINDENT
  13150. .TP
  13151. .B \fBdemuxer\-via\-network\fP
  13152. Returns \fByes\fP if the stream demuxed via the main demuxer is most likely
  13153. played via network. What constitutes "network" is not always clear, might
  13154. be used for other types of untrusted streams, could be wrong in certain
  13155. cases, and its definition might be changing. Also, external files (like
  13156. separate audio files or streams) do not influence the value of this
  13157. property (currently).
  13158. .TP
  13159. .B \fBdemuxer\-start\-time\fP (R)
  13160. Returns the start time reported by the demuxer in fractional seconds.
  13161. .TP
  13162. .B \fBpaused\-for\-cache\fP
  13163. Returns \fByes\fP when playback is paused because of waiting for the cache.
  13164. .TP
  13165. .B \fBcache\-buffering\-state\fP
  13166. Return the percentage (0\-100) of the cache fill status until the player
  13167. will unpause (related to \fBpaused\-for\-cache\fP).
  13168. .TP
  13169. .B \fBeof\-reached\fP
  13170. Returns \fByes\fP if end of playback was reached, \fBno\fP otherwise. Note
  13171. that this is usually interesting only if \fB\-\-keep\-open\fP is enabled,
  13172. since otherwise the player will immediately play the next file (or exit
  13173. or enter idle mode), and in these cases the \fBeof\-reached\fP property will
  13174. logically be cleared immediately after it\(aqs set.
  13175. .TP
  13176. .B \fBseeking\fP
  13177. Returns \fByes\fP if the player is currently seeking, or otherwise trying
  13178. to restart playback. (It\(aqs possible that it returns \fByes\fP while a file
  13179. is loaded. This is because the same underlying code is used for seeking and
  13180. resyncing.)
  13181. .TP
  13182. .B \fBmixer\-active\fP
  13183. Return \fByes\fP if the audio mixer is active, \fBno\fP otherwise.
  13184. .sp
  13185. This option is relatively useless. Before mpv 0.18.1, it could be used to
  13186. infer behavior of the \fBvolume\fP property.
  13187. .TP
  13188. .B \fBao\-volume\fP (RW)
  13189. System volume. This property is available only if mpv audio output is
  13190. currently active, and only if the underlying implementation supports volume
  13191. control. What this option does depends on the API. For example, on ALSA
  13192. this usually changes system\-wide audio, while with PulseAudio this controls
  13193. per\-application volume.
  13194. .TP
  13195. .B \fBao\-mute\fP (RW)
  13196. Similar to \fBao\-volume\fP, but controls the mute state. May be unimplemented
  13197. even if \fBao\-volume\fP works.
  13198. .TP
  13199. .B \fBaudio\-codec\fP
  13200. Audio codec selected for decoding.
  13201. .TP
  13202. .B \fBaudio\-codec\-name\fP
  13203. Audio codec.
  13204. .TP
  13205. .B \fBaudio\-params\fP
  13206. Audio format as output by the audio decoder.
  13207. This has a number of sub\-properties:
  13208. .INDENT 7.0
  13209. .TP
  13210. .B \fBaudio\-params/format\fP
  13211. The sample format as string. This uses the same names as used in other
  13212. places of mpv.
  13213. .TP
  13214. .B \fBaudio\-params/samplerate\fP
  13215. Samplerate.
  13216. .TP
  13217. .B \fBaudio\-params/channels\fP
  13218. The channel layout as a string. This is similar to what the
  13219. \fB\-\-audio\-channels\fP accepts.
  13220. .TP
  13221. .B \fBaudio\-params/hr\-channels\fP
  13222. As \fBchannels\fP, but instead of the possibly cryptic actual layout
  13223. sent to the audio device, return a hopefully more human readable form.
  13224. (Usually only \fBaudio\-out\-params/hr\-channels\fP makes sense.)
  13225. .TP
  13226. .B \fBaudio\-params/channel\-count\fP
  13227. Number of audio channels. This is redundant to the \fBchannels\fP field
  13228. described above.
  13229. .UNINDENT
  13230. .sp
  13231. When querying the property with the client API using \fBMPV_FORMAT_NODE\fP,
  13232. or with Lua \fBmp.get_property_native\fP, this will return a mpv_node with
  13233. the following contents:
  13234. .INDENT 7.0
  13235. .INDENT 3.5
  13236. .sp
  13237. .nf
  13238. .ft C
  13239. MPV_FORMAT_NODE_MAP
  13240.     "format"            MPV_FORMAT_STRING
  13241.     "samplerate"        MPV_FORMAT_INT64
  13242.     "channels"          MPV_FORMAT_STRING
  13243.     "channel\-count"     MPV_FORMAT_INT64
  13244.     "hr\-channels"       MPV_FORMAT_STRING
  13245. .ft P
  13246. .fi
  13247. .UNINDENT
  13248. .UNINDENT
  13249. .TP
  13250. .B \fBaudio\-out\-params\fP
  13251. Same as \fBaudio\-params\fP, but the format of the data written to the audio
  13252. API.
  13253. .TP
  13254. .B \fBcolormatrix\fP (R)
  13255. Redirects to \fBvideo\-params/colormatrix\fP\&. This parameter (as well as
  13256. similar ones) can be overridden with the \fBformat\fP video filter.
  13257. .TP
  13258. .B \fBcolormatrix\-input\-range\fP (R)
  13259. See \fBcolormatrix\fP\&.
  13260. .TP
  13261. .B \fBcolormatrix\-primaries\fP (R)
  13262. See \fBcolormatrix\fP\&.
  13263. .TP
  13264. .B \fBhwdec\fP (RW)
  13265. Reflects the \fB\-\-hwdec\fP option.
  13266. .sp
  13267. Writing to it may change the currently used hardware decoder, if possible.
  13268. (Internally, the player may reinitialize the decoder, and will perform a
  13269. seek to refresh the video properly.) You can watch the other hwdec
  13270. properties to see whether this was successful.
  13271. .sp
  13272. Unlike in mpv 0.9.x and before, this does not return the currently active
  13273. hardware decoder. Since mpv 0.18.0, \fBhwdec\-current\fP is available for
  13274. this purpose.
  13275. .TP
  13276. .B \fBhwdec\-current\fP
  13277. Return the current hardware decoding in use. If decoding is active, return
  13278. one of the values used by the \fBhwdec\fP option/property. \fBno\fP indicates
  13279. software decoding. If no decoder is loaded, the property is unavailable.
  13280. .TP
  13281. .B \fBhwdec\-interop\fP
  13282. This returns the currently loaded hardware decoding/output interop driver.
  13283. This is known only once the VO has opened (and possibly later). With some
  13284. VOs (like \fBgpu\fP), this might be never known in advance, but only when
  13285. the decoder attempted to create the hw decoder successfully. (Using
  13286. \fB\-\-gpu\-hwdec\-interop\fP can load it eagerly.) If there are multiple
  13287. drivers loaded, they will be separated by \fB,\fP\&.
  13288. .sp
  13289. If no VO is active or no interop driver is known, this property is
  13290. unavailable.
  13291. .sp
  13292. This does not necessarily use the same values as \fBhwdec\fP\&. There can be
  13293. multiple interop drivers for the same hardware decoder, depending on
  13294. platform and VO.
  13295. .TP
  13296. .B \fBvideo\-format\fP
  13297. Video format as string.
  13298. .TP
  13299. .B \fBvideo\-codec\fP
  13300. Video codec selected for decoding.
  13301. .TP
  13302. .B \fBwidth\fP, \fBheight\fP
  13303. Video size. This uses the size of the video as decoded, or if no video
  13304. frame has been decoded yet, the (possibly incorrect) container indicated
  13305. size.
  13306. .TP
  13307. .B \fBvideo\-params\fP
  13308. Video parameters, as output by the decoder (with overrides like aspect
  13309. etc. applied). This has a number of sub\-properties:
  13310. .INDENT 7.0
  13311. .TP
  13312. .B \fBvideo\-params/pixelformat\fP
  13313. The pixel format as string. This uses the same names as used in other
  13314. places of mpv.
  13315. .TP
  13316. .B \fBvideo\-params/average\-bpp\fP
  13317. Average bits\-per\-pixel as integer. Subsampled planar formats use a
  13318. different resolution, which is the reason this value can sometimes be
  13319. odd or confusing. Can be unavailable with some formats.
  13320. .TP
  13321. .B \fBvideo\-params/plane\-depth\fP
  13322. Bit depth for each color component as integer. This is only exposed
  13323. for planar or single\-component formats, and is unavailable for other
  13324. formats.
  13325. .TP
  13326. .B \fBvideo\-params/w\fP, \fBvideo\-params/h\fP
  13327. Video size as integers, with no aspect correction applied.
  13328. .TP
  13329. .B \fBvideo\-params/dw\fP, \fBvideo\-params/dh\fP
  13330. Video size as integers, scaled for correct aspect ratio.
  13331. .TP
  13332. .B \fBvideo\-params/aspect\fP
  13333. Display aspect ratio as float.
  13334. .TP
  13335. .B \fBvideo\-params/par\fP
  13336. Pixel aspect ratio.
  13337. .TP
  13338. .B \fBvideo\-params/colormatrix\fP
  13339. The colormatrix in use as string. (Exact values subject to change.)
  13340. .TP
  13341. .B \fBvideo\-params/colorlevels\fP
  13342. The colorlevels as string. (Exact values subject to change.)
  13343. .TP
  13344. .B \fBvideo\-params/primaries\fP
  13345. The primaries in use as string. (Exact values subject to change.)
  13346. .TP
  13347. .B \fBvideo\-params/gamma\fP
  13348. The gamma function in use as string. (Exact values subject to change.)
  13349. .TP
  13350. .B \fBvideo\-params/sig\-peak\fP
  13351. The video file\(aqs tagged signal peak as float.
  13352. .TP
  13353. .B \fBvideo\-params/light\fP
  13354. The light type in use as a string. (Exact values subject to change.)
  13355. .TP
  13356. .B \fBvideo\-params/chroma\-location\fP
  13357. Chroma location as string. (Exact values subject to change.)
  13358. .TP
  13359. .B \fBvideo\-params/rotate\fP
  13360. Intended display rotation in degrees (clockwise).
  13361. .TP
  13362. .B \fBvideo\-params/stereo\-in\fP
  13363. Source file stereo 3D mode. (See the \fBformat\fP video filter\(aqs
  13364. \fBstereo\-in\fP option.)
  13365. .UNINDENT
  13366. .sp
  13367. When querying the property with the client API using \fBMPV_FORMAT_NODE\fP,
  13368. or with Lua \fBmp.get_property_native\fP, this will return a mpv_node with
  13369. the following contents:
  13370. .INDENT 7.0
  13371. .INDENT 3.5
  13372. .sp
  13373. .nf
  13374. .ft C
  13375. MPV_FORMAT_NODE_MAP
  13376.     "pixelformat"       MPV_FORMAT_STRING
  13377.     "w"                 MPV_FORMAT_INT64
  13378.     "h"                 MPV_FORMAT_INT64
  13379.     "dw"                MPV_FORMAT_INT64
  13380.     "dh"                MPV_FORMAT_INT64
  13381.     "aspect"            MPV_FORMAT_DOUBLE
  13382.     "par"               MPV_FORMAT_DOUBLE
  13383.     "colormatrix"       MPV_FORMAT_STRING
  13384.     "colorlevels"       MPV_FORMAT_STRING
  13385.     "primaries"         MPV_FORMAT_STRING
  13386.     "gamma"             MPV_FORMAT_STRING
  13387.     "sig\-peak"          MPV_FORMAT_DOUBLE
  13388.     "light"             MPV_FORMAT_STRING
  13389.     "chroma\-location"   MPV_FORMAT_STRING
  13390.     "rotate"            MPV_FORMAT_INT64
  13391.     "stereo\-in"         MPV_FORMAT_STRING
  13392. .ft P
  13393. .fi
  13394. .UNINDENT
  13395. .UNINDENT
  13396. .TP
  13397. .B \fBdwidth\fP, \fBdheight\fP
  13398. Video display size. This is the video size after filters and aspect scaling
  13399. have been applied. The actual video window size can still be different
  13400. from this, e.g. if the user resized the video window manually.
  13401. .sp
  13402. These have the same values as \fBvideo\-out\-params/dw\fP and
  13403. \fBvideo\-out\-params/dh\fP\&.
  13404. .TP
  13405. .B \fBvideo\-dec\-params\fP
  13406. Exactly like \fBvideo\-params\fP, but no overrides applied.
  13407. .TP
  13408. .B \fBvideo\-out\-params\fP
  13409. Same as \fBvideo\-params\fP, but after video filters have been applied. If
  13410. there are no video filters in use, this will contain the same values as
  13411. \fBvideo\-params\fP\&. Note that this is still not necessarily what the video
  13412. window uses, since the user can change the window size, and all real VOs
  13413. do their own scaling independently from the filter chain.
  13414. .sp
  13415. Has the same sub\-properties as \fBvideo\-params\fP\&.
  13416. .TP
  13417. .B \fBvideo\-frame\-info\fP
  13418. Approximate information of the current frame. Note that if any of these
  13419. are used on OSD, the information might be off by a few frames due to OSD
  13420. redrawing and frame display being somewhat disconnected, and you might
  13421. have to pause and force a redraw.
  13422. .sp
  13423. Sub\-properties:
  13424. .INDENT 7.0
  13425. .INDENT 3.5
  13426. .sp
  13427. .nf
  13428. .ft C
  13429. video\-frame\-info/picture\-type
  13430. video\-frame\-info/interlaced
  13431. video\-frame\-info/tff
  13432. video\-frame\-info/repeat
  13433. .ft P
  13434. .fi
  13435. .UNINDENT
  13436. .UNINDENT
  13437. .TP
  13438. .B \fBcontainer\-fps\fP
  13439. Container FPS. This can easily contain bogus values. For videos that use
  13440. modern container formats or video codecs, this will often be incorrect.
  13441. .sp
  13442. (Renamed from \fBfps\fP\&.)
  13443. .TP
  13444. .B \fBestimated\-vf\-fps\fP
  13445. Estimated/measured FPS of the video filter chain output. (If no filters
  13446. are used, this corresponds to decoder output.) This uses the average of
  13447. the 10 past frame durations to calculate the FPS. It will be inaccurate
  13448. if frame\-dropping is involved (such as when framedrop is explicitly
  13449. enabled, or after precise seeking). Files with imprecise timestamps (such
  13450. as Matroska) might lead to unstable results.
  13451. .TP
  13452. .B \fBwindow\-scale\fP (RW)
  13453. Window size multiplier. Setting this will resize the video window to the
  13454. values contained in \fBdwidth\fP and \fBdheight\fP multiplied with the value
  13455. set with this property. Setting \fB1\fP will resize to original video size
  13456. (or to be exact, the size the video filters output). \fB2\fP will set the
  13457. double size, \fB0.5\fP halves the size.
  13458. .sp
  13459. See \fBcurrent\-window\-scale\fP for the value derived from the actual window
  13460. size.
  13461. .sp
  13462. Since mpv 0.31.0, this always returns the previously set value (or the
  13463. default value), instead of the value implied by the actual window size.
  13464. Before mpv 0.31.0, this returned what \fBcurrent\-window\-scale\fP returns now,
  13465. after the window was created.
  13466. .TP
  13467. .B \fBcurrent\-window\-scale\fP
  13468. The \fBwindow\-scale\fP value calculated from the current window size. This
  13469. has the same value as \fBwindow\-scale\fP if the window size was not changed
  13470. since setting the option, and the window size was not restricted in other
  13471. ways. The property is unavailable if no video is active.
  13472. .TP
  13473. .B \fBdisplay\-names\fP
  13474. Names of the displays that the mpv window covers. On X11, these
  13475. are the xrandr names (LVDS1, HDMI1, DP1, VGA1, etc.). On Windows, these
  13476. are the GDI names (\e.DISPLAY1, \e.DISPLAY2, etc.) and the first display
  13477. in the list will be the one that Windows considers associated with the
  13478. window (as determined by the MonitorFromWindow API.) On macOS these are the
  13479. Display Product Names as used in the System Information and only one display
  13480. name is returned since a window can only be on one screen.
  13481. .TP
  13482. .B \fBdisplay\-fps\fP
  13483. The refresh rate of the current display. Currently, this is the lowest FPS
  13484. of any display covered by the video, as retrieved by the underlying system
  13485. APIs (e.g. xrandr on X11). It is not the measured FPS. It\(aqs not necessarily
  13486. available on all platforms. Note that any of the listed facts may change
  13487. any time without a warning.
  13488. .sp
  13489. Writing to this property is deprecated. It has the same effect as writing to
  13490. \fBoverride\-display\-fps\fP\&. Since mpv 0.31.0, this property is unavailable
  13491. if no display FPS was reported (e.g. if no video is active), while in older
  13492. versions, it returned the \fB\-\-display\-fps\fP option value.
  13493. .TP
  13494. .B \fBestimated\-display\-fps\fP
  13495. Only available if display\-sync mode (as selected by \fB\-\-video\-sync\fP) is
  13496. active. Returns the actual rate at which display refreshes seem to occur,
  13497. measured by system time.
  13498. .TP
  13499. .B \fBvsync\-jitter\fP
  13500. Estimated deviation factor of the vsync duration.
  13501. .TP
  13502. .B \fBdisplay\-hidpi\-scale\fP
  13503. The HiDPI scale factor as reported by the windowing backend. If no VO is
  13504. active, or if the VO does not report a value, this property is unavailable.
  13505. It may be saner to report an absolute DPI, however, this is the way HiDPI
  13506. support is implemented on most OS APIs. See also \fB\-\-hidpi\-window\-scale\fP\&.
  13507. .TP
  13508. .B \fBvideo\-aspect\fP (RW)
  13509. Deprecated. This is tied to \fB\-\-video\-aspect\-override\fP, but always
  13510. reports the current video aspect if video is active.
  13511. .sp
  13512. The read and write components of this option can be split up into
  13513. \fBvideo\-params/aspect\fP and \fBvideo\-aspect\-override\fP respectively.
  13514. .TP
  13515. .B \fBosd\-width\fP, \fBosd\-height\fP
  13516. Last known OSD width (can be 0). This is needed if you want to use the
  13517. \fBoverlay\-add\fP command. It gives you the actual OSD size, which can be
  13518. different from the window size in some cases.
  13519. .sp
  13520. Alias to \fBosd\-dimensions/w\fP and \fBosd\-dimensions/h\fP\&.
  13521. .TP
  13522. .B \fBosd\-par\fP
  13523. Last known OSD display pixel aspect (can be 0).
  13524. .sp
  13525. Alias to \fBosd\-dimensions/osd\-par\fP\&.
  13526. .TP
  13527. .B \fBosd\-dimensions\fP
  13528. Last known OSD dimensions.
  13529. .sp
  13530. Has the following sub\-properties (which can be read as \fBMPV_FORMAT_NODE\fP
  13531. or Lua table with \fBmp.get_property_native\fP):
  13532. .INDENT 7.0
  13533. .TP
  13534. .B \fBw\fP
  13535. Size of the VO window in OSD render units (usually pixels, but may be
  13536. scaled pixels with VOs like \fBxv\fP).
  13537. .TP
  13538. .B \fBh\fP
  13539. Size of the VO window in OSD render units,
  13540. .TP
  13541. .B \fBpar\fP
  13542. Pixel aspect ratio of the OSD (usually 1).
  13543. .TP
  13544. .B \fBaspect\fP
  13545. Display aspect ratio of the VO window. (Computing from the properties
  13546. above.)
  13547. .TP
  13548. .B \fBmt\fP, \fBmb\fP, \fBml\fP, \fBmr\fP
  13549. OSD to video margins (top, bottom, left, right). This describes the
  13550. area into which the video is rendered.
  13551. .UNINDENT
  13552. .sp
  13553. Any of these properties may be unavailable or set to dummy values if the
  13554. VO window is not created or visible.
  13555. .TP
  13556. .B \fBsub\-text\fP
  13557. Return the current subtitle text regardless of sub visibility.
  13558. Formatting is stripped. If the subtitle is not text\-based
  13559. (i.e. DVD/BD subtitles), an empty string is returned.
  13560. .sp
  13561. This property is experimental and might be removed in the future.
  13562. .TP
  13563. .B \fBsub\-start\fP
  13564. Return the current subtitle start time (in seconds). If there\(aqs multiple
  13565. current subtitles, returns the first start time. If no current subtitle is
  13566. present null is returned instead.
  13567. .TP
  13568. .B \fBsub\-end\fP
  13569. Return the current subtitle start time (in seconds). If there\(aqs multiple
  13570. current subtitles, return the last end time. If no current subtitle is
  13571. present, or if it\(aqs present but has unknown or incorrect duration, null
  13572. is returned instead.
  13573. .TP
  13574. .B \fBplaylist\-pos\fP (RW)
  13575. Current position on playlist. The first entry is on position 0. Writing
  13576. to the property will restart playback at the written entry.
  13577. .TP
  13578. .B \fBplaylist\-pos\-1\fP (RW)
  13579. Same as \fBplaylist\-pos\fP, but 1\-based.
  13580. .TP
  13581. .B \fBplaylist\-count\fP
  13582. Number of total playlist entries.
  13583. .TP
  13584. .B \fBplaylist\fP
  13585. Playlist, current entry marked. Currently, the raw property value is
  13586. useless.
  13587. .sp
  13588. This has a number of sub\-properties. Replace \fBN\fP with the 0\-based playlist
  13589. entry index.
  13590. .INDENT 7.0
  13591. .TP
  13592. .B \fBplaylist/count\fP
  13593. Number of playlist entries (same as \fBplaylist\-count\fP).
  13594. .TP
  13595. .B \fBplaylist/N/filename\fP
  13596. Filename of the Nth entry.
  13597. .TP
  13598. .B \fBplaylist/N/current\fP, \fBplaylist/N/playing\fP
  13599. \fByes\fP if this entry is currently playing (or being loaded).
  13600. Unavailable or \fBno\fP otherwise. When changing files, \fBcurrent\fP and
  13601. \fBplaying\fP can be different, because the currently playing file hasn\(aqt
  13602. been unloaded yet; in this case, \fBcurrent\fP refers to the new
  13603. selection. (Since mpv 0.7.0.)
  13604. .TP
  13605. .B \fBplaylist/N/title\fP
  13606. Name of the Nth entry. Only available if the playlist file contains
  13607. such fields, and only if mpv\(aqs parser supports it for the given
  13608. playlist format.
  13609. .UNINDENT
  13610. .sp
  13611. When querying the property with the client API using \fBMPV_FORMAT_NODE\fP,
  13612. or with Lua \fBmp.get_property_native\fP, this will return a mpv_node with
  13613. the following contents:
  13614. .INDENT 7.0
  13615. .INDENT 3.5
  13616. .sp
  13617. .nf
  13618. .ft C
  13619. MPV_FORMAT_NODE_ARRAY
  13620.     MPV_FORMAT_NODE_MAP (for each playlist entry)
  13621.         "filename"  MPV_FORMAT_STRING
  13622.         "current"   MPV_FORMAT_FLAG (might be missing; since mpv 0.7.0)
  13623.         "playing"   MPV_FORMAT_FLAG (same)
  13624.         "title"     MPV_FORMAT_STRING (optional)
  13625. .ft P
  13626. .fi
  13627. .UNINDENT
  13628. .UNINDENT
  13629. .TP
  13630. .B \fBtrack\-list\fP
  13631. List of audio/video/sub tracks, current entry marked. Currently, the raw
  13632. property value is useless.
  13633. .sp
  13634. This has a number of sub\-properties. Replace \fBN\fP with the 0\-based track
  13635. index.
  13636. .INDENT 7.0
  13637. .TP
  13638. .B \fBtrack\-list/count\fP
  13639. Total number of tracks.
  13640. .TP
  13641. .B \fBtrack\-list/N/id\fP
  13642. The ID as it\(aqs used for \fB\-sid\fP/\fB\-\-aid\fP/\fB\-\-vid\fP\&. This is unique
  13643. within tracks of the same type (sub/audio/video), but otherwise not.
  13644. .TP
  13645. .B \fBtrack\-list/N/type\fP
  13646. String describing the media type. One of \fBaudio\fP, \fBvideo\fP, \fBsub\fP\&.
  13647. .TP
  13648. .B \fBtrack\-list/N/src\-id\fP
  13649. Track ID as used in the source file. Not always available. (It is
  13650. missing if the format has no native ID, if the track is a pseudo\-track
  13651. that does not exist in this way in the actual file, or if the format
  13652. is handled by libavformat, and the format was not whitelisted as having
  13653. track IDs.)
  13654. .TP
  13655. .B \fBtrack\-list/N/title\fP
  13656. Track title as it is stored in the file. Not always available.
  13657. .TP
  13658. .B \fBtrack\-list/N/lang\fP
  13659. Track language as identified by the file. Not always available.
  13660. .TP
  13661. .B \fBtrack\-list/N/albumart\fP
  13662. \fByes\fP if this is a video track that consists of a single picture,
  13663. \fBno\fP or unavailable otherwise. This is used for video tracks that are
  13664. really attached pictures in audio files.
  13665. .TP
  13666. .B \fBtrack\-list/N/default\fP
  13667. \fByes\fP if the track has the default flag set in the file, \fBno\fP
  13668. otherwise.
  13669. .TP
  13670. .B \fBtrack\-list/N/forced\fP
  13671. \fByes\fP if the track has the forced flag set in the file, \fBno\fP
  13672. otherwise.
  13673. .TP
  13674. .B \fBtrack\-list/N/codec\fP
  13675. The codec name used by this track, for example \fBh264\fP\&. Unavailable
  13676. in some rare cases.
  13677. .TP
  13678. .B \fBtrack\-list/N/external\fP
  13679. \fByes\fP if the track is an external file, \fBno\fP otherwise. This is
  13680. set for separate subtitle files.
  13681. .TP
  13682. .B \fBtrack\-list/N/external\-filename\fP
  13683. The filename if the track is from an external file, unavailable
  13684. otherwise.
  13685. .TP
  13686. .B \fBtrack\-list/N/selected\fP
  13687. \fByes\fP if the track is currently decoded, \fBno\fP otherwise.
  13688. .TP
  13689. .B \fBtrack\-list/N/ff\-index\fP
  13690. The stream index as usually used by the FFmpeg utilities. Note that
  13691. this can be potentially wrong if a demuxer other than libavformat
  13692. (\fB\-\-demuxer=lavf\fP) is used. For mkv files, the index will usually
  13693. match even if the default (builtin) demuxer is used, but there is
  13694. no hard guarantee.
  13695. .TP
  13696. .B \fBtrack\-list/N/decoder\-desc\fP
  13697. If this track is being decoded, the human\-readable decoder name,
  13698. .TP
  13699. .B \fBtrack\-list/N/demux\-w\fP, \fBtrack\-list/N/demux\-h\fP
  13700. Video size hint as indicated by the container. (Not always accurate.)
  13701. .TP
  13702. .B \fBtrack\-list/N/demux\-channel\-count\fP
  13703. Number of audio channels as indicated by the container. (Not always
  13704. accurate \- in particular, the track could be decoded as a different
  13705. number of channels.)
  13706. .TP
  13707. .B \fBtrack\-list/N/demux\-channels\fP
  13708. Channel layout as indicated by the container. (Not always accurate.)
  13709. .TP
  13710. .B \fBtrack\-list/N/demux\-samplerate\fP
  13711. Audio sample rate as indicated by the container. (Not always accurate.)
  13712. .TP
  13713. .B \fBtrack\-list/N/demux\-fps\fP
  13714. Video FPS as indicated by the container. (Not always accurate.)
  13715. .TP
  13716. .B \fBtrack\-list/N/demux\-bitrate\fP
  13717. Audio average bitrate, in bits per second. (Not always accurate.)
  13718. .TP
  13719. .B \fBtrack\-list/N/demux\-rotation\fP
  13720. Video clockwise rotation metadata, in degrees.
  13721. .TP
  13722. .B \fBtrack\-list/N/demux\-par\fP
  13723. Pixel aspect ratio.
  13724. .TP
  13725. .B \fBtrack\-list/N/audio\-channels\fP (deprecated)
  13726. Deprecated alias for \fBtrack\-list/N/demux\-channel\-count\fP\&.
  13727. .TP
  13728. .B \fBtrack\-list/N/replaygain\-track\-peak\fP, \fBtrack\-list/N/replaygain\-track\-gain\fP
  13729. Per\-track replaygain values. Only available for audio tracks with
  13730. corresponding information stored in the source file.
  13731. .TP
  13732. .B \fBtrack\-list/N/replaygain\-album\-peak\fP, \fBtrack\-list/N/replaygain\-album\-gain\fP
  13733. Per\-album replaygain values. If the file has per\-track but no per\-album
  13734. information, the per\-album values will be copied from the per\-track
  13735. values currently. It\(aqs possible that future mpv versions will make
  13736. these properties unavailable instead in this case.
  13737. .UNINDENT
  13738. .sp
  13739. When querying the property with the client API using \fBMPV_FORMAT_NODE\fP,
  13740. or with Lua \fBmp.get_property_native\fP, this will return a mpv_node with
  13741. the following contents:
  13742. .INDENT 7.0
  13743. .INDENT 3.5
  13744. .sp
  13745. .nf
  13746. .ft C
  13747. MPV_FORMAT_NODE_ARRAY
  13748.     MPV_FORMAT_NODE_MAP (for each track)
  13749.         "id"                MPV_FORMAT_INT64
  13750.         "type"              MPV_FORMAT_STRING
  13751.         "src\-id"            MPV_FORMAT_INT64
  13752.         "title"             MPV_FORMAT_STRING
  13753.         "lang"              MPV_FORMAT_STRING
  13754.         "albumart"          MPV_FORMAT_FLAG
  13755.         "default"           MPV_FORMAT_FLAG
  13756.         "forced"            MPV_FORMAT_FLAG
  13757.         "selected"          MPV_FORMAT_FLAG
  13758.         "external"          MPV_FORMAT_FLAG
  13759.         "external\-filename" MPV_FORMAT_STRING
  13760.         "codec"             MPV_FORMAT_STRING
  13761.         "ff\-index"          MPV_FORMAT_INT64
  13762.         "decoder\-desc"      MPV_FORMAT_STRING
  13763.         "demux\-w"           MPV_FORMAT_INT64
  13764.         "demux\-h"           MPV_FORMAT_INT64
  13765.         "demux\-channel\-count" MPV_FORMAT_INT64
  13766.         "demux\-channels"    MPV_FORMAT_STRING
  13767.         "demux\-samplerate"  MPV_FORMAT_INT64
  13768.         "demux\-fps"         MPV_FORMAT_DOUBLE
  13769.         "demux\-bitrate"     MPV_FORMAT_INT64
  13770.         "demux\-rotation"    MPV_FORMAT_INT64
  13771.         "demux\-par"         MPV_FORMAT_DOUBLE
  13772.         "audio\-channels"    MPV_FORMAT_INT64
  13773.         "replaygain\-track\-peak" MPV_FORMAT_DOUBLE
  13774.         "replaygain\-track\-gain" MPV_FORMAT_DOUBLE
  13775.         "replaygain\-album\-peak" MPV_FORMAT_DOUBLE
  13776.         "replaygain\-album\-gain" MPV_FORMAT_DOUBLE
  13777. .ft P
  13778. .fi
  13779. .UNINDENT
  13780. .UNINDENT
  13781. .TP
  13782. .B \fBchapter\-list\fP
  13783. List of chapters, current entry marked. Currently, the raw property value
  13784. is useless.
  13785. .sp
  13786. This has a number of sub\-properties. Replace \fBN\fP with the 0\-based chapter
  13787. index.
  13788. .INDENT 7.0
  13789. .TP
  13790. .B \fBchapter\-list/count\fP
  13791. Number of chapters.
  13792. .TP
  13793. .B \fBchapter\-list/N/title\fP
  13794. Chapter title as stored in the file. Not always available.
  13795. .TP
  13796. .B \fBchapter\-list/N/time\fP
  13797. Chapter start time in seconds as float.
  13798. .UNINDENT
  13799. .sp
  13800. When querying the property with the client API using \fBMPV_FORMAT_NODE\fP,
  13801. or with Lua \fBmp.get_property_native\fP, this will return a mpv_node with
  13802. the following contents:
  13803. .INDENT 7.0
  13804. .INDENT 3.5
  13805. .sp
  13806. .nf
  13807. .ft C
  13808. MPV_FORMAT_NODE_ARRAY
  13809.     MPV_FORMAT_NODE_MAP (for each chapter)
  13810.         "title" MPV_FORMAT_STRING
  13811.         "time"  MPV_FORMAT_DOUBLE
  13812. .ft P
  13813. .fi
  13814. .UNINDENT
  13815. .UNINDENT
  13816. .TP
  13817. .B \fBaf\fP, \fBvf\fP (RW)
  13818. See \fB\-\-vf\fP/\fB\-\-af\fP and the \fBvf\fP/\fBaf\fP command.
  13819. .sp
  13820. When querying the property with the client API using \fBMPV_FORMAT_NODE\fP,
  13821. or with Lua \fBmp.get_property_native\fP, this will return a mpv_node with
  13822. the following contents:
  13823. .INDENT 7.0
  13824. .INDENT 3.5
  13825. .sp
  13826. .nf
  13827. .ft C
  13828. MPV_FORMAT_NODE_ARRAY
  13829.     MPV_FORMAT_NODE_MAP (for each filter entry)
  13830.         "name"      MPV_FORMAT_STRING
  13831.         "label"     MPV_FORMAT_STRING [optional]
  13832.         "enabled"   MPV_FORMAT_FLAG [optional]
  13833.         "params"    MPV_FORMAT_NODE_MAP [optional]
  13834.             "key"   MPV_FORMAT_STRING
  13835.             "value" MPV_FORMAT_STRING
  13836. .ft P
  13837. .fi
  13838. .UNINDENT
  13839. .UNINDENT
  13840. .sp
  13841. It\(aqs also possible to write the property using this format.
  13842. .TP
  13843. .B \fBseekable\fP
  13844. Return whether it\(aqs generally possible to seek in the current file.
  13845. .TP
  13846. .B \fBpartially\-seekable\fP
  13847. Return \fByes\fP if the current file is considered seekable, but only because
  13848. the cache is active. This means small relative seeks may be fine, but larger
  13849. seeks may fail anyway. Whether a seek will succeed or not is generally not
  13850. known in advance.
  13851. .sp
  13852. If this property returns true, \fBseekable\fP will also return true.
  13853. .TP
  13854. .B \fBplayback\-abort\fP
  13855. Return whether playback is stopped or is to be stopped. (Useful in obscure
  13856. situations like during \fBon_load\fP hook processing, when the user can
  13857. stop playback, but the script has to explicitly end processing.)
  13858. .TP
  13859. .B \fBcursor\-autohide\fP (RW)
  13860. See \fB\-\-cursor\-autohide\fP\&. Setting this to a new value will always update
  13861. the cursor, and reset the internal timer.
  13862. .TP
  13863. .B \fBosd\-sym\-cc\fP
  13864. Inserts the current OSD symbol as opaque OSD control code (cc). This makes
  13865. sense only with the \fBshow\-text\fP command or options which set OSD messages.
  13866. The control code is implementation specific and is useless for anything else.
  13867. .TP
  13868. .B \fBosd\-ass\-cc\fP
  13869. \fB${osd\-ass\-cc/0}\fP disables escaping ASS sequences of text in OSD,
  13870. \fB${osd\-ass\-cc/1}\fP enables it again. By default, ASS sequences are
  13871. escaped to avoid accidental formatting, and this property can disable
  13872. this behavior. Note that the properties return an opaque OSD control
  13873. code, which only makes sense for the \fBshow\-text\fP command or options
  13874. which set OSD messages.
  13875. .INDENT 7.0
  13876. .INDENT 3.5
  13877. .IP "Example"
  13878. .INDENT 0.0
  13879. .IP \(bu 2
  13880. \fB\-\-osd\-status\-msg=\(aqThis is ${osd\-ass\-cc/0}{\e\eb1}bold text\(aq\fP
  13881. .IP \(bu 2
  13882. \fBshow\-text "This is ${osd\-ass\-cc/0}{\eb1}bold text"\fP
  13883. .UNINDENT
  13884. .UNINDENT
  13885. .UNINDENT
  13886. .sp
  13887. Any ASS override tags as understood by libass can be used.
  13888. .sp
  13889. Note that you need to escape the \fB\e\fP character, because the string is
  13890. processed for C escape sequences before passing it to the OSD code.
  13891. .sp
  13892. A list of tags can be found here: \fI\%http://docs.aegisub.org/latest/ASS_Tags/\fP
  13893. .TP
  13894. .B \fBvo\-configured\fP
  13895. Return whether the VO is configured right now. Usually this corresponds to
  13896. whether the video window is visible. If the \fB\-\-force\-window\fP option is
  13897. used, this is usually always returns \fByes\fP\&.
  13898. .TP
  13899. .B \fBvo\-passes\fP
  13900. Contains introspection about the VO\(aqs active render passes and their
  13901. execution times. Not implemented by all VOs.
  13902. .sp
  13903. This is further subdivided into two frame types, \fBvo\-passes/fresh\fP for
  13904. fresh frames (which have to be uploaded, scaled, etc.) and
  13905. \fBvo\-passes/redraw\fP for redrawn frames (which only have to be re\-painted).
  13906. The number of passes for any given subtype can change from frame to frame,
  13907. and should not be relied upon.
  13908. .sp
  13909. Each frame type has a number of further sub\-properties. Replace \fBTYPE\fP
  13910. with the frame type, \fBN\fP with the 0\-based pass index, and \fBM\fP with the
  13911. 0\-based sample index.
  13912. .INDENT 7.0
  13913. .TP
  13914. .B \fBvo\-passes/TYPE/count\fP
  13915. Number of passes.
  13916. .TP
  13917. .B \fBvo\-passes/TYPE/N/desc\fP
  13918. Human\-friendy description of the pass.
  13919. .TP
  13920. .B \fBvo\-passes/TYPE/N/last\fP
  13921. Last measured execution time, in nanoseconds.
  13922. .TP
  13923. .B \fBvo\-passes/TYPE/N/avg\fP
  13924. Average execution time of this pass, in nanoseconds. The exact
  13925. timeframe varies, but it should generally be a handful of seconds.
  13926. .TP
  13927. .B \fBvo\-passes/TYPE/N/peak\fP
  13928. The peak execution time (highest value) within this averaging range, in
  13929. nanoseconds.
  13930. .TP
  13931. .B \fBvo\-passes/TYPE/N/count\fP
  13932. The number of samples for this pass.
  13933. .TP
  13934. .B \fBvo\-passes/TYPE/N/samples/M\fP
  13935. The raw execution time of a specific sample for this pass, in
  13936. nanoseconds.
  13937. .UNINDENT
  13938. .sp
  13939. When querying the property with the client API using \fBMPV_FORMAT_NODE\fP,
  13940. or with Lua \fBmp.get_property_native\fP, this will return a mpv_node with
  13941. the following contents:
  13942. .INDENT 7.0
  13943. .INDENT 3.5
  13944. .sp
  13945. .nf
  13946. .ft C
  13947. MPV_FORMAT_NODE_MAP
  13948. "TYPE" MPV_FORMAT_NODE_ARRAY
  13949.     MPV_FORMAT_NODE_MAP
  13950.         "desc"    MPV_FORMAT_STRING
  13951.         "last"    MPV_FORMAT_INT64
  13952.         "avg"     MPV_FORMAT_INT64
  13953.         "peak"    MPV_FORMAT_INT64
  13954.         "count"   MPV_FORMAT_INT64
  13955.         "samples" MPV_FORMAT_NODE_ARRAY
  13956.              MP_FORMAT_INT64
  13957. .ft P
  13958. .fi
  13959. .UNINDENT
  13960. .UNINDENT
  13961. .sp
  13962. Note that directly accessing this structure via subkeys is not supported,
  13963. the only access is through aforementioned \fBMPV_FORMAT_NODE\fP\&.
  13964. .TP
  13965. .B \fBvideo\-bitrate\fP, \fBaudio\-bitrate\fP, \fBsub\-bitrate\fP
  13966. Bitrate values calculated on the packet level. This works by dividing the
  13967. bit size of all packets between two keyframes by their presentation
  13968. timestamp distance. (This uses the timestamps are stored in the file, so
  13969. e.g. playback speed does not influence the returned values.) In particular,
  13970. the video bitrate will update only per keyframe, and show the "past"
  13971. bitrate. To make the property more UI friendly, updates to these properties
  13972. are throttled in a certain way.
  13973. .sp
  13974. The unit is bits per second. OSD formatting turns these values in kilobits
  13975. (or megabits, if appropriate), which can be prevented by using the
  13976. raw property value, e.g. with \fB${=video\-bitrate}\fP\&.
  13977. .sp
  13978. Note that the accuracy of these properties is influenced by a few factors.
  13979. If the underlying demuxer rewrites the packets on demuxing (done for some
  13980. file formats), the bitrate might be slightly off. If timestamps are bad
  13981. or jittery (like in Matroska), even constant bitrate streams might show
  13982. fluctuating bitrate.
  13983. .sp
  13984. How exactly these values are calculated might change in the future.
  13985. .sp
  13986. In earlier versions of mpv, these properties returned a static (but bad)
  13987. guess using a completely different method.
  13988. .TP
  13989. .B \fBpacket\-video\-bitrate\fP, \fBpacket\-audio\-bitrate\fP, \fBpacket\-sub\-bitrate\fP
  13990. Old and deprecated properties for \fBvideo\-bitrate\fP, \fBaudio\-bitrate\fP,
  13991. \fBsub\-bitrate\fP\&. They behave exactly the same, but return a value in
  13992. kilobits. Also, they don\(aqt have any OSD formatting, though the same can be
  13993. achieved with e.g. \fB${=video\-bitrate}\fP\&.
  13994. .sp
  13995. These properties shouldn\(aqt be used anymore.
  13996. .TP
  13997. .B \fBaudio\-device\-list\fP
  13998. Return the list of discovered audio devices. This is mostly for use with
  13999. the client API, and reflects what \fB\-\-audio\-device=help\fP with the command
  14000. line player returns.
  14001. .sp
  14002. When querying the property with the client API using \fBMPV_FORMAT_NODE\fP,
  14003. or with Lua \fBmp.get_property_native\fP, this will return a mpv_node with
  14004. the following contents:
  14005. .INDENT 7.0
  14006. .INDENT 3.5
  14007. .sp
  14008. .nf
  14009. .ft C
  14010. MPV_FORMAT_NODE_ARRAY
  14011.     MPV_FORMAT_NODE_MAP (for each device entry)
  14012.         "name"          MPV_FORMAT_STRING
  14013.         "description"   MPV_FORMAT_STRING
  14014. .ft P
  14015. .fi
  14016. .UNINDENT
  14017. .UNINDENT
  14018. .sp
  14019. The \fBname\fP is what is to be passed to the \fB\-\-audio\-device\fP option (and
  14020. often a rather cryptic audio API\-specific ID), while \fBdescription\fP is
  14021. human readable free form text. The description is set to the device name
  14022. (minus mpv\-specific \fB<driver>/\fP prefix) if no description is available
  14023. or the description would have been an empty string.
  14024. .sp
  14025. The special entry with the name set to \fBauto\fP selects the default audio
  14026. output driver and the default device.
  14027. .sp
  14028. The property can be watched with the property observation mechanism in
  14029. the client API and in Lua scripts. (Technically, change notification is
  14030. enabled the first time this property is read.)
  14031. .TP
  14032. .B \fBaudio\-device\fP (RW)
  14033. Set the audio device. This directly reads/writes the \fB\-\-audio\-device\fP
  14034. option, but on write accesses, the audio output will be scheduled for
  14035. reloading.
  14036. .sp
  14037. Writing this property while no audio output is active will not automatically
  14038. enable audio. (This is also true in the case when audio was disabled due to
  14039. reinitialization failure after a previous write access to \fBaudio\-device\fP\&.)
  14040. .sp
  14041. This property also doesn\(aqt tell you which audio device is actually in use.
  14042. .sp
  14043. How these details are handled may change in the future.
  14044. .TP
  14045. .B \fBcurrent\-vo\fP
  14046. Current video output driver (name as used with \fB\-\-vo\fP).
  14047. .TP
  14048. .B \fBcurrent\-ao\fP
  14049. Current audio output driver (name as used with \fB\-\-ao\fP).
  14050. .TP
  14051. .B \fBshared\-script\-properties\fP (RW)
  14052. This is a key/value map of arbitrary strings shared between scripts for
  14053. general use. The player itself does not use any data in it (although some
  14054. builtin scripts may). The property is not preserved across player restarts.
  14055. .sp
  14056. This is very primitive, inefficient, and annoying to use. It\(aqs a makeshift
  14057. solution which could go away any time (for example, when a better solution
  14058. becomes available). This is also why this property has an annoying name. You
  14059. should avoid using it, unless you absolutely have to.
  14060. .sp
  14061. Lua scripting has helpers starting with \fButils.shared_script_property_\fP\&.
  14062. They are undocumented because you should not use this property. If you still
  14063. think you must, you should use the helpers instead of the property directly.
  14064. .sp
  14065. You are supposed to use the \fBchange\-list\fP command to modify the contents.
  14066. Reading, modifying, and writing the property manually could data loss if two
  14067. scripts update different keys at the same time due to lack of
  14068. synchronization. The Lua helpers take care of this.
  14069. .sp
  14070. (There is no way to ensure synchronization if two scripts try to update the
  14071. same key at the same time.)
  14072. .TP
  14073. .B \fBworking\-directory\fP
  14074. Return the working directory of the mpv process. Can be useful for JSON IPC
  14075. users, because the command line player usually works with relative paths.
  14076. .TP
  14077. .B \fBprotocol\-list\fP
  14078. List of protocol prefixes potentially recognized by the player. They are
  14079. returned without trailing \fB://\fP suffix (which is still always required).
  14080. In some cases, the protocol will not actually be supported (consider
  14081. \fBhttps\fP if ffmpeg is not compiled with TLS support).
  14082. .TP
  14083. .B \fBdecoder\-list\fP
  14084. List of decoders supported. This lists decoders which can be passed to
  14085. \fB\-\-vd\fP and \fB\-\-ad\fP\&.
  14086. .INDENT 7.0
  14087. .TP
  14088. .B \fBcodec\fP
  14089. Canonical codec name, which identifies the format the decoder can
  14090. handle.
  14091. .TP
  14092. .B \fBdriver\fP
  14093. The name of the decoder itself. Often, this is the same as \fBcodec\fP\&.
  14094. Sometimes it can be different. It is used to distinguish multiple
  14095. decoders for the same codec.
  14096. .TP
  14097. .B \fBdescription\fP
  14098. Human readable description of the decoder and codec.
  14099. .UNINDENT
  14100. .sp
  14101. When querying the property with the client API using \fBMPV_FORMAT_NODE\fP,
  14102. or with Lua \fBmp.get_property_native\fP, this will return a mpv_node with
  14103. the following contents:
  14104. .INDENT 7.0
  14105. .INDENT 3.5
  14106. .sp
  14107. .nf
  14108. .ft C
  14109. MPV_FORMAT_NODE_ARRAY
  14110.     MPV_FORMAT_NODE_MAP (for each decoder entry)
  14111.         "codec"         MPV_FORMAT_STRING
  14112.         "driver"        MPV_FORMAT_STRING
  14113.         "description"   MPV_FORMAT_STRING
  14114. .ft P
  14115. .fi
  14116. .UNINDENT
  14117. .UNINDENT
  14118. .TP
  14119. .B \fBencoder\-list\fP
  14120. List of libavcodec encoders. This has the same format as \fBdecoder\-list\fP\&.
  14121. The encoder names (\fBdriver\fP entries) can be passed to \fB\-\-ovc\fP and
  14122. \fB\-\-oac\fP (without the \fBlavc:\fP prefix required by \fB\-\-vd\fP and \fB\-\-ad\fP).
  14123. .TP
  14124. .B \fBdemuxer\-lavf\-list\fP
  14125. List of available libavformat demuxers\(aq names. This can be used to check
  14126. for support for a specific format or use with \fB\-\-demuxer\-lavf\-format\fP\&.
  14127. .TP
  14128. .B \fBmpv\-version\fP
  14129. Return the mpv version/copyright string. Depending on how the binary was
  14130. built, it might contain either a release version, or just a git hash.
  14131. .TP
  14132. .B \fBmpv\-configuration\fP
  14133. Return the configuration arguments which were passed to the build system
  14134. (typically the way \fB\&./waf configure ...\fP was invoked).
  14135. .TP
  14136. .B \fBffmpeg\-version\fP
  14137. Return the contents of the \fBav_version_info()\fP API call. This is a string
  14138. which identifies the build in some way, either through a release version
  14139. number, or a git hash. This applies to Libav as well (the property is
  14140. still named the same.) This property is unavailable if mpv is linked against
  14141. older FFmpeg and Libav versions.
  14142. .TP
  14143. .B \fBoptions/<name>\fP (RW)
  14144. Read\-only access to value of option \fB\-\-<name>\fP\&. Most options can be
  14145. changed at runtime by writing to this property. Note that many options
  14146. require reloading the file for changes to take effect. If there is an
  14147. equivalent property, prefer setting the property instead.
  14148. .sp
  14149. There shouldn\(aqt be any reason to access \fBoptions/<name>\fP instead of
  14150. \fB<name>\fP, except in situations in which the properties have different
  14151. behavior or conflicting semantics.
  14152. .TP
  14153. .B \fBfile\-local\-options/<name>\fP
  14154. Similar to \fBoptions/<name>\fP, but when setting an option through this
  14155. property, the option is reset to its old value once the current file has
  14156. stopped playing. Trying to write an option while no file is playing (or
  14157. is being loaded) results in an error.
  14158. .sp
  14159. (Note that if an option is marked as file\-local, even \fBoptions/\fP will
  14160. access the local value, and the \fBold\fP value, which will be restored on
  14161. end of playback, cannot be read or written until end of playback.)
  14162. .TP
  14163. .B \fBoption\-info/<name>\fP
  14164. Additional per\-option information.
  14165. .sp
  14166. This has a number of sub\-properties. Replace \fB<name>\fP with the name of
  14167. a top\-level option. No guarantee of stability is given to any of these
  14168. sub\-properties \- they may change radically in the feature.
  14169. .INDENT 7.0
  14170. .TP
  14171. .B \fBoption\-info/<name>/name\fP
  14172. Returns the name of the option.
  14173. .TP
  14174. .B \fBoption\-info/<name>/type\fP
  14175. Return the name of the option type, like \fBString\fP or \fBInteger\fP\&.
  14176. For many complex types, this isn\(aqt very accurate.
  14177. .TP
  14178. .B \fBoption\-info/<name>/set\-from\-commandline\fP
  14179. Return \fByes\fP if the option was set from the mpv command line,
  14180. \fBno\fP otherwise. What this is set to if the option is e.g. changed
  14181. at runtime is left undefined (meaning it could change in the future).
  14182. .TP
  14183. .B \fBoption\-info/<name>/set\-locally\fP
  14184. Return \fByes\fP if the option was set per\-file. This is the case with
  14185. automatically loaded profiles, file\-dir configs, and other cases. It
  14186. means the option value will be restored to the value before playback
  14187. start when playback ends.
  14188. .TP
  14189. .B \fBoption\-info/<name>/default\-value\fP
  14190. The default value of the option. May not always be available.
  14191. .TP
  14192. .B \fBoption\-info/<name>/min\fP, \fBoption\-info/<name>/max\fP
  14193. Integer minimum and maximum values allowed for the option. Only
  14194. available if the options are numeric, and the minimum/maximum has been
  14195. set internally. It\(aqs also possible that only one of these is set.
  14196. .TP
  14197. .B \fBoption\-info/<name>/choices\fP
  14198. If the option is a choice option, the possible choices. Choices that
  14199. are integers may or may not be included (they can be implied by \fBmin\fP
  14200. and \fBmax\fP). Note that options which behave like choice options, but
  14201. are not actual choice options internally, may not have this info
  14202. available.
  14203. .UNINDENT
  14204. .TP
  14205. .B \fBproperty\-list\fP
  14206. Return the list of top\-level properties.
  14207. .TP
  14208. .B \fBprofile\-list\fP
  14209. Return the list of profiles and their contents. This is highly
  14210. implementation\-specific, and may change any time. Currently, it returns
  14211. an array of options for each profile. Each option has a name and a value,
  14212. with the value currently always being a string. Note that the options array
  14213. is not a map, as order matters and duplicate entries are possible. Recursive
  14214. profiles are not expanded, and show up as special \fBprofile\fP options.
  14215. .TP
  14216. .B \fBcommand\-list\fP
  14217. Return the list of input commands. This returns an array of maps, where
  14218. each map node represents a command. This map currently only has a single
  14219. entry: \fBname\fP for the name of the command. (This property is supposed to
  14220. be a replacement for \fB\-\-input\-cmdlist\fP\&. The option dumps some more
  14221. information, but it\(aqs a valid feature request to extend this property if
  14222. needed.)
  14223. .TP
  14224. .B \fBinput\-bindings\fP
  14225. Return list of current input key bindings. This returns an array of maps,
  14226. where each map node represents a binding for a single key/command. This map
  14227. has the following entries:
  14228. .INDENT 7.0
  14229. .TP
  14230. .B \fBkey\fP
  14231. The key name. This is normalized and may look slightly different from
  14232. how it was specified in the source (e.g. in input.conf).
  14233. .TP
  14234. .B \fBcmd\fP
  14235. The command mapped to the key. (Currently, this is exactly the same
  14236. string as specified in the source, other than stripping whitespace and
  14237. comments. It\(aqs possible that it will be normalized in the future.)
  14238. .TP
  14239. .B \fBis_weak\fP
  14240. If set to true, any existing and active user bindings will take priority.
  14241. .TP
  14242. .B \fBowner\fP
  14243. If this entry exists, the name of the script (or similar) which added
  14244. this binding.
  14245. .TP
  14246. .B \fBsection\fP
  14247. Name of the section this binding is part of. This is a rarely used
  14248. mechanism. This entry may be removed or change meaning in the future.
  14249. .TP
  14250. .B \fBpriority\fP
  14251. A number. Bindings with a higher value are preferred over bindings
  14252. with a lower value. If the value is negative, this binding is inactive
  14253. and will not be triggered by input. Note that mpv does not use this
  14254. value internally, and matching of bindings may work slightly differently
  14255. in some cases. In addition, this value is dynamic and can change around
  14256. at runtime.
  14257. .TP
  14258. .B \fBcomment\fP
  14259. If available, the comment following the command on the same line. (For
  14260. example, the input.conf entry \fBf cycle bla # toggle bla\fP would
  14261. result in an entry with \fBcomment = "toggle bla", cmd = "cycle bla"\fP\&.)
  14262. .UNINDENT
  14263. .sp
  14264. This property is read\-only, and change notification is not supported.
  14265. Currently, there is no mechanism to change key bindings at runtime, other
  14266. than scripts adding or removing their own bindings.
  14267. .UNINDENT
  14268. .SS Inconsistencies between options and properties
  14269. .sp
  14270. You can access (almost) all options as properties, though there are some
  14271. caveats with some properties (due to historical reasons):
  14272. .INDENT 0.0
  14273. .TP
  14274. .B \fBvid\fP, \fBaid\fP, \fBsid\fP
  14275. While playback is active, these result the actually active tracks. For
  14276. example, if you set \fBaid=5\fP, and the currently played file contains no
  14277. audio track with ID 5, the \fBaid\fP property will return \fBno\fP\&.
  14278. .sp
  14279. Before mpv 0.31.0, you could set existing tracks at runtime only.
  14280. .TP
  14281. .B \fBdisplay\-fps\fP
  14282. This inconsistent behavior is deprecated. Post\-deprecation, the reported
  14283. value and the option value are cleanly separated (\fBoverride\-display\-fps\fP
  14284. for the option value).
  14285. .TP
  14286. .B \fBvf\fP, \fBaf\fP
  14287. If you set the properties during playback, and the filter chain fails to
  14288. reinitialize, the option will be set, but the runtime filter chain does not
  14289. change. On the other hand, the next video to be played will fail, because
  14290. the initial filter chain cannot be created.
  14291. .sp
  14292. This behavior changed in mpv 0.31.0. Before this, the new value was rejected
  14293. \fIiff\fP video (for \fBvf\fP) or audio (for \fBaf\fP) was active. If playback was
  14294. not active, the behavior was the same as the current behavior.
  14295. .TP
  14296. .B \fBplaylist\fP
  14297. The property is read\-only and returns the current internal playlist. The
  14298. option is for loading playlist during command line parsing. For client API
  14299. uses, you should use the \fBloadlist\fP command instead.
  14300. .TP
  14301. .B \fBprofile\fP, \fBinclude\fP
  14302. These are write\-only, and will perform actions as they are written to,
  14303. exactly as if they were used on the mpv CLI commandline. Their only use is
  14304. when using libmpv before \fBmpv_initialize()\fP, which in turn is probably
  14305. only useful in encoding mode. Normal libmpv users should use other
  14306. mechanisms, such as the \fBapply\-profile\fP command, and the
  14307. \fBmpv_load_config_file\fP API function. Avoid these properties.
  14308. .UNINDENT
  14309. .SS Property Expansion
  14310. .sp
  14311. All string arguments to input commands as well as certain options (like
  14312. \fB\-\-term\-playing\-msg\fP) are subject to property expansion. Note that property
  14313. expansion does not work in places where e.g. numeric parameters are expected.
  14314. (For example, the \fBadd\fP command does not do property expansion. The \fBset\fP
  14315. command is an exception and not a general rule.)
  14316. .INDENT 0.0
  14317. .INDENT 3.5
  14318. .IP "Example for input.conf"
  14319. .INDENT 0.0
  14320. .TP
  14321. .B \fBi show\-text "Filename: ${filename}"\fP
  14322. shows the filename of the current file when pressing the \fBi\fP key
  14323. .UNINDENT
  14324. .UNINDENT
  14325. .UNINDENT
  14326. .sp
  14327. Within \fBinput.conf\fP, property expansion can be inhibited by putting the
  14328. \fBraw\fP prefix in front of commands.
  14329. .sp
  14330. The following expansions are supported:
  14331. .INDENT 0.0
  14332. .TP
  14333. .B \fB${NAME}\fP
  14334. Expands to the value of the property \fBNAME\fP\&. If retrieving the property
  14335. fails, expand to an error string. (Use \fB${NAME:}\fP with a trailing
  14336. \fB:\fP to expand to an empty string instead.)
  14337. If \fBNAME\fP is prefixed with \fB=\fP, expand to the raw value of the property
  14338. (see section below).
  14339. .TP
  14340. .B \fB${NAME:STR}\fP
  14341. Expands to the value of the property \fBNAME\fP, or \fBSTR\fP if the
  14342. property cannot be retrieved. \fBSTR\fP is expanded recursively.
  14343. .TP
  14344. .B \fB${?NAME:STR}\fP
  14345. Expands to \fBSTR\fP (recursively) if the property \fBNAME\fP is available.
  14346. .TP
  14347. .B \fB${!NAME:STR}\fP
  14348. Expands to \fBSTR\fP (recursively) if the property \fBNAME\fP cannot be
  14349. retrieved.
  14350. .TP
  14351. .B \fB${?NAME==VALUE:STR}\fP
  14352. Expands to \fBSTR\fP (recursively) if the property \fBNAME\fP expands to a
  14353. string equal to \fBVALUE\fP\&. You can prefix \fBNAME\fP with \fB=\fP in order to
  14354. compare the raw value of a property (see section below). If the property
  14355. is unavailable, or other errors happen when retrieving it, the value is
  14356. never considered equal.
  14357. Note that \fBVALUE\fP can\(aqt contain any of the characters \fB:\fP or \fB}\fP\&.
  14358. Also, it is possible that escaping with \fB"\fP or \fB%\fP might be added in
  14359. the future, should the need arise.
  14360. .TP
  14361. .B \fB${!NAME==VALUE:STR}\fP
  14362. Same as with the \fB?\fP variant, but \fBSTR\fP is expanded if the value is
  14363. not equal. (Using the same semantics as with \fB?\fP\&.)
  14364. .TP
  14365. .B \fB$$\fP
  14366. Expands to \fB$\fP\&.
  14367. .TP
  14368. .B \fB$}\fP
  14369. Expands to \fB}\fP\&. (To produce this character inside recursive
  14370. expansion.)
  14371. .TP
  14372. .B \fB$>\fP
  14373. Disable property expansion and special handling of \fB$\fP for the rest
  14374. of the string.
  14375. .UNINDENT
  14376. .sp
  14377. In places where property expansion is allowed, C\-style escapes are often
  14378. accepted as well. Example:
  14379. .INDENT 0.0
  14380. .INDENT 3.5
  14381. .INDENT 0.0
  14382. .IP \(bu 2
  14383. \fB\en\fP becomes a newline character
  14384. .IP \(bu 2
  14385. \fB\e\e\fP expands to \fB\e\fP
  14386. .UNINDENT
  14387. .UNINDENT
  14388. .UNINDENT
  14389. .SS Raw and Formatted Properties
  14390. .sp
  14391. Normally, properties are formatted as human\-readable text, meant to be
  14392. displayed on OSD or on the terminal. It is possible to retrieve an unformatted
  14393. (raw) value from a property by prefixing its name with \fB=\fP\&. These raw values
  14394. can be parsed by other programs and follow the same conventions as the options
  14395. associated with the properties.
  14396. .INDENT 0.0
  14397. .INDENT 3.5
  14398. .IP "Examples"
  14399. .INDENT 0.0
  14400. .IP \(bu 2
  14401. \fB${time\-pos}\fP expands to \fB00:14:23\fP (if playback position is at 14
  14402. minutes 23 seconds)
  14403. .IP \(bu 2
  14404. \fB${=time\-pos}\fP expands to \fB863.4\fP (same time, plus 400 milliseconds \-
  14405. milliseconds are normally not shown in the formatted case)
  14406. .UNINDENT
  14407. .UNINDENT
  14408. .UNINDENT
  14409. .sp
  14410. Sometimes, the difference in amount of information carried by raw and formatted
  14411. property values can be rather big. In some cases, raw values have more
  14412. information, like higher precision than seconds with \fBtime\-pos\fP\&. Sometimes
  14413. it is the other way around, e.g. \fBaid\fP shows track title and language in the
  14414. formatted case, but only the track number if it is raw.
  14415. .SH ON SCREEN CONTROLLER
  14416. .sp
  14417. The On Screen Controller (short: OSC) is a minimal GUI integrated with mpv to
  14418. offer basic mouse\-controllability. It is intended to make interaction easier
  14419. for new users and to enable precise and direct seeking.
  14420. .sp
  14421. The OSC is enabled by default if mpv was compiled with Lua support. It can be
  14422. disabled entirely using the \fB\-\-osc=no\fP option.
  14423. .SS Using the OSC
  14424. .sp
  14425. By default, the OSC will show up whenever the mouse is moved inside the
  14426. player window and will hide if the mouse is not moved outside the OSC for
  14427. 0.5 seconds or if the mouse leaves the window.
  14428. .SS The Interface
  14429. .INDENT 0.0
  14430. .INDENT 3.5
  14431. .sp
  14432. .nf
  14433. .ft C
  14434. +\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-+
  14435. | pl prev | pl next  |  title                                   |    cache |
  14436. +\-\-\-\-\-\-+\-\-+\-\-\-+\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-+\-\-\-\-\-\-\-+\-\-\-\-\-+\-\-\-\-\-+\-\-\-\-+
  14437. | play | skip | skip | time    |  seekbar  | time | audio | sub | vol | fs |
  14438. |      | back | frwd | elapsed |           | left |       |     |     |    |
  14439. +\-\-\-\-\-\-+\-\-\-\-\-\-+\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-+\-\-\-\-\-\-\-+\-\-\-\-\-+\-\-\-\-\-+\-\-\-\-+
  14440. .ft P
  14441. .fi
  14442. .UNINDENT
  14443. .UNINDENT
  14444. .INDENT 0.0
  14445. .TP
  14446. .B pl prev
  14447. .TS
  14448. center;
  14449. |l|l|.
  14450. _
  14451. T{
  14452. left\-click
  14453. T}	T{
  14454. play previous file in playlist
  14455. T}
  14456. _
  14457. T{
  14458. right\-click
  14459. T}	T{
  14460. show playlist
  14461. T}
  14462. _
  14463. T{
  14464. shift+L\-click
  14465. T}	T{
  14466. show playlist
  14467. T}
  14468. _
  14469. .TE
  14470. .TP
  14471. .B pl next
  14472. .TS
  14473. center;
  14474. |l|l|.
  14475. _
  14476. T{
  14477. left\-click
  14478. T}	T{
  14479. play next file in playlist
  14480. T}
  14481. _
  14482. T{
  14483. right\-click
  14484. T}	T{
  14485. show playlist
  14486. T}
  14487. _
  14488. T{
  14489. shift+L\-click
  14490. T}	T{
  14491. show playlist
  14492. T}
  14493. _
  14494. .TE
  14495. .TP
  14496. .B title
  14497. .nf
  14498. Displays current media\-title, filename, or custom title
  14499. .fi
  14500. .sp
  14501. .TS
  14502. center;
  14503. |l|l|.
  14504. _
  14505. T{
  14506. left\-click
  14507. T}	T{
  14508. show playlist position and length and full title
  14509. T}
  14510. _
  14511. T{
  14512. right\-click
  14513. T}	T{
  14514. show filename
  14515. T}
  14516. _
  14517. .TE
  14518. .TP
  14519. .B cache
  14520. .nf
  14521. Shows current cache fill status
  14522. .fi
  14523. .sp
  14524. .TP
  14525. .B play
  14526. .TS
  14527. center;
  14528. |l|l|.
  14529. _
  14530. T{
  14531. left\-click
  14532. T}	T{
  14533. toggle play/pause
  14534. T}
  14535. _
  14536. .TE
  14537. .TP
  14538. .B skip back
  14539. .TS
  14540. center;
  14541. |l|l|.
  14542. _
  14543. T{
  14544. left\-click
  14545. T}	T{
  14546. go to beginning of chapter / previous chapter
  14547. T}
  14548. _
  14549. T{
  14550. right\-click
  14551. T}	T{
  14552. show chapters
  14553. T}
  14554. _
  14555. T{
  14556. shift+L\-click
  14557. T}	T{
  14558. show chapters
  14559. T}
  14560. _
  14561. .TE
  14562. .TP
  14563. .B skip frwd
  14564. .TS
  14565. center;
  14566. |l|l|.
  14567. _
  14568. T{
  14569. left\-click
  14570. T}	T{
  14571. go to next chapter
  14572. T}
  14573. _
  14574. T{
  14575. right\-click
  14576. T}	T{
  14577. show chapters
  14578. T}
  14579. _
  14580. T{
  14581. shift+L\-click
  14582. T}	T{
  14583. show chapters
  14584. T}
  14585. _
  14586. .TE
  14587. .TP
  14588. .B time elapsed
  14589. .nf
  14590. Shows current playback position timestamp
  14591. .fi
  14592. .sp
  14593. .TS
  14594. center;
  14595. |l|l|.
  14596. _
  14597. T{
  14598. left\-click
  14599. T}	T{
  14600. toggle displaying timecodes with milliseconds
  14601. T}
  14602. _
  14603. .TE
  14604. .TP
  14605. .B seekbar
  14606. .nf
  14607. Indicates current playback position and position of chapters
  14608. .fi
  14609. .sp
  14610. .TS
  14611. center;
  14612. |l|l|.
  14613. _
  14614. T{
  14615. left\-click
  14616. T}	T{
  14617. seek to position
  14618. T}
  14619. _
  14620. .TE
  14621. .TP
  14622. .B time left
  14623. .nf
  14624. Shows remaining playback time timestamp
  14625. .fi
  14626. .sp
  14627. .TS
  14628. center;
  14629. |l|l|.
  14630. _
  14631. T{
  14632. left\-click
  14633. T}	T{
  14634. toggle between total and remaining time
  14635. T}
  14636. _
  14637. .TE
  14638. .TP
  14639. .B audio and sub
  14640. .nf
  14641. Displays selected track and amount of available tracks
  14642. .fi
  14643. .sp
  14644. .TS
  14645. center;
  14646. |l|l|.
  14647. _
  14648. T{
  14649. left\-click
  14650. T}	T{
  14651. cycle audio/sub tracks forward
  14652. T}
  14653. _
  14654. T{
  14655. right\-click
  14656. T}	T{
  14657. cycle audio/sub tracks backwards
  14658. T}
  14659. _
  14660. T{
  14661. shift+L\-click
  14662. T}	T{
  14663. show available audio/sub tracks
  14664. T}
  14665. _
  14666. .TE
  14667. .TP
  14668. .B vol
  14669. .TS
  14670. center;
  14671. |l|l|.
  14672. _
  14673. T{
  14674. left\-click
  14675. T}	T{
  14676. toggle mute
  14677. T}
  14678. _
  14679. T{
  14680. mouse wheel
  14681. T}	T{
  14682. volume up/down
  14683. T}
  14684. _
  14685. .TE
  14686. .TP
  14687. .B fs
  14688. .TS
  14689. center;
  14690. |l|l|.
  14691. _
  14692. T{
  14693. left\-click
  14694. T}	T{
  14695. toggle fullscreen
  14696. T}
  14697. _
  14698. .TE
  14699. .UNINDENT
  14700. .SS Key Bindings
  14701. .sp
  14702. These key bindings are active by default if nothing else is already bound to
  14703. these keys. In case of collision, the function needs to be bound to a
  14704. different key. See the \fI\%Script Commands\fP section.
  14705. .TS
  14706. center;
  14707. |l|l|.
  14708. _
  14709. T{
  14710. del
  14711. T}	T{
  14712. Cycles visibility between never / auto (mouse\-move) / always
  14713. T}
  14714. _
  14715. .TE
  14716. .SS Configuration
  14717. .sp
  14718. The OSC offers limited configuration through a config file
  14719. \fBscript\-opts/osc.conf\fP placed in mpv\(aqs user dir and through the
  14720. \fB\-\-script\-opts\fP command\-line option. Options provided through the command\-line
  14721. will override those from the config file.
  14722. .SS Config Syntax
  14723. .sp
  14724. The config file must exactly follow the following syntax:
  14725. .INDENT 0.0
  14726. .INDENT 3.5
  14727. .sp
  14728. .nf
  14729. .ft C
  14730. # this is a comment
  14731. optionA=value1
  14732. optionB=value2
  14733. .ft P
  14734. .fi
  14735. .UNINDENT
  14736. .UNINDENT
  14737. .sp
  14738. \fB#\fP can only be used at the beginning of a line and there may be no
  14739. spaces around the \fB=\fP or anywhere else.
  14740. .SS Command\-line Syntax
  14741. .sp
  14742. To avoid collisions with other scripts, all options need to be prefixed with
  14743. \fBosc\-\fP\&.
  14744. .sp
  14745. Example:
  14746. .INDENT 0.0
  14747. .INDENT 3.5
  14748. .sp
  14749. .nf
  14750. .ft C
  14751. \-\-script\-opts=osc\-optionA=value1,osc\-optionB=value2
  14752. .ft P
  14753. .fi
  14754. .UNINDENT
  14755. .UNINDENT
  14756. .SS Configurable Options
  14757. .INDENT 0.0
  14758. .TP
  14759. .B \fBlayout\fP
  14760. Default: bottombar
  14761. .sp
  14762. The layout for the OSC. Currently available are: box, slimbox,
  14763. bottombar and topbar. Default pre\-0.21.0 was \(aqbox\(aq.
  14764. .TP
  14765. .B \fBseekbarstyle\fP
  14766. Default: bar
  14767. .sp
  14768. Sets the style of the playback position marker and overall shape
  14769. of the seekbar: \fBbar\fP, \fBdiamond\fP or \fBknob\fP\&.
  14770. .TP
  14771. .B \fBseekbarhandlesize\fP
  14772. Default: 0.6
  14773. .sp
  14774. Size ratio of the seek handle if \fBseekbarstyle\fP is set to \fBdimaond\fP
  14775. or \fBknob\fP\&. This is relative to the full height of the seekbar.
  14776. .TP
  14777. .B \fBseekbarkeyframes\fP
  14778. Default: yes
  14779. .sp
  14780. Controls the mode used to seek when dragging the seekbar. By default,
  14781. keyframes are used. If set to false, exact seeking on mouse drags
  14782. will be used instead. Keyframes are preferred, but exact seeks may be
  14783. useful in cases where keyframes cannot be found. Note that using exact
  14784. seeks can potentially make mouse dragging much slower.
  14785. .TP
  14786. .B \fBseekrangestyle\fP
  14787. Default: inverted
  14788. .sp
  14789. Display seekable ranges on the seekbar. \fBbar\fP shows them on the full
  14790. height of the bar, \fBline\fP as a thick line and \fBinverted\fP as a thin
  14791. line that is inverted over playback position markers. \fBnone\fP will hide
  14792. them. Additionally, \fBslider\fP will show a permanent handle inside the seekbar
  14793. with cached ranges marked inside. Note that these will look differently
  14794. based on the seekbarstyle option. Also, \fBslider\fP does not work with
  14795. \fBseekbarstyle\fP set to \fBbar\fP\&.
  14796. .TP
  14797. .B \fBseekrangeseparate\fP
  14798. Default: yes
  14799. .sp
  14800. Controls whether to show line\-style seekable ranges on top of the
  14801. seekbar or separately if \fBseekbarstyle\fP is set to \fBbar\fP\&.
  14802. .TP
  14803. .B \fBseekrangealpha\fP
  14804. Default: 200
  14805. .sp
  14806. Alpha of the seekable ranges, 0 (opaque) to 255 (fully transparent).
  14807. .TP
  14808. .B \fBdeadzonesize\fP
  14809. Default: 0.5
  14810. .sp
  14811. Size of the deadzone. The deadzone is an area that makes the mouse act
  14812. like leaving the window. Movement there won\(aqt make the OSC show up and
  14813. it will hide immediately if the mouse enters it. The deadzone starts
  14814. at the window border opposite to the OSC and the size controls how much
  14815. of the window it will span. Values between 0.0 and 1.0, where 0 means the
  14816. OSC will always popup with mouse movement in the window, and 1 means the
  14817. OSC will only show up when the mouse hovers it. Default pre\-0.21.0 was 0.
  14818. .TP
  14819. .B \fBminmousemove\fP
  14820. Default: 0
  14821. .sp
  14822. Minimum amount of pixels the mouse has to move between ticks to make
  14823. the OSC show up. Default pre\-0.21.0 was 3.
  14824. .TP
  14825. .B \fBshowwindowed\fP
  14826. Default: yes
  14827. .sp
  14828. Enable the OSC when windowed
  14829. .TP
  14830. .B \fBshowfullscreen\fP
  14831. Default: yes
  14832. .sp
  14833. Enable the OSC when fullscreen
  14834. .TP
  14835. .B \fBscalewindowed\fP
  14836. Default: 1.0
  14837. .sp
  14838. Scale factor of the OSC when windowed.
  14839. .TP
  14840. .B \fBscalefullscreen\fP
  14841. Default: 1.0
  14842. .sp
  14843. Scale factor of the OSC when fullscreen
  14844. .TP
  14845. .B \fBscaleforcedwindow\fP
  14846. Default: 2.0
  14847. .sp
  14848. Scale factor of the OSC when rendered on a forced (dummy) window
  14849. .TP
  14850. .B \fBvidscale\fP
  14851. Default: yes
  14852. .sp
  14853. Scale the OSC with the video
  14854. \fBno\fP tries to keep the OSC size constant as much as the window size allows
  14855. .TP
  14856. .B \fBvalign\fP
  14857. Default: 0.8
  14858. .sp
  14859. Vertical alignment, \-1 (top) to 1 (bottom)
  14860. .TP
  14861. .B \fBhalign\fP
  14862. Default: 0.0
  14863. .sp
  14864. Horizontal alignment, \-1 (left) to 1 (right)
  14865. .TP
  14866. .B \fBbarmargin\fP
  14867. Default: 0
  14868. .sp
  14869. Margin from bottom (bottombar) or top (topbar), in pixels
  14870. .TP
  14871. .B \fBboxalpha\fP
  14872. Default: 80
  14873. .sp
  14874. Alpha of the background box, 0 (opaque) to 255 (fully transparent)
  14875. .TP
  14876. .B \fBhidetimeout\fP
  14877. Default: 500
  14878. .sp
  14879. Duration in ms until the OSC hides if no mouse movement, must not be
  14880. negative
  14881. .TP
  14882. .B \fBfadeduration\fP
  14883. Default: 200
  14884. .sp
  14885. Duration of fade out in ms, 0 = no fade
  14886. .TP
  14887. .B \fBtitle\fP
  14888. Default: ${media\-title}
  14889. .sp
  14890. String that supports property expansion that will be displayed as
  14891. OSC title.
  14892. ASS tags are escaped, and newlines and trailing slashes are stripped.
  14893. .TP
  14894. .B \fBtooltipborder\fP
  14895. Default: 1
  14896. .sp
  14897. Size of the tooltip outline when using bottombar or topbar layouts
  14898. .TP
  14899. .B \fBtimetotal\fP
  14900. Default: no
  14901. .sp
  14902. Show total time instead of time remaining
  14903. .TP
  14904. .B \fBtimems\fP
  14905. Default: no
  14906. .sp
  14907. Display timecodes with milliseconds
  14908. .TP
  14909. .B \fBvisibility\fP
  14910. Default: auto (auto hide/show on mouse move)
  14911. .sp
  14912. Also supports \fBnever\fP and \fBalways\fP
  14913. .TP
  14914. .B \fBboxmaxchars\fP
  14915. Default: 80
  14916. .sp
  14917. Max chars for the osc title at the box layout. mpv does not measure the
  14918. text width on screen and so it needs to limit it by number of chars. The
  14919. default is conservative to allow wide fonts to be used without overflow.
  14920. However, with many common fonts a bigger number can be used. YMMV.
  14921. .TP
  14922. .B \fBboxvideo\fP
  14923. Default: no
  14924. .sp
  14925. Whether to overlay the osc over the video (\fBno\fP), or to box the video
  14926. within the areas not covered by the osc (\fByes\fP). If this option is set,
  14927. the osc may overwrite the \fB\-\-video\-margin\-ratio\-*\fP options, even if the
  14928. user has set them. (It will not overwrite them if all of them are set to
  14929. default values.)
  14930. .sp
  14931. Currently, this is supported for the \fBbottombar\fP and \fBtopbar\fP layout
  14932. only. The other layouts do not change if this option is set. Separately,
  14933. if window controls are present (see below), they will be affected
  14934. regardless of which osc layout is in use.
  14935. .sp
  14936. The border is static and appears even if the OSC is configured to appear
  14937. only on mouse interaction. If the OSC is invisible, the border is simply
  14938. filled with the background color (black by default).
  14939. .sp
  14940. This currently still makes the OSC overlap with subtitles (if the
  14941. \fB\-\-sub\-use\-margins\fP option is set to \fByes\fP, the default). This may be
  14942. fixed later.
  14943. .sp
  14944. This does not work correctly with video outputs like \fB\-\-vo=xv\fP, which
  14945. render OSD into the unscaled video.
  14946. .TP
  14947. .B \fBwindowcontrols\fP
  14948. Default: auto (Show window controls if there is no window border)
  14949. .sp
  14950. Whether to show window management controls over the video, and if so,
  14951. which side of the window to place them. This may be desirable when the
  14952. window has no decorations, either because they have been explicitly
  14953. disabled (\fBborder=no\fP) or because the current platform doesn\(aqt support
  14954. them (eg: gnome\-shell with wayland).
  14955. .sp
  14956. The set of window controls is fixed, offering \fBminimize\fP, \fBmaximize\fP,
  14957. and \fBquit\fP\&. Not all platforms implement \fBminimize\fP and \fBmaximize\fP,
  14958. but \fBquit\fP will always work.
  14959. .TP
  14960. .B \fBwindowcontrols_alignment\fP
  14961. Default: right
  14962. .sp
  14963. If window controls are shown, indicates which side should they be aligned
  14964. to.
  14965. .sp
  14966. Supports \fBleft\fP and \fBright\fP which will place the controls on those
  14967. respective sides.
  14968. .TP
  14969. .B \fBgreenandgrumpy\fP
  14970. Default: no
  14971. .sp
  14972. Set to \fByes\fP to reduce festivity (i.e. disable santa hat in December.)
  14973. .UNINDENT
  14974. .SS Script Commands
  14975. .sp
  14976. The OSC script listens to certain script commands. These commands can bound
  14977. in \fBinput.conf\fP, or sent by other scripts.
  14978. .INDENT 0.0
  14979. .TP
  14980. .B \fBosc\-message\fP
  14981. Show a message on screen using the OSC. First argument is the message,
  14982. second the duration in seconds.
  14983. .TP
  14984. .B \fBosc\-visibility\fP
  14985. Controls visibility mode \fBnever\fP / \fBauto\fP (on mouse move) / \fBalways\fP
  14986. and also \fBcycle\fP to cycle between the modes
  14987. .UNINDENT
  14988. .sp
  14989. Example
  14990. .sp
  14991. You could put this into \fBinput.conf\fP to hide the OSC with the \fBa\fP key and
  14992. to set auto mode (the default) with \fBb\fP:
  14993. .INDENT 0.0
  14994. .INDENT 3.5
  14995. .sp
  14996. .nf
  14997. .ft C
  14998. a script\-message osc\-visibility never
  14999. b script\-message osc\-visibility auto
  15000. .ft P
  15001. .fi
  15002. .UNINDENT
  15003. .UNINDENT
  15004. .INDENT 0.0
  15005. .TP
  15006. .B \fBosc\-playlist\fP, \fBosc\-chapterlist\fP, \fBosc\-tracklist\fP
  15007. Shows a limited view of the respective type of list using the OSC. First
  15008. argument is duration in seconds.
  15009. .UNINDENT
  15010. .SH STATS
  15011. .sp
  15012. This builtin script displays information and statistics for the currently
  15013. played file. It is enabled by default if mpv was compiled with Lua support.
  15014. It can be disabled entirely using the \fB\-\-load\-stats\-overlay=no\fP option.
  15015. .SS Usage
  15016. .sp
  15017. The following key bindings are active by default unless something else is
  15018. already bound to them:
  15019. .TS
  15020. center;
  15021. |l|l|.
  15022. _
  15023. T{
  15024. i
  15025. T}	T{
  15026. Show stats for a fixed duration
  15027. T}
  15028. _
  15029. T{
  15030. I
  15031. T}	T{
  15032. Toggle stats (shown until toggled again)
  15033. T}
  15034. _
  15035. .TE
  15036. .sp
  15037. While the stats are visible on screen the following key bindings are active,
  15038. regardless of existing bindings. They allow you to switch between \fIpages\fP of
  15039. stats:
  15040. .TS
  15041. center;
  15042. |l|l|.
  15043. _
  15044. T{
  15045. 1
  15046. T}	T{
  15047. Show usual stats
  15048. T}
  15049. _
  15050. T{
  15051. 2
  15052. T}	T{
  15053. Show frame timings
  15054. T}
  15055. _
  15056. T{
  15057. 3
  15058. T}	T{
  15059. Input cache stats
  15060. T}
  15061. _
  15062. .TE
  15063. .SS Font
  15064. .sp
  15065. For optimal visual experience, a font with support for many font weights and
  15066. monospaced digits is recommended. By default, the open source font
  15067. \fI\%Source Sans Pro\fP is used.
  15068. .SS Configuration
  15069. .sp
  15070. This script can be customized through a config file \fBscript\-opts/stats.conf\fP
  15071. placed in mpv\(aqs user directory and through the \fB\-\-script\-opts\fP command\-line
  15072. option. The configuration syntax is described in \fI\%ON SCREEN CONTROLLER\fP\&.
  15073. .SS Configurable Options
  15074. .INDENT 0.0
  15075. .TP
  15076. .B \fBkey_oneshot\fP
  15077. Default: i
  15078. .TP
  15079. .B \fBkey_toggle\fP
  15080. Default: I
  15081. .sp
  15082. Key bindings to display stats.
  15083. .TP
  15084. .B \fBkey_page_1\fP
  15085. Default: 1
  15086. .TP
  15087. .B \fBkey_page_2\fP
  15088. Default: 2
  15089. .TP
  15090. .B \fBkey_page_3\fP
  15091. Default: 3
  15092. .sp
  15093. Key bindings for page switching while stats are displayed.
  15094. .TP
  15095. .B \fBduration\fP
  15096. Default: 4
  15097. .sp
  15098. How long the stats are shown in seconds (oneshot).
  15099. .TP
  15100. .B \fBredraw_delay\fP
  15101. Default: 1
  15102. .sp
  15103. How long it takes to refresh the displayed stats in seconds (toggling).
  15104. .TP
  15105. .B \fBpersistent_overlay\fP
  15106. Default: no
  15107. .sp
  15108. When \fIno\fP, other scripts printing text to the screen can overwrite the
  15109. displayed stats. When \fIyes\fP, displayed stats are persistently shown for the
  15110. respective duration. This can result in overlapping text when multiple
  15111. scripts decide to print text at the same time.
  15112. .TP
  15113. .B \fBplot_perfdata\fP
  15114. Default: yes
  15115. .sp
  15116. Show graphs for performance data (page 2).
  15117. .TP
  15118. .B \fBplot_vsync_ratio\fP
  15119. Default: yes
  15120. .TP
  15121. .B \fBplot_vsync_jitter\fP
  15122. Default: yes
  15123. .sp
  15124. Show graphs for vsync and jitter values (page 1). Only when toggled.
  15125. .TP
  15126. .B \fBflush_graph_data\fP
  15127. Default: yes
  15128. .sp
  15129. Clear data buffers used for drawing graphs when toggling.
  15130. .TP
  15131. .B \fBfont\fP
  15132. Default: Source Sans Pro
  15133. .sp
  15134. Font name. Should support as many font weights as possible for optimal
  15135. visual experience.
  15136. .TP
  15137. .B \fBfont_mono\fP
  15138. Default: Source Sans Pro
  15139. .sp
  15140. Font name for parts where monospaced characters are necessary to align
  15141. text. Currently, monospaced digits are sufficient.
  15142. .TP
  15143. .B \fBfont_size\fP
  15144. Default: 8
  15145. .sp
  15146. Font size used to render text.
  15147. .TP
  15148. .B \fBfont_color\fP
  15149. Default: FFFFFF
  15150. .sp
  15151. Font color.
  15152. .TP
  15153. .B \fBborder_size\fP
  15154. Default: 0.8
  15155. .sp
  15156. Size of border drawn around the font.
  15157. .TP
  15158. .B \fBborder_color\fP
  15159. Default: 262626
  15160. .sp
  15161. Color of drawn border.
  15162. .TP
  15163. .B \fBalpha\fP
  15164. Default: 11
  15165. .sp
  15166. Transparency for drawn text.
  15167. .TP
  15168. .B \fBplot_bg_border_color\fP
  15169. Default: 0000FF
  15170. .sp
  15171. Border color used for drawing graphs.
  15172. .TP
  15173. .B \fBplot_bg_color\fP
  15174. Default: 262626
  15175. .sp
  15176. Background color used for drawing graphs.
  15177. .TP
  15178. .B \fBplot_color\fP
  15179. Default: FFFFFF
  15180. .sp
  15181. Color used for drawing graphs.
  15182. .UNINDENT
  15183. .sp
  15184. Note: colors are given as hexadecimal values and use ASS tag order: BBGGRR
  15185. (blue green red).
  15186. .SS Different key bindings
  15187. .sp
  15188. A different key binding can be defined with the aforementioned options
  15189. \fBkey_oneshot\fP and \fBkey_toggle\fP but also with commands in \fBinput.conf\fP,
  15190. for example:
  15191. .INDENT 0.0
  15192. .INDENT 3.5
  15193. .sp
  15194. .nf
  15195. .ft C
  15196. e script\-binding stats/display\-stats
  15197. E script\-binding stats/display\-stats\-toggle
  15198. .ft P
  15199. .fi
  15200. .UNINDENT
  15201. .UNINDENT
  15202. .sp
  15203. Using \fBinput.conf\fP, it is also possible to directly display a certain page:
  15204. .INDENT 0.0
  15205. .INDENT 3.5
  15206. .sp
  15207. .nf
  15208. .ft C
  15209. i script\-binding stats/display\-page\-1
  15210. e script\-binding stats/display\-page\-2
  15211. .ft P
  15212. .fi
  15213. .UNINDENT
  15214. .UNINDENT
  15215. .SH CONSOLE
  15216. .sp
  15217. The console is a REPL for mpv input commands. It is displayed on the video
  15218. window. It also shows log messages. It can be disabled entirely using the
  15219. \fB\-\-load\-osd\-console=no\fP option.
  15220. .SS Keybindings
  15221. .INDENT 0.0
  15222. .TP
  15223. .B \(ga
  15224. Show the console.
  15225. .TP
  15226. .B ESC
  15227. Hide the console.
  15228. .TP
  15229. .B ENTER
  15230. Run the typed command.
  15231. .TP
  15232. .B Shift+ENTER
  15233. Type a literal newline character.
  15234. .TP
  15235. .B Ctrl+LEFT and Ctrl+RIGHT
  15236. Move cursor to previous/next word.
  15237. .TP
  15238. .B UP and DOWN
  15239. Navigate command history.
  15240. .TP
  15241. .B PGUP
  15242. Go to the first command in the history.
  15243. .TP
  15244. .B PGDN
  15245. Stop navigating command history.
  15246. .TP
  15247. .B INSERT
  15248. Toggle insert mode.
  15249. .TP
  15250. .B Shift+INSERT
  15251. Paste text (uses the primary selection on X11.)
  15252. .TP
  15253. .B TAB
  15254. Complete the command or property name at the cursor.
  15255. .TP
  15256. .B Ctrl+C
  15257. Clear current line.
  15258. .TP
  15259. .B Ctrl+K.
  15260. Delete text from the cursor to the end of the line.
  15261. .TP
  15262. .B Ctrl+L
  15263. Clear all log messages from the console.
  15264. .TP
  15265. .B Ctrl+U
  15266. Delete text from the cursor to the beginning of the line.
  15267. .TP
  15268. .B Ctrl+V
  15269. Paste text (uses the clipboard on X11.)
  15270. .TP
  15271. .B Ctrl+W
  15272. Delete text from the cursor to the beginning of the current word.
  15273. .UNINDENT
  15274. .SS Commands
  15275. .INDENT 0.0
  15276. .TP
  15277. .B \fBscript\-message\-to console type <text>\fP
  15278. Show the console and pre\-fill it with the provided text.
  15279. .UNINDENT
  15280. .SS Known issues
  15281. .INDENT 0.0
  15282. .IP \(bu 2
  15283. Pasting text is slow on Windows
  15284. .IP \(bu 2
  15285. Non\-ASCII keyboard input has restrictions
  15286. .IP \(bu 2
  15287. The cursor keys move between Unicode code\-points, not grapheme clusters
  15288. .UNINDENT
  15289. .SS Configuration
  15290. .sp
  15291. This script can be customized through a config file \fBscript\-opts/console.conf\fP
  15292. placed in mpv\(aqs user directory and through the \fB\-\-script\-opts\fP command\-line
  15293. option. The configuration syntax is described in \fI\%ON SCREEN CONTROLLER\fP\&.
  15294. .sp
  15295. Key bindings can be changed in a standard way, see for example stats.lua
  15296. documentation.
  15297. .SS Configurable Options
  15298. .INDENT 0.0
  15299. .TP
  15300. .B \fBscale\fP
  15301. Default: 1
  15302. .sp
  15303. All drawing is scaled by this value, including the text borders and the
  15304. cursor.
  15305. .sp
  15306. If the VO backend in use has HiDPI scale reporting implemented, the option
  15307. value is scaled with the reported HiDPI scale.
  15308. .TP
  15309. .B \fBfont\fP
  15310. Default: unset (picks a hardcoded font depending on detected platform)
  15311. .sp
  15312. Set the font used for the REPL and the console. This probably doesn\(aqt
  15313. have to be a monospaced font.
  15314. .TP
  15315. .B \fBfont_size\fP
  15316. Default: 16
  15317. .sp
  15318. Set the font size used for the REPL and the console. This will be
  15319. multiplied by "scale."
  15320. .UNINDENT
  15321. .SH LUA SCRIPTING
  15322. .sp
  15323. mpv can load Lua scripts. Scripts passed to the \fB\-\-script\fP option, or found in
  15324. the \fBscripts\fP subdirectory of the mpv configuration directory (usually
  15325. \fB~/.config/mpv/scripts/\fP) will be loaded on program start. mpv also appends the
  15326. \fBscripts\fP subdirectory to the end of Lua\(aqs path so you can import scripts from
  15327. there too. Since it\(aqs added to the end, don\(aqt name scripts you want to import
  15328. the same as Lua libraries because they will be overshadowed by them.
  15329. .sp
  15330. mpv provides the built\-in module \fBmp\fP, which contains functions to send
  15331. commands to the mpv core and to retrieve information about playback state, user
  15332. settings, file information, and so on.
  15333. .sp
  15334. These scripts can be used to control mpv in a similar way to slave mode.
  15335. Technically, the Lua code uses the client API internally.
  15336. .SS Example
  15337. .sp
  15338. A script which leaves fullscreen mode when the player is paused:
  15339. .INDENT 0.0
  15340. .INDENT 3.5
  15341. .sp
  15342. .nf
  15343. .ft C
  15344. function on_pause_change(name, value)
  15345.     if value == true then
  15346.         mp.set_property("fullscreen", "no")
  15347.     end
  15348. end
  15349. mp.observe_property("pause", "bool", on_pause_change)
  15350. .ft P
  15351. .fi
  15352. .UNINDENT
  15353. .UNINDENT
  15354. .SS Details on the script initialization and lifecycle
  15355. .sp
  15356. Your script will be loaded by the player at program start from the \fBscripts\fP
  15357. configuration subdirectory, or from a path specified with the \fB\-\-script\fP
  15358. option. Some scripts are loaded internally (like \fB\-\-osc\fP). Each script runs in
  15359. its own thread. Your script is first run "as is", and once that is done, the event loop
  15360. is entered. This event loop will dispatch events received by mpv and call your
  15361. own event handlers which you have registered with \fBmp.register_event\fP, or
  15362. timers added with \fBmp.add_timeout\fP or similar. Note that since the
  15363. script starts execution concurrently with player initialization, some properties
  15364. may not be populated with meaningful values until the relevant subsystems have
  15365. initialized.
  15366. .sp
  15367. When the player quits, all scripts will be asked to terminate. This happens via
  15368. a \fBshutdown\fP event, which by default will make the event loop return. If your
  15369. script got into an endless loop, mpv will probably behave fine during playback,
  15370. but it won\(aqt terminate when quitting, because it\(aqs waiting on your script.
  15371. .sp
  15372. Internally, the C code will call the Lua function \fBmp_event_loop\fP after
  15373. loading a Lua script. This function is normally defined by the default prelude
  15374. loaded before your script (see \fBplayer/lua/defaults.lua\fP in the mpv sources).
  15375. The event loop will wait for events and dispatch events registered with
  15376. \fBmp.register_event\fP\&. It will also handle timers added with \fBmp.add_timeout\fP
  15377. and similar (by waiting with a timeout).
  15378. .sp
  15379. Since mpv 0.6.0, the player will wait until the script is fully loaded before
  15380. continuing normal operation. The player considers a script as fully loaded as
  15381. soon as it starts waiting for mpv events (or it exits). In practice this means
  15382. the player will more or less hang until the script returns from the main chunk
  15383. (and \fBmp_event_loop\fP is called), or the script calls \fBmp_event_loop\fP or
  15384. \fBmp.dispatch_events\fP directly. This is done to make it possible for a script
  15385. to fully setup event handlers etc. before playback actually starts. In older
  15386. mpv versions, this happened asynchronously. With mpv 0.29.0, this changes
  15387. slightly, and it merely waits for scripts to be loaded in this manner before
  15388. starting playback as part of the player initialization phase. Scripts run though
  15389. initialization in parallel. This might change again.
  15390. .SS mp functions
  15391. .sp
  15392. The \fBmp\fP module is preloaded, although it can be loaded manually with
  15393. \fBrequire \(aqmp\(aq\fP\&. It provides the core client API.
  15394. .INDENT 0.0
  15395. .TP
  15396. .B \fBmp.command(string)\fP
  15397. Run the given command. This is similar to the commands used in input.conf.
  15398. See \fI\%List of Input Commands\fP\&.
  15399. .sp
  15400. By default, this will show something on the OSD (depending on the command),
  15401. as if it was used in \fBinput.conf\fP\&. See \fI\%Input Command Prefixes\fP how
  15402. to influence OSD usage per command.
  15403. .sp
  15404. Returns \fBtrue\fP on success, or \fBnil, error\fP on error.
  15405. .TP
  15406. .B \fBmp.commandv(arg1, arg2, ...)\fP
  15407. Similar to \fBmp.command\fP, but pass each command argument as separate
  15408. parameter. This has the advantage that you don\(aqt have to care about
  15409. quoting and escaping in some cases.
  15410. .sp
  15411. Example:
  15412. .INDENT 7.0
  15413. .INDENT 3.5
  15414. .sp
  15415. .nf
  15416. .ft C
  15417. mp.command("loadfile " .. filename .. " append")
  15418. mp.commandv("loadfile", filename, "append")
  15419. .ft P
  15420. .fi
  15421. .UNINDENT
  15422. .UNINDENT
  15423. .sp
  15424. These two commands are equivalent, except that the first version breaks
  15425. if the filename contains spaces or certain special characters.
  15426. .sp
  15427. Note that properties are \fInot\fP expanded.  You can use either \fBmp.command\fP,
  15428. the \fBexpand\-properties\fP prefix, or the \fBmp.get_property\fP family of
  15429. functions.
  15430. .sp
  15431. Unlike \fBmp.command\fP, this will not use OSD by default either (except
  15432. for some OSD\-specific commands).
  15433. .TP
  15434. .B \fBmp.command_native(table [,def])\fP
  15435. Similar to \fBmp.commandv\fP, but pass the argument list as table. This has
  15436. the advantage that in at least some cases, arguments can be passed as
  15437. native types. It also allows you to use named argument.
  15438. .sp
  15439. If the table is an array, each array item is like an argument in
  15440. \fBmp.commandv()\fP (but can be a native type instead of a string).
  15441. .sp
  15442. If the table contains string keys, it\(aqs interpreted as command with named
  15443. arguments. This requires at least an entry with the key \fBname\fP to be
  15444. present, which must be a string, and contains the command name. The special
  15445. entry \fB_flags\fP is optional, and if present, must be an array of
  15446. \fI\%Input Command Prefixes\fP to apply. All other entries are interpreted as
  15447. arguments.
  15448. .sp
  15449. Returns a result table on success (usually empty), or \fBdef, error\fP on
  15450. error. \fBdef\fP is the second parameter provided to the function, and is
  15451. nil if it\(aqs missing.
  15452. .TP
  15453. .B \fBmp.command_native_async(table [,fn])\fP
  15454. Like \fBmp.command_native()\fP, but the command is ran asynchronously (as far
  15455. as possible), and upon completion, fn is called. fn has two arguments:
  15456. \fBfn(success, result, error)\fP\&. \fBsuccess\fP is always a Boolean and is true
  15457. if the command was successful, otherwise false. The second parameter is
  15458. the result value (can be nil) in case of success, nil otherwise (as returned
  15459. by \fBmp.command_native()\fP). The third parameter is the error string in case
  15460. of an error, nil otherwise.
  15461. .sp
  15462. Returns a table with undefined contents, which can be used as argument for
  15463. \fBmp.abort_async_command\fP\&.
  15464. .sp
  15465. If starting the command failed for some reason, \fBnil, error\fP is returned,
  15466. and \fBfn\fP is called indicating failure, using the same error value.
  15467. .TP
  15468. .B \fBmp.abort_async_command(t)\fP
  15469. Abort a \fBmp.command_native_async\fP call. The argument is the return value
  15470. of that command (which starts asynchronous execution of the command).
  15471. Whether this works and how long it takes depends on the command and the
  15472. situation. The abort call itself is asynchronous. Does not return anything.
  15473. .TP
  15474. .B \fBmp.get_property(name [,def])\fP
  15475. Return the value of the given property as string. These are the same
  15476. properties as used in input.conf. See \fI\%Properties\fP for a list of
  15477. properties. The returned string is formatted similar to \fB${=name}\fP
  15478. (see \fI\%Property Expansion\fP).
  15479. .sp
  15480. Returns the string on success, or \fBdef, error\fP on error. \fBdef\fP is the
  15481. second parameter provided to the function, and is nil if it\(aqs missing.
  15482. .TP
  15483. .B \fBmp.get_property_osd(name [,def])\fP
  15484. Similar to \fBmp.get_property\fP, but return the property value formatted for
  15485. OSD. This is the same string as printed with \fB${name}\fP when used in
  15486. input.conf.
  15487. .sp
  15488. Returns the string on success, or \fBdef, error\fP on error. \fBdef\fP is the
  15489. second parameter provided to the function, and is an empty string if it\(aqs
  15490. missing. Unlike \fBget_property()\fP, assigning the return value to a variable
  15491. will always result in a string.
  15492. .TP
  15493. .B \fBmp.get_property_bool(name [,def])\fP
  15494. Similar to \fBmp.get_property\fP, but return the property value as Boolean.
  15495. .sp
  15496. Returns a Boolean on success, or \fBdef, error\fP on error.
  15497. .TP
  15498. .B \fBmp.get_property_number(name [,def])\fP
  15499. Similar to \fBmp.get_property\fP, but return the property value as number.
  15500. .sp
  15501. Note that while Lua does not distinguish between integers and floats,
  15502. mpv internals do. This function simply request a double float from mpv,
  15503. and mpv will usually convert integer property values to float.
  15504. .sp
  15505. Returns a number on success, or \fBdef, error\fP on error.
  15506. .TP
  15507. .B \fBmp.get_property_native(name [,def])\fP
  15508. Similar to \fBmp.get_property\fP, but return the property value using the best
  15509. Lua type for the property. Most time, this will return a string, Boolean,
  15510. or number. Some properties (for example \fBchapter\-list\fP) are returned as
  15511. tables.
  15512. .sp
  15513. Returns a value on success, or \fBdef, error\fP on error. Note that \fBnil\fP
  15514. might be a possible, valid value too in some corner cases.
  15515. .TP
  15516. .B \fBmp.set_property(name, value)\fP
  15517. Set the given property to the given string value. See \fBmp.get_property\fP
  15518. and \fI\%Properties\fP for more information about properties.
  15519. .sp
  15520. Returns true on success, or \fBnil, error\fP on error.
  15521. .TP
  15522. .B \fBmp.set_property_bool(name, value)\fP
  15523. Similar to \fBmp.set_property\fP, but set the given property to the given
  15524. Boolean value.
  15525. .TP
  15526. .B \fBmp.set_property_number(name, value)\fP
  15527. Similar to \fBmp.set_property\fP, but set the given property to the given
  15528. numeric value.
  15529. .sp
  15530. Note that while Lua does not distinguish between integers and floats,
  15531. mpv internals do. This function will test whether the number can be
  15532. represented as integer, and if so, it will pass an integer value to mpv,
  15533. otherwise a double float.
  15534. .TP
  15535. .B \fBmp.set_property_native(name, value)\fP
  15536. Similar to \fBmp.set_property\fP, but set the given property using its native
  15537. type.
  15538. .sp
  15539. Since there are several data types which cannot represented natively in
  15540. Lua, this might not always work as expected. For example, while the Lua
  15541. wrapper can do some guesswork to decide whether a Lua table is an array
  15542. or a map, this would fail with empty tables. Also, there are not many
  15543. properties for which it makes sense to use this, instead of
  15544. \fBset_property\fP, \fBset_property_bool\fP, \fBset_property_number\fP\&.
  15545. For these reasons, this function should probably be avoided for now, except
  15546. for properties that use tables natively.
  15547. .TP
  15548. .B \fBmp.get_time()\fP
  15549. Return the current mpv internal time in seconds as a number. This is
  15550. basically the system time, with an arbitrary offset.
  15551. .TP
  15552. .B \fBmp.add_key_binding(key, name|fn [,fn [,flags]])\fP
  15553. Register callback to be run on a key binding. The binding will be mapped to
  15554. the given \fBkey\fP, which is a string describing the physical key. This uses
  15555. the same key names as in input.conf, and also allows combinations
  15556. (e.g. \fBctrl+a\fP). If the key is empty or \fBnil\fP, no physical key is
  15557. registered, but the user still can create own bindings (see below).
  15558. .sp
  15559. After calling this function, key presses will cause the function \fBfn\fP to
  15560. be called (unless the user remapped the key with another binding).
  15561. .sp
  15562. The \fBname\fP argument should be a short symbolic string. It allows the user
  15563. to remap the key binding via input.conf using the \fBscript\-message\fP
  15564. command, and the name of the key binding (see below for
  15565. an example). The name should be unique across other bindings in the same
  15566. script \- if not, the previous binding with the same name will be
  15567. overwritten. You can omit the name, in which case a random name is generated
  15568. internally. (Omitting works as follows: either pass \fBnil\fP for \fBname\fP,
  15569. or pass the \fBfn\fP argument in place of the name. The latter is not
  15570. recommended and is handled for compatibility only.)
  15571. .sp
  15572. The last argument is used for optional flags. This is a table, which can
  15573. have the following entries:
  15574. .INDENT 7.0
  15575. .INDENT 3.5
  15576. .INDENT 0.0
  15577. .TP
  15578. .B \fBrepeatable\fP
  15579. If set to \fBtrue\fP, enables key repeat for this specific binding.
  15580. .TP
  15581. .B \fBcomplex\fP
  15582. If set to \fBtrue\fP, then \fBfn\fP is called on both key up and down
  15583. events (as well as key repeat, if enabled), with the first
  15584. argument being a table. This table has the following entries (and
  15585. may contain undocumented ones):
  15586. .INDENT 7.0
  15587. .TP
  15588. .B \fBevent\fP
  15589. Set to one of the strings \fBdown\fP, \fBrepeat\fP, \fBup\fP or
  15590. \fBpress\fP (the latter if key up/down can\(aqt be tracked).
  15591. .TP
  15592. .B \fBis_mouse\fP
  15593. Boolean Whether the event was caused by a mouse button.
  15594. .TP
  15595. .B \fBkey_name\fP
  15596. The name of they key that triggered this, or \fBnil\fP if invoked
  15597. artificially. If the key name is unknown, it\(aqs an empty string.
  15598. .TP
  15599. .B \fBkey_text\fP
  15600. Text if triggered by a text key, otherwise \fBnil\fP\&. See
  15601. description of \fBscript\-binding\fP command for details (this
  15602. field is equivalent to the 5th argument).
  15603. .UNINDENT
  15604. .UNINDENT
  15605. .UNINDENT
  15606. .UNINDENT
  15607. .sp
  15608. Internally, key bindings are dispatched via the \fBscript\-message\-to\fP or
  15609. \fBscript\-binding\fP input commands and \fBmp.register_script_message\fP\&.
  15610. .sp
  15611. Trying to map multiple commands to a key will essentially prefer a random
  15612. binding, while the other bindings are not called. It is guaranteed that
  15613. user defined bindings in the central input.conf are preferred over bindings
  15614. added with this function (but see \fBmp.add_forced_key_binding\fP).
  15615. .sp
  15616. Example:
  15617. .INDENT 7.0
  15618. .INDENT 3.5
  15619. .sp
  15620. .nf
  15621. .ft C
  15622. function something_handler()
  15623.     print("the key was pressed")
  15624. end
  15625. mp.add_key_binding("x", "something", something_handler)
  15626. .ft P
  15627. .fi
  15628. .UNINDENT
  15629. .UNINDENT
  15630. .sp
  15631. This will print the message \fBthe key was pressed\fP when \fBx\fP was pressed.
  15632. .sp
  15633. The user can remap these key bindings. Then the user has to put the
  15634. following into their input.conf to remap the command to the \fBy\fP key:
  15635. .INDENT 7.0
  15636. .INDENT 3.5
  15637. .sp
  15638. .nf
  15639. .ft C
  15640. y script\-binding something
  15641. .ft P
  15642. .fi
  15643. .UNINDENT
  15644. .UNINDENT
  15645. .sp
  15646. This will print the message when the key \fBy\fP is pressed. (\fBx\fP will
  15647. still work, unless the user remaps it.)
  15648. .sp
  15649. You can also explicitly send a message to a named script only. Assume the
  15650. above script was using the filename \fBfooscript.lua\fP:
  15651. .INDENT 7.0
  15652. .INDENT 3.5
  15653. .sp
  15654. .nf
  15655. .ft C
  15656. y script\-binding fooscript/something
  15657. .ft P
  15658. .fi
  15659. .UNINDENT
  15660. .UNINDENT
  15661. .TP
  15662. .B \fBmp.add_forced_key_binding(...)\fP
  15663. This works almost the same as \fBmp.add_key_binding\fP, but registers the
  15664. key binding in a way that will overwrite the user\(aqs custom bindings in their
  15665. input.conf. (\fBmp.add_key_binding\fP overwrites default key bindings only,
  15666. but not those by the user\(aqs input.conf.)
  15667. .TP
  15668. .B \fBmp.remove_key_binding(name)\fP
  15669. Remove a key binding added with \fBmp.add_key_binding\fP or
  15670. \fBmp.add_forced_key_binding\fP\&. Use the same name as you used when adding
  15671. the bindings. It\(aqs not possible to remove bindings for which you omitted
  15672. the name.
  15673. .TP
  15674. .B \fBmp.register_event(name, fn)\fP
  15675. Call a specific function when an event happens. The event name is a string,
  15676. and the function fn is a Lua function value.
  15677. .sp
  15678. Some events have associated data. This is put into a Lua table and passed
  15679. as argument to fn. The Lua table by default contains a \fBname\fP field,
  15680. which is a string containing the event name. If the event has an error
  15681. associated, the \fBerror\fP field is set to a string describing the error,
  15682. on success it\(aqs not set.
  15683. .sp
  15684. If multiple functions are registered for the same event, they are run in
  15685. registration order, which the first registered function running before all
  15686. the other ones.
  15687. .sp
  15688. Returns true if such an event exists, false otherwise.
  15689. .sp
  15690. See \fI\%Events\fP and \fI\%List of events\fP for details.
  15691. .TP
  15692. .B \fBmp.unregister_event(fn)\fP
  15693. Undo \fBmp.register_event(..., fn)\fP\&. This removes all event handlers that
  15694. are equal to the \fBfn\fP parameter. This uses normal Lua \fB==\fP comparison,
  15695. so be careful when dealing with closures.
  15696. .TP
  15697. .B \fBmp.observe_property(name, type, fn)\fP
  15698. Watch a property for changes. If the property \fBname\fP is changed, then
  15699. the function \fBfn(name)\fP will be called. \fBtype\fP can be \fBnil\fP, or be
  15700. set to one of \fBnone\fP, \fBnative\fP, \fBbool\fP, \fBstring\fP, or \fBnumber\fP\&.
  15701. \fBnone\fP is the same as \fBnil\fP\&. For all other values, the new value of
  15702. the property will be passed as second argument to \fBfn\fP, using
  15703. \fBmp.get_property_<type>\fP to retrieve it. This means if \fBtype\fP is for
  15704. example \fBstring\fP, \fBfn\fP is roughly called as in
  15705. \fBfn(name, mp.get_property_string(name))\fP\&.
  15706. .sp
  15707. If possible, change events are coalesced. If a property is changed a bunch
  15708. of times in a row, only the last change triggers the change function. (The
  15709. exact behavior depends on timing and other things.)
  15710. .sp
  15711. If a property is unavailable, or on error, the value argument to \fBfn\fP is
  15712. \fBnil\fP\&. (The \fBobserve_property()\fP call always succeeds, even if a
  15713. property does not exist.)
  15714. .sp
  15715. In some cases the function is not called even if the property changes.
  15716. This depends on the property, and it\(aqs a valid feature request to ask for
  15717. better update handling of a specific property.
  15718. .sp
  15719. If the \fBtype\fP is \fBnone\fP or \fBnil\fP, sporadic property change events are
  15720. possible. This means the change function \fBfn\fP can be called even if the
  15721. property doesn\(aqt actually change.
  15722. .sp
  15723. You always get an initial change notification. This is meant to initialize
  15724. the user\(aqs state to the current value of the property.
  15725. .TP
  15726. .B \fBmp.unobserve_property(fn)\fP
  15727. Undo \fBmp.observe_property(..., fn)\fP\&. This removes all property handlers
  15728. that are equal to the \fBfn\fP parameter. This uses normal Lua \fB==\fP
  15729. comparison, so be careful when dealing with closures.
  15730. .TP
  15731. .B \fBmp.add_timeout(seconds, fn)\fP
  15732. Call the given function fn when the given number of seconds has elapsed.
  15733. Note that the number of seconds can be fractional. For now, the timer\(aqs
  15734. resolution may be as low as 50 ms, although this will be improved in the
  15735. future.
  15736. .sp
  15737. This is a one\-shot timer: it will be removed when it\(aqs fired.
  15738. .sp
  15739. Returns a timer object. See \fBmp.add_periodic_timer\fP for details.
  15740. .TP
  15741. .B \fBmp.add_periodic_timer(seconds, fn)\fP
  15742. Call the given function periodically. This is like \fBmp.add_timeout\fP, but
  15743. the timer is re\-added after the function fn is run.
  15744. .INDENT 7.0
  15745. .TP
  15746. .B Returns a timer object. The timer object provides the following methods:
  15747. .INDENT 7.0
  15748. .TP
  15749. .B \fBstop()\fP
  15750. Disable the timer. Does nothing if the timer is already disabled.
  15751. This will remember the current elapsed time when stopping, so that
  15752. \fBresume()\fP essentially unpauses the timer.
  15753. .TP
  15754. .B \fBkill()\fP
  15755. Disable the timer. Resets the elapsed time. \fBresume()\fP will
  15756. restart the timer.
  15757. .TP
  15758. .B \fBresume()\fP
  15759. Restart the timer. If the timer was disabled with \fBstop()\fP, this
  15760. will resume at the time it was stopped. If the timer was disabled
  15761. with \fBkill()\fP, or if it\(aqs a previously fired one\-shot timer (added
  15762. with \fBadd_timeout()\fP), this starts the timer from the beginning,
  15763. using the initially configured timeout.
  15764. .TP
  15765. .B \fBis_enabled()\fP
  15766. Whether the timer is currently enabled or was previously disabled
  15767. (e.g. by \fBstop()\fP or \fBkill()\fP).
  15768. .TP
  15769. .B \fBtimeout\fP (RW)
  15770. This field contains the current timeout period. This value is not
  15771. updated as time progresses. It\(aqs only used to calculate when the
  15772. timer should fire next when the timer expires.
  15773. .sp
  15774. If you write this, you can call \fBt:kill() ; t:resume()\fP to reset
  15775. the current timeout to the new one. (\fBt:stop()\fP won\(aqt use the
  15776. new timeout.)
  15777. .TP
  15778. .B \fBoneshot\fP (RW)
  15779. Whether the timer is periodic (\fBfalse\fP) or fires just once
  15780. (\fBtrue\fP). This value is used when the timer expires (but before
  15781. the timer callback function fn is run).
  15782. .UNINDENT
  15783. .UNINDENT
  15784. .sp
  15785. Note that these are methods, and you have to call them using \fB:\fP instead
  15786. of \fB\&.\fP (Refer to \fI\%http://www.lua.org/manual/5.2/manual.html#3.4.9\fP .)
  15787. .sp
  15788. Example:
  15789. .INDENT 7.0
  15790. .INDENT 3.5
  15791. .sp
  15792. .nf
  15793. .ft C
  15794. seconds = 0
  15795. timer = mp.add_periodic_timer(1, function()
  15796.     print("called every second")
  15797.     # stop it after 10 seconds
  15798.     seconds = seconds + 1
  15799.     if seconds >= 10 then
  15800.         timer:kill()
  15801.     end
  15802. end)
  15803. .ft P
  15804. .fi
  15805. .UNINDENT
  15806. .UNINDENT
  15807. .TP
  15808. .B \fBmp.get_opt(key)\fP
  15809. Return a setting from the \fB\-\-script\-opts\fP option. It\(aqs up to the user and
  15810. the script how this mechanism is used. Currently, all scripts can access
  15811. this equally, so you should be careful about collisions.
  15812. .TP
  15813. .B \fBmp.get_script_name()\fP
  15814. Return the name of the current script. The name is usually made of the
  15815. filename of the script, with directory and file extension removed. If
  15816. there are several scripts which would have the same name, it\(aqs made unique
  15817. by appending a number.
  15818. .INDENT 7.0
  15819. .INDENT 3.5
  15820. .IP "Example"
  15821. .sp
  15822. The script \fB/path/to/fooscript.lua\fP becomes \fBfooscript\fP\&.
  15823. .UNINDENT
  15824. .UNINDENT
  15825. .TP
  15826. .B \fBmp.osd_message(text [,duration])\fP
  15827. Show an OSD message on the screen. \fBduration\fP is in seconds, and is
  15828. optional (uses \fB\-\-osd\-duration\fP by default).
  15829. .UNINDENT
  15830. .SS Advanced mp functions
  15831. .sp
  15832. These also live in the \fBmp\fP module, but are documented separately as they
  15833. are useful only in special situations.
  15834. .INDENT 0.0
  15835. .TP
  15836. .B \fBmp.suspend()\fP
  15837. This function has been deprecated in mpv 0.21.0 and does nothing starting
  15838. with mpv 0.23.0 (no replacement).
  15839. .TP
  15840. .B \fBmp.resume()\fP
  15841. This function has been deprecated in mpv 0.21.0 and does nothing starting
  15842. with mpv 0.23.0 (no replacement).
  15843. .TP
  15844. .B \fBmp.resume_all()\fP
  15845. This function has been deprecated in mpv 0.21.0 and does nothing starting
  15846. with mpv 0.23.0 (no replacement).
  15847. .TP
  15848. .B \fBmp.get_wakeup_pipe()\fP
  15849. Calls \fBmpv_get_wakeup_pipe()\fP and returns the read end of the wakeup
  15850. pipe. This is deprecated, but still works. (See \fBclient.h\fP for details.)
  15851. .TP
  15852. .B \fBmp.get_next_timeout()\fP
  15853. Return the relative time in seconds when the next timer (\fBmp.add_timeout\fP
  15854. and similar) expires. If there is no timer, return \fBnil\fP\&.
  15855. .TP
  15856. .B \fBmp.dispatch_events([allow_wait])\fP
  15857. This can be used to run custom event loops. If you want to have direct
  15858. control what the Lua script does (instead of being called by the default
  15859. event loop), you can set the global variable \fBmp_event_loop\fP to your
  15860. own function running the event loop. From your event loop, you should call
  15861. \fBmp.dispatch_events()\fP to dequeue and dispatch mpv events.
  15862. .sp
  15863. If the \fBallow_wait\fP parameter is set to \fBtrue\fP, the function will block
  15864. until the next event is received or the next timer expires. Otherwise (and
  15865. this is the default behavior), it returns as soon as the event loop is
  15866. emptied. It\(aqs strongly recommended to use \fBmp.get_next_timeout()\fP and
  15867. \fBmp.get_wakeup_pipe()\fP if you\(aqre interested in properly working
  15868. notification of new events and working timers.
  15869. .TP
  15870. .B \fBmp.register_idle(fn)\fP
  15871. Register an event loop idle handler. Idle handlers are called before the
  15872. script goes to sleep after handling all new events. This can be used for
  15873. example to delay processing of property change events: if you\(aqre observing
  15874. multiple properties at once, you might not want to act on each property
  15875. change, but only when all change notifications have been received.
  15876. .TP
  15877. .B \fBmp.unregister_idle(fn)\fP
  15878. Undo \fBmp.register_idle(fn)\fP\&. This removes all idle handlers that
  15879. are equal to the \fBfn\fP parameter. This uses normal Lua \fB==\fP comparison,
  15880. so be careful when dealing with closures.
  15881. .TP
  15882. .B \fBmp.enable_messages(level)\fP
  15883. Set the minimum log level of which mpv message output to receive. These
  15884. messages are normally printed to the terminal. By calling this function,
  15885. you can set the minimum log level of messages which should be received with
  15886. the \fBlog\-message\fP event. See the description of this event for details.
  15887. The level is a string, see \fBmsg.log\fP for allowed log levels.
  15888. .TP
  15889. .B \fBmp.register_script_message(name, fn)\fP
  15890. This is a helper to dispatch \fBscript\-message\fP or \fBscript\-message\-to\fP
  15891. invocations to Lua functions. \fBfn\fP is called if \fBscript\-message\fP or
  15892. \fBscript\-message\-to\fP (with this script as destination) is run
  15893. with \fBname\fP as first parameter. The other parameters are passed to \fBfn\fP\&.
  15894. If a message with the given name is already registered, it\(aqs overwritten.
  15895. .sp
  15896. Used by \fBmp.add_key_binding\fP, so be careful about name collisions.
  15897. .TP
  15898. .B \fBmp.unregister_script_message(name)\fP
  15899. Undo a previous registration with \fBmp.register_script_message\fP\&. Does
  15900. nothing if the \fBname\fP wasn\(aqt registered.
  15901. .TP
  15902. .B \fBmp.create_osd_overlay(format)\fP
  15903. Create an OSD overlay. This is a very thin wrapper around the \fBosd\-overlay\fP
  15904. command. The function returns a table, which mostly contains fields that
  15905. will be passed to \fBosd\-overlay\fP\&. The \fBformat\fP parameter is used to
  15906. initialize the \fBformat\fP field. The \fBdata\fP field contains the text to
  15907. be used as overlay. For details, see the \fBosd\-overlay\fP command.
  15908. .sp
  15909. In addition, it provides the following methods:
  15910. .INDENT 7.0
  15911. .TP
  15912. .B \fBupdate()\fP
  15913. Commit the OSD overlay to the screen, or in other words, run the
  15914. \fBosd\-overlay\fP command with the current fields of the overlay table.
  15915. .TP
  15916. .B \fBremove()\fP
  15917. Remove the overlay from the screen. A \fBupdate()\fP call will add it
  15918. again.
  15919. .UNINDENT
  15920. .sp
  15921. Example:
  15922. .INDENT 7.0
  15923. .INDENT 3.5
  15924. .sp
  15925. .nf
  15926. .ft C
  15927. ov = mp.create_osd_overlay("ass\-events")
  15928. ov.data = "{\e\ean5}{\e\eb1}hello world!"
  15929. ov:update()
  15930. .ft P
  15931. .fi
  15932. .UNINDENT
  15933. .UNINDENT
  15934. .sp
  15935. The advantage of using this wrapper (as opposed to running \fBosd\-overlay\fP
  15936. directly) is that the \fBid\fP field is allocated automatically.
  15937. .TP
  15938. .B \fBmp.get_osd_size()\fP
  15939. Returns a tuple of \fBosd_width, osd_height, osd_par\fP\&. The first two give
  15940. the size of the OSD in pixels (for video ouputs like \fB\-\-vo=xv\fP, this may
  15941. be "scaled" pixels). The third is the display pixel aspect ratio.
  15942. .sp
  15943. May return invalid/nonsense values if OSD is not initialized yet.
  15944. .UNINDENT
  15945. .SS mp.msg functions
  15946. .sp
  15947. This module allows outputting messages to the terminal, and can be loaded
  15948. with \fBrequire \(aqmp.msg\(aq\fP\&.
  15949. .INDENT 0.0
  15950. .TP
  15951. .B \fBmsg.log(level, ...)\fP
  15952. The level parameter is the message priority. It\(aqs a string and one of
  15953. \fBfatal\fP, \fBerror\fP, \fBwarn\fP, \fBinfo\fP, \fBv\fP, \fBdebug\fP, \fBtrace\fP\&. The
  15954. user\(aqs settings will determine which of these messages will be
  15955. visible. Normally, all messages are visible, except \fBv\fP, \fBdebug\fP and
  15956. \fBtrace\fP\&.
  15957. .sp
  15958. The parameters after that are all converted to strings. Spaces are inserted
  15959. to separate multiple parameters.
  15960. .sp
  15961. You don\(aqt need to add newlines.
  15962. .TP
  15963. .B \fBmsg.fatal(...)\fP, \fBmsg.error(...)\fP, \fBmsg.warn(...)\fP, \fBmsg.info(...)\fP, \fBmsg.verbose(...)\fP, \fBmsg.debug(...)\fP, \fBmsg.trace(...)\fP
  15964. All of these are shortcuts and equivalent to the corresponding
  15965. \fBmsg.log(level, ...)\fP call.
  15966. .UNINDENT
  15967. .SS mp.options functions
  15968. .sp
  15969. mpv comes with a built\-in module to manage options from config\-files and the
  15970. command\-line. All you have to do is to supply a table with default options to
  15971. the read_options function. The function will overwrite the default values
  15972. with values found in the config\-file and the command\-line (in that order).
  15973. .INDENT 0.0
  15974. .TP
  15975. .B \fBoptions.read_options(table [, identifier [, on_update]])\fP
  15976. A \fBtable\fP with key\-value pairs. The type of the default values is
  15977. important for converting the values read from the config file or
  15978. command\-line back. Do not use \fBnil\fP as a default value!
  15979. .sp
  15980. The \fBidentifier\fP is used to identify the config\-file and the command\-line
  15981. options. These needs to unique to avoid collisions with other scripts.
  15982. Defaults to \fBmp.get_script_name()\fP if the parameter is \fBnil\fP or missing.
  15983. .sp
  15984. The \fBon_update\fP parameter enables run\-time updates of all matching option
  15985. values via the \fBscript\-opts\fP option/property. If any of the matching
  15986. options changes, the values in the \fBtable\fP (which was originally passed to
  15987. the function) are changed, and \fBon_update(list)\fP is called. \fBlist\fP is
  15988. a table where each updated option has a \fBlist[option_name] = true\fP entry.
  15989. There is no initial \fBon_update()\fP call. This never re\-reads the config file.
  15990. \fBscript\-opts\fP is always applied on the original config file, ignoring
  15991. previous \fBscript\-opts\fP values (for example, if an option is removed from
  15992. \fBscript\-opts\fP at runtime, the option will have the value in the config
  15993. file). \fBtable\fP entries are only written for option values whose values
  15994. effectively change (this is important if the script changes \fBtable\fP
  15995. entries independently).
  15996. .UNINDENT
  15997. .sp
  15998. Example implementation:
  15999. .INDENT 0.0
  16000. .INDENT 3.5
  16001. .sp
  16002. .nf
  16003. .ft C
  16004. require \(aqmp.options\(aq
  16005. local options = {
  16006.     optionA = "defaultvalueA",
  16007.     optionB = \-0.5,
  16008.     optionC = true,
  16009. }
  16010. read_options(options, "myscript")
  16011. print(options.optionA)
  16012. .ft P
  16013. .fi
  16014. .UNINDENT
  16015. .UNINDENT
  16016. .sp
  16017. The config file will be stored in \fBscript\-opts/identifier.conf\fP in mpv\(aqs user
  16018. folder. Comment lines can be started with # and stray spaces are not removed.
  16019. Boolean values will be represented with yes/no.
  16020. .sp
  16021. Example config:
  16022. .INDENT 0.0
  16023. .INDENT 3.5
  16024. .sp
  16025. .nf
  16026. .ft C
  16027. # comment
  16028. optionA=Hello World
  16029. optionB=9999
  16030. optionC=no
  16031. .ft P
  16032. .fi
  16033. .UNINDENT
  16034. .UNINDENT
  16035. .sp
  16036. Command\-line options are read from the \fB\-\-script\-opts\fP parameter. To avoid
  16037. collisions, all keys have to be prefixed with \fBidentifier\-\fP\&.
  16038. .sp
  16039. Example command\-line:
  16040. .INDENT 0.0
  16041. .INDENT 3.5
  16042. .sp
  16043. .nf
  16044. .ft C
  16045. \-\-script\-opts=myscript\-optionA=TEST,myscript\-optionB=0,myscript\-optionC=yes
  16046. .ft P
  16047. .fi
  16048. .UNINDENT
  16049. .UNINDENT
  16050. .SS mp.utils functions
  16051. .sp
  16052. This built\-in module provides generic helper functions for Lua, and have
  16053. strictly speaking nothing to do with mpv or video/audio playback. They are
  16054. provided for convenience. Most compensate for Lua\(aqs scarce standard library.
  16055. .sp
  16056. Be warned that any of these functions might disappear any time. They are not
  16057. strictly part of the guaranteed API.
  16058. .INDENT 0.0
  16059. .TP
  16060. .B \fButils.getcwd()\fP
  16061. Returns the directory that mpv was launched from. On error, \fBnil, error\fP
  16062. is returned.
  16063. .TP
  16064. .B \fButils.readdir(path [, filter])\fP
  16065. Enumerate all entries at the given path on the filesystem, and return them
  16066. as array. Each entry is a directory entry (without the path).
  16067. The list is unsorted (in whatever order the operating system returns it).
  16068. .sp
  16069. If the \fBfilter\fP argument is given, it must be one of the following
  16070. strings:
  16071. .INDENT 7.0
  16072. .INDENT 3.5
  16073. .INDENT 0.0
  16074. .TP
  16075. .B \fBfiles\fP
  16076. List regular files only. This excludes directories, special files
  16077. (like UNIX device files or FIFOs), and dead symlinks. It includes
  16078. UNIX symlinks to regular files.
  16079. .TP
  16080. .B \fBdirs\fP
  16081. List directories only, or symlinks to directories. \fB\&.\fP and \fB\&..\fP
  16082. are not included.
  16083. .TP
  16084. .B \fBnormal\fP
  16085. Include the results of both \fBfiles\fP and \fBdirs\fP\&. (This is the
  16086. default.)
  16087. .TP
  16088. .B \fBall\fP
  16089. List all entries, even device files, dead symlinks, FIFOs, and the
  16090. \fB\&.\fP and \fB\&..\fP entries.
  16091. .UNINDENT
  16092. .UNINDENT
  16093. .UNINDENT
  16094. .sp
  16095. On error, \fBnil, error\fP is returned.
  16096. .TP
  16097. .B \fButils.file_info(path)\fP
  16098. Stats the given path for information and returns a table with the
  16099. following entries:
  16100. .INDENT 7.0
  16101. .INDENT 3.5
  16102. .INDENT 0.0
  16103. .TP
  16104. .B \fBmode\fP
  16105. protection bits (on Windows, always 755 (octal) for directories
  16106. and 644 (octal) for files)
  16107. .TP
  16108. .B \fBsize\fP
  16109. size in bytes
  16110. .TP
  16111. .B \fBatime\fP
  16112. time of last access
  16113. .TP
  16114. .B \fBmtime\fP
  16115. time of last modification
  16116. .TP
  16117. .B \fBctime\fP
  16118. time of last metadata change (Linux) / time of creation (Windows)
  16119. .TP
  16120. .B \fBis_file\fP
  16121. Whether \fBpath\fP is a regular file (boolean)
  16122. .TP
  16123. .B \fBis_dir\fP
  16124. Whether \fBpath\fP is a directory (boolean)
  16125. .UNINDENT
  16126. .UNINDENT
  16127. .UNINDENT
  16128. .sp
  16129. \fBmode\fP and \fBsize\fP are integers.
  16130. Timestamps (\fBatime\fP, \fBmtime\fP and \fBctime\fP) are integer seconds since
  16131. the Unix epoch (Unix time).
  16132. The booleans \fBis_file\fP and \fBis_dir\fP are provided as a convenience;
  16133. they can be and are derived from \fBmode\fP\&.
  16134. .sp
  16135. On error (eg. path does not exist), \fBnil, error\fP is returned.
  16136. .TP
  16137. .B \fButils.split_path(path)\fP
  16138. Split a path into directory component and filename component, and return
  16139. them. The first return value is always the directory. The second return
  16140. value is the trailing part of the path, the directory entry.
  16141. .TP
  16142. .B \fButils.join_path(p1, p2)\fP
  16143. Return the concatenation of the 2 paths. Tries to be clever. For example,
  16144. if \fB\(gap2\fP is an absolute path, p2 is returned without change.
  16145. .TP
  16146. .B \fButils.subprocess(t)\fP
  16147. Runs an external process and waits until it exits. Returns process status
  16148. and the captured output. This is a legacy wrapper around calling the
  16149. \fBsubprocess\fP command with \fBmp.command_native\fP\&. It does the following
  16150. things:
  16151. .INDENT 7.0
  16152. .IP \(bu 2
  16153. copy the table \fBt\fP
  16154. .IP \(bu 2
  16155. rename \fBcancellable\fP field to \fBplayback_only\fP
  16156. .IP \(bu 2
  16157. rename \fBmax_size\fP to \fBcapture_size\fP
  16158. .IP \(bu 2
  16159. set \fBcapture_stdout\fP field to \fBtrue\fP if unset
  16160. .IP \(bu 2
  16161. set \fBname\fP field to \fBsubprocess\fP
  16162. .IP \(bu 2
  16163. call \fBmp.command_native(copied_t)\fP
  16164. .IP \(bu 2
  16165. if the command failed, create a dummy result table
  16166. .IP \(bu 2
  16167. copy \fBerror_string\fP to \fBerror\fP field if the string is non\-empty
  16168. .IP \(bu 2
  16169. return the result table
  16170. .UNINDENT
  16171. .sp
  16172. It is recommended to use \fBmp.command_native\fP or \fBmp.command_native_async\fP
  16173. directly, instead of calling this legacy wrapper. It is for compatibility
  16174. only.
  16175. .sp
  16176. See the \fBsubprocess\fP documentation for semantics and further parameters.
  16177. .TP
  16178. .B \fButils.subprocess_detached(t)\fP
  16179. Runs an external process and detaches it from mpv\(aqs control.
  16180. .sp
  16181. The parameter \fBt\fP is a table. The function reads the following entries:
  16182. .INDENT 7.0
  16183. .INDENT 3.5
  16184. .INDENT 0.0
  16185. .TP
  16186. .B \fBargs\fP
  16187. Array of strings of the same semantics as the \fBargs\fP used in the
  16188. \fBsubprocess\fP function.
  16189. .UNINDENT
  16190. .UNINDENT
  16191. .UNINDENT
  16192. .sp
  16193. The function returns \fBnil\fP\&.
  16194. .sp
  16195. This is a legacy wrapper around calling the \fBrun\fP command with
  16196. \fBmp.commandv\fP and other functions.
  16197. .TP
  16198. .B \fButils.getpid()\fP
  16199. Returns the process ID of the running mpv process. This can be used to identify
  16200. the calling mpv when launching (detached) subprocesses.
  16201. .TP
  16202. .B \fButils.parse_json(str [, trail])\fP
  16203. Parses the given string argument as JSON, and returns it as a Lua table. On
  16204. error, returns \fBnil, error\fP\&. (Currently, \fBerror\fP is just a string
  16205. reading \fBerror\fP, because there is no fine\-grained error reporting of any
  16206. kind.)
  16207. .sp
  16208. The returned value uses similar conventions as \fBmp.get_property_native()\fP
  16209. to distinguish empty objects and arrays.
  16210. .sp
  16211. If the \fBtrail\fP parameter is \fBtrue\fP (or any value equal to \fBtrue\fP),
  16212. then trailing non\-whitespace text is tolerated by the function, and the
  16213. trailing text is returned as 3rd return value. (The 3rd return value is
  16214. always there, but with \fBtrail\fP set, no error is raised.)
  16215. .TP
  16216. .B \fButils.format_json(v)\fP
  16217. Format the given Lua table (or value) as a JSON string and return it. On
  16218. error, returns \fBnil, error\fP\&. (Errors usually only happen on value types
  16219. incompatible with JSON.)
  16220. .sp
  16221. The argument value uses similar conventions as \fBmp.set_property_native()\fP
  16222. to distinguish empty objects and arrays.
  16223. .TP
  16224. .B \fButils.to_string(v)\fP
  16225. Turn the given value into a string. Formats tables and their contents. This
  16226. doesn\(aqt do anything special; it is only needed because Lua is terrible.
  16227. .UNINDENT
  16228. .SS Events
  16229. .sp
  16230. Events are notifications from player core to scripts. You can register an
  16231. event handler with \fBmp.register_event\fP\&.
  16232. .sp
  16233. Note that all scripts (and other parts of the player) receive events equally,
  16234. and there\(aqs no such thing as blocking other scripts from receiving events.
  16235. .sp
  16236. Example:
  16237. .INDENT 0.0
  16238. .INDENT 3.5
  16239. .sp
  16240. .nf
  16241. .ft C
  16242. function my_fn(event)
  16243.     print("start of playback!")
  16244. end
  16246. mp.register_event("file\-loaded", my_fn)
  16247. .ft P
  16248. .fi
  16249. .UNINDENT
  16250. .UNINDENT
  16251. .SS List of events
  16252. .INDENT 0.0
  16253. .TP
  16254. .B \fBstart\-file\fP
  16255. Happens right before a new file is loaded. When you receive this, the
  16256. player is loading the file (or possibly already done with it).
  16257. .TP
  16258. .B \fBend\-file\fP
  16259. Happens after a file was unloaded. Typically, the player will load the
  16260. next file right away, or quit if this was the last file.
  16261. .sp
  16262. The event has the \fBreason\fP field, which takes one of these values:
  16263. .INDENT 7.0
  16264. .TP
  16265. .B \fBeof\fP
  16266. The file has ended. This can (but doesn\(aqt have to) include
  16267. incomplete files or broken network connections under
  16268. circumstances.
  16269. .TP
  16270. .B \fBstop\fP
  16271. Playback was ended by a command.
  16272. .TP
  16273. .B \fBquit\fP
  16274. Playback was ended by sending the quit command.
  16275. .TP
  16276. .B \fBerror\fP
  16277. An error happened. In this case, an \fBerror\fP field is present with
  16278. the error string.
  16279. .TP
  16280. .B \fBredirect\fP
  16281. Happens with playlists and similar. Details see
  16282. \fBMPV_END_FILE_REASON_REDIRECT\fP in the C API.
  16283. .TP
  16284. .B \fBunknown\fP
  16285. Unknown. Normally doesn\(aqt happen, unless the Lua API is out of sync
  16286. with the C API. (Likewise, it could happen that your script gets
  16287. reason strings that did not exist yet at the time your script was
  16288. written.)
  16289. .UNINDENT
  16290. .TP
  16291. .B \fBfile\-loaded\fP
  16292. Happens after a file was loaded and begins playback.
  16293. .TP
  16294. .B \fBseek\fP
  16295. Happens on seeking. (This might include cases when the player seeks
  16296. internally, even without user interaction. This includes e.g. segment
  16297. changes when playing ordered chapters Matroska files.)
  16298. .TP
  16299. .B \fBplayback\-restart\fP
  16300. Start of playback after seek or after file was loaded.
  16301. .TP
  16302. .B \fBidle\fP
  16303. Idle mode is entered. This happens when playback ended, and the player was
  16304. started with \fB\-\-idle\fP or \fB\-\-force\-window\fP\&. This mode is implicitly ended
  16305. when the \fBstart\-file\fP or \fBshutdown\fP events happen.
  16306. .TP
  16307. .B \fBtick\fP
  16308. Called after a video frame was displayed. This is a hack, and you should
  16309. avoid using it. Use timers instead and maybe watch pausing/unpausing events
  16310. to avoid wasting CPU when the player is paused.
  16311. .TP
  16312. .B \fBshutdown\fP
  16313. Sent when the player quits, and the script should terminate. Normally
  16314. handled automatically. See \fI\%Details on the script initialization and lifecycle\fP\&.
  16315. .TP
  16316. .B \fBlog\-message\fP
  16317. Receives messages enabled with \fBmp.enable_messages\fP\&. The message data
  16318. is contained in the table passed as first parameter to the event handler.
  16319. The table contains, in addition to the default event fields, the following
  16320. fields:
  16321. .INDENT 7.0
  16322. .TP
  16323. .B \fBprefix\fP
  16324. The module prefix, identifies the sender of the message. This is what
  16325. the terminal player puts in front of the message text when using the
  16326. \fB\-\-v\fP option, and is also what is used for \fB\-\-msg\-level\fP\&.
  16327. .TP
  16328. .B \fBlevel\fP
  16329. The log level as string. See \fBmsg.log\fP for possible log level names.
  16330. Note that later versions of mpv might add new levels or remove
  16331. (undocumented) existing ones.
  16332. .TP
  16333. .B \fBtext\fP
  16334. The log message. The text will end with a newline character. Sometimes
  16335. it can contain multiple lines.
  16336. .UNINDENT
  16337. .sp
  16338. Keep in mind that these messages are meant to be hints for humans. You
  16339. should not parse them, and prefix/level/text of messages might change
  16340. any time.
  16341. .TP
  16342. .B \fBget\-property\-reply\fP
  16343. Undocumented (not useful for Lua scripts).
  16344. .TP
  16345. .B \fBset\-property\-reply\fP
  16346. Undocumented (not useful for Lua scripts).
  16347. .TP
  16348. .B \fBcommand\-reply\fP
  16349. Undocumented (not useful for Lua scripts).
  16350. .TP
  16351. .B \fBclient\-message\fP
  16352. Undocumented (used internally).
  16353. .TP
  16354. .B \fBvideo\-reconfig\fP
  16355. Happens on video output or filter reconfig.
  16356. .TP
  16357. .B \fBaudio\-reconfig\fP
  16358. Happens on audio output or filter reconfig.
  16359. .UNINDENT
  16360. .sp
  16361. The following events also happen, but are deprecated: \fBtracks\-changed\fP,
  16362. \fBtrack\-switched\fP, \fBpause\fP, \fBunpause\fP, \fBmetadata\-update\fP,
  16363. \fBchapter\-change\fP\&. Use \fBmp.observe_property()\fP instead.
  16364. .SS Extras
  16365. .sp
  16366. This documents experimental features, or features that are "too special" to
  16367. guarantee a stable interface.
  16368. .INDENT 0.0
  16369. .TP
  16370. .B \fBmp.add_hook(type, priority, fn)\fP
  16371. Add a hook callback for \fBtype\fP (a string identifying a certain kind of
  16372. hook). These hooks allow the player to call script functions and wait for
  16373. their result (normally, the Lua scripting interface is asynchronous from
  16374. the point of view of the player core). \fBpriority\fP is an arbitrary integer
  16375. that allows ordering among hooks of the same kind. Using the value 50 is
  16376. recommended as neutral default value. \fBfn\fP is the function that will be
  16377. called during execution of the hook.
  16378. .sp
  16379. See \fI\%Hooks\fP for currently existing hooks and what they do \- only the hook
  16380. list is interesting; handling hook execution is done by the Lua script
  16381. function automatically.
  16382. .UNINDENT
  16383. .SH JAVASCRIPT
  16384. .sp
  16385. JavaScript support in mpv is near identical to its Lua support. Use this section
  16386. as reference on differences and availability of APIs, but otherwise you should
  16387. refer to the Lua documentation for API details and general scripting in mpv.
  16388. .SS Example
  16389. .sp
  16390. JavaScript code which leaves fullscreen mode when the player is paused:
  16391. .INDENT 0.0
  16392. .INDENT 3.5
  16393. .sp
  16394. .nf
  16395. .ft C
  16396. function on_pause_change(name, value) {
  16397.     if (value == true)
  16398.         mp.set_property("fullscreen", "no");
  16399. }
  16400. mp.observe_property("pause", "bool", on_pause_change);
  16401. .ft P
  16402. .fi
  16403. .UNINDENT
  16404. .UNINDENT
  16405. .SS Similarities with Lua
  16406. .sp
  16407. mpv tries to load a script file as JavaScript if it has a \fB\&.js\fP extension, but
  16408. otherwise, the documented Lua options, script directories, loading, etc apply to
  16409. JavaScript files too.
  16410. .sp
  16411. Script initialization and lifecycle is the same as with Lua, and most of the Lua
  16412. functions at the modules \fBmp\fP, \fBmp.utils\fP, \fBmp.msg\fP and \fBmp.options\fP are
  16413. available to JavaScript with identical APIs \- including running commands,
  16414. getting/setting properties, registering events/key\-bindings/hooks, etc.
  16415. .SS Differences from Lua
  16416. .sp
  16417. No need to load modules. \fBmp\fP, \fBmp.utils\fP,  \fBmp.msg\fP and \fBmp.options\fP
  16418. are preloaded, and you can use e.g. \fBvar cwd = mp.utils.getcwd();\fP without
  16419. prior setup.
  16420. .sp
  16421. Errors are slightly different. Where the Lua APIs return \fBnil\fP for error,
  16422. the JavaScript ones return \fBundefined\fP\&. Where Lua returns \fBsomething, error\fP
  16423. JavaScript returns only \fBsomething\fP \- and makes \fBerror\fP available via
  16424. \fBmp.last_error()\fP\&. Note that only some of the functions have this additional
  16425. \fBerror\fP value \- typically the same ones which have it in Lua.
  16426. .sp
  16427. Standard APIs are preferred. For instance \fBsetTimeout\fP and \fBJSON.stringify\fP
  16428. are available, but \fBmp.add_timeout\fP and \fBmp.utils.format_json\fP are not.
  16429. .sp
  16430. No standard library. This means that interaction with anything outside of mpv is
  16431. limited to the available APIs, typically via \fBmp.utils\fP\&. However, some file
  16432. functions were added, and CommonJS \fBrequire\fP is available too \- where the
  16433. loaded modules have the same privileges as normal scripts.
  16434. .SS Language features \- ECMAScript 5
  16435. .sp
  16436. The scripting backend which mpv currently uses is MuJS \- a compatible minimal
  16437. ES5 interpreter. As such, \fBString.substring\fP is implemented for instance,
  16438. while the common but non\-standard \fBString.substr\fP is not. Please consult the
  16439. MuJS pages on language features and platform support \- \fI\%http://mujs.com\fP .
  16440. .SS Unsupported Lua APIs and their JS alternatives
  16441. .sp
  16442. \fBmp.add_timeout(seconds, fn)\fP  JS: \fBid = setTimeout(fn, ms)\fP
  16443. .sp
  16444. \fBmp.add_periodic_timer(seconds, fn)\fP  JS: \fBid = setInterval(fn, ms)\fP
  16445. .sp
  16446. \fButils.parse_json(str [, trail])\fP  JS: \fBJSON.parse(str)\fP
  16447. .sp
  16448. \fButils.format_json(v)\fP  JS: \fBJSON.stringify(v)\fP
  16449. .sp
  16450. \fButils.to_string(v)\fP  see \fBdump\fP below.
  16451. .sp
  16452. \fBmp.suspend()\fP JS: none (deprecated).
  16453. .sp
  16454. \fBmp.resume()\fP JS: none (deprecated).
  16455. .sp
  16456. \fBmp.resume_all()\fP JS: none (deprecated).
  16457. .sp
  16458. \fBmp.get_next_timeout()\fP see event loop below.
  16459. .sp
  16460. \fBmp.dispatch_events([allow_wait])\fP see event loop below.
  16461. .SS Scripting APIs \- identical to Lua
  16462. .sp
  16463. (LE) \- Last\-Error, indicates that \fBmp.last_error()\fP can be used after the
  16464. call to test for success (empty string) or failure (non empty reason string).
  16465. Where the Lua APIs use \fBnil\fP to indicate error, JS APIs use \fBundefined\fP\&.
  16466. .sp
  16467. \fBmp.command(string)\fP (LE)
  16468. .sp
  16469. \fBmp.commandv(arg1, arg2, ...)\fP (LE)
  16470. .sp
  16471. \fBmp.command_native(table [,def])\fP (LE)
  16472. .sp
  16473. \fBid = mp.command_native_async(table [,fn])\fP (LE) Notes: \fBid\fP is true\-thy on
  16474. success, \fBfn\fP is called always a\-sync, \fBerror\fP is empty string on success.
  16475. .sp
  16476. \fBmp.abort_async_command(id)\fP
  16477. .sp
  16478. \fBmp.get_property(name [,def])\fP (LE)
  16479. .sp
  16480. \fBmp.get_property_osd(name [,def])\fP (LE)
  16481. .sp
  16482. \fBmp.get_property_bool(name [,def])\fP (LE)
  16483. .sp
  16484. \fBmp.get_property_number(name [,def])\fP (LE)
  16485. .sp
  16486. \fBmp.get_property_native(name [,def])\fP (LE)
  16487. .sp
  16488. \fBmp.set_property(name, value)\fP (LE)
  16489. .sp
  16490. \fBmp.set_property_bool(name, value)\fP (LE)
  16491. .sp
  16492. \fBmp.set_property_number(name, value)\fP (LE)
  16493. .sp
  16494. \fBmp.set_property_native(name, value)\fP (LE)
  16495. .sp
  16496. \fBmp.get_time()\fP
  16497. .sp
  16498. \fBmp.add_key_binding(key, name|fn [,fn [,flags]])\fP
  16499. .sp
  16500. \fBmp.add_forced_key_binding(...)\fP
  16501. .sp
  16502. \fBmp.remove_key_binding(name)\fP
  16503. .sp
  16504. \fBmp.register_event(name, fn)\fP
  16505. .sp
  16506. \fBmp.unregister_event(fn)\fP
  16507. .sp
  16508. \fBmp.observe_property(name, type, fn)\fP
  16509. .sp
  16510. \fBmp.unobserve_property(fn)\fP
  16511. .sp
  16512. \fBmp.get_opt(key)\fP
  16513. .sp
  16514. \fBmp.get_script_name()\fP
  16515. .sp
  16516. \fBmp.osd_message(text [,duration])\fP
  16517. .sp
  16518. \fBmp.get_wakeup_pipe()\fP
  16519. .sp
  16520. \fBmp.register_idle(fn)\fP
  16521. .sp
  16522. \fBmp.unregister_idle(fn)\fP
  16523. .sp
  16524. \fBmp.enable_messages(level)\fP
  16525. .sp
  16526. \fBmp.register_script_message(name, fn)\fP
  16527. .sp
  16528. \fBmp.unregister_script_message(name)\fP
  16529. .sp
  16530. \fBmp.create_osd_overlay(format)\fP
  16531. .sp
  16532. \fBmp.get_osd_size()\fP  (returned object has properties: width, height, aspect)
  16533. .sp
  16534. \fBmp.msg.log(level, ...)\fP
  16535. .sp
  16536. \fBmp.msg.fatal(...)\fP
  16537. .sp
  16538. \fBmp.msg.error(...)\fP
  16539. .sp
  16540. \fBmp.msg.warn(...)\fP
  16541. .sp
  16542. \fBmp.msg.info(...)\fP
  16543. .sp
  16544. \fBmp.msg.verbose(...)\fP
  16545. .sp
  16546. \fBmp.msg.debug(...)\fP
  16547. .sp
  16548. \fBmp.msg.trace(...)\fP
  16549. .sp
  16550. \fBmp.utils.getcwd()\fP (LE)
  16551. .sp
  16552. \fBmp.utils.readdir(path [, filter])\fP (LE)
  16553. .sp
  16554. \fBmp.utils.file_info(path)\fP (LE)
  16555. .sp
  16556. \fBmp.utils.split_path(path)\fP
  16557. .sp
  16558. \fBmp.utils.join_path(p1, p2)\fP
  16559. .sp
  16560. \fBmp.utils.subprocess(t)\fP
  16561. .sp
  16562. \fBmp.utils.subprocess_detached(t)\fP
  16563. .sp
  16564. \fBmp.utils.getpid()\fP (LE)
  16565. .sp
  16566. \fBmp.add_hook(type, priority, fn)\fP
  16567. .sp
  16568. \fBmp.options.read_options(obj [, identifier [, on_update]])\fP (types:
  16569. string/boolean/number)
  16570. .SS Additional utilities
  16571. .INDENT 0.0
  16572. .TP
  16573. .B \fBmp.last_error()\fP
  16574. If used after an API call which updates last error, returns an empty string
  16575. if the API call succeeded, or a non\-empty error reason string otherwise.
  16576. .TP
  16577. .B \fBError.stack\fP (string)
  16578. When using \fBtry { ... } catch(e) { ... }\fP, then \fBe.stack\fP is the stack
  16579. trace of the error \- if it was created using the \fBError(...)\fP constructor.
  16580. .TP
  16581. .B \fBprint\fP (global)
  16582. A convenient alias to \fBmp.msg.info\fP\&.
  16583. .TP
  16584. .B \fBdump\fP (global)
  16585. Like \fBprint\fP but also expands objects and arrays recursively.
  16586. .TP
  16587. .B \fBmp.utils.getenv(name)\fP
  16588. Returns the value of the host environment variable \fBname\fP, or
  16589. \fBundefined\fP if the variable is not defined.
  16590. .TP
  16591. .B \fBmp.utils.get_user_path(path)\fP
  16592. Expands (mpv) meta paths like \fB~/x\fP, \fB~~/y\fP, \fB~~desktop/z\fP etc.
  16593. \fBread_file\fP, \fBwrite_file\fP and \fBrequire\fP already use this internaly.
  16594. .TP
  16595. .B \fBmp.utils.read_file(fname [,max])\fP
  16596. Returns the content of file \fBfname\fP as string. If \fBmax\fP is provided and
  16597. not negative, limit the read to \fBmax\fP bytes.
  16598. .TP
  16599. .B \fBmp.utils.write_file(fname, str)\fP
  16600. (Over)write file \fBfname\fP with text content \fBstr\fP\&. \fBfname\fP must be
  16601. prefixed with \fBfile://\fP as simple protection against accidental arguments
  16602. switch, e.g. \fBmp.utils.write_file("file://~/abc.txt", "hello world")\fP\&.
  16603. .UNINDENT
  16604. .sp
  16605. Note: \fBread_file\fP and \fBwrite_file\fP throw on errors, allow text content only.
  16606. .INDENT 0.0
  16607. .TP
  16608. .B \fBmp.get_time_ms()\fP
  16609. Same as \fBmp.get_time()\fP but in ms instead of seconds.
  16610. .TP
  16611. .B \fBmp.get_script_file()\fP
  16612. Returns the file name of the current script.
  16613. .TP
  16614. .B \fBexit()\fP (global)
  16615. Make the script exit at the end of the current event loop iteration.
  16616. Note: please remove added key bindings before calling \fBexit()\fP\&.
  16617. .TP
  16618. .B \fBmp.utils.compile_js(fname, content_str)\fP
  16619. Compiles the JS code \fBcontent_str\fP as file name \fBfname\fP (without loading
  16620. anything from the filesystem), and returns it as a function. Very similar
  16621. to a \fBFunction\fP constructor, but shows at stack traces as \fBfname\fP\&.
  16622. .TP
  16623. .B \fBmp.module_paths\fP
  16624. Global modules search paths array for the \fBrequire\fP function (see below).
  16625. .UNINDENT
  16626. .SS Timers (global)
  16627. .sp
  16628. The standard HTML/node.js timers are available:
  16629. .sp
  16630. \fBid = setTimeout(fn [,duration [,arg1 [,arg2...]]])\fP
  16631. .sp
  16632. \fBid = setTimeout(code_string [,duration])\fP
  16633. .sp
  16634. \fBclearTimeout(id)\fP
  16635. .sp
  16636. \fBid = setInterval(fn [,duration [,arg1 [,arg2...]]])\fP
  16637. .sp
  16638. \fBid = setInterval(code_string [,duration])\fP
  16639. .sp
  16640. \fBclearInterval(id)\fP
  16641. .sp
  16642. \fBsetTimeout\fP and \fBsetInterval\fP return id, and later call \fBfn\fP (or execute
  16643. \fBcode_string\fP) after \fBduration\fP ms. Interval also repeat every \fBduration\fP\&.
  16644. .sp
  16645. \fBduration\fP has a minimum and default value of 0, \fBcode_string\fP is
  16646. a plain string which is evaluated as JS code, and \fB[,arg1 [,arg2..]]\fP are used
  16647. as arguments (if provided) when calling back \fBfn\fP\&.
  16648. .sp
  16649. The \fBclear...(id)\fP functions cancel timer \fBid\fP, and are irreversible.
  16650. .sp
  16651. Note: timers always call back asynchronously, e.g. \fBsetTimeout(fn)\fP will never
  16652. call \fBfn\fP before returning. \fBfn\fP will be called either at the end of this
  16653. event loop iteration or at a later event loop iteration. This is true also for
  16654. intervals \- which also never call back twice at the same event loop iteration.
  16655. .sp
  16656. Additionally, timers are processed after the event queue is empty, so it\(aqs valid
  16657. to use \fBsetTimeout(fn)\fP as a one\-time idle observer.
  16658. .SS CommonJS modules and \fBrequire(id)\fP
  16659. .sp
  16660. CommonJS Modules are a standard system where scripts can export common functions
  16661. for use by other scripts. Specifically, a module is a script which adds
  16662. properties (functions, etc) to its pre\-existing \fBexports\fP object, which
  16663. another script can access with \fBrequire(module\-id)\fP\&. This runs the module and
  16664. returns its \fBexports\fP object. Further calls to \fBrequire\fP for the same module
  16665. will return its cached \fBexports\fP object without running the module again.
  16666. .sp
  16667. Modules and \fBrequire\fP are supported, standard compliant, and generally similar
  16668. to node.js. However, most node.js modules won\(aqt run due to missing modules such
  16669. as \fBfs\fP, \fBprocess\fP, etc, but some node.js modules with minimal dependencies
  16670. do work. In general, this is for mpv modules and not a node.js replacement.
  16671. .sp
  16672. A \fB\&.js\fP file extension is always added to \fBid\fP, e.g. \fBrequire("./foo")\fP
  16673. will load the file \fB\&./foo.js\fP and return its \fBexports\fP object.
  16674. .sp
  16675. An id is relative (to the script which \fBrequire\fP\(aqd it) if it starts with
  16676. \fB\&./\fP or \fB\&../\fP\&. Otherwise, it\(aqs considered a "top\-level id" (CommonJS term).
  16677. .sp
  16678. Top level id is evaluated as absolute filesystem path if possible, e.g. \fB/x/y\fP
  16679. or \fB~/x\fP\&. Otherwise, it\(aqs considered a global module id and searched at
  16680. \fBscripts/modules.js/\fP in mpv config dirs \- in normal config search order. E.g.
  16681. \fBrequire("x")\fP is searched as file \fBx.js\fP at those dirs, and id \fBfoo/x\fP is
  16682. searched as file \fBx.js\fP inside dir \fBfoo\fP at those dirs.
  16683. .sp
  16684. Search paths for global module id\(aqs are at the array \fBmp.module_paths\fP, which
  16685. is searched in order. Initially it contains one item: \fB~~/scripts/modules.js\fP
  16686. such that it behaves as described above. Modifying it will affect future
  16687. \fBrequire\fP calls with global module id\(aqs which are not already loaded/cached.
  16688. .sp
  16689. No \fBglobal\fP variable, but a module\(aqs \fBthis\fP at its top lexical scope is the
  16690. global object \- also in strict mode. If you have a module which needs \fBglobal\fP
  16691. as the global object, you could do \fBthis.global = this;\fP before \fBrequire\fP\&.
  16692. .sp
  16693. Functions and variables declared at a module don\(aqt pollute the global object.
  16694. .SS The event loop
  16695. .sp
  16696. The event loop poll/dispatch mpv events as long as the queue is not empty, then
  16697. processes the timers, then waits for the next event, and repeats this forever.
  16698. .sp
  16699. You could put this code at your script to replace the built\-in event loop, and
  16700. also print every event which mpv sends to your script:
  16701. .INDENT 0.0
  16702. .INDENT 3.5
  16703. .sp
  16704. .nf
  16705. .ft C
  16706. function mp_event_loop() {
  16707.     var wait = 0;
  16708.     do {
  16709.         var e = mp.wait_event(wait);
  16710.         dump(e);  // there could be a lot of prints...
  16711.         if (e.event != "none") {
  16712.             mp.dispatch_event(e);
  16713.             wait = 0;
  16714.         } else {
  16715.             wait = mp.process_timers() / 1000;
  16716.             if (wait != 0) {
  16717.                 mp.notify_idle_observers();
  16718.                 wait = mp.peek_timers_wait() / 1000;
  16719.             }
  16720.         }
  16721.     } while (mp.keep_running);
  16722. }
  16723. .ft P
  16724. .fi
  16725. .UNINDENT
  16726. .UNINDENT
  16727. .sp
  16728. \fBmp_event_loop\fP is a name which mpv tries to call after the script loads.
  16729. The internal implementation is similar to this (without \fBdump\fP though..).
  16730. .sp
  16731. \fBe = mp.wait_event(wait)\fP returns when the next mpv event arrives, or after
  16732. \fBwait\fP seconds if positive and no mpv events arrived. \fBwait\fP value of 0
  16733. returns immediately (with \fBe.event == "none"\fP if the queue is empty).
  16734. .sp
  16735. \fBmp.dispatch_event(e)\fP calls back the handlers registered for \fBe.event\fP,
  16736. if there are such (event handlers, property observers, script messages, etc).
  16737. .sp
  16738. \fBmp.process_timers()\fP calls back the already\-added, non\-canceled due timers,
  16739. and returns the duration in ms till the next due timer (possibly 0), or \-1 if
  16740. there are no pending timers. Must not be called recursively.
  16741. .sp
  16742. \fBmp.notify_idle_observers()\fP calls back the idle observers, which we do when
  16743. we\(aqre about to sleep (wait != 0), but the observers may add timers or take
  16744. non\-negligible duration to complete, so we re\-calculate \fBwait\fP afterwards.
  16745. .sp
  16746. \fBmp.peek_timers_wait()\fP returns the same values as \fBmp.process_timers()\fP
  16747. but without doing anything. Invalid result if called from a timer callback.
  16748. .sp
  16749. Note: \fBexit()\fP is also registered for the \fBshutdown\fP event, and its
  16750. implementation is a simple \fBmp.keep_running = false\fP\&.
  16751. .SH JSON IPC
  16752. .sp
  16753. mpv can be controlled by external programs using the JSON\-based IPC protocol.
  16754. It can be enabled by specifying the path to a unix socket or a named pipe using
  16755. the option \fB\-\-input\-ipc\-server\fP\&. Clients can connect to this socket and send
  16756. commands to the player or receive events from it.
  16757. .sp
  16758. \fBWARNING:\fP
  16759. .INDENT 0.0
  16760. .INDENT 3.5
  16761. This is not intended to be a secure network protocol. It is explicitly
  16762. insecure: there is no authentication, no encryption, and the commands
  16763. themselves are insecure too. For example, the \fBrun\fP command is exposed,
  16764. which can run arbitrary system commands. The use\-case is controlling the
  16765. player locally. This is not different from the MPlayer slave protocol.
  16766. .UNINDENT
  16767. .UNINDENT
  16768. .SS Socat example
  16769. .sp
  16770. You can use the \fBsocat\fP tool to send commands (and receive replies) from the
  16771. shell. Assuming mpv was started with:
  16772. .INDENT 0.0
  16773. .INDENT 3.5
  16774. .sp
  16775. .nf
  16776. .ft C
  16777. mpv file.mkv \-\-input\-ipc\-server=/tmp/mpvsocket
  16778. .ft P
  16779. .fi
  16780. .UNINDENT
  16781. .UNINDENT
  16782. .sp
  16783. Then you can control it using socat:
  16784. .INDENT 0.0
  16785. .INDENT 3.5
  16786. .sp
  16787. .nf
  16788. .ft C
  16789. > echo \(aq{ "command": ["get_property", "playback\-time"] }\(aq | socat \- /tmp/mpvsocket
  16790. {"data":190.482000,"error":"success"}
  16791. .ft P
  16792. .fi
  16793. .UNINDENT
  16794. .UNINDENT
  16795. .sp
  16796. In this case, socat copies data between stdin/stdout and the mpv socket
  16797. connection.
  16798. .sp
  16799. See the \fB\-\-idle\fP option how to make mpv start without exiting immediately or
  16800. playing a file.
  16801. .sp
  16802. It\(aqs also possible to send input.conf style text\-only commands:
  16803. .INDENT 0.0
  16804. .INDENT 3.5
  16805. .sp
  16806. .nf
  16807. .ft C
  16808. > echo \(aqshow\-text ${playback\-time}\(aq | socat \- /tmp/mpvsocket
  16809. .ft P
  16810. .fi
  16811. .UNINDENT
  16812. .UNINDENT
  16813. .sp
  16814. But you won\(aqt get a reply over the socket. (This particular command shows the
  16815. playback time on the player\(aqs OSD.)
  16816. .SS Command Prompt example
  16817. .sp
  16818. Unfortunately, it\(aqs not as easy to test the IPC protocol on Windows, since
  16819. Windows ports of socat (in Cygwin and MSYS2) don\(aqt understand named pipes. In
  16820. the absence of a simple tool to send and receive from bidirectional pipes, the
  16821. \fBecho\fP command can be used to send commands, but not receive replies from the
  16822. command prompt.
  16823. .sp
  16824. Assuming mpv was started with:
  16825. .INDENT 0.0
  16826. .INDENT 3.5
  16827. .sp
  16828. .nf
  16829. .ft C
  16830. mpv file.mkv \-\-input\-ipc\-server=\e\e.\epipe\empvsocket
  16831. .ft P
  16832. .fi
  16833. .UNINDENT
  16834. .UNINDENT
  16835. .sp
  16836. You can send commands from a command prompt:
  16837. .INDENT 0.0
  16838. .INDENT 3.5
  16839. .sp
  16840. .nf
  16841. .ft C
  16842. echo show\-text ${playback\-time} >\e\e.\epipe\empvsocket
  16843. .ft P
  16844. .fi
  16845. .UNINDENT
  16846. .UNINDENT
  16847. .sp
  16848. To be able to simultaneously read and write from the IPC pipe, like on Linux,
  16849. it\(aqs necessary to write an external program that uses overlapped file I/O (or
  16850. some wrapper like .NET\(aqs NamedPipeClientStream.)
  16851. .SS Protocol
  16852. .sp
  16853. The protocol uses UTF\-8\-only JSON as defined by RFC\-8259. Unlike standard JSON,
  16854. "u" escape sequences are not allowed to construct surrogate pairs. To avoid
  16855. getting conflicts, encode all text characters including and above codepoint
  16856. U+0020 as UTF\-8. mpv might output broken UTF\-8 in corner cases (see "UTF\-8"
  16857. section below).
  16858. .sp
  16859. Clients can execute commands on the player by sending JSON messages of the
  16860. following form:
  16861. .INDENT 0.0
  16862. .INDENT 3.5
  16863. .sp
  16864. .nf
  16865. .ft C
  16866. { "command": ["command_name", "param1", "param2", ...] }
  16867. .ft P
  16868. .fi
  16869. .UNINDENT
  16870. .UNINDENT
  16871. .sp
  16872. where \fBcommand_name\fP is the name of the command to be executed, followed by a
  16873. list of parameters. Parameters must be formatted as native JSON values
  16874. (integers, strings, booleans, ...). Every message \fBmust\fP be terminated with
  16875. \fB\en\fP\&. Additionally, \fB\en\fP must not appear anywhere inside the message. In
  16876. practice this means that messages should be minified before being sent to mpv.
  16877. .sp
  16878. mpv will then send back a reply indicating whether the command was run
  16879. correctly, and an additional field holding the command\-specific return data (it
  16880. can also be null).
  16881. .INDENT 0.0
  16882. .INDENT 3.5
  16883. .sp
  16884. .nf
  16885. .ft C
  16886. { "error": "success", "data": null }
  16887. .ft P
  16888. .fi
  16889. .UNINDENT
  16890. .UNINDENT
  16891. .sp
  16892. mpv will also send events to clients with JSON messages of the following form:
  16893. .INDENT 0.0
  16894. .INDENT 3.5
  16895. .sp
  16896. .nf
  16897. .ft C
  16898. { "event": "event_name" }
  16899. .ft P
  16900. .fi
  16901. .UNINDENT
  16902. .UNINDENT
  16903. .sp
  16904. where \fBevent_name\fP is the name of the event. Additional event\-specific fields
  16905. can also be present. See \fI\%List of events\fP for a list of all supported events.
  16906. .sp
  16907. Because events can occur at any time, it may be difficult at times to determine
  16908. which response goes with which command. Commands may optionally include a
  16909. \fBrequest_id\fP which, if provided in the command request, will be copied
  16910. verbatim into the response. mpv does not intrepret the \fBrequest_id\fP in any
  16911. way; it is solely for the use of the requester. The only requirement is that
  16912. the \fBrequest_id\fP field must be an integer (a number without fractional parts
  16913. in the range \fB\-2^63..2^63\-1\fP). Using other types is deprecated and will
  16914. currently show a warning. In the future, this will raise an error.
  16915. .sp
  16916. For example, this request:
  16917. .INDENT 0.0
  16918. .INDENT 3.5
  16919. .sp
  16920. .nf
  16921. .ft C
  16922. { "command": ["get_property", "time\-pos"], "request_id": 100 }
  16923. .ft P
  16924. .fi
  16925. .UNINDENT
  16926. .UNINDENT
  16927. .sp
  16928. Would generate this response:
  16929. .INDENT 0.0
  16930. .INDENT 3.5
  16931. .sp
  16932. .nf
  16933. .ft C
  16934. { "error": "success", "data": 1.468135, "request_id": 100 }
  16935. .ft P
  16936. .fi
  16937. .UNINDENT
  16938. .UNINDENT
  16939. .sp
  16940. If you don\(aqt specify a \fBrequest_id\fP, command replies will set it to 0.
  16941. .sp
  16942. Commands may run asynchronously in the future, instead of blocking the  socket
  16943. until a reply is sent.
  16944. .sp
  16945. All commands, replies, and events are separated from each other with a line
  16946. break character (\fB\en\fP).
  16947. .sp
  16948. If the first character (after skipping whitespace) is not \fB{\fP, the command
  16949. will be interpreted as non\-JSON text command, as they are used in input.conf
  16950. (or \fBmpv_command_string()\fP in the client API). Additionally, lines starting
  16951. with \fB#\fP and empty lines are ignored.
  16952. .sp
  16953. Currently, embedded 0 bytes terminate the current line, but you should not
  16954. rely on this.
  16955. .SS Commands
  16956. .sp
  16957. In addition to the commands described in \fI\%List of Input Commands\fP, a few
  16958. extra commands can also be used as part of the protocol:
  16959. .INDENT 0.0
  16960. .TP
  16961. .B \fBclient_name\fP
  16962. Return the name of the client as string. This is the string \fBipc\-N\fP with
  16963. N being an integer number.
  16964. .TP
  16965. .B \fBget_time_us\fP
  16966. Return the current mpv internal time in microseconds as a number. This is
  16967. basically the system time, with an arbitrary offset.
  16968. .TP
  16969. .B \fBget_property\fP
  16970. Return the value of the given property. The value will be sent in the data
  16971. field of the replay message.
  16972. .sp
  16973. Example:
  16974. .INDENT 7.0
  16975. .INDENT 3.5
  16976. .sp
  16977. .nf
  16978. .ft C
  16979. { "command": ["get_property", "volume"] }
  16980. { "data": 50.0, "error": "success" }
  16981. .ft P
  16982. .fi
  16983. .UNINDENT
  16984. .UNINDENT
  16985. .TP
  16986. .B \fBget_property_string\fP
  16987. Like \fBget_property\fP, but the resulting data will always be a string.
  16988. .sp
  16989. Example:
  16990. .INDENT 7.0
  16991. .INDENT 3.5
  16992. .sp
  16993. .nf
  16994. .ft C
  16995. { "command": ["get_property_string", "volume"] }
  16996. { "data": "50.000000", "error": "success" }
  16997. .ft P
  16998. .fi
  16999. .UNINDENT
  17000. .UNINDENT
  17001. .TP
  17002. .B \fBset_property\fP
  17003. Set the given property to the given value. See \fI\%Properties\fP for more
  17004. information about properties.
  17005. .sp
  17006. Example:
  17007. .INDENT 7.0
  17008. .INDENT 3.5
  17009. .sp
  17010. .nf
  17011. .ft C
  17012. { "command": ["set_property", "pause", true] }
  17013. { "error": "success" }
  17014. .ft P
  17015. .fi
  17016. .UNINDENT
  17017. .UNINDENT
  17018. .TP
  17019. .B \fBset_property_string\fP
  17020. Alias for \fBset_property\fP\&. Both commands accept native values and strings.
  17021. .TP
  17022. .B \fBobserve_property\fP
  17023. Watch a property for changes. If the given property is changed, then an
  17024. event of type \fBproperty\-change\fP will be generated
  17025. .sp
  17026. Example:
  17027. .INDENT 7.0
  17028. .INDENT 3.5
  17029. .sp
  17030. .nf
  17031. .ft C
  17032. { "command": ["observe_property", 1, "volume"] }
  17033. { "error": "success" }
  17034. { "event": "property\-change", "id": 1, "data": 52.0, "name": "volume" }
  17035. .ft P
  17036. .fi
  17037. .UNINDENT
  17038. .UNINDENT
  17039. .sp
  17040. \fBWARNING:\fP
  17041. .INDENT 7.0
  17042. .INDENT 3.5
  17043. If the connection is closed, the IPC client is destroyed internally,
  17044. and the observed properties are unregistered. This happens for example
  17045. when sending commands to a socket with separate \fBsocat\fP invocations.
  17046. This can make it seem like property observation does not work. You must
  17047. keep the IPC connection open to make it work.
  17048. .UNINDENT
  17049. .UNINDENT
  17050. .TP
  17051. .B \fBobserve_property_string\fP
  17052. Like \fBobserve_property\fP, but the resulting data will always be a string.
  17053. .sp
  17054. Example:
  17055. .INDENT 7.0
  17056. .INDENT 3.5
  17057. .sp
  17058. .nf
  17059. .ft C
  17060. { "command": ["observe_property_string", 1, "volume"] }
  17061. { "error": "success" }
  17062. { "event": "property\-change", "id": 1, "data": "52.000000", "name": "volume" }
  17063. .ft P
  17064. .fi
  17065. .UNINDENT
  17066. .UNINDENT
  17067. .TP
  17068. .B \fBunobserve_property\fP
  17069. Undo \fBobserve_property\fP or \fBobserve_property_string\fP\&. This requires the
  17070. numeric id passed to the observed command as argument.
  17071. .sp
  17072. Example:
  17073. .INDENT 7.0
  17074. .INDENT 3.5
  17075. .sp
  17076. .nf
  17077. .ft C
  17078. { "command": ["unobserve_property", 1] }
  17079. { "error": "success" }
  17080. .ft P
  17081. .fi
  17082. .UNINDENT
  17083. .UNINDENT
  17084. .TP
  17085. .B \fBrequest_log_messages\fP
  17086. Enable output of mpv log messages. They will be received as events. The
  17087. parameter to this command is the log\-level (see \fBmpv_request_log_messages\fP
  17088. C API function).
  17089. .sp
  17090. Log message output is meant for humans only (mostly for debugging).
  17091. Attempting to retrieve information by parsing these messages will just
  17092. lead to breakages with future mpv releases. Instead, make a feature request,
  17093. and ask for a proper event that returns the information you need.
  17094. .TP
  17095. .B \fBenable_event\fP, \fBdisable_event\fP
  17096. Enables or disables the named event. Mirrors the \fBmpv_request_event\fP C
  17097. API function. If the string \fBall\fP is used instead of an event name, all
  17098. events are enabled or disabled.
  17099. .sp
  17100. By default, most events are enabled, and there is not much use for this
  17101. command.
  17102. .TP
  17103. .B \fBget_version\fP
  17104. Returns the client API version the C API of the remote mpv instance
  17105. provides.
  17106. .sp
  17107. See also: \fBDOCS/client\-api\-changes.rst\fP\&.
  17108. .UNINDENT
  17109. .SS UTF\-8
  17110. .sp
  17111. Normally, all strings are in UTF\-8. Sometimes it can happen that strings are
  17112. in some broken encoding (often happens with file tags and such, and filenames
  17113. on many Unixes are not required to be in UTF\-8 either). This means that mpv
  17114. sometimes sends invalid JSON. If that is a problem for the client application\(aqs
  17115. parser, it should filter the raw data for invalid UTF\-8 sequences and perform
  17116. the desired replacement, before feeding the data to its JSON parser.
  17117. .sp
  17118. mpv will not attempt to construct invalid UTF\-8 with broken "u" escape
  17119. sequences. This includes surrogate pairs.
  17120. .SS JSON extensions
  17121. .sp
  17122. The following non\-standard extensions are supported:
  17123. .INDENT 0.0
  17124. .INDENT 3.5
  17125. .INDENT 0.0
  17126. .IP \(bu 2
  17127. a list or object item can have a trailing ","
  17128. .IP \(bu 2
  17129. object syntax accepts "=" in addition of ":"
  17130. .IP \(bu 2
  17131. object keys can be unquoted, if they start with a character in "A\-Za\-z_"
  17132. and contain only characters in "A\-Za\-z0\-9_"
  17133. .IP \(bu 2
  17134. byte escapes with "xAB" are allowed (with AB being a 2 digit hex number)
  17135. .UNINDENT
  17136. .UNINDENT
  17137. .UNINDENT
  17138. .sp
  17139. Example:
  17140. .INDENT 0.0
  17141. .INDENT 3.5
  17142. .sp
  17143. .nf
  17144. .ft C
  17145. { objkey = "value\ex0A" }
  17146. .ft P
  17147. .fi
  17148. .UNINDENT
  17149. .UNINDENT
  17150. .sp
  17151. Is equivalent to:
  17152. .INDENT 0.0
  17153. .INDENT 3.5
  17154. .sp
  17155. .nf
  17156. .ft C
  17157. { "objkey": "value\en" }
  17158. .ft P
  17159. .fi
  17160. .UNINDENT
  17161. .UNINDENT
  17162. .SH CHANGELOG
  17163. .sp
  17164. There is no real changelog, but you can look at the following things:
  17165. .INDENT 0.0
  17166. .IP \(bu 2
  17167. The release changelog, which should contain most user\-visible changes,
  17168. including new features and bug fixes:
  17169. .sp
  17170. \fI\%https://github.com/mpv\-player/mpv/releases\fP
  17171. .IP \(bu 2
  17172. The git log, which is the "real" changelog
  17173. .IP \(bu 2
  17174. The files \fBclient\-api\-changes.rst\fP and \fBinterface\-changes.rst\fP in the
  17175. \fBDOCS\fP sub directoryon the git repository, which document API and user
  17176. interface changes (the latter usually documents breaking changes only, rather
  17177. than additions).
  17178. .IP \(bu 2
  17179. The file \fBmplayer\-changes.rst\fP in the \fBDOCS\fP sub directory on the git
  17180. repository, which used to be in place of this section. It documents some
  17181. changes that happened since mplayer2 forked off MPlayer. (Not updated
  17182. anymore.)
  17183. .UNINDENT
  17184. .SH EMBEDDING INTO OTHER PROGRAMS (LIBMPV)
  17185. .sp
  17186. mpv can be embedded into other programs as video/audio playback backend. The
  17187. recommended way to do so is using libmpv. See \fBlibmpv/client.h\fP in the mpv
  17188. source code repository. This provides a C API. Bindings for other languages
  17189. might be available (see wiki).
  17190. .sp
  17191. Since libmpv merely allows access to underlying mechanisms that can control
  17192. mpv, further documentation is spread over a few places:
  17193. .INDENT 0.0
  17194. .IP \(bu 2
  17195. \fI\%https://github.com/mpv\-player/mpv/blob/master/libmpv/client.h\fP
  17196. .IP \(bu 2
  17197. \fI\%http://mpv.io/manual/master/#options\fP
  17198. .IP \(bu 2
  17199. \fI\%http://mpv.io/manual/master/#list\-of\-input\-commands\fP
  17200. .IP \(bu 2
  17201. \fI\%http://mpv.io/manual/master/#properties\fP
  17202. .IP \(bu 2
  17203. \fI\%https://github.com/mpv\-player/mpv\-examples/tree/master/libmpv\fP
  17204. .UNINDENT
  17205. .SH C PLUGINS
  17206. .sp
  17207. You can write C plugins for mpv. These use the libmpv API, although they do not
  17208. use the libmpv library itself.
  17209. .sp
  17210. Currently, they must be explicitly enabled at build time with
  17211. \fB\-\-enable\-cplugins\fP\&. They are available on Linux/BSD platforms only.
  17212. .SS C plugins location
  17213. .sp
  17214. C plugins are put into the mpv scripts directory in its config directory
  17215. (see the \fI\%FILES\fP section for details). They must have a \fB\&.so\fP file extension.
  17216. They can also be explicitly loaded with the \fB\-\-script\fP option.
  17217. .SS API
  17218. .sp
  17219. A C plugin must export the following function:
  17220. .INDENT 0.0
  17221. .INDENT 3.5
  17222. .sp
  17223. .nf
  17224. .ft C
  17225. int mpv_open_cplugin(mpv_handle *handle)
  17226. .ft P
  17227. .fi
  17228. .UNINDENT
  17229. .UNINDENT
  17230. .sp
  17231. The plugin function will be called on loading time. This function does not
  17232. return as long as your plugin is loaded (it runs in its own thread). The
  17233. \fBhandle\fP will be deallocated as soon as the plugin function returns.
  17234. .sp
  17235. The return value is interpreted as error status. A value of \fB0\fP is
  17236. interpreted as success, while \fB\-1\fP signals an error. In the latter case,
  17237. the player prints an uninformative error message that loading failed.
  17238. .sp
  17239. Return values other than \fB0\fP and \fB\-1\fP are reserved, and trigger undefined
  17240. behavior.
  17241. .sp
  17242. Within the plugin function, you can call libmpv API functions. The \fBhandle\fP
  17243. is created by \fBmpv_create_client()\fP (or actually an internal equivalent),
  17244. and belongs to you. You can call \fBmpv_wait_event()\fP to wait for things
  17245. happening, and so on.
  17246. .sp
  17247. Note that the player might block until your plugin calls \fBmpv_wait_event()\fP
  17248. for the first time. This gives you a chance to install initial hooks etc.
  17249. before playback begins.
  17250. .sp
  17251. The details are quite similar to Lua scripts.
  17252. .SS Linkage to libmpv
  17253. .sp
  17254. The current implementation requires that your plugins are \fBnot\fP linked against
  17255. libmpv. What your plugins uses are not symbols from a libmpv binary, but
  17256. symbols from the mpv host binary.
  17257. .SS Examples
  17258. .sp
  17259. See:
  17260. .INDENT 0.0
  17261. .IP \(bu 2
  17262. \fI\%https://github.com/mpv\-player/mpv\-examples/tree/master/cplugins\fP
  17263. .UNINDENT
  17264. .SH ENVIRONMENT VARIABLES
  17265. .sp
  17266. There are a number of environment variables that can be used to control the
  17267. behavior of mpv.
  17268. .INDENT 0.0
  17269. .TP
  17270. .B \fBHOME\fP, \fBXDG_CONFIG_HOME\fP
  17271. Used to determine mpv config directory. If \fBXDG_CONFIG_HOME\fP is not set,
  17272. \fB$HOME/.config/mpv\fP is used.
  17273. .sp
  17274. \fB$HOME/.mpv\fP is always added to the list of config search paths with a
  17275. lower priority.
  17276. .TP
  17277. .B \fBXDG_CONFIG_DIRS\fP
  17278. If set, XDG\-style system configuration directories are used. Otherwise,
  17279. the UNIX convention (\fBPREFIX/etc/mpv/\fP) is used.
  17280. .TP
  17281. .B \fBMPV_HOME\fP
  17282. Directory where mpv looks for user settings. Overrides \fBHOME\fP, and mpv
  17283. will try to load the config file as \fB$MPV_HOME/mpv.conf\fP\&.
  17284. .TP
  17285. .B \fBMPV_VERBOSE\fP (see also \fB\-v\fP and \fB\-\-msg\-level\fP)
  17286. Set the initial verbosity level across all message modules (default: 0).
  17287. This is an integer, and the resulting verbosity corresponds to the number
  17288. of \fB\-\-v\fP options passed to the command line.
  17289. .TP
  17290. .B \fBMPV_LEAK_REPORT\fP
  17291. If set to \fB1\fP, enable internal talloc leak reporting. If set to another
  17292. value, disable leak reporting. If unset, use the default, which normally is
  17293. \fB0\fP\&. If mpv was built with \fB\-\-enable\-ta\-leak\-report\fP, the default is
  17294. \fB1\fP\&. If leak reporting was disabled at compile time (\fBNDEBUG\fP in
  17295. custom \fBCFLAGS\fP), this environment variable is ignored.
  17296. .TP
  17297. .B \fBLADSPA_PATH\fP
  17298. Specifies the search path for LADSPA plugins. If it is unset, fully
  17299. qualified path names must be used.
  17300. .TP
  17301. .B \fBDISPLAY\fP
  17302. Standard X11 display name to use.
  17303. .TP
  17304. .B FFmpeg/Libav:
  17305. This library accesses various environment variables. However, they are not
  17306. centrally documented, and documenting them is not our job. Therefore, this
  17307. list is incomplete.
  17308. .sp
  17309. Notable environment variables:
  17310. .INDENT 7.0
  17311. .TP
  17312. .B \fBhttp_proxy\fP
  17313. URL to proxy for \fBhttp://\fP and \fBhttps://\fP URLs.
  17314. .TP
  17315. .B \fBno_proxy\fP
  17316. List of domain patterns for which no proxy should be used.
  17317. List entries are separated by \fB,\fP\&. Patterns can include \fB*\fP\&.
  17318. .UNINDENT
  17319. .TP
  17320. .B libdvdcss:
  17321. .INDENT 7.0
  17322. .TP
  17323. .B \fBDVDCSS_CACHE\fP
  17324. Specify a directory in which to store title key values. This will
  17325. speed up descrambling of DVDs which are in the cache. The
  17326. \fBDVDCSS_CACHE\fP directory is created if it does not exist, and a
  17327. subdirectory is created named after the DVD\(aqs title or manufacturing
  17328. date. If \fBDVDCSS_CACHE\fP is not set or is empty, libdvdcss will use
  17329. the default value which is \fB${HOME}/.dvdcss/\fP under Unix and
  17330. the roaming application data directory (\fB%APPDATA%\fP) under
  17331. Windows. The special value "off" disables caching.
  17332. .TP
  17333. .B \fBDVDCSS_METHOD\fP
  17334. Sets the authentication and decryption method that libdvdcss will use
  17335. to read scrambled discs. Can be one of \fBtitle\fP, \fBkey\fP or \fBdisc\fP\&.
  17336. .INDENT 7.0
  17337. .TP
  17338. .B key
  17339. is the default method. libdvdcss will use a set of calculated
  17340. player keys to try to get the disc key. This can fail if the drive
  17341. does not recognize any of the player keys.
  17342. .TP
  17343. .B disc
  17344. is a fallback method when key has failed. Instead of using player
  17345. keys, libdvdcss will crack the disc key using a brute force
  17346. algorithm. This process is CPU intensive and requires 64 MB of
  17347. memory to store temporary data.
  17348. .TP
  17349. .B title
  17350. is the fallback when all other methods have failed. It does not
  17351. rely on a key exchange with the DVD drive, but rather uses a crypto
  17352. attack to guess the title key. On rare cases this may fail because
  17353. there is not enough encrypted data on the disc to perform a
  17354. statistical attack, but on the other hand it is the only way to
  17355. decrypt a DVD stored on a hard disc, or a DVD with the wrong region
  17356. on an RPC2 drive.
  17357. .UNINDENT
  17358. .TP
  17359. .B \fBDVDCSS_RAW_DEVICE\fP
  17360. Specify the raw device to use. Exact usage will depend on your
  17361. operating system, the Linux utility to set up raw devices is raw(8)
  17362. for instance. Please note that on most operating systems, using a raw
  17363. device requires highly aligned buffers: Linux requires a 2048 bytes
  17364. alignment (which is the size of a DVD sector).
  17365. .TP
  17366. .B \fBDVDCSS_VERBOSE\fP
  17367. Sets the libdvdcss verbosity level.
  17368. .INDENT 7.0
  17369. .TP
  17370. .B 0
  17371. Outputs no messages at all.
  17372. .TP
  17373. .B 1
  17374. Outputs error messages to stderr.
  17375. .TP
  17376. .B 2
  17377. Outputs error messages and debug messages to stderr.
  17378. .UNINDENT
  17379. .TP
  17380. .B \fBDVDREAD_NOKEYS\fP
  17381. Skip retrieving all keys on startup. Currently disabled.
  17382. .TP
  17383. .B \fBHOME\fP
  17384. FIXME: Document this.
  17385. .UNINDENT
  17386. .UNINDENT
  17387. .SH EXIT CODES
  17388. .sp
  17389. Normally \fBmpv\fP returns 0 as exit code after finishing playback successfully.
  17390. If errors happen, the following exit codes can be returned:
  17391. .INDENT 0.0
  17392. .INDENT 3.5
  17393. .INDENT 0.0
  17394. .TP
  17395. .B 1
  17396. Error initializing mpv. This is also returned if unknown options are
  17397. passed to mpv.
  17398. .TP
  17399. .B 2
  17400. The file passed to mpv couldn\(aqt be played. This is somewhat fuzzy:
  17401. currently, playback of a file is considered to be successful if
  17402. initialization was mostly successful, even if playback fails
  17403. immediately after initialization.
  17404. .TP
  17405. .B 3
  17406. There were some files that could be played, and some files which
  17407. couldn\(aqt (using the definition of success from above).
  17408. .TP
  17409. .B 4
  17410. Quit due to a signal, Ctrl+c in a VO window (by default), or from the
  17411. default quit key bindings in encoding mode.
  17412. .UNINDENT
  17413. .UNINDENT
  17414. .UNINDENT
  17415. .sp
  17416. Note that quitting the player manually will always lead to exit code 0,
  17417. overriding the exit code that would be returned normally. Also, the \fBquit\fP
  17418. input command can take an exit code: in this case, that exit code is returned.
  17419. .SH FILES
  17420. .sp
  17421. For Windows\-specifics, see \fI\%FILES ON WINDOWS\fP section.
  17422. .INDENT 0.0
  17423. .TP
  17424. .B \fB/usr/local/etc/mpv/mpv.conf\fP
  17425. mpv system\-wide settings (depends on \fB\-\-prefix\fP passed to configure \- mpv
  17426. in default configuration will use \fB/usr/local/etc/mpv/\fP as config
  17427. directory, while most Linux distributions will set it to \fB/etc/mpv/\fP).
  17428. .TP
  17429. .B \fB~/.config/mpv/mpv.conf\fP
  17430. mpv user settings (see \fI\%CONFIGURATION FILES\fP section)
  17431. .TP
  17432. .B \fB~/.config/mpv/input.conf\fP
  17433. key bindings (see \fI\%INPUT.CONF\fP section)
  17434. .TP
  17435. .B \fB~/.config/mpv/fonts.conf\fP
  17436. Fontconfig fonts.conf that is customized for mpv. You should include system
  17437. fonts.conf in this file or mpv would not know about fonts that you already
  17438. have in the system.
  17439. .sp
  17440. Only available when libass is built with fontconfig.
  17441. .TP
  17442. .B \fB~/.config/mpv/subfont.ttf\fP
  17443. fallback subtitle font
  17444. .TP
  17445. .B \fB~/.config/mpv/fonts/\fP
  17446. Font files in this directory are used by mpv/libass for subtitles. Useful
  17447. if you do not want to install fonts to your system. Note that files in this
  17448. directory are loaded into memory before being used by mpv. If you have a
  17449. lot of fonts, consider using fonts.conf (see above) to include additional
  17450. fonts, which is more memory\-efficient.
  17451. .TP
  17452. .B \fB~/.config/mpv/scripts/\fP
  17453. All files in this directory are loaded as if they were passed to the
  17454. \fB\-\-script\fP option. They are loaded in alphabetical order. Directory entries
  17455. other than files are ignored. Files with unknown extension lead to an
  17456. initialization error. Files with \fB\&.disable\fP extension are ignored. The
  17457. \fB\-\-load\-scripts=no\fP option disables loading these files.
  17458. .TP
  17459. .B \fB~/.config/mpv/watch_later/\fP
  17460. Contains temporary config files needed for resuming playback of files with
  17461. the watch later feature. See for example the \fBQ\fP key binding, or the
  17462. \fBquit\-watch\-later\fP input command.
  17463. .sp
  17464. Each file is a small config file which is loaded if the corresponding media
  17465. file is loaded. It contains the playback position and some (not necessarily
  17466. all) settings that were changed during playback. The filenames are hashed
  17467. from the full paths of the media files. It\(aqs in general not possible to
  17468. extract the media filename from this hash. However, you can set the
  17469. \fB\-\-write\-filename\-in\-watch\-later\-config\fP option, and the player will
  17470. add the media filename to the contents of the resume config file.
  17471. .TP
  17472. .B \fB~/.config/mpv/script\-opts/osc.conf\fP
  17473. This is loaded by the OSC script. See the \fI\%ON SCREEN CONTROLLER\fP docs
  17474. for details.
  17475. .sp
  17476. Other files in this directory are specific to the corresponding scripts
  17477. as well, and the mpv core doesn\(aqt touch them.
  17478. .UNINDENT
  17479. .sp
  17480. Note that the environment variables \fB$XDG_CONFIG_HOME\fP and \fB$MPV_HOME\fP can
  17481. override the standard directory \fB~/.config/mpv/\fP\&.
  17482. .sp
  17483. Also, the old config location at \fB~/.mpv/\fP is still read, and if the XDG
  17484. variant does not exist, will still be preferred.
  17485. .SH FILES ON WINDOWS
  17486. .sp
  17487. On win32 (if compiled with MinGW, but not Cygwin), the default config file
  17488. locations are different. They are generally located under \fB%APPDATA%/mpv/\fP\&.
  17489. For example, the path to mpv.conf is \fB%APPDATA%/mpv/mpv.conf\fP, which maps to
  17490. a system and user\-specific path, for example
  17491. .INDENT 0.0
  17492. .INDENT 3.5
  17493. \fBC:\eusers\eUSERNAME\eAppData\eRoaming\empv\empv.conf\fP
  17494. .UNINDENT
  17495. .UNINDENT
  17496. .sp
  17497. You can find the exact path by running \fBecho %APPDATA%\empv\empv.conf\fP in cmd.exe.
  17498. .sp
  17499. Other config files (such as \fBinput.conf\fP) are in the same directory. See the
  17500. \fI\%FILES\fP section above.
  17501. .sp
  17502. The environment variable \fB$MPV_HOME\fP completely overrides these, like on
  17503. UNIX.
  17504. .sp
  17505. If a directory named \fBportable_config\fP next to the mpv.exe exists, all
  17506. config will be loaded from this directory only. Watch later config files are
  17507. written to this directory as well. (This exists on Windows only and is redundant
  17508. with \fB$MPV_HOME\fP\&. However, since Windows is very scripting unfriendly, a
  17509. wrapper script just setting \fB$MPV_HOME\fP, like you could do it on other
  17510. systems, won\(aqt work. \fBportable_config\fP is provided for convenience to get
  17511. around this restriction.)
  17512. .sp
  17513. Config files located in the same directory as \fBmpv.exe\fP are loaded with
  17514. lower priority. Some config files are loaded only once, which means that
  17515. e.g. of 2 \fBinput.conf\fP files located in two config directories, only the
  17516. one from the directory with higher priority will be loaded.
  17517. .sp
  17518. A third config directory with the lowest priority is the directory named \fBmpv\fP
  17519. in the same directory as \fBmpv.exe\fP\&. This used to be the directory with the
  17520. highest priority, but is now discouraged to use and might be removed in the
  17521. future.
  17522. .sp
  17523. Note that mpv likes to mix \fB/\fP and \fB\e\fP path separators for simplicity.
  17524. kernel32.dll accepts this, but cmd.exe does not.
  17525. .SH COPYRIGHT
  17526. GPLv2+
  17527. .\" Generated by docutils manpage writer.
  17528. .