linus/mpv.net

Fork 0

Files

Frank Skare 23a587c819 manual

2020-04-23 12:55:02 +02:00

37 KiB

Raw Blame History

mpv.net manual

About
Download
Installation
Support
Settings
Command Line Interface
Terminal
External Tools
Scripting
Extensions
Color Theme
Advanced Features
Differences
Technical Overview
Context Menu

About

mpv.net is a modern desktop media player for Windows based on mpv. mpv is a media player based on MPlayer and mplayer2.

libmpv provides the majority of the features of the mpv player. 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 modern Windows GUI on top of it.

mpv.net is designed to be mpv compatible, almost all mpv features are available because they are all contained in libmpv, this means the official mpv manual applies to mpv.net.

Download

Changelog

Stable

Release page

Beta

OneDrive

DropBox

Installation

mpv.net requires the .NET Framework 4.8 and Windows 7 or 10 and a modern graphics card.

There is a setup and a portable download in the 7zip and Zip archive format.

x64 editions have the advantage of being typically better optimized and tested.

Scoop

scoop bucket add extras
scoop install mpv.net

AppGet

appget install mpv-net

Chocolatey

choco install mpvnet.install

File Associations

File Associations can be created using the setup or with the context menu under 'Tools > Setup'.

After the file associations were registered, go to the Windows settings under 'Settings > Apps > Default apps' or shell execute ms-settings:defaultapps and choose mpv.net as default app for Video and optionally for Audio and Images.

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

Open with++ can be used to extend the File Explorer context menu to get menu items for 'Play with mpv.net' and 'Add to mpv.net playlist'.

Support

Before making a support request, please try a newer beta version first.

Support thread in VideoHelp forum

Issue tracker, feel free to use for anything mpv.net related.

You can support my work with a PayPal donation. The input hardware support in mpv.net is not 100% mpv compatible, people use all kind of weird input hardware and sometimes I have to buy those to support them.

https://www.paypal.me/stax76

Settings

When mpv.net finds no config folder on startup it will ask for a location.

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

<startup>\portable_config\

mpv specific settings are stored in the file mpv.conf, 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/mpv.conf.txt

mpv.net specific settings are stored in the file mpvnet.conf.

The input (key/mouse) 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/input.conf.txt

mpv.net supports almost all mpv settings and features.

The config folder can be opened from the context menu (Settings > Open Config Folder).

Command Line Interface

mpvnet [options] [file|URL|PLAYLIST|-]
mpvnet [options] files

mpv properties can be set with the same syntax as mpv, that is:

To enable the border property:

--border or --border=yes

To disable the border property:

--no-boder or --border=no

Supported are all mpv properties, they are documented here:

https://mpv.io/manual/master/#properties

mpv.net has a feature to list all properties:

Context Menu > View > Show Properties

Non property switches are generally not supported in mpv.net!

Terminal

When mpv.net is started from a terminal it will output status, error and debug messages to the terminal and accept input keys from the terminal.

In the context menu under 'Tools > Setup' a button can be found to add mpv.net to the path environment variable.

A common task for the terminal is debugging scripts.

External Tools

Play with mpv

In order to play videos from sites such as YouTube the Chrome Extension Play with mpv can be used.

Due to Chrome Extensions not being able to start a app, another app that communicates with the extension is required, this app can be downloaded here. The extension works only when the app is running, to have the app always running a link can be created in the auto start folder located at:

C:\Users\%username%\AppData\Roaming\Microsoft\Windows\Start Menu\Programs\Startup

This will start the app on system start and have it running in the background. When the file association registration of mpv.net was executed then the app should find the location of mpv.net, alternativly the mpv.net folder can be added to the Path environment variable.

Open With

Alternatively he Chrome/Firefox extension Open With can be used.

Open with++

Open with++ allows to customize the File Explorer context menu to add menu items 'Play with mpv.net' and 'Add to mpv.net playlist'.

https://github.com/stax76/OpenWithPlusPlus

https://github.com/stax76/OpenWithPlusPlus#mpvnet

https://github.com/stax76/OpenWithPlusPlus#add-to-mpvnet-playlist

MediaInfo.NET

MediaInfo.NET is a media info GUI.

https://github.com/stax76/MediaInfo.NET

To start a external application mpv has the run input command (it does not use shell execute).

If the path has spaces then it must be enclosed in quotes and then double backslashes must be used for escaping or alternatively forward slashes.

_ run D:\Software\MediaInfoNET.exe "${path}" #menu: Tools > Open file with MediaInfo.NET

_ run "D:\\Soft ware\\MediaInfoNET.exe" "${path}" #menu: Tools > Open file with MediaInfo.NET

_ run "D:/Soft ware/MediaInfoNET.exe" "${path}" #menu: Tools > Open file with MediaInfo.NET

Scripting

There is no debugger support available for the scripting hosts, mpv.net can be started from a terminal, script errors and debug messages are printed then on the terminal.

Lua

File Type: lua

Location: <config folder>\scripts

Lua and JavaScript scripts are loaded before the first media file loads.

mpv Lua documentation

mpv user scripts

JavaScript

File Type: js

Location: <config folder>\scripts

Lua and JavaScript scripts are loaded before the first media file loads.

mpv JavaScript documentation

mpv user scripts

PowerShell

File Type: ps1

Location: <config folder>\scripts-ps

The PowerShell scripting host is like extensions not initialized before media files are loaded.

mpv.net does not define scripting interfaces but instead exposed its complete internals, there are no compatibility guaranties.

Example Scripts

C#

File Type: cs

Location: <config folder>\scripts-cs

C# scripting in mpv.net is implemented with a C# extension and CS-Script.

mpv.net does not define scripting interfaces but instead exposed its complete internals, there are no compatibility guaranties.

Script code can be written within a C# extension, that way full code completion and debugger support is available. Once the code was developed and debugged, the code can be moved from the extension to a lightweight standalone script.

The C# scripting host is like extensions not initialized before media files are loaded.

Example Scripts

Extensions

Extensions are located in the config folder and the filename must end with 'Extension.dll':

<config folder>\Extensions\ExampleExtension\ExampleExtension.dll

mpv.net does not define extension interfaces but instead exposed its complete internals, there are no compatibility guaranties.

Walkthrough creating an extension

Download and install Visual Studio Community.
Create a new project of type Class Library .NET Framework and ensure the project name ends with Extension.
Add a reference to System.ComponentModel.Composition.
Add a reference to mpvnet.exe, select the mpvnet reference in the Solution Explorer, open the Properties window and set Copy Local to false to prevent mpvnet.exe being copied to the output directory when the project is built.
Now open the project properties and set the output path in the Build tab, extensions are like scripts located in your config folder, example: <config folder>\extensions\ExampleExtension\ExampleExtension.dll
Also in the project properties choose the option Start external program in the Debug tab and define the path to mpvnet.exe. In the Debug tab you may also define command line arguments like a video file to be played when you start debugging.

Sample Code

ScriptingExtension

The ScriptingExtension implements the C# scripting host using CS-Script.

I use this extension as well to develop and debug C# scripts. Once the code was developed and debugged, I move the code from the extension to a standalone script.

Source Code

RatingExtension

This extension writes a rating to the filename of rated videos when mpv.net shuts down.

The input.conf defaults contain key bindings for this extension to set ratings.

Source Code

Color Theme

mpv.net supports custom color themes, the definition of the built-in themes can be found at:

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

Custom themes can be saved at:

<conf folder>\theme.conf

The theme.conf file may contain an unlimited amount of themes.

In the config editor under UI there are the settings dark-theme and light-theme to define the themes used in dark and in light mode.

Advanced Features

Playback of VapourSynth scripts

vpy files are supported with following mpv.conf configuration:

[extension.vpy]
demuxer-lavf-format = vapoursynth

Python and VapourSynth must be in the path environment variable.

Hidden Features

Selecting multiple files in File Explorer and pressing enter will open the files in mpv.net. Explorer restricts this to maximum 15 files and the order will be random.

Whenever the control key is pressed when files or URLs are opened, the playlist is not cleared but the files or URLs are appended to the playlist. This works in all mpv.net features that open files or URLs.

Pressing the shift key while opening a single file will suppress loading all files in the folder.

Differences

mpv.net is designed to work exactly like mpv, there are a few limitations:

Window Limitations

mpv.net implements an own main window which means only mpv window features are supported that have an own implementation in mpv.net.

A window free mode is currently not supported.

The documentation of mpvs window features can be found here:

https://mpv.io/manual/master/#window

mpv.net has currently implemented the following window features:

Partly implemented are:

autofit

autofit-smaller

autofit-larger

Command Line Limitations

mpv.net supports only property switches, it does not support non property switches.

mpv.net specific options

Options that are specific to mpv.net can be found by entering mpv.net in the search field of the config editor.

mpv.net specific options are saved in the file mpvnet.conf and are just as mpv properties available on the command line.

Technical Overview

mpv.net is written in C# 7 and runs on the .NET Framework 4.8.

The Extension implementation is based on the Managed Extensibility Framework.

The main window is WinForms based because WinForms allows better libmpv integration compared to WPF, all other windows are WPF based.

The config editor adds it's controls dynamically and uses TOML to define it's content.

Third party components:

The context menu of mpv.net is defined in the file input.conf which is located in the config directory.

If the input.conf file does not exists mpv.net generates it with the following defaults:

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

input.conf defines mpvs key and mouse bindings and mpv.net uses comments to define the context menu.

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 File Explorer if file associations exist.

When mpv.net is started from a terminal, mpv.net outputs status and debug messages on the terminal.

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

Pressing the shift key while opening a single file will suppress loading all files in the folder.

Open > Open URL or file path from clipboard

Opens files and URLs from the clipboard. How to open URLs directly from the browser from sites like YouTube is described in the External Tools section.

Open > Open DVD/Blu-ray Drive/Folder

Opens a DVD/Blu-ray Drive/Folder.

Open > Show media search

mpv.net supports system wide media searches using the Everything indexing service installed by the popular file search tool Everything.

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

37 KiB Raw Blame History

mpv.net manual

Table of contents

About

Download

Stable

Beta

Installation

Scoop

AppGet

Chocolatey

File Associations

Support

Settings

Command Line Interface

Terminal

External Tools

Play with mpv

Open With

Open with++

MediaInfo.NET

Scripting

Lua

JavaScript

PowerShell

C#

Extensions

Walkthrough creating an extension

Sample Code

ScriptingExtension

RatingExtension

Color Theme

Advanced Features

Playback of VapourSynth scripts

Hidden Features

Differences

Window Limitations

Command Line Limitations

mpv.net specific options

Technical Overview

Context Menu

Open > Open Files

Open > Open URL or file path from clipboard

Open > Open DVD/Blu-ray Drive/Folder

Open > Show media search

Open > Load external audio files

Open > Load external subtitle files

Play/Pause

Stop

Toggle Fullscreen

Navigate > Previous File

Navigate > Next File

Navigate > Next Chapter

Navigate > Previous Chapter

Navigate > Jump Next Frame

Navigate > Jump Previous Frame

Navigate > Jump

Pan & Scan > Increase Size

Pan & Scan > Decrease Size

Pan & Scan > Move Left

Pan & Scan > Move Right

Pan & Scan > Move Up

Pan & Scan > Move Down

Pan & Scan > Decrease Height

Pan & Scan > Increase Height

Pan & Scan > Reset

Video > Decrease Contrast

Video > Increase Contrast

Video > Decrease Brightness

Video > Increase Brightness

Video > Decrease Gamma

Video > Increase Gamma

Video > Decrease Saturation

Video > Increase Saturation

Video > Take Screenshot

Video > Toggle Deinterlace

Video > Cycle Aspect Ratio

Audio > Cycle/Next

Audio > Delay +0.1

Audio > Delay -0.1

37 KiB

Raw Blame History