Deluan Quintão
f03ca44a8e
* feat(plugins): add lyrics provider plugin capability Refactor the lyrics system from a static function to an interface-based service that supports WASM plugin providers. Plugins listed in the LyricsPriority config (alongside "embedded" and file extensions) are now resolved through the plugin system. Includes capability definition, Go/Rust PDK, adapter, Wire integration, and tests for plugin fallback behavior. * test(plugins): add lyrics capability integration test with test plugin * fix(plugins): default lyrics language to 'xxx' when plugin omits it Per the OpenSubsonic spec, the server must return 'und' or 'xxx' when the lyrics language is unknown. The lyrics plugin adapter was passing an empty string through when a plugin didn't provide a language value. This defaults the language to 'xxx', consistent with all other callers of model.ToLyrics() in the codebase. * refactor(plugins): rename lyrics import to improve clarity Signed-off-by: Deluan <deluan@navidrome.org> * refactor(lyrics): update TrackInfo description for clarity Signed-off-by: Deluan <deluan@navidrome.org> * fix(lyrics): enhance lyrics plugin handling and case sensitivity Signed-off-by: Deluan <deluan@navidrome.org> * fix(plugins): update payload type to string with byte format for task data Signed-off-by: Deluan <deluan@navidrome.org> --------- Signed-off-by: Deluan <deluan@navidrome.org>
60 lines
1.5 KiB
Go
60 lines
1.5 KiB
Go
package lyrics
|
|
|
|
import (
|
|
"context"
|
|
"strings"
|
|
|
|
"github.com/navidrome/navidrome/conf"
|
|
"github.com/navidrome/navidrome/log"
|
|
"github.com/navidrome/navidrome/model"
|
|
)
|
|
|
|
// Lyrics can fetch lyrics for a media file.
|
|
type Lyrics interface {
|
|
GetLyrics(ctx context.Context, mf *model.MediaFile) (model.LyricList, error)
|
|
}
|
|
|
|
// PluginLoader discovers and loads lyrics provider plugins.
|
|
type PluginLoader interface {
|
|
LoadLyricsProvider(name string) (Lyrics, bool)
|
|
}
|
|
|
|
type lyricsService struct {
|
|
pluginLoader PluginLoader
|
|
}
|
|
|
|
// NewLyrics creates a new lyrics service. pluginLoader may be nil if no plugin
|
|
// system is available.
|
|
func NewLyrics(pluginLoader PluginLoader) Lyrics {
|
|
return &lyricsService{pluginLoader: pluginLoader}
|
|
}
|
|
|
|
// GetLyrics returns lyrics for the given media file, trying sources in the
|
|
// order specified by conf.Server.LyricsPriority.
|
|
func (l *lyricsService) GetLyrics(ctx context.Context, mf *model.MediaFile) (model.LyricList, error) {
|
|
var lyricsList model.LyricList
|
|
var err error
|
|
|
|
for pattern := range strings.SplitSeq(conf.Server.LyricsPriority, ",") {
|
|
pattern = strings.TrimSpace(pattern)
|
|
switch {
|
|
case strings.EqualFold(pattern, "embedded"):
|
|
lyricsList, err = fromEmbedded(ctx, mf)
|
|
case strings.HasPrefix(pattern, "."):
|
|
lyricsList, err = fromExternalFile(ctx, mf, strings.ToLower(pattern))
|
|
default:
|
|
lyricsList, err = l.fromPlugin(ctx, mf, pattern)
|
|
}
|
|
|
|
if err != nil {
|
|
log.Error(ctx, "error getting lyrics", "source", pattern, err)
|
|
}
|
|
|
|
if len(lyricsList) > 0 {
|
|
return lyricsList, nil
|
|
}
|
|
}
|
|
|
|
return nil, nil
|
|
}
|