feat: add support for synchronized lyrics

Author: streambinder

cmd/attach.go

@@ -4,8 +4,8 @@ import (
 	"path/filepath"
 	"strconv"
 
-	"github.com/bogem/id3v2/v2"
 	"github.com/spf13/cobra"
+	"github.com/streambinder/id3v2-sylt"
 	"github.com/streambinder/spotitube/downloader"
 	"github.com/streambinder/spotitube/entity/id3"
 	"github.com/streambinder/spotitube/lyrics"

cmd/attach_test.go

@@ -5,7 +5,7 @@ import (
 	"testing"
 
 	"github.com/agiledragon/gomonkey/v2"
-	"github.com/bogem/id3v2/v2"
+	"github.com/streambinder/id3v2-sylt"
 	"github.com/streambinder/spotitube/downloader"
 	"github.com/streambinder/spotitube/entity"
 	"github.com/streambinder/spotitube/lyrics"

cmd/show.go

@@ -5,9 +5,9 @@ import (
 	"os"
 	"text/tabwriter"
 
-	"github.com/bogem/id3v2/v2"
 	"github.com/fatih/color"
 	"github.com/spf13/cobra"
+	"github.com/streambinder/id3v2-sylt"
 	"github.com/streambinder/spotitube/entity/id3"
 	"github.com/streambinder/spotitube/util"
 )
@@ -45,7 +45,7 @@ func cmdShow() *cobra.Command {
 					fmt.Fprintln(table, "Artwork URL\t", util.Fallback(tag.ArtworkURL(), fallback))
 					fmt.Fprintln(table, "Duration\t", util.Fallback(fmt.Sprintf("%ss", tag.Duration()), fallback))
 					fmt.Fprintln(table, "Upstream URL\t", util.Fallback(tag.UpstreamURL(), fallback))
-					fmt.Fprintln(table, "Lyrics\t", util.Fallback(util.Excerpt(tag.UnsynchronizedLyrics(), 64), fallback))
+					fmt.Fprintln(table, "Lyrics\t", util.Fallback(util.Excerpt(util.FirstLine(tag.UnsynchronizedLyrics()), 64)+"...", fallback))
 					fmt.Fprintln(table, "Artwork\t", func(mimeType string, data []byte) string {
 						if len(data) > 0 {
 							return fmt.Sprintf("%s (%s)", mimeType, util.HumanizeBytes(len(data)))

cmd/sync.go

@@ -10,9 +10,9 @@ import (
 
 	"github.com/adrg/xdg"
 	"github.com/arunsworld/nursery"
-	"github.com/bogem/id3v2/v2"
 	"github.com/spf13/cobra"
 	"github.com/spf13/pflag"
+	"github.com/streambinder/id3v2-sylt"
 	"github.com/streambinder/spotitube/downloader"
 	"github.com/streambinder/spotitube/entity"
 	"github.com/streambinder/spotitube/entity/id3"
@@ -394,7 +394,7 @@ func routineCollectLyrics(track *entity.Track) func(context.Context, chan error)
 		}
 		tui.Lot("compose").Wipe()
 		track.Lyrics = lyrics
-		tui.Printf("lyrics for %s by %s: %s", track.Title, track.Artists[0], util.Excerpt(lyrics))
+		tui.Printf("lyrics for %s by %s: %s...", track.Title, track.Artists[0], util.Excerpt(util.FirstLine(lyrics), 64))
 	}
 }
 

cmd/sync_test.go

@@ -7,7 +7,7 @@ import (
 	"time"
 
 	"github.com/agiledragon/gomonkey/v2"
-	"github.com/bogem/id3v2/v2"
+	"github.com/streambinder/id3v2-sylt"
 	"github.com/streambinder/spotitube/downloader"
 	"github.com/streambinder/spotitube/entity"
 	"github.com/streambinder/spotitube/entity/id3"

entity/id3/id3.go

@@ -1,16 +1,19 @@
 package id3
 
 import (
+	"fmt"
 	"strings"
 
-	"github.com/bogem/id3v2/v2"
+	"github.com/streambinder/id3v2-sylt"
 	"github.com/streambinder/spotitube/lyrics"
+	"github.com/streambinder/spotitube/util"
 )
 
 const (
 	frameAttachedPicture      = "Attached picture"
 	frameTrackNumber          = "Track number/Position in set"
 	frameUnsynchronizedLyrics = "Unsynchronised lyrics/text transcription"
+	frameSynchronizedLyrics   = "Synchronised lyrics/text"
 	frameSpotifyID            = "Spotify ID"
 	frameArtworkURL           = "Artwork URL"
 	frameDuration             = "Duration"
@@ -126,20 +129,47 @@ func (tag *Tag) SetLyrics(title, lyrics string) {
 	tag.setUnsynchronizedLyrics(title, lyrics)
 }
 
-func (tag *Tag) setSynchronizedLyrics(_, data string) {
+func (tag *Tag) setSynchronizedLyrics(title, data string) {
 	if !lyrics.IsSynced(data) {
 		return
 	}
 
-	// implement me
+	var syncedText []id3v2.SyncedText
+	for _, line := range lyrics.GetSync(data) {
+		syncedText = append(syncedText, id3v2.SyncedText{
+			Timestamp: line.Time,
+			Text:      line.Text,
+		})
+	}
+
+	tag.AddSynchronisedLyricsFrame(id3v2.SynchronisedLyricsFrame{
+		Encoding:          tag.DefaultEncoding(),
+		Language:          "eng",
+		TimestampFormat:   id3v2.SYLTAbsoluteMillisecondsTimestampFormat,
+		ContentType:       id3v2.SYLTLyricsContentType,
+		ContentDescriptor: title,
+		SynchronizedTexts: syncedText,
+	})
+}
+
+func (tag *Tag) SynchronizedLyrics() string {
+	frame, ok := tag.GetLastFrame(tag.CommonID(frameSynchronizedLyrics)).(id3v2.SynchronisedLyricsFrame)
+	if ok {
+		var lyrics []string
+		for _, line := range frame.SynchronizedTexts {
+			lyrics = append(lyrics, fmt.Sprintf("[%s]%s", util.MillisToColonMinutes(line.Timestamp), line.Text))
+		}
+		return strings.Join(lyrics, "\n")
+	}
+	return ""
 }
 
-func (tag *Tag) setUnsynchronizedLyrics(title, lyrics string) {
+func (tag *Tag) setUnsynchronizedLyrics(title, data string) {
 	tag.AddUnsynchronisedLyricsFrame(id3v2.UnsynchronisedLyricsFrame{
 		Encoding:          tag.DefaultEncoding(),
 		Language:          "eng",
 		ContentDescriptor: title,
-		Lyrics:            lyrics,
+		Lyrics:            lyrics.GetPlain(data),
 	})
 }
 

entity/id3/id3_test.go

@@ -5,7 +5,7 @@ import (
 	"testing"
 
 	"github.com/agiledragon/gomonkey/v2"
-	"github.com/bogem/id3v2/v2"
+	"github.com/streambinder/id3v2-sylt"
 	"github.com/streambinder/spotitube/util"
 	"github.com/stretchr/testify/assert"
 )
@@ -31,9 +31,11 @@ func TestOpen(t *testing.T) {
 	assert.Empty(t, mimeType)
 	assert.Empty(t, image)
 	assert.Empty(t, tag.UnsynchronizedLyrics())
+	assert.Empty(t, tag.SynchronizedLyrics())
 
 	tag.SetAttachedPicture([]byte("picture"))
 	tag.SetLyrics("title", "lyrics")
+	tag.SetLyrics("title", "[01:01.15]lyrics")
 	tag.SetTrackNumber("1")
 	tag.SetSpotifyID("Spotify ID")
 	tag.SetArtworkURL("Artwork URL")
@@ -43,7 +45,8 @@ func TestOpen(t *testing.T) {
 	mimeType, image = tag.AttachedPicture()
 	assert.Equal(t, "image/jpeg", mimeType)
 	assert.Equal(t, []byte("picture"), image)
-	assert.Equal(t, "lyrics", tag.UnsynchronizedLyrics())
+	assert.Equal(t, "[01:01.15]lyrics", tag.UnsynchronizedLyrics())
+	assert.Equal(t, "[01:01.15]lyrics", tag.SynchronizedLyrics())
 	assert.Equal(t, "1", tag.TrackNumber())
 	assert.Equal(t, "Spotify ID", tag.SpotifyID())
 	assert.Equal(t, "Artwork URL", tag.ArtworkURL())

entity/index/index.go

@@ -6,8 +6,8 @@ import (
 	"strings"
 	"sync"
 
-	"github.com/bogem/id3v2/v2"
 	"github.com/gosimple/slug"
+	"github.com/streambinder/id3v2-sylt"
 	"github.com/streambinder/spotitube/entity"
 	"github.com/streambinder/spotitube/entity/id3"
 )

entity/index/index_test.go

@@ -8,7 +8,7 @@ import (
 	"testing"
 
 	"github.com/agiledragon/gomonkey/v2"
-	"github.com/bogem/id3v2/v2"
+	"github.com/streambinder/id3v2-sylt"
 	"github.com/streambinder/spotitube/entity"
 	"github.com/streambinder/spotitube/entity/id3"
 	"github.com/streambinder/spotitube/util"

go.mod

@@ -34,8 +34,9 @@ require (
 	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
 	github.com/modern-go/reflect2 v1.0.2 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
+	github.com/streambinder/id3v2-sylt v0.0.0-20250518085742-fbdd8d5d8b8b // indirect
 	golang.org/x/net v0.38.0 // indirect
 	golang.org/x/sys v0.31.0 // indirect
-	golang.org/x/text v0.23.0 // indirect
+	golang.org/x/text v0.25.0 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )