gomu/player.go

// Copyright (C) 2020  Raziman

package main

import (
	"fmt"
	"os"
	"time"

	"github.com/faiface/beep"
	"github.com/faiface/beep/effects"
	"github.com/faiface/beep/mp3"
	"github.com/faiface/beep/speaker"
	"github.com/ztrue/tracerr"
)

type Player struct {
	hasInit   bool
	isLoop    bool
	isRunning bool
	volume    float64
	isSkipped chan struct{}
	done      chan struct{}

	// to control the vol internally
	vol              *effects.Volume
	ctrl             *beep.Ctrl
	format           *beep.Format
	length           time.Duration
	currentSong      *AudioFile
	streamSeekCloser beep.StreamSeekCloser
	// is used to send progress
	i int
}

func newPlayer() *Player {

	volume := gomu.anko.GetInt("General.volume")
	// Read initial volume from config
	initVol := absVolume(volume)

	// making sure user does not give invalid volume
	if volume > 100 || volume < 0 {
		initVol = 0
	}

	return &Player{volume: initVol}
}

func (p *Player) run(currSong *AudioFile) error {

	p.isSkipped = make(chan struct{}, 1)
	f, err := os.Open(currSong.path)

	if err != nil {
		return tracerr.Wrap(err)
	}

	defer f.Close()

	stream, format, err := mp3.Decode(f)

	p.streamSeekCloser = stream
	p.format = &format

	if err != nil {
		return tracerr.Wrap(err)
	}

	defer stream.Close()

	// song duration
	p.length = p.format.SampleRate.D(p.streamSeekCloser.Len())

	sr := beep.SampleRate(48000)
	if !p.hasInit {

		err := speaker.Init(sr, sr.N(time.Second/10))

		if err != nil {
			return tracerr.Wrap(err)
		}

		p.hasInit = true
	}

	p.currentSong = currSong

	popupMessage := fmt.Sprintf("%s\n\n[ %s ]",
		currSong.name, fmtDuration(p.length))

	defaultTimedPopup(" Current Song ", popupMessage)

	// resample to adapt to sample rate of new songs
	resampled := beep.Resample(4, p.format.SampleRate, sr, p.streamSeekCloser)
	done := make(chan struct{}, 1)
	p.done = done

	sstreamer := beep.Seq(resampled, beep.Callback(func() {
		done <- struct{}{}
	}))

	ctrl := &beep.Ctrl{
		Streamer: sstreamer,
		Paused:   false,
	}

	p.ctrl = ctrl

	resampler := beep.ResampleRatio(4, 1, ctrl)

	volume := &effects.Volume{
		Streamer: resampler,
		Base:     2,
		Volume:   0,
		Silent:   false,
	}

	// sets the volume of previous player
	volume.Volume += p.volume
	p.vol = volume

	// starts playing the audio
	speaker.Play(p.vol)
	gomu.hook.RunHooks("new_song")

	p.isRunning = true

	gomu.playingBar.newProgress(currSong, int(p.length.Seconds()))

	go func() {
		if err := gomu.playingBar.run(); err != nil {
			logError(err)
		}
	}()

	// is used to send progress
	p.i = 0

next:
	for {

		select {
		case <-done:
			if p.isLoop {
				gomu.queue.enqueue(currSong)
				gomu.app.Draw()
			}

			p.isRunning = false
			p.format = nil
			gomu.playingBar.stop()

			nextSong, err := gomu.queue.dequeue()
			gomu.app.Draw()

			if err != nil {
				// when there are no songs to be played, set currentSong as nil
				p.currentSong = nil
				gomu.playingBar.setDefault()
				gomu.app.Draw()
				break next
			}

			go func() {
				if err := p.run(nextSong); err != nil {
					logError(err)
				}
			}()

			break next

		case <-time.After(time.Second):
			// stop progress bar from progressing when paused
			if !p.isRunning {
				continue
			}

			p.i++
			if p.i >= gomu.playingBar.full {
				done <- struct{}{}
				continue
			}

			gomu.playingBar.update <- struct{}{}

		}

	}

	return nil
}

func (p *Player) pause() {
	gomu.hook.RunHooks("pause")
	speaker.Lock()
	p.ctrl.Paused = true
	p.isRunning = false
	speaker.Unlock()
}

func (p *Player) play() {
	gomu.hook.RunHooks("play")
	speaker.Lock()
	p.ctrl.Paused = false
	p.isRunning = true
	speaker.Unlock()
	gomu.playingBar.setSongTitle(p.currentSong.name)
}

// volume up and volume down using -0.5 or +0.5
func (p *Player) setVolume(v float64) float64 {

	// check if no songs playing currently
	if p.vol == nil {
		p.volume += v
		return p.volume
	}

	speaker.Lock()
	p.vol.Volume += v
	p.volume = p.vol.Volume
	speaker.Unlock()
	return p.volume
}

func (p *Player) togglePause() {

	if p.ctrl == nil {
		return
	}

	if p.ctrl.Paused {
		p.play()
	} else {
		p.pause()
	}
}

// skips current song
func (p *Player) skip() {

	gomu.hook.RunHooks("skip")

	if p.currentSong == nil {
		return
	}

	p.ctrl.Streamer = nil
	p.streamSeekCloser.Close()
	p.done <- struct{}{}
}

// Toggles the queue to loop
// dequeued item will be enqueued back
// function returns loop state
func (p *Player) toggleLoop() bool {
	p.isLoop = !p.isLoop
	return p.isLoop
}

func (p *Player) getPosition() time.Duration {
	return p.format.SampleRate.D(p.streamSeekCloser.Position())
}

// seek is the function to move forward and rewind
func (p *Player) seek(pos int) error {
	speaker.Lock()
	defer speaker.Unlock()
	err := p.streamSeekCloser.Seek(pos * int(p.format.SampleRate))
	p.i = pos
	return err
}

// isPaused is used to distinguish the player between pause and stop
func (p *Player) isPaused() bool {
	if p.ctrl == nil {
		return false
	}

	return p.ctrl.Paused
}

// Gets the length of the song in the queue
func getLength(audioPath string) (time.Duration, error) {
	f, err := os.Open(audioPath)

	if err != nil {
		return 0, tracerr.Wrap(err)
	}

	defer f.Close()

	streamer, format, err := mp3.Decode(f)

	if err != nil {
		return 0, tracerr.Wrap(err)
	}

	defer streamer.Close()
	return format.SampleRate.D(streamer.Len()), nil
}

// volToHuman converts float64 volume that is used by audio library to human
// readable form (0 - 100)
func volToHuman(volume float64) int {
	return int(volume*10) + 100
}

// absVolume converts human readable form volume (0 - 100) to float64 volume
// that is used by the audio library
func absVolume(volume int) float64 {
	return (float64(volume) - 100) / 10
}