feat(lyrics): integrate SimpMusic Lyrics provider #4041

UndeffinedDev · 2025-10-25T23:40:56Z

This PR adds integration with the SimpMusic Lyrics provider, allowing the application to fetch and display lyrics for supported tracks directly from the SimpMusic Lyrics API.

I added it because while using the app, I noticed that some songs, for example in Spanish, do not have lyrics or synchronized lyrics.

Example of what I mean

2025-10-25.18-38-52.mp4

(btw, this is my first contribution to the project and first PR I've done in a public project)

Copilot

Pull request overview

This PR integrates the SimpMusic Lyrics API as a new lyrics provider to improve lyrics coverage, particularly for songs in languages like Spanish where existing providers may not have lyrics or synchronized lyrics.

Key changes:

Added a new SimpMusicLyrics provider class that implements the LyricProvider interface
Registered the provider in the providers registry and enum
Implemented search logic with fallback strategies and artist matching using Jaro-Winkler similarity

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 7 comments.

File	Description
`src/plugins/synced-lyrics/providers/SimpMusicLyrics.ts`	New provider implementation with search, filtering, and result selection logic
`src/plugins/synced-lyrics/providers/index.ts`	Added `SimpMusicLyrics` to the `ProviderNames` enum
`src/plugins/synced-lyrics/providers/renderer.ts`	Registered the new provider instance in the providers object

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-12-19T07:07:09Z

src/plugins/synced-lyrics/providers/SimpMusicLyrics.ts

+      if (config()?.showLyricsEvenIfInexact) {
+        return null;
+      }
+      return null;


The logic in lines 58-61 is redundant. The condition checks if the config has showLyricsEvenIfInexact enabled, but then returns null regardless of the result. Both branches return null, making the if statement unnecessary. This code should either be removed entirely or have different logic in the two branches.

Copilot · 2025-12-19T07:07:10Z

src/plugins/synced-lyrics/providers/SimpMusicLyrics.ts

+      const ratio = Math.max(
+        ...permutations.map(([x, y]) => jaroWinkler(x, y)),
+      );
+      if (ratio < 0.85) continue;


The artist comparison threshold at 0.85 is more lenient than in other providers. For example, LRCLib uses 0.9 for the same comparison. This could lead to false positive matches. Consider aligning with the stricter threshold used by other providers in this codebase for consistency.

Suggested change

if (ratio < 0.85) continue;

if (ratio < 0.9) continue;

Copilot · 2025-12-19T07:07:10Z

src/plugins/synced-lyrics/providers/SimpMusicLyrics.ts

+          permutations.push([a.toLowerCase(), b.toLowerCase()]);
+        }
+      }
+


The permutations array creates only one direction of comparisons. Looking at LRCLib's implementation (lines 86-97), it creates permutations in both directions (artistA to artistB and artistB to artistA) to ensure symmetrical matching. The current implementation may miss valid matches depending on the comparison order.

Suggested change

permutations.push([a.toLowerCase(), b.toLowerCase()]);

}

}

const aLower = a.toLowerCase();

const bLower = b.toLowerCase();

// Add both directions to ensure symmetrical matching, as in LRCLib

permutations.push([aLower, bLower], [bLower, aLower]);

}

}

if (!permutations.length) {

continue;

}

Copilot · 2025-12-19T07:07:10Z

src/plugins/synced-lyrics/providers/SimpMusicLyrics.ts

+    filteredResults.sort(
+      (a, b) =>
+        Math.abs(a.durationSeconds - songDuration) -
+        Math.abs(b.durationSeconds - songDuration),
+    );
+
+    const maxVote = Math.max(...filteredResults.map((r) => r.vote ?? 0));
+
+    const topVoted = filteredResults.filter((r) => (r.vote ?? 0) === maxVote);
+


The sorting logic only considers duration differences but ignores the vote field when selecting from the top-voted results. After filtering for maximum votes, the results are already sorted by duration (line 88-92), so taking topVoted[0] gets the best match by duration among the highest-voted songs. However, this means the initial duration-based sort on filteredResults is overwritten. Consider moving the vote-based filtering before the duration sorting to make the logic clearer.

Suggested change

filteredResults.sort(

(a, b) =>

Math.abs(a.durationSeconds - songDuration) -

Math.abs(b.durationSeconds - songDuration),

);

const maxVote = Math.max(...filteredResults.map((r) => r.vote ?? 0));

const topVoted = filteredResults.filter((r) => (r.vote ?? 0) === maxVote);

const maxVote = Math.max(...filteredResults.map((r) => r.vote ?? 0));

const topVoted = filteredResults.filter((r) => (r.vote ?? 0) === maxVote);

topVoted.sort(

(a, b) =>

Math.abs(a.durationSeconds - songDuration) -

Math.abs(b.durationSeconds - songDuration),

);

Copilot · 2025-12-19T07:07:11Z

src/plugins/synced-lyrics/providers/SimpMusicLyrics.ts

+    let response = await fetch(url);
+
+    if (!response.ok) {
+      throw new Error(`HTTP error (${response.statusText})`);


The error message format is inconsistent with other providers in the codebase. LRCLib uses the format 'bad HTTPStatus(statusText)' while this uses 'HTTP error (statusText)'. For consistency across the codebase, consider using the same error message format as other providers.

Copilot · 2025-12-19T07:07:11Z

src/plugins/synced-lyrics/providers/SimpMusicLyrics.ts

+
+      response = await fetch(url);
+      if (!response.ok) {
+        throw new Error(`HTTP error (${response.statusText})`);


The error message format is inconsistent with other providers in the codebase. LRCLib uses the format 'bad HTTPStatus(statusText)' while this uses 'HTTP error (statusText)'. For consistency across the codebase, consider using the same error message format as other providers.

Copilot · 2025-12-19T07:07:11Z

src/plugins/synced-lyrics/providers/SimpMusicLyrics.ts

+
+      response = await fetch(url);
+      if (!response.ok) {
+        throw new Error(`HTTP error (${response.statusText})`);


The error message format is inconsistent with other providers in the codebase. LRCLib uses the format 'bad HTTPStatus(statusText)' while this uses 'HTTP error (statusText)'. For consistency across the codebase, consider using the same error message format as other providers.

ArjixWasTaken

some nitpicking, but otherwise this looks good

please follow the DRY principles and deduplicate your code by making a re-usable function where needed

ArjixWasTaken · 2025-12-19T07:13:05Z

src/plugins/synced-lyrics/providers/SimpMusicLyrics.ts

+    let data: SimpMusicSong[] = [];
+
+    let query = new URLSearchParams({ q: `${title} ${artist}` });
+    let url = `${this.baseUrl}/search?${query.toString()}`;


Redundant .toString

Suggested change

let url = `${this.baseUrl}/search?${query.toString()}`;

let url = `${this.baseUrl}/search?${query}`;

ArjixWasTaken · 2025-12-19T07:14:04Z

src/plugins/synced-lyrics/providers/SimpMusicLyrics.ts

+      throw new Error(`HTTP error (${response.statusText})`);
+    }
+
+    let json = (await response.json()) as SimpMusicResponse;


Please create a zod schema and parse the data.

ArjixWasTaken · 2025-12-19T07:14:34Z

src/plugins/synced-lyrics/providers/SimpMusicLyrics.ts

+
+    if (!data.length) {
+      query = new URLSearchParams({ q: title });
+      url = `${this.baseUrl}/search?${query.toString()}`;


Suggested change

url = `${this.baseUrl}/search?${query.toString()}`;

url = `${this.baseUrl}/search?${query}`;

ArjixWasTaken · 2025-12-19T07:15:30Z

src/plugins/synced-lyrics/providers/SimpMusicLyrics.ts

+        throw new Error(`HTTP error (${response.statusText})`);
+      }
+
+      json = (await response.json()) as SimpMusicResponse;


Zod schema x2

ArjixWasTaken · 2025-12-19T07:15:54Z

src/plugins/synced-lyrics/providers/SimpMusicLyrics.ts

+
+    if (!data.length && alternativeTitle) {
+      query = new URLSearchParams({ q: alternativeTitle });
+      url = `${this.baseUrl}/search?${query.toString()}`;


Suggested change

url = `${this.baseUrl}/search?${query.toString()}`;

url = `${this.baseUrl}/search?${query}`;

ArjixWasTaken · 2025-12-19T07:16:12Z

src/plugins/synced-lyrics/providers/SimpMusicLyrics.ts

+        throw new Error(`HTTP error (${response.statusText})`);
+      }
+
+      json = (await response.json()) as SimpMusicResponse;


Zod schema x3

ArjixWasTaken · 2025-12-19T08:03:15Z

src/plugins/synced-lyrics/providers/SimpMusicLyrics.ts

+type SimpMusicResponse = {
+  type: string;
+  data: SimpMusicSong[];
+  success?: boolean;
+};
+
+type SimpMusicSong = {
+  id: string;
+  videoId?: string;
+  songTitle: string;
+  artistName: string;
+  albumName?: string;
+  durationSeconds: number;
+  plainLyric?: string;
+  syncedLyrics?: string;
+  vote?: number;
+};


instead of types, please make zod schemas 🙏

ArjixWasTaken · 2025-12-22T08:01:24Z

Looks like UndeffinedDev has gone offline, maybe on vacation, so I'll be picking up this PR.

UndeffinedDev added 2 commits October 25, 2025 18:16

feat(lyrics): integrate SimpMusic Lyrics provider

7de9250

fix(prettier): Fix code style

1aa014e

Copilot AI mentioned this pull request Nov 10, 2025

Add SimpMusic Lyrics provider integration Daksh777/youtube-music#3

Merged

JellyBrick requested a review from ArjixWasTaken December 19, 2025 07:01

JellyBrick added the enhancement New feature or request label Dec 19, 2025

JellyBrick requested a review from Copilot December 19, 2025 07:02

Copilot started reviewing on behalf of JellyBrick December 19, 2025 07:02 View session

Copilot AI reviewed Dec 19, 2025

View reviewed changes

ArjixWasTaken requested changes Dec 19, 2025

View reviewed changes

ArjixWasTaken self-assigned this Dec 22, 2025

Merge branch 'master' into feat/simpmusic-lyrics-integration

87b0cdb

-          permutations.push([a.toLowerCase(), b.toLowerCase()]);
-        }
-      }
+          const aLower = a.toLowerCase();
+          const bLower = b.toLowerCase();
+          // Add both directions to ensure symmetrical matching, as in LRCLib
+          permutations.push([aLower, bLower], [bLower, aLower]);
+        }
+      }
+      if (!permutations.length) {
+        continue;
+      }

	let url = `${this.baseUrl}/search?${query.toString()}`;
	let url = `${this.baseUrl}/search?${query}`;

	url = `${this.baseUrl}/search?${query.toString()}`;
	url = `${this.baseUrl}/search?${query}`;

feat(lyrics): integrate SimpMusic Lyrics provider #4041

Are you sure you want to change the base?

feat(lyrics): integrate SimpMusic Lyrics provider #4041

Conversation

UndeffinedDev commented Oct 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Example of what I mean

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Dec 19, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 19, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 19, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 19, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 19, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 19, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 19, 2025

Choose a reason for hiding this comment

Uh oh!

ArjixWasTaken left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ArjixWasTaken commented Dec 22, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

UndeffinedDev commented Oct 25, 2025 •

edited

Loading