uosc

Minimalist cursor proximity based UI for MPV player.

Most notable features:

• UI elements hide and show based on their proximity to cursor instead of every time mouse moves. This gives you 100% control over when you see the UI and when you don't. Click on the preview above to see it in action.
• Set min timeline size to make an always visible discrete progress bar.
• Build your own context menu with nesting support by editing your input.conf file.
• UIs for:
  • Loading external subtitles.
  • Selecting subtitle/audio/video track.
  • Selecting stream quality.
  • Quick directory and playlist navigation.
• Mouse scroll wheel does multiple things depending on what is the cursor hovering over:
  • Timeline: seek by timeline_step seconds per scroll.
  • Volume bar: change volume by volume_step per scroll.
  • Speed bar: change speed by speed_step per scroll.
  • Just hovering video with no UI widget below cursor: your configured wheel bindings from input.conf.
• Transform chapters into timeline ranges (the red portion of the timeline in the preview).
• And a lot of useful options and commands to bind keys to.

Changelog.

• uosc.lua - script file
• uosc.conf - configuration file with default values (optional)

• uosc.lua
• uosc.conf

1. uosc is a replacement for the built in osc, so that has to be disabled first.

   In your mpv.conf (List of all the possible places where configuration files can be located in is documented here: https://mpv.io/manual/master/#files):

   # required so that the 2 UIs don't fight each other
   osc=no
   # uosc provides its own seeking/volume indicators, so you also don't need this
   osd-bar=no
   # uosc will draw its own window controls if you disable window border
   border=no
   

2. Save uosc.lua into scripts/ folder.

3. To configure uosc to your likings, create a script-opts/uosc.conf file, or download uosc.conf with all default values from one of the links above, and save into script-opts/ folder.

4. OPTIONAL: If the UI feels sluggish/slow while playing video, you can remedy this a lot by placing this in your mpv.conf:

   video-sync=display-resample
   

   Though this does come at the cost of a little bit higher CPU/GPU load.

   What is going on?

   uosc places performance as one of its top priorities, so how can the UI feel slow? Well, it really isn't, uosc is fast, it just doesn't feel like it because when video is playing, the UI rendering frequency is chained to its frame rate, so unless you are the type of person that can't see above 24fps, it will feel slow, unless you tell mpv to resample the video framerate to match your display. This is mpv limitation, and not much we can do about it on our side.

All of the available uosc options with their default values are in the provided uosc.conf. Follow one of the download links to the version of this file that matches your uosc.lua, or just peak the latest development version for a quick reference, but this might have options that are different or not available in stable release.

To change the font, uosc respects the mpv osd-font configuration. To change it, you have to declare osd-font in your mpv.conf.

The only keybinds uosc defines by default are menu navigation keys that are active only when one of the menus (context menu, load/select subtitles,...) is active. They are:

• ↑, ↓, ←, → - up, down, previous menu or close, select item
• k, j, h, l - up, down, previous menu or close, select item
• w, s, a, d - up, down, previous menu or close, select item
• enter - select item
• esc - close menu
• wheel_up, wheel_down - scroll menu
• pgup, pgdwn, home, end - self explanatory

Click on a faded parent menu to go back to it.

Hold shift to activate menu item without closing the menu.

uosc also provides various commands with useful features to bind your preferred keys to. See Commands section below.

To add a keybind to one of this commands, open your input.conf file and add one on a new line. The command syntax is script-binding uosc/{command-name}.

Example to bind the tab key to peek timeline:

tab  script-binding uosc/peek-timeline

Available commands:

Makes the whole UI visible until you call this command again, or move the cursor. Useful for peeking remaining time and such while watching.

You can also peek only a specific element with peek-{element} command.

{element} can be one of: timeline, controls, volume, top-bar

Toggles the always visible portion of the timeline. You can look at it as switching timeline_size_min option between it's configured value and 0.

Commands to briefly flash a specified element. You can use it in your bindings like so:

space        cycle pause; script-binding uosc/flash-pause-indicator
right        seek  5
left         seek -5
shift+right  seek  30; script-binding uosc/flash-timeline
shift+left   seek -30; script-binding uosc/flash-timeline
m            cycle mute; script-binding uosc/flash-volume
up           add volume  10; script-binding uosc/flash-volume
down         add volume -10; script-binding uosc/flash-volume
[            add speed -0.25; script-binding uosc/flash-speed
]            add speed  0.25; script-binding uosc/flash-speed
\            set speed 1; script-binding uosc/flash-speed
>            script-binding uosc/next; script-binding uosc/flash-top-bar; script-binding uosc/flash-timeline
<            script-binding uosc/prev; script-binding uosc/flash-top-bar; script-binding uosc/flash-timeline

Case for (flash/decide)-pause-indicator: mpv handles frame stepping forward by briefly resuming the video, which causes pause indicator to flash, and none likes that when they are trying to compare frames. The solution is to enable manual pause indicator (pause_indicator=manual) and use flash-pause-indicator (for a brief flash) or decide-pause-indicator (for a static indicator) as a secondary command to all bindings you wish would display it (see space binding example above).

Toggles menu. Menu is empty by default and won't show up when this is pressed. Read Menu section below to find out how to fill it up with items you want there.

Menus to select a track of a requested type.

Displays a file explorer with directory navigation to load a requested track type.

For subtitles, explorer only displays file types defined in subtitle_types option.

Playlist navigation.

Chapter navigation.

Switch stream quality. This is just a basic re-assignment of ytdl-format mpv property from predefined options (configurable with stream_quality_options) and video reload, there is no fetching of available formats going on.

Open file menu. Browsing starts in current file directory, or user directory when file not available.

Opens playlist menu when playlist exists, or open-file menu otherwise.

Open next item in playlist, or file in current directory when there is no playlist.

Open previous item in playlist, or file in current directory when there is no playlist.

Open first item in playlist, or file in current directory when there is no playlist.

Open last item in playlist, or file in current directory when there is no playlist.

Open next file in current directory. Set directory_navigation_loops=yes to open first file when at the end.

Open previous file in current directory. Set directory_navigation_loops=yes to open last file when at the start.

Open first file in current directory.

Open last file in current directory.

Delete currently playing file and start next file in playlist (if there is a playlist) or current directory.

Useful when watching episodic content.

Delete currently playing file and quit mpv.

Show current file in your operating systems' file explorer.

Switch audio output device.

Open directory with mpv.conf in file explorer.

uosc provides a way to build, display, and use your own menu. By default it displays a pre-configured menu with common actions.

To display the menu, add uosc's menu command to a key of your choice. Example to bind it to right click and menu buttons:

mbtn_right  script-binding uosc/menu
menu        script-binding uosc/menu

To display a submenu, send a show-submenu message to uosc with first parameter specifying menu ID. Example:

R    script-message-to uosc show-submenu "Utils > Aspect ratio"

*menu button is the key between win and right_ctrl buttons that none uses (might not be on your keyboard).*

Adding items to menu is facilitated by commenting your keybinds in input.conf with special comment syntax. uosc will than parse this file and build the context menu out of it.

Comment has to be at the end of the line with the binding.

Comment has to start with #! (or #menu:).

Text after #! is an item title.

Title can be split with > to define nested menus. There is no limit on nesting.

Use # instead of a key if you don't necessarily want to bind a key to a command, but still want it in the menu.

If multiple menu items with the same command are defined, uosc will concatenate them into one item and just display all available shortcuts as that items' hint, while using the title of the first defined item.

Menu items are displayed in the order they are defined in input.conf file.

The command ignore does not result in a menu item, however all the folders leading up to it will still be created. This allows more flexible structuring of the input.conf file.

Adds a menu item to load subtitles:

alt+s  script-binding uosc/load-subtitles  #! Load subtitles

Adds a stay-on-top toggle with no keybind:

#  cycle ontop  #! Toggle on-top

Define and display multiple shortcuts in single items' menu hint (items with same command get concatenated):

esc  quit  #! Quit
q    quit  #!

Define a folder without defining any of its contents:

#  ignore  #! Folder title >

Example context menu:

This is the default pre-configured menu if none is defined in your input.conf, but with added shortcuts.

menu        script-binding uosc/menu
mbtn_right  script-binding uosc/menu
o           script-binding uosc/open-file          #! Open file
P           script-binding uosc/playlist           #! Playlist
C           script-binding uosc/chapters           #! Chapters
S           script-binding uosc/subtitles          #! Subtitle tracks
A           script-binding uosc/audio              #! Audio tracks
q           script-binding uosc/stream-quality     #! Stream quality
>           script-binding uosc/next               #! Navigation > Next
<           script-binding uosc/prev               #! Navigation > Prev
alt+>       script-binding uosc/delete-file-next   #! Navigation > Delete file & Next
alt+<       script-binding uosc/delete-file-prev   #! Navigation > Delete file & Prev
alt+esc     script-binding uosc/delete-file-quit   #! Navigation > Delete file & Quit
alt+s       script-binding uosc/load-subtitles     #! Utils > Load subtitles
#           set video-aspect-override "-1"         #! Utils > Aspect ratio > Default
#           set video-aspect-override "16:9"       #! Utils > Aspect ratio > 16:9
#           set video-aspect-override "4:3"        #! Utils > Aspect ratio > 4:3
#           set video-aspect-override "2.35:1"     #! Utils > Aspect ratio > 2.35:1
#           script-binding uosc/audio-device       #! Utils > Audio devices
ctrl+s      async screenshot                       #! Utils > Screenshot
O           script-binding uosc/show-in-directory  #! Utils > Show in directory
#           script-binding uosc/open-config-directory #! Utils > Open config directory
esc         quit #! Quit

To see all the commands you can bind keys or menu items to, refer to mpv's list of input commands documentation.

uosc listens on some messages that can be sent with script-message-to uosc command. Example:

R    script-message-to uosc show-submenu "Utils > Aspect ratio"

Tells uosc to send it's version to <script_id> script. Useful if you want to detect that uosc is installed. Example:

-- Register response handler
mp.register_script_message('uosc-version', function(version)
  print('uosc version', version)
end)

-- Ask for version
mp.commandv('script-message-to', 'uosc', 'get-version', mp.get_script_name())

Opens one of the submenus defined in input.conf (read on how to build those in the Menu documentation above).

Parameters

ID (title) of the submenu, including > subsections as defined in input.conf. It has to be match the title exactly.

A message other scripts can send to open a uosc menu serialized as JSON. You can optionally pass a submenu_id to pre-open a submenu. The ID is the submenu title chain leading to the submenu concatenated with >, for example Tools > Aspect ratio.

Menu data structure:

Menu {
  type?: string;
  title?: string;
  items: Item[];
  selected_index?: integer;
  keep_open?: boolean;
}

Item = Command | Submenu;

Submenu {
  title?: string;
  hint?: string;
  items: Item[];
  keep_open?: boolean;
}

Command {
  title?: string;
  hint?: string;
  icon?: string;
  value: string | string[];
  bold?: boolean;
  italic?: boolean;
  muted?: boolean;
  active?: integer;
  keep_open?: boolean;
}

When command value is a string, it'll be passed to mp.command(value). If it's a table (array) of strings, it'll be used as mp.commandv(table.unpack(value)).

Menu type controls what happens when opening a menu when some other menu is already open. When the new menu type is different, it'll replace the currently opened menu. When it's the same, the currently open menu will simply be closed. This is used to implement toggling of menus with the same type.

item.icon property accepts icon names. You can pick one from here: Google Material Icons

When keep_open is true, activating the item will not close the menu. This property can be defined on both menus and items, and is inherited from parent to child if child doesn't overwrite it.

It's usually not necessary to define selected_index as it'll default to the first active item, or 1st item in the list.

Example:

local utils = require('mp.utils')
local menu = {
  type = 'menu_type',
  title = 'Custom menu',
  items = {
    {title = 'Foo', hint = 'foo', value = 'quit'},
    {title = 'Bar', hint = 'bar', value = 'quit', active = true},
  }
}
local json = utils.format_json(menu)
mp.commandv('script-message-to', 'uosc', 'open-menu', json)

Updates currently opened menu with the same type. If the menu isn't open, it will be opened.

The difference between this and open-menu is that if the same type menu is already open, open-menu will close it (facilitating menu toggling with the same key/command), while update-menu will update it's data.

update-menu, along with {menu/item}.keep_open property and item.command that sends a message back can be used to create a self updating menu with some limited UI. Example:

local utils = require('mp.utils')
local script_name = mp.get_script_name()
local state = {
  checkbox = 'no',
  radio = 'bar'
}

function command(str)
  return string.format('script-message-to %s %s', script_name, str)
end

function create_menu_data()
  return {
    type = 'test_menu',
    title = 'Test menu',
    keep_open = true,
    items = {
      {
        title = 'Checkbox',
        icon = state.checkbox == 'yes' and 'check_box' or 'check_box_outline_blank',
        value = command('set-state checkbox ' .. (state.checkbox == 'yes' and 'no' or 'yes'))
      },
      {
        title = 'Radio',
        hint = state.radio,
        items = {
          {
            title = 'Foo',
            icon = state.radio == 'foo' and 'radio_button_checked' or 'radio_button_unchecked',
            value = command('set-state radio foo')
          },
          {
            title = 'Bar',
            icon = state.radio == 'bar' and 'radio_button_checked' or 'radio_button_unchecked',
            value = command('set-state radio bar')
          },
          {
            title = 'Baz',
            icon = state.radio == 'baz' and 'radio_button_checked' or 'radio_button_unchecked',
            value = command('set-state radio baz')
          },
        },
      },
      {
        title = 'Submit',
        icon = 'check',
        value = command('submit'),
        keep_open = false
      },
    }
  }
end

mp.add_forced_key_binding('t', 'test_menu', function()
  local json = utils.format_json(create_menu_data())
  mp.commandv('script-message-to', 'uosc', 'open-menu', json)
end)

mp.register_script_message('set-state', function(prop, value)
  state[prop] = value
  -- Update currently opened menu
  local json = utils.format_json(create_menu_data())
  mp.commandv('script-message-to', 'uosc', 'update-menu', json)
end)

mp.register_script_message('submit', function(prop, value)
  -- Do something with state
end)