ebiten/audio/audio.go

459 lines
12 KiB
Go
Raw Normal View History

2015-01-10 17:23:43 +01:00
// Copyright 2015 Hajime Hoshi
//
// 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.
2017-10-01 10:24:30 +02:00
// Package audio provides audio players.
2016-04-10 10:07:58 +02:00
//
2017-10-01 10:24:30 +02:00
// The stream format must be 16-bit little endian and 2 channels. The format is as follows:
// [data] = [sample 1] [sample 2] [sample 3] ...
// [sample *] = [channel 1] ...
// [channel *] = [byte 1] [byte 2] ...
2016-04-10 10:07:58 +02:00
//
2017-10-01 10:24:30 +02:00
// An audio context (audio.Context object) has a sample rate you can specify and all streams you want to play must have the same
// sample rate. However, decoders in e.g. audio/mp3 package adjust sample rate automatically,
2017-01-15 10:02:21 +01:00
// and you don't have to care about it as long as you use those decoders.
2016-04-10 10:07:58 +02:00
//
2017-10-01 10:24:30 +02:00
// An audio context can generate 'players' (audio.Player objects),
2016-04-10 10:07:58 +02:00
// and you can play sound by calling Play function of players.
// When multiple players play, mixing is automatically done.
// Note that too many players may cause distortion.
2017-07-13 19:26:41 +02:00
//
2017-10-01 10:24:30 +02:00
// For the simplest example to play sound, see wav package in the examples.
2015-01-23 15:04:56 +01:00
package audio
2015-01-10 17:23:43 +01:00
import (
2016-06-26 19:22:44 +02:00
"bytes"
"errors"
"fmt"
2016-02-10 18:04:23 +01:00
"io"
2016-03-28 17:06:37 +02:00
"runtime"
"sync"
2016-03-06 10:55:20 +01:00
"time"
"github.com/hajimehoshi/ebiten/v2/audio/internal/readerdriver"
"github.com/hajimehoshi/ebiten/v2/internal/hooks"
)
2016-03-12 20:48:13 +01:00
const (
channelNum = 2
bitDepthInBytes = 2
bytesPerSample = bitDepthInBytes * channelNum
2015-01-10 17:23:43 +01:00
)
2021-01-06 18:06:09 +01:00
type newPlayerImpler interface {
newPlayerImpl(context *Context, src io.Reader) (playerImpl, error)
}
2017-10-01 10:24:30 +02:00
// A Context represents a current state of audio.
2016-04-10 10:07:58 +02:00
//
2017-10-01 10:24:30 +02:00
// At most one Context object can exist in one process.
2016-09-26 16:08:34 +02:00
// This means only one constant sample rate is valid in your one application.
//
2017-11-30 17:38:47 +01:00
// For a typical usage example, see examples/wav/main.go.
2016-03-02 16:48:59 +01:00
type Context struct {
2021-01-06 18:06:09 +01:00
np newPlayerImpler
// inited represents whether the audio device is initialized and available or not.
// On Android, audio loop cannot be started unless JVM is accessible. After updating one frame, JVM should exist.
inited chan struct{}
initedOnce sync.Once
2017-12-23 16:23:57 +01:00
sampleRate int
err error
2018-10-13 15:41:37 +02:00
ready bool
readyOnce sync.Once
2021-01-06 16:59:13 +01:00
players map[playerImpl]struct{}
m sync.Mutex
semaphore chan struct{}
2016-03-02 16:48:59 +01:00
}
var (
theContext *Context
theContextLock sync.Mutex
)
2017-09-25 17:38:50 +02:00
// NewContext creates a new audio context with the given sample rate.
//
2017-10-01 10:24:30 +02:00
// The sample rate is also used for decoding MP3 with audio/mp3 package
// or other formats as the target sample rate.
2017-09-25 17:38:50 +02:00
//
// sampleRate should be 44100 or 48000.
// Other values might not work.
// For example, 22050 causes error on Safari when decoding MP3.
2017-04-04 18:12:02 +02:00
//
// NewContext panics when an audio context is already created.
func NewContext(sampleRate int) *Context {
theContextLock.Lock()
defer theContextLock.Unlock()
2021-01-06 17:30:03 +01:00
if theContext != nil {
2017-04-04 18:12:02 +02:00
panic("audio: context is already created")
}
var np newPlayerImpler
if readerdriver.IsAvailable() {
2021-02-28 15:47:57 +01:00
// 'Reader players' are players that implement io.Reader. This is the new way and
// not all the environments support reader players. Reader players can have enough
// buffers so that clicking noises can be avoided compared to writer players.
// Reder players will replace writer players in any platforms in the future.
np = newReaderPlayerFactory(sampleRate)
} else {
2021-02-28 15:47:57 +01:00
// 'Writer players' are players that implement io.Writer. This is the old way but
// all the environments support writer players. Writer players cannot have enough
// buffers and clicking noises are sometimes problematic (#1356, #1458).
np = newWriterPlayerFactory(sampleRate)
}
2016-04-15 17:52:07 +02:00
c := &Context{
sampleRate: sampleRate,
np: np,
2021-01-06 16:59:13 +01:00
players: map[playerImpl]struct{}{},
inited: make(chan struct{}),
semaphore: make(chan struct{}, 1),
2016-04-15 17:52:07 +02:00
}
theContext = c
2019-04-28 12:35:59 +02:00
h := getHook()
h.OnSuspendAudio(func() error {
c.semaphore <- struct{}{}
if s, ok := np.(interface{ suspend() error }); ok {
return s.suspend()
}
return nil
})
h.OnResumeAudio(func() error {
<-c.semaphore
if s, ok := np.(interface{ resume() error }); ok {
return s.resume()
}
return nil
})
2019-04-28 12:35:59 +02:00
h.AppendHookOnBeforeUpdate(func() error {
c.initedOnce.Do(func() {
close(c.inited)
})
var err error
theContextLock.Lock()
if theContext != nil {
theContext.m.Lock()
err = theContext.err
theContext.m.Unlock()
}
theContextLock.Unlock()
if err != nil {
return err
}
if err := c.gcPlayers(); err != nil {
return err
}
return nil
})
2017-07-13 18:38:22 +02:00
return c
2019-04-27 15:30:09 +02:00
}
// CurrentContext returns the current context or nil if there is no context.
func CurrentContext() *Context {
theContextLock.Lock()
c := theContext
theContextLock.Unlock()
return c
}
func (c *Context) hasError() bool {
c.m.Lock()
r := c.err != nil
c.m.Unlock()
return r
}
2019-04-28 13:31:20 +02:00
func (c *Context) setError(err error) {
// TODO: What if c.err already exists?
c.m.Lock()
c.err = err
c.m.Unlock()
}
func (c *Context) setReady() {
c.m.Lock()
c.ready = true
c.m.Unlock()
}
2021-01-06 16:59:13 +01:00
func (c *Context) addPlayer(p playerImpl) {
c.m.Lock()
defer c.m.Unlock()
c.players[p] = struct{}{}
// Check the source duplication
srcs := map[io.Reader]struct{}{}
for p := range c.players {
if _, ok := srcs[p.source()]; ok {
c.err = errors.New("audio: a same source is used by multiple Player")
return
}
srcs[p.source()] = struct{}{}
}
}
2021-01-06 16:59:13 +01:00
func (c *Context) removePlayer(p playerImpl) {
c.m.Lock()
delete(c.players, p)
c.m.Unlock()
}
func (c *Context) gcPlayers() error {
c.m.Lock()
defer c.m.Unlock()
// Now reader players cannot call removePlayers from themselves in the current implementation.
// Underlying playering can be the pause state after fishing its playing,
// but there is no way to notify this to readerPlayers so far.
// Instead, let's check the states proactively every frame.
for p := range c.players {
rp, ok := p.(*readerPlayer)
if !ok {
return nil
}
if err := rp.Err(); err != nil {
return err
}
if !rp.IsPlaying() {
delete(c.players, p)
}
}
return nil
}
2018-10-13 15:41:37 +02:00
// IsReady returns a boolean value indicating whether the audio is ready or not.
//
// On some browsers, user interaction like click or pressing keys is required to start audio.
func (c *Context) IsReady() bool {
c.m.Lock()
defer c.m.Unlock()
2018-10-13 15:41:37 +02:00
r := c.ready
if r {
return r
}
if len(c.players) != 0 {
return r
}
c.readyOnce.Do(func() {
// Create another goroutine since (*Player).Play can lock the context's mutex.
// TODO: Is this needed for reader players?
go func() {
// The audio context is never ready unless there is a player. This is
// problematic when a user tries to play audio after the context is ready.
// Play a dummy player to avoid the blocking (#969).
// Use a long enough buffer so that writing doesn't finish immediately (#970).
p := NewPlayerFromBytes(c, make([]byte, bufferSize()*2))
p.Play()
}()
})
2018-10-13 15:41:37 +02:00
return r
}
// SampleRate returns the sample rate.
func (c *Context) SampleRate() int {
2016-04-15 17:52:07 +02:00
return c.sampleRate
}
2021-01-06 17:30:03 +01:00
func (c *Context) acquireSemaphore() {
c.semaphore <- struct{}{}
}
func (c *Context) releaseSemaphore() {
<-c.semaphore
}
func (c *Context) waitUntilInited() {
<-c.inited
}
2016-04-04 19:24:54 +02:00
// Player is an audio player which has one stream.
2018-12-18 15:07:19 +01:00
//
// Even when all references to a Player object is gone,
// the object is not GCed until the player finishes playing.
// This means that if a Player plays an infinite stream,
// the object is never GCed unless Close is called.
2016-02-10 18:18:39 +01:00
type Player struct {
2021-01-06 16:59:13 +01:00
p playerImpl
}
type playerImpl interface {
io.Closer
Play()
IsPlaying() bool
Pause()
Volume() float64
SetVolume(volume float64)
Current() time.Duration
Rewind() error
Seek(offset time.Duration) error
source() io.Reader
2016-02-10 18:18:39 +01:00
}
2016-04-10 10:07:58 +02:00
// NewPlayer creates a new player with the given stream.
2015-01-24 07:48:48 +01:00
//
2016-04-10 10:07:58 +02:00
// src's format must be linear PCM (16bits little endian, 2 channel stereo)
2016-02-07 16:51:25 +01:00
// without a header (e.g. RIFF header).
2016-04-10 10:07:58 +02:00
// The sample rate must be same as that of the audio context.
2016-04-15 17:52:07 +02:00
//
// The player is seekable when src is io.Seeker.
// Attempt to seek the player that is not io.Seeker causes panic.
//
2017-10-01 10:24:30 +02:00
// Note that the given src can't be shared with other Player objects.
//
2017-10-01 10:24:30 +02:00
// NewPlayer tries to call Seek of src to get the current position.
// NewPlayer returns error when the Seek returns error.
2019-03-31 18:59:10 +02:00
//
// A Player doesn't close src even if src implements io.Closer.
// Closing the source is src owner's responsibility.
func NewPlayer(context *Context, src io.Reader) (*Player, error) {
2021-01-06 18:06:09 +01:00
pi, err := context.np.newPlayerImpl(context, src)
2021-01-06 16:59:13 +01:00
if err != nil {
return nil, err
2016-04-15 17:52:07 +02:00
}
2021-01-06 16:59:13 +01:00
p := &Player{pi}
runtime.SetFinalizer(p, (*Player).finalize)
2017-12-23 09:24:51 +01:00
2016-04-15 17:52:07 +02:00
return p, nil
2016-03-03 03:57:25 +01:00
}
2016-06-26 19:22:44 +02:00
// NewPlayerFromBytes creates a new player with the given bytes.
//
// As opposed to NewPlayer, you don't have to care if src is already used by another player or not.
// src can be shared by multiple players.
//
// The format of src should be same as noted at NewPlayer.
func NewPlayerFromBytes(context *Context, src []byte) *Player {
b := bytes.NewReader(src)
p, err := NewPlayer(context, b)
if err != nil {
// Errors should never happen.
2019-02-07 09:19:24 +01:00
panic(fmt.Sprintf("audio: %v at NewPlayerFromBytes", err))
}
return p
2016-06-26 19:22:44 +02:00
}
func (p *Player) finalize() {
runtime.SetFinalizer(p, nil)
if !p.IsPlaying() {
p.Close()
}
}
2017-10-01 10:24:30 +02:00
// Close closes the stream.
2016-04-15 17:52:07 +02:00
//
2020-10-07 16:43:33 +02:00
// When Close is called, the stream owned by the player is NOT closed,
// even if the stream implements io.Closer.
//
// Close returns error when the player is already closed.
2016-03-28 17:06:37 +02:00
func (p *Player) Close() error {
return p.p.Close()
}
2016-04-10 10:07:58 +02:00
// Play plays the stream.
func (p *Player) Play() {
p.p.Play()
2015-01-22 19:02:23 +01:00
}
2016-02-11 11:55:59 +01:00
2016-04-10 10:07:58 +02:00
// IsPlaying returns boolean indicating whether the player is playing.
2016-03-06 10:55:20 +01:00
func (p *Player) IsPlaying() bool {
return p.p.IsPlaying()
}
2016-04-10 10:07:58 +02:00
// Rewind rewinds the current position to the start.
2016-04-15 17:52:07 +02:00
//
// The passed source to NewPlayer must be io.Seeker, or Rewind panics.
//
2017-10-01 10:24:30 +02:00
// Rewind returns error when seeking the source stream returns error.
2016-03-06 10:55:20 +01:00
func (p *Player) Rewind() error {
return p.p.Rewind()
}
2016-04-10 10:07:58 +02:00
// Seek seeks the position with the given offset.
2016-04-15 17:52:07 +02:00
//
// The passed source to NewPlayer must be io.Seeker, or Seek panics.
//
2017-10-01 10:24:30 +02:00
// Seek returns error when seeking the source stream returns error.
2016-03-06 10:55:20 +01:00
func (p *Player) Seek(offset time.Duration) error {
return p.p.Seek(offset)
}
2016-04-10 10:07:58 +02:00
// Pause pauses the playing.
func (p *Player) Pause() {
p.p.Pause()
2016-02-11 11:55:59 +01:00
}
2016-03-06 10:55:20 +01:00
2019-05-01 19:11:35 +02:00
// Current returns the current position in time.
//
// As long as the player continues to play, Current's returning value is increased monotonically,
// even though the source stream loops and its position goes back.
2016-03-06 10:55:20 +01:00
func (p *Player) Current() time.Duration {
return p.p.Current()
}
2016-04-10 10:07:58 +02:00
// Volume returns the current volume of this player [0-1].
2016-03-28 04:06:17 +02:00
func (p *Player) Volume() float64 {
return p.p.Volume()
}
2016-04-10 10:07:58 +02:00
// SetVolume sets the volume of this player.
// volume must be in between 0 and 1. SetVolume panics otherwise.
2016-03-28 04:06:17 +02:00
func (p *Player) SetVolume(volume float64) {
p.p.SetVolume(volume)
}
type hook interface {
OnSuspendAudio(f func() error)
OnResumeAudio(f func() error)
AppendHookOnBeforeUpdate(f func() error)
}
var hookForTesting hook
func getHook() hook {
if hookForTesting != nil {
return hookForTesting
}
return &hookImpl{}
}
type hookImpl struct{}
func (h *hookImpl) OnSuspendAudio(f func() error) {
hooks.OnSuspendAudio(f)
}
func (h *hookImpl) OnResumeAudio(f func() error) {
hooks.OnResumeAudio(f)
}
func (h *hookImpl) AppendHookOnBeforeUpdate(f func() error) {
hooks.AppendHookOnBeforeUpdate(f)
}