Add audio.Sfx, audio.Pat and audio.Sync()

Author: elgopher

audio/audio.go

@@ -7,6 +7,8 @@
 // Sound effects and music can be changed using functions: SetSfx and SetMusic.
 package audio
 
+import "fmt"
+
 // Sfx starts playing sound effect with given sfxNo on specified channel.
 //
 // sfxNo is the number of sound effect to play (0-63). sfxNo=-1 stops
@@ -47,36 +49,6 @@ func GetStat() Stat {
 	return system.Stat()
 }
 
-// SetSfx updates the sound effect. sfxNo is 0-63. Updating sfx number which
-// is higher than 63 does not do anything.
-//
-// SoundEffect parameters are clamped when out of range.
-// For example, sfx note volume equal 8 will be silently clamped to 7.
-func SetSfx(sfxNo int, e SoundEffect) {
-	system.SetSfx(sfxNo, e)
-}
-
-// GetSfx returns sfx with given number. sfxNo is 0-63. Trying to get
-// sfx number higher than 63 will result in returning empty SoundEffect (zero-value).
-func GetSfx(sfxNo int) SoundEffect {
-	return system.GetSfx(sfxNo)
-}
-
-// SetMusic updates the music pattern. patternNo is 0-63. Updating pattern number which
-// is higher than 63 does not do anything.
-//
-// Pattern parameters are clamped when out of range.
-// For example, pattern sfx number equal 64 will be silently clamped to 63.
-func SetMusic(patternNo int, p Pattern) {
-	system.SetMusic(patternNo, p)
-}
-
-// GetMusic returns music pattern with given number. patterNo is 0-63. Trying to get
-// pattern number higher than 63 will result in returning empty Pattern (zero-value).
-func GetMusic(patterNo int) Pattern {
-	return system.GetMusic(patterNo)
-}
-
 // SaveAudio stores audio system state to byte slice. State is stored in binary form.
 // The format is described in Synthesizer.Save source code.
 func SaveAudio() ([]byte, error) {
@@ -122,6 +94,12 @@ type SoundEffect struct {
 	Buzz      bool // Not implemented yet.
 }
 
+func (s SoundEffect) String() string {
+	return fmt.Sprintf(
+		"{Speed:%d LoopStart:%d LoopStop:%d Detune:%d Reverb:%d Dampen:%d Noiz:%t Buzz:%t Notes:(%d)[%+v %+v %+v ...]}",
+		s.Speed, s.LoopStart, s.LoopStop, s.Detune, s.Reverb, s.Dampen, s.Noiz, s.Buzz, len(s.Notes), s.Notes[0], s.Notes[1], s.Notes[2])
+}
+
 func (s SoundEffect) noteAt(no int) Note {
 	var note Note
 	if no < len(s.Notes) {
@@ -278,9 +256,23 @@ type System interface {
 	Sfx(sfxNo int, channel Channel, offset, length int)
 	Music(patterNo int, fadeMs int, channelMask byte)
 	Stat() Stat
+	// SetSfx updates the sound effect. sfxNo is 0-63. Updating sfx number which
+	// is higher than 63 does not do anything.
+	//
+	// SoundEffect parameters are clamped when out of range.
+	// For example, sfx note volume equal 8 will be silently clamped to 7.
 	SetSfx(sfxNo int, e SoundEffect)
+	// GetSfx returns sfx with given number. sfxNo is 0-63. Trying to get
+	// sfx number higher than 63 will result in returning empty SoundEffect (zero-value).
 	GetSfx(sfxNo int) SoundEffect
+	// SetMusic updates the music pattern. patternNo is 0-63. Updating pattern number which
+	// is higher than 63 does not do anything.
+	//
+	// Pattern parameters are clamped when out of range.
+	// For example, pattern sfx number equal 64 will be silently clamped to 63.
 	SetMusic(patternNo int, _ Pattern)
+	// GetMusic returns music pattern with given number. patterNo is 0-63. Trying to get
+	// pattern number higher than 63 will result in returning empty Pattern (zero-value).
 	GetMusic(patterNo int) Pattern
 	Save() ([]byte, error)
 	Load([]byte) error

audio/memory.go

@@ -0,0 +1,18 @@
+// (c) 2022-2023 Jacek Olszak
+// This code is licensed under MIT license (see LICENSE for details)
+
+package audio
+
+var (
+	SFX [64]SoundEffect
+	Pat [64]Pattern
+)
+
+func Sync() {
+	for i, sfx := range SFX {
+		system.SetSfx(i, sfx)
+	}
+	for i, pattern := range Pat {
+		system.SetMusic(i, pattern)
+	}
+}

devtools/internal/lib/github_com-elgopher-pi-audio.go

@@ -5,7 +5,7 @@ package devtools
 
 import (
 	"fmt"
-
+	"github.com/elgopher/pi/audio"
 	"github.com/elgopher/pi/devtools/internal/help"
 	"github.com/elgopher/pi/devtools/internal/interpreter"
 	"github.com/elgopher/pi/devtools/internal/snapshot"
@@ -67,6 +67,7 @@ func evaluateNextCommandFromTerminal() {
 
 		switch result {
 		case interpreter.GoCodeExecuted:
+			audio.Sync() // Quality Of Live
 			snapshot.Take()
 		case interpreter.Resumed:
 			resumeGame()

devtools/scripting.go

@@ -7,44 +7,43 @@ import (
 )
 
 func main() {
-	sfx := audio.SoundEffect{
-		Notes: [32]audio.Note{
-			{
-				Pitch:      audio.PitchG3,
-				Instrument: audio.InstrumentNoise,
-				Volume:     7,
-			},
-		},
-		Speed: 255,
+	audio.SFX[0].Notes[0] = audio.Note{
+		Pitch:      audio.PitchG3,
+		Instrument: audio.InstrumentNoise,
+		Volume:     7,
 	}
-	audio.SetSfx(0, sfx)
+	audio.SFX[0].Speed = 255
+	audio.Sync()
+
+	sfxNote0 := &audio.SFX[0].Notes[0]
 
 	pi.Update = func() {
 		if pi.Btnp(pi.X) {
 			audio.Sfx(0, audio.Channel0, 0, 0)
 		}
 
-		if pi.Btnp(pi.Up) && sfx.Notes[0].Pitch < 255 {
-			sfx.Notes[0].Pitch += 1
-			audio.SetSfx(0, sfx)
-			audio.Sfx(0, audio.Channel0, 0, 0)
+		if pi.Btnp(pi.Up) && sfxNote0.Pitch < 255 {
+			sfxNote0.Pitch += 1
+			playSfx0()
 		}
-		if pi.Btnp(pi.Down) && sfx.Notes[0].Pitch > 0 {
-			sfx.Notes[0].Pitch -= 1
-			audio.SetSfx(0, sfx)
-			audio.Sfx(0, audio.Channel0, 0, 0)
+		if pi.Btnp(pi.Down) && sfxNote0.Pitch > 0 {
+			sfxNote0.Pitch -= 1
+			playSfx0()
 		}
-		if pi.Btnp(pi.Right) && sfx.Notes[0].Instrument < audio.InstrumentPhaser {
-			sfx.Notes[0].Instrument += 1
-			audio.SetSfx(0, sfx)
-			audio.Sfx(0, audio.Channel0, 0, 0)
+		if pi.Btnp(pi.Right) && sfxNote0.Instrument < audio.InstrumentPhaser {
+			sfxNote0.Instrument += 1
+			playSfx0()
 		}
-		if pi.Btnp(pi.Left) && sfx.Notes[0].Instrument > 0 {
-			sfx.Notes[0].Instrument -= 1
-			audio.SetSfx(0, sfx)
-			audio.Sfx(0, audio.Channel0, 0, 0)
+		if pi.Btnp(pi.Left) && sfxNote0.Instrument > 0 {
+			sfxNote0.Instrument -= 1
+			playSfx0()
 		}
 	}
 
 	ebitengine.MustRun()
 }
+
+func playSfx0() {
+	audio.Sync() // first send changed sfx to audio system
+	audio.Sfx(0, audio.Channel0, 0, 0)
+}