drum

Documentation

Overview

Package drum is supposed to implement the decoding of .splice drum machine files. See golang-challenge.com/go-challenge1/ for more information

Index

• type FormatError
  • func (e FormatError) Error() string
• type Pattern
  • func Decode(r io.Reader) (*Pattern, error)
  • func DecodeFile(path string) (*Pattern, error)
  • func (p *Pattern) String() string
• type Track
  • func (t *Track) String() string

Types

type FormatError

type FormatError string

A FormatError reports that the input is not a valid SPLICE data.

func (FormatError) Error

func (e FormatError) Error() string

type Pattern

type Pattern struct {
	Version [32]byte
	Tempo   float32
	Tracks  []Track
}

Pattern is the high level representation of the drum pattern contained in a .splice file.

func Decode

func Decode(r io.Reader) (*Pattern, error)

Decode extract the pattern from the io.Reader

func DecodeFile

func DecodeFile(path string) (*Pattern, error)

DecodeFile decodes the drum machine file found at the provided path and returns a pointer to a parsed pattern which is the entry point to the rest of the data.

func (*Pattern) String

func (p *Pattern) String() string

type Track

type Track struct {
	ID    uint32
	Name  []byte
	Steps [2]uint8
}

Track keeps the information of the specific drum track

func (*Track) String

func (t *Track) String() string