From 6048f87e3c07d03df8a59da58c81608c5375f6dc Mon Sep 17 00:00:00 2001 From: wm4 Date: Thu, 26 Sep 2013 00:41:14 +0200 Subject: Add initial Lua scripting support This is preliminary. There are still tons of issues, and any aspect of scripting may change in the future. I decided to merge this (preliminary) work now because it makes it easier to develop it, not because it's done. lua.rst is clear enough about it (plus some sarcasm). This requires linking to Lua. Lua has no official pkg-config file, but there are distribution specific .pc files, all with different names. Adding a non-pkg-config based configure test was considered, but we'd rather not. One major complication is that libquvi links against Lua too, and if the Lua version is different from mpv's, you will get a crash as soon as libquvi uses Lua. (libquvi by design always runs when a file is opened.) I would consider this the problem of distros and whoever builds mpv, but to make things easier for users, we add a terrible runtime test to the configure script, which probes whether libquvi will crash. This is disabled when cross-compiling, but in that case we hope the user knows what he is doing. --- DOCS/man/en/lua.rst | 18 ++++++++++++++++++ DOCS/man/en/mpv.rst | 2 ++ DOCS/man/en/options.rst | 4 ++++ 3 files changed, 24 insertions(+) create mode 100644 DOCS/man/en/lua.rst (limited to 'DOCS/man/en') diff --git a/DOCS/man/en/lua.rst b/DOCS/man/en/lua.rst new file mode 100644 index 0000000000..25d456cb46 --- /dev/null +++ b/DOCS/man/en/lua.rst @@ -0,0 +1,18 @@ +LUA SCRIPTING +============= + +mpv can load Lua scripts. These scripts can be used to control mpv in a similar +way to slave mode. mpv provides the builtin module ``mp`` (can be loaded +with ``require 'mpv'``), which provides functions to send commands to the +mpv core and to retrieve information about playback state, user settings, +file information, and so on. + +.. admonition:: Warning + + Lua scripting is work in progress, and it's in a very early stage. When + writing scripts, rely only on the features and functions documented here. + Everything else is subject to change. + +.. admonition:: Warning + + Nothing is finished and documented yet. diff --git a/DOCS/man/en/mpv.rst b/DOCS/man/en/mpv.rst index 08eef8bc45..5b61257999 100644 --- a/DOCS/man/en/mpv.rst +++ b/DOCS/man/en/mpv.rst @@ -441,6 +441,8 @@ OPTIONS .. include:: input.rst +.. include:: lua.rst + .. include:: changes.rst ENVIRONMENT VARIABLES diff --git a/DOCS/man/en/options.rst b/DOCS/man/en/options.rst index ca17c763c4..4c4d6ebc8d 100644 --- a/DOCS/man/en/options.rst +++ b/DOCS/man/en/options.rst @@ -1258,6 +1258,10 @@ looping. If several files are specified on command line, the entire playlist is looped. +``--lua=`` + Load a Lua script. You can load multiple scripts by separating them with + commas (``,``). + ``--mc=`` Maximum A-V sync correction per frame (in seconds) -- cgit v1.2.3