Merge pull request #305 from dweymouth/feature/jukebox

Redesign of PlaybackManager
This commit is contained in:
Drew Weymouth
2023-12-23 10:52:55 -08:00
committed by GitHub
21 changed files with 1300 additions and 987 deletions
+25 -18
View File
@@ -12,6 +12,7 @@ import (
"github.com/dweymouth/supersonic/backend/util"
"github.com/dweymouth/supersonic/player"
"github.com/dweymouth/supersonic/player/mpv"
"github.com/dweymouth/supersonic/sharedutil"
"github.com/fsnotify/fsnotify"
"github.com/google/uuid"
@@ -36,7 +37,7 @@ type App struct {
ServerManager *ServerManager
ImageManager *ImageManager
PlaybackManager *PlaybackManager
Player *player.Player
LocalPlayer *mpv.Player
UpdateChecker UpdateChecker
MPRISHandler *MPRISHandler
@@ -107,7 +108,7 @@ func StartupApp(appName, displayAppName, appVersionTag, configFile, latestReleas
}
a.ServerManager = NewServerManager(appName, a.Config)
a.PlaybackManager = NewPlaybackManager(a.bgrndCtx, a.ServerManager, a.Player, &a.Config.Scrobbling, &a.Config.Transcoding)
a.PlaybackManager = NewPlaybackManager(a.bgrndCtx, a.ServerManager, a.LocalPlayer, &a.Config.Scrobbling, &a.Config.Transcoding)
a.ImageManager = NewImageManager(a.bgrndCtx, a.ServerManager, configdir.LocalCache(a.appName))
a.Config.Application.MaxImageCacheSizeMB = clamp(a.Config.Application.MaxImageCacheSizeMB, 1, 500)
a.ImageManager.SetMaxOnDiskCacheSizeBytes(int64(a.Config.Application.MaxImageCacheSizeMB) * 1_048_576)
@@ -117,7 +118,7 @@ func StartupApp(appName, displayAppName, appVersionTag, configFile, latestReleas
// OS media center integrations
a.setupMPRIS(displayAppName)
InitMPMediaHandler(a.Player, a.PlaybackManager, func(id string) (string, error) {
InitMPMediaHandler(a.PlaybackManager, func(id string) (string, error) {
a.ImageManager.GetCoverThumbnail(id) // ensure image is cached locally
return a.ImageManager.GetCoverArtUrl(id)
})
@@ -194,21 +195,21 @@ func (a *App) callOnReactivate() {
}
func (a *App) initMPV() error {
p := player.NewWithClientName(a.appName)
p := mpv.NewWithClientName(a.appName)
c := a.Config.LocalPlayback
c.InMemoryCacheSizeMB = clamp(c.InMemoryCacheSizeMB, 10, 500)
if err := p.Init(c.InMemoryCacheSizeMB); err != nil {
return fmt.Errorf("failed to initialize mpv player: %s", err.Error())
}
a.Player = p
a.LocalPlayer = p
return nil
}
func (a *App) setupMPV() error {
a.Config.LocalPlayback.Volume = clamp(a.Config.LocalPlayback.Volume, 0, 100)
a.Player.SetVolume(a.Config.LocalPlayback.Volume)
a.LocalPlayer.SetVolume(a.Config.LocalPlayback.Volume)
devs, err := a.Player.ListAudioDevices()
devs, err := a.LocalPlayer.ListAudioDevices()
if err != nil {
return err
}
@@ -228,35 +229,41 @@ func (a *App) setupMPV() error {
// (e.g. a USB audio device that is currently unplugged)
desiredDevice = "auto"
}
a.Player.SetAudioDevice(desiredDevice)
a.LocalPlayer.SetAudioDevice(desiredDevice)
rgainOpts := []string{ReplayGainNone, ReplayGainAlbum, ReplayGainTrack, ReplayGainAuto}
if !sharedutil.SliceContains(rgainOpts, a.Config.ReplayGain.Mode) {
a.Config.ReplayGain.Mode = ReplayGainNone
}
mode := player.ReplayGainMode(a.Config.ReplayGain.Mode)
if a.Config.ReplayGain.Mode == ReplayGainAuto {
mode := player.ReplayGainNone
switch a.Config.ReplayGain.Mode {
case ReplayGainAlbum:
mode = player.ReplayGainAlbum
case ReplayGainTrack:
mode = player.ReplayGainTrack
case ReplayGainAuto:
mode = player.ReplayGainTrack
}
a.Player.SetReplayGainOptions(player.ReplayGainOptions{
a.LocalPlayer.SetReplayGainOptions(player.ReplayGainOptions{
Mode: mode,
PreventClipping: a.Config.ReplayGain.PreventClipping,
PreampGain: a.Config.ReplayGain.PreampGainDB,
})
a.Player.SetAudioExclusive(a.Config.LocalPlayback.AudioExclusive)
a.LocalPlayer.SetAudioExclusive(a.Config.LocalPlayback.AudioExclusive)
eq := &player.ISO15BandEqualizer{
eq := &mpv.ISO15BandEqualizer{
EQPreamp: a.Config.LocalPlayback.EqualizerPreamp,
Disabled: !a.Config.LocalPlayback.EqualizerEnabled,
}
copy(eq.BandGains[:], a.Config.LocalPlayback.GraphicEqualizerBands)
a.Player.SetEqualizer(eq)
a.LocalPlayer.SetEqualizer(eq)
return nil
}
func (a *App) setupMPRIS(mprisAppName string) {
a.MPRISHandler = NewMPRISHandler(mprisAppName, a.Player, a.PlaybackManager)
a.MPRISHandler = NewMPRISHandler(mprisAppName, a.PlaybackManager)
a.MPRISHandler.ArtURLLookup = a.ImageManager.GetCoverArtUrl
a.MPRISHandler.OnRaise = func() error { a.callOnReactivate(); return nil }
a.MPRISHandler.OnQuit = func() error {
@@ -293,10 +300,10 @@ func (a *App) DeleteServerCacheDir(serverID uuid.UUID) error {
func (a *App) Shutdown() {
a.MPRISHandler.Shutdown()
a.PlaybackManager.DisableCallbacks()
a.Player.Stop() // will trigger scrobble check
a.Config.LocalPlayback.Volume = a.Player.GetVolume()
a.PlaybackManager.Stop() // will trigger scrobble check
a.Config.LocalPlayback.Volume = a.LocalPlayer.GetVolume()
a.cancel()
a.Player.Destroy()
a.LocalPlayer.Destroy()
a.Config.WriteConfigFile(a.configPath())
os.RemoveAll(configdir.LocalConfig(a.appName, sessionDir))
}
+19
View File
@@ -148,6 +148,25 @@ type SupportsRating interface {
SetRating(params RatingFavoriteParameters, rating int) error
}
type JukeboxProvider interface {
JukeboxStart() error
JukeboxStop() error
JukeboxSeek(idx, seconds int) error
JukeboxClear() error
JukeboxSet(trackID string) error
JukeboxAdd(trackID string) error
JukeboxRemove(idx int) error
JukeboxSetVolume(vol int) error
JukeboxGetStatus() (*JukeboxStatus, error)
}
type JukeboxStatus struct {
Volume int
CurrentTrack int
Playing bool
PositionSeconds float64
}
func genresMatch(filterGenres, albumGenres []string) bool {
for _, g1 := range filterGenres {
for _, g2 := range albumGenres {
+67
View File
@@ -0,0 +1,67 @@
package subsonic
import (
"strconv"
"github.com/dweymouth/supersonic/backend/mediaprovider"
)
var _ mediaprovider.JukeboxProvider = (*subsonicMediaProvider)(nil)
func (s *subsonicMediaProvider) JukeboxStart() error {
_, err := s.client.JukeboxControl("start", nil)
return err
}
func (s *subsonicMediaProvider) JukeboxStop() error {
_, err := s.client.JukeboxControl("stop", nil)
return err
}
func (s *subsonicMediaProvider) JukeboxClear() error {
_, err := s.client.JukeboxControl("clear", nil)
return err
}
func (s *subsonicMediaProvider) JukeboxSetVolume(vol int) error {
_, err := s.client.JukeboxControl("setGain",
map[string]string{"gain": strconv.Itoa(vol)})
return err
}
func (s *subsonicMediaProvider) JukeboxSeek(idx, seconds int) error {
_, err := s.client.JukeboxControl("skip",
map[string]string{"index": strconv.Itoa(idx), "offset": strconv.Itoa(seconds)})
return err
}
func (s *subsonicMediaProvider) JukeboxRemove(idx int) error {
_, err := s.client.JukeboxControl("remove",
map[string]string{"index": strconv.Itoa(idx)})
return err
}
func (s *subsonicMediaProvider) JukeboxSet(trackID string) error {
_, err := s.client.JukeboxControl("set",
map[string]string{"id": trackID})
return err
}
func (s *subsonicMediaProvider) JukeboxAdd(trackID string) error {
_, err := s.client.JukeboxControl("add",
map[string]string{"id": trackID})
return err
}
func (s *subsonicMediaProvider) JukeboxGetStatus() (*mediaprovider.JukeboxStatus, error) {
stat, err := s.client.JukeboxControl("status", nil)
if err != nil {
return nil, err
}
return &mediaprovider.JukeboxStatus{
Volume: int(stat.Gain * 100),
CurrentTrack: stat.CurrentIndex,
Playing: stat.Playing,
PositionSeconds: float64(stat.Position),
}, nil
}
+22 -30
View File
@@ -16,13 +16,11 @@ import (
)
import (
"fmt"
"log"
"strings"
"unsafe"
"github.com/dweymouth/supersonic/backend/mediaprovider"
"github.com/dweymouth/supersonic/player"
)
// os_remote_command_callback is called by Objective-C when incoming OS media commands are received.
@@ -51,7 +49,6 @@ func os_remote_command_callback(command C.Command, value C.double) {
// MPMediaHandler is the handler for MacOS media controls and system events.
type MPMediaHandler struct {
player *player.Player
playbackManager *PlaybackManager
artURLLookup func(string) (string, error)
}
@@ -62,9 +59,8 @@ var mpMediaEventRecipient *MPMediaHandler
// NewMPMediaHandler creates a new MPMediaHandler instances and sets it as the current recipient
// for incoming system events.
func InitMPMediaHandler(player *player.Player, playbackManager *PlaybackManager, artURLLookup func(trackID string) (string, error)) error {
func InitMPMediaHandler(playbackManager *PlaybackManager, artURLLookup func(trackID string) (string, error)) error {
mp := &MPMediaHandler{
player: player,
playbackManager: playbackManager,
artURLLookup: artURLLookup,
}
@@ -78,22 +74,22 @@ func InitMPMediaHandler(player *player.Player, playbackManager *PlaybackManager,
go mp.updateMetadata(track)
})
mp.player.OnStopped(func() {
mp.playbackManager.OnStopped(func() {
C.set_os_playback_state_stopped()
})
mp.player.OnSeek(func() {
C.update_os_now_playing_info_position(C.double(mp.player.GetStatus().TimePos))
mp.playbackManager.OnSeek(func() {
C.update_os_now_playing_info_position(C.double(mp.playbackManager.PlayerStatus().TimePos))
})
mp.player.OnPlaying(func() {
mp.playbackManager.OnPlaying(func() {
C.set_os_playback_state_playing()
C.update_os_now_playing_info_position(C.double(mp.player.GetStatus().TimePos))
C.update_os_now_playing_info_position(C.double(mp.playbackManager.PlayerStatus().TimePos))
})
mp.player.OnPaused(func() {
mp.playbackManager.OnPaused(func() {
C.set_os_playback_state_paused()
C.update_os_now_playing_info_position(C.double(mp.player.GetStatus().TimePos))
C.update_os_now_playing_info_position(C.double(mp.playbackManager.PlayerStatus().TimePos))
})
return nil
@@ -132,60 +128,56 @@ func (mp *MPMediaHandler) updateMetadata(track *mediaprovider.Track) {
// MPMediaHandler instance received OS command 'pause'
func (mp *MPMediaHandler) OnCommandPause() {
if mp == nil || mp.player == nil {
if mp == nil || mp.playbackManager == nil {
return
}
mp.player.Pause()
mp.playbackManager.Pause()
}
// MPMediaHandler instance received OS command 'play'
func (mp *MPMediaHandler) OnCommandPlay() {
if mp == nil || mp.player == nil {
if mp == nil || mp.playbackManager == nil {
return
}
mp.player.Continue()
mp.playbackManager.Continue()
}
// MPMediaHandler instance received OS command 'stop'
func (mp *MPMediaHandler) OnCommandStop() {
if mp == nil || mp.player == nil {
if mp == nil || mp.playbackManager == nil {
return
}
mp.player.Stop()
mp.playbackManager.Stop()
}
// MPMediaHandler instance received OS command 'toggle'
func (mp *MPMediaHandler) OnCommandTogglePlayPause() {
if mp == nil || mp.player == nil {
if mp == nil || mp.playbackManager == nil {
return
}
if mp.player.GetStatus().State == player.Playing {
mp.OnCommandPause()
} else {
mp.OnCommandPlay()
}
mp.playbackManager.PlayPause()
}
// MPMediaHandler instance received OS command 'next track'
func (mp *MPMediaHandler) OnCommandNextTrack() {
if mp == nil || mp.player == nil {
if mp == nil || mp.playbackManager == nil {
return
}
mp.player.SeekNext()
mp.playbackManager.SeekNext()
}
// MPMediaHandler instance received OS command 'previous track'
func (mp *MPMediaHandler) OnCommandPreviousTrack() {
if mp == nil || mp.player == nil {
if mp == nil || mp.playbackManager == nil {
return
}
mp.player.SeekBackOrPrevious()
mp.playbackManager.SeekBackOrPrevious()
}
// MPMediaHandler instance received OS command to 'seek'
func (mp *MPMediaHandler) OnCommandSeek(positionSeconds float64) {
if mp == nil || mp.player == nil {
if mp == nil || mp.playbackManager == nil {
return
}
mp.player.Seek(fmt.Sprintf("%0.2f", positionSeconds), player.SeekAbsolute)
mp.playbackManager.SeekSeconds(positionSeconds)
}
+1 -3
View File
@@ -4,11 +4,9 @@ package backend
import (
"errors"
"github.com/dweymouth/supersonic/player"
)
func InitMPMediaHandler(player *player.Player, playbackManager *PlaybackManager, artURLLookup func(trackID string) (string, error)) error {
func InitMPMediaHandler(playbackManager *PlaybackManager, artURLLookup func(trackID string) (string, error)) error {
// MPMediaHandler only supports macOS.
return errors.New("unsupported platform")
}
+36 -35
View File
@@ -3,7 +3,6 @@ package backend
import (
"encoding/base32"
"errors"
"fmt"
"strconv"
"github.com/dweymouth/supersonic/backend/mediaprovider"
@@ -43,24 +42,23 @@ type MPRISHandler struct {
connErr error
playerName string
curTrackPath string // empty for no track
p *player.Player
pm *PlaybackManager
s *server.Server
evt *events.EventHandler
}
func NewMPRISHandler(playerName string, p *player.Player, pm *PlaybackManager) *MPRISHandler {
m := &MPRISHandler{playerName: playerName, p: p, pm: pm, connErr: errors.New("not started")}
func NewMPRISHandler(playerName string, pm *PlaybackManager) *MPRISHandler {
m := &MPRISHandler{playerName: playerName, pm: pm, connErr: errors.New("not started")}
m.s = server.NewServer(playerName, m, m)
m.evt = events.NewEventHandler(m.s)
m.p.OnSeek(func() {
pm.OnSeek(func() {
if m.connErr == nil {
pos := secondsToMicroseconds(m.p.GetStatus().TimePos)
pos := secondsToMicroseconds(pm.PlayerStatus().TimePos)
m.evt.Player.OnSeek(pos)
}
})
m.pm.OnSongChange(func(tr, _ *mediaprovider.Track) {
pm.OnSongChange(func(tr, _ *mediaprovider.Track) {
if m.connErr == nil {
m.evt.Player.OnTitle()
}
@@ -70,7 +68,7 @@ func NewMPRISHandler(playerName string, p *player.Player, pm *PlaybackManager) *
m.curTrackPath = dbusTrackIDPrefix + encodeTrackId(tr.ID)
}
})
m.pm.OnVolumeChange(func(vol int) {
pm.OnVolumeChange(func(vol int) {
if m.connErr == nil {
m.evt.Player.OnVolume()
}
@@ -80,9 +78,9 @@ func NewMPRISHandler(playerName string, p *player.Player, pm *PlaybackManager) *
m.evt.Player.OnPlayPause()
}
}
m.p.OnStopped(emitPlayStatus)
m.p.OnPlaying(emitPlayStatus)
m.p.OnPaused(emitPlayStatus)
m.pm.OnStopped(emitPlayStatus)
m.pm.OnPlaying(emitPlayStatus)
m.pm.OnPaused(emitPlayStatus)
return m
}
@@ -147,45 +145,47 @@ func (m *MPRISHandler) SupportedMimeTypes() ([]string, error) {
// OrgMprisMediaPlayer2PlayerAdapter implementation
func (m *MPRISHandler) Next() error {
return m.p.SeekNext()
return m.pm.SeekNext()
}
func (m *MPRISHandler) Previous() error {
return m.p.SeekBackOrPrevious()
return m.pm.SeekBackOrPrevious()
}
func (m *MPRISHandler) Pause() error {
if m.p.GetStatus().State == player.Playing {
return m.p.PlayPause()
if m.pm.PlayerStatus().State == player.Playing {
return m.pm.PlayPause()
}
return nil
}
func (m *MPRISHandler) PlayPause() error {
return m.p.PlayPause()
return m.pm.PlayPause()
}
func (m *MPRISHandler) Stop() error {
return m.p.Stop()
return m.pm.Stop()
}
func (m *MPRISHandler) Play() error {
switch m.p.GetStatus().State {
switch m.pm.PlayerStatus().State {
case player.Paused:
return m.p.PlayPause()
return m.pm.PlayPause()
case player.Stopped:
return m.p.PlayFromBeginning()
return m.pm.PlayFromBeginning()
}
return nil
}
func (m *MPRISHandler) Seek(offset types.Microseconds) error {
return m.p.Seek(fmt.Sprintf("%0.2f", microsecondsToSeconds(offset)), player.SeekRelative)
// MPRIS seek command is relative to current position
pos := m.pm.PlayerStatus().TimePos + microsecondsToSeconds(offset)
return m.pm.SeekSeconds(pos)
}
func (m *MPRISHandler) SetPosition(trackId string, position types.Microseconds) error {
if m.curTrackPath == trackId {
return m.p.Seek(fmt.Sprintf("%0.2f", microsecondsToSeconds(position)), player.SeekAbsolute)
return m.pm.SeekSeconds(microsecondsToSeconds(position))
}
return nil
}
@@ -195,7 +195,7 @@ func (m *MPRISHandler) OpenUri(uri string) error {
}
func (m *MPRISHandler) PlaybackStatus() (types.PlaybackStatus, error) {
switch m.p.GetStatus().State {
switch m.pm.PlayerStatus().State {
case player.Playing:
return types.PlaybackStatusPlaying, nil
case player.Paused:
@@ -207,12 +207,12 @@ func (m *MPRISHandler) PlaybackStatus() (types.PlaybackStatus, error) {
}
func (m *MPRISHandler) LoopStatus() (types.LoopStatus, error) {
switch m.pm.LoopMode() {
case LoopModeAll:
switch m.pm.GetLoopMode() {
case LoopAll:
return types.LoopStatusPlaylist, nil
case LoopModeOne:
case LoopOne:
return types.LoopStatusTrack, nil
case LoopModeNone:
case LoopNone:
return types.LoopStatusNone, nil
}
return "", errors.New("unknown loop status")
@@ -221,13 +221,15 @@ func (m *MPRISHandler) LoopStatus() (types.LoopStatus, error) {
func (m *MPRISHandler) SetLoopStatus(status types.LoopStatus) error {
switch status {
case types.LoopStatusPlaylist:
return m.pm.SetLoopMode(LoopModeAll)
m.pm.SetLoopMode(LoopAll)
case types.LoopStatusTrack:
return m.pm.SetLoopMode(LoopModeOne)
m.pm.SetLoopMode(LoopOne)
case types.LoopStatusNone:
return m.pm.SetLoopMode(LoopModeNone)
m.pm.SetLoopMode(LoopNone)
default:
return errors.New("unknown loop status")
}
return errors.New("unknown loop status")
return nil
}
func (m *MPRISHandler) Rate() (float64, error) {
@@ -243,7 +245,7 @@ func (m *MPRISHandler) Metadata() (types.Metadata, error) {
if m.curTrackPath != "" {
trackObjPath = m.curTrackPath
}
status := m.p.GetStatus()
status := m.pm.PlayerStatus()
var tr mediaprovider.Track
if np := m.pm.NowPlaying(); np != nil && status.State != player.Stopped {
tr = *np
@@ -271,7 +273,7 @@ func (m *MPRISHandler) Metadata() (types.Metadata, error) {
}
func (m *MPRISHandler) Volume() (float64, error) {
return float64(m.p.GetVolume()) / 100, nil
return float64(m.pm.Volume()) / 100, nil
}
func (m *MPRISHandler) SetVolume(v float64) error {
@@ -279,7 +281,7 @@ func (m *MPRISHandler) SetVolume(v float64) error {
}
func (m *MPRISHandler) Position() (int64, error) {
return int64(secondsToMicroseconds(m.p.GetStatus().TimePos)), nil
return int64(secondsToMicroseconds(m.pm.PlayerStatus().TimePos)), nil
}
func (m *MPRISHandler) MinimumRate() (float64, error) {
@@ -326,4 +328,3 @@ func encodeTrackId(id string) string {
data := []byte(id)
return base32.StdEncoding.WithPadding('0').EncodeToString(data)
}
+310 -118
View File
@@ -2,6 +2,7 @@ package backend
import (
"context"
"errors"
"log"
"math/rand"
"time"
@@ -12,30 +13,29 @@ import (
"github.com/dweymouth/supersonic/sharedutil"
)
const (
ReplayGainNone = string(player.ReplayGainNone)
ReplayGainAlbum = string(player.ReplayGainAlbum)
ReplayGainTrack = string(player.ReplayGainTrack)
var (
ReplayGainNone = player.ReplayGainNone.String()
ReplayGainAlbum = player.ReplayGainAlbum.String()
ReplayGainTrack = player.ReplayGainTrack.String()
ReplayGainAuto = "Auto"
)
// The playback loop mode (LoopNone, LoopAll, LoopOne).
type LoopMode int
const (
LoopModeNone LoopMode = LoopMode(player.LoopNone)
LoopModeAll LoopMode = LoopMode(player.LoopAll)
LoopModeOne LoopMode = LoopMode(player.LoopOne)
LoopNone LoopMode = iota
LoopAll
LoopOne
)
// A high-level Subsonic-aware playback backend.
// Manages loading tracks into the Player queue,
// sending callbacks on play time updates and track changes.
// A high-level MediaProvider-aware playback engine, serves as an
// intermediary between the frontend and various Player backends.
type PlaybackManager struct {
ctx context.Context
cancelPollPos context.CancelFunc
pollingTick *time.Ticker
sm *ServerManager
player *player.Player
player player.BasePlayer
playTimeStopwatch util.Stopwatch
curTrackTime float64
@@ -43,7 +43,8 @@ type PlaybackManager struct {
callbacksDisabled bool
playQueue []*mediaprovider.Track
nowPlayingIdx int64
nowPlayingIdx int
loopMode LoopMode
// to pass to onSongChange listeners; clear once listeners have been called
lastScrobbled *mediaprovider.Track
@@ -51,59 +52,50 @@ type PlaybackManager struct {
transcodeCfg *TranscodingConfig
replayGainCfg ReplayGainConfig
// registered callbacks
onSongChange []func(nowPlaying, justScrobbledIfAny *mediaprovider.Track)
onPlayTimeUpdate []func(float64, float64)
onLoopModeChange []func(LoopMode)
onVolumeChange []func(int)
onSeek []func()
onPaused []func()
onStopped []func()
onPlaying []func()
onPlayerChange []func()
}
func NewPlaybackManager(
ctx context.Context,
s *ServerManager,
p *player.Player,
p player.BasePlayer,
scrobbleCfg *ScrobbleConfig,
transcodeCfg *TranscodingConfig,
) *PlaybackManager {
// clamp to 99% to avoid any possible rounding issues
scrobbleCfg.ThresholdPercent = clamp(scrobbleCfg.ThresholdPercent, 0, 99)
pm := &PlaybackManager{
ctx: ctx,
sm: s,
player: p,
scrobbleCfg: scrobbleCfg,
transcodeCfg: transcodeCfg,
ctx: ctx,
sm: s,
player: p,
scrobbleCfg: scrobbleCfg,
transcodeCfg: transcodeCfg,
nowPlayingIdx: -1,
}
p.OnTrackChange(func(tracknum int64) {
if tracknum >= int64(len(pm.playQueue)) {
return
}
pm.checkScrobble() // scrobble the previous song if needed
if pm.player.GetStatus().State == player.Playing {
pm.playTimeStopwatch.Start()
}
pm.nowPlayingIdx = tracknum
pm.curTrackTime = float64(pm.playQueue[pm.nowPlayingIdx].Duration)
pm.sendNowPlayingScrobble() // Must come before invokeOnChangeCallbacks b/c track may immediately be scrobbled
pm.invokeOnSongChangeCallbacks()
pm.doUpdateTimePos()
})
p.OnTrackChange(pm.handleOnTrackChange)
p.OnSeek(func() {
pm.doUpdateTimePos()
pm.invokeNoArgCallbacks(pm.onSeek)
})
p.OnStopped(func() {
pm.playTimeStopwatch.Stop()
pm.checkScrobble()
pm.stopPollTimePos()
pm.doUpdateTimePos()
pm.invokeOnSongChangeCallbacks()
})
p.OnStopped(pm.handleOnStopped)
p.OnPaused(func() {
pm.playTimeStopwatch.Stop()
pm.stopPollTimePos()
pm.invokeNoArgCallbacks(pm.onPaused)
})
p.OnPlaying(func() {
pm.playTimeStopwatch.Start()
pm.startPollTimePos()
pm.invokeNoArgCallbacks(pm.onPlaying)
})
s.OnLogout(func() {
@@ -113,6 +105,14 @@ func NewPlaybackManager(
return pm
}
func (p *PlaybackManager) CurrentPlayer() player.BasePlayer {
return p.player
}
func (p *PlaybackManager) OnPlayerChange(cb func()) {
p.onPlayerChange = append(p.onPlayerChange, cb)
}
func (p *PlaybackManager) IsSeeking() bool {
return p.player.IsSeeking()
}
@@ -155,6 +155,26 @@ func (p *PlaybackManager) OnVolumeChange(cb func(int)) {
p.onVolumeChange = append(p.onVolumeChange, cb)
}
// Registers a callback that is notified whenever the player has been seeked.
func (p *PlaybackManager) OnSeek(cb func()) {
p.onSeek = append(p.onSeek, cb)
}
// Registers a callback that is notified whenever the player has been paused.
func (p *PlaybackManager) OnPaused(cb func()) {
p.onPaused = append(p.onPaused, cb)
}
// Registers a callback that is notified whenever the player is stopped.
func (p *PlaybackManager) OnStopped(cb func()) {
p.onStopped = append(p.onStopped, cb)
}
// Registers a callback that is notified whenever the player begins playing.
func (p *PlaybackManager) OnPlaying(cb func()) {
p.onPlaying = append(p.onPlaying, cb)
}
// Loads the specified album into the play queue.
func (p *PlaybackManager) LoadAlbum(albumID string, appendToQueue bool, shuffle bool) error {
album, err := p.sm.Server.GetAlbum(albumID)
@@ -173,28 +193,29 @@ func (p *PlaybackManager) LoadPlaylist(playlistID string, appendToQueue bool, sh
return p.LoadTracks(playlist.Tracks, appendToQueue, shuffle)
}
// Load tracks into the play queue.
// If replacing the current queue (!appendToQueue), playback will be stopped.
func (p *PlaybackManager) LoadTracks(tracks []*mediaprovider.Track, appendToQueue, shuffle bool) error {
if !appendToQueue {
p.player.Stop()
p.nowPlayingIdx = 0
p.nowPlayingIdx = -1
p.playQueue = nil
}
nums := util.Range(len(tracks))
if shuffle {
rand.Shuffle(len(nums), func(i, j int) { nums[i], nums[j] = nums[j], nums[i] })
}
needToSetNext := appendToQueue && len(tracks) > 0 && p.nowPlayingIdx == len(p.playQueue)-1
for _, i := range nums {
url, err := p.sm.Server.GetStreamURL(tracks[i].ID, p.transcodeCfg.ForceRawFile)
if err != nil {
return err
}
p.player.AppendFile(url)
// ensure a deep copy of the track info so that we can maintain our own state
// (tracking play count increases, favorite, and rating) without messing up
// other views' track models
tr := *tracks[i]
p.playQueue = append(p.playQueue, &tr)
}
if needToSetNext {
p.setNextTrack(p.nowPlayingIdx + 1)
}
return nil
}
@@ -205,10 +226,7 @@ func (p *PlaybackManager) PlayAlbum(albumID string, firstTrack int, shuffle bool
if p.replayGainCfg.Mode == ReplayGainAuto {
p.SetReplayGainMode(player.ReplayGainAlbum)
}
if firstTrack <= 0 {
return p.player.PlayFromBeginning()
}
return p.player.PlayTrackAt(firstTrack)
return p.PlayTrackAt(firstTrack)
}
func (p *PlaybackManager) PlayPlaylist(playlistID string, firstTrack int, shuffle bool) error {
@@ -218,10 +236,7 @@ func (p *PlaybackManager) PlayPlaylist(playlistID string, firstTrack int, shuffl
if p.replayGainCfg.Mode == ReplayGainAuto {
p.SetReplayGainMode(player.ReplayGainTrack)
}
if firstTrack <= 0 {
return p.player.PlayFromBeginning()
}
return p.player.PlayTrackAt(firstTrack)
return p.PlayTrackAt(firstTrack)
}
func (p *PlaybackManager) PlayTrack(trackID string) error {
@@ -237,28 +252,32 @@ func (p *PlaybackManager) PlayTrack(trackID string) error {
}
func (p *PlaybackManager) PlayFromBeginning() error {
return p.player.PlayFromBeginning()
return p.PlayTrackAt(0)
}
func (p *PlaybackManager) PlayTrackAt(idx int) error {
return p.player.PlayTrackAt(idx)
if idx < 0 || idx >= len(p.playQueue) {
return errors.New("track index out of range")
}
p.nowPlayingIdx = idx - 1
return p.setTrack(idx, false)
}
func (p *PlaybackManager) PlayRandomSongs(genreName string) {
if songs, err := p.sm.Server.GetRandomTracks(genreName, 100); err != nil {
log.Printf("error getting random songs: %s", err.Error())
} else {
p.LoadTracks(songs, false, false)
if p.replayGainCfg.Mode == ReplayGainAuto {
p.SetReplayGainMode(player.ReplayGainTrack)
}
p.PlayFromBeginning()
}
p.fetchAndPlayTracks(func() ([]*mediaprovider.Track, error) {
return p.sm.Server.GetRandomTracks(genreName, 100)
})
}
func (p *PlaybackManager) PlaySimilarSongs(id string) {
if songs, err := p.sm.Server.GetSimilarTracks(id, 100); err != nil {
log.Printf("error getting similar songs: %s", err.Error())
p.fetchAndPlayTracks(func() ([]*mediaprovider.Track, error) {
return p.sm.Server.GetSimilarTracks(id, 100)
})
}
func (p *PlaybackManager) fetchAndPlayTracks(fetchFn func() ([]*mediaprovider.Track, error)) {
if songs, err := fetchFn(); err != nil {
log.Printf("error fetching tracks: %s", err.Error())
} else {
p.LoadTracks(songs, false, false)
if p.replayGainCfg.Mode == ReplayGainAuto {
@@ -295,23 +314,23 @@ func (p *PlaybackManager) OnTrackRatingChanged(id string, rating int) {
func (p *PlaybackManager) RemoveTracksFromQueue(trackIDs []string) {
newQueue := make([]*mediaprovider.Track, 0, len(p.playQueue)-len(trackIDs))
rmCount := 0
idSet := sharedutil.ToSet(trackIDs)
isPlayingTrackRemoved := false
isNextPlayingTrackremoved := false
nowPlaying := p.NowPlayingIndex()
newNowPlaying := nowPlaying
for i, tr := range p.playQueue {
if _, ok := idSet[tr.ID]; ok {
// removing this track
if i == p.NowPlayingIndex() {
if i < nowPlaying {
// if removing a track earlier than the currently playing one (if any),
// decrement new now playing index by one to account for new position in queue
newNowPlaying--
} else if i == nowPlaying {
isPlayingTrackRemoved = true
// If we are removing the currently playing track, we need to scrobble it
p.checkScrobble()
}
if err := p.player.RemoveTrackAt(i - rmCount); err == nil {
rmCount++
} else {
log.Printf("error removing track: %v", err.Error())
// did not remove this track
newQueue = append(newQueue, tr)
} else if nowPlaying >= 0 && i == nowPlaying+1 {
isNextPlayingTrackremoved = true
}
} else {
// not removing this track
@@ -319,28 +338,54 @@ func (p *PlaybackManager) RemoveTracksFromQueue(trackIDs []string) {
}
}
p.playQueue = newQueue
p.nowPlayingIdx = p.player.GetStatus().PlaylistPos
// fire on song change callbacks in case the playing track was removed
p.nowPlayingIdx = newNowPlaying
if isPlayingTrackRemoved {
p.invokeOnSongChangeCallbacks()
if newNowPlaying == len(newQueue) {
// we had been playing the last track, and removed it
p.Stop()
} else {
p.nowPlayingIdx -= 1 // will be incremented in newtrack callback from player
p.setTrack(newNowPlaying, false)
}
// setNextTrack and onSongChange callbacks will be handled
// when we receive new track event from player
} else if isNextPlayingTrackremoved {
if newNowPlaying < len(newQueue)-1 {
p.setNextTrack(p.nowPlayingIdx + 1)
} else {
// no next track to play
p.setNextTrack(-1)
}
}
}
// Stop playback and clear the play queue.
func (p *PlaybackManager) StopAndClearPlayQueue() {
p.player.Stop()
p.player.ClearPlayQueue()
p.doUpdateTimePos()
p.playQueue = nil
p.nowPlayingIdx = -1
}
func (p *PlaybackManager) SetReplayGainOptions(config ReplayGainConfig) {
p.replayGainCfg = config
mode := player.ReplayGainMode(config.Mode)
if config.Mode == ReplayGainAuto {
mode = player.ReplayGainTrack
rGainPlayer, ok := p.player.(player.ReplayGainPlayer)
if !ok {
log.Println("Error: player doesn't support ReplayGain")
return
}
p.player.SetReplayGainOptions(player.ReplayGainOptions{
p.replayGainCfg = config
mode := player.ReplayGainNone
switch config.Mode {
case ReplayGainAuto:
mode = player.ReplayGainTrack
case ReplayGainTrack:
mode = player.ReplayGainTrack
case ReplayGainAlbum:
mode = player.ReplayGainAlbum
}
rGainPlayer.SetReplayGainOptions(player.ReplayGainOptions{
Mode: mode,
PreventClipping: config.PreventClipping,
PreampGain: config.PreampGainDB,
@@ -348,7 +393,12 @@ func (p *PlaybackManager) SetReplayGainOptions(config ReplayGainConfig) {
}
func (p *PlaybackManager) SetReplayGainMode(mode player.ReplayGainMode) {
p.player.SetReplayGainOptions(player.ReplayGainOptions{
rGainPlayer, ok := p.player.(player.ReplayGainPlayer)
if !ok {
log.Println("Error: player doesn't support ReplayGain")
return
}
rGainPlayer.SetReplayGainOptions(player.ReplayGainOptions{
PreventClipping: p.replayGainCfg.PreventClipping,
PreampGain: p.replayGainCfg.PreampGainDB,
Mode: mode,
@@ -357,32 +407,33 @@ func (p *PlaybackManager) SetReplayGainMode(mode player.ReplayGainMode) {
// Changes the loop mode of the player to the next one.
// Useful for toggling UI elements, to change modes without knowing the current player mode.
func (p *PlaybackManager) SetNextLoopMode() error {
if err := p.player.SetNextLoopMode(); err != nil {
return err
}
func (p *PlaybackManager) SetNextLoopMode() {
switch p.loopMode {
case LoopNone:
p.SetLoopMode(LoopAll)
case LoopAll:
p.SetLoopMode(LoopOne)
case LoopOne:
p.SetLoopMode(LoopNone)
for _, cb := range p.onLoopModeChange {
cb(LoopMode(p.player.GetLoopMode()))
}
return nil
}
func (p *PlaybackManager) SetLoopMode(loopMode LoopMode) error {
if err := p.player.SetLoopMode(player.LoopMode(loopMode)); err != nil {
return err
}
func (p *PlaybackManager) SetLoopMode(loopMode LoopMode) {
p.loopMode = loopMode
p.setNextTrackBasedOnLoopMode(true)
for _, cb := range p.onLoopModeChange {
cb(loopMode)
}
return nil
}
func (p *PlaybackManager) LoopMode() LoopMode {
return LoopMode(p.player.GetLoopMode())
func (p *PlaybackManager) GetLoopMode() LoopMode {
return p.loopMode
}
func (p *PlaybackManager) PlayerStatus() player.Status {
return p.player.GetStatus()
}
func (p *PlaybackManager) SetVolume(vol int) error {
@@ -400,6 +451,143 @@ func (p *PlaybackManager) Volume() int {
return p.player.GetVolume()
}
func (p *PlaybackManager) SeekNext() error {
if p.CurrentPlayer().GetStatus().State == player.Stopped {
return nil
}
return p.PlayTrackAt(p.nowPlayingIdx + 1)
}
func (p *PlaybackManager) SeekBackOrPrevious() error {
if p.nowPlayingIdx == 0 || p.player.GetStatus().TimePos > 3 {
return p.player.SeekSeconds(0)
}
return p.PlayTrackAt(p.nowPlayingIdx - 1)
}
// Seek to given absolute position in the current track by seconds.
func (p *PlaybackManager) SeekSeconds(sec float64) error {
return p.player.SeekSeconds(sec)
}
// Seek to a fractional position in the current track [0..1]
func (p *PlaybackManager) SeekFraction(fraction float64) error {
if fraction < 0 {
fraction = 0
} else if fraction > 1 {
fraction = 1
}
target := p.curTrackTime * fraction
return p.player.SeekSeconds(target)
}
func (p *PlaybackManager) Stop() error {
return p.player.Stop()
}
func (p *PlaybackManager) Pause() error {
return p.player.Pause()
}
func (p *PlaybackManager) Continue() error {
if p.player.GetStatus().State == player.Stopped {
return p.PlayFromBeginning()
}
return p.player.Continue()
}
func (p *PlaybackManager) PlayPause() error {
switch p.player.GetStatus().State {
case player.Playing:
return p.player.Pause()
case player.Paused:
return p.player.Continue()
case player.Stopped:
return p.PlayFromBeginning()
}
return errors.New("unreached - invalid player state")
}
func (p *PlaybackManager) handleOnTrackChange() {
p.checkScrobble() // scrobble the previous song if needed
if p.player.GetStatus().State == player.Playing {
p.playTimeStopwatch.Start()
}
if p.loopMode != LoopOne {
p.nowPlayingIdx++
if p.loopMode == LoopAll && p.nowPlayingIdx == len(p.playQueue) {
p.nowPlayingIdx = 0 // wrapped around
}
}
p.curTrackTime = float64(p.playQueue[p.nowPlayingIdx].Duration)
p.sendNowPlayingScrobble() // Must come before invokeOnChangeCallbacks b/c track may immediately be scrobbled
p.invokeOnSongChangeCallbacks()
p.doUpdateTimePos()
p.setNextTrackBasedOnLoopMode(false)
}
func (p *PlaybackManager) handleOnStopped() {
p.playTimeStopwatch.Stop()
p.checkScrobble()
p.stopPollTimePos()
p.doUpdateTimePos()
p.invokeOnSongChangeCallbacks()
p.invokeNoArgCallbacks(p.onStopped)
p.nowPlayingIdx = -1
}
func (p *PlaybackManager) setNextTrackBasedOnLoopMode(onLoopModeChange bool) {
switch p.loopMode {
case LoopNone:
if p.nowPlayingIdx < len(p.playQueue)-1 {
p.setNextTrack(p.nowPlayingIdx + 1)
} else if onLoopModeChange {
// prev was LoopOne - need to erase next track
p.setNextTrack(-1)
}
case LoopOne:
p.setNextTrack(p.nowPlayingIdx)
case LoopAll:
if p.nowPlayingIdx >= len(p.playQueue)-1 {
p.setNextTrack(0)
} else if !onLoopModeChange {
// if onloopmodechange, prev mode was LoopNone and next track is already set
p.setNextTrack(p.nowPlayingIdx + 1)
}
}
}
func (p *PlaybackManager) setTrack(idx int, next bool) error {
if urlP, ok := p.player.(player.URLPlayer); ok {
url := ""
if idx >= 0 {
var err error
url, err = p.sm.Server.GetStreamURL(p.playQueue[idx].ID, p.transcodeCfg.ForceRawFile)
if err != nil {
return err
}
}
if next {
return urlP.SetNextFile(url)
}
return urlP.PlayFile(url)
} else if trP, ok := p.player.(player.TrackPlayer); ok {
var track *mediaprovider.Track
if idx >= 0 {
track = p.playQueue[idx]
}
if next {
return trP.SetNextTrack(track)
}
return trP.PlayTrack(track)
}
panic("Unsupported player type")
}
func (p *PlaybackManager) setNextTrack(idx int) error {
return p.setTrack(idx, true)
}
// call BEFORE updating p.nowPlayingIdx
func (p *PlaybackManager) checkScrobble() {
if !p.scrobbleCfg.Enabled || len(p.playQueue) == 0 || p.nowPlayingIdx < 0 {
@@ -450,26 +638,40 @@ func (p *PlaybackManager) invokeOnSongChangeCallbacks() {
p.lastScrobbled = nil
}
func (pm *PlaybackManager) invokeNoArgCallbacks(cbs []func()) {
if pm.callbacksDisabled {
return
}
for _, cb := range cbs {
cb()
}
}
func (p *PlaybackManager) startPollTimePos() {
ctx, cancel := context.WithCancel(p.ctx)
p.cancelPollPos = cancel
p.pollingTick = time.NewTicker(250 * time.Millisecond)
pollingTick := time.NewTicker(250 * time.Millisecond)
// TODO: fix occasional nil pointer dereference on app quit
go func() {
for {
select {
case <-ctx.Done():
p.pollingTick.Stop()
p.pollingTick = nil
pollingTick.Stop()
return
case <-p.pollingTick.C:
case <-pollingTick.C:
p.doUpdateTimePos()
}
}
}()
}
func (p *PlaybackManager) stopPollTimePos() {
if p.cancelPollPos != nil {
p.cancelPollPos()
p.cancelPollPos = nil
}
}
func (p *PlaybackManager) doUpdateTimePos() {
if p.callbacksDisabled {
return
@@ -482,13 +684,3 @@ func (p *PlaybackManager) doUpdateTimePos() {
cb(s.TimePos, s.Duration)
}
}
func (p *PlaybackManager) stopPollTimePos() {
if p.cancelPollPos != nil {
p.cancelPollPos()
p.cancelPollPos = nil
}
if p.pollingTick != nil {
p.pollingTick.Stop()
}
}