mpv-notify
https://github.com/rohieb/mpv-notify
$ sudo pacman -S lua lua-socket luarocks libnotify imagemagick
$ sudo luarocks install luaposix
is currently unmaintained
-- notify.lua -- Desktop notifications for mpv.
-- Just put this file into your ~/.mpv/lua folder and mpv will find it.
--
-- Copyright (c) 2014 Roland Hieber
--
-- Permission is hereby granted, free of charge, to any person obtaining a copy
-- of this software and associated documentation files (the "Software"), to deal
-- in the Software without restriction, including without limitation the rights
-- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-- copies of the Software, and to permit persons to whom the Software is
-- furnished to do so, subject to the following conditions:
--
-- The above copyright notice and this permission notice shall be included in
-- all copies or substantial portions of the Software.
--
-- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-- SOFTWARE.
-------------------------------------------------------------------------------
-- helper functions
-------------------------------------------------------------------------------
function print_debug(s)
-- print("DEBUG: " .. s) -- comment out for no debug info
return true
end
-- url-escape a string, per RFC 2396, Section 2
function string.urlescape(str)
local s, c = string.gsub(str, "([^A-Za-z0-9_.!~*'()/-])",
function(c)
return ("%%%02x"):format(c:byte())
end)
return s;
end
-- escape string for html
function string.htmlescape(str)
local str = string.gsub(str, "<", "<")
str = string.gsub(str, ">", ">")
str = string.gsub(str, "&", "&")
str = string.gsub(str, "\"", """)
str = string.gsub(str, "'", "'")
return str
end
-- escape string for shell inclusion
function string.shellescape(str)
return "'"..string.gsub(str, "'", "'\"'\"'").."'"
end
-- converts string to a valid filename on most (modern) filesystems
function string.safe_filename(str)
local s, _ = string.gsub(str, "([^A-Za-z0-9_.-])",
function(c)
return ("%02x"):format(c:byte())
end)
return s;
end
-------------------------------------------------------------------------------
-- here we go.
-------------------------------------------------------------------------------
local http = require("socket.http")
http.TIMEOUT = 3
http.USERAGENT = "mpv-notify/0.1"
local posix = require("posix")
local CACHE_DIR = os.getenv("XDG_CACHE_HOME")
CACHE_DIR = CACHE_DIR or os.getenv("HOME").."/.cache"
CACHE_DIR = CACHE_DIR.."/mpv/coverart"
print_debug("making " .. CACHE_DIR)
os.execute("mkdir -p -- " .. string.shellescape(CACHE_DIR))
function tmpname()
local _, fname = posix.mkstemp(CACHE_DIR .. "/rescale.XXXXXX")
return fname
end
-- scale an image file
-- @return boolean of success
function scale_image(src, dst)
local convert_cmd = ("convert -scale x64 -- %s %s"):format(
string.shellescape(src), string.shellescape(dst))
print_debug("executing " .. convert_cmd)
if os.execute(convert_cmd) then
return true
end
return false
end
-- look for a list of possible cover art images in the same folder as the file
-- @param absolute filename name of currently played file, or nil if no match
function get_folder_cover_art(filename)
if not filename or string.len(filename) < 1 then
return nil
end
print_debug("get_folder_cover_art: filename is " .. filename)
local cover_extensions = { "png", "jpg", "jpeg", "gif" }
local cover_names = { "cover", "folder", "front", "back", "insert" }
local path = string.match(filename, "^(.*/)[^/]+$")
for _,name in pairs(cover_names) do
for _,ext in pairs(cover_extensions) do
morenames = { name, string.upper(name),
string.upper(string.sub(name, 1, 1)) .. string.sub(name, 2, -1) }
moreexts = { ext, string.upper(ext) }
for _,name in pairs(morenames) do
for _,ext in pairs(moreexts) do
local fn = path .. name .. "." .. ext
--print_debug("get_folder_cover_art: trying " .. fn)
local f = io.open(fn, "r")
if f then
f:close()
print_debug("get_folder_cover_art: match at " .. fn)
return fn
end
end
end
end
end
return nil
end
-- fetch cover art from MusicBrainz/Cover Art Archive
-- @return file name of downloaded cover art, or nil in case of error
-- @param mbid optional MusicBrainz release ID
function fetch_musicbrainz_cover_art(artist, album, mbid)
print_debug("fetch_musicbrainz_cover_art parameters:")
print_debug("artist: " .. artist)
print_debug("album: " .. album)
print_debug("mbid: " .. mbid)
if not artist or artist == "" or not album or album == "" then
print("not enough metadata, not fetching cover art.")
return nil
end
local output_filename = string.safe_filename(artist .. "_" .. album)
output_filename = (CACHE_DIR .. "/%s.png"):format(output_filename)
-- TODO: dirty hack, may only work on Linux.
f, err = io.open(output_filename, "r")
if f then
print_debug("file is already in cache: " .. output_filename)
return output_filename -- exists and is readable
elseif string.find(err, "[Pp]ermission denied") then
print(("cannot read from cached file %s: %s"):format(output_filename, err))
return nil
end
print_debug("fetching album art to " .. output_filename)
local valid_mbid = function(s)
return s and string.len(s) > 0 and not string.find(s, "[^0-9a-fA-F-]")
end
-- fetch release MBID from MusicBrainz, needed for Cover Art Archive
if not valid_mbid(mbid) then
string.gsub(artist, '"', "")
local query = ("%s AND artist:%s"):format(album, artist)
local url = "http://musicbrainz.org/ws/2/release?limit=1&query="
.. string.urlescape(query)
print_debug("fetching " .. url)
local d, c, h = http.request(url)
-- poor man's XML parsing:
local mbid = string.match(d or "",
"<%s*release%s+[^>]*id%s*=%s*['\"]%s*([0-9a-fA-F-]+)%s*['\"]")
if not mbid or not valid_mbid(mbid) then
print("MusicBrainz returned no match.")
print_debug("content: " .. d)
return nil
end
end
print_debug("got MusicBrainz ID " .. mbid)
-- fetch image from Cover Art Archive
local url = ("http://coverartarchive.org/release/%s/front-250"):format(mbid)
print("fetching album cover from " .. url)
local d, c, h = http.request(url)
if c ~= 200 then
print(("Cover Art Archive returned HTTP %s for MBID %s"):format(c, mbid))
return nil
end
if not d or string.len(d) < 1 then
print(("Cover Art Archive returned no content for MBID %s"):format(mbid))
print_debug("HTTP response: " .. d)
return nil
end
local tmp_filename = tmpname()
local f = io.open(tmp_filename, "w+")
f:write(d)
f:flush()
f:close()
-- make it a nice size
if scale_image(tmp_filename, output_filename) then
if not os.remove(tmp_filename) then
print("could not remove" .. tmp_filename .. ", please remove it manually")
end
return output_filename
end
print(("could not scale %s to %s"):format(tmp_filename, output_filename))
return nil
end
function notify_current_track()
local data = mp.get_property_native("metadata")
if not data then
return
end
function get_metadata(data, keys)
for _,v in pairs(keys) do
if data[v] and string.len(data[v]) > 0 then
return data[v]
end
end
return ""
end
-- srsly MPV, why do we have to do this? :-(
local artist = get_metadata(data, {"artist", "ARTIST"})
local album = get_metadata(data, {"album", "ALBUM"})
local album_mbid = get_metadata(data, {"MusicBrainz Album Id",
"MUSICBRAINZ_ALBUMID"})
local title = get_metadata(data, {"title", "TITLE", "icy-title"})
print_debug("notify_current_track: relevant metadata:")
print_debug("artist: " .. artist)
print_debug("album: " .. album)
print_debug("album_mbid: " .. album_mbid)
local summary = ""
local body = ""
local params = ""
local scaled_image = ""
local delete_scaled_image = false
-- first try finding local cover art
local abs_filename = os.getenv("PWD") .. "/" .. mp.get_property_native("path")
local cover_image = get_folder_cover_art(abs_filename)
if cover_image and cover_image ~= "" then
scaled_image = tmpname()
scale_image(cover_image, scaled_image)
delete_scaled_image = true
end
-- then load cover art from the internet
if (not scaled_image or scaled_image == "")
and ((artist ~= "" and album ~= "") or album_mbid ~= "") then
scaled_image = fetch_musicbrainz_cover_art(artist, album, album_mbid)
cover_image = scaled_image
end
if scaled_image and string.len(scaled_image) > 1 then
print("found cover art in " .. cover_image)
params = " -i " .. string.shellescape(scaled_image)
end
if(artist == "") then
summary = string.shellescape("Now playing:")
else
summary = string.shellescape(string.htmlescape(artist))
end
if title == "" then
body = string.shellescape(mp.get_property_native("filename"))
else
if album == "" then
body = string.shellescape(string.htmlescape(title))
else
body = string.shellescape(("%s<br /><i>%s</i>"):format(
string.htmlescape(title), string.htmlescape(album)))
end
end
local command = ("notify-send -a mpv %s -- %s %s"):format(params, summary, body)
print_debug("command: " .. command)
os.execute(command)
if delete_scaled_image and not os.remove(scaled_image) then
print("could not remove" .. scaled_image .. ", please remove it manually")
end
end
function notify_metadata_updated(name, data)
notify_current_track()
end
-- insert main() here
mp.register_event("file-loaded", notify_current_track)
mp.observe_property("metadata", nil, notify_metadata_updated)
~/.config/mpv/scripts/notify.lua
-- notify.lua -- Desktop notifications for mpv.
-- Just put this file into your ~/.mpv/lua folder and mpv will find it.
--
-- Copyright (c) 2014 Roland Hieber
--
-- Permission is hereby granted, free of charge, to any person obtaining a copy
-- of this software and associated documentation files (the "Software"), to deal
-- in the Software without restriction, including without limitation the rights
-- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-- copies of the Software, and to permit persons to whom the Software is
-- furnished to do so, subject to the following conditions:
--
-- The above copyright notice and this permission notice shall be included in
-- all copies or substantial portions of the Software.
--
-- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-- SOFTWARE.
-------------------------------------------------------------------------------
-- helper functions
-------------------------------------------------------------------------------
function print_debug(s)
-- print("DEBUG: " .. s) -- comment out for no debug info
return true
end
--- Function equivalent to dirname in POSIX systems
--@param str the path string
function basename(str)
if str:match(".-/.-") then
local name = string.gsub(str, "(.*/)(.*)", "%2")
return name
else
return ''
end
end
--@param str the path string
function remove_extension(path)
local found, len, remainder = string.find(path, "^(.*)%.[^%.]*$")
if found then
return remainder
else
return path
end
end
-- -- url-escape a string, per RFC 2396, Section 2
-- function string.urlescape(str)
-- s, c = string.gsub(str, "([^A-Za-z0-9_.!~*'()/-])",
-- function(c)
-- return ("%%%02x"):format(c:byte())
-- end)
-- return s;
-- end
-- escape string for html
function string.htmlescape(str)
str = string.gsub(str, "<", "<")
str = string.gsub(str, ">", ">")
str = string.gsub(str, "&", "&")
str = string.gsub(str, "\"", """)
str = string.gsub(str, "'", "'")
return str
end
-- escape string for shell inclusion
function string.shellescape(str)
return "'"..string.gsub(str, "'", "'\"'\"'").."'"
end
-- -- converts string to a valid filename on most (modern) filesystems
-- function string.safe_filename(str)
-- s, c = string.gsub(str, "([^A-Za-z0-9_.-])",
-- function(c)
-- return ("%02x"):format(c:byte())
-- end)
-- return s;
-- end
-------------------------------------------------------------------------------
-- here we go.
-------------------------------------------------------------------------------
-- http = require("socket.http")
-- http.TIMEOUT = 3
-- http.USERAGENT = "mpv-notify/0.1"
--
-- local CACHE_DIR = os.getenv("XDG_CACHE_HOME")
-- CACHE_DIR = CACHE_DIR or os.getenv("HOME").."/.cache"
-- CACHE_DIR = CACHE_DIR.."/mpv/coverart"
-- print_debug("making " .. CACHE_DIR)
-- os.execute("mkdir -p -- " .. string.shellescape(CACHE_DIR))
--
-- function tmpname()
-- return "/tmp/mpv-coverart." .. math.random(0,0xffffff)
-- end
--
-- -- scale an image file
-- -- @return boolean of success
-- function scale_image(src, dst)
-- convert_cmd = ("convert -scale x64 -- %s %s"):format(
-- string.shellescape(src), string.shellescape(dst))
-- print_debug("executing " .. convert_cmd)
-- if os.execute(convert_cmd) then
-- return true
-- end
-- return false
-- end
--
-- -- look for a list of possible cover art images in the same folder as the file
-- -- @param absolute filename name of currently played file, or nil if no match
-- function get_folder_cover_art(filename)
-- if not filename or string.len(filename) < 1 then
-- return nil
-- end
--
-- print_debug("get_folder_cover_art: filename is " .. filename)
--
-- cover_extensions = { "png", "jpg", "jpeg", "gif" }
-- cover_names = { "cover", "folder", "front", "back", "insert" }
--
-- path = string.match(filename, "^(.*/)[^/]+$")
--
-- for k,name in pairs(cover_names) do
-- for k,ext in pairs(cover_extensions) do
-- morenames = { name, string.upper(name),
-- string.upper(string.sub(name, 1, 1)) .. string.sub(name, 2, -1) }
-- moreexts = { ext, string.upper(ext) }
-- for k,name in pairs(morenames) do
-- for k,ext in pairs(moreexts) do
-- fn = path .. name .. "." .. ext
-- print_debug("get_folder_cover_art: trying " .. fn)
-- f = io.open(fn, "r")
-- if f then
-- f:close()
-- print_debug("get_folder_cover_art: match at " .. fn)
-- return fn
-- end
-- end
-- end
-- end
-- end
-- return nil
-- end
--
-- -- fetch cover art from MusicBrainz/Cover Art Archive
-- -- @return file name of downloaded cover art, or nil in case of error
-- -- @param mbid optional MusicBrainz release ID
-- function fetch_musicbrainz_cover_art(artist, album, mbid)
-- print_debug("fetch_musicbrainz_cover_art parameters:")
-- print_debug("artist: " .. artist)
-- print_debug("album: " .. album)
-- print_debug("mbid: " .. mbid)
--
-- if not artist or artist == "" or not album or album == "" then
-- print("not enough metadata, not fetching cover art.")
-- return nil
-- end
--
-- output_filename = string.safe_filename(artist .. "_" .. album)
-- output_filename = (CACHE_DIR .. "/%s.png"):format(output_filename)
--
-- -- TODO: dirty hack, may only work on Linux.
-- f, err = io.open(output_filename, "r")
-- if f then
-- print_debug("file is already in cache: " .. output_filename)
-- return output_filename -- exists and is readable
-- elseif string.find(err, "[Pp]ermission denied") then
-- print(("cannot read from cached file %s: %s"):format(output_filename, err))
-- return nil
-- end
-- print_debug("fetching album art to " .. output_filename)
--
-- valid_mbid = function(s)
-- return s and string.len(s) > 0 and not string.find(s, "[^0-9a-fA-F-]")
-- end
--
-- -- fetch release MBID from MusicBrainz, needed for Cover Art Archive
-- if not valid_mbid(mbid) then
-- string.gsub(artist, '"', "")
-- query = ("%s AND artist:%s"):format(album, artist)
-- url = "http://musicbrainz.org/ws/2/release?limit=1&query="
-- .. string.urlescape(query)
-- print_debug("fetching " .. url)
-- d, c, h = http.request(url)
-- -- poor man's XML parsing:
-- mbid = string.match(d or "",
-- "<%s*release%s+[^>]*id%s*=%s*['\"]%s*([0-9a-fA-F-]+)%s*['\"]")
-- if not mbid or not valid_mbid(mbid) then
-- print("MusicBrainz returned no match.")
-- print_debug("content: " .. d)
-- return nil
-- end
-- end
-- print_debug("got MusicBrainz ID " .. mbid)
--
-- -- fetch image from Cover Art Archive
-- url = ("http://coverartarchive.org/release/%s/front-250"):format(mbid)
-- print_debug("fetching album cover from " .. url)
-- d, c, h = http.request(url)
-- if c ~= 200 then
-- print_debug(("Cover Art Archive returned HTTP %s for MBID %s"):format(c, mbid))
-- return nil
-- end
-- if not d or string.len(d) < 1 then
-- print_debug(("Cover Art Archive returned no content for MBID %s"):format(mbid))
-- print_debug("HTTP response: " .. d)
-- return nil
-- end
--
-- tmp_filename = tmpname()
-- f = io.open(tmp_filename, "w+")
-- f:write(d)
-- f:flush()
-- f:close()
--
-- -- make it a nice size
-- if scale_image(tmp_filename, output_filename) then
-- if not os.remove(tmp_filename) then
-- print("could not remove" .. tmp_filename .. ", please remove it manually")
-- end
-- return output_filename
-- end
--
-- print(("could not scale %s to %s"):format(tmp_filename, output_filename))
-- return nil
-- end
function notify_current_track()
data = mp.get_property_native("metadata")
function get_metadata(data, keys)
for k,v in pairs(keys) do
if data[v] and string.len(data[v]) > 0 then
return data[v]
end
end
return ""
end
-- srsly MPV, why do we have to do this? :-(
artist = get_metadata(data, {"artist", "ARTIST"})
album = get_metadata(data, {"album", "ALBUM"})
album_mbid = get_metadata(data, {"MusicBrainz Album Id",
"MUSICBRAINZ_ALBUMID"})
title = get_metadata(data, {"title", "TITLE"})
print_debug("notify_current_track: relevant metadata:")
print_debug("artist: " .. artist)
print_debug("album: " .. album)
print_debug("album_mbid: " .. album_mbid)
summary = ""
body = ""
params = ""
scaled_image = ""
delete_scaled_image = false
-- first try finding local cover art
abs_filename = os.getenv("PWD") .. "/" .. mp.get_property_native("path")
-- cover_image = get_folder_cover_art(abs_filename)
-- if cover_image and cover_image ~= "" then
-- scaled_image = tmpname()
-- scale_image(cover_image, scaled_image)
-- delete_scaled_image = true
-- end
-- -- then load cover art from the internet
-- if (not scaled_image or scaled_image == "")
-- and ((artist ~= "" and album ~= "") or album_mbid ~= "") then
-- scaled_image = fetch_musicbrainz_cover_art(artist, album, album_mbid)
-- cover_image = scaled_image
-- end
-- if scaled_image and string.len(scaled_image) > 1 then
-- print("found cover art in " .. cover_image)
-- params = " -i " .. string.shellescape(cover_image)
-- else
params = "-i /home/nietz/.local/share/icons/Snowy/apps/scalable/mpv-icon-8bits-64x64.png"
params = "-i /home/nietz/.config/mpv/script-opts/120px-Mpv-logo.svg.png"
-- end
if title == "" or title == "na" then
summary = string.shellescape(remove_extension(mp.get_property_native("filename")))
else
summary = string.shellescape(" " .. string.htmlescape(title))
end
if artist == "" or artist == "na" then
if album == "" or album == "na" then
body = string.shellescape(basename(os.getenv("PWD")))
else
body = string.shellescape("album: " .. string.htmlescape(album))
end
else
if album == "" or album == "na" then
body = string.shellescape("artist: " .. string.htmlescape(artist))
else
body = string.shellescape("artist : %s
album: %s"):format(
string.htmlescape(artist), string.htmlescape(album))
end
end
command = ("notify-send -a mpv %s %s %s"):format(summary, body, params)
print_debug("command: " .. command)
os.execute(command)
if delete_scaled_image and not os.remove(scaled_image) then
print("could not remove" .. scaled_image .. ", please remove it manually")
end
end
-- insert main() here
mp.register_event("file-loaded", notify_current_track)
~/.config/mpv/config
### Extension Specific #########################################################
[extension.mp3]
hwdec=no
vf-clr
x11-name=music
ontop
border=no
geometry=15%
target-prim=auto
target-trc=srgb
video-output-levels=full
display-tags=album,artist,title,lyrics-kor,lyrics-eng
term-osd-bar=yes
osd-status-msg='${time-pos}-${=time-pos} / ${duration} (${percent-pos}%)\n${osd-ass-cc/0}{\\1c&H725761&}{\\b1} ${osd-sym-cc}${osd-ass-cc/0}{\\1c&H725761&}{\\b1}\t${media-title}\n ${osd-ass-cc/0}{\\1c&HA3A3A3&}{\\b1}{\\fs10}\n${osd-ass-cc/0}{\\1c&HA3A3A3&}{\\b1} File Size: ${osd-ass-cc/0}{\\1c&HFFFFFF&}{\\b1}${file-size}\n${osd-ass-cc/0}{\\1c&HA3A3A3&}{\\b1} Format: ${osd-ass-cc/0}{\\1c&HFFFFFF&}{\\b1}${file-format}{?audio-codec-name:${audio-codec-name}}\n${osd-ass-cc/0}{\\1c&HA3A3A3&}{\\b1}\n Audio Codec: ${osd-ass-cc/0}{\\1c&H725761&}{\\b1}${?audio-codec:${audio-codec}}\n${osd-ass-cc/0}{\\1c&HA3A3A3&}{\\b1} Audio-bitrate: ${osd-ass-cc/0}{\\1c&H725761&}{\\b1}${?audio-bitrate:${audio-bitrate}} ${?audio-params/channels:(${audio-params/channels})}\n\n${osd-ass-cc/0}{\\1c&H573E57&}{\\b1} Output Driver: ${?current-ao: AO [${current-ao}]}{\\1c&H573E57&}{\\b1} {osd-ass-cc/0}{\\1c&H009aa7c0&}{\\b1}{\\an7}\n\n Mpv version: ${mpv-version}\n FFmpeg version: ${ffmpeg-version}'
osd-msg2='${osd-ass-cc/0}{\\r}{\\pos(100,10)}{\\1c&H573e78&}{\\b1}{\\fs10}\n ${filtered-metadata/title} by ${filtered-metadata/artist} ( ${filtered-metadata/album})${osd-ass-cc/0}{\\1c&H009aa7c0&}{\\b1}{\\fs6}\n\n ${?filtered-metadata/lyrics-kor:${filtered-metadata/lyrics-kor}}${?filtered-metadata/lyrics-eng:${filtered-metadata/lyrics-eng}}'
[extension.flac]
profile=extension.mp3
