ebiten/audio/audio.go

678 lines
15 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"
2016-03-12 20:48:13 +01:00
"github.com/hajimehoshi/ebiten/internal/hooks"
"github.com/hajimehoshi/ebiten/internal/web"
2015-01-10 17:23:43 +01:00
)
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 {
c context
initCh chan struct{}
2019-01-09 13:55:42 +01:00
mux *mux
2017-12-23 16:23:57 +01:00
sampleRate int
err error
2018-10-13 15:41:37 +02:00
ready bool
m sync.Mutex
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
//
// Error returned by NewContext is always nil as of 1.5.0-alpha.
//
// NewContext panics when an audio context is already created.
func NewContext(sampleRate int) (*Context, error) {
theContextLock.Lock()
defer theContextLock.Unlock()
if theContext != nil {
2017-04-04 18:12:02 +02:00
panic("audio: context is already created")
}
ch := make(chan struct{})
context, err := newContext(sampleRate, ch)
if err != nil {
return nil, err
}
2016-04-15 17:52:07 +02:00
c := &Context{
sampleRate: sampleRate,
c: context,
initCh: ch,
2016-04-15 17:52:07 +02:00
}
theContext = c
2019-01-09 13:55:42 +01:00
c.mux = newMux()
2017-08-17 04:15:04 +02:00
go c.loop()
return c, nil
}
2017-10-01 10:24:30 +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
2016-03-02 16:48:59 +01:00
}
2017-08-17 04:15:04 +02:00
func (c *Context) loop() {
suspendCh := make(chan struct{}, 1)
resumeCh := make(chan struct{}, 1)
hooks.OnSuspendAudio(func() {
suspendCh <- struct{}{}
})
hooks.OnResumeAudio(func() {
resumeCh <- struct{}{}
})
var once sync.Once
hooks.AppendHookOnBeforeUpdate(func() error {
once.Do(func() {
close(c.initCh)
})
var err error
theContextLock.Lock()
if theContext != nil {
theContext.m.Lock()
err = theContext.err
theContext.m.Unlock()
}
theContextLock.Unlock()
return err
})
2017-07-13 18:38:22 +02:00
<-c.initCh
defer c.c.Close()
2019-01-26 16:31:55 +01:00
p := c.c.NewPlayer()
defer p.Close()
for {
select {
case <-suspendCh:
<-resumeCh
default:
2019-01-09 13:55:42 +01:00
if _, err := io.CopyN(p, c.mux, 2048); err != nil {
c.err = err
return
}
2018-10-13 15:41:37 +02:00
c.m.Lock()
c.ready = true
c.m.Unlock()
}
}
}
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()
r := c.ready
c.m.Unlock()
return r
}
2017-11-30 16:26:28 +01:00
// Update is deprecated as of 1.6.0-alpha.
2017-07-13 18:45:36 +02:00
//
2017-11-30 16:26:28 +01:00
// As of 1.6.0-alpha, Update always returns nil and does nothing related to updating the state.
// You don't have to call Update any longer.
2017-11-30 16:26:28 +01:00
// The internal audio error is returned at ebiten.Run instead.
func (c *Context) Update() error {
return nil
2016-03-10 16:01:00 +01:00
}
// SampleRate returns the sample rate.
func (c *Context) SampleRate() int {
2016-04-15 17:52:07 +02:00
return c.sampleRate
}
2016-04-04 19:24:54 +02:00
// ReadSeekCloser is an io.ReadSeeker and io.Closer.
2016-03-28 17:06:37 +02:00
type ReadSeekCloser interface {
io.ReadSeeker
io.Closer
}
type bytesReadSeekCloser struct {
reader *bytes.Reader
}
2017-12-22 18:05:49 +01:00
func (b *bytesReadSeekCloser) Read(buf []byte) (int, error) {
return b.reader.Read(buf)
2017-01-15 18:21:21 +01:00
}
func (b *bytesReadSeekCloser) Seek(offset int64, whence int) (int64, error) {
return b.reader.Seek(offset, whence)
}
func (b *bytesReadSeekCloser) Close() error {
b.reader = nil
2017-01-15 18:21:21 +01:00
return nil
}
// BytesReadSeekCloser creates ReadSeekCloser from bytes.
2017-12-22 18:05:49 +01:00
func BytesReadSeekCloser(b []byte) ReadSeekCloser {
2017-06-03 18:03:01 +02:00
return &bytesReadSeekCloser{reader: bytes.NewReader(b)}
2017-01-15 18:21:21 +01:00
}
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 {
p *playerImpl
}
type playerImpl struct {
2019-01-09 13:55:42 +01:00
mux *mux
src io.ReadCloser
2017-12-22 18:05:49 +01:00
srcEOF bool
2016-04-15 17:52:07 +02:00
sampleRate int
2017-12-22 18:05:49 +01:00
buf []byte
pos int64
volume float64
closeCh chan struct{}
closedCh chan struct{}
readLoopEndedCh chan struct{}
seekCh chan seekArgs
seekedCh chan error
proceedCh chan []int16
proceededCh chan proceededValues
2017-12-23 10:51:45 +01:00
syncCh chan func()
finalized bool
2016-02-10 18:18:39 +01:00
}
2017-12-23 09:24:51 +01:00
type seekArgs struct {
offset int64
whence int
}
type proceededValues struct {
buf []int16
err error
}
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.
func NewPlayer(context *Context, src io.ReadCloser) (*Player, error) {
2019-01-09 13:55:42 +01:00
if context.mux.hasSource(src) {
return nil, errors.New("audio: src cannot be shared with another Player")
}
2016-04-15 17:52:07 +02:00
p := &Player{
&playerImpl{
2019-01-09 13:55:42 +01:00
mux: context.mux,
src: src,
sampleRate: context.sampleRate,
buf: nil,
volume: 1,
closeCh: make(chan struct{}),
closedCh: make(chan struct{}),
readLoopEndedCh: make(chan struct{}),
seekCh: make(chan seekArgs),
seekedCh: make(chan error),
proceedCh: make(chan []int16),
proceededCh: make(chan proceededValues),
syncCh: make(chan func()),
},
2016-04-15 17:52:07 +02:00
}
if seeker, ok := p.p.src.(io.Seeker); ok {
// Get the current position of the source.
pos, err := seeker.Seek(0, io.SeekCurrent)
if err != nil {
return nil, err
}
p.p.pos = pos
2016-04-15 17:52:07 +02:00
}
runtime.SetFinalizer(p, (*Player).finalize)
2017-12-23 09:24:51 +01:00
go func() {
p.p.readLoop()
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.
//
// NewPlayerFromBytes's error is always nil as of 1.5.0-alpha.
2017-12-22 18:05:49 +01:00
func NewPlayerFromBytes(context *Context, src []byte) (*Player, error) {
b := BytesReadSeekCloser(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, nil
2016-06-26 19:22:44 +02:00
}
func (p *Player) finalize() {
runtime.SetFinalizer(p, nil)
p.p.setFinalized(true)
// TODO: It is really hard to say concurrent safety.
// Refactor this package to reduce goroutines.
if !p.IsPlaying() {
p.Close()
}
}
func (p *playerImpl) setFinalized(finalized bool) {
p.sync(func() {
p.finalized = finalized
})
}
func (p *playerImpl) isFinalized() bool {
b := false
p.sync(func() {
b = p.finalized
})
return b
}
2017-10-01 10:24:30 +02:00
// Close closes the stream.
2016-04-15 17:52:07 +02:00
//
2016-06-27 19:50:13 +02:00
// When closing, the stream owned by the player will also be closed by calling its Close.
2017-10-01 10:24:30 +02:00
// This means that the source stream passed via NewPlayer will also be closed.
//
2017-04-04 18:12:02 +02:00
// Close returns error when closing the source returns error.
2016-03-28 17:06:37 +02:00
func (p *Player) Close() error {
2016-04-15 17:52:07 +02:00
runtime.SetFinalizer(p, nil)
return p.p.Close()
}
func (p *playerImpl) Close() error {
2019-01-09 13:55:42 +01:00
p.mux.removePlayer(p)
return p.closeImpl()
}
2017-12-22 18:05:49 +01:00
func (p *playerImpl) closeImpl() error {
select {
case p.closeCh <- struct{}{}:
<-p.closedCh
return nil
case <-p.readLoopEndedCh:
return fmt.Errorf("audio: the player is already closed")
}
2016-03-06 14:03:11 +01:00
}
func (p *playerImpl) bufferToInt16(lengthInBytes int) ([]int16, error) {
select {
case p.proceedCh <- make([]int16, lengthInBytes/2):
r := <-p.proceededCh
return r.buf, r.err
case <-p.readLoopEndedCh:
return nil, fmt.Errorf("audio: the player is already closed")
}
2016-03-06 14:03:11 +01:00
}
2016-04-10 10:07:58 +02:00
// Play plays the stream.
2016-04-15 17:52:07 +02:00
//
2017-04-04 18:12:02 +02:00
// Play always returns nil.
2016-02-10 18:18:39 +01:00
func (p *Player) Play() error {
p.p.Play()
2016-03-03 03:57:25 +01:00
return nil
2015-01-22 19:02:23 +01:00
}
2016-02-11 11:55:59 +01:00
func (p *playerImpl) Play() {
2019-01-09 13:55:42 +01:00
p.mux.addPlayer(p)
}
func (p *playerImpl) readLoop() {
defer func() {
// Note: the error is ignored
p.src.Close()
2017-12-23 10:51:45 +01:00
// Receiving from a closed channel returns quickly
// i.e. `case <-p.readLoopEndedCh:` can check if this loops is ended.
close(p.readLoopEndedCh)
}()
timer := time.NewTimer(0)
timerCh := timer.C
2017-12-23 09:24:51 +01:00
var readErr error
2017-12-22 18:05:49 +01:00
for {
select {
case <-p.closeCh:
p.closedCh <- struct{}{}
2017-12-22 20:12:12 +01:00
return
2017-12-23 09:24:51 +01:00
case s := <-p.seekCh:
seeker, ok := p.src.(io.Seeker)
if !ok {
2019-02-07 09:19:24 +01:00
panic("audio: the source must be io.Seeker when seeking")
}
pos, err := seeker.Seek(s.offset, s.whence)
2017-12-23 09:24:51 +01:00
p.buf = nil
p.pos = pos
p.srcEOF = false
p.seekedCh <- err
if timer != nil {
timer.Stop()
}
timer = time.NewTimer(time.Millisecond)
timerCh = timer.C
2017-12-23 09:24:51 +01:00
case <-timerCh:
2017-12-23 14:52:01 +01:00
// If the buffer has 1 second, that's enough.
if len(p.buf) >= p.sampleRate*bytesPerSample {
if timer != nil {
timer.Stop()
}
timer = time.NewTimer(100 * time.Millisecond)
timerCh = timer.C
2017-12-23 09:05:14 +01:00
break
}
2017-12-23 09:24:51 +01:00
// Try to read the buffer for 1/60[s].
2017-12-23 19:41:36 +01:00
s := 60
if web.IsAndroidChrome() {
s = 10
} else if web.IsBrowser() {
s = 20
}
l := p.sampleRate * bytesPerSample / s
2017-12-23 11:59:52 +01:00
l &= mask
buf := make([]byte, l)
2017-12-23 09:05:14 +01:00
n, err := p.src.Read(buf)
2017-12-23 09:24:51 +01:00
2017-12-23 09:05:14 +01:00
p.buf = append(p.buf, buf[:n]...)
if err == io.EOF {
p.srcEOF = true
}
if p.srcEOF && len(p.buf) == 0 {
if timer != nil {
timer.Stop()
}
timer = nil
timerCh = nil
2017-12-23 09:24:51 +01:00
break
2017-12-23 09:05:14 +01:00
}
if err != nil && err != io.EOF {
2017-12-23 09:24:51 +01:00
readErr = err
if timer != nil {
timer.Stop()
}
timer = nil
timerCh = nil
2017-12-23 09:24:51 +01:00
break
2017-12-22 18:05:49 +01:00
}
if timer != nil {
timer.Stop()
}
2017-12-23 19:41:36 +01:00
if web.IsBrowser() {
timer = time.NewTimer(10 * time.Millisecond)
2017-12-23 19:41:36 +01:00
} else {
timer = time.NewTimer(time.Millisecond)
2017-12-23 19:41:36 +01:00
}
timerCh = timer.C
2017-12-23 09:24:51 +01:00
case buf := <-p.proceedCh:
if readErr != nil {
p.proceededCh <- proceededValues{buf, readErr}
return
}
if p.shouldSkipImpl() {
// Return zero values.
p.proceededCh <- proceededValues{buf, nil}
break
}
lengthInBytes := len(buf) * 2
l := lengthInBytes
2017-12-23 09:24:51 +01:00
if l > len(p.buf) {
l = len(p.buf)
}
for i := 0; i < l/2; i++ {
buf[i] = int16(p.buf[2*i]) | (int16(p.buf[2*i+1]) << 8)
buf[i] = int16(float64(buf[i]) * p.volume)
}
p.pos += int64(l)
p.buf = p.buf[l:]
p.proceededCh <- proceededValues{buf[:l/2], nil}
2017-12-23 10:51:45 +01:00
case f := <-p.syncCh:
f()
2017-12-22 18:05:49 +01:00
}
}
}
func (p *playerImpl) sync(f func()) bool {
2017-12-23 10:51:45 +01:00
ch := make(chan struct{})
ff := func() {
f()
close(ch)
}
select {
case p.syncCh <- ff:
<-ch
return true
case <-p.readLoopEndedCh:
return false
}
}
func (p *playerImpl) shouldSkip() bool {
r := false
p.sync(func() {
r = p.shouldSkipImpl()
})
return r
}
func (p *playerImpl) shouldSkipImpl() bool {
// When p.buf is nil, the player just starts playing or seeking.
// Note that this is different from len(p.buf) == 0 && p.buf != nil.
if p.buf == nil {
return true
}
if p.eofImpl() {
return true
}
return false
}
func (p *playerImpl) bufferSizeInBytes() int {
s := 0
p.sync(func() {
s = len(p.buf)
})
return s
}
func (p *playerImpl) eof() bool {
2017-12-23 10:51:45 +01:00
r := false
p.sync(func() {
r = p.eofImpl()
2017-12-23 10:51:45 +01:00
})
2017-12-22 18:05:49 +01:00
return r
}
func (p *playerImpl) eofImpl() bool {
return p.srcEOF && len(p.buf) == 0
}
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()
}
func (p *playerImpl) IsPlaying() bool {
2019-01-09 13:55:42 +01:00
return p.mux.hasPlayer(p)
2016-03-06 10:55:20 +01:00
}
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()
}
func (p *playerImpl) Rewind() error {
if _, ok := p.src.(io.Seeker); !ok {
2018-03-21 16:36:38 +01:00
panic("audio: player to be rewound must be io.Seeker")
}
2016-03-06 10:55:20 +01:00
return p.Seek(0)
}
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)
}
func (p *playerImpl) Seek(offset time.Duration) error {
if _, ok := p.src.(io.Seeker); !ok {
panic("audio: player to be sought must be io.Seeker")
}
o := int64(offset) * bytesPerSample * int64(p.sampleRate) / int64(time.Second)
2016-04-15 17:52:07 +02:00
o &= mask
select {
case p.seekCh <- seekArgs{o, io.SeekStart}:
return <-p.seekedCh
case <-p.readLoopEndedCh:
return fmt.Errorf("audio: the player is already closed")
}
}
2016-04-10 10:07:58 +02:00
// Pause pauses the playing.
2016-04-15 17:52:07 +02:00
//
2017-04-04 18:12:02 +02:00
// Pause always returns nil.
2016-03-04 17:01:57 +01:00
func (p *Player) Pause() error {
p.p.Pause()
2016-03-03 03:57:25 +01:00
return nil
2016-02-11 11:55:59 +01:00
}
2016-03-06 10:55:20 +01:00
func (p *playerImpl) Pause() {
2019-01-09 13:55:42 +01:00
p.mux.removePlayer(p)
}
2016-04-10 10:07:58 +02:00
// Current returns the current position.
2016-03-06 10:55:20 +01:00
func (p *Player) Current() time.Duration {
return p.p.Current()
}
func (p *playerImpl) Current() time.Duration {
2017-12-23 10:51:45 +01:00
sample := int64(0)
p.sync(func() {
sample = p.pos / bytesPerSample
2017-12-23 10:51:45 +01:00
})
2017-12-23 10:39:14 +01:00
return time.Duration(sample) * time.Second / time.Duration(p.sampleRate)
2016-03-06 10:55:20 +01:00
}
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()
}
func (p *playerImpl) Volume() float64 {
2017-12-23 10:51:45 +01:00
v := 0.0
p.sync(func() {
v = p.volume
})
2017-06-03 20:14:48 +02:00
return v
2016-03-28 04:06:17 +02:00
}
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)
}
func (p *playerImpl) SetVolume(volume float64) {
2016-04-02 19:46:18 +02:00
// The condition must be true when volume is NaN.
if !(0 <= volume && volume <= 1) {
panic("audio: volume must be in between 0 and 1")
2016-03-28 04:06:17 +02:00
}
2017-12-23 10:39:14 +01:00
2017-12-23 10:51:45 +01:00
p.sync(func() {
p.volume = volume
})
2016-03-28 04:06:17 +02:00
}