Something went wrong. Try again.
🎥 Command line media player
Something went wrong. Try again.
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644ON SCREEN CONTROLLER====================
The On Screen Controller (short: OSC) is a minimal GUI integrated with mpv tooffer basic mouse-controllability. It is intended to make interaction easierfor new users and to enable precise and direct seeking.
The OSC is enabled by default if mpv was compiled with Lua support. It can bedisabled entirely using the ``--osc=no`` option.
Using the OSC-------------
By default, the OSC will show up whenever the mouse is moved inside theplayer window and will hide if the mouse is not moved outside the OSC for0.5 seconds or if the mouse leaves the window.
The Interface~~~~~~~~~~~~~
::
+------+---------+---------+-----------------------------------------------+ | menu | pl prev | pl next | title cache | +------+------+------+---------+-----------+------+-------+-----+-----+----+ | play | skip | skip | time | seekbar | time | audio | sub | vol | fs | | | back | frwd | elapsed | | left | | | | | +------+------+------+---------+-----------+------+-------+-----+-----+----+
menu ============= ================================================ left-click open the menu ============= ================================================
pl prev ============= ================================================ left-click play previous file in playlist shift+L-click show the playlist middle-click show the playlist right-click open the playlist selector ============= ================================================
pl next ============= ================================================ left-click play next file in playlist shift+L-click show the playlist middle-click show the playlist right-click open the playlist selector ============= ================================================
title | Displays the current playlist position and media-title, filename or custom title, or the target chapter name while hovering the seekbar.
============= ================================================ left-click show file and track info shift+L-click show the path middle-click show the path right-click open the history selector ============= ================================================
cache | Shows current cache fill status
play ============= ================================================ left-click toggle play/pause shift+L-click toggle infinite looping of the playlist middle-click toggle infinite looping of the playlist right-click toggle infinite looping of the current file ============= ================================================
skip back ============= ================================================ left-click go to beginning of chapter / previous chapter shift+L-click show chapters middle-click show chapters right-click open the chapter selector ============= ================================================
skip frwd ============= ================================================ left-click go to next chapter shift+L-click show chapters middle-click show chapters right-click open the chapter selector ============= ================================================
time elapsed | Shows current playback position timestamp
============= ================================================ left-click toggle displaying timecodes with milliseconds ============= ================================================
seekbar | Indicates current playback position and position of chapters
============= ================================================ left-click seek to position right-click seek to the nearest chapter mouse wheel seek forward/backward ============= ================================================
time left | Shows remaining playback time timestamp
============= ================================================ left-click toggle between total and remaining time ============= ================================================
audio and sub | Displays selected track and amount of available tracks
============= ================================================ left-click cycle audio/sub tracks forward shift+L-click cycle audio/sub tracks backwards middle-click cycle audio/sub tracks backwards right-click open the audio/sub track selector mouse wheel cycle audio/sub tracks forward/backwards ============= ================================================
vol ============= ================================================ left-click toggle mute right-click open the audio device selector mouse wheel volume up/down ============= ================================================
fs ============= ================================================ left-click toggle fullscreen right-click toggle whether the window is maximized ============= ================================================
Since mpv 0.40.0, it is possible to configure the commands to run with mouseactions on some interface elements, and the default behaviors of severalelements were changed. If you miss some older behaviors, look at``etc/restore-osc-bindings.conf`` in the mpv git repository.
Key Bindings~~~~~~~~~~~~
These key bindings are active by default if nothing else is already bound tothese keys. In case of collision, the function needs to be bound to adifferent key. See the `Script Commands`_ section.
============= ================================================del Cycles visibility between never / auto (mouse-move) / always============= ================================================
Configuration-------------
This script can be customized through a config file ``script-opts/osc.conf``placed in mpv's user directory and through the ``--script-opts`` command-lineoption. The configuration syntax is described in `mp.options functions`_.
Command-line Syntax~~~~~~~~~~~~~~~~~~~
To avoid collisions with other scripts, all options need to be prefixed with``osc-``.
Example::
--script-opts=osc-optionA=value1,osc-optionB=value2
Configurable Options~~~~~~~~~~~~~~~~~~~~
``layout`` Default: bottombar
The layout for the OSC. Currently available are: box, slimbox, bottombar, topbar, slimbottombar and slimtopbar. Default pre-0.21.0 was 'box'.
``seekbarstyle`` Default: bar
Sets the style of the playback position marker and overall shape of the seekbar: ``bar``, ``diamond`` or ``knob``.
``seekbarhandlesize`` Default: 0.6
Size ratio of the seek handle if ``seekbarstyle`` is set to ``diamond`` or ``knob``. This is relative to the full height of the seekbar.
``seekbarkeyframes`` Default: yes
Controls the mode used to seek when dragging the seekbar. If set to ``yes``, default seeking mode is used (usually keyframes, but player defaults and heuristics can change it to exact). If set to ``no``, exact seeking on mouse drags will be used instead. Keyframes are preferred, but exact seeks may be useful in cases where keyframes cannot be found. Note that using exact seeks can potentially make mouse dragging much slower.
``seekrangestyle`` Default: inverted
Display seekable ranges on the seekbar. ``bar`` shows them on the full height of the bar, ``line`` as a thick line and ``inverted`` as a thin line that is inverted over playback position markers. ``none`` will hide them. Additionally, ``slider`` will show a permanent handle inside the seekbar with cached ranges marked inside. Note that these will look differently based on the seekbarstyle option. Also, ``slider`` does not work with ``seekbarstyle`` set to ``bar``.
``seekrangeseparate`` Default: yes
Controls whether to show line-style seekable ranges on top of the seekbar or separately if ``seekbarstyle`` is set to ``bar``.
``seekrangealpha`` Default: 200
Alpha of the seekable ranges, 0 (opaque) to 255 (fully transparent).
``scrollcontrols`` Default: yes
By default, going up or down with the mouse wheel can trigger certain actions (such as seeking) if the mouse is hovering an OSC element. Set to ``no`` to disable any special mouse wheel behavior.
``deadzonesize`` Default: 0.5
Size of the deadzone. The deadzone is an area that makes the mouse act like leaving the window. Movement there won't make the OSC show up and it will hide immediately if the mouse enters it. The deadzone starts at the window border opposite to the OSC and the size controls how much of the window it will span. Values between 0.0 and 1.0, where 0 means the OSC will always popup with mouse movement in the window, and 1 means the OSC will only show up when the mouse hovers it. Default pre-0.21.0 was 0.
``minmousemove`` Default: 0
Minimum amount of pixels the mouse has to move between ticks to make the OSC show up. Default pre-0.21.0 was 3.
``showwindowed`` Default: yes
Enable the OSC when windowed
``showfullscreen`` Default: yes
Enable the OSC when fullscreen
``idlescreen`` Default: yes
Show the mpv logo and message when idle
``scalewindowed`` Default: 1.0
Scale factor of the OSC when windowed.
``scalefullscreen`` Default: 1.0
Scale factor of the OSC when fullscreen
``vidscale`` Default: auto
Scale the OSC with the video. ``no`` tries to keep the OSC size constant as much as the window size allows. ``auto`` scales the OSC with the OSD, which is scaled with the window or kept at a constant size, depending on the ``--osd-scale-by-window`` option.
``valign`` Default: 0.8
Vertical alignment in box and slimbox layouts, -1 (top) to 1 (bottom).
``halign`` Default: 0.0
Horizontal alignment in box and slimbox layouts, -1 (left) to 1 (right).
``barmargin`` Default: 0
Margin from bottom (bottombar, slimbottombar) or top (topbar, slimtopbar), in pixels.
``boxalpha`` Default: 80
Alpha of the background box, 0 (opaque) to 255 (fully transparent)
``hidetimeout`` Default: 500
Duration in ms until the OSC hides if no mouse movement, must not be negative
``fadeduration`` Default: 200
Duration of fade effects in ms, 0 = no fade.
``fadein`` Default: no
Enable fade-in.
``title`` Default: ${!playlist-count==1:[${playlist-pos-1}/${playlist-count}] }${media-title}
String that supports property expansion that will be displayed as OSC title. ASS tags are escaped and newlines are converted to spaces.
``tooltipborder`` Default: 1
Size of the tooltip outline when using bottombar or topbar layouts
``timetotal`` Default: no
Show total time instead of time remaining
``remaining_playtime`` Default: yes
Whether the time-remaining display takes speed into account. ``yes`` - how much playback time remains at the current speed. ``no`` - how much video-time remains.
``timems`` Default: no
Display timecodes with milliseconds
``tcspace`` Default: 100 (allowed: 50-200)
Adjust space reserved for timecodes (current time and time remaining) in the ``bottombar`` and ``topbar`` layouts. The timecode width depends on the font, and with some fonts the spacing near the timecodes becomes too small. Use values above 100 to increase that spacing, or below 100 to decrease it.
``visibility`` Default: auto (auto hide/show on mouse move)
Also supports ``never`` and ``always``
``visibility_modes`` Default: never_auto_always
The list of visibility modes to cycle through when calling the osc-visibility cycle script message. Modes are separated by ``_``.
``boxmaxchars`` Default: 80
Max chars for the osc title at the box layout. mpv does not measure the text width on screen and so it needs to limit it by number of chars. The default is conservative to allow wide fonts to be used without overflow. However, with many common fonts a bigger number can be used. YMMV.
``boxvideo`` Default: no
Whether to overlay the osc over the video (``no``), or to box the video within the areas not covered by the osc (``yes``). If this option is set, the osc may overwrite the ``--video-margin-ratio-*`` options, even if the user has set them. (It will not overwrite them if all of them are set to default values.) Additionally, ``visibility`` must be set to ``always``. Otherwise, this option does nothing.
Currently, this is supported for the ``bottombar``, ``slimbottombar``, ``topbar`` and ``slimtopbar`` layouts only. The other layouts do not change if this option is set. Separately, if window controls are present (see below), they will be affected regardless of which osc layout is in use.
The border is static and appears even if the OSC is configured to appear only on mouse interaction. If the OSC is invisible, the border is simply filled with the background color (black by default).
This currently still makes the OSC overlap with subtitles (if the ``--sub-use-margins`` option is set to ``yes``, the default). This may be fixed later.
This does not work correctly with video outputs like ``--vo=xv``, which render OSD into the unscaled video.
``windowcontrols`` Default: auto (Show window controls if there is no window border)
Whether to show window management controls over the video, and if so, which side of the window to place them. This may be desirable when the window has no decorations, either because they have been explicitly disabled (``border=no``) or because the current platform doesn't support them (eg: gnome-shell with wayland).
The set of window controls is fixed, offering ``minimize``, ``maximize``, and ``quit``. Not all platforms implement ``minimize`` and ``maximize``, but ``quit`` will always work.
``windowcontrols_alignment`` Default: right
If window controls are shown, indicates which side should they be aligned to.
Supports ``left`` and ``right`` which will place the controls on those respective sides.
``windowcontrols_title`` Default: ${media-title}
String that supports property expansion that will be displayed as the windowcontrols title. ASS tags are escaped, and newlines and trailing slashes are stripped.
``greenandgrumpy`` Default: no
Set to ``yes`` to reduce festivity (i.e. disable santa hat in December.)
``livemarkers`` Default: yes
Update chapter markers positions on duration changes, e.g. live streams. The updates are unoptimized - consider disabling it on very low-end systems.
``chapter_fmt`` Default: ``Chapter: %s``
Template for the chapter-name display when hovering the seekbar. Use ``no`` to disable chapter display on hover. Otherwise it's a lua ``string.format`` template and ``%s`` is replaced with the actual name.
``unicodeminus`` Default: no
Use a Unicode minus sign instead of an ASCII hyphen when displaying the remaining playback time.
``background_color`` Default: #000000
Sets the background color of the OSC.
``timecode_color`` Default: #FFFFFF
Sets the color of the timecode and seekbar, of the OSC.
``title_color`` Default: #FFFFFF
Sets the color of the video title. Formatted as #RRGGBB.
``time_pos_color`` Default: #FFFFFF
Sets the color of the timecode at hover position in the seekbar.
``time_pos_outline_color`` Default: #FFFFFF
Sets the color of the timecode's outline at hover position in the seekbar. Also affects the timecode in the slimbox layout.
``buttons_color`` Default: #FFFFFF
Sets the colors of the big buttons.
``top_buttons_color`` Default: #FFFFFF
Sets the colors of the top buttons.
``small_buttonsL_color`` Default: #FFFFFF
Sets the colors of the small buttons on the left in the box layout.
``small_buttonsR_color`` Default: #FFFFFF
Sets the colors of the small buttons on the right in the box layout.
``held_element_color`` Default: #999999
Sets the colors of the elements that are being pressed or held down.
``tick_delay`` Default: 1/60
Sets the minimum interval between OSC redraws in seconds. This can be decreased on fast systems to make OSC rendering smoother.
Ignored if ``tick_delay_follow_display_fps`` is set to yes and the VO supports the ``display-fps`` property.
``tick_delay_follow_display_fps`` Default: no
Use display fps to calculate the interval between OSC redraws.
The following options configure what commands are run when the buttons areclicked. ``mbtn_mid`` commands are also triggered with ``shift+mbtn_left``.
``menu_mbtn_left_command=script-binding select/menu; script-message-to osc osc-hide``
``menu_mbtn_mid_command=``
``menu_mbtn_right_command=``
``playlist_prev_mbtn_left_command=playlist-prev; show-text ${playlist} 3000``
``playlist_prev_mbtn_mid_command=show-text ${playlist} 3000``
``playlist_prev_mbtn_right_command=script-binding select/select-playlist; script-message-to osc osc-hide``
``playlist_next_mbtn_left_command=playlist-next; show-text ${playlist} 3000``
``playlist_next_mbtn_mid_command=show-text ${playlist} 3000``
``playlist_next_mbtn_right_command=script-binding select/select-playlist; script-message-to osc osc-hide``
``title_mbtn_left_command=script-binding stats/display-page-5``
``title_mbtn_mid_command=show-text ${path}``
``title_mbtn_right_command=script-binding select/select-watch-history; script-message-to osc osc-hide``
``play_pause_mbtn_left_command=cycle pause``
``play_pause_mbtn_mid_command=cycle-values loop-playlist inf no``
``play_pause_mbtn_right_command=cycle-values loop-file inf no``
``chapter_prev_mbtn_left_command=osd-msg add chapter -1``
``chapter_prev_mbtn_mid_command=show-text ${chapter-list} 3000``
``chapter_prev_mbtn_right_command=script-binding select/select-chapter; script-message-to osc osc-hide``
``chapter_next_mbtn_left_command=osd-msg add chapter 1``
``chapter_next_mbtn_mid_command=show-text ${chapter-list} 3000``
``chapter_next_mbtn_right_command=script-binding select/select-chapter; script-message-to osc osc-hide``
``audio_track_mbtn_left_command=cycle audio``
``audio_track_mbtn_mid_command=cycle audio down``
``audio_track_mbtn_right_command=script-binding select/select-aid; script-message-to osc osc-hide``
``audio_track_wheel_down_command=cycle audio``
``audio_track_wheel_up_command=cycle audio down``
``sub_track_mbtn_left_command=cycle sub``
``sub_track_mbtn_mid_command=cycle sub down``
``sub_track_mbtn_right_command=script-binding select/select-sid; script-message-to osc osc-hide``
``sub_track_wheel_down_command=cycle sub``
``sub_track_wheel_up_command=cycle sub down``
``volume_mbtn_left_command=no-osd cycle mute``
``volume_mbtn_mid_command=``
``volume_mbtn_right_command=script-binding select/select-audio-device; script-message-to osc osc-hide``
``volume_wheel_down_command=add volume -5``
``volume_wheel_up_command=add volume 5``
``fullscreen_mbtn_left_command="cycle fullscreen"``
``fullscreen_mbtn_mid_command=``
``fullscreen_mbtn_right_command="cycle window-maximized"``
Custom Buttons~~~~~~~~~~~~~~
Additional script-opts are available to define custom buttons in ``bottombar``and ``topbar`` layouts.
.. admonition:: Example to add loop and shuffle buttons
custom_button_1_content=🔁 custom_button_1_mbtn_left_command=cycle-values loop-file inf no custom_button_1_mbtn_right_command=cycle-values loop-playlist inf no
custom_button_2_content=🔀 custom_button_2_mbtn_left_command=playlist-shuffle
Script Commands~~~~~~~~~~~~~~~
The OSC script listens to certain script commands. These commands can boundin ``input.conf``, or sent by other scripts.
``osc-visibility`` Controls visibility mode ``never`` / ``auto`` (on mouse move) / ``always`` and also ``cycle`` to cycle between the modes. If a second argument is passed (any value), then the output on the OSD will be silenced.
``osc-show`` Triggers the OSC to show up, just as if user moved mouse.
``osc-hide`` Hide the OSC when ``visibility`` is ``auto``.
Example
You could put this into ``input.conf`` to hide the OSC with the ``a`` key andto set auto mode (the default) with ``b``::
a script-message osc-visibility never b script-message osc-visibility auto
``osc-idlescreen`` Controls the visibility of the mpv logo on idle. Valid arguments are ``yes``, ``no``, and ``cycle`` to toggle between yes and no. If a second argument is passed (any value), then the output on the OSD will be silenced.