Skip to content

🎧 Your Personal Streaming Service

fix(scanner): lyrics tag parsing to properly handle both ID3 and aliased tags

Kendall Garner6730716d263e
diff --git a/adapters/taglib/end_to_end_test.go b/adapters/taglib/end_to_end_test.go
index e192bbdd7..e4d94bb24 100644
--- a/adapters/taglib/end_to_end_test.go
+++ b/adapters/taglib/end_to_end_test.go
@@ -79,22 +79,29 @@ var _ = Describe("Extractor", func() {
var e *extractor
+ parseTestFile := func(path string) *model.MediaFile {
+ mds, err := e.Parse(path)
+ Expect(err).ToNot(HaveOccurred())
+
+ info, ok := mds[path]
+ Expect(ok).To(BeTrue())
+
+ fileInfo, err := os.Stat(path)
+ Expect(err).ToNot(HaveOccurred())
+ info.FileInfo = testFileInfo{FileInfo: fileInfo}
+
+ metadata := metadata.New(path, info)
+ mf := metadata.ToMediaFile(1, "folderID")
+ return &mf
+ }
+
BeforeEach(func() {
e = &extractor{}
})
Describe("ReplayGain", func() {
DescribeTable("test replaygain end-to-end", func(file string, trackGain, trackPeak, albumGain, albumPeak *float64) {
- path := "tests/fixtures/" + file
- mds, err := e.Parse(path)
- Expect(err).ToNot(HaveOccurred())
-
- info := mds[path]
- fileInfo, _ := os.Stat(path)
- info.FileInfo = testFileInfo{FileInfo: fileInfo}
-
- metadata := metadata.New(path, info)
- mf := metadata.ToMediaFile(1, "folderID")
+ mf := parseTestFile("tests/fixtures/" + file)
Expect(mf.RGTrackGain).To(Equal(trackGain))
Expect(mf.RGTrackPeak).To(Equal(trackPeak))
@@ -106,18 +113,82 @@ var _ = Describe("Extractor", func() {
)
})
- Describe("Participants", func() {
- DescribeTable("test tags consistent across formats", func(format string) {
- path := "tests/fixtures/test." + format
- mds, err := e.Parse(path)
+ Describe("lyrics", func() {
+ makeLyrics := func(code, secondLine string) model.Lyrics {
+ return model.Lyrics{
+ DisplayArtist: "",
+ DisplayTitle: "",
+ Lang: code,
+ Line: []model.Line{
+ {Start: gg.P(int64(0)), Value: "This is"},
+ {Start: gg.P(int64(2500)), Value: secondLine},
+ },
+ Offset: nil,
+ Synced: true,
+ }
+ }
+
+ It("should fetch both synced and unsynced lyrics in mixed flac", func() {
+ mf := parseTestFile("tests/fixtures/mixed-lyrics.flac")
+
+ lyrics, err := mf.StructuredLyrics()
Expect(err).ToNot(HaveOccurred())
+ Expect(lyrics).To(HaveLen(2))
- info := mds[path]
- fileInfo, _ := os.Stat(path)
- info.FileInfo = testFileInfo{FileInfo: fileInfo}
+ Expect(lyrics[0].Synced).To(BeTrue())
+ Expect(lyrics[1].Synced).To(BeFalse())
+ })
- metadata := metadata.New(path, info)
- mf := metadata.ToMediaFile(1, "folderID")
+ It("should handle mp3 with uslt and sylt", func() {
+ mf := parseTestFile("tests/fixtures/test.mp3")
+
+ lyrics, err := mf.StructuredLyrics()
+ Expect(err).ToNot(HaveOccurred())
+ Expect(lyrics).To(HaveLen(4))
+
+ engSylt := makeLyrics("eng", "English SYLT")
+ engUslt := makeLyrics("eng", "English")
+ unsSylt := makeLyrics("xxx", "unspecified SYLT")
+ unsUslt := makeLyrics("xxx", "unspecified")
+
+ // Why is the order inconsistent between runs? Nobody knows
+ Expect(lyrics).To(Or(
+ Equal(model.LyricList{engSylt, engUslt, unsSylt, unsUslt}),
+ Equal(model.LyricList{unsSylt, unsUslt, engSylt, engUslt}),
+ ))
+ })
+
+ DescribeTable("format-specific lyrics", func(file string, isId3 bool) {
+ mf := parseTestFile("tests/fixtures/" + file)
+
+ lyrics, err := mf.StructuredLyrics()
+ Expect(err).To(Not(HaveOccurred()))
+ Expect(lyrics).To(HaveLen(2))
+
+ unspec := makeLyrics("xxx", "unspecified")
+ eng := makeLyrics("xxx", "English")
+
+ if isId3 {
+ eng.Lang = "eng"
+ }
+
+ Expect(lyrics).To(Or(
+ Equal(model.LyricList{unspec, eng}),
+ Equal(model.LyricList{eng, unspec})))
+ },
+ Entry("flac", "test.flac", false),
+ Entry("m4a", "test.m4a", false),
+ Entry("ogg", "test.ogg", false),
+ Entry("wma", "test.wma", false),
+ Entry("wv", "test.wv", false),
+ Entry("wav", "test.wav", true),
+ Entry("aiff", "test.aiff", true),
+ )
+ })
+
+ Describe("Participants", func() {
+ DescribeTable("test tags consistent across formats", func(format string) {
+ mf := parseTestFile("tests/fixtures/test." + format)
for _, data := range roles {
role := data.Role
@@ -176,16 +247,7 @@ var _ = Describe("Extractor", func() {
)
It("should parse wma", func() {
- path := "tests/fixtures/test.wma"
- mds, err := e.Parse(path)
- Expect(err).ToNot(HaveOccurred())
-
- info := mds[path]
- fileInfo, _ := os.Stat(path)
- info.FileInfo = testFileInfo{FileInfo: fileInfo}
-
- metadata := metadata.New(path, info)
- mf := metadata.ToMediaFile(1, "folderID")
+ mf := parseTestFile("tests/fixtures/test.wma")
for _, data := range roles {
role := data.Role
diff --git a/model/metadata/metadata.go b/model/metadata/metadata.go
index aea4238a4..1372d0034 100644
--- a/model/metadata/metadata.go
+++ b/model/metadata/metadata.go
@@ -245,10 +245,14 @@ func processPairMapping(name model.TagName, mapping model.TagConf, lowered model
}
}
+ // always parse id3 pairs. For lyrics, Taglib appears to always provide lyrics:xxx
+ // Prefer that over format-specific tags
+ id3Base := parseID3Pairs(name, lowered)
+
if len(aliasValues) > 0 {
- return parseVorbisPairs(aliasValues)
+ id3Base = append(id3Base, parseVorbisPairs(aliasValues)...)
}
- return parseID3Pairs(name, lowered)
+ return id3Base
}
func parseID3Pairs(name model.TagName, lowered model.Tags) []string {
diff --git a/resources/mappings.yaml b/resources/mappings.yaml
index f461d889e..d1da5c620 100644
--- a/resources/mappings.yaml
+++ b/resources/mappings.yaml
@@ -108,7 +108,8 @@ main:
bpm:
aliases: [ tbpm, bpm, tmpo, wm/beatsperminute ]
lyrics:
- aliases: [ uslt:description, lyrics, ©lyr, wm/lyrics, unsyncedlyrics ]
+ # Note, @lyr and wm/lyrics have been removed. Taglib somehow appears to always populate `lyrics:xxx`
+ aliases: [ uslt:description, lyrics, unsyncedlyrics ]
maxLength: 32768
type: pair # ex: lyrics:eng, lyrics:xxx
comment:
diff --git a/tests/fixtures/mixed-lyrics.flac b/tests/fixtures/mixed-lyrics.flac
new file mode 100644
index 000000000..d048234f5
Binary files /dev/null and b/tests/fixtures/mixed-lyrics.flac differ