summaryrefslogtreecommitdiffstats
path: root/TOOLS/lua/drc-control.lua
diff options
context:
space:
mode:
authorKevin Mitchell <kevmitch@gmail.com>2014-04-29 05:11:39 -0700
committerKevin Mitchell <kevmitch@gmail.com>2014-04-29 08:31:44 -0700
commit8e8758dbe15ed7611c65856d62c3f44b5be73d7e (patch)
treeccbf2fbfec3ed404c61605587d050e9082126456 /TOOLS/lua/drc-control.lua
parent4b0a760d86381587eff3552c440fbe1bfbac03e5 (diff)
downloadmpv-8e8758dbe15ed7611c65856d62c3f44b5be73d7e.tar.bz2
mpv-8e8758dbe15ed7611c65856d62c3f44b5be73d7e.tar.xz
TOOLS: better documentation of lua scripts
Diffstat (limited to 'TOOLS/lua/drc-control.lua')
-rw-r--r--TOOLS/lua/drc-control.lua19
1 files changed, 19 insertions, 0 deletions
diff --git a/TOOLS/lua/drc-control.lua b/TOOLS/lua/drc-control.lua
index 71755d4dfb..f0a6ff2721 100644
--- a/TOOLS/lua/drc-control.lua
+++ b/TOOLS/lua/drc-control.lua
@@ -1,3 +1,22 @@
+-- This script enables live control of the dynamic range compression
+-- (drc) audio filter while the video is playing back. This can be
+-- useful to avoid having to stop and restart mpv to adjust filter
+-- parameters. See the entry for "drc" under the "AUDIO FILTERS"
+-- section of the man page for a complete description of the filter.
+--
+-- This script registers the key-binding "\" to toggle the filter between
+--
+-- * off
+-- * method=1 (single-sample smoothing)
+-- * method=2 (multi-sample smoothing)
+--
+-- It registers the keybindings ctrl+9/ctrl+0 to decrease/increase the
+-- target ampltiude. These keys will insert the filter at the default
+-- target amplitude of 0.25 if it was not previously present.
+--
+-- OSD feedback of the current filter state is displayed on pressing
+-- each bound key.
+
script_name=mp.get_script_name():gsub("lua/","",1)
function print_state(params)