mirror of
https://github.com/navidrome/navidrome.git
synced 2026-08-31 07:30:32 +00:00
Merge 81c3597018e0061c39f5af7343b239bde59978da into 2a43c4683ea41492a6ad8c6b22af9a1f7eacb1e9
This commit is contained in:
commit
0d5b1157b3
@ -52,6 +52,7 @@ A share of the revenue helps fund the development of Navidrome at no additional
|
||||
- **Multi-platform**, runs on macOS, Linux and Windows. **Docker** images are also provided
|
||||
- Ready to use binaries for all major platforms, including **Raspberry Pi**
|
||||
- Automatically **monitors your library** for changes, importing new files and reloading new metadata
|
||||
- Supports lyrics from sidecar **.ttml**, **.elrc**, **.lrc**, **.srt**, **.txt** files and embedded **TTML**, **Enhanced LRC**, **LRC**, **SRT**, and plain-text tags (via `lyricspriority`)
|
||||
- **Themeable**, modern and responsive **Web interface** based on [Material UI](https://material-ui.com)
|
||||
- **Compatible** with all Subsonic/Madsonic/Airsonic [clients](https://www.navidrome.org/docs/overview/#apps)
|
||||
- **Transcoding** on the fly. Can be set per user/player. **Opus encoding is supported**
|
||||
|
||||
@ -776,7 +776,7 @@ func setViperDefaults() {
|
||||
viper.SetDefault("artistartpriority", "artist.*, album/artist.*, external")
|
||||
viper.SetDefault("artistimagefolder", "")
|
||||
viper.SetDefault("discartpriority", "disc*.*, cd*.*, cover.*, folder.*, front.*, discsubtitle, embedded")
|
||||
viper.SetDefault("lyricspriority", ".lrc,.txt,embedded")
|
||||
viper.SetDefault("lyricspriority", ".ttml,.elrc,.lrc,.srt,.txt,embedded")
|
||||
viper.SetDefault("enablegravatar", false)
|
||||
viper.SetDefault("enablefavourites", true)
|
||||
viper.SetDefault("enablestarrating", true)
|
||||
|
||||
64
core/lyrics/embedded.go
Normal file
64
core/lyrics/embedded.go
Normal file
@ -0,0 +1,64 @@
|
||||
package lyrics
|
||||
|
||||
import (
|
||||
"encoding/xml"
|
||||
"strings"
|
||||
|
||||
"github.com/navidrome/navidrome/log"
|
||||
"github.com/navidrome/navidrome/model"
|
||||
)
|
||||
|
||||
// ParseEmbedded parses lyrics read from media-file metadata tags. It detects rich
|
||||
// payloads before falling back to the generic LRC/plain-text parser, because
|
||||
// text sanitization would otherwise strip TTML XML markup.
|
||||
func ParseEmbedded(language, text string) (model.LyricList, error) {
|
||||
text = strings.TrimPrefix(text, "\ufeff")
|
||||
|
||||
if isTTMLDocument(text) {
|
||||
list, err := parseTTMLWithDefaultLang([]byte(text), language)
|
||||
if err == nil && len(list) > 0 {
|
||||
return list, nil
|
||||
}
|
||||
if err != nil {
|
||||
log.Warn("Error parsing embedded TTML lyrics, falling back to plain lyrics", "error", err)
|
||||
}
|
||||
}
|
||||
|
||||
list, err := parseSRTWithLanguage([]byte(text), language)
|
||||
if err == nil && len(list) > 0 {
|
||||
return list, nil
|
||||
}
|
||||
if err != nil && strings.Contains(text, "-->") {
|
||||
log.Warn("Error parsing embedded SRT lyrics, falling back to plain lyrics", "error", err)
|
||||
}
|
||||
|
||||
lyric, err := model.ToLyrics(language, text)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
if lyric == nil || lyric.IsEmpty() {
|
||||
return nil, nil
|
||||
}
|
||||
return model.LyricList{*lyric}, nil
|
||||
}
|
||||
|
||||
func isTTMLDocument(text string) bool {
|
||||
decoder := xml.NewDecoder(strings.NewReader(strings.TrimSpace(text)))
|
||||
for {
|
||||
token, err := decoder.Token()
|
||||
if err != nil {
|
||||
return false
|
||||
}
|
||||
if start, ok := token.(xml.StartElement); ok {
|
||||
return strings.EqualFold(start.Name.Local, "tt")
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func normalizeEmbeddedLanguage(language string) string {
|
||||
language = strings.ToLower(strings.TrimSpace(language))
|
||||
if language == "" {
|
||||
return "xxx"
|
||||
}
|
||||
return language
|
||||
}
|
||||
169
core/lyrics/embedded_test.go
Normal file
169
core/lyrics/embedded_test.go
Normal file
@ -0,0 +1,169 @@
|
||||
package lyrics
|
||||
|
||||
import (
|
||||
"strings"
|
||||
|
||||
"github.com/navidrome/navidrome/model"
|
||||
. "github.com/onsi/ginkgo/v2"
|
||||
. "github.com/onsi/gomega"
|
||||
)
|
||||
|
||||
var _ = Describe("ParseEmbedded", func() {
|
||||
It("should parse embedded TTML with the tag language as the default", func() {
|
||||
content := `<tt xmlns="http://www.w3.org/ns/ttml" xmlns:ttm="http://www.w3.org/ns/ttml#metadata">
|
||||
<head>
|
||||
<metadata>
|
||||
<ttm:agent xml:id="lead" ttm:type="person">
|
||||
<ttm:name>Lead Vocal</ttm:name>
|
||||
</ttm:agent>
|
||||
</metadata>
|
||||
</head>
|
||||
<body>
|
||||
<div>
|
||||
<p begin="00:00:01.000" end="00:00:03.000">
|
||||
<span begin="00:00:01.000" end="00:00:02.000" ttm:agent="lead">Hello </span><span begin="00:00:02.000" end="00:00:03.000" ttm:agent="lead">world</span>
|
||||
</p>
|
||||
</div>
|
||||
</body>
|
||||
</tt>`
|
||||
|
||||
list, err := ParseEmbedded("ENG", content)
|
||||
|
||||
Expect(err).ToNot(HaveOccurred())
|
||||
Expect(list).To(HaveLen(1))
|
||||
Expect(list[0].Kind).To(Equal("main"))
|
||||
Expect(list[0].Lang).To(Equal("eng"))
|
||||
Expect(list[0].Synced).To(BeTrue())
|
||||
Expect(list[0].Agents).To(Equal([]model.Agent{{ID: "lead", Role: "main", Name: "Lead Vocal"}}))
|
||||
Expect(list[0].Line).To(HaveLen(1))
|
||||
Expect(list[0].Line[0].Start).To(Equal(ptr(int64(1000))))
|
||||
Expect(list[0].Line[0].End).To(Equal(ptr(int64(3000))))
|
||||
Expect(list[0].Line[0].Value).To(Equal("Hello world"))
|
||||
Expect(list[0].Line[0].Cue).To(HaveLen(2))
|
||||
Expect(list[0].Line[0].Cue[0].AgentID).To(Equal("lead"))
|
||||
Expect(list[0].Line[0].Cue[0].ByteStart).To(Equal(0))
|
||||
Expect(list[0].Line[0].Cue[0].ByteEnd).To(Equal(5))
|
||||
Expect(list[0].Line[0].Cue[1].ByteStart).To(Equal(6))
|
||||
Expect(list[0].Line[0].Cue[1].ByteEnd).To(Equal(10))
|
||||
})
|
||||
|
||||
It("should preserve embedded TTML translation and pronunciation tracks", func() {
|
||||
content := `<tt xmlns="http://www.w3.org/ns/ttml" xmlns:itunes="http://music.apple.com/lyric-ttml-internal">
|
||||
<head>
|
||||
<metadata>
|
||||
<iTunesMetadata xmlns="http://music.apple.com/lyric-ttml-internal">
|
||||
<translations>
|
||||
<translation xml:lang="es">
|
||||
<text for="L1">Hola</text>
|
||||
</translation>
|
||||
</translations>
|
||||
<transliterations>
|
||||
<transliteration xml:lang="ja-Latn">
|
||||
<text for="L1"><span begin="00:00:01.000" end="00:00:01.300" xmlns="http://www.w3.org/ns/ttml">ko</span><span begin="00:00:01.300" end="00:00:01.600" xmlns="http://www.w3.org/ns/ttml">nni</span></text>
|
||||
</transliteration>
|
||||
</transliterations>
|
||||
</iTunesMetadata>
|
||||
</metadata>
|
||||
</head>
|
||||
<body xml:lang="ja">
|
||||
<div>
|
||||
<p begin="00:00:01.000" end="00:00:02.000" itunes:key="L1">こんにちは</p>
|
||||
</div>
|
||||
</body>
|
||||
</tt>`
|
||||
|
||||
list, err := ParseEmbedded("eng", content)
|
||||
|
||||
Expect(err).ToNot(HaveOccurred())
|
||||
Expect(list).To(HaveLen(3))
|
||||
Expect(list[0].Kind).To(Equal("main"))
|
||||
Expect(list[0].Lang).To(Equal("ja"))
|
||||
Expect(list[0].Line[0].Value).To(Equal("こんにちは"))
|
||||
Expect(list[1].Kind).To(Equal("translation"))
|
||||
Expect(list[1].Lang).To(Equal("es"))
|
||||
Expect(list[1].Line[0].Value).To(Equal("Hola"))
|
||||
Expect(list[2].Kind).To(Equal("pronunciation"))
|
||||
Expect(list[2].Lang).To(Equal("ja-latn"))
|
||||
Expect(list[2].Line[0].Value).To(Equal("konni"))
|
||||
Expect(list[2].Line[0].Cue).To(HaveLen(2))
|
||||
})
|
||||
|
||||
It("should parse embedded SRT with the tag language", func() {
|
||||
content := `1
|
||||
00:00:18,800 --> 00:00:22,800
|
||||
We're from subtitles
|
||||
|
||||
2
|
||||
00:00:22,801 --> 00:00:26,000
|
||||
Another subtitle line`
|
||||
|
||||
list, err := ParseEmbedded("POR", content)
|
||||
|
||||
Expect(err).ToNot(HaveOccurred())
|
||||
Expect(list).To(Equal(model.LyricList{
|
||||
{
|
||||
Lang: "por",
|
||||
Line: []model.Line{
|
||||
{
|
||||
Start: ptr(int64(18800)),
|
||||
End: ptr(int64(22800)),
|
||||
Value: "We're from subtitles",
|
||||
},
|
||||
{
|
||||
Start: ptr(int64(22801)),
|
||||
End: ptr(int64(26000)),
|
||||
Value: "Another subtitle line",
|
||||
},
|
||||
},
|
||||
Synced: true,
|
||||
},
|
||||
}))
|
||||
})
|
||||
|
||||
It("should parse embedded SRT blocks separated by whitespace-only blank lines", func() {
|
||||
content := "1\n00:00:01,000 --> 00:00:02,000\nFirst subtitle\n \n2\n00:00:03,000 --> 00:00:04,000\nSecond subtitle"
|
||||
|
||||
list, err := ParseEmbedded("eng", content)
|
||||
|
||||
Expect(err).ToNot(HaveOccurred())
|
||||
Expect(list).To(HaveLen(1))
|
||||
Expect(list[0].Line).To(Equal([]model.Line{
|
||||
{Start: ptr(int64(1000)), End: ptr(int64(2000)), Value: "First subtitle"},
|
||||
{Start: ptr(int64(3000)), End: ptr(int64(4000)), Value: "Second subtitle"},
|
||||
}))
|
||||
})
|
||||
|
||||
It("should keep embedded enhanced LRC cues", func() {
|
||||
content := "[00:01.00]<00:01.00>Lead <00:01.50>words"
|
||||
|
||||
list, err := ParseEmbedded("eng", content)
|
||||
|
||||
Expect(err).ToNot(HaveOccurred())
|
||||
Expect(list).To(HaveLen(1))
|
||||
Expect(list[0].Lang).To(Equal("eng"))
|
||||
Expect(list[0].Synced).To(BeTrue())
|
||||
Expect(list[0].Line[0].Value).To(Equal("Lead words"))
|
||||
Expect(list[0].Line[0].Cue).To(HaveLen(2))
|
||||
})
|
||||
|
||||
It("should fall back to plain lyrics when embedded TTML is invalid", func() {
|
||||
content := `<tt xmlns="http://www.w3.org/ns/ttml">
|
||||
<body>
|
||||
<p begin="not-a-time">Broken</p>
|
||||
</body>
|
||||
</tt>`
|
||||
|
||||
list, err := ParseEmbedded("eng", content)
|
||||
|
||||
Expect(err).ToNot(HaveOccurred())
|
||||
Expect(list).To(HaveLen(1))
|
||||
Expect(list[0].Lang).To(Equal("eng"))
|
||||
Expect(list[0].Synced).To(BeFalse())
|
||||
Expect(list[0].Line).ToNot(BeEmpty())
|
||||
values := make([]string, 0, len(list[0].Line))
|
||||
for _, line := range list[0].Line {
|
||||
values = append(values, line.Value)
|
||||
}
|
||||
Expect(strings.Join(values, "\n")).To(ContainSubstring("Broken"))
|
||||
})
|
||||
})
|
||||
5
core/lyrics/external_test_helpers_test.go
Normal file
5
core/lyrics/external_test_helpers_test.go
Normal file
@ -0,0 +1,5 @@
|
||||
package lyrics_test
|
||||
|
||||
func ptr[T any](v T) *T {
|
||||
return &v
|
||||
}
|
||||
@ -14,6 +14,12 @@ type Lyrics interface {
|
||||
GetLyrics(ctx context.Context, mf *model.MediaFile) (model.LyricList, error)
|
||||
}
|
||||
|
||||
// BatchLyrics can resolve lyrics across multiple candidate media files while
|
||||
// still honoring the configured source priority globally.
|
||||
type BatchLyrics interface {
|
||||
GetLyricsForMediaFiles(ctx context.Context, mediaFiles []model.MediaFile) (model.LyricList, error)
|
||||
}
|
||||
|
||||
// PluginLoader discovers and loads lyrics provider plugins.
|
||||
type PluginLoader interface {
|
||||
LoadLyricsProvider(name string) (Lyrics, bool)
|
||||
@ -32,28 +38,53 @@ func NewLyrics(pluginLoader PluginLoader) Lyrics {
|
||||
// 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
|
||||
return l.getLyricsForCandidates(ctx, []*model.MediaFile{mf})
|
||||
}
|
||||
|
||||
// GetLyricsForMediaFiles resolves lyrics across duplicate media files while
|
||||
// preserving the configured source priority across the full candidate set.
|
||||
func (l *lyricsService) GetLyricsForMediaFiles(ctx context.Context, mediaFiles []model.MediaFile) (model.LyricList, error) {
|
||||
candidates := make([]*model.MediaFile, 0, len(mediaFiles))
|
||||
for i := range mediaFiles {
|
||||
candidates = append(candidates, &mediaFiles[i])
|
||||
}
|
||||
return l.getLyricsForCandidates(ctx, candidates)
|
||||
}
|
||||
|
||||
func (l *lyricsService) getLyricsForCandidates(ctx context.Context, mediaFiles []*model.MediaFile) (model.LyricList, 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 pattern == "" {
|
||||
continue
|
||||
}
|
||||
|
||||
if err != nil {
|
||||
log.Error(ctx, "error getting lyrics", "source", pattern, err)
|
||||
}
|
||||
for _, mf := range mediaFiles {
|
||||
if mf == nil {
|
||||
continue
|
||||
}
|
||||
|
||||
if len(lyricsList) > 0 {
|
||||
return lyricsList, nil
|
||||
lyricsList, err := l.getLyricsFromSource(ctx, mf, pattern)
|
||||
if err != nil {
|
||||
log.Error(ctx, "error getting lyrics", "source", pattern, err)
|
||||
continue
|
||||
}
|
||||
|
||||
if len(lyricsList) > 0 {
|
||||
return lyricsList, nil
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return nil, nil
|
||||
}
|
||||
|
||||
func (l *lyricsService) getLyricsFromSource(ctx context.Context, mf *model.MediaFile, pattern string) (model.LyricList, error) {
|
||||
switch {
|
||||
case strings.EqualFold(pattern, "embedded"):
|
||||
return fromEmbedded(ctx, mf)
|
||||
case strings.HasPrefix(pattern, "."):
|
||||
return fromExternalFile(ctx, mf, pattern)
|
||||
default:
|
||||
return l.fromPlugin(ctx, mf, pattern)
|
||||
}
|
||||
}
|
||||
|
||||
@ -5,6 +5,7 @@ import (
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"os"
|
||||
"path/filepath"
|
||||
|
||||
"github.com/navidrome/navidrome/conf"
|
||||
"github.com/navidrome/navidrome/conf/configtest"
|
||||
@ -44,6 +45,71 @@ var _ = Describe("sources", func() {
|
||||
},
|
||||
}
|
||||
|
||||
elrcLyrics := model.LyricList{
|
||||
model.Lyrics{
|
||||
DisplayArtist: "ELRC Artist",
|
||||
DisplayTitle: "ELRC Song",
|
||||
Lang: "eng",
|
||||
Line: []model.Line{
|
||||
{
|
||||
Start: ptr(int64(1000)),
|
||||
End: ptr(int64(3000)),
|
||||
Value: "Lead words",
|
||||
Cue: []model.Cue{
|
||||
{
|
||||
Start: ptr(int64(1000)),
|
||||
End: ptr(int64(1500)),
|
||||
Value: "Lead ",
|
||||
ByteStart: 0,
|
||||
ByteEnd: 4,
|
||||
},
|
||||
{
|
||||
Start: ptr(int64(1500)),
|
||||
End: ptr(int64(3000)),
|
||||
Value: "words",
|
||||
ByteStart: 5,
|
||||
ByteEnd: 9,
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
Start: ptr(int64(3000)),
|
||||
Value: "Fallback line",
|
||||
},
|
||||
},
|
||||
Synced: true,
|
||||
},
|
||||
}
|
||||
|
||||
ttmlLyrics := model.LyricList{
|
||||
model.Lyrics{
|
||||
Kind: "main",
|
||||
Lang: "eng",
|
||||
Line: []model.Line{
|
||||
{
|
||||
Start: ptr(int64(18800)),
|
||||
Value: "We're no strangers to love",
|
||||
},
|
||||
{
|
||||
Start: ptr(int64(22800)),
|
||||
Value: "You know the rules and so do I",
|
||||
},
|
||||
},
|
||||
Synced: true,
|
||||
},
|
||||
model.Lyrics{
|
||||
Kind: "main",
|
||||
Lang: "por",
|
||||
Line: []model.Line{
|
||||
{
|
||||
Start: ptr(int64(18800)),
|
||||
Value: "Nao somos estranhos ao amor",
|
||||
},
|
||||
},
|
||||
Synced: true,
|
||||
},
|
||||
}
|
||||
|
||||
unsyncedLyrics := model.LyricList{
|
||||
model.Lyrics{
|
||||
Lang: "xxx",
|
||||
@ -59,6 +125,25 @@ var _ = Describe("sources", func() {
|
||||
},
|
||||
}
|
||||
|
||||
srtLyrics := model.LyricList{
|
||||
model.Lyrics{
|
||||
Lang: "xxx",
|
||||
Line: []model.Line{
|
||||
{
|
||||
Start: ptr(int64(18800)),
|
||||
End: ptr(int64(22800)),
|
||||
Value: "We're from subtitles",
|
||||
},
|
||||
{
|
||||
Start: ptr(int64(22801)),
|
||||
End: ptr(int64(26000)),
|
||||
Value: "Another subtitle line",
|
||||
},
|
||||
},
|
||||
Synced: true,
|
||||
},
|
||||
}
|
||||
|
||||
BeforeEach(func() {
|
||||
DeferCleanup(configtest.SetupConfig())
|
||||
|
||||
@ -80,7 +165,64 @@ var _ = Describe("sources", func() {
|
||||
},
|
||||
Entry("embedded > lrc > txt", "embedded,.lrc,.txt", embeddedLyrics),
|
||||
Entry("lrc > embedded > txt", ".lrc,embedded,.txt", syncedLyrics),
|
||||
Entry("txt > lrc > embedded", ".txt,.lrc,embedded", unsyncedLyrics))
|
||||
Entry("elrc > lrc > embedded", ".elrc,.lrc,embedded", elrcLyrics),
|
||||
Entry("srt > txt > embedded", ".srt,.txt,embedded", srtLyrics),
|
||||
Entry("txt > lrc > embedded", ".txt,.lrc,embedded", unsyncedLyrics),
|
||||
Entry("ttml > elrc > lrc > srt > embedded", ".ttml,.elrc,.lrc,.srt,embedded", ttmlLyrics))
|
||||
|
||||
It("resolves source priority across duplicate media files", func() {
|
||||
conf.Server.LyricsPriority = ".ttml,embedded"
|
||||
embeddedJSON, err := json.Marshal(embeddedLyrics)
|
||||
Expect(err).To(BeNil())
|
||||
|
||||
svc := lyrics.NewLyrics(nil)
|
||||
batchSvc, ok := svc.(lyrics.BatchLyrics)
|
||||
Expect(ok).To(BeTrue())
|
||||
|
||||
list, err := batchSvc.GetLyricsForMediaFiles(ctx, []model.MediaFile{
|
||||
{
|
||||
Lyrics: string(embeddedJSON),
|
||||
Path: "tests/fixtures/01 Invisible (RED) Edit Version.mp3",
|
||||
},
|
||||
{
|
||||
Lyrics: "[]",
|
||||
Path: "tests/fixtures/test.mp3",
|
||||
},
|
||||
})
|
||||
Expect(err).To(BeNil())
|
||||
Expect(list).To(Equal(ttmlLyrics))
|
||||
})
|
||||
|
||||
It("preserves configured sidecar suffix casing on case-sensitive filesystems", func() {
|
||||
dir, err := os.MkdirTemp("", "lyrics-case-*")
|
||||
Expect(err).ToNot(HaveOccurred())
|
||||
DeferCleanup(func() {
|
||||
Expect(os.RemoveAll(dir)).To(Succeed())
|
||||
})
|
||||
|
||||
probe := filepath.Join(dir, "CASECHECK")
|
||||
Expect(os.WriteFile(probe, []byte("probe"), 0644)).To(Succeed())
|
||||
_, err = os.Stat(filepath.Join(dir, "casecheck"))
|
||||
if err == nil {
|
||||
Skip("filesystem is case-insensitive")
|
||||
}
|
||||
Expect(os.IsNotExist(err)).To(BeTrue())
|
||||
|
||||
conf.Server.LyricsPriority = ".LRC"
|
||||
Expect(os.WriteFile(filepath.Join(dir, "song.LRC"), []byte("[00:01.00]Upper suffix"), 0644)).To(Succeed())
|
||||
|
||||
svc := lyrics.NewLyrics(nil)
|
||||
list, err := svc.GetLyrics(ctx, &model.MediaFile{
|
||||
LibraryPath: dir,
|
||||
Path: "song.mp3",
|
||||
})
|
||||
|
||||
Expect(err).To(BeNil())
|
||||
Expect(list).To(HaveLen(1))
|
||||
Expect(list[0].Line).To(Equal([]model.Line{
|
||||
{Start: ptr(int64(1000)), Value: "Upper suffix"},
|
||||
}))
|
||||
})
|
||||
|
||||
Context("Errors", func() {
|
||||
var RegularUserContext = XContext
|
||||
|
||||
@ -5,6 +5,7 @@ import (
|
||||
"errors"
|
||||
"os"
|
||||
"path"
|
||||
"strings"
|
||||
|
||||
"github.com/navidrome/navidrome/log"
|
||||
"github.com/navidrome/navidrome/model"
|
||||
@ -36,18 +37,38 @@ func fromExternalFile(ctx context.Context, mf *model.MediaFile, suffix string) (
|
||||
return nil, err
|
||||
}
|
||||
|
||||
lyrics, err := model.ToLyrics("xxx", string(contents))
|
||||
if err != nil {
|
||||
log.Error(ctx, "error parsing lyric external file", "path", externalLyric, err)
|
||||
return nil, err
|
||||
} else if lyrics == nil {
|
||||
var list model.LyricList
|
||||
switch {
|
||||
case strings.EqualFold(suffix, ".ttml"):
|
||||
list, err = parseTTML(contents)
|
||||
if err != nil {
|
||||
log.Error(ctx, "error parsing ttml external file", "path", externalLyric, err)
|
||||
return nil, err
|
||||
}
|
||||
case strings.EqualFold(suffix, ".srt"):
|
||||
list, err = parseSRT(contents)
|
||||
if err != nil {
|
||||
log.Error(ctx, "error parsing srt external file", "path", externalLyric, err)
|
||||
return nil, err
|
||||
}
|
||||
default:
|
||||
lyrics, err := model.ToLyrics("xxx", string(contents))
|
||||
if err != nil {
|
||||
log.Error(ctx, "error parsing lyric external file", "path", externalLyric, err)
|
||||
return nil, err
|
||||
}
|
||||
if lyrics != nil {
|
||||
list = model.LyricList{*lyrics}
|
||||
}
|
||||
}
|
||||
|
||||
if len(list) == 0 {
|
||||
log.Trace(ctx, "empty lyrics from external file", "path", externalLyric)
|
||||
return nil, nil
|
||||
}
|
||||
|
||||
log.Trace(ctx, "retrieved lyrics from external file", "path", externalLyric)
|
||||
|
||||
return model.LyricList{*lyrics}, nil
|
||||
return list, nil
|
||||
}
|
||||
|
||||
// fromPlugin attempts to load lyrics from a plugin with the given name.
|
||||
|
||||
@ -87,6 +87,89 @@ var _ = Describe("sources", func() {
|
||||
}))
|
||||
})
|
||||
|
||||
It("should return Enhanced LRC lyrics with word-level cues from a file", func() {
|
||||
mf := model.MediaFile{Path: "tests/fixtures/test-enhanced.mp3"}
|
||||
lyrics, err := fromExternalFile(ctx, &mf, ".lrc")
|
||||
|
||||
Expect(err).To(BeNil())
|
||||
Expect(lyrics).To(HaveLen(1))
|
||||
Expect(lyrics[0].DisplayArtist).To(Equal("Test Artist"))
|
||||
Expect(lyrics[0].DisplayTitle).To(Equal("Enhanced Test"))
|
||||
Expect(lyrics[0].Lang).To(Equal("eng"))
|
||||
Expect(lyrics[0].Synced).To(BeTrue())
|
||||
Expect(lyrics[0].Line).To(HaveLen(3))
|
||||
|
||||
// Line 1: has inline markers → Cue array populated
|
||||
Expect(lyrics[0].Line[0].Start).To(Equal(ptr(int64(1000))))
|
||||
Expect(lyrics[0].Line[0].End).To(Equal(ptr(int64(3000))))
|
||||
Expect(lyrics[0].Line[0].Value).To(Equal("Some lyrics here"))
|
||||
Expect(lyrics[0].Line[0].Cue).To(HaveLen(3))
|
||||
Expect(*lyrics[0].Line[0].Cue[0].Start).To(Equal(int64(1000)))
|
||||
Expect(lyrics[0].Line[0].Cue[0].Value).To(Equal("Some "))
|
||||
Expect(lyrics[0].Line[0].Cue[0].End).To(Equal(ptr(int64(1500))))
|
||||
Expect(lyrics[0].Line[0].Cue[0].ByteStart).To(Equal(0))
|
||||
Expect(lyrics[0].Line[0].Cue[0].ByteEnd).To(Equal(4))
|
||||
Expect(*lyrics[0].Line[0].Cue[1].Start).To(Equal(int64(1500)))
|
||||
Expect(lyrics[0].Line[0].Cue[1].Value).To(Equal("lyrics "))
|
||||
Expect(lyrics[0].Line[0].Cue[1].End).To(Equal(ptr(int64(2000))))
|
||||
Expect(lyrics[0].Line[0].Cue[1].ByteStart).To(Equal(5))
|
||||
Expect(lyrics[0].Line[0].Cue[1].ByteEnd).To(Equal(11))
|
||||
Expect(*lyrics[0].Line[0].Cue[2].Start).To(Equal(int64(2000)))
|
||||
Expect(lyrics[0].Line[0].Cue[2].Value).To(Equal("here"))
|
||||
Expect(lyrics[0].Line[0].Cue[2].End).To(Equal(ptr(int64(3000))))
|
||||
Expect(lyrics[0].Line[0].Cue[2].ByteStart).To(Equal(12))
|
||||
Expect(lyrics[0].Line[0].Cue[2].ByteEnd).To(Equal(15))
|
||||
|
||||
// Line 2: has inline markers
|
||||
Expect(lyrics[0].Line[1].Start).To(Equal(ptr(int64(3000))))
|
||||
Expect(lyrics[0].Line[1].End).To(Equal(ptr(int64(5000))))
|
||||
Expect(lyrics[0].Line[1].Value).To(Equal("More words"))
|
||||
Expect(lyrics[0].Line[1].Cue).To(HaveLen(2))
|
||||
Expect(lyrics[0].Line[1].Cue[0].End).To(Equal(ptr(int64(3500))))
|
||||
Expect(lyrics[0].Line[1].Cue[1].End).To(Equal(ptr(int64(5000))))
|
||||
Expect(lyrics[0].Line[1].Cue[0].ByteStart).To(Equal(0))
|
||||
Expect(lyrics[0].Line[1].Cue[0].ByteEnd).To(Equal(4))
|
||||
Expect(lyrics[0].Line[1].Cue[1].ByteStart).To(Equal(5))
|
||||
Expect(lyrics[0].Line[1].Cue[1].ByteEnd).To(Equal(9))
|
||||
|
||||
// Line 3: plain line, no cues
|
||||
Expect(lyrics[0].Line[2].Start).To(Equal(ptr(int64(5000))))
|
||||
Expect(lyrics[0].Line[2].Value).To(Equal("Plain line without inline markers"))
|
||||
Expect(lyrics[0].Line[2].Cue).To(BeNil())
|
||||
})
|
||||
|
||||
It("should return Enhanced LRC lyrics from an ELRC file", func() {
|
||||
mf := model.MediaFile{Path: "tests/fixtures/test.mp3"}
|
||||
lyrics, err := fromExternalFile(ctx, &mf, ".elrc")
|
||||
|
||||
Expect(err).To(BeNil())
|
||||
Expect(lyrics).To(HaveLen(1))
|
||||
Expect(lyrics[0].DisplayArtist).To(Equal("ELRC Artist"))
|
||||
Expect(lyrics[0].DisplayTitle).To(Equal("ELRC Song"))
|
||||
Expect(lyrics[0].Lang).To(Equal("eng"))
|
||||
Expect(lyrics[0].Synced).To(BeTrue())
|
||||
Expect(lyrics[0].Line).To(HaveLen(2))
|
||||
|
||||
Expect(lyrics[0].Line[0].Start).To(Equal(ptr(int64(1000))))
|
||||
Expect(lyrics[0].Line[0].End).To(Equal(ptr(int64(3000))))
|
||||
Expect(lyrics[0].Line[0].Value).To(Equal("Lead words"))
|
||||
Expect(lyrics[0].Line[0].Cue).To(HaveLen(2))
|
||||
Expect(*lyrics[0].Line[0].Cue[0].Start).To(Equal(int64(1000)))
|
||||
Expect(lyrics[0].Line[0].Cue[0].Value).To(Equal("Lead "))
|
||||
Expect(lyrics[0].Line[0].Cue[0].End).To(Equal(ptr(int64(1500))))
|
||||
Expect(lyrics[0].Line[0].Cue[0].ByteStart).To(Equal(0))
|
||||
Expect(lyrics[0].Line[0].Cue[0].ByteEnd).To(Equal(4))
|
||||
Expect(*lyrics[0].Line[0].Cue[1].Start).To(Equal(int64(1500)))
|
||||
Expect(lyrics[0].Line[0].Cue[1].Value).To(Equal("words"))
|
||||
Expect(lyrics[0].Line[0].Cue[1].End).To(Equal(ptr(int64(3000))))
|
||||
Expect(lyrics[0].Line[0].Cue[1].ByteStart).To(Equal(5))
|
||||
Expect(lyrics[0].Line[0].Cue[1].ByteEnd).To(Equal(9))
|
||||
|
||||
Expect(lyrics[0].Line[1].Start).To(Equal(ptr(int64(3000))))
|
||||
Expect(lyrics[0].Line[1].Value).To(Equal("Fallback line"))
|
||||
Expect(lyrics[0].Line[1].Cue).To(BeNil())
|
||||
})
|
||||
|
||||
It("should return unsynchronized lyrics from a file", func() {
|
||||
mf := model.MediaFile{Path: "tests/fixtures/test.mp3"}
|
||||
lyrics, err := fromExternalFile(ctx, &mf, ".txt")
|
||||
@ -108,6 +191,66 @@ var _ = Describe("sources", func() {
|
||||
}))
|
||||
})
|
||||
|
||||
It("should return synchronized lyrics from an SRT file", func() {
|
||||
mf := model.MediaFile{Path: "tests/fixtures/test.mp3"}
|
||||
lyrics, err := fromExternalFile(ctx, &mf, ".srt")
|
||||
|
||||
Expect(err).To(BeNil())
|
||||
Expect(lyrics).To(Equal(model.LyricList{
|
||||
model.Lyrics{
|
||||
Lang: "xxx",
|
||||
Line: []model.Line{
|
||||
{
|
||||
Start: ptr(int64(18800)),
|
||||
End: ptr(int64(22800)),
|
||||
Value: "We're from subtitles",
|
||||
},
|
||||
{
|
||||
Start: ptr(int64(22801)),
|
||||
End: ptr(int64(26000)),
|
||||
Value: "Another subtitle line",
|
||||
},
|
||||
},
|
||||
Synced: true,
|
||||
},
|
||||
}))
|
||||
})
|
||||
|
||||
It("should return synchronized multilingual lyrics from a TTML file", func() {
|
||||
mf := model.MediaFile{Path: "tests/fixtures/test.mp3"}
|
||||
lyrics, err := fromExternalFile(ctx, &mf, ".ttml")
|
||||
|
||||
Expect(err).To(BeNil())
|
||||
Expect(lyrics).To(Equal(model.LyricList{
|
||||
{
|
||||
Kind: "main",
|
||||
Lang: "eng",
|
||||
Line: []model.Line{
|
||||
{
|
||||
Start: ptr(int64(18800)),
|
||||
Value: "We're no strangers to love",
|
||||
},
|
||||
{
|
||||
Start: ptr(int64(22800)),
|
||||
Value: "You know the rules and so do I",
|
||||
},
|
||||
},
|
||||
Synced: true,
|
||||
},
|
||||
{
|
||||
Kind: "main",
|
||||
Lang: "por",
|
||||
Line: []model.Line{
|
||||
{
|
||||
Start: ptr(int64(18800)),
|
||||
Value: "Nao somos estranhos ao amor",
|
||||
},
|
||||
},
|
||||
Synced: true,
|
||||
},
|
||||
}))
|
||||
})
|
||||
|
||||
It("should handle LRC files with UTF-8 BOM marker (issue #4631)", func() {
|
||||
// The function looks for <basePath-without-ext><suffix>, so we need to pass
|
||||
// a MediaFile with .mp3 path and look for .lrc suffix
|
||||
@ -141,5 +284,33 @@ var _ = Describe("sources", func() {
|
||||
Expect(lyrics[0].Line[1].Start).To(Equal(new(int64(22801))))
|
||||
Expect(lyrics[0].Line[1].Value).To(Equal("You know the rules and so do I"))
|
||||
})
|
||||
|
||||
It("should handle TTML files with UTF-8 BOM marker", func() {
|
||||
mf := model.MediaFile{Path: "tests/fixtures/bom-test.mp3"}
|
||||
lyrics, err := fromExternalFile(ctx, &mf, ".ttml")
|
||||
|
||||
Expect(err).To(BeNil())
|
||||
Expect(lyrics).To(HaveLen(1))
|
||||
Expect(lyrics[0].Kind).To(Equal("main"))
|
||||
Expect(lyrics[0].Synced).To(BeTrue())
|
||||
Expect(lyrics[0].Line).To(HaveLen(1))
|
||||
Expect(lyrics[0].Line[0].Start).To(Equal(ptr(int64(0))))
|
||||
Expect(lyrics[0].Line[0].Value).To(Equal("BOM test line"))
|
||||
})
|
||||
|
||||
It("should handle UTF-16 BE encoded TTML files", func() {
|
||||
mf := model.MediaFile{Path: "tests/fixtures/bom-utf16-test.mp3"}
|
||||
lyrics, err := fromExternalFile(ctx, &mf, ".ttml")
|
||||
|
||||
Expect(err).To(BeNil())
|
||||
Expect(lyrics).To(HaveLen(1))
|
||||
Expect(lyrics[0].Kind).To(Equal("main"))
|
||||
Expect(lyrics[0].Synced).To(BeTrue())
|
||||
Expect(lyrics[0].Line).To(HaveLen(2))
|
||||
Expect(lyrics[0].Line[0].Start).To(Equal(ptr(int64(18800))))
|
||||
Expect(lyrics[0].Line[0].Value).To(Equal("UTF16 line one"))
|
||||
Expect(lyrics[0].Line[1].Start).To(Equal(ptr(int64(22801))))
|
||||
Expect(lyrics[0].Line[1].Value).To(Equal("UTF16 line two"))
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
168
core/lyrics/srt.go
Normal file
168
core/lyrics/srt.go
Normal file
@ -0,0 +1,168 @@
|
||||
package lyrics
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"regexp"
|
||||
"strconv"
|
||||
"strings"
|
||||
|
||||
"github.com/navidrome/navidrome/model"
|
||||
"github.com/navidrome/navidrome/utils/str"
|
||||
)
|
||||
|
||||
var (
|
||||
srtTimeRegex = regexp.MustCompile(`^\s*(\d{1,2}):(\d{2}):(\d{2})[,.](\d{1,3})\s*$`)
|
||||
srtBlockSeparatorRegex = regexp.MustCompile(`\n\s*\n`)
|
||||
)
|
||||
|
||||
func parseSRT(contents []byte) (model.LyricList, error) {
|
||||
return parseSRTWithLanguage(contents, "xxx")
|
||||
}
|
||||
|
||||
func parseSRTWithLanguage(contents []byte, language string) (model.LyricList, error) {
|
||||
raw := strings.ReplaceAll(string(contents), "\r\n", "\n")
|
||||
raw = strings.ReplaceAll(raw, "\r", "\n")
|
||||
|
||||
blocks := splitSRTBlocks(raw)
|
||||
lines := make([]model.Line, 0, len(blocks))
|
||||
|
||||
for _, block := range blocks {
|
||||
line, ok, err := parseSRTBlock(block)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
if ok {
|
||||
lines = append(lines, line)
|
||||
}
|
||||
}
|
||||
|
||||
if len(lines) == 0 {
|
||||
return nil, nil
|
||||
}
|
||||
|
||||
lyrics := model.NormalizeLyrics(model.Lyrics{
|
||||
Lang: normalizeEmbeddedLanguage(language),
|
||||
Line: lines,
|
||||
Synced: true,
|
||||
})
|
||||
return model.LyricList{lyrics}, nil
|
||||
}
|
||||
|
||||
func splitSRTBlocks(raw string) []string {
|
||||
raw = strings.TrimSpace(raw)
|
||||
if raw == "" {
|
||||
return nil
|
||||
}
|
||||
|
||||
parts := srtBlockSeparatorRegex.Split(raw, -1)
|
||||
blocks := make([]string, 0, len(parts))
|
||||
for _, part := range parts {
|
||||
part = strings.TrimSpace(part)
|
||||
if part != "" {
|
||||
blocks = append(blocks, part)
|
||||
}
|
||||
}
|
||||
return blocks
|
||||
}
|
||||
|
||||
func parseSRTBlock(block string) (model.Line, bool, error) {
|
||||
scanner := bytes.Split([]byte(block), []byte("\n"))
|
||||
if len(scanner) == 0 {
|
||||
return model.Line{}, false, nil
|
||||
}
|
||||
|
||||
lines := make([]string, 0, len(scanner))
|
||||
for _, line := range scanner {
|
||||
lines = append(lines, strings.TrimSpace(string(line)))
|
||||
}
|
||||
|
||||
if len(lines) == 0 {
|
||||
return model.Line{}, false, nil
|
||||
}
|
||||
|
||||
startIdx := 0
|
||||
if digitsOnly(lines[0]) {
|
||||
startIdx = 1
|
||||
}
|
||||
if startIdx >= len(lines) {
|
||||
return model.Line{}, false, nil
|
||||
}
|
||||
|
||||
timing := strings.Split(lines[startIdx], "-->")
|
||||
if len(timing) != 2 {
|
||||
return model.Line{}, false, nil
|
||||
}
|
||||
|
||||
startMs, err := parseSRTTime(timing[0])
|
||||
if err != nil {
|
||||
return model.Line{}, false, err
|
||||
}
|
||||
endMs, err := parseSRTTime(timing[1])
|
||||
if err != nil {
|
||||
return model.Line{}, false, err
|
||||
}
|
||||
|
||||
textLines := make([]string, 0, len(lines)-startIdx-1)
|
||||
for _, line := range lines[startIdx+1:] {
|
||||
if line == "" {
|
||||
continue
|
||||
}
|
||||
textLines = append(textLines, line)
|
||||
}
|
||||
|
||||
value := str.SanitizeText(strings.Join(textLines, "\n"))
|
||||
if value == "" {
|
||||
return model.Line{}, false, nil
|
||||
}
|
||||
|
||||
return model.Line{
|
||||
Start: &startMs,
|
||||
End: &endMs,
|
||||
Value: value,
|
||||
}, true, nil
|
||||
}
|
||||
|
||||
func parseSRTTime(value string) (int64, error) {
|
||||
match := srtTimeRegex.FindStringSubmatch(strings.TrimSpace(value))
|
||||
if match == nil {
|
||||
return 0, strconv.ErrSyntax
|
||||
}
|
||||
|
||||
hours, err := strconv.ParseInt(match[1], 10, 64)
|
||||
if err != nil {
|
||||
return 0, err
|
||||
}
|
||||
minutes, err := strconv.ParseInt(match[2], 10, 64)
|
||||
if err != nil {
|
||||
return 0, err
|
||||
}
|
||||
seconds, err := strconv.ParseInt(match[3], 10, 64)
|
||||
if err != nil {
|
||||
return 0, err
|
||||
}
|
||||
millis, err := strconv.ParseInt(match[4], 10, 64)
|
||||
if err != nil {
|
||||
return 0, err
|
||||
}
|
||||
|
||||
switch len(match[4]) {
|
||||
case 1:
|
||||
millis *= 100
|
||||
case 2:
|
||||
millis *= 10
|
||||
}
|
||||
|
||||
return (((hours*60)+minutes)*60+seconds)*1000 + millis, nil
|
||||
}
|
||||
|
||||
func digitsOnly(value string) bool {
|
||||
if value == "" {
|
||||
return false
|
||||
}
|
||||
for _, ch := range value {
|
||||
if ch < '0' || ch > '9' {
|
||||
return false
|
||||
}
|
||||
}
|
||||
return true
|
||||
}
|
||||
5
core/lyrics/test_helpers_test.go
Normal file
5
core/lyrics/test_helpers_test.go
Normal file
@ -0,0 +1,5 @@
|
||||
package lyrics
|
||||
|
||||
func ptr[T any](v T) *T {
|
||||
return &v
|
||||
}
|
||||
1278
core/lyrics/ttml.go
Normal file
1278
core/lyrics/ttml.go
Normal file
File diff suppressed because it is too large
Load Diff
430
core/lyrics/ttml_test.go
Normal file
430
core/lyrics/ttml_test.go
Normal file
@ -0,0 +1,430 @@
|
||||
package lyrics
|
||||
|
||||
import (
|
||||
"github.com/navidrome/navidrome/model"
|
||||
. "github.com/onsi/ginkgo/v2"
|
||||
. "github.com/onsi/gomega"
|
||||
)
|
||||
|
||||
var _ = Describe("parseTTML", func() {
|
||||
Describe("Multi-language and timing", func() {
|
||||
It("should parse multiple language divs with inherited offsets and frame/tick timing", func() {
|
||||
content := []byte(`<?xml version="1.0" encoding="UTF-8"?>
|
||||
<tt xmlns="http://www.w3.org/ns/ttml" xmlns:ttp="http://www.w3.org/ns/ttml#parameter" ttp:frameRate="30" ttp:subFrameRate="2" ttp:tickRate="10">
|
||||
<body>
|
||||
<div xml:lang="eng" begin="1s">
|
||||
<p begin="2s">Line one</p>
|
||||
<p begin="00:00:04:15.1"><span>Line two</span><br/>with break</p>
|
||||
</div>
|
||||
<div xml:lang="por">
|
||||
<p begin="45t">Linha</p>
|
||||
</div>
|
||||
</body>
|
||||
</tt>`)
|
||||
|
||||
list, err := parseTTML(content)
|
||||
Expect(err).ToNot(HaveOccurred())
|
||||
Expect(list).To(HaveLen(2))
|
||||
|
||||
By("parsing the English track")
|
||||
eng := list[0]
|
||||
Expect(eng.Lang).To(Equal("eng"))
|
||||
Expect(eng.Synced).To(BeTrue())
|
||||
Expect(eng.Line[0].Start).To(Equal(ptr(int64(3000))))
|
||||
Expect(eng.Line[0].Value).To(Equal("Line one"))
|
||||
Expect(eng.Line[1].Start).To(Equal(ptr(int64(4517))))
|
||||
Expect(eng.Line[1].Value).To(Equal("Line two\nwith break"))
|
||||
|
||||
By("parsing the Portuguese track")
|
||||
por := list[1]
|
||||
Expect(por.Lang).To(Equal("por"))
|
||||
Expect(por.Line[0].Start).To(Equal(ptr(int64(4500))))
|
||||
Expect(por.Line[0].Value).To(Equal("Linha"))
|
||||
})
|
||||
})
|
||||
|
||||
Describe("Unsupported cue handling", func() {
|
||||
It("should skip wallclock cues and keep valid ones", func() {
|
||||
content := []byte(`<?xml version="1.0" encoding="UTF-8"?>
|
||||
<tt xmlns="http://www.w3.org/ns/ttml">
|
||||
<body xml:lang="eng">
|
||||
<div>
|
||||
<p begin="wallclock(2026-01-01T00:00:00Z)">Skip me</p>
|
||||
<p begin="1s">Keep me</p>
|
||||
</div>
|
||||
</body>
|
||||
</tt>`)
|
||||
|
||||
list, err := parseTTML(content)
|
||||
Expect(err).ToNot(HaveOccurred())
|
||||
Expect(list).To(HaveLen(1))
|
||||
Expect(list[0].Line).To(HaveLen(1))
|
||||
Expect(list[0].Line[0].Start).To(Equal(ptr(int64(1000))))
|
||||
Expect(list[0].Line[0].Value).To(Equal("Keep me"))
|
||||
})
|
||||
})
|
||||
|
||||
Describe("Begin/End/Dur with inheritance", func() {
|
||||
It("should correctly accumulate nested timing from body, div, and p elements", func() {
|
||||
content := []byte(`<?xml version="1.0" encoding="UTF-8"?>
|
||||
<tt xmlns="http://www.w3.org/ns/ttml">
|
||||
<body xml:lang="eng" begin="10s">
|
||||
<div begin="5s" dur="8s">
|
||||
<p begin="1s" dur="2s">First line</p>
|
||||
<p begin="3s" end="5s">Second line</p>
|
||||
</div>
|
||||
</body>
|
||||
</tt>`)
|
||||
|
||||
list, err := parseTTML(content)
|
||||
Expect(err).ToNot(HaveOccurred())
|
||||
Expect(list).To(HaveLen(1))
|
||||
Expect(list[0].Lang).To(Equal("eng"))
|
||||
Expect(list[0].Line).To(HaveLen(2))
|
||||
Expect(list[0].Line[0].Start).To(Equal(ptr(int64(16000))))
|
||||
Expect(list[0].Line[0].Value).To(Equal("First line"))
|
||||
Expect(list[0].Line[1].Start).To(Equal(ptr(int64(18000))))
|
||||
Expect(list[0].Line[1].Value).To(Equal("Second line"))
|
||||
})
|
||||
})
|
||||
|
||||
Describe("Non-standard bare second offsets", func() {
|
||||
It("should parse bare decimal numbers as seconds", func() {
|
||||
content := []byte(`<?xml version="1.0" encoding="UTF-8"?>
|
||||
<tt xmlns="http://www.w3.org/ns/ttml">
|
||||
<body xml:lang="eng" begin="10">
|
||||
<div>
|
||||
<p begin="0.170">First line</p>
|
||||
<p begin="3.710">Second line</p>
|
||||
</div>
|
||||
</body>
|
||||
</tt>`)
|
||||
|
||||
list, err := parseTTML(content)
|
||||
Expect(err).ToNot(HaveOccurred())
|
||||
Expect(list).To(HaveLen(1))
|
||||
Expect(list[0].Line).To(HaveLen(2))
|
||||
Expect(list[0].Line[0].Start).To(Equal(ptr(int64(10170))))
|
||||
Expect(list[0].Line[0].Value).To(Equal("First line"))
|
||||
Expect(list[0].Line[1].Start).To(Equal(ptr(int64(13710))))
|
||||
Expect(list[0].Line[1].Value).To(Equal("Second line"))
|
||||
})
|
||||
})
|
||||
|
||||
Describe("Word timing tokens", func() {
|
||||
It("should extract timed tokens from spans including background role", func() {
|
||||
content := []byte(`<?xml version="1.0" encoding="UTF-8"?>
|
||||
<tt xmlns="http://www.w3.org/ns/ttml" xmlns:ttm="http://www.w3.org/ns/ttml#metadata">
|
||||
<body xml:lang="eng">
|
||||
<div>
|
||||
<p begin="00:01.000" end="00:03.000">
|
||||
<span begin="00:01.000" end="00:01.400">He</span><span begin="00:01.400" end="00:01.800">llo</span>
|
||||
<span ttm:role="x-bg"><span begin="00:02.000" end="00:02.500">echo</span></span>
|
||||
</p>
|
||||
</div>
|
||||
</body>
|
||||
</tt>`)
|
||||
|
||||
list, err := parseTTML(content)
|
||||
Expect(err).ToNot(HaveOccurred())
|
||||
Expect(list).To(HaveLen(1))
|
||||
Expect(list[0].Agents).To(Equal([]model.Agent{
|
||||
{ID: "main", Role: "main"},
|
||||
{ID: "__nd_bg__|main", Role: "bg"},
|
||||
}))
|
||||
Expect(list[0].Line).To(HaveLen(1))
|
||||
|
||||
line := list[0].Line[0]
|
||||
Expect(line.Start).To(Equal(ptr(int64(1000))))
|
||||
Expect(line.Value).To(Equal("Hello\necho"))
|
||||
Expect(line.End).To(Equal(ptr(int64(3000))))
|
||||
Expect(line.Cue).To(HaveLen(3))
|
||||
|
||||
Expect(line.Cue[0]).To(Equal(model.Cue{Start: ptr(int64(1000)), End: ptr(int64(1400)), Value: "He", ByteStart: 0, ByteEnd: 1, AgentID: "main"}))
|
||||
Expect(line.Cue[1]).To(Equal(model.Cue{Start: ptr(int64(1400)), End: ptr(int64(1800)), Value: "llo", ByteStart: 2, ByteEnd: 4, AgentID: "main"}))
|
||||
Expect(line.Cue[2]).To(Equal(model.Cue{Start: ptr(int64(2000)), End: ptr(int64(2500)), Value: "echo", ByteStart: 6, ByteEnd: 9, AgentID: "__nd_bg__|main"}))
|
||||
})
|
||||
|
||||
It("should append role tokens exactly instead of using substring matches", func() {
|
||||
content := []byte(`<?xml version="1.0" encoding="UTF-8"?>
|
||||
<tt xmlns="http://www.w3.org/ns/ttml" xmlns:ttm="http://www.w3.org/ns/ttml#metadata">
|
||||
<body xml:lang="eng">
|
||||
<div>
|
||||
<p begin="00:01.000" end="00:03.000" ttm:role="not-x-bg"><span begin="00:01.000" end="00:01.400">Lead</span><span ttm:role="x-bg"><span begin="00:02.000" end="00:02.500">Echo</span></span></p>
|
||||
</div>
|
||||
</body>
|
||||
</tt>`)
|
||||
|
||||
list, err := parseTTML(content)
|
||||
|
||||
Expect(err).ToNot(HaveOccurred())
|
||||
Expect(list).To(HaveLen(1))
|
||||
Expect(list[0].Agents).To(Equal([]model.Agent{
|
||||
{ID: "main", Role: "main"},
|
||||
{ID: "__nd_bg__|main", Role: "bg"},
|
||||
}))
|
||||
Expect(list[0].Line).To(HaveLen(1))
|
||||
Expect(list[0].Line[0].Cue).To(HaveLen(2))
|
||||
Expect(list[0].Line[0].Cue[0].AgentID).To(Equal("main"))
|
||||
Expect(list[0].Line[0].Cue[1].AgentID).To(Equal("__nd_bg__|main"))
|
||||
})
|
||||
|
||||
It("should parse named TTML agents into main, voice, and group roles", func() {
|
||||
content := []byte(`<?xml version="1.0" encoding="UTF-8"?>
|
||||
<tt xmlns="http://www.w3.org/ns/ttml" xmlns:ttm="http://www.w3.org/ns/ttml#metadata">
|
||||
<head>
|
||||
<metadata>
|
||||
<ttm:agent xml:id="v1" type="person"><ttm:name>Chris Martin</ttm:name></ttm:agent>
|
||||
<ttm:agent xml:id="v2" type="person"><ttm:name>Jin</ttm:name></ttm:agent>
|
||||
<ttm:agent xml:id="v1000" type="group"><ttm:name>All</ttm:name></ttm:agent>
|
||||
</metadata>
|
||||
</head>
|
||||
<body xml:lang="eng">
|
||||
<div>
|
||||
<p begin="1s" end="2s" ttm:agent="v1"><span begin="1s" end="1.5s">You</span></p>
|
||||
<p begin="2s" end="3s" ttm:agent="v2"><span begin="2s" end="2.5s">and</span></p>
|
||||
<p begin="3s" end="4s" ttm:agent="v1000"><span begin="3s" end="3.5s">All</span></p>
|
||||
</div>
|
||||
</body>
|
||||
</tt>`)
|
||||
|
||||
list, err := parseTTML(content)
|
||||
Expect(err).ToNot(HaveOccurred())
|
||||
Expect(list).To(HaveLen(1))
|
||||
Expect(list[0].Agents).To(Equal([]model.Agent{
|
||||
{ID: "v1", Role: "main", Name: "Chris Martin"},
|
||||
{ID: "v2", Role: "voice", Name: "Jin"},
|
||||
{ID: "v1000", Role: "group", Name: "All"},
|
||||
}))
|
||||
Expect(list[0].Line[0].Cue[0].AgentID).To(Equal("v1"))
|
||||
Expect(list[0].Line[1].Cue[0].AgentID).To(Equal("v2"))
|
||||
Expect(list[0].Line[2].Cue[0].AgentID).To(Equal("v1000"))
|
||||
})
|
||||
|
||||
It("should avoid collisions between derived background agents and explicit TTML agent ids", func() {
|
||||
content := []byte(`<?xml version="1.0" encoding="UTF-8"?>
|
||||
<tt xmlns="http://www.w3.org/ns/ttml" xmlns:ttm="http://www.w3.org/ns/ttml#metadata">
|
||||
<head>
|
||||
<metadata>
|
||||
<ttm:agent xml:id="lead" type="person"><ttm:name>Lead</ttm:name></ttm:agent>
|
||||
<ttm:agent xml:id="lead__bg" type="person"><ttm:name>Existing Background Id</ttm:name></ttm:agent>
|
||||
</metadata>
|
||||
</head>
|
||||
<body xml:lang="eng">
|
||||
<div>
|
||||
<p begin="1s" end="2s" ttm:agent="lead">
|
||||
<span begin="1s" end="1.4s">Lead</span>
|
||||
<span ttm:role="x-bg"><span begin="1.5s" end="1.8s">Echo</span></span>
|
||||
</p>
|
||||
<p begin="2s" end="3s" ttm:agent="lead__bg">
|
||||
<span begin="2s" end="2.5s">Named</span>
|
||||
</p>
|
||||
</div>
|
||||
</body>
|
||||
</tt>`)
|
||||
|
||||
list, err := parseTTML(content)
|
||||
Expect(err).ToNot(HaveOccurred())
|
||||
Expect(list).To(HaveLen(1))
|
||||
Expect(list[0].Agents).To(Equal([]model.Agent{
|
||||
{ID: "lead", Role: "main", Name: "Lead"},
|
||||
{ID: "__nd_bg__|lead", Role: "bg", Name: "Lead"},
|
||||
{ID: "lead__bg", Role: "voice", Name: "Existing Background Id"},
|
||||
}))
|
||||
Expect(list[0].Line).To(HaveLen(2))
|
||||
Expect(list[0].Line[0].Cue).To(HaveLen(2))
|
||||
Expect(list[0].Line[0].Cue[0].AgentID).To(Equal("lead"))
|
||||
Expect(list[0].Line[0].Cue[1].AgentID).To(Equal("__nd_bg__|lead"))
|
||||
Expect(list[0].Line[1].Cue).To(HaveLen(1))
|
||||
Expect(list[0].Line[1].Cue[0].AgentID).To(Equal("lead__bg"))
|
||||
})
|
||||
|
||||
It("should fill missing cue agent ids with the resolved main agent", func() {
|
||||
content := []byte(`<?xml version="1.0" encoding="UTF-8"?>
|
||||
<tt xmlns="http://www.w3.org/ns/ttml" xmlns:ttm="http://www.w3.org/ns/ttml#metadata">
|
||||
<head>
|
||||
<metadata>
|
||||
<ttm:agent xml:id="guest" type="person"><ttm:name>Guest Vocal</ttm:name></ttm:agent>
|
||||
</metadata>
|
||||
</head>
|
||||
<body xml:lang="eng">
|
||||
<div>
|
||||
<p begin="1s" end="3s">
|
||||
<span begin="1s" end="1.4s">Lead</span>
|
||||
<span begin="2s" end="2.4s" ttm:agent="guest">Guest</span>
|
||||
</p>
|
||||
</div>
|
||||
</body>
|
||||
</tt>`)
|
||||
|
||||
list, err := parseTTML(content)
|
||||
Expect(err).ToNot(HaveOccurred())
|
||||
Expect(list).To(HaveLen(1))
|
||||
Expect(list[0].Agents).To(Equal([]model.Agent{
|
||||
{ID: "guest", Role: "main", Name: "Guest Vocal"},
|
||||
}))
|
||||
Expect(list[0].Line).To(HaveLen(1))
|
||||
Expect(list[0].Line[0].Cue).To(HaveLen(2))
|
||||
Expect(list[0].Line[0].Cue[0].AgentID).To(Equal("guest"))
|
||||
Expect(list[0].Line[0].Cue[1].AgentID).To(Equal("guest"))
|
||||
})
|
||||
})
|
||||
|
||||
Describe("Ambiguous decimal timing", func() {
|
||||
It("should prefer absolute timing when values fall inside parent window", func() {
|
||||
content := []byte(`<?xml version="1.0" encoding="UTF-8"?>
|
||||
<tt xmlns="http://www.w3.org/ns/ttml">
|
||||
<body xml:lang="eng">
|
||||
<div begin="37.870" end="45.570">
|
||||
<p begin="43.444" end="45.570">
|
||||
<span begin="43.444" end="43.716">go</span>
|
||||
<span begin="43.716" end="43.887">go</span>
|
||||
</p>
|
||||
</div>
|
||||
</body>
|
||||
</tt>`)
|
||||
|
||||
list, err := parseTTML(content)
|
||||
Expect(err).ToNot(HaveOccurred())
|
||||
Expect(list).To(HaveLen(1))
|
||||
Expect(list[0].Line).To(HaveLen(1))
|
||||
|
||||
line := list[0].Line[0]
|
||||
Expect(line.Start).To(Equal(ptr(int64(43444))))
|
||||
Expect(line.Value).To(Equal("go\ngo"))
|
||||
Expect(line.End).To(Equal(ptr(int64(45570))))
|
||||
Expect(line.Cue).To(HaveLen(2))
|
||||
Expect(line.Cue[0]).To(Equal(model.Cue{Start: ptr(int64(43444)), End: ptr(int64(43716)), Value: "go", ByteStart: 0, ByteEnd: 1}))
|
||||
Expect(line.Cue[1]).To(Equal(model.Cue{Start: ptr(int64(43716)), End: ptr(int64(43887)), Value: "go", ByteStart: 3, ByteEnd: 4}))
|
||||
})
|
||||
})
|
||||
|
||||
Describe("Unsynced fallback", func() {
|
||||
It("should return unsynced lyrics when no timing is present", func() {
|
||||
content := []byte(`<?xml version="1.0" encoding="UTF-8"?>
|
||||
<tt xmlns="http://www.w3.org/ns/ttml">
|
||||
<body>
|
||||
<div>
|
||||
<p>No timing here</p>
|
||||
</div>
|
||||
</body>
|
||||
</tt>`)
|
||||
|
||||
list, err := parseTTML(content)
|
||||
Expect(err).ToNot(HaveOccurred())
|
||||
Expect(list).To(HaveLen(1))
|
||||
Expect(list[0].Lang).To(Equal("xxx"))
|
||||
Expect(list[0].Synced).To(BeFalse())
|
||||
Expect(list[0].Line).To(HaveLen(1))
|
||||
Expect(list[0].Line[0].Start).To(BeNil())
|
||||
Expect(list[0].Line[0].Value).To(Equal("No timing here"))
|
||||
})
|
||||
})
|
||||
|
||||
Describe("Metadata tracks", func() {
|
||||
It("should produce main, translation, and pronunciation tracks from iTunesMetadata", func() {
|
||||
content := []byte(`<?xml version="1.0" encoding="UTF-8"?>
|
||||
<tt xmlns="http://www.w3.org/ns/ttml" xmlns:itunes="http://music.apple.com/lyric-ttml-internal">
|
||||
<head>
|
||||
<metadata>
|
||||
<iTunesMetadata xmlns="http://music.apple.com/lyric-ttml-internal">
|
||||
<translations>
|
||||
<translation xml:lang="es">
|
||||
<text for="L1">Hola</text>
|
||||
<text for="MISSING">Skip me</text>
|
||||
</translation>
|
||||
</translations>
|
||||
<transliterations>
|
||||
<transliteration xml:lang="ja-Latn">
|
||||
<text for="L2"><span begin="00:02.000" end="00:02.300" xmlns="http://www.w3.org/ns/ttml">ko</span><span begin="00:02.300" end="00:02.600" xmlns="http://www.w3.org/ns/ttml">nni</span></text>
|
||||
</transliteration>
|
||||
</transliterations>
|
||||
</iTunesMetadata>
|
||||
</metadata>
|
||||
</head>
|
||||
<body xml:lang="ja">
|
||||
<div>
|
||||
<p begin="00:01.000" end="00:01.500" itunes:key="L1">こんにちは</p>
|
||||
<p begin="00:02.000" end="00:02.700" itunes:key="L2">こんばんは</p>
|
||||
</div>
|
||||
</body>
|
||||
</tt>`)
|
||||
|
||||
list, err := parseTTML(content)
|
||||
Expect(err).ToNot(HaveOccurred())
|
||||
Expect(list).To(HaveLen(3))
|
||||
|
||||
By("checking the main track")
|
||||
main := list[0]
|
||||
Expect(main.Kind).To(Equal("main"))
|
||||
Expect(main.Lang).To(Equal("ja"))
|
||||
Expect(main.Line).To(HaveLen(2))
|
||||
|
||||
By("checking the translation track")
|
||||
translation := list[1]
|
||||
Expect(translation.Kind).To(Equal("translation"))
|
||||
Expect(translation.Lang).To(Equal("es"))
|
||||
Expect(translation.Line).To(HaveLen(1))
|
||||
Expect(translation.Line[0].Start).To(Equal(ptr(int64(1000))))
|
||||
Expect(translation.Line[0].Value).To(Equal("Hola"))
|
||||
Expect(translation.Line[0].End).To(Equal(ptr(int64(1500))))
|
||||
|
||||
By("checking the pronunciation track")
|
||||
pronunciation := list[2]
|
||||
Expect(pronunciation.Kind).To(Equal("pronunciation"))
|
||||
Expect(pronunciation.Lang).To(Equal("ja-latn"))
|
||||
Expect(pronunciation.Line).To(HaveLen(1))
|
||||
Expect(pronunciation.Line[0].Start).To(Equal(ptr(int64(2000))))
|
||||
Expect(pronunciation.Line[0].Value).To(Equal("konni"))
|
||||
Expect(pronunciation.Line[0].End).To(Equal(ptr(int64(2600))))
|
||||
Expect(pronunciation.Line[0].Cue).To(HaveLen(2))
|
||||
Expect(pronunciation.Line[0].Cue[0]).To(Equal(model.Cue{Start: ptr(int64(2000)), End: ptr(int64(2300)), Value: "ko", ByteStart: 0, ByteEnd: 1}))
|
||||
Expect(pronunciation.Line[0].Cue[1]).To(Equal(model.Cue{Start: ptr(int64(2300)), End: ptr(int64(2600)), Value: "nni", ByteStart: 2, ByteEnd: 4}))
|
||||
})
|
||||
})
|
||||
|
||||
Describe("Pronunciation with bare decimal end times", func() {
|
||||
It("should correctly parse bare decimal times in transliteration spans", func() {
|
||||
content := []byte(`<?xml version="1.0" encoding="UTF-8"?>
|
||||
<tt xmlns="http://www.w3.org/ns/ttml" xmlns:itunes="http://music.apple.com/lyric-ttml-internal">
|
||||
<head>
|
||||
<metadata>
|
||||
<iTunesMetadata xmlns="http://music.apple.com/lyric-ttml-internal">
|
||||
<transliterations>
|
||||
<transliteration xml:lang="ja-Latn">
|
||||
<text for="L1"><span begin="2.747" end="3.018" xmlns="http://www.w3.org/ns/ttml">I</span> <span begin="3.018" end="3.179" xmlns="http://www.w3.org/ns/ttml">woke</span> <span begin="3.179" end="3.582" xmlns="http://www.w3.org/ns/ttml">up</span></text>
|
||||
</transliteration>
|
||||
</transliterations>
|
||||
</iTunesMetadata>
|
||||
</metadata>
|
||||
</head>
|
||||
<body xml:lang="ja">
|
||||
<div>
|
||||
<p begin="00:02.747" end="00:04.000" itunes:key="L1">起きた</p>
|
||||
</div>
|
||||
</body>
|
||||
</tt>`)
|
||||
|
||||
list, err := parseTTML(content)
|
||||
Expect(err).ToNot(HaveOccurred())
|
||||
|
||||
var pronunciation *model.Lyrics
|
||||
for i := range list {
|
||||
if list[i].Kind == "pronunciation" {
|
||||
pronunciation = &list[i]
|
||||
break
|
||||
}
|
||||
}
|
||||
Expect(pronunciation).ToNot(BeNil())
|
||||
Expect(pronunciation.Line).To(HaveLen(1))
|
||||
|
||||
line := pronunciation.Line[0]
|
||||
Expect(line.Start).To(Equal(ptr(int64(2747))))
|
||||
Expect(line.Value).To(Equal("I woke up"))
|
||||
Expect(line.Cue).To(HaveLen(3))
|
||||
Expect(line.Cue[0]).To(Equal(model.Cue{Start: ptr(int64(2747)), End: ptr(int64(3018)), Value: "I", ByteStart: 0, ByteEnd: 0}))
|
||||
Expect(line.Cue[1]).To(Equal(model.Cue{Start: ptr(int64(3018)), End: ptr(int64(3179)), Value: "woke", ByteStart: 2, ByteEnd: 5}))
|
||||
Expect(line.Cue[2]).To(Equal(model.Cue{Start: ptr(int64(3179)), End: ptr(int64(3582)), Value: "up", ByteStart: 7, ByteEnd: 8}))
|
||||
})
|
||||
})
|
||||
})
|
||||
269
model/lyrics.go
269
model/lyrics.go
@ -6,33 +6,57 @@ import (
|
||||
"slices"
|
||||
"strconv"
|
||||
"strings"
|
||||
"unicode"
|
||||
|
||||
"github.com/navidrome/navidrome/log"
|
||||
"github.com/navidrome/navidrome/utils/str"
|
||||
)
|
||||
|
||||
type Cue struct {
|
||||
Start *int64 `structs:"start,omitempty" json:"start,omitempty"`
|
||||
End *int64 `structs:"end,omitempty" json:"end,omitempty"`
|
||||
Value string `structs:"value" json:"value"`
|
||||
ByteStart int `structs:"byteStart" json:"byteStart"`
|
||||
ByteEnd int `structs:"byteEnd" json:"byteEnd"`
|
||||
AgentID string `structs:"agentId,omitempty" json:"agentId,omitempty"`
|
||||
}
|
||||
|
||||
type Agent struct {
|
||||
ID string `structs:"id" json:"id"`
|
||||
Role string `structs:"role" json:"role"`
|
||||
Name string `structs:"name,omitempty" json:"name,omitempty"`
|
||||
}
|
||||
|
||||
type Line struct {
|
||||
Start *int64 `structs:"start,omitempty" json:"start,omitempty"`
|
||||
End *int64 `structs:"end,omitempty" json:"end,omitempty"`
|
||||
Value string `structs:"value" json:"value"`
|
||||
Cue []Cue `structs:"cue,omitempty" json:"cue,omitempty"`
|
||||
}
|
||||
|
||||
type Lyrics struct {
|
||||
DisplayArtist string `structs:"displayArtist,omitempty" json:"displayArtist,omitempty"`
|
||||
DisplayTitle string `structs:"displayTitle,omitempty" json:"displayTitle,omitempty"`
|
||||
Lang string `structs:"lang" json:"lang"`
|
||||
Line []Line `structs:"line" json:"line"`
|
||||
Offset *int64 `structs:"offset,omitempty" json:"offset,omitempty"`
|
||||
Synced bool `structs:"synced" json:"synced"`
|
||||
DisplayArtist string `structs:"displayArtist,omitempty" json:"displayArtist,omitempty"`
|
||||
DisplayTitle string `structs:"displayTitle,omitempty" json:"displayTitle,omitempty"`
|
||||
Kind string `structs:"kind,omitempty" json:"kind,omitempty"`
|
||||
Lang string `structs:"lang" json:"lang"`
|
||||
Agents []Agent `structs:"agents,omitempty" json:"agents,omitempty"`
|
||||
Line []Line `structs:"line" json:"line"`
|
||||
Offset *int64 `structs:"offset,omitempty" json:"offset,omitempty"`
|
||||
Synced bool `structs:"synced" json:"synced"`
|
||||
}
|
||||
|
||||
// support the standard [mm:ss.mm], as well as [hh:*] and [*.mmm]
|
||||
const timeRegexString = `\[([0-9]{1,2}:)?([0-9]{1,2}):([0-9]{1,2})(.[0-9]{1,3})?\]`
|
||||
const timeRegexString = `\[([0-9]{1,2}:)?([0-9]{1,2}):([0-9]{1,2})(\.[0-9]{1,3})?\]`
|
||||
|
||||
var (
|
||||
// Should either be at the beginning of file, or beginning of line
|
||||
syncRegex = regexp.MustCompile(`(^|\n)\s*` + timeRegexString)
|
||||
timeRegex = regexp.MustCompile(timeRegexString)
|
||||
lrcIdRegex = regexp.MustCompile(`\[(ar|ti|offset|lang):([^]]+)]`)
|
||||
|
||||
// Enhanced LRC: inline word-level timing markers like <00:12.34>
|
||||
enhancedLRCTimeString = `<([0-9]{1,2}:)?([0-9]{1,2}):([0-9]{1,2})(\.[0-9]{1,3})?>`
|
||||
enhancedLRCRegex = regexp.MustCompile(enhancedLRCTimeString)
|
||||
)
|
||||
|
||||
func (l Lyrics) IsEmpty() bool {
|
||||
@ -106,9 +130,11 @@ func ToLyrics(language, text string) (*Lyrics, error) {
|
||||
|
||||
if validLine {
|
||||
for idx := range timestamps {
|
||||
value, cues := parseEnhancedLine(priorLine)
|
||||
structuredLines = append(structuredLines, Line{
|
||||
Start: ×tamps[idx],
|
||||
Value: strings.TrimSpace(priorLine),
|
||||
Value: value,
|
||||
Cue: cues,
|
||||
})
|
||||
}
|
||||
timestamps = nil
|
||||
@ -154,9 +180,11 @@ func ToLyrics(language, text string) (*Lyrics, error) {
|
||||
|
||||
if validLine {
|
||||
for idx := range timestamps {
|
||||
value, cues := parseEnhancedLine(priorLine)
|
||||
structuredLines = append(structuredLines, Line{
|
||||
Start: ×tamps[idx],
|
||||
Value: strings.TrimSpace(priorLine),
|
||||
Value: value,
|
||||
Cue: cues,
|
||||
})
|
||||
}
|
||||
}
|
||||
@ -173,13 +201,118 @@ func ToLyrics(language, text string) (*Lyrics, error) {
|
||||
DisplayArtist: artist,
|
||||
DisplayTitle: title,
|
||||
Lang: language,
|
||||
Line: structuredLines,
|
||||
Line: NormalizeCueLines(structuredLines),
|
||||
Offset: offset,
|
||||
Synced: synced,
|
||||
}
|
||||
return &lyrics, nil
|
||||
}
|
||||
|
||||
// parseEnhancedLine extracts word-level timing cues from Enhanced LRC inline markers
|
||||
// and computes UTF-8 byte offsets against the final stripped line value.
|
||||
func parseEnhancedLine(text string) (string, []Cue) {
|
||||
matches := enhancedLRCRegex.FindAllStringSubmatchIndex(text, -1)
|
||||
if len(matches) == 0 {
|
||||
return strings.TrimSpace(text), nil
|
||||
}
|
||||
|
||||
type segment struct {
|
||||
start int64
|
||||
rawStart int
|
||||
rawEnd int
|
||||
}
|
||||
|
||||
segments := make([]segment, 0, len(matches))
|
||||
var rawValue strings.Builder
|
||||
for i, match := range matches {
|
||||
timeMs, err := parseTime(
|
||||
// Rewrite <...> as [...] so parseTime can handle it with the same logic
|
||||
"["+text[match[0]+1:match[1]-1]+"]",
|
||||
// Adjust match indices to point into our rewritten string (need start/end pairs for each group)
|
||||
[]int{
|
||||
0, match[1] - match[0],
|
||||
adjustGroup(match, 2), adjustGroup(match, 3),
|
||||
adjustGroup(match, 4), adjustGroup(match, 5),
|
||||
adjustGroup(match, 6), adjustGroup(match, 7),
|
||||
adjustGroup(match, 8), adjustGroup(match, 9),
|
||||
},
|
||||
)
|
||||
if err != nil {
|
||||
continue
|
||||
}
|
||||
|
||||
// Text runs from after this marker to the start of the next marker (or end of string)
|
||||
textStart := match[1]
|
||||
var textEnd int
|
||||
if i+1 < len(matches) {
|
||||
textEnd = matches[i+1][0]
|
||||
} else {
|
||||
textEnd = len(text)
|
||||
}
|
||||
|
||||
word := text[textStart:textEnd]
|
||||
if word == "" {
|
||||
continue
|
||||
}
|
||||
|
||||
rawStart := rawValue.Len()
|
||||
rawValue.WriteString(word)
|
||||
segments = append(segments, segment{
|
||||
start: timeMs,
|
||||
rawStart: rawStart,
|
||||
rawEnd: rawValue.Len(),
|
||||
})
|
||||
}
|
||||
|
||||
if len(segments) == 0 {
|
||||
return strings.TrimSpace(stripEnhancedMarkers(text)), nil
|
||||
}
|
||||
|
||||
finalRaw := rawValue.String()
|
||||
leftTrimBytes := len(finalRaw) - len(strings.TrimLeftFunc(finalRaw, unicode.IsSpace))
|
||||
rightTrimBytes := len(finalRaw) - len(strings.TrimRightFunc(finalRaw, unicode.IsSpace))
|
||||
trimmedEnd := len(finalRaw) - rightTrimBytes
|
||||
if trimmedEnd < leftTrimBytes {
|
||||
trimmedEnd = leftTrimBytes
|
||||
}
|
||||
|
||||
cues := make([]Cue, 0, len(segments))
|
||||
for _, seg := range segments {
|
||||
start := seg.start
|
||||
byteStart := max(seg.rawStart, leftTrimBytes)
|
||||
byteEnd := min(seg.rawEnd, trimmedEnd)
|
||||
if byteStart >= byteEnd {
|
||||
continue
|
||||
}
|
||||
|
||||
cues = append(cues, Cue{
|
||||
Start: &start,
|
||||
Value: finalRaw[byteStart:byteEnd],
|
||||
ByteStart: byteStart - leftTrimBytes,
|
||||
ByteEnd: byteEnd - leftTrimBytes - 1,
|
||||
})
|
||||
}
|
||||
|
||||
return strings.TrimSpace(finalRaw), cues
|
||||
}
|
||||
|
||||
// adjustGroup remaps a capture group index from the original match to our rewritten "[...]" string.
|
||||
// The rewrite shifts by -1 (removed '<', added '[') so positions within the brackets stay the same.
|
||||
func adjustGroup(match []int, groupIdx int) int {
|
||||
orig := match[groupIdx]
|
||||
if orig == -1 {
|
||||
return -1
|
||||
}
|
||||
// Offset is: original position minus the position of '<' in the original, plus 1 for '['
|
||||
return orig - match[0]
|
||||
}
|
||||
|
||||
// stripEnhancedMarkers removes all <mm:ss.mm> inline markers from text,
|
||||
// returning the plain lyric text.
|
||||
func stripEnhancedMarkers(text string) string {
|
||||
return enhancedLRCRegex.ReplaceAllString(text, "")
|
||||
}
|
||||
|
||||
func parseTime(line string, match []int) (int64, error) {
|
||||
var hours, millis int64
|
||||
var err error
|
||||
@ -227,3 +360,119 @@ func parseTime(line string, match []int) (int64, error) {
|
||||
}
|
||||
|
||||
type LyricList []Lyrics
|
||||
|
||||
func NormalizeLyrics(lyrics Lyrics) Lyrics {
|
||||
lyrics.Line = NormalizeCueLines(lyrics.Line)
|
||||
if len(lyrics.Agents) == 0 {
|
||||
lyrics.Agents = nil
|
||||
}
|
||||
return lyrics
|
||||
}
|
||||
|
||||
func NormalizeCueLines(lines []Line) []Line {
|
||||
if len(lines) == 0 {
|
||||
return lines
|
||||
}
|
||||
|
||||
normalized := make([]Line, len(lines))
|
||||
copy(normalized, lines)
|
||||
|
||||
for i := range normalized {
|
||||
if len(normalized[i].Cue) > 0 {
|
||||
normalized[i].Cue = slices.Clone(normalized[i].Cue)
|
||||
}
|
||||
|
||||
var fallbackEnd *int64
|
||||
if normalized[i].End != nil {
|
||||
v := *normalized[i].End
|
||||
fallbackEnd = &v
|
||||
} else if i+1 < len(normalized) && normalized[i+1].Start != nil {
|
||||
v := *normalized[i+1].Start
|
||||
fallbackEnd = &v
|
||||
}
|
||||
|
||||
normalized[i] = normalizeCueLine(normalized[i], fallbackEnd)
|
||||
}
|
||||
|
||||
return normalized
|
||||
}
|
||||
|
||||
func NormalizeLineTiming(line Line) Line {
|
||||
if len(line.Cue) == 0 {
|
||||
return line
|
||||
}
|
||||
|
||||
var earliestStart *int64
|
||||
var latestEnd *int64
|
||||
for i := range line.Cue {
|
||||
token := line.Cue[i]
|
||||
if token.Start != nil {
|
||||
if earliestStart == nil || *token.Start < *earliestStart {
|
||||
v := *token.Start
|
||||
earliestStart = &v
|
||||
}
|
||||
}
|
||||
|
||||
candidateEnd := token.End
|
||||
if candidateEnd == nil {
|
||||
candidateEnd = token.Start
|
||||
}
|
||||
if candidateEnd != nil {
|
||||
if latestEnd == nil || *candidateEnd > *latestEnd {
|
||||
v := *candidateEnd
|
||||
latestEnd = &v
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if line.Start == nil && earliestStart != nil {
|
||||
v := *earliestStart
|
||||
line.Start = &v
|
||||
}
|
||||
if line.End == nil && latestEnd != nil {
|
||||
v := *latestEnd
|
||||
line.End = &v
|
||||
}
|
||||
return line
|
||||
}
|
||||
|
||||
func normalizeCueLine(line Line, fallbackEnd *int64) Line {
|
||||
if len(line.Cue) == 0 {
|
||||
return line
|
||||
}
|
||||
|
||||
for i := range line.Cue {
|
||||
if line.Cue[i].End != nil {
|
||||
continue
|
||||
}
|
||||
|
||||
if i+1 < len(line.Cue) && line.Cue[i+1].Start != nil {
|
||||
v := *line.Cue[i+1].Start
|
||||
line.Cue[i].End = &v
|
||||
continue
|
||||
}
|
||||
|
||||
if fallbackEnd != nil {
|
||||
v := *fallbackEnd
|
||||
line.Cue[i].End = &v
|
||||
}
|
||||
}
|
||||
|
||||
for i := range line.Cue {
|
||||
if line.Cue[i].End == nil {
|
||||
line.Cue = clearCueEnds(line.Cue)
|
||||
return NormalizeLineTiming(line)
|
||||
}
|
||||
}
|
||||
|
||||
return NormalizeLineTiming(line)
|
||||
}
|
||||
|
||||
func clearCueEnds(cues []Cue) []Cue {
|
||||
normalized := make([]Cue, len(cues))
|
||||
copy(normalized, cues)
|
||||
for i := range normalized {
|
||||
normalized[i].End = nil
|
||||
}
|
||||
return normalized
|
||||
}
|
||||
|
||||
@ -108,4 +108,121 @@ var _ = Describe("ToLyrics", func() {
|
||||
{Start: new(int64(1000 * 60 * 60 * 51)), Value: "Test"},
|
||||
}))
|
||||
})
|
||||
|
||||
It("should parse Enhanced LRC with word-level timing", func() {
|
||||
lyrics, err := ToLyrics("xxx", "[00:01.00]<00:01.00>Some <00:01.50>lyrics <00:02.00>here\n[00:03.00]<00:03.00>More <00:03.50>words")
|
||||
Expect(err).ToNot(HaveOccurred())
|
||||
Expect(lyrics.Synced).To(BeTrue())
|
||||
Expect(lyrics.Line).To(HaveLen(2))
|
||||
|
||||
t1000, t1500, t2000, t3000, t3500 := int64(1000), int64(1500), int64(2000), int64(3000), int64(3500)
|
||||
|
||||
line0 := lyrics.Line[0]
|
||||
Expect(line0.Start).To(Equal(&t1000))
|
||||
Expect(line0.End).To(Equal(&t3000))
|
||||
Expect(line0.Value).To(Equal("Some lyrics here"))
|
||||
Expect(line0.Cue).To(Equal([]Cue{
|
||||
{Start: &t1000, End: &t1500, Value: "Some ", ByteStart: 0, ByteEnd: 4},
|
||||
{Start: &t1500, End: &t2000, Value: "lyrics ", ByteStart: 5, ByteEnd: 11},
|
||||
{Start: &t2000, End: &t3000, Value: "here", ByteStart: 12, ByteEnd: 15},
|
||||
}))
|
||||
|
||||
line1 := lyrics.Line[1]
|
||||
Expect(line1.Start).To(Equal(&t3000))
|
||||
Expect(line1.End).To(Equal(&t3500))
|
||||
Expect(line1.Value).To(Equal("More words"))
|
||||
Expect(line1.Cue).To(Equal([]Cue{
|
||||
{Start: &t3000, Value: "More ", ByteStart: 0, ByteEnd: 4},
|
||||
{Start: &t3500, Value: "words", ByteStart: 5, ByteEnd: 9},
|
||||
}))
|
||||
|
||||
Expect(line1.Cue[1].End).To(BeNil())
|
||||
})
|
||||
|
||||
It("should not parse malformed Enhanced LRC timing markers", func() {
|
||||
lyrics, err := ToLyrics("xxx", "[00:01.00]<00:01a50>Not a marker")
|
||||
Expect(err).ToNot(HaveOccurred())
|
||||
Expect(lyrics.Synced).To(BeTrue())
|
||||
Expect(lyrics.Line).To(Equal([]Line{
|
||||
{Start: new(int64(1000)), Value: "<00:01a50>Not a marker"},
|
||||
}))
|
||||
})
|
||||
|
||||
It("should ignore Enhanced LRC markers and return plain lines when no markers present", func() {
|
||||
a, b := int64(1000), int64(3000)
|
||||
lyrics, err := ToLyrics("xxx", "[00:01.00]Plain line\n[00:03.00]Another plain line")
|
||||
Expect(err).ToNot(HaveOccurred())
|
||||
Expect(lyrics.Line).To(Equal([]Line{
|
||||
{Start: &a, Value: "Plain line"},
|
||||
{Start: &b, Value: "Another plain line"},
|
||||
}))
|
||||
})
|
||||
|
||||
It("should handle mixed Enhanced and plain LRC lines", func() {
|
||||
lyrics, err := ToLyrics("xxx", "[00:01.00]<00:01.00>Some <00:01.50>lyrics\n[00:03.00]Plain line\n[00:05.00]<00:05.00>More <00:05.50>words")
|
||||
Expect(err).ToNot(HaveOccurred())
|
||||
Expect(lyrics.Line).To(HaveLen(3))
|
||||
|
||||
t1000, t1500, t5000, t5500 := int64(1000), int64(1500), int64(5000), int64(5500)
|
||||
t3000 := int64(3000)
|
||||
|
||||
Expect(lyrics.Line[0].Cue).To(Equal([]Cue{
|
||||
{Start: &t1000, End: &t1500, Value: "Some ", ByteStart: 0, ByteEnd: 4},
|
||||
{Start: &t1500, End: &t3000, Value: "lyrics", ByteStart: 5, ByteEnd: 10},
|
||||
}))
|
||||
Expect(lyrics.Line[0].Value).To(Equal("Some lyrics"))
|
||||
Expect(lyrics.Line[0].End).To(Equal(&t3000))
|
||||
|
||||
Expect(lyrics.Line[1].Cue).To(BeNil())
|
||||
Expect(lyrics.Line[1].Value).To(Equal("Plain line"))
|
||||
|
||||
Expect(lyrics.Line[2].Cue).To(Equal([]Cue{
|
||||
{Start: &t5000, Value: "More ", ByteStart: 0, ByteEnd: 4},
|
||||
{Start: &t5500, Value: "words", ByteStart: 5, ByteEnd: 9},
|
||||
}))
|
||||
Expect(lyrics.Line[2].Value).To(Equal("More words"))
|
||||
})
|
||||
|
||||
It("should preserve byte offsets for Enhanced LRC cues", func() {
|
||||
lyrics, err := ToLyrics("xxx", "[00:00.00]<00:00.00>Oh <00:00.90>love<00:01.30> me <00:01.60>tonight")
|
||||
Expect(err).ToNot(HaveOccurred())
|
||||
Expect(lyrics.Line).To(HaveLen(1))
|
||||
|
||||
t0, t900, t1300, t1600 := int64(0), int64(900), int64(1300), int64(1600)
|
||||
line := lyrics.Line[0]
|
||||
Expect(line.Value).To(Equal("Oh love me tonight"))
|
||||
Expect(line.Cue).To(Equal([]Cue{
|
||||
{Start: &t0, Value: "Oh ", ByteStart: 0, ByteEnd: 2},
|
||||
{Start: &t900, Value: "love", ByteStart: 3, ByteEnd: 6},
|
||||
{Start: &t1300, Value: " me ", ByteStart: 7, ByteEnd: 10},
|
||||
{Start: &t1600, Value: "tonight", ByteStart: 11, ByteEnd: 17},
|
||||
}))
|
||||
})
|
||||
})
|
||||
|
||||
var _ = Describe("NormalizeCueLines", func() {
|
||||
It("should not mutate caller cue slices when filling missing cue end times", func() {
|
||||
start0, start1, nextLineStart := int64(1000), int64(1500), int64(3000)
|
||||
lines := []Line{
|
||||
{
|
||||
Start: &start0,
|
||||
Value: "Some lyrics",
|
||||
Cue: []Cue{
|
||||
{Start: &start0, Value: "Some ", ByteStart: 0, ByteEnd: 4},
|
||||
{Start: &start1, Value: "lyrics", ByteStart: 5, ByteEnd: 10},
|
||||
},
|
||||
},
|
||||
{
|
||||
Start: &nextLineStart,
|
||||
Value: "Next line",
|
||||
},
|
||||
}
|
||||
|
||||
normalized := NormalizeCueLines(lines)
|
||||
|
||||
Expect(normalized[0].Cue[0].End).To(Equal(&start1))
|
||||
Expect(normalized[0].Cue[1].End).To(Equal(&nextLineStart))
|
||||
Expect(lines[0].Cue[0].End).To(BeNil())
|
||||
Expect(lines[0].Cue[1].End).To(BeNil())
|
||||
})
|
||||
})
|
||||
|
||||
@ -8,6 +8,7 @@ import (
|
||||
"strconv"
|
||||
|
||||
"github.com/navidrome/navidrome/conf"
|
||||
lyricssvc "github.com/navidrome/navidrome/core/lyrics"
|
||||
"github.com/navidrome/navidrome/log"
|
||||
"github.com/navidrome/navidrome/model"
|
||||
"github.com/navidrome/navidrome/utils/str"
|
||||
@ -129,7 +130,7 @@ func (md Metadata) mapGain(rg, r128 model.TagName) *float64 {
|
||||
}
|
||||
|
||||
func (md Metadata) mapLyrics() string {
|
||||
rawLyrics := md.Pairs(model.TagLyrics)
|
||||
rawLyrics := md.rawPairs(model.TagLyrics)
|
||||
|
||||
lyricList := make(model.LyricList, 0, len(rawLyrics))
|
||||
|
||||
@ -137,13 +138,15 @@ func (md Metadata) mapLyrics() string {
|
||||
lang := raw.Key()
|
||||
text := raw.Value()
|
||||
|
||||
lyrics, err := model.ToLyrics(lang, text)
|
||||
lyrics, err := lyricssvc.ParseEmbedded(lang, text)
|
||||
if err != nil {
|
||||
log.Warn("Unexpected failure occurred when parsing lyrics", "file", md.filePath, err)
|
||||
continue
|
||||
}
|
||||
if !lyrics.IsEmpty() {
|
||||
lyricList = append(lyricList, *lyrics)
|
||||
for _, lyric := range lyrics {
|
||||
if !lyric.IsEmpty() {
|
||||
lyricList = append(lyricList, lyric)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@ -4,6 +4,7 @@ import (
|
||||
"encoding/json"
|
||||
"os"
|
||||
"sort"
|
||||
"strings"
|
||||
|
||||
"github.com/navidrome/navidrome/model"
|
||||
"github.com/navidrome/navidrome/model/metadata"
|
||||
@ -116,5 +117,86 @@ var _ = Describe("ToMediaFile", func() {
|
||||
sort.Slice(expected, func(i, j int) bool { return expected[i].Lang < expected[j].Lang })
|
||||
Expect(actual).To(Equal(expected))
|
||||
})
|
||||
|
||||
It("should parse embedded TTML lyrics before sanitizing XML tags", func() {
|
||||
mf = toMediaFile(model.RawTags{
|
||||
"LYRICS:ENG": {`<tt xmlns="http://www.w3.org/ns/ttml">
|
||||
<body>
|
||||
<div>
|
||||
<p begin="00:00:01.000" end="00:00:02.500">Embedded TTML line</p>
|
||||
</div>
|
||||
</body>
|
||||
</tt>`},
|
||||
})
|
||||
var actual model.LyricList
|
||||
err := json.Unmarshal([]byte(mf.Lyrics), &actual)
|
||||
Expect(err).ToNot(HaveOccurred())
|
||||
|
||||
Expect(actual).To(Equal(model.LyricList{
|
||||
{
|
||||
Kind: "main",
|
||||
Lang: "eng",
|
||||
Line: []model.Line{{Start: ptr(int64(1000)), End: ptr(int64(2500)), Value: "Embedded TTML line"}},
|
||||
Synced: true,
|
||||
},
|
||||
}))
|
||||
})
|
||||
|
||||
It("should parse embedded TTML lyrics longer than the metadata tag max length", func() {
|
||||
padding := strings.Repeat(`<text for="unused">padding</text>`, 1400)
|
||||
content := `<tt xmlns="http://www.w3.org/ns/ttml" xmlns:itunes="http://music.apple.com/lyric-ttml-internal" xml:lang="en">
|
||||
<head>
|
||||
<metadata>
|
||||
<iTunesMetadata xmlns="http://music.apple.com/lyric-ttml-internal">
|
||||
<translations>
|
||||
<translation xml:lang="en-US">` + padding + `</translation>
|
||||
</translations>
|
||||
</iTunesMetadata>
|
||||
</metadata>
|
||||
</head>
|
||||
<body>
|
||||
<div>
|
||||
<p begin="00:00:01.000" end="00:00:02.500" itunes:key="L1">Long embedded TTML line</p>
|
||||
</div>
|
||||
</body>
|
||||
</tt>`
|
||||
|
||||
Expect(len(content)).To(BeNumerically(">", 32768))
|
||||
|
||||
mf = toMediaFile(model.RawTags{
|
||||
"LYRICS:ENG": {content},
|
||||
})
|
||||
var actual model.LyricList
|
||||
err := json.Unmarshal([]byte(mf.Lyrics), &actual)
|
||||
Expect(err).ToNot(HaveOccurred())
|
||||
|
||||
Expect(actual).To(HaveLen(1))
|
||||
Expect(actual[0].Kind).To(Equal("main"))
|
||||
Expect(actual[0].Lang).To(Equal("en"))
|
||||
Expect(actual[0].Line).To(Equal([]model.Line{
|
||||
{Start: ptr(int64(1000)), End: ptr(int64(2500)), Value: "Long embedded TTML line"},
|
||||
}))
|
||||
})
|
||||
|
||||
It("should parse embedded SRT lyrics with the tag language", func() {
|
||||
mf = toMediaFile(model.RawTags{
|
||||
"LYRICS:POR": {`1
|
||||
00:00:18,800 --> 00:00:22,800
|
||||
Estamos nas legendas`},
|
||||
})
|
||||
var actual model.LyricList
|
||||
err := json.Unmarshal([]byte(mf.Lyrics), &actual)
|
||||
Expect(err).ToNot(HaveOccurred())
|
||||
|
||||
Expect(actual).To(Equal(model.LyricList{
|
||||
{
|
||||
Lang: "por",
|
||||
Line: []model.Line{
|
||||
{Start: ptr(int64(18800)), End: ptr(int64(22800)), Value: "Estamos nas legendas"},
|
||||
},
|
||||
Synced: true,
|
||||
},
|
||||
}))
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
@ -70,6 +70,7 @@ func New(filePath string, info Info) Metadata {
|
||||
return Metadata{
|
||||
filePath: filePath,
|
||||
fileInfo: info.FileInfo,
|
||||
rawTags: lowerTags(info.Tags),
|
||||
tags: clean(filePath, info.Tags),
|
||||
audioProps: info.AudioProperties,
|
||||
hasPicture: info.HasPicture,
|
||||
@ -79,6 +80,7 @@ func New(filePath string, info Info) Metadata {
|
||||
type Metadata struct {
|
||||
filePath string
|
||||
fileInfo FileInfo
|
||||
rawTags model.Tags
|
||||
tags model.Tags
|
||||
audioProps AudioProperties
|
||||
hasPicture bool
|
||||
@ -114,6 +116,14 @@ func (md Metadata) Pairs(key model.TagName) []Pair {
|
||||
values := md.tags[key]
|
||||
return slice.Map(values, func(v string) Pair { return Pair(v) })
|
||||
}
|
||||
func (md Metadata) rawPairs(key model.TagName) []Pair {
|
||||
mapping, ok := model.TagMappings()[key]
|
||||
if !ok {
|
||||
return nil
|
||||
}
|
||||
values := filterDuplicatedOrEmptyValues(processPairMapping(key, mapping, md.rawTags))
|
||||
return slice.Map(values, func(v string) Pair { return Pair(v) })
|
||||
}
|
||||
func (md Metadata) first(key model.TagName) string {
|
||||
if v, ok := md.tags[key]; ok && len(v) > 0 {
|
||||
return v[0]
|
||||
|
||||
5
model/metadata/test_helpers_test.go
Normal file
5
model/metadata/test_helpers_test.go
Normal file
@ -0,0 +1,5 @@
|
||||
package metadata_test
|
||||
|
||||
func ptr[T any](v T) *T {
|
||||
return &v
|
||||
}
|
||||
@ -494,14 +494,79 @@ func mapExplicitStatus(explicitStatus string) string {
|
||||
return ""
|
||||
}
|
||||
|
||||
func buildStructuredLyric(mf *model.MediaFile, lyrics model.Lyrics) responses.StructuredLyric {
|
||||
func buildStructuredLyric(mf *model.MediaFile, lyrics model.Lyrics, enhanced bool) responses.StructuredLyric {
|
||||
lines := make([]responses.Line, len(lyrics.Line))
|
||||
var cueLines []responses.CueLine
|
||||
agentOrderByID := make(map[string]int, len(lyrics.Agents))
|
||||
agentRoleByID := make(map[string]string, len(lyrics.Agents))
|
||||
responseAgents := make([]responses.Agent, 0, len(lyrics.Agents))
|
||||
|
||||
for i, agent := range lyrics.Agents {
|
||||
agentOrderByID[agent.ID] = i
|
||||
agentRoleByID[agent.ID] = agent.Role
|
||||
responseAgents = append(responseAgents, responses.Agent{
|
||||
ID: agent.ID,
|
||||
Role: agent.Role,
|
||||
Name: agent.Name,
|
||||
})
|
||||
}
|
||||
|
||||
for i, line := range lyrics.Line {
|
||||
lines[i] = responses.Line{
|
||||
Start: line.Start,
|
||||
Value: line.Value,
|
||||
}
|
||||
if !enhanced || len(line.Cue) == 0 {
|
||||
continue
|
||||
}
|
||||
|
||||
agentOrder := make([]string, 0, 2)
|
||||
cuesByAgent := make(map[string][]model.Cue)
|
||||
for _, cue := range line.Cue {
|
||||
if cue.Start == nil {
|
||||
continue
|
||||
}
|
||||
agentID := strings.TrimSpace(cue.AgentID)
|
||||
if _, exists := cuesByAgent[agentID]; !exists {
|
||||
agentOrder = append(agentOrder, agentID)
|
||||
}
|
||||
cuesByAgent[agentID] = append(cuesByAgent[agentID], cue)
|
||||
}
|
||||
|
||||
sort.SliceStable(agentOrder, func(i, j int) bool {
|
||||
leftRole := agentRoleByID[agentOrder[i]]
|
||||
rightRole := agentRoleByID[agentOrder[j]]
|
||||
if leftRole == "main" && rightRole != "main" {
|
||||
return true
|
||||
}
|
||||
if rightRole == "main" && leftRole != "main" {
|
||||
return false
|
||||
}
|
||||
|
||||
leftOrder, leftOK := agentOrderByID[agentOrder[i]]
|
||||
rightOrder, rightOK := agentOrderByID[agentOrder[j]]
|
||||
if leftOK && rightOK && leftOrder != rightOrder {
|
||||
return leftOrder < rightOrder
|
||||
}
|
||||
if leftOK != rightOK {
|
||||
return leftOK
|
||||
}
|
||||
return i < j
|
||||
})
|
||||
|
||||
for _, agentID := range agentOrder {
|
||||
cueLine := responses.CueLine{
|
||||
Index: int32(i),
|
||||
Start: line.Start,
|
||||
End: line.End,
|
||||
Value: line.Value,
|
||||
Cue: buildLyricCues(cuesByAgent[agentID], line.End),
|
||||
}
|
||||
if agentID != "" {
|
||||
cueLine.AgentID = agentID
|
||||
}
|
||||
cueLines = append(cueLines, cueLine)
|
||||
}
|
||||
}
|
||||
|
||||
structured := responses.StructuredLyric{
|
||||
@ -509,10 +574,22 @@ func buildStructuredLyric(mf *model.MediaFile, lyrics model.Lyrics) responses.St
|
||||
DisplayTitle: lyrics.DisplayTitle,
|
||||
Lang: lyrics.Lang,
|
||||
Line: lines,
|
||||
CueLine: cueLines,
|
||||
Offset: lyrics.Offset,
|
||||
Synced: lyrics.Synced,
|
||||
}
|
||||
|
||||
if enhanced {
|
||||
kind := strings.TrimSpace(lyrics.Kind)
|
||||
if kind == "" {
|
||||
kind = "main"
|
||||
}
|
||||
structured.Kind = kind
|
||||
if len(cueLines) > 0 && len(responseAgents) > 0 {
|
||||
structured.Agents = responseAgents
|
||||
}
|
||||
}
|
||||
|
||||
if structured.DisplayArtist == "" {
|
||||
structured.DisplayArtist = mf.Artist
|
||||
}
|
||||
@ -523,11 +600,86 @@ func buildStructuredLyric(mf *model.MediaFile, lyrics model.Lyrics) responses.St
|
||||
return structured
|
||||
}
|
||||
|
||||
func buildLyricsList(mf *model.MediaFile, lyricsList model.LyricList) *responses.LyricsList {
|
||||
lyricList := make(responses.StructuredLyrics, len(lyricsList))
|
||||
func buildLyricCues(cues []model.Cue, lineEnd *int64) []responses.LyricCue {
|
||||
if len(cues) == 0 {
|
||||
return nil
|
||||
}
|
||||
|
||||
for i, lyrics := range lyricsList {
|
||||
lyricList[i] = buildStructuredLyric(mf, lyrics)
|
||||
hasAnyEnd := false
|
||||
for i := range cues {
|
||||
if cues[i].End != nil {
|
||||
hasAnyEnd = true
|
||||
break
|
||||
}
|
||||
}
|
||||
|
||||
normalized := make([]responses.LyricCue, 0, len(cues))
|
||||
for i := range cues {
|
||||
if cues[i].Start == nil {
|
||||
continue
|
||||
}
|
||||
|
||||
cue := responses.LyricCue{
|
||||
Start: *cues[i].Start,
|
||||
Value: cues[i].Value,
|
||||
ByteStart: cues[i].ByteStart,
|
||||
ByteEnd: cues[i].ByteEnd,
|
||||
}
|
||||
if hasAnyEnd {
|
||||
end := cues[i].End
|
||||
if end == nil {
|
||||
if i+1 < len(cues) && cues[i+1].Start != nil {
|
||||
v := *cues[i+1].Start
|
||||
end = &v
|
||||
} else if lineEnd != nil {
|
||||
v := *lineEnd
|
||||
end = &v
|
||||
}
|
||||
}
|
||||
if end != nil && i+1 < len(cues) && cues[i+1].Start != nil && *end > *cues[i+1].Start {
|
||||
v := *cues[i+1].Start
|
||||
end = &v
|
||||
}
|
||||
if end != nil && *end < cue.Start {
|
||||
v := cue.Start
|
||||
end = &v
|
||||
}
|
||||
cue.End = end
|
||||
}
|
||||
normalized = append(normalized, cue)
|
||||
}
|
||||
|
||||
if hasAnyEnd {
|
||||
for i := range normalized {
|
||||
if normalized[i].End == nil {
|
||||
for j := range normalized {
|
||||
normalized[j].End = nil
|
||||
}
|
||||
break
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return normalized
|
||||
}
|
||||
|
||||
func buildLyricsList(mf *model.MediaFile, lyricsList model.LyricList, enhanced bool) *responses.LyricsList {
|
||||
var filtered model.LyricList
|
||||
if enhanced {
|
||||
filtered = lyricsList
|
||||
} else {
|
||||
// Without enhanced, only return "main" kind entries
|
||||
for _, l := range lyricsList {
|
||||
kind := strings.TrimSpace(l.Kind)
|
||||
if kind == "" || kind == "main" {
|
||||
filtered = append(filtered, l)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
lyricList := make(responses.StructuredLyrics, len(filtered))
|
||||
for i, lyrics := range filtered {
|
||||
lyricList[i] = buildStructuredLyric(mf, lyrics, enhanced)
|
||||
}
|
||||
|
||||
res := &responses.LyricsList{
|
||||
|
||||
@ -10,6 +10,7 @@ import (
|
||||
|
||||
"github.com/navidrome/navidrome/conf"
|
||||
"github.com/navidrome/navidrome/consts"
|
||||
lyricssvc "github.com/navidrome/navidrome/core/lyrics"
|
||||
"github.com/navidrome/navidrome/log"
|
||||
"github.com/navidrome/navidrome/model"
|
||||
"github.com/navidrome/navidrome/resources"
|
||||
@ -19,6 +20,8 @@ import (
|
||||
"github.com/navidrome/navidrome/utils/req"
|
||||
)
|
||||
|
||||
const maxLegacyLyricsCandidates = 10
|
||||
|
||||
func (api *Router) GetAvatar(w http.ResponseWriter, r *http.Request) (*responses.Subsonic, error) {
|
||||
if !conf.Server.EnableGravatar {
|
||||
return api.getPlaceHolderAvatar(w, r)
|
||||
@ -98,7 +101,11 @@ func (api *Router) GetLyrics(r *http.Request) (*responses.Subsonic, error) {
|
||||
response := newResponse()
|
||||
lyricsResponse := responses.Lyrics{}
|
||||
response.Lyrics = &lyricsResponse
|
||||
mediaFiles, err := api.ds.MediaFile(r.Context()).GetAll(filter.SongsByArtistTitleWithLyricsFirst(artist, title))
|
||||
opts := filter.SongsByArtistTitleWithLyricsFirst(artist, title)
|
||||
// Search a bounded duplicate window so source-priority fallback can still
|
||||
// reach older matches without turning legacy getLyrics into an unbounded scan.
|
||||
opts.Max = maxLegacyLyricsCandidates
|
||||
mediaFiles, err := api.ds.MediaFile(r.Context()).GetAll(opts)
|
||||
|
||||
if err != nil {
|
||||
return nil, err
|
||||
@ -108,9 +115,22 @@ func (api *Router) GetLyrics(r *http.Request) (*responses.Subsonic, error) {
|
||||
return response, nil
|
||||
}
|
||||
|
||||
structuredLyrics, err := api.lyrics.GetLyrics(r.Context(), &mediaFiles[0])
|
||||
if err != nil {
|
||||
return nil, err
|
||||
var structuredLyrics model.LyricList
|
||||
if batchLyrics, ok := api.lyrics.(lyricssvc.BatchLyrics); ok {
|
||||
structuredLyrics, err = batchLyrics.GetLyricsForMediaFiles(r.Context(), mediaFiles)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
} else {
|
||||
for i := range mediaFiles {
|
||||
structuredLyrics, err = api.lyrics.GetLyrics(r.Context(), &mediaFiles[i])
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
if len(structuredLyrics) > 0 {
|
||||
break
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if len(structuredLyrics) == 0 {
|
||||
@ -124,7 +144,6 @@ func (api *Router) GetLyrics(r *http.Request) (*responses.Subsonic, error) {
|
||||
for _, line := range structuredLyrics[0].Line {
|
||||
lyricsText.WriteString(line.Value + "\n")
|
||||
}
|
||||
|
||||
lyricsResponse.Value = lyricsText.String()
|
||||
|
||||
return response, nil
|
||||
@ -146,8 +165,10 @@ func (api *Router) GetLyricsBySongId(r *http.Request) (*responses.Subsonic, erro
|
||||
return nil, err
|
||||
}
|
||||
|
||||
enhanced, _ := req.Params(r).Bool("enhanced")
|
||||
|
||||
response := newResponse()
|
||||
response.LyricsList = buildLyricsList(mediaFile, structuredLyrics)
|
||||
response.LyricsList = buildLyricsList(mediaFile, structuredLyrics, enhanced)
|
||||
|
||||
return response, nil
|
||||
}
|
||||
|
||||
@ -180,6 +180,41 @@ var _ = Describe("MediaRetrievalController", func() {
|
||||
Expect(response.Lyrics.Title).To(Equal("Never Gonna Give You Up"))
|
||||
Expect(response.Lyrics.Value).To(Equal("We're no strangers to love\nYou know the rules and so do I\n"))
|
||||
})
|
||||
|
||||
It("should prefer higher-priority sidecar lyrics across duplicate candidates", func() {
|
||||
conf.Server.LyricsPriority = ".ttml,embedded"
|
||||
r := newGetRequest("artist=Rick+Astley", "title=Never+Gonna+Give+You+Up")
|
||||
baseTime := time.Date(2025, 1, 1, 0, 0, 0, 0, time.UTC)
|
||||
embedded, err := model.ToLyrics("eng", "Newest duplicate embedded lyrics")
|
||||
Expect(err).ToNot(HaveOccurred())
|
||||
embeddedJSON, err := json.Marshal(model.LyricList{*embedded})
|
||||
Expect(err).ToNot(HaveOccurred())
|
||||
mockRepo.SetData(model.MediaFiles{
|
||||
{
|
||||
ID: "1",
|
||||
Path: "tests/fixtures/01 Invisible (RED) Edit Version.mp3",
|
||||
Artist: "Rick Astley",
|
||||
Title: "Never Gonna Give You Up",
|
||||
Lyrics: string(embeddedJSON),
|
||||
UpdatedAt: baseTime.Add(2 * time.Hour), // Newer duplicate with embedded lyrics only
|
||||
},
|
||||
{
|
||||
ID: "2",
|
||||
Path: "tests/fixtures/test.mp3",
|
||||
Artist: "Rick Astley",
|
||||
Title: "Never Gonna Give You Up",
|
||||
Lyrics: "[]",
|
||||
UpdatedAt: baseTime.Add(1 * time.Hour), // Older, but has TTML sidecar
|
||||
},
|
||||
})
|
||||
|
||||
response, err := router.GetLyrics(r)
|
||||
Expect(err).ToNot(HaveOccurred())
|
||||
Expect(response.Lyrics.Artist).To(Equal("Rick Astley"))
|
||||
Expect(response.Lyrics.Title).To(Equal("Never Gonna Give You Up"))
|
||||
Expect(response.Lyrics.Value).To(Equal("We're no strangers to love\nYou know the rules and so do I\n"))
|
||||
Expect(mockRepo.Options.Max).To(Equal(maxLegacyLyricsCandidates))
|
||||
})
|
||||
})
|
||||
|
||||
Describe("GetLyricsBySongId", func() {
|
||||
@ -196,8 +231,10 @@ var _ = Describe("MediaRetrievalController", func() {
|
||||
|
||||
Expect(realLyric.DisplayArtist).To(Equal(expectedLyric.DisplayArtist))
|
||||
Expect(realLyric.DisplayTitle).To(Equal(expectedLyric.DisplayTitle))
|
||||
Expect(realLyric.Kind).To(Equal(expectedLyric.Kind))
|
||||
Expect(realLyric.Lang).To(Equal(expectedLyric.Lang))
|
||||
Expect(realLyric.Synced).To(Equal(expectedLyric.Synced))
|
||||
Expect(realLyric.Agents).To(Equal(expectedLyric.Agents))
|
||||
|
||||
if expectedLyric.Offset == nil {
|
||||
Expect(realLyric.Offset).To(BeNil())
|
||||
@ -216,6 +253,38 @@ var _ = Describe("MediaRetrievalController", func() {
|
||||
Expect(*realLine.Start).To(Equal(*expectedLine.Start))
|
||||
}
|
||||
}
|
||||
|
||||
Expect(realLyric.CueLine).To(HaveLen(len(expectedLyric.CueLine)))
|
||||
for j, realCueLine := range realLyric.CueLine {
|
||||
expectedCueLine := expectedLyric.CueLine[j]
|
||||
Expect(realCueLine.Index).To(Equal(expectedCueLine.Index))
|
||||
Expect(realCueLine.Value).To(Equal(expectedCueLine.Value))
|
||||
Expect(realCueLine.AgentID).To(Equal(expectedCueLine.AgentID))
|
||||
if expectedCueLine.Start == nil {
|
||||
Expect(realCueLine.Start).To(BeNil())
|
||||
} else {
|
||||
Expect(*realCueLine.Start).To(Equal(*expectedCueLine.Start))
|
||||
}
|
||||
if expectedCueLine.End == nil {
|
||||
Expect(realCueLine.End).To(BeNil())
|
||||
} else {
|
||||
Expect(*realCueLine.End).To(Equal(*expectedCueLine.End))
|
||||
}
|
||||
|
||||
Expect(realCueLine.Cue).To(HaveLen(len(expectedCueLine.Cue)))
|
||||
for k, realCue := range realCueLine.Cue {
|
||||
expectedCue := expectedCueLine.Cue[k]
|
||||
Expect(realCue.Value).To(Equal(expectedCue.Value))
|
||||
Expect(realCue.Start).To(Equal(expectedCue.Start))
|
||||
Expect(realCue.ByteStart).To(Equal(expectedCue.ByteStart))
|
||||
Expect(realCue.ByteEnd).To(Equal(expectedCue.ByteEnd))
|
||||
if expectedCue.End == nil {
|
||||
Expect(realCue.End).To(BeNil())
|
||||
} else {
|
||||
Expect(*realCue.End).To(Equal(*expectedCue.End))
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@ -316,6 +385,427 @@ var _ = Describe("MediaRetrievalController", func() {
|
||||
},
|
||||
})
|
||||
})
|
||||
|
||||
It("should return multilingual TTML sidecar lyrics", func() {
|
||||
conf.Server.LyricsPriority = ".ttml,embedded"
|
||||
r := newGetRequest("id=1")
|
||||
|
||||
mockRepo.SetData(model.MediaFiles{
|
||||
{
|
||||
ID: "1",
|
||||
Path: "tests/fixtures/test.mp3",
|
||||
Artist: "Rick Astley",
|
||||
Title: "Never Gonna Give You Up",
|
||||
Lyrics: "[]",
|
||||
},
|
||||
})
|
||||
|
||||
response, err := router.GetLyricsBySongId(r)
|
||||
Expect(err).ToNot(HaveOccurred())
|
||||
|
||||
porTime := int64(18800)
|
||||
ttmlTime := int64(22800)
|
||||
compareResponses(response.LyricsList, responses.LyricsList{
|
||||
StructuredLyrics: responses.StructuredLyrics{
|
||||
{
|
||||
DisplayArtist: "Rick Astley",
|
||||
DisplayTitle: "Never Gonna Give You Up",
|
||||
Lang: "eng",
|
||||
Synced: true,
|
||||
Line: []responses.Line{
|
||||
{
|
||||
Start: ×[0],
|
||||
Value: "We're no strangers to love",
|
||||
},
|
||||
{
|
||||
Start: &ttmlTime,
|
||||
Value: "You know the rules and so do I",
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
DisplayArtist: "Rick Astley",
|
||||
DisplayTitle: "Never Gonna Give You Up",
|
||||
Lang: "por",
|
||||
Synced: true,
|
||||
Line: []responses.Line{
|
||||
{
|
||||
Start: &porTime,
|
||||
Value: "Nao somos estranhos ao amor",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
})
|
||||
})
|
||||
|
||||
It("should return metadata-linked translation and pronunciation tracks from TTML", func() {
|
||||
conf.Server.LyricsPriority = ".ttml,embedded"
|
||||
r := newGetRequest("id=1&enhanced=true")
|
||||
|
||||
mockRepo.SetData(model.MediaFiles{
|
||||
{
|
||||
ID: "1",
|
||||
Path: "tests/fixtures/test-metadata.mp3",
|
||||
Artist: "Rick Astley",
|
||||
Title: "Never Gonna Give You Up",
|
||||
Lyrics: "[]",
|
||||
},
|
||||
})
|
||||
|
||||
response, err := router.GetLyricsBySongId(r)
|
||||
Expect(err).ToNot(HaveOccurred())
|
||||
|
||||
mainStartA := int64(1000)
|
||||
mainStartB := int64(2000)
|
||||
tokenStartA := int64(2000)
|
||||
tokenEndA := int64(2300)
|
||||
tokenStartB := int64(2300)
|
||||
tokenEndB := int64(2600)
|
||||
compareResponses(response.LyricsList, responses.LyricsList{
|
||||
StructuredLyrics: responses.StructuredLyrics{
|
||||
{
|
||||
DisplayArtist: "Rick Astley",
|
||||
DisplayTitle: "Never Gonna Give You Up",
|
||||
Kind: "main",
|
||||
Lang: "ja",
|
||||
Synced: true,
|
||||
Line: []responses.Line{
|
||||
{
|
||||
Start: &mainStartA,
|
||||
Value: "こんにちは",
|
||||
},
|
||||
{
|
||||
Start: &mainStartB,
|
||||
Value: "こんばんは",
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
DisplayArtist: "Rick Astley",
|
||||
DisplayTitle: "Never Gonna Give You Up",
|
||||
Kind: "translation",
|
||||
Lang: "es",
|
||||
Synced: true,
|
||||
Line: []responses.Line{
|
||||
{
|
||||
Start: &mainStartA,
|
||||
Value: "Hola",
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
DisplayArtist: "Rick Astley",
|
||||
DisplayTitle: "Never Gonna Give You Up",
|
||||
Kind: "pronunciation",
|
||||
Lang: "ja-latn",
|
||||
Synced: true,
|
||||
Line: []responses.Line{
|
||||
{
|
||||
Start: &mainStartB,
|
||||
Value: "konni",
|
||||
},
|
||||
},
|
||||
CueLine: []responses.CueLine{
|
||||
{
|
||||
Index: 0,
|
||||
Start: &mainStartB,
|
||||
End: &tokenEndB,
|
||||
Value: "konni",
|
||||
Cue: []responses.LyricCue{
|
||||
{
|
||||
Start: tokenStartA,
|
||||
End: &tokenEndA,
|
||||
ByteStart: 0,
|
||||
ByteEnd: 1,
|
||||
Value: "ko",
|
||||
},
|
||||
{
|
||||
Start: tokenStartB,
|
||||
End: &tokenEndB,
|
||||
ByteStart: 2,
|
||||
ByteEnd: 4,
|
||||
Value: "nni",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
})
|
||||
})
|
||||
|
||||
It("should return cue lines for songLyrics v2 clients with enhanced=true", func() {
|
||||
r := newGetRequest("id=1&enhanced=true")
|
||||
|
||||
lineStart := int64(1000)
|
||||
lineEnd := int64(3000)
|
||||
tokenStartA := int64(1000)
|
||||
tokenEndA := int64(1400)
|
||||
tokenStartB := int64(2000)
|
||||
tokenEndB := int64(2500)
|
||||
lyricsJson, err := json.Marshal(model.LyricList{
|
||||
{
|
||||
Lang: "eng",
|
||||
Agents: []model.Agent{{ID: "lead", Role: "main"}, {ID: "__nd_bg__|lead", Role: "bg"}},
|
||||
Synced: true,
|
||||
Line: []model.Line{
|
||||
{
|
||||
Start: &lineStart,
|
||||
End: &lineEnd,
|
||||
Value: "Hello echo",
|
||||
Cue: []model.Cue{
|
||||
{
|
||||
Start: &tokenStartA,
|
||||
End: &tokenEndA,
|
||||
Value: "Hello",
|
||||
ByteStart: 0,
|
||||
ByteEnd: 4,
|
||||
AgentID: "lead",
|
||||
},
|
||||
{
|
||||
Start: &tokenStartB,
|
||||
End: &tokenEndB,
|
||||
Value: "echo",
|
||||
ByteStart: 6,
|
||||
ByteEnd: 9,
|
||||
AgentID: "__nd_bg__|lead",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
})
|
||||
Expect(err).ToNot(HaveOccurred())
|
||||
|
||||
mockRepo.SetData(model.MediaFiles{
|
||||
{
|
||||
ID: "1",
|
||||
Artist: "Rick Astley",
|
||||
Title: "Never Gonna Give You Up",
|
||||
Lyrics: string(lyricsJson),
|
||||
},
|
||||
})
|
||||
|
||||
response, err := router.GetLyricsBySongId(r)
|
||||
Expect(err).ToNot(HaveOccurred())
|
||||
compareResponses(response.LyricsList, responses.LyricsList{
|
||||
StructuredLyrics: responses.StructuredLyrics{
|
||||
{
|
||||
DisplayArtist: "Rick Astley",
|
||||
DisplayTitle: "Never Gonna Give You Up",
|
||||
Kind: "main",
|
||||
Lang: "eng",
|
||||
Synced: true,
|
||||
Agents: []responses.Agent{
|
||||
{ID: "lead", Role: "main"},
|
||||
{ID: "__nd_bg__|lead", Role: "bg"},
|
||||
},
|
||||
Line: []responses.Line{
|
||||
{
|
||||
Start: &lineStart,
|
||||
Value: "Hello echo",
|
||||
},
|
||||
},
|
||||
CueLine: []responses.CueLine{
|
||||
{
|
||||
Index: 0,
|
||||
Start: &lineStart,
|
||||
End: &lineEnd,
|
||||
Value: "Hello echo",
|
||||
AgentID: "lead",
|
||||
Cue: []responses.LyricCue{
|
||||
{
|
||||
Start: tokenStartA,
|
||||
End: &tokenEndA,
|
||||
ByteStart: 0,
|
||||
ByteEnd: 4,
|
||||
Value: "Hello",
|
||||
},
|
||||
},
|
||||
},
|
||||
{
|
||||
Index: 0,
|
||||
Start: &lineStart,
|
||||
End: &lineEnd,
|
||||
Value: "Hello echo",
|
||||
AgentID: "__nd_bg__|lead",
|
||||
Cue: []responses.LyricCue{
|
||||
{
|
||||
Start: tokenStartB,
|
||||
End: &tokenEndB,
|
||||
ByteStart: 6,
|
||||
ByteEnd: 9,
|
||||
Value: "echo",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
})
|
||||
})
|
||||
|
||||
It("should keep enhanced line-level lyrics when no cue data is available", func() {
|
||||
r := newGetRequest("id=1&enhanced=true")
|
||||
|
||||
lineStart := int64(1000)
|
||||
lineEnd := int64(3000)
|
||||
lyricsJSON, err := json.Marshal(model.LyricList{
|
||||
{
|
||||
Kind: "main",
|
||||
Lang: "eng",
|
||||
Synced: true,
|
||||
Line: []model.Line{
|
||||
{
|
||||
Start: &lineStart,
|
||||
End: &lineEnd,
|
||||
Value: "Line without word timing",
|
||||
},
|
||||
},
|
||||
},
|
||||
})
|
||||
Expect(err).ToNot(HaveOccurred())
|
||||
|
||||
mockRepo.SetData(model.MediaFiles{
|
||||
{
|
||||
ID: "1",
|
||||
Artist: "Rick Astley",
|
||||
Title: "Never Gonna Give You Up",
|
||||
Lyrics: string(lyricsJSON),
|
||||
},
|
||||
})
|
||||
|
||||
response, err := router.GetLyricsBySongId(r)
|
||||
Expect(err).ToNot(HaveOccurred())
|
||||
compareResponses(response.LyricsList, responses.LyricsList{
|
||||
StructuredLyrics: responses.StructuredLyrics{
|
||||
{
|
||||
DisplayArtist: "Rick Astley",
|
||||
DisplayTitle: "Never Gonna Give You Up",
|
||||
Kind: "main",
|
||||
Lang: "eng",
|
||||
Synced: true,
|
||||
Line: []responses.Line{
|
||||
{
|
||||
Start: &lineStart,
|
||||
Value: "Line without word timing",
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
})
|
||||
})
|
||||
|
||||
It("should return required cue byte offsets for ambiguous and multibyte cue lines", func() {
|
||||
r := newGetRequest("id=1&enhanced=true")
|
||||
|
||||
asciiLineStart := int64(0)
|
||||
asciiLineEnd := int64(2400)
|
||||
asciiCueStartA := int64(0)
|
||||
asciiCueEndA := int64(300)
|
||||
asciiCueStartB := int64(900)
|
||||
asciiCueEndB := int64(1300)
|
||||
asciiCueStartC := int64(1300)
|
||||
asciiCueEndC := int64(1600)
|
||||
asciiCueStartD := int64(1600)
|
||||
|
||||
utfLineStart := int64(2747)
|
||||
utfLineEnd := int64(6214)
|
||||
utfCueStartA := int64(2747)
|
||||
utfCueEndA := int64(3018)
|
||||
utfCueStartB := int64(3018)
|
||||
utfCueEndB := int64(3179)
|
||||
utfCueStartC := int64(3582)
|
||||
utfCueEndC := int64(4100)
|
||||
utfCueStartD := int64(4500)
|
||||
utfCueEndD := int64(6214)
|
||||
|
||||
lyricsJSON, err := json.Marshal(model.LyricList{
|
||||
{
|
||||
Lang: "eng",
|
||||
Synced: true,
|
||||
Line: []model.Line{
|
||||
{
|
||||
Start: &asciiLineStart,
|
||||
End: &asciiLineEnd,
|
||||
Value: "Oh love love me tonight",
|
||||
Cue: []model.Cue{
|
||||
{Start: &asciiCueStartA, End: &asciiCueEndA, Value: "Oh", ByteStart: 0, ByteEnd: 1},
|
||||
{Start: &asciiCueStartB, End: &asciiCueEndB, Value: "love", ByteStart: 8, ByteEnd: 11},
|
||||
{Start: &asciiCueStartC, End: &asciiCueEndC, Value: "me", ByteStart: 13, ByteEnd: 14},
|
||||
{Start: &asciiCueStartD, Value: "tonight", ByteStart: 16, ByteEnd: 22},
|
||||
},
|
||||
},
|
||||
{
|
||||
Start: &utfLineStart,
|
||||
End: &utfLineEnd,
|
||||
Value: "눈을 뜬 순간",
|
||||
Cue: []model.Cue{
|
||||
{Start: &utfCueStartA, End: &utfCueEndA, Value: "눈", ByteStart: 0, ByteEnd: 2},
|
||||
{Start: &utfCueStartB, End: &utfCueEndB, Value: "을", ByteStart: 3, ByteEnd: 5},
|
||||
{Start: &utfCueStartC, End: &utfCueEndC, Value: "뜬", ByteStart: 7, ByteEnd: 9},
|
||||
{Start: &utfCueStartD, End: &utfCueEndD, Value: "순간", ByteStart: 11, ByteEnd: 16},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
})
|
||||
Expect(err).ToNot(HaveOccurred())
|
||||
|
||||
mockRepo.SetData(model.MediaFiles{
|
||||
{
|
||||
ID: "1",
|
||||
Artist: "Rick Astley",
|
||||
Title: "Never Gonna Give You Up",
|
||||
Lyrics: string(lyricsJSON),
|
||||
},
|
||||
})
|
||||
|
||||
response, err := router.GetLyricsBySongId(r)
|
||||
Expect(err).ToNot(HaveOccurred())
|
||||
compareResponses(response.LyricsList, responses.LyricsList{
|
||||
StructuredLyrics: responses.StructuredLyrics{
|
||||
{
|
||||
DisplayArtist: "Rick Astley",
|
||||
DisplayTitle: "Never Gonna Give You Up",
|
||||
Kind: "main",
|
||||
Lang: "eng",
|
||||
Synced: true,
|
||||
Line: []responses.Line{
|
||||
{Start: &asciiLineStart, Value: "Oh love love me tonight"},
|
||||
{Start: &utfLineStart, Value: "눈을 뜬 순간"},
|
||||
},
|
||||
CueLine: []responses.CueLine{
|
||||
{
|
||||
Index: 0,
|
||||
Start: &asciiLineStart,
|
||||
End: &asciiLineEnd,
|
||||
Value: "Oh love love me tonight",
|
||||
Cue: []responses.LyricCue{
|
||||
{Start: asciiCueStartA, End: &asciiCueEndA, Value: "Oh", ByteStart: 0, ByteEnd: 1},
|
||||
{Start: asciiCueStartB, End: &asciiCueEndB, Value: "love", ByteStart: 8, ByteEnd: 11},
|
||||
{Start: asciiCueStartC, End: &asciiCueEndC, Value: "me", ByteStart: 13, ByteEnd: 14},
|
||||
{Start: asciiCueStartD, End: &asciiLineEnd, Value: "tonight", ByteStart: 16, ByteEnd: 22},
|
||||
},
|
||||
},
|
||||
{
|
||||
Index: 1,
|
||||
Start: &utfLineStart,
|
||||
End: &utfLineEnd,
|
||||
Value: "눈을 뜬 순간",
|
||||
Cue: []responses.LyricCue{
|
||||
{Start: utfCueStartA, End: &utfCueEndA, Value: "눈", ByteStart: 0, ByteEnd: 2},
|
||||
{Start: utfCueStartB, End: &utfCueEndB, Value: "을", ByteStart: 3, ByteEnd: 5},
|
||||
{Start: utfCueStartC, End: &utfCueEndC, Value: "뜬", ByteStart: 7, ByteEnd: 9},
|
||||
{Start: utfCueStartD, End: &utfCueEndD, Value: "순간", ByteStart: 11, ByteEnd: 16},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
})
|
||||
})
|
||||
})
|
||||
})
|
||||
|
||||
|
||||
@ -11,7 +11,7 @@ func (api *Router) GetOpenSubsonicExtensions(_ *http.Request) (*responses.Subson
|
||||
extensions := responses.OpenSubsonicExtensions{
|
||||
{Name: "transcodeOffset", Versions: []int32{1}},
|
||||
{Name: "formPost", Versions: []int32{1}},
|
||||
{Name: "songLyrics", Versions: []int32{1}},
|
||||
{Name: "songLyrics", Versions: []int32{1, 2}},
|
||||
{Name: "indexBasedQueue", Versions: []int32{1}},
|
||||
{Name: "transcoding", Versions: []int32{1}},
|
||||
{Name: "playbackReport", Versions: []int32{1}},
|
||||
|
||||
@ -58,7 +58,7 @@ var _ = Describe("GetOpenSubsonicExtensions", func() {
|
||||
HaveLen(6),
|
||||
ContainElement(responses.OpenSubsonicExtension{Name: "transcodeOffset", Versions: []int32{1}}),
|
||||
ContainElement(responses.OpenSubsonicExtension{Name: "formPost", Versions: []int32{1}}),
|
||||
ContainElement(responses.OpenSubsonicExtension{Name: "songLyrics", Versions: []int32{1}}),
|
||||
ContainElement(responses.OpenSubsonicExtension{Name: "songLyrics", Versions: []int32{1, 2}}),
|
||||
ContainElement(responses.OpenSubsonicExtension{Name: "indexBasedQueue", Versions: []int32{1}}),
|
||||
ContainElement(responses.OpenSubsonicExtension{Name: "transcoding", Versions: []int32{1}}),
|
||||
ContainElement(responses.OpenSubsonicExtension{Name: "playbackReport", Versions: []int32{1}}),
|
||||
@ -88,7 +88,7 @@ var _ = Describe("GetOpenSubsonicExtensions", func() {
|
||||
HaveLen(7),
|
||||
ContainElement(responses.OpenSubsonicExtension{Name: "transcodeOffset", Versions: []int32{1}}),
|
||||
ContainElement(responses.OpenSubsonicExtension{Name: "formPost", Versions: []int32{1}}),
|
||||
ContainElement(responses.OpenSubsonicExtension{Name: "songLyrics", Versions: []int32{1}}),
|
||||
ContainElement(responses.OpenSubsonicExtension{Name: "songLyrics", Versions: []int32{1, 2}}),
|
||||
ContainElement(responses.OpenSubsonicExtension{Name: "indexBasedQueue", Versions: []int32{1}}),
|
||||
ContainElement(responses.OpenSubsonicExtension{Name: "transcoding", Versions: []int32{1}}),
|
||||
ContainElement(responses.OpenSubsonicExtension{Name: "playbackReport", Versions: []int32{1}}),
|
||||
|
||||
@ -547,13 +547,39 @@ type Line struct {
|
||||
Value string `xml:",chardata" json:"value"`
|
||||
}
|
||||
|
||||
type LyricCue struct {
|
||||
Start int64 `xml:"start,attr" json:"start"`
|
||||
End *int64 `xml:"end,attr,omitempty" json:"end,omitempty"`
|
||||
ByteStart int `xml:"byteStart,attr" json:"byteStart"`
|
||||
ByteEnd int `xml:"byteEnd,attr" json:"byteEnd"`
|
||||
Value string `xml:",chardata" json:"value"`
|
||||
}
|
||||
|
||||
type Agent struct {
|
||||
ID string `xml:"id,attr" json:"id"`
|
||||
Role string `xml:"role,attr" json:"role"`
|
||||
Name string `xml:"name,attr,omitempty" json:"name,omitempty"`
|
||||
}
|
||||
|
||||
type CueLine struct {
|
||||
Index int32 `xml:"index,attr" json:"index"`
|
||||
Start *int64 `xml:"start,attr,omitempty" json:"start,omitempty"`
|
||||
End *int64 `xml:"end,attr,omitempty" json:"end,omitempty"`
|
||||
Value string `xml:"value,attr" json:"value"`
|
||||
AgentID string `xml:"agentId,attr,omitempty" json:"agentId,omitempty"`
|
||||
Cue []LyricCue `xml:"cue,omitempty" json:"cue,omitempty"`
|
||||
}
|
||||
|
||||
type StructuredLyric struct {
|
||||
DisplayArtist string `xml:"displayArtist,attr,omitempty" json:"displayArtist,omitempty"`
|
||||
DisplayTitle string `xml:"displayTitle,attr,omitempty" json:"displayTitle,omitempty"`
|
||||
Lang string `xml:"lang,attr" json:"lang"`
|
||||
Line []Line `xml:"line" json:"line"`
|
||||
Offset *int64 `xml:"offset,attr,omitempty" json:"offset,omitempty"`
|
||||
Synced bool `xml:"synced,attr" json:"synced"`
|
||||
DisplayArtist string `xml:"displayArtist,attr,omitempty" json:"displayArtist,omitempty"`
|
||||
DisplayTitle string `xml:"displayTitle,attr,omitempty" json:"displayTitle,omitempty"`
|
||||
Kind string `xml:"kind,attr,omitempty" json:"kind,omitempty"`
|
||||
Lang string `xml:"lang,attr" json:"lang"`
|
||||
Line []Line `xml:"line" json:"line"`
|
||||
Agents []Agent `xml:"agent,omitempty" json:"agents,omitempty"`
|
||||
CueLine []CueLine `xml:"cueLine,omitempty" json:"cueLine,omitempty"`
|
||||
Offset *int64 `xml:"offset,attr,omitempty" json:"offset,omitempty"`
|
||||
Synced bool `xml:"synced,attr" json:"synced"`
|
||||
}
|
||||
|
||||
type StructuredLyrics []StructuredLyric
|
||||
|
||||
2
tests/fixtures/bom-test.ttml
vendored
Normal file
2
tests/fixtures/bom-test.ttml
vendored
Normal file
@ -0,0 +1,2 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<tt xmlns="http://www.w3.org/ns/ttml"><body><div xml:lang="eng"><p begin="00:00:00.00">BOM test line</p></div></body></tt>
|
||||
BIN
tests/fixtures/bom-utf16-test.ttml
vendored
Normal file
BIN
tests/fixtures/bom-utf16-test.ttml
vendored
Normal file
Binary file not shown.
6
tests/fixtures/test-enhanced.lrc
vendored
Normal file
6
tests/fixtures/test-enhanced.lrc
vendored
Normal file
@ -0,0 +1,6 @@
|
||||
[ar:Test Artist]
|
||||
[ti:Enhanced Test]
|
||||
[lang:eng]
|
||||
[00:01.00]<00:01.00>Some <00:01.50>lyrics <00:02.00>here
|
||||
[00:03.00]<00:03.00>More <00:03.50>words
|
||||
[00:05.00]Plain line without inline markers
|
||||
25
tests/fixtures/test-metadata.ttml
vendored
Normal file
25
tests/fixtures/test-metadata.ttml
vendored
Normal file
@ -0,0 +1,25 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<tt xmlns="http://www.w3.org/ns/ttml" xmlns:itunes="http://music.apple.com/lyric-ttml-internal">
|
||||
<head>
|
||||
<metadata>
|
||||
<iTunesMetadata xmlns="http://music.apple.com/lyric-ttml-internal">
|
||||
<translations>
|
||||
<translation xml:lang="es">
|
||||
<text for="L1">Hola</text>
|
||||
</translation>
|
||||
</translations>
|
||||
<transliterations>
|
||||
<transliteration xml:lang="ja-Latn">
|
||||
<text for="L2"><span begin="00:02.000" end="00:02.300" xmlns="http://www.w3.org/ns/ttml">ko</span><span begin="00:02.300" end="00:02.600" xmlns="http://www.w3.org/ns/ttml">nni</span></text>
|
||||
</transliteration>
|
||||
</transliterations>
|
||||
</iTunesMetadata>
|
||||
</metadata>
|
||||
</head>
|
||||
<body xml:lang="ja">
|
||||
<div>
|
||||
<p begin="00:01.000" end="00:01.500" itunes:key="L1">こんにちは</p>
|
||||
<p begin="00:02.000" end="00:02.700" itunes:key="L2">こんばんは</p>
|
||||
</div>
|
||||
</body>
|
||||
</tt>
|
||||
5
tests/fixtures/test.elrc
vendored
Normal file
5
tests/fixtures/test.elrc
vendored
Normal file
@ -0,0 +1,5 @@
|
||||
[ar:ELRC Artist]
|
||||
[ti:ELRC Song]
|
||||
[lang:eng]
|
||||
[00:01.00]<00:01.00>Lead <00:01.50>words
|
||||
[00:03.00]Fallback line
|
||||
7
tests/fixtures/test.srt
vendored
Normal file
7
tests/fixtures/test.srt
vendored
Normal file
@ -0,0 +1,7 @@
|
||||
1
|
||||
00:00:18,800 --> 00:00:22,800
|
||||
We're from subtitles
|
||||
|
||||
2
|
||||
00:00:22,801 --> 00:00:26,000
|
||||
Another subtitle line
|
||||
12
tests/fixtures/test.ttml
vendored
Normal file
12
tests/fixtures/test.ttml
vendored
Normal file
@ -0,0 +1,12 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<tt xmlns="http://www.w3.org/ns/ttml" xmlns:ttp="http://www.w3.org/ns/ttml#parameter" ttp:frameRate="30" ttp:subFrameRate="2" ttp:tickRate="10">
|
||||
<body>
|
||||
<div xml:lang="eng">
|
||||
<p begin="00:00:18.80">We're no strangers to love</p>
|
||||
<p begin="00:00:22:24">You know the rules and so do I</p>
|
||||
</div>
|
||||
<div xml:lang="por">
|
||||
<p begin="188t">Nao somos estranhos ao amor</p>
|
||||
</div>
|
||||
</body>
|
||||
</tt>
|
||||
Loading…
x
Reference in New Issue
Block a user