Skip to content
🎵 ID3 parsing and writing library for Go
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
testdata Delete e field from xencodingWrapper May 17, 2018
.gitignore
.travis.yml
LICENSE First commit! May 15, 2016
README.md
bench_test.go
buf_reader.go
buf_reader_test.go
buf_writer.go Fix parsing and writing synchunsafe sizes, that are used in id3v2.3 Aug 15, 2018
comment_frame.go
common_ids.go Expose Tag's default encoding, add AddTextFrame method Sep 27, 2018
encoding.go
encoding_test.go Use own bufWriter Apr 7, 2018
example_test.go
framer.go
header.go
header_test.go
id3v2.go Add encoding conversion support Aug 24, 2017
options.go Add id3v2.Options May 1, 2017
parse.go
parse_test.go Make small improvements Aug 25, 2018
picture_frame.go
pools.go Fix getByteSlice Apr 7, 2018
sequence.go
sequence_test.go
size.go Fix parsing and writing synchunsafe sizes, that are used in id3v2.3 Aug 15, 2018
size_test.go Add more tests Aug 15, 2018
tag.go Shorten Add*Frame funcs Sep 27, 2018
tag_test.go Make small refactoring Aug 25, 2018
text_frame.go
ufid_frame.go Add convenient ReadText func Aug 25, 2018
unknown_frame.go
unsynchronised_lyrics_frame.go
user_defined_text_frame.go

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

You can’t perform that action at this time.