Cleanup (#12)

* use build tag listen for tests involving listening

test infrastructure for listening isn't automatable by
definition.

this commit places sound/gen/gen_test under build tag
listen, because it generates wavs for listening.

This also cleans up some modules madness where somehow
sound ended up indirectly depending on an earlier version of itself
due to the fact that codec module depends on sound.

* ChannelAlignmentError -> ErrChannelAlignment

Author: wsc1

Diff for: cae.go

@@ -5,7 +5,7 @@ package sound
 
 import "errors"
 
-// ChannelAlignmentError is returned by sources and sinks
+// ErrChannelAlignment is returned by sources and sinks
 // when the input/output slices aren't sized correctly
 // with respect to the number of channels
 // in the sink/source.  More concretely this error is returned
@@ -17,4 +17,4 @@ import "errors"
 //
 // Because the buffers d don't contain a number of samples representing
 // one sample for all channels for all represented points in time.
-var ChannelAlignmentError = errors.New("Channels misaligned")
+var ErrChannelAlignment = errors.New("Channels misaligned")

Diff for: cil/t.go

@@ -66,7 +66,7 @@ func (t *T) Len() int {
 // for each channel.
 //
 // If len(raw) is not a multiple of the number of channels expected by t
-// (specified in the constructor), then Inter returns sound.ChannelAlignmentError.
+// (specified in the constructor), then Inter returns sound.ErrChannelAlignment
 //
 // raw's frame count may differ from that given in the constructor.
 //
@@ -76,7 +76,7 @@ func (t *T) Inter(raw []float64) error {
 	}
 	N := len(raw)
 	if N%t.c != 0 {
-		return sound.ChannelAlignmentError
+		return sound.ErrChannelAlignment
 	}
 	orgF := t.f
 	defer t.SetFrames(orgF)
@@ -107,15 +107,15 @@ func (t *T) Inter(raw []float64) error {
 //
 // raw's frame count may differ from that given in t's constructor.
 //
-// Deinter returns a sound.ChannelAlignmentError if len(raw)%nC != 0
+// Deinter returns a sound.ErrChannelAlignment if len(raw)%nC != 0
 // where nC is the number of channels given in the constructor.
 func (t *T) Deinter(raw []float64) error {
 	if t.c == 1 {
 		return nil
 	}
 	N := len(raw)
 	if N%t.c != 0 {
-		return sound.ChannelAlignmentError
+		return sound.ErrChannelAlignment
 	}
 	orgF := t.f
 	defer t.SetFrames(orgF)

Diff for: duplex.go

@@ -16,11 +16,11 @@ type Duplex interface {
 	// SendReceive on a duplex connection will play out
 	// and capture to in.
 	//
-	// SendReceive returns a ChannelAlignmentError if
+	// SendReceive returns a ErrChannelAlignment if
 	// len(in) is not a multiple of InChannels() and also
 	// if len(out) is not a multiple of OutChannels().
 	//
-	// SendReceive returns a FrameAlignmentError if
+	// SendReceive returns a ErrFrameAlignment if
 	// the number of frames in out is not equal to the number
 	// of frames in in.
 	//
@@ -34,4 +34,4 @@ type Duplex interface {
 }
 
 // See Duplex.SendReceive
-var FrameAlignmentError = errors.New("duplex frames misaligned.")
+var ErrFrameAlignment = errors.New("duplex frames misaligned.")

Diff for: gen/gen_test.go

@@ -1,6 +1,13 @@
 // Copyright 2018 The ZikiChombo Authors. All rights reserved.  Use of this source
 // code is governed by a license that can be found in the License file.
 
+// +build listen
+
+// this package introduces a dependency on the codec module, which
+// makes things confusing.  It also doesn't really test anything
+// but rather just creates wav files for listening tests.
+//
+// so we've made it ignored by default with the build tag "listen".
 package gen_test
 
 import (
@@ -18,7 +25,6 @@ func TestNote(t *testing.T) {
 	if e := wav.Save(a, "a3.wav"); e != nil {
 		t.Fatal(e)
 	}
-
 }
 
 func TestNotes(t *testing.T) {

Diff for: ops/add.go

@@ -60,7 +60,7 @@ func (a *sAdd) Receive(dst []float64) (int, error) {
 			frms = n
 		}
 		if frms != n {
-			return 0, sound.ChannelAlignmentError
+			return 0, sound.ErrChannelAlignment
 		}
 		for i := 0; i < nC*frms; i++ {
 			dst[i] += a.buf[i]
@@ -114,7 +114,7 @@ func (m *sMul) Receive(dst []float64) (int, error) {
 			frms = n
 		}
 		if frms != n {
-			return 0, sound.ChannelAlignmentError
+			return 0, sound.ErrChannelAlignment
 		}
 		for i := 0; i < nC*frms; i++ {
 			dst[i] *= m.buf[i]

Diff for: ops/dec.go

@@ -49,7 +49,7 @@ func (d *decimate) wFrames(f int) int {
 func (d *decimate) Receive(dst []float64) (int, error) {
 	nC := d.Channels()
 	if len(dst)%nC != 0 {
-		return 0, sound.ChannelAlignmentError
+		return 0, sound.ErrChannelAlignment
 	}
 	nF := len(dst) / nC
 	rF := d.rFrames(nF)

Diff for: ops/env.go

@@ -82,7 +82,7 @@ type eSrc struct {
 func (e *eSrc) Receive(dst []float64) (int, error) {
 	nC := e.Source.Channels()
 	if len(dst)%nC != 0 {
-		return 0, sound.ChannelAlignmentError
+		return 0, sound.ErrChannelAlignment
 	}
 	n, err := e.Source.Receive(dst)
 	if err != nil {

Diff for: ops/join.go

@@ -25,7 +25,7 @@ func (j *join) Channels() int {
 
 func (j *join) Receive(dst []float64) (int, error) {
 	if len(dst)%len(j.srcs) != 0 {
-		return 0, sound.ChannelAlignmentError
+		return 0, sound.ErrChannelAlignment
 	}
 	n := len(dst) / len(j.srcs)
 	nf := -1

Diff for: ops/loop.go

@@ -19,7 +19,7 @@ type loop struct {
 func (l *loop) Receive(dst []float64) (int, error) {
 	nC := l.Channels()
 	if len(dst)%nC != 0 {
-		return 0, sound.ChannelAlignmentError
+		return 0, sound.ErrChannelAlignment
 	}
 	if l.n == 0 {
 		return 0, io.EOF

Diff for: ops/up.go

@@ -18,7 +18,7 @@ type up struct {
 func (u *up) Receive(dst []float64) (int, error) {
 	nC := u.Channels()
 	if len(dst)%nC != 0 {
-		return 0, sound.ChannelAlignmentError
+		return 0, sound.ErrChannelAlignment
 	}
 	nF := len(dst) / nC
 	rnF := (nF - u.i) / u.n

Diff for: pipe.go

@@ -38,7 +38,7 @@ type packet struct {
 func (p *pipe) Send(d []float64) error {
 	nC := p.Channels()
 	if len(d)%nC != 0 {
-		return ChannelAlignmentError
+		return ErrChannelAlignment
 	}
 	trgFrms := len(d) / nC
 	pkt := &packet{sl: d}
@@ -70,7 +70,7 @@ func (p *pipe) Close() error {
 func (p *pipe) Receive(dst []float64) (int, error) {
 	nC := p.Channels()
 	if len(dst)%nC != 0 {
-		return 0, ChannelAlignmentError
+		return 0, ErrChannelAlignment
 	}
 	dPkt := &packet{sl: dst, n: 0}
 	inFrms := len(dst) / nC

Diff for: sink.go

@@ -14,7 +14,7 @@ type Sink interface {
 	//
 	// len(d) must be a multiple of the number of channels
 	// associated with the Sink, or Send will return a
-	// ChannelAlignmentError.
+	// ErrChannelAlignment.
 	//
 	// In case the Sink is multi-channel, d is interpreted in
 	// channel-deinterleaved format.

Diff for: sndbuf/buf.go

@@ -122,7 +122,7 @@ func (b *T) Channels() int {
 // data in dst.
 func (b *T) Receive(dst []float64) (int, error) {
 	if len(dst)%b.nchan != 0 {
-		return 0, sound.ChannelAlignmentError
+		return 0, sound.ErrChannelAlignment
 	}
 
 	n := len(dst)
@@ -154,7 +154,7 @@ func (b *T) Receive(dst []float64) (int, error) {
 // and placing it in the memory buffer.
 func (b *T) Send(d []float64) error {
 	if len(d)%b.nchan != 0 {
-		return sound.ChannelAlignmentError
+		return sound.ErrChannelAlignment
 	}
 
 	frms := len(d) / b.nchan

Diff for: source.go

@@ -19,7 +19,7 @@ type Source interface {
 	//
 	// Receive returns multi-channel data in de-interleaved format.
 	// If len(d) is not a multiple of Channels(), then Receive returns
-	// ChannelAlignmentError.  If Receive returns fewer than len(d)/Channels()
+	// ErrChannelAlignment.  If Receive returns fewer than len(d)/Channels()
 	// frames, then the deinterleaved data of n frames is arranged in
 	// the prefix d[:n*Channels()].
 	Receive(d []float64) (int, error)