Awesome
InputEvent
This script enhanced input.conf with better, conflict-free, low-latency event mechanism.
It allows mpv users to bind events by using this syntax in input.conf.
KEY command #event: event_name
Now the supported events are:
press, release, repeat, click, double_click, triple_click, quatra_click, penta_click
Compound events e.g. click will be emitted as soon as possible to get lowest latency.
How to use?
- Put inputevent.lua into
~~/scripts - Modify your
input.conf, See Examples to get common uses - (Recommended) Append
input-doubleclick-time=200to yourmpv.conf, if you feel unresponsive due to clicking
Examples
Click to pause, Double click to fullscreen
MBTN_LEFT cycle pause #event: click
MBTN_LEFT cycle fullscreen #event: double_click
MBTN_LEFT_DBL ignore
Like Youtube, you can click to pause and double click to full screen.
But I'm an mpv user and I wanted to do the same, so I added these into input.conf.
MBTN_LEFT cycle pause
MBTN_LEFT_DBL cycle fullscreen
Hmm, it does work, but it also pauses when double click, and I don't want that.
So here is the solution.
Press to speedup, Release to restore
SPACE cycle pause #event: click
SPACE no-osd set speed 4; set pause no #event: press
SPACE ignore #event: release
When you press the SPACE the playback speed will be 4x faster.
When you release it, changes will automatically restore.
Of course, you can bind it to the right arrow key by simply replacing SPACE to RIGHT.
I just personally prefer the space.
po5/evafast also does this and is more powerful.
if you want to use it while having custom keybind, this is an example of integrating it.
RIGHT seek 5 #event: click
RIGHT script-binding evafast/speedup #event: press
RIGHT script-binding evafast/slowdown #event: release
Press to maximize/minimize volume
UP add volume 10 #event: click
UP set volume 100 #event: press
DOWN add volume -10 #event: click
DOWN set volume 0 #event: press
For the default volume adjustment, repeatedly pressing or holding is annoying, slow and imprecise.
Now just one step, press.
Click to next/prev chapter, Press to next/prev playlist item
PGUP add chapter -1 #event: click
PGUP playlist-prev #event: press
PGDWN add chapter 1 #event: click
PGDWN playlist-next #event: press
It's convenient for 65-key keyboard users like me.
HOME/END need be a combination of fn + PGUP/PGDN, which is not easy to press.
Press to display stats, Click to toggle
i script-binding stats/display-stats-toggle #event: click
i script-binding stats/display-stats #event: repeat
i script-binding stats/display-stats #event: press
Click to toggle displaying information and statistics (as default shift+i).
Press to display information and statistics (as default i).
The press line is not required, it just reduces the latency (Very little).
Press to show uosc UI
MBTN_LEFT script-message-to uosc set-min-visibility 1 #event: press
MBTN_LEFT script-message-to uosc set-min-visibility 0 #event: release
Rather than click to show, click to hide it is more comfortable to show only when pressed.
Requires tomasklaen/uosc.
Handling repeat, Make it have a different event than click
. frame-step; show-text "${estimated-frame-number}" #event: click
. set pause no #event: press
. set pause yes; show-text "${estimated-frame-number}" #event: release
. show-text "${estimated-frame-number}" #event: repeat
Here is an example of frame-step.
The click here is the same as the default behavior.
But the press of the default is stuttering, now the playback is smooth.
Handling raw press，Make it have different click, double click events
PLAYPAUSE cycle pause #event: click
PLAYPAUSE playlist-next #event: double_click
Some headphones have a PLAYPAUSE button, click to play/pause and double click to play the next, just like some smart headphones.
Press (the latter if key up/down can't be tracked) will be treated as a click.
Ideas that are currently impossible
Press LEFT to rewind
Unfortunately, mpv doesn't support rewind now.
Press MBTN_RIGHT to start mouse gesture, Release to execute the action
Will not be implemented here, Gesture is a higher level feature.
I would prefer this script to be an infrastructure, A better idea is to call other scripts.
omeryagmurlu/mpv-gestures
christoph-heinrich/mpv-touch-gestures
How does the auto-restore on release works?
Writing the ignore command in the release event will enable automatic restore.
What if you just need to ignore the release? Just don't write the line of release event.
KEY ignore #event: release
In this example press-to-speedup-release-to-restore.
If you playing with speed=0.5; pause=yes, Press will change them to speed=4; pause=no.
When released, they will restore to speed=0.5; pause=yes.
When you press, the script will record the current value of properties that will be changed.
Then it executes the command in press.
When you release, it will change the value of these properties to the value of the record.
The command-prefixes of press will be retained as is.
The restore for no-osd set speed 4 will be no-osd set speed 1.
Only set, cycle, add, multiply are currently supported for auto-restore.
A warning will be given for unsupported commands, command doesn't support auto restore..
But that doesn't mean it doesn't work at all, It will restore the reversible part.
SPACE set speed 4; show-text 1 #event: press
SPACE ignore #event: release
In the above example, the speed will be restored, show-text cannot and will not be restored.
The native press (repeat) doesn't work?
Writing the ignore command in the repeat event will bring back the original behavior of repeat.
UP add volume 1 #event: click
UP ignore #event: repeat
In the above example, if you don't write UP ignore #event: repeat, you'll have to press frequently, which is too tiring.
Extended support for property-expansion
- Dangerous, use with caution
The original property-expansion can only work for strings, but now supports inserting in all positions of the command.
This is a example of a smoother speedup.
SPACE cycle pause #event: click
SPACE no-osd set speed 1; set pause no #event: press
SPACE ignore #event: release
SPACE no-osd add speed ${?speed==4.00:0}${!speed==4.00:0.1}; show-text ${speed} #event: repeat
Support for multiple configuration files
- For same key, any events in new config will overwrite all events in old config.
You can spread out the configuration files into multiple ones like this and load them together at runtime.
script-opts-add=inputevent-configs="input.conf,~~/test.conf,~~/test.json"
input.conf
SPACE cycle pause #event: click
SPACE set speed 2.0 #event: press
SPACE set speed 1.0 #event: release
test.conf
SPACE set speed 0.5 #event: press
SPACE set speed 1.0 #event: release
test.json
[
{
"key": "SPACE",
"on": {
"click": "show-text click",
"double_click": "show-text double-click",
"penta_click": "show-text penta-click",
"press": "show-text pressed",
"quatra_click": "show-text quatra-click",
"release": "show-text released",
"repeat": "show-text repeat",
"triple_click": "show-text triple-click"
}
}
]
Also, it supports hot-reloading.
[fullscreen]
profile-cond=fullscreen
profile-restore=copy-equal
script-opts-add=inputevent-configs="input.conf,~~/test.json"
How to integrate with other scripts?
- For same key, events will be merged with existing events.
Here's an example
press Z to bind the key, press C to test the event execution and press X to unbind.
Save it as test.lua in your ~~/scripts
local utils = require("mp.utils")
local key = "c"
local on = {
click = "show-text click",
double_click = "show-text double-click",
triple_click = "show-text triple-click",
quatra_click = "show-text quatra-click",
penta_click = "show-text penta-click",
press = "show-text pressed",
release = "show-text released",
["repeat"] = "show-text repeat",
}
function bind()
local json, err = utils.format_json(on)
mp.commandv('script-message-to', 'inputevent', 'bind', key, json)
end
function unbind()
mp.commandv('script-message-to', 'inputevent', 'unbind', key)
end
mp.add_forced_key_binding("z", "test-z", bind)
mp.add_forced_key_binding("x", "test-x", unbind)