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 Decode(r io.Reader) (*Pattern, error)
  • func DecodeFile(path string) (*Pattern, error)
  • func (p Pattern) String() string
• type Track
  • func (t Track) String() string
• type TrackHeader

Types

type Pattern

type Pattern struct {
	Version string
	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 reads a drum machine file from r and returns a pointer to a parsed pattern which is the entry point to the rest of the data.

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 {
	Header TrackHeader
	Name   string
	Steps  [16]bool
}

A Track represents a sound.

func (Track) String

func (t Track) String() string

type TrackHeader

type TrackHeader struct {
	ID      uint32 // ID of the track.
	NameLen uint8  // Length (in bytes) of the track name.
}

A TrackHeader represents the header of a Track.