-
Notifications
You must be signed in to change notification settings - Fork 11
/
sound.go
257 lines (234 loc) · 6.68 KB
/
sound.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
// Copyright 2021 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package sound
import (
"bytes"
"encoding/json"
"errors"
"fmt"
"io"
"io/ioutil"
"os"
"sort"
"strings"
"time"
"github.com/hajimehoshi/ebiten/v2/audio"
"github.com/hajimehoshi/ebiten/v2/audio/vorbis"
"github.com/divVerent/aaaaxy/internal/audiowrap"
"github.com/divVerent/aaaaxy/internal/dontgc"
"github.com/divVerent/aaaaxy/internal/flag"
"github.com/divVerent/aaaaxy/internal/go117"
"github.com/divVerent/aaaaxy/internal/log"
"github.com/divVerent/aaaaxy/internal/splash"
"github.com/divVerent/aaaaxy/internal/vfs"
)
var (
precacheSounds = flag.Bool("precache_sounds", true, "preload all sounds at startup (VERY recommended)")
soundVolume = flag.Float64("sound_volume", 0.5, "sound volume (0..1)")
)
const (
bytesPerSample = 4
)
// Sound represents a sound effect.
type Sound struct {
sound []byte
groupedPlayer *audiowrap.Player
groupedCount int
volumeAdjust float64
loopStart, loopEnd int64
}
// Sounds are preloaded as byte streams.
var (
cache = map[string]*Sound{}
cacheFrozen bool
)
type soundJson struct {
VolumeAdjust float64 `json:"volume_adjust"`
LoopStart int64 `json:"loop_start"`
LoopEnd int64 `json:"loop_end"`
}
// Load loads a sound effect.
// Multiple Load calls to the same sound effect return the same cached instance.
func Load(name string) (*Sound, error) {
cacheName := vfs.Canonical("sounds", name)
if sound, found := cache[cacheName]; found {
return sound, nil
}
if cacheFrozen {
return nil, fmt.Errorf("sound %v was not precached", name)
}
data, err := vfs.Load("sounds", name)
if err != nil {
return nil, fmt.Errorf("could not load: %v", err)
}
defer data.Close()
stream, err := vorbis.DecodeWithSampleRate(audiowrap.SampleRate(), data)
if err != nil {
return nil, fmt.Errorf("could not start decoding: %v", err)
}
decoded, err := ioutil.ReadAll(stream)
if err != nil {
return nil, fmt.Errorf("could not decode: %v", err)
}
config := soundJson{
VolumeAdjust: 1,
LoopStart: -1,
LoopEnd: -1,
}
j, err := vfs.Load("sounds", name+".json")
if err != nil && !errors.Is(err, os.ErrNotExist) {
return nil, fmt.Errorf("could not load sound json config file for %q: %v", name, err)
}
if j != nil {
defer j.Close()
err = json.NewDecoder(j).Decode(&config)
if err != nil {
return nil, fmt.Errorf("could not decode sound json config file for %q: %v", name, err)
}
}
sound := &Sound{
sound: decoded,
volumeAdjust: config.VolumeAdjust,
loopStart: config.LoopStart,
loopEnd: config.LoopEnd,
}
cache[cacheName] = sound
return sound, nil
}
// PlayAtVolume plays the given sound effect at the given volume.
func (s *Sound) PlayAtVolume(vol float64) *audiowrap.Player {
var player *audiowrap.Player
var err error
if s.loopStart >= 0 {
player, err = audiowrap.NewPlayer(func() (io.ReadCloser, error) {
loopEnd := s.loopEnd * bytesPerSample
if loopEnd < 0 {
loopEnd = int64(len(s.sound))
}
return go117.NopCloser(audio.NewInfiniteLoopWithIntro(bytes.NewReader(s.sound), s.loopStart*bytesPerSample, loopEnd)), nil
})
} else {
player, err = audiowrap.NewPlayerFromBytes(s.sound)
}
if err != nil {
// No need for fatal - we just play no sound then.
log.Errorf("UNREACHABLE CODE: could not spawn new sound using an always-succeed function: %v", err)
return audiowrap.NoPlayer()
}
player.SetVolume(s.volumeAdjust * *soundVolume * vol)
player.Play()
return player
}
// Play plays the given sound effect.
func (s *Sound) Play() *audiowrap.Player {
return s.PlayAtVolume(1.0)
}
// DurationNotForGameplay returns how long a sound takes. As this may depend on hardware, do not use this for gameplay.
func (s *Sound) DurationNotForGameplay() time.Duration {
if s.loopStart >= 0 {
return -1
}
samples := len(s.sound) / bytesPerSample
return time.Duration(samples) * time.Second / time.Duration(audiowrap.SampleRate())
}
type GroupedSound struct {
s *Sound
playing bool
dontGCState dontgc.State
}
// PlayGrouped starts the given sound effect in a grouped fashion.
func (s *Sound) Grouped() *GroupedSound {
g := &GroupedSound{
s: s,
}
g.dontGCState = dontgc.SetUp(g)
return g
}
// CheckGC checks if GC is currently allowed. Grouped sounds may be GC'd only while not playing.
func (g *GroupedSound) CheckGC() dontgc.State {
if !g.playing {
return nil
}
g.Close()
return g.dontGCState
}
// Play starts a grouped sound.
func (g *GroupedSound) Play() {
if g.playing {
return
}
g.playing = true
if g.s.groupedCount == 0 {
g.s.groupedPlayer = g.s.Play()
}
g.s.groupedCount++
}
// Close stops a grouped sound.
func (g *GroupedSound) Close() {
if !g.playing {
return
}
g.playing = false
g.s.groupedCount--
if g.s.groupedCount == 0 {
g.s.groupedPlayer.Close()
g.s.groupedPlayer = nil
}
}
// Reset restarts a grouped sound.
func (g *GroupedSound) Reset() {
if !g.playing {
return
}
g.s.groupedPlayer.Close()
g.s.groupedPlayer = g.s.Play()
}
// CurrentNotForGameplay returns the current playback position. As this may depend on hardware, do not use this for gameplay.
func (g *GroupedSound) CurrentNotForGameplay() time.Duration {
return g.s.groupedPlayer.Current()
}
// IsPlayingNotForGameplay returns whether the sound is currently playing. As this may depend on hardware, do not use this for gameplay.
func (g *GroupedSound) IsPlayingNotForGameplay() bool {
return g.s.groupedPlayer.IsPlaying()
}
var (
soundsToPrecache []string
)
func Precache(s *splash.State) (splash.Status, error) {
if !*precacheSounds {
return splash.Continue, nil
}
status, err := s.Enter("enumerating sounds", "could not enumerate sounds", splash.Single(func() error {
var err error
soundsToPrecache, err = vfs.ReadDir("sounds")
sort.Strings(soundsToPrecache)
return err
}))
if status != splash.Continue {
return status, err
}
for _, name := range soundsToPrecache {
if !strings.HasSuffix(name, ".ogg") {
continue
}
status, err := s.Enter("precaching "+name, fmt.Sprintf("could not precache %v", name), splash.Single(func() error {
_, err := Load(name)
return err
}))
if status != splash.Continue {
return status, err
}
}
return splash.Continue, nil
}