README
¶
Developing Beatboxer Programs
This document describes development of "programs" for the Beatboxer.
Quick Start
From the root of this repo:
go run cmd/beatboxer_noleds.go
Optional web renderer:
open http://localhost:8080
The Beatboxer's 16x4 grid of buttons is emulated via your keyboard. The first 8x4 keys are bound to:
1..8q..ia..kz..,
The shift key modifies the above to act on the second set of 8x4 keys.
Note all indexes in code are 0-based. Button 0x0 is 1, 15x3 is shift + ,.
Pressing button 15x1 (shift + i) 5 times will switch programs.
Adding a Program
-
Add a new file under
programs -
Implement the
Programinterface, as defined inprogram.go. This interface supports the following:- Input
New: initialize state, kicks off long-running processes, returns new handleAmplitude: receive amplitude, [0..1]Keyboard: receive button pressesClose: stops all processes, frees resources
- Output
Play: play audio filesRender: render LEDsYield: yield back to the harness
- Input
-
Add your new module to
../cmd/beatboxer_noleds.go.
TODO
- update LED rendering code for harness environment
- consider buffered channels, drop when channels fills
Documentation
¶
Index ¶
Constants ¶
View Source
const ( MIN_MAX_VOL = 0.1 SMOOTHING_FAST = 0.9 SMOOTHING_SLOW = 0.99 )
View Source
const (
SWITCH_COUNT = 5
)
Variables ¶
View Source
var (
MAX_SMOOTHING = math.Pow(0.999, 1.0/100)
)
Functions ¶
This section is empty.
Types ¶
type Amplitude ¶
type Amplitude struct {
// contains filtered or unexported fields
}
func InitAmplitude ¶
func InitAmplitude() *Amplitude
type Program ¶
type Program interface {
New(wavDurs map[string]time.Duration) Program
// input
Amplitude() chan<- float64
Keyboard() chan<- bbox.Coord
Close() chan<- struct{}
// output
Play() <-chan string
Render() <-chan render.State
Yield() <-chan struct{}
}
Program defines the interface all Beatboxer programs must satisfy
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.