DOCS/man/input: don't discourage hook usage #17038
Conversation
Dudemanguy
left a comment
Dudemanguy
left a comment
There was a problem hiding this comment.
Yeah no point in scaring people.
DOCS/man/input.rst
Outdated
| no API stability guarantees made. Not following the protocol exactly can make | ||
| the player freeze randomly. Basically, nobody should use this API. | ||
| events are supposed to be asynchronous, and the hook API provides a way to | ||
| handle events that require stricter coordination. |
There was a problem hiding this comment.
Not following the protocol exactly can make the player freeze randomly.
Should be left intact. The hook api may be used, but is still dangerous tool in hands on scripts, and should be used with caution.
Not following the protocol exactly can make the player freeze randomly. Use with caution, avoid if possible.
There was a problem hiding this comment.
How would it freeze randomly though? We even call yt-dlp in a hook and it doesn't freeze.
There was a problem hiding this comment.
If you don't trigger next hook from script it will wait and hang forever. Generally scripts shouldn't be able to interrupt main player loop.
(I think in lua the process is mostly automatic, but hooks in general require careful use)
There was a problem hiding this comment.
Apparently in the C api you have to call mpv_hook_continue but this is done automatically in scripts. But I think "randomly" makes it sound like it will occasionally break unpredictably. If you don't continue mpv will freeze, it is not random.
There was a problem hiding this comment.
The message can be changed to:
Not following the protocol exactly can make the player freeze. Use with caution, avoid if synchronous event handling is not required.
There was a problem hiding this comment.
That's much better.
This paragraph was added 10 years ago in f8dc5db. Hooks are now commonly used both in internal (ytdl_hook, auto_profiles) and external scripts (e.g. https://github.com/mpv-player/mpv/issues?q=mp.add_hook). They are the only way to handle events synchronously and nobody is just going to change the API and break all scripts at this point, so remove the warning.
5 participants
This paragraph was added 10 years ago in f8dc5db. Hooks are now commonly used both in internal (ytdl_hook, auto_profiles) and external scripts (e.g. https://github.com/mpv-player/mpv/issues?q=mp.add_hook). They are the only way to handle events synchronously and nobody is just going to change the API and break all scripts at this point, so remove the warning.