osc.lua: add visibility_modes script opt

This allows users to choose what visibility modes they want to cycle through when calling the osc-visibilty cycle script binding.

Dudemanguy committed 1 year ago

Commit 8d665ac1 parent fd4aa9b3 files · +25 −6Browse files

Unified · Split

3 files

DOCS/interface-changes/osc-script-messages.txt +1 −0
DOCS/man/osc.rst +6 −0
player/lua/osc.lua +18 −6

DOCS/interface-changes/osc-script-messages.txt+1−0

@@ -2,3 +2,4 @@ deprecate `osc-message` script message in favor of `show-text` command · 1 unmodified line
2	deprecate `osc-chapterlist` script message in favor of `show-text ${chapter-list}`	2	deprecate `osc-chapterlist` script message in favor of `show-text ${chapter-list}`
3	deprecate `osc-playlist` script message in favor of `show-text ${playlist}`	3	deprecate `osc-playlist` script message in favor of `show-text ${playlist}`
4	deprecate `osc-tracklist` script message in favor of `show-text ${track-list}`	4	deprecate `osc-tracklist` script message in favor of `show-text ${track-list}`
		5	add `visibility_modes` script-opt to osc

DOCS/man/osc.rst+6−0

@@ -358,6 +358,12 @@ Configurable Options · 357 unmodified lines
358		358
359	Also supports ``never`` and ``always``	359	Also supports ``never`` and ``always``
360		360
		361	``visibility_modes``
		362	Default: never_auto_always
		363
		364	The list of visibility modes to cycle through when calling the
		365	osc-visibility cycle script message. Modes are separated by ``_``.
		366
361	``boxmaxchars``	367	``boxmaxchars``
362	Default: 80	368	Default: 80
363		369

player/lua/osc.lua+18−6

     timems = false,             -- display timecodes with milliseconds?
     tcspace = 100,              -- timecode spacing (compensate font size estimation)
     visibility = "auto",        -- only used at init to set visibility_mode(...)
+    visibility_modes = "never_auto_always", -- visibility modes to cycle through
     boxmaxchars = 80,           -- title crop threshold for box layout
     boxvideo = false,           -- apply osc_param.video_margins to video
     windowcontrols = "auto",    -- whether to show window controls
     maximized = false,
     osd = mp.create_osd_overlay("ass-events"),
     chapter_list = {},                      -- sorted by time
+    visibility_modes = {},                  -- visibility_modes to cycle through
     osc_message_warned = false,             -- deprecation warnings
     osc_chapterlist_warned = false,
     osc_playlist_warned = false,
 -- the modes only affect internal variables and not stored on its own.
 local function visibility_mode(mode, no_osd)
     if mode == "cycle" then
-        if not state.enabled then
+        for i, allowed_mode in ipairs(state.visibility_modes) do
-            mode = "auto"
+            if i == #state.visibility_modes then
-        elseif user_opts.visibility ~= "always" then
+                mode = state.visibility_modes[1]
-            mode = "always"
+                break
-        else
+            elseif user_opts.visibility == allowed_mode then
-            mode = "never"
+                mode = state.visibility_modes[i + 1]
+                break
+            end
         end
     end
             msg.warn("'" .. color .. "' is not a valid color")
         end
     end
+    for str in string.gmatch(user_opts.visibility_modes, "([^_]+)") do
+        if str ~= "auto" and str ~= "always" and str ~= "never" then
+            msg.warn("Ignoring unknown visibility mode '" .. str .."' in list")
+        else
+            table.insert(state.visibility_modes, str)
+        end
+    end
 end
 -- read options from config and command-line

osc.lua: add visibility_modes script opt

Keyboard shortcuts

General

Issues and pull requests

Issues, pull requests and Inbox

Repository code