Merge pull request #111 from nouun/feature/synced-lyrics

feat(lyrics): add ability to fetch synced lyrics

Author: contre95

config.example.yaml

@@ -55,6 +55,7 @@ lyrics:
   providers:
     lrclib:
       enabled: true
+      prefer_synced: false # Some programs like navidrome require synced lyrics
 sync:
   enabled: true
   devices:

docs/jobs.md

@@ -8,8 +8,8 @@ jobs:
   log_path: ./logs/jobs
   webhooks:
     enabled: true
-     job_types:
-       - directory_import
+    job_types:
+      - directory_import
       - download_album
       - dap_sync
     command: | # ntfy

docs/lyrics.md

@@ -0,0 +1,29 @@
+# Lyrics
+
+Soulsolid supports automatic lyric retrieval and embedding via  lyric providers
+
+Lyric handling is separate from downloaders, allowing new providers to be added without modifying downloader plugins.
+
+## Lyric Providers
+
+Lyric providers are responsible for searching, retrieving, and returning lyrics for tracks based on available metadata (e.g. title, artist, album, ISRC, duration).
+
+Providers may supply:
+	•	Unsynced lyrics — plain text lyrics
+	•	Synced lyrics — time-aligned lyrics (e.g. LRC-style timestamps)
+
+## Configuration
+
+Lyric providers are configured in the main config.yaml file:
+
+```yml
+lyrics:
+  providers:
+    lrclib:
+      enabled: true
+      prefer_synced: false
+```
+
+## Provider Options
+- **enabled**: Enables or disables the provider entirely.
+- **prefer_synced**: When set to true, synced lyrics will be preferred over unsynced lyrics if both are available.

src/features/config/config.go

@@ -81,17 +81,23 @@ type Metadata struct {
 	Providers map[string]Provider `yaml:"providers"`
 }
 
-// Lyrics holds the configuration for lyrics providers
-type Lyrics struct {
-	Providers map[string]Provider `yaml:"providers"`
-}
-
 // Provider holds configuration for individual tagging providers
 type Provider struct {
 	Enabled bool    `yaml:"enabled"`
 	Secret  *string `yaml:"secret,omitempty"`
 }
 
+// Lyrics holds the configuration for lyrics providers
+type Lyrics struct {
+	Providers map[string]LyricsProvider `yaml:"providers"`
+}
+
+// Provider holds configuration for individual lyric providers
+type LyricsProvider struct {
+	Enabled      bool `yaml:"enabled"`
+	PreferSynced bool `yaml:"prefer_synced,omitempty"`
+}
+
 // Sync holds configuration for device synchronization
 type Sync struct {
 	Enabled bool     `yaml:"enabled"`

src/features/config/loader.go

@@ -145,10 +145,11 @@ func createDefaultConfig() *Config {
 				},
 			},
 		},
-		Lyrics: Lyrics{ // NOTE: Add this to the documentation
-			Providers: map[string]Provider{
+		Lyrics: Lyrics{
+			Providers: map[string]LyricsProvider{
 				"lrclib": {
-					Enabled: true,
+					Enabled:      true,
+					PreferSynced: false,
 				},
 			},
 		},

src/infra/providers/lrclib.go

@@ -26,12 +26,13 @@ type lrclibSong struct {
 
 // LRCLibProvider implements LyricsProvider for LRCLib
 type LRCLibProvider struct {
-	enabled bool
+	enabled      bool
+	preferSynced bool
 }
 
 // NewLRCLibProvider creates a new LRCLib provider
-func NewLRCLibProvider(enabled bool) *LRCLibProvider {
-	return &LRCLibProvider{enabled: enabled}
+func NewLRCLibProvider(enabled bool, preferSynced bool) *LRCLibProvider {
+	return &LRCLibProvider{enabled: enabled, preferSynced: preferSynced}
 }
 
 func (p *LRCLibProvider) SearchLyrics(ctx context.Context, params music.LyricsSearchParams) (string, error) {
@@ -84,6 +85,15 @@ func (p *LRCLibProvider) SearchLyrics(ctx context.Context, params music.LyricsSe
 		return "", fmt.Errorf("no lyrics found")
 	}
 
+	// Iterate over all songs to find synced lyrics
+	if p.preferSynced {
+		for _, song := range searchResp {
+			if song.SyncedLyrics != "" {
+				return song.SyncedLyrics, nil
+			}
+		}
+	}
+
 	// Return the first result's plain lyrics
 	song := searchResp[0]
 	if song.PlainLyrics != "" {

src/main.go

@@ -90,7 +90,7 @@ func main() {
 	discogsProvider := providers.NewDiscogsProvider(cfgManager.Get().Metadata.Providers["discogs"].Enabled, discogsSecret)
 	deezerProvider := providers.NewDeezerProvider(cfgManager.Get().Metadata.Providers["deezer"].Enabled)
 
-	lrclibProvider := providers.NewLRCLibProvider(cfgManager.Get().Lyrics.Providers["lrclib"].Enabled)
+	lrclibProvider := providers.NewLRCLibProvider(cfgManager.Get().Lyrics.Providers["lrclib"].Enabled, cfgManager.Get().Lyrics.Providers["lrclib"].PreferSynced)
 
 	acoustIDService := providers.NewAcoustIDService(cfgManager)
 	lyricsService := lyrics.NewService(tagWriter, tagReader, db, map[string]lyrics.LyricsProvider{