drum

Documentation

Overview

Package drum decodes .splice drum machine files.

Index

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

Constants

const (
	Rest = 0
	Beat = 1
)

Rest and Beat are possible values for steps of a track.

Types

type Pattern

type Pattern struct {
	HWVersion string  // readable string
	Tempo     float32 // beats per minute
	Tracks    []Track // variable number of tracks
}

Pattern represents a drum pattern of a .splice file.

func DecodeFile

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

DecodeFile decodes the drum machine file found at the given path and returns a parsed pattern.

Valid tracks following a valid header are returned without error.

An error is returned if the file header cannot be read or decoded.

If invalid track or non-track data is encountered decoding terminates and the pattern read so far is returned without error.

func (*Pattern) String

func (p *Pattern) String() string

String returns a multi-line human readable representation of a drum pattern.

type Track

type Track struct {
	ID    int32
	Name  string   // typically an instrument or sound name
	Steps [16]byte // use constants Rest and Beat
}

Track represents a single part or sound of a drum pattern.