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 Pattern
  • func DecodeFile(path string) (*Pattern, error)
  • func NewPattern() *Pattern
  • func (p Pattern) String() string
• type Quarter
  • func NewQuarter(steps []byte) (*Quarter, error)
  • func (q Quarter) String() string
• type Step
• type Track
  • func NewTrack() *Track
  • func (t Track) String() string

Types

type Pattern

type Pattern struct {
	Filename string
	Lenght   int64
	Version  string
	Tempo    float32
	Tracks   []Track
}

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

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 NewPattern

func NewPattern() *Pattern

NewPattern creates a new Pattern

func (Pattern) String

func (p Pattern) String() string

type Quarter

type Quarter struct {
	Steps []Step
}

Quarter is fourth of a Tack

func NewQuarter

func NewQuarter(steps []byte) (*Quarter, error)

NewQuarter creates a new Quarter

func (Quarter) String

func (q Quarter) String() string

type Step

type Step bool

Step is an internal renaming of the bool value

type Track

type Track struct {
	Number   uint8
	ID       uint8
	Name     string
	Quarters []Quarter
}

Track is the struct that represent a track of a Pattern

func NewTrack

func NewTrack() *Track

NewTrack creates a new Track

func (Track) String

func (t Track) String() string