Add sampleRate to the DB

navidrome · May 11, 2024 · f3bb022 · f3bb022
1 parent 472324e
commit f3bb022
Show file tree

Hide file tree

Showing 5 changed files with 85 additions and 50 deletions.
diff --git a/db/migrations/20240511210036_add_sample_rate.go b/db/migrations/20240511210036_add_sample_rate.go
@@ -0,0 +1,29 @@
+package migrations
+
+import (
+	"context"
+	"database/sql"
+
+	"github.com/pressly/goose/v3"
+)
+
+func init() {
+	goose.AddMigrationContext(upAddSampleRate, downAddSampleRate)
+}
+
+func upAddSampleRate(ctx context.Context, tx *sql.Tx) error {
+	_, err := tx.ExecContext(ctx, `
+alter table media_file
+    add sample_rate integer not null default 0;
+
+create index if not exists media_file_sample_rate
+	on media_file (sample_rate);
+`)
+	notice(tx, "A full rescan should be performed to pick up additional tags")
+	return err
+}
+
+func downAddSampleRate(ctx context.Context, tx *sql.Tx) error {
+	_, err := tx.ExecContext(ctx, `alter table media_file drop sample_rate;`)
+	return err
+}
diff --git a/model/mediafile.go b/model/mediafile.go
@@ -43,6 +43,7 @@ type MediaFile struct {
 	Suffix               string  `structs:"suffix" json:"suffix"`
 	Duration             float32 `structs:"duration" json:"duration"`
 	BitRate              int     `structs:"bit_rate" json:"bitRate"`
+	SampleRate           int     `structs:"sample_rate" json:"sampleRate"`
 	Channels             int     `structs:"channels" json:"channels"`
 	Genre                string  `structs:"genre" json:"genre"`
 	Genres               Genres  `structs:"-" json:"genres"`

diff --git a/scanner/mapping.go b/scanner/mapping.go
@@ -46,6 +46,7 @@ func (s MediaFileMapper) ToMediaFile(md metadata.Tags) model.MediaFile {
 	mf.DiscSubtitle = md.DiscSubtitle()
 	mf.Duration = md.Duration()
 	mf.BitRate = md.BitRate()
+	mf.SampleRate = md.SampleRate()
 	mf.Channels = md.Channels()
 	mf.Path = md.FilePath()
 	mf.Suffix = md.Suffix()

diff --git a/scanner/metadata/metadata.go b/scanner/metadata/metadata.go
@@ -139,51 +139,9 @@ func (t Tags) Date() (int, string)         { return t.getDate("date") }
 func (t Tags) OriginalDate() (int, string) { return t.getDate("originaldate") }
 func (t Tags) ReleaseDate() (int, string)  { return t.getDate("releasedate") }
 func (t Tags) Comment() string             { return t.getFirstTagValue("comment") }
-func (t Tags) Lyrics() string {
-	lyricList := model.LyricList{}
-	basicLyrics := t.getAllTagValues("lyrics", "unsynced_lyrics", "unsynced lyrics", "unsyncedlyrics")
-
-	for _, value := range basicLyrics {
-		lyrics, err := model.ToLyrics("xxx", value)
-		if err != nil {
-			log.Warn("Unexpected failure occurred when parsing lyrics", "file", t.filePath, "error", err)
-			continue
-		}
-
-		lyricList = append(lyricList, *lyrics)
-	}
-
-	for tag, value := range t.Tags {
-		if strings.HasPrefix(tag, "lyrics-") {
-			language := strings.TrimSpace(strings.TrimPrefix(tag, "lyrics-"))
-
-			if language == "" {
-				language = "xxx"
-			}
-
-			for _, text := range value {
-				lyrics, err := model.ToLyrics(language, text)
-				if err != nil {
-					log.Warn("Unexpected failure occurred when parsing lyrics", "file", t.filePath, "error", err)
-					continue
-				}
-
-				lyricList = append(lyricList, *lyrics)
-			}
-		}
-	}
-
-	res, err := json.Marshal(lyricList)
-	if err != nil {
-		log.Warn("Unexpected error occurred when serializing lyrics", "file", t.filePath, "error", err)
-		return ""
-	}
-	return string(res)
-}
-
-func (t Tags) Compilation() bool       { return t.getBool("tcmp", "compilation", "wm/iscompilation") }
-func (t Tags) TrackNumber() (int, int) { return t.getTuple("track", "tracknumber") }
-func (t Tags) DiscNumber() (int, int)  { return t.getTuple("disc", "discnumber") }
+func (t Tags) Compilation() bool           { return t.getBool("tcmp", "compilation", "wm/iscompilation") }
+func (t Tags) TrackNumber() (int, int)     { return t.getTuple("track", "tracknumber") }
+func (t Tags) DiscNumber() (int, int)      { return t.getTuple("disc", "discnumber") }
 func (t Tags) DiscSubtitle() string {
 	return t.getFirstTagValue("tsst", "discsubtitle", "setsubtitle")
 }
@@ -214,9 +172,17 @@ func (t Tags) MbzAlbumComment() string {
 	return t.getFirstTagValue("musicbrainz_albumcomment", "musicbrainz album comment")
 }
 
+// ReplayGain Properties
+
+func (t Tags) RGAlbumGain() float64 { return t.getGainValue("replaygain_album_gain") }
+func (t Tags) RGAlbumPeak() float64 { return t.getPeakValue("replaygain_album_peak") }
+func (t Tags) RGTrackGain() float64 { return t.getGainValue("replaygain_track_gain") }
+func (t Tags) RGTrackPeak() float64 { return t.getPeakValue("replaygain_track_peak") }
+
 // File properties
 
 func (t Tags) Duration() float32           { return float32(t.getFloat("duration")) }
+func (t Tags) SampleRate() int             { return t.getInt("samplerate") }
 func (t Tags) BitRate() int                { return t.getInt("bitrate") }
 func (t Tags) Channels() int               { return t.getInt("channels") }
 func (t Tags) ModificationTime() time.Time { return t.fileInfo.ModTime() }
@@ -230,12 +196,47 @@ func (t Tags) BirthTime() time.Time {
 	return time.Now()
 }
 
-// ReplayGain Properties
+func (t Tags) Lyrics() string {
+	lyricList := model.LyricList{}
+	basicLyrics := t.getAllTagValues("lyrics", "unsynced_lyrics", "unsynced lyrics", "unsyncedlyrics")
 
-func (t Tags) RGAlbumGain() float64 { return t.getGainValue("replaygain_album_gain") }
-func (t Tags) RGAlbumPeak() float64 { return t.getPeakValue("replaygain_album_peak") }
-func (t Tags) RGTrackGain() float64 { return t.getGainValue("replaygain_track_gain") }
-func (t Tags) RGTrackPeak() float64 { return t.getPeakValue("replaygain_track_peak") }
+	for _, value := range basicLyrics {
+		lyrics, err := model.ToLyrics("xxx", value)
+		if err != nil {
+			log.Warn("Unexpected failure occurred when parsing lyrics", "file", t.filePath, "error", err)
+			continue
+		}
+
+		lyricList = append(lyricList, *lyrics)
+	}
+
+	for tag, value := range t.Tags {
+		if strings.HasPrefix(tag, "lyrics-") {
+			language := strings.TrimSpace(strings.TrimPrefix(tag, "lyrics-"))
+
+			if language == "" {
+				language = "xxx"
+			}
+
+			for _, text := range value {
+				lyrics, err := model.ToLyrics(language, text)
+				if err != nil {
+					log.Warn("Unexpected failure occurred when parsing lyrics", "file", t.filePath, "error", err)
+					continue
+				}
+
+				lyricList = append(lyricList, *lyrics)
+			}
+		}
+	}
+
+	res, err := json.Marshal(lyricList)
+	if err != nil {
+		log.Warn("Unexpected error occurred when serializing lyrics", "file", t.filePath, "error", err)
+		return ""
+	}
+	return string(res)
+}
 
 func (t Tags) getGainValue(tagName string) float64 {
 	// Gain is in the form [-]a.bb dB

diff --git a/scanner/metadata/metadata_test.go b/scanner/metadata/metadata_test.go
@@ -94,6 +94,7 @@ var _ = Describe("Tags", func() {
 			Expect(m.Duration()).To(BeNumerically("~", 1.02, 0.01))
 			Expect(m.BitRate()).To(Equal(192))
 			Expect(m.Channels()).To(Equal(2))
+			Expect(m.SampleRate()).To(Equal(44100))
 			Expect(m.FilePath()).To(Equal("tests/fixtures/test.mp3"))
 			Expect(m.Suffix()).To(Equal("mp3"))
 			Expect(m.Size()).To(Equal(int64(51876)))
@@ -113,6 +114,7 @@ var _ = Describe("Tags", func() {
 			// TabLib 1.12 returns 18, previous versions return 39.
 			// See https://github.com/taglib/taglib/commit/2f238921824741b2cfe6fbfbfc9701d9827ab06b
 			Expect(m.BitRate()).To(BeElementOf(18, 39, 40, 43, 49))
+			Expect(m.SampleRate()).To(Equal(8000))
 
 			m = mds["tests/fixtures/test.wma"]
 			Expect(err).To(BeNil())
@@ -124,6 +126,7 @@ var _ = Describe("Tags", func() {
 			Expect(m.FilePath()).To(Equal("tests/fixtures/test.wma"))
 			Expect(m.Size()).To(Equal(int64(21581)))
 			Expect(m.BitRate()).To(BeElementOf(128))
+			Expect(m.SampleRate()).To(Equal(44100))
 		})
 
 		DescribeTable("Lyrics test",