Repository: christoph-heinrich/mpv-quality-menu
Branch: master
Commit: 7dc5631c014f
Files: 6
Total size: 170.0 KB
Directory structure:
gitextract_9oc7bwb2/
├── LICENSE.md
├── README.md
├── osc.patch
├── quality-menu-osc.lua
├── quality-menu.conf
└── quality-menu.lua
================================================
FILE CONTENTS
================================================
================================================
FILE: LICENSE.md
================================================
GNU GENERAL PUBLIC LICENSE
Version 2, June 1991
Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public
License is intended to guarantee your freedom to share and change free
software--to make sure the software is free for all its users. This
General Public License applies to most of the Free Software
Foundation's software and to any other program whose authors commit to
using it. (Some other Free Software Foundation software is covered by
the GNU Lesser General Public License instead.) You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
this service if you wish), that you receive source code or can get it
if you want it, that you can change the software or use pieces of it
in new free programs; and that you know you can do these things.
To protect your rights, we need to make restrictions that forbid
anyone to deny you these rights or to ask you to surrender the rights.
These restrictions translate to certain responsibilities for you if you
distribute copies of the software, or if you modify it.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must give the recipients all the rights that
you have. You must make sure that they, too, receive or can get the
source code. And you must show them these terms so they know their
rights.
We protect your rights with two steps: (1) copyright the software, and
(2) offer you this license which gives you legal permission to copy,
distribute and/or modify the software.
Also, for each author's protection and ours, we want to make certain
that everyone understands that there is no warranty for this free
software. If the software is modified by someone else and passed on, we
want its recipients to know that what they have is not the original, so
that any problems introduced by others will not reflect on the original
authors' reputations.
Finally, any free program is threatened constantly by software
patents. We wish to avoid the danger that redistributors of a free
program will individually obtain patent licenses, in effect making the
program proprietary. To prevent this, we have made it clear that any
patent must be licensed for everyone's free use or not licensed at all.
The precise terms and conditions for copying, distribution and
modification follow.
GNU GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License applies to any program or other work which contains
a notice placed by the copyright holder saying it may be distributed
under the terms of this General Public License. The "Program", below,
refers to any such program or work, and a "work based on the Program"
means either the Program or any derivative work under copyright law:
that is to say, a work containing the Program or a portion of it,
either verbatim or with modifications and/or translated into another
language. (Hereinafter, translation is included without limitation in
the term "modification".) Each licensee is addressed as "you".
Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope. The act of
running the Program is not restricted, and the output from the Program
is covered only if its contents constitute a work based on the
Program (independent of having been made by running the Program).
Whether that is true depends on what the Program does.
1. You may copy and distribute verbatim copies of the Program's
source code as you receive it, in any medium, provided that you
conspicuously and appropriately publish on each copy an appropriate
copyright notice and disclaimer of warranty; keep intact all the
notices that refer to this License and to the absence of any warranty;
and give any other recipients of the Program a copy of this License
along with the Program.
You may charge a fee for the physical act of transferring a copy, and
you may at your option offer warranty protection in exchange for a fee.
2. You may modify your copy or copies of the Program or any portion
of it, thus forming a work based on the Program, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:
a) You must cause the modified files to carry prominent notices
stating that you changed the files and the date of any change.
b) You must cause any work that you distribute or publish, that in
whole or in part contains or is derived from the Program or any
part thereof, to be licensed as a whole at no charge to all third
parties under the terms of this License.
c) If the modified program normally reads commands interactively
when run, you must cause it, when started running for such
interactive use in the most ordinary way, to print or display an
announcement including an appropriate copyright notice and a
notice that there is no warranty (or else, saying that you provide
a warranty) and that users may redistribute the program under
these conditions, and telling the user how to view a copy of this
License. (Exception: if the Program itself is interactive but
does not normally print such an announcement, your work based on
the Program is not required to print an announcement.)
These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Program,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works. But when you
distribute the same sections as part of a whole which is a work based
on the Program, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote it.
Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Program.
In addition, mere aggregation of another work not based on the Program
with the Program (or with a work based on the Program) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.
3. You may copy and distribute the Program (or a work based on it,
under Section 2) in object code or executable form under the terms of
Sections 1 and 2 above provided that you also do one of the following:
a) Accompany it with the complete corresponding machine-readable
source code, which must be distributed under the terms of Sections
1 and 2 above on a medium customarily used for software interchange; or,
b) Accompany it with a written offer, valid for at least three
years, to give any third party, for a charge no more than your
cost of physically performing source distribution, a complete
machine-readable copy of the corresponding source code, to be
distributed under the terms of Sections 1 and 2 above on a medium
customarily used for software interchange; or,
c) Accompany it with the information you received as to the offer
to distribute corresponding source code. (This alternative is
allowed only for noncommercial distribution and only if you
received the program in object code or executable form with such
an offer, in accord with Subsection b above.)
The source code for a work means the preferred form of the work for
making modifications to it. For an executable work, complete source
code means all the source code for all modules it contains, plus any
associated interface definition files, plus the scripts used to
control compilation and installation of the executable. However, as a
special exception, the source code distributed need not include
anything that is normally distributed (in either source or binary
form) with the major components (compiler, kernel, and so on) of the
operating system on which the executable runs, unless that component
itself accompanies the executable.
If distribution of executable or object code is made by offering
access to copy from a designated place, then offering equivalent
access to copy the source code from the same place counts as
distribution of the source code, even though third parties are not
compelled to copy the source along with the object code.
4. You may not copy, modify, sublicense, or distribute the Program
except as expressly provided under this License. Any attempt
otherwise to copy, modify, sublicense or distribute the Program is
void, and will automatically terminate your rights under this License.
However, parties who have received copies, or rights, from you under
this License will not have their licenses terminated so long as such
parties remain in full compliance.
5. You are not required to accept this License, since you have not
signed it. However, nothing else grants you permission to modify or
distribute the Program or its derivative works. These actions are
prohibited by law if you do not accept this License. Therefore, by
modifying or distributing the Program (or any work based on the
Program), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Program or works based on it.
6. Each time you redistribute the Program (or any work based on the
Program), the recipient automatically receives a license from the
original licensor to copy, distribute or modify the Program subject to
these terms and conditions. You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties to
this License.
7. If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Program at all. For example, if a patent
license would not permit royalty-free redistribution of the Program by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Program.
If any portion of this section is held invalid or unenforceable under
any particular circumstance, the balance of the section is intended to
apply and the section as a whole is intended to apply in other
circumstances.
It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system, which is
implemented by public license practices. Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.
This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.
8. If the distribution and/or use of the Program is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Program under this License
may add an explicit geographical distribution limitation excluding
those countries, so that distribution is permitted only in or among
countries not thus excluded. In such case, this License incorporates
the limitation as if written in the body of this License.
9. The Free Software Foundation may publish revised and/or new versions
of the General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the Program
specifies a version number of this License which applies to it and "any
later version", you have the option of following the terms and conditions
either of that version or of any later version published by the Free
Software Foundation. If the Program does not specify a version number of
this License, you may choose any version ever published by the Free Software
Foundation.
10. If you wish to incorporate parts of the Program into other free
programs whose distribution conditions are different, write to the author
to ask for permission. For software which is copyrighted by the Free
Software Foundation, write to the Free Software Foundation; we sometimes
make exceptions for this. Our decision will be guided by the two goals
of preserving the free status of all derivatives of our free software and
of promoting the sharing and reuse of software generally.
NO WARRANTY
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
REPAIR OR CORRECTION.
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
convey the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
Also add information on how to contact you by electronic and paper mail.
If the program is interactive, make it output a short notice like this
when it starts in an interactive mode:
Gnomovision version 69, Copyright (C) year name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, the commands you use may
be called something other than `show w' and `show c'; they could even be
mouse-clicks or menu items--whatever suits your program.
You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the program, if
necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
`Gnomovision' (which makes passes at compilers) written by James Hacker.
<signature of Ty Coon>, 1 April 1989
Ty Coon, President of Vice
This General Public License does not permit incorporating your program into
proprietary programs. If your program is a subroutine library, you may
consider it more useful to permit linking proprietary applications with the
library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License.
================================================
FILE: README.md
================================================
# quality-menu
A userscript for MPV that allows you to change the streamed video and audio quality (ytdl-format) on the fly.
Simply open the video or audio menu, select your prefered format and confirm your choice. The keybindings for opening the menus are configured in input.conf, and everthing else is configured in quality-menu.conf.
Note: Version 4.2.0 and later require mpv 0.39.0. Anyone on an older version of mpv can use version 4.1.2 instead.
## Features
- Currently playing format is marked and selected when opening the menu
- Remembers selected format for every url in the current session (e.g. going back to previous playlist item automatically selects the prefered format)
- Controllable entirely by mouse or keyboard (opening by mouse requires either the OSC extension, [uosc](https://github.com/tomasklaen/uosc) or an additional entry in [`input.conf`](https://mpv.io/manual/stable/#input-conf))
- All format related information from yt-dlp/youtube-dl can be shown
- Columns that are identical for all formats are automatically hidden
- Formats can be sorted based on resolution, fps, bitrate, etc.
- Simple reload functionality
- Columns and their order are configurable
- **(optional)** Graphical menu via [uosc](https://github.com/tomasklaen/uosc) integration
Note: Requires uosc 5.0.0 or newer.
## OSC extension
**(optional)** An extended version of the OSC is available that includes a button to display the quality menu.
**PLEASE NOTE:** This conflicts with other scripts that modify the OSC. Merging this OSC modification others is certainly possible. Depending on how the osc is modified, the [osc.patch](osc.patch) might apply cleanly, but you have to make sure the filename in the patch lines up with the filename of your files.
## Installation
1. Save the `quality-menu.lua` into your [scripts directory](https://mpv.io/manual/stable/#script-location)
2. Set key bindings in [`input.conf`](https://mpv.io/manual/stable/#input-conf)
```
F script-binding quality_menu/video_formats_toggle
Alt+f script-binding quality_menu/audio_formats_toggle
```
**(optional)** `Ctrl+r script-binding quality_menu/reload`
3. **(optional)** Save the `quality-menu.conf` into your `script-opts` directory (next to the [scripts directory](https://mpv.io/manual/stable/#script-location), create if it doesn't exist)
4. **(optional)** UI integration (pick one)
- For OSC: Save the `quality-menu-osc.lua` into your [scripts directory](https://mpv.io/manual/stable/#script-location) and put `osc=no` in your [mpv.conf](https://mpv.io/manual/stable/#location-and-syntax)
- For [uosc](https://github.com/tomasklaen/uosc) (each is optional)
1. Add the video and audio menu to the uosc menu by appending `#! ...` to your key bindings in [`input.conf`](https://mpv.io/manual/stable/#input-conf)
```
F script-binding quality_menu/video_formats_toggle #! Stream Quality > Video
Alt+f script-binding quality_menu/audio_formats_toggle #! Stream Quality > Audio
```
2. quality-menu already overwrites the builtin uosc command `stream-quality`, so it already works well out of the box.
For even deeper UI integration you can add buttons to the `contols=` option in your [`uosc.conf`](https://github.com/tomasklaen/uosc/blob/main/script-opts/uosc.conf)
1. `<!has_many_video,video,stream>command:theaters:script-binding quality_menu/video_formats_toggle#@vformats>1?Video`
2. `<!has_many_audio,has_audio,stream>command:graphic_eq:script-binding quality_menu/audio_formats_toggle#@aformats>1?Audio`
## Plans For Future Enhancement
- [x] Visual indication of what the current quality level is
- [x] Option to populate the quality list automatically with the exact formats available for a given video
- [x] Optional OSC extension
- [x] [uosc](https://github.com/tomasklaen/uosc) integration
- [ ] *\[your suggestion here\]*
## Credit
- [reload.lua](https://github.com/4e6/mpv-reload/), for the function to reload a video while preserving the playlist.
- [mpv-playlistmanager](https://github.com/jonniek/mpv-playlistmanager), for the menu formatting config.
- ytdl_hook.lua, much of the code to fetch the format list with youtube-dl came from there.
- somebody on /mpv/ for the idea
================================================
FILE: osc.patch
================================================
diff --git a/../mpv/player/lua/osc.lua b/osc.lua
index 6132aa9..5c73229 100644
--- a/osc.lua
+++ b/osc.lua
@@ -1711,6 +1711,13 @@ local function bar_layout(direction, slim)
lo.geometry = geo
lo.style = osc_styles.smallButtonsBar
+ -- START quality-menu
+ geo = { x = geo.x - geo.w - padX, y = geo.y, an = geo.an, w = geo.w, h = geo.h }
+ lo = add_layout("quality-menu")
+ lo.geometry = geo
+ lo.style = osc_styles.smallButtonsBar
+ -- END quality-menu
+
-- Volume
geo = { x = geo.x - geo.w - padX, y = geo.y, an = geo.an, w = geo.w, h = geo.h }
lo = add_layout("volume")
@@ -2136,6 +2143,17 @@ local function osc_init()
string.format("%3.0fs", sec))
end
+ -- START quality-menu
+ ne = new_element("quality-menu", "button")
+ ne.content = function()
+ return ("≚")
+ end
+ ne.eventresponder["mbtn_left_up"] =
+ function () mp.commandv("script-message", "video_formats_toggle") end
+ ne.eventresponder["mbtn_right_up"] =
+ function () mp.commandv("script-message", "audio_formats_toggle") end
+ -- END quality-menu
+
-- volume
ne = new_element("volume", "button")
================================================
FILE: quality-menu-osc.lua
================================================
local assdraw = require 'mp.assdraw'
local msg = require 'mp.msg'
local opt = require 'mp.options'
--
-- Parameters
--
-- default user option values
-- do not touch, change them in osc.conf
local user_opts = {
showwindowed = true, -- show OSC when windowed?
showfullscreen = true, -- show OSC when fullscreen?
idlescreen = true, -- show mpv logo on idle
scalewindowed = 1, -- scaling of the controller when windowed
scalefullscreen = 1, -- scaling of the controller when fullscreen
vidscale = "auto", -- scale the controller with the video?
valign = 0.8, -- vertical alignment, -1 (top) to 1 (bottom)
halign = 0, -- horizontal alignment, -1 (left) to 1 (right)
barmargin = 0, -- vertical margin of top/bottombar
boxalpha = 80, -- alpha of the background box,
-- 0 (opaque) to 255 (fully transparent)
hidetimeout = 500, -- duration in ms until the OSC hides if no
-- mouse movement. enforced non-negative for the
-- user, but internally negative is "always-on".
fadeduration = 200, -- duration of fade out (and fade in, if enabled) in ms, 0 = no fade
fadein = false, -- whether to enable fade-in effect
deadzonesize = 0.5, -- size of deadzone
minmousemove = 0, -- minimum amount of pixels the mouse has to
-- move between ticks to make the OSC show up
layout = "bottombar",
seekbarstyle = "bar", -- bar, diamond or knob
seekbarhandlesize = 0.6, -- size ratio of the diamond and knob handle
seekrangestyle = "inverted",-- bar, line, slider, inverted or none
seekrangeseparate = true, -- whether the seekranges overlay on the bar-style seekbar
seekrangealpha = 200, -- transparency of seekranges
seekbarkeyframes = true, -- use keyframes when dragging the seekbar
scrollcontrols = true, -- allow scrolling when hovering certain OSC elements
title = "${!playlist-count==1:[${playlist-pos-1}/${playlist-count}] }${media-title}",
-- to be shown as OSC title
tooltipborder = 1, -- border of tooltip in bottom/topbar
timetotal = false, -- display total time instead of remaining time?
remaining_playtime = true, -- display the remaining time in playtime or video-time mode
-- playtime takes speed into account, whereas video-time doesn't
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
windowcontrols_alignment = "right", -- which side to show window controls on
windowcontrols_title = "${media-title}", -- same as title but for windowcontrols
greenandgrumpy = false, -- disable santa hat
livemarkers = true, -- update seekbar chapter markers on duration change
chapter_fmt = "Chapter: %s", -- chapter print format for seekbar-hover. "no" to disable
unicodeminus = false, -- whether to use the Unicode minus sign character
background_color = "#000000", -- background color of the osc
timecode_color = "#FFFFFF", -- color of the progress bar and time color
title_color = "#FFFFFF", -- color of the title
time_pos_color = "#FFFFFF", -- color of the timecode at hovered position
buttons_color = "#FFFFFF", -- color of big buttons, wc buttons, and bar small buttons
small_buttonsL_color = "#FFFFFF", -- color of left small buttons
small_buttonsR_color = "#FFFFFF", -- color of right small buttons
top_buttons_color = "#FFFFFF", -- color of top buttons
held_element_color = "#999999", -- color of an element while held down
time_pos_outline_color = "#000000", -- color of the border timecodes in slimbox and TimePosBar
tick_delay = 1 / 60, -- minimum interval between OSC redraws in seconds
tick_delay_follow_display_fps = false, -- use display fps as the minimum interval
-- luacheck: push ignore
-- luacheck: max line length
menu_mbtn_left_command = "script-binding select/menu; script-message-to osc osc-hide",
menu_mbtn_mid_command = "",
menu_mbtn_right_command = "",
playlist_prev_mbtn_left_command = "playlist-prev",
playlist_prev_mbtn_mid_command = "show-text ${playlist} 3000",
playlist_prev_mbtn_right_command = "script-binding select/select-playlist; script-message-to osc osc-hide",
playlist_next_mbtn_left_command = "playlist-next",
playlist_next_mbtn_mid_command = "show-text ${playlist} 3000",
playlist_next_mbtn_right_command = "script-binding select/select-playlist; script-message-to osc osc-hide",
title_mbtn_left_command = "script-binding stats/display-page-5",
title_mbtn_mid_command = "show-text ${path}",
title_mbtn_right_command = "script-binding select/select-watch-history; script-message-to osc osc-hide",
play_pause_mbtn_left_command = "cycle pause",
play_pause_mbtn_mid_command = "cycle-values loop-playlist inf no",
play_pause_mbtn_right_command = "cycle-values loop-file inf no",
chapter_prev_mbtn_left_command = "osd-msg add chapter -1",
chapter_prev_mbtn_mid_command = "show-text ${chapter-list} 3000",
chapter_prev_mbtn_right_command = "script-binding select/select-chapter; script-message-to osc osc-hide",
chapter_next_mbtn_left_command = "osd-msg add chapter 1",
chapter_next_mbtn_mid_command = "show-text ${chapter-list} 3000",
chapter_next_mbtn_right_command = "script-binding select/select-chapter; script-message-to osc osc-hide",
audio_track_mbtn_left_command = "cycle audio",
audio_track_mbtn_mid_command = "cycle audio down",
audio_track_mbtn_right_command = "script-binding select/select-aid; script-message-to osc osc-hide",
audio_track_wheel_down_command = "cycle audio",
audio_track_wheel_up_command = "cycle audio down",
sub_track_mbtn_left_command = "cycle sub",
sub_track_mbtn_mid_command = "cycle sub down",
sub_track_mbtn_right_command = "script-binding select/select-sid; script-message-to osc osc-hide",
sub_track_wheel_down_command = "cycle sub",
sub_track_wheel_up_command = "cycle sub down",
volume_mbtn_left_command = "no-osd cycle mute",
volume_mbtn_mid_command = "",
volume_mbtn_right_command = "script-binding select/select-audio-device; script-message-to osc osc-hide",
volume_wheel_down_command = "add volume -5",
volume_wheel_up_command = "add volume 5",
fullscreen_mbtn_left_command = "cycle fullscreen",
fullscreen_mbtn_mid_command = "",
fullscreen_mbtn_right_command = "cycle window-maximized",
-- luacheck: pop
}
for i = 1, 99 do
user_opts["custom_button_" .. i .. "_content"] = ""
user_opts["custom_button_" .. i .. "_mbtn_left_command"] = ""
user_opts["custom_button_" .. i .. "_mbtn_mid_command"] = ""
user_opts["custom_button_" .. i .. "_mbtn_right_command"] = ""
user_opts["custom_button_" .. i .. "_wheel_down_command"] = ""
user_opts["custom_button_" .. i .. "_wheel_up_command"] = ""
end
local icon_font = "mpv-osd-symbols"
-- Running this in Lua 5.3+ or LuaJIT converts a hexadecimal Unicode code point
-- to the decimal value of every byte for Lua 5.1 and 5.2 compatibility:
-- glyph='\u{e000}' output=''
-- for i = 1, #glyph do output = output .. '\\' .. string.byte(glyph, i) end
-- print(output)
local icons = {
menu = "\238\132\130", -- E102
prev = "\238\132\144", -- E110
next = "\238\132\129", -- E101
pause = "\238\128\130", -- E002
play = "\238\132\129", -- E101
play_backward = "\238\132\144", -- E110
skip_backward = "\238\128\132", -- E004
skip_forward = "\238\128\133", -- E005
chapter_prev = "\238\132\132", -- E104
chapter_next = "\238\132\133", -- E105
audio = "\238\132\134", -- E106
subtitle = "\238\132\135", -- E107
mute = "\238\132\138", -- E10A
volume = {"\238\132\139", "\238\132\140", "\238\132\141", "\238\132\142"},-- E10B E10C E10D E10E
fullscreen = "\238\132\136", -- E108
exit_fullscreen = "\238\132\137",-- E109
close = "\238\132\149", -- E115
minimize = "\238\132\146", -- E112
maximize = "\238\132\147", -- E113
unmaximize = "\238\132\148", -- E114
}
local osc_param = { -- calculated by osc_init()
playresy = 0, -- canvas size Y
playresx = 0, -- canvas size X
display_aspect = 1,
unscaled_y = 0,
areas = {},
video_margins = {
l = 0, r = 0, t = 0, b = 0, -- left/right/top/bottom
},
}
local margins_opts = {
{"l", "video-margin-ratio-left"},
{"r", "video-margin-ratio-right"},
{"t", "video-margin-ratio-top"},
{"b", "video-margin-ratio-bottom"},
}
local tick_delay = 1 / 60
local audio_track_count = 0
local sub_track_count = 0
local window_control_box_width = 80
local layouts = {}
local is_december = os.date("*t").month == 12
local UNICODE_MINUS = string.char(0xe2, 0x88, 0x92) -- UTF-8 for U+2212 MINUS SIGN
local last_custom_button = 0
local function osc_color_convert(color)
return color:sub(6,7) .. color:sub(4,5) .. color:sub(2,3)
end
-- luacheck: push ignore
-- luacheck: max line length
local osc_styles
local function set_osc_styles()
osc_styles = {
bigButtons = "{\\blur0\\bord0\\1c&H" .. osc_color_convert(user_opts.buttons_color) .. "\\3c&HFFFFFF\\fs50\\fn" .. icon_font .. "}",
smallButtonsL = "{\\blur0\\bord0\\1c&H" .. osc_color_convert(user_opts.small_buttonsL_color) .. "\\3c&HFFFFFF\\fs19\\fn" .. icon_font .. "}",
smallButtonsLlabel = "{\\fscx105\\fscy105\\fn" .. mp.get_property("options/osd-font") .. "}",
smallButtonsR = "{\\blur0\\bord0\\1c&H" .. osc_color_convert(user_opts.small_buttonsR_color) .. "\\3c&HFFFFFF\\fs30\\fn" .. icon_font .. "}",
topButtons = "{\\blur0\\bord0\\1c&H" .. osc_color_convert(user_opts.top_buttons_color) .. "\\3c&HFFFFFF\\fs12\\fn" .. icon_font .. "}",
elementDown = "{\\1c&H" .. osc_color_convert(user_opts.held_element_color) .."}",
timecodes = "{\\blur0\\bord0\\1c&H" .. osc_color_convert(user_opts.timecode_color) .. "\\3c&HFFFFFF\\fs20}",
vidtitle = "{\\blur0\\bord0\\1c&H" .. osc_color_convert(user_opts.title_color) .. "\\3c&HFFFFFF\\fs14\\q2}",
box = "{\\rDefault\\blur0\\bord1\\1c&H" .. osc_color_convert(user_opts.background_color) .. "\\3c&HFFFFFF}",
topButtonsBar = "{\\blur0\\bord0\\1c&H" .. osc_color_convert(user_opts.top_buttons_color) .. "\\3c&HFFFFFF\\fs18\\fn" .. icon_font .. "}",
smallButtonsBar = "{\\blur0\\bord0\\1c&H" .. osc_color_convert(user_opts.buttons_color) .. "\\3c&HFFFFFF\\fs28\\fn" .. icon_font .. "}",
timecodesBar = "{\\blur0\\bord0\\1c&H" .. osc_color_convert(user_opts.timecode_color) .."\\3c&HFFFFFF\\fs27}",
timePosBar = "{\\blur0\\bord".. user_opts.tooltipborder .."\\1c&H" .. osc_color_convert(user_opts.time_pos_color) .. "\\3c&H" .. osc_color_convert(user_opts.time_pos_outline_color) .. "\\fs30}",
vidtitleBar = "{\\blur0\\bord0\\1c&H" .. osc_color_convert(user_opts.title_color) .. "\\3c&HFFFFFF\\fs18\\q2}",
wcButtons = "{\\1c&H" .. osc_color_convert(user_opts.buttons_color) .. "\\fs24\\fn" .. icon_font .. "}",
wcTitle = "{\\1c&H" .. osc_color_convert(user_opts.title_color) .. "\\fs24\\q2}",
wcBar = "{\\1c&H" .. osc_color_convert(user_opts.background_color) .. "}",
}
end
-- internal states, do not touch
local state = {
showtime = nil, -- time of last invocation (last mouse move)
touchtime = nil, -- time of last invocation (last touch event)
osc_visible = false,
anistart = nil, -- time when the animation started
anitype = nil, -- current type of animation
animation = nil, -- current animation alpha
mouse_down_counter = 0, -- used for softrepeat
active_element = nil, -- nil = none, 0 = background, 1+ = see elements[]
active_event_source = nil, -- the "button" that issued the current event
rightTC_trem = not user_opts.timetotal, -- if the right timecode should display total or remaining time
tc_ms = user_opts.timems, -- Should the timecodes display their time with milliseconds
screen_sizeX = nil, screen_sizeY = nil, -- last screen-resolution, to detect resolution changes to issue reINITs
initREQ = false, -- is a re-init request pending?
marginsREQ = false, -- is a margins update pending?
last_mouseX = nil, last_mouseY = nil, -- last mouse position, to detect significant mouse movement
mouse_in_window = false,
fullscreen = false,
tick_timer = nil,
tick_last_time = 0, -- when the last tick() was run
hide_timer = nil,
cache_state = nil,
idle = false,
enabled = true,
input_enabled = true,
showhide_enabled = false,
windowcontrols_buttons = false,
windowcontrols_title = false,
dmx_cache = 0,
using_video_margins = false,
border = true,
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,
osc_tracklist_warned = false,
}
local logo_lines = {
-- White border
"{\\c&HE5E5E5&\\p6}m 895 10 b 401 10 0 410 0 905 0 1399 401 1800 895 1800 1390 1800 1790 1399 1790 905 1790 410 1390 10 895 10 {\\p0}",
-- Purple fill
"{\\c&H682167&\\p6}m 925 42 b 463 42 87 418 87 880 87 1343 463 1718 925 1718 1388 1718 1763 1343 1763 880 1763 418 1388 42 925 42{\\p0}",
-- Darker fill
"{\\c&H430142&\\p6}m 1605 828 b 1605 1175 1324 1456 977 1456 631 1456 349 1175 349 828 349 482 631 200 977 200 1324 200 1605 482 1605 828{\\p0}",
-- White fill
"{\\c&HDDDBDD&\\p6}m 1296 910 b 1296 1131 1117 1310 897 1310 676 1310 497 1131 497 910 497 689 676 511 897 511 1117 511 1296 689 1296 910{\\p0}",
-- Triangle
"{\\c&H691F69&\\p6}m 762 1113 l 762 708 b 881 776 1000 843 1119 911 1000 978 881 1046 762 1113{\\p0}",
}
local santa_hat_lines = {
-- Pompoms
"{\\c&HC0C0C0&\\p6}m 500 -323 b 491 -322 481 -318 475 -311 465 -312 456 -319 446 -318 434 -314 427 -304 417 -297 410 -290 404 -282 395 -278 390 -274 387 -267 381 -265 377 -261 379 -254 384 -253 397 -244 409 -232 425 -228 437 -228 446 -218 457 -217 462 -216 466 -213 468 -209 471 -205 477 -203 482 -206 491 -211 499 -217 508 -222 532 -235 556 -249 576 -267 584 -272 584 -284 578 -290 569 -305 550 -312 533 -309 523 -310 515 -316 507 -321 505 -323 503 -323 500 -323{\\p0}",
"{\\c&HE0E0E0&\\p6}m 315 -260 b 286 -258 259 -240 246 -215 235 -210 222 -215 211 -211 204 -188 177 -176 172 -151 170 -139 163 -128 154 -121 143 -103 141 -81 143 -60 139 -46 125 -34 129 -17 132 -1 134 16 142 30 145 56 161 80 181 96 196 114 210 133 231 144 266 153 303 138 328 115 373 79 401 28 423 -24 446 -73 465 -123 483 -174 487 -199 467 -225 442 -227 421 -232 402 -242 384 -254 364 -259 342 -250 322 -260 320 -260 317 -261 315 -260{\\p0}",
-- Main cap
"{\\c&H0000F0&\\p6}m 1151 -523 b 1016 -516 891 -458 769 -406 693 -369 624 -319 561 -262 526 -252 465 -235 479 -187 502 -147 551 -135 588 -111 1115 165 1379 232 1909 761 1926 800 1952 834 1987 858 2020 883 2053 912 2065 952 2088 1000 2146 962 2139 919 2162 836 2156 747 2143 662 2131 615 2116 567 2122 517 2120 410 2090 306 2089 199 2092 147 2071 99 2034 64 1987 5 1928 -41 1869 -86 1777 -157 1712 -256 1629 -337 1578 -389 1521 -436 1461 -476 1407 -509 1343 -507 1284 -515 1240 -519 1195 -521 1151 -523{\\p0}",
-- Cap shadow
"{\\c&H0000AA&\\p6}m 1657 248 b 1658 254 1659 261 1660 267 1669 276 1680 284 1689 293 1695 302 1700 311 1707 320 1716 325 1726 330 1735 335 1744 347 1752 360 1761 371 1753 352 1754 331 1753 311 1751 237 1751 163 1751 90 1752 64 1752 37 1767 14 1778 -3 1785 -24 1786 -45 1786 -60 1786 -77 1774 -87 1760 -96 1750 -78 1751 -65 1748 -37 1750 -8 1750 20 1734 78 1715 134 1699 192 1694 211 1689 231 1676 246 1671 251 1661 255 1657 248 m 1909 541 b 1914 542 1922 549 1917 539 1919 520 1921 502 1919 483 1918 458 1917 433 1915 407 1930 373 1942 338 1947 301 1952 270 1954 238 1951 207 1946 214 1947 229 1945 239 1939 278 1936 318 1924 356 1923 362 1913 382 1912 364 1906 301 1904 237 1891 175 1887 150 1892 126 1892 101 1892 68 1893 35 1888 2 1884 -9 1871 -20 1859 -14 1851 -6 1854 9 1854 20 1855 58 1864 95 1873 132 1883 179 1894 225 1899 273 1908 362 1910 451 1909 541{\\p0}",
-- Brim and tip pompom
"{\\c&HF8F8F8&\\p6}m 626 -191 b 565 -155 486 -196 428 -151 387 -115 327 -101 304 -47 273 2 267 59 249 113 219 157 217 213 215 265 217 309 260 302 285 283 373 264 465 264 555 257 608 252 655 292 709 287 759 294 816 276 863 298 903 340 972 324 1012 367 1061 394 1125 382 1167 424 1213 462 1268 482 1322 506 1385 546 1427 610 1479 662 1510 690 1534 725 1566 752 1611 796 1664 830 1703 880 1740 918 1747 986 1805 1005 1863 991 1897 932 1916 880 1914 823 1945 777 1961 725 1979 673 1957 622 1938 575 1912 534 1862 515 1836 473 1790 417 1755 351 1697 305 1658 266 1633 216 1593 176 1574 138 1539 116 1497 110 1448 101 1402 77 1371 37 1346 -16 1295 15 1254 6 1211 -27 1170 -62 1121 -86 1072 -104 1027 -128 976 -133 914 -130 851 -137 794 -162 740 -181 679 -168 626 -191 m 2051 917 b 1971 932 1929 1017 1919 1091 1912 1149 1923 1214 1970 1254 2000 1279 2027 1314 2066 1325 2139 1338 2212 1295 2254 1238 2281 1203 2287 1158 2282 1116 2292 1061 2273 1006 2229 970 2206 941 2167 938 2138 918{\\p0}",
}
-- luacheck: pop
--
-- Helper functions
--
local function kill_animation()
state.anistart = nil
state.animation = nil
state.anitype = nil
end
local function set_osd(res_x, res_y, text, z)
if state.osd.res_x == res_x and
state.osd.res_y == res_y and
state.osd.data == text then
return
end
state.osd.res_x = res_x
state.osd.res_y = res_y
state.osd.data = text
state.osd.z = z
state.osd:update()
end
local function set_time_styles(timetotal_changed, timems_changed)
if timetotal_changed then
state.rightTC_trem = not user_opts.timetotal
end
if timems_changed then
state.tc_ms = user_opts.timems
end
end
-- scale factor for translating between real and virtual ASS coordinates
local function get_virt_scale_factor()
local w, h = mp.get_osd_size()
if w <= 0 or h <= 0 then
return 0, 0
end
return osc_param.playresx / w, osc_param.playresy / h
end
-- return mouse position in virtual ASS coordinates (playresx/y)
local function get_virt_mouse_pos()
if state.mouse_in_window then
local sx, sy = get_virt_scale_factor()
local x, y = mp.get_mouse_pos()
return x * sx, y * sy
else
return -1, -1
end
end
local function set_virt_mouse_area(x0, y0, x1, y1, name)
local sx, sy = get_virt_scale_factor()
mp.set_mouse_area(x0 / sx, y0 / sy, x1 / sx, y1 / sy, name)
end
local function scale_value(x0, x1, y0, y1, val)
local m = (y1 - y0) / (x1 - x0)
local b = y0 - (m * x0)
return (m * val) + b
end
-- returns hitbox spanning coordinates (top left, bottom right corner)
-- according to alignment
local function get_hitbox_coords(x, y, an, w, h)
local alignments = {
[1] = function () return x, y-h, x+w, y end,
[2] = function () return x-(w/2), y-h, x+(w/2), y end,
[3] = function () return x-w, y-h, x, y end,
[4] = function () return x, y-(h/2), x+w, y+(h/2) end,
[5] = function () return x-(w/2), y-(h/2), x+(w/2), y+(h/2) end,
[6] = function () return x-w, y-(h/2), x, y+(h/2) end,
[7] = function () return x, y, x+w, y+h end,
[8] = function () return x-(w/2), y, x+(w/2), y+h end,
[9] = function () return x-w, y, x, y+h end,
}
return alignments[an]()
end
local function get_hitbox_coords_geo(geometry)
return get_hitbox_coords(geometry.x, geometry.y, geometry.an,
geometry.w, geometry.h)
end
local function get_element_hitbox(element)
return element.hitbox.x1, element.hitbox.y1,
element.hitbox.x2, element.hitbox.y2
end
local function mouse_hit_coords(bX1, bY1, bX2, bY2)
local mX, mY = get_virt_mouse_pos()
return (mX >= bX1 and mX <= bX2 and mY >= bY1 and mY <= bY2)
end
local function mouse_hit(element)
return mouse_hit_coords(get_element_hitbox(element))
end
local function limit_range(min, max, val)
if val > max then
val = max
elseif val < min then
val = min
end
return val
end
-- translate value into element coordinates
local function get_slider_ele_pos_for(element, val)
local ele_pos = scale_value(
element.slider.min.value, element.slider.max.value,
element.slider.min.ele_pos, element.slider.max.ele_pos,
val)
return limit_range(
element.slider.min.ele_pos, element.slider.max.ele_pos,
ele_pos)
end
-- translates global (mouse) coordinates to value
local function get_slider_value_at(element, glob_pos)
local val = scale_value(
element.slider.min.glob_pos, element.slider.max.glob_pos,
element.slider.min.value, element.slider.max.value,
glob_pos)
return limit_range(
element.slider.min.value, element.slider.max.value,
val)
end
-- get value at current mouse position
local function get_slider_value(element)
return get_slider_value_at(element, get_virt_mouse_pos())
end
-- align: -1 .. +1
-- frame: size of the containing area
-- obj: size of the object that should be positioned inside the area
-- margin: min. distance from object to frame (as long as -1 <= align <= +1)
local function get_align(align, frame, obj, margin)
return (frame / 2) + (((frame / 2) - margin - (obj / 2)) * align)
end
-- multiplies two alpha values, formular can probably be improved
local function mult_alpha(alphaA, alphaB)
return 255 - (((1-(alphaA/255)) * (1-(alphaB/255))) * 255)
end
local function add_area(name, x1, y1, x2, y2)
-- create area if needed
if osc_param.areas[name] == nil then
osc_param.areas[name] = {}
end
table.insert(osc_param.areas[name], {x1=x1, y1=y1, x2=x2, y2=y2})
end
local function ass_append_alpha(ass, alpha, modifier)
local ar = {}
for ai, av in pairs(alpha) do
av = mult_alpha(av, modifier)
if state.animation then
av = mult_alpha(av, state.animation)
end
ar[ai] = av
end
ass:append(string.format("{\\1a&H%X&\\2a&H%X&\\3a&H%X&\\4a&H%X&}",
ar[1], ar[2], ar[3], ar[4]))
end
local function ass_draw_rr_h_cw(ass, x0, y0, x1, y1, r1, hexagon, r2)
if hexagon then
ass:hexagon_cw(x0, y0, x1, y1, r1, r2)
else
ass:round_rect_cw(x0, y0, x1, y1, r1, r2)
end
end
local function ass_draw_rr_h_ccw(ass, x0, y0, x1, y1, r1, hexagon, r2)
if hexagon then
ass:hexagon_ccw(x0, y0, x1, y1, r1, r2)
else
ass:round_rect_ccw(x0, y0, x1, y1, r1, r2)
end
end
local function get_hidetimeout()
if user_opts.visibility == "always" then
return -1 -- disable autohide
end
return user_opts.hidetimeout
end
local function get_touchtimeout()
if state.touchtime == nil then
return 0
end
return state.touchtime + (get_hidetimeout() / 1000) - mp.get_time()
end
local function cache_enabled()
return state.cache_state and #state.cache_state["seekable-ranges"] > 0
end
local function reset_margins()
if state.using_video_margins then
for _, mopt in ipairs(margins_opts) do
mp.set_property_number(mopt[2], 0.0)
end
state.using_video_margins = false
end
end
local function update_margins()
local margins = osc_param.video_margins
-- Don't use margins if it's visible only temporarily.
if not state.osc_visible or get_hidetimeout() >= 0 or
(state.fullscreen and not user_opts.showfullscreen) or
(not state.fullscreen and not user_opts.showwindowed)
then
margins = {l = 0, r = 0, t = 0, b = 0}
end
if user_opts.boxvideo then
-- check whether any margin option has a non-default value
local margins_used = false
if not state.using_video_margins then
for _, mopt in ipairs(margins_opts) do
if mp.get_property_number(mopt[2], 0.0) ~= 0.0 then
margins_used = true
end
end
end
if not margins_used then
for _, mopt in ipairs(margins_opts) do
local v = margins[mopt[1]]
if v ~= 0 or state.using_video_margins then
mp.set_property_number(mopt[2], v)
state.using_video_margins = true
end
end
end
else
reset_margins()
end
mp.set_property_native("user-data/osc/margins", margins)
end
local tick
-- Request that tick() is called (which typically re-renders the OSC).
-- The tick is then either executed immediately, or rate-limited if it was
-- called a small time ago.
local function request_tick()
if state.tick_timer == nil then
state.tick_timer = mp.add_timeout(0, tick)
end
if not state.tick_timer:is_enabled() then
local now = mp.get_time()
local timeout = tick_delay - (now - state.tick_last_time)
if timeout < 0 then
timeout = 0
end
state.tick_timer.timeout = timeout
state.tick_timer:resume()
end
end
local function request_init()
state.initREQ = true
request_tick()
end
-- Like request_init(), but also request an immediate update
local function request_init_resize()
request_init()
-- ensure immediate update
state.tick_timer:kill()
state.tick_timer.timeout = 0
state.tick_timer:resume()
end
local function render_wipe()
msg.trace("render_wipe()")
state.osd.data = "" -- allows set_osd to immediately update on enable
state.osd:remove()
end
--
-- Tracklist Management
--
-- updates the OSC internal playlists, should be run each time the track-layout changes
local function update_tracklist()
audio_track_count, sub_track_count = 0, 0
for _, track in pairs(mp.get_property_native("track-list")) do
if track.type == "audio" then
audio_track_count = audio_track_count + 1
elseif track.type == "sub" then
sub_track_count = sub_track_count + 1
end
end
end
-- WindowControl helpers
local function window_controls_enabled()
local val = user_opts.windowcontrols
if val == "auto" then
return not (state.border and state.title_bar)
else
return val ~= "no"
end
end
local function window_controls_alignment()
return user_opts.windowcontrols_alignment
end
--
-- Element Management
--
local elements = {}
local function prepare_elements()
-- remove elements without layout or invisible
local elements2 = {}
for _, element in pairs(elements) do
if element.layout ~= nil and element.visible then
table.insert(elements2, element)
end
end
elements = elements2
local function elem_compare (a, b)
return a.layout.layer < b.layout.layer
end
table.sort(elements, elem_compare)
for _,element in pairs(elements) do
local elem_geo = element.layout.geometry
-- Calculate the hitbox
local bX1, bY1, bX2, bY2 = get_hitbox_coords_geo(elem_geo)
element.hitbox = {x1 = bX1, y1 = bY1, x2 = bX2, y2 = bY2}
local style_ass = assdraw.ass_new()
-- prepare static elements
style_ass:append("{}") -- hack to troll new_event into inserting a \n
style_ass:new_event()
style_ass:pos(elem_geo.x, elem_geo.y)
style_ass:an(elem_geo.an)
style_ass:append(element.layout.style)
element.style_ass = style_ass
local static_ass = assdraw.ass_new()
if element.type == "box" then
--draw box
static_ass:draw_start()
ass_draw_rr_h_cw(static_ass, 0, 0, elem_geo.w, elem_geo.h,
element.layout.box.radius, element.layout.box.hexagon)
static_ass:draw_stop()
elseif element.type == "slider" then
--draw static slider parts
local r1 = 0
local r2 = 0
local slider_lo = element.layout.slider
-- offset between element outline and drag-area
local foV = slider_lo.border + slider_lo.gap
-- calculate positions of min and max points
if slider_lo.stype ~= "bar" then
r1 = elem_geo.h / 2
element.slider.min.ele_pos = elem_geo.h / 2
element.slider.max.ele_pos = elem_geo.w - (elem_geo.h / 2)
if slider_lo.stype == "diamond" then
r2 = (elem_geo.h - 2 * slider_lo.border) / 2
elseif slider_lo.stype == "knob" then
r2 = r1
end
else
element.slider.min.ele_pos =
slider_lo.border + slider_lo.gap
element.slider.max.ele_pos =
elem_geo.w - (slider_lo.border + slider_lo.gap)
end
element.slider.min.glob_pos =
element.hitbox.x1 + element.slider.min.ele_pos
element.slider.max.glob_pos =
element.hitbox.x1 + element.slider.max.ele_pos
-- -- --
static_ass:draw_start()
-- the box
ass_draw_rr_h_cw(static_ass, 0, 0, elem_geo.w, elem_geo.h, r1,
slider_lo.stype == "diamond")
-- the "hole"
ass_draw_rr_h_ccw(static_ass, slider_lo.border, slider_lo.border,
elem_geo.w - slider_lo.border, elem_geo.h - slider_lo.border,
r2, slider_lo.stype == "diamond")
-- marker nibbles
if element.slider.markerF ~= nil and slider_lo.gap > 0 then
local markers = element.slider.markerF()
for _,marker in pairs(markers) do
if marker > element.slider.min.value and
marker < element.slider.max.value then
local s = get_slider_ele_pos_for(element, marker)
if slider_lo.gap > 1 then -- draw triangles
local a = slider_lo.gap / 0.5 --0.866
--top
if slider_lo.nibbles_top then
static_ass:move_to(s - (a / 2), slider_lo.border)
static_ass:line_to(s + (a / 2), slider_lo.border)
static_ass:line_to(s, foV)
end
--bottom
if slider_lo.nibbles_bottom then
static_ass:move_to(s - (a / 2),
elem_geo.h - slider_lo.border)
static_ass:line_to(s,
elem_geo.h - foV)
static_ass:line_to(s + (a / 2),
elem_geo.h - slider_lo.border)
end
else -- draw 2x1px nibbles
--top
if slider_lo.nibbles_top then
static_ass:rect_cw(s - 1, slider_lo.border,
s + 1, slider_lo.border + slider_lo.gap);
end
--bottom
if slider_lo.nibbles_bottom then
static_ass:rect_cw(s - 1,
elem_geo.h -slider_lo.border -slider_lo.gap,
s + 1, elem_geo.h - slider_lo.border);
end
end
end
end
end
end
element.static_ass = static_ass
-- if the element is supposed to be disabled,
-- style it accordingly and kill the eventresponders
if not element.enabled then
element.layout.alpha[1] = 136
element.eventresponder = nil
end
end
end
--
-- Element Rendering
--
-- returns nil or a chapter element from the native property chapter-list
local function get_chapter(possec)
local cl = state.chapter_list -- sorted, get latest before possec, if any
for n=#cl,1,-1 do
if possec >= cl[n].time then
return cl[n]
end
end
end
local function render_elements(master_ass)
-- when the slider is dragged or hovered and we have a target chapter name
-- then we use it instead of the normal title. we calculate it before the
-- render iterations because the title may be rendered before the slider.
state.forced_title = nil
local se, ae = state.slider_element, elements[state.active_element]
if user_opts.chapter_fmt ~= "no" and se and (ae == se or (not ae and mouse_hit(se))) then
local dur = mp.get_property_number("duration", 0)
if dur > 0 then
local possec = get_slider_value(se) * dur / 100 -- of mouse pos
local ch = get_chapter(possec)
if ch and ch.title and ch.title ~= "" then
state.forced_title = string.format(user_opts.chapter_fmt, ch.title)
end
end
end
for n=1, #elements do
local element = elements[n]
local style_ass = assdraw.ass_new()
style_ass:merge(element.style_ass)
ass_append_alpha(style_ass, element.layout.alpha, 0)
if element.eventresponder and (state.active_element == n) then
-- run render event functions
if element.eventresponder.render ~= nil then
element.eventresponder.render(element)
end
if mouse_hit(element) then
-- mouse down styling
if element.styledown then
style_ass:append(osc_styles.elementDown)
end
if element.softrepeat and state.mouse_down_counter >= 15
and state.mouse_down_counter % 5 == 0 then
element.eventresponder[state.active_event_source.."_down"](element)
end
state.mouse_down_counter = state.mouse_down_counter + 1
end
end
local elem_ass = assdraw.ass_new()
elem_ass:merge(style_ass)
if element.type ~= "button" then
elem_ass:merge(element.static_ass)
end
if element.type == "slider" then
local slider_lo = element.layout.slider
local elem_geo = element.layout.geometry
local s_min = element.slider.min.value
local s_max = element.slider.max.value
-- draw pos marker
local foH, xp
local pos = element.slider.posF()
local foV = slider_lo.border + slider_lo.gap
local innerH = elem_geo.h - (2 * foV)
local seekRanges = element.slider.seekRangesF()
local seekRangeLineHeight = innerH / 5
if slider_lo.stype ~= "bar" then
foH = elem_geo.h / 2
else
foH = slider_lo.border + slider_lo.gap
end
if pos then
xp = get_slider_ele_pos_for(element, pos)
if slider_lo.stype ~= "bar" then
local r = (user_opts.seekbarhandlesize * innerH) / 2
ass_draw_rr_h_cw(elem_ass, xp - r, foH - r,
xp + r, foH + r,
r, slider_lo.stype == "diamond")
else
local h = 0
if seekRanges and user_opts.seekrangeseparate and
slider_lo.rtype ~= "inverted" then
h = seekRangeLineHeight
end
elem_ass:rect_cw(foH, foV, xp, elem_geo.h - foV - h)
if seekRanges and not user_opts.seekrangeseparate and
slider_lo.rtype ~= "inverted" then
-- Punch holes for the seekRanges to be drawn later
for _,range in pairs(seekRanges) do
if range["start"] < pos then
local pstart = get_slider_ele_pos_for(element, range["start"])
local pend = xp
if pos > range["end"] then
pend = get_slider_ele_pos_for(element, range["end"])
end
elem_ass:rect_ccw(pstart, elem_geo.h - foV - seekRangeLineHeight,
pend, elem_geo.h - foV)
end
end
end
end
if slider_lo.rtype == "slider" then
ass_draw_rr_h_cw(elem_ass, foH - innerH / 6, foH - innerH / 6,
xp, foH + innerH / 6,
innerH / 6, slider_lo.stype == "diamond", 0)
ass_draw_rr_h_cw(elem_ass, xp, foH - innerH / 15,
elem_geo.w - foH + innerH / 15, foH + innerH / 15,
0, slider_lo.stype == "diamond", innerH / 15)
for _,range in pairs(seekRanges or {}) do
local pstart = get_slider_ele_pos_for(element, range["start"])
local pend = get_slider_ele_pos_for(element, range["end"])
ass_draw_rr_h_ccw(elem_ass, pstart, foH - innerH / 21,
pend, foH + innerH / 21,
innerH / 21, slider_lo.stype == "diamond")
end
end
end
if seekRanges then
if slider_lo.rtype ~= "inverted" then
elem_ass:draw_stop()
elem_ass:merge(element.style_ass)
ass_append_alpha(elem_ass, element.layout.alpha, user_opts.seekrangealpha)
elem_ass:merge(element.static_ass)
end
for _,range in pairs(seekRanges) do
local pstart = get_slider_ele_pos_for(element, range["start"])
local pend = get_slider_ele_pos_for(element, range["end"])
if slider_lo.rtype == "slider" then
ass_draw_rr_h_cw(elem_ass, pstart, foH - innerH / 21,
pend, foH + innerH / 21,
innerH / 21, slider_lo.stype == "diamond")
elseif slider_lo.rtype == "line" then
if slider_lo.stype == "bar" then
elem_ass:rect_cw(pstart, elem_geo.h - foV - seekRangeLineHeight,
pend, elem_geo.h - foV)
else
ass_draw_rr_h_cw(elem_ass, pstart - innerH / 8, foH - innerH / 8,
pend + innerH / 8, foH + innerH / 8,
innerH / 8, slider_lo.stype == "diamond")
end
elseif slider_lo.rtype == "bar" then
if slider_lo.stype ~= "bar" then
ass_draw_rr_h_cw(elem_ass, pstart - innerH / 2, foV,
pend + innerH / 2, foV + innerH,
innerH / 2, slider_lo.stype == "diamond")
elseif range["end"] >= (pos or 0) then
elem_ass:rect_cw(pstart, foV, pend, elem_geo.h - foV)
else
elem_ass:rect_cw(pstart, elem_geo.h - foV - seekRangeLineHeight, pend,
elem_geo.h - foV)
end
elseif slider_lo.rtype == "inverted" then
if slider_lo.stype ~= "bar" then
ass_draw_rr_h_ccw(elem_ass, pstart, (elem_geo.h / 2) - 1, pend,
(elem_geo.h / 2) + 1,
1, slider_lo.stype == "diamond")
else
elem_ass:rect_ccw(pstart, (elem_geo.h / 2) - 1, pend,
(elem_geo.h / 2) + 1)
end
end
end
end
elem_ass:draw_stop()
-- add tooltip
if element.slider.tooltipF ~= nil then
if mouse_hit(element) then
local sliderpos = get_slider_value(element)
local tooltiplabel = element.slider.tooltipF(sliderpos)
local an = slider_lo.tooltip_an
local ty
if an == 2 then
ty = element.hitbox.y1 - slider_lo.border
else
ty = element.hitbox.y1 + elem_geo.h / 2
end
local tx = get_virt_mouse_pos()
if slider_lo.adjust_tooltip then
if an == 2 then
if sliderpos < (s_min + 3) then
an = an - 1
elseif sliderpos > (s_max - 3) then
an = an + 1
end
elseif sliderpos > (s_max+s_min) / 2 then
an = an + 1
tx = tx - 5
else
an = an - 1
tx = tx + 10
end
end
-- tooltip label
elem_ass:new_event()
elem_ass:pos(tx, ty)
elem_ass:an(an)
elem_ass:append(slider_lo.tooltip_style)
ass_append_alpha(elem_ass, slider_lo.alpha, 0)
elem_ass:append(tooltiplabel)
end
end
elseif element.type == "button" then
local buttontext
if type(element.content) == "function" then
buttontext = element.content() -- function objects
elseif element.content ~= nil then
buttontext = element.content -- text objects
end
local maxchars = element.layout.button.maxchars
if maxchars ~= nil and #buttontext > maxchars then
local max_ratio = 1.25 -- up to 25% more chars while shrinking
local limit = math.max(0, math.floor(maxchars * max_ratio) - 3)
if #buttontext > limit then
while (#buttontext > limit) do
buttontext = buttontext:gsub(".[\128-\191]*$", "")
end
buttontext = buttontext .. "..."
end
buttontext = string.format("{\\fscx%f}",
(maxchars/#buttontext)*100) .. buttontext
end
elem_ass:append(buttontext)
end
master_ass:merge(elem_ass)
end
end
--
-- Initialisation and Layout
--
local function new_element(name, type)
elements[name] = {}
elements[name].type = type
-- add default stuff
elements[name].eventresponder = {}
elements[name].visible = true
elements[name].enabled = true
elements[name].softrepeat = false
elements[name].styledown = (type == "button")
elements[name].state = {}
if type == "slider" then
elements[name].slider = {min = {value = 0}, max = {value = 100}}
end
return elements[name]
end
local function add_layout(name)
if elements[name] ~= nil then
-- new layout
elements[name].layout = {}
-- set layout defaults
elements[name].layout.layer = 50
elements[name].layout.alpha = {[1] = 0, [2] = 255, [3] = 255, [4] = 255}
if elements[name].type == "button" then
elements[name].layout.button = {
maxchars = nil,
}
elseif elements[name].type == "slider" then
-- slider defaults
elements[name].layout.slider = {
border = 1,
gap = 1,
nibbles_top = true,
nibbles_bottom = true,
stype = "slider",
adjust_tooltip = true,
tooltip_style = "",
tooltip_an = 2,
alpha = {[1] = 0, [2] = 255, [3] = 88, [4] = 255},
}
elseif elements[name].type == "box" then
elements[name].layout.box = {radius = 0, hexagon = false}
end
return elements[name].layout
else
msg.error("Can't add_layout to element '"..name.."', doesn't exist.")
end
end
-- Window Controls
local function window_controls(topbar)
local wc_geo = {
x = 0,
y = 30 + user_opts.barmargin,
an = 1,
w = osc_param.playresx,
h = 30,
}
local alignment = window_controls_alignment()
local controlbox_w = window_control_box_width
local titlebox_w = wc_geo.w - controlbox_w
-- Default alignment is "right"
local controlbox_left = wc_geo.w - controlbox_w
local titlebox_left = wc_geo.x
local titlebox_right = wc_geo.w - controlbox_w
if alignment == "left" then
controlbox_left = wc_geo.x
titlebox_left = wc_geo.x + controlbox_w
titlebox_right = wc_geo.w
end
add_area("window-controls",
get_hitbox_coords(controlbox_left, wc_geo.y, wc_geo.an,
controlbox_w, wc_geo.h))
local lo
-- Background Bar
new_element("wcbar", "box")
lo = add_layout("wcbar")
lo.geometry = wc_geo
lo.layer = 10
lo.style = osc_styles.wcBar
lo.alpha[1] = user_opts.boxalpha
local button_y = wc_geo.y - (wc_geo.h / 2)
local first_geo =
{x = controlbox_left + 5, y = button_y, an = 4, w = 25, h = 25}
local second_geo =
{x = controlbox_left + 30, y = button_y, an = 4, w = 25, h = 25}
local third_geo =
{x = controlbox_left + 55, y = button_y, an = 4, w = 25, h = 25}
-- Window control buttons use symbols in the custom mpv osd font
-- because the official unicode codepoints are sufficiently
-- exotic that a system might lack an installed font with them,
-- and libass will complain that they are not present in the
-- default font, even if another font with them is available.
-- Close: 🗙
local ne = new_element("close", "button")
ne.content = icons.close
ne.eventresponder["mbtn_left_up"] =
function () mp.commandv("quit") end
lo = add_layout("close")
lo.geometry = alignment == "left" and first_geo or third_geo
lo.style = osc_styles.wcButtons
-- Minimize: 🗕
ne = new_element("minimize", "button")
ne.content = icons.minimize
ne.eventresponder["mbtn_left_up"] =
function () mp.commandv("cycle", "window-minimized") end
lo = add_layout("minimize")
lo.geometry = alignment == "left" and second_geo or first_geo
lo.style = osc_styles.wcButtons
-- Maximize: 🗖 /🗗
ne = new_element("maximize", "button")
if state.maximized or state.fullscreen then
ne.content = icons.unmaximize
else
ne.content = icons.maximize
end
ne.eventresponder["mbtn_left_up"] =
function ()
if state.fullscreen then
mp.commandv("cycle", "fullscreen")
else
mp.commandv("cycle", "window-maximized")
end
end
lo = add_layout("maximize")
lo.geometry = alignment == "left" and third_geo or second_geo
lo.style = osc_styles.wcButtons
-- deadzone below window controls
local sh_area_y0, sh_area_y1
sh_area_y0 = user_opts.barmargin
sh_area_y1 = wc_geo.y + get_align(1 - (2 * user_opts.deadzonesize),
osc_param.playresy - wc_geo.y, 0, 0)
add_area("showhide_wc", wc_geo.x, sh_area_y0, wc_geo.w, sh_area_y1)
if topbar then
-- The title is already there as part of the top bar
return
else
-- Apply boxvideo margins to the control bar
osc_param.video_margins.t = wc_geo.h / osc_param.playresy
end
-- Window Title
ne = new_element("wctitle", "button")
ne.content = function ()
local title = mp.command_native({"expand-text", user_opts.windowcontrols_title})
title = title:gsub("\n", " ")
return title ~= "" and mp.command_native({"escape-ass", title}) or "mpv"
end
local left_pad = 5
local right_pad = 10
lo = add_layout("wctitle")
lo.geometry =
{ x = titlebox_left + left_pad, y = wc_geo.y - 3, an = 1,
w = titlebox_w, h = wc_geo.h }
lo.style = string.format("%s{\\clip(%f,%f,%f,%f)}",
osc_styles.wcTitle,
titlebox_left + left_pad, wc_geo.y - wc_geo.h,
titlebox_right - right_pad , wc_geo.y + wc_geo.h)
add_area("window-controls-title",
titlebox_left, 0, titlebox_right, wc_geo.h)
end
--
-- Layouts
--
-- Classic box layout
layouts["box"] = function ()
local osc_geo = {
w = 550, -- width
h = 138, -- height
r = 10, -- corner-radius
p = 15, -- padding
}
-- make sure the OSC actually fits into the video
if osc_param.playresx < (osc_geo.w + (2 * osc_geo.p)) then
osc_param.playresy = (osc_geo.w + (2 * osc_geo.p)) / osc_param.display_aspect
osc_param.playresx = osc_param.playresy * osc_param.display_aspect
end
-- position of the controller according to video aspect and valignment
local posX = math.floor(get_align(user_opts.halign, osc_param.playresx,
osc_geo.w, 0))
local posY = math.floor(get_align(user_opts.valign, osc_param.playresy,
osc_geo.h, 0))
-- position offset for contents aligned at the borders of the box
local pos_offsetX = (osc_geo.w - (2*osc_geo.p)) / 2
local pos_offsetY = (osc_geo.h - (2*osc_geo.p)) / 2
osc_param.areas = {} -- delete areas
-- area for active mouse input
add_area("input", get_hitbox_coords(posX, posY, 5, osc_geo.w, osc_geo.h))
-- area for show/hide
local sh_area_y0, sh_area_y1
if user_opts.valign > 0 then
-- deadzone above OSC
sh_area_y0 = get_align(-1 + (2*user_opts.deadzonesize),
posY - (osc_geo.h / 2), 0, 0)
sh_area_y1 = osc_param.playresy
else
-- deadzone below OSC
sh_area_y0 = 0
sh_area_y1 = (posY + (osc_geo.h / 2)) +
get_align(1 - (2*user_opts.deadzonesize),
osc_param.playresy - (posY + (osc_geo.h / 2)), 0, 0)
end
add_area("showhide", 0, sh_area_y0, osc_param.playresx, sh_area_y1)
-- fetch values
local osc_w, osc_h, osc_r = osc_geo.w, osc_geo.h, osc_geo.r
local lo
--
-- Background box
--
new_element("bgbox", "box")
lo = add_layout("bgbox")
lo.geometry = {x = posX, y = posY, an = 5, w = osc_w, h = osc_h}
lo.layer = 10
lo.style = osc_styles.box
lo.alpha[1] = user_opts.boxalpha
lo.alpha[3] = user_opts.boxalpha
lo.box.radius = osc_r
--
-- Title row
--
local titlerowY = posY - pos_offsetY - 10
lo = add_layout("title")
lo.geometry = {x = posX, y = titlerowY, an = 8, w = 496, h = 12}
lo.style = osc_styles.vidtitle
lo.button.maxchars = user_opts.boxmaxchars
lo = add_layout("playlist_prev")
lo.geometry =
{x = (posX - pos_offsetX), y = titlerowY, an = 7, w = 12, h = 12}
lo.style = osc_styles.topButtons
lo = add_layout("playlist_next")
lo.geometry =
{x = (posX + pos_offsetX), y = titlerowY, an = 9, w = 12, h = 12}
lo.style = osc_styles.topButtons
--
-- Big buttons
--
local bigbtnrowY = posY - pos_offsetY + 35
local bigbtndist = 60
lo = add_layout("play_pause")
lo.geometry =
{x = posX, y = bigbtnrowY, an = 5, w = 40, h = 40}
lo.style = osc_styles.bigButtons
lo = add_layout("skip_backward")
lo.geometry =
{x = posX - bigbtndist, y = bigbtnrowY, an = 5, w = 40, h = 40}
lo.style = osc_styles.bigButtons
lo = add_layout("skip_forward")
lo.geometry =
{x = posX + bigbtndist, y = bigbtnrowY, an = 5, w = 40, h = 40}
lo.style = osc_styles.bigButtons
lo = add_layout("chapter_prev")
lo.geometry =
{x = posX - (bigbtndist * 2), y = bigbtnrowY, an = 5, w = 40, h = 40}
lo.style = osc_styles.bigButtons
lo = add_layout("chapter_next")
lo.geometry =
{x = posX + (bigbtndist * 2), y = bigbtnrowY, an = 5, w = 40, h = 40}
lo.style = osc_styles.bigButtons
lo = add_layout("audio_track")
lo.geometry =
{x = posX - pos_offsetX, y = bigbtnrowY, an = 1, w = 70, h = 18}
lo.style = osc_styles.smallButtonsL
lo = add_layout("sub_track")
lo.geometry =
{x = posX - pos_offsetX, y = bigbtnrowY, an = 7, w = 70, h = 18}
lo.style = osc_styles.smallButtonsL
lo = add_layout("fullscreen")
lo.geometry =
{x = posX+pos_offsetX - 25, y = bigbtnrowY, an = 4, w = 25, h = 25}
lo.style = osc_styles.smallButtonsR
lo = add_layout("volume")
lo.geometry =
{x = posX+pos_offsetX - (25 * 2) - osc_geo.p,
y = bigbtnrowY, an = 4, w = 25, h = 25}
lo.style = osc_styles.smallButtonsR
--
-- Seekbar
--
lo = add_layout("seekbar")
lo.geometry =
{x = posX, y = posY+pos_offsetY-22, an = 2, w = pos_offsetX*2, h = 15}
lo.style = osc_styles.timecodes
lo.slider.tooltip_style = osc_styles.vidtitle
lo.slider.stype = user_opts["seekbarstyle"]
lo.slider.rtype = user_opts["seekrangestyle"]
--
-- Timecodes + Cache
--
local bottomrowY = posY + pos_offsetY - 5
lo = add_layout("tc_left")
lo.geometry =
{x = posX - pos_offsetX, y = bottomrowY, an = 4, w = 110, h = 18}
lo.style = osc_styles.timecodes
lo = add_layout("tc_right")
lo.geometry =
{x = posX + pos_offsetX, y = bottomrowY, an = 6, w = 110, h = 18}
lo.style = osc_styles.timecodes
lo = add_layout("cache")
lo.geometry =
{x = posX, y = bottomrowY, an = 5, w = 110, h = 18}
lo.style = osc_styles.timecodes
end
-- slim box layout
layouts["slimbox"] = function ()
local osc_geo = {
w = 660, -- width
h = 70, -- height
r = 10, -- corner-radius
}
-- make sure the OSC actually fits into the video
if osc_param.playresx < (osc_geo.w) then
osc_param.playresy = (osc_geo.w) / osc_param.display_aspect
osc_param.playresx = osc_param.playresy * osc_param.display_aspect
end
-- position of the controller according to video aspect and valignment
local posX = math.floor(get_align(user_opts.halign, osc_param.playresx,
osc_geo.w, 0))
local posY = math.floor(get_align(user_opts.valign, osc_param.playresy,
osc_geo.h, 0))
osc_param.areas = {} -- delete areas
-- area for active mouse input
add_area("input", get_hitbox_coords(posX, posY, 5, osc_geo.w, osc_geo.h))
-- area for show/hide
local sh_area_y0, sh_area_y1
if user_opts.valign > 0 then
-- deadzone above OSC
sh_area_y0 = get_align(-1 + (2*user_opts.deadzonesize),
posY - (osc_geo.h / 2), 0, 0)
sh_area_y1 = osc_param.playresy
else
-- deadzone below OSC
sh_area_y0 = 0
sh_area_y1 = (posY + (osc_geo.h / 2)) +
get_align(1 - (2*user_opts.deadzonesize),
osc_param.playresy - (posY + (osc_geo.h / 2)), 0, 0)
end
add_area("showhide", 0, sh_area_y0, osc_param.playresx, sh_area_y1)
local lo
local tc_w, ele_h, inner_w = 100, 20, osc_geo.w - 100
-- styles
local styles = {
box = "{\\rDefault\\blur0\\bord1\\1c&H" ..
osc_color_convert(user_opts.background_color) .. "\\3c&HFFFFFF}",
timecodes = "{\\1c&H" .. osc_color_convert(user_opts.timecode_color) .. "\\3c&H" ..
osc_color_convert(user_opts.time_pos_outline_color) .. "\\fs20\\bord2\\blur1}",
tooltip = "{\\1c&H" .. osc_color_convert(user_opts.time_pos_color).. "\\3c&H" ..
osc_color_convert(user_opts.time_pos_outline_color) .. "\\fs12\\bord1\\blur0.5}",
}
new_element("bgbox", "box")
lo = add_layout("bgbox")
lo.geometry = {x = posX, y = posY - 1, an = 2, w = inner_w, h = ele_h}
lo.layer = 10
lo.style = osc_styles.box
lo.alpha[1] = user_opts.boxalpha
lo.alpha[3] = 0
if user_opts["seekbarstyle"] ~= "bar" then
lo.box.radius = osc_geo.r
lo.box.hexagon = user_opts["seekbarstyle"] == "diamond"
end
lo = add_layout("seekbar")
lo.geometry =
{x = posX, y = posY - 1, an = 2, w = inner_w, h = ele_h}
lo.style = osc_styles.timecodes
lo.slider.border = 0
lo.slider.gap = 1.5
lo.slider.tooltip_style = styles.tooltip
lo.slider.stype = user_opts["seekbarstyle"]
lo.slider.rtype = user_opts["seekrangestyle"]
lo.slider.adjust_tooltip = false
--
-- Timecodes
--
lo = add_layout("tc_left")
lo.geometry =
{x = posX - (inner_w/2) + osc_geo.r, y = posY + 1,
an = 7, w = tc_w, h = ele_h}
lo.style = styles.timecodes
lo.alpha[3] = user_opts.boxalpha
lo = add_layout("tc_right")
lo.geometry =
{x = posX + (inner_w/2) - osc_geo.r, y = posY + 1,
an = 9, w = tc_w, h = ele_h}
lo.style = styles.timecodes
lo.alpha[3] = user_opts.boxalpha
-- Cache
lo = add_layout("cache")
lo.geometry =
{x = posX, y = posY + 1,
an = 8, w = tc_w, h = ele_h}
lo.style = styles.timecodes
lo.alpha[3] = user_opts.boxalpha
end
local function bar_layout(direction, slim)
local osc_geo = {
x = -2,
y = nil,
an = (direction < 0) and 7 or 1,
w = nil,
h = slim and 25 or 56,
}
local padX = 9
local padY = 3
local buttonW = 27
local tcW = (state.tc_ms) and 170 or 110
if user_opts.tcspace >= 50 and user_opts.tcspace <= 200 then
-- adjust our hardcoded font size estimation
tcW = tcW * user_opts.tcspace / 100
end
local tsW = 90
local minW = (buttonW + padX)*5 + (tcW + padX)*4 + (tsW + padX)*2
-- Special topbar handling when window controls are present
local padwc_l
local padwc_r
if direction < 0 or not window_controls_enabled() then
padwc_l = 0
padwc_r = 0
elseif window_controls_alignment() == "left" then
padwc_l = window_control_box_width
padwc_r = 0
else
padwc_l = 0
padwc_r = window_control_box_width
end
if osc_param.display_aspect > 0 and osc_param.playresx < minW then
osc_param.playresy = minW / osc_param.display_aspect
osc_param.playresx = osc_param.playresy * osc_param.display_aspect
end
osc_geo.y = direction * (osc_geo.h - 2 + user_opts.barmargin)
osc_geo.w = osc_param.playresx + 4
if direction < 0 then
osc_geo.y = osc_geo.y + osc_param.playresy
end
if direction < 0 then
osc_param.video_margins.b = osc_geo.h / osc_param.playresy
else
osc_param.video_margins.t = osc_geo.h / osc_param.playresy
end
local line1 = osc_geo.y - direction * (9 + padY)
local line2 = osc_geo.y - direction * (36 + padY)
osc_param.areas = {}
add_area("input", get_hitbox_coords(osc_geo.x, osc_geo.y, osc_geo.an,
osc_geo.w, osc_geo.h))
local sh_area_y0, sh_area_y1
if direction > 0 then
-- deadzone below OSC
sh_area_y0 = user_opts.barmargin
sh_area_y1 = osc_geo.y + get_align(1 - (2 * user_opts.deadzonesize),
osc_param.playresy - osc_geo.y, 0, 0)
else
-- deadzone above OSC
sh_area_y0 = get_align(-1 + (2 * user_opts.deadzonesize), osc_geo.y, 0, 0)
sh_area_y1 = osc_param.playresy - user_opts.barmargin
end
add_area("showhide", 0, sh_area_y0, osc_param.playresx, sh_area_y1)
local lo, geo
-- Background bar
new_element("bgbox", "box")
lo = add_layout("bgbox")
lo.geometry = osc_geo
lo.layer = 10
lo.style = osc_styles.box
lo.alpha[1] = user_opts.boxalpha
-- Menu
geo = { x = osc_geo.x + padX + 4, y = line1, an = 4, w = 18, h = 18 - padY }
lo = add_layout("menu")
lo.geometry = geo
lo.style = osc_styles.topButtonsBar
-- Playlist prev/next
geo = { x = geo.x + geo.w + padX, y = geo.y, an = geo.an, w = geo.w, h = geo.h }
lo = add_layout("playlist_prev")
lo.geometry = geo
lo.style = osc_styles.topButtonsBar
geo = { x = geo.x + geo.w + padX, y = geo.y, an = geo.an, w = geo.w, h = geo.h }
lo = add_layout("playlist_next")
lo.geometry = geo
lo.style = osc_styles.topButtonsBar
local t_l = geo.x + geo.w + padX
-- Custom buttons
local t_r = osc_geo.x + osc_geo.w
for i = last_custom_button, 1, -1 do
t_r = t_r - padX
geo = { x = t_r, y = geo.y, an = 6, w = geo.w, h = geo.h }
t_r = t_r - geo.w
lo = add_layout("custom_button_" .. i)
lo.geometry = geo
lo.style = osc_styles.vidtitleBar
end
t_r = t_r - padX
if slim then
-- Fullscreen button
geo = { x = t_r, y = geo.y, an = 6, w = buttonW, h = geo.h }
lo = add_layout("fullscreen")
lo.geometry = geo
lo.style = osc_styles.topButtonsBar
else
-- Cache
geo = { x = t_r, y = geo.y, an = 6, w = 150, h = geo.h }
lo = add_layout("cache")
lo.geometry = geo
lo.style = osc_styles.vidtitleBar
end
t_r = t_r - geo.w - padX
-- Title
geo = { x = t_l, y = geo.y, an = 4,
w = t_r - t_l, h = geo.h }
lo = add_layout("title")
lo.geometry = geo
lo.style = string.format("%s{\\clip(%f,%f,%f,%f)}",
osc_styles.vidtitleBar,
geo.x, geo.y-geo.h, geo.w, geo.y+geo.h)
if slim then
return
end
-- Playback control buttons
geo = { x = osc_geo.x + padX + padwc_l, y = line2, an = 4,
w = buttonW, h = 36 - padY*2}
lo = add_layout("play_pause")
lo.geometry = geo
lo.style = osc_styles.smallButtonsBar
geo = { x = geo.x + geo.w + padX, y = geo.y, an = geo.an, w = geo.w, h = geo.h }
lo = add_layout("chapter_prev")
lo.geometry = geo
lo.style = osc_styles.smallButtonsBar
geo = { x = geo.x + geo.w + padX, y = geo.y, an = geo.an, w = geo.w, h = geo.h }
lo = add_layout("chapter_next")
lo.geometry = geo
lo.style = osc_styles.smallButtonsBar
-- Left timecode
geo = { x = geo.x + geo.w + padX + tcW, y = geo.y, an = 6,
w = tcW, h = geo.h }
lo = add_layout("tc_left")
lo.geometry = geo
lo.style = osc_styles.timecodesBar
local sb_l = geo.x + padX
-- Fullscreen button
geo = { x = osc_geo.x + osc_geo.w - buttonW - padX - padwc_r, y = geo.y, an = 4,
w = buttonW, h = geo.h }
lo = add_layout("fullscreen")
lo.geometry = geo
lo.style = osc_styles.smallButtonsBar
-- START quality-menu
geo = { x = geo.x - geo.w - padX, y = geo.y, an = geo.an, w = geo.w, h = geo.h }
lo = add_layout("quality-menu")
lo.geometry = geo
lo.style = osc_styles.smallButtonsBar
-- END quality-menu
-- Volume
geo = { x = geo.x - geo.w - padX, y = geo.y, an = geo.an, w = geo.w, h = geo.h }
lo = add_layout("volume")
lo.geometry = geo
lo.style = osc_styles.smallButtonsBar
-- Track selection buttons
geo = { x = geo.x - tsW - padX, y = geo.y, an = geo.an, w = tsW, h = geo.h }
lo = add_layout("sub_track")
lo.geometry = geo
lo.style = osc_styles.smallButtonsBar
geo = { x = geo.x - geo.w - padX, y = geo.y, an = geo.an, w = geo.w, h = geo.h }
lo = add_layout("audio_track")
lo.geometry = geo
lo.style = osc_styles.smallButtonsBar
-- Right timecode
geo = { x = geo.x - padX - tcW - 10, y = geo.y, an = geo.an,
w = tcW, h = geo.h }
lo = add_layout("tc_right")
lo.geometry = geo
lo.style = osc_styles.timecodesBar
local sb_r = geo.x - padX
-- Seekbar
geo = { x = sb_l, y = geo.y, an = geo.an,
w = math.max(0, sb_r - sb_l), h = geo.h }
new_element("bgbar1", "box")
lo = add_layout("bgbar1")
lo.geometry = geo
lo.layer = 15
lo.style = osc_styles.timecodesBar
lo.alpha[1] =
math.min(255, user_opts.boxalpha + (255 - user_opts.boxalpha)*0.8)
if user_opts["seekbarstyle"] ~= "bar" then
lo.box.radius = geo.h / 2
lo.box.hexagon = user_opts["seekbarstyle"] == "diamond"
end
lo = add_layout("seekbar")
lo.geometry = geo
lo.style = osc_styles.timecodesBar
lo.slider.border = 0
lo.slider.gap = 2
lo.slider.tooltip_style = osc_styles.timePosBar
lo.slider.tooltip_an = 5
lo.slider.stype = user_opts["seekbarstyle"]
lo.slider.rtype = user_opts["seekrangestyle"]
end
layouts["bottombar"] = function()
bar_layout(-1)
end
layouts["topbar"] = function()
bar_layout(1)
end
layouts["slimbottombar"] = function()
bar_layout(-1, true)
end
layouts["slimtopbar"] = function()
bar_layout(1, true)
end
local function bind_mouse_buttons(element_name)
for _, button in pairs({"mbtn_left", "mbtn_mid", "mbtn_right"}) do
local command = user_opts[element_name .. "_" .. button .. "_command"]
if command ~= "" then
elements[element_name].eventresponder[button .. "_up"] = function ()
mp.command(command)
end
end
end
if user_opts.scrollcontrols then
for _, button in pairs({"wheel_down", "wheel_up"}) do
local command = user_opts[element_name .. "_" .. button .. "_command"]
if command and command ~= "" then
elements[element_name].eventresponder[button .. "_press"] = function ()
mp.command(command)
end
end
end
end
end
local function osc_init()
msg.debug("osc_init")
-- set canvas resolution according to display aspect and scaling setting
local baseResY = 720
local _, display_h, display_aspect = mp.get_osd_size()
local scale
if state.fullscreen then
scale = user_opts.scalefullscreen
else
scale = user_opts.scalewindowed
end
local scale_with_video
if user_opts.vidscale == "auto" then
scale_with_video = mp.get_property_native("osd-scale-by-window")
else
scale_with_video = user_opts.vidscale == "yes"
end
if scale_with_video then
osc_param.unscaled_y = baseResY
else
osc_param.unscaled_y = display_h
end
osc_param.playresy = osc_param.unscaled_y / scale
if display_aspect > 0 then
osc_param.display_aspect = display_aspect
end
osc_param.playresx = osc_param.playresy * osc_param.display_aspect
-- stop seeking with the slider to prevent skipping files
state.active_element = nil
osc_param.video_margins = {l = 0, r = 0, t = 0, b = 0}
elements = {}
-- some often needed stuff
local pl_count = mp.get_property_number("playlist-count", 0)
local have_pl = (pl_count > 1)
local pl_pos = mp.get_property_number("playlist-pos", 0) + 1
local have_ch = (mp.get_property_number("chapters", 0) > 0)
local loop = mp.get_property("loop-playlist", "no")
local ne
-- title
ne = new_element("title", "button")
ne.content = function ()
local title = state.forced_title or
mp.command_native({"expand-text", user_opts.title})
title = title:gsub("\n", " ")
return title ~= "" and mp.command_native({"escape-ass", title}) or "mpv"
end
bind_mouse_buttons("title")
-- menu
ne = new_element("menu", "button")
ne.content = icons.menu
bind_mouse_buttons("menu")
-- playlist buttons
-- prev
ne = new_element("playlist_prev", "button")
ne.content = icons.prev
ne.enabled = (pl_pos > 1) or (loop ~= "no")
bind_mouse_buttons("playlist_prev")
--next
ne = new_element("playlist_next", "button")
ne.content = icons.next
ne.enabled = (have_pl and (pl_pos < pl_count)) or (loop ~= "no")
bind_mouse_buttons("playlist_next")
-- big buttons
--play_pause
ne = new_element("play_pause", "button")
ne.content = function ()
if not mp.get_property_native("pause") then
return icons.pause
end
return mp.get_property("play-direction") == "forward"
and icons.play
or icons.play_backward
end
bind_mouse_buttons("play_pause")
--skip_backward
ne = new_element("skip_backward", "button")
ne.softrepeat = true
ne.content = icons.skip_backward
ne.eventresponder["mbtn_left_down"] =
function () mp.commandv("seek", -5) end
ne.eventresponder["mbtn_mid"] =
function () mp.commandv("frame-back-step") end
ne.eventresponder["mbtn_right_down"] =
function () mp.commandv("seek", -30) end
--skip_forward
ne = new_element("skip_forward", "button")
ne.softrepeat = true
ne.content = icons.skip_forward
ne.eventresponder["mbtn_left_down"] =
function () mp.commandv("seek", 10) end
ne.eventresponder["mbtn_mid"] =
function () mp.commandv("frame-step") end
ne.eventresponder["mbtn_right_down"] =
function () mp.commandv("seek", 60) end
--chapter_prev
ne = new_element("chapter_prev", "button")
ne.enabled = have_ch
ne.content = icons.chapter_prev
bind_mouse_buttons("chapter_prev")
--chapter_next
ne = new_element("chapter_next", "button")
ne.enabled = have_ch
ne.content = icons.chapter_next
bind_mouse_buttons("chapter_next")
--
update_tracklist()
--audio_track
ne = new_element("audio_track", "button")
ne.enabled = audio_track_count > 0
ne.content = function ()
return icons.audio .. osc_styles.smallButtonsLlabel .. " " ..
mp.get_property_number("aid", "-") .. "/" .. audio_track_count
end
bind_mouse_buttons("audio_track")
--sub_track
ne = new_element("sub_track", "button")
ne.enabled = sub_track_count > 0
ne.content = function ()
return icons.subtitle .. osc_styles.smallButtonsLlabel .. " " ..
mp.get_property_number("sid", "-") .. "/" .. sub_track_count
end
bind_mouse_buttons("sub_track")
--fullscreen
ne = new_element("fullscreen", "button")
ne.content = function ()
return state.fullscreen and icons.exit_fullscreen or icons.fullscreen
end
bind_mouse_buttons("fullscreen")
--seekbar
ne = new_element("seekbar", "slider")
ne.enabled = mp.get_property("percent-pos") ~= nil
and user_opts.layout ~= "slimbottombar"
and user_opts.layout ~= "slimtopbar"
state.slider_element = ne.enabled and ne or nil -- used for forced_title
ne.slider.markerF = function ()
local duration = mp.get_property_number("duration")
if duration ~= nil then
local chapters = mp.get_property_native("chapter-list", {})
local markers = {}
for n = 1, #chapters do
markers[n] = (chapters[n].time / duration * 100)
end
return markers
else
return {}
end
end
ne.slider.posF =
function () return mp.get_property_number("percent-pos") end
ne.slider.tooltipF = function (pos)
local duration = mp.get_property_number("duration")
if duration ~= nil and pos ~= nil then
local possec = duration * (pos / 100)
return mp.format_time(possec)
else
return ""
end
end
ne.slider.seekRangesF = function()
if user_opts.seekrangestyle == "none" or not cache_enabled() then
return nil
end
local duration = mp.get_property_number("duration")
if duration == nil or duration <= 0 then
return nil
end
local nranges = {}
for _, range in pairs(state.cache_state["seekable-ranges"]) do
nranges[#nranges + 1] = {
["start"] = 100 * range["start"] / duration,
["end"] = 100 * range["end"] / duration,
}
end
return nranges
end
ne.eventresponder["mouse_move"] = --keyframe seeking when mouse is dragged
function (element)
if not element.state.mbtn_left then
return
end
-- mouse move events may pile up during seeking and may still get
-- sent when the user is done seeking, so we need to throw away
-- identical seeks
local seekto = get_slider_value(element)
if element.state.lastseek == nil or
element.state.lastseek ~= seekto then
local flags = "absolute-percent"
if not user_opts.seekbarkeyframes then
flags = flags .. "+exact"
end
mp.commandv("seek", seekto, flags)
element.state.lastseek = seekto
end
end
ne.eventresponder["mbtn_left_down"] = function (element)
element.state.mbtn_left = true
mp.commandv("seek", get_slider_value(element), "absolute-percent+exact")
end
ne.eventresponder["mbtn_left_up"] = function (element)
element.state.mbtn_left = false
end
ne.eventresponder["mbtn_right_up"] = function (element)
local chapter
local pos = get_slider_value(element)
local diff = math.huge
for i, marker in ipairs(element.slider.markerF()) do
if math.abs(pos - marker) < diff then
diff = math.abs(pos - marker)
chapter = i
end
end
if chapter then
mp.set_property("chapter", chapter - 1)
end
end
ne.eventresponder["reset"] =
function (element) element.state.lastseek = nil end
if user_opts.scrollcontrols then
ne.eventresponder["wheel_up_press"] =
function () mp.commandv("osd-auto", "seek", 10) end
ne.eventresponder["wheel_down_press"] =
function () mp.commandv("osd-auto", "seek", -10) end
end
-- tc_left (current pos)
ne = new_element("tc_left", "button")
ne.content = function ()
if state.tc_ms then
return (mp.get_property_osd("playback-time/full"))
else
return (mp.get_property_osd("playback-time"))
end
end
ne.eventresponder["mbtn_left_up"] = function ()
state.tc_ms = not state.tc_ms
request_init()
end
-- tc_right (total/remaining time)
ne = new_element("tc_right", "button")
ne.visible = (mp.get_property_number("duration", 0) > 0)
ne.content = function ()
if state.rightTC_trem then
local minus = user_opts.unicodeminus and UNICODE_MINUS or "-"
local property = user_opts.remaining_playtime and "playtime-remaining"
or "time-remaining"
if state.tc_ms then
return (minus..mp.get_property_osd(property .. "/full"))
else
return (minus..mp.get_property_osd(property))
end
else
if state.tc_ms then
return (mp.get_property_osd("duration/full"))
else
return (mp.get_property_osd("duration"))
end
end
end
ne.eventresponder["mbtn_left_up"] =
function () state.rightTC_trem = not state.rightTC_trem end
-- cache
ne = new_element("cache", "button")
ne.content = function ()
if not cache_enabled() then
return ""
end
local dmx_cache = state.cache_state["cache-duration"]
local thresh = math.min(state.dmx_cache * 0.05, 5) -- 5% or 5s
if dmx_cache and math.abs(dmx_cache - state.dmx_cache) >= thresh then
state.dmx_cache = dmx_cache
else
dmx_cache = state.dmx_cache
end
local min = math.floor(dmx_cache / 60)
local sec = math.floor(dmx_cache % 60) -- don't round e.g. 59.9 to 60
return "Cache: " .. (min > 0 and
string.format("%sm%02.0fs", min, sec) or
string.format("%3.0fs", sec))
end
-- START quality-menu
ne = new_element("quality-menu", "button")
ne.content = function()
return ("≚")
end
ne.eventresponder["mbtn_left_up"] =
function () mp.commandv("script-message", "video_formats_toggle") end
ne.eventresponder["mbtn_right_up"] =
function () mp.commandv("script-message", "audio_formats_toggle") end
-- END quality-menu
-- volume
ne = new_element("volume", "button")
ne.content = function()
local volume = mp.get_property_number("volume")
if volume == 0 or mp.get_property_native("mute") then
return icons.mute
end
return icons.volume[math.min(4, math.ceil(volume / (100/3)))]
end
bind_mouse_buttons("volume")
-- custom buttons
for i = 1, math.huge do
local content = user_opts["custom_button_" .. i .. "_content"]
if not content or content == "" then
break
end
ne = new_element("custom_button_" .. i, "button")
ne.content = content
bind_mouse_buttons("custom_button_" .. i)
last_custom_button = i
end
-- load layout
layouts[user_opts.layout]()
-- load window controls
if window_controls_enabled() then
window_controls(user_opts.layout == "topbar")
end
--do something with the elements
prepare_elements()
update_margins()
end
local function osc_visible(visible)
if state.osc_visible ~= visible then
state.osc_visible = visible
update_margins()
end
request_tick()
end
local function show_osc()
-- show when disabled can happen (e.g. mouse_move) due to async/delayed unbinding
if not state.enabled then return end
msg.trace("show_osc")
--remember last time of invocation (mouse move)
state.showtime = mp.get_time()
if user_opts.fadeduration <= 0 then
osc_visible(true)
elseif user_opts.fadein then
if not state.osc_visible then
state.anitype = "in"
request_tick()
end
else
osc_visible(true)
state.anitype = nil
end
end
local function hide_osc()
msg.trace("hide_osc")
if not state.enabled then
-- typically hide happens at render() from tick(), but now tick() is
-- no-op and won't render again to remove the osc, so do that manually.
state.osc_visible = false
render_wipe()
elseif user_opts.fadeduration > 0 then
if state.osc_visible then
state.anitype = "out"
request_tick()
end
else
osc_visible(false)
end
end
local function pause_state(_, enabled)
state.paused = enabled
request_tick()
end
local function cache_state(_, st)
state.cache_state = st
request_tick()
end
local function mouse_leave()
if get_hidetimeout() >= 0 and get_touchtimeout() <= 0 then
hide_osc()
end
-- reset mouse position
state.last_mouseX, state.last_mouseY = nil, nil
state.mouse_in_window = false
end
local function handle_touch()
--remember last time of invocation (touch event)
state.touchtime = mp.get_time()
end
--
-- Eventhandling
--
local function element_has_action(element, action)
return element and element.eventresponder and
element.eventresponder[action]
end
local function process_event(source, what)
local action = string.format("%s%s", source,
what and ("_" .. what) or "")
if what == "down" or what == "press" then
for n = 1, #elements do
if mouse_hit(elements[n]) and
elements[n].eventresponder and
(elements[n].eventresponder[source .. "_up"] or
elements[n].eventresponder[action]) then
if what == "down" then
state.active_element = n
state.active_event_source = source
end
-- fire the down or press event if the element has one
if element_has_action(elements[n], action) then
elements[n].eventresponder[action](elements[n])
end
end
end
elseif what == "up" then
if elements[state.active_element] then
local n = state.active_element
if n == 0 then --luacheck: ignore 542
--click on background (does not work)
elseif element_has_action(elements[n], action) and
mouse_hit(elements[n]) then
elements[n].eventresponder[action](elements[n])
end
--reset active element
if element_has_action(elements[n], "reset") then
elements[n].eventresponder["reset"](elements[n])
end
end
state.active_element = nil
state.mouse_down_counter = 0
elseif source == "mouse_move" then
state.mouse_in_window = true
local mouseX, mouseY = get_virt_mouse_pos()
if user_opts.minmousemove == 0 or
((state.last_mouseX ~= nil and state.last_mouseY ~= nil) and
((math.abs(mouseX - state.last_mouseX) >= user_opts.minmousemove)
or (math.abs(mouseY - state.last_mouseY) >= user_opts.minmousemove)
)
) then
show_osc()
end
state.last_mouseX, state.last_mouseY = mouseX, mouseY
local n = state.active_element
if element_has_action(elements[n], action) then
elements[n].eventresponder[action](elements[n])
end
end
-- ensure rendering after any (mouse) event - icons could change etc
request_tick()
end
local function do_enable_keybindings()
if state.enabled then
if not state.showhide_enabled then
mp.enable_key_bindings("showhide", "allow-vo-dragging+allow-hide-cursor")
mp.enable_key_bindings("showhide_wc", "allow-vo-dragging+allow-hide-cursor")
end
state.showhide_enabled = true
end
end
local function enable_osc(enable)
state.enabled = enable
if enable then
do_enable_keybindings()
else
hide_osc() -- acts immediately when state.enabled == false
if state.showhide_enabled then
mp.disable_key_bindings("showhide")
mp.disable_key_bindings("showhide_wc")
end
state.showhide_enabled = false
end
end
local function render()
msg.trace("rendering")
local current_screen_sizeX, current_screen_sizeY = mp.get_osd_size()
local mouseX, mouseY = get_virt_mouse_pos()
local now = mp.get_time()
-- check if display changed, if so request reinit
if state.screen_sizeX ~= current_screen_sizeX
or state.screen_sizeY ~= current_screen_sizeY then
request_init_resize()
state.screen_sizeX = current_screen_sizeX
state.screen_sizeY = current_screen_sizeY
end
-- init management
if state.active_element then
-- mouse is held down on some element - keep ticking and ignore initReq
-- till it's released, or else the mouse-up (click) will misbehave or
-- get ignored. that's because osc_init() recreates the osc elements,
-- but mouse handling depends on the elements staying unmodified
-- between mouse-down and mouse-up (using the index active_element).
request_tick()
elseif state.initREQ then
osc_init()
state.initREQ = false
-- store initial mouse position
if (state.last_mouseX == nil or state.last_mouseY == nil)
and not (mouseX == nil or mouseY == nil) then
state.last_mouseX, state.last_mouseY = mouseX, mouseY
end
end
-- fade animation
if state.anitype ~= nil then
if state.anistart == nil then
state.anistart = now
end
if now < state.anistart + (user_opts.fadeduration / 1000) then
if state.anitype == "in" then --fade in
osc_visible(true)
state.animation = scale_value(state.anistart,
(state.anistart + (user_opts.fadeduration / 1000)),
255, 0, now)
elseif state.anitype == "out" then --fade out
state.animation = scale_value(state.anistart,
(state.anistart + (user_opts.fadeduration / 1000)),
0, 255, now)
end
else
if state.anitype == "out" then
osc_visible(false)
end
kill_animation()
end
else
kill_animation()
end
--mouse show/hide area
for _, cords in pairs(osc_param.areas["showhide"]) do
set_virt_mouse_area(cords.x1, cords.y1, cords.x2, cords.y2, "showhide")
end
if osc_param.areas["showhide_wc"] then
for _, cords in pairs(osc_param.areas["showhide_wc"]) do
set_virt_mouse_area(cords.x1, cords.y1, cords.x2, cords.y2, "showhide_wc")
end
else
set_virt_mouse_area(0, 0, 0, 0, "showhide_wc")
end
do_enable_keybindings()
--mouse input area
local mouse_over_osc = false
for _,cords in ipairs(osc_param.areas["input"]) do
if state.osc_visible then -- activate only when OSC is actually visible
set_virt_mouse_area(cords.x1, cords.y1, cords.x2, cords.y2, "input")
end
if state.osc_visible ~= state.input_enabled then
if state.osc_visible then
mp.enable_key_bindings("input")
else
mp.disable_key_bindings("input")
end
state.input_enabled = state.osc_visible
end
if mouse_hit_coords(cords.x1, cords.y1, cords.x2, cords.y2) then
mouse_over_osc = true
end
end
if osc_param.areas["window-controls"] then
for _,cords in ipairs(osc_param.areas["window-controls"]) do
if state.osc_visible then -- activate only when OSC is actually visible
set_virt_mouse_area(cords.x1, cords.y1, cords.x2, cords.y2, "window-controls")
end
if state.osc_visible ~= state.windowcontrols_buttons then
if state.osc_visible then
mp.enable_key_bindings("window-controls")
else
mp.disable_key_bindings("window-controls")
end
state.windowcontrols_buttons = state.osc_visible
end
if mouse_hit_coords(cords.x1, cords.y1, cords.x2, cords.y2) then
mouse_over_osc = true
end
end
end
if osc_param.areas["window-controls-title"] then
for _,cords in ipairs(osc_param.areas["window-controls-title"]) do
if state.osc_visible then -- activate only when OSC is actually visible
set_virt_mouse_area(cords.x1, cords.y1, cords.x2, cords.y2, "window-controls-title")
end
if state.osc_visible ~= state.windowcontrols_title then
if state.osc_visible then
mp.enable_key_bindings("window-controls-title", "allow-vo-dragging")
else
mp.disable_key_bindings("window-controls-title", "allow-vo-dragging")
end
state.windowcontrols_title = state.osc_visible
end
if mouse_hit_coords(cords.x1, cords.y1, cords.x2, cords.y2) then
mouse_over_osc = true
end
end
end
-- autohide
if state.showtime ~= nil and get_hidetimeout() >= 0 then
local timeout = state.showtime + (get_hidetimeout() / 1000) - now
if timeout <= 0 and get_touchtimeout() <= 0 then
if state.active_element == nil and not mouse_over_osc then
hide_osc()
end
else
-- the timer is only used to recheck the state and to possibly run
-- the code above again
if not state.hide_timer then
state.hide_timer = mp.add_timeout(0, tick)
end
state.hide_timer.timeout = timeout
-- re-arm
state.hide_timer:kill()
state.hide_timer:resume()
end
end
-- actual rendering
local ass = assdraw.ass_new()
-- actual OSC
if state.osc_visible then
render_elements(ass)
end
-- submit
set_osd(osc_param.playresy * osc_param.display_aspect,
osc_param.playresy, ass.text, 1000)
end
-- called by mpv on every frame
tick = function()
if state.marginsREQ == true then
update_margins()
state.marginsREQ = false
end
if not state.enabled then return end
if state.idle then
-- render idle message
msg.trace("idle message")
local _, _, display_aspect = mp.get_osd_size()
if display_aspect == 0 then
return
end
local display_h = 360
local display_w = display_h * display_aspect
-- logo is rendered at 2^(6-1) = 32 times resolution with size 1800x1800
local icon_x, icon_y = (display_w - 1800 / 32) / 2, 140
local line_prefix = ("{\\rDefault\\an7\\1a&H00&\\bord0\\shad0\\pos(%f,%f)}"):format(icon_x,
icon_y)
local ass = assdraw.ass_new()
-- mpv logo
if user_opts.idlescreen then
for _, line in ipairs(logo_lines) do
ass:new_event()
ass:append(line_prefix .. line)
end
end
-- Santa hat
if is_december and user_opts.idlescreen and not user_opts.greenandgrumpy then
for _, line in ipairs(santa_hat_lines) do
ass:new_event()
ass:append(line_prefix .. line)
end
end
if user_opts.idlescreen then
ass:new_event()
ass:pos(display_w / 2, icon_y + 65)
ass:an(8)
ass:append("Drop files or URLs to play here.")
end
set_osd(display_w, display_h, ass.text, -1000)
if state.showhide_enabled then
mp.disable_key_bindings("showhide")
mp.disable_key_bindings("showhide_wc")
state.showhide_enabled = false
end
elseif state.fullscreen and user_opts.showfullscreen
or (not state.fullscreen and user_opts.showwindowed) then
-- render the OSC
render()
else
-- Flush OSD
render_wipe()
end
state.tick_last_time = mp.get_time()
if state.anitype ~= nil then
-- state.anistart can be nil - animation should now start, or it can
-- be a timestamp when it started. state.idle has no animation.
if not state.idle and
(not state.anistart or
mp.get_time() < 1 + state.anistart + user_opts.fadeduration/1000)
then
-- animating or starting, or still within 1s past the deadline
request_tick()
else
kill_animation()
end
end
end
local function shutdown()
reset_margins()
mp.del_property("user-data/osc")
end
-- duration is observed for the sole purpose of updating chapter markers
-- positions. live streams with chapters are very rare, and the update is also
-- expensive (with request_init), so it's only observed when we have chapters
-- and the user didn't disable the livemarkers option (update_duration_watch).
local function on_duration() request_init() end
local duration_watched = false
local function update_duration_watch()
local want_watch = user_opts.livemarkers and
(mp.get_property_number("chapters", 0) or 0) > 0 and
true or false -- ensure it's a boolean
if want_watch ~= duration_watched then
if want_watch then
mp.observe_property("duration", "native", on_duration)
else
mp.unobserve_property(on_duration)
end
duration_watched = want_watch
end
end
local function set_tick_delay(_, display_fps)
-- may be nil if unavailable or 0 fps is reported
if not display_fps or not user_opts.tick_delay_follow_display_fps then
tick_delay = user_opts.tick_delay
return
end
tick_delay = 1 / display_fps
end
mp.register_event("shutdown", shutdown)
mp.register_event("start-file", request_init)
mp.observe_property("track-list", "native", request_init)
mp.observe_property("playlist-count", "native", request_init)
mp.observe_property("playlist-pos", "native", request_init)
mp.observe_property("chapter-list", "native", function(_, list)
list = list or {} -- safety, shouldn't return nil
table.sort(list, function(a, b) return a.time < b.time end)
state.chapter_list = list
update_duration_watch()
request_init()
end)
-- These are for backwards compatibility only.
mp.register_script_message("osc-message", function(message, dur)
if not state.osc_message_warned then
mp.msg.warn("osc-message is deprecated and may be removed in the future.",
"Use the show-text command instead.")
state.osc_message_warned = true
end
mp.osd_message(message, dur)
end)
mp.register_script_message("osc-chapterlist", function(dur)
if not state.osc_chapterlist_warned then
mp.msg.warn("osc-chapterlist is deprecated and may be removed in the future.",
"Use show-text ${chapter-list} instead.")
state.osc_chapterlist_warned = true
end
mp.command("show-text ${chapter-list} " .. (dur and dur * 1000 or ""))
end)
mp.register_script_message("osc-playlist", function(dur)
if not state.osc_playlist_warned then
mp.msg.warn("osc-playlist is deprecated and may be removed in the future.",
"Use show-text ${playlist} instead.")
state.osc_playlist_warned = true
end
mp.command("show-text ${playlist} " .. (dur and dur * 1000 or ""))
end)
mp.register_script_message("osc-tracklist", function(dur)
if not state.osc_tracklist_warned then
mp.msg.warn("osc-tracklist is deprecated and may be removed in the future.",
"Use show-text ${track-list} instead.")
state.osc_tracklist_warned = true
end
mp.command("show-text ${track-list} " .. (dur and dur * 1000 or ""))
end)
mp.observe_property("fullscreen", "bool", function(_, val)
state.fullscreen = val
state.marginsREQ = true
request_init_resize()
end)
mp.observe_property("border", "bool", function(_, val)
state.border = val
request_init_resize()
end)
mp.observe_property("title-bar", "bool", function(_, val)
state.title_bar = val
request_init_resize()
end)
mp.observe_property("window-maximized", "bool", function(_, val)
state.maximized = val
request_init_resize()
end)
mp.observe_property("idle-active", "bool", function(_, val)
state.idle = val
request_tick()
end)
mp.observe_property("display-fps", "number", set_tick_delay)
mp.observe_property("pause", "bool", pause_state)
mp.observe_property("demuxer-cache-state", "native", cache_state)
mp.observe_property("vo-configured", "bool", request_tick)
mp.observe_property("playback-time", "number", request_tick)
mp.observe_property("osd-dimensions", "native", function()
-- (we could use the value instead of re-querying it all the time, but then
-- we might have to worry about property update ordering)
request_init_resize()
end)
mp.observe_property('osd-scale-by-window', 'native', request_init_resize)
mp.observe_property('touch-pos', 'native', handle_touch)
-- mouse show/hide bindings
mp.set_key_bindings({
{"mouse_move", function() process_event("mouse_move", nil) end},
{"mouse_leave", mouse_leave},
}, "showhide", "force")
mp.set_key_bindings({
{"mouse_move", function() process_event("mouse_move", nil) end},
{"mouse_leave", mouse_leave},
}, "showhide_wc", "force")
do_enable_keybindings()
--mouse input bindings
mp.set_key_bindings({
{"mbtn_left", function() process_event("mbtn_left", "up") end,
function() process_event("mbtn_left", "down") end},
{"mbtn_mid", function() process_event("mbtn_mid", "up") end,
function() process_event("mbtn_mid", "down") end},
{"mbtn_right", function() process_event("mbtn_right", "up") end,
function() process_event("mbtn_right", "down") end},
-- alias shift+mbtn_left to mbtn_mid for touchpads
{"shift+mbtn_left", function() process_event("mbtn_mid", "up") end,
function() process_event("mbtn_mid", "down") end},
{"wheel_up", function() process_event("wheel_up", "press") end},
{"wheel_down", function() process_event("wheel_down", "press") end},
{"mbtn_left_dbl", "ignore"},
{"shift+mbtn_left_dbl", "ignore"},
{"mbtn_right_dbl", "ignore"},
}, "input", "force")
mp.enable_key_bindings("input")
mp.set_key_bindings({
{"mbtn_left", function() process_event("mbtn_left", "up") end,
function() process_event("mbtn_left", "down") end},
}, "window-controls", "force")
mp.enable_key_bindings("window-controls")
local function always_on(val)
if state.enabled then
if val then
show_osc()
else
hide_osc()
end
end
end
-- mode can be auto/always/never/cycle
-- the modes only affect internal variables and not stored on its own.
local function visibility_mode(mode, no_osd)
if mode == "cycle" then
for i, allowed_mode in ipairs(state.visibility_modes) do
if i == #state.visibility_modes then
mode = state.visibility_modes[1]
break
elseif user_opts.visibility == allowed_mode then
mode = state.visibility_modes[i + 1]
break
end
end
end
if mode == "auto" then
always_on(false)
enable_osc(true)
elseif mode == "always" then
enable_osc(true)
always_on(true)
elseif mode == "never" then
enable_osc(false)
else
msg.warn("Ignoring unknown visibility mode '" .. mode .. "'")
return
end
user_opts.visibility = mode
mp.set_property_native("user-data/osc/visibility", mode)
if not no_osd and tonumber(mp.get_property("osd-level")) >= 1 then
mp.osd_message("OSC visibility: " .. mode)
end
-- Reset the input state on a mode change. The input state will be
-- recalculated on the next render cycle, except in 'never' mode where it
-- will just stay disabled.
mp.disable_key_bindings("input")
mp.disable_key_bindings("window-controls")
state.input_enabled = false
update_margins()
request_tick()
end
local function idlescreen_visibility(mode, no_osd)
if mode == "cycle" then
if user_opts.idlescreen then
mode = "no"
else
mode = "yes"
end
end
if mode == "yes" then
user_opts.idlescreen = true
else
user_opts.idlescreen = false
end
mp.set_property_native("user-data/osc/idlescreen", user_opts.idlescreen)
if not no_osd and tonumber(mp.get_property("osd-level")) >= 1 then
mp.osd_message("OSC logo visibility: " .. tostring(mode))
end
request_tick()
end
mp.register_script_message("osc-visibility", visibility_mode)
mp.register_script_message("osc-show", show_osc)
mp.register_script_message("osc-hide", function ()
if user_opts.visibility == "auto" then
osc_visible(false)
end
end)
mp.add_key_binding(nil, "visibility", function() visibility_mode("cycle") end)
mp.register_script_message("osc-idlescreen", idlescreen_visibility)
-- Validate string type user options
local function validate_user_opts()
if layouts[user_opts.layout] == nil then
msg.warn("Invalid setting '"..user_opts.layout.."' for layout")
user_opts.layout = "bottombar"
end
if user_opts.seekbarstyle ~= "bar" and
user_opts.seekbarstyle ~= "diamond" and
user_opts.seekbarstyle ~= "knob" then
msg.warn("Invalid setting '" .. user_opts.seekbarstyle
.. "' for seekbarstyle")
user_opts.seekbarstyle = "bar"
end
if user_opts.seekrangestyle ~= "bar" and
user_opts.seekrangestyle ~= "line" and
user_opts.seekrangestyle ~= "slider" and
user_opts.seekrangestyle ~= "inverted" and
user_opts.seekrangestyle ~= "none" then
msg.warn("Invalid setting '" .. user_opts.seekrangestyle
.. "' for seekrangestyle")
user_opts.seekrangestyle = "inverted"
end
if user_opts.seekrangestyle == "slider" and
user_opts.seekbarstyle == "bar" then
msg.warn(
"Using 'slider' seekrangestyle together with 'bar' seekbarstyle is not supported")
user_opts.seekrangestyle = "inverted"
end
if user_opts.windowcontrols ~= "auto" and
user_opts.windowcontrols ~= "yes" and
user_opts.windowcontrols ~= "no" then
msg.warn("windowcontrols cannot be '" ..
user_opts.windowcontrols .. "'. Ignoring.")
user_opts.windowcontrols = "auto"
end
if user_opts.windowcontrols_alignment ~= "right" and
user_opts.windowcontrols_alignment ~= "left" then
msg.warn("windowcontrols_alignment cannot be '" ..
user_opts.windowcontrols_alignment .. "'. Ignoring.")
user_opts.windowcontrols_alignment = "right"
end
local colors = {
user_opts.background_color, user_opts.top_buttons_color,
user_opts.small_buttonsL_color, user_opts.small_buttonsR_color,
user_opts.buttons_color, user_opts.title_color,
user_opts.timecode_color, user_opts.time_pos_color,
user_opts.held_element_color, user_opts.time_pos_outline_color,
}
for _, color in pairs(colors) do
if color:find("^#%x%x%x%x%x%x$") == nil then
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
opt.read_options(user_opts, "osc", function(changed)
validate_user_opts()
set_osc_styles()
set_time_styles(changed.timetotal, changed.timems)
if changed.tick_delay or changed.tick_delay_follow_display_fps then
set_tick_delay("display_fps", mp.get_property_number("display_fps"))
end
request_tick()
visibility_mode(user_opts.visibility, true)
update_duration_watch()
request_init()
end)
validate_user_opts()
set_osc_styles()
set_time_styles(true, true)
set_tick_delay("display_fps", mp.get_property_number("display_fps"))
visibility_mode(user_opts.visibility, true)
update_duration_watch()
set_virt_mouse_area(0, 0, 0, 0, "input")
set_virt_mouse_area(0, 0, 0, 0, "window-controls")
set_virt_mouse_area(0, 0, 0, 0, "window-controls-title")
================================================
FILE: quality-menu.conf
================================================
# KEY BINDINGS
# move the menu cursor up
up_binding=UP WHEEL_UP
# move the menu cursor down
down_binding=DOWN WHEEL_DOWN
# select menu entry
select_binding=ENTER MBTN_LEFT
# close menu
close_menu_binding=ESC MBTN_RIGHT
# formatting / cursors
selected_and_active=▶ -
selected_and_inactive=● -
unselected_and_active=▷ -
unselected_and_inactive=○ -
# font size scales by window, if false requires larger font and padding sizes
scale_playlist_by_window=yes
# playlist ass style overrides inside curly brackets, \keyvalue is one field, extra \ for escape in lua
# example {\\fnUbuntu\\fs10\\b0\\bord1} equals: font=Ubuntu, size=10, bold=no, border=1
# read https://aegi.vmoe.info/docs/3.0/ASS_Tags/ for reference of tags
# undeclared tags will use default osd settings
# these styles will be used for the whole playlist. More specific styling will need to be hacked in
#
# (a monospaced font is recommended but not required)
style_ass_tags={\\fnmonospace\\fs25\\bord1}
# Shift drawing coordinates. Required for mpv.net compatiblity
shift_x=0
shift_y=0
# paddings for top left corner
text_padding_x=5
text_padding_y=10
# Screen dim when menu is open
curtain_opacity=0.7
# how many seconds until the quality menu times out
# setting this to 0 deactivates the timeout
menu_timeout=6
# use youtube-dl to fetch a list of available formats (overrides quality_strings)
fetch_formats=yes
# list of ytdl-format strings to choose from
quality_strings_video=[ {"4320p" : "bestvideo[height<=?4320p]"}, {"2160p" : "bestvideo[height<=?2160]"}, {"1440p" : "bestvideo[height<=?1440]"}, {"1080p" : "bestvideo[height<=?1080]"}, {"720p" : "bestvideo[height<=?720]"}, {"480p" : "bestvideo[height<=?480]"}, {"360p" : "bestvideo[height<=?360]"}, {"240p" : "bestvideo[height<=?240]"}, {"144p" : "bestvideo[height<=?144]"} ]
quality_strings_audio=[ {"default" : "bestaudio"} ]
# show the video format menu after opening an url
start_with_menu=no
# include unknown formats in the list
# Unfortunately choosing which formats are video or audio is not always perfect.
# Set to true to make sure you don't miss any formats, but then the list
# might also include formats that aren't actually video or audio.
# Formats that are known to not be video or audio are still filtered out.
include_unknown=no
# hide columns that are identical for all formats
hide_identical_columns=yes
# which columns are shown in which order
# comma separated list, prefix column with "-" to align left
#
# for the uosc integration it is possible to split the text up into a title and a hint
# this is done by separating two columns with a "|" instead of a comma
# column order in the hint is reversed
#
# columns that might be useful are:
# resolution, width, height, fps, dynamic_range, tbr, vbr, abr, asr,
# filesize, filesize_approx, vcodec, acodec, ext, video_ext, audio_ext,
# language, format, format_note, quality
#
# columns that are derived from the above, but with special treatment:
# size, frame_rate, bitrate_total, bitrate_video, bitrate_audio,
# codec_video, codec_audio, audio_sample_rate
#
# If those still aren't enough or you're just curious, run:
# yt-dlp -j <url>
# This outputs unformatted JSON.
# Format it and look under "formats" to see what's available.
#
# Not all videos have all columns available.
# Be careful, misspelled columns simply won't be displayed, there is no error.
columns_video=-resolution,frame_rate,dynamic_range|language,bitrate_total,size,-codec_video,-codec_audio
columns_audio=audio_sample_rate,bitrate_total|size,language,-codec_audio
# columns used for sorting, see "columns_video" for available columns
# comma separated list, prefix column with "-" to reverse sorting order
# Leaving this empty keeps the order from yt-dlp/youtube-dl.
# Be careful, misspelled columns won't result in an error,
# but they might influence the result.
sort_video=height,fps,tbr,size,format_id
sort_audio=asr,tbr,size,format_id
================================================
FILE: quality-menu.lua
================================================
-- quality-menu 4.2.1 - 2025-Jun-29
-- https://github.com/christoph-heinrich/mpv-quality-menu
--
-- Change the stream video and audio quality on the fly.
--
-- Usage:
-- add bindings to input.conf:
-- F script-binding quality_menu/video_formats_toggle
-- Alt+f script-binding quality_menu/audio_formats_toggle
local mp = require 'mp'
local utils = require 'mp.utils'
local msg = require 'mp.msg'
local assdraw = require 'mp.assdraw'
local opt = require('mp.options')
local script_name = mp.get_script_name()
local opts = {
--key bindings
up_binding = 'UP WHEEL_UP',
down_binding = 'DOWN WHEEL_DOWN',
select_binding = 'ENTER MBTN_LEFT',
close_menu_binding = 'ESC MBTN_RIGHT',
--formatting / cursors
selected_and_active = '▶ - ',
selected_and_inactive = '● - ',
unselected_and_active = '▷ - ',
unselected_and_inactive = '○ - ',
--font size scales by window, if false requires larger font and padding sizes
scale_playlist_by_window = true,
--playlist ass style overrides inside curly brackets, \keyvalue is one field, extra \ for escape in lua
--example {\\fnUbuntu\\fs10\\b0\\bord1} equals: font=Ubuntu, size=10, bold=no, border=1
--read http://docs.aegisub.org/3.2/ASS_Tags/ for reference of tags
--undeclared tags will use default osd settings
--these styles will be used for the whole playlist. More specific styling will need to be hacked in
--
--(a monospaced font is recommended but not required)
style_ass_tags = '{\\fnmonospace\\fs25\\bord1}',
-- Shift drawing coordinates. Required for mpv.net compatiblity
shift_x = 0,
shift_y = 0,
--paddings from window edge
text_padding_x = 5,
text_padding_y = 10,
--Screen dim when menu is open
curtain_opacity = 0.7,
--how many seconds until the quality menu times out
--setting this to 0 deactivates the timeout
menu_timeout = 6,
--use youtube-dl to fetch a list of available formats (overrides quality_strings)
fetch_formats = true,
--list of ytdl-format strings to choose from
quality_strings_video = [[
[
{"4320p" : "bestvideo[height<=?4320p]"},
{"2160p" : "bestvideo[height<=?2160]"},
{"1440p" : "bestvideo[height<=?1440]"},
{"1080p" : "bestvideo[height<=?1080]"},
{"720p" : "bestvideo[height<=?720]"},
{"480p" : "bestvideo[height<=?480]"},
{"360p" : "bestvideo[height<=?360]"},
{"240p" : "bestvideo[height<=?240]"},
{"144p" : "bestvideo[height<=?144]"}
]
]],
quality_strings_audio = [[
[
{"default" : "bestaudio/best"}
]
]],
--show the video format menu after opening an url
start_with_menu = false,
--include unknown formats in the list
--Unfortunately choosing which formats are video or audio is not always perfect.
--Set to true to make sure you don't miss any formats, but then the list
--might also include formats that aren't actually video or audio.
--Formats that are known to not be video or audio are still filtered out.
include_unknown = false,
--hide columns that are identical for all formats
hide_identical_columns = true,
--which columns are shown in which order
--comma separated list, prefix column with "-" to align left
--
--for the uosc integration it is possible to split the text up into a title and a hint
--this is done by separating two columns with a "|" instead of a comma
--column order in the hint is reversed
--
--columns that might be useful are:
--resolution, width, height, fps, dynamic_range, tbr, vbr, abr, asr,
--filesize, filesize_approx, vcodec, acodec, ext, video_ext, audio_ext,
--language, format, format_note, quality
--
--columns that are derived from the above, but with special treatment:
--size, frame_rate, bitrate_total, bitrate_video, bitrate_audio,
--codec_video, codec_audio, audio_sample_rate
--
--If those still aren't enough or you're just curious, run:
--yt-dlp -j <url>
--This outputs unformatted JSON.
--Format it and look under "formats" to see what's available.
--
--Not all videos have all columns available.
--Be careful, misspelled columns simply won't be displayed, there is no error.
columns_video = '-resolution,frame_rate,dynamic_range|language,bitrate_total,size,-codec_video,-codec_audio',
columns_audio = 'audio_sample_rate,bitrate_total|size,language,-codec_audio',
--columns used for sorting, see "columns_video" for available columns
--comma separated list, prefix column with "-" to reverse sorting order
--Leaving this empty keeps the order from yt-dlp/youtube-dl.
--Be careful, misspelled columns won't result in an error,
--but they might influence the result.
sort_video = 'height,fps,tbr,size,format_id',
sort_audio = 'asr,tbr,size,format_id',
}
opt.read_options(opts, 'quality-menu')
---@alias Format { properties: {[string]: string}, id: string, label?: string, title?: string, hint?: string }
-- *_active_id == nil means unknown, *_active_id == '' means disabled
---@alias Data { video_formats: Format[], audio_formats: Format[], video_active_id?: string, audio_active_id?: string }
---@alias UIState { type: string, type_capitalized: string, name: string , to_other_type: UIState, to_fetching: UIState, to_menu: UIState, is_video: boolean }
do
---@param option_string string
---@param option_name string
---@return Format[]
local function parse_predefined(option_string, option_name)
---@type {[string]: string}[]
local json, error = utils.parse_json(option_string)
if error then
msg.error('Error while parsing JSON of option ' .. option_name .. ': ' .. error)
return {}
end
---@type Format[]
local formats = {}
for i, format in ipairs(json) do
local label, format_string = next(format)
formats[i] = {
label = label,
title = label,
id = format_string,
}
end
return formats
end
---@type Data
opts.predefined_data = {
video_formats = parse_predefined(opts.quality_strings_video, 'quality_strings_video'),
audio_formats = parse_predefined(opts.quality_strings_audio, 'quality_strings_audio'),
video_active_id = nil,
audio_active_id = nil,
}
end
opts.font_size = tonumber(opts.style_ass_tags:match('\\fs(%d+%.?%d*)')) or mp.get_property_number('osd-font-size') or 25
opts.curtain_opacity = math.max(math.min(opts.curtain_opacity, 1), 0)
---@param input string
---@param separator string
---@return string[]
local function string_split(input, separator)
if separator == nil then
separator = '%s'
end
local t = {}
for str in string.gmatch(input, '([^' .. separator .. ']+)') do
table.insert(t, str)
end
return t
end
---@param strings string[]
---@return string[], boolean[]
local function strip_minus(strings)
local stripped_list = {}
local had_minus = {}
for i, val in ipairs(strings) do
if string.sub(val, 1, 1) == '-' then
val = string.sub(val, 2)
had_minus[val] = true
end
stripped_list[i] = val
end
return stripped_list, had_minus
end
do
---@param column_definition string
---@return { all: string[], all_align_left: boolean[], title: string[], title_align_left: boolean[], hint?: string[] }
local function parse_columns(column_definition)
local columns, columns_align_left = strip_minus(string_split(column_definition, '|,'))
local title_hint = string_split(column_definition, '|')
local title, title_align_left = strip_minus(string_split(title_hint[1], ','))
local hint = nil
if title_hint[2] then
hint = strip_minus(string_split(title_hint[2], ','))
-- reverse column order
local n = #hint
for i = 1, n / 2 do
hint[i], hint[n - i + 1] = hint[n - i + 1], hint[i]
end
end
return {
all = columns, all_align_left = columns_align_left,
title = title, title_align_left = title_align_left,
hint = hint
}
end
---@type { all: string[], all_align_left: boolean[], title: string[], title_align_left: boolean[], hint?: string[] }
---@diagnostic disable-next-line: param-type-mismatch
opts.columns_video = parse_columns(opts.columns_video)
---@type { all: string[], all_align_left: boolean[], title: string[], title_align_left: boolean[], hint?: string[] }
---@diagnostic disable-next-line: param-type-mismatch
opts.columns_audio = parse_columns(opts.columns_audio)
end
-- special thanks to reload.lua (https://github.com/4e6/mpv-reload/)
local function reload_resume()
local reload_duration = mp.get_property_native('duration')
local time_pos = mp.get_property('time-pos')
mp.command('playlist-play-index current')
-- Tries to determine live stream vs. pre-recorded VOD. VOD has non-zero
-- duration property. When reloading VOD, to keep the current time position
-- we should provide offset from the start. Stream doesn't have fixed start.
-- Decent choice would be to reload stream from it's current 'live' position.
-- That's the reason we don't pass the offset when reloading streams.
if reload_duration and reload_duration > 0 and time_pos then
local function seeker()
mp.commandv('seek', time_pos, 'absolute+exact')
mp.unregister_event(seeker)
end
mp.register_event('file-loaded', seeker)
end
end
---@type { video_menu: UIState, audio_menu: UIState, video_fetching: UIState, audio_fetching: UIState }
local states = {
video_menu = { type = 'video', type_capitalized = 'Video', name = 'video_menu', is_video = true },
audio_menu = { type = 'audio', type_capitalized = 'Audio', name = 'audio_menu', is_video = false },
video_fetching = { type = 'video', type_capitalized = 'Video', name = 'video_fetching', is_video = true },
audio_fetching = { type = 'audio', type_capitalized = 'Audio', name = 'audio_fetching', is_video = false },
}
states.video_menu.to_fetching = states.video_fetching
states.video_menu.to_menu = states.video_menu
states.video_menu.to_other_type = states.audio_menu
states.audio_menu.to_fetching = states.audio_fetching
states.audio_menu.to_menu = states.audio_menu
states.audio_menu.to_other_type = states.video_menu
states.video_fetching.to_fetching = states.video_fetching
states.video_fetching.to_menu = states.video_menu
states.video_fetching.to_other_type = states.audio_fetching
states.audio_fetching.to_fetching = states.audio_fetching
states.audio_fetching.to_menu = states.audio_menu
states.audio_fetching.to_other_type = states.video_fetching
---@type UIState | nil
local open_menu_state = nil
---@type string | nil
local current_url = nil
---@type function | nil
local destructor = nil
local menu_open
local menu_close
local video_formats_toggle
local audio_formats_toggle
local osd = mp.create_osd_overlay('ass-events')
local function hide_osd()
-- workaround mpv bug, setting to hidden does not cause a redraw
-- https://github.com/mpv-player/mpv/issues/10227
osd.data = ''
osd:update()
osd.hidden = true
osd:update()
end
local osd_timer = mp.add_timeout(1, function() menu_close() end)
osd_timer:kill()
---@param message string
---@param time number
local function osd_message(message, time)
osd.res_x = 1280
osd.res_y = 720
osd.hidden = false
osd.data = message
osd:update()
osd_timer.timeout = time
osd_timer:kill()
osd_timer:resume()
end
---@alias FormatRaw {format_id: string, vcodec?: string, acodec?: string, filesize: integer?, filesize_approx?: integer, fps?: number, tbr?: number, vbr?: number, abr?: number, asr?: number}
---@param json {formats: FormatRaw[], requested_formats: FormatRaw, requested_downloads: FormatRaw}
---@return Data
local function process_json(json)
---@param format FormatRaw
---@return boolean
local function is_video(format)
-- 'none' means it is not a video
-- nil means it is unknown
return (opts.include_unknown or format.vcodec) and format.vcodec ~= 'none' or false
end
---@param format FormatRaw
---@return boolean
local function is_audio(format)
return (opts.include_unknown or format.acodec) and format.acodec ~= 'none' or false
end
local requested_video = nil
local requested_audio = nil
local requested_formats = json.requested_formats or json.requested_downloads or {}
for _, format in ipairs(requested_formats) do
if is_video(format) then
requested_video = format.format_id
elseif is_audio(format) then
requested_audio = format.format_id
end
end
local video_formats = {}
local audio_formats = {}
local all_formats = {}
for i = #json.formats, 1, -1 do
local format = json.formats[i]
if is_video(format) then
video_formats[#video_formats + 1] = format
all_formats[#all_formats + 1] = format
elseif is_audio(format) then
audio_formats[#audio_formats + 1] = format
all_formats[#all_formats + 1] = format
end
end
---@param format FormatRaw
local function populate_special_fields(format)
format.size = format.filesize or format.filesize_approx
format.frame_rate = format.fps
format.bitrate_total = format.tbr
format.bitrate_video = format.vbr
format.bitrate_audio = format.abr
format.codec_video = format.vcodec
format.codec_audio = format.acodec
format.audio_sample_rate = format.asr
end
for _, format in ipairs(all_formats) do
populate_special_fields(format)
end
local sort_video, reverse_video = strip_minus(string_split(opts.sort_video, ','))
local sort_audio, reverse_audio = strip_minus(string_split(opts.sort_audio, ','))
---@param properties string[]
---@param reverse {[string]: boolean}
---@return fun(a: FormatRaw, b: FormatRaw): boolean
local function comp(properties, reverse)
return function(a, b)
for _, prop in ipairs(properties) do
local a_val = a[prop]
local b_val = b[prop]
if a_val and b_val and type(a_val) ~= 'table' and a_val ~= b_val then
if reverse[prop] then
return a_val < b_val
else
return a_val > b_val
end
end
end
return false
end
end
if #sort_video > 0 then
table.sort(video_formats, comp(sort_video, reverse_video))
end
if #sort_audio > 0 then
table.sort(audio_formats, comp(sort_audio, reverse_audio))
end
---@param size integer
---@return string
local function scale_filesize(size)
if size == nil then
return ''
end
local counter = 0
while size > 1024 do
size = size / 1024
counter = counter + 1
end
if counter >= 3 then return string.format('%.1fGiB', size)
elseif counter >= 2 then return string.format('%.1fMiB', size)
elseif counter >= 1 then return string.format('%.1fKiB', size)
else return string.format('%.1fB ', size)
end
end
---@param bitrate integer
---@return string
local function scale_bitrate(bitrate)
if bitrate == nil then
return ''
end
local counter = 0
while bitrate > 1000 do
bitrate = bitrate / 1000
counter = counter + 1
end
if counter >= 2 then return string.format('%.1fGbps', bitrate)
elseif counter >= 1 then return string.format('%.1fMbps', bitrate)
else return string.format('%.1fKbps', bitrate)
end
end
---@param format FormatRaw
local function format_special_fields(format)
local size_prefix = not format.filesize and format.filesize_approx and '~' or ''
---@diagnostic disable-next-line: param-type-mismatch
format.size = (size_prefix) .. scale_filesize(format.size)
format.frame_rate = format.fps and format.fps .. 'fps' or ''
format.bitrate_total = scale_bitrate(format.tbr)
format.bitrate_video = scale_bitrate(format.vbr)
format.bitrate_audio = scale_bitrate(format.abr)
format.codec_video = format.vcodec == nil and 'unknown' or format.vcodec == 'none' and '' or format.vcodec
format.codec_audio = format.acodec == nil and 'unknown' or format.acodec == 'none' and '' or format.acodec
format.audio_sample_rate = format.asr and tostring(format.asr) .. 'Hz' or ''
end
for _, format in ipairs(all_formats) do
format_special_fields(format)
end
---@param raw_formats { [string]: any }
---@param properties string[]
---@return Format[]
local function convert_to_format(raw_formats, properties)
---@type Format[]
local formats = {}
for i, format in ipairs(raw_formats) do
local props = {}
for _, prop in ipairs(properties) do
props[prop] = tostring(format[prop] or '')
end
formats[i] = { properties = props, id = format.format_id }
end
return formats
end
return {
video_formats = convert_to_format(video_formats, opts.columns_video.all),
audio_formats = convert_to_format(audio_formats, opts.columns_audio.all),
video_active_id = requested_video,
audio_active_id = requested_audio,
}
end
---@return string | nil
local function get_url()
local path, n = mp.get_property('path'), nil
if not path then return nil end
path, n = path:gsub('^ytdl://', '') -- Strip possible ytdl:// prefix.
if n > 0 then return path end
---@param str string
---@return boolean
local function is_url(str)
-- adapted the regex from
-- https://stackoverflow.com/questions/3809401/what-is-a-good-regular-expression-to-match-a-url
return nil ~=
str:match(
'^[%w]-://[-a-zA-Z0-9@:%._\\+~#=]+%.' ..
'[a-zA-Z0-9()][a-zA-Z0-9()]?[a-zA-Z0-9()]?[a-zA-Z0-9()]?[a-zA-Z0-9()]?[a-zA-Z0-9()]?' ..
'[-a-zA-Z0-9()@:%_\\+.~#?&/=]*')
end
return is_url(path) and path or nil
end
local uosc_available = false
---@type { [string]: Data }
local url_data = {}
local function uosc_set_format_counts()
if not uosc_available then return end
local data = url_data[current_url]
if data then
mp.commandv('script-message-to', 'uosc', 'set', 'vformats', #data.video_formats)
mp.commandv('script-message-to', 'uosc', 'set', 'aformats', #data.audio_formats)
else
mp.commandv('script-message-to', 'uosc', 'set', 'vformats', 0)
mp.commandv('script-message-to', 'uosc', 'set', 'aformats', 0)
end
end
---@param json string
---@return Data | nil
local function process_json_string(json)
local json_table, err = utils.parse_json(json)
if (json_table == nil) then
osd_message('fetching formats failed...', 2)
if err == nil then err = 'unexpected error occurred' end
msg.error('failed to parse JSON data: ' .. err)
return
end
if json_table.formats == nil then
return
end
return process_json(json_table)
end
---Unknown format falls back on highest ranked format if possible
---@param id string | nil
---@param formats Format[]
---@return string
local function sanitize_format_id(id, formats)
return id or (formats[1] or {}).id or ''
end
---@param video_id string
---@param audio_id string
---@return string
local function format_string(video_id, audio_id)
if #video_id > 0 and #audio_id > 0 then
return video_id .. '+' .. audio_id
elseif #video_id > 0 then
return video_id
elseif #audio_id > 0 then
return audio_id
else
return ''
end
end
---@param url string
---@param video_format string
---@param audio_format string
local function set_format(url, video_format, audio_format)
if (url_data[url].video_active_id ~= video_format or url_data[url].audio_active_id ~= audio_format) then
url_data[url].video_active_id = video_format
url_data[url].audio_active_id = audio_format
if url == mp.get_property('path') then reload_resume() end
end
end
---@param formats Format[]
---@param active_format string | nil
---@param menu_type UIState
local function text_menu_open(formats, active_format, menu_type)
local active = 0
local selected = 1
--set the cursor to the current format
for i, format in ipairs(formats) do
if format.id == active_format then
active = i
selected = active
break
end
end
if active_format == '' then
active = #formats + 1
selected = active
end
---@param i integer
---@return string
local function choose_prefix(i)
if i == selected and i == active then return opts.selected_and_active
elseif i == selected then return opts.selected_and_inactive end
if i ~= selected and i == active then return opts.unselected_and_active
elseif i ~= selected then return opts.unselected_and_inactive end
return '> ' --shouldn't get here.
end
local width, height
local margin_top, margin_bottom = 0, 0
local num_options = #formats > 0 and #formats + 2 or 1
---@return integer
local function get_scrolled_lines()
local output_height = height - opts.text_padding_y * 2 - margin_top * height - margin_bottom * height
local screen_lines = math.max(math.floor(output_height / opts.font_size), 1)
local max_scroll = math.max(num_options - screen_lines, 0)
return math.min(math.max(selected - math.ceil(screen_lines / 2), 0), max_scroll)
end
local function draw_menu()
local ass = assdraw.ass_new()
if opts.curtain_opacity > 0 then
local alpha = 255 - math.ceil(255 * opts.curtain_opacity)
ass.text = string.format('{\\pos(0,0)\\rDefault\\an7\\1c&H000000&\\alpha&H%X&}', alpha)
ass:draw_start()
ass:rect_cw(0, 0, width, height)
ass:draw_stop()
ass:new_event()
end
local scrolled_lines = get_scrolled_lines()
local pos_y = opts.shift_y + margin_top * height + opts.text_padding_y - scrolled_lines * opts.font_size
ass:pos(opts.shift_x + opts.text_padding_x, pos_y)
local clip_top = math.floor(margin_top * height + 0.5)
local clip_bottom = math.floor((1 - margin_bottom) * height + 0.5)
local clipping_coordinates = '0,' .. clip_top .. ',' .. width .. ',' .. clip_bottom
ass:append('{\\rDefault\\an7\\q2\\clip(' .. clipping_coordinates .. ')}' .. opts.style_ass_tags)
if #formats > 0 then
for i, format in ipairs(formats) do
ass:append(choose_prefix(i) .. format.label .. '\\N')
end
ass:append(choose_prefix(#formats + 1) .. 'Disabled\\N')
ass:append(choose_prefix(#formats + 2) .. menu_type.to_other_type.type_capitalized .. ' menu')
else
ass:append('no formats found\\N')
ass:append(opts.selected_and_inactive .. menu_type.to_other_type.type_capitalized .. ' menu')
end
osd.data = ass.text
osd:update()
end
local function update_dimensions()
local _, h, aspect = mp.get_osd_size()
if opts.scale_playlist_by_window then h = 720 end
height = h
width = height * aspect
osd.res_y = height
osd.res_x = width
draw_menu()
end
local update_margins = function(_, val)
if not val then
val = mp.get_property_native('user-data/osc/margins')
end
if val then
margin_top = val.t
margin_bottom = val.b
else
margin_top = 0
margin_bottom = 0
end
draw_menu()
end
mp.observe_property('user-data/osc/margins', 'native', update_margins)
update_dimensions()
update_margins()
mp.observe_property('osd-dimensions', 'native', update_dimensions)
---@param amount integer
local function selected_move(amount)
selected = selected + amount
if selected < 1 then selected = num_options
elseif selected > num_options then selected = 1 end
if osd_timer then
osd_timer:kill()
osd_timer:resume()
end
draw_menu()
end
---@param keys string | nil
---@param name string
---@param func function
---@param opts table | nil
local function bind_keys(keys, name, func, opts)
if not keys then
mp.add_forced_key_binding(keys, name, func, opts)
return
end
local i = 1
for key in keys:gmatch('[^%s]+') do
local prefix = i == 1 and '' or i
mp.add_forced_key_binding(key, name .. prefix, func, opts)
i = i + 1
end
end
---@param keys string | nil
---@param name string
local function unbind_keys(keys, name)
if not keys then
mp.remove_key_binding(name)
return
end
local i = 1
for key in keys:gmatch('[^%s]+') do
local prefix = i == 1 and '' or i
mp.remove_key_binding(name .. prefix)
i = i + 1
end
end
-- make sure observers are cleaned up
if open_menu_state and open_menu_state == open_menu_state.to_menu and destructor then destructor() end
destructor = function()
unbind_keys(opts.up_binding, 'move_up')
unbind_keys(opts.down_binding, 'move_down')
unbind_keys(opts.select_binding, 'select')
unbind_keys(opts.close_menu_binding, 'close')
mp.unobserve_property(update_dimensions)
mp.unobserve_property(update_margins)
end
osd_timer:kill()
if opts.menu_timeout > 0 then
osd_timer.timeout = opts.menu_timeout
osd_timer:resume()
end
bind_keys(opts.up_binding, 'move_up', function() selected_move( -1) end, { repeatable = true })
bind_keys(opts.down_binding, 'move_down', function() selected_move(1) end, { repeatable = true })
bind_keys(opts.close_menu_binding, 'close', menu_close)
bind_keys(opts.select_binding, 'select', function()
if selected == num_options then
mp.unobserve_property(update_dimensions)
mp.unobserve_property(update_margins)
if menu_type.is_video then audio_formats_toggle()
else video_formats_toggle() end
return
end
menu_close()
if selected == active then return end
if current_url == nil then return end
local video_id, audio_id
local id = formats[selected] and formats[selected].id or ''
local data = url_data[current_url]
if menu_type.is_video then
video_id = id
audio_id = sanitize_format_id(data.audio_active_id, data.audio_formats)
else
video_id = sanitize_format_id(data.video_active_id, data.video_formats)
audio_id = id
end
set_format(current_url, video_id, audio_id)
end)
osd.hidden = false
draw_menu()
end
---@param menu table
---@param menu_type UIState
local function uosc_show_menu(menu, menu_type)
local json = utils.format_json(menu)
-- always using update wouldn't work, because it doesn't support the on_close command
-- therefore opening a different kind requires `open-menu`
-- while updating the same kind requires `update-menu`
if open_menu_state == menu_type then mp.commandv('script-message-to', 'uosc', 'update-menu', json)
else mp.commandv('script-message-to', 'uosc', 'open-menu', json) end
end
---@param formats Format[]
---@param active_format string | nil
---@param menu_type UIState
local function uosc_menu_open(formats, active_format, menu_type)
local menu = {
title = menu_type.type_capitalized .. ' Formats',
items = {},
type = 'quality-menu-' .. menu_type.name,
keep_open = true,
on_close = {
'script-message-to',
script_name,
'uosc-menu-closed',
menu_type.name,
}
}
menu.items[#menu.items + 1] = {
title = menu_type.to_other_type.type_capitalized,
italic = true,
bold = true,
hint = 'open menu',
value = {
'script-message-to',
script_name,
menu_type.to_other_type.type .. '_formats_toggle',
},
}
menu.items[#menu.items + 1] = {
title = 'Disabled',
italic = true,
muted = true,
hint = '—',
active = active_format == '',
value = {
'script-message-to',
script_name,
menu_type.type .. '-format-set',
current_url,
'',
}
}
for _, format in ipairs(formats) do
menu.items[#menu.items + 1] = {
title = format.title,
hint = format.hint,
active = format.id == active_format,
value = {
'script-message-to',
script_name,
menu_type.type .. '-format-set',
current_url,
format.id,
}
}
end
uosc_show_menu(menu, menu_type)
destructor = function()
mp.commandv('script-message-to', 'uosc', 'close-menu', menu.type)
end
end
---Check if property is same for all formats
---@param formats Format[]
---@param properties string[]
---@return { [string]: boolean }
local function identical_for_all(formats, properties)
---@param formats Format[]
---@param prop string
---@return boolean
local function all_formats_same_value(formats, prop)
local first_value = nil
for _, format in ipairs(formats) do
first_value = first_value or format.properties[prop]
if format.properties[prop] ~= first_value then return false end
end
return true
end
local identical_props = {}
for _, prop in ipairs(properties) do
identical_props[prop] = all_formats_same_value(formats, prop)
end
return identical_props
end
---@param formats Format[]
---@param columns string[]
---@param column_align_left boolean[]
---@return string[]
local function format_table(formats, columns, column_align_left)
local column_widths = {}
for _, format in pairs(formats) do
for col, prop in ipairs(columns) do
local width = format.properties[prop]:len()
if not column_widths[col] or column_widths[col] < width then
column_widths[col] = width
end
end
end
local identical_columns = #formats < 2 and {} or identical_for_all(formats, columns)
local show_columns = {}
for i, width in ipairs(column_widths) do
local prop = columns[i]
if width > 0 and not (opts.hide_identical_columns and identical_columns[prop]) then
show_columns[#show_columns + 1] = {
prop = prop,
width = width,
align_left = column_align_left[prop]
}
end
end
local spacing = 2
---@type string[]
local rows = {}
for i, format in ipairs(formats) do
local row = {}
for j, column in ipairs(show_columns) do
-- lua errors out with width > 99 ("invalid conversion specification")
local width = math.min(column.width * (column.align_left and -1 or 1), 99)
row[j] = string.format('%' .. width .. 's', format.properties[column.prop] or '')
end
rows[i] = table.concat(row, string.format('%' .. spacing .. 's', '')):gsub('%s+$', '')
end
return rows
end
---@param formats Format[]
---@param columns string[]
---@return string[]
local function format_csv(formats, columns)
local identical_props = #formats < 2 and {} or identical_for_all(formats, columns)
local hints = {}
for i, format in ipairs(formats) do
local row = {}
for _, prop in ipairs(columns) do
local val = format.properties[prop]
if #val > 0 and not (opts.hide_identical_columns and identical_props[prop]) then
row[#row + 1] = val
end
end
hints[i] = table.concat(row, ', ')
end
return hints
end
---@param formats Format[]
---@param menu_type UIState
local function ensure_menu_data_filled(formats, menu_type)
if uosc_available then
if formats[1] and formats[1].title == nil then
local columns = menu_type.is_video and opts.columns_video or opts.columns_audio
local titles = format_table(formats, columns.title, columns.title_align_left)
local hints = {}
if columns.hint then
hints = format_csv(formats, columns.hint)
end
for i, format in ipairs(formats) do
format.title = titles[i]
format.hint = hints[i]
end
end
else
if formats[1] and formats[1].label == nil then
local columns = menu_type.is_video and opts.columns_video or opts.columns_audio
local labels = format_table(formats, columns.all, columns.all_align_left)
for i, format in ipairs(formats) do format.label = labels[i] end
end
end
end
---@param menu_type UIState
local function loading_message(menu_type)
menu_type = menu_type.to_fetching
if uosc_available then
if open_menu_state and open_menu_state == menu_type then return end
local menu = {
title = menu_type.type_capitalized .. ' Formats',
items = { { icon = 'spinner', selectable = false, value = 'ignore' } },
type = 'quality-menu-' .. menu_type.name,
keep_open = true,
on_close = {
'script-message-to',
script_name,
'uosc-menu-closed',
menu_type.name
}
}
uosc_show_menu(menu, menu_type)
destructor = function()
mp.commandv('script-message-to', 'uosc', 'close-menu', menu.type)
end
else
osd_message('fetching available ' .. menu_type.type .. ' formats...', 60)
end
open_menu_state = menu_type
end
---@param menu_type UIState
function menu_open(menu_type)
if not current_url then return end
menu_type = menu_type.to_menu
local data = url_data[current_url]
if not data then
if opts.fetch_formats then
loading_message(menu_type)
return
end
-- shallow clone so that each url has it's own active format ids
data = {}
for k, v in pairs(opts.predefined_data) do
data[k] = v
end
url_data[current_url] = data
end
local formats = menu_type.is_video and data.video_formats or data.audio_formats
local active_format
if menu_type.is_video then active_format = data.video_active_id
else active_format = data.audio_active_id end
msg.verbose('current ytdl-format: ' .. mp.get_property('ytdl-format', ''))
ensure_menu_data_filled(formats, menu_type)
if uosc_available then uosc_menu_open(formats, active_format, menu_type)
else text_menu_open(formats, active_format, menu_type) end
open_menu_state = menu_type
end
function menu_close()
if destructor then
destructor()
destructor = nil
end
if not osd.hidden then hide_osd() end
open_menu_state = nil
end
---@param menu_type UIState
local function toggle_menu(menu_type)
if open_menu_state and open_menu_state.type == menu_type.type then
menu_close()
return
end
if current_url == nil then
if uosc_available then
if menu_type.is_video then
mp.commandv('script-binding', 'uosc/video')
else
mp.commandv('script-binding', 'uosc/audio')
end
end
return
end
menu_open(menu_type)
end
function video_formats_toggle() toggle_menu(states.video_menu) end
function audio_formats_toggle() toggle_menu(states.audio_menu) end
-- keybind to launch menu
mp.add_key_binding(nil, 'video_formats_toggle', video_formats_toggle)
mp.add_key_binding(nil, 'audio_formats_toggle', audio_formats_toggle)
mp.add_key_binding(nil, 'reload', reload_resume)
mp.register_event('start-file', function()
local new_url = get_url()
local url_changed = current_url ~= new_url
current_url = new_url
uosc_set_format_counts()
-- new path isn't an url
if not new_url then return menu_close() end
-- open or update menu
if opts.start_with_menu and url_changed or open_menu_state then
menu_open(open_menu_state or states.video_menu)
end
end)
-- run before ytdl_hook, which uses a priority of 10
mp.add_hook('on_load', 9, function()
local path = mp.get_property('path')
local data = url_data[path]
if not (data and data.video_active_id and data.audio_active_id) then return end
local format = format_string(data.video_active_id, data.audio_active_id)
msg.verbose('setting ytdl-format: ' .. format)
mp.set_property('file-local-options/ytdl-format', format)
end)
---@param url string
---@param format_id string
mp.register_script_message('video-format-set', function(url, format_id)
menu_close()
local data = url_data[url]
set_format(url, format_id, sanitize_format_id(data.audio_active_id, data.audio_formats))
end)
---@param url string
---@param format_id string
mp.register_script_message('audio-format-set', function(url, format_id)
menu_close()
local data = url_data[url]
set_format(url, sanitize_format_id(data.video_active_id, data.video_formats), format_id)
end)
--- check if uosc is running
---@param version string
mp.register_script_message('uosc-version', function(version)
---Like the comperator for table.sort, this returns v1 < v2
---Assumes two valid semver strings
---@param v1 string
---@param v2 string
---@return boolean
local function semver_comp(v1, v2)
local v1_iterator = v1:gmatch('%d+')
local v2_iterator = v2:gmatch('%d+')
for v2_num_str in v2_iterator do
local v1_num_str = v1_iterator()
if not v1_num_str then return true end
local v1_num = tonumber(v1_num_str)
local v2_num = tonumber(v2_num_str)
if v1_num < v2_num then return true end
if v1_num > v2_num then return false end
end
return false
end
local min_version = '4.6.0'
uosc_available = not semver_comp(version, min_version)
if not uosc_available then return end
uosc_set_format_counts()
mp.commandv(
'script-message-to',
'uosc',
'overwrite-binding',
'stream-quality',
'script-binding ' .. script_name .. '/video_formats_toggle'
)
---@param name string
mp.register_script_message('uosc-menu-closed', function(name)
-- got closed from the uosc side
if open_menu_state and open_menu_state.name == name then
destructor = nil
menu_close()
end
end)
end)
mp.commandv('script-message-to', 'uosc', 'get-version', mp.get_script_name())
mp.observe_property('user-data/mpv/ytdl/json-subprocess-result', 'native', function(_, ytdl_result)
if not ytdl_result then
-- property gets deleted in on_after_end_file hook
return
end
if not current_url then
osd_message('current_url is nil', 2)
msg.error('current_url is nil')
return
end
local json = ytdl_result.stdout
if ytdl_result.status ~= 0 or json == '' then
json = nil
osd_message('fetching formats failed...', 2)
elseif json then
---@type Data | nil
local data = url_data[current_url]
if data == nil then
data = process_json_string(json)
url_data[current_url] = data
uosc_set_format_counts()
end
if not data then return end
if open_menu_state and open_menu_state == open_menu_state.to_fetching then
menu_open(open_menu_state)
end
end
end)
gitextract_9oc7bwb2/ ├── LICENSE.md ├── README.md ├── osc.patch ├── quality-menu-osc.lua ├── quality-menu.conf └── quality-menu.lua
Condensed preview — 6 files, each showing path, character count, and a content snippet. Download the .json file or copy for the full structured content (181K chars).
[
{
"path": "LICENSE.md",
"chars": 18092,
"preview": " GNU GENERAL PUBLIC LICENSE\n Version 2, June 1991\n\n Copyright (C) 1989, 1991 Fr"
},
{
"path": "README.md",
"chars": 4381,
"preview": "# quality-menu\nA userscript for MPV that allows you to change the streamed video and audio quality (ytdl-format) on the "
},
{
"path": "osc.patch",
"chars": 1181,
"preview": "diff --git a/../mpv/player/lua/osc.lua b/osc.lua\nindex 6132aa9..5c73229 100644\n--- a/osc.lua\n+++ b/osc.lua\n@@ -1711,6 +1"
},
{
"path": "quality-menu-osc.lua",
"chars": 105785,
"preview": "local assdraw = require 'mp.assdraw'\nlocal msg = require 'mp.msg'\nlocal opt = require 'mp.options'\n\n--\n-- Parameters\n--\n"
},
{
"path": "quality-menu.conf",
"chars": 3926,
"preview": "# KEY BINDINGS\n\n# move the menu cursor up\nup_binding=UP WHEEL_UP\n# move the menu cursor down\ndown_binding=DOWN WHEEL_DOW"
},
{
"path": "quality-menu.lua",
"chars": 40763,
"preview": "-- quality-menu 4.2.1 - 2025-Jun-29\n-- https://github.com/christoph-heinrich/mpv-quality-menu\n--\n-- Change the stream vi"
}
]
About this extraction
This page contains the full source code of the christoph-heinrich/mpv-quality-menu GitHub repository, extracted and formatted as plain text for AI agents and large language models (LLMs). The extraction includes 6 files (170.0 KB), approximately 44.3k tokens. Use this with OpenClaw, Claude, ChatGPT, Cursor, Windsurf, or any other AI tool that accepts text input. You can copy the full output to your clipboard or download it as a .txt file.
Extracted by GitExtract — free GitHub repo to text converter for AI. Built by Nikandr Surkov.