Skip to content

Latest commit

 

History

History
831 lines (464 loc) · 26.1 KB

Manual.md

File metadata and controls

831 lines (464 loc) · 26.1 KB

mpv.net manual

Table of contents

About mpv.net

mpv.net is a media player for Windows. Similar like VLC mpv.net is not based on DirectShow like MPC, mpv.net is based on libmpv which in return is based on ffmpeg.

libmpv provides the majority of the features of the mpv media player, a fork of mplayer. mpv focuses on the usage of the command line interface, mpv.net retains the ability to be used from the command line and adds a simple and easy to use GUI on top of it.

mpv.net is meant to be a small single person project, it's designed to be mpv compatible, can use the same settings as mpv and offers almost all mpv features because they are all contained in libmpv, this means the official mpv manual fully applies to mpv.net.

Target Audience

The target audience of mpv.net are Windows programmers and users that need something more advanced than common media players.

Furthermore mpv.net is well suited for Windows users who are interested to learn about the Linux operating system and portable apps, even though mpv.net self is not portable.

Requirements

mpv.net is based on the .NET Framework and requires Windows 7 as minimum version of the Windows operating system. As of the writing of this manual the minimum required .NET Framework version is 4.7.2.

For optimal results a modern graphics card is recommended.

Installation

mpv.net is available as setup and as portable download in the 7zip and zip archive format, to unpack the portable download 7zip can be used, it is available at www.7-zip.org.

If you are new to mpv.net the portable download is recommended, for regular mpv.net users the setup is typically more easy to use.

The x64 editions require more memory and have the advantage of decoders being typically first and better optimized for x64.

x86 should though still be well supported and work.

File Associations

File Associations can be created using the setup or from within the apps context menu under 'Tools > Manage File Associations'.

Windows 10 prevents apps to register as the default app, to define the default video or audio player app in Windows 10 go to the Windows settings under 'Settings > Apps > Default apps' or shell execute 'ms-settings:defaultapps'.

It's also possible to change the default application using the Open With feature of the context menu in Windows File Explorer.

Context Menu

The most important part of the user interface in mpv.net is the context menu, the menu can be customized as it is defined in the same file where the key bindings are defined.

Open > Open Files

The Open Files menu entry is one way to open files in mpv.net, it supports multi selection.

Another way to open files is the command line, it is used by the Windows File Explorer if file associations exist.

A third way is to drag and drop files on the main window.

Open > Open URL

The Open URL menu entry can be used to open URLs for example from YouTube.

mpv.net monitors the Windows clipboard and ask if URLs should be played in case it finds a URL in the clipboard.

Open > Show media search

mpv.net supports system wide media searches using the Everything indexing service installed by the popular file search tool Everything (www.voidtools.com).

Open > Load external audio files

Allows to load an external audio file. It's also possible to auto detect external audio files based on the file name, the option for this can be found in the settings under 'Settings > Show Config Editor > Audio > audio-file-auto'.

Open > Load external subtitle files

Allows to load an external subtitle file. It's also possible to auto detect external subtitle files based on the file name, the option for this can be found in the settings under 'Settings > Show Config Editor > Subtitles > sub-auto'.

Play/Pause

Play/Pause using the command:

cycle pause

cycle command

pause property

Stop

Stops the player and unloads the playlist using the command:

stop

stop command

Toggle Fullscreen

Toggles fullscreen using the command:

cycle fullscreen

cycle command

fullscreen property

Navigate > Previous File

Navigates to the previous file in the playlist using the command:

playlist-prev

playlist-prev command

Navigate > Next File

Navigates to the next file in the playlist using the command:

playlist-next

playlist-next command

Navigate > Next Chapter

Navigates to the next chapter using the command:

add chapter 1

add command

chapter property

Navigate > Previous Chapter

Navigates to the previous chapter using the command:

add chapter -1

add command

chapter property

Navigate > Jump Next Frame

Jumps to the next frame using the command:

frame-step

frame-step command

Navigate > Jump Previous Frame

Jumps to the previous frame using the command:

frame-back-step

frame-back-step command

Navigate > Jump

Seeking using the command:

no-osd seek sec

sec is the relative amount of seconds to jump, the no-osd prefix is used because mpv.net includes a script that shows the position when a seek operation is performed, the script uses a more simple time format.

no-osd command prefix

seek command

Pan & Scan > Increase Size

Adds video zoom using the command:

add video-zoom 0.1

add command

video-zoom property

Pan & Scan > Decrease Size

Adds negative video zoom using the command:

add video-zoom -0.1

add command

video-zoom property

Pan & Scan > Move Left

add video-pan-x -0.01

add command

video-pan-x, video-pan-y property

Pan & Scan > Move Right

add video-pan-x 0.01

add command

video-pan-x, video-pan-y property

Pan & Scan > Move Up

add video-pan-y -0.01

add command

video-pan-x, video-pan-y property

Pan & Scan > Move Down

add video-pan-y 0.01

add command

video-pan-x, video-pan-y property

Pan & Scan > Decrease Height

add panscan -0.1

add command

panscan property

Pan & Scan > Increase Height

add panscan 0.1

add command

panscan property

Pan & Scan > Reset

Resets Pan & Scan, multiple commands in the same line are separated with semicolon.

set video-zoom 0; set video-pan-x 0; set video-pan-y 0

video-zoom property

video-pan-x, video-pan-y property

Video > Decrease Contrast

Decreases contrast with the following command:

add contrast -1

add command

contrast property

Video > Increase Contrast

Increases contrast with the following command:

add contrast 1

add command

contrast property

Video > Decrease Brightness

Decreases brightness using the following command:

add brightness -1

add command

brightness property

Video > Increase Brightness

Increases brightness using the following command:

add brightness 1

add command

brightness property

Video > Decrease Gamma

Decreases gamma using the following command:

add gamma -1

add command

gamma property

Video > Increase Gamma

Increases gamma using the following command:

add gamma 1

add command

gamma property

Video > Decrease Saturation

Decreases saturation using the following command:

add saturation -1

add command

saturation property

Video > Increase Saturation

Increases saturation using the following command:

add saturation 1

add command

saturation property

Video > Take Screenshot

async screenshot

async command prefix

screenshot command

Video > Toggle Deinterlace

Cycles the deinterlace property using the following command:

cycle deinterlace

cycle command

deinterlace property

Video > Cycle Aspect Ratio

Cycles the aspect ratio using the following command:

cycle-values video-aspect "16:9" "4:3" "2.35:1" "-1"

cycle-values command

video-aspect property

Audio > Cycle/Next

This uses a mpv.net command that shows better info then the mpv preset and also has the advantage of not showing no audio.

Audio > Delay +0.1

Adds a audio delay using the following command:

add audio-delay 0.1

add command

audio-delay property

Audio > Delay -0.1

Adds a negative audio delay using the following command:

add audio-delay -0.1

add command

audio-delay property

Subtitle > Cycle/Next

Shows the next subtitle track using the following command:

cycle sub

cycle command

sub/sid property

Subtitle > Toggle Visibility

Cycles the subtitle visibility using the following command:

cycle sub-visibility

cycle command

sub-visibility property

Subtitle > Delay -0.1

Adds a negative subtitle delay using the following command:

add sub-delay -0.1

add command

sub-delay property

Subtitle > Delay 0.1

Adds a positive subtitle delay using the following command:

add sub-delay 0.1

add command

sub-delay property

Subtitle > Move Up

Moves the subtitle up using the following command:

add sub-pos -1

add command

sub-pos property

Subtitle > Move Down

Moves the subtitle down using the following command:

add sub-pos 1

add command

sub-pos property

Subtitle > Decrease Subtitle Font Size

Decreases the subtitle font size using the following command:

add sub-scale -0.1

add command

sub-scale property

Subtitle > Increase Subtitle Font Size

Increases the subtitle font size using the following command:

add sub-scale 0.1

add command

sub-scale property

Volume > Up

Increases the volume using the following command:

add volume 10

add command

volume property

Volume > Down

Decreases the volume using the following command:

add volume -10

add command

volume property

Volume > Mute

Cycles the mute property using the following command:

cycle mute

cycle command

mute property

Speed > -10%

Decreases the speed by 10% using the following command:

multiply speed 1/1.1

multiply command

speed property

Speed > 10%

Increases the speed by 10% using the following command:

multiply speed 1.1

multiply command

speed property

Speed > Half

Halfs the speed using the following command:

multiply speed 0.5

multiply command

speed property

Speed > Double

Doubles the speed using the following command:

multiply speed 2

multiply command

speed property

Speed > Reset

Resets the speed using the following command:

set speed 1

set command

speed property

Extensions > Rating > 0stars

A plugin the writes the rating to the filename.

View > On Top > Enable

Forces the player to stay on top of other windows using the following command:

set ontop yes

set command

ontop property

View > On Top > Disable

Disables the player to stay on top of other windows using the following command:

set ontop no

set command

ontop property

View > File Info

Shows info using a mpv.net command about the current file, shows length, position, formats, size and filename.

View > Show Statistics

Show statistics using the following command:

script-binding stats/display-stats

script-binding command

View > Toggle Statistics

Toggles statistics using the following command:

script-binding stats/display-stats-toggle

script-binding command

View > Toggle OSC Visibility

Toggles OSC Visibility using the following command:

script-binding osc/visibility

script-binding command

View > Show Playlist

Shows the playlist for 5 seconds using the following command:

show-text ${playlist} 5000

show-text command

View > Show Audio/Video/Subtitle List

Shows the Audio/Video/Subtitle list for 5 seconds using the following command:

show-text ${track-list} 5000

show-text command

Settings > Show Config Editor

Shows mpv.net's config editor.

Settings > Show Input Editor

Shows mpv.net's key binding editor.

Settings > Open Config Folder

Opens the config folder which contains:

mpv.conf file containing mpv settings

mpvnet.conf file containing mpv.net settings

input.conf containing mpv key bindings

User scripts and user extensions

Tools > Command Palette

Shows the command palette window which allows to find mpv.net commands, it shows the command's location in the context menu and the key shortcut.

Tools > Show History

When enabled shows a file that contains the playback history containing the time and filename.

Tools > Set/clear A-B loop points

Enables to set loop start and end points using the following command:

ab-loop

ab-loop command

Tools > Toggle infinite file looping

Loops the current file infinitely using the following command:

cycle-values loop-file "inf" "no"

cycle-values command

loop-file command

Tools > Cycle Hardware Decoding

Cycles the hwdec property to enable/disable hardware decoding using the following command:

cycle-values hwdec "auto" "no"

cycle-values command

hwdec property

Tools > Execute mpv command

Allows to execute mpv commands.

Tools > Manage File Associations

Allows to manage file associations.

Help > Show mpv manual

Shows the mpv manual.

Help > Show mpv default keys

Shows the mpv default keys

Help > Show mpv.net default keys

Shows the mpv.net default keys

Help > Show mpv.net web site

Shows the mpv.net web site

Help > Show mpv.net manual

Shows the mpv.net manual

Help > About mpv.net

Shows the mpv.net about dialog.

Exit

Exits mpv.net using the following command:

quit

quit command

Exit Watch Later

Exits mpv.net and remembers the position in the file using the following command:

quit-watch-later

quit-watch-later command

Command Line Interface

mpvnet implements a basic CLI to set mpv commands.

Example:

mpvnet --mute=yes <file|URL>

Settings

mpv.net is able to share the settings with mpv and mpv.net uses the same logic to decide from where the settings are loaded. The default location is:

C:\Users\%username%\AppData\Roaming\mpv\mpv.conf

If a directory named portable_config next to the mpvnet.exe exists, all config will be loaded from this directory only.

<startup>\portable_config\mpv.conf

In case there isn't any config folder mpv.net asks where to create it. If no mpv.conf file exists mpv.net generates it with the following defaults:

https://github.com/stax76/mpv.net/blob/master/mpv.net/Resources/mpvConf.txt

Config files located in the same directory as mpvnet.exe are loaded with lower priority. Some config files are loaded only once, which means that e.g. of 2 input.conf files located in two config directories, only the one from the directory with higher priority will be loaded.

The key bindings and the context menu definitions are stored in the input.conf file, if it's missing mpv.net generates it with the following defaults:

https://github.com/stax76/mpv.net/blob/master/mpv.net/Resources/inputConf.txt