Add Synchronised Lyrics SYLT support

common_ids.go

@@ -49,10 +49,11 @@ var (
 		"Size":                         "TSIZ",
 		"ISRC":                         "TSRC",
 		"Software/Hardware and settings used for encoding": "TSSE",
-		"Year":                                     "TYER",
-		"User defined text information frame":      "TXXX",
-		"Unique file identifier":                   "UFID",
-		"Unsynchronised lyrics/text transcription": "USLT",
+		"Synchronised lyrics/text":                         "SYLT",
+		"Year":                                             "TYER",
+		"User defined text information frame":              "TXXX",
+		"Unique file identifier":                           "UFID",
+		"Unsynchronised lyrics/text transcription":         "USLT",
 
 		// Just for convenience.
 		"Artist": "TPE1",
@@ -109,6 +110,7 @@ var (
 		"ISRC":                         "TSRC",
 		"Software/Hardware and settings used for encoding": "TSSE",
 		"Set subtitle":                             "TSST",
+		"Synchronised lyrics/text":                 "SYLT",
 		"User defined text information frame":      "TXXX",
 		"Unique file identifier":                   "UFID",
 		"Unsynchronised lyrics/text transcription": "USLT",
@@ -139,6 +141,7 @@ var parsers = map[string]func(*bufReader) (Framer, error){
 	"APIC": parsePictureFrame,
 	"COMM": parseCommentFrame,
 	"POPM": parsePopularimeterFrame,
+	"SYLT": parseSynchronisedLyricsFrame,
 	"TXXX": parseUserDefinedTextFrame,
 	"UFID": parseUFIDFrame,
 	"USLT": parseUnsynchronisedLyricsFrame,

go.mod

@@ -1,4 +1,4 @@
-module github.com/bogem/id3v2
+module github.com/tramhao/id3v2
 
 go 1.13
 

synchronised_lyrics_frame.go

@@ -0,0 +1,136 @@
+// Copyright 2016 Albert Nigmatzianov. All rights reserved.
+// Use of this source code is governed by a MIT-style
+// license that can be found in the LICENSE file.
+
+package id3v2
+
+import (
+	// "bytes"
+	"encoding/binary"
+	// "fmt"
+	"io"
+)
+
+// SynchronisedLyricsFrame is used to work with SYLT frames.
+// The information about how to add synchronised lyrics/text frame to tag
+// you can see in the docs to tag.AddSynchronisedLyricsFrame function.
+//
+// You must choose a three-letter language code from
+// ISO 639-2 code list: https://www.loc.gov/standards/iso639-2/php/code_list.php
+type SynchronisedLyricsFrame struct {
+	Encoding          Encoding
+	Language          string
+	TimestampFormat   byte
+	ContentType       byte
+	ContentDescriptor string
+	SynchronizedTexts []SyncedText
+}
+
+type TimestampFormat int
+
+const (
+	Unknown TimestampFormat = iota
+	AbsoluteMpegFrames
+	AbsoluteMilliseconds
+)
+
+var (
+	ContentType = map[int]string{
+		0: "Other",
+		1: "Lyrics",
+		2: "Transcription",
+		3: "Movement",
+		4: "Events",
+		5: "Chord",
+		6: "Trivia",
+		7: "WebpageUrls",
+		8: "ImageUrls",
+	}
+)
+
+type SyncedText struct {
+	Text      string
+	Timestamp uint32
+}
+
+func (sylf SynchronisedLyricsFrame) Size() int {
+	var s int
+	for _, v := range sylf.SynchronizedTexts {
+		s += encodedSize(v.Text, sylf.Encoding)
+		s += len(sylf.Encoding.TerminationBytes)
+		s += 4
+	}
+
+	return 1 + len(sylf.Language) + encodedSize(sylf.ContentDescriptor, sylf.Encoding) +
+		+len(sylf.Encoding.TerminationBytes) + s +
+		+1 + 1
+}
+
+func (sylf SynchronisedLyricsFrame) UniqueIdentifier() string {
+	return sylf.Language + sylf.ContentDescriptor
+}
+
+func (sy SyncedText) uintToBytes() []byte {
+	bs := make([]byte, 4)
+	binary.BigEndian.PutUint32(bs, sy.Timestamp)
+	return bs
+}
+
+func bytesToInt(timeStampBytes []byte) uint32 {
+	return binary.BigEndian.Uint32(timeStampBytes)
+}
+
+func (sylf SynchronisedLyricsFrame) WriteTo(w io.Writer) (n int64, err error) {
+	if len(sylf.Language) != 3 {
+		return n, ErrInvalidLanguageLength
+	}
+	return useBufWriter(w, func(bw *bufWriter) {
+		bw.WriteByte(sylf.Encoding.Key)
+		bw.WriteString(sylf.Language)
+		bw.WriteByte(sylf.TimestampFormat)
+		bw.WriteByte(sylf.ContentType)
+		bw.EncodeAndWriteText(sylf.ContentDescriptor, sylf.Encoding)
+		bw.Write(sylf.Encoding.TerminationBytes)
+		for _, v := range sylf.SynchronizedTexts {
+			bw.EncodeAndWriteText(v.Text, sylf.Encoding)
+			bw.Write(sylf.Encoding.TerminationBytes)
+			bw.Write(v.uintToBytes())
+		}
+	})
+}
+
+func parseSynchronisedLyricsFrame(br *bufReader) (Framer, error) {
+	encoding := getEncoding(br.ReadByte())
+	language := br.Next(3)
+	timestampFormat := br.ReadByte()
+	contentType := br.ReadByte()
+	contentDescriptor := br.ReadText(encoding)
+
+	if br.Err() != nil {
+		return nil, br.Err()
+	}
+
+	var s []SyncedText
+	for {
+		textLyric, err := br.readTillDelims(encoding.TerminationBytes)
+		if err != nil {
+			break
+		}
+		t := SyncedText{Text: decodeText(textLyric, encoding)}
+		br.Next(len(encoding.TerminationBytes))
+		timeStamp := br.Next(4)
+		timeStampUint := bytesToInt(timeStamp)
+		t.Timestamp = timeStampUint
+		s = append(s, t)
+	}
+	sylf := SynchronisedLyricsFrame{
+		Encoding:          encoding,
+		Language:          string(language),
+		TimestampFormat:   timestampFormat,
+		ContentType:       contentType,
+		ContentDescriptor: decodeText(contentDescriptor, encoding),
+		SynchronizedTexts: s,
+	}
+
+	return sylf, nil
+}

tag.go

@@ -68,6 +68,12 @@ func (tag *Tag) AddUnsynchronisedLyricsFrame(uslf UnsynchronisedLyricsFrame) {
 	tag.AddFrame(tag.CommonID("Unsynchronised lyrics/text transcription"), uslf)
 }
 
+// AddSynchronisedLyricsFrame adds the unsynchronised lyrics/text frame
+// to tag.
+func (tag *Tag) AddSynchronisedLyricsFrame(sylf SynchronisedLyricsFrame) {
+	tag.AddFrame(tag.CommonID("Synchronised lyrics/text"), sylf)
+}
+
 // AddUserDefinedTextFrame adds the custom frame (TXXX) to tag.
 func (tag *Tag) AddUserDefinedTextFrame(udtf UserDefinedTextFrame) {
 	tag.AddFrame(tag.CommonID("User defined text information frame"), udtf)