-
Notifications
You must be signed in to change notification settings - Fork 7
Expand file tree
/
Copy pathautolyrics.lua
More file actions
400 lines (333 loc) · 12.9 KB
/
autolyrics.lua
File metadata and controls
400 lines (333 loc) · 12.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
--[[
autolyrics.lua by zydezu
(https://github.com/zydezu/mpvconfig/blob/main/scripts/autolyrics.lua)
* Based on https://github.com/guidocella/mpv-lrc
Tries to download lyrics and display them for said file
--]]
mp.utils = require("mp.utils")
mp.input = require("mp.input")
local options = {
musixmatch_token = "2501192ac605cc2e16b6b2c04fe43d1011a38d919fe802976084e7",
download_for_all = false, -- try to get subtitles for music without metadata
load_for_youtube = true, -- try to load lyrics on youtube videos
store_lyrics_seperate = true, -- store lyrics in ~~Pictures/mpv/lyrics/
lyrics_store = "~/Pictures/mpv/lyrics/", -- where to store downloaded lyric files if store_lyrics_seperate is true
cache_loading = true, -- try to load lyrics that were already downloaded
strip_artists = true, -- remove lines with the names of the artists from NetEase lyrics
run_automatically = false -- run this script without pressing Alt+m
}
require("mp.options").read_options(options)
local manual_run = false
local got_lyrics = false
local without_timestamps = false
local downloading_name = ""
local old_subtitle_count, subtitle_count
local function show_error(message)
mp.msg.error(message)
if mp.get_property_native("vo-configured") and manual_run then
mp.osd_message(message, 5)
end
end
local function curl(args)
local r = mp.command_native({name = "subprocess", capture_stdout = true, args = args})
if r.killed_by_us then
-- don't print an error when curl fails because the playlist index was changed
return false
end
if r.status < 0 then
show_error("subprocess error: " .. r.error_string)
return false
end
if r.status > 0 then
show_error("curl failed with code " .. r.status)
return false
end
local response, error = mp.utils.parse_json(r.stdout)
if error then
show_error("Unable to parse the JSON response")
return false
end
return response
end
local function get_metadata()
local metadata = mp.get_property_native("metadata")
local title, artist, album
if metadata then
if next(metadata) == nil then
mp.msg.info("Couldn't load metadata!")
else
title = metadata.title or metadata.TITLE or metadata.Title
if options.download_for_all then
title = mp.get_property("media-title")
title = title:gsub("%b[]", "") .. " "
end
artist = mp.get_property("filtered-metadata/by-key/Artist") or mp.get_property("filtered-metadata/by-key/Album_Artist") or mp.get_property("filtered-metadata/by-key/Uploader")
if options.download_for_all and not artist then
artist = " "
end
album = metadata.album or metadata.ALBUM or metadata.Album or ""
end
else
mp.msg.info("Couldn't load metadata!")
end
if not title then
show_error("This song has no title metadata")
return false
end
if not artist then
show_error("This song has no artist metadata")
return false
end
local duration = mp.get_property_number("duration") or 0
return title, artist, album, duration
end
local function strip_artists(lyrics)
for _, pattern in pairs({'作词', '作詞', '作曲', '制作人', '编曲', '編曲', '詞', '曲'}) do
lyrics = lyrics:gsub('%[[%d:%.]*] ?' .. pattern .. ' ?[:：] ?.-\n', '')
end
return lyrics
end
local function create_folder(path)
local args
if package.config:sub(1,1) == '\\' then
-- Windows: normalize slashes and use 'mkdir' with '/S' for nested folders
local win_path = path:gsub("/", "\\")
args = { "cmd", "/c", "mkdir", win_path }
else
-- Unix/macOS/Linux
args = { "mkdir", "-p", path }
end
local res = mp.utils.subprocess({ args = args })
if res.status == 0 then
mp.msg.info("Successfully created folder: " .. path)
else
mp.msg.error("Failed to create folder: " .. path)
end
end
local function save_lyrics(lyrics)
if lyrics == "" or #lyrics < 100 then
show_error("Lyrics not found")
return
end
local current_sub_path = mp.get_property("current-tracks/sub/external-filename")
if current_sub_path and lyrics:find("^%[") == nil then
show_error("Only lyrics without timestamps are available, so the existing LRC file won't be overwritten")
return
end
lyrics = lyrics:gsub("’", "'"):gsub("' ", "'"):gsub("\\", "") -- remove strange characters
if options.strip_artists then
lyrics = strip_artists(lyrics)
end
local function is_url(s)
local url_pattern = "^[%w]+://[%w%.%-_]+%.[%a]+[-%w%.%-%_/?&=]*"
return string.match(s, url_pattern) ~= nil
end
downloading_name = downloading_name:gsub("\\", " "):gsub("/", " ")
local path = mp.get_property("path")
local media = downloading_name .. " [" .. mp.get_property("filename/no-ext") .. "]"
local pattern = '[\\/:*?"<>|]'
if (is_url(path) and path or nil) and options.load_for_youtube then
local youtube_ID = ""
if not downloading_name then
youtube_ID = " [" .. mp.get_property("filename"):match("[?&]v=([^&]+)") .. "]"
end
local filename = string.gsub(media:sub(1, 100):gsub(pattern, ""), "^%s*(.-)%s*$", "%1") .. youtube_ID
path = mp.command_native({"expand-path", options.lyrics_store .. filename})
else
if options.store_lyrics_seperate then
path = mp.command_native({"expand-path", options.lyrics_store .. media})
end
end
local lrc_path = (path:gsub("?", "") .. ".lrc")
local dir_path = lrc_path:match("(.+[\\/])")
if mp.utils.readdir(dir_path) == nil and options.store_lyrics_seperate then
create_folder(dir_path)
end
local lrc = io.open(lrc_path, "w")
if lrc == nil then
show_error("Failed writing to " .. lrc_path)
return
end
lrc:write(lyrics)
lrc:close()
if lyrics:find("^%[") then
mp.command(current_sub_path and "sub-reload" or "rescan-external-files")
if manual_run then
mp.osd_message("Lyrics downloaded")
end
got_lyrics = true
without_timestamps = false
else
if manual_run then
mp.osd_message("Lyrics without timestamps downloaded")
end
without_timestamps = true
end
end
local function musixmatch_download()
local title, artist, album, duration = get_metadata()
if not title then
return
end
mp.msg.info("Fetching lyrics (musixmatch)")
if manual_run then
mp.osd_message("Fetching lyrics (musixmatch)")
end
mp.msg.info("Requesting: " .. title .. " - " .. artist)
local response = curl({
"curl",
"--silent",
"--get",
"--cookie", "x-mxm-token-guid=" .. options.musixmatch_token, -- avoids a redirect
"https://apic-desktop.musixmatch.com/ws/1.1/macro.subtitles.get",
"--data", "app_id=web-desktop-app-v1.0",
"--data", "usertoken=" .. options.musixmatch_token,
"--data-urlencode", "q_track=" .. title,
"--data-urlencode", "q_artist=" .. artist,
})
if not response then
return
end
if response.message.header.status_code == 401 and response.message.header.hint == "renew" then
show_error("The Musixmatch token has been rate limited - https://github.com/guidocella/mpv-lrc >>> script-opts/lrc.conf explains how to generate a new one.")
return
end
if response.message.header.status_code ~= 200 then
show_error("Request failed with status code " .. response.message.header.status_code .. ". Hint: " .. response.message.header.hint)
return
end
local lyrics = ""
local body = response and response.message and response.message.body and response.message.body.macro_calls
if not body then
show_error("Invalid response structure: macro_calls not found")
return
end
local matcher = body["matcher.track.get"]
if not matcher or not matcher.message or not matcher.message.header then
show_error("Invalid matcher.track.get structure")
return
end
if matcher.message.header.status_code == 200 then
local track = matcher.message.body and matcher.message.body.track
if not track or not track.artist_name or not track.track_name then
show_error("Track data missing")
return
end
downloading_name = track.artist_name .. " - " .. track.track_name
if track.has_subtitles == 1 then
local subtitles = body["track.subtitles.get"]
if subtitles and subtitles.message and subtitles.message.body then
local subtitle_list = subtitles.message.body.subtitle_list
if subtitle_list and subtitle_list[1] and subtitle_list[1].subtitle then
lyrics = subtitle_list[1].subtitle.subtitle_body or ""
else
show_error("Subtitles data is malformed")
end
else
show_error("Subtitle data missing")
end
elseif track.has_lyrics == 1 then
local lyrics_data = body["track.lyrics.get"]
if lyrics_data and lyrics_data.message and lyrics_data.message.body and lyrics_data.message.body.lyrics then
lyrics = lyrics_data.message.body.lyrics.lyrics_body or ""
else
show_error("Lyrics data is missing or malformed")
end
elseif track.instrumental == 1 then
show_error("This is an instrumental track")
return
else
show_error("No lyrics or subtitles found")
end
end
save_lyrics(lyrics)
end
local function lrclib_download()
local title, artist, album, duration = get_metadata()
if not title or not artist or not album or not duration then
return
end
mp.osd_message('Fetching lyrics (lrclib.net)')
local response = curl({
"curl",
"--silent",
"--get",
"https://lrclib.net/api/get",
"--data-urlencode", "track_name=" .. title,
"--data-urlencode", "artist_name=" .. artist,
"--data-urlencode", "album_name=" .. album,
"--data-urlencode", "duration=" .. duration,
})
if not response or not response.artistName or not response.trackName then
return
end
if response.instrumental == true then
show_error("This is an instrumental track")
return
end
downloading_name = response.artistName .. " - " .. response.trackName
save_lyrics(response.syncedLyrics)
end
local function auto_download()
if old_subtitle_count ~= subtitle_count and options.cache_loading then
print("Subs previously downloaded - not downloading again")
else
got_lyrics = false
musixmatch_download()
if not got_lyrics then
lrclib_download()
end
if without_timestamps then
mp.osd_message("Lyrics without timestamps downloaded automatically")
end
if not got_lyrics then
show_error("Lyrics not found")
end
end
end
local function get_subtitle_count()
local track_list = mp.get_property_native("track-list", {})
local sub_count = 0
for _, track in ipairs(track_list) do
if track["type"] == "sub" then
sub_count = sub_count + 1
end
end
return sub_count
end
local function check_downloaded_subs()
old_subtitle_count, subtitle_count = get_subtitle_count(), nil
if old_subtitle_count > 0 then
print("Subtitles detected - aborting autolyrics.lua")
return
end
if options.cache_loading then
-- check if already downloaded lyrics exist and were loaded
local current_sub_path = mp.get_property("current-tracks/sub/external-filename")
mp.set_property("sub-file-paths", mp.command_native({"expand-path", options.lyrics_store}))
mp.command(current_sub_path and "sub-reload" or "rescan-external-files")
subtitle_count = get_subtitle_count()
end
if options.run_automatically then
auto_download()
end
end
mp.add_key_binding("alt+m", "musixmatch-download", function()
manual_run = true
auto_download()
end)
mp.add_key_binding("alt+n", "netease-download", function()
manual_run = true
lrclib_download()
end)
mp.add_key_binding("alt+o", "offset-sub", function()
local sub_path = mp.get_property("current-tracks/sub/external-filename")
if not sub_path then
show_error("No external subtitle is loaded")
return
end
mp.set_property("sub-delay", mp.get_property_number("playback-time"))
mp.command("sub-reload")
mp.osd_message("Subtitles updated")
end)
check_downloaded_subs()