ON SCREEN CONTROLLER
====================

The On Screen Controller (short: OSC) is a minimal GUI integrated with mpv to
offer basic mouse-controllability. It is intended to make interaction easier
for new users and to enable precise and direct seeking.

The OSC is enabled by default if mpv was compiled with Lua support. It can be
disabled entirely using the ``--osc=no`` option.

Using the OSC
-------------

By default, the OSC will show up whenever the mouse is moved inside the
player window and will hide if the mouse is not moved outside the OSC for
0.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 menu
    =============   ================================================

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 menu
    =============   ================================================

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 menu
    =============   ================================================

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 menu
    =============   ================================================

skip frwd
    =============   ================================================
    left-click      go to next chapter
    shift+L-click   show chapters
    middle-click    show chapters
    right-click     open the chapter menu
    =============   ================================================

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 menu
    mouse wheel     cycle audio/sub tracks forward/backwards
    =============   ================================================

vol
    =============   ================================================
    left-click      toggle mute
    right-click     open the audio device menu
    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 mouse
actions on some interface elements, and the default behaviors of several
elements 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 to
these keys. In case of collision, the function needs to be bound to a
different 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-line
option. 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, slimtopbar and floating.

``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: 20

    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.75

    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.42.0 was 0.5.

``minmousemove``
    Default: 0

    Minimum amount of pixels the mouse has to move between ticks to make
    the OSC show up.

``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

``audioonlyscreen``
    Default: no

    Show the mpv logo when no video track is present or selected.

``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 ``_``.

``boxwidth``
    Default: 550

    Width of the ``box`` layout.

``slimboxwidth``
    Default: 660

    Width of the ``slimbox`` layout.

``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.) By default, ``visibility`` must be set to ``always``.
    Use ``dynamic_margins`` to allow margins to update with OSC visibility
    instead.

    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.

    Subtitles may still overlap with the OSC when ``--sub-use-margins`` is set
    to ``yes`` (the default), as they are allowed to extend into the margin
    area. Setting ``--sub-use-margins=no`` confines subtitles to the video
    area.

    This does not work correctly with video outputs like ``--vo=xv``, which
    render OSD into the unscaled video.

``dynamic_margins``
    Default: no

    When set to ``yes``, margins follow the actual OSC visibility: they are
    applied when the OSC appears and removed when it hides. Without this
    option, margins are only applied when ``visibility`` is set to ``always``.

``sub_margins``
    Default: no

    Whether to adjust the subtitle margin so that subtitles do not overlap
    with the OSC. Requires ``dynamic_margins`` or ``visibility=always`` to
    take effect. Uses ``--sub-margin-y-offset`` to apply the adjustment.

    With ``boxvideo`` enabled and ``--sub-use-margins=no``, subtitles are
    already confined to the video area and this option has no additional
    effect.

``osd_margins``
    Default: yes

    Whether to adjust the OSD margin so that OSD text does not overlap
    with the OSC. Requires ``dynamic_margins`` or ``visibility=always`` to
    take effect. Uses ``--osd-margin-y-offset`` to apply the adjustment.

``windowcontrols``
    Default: auto (Show window controls if there is no window border/title-bar)

    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_independent``
    Default: yes

    Whether to show window controls independently of the OSC, or show them
    together.

``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.

``floatingtitle``
    Default: yes

    Whether to show the title row in the ``floating`` layout. When enabled,
    window controls are rendered as compact buttons without a full-width
    background bar.

``floatingwidth``
    Default: 700

    Width of the ``floating`` layout.

``floatingalpha``
    Default: 105

    Alpha of the ``floating`` layout background, 0 (opaque) to 255 (fully
    transparent).

``tracknumberswidth``
    Default: 35

    Width of the track number labels next to the audio/subtitle track selector
    icons. Set to ``0`` to hide track numbers and show only the icons.

``greenandgrumpy``
    Default: no

    Set to ``yes`` to reduce festivity (i.e. disable santa hat in December.)

``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.

``icon_style``
    Default: layout

    Selects the icon set used for OSC buttons. Both sets are bundled in the
    mpv-osd-symbols font.

    ``layout``
        Select the icon set based on the current layout.
    ``classic``
        The original mpv icon set.
    ``fluent``
        Icons based on Microsoft's Fluent UI System Icons.

``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.

``max_thumb_size``
    Default: 200

    Maximum display size of the preview thumbnail. Only meaningful when a
    Thumbnailer is active. See the `OSC Preview API`_ section.

The following options configure what commands are run when the buttons are
clicked. ``mbtn_mid`` commands are also triggered with ``shift+mbtn_left``.
An option that ends with ``_down_command`` means that the command is
continuously called while the mouse button is held down.

``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"``

``skip_backward_mbtn_left_down_command=seek -5``

``skip_backward_mbtn_mid_down_command=frame-back-step``

``skip_backward_mbtn_right_down_command=seek -30``

``skip_forward_mbtn_left_down_command=seek 10``

``skip_forward_mbtn_mid_down_command=frame-step``

``skip_forward_mbtn_right_down_command=seek 60``

``close_mbtn_left_command=quit``

``close_mbtn_mid_command=``

``close_mbtn_right_command=``

``minimize_mbtn_left_command=cycle window-minimized``

``minimize_mbtn_mid_command=``

``minimize_mbtn_right_command=``

``maximize_mbtn_left_command=cycle ${?fullscreen==yes:fullscreen}${!fullscreen==yes:window-maximized}``

``maximize_mbtn_mid_command=``

``maximize_mbtn_right_command=``

Custom Buttons
~~~~~~~~~~~~~~

Additional script-opts are available to define custom buttons in ``bottombar``
and ``topbar`` layouts.

.. admonition:: Example to add loop, shuffle and speed 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

        custom_button_3_content=⏱
        custom_button_3_mbtn_left_command=add speed 1
        custom_button_3_mbtn_right_command=set speed 1
        custom_button_3_wheel_up_command=add speed 0.25
        custom_button_3_wheel_down_command=add speed -0.25

Script Commands
~~~~~~~~~~~~~~~

The OSC script listens to certain script commands. These commands can bound
in ``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 and
to 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.

OSC Preview API
~~~~~~~~~~~~~~~

The OSC supports displaying preview thumbnails when hovering over the seekbar if
a compatible thumbnailer script is installed. It communicates with a thumbnailer
script via the following ``user-data`` properties:

``user-data/osc/draw-preview``
    Set by the OSC to request a thumbnail within the currently playing file.
    The ``draw-preview`` property is a table with the following fields:

    ``x``, ``y``
        Top-left coordinates (positive integers) to draw the thumbnail at.

    ``w``, ``h``
        Width and height (positive non-zero integers) of the area to draw the
        thumbnail in. Note that this only specifies the drawing width and
        height, the actual backing thumbnail size may differ.

    ``hover-sec``
        Requested thumbnail timestamp in seconds.

    ``ass``
        Optional ASS string to render alongside the thumbnail, using OSD
        coordinates. This can be used for decorations such as a thumbnail
        border.

    The OSC sets this property to ``nil`` to signal the thumbnailer to clear
    the displayed thumbnail.

Avoid installing/enabling multiple thumbnailer script since this api expects
only one to be active at a time.
