🎵 ID3 parsing and writing library for Go https://godoc.org/github.com/bogem/id3v2

eternal-flame-AD a4e250fe50 add frame overflow check 2 months ago
testdata e3d3f57933 Delete e field from xencodingWrapper 7 months ago
.gitignore 5f2eaf0402 Add .gitignore 7 months ago
.travis.yml 040fcd0b4d Add 32bit support 1 year ago
LICENSE 5aa0629ea3 First commit! 2 years ago
README.md b22a460240 Update README.md 3 months ago
bench_test.go 6a143b684c Take off UDTF and UFID frames from benchmarks 3 months ago
buf_reader.go 08cf71b213 Add convenient ReadText func 3 months ago
buf_reader_test.go 08cf71b213 Add convenient ReadText func 3 months ago
buf_writer.go 3845103da5 Fix parsing and writing synchunsafe sizes, that are used in id3v2.3 4 months ago
comment_frame.go 62f1d3d12b Delete encodingKey variable in parse* funcs 3 months ago
common_ids.go 7e43476360 Expose Tag's default encoding, add AddTextFrame method 2 months ago
encoding.go e3d3f57933 Delete e field from xencodingWrapper 7 months ago
encoding_test.go 8190b64040 Use own bufWriter 8 months ago
example_test.go bae247a045 Rename encodings 1 year ago
framer.go 4ecb8426d0 Prevent checking error from bufio.Write 1 year ago
header.go 5785be9ad4 Tag header size should always be synchsafe 4 months ago
header_test.go 8190b64040 Use own bufWriter 8 months ago
id3v2.go 1283c51623 Add encoding conversion support 1 year ago
options.go 0735adcee6 Add id3v2.Options 1 year ago
parse.go a4e250fe50 add frame overflow check 1 month ago
parse_test.go 44c4f41222 Make small improvements 3 months ago
picture_frame.go 62f1d3d12b Delete encodingKey variable in parse* funcs 3 months ago
pools.go e4247ea7ec Fix getByteSlice 8 months ago
sequence.go 2dc90affa4 Make TXXX to be in sequences 3 months ago
sequence_test.go 04f5b9b8b3 Add sequencePool 1 year ago
size.go 3845103da5 Fix parsing and writing synchunsafe sizes, that are used in id3v2.3 4 months ago
size_test.go 5da9331ad6 Add more tests 4 months ago
tag.go c8c2e7f95f Shorten Add*Frame funcs 2 months ago
tag_test.go 3c6010be98 Make small refactoring 3 months ago
text_frame.go 62f1d3d12b Delete encodingKey variable in parse* funcs 3 months ago
ufid_frame.go 08cf71b213 Add convenient ReadText func 3 months ago
unknown_frame.go 5d6e6a88cf Use bufReader 8 months ago
unsynchronised_lyrics_frame.go 62f1d3d12b Delete encodingKey variable in parse* funcs 3 months ago
user_defined_text_frame.go 62f1d3d12b Delete encodingKey variable in parse* funcs 3 months ago

README.md

id3v2 GoDoc Build Status

Fast, simple and powerful ID3 parsing and writing library for Go, based only on standard library.

id3v2 can:

  • ✅ support of ID3v2.3 and ID3v2.4 tags;
  • ✅ parse and write tags;
  • ✅ work with all available encodings;
  • ✅ set and read all text frames, unsynchronised lyrics/text (USLT), comments, attached pictures, UFID and TXXX frames;
  • ✅ set and read frames, that can be used multiple times in tag;
  • ✅ be used in multiple goroutines.

id3v2 can't:

  • ❌ work with unsynchronization, extended header, flags, padding, footer.

If you want some functionality, that library can't do, or you have some questions, just write an issue. And of course, pull requests are welcome!

Installation

go get -u github.com/bogem/id3v2

Example of usage

package main

import (
	"fmt"
	"log"

	"github.com/bogem/id3v2"
)

func main() {
	// Open file and parse tag in it.
	tag, err := id3v2.Open("file.mp3", id3v2.Options{Parse: true})
	if err != nil {
 		log.Fatal("Error while opening mp3 file: ", err)
 	}
	defer tag.Close()

	// Read frames.
	fmt.Println(tag.Artist())
	fmt.Println(tag.Title())

	// Set simple text frames.
	tag.SetArtist("New artist")
	tag.SetTitle("New title")

	// Set comment frame.
	comment := id3v2.CommentFrame{
		Encoding:    id3v2.EncodingUTF8,
		Language:    "eng",
		Description: "My opinion",
		Text:        "Very good song",
	}
	tag.AddCommentFrame(comment)

	// Write it to file.
	if err = tag.Save(); err != nil {
		log.Fatal("Error while saving a tag: ", err)
	}
}

Read multiple frames

pictures := tag.GetFrames(tag.CommonID("Attached picture"))
for _, f := range pictures {
	pic, ok := f.(id3v2.PictureFrame)
	if !ok {
		log.Fatal("Couldn't assert picture frame")
	}

	// Do something with picture frame.
	// For example, print the description:
	fmt.Println(pic.Description)
}

Options

// Options influence on processing the tag.
type Options struct {
	// Parse defines, if tag will be parsed.
	Parse bool

	// ParseFrames defines, that frames do you only want to parse. For example,
	// `ParseFrames: []string{"Artist", "Title"}` will only parse artist
	// and title frames. You can specify IDs ("TPE1", "TIT2") as well as
	// descriptions ("Artist", "Title"). If ParseFrame is blank or nil,
	// id3v2 will parse all frames in tag. It works only if Parse is true.
	//
	// It's very useful for performance, so for example
	// if you want to get only some text frames,
	// id3v2 will not parse huge picture or unknown frames.
	ParseFrames []string
}

Work with encodings

id3v2 can encode and decode text of avaialble encodings (ISO-8859-1, UTF-16 with BOM, UTF-16BE without BOM, UTF-8). Just set the desired encoding in Encoding field of frame and set UTF-8 encoded text to corresponding text fields.

For example, if you set comment frame with custom encoding and write it:

tag := id3v2.NewEmptyTag()
comment := id3v2.CommentFrame{
	Encoding:    id3v2.EncodingUTF16,
	Language:    "ger",
	Description: "Tier",
	Text:        "Der Löwe",
}
tag.AddCommentFrame(comment)

_, err := tag.WriteTo(w)
if err != nil {
	log.Fatal(err)
}

Text field will be automatically encoded with UTF-16BE with BOM and written to w.

By default, if version of tag is 4 then UTF-8 is used for methods like SetArtist, SetTitle, SetGenre and etc, otherwise ISO-8859-1.

Benchmarks

See benchmarks in the description of last release.

Reference

https://godoc.org/github.com/bogem/id3v2