summaryrefslogtreecommitdiffstats
path: root/DOCS/man/osc.rst
Commit message (Collapse)AuthorAgeFilesLines
* DOCS/man: refer to "mp.options functions" for script config docsnanahi12 days1-16/+3
| | | | | | | | | | | Currently they refer to the OSC documentation. However, the "mp.options functions" already documents that, is more detailed, and does not contain false statements like "there may be no spaces around the ``=`` or anywhere else" (the primitive parser does not care about them, so starting a string option value with spaces is perfectly fine). Change them to refer to "mp.options functions" and remove the redundant section in the OSC documentation.
* osc: add playlist_media_title optionsunpenghao2024-04-171-0/+7
| | | | | | Showing media titles in the playlist is pointless when sources are ill tagged and media titles contain only garbage. Being able to opt for file names at least gives us a choice in such cases.
* osc.lua: escape textGuido Cella2024-03-211-1/+1
| | | | | | | | | | | | | | | | | | | | Escape all messages in osc.lua, because other than the title they weren't being escaped at all. If for example you did mpv foo.mp4 '{\fs50}bar.mp4' and script-message osc-playlist, it would just render the second entry as bar.mp4 in big text. The title was escaped partially, now the escaping is complete because: - It escapes \. Backslashes at the end of the title are escaped instead of being stripped, and \n, \N and \h are now printed verbatim. In particular, "\\n" is no longer converted to space and is printed verbatim instead which is more correct. - Newlines ("\n", not the "\\n" escape sequence) are converted to spaces instead of rendering them and messing up the text positioning within the OSC. - Spaces at the start are preserved. Fixes #11209, fixes #11275.
* osc: add osc-windowcontrols_title optionDudemanguy2024-01-221-0/+7
| | | | | This allows the title shown with the windowcontrols to be controlled separately from the normal osc title. Fixes #13295.
* osc: allow disabling special mouse wheel behaviorDudemanguy2023-12-211-0/+7
| | | | | | | | When hovering certain elements over the OSC, using the mouse wheel can result in special commands (such as seeking, changing audio tracks, etc.) Not everyone neccessarily wants this feature, so add an option to make it possible to disable all of it. Maybe more fine-tuned control would be more ideal, but probably not worth it. Fixes #13096.
* Revert "OSC: Remove merriment"Niklas Haas2023-12-131-0/+5
| | | | | This reverts commit af2635d8c9389504cb0b07a78f3999096d80a1ab, and restores feature parity with VLC.
* OSC: Remove merrimentMia Herkt2023-12-131-5/+0
| | | | | | | | | | | | | I honestly don’t care either way but I also don’t believe this innocent and cute hat is worth repeatedly having people show up on the issue tracker to aggressively virtue signal and then shit-talk the project elsewhere when their “concerns” are ignored and made fun of. For the record, I approve of neither brand of childish nonsense. If your workflow depends on December festivities, feel free to use an alternative OSC implementation. Fixes #13082 and #9548
* osc: add scrolling to audio/sub buttonsllyyr2023-09-171-0/+1
| | | | Consistent with other osc buttons now
* osc: add scrolling to the seekbarNRK2023-09-021-0/+1
| | | | | | the osc currently allows for changing volume via scrolling when on top of the volume icon. this does the same thing for the seekbar by allowing seeking via scroll.
* osc: support speed-independent time-remaiing displayDave2023-08-111-0/+7
| | | | | The new OSC config option "remaining_playtime" controls whether the time-remaining display considers speed (yes - default) or ignores it.
* various: fix various typos in the code baseAlexander Seiler2023-03-281-1/+1
| | | | Signed-off-by: Alexander Seiler <seileralex@gmail.com>
* osc.lua: add osc-tcspace script optionRyan Hendrickson2022-07-191-0/+8
| | | | | | | | | | Generally, the hard-coded sizes used for the OSC elements are comfortable regardless of the font used, but the timecode fields have relatively many characters, and so are affected to a greater degree by fonts with a wider or narrower average character width than expected. This allow users to adjust the space reserved for the timecode fields to compensate.
* osc.lua: add osc-unicodeminus script optionRyan Hendrickson2022-07-191-0/+6
| | | | | | This option enables the use of the Unicode U+2212 Minus Sign character when displaying the time remaining, instead of "-" (U+002D Hyphen-Minus).
* DOCS/osc: fix option "showidlescreen" -> "idlescreen"dyphire2022-07-011-1/+1
| | | | This option was added in mpv-player@ec236f7, but its name in the document description is incorrect
* osc.lua: add idlescreen and osc-idlescreenDudemanguy2022-06-041-0/+9
| | | | | | | | | | | | | | | This is mainly for other user scripts that may conflict with the osc logo in some way. Although it is possible to listen for shared-script-properties, this has many edge cases that could easily pop up. A user could want other OSC things to happen at the same time (say osc-message). They just don't want the logo. The idlescreen option disables all idlescreen related things (including the santa hat) if it is set to "no". A new script message (osc-idlescreen) is also added so users can easily toggle the value (passing "cycle" or just explictly setting "yes" or "no"). Some more discussion on this is found in the below github issues. https://github.com/mpv-player/mpv/issues/10201 https://github.com/CogentRedTester/mpv-file-browser/issues/55
* osc: add options: chapters/playlist OSD, hover chapter formatAvi Halachmi (:avih)2021-11-251-0/+14
| | | | | | | | | | | Previously OSD was always displayed on {ch,pl}_{next,prev} left-click, and seekbar-hover-chapter was always enabled and with fixed format. Now it can be controlled with: - chapters_osd, playlist_osd: yes/no (only affects left-click). - chapter_fmt: lua string.format template, or "no" to disable. Fixes #4675
* DOCS: fix typo on seekbarkeyframeshooke0072021-06-241-6/+6
|
* osc: seekbar hover/drag: display target chapter at the titleAvi Halachmi (:avih)2021-06-221-1/+2
| | | | Fixes #8925
* osc: update chapter marker positions when duration changesSagnac2021-06-161-0/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | Commit 6abb7e3 updates the markers when the chapters change, but it doesn't update their relative position at the bar when the duration changes. This means that adding chapters to a live stream would result in corresponding chapter markers which were static while the duration changed and thus their positions became incorrect over time until the OSC was reinitialized. This is fixed by observing the duration property if chapters are present and reinitializing the OSC when the duration changes. The live_markers user option, which determines whether the duration property is observed when there are chapters, has been added in order to allow disabling this behaviour as calling request_init() frequently might have some impact on low-end systems. The impact of request_init() on render() was measured to increase from 1-1.5 ms to 2-3 ms on a 2010 MacBook Air, while the impact was neglible on a 2016 Surface Book (increasing only to an average of 1.4 ms from 1.3 ms for n=1500 render cycles). The live_markers option is enabled by default.
* manpage: clarify requirements for boxvideoDudemanguy2020-08-041-1/+2
| | | | The osc must not auto-hide for this option to do anything.
* osc: use default hr-seek when dragging progress bar to seekwm42020-02-281-5/+6
| | | | | | | The "seekbarkeyframes" option is now interpreted such if it's true, the player default is used. Too lazy to make this a choice option or whatever; the Lua option parser doesn't have support for that anyway. Someone who cares can adjust this.
* osc: add option to disable santa hatNicolas F2019-12-231-0/+5
| | | | | | | | | | A minority of users have expressed a dislike of hats, calling them "cancer [that] don't belong in software" describing the people who add them as "shitty circlejerks" and "chucklefuck." While I personally disagree with those opinions, it's probably easier to let them have it their way. For that reason this adds the option `greenandgrumpy` to the osc, which allows users to disable the hat.
* manpage: document that --vo=xv breaks "boxvideo"wm42019-12-231-0/+3
| | | | (OK, maybe a bit redundant, since vo=xv breaks a lot of stuff.)
* osc: rework window control configuration to add auto modePhilip Langdale2019-12-041-1/+7
| | | | | | | | | | | | | | | | To aid in discoverability, and to address the most common case directly, I'm adding an 'auto' mode for the window controls. In this case, we will show the controls if there is no window border and hide them if there are borders. This also respects the option being toggled at runtime. To ensure that it works in the wayland case, I've also made sure that the wayland code explicitly forces the option to false if decoration support is missing. Based on feedback, I've split the config in two, with one option for whether controls are active, and one for alignment. These are new enough that we can get away with ignoring compatibility.
* osc: apply boxvideo margins to the window controlsPhilip Langdale2019-11-301-1/+3
| | | | | | It seems logical to account for the window controls if `boxvideo` is in use (which has the effect of reducing the size of the video so that the osc is not covering the video).
* man/osc: fix typoPhilip Langdale2019-11-291-1/+1
|
* osc: implement pseudo client side decorations via OSCPhilip Langdale2019-11-291-0/+16
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Today, if window decorations are not present, either because they were disabled, or because the platform doesn't support them (eg: gnome-shell on wayland), there are no window controls, meaning it is not possible to minimize/maximize/close a window without knowing keyboard shortcuts. While you can imagine various ways of offering client side decorations, it is attractive to consider using OSC because that is functionality that we already have. The main work here is defining a separate input area from the main OSC box with its own buttons, etc. While we could probably handle auto-detection based on whether decorations are present or not, it's manually controlled for now. The window control logic is mostly disconnected from the OSC itself, except in the case of the `topbar` layout, where there has to be coordination so that the controls don't get drawn on top of each other. I had to do fine-positioning of the buttons based on the font on my system, so don't be surprised if it looks wrong elsewhere. You could also argue that window controls should be unscaled, even if the main OSC box is scaled, but I've not tried to do this.
* osc: Unify bottom and topbar codeJan Janssen2019-10-281-2/+2
| | | | | | Among the pointless duplication the right timecode label was given some extra space that wasn't needed. Fixes: #6904
* osc: add feature to bottombar to not cover the videowm42019-09-191-0/+20
| | | | | | | | | | | | | | | | | | | | | | Normally I use the OSC like this: not at all, but have a key binding that does "cycle osc" to show it. And in that case, I don't really want it to overlap the damn video. I could use the zoom/pan options to move the video out of the way, but this is also sort of annoying. Likewise, you could write a script or so which does this automatically if the OSC appears, but that's still annoying, and computing values for these options such that the video is moved correctly is tricky. So I added a bunch of options that set explicit video borders (previous commit), and a option for the OSC to use them (this commit). Disabled by default, since I'm afraid this is too awkward and unpolished, especially with OSC default settings. I'm also using "osc-visibility=always". Effectively, making the OSC appear will box the video, and making it disappear (by unloading osc.lua) will restore the video back to normal.
* osc: improve look of seekrangesJan Janssen2019-09-021-8/+30
|
* config: replace config dir lua-settings/ with dir script-opts/Avi Halachmi (:avih)2018-04-071-1/+1
| | | | lua-settings/ is still supported, with deprecation warning.
* osc: add seekbarkeyframes as a user optiondudemanguy2018-01-031-0/+9
|
* osc: make seek ranges rendering optionalpavelxdd2017-12-261-0/+5
| | | | | This commit adds a new osc setting `seekranges` to control the seek ranges visibility.
* osc: add user_opts.boxmaxchars for box layout title limitAvi Halachmi (:avih)2017-04-191-0/+8
| | | | | The default of 80 is conservative to allow relatively wide fonts, but with many common fonts a bigger number can be used without overflow.
* man/osc: document volume and fullscreen buttonsRicardo Constantino2017-04-191-6/+17
|
* osc: escape ASS and strip newlines on titleRicardo Constantino2017-03-271-0/+1
|
* osc: make title configurable and use property expansion on itRicardo Constantino2017-03-271-1/+7
|
* Revert "osc: make the title toggleable between media-title and filename"Ricardo Constantino2017-03-271-8/+2
| | | | This reverts commit 6573b73462e336da0daca845ba4df02782afc2b6.
* osc: make the title toggleable between media-title and filenameRicardo Constantino2017-03-261-2/+8
| | | | Close #4221
* osc: add seekbarstyle=knobRicardo Constantino2016-11-091-1/+2
| | | | | | | | Most code from @leiserfg in #2365. Closes #2365 Cut guides to the center of the knob. This makes the knob knob look more like IRL knob sliders.
* man/osc: remove extra indentation from 3adc6071Ricardo Constantino2016-10-301-10/+10
|
* osc: top/bottombar: rescale layout to same size with scale=1Ricardo Constantino2016-10-291-3/+3
| | | | | Basically, there's two less values to revert to previous defaults and top/bottombar now look at scale=1 like they looked with scale=1.5.
* man/osc: Fix hard wrapping in man filesRicardo Constantino2016-10-291-41/+61
|
* osc: compromise on default deadzonesizeRicardo Constantino2016-10-291-1/+1
| | | | | | This way people can still use the mouse to quickly check the elapsed time without moving it all the way to the bottom while still having half the screen to ignore mouse movement.
* osc: add script message handlers for chapter/track/playlistsRicardo Constantino2016-10-241-0/+4
| | | | | | | | | | These can be used in input.conf for pretty formatting of lists as with shift+clicking the OSC buttons. Ex: z script-message osc-playlist Z script-message osc-chapterlist x script-message osc-tracklist
* man/osc: reorder a few options for better visibilityRicardo Constantino2016-10-231-24/+25
| | | | Also document pre-0.21.0 defaults.
* man/osc: better explain the values of deadzonesizeRicardo Constantino2016-10-171-1/+3
|
* osc: add user-alterable margin for top/bottombarRicardo Constantino2016-10-151-0/+4
|
* osc: add right-click behavior to playlist and chapter buttonsRicardo Constantino2016-10-151-0/+4
|
* osc: change default layout to bottombarRicardo Constantino2016-10-151-61/+37
| | | | | | Change a few other defaults accordingly: - seekbarstyle=bar looks better with bottombar. - Bigger scalewindowed and scalefullscreen make bottom/topbar more readable.
* osc: move tooltip to inside seekbar for top/bottombarRicardo Constantino2016-10-071-0/+4
| | | | Tooltip border is user-alterable
* manpage: fix some script_message references to preferred namewm42016-05-091-2/+2
|
* osc: add always-on mode and unify visibility mode (always/never/auto)Avi Halachmi (:avih)2016-02-271-12/+13
| | | | | | | | | | | | | Adds always-on mode by internally utilizing hidetimeout as negative and forbidding the user to set negative values. This removes script-message to enable/disable the osc, and instead introduces a combined 'visibility' control with the values never/auto/always. It's available via script_opts and script_message as 'osc-visibility'. As message, it also supports a 'cycle' value. The del key is bound to cycling the visibility modes.
* osc: time display configuration optionsTeoh Han Hui2015-06-191-0/+8
| | | | Total time and ms
* DOCS/manpage: fix typosrrooij2015-06-171-1/+1
| | | | | | | Fix some errors in the man pages by spell checking them. Most of them were typos. Signed-off-by: wm4 <wm4@nowhere>
* manpage: improve osc helpAvi Halachmi (:avih)2015-05-161-10/+11
| | | | Signed-off-by: wm4 <wm4@nowhere>
* OSC: add osc-message script command (wip)ChrisK22015-01-021-0/+4
|
* options: deprecate 'lua' based options/dirs for 'script'Avi Halachmi (:avih)2014-12-151-2/+2
| | | | | | | | | | | | - --lua and --lua-opts change to --script and --script-opts - 'lua' default script dirs change to 'scripts' - DOCS updated - 'lua-settings' dir was _not_ modified The old lua-based names/dirs still work, but display a warning. Signed-off-by: wm4 <wm4@nowhere>
* DOCS, OSC: Un-document removed seektooltip optionChrisK22014-12-051-4/+0
|
* DOCS, OSC: Document layout optionChrisK22014-12-051-1/+6
|
* man: document osc seekbarstyle optionahoka2014-11-151-0/+4
|
* man: replaced : with , in broken --lua-opts osc exampleStephen Caraher2014-10-031-1/+1
| | | | | | | --lua-opts is a key-value list, so the option parser accepts only commas. Signed-off-by: wm4 <wm4@nowhere> CC: @mpv-player/stable
* man: fix a whole bunch of typosMartin Herkt2014-09-011-4/+4
|
* DOCS: remove en/ sub-directorywm42014-06-201-0/+252
This additional sub-directory doesn't serve any purpose anymore. Get rid of it.