drum

Documentation

Overview

Package drum implements the decoding of .splice drum machine files. See http://golang-challenge.com/go-challenge1/ for more information

Index

• type Pattern
  • func DecodeFile(path string) (*Pattern, error)
  • func (p Pattern) String() string
• type Track
  • func (t Track) String() string

Types

type Pattern

type Pattern struct {
	Version string
	Tempo   float32 // speed of the playback, in bpm
	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 (Pattern) String

func (p Pattern) String() string

type Track

type Track struct {
	ID    uint8
	Name  string
	Steps [16]bool // if a step is true, it triggers a sound
}

Track represents the sound of an instrument.

func (Track) String

func (t Track) String() string