Lyrix provider

README.md

@@ -75,8 +75,10 @@ Make sure all packages are updated / installed by entering `yarn install` after.
 
 ## Lyrics
 
-Currently (experimentally) fetches lyrics using [musixmatch.com](https://musixmatch.com/)'s internal API and uses them to schedule each lyric in-sync with the song.
-This feature is currently in development and I will **not** provide support on retrieving an internal API. (See .env.example on how to setup)
+~~Currently (experimentally) fetches lyrics using [musixmatch.com](https://musixmatch.com/)'s internal API and uses them to schedule each lyric in-sync with the song.
+This feature is currently in development and I will **not** provide support on retrieving an internal API. (See .env.example on how to setup)~~
+
+Using a custom token can still be used but will now also automatically fetch lyrics from [lyrix.vercel.app](https://github.com/BlueCatSoftware/Lyrix). No need to configure anything!
 
 ## Screenshots
 

src/app/cache.ts

@@ -1,6 +1,6 @@
 import config from "./config";
 import { log } from "./logger";
-import { Subtitle } from "./mxm";
+import { Subtitle } from "./lyrics/types";
 import { storage } from ".";
 
 interface SubtitleCache {

src/app/config.ts

@@ -11,6 +11,8 @@ const setupConfiguration = () => {
     MXM_SIGNATURE: z.string().optional(),
     MXM_COOKIE: z.string().optional(),
 
+    LYRIX_SERVER: z.string().default("https://lyrix.vercel.app"),
+
     OSC_TARGET_ADDRESS: z.string().optional().default("localhost"),
     OSC_TARGET_PORT: z.number().optional().default(9000),
 

src/app/index.ts

@@ -6,7 +6,8 @@ import { create as createStorage } from "node-persist";
 import SpotifyWebApi from "spotify-web-api-node";
 import config from "./config";
 import { log } from "./logger";
-import { queueLyrics } from "./mxm";
+import { queueLyrix } from "./lyrics/lyrix";
+import { queueLyrics } from "./lyrics/mxm";
 
 let server: Server | undefined;
 const oscClient = new Client(config.OSC_TARGET_ADDRESS, config.OSC_TARGET_PORT);
@@ -129,6 +130,9 @@ const startListening = async (
         ) {
           currentLyrics.forEach((lyricTimer) => clearTimeout(lyricTimer));
           currentLyrics = await queueLyrics(progress_ms, item, oscClient);
+        } else if (config.LYRIX_SERVER && progress_ms) {
+          currentLyrics.forEach((lyricTimer) => clearTimeout(lyricTimer));
+          currentLyrics = await queueLyrix(progress_ms, item, oscClient);
         }
         currentSong = item.id;
         oscClient.send(

src/app/lyrics/lyrix.ts

@@ -0,0 +1,79 @@
+import axios from "axios";
+import { Client, Message } from "node-osc";
+import { loadSubtitles, saveSubtitles } from "../cache";
+import config from "../config";
+import { log } from "../logger";
+import { LyrixSubtitle, Subtitle } from "./types";
+
+const pullLyrics = async (song: SpotifyApi.TrackObjectFull) => {
+  const response = await axios.get(
+    `${config.LYRIX_SERVER}/getLyrics/${song.id}`,
+    { validateStatus: () => true }
+  );
+
+  const { status } = response;
+  if (status != 200) {
+    log(`Error: Could not retrieve lyrics: ${status}.`);
+    return undefined;
+  }
+
+  const lines = response.data.lyrics?.lines as LyrixSubtitle[] | undefined;
+
+  if (!lines) return undefined;
+
+  return lines.map(
+    (line) =>
+      ({
+        text: line.words,
+        time: {
+          total: +line.startTimeMs / 1000,
+        },
+      } as Subtitle)
+  );
+};
+
+const queueLyrix = async (
+  playbackProgress: number,
+  song: SpotifyApi.TrackObjectFull,
+  oscClient: Client
+) => {
+  const queuedLyrics: NodeJS.Timeout[] = [];
+  const retrievedLyrics = await getLyrics(song);
+
+  if (!retrievedLyrics) return [];
+
+  retrievedLyrics.forEach((lyric) => {
+    const lyricTime = lyric.time.total * 1000;
+    if (lyricTime <= playbackProgress) return [];
+
+    queuedLyrics.push(
+      setTimeout(() => {
+        log(`>> ${lyric.text}`, false);
+        oscClient.send(
+          new Message(
+            "/chatbox/input",
+            lyric.text ? `(♪) ${lyric.text}` : "",
+            true,
+            false
+          )
+        );
+      }, lyricTime - playbackProgress)
+    );
+  });
+
+  log(`Queued ${retrievedLyrics.length} lyrics.`);
+  return queuedLyrics;
+};
+
+const getLyrics = async (song: SpotifyApi.TrackObjectFull) => {
+  let retrievedLyrics = await loadSubtitles(song);
+
+  if (!retrievedLyrics) {
+    log(`No local lyrics found for ${song.name}. Pulling from lyrix...`);
+    retrievedLyrics = (await pullLyrics(song)) || [];
+    await saveSubtitles(song, retrievedLyrics);
+  }
+  return retrievedLyrics;
+};
+
+export { pullLyrics, queueLyrix };

src/app/mxm.ts → src/app/lyrics/mxm.ts

@@ -1,18 +1,9 @@
 import axios from "axios";
 import { Client, Message } from "node-osc";
-import { loadSubtitles, saveSubtitles } from "./cache";
-import config from "./config";
-import { log } from "./logger";
-
-interface Subtitle {
-  text: string;
-  time: {
-    total: number;
-    minutes: number;
-    seconds: number;
-    hundredths: number;
-  };
-}
+import { loadSubtitles, saveSubtitles } from "../cache";
+import config from "../config";
+import { log } from "../logger";
+import { Subtitle } from "./types";
 
 const pullLyrics = async (song: SpotifyApi.TrackObjectFull) => {
   const response = await axios.get(
@@ -92,7 +83,6 @@ const queueLyrics = async (
     queuedLyrics.push(
       setTimeout(() => {
         log(`>> ${lyric.text}`, false);
-        //console.log(`>> ${lyric.text}`);
         oscClient.send(
           new Message(
             "/chatbox/input",
@@ -120,4 +110,4 @@ const getLyrics = async (song: SpotifyApi.TrackObjectFull) => {
   return retrievedLyrics;
 };
 
-export { pullLyrics, queueLyrics, getLyrics, Subtitle };
+export { pullLyrics, queueLyrics, getLyrics };

src/app/lyrics/types.ts

@@ -0,0 +1,14 @@
+export interface Subtitle {
+  text: string;
+  time: {
+    total: number;
+    minutes?: number;
+    seconds?: number;
+    hundredths?: number;
+  };
+}
+
+export interface LyrixSubtitle {
+  startTimeMs: string;
+  words: string;
+}