in progress MediaItem refactor - does not build

This commit is contained in:
Drew Weymouth
2024-05-31 09:35:46 -07:00
parent 403e1a19b5
commit f67a0c5fc1
10 changed files with 171 additions and 44 deletions
+79 -23
View File
@@ -48,7 +48,7 @@ type playbackEngine struct {
latestTrackPosition float64 // cleared by checkScrobble
callbacksDisabled bool
playQueue []*mediaprovider.Track
playQueue []mediaprovider.MediaItem
nowPlayingIdx int
wasStopped bool // true iff player was stopped before handleOnTrackChange invocation
loopMode LoopMode
@@ -60,7 +60,7 @@ type playbackEngine struct {
replayGainCfg ReplayGainConfig
// registered callbacks
onSongChange []func(nowPlaying, justScrobbledIfAny *mediaprovider.Track)
onSongChange []func(nowPlaying *NowPlayingMetadata, justScrobbledIfAny *mediaprovider.Track)
onPlayTimeUpdate []func(float64, float64, bool)
onLoopModeChange []func(LoopMode)
onVolumeChange []func(int)
@@ -123,7 +123,33 @@ func (p *playbackEngine) PlayTrackAt(idx int) error {
}
// Gets the curently playing song, if any.
func (p *playbackEngine) NowPlaying() *mediaprovider.Track {
func (p *playbackEngine) NowPlaying() *NowPlayingMetadata {
if p.nowPlayingIdx < 0 || len(p.playQueue) == 0 || p.player.GetStatus().State == player.Stopped {
return nil
}
item := p.playQueue[p.nowPlayingIdx]
if tr, ok := item.(*mediaprovider.Track); ok {
return &NowPlayingMetadata{
Type: MediaTypeTrack,
ID: tr.ID,
Title: tr.Name,
Artists: tr.ArtistNames,
ArtistIDs: tr.ArtistIDs,
Album: tr.Album,
AlbumID: tr.AlbumID,
Duration: float64(tr.Duration),
}
}
return &NowPlayingMetadata{
Type: MediaTypeRadioStation,
ID: item.MediaItemID(),
Title: item.MediaItemName(),
Duration: 0.0,
}
}
// Gets the curently playing song, if any.
func (p *playbackEngine) NowPlayingMediaItem() mediaprovider.MediaItem {
if p.nowPlayingIdx < 0 || len(p.playQueue) == 0 || p.player.GetStatus().State == player.Stopped {
return nil
}
@@ -216,7 +242,7 @@ func (p *playbackEngine) LoadTracks(tracks []*mediaprovider.Track, insertQueueMo
}
needToSetNext := len(tracks) > 0 && (insertQueueMode == InsertNext || (insertQueueMode == Append && p.nowPlayingIdx == len(p.playQueue)-1))
newTracks := p.deepCopyTrackSlice(tracks)
newTracks := p.copyTrackSliceToMediaItemSlice(tracks)
if shuffle {
rand.Shuffle(len(newTracks), func(i, j int) { newTracks[i], newTracks[j] = newTracks[j], newTracks[i] })
}
@@ -247,23 +273,27 @@ func (p *playbackEngine) StopAndClearPlayQueue() {
}
}
func (p *playbackEngine) GetPlayQueue() []*mediaprovider.Track {
func (p *playbackEngine) GetPlayQueue() []mediaprovider.MediaItem {
return p.deepCopyTrackSlice(p.playQueue)
}
// Any time the user changes the favorite status of a track elsewhere in the app,
// this should be called to ensure the in-memory track model is updated.
func (p *playbackEngine) OnTrackFavoriteStatusChanged(id string, fav bool) {
if tr := sharedutil.FindTrackByID(id, p.playQueue); tr != nil {
tr.Favorite = fav
if item := sharedutil.FindMediaItemByID(id, p.playQueue); item != nil {
if tr, ok := item.(*mediaprovider.Track); ok {
tr.Favorite = fav
}
}
}
// Any time the user changes the rating of a track elsewhere in the app,
// this should be called to ensure the in-memory track model is updated.
func (p *playbackEngine) OnTrackRatingChanged(id string, rating int) {
if tr := sharedutil.FindTrackByID(id, p.playQueue); tr != nil {
tr.Rating = rating
if item := sharedutil.FindMediaItemByID(id, p.playQueue); item != nil {
if tr, ok := item.(*mediaprovider.Track); ok {
tr.Rating = rating
}
}
}
@@ -271,12 +301,12 @@ func (p *playbackEngine) OnTrackRatingChanged(id string, rating int) {
// Does not stop playback if the currently playing track is in the new queue,
// but updates the now playing index to point to the first instance of the track in the new queue.
func (p *playbackEngine) UpdatePlayQueue(tracks []*mediaprovider.Track) error {
newQueue := p.deepCopyTrackSlice(tracks)
newQueue := p.copyTrackSliceToMediaItemSlice(tracks)
newNowPlayingIdx := -1
if p.nowPlayingIdx >= 0 {
nowPlayingID := p.playQueue[p.nowPlayingIdx].ID
nowPlayingID := p.playQueue[p.nowPlayingIdx].MediaItemID()
for i, tr := range newQueue {
if tr.ID == nowPlayingID {
if tr.MediaItemID() == nowPlayingID {
newNowPlayingIdx = i
break
}
@@ -298,14 +328,14 @@ func (p *playbackEngine) UpdatePlayQueue(tracks []*mediaprovider.Track) error {
}
func (p *playbackEngine) RemoveTracksFromQueue(trackIDs []string) {
newQueue := make([]*mediaprovider.Track, 0, len(p.playQueue)-len(trackIDs))
newQueue := make([]mediaprovider.MediaItem, 0, len(p.playQueue)-len(trackIDs))
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 {
if _, ok := idSet[tr.MediaItemID()]; ok {
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
@@ -396,7 +426,10 @@ func (p *playbackEngine) handleOnTrackChange() {
}
}
p.wasStopped = false
p.curTrackTime = float64(p.playQueue[p.nowPlayingIdx].Duration)
p.curTrackTime = 0
if tr, ok := p.playQueue[p.nowPlayingIdx].(*mediaprovider.Track); ok {
p.curTrackTime = float64(tr.Duration)
}
p.sendNowPlayingScrobble() // Must come before invokeOnChangeCallbacks b/c track may immediately be scrobbled
p.invokeOnSongChangeCallbacks()
p.doUpdateTimePos(false)
@@ -460,7 +493,12 @@ func (p *playbackEngine) setTrack(idx int, next bool) error {
url := ""
if idx >= 0 {
var err error
url, err = p.sm.Server.GetStreamURL(p.playQueue[idx].ID, p.transcodeCfg.ForceRawFile)
item := p.playQueue[idx]
if tr, ok := item.(*mediaprovider.Track); ok {
url, err = p.sm.Server.GetStreamURL(tr.ID, p.transcodeCfg.ForceRawFile)
} else {
url = item.(*mediaprovider.RadioStation).StreamURL
}
if err != nil {
return err
}
@@ -472,7 +510,10 @@ func (p *playbackEngine) setTrack(idx int, next bool) error {
} else if trP, ok := p.player.(player.TrackPlayer); ok {
var track *mediaprovider.Track
if idx >= 0 {
track = p.playQueue[idx]
track, ok = p.playQueue[idx].(*mediaprovider.Track)
if !ok {
return errors.New("cannot play non-Track media item with TrackPlayer")
}
}
if next {
return trP.SetNextTrack(track)
@@ -491,6 +532,11 @@ func (p *playbackEngine) checkScrobble() {
if !p.scrobbleCfg.Enabled || len(p.playQueue) == 0 || p.nowPlayingIdx < 0 {
return
}
track, ok := p.playQueue[p.nowPlayingIdx].(*mediaprovider.Track)
if !ok {
return // radio stations are not scrobbled
}
playDur := p.playTimeStopwatch.Elapsed()
if playDur.Seconds() < 0.1 || p.curTrackTime < 0.1 {
return
@@ -499,7 +545,6 @@ func (p *playbackEngine) checkScrobble() {
timeThresholdMet := p.scrobbleCfg.ThresholdTimeSeconds >= 0 &&
playDur.Seconds() >= float64(p.scrobbleCfg.ThresholdTimeSeconds)
track := p.playQueue[p.nowPlayingIdx]
var submission bool
server := p.sm.Server
if server.ClientDecidesScrobble() && (timeThresholdMet || pcnt >= float64(p.scrobbleCfg.ThresholdPercent)) {
@@ -516,7 +561,11 @@ func (p *playbackEngine) sendNowPlayingScrobble() {
if !p.scrobbleCfg.Enabled || len(p.playQueue) == 0 || p.nowPlayingIdx < 0 {
return
}
track := p.playQueue[p.nowPlayingIdx]
track, ok := p.playQueue[p.nowPlayingIdx].(*mediaprovider.Track)
if !ok {
return // radio stations are not scrobbled
}
server := p.sm.Server
if !server.ClientDecidesScrobble() {
// server will count track as scrobbled as soon as it starts playing
@@ -528,11 +577,18 @@ func (p *playbackEngine) sendNowPlayingScrobble() {
// creates a deep copy of the track info so that we can maintain our own state
// (play count increases, favorite, and rating) without messing up other views' track models
func (p *playbackEngine) deepCopyTrackSlice(tracks []*mediaprovider.Track) []*mediaprovider.Track {
newTracks := make([]*mediaprovider.Track, len(tracks))
func (p *playbackEngine) deepCopyTrackSlice(tracks []mediaprovider.MediaItem) []mediaprovider.MediaItem {
newTracks := make([]mediaprovider.MediaItem, len(tracks))
for i, tr := range tracks {
copy := *tr
newTracks[i] = &copy
newTracks[i] = tr.Copy()
}
return newTracks
}
func (p *playbackEngine) copyTrackSliceToMediaItemSlice(tracks []*mediaprovider.Track) []mediaprovider.MediaItem {
newTracks := make([]mediaprovider.MediaItem, len(tracks))
for i, tr := range tracks {
newTracks[i] = tr.Copy()
}
return newTracks
}