freedb

README

Parse a freedb.org database dump.

Documentation

Overview

Package freedb can parse freedb.org dumps and insert into PostgreSQL.

Index

• Variables
• func ComposeUID(discID []uint8, shard uint8) []uint8
• func ShardPos(name string) (uint8, error)
• type Disc
  • func ParseDump(dump io.Reader, shard uint8) (*Disc, error)
  • func (d *Disc) AppendTitle(s string)
  • func (d *Disc) AppendTrack(s string, pos int) error
• type ShardErr
  • func (e *ShardErr) Error() string

Variables

var Shards = []string{
	"blues",
	"classical",
	"country",
	"data",
	"folk",
	"jazz",
	"misc",
	"newage",
	"reggae",
	"rock",
	"soundtrack",
}

These shard names are meaningless and vestigal, but are needed to disambiguate the freedb.org DISCID

Functions

func ComposeUID

func ComposeUID(discID []uint8, shard uint8) []uint8

ComposeUID concatenates the non-unique DISCID with the unique shard number to create an actually unique ID.

func ShardPos

func ShardPos(name string) (uint8, error)

ShardPos returns the shard position of a named shard as well as a ShardErr if the named shard does not exist.

Types

type Disc

type Disc struct {
	// IDs is a list of non-unique algorithmically-generated hashes identifying
	// a compact disc stored in hexadecimal.
	IDs [][]uint8

	// Shard is an 8 bit unsigned int that represents the position of the shard
	// in the Shards slice. These shards look like genre subdirectories, but
	// that meaning is vestigal. The subdirectories are used as generic shard
	// buckets to work around ID collisions.
	Shard uint8

	// Title is the combined artist name and release name of a compact disc.
	Title string

	// Genre is an optional field that represents the genre of music found
	// on a compact disc.
	Genre *string

	// Year is an optional field denoting the release year of a compact disc.
	Year *uint16

	// Offsets are the positions on a CD where tracks begin.
	Offsets []uint32

	// Duration of the compact disc, in seconds.
	Duration uint16

	// Tracks is a slice of strings representing the track titles on a compact
	// disc.
	Tracks []string
}

Disc represents the parsed output of a freeDB dump

func ParseDump

func ParseDump(dump io.Reader, shard uint8) (*Disc, error)

ParseDump reads a freedb dump file, parses it, converts strings to UTF8, and returns the parsed data into a *freedb.Disc.

func (*Disc) AppendTitle

func (d *Disc) AppendTitle(s string)

AppendTitle appends to the string that represents the compact disc title, ensuring that the string is valid UTF8.

func (*Disc) AppendTrack

func (d *Disc) AppendTrack(s string, pos int) error

AppendTrack appends to the track title in the given slice position, ensuring that the string is valid UTF8.

type ShardErr

type ShardErr struct {
	// contains filtered or unexported fields
}

ShardErr is the response to an unknown shard name.

func (*ShardErr) Error

func (e *ShardErr) Error() string

Error provides an error string for the ShardErr type.