Should I add pip.lua in extras? (Picture-in-Picture script)

[Samillion]

A PiP mode is very useful when multi-tasking, especially for single monitors.

In the past I used to add this auto-profile in my mpv.conf to enhance the pin button function with a PiP mode:

[Window-PiP]
    profile-desc=On window pin resize and move window bottom right
    profile-cond=ontop == true and not fullscreen
    profile-restore=copy-equal
    autofit=40%x30%
    autofit-larger=40%x30%
    geometry=100%:100%
    script-opts-append=modernz-persistentprogress=yes

However, it wasn't consistent with geometry in constant on/off triggers. Sometimes window position would change incorrectly or erratically.

So I decided to create pip.lua

In essence: On pin (ontop = true), it resizes and moves the window to the bottom right, and restores it on unpin (ontop = false).

The default window changes and options within the script:

local options = {
    autofit = "40%x30%",
    autofit_larger = "40%x30%",
    geometry = "100%:100%",        -- bottom-right: -0-0 or 100%:100%
    geometry_restore = "50%:50%",  -- center: 50%:50%
    geometry_delay = 0.02          -- geo delay time to avoid race
}

It made the behavior much more stable, and now I can just use the auto-profile to adjust some options, for example:

[Window-PiP]
    profile-desc=On window pin: resize, move window, enable persistant bar
    profile-cond=ontop == true and not fullscreen
    profile-restore=copy-equal
    script-opts-append=modernz-persistentprogress=yes

Though I'm not sure if pip.lua should be included in extras or not. As it is now it functions exactly to my use-case, though I'm sure others have different scenarios.

I'll leave this discussion open for the long run, just to gather any information from you guys, if any.

[Keith94]

I like the concept of it. It makes the on top button actually useful and behave more like YouTube's.

I saw some issues when restoring the window back to its original state though, like the window disappearing out of the viewport.

[Samillion]

The corner thing is usually because of border=yes/no, isn't it?

That is absolutely correct. I forgot we change the border state in ModernZ with pin. Thank you.

Updated script. commits:

• Samillion/mpv-conf@ef1cba7
• Samillion/mpv-conf@c8ff3ea
• Samillion/mpv-conf@17aa0a3
• Samillion/mpv-conf@a05f1ad

Changes:

• Added geometry_restore in options, to control restored window position. Default is center with 50%:50%.
• Removed saving geometry state before initiating PiP
• Removed redundant code
• Added a 0.02 delay to geometry to avoid any possible racing
• Ensure no nil values are given when restoring mode

[Samillion]

Updated script: pip.lua
Commit: Samillion/mpv-conf@f6394a4

Changes:

• Add geometry_delay option to easily control delay time
• Add state pip to replace pip_active variable
• Add state geometry_timer to monitor active timers to avoid stacking
• Add set_geometry_delay() helper function to avoid repeated code and ensure no stacked timers are added

[Keith94]

The updated script works beautifully now. Definitely worthy of adding to \extras or even integrating into modernz.lua itself :)

I combine it with vidscale=no via an autoprofile to make the UI usable.

[Samillion]

Awesome! Geometry had a racing issue when combined with autofit, and it's not constant, it happens at random. I assume when all circumstances lead to a lag spike.

Now the script basically resizes window first and only when it does that, it changes position with geometry.

[Samillion]

Done! https://github.com/Samillion/ModernZ/tree/main/extras/pip-lite