Implement OSC toggle as an alternative to cycle

[ericpruitt]

Expected behavior of the wanted feature

The OSC message "osc-visibility" allows the user to cycle between "never", "always" and "auto." I don't find this behavior ideal because I always want to toggle between on/off which means always/never or always/auto, and that's how the other media players I've used work. I wrote the following script that I use in my mpv configuration:

-- Toggles the on screen controller between being always on and either
-- automatic mode or completely hidden depending on what the initial visibility
-- value was. If this is used in conjunction with "osc-visibility cycle", the
-- uncorrelated state used by the two messages may result in neither behaving
-- as expected.
mp.register_script_message("osc-toggle",
    (function ()
        local cursor
        local states

        local osc_conf = {
            visibility = "auto"
        }

        (require "mp.options").read_options(osc_conf, "osc")

        if osc_conf.visibility == "auto" then
            states = {"always", "auto"}
        else
            states = {"always", "never"}
        end

        cursor = states[2] == osc_conf.visibility and 2 or 1

        return function ()
            cursor = cursor == 1 and 2 or 1
            mp.commandv(
                "script-message", "osc-visibility", states[cursor], "no-osd"
            )
        end
    end)()
)

I'm willing to update osc.lua to integrate this logic into the upstream codebase, but I wanted to see if the PR would be welcomed before potentially wasting time on it.

Alternative behavior of the wanted feature

No response

Log File

No response

Sample Files

No response

[Dudemanguy]

Actually you can already do this e.g. in input.conf:

DEL cycle-values input-commands "change-list script-opts append osc-visibility=always" "change-list script-opts append osc-visibility=never"