update readme

Author: noriah

Makefile

@@ -1,30 +1,86 @@
-# terminal audio visualizer - tavis
+tavis
+===
 
 [![love][withlove]][noriah-dev]
 [![made-with-go][withgo]][go-dev]
 [![betamax-was-a-thing][betamax]][betawhat]
 
-tavis is a terminal audio visualizer for linux/unix/macOS/windows*.
-powered by go, it can pull from PortAudio, PulseAudio, FFmpeg.
+### terminal audio visualizer for linux/unix/macOS/windows*
+*windows needs work
 
-## tavis is in early development. expect things to change and break
+## early development - expect things to change and break
 
-run `tavis -h` for usage
+we are working on this project all the time. its a sort of time filler for us at this point. expect lots of additions and changes at random times.
 
-#### depends on
+## supported audio backends
+- PortAudio (linux/macOS/*windows**)
+- PulseAudio (parec/FFmpeg)
+- AVFoundation (FFmpeg)
+- ALSA (FFmpeg)
 
-- tcell
-- gonum
-- Optional:
-	- `CGO_ENABLED=1`
-		- portaudio-2.0
-		- fftw3
-	- ffmpeg (non-cgo fallback)
-		- avfoundation
-		- alsa
-		- pulse
-		- sndio
-	- parec (pulse only)
+## dependencies
+
+- go modules
+	- github.com/nsf/termbox-go
+	- github.com/urfave/cli/v2
+	- github.com/pkg/errors
+	- github.com/lawl/pulseaudio
+	- gonum.org/v1/gonum
+
+- c libraries (`CGO_ENABLED=1`)
+	- fftw (fftw3)
+	- portaudio (portaudio-2.0)
+
+- binaries (optional)
+	- ffmpeg
+	- parec
+
+## installation
+
+### with `go get`
+
+```sh
+# with cgo (fftw, portaudio)
+go get github.com/noriah/tavis
+# without cgo
+CGO_ENABLED=0 go get github.com/noriah/tavis
+```
+
+### with `git`
+
+```sh
+# get source
+git clone https://github.com/noriah/tavis.git
+
+# move to source
+cd tavis
+
+# build tavis
+go install
+# without cgo
+CGO_ENABLED=0 go install
+```
+
+## usage
+
+```sh
+NAME:
+   tavis - terminal audio visualizer
+
+USAGE:
+   tavis [global options] command [command options] [arguments...]
+
+COMMANDS:
+   list-backends
+   list-devices
+   help, h        Shows a list of commands or help for one command
+
+```
+
+- use `tavis list-backends` to show available backends
+- use `tavis -b {backend} list-devices` to show available devices
+- use `tavis -b {backend} -d {device}` to run - use the full device name
+- use `tavis -h` for information on several more customizations
 
 
 <!-- Links -->

README.md

@@ -8,6 +8,18 @@ import (
 	"github.com/noriah/tavis/fft"
 )
 
+// SpectrumType is the type of calculation we run
+type SpectrumType int
+
+// Spectrum calculation types
+const (
+	SpectrumLog SpectrumType = iota
+	SpectrumEqual
+
+	// SpectrumDefault is the default spectrum type
+	SpectrumDefault = SpectrumLog
+)
+
 // Spectrum is an audio spectrum in a buffer
 type Spectrum struct {
 	numBins      int          // number of bins we look at
@@ -35,18 +47,6 @@ type stream struct {
 	plan  *fft.Plan // fft plan
 }
 
-// SpectrumType is the type of calculation we run
-type SpectrumType int
-
-// Spectrum calculation types
-const (
-	SpectrumLog SpectrumType = iota
-	SpectrumEqual
-
-	// SpectrumDefault is the default spectrum type
-	SpectrumDefault = SpectrumLog
-)
-
 // Frequencies are the dividing frequencies
 var Frequencies = []float64{
 	// sub sub bass
@@ -163,7 +163,6 @@ func (sp *Spectrum) Process(win window.Function) {
 			case sp.bins[xB].floorFFT < bassCut:
 				pow *= math.Max(0.6, float64(xF)/fBassCut)
 
-			default:
 			}
 
 			mag *= sp.bins[xB].eqVal

dsp/spectrum.go

@@ -10,9 +10,6 @@ import (
 	"github.com/nsf/termbox-go"
 )
 
-// DrawType is the type
-type DrawType int
-
 // Constants
 const (
 
@@ -34,17 +31,6 @@ const (
 	// StyleCenter  = StyleDefault
 	StyleReverse = termbox.AttrReverse
 
-	// types
-
-	DrawMin DrawType = iota
-	DrawUp
-	DrawUpDown
-	DrawDown
-	DrawMax
-
-	// DrawDefault is the default draw type
-	DrawDefault = DrawUpDown
-
 	// NumRunes number of runes for sub step bars
 	NumRunes = 8
 
@@ -60,6 +46,21 @@ const (
 	ScalingResetDeviation = 1
 )
 
+// DrawType is the type
+type DrawType int
+
+// draw types
+const (
+	DrawMin DrawType = iota
+	DrawUp
+	DrawUpDown
+	DrawDown
+	DrawMax
+
+	// DrawDefault is the default draw type
+	DrawDefault = DrawUpDown
+)
+
 // Config is a Display Config Object
 type Config struct {
 	BarWidth   int

graphic/display.go

@@ -92,7 +92,6 @@ func main() {
 			&cli.IntFlag{
 				Name:        "channel-count",
 				Aliases:     []string{"c"},
-				Hidden:      true,
 				Value:       globalCfg.ChannelCount,
 				Destination: &globalCfg.ChannelCount,
 			},

main.go

@@ -61,6 +61,7 @@ func Run(cfg Config) error {
 
 	var endSig = make(chan os.Signal, 2)
 	signal.Notify(endSig, os.Interrupt)
+	signal.Notify(endSig, os.Kill)
 
 	// Root Context
 	var ctx, cancel = context.WithCancel(context.Background())
@@ -84,15 +85,6 @@ func Run(cfg Config) error {
 	defer audio.Stop()
 
 	for {
-		select {
-		case <-endSig:
-			return nil
-		case <-ctx.Done():
-			return nil
-		case <-timer.C:
-			timer.Reset(drawDelay)
-		}
-
 		if audio.ReadyRead() < cfg.SampleSize {
 			continue
 		}
@@ -107,6 +99,17 @@ func Run(cfg Config) error {
 
 		spectrum.Process(win)
 
-		display.Draw(barBuffers, cfg.ChannelCount, barCount)
+		if err := display.Draw(barBuffers, cfg.ChannelCount, barCount); err != nil {
+			return errors.Wrap(err, "graphic threw an error. this should not happen.")
+		}
+
+		select {
+		case <-endSig:
+			return nil
+		case <-ctx.Done():
+			return nil
+		case <-timer.C:
+			timer.Reset(drawDelay)
+		}
 	}
 }