Replace audio.Sfx with audio.Play and audio.Stop

Author: elgopher

audio/audio.go

@@ -9,23 +9,37 @@ package audio
 
 import "fmt"
 
-// Sfx starts playing sound effect with given sfxNo on specified channel.
+// Play starts playing sound effect with given sfxNo on specified channel.
 //
-// sfxNo is the number of sound effect to play (0-63). sfxNo=-1 stops
-// playing sound on the given channel. sfxNo=-2 releases the sound
-// of the given channel from looping.
+// sfxNo is the number of sound effect to play (0-63).
 //
-// channel is the channel number from 0-3. Channel=-1 chooses available
-// channel automatically. Channel=-2 stops playing the given sound effect
-// on any channel. See pi.Channel.
+// channel is the channel number from 0-3. -1 chooses available
+// channel automatically.
 //
 // offset is the note position to start playing (0-31). Offset is clamped to [0,31].
 //
 // length is the number of notes to play. If length <= 0 and sfx has no loop
 // then entire sfx is played. If length < sfx length then only fraction of sfx is
 // played. If length <= 0 and sfx has loop then sfx is played infinitely.
-func Sfx(sfxNo int, channel Channel, offset, length int) {
-	system.Sfx(sfxNo, channel, offset, length)
+func Play(sfxNo int, channel, offset, length int) {
+	system.Play(sfxNo, channel, offset, length)
+}
+
+// Stop stops playing sound effect with given sfxNo. -1 stops all sounds.
+//
+// sfxNo is the number of sound effect to stop (0-63).
+func Stop(sfxNo int) {
+	system.Stop(sfxNo)
+}
+
+// channel is the channel number from 0-3. -1 stops loop on all channels.
+func StopLoop(channel int) {
+	system.StopLoop(channel)
+}
+
+// channel is the channel number from 0-3. -1 stops all channels.
+func StopChan(channel int) {
+	system.StopChan(channel)
 }
 
 // Music starts playing music with given patterNo.
@@ -63,17 +77,6 @@ func LoadAudio(b []byte) error {
 
 var system System = &Synthesizer{}
 
-type Channel int8
-
-const (
-	Channel0    Channel = 0
-	Channel1    Channel = 1
-	Channel2    Channel = 2
-	Channel3    Channel = 3
-	ChannelAny  Channel = -1 // Rename - it means all channels for Sfx(-2, ...)
-	ChannelStop Channel = -2
-)
-
 type Stat struct {
 	Sfx           [4]int // -1 means no sfx on channel
 	Note          [4]int // -1 means no sfx on channel. Not implemented yet.
@@ -253,7 +256,10 @@ func SetSystem(s System) {
 }
 
 type System interface {
-	Sfx(sfxNo int, channel Channel, offset, length int)
+	Play(sfxNo, channel, offset, length int)
+	Stop(sfxNo int)
+	StopChan(channel int)
+	StopLoop(channel int)
 	Music(patterNo int, fadeMs int, channelMask byte)
 	Stat() Stat
 	// SetSfx updates the sound effect. sfxNo is 0-63. Updating sfx number which

audio/synth.go

@@ -93,21 +93,21 @@ func (c *channel) moveToNextNote(sfx SoundEffect) {
 	c.oscillator.FreqHz = pitchToFreq(note.Pitch)
 }
 
-func (s *Synthesizer) Sfx(sfxNo int, ch Channel, offset, length int) {
+func (s *Synthesizer) Play(sfxNo, ch, offset, length int) {
 	if sfxNo == -2 {
 		s.disableLooping(ch)
 		return
 	}
 
-	if ch >= ChannelStop && ch <= Channel3 {
-		s.stopSfx(sfxNo)
+	if ch >= -2 && ch <= 3 {
+		s.Stop(sfxNo)
 	}
 
-	if ch == ChannelAny {
+	if ch == -1 {
 		ch = s.findAvailableChannel()
 	}
 
-	if ch < Channel0 || ch > Channel3 {
+	if ch < 0 || ch > 3 {
 		return
 	}
 
@@ -135,37 +135,70 @@ func (s *Synthesizer) Sfx(sfxNo int, ch Channel, offset, length int) {
 	s.channels[ch].oscillator.FreqHz = pitchToFreq(note0.Pitch)
 }
 
-func (s *Synthesizer) disableLooping(ch Channel) {
-	if ch == ChannelAny || ch == ChannelStop {
+func (s *Synthesizer) Stop(sfxNo int) {
+	if sfxNo == -1 {
+		for i, c := range s.channels {
+			c.playing = false
+			s.channels[i] = c
+		}
+		return
+	}
+
+	for i, c := range s.channels {
+		if c.playing && c.sfxNo == sfxNo {
+			c.playing = false
+			s.channels[i] = c
+			return
+		}
+	}
+}
+
+func (s *Synthesizer) StopChan(channel int) {
+	if channel == -1 {
+		s.Stop(-1)
+		return
+	}
+	if channel < 0 || channel > 3 {
+		return
+	}
+
+	s.channels[channel].playing = false
+}
+
+func (s *Synthesizer) StopLoop(channel int) {
+	if channel == -1 {
 		for i := range s.channels {
 			s.channels[i].loopingDisabled = true
 		}
 		return
 	}
 
-	if ch >= Channel0 && ch <= Channel3 {
-		s.channels[ch].loopingDisabled = true
+	if channel >= 0 && channel <= 3 {
+		s.channels[channel].loopingDisabled = true
 	}
 }
 
-func (s *Synthesizer) stopSfx(no int) {
-	for i, c := range s.channels {
-		if c.playing && c.sfxNo == no {
-			c.playing = false
-			s.channels[i] = c
-			return
+func (s *Synthesizer) disableLooping(ch int) {
+	if ch == -1 || ch == -2 {
+		for i := range s.channels {
+			s.channels[i].loopingDisabled = true
 		}
+		return
+	}
+
+	if ch >= 0 && ch <= 0 {
+		s.channels[ch].loopingDisabled = true
 	}
 }
 
-func (s *Synthesizer) findAvailableChannel() Channel {
+func (s *Synthesizer) findAvailableChannel() int {
 	for i, c := range s.channels {
 		if !c.playing {
-			return Channel(i)
+			return i
 		}
 	}
 
-	return Channel3
+	return 3
 }
 
 func (s *Synthesizer) Music(patterNo int, fadeMs int, channelMask byte) {