From 8819a9d478e6fc11dbfdcff80d9a2dc175953373 Mon Sep 17 00:00:00 2001 From: Ionut Andrei Oanca Date: Thu, 24 Sep 2020 23:04:21 +0200 Subject: Add playlist-sync and group-wait to SyncPlay --- .../SyncPlay/Queue/PlayQueueManager.cs | 596 +++++++++++++++++++++ 1 file changed, 596 insertions(+) create mode 100644 MediaBrowser.Controller/SyncPlay/Queue/PlayQueueManager.cs (limited to 'MediaBrowser.Controller/SyncPlay/Queue') diff --git a/MediaBrowser.Controller/SyncPlay/Queue/PlayQueueManager.cs b/MediaBrowser.Controller/SyncPlay/Queue/PlayQueueManager.cs new file mode 100644 index 0000000000..701982cc00 --- /dev/null +++ b/MediaBrowser.Controller/SyncPlay/Queue/PlayQueueManager.cs @@ -0,0 +1,596 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using MediaBrowser.Model.SyncPlay; + +namespace MediaBrowser.Controller.SyncPlay +{ + static class ListShuffleExtension + { + private static Random rng = new Random(); + public static void Shuffle(this IList list) + { + int n = list.Count; + while (n > 1) + { + n--; + int k = rng.Next(n + 1); + T value = list[k]; + list[k] = list[n]; + list[n] = value; + } + } + } + + /// + /// Class PlayQueueManager. + /// + public class PlayQueueManager : IDisposable + { + /// + /// Gets or sets the playing item index. + /// + /// The playing item index. + public int PlayingItemIndex { get; private set; } + + /// + /// Gets or sets the last time the queue has been changed. + /// + /// The last time the queue has been changed. + public DateTime LastChange { get; private set; } + + /// + /// Gets the sorted playlist. + /// + /// The sorted playlist, or play queue of the group. + private List SortedPlaylist { get; set; } = new List(); + + /// + /// Gets the shuffled playlist. + /// + /// The shuffled playlist, or play queue of the group. + private List ShuffledPlaylist { get; set; } = new List(); + + /// + /// Gets or sets the shuffle mode. + /// + /// The shuffle mode. + public GroupShuffleMode ShuffleMode { get; private set; } = GroupShuffleMode.Sorted; + + /// + /// Gets or sets the repeat mode. + /// + /// The repeat mode. + public GroupRepeatMode RepeatMode { get; private set; } = GroupRepeatMode.RepeatNone; + + /// + /// Gets or sets the progressive id counter. + /// + /// The progressive id. + private int ProgressiveId { get; set; } = 0; + + private bool _disposed = false; + + /// + /// Initializes a new instance of the class. + /// + public PlayQueueManager() + { + Reset(); + } + + /// + public void Dispose() + { + Dispose(true); + GC.SuppressFinalize(this); + } + + /// + /// Releases unmanaged and optionally managed resources. + /// + /// true to release both managed and unmanaged resources; false to release only unmanaged resources. + protected virtual void Dispose(bool disposing) + { + if (_disposed) + { + return; + } + + _disposed = true; + } + + /// + /// Gets the next available id. + /// + /// The next available id. + private int GetNextProgressiveId() { + return ProgressiveId++; + } + + /// + /// Creates a list from the array of items. Each item is given an unique playlist id. + /// + /// The list of queue items. + private List CreateQueueItemsFromArray(Guid[] items) + { + return items.ToList() + .Select(item => new QueueItem() + { + ItemId = item, + PlaylistItemId = "syncPlayItem" + GetNextProgressiveId() + }) + .ToList(); + } + + /// + /// Gets the current playlist, depending on the shuffle mode. + /// + /// The playlist. + private List GetPlaylistAsList() + { + if (ShuffleMode.Equals(GroupShuffleMode.Shuffle)) + { + return ShuffledPlaylist; + } + else + { + return SortedPlaylist; + } + } + + /// + /// Gets the current playlist as an array, depending on the shuffle mode. + /// + /// The array of items in the playlist. + public QueueItem[] GetPlaylist() { + if (ShuffleMode.Equals(GroupShuffleMode.Shuffle)) + { + return ShuffledPlaylist.ToArray(); + } + else + { + return SortedPlaylist.ToArray(); + } + } + + /// + /// Sets a new playlist. Playing item is set to none. Resets shuffle mode and repeat mode as well. + /// + /// The new items of the playlist. + public void SetPlaylist(Guid[] items) + { + SortedPlaylist = CreateQueueItemsFromArray(items); + PlayingItemIndex = -1; + ShuffleMode = GroupShuffleMode.Sorted; + RepeatMode = GroupRepeatMode.RepeatNone; + LastChange = DateTime.UtcNow; + } + + /// + /// Appends new items to the playlist. The specified order is mantained for the sorted playlist, whereas items get shuffled for the shuffled playlist. + /// + /// The items to add to the playlist. + public void Queue(Guid[] items) + { + var newItems = CreateQueueItemsFromArray(items); + SortedPlaylist.AddRange(newItems); + + if (ShuffleMode.Equals(GroupShuffleMode.Shuffle)) + { + newItems.Shuffle(); + ShuffledPlaylist.AddRange(newItems); + } + + LastChange = DateTime.UtcNow; + } + + /// + /// Shuffles the playlist. Shuffle mode is changed. + /// + public void ShufflePlaylist() + { + if (SortedPlaylist.Count() == 0) + { + return; + } + + if (PlayingItemIndex < 0) { + ShuffledPlaylist = SortedPlaylist.ToList(); + ShuffledPlaylist.Shuffle(); + } + else + { + var playingItem = SortedPlaylist[PlayingItemIndex]; + ShuffledPlaylist = SortedPlaylist.ToList(); + ShuffledPlaylist.RemoveAt(PlayingItemIndex); + ShuffledPlaylist.Shuffle(); + ShuffledPlaylist = ShuffledPlaylist.Prepend(playingItem).ToList(); + PlayingItemIndex = 0; + } + + ShuffleMode = GroupShuffleMode.Shuffle; + LastChange = DateTime.UtcNow; + } + + /// + /// Resets the playlist to sorted mode. Shuffle mode is changed. + /// + public void SortShuffledPlaylist() + { + if (PlayingItemIndex >= 0) + { + var playingItem = ShuffledPlaylist[PlayingItemIndex]; + PlayingItemIndex = SortedPlaylist.IndexOf(playingItem); + } + + ShuffledPlaylist.Clear(); + + ShuffleMode = GroupShuffleMode.Sorted; + LastChange = DateTime.UtcNow; + } + + /// + /// Clears the playlist. + /// + /// Whether to remove the playing item as well. + public void ClearPlaylist(bool clearPlayingItem) + { + var playingItem = SortedPlaylist[PlayingItemIndex]; + SortedPlaylist.Clear(); + ShuffledPlaylist.Clear(); + LastChange = DateTime.UtcNow; + + if (!clearPlayingItem && playingItem != null) + { + SortedPlaylist.Add(playingItem); + if (ShuffleMode.Equals(GroupShuffleMode.Shuffle)) + { + SortedPlaylist.Add(playingItem); + } + } + } + + /// + /// Adds new items to the playlist right after the playing item. The specified order is mantained for the sorted playlist, whereas items get shuffled for the shuffled playlist. + /// + /// The items to add to the playlist. + public void QueueNext(Guid[] items) + { + var newItems = CreateQueueItemsFromArray(items); + + if (ShuffleMode.Equals(GroupShuffleMode.Shuffle)) + { + // Append items to sorted playlist as they are + SortedPlaylist.AddRange(newItems); + // Shuffle items before adding to shuffled playlist + newItems.Shuffle(); + ShuffledPlaylist.InsertRange(PlayingItemIndex + 1, newItems); + } + else + { + SortedPlaylist.InsertRange(PlayingItemIndex + 1, newItems); + } + + LastChange = DateTime.UtcNow; + } + + /// + /// Gets playlist id of the playing item, if any. + /// + /// The playlist id of the playing item. + public string GetPlayingItemPlaylistId() + { + if (PlayingItemIndex < 0) + { + return null; + } + + var list = GetPlaylistAsList(); + + if (list.Count() > 0) + { + return list[PlayingItemIndex].PlaylistItemId; + } + else + { + return null; + } + } + + /// + /// Gets the playing item id, if any. + /// + /// The playing item id. + public Guid GetPlayingItemId() + { + if (PlayingItemIndex < 0) + { + return Guid.Empty; + } + + var list = GetPlaylistAsList(); + + if (list.Count() > 0) + { + return list[PlayingItemIndex].ItemId; + } + else + { + return Guid.Empty; + } + } + + /// + /// Sets the playing item using its id. If not in the playlist, the playing item is reset. + /// + /// The new playing item id. + public void SetPlayingItemById(Guid itemId) + { + var itemIds = GetPlaylistAsList().Select(queueItem => queueItem.ItemId).ToList(); + PlayingItemIndex = itemIds.IndexOf(itemId); + LastChange = DateTime.UtcNow; + } + + /// + /// Sets the playing item using its playlist id. If not in the playlist, the playing item is reset. + /// + /// The new playing item id. + /// true if playing item has been set; false if item is not in the playlist. + public bool SetPlayingItemByPlaylistId(string playlistItemId) + { + var playlistIds = GetPlaylistAsList().Select(queueItem => queueItem.PlaylistItemId).ToList(); + PlayingItemIndex = playlistIds.IndexOf(playlistItemId); + LastChange = DateTime.UtcNow; + return PlayingItemIndex != -1; + } + + /// + /// Sets the playing item using its position. If not in range, the playing item is reset. + /// + /// The new playing item index. + public void SetPlayingItemByIndex(int playlistIndex) + { + var list = GetPlaylistAsList(); + if (playlistIndex < 0 || playlistIndex > list.Count()) + { + PlayingItemIndex = -1; + } + else + { + PlayingItemIndex = playlistIndex; + } + + LastChange = DateTime.UtcNow; + } + + /// + /// Removes items from the playlist. If not removed, the playing item is preserved. + /// + /// The items to remove. + /// true if playing item got removed; false otherwise. + public bool RemoveFromPlaylist(string[] playlistItemIds) + { + var playingItem = SortedPlaylist[PlayingItemIndex]; + if (ShuffleMode.Equals(GroupShuffleMode.Shuffle)) + { + playingItem = ShuffledPlaylist[PlayingItemIndex]; + } + + var playlistItemIdsList = playlistItemIds.ToList(); + SortedPlaylist.RemoveAll(item => playlistItemIdsList.Contains(item.PlaylistItemId)); + ShuffledPlaylist.RemoveAll(item => playlistItemIdsList.Contains(item.PlaylistItemId)); + + LastChange = DateTime.UtcNow; + + if (playingItem != null) + { + if (playlistItemIds.Contains(playingItem.PlaylistItemId)) + { + // Playing item has been removed, picking previous item + PlayingItemIndex--; + if (PlayingItemIndex < 0) + { + // Was first element, picking next if available + PlayingItemIndex = SortedPlaylist.Count() > 0 ? 0 : -1; + } + + return true; + } + else + { + // Restoring playing item + SetPlayingItemByPlaylistId(playingItem.PlaylistItemId); + return false; + } + } + else + { + return false; + } + } + + /// + /// Moves an item in the playlist to another position. + /// + /// The item to move. + /// The new position. + /// true if the item has been moved; false otherwise. + public bool MovePlaylistItem(string playlistItemId, int newIndex) + { + var list = GetPlaylistAsList(); + var playingItem = list[PlayingItemIndex]; + + var playlistIds = list.Select(queueItem => queueItem.PlaylistItemId).ToList(); + var oldIndex = playlistIds.IndexOf(playlistItemId); + if (oldIndex < 0) { + return false; + } + + var queueItem = list[oldIndex]; + list.RemoveAt(oldIndex); + newIndex = newIndex > list.Count() ? list.Count() : newIndex; + newIndex = newIndex < 0 ? 0 : newIndex; + list.Insert(newIndex, queueItem); + + LastChange = DateTime.UtcNow; + PlayingItemIndex = list.IndexOf(playingItem); + return true; + } + + /// + /// Resets the playlist to its initial state. + /// + public void Reset() + { + ProgressiveId = 0; + SortedPlaylist.Clear(); + ShuffledPlaylist.Clear(); + PlayingItemIndex = -1; + ShuffleMode = GroupShuffleMode.Sorted; + RepeatMode = GroupRepeatMode.RepeatNone; + LastChange = DateTime.UtcNow; + } + + /// + /// Sets the repeat mode. + /// + /// The new mode. + public void SetRepeatMode(string mode) + { + switch (mode) + { + case "RepeatOne": + RepeatMode = GroupRepeatMode.RepeatOne; + break; + case "RepeatAll": + RepeatMode = GroupRepeatMode.RepeatAll; + break; + default: + RepeatMode = GroupRepeatMode.RepeatNone; + break; + } + + LastChange = DateTime.UtcNow; + } + + /// + /// Sets the shuffle mode. + /// + /// The new mode. + public void SetShuffleMode(string mode) + { + switch (mode) + { + case "Shuffle": + ShufflePlaylist(); + break; + default: + SortShuffledPlaylist(); + break; + } + } + + /// + /// Toggles the shuffle mode between sorted and shuffled. + /// + public void ToggleShuffleMode() + { + SetShuffleMode(ShuffleMode.Equals(GroupShuffleMode.Shuffle) ? "Shuffle" : ""); + } + + /// + /// Gets the next item in the playlist considering repeat mode and shuffle mode. + /// + /// The next item in the playlist. + public QueueItem GetNextItemPlaylistId() + { + int newIndex; + var playlist = GetPlaylistAsList(); + + switch (RepeatMode) + { + case GroupRepeatMode.RepeatOne: + newIndex = PlayingItemIndex; + break; + case GroupRepeatMode.RepeatAll: + newIndex = PlayingItemIndex + 1; + if (newIndex >= playlist.Count()) + { + newIndex = 0; + } + break; + default: + newIndex = PlayingItemIndex + 1; + break; + } + + if (newIndex < 0 || newIndex >= playlist.Count()) + { + return null; + } + + return playlist[newIndex]; + } + + /// + /// Sets the next item in the queue as playing item. + /// + /// true if the playing item changed; false otherwise. + public bool Next() + { + if (RepeatMode.Equals(GroupRepeatMode.RepeatOne)) + { + LastChange = DateTime.UtcNow; + return true; + } + + PlayingItemIndex++; + if (PlayingItemIndex >= SortedPlaylist.Count()) + { + if (RepeatMode.Equals(GroupRepeatMode.RepeatAll)) + { + PlayingItemIndex = 0; + } + else + { + PlayingItemIndex--; + return false; + } + } + + LastChange = DateTime.UtcNow; + return true; + } + + /// + /// Sets the previous item in the queue as playing item. + /// + /// true if the playing item changed; false otherwise. + public bool Previous() + { + if (RepeatMode.Equals(GroupRepeatMode.RepeatOne)) + { + LastChange = DateTime.UtcNow; + return true; + } + + PlayingItemIndex--; + if (PlayingItemIndex < 0) + { + if (RepeatMode.Equals(GroupRepeatMode.RepeatAll)) + { + PlayingItemIndex = SortedPlaylist.Count() - 1; + } + else + { + PlayingItemIndex++; + return false; + } + } + + LastChange = DateTime.UtcNow; + return true; + } + } +} -- cgit v1.2.3 From 93cbf64f884688b667c5403412cb8193dadb251c Mon Sep 17 00:00:00 2001 From: Ionut Andrei Oanca Date: Wed, 21 Oct 2020 15:46:50 +0200 Subject: End comments with a period --- .../SyncPlay/GroupController.cs | 28 ++-- .../SyncPlay/GroupStates/AbstractGroupState.cs | 4 +- .../SyncPlay/GroupStates/IdleGroupState.cs | 12 +- .../SyncPlay/GroupStates/PausedGroupState.cs | 36 +++--- .../SyncPlay/GroupStates/PlayingGroupState.cs | 38 +++--- .../SyncPlay/GroupStates/WaitingGroupState.cs | 144 ++++++++++----------- .../SyncPlay/SyncPlayManager.cs | 8 +- .../SyncPlay/ISyncPlayManager.cs | 4 +- .../SyncPlay/Queue/PlayQueueManager.cs | 10 +- 9 files changed, 142 insertions(+), 142 deletions(-) (limited to 'MediaBrowser.Controller/SyncPlay/Queue') diff --git a/Emby.Server.Implementations/SyncPlay/GroupController.cs b/Emby.Server.Implementations/SyncPlay/GroupController.cs index ee2e9eb8f1..ff1340e46b 100644 --- a/Emby.Server.Implementations/SyncPlay/GroupController.cs +++ b/Emby.Server.Implementations/SyncPlay/GroupController.cs @@ -206,22 +206,22 @@ namespace Emby.Server.Implementations.SyncPlay var items = queue.ToList() .Select(item => _libraryManager.GetItemById(item)); - // Find the highest rating value, which becomes the required minimum for the user + // Find the highest rating value, which becomes the required minimum for the user. var MinParentalRatingAccessRequired = items .Select(item => item.InheritedParentalRatingValue) .Min(); - // Check ParentalRating access, user must have the minimum required access level + // Check ParentalRating access, user must have the minimum required access level. var hasParentalRatingAccess = !user.MaxParentalAgeRating.HasValue || MinParentalRatingAccessRequired <= user.MaxParentalAgeRating; - // Check that user has access to all required folders + // Check that user has access to all required folders. if (!user.HasPermission(PermissionKind.EnableAllFolders) && hasParentalRatingAccess) { - // Get list of items that are not accessible + // Get list of items that are not accessible. var blockedItems = items.Where(item => !HasAccessToItem(user, item)); - // We need the user to be able to access all items + // We need the user to be able to access all items. return !blockedItems.Any(); } @@ -235,14 +235,14 @@ namespace Emby.Server.Implementations.SyncPlay return true; } - // Get list of users + // Get list of users. var users = Participants.Values .Select(participant => _userManager.GetUserById(participant.Session.UserId)); - // Find problematic users + // Find problematic users. var usersWithNoAccess = users.Where(user => !HasAccessToQueue(user, queue)); - // All users must be able to access the queue + // All users must be able to access the queue. return !usersWithNoAccess.Any(); } @@ -268,7 +268,7 @@ namespace Emby.Server.Implementations.SyncPlay RunTimeTicks = session.FullNowPlayingItem.RunTimeTicks ?? 0; PositionTicks = session.PlayState.PositionTicks ?? 0; - // Mantain playstate + // Mantain playstate. var waitingState = new WaitingGroupState(_logger); waitingState.ResumePlaying = !session.PlayState.IsPaused; SetState(waitingState); @@ -503,13 +503,13 @@ namespace Emby.Server.Implementations.SyncPlay /// public bool SetPlayQueue(Guid[] playQueue, int playingItemPosition, long startPositionTicks) { - // Ignore on empty queue or invalid item position + // Ignore on empty queue or invalid item position. if (playQueue.Length < 1 || playingItemPosition >= playQueue.Length || playingItemPosition < 0) { return false; } - // Check is participants can access the new playing queue + // Check is participants can access the new playing queue. if (!AllUsersHaveAccessToQueue(playQueue)) { return false; @@ -577,13 +577,13 @@ namespace Emby.Server.Implementations.SyncPlay /// public bool AddToPlayQueue(Guid[] newItems, string mode) { - // Ignore on empty list + // Ignore on empty list. if (newItems.Length < 1) { return false; } - // Check is participants can access the new playing queue + // Check is participants can access the new playing queue. if (!AllUsersHaveAccessToQueue(newItems)) { return false; @@ -661,7 +661,7 @@ namespace Emby.Server.Implementations.SyncPlay { var currentTime = DateTime.UtcNow; var elapsedTime = currentTime - LastActivity; - // Event may happen during the delay added to account for latency + // Event may happen during the delay added to account for latency. startPositionTicks += elapsedTime.Ticks > 0 ? elapsedTime.Ticks : 0; } diff --git a/Emby.Server.Implementations/SyncPlay/GroupStates/AbstractGroupState.cs b/Emby.Server.Implementations/SyncPlay/GroupStates/AbstractGroupState.cs index 1f0cb42870..1eb1107721 100644 --- a/Emby.Server.Implementations/SyncPlay/GroupStates/AbstractGroupState.cs +++ b/Emby.Server.Implementations/SyncPlay/GroupStates/AbstractGroupState.cs @@ -35,7 +35,7 @@ namespace MediaBrowser.Controller.SyncPlay /// The cancellation token. protected void SendGroupStateUpdate(ISyncPlayStateContext context, IPlaybackGroupRequest reason, SessionInfo session, CancellationToken cancellationToken) { - // Notify relevant state change event + // Notify relevant state change event. var stateUpdate = new GroupStateUpdate() { State = GetGroupState(), @@ -200,7 +200,7 @@ namespace MediaBrowser.Controller.SyncPlay /// public virtual void HandleRequest(ISyncPlayStateContext context, GroupState prevState, PingGroupRequest request, SessionInfo session, CancellationToken cancellationToken) { - // Collected pings are used to account for network latency when unpausing playback + // Collected pings are used to account for network latency when unpausing playback. context.UpdatePing(session, request.Ping); } diff --git a/Emby.Server.Implementations/SyncPlay/GroupStates/IdleGroupState.cs b/Emby.Server.Implementations/SyncPlay/GroupStates/IdleGroupState.cs index d6b981c584..b8510715ac 100644 --- a/Emby.Server.Implementations/SyncPlay/GroupStates/IdleGroupState.cs +++ b/Emby.Server.Implementations/SyncPlay/GroupStates/IdleGroupState.cs @@ -18,7 +18,7 @@ namespace MediaBrowser.Controller.SyncPlay /// public IdleGroupState(ILogger logger) : base(logger) { - // Do nothing + // Do nothing. } /// @@ -36,13 +36,13 @@ namespace MediaBrowser.Controller.SyncPlay /// public override void SessionLeaving(ISyncPlayStateContext context, GroupState prevState, SessionInfo session, CancellationToken cancellationToken) { - // Do nothing + // Do nothing. } /// public override void HandleRequest(ISyncPlayStateContext context, GroupState prevState, PlayGroupRequest request, SessionInfo session, CancellationToken cancellationToken) { - // Change state + // Change state. var waitingState = new WaitingGroupState(_logger); context.SetState(waitingState); waitingState.HandleRequest(context, GetGroupState(), request, session, cancellationToken); @@ -51,7 +51,7 @@ namespace MediaBrowser.Controller.SyncPlay /// public override void HandleRequest(ISyncPlayStateContext context, GroupState prevState, UnpauseGroupRequest request, SessionInfo session, CancellationToken cancellationToken) { - // Change state + // Change state. var waitingState = new WaitingGroupState(_logger); context.SetState(waitingState); waitingState.HandleRequest(context, GetGroupState(), request, session, cancellationToken); @@ -90,7 +90,7 @@ namespace MediaBrowser.Controller.SyncPlay /// public override void HandleRequest(ISyncPlayStateContext context, GroupState prevState, NextTrackGroupRequest request, SessionInfo session, CancellationToken cancellationToken) { - // Change state + // Change state. var waitingState = new WaitingGroupState(_logger); context.SetState(waitingState); waitingState.HandleRequest(context, GetGroupState(), request, session, cancellationToken); @@ -99,7 +99,7 @@ namespace MediaBrowser.Controller.SyncPlay /// public override void HandleRequest(ISyncPlayStateContext context, GroupState prevState, PreviousTrackGroupRequest request, SessionInfo session, CancellationToken cancellationToken) { - // Change state + // Change state. var waitingState = new WaitingGroupState(_logger); context.SetState(waitingState); waitingState.HandleRequest(context, GetGroupState(), request, session, cancellationToken); diff --git a/Emby.Server.Implementations/SyncPlay/GroupStates/PausedGroupState.cs b/Emby.Server.Implementations/SyncPlay/GroupStates/PausedGroupState.cs index 39c0511d9f..f674ec7778 100644 --- a/Emby.Server.Implementations/SyncPlay/GroupStates/PausedGroupState.cs +++ b/Emby.Server.Implementations/SyncPlay/GroupStates/PausedGroupState.cs @@ -19,7 +19,7 @@ namespace MediaBrowser.Controller.SyncPlay /// public PausedGroupState(ILogger logger) : base(logger) { - // Do nothing + // Do nothing. } /// @@ -31,7 +31,7 @@ namespace MediaBrowser.Controller.SyncPlay /// public override void SessionJoined(ISyncPlayStateContext context, GroupState prevState, SessionInfo session, CancellationToken cancellationToken) { - // Wait for session to be ready + // Wait for session to be ready. var waitingState = new WaitingGroupState(_logger); context.SetState(waitingState); waitingState.SessionJoined(context, GetGroupState(), session, cancellationToken); @@ -40,13 +40,13 @@ namespace MediaBrowser.Controller.SyncPlay /// public override void SessionLeaving(ISyncPlayStateContext context, GroupState prevState, SessionInfo session, CancellationToken cancellationToken) { - // Do nothing + // Do nothing. } /// public override void HandleRequest(ISyncPlayStateContext context, GroupState prevState, PlayGroupRequest request, SessionInfo session, CancellationToken cancellationToken) { - // Change state + // Change state. var waitingState = new WaitingGroupState(_logger); context.SetState(waitingState); waitingState.HandleRequest(context, GetGroupState(), request, session, cancellationToken); @@ -55,7 +55,7 @@ namespace MediaBrowser.Controller.SyncPlay /// public override void HandleRequest(ISyncPlayStateContext context, GroupState prevState, UnpauseGroupRequest request, SessionInfo session, CancellationToken cancellationToken) { - // Change state + // Change state. var playingState = new PlayingGroupState(_logger); context.SetState(playingState); playingState.HandleRequest(context, GetGroupState(), request, session, cancellationToken); @@ -66,23 +66,23 @@ namespace MediaBrowser.Controller.SyncPlay { if (!prevState.Equals(GetGroupState())) { - // Pause group and compute the media playback position + // Pause group and compute the media playback position. var currentTime = DateTime.UtcNow; var elapsedTime = currentTime - context.LastActivity; context.LastActivity = currentTime; - // Seek only if playback actually started - // Pause request may be issued during the delay added to account for latency + // Seek only if playback actually started. + // Pause request may be issued during the delay added to account for latency. context.PositionTicks += elapsedTime.Ticks > 0 ? elapsedTime.Ticks : 0; var command = context.NewSyncPlayCommand(SendCommandType.Pause); context.SendCommand(session, SyncPlayBroadcastType.AllGroup, command, cancellationToken); - // Notify relevant state change event + // Notify relevant state change event. SendGroupStateUpdate(context, request, session, cancellationToken); } else { - // Client got lost, sending current state + // Client got lost, sending current state. var command = context.NewSyncPlayCommand(SendCommandType.Pause); context.SendCommand(session, SyncPlayBroadcastType.CurrentSession, command, cancellationToken); } @@ -91,7 +91,7 @@ namespace MediaBrowser.Controller.SyncPlay /// public override void HandleRequest(ISyncPlayStateContext context, GroupState prevState, StopGroupRequest request, SessionInfo session, CancellationToken cancellationToken) { - // Change state + // Change state. var idleState = new IdleGroupState(_logger); context.SetState(idleState); idleState.HandleRequest(context, GetGroupState(), request, session, cancellationToken); @@ -100,7 +100,7 @@ namespace MediaBrowser.Controller.SyncPlay /// public override void HandleRequest(ISyncPlayStateContext context, GroupState prevState, SeekGroupRequest request, SessionInfo session, CancellationToken cancellationToken) { - // Change state + // Change state. var waitingState = new WaitingGroupState(_logger); context.SetState(waitingState); waitingState.HandleRequest(context, GetGroupState(), request, session, cancellationToken); @@ -109,7 +109,7 @@ namespace MediaBrowser.Controller.SyncPlay /// public override void HandleRequest(ISyncPlayStateContext context, GroupState prevState, BufferGroupRequest request, SessionInfo session, CancellationToken cancellationToken) { - // Change state + // Change state. var waitingState = new WaitingGroupState(_logger); context.SetState(waitingState); waitingState.HandleRequest(context, GetGroupState(), request, session, cancellationToken); @@ -120,17 +120,17 @@ namespace MediaBrowser.Controller.SyncPlay { if (prevState.Equals(GetGroupState())) { - // Client got lost, sending current state + // Client got lost, sending current state. var command = context.NewSyncPlayCommand(SendCommandType.Pause); context.SendCommand(session, SyncPlayBroadcastType.CurrentSession, command, cancellationToken); } else if (prevState.Equals(GroupState.Waiting)) { - // Sending current state to all clients + // Sending current state to all clients. var command = context.NewSyncPlayCommand(SendCommandType.Pause); context.SendCommand(session, SyncPlayBroadcastType.AllGroup, command, cancellationToken); - // Notify relevant state change event + // Notify relevant state change event. SendGroupStateUpdate(context, request, session, cancellationToken); } } @@ -138,7 +138,7 @@ namespace MediaBrowser.Controller.SyncPlay /// public override void HandleRequest(ISyncPlayStateContext context, GroupState prevState, NextTrackGroupRequest request, SessionInfo session, CancellationToken cancellationToken) { - // Change state + // Change state. var waitingState = new WaitingGroupState(_logger); context.SetState(waitingState); waitingState.HandleRequest(context, GetGroupState(), request, session, cancellationToken); @@ -147,7 +147,7 @@ namespace MediaBrowser.Controller.SyncPlay /// public override void HandleRequest(ISyncPlayStateContext context, GroupState prevState, PreviousTrackGroupRequest request, SessionInfo session, CancellationToken cancellationToken) { - // Change state + // Change state. var waitingState = new WaitingGroupState(_logger); context.SetState(waitingState); waitingState.HandleRequest(context, GetGroupState(), request, session, cancellationToken); diff --git a/Emby.Server.Implementations/SyncPlay/GroupStates/PlayingGroupState.cs b/Emby.Server.Implementations/SyncPlay/GroupStates/PlayingGroupState.cs index e2909ff91c..a3b0baf963 100644 --- a/Emby.Server.Implementations/SyncPlay/GroupStates/PlayingGroupState.cs +++ b/Emby.Server.Implementations/SyncPlay/GroupStates/PlayingGroupState.cs @@ -24,7 +24,7 @@ namespace MediaBrowser.Controller.SyncPlay /// public PlayingGroupState(ILogger logger) : base(logger) { - // Do nothing + // Do nothing. } /// @@ -36,7 +36,7 @@ namespace MediaBrowser.Controller.SyncPlay /// public override void SessionJoined(ISyncPlayStateContext context, GroupState prevState, SessionInfo session, CancellationToken cancellationToken) { - // Wait for session to be ready + // Wait for session to be ready. var waitingState = new WaitingGroupState(_logger); context.SetState(waitingState); waitingState.SessionJoined(context, GetGroupState(), session, cancellationToken); @@ -45,13 +45,13 @@ namespace MediaBrowser.Controller.SyncPlay /// public override void SessionLeaving(ISyncPlayStateContext context, GroupState prevState, SessionInfo session, CancellationToken cancellationToken) { - // Do nothing + // Do nothing. } /// public override void HandleRequest(ISyncPlayStateContext context, GroupState prevState, PlayGroupRequest request, SessionInfo session, CancellationToken cancellationToken) { - // Change state + // Change state. var waitingState = new WaitingGroupState(_logger); context.SetState(waitingState); waitingState.HandleRequest(context, GetGroupState(), request, session, cancellationToken); @@ -62,13 +62,13 @@ namespace MediaBrowser.Controller.SyncPlay { if (!prevState.Equals(GetGroupState())) { - // Pick a suitable time that accounts for latency + // Pick a suitable time that accounts for latency. var delayMillis = Math.Max(context.GetHighestPing() * 2, context.DefaultPing); - // Unpause group and set starting point in future - // Clients will start playback at LastActivity (datetime) from PositionTicks (playback position) - // The added delay does not guarantee, of course, that the command will be received in time - // Playback synchronization will mainly happen client side + // Unpause group and set starting point in future. + // Clients will start playback at LastActivity (datetime) from PositionTicks (playback position). + // The added delay does not guarantee, of course, that the command will be received in time. + // Playback synchronization will mainly happen client side. context.LastActivity = DateTime.UtcNow.AddMilliseconds( delayMillis ); @@ -76,12 +76,12 @@ namespace MediaBrowser.Controller.SyncPlay var command = context.NewSyncPlayCommand(SendCommandType.Unpause); context.SendCommand(session, SyncPlayBroadcastType.AllGroup, command, cancellationToken); - // Notify relevant state change event + // Notify relevant state change event. SendGroupStateUpdate(context, request, session, cancellationToken); } else { - // Client got lost, sending current state + // Client got lost, sending current state. var command = context.NewSyncPlayCommand(SendCommandType.Unpause); context.SendCommand(session, SyncPlayBroadcastType.CurrentSession, command, cancellationToken); } @@ -90,7 +90,7 @@ namespace MediaBrowser.Controller.SyncPlay /// public override void HandleRequest(ISyncPlayStateContext context, GroupState prevState, PauseGroupRequest request, SessionInfo session, CancellationToken cancellationToken) { - // Change state + // Change state. var pausedState = new PausedGroupState(_logger); context.SetState(pausedState); pausedState.HandleRequest(context, GetGroupState(), request, session, cancellationToken); @@ -99,7 +99,7 @@ namespace MediaBrowser.Controller.SyncPlay /// public override void HandleRequest(ISyncPlayStateContext context, GroupState prevState, StopGroupRequest request, SessionInfo session, CancellationToken cancellationToken) { - // Change state + // Change state. var idleState = new IdleGroupState(_logger); context.SetState(idleState); idleState.HandleRequest(context, GetGroupState(), request, session, cancellationToken); @@ -108,7 +108,7 @@ namespace MediaBrowser.Controller.SyncPlay /// public override void HandleRequest(ISyncPlayStateContext context, GroupState prevState, SeekGroupRequest request, SessionInfo session, CancellationToken cancellationToken) { - // Change state + // Change state. var waitingState = new WaitingGroupState(_logger); context.SetState(waitingState); waitingState.HandleRequest(context, GetGroupState(), request, session, cancellationToken); @@ -122,7 +122,7 @@ namespace MediaBrowser.Controller.SyncPlay return; } - // Change state + // Change state. var waitingState = new WaitingGroupState(_logger); context.SetState(waitingState); waitingState.HandleRequest(context, GetGroupState(), request, session, cancellationToken); @@ -133,13 +133,13 @@ namespace MediaBrowser.Controller.SyncPlay { if (prevState.Equals(GetGroupState())) { - // Group was not waiting, make sure client has latest state + // Group was not waiting, make sure client has latest state. var command = context.NewSyncPlayCommand(SendCommandType.Unpause); context.SendCommand(session, SyncPlayBroadcastType.CurrentSession, command, cancellationToken); } else if (prevState.Equals(GroupState.Waiting)) { - // Notify relevant state change event + // Notify relevant state change event. SendGroupStateUpdate(context, request, session, cancellationToken); } } @@ -147,7 +147,7 @@ namespace MediaBrowser.Controller.SyncPlay /// public override void HandleRequest(ISyncPlayStateContext context, GroupState prevState, NextTrackGroupRequest request, SessionInfo session, CancellationToken cancellationToken) { - // Change state + // Change state. var waitingState = new WaitingGroupState(_logger); context.SetState(waitingState); waitingState.HandleRequest(context, GetGroupState(), request, session, cancellationToken); @@ -156,7 +156,7 @@ namespace MediaBrowser.Controller.SyncPlay /// public override void HandleRequest(ISyncPlayStateContext context, GroupState prevState, PreviousTrackGroupRequest request, SessionInfo session, CancellationToken cancellationToken) { - // Change state + // Change state. var waitingState = new WaitingGroupState(_logger); context.SetState(waitingState); waitingState.HandleRequest(context, GetGroupState(), request, session, cancellationToken); diff --git a/Emby.Server.Implementations/SyncPlay/GroupStates/WaitingGroupState.cs b/Emby.Server.Implementations/SyncPlay/GroupStates/WaitingGroupState.cs index 9d839b268b..acf0161b4e 100644 --- a/Emby.Server.Implementations/SyncPlay/GroupStates/WaitingGroupState.cs +++ b/Emby.Server.Implementations/SyncPlay/GroupStates/WaitingGroupState.cs @@ -34,7 +34,7 @@ namespace MediaBrowser.Controller.SyncPlay /// public WaitingGroupState(ILogger logger) : base(logger) { - // Do nothing + // Do nothing. } /// @@ -46,7 +46,7 @@ namespace MediaBrowser.Controller.SyncPlay /// public override void SessionJoined(ISyncPlayStateContext context, GroupState prevState, SessionInfo session, CancellationToken cancellationToken) { - // Save state if first event + // Save state if first event. if (!InitialStateSet) { InitialState = prevState; @@ -55,23 +55,23 @@ namespace MediaBrowser.Controller.SyncPlay if (prevState.Equals(GroupState.Playing)) { ResumePlaying = true; - // Pause group and compute the media playback position + // Pause group and compute the media playback position. var currentTime = DateTime.UtcNow; var elapsedTime = currentTime - context.LastActivity; context.LastActivity = currentTime; - // Seek only if playback actually started - // Event may happen during the delay added to account for latency + // Seek only if playback actually started. + // Event may happen during the delay added to account for latency. context.PositionTicks += elapsedTime.Ticks > 0 ? elapsedTime.Ticks : 0; } - // Prepare new session + // Prepare new session. var playQueueUpdate = context.GetPlayQueueUpdate(PlayQueueUpdateReason.NewPlaylist); var update = context.NewSyncPlayGroupUpdate(GroupUpdateType.PlayQueue, playQueueUpdate); context.SendGroupUpdate(session, SyncPlayBroadcastType.CurrentSession, update, cancellationToken); context.SetBuffering(session, true); - // Send pause command to all non-buffering sessions + // Send pause command to all non-buffering sessions. var command = context.NewSyncPlayCommand(SendCommandType.Pause); context.SendCommand(session, SyncPlayBroadcastType.AllReady, command, cancellationToken); } @@ -79,7 +79,7 @@ namespace MediaBrowser.Controller.SyncPlay /// public override void SessionLeaving(ISyncPlayStateContext context, GroupState prevState, SessionInfo session, CancellationToken cancellationToken) { - // Save state if first event + // Save state if first event. if (!InitialStateSet) { InitialState = prevState; @@ -92,7 +92,7 @@ namespace MediaBrowser.Controller.SyncPlay { if (ResumePlaying) { - // Client, that was buffering, left the group + // Client, that was buffering, left the group. var playingState = new PlayingGroupState(_logger); context.SetState(playingState); var unpauseRequest = new UnpauseGroupRequest(); @@ -102,7 +102,7 @@ namespace MediaBrowser.Controller.SyncPlay } else { - // Group is ready, returning to previous state + // Group is ready, returning to previous state. var pausedState = new PausedGroupState(_logger); context.SetState(pausedState); @@ -114,7 +114,7 @@ namespace MediaBrowser.Controller.SyncPlay /// public override void HandleRequest(ISyncPlayStateContext context, GroupState prevState, PlayGroupRequest request, SessionInfo session, CancellationToken cancellationToken) { - // Save state if first event + // Save state if first event. if (!InitialStateSet) { InitialState = prevState; @@ -128,7 +128,7 @@ namespace MediaBrowser.Controller.SyncPlay { _logger.LogError("HandleRequest: {0} in group {1}, unable to set playing queue.", request.GetRequestType(), context.GroupId.ToString()); - // Ignore request and return to previous state + // Ignore request and return to previous state. ISyncPlayState newState; switch (prevState) { @@ -151,7 +151,7 @@ namespace MediaBrowser.Controller.SyncPlay var update = context.NewSyncPlayGroupUpdate(GroupUpdateType.PlayQueue, playQueueUpdate); context.SendGroupUpdate(session, SyncPlayBroadcastType.AllGroup, update, cancellationToken); - // Reset status of sessions and await for all Ready events before sending Play command + // Reset status of sessions and await for all Ready events before sending Play command. context.SetAllBuffering(true); _logger.LogDebug("HandleRequest: {0} in group {1}, {2} set a new play queue.", request.GetRequestType(), context.GroupId.ToString(), session.Id.ToString()); @@ -160,7 +160,7 @@ namespace MediaBrowser.Controller.SyncPlay /// public override void HandleRequest(ISyncPlayStateContext context, GroupState prevState, SetPlaylistItemGroupRequest request, SessionInfo session, CancellationToken cancellationToken) { - // Save state if first event + // Save state if first event. if (!InitialStateSet) { InitialState = prevState; @@ -176,12 +176,12 @@ namespace MediaBrowser.Controller.SyncPlay var update = context.NewSyncPlayGroupUpdate(GroupUpdateType.PlayQueue, playQueueUpdate); context.SendGroupUpdate(session, SyncPlayBroadcastType.AllGroup, update, cancellationToken); - // Reset status of sessions and await for all Ready events before sending Play command + // Reset status of sessions and await for all Ready events before sending Play command. context.SetAllBuffering(true); } else { - // Return to old state + // Return to old state. ISyncPlayState newState; switch (prevState) { @@ -205,7 +205,7 @@ namespace MediaBrowser.Controller.SyncPlay /// public override void HandleRequest(ISyncPlayStateContext context, GroupState prevState, UnpauseGroupRequest request, SessionInfo session, CancellationToken cancellationToken) { - // Save state if first event + // Save state if first event. if (!InitialStateSet) { InitialState = prevState; @@ -221,7 +221,7 @@ namespace MediaBrowser.Controller.SyncPlay var update = context.NewSyncPlayGroupUpdate(GroupUpdateType.PlayQueue, playQueueUpdate); context.SendGroupUpdate(session, SyncPlayBroadcastType.AllGroup, update, cancellationToken); - // Reset status of sessions and await for all Ready events before sending Play command + // Reset status of sessions and await for all Ready events before sending Play command. context.SetAllBuffering(true); _logger.LogDebug("HandleRequest: {0} in group {1}, waiting for all ready events.", request.GetRequestType(), context.GroupId.ToString()); @@ -232,10 +232,10 @@ namespace MediaBrowser.Controller.SyncPlay { _logger.LogDebug("HandleRequest: {0} in group {1}, ignoring sessions that are not ready and forcing the playback to start.", request.GetRequestType(), context.GroupId.ToString()); - // An Unpause request is forcing the playback to start, ignoring sessions that are not ready + // An Unpause request is forcing the playback to start, ignoring sessions that are not ready. context.SetAllBuffering(false); - // Change state + // Change state. var playingState = new PlayingGroupState(_logger); playingState.IgnoreBuffering = true; context.SetState(playingState); @@ -243,10 +243,10 @@ namespace MediaBrowser.Controller.SyncPlay } else { - // Group would have gone to paused state, now will go to playing state when ready + // Group would have gone to paused state, now will go to playing state when ready. ResumePlaying = true; - // Notify relevant state change event + // Notify relevant state change event. SendGroupStateUpdate(context, request, session, cancellationToken); } } @@ -255,31 +255,31 @@ namespace MediaBrowser.Controller.SyncPlay /// public override void HandleRequest(ISyncPlayStateContext context, GroupState prevState, PauseGroupRequest request, SessionInfo session, CancellationToken cancellationToken) { - // Save state if first event + // Save state if first event. if (!InitialStateSet) { InitialState = prevState; InitialStateSet = true; } - // Wait for sessions to be ready, then switch to paused state + // Wait for sessions to be ready, then switch to paused state. ResumePlaying = false; - // Notify relevant state change event + // Notify relevant state change event. SendGroupStateUpdate(context, request, session, cancellationToken); } /// public override void HandleRequest(ISyncPlayStateContext context, GroupState prevState, StopGroupRequest request, SessionInfo session, CancellationToken cancellationToken) { - // Save state if first event + // Save state if first event. if (!InitialStateSet) { InitialState = prevState; InitialStateSet = true; } - // Change state + // Change state. var idleState = new IdleGroupState(_logger); context.SetState(idleState); idleState.HandleRequest(context, GetGroupState(), request, session, cancellationToken); @@ -288,7 +288,7 @@ namespace MediaBrowser.Controller.SyncPlay /// public override void HandleRequest(ISyncPlayStateContext context, GroupState prevState, SeekGroupRequest request, SessionInfo session, CancellationToken cancellationToken) { - // Save state if first event + // Save state if first event. if (!InitialStateSet) { InitialState = prevState; @@ -304,34 +304,34 @@ namespace MediaBrowser.Controller.SyncPlay ResumePlaying = false; } - // Sanitize PositionTicks + // Sanitize PositionTicks. var ticks = context.SanitizePositionTicks(request.PositionTicks); - // Seek + // Seek. context.PositionTicks = ticks; context.LastActivity = DateTime.UtcNow; var command = context.NewSyncPlayCommand(SendCommandType.Seek); context.SendCommand(session, SyncPlayBroadcastType.AllGroup, command, cancellationToken); - // Reset status of sessions and await for all Ready events before sending Play command + // Reset status of sessions and await for all Ready events before sending Play command. context.SetAllBuffering(true); - // Notify relevant state change event + // Notify relevant state change event. SendGroupStateUpdate(context, request, session, cancellationToken); } /// public override void HandleRequest(ISyncPlayStateContext context, GroupState prevState, BufferGroupRequest request, SessionInfo session, CancellationToken cancellationToken) { - // Save state if first event + // Save state if first event. if (!InitialStateSet) { InitialState = prevState; InitialStateSet = true; } - // Make sure the client is playing the correct item + // Make sure the client is playing the correct item. if (!request.PlaylistItemId.Equals(context.PlayQueue.GetPlayingItemPlaylistId())) { _logger.LogDebug("HandleRequest: {0} in group {1}, {2} has wrong playlist item.", request.GetRequestType(), context.GroupId.ToString(), session.Id.ToString()); @@ -346,60 +346,60 @@ namespace MediaBrowser.Controller.SyncPlay if (prevState.Equals(GroupState.Playing)) { - // Resume playback when all ready + // Resume playback when all ready. ResumePlaying = true; context.SetBuffering(session, true); - // Pause group and compute the media playback position + // Pause group and compute the media playback position. var currentTime = DateTime.UtcNow; var elapsedTime = currentTime - context.LastActivity; context.LastActivity = currentTime; context.PositionTicks += elapsedTime.Ticks > 0 ? elapsedTime.Ticks : 0; - // Send pause command to all non-buffering sessions + // Send pause command to all non-buffering sessions. var command = context.NewSyncPlayCommand(SendCommandType.Pause); context.SendCommand(session, SyncPlayBroadcastType.AllReady, command, cancellationToken); } else if (prevState.Equals(GroupState.Paused)) { - // Don't resume playback when all ready + // Don't resume playback when all ready. ResumePlaying = false; context.SetBuffering(session, true); - // Send pause command to buffering session + // Send pause command to buffering session. var command = context.NewSyncPlayCommand(SendCommandType.Pause); context.SendCommand(session, SyncPlayBroadcastType.CurrentSession, command, cancellationToken); } else if (prevState.Equals(GroupState.Waiting)) { - // Another session is now buffering + // Another session is now buffering. context.SetBuffering(session, true); if (!ResumePlaying) { - // Force update for this session that should be paused + // Force update for this session that should be paused. var command = context.NewSyncPlayCommand(SendCommandType.Pause); context.SendCommand(session, SyncPlayBroadcastType.CurrentSession, command, cancellationToken); } } - // Notify relevant state change event + // Notify relevant state change event. SendGroupStateUpdate(context, request, session, cancellationToken); } /// public override void HandleRequest(ISyncPlayStateContext context, GroupState prevState, ReadyGroupRequest request, SessionInfo session, CancellationToken cancellationToken) { - // Save state if first event + // Save state if first event. if (!InitialStateSet) { InitialState = prevState; InitialStateSet = true; } - // Make sure the client is playing the correct item + // Make sure the client is playing the correct item. if (!request.PlaylistItemId.Equals(context.PlayQueue.GetPlayingItemPlaylistId())) { _logger.LogDebug("HandleRequest: {0} in group {1}, {2} has wrong playlist item.", request.GetRequestType(), context.GroupId.ToString(), session.Id.ToString()); @@ -432,28 +432,28 @@ namespace MediaBrowser.Controller.SyncPlay if (ResumePlaying) { // Handle case where session reported as ready but in reality - // it has no clue of the real position nor the playback state + // it has no clue of the real position nor the playback state. if (!request.IsPlaying && Math.Abs(context.PositionTicks - requestTicks) > TimeSpan.FromSeconds(0.5).Ticks) { - // Session not ready at all + // Session not ready at all. context.SetBuffering(session, true); - // Correcting session's position + // Correcting session's position. var command = context.NewSyncPlayCommand(SendCommandType.Seek); context.SendCommand(session, SyncPlayBroadcastType.CurrentSession, command, cancellationToken); - // Notify relevant state change event + // Notify relevant state change event. SendGroupStateUpdate(context, request, session, cancellationToken); _logger.LogDebug("HandleRequest: {0} in group {1}, {2} got lost in time, correcting.", request.GetRequestType(), context.GroupId.ToString(), session.Id.ToString()); return; } - // Session is ready + // Session is ready. context.SetBuffering(session, false); if (context.IsBuffering()) { - // Others are still buffering, tell this client to pause when ready + // Others are still buffering, tell this client to pause when ready. var command = context.NewSyncPlayCommand(SendCommandType.Pause); var pauseAtTime = currentTime.AddTicks(delayTicks); command.When = context.DateToUTCString(pauseAtTime); @@ -463,11 +463,11 @@ namespace MediaBrowser.Controller.SyncPlay } else { - // If all ready, then start playback - // Let other clients resume as soon as the buffering client catches up + // If all ready, then start playback. + // Let other clients resume as soon as the buffering client catches up. if (delayTicks > context.GetHighestPing() * 2 * TimeSpan.TicksPerMillisecond) { - // Client that was buffering is recovering, notifying others to resume + // Client that was buffering is recovering, notifying others to resume. context.LastActivity = currentTime.AddTicks(delayTicks); var command = context.NewSyncPlayCommand(SendCommandType.Unpause); var filter = SyncPlayBroadcastType.AllExceptCurrentSession; @@ -482,7 +482,7 @@ namespace MediaBrowser.Controller.SyncPlay } else { - // Client, that was buffering, resumed playback but did not update others in time + // Client, that was buffering, resumed playback but did not update others in time. delayTicks = context.GetHighestPing() * 2 * TimeSpan.TicksPerMillisecond; delayTicks = delayTicks < context.DefaultPing ? context.DefaultPing : delayTicks; @@ -494,7 +494,7 @@ namespace MediaBrowser.Controller.SyncPlay _logger.LogDebug("HandleRequest: {0} in group {1}, {2} resumed playback but did not update others in time.", request.GetRequestType(), context.GroupId.ToString(), session.Id.ToString()); } - // Change state + // Change state. var playingState = new PlayingGroupState(_logger); context.SetState(playingState); playingState.HandleRequest(context, GetGroupState(), request, session, cancellationToken); @@ -502,35 +502,35 @@ namespace MediaBrowser.Controller.SyncPlay } else { - // Check that session is really ready, tollerate half second difference to account for player imperfections + // Check that session is really ready, tollerate half second difference to account for player imperfections. if (Math.Abs(context.PositionTicks - requestTicks) > TimeSpan.FromSeconds(0.5).Ticks) { - // Session still not ready + // Session still not ready. context.SetBuffering(session, true); - // Session is seeking to wrong position, correcting + // Session is seeking to wrong position, correcting. var command = context.NewSyncPlayCommand(SendCommandType.Seek); context.SendCommand(session, SyncPlayBroadcastType.CurrentSession, command, cancellationToken); - // Notify relevant state change event + // Notify relevant state change event. SendGroupStateUpdate(context, request, session, cancellationToken); _logger.LogDebug("HandleRequest: {0} in group {1}, {2} was seeking to wrong position, correcting.", request.GetRequestType(), context.GroupId.ToString(), session.Id.ToString()); return; } else { - // Session is ready + // Session is ready. context.SetBuffering(session, false); } if (!context.IsBuffering()) { - // Group is ready, returning to previous state + // Group is ready, returning to previous state. var pausedState = new PausedGroupState(_logger); context.SetState(pausedState); if (InitialState.Equals(GroupState.Playing)) { - // Group went from playing to waiting state and a pause request occured while waiting + // Group went from playing to waiting state and a pause request occured while waiting. var pauserequest = new PauseGroupRequest(); pausedState.HandleRequest(context, GetGroupState(), pauserequest, session, cancellationToken); } @@ -547,7 +547,7 @@ namespace MediaBrowser.Controller.SyncPlay /// public override void HandleRequest(ISyncPlayStateContext context, GroupState prevState, NextTrackGroupRequest request, SessionInfo session, CancellationToken cancellationToken) { - // Save state if first event + // Save state if first event. if (!InitialStateSet) { InitialState = prevState; @@ -556,7 +556,7 @@ namespace MediaBrowser.Controller.SyncPlay ResumePlaying = true; - // Make sure the client knows the playing item, to avoid duplicate requests + // Make sure the client knows the playing item, to avoid duplicate requests. if (!request.PlaylistItemId.Equals(context.PlayQueue.GetPlayingItemPlaylistId())) { _logger.LogDebug("HandleRequest: {0} in group {1}, client provided the wrong playlist id.", request.GetRequestType(), context.GroupId.ToString()); @@ -566,17 +566,17 @@ namespace MediaBrowser.Controller.SyncPlay var newItem = context.NextItemInQueue(); if (newItem) { - // Send playing-queue update + // Send playing-queue update. var playQueueUpdate = context.GetPlayQueueUpdate(PlayQueueUpdateReason.NextTrack); var update = context.NewSyncPlayGroupUpdate(GroupUpdateType.PlayQueue, playQueueUpdate); context.SendGroupUpdate(session, SyncPlayBroadcastType.AllGroup, update, cancellationToken); - // Reset status of sessions and await for all Ready events before sending Play command + // Reset status of sessions and await for all Ready events before sending Play command. context.SetAllBuffering(true); } else { - // Return to old state + // Return to old state. ISyncPlayState newState; switch (prevState) { @@ -600,7 +600,7 @@ namespace MediaBrowser.Controller.SyncPlay /// public override void HandleRequest(ISyncPlayStateContext context, GroupState prevState, PreviousTrackGroupRequest request, SessionInfo session, CancellationToken cancellationToken) { - // Save state if first event + // Save state if first event. if (!InitialStateSet) { InitialState = prevState; @@ -609,7 +609,7 @@ namespace MediaBrowser.Controller.SyncPlay ResumePlaying = true; - // Make sure the client knows the playing item, to avoid duplicate requests + // Make sure the client knows the playing item, to avoid duplicate requests. if (!request.PlaylistItemId.Equals(context.PlayQueue.GetPlayingItemPlaylistId())) { _logger.LogDebug("HandleRequest: {0} in group {1}, client provided the wrong playlist id.", request.GetRequestType(), context.GroupId.ToString()); @@ -619,17 +619,17 @@ namespace MediaBrowser.Controller.SyncPlay var newItem = context.PreviousItemInQueue(); if (newItem) { - // Send playing-queue update + // Send playing-queue update. var playQueueUpdate = context.GetPlayQueueUpdate(PlayQueueUpdateReason.PreviousTrack); var update = context.NewSyncPlayGroupUpdate(GroupUpdateType.PlayQueue, playQueueUpdate); context.SendGroupUpdate(session, SyncPlayBroadcastType.AllGroup, update, cancellationToken); - // Reset status of sessions and await for all Ready events before sending Play command + // Reset status of sessions and await for all Ready events before sending Play command. context.SetAllBuffering(true); } else { - // Return to old state + // Return to old state. ISyncPlayState newState; switch (prevState) { diff --git a/Emby.Server.Implementations/SyncPlay/SyncPlayManager.cs b/Emby.Server.Implementations/SyncPlay/SyncPlayManager.cs index a8e30a9eca..6e3b492498 100644 --- a/Emby.Server.Implementations/SyncPlay/SyncPlayManager.cs +++ b/Emby.Server.Implementations/SyncPlay/SyncPlayManager.cs @@ -135,7 +135,7 @@ namespace Emby.Server.Implementations.SyncPlay return; } - // TODO: probably remove this event, not used at the moment + // TODO: probably remove this event, not used at the moment. } private void OnSessionManagerPlaybackStart(object sender, PlaybackProgressEventArgs e) @@ -146,7 +146,7 @@ namespace Emby.Server.Implementations.SyncPlay return; } - // TODO: probably remove this event, not used at the moment + // TODO: probably remove this event, not used at the moment. } private void OnSessionManagerPlaybackStopped(object sender, PlaybackStopEventArgs e) @@ -157,7 +157,7 @@ namespace Emby.Server.Implementations.SyncPlay return; } - // TODO: probably remove this event, not used at the moment + // TODO: probably remove this event, not used at the moment. } private bool IsSessionInGroup(SessionInfo session) @@ -267,7 +267,7 @@ namespace Emby.Server.Implementations.SyncPlay /// public void LeaveGroup(SessionInfo session, CancellationToken cancellationToken) { - // TODO: determine what happens to users that are in a group and get their permissions revoked + // TODO: determine what happens to users that are in a group and get their permissions revoked. lock (_groupsLock) { _sessionToGroupMap.TryGetValue(session.Id, out var group); diff --git a/MediaBrowser.Controller/SyncPlay/ISyncPlayManager.cs b/MediaBrowser.Controller/SyncPlay/ISyncPlayManager.cs index 9bef3f5593..ae2b0fa50a 100644 --- a/MediaBrowser.Controller/SyncPlay/ISyncPlayManager.cs +++ b/MediaBrowser.Controller/SyncPlay/ISyncPlayManager.cs @@ -55,7 +55,7 @@ namespace MediaBrowser.Controller.SyncPlay /// /// The session. /// The group. - /// + /// Thrown when the user is in another group already. void AddSessionToGroup(SessionInfo session, ISyncPlayGroupController group); /// @@ -63,7 +63,7 @@ namespace MediaBrowser.Controller.SyncPlay /// /// The session. /// The group. - /// + /// Thrown when the user is not found in the specified group. void RemoveSessionFromGroup(SessionInfo session, ISyncPlayGroupController group); } } diff --git a/MediaBrowser.Controller/SyncPlay/Queue/PlayQueueManager.cs b/MediaBrowser.Controller/SyncPlay/Queue/PlayQueueManager.cs index 701982cc00..6b4f9401e2 100644 --- a/MediaBrowser.Controller/SyncPlay/Queue/PlayQueueManager.cs +++ b/MediaBrowser.Controller/SyncPlay/Queue/PlayQueueManager.cs @@ -261,9 +261,9 @@ namespace MediaBrowser.Controller.SyncPlay if (ShuffleMode.Equals(GroupShuffleMode.Shuffle)) { - // Append items to sorted playlist as they are + // Append items to sorted playlist as they are. SortedPlaylist.AddRange(newItems); - // Shuffle items before adding to shuffled playlist + // Shuffle items before adding to shuffled playlist. newItems.Shuffle(); ShuffledPlaylist.InsertRange(PlayingItemIndex + 1, newItems); } @@ -387,11 +387,11 @@ namespace MediaBrowser.Controller.SyncPlay { if (playlistItemIds.Contains(playingItem.PlaylistItemId)) { - // Playing item has been removed, picking previous item + // Playing item has been removed, picking previous item. PlayingItemIndex--; if (PlayingItemIndex < 0) { - // Was first element, picking next if available + // Was first element, picking next if available. PlayingItemIndex = SortedPlaylist.Count() > 0 ? 0 : -1; } @@ -399,7 +399,7 @@ namespace MediaBrowser.Controller.SyncPlay } else { - // Restoring playing item + // Restoring playing item. SetPlayingItemByPlaylistId(playingItem.PlaylistItemId); return false; } -- cgit v1.2.3 From 36fee4e60a033d8d785e62788aaf00999d497c58 Mon Sep 17 00:00:00 2001 From: Ionut Andrei Oanca Date: Wed, 21 Oct 2020 16:42:57 +0200 Subject: Minor fixes --- .../SyncPlay/GroupController.cs | 6 ++--- .../SyncPlay/GroupStates/PausedGroupState.cs | 2 +- .../SyncPlay/GroupStates/WaitingGroupState.cs | 20 ++++++++--------- .../SyncPlay/ISyncPlayController.cs | 2 +- .../SyncPlay/ISyncPlayManager.cs | 2 +- MediaBrowser.Controller/SyncPlay/ISyncPlayState.cs | 4 ++-- .../SyncPlay/ISyncPlayStateContext.cs | 18 +++++++-------- .../SyncPlay/PlaybackRequest/BufferGroupRequest.cs | 6 ++--- .../MovePlaylistItemGroupRequest.cs | 6 ++--- .../PlaybackRequest/NextTrackGroupRequest.cs | 4 ++-- .../SyncPlay/PlaybackRequest/PingGroupRequest.cs | 2 +- .../PlaybackRequest/PreviousTrackGroupRequest.cs | 4 ++-- .../SyncPlay/PlaybackRequest/ReadyGroupRequest.cs | 6 ++--- .../RemoveFromPlaylistGroupRequest.cs | 6 ++--- .../PlaybackRequest/SetCurrentItemGroupRequest.cs | 4 ++-- .../SyncPlay/Queue/PlayQueueManager.cs | 26 +++++++++++----------- MediaBrowser.Model/SyncPlay/GroupUpdateType.cs | 2 +- MediaBrowser.Model/SyncPlay/JoinGroupRequest.cs | 4 ++-- MediaBrowser.Model/SyncPlay/QueueItem.cs | 8 +++---- MediaBrowser.Model/SyncPlay/SendCommand.cs | 4 ++-- 20 files changed, 68 insertions(+), 68 deletions(-) (limited to 'MediaBrowser.Controller/SyncPlay/Queue') diff --git a/Emby.Server.Implementations/SyncPlay/GroupController.cs b/Emby.Server.Implementations/SyncPlay/GroupController.cs index ff1340e46b..26972de8aa 100644 --- a/Emby.Server.Implementations/SyncPlay/GroupController.cs +++ b/Emby.Server.Implementations/SyncPlay/GroupController.cs @@ -129,7 +129,7 @@ namespace Emby.Server.Implementations.SyncPlay /// /// Checks if a session is in this group. /// - /// The session id to check. + /// The session identifier to check. /// true if the session is in this group; false otherwise. private bool ContainsSession(string sessionId) { @@ -509,7 +509,7 @@ namespace Emby.Server.Implementations.SyncPlay return false; } - // Check is participants can access the new playing queue. + // Check if participants can access the new playing queue. if (!AllUsersHaveAccessToQueue(playQueue)) { return false; @@ -583,7 +583,7 @@ namespace Emby.Server.Implementations.SyncPlay return false; } - // Check is participants can access the new playing queue. + // Check if participants can access the new playing queue. if (!AllUsersHaveAccessToQueue(newItems)) { return false; diff --git a/Emby.Server.Implementations/SyncPlay/GroupStates/PausedGroupState.cs b/Emby.Server.Implementations/SyncPlay/GroupStates/PausedGroupState.cs index f674ec7778..8c4bd20b1c 100644 --- a/Emby.Server.Implementations/SyncPlay/GroupStates/PausedGroupState.cs +++ b/Emby.Server.Implementations/SyncPlay/GroupStates/PausedGroupState.cs @@ -72,7 +72,7 @@ namespace MediaBrowser.Controller.SyncPlay context.LastActivity = currentTime; // Seek only if playback actually started. // Pause request may be issued during the delay added to account for latency. - context.PositionTicks += elapsedTime.Ticks > 0 ? elapsedTime.Ticks : 0; + context.PositionTicks += Math.Max(elapsedTime.Ticks, 0); var command = context.NewSyncPlayCommand(SendCommandType.Pause); context.SendCommand(session, SyncPlayBroadcastType.AllGroup, command, cancellationToken); diff --git a/Emby.Server.Implementations/SyncPlay/GroupStates/WaitingGroupState.cs b/Emby.Server.Implementations/SyncPlay/GroupStates/WaitingGroupState.cs index acf0161b4e..ff1d379d77 100644 --- a/Emby.Server.Implementations/SyncPlay/GroupStates/WaitingGroupState.cs +++ b/Emby.Server.Implementations/SyncPlay/GroupStates/WaitingGroupState.cs @@ -61,7 +61,7 @@ namespace MediaBrowser.Controller.SyncPlay context.LastActivity = currentTime; // Seek only if playback actually started. // Event may happen during the delay added to account for latency. - context.PositionTicks += elapsedTime.Ticks > 0 ? elapsedTime.Ticks : 0; + context.PositionTicks += Math.Max(elapsedTime.Ticks, 0); } // Prepare new session. @@ -151,7 +151,7 @@ namespace MediaBrowser.Controller.SyncPlay var update = context.NewSyncPlayGroupUpdate(GroupUpdateType.PlayQueue, playQueueUpdate); context.SendGroupUpdate(session, SyncPlayBroadcastType.AllGroup, update, cancellationToken); - // Reset status of sessions and await for all Ready events before sending Play command. + // Reset status of sessions and await for all Ready events. context.SetAllBuffering(true); _logger.LogDebug("HandleRequest: {0} in group {1}, {2} set a new play queue.", request.GetRequestType(), context.GroupId.ToString(), session.Id.ToString()); @@ -176,7 +176,7 @@ namespace MediaBrowser.Controller.SyncPlay var update = context.NewSyncPlayGroupUpdate(GroupUpdateType.PlayQueue, playQueueUpdate); context.SendGroupUpdate(session, SyncPlayBroadcastType.AllGroup, update, cancellationToken); - // Reset status of sessions and await for all Ready events before sending Play command. + // Reset status of sessions and await for all Ready events. context.SetAllBuffering(true); } else @@ -221,7 +221,7 @@ namespace MediaBrowser.Controller.SyncPlay var update = context.NewSyncPlayGroupUpdate(GroupUpdateType.PlayQueue, playQueueUpdate); context.SendGroupUpdate(session, SyncPlayBroadcastType.AllGroup, update, cancellationToken); - // Reset status of sessions and await for all Ready events before sending Play command. + // Reset status of sessions and await for all Ready events. context.SetAllBuffering(true); _logger.LogDebug("HandleRequest: {0} in group {1}, waiting for all ready events.", request.GetRequestType(), context.GroupId.ToString()); @@ -314,7 +314,7 @@ namespace MediaBrowser.Controller.SyncPlay var command = context.NewSyncPlayCommand(SendCommandType.Seek); context.SendCommand(session, SyncPlayBroadcastType.AllGroup, command, cancellationToken); - // Reset status of sessions and await for all Ready events before sending Play command. + // Reset status of sessions and await for all Ready events. context.SetAllBuffering(true); // Notify relevant state change event. @@ -355,7 +355,7 @@ namespace MediaBrowser.Controller.SyncPlay var currentTime = DateTime.UtcNow; var elapsedTime = currentTime - context.LastActivity; context.LastActivity = currentTime; - context.PositionTicks += elapsedTime.Ticks > 0 ? elapsedTime.Ticks : 0; + context.PositionTicks += Math.Max(elapsedTime.Ticks, 0); // Send pause command to all non-buffering sessions. var command = context.NewSyncPlayCommand(SendCommandType.Pause); @@ -559,7 +559,7 @@ namespace MediaBrowser.Controller.SyncPlay // Make sure the client knows the playing item, to avoid duplicate requests. if (!request.PlaylistItemId.Equals(context.PlayQueue.GetPlayingItemPlaylistId())) { - _logger.LogDebug("HandleRequest: {0} in group {1}, client provided the wrong playlist id.", request.GetRequestType(), context.GroupId.ToString()); + _logger.LogDebug("HandleRequest: {0} in group {1}, client provided the wrong playlist identifier.", request.GetRequestType(), context.GroupId.ToString()); return; } @@ -571,7 +571,7 @@ namespace MediaBrowser.Controller.SyncPlay var update = context.NewSyncPlayGroupUpdate(GroupUpdateType.PlayQueue, playQueueUpdate); context.SendGroupUpdate(session, SyncPlayBroadcastType.AllGroup, update, cancellationToken); - // Reset status of sessions and await for all Ready events before sending Play command. + // Reset status of sessions and await for all Ready events. context.SetAllBuffering(true); } else @@ -612,7 +612,7 @@ namespace MediaBrowser.Controller.SyncPlay // Make sure the client knows the playing item, to avoid duplicate requests. if (!request.PlaylistItemId.Equals(context.PlayQueue.GetPlayingItemPlaylistId())) { - _logger.LogDebug("HandleRequest: {0} in group {1}, client provided the wrong playlist id.", request.GetRequestType(), context.GroupId.ToString()); + _logger.LogDebug("HandleRequest: {0} in group {1}, client provided the wrong playlist identifier.", request.GetRequestType(), context.GroupId.ToString()); return; } @@ -624,7 +624,7 @@ namespace MediaBrowser.Controller.SyncPlay var update = context.NewSyncPlayGroupUpdate(GroupUpdateType.PlayQueue, playQueueUpdate); context.SendGroupUpdate(session, SyncPlayBroadcastType.AllGroup, update, cancellationToken); - // Reset status of sessions and await for all Ready events before sending Play command. + // Reset status of sessions and await for all Ready events. context.SetAllBuffering(true); } else diff --git a/MediaBrowser.Controller/SyncPlay/ISyncPlayController.cs b/MediaBrowser.Controller/SyncPlay/ISyncPlayController.cs index 9a4e1ee1ee..2f497ebbb9 100644 --- a/MediaBrowser.Controller/SyncPlay/ISyncPlayController.cs +++ b/MediaBrowser.Controller/SyncPlay/ISyncPlayController.cs @@ -26,7 +26,7 @@ namespace MediaBrowser.Controller.SyncPlay /// /// Checks if the group is empty. /// - /// If the group is empty. + /// true if the group is empty, false otherwise bool IsGroupEmpty(); /// diff --git a/MediaBrowser.Controller/SyncPlay/ISyncPlayManager.cs b/MediaBrowser.Controller/SyncPlay/ISyncPlayManager.cs index ae2b0fa50a..ec13686c64 100644 --- a/MediaBrowser.Controller/SyncPlay/ISyncPlayManager.cs +++ b/MediaBrowser.Controller/SyncPlay/ISyncPlayManager.cs @@ -23,7 +23,7 @@ namespace MediaBrowser.Controller.SyncPlay /// Adds the session to a group. /// /// The session. - /// The group id. + /// The group identifier. /// The request. /// The cancellation token. void JoinGroup(SessionInfo session, Guid groupId, JoinGroupRequest request, CancellationToken cancellationToken); diff --git a/MediaBrowser.Controller/SyncPlay/ISyncPlayState.cs b/MediaBrowser.Controller/SyncPlay/ISyncPlayState.cs index 290576e30f..218e871e36 100644 --- a/MediaBrowser.Controller/SyncPlay/ISyncPlayState.cs +++ b/MediaBrowser.Controller/SyncPlay/ISyncPlayState.cs @@ -16,7 +16,7 @@ namespace MediaBrowser.Controller.SyncPlay GroupState GetGroupState(); /// - /// Handle a session that joined the group. + /// Handles a session that joined the group. /// /// The context of the state. /// The previous state. @@ -25,7 +25,7 @@ namespace MediaBrowser.Controller.SyncPlay void SessionJoined(ISyncPlayStateContext context, GroupState prevState, SessionInfo session, CancellationToken cancellationToken); /// - /// Handle a session that is leaving the group. + /// Handles a session that is leaving the group. /// /// The context of the state. /// The previous state. diff --git a/MediaBrowser.Controller/SyncPlay/ISyncPlayStateContext.cs b/MediaBrowser.Controller/SyncPlay/ISyncPlayStateContext.cs index 18a6857491..13d38a02bb 100644 --- a/MediaBrowser.Controller/SyncPlay/ISyncPlayStateContext.cs +++ b/MediaBrowser.Controller/SyncPlay/ISyncPlayStateContext.cs @@ -71,7 +71,7 @@ namespace MediaBrowser.Controller.SyncPlay /// Builds a new playback command with some default values. /// /// The command type. - /// The SendCommand. + /// The command. SendCommand NewSyncPlayCommand(SendCommandType type); /// @@ -79,7 +79,7 @@ namespace MediaBrowser.Controller.SyncPlay /// /// The update type. /// The data to send. - /// The GroupUpdate. + /// The group update. GroupUpdate NewSyncPlayGroupUpdate(GroupUpdateType type, T data); /// @@ -93,7 +93,7 @@ namespace MediaBrowser.Controller.SyncPlay /// Sanitizes the PositionTicks, considers the current playing item when available. /// /// The PositionTicks. - /// The sanitized PositionTicks. + /// The sanitized position ticks. long SanitizePositionTicks(long? positionTicks); /// @@ -141,14 +141,14 @@ namespace MediaBrowser.Controller.SyncPlay /// The new play queue. /// The playing item position in the play queue. /// The start position ticks. - /// true if the play queue has been changed; false is something went wrong. + /// true if the play queue has been changed; false if something went wrong. bool SetPlayQueue(Guid[] playQueue, int playingItemPosition, long startPositionTicks); /// /// Sets the playing item. /// - /// The new playing item id. - /// true if the play queue has been changed; false is something went wrong. + /// The new playing item identifier. + /// true if the play queue has been changed; false if something went wrong. bool SetPlayingItem(string playlistItemId); /// @@ -161,9 +161,9 @@ namespace MediaBrowser.Controller.SyncPlay /// /// Moves an item in the play queue. /// - /// The playlist id of the item to move. + /// The playlist identifier of the item to move. /// The new position. - /// true if item has been moved; false is something went wrong. + /// true if item has been moved; false if something went wrong. bool MoveItemInPlayQueue(string playlistItemId, int newIndex); /// @@ -171,7 +171,7 @@ namespace MediaBrowser.Controller.SyncPlay /// /// The new items to add to the play queue. /// The mode with which the items will be added. - /// true if the play queue has been changed; false is something went wrong. + /// true if the play queue has been changed; false if something went wrong. bool AddToPlayQueue(Guid[] newItems, string mode); /// diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/BufferGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequest/BufferGroupRequest.cs index 0815dd79b2..65fced43f1 100644 --- a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/BufferGroupRequest.cs +++ b/MediaBrowser.Controller/SyncPlay/PlaybackRequest/BufferGroupRequest.cs @@ -6,7 +6,7 @@ using MediaBrowser.Controller.Session; namespace MediaBrowser.Controller.SyncPlay { /// - /// Class BufferingGroupRequest. + /// Class BufferGroupRequest. /// public class BufferGroupRequest : IPlaybackGroupRequest { @@ -29,9 +29,9 @@ namespace MediaBrowser.Controller.SyncPlay public bool IsPlaying { get; set; } /// - /// Gets or sets the playlist item id of the playing item. + /// Gets or sets the playlist item identifier of the playing item. /// - /// The playlist item id. + /// The playlist item identifier. public string PlaylistItemId { get; set; } /// diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/MovePlaylistItemGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequest/MovePlaylistItemGroupRequest.cs index 7a293c02fd..38170facf0 100644 --- a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/MovePlaylistItemGroupRequest.cs +++ b/MediaBrowser.Controller/SyncPlay/PlaybackRequest/MovePlaylistItemGroupRequest.cs @@ -10,9 +10,9 @@ namespace MediaBrowser.Controller.SyncPlay public class MovePlaylistItemGroupRequest : IPlaybackGroupRequest { /// - /// Gets or sets the playlist id of the item. + /// Gets or sets the playlist identifier of the item. /// - /// The playlist id of the item. + /// The playlist identifier of the item. public string PlaylistItemId { get; set; } /// @@ -24,7 +24,7 @@ namespace MediaBrowser.Controller.SyncPlay /// public PlaybackRequestType GetRequestType() { - return PlaybackRequestType.Queue; + return PlaybackRequestType.MovePlaylistItem; } /// diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/NextTrackGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequest/NextTrackGroupRequest.cs index d19df2c6a0..b27c10f169 100644 --- a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/NextTrackGroupRequest.cs +++ b/MediaBrowser.Controller/SyncPlay/PlaybackRequest/NextTrackGroupRequest.cs @@ -10,9 +10,9 @@ namespace MediaBrowser.Controller.SyncPlay public class NextTrackGroupRequest : IPlaybackGroupRequest { /// - /// Gets or sets the playing item id. + /// Gets or sets the playing item identifier. /// - /// The playing item id. + /// The playing item identifier. public string PlaylistItemId { get; set; } /// diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/PingGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequest/PingGroupRequest.cs index 631bf245b1..5605578d75 100644 --- a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/PingGroupRequest.cs +++ b/MediaBrowser.Controller/SyncPlay/PlaybackRequest/PingGroupRequest.cs @@ -5,7 +5,7 @@ using MediaBrowser.Controller.Session; namespace MediaBrowser.Controller.SyncPlay { /// - /// Class UpdatePingGroupRequest. + /// Class PingGroupRequest. /// public class PingGroupRequest : IPlaybackGroupRequest { diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/PreviousTrackGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequest/PreviousTrackGroupRequest.cs index 663011b429..31b93b9675 100644 --- a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/PreviousTrackGroupRequest.cs +++ b/MediaBrowser.Controller/SyncPlay/PlaybackRequest/PreviousTrackGroupRequest.cs @@ -10,9 +10,9 @@ namespace MediaBrowser.Controller.SyncPlay public class PreviousTrackGroupRequest : IPlaybackGroupRequest { /// - /// Gets or sets the playing item id. + /// Gets or sets the playing item identifier. /// - /// The playing item id. + /// The playing item identifier. public string PlaylistItemId { get; set; } /// diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/ReadyGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequest/ReadyGroupRequest.cs index 16bc67c617..8f266ed32e 100644 --- a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/ReadyGroupRequest.cs +++ b/MediaBrowser.Controller/SyncPlay/PlaybackRequest/ReadyGroupRequest.cs @@ -6,7 +6,7 @@ using MediaBrowser.Controller.Session; namespace MediaBrowser.Controller.SyncPlay { /// - /// Class BufferingDoneGroupRequest. + /// Class ReadyGroupRequest. /// public class ReadyGroupRequest : IPlaybackGroupRequest { @@ -29,9 +29,9 @@ namespace MediaBrowser.Controller.SyncPlay public bool IsPlaying { get; set; } /// - /// Gets or sets the playlist item id of the playing item. + /// Gets or sets the playlist item identifier of the playing item. /// - /// The playlist item id. + /// The playlist item identifier. public string PlaylistItemId { get; set; } /// diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/RemoveFromPlaylistGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequest/RemoveFromPlaylistGroupRequest.cs index 3fc77f6771..78aeb9c6f0 100644 --- a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/RemoveFromPlaylistGroupRequest.cs +++ b/MediaBrowser.Controller/SyncPlay/PlaybackRequest/RemoveFromPlaylistGroupRequest.cs @@ -10,15 +10,15 @@ namespace MediaBrowser.Controller.SyncPlay public class RemoveFromPlaylistGroupRequest : IPlaybackGroupRequest { /// - /// Gets or sets the playlist ids ot the items. + /// Gets or sets the playlist identifiers ot the items. /// - /// The playlist ids ot the items. + /// The playlist identifiers ot the items. public string[] PlaylistItemIds { get; set; } /// public PlaybackRequestType GetRequestType() { - return PlaybackRequestType.Queue; + return PlaybackRequestType.RemoveFromPlaylist; } /// diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/SetCurrentItemGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequest/SetCurrentItemGroupRequest.cs index d70559899a..070fd71d25 100644 --- a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/SetCurrentItemGroupRequest.cs +++ b/MediaBrowser.Controller/SyncPlay/PlaybackRequest/SetCurrentItemGroupRequest.cs @@ -10,9 +10,9 @@ namespace MediaBrowser.Controller.SyncPlay public class SetPlaylistItemGroupRequest : IPlaybackGroupRequest { /// - /// Gets or sets the playlist id of the playing item. + /// Gets or sets the playlist identifier of the playing item. /// - /// The playlist id of the playing item. + /// The playlist identifier of the playing item. public string PlaylistItemId { get; set; } /// diff --git a/MediaBrowser.Controller/SyncPlay/Queue/PlayQueueManager.cs b/MediaBrowser.Controller/SyncPlay/Queue/PlayQueueManager.cs index 6b4f9401e2..aca50f80a7 100644 --- a/MediaBrowser.Controller/SyncPlay/Queue/PlayQueueManager.cs +++ b/MediaBrowser.Controller/SyncPlay/Queue/PlayQueueManager.cs @@ -64,9 +64,9 @@ namespace MediaBrowser.Controller.SyncPlay public GroupRepeatMode RepeatMode { get; private set; } = GroupRepeatMode.RepeatNone; /// - /// Gets or sets the progressive id counter. + /// Gets or sets the progressive identifier counter. /// - /// The progressive id. + /// The progressive identifier. private int ProgressiveId { get; set; } = 0; private bool _disposed = false; @@ -101,15 +101,15 @@ namespace MediaBrowser.Controller.SyncPlay } /// - /// Gets the next available id. + /// Gets the next available identifier. /// - /// The next available id. + /// The next available identifier. private int GetNextProgressiveId() { return ProgressiveId++; } /// - /// Creates a list from the array of items. Each item is given an unique playlist id. + /// Creates a list from the array of items. Each item is given an unique playlist identifier. /// /// The list of queue items. private List CreateQueueItemsFromArray(Guid[] items) @@ -276,9 +276,9 @@ namespace MediaBrowser.Controller.SyncPlay } /// - /// Gets playlist id of the playing item, if any. + /// Gets playlist identifier of the playing item, if any. /// - /// The playlist id of the playing item. + /// The playlist identifier of the playing item. public string GetPlayingItemPlaylistId() { if (PlayingItemIndex < 0) @@ -299,9 +299,9 @@ namespace MediaBrowser.Controller.SyncPlay } /// - /// Gets the playing item id, if any. + /// Gets the playing item identifier, if any. /// - /// The playing item id. + /// The playing item identifier. public Guid GetPlayingItemId() { if (PlayingItemIndex < 0) @@ -322,9 +322,9 @@ namespace MediaBrowser.Controller.SyncPlay } /// - /// Sets the playing item using its id. If not in the playlist, the playing item is reset. + /// Sets the playing item using its identifier. If not in the playlist, the playing item is reset. /// - /// The new playing item id. + /// The new playing item identifier. public void SetPlayingItemById(Guid itemId) { var itemIds = GetPlaylistAsList().Select(queueItem => queueItem.ItemId).ToList(); @@ -333,9 +333,9 @@ namespace MediaBrowser.Controller.SyncPlay } /// - /// Sets the playing item using its playlist id. If not in the playlist, the playing item is reset. + /// Sets the playing item using its playlist identifier. If not in the playlist, the playing item is reset. /// - /// The new playing item id. + /// The new playing item identifier. /// true if playing item has been set; false if item is not in the playlist. public bool SetPlayingItemByPlaylistId(string playlistItemId) { diff --git a/MediaBrowser.Model/SyncPlay/GroupUpdateType.cs b/MediaBrowser.Model/SyncPlay/GroupUpdateType.cs index 7423bff117..907d1defe0 100644 --- a/MediaBrowser.Model/SyncPlay/GroupUpdateType.cs +++ b/MediaBrowser.Model/SyncPlay/GroupUpdateType.cs @@ -31,7 +31,7 @@ namespace MediaBrowser.Model.SyncPlay StateUpdate, /// - /// The play-queue update. Tells a user what's the playing queue of the group. + /// The play-queue update. Tells a user the playing queue of the group. /// PlayQueue, diff --git a/MediaBrowser.Model/SyncPlay/JoinGroupRequest.cs b/MediaBrowser.Model/SyncPlay/JoinGroupRequest.cs index 04f3a73b17..27a29b8998 100644 --- a/MediaBrowser.Model/SyncPlay/JoinGroupRequest.cs +++ b/MediaBrowser.Model/SyncPlay/JoinGroupRequest.cs @@ -8,9 +8,9 @@ namespace MediaBrowser.Model.SyncPlay public class JoinGroupRequest { /// - /// Gets or sets the group id. + /// Gets or sets the group identifier. /// - /// The id of the group to join. + /// The identifier of the group to join. public Guid GroupId { get; set; } } } diff --git a/MediaBrowser.Model/SyncPlay/QueueItem.cs b/MediaBrowser.Model/SyncPlay/QueueItem.cs index dc9cfbc229..ce253b182c 100644 --- a/MediaBrowser.Model/SyncPlay/QueueItem.cs +++ b/MediaBrowser.Model/SyncPlay/QueueItem.cs @@ -10,15 +10,15 @@ namespace MediaBrowser.Model.SyncPlay public class QueueItem { /// - /// Gets or sets the item id. + /// Gets or sets the item identifier. /// - /// The item id. + /// The item identifier. public Guid ItemId { get; set; } /// - /// Gets or sets the playlist id of the item. + /// Gets or sets the playlist identifier of the item. /// - /// The playlist id of the item. + /// The playlist identifier of the item. public string PlaylistItemId { get; set; } } } diff --git a/MediaBrowser.Model/SyncPlay/SendCommand.cs b/MediaBrowser.Model/SyncPlay/SendCommand.cs index 779f711af0..b24f7e97bd 100644 --- a/MediaBrowser.Model/SyncPlay/SendCommand.cs +++ b/MediaBrowser.Model/SyncPlay/SendCommand.cs @@ -14,9 +14,9 @@ namespace MediaBrowser.Model.SyncPlay public string GroupId { get; set; } /// - /// Gets or sets the playlist id of the playing item. + /// Gets or sets the playlist identifier of the playing item. /// - /// The playlist id of the playing item. + /// The playlist identifier of the playing item. public string PlaylistItemId { get; set; } /// -- cgit v1.2.3 From f6ab98507ec6ac25e9b2239e519118db07672592 Mon Sep 17 00:00:00 2001 From: BaronGreenback Date: Thu, 22 Oct 2020 13:29:09 +0100 Subject: Update MediaBrowser.Controller/SyncPlay/Queue/PlayQueueManager.cs --- MediaBrowser.Controller/SyncPlay/Queue/PlayQueueManager.cs | 3 +++ 1 file changed, 3 insertions(+) (limited to 'MediaBrowser.Controller/SyncPlay/Queue') diff --git a/MediaBrowser.Controller/SyncPlay/Queue/PlayQueueManager.cs b/MediaBrowser.Controller/SyncPlay/Queue/PlayQueueManager.cs index aca50f80a7..6373a52116 100644 --- a/MediaBrowser.Controller/SyncPlay/Queue/PlayQueueManager.cs +++ b/MediaBrowser.Controller/SyncPlay/Queue/PlayQueueManager.cs @@ -486,7 +486,10 @@ namespace MediaBrowser.Controller.SyncPlay ShufflePlaylist(); break; default: + if (!ShuffleMode.Equals(mode)) + { SortShuffledPlaylist(); + } break; } } -- cgit v1.2.3 From 1cabe82b59071a277d81f9438189b565e93f0660 Mon Sep 17 00:00:00 2001 From: Ionut Andrei Oanca Date: Thu, 22 Oct 2020 15:49:37 +0200 Subject: Rewrite play queue logic of SyncPlay group --- .../SyncPlay/GroupController.cs | 2 + .../SyncPlay/Queue/PlayQueueManager.cs | 142 ++++++++++++--------- 2 files changed, 86 insertions(+), 58 deletions(-) (limited to 'MediaBrowser.Controller/SyncPlay/Queue') diff --git a/Emby.Server.Implementations/SyncPlay/GroupController.cs b/Emby.Server.Implementations/SyncPlay/GroupController.cs index 26972de8aa..687aa7a3ad 100644 --- a/Emby.Server.Implementations/SyncPlay/GroupController.cs +++ b/Emby.Server.Implementations/SyncPlay/GroupController.cs @@ -263,6 +263,7 @@ namespace Emby.Server.Implementations.SyncPlay if (sessionIsPlayingAnItem) { var playlist = session.NowPlayingQueue.Select(item => item.Id).ToArray(); + PlayQueue.Reset(); PlayQueue.SetPlaylist(playlist); PlayQueue.SetPlayingItemById(session.FullNowPlayingItem.Id); RunTimeTicks = session.FullNowPlayingItem.RunTimeTicks ?? 0; @@ -515,6 +516,7 @@ namespace Emby.Server.Implementations.SyncPlay return false; } + PlayQueue.Reset(); PlayQueue.SetPlaylist(playQueue); PlayQueue.SetPlayingItemByIndex(playingItemPosition); var item = _libraryManager.GetItemById(PlayQueue.GetPlayingItemId()); diff --git a/MediaBrowser.Controller/SyncPlay/Queue/PlayQueueManager.cs b/MediaBrowser.Controller/SyncPlay/Queue/PlayQueueManager.cs index aca50f80a7..366bedfa1b 100644 --- a/MediaBrowser.Controller/SyncPlay/Queue/PlayQueueManager.cs +++ b/MediaBrowser.Controller/SyncPlay/Queue/PlayQueueManager.cs @@ -69,7 +69,11 @@ namespace MediaBrowser.Controller.SyncPlay /// The progressive identifier. private int ProgressiveId { get; set; } = 0; - private bool _disposed = false; + /// + /// Placeholder index for when no item is playing. + /// + /// The no-playing item index. + private const int NoPlayingItemIndex = -1; /// /// Initializes a new instance of the class. @@ -139,6 +143,26 @@ namespace MediaBrowser.Controller.SyncPlay } } + /// + /// Gets the current playing item, depending on the shuffle mode. + /// + /// The playing item. + private QueueItem GetPlayingItem() + { + if (PlayingItemIndex == NoPlayingItemIndex) + { + return null; + } + else if (ShuffleMode.Equals(GroupShuffleMode.Shuffle)) + { + return ShuffledPlaylist[PlayingItemIndex]; + } + else + { + return SortedPlaylist[PlayingItemIndex]; + } + } + /// /// Gets the current playlist as an array, depending on the shuffle mode. /// @@ -155,30 +179,36 @@ namespace MediaBrowser.Controller.SyncPlay } /// - /// Sets a new playlist. Playing item is set to none. Resets shuffle mode and repeat mode as well. + /// Sets a new playlist. Playing item is reset. /// /// The new items of the playlist. public void SetPlaylist(Guid[] items) { + SortedPlaylist.Clear(); + ShuffledPlaylist.Clear(); + SortedPlaylist = CreateQueueItemsFromArray(items); - PlayingItemIndex = -1; - ShuffleMode = GroupShuffleMode.Sorted; - RepeatMode = GroupRepeatMode.RepeatNone; + if (ShuffleMode.Equals(GroupShuffleMode.Shuffle)) + { + ShuffledPlaylist = SortedPlaylist.ToList(); + ShuffledPlaylist.Shuffle(); + } + + PlayingItemIndex = NoPlayingItemIndex; LastChange = DateTime.UtcNow; } /// - /// Appends new items to the playlist. The specified order is mantained for the sorted playlist, whereas items get shuffled for the shuffled playlist. + /// Appends new items to the playlist. The specified order is mantained. /// /// The items to add to the playlist. public void Queue(Guid[] items) { var newItems = CreateQueueItemsFromArray(items); - SortedPlaylist.AddRange(newItems); + SortedPlaylist.AddRange(newItems); if (ShuffleMode.Equals(GroupShuffleMode.Shuffle)) { - newItems.Shuffle(); ShuffledPlaylist.AddRange(newItems); } @@ -190,17 +220,13 @@ namespace MediaBrowser.Controller.SyncPlay /// public void ShufflePlaylist() { - if (SortedPlaylist.Count() == 0) - { - return; - } - - if (PlayingItemIndex < 0) { + if (PlayingItemIndex == NoPlayingItemIndex) { ShuffledPlaylist = SortedPlaylist.ToList(); ShuffledPlaylist.Shuffle(); } - else + else if (ShuffleMode.Equals(GroupShuffleMode.Sorted)) { + // First time shuffle. var playingItem = SortedPlaylist[PlayingItemIndex]; ShuffledPlaylist = SortedPlaylist.ToList(); ShuffledPlaylist.RemoveAt(PlayingItemIndex); @@ -208,6 +234,15 @@ namespace MediaBrowser.Controller.SyncPlay ShuffledPlaylist = ShuffledPlaylist.Prepend(playingItem).ToList(); PlayingItemIndex = 0; } + else + { + // Re-shuffle playlist. + var playingItem = ShuffledPlaylist[PlayingItemIndex]; + ShuffledPlaylist.RemoveAt(PlayingItemIndex); + ShuffledPlaylist.Shuffle(); + ShuffledPlaylist = ShuffledPlaylist.Prepend(playingItem).ToList(); + PlayingItemIndex = 0; + } ShuffleMode = GroupShuffleMode.Shuffle; LastChange = DateTime.UtcNow; @@ -216,9 +251,9 @@ namespace MediaBrowser.Controller.SyncPlay /// /// Resets the playlist to sorted mode. Shuffle mode is changed. /// - public void SortShuffledPlaylist() + public void RestoreSortedPlaylist() { - if (PlayingItemIndex >= 0) + if (PlayingItemIndex != NoPlayingItemIndex) { var playingItem = ShuffledPlaylist[PlayingItemIndex]; PlayingItemIndex = SortedPlaylist.IndexOf(playingItem); @@ -231,12 +266,12 @@ namespace MediaBrowser.Controller.SyncPlay } /// - /// Clears the playlist. + /// Clears the playlist. Shuffle mode is preserved. /// /// Whether to remove the playing item as well. public void ClearPlaylist(bool clearPlayingItem) { - var playingItem = SortedPlaylist[PlayingItemIndex]; + var playingItem = GetPlayingItem(); SortedPlaylist.Clear(); ShuffledPlaylist.Clear(); LastChange = DateTime.UtcNow; @@ -246,13 +281,18 @@ namespace MediaBrowser.Controller.SyncPlay SortedPlaylist.Add(playingItem); if (ShuffleMode.Equals(GroupShuffleMode.Shuffle)) { - SortedPlaylist.Add(playingItem); + ShuffledPlaylist.Add(playingItem); + } + PlayingItemIndex = 0; } + else + { + PlayingItemIndex = NoPlayingItemIndex; } } /// - /// Adds new items to the playlist right after the playing item. The specified order is mantained for the sorted playlist, whereas items get shuffled for the shuffled playlist. + /// Adds new items to the playlist right after the playing item. The specified order is mantained. /// /// The items to add to the playlist. public void QueueNext(Guid[] items) @@ -261,10 +301,10 @@ namespace MediaBrowser.Controller.SyncPlay if (ShuffleMode.Equals(GroupShuffleMode.Shuffle)) { - // Append items to sorted playlist as they are. - SortedPlaylist.AddRange(newItems); - // Shuffle items before adding to shuffled playlist. - newItems.Shuffle(); + var playingItem = GetPlayingItem(); + var sortedPlayingItemIndex = SortedPlaylist.IndexOf(playingItem); + // Append items to sorted and shuffled playlist as they are. + SortedPlaylist.InsertRange(sortedPlayingItemIndex + 1, newItems); ShuffledPlaylist.InsertRange(PlayingItemIndex + 1, newItems); } else @@ -281,16 +321,10 @@ namespace MediaBrowser.Controller.SyncPlay /// The playlist identifier of the playing item. public string GetPlayingItemPlaylistId() { - if (PlayingItemIndex < 0) - { - return null; - } - - var list = GetPlaylistAsList(); - - if (list.Count() > 0) + var playingItem = GetPlayingItem(); + if (playingItem != null) { - return list[PlayingItemIndex].PlaylistItemId; + return playingItem.PlaylistItemId; } else { @@ -304,16 +338,10 @@ namespace MediaBrowser.Controller.SyncPlay /// The playing item identifier. public Guid GetPlayingItemId() { - if (PlayingItemIndex < 0) - { - return Guid.Empty; - } - - var list = GetPlaylistAsList(); - - if (list.Count() > 0) + var playingItem = GetPlayingItem(); + if (playingItem != null) { - return list[PlayingItemIndex].ItemId; + return playingItem.ItemId; } else { @@ -342,7 +370,7 @@ namespace MediaBrowser.Controller.SyncPlay var playlistIds = GetPlaylistAsList().Select(queueItem => queueItem.PlaylistItemId).ToList(); PlayingItemIndex = playlistIds.IndexOf(playlistItemId); LastChange = DateTime.UtcNow; - return PlayingItemIndex != -1; + return PlayingItemIndex != NoPlayingItemIndex; } /// @@ -354,7 +382,7 @@ namespace MediaBrowser.Controller.SyncPlay var list = GetPlaylistAsList(); if (playlistIndex < 0 || playlistIndex > list.Count()) { - PlayingItemIndex = -1; + PlayingItemIndex = NoPlayingItemIndex; } else { @@ -371,13 +399,9 @@ namespace MediaBrowser.Controller.SyncPlay /// true if playing item got removed; false otherwise. public bool RemoveFromPlaylist(string[] playlistItemIds) { - var playingItem = SortedPlaylist[PlayingItemIndex]; - if (ShuffleMode.Equals(GroupShuffleMode.Shuffle)) - { - playingItem = ShuffledPlaylist[PlayingItemIndex]; - } - + var playingItem = GetPlayingItem(); var playlistItemIdsList = playlistItemIds.ToList(); + SortedPlaylist.RemoveAll(item => playlistItemIdsList.Contains(item.PlaylistItemId)); ShuffledPlaylist.RemoveAll(item => playlistItemIdsList.Contains(item.PlaylistItemId)); @@ -392,7 +416,8 @@ namespace MediaBrowser.Controller.SyncPlay if (PlayingItemIndex < 0) { // Was first element, picking next if available. - PlayingItemIndex = SortedPlaylist.Count() > 0 ? 0 : -1; + // Default to no playing item otherwise. + PlayingItemIndex = SortedPlaylist.Count() > 0 ? 0 : NoPlayingItemIndex; } return true; @@ -419,18 +444,19 @@ namespace MediaBrowser.Controller.SyncPlay public bool MovePlaylistItem(string playlistItemId, int newIndex) { var list = GetPlaylistAsList(); - var playingItem = list[PlayingItemIndex]; + var playingItem = GetPlayingItem(); var playlistIds = list.Select(queueItem => queueItem.PlaylistItemId).ToList(); var oldIndex = playlistIds.IndexOf(playlistItemId); - if (oldIndex < 0) { + if (oldIndex < 0) + { return false; } var queueItem = list[oldIndex]; list.RemoveAt(oldIndex); - newIndex = newIndex > list.Count() ? list.Count() : newIndex; - newIndex = newIndex < 0 ? 0 : newIndex; + newIndex = Math.Min(newIndex, list.Count()); + newIndex = Math.Max(newIndex, 0); list.Insert(newIndex, queueItem); LastChange = DateTime.UtcNow; @@ -446,7 +472,7 @@ namespace MediaBrowser.Controller.SyncPlay ProgressiveId = 0; SortedPlaylist.Clear(); ShuffledPlaylist.Clear(); - PlayingItemIndex = -1; + PlayingItemIndex = NoPlayingItemIndex; ShuffleMode = GroupShuffleMode.Sorted; RepeatMode = GroupRepeatMode.RepeatNone; LastChange = DateTime.UtcNow; @@ -486,7 +512,7 @@ namespace MediaBrowser.Controller.SyncPlay ShufflePlaylist(); break; default: - SortShuffledPlaylist(); + RestoreSortedPlaylist(); break; } } -- cgit v1.2.3 From 0c735a039538bfaa44d25df415f3d41519e37194 Mon Sep 17 00:00:00 2001 From: Ionut Andrei Oanca Date: Thu, 22 Oct 2020 15:51:58 +0200 Subject: Address requested changes by review --- .../SyncPlay/GroupController.cs | 50 +++++++++++----------- .../SyncPlay/GroupStates/AbstractGroupState.cs | 2 +- .../SyncPlay/GroupStates/IdleGroupState.cs | 3 +- .../SyncPlay/GroupStates/PausedGroupState.cs | 9 +++- .../SyncPlay/GroupStates/PlayingGroupState.cs | 3 +- .../SyncPlay/GroupStates/WaitingGroupState.cs | 17 ++++++-- .../SyncPlay/Queue/PlayQueueManager.cs | 25 +---------- 7 files changed, 54 insertions(+), 55 deletions(-) (limited to 'MediaBrowser.Controller/SyncPlay/Queue') diff --git a/Emby.Server.Implementations/SyncPlay/GroupController.cs b/Emby.Server.Implementations/SyncPlay/GroupController.cs index 687aa7a3ad..65a711fb42 100644 --- a/Emby.Server.Implementations/SyncPlay/GroupController.cs +++ b/Emby.Server.Implementations/SyncPlay/GroupController.cs @@ -126,16 +126,6 @@ namespace Emby.Server.Implementations.SyncPlay State = new IdleGroupState(_logger); } - /// - /// Checks if a session is in this group. - /// - /// The session identifier to check. - /// true if the session is in this group; false otherwise. - private bool ContainsSession(string sessionId) - { - return Participants.ContainsKey(sessionId); - } - /// /// Adds the session to the group. /// @@ -174,16 +164,22 @@ namespace Emby.Server.Implementations.SyncPlay case SyncPlayBroadcastType.CurrentSession: return new SessionInfo[] { from }; case SyncPlayBroadcastType.AllGroup: - return Participants.Values.Select( - session => session.Session).ToArray(); + return Participants + .Values + .Select(session => session.Session) + .ToArray(); case SyncPlayBroadcastType.AllExceptCurrentSession: - return Participants.Values.Select( - session => session.Session).Where( - session => !session.Id.Equals(from.Id)).ToArray(); + return Participants + .Values + .Select(session => session.Session) + .Where(session => !session.Id.Equals(from.Id)) + .ToArray(); case SyncPlayBroadcastType.AllReady: - return Participants.Values.Where( - session => !session.IsBuffering).Select( - session => session.Session).ToArray(); + return Participants + .Values + .Where(session => !session.IsBuffering) + .Select(session => session.Session) + .ToArray(); default: return Array.Empty(); } @@ -236,7 +232,8 @@ namespace Emby.Server.Implementations.SyncPlay } // Get list of users. - var users = Participants.Values + var users = Participants + .Values .Select(participant => _userManager.GetUserById(participant.Session.UserId)); // Find problematic users. @@ -365,7 +362,7 @@ namespace Emby.Server.Implementations.SyncPlay /// public void SetIgnoreGroupWait(SessionInfo session, bool ignoreGroupWait) { - if (!ContainsSession(session.Id)) + if (!Participants.ContainsKey(session.Id)) { return; } @@ -443,8 +440,8 @@ namespace Emby.Server.Implementations.SyncPlay public long SanitizePositionTicks(long? positionTicks) { var ticks = positionTicks ?? 0; - ticks = ticks >= 0 ? ticks : 0; - ticks = ticks > RunTimeTicks ? RunTimeTicks : ticks; + ticks = Math.Max(ticks, 0); + ticks = Math.Min(ticks, RunTimeTicks); return ticks; } @@ -663,8 +660,13 @@ namespace Emby.Server.Implementations.SyncPlay { var currentTime = DateTime.UtcNow; var elapsedTime = currentTime - LastActivity; - // Event may happen during the delay added to account for latency. - startPositionTicks += elapsedTime.Ticks > 0 ? elapsedTime.Ticks : 0; + // Elapsed time is negative if event happens + // during the delay added to account for latency. + // In this phase clients haven't started the playback yet. + // In other words, LastActivity is in the future, + // when playback unpause is supposed to happen. + // Adjust ticks only if playback actually started. + startPositionTicks += Math.Max(elapsedTime.Ticks, 0); } return new PlayQueueUpdate() diff --git a/Emby.Server.Implementations/SyncPlay/GroupStates/AbstractGroupState.cs b/Emby.Server.Implementations/SyncPlay/GroupStates/AbstractGroupState.cs index 1eb1107721..26cd51b8d8 100644 --- a/Emby.Server.Implementations/SyncPlay/GroupStates/AbstractGroupState.cs +++ b/Emby.Server.Implementations/SyncPlay/GroupStates/AbstractGroupState.cs @@ -212,7 +212,7 @@ namespace MediaBrowser.Controller.SyncPlay private void UnhandledRequest(IPlaybackGroupRequest request) { - _logger.LogWarning("HandleRequest: unhandled {0} request for {1} state.", request.GetRequestType(), this.GetGroupState()); + _logger.LogWarning("HandleRequest: unhandled {0} request for {1} state.", request.GetRequestType(), GetGroupState()); } } } diff --git a/Emby.Server.Implementations/SyncPlay/GroupStates/IdleGroupState.cs b/Emby.Server.Implementations/SyncPlay/GroupStates/IdleGroupState.cs index b8510715ac..70fe3e0067 100644 --- a/Emby.Server.Implementations/SyncPlay/GroupStates/IdleGroupState.cs +++ b/Emby.Server.Implementations/SyncPlay/GroupStates/IdleGroupState.cs @@ -16,7 +16,8 @@ namespace MediaBrowser.Controller.SyncPlay /// /// Default constructor. /// - public IdleGroupState(ILogger logger) : base(logger) + public IdleGroupState(ILogger logger) + : base(logger) { // Do nothing. } diff --git a/Emby.Server.Implementations/SyncPlay/GroupStates/PausedGroupState.cs b/Emby.Server.Implementations/SyncPlay/GroupStates/PausedGroupState.cs index 8c4bd20b1c..ca2cb0988b 100644 --- a/Emby.Server.Implementations/SyncPlay/GroupStates/PausedGroupState.cs +++ b/Emby.Server.Implementations/SyncPlay/GroupStates/PausedGroupState.cs @@ -17,7 +17,8 @@ namespace MediaBrowser.Controller.SyncPlay /// /// Default constructor. /// - public PausedGroupState(ILogger logger) : base(logger) + public PausedGroupState(ILogger logger) + : base(logger) { // Do nothing. } @@ -70,8 +71,12 @@ namespace MediaBrowser.Controller.SyncPlay var currentTime = DateTime.UtcNow; var elapsedTime = currentTime - context.LastActivity; context.LastActivity = currentTime; + // Elapsed time is negative if event happens + // during the delay added to account for latency. + // In this phase clients haven't started the playback yet. + // In other words, LastActivity is in the future, + // when playback unpause is supposed to happen. // Seek only if playback actually started. - // Pause request may be issued during the delay added to account for latency. context.PositionTicks += Math.Max(elapsedTime.Ticks, 0); var command = context.NewSyncPlayCommand(SendCommandType.Pause); diff --git a/Emby.Server.Implementations/SyncPlay/GroupStates/PlayingGroupState.cs b/Emby.Server.Implementations/SyncPlay/GroupStates/PlayingGroupState.cs index a3b0baf963..85119669dd 100644 --- a/Emby.Server.Implementations/SyncPlay/GroupStates/PlayingGroupState.cs +++ b/Emby.Server.Implementations/SyncPlay/GroupStates/PlayingGroupState.cs @@ -22,7 +22,8 @@ namespace MediaBrowser.Controller.SyncPlay /// /// Default constructor. /// - public PlayingGroupState(ILogger logger) : base(logger) + public PlayingGroupState(ILogger logger) + : base(logger) { // Do nothing. } diff --git a/Emby.Server.Implementations/SyncPlay/GroupStates/WaitingGroupState.cs b/Emby.Server.Implementations/SyncPlay/GroupStates/WaitingGroupState.cs index ff1d379d77..8e970751f1 100644 --- a/Emby.Server.Implementations/SyncPlay/GroupStates/WaitingGroupState.cs +++ b/Emby.Server.Implementations/SyncPlay/GroupStates/WaitingGroupState.cs @@ -32,7 +32,8 @@ namespace MediaBrowser.Controller.SyncPlay /// /// Default constructor. /// - public WaitingGroupState(ILogger logger) : base(logger) + public WaitingGroupState(ILogger logger) + : base(logger) { // Do nothing. } @@ -59,8 +60,12 @@ namespace MediaBrowser.Controller.SyncPlay var currentTime = DateTime.UtcNow; var elapsedTime = currentTime - context.LastActivity; context.LastActivity = currentTime; + // Elapsed time is negative if event happens + // during the delay added to account for latency. + // In this phase clients haven't started the playback yet. + // In other words, LastActivity is in the future, + // when playback unpause is supposed to happen. // Seek only if playback actually started. - // Event may happen during the delay added to account for latency. context.PositionTicks += Math.Max(elapsedTime.Ticks, 0); } @@ -355,6 +360,12 @@ namespace MediaBrowser.Controller.SyncPlay var currentTime = DateTime.UtcNow; var elapsedTime = currentTime - context.LastActivity; context.LastActivity = currentTime; + // Elapsed time is negative if event happens + // during the delay added to account for latency. + // In this phase clients haven't started the playback yet. + // In other words, LastActivity is in the future, + // when playback unpause is supposed to happen. + // Seek only if playback actually started. context.PositionTicks += Math.Max(elapsedTime.Ticks, 0); // Send pause command to all non-buffering sessions. @@ -484,7 +495,7 @@ namespace MediaBrowser.Controller.SyncPlay { // Client, that was buffering, resumed playback but did not update others in time. delayTicks = context.GetHighestPing() * 2 * TimeSpan.TicksPerMillisecond; - delayTicks = delayTicks < context.DefaultPing ? context.DefaultPing : delayTicks; + delayTicks = Math.Max(delayTicks, context.DefaultPing); context.LastActivity = currentTime.AddTicks(delayTicks); diff --git a/MediaBrowser.Controller/SyncPlay/Queue/PlayQueueManager.cs b/MediaBrowser.Controller/SyncPlay/Queue/PlayQueueManager.cs index 366bedfa1b..9ab0dfd2ad 100644 --- a/MediaBrowser.Controller/SyncPlay/Queue/PlayQueueManager.cs +++ b/MediaBrowser.Controller/SyncPlay/Queue/PlayQueueManager.cs @@ -25,7 +25,7 @@ namespace MediaBrowser.Controller.SyncPlay /// /// Class PlayQueueManager. /// - public class PlayQueueManager : IDisposable + public class PlayQueueManager { /// /// Gets or sets the playing item index. @@ -83,27 +83,6 @@ namespace MediaBrowser.Controller.SyncPlay Reset(); } - /// - public void Dispose() - { - Dispose(true); - GC.SuppressFinalize(this); - } - - /// - /// Releases unmanaged and optionally managed resources. - /// - /// true to release both managed and unmanaged resources; false to release only unmanaged resources. - protected virtual void Dispose(bool disposing) - { - if (_disposed) - { - return; - } - - _disposed = true; - } - /// /// Gets the next available identifier. /// @@ -284,7 +263,7 @@ namespace MediaBrowser.Controller.SyncPlay ShuffledPlaylist.Add(playingItem); } PlayingItemIndex = 0; - } + } else { PlayingItemIndex = NoPlayingItemIndex; -- cgit v1.2.3 From 1dbc91978ece81628c339d1dc3b53f6d250cb005 Mon Sep 17 00:00:00 2001 From: Ionut Andrei Oanca Date: Fri, 13 Nov 2020 15:13:32 +0100 Subject: Address requested changes and fix some warnings --- .../SyncPlay/GroupController.cs | 251 ++++---- .../SyncPlay/GroupStates/AbstractGroupState.cs | 218 ------- .../SyncPlay/GroupStates/IdleGroupState.cs | 122 ---- .../SyncPlay/GroupStates/PausedGroupState.cs | 161 ----- .../SyncPlay/GroupStates/PlayingGroupState.cs | 166 ----- .../SyncPlay/GroupStates/WaitingGroupState.cs | 683 --------------------- .../SyncPlay/SyncPlayManager.cs | 27 +- Jellyfin.Api/Controllers/SyncPlayController.cs | 12 +- .../SyncPlay/GroupStates/AbstractGroupState.cs | 216 +++++++ .../SyncPlay/GroupStates/IdleGroupState.cs | 126 ++++ .../SyncPlay/GroupStates/PausedGroupState.cs | 165 +++++ .../SyncPlay/GroupStates/PlayingGroupState.cs | 168 +++++ .../SyncPlay/GroupStates/WaitingGroupState.cs | 655 ++++++++++++++++++++ .../SyncPlay/IGroupController.cs | 84 +++ .../SyncPlay/IGroupPlaybackRequest.cs | 27 + MediaBrowser.Controller/SyncPlay/IGroupState.cs | 216 +++++++ .../SyncPlay/IGroupStateContext.cs | 228 +++++++ .../SyncPlay/IPlaybackGroupRequest.cs | 23 - .../SyncPlay/ISyncPlayController.cs | 85 --- .../SyncPlay/ISyncPlayManager.cs | 6 +- MediaBrowser.Controller/SyncPlay/ISyncPlayState.cs | 216 ------- .../SyncPlay/ISyncPlayStateContext.cs | 225 ------- .../SyncPlay/PlaybackRequest/BufferGroupRequest.cs | 49 -- .../PlaybackRequest/IgnoreWaitGroupRequest.cs | 30 - .../MovePlaylistItemGroupRequest.cs | 36 -- .../PlaybackRequest/NextTrackGroupRequest.cs | 30 - .../SyncPlay/PlaybackRequest/PauseGroupRequest.cs | 24 - .../SyncPlay/PlaybackRequest/PingGroupRequest.cs | 30 - .../SyncPlay/PlaybackRequest/PlayGroupRequest.cs | 43 -- .../PlaybackRequest/PreviousTrackGroupRequest.cs | 30 - .../SyncPlay/PlaybackRequest/QueueGroupRequest.cs | 37 -- .../SyncPlay/PlaybackRequest/ReadyGroupRequest.cs | 49 -- .../RemoveFromPlaylistGroupRequest.cs | 30 - .../SyncPlay/PlaybackRequest/SeekGroupRequest.cs | 30 - .../PlaybackRequest/SetCurrentItemGroupRequest.cs | 30 - .../PlaybackRequest/SetRepeatModeGroupRequest.cs | 30 - .../PlaybackRequest/SetShuffleModeGroupRequest.cs | 30 - .../SyncPlay/PlaybackRequest/StopGroupRequest.cs | 24 - .../PlaybackRequest/UnpauseGroupRequest.cs | 24 - .../PlaybackRequests/BufferGroupRequest.cs | 46 ++ .../PlaybackRequests/IgnoreWaitGroupRequest.cs | 27 + .../MovePlaylistItemGroupRequest.cs | 33 + .../PlaybackRequests/NextTrackGroupRequest.cs | 27 + .../SyncPlay/PlaybackRequests/PauseGroupRequest.cs | 21 + .../SyncPlay/PlaybackRequests/PingGroupRequest.cs | 27 + .../SyncPlay/PlaybackRequests/PlayGroupRequest.cs | 41 ++ .../PlaybackRequests/PreviousTrackGroupRequest.cs | 27 + .../SyncPlay/PlaybackRequests/QueueGroupRequest.cs | 35 ++ .../SyncPlay/PlaybackRequests/ReadyGroupRequest.cs | 46 ++ .../RemoveFromPlaylistGroupRequest.cs | 28 + .../SyncPlay/PlaybackRequests/SeekGroupRequest.cs | 27 + .../SetPlaylistItemGroupRequest.cs | 27 + .../PlaybackRequests/SetRepeatModeGroupRequest.cs | 27 + .../PlaybackRequests/SetShuffleModeGroupRequest.cs | 27 + .../SyncPlay/PlaybackRequests/StopGroupRequest.cs | 21 + .../PlaybackRequests/UnpauseGroupRequest.cs | 21 + .../SyncPlay/Queue/PlayQueueManager.cs | 315 ++++++---- MediaBrowser.Model/SyncPlay/GroupInfoDto.cs | 2 +- MediaBrowser.Model/SyncPlay/GroupState.cs | 25 - MediaBrowser.Model/SyncPlay/GroupStateType.cs | 28 + MediaBrowser.Model/SyncPlay/GroupStateUpdate.cs | 4 +- MediaBrowser.Model/SyncPlay/GroupUpdate.cs | 1 + MediaBrowser.Model/SyncPlay/PlayQueueUpdate.cs | 4 +- MediaBrowser.Model/SyncPlay/PlaybackRequestType.cs | 1 + 64 files changed, 2752 insertions(+), 2772 deletions(-) delete mode 100644 Emby.Server.Implementations/SyncPlay/GroupStates/AbstractGroupState.cs delete mode 100644 Emby.Server.Implementations/SyncPlay/GroupStates/IdleGroupState.cs delete mode 100644 Emby.Server.Implementations/SyncPlay/GroupStates/PausedGroupState.cs delete mode 100644 Emby.Server.Implementations/SyncPlay/GroupStates/PlayingGroupState.cs delete mode 100644 Emby.Server.Implementations/SyncPlay/GroupStates/WaitingGroupState.cs create mode 100644 MediaBrowser.Controller/SyncPlay/GroupStates/AbstractGroupState.cs create mode 100644 MediaBrowser.Controller/SyncPlay/GroupStates/IdleGroupState.cs create mode 100644 MediaBrowser.Controller/SyncPlay/GroupStates/PausedGroupState.cs create mode 100644 MediaBrowser.Controller/SyncPlay/GroupStates/PlayingGroupState.cs create mode 100644 MediaBrowser.Controller/SyncPlay/GroupStates/WaitingGroupState.cs create mode 100644 MediaBrowser.Controller/SyncPlay/IGroupController.cs create mode 100644 MediaBrowser.Controller/SyncPlay/IGroupPlaybackRequest.cs create mode 100644 MediaBrowser.Controller/SyncPlay/IGroupState.cs create mode 100644 MediaBrowser.Controller/SyncPlay/IGroupStateContext.cs delete mode 100644 MediaBrowser.Controller/SyncPlay/IPlaybackGroupRequest.cs delete mode 100644 MediaBrowser.Controller/SyncPlay/ISyncPlayController.cs delete mode 100644 MediaBrowser.Controller/SyncPlay/ISyncPlayState.cs delete mode 100644 MediaBrowser.Controller/SyncPlay/ISyncPlayStateContext.cs delete mode 100644 MediaBrowser.Controller/SyncPlay/PlaybackRequest/BufferGroupRequest.cs delete mode 100644 MediaBrowser.Controller/SyncPlay/PlaybackRequest/IgnoreWaitGroupRequest.cs delete mode 100644 MediaBrowser.Controller/SyncPlay/PlaybackRequest/MovePlaylistItemGroupRequest.cs delete mode 100644 MediaBrowser.Controller/SyncPlay/PlaybackRequest/NextTrackGroupRequest.cs delete mode 100644 MediaBrowser.Controller/SyncPlay/PlaybackRequest/PauseGroupRequest.cs delete mode 100644 MediaBrowser.Controller/SyncPlay/PlaybackRequest/PingGroupRequest.cs delete mode 100644 MediaBrowser.Controller/SyncPlay/PlaybackRequest/PlayGroupRequest.cs delete mode 100644 MediaBrowser.Controller/SyncPlay/PlaybackRequest/PreviousTrackGroupRequest.cs delete mode 100644 MediaBrowser.Controller/SyncPlay/PlaybackRequest/QueueGroupRequest.cs delete mode 100644 MediaBrowser.Controller/SyncPlay/PlaybackRequest/ReadyGroupRequest.cs delete mode 100644 MediaBrowser.Controller/SyncPlay/PlaybackRequest/RemoveFromPlaylistGroupRequest.cs delete mode 100644 MediaBrowser.Controller/SyncPlay/PlaybackRequest/SeekGroupRequest.cs delete mode 100644 MediaBrowser.Controller/SyncPlay/PlaybackRequest/SetCurrentItemGroupRequest.cs delete mode 100644 MediaBrowser.Controller/SyncPlay/PlaybackRequest/SetRepeatModeGroupRequest.cs delete mode 100644 MediaBrowser.Controller/SyncPlay/PlaybackRequest/SetShuffleModeGroupRequest.cs delete mode 100644 MediaBrowser.Controller/SyncPlay/PlaybackRequest/StopGroupRequest.cs delete mode 100644 MediaBrowser.Controller/SyncPlay/PlaybackRequest/UnpauseGroupRequest.cs create mode 100644 MediaBrowser.Controller/SyncPlay/PlaybackRequests/BufferGroupRequest.cs create mode 100644 MediaBrowser.Controller/SyncPlay/PlaybackRequests/IgnoreWaitGroupRequest.cs create mode 100644 MediaBrowser.Controller/SyncPlay/PlaybackRequests/MovePlaylistItemGroupRequest.cs create mode 100644 MediaBrowser.Controller/SyncPlay/PlaybackRequests/NextTrackGroupRequest.cs create mode 100644 MediaBrowser.Controller/SyncPlay/PlaybackRequests/PauseGroupRequest.cs create mode 100644 MediaBrowser.Controller/SyncPlay/PlaybackRequests/PingGroupRequest.cs create mode 100644 MediaBrowser.Controller/SyncPlay/PlaybackRequests/PlayGroupRequest.cs create mode 100644 MediaBrowser.Controller/SyncPlay/PlaybackRequests/PreviousTrackGroupRequest.cs create mode 100644 MediaBrowser.Controller/SyncPlay/PlaybackRequests/QueueGroupRequest.cs create mode 100644 MediaBrowser.Controller/SyncPlay/PlaybackRequests/ReadyGroupRequest.cs create mode 100644 MediaBrowser.Controller/SyncPlay/PlaybackRequests/RemoveFromPlaylistGroupRequest.cs create mode 100644 MediaBrowser.Controller/SyncPlay/PlaybackRequests/SeekGroupRequest.cs create mode 100644 MediaBrowser.Controller/SyncPlay/PlaybackRequests/SetPlaylistItemGroupRequest.cs create mode 100644 MediaBrowser.Controller/SyncPlay/PlaybackRequests/SetRepeatModeGroupRequest.cs create mode 100644 MediaBrowser.Controller/SyncPlay/PlaybackRequests/SetShuffleModeGroupRequest.cs create mode 100644 MediaBrowser.Controller/SyncPlay/PlaybackRequests/StopGroupRequest.cs create mode 100644 MediaBrowser.Controller/SyncPlay/PlaybackRequests/UnpauseGroupRequest.cs delete mode 100644 MediaBrowser.Model/SyncPlay/GroupState.cs create mode 100644 MediaBrowser.Model/SyncPlay/GroupStateType.cs (limited to 'MediaBrowser.Controller/SyncPlay/Queue') diff --git a/Emby.Server.Implementations/SyncPlay/GroupController.cs b/Emby.Server.Implementations/SyncPlay/GroupController.cs index ffd65d7f8a..5a3c707dbf 100644 --- a/Emby.Server.Implementations/SyncPlay/GroupController.cs +++ b/Emby.Server.Implementations/SyncPlay/GroupController.cs @@ -16,28 +16,13 @@ using Microsoft.Extensions.Logging; namespace Emby.Server.Implementations.SyncPlay { /// - /// Class SyncPlayGroupController. + /// Class GroupController. /// /// /// Class is not thread-safe, external locking is required when accessing methods. /// - public class SyncPlayGroupController : ISyncPlayGroupController, ISyncPlayStateContext + public class GroupController : IGroupController, IGroupStateContext { - /// - /// Gets the default ping value used for sessions. - /// - public long DefaultPing { get; } = 500; - - /// - /// Gets the maximum time offset error accepted for dates reported by clients, in milliseconds. - /// - public long TimeSyncOffset { get; } = 2000; - - /// - /// Gets the maximum offset error accepted for position reported by clients, in milliseconds. - /// - public long MaxPlaybackOffset { get; } = 500; - /// /// The logger. /// @@ -67,7 +52,46 @@ namespace Emby.Server.Implementations.SyncPlay /// Internal group state. /// /// The group's state. - private ISyncPlayState State; + private IGroupState _state; + + /// + /// Initializes a new instance of the class. + /// + /// The logger. + /// The user manager. + /// The session manager. + /// The library manager. + /// The SyncPlay manager. + public GroupController( + ILogger logger, + IUserManager userManager, + ISessionManager sessionManager, + ILibraryManager libraryManager, + ISyncPlayManager syncPlayManager) + { + _logger = logger; + _userManager = userManager; + _sessionManager = sessionManager; + _libraryManager = libraryManager; + _syncPlayManager = syncPlayManager; + + _state = new IdleGroupState(_logger); + } + + /// + /// Gets the default ping value used for sessions. + /// + public long DefaultPing { get; } = 500; + + /// + /// Gets the maximum time offset error accepted for dates reported by clients, in milliseconds. + /// + public long TimeSyncOffset { get; } = 2000; + + /// + /// Gets the maximum offset error accepted for position reported by clients, in milliseconds. + /// + public long MaxPlaybackOffset { get; } = 500; /// /// Gets the group identifier. @@ -88,7 +112,7 @@ namespace Emby.Server.Implementations.SyncPlay public PlayQueueManager PlayQueue { get; } = new PlayQueueManager(); /// - /// Gets or sets the runtime ticks of current playing item. + /// Gets the runtime ticks of current playing item. /// /// The runtime ticks of current playing item. public long RunTimeTicks { get; private set; } @@ -112,30 +136,6 @@ namespace Emby.Server.Implementations.SyncPlay public Dictionary Participants { get; } = new Dictionary(StringComparer.OrdinalIgnoreCase); - /// - /// Initializes a new instance of the class. - /// - /// The logger. - /// The user manager. - /// The session manager. - /// The library manager. - /// The SyncPlay manager. - public SyncPlayGroupController( - ILogger logger, - IUserManager userManager, - ISessionManager sessionManager, - ILibraryManager libraryManager, - ISyncPlayManager syncPlayManager) - { - _logger = logger; - _userManager = userManager; - _sessionManager = sessionManager; - _libraryManager = libraryManager; - _syncPlayManager = syncPlayManager; - - State = new IdleGroupState(_logger); - } - /// /// Adds the session to the group. /// @@ -167,34 +167,32 @@ namespace Emby.Server.Implementations.SyncPlay /// The current session. /// The filtering type. /// The array of sessions matching the filter. - private SessionInfo[] FilterSessions(SessionInfo from, SyncPlayBroadcastType type) - { - switch (type) - { - case SyncPlayBroadcastType.CurrentSession: - return new SessionInfo[] { from }; - case SyncPlayBroadcastType.AllGroup: - return Participants - .Values - .Select(session => session.Session) - .ToArray(); - case SyncPlayBroadcastType.AllExceptCurrentSession: - return Participants - .Values - .Select(session => session.Session) - .Where(session => !session.Id.Equals(from.Id)) - .ToArray(); - case SyncPlayBroadcastType.AllReady: - return Participants - .Values - .Where(session => !session.IsBuffering) - .Select(session => session.Session) - .ToArray(); - default: - return Array.Empty(); - } + private IEnumerable FilterSessions(SessionInfo from, SyncPlayBroadcastType type) + { + return type switch + { + SyncPlayBroadcastType.CurrentSession => new SessionInfo[] { from }, + SyncPlayBroadcastType.AllGroup => Participants + .Values + .Select(session => session.Session), + SyncPlayBroadcastType.AllExceptCurrentSession => Participants + .Values + .Select(session => session.Session) + .Where(session => !session.Id.Equals(from.Id, StringComparison.OrdinalIgnoreCase)), + SyncPlayBroadcastType.AllReady => Participants + .Values + .Where(session => !session.IsBuffering) + .Select(session => session.Session), + _ => Enumerable.Empty() + }; } + /// + /// Checks if a given user can access a given item, that is, the user has access to a folder where the item is stored. + /// + /// The user. + /// The item. + /// true if the user can access the item, false otherwise. private bool HasAccessToItem(User user, BaseItem item) { var collections = _libraryManager.GetCollectionFolders(item) @@ -202,41 +200,42 @@ namespace Emby.Server.Implementations.SyncPlay return collections.Intersect(user.GetPreference(PreferenceKind.EnabledFolders)).Any(); } - private bool HasAccessToQueue(User user, Guid[] queue) + /// + /// Checks if a given user can access all items of a given queue, that is, + /// the user has the required minimum parental access and has access to all required folders. + /// + /// The user. + /// The queue. + /// true if the user can access all the items in the queue, false otherwise. + private bool HasAccessToQueue(User user, IEnumerable queue) { - if (queue == null || queue.Length == 0) + // Check if queue is empty. + if (!queue?.Any() ?? true) { return true; } - var items = queue.ToList() - .Select(item => _libraryManager.GetItemById(item)); - - // Find the highest rating value, which becomes the required minimum for the user. - var MinParentalRatingAccessRequired = items - .Select(item => item.InheritedParentalRatingValue) - .Min(); - - // Check ParentalRating access, user must have the minimum required access level. - var hasParentalRatingAccess = !user.MaxParentalAgeRating.HasValue - || MinParentalRatingAccessRequired <= user.MaxParentalAgeRating; - - // Check that user has access to all required folders. - if (!user.HasPermission(PermissionKind.EnableAllFolders) && hasParentalRatingAccess) + foreach (var itemId in queue) { - // Get list of items that are not accessible. - var blockedItems = items.Where(item => !HasAccessToItem(user, item)); + var item = _libraryManager.GetItemById(itemId); + if (user.MaxParentalAgeRating.HasValue && item.InheritedParentalRatingValue > user.MaxParentalAgeRating) + { + return false; + } - // We need the user to be able to access all items. - return !blockedItems.Any(); + if (!user.HasPermission(PermissionKind.EnableAllFolders) && !HasAccessToItem(user, item)) + { + return false; + } } - return hasParentalRatingAccess; + return true; } - private bool AllUsersHaveAccessToQueue(Guid[] queue) + private bool AllUsersHaveAccessToQueue(IEnumerable queue) { - if (queue == null || queue.Length == 0) + // Check if queue is empty. + if (!queue?.Any() ?? true) { return true; } @@ -269,7 +268,7 @@ namespace Emby.Server.Implementations.SyncPlay if (sessionIsPlayingAnItem) { - var playlist = session.NowPlayingQueue.Select(item => item.Id).ToArray(); + var playlist = session.NowPlayingQueue.Select(item => item.Id); PlayQueue.Reset(); PlayQueue.SetPlaylist(playlist); PlayQueue.SetPlayingItemById(session.FullNowPlayingItem.Id); @@ -277,17 +276,19 @@ namespace Emby.Server.Implementations.SyncPlay PositionTicks = session.PlayState.PositionTicks ?? 0; // Mantain playstate. - var waitingState = new WaitingGroupState(_logger); - waitingState.ResumePlaying = !session.PlayState.IsPaused; + var waitingState = new WaitingGroupState(_logger) + { + ResumePlaying = !session.PlayState.IsPaused + }; SetState(waitingState); } var updateSession = NewSyncPlayGroupUpdate(GroupUpdateType.GroupJoined, GetInfo()); SendGroupUpdate(session, SyncPlayBroadcastType.CurrentSession, updateSession, cancellationToken); - State.SessionJoined(this, State.GetGroupState(), session, cancellationToken); + _state.SessionJoined(this, _state.Type, session, cancellationToken); - _logger.LogInformation("InitGroup: {0} created group {1}.", session.Id.ToString(), GroupId.ToString()); + _logger.LogInformation("InitGroup: {0} created group {1}.", session.Id, GroupId.ToString()); } /// @@ -302,9 +303,9 @@ namespace Emby.Server.Implementations.SyncPlay var updateOthers = NewSyncPlayGroupUpdate(GroupUpdateType.UserJoined, session.UserName); SendGroupUpdate(session, SyncPlayBroadcastType.AllExceptCurrentSession, updateOthers, cancellationToken); - State.SessionJoined(this, State.GetGroupState(), session, cancellationToken); + _state.SessionJoined(this, _state.Type, session, cancellationToken); - _logger.LogInformation("SessionJoin: {0} joined group {1}.", session.Id.ToString(), GroupId.ToString()); + _logger.LogInformation("SessionJoin: {0} joined group {1}.", session.Id, GroupId.ToString()); } /// @@ -316,15 +317,15 @@ namespace Emby.Server.Implementations.SyncPlay var updateOthers = NewSyncPlayGroupUpdate(GroupUpdateType.UserJoined, session.UserName); SendGroupUpdate(session, SyncPlayBroadcastType.AllExceptCurrentSession, updateOthers, cancellationToken); - State.SessionJoined(this, State.GetGroupState(), session, cancellationToken); + _state.SessionJoined(this, _state.Type, session, cancellationToken); - _logger.LogInformation("SessionRestore: {0} re-joined group {1}.", session.Id.ToString(), GroupId.ToString()); + _logger.LogInformation("SessionRestore: {0} re-joined group {1}.", session.Id, GroupId.ToString()); } /// public void SessionLeave(SessionInfo session, CancellationToken cancellationToken) { - State.SessionLeaving(this, State.GetGroupState(), session, cancellationToken); + _state.SessionLeaving(this, _state.Type, session, cancellationToken); RemoveSession(session); _syncPlayManager.RemoveSessionFromGroup(session, this); @@ -335,18 +336,17 @@ namespace Emby.Server.Implementations.SyncPlay var updateOthers = NewSyncPlayGroupUpdate(GroupUpdateType.UserLeft, session.UserName); SendGroupUpdate(session, SyncPlayBroadcastType.AllExceptCurrentSession, updateOthers, cancellationToken); - _logger.LogInformation("SessionLeave: {0} left group {1}.", session.Id.ToString(), GroupId.ToString()); + _logger.LogInformation("SessionLeave: {0} left group {1}.", session.Id, GroupId.ToString()); } /// - public void HandleRequest(SessionInfo session, IPlaybackGroupRequest request, CancellationToken cancellationToken) + public void HandleRequest(SessionInfo session, IGroupPlaybackRequest request, CancellationToken cancellationToken) { // The server's job is to maintain a consistent state for clients to reference // and notify clients of state changes. The actual syncing of media playback // happens client side. Clients are aware of the server's time and use it to sync. - _logger.LogInformation("HandleRequest: {0} requested {1}, group {2} in {3} state.", - session.Id.ToString(), request.GetRequestType(), GroupId.ToString(), State.GetGroupState()); - request.Apply(this, State, session, cancellationToken); + _logger.LogInformation("HandleRequest: {0} requested {1}, group {2} in {3} state.", session.Id, request.Type, GroupId.ToString(), _state.Type); + request.Apply(this, _state, session, cancellationToken); } /// @@ -356,7 +356,7 @@ namespace Emby.Server.Implementations.SyncPlay { GroupId = GroupId.ToString(), GroupName = GroupName, - State = State.GetGroupState(), + State = _state.Type, Participants = Participants.Values.Select(session => session.Session.UserName).Distinct().ToList(), LastUpdatedAt = DateToUTCString(DateTime.UtcNow) }; @@ -365,7 +365,7 @@ namespace Emby.Server.Implementations.SyncPlay /// public bool HasAccessToPlayQueue(User user) { - var items = PlayQueue.GetPlaylist().Select(item => item.ItemId).ToArray(); + var items = PlayQueue.GetPlaylist().Select(item => item.ItemId); return HasAccessToQueue(user, items); } @@ -381,10 +381,10 @@ namespace Emby.Server.Implementations.SyncPlay } /// - public void SetState(ISyncPlayState state) + public void SetState(IGroupState state) { - _logger.LogInformation("SetState: {0} switching from {1} to {2}.", GroupId.ToString(), State.GetGroupState(), state.GetGroupState()); - this.State = state; + _logger.LogInformation("SetState: {0} switching from {1} to {2}.", GroupId.ToString(), _state.Type, state.Type); + this._state = state; } /// @@ -443,16 +443,14 @@ namespace Emby.Server.Implementations.SyncPlay /// public string DateToUTCString(DateTime dateTime) { - return dateTime.ToUniversalTime().ToString("o"); + return dateTime.ToUniversalTime().ToString("o", CultureInfo.InvariantCulture); } /// public long SanitizePositionTicks(long? positionTicks) { var ticks = positionTicks ?? 0; - ticks = Math.Max(ticks, 0); - ticks = Math.Min(ticks, RunTimeTicks); - return ticks; + return Math.Clamp(ticks, 0, RunTimeTicks); } /// @@ -509,10 +507,10 @@ namespace Emby.Server.Implementations.SyncPlay } /// - public bool SetPlayQueue(Guid[] playQueue, int playingItemPosition, long startPositionTicks) + public bool SetPlayQueue(IEnumerable playQueue, int playingItemPosition, long startPositionTicks) { // Ignore on empty queue or invalid item position. - if (playQueue.Length < 1 || playingItemPosition >= playQueue.Length || playingItemPosition < 0) + if (!playQueue.Any() || playingItemPosition >= playQueue.Count() || playingItemPosition < 0) { return false; } @@ -555,7 +553,7 @@ namespace Emby.Server.Implementations.SyncPlay } /// - public bool RemoveFromPlayQueue(string[] playlistItemIds) + public bool RemoveFromPlayQueue(IEnumerable playlistItemIds) { var playingItemRemoved = PlayQueue.RemoveFromPlaylist(playlistItemIds); if (playingItemRemoved) @@ -584,10 +582,10 @@ namespace Emby.Server.Implementations.SyncPlay } /// - public bool AddToPlayQueue(Guid[] newItems, string mode) + public bool AddToPlayQueue(IEnumerable newItems, string mode) { // Ignore on empty list. - if (newItems.Length < 1) + if (!newItems.Any()) { return false; } @@ -598,7 +596,7 @@ namespace Emby.Server.Implementations.SyncPlay return false; } - if (mode.Equals("next")) + if (mode.Equals("next", StringComparison.OrdinalIgnoreCase)) { PlayQueue.QueueNext(newItems); } @@ -652,7 +650,8 @@ namespace Emby.Server.Implementations.SyncPlay } /// - public void SetRepeatMode(string mode) { + public void SetRepeatMode(string mode) + { switch (mode) { case "RepeatOne": @@ -669,7 +668,8 @@ namespace Emby.Server.Implementations.SyncPlay } /// - public void SetShuffleMode(string mode) { + public void SetShuffleMode(string mode) + { switch (mode) { case "Shuffle": @@ -687,7 +687,7 @@ namespace Emby.Server.Implementations.SyncPlay { var startPositionTicks = PositionTicks; - if (State.GetGroupState().Equals(GroupState.Playing)) + if (_state.Type.Equals(GroupStateType.Playing)) { var currentTime = DateTime.UtcNow; var elapsedTime = currentTime - LastActivity; @@ -711,6 +711,5 @@ namespace Emby.Server.Implementations.SyncPlay RepeatMode = PlayQueue.RepeatMode }; } - } } diff --git a/Emby.Server.Implementations/SyncPlay/GroupStates/AbstractGroupState.cs b/Emby.Server.Implementations/SyncPlay/GroupStates/AbstractGroupState.cs deleted file mode 100644 index 26cd51b8d8..0000000000 --- a/Emby.Server.Implementations/SyncPlay/GroupStates/AbstractGroupState.cs +++ /dev/null @@ -1,218 +0,0 @@ -using System.Threading; -using MediaBrowser.Controller.Session; -using MediaBrowser.Model.SyncPlay; -using Microsoft.Extensions.Logging; - -namespace MediaBrowser.Controller.SyncPlay -{ - /// - /// Class AbstractGroupState. - /// - /// - /// Class is not thread-safe, external locking is required when accessing methods. - /// - public abstract class AbstractGroupState : ISyncPlayState - { - /// - /// The logger. - /// - protected readonly ILogger _logger; - - /// - /// Default constructor. - /// - public AbstractGroupState(ILogger logger) - { - _logger = logger; - } - - /// - /// Sends a group state update to all group. - /// - /// The context of the state. - /// The reason of the state change. - /// The session. - /// The cancellation token. - protected void SendGroupStateUpdate(ISyncPlayStateContext context, IPlaybackGroupRequest reason, SessionInfo session, CancellationToken cancellationToken) - { - // Notify relevant state change event. - var stateUpdate = new GroupStateUpdate() - { - State = GetGroupState(), - Reason = reason.GetRequestType() - }; - var update = context.NewSyncPlayGroupUpdate(GroupUpdateType.StateUpdate, stateUpdate); - context.SendGroupUpdate(session, SyncPlayBroadcastType.AllGroup, update, cancellationToken); - } - - /// - public abstract GroupState GetGroupState(); - - /// - public abstract void SessionJoined(ISyncPlayStateContext context, GroupState prevState, SessionInfo session, CancellationToken cancellationToken); - - /// - public abstract void SessionLeaving(ISyncPlayStateContext context, GroupState prevState, SessionInfo session, CancellationToken cancellationToken); - - /// - public virtual void HandleRequest(ISyncPlayStateContext context, GroupState prevState, IPlaybackGroupRequest request, SessionInfo session, CancellationToken cancellationToken) - { - UnhandledRequest(request); - } - - /// - public virtual void HandleRequest(ISyncPlayStateContext context, GroupState prevState, PlayGroupRequest request, SessionInfo session, CancellationToken cancellationToken) - { - UnhandledRequest(request); - } - - /// - public virtual void HandleRequest(ISyncPlayStateContext context, GroupState prevState, SetPlaylistItemGroupRequest request, SessionInfo session, CancellationToken cancellationToken) - { - var waitingState = new WaitingGroupState(_logger); - context.SetState(waitingState); - waitingState.HandleRequest(context, GetGroupState(), request, session, cancellationToken); - } - - /// - public virtual void HandleRequest(ISyncPlayStateContext context, GroupState prevState, RemoveFromPlaylistGroupRequest request, SessionInfo session, CancellationToken cancellationToken) - { - var playingItemRemoved = context.RemoveFromPlayQueue(request.PlaylistItemIds); - - var playQueueUpdate = context.GetPlayQueueUpdate(PlayQueueUpdateReason.RemoveItems); - var update = context.NewSyncPlayGroupUpdate(GroupUpdateType.PlayQueue, playQueueUpdate); - context.SendGroupUpdate(session, SyncPlayBroadcastType.AllGroup, update, cancellationToken); - - if (playingItemRemoved) - { - var PlayingItemIndex = context.PlayQueue.PlayingItemIndex; - if (context.PlayQueue.PlayingItemIndex == -1) - { - _logger.LogDebug("HandleRequest: {0} in group {1}, play queue is empty.", request.GetRequestType(), context.GroupId.ToString()); - - ISyncPlayState idleState = new IdleGroupState(_logger); - context.SetState(idleState); - var stopRequest = new StopGroupRequest(); - idleState.HandleRequest(context, GetGroupState(), stopRequest, session, cancellationToken); - } - } - } - - /// - public virtual void HandleRequest(ISyncPlayStateContext context, GroupState prevState, MovePlaylistItemGroupRequest request, SessionInfo session, CancellationToken cancellationToken) - { - var result = context.MoveItemInPlayQueue(request.PlaylistItemId, request.NewIndex); - - if (!result) - { - _logger.LogError("HandleRequest: {0} in group {1}, unable to move item in play queue.", request.GetRequestType(), context.GroupId.ToString()); - return; - } - - var playQueueUpdate = context.GetPlayQueueUpdate(PlayQueueUpdateReason.MoveItem); - var update = context.NewSyncPlayGroupUpdate(GroupUpdateType.PlayQueue, playQueueUpdate); - context.SendGroupUpdate(session, SyncPlayBroadcastType.AllGroup, update, cancellationToken); - } - - /// - public virtual void HandleRequest(ISyncPlayStateContext context, GroupState prevState, QueueGroupRequest request, SessionInfo session, CancellationToken cancellationToken) - { - var result = context.AddToPlayQueue(request.ItemIds, request.Mode); - - if (!result) - { - _logger.LogError("HandleRequest: {0} in group {1}, unable to add items to play queue.", request.GetRequestType(), context.GroupId.ToString()); - return; - } - - var reason = request.Mode.Equals("next") ? PlayQueueUpdateReason.QueueNext : PlayQueueUpdateReason.Queue; - var playQueueUpdate = context.GetPlayQueueUpdate(reason); - var update = context.NewSyncPlayGroupUpdate(GroupUpdateType.PlayQueue, playQueueUpdate); - context.SendGroupUpdate(session, SyncPlayBroadcastType.AllGroup, update, cancellationToken); - } - - /// - public virtual void HandleRequest(ISyncPlayStateContext context, GroupState prevState, UnpauseGroupRequest request, SessionInfo session, CancellationToken cancellationToken) - { - UnhandledRequest(request); - } - - /// - public virtual void HandleRequest(ISyncPlayStateContext context, GroupState prevState, PauseGroupRequest request, SessionInfo session, CancellationToken cancellationToken) - { - UnhandledRequest(request); - } - - /// - public virtual void HandleRequest(ISyncPlayStateContext context, GroupState prevState, StopGroupRequest request, SessionInfo session, CancellationToken cancellationToken) - { - UnhandledRequest(request); - } - - /// - public virtual void HandleRequest(ISyncPlayStateContext context, GroupState prevState, SeekGroupRequest request, SessionInfo session, CancellationToken cancellationToken) - { - UnhandledRequest(request); - } - - /// - public virtual void HandleRequest(ISyncPlayStateContext context, GroupState prevState, BufferGroupRequest request, SessionInfo session, CancellationToken cancellationToken) - { - UnhandledRequest(request); - } - - /// - public virtual void HandleRequest(ISyncPlayStateContext context, GroupState prevState, ReadyGroupRequest request, SessionInfo session, CancellationToken cancellationToken) - { - UnhandledRequest(request); - } - - /// - public virtual void HandleRequest(ISyncPlayStateContext context, GroupState prevState, NextTrackGroupRequest request, SessionInfo session, CancellationToken cancellationToken) - { - UnhandledRequest(request); - } - - /// - public virtual void HandleRequest(ISyncPlayStateContext context, GroupState prevState, PreviousTrackGroupRequest request, SessionInfo session, CancellationToken cancellationToken) - { - UnhandledRequest(request); - } - - /// - public virtual void HandleRequest(ISyncPlayStateContext context, GroupState prevState, SetRepeatModeGroupRequest request, SessionInfo session, CancellationToken cancellationToken) - { - context.SetRepeatMode(request.Mode); - var playQueueUpdate = context.GetPlayQueueUpdate(PlayQueueUpdateReason.RepeatMode); - var update = context.NewSyncPlayGroupUpdate(GroupUpdateType.PlayQueue, playQueueUpdate); - context.SendGroupUpdate(session, SyncPlayBroadcastType.AllGroup, update, cancellationToken); - } - - /// - public virtual void HandleRequest(ISyncPlayStateContext context, GroupState prevState, SetShuffleModeGroupRequest request, SessionInfo session, CancellationToken cancellationToken) - { - context.SetShuffleMode(request.Mode); - var playQueueUpdate = context.GetPlayQueueUpdate(PlayQueueUpdateReason.ShuffleMode); - var update = context.NewSyncPlayGroupUpdate(GroupUpdateType.PlayQueue, playQueueUpdate); - context.SendGroupUpdate(session, SyncPlayBroadcastType.AllGroup, update, cancellationToken); - } - - /// - public virtual void HandleRequest(ISyncPlayStateContext context, GroupState prevState, PingGroupRequest request, SessionInfo session, CancellationToken cancellationToken) - { - // Collected pings are used to account for network latency when unpausing playback. - context.UpdatePing(session, request.Ping); - } - - /// - public virtual void HandleRequest(ISyncPlayStateContext context, GroupState prevState, IgnoreWaitGroupRequest request, SessionInfo session, CancellationToken cancellationToken) - { - context.SetIgnoreGroupWait(session, request.IgnoreWait); - } - - private void UnhandledRequest(IPlaybackGroupRequest request) - { - _logger.LogWarning("HandleRequest: unhandled {0} request for {1} state.", request.GetRequestType(), GetGroupState()); - } - } -} diff --git a/Emby.Server.Implementations/SyncPlay/GroupStates/IdleGroupState.cs b/Emby.Server.Implementations/SyncPlay/GroupStates/IdleGroupState.cs deleted file mode 100644 index 70fe3e0067..0000000000 --- a/Emby.Server.Implementations/SyncPlay/GroupStates/IdleGroupState.cs +++ /dev/null @@ -1,122 +0,0 @@ -using System.Threading; -using MediaBrowser.Controller.Session; -using MediaBrowser.Model.SyncPlay; -using Microsoft.Extensions.Logging; - -namespace MediaBrowser.Controller.SyncPlay -{ - /// - /// Class IdleGroupState. - /// - /// - /// Class is not thread-safe, external locking is required when accessing methods. - /// - public class IdleGroupState : AbstractGroupState - { - /// - /// Default constructor. - /// - public IdleGroupState(ILogger logger) - : base(logger) - { - // Do nothing. - } - - /// - public override GroupState GetGroupState() - { - return GroupState.Idle; - } - - /// - public override void SessionJoined(ISyncPlayStateContext context, GroupState prevState, SessionInfo session, CancellationToken cancellationToken) - { - SendStopCommand(context, GetGroupState(), session, cancellationToken); - } - - /// - public override void SessionLeaving(ISyncPlayStateContext context, GroupState prevState, SessionInfo session, CancellationToken cancellationToken) - { - // Do nothing. - } - - /// - public override void HandleRequest(ISyncPlayStateContext context, GroupState prevState, PlayGroupRequest request, SessionInfo session, CancellationToken cancellationToken) - { - // Change state. - var waitingState = new WaitingGroupState(_logger); - context.SetState(waitingState); - waitingState.HandleRequest(context, GetGroupState(), request, session, cancellationToken); - } - - /// - public override void HandleRequest(ISyncPlayStateContext context, GroupState prevState, UnpauseGroupRequest request, SessionInfo session, CancellationToken cancellationToken) - { - // Change state. - var waitingState = new WaitingGroupState(_logger); - context.SetState(waitingState); - waitingState.HandleRequest(context, GetGroupState(), request, session, cancellationToken); - } - - /// - public override void HandleRequest(ISyncPlayStateContext context, GroupState prevState, PauseGroupRequest request, SessionInfo session, CancellationToken cancellationToken) - { - SendStopCommand(context, prevState, session, cancellationToken); - } - - /// - public override void HandleRequest(ISyncPlayStateContext context, GroupState prevState, StopGroupRequest request, SessionInfo session, CancellationToken cancellationToken) - { - SendStopCommand(context, prevState, session, cancellationToken); - } - - /// - public override void HandleRequest(ISyncPlayStateContext context, GroupState prevState, SeekGroupRequest request, SessionInfo session, CancellationToken cancellationToken) - { - SendStopCommand(context, prevState, session, cancellationToken); - } - - /// - public override void HandleRequest(ISyncPlayStateContext context, GroupState prevState, BufferGroupRequest request, SessionInfo session, CancellationToken cancellationToken) - { - SendStopCommand(context, prevState, session, cancellationToken); - } - - /// - public override void HandleRequest(ISyncPlayStateContext context, GroupState prevState, ReadyGroupRequest request, SessionInfo session, CancellationToken cancellationToken) - { - SendStopCommand(context, prevState, session, cancellationToken); - } - - /// - public override void HandleRequest(ISyncPlayStateContext context, GroupState prevState, NextTrackGroupRequest request, SessionInfo session, CancellationToken cancellationToken) - { - // Change state. - var waitingState = new WaitingGroupState(_logger); - context.SetState(waitingState); - waitingState.HandleRequest(context, GetGroupState(), request, session, cancellationToken); - } - - /// - public override void HandleRequest(ISyncPlayStateContext context, GroupState prevState, PreviousTrackGroupRequest request, SessionInfo session, CancellationToken cancellationToken) - { - // Change state. - var waitingState = new WaitingGroupState(_logger); - context.SetState(waitingState); - waitingState.HandleRequest(context, GetGroupState(), request, session, cancellationToken); - } - - private void SendStopCommand(ISyncPlayStateContext context, GroupState prevState, SessionInfo session, CancellationToken cancellationToken) - { - var command = context.NewSyncPlayCommand(SendCommandType.Stop); - if (!prevState.Equals(GetGroupState())) - { - context.SendCommand(session, SyncPlayBroadcastType.AllGroup, command, cancellationToken); - } - else - { - context.SendCommand(session, SyncPlayBroadcastType.CurrentSession, command, cancellationToken); - } - } - } -} diff --git a/Emby.Server.Implementations/SyncPlay/GroupStates/PausedGroupState.cs b/Emby.Server.Implementations/SyncPlay/GroupStates/PausedGroupState.cs deleted file mode 100644 index ca2cb0988b..0000000000 --- a/Emby.Server.Implementations/SyncPlay/GroupStates/PausedGroupState.cs +++ /dev/null @@ -1,161 +0,0 @@ -using System; -using System.Threading; -using MediaBrowser.Controller.Session; -using MediaBrowser.Model.SyncPlay; -using Microsoft.Extensions.Logging; - -namespace MediaBrowser.Controller.SyncPlay -{ - /// - /// Class PausedGroupState. - /// - /// - /// Class is not thread-safe, external locking is required when accessing methods. - /// - public class PausedGroupState : AbstractGroupState - { - /// - /// Default constructor. - /// - public PausedGroupState(ILogger logger) - : base(logger) - { - // Do nothing. - } - - /// - public override GroupState GetGroupState() - { - return GroupState.Paused; - } - - /// - public override void SessionJoined(ISyncPlayStateContext context, GroupState prevState, SessionInfo session, CancellationToken cancellationToken) - { - // Wait for session to be ready. - var waitingState = new WaitingGroupState(_logger); - context.SetState(waitingState); - waitingState.SessionJoined(context, GetGroupState(), session, cancellationToken); - } - - /// - public override void SessionLeaving(ISyncPlayStateContext context, GroupState prevState, SessionInfo session, CancellationToken cancellationToken) - { - // Do nothing. - } - - /// - public override void HandleRequest(ISyncPlayStateContext context, GroupState prevState, PlayGroupRequest request, SessionInfo session, CancellationToken cancellationToken) - { - // Change state. - var waitingState = new WaitingGroupState(_logger); - context.SetState(waitingState); - waitingState.HandleRequest(context, GetGroupState(), request, session, cancellationToken); - } - - /// - public override void HandleRequest(ISyncPlayStateContext context, GroupState prevState, UnpauseGroupRequest request, SessionInfo session, CancellationToken cancellationToken) - { - // Change state. - var playingState = new PlayingGroupState(_logger); - context.SetState(playingState); - playingState.HandleRequest(context, GetGroupState(), request, session, cancellationToken); - } - - /// - public override void HandleRequest(ISyncPlayStateContext context, GroupState prevState, PauseGroupRequest request, SessionInfo session, CancellationToken cancellationToken) - { - if (!prevState.Equals(GetGroupState())) - { - // Pause group and compute the media playback position. - var currentTime = DateTime.UtcNow; - var elapsedTime = currentTime - context.LastActivity; - context.LastActivity = currentTime; - // Elapsed time is negative if event happens - // during the delay added to account for latency. - // In this phase clients haven't started the playback yet. - // In other words, LastActivity is in the future, - // when playback unpause is supposed to happen. - // Seek only if playback actually started. - context.PositionTicks += Math.Max(elapsedTime.Ticks, 0); - - var command = context.NewSyncPlayCommand(SendCommandType.Pause); - context.SendCommand(session, SyncPlayBroadcastType.AllGroup, command, cancellationToken); - - // Notify relevant state change event. - SendGroupStateUpdate(context, request, session, cancellationToken); - } - else - { - // Client got lost, sending current state. - var command = context.NewSyncPlayCommand(SendCommandType.Pause); - context.SendCommand(session, SyncPlayBroadcastType.CurrentSession, command, cancellationToken); - } - } - - /// - public override void HandleRequest(ISyncPlayStateContext context, GroupState prevState, StopGroupRequest request, SessionInfo session, CancellationToken cancellationToken) - { - // Change state. - var idleState = new IdleGroupState(_logger); - context.SetState(idleState); - idleState.HandleRequest(context, GetGroupState(), request, session, cancellationToken); - } - - /// - public override void HandleRequest(ISyncPlayStateContext context, GroupState prevState, SeekGroupRequest request, SessionInfo session, CancellationToken cancellationToken) - { - // Change state. - var waitingState = new WaitingGroupState(_logger); - context.SetState(waitingState); - waitingState.HandleRequest(context, GetGroupState(), request, session, cancellationToken); - } - - /// - public override void HandleRequest(ISyncPlayStateContext context, GroupState prevState, BufferGroupRequest request, SessionInfo session, CancellationToken cancellationToken) - { - // Change state. - var waitingState = new WaitingGroupState(_logger); - context.SetState(waitingState); - waitingState.HandleRequest(context, GetGroupState(), request, session, cancellationToken); - } - - /// - public override void HandleRequest(ISyncPlayStateContext context, GroupState prevState, ReadyGroupRequest request, SessionInfo session, CancellationToken cancellationToken) - { - if (prevState.Equals(GetGroupState())) - { - // Client got lost, sending current state. - var command = context.NewSyncPlayCommand(SendCommandType.Pause); - context.SendCommand(session, SyncPlayBroadcastType.CurrentSession, command, cancellationToken); - } - else if (prevState.Equals(GroupState.Waiting)) - { - // Sending current state to all clients. - var command = context.NewSyncPlayCommand(SendCommandType.Pause); - context.SendCommand(session, SyncPlayBroadcastType.AllGroup, command, cancellationToken); - - // Notify relevant state change event. - SendGroupStateUpdate(context, request, session, cancellationToken); - } - } - - /// - public override void HandleRequest(ISyncPlayStateContext context, GroupState prevState, NextTrackGroupRequest request, SessionInfo session, CancellationToken cancellationToken) - { - // Change state. - var waitingState = new WaitingGroupState(_logger); - context.SetState(waitingState); - waitingState.HandleRequest(context, GetGroupState(), request, session, cancellationToken); - } - - /// - public override void HandleRequest(ISyncPlayStateContext context, GroupState prevState, PreviousTrackGroupRequest request, SessionInfo session, CancellationToken cancellationToken) - { - // Change state. - var waitingState = new WaitingGroupState(_logger); - context.SetState(waitingState); - waitingState.HandleRequest(context, GetGroupState(), request, session, cancellationToken); - } - } -} diff --git a/Emby.Server.Implementations/SyncPlay/GroupStates/PlayingGroupState.cs b/Emby.Server.Implementations/SyncPlay/GroupStates/PlayingGroupState.cs deleted file mode 100644 index 85119669dd..0000000000 --- a/Emby.Server.Implementations/SyncPlay/GroupStates/PlayingGroupState.cs +++ /dev/null @@ -1,166 +0,0 @@ -using System; -using System.Threading; -using MediaBrowser.Controller.Session; -using MediaBrowser.Model.SyncPlay; -using Microsoft.Extensions.Logging; - -namespace MediaBrowser.Controller.SyncPlay -{ - /// - /// Class PlayingGroupState. - /// - /// - /// Class is not thread-safe, external locking is required when accessing methods. - /// - public class PlayingGroupState : AbstractGroupState - { - /// - /// Ignore requests for buffering. - /// - public bool IgnoreBuffering { get; set; } - - /// - /// Default constructor. - /// - public PlayingGroupState(ILogger logger) - : base(logger) - { - // Do nothing. - } - - /// - public override GroupState GetGroupState() - { - return GroupState.Playing; - } - - /// - public override void SessionJoined(ISyncPlayStateContext context, GroupState prevState, SessionInfo session, CancellationToken cancellationToken) - { - // Wait for session to be ready. - var waitingState = new WaitingGroupState(_logger); - context.SetState(waitingState); - waitingState.SessionJoined(context, GetGroupState(), session, cancellationToken); - } - - /// - public override void SessionLeaving(ISyncPlayStateContext context, GroupState prevState, SessionInfo session, CancellationToken cancellationToken) - { - // Do nothing. - } - - /// - public override void HandleRequest(ISyncPlayStateContext context, GroupState prevState, PlayGroupRequest request, SessionInfo session, CancellationToken cancellationToken) - { - // Change state. - var waitingState = new WaitingGroupState(_logger); - context.SetState(waitingState); - waitingState.HandleRequest(context, GetGroupState(), request, session, cancellationToken); - } - - /// - public override void HandleRequest(ISyncPlayStateContext context, GroupState prevState, UnpauseGroupRequest request, SessionInfo session, CancellationToken cancellationToken) - { - if (!prevState.Equals(GetGroupState())) - { - // Pick a suitable time that accounts for latency. - var delayMillis = Math.Max(context.GetHighestPing() * 2, context.DefaultPing); - - // Unpause group and set starting point in future. - // Clients will start playback at LastActivity (datetime) from PositionTicks (playback position). - // The added delay does not guarantee, of course, that the command will be received in time. - // Playback synchronization will mainly happen client side. - context.LastActivity = DateTime.UtcNow.AddMilliseconds( - delayMillis - ); - - var command = context.NewSyncPlayCommand(SendCommandType.Unpause); - context.SendCommand(session, SyncPlayBroadcastType.AllGroup, command, cancellationToken); - - // Notify relevant state change event. - SendGroupStateUpdate(context, request, session, cancellationToken); - } - else - { - // Client got lost, sending current state. - var command = context.NewSyncPlayCommand(SendCommandType.Unpause); - context.SendCommand(session, SyncPlayBroadcastType.CurrentSession, command, cancellationToken); - } - } - - /// - public override void HandleRequest(ISyncPlayStateContext context, GroupState prevState, PauseGroupRequest request, SessionInfo session, CancellationToken cancellationToken) - { - // Change state. - var pausedState = new PausedGroupState(_logger); - context.SetState(pausedState); - pausedState.HandleRequest(context, GetGroupState(), request, session, cancellationToken); - } - - /// - public override void HandleRequest(ISyncPlayStateContext context, GroupState prevState, StopGroupRequest request, SessionInfo session, CancellationToken cancellationToken) - { - // Change state. - var idleState = new IdleGroupState(_logger); - context.SetState(idleState); - idleState.HandleRequest(context, GetGroupState(), request, session, cancellationToken); - } - - /// - public override void HandleRequest(ISyncPlayStateContext context, GroupState prevState, SeekGroupRequest request, SessionInfo session, CancellationToken cancellationToken) - { - // Change state. - var waitingState = new WaitingGroupState(_logger); - context.SetState(waitingState); - waitingState.HandleRequest(context, GetGroupState(), request, session, cancellationToken); - } - - /// - public override void HandleRequest(ISyncPlayStateContext context, GroupState prevState, BufferGroupRequest request, SessionInfo session, CancellationToken cancellationToken) - { - if (IgnoreBuffering) - { - return; - } - - // Change state. - var waitingState = new WaitingGroupState(_logger); - context.SetState(waitingState); - waitingState.HandleRequest(context, GetGroupState(), request, session, cancellationToken); - } - - /// - public override void HandleRequest(ISyncPlayStateContext context, GroupState prevState, ReadyGroupRequest request, SessionInfo session, CancellationToken cancellationToken) - { - if (prevState.Equals(GetGroupState())) - { - // Group was not waiting, make sure client has latest state. - var command = context.NewSyncPlayCommand(SendCommandType.Unpause); - context.SendCommand(session, SyncPlayBroadcastType.CurrentSession, command, cancellationToken); - } - else if (prevState.Equals(GroupState.Waiting)) - { - // Notify relevant state change event. - SendGroupStateUpdate(context, request, session, cancellationToken); - } - } - - /// - public override void HandleRequest(ISyncPlayStateContext context, GroupState prevState, NextTrackGroupRequest request, SessionInfo session, CancellationToken cancellationToken) - { - // Change state. - var waitingState = new WaitingGroupState(_logger); - context.SetState(waitingState); - waitingState.HandleRequest(context, GetGroupState(), request, session, cancellationToken); - } - - /// - public override void HandleRequest(ISyncPlayStateContext context, GroupState prevState, PreviousTrackGroupRequest request, SessionInfo session, CancellationToken cancellationToken) - { - // Change state. - var waitingState = new WaitingGroupState(_logger); - context.SetState(waitingState); - waitingState.HandleRequest(context, GetGroupState(), request, session, cancellationToken); - } - } -} diff --git a/Emby.Server.Implementations/SyncPlay/GroupStates/WaitingGroupState.cs b/Emby.Server.Implementations/SyncPlay/GroupStates/WaitingGroupState.cs deleted file mode 100644 index bc3cc49182..0000000000 --- a/Emby.Server.Implementations/SyncPlay/GroupStates/WaitingGroupState.cs +++ /dev/null @@ -1,683 +0,0 @@ -using System; -using System.Threading; -using MediaBrowser.Controller.Session; -using MediaBrowser.Model.SyncPlay; -using Microsoft.Extensions.Logging; - -namespace MediaBrowser.Controller.SyncPlay -{ - /// - /// Class WaitingGroupState. - /// - /// - /// Class is not thread-safe, external locking is required when accessing methods. - /// - public class WaitingGroupState : AbstractGroupState - { - /// - /// Tells the state to switch to after buffering is done. - /// - public bool ResumePlaying { get; set; } = false; - - /// - /// Whether the initial state has been set. - /// - private bool InitialStateSet { get; set; } = false; - - /// - /// The group state before the first ever event. - /// - private GroupState InitialState { get; set; } - - /// - /// Default constructor. - /// - public WaitingGroupState(ILogger logger) - : base(logger) - { - // Do nothing. - } - - /// - public override GroupState GetGroupState() - { - return GroupState.Waiting; - } - - /// - public override void SessionJoined(ISyncPlayStateContext context, GroupState prevState, SessionInfo session, CancellationToken cancellationToken) - { - // Save state if first event. - if (!InitialStateSet) - { - InitialState = prevState; - InitialStateSet = true; - } - - if (prevState.Equals(GroupState.Playing)) { - ResumePlaying = true; - // Pause group and compute the media playback position. - var currentTime = DateTime.UtcNow; - var elapsedTime = currentTime - context.LastActivity; - context.LastActivity = currentTime; - // Elapsed time is negative if event happens - // during the delay added to account for latency. - // In this phase clients haven't started the playback yet. - // In other words, LastActivity is in the future, - // when playback unpause is supposed to happen. - // Seek only if playback actually started. - context.PositionTicks += Math.Max(elapsedTime.Ticks, 0); - } - - // Prepare new session. - var playQueueUpdate = context.GetPlayQueueUpdate(PlayQueueUpdateReason.NewPlaylist); - var update = context.NewSyncPlayGroupUpdate(GroupUpdateType.PlayQueue, playQueueUpdate); - context.SendGroupUpdate(session, SyncPlayBroadcastType.CurrentSession, update, cancellationToken); - - context.SetBuffering(session, true); - - // Send pause command to all non-buffering sessions. - var command = context.NewSyncPlayCommand(SendCommandType.Pause); - context.SendCommand(session, SyncPlayBroadcastType.AllReady, command, cancellationToken); - } - - /// - public override void SessionLeaving(ISyncPlayStateContext context, GroupState prevState, SessionInfo session, CancellationToken cancellationToken) - { - // Save state if first event. - if (!InitialStateSet) - { - InitialState = prevState; - InitialStateSet = true; - } - - context.SetBuffering(session, false); - - if (!context.IsBuffering()) - { - if (ResumePlaying) - { - // Client, that was buffering, left the group. - var playingState = new PlayingGroupState(_logger); - context.SetState(playingState); - var unpauseRequest = new UnpauseGroupRequest(); - playingState.HandleRequest(context, GetGroupState(), unpauseRequest, session, cancellationToken); - - _logger.LogDebug("SessionLeaving: {0} left the group {1}, notifying others to resume.", session.Id.ToString(), context.GroupId.ToString()); - } - else - { - // Group is ready, returning to previous state. - var pausedState = new PausedGroupState(_logger); - context.SetState(pausedState); - - _logger.LogDebug("SessionLeaving: {0} left the group {1}, returning to previous state.", session.Id.ToString(), context.GroupId.ToString()); - } - } - } - - /// - public override void HandleRequest(ISyncPlayStateContext context, GroupState prevState, PlayGroupRequest request, SessionInfo session, CancellationToken cancellationToken) - { - // Save state if first event. - if (!InitialStateSet) - { - InitialState = prevState; - InitialStateSet = true; - } - - ResumePlaying = true; - - var setQueueStatus = context.SetPlayQueue(request.PlayingQueue, request.PlayingItemPosition, request.StartPositionTicks); - if (!setQueueStatus) - { - _logger.LogError("HandleRequest: {0} in group {1}, unable to set playing queue.", request.GetRequestType(), context.GroupId.ToString()); - - // Ignore request and return to previous state. - ISyncPlayState newState; - switch (prevState) - { - case GroupState.Playing: - newState = new PlayingGroupState(_logger); - break; - case GroupState.Paused: - newState = new PausedGroupState(_logger); - break; - default: - newState = new IdleGroupState(_logger); - break; - } - - context.SetState(newState); - return; - } - - var playQueueUpdate = context.GetPlayQueueUpdate(PlayQueueUpdateReason.NewPlaylist); - var update = context.NewSyncPlayGroupUpdate(GroupUpdateType.PlayQueue, playQueueUpdate); - context.SendGroupUpdate(session, SyncPlayBroadcastType.AllGroup, update, cancellationToken); - - // Reset status of sessions and await for all Ready events. - context.SetAllBuffering(true); - - _logger.LogDebug("HandleRequest: {0} in group {1}, {2} set a new play queue.", request.GetRequestType(), context.GroupId.ToString(), session.Id.ToString()); - } - - /// - public override void HandleRequest(ISyncPlayStateContext context, GroupState prevState, SetPlaylistItemGroupRequest request, SessionInfo session, CancellationToken cancellationToken) - { - // Save state if first event. - if (!InitialStateSet) - { - InitialState = prevState; - InitialStateSet = true; - } - - ResumePlaying = true; - - var result = context.SetPlayingItem(request.PlaylistItemId); - if (result) - { - var playQueueUpdate = context.GetPlayQueueUpdate(PlayQueueUpdateReason.SetCurrentItem); - var update = context.NewSyncPlayGroupUpdate(GroupUpdateType.PlayQueue, playQueueUpdate); - context.SendGroupUpdate(session, SyncPlayBroadcastType.AllGroup, update, cancellationToken); - - // Reset status of sessions and await for all Ready events. - context.SetAllBuffering(true); - } - else - { - // Return to old state. - ISyncPlayState newState; - switch (prevState) - { - case GroupState.Playing: - newState = new PlayingGroupState(_logger); - break; - case GroupState.Paused: - newState = new PausedGroupState(_logger); - break; - default: - newState = new IdleGroupState(_logger); - break; - } - - context.SetState(newState); - - _logger.LogDebug("HandleRequest: {0} in group {1}, unable to change current playing item.", request.GetRequestType(), context.GroupId.ToString()); - } - } - - /// - public override void HandleRequest(ISyncPlayStateContext context, GroupState prevState, UnpauseGroupRequest request, SessionInfo session, CancellationToken cancellationToken) - { - // Save state if first event. - if (!InitialStateSet) - { - InitialState = prevState; - InitialStateSet = true; - } - - if (prevState.Equals(GroupState.Idle)) - { - ResumePlaying = true; - context.RestartCurrentItem(); - - var playQueueUpdate = context.GetPlayQueueUpdate(PlayQueueUpdateReason.NewPlaylist); - var update = context.NewSyncPlayGroupUpdate(GroupUpdateType.PlayQueue, playQueueUpdate); - context.SendGroupUpdate(session, SyncPlayBroadcastType.AllGroup, update, cancellationToken); - - // Reset status of sessions and await for all Ready events. - context.SetAllBuffering(true); - - _logger.LogDebug("HandleRequest: {0} in group {1}, waiting for all ready events.", request.GetRequestType(), context.GroupId.ToString()); - } - else - { - if (ResumePlaying) - { - _logger.LogDebug("HandleRequest: {0} in group {1}, ignoring sessions that are not ready and forcing the playback to start.", request.GetRequestType(), context.GroupId.ToString()); - - // An Unpause request is forcing the playback to start, ignoring sessions that are not ready. - context.SetAllBuffering(false); - - // Change state. - var playingState = new PlayingGroupState(_logger); - playingState.IgnoreBuffering = true; - context.SetState(playingState); - playingState.HandleRequest(context, GetGroupState(), request, session, cancellationToken); - } - else - { - // Group would have gone to paused state, now will go to playing state when ready. - ResumePlaying = true; - - // Notify relevant state change event. - SendGroupStateUpdate(context, request, session, cancellationToken); - } - } - } - - /// - public override void HandleRequest(ISyncPlayStateContext context, GroupState prevState, PauseGroupRequest request, SessionInfo session, CancellationToken cancellationToken) - { - // Save state if first event. - if (!InitialStateSet) - { - InitialState = prevState; - InitialStateSet = true; - } - - // Wait for sessions to be ready, then switch to paused state. - ResumePlaying = false; - - // Notify relevant state change event. - SendGroupStateUpdate(context, request, session, cancellationToken); - } - - /// - public override void HandleRequest(ISyncPlayStateContext context, GroupState prevState, StopGroupRequest request, SessionInfo session, CancellationToken cancellationToken) - { - // Save state if first event. - if (!InitialStateSet) - { - InitialState = prevState; - InitialStateSet = true; - } - - // Change state. - var idleState = new IdleGroupState(_logger); - context.SetState(idleState); - idleState.HandleRequest(context, GetGroupState(), request, session, cancellationToken); - } - - /// - public override void HandleRequest(ISyncPlayStateContext context, GroupState prevState, SeekGroupRequest request, SessionInfo session, CancellationToken cancellationToken) - { - // Save state if first event. - if (!InitialStateSet) - { - InitialState = prevState; - InitialStateSet = true; - } - - if (prevState.Equals(GroupState.Playing)) - { - ResumePlaying = true; - } - else if(prevState.Equals(GroupState.Paused)) - { - ResumePlaying = false; - } - - // Sanitize PositionTicks. - var ticks = context.SanitizePositionTicks(request.PositionTicks); - - // Seek. - context.PositionTicks = ticks; - context.LastActivity = DateTime.UtcNow; - - var command = context.NewSyncPlayCommand(SendCommandType.Seek); - context.SendCommand(session, SyncPlayBroadcastType.AllGroup, command, cancellationToken); - - // Reset status of sessions and await for all Ready events. - context.SetAllBuffering(true); - - // Notify relevant state change event. - SendGroupStateUpdate(context, request, session, cancellationToken); - } - - /// - public override void HandleRequest(ISyncPlayStateContext context, GroupState prevState, BufferGroupRequest request, SessionInfo session, CancellationToken cancellationToken) - { - // Save state if first event. - if (!InitialStateSet) - { - InitialState = prevState; - InitialStateSet = true; - } - - // Make sure the client is playing the correct item. - if (!request.PlaylistItemId.Equals(context.PlayQueue.GetPlayingItemPlaylistId())) - { - _logger.LogDebug("HandleRequest: {0} in group {1}, {2} has wrong playlist item.", request.GetRequestType(), context.GroupId.ToString(), session.Id.ToString()); - - var playQueueUpdate = context.GetPlayQueueUpdate(PlayQueueUpdateReason.SetCurrentItem); - var updateSession = context.NewSyncPlayGroupUpdate(GroupUpdateType.PlayQueue, playQueueUpdate); - context.SendGroupUpdate(session, SyncPlayBroadcastType.CurrentSession, updateSession, cancellationToken); - context.SetBuffering(session, true); - - return; - } - - if (prevState.Equals(GroupState.Playing)) - { - // Resume playback when all ready. - ResumePlaying = true; - - context.SetBuffering(session, true); - - // Pause group and compute the media playback position. - var currentTime = DateTime.UtcNow; - var elapsedTime = currentTime - context.LastActivity; - context.LastActivity = currentTime; - // Elapsed time is negative if event happens - // during the delay added to account for latency. - // In this phase clients haven't started the playback yet. - // In other words, LastActivity is in the future, - // when playback unpause is supposed to happen. - // Seek only if playback actually started. - context.PositionTicks += Math.Max(elapsedTime.Ticks, 0); - - // Send pause command to all non-buffering sessions. - var command = context.NewSyncPlayCommand(SendCommandType.Pause); - context.SendCommand(session, SyncPlayBroadcastType.AllReady, command, cancellationToken); - } - else if (prevState.Equals(GroupState.Paused)) - { - // Don't resume playback when all ready. - ResumePlaying = false; - - context.SetBuffering(session, true); - - // Send pause command to buffering session. - var command = context.NewSyncPlayCommand(SendCommandType.Pause); - context.SendCommand(session, SyncPlayBroadcastType.CurrentSession, command, cancellationToken); - } - else if (prevState.Equals(GroupState.Waiting)) - { - // Another session is now buffering. - context.SetBuffering(session, true); - - if (!ResumePlaying) - { - // Force update for this session that should be paused. - var command = context.NewSyncPlayCommand(SendCommandType.Pause); - context.SendCommand(session, SyncPlayBroadcastType.CurrentSession, command, cancellationToken); - } - } - - // Notify relevant state change event. - SendGroupStateUpdate(context, request, session, cancellationToken); - } - - /// - public override void HandleRequest(ISyncPlayStateContext context, GroupState prevState, ReadyGroupRequest request, SessionInfo session, CancellationToken cancellationToken) - { - // Save state if first event. - if (!InitialStateSet) - { - InitialState = prevState; - InitialStateSet = true; - } - - // Make sure the client is playing the correct item. - if (!request.PlaylistItemId.Equals(context.PlayQueue.GetPlayingItemPlaylistId())) - { - _logger.LogDebug("HandleRequest: {0} in group {1}, {2} has wrong playlist item.", request.GetRequestType(), context.GroupId.ToString(), session.Id.ToString()); - - var playQueueUpdate = context.GetPlayQueueUpdate(PlayQueueUpdateReason.SetCurrentItem); - var update = context.NewSyncPlayGroupUpdate(GroupUpdateType.PlayQueue, playQueueUpdate); - context.SendGroupUpdate(session, SyncPlayBroadcastType.CurrentSession, update, cancellationToken); - context.SetBuffering(session, true); - - return; - } - - // Compute elapsed time between the client reported time and now. - // Elapsed time is used to estimate the client position when playback is unpaused. - // Ideally, the request is received and handled without major delays. - // However, to avoid waiting indefinitely when a client is not reporting a correct time, - // the elapsed time is ignored after a certain threshold. - var currentTime = DateTime.UtcNow; - var elapsedTime = currentTime.Subtract(request.When); - var timeSyncThresholdTicks = TimeSpan.FromMilliseconds(context.TimeSyncOffset).Ticks; - if (Math.Abs(elapsedTime.Ticks) > timeSyncThresholdTicks) - { - _logger.LogWarning("HandleRequest: {0} in group {1}, {2} is not time syncing properly. Ignoring elapsed time.", - request.GetRequestType(), context.GroupId.ToString(), session.Id); - - elapsedTime = TimeSpan.Zero; - } - - // Ignore elapsed time if client is paused. - if (!request.IsPlaying) - { - elapsedTime = TimeSpan.Zero; - } - - var requestTicks = context.SanitizePositionTicks(request.PositionTicks); - var clientPosition = TimeSpan.FromTicks(requestTicks) + elapsedTime; - var delayTicks = context.PositionTicks - clientPosition.Ticks; - var maxPlaybackOffsetTicks = TimeSpan.FromMilliseconds(context.MaxPlaybackOffset).Ticks; - - _logger.LogDebug("HandleRequest: {0} in group {1}, {2} at {3} (delay of {4} seconds).", - request.GetRequestType(), context.GroupId.ToString(), session.Id, clientPosition, TimeSpan.FromTicks(delayTicks).TotalSeconds); - - if (ResumePlaying) - { - // Handle case where session reported as ready but in reality - // it has no clue of the real position nor the playback state. - if (!request.IsPlaying && Math.Abs(delayTicks) > maxPlaybackOffsetTicks) - { - // Session not ready at all. - context.SetBuffering(session, true); - - // Correcting session's position. - var command = context.NewSyncPlayCommand(SendCommandType.Seek); - context.SendCommand(session, SyncPlayBroadcastType.CurrentSession, command, cancellationToken); - - // Notify relevant state change event. - SendGroupStateUpdate(context, request, session, cancellationToken); - - _logger.LogWarning("HandleRequest: {0} in group {1}, {2} got lost in time, correcting.", - request.GetRequestType(), context.GroupId.ToString(), session.Id); - return; - } - - // Session is ready. - context.SetBuffering(session, false); - - if (context.IsBuffering()) - { - // Others are still buffering, tell this client to pause when ready. - var command = context.NewSyncPlayCommand(SendCommandType.Pause); - var pauseAtTime = currentTime.AddTicks(delayTicks); - command.When = context.DateToUTCString(pauseAtTime); - context.SendCommand(session, SyncPlayBroadcastType.CurrentSession, command, cancellationToken); - - _logger.LogInformation("HandleRequest: {0} in group {1}, others still buffering, {2} will pause when ready in {3} seconds.", - request.GetRequestType(), context.GroupId.ToString(), session.Id, TimeSpan.FromTicks(delayTicks).TotalSeconds); - } - else - { - // If all ready, then start playback. - // Let other clients resume as soon as the buffering client catches up. - if (delayTicks > context.GetHighestPing() * 2 * TimeSpan.TicksPerMillisecond) - { - // Client that was buffering is recovering, notifying others to resume. - context.LastActivity = currentTime.AddTicks(delayTicks); - var command = context.NewSyncPlayCommand(SendCommandType.Unpause); - var filter = SyncPlayBroadcastType.AllExceptCurrentSession; - if (!request.IsPlaying) - { - filter = SyncPlayBroadcastType.AllGroup; - } - - context.SendCommand(session, filter, command, cancellationToken); - - _logger.LogInformation("HandleRequest: {0} in group {1}, {2} is recovering, notifying others to resume in {3} seconds.", - request.GetRequestType(), context.GroupId.ToString(), session.Id, TimeSpan.FromTicks(delayTicks).TotalSeconds); - } - else - { - // Client, that was buffering, resumed playback but did not update others in time. - delayTicks = context.GetHighestPing() * 2 * TimeSpan.TicksPerMillisecond; - delayTicks = Math.Max(delayTicks, context.DefaultPing); - - context.LastActivity = currentTime.AddTicks(delayTicks); - - var command = context.NewSyncPlayCommand(SendCommandType.Unpause); - context.SendCommand(session, SyncPlayBroadcastType.AllGroup, command, cancellationToken); - - _logger.LogWarning("HandleRequest: {0} in group {1}, {2} resumed playback but did not update others in time. {3} seconds to recover.", - request.GetRequestType(), context.GroupId.ToString(), session.Id, TimeSpan.FromTicks(delayTicks).TotalSeconds); - } - - // Change state. - var playingState = new PlayingGroupState(_logger); - context.SetState(playingState); - playingState.HandleRequest(context, GetGroupState(), request, session, cancellationToken); - } - } - else - { - // Check that session is really ready, tollerate player imperfections under a certain threshold. - if (Math.Abs(context.PositionTicks - requestTicks) > maxPlaybackOffsetTicks) - { - // Session still not ready. - context.SetBuffering(session, true); - // Session is seeking to wrong position, correcting. - var command = context.NewSyncPlayCommand(SendCommandType.Seek); - context.SendCommand(session, SyncPlayBroadcastType.CurrentSession, command, cancellationToken); - - // Notify relevant state change event. - SendGroupStateUpdate(context, request, session, cancellationToken); - - _logger.LogWarning("HandleRequest: {0} in group {1}, {2} was seeking to wrong position, correcting.", - request.GetRequestType(), context.GroupId.ToString(), session.Id); - return; - } else { - // Session is ready. - context.SetBuffering(session, false); - } - - if (!context.IsBuffering()) - { - // Group is ready, returning to previous state. - var pausedState = new PausedGroupState(_logger); - context.SetState(pausedState); - - if (InitialState.Equals(GroupState.Playing)) - { - // Group went from playing to waiting state and a pause request occured while waiting. - var pauserequest = new PauseGroupRequest(); - pausedState.HandleRequest(context, GetGroupState(), pauserequest, session, cancellationToken); - } - else if (InitialState.Equals(GroupState.Paused)) - { - pausedState.HandleRequest(context, GetGroupState(), request, session, cancellationToken); - } - - _logger.LogDebug("HandleRequest: {0} in group {1}, {2} is ready, returning to previous state.", - request.GetRequestType(), context.GroupId.ToString(), session.Id); - } - } - } - - /// - public override void HandleRequest(ISyncPlayStateContext context, GroupState prevState, NextTrackGroupRequest request, SessionInfo session, CancellationToken cancellationToken) - { - // Save state if first event. - if (!InitialStateSet) - { - InitialState = prevState; - InitialStateSet = true; - } - - ResumePlaying = true; - - // Make sure the client knows the playing item, to avoid duplicate requests. - if (!request.PlaylistItemId.Equals(context.PlayQueue.GetPlayingItemPlaylistId())) - { - _logger.LogDebug("HandleRequest: {0} in group {1}, client provided the wrong playlist identifier.", request.GetRequestType(), context.GroupId.ToString()); - return; - } - - var newItem = context.NextItemInQueue(); - if (newItem) - { - // Send playing-queue update. - var playQueueUpdate = context.GetPlayQueueUpdate(PlayQueueUpdateReason.NextTrack); - var update = context.NewSyncPlayGroupUpdate(GroupUpdateType.PlayQueue, playQueueUpdate); - context.SendGroupUpdate(session, SyncPlayBroadcastType.AllGroup, update, cancellationToken); - - // Reset status of sessions and await for all Ready events. - context.SetAllBuffering(true); - } - else - { - // Return to old state. - ISyncPlayState newState; - switch (prevState) - { - case GroupState.Playing: - newState = new PlayingGroupState(_logger); - break; - case GroupState.Paused: - newState = new PausedGroupState(_logger); - break; - default: - newState = new IdleGroupState(_logger); - break; - } - - context.SetState(newState); - - _logger.LogDebug("HandleRequest: {0} in group {1}, no next track available.", request.GetRequestType(), context.GroupId.ToString()); - } - } - - /// - public override void HandleRequest(ISyncPlayStateContext context, GroupState prevState, PreviousTrackGroupRequest request, SessionInfo session, CancellationToken cancellationToken) - { - // Save state if first event. - if (!InitialStateSet) - { - InitialState = prevState; - InitialStateSet = true; - } - - ResumePlaying = true; - - // Make sure the client knows the playing item, to avoid duplicate requests. - if (!request.PlaylistItemId.Equals(context.PlayQueue.GetPlayingItemPlaylistId())) - { - _logger.LogDebug("HandleRequest: {0} in group {1}, client provided the wrong playlist identifier.", request.GetRequestType(), context.GroupId.ToString()); - return; - } - - var newItem = context.PreviousItemInQueue(); - if (newItem) - { - // Send playing-queue update. - var playQueueUpdate = context.GetPlayQueueUpdate(PlayQueueUpdateReason.PreviousTrack); - var update = context.NewSyncPlayGroupUpdate(GroupUpdateType.PlayQueue, playQueueUpdate); - context.SendGroupUpdate(session, SyncPlayBroadcastType.AllGroup, update, cancellationToken); - - // Reset status of sessions and await for all Ready events. - context.SetAllBuffering(true); - } - else - { - // Return to old state. - ISyncPlayState newState; - switch (prevState) - { - case GroupState.Playing: - newState = new PlayingGroupState(_logger); - break; - case GroupState.Paused: - newState = new PausedGroupState(_logger); - break; - default: - newState = new IdleGroupState(_logger); - break; - } - - context.SetState(newState); - - _logger.LogDebug("HandleRequest: {0} in group {1}, no previous track available.", request.GetRequestType(), context.GroupId.ToString()); - } - } - } -} diff --git a/Emby.Server.Implementations/SyncPlay/SyncPlayManager.cs b/Emby.Server.Implementations/SyncPlay/SyncPlayManager.cs index ab9be145f3..178536631e 100644 --- a/Emby.Server.Implementations/SyncPlay/SyncPlayManager.cs +++ b/Emby.Server.Implementations/SyncPlay/SyncPlayManager.cs @@ -39,14 +39,14 @@ namespace Emby.Server.Implementations.SyncPlay /// /// The map between sessions and groups. /// - private readonly Dictionary _sessionToGroupMap = - new Dictionary(StringComparer.OrdinalIgnoreCase); + private readonly Dictionary _sessionToGroupMap = + new Dictionary(StringComparer.OrdinalIgnoreCase); /// /// The groups. /// - private readonly Dictionary _groups = - new Dictionary(); + private readonly Dictionary _groups = + new Dictionary(); /// /// Lock used for accesing any group. @@ -83,7 +83,7 @@ namespace Emby.Server.Implementations.SyncPlay /// Gets all groups. /// /// All groups. - public IEnumerable Groups => _groups.Values; + public IEnumerable Groups => _groups.Values; /// public void Dispose() @@ -229,7 +229,7 @@ namespace Emby.Server.Implementations.SyncPlay LeaveGroup(session, cancellationToken); } - var group = new SyncPlayGroupController(_logger, _userManager, _sessionManager, _libraryManager, this); + var group = new GroupController(_logger, _userManager, _sessionManager, _libraryManager, this); _groups[group.GroupId] = group; group.CreateGroup(session, request, cancellationToken); @@ -249,7 +249,7 @@ namespace Emby.Server.Implementations.SyncPlay lock (_groupsLock) { - _groups.TryGetValue(groupId, out ISyncPlayGroupController group); + _groups.TryGetValue(groupId, out IGroupController group); if (group == null) { @@ -346,7 +346,7 @@ namespace Emby.Server.Implementations.SyncPlay } /// - public void HandleRequest(SessionInfo session, IPlaybackGroupRequest request, CancellationToken cancellationToken) + public void HandleRequest(SessionInfo session, IGroupPlaybackRequest request, CancellationToken cancellationToken) { // TODO: create abstract class for GroupRequests to avoid explicit request type here. if (!IsRequestValid(session, GroupRequestType.Playback, request)) @@ -375,28 +375,23 @@ namespace Emby.Server.Implementations.SyncPlay } /// - public void AddSessionToGroup(SessionInfo session, ISyncPlayGroupController group) + public void AddSessionToGroup(SessionInfo session, IGroupController group) { if (session == null) { throw new InvalidOperationException("Session is null!"); } - if (group == null) - { - throw new InvalidOperationException("Group is null!"); - } - if (IsSessionInGroup(session)) { throw new InvalidOperationException("Session in other group already!"); } - _sessionToGroupMap[session.Id] = group; + _sessionToGroupMap[session.Id] = group ?? throw new InvalidOperationException("Group is null!"); } /// - public void RemoveSessionFromGroup(SessionInfo session, ISyncPlayGroupController group) + public void RemoveSessionFromGroup(SessionInfo session, IGroupController group) { if (session == null) { diff --git a/Jellyfin.Api/Controllers/SyncPlayController.cs b/Jellyfin.Api/Controllers/SyncPlayController.cs index 847c3ab117..6bd78179b5 100644 --- a/Jellyfin.Api/Controllers/SyncPlayController.cs +++ b/Jellyfin.Api/Controllers/SyncPlayController.cs @@ -125,10 +125,10 @@ namespace Jellyfin.Api.Controllers var currentSession = RequestHelpers.GetSession(_sessionManager, _authorizationContext, Request); var syncPlayRequest = new PlayGroupRequest() { - PlayingQueue = RequestHelpers.GetGuids(playingQueue), PlayingItemPosition = playingItemPosition, StartPositionTicks = startPositionTicks }; + syncPlayRequest.PlayingQueue.AddRange(RequestHelpers.GetGuids(playingQueue)); _syncPlayManager.HandleRequest(currentSession, syncPlayRequest, CancellationToken.None); return NoContent(); } @@ -165,10 +165,8 @@ namespace Jellyfin.Api.Controllers [FromQuery, Required] string[] playlistItemIds) { var currentSession = RequestHelpers.GetSession(_sessionManager, _authorizationContext, Request); - var syncPlayRequest = new RemoveFromPlaylistGroupRequest() - { - PlaylistItemIds = playlistItemIds - }; + var syncPlayRequest = new RemoveFromPlaylistGroupRequest(); + syncPlayRequest.PlaylistItemIds.AddRange(playlistItemIds); _syncPlayManager.HandleRequest(currentSession, syncPlayRequest, CancellationToken.None); return NoContent(); } @@ -212,9 +210,9 @@ namespace Jellyfin.Api.Controllers var currentSession = RequestHelpers.GetSession(_sessionManager, _authorizationContext, Request); var syncPlayRequest = new QueueGroupRequest() { - ItemIds = RequestHelpers.GetGuids(itemIds), Mode = mode }; + syncPlayRequest.ItemIds.AddRange(RequestHelpers.GetGuids(itemIds)); _syncPlayManager.HandleRequest(currentSession, syncPlayRequest, CancellationToken.None); return NoContent(); } @@ -304,7 +302,7 @@ namespace Jellyfin.Api.Controllers [FromQuery, Required] bool bufferingDone) { var currentSession = RequestHelpers.GetSession(_sessionManager, _authorizationContext, Request); - IPlaybackGroupRequest syncPlayRequest; + IGroupPlaybackRequest syncPlayRequest; if (!bufferingDone) { syncPlayRequest = new BufferGroupRequest() diff --git a/MediaBrowser.Controller/SyncPlay/GroupStates/AbstractGroupState.cs b/MediaBrowser.Controller/SyncPlay/GroupStates/AbstractGroupState.cs new file mode 100644 index 0000000000..829ef2bbab --- /dev/null +++ b/MediaBrowser.Controller/SyncPlay/GroupStates/AbstractGroupState.cs @@ -0,0 +1,216 @@ +using System; +using System.Threading; +using MediaBrowser.Controller.Session; +using MediaBrowser.Model.SyncPlay; +using Microsoft.Extensions.Logging; + +namespace MediaBrowser.Controller.SyncPlay +{ + /// + /// Class AbstractGroupState. + /// + /// + /// Class is not thread-safe, external locking is required when accessing methods. + /// + public abstract class AbstractGroupState : IGroupState + { + /// + /// Initializes a new instance of the class. + /// + /// Instance of the interface. + protected AbstractGroupState(ILogger logger) + { + Logger = logger; + } + + /// + public abstract GroupStateType Type { get; } + + /// + /// Gets the logger. + /// + protected ILogger Logger { get; } + + /// + public abstract void SessionJoined(IGroupStateContext context, GroupStateType prevState, SessionInfo session, CancellationToken cancellationToken); + + /// + public abstract void SessionLeaving(IGroupStateContext context, GroupStateType prevState, SessionInfo session, CancellationToken cancellationToken); + + /// + public virtual void HandleRequest(IGroupStateContext context, GroupStateType prevState, IGroupPlaybackRequest request, SessionInfo session, CancellationToken cancellationToken) + { + UnhandledRequest(request); + } + + /// + public virtual void HandleRequest(IGroupStateContext context, GroupStateType prevState, PlayGroupRequest request, SessionInfo session, CancellationToken cancellationToken) + { + UnhandledRequest(request); + } + + /// + public virtual void HandleRequest(IGroupStateContext context, GroupStateType prevState, SetPlaylistItemGroupRequest request, SessionInfo session, CancellationToken cancellationToken) + { + var waitingState = new WaitingGroupState(Logger); + context.SetState(waitingState); + waitingState.HandleRequest(context, Type, request, session, cancellationToken); + } + + /// + public virtual void HandleRequest(IGroupStateContext context, GroupStateType prevState, RemoveFromPlaylistGroupRequest request, SessionInfo session, CancellationToken cancellationToken) + { + var playingItemRemoved = context.RemoveFromPlayQueue(request.PlaylistItemIds); + + var playQueueUpdate = context.GetPlayQueueUpdate(PlayQueueUpdateReason.RemoveItems); + var update = context.NewSyncPlayGroupUpdate(GroupUpdateType.PlayQueue, playQueueUpdate); + context.SendGroupUpdate(session, SyncPlayBroadcastType.AllGroup, update, cancellationToken); + + if (playingItemRemoved && !context.PlayQueue.IsItemPlaying()) + { + Logger.LogDebug("HandleRequest: {0} in group {1}, play queue is empty.", request.Type, context.GroupId.ToString()); + + IGroupState idleState = new IdleGroupState(Logger); + context.SetState(idleState); + var stopRequest = new StopGroupRequest(); + idleState.HandleRequest(context, Type, stopRequest, session, cancellationToken); + } + } + + /// + public virtual void HandleRequest(IGroupStateContext context, GroupStateType prevState, MovePlaylistItemGroupRequest request, SessionInfo session, CancellationToken cancellationToken) + { + var result = context.MoveItemInPlayQueue(request.PlaylistItemId, request.NewIndex); + + if (!result) + { + Logger.LogError("HandleRequest: {0} in group {1}, unable to move item in play queue.", request.Type, context.GroupId.ToString()); + return; + } + + var playQueueUpdate = context.GetPlayQueueUpdate(PlayQueueUpdateReason.MoveItem); + var update = context.NewSyncPlayGroupUpdate(GroupUpdateType.PlayQueue, playQueueUpdate); + context.SendGroupUpdate(session, SyncPlayBroadcastType.AllGroup, update, cancellationToken); + } + + /// + public virtual void HandleRequest(IGroupStateContext context, GroupStateType prevState, QueueGroupRequest request, SessionInfo session, CancellationToken cancellationToken) + { + var result = context.AddToPlayQueue(request.ItemIds, request.Mode); + + if (!result) + { + Logger.LogError("HandleRequest: {0} in group {1}, unable to add items to play queue.", request.Type, context.GroupId.ToString()); + return; + } + + var reason = request.Mode.Equals("next", StringComparison.OrdinalIgnoreCase) ? PlayQueueUpdateReason.QueueNext : PlayQueueUpdateReason.Queue; + var playQueueUpdate = context.GetPlayQueueUpdate(reason); + var update = context.NewSyncPlayGroupUpdate(GroupUpdateType.PlayQueue, playQueueUpdate); + context.SendGroupUpdate(session, SyncPlayBroadcastType.AllGroup, update, cancellationToken); + } + + /// + public virtual void HandleRequest(IGroupStateContext context, GroupStateType prevState, UnpauseGroupRequest request, SessionInfo session, CancellationToken cancellationToken) + { + UnhandledRequest(request); + } + + /// + public virtual void HandleRequest(IGroupStateContext context, GroupStateType prevState, PauseGroupRequest request, SessionInfo session, CancellationToken cancellationToken) + { + UnhandledRequest(request); + } + + /// + public virtual void HandleRequest(IGroupStateContext context, GroupStateType prevState, StopGroupRequest request, SessionInfo session, CancellationToken cancellationToken) + { + UnhandledRequest(request); + } + + /// + public virtual void HandleRequest(IGroupStateContext context, GroupStateType prevState, SeekGroupRequest request, SessionInfo session, CancellationToken cancellationToken) + { + UnhandledRequest(request); + } + + /// + public virtual void HandleRequest(IGroupStateContext context, GroupStateType prevState, BufferGroupRequest request, SessionInfo session, CancellationToken cancellationToken) + { + UnhandledRequest(request); + } + + /// + public virtual void HandleRequest(IGroupStateContext context, GroupStateType prevState, ReadyGroupRequest request, SessionInfo session, CancellationToken cancellationToken) + { + UnhandledRequest(request); + } + + /// + public virtual void HandleRequest(IGroupStateContext context, GroupStateType prevState, NextTrackGroupRequest request, SessionInfo session, CancellationToken cancellationToken) + { + UnhandledRequest(request); + } + + /// + public virtual void HandleRequest(IGroupStateContext context, GroupStateType prevState, PreviousTrackGroupRequest request, SessionInfo session, CancellationToken cancellationToken) + { + UnhandledRequest(request); + } + + /// + public virtual void HandleRequest(IGroupStateContext context, GroupStateType prevState, SetRepeatModeGroupRequest request, SessionInfo session, CancellationToken cancellationToken) + { + context.SetRepeatMode(request.Mode); + var playQueueUpdate = context.GetPlayQueueUpdate(PlayQueueUpdateReason.RepeatMode); + var update = context.NewSyncPlayGroupUpdate(GroupUpdateType.PlayQueue, playQueueUpdate); + context.SendGroupUpdate(session, SyncPlayBroadcastType.AllGroup, update, cancellationToken); + } + + /// + public virtual void HandleRequest(IGroupStateContext context, GroupStateType prevState, SetShuffleModeGroupRequest request, SessionInfo session, CancellationToken cancellationToken) + { + context.SetShuffleMode(request.Mode); + var playQueueUpdate = context.GetPlayQueueUpdate(PlayQueueUpdateReason.ShuffleMode); + var update = context.NewSyncPlayGroupUpdate(GroupUpdateType.PlayQueue, playQueueUpdate); + context.SendGroupUpdate(session, SyncPlayBroadcastType.AllGroup, update, cancellationToken); + } + + /// + public virtual void HandleRequest(IGroupStateContext context, GroupStateType prevState, PingGroupRequest request, SessionInfo session, CancellationToken cancellationToken) + { + // Collected pings are used to account for network latency when unpausing playback. + context.UpdatePing(session, request.Ping); + } + + /// + public virtual void HandleRequest(IGroupStateContext context, GroupStateType prevState, IgnoreWaitGroupRequest request, SessionInfo session, CancellationToken cancellationToken) + { + context.SetIgnoreGroupWait(session, request.IgnoreWait); + } + + /// + /// Sends a group state update to all group. + /// + /// The context of the state. + /// The reason of the state change. + /// The session. + /// The cancellation token. + protected void SendGroupStateUpdate(IGroupStateContext context, IGroupPlaybackRequest reason, SessionInfo session, CancellationToken cancellationToken) + { + // Notify relevant state change event. + var stateUpdate = new GroupStateUpdate() + { + State = Type, + Reason = reason.Type + }; + var update = context.NewSyncPlayGroupUpdate(GroupUpdateType.StateUpdate, stateUpdate); + context.SendGroupUpdate(session, SyncPlayBroadcastType.AllGroup, update, cancellationToken); + } + + private void UnhandledRequest(IGroupPlaybackRequest request) + { + Logger.LogWarning("HandleRequest: unhandled {0} request for {1} state.", request.Type, Type); + } + } +} diff --git a/MediaBrowser.Controller/SyncPlay/GroupStates/IdleGroupState.cs b/MediaBrowser.Controller/SyncPlay/GroupStates/IdleGroupState.cs new file mode 100644 index 0000000000..1a507e044c --- /dev/null +++ b/MediaBrowser.Controller/SyncPlay/GroupStates/IdleGroupState.cs @@ -0,0 +1,126 @@ +using System.Threading; +using MediaBrowser.Controller.Session; +using MediaBrowser.Model.SyncPlay; +using Microsoft.Extensions.Logging; + +namespace MediaBrowser.Controller.SyncPlay +{ + /// + /// Class IdleGroupState. + /// + /// + /// Class is not thread-safe, external locking is required when accessing methods. + /// + public class IdleGroupState : AbstractGroupState + { + /// + /// Initializes a new instance of the class. + /// + /// Instance of the interface. + public IdleGroupState(ILogger logger) + : base(logger) + { + // Do nothing. + } + + /// + public override GroupStateType Type + { + get + { + return GroupStateType.Idle; + } + } + + /// + public override void SessionJoined(IGroupStateContext context, GroupStateType prevState, SessionInfo session, CancellationToken cancellationToken) + { + SendStopCommand(context, Type, session, cancellationToken); + } + + /// + public override void SessionLeaving(IGroupStateContext context, GroupStateType prevState, SessionInfo session, CancellationToken cancellationToken) + { + // Do nothing. + } + + /// + public override void HandleRequest(IGroupStateContext context, GroupStateType prevState, PlayGroupRequest request, SessionInfo session, CancellationToken cancellationToken) + { + // Change state. + var waitingState = new WaitingGroupState(Logger); + context.SetState(waitingState); + waitingState.HandleRequest(context, Type, request, session, cancellationToken); + } + + /// + public override void HandleRequest(IGroupStateContext context, GroupStateType prevState, UnpauseGroupRequest request, SessionInfo session, CancellationToken cancellationToken) + { + // Change state. + var waitingState = new WaitingGroupState(Logger); + context.SetState(waitingState); + waitingState.HandleRequest(context, Type, request, session, cancellationToken); + } + + /// + public override void HandleRequest(IGroupStateContext context, GroupStateType prevState, PauseGroupRequest request, SessionInfo session, CancellationToken cancellationToken) + { + SendStopCommand(context, prevState, session, cancellationToken); + } + + /// + public override void HandleRequest(IGroupStateContext context, GroupStateType prevState, StopGroupRequest request, SessionInfo session, CancellationToken cancellationToken) + { + SendStopCommand(context, prevState, session, cancellationToken); + } + + /// + public override void HandleRequest(IGroupStateContext context, GroupStateType prevState, SeekGroupRequest request, SessionInfo session, CancellationToken cancellationToken) + { + SendStopCommand(context, prevState, session, cancellationToken); + } + + /// + public override void HandleRequest(IGroupStateContext context, GroupStateType prevState, BufferGroupRequest request, SessionInfo session, CancellationToken cancellationToken) + { + SendStopCommand(context, prevState, session, cancellationToken); + } + + /// + public override void HandleRequest(IGroupStateContext context, GroupStateType prevState, ReadyGroupRequest request, SessionInfo session, CancellationToken cancellationToken) + { + SendStopCommand(context, prevState, session, cancellationToken); + } + + /// + public override void HandleRequest(IGroupStateContext context, GroupStateType prevState, NextTrackGroupRequest request, SessionInfo session, CancellationToken cancellationToken) + { + // Change state. + var waitingState = new WaitingGroupState(Logger); + context.SetState(waitingState); + waitingState.HandleRequest(context, Type, request, session, cancellationToken); + } + + /// + public override void HandleRequest(IGroupStateContext context, GroupStateType prevState, PreviousTrackGroupRequest request, SessionInfo session, CancellationToken cancellationToken) + { + // Change state. + var waitingState = new WaitingGroupState(Logger); + context.SetState(waitingState); + waitingState.HandleRequest(context, Type, request, session, cancellationToken); + } + + private void SendStopCommand(IGroupStateContext context, GroupStateType prevState, SessionInfo session, CancellationToken cancellationToken) + { + var command = context.NewSyncPlayCommand(SendCommandType.Stop); + if (!prevState.Equals(Type)) + { + context.SendCommand(session, SyncPlayBroadcastType.AllGroup, command, cancellationToken); + } + else + { + context.SendCommand(session, SyncPlayBroadcastType.CurrentSession, command, cancellationToken); + } + } + } +} diff --git a/MediaBrowser.Controller/SyncPlay/GroupStates/PausedGroupState.cs b/MediaBrowser.Controller/SyncPlay/GroupStates/PausedGroupState.cs new file mode 100644 index 0000000000..11f526d31d --- /dev/null +++ b/MediaBrowser.Controller/SyncPlay/GroupStates/PausedGroupState.cs @@ -0,0 +1,165 @@ +using System; +using System.Threading; +using MediaBrowser.Controller.Session; +using MediaBrowser.Model.SyncPlay; +using Microsoft.Extensions.Logging; + +namespace MediaBrowser.Controller.SyncPlay +{ + /// + /// Class PausedGroupState. + /// + /// + /// Class is not thread-safe, external locking is required when accessing methods. + /// + public class PausedGroupState : AbstractGroupState + { + /// + /// Initializes a new instance of the class. + /// + /// Instance of the interface. + public PausedGroupState(ILogger logger) + : base(logger) + { + // Do nothing. + } + + /// + public override GroupStateType Type + { + get + { + return GroupStateType.Paused; + } + } + + /// + public override void SessionJoined(IGroupStateContext context, GroupStateType prevState, SessionInfo session, CancellationToken cancellationToken) + { + // Wait for session to be ready. + var waitingState = new WaitingGroupState(Logger); + context.SetState(waitingState); + waitingState.SessionJoined(context, Type, session, cancellationToken); + } + + /// + public override void SessionLeaving(IGroupStateContext context, GroupStateType prevState, SessionInfo session, CancellationToken cancellationToken) + { + // Do nothing. + } + + /// + public override void HandleRequest(IGroupStateContext context, GroupStateType prevState, PlayGroupRequest request, SessionInfo session, CancellationToken cancellationToken) + { + // Change state. + var waitingState = new WaitingGroupState(Logger); + context.SetState(waitingState); + waitingState.HandleRequest(context, Type, request, session, cancellationToken); + } + + /// + public override void HandleRequest(IGroupStateContext context, GroupStateType prevState, UnpauseGroupRequest request, SessionInfo session, CancellationToken cancellationToken) + { + // Change state. + var playingState = new PlayingGroupState(Logger); + context.SetState(playingState); + playingState.HandleRequest(context, Type, request, session, cancellationToken); + } + + /// + public override void HandleRequest(IGroupStateContext context, GroupStateType prevState, PauseGroupRequest request, SessionInfo session, CancellationToken cancellationToken) + { + if (!prevState.Equals(Type)) + { + // Pause group and compute the media playback position. + var currentTime = DateTime.UtcNow; + var elapsedTime = currentTime - context.LastActivity; + context.LastActivity = currentTime; + // Elapsed time is negative if event happens + // during the delay added to account for latency. + // In this phase clients haven't started the playback yet. + // In other words, LastActivity is in the future, + // when playback unpause is supposed to happen. + // Seek only if playback actually started. + context.PositionTicks += Math.Max(elapsedTime.Ticks, 0); + + var command = context.NewSyncPlayCommand(SendCommandType.Pause); + context.SendCommand(session, SyncPlayBroadcastType.AllGroup, command, cancellationToken); + + // Notify relevant state change event. + SendGroupStateUpdate(context, request, session, cancellationToken); + } + else + { + // Client got lost, sending current state. + var command = context.NewSyncPlayCommand(SendCommandType.Pause); + context.SendCommand(session, SyncPlayBroadcastType.CurrentSession, command, cancellationToken); + } + } + + /// + public override void HandleRequest(IGroupStateContext context, GroupStateType prevState, StopGroupRequest request, SessionInfo session, CancellationToken cancellationToken) + { + // Change state. + var idleState = new IdleGroupState(Logger); + context.SetState(idleState); + idleState.HandleRequest(context, Type, request, session, cancellationToken); + } + + /// + public override void HandleRequest(IGroupStateContext context, GroupStateType prevState, SeekGroupRequest request, SessionInfo session, CancellationToken cancellationToken) + { + // Change state. + var waitingState = new WaitingGroupState(Logger); + context.SetState(waitingState); + waitingState.HandleRequest(context, Type, request, session, cancellationToken); + } + + /// + public override void HandleRequest(IGroupStateContext context, GroupStateType prevState, BufferGroupRequest request, SessionInfo session, CancellationToken cancellationToken) + { + // Change state. + var waitingState = new WaitingGroupState(Logger); + context.SetState(waitingState); + waitingState.HandleRequest(context, Type, request, session, cancellationToken); + } + + /// + public override void HandleRequest(IGroupStateContext context, GroupStateType prevState, ReadyGroupRequest request, SessionInfo session, CancellationToken cancellationToken) + { + if (prevState.Equals(Type)) + { + // Client got lost, sending current state. + var command = context.NewSyncPlayCommand(SendCommandType.Pause); + context.SendCommand(session, SyncPlayBroadcastType.CurrentSession, command, cancellationToken); + } + else if (prevState.Equals(GroupStateType.Waiting)) + { + // Sending current state to all clients. + var command = context.NewSyncPlayCommand(SendCommandType.Pause); + context.SendCommand(session, SyncPlayBroadcastType.AllGroup, command, cancellationToken); + + // Notify relevant state change event. + SendGroupStateUpdate(context, request, session, cancellationToken); + } + } + + /// + public override void HandleRequest(IGroupStateContext context, GroupStateType prevState, NextTrackGroupRequest request, SessionInfo session, CancellationToken cancellationToken) + { + // Change state. + var waitingState = new WaitingGroupState(Logger); + context.SetState(waitingState); + waitingState.HandleRequest(context, Type, request, session, cancellationToken); + } + + /// + public override void HandleRequest(IGroupStateContext context, GroupStateType prevState, PreviousTrackGroupRequest request, SessionInfo session, CancellationToken cancellationToken) + { + // Change state. + var waitingState = new WaitingGroupState(Logger); + context.SetState(waitingState); + waitingState.HandleRequest(context, Type, request, session, cancellationToken); + } + } +} diff --git a/MediaBrowser.Controller/SyncPlay/GroupStates/PlayingGroupState.cs b/MediaBrowser.Controller/SyncPlay/GroupStates/PlayingGroupState.cs new file mode 100644 index 0000000000..2aa7598118 --- /dev/null +++ b/MediaBrowser.Controller/SyncPlay/GroupStates/PlayingGroupState.cs @@ -0,0 +1,168 @@ +using System; +using System.Threading; +using MediaBrowser.Controller.Session; +using MediaBrowser.Model.SyncPlay; +using Microsoft.Extensions.Logging; + +namespace MediaBrowser.Controller.SyncPlay +{ + /// + /// Class PlayingGroupState. + /// + /// + /// Class is not thread-safe, external locking is required when accessing methods. + /// + public class PlayingGroupState : AbstractGroupState + { + /// + /// Initializes a new instance of the class. + /// + /// Instance of the interface. + public PlayingGroupState(ILogger logger) + : base(logger) + { + // Do nothing. + } + + /// + public override GroupStateType Type + { + get + { + return GroupStateType.Playing; + } + } + + /// + /// Gets or sets a value indicating whether requests for buffering should be ignored. + /// + public bool IgnoreBuffering { get; set; } + + /// + public override void SessionJoined(IGroupStateContext context, GroupStateType prevState, SessionInfo session, CancellationToken cancellationToken) + { + // Wait for session to be ready. + var waitingState = new WaitingGroupState(Logger); + context.SetState(waitingState); + waitingState.SessionJoined(context, Type, session, cancellationToken); + } + + /// + public override void SessionLeaving(IGroupStateContext context, GroupStateType prevState, SessionInfo session, CancellationToken cancellationToken) + { + // Do nothing. + } + + /// + public override void HandleRequest(IGroupStateContext context, GroupStateType prevState, PlayGroupRequest request, SessionInfo session, CancellationToken cancellationToken) + { + // Change state. + var waitingState = new WaitingGroupState(Logger); + context.SetState(waitingState); + waitingState.HandleRequest(context, Type, request, session, cancellationToken); + } + + /// + public override void HandleRequest(IGroupStateContext context, GroupStateType prevState, UnpauseGroupRequest request, SessionInfo session, CancellationToken cancellationToken) + { + if (!prevState.Equals(Type)) + { + // Pick a suitable time that accounts for latency. + var delayMillis = Math.Max(context.GetHighestPing() * 2, context.DefaultPing); + + // Unpause group and set starting point in future. + // Clients will start playback at LastActivity (datetime) from PositionTicks (playback position). + // The added delay does not guarantee, of course, that the command will be received in time. + // Playback synchronization will mainly happen client side. + context.LastActivity = DateTime.UtcNow.AddMilliseconds(delayMillis); + + var command = context.NewSyncPlayCommand(SendCommandType.Unpause); + context.SendCommand(session, SyncPlayBroadcastType.AllGroup, command, cancellationToken); + + // Notify relevant state change event. + SendGroupStateUpdate(context, request, session, cancellationToken); + } + else + { + // Client got lost, sending current state. + var command = context.NewSyncPlayCommand(SendCommandType.Unpause); + context.SendCommand(session, SyncPlayBroadcastType.CurrentSession, command, cancellationToken); + } + } + + /// + public override void HandleRequest(IGroupStateContext context, GroupStateType prevState, PauseGroupRequest request, SessionInfo session, CancellationToken cancellationToken) + { + // Change state. + var pausedState = new PausedGroupState(Logger); + context.SetState(pausedState); + pausedState.HandleRequest(context, Type, request, session, cancellationToken); + } + + /// + public override void HandleRequest(IGroupStateContext context, GroupStateType prevState, StopGroupRequest request, SessionInfo session, CancellationToken cancellationToken) + { + // Change state. + var idleState = new IdleGroupState(Logger); + context.SetState(idleState); + idleState.HandleRequest(context, Type, request, session, cancellationToken); + } + + /// + public override void HandleRequest(IGroupStateContext context, GroupStateType prevState, SeekGroupRequest request, SessionInfo session, CancellationToken cancellationToken) + { + // Change state. + var waitingState = new WaitingGroupState(Logger); + context.SetState(waitingState); + waitingState.HandleRequest(context, Type, request, session, cancellationToken); + } + + /// + public override void HandleRequest(IGroupStateContext context, GroupStateType prevState, BufferGroupRequest request, SessionInfo session, CancellationToken cancellationToken) + { + if (IgnoreBuffering) + { + return; + } + + // Change state. + var waitingState = new WaitingGroupState(Logger); + context.SetState(waitingState); + waitingState.HandleRequest(context, Type, request, session, cancellationToken); + } + + /// + public override void HandleRequest(IGroupStateContext context, GroupStateType prevState, ReadyGroupRequest request, SessionInfo session, CancellationToken cancellationToken) + { + if (prevState.Equals(Type)) + { + // Group was not waiting, make sure client has latest state. + var command = context.NewSyncPlayCommand(SendCommandType.Unpause); + context.SendCommand(session, SyncPlayBroadcastType.CurrentSession, command, cancellationToken); + } + else if (prevState.Equals(GroupStateType.Waiting)) + { + // Notify relevant state change event. + SendGroupStateUpdate(context, request, session, cancellationToken); + } + } + + /// + public override void HandleRequest(IGroupStateContext context, GroupStateType prevState, NextTrackGroupRequest request, SessionInfo session, CancellationToken cancellationToken) + { + // Change state. + var waitingState = new WaitingGroupState(Logger); + context.SetState(waitingState); + waitingState.HandleRequest(context, Type, request, session, cancellationToken); + } + + /// + public override void HandleRequest(IGroupStateContext context, GroupStateType prevState, PreviousTrackGroupRequest request, SessionInfo session, CancellationToken cancellationToken) + { + // Change state. + var waitingState = new WaitingGroupState(Logger); + context.SetState(waitingState); + waitingState.HandleRequest(context, Type, request, session, cancellationToken); + } + } +} diff --git a/MediaBrowser.Controller/SyncPlay/GroupStates/WaitingGroupState.cs b/MediaBrowser.Controller/SyncPlay/GroupStates/WaitingGroupState.cs new file mode 100644 index 0000000000..7f454570a9 --- /dev/null +++ b/MediaBrowser.Controller/SyncPlay/GroupStates/WaitingGroupState.cs @@ -0,0 +1,655 @@ +using System; +using System.Threading; +using MediaBrowser.Controller.Session; +using MediaBrowser.Model.SyncPlay; +using Microsoft.Extensions.Logging; + +namespace MediaBrowser.Controller.SyncPlay +{ + /// + /// Class WaitingGroupState. + /// + /// + /// Class is not thread-safe, external locking is required when accessing methods. + /// + public class WaitingGroupState : AbstractGroupState + { + /// + /// Initializes a new instance of the class. + /// + /// Instance of the interface. + public WaitingGroupState(ILogger logger) + : base(logger) + { + // Do nothing. + } + + /// + public override GroupStateType Type + { + get + { + return GroupStateType.Waiting; + } + } + + /// + /// Gets or sets a value indicating whether playback should resume when group is ready. + /// + public bool ResumePlaying { get; set; } = false; + + /// + /// Gets or sets a value indicating whether the initial state has been set. + /// + private bool InitialStateSet { get; set; } = false; + + /// + /// Gets or sets the group state before the first ever event. + /// + private GroupStateType InitialState { get; set; } + + /// + public override void SessionJoined(IGroupStateContext context, GroupStateType prevState, SessionInfo session, CancellationToken cancellationToken) + { + // Save state if first event. + if (!InitialStateSet) + { + InitialState = prevState; + InitialStateSet = true; + } + + if (prevState.Equals(GroupStateType.Playing)) + { + ResumePlaying = true; + // Pause group and compute the media playback position. + var currentTime = DateTime.UtcNow; + var elapsedTime = currentTime - context.LastActivity; + context.LastActivity = currentTime; + // Elapsed time is negative if event happens + // during the delay added to account for latency. + // In this phase clients haven't started the playback yet. + // In other words, LastActivity is in the future, + // when playback unpause is supposed to happen. + // Seek only if playback actually started. + context.PositionTicks += Math.Max(elapsedTime.Ticks, 0); + } + + // Prepare new session. + var playQueueUpdate = context.GetPlayQueueUpdate(PlayQueueUpdateReason.NewPlaylist); + var update = context.NewSyncPlayGroupUpdate(GroupUpdateType.PlayQueue, playQueueUpdate); + context.SendGroupUpdate(session, SyncPlayBroadcastType.CurrentSession, update, cancellationToken); + + context.SetBuffering(session, true); + + // Send pause command to all non-buffering sessions. + var command = context.NewSyncPlayCommand(SendCommandType.Pause); + context.SendCommand(session, SyncPlayBroadcastType.AllReady, command, cancellationToken); + } + + /// + public override void SessionLeaving(IGroupStateContext context, GroupStateType prevState, SessionInfo session, CancellationToken cancellationToken) + { + // Save state if first event. + if (!InitialStateSet) + { + InitialState = prevState; + InitialStateSet = true; + } + + context.SetBuffering(session, false); + + if (!context.IsBuffering()) + { + if (ResumePlaying) + { + // Client, that was buffering, left the group. + var playingState = new PlayingGroupState(Logger); + context.SetState(playingState); + var unpauseRequest = new UnpauseGroupRequest(); + playingState.HandleRequest(context, Type, unpauseRequest, session, cancellationToken); + + Logger.LogDebug("SessionLeaving: {0} left the group {1}, notifying others to resume.", session.Id, context.GroupId.ToString()); + } + else + { + // Group is ready, returning to previous state. + var pausedState = new PausedGroupState(Logger); + context.SetState(pausedState); + + Logger.LogDebug("SessionLeaving: {0} left the group {1}, returning to previous state.", session.Id, context.GroupId.ToString()); + } + } + } + + /// + public override void HandleRequest(IGroupStateContext context, GroupStateType prevState, PlayGroupRequest request, SessionInfo session, CancellationToken cancellationToken) + { + // Save state if first event. + if (!InitialStateSet) + { + InitialState = prevState; + InitialStateSet = true; + } + + ResumePlaying = true; + + var setQueueStatus = context.SetPlayQueue(request.PlayingQueue, request.PlayingItemPosition, request.StartPositionTicks); + if (!setQueueStatus) + { + Logger.LogError("HandleRequest: {0} in group {1}, unable to set playing queue.", request.Type, context.GroupId.ToString()); + + // Ignore request and return to previous state. + IGroupState newState = prevState switch { + GroupStateType.Playing => new PlayingGroupState(Logger), + GroupStateType.Paused => new PausedGroupState(Logger), + _ => new IdleGroupState(Logger) + }; + + context.SetState(newState); + return; + } + + var playQueueUpdate = context.GetPlayQueueUpdate(PlayQueueUpdateReason.NewPlaylist); + var update = context.NewSyncPlayGroupUpdate(GroupUpdateType.PlayQueue, playQueueUpdate); + context.SendGroupUpdate(session, SyncPlayBroadcastType.AllGroup, update, cancellationToken); + + // Reset status of sessions and await for all Ready events. + context.SetAllBuffering(true); + + Logger.LogDebug("HandleRequest: {0} in group {1}, {2} set a new play queue.", request.Type, context.GroupId.ToString(), session.Id); + } + + /// + public override void HandleRequest(IGroupStateContext context, GroupStateType prevState, SetPlaylistItemGroupRequest request, SessionInfo session, CancellationToken cancellationToken) + { + // Save state if first event. + if (!InitialStateSet) + { + InitialState = prevState; + InitialStateSet = true; + } + + ResumePlaying = true; + + var result = context.SetPlayingItem(request.PlaylistItemId); + if (result) + { + var playQueueUpdate = context.GetPlayQueueUpdate(PlayQueueUpdateReason.SetCurrentItem); + var update = context.NewSyncPlayGroupUpdate(GroupUpdateType.PlayQueue, playQueueUpdate); + context.SendGroupUpdate(session, SyncPlayBroadcastType.AllGroup, update, cancellationToken); + + // Reset status of sessions and await for all Ready events. + context.SetAllBuffering(true); + } + else + { + // Return to old state. + IGroupState newState = prevState switch + { + GroupStateType.Playing => new PlayingGroupState(Logger), + GroupStateType.Paused => new PausedGroupState(Logger), + _ => new IdleGroupState(Logger) + }; + + context.SetState(newState); + + Logger.LogDebug("HandleRequest: {0} in group {1}, unable to change current playing item.", request.Type, context.GroupId.ToString()); + } + } + + /// + public override void HandleRequest(IGroupStateContext context, GroupStateType prevState, UnpauseGroupRequest request, SessionInfo session, CancellationToken cancellationToken) + { + // Save state if first event. + if (!InitialStateSet) + { + InitialState = prevState; + InitialStateSet = true; + } + + if (prevState.Equals(GroupStateType.Idle)) + { + ResumePlaying = true; + context.RestartCurrentItem(); + + var playQueueUpdate = context.GetPlayQueueUpdate(PlayQueueUpdateReason.NewPlaylist); + var update = context.NewSyncPlayGroupUpdate(GroupUpdateType.PlayQueue, playQueueUpdate); + context.SendGroupUpdate(session, SyncPlayBroadcastType.AllGroup, update, cancellationToken); + + // Reset status of sessions and await for all Ready events. + context.SetAllBuffering(true); + + Logger.LogDebug("HandleRequest: {0} in group {1}, waiting for all ready events.", request.Type, context.GroupId.ToString()); + } + else + { + if (ResumePlaying) + { + Logger.LogDebug("HandleRequest: {0} in group {1}, ignoring sessions that are not ready and forcing the playback to start.", request.Type, context.GroupId.ToString()); + + // An Unpause request is forcing the playback to start, ignoring sessions that are not ready. + context.SetAllBuffering(false); + + // Change state. + var playingState = new PlayingGroupState(Logger) + { + IgnoreBuffering = true + }; + context.SetState(playingState); + playingState.HandleRequest(context, Type, request, session, cancellationToken); + } + else + { + // Group would have gone to paused state, now will go to playing state when ready. + ResumePlaying = true; + + // Notify relevant state change event. + SendGroupStateUpdate(context, request, session, cancellationToken); + } + } + } + + /// + public override void HandleRequest(IGroupStateContext context, GroupStateType prevState, PauseGroupRequest request, SessionInfo session, CancellationToken cancellationToken) + { + // Save state if first event. + if (!InitialStateSet) + { + InitialState = prevState; + InitialStateSet = true; + } + + // Wait for sessions to be ready, then switch to paused state. + ResumePlaying = false; + + // Notify relevant state change event. + SendGroupStateUpdate(context, request, session, cancellationToken); + } + + /// + public override void HandleRequest(IGroupStateContext context, GroupStateType prevState, StopGroupRequest request, SessionInfo session, CancellationToken cancellationToken) + { + // Save state if first event. + if (!InitialStateSet) + { + InitialState = prevState; + InitialStateSet = true; + } + + // Change state. + var idleState = new IdleGroupState(Logger); + context.SetState(idleState); + idleState.HandleRequest(context, Type, request, session, cancellationToken); + } + + /// + public override void HandleRequest(IGroupStateContext context, GroupStateType prevState, SeekGroupRequest request, SessionInfo session, CancellationToken cancellationToken) + { + // Save state if first event. + if (!InitialStateSet) + { + InitialState = prevState; + InitialStateSet = true; + } + + if (prevState.Equals(GroupStateType.Playing)) + { + ResumePlaying = true; + } + else if (prevState.Equals(GroupStateType.Paused)) + { + ResumePlaying = false; + } + + // Sanitize PositionTicks. + var ticks = context.SanitizePositionTicks(request.PositionTicks); + + // Seek. + context.PositionTicks = ticks; + context.LastActivity = DateTime.UtcNow; + + var command = context.NewSyncPlayCommand(SendCommandType.Seek); + context.SendCommand(session, SyncPlayBroadcastType.AllGroup, command, cancellationToken); + + // Reset status of sessions and await for all Ready events. + context.SetAllBuffering(true); + + // Notify relevant state change event. + SendGroupStateUpdate(context, request, session, cancellationToken); + } + + /// + public override void HandleRequest(IGroupStateContext context, GroupStateType prevState, BufferGroupRequest request, SessionInfo session, CancellationToken cancellationToken) + { + // Save state if first event. + if (!InitialStateSet) + { + InitialState = prevState; + InitialStateSet = true; + } + + // Make sure the client is playing the correct item. + if (!request.PlaylistItemId.Equals(context.PlayQueue.GetPlayingItemPlaylistId(), StringComparison.OrdinalIgnoreCase)) + { + Logger.LogDebug("HandleRequest: {0} in group {1}, {2} has wrong playlist item.", request.Type, context.GroupId.ToString(), session.Id); + + var playQueueUpdate = context.GetPlayQueueUpdate(PlayQueueUpdateReason.SetCurrentItem); + var updateSession = context.NewSyncPlayGroupUpdate(GroupUpdateType.PlayQueue, playQueueUpdate); + context.SendGroupUpdate(session, SyncPlayBroadcastType.CurrentSession, updateSession, cancellationToken); + context.SetBuffering(session, true); + + return; + } + + if (prevState.Equals(GroupStateType.Playing)) + { + // Resume playback when all ready. + ResumePlaying = true; + + context.SetBuffering(session, true); + + // Pause group and compute the media playback position. + var currentTime = DateTime.UtcNow; + var elapsedTime = currentTime - context.LastActivity; + context.LastActivity = currentTime; + // Elapsed time is negative if event happens + // during the delay added to account for latency. + // In this phase clients haven't started the playback yet. + // In other words, LastActivity is in the future, + // when playback unpause is supposed to happen. + // Seek only if playback actually started. + context.PositionTicks += Math.Max(elapsedTime.Ticks, 0); + + // Send pause command to all non-buffering sessions. + var command = context.NewSyncPlayCommand(SendCommandType.Pause); + context.SendCommand(session, SyncPlayBroadcastType.AllReady, command, cancellationToken); + } + else if (prevState.Equals(GroupStateType.Paused)) + { + // Don't resume playback when all ready. + ResumePlaying = false; + + context.SetBuffering(session, true); + + // Send pause command to buffering session. + var command = context.NewSyncPlayCommand(SendCommandType.Pause); + context.SendCommand(session, SyncPlayBroadcastType.CurrentSession, command, cancellationToken); + } + else if (prevState.Equals(GroupStateType.Waiting)) + { + // Another session is now buffering. + context.SetBuffering(session, true); + + if (!ResumePlaying) + { + // Force update for this session that should be paused. + var command = context.NewSyncPlayCommand(SendCommandType.Pause); + context.SendCommand(session, SyncPlayBroadcastType.CurrentSession, command, cancellationToken); + } + } + + // Notify relevant state change event. + SendGroupStateUpdate(context, request, session, cancellationToken); + } + + /// + public override void HandleRequest(IGroupStateContext context, GroupStateType prevState, ReadyGroupRequest request, SessionInfo session, CancellationToken cancellationToken) + { + // Save state if first event. + if (!InitialStateSet) + { + InitialState = prevState; + InitialStateSet = true; + } + + // Make sure the client is playing the correct item. + if (!request.PlaylistItemId.Equals(context.PlayQueue.GetPlayingItemPlaylistId(), StringComparison.OrdinalIgnoreCase)) + { + Logger.LogDebug("HandleRequest: {0} in group {1}, {2} has wrong playlist item.", request.Type, context.GroupId.ToString(), session.Id); + + var playQueueUpdate = context.GetPlayQueueUpdate(PlayQueueUpdateReason.SetCurrentItem); + var update = context.NewSyncPlayGroupUpdate(GroupUpdateType.PlayQueue, playQueueUpdate); + context.SendGroupUpdate(session, SyncPlayBroadcastType.CurrentSession, update, cancellationToken); + context.SetBuffering(session, true); + + return; + } + + // Compute elapsed time between the client reported time and now. + // Elapsed time is used to estimate the client position when playback is unpaused. + // Ideally, the request is received and handled without major delays. + // However, to avoid waiting indefinitely when a client is not reporting a correct time, + // the elapsed time is ignored after a certain threshold. + var currentTime = DateTime.UtcNow; + var elapsedTime = currentTime.Subtract(request.When); + var timeSyncThresholdTicks = TimeSpan.FromMilliseconds(context.TimeSyncOffset).Ticks; + if (Math.Abs(elapsedTime.Ticks) > timeSyncThresholdTicks) + { + Logger.LogWarning("HandleRequest: {0} in group {1}, {2} is not time syncing properly. Ignoring elapsed time.", request.Type, context.GroupId.ToString(), session.Id); + + elapsedTime = TimeSpan.Zero; + } + + // Ignore elapsed time if client is paused. + if (!request.IsPlaying) + { + elapsedTime = TimeSpan.Zero; + } + + var requestTicks = context.SanitizePositionTicks(request.PositionTicks); + var clientPosition = TimeSpan.FromTicks(requestTicks) + elapsedTime; + var delayTicks = context.PositionTicks - clientPosition.Ticks; + var maxPlaybackOffsetTicks = TimeSpan.FromMilliseconds(context.MaxPlaybackOffset).Ticks; + + Logger.LogDebug("HandleRequest: {0} in group {1}, {2} at {3} (delay of {4} seconds).", request.Type, context.GroupId.ToString(), session.Id, clientPosition, TimeSpan.FromTicks(delayTicks).TotalSeconds); + + if (ResumePlaying) + { + // Handle case where session reported as ready but in reality + // it has no clue of the real position nor the playback state. + if (!request.IsPlaying && Math.Abs(delayTicks) > maxPlaybackOffsetTicks) + { + // Session not ready at all. + context.SetBuffering(session, true); + + // Correcting session's position. + var command = context.NewSyncPlayCommand(SendCommandType.Seek); + context.SendCommand(session, SyncPlayBroadcastType.CurrentSession, command, cancellationToken); + + // Notify relevant state change event. + SendGroupStateUpdate(context, request, session, cancellationToken); + + Logger.LogWarning("HandleRequest: {0} in group {1}, {2} got lost in time, correcting.", request.Type, context.GroupId.ToString(), session.Id); + return; + } + + // Session is ready. + context.SetBuffering(session, false); + + if (context.IsBuffering()) + { + // Others are still buffering, tell this client to pause when ready. + var command = context.NewSyncPlayCommand(SendCommandType.Pause); + var pauseAtTime = currentTime.AddTicks(delayTicks); + command.When = context.DateToUTCString(pauseAtTime); + context.SendCommand(session, SyncPlayBroadcastType.CurrentSession, command, cancellationToken); + + Logger.LogInformation("HandleRequest: {0} in group {1}, others still buffering, {2} will pause when ready in {3} seconds.", request.Type, context.GroupId.ToString(), session.Id, TimeSpan.FromTicks(delayTicks).TotalSeconds); + } + else + { + // If all ready, then start playback. + // Let other clients resume as soon as the buffering client catches up. + if (delayTicks > context.GetHighestPing() * 2 * TimeSpan.TicksPerMillisecond) + { + // Client that was buffering is recovering, notifying others to resume. + context.LastActivity = currentTime.AddTicks(delayTicks); + var command = context.NewSyncPlayCommand(SendCommandType.Unpause); + var filter = SyncPlayBroadcastType.AllExceptCurrentSession; + if (!request.IsPlaying) + { + filter = SyncPlayBroadcastType.AllGroup; + } + + context.SendCommand(session, filter, command, cancellationToken); + + Logger.LogInformation("HandleRequest: {0} in group {1}, {2} is recovering, notifying others to resume in {3} seconds.", request.Type, context.GroupId.ToString(), session.Id, TimeSpan.FromTicks(delayTicks).TotalSeconds); + } + else + { + // Client, that was buffering, resumed playback but did not update others in time. + delayTicks = context.GetHighestPing() * 2 * TimeSpan.TicksPerMillisecond; + delayTicks = Math.Max(delayTicks, context.DefaultPing); + + context.LastActivity = currentTime.AddTicks(delayTicks); + + var command = context.NewSyncPlayCommand(SendCommandType.Unpause); + context.SendCommand(session, SyncPlayBroadcastType.AllGroup, command, cancellationToken); + + Logger.LogWarning("HandleRequest: {0} in group {1}, {2} resumed playback but did not update others in time. {3} seconds to recover.", request.Type, context.GroupId.ToString(), session.Id, TimeSpan.FromTicks(delayTicks).TotalSeconds); + } + + // Change state. + var playingState = new PlayingGroupState(Logger); + context.SetState(playingState); + playingState.HandleRequest(context, Type, request, session, cancellationToken); + } + } + else + { + // Check that session is really ready, tollerate player imperfections under a certain threshold. + if (Math.Abs(context.PositionTicks - requestTicks) > maxPlaybackOffsetTicks) + { + // Session still not ready. + context.SetBuffering(session, true); + // Session is seeking to wrong position, correcting. + var command = context.NewSyncPlayCommand(SendCommandType.Seek); + context.SendCommand(session, SyncPlayBroadcastType.CurrentSession, command, cancellationToken); + + // Notify relevant state change event. + SendGroupStateUpdate(context, request, session, cancellationToken); + + Logger.LogWarning("HandleRequest: {0} in group {1}, {2} was seeking to wrong position, correcting.", request.Type, context.GroupId.ToString(), session.Id); + return; + } + else + { + // Session is ready. + context.SetBuffering(session, false); + } + + if (!context.IsBuffering()) + { + // Group is ready, returning to previous state. + var pausedState = new PausedGroupState(Logger); + context.SetState(pausedState); + + if (InitialState.Equals(GroupStateType.Playing)) + { + // Group went from playing to waiting state and a pause request occured while waiting. + var pauserequest = new PauseGroupRequest(); + pausedState.HandleRequest(context, Type, pauserequest, session, cancellationToken); + } + else if (InitialState.Equals(GroupStateType.Paused)) + { + pausedState.HandleRequest(context, Type, request, session, cancellationToken); + } + + Logger.LogDebug("HandleRequest: {0} in group {1}, {2} is ready, returning to previous state.", request.Type, context.GroupId.ToString(), session.Id); + } + } + } + + /// + public override void HandleRequest(IGroupStateContext context, GroupStateType prevState, NextTrackGroupRequest request, SessionInfo session, CancellationToken cancellationToken) + { + // Save state if first event. + if (!InitialStateSet) + { + InitialState = prevState; + InitialStateSet = true; + } + + ResumePlaying = true; + + // Make sure the client knows the playing item, to avoid duplicate requests. + if (!request.PlaylistItemId.Equals(context.PlayQueue.GetPlayingItemPlaylistId(), StringComparison.OrdinalIgnoreCase)) + { + Logger.LogDebug("HandleRequest: {0} in group {1}, client provided the wrong playlist identifier.", request.Type, context.GroupId.ToString()); + return; + } + + var newItem = context.NextItemInQueue(); + if (newItem) + { + // Send playing-queue update. + var playQueueUpdate = context.GetPlayQueueUpdate(PlayQueueUpdateReason.NextTrack); + var update = context.NewSyncPlayGroupUpdate(GroupUpdateType.PlayQueue, playQueueUpdate); + context.SendGroupUpdate(session, SyncPlayBroadcastType.AllGroup, update, cancellationToken); + + // Reset status of sessions and await for all Ready events. + context.SetAllBuffering(true); + } + else + { + // Return to old state. + IGroupState newState = prevState switch + { + GroupStateType.Playing => new PlayingGroupState(Logger), + GroupStateType.Paused => new PausedGroupState(Logger), + _ => new IdleGroupState(Logger) + }; + + context.SetState(newState); + + Logger.LogDebug("HandleRequest: {0} in group {1}, no next track available.", request.Type, context.GroupId.ToString()); + } + } + + /// + public override void HandleRequest(IGroupStateContext context, GroupStateType prevState, PreviousTrackGroupRequest request, SessionInfo session, CancellationToken cancellationToken) + { + // Save state if first event. + if (!InitialStateSet) + { + InitialState = prevState; + InitialStateSet = true; + } + + ResumePlaying = true; + + // Make sure the client knows the playing item, to avoid duplicate requests. + if (!request.PlaylistItemId.Equals(context.PlayQueue.GetPlayingItemPlaylistId(), StringComparison.OrdinalIgnoreCase)) + { + Logger.LogDebug("HandleRequest: {0} in group {1}, client provided the wrong playlist identifier.", request.Type, context.GroupId.ToString()); + return; + } + + var newItem = context.PreviousItemInQueue(); + if (newItem) + { + // Send playing-queue update. + var playQueueUpdate = context.GetPlayQueueUpdate(PlayQueueUpdateReason.PreviousTrack); + var update = context.NewSyncPlayGroupUpdate(GroupUpdateType.PlayQueue, playQueueUpdate); + context.SendGroupUpdate(session, SyncPlayBroadcastType.AllGroup, update, cancellationToken); + + // Reset status of sessions and await for all Ready events. + context.SetAllBuffering(true); + } + else + { + // Return to old state. + IGroupState newState = prevState switch + { + GroupStateType.Playing => new PlayingGroupState(Logger), + GroupStateType.Paused => new PausedGroupState(Logger), + _ => new IdleGroupState(Logger) + }; + + context.SetState(newState); + + Logger.LogDebug("HandleRequest: {0} in group {1}, no previous track available.", request.Type, context.GroupId.ToString()); + } + } + } +} diff --git a/MediaBrowser.Controller/SyncPlay/IGroupController.cs b/MediaBrowser.Controller/SyncPlay/IGroupController.cs new file mode 100644 index 0000000000..038233fdd3 --- /dev/null +++ b/MediaBrowser.Controller/SyncPlay/IGroupController.cs @@ -0,0 +1,84 @@ +using System; +using System.Threading; +using Jellyfin.Data.Entities; +using MediaBrowser.Controller.Session; +using MediaBrowser.Model.SyncPlay; + +namespace MediaBrowser.Controller.SyncPlay +{ + /// + /// Interface IGroupController. + /// + public interface IGroupController + { + /// + /// Gets the group identifier. + /// + /// The group identifier. + Guid GroupId { get; } + + /// + /// Gets the play queue. + /// + /// The play queue. + PlayQueueManager PlayQueue { get; } + + /// + /// Checks if the group is empty. + /// + /// true if the group is empty, false otherwise. + bool IsGroupEmpty(); + + /// + /// Initializes the group with the session's info. + /// + /// The session. + /// The request. + /// The cancellation token. + void CreateGroup(SessionInfo session, NewGroupRequest request, CancellationToken cancellationToken); + + /// + /// Adds the session to the group. + /// + /// The session. + /// The request. + /// The cancellation token. + void SessionJoin(SessionInfo session, JoinGroupRequest request, CancellationToken cancellationToken); + + /// + /// Restores the state of a session that already joined the group. + /// + /// The session. + /// The request. + /// The cancellation token. + void SessionRestore(SessionInfo session, JoinGroupRequest request, CancellationToken cancellationToken); + + /// + /// Removes the session from the group. + /// + /// The session. + /// The cancellation token. + void SessionLeave(SessionInfo session, CancellationToken cancellationToken); + + /// + /// Handles the requested action by the session. + /// + /// The session. + /// The requested action. + /// The cancellation token. + void HandleRequest(SessionInfo session, IGroupPlaybackRequest request, CancellationToken cancellationToken); + + /// + /// Gets the info about the group for the clients. + /// + /// The group info for the clients. + GroupInfoDto GetInfo(); + + /// + /// Checks if a user has access to all content in the play queue. + /// + /// The user. + /// true if the user can access the play queue; false otherwise. + bool HasAccessToPlayQueue(User user); + } +} diff --git a/MediaBrowser.Controller/SyncPlay/IGroupPlaybackRequest.cs b/MediaBrowser.Controller/SyncPlay/IGroupPlaybackRequest.cs new file mode 100644 index 0000000000..3b195e98ca --- /dev/null +++ b/MediaBrowser.Controller/SyncPlay/IGroupPlaybackRequest.cs @@ -0,0 +1,27 @@ +using System.Threading; +using MediaBrowser.Controller.Session; +using MediaBrowser.Model.SyncPlay; + +namespace MediaBrowser.Controller.SyncPlay +{ + /// + /// Interface IGroupPlaybackRequest. + /// + public interface IGroupPlaybackRequest + { + /// + /// Gets the playback request type. + /// + /// The playback request type. + PlaybackRequestType Type { get; } + + /// + /// Applies the request to a group. + /// + /// The context of the state. + /// The current state. + /// The session. + /// The cancellation token. + void Apply(IGroupStateContext context, IGroupState state, SessionInfo session, CancellationToken cancellationToken); + } +} diff --git a/MediaBrowser.Controller/SyncPlay/IGroupState.cs b/MediaBrowser.Controller/SyncPlay/IGroupState.cs new file mode 100644 index 0000000000..981b65221b --- /dev/null +++ b/MediaBrowser.Controller/SyncPlay/IGroupState.cs @@ -0,0 +1,216 @@ +using System.Threading; +using MediaBrowser.Controller.Session; +using MediaBrowser.Model.SyncPlay; + +namespace MediaBrowser.Controller.SyncPlay +{ + /// + /// Interface IGroupState. + /// + public interface IGroupState + { + /// + /// Gets the group state type. + /// + /// The group state type. + GroupStateType Type { get; } + + /// + /// Handles a session that joined the group. + /// + /// The context of the state. + /// The previous state. + /// The session. + /// The cancellation token. + void SessionJoined(IGroupStateContext context, GroupStateType prevState, SessionInfo session, CancellationToken cancellationToken); + + /// + /// Handles a session that is leaving the group. + /// + /// The context of the state. + /// The previous state. + /// The session. + /// The cancellation token. + void SessionLeaving(IGroupStateContext context, GroupStateType prevState, SessionInfo session, CancellationToken cancellationToken); + + /// + /// Generic handle. Context's state can change. + /// + /// The context of the state. + /// The previous state. + /// The generic action. + /// The session. + /// The cancellation token. + void HandleRequest(IGroupStateContext context, GroupStateType prevState, IGroupPlaybackRequest request, SessionInfo session, CancellationToken cancellationToken); + + /// + /// Handles a play action requested by a session. Context's state can change. + /// + /// The context of the state. + /// The previous state. + /// The play action. + /// The session. + /// The cancellation token. + void HandleRequest(IGroupStateContext context, GroupStateType prevState, PlayGroupRequest request, SessionInfo session, CancellationToken cancellationToken); + + /// + /// Handles a playlist-item change requested by a session. Context's state can change. + /// + /// The context of the state. + /// The previous state. + /// The playlist-item change action. + /// The session. + /// The cancellation token. + void HandleRequest(IGroupStateContext context, GroupStateType prevState, SetPlaylistItemGroupRequest request, SessionInfo session, CancellationToken cancellationToken); + + /// + /// Handles a remove-items change requested by a session. Context's state can change. + /// + /// The context of the state. + /// The previous state. + /// The remove-items change action. + /// The session. + /// The cancellation token. + void HandleRequest(IGroupStateContext context, GroupStateType prevState, RemoveFromPlaylistGroupRequest request, SessionInfo session, CancellationToken cancellationToken); + + /// + /// Handles a move-item change requested by a session. Context's state should not change. + /// + /// The context of the state. + /// The previous state. + /// The move-item change action. + /// The session. + /// The cancellation token. + void HandleRequest(IGroupStateContext context, GroupStateType prevState, MovePlaylistItemGroupRequest request, SessionInfo session, CancellationToken cancellationToken); + + /// + /// Handles a queue change requested by a session. Context's state should not change. + /// + /// The context of the state. + /// The previous state. + /// The queue action. + /// The session. + /// The cancellation token. + void HandleRequest(IGroupStateContext context, GroupStateType prevState, QueueGroupRequest request, SessionInfo session, CancellationToken cancellationToken); + + /// + /// Handles an unpause action requested by a session. Context's state can change. + /// + /// The context of the state. + /// The previous state. + /// The unpause action. + /// The session. + /// The cancellation token. + void HandleRequest(IGroupStateContext context, GroupStateType prevState, UnpauseGroupRequest request, SessionInfo session, CancellationToken cancellationToken); + + /// + /// Handles a pause action requested by a session. Context's state can change. + /// + /// The context of the state. + /// The previous state. + /// The pause action. + /// The session. + /// The cancellation token. + void HandleRequest(IGroupStateContext context, GroupStateType prevState, PauseGroupRequest request, SessionInfo session, CancellationToken cancellationToken); + + /// + /// Handles a stop action requested by a session. Context's state can change. + /// + /// The context of the state. + /// The previous state. + /// The stop action. + /// The session. + /// The cancellation token. + void HandleRequest(IGroupStateContext context, GroupStateType prevState, StopGroupRequest request, SessionInfo session, CancellationToken cancellationToken); + + /// + /// Handles a seek action requested by a session. Context's state can change. + /// + /// The context of the state. + /// The previous state. + /// The seek action. + /// The session. + /// The cancellation token. + void HandleRequest(IGroupStateContext context, GroupStateType prevState, SeekGroupRequest request, SessionInfo session, CancellationToken cancellationToken); + + /// + /// Handles a buffering action requested by a session. Context's state can change. + /// + /// The context of the state. + /// The previous state. + /// The buffering action. + /// The session. + /// The cancellation token. + void HandleRequest(IGroupStateContext context, GroupStateType prevState, BufferGroupRequest request, SessionInfo session, CancellationToken cancellationToken); + + /// + /// Handles a buffering-done action requested by a session. Context's state can change. + /// + /// The context of the state. + /// The previous state. + /// The buffering-done action. + /// The session. + /// The cancellation token. + void HandleRequest(IGroupStateContext context, GroupStateType prevState, ReadyGroupRequest request, SessionInfo session, CancellationToken cancellationToken); + + /// + /// Handles a next-track action requested by a session. Context's state can change. + /// + /// The context of the state. + /// The previous state. + /// The next-track action. + /// The session. + /// The cancellation token. + void HandleRequest(IGroupStateContext context, GroupStateType prevState, NextTrackGroupRequest request, SessionInfo session, CancellationToken cancellationToken); + + /// + /// Handles a previous-track action requested by a session. Context's state can change. + /// + /// The context of the state. + /// The previous state. + /// The previous-track action. + /// The session. + /// The cancellation token. + void HandleRequest(IGroupStateContext context, GroupStateType prevState, PreviousTrackGroupRequest request, SessionInfo session, CancellationToken cancellationToken); + + /// + /// Handles a repeat-mode change requested by a session. Context's state should not change. + /// + /// The context of the state. + /// The previous state. + /// The repeat-mode action. + /// The session. + /// The cancellation token. + void HandleRequest(IGroupStateContext context, GroupStateType prevState, SetRepeatModeGroupRequest request, SessionInfo session, CancellationToken cancellationToken); + + /// + /// Handles a shuffle-mode change requested by a session. Context's state should not change. + /// + /// The context of the state. + /// The previous state. + /// The shuffle-mode action. + /// The session. + /// The cancellation token. + void HandleRequest(IGroupStateContext context, GroupStateType prevState, SetShuffleModeGroupRequest request, SessionInfo session, CancellationToken cancellationToken); + + /// + /// Updates ping of a session. Context's state should not change. + /// + /// The context of the state. + /// The previous state. + /// The buffering-done action. + /// The session. + /// The cancellation token. + void HandleRequest(IGroupStateContext context, GroupStateType prevState, PingGroupRequest request, SessionInfo session, CancellationToken cancellationToken); + + /// + /// Updates whether the session should be considered during group wait. Context's state should not change. + /// + /// The context of the state. + /// The previous state. + /// The ignore-wait action. + /// The session. + /// The cancellation token. + void HandleRequest(IGroupStateContext context, GroupStateType prevState, IgnoreWaitGroupRequest request, SessionInfo session, CancellationToken cancellationToken); + } +} diff --git a/MediaBrowser.Controller/SyncPlay/IGroupStateContext.cs b/MediaBrowser.Controller/SyncPlay/IGroupStateContext.cs new file mode 100644 index 0000000000..2ddaae6400 --- /dev/null +++ b/MediaBrowser.Controller/SyncPlay/IGroupStateContext.cs @@ -0,0 +1,228 @@ +using System; +using System.Collections.Generic; +using System.Threading; +using System.Threading.Tasks; +using MediaBrowser.Controller.Session; +using MediaBrowser.Model.SyncPlay; + +namespace MediaBrowser.Controller.SyncPlay +{ + /// + /// Interface IGroupStateContext. + /// + public interface IGroupStateContext + { + /// + /// Gets the default ping value used for sessions, in milliseconds. + /// + /// The default ping value used for sessions, in milliseconds. + long DefaultPing { get; } + + /// + /// Gets the maximum time offset error accepted for dates reported by clients, in milliseconds. + /// + /// The maximum offset error accepted, in milliseconds. + long TimeSyncOffset { get; } + + /// + /// Gets the maximum offset error accepted for position reported by clients, in milliseconds. + /// + /// The maximum offset error accepted, in milliseconds. + long MaxPlaybackOffset { get; } + + /// + /// Gets the group identifier. + /// + /// The group identifier. + Guid GroupId { get; } + + /// + /// Gets or sets the position ticks. + /// + /// The position ticks. + long PositionTicks { get; set; } + + /// + /// Gets or sets the last activity. + /// + /// The last activity. + DateTime LastActivity { get; set; } + + /// + /// Gets the play queue. + /// + /// The play queue. + PlayQueueManager PlayQueue { get; } + + /// + /// Sets a new state. + /// + /// The new state. + void SetState(IGroupState state); + + /// + /// Sends a GroupUpdate message to the interested sessions. + /// + /// The type of the data of the message. + /// The current session. + /// The filtering type. + /// The message to send. + /// The cancellation token. + /// The task. + Task SendGroupUpdate(SessionInfo from, SyncPlayBroadcastType type, GroupUpdate message, CancellationToken cancellationToken); + + /// + /// Sends a playback command to the interested sessions. + /// + /// The current session. + /// The filtering type. + /// The message to send. + /// The cancellation token. + /// The task. + Task SendCommand(SessionInfo from, SyncPlayBroadcastType type, SendCommand message, CancellationToken cancellationToken); + + /// + /// Builds a new playback command with some default values. + /// + /// The command type. + /// The command. + SendCommand NewSyncPlayCommand(SendCommandType type); + + /// + /// Builds a new group update message. + /// + /// The type of the data of the message. + /// The update type. + /// The data to send. + /// The group update. + GroupUpdate NewSyncPlayGroupUpdate(GroupUpdateType type, T data); + + /// + /// Converts DateTime to UTC string. + /// + /// The date to convert. + /// The UTC string. + string DateToUTCString(DateTime dateTime); + + /// + /// Sanitizes the PositionTicks, considers the current playing item when available. + /// + /// The PositionTicks. + /// The sanitized position ticks. + long SanitizePositionTicks(long? positionTicks); + + /// + /// Updates the ping of a session, in milliseconds. + /// + /// The session. + /// The ping, in milliseconds. + void UpdatePing(SessionInfo session, long ping); + + /// + /// Gets the highest ping in the group, in milliseconds. + /// + /// The highest ping in the group. + long GetHighestPing(); + + /// + /// Sets the session's buffering state. + /// + /// The session. + /// The state. + void SetBuffering(SessionInfo session, bool isBuffering); + + /// + /// Sets the buffering state of all the sessions. + /// + /// The state. + void SetAllBuffering(bool isBuffering); + + /// + /// Gets the group buffering state. + /// + /// true if there is a session buffering in the group; false otherwise. + bool IsBuffering(); + + /// + /// Sets the session's group wait state. + /// + /// The session. + /// The state. + void SetIgnoreGroupWait(SessionInfo session, bool ignoreGroupWait); + + /// + /// Sets a new play queue. + /// + /// The new play queue. + /// The playing item position in the play queue. + /// The start position ticks. + /// true if the play queue has been changed; false if something went wrong. + bool SetPlayQueue(IEnumerable playQueue, int playingItemPosition, long startPositionTicks); + + /// + /// Sets the playing item. + /// + /// The new playing item identifier. + /// true if the play queue has been changed; false if something went wrong. + bool SetPlayingItem(string playlistItemId); + + /// + /// Removes items from the play queue. + /// + /// The items to remove. + /// true if playing item got removed; false otherwise. + bool RemoveFromPlayQueue(IEnumerable playlistItemIds); + + /// + /// Moves an item in the play queue. + /// + /// The playlist identifier of the item to move. + /// The new position. + /// true if item has been moved; false if something went wrong. + bool MoveItemInPlayQueue(string playlistItemId, int newIndex); + + /// + /// Updates the play queue. + /// + /// The new items to add to the play queue. + /// The mode with which the items will be added. + /// true if the play queue has been changed; false if something went wrong. + bool AddToPlayQueue(IEnumerable newItems, string mode); + + /// + /// Restarts current item in play queue. + /// + void RestartCurrentItem(); + + /// + /// Picks next item in play queue. + /// + /// true if the item changed; false otherwise. + bool NextItemInQueue(); + + /// + /// Picks previous item in play queue. + /// + /// true if the item changed; false otherwise. + bool PreviousItemInQueue(); + + /// + /// Sets the repeat mode. + /// + /// The new mode. + void SetRepeatMode(string mode); + + /// + /// Sets the shuffle mode. + /// + /// The new mode. + void SetShuffleMode(string mode); + + /// + /// Creates a play queue update. + /// + /// The reason for the update. + /// The play queue update. + PlayQueueUpdate GetPlayQueueUpdate(PlayQueueUpdateReason reason); + } +} diff --git a/MediaBrowser.Controller/SyncPlay/IPlaybackGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/IPlaybackGroupRequest.cs deleted file mode 100644 index 35ca64c8df..0000000000 --- a/MediaBrowser.Controller/SyncPlay/IPlaybackGroupRequest.cs +++ /dev/null @@ -1,23 +0,0 @@ -using System.Threading; -using MediaBrowser.Model.SyncPlay; -using MediaBrowser.Controller.Session; - -namespace MediaBrowser.Controller.SyncPlay -{ - /// - /// Interface IPlaybackGroupRequest. - /// - public interface IPlaybackGroupRequest - { - /// - /// Gets the playback request type. - /// - /// The playback request type. - PlaybackRequestType GetRequestType(); - - /// - /// Applies the request to a group. - /// - void Apply(ISyncPlayStateContext context, ISyncPlayState state, SessionInfo session, CancellationToken cancellationToken); - } -} diff --git a/MediaBrowser.Controller/SyncPlay/ISyncPlayController.cs b/MediaBrowser.Controller/SyncPlay/ISyncPlayController.cs deleted file mode 100644 index 2f497ebbb9..0000000000 --- a/MediaBrowser.Controller/SyncPlay/ISyncPlayController.cs +++ /dev/null @@ -1,85 +0,0 @@ -using System; -using System.Threading; -using Jellyfin.Data.Entities; -using MediaBrowser.Controller.Session; -using MediaBrowser.Model.SyncPlay; - -namespace MediaBrowser.Controller.SyncPlay -{ - /// - /// Interface ISyncPlayGroupController. - /// - public interface ISyncPlayGroupController - { - /// - /// Gets the group identifier. - /// - /// The group identifier. - Guid GroupId { get; } - - /// - /// Gets the play queue. - /// - /// The play queue. - PlayQueueManager PlayQueue { get; } - - /// - /// Checks if the group is empty. - /// - /// true if the group is empty, false otherwise - bool IsGroupEmpty(); - - /// - /// Initializes the group with the session's info. - /// - /// The session. - /// The request. - /// The cancellation token. - void CreateGroup(SessionInfo session, NewGroupRequest request, CancellationToken cancellationToken); - - /// - /// Adds the session to the group. - /// - /// The session. - /// The request. - /// The cancellation token. - void SessionJoin(SessionInfo session, JoinGroupRequest request, CancellationToken cancellationToken); - - /// - /// Restores the state of a session that already joined the group. - /// - /// The session. - /// The request. - /// The cancellation token. - void SessionRestore(SessionInfo session, JoinGroupRequest request, CancellationToken cancellationToken); - - /// - /// Removes the session from the group. - /// - /// The session. - /// The cancellation token. - void SessionLeave(SessionInfo session, CancellationToken cancellationToken); - - /// - /// Handles the requested action by the session. - /// - /// The session. - /// The requested action. - /// The cancellation token. - void HandleRequest(SessionInfo session, IPlaybackGroupRequest request, CancellationToken cancellationToken); - - /// - /// Gets the info about the group for the clients. - /// - /// The group info for the clients. - GroupInfoDto GetInfo(); - - /// - /// Checks if a user has access to all content in the play queue. - /// - /// The user. - /// true if the user can access the play queue; false otherwise. - bool HasAccessToPlayQueue(User user); - - } -} diff --git a/MediaBrowser.Controller/SyncPlay/ISyncPlayManager.cs b/MediaBrowser.Controller/SyncPlay/ISyncPlayManager.cs index ec13686c64..65146d4ae8 100644 --- a/MediaBrowser.Controller/SyncPlay/ISyncPlayManager.cs +++ b/MediaBrowser.Controller/SyncPlay/ISyncPlayManager.cs @@ -48,7 +48,7 @@ namespace MediaBrowser.Controller.SyncPlay /// The session. /// The request. /// The cancellation token. - void HandleRequest(SessionInfo session, IPlaybackGroupRequest request, CancellationToken cancellationToken); + void HandleRequest(SessionInfo session, IGroupPlaybackRequest request, CancellationToken cancellationToken); /// /// Maps a session to a group. @@ -56,7 +56,7 @@ namespace MediaBrowser.Controller.SyncPlay /// The session. /// The group. /// Thrown when the user is in another group already. - void AddSessionToGroup(SessionInfo session, ISyncPlayGroupController group); + void AddSessionToGroup(SessionInfo session, IGroupController group); /// /// Unmaps a session from a group. @@ -64,6 +64,6 @@ namespace MediaBrowser.Controller.SyncPlay /// The session. /// The group. /// Thrown when the user is not found in the specified group. - void RemoveSessionFromGroup(SessionInfo session, ISyncPlayGroupController group); + void RemoveSessionFromGroup(SessionInfo session, IGroupController group); } } diff --git a/MediaBrowser.Controller/SyncPlay/ISyncPlayState.cs b/MediaBrowser.Controller/SyncPlay/ISyncPlayState.cs deleted file mode 100644 index 218e871e36..0000000000 --- a/MediaBrowser.Controller/SyncPlay/ISyncPlayState.cs +++ /dev/null @@ -1,216 +0,0 @@ -using System.Threading; -using MediaBrowser.Model.SyncPlay; -using MediaBrowser.Controller.Session; - -namespace MediaBrowser.Controller.SyncPlay -{ - /// - /// Interface ISyncPlayState. - /// - public interface ISyncPlayState - { - /// - /// Gets the group state. - /// - /// The group state. - GroupState GetGroupState(); - - /// - /// Handles a session that joined the group. - /// - /// The context of the state. - /// The previous state. - /// The session. - /// The cancellation token. - void SessionJoined(ISyncPlayStateContext context, GroupState prevState, SessionInfo session, CancellationToken cancellationToken); - - /// - /// Handles a session that is leaving the group. - /// - /// The context of the state. - /// The previous state. - /// The session. - /// The cancellation token. - void SessionLeaving(ISyncPlayStateContext context, GroupState prevState, SessionInfo session, CancellationToken cancellationToken); - - /// - /// Generic handle. Context's state can change. - /// - /// The context of the state. - /// The previous state. - /// The generic action. - /// The session. - /// The cancellation token. - void HandleRequest(ISyncPlayStateContext context, GroupState prevState, IPlaybackGroupRequest request, SessionInfo session, CancellationToken cancellationToken); - - /// - /// Handles a play action requested by a session. Context's state can change. - /// - /// The context of the state. - /// The previous state. - /// The play action. - /// The session. - /// The cancellation token. - void HandleRequest(ISyncPlayStateContext context, GroupState prevState, PlayGroupRequest request, SessionInfo session, CancellationToken cancellationToken); - - /// - /// Handles a playlist-item change requested by a session. Context's state can change. - /// - /// The context of the state. - /// The previous state. - /// The playlist-item change action. - /// The session. - /// The cancellation token. - void HandleRequest(ISyncPlayStateContext context, GroupState prevState, SetPlaylistItemGroupRequest request, SessionInfo session, CancellationToken cancellationToken); - - /// - /// Handles a remove-items change requested by a session. Context's state can change. - /// - /// The context of the state. - /// The previous state. - /// The remove-items change action. - /// The session. - /// The cancellation token. - void HandleRequest(ISyncPlayStateContext context, GroupState prevState, RemoveFromPlaylistGroupRequest request, SessionInfo session, CancellationToken cancellationToken); - - /// - /// Handles a move-item change requested by a session. Context's state should not change. - /// - /// The context of the state. - /// The previous state. - /// The move-item change action. - /// The session. - /// The cancellation token. - void HandleRequest(ISyncPlayStateContext context, GroupState prevState, MovePlaylistItemGroupRequest request, SessionInfo session, CancellationToken cancellationToken); - - /// - /// Handles a queue change requested by a session. Context's state should not change. - /// - /// The context of the state. - /// The previous state. - /// The queue action. - /// The session. - /// The cancellation token. - void HandleRequest(ISyncPlayStateContext context, GroupState prevState, QueueGroupRequest request, SessionInfo session, CancellationToken cancellationToken); - - /// - /// Handles an unpause action requested by a session. Context's state can change. - /// - /// The context of the state. - /// The previous state. - /// The unpause action. - /// The session. - /// The cancellation token. - void HandleRequest(ISyncPlayStateContext context, GroupState prevState, UnpauseGroupRequest request, SessionInfo session, CancellationToken cancellationToken); - - /// - /// Handles a pause action requested by a session. Context's state can change. - /// - /// The context of the state. - /// The previous state. - /// The pause action. - /// The session. - /// The cancellation token. - void HandleRequest(ISyncPlayStateContext context, GroupState prevState, PauseGroupRequest request, SessionInfo session, CancellationToken cancellationToken); - - /// - /// Handles a stop action requested by a session. Context's state can change. - /// - /// The context of the state. - /// The previous state. - /// The stop action. - /// The session. - /// The cancellation token. - void HandleRequest(ISyncPlayStateContext context, GroupState prevState, StopGroupRequest request, SessionInfo session, CancellationToken cancellationToken); - - /// - /// Handles a seek action requested by a session. Context's state can change. - /// - /// The context of the state. - /// The previous state. - /// The seek action. - /// The session. - /// The cancellation token. - void HandleRequest(ISyncPlayStateContext context, GroupState prevState, SeekGroupRequest request, SessionInfo session, CancellationToken cancellationToken); - - /// - /// Handles a buffering action requested by a session. Context's state can change. - /// - /// The context of the state. - /// The previous state. - /// The buffering action. - /// The session. - /// The cancellation token. - void HandleRequest(ISyncPlayStateContext context, GroupState prevState, BufferGroupRequest request, SessionInfo session, CancellationToken cancellationToken); - - /// - /// Handles a buffering-done action requested by a session. Context's state can change. - /// - /// The context of the state. - /// The previous state. - /// The buffering-done action. - /// The session. - /// The cancellation token. - void HandleRequest(ISyncPlayStateContext context, GroupState prevState, ReadyGroupRequest request, SessionInfo session, CancellationToken cancellationToken); - - /// - /// Handles a next-track action requested by a session. Context's state can change. - /// - /// The context of the state. - /// The previous state. - /// The next-track action. - /// The session. - /// The cancellation token. - void HandleRequest(ISyncPlayStateContext context, GroupState prevState, NextTrackGroupRequest request, SessionInfo session, CancellationToken cancellationToken); - - /// - /// Handles a previous-track action requested by a session. Context's state can change. - /// - /// The context of the state. - /// The previous state. - /// The previous-track action. - /// The session. - /// The cancellation token. - void HandleRequest(ISyncPlayStateContext context, GroupState prevState, PreviousTrackGroupRequest request, SessionInfo session, CancellationToken cancellationToken); - - /// - /// Handles a repeat-mode change requested by a session. Context's state should not change. - /// - /// The context of the state. - /// The previous state. - /// The repeat-mode action. - /// The session. - /// The cancellation token. - void HandleRequest(ISyncPlayStateContext context, GroupState prevState, SetRepeatModeGroupRequest request, SessionInfo session, CancellationToken cancellationToken); - - /// - /// Handles a shuffle-mode change requested by a session. Context's state should not change. - /// - /// The context of the state. - /// The previous state. - /// The shuffle-mode action. - /// The session. - /// The cancellation token. - void HandleRequest(ISyncPlayStateContext context, GroupState prevState, SetShuffleModeGroupRequest request, SessionInfo session, CancellationToken cancellationToken); - - /// - /// Updates ping of a session. Context's state should not change. - /// - /// The context of the state. - /// The previous state. - /// The buffering-done action. - /// The session. - /// The cancellation token. - void HandleRequest(ISyncPlayStateContext context, GroupState prevState, PingGroupRequest request, SessionInfo session, CancellationToken cancellationToken); - - /// - /// Updates whether the session should be considered during group wait. Context's state should not change. - /// - /// The context of the state. - /// The previous state. - /// The ignore-wait action. - /// The session. - /// The cancellation token. - void HandleRequest(ISyncPlayStateContext context, GroupState prevState, IgnoreWaitGroupRequest request, SessionInfo session, CancellationToken cancellationToken); - } -} diff --git a/MediaBrowser.Controller/SyncPlay/ISyncPlayStateContext.cs b/MediaBrowser.Controller/SyncPlay/ISyncPlayStateContext.cs deleted file mode 100644 index 4aac2a8818..0000000000 --- a/MediaBrowser.Controller/SyncPlay/ISyncPlayStateContext.cs +++ /dev/null @@ -1,225 +0,0 @@ -using System; -using System.Threading; -using System.Threading.Tasks; -using MediaBrowser.Model.SyncPlay; -using MediaBrowser.Controller.Session; - -namespace MediaBrowser.Controller.SyncPlay -{ - /// - /// Interface ISyncPlayStateContext. - /// - public interface ISyncPlayStateContext - { - /// - /// Gets the default ping value used for sessions, in milliseconds. - /// - /// The default ping value used for sessions, in milliseconds. - long DefaultPing { get; } - - /// - /// Gets the maximum time offset error accepted for dates reported by clients, in milliseconds. - /// - /// The maximum offset error accepted, in milliseconds. - long TimeSyncOffset { get; } - - /// - /// Gets the maximum offset error accepted for position reported by clients, in milliseconds. - /// - /// The maximum offset error accepted, in milliseconds. - long MaxPlaybackOffset { get; } - - /// - /// Gets the group identifier. - /// - /// The group identifier. - Guid GroupId { get; } - - /// - /// Gets or sets the position ticks. - /// - /// The position ticks. - long PositionTicks { get; set; } - - /// - /// Gets or sets the last activity. - /// - /// The last activity. - DateTime LastActivity { get; set; } - - /// - /// Gets the play queue. - /// - /// The play queue. - PlayQueueManager PlayQueue { get; } - - /// - /// Sets a new state. - /// - /// The new state. - void SetState(ISyncPlayState state); - - /// - /// Sends a GroupUpdate message to the interested sessions. - /// - /// The current session. - /// The filtering type. - /// The message to send. - /// The cancellation token. - /// The task. - Task SendGroupUpdate(SessionInfo from, SyncPlayBroadcastType type, GroupUpdate message, CancellationToken cancellationToken); - - /// - /// Sends a playback command to the interested sessions. - /// - /// The current session. - /// The filtering type. - /// The message to send. - /// The cancellation token. - /// The task. - Task SendCommand(SessionInfo from, SyncPlayBroadcastType type, SendCommand message, CancellationToken cancellationToken); - - /// - /// Builds a new playback command with some default values. - /// - /// The command type. - /// The command. - SendCommand NewSyncPlayCommand(SendCommandType type); - - /// - /// Builds a new group update message. - /// - /// The update type. - /// The data to send. - /// The group update. - GroupUpdate NewSyncPlayGroupUpdate(GroupUpdateType type, T data); - - /// - /// Converts DateTime to UTC string. - /// - /// The date to convert. - /// The UTC string. - string DateToUTCString(DateTime dateTime); - - /// - /// Sanitizes the PositionTicks, considers the current playing item when available. - /// - /// The PositionTicks. - /// The sanitized position ticks. - long SanitizePositionTicks(long? positionTicks); - - /// - /// Updates the ping of a session, in milliseconds. - /// - /// The session. - /// The ping, in milliseconds. - void UpdatePing(SessionInfo session, long ping); - - /// - /// Gets the highest ping in the group, in milliseconds. - /// - /// The highest ping in the group. - long GetHighestPing(); - - /// - /// Sets the session's buffering state. - /// - /// The session. - /// The state. - void SetBuffering(SessionInfo session, bool isBuffering); - - /// - /// Sets the buffering state of all the sessions. - /// - /// The state. - void SetAllBuffering(bool isBuffering); - - /// - /// Gets the group buffering state. - /// - /// true if there is a session buffering in the group; false otherwise. - bool IsBuffering(); - - /// - /// Sets the session's group wait state. - /// - /// The session. - /// The state. - void SetIgnoreGroupWait(SessionInfo session, bool ignoreGroupWait); - - /// - /// Sets a new play queue. - /// - /// The new play queue. - /// The playing item position in the play queue. - /// The start position ticks. - /// true if the play queue has been changed; false if something went wrong. - bool SetPlayQueue(Guid[] playQueue, int playingItemPosition, long startPositionTicks); - - /// - /// Sets the playing item. - /// - /// The new playing item identifier. - /// true if the play queue has been changed; false if something went wrong. - bool SetPlayingItem(string playlistItemId); - - /// - /// Removes items from the play queue. - /// - /// The items to remove. - /// true if playing item got removed; false otherwise. - bool RemoveFromPlayQueue(string[] playlistItemIds); - - /// - /// Moves an item in the play queue. - /// - /// The playlist identifier of the item to move. - /// The new position. - /// true if item has been moved; false if something went wrong. - bool MoveItemInPlayQueue(string playlistItemId, int newIndex); - - /// - /// Updates the play queue. - /// - /// The new items to add to the play queue. - /// The mode with which the items will be added. - /// true if the play queue has been changed; false if something went wrong. - bool AddToPlayQueue(Guid[] newItems, string mode); - - /// - /// Restarts current item in play queue. - /// - void RestartCurrentItem(); - - /// - /// Picks next item in play queue. - /// - /// true if the item changed; false otherwise. - bool NextItemInQueue(); - - /// - /// Picks previous item in play queue. - /// - /// true if the item changed; false otherwise. - bool PreviousItemInQueue(); - - /// - /// Sets the repeat mode. - /// - /// The new mode. - void SetRepeatMode(string mode); - - /// - /// Sets the shuffle mode. - /// - /// The new mode. - void SetShuffleMode(string mode); - - /// - /// Creates a play queue update. - /// - /// The reason for the update. - /// The play queue update. - PlayQueueUpdate GetPlayQueueUpdate(PlayQueueUpdateReason reason); - } -} diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/BufferGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequest/BufferGroupRequest.cs deleted file mode 100644 index 65fced43f1..0000000000 --- a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/BufferGroupRequest.cs +++ /dev/null @@ -1,49 +0,0 @@ -using System; -using System.Threading; -using MediaBrowser.Model.SyncPlay; -using MediaBrowser.Controller.Session; - -namespace MediaBrowser.Controller.SyncPlay -{ - /// - /// Class BufferGroupRequest. - /// - public class BufferGroupRequest : IPlaybackGroupRequest - { - /// - /// Gets or sets when the request has been made by the client. - /// - /// The date of the request. - public DateTime When { get; set; } - - /// - /// Gets or sets the position ticks. - /// - /// The position ticks. - public long PositionTicks { get; set; } - - /// - /// Gets or sets the client playback status. - /// - /// The client playback status. - public bool IsPlaying { get; set; } - - /// - /// Gets or sets the playlist item identifier of the playing item. - /// - /// The playlist item identifier. - public string PlaylistItemId { get; set; } - - /// - public PlaybackRequestType GetRequestType() - { - return PlaybackRequestType.Buffer; - } - - /// - public void Apply(ISyncPlayStateContext context, ISyncPlayState state, SessionInfo session, CancellationToken cancellationToken) - { - state.HandleRequest(context, state.GetGroupState(), this, session, cancellationToken); - } - } -} diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/IgnoreWaitGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequest/IgnoreWaitGroupRequest.cs deleted file mode 100644 index 5466cbe2f7..0000000000 --- a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/IgnoreWaitGroupRequest.cs +++ /dev/null @@ -1,30 +0,0 @@ -using System.Threading; -using MediaBrowser.Model.SyncPlay; -using MediaBrowser.Controller.Session; - -namespace MediaBrowser.Controller.SyncPlay -{ - /// - /// Class IgnoreWaitGroupRequest. - /// - public class IgnoreWaitGroupRequest : IPlaybackGroupRequest - { - /// - /// Gets or sets the client group-wait status. - /// - /// The client group-wait status. - public bool IgnoreWait { get; set; } - - /// - public PlaybackRequestType GetRequestType() - { - return PlaybackRequestType.IgnoreWait; - } - - /// - public void Apply(ISyncPlayStateContext context, ISyncPlayState state, SessionInfo session, CancellationToken cancellationToken) - { - state.HandleRequest(context, state.GetGroupState(), this, session, cancellationToken); - } - } -} diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/MovePlaylistItemGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequest/MovePlaylistItemGroupRequest.cs deleted file mode 100644 index 38170facf0..0000000000 --- a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/MovePlaylistItemGroupRequest.cs +++ /dev/null @@ -1,36 +0,0 @@ -using System.Threading; -using MediaBrowser.Model.SyncPlay; -using MediaBrowser.Controller.Session; - -namespace MediaBrowser.Controller.SyncPlay -{ - /// - /// Class MovePlaylistItemGroupRequest. - /// - public class MovePlaylistItemGroupRequest : IPlaybackGroupRequest - { - /// - /// Gets or sets the playlist identifier of the item. - /// - /// The playlist identifier of the item. - public string PlaylistItemId { get; set; } - - /// - /// Gets or sets the new position. - /// - /// The new position. - public int NewIndex { get; set; } - - /// - public PlaybackRequestType GetRequestType() - { - return PlaybackRequestType.MovePlaylistItem; - } - - /// - public void Apply(ISyncPlayStateContext context, ISyncPlayState state, SessionInfo session, CancellationToken cancellationToken) - { - state.HandleRequest(context, state.GetGroupState(), this, session, cancellationToken); - } - } -} diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/NextTrackGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequest/NextTrackGroupRequest.cs deleted file mode 100644 index b27c10f169..0000000000 --- a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/NextTrackGroupRequest.cs +++ /dev/null @@ -1,30 +0,0 @@ -using System.Threading; -using MediaBrowser.Model.SyncPlay; -using MediaBrowser.Controller.Session; - -namespace MediaBrowser.Controller.SyncPlay -{ - /// - /// Class NextTrackGroupRequest. - /// - public class NextTrackGroupRequest : IPlaybackGroupRequest - { - /// - /// Gets or sets the playing item identifier. - /// - /// The playing item identifier. - public string PlaylistItemId { get; set; } - - /// - public PlaybackRequestType GetRequestType() - { - return PlaybackRequestType.NextTrack; - } - - /// - public void Apply(ISyncPlayStateContext context, ISyncPlayState state, SessionInfo session, CancellationToken cancellationToken) - { - state.HandleRequest(context, state.GetGroupState(), this, session, cancellationToken); - } - } -} diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/PauseGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequest/PauseGroupRequest.cs deleted file mode 100644 index facb25155c..0000000000 --- a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/PauseGroupRequest.cs +++ /dev/null @@ -1,24 +0,0 @@ -using System.Threading; -using MediaBrowser.Model.SyncPlay; -using MediaBrowser.Controller.Session; - -namespace MediaBrowser.Controller.SyncPlay -{ - /// - /// Class PauseGroupRequest. - /// - public class PauseGroupRequest : IPlaybackGroupRequest - { - /// - public PlaybackRequestType GetRequestType() - { - return PlaybackRequestType.Pause; - } - - /// - public void Apply(ISyncPlayStateContext context, ISyncPlayState state, SessionInfo session, CancellationToken cancellationToken) - { - state.HandleRequest(context, state.GetGroupState(), this, session, cancellationToken); - } - } -} diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/PingGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequest/PingGroupRequest.cs deleted file mode 100644 index 5605578d75..0000000000 --- a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/PingGroupRequest.cs +++ /dev/null @@ -1,30 +0,0 @@ -using System.Threading; -using MediaBrowser.Model.SyncPlay; -using MediaBrowser.Controller.Session; - -namespace MediaBrowser.Controller.SyncPlay -{ - /// - /// Class PingGroupRequest. - /// - public class PingGroupRequest : IPlaybackGroupRequest - { - /// - /// Gets or sets the ping time. - /// - /// The ping time. - public long Ping { get; set; } - - /// - public PlaybackRequestType GetRequestType() - { - return PlaybackRequestType.Ping; - } - - /// - public void Apply(ISyncPlayStateContext context, ISyncPlayState state, SessionInfo session, CancellationToken cancellationToken) - { - state.HandleRequest(context, state.GetGroupState(), this, session, cancellationToken); - } - } -} diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/PlayGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequest/PlayGroupRequest.cs deleted file mode 100644 index f3dd769e46..0000000000 --- a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/PlayGroupRequest.cs +++ /dev/null @@ -1,43 +0,0 @@ -using System; -using System.Threading; -using MediaBrowser.Model.SyncPlay; -using MediaBrowser.Controller.Session; - -namespace MediaBrowser.Controller.SyncPlay -{ - /// - /// Class PlayGroupRequest. - /// - public class PlayGroupRequest : IPlaybackGroupRequest - { - /// - /// Gets or sets the playing queue. - /// - /// The playing queue. - public Guid[] PlayingQueue { get; set; } - - /// - /// Gets or sets the playing item from the queue. - /// - /// The playing item. - public int PlayingItemPosition { get; set; } - - /// - /// Gets or sets the start position ticks. - /// - /// The start position ticks. - public long StartPositionTicks { get; set; } - - /// - public PlaybackRequestType GetRequestType() - { - return PlaybackRequestType.Play; - } - - /// - public void Apply(ISyncPlayStateContext context, ISyncPlayState state, SessionInfo session, CancellationToken cancellationToken) - { - state.HandleRequest(context, state.GetGroupState(), this, session, cancellationToken); - } - } -} diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/PreviousTrackGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequest/PreviousTrackGroupRequest.cs deleted file mode 100644 index 31b93b9675..0000000000 --- a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/PreviousTrackGroupRequest.cs +++ /dev/null @@ -1,30 +0,0 @@ -using System.Threading; -using MediaBrowser.Model.SyncPlay; -using MediaBrowser.Controller.Session; - -namespace MediaBrowser.Controller.SyncPlay -{ - /// - /// Class PreviousTrackGroupRequest. - /// - public class PreviousTrackGroupRequest : IPlaybackGroupRequest - { - /// - /// Gets or sets the playing item identifier. - /// - /// The playing item identifier. - public string PlaylistItemId { get; set; } - - /// - public PlaybackRequestType GetRequestType() - { - return PlaybackRequestType.PreviousTrack; - } - - /// - public void Apply(ISyncPlayStateContext context, ISyncPlayState state, SessionInfo session, CancellationToken cancellationToken) - { - state.HandleRequest(context, state.GetGroupState(), this, session, cancellationToken); - } - } -} diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/QueueGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequest/QueueGroupRequest.cs deleted file mode 100644 index 01c08cc860..0000000000 --- a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/QueueGroupRequest.cs +++ /dev/null @@ -1,37 +0,0 @@ -using System; -using System.Threading; -using MediaBrowser.Model.SyncPlay; -using MediaBrowser.Controller.Session; - -namespace MediaBrowser.Controller.SyncPlay -{ - /// - /// Class QueueGroupRequest. - /// - public class QueueGroupRequest : IPlaybackGroupRequest - { - /// - /// Gets or sets the items to queue. - /// - /// The items to queue. - public Guid[] ItemIds { get; set; } - - /// - /// Gets or sets the mode in which to add the new items. - /// - /// The mode. - public string Mode { get; set; } - - /// - public PlaybackRequestType GetRequestType() - { - return PlaybackRequestType.Queue; - } - - /// - public void Apply(ISyncPlayStateContext context, ISyncPlayState state, SessionInfo session, CancellationToken cancellationToken) - { - state.HandleRequest(context, state.GetGroupState(), this, session, cancellationToken); - } - } -} diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/ReadyGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequest/ReadyGroupRequest.cs deleted file mode 100644 index 8f266ed32e..0000000000 --- a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/ReadyGroupRequest.cs +++ /dev/null @@ -1,49 +0,0 @@ -using System; -using System.Threading; -using MediaBrowser.Model.SyncPlay; -using MediaBrowser.Controller.Session; - -namespace MediaBrowser.Controller.SyncPlay -{ - /// - /// Class ReadyGroupRequest. - /// - public class ReadyGroupRequest : IPlaybackGroupRequest - { - /// - /// Gets or sets when the request has been made by the client. - /// - /// The date of the request. - public DateTime When { get; set; } - - /// - /// Gets or sets the position ticks. - /// - /// The position ticks. - public long PositionTicks { get; set; } - - /// - /// Gets or sets the client playback status. - /// - /// The client playback status. - public bool IsPlaying { get; set; } - - /// - /// Gets or sets the playlist item identifier of the playing item. - /// - /// The playlist item identifier. - public string PlaylistItemId { get; set; } - - /// - public PlaybackRequestType GetRequestType() - { - return PlaybackRequestType.Ready; - } - - /// - public void Apply(ISyncPlayStateContext context, ISyncPlayState state, SessionInfo session, CancellationToken cancellationToken) - { - state.HandleRequest(context, state.GetGroupState(), this, session, cancellationToken); - } - } -} diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/RemoveFromPlaylistGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequest/RemoveFromPlaylistGroupRequest.cs deleted file mode 100644 index 78aeb9c6f0..0000000000 --- a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/RemoveFromPlaylistGroupRequest.cs +++ /dev/null @@ -1,30 +0,0 @@ -using System.Threading; -using MediaBrowser.Model.SyncPlay; -using MediaBrowser.Controller.Session; - -namespace MediaBrowser.Controller.SyncPlay -{ - /// - /// Class RemoveFromPlaylistGroupRequest. - /// - public class RemoveFromPlaylistGroupRequest : IPlaybackGroupRequest - { - /// - /// Gets or sets the playlist identifiers ot the items. - /// - /// The playlist identifiers ot the items. - public string[] PlaylistItemIds { get; set; } - - /// - public PlaybackRequestType GetRequestType() - { - return PlaybackRequestType.RemoveFromPlaylist; - } - - /// - public void Apply(ISyncPlayStateContext context, ISyncPlayState state, SessionInfo session, CancellationToken cancellationToken) - { - state.HandleRequest(context, state.GetGroupState(), this, session, cancellationToken); - } - } -} diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/SeekGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequest/SeekGroupRequest.cs deleted file mode 100644 index 24d9be5073..0000000000 --- a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/SeekGroupRequest.cs +++ /dev/null @@ -1,30 +0,0 @@ -using System.Threading; -using MediaBrowser.Model.SyncPlay; -using MediaBrowser.Controller.Session; - -namespace MediaBrowser.Controller.SyncPlay -{ - /// - /// Class SeekGroupRequest. - /// - public class SeekGroupRequest : IPlaybackGroupRequest - { - /// - /// Gets or sets the position ticks. - /// - /// The position ticks. - public long PositionTicks { get; set; } - - /// - public PlaybackRequestType GetRequestType() - { - return PlaybackRequestType.Seek; - } - - /// - public void Apply(ISyncPlayStateContext context, ISyncPlayState state, SessionInfo session, CancellationToken cancellationToken) - { - state.HandleRequest(context, state.GetGroupState(), this, session, cancellationToken); - } - } -} diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/SetCurrentItemGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequest/SetCurrentItemGroupRequest.cs deleted file mode 100644 index 070fd71d25..0000000000 --- a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/SetCurrentItemGroupRequest.cs +++ /dev/null @@ -1,30 +0,0 @@ -using System.Threading; -using MediaBrowser.Model.SyncPlay; -using MediaBrowser.Controller.Session; - -namespace MediaBrowser.Controller.SyncPlay -{ - /// - /// Class SetPlaylistItemGroupRequest. - /// - public class SetPlaylistItemGroupRequest : IPlaybackGroupRequest - { - /// - /// Gets or sets the playlist identifier of the playing item. - /// - /// The playlist identifier of the playing item. - public string PlaylistItemId { get; set; } - - /// - public PlaybackRequestType GetRequestType() - { - return PlaybackRequestType.SetPlaylistItem; - } - - /// - public void Apply(ISyncPlayStateContext context, ISyncPlayState state, SessionInfo session, CancellationToken cancellationToken) - { - state.HandleRequest(context, state.GetGroupState(), this, session, cancellationToken); - } - } -} diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/SetRepeatModeGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequest/SetRepeatModeGroupRequest.cs deleted file mode 100644 index 5f36f60e45..0000000000 --- a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/SetRepeatModeGroupRequest.cs +++ /dev/null @@ -1,30 +0,0 @@ -using System.Threading; -using MediaBrowser.Model.SyncPlay; -using MediaBrowser.Controller.Session; - -namespace MediaBrowser.Controller.SyncPlay -{ - /// - /// Class SetRepeatModeGroupRequest. - /// - public class SetRepeatModeGroupRequest : IPlaybackGroupRequest - { - /// - /// Gets or sets the repeat mode. - /// - /// The repeat mode. - public string Mode { get; set; } - - /// - public PlaybackRequestType GetRequestType() - { - return PlaybackRequestType.SetRepeatMode; - } - - /// - public void Apply(ISyncPlayStateContext context, ISyncPlayState state, SessionInfo session, CancellationToken cancellationToken) - { - state.HandleRequest(context, state.GetGroupState(), this, session, cancellationToken); - } - } -} diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/SetShuffleModeGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequest/SetShuffleModeGroupRequest.cs deleted file mode 100644 index 472455fd3b..0000000000 --- a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/SetShuffleModeGroupRequest.cs +++ /dev/null @@ -1,30 +0,0 @@ -using System.Threading; -using MediaBrowser.Model.SyncPlay; -using MediaBrowser.Controller.Session; - -namespace MediaBrowser.Controller.SyncPlay -{ - /// - /// Class SetShuffleModeGroupRequest. - /// - public class SetShuffleModeGroupRequest : IPlaybackGroupRequest - { - /// - /// Gets or sets the shuffle mode. - /// - /// The shuffle mode. - public string Mode { get; set; } - - /// - public PlaybackRequestType GetRequestType() - { - return PlaybackRequestType.SetShuffleMode; - } - - /// - public void Apply(ISyncPlayStateContext context, ISyncPlayState state, SessionInfo session, CancellationToken cancellationToken) - { - state.HandleRequest(context, state.GetGroupState(), this, session, cancellationToken); - } - } -} diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/StopGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequest/StopGroupRequest.cs deleted file mode 100644 index f1581c98d9..0000000000 --- a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/StopGroupRequest.cs +++ /dev/null @@ -1,24 +0,0 @@ -using System.Threading; -using MediaBrowser.Model.SyncPlay; -using MediaBrowser.Controller.Session; - -namespace MediaBrowser.Controller.SyncPlay -{ - /// - /// Class StopGroupRequest. - /// - public class StopGroupRequest : IPlaybackGroupRequest - { - /// - public PlaybackRequestType GetRequestType() - { - return PlaybackRequestType.Stop; - } - - /// - public void Apply(ISyncPlayStateContext context, ISyncPlayState state, SessionInfo session, CancellationToken cancellationToken) - { - state.HandleRequest(context, state.GetGroupState(), this, session, cancellationToken); - } - } -} diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/UnpauseGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequest/UnpauseGroupRequest.cs deleted file mode 100644 index 1072952081..0000000000 --- a/MediaBrowser.Controller/SyncPlay/PlaybackRequest/UnpauseGroupRequest.cs +++ /dev/null @@ -1,24 +0,0 @@ -using System.Threading; -using MediaBrowser.Model.SyncPlay; -using MediaBrowser.Controller.Session; - -namespace MediaBrowser.Controller.SyncPlay -{ - /// - /// Class UnpauseGroupRequest. - /// - public class UnpauseGroupRequest : IPlaybackGroupRequest - { - /// - public PlaybackRequestType GetRequestType() - { - return PlaybackRequestType.Unpause; - } - - /// - public void Apply(ISyncPlayStateContext context, ISyncPlayState state, SessionInfo session, CancellationToken cancellationToken) - { - state.HandleRequest(context, state.GetGroupState(), this, session, cancellationToken); - } - } -} diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/BufferGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/BufferGroupRequest.cs new file mode 100644 index 0000000000..b5bed89f21 --- /dev/null +++ b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/BufferGroupRequest.cs @@ -0,0 +1,46 @@ +using System; +using System.Threading; +using MediaBrowser.Controller.Session; +using MediaBrowser.Model.SyncPlay; + +namespace MediaBrowser.Controller.SyncPlay +{ + /// + /// Class BufferGroupRequest. + /// + public class BufferGroupRequest : IGroupPlaybackRequest + { + /// + /// Gets or sets when the request has been made by the client. + /// + /// The date of the request. + public DateTime When { get; set; } + + /// + /// Gets or sets the position ticks. + /// + /// The position ticks. + public long PositionTicks { get; set; } + + /// + /// Gets or sets a value indicating whether the client playback is unpaused. + /// + /// The client playback status. + public bool IsPlaying { get; set; } + + /// + /// Gets or sets the playlist item identifier of the playing item. + /// + /// The playlist item identifier. + public string PlaylistItemId { get; set; } + + /// + public PlaybackRequestType Type { get; } = PlaybackRequestType.Buffer; + + /// + public void Apply(IGroupStateContext context, IGroupState state, SessionInfo session, CancellationToken cancellationToken) + { + state.HandleRequest(context, state.Type, this, session, cancellationToken); + } + } +} diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/IgnoreWaitGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/IgnoreWaitGroupRequest.cs new file mode 100644 index 0000000000..325839f107 --- /dev/null +++ b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/IgnoreWaitGroupRequest.cs @@ -0,0 +1,27 @@ +using System.Threading; +using MediaBrowser.Controller.Session; +using MediaBrowser.Model.SyncPlay; + +namespace MediaBrowser.Controller.SyncPlay +{ + /// + /// Class IgnoreWaitGroupRequest. + /// + public class IgnoreWaitGroupRequest : IGroupPlaybackRequest + { + /// + /// Gets or sets a value indicating whether the client should be ignored. + /// + /// The client group-wait status. + public bool IgnoreWait { get; set; } + + /// + public PlaybackRequestType Type { get; } = PlaybackRequestType.IgnoreWait; + + /// + public void Apply(IGroupStateContext context, IGroupState state, SessionInfo session, CancellationToken cancellationToken) + { + state.HandleRequest(context, state.Type, this, session, cancellationToken); + } + } +} diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/MovePlaylistItemGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/MovePlaylistItemGroupRequest.cs new file mode 100644 index 0000000000..3c95f53d4a --- /dev/null +++ b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/MovePlaylistItemGroupRequest.cs @@ -0,0 +1,33 @@ +using System.Threading; +using MediaBrowser.Controller.Session; +using MediaBrowser.Model.SyncPlay; + +namespace MediaBrowser.Controller.SyncPlay +{ + /// + /// Class MovePlaylistItemGroupRequest. + /// + public class MovePlaylistItemGroupRequest : IGroupPlaybackRequest + { + /// + /// Gets or sets the playlist identifier of the item. + /// + /// The playlist identifier of the item. + public string PlaylistItemId { get; set; } + + /// + /// Gets or sets the new position. + /// + /// The new position. + public int NewIndex { get; set; } + + /// + public PlaybackRequestType Type { get; } = PlaybackRequestType.MovePlaylistItem; + + /// + public void Apply(IGroupStateContext context, IGroupState state, SessionInfo session, CancellationToken cancellationToken) + { + state.HandleRequest(context, state.Type, this, session, cancellationToken); + } + } +} diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/NextTrackGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/NextTrackGroupRequest.cs new file mode 100644 index 0000000000..8636d6f4d5 --- /dev/null +++ b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/NextTrackGroupRequest.cs @@ -0,0 +1,27 @@ +using System.Threading; +using MediaBrowser.Controller.Session; +using MediaBrowser.Model.SyncPlay; + +namespace MediaBrowser.Controller.SyncPlay +{ + /// + /// Class NextTrackGroupRequest. + /// + public class NextTrackGroupRequest : IGroupPlaybackRequest + { + /// + /// Gets or sets the playing item identifier. + /// + /// The playing item identifier. + public string PlaylistItemId { get; set; } + + /// + public PlaybackRequestType Type { get; } = PlaybackRequestType.NextTrack; + + /// + public void Apply(IGroupStateContext context, IGroupState state, SessionInfo session, CancellationToken cancellationToken) + { + state.HandleRequest(context, state.Type, this, session, cancellationToken); + } + } +} diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/PauseGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/PauseGroupRequest.cs new file mode 100644 index 0000000000..45bd3b15f1 --- /dev/null +++ b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/PauseGroupRequest.cs @@ -0,0 +1,21 @@ +using System.Threading; +using MediaBrowser.Controller.Session; +using MediaBrowser.Model.SyncPlay; + +namespace MediaBrowser.Controller.SyncPlay +{ + /// + /// Class PauseGroupRequest. + /// + public class PauseGroupRequest : IGroupPlaybackRequest + { + /// + public PlaybackRequestType Type { get; } = PlaybackRequestType.Pause; + + /// + public void Apply(IGroupStateContext context, IGroupState state, SessionInfo session, CancellationToken cancellationToken) + { + state.HandleRequest(context, state.Type, this, session, cancellationToken); + } + } +} diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/PingGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/PingGroupRequest.cs new file mode 100644 index 0000000000..9dacb79857 --- /dev/null +++ b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/PingGroupRequest.cs @@ -0,0 +1,27 @@ +using System.Threading; +using MediaBrowser.Controller.Session; +using MediaBrowser.Model.SyncPlay; + +namespace MediaBrowser.Controller.SyncPlay +{ + /// + /// Class PingGroupRequest. + /// + public class PingGroupRequest : IGroupPlaybackRequest + { + /// + /// Gets or sets the ping time. + /// + /// The ping time. + public long Ping { get; set; } + + /// + public PlaybackRequestType Type { get; } = PlaybackRequestType.Ping; + + /// + public void Apply(IGroupStateContext context, IGroupState state, SessionInfo session, CancellationToken cancellationToken) + { + state.HandleRequest(context, state.Type, this, session, cancellationToken); + } + } +} diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/PlayGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/PlayGroupRequest.cs new file mode 100644 index 0000000000..e090a882e2 --- /dev/null +++ b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/PlayGroupRequest.cs @@ -0,0 +1,41 @@ +using System; +using System.Collections.Generic; +using System.Threading; +using MediaBrowser.Controller.Session; +using MediaBrowser.Model.SyncPlay; + +namespace MediaBrowser.Controller.SyncPlay +{ + /// + /// Class PlayGroupRequest. + /// + public class PlayGroupRequest : IGroupPlaybackRequest + { + /// + /// Gets the playing queue. + /// + /// The playing queue. + public List PlayingQueue { get; } = new List(); + + /// + /// Gets or sets the playing item from the queue. + /// + /// The playing item. + public int PlayingItemPosition { get; set; } + + /// + /// Gets or sets the start position ticks. + /// + /// The start position ticks. + public long StartPositionTicks { get; set; } + + /// + public PlaybackRequestType Type { get; } = PlaybackRequestType.Play; + + /// + public void Apply(IGroupStateContext context, IGroupState state, SessionInfo session, CancellationToken cancellationToken) + { + state.HandleRequest(context, state.Type, this, session, cancellationToken); + } + } +} diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/PreviousTrackGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/PreviousTrackGroupRequest.cs new file mode 100644 index 0000000000..aca5d678e0 --- /dev/null +++ b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/PreviousTrackGroupRequest.cs @@ -0,0 +1,27 @@ +using System.Threading; +using MediaBrowser.Controller.Session; +using MediaBrowser.Model.SyncPlay; + +namespace MediaBrowser.Controller.SyncPlay +{ + /// + /// Class PreviousTrackGroupRequest. + /// + public class PreviousTrackGroupRequest : IGroupPlaybackRequest + { + /// + /// Gets or sets the playing item identifier. + /// + /// The playing item identifier. + public string PlaylistItemId { get; set; } + + /// + public PlaybackRequestType Type { get; } = PlaybackRequestType.PreviousTrack; + + /// + public void Apply(IGroupStateContext context, IGroupState state, SessionInfo session, CancellationToken cancellationToken) + { + state.HandleRequest(context, state.Type, this, session, cancellationToken); + } + } +} diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/QueueGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/QueueGroupRequest.cs new file mode 100644 index 0000000000..82380b2098 --- /dev/null +++ b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/QueueGroupRequest.cs @@ -0,0 +1,35 @@ +using System; +using System.Collections.Generic; +using System.Threading; +using MediaBrowser.Controller.Session; +using MediaBrowser.Model.SyncPlay; + +namespace MediaBrowser.Controller.SyncPlay +{ + /// + /// Class QueueGroupRequest. + /// + public class QueueGroupRequest : IGroupPlaybackRequest + { + /// + /// Gets the items to queue. + /// + /// The items to queue. + public List ItemIds { get; } = new List(); + + /// + /// Gets or sets the mode in which to add the new items. + /// + /// The mode. + public string Mode { get; set; } + + /// + public PlaybackRequestType Type { get; } = PlaybackRequestType.Queue; + + /// + public void Apply(IGroupStateContext context, IGroupState state, SessionInfo session, CancellationToken cancellationToken) + { + state.HandleRequest(context, state.Type, this, session, cancellationToken); + } + } +} diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/ReadyGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/ReadyGroupRequest.cs new file mode 100644 index 0000000000..c8a2268cfb --- /dev/null +++ b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/ReadyGroupRequest.cs @@ -0,0 +1,46 @@ +using System; +using System.Threading; +using MediaBrowser.Controller.Session; +using MediaBrowser.Model.SyncPlay; + +namespace MediaBrowser.Controller.SyncPlay +{ + /// + /// Class ReadyGroupRequest. + /// + public class ReadyGroupRequest : IGroupPlaybackRequest + { + /// + /// Gets or sets when the request has been made by the client. + /// + /// The date of the request. + public DateTime When { get; set; } + + /// + /// Gets or sets the position ticks. + /// + /// The position ticks. + public long PositionTicks { get; set; } + + /// + /// Gets or sets a value indicating whether the client playback is unpaused. + /// + /// The client playback status. + public bool IsPlaying { get; set; } + + /// + /// Gets or sets the playlist item identifier of the playing item. + /// + /// The playlist item identifier. + public string PlaylistItemId { get; set; } + + /// + public PlaybackRequestType Type { get; } = PlaybackRequestType.Ready; + + /// + public void Apply(IGroupStateContext context, IGroupState state, SessionInfo session, CancellationToken cancellationToken) + { + state.HandleRequest(context, state.Type, this, session, cancellationToken); + } + } +} diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/RemoveFromPlaylistGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/RemoveFromPlaylistGroupRequest.cs new file mode 100644 index 0000000000..4ead1301b6 --- /dev/null +++ b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/RemoveFromPlaylistGroupRequest.cs @@ -0,0 +1,28 @@ +using System.Collections.Generic; +using System.Threading; +using MediaBrowser.Controller.Session; +using MediaBrowser.Model.SyncPlay; + +namespace MediaBrowser.Controller.SyncPlay +{ + /// + /// Class RemoveFromPlaylistGroupRequest. + /// + public class RemoveFromPlaylistGroupRequest : IGroupPlaybackRequest + { + /// + /// Gets the playlist identifiers ot the items. + /// + /// The playlist identifiers ot the items. + public List PlaylistItemIds { get; } = new List(); + + /// + public PlaybackRequestType Type { get; } = PlaybackRequestType.RemoveFromPlaylist; + + /// + public void Apply(IGroupStateContext context, IGroupState state, SessionInfo session, CancellationToken cancellationToken) + { + state.HandleRequest(context, state.Type, this, session, cancellationToken); + } + } +} diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/SeekGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/SeekGroupRequest.cs new file mode 100644 index 0000000000..d311bffdc4 --- /dev/null +++ b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/SeekGroupRequest.cs @@ -0,0 +1,27 @@ +using System.Threading; +using MediaBrowser.Controller.Session; +using MediaBrowser.Model.SyncPlay; + +namespace MediaBrowser.Controller.SyncPlay +{ + /// + /// Class SeekGroupRequest. + /// + public class SeekGroupRequest : IGroupPlaybackRequest + { + /// + /// Gets or sets the position ticks. + /// + /// The position ticks. + public long PositionTicks { get; set; } + + /// + public PlaybackRequestType Type { get; } = PlaybackRequestType.Seek; + + /// + public void Apply(IGroupStateContext context, IGroupState state, SessionInfo session, CancellationToken cancellationToken) + { + state.HandleRequest(context, state.Type, this, session, cancellationToken); + } + } +} diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/SetPlaylistItemGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/SetPlaylistItemGroupRequest.cs new file mode 100644 index 0000000000..0983d91292 --- /dev/null +++ b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/SetPlaylistItemGroupRequest.cs @@ -0,0 +1,27 @@ +using System.Threading; +using MediaBrowser.Controller.Session; +using MediaBrowser.Model.SyncPlay; + +namespace MediaBrowser.Controller.SyncPlay +{ + /// + /// Class SetPlaylistItemGroupRequest. + /// + public class SetPlaylistItemGroupRequest : IGroupPlaybackRequest + { + /// + /// Gets or sets the playlist identifier of the playing item. + /// + /// The playlist identifier of the playing item. + public string PlaylistItemId { get; set; } + + /// + public PlaybackRequestType Type { get; } = PlaybackRequestType.SetPlaylistItem; + + /// + public void Apply(IGroupStateContext context, IGroupState state, SessionInfo session, CancellationToken cancellationToken) + { + state.HandleRequest(context, state.Type, this, session, cancellationToken); + } + } +} diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/SetRepeatModeGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/SetRepeatModeGroupRequest.cs new file mode 100644 index 0000000000..79373ef5f5 --- /dev/null +++ b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/SetRepeatModeGroupRequest.cs @@ -0,0 +1,27 @@ +using System.Threading; +using MediaBrowser.Controller.Session; +using MediaBrowser.Model.SyncPlay; + +namespace MediaBrowser.Controller.SyncPlay +{ + /// + /// Class SetRepeatModeGroupRequest. + /// + public class SetRepeatModeGroupRequest : IGroupPlaybackRequest + { + /// + /// Gets or sets the repeat mode. + /// + /// The repeat mode. + public string Mode { get; set; } + + /// + public PlaybackRequestType Type { get; } = PlaybackRequestType.SetRepeatMode; + + /// + public void Apply(IGroupStateContext context, IGroupState state, SessionInfo session, CancellationToken cancellationToken) + { + state.HandleRequest(context, state.Type, this, session, cancellationToken); + } + } +} diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/SetShuffleModeGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/SetShuffleModeGroupRequest.cs new file mode 100644 index 0000000000..316fb49f40 --- /dev/null +++ b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/SetShuffleModeGroupRequest.cs @@ -0,0 +1,27 @@ +using System.Threading; +using MediaBrowser.Controller.Session; +using MediaBrowser.Model.SyncPlay; + +namespace MediaBrowser.Controller.SyncPlay +{ + /// + /// Class SetShuffleModeGroupRequest. + /// + public class SetShuffleModeGroupRequest : IGroupPlaybackRequest + { + /// + /// Gets or sets the shuffle mode. + /// + /// The shuffle mode. + public string Mode { get; set; } + + /// + public PlaybackRequestType Type { get; } = PlaybackRequestType.SetShuffleMode; + + /// + public void Apply(IGroupStateContext context, IGroupState state, SessionInfo session, CancellationToken cancellationToken) + { + state.HandleRequest(context, state.Type, this, session, cancellationToken); + } + } +} diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/StopGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/StopGroupRequest.cs new file mode 100644 index 0000000000..9f6f8ea63c --- /dev/null +++ b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/StopGroupRequest.cs @@ -0,0 +1,21 @@ +using System.Threading; +using MediaBrowser.Controller.Session; +using MediaBrowser.Model.SyncPlay; + +namespace MediaBrowser.Controller.SyncPlay +{ + /// + /// Class StopGroupRequest. + /// + public class StopGroupRequest : IGroupPlaybackRequest + { + /// + public PlaybackRequestType Type { get; } = PlaybackRequestType.Stop; + + /// + public void Apply(IGroupStateContext context, IGroupState state, SessionInfo session, CancellationToken cancellationToken) + { + state.HandleRequest(context, state.Type, this, session, cancellationToken); + } + } +} diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/UnpauseGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/UnpauseGroupRequest.cs new file mode 100644 index 0000000000..84a6b0a6e7 --- /dev/null +++ b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/UnpauseGroupRequest.cs @@ -0,0 +1,21 @@ +using System.Threading; +using MediaBrowser.Controller.Session; +using MediaBrowser.Model.SyncPlay; + +namespace MediaBrowser.Controller.SyncPlay +{ + /// + /// Class UnpauseGroupRequest. + /// + public class UnpauseGroupRequest : IGroupPlaybackRequest + { + /// + public PlaybackRequestType Type { get; } = PlaybackRequestType.Unpause; + + /// + public void Apply(IGroupStateContext context, IGroupState state, SessionInfo session, CancellationToken cancellationToken) + { + state.HandleRequest(context, state.Type, this, session, cancellationToken); + } + } +} diff --git a/MediaBrowser.Controller/SyncPlay/Queue/PlayQueueManager.cs b/MediaBrowser.Controller/SyncPlay/Queue/PlayQueueManager.cs index 030005abe6..8bc21a6a80 100644 --- a/MediaBrowser.Controller/SyncPlay/Queue/PlayQueueManager.cs +++ b/MediaBrowser.Controller/SyncPlay/Queue/PlayQueueManager.cs @@ -5,163 +5,96 @@ using MediaBrowser.Model.SyncPlay; namespace MediaBrowser.Controller.SyncPlay { - static class ListShuffleExtension - { - private static Random rng = new Random(); - public static void Shuffle(this IList list) - { - int n = list.Count; - while (n > 1) - { - n--; - int k = rng.Next(n + 1); - T value = list[k]; - list[k] = list[n]; - list[n] = value; - } - } - } - /// /// Class PlayQueueManager. /// public class PlayQueueManager { /// - /// Gets or sets the playing item index. + /// Placeholder index for when no item is playing. /// - /// The playing item index. - public int PlayingItemIndex { get; private set; } + /// The no-playing item index. + private const int NoPlayingItemIndex = -1; /// - /// Gets or sets the last time the queue has been changed. + /// Random number generator used to shuffle lists. /// - /// The last time the queue has been changed. - public DateTime LastChange { get; private set; } + /// The random number generator. + private readonly Random randomNumberGenerator = new Random(); /// - /// Gets the sorted playlist. + /// Initializes a new instance of the class. /// - /// The sorted playlist, or play queue of the group. - private List SortedPlaylist { get; set; } = new List(); + public PlayQueueManager() + { + Reset(); + } /// - /// Gets the shuffled playlist. + /// Gets the playing item index. /// - /// The shuffled playlist, or play queue of the group. - private List ShuffledPlaylist { get; set; } = new List(); + /// The playing item index. + public int PlayingItemIndex { get; private set; } /// - /// Gets or sets the shuffle mode. + /// Gets the last time the queue has been changed. + /// + /// The last time the queue has been changed. + public DateTime LastChange { get; private set; } + + /// + /// Gets the shuffle mode. /// /// The shuffle mode. public GroupShuffleMode ShuffleMode { get; private set; } = GroupShuffleMode.Sorted; /// - /// Gets or sets the repeat mode. + /// Gets the repeat mode. /// /// The repeat mode. public GroupRepeatMode RepeatMode { get; private set; } = GroupRepeatMode.RepeatNone; /// - /// Gets or sets the progressive identifier counter. + /// Gets or sets the sorted playlist. /// - /// The progressive identifier. - private int ProgressiveId { get; set; } = 0; - - /// - /// Placeholder index for when no item is playing. - /// - /// The no-playing item index. - private const int NoPlayingItemIndex = -1; + /// The sorted playlist, or play queue of the group. + private List SortedPlaylist { get; set; } = new List(); /// - /// Initializes a new instance of the class. + /// Gets or sets the shuffled playlist. /// - public PlayQueueManager() - { - Reset(); - } + /// The shuffled playlist, or play queue of the group. + private List ShuffledPlaylist { get; set; } = new List(); /// - /// Gets the next available identifier. + /// Gets or sets the progressive identifier counter. /// - /// The next available identifier. - private int GetNextProgressiveId() { - return ProgressiveId++; - } + /// The progressive identifier. + private int ProgressiveId { get; set; } /// - /// Creates a list from the array of items. Each item is given an unique playlist identifier. + /// Checks if an item is playing. /// - /// The list of queue items. - private List CreateQueueItemsFromArray(Guid[] items) + /// true if an item is playing; false otherwise. + public bool IsItemPlaying() { - return items.ToList() - .Select(item => new QueueItem() - { - ItemId = item, - PlaylistItemId = "syncPlayItem" + GetNextProgressiveId() - }) - .ToList(); + return PlayingItemIndex != NoPlayingItemIndex; } /// - /// Gets the current playlist, depending on the shuffle mode. + /// Gets the current playlist considering the shuffle mode. /// /// The playlist. - private List GetPlaylistAsList() + public IReadOnlyList GetPlaylist() { - if (ShuffleMode.Equals(GroupShuffleMode.Shuffle)) - { - return ShuffledPlaylist; - } - else - { - return SortedPlaylist; - } - } - - /// - /// Gets the current playing item, depending on the shuffle mode. - /// - /// The playing item. - private QueueItem GetPlayingItem() - { - if (PlayingItemIndex == NoPlayingItemIndex) - { - return null; - } - else if (ShuffleMode.Equals(GroupShuffleMode.Shuffle)) - { - return ShuffledPlaylist[PlayingItemIndex]; - } - else - { - return SortedPlaylist[PlayingItemIndex]; - } - } - - /// - /// Gets the current playlist as an array, depending on the shuffle mode. - /// - /// The array of items in the playlist. - public QueueItem[] GetPlaylist() { - if (ShuffleMode.Equals(GroupShuffleMode.Shuffle)) - { - return ShuffledPlaylist.ToArray(); - } - else - { - return SortedPlaylist.ToArray(); - } + return GetPlaylistInternal(); } /// /// Sets a new playlist. Playing item is reset. /// /// The new items of the playlist. - public void SetPlaylist(Guid[] items) + public void SetPlaylist(IEnumerable items) { SortedPlaylist.Clear(); ShuffledPlaylist.Clear(); @@ -170,7 +103,7 @@ namespace MediaBrowser.Controller.SyncPlay if (ShuffleMode.Equals(GroupShuffleMode.Shuffle)) { ShuffledPlaylist = SortedPlaylist.ToList(); - ShuffledPlaylist.Shuffle(); + Shuffle(ShuffledPlaylist); } PlayingItemIndex = NoPlayingItemIndex; @@ -181,7 +114,7 @@ namespace MediaBrowser.Controller.SyncPlay /// Appends new items to the playlist. The specified order is mantained. /// /// The items to add to the playlist. - public void Queue(Guid[] items) + public void Queue(IEnumerable items) { var newItems = CreateQueueItemsFromArray(items); @@ -195,13 +128,14 @@ namespace MediaBrowser.Controller.SyncPlay } /// - /// Shuffles the playlist. Shuffle mode is changed. + /// Shuffles the playlist. Shuffle mode is changed. The playlist gets re-shuffled if already shuffled. /// public void ShufflePlaylist() { - if (PlayingItemIndex == NoPlayingItemIndex) { + if (PlayingItemIndex == NoPlayingItemIndex) + { ShuffledPlaylist = SortedPlaylist.ToList(); - ShuffledPlaylist.Shuffle(); + Shuffle(ShuffledPlaylist); } else if (ShuffleMode.Equals(GroupShuffleMode.Sorted)) { @@ -209,7 +143,7 @@ namespace MediaBrowser.Controller.SyncPlay var playingItem = SortedPlaylist[PlayingItemIndex]; ShuffledPlaylist = SortedPlaylist.ToList(); ShuffledPlaylist.RemoveAt(PlayingItemIndex); - ShuffledPlaylist.Shuffle(); + Shuffle(ShuffledPlaylist); ShuffledPlaylist = ShuffledPlaylist.Prepend(playingItem).ToList(); PlayingItemIndex = 0; } @@ -218,7 +152,7 @@ namespace MediaBrowser.Controller.SyncPlay // Re-shuffle playlist. var playingItem = ShuffledPlaylist[PlayingItemIndex]; ShuffledPlaylist.RemoveAt(PlayingItemIndex); - ShuffledPlaylist.Shuffle(); + Shuffle(ShuffledPlaylist); ShuffledPlaylist = ShuffledPlaylist.Prepend(playingItem).ToList(); PlayingItemIndex = 0; } @@ -262,6 +196,7 @@ namespace MediaBrowser.Controller.SyncPlay { ShuffledPlaylist.Add(playingItem); } + PlayingItemIndex = 0; } else @@ -274,7 +209,7 @@ namespace MediaBrowser.Controller.SyncPlay /// Adds new items to the playlist right after the playing item. The specified order is mantained. /// /// The items to add to the playlist. - public void QueueNext(Guid[] items) + public void QueueNext(IEnumerable items) { var newItems = CreateQueueItemsFromArray(items); @@ -334,8 +269,18 @@ namespace MediaBrowser.Controller.SyncPlay /// The new playing item identifier. public void SetPlayingItemById(Guid itemId) { - var itemIds = GetPlaylistAsList().Select(queueItem => queueItem.ItemId).ToList(); - PlayingItemIndex = itemIds.IndexOf(itemId); + PlayingItemIndex = NoPlayingItemIndex; + + var playlist = GetPlaylistInternal(); + foreach (var item in playlist) + { + if (item.ItemId.Equals(itemId)) + { + PlayingItemIndex = playlist.IndexOf(item); + break; + } + } + LastChange = DateTime.UtcNow; } @@ -346,8 +291,18 @@ namespace MediaBrowser.Controller.SyncPlay /// true if playing item has been set; false if item is not in the playlist. public bool SetPlayingItemByPlaylistId(string playlistItemId) { - var playlistIds = GetPlaylistAsList().Select(queueItem => queueItem.PlaylistItemId).ToList(); - PlayingItemIndex = playlistIds.IndexOf(playlistItemId); + PlayingItemIndex = NoPlayingItemIndex; + + var playlist = GetPlaylistInternal(); + foreach (var item in playlist) + { + if (item.PlaylistItemId.Equals(playlistItemId, StringComparison.OrdinalIgnoreCase)) + { + PlayingItemIndex = playlist.IndexOf(item); + break; + } + } + LastChange = DateTime.UtcNow; return PlayingItemIndex != NoPlayingItemIndex; } @@ -358,8 +313,8 @@ namespace MediaBrowser.Controller.SyncPlay /// The new playing item index. public void SetPlayingItemByIndex(int playlistIndex) { - var list = GetPlaylistAsList(); - if (playlistIndex < 0 || playlistIndex > list.Count()) + var playlist = GetPlaylistInternal(); + if (playlistIndex < 0 || playlistIndex > playlist.Count) { PlayingItemIndex = NoPlayingItemIndex; } @@ -376,7 +331,7 @@ namespace MediaBrowser.Controller.SyncPlay /// /// The items to remove. /// true if playing item got removed; false otherwise. - public bool RemoveFromPlaylist(string[] playlistItemIds) + public bool RemoveFromPlaylist(IEnumerable playlistItemIds) { var playingItem = GetPlayingItem(); var playlistItemIdsList = playlistItemIds.ToList(); @@ -396,7 +351,7 @@ namespace MediaBrowser.Controller.SyncPlay { // Was first element, picking next if available. // Default to no playing item otherwise. - PlayingItemIndex = SortedPlaylist.Count() > 0 ? 0 : NoPlayingItemIndex; + PlayingItemIndex = SortedPlaylist.Count > 0 ? 0 : NoPlayingItemIndex; } return true; @@ -422,24 +377,32 @@ namespace MediaBrowser.Controller.SyncPlay /// true if the item has been moved; false otherwise. public bool MovePlaylistItem(string playlistItemId, int newIndex) { - var list = GetPlaylistAsList(); + var playlist = GetPlaylistInternal(); var playingItem = GetPlayingItem(); - var playlistIds = list.Select(queueItem => queueItem.PlaylistItemId).ToList(); - var oldIndex = playlistIds.IndexOf(playlistItemId); + var oldIndex = -1; + foreach (var item in playlist) + { + if (item.PlaylistItemId.Equals(playlistItemId, StringComparison.OrdinalIgnoreCase)) + { + oldIndex = playlist.IndexOf(item); + break; + } + } + if (oldIndex < 0) { return false; } - var queueItem = list[oldIndex]; - list.RemoveAt(oldIndex); - newIndex = Math.Min(newIndex, list.Count()); + var queueItem = playlist[oldIndex]; + playlist.RemoveAt(oldIndex); + newIndex = Math.Min(newIndex, playlist.Count); newIndex = Math.Max(newIndex, 0); - list.Insert(newIndex, queueItem); + playlist.Insert(newIndex, queueItem); LastChange = DateTime.UtcNow; - PlayingItemIndex = list.IndexOf(playingItem); + PlayingItemIndex = playlist.IndexOf(playingItem); return true; } @@ -505,7 +468,7 @@ namespace MediaBrowser.Controller.SyncPlay public QueueItem GetNextItemPlaylistId() { int newIndex; - var playlist = GetPlaylistAsList(); + var playlist = GetPlaylistInternal(); switch (RepeatMode) { @@ -514,17 +477,18 @@ namespace MediaBrowser.Controller.SyncPlay break; case GroupRepeatMode.RepeatAll: newIndex = PlayingItemIndex + 1; - if (newIndex >= playlist.Count()) + if (newIndex >= playlist.Count) { newIndex = 0; } + break; default: newIndex = PlayingItemIndex + 1; break; } - if (newIndex < 0 || newIndex >= playlist.Count()) + if (newIndex < 0 || newIndex >= playlist.Count) { return null; } @@ -545,7 +509,7 @@ namespace MediaBrowser.Controller.SyncPlay } PlayingItemIndex++; - if (PlayingItemIndex >= SortedPlaylist.Count()) + if (PlayingItemIndex >= SortedPlaylist.Count) { if (RepeatMode.Equals(GroupRepeatMode.RepeatAll)) { @@ -579,7 +543,7 @@ namespace MediaBrowser.Controller.SyncPlay { if (RepeatMode.Equals(GroupRepeatMode.RepeatAll)) { - PlayingItemIndex = SortedPlaylist.Count() - 1; + PlayingItemIndex = SortedPlaylist.Count - 1; } else { @@ -591,5 +555,86 @@ namespace MediaBrowser.Controller.SyncPlay LastChange = DateTime.UtcNow; return true; } + + /// + /// Shuffles a given list. + /// + /// The list to shuffle. + private void Shuffle(IList list) + { + int n = list.Count; + while (n > 1) + { + n--; + int k = randomNumberGenerator.Next(n + 1); + T value = list[k]; + list[k] = list[n]; + list[n] = value; + } + } + + /// + /// Gets the next available identifier. + /// + /// The next available identifier. + private int GetNextProgressiveId() + { + return ProgressiveId++; + } + + /// + /// Creates a list from the array of items. Each item is given an unique playlist identifier. + /// + /// The list of queue items. + private List CreateQueueItemsFromArray(IEnumerable items) + { + var list = new List(); + foreach (var item in items) + { + list.Add(new QueueItem() + { + ItemId = item, + PlaylistItemId = "syncPlayItem" + GetNextProgressiveId() + }); + } + + return list; + } + + /// + /// Gets the current playlist considering the shuffle mode. + /// + /// The playlist. + private List GetPlaylistInternal() + { + if (ShuffleMode.Equals(GroupShuffleMode.Shuffle)) + { + return ShuffledPlaylist; + } + else + { + return SortedPlaylist; + } + } + + /// + /// Gets the current playing item, depending on the shuffle mode. + /// + /// The playing item. + private QueueItem GetPlayingItem() + { + if (PlayingItemIndex == NoPlayingItemIndex) + { + return null; + } + else if (ShuffleMode.Equals(GroupShuffleMode.Shuffle)) + { + return ShuffledPlaylist[PlayingItemIndex]; + } + else + { + return SortedPlaylist[PlayingItemIndex]; + } + } } } diff --git a/MediaBrowser.Model/SyncPlay/GroupInfoDto.cs b/MediaBrowser.Model/SyncPlay/GroupInfoDto.cs index 255f6812bd..85b9a35229 100644 --- a/MediaBrowser.Model/SyncPlay/GroupInfoDto.cs +++ b/MediaBrowser.Model/SyncPlay/GroupInfoDto.cs @@ -25,7 +25,7 @@ namespace MediaBrowser.Model.SyncPlay /// Gets or sets the group state. /// /// The group state. - public GroupState State { get; set; } + public GroupStateType State { get; set; } /// /// Gets or sets the participants. diff --git a/MediaBrowser.Model/SyncPlay/GroupState.cs b/MediaBrowser.Model/SyncPlay/GroupState.cs deleted file mode 100644 index 871634d558..0000000000 --- a/MediaBrowser.Model/SyncPlay/GroupState.cs +++ /dev/null @@ -1,25 +0,0 @@ -namespace MediaBrowser.Model.SyncPlay -{ - /// - /// Enum GroupState. - /// - public enum GroupState - { - /// - /// The group is in idle state. No media is playing. - /// - Idle, - /// - /// The group is in wating state. Playback is paused. Will start playing when users are ready. - /// - Waiting, - /// - /// The group is in paused state. Playback is paused. Will resume on play command. - /// - Paused, - /// - /// The group is in playing state. Playback is advancing. - /// - Playing - } -} diff --git a/MediaBrowser.Model/SyncPlay/GroupStateType.cs b/MediaBrowser.Model/SyncPlay/GroupStateType.cs new file mode 100644 index 0000000000..341859b306 --- /dev/null +++ b/MediaBrowser.Model/SyncPlay/GroupStateType.cs @@ -0,0 +1,28 @@ +namespace MediaBrowser.Model.SyncPlay +{ + /// + /// Enum GroupState. + /// + public enum GroupStateType + { + /// + /// The group is in idle state. No media is playing. + /// + Idle, + + /// + /// The group is in wating state. Playback is paused. Will start playing when users are ready. + /// + Waiting, + + /// + /// The group is in paused state. Playback is paused. Will resume on play command. + /// + Paused, + + /// + /// The group is in playing state. Playback is advancing. + /// + Playing + } +} diff --git a/MediaBrowser.Model/SyncPlay/GroupStateUpdate.cs b/MediaBrowser.Model/SyncPlay/GroupStateUpdate.cs index 7c7b267e6f..532b5a56f4 100644 --- a/MediaBrowser.Model/SyncPlay/GroupStateUpdate.cs +++ b/MediaBrowser.Model/SyncPlay/GroupStateUpdate.cs @@ -1,5 +1,3 @@ -#nullable disable - namespace MediaBrowser.Model.SyncPlay { /// @@ -11,7 +9,7 @@ namespace MediaBrowser.Model.SyncPlay /// Gets or sets the state of the group. /// /// The state of the group. - public GroupState State { get; set; } + public GroupStateType State { get; set; } /// /// Gets or sets the reason of the state change. diff --git a/MediaBrowser.Model/SyncPlay/GroupUpdate.cs b/MediaBrowser.Model/SyncPlay/GroupUpdate.cs index 8c7208211c..12d6058ac3 100644 --- a/MediaBrowser.Model/SyncPlay/GroupUpdate.cs +++ b/MediaBrowser.Model/SyncPlay/GroupUpdate.cs @@ -5,6 +5,7 @@ namespace MediaBrowser.Model.SyncPlay /// /// Class GroupUpdate. /// + /// The type of the data of the message. public class GroupUpdate { /// diff --git a/MediaBrowser.Model/SyncPlay/PlayQueueUpdate.cs b/MediaBrowser.Model/SyncPlay/PlayQueueUpdate.cs index 5e2740a892..575597e62d 100644 --- a/MediaBrowser.Model/SyncPlay/PlayQueueUpdate.cs +++ b/MediaBrowser.Model/SyncPlay/PlayQueueUpdate.cs @@ -1,5 +1,7 @@ #nullable disable +using System.Collections.Generic; + namespace MediaBrowser.Model.SyncPlay { /// @@ -23,7 +25,7 @@ namespace MediaBrowser.Model.SyncPlay /// Gets or sets the playlist. /// /// The playlist. - public QueueItem[] Playlist { get; set; } + public IReadOnlyList Playlist { get; set; } /// /// Gets or sets the playing item index in the playlist. diff --git a/MediaBrowser.Model/SyncPlay/PlaybackRequestType.cs b/MediaBrowser.Model/SyncPlay/PlaybackRequestType.cs index 0d0f48ea97..4809dc44f8 100644 --- a/MediaBrowser.Model/SyncPlay/PlaybackRequestType.cs +++ b/MediaBrowser.Model/SyncPlay/PlaybackRequestType.cs @@ -69,6 +69,7 @@ namespace MediaBrowser.Model.SyncPlay /// A user is requesting previous track in playlist. /// PreviousTrack = 12, + /// /// A user is setting the repeat mode. /// -- cgit v1.2.3 From 83333e1fe8ed35f73fafdc200a4bf39be7d80f1b Mon Sep 17 00:00:00 2001 From: Ionut Andrei Oanca Date: Sat, 14 Nov 2020 17:07:52 +0100 Subject: Replace foreach loop with FindIndex --- .../SyncPlay/Queue/PlayQueueManager.cs | 36 +++------------------- 1 file changed, 4 insertions(+), 32 deletions(-) (limited to 'MediaBrowser.Controller/SyncPlay/Queue') diff --git a/MediaBrowser.Controller/SyncPlay/Queue/PlayQueueManager.cs b/MediaBrowser.Controller/SyncPlay/Queue/PlayQueueManager.cs index 8bc21a6a80..821a6314bd 100644 --- a/MediaBrowser.Controller/SyncPlay/Queue/PlayQueueManager.cs +++ b/MediaBrowser.Controller/SyncPlay/Queue/PlayQueueManager.cs @@ -269,18 +269,8 @@ namespace MediaBrowser.Controller.SyncPlay /// The new playing item identifier. public void SetPlayingItemById(Guid itemId) { - PlayingItemIndex = NoPlayingItemIndex; - var playlist = GetPlaylistInternal(); - foreach (var item in playlist) - { - if (item.ItemId.Equals(itemId)) - { - PlayingItemIndex = playlist.IndexOf(item); - break; - } - } - + PlayingItemIndex = playlist.FindIndex(item => item.ItemId.Equals(itemId)); LastChange = DateTime.UtcNow; } @@ -291,19 +281,10 @@ namespace MediaBrowser.Controller.SyncPlay /// true if playing item has been set; false if item is not in the playlist. public bool SetPlayingItemByPlaylistId(string playlistItemId) { - PlayingItemIndex = NoPlayingItemIndex; - var playlist = GetPlaylistInternal(); - foreach (var item in playlist) - { - if (item.PlaylistItemId.Equals(playlistItemId, StringComparison.OrdinalIgnoreCase)) - { - PlayingItemIndex = playlist.IndexOf(item); - break; - } - } - + PlayingItemIndex = playlist.FindIndex(item => item.PlaylistItemId.Equals(playlistItemId, StringComparison.OrdinalIgnoreCase)); LastChange = DateTime.UtcNow; + return PlayingItemIndex != NoPlayingItemIndex; } @@ -380,16 +361,7 @@ namespace MediaBrowser.Controller.SyncPlay var playlist = GetPlaylistInternal(); var playingItem = GetPlayingItem(); - var oldIndex = -1; - foreach (var item in playlist) - { - if (item.PlaylistItemId.Equals(playlistItemId, StringComparison.OrdinalIgnoreCase)) - { - oldIndex = playlist.IndexOf(item); - break; - } - } - + var oldIndex = playlist.FindIndex(item => item.PlaylistItemId.Equals(playlistItemId, StringComparison.OrdinalIgnoreCase)); if (oldIndex < 0) { return false; -- cgit v1.2.3 From 5d77f422f0e4998130f1defebd08e053188a1a25 Mon Sep 17 00:00:00 2001 From: Ionut Andrei Oanca Date: Sat, 14 Nov 2020 23:40:01 +0100 Subject: Hide some property setters, init null values, update namespaces --- .../SyncPlay/GroupController.cs | 49 +++--------- Jellyfin.Api/Controllers/SyncPlayController.cs | 93 +++++----------------- .../SyncPlay/GroupStates/AbstractGroupState.cs | 10 ++- .../SyncPlay/GroupStates/IdleGroupState.cs | 3 +- .../SyncPlay/GroupStates/PausedGroupState.cs | 3 +- .../SyncPlay/GroupStates/PlayingGroupState.cs | 3 +- .../SyncPlay/GroupStates/WaitingGroupState.cs | 6 +- .../SyncPlay/IGroupController.cs | 1 + MediaBrowser.Controller/SyncPlay/IGroupState.cs | 1 + .../SyncPlay/IGroupStateContext.cs | 14 +--- .../PlaybackRequests/BufferGroupRequest.cs | 33 +++++--- .../PlaybackRequests/IgnoreWaitGroupRequest.cs | 15 +++- .../MovePlaylistItemGroupRequest.cs | 21 +++-- .../PlaybackRequests/NextTrackGroupRequest.cs | 15 +++- .../SyncPlay/PlaybackRequests/PauseGroupRequest.cs | 2 +- .../SyncPlay/PlaybackRequests/PingGroupRequest.cs | 15 +++- .../SyncPlay/PlaybackRequests/PlayGroupRequest.cs | 29 +++++-- .../PlaybackRequests/PreviousTrackGroupRequest.cs | 15 +++- .../SyncPlay/PlaybackRequests/QueueGroupRequest.cs | 27 +++++-- .../SyncPlay/PlaybackRequests/ReadyGroupRequest.cs | 33 +++++--- .../RemoveFromPlaylistGroupRequest.cs | 15 +++- .../SyncPlay/PlaybackRequests/SeekGroupRequest.cs | 15 +++- .../SetPlaylistItemGroupRequest.cs | 15 +++- .../PlaybackRequests/SetRepeatModeGroupRequest.cs | 15 +++- .../PlaybackRequests/SetShuffleModeGroupRequest.cs | 15 +++- .../SyncPlay/PlaybackRequests/StopGroupRequest.cs | 2 +- .../PlaybackRequests/UnpauseGroupRequest.cs | 2 +- .../SyncPlay/Queue/PlayQueueManager.cs | 9 +-- MediaBrowser.Model/SyncPlay/GroupInfoDto.cs | 15 +++- MediaBrowser.Model/SyncPlay/GroupQueueMode.cs | 18 +++++ MediaBrowser.Model/SyncPlay/GroupRequestType.cs | 10 +-- MediaBrowser.Model/SyncPlay/GroupStateType.cs | 8 +- MediaBrowser.Model/SyncPlay/NewGroupRequest.cs | 10 ++- MediaBrowser.Model/SyncPlay/PlayQueueUpdate.cs | 13 ++- .../SyncPlay/PlayQueueUpdateReason.cs | 4 +- MediaBrowser.Model/SyncPlay/QueueItem.cs | 21 +++-- MediaBrowser.Model/SyncPlay/SendCommand.cs | 15 +++- 37 files changed, 363 insertions(+), 227 deletions(-) create mode 100644 MediaBrowser.Model/SyncPlay/GroupQueueMode.cs (limited to 'MediaBrowser.Controller/SyncPlay/Queue') diff --git a/Emby.Server.Implementations/SyncPlay/GroupController.cs b/Emby.Server.Implementations/SyncPlay/GroupController.cs index 5447aad5dd..a0d951b3e6 100644 --- a/Emby.Server.Implementations/SyncPlay/GroupController.cs +++ b/Emby.Server.Implementations/SyncPlay/GroupController.cs @@ -10,6 +10,8 @@ using MediaBrowser.Controller.Entities; using MediaBrowser.Controller.Library; using MediaBrowser.Controller.Session; using MediaBrowser.Controller.SyncPlay; +using MediaBrowser.Controller.SyncPlay.GroupStates; +using MediaBrowser.Controller.SyncPlay.Queue; using MediaBrowser.Model.SyncPlay; using Microsoft.Extensions.Logging; @@ -358,7 +360,7 @@ namespace Emby.Server.Implementations.SyncPlay GroupName = GroupName, State = _state.Type, Participants = Participants.Values.Select(session => session.Session.UserName).Distinct().ToList(), - LastUpdatedAt = DateToUTCString(DateTime.UtcNow) + LastUpdatedAt = DateTime.UtcNow }; } @@ -422,8 +424,8 @@ namespace Emby.Server.Implementations.SyncPlay PlaylistItemId = PlayQueue.GetPlayingItemPlaylistId(), PositionTicks = PositionTicks, Command = type, - When = DateToUTCString(LastActivity), - EmittedAt = DateToUTCString(DateTime.UtcNow) + When = LastActivity, + EmittedAt = DateTime.UtcNow }; } @@ -438,12 +440,6 @@ namespace Emby.Server.Implementations.SyncPlay }; } - /// - public string DateToUTCString(DateTime dateTime) - { - return dateTime.ToUniversalTime().ToString("o", CultureInfo.InvariantCulture); - } - /// public long SanitizePositionTicks(long? positionTicks) { @@ -580,7 +576,7 @@ namespace Emby.Server.Implementations.SyncPlay } /// - public bool AddToPlayQueue(IEnumerable newItems, string mode) + public bool AddToPlayQueue(IEnumerable newItems, GroupQueueMode mode) { // Ignore on empty list. if (!newItems.Any()) @@ -594,7 +590,7 @@ namespace Emby.Server.Implementations.SyncPlay return false; } - if (mode.Equals("next", StringComparison.OrdinalIgnoreCase)) + if (mode.Equals(GroupQueueMode.QueueNext)) { PlayQueue.QueueNext(newItems); } @@ -648,36 +644,15 @@ namespace Emby.Server.Implementations.SyncPlay } /// - public void SetRepeatMode(string mode) + public void SetRepeatMode(GroupRepeatMode mode) { - switch (mode) - { - case "RepeatOne": - PlayQueue.SetRepeatMode(GroupRepeatMode.RepeatOne); - break; - case "RepeatAll": - PlayQueue.SetRepeatMode(GroupRepeatMode.RepeatAll); - break; - default: - // On unknown values, default to repeat none. - PlayQueue.SetRepeatMode(GroupRepeatMode.RepeatNone); - break; - } + PlayQueue.SetRepeatMode(mode); } /// - public void SetShuffleMode(string mode) + public void SetShuffleMode(GroupShuffleMode mode) { - switch (mode) - { - case "Shuffle": - PlayQueue.SetShuffleMode(GroupShuffleMode.Shuffle); - break; - default: - // On unknown values, default to sorted playlist. - PlayQueue.SetShuffleMode(GroupShuffleMode.Sorted); - break; - } + PlayQueue.SetShuffleMode(mode); } /// @@ -701,7 +676,7 @@ namespace Emby.Server.Implementations.SyncPlay return new PlayQueueUpdate() { Reason = reason, - LastUpdate = DateToUTCString(PlayQueue.LastChange), + LastUpdate = PlayQueue.LastChange, Playlist = PlayQueue.GetPlaylist(), PlayingItemIndex = PlayQueue.PlayingItemIndex, StartPositionTicks = startPositionTicks, diff --git a/Jellyfin.Api/Controllers/SyncPlayController.cs b/Jellyfin.Api/Controllers/SyncPlayController.cs index 6bd78179b5..9085a71c88 100644 --- a/Jellyfin.Api/Controllers/SyncPlayController.cs +++ b/Jellyfin.Api/Controllers/SyncPlayController.cs @@ -7,6 +7,7 @@ using Jellyfin.Api.Helpers; using MediaBrowser.Controller.Net; using MediaBrowser.Controller.Session; using MediaBrowser.Controller.SyncPlay; +using MediaBrowser.Controller.SyncPlay.PlaybackRequests; using MediaBrowser.Model.SyncPlay; using Microsoft.AspNetCore.Authorization; using Microsoft.AspNetCore.Http; @@ -118,17 +119,12 @@ namespace Jellyfin.Api.Controllers [HttpPost("Play")] [ProducesResponseType(StatusCodes.Status204NoContent)] public ActionResult SyncPlayPlay( - [FromQuery, Required] string playingQueue, + [FromQuery, Required] Guid[] playingQueue, [FromQuery, Required] int playingItemPosition, [FromQuery, Required] long startPositionTicks) { var currentSession = RequestHelpers.GetSession(_sessionManager, _authorizationContext, Request); - var syncPlayRequest = new PlayGroupRequest() - { - PlayingItemPosition = playingItemPosition, - StartPositionTicks = startPositionTicks - }; - syncPlayRequest.PlayingQueue.AddRange(RequestHelpers.GetGuids(playingQueue)); + var syncPlayRequest = new PlayGroupRequest(playingQueue, playingItemPosition, startPositionTicks); _syncPlayManager.HandleRequest(currentSession, syncPlayRequest, CancellationToken.None); return NoContent(); } @@ -145,10 +141,7 @@ namespace Jellyfin.Api.Controllers [FromQuery, Required] string playlistItemId) { var currentSession = RequestHelpers.GetSession(_sessionManager, _authorizationContext, Request); - var syncPlayRequest = new SetPlaylistItemGroupRequest() - { - PlaylistItemId = playlistItemId - }; + var syncPlayRequest = new SetPlaylistItemGroupRequest(playlistItemId); _syncPlayManager.HandleRequest(currentSession, syncPlayRequest, CancellationToken.None); return NoContent(); } @@ -165,8 +158,7 @@ namespace Jellyfin.Api.Controllers [FromQuery, Required] string[] playlistItemIds) { var currentSession = RequestHelpers.GetSession(_sessionManager, _authorizationContext, Request); - var syncPlayRequest = new RemoveFromPlaylistGroupRequest(); - syncPlayRequest.PlaylistItemIds.AddRange(playlistItemIds); + var syncPlayRequest = new RemoveFromPlaylistGroupRequest(playlistItemIds); _syncPlayManager.HandleRequest(currentSession, syncPlayRequest, CancellationToken.None); return NoContent(); } @@ -185,11 +177,7 @@ namespace Jellyfin.Api.Controllers [FromQuery, Required] int newIndex) { var currentSession = RequestHelpers.GetSession(_sessionManager, _authorizationContext, Request); - var syncPlayRequest = new MovePlaylistItemGroupRequest() - { - PlaylistItemId = playlistItemId, - NewIndex = newIndex - }; + var syncPlayRequest = new MovePlaylistItemGroupRequest(playlistItemId, newIndex); _syncPlayManager.HandleRequest(currentSession, syncPlayRequest, CancellationToken.None); return NoContent(); } @@ -197,22 +185,18 @@ namespace Jellyfin.Api.Controllers /// /// Request to queue items to the playlist of a SyncPlay group. /// - /// The items to add. Item ids, comma delimited. - /// The mode in which to queue items. + /// The items to add. + /// The mode in which to enqueue the items. /// Queue update request sent to all group members. /// A indicating success. [HttpPost("Queue")] [ProducesResponseType(StatusCodes.Status204NoContent)] public ActionResult SyncPlayQueue( - [FromQuery, Required] string itemIds, - [FromQuery, Required] string mode) + [FromQuery, Required] Guid[] items, + [FromQuery, Required] GroupQueueMode mode) { var currentSession = RequestHelpers.GetSession(_sessionManager, _authorizationContext, Request); - var syncPlayRequest = new QueueGroupRequest() - { - Mode = mode - }; - syncPlayRequest.ItemIds.AddRange(RequestHelpers.GetGuids(itemIds)); + var syncPlayRequest = new QueueGroupRequest(items, mode); _syncPlayManager.HandleRequest(currentSession, syncPlayRequest, CancellationToken.None); return NoContent(); } @@ -274,10 +258,7 @@ namespace Jellyfin.Api.Controllers [FromQuery, Required] long positionTicks) { var currentSession = RequestHelpers.GetSession(_sessionManager, _authorizationContext, Request); - var syncPlayRequest = new SeekGroupRequest() - { - PositionTicks = positionTicks - }; + var syncPlayRequest = new SeekGroupRequest(positionTicks); _syncPlayManager.HandleRequest(currentSession, syncPlayRequest, CancellationToken.None); return NoContent(); } @@ -305,23 +286,11 @@ namespace Jellyfin.Api.Controllers IGroupPlaybackRequest syncPlayRequest; if (!bufferingDone) { - syncPlayRequest = new BufferGroupRequest() - { - When = when, - PositionTicks = positionTicks, - IsPlaying = isPlaying, - PlaylistItemId = playlistItemId - }; + syncPlayRequest = new BufferGroupRequest(when, positionTicks, isPlaying, playlistItemId); } else { - syncPlayRequest = new ReadyGroupRequest() - { - When = when, - PositionTicks = positionTicks, - IsPlaying = isPlaying, - PlaylistItemId = playlistItemId - }; + syncPlayRequest = new ReadyGroupRequest(when, positionTicks, isPlaying, playlistItemId); } _syncPlayManager.HandleRequest(currentSession, syncPlayRequest, CancellationToken.None); @@ -340,10 +309,7 @@ namespace Jellyfin.Api.Controllers [FromQuery, Required] bool ignoreWait) { var currentSession = RequestHelpers.GetSession(_sessionManager, _authorizationContext, Request); - var syncPlayRequest = new IgnoreWaitGroupRequest() - { - IgnoreWait = ignoreWait - }; + var syncPlayRequest = new IgnoreWaitGroupRequest(ignoreWait); _syncPlayManager.HandleRequest(currentSession, syncPlayRequest, CancellationToken.None); return NoContent(); } @@ -360,10 +326,7 @@ namespace Jellyfin.Api.Controllers [FromQuery, Required] string playlistItemId) { var currentSession = RequestHelpers.GetSession(_sessionManager, _authorizationContext, Request); - var syncPlayRequest = new NextTrackGroupRequest() - { - PlaylistItemId = playlistItemId - }; + var syncPlayRequest = new NextTrackGroupRequest(playlistItemId); _syncPlayManager.HandleRequest(currentSession, syncPlayRequest, CancellationToken.None); return NoContent(); } @@ -380,10 +343,7 @@ namespace Jellyfin.Api.Controllers [FromQuery, Required] string playlistItemId) { var currentSession = RequestHelpers.GetSession(_sessionManager, _authorizationContext, Request); - var syncPlayRequest = new PreviousTrackGroupRequest() - { - PlaylistItemId = playlistItemId - }; + var syncPlayRequest = new PreviousTrackGroupRequest(playlistItemId); _syncPlayManager.HandleRequest(currentSession, syncPlayRequest, CancellationToken.None); return NoContent(); } @@ -397,13 +357,10 @@ namespace Jellyfin.Api.Controllers [HttpPost("SetRepeatMode")] [ProducesResponseType(StatusCodes.Status204NoContent)] public ActionResult SyncPlaySetRepeatMode( - [FromQuery, Required] string mode) + [FromQuery, Required] GroupRepeatMode mode) { var currentSession = RequestHelpers.GetSession(_sessionManager, _authorizationContext, Request); - var syncPlayRequest = new SetRepeatModeGroupRequest() - { - Mode = mode - }; + var syncPlayRequest = new SetRepeatModeGroupRequest(mode); _syncPlayManager.HandleRequest(currentSession, syncPlayRequest, CancellationToken.None); return NoContent(); } @@ -417,13 +374,10 @@ namespace Jellyfin.Api.Controllers [HttpPost("SetShuffleMode")] [ProducesResponseType(StatusCodes.Status204NoContent)] public ActionResult SyncPlaySetShuffleMode( - [FromQuery, Required] string mode) + [FromQuery, Required] GroupShuffleMode mode) { var currentSession = RequestHelpers.GetSession(_sessionManager, _authorizationContext, Request); - var syncPlayRequest = new SetShuffleModeGroupRequest() - { - Mode = mode - }; + var syncPlayRequest = new SetShuffleModeGroupRequest(mode); _syncPlayManager.HandleRequest(currentSession, syncPlayRequest, CancellationToken.None); return NoContent(); } @@ -440,10 +394,7 @@ namespace Jellyfin.Api.Controllers [FromQuery, Required] double ping) { var currentSession = RequestHelpers.GetSession(_sessionManager, _authorizationContext, Request); - var syncPlayRequest = new PingGroupRequest() - { - Ping = Convert.ToInt64(ping) - }; + var syncPlayRequest = new PingGroupRequest(Convert.ToInt64(ping)); _syncPlayManager.HandleRequest(currentSession, syncPlayRequest, CancellationToken.None); return NoContent(); } diff --git a/MediaBrowser.Controller/SyncPlay/GroupStates/AbstractGroupState.cs b/MediaBrowser.Controller/SyncPlay/GroupStates/AbstractGroupState.cs index 829ef2bbab..bc2e223802 100644 --- a/MediaBrowser.Controller/SyncPlay/GroupStates/AbstractGroupState.cs +++ b/MediaBrowser.Controller/SyncPlay/GroupStates/AbstractGroupState.cs @@ -1,10 +1,10 @@ -using System; using System.Threading; using MediaBrowser.Controller.Session; +using MediaBrowser.Controller.SyncPlay.PlaybackRequests; using MediaBrowser.Model.SyncPlay; using Microsoft.Extensions.Logging; -namespace MediaBrowser.Controller.SyncPlay +namespace MediaBrowser.Controller.SyncPlay.GroupStates { /// /// Class AbstractGroupState. @@ -104,7 +104,11 @@ namespace MediaBrowser.Controller.SyncPlay return; } - var reason = request.Mode.Equals("next", StringComparison.OrdinalIgnoreCase) ? PlayQueueUpdateReason.QueueNext : PlayQueueUpdateReason.Queue; + var reason = request.Mode switch + { + GroupQueueMode.QueueNext => PlayQueueUpdateReason.QueueNext, + _ => PlayQueueUpdateReason.Queue + }; var playQueueUpdate = context.GetPlayQueueUpdate(reason); var update = context.NewSyncPlayGroupUpdate(GroupUpdateType.PlayQueue, playQueueUpdate); context.SendGroupUpdate(session, SyncPlayBroadcastType.AllGroup, update, cancellationToken); diff --git a/MediaBrowser.Controller/SyncPlay/GroupStates/IdleGroupState.cs b/MediaBrowser.Controller/SyncPlay/GroupStates/IdleGroupState.cs index d9350cc9b9..660afb607d 100644 --- a/MediaBrowser.Controller/SyncPlay/GroupStates/IdleGroupState.cs +++ b/MediaBrowser.Controller/SyncPlay/GroupStates/IdleGroupState.cs @@ -1,9 +1,10 @@ using System.Threading; using MediaBrowser.Controller.Session; +using MediaBrowser.Controller.SyncPlay.PlaybackRequests; using MediaBrowser.Model.SyncPlay; using Microsoft.Extensions.Logging; -namespace MediaBrowser.Controller.SyncPlay +namespace MediaBrowser.Controller.SyncPlay.GroupStates { /// /// Class IdleGroupState. diff --git a/MediaBrowser.Controller/SyncPlay/GroupStates/PausedGroupState.cs b/MediaBrowser.Controller/SyncPlay/GroupStates/PausedGroupState.cs index 5ae4786057..29942898e6 100644 --- a/MediaBrowser.Controller/SyncPlay/GroupStates/PausedGroupState.cs +++ b/MediaBrowser.Controller/SyncPlay/GroupStates/PausedGroupState.cs @@ -1,10 +1,11 @@ using System; using System.Threading; using MediaBrowser.Controller.Session; +using MediaBrowser.Controller.SyncPlay.PlaybackRequests; using MediaBrowser.Model.SyncPlay; using Microsoft.Extensions.Logging; -namespace MediaBrowser.Controller.SyncPlay +namespace MediaBrowser.Controller.SyncPlay.GroupStates { /// /// Class PausedGroupState. diff --git a/MediaBrowser.Controller/SyncPlay/GroupStates/PlayingGroupState.cs b/MediaBrowser.Controller/SyncPlay/GroupStates/PlayingGroupState.cs index 394c64e511..c5d73dedb8 100644 --- a/MediaBrowser.Controller/SyncPlay/GroupStates/PlayingGroupState.cs +++ b/MediaBrowser.Controller/SyncPlay/GroupStates/PlayingGroupState.cs @@ -1,10 +1,11 @@ using System; using System.Threading; using MediaBrowser.Controller.Session; +using MediaBrowser.Controller.SyncPlay.PlaybackRequests; using MediaBrowser.Model.SyncPlay; using Microsoft.Extensions.Logging; -namespace MediaBrowser.Controller.SyncPlay +namespace MediaBrowser.Controller.SyncPlay.GroupStates { /// /// Class PlayingGroupState. diff --git a/MediaBrowser.Controller/SyncPlay/GroupStates/WaitingGroupState.cs b/MediaBrowser.Controller/SyncPlay/GroupStates/WaitingGroupState.cs index c78077b357..78318dd94d 100644 --- a/MediaBrowser.Controller/SyncPlay/GroupStates/WaitingGroupState.cs +++ b/MediaBrowser.Controller/SyncPlay/GroupStates/WaitingGroupState.cs @@ -1,10 +1,11 @@ using System; using System.Threading; using MediaBrowser.Controller.Session; +using MediaBrowser.Controller.SyncPlay.PlaybackRequests; using MediaBrowser.Model.SyncPlay; using Microsoft.Extensions.Logging; -namespace MediaBrowser.Controller.SyncPlay +namespace MediaBrowser.Controller.SyncPlay.GroupStates { /// /// Class WaitingGroupState. @@ -464,8 +465,7 @@ namespace MediaBrowser.Controller.SyncPlay { // Others are still buffering, tell this client to pause when ready. var command = context.NewSyncPlayCommand(SendCommandType.Pause); - var pauseAtTime = currentTime.AddTicks(delayTicks); - command.When = context.DateToUTCString(pauseAtTime); + command.When = currentTime.AddTicks(delayTicks); context.SendCommand(session, SyncPlayBroadcastType.CurrentSession, command, cancellationToken); Logger.LogInformation("HandleRequest: {0} in group {1}, others still buffering, {2} will pause when ready in {3} seconds.", request.Type, context.GroupId.ToString(), session.Id, TimeSpan.FromTicks(delayTicks).TotalSeconds); diff --git a/MediaBrowser.Controller/SyncPlay/IGroupController.cs b/MediaBrowser.Controller/SyncPlay/IGroupController.cs index 038233fdd3..aa8bb9eaea 100644 --- a/MediaBrowser.Controller/SyncPlay/IGroupController.cs +++ b/MediaBrowser.Controller/SyncPlay/IGroupController.cs @@ -2,6 +2,7 @@ using System; using System.Threading; using Jellyfin.Data.Entities; using MediaBrowser.Controller.Session; +using MediaBrowser.Controller.SyncPlay.Queue; using MediaBrowser.Model.SyncPlay; namespace MediaBrowser.Controller.SyncPlay diff --git a/MediaBrowser.Controller/SyncPlay/IGroupState.cs b/MediaBrowser.Controller/SyncPlay/IGroupState.cs index f6ebe2a58d..0028823b4e 100644 --- a/MediaBrowser.Controller/SyncPlay/IGroupState.cs +++ b/MediaBrowser.Controller/SyncPlay/IGroupState.cs @@ -1,5 +1,6 @@ using System.Threading; using MediaBrowser.Controller.Session; +using MediaBrowser.Controller.SyncPlay.PlaybackRequests; using MediaBrowser.Model.SyncPlay; namespace MediaBrowser.Controller.SyncPlay diff --git a/MediaBrowser.Controller/SyncPlay/IGroupStateContext.cs b/MediaBrowser.Controller/SyncPlay/IGroupStateContext.cs index 2ddaae6400..3609be36b7 100644 --- a/MediaBrowser.Controller/SyncPlay/IGroupStateContext.cs +++ b/MediaBrowser.Controller/SyncPlay/IGroupStateContext.cs @@ -3,6 +3,7 @@ using System.Collections.Generic; using System.Threading; using System.Threading.Tasks; using MediaBrowser.Controller.Session; +using MediaBrowser.Controller.SyncPlay.Queue; using MediaBrowser.Model.SyncPlay; namespace MediaBrowser.Controller.SyncPlay @@ -97,13 +98,6 @@ namespace MediaBrowser.Controller.SyncPlay /// The group update. GroupUpdate NewSyncPlayGroupUpdate(GroupUpdateType type, T data); - /// - /// Converts DateTime to UTC string. - /// - /// The date to convert. - /// The UTC string. - string DateToUTCString(DateTime dateTime); - /// /// Sanitizes the PositionTicks, considers the current playing item when available. /// @@ -187,7 +181,7 @@ namespace MediaBrowser.Controller.SyncPlay /// The new items to add to the play queue. /// The mode with which the items will be added. /// true if the play queue has been changed; false if something went wrong. - bool AddToPlayQueue(IEnumerable newItems, string mode); + bool AddToPlayQueue(IEnumerable newItems, GroupQueueMode mode); /// /// Restarts current item in play queue. @@ -210,13 +204,13 @@ namespace MediaBrowser.Controller.SyncPlay /// Sets the repeat mode. /// /// The new mode. - void SetRepeatMode(string mode); + void SetRepeatMode(GroupRepeatMode mode); /// /// Sets the shuffle mode. /// /// The new mode. - void SetShuffleMode(string mode); + void SetShuffleMode(GroupShuffleMode mode); /// /// Creates a play queue update. diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/BufferGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/BufferGroupRequest.cs index b5bed89f21..a12ab96b77 100644 --- a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/BufferGroupRequest.cs +++ b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/BufferGroupRequest.cs @@ -3,7 +3,7 @@ using System.Threading; using MediaBrowser.Controller.Session; using MediaBrowser.Model.SyncPlay; -namespace MediaBrowser.Controller.SyncPlay +namespace MediaBrowser.Controller.SyncPlay.PlaybackRequests { /// /// Class BufferGroupRequest. @@ -11,28 +11,43 @@ namespace MediaBrowser.Controller.SyncPlay public class BufferGroupRequest : IGroupPlaybackRequest { /// - /// Gets or sets when the request has been made by the client. + /// Initializes a new instance of the class. + /// + /// When the request has been made, as reported by the client. + /// The position ticks. + /// Whether the client playback is unpaused. + /// The playlist item identifier of the playing item. + public BufferGroupRequest(DateTime when, long positionTicks, bool isPlaying, string playlistItemId) + { + When = when; + PositionTicks = positionTicks; + IsPlaying = isPlaying; + PlaylistItemId = playlistItemId; + } + + /// + /// Gets when the request has been made by the client. /// /// The date of the request. - public DateTime When { get; set; } + public DateTime When { get; } /// - /// Gets or sets the position ticks. + /// Gets the position ticks. /// /// The position ticks. - public long PositionTicks { get; set; } + public long PositionTicks { get; } /// - /// Gets or sets a value indicating whether the client playback is unpaused. + /// Gets a value indicating whether the client playback is unpaused. /// /// The client playback status. - public bool IsPlaying { get; set; } + public bool IsPlaying { get; } /// - /// Gets or sets the playlist item identifier of the playing item. + /// Gets the playlist item identifier of the playing item. /// /// The playlist item identifier. - public string PlaylistItemId { get; set; } + public string PlaylistItemId { get; } /// public PlaybackRequestType Type { get; } = PlaybackRequestType.Buffer; diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/IgnoreWaitGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/IgnoreWaitGroupRequest.cs index 325839f107..25034cb10b 100644 --- a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/IgnoreWaitGroupRequest.cs +++ b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/IgnoreWaitGroupRequest.cs @@ -2,7 +2,7 @@ using System.Threading; using MediaBrowser.Controller.Session; using MediaBrowser.Model.SyncPlay; -namespace MediaBrowser.Controller.SyncPlay +namespace MediaBrowser.Controller.SyncPlay.PlaybackRequests { /// /// Class IgnoreWaitGroupRequest. @@ -10,10 +10,19 @@ namespace MediaBrowser.Controller.SyncPlay public class IgnoreWaitGroupRequest : IGroupPlaybackRequest { /// - /// Gets or sets a value indicating whether the client should be ignored. + /// Initializes a new instance of the class. + /// + /// Whether the client should be ignored. + public IgnoreWaitGroupRequest(bool ignoreWait) + { + IgnoreWait = ignoreWait; + } + + /// + /// Gets a value indicating whether the client should be ignored. /// /// The client group-wait status. - public bool IgnoreWait { get; set; } + public bool IgnoreWait { get; } /// public PlaybackRequestType Type { get; } = PlaybackRequestType.IgnoreWait; diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/MovePlaylistItemGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/MovePlaylistItemGroupRequest.cs index 3c95f53d4a..a12eff8b84 100644 --- a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/MovePlaylistItemGroupRequest.cs +++ b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/MovePlaylistItemGroupRequest.cs @@ -2,7 +2,7 @@ using System.Threading; using MediaBrowser.Controller.Session; using MediaBrowser.Model.SyncPlay; -namespace MediaBrowser.Controller.SyncPlay +namespace MediaBrowser.Controller.SyncPlay.PlaybackRequests { /// /// Class MovePlaylistItemGroupRequest. @@ -10,16 +10,27 @@ namespace MediaBrowser.Controller.SyncPlay public class MovePlaylistItemGroupRequest : IGroupPlaybackRequest { /// - /// Gets or sets the playlist identifier of the item. + /// Initializes a new instance of the class. + /// + /// The playlist identifier of the item. + /// The new position. + public MovePlaylistItemGroupRequest(string playlistItemId, int newIndex) + { + PlaylistItemId = playlistItemId; + NewIndex = newIndex; + } + + /// + /// Gets the playlist identifier of the item. /// /// The playlist identifier of the item. - public string PlaylistItemId { get; set; } + public string PlaylistItemId { get; } /// - /// Gets or sets the new position. + /// Gets the new position. /// /// The new position. - public int NewIndex { get; set; } + public int NewIndex { get; } /// public PlaybackRequestType Type { get; } = PlaybackRequestType.MovePlaylistItem; diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/NextTrackGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/NextTrackGroupRequest.cs index 8636d6f4d5..f87bbc556d 100644 --- a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/NextTrackGroupRequest.cs +++ b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/NextTrackGroupRequest.cs @@ -2,7 +2,7 @@ using System.Threading; using MediaBrowser.Controller.Session; using MediaBrowser.Model.SyncPlay; -namespace MediaBrowser.Controller.SyncPlay +namespace MediaBrowser.Controller.SyncPlay.PlaybackRequests { /// /// Class NextTrackGroupRequest. @@ -10,10 +10,19 @@ namespace MediaBrowser.Controller.SyncPlay public class NextTrackGroupRequest : IGroupPlaybackRequest { /// - /// Gets or sets the playing item identifier. + /// Initializes a new instance of the class. + /// + /// The playing item identifier. + public NextTrackGroupRequest(string playlistItemId) + { + PlaylistItemId = playlistItemId; + } + + /// + /// Gets the playing item identifier. /// /// The playing item identifier. - public string PlaylistItemId { get; set; } + public string PlaylistItemId { get; } /// public PlaybackRequestType Type { get; } = PlaybackRequestType.NextTrack; diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/PauseGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/PauseGroupRequest.cs index 45bd3b15f1..0dcd1423fd 100644 --- a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/PauseGroupRequest.cs +++ b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/PauseGroupRequest.cs @@ -2,7 +2,7 @@ using System.Threading; using MediaBrowser.Controller.Session; using MediaBrowser.Model.SyncPlay; -namespace MediaBrowser.Controller.SyncPlay +namespace MediaBrowser.Controller.SyncPlay.PlaybackRequests { /// /// Class PauseGroupRequest. diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/PingGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/PingGroupRequest.cs index 9dacb79857..2528bb3e70 100644 --- a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/PingGroupRequest.cs +++ b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/PingGroupRequest.cs @@ -2,7 +2,7 @@ using System.Threading; using MediaBrowser.Controller.Session; using MediaBrowser.Model.SyncPlay; -namespace MediaBrowser.Controller.SyncPlay +namespace MediaBrowser.Controller.SyncPlay.PlaybackRequests { /// /// Class PingGroupRequest. @@ -10,10 +10,19 @@ namespace MediaBrowser.Controller.SyncPlay public class PingGroupRequest : IGroupPlaybackRequest { /// - /// Gets or sets the ping time. + /// Initializes a new instance of the class. + /// + /// The ping time. + public PingGroupRequest(long ping) + { + Ping = ping; + } + + /// + /// Gets the ping time. /// /// The ping time. - public long Ping { get; set; } + public long Ping { get; } /// public PlaybackRequestType Type { get; } = PlaybackRequestType.Ping; diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/PlayGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/PlayGroupRequest.cs index e090a882e2..306c161ed9 100644 --- a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/PlayGroupRequest.cs +++ b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/PlayGroupRequest.cs @@ -4,30 +4,45 @@ using System.Threading; using MediaBrowser.Controller.Session; using MediaBrowser.Model.SyncPlay; -namespace MediaBrowser.Controller.SyncPlay +namespace MediaBrowser.Controller.SyncPlay.PlaybackRequests { /// /// Class PlayGroupRequest. /// public class PlayGroupRequest : IGroupPlaybackRequest { + /// + /// Initializes a new instance of the class. + /// + /// The playing queue. + /// The playing item position. + /// The start position ticks. + public PlayGroupRequest(Guid[] playingQueue, int playingItemPosition, long startPositionTicks) + { + var list = new List(); + list.AddRange(playingQueue); + PlayingQueue = list; + PlayingItemPosition = playingItemPosition; + StartPositionTicks = startPositionTicks; + } + /// /// Gets the playing queue. /// /// The playing queue. - public List PlayingQueue { get; } = new List(); + public IReadOnlyList PlayingQueue { get; } /// - /// Gets or sets the playing item from the queue. + /// Gets the position of the playing item in the queue. /// - /// The playing item. - public int PlayingItemPosition { get; set; } + /// The playing item position. + public int PlayingItemPosition { get; } /// - /// Gets or sets the start position ticks. + /// Gets the start position ticks. /// /// The start position ticks. - public long StartPositionTicks { get; set; } + public long StartPositionTicks { get; } /// public PlaybackRequestType Type { get; } = PlaybackRequestType.Play; diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/PreviousTrackGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/PreviousTrackGroupRequest.cs index aca5d678e0..206fef3312 100644 --- a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/PreviousTrackGroupRequest.cs +++ b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/PreviousTrackGroupRequest.cs @@ -2,7 +2,7 @@ using System.Threading; using MediaBrowser.Controller.Session; using MediaBrowser.Model.SyncPlay; -namespace MediaBrowser.Controller.SyncPlay +namespace MediaBrowser.Controller.SyncPlay.PlaybackRequests { /// /// Class PreviousTrackGroupRequest. @@ -10,10 +10,19 @@ namespace MediaBrowser.Controller.SyncPlay public class PreviousTrackGroupRequest : IGroupPlaybackRequest { /// - /// Gets or sets the playing item identifier. + /// Initializes a new instance of the class. + /// + /// The playing item identifier. + public PreviousTrackGroupRequest(string playlistItemId) + { + PlaylistItemId = playlistItemId; + } + + /// + /// Gets the playing item identifier. /// /// The playing item identifier. - public string PlaylistItemId { get; set; } + public string PlaylistItemId { get; } /// public PlaybackRequestType Type { get; } = PlaybackRequestType.PreviousTrack; diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/QueueGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/QueueGroupRequest.cs index 82380b2098..9580b53154 100644 --- a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/QueueGroupRequest.cs +++ b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/QueueGroupRequest.cs @@ -4,7 +4,7 @@ using System.Threading; using MediaBrowser.Controller.Session; using MediaBrowser.Model.SyncPlay; -namespace MediaBrowser.Controller.SyncPlay +namespace MediaBrowser.Controller.SyncPlay.PlaybackRequests { /// /// Class QueueGroupRequest. @@ -12,16 +12,29 @@ namespace MediaBrowser.Controller.SyncPlay public class QueueGroupRequest : IGroupPlaybackRequest { /// - /// Gets the items to queue. + /// Initializes a new instance of the class. /// - /// The items to queue. - public List ItemIds { get; } = new List(); + /// The items to add to the queue. + /// The enqueue mode. + public QueueGroupRequest(Guid[] items, GroupQueueMode mode) + { + var list = new List(); + list.AddRange(items); + ItemIds = list; + Mode = mode; + } + + /// + /// Gets the items to enqueue. + /// + /// The items to enqueue. + public IReadOnlyList ItemIds { get; } /// - /// Gets or sets the mode in which to add the new items. + /// Gets the mode in which to add the new items. /// - /// The mode. - public string Mode { get; set; } + /// The enqueue mode. + public GroupQueueMode Mode { get; } /// public PlaybackRequestType Type { get; } = PlaybackRequestType.Queue; diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/ReadyGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/ReadyGroupRequest.cs index c8a2268cfb..a2b3553cee 100644 --- a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/ReadyGroupRequest.cs +++ b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/ReadyGroupRequest.cs @@ -3,7 +3,7 @@ using System.Threading; using MediaBrowser.Controller.Session; using MediaBrowser.Model.SyncPlay; -namespace MediaBrowser.Controller.SyncPlay +namespace MediaBrowser.Controller.SyncPlay.PlaybackRequests { /// /// Class ReadyGroupRequest. @@ -11,28 +11,43 @@ namespace MediaBrowser.Controller.SyncPlay public class ReadyGroupRequest : IGroupPlaybackRequest { /// - /// Gets or sets when the request has been made by the client. + /// Initializes a new instance of the class. + /// + /// When the request has been made, as reported by the client. + /// The position ticks. + /// Whether the client playback is unpaused. + /// The playlist item identifier of the playing item. + public ReadyGroupRequest(DateTime when, long positionTicks, bool isPlaying, string playlistItemId) + { + When = when; + PositionTicks = positionTicks; + IsPlaying = isPlaying; + PlaylistItemId = playlistItemId; + } + + /// + /// Gets when the request has been made by the client. /// /// The date of the request. - public DateTime When { get; set; } + public DateTime When { get; } /// - /// Gets or sets the position ticks. + /// Gets the position ticks. /// /// The position ticks. - public long PositionTicks { get; set; } + public long PositionTicks { get; } /// - /// Gets or sets a value indicating whether the client playback is unpaused. + /// Gets a value indicating whether the client playback is unpaused. /// /// The client playback status. - public bool IsPlaying { get; set; } + public bool IsPlaying { get; } /// - /// Gets or sets the playlist item identifier of the playing item. + /// Gets the playlist item identifier of the playing item. /// /// The playlist item identifier. - public string PlaylistItemId { get; set; } + public string PlaylistItemId { get; } /// public PlaybackRequestType Type { get; } = PlaybackRequestType.Ready; diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/RemoveFromPlaylistGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/RemoveFromPlaylistGroupRequest.cs index 4ead1301b6..21c602846e 100644 --- a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/RemoveFromPlaylistGroupRequest.cs +++ b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/RemoveFromPlaylistGroupRequest.cs @@ -3,18 +3,29 @@ using System.Threading; using MediaBrowser.Controller.Session; using MediaBrowser.Model.SyncPlay; -namespace MediaBrowser.Controller.SyncPlay +namespace MediaBrowser.Controller.SyncPlay.PlaybackRequests { /// /// Class RemoveFromPlaylistGroupRequest. /// public class RemoveFromPlaylistGroupRequest : IGroupPlaybackRequest { + /// + /// Initializes a new instance of the class. + /// + /// The playlist ids of the items to remove. + public RemoveFromPlaylistGroupRequest(string[] items) + { + var list = new List(); + list.AddRange(items); + PlaylistItemIds = list; + } + /// /// Gets the playlist identifiers ot the items. /// /// The playlist identifiers ot the items. - public List PlaylistItemIds { get; } = new List(); + public IReadOnlyList PlaylistItemIds { get; } /// public PlaybackRequestType Type { get; } = PlaybackRequestType.RemoveFromPlaylist; diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/SeekGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/SeekGroupRequest.cs index d311bffdc4..f7bfc19788 100644 --- a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/SeekGroupRequest.cs +++ b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/SeekGroupRequest.cs @@ -2,7 +2,7 @@ using System.Threading; using MediaBrowser.Controller.Session; using MediaBrowser.Model.SyncPlay; -namespace MediaBrowser.Controller.SyncPlay +namespace MediaBrowser.Controller.SyncPlay.PlaybackRequests { /// /// Class SeekGroupRequest. @@ -10,10 +10,19 @@ namespace MediaBrowser.Controller.SyncPlay public class SeekGroupRequest : IGroupPlaybackRequest { /// - /// Gets or sets the position ticks. + /// Initializes a new instance of the class. + /// + /// The position ticks. + public SeekGroupRequest(long positionTicks) + { + PositionTicks = positionTicks; + } + + /// + /// Gets the position ticks. /// /// The position ticks. - public long PositionTicks { get; set; } + public long PositionTicks { get; } /// public PlaybackRequestType Type { get; } = PlaybackRequestType.Seek; diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/SetPlaylistItemGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/SetPlaylistItemGroupRequest.cs index 0983d91292..2ca33c1ccf 100644 --- a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/SetPlaylistItemGroupRequest.cs +++ b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/SetPlaylistItemGroupRequest.cs @@ -2,7 +2,7 @@ using System.Threading; using MediaBrowser.Controller.Session; using MediaBrowser.Model.SyncPlay; -namespace MediaBrowser.Controller.SyncPlay +namespace MediaBrowser.Controller.SyncPlay.PlaybackRequests { /// /// Class SetPlaylistItemGroupRequest. @@ -10,10 +10,19 @@ namespace MediaBrowser.Controller.SyncPlay public class SetPlaylistItemGroupRequest : IGroupPlaybackRequest { /// - /// Gets or sets the playlist identifier of the playing item. + /// Initializes a new instance of the class. + /// + /// The playlist identifier of the item. + public SetPlaylistItemGroupRequest(string playlistItemId) + { + PlaylistItemId = playlistItemId; + } + + /// + /// Gets the playlist identifier of the playing item. /// /// The playlist identifier of the playing item. - public string PlaylistItemId { get; set; } + public string PlaylistItemId { get; } /// public PlaybackRequestType Type { get; } = PlaybackRequestType.SetPlaylistItem; diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/SetRepeatModeGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/SetRepeatModeGroupRequest.cs index 79373ef5f5..cd4505e4d0 100644 --- a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/SetRepeatModeGroupRequest.cs +++ b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/SetRepeatModeGroupRequest.cs @@ -2,7 +2,7 @@ using System.Threading; using MediaBrowser.Controller.Session; using MediaBrowser.Model.SyncPlay; -namespace MediaBrowser.Controller.SyncPlay +namespace MediaBrowser.Controller.SyncPlay.PlaybackRequests { /// /// Class SetRepeatModeGroupRequest. @@ -10,10 +10,19 @@ namespace MediaBrowser.Controller.SyncPlay public class SetRepeatModeGroupRequest : IGroupPlaybackRequest { /// - /// Gets or sets the repeat mode. + /// Initializes a new instance of the class. + /// + /// The repeat mode. + public SetRepeatModeGroupRequest(GroupRepeatMode mode) + { + Mode = mode; + } + + /// + /// Gets the repeat mode. /// /// The repeat mode. - public string Mode { get; set; } + public GroupRepeatMode Mode { get; } /// public PlaybackRequestType Type { get; } = PlaybackRequestType.SetRepeatMode; diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/SetShuffleModeGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/SetShuffleModeGroupRequest.cs index 316fb49f40..4530a34c02 100644 --- a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/SetShuffleModeGroupRequest.cs +++ b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/SetShuffleModeGroupRequest.cs @@ -2,7 +2,7 @@ using System.Threading; using MediaBrowser.Controller.Session; using MediaBrowser.Model.SyncPlay; -namespace MediaBrowser.Controller.SyncPlay +namespace MediaBrowser.Controller.SyncPlay.PlaybackRequests { /// /// Class SetShuffleModeGroupRequest. @@ -10,10 +10,19 @@ namespace MediaBrowser.Controller.SyncPlay public class SetShuffleModeGroupRequest : IGroupPlaybackRequest { /// - /// Gets or sets the shuffle mode. + /// Initializes a new instance of the class. + /// + /// The shuffle mode. + public SetShuffleModeGroupRequest(GroupShuffleMode mode) + { + Mode = mode; + } + + /// + /// Gets the shuffle mode. /// /// The shuffle mode. - public string Mode { get; set; } + public GroupShuffleMode Mode { get; } /// public PlaybackRequestType Type { get; } = PlaybackRequestType.SetShuffleMode; diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/StopGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/StopGroupRequest.cs index 9f6f8ea63c..ec01cd1105 100644 --- a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/StopGroupRequest.cs +++ b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/StopGroupRequest.cs @@ -2,7 +2,7 @@ using System.Threading; using MediaBrowser.Controller.Session; using MediaBrowser.Model.SyncPlay; -namespace MediaBrowser.Controller.SyncPlay +namespace MediaBrowser.Controller.SyncPlay.PlaybackRequests { /// /// Class StopGroupRequest. diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/UnpauseGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/UnpauseGroupRequest.cs index 84a6b0a6e7..bdf4fd4767 100644 --- a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/UnpauseGroupRequest.cs +++ b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/UnpauseGroupRequest.cs @@ -2,7 +2,7 @@ using System.Threading; using MediaBrowser.Controller.Session; using MediaBrowser.Model.SyncPlay; -namespace MediaBrowser.Controller.SyncPlay +namespace MediaBrowser.Controller.SyncPlay.PlaybackRequests { /// /// Class UnpauseGroupRequest. diff --git a/MediaBrowser.Controller/SyncPlay/Queue/PlayQueueManager.cs b/MediaBrowser.Controller/SyncPlay/Queue/PlayQueueManager.cs index 821a6314bd..2d1d1533b9 100644 --- a/MediaBrowser.Controller/SyncPlay/Queue/PlayQueueManager.cs +++ b/MediaBrowser.Controller/SyncPlay/Queue/PlayQueueManager.cs @@ -3,7 +3,7 @@ using System.Collections.Generic; using System.Linq; using MediaBrowser.Model.SyncPlay; -namespace MediaBrowser.Controller.SyncPlay +namespace MediaBrowser.Controller.SyncPlay.Queue { /// /// Class PlayQueueManager. @@ -563,11 +563,8 @@ namespace MediaBrowser.Controller.SyncPlay var list = new List(); foreach (var item in items) { - list.Add(new QueueItem() - { - ItemId = item, - PlaylistItemId = "syncPlayItem" + GetNextProgressiveId() - }); + var queueItem = new QueueItem(item, "syncPlayItem" + GetNextProgressiveId()); + list.Add(queueItem); } return list; diff --git a/MediaBrowser.Model/SyncPlay/GroupInfoDto.cs b/MediaBrowser.Model/SyncPlay/GroupInfoDto.cs index 85b9a35229..16a75eb68e 100644 --- a/MediaBrowser.Model/SyncPlay/GroupInfoDto.cs +++ b/MediaBrowser.Model/SyncPlay/GroupInfoDto.cs @@ -1,5 +1,4 @@ -#nullable disable - +using System; using System.Collections.Generic; namespace MediaBrowser.Model.SyncPlay @@ -9,6 +8,16 @@ namespace MediaBrowser.Model.SyncPlay /// public class GroupInfoDto { + /// + /// Initializes a new instance of the class. + /// + public GroupInfoDto() + { + GroupId = string.Empty; + GroupName = string.Empty; + Participants = new List(); + } + /// /// Gets or sets the group identifier. /// @@ -37,6 +46,6 @@ namespace MediaBrowser.Model.SyncPlay /// Gets or sets the date when this dto has been updated. /// /// The date when this dto has been updated. - public string LastUpdatedAt { get; set; } + public DateTime LastUpdatedAt { get; set; } } } diff --git a/MediaBrowser.Model/SyncPlay/GroupQueueMode.cs b/MediaBrowser.Model/SyncPlay/GroupQueueMode.cs new file mode 100644 index 0000000000..5c9c2627b9 --- /dev/null +++ b/MediaBrowser.Model/SyncPlay/GroupQueueMode.cs @@ -0,0 +1,18 @@ +namespace MediaBrowser.Model.SyncPlay +{ + /// + /// Enum GroupQueueMode. + /// + public enum GroupQueueMode + { + /// + /// Insert items at the end of the queue. + /// + Queue = 0, + + /// + /// Insert items after the currently playing item. + /// + QueueNext = 1 + } +} diff --git a/MediaBrowser.Model/SyncPlay/GroupRequestType.cs b/MediaBrowser.Model/SyncPlay/GroupRequestType.cs index e7361817ca..75c0712364 100644 --- a/MediaBrowser.Model/SyncPlay/GroupRequestType.cs +++ b/MediaBrowser.Model/SyncPlay/GroupRequestType.cs @@ -8,26 +8,26 @@ namespace MediaBrowser.Model.SyncPlay /// /// A user is requesting to create a new group. /// - NewGroup, + NewGroup = 0, /// /// A user is requesting to join a group. /// - JoinGroup, + JoinGroup = 1, /// /// A user is requesting to leave a group. /// - LeaveGroup, + LeaveGroup = 2, /// /// A user is requesting the list of available groups. /// - ListGroups, + ListGroups = 3, /// /// A user is sending a playback command to a group. /// - Playback + Playback = 4 } } diff --git a/MediaBrowser.Model/SyncPlay/GroupStateType.cs b/MediaBrowser.Model/SyncPlay/GroupStateType.cs index 341859b306..7aa454f928 100644 --- a/MediaBrowser.Model/SyncPlay/GroupStateType.cs +++ b/MediaBrowser.Model/SyncPlay/GroupStateType.cs @@ -8,21 +8,21 @@ namespace MediaBrowser.Model.SyncPlay /// /// The group is in idle state. No media is playing. /// - Idle, + Idle = 0, /// /// The group is in wating state. Playback is paused. Will start playing when users are ready. /// - Waiting, + Waiting = 1, /// /// The group is in paused state. Playback is paused. Will resume on play command. /// - Paused, + Paused = 2, /// /// The group is in playing state. Playback is advancing. /// - Playing + Playing = 3 } } diff --git a/MediaBrowser.Model/SyncPlay/NewGroupRequest.cs b/MediaBrowser.Model/SyncPlay/NewGroupRequest.cs index ccab5313f7..eb61a68d15 100644 --- a/MediaBrowser.Model/SyncPlay/NewGroupRequest.cs +++ b/MediaBrowser.Model/SyncPlay/NewGroupRequest.cs @@ -1,5 +1,3 @@ -#nullable disable - namespace MediaBrowser.Model.SyncPlay { /// @@ -7,6 +5,14 @@ namespace MediaBrowser.Model.SyncPlay /// public class NewGroupRequest { + /// + /// Initializes a new instance of the class. + /// + public NewGroupRequest() + { + GroupName = string.Empty; + } + /// /// Gets or sets the group name. /// diff --git a/MediaBrowser.Model/SyncPlay/PlayQueueUpdate.cs b/MediaBrowser.Model/SyncPlay/PlayQueueUpdate.cs index 575597e62d..d193b4c663 100644 --- a/MediaBrowser.Model/SyncPlay/PlayQueueUpdate.cs +++ b/MediaBrowser.Model/SyncPlay/PlayQueueUpdate.cs @@ -1,5 +1,4 @@ -#nullable disable - +using System; using System.Collections.Generic; namespace MediaBrowser.Model.SyncPlay @@ -9,6 +8,14 @@ namespace MediaBrowser.Model.SyncPlay /// public class PlayQueueUpdate { + /// + /// Initializes a new instance of the class. + /// + public PlayQueueUpdate() + { + Playlist = new List(); + } + /// /// Gets or sets the request type that originated this update. /// @@ -19,7 +26,7 @@ namespace MediaBrowser.Model.SyncPlay /// Gets or sets the UTC time of the last change to the playing queue. /// /// The UTC time of the last change to the playing queue. - public string LastUpdate { get; set; } + public DateTime LastUpdate { get; set; } /// /// Gets or sets the playlist. diff --git a/MediaBrowser.Model/SyncPlay/PlayQueueUpdateReason.cs b/MediaBrowser.Model/SyncPlay/PlayQueueUpdateReason.cs index 4b3f6eb4d6..e78940fe68 100644 --- a/MediaBrowser.Model/SyncPlay/PlayQueueUpdateReason.cs +++ b/MediaBrowser.Model/SyncPlay/PlayQueueUpdateReason.cs @@ -26,12 +26,12 @@ namespace MediaBrowser.Model.SyncPlay MoveItem = 3, /// - /// A user is making changes to the queue. + /// A user is adding items the queue. /// Queue = 4, /// - /// A user is making changes to the queue. + /// A user is adding items to the queue, after the currently playing item. /// QueueNext = 5, diff --git a/MediaBrowser.Model/SyncPlay/QueueItem.cs b/MediaBrowser.Model/SyncPlay/QueueItem.cs index ce253b182c..9c4d3a4ceb 100644 --- a/MediaBrowser.Model/SyncPlay/QueueItem.cs +++ b/MediaBrowser.Model/SyncPlay/QueueItem.cs @@ -1,5 +1,3 @@ -#nullable disable - using System; namespace MediaBrowser.Model.SyncPlay @@ -10,15 +8,26 @@ namespace MediaBrowser.Model.SyncPlay public class QueueItem { /// - /// Gets or sets the item identifier. + /// Initializes a new instance of the class. + /// + /// The item identifier. + /// The playlist identifier of the item. + public QueueItem(Guid itemId, string playlistItemId) + { + ItemId = itemId; + PlaylistItemId = playlistItemId; + } + + /// + /// Gets the item identifier. /// /// The item identifier. - public Guid ItemId { get; set; } + public Guid ItemId { get; } /// - /// Gets or sets the playlist identifier of the item. + /// Gets the playlist identifier of the item. /// /// The playlist identifier of the item. - public string PlaylistItemId { get; set; } + public string PlaylistItemId { get; } } } diff --git a/MediaBrowser.Model/SyncPlay/SendCommand.cs b/MediaBrowser.Model/SyncPlay/SendCommand.cs index b24f7e97bd..a3aa54b380 100644 --- a/MediaBrowser.Model/SyncPlay/SendCommand.cs +++ b/MediaBrowser.Model/SyncPlay/SendCommand.cs @@ -1,4 +1,4 @@ -#nullable disable +using System; namespace MediaBrowser.Model.SyncPlay { @@ -7,6 +7,15 @@ namespace MediaBrowser.Model.SyncPlay /// public class SendCommand { + /// + /// Initializes a new instance of the class. + /// + public SendCommand() + { + GroupId = string.Empty; + PlaylistItemId = string.Empty; + } + /// /// Gets or sets the group identifier. /// @@ -23,7 +32,7 @@ namespace MediaBrowser.Model.SyncPlay /// Gets or sets the UTC time when to execute the command. /// /// The UTC time when to execute the command. - public string When { get; set; } + public DateTime When { get; set; } /// /// Gets or sets the position ticks. @@ -41,6 +50,6 @@ namespace MediaBrowser.Model.SyncPlay /// Gets or sets the UTC time when this command has been emitted. /// /// The UTC time when this command has been emitted. - public string EmittedAt { get; set; } + public DateTime EmittedAt { get; set; } } } -- cgit v1.2.3 From c7e53bce2fa43ad38807a0589e1bc020237e49c6 Mon Sep 17 00:00:00 2001 From: Ionut Andrei Oanca Date: Sun, 15 Nov 2020 17:03:27 +0100 Subject: Patch data-races and minor changes in SyncPlay --- .../SyncPlay/GroupController.cs | 96 +++---- .../SyncPlay/SyncPlayManager.cs | 312 ++++++++++----------- Jellyfin.Api/Controllers/SyncPlayController.cs | 16 +- Jellyfin.Api/Controllers/TimeSyncController.cs | 14 +- .../SyncPlay/GroupStates/AbstractGroupState.cs | 14 +- .../SyncPlay/GroupStates/WaitingGroupState.cs | 46 +-- .../SyncPlay/IGroupStateContext.cs | 6 +- .../SyncPlay/ISyncPlayManager.cs | 16 -- .../SyncPlay/PlaybackRequests/PlayGroupRequest.cs | 4 +- .../SyncPlay/PlaybackRequests/QueueGroupRequest.cs | 4 +- .../RemoveFromPlaylistGroupRequest.cs | 5 +- .../SyncPlay/Queue/PlayQueueManager.cs | 22 +- MediaBrowser.Model/SyncPlay/GroupInfoDto.cs | 37 ++- MediaBrowser.Model/SyncPlay/GroupStateUpdate.cs | 19 +- MediaBrowser.Model/SyncPlay/GroupUpdate.cs | 29 +- MediaBrowser.Model/SyncPlay/JoinGroupRequest.cs | 13 +- MediaBrowser.Model/SyncPlay/NewGroupRequest.cs | 9 +- MediaBrowser.Model/SyncPlay/PlayQueueUpdate.cs | 45 +-- MediaBrowser.Model/SyncPlay/SendCommand.cs | 36 ++- MediaBrowser.Model/SyncPlay/UtcTimeResponse.cs | 21 +- 20 files changed, 381 insertions(+), 383 deletions(-) (limited to 'MediaBrowser.Controller/SyncPlay/Queue') diff --git a/Emby.Server.Implementations/SyncPlay/GroupController.cs b/Emby.Server.Implementations/SyncPlay/GroupController.cs index a0d951b3e6..48596bb421 100644 --- a/Emby.Server.Implementations/SyncPlay/GroupController.cs +++ b/Emby.Server.Implementations/SyncPlay/GroupController.cs @@ -45,11 +45,6 @@ namespace Emby.Server.Implementations.SyncPlay /// private readonly ILibraryManager _libraryManager; - /// - /// The SyncPlay manager. - /// - private readonly ISyncPlayManager _syncPlayManager; - /// /// Internal group state. /// @@ -63,19 +58,16 @@ namespace Emby.Server.Implementations.SyncPlay /// The user manager. /// The session manager. /// The library manager. - /// The SyncPlay manager. public GroupController( ILogger logger, IUserManager userManager, ISessionManager sessionManager, - ILibraryManager libraryManager, - ISyncPlayManager syncPlayManager) + ILibraryManager libraryManager) { _logger = logger; _userManager = userManager; _sessionManager = sessionManager; _libraryManager = libraryManager; - _syncPlayManager = syncPlayManager; _state = new IdleGroupState(_logger); } @@ -168,7 +160,7 @@ namespace Emby.Server.Implementations.SyncPlay /// /// The current session. /// The filtering type. - /// The array of sessions matching the filter. + /// The list of sessions matching the filter. private IEnumerable FilterSessions(SessionInfo from, SyncPlayBroadcastType type) { return type switch @@ -209,7 +201,7 @@ namespace Emby.Server.Implementations.SyncPlay /// The user. /// The queue. /// true if the user can access all the items in the queue, false otherwise. - private bool HasAccessToQueue(User user, IEnumerable queue) + private bool HasAccessToQueue(User user, IReadOnlyList queue) { // Check if queue is empty. if (!queue?.Any() ?? true) @@ -234,7 +226,7 @@ namespace Emby.Server.Implementations.SyncPlay return true; } - private bool AllUsersHaveAccessToQueue(IEnumerable queue) + private bool AllUsersHaveAccessToQueue(IReadOnlyList queue) { // Check if queue is empty. if (!queue?.Any() ?? true) @@ -262,7 +254,6 @@ namespace Emby.Server.Implementations.SyncPlay { GroupName = request.GroupName; AddSession(session); - _syncPlayManager.AddSessionToGroup(session, this); var sessionIsPlayingAnItem = session.FullNowPlayingItem != null; @@ -270,7 +261,7 @@ namespace Emby.Server.Implementations.SyncPlay if (sessionIsPlayingAnItem) { - var playlist = session.NowPlayingQueue.Select(item => item.Id); + var playlist = session.NowPlayingQueue.Select(item => item.Id).ToList(); PlayQueue.Reset(); PlayQueue.SetPlaylist(playlist); PlayQueue.SetPlayingItemById(session.FullNowPlayingItem.Id); @@ -290,14 +281,13 @@ namespace Emby.Server.Implementations.SyncPlay _state.SessionJoined(this, _state.Type, session, cancellationToken); - _logger.LogInformation("InitGroup: {0} created group {1}.", session.Id, GroupId.ToString()); + _logger.LogInformation("InitGroup: {SessionId} created group {GroupId}.", session.Id, GroupId.ToString()); } /// public void SessionJoin(SessionInfo session, JoinGroupRequest request, CancellationToken cancellationToken) { AddSession(session); - _syncPlayManager.AddSessionToGroup(session, this); var updateSession = NewSyncPlayGroupUpdate(GroupUpdateType.GroupJoined, GetInfo()); SendGroupUpdate(session, SyncPlayBroadcastType.CurrentSession, updateSession, cancellationToken); @@ -307,7 +297,7 @@ namespace Emby.Server.Implementations.SyncPlay _state.SessionJoined(this, _state.Type, session, cancellationToken); - _logger.LogInformation("SessionJoin: {0} joined group {1}.", session.Id, GroupId.ToString()); + _logger.LogInformation("SessionJoin: {SessionId} joined group {GroupId}.", session.Id, GroupId.ToString()); } /// @@ -321,7 +311,7 @@ namespace Emby.Server.Implementations.SyncPlay _state.SessionJoined(this, _state.Type, session, cancellationToken); - _logger.LogInformation("SessionRestore: {0} re-joined group {1}.", session.Id, GroupId.ToString()); + _logger.LogInformation("SessionRestore: {SessionId} re-joined group {GroupId}.", session.Id, GroupId.ToString()); } /// @@ -330,7 +320,6 @@ namespace Emby.Server.Implementations.SyncPlay _state.SessionLeaving(this, _state.Type, session, cancellationToken); RemoveSession(session); - _syncPlayManager.RemoveSessionFromGroup(session, this); var updateSession = NewSyncPlayGroupUpdate(GroupUpdateType.GroupLeft, GroupId.ToString()); SendGroupUpdate(session, SyncPlayBroadcastType.CurrentSession, updateSession, cancellationToken); @@ -338,7 +327,7 @@ namespace Emby.Server.Implementations.SyncPlay var updateOthers = NewSyncPlayGroupUpdate(GroupUpdateType.UserLeft, session.UserName); SendGroupUpdate(session, SyncPlayBroadcastType.AllExceptCurrentSession, updateOthers, cancellationToken); - _logger.LogInformation("SessionLeave: {0} left group {1}.", session.Id, GroupId.ToString()); + _logger.LogInformation("SessionLeave: {SessionId} left group {GroupId}.", session.Id, GroupId.ToString()); } /// @@ -347,27 +336,21 @@ namespace Emby.Server.Implementations.SyncPlay // The server's job is to maintain a consistent state for clients to reference // and notify clients of state changes. The actual syncing of media playback // happens client side. Clients are aware of the server's time and use it to sync. - _logger.LogInformation("HandleRequest: {0} requested {1}, group {2} in {3} state.", session.Id, request.Type, GroupId.ToString(), _state.Type); + _logger.LogInformation("HandleRequest: {SessionId} requested {RequestType}, group {GroupId} is {StateType}.", session.Id, request.Type, GroupId.ToString(), _state.Type); request.Apply(this, _state, session, cancellationToken); } /// public GroupInfoDto GetInfo() { - return new GroupInfoDto() - { - GroupId = GroupId.ToString(), - GroupName = GroupName, - State = _state.Type, - Participants = Participants.Values.Select(session => session.Session.UserName).Distinct().ToList(), - LastUpdatedAt = DateTime.UtcNow - }; + var participants = Participants.Values.Select(session => session.Session.UserName).Distinct().ToList(); + return new GroupInfoDto(GroupId, GroupName, _state.Type, participants, DateTime.UtcNow); } /// public bool HasAccessToPlayQueue(User user) { - var items = PlayQueue.GetPlaylist().Select(item => item.ItemId); + var items = PlayQueue.GetPlaylist().Select(item => item.ItemId).ToList(); return HasAccessToQueue(user, items); } @@ -383,7 +366,7 @@ namespace Emby.Server.Implementations.SyncPlay /// public void SetState(IGroupState state) { - _logger.LogInformation("SetState: {0} switching from {1} to {2}.", GroupId.ToString(), _state.Type, state.Type); + _logger.LogInformation("SetState: {GroupId} switching from {FromStateType} to {ToStateType}.", GroupId.ToString(), _state.Type, state.Type); this._state = state; } @@ -418,26 +401,19 @@ namespace Emby.Server.Implementations.SyncPlay /// public SendCommand NewSyncPlayCommand(SendCommandType type) { - return new SendCommand() - { - GroupId = GroupId.ToString(), - PlaylistItemId = PlayQueue.GetPlayingItemPlaylistId(), - PositionTicks = PositionTicks, - Command = type, - When = LastActivity, - EmittedAt = DateTime.UtcNow - }; + return new SendCommand( + GroupId, + PlayQueue.GetPlayingItemPlaylistId(), + LastActivity, + type, + PositionTicks, + DateTime.UtcNow); } /// public GroupUpdate NewSyncPlayGroupUpdate(GroupUpdateType type, T data) { - return new GroupUpdate() - { - GroupId = GroupId.ToString(), - Type = type, - Data = data - }; + return new GroupUpdate(GroupId, type, data); } /// @@ -501,10 +477,10 @@ namespace Emby.Server.Implementations.SyncPlay } /// - public bool SetPlayQueue(IEnumerable playQueue, int playingItemPosition, long startPositionTicks) + public bool SetPlayQueue(IReadOnlyList playQueue, int playingItemPosition, long startPositionTicks) { // Ignore on empty queue or invalid item position. - if (!playQueue.Any() || playingItemPosition >= playQueue.Count() || playingItemPosition < 0) + if (playQueue.Count == 0 || playingItemPosition >= playQueue.Count || playingItemPosition < 0) { return false; } @@ -547,7 +523,7 @@ namespace Emby.Server.Implementations.SyncPlay } /// - public bool RemoveFromPlayQueue(IEnumerable playlistItemIds) + public bool RemoveFromPlayQueue(IReadOnlyList playlistItemIds) { var playingItemRemoved = PlayQueue.RemoveFromPlaylist(playlistItemIds); if (playingItemRemoved) @@ -576,10 +552,10 @@ namespace Emby.Server.Implementations.SyncPlay } /// - public bool AddToPlayQueue(IEnumerable newItems, GroupQueueMode mode) + public bool AddToPlayQueue(IReadOnlyList newItems, GroupQueueMode mode) { // Ignore on empty list. - if (!newItems.Any()) + if (newItems.Count == 0) { return false; } @@ -673,16 +649,14 @@ namespace Emby.Server.Implementations.SyncPlay startPositionTicks += Math.Max(elapsedTime.Ticks, 0); } - return new PlayQueueUpdate() - { - Reason = reason, - LastUpdate = PlayQueue.LastChange, - Playlist = PlayQueue.GetPlaylist(), - PlayingItemIndex = PlayQueue.PlayingItemIndex, - StartPositionTicks = startPositionTicks, - ShuffleMode = PlayQueue.ShuffleMode, - RepeatMode = PlayQueue.RepeatMode - }; + return new PlayQueueUpdate( + reason, + PlayQueue.LastChange, + PlayQueue.GetPlaylist(), + PlayQueue.PlayingItemIndex, + startPositionTicks, + PlayQueue.ShuffleMode, + PlayQueue.RepeatMode); } } } diff --git a/Emby.Server.Implementations/SyncPlay/SyncPlayManager.cs b/Emby.Server.Implementations/SyncPlay/SyncPlayManager.cs index 178536631e..ee75580cc1 100644 --- a/Emby.Server.Implementations/SyncPlay/SyncPlayManager.cs +++ b/Emby.Server.Implementations/SyncPlay/SyncPlayManager.cs @@ -72,19 +72,9 @@ namespace Emby.Server.Implementations.SyncPlay _userManager = userManager; _sessionManager = sessionManager; _libraryManager = libraryManager; - _sessionManager.SessionStarted += OnSessionManagerSessionStarted; - _sessionManager.SessionEnded += OnSessionManagerSessionEnded; - _sessionManager.PlaybackStart += OnSessionManagerPlaybackStart; - _sessionManager.PlaybackStopped += OnSessionManagerPlaybackStopped; } - /// - /// Gets all groups. - /// - /// All groups. - public IEnumerable Groups => _groups.Values; - /// public void Dispose() { @@ -92,127 +82,6 @@ namespace Emby.Server.Implementations.SyncPlay GC.SuppressFinalize(this); } - /// - /// Releases unmanaged and optionally managed resources. - /// - /// true to release both managed and unmanaged resources; false to release only unmanaged resources. - protected virtual void Dispose(bool disposing) - { - if (_disposed) - { - return; - } - - _sessionManager.SessionStarted -= OnSessionManagerSessionStarted; - _sessionManager.SessionEnded -= OnSessionManagerSessionEnded; - _sessionManager.PlaybackStart -= OnSessionManagerPlaybackStart; - _sessionManager.PlaybackStopped -= OnSessionManagerPlaybackStopped; - - _disposed = true; - } - - private void OnSessionManagerSessionStarted(object sender, SessionEventArgs e) - { - var session = e.SessionInfo; - if (!IsSessionInGroup(session)) - { - return; - } - - var groupId = GetSessionGroup(session) ?? Guid.Empty; - var request = new JoinGroupRequest() - { - GroupId = groupId - }; - JoinGroup(session, groupId, request, CancellationToken.None); - } - - private void OnSessionManagerSessionEnded(object sender, SessionEventArgs e) - { - var session = e.SessionInfo; - if (!IsSessionInGroup(session)) - { - return; - } - - // TODO: probably remove this event, not used at the moment. - } - - private void OnSessionManagerPlaybackStart(object sender, PlaybackProgressEventArgs e) - { - var session = e.Session; - if (!IsSessionInGroup(session)) - { - return; - } - - // TODO: probably remove this event, not used at the moment. - } - - private void OnSessionManagerPlaybackStopped(object sender, PlaybackStopEventArgs e) - { - var session = e.Session; - if (!IsSessionInGroup(session)) - { - return; - } - - // TODO: probably remove this event, not used at the moment. - } - - private bool IsRequestValid(SessionInfo session, GroupRequestType requestType, T request, bool checkRequest = true) - { - if (session == null || (request == null && checkRequest)) - { - return false; - } - - var user = _userManager.GetUserById(session.UserId); - - if (user.SyncPlayAccess == SyncPlayAccess.None) - { - _logger.LogWarning("IsRequestValid: {0} does not have access to SyncPlay. Requested {1}.", session.Id, requestType); - - var error = new GroupUpdate() - { - // TODO: rename to a more generic error. Next PR will fix this. - Type = GroupUpdateType.JoinGroupDenied - }; - _sessionManager.SendSyncPlayGroupUpdate(session, error, CancellationToken.None); - return false; - } - - if (requestType.Equals(GroupRequestType.NewGroup) && user.SyncPlayAccess != SyncPlayAccess.CreateAndJoinGroups) - { - _logger.LogWarning("IsRequestValid: {0} does not have permission to create groups.", session.Id); - - var error = new GroupUpdate - { - Type = GroupUpdateType.CreateGroupDenied - }; - _sessionManager.SendSyncPlayGroupUpdate(session, error, CancellationToken.None); - return false; - } - - return true; - } - - private bool IsRequestValid(SessionInfo session, GroupRequestType requestType) - { - return IsRequestValid(session, requestType, session, false); - } - - private bool IsSessionInGroup(SessionInfo session) - { - return _sessionToGroupMap.ContainsKey(session.Id); - } - - private Guid? GetSessionGroup(SessionInfo session) - { - _sessionToGroupMap.TryGetValue(session.Id, out var group); - return group?.GroupId; - } - /// public void NewGroup(SessionInfo session, NewGroupRequest request, CancellationToken cancellationToken) { @@ -229,9 +98,10 @@ namespace Emby.Server.Implementations.SyncPlay LeaveGroup(session, cancellationToken); } - var group = new GroupController(_logger, _userManager, _sessionManager, _libraryManager, this); + var group = new GroupController(_logger, _userManager, _sessionManager, _libraryManager); _groups[group.GroupId] = group; + AddSessionToGroup(session, group); group.CreateGroup(session, request, cancellationToken); } } @@ -253,25 +123,18 @@ namespace Emby.Server.Implementations.SyncPlay if (group == null) { - _logger.LogWarning("JoinGroup: {0} tried to join group {0} that does not exist.", session.Id, groupId); + _logger.LogWarning("JoinGroup: {SessionId} tried to join group {GroupId} that does not exist.", session.Id, groupId); - var error = new GroupUpdate() - { - Type = GroupUpdateType.GroupDoesNotExist - }; + var error = new GroupUpdate(Guid.Empty, GroupUpdateType.GroupDoesNotExist, string.Empty); _sessionManager.SendSyncPlayGroupUpdate(session, error, CancellationToken.None); return; } if (!group.HasAccessToPlayQueue(user)) { - _logger.LogWarning("JoinGroup: {0} does not have access to some content from the playing queue of group {1}.", session.Id, group.GroupId.ToString()); + _logger.LogWarning("JoinGroup: {SessionId} does not have access to some content from the playing queue of group {GroupId}.", session.Id, group.GroupId.ToString()); - var error = new GroupUpdate() - { - GroupId = group.GroupId.ToString(), - Type = GroupUpdateType.LibraryAccessDenied - }; + var error = new GroupUpdate(group.GroupId, GroupUpdateType.LibraryAccessDenied, string.Empty); _sessionManager.SendSyncPlayGroupUpdate(session, error, CancellationToken.None); return; } @@ -287,6 +150,7 @@ namespace Emby.Server.Implementations.SyncPlay LeaveGroup(session, cancellationToken); } + AddSessionToGroup(session, group); group.SessionJoin(session, request, cancellationToken); } } @@ -307,21 +171,19 @@ namespace Emby.Server.Implementations.SyncPlay if (group == null) { - _logger.LogWarning("LeaveGroup: {0} does not belong to any group.", session.Id); + _logger.LogWarning("LeaveGroup: {SessionId} does not belong to any group.", session.Id); - var error = new GroupUpdate() - { - Type = GroupUpdateType.NotInGroup - }; + var error = new GroupUpdate(Guid.Empty, GroupUpdateType.NotInGroup, string.Empty); _sessionManager.SendSyncPlayGroupUpdate(session, error, CancellationToken.None); return; } + RemoveSessionFromGroup(session, group); group.SessionLeave(session, cancellationToken); if (group.IsGroupEmpty()) { - _logger.LogInformation("LeaveGroup: removing empty group {0}.", group.GroupId); + _logger.LogInformation("LeaveGroup: removing empty group {GroupId}.", group.GroupId); _groups.Remove(group.GroupId, out _); } } @@ -338,11 +200,14 @@ namespace Emby.Server.Implementations.SyncPlay var user = _userManager.GetUserById(session.UserId); - return _groups - .Values - .Where(group => group.HasAccessToPlayQueue(user)) - .Select(group => group.GetInfo()) - .ToList(); + lock (_groupsLock) + { + return _groups + .Values + .Where(group => group.HasAccessToPlayQueue(user)) + .Select(group => group.GetInfo()) + .ToList(); + } } /// @@ -360,12 +225,9 @@ namespace Emby.Server.Implementations.SyncPlay if (group == null) { - _logger.LogWarning("HandleRequest: {0} does not belong to any group.", session.Id); + _logger.LogWarning("HandleRequest: {SessionId} does not belong to any group.", session.Id); - var error = new GroupUpdate() - { - Type = GroupUpdateType.NotInGroup - }; + var error = new GroupUpdate(Guid.Empty, GroupUpdateType.NotInGroup, string.Empty); _sessionManager.SendSyncPlayGroupUpdate(session, error, CancellationToken.None); return; } @@ -374,8 +236,74 @@ namespace Emby.Server.Implementations.SyncPlay } } - /// - public void AddSessionToGroup(SessionInfo session, IGroupController group) + /// + /// Releases unmanaged and optionally managed resources. + /// + /// true to release both managed and unmanaged resources; false to release only unmanaged resources. + protected virtual void Dispose(bool disposing) + { + if (_disposed) + { + return; + } + + _sessionManager.SessionStarted -= OnSessionManagerSessionStarted; + _disposed = true; + } + + private void OnSessionManagerSessionStarted(object sender, SessionEventArgs e) + { + var session = e.SessionInfo; + lock (_groupsLock) + { + if (!IsSessionInGroup(session)) + { + return; + } + + var groupId = GetSessionGroup(session); + var request = new JoinGroupRequest(groupId); + JoinGroup(session, groupId, request, CancellationToken.None); + } + } + + /// + /// Checks if a given session has joined a group. + /// + /// + /// Not thread-safe, call only under groups-lock. + /// + /// The session. + /// true if the session has joined a group, false otherwise. + private bool IsSessionInGroup(SessionInfo session) + { + return _sessionToGroupMap.ContainsKey(session.Id); + } + + /// + /// Gets the group joined by the given session, if any. + /// + /// + /// Not thread-safe, call only under groups-lock. + /// + /// The session. + /// The group identifier if the session has joined a group, an empty identifier otherwise. + private Guid GetSessionGroup(SessionInfo session) + { + _sessionToGroupMap.TryGetValue(session.Id, out var group); + return group?.GroupId ?? Guid.Empty; + } + + /// + /// Maps a session to a group. + /// + /// + /// Not thread-safe, call only under groups-lock. + /// + /// The session. + /// The group. + /// Thrown when the user is in another group already. + private void AddSessionToGroup(SessionInfo session, IGroupController group) { if (session == null) { @@ -390,8 +318,16 @@ namespace Emby.Server.Implementations.SyncPlay _sessionToGroupMap[session.Id] = group ?? throw new InvalidOperationException("Group is null!"); } - /// - public void RemoveSessionFromGroup(SessionInfo session, IGroupController group) + /// + /// Unmaps a session from a group. + /// + /// + /// Not thread-safe, call only under groups-lock. + /// + /// The session. + /// The group. + /// Thrown when the user is not found in the specified group. + private void RemoveSessionFromGroup(SessionInfo session, IGroupController group) { if (session == null) { @@ -414,5 +350,55 @@ namespace Emby.Server.Implementations.SyncPlay throw new InvalidOperationException("Session was in wrong group!"); } } + + /// + /// Checks if a given session is allowed to make a given request. + /// + /// The session. + /// The request type. + /// The request. + /// Whether to check if request is null. + /// true if the request is valid, false otherwise. Will return false also when session is null. + private bool IsRequestValid(SessionInfo session, GroupRequestType requestType, T request, bool checkRequest = true) + { + if (session == null || (request == null && checkRequest)) + { + return false; + } + + var user = _userManager.GetUserById(session.UserId); + + if (user.SyncPlayAccess == SyncPlayAccess.None) + { + _logger.LogWarning("IsRequestValid: {SessionId} does not have access to SyncPlay. Requested {RequestType}.", session.Id, requestType); + + // TODO: rename to a more generic error. Next PR will fix this. + var error = new GroupUpdate(Guid.Empty, GroupUpdateType.JoinGroupDenied, string.Empty); + _sessionManager.SendSyncPlayGroupUpdate(session, error, CancellationToken.None); + return false; + } + + if (requestType.Equals(GroupRequestType.NewGroup) && user.SyncPlayAccess != SyncPlayAccess.CreateAndJoinGroups) + { + _logger.LogWarning("IsRequestValid: {SessionId} does not have permission to create groups.", session.Id); + + var error = new GroupUpdate(Guid.Empty, GroupUpdateType.CreateGroupDenied, string.Empty); + _sessionManager.SendSyncPlayGroupUpdate(session, error, CancellationToken.None); + return false; + } + + return true; + } + + /// + /// Checks if a given session is allowed to make a given type of request. + /// + /// The session. + /// The request type. + /// true if the request is valid, false otherwise. Will return false also when session is null. + private bool IsRequestValid(SessionInfo session, GroupRequestType requestType) + { + return IsRequestValid(session, requestType, session, false); + } } } diff --git a/Jellyfin.Api/Controllers/SyncPlayController.cs b/Jellyfin.Api/Controllers/SyncPlayController.cs index 9085a71c88..8e9314b4aa 100644 --- a/Jellyfin.Api/Controllers/SyncPlayController.cs +++ b/Jellyfin.Api/Controllers/SyncPlayController.cs @@ -53,10 +53,7 @@ namespace Jellyfin.Api.Controllers [FromQuery, Required] string groupName) { var currentSession = RequestHelpers.GetSession(_sessionManager, _authorizationContext, Request); - var newGroupRequest = new NewGroupRequest() - { - GroupName = groupName - }; + var newGroupRequest = new NewGroupRequest(groupName); _syncPlayManager.NewGroup(currentSession, newGroupRequest, CancellationToken.None); return NoContent(); } @@ -73,10 +70,7 @@ namespace Jellyfin.Api.Controllers [FromQuery, Required] Guid groupId) { var currentSession = RequestHelpers.GetSession(_sessionManager, _authorizationContext, Request); - var joinRequest = new JoinGroupRequest() - { - GroupId = groupId - }; + var joinRequest = new JoinGroupRequest(groupId); _syncPlayManager.JoinGroup(currentSession, groupId, joinRequest, CancellationToken.None); return NoContent(); } @@ -185,18 +179,18 @@ namespace Jellyfin.Api.Controllers /// /// Request to queue items to the playlist of a SyncPlay group. /// - /// The items to add. + /// The items to add. /// The mode in which to enqueue the items. /// Queue update request sent to all group members. /// A indicating success. [HttpPost("Queue")] [ProducesResponseType(StatusCodes.Status204NoContent)] public ActionResult SyncPlayQueue( - [FromQuery, Required] Guid[] items, + [FromQuery, Required] Guid[] itemIds, [FromQuery, Required] GroupQueueMode mode) { var currentSession = RequestHelpers.GetSession(_sessionManager, _authorizationContext, Request); - var syncPlayRequest = new QueueGroupRequest(items, mode); + var syncPlayRequest = new QueueGroupRequest(itemIds, mode); _syncPlayManager.HandleRequest(currentSession, syncPlayRequest, CancellationToken.None); return NoContent(); } diff --git a/Jellyfin.Api/Controllers/TimeSyncController.cs b/Jellyfin.Api/Controllers/TimeSyncController.cs index 2dc744e7ca..5de5604173 100644 --- a/Jellyfin.Api/Controllers/TimeSyncController.cs +++ b/Jellyfin.Api/Controllers/TimeSyncController.cs @@ -13,7 +13,7 @@ namespace Jellyfin.Api.Controllers public class TimeSyncController : BaseJellyfinApiController { /// - /// Gets the current utc time. + /// Gets the current UTC time. /// /// Time returned. /// An to sync the client and server time. @@ -22,18 +22,14 @@ namespace Jellyfin.Api.Controllers public ActionResult GetUtcTime() { // Important to keep the following line at the beginning - var requestReceptionTime = DateTime.UtcNow.ToUniversalTime().ToString("o", DateTimeFormatInfo.InvariantInfo); + var requestReceptionTime = DateTime.UtcNow.ToUniversalTime(); - var response = new UtcTimeResponse(); - response.RequestReceptionTime = requestReceptionTime; - - // Important to keep the following two lines at the end - var responseTransmissionTime = DateTime.UtcNow.ToUniversalTime().ToString("o", DateTimeFormatInfo.InvariantInfo); - response.ResponseTransmissionTime = responseTransmissionTime; + // Important to keep the following line at the end + var responseTransmissionTime = DateTime.UtcNow.ToUniversalTime(); // Implementing NTP on such a high level results in this useless // information being sent. On the other hand it enables future additions. - return response; + return new UtcTimeResponse(requestReceptionTime, responseTransmissionTime); } } } diff --git a/MediaBrowser.Controller/SyncPlay/GroupStates/AbstractGroupState.cs b/MediaBrowser.Controller/SyncPlay/GroupStates/AbstractGroupState.cs index bc2e223802..e5da0ef40f 100644 --- a/MediaBrowser.Controller/SyncPlay/GroupStates/AbstractGroupState.cs +++ b/MediaBrowser.Controller/SyncPlay/GroupStates/AbstractGroupState.cs @@ -68,7 +68,7 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates if (playingItemRemoved && !context.PlayQueue.IsItemPlaying()) { - Logger.LogDebug("HandleRequest: {0} in group {1}, play queue is empty.", request.Type, context.GroupId.ToString()); + Logger.LogDebug("HandleRequest: {RequestType} in group {GroupId}, play queue is empty.", request.Type, context.GroupId.ToString()); IGroupState idleState = new IdleGroupState(Logger); context.SetState(idleState); @@ -84,7 +84,7 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates if (!result) { - Logger.LogError("HandleRequest: {0} in group {1}, unable to move item in play queue.", request.Type, context.GroupId.ToString()); + Logger.LogError("HandleRequest: {RequestType} in group {GroupId}, unable to move item in play queue.", request.Type, context.GroupId.ToString()); return; } @@ -100,7 +100,7 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates if (!result) { - Logger.LogError("HandleRequest: {0} in group {1}, unable to add items to play queue.", request.Type, context.GroupId.ToString()); + Logger.LogError("HandleRequest: {RequestType} in group {GroupId}, unable to add items to play queue.", request.Type, context.GroupId.ToString()); return; } @@ -203,18 +203,14 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates protected void SendGroupStateUpdate(IGroupStateContext context, IGroupPlaybackRequest reason, SessionInfo session, CancellationToken cancellationToken) { // Notify relevant state change event. - var stateUpdate = new GroupStateUpdate() - { - State = Type, - Reason = reason.Type - }; + var stateUpdate = new GroupStateUpdate(Type, reason.Type); var update = context.NewSyncPlayGroupUpdate(GroupUpdateType.StateUpdate, stateUpdate); context.SendGroupUpdate(session, SyncPlayBroadcastType.AllGroup, update, cancellationToken); } private void UnhandledRequest(IGroupPlaybackRequest request) { - Logger.LogWarning("HandleRequest: unhandled {0} request for {1} state.", request.Type, Type); + Logger.LogWarning("HandleRequest: unhandled {RequestType} request in {StateType} state.", request.Type, Type); } } } diff --git a/MediaBrowser.Controller/SyncPlay/GroupStates/WaitingGroupState.cs b/MediaBrowser.Controller/SyncPlay/GroupStates/WaitingGroupState.cs index 78318dd94d..e33e711fb7 100644 --- a/MediaBrowser.Controller/SyncPlay/GroupStates/WaitingGroupState.cs +++ b/MediaBrowser.Controller/SyncPlay/GroupStates/WaitingGroupState.cs @@ -103,7 +103,7 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates var unpauseRequest = new UnpauseGroupRequest(); playingState.HandleRequest(context, Type, unpauseRequest, session, cancellationToken); - Logger.LogDebug("SessionLeaving: {0} left the group {1}, notifying others to resume.", session.Id, context.GroupId.ToString()); + Logger.LogDebug("SessionLeaving: {SessionId} left group {GroupId}, notifying others to resume.", session.Id, context.GroupId.ToString()); } else { @@ -111,7 +111,7 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates var pausedState = new PausedGroupState(Logger); context.SetState(pausedState); - Logger.LogDebug("SessionLeaving: {0} left the group {1}, returning to previous state.", session.Id, context.GroupId.ToString()); + Logger.LogDebug("SessionLeaving: {SessionId} left group {GroupId}, returning to previous state.", session.Id, context.GroupId.ToString()); } } } @@ -131,7 +131,7 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates var setQueueStatus = context.SetPlayQueue(request.PlayingQueue, request.PlayingItemPosition, request.StartPositionTicks); if (!setQueueStatus) { - Logger.LogError("HandleRequest: {0} in group {1}, unable to set playing queue.", request.Type, context.GroupId.ToString()); + Logger.LogError("HandleRequest: {RequestType} in group {GroupId}, unable to set playing queue.", request.Type, context.GroupId.ToString()); // Ignore request and return to previous state. IGroupState newState = prevState switch { @@ -151,7 +151,7 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates // Reset status of sessions and await for all Ready events. context.SetAllBuffering(true); - Logger.LogDebug("HandleRequest: {0} in group {1}, {2} set a new play queue.", request.Type, context.GroupId.ToString(), session.Id); + Logger.LogDebug("HandleRequest: {RequestType} in group {GroupId}, {SessionId} set a new play queue.", request.Type, context.GroupId.ToString(), session.Id); } /// @@ -188,7 +188,7 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates context.SetState(newState); - Logger.LogDebug("HandleRequest: {0} in group {1}, unable to change current playing item.", request.Type, context.GroupId.ToString()); + Logger.LogDebug("HandleRequest: {RequestType} in group {GroupId}, unable to change current playing item.", request.Type, context.GroupId.ToString()); } } @@ -214,13 +214,13 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates // Reset status of sessions and await for all Ready events. context.SetAllBuffering(true); - Logger.LogDebug("HandleRequest: {0} in group {1}, waiting for all ready events.", request.Type, context.GroupId.ToString()); + Logger.LogDebug("HandleRequest: {RequestType} in group {GroupId}, waiting for all ready events.", request.Type, context.GroupId.ToString()); } else { if (ResumePlaying) { - Logger.LogDebug("HandleRequest: {0} in group {1}, ignoring sessions that are not ready and forcing the playback to start.", request.Type, context.GroupId.ToString()); + Logger.LogDebug("HandleRequest: {RequestType} in group {GroupId}, ignoring sessions that are not ready and forcing the playback to start.", request.Type, context.GroupId.ToString()); // An Unpause request is forcing the playback to start, ignoring sessions that are not ready. context.SetAllBuffering(false); @@ -326,7 +326,7 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates // Make sure the client is playing the correct item. if (!request.PlaylistItemId.Equals(context.PlayQueue.GetPlayingItemPlaylistId(), StringComparison.OrdinalIgnoreCase)) { - Logger.LogDebug("HandleRequest: {0} in group {1}, {2} has wrong playlist item.", request.Type, context.GroupId.ToString(), session.Id); + Logger.LogDebug("HandleRequest: {RequestType} in group {GroupId}, {SessionId} has wrong playlist item.", request.Type, context.GroupId.ToString(), session.Id); var playQueueUpdate = context.GetPlayQueueUpdate(PlayQueueUpdateReason.SetCurrentItem); var updateSession = context.NewSyncPlayGroupUpdate(GroupUpdateType.PlayQueue, playQueueUpdate); @@ -400,7 +400,7 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates // Make sure the client is playing the correct item. if (!request.PlaylistItemId.Equals(context.PlayQueue.GetPlayingItemPlaylistId(), StringComparison.OrdinalIgnoreCase)) { - Logger.LogDebug("HandleRequest: {0} in group {1}, {2} has wrong playlist item.", request.Type, context.GroupId.ToString(), session.Id); + Logger.LogDebug("HandleRequest: {RequestType} in group {GroupId}, {SessionId} has wrong playlist item.", request.Type, context.GroupId.ToString(), session.Id); var playQueueUpdate = context.GetPlayQueueUpdate(PlayQueueUpdateReason.SetCurrentItem); var update = context.NewSyncPlayGroupUpdate(GroupUpdateType.PlayQueue, playQueueUpdate); @@ -420,7 +420,7 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates var timeSyncThresholdTicks = TimeSpan.FromMilliseconds(context.TimeSyncOffset).Ticks; if (Math.Abs(elapsedTime.Ticks) > timeSyncThresholdTicks) { - Logger.LogWarning("HandleRequest: {0} in group {1}, {2} is not time syncing properly. Ignoring elapsed time.", request.Type, context.GroupId.ToString(), session.Id); + Logger.LogWarning("HandleRequest: {RequestType} in group {GroupId}, {SessionId} is not time syncing properly. Ignoring elapsed time.", request.Type, context.GroupId.ToString(), session.Id); elapsedTime = TimeSpan.Zero; } @@ -436,7 +436,7 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates var delayTicks = context.PositionTicks - clientPosition.Ticks; var maxPlaybackOffsetTicks = TimeSpan.FromMilliseconds(context.MaxPlaybackOffset).Ticks; - Logger.LogDebug("HandleRequest: {0} in group {1}, {2} at {3} (delay of {4} seconds).", request.Type, context.GroupId.ToString(), session.Id, clientPosition, TimeSpan.FromTicks(delayTicks).TotalSeconds); + Logger.LogDebug("HandleRequest: {RequestType} in group {GroupId}, {SessionId} at {PositionTicks} (delay of {Delay} seconds).", request.Type, context.GroupId.ToString(), session.Id, clientPosition, TimeSpan.FromTicks(delayTicks).TotalSeconds); if (ResumePlaying) { @@ -454,7 +454,7 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates // Notify relevant state change event. SendGroupStateUpdate(context, request, session, cancellationToken); - Logger.LogWarning("HandleRequest: {0} in group {1}, {2} got lost in time, correcting.", request.Type, context.GroupId.ToString(), session.Id); + Logger.LogWarning("HandleRequest: {RequestType} in group {GroupId}, {SessionId} got lost in time, correcting.", request.Type, context.GroupId.ToString(), session.Id); return; } @@ -468,7 +468,7 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates command.When = currentTime.AddTicks(delayTicks); context.SendCommand(session, SyncPlayBroadcastType.CurrentSession, command, cancellationToken); - Logger.LogInformation("HandleRequest: {0} in group {1}, others still buffering, {2} will pause when ready in {3} seconds.", request.Type, context.GroupId.ToString(), session.Id, TimeSpan.FromTicks(delayTicks).TotalSeconds); + Logger.LogInformation("HandleRequest: {RequestType} in group {GroupId}, others still buffering, {SessionId} will pause when ready in {Delay} seconds.", request.Type, context.GroupId.ToString(), session.Id, TimeSpan.FromTicks(delayTicks).TotalSeconds); } else { @@ -487,7 +487,7 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates context.SendCommand(session, filter, command, cancellationToken); - Logger.LogInformation("HandleRequest: {0} in group {1}, {2} is recovering, notifying others to resume in {3} seconds.", request.Type, context.GroupId.ToString(), session.Id, TimeSpan.FromTicks(delayTicks).TotalSeconds); + Logger.LogInformation("HandleRequest: {RequestType} in group {GroupId}, {SessionId} is recovering, notifying others to resume in {Delay} seconds.", request.Type, context.GroupId.ToString(), session.Id, TimeSpan.FromTicks(delayTicks).TotalSeconds); } else { @@ -500,7 +500,7 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates var command = context.NewSyncPlayCommand(SendCommandType.Unpause); context.SendCommand(session, SyncPlayBroadcastType.AllGroup, command, cancellationToken); - Logger.LogWarning("HandleRequest: {0} in group {1}, {2} resumed playback but did not update others in time. {3} seconds to recover.", request.Type, context.GroupId.ToString(), session.Id, TimeSpan.FromTicks(delayTicks).TotalSeconds); + Logger.LogWarning("HandleRequest: {RequestType} in group {GroupId}, {SessionId} resumed playback but did not update others in time. {Delay} seconds to recover.", request.Type, context.GroupId.ToString(), session.Id, TimeSpan.FromTicks(delayTicks).TotalSeconds); } // Change state. @@ -511,7 +511,7 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates } else { - // Check that session is really ready, tollerate player imperfections under a certain threshold. + // Check that session is really ready, tolerate player imperfections under a certain threshold. if (Math.Abs(context.PositionTicks - requestTicks) > maxPlaybackOffsetTicks) { // Session still not ready. @@ -523,7 +523,7 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates // Notify relevant state change event. SendGroupStateUpdate(context, request, session, cancellationToken); - Logger.LogWarning("HandleRequest: {0} in group {1}, {2} was seeking to wrong position, correcting.", request.Type, context.GroupId.ToString(), session.Id); + Logger.LogWarning("HandleRequest: {RequestType} in group {GroupId}, {SessionId} is seeking to wrong position, correcting.", request.Type, context.GroupId.ToString(), session.Id); return; } else @@ -549,7 +549,7 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates pausedState.HandleRequest(context, Type, request, session, cancellationToken); } - Logger.LogDebug("HandleRequest: {0} in group {1}, {2} is ready, returning to previous state.", request.Type, context.GroupId.ToString(), session.Id); + Logger.LogDebug("HandleRequest: {RequestType} in group {GroupId}, {SessionId} is ready, returning to previous state.", request.Type, context.GroupId.ToString(), session.Id); } } } @@ -569,7 +569,7 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates // Make sure the client knows the playing item, to avoid duplicate requests. if (!request.PlaylistItemId.Equals(context.PlayQueue.GetPlayingItemPlaylistId(), StringComparison.OrdinalIgnoreCase)) { - Logger.LogDebug("HandleRequest: {0} in group {1}, client provided the wrong playlist identifier.", request.Type, context.GroupId.ToString()); + Logger.LogDebug("HandleRequest: {RequestType} in group {GroupId}, {SessionId} provided the wrong playlist identifier.", request.Type, context.GroupId.ToString(), session.Id); return; } @@ -596,7 +596,7 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates context.SetState(newState); - Logger.LogDebug("HandleRequest: {0} in group {1}, no next track available.", request.Type, context.GroupId.ToString()); + Logger.LogDebug("HandleRequest: {RequestType} in group {GroupId}, no next track available.", request.Type, context.GroupId.ToString()); } } @@ -615,7 +615,7 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates // Make sure the client knows the playing item, to avoid duplicate requests. if (!request.PlaylistItemId.Equals(context.PlayQueue.GetPlayingItemPlaylistId(), StringComparison.OrdinalIgnoreCase)) { - Logger.LogDebug("HandleRequest: {0} in group {1}, client provided the wrong playlist identifier.", request.Type, context.GroupId.ToString()); + Logger.LogDebug("HandleRequest: {RequestType} in group {GroupId}, {SessionId} provided the wrong playlist identifier.", request.Type, context.GroupId.ToString(), session.Id); return; } @@ -642,7 +642,7 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates context.SetState(newState); - Logger.LogDebug("HandleRequest: {0} in group {1}, no previous track available.", request.Type, context.GroupId.ToString()); + Logger.LogDebug("HandleRequest: {RequestType} in group {GroupId}, no previous track available.", request.Type, context.GroupId.ToString()); } } @@ -653,7 +653,7 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates if (!context.IsBuffering()) { - Logger.LogDebug("HandleRequest: {0} in group {1}, returning to previous state.", request.Type, context.GroupId.ToString()); + Logger.LogDebug("HandleRequest: {RequestType} in group {GroupId}, returning to previous state.", request.Type, context.GroupId.ToString()); if (ResumePlaying) { diff --git a/MediaBrowser.Controller/SyncPlay/IGroupStateContext.cs b/MediaBrowser.Controller/SyncPlay/IGroupStateContext.cs index 3609be36b7..13f1b23169 100644 --- a/MediaBrowser.Controller/SyncPlay/IGroupStateContext.cs +++ b/MediaBrowser.Controller/SyncPlay/IGroupStateContext.cs @@ -151,7 +151,7 @@ namespace MediaBrowser.Controller.SyncPlay /// The playing item position in the play queue. /// The start position ticks. /// true if the play queue has been changed; false if something went wrong. - bool SetPlayQueue(IEnumerable playQueue, int playingItemPosition, long startPositionTicks); + bool SetPlayQueue(IReadOnlyList playQueue, int playingItemPosition, long startPositionTicks); /// /// Sets the playing item. @@ -165,7 +165,7 @@ namespace MediaBrowser.Controller.SyncPlay /// /// The items to remove. /// true if playing item got removed; false otherwise. - bool RemoveFromPlayQueue(IEnumerable playlistItemIds); + bool RemoveFromPlayQueue(IReadOnlyList playlistItemIds); /// /// Moves an item in the play queue. @@ -181,7 +181,7 @@ namespace MediaBrowser.Controller.SyncPlay /// The new items to add to the play queue. /// The mode with which the items will be added. /// true if the play queue has been changed; false if something went wrong. - bool AddToPlayQueue(IEnumerable newItems, GroupQueueMode mode); + bool AddToPlayQueue(IReadOnlyList newItems, GroupQueueMode mode); /// /// Restarts current item in play queue. diff --git a/MediaBrowser.Controller/SyncPlay/ISyncPlayManager.cs b/MediaBrowser.Controller/SyncPlay/ISyncPlayManager.cs index 65146d4ae8..a980016827 100644 --- a/MediaBrowser.Controller/SyncPlay/ISyncPlayManager.cs +++ b/MediaBrowser.Controller/SyncPlay/ISyncPlayManager.cs @@ -49,21 +49,5 @@ namespace MediaBrowser.Controller.SyncPlay /// The request. /// The cancellation token. void HandleRequest(SessionInfo session, IGroupPlaybackRequest request, CancellationToken cancellationToken); - - /// - /// Maps a session to a group. - /// - /// The session. - /// The group. - /// Thrown when the user is in another group already. - void AddSessionToGroup(SessionInfo session, IGroupController group); - - /// - /// Unmaps a session from a group. - /// - /// The session. - /// The group. - /// Thrown when the user is not found in the specified group. - void RemoveSessionFromGroup(SessionInfo session, IGroupController group); } } diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/PlayGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/PlayGroupRequest.cs index 306c161ed9..7d27f61518 100644 --- a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/PlayGroupRequest.cs +++ b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/PlayGroupRequest.cs @@ -19,9 +19,7 @@ namespace MediaBrowser.Controller.SyncPlay.PlaybackRequests /// The start position ticks. public PlayGroupRequest(Guid[] playingQueue, int playingItemPosition, long startPositionTicks) { - var list = new List(); - list.AddRange(playingQueue); - PlayingQueue = list; + PlayingQueue = playingQueue ?? Array.Empty(); PlayingItemPosition = playingItemPosition; StartPositionTicks = startPositionTicks; } diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/QueueGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/QueueGroupRequest.cs index 9580b53154..106daecc8c 100644 --- a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/QueueGroupRequest.cs +++ b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/QueueGroupRequest.cs @@ -18,9 +18,7 @@ namespace MediaBrowser.Controller.SyncPlay.PlaybackRequests /// The enqueue mode. public QueueGroupRequest(Guid[] items, GroupQueueMode mode) { - var list = new List(); - list.AddRange(items); - ItemIds = list; + ItemIds = items ?? Array.Empty(); Mode = mode; } diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/RemoveFromPlaylistGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/RemoveFromPlaylistGroupRequest.cs index 21c602846e..1e892d8196 100644 --- a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/RemoveFromPlaylistGroupRequest.cs +++ b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/RemoveFromPlaylistGroupRequest.cs @@ -1,3 +1,4 @@ +using System; using System.Collections.Generic; using System.Threading; using MediaBrowser.Controller.Session; @@ -16,9 +17,7 @@ namespace MediaBrowser.Controller.SyncPlay.PlaybackRequests /// The playlist ids of the items to remove. public RemoveFromPlaylistGroupRequest(string[] items) { - var list = new List(); - list.AddRange(items); - PlaylistItemIds = list; + PlaylistItemIds = items ?? Array.Empty(); } /// diff --git a/MediaBrowser.Controller/SyncPlay/Queue/PlayQueueManager.cs b/MediaBrowser.Controller/SyncPlay/Queue/PlayQueueManager.cs index 2d1d1533b9..73457f4471 100644 --- a/MediaBrowser.Controller/SyncPlay/Queue/PlayQueueManager.cs +++ b/MediaBrowser.Controller/SyncPlay/Queue/PlayQueueManager.cs @@ -94,7 +94,7 @@ namespace MediaBrowser.Controller.SyncPlay.Queue /// Sets a new playlist. Playing item is reset. /// /// The new items of the playlist. - public void SetPlaylist(IEnumerable items) + public void SetPlaylist(IReadOnlyList items) { SortedPlaylist.Clear(); ShuffledPlaylist.Clear(); @@ -114,7 +114,7 @@ namespace MediaBrowser.Controller.SyncPlay.Queue /// Appends new items to the playlist. The specified order is mantained. /// /// The items to add to the playlist. - public void Queue(IEnumerable items) + public void Queue(IReadOnlyList items) { var newItems = CreateQueueItemsFromArray(items); @@ -209,7 +209,7 @@ namespace MediaBrowser.Controller.SyncPlay.Queue /// Adds new items to the playlist right after the playing item. The specified order is mantained. /// /// The items to add to the playlist. - public void QueueNext(IEnumerable items) + public void QueueNext(IReadOnlyList items) { var newItems = CreateQueueItemsFromArray(items); @@ -312,13 +312,12 @@ namespace MediaBrowser.Controller.SyncPlay.Queue /// /// The items to remove. /// true if playing item got removed; false otherwise. - public bool RemoveFromPlaylist(IEnumerable playlistItemIds) + public bool RemoveFromPlaylist(IReadOnlyList playlistItemIds) { var playingItem = GetPlayingItem(); - var playlistItemIdsList = playlistItemIds.ToList(); - SortedPlaylist.RemoveAll(item => playlistItemIdsList.Contains(item.PlaylistItemId)); - ShuffledPlaylist.RemoveAll(item => playlistItemIdsList.Contains(item.PlaylistItemId)); + SortedPlaylist.RemoveAll(item => playlistItemIds.Contains(item.PlaylistItemId)); + ShuffledPlaylist.RemoveAll(item => playlistItemIds.Contains(item.PlaylistItemId)); LastChange = DateTime.UtcNow; @@ -369,8 +368,7 @@ namespace MediaBrowser.Controller.SyncPlay.Queue var queueItem = playlist[oldIndex]; playlist.RemoveAt(oldIndex); - newIndex = Math.Min(newIndex, playlist.Count); - newIndex = Math.Max(newIndex, 0); + newIndex = Math.Clamp(newIndex, 0, playlist.Count); playlist.Insert(newIndex, queueItem); LastChange = DateTime.UtcNow; @@ -489,7 +487,7 @@ namespace MediaBrowser.Controller.SyncPlay.Queue } else { - PlayingItemIndex--; + PlayingItemIndex = SortedPlaylist.Count - 1; return false; } } @@ -519,7 +517,7 @@ namespace MediaBrowser.Controller.SyncPlay.Queue } else { - PlayingItemIndex++; + PlayingItemIndex = 0; return false; } } @@ -558,7 +556,7 @@ namespace MediaBrowser.Controller.SyncPlay.Queue /// Creates a list from the array of items. Each item is given an unique playlist identifier. /// /// The list of queue items. - private List CreateQueueItemsFromArray(IEnumerable items) + private List CreateQueueItemsFromArray(IReadOnlyList items) { var list = new List(); foreach (var item in items) diff --git a/MediaBrowser.Model/SyncPlay/GroupInfoDto.cs b/MediaBrowser.Model/SyncPlay/GroupInfoDto.cs index 16a75eb68e..8c0960b830 100644 --- a/MediaBrowser.Model/SyncPlay/GroupInfoDto.cs +++ b/MediaBrowser.Model/SyncPlay/GroupInfoDto.cs @@ -11,41 +11,48 @@ namespace MediaBrowser.Model.SyncPlay /// /// Initializes a new instance of the class. /// - public GroupInfoDto() + /// The group identifier. + /// The group name. + /// The group state. + /// The participants. + /// The date when this DTO has been created. + public GroupInfoDto(Guid groupId, string groupName, GroupStateType state, IReadOnlyList participants, DateTime lastUpdatedAt) { - GroupId = string.Empty; - GroupName = string.Empty; - Participants = new List(); + GroupId = groupId; + GroupName = groupName; + State = state; + Participants = participants; + LastUpdatedAt = lastUpdatedAt; } /// - /// Gets or sets the group identifier. + /// Gets the group identifier. /// /// The group identifier. - public string GroupId { get; set; } + public Guid GroupId { get; } /// - /// Gets or sets the group name. + /// Gets the group name. /// /// The group name. - public string GroupName { get; set; } + public string GroupName { get; } /// - /// Gets or sets the group state. + /// Gets the group state. /// /// The group state. - public GroupStateType State { get; set; } + public GroupStateType State { get; } /// - /// Gets or sets the participants. + /// Gets the participants. /// /// The participants. - public IReadOnlyList Participants { get; set; } + public IReadOnlyList Participants { get; } /// - /// Gets or sets the date when this dto has been updated. + /// Gets the date when this DTO has been created. /// - /// The date when this dto has been updated. - public DateTime LastUpdatedAt { get; set; } + /// The date when this DTO has been created. + public DateTime LastUpdatedAt { get; } } } diff --git a/MediaBrowser.Model/SyncPlay/GroupStateUpdate.cs b/MediaBrowser.Model/SyncPlay/GroupStateUpdate.cs index 532b5a56f4..7f7deb86bb 100644 --- a/MediaBrowser.Model/SyncPlay/GroupStateUpdate.cs +++ b/MediaBrowser.Model/SyncPlay/GroupStateUpdate.cs @@ -6,15 +6,26 @@ namespace MediaBrowser.Model.SyncPlay public class GroupStateUpdate { /// - /// Gets or sets the state of the group. + /// Initializes a new instance of the class. + /// + /// The state of the group. + /// The reason of the state change. + public GroupStateUpdate(GroupStateType state, PlaybackRequestType reason) + { + State = state; + Reason = reason; + } + + /// + /// Gets the state of the group. /// /// The state of the group. - public GroupStateType State { get; set; } + public GroupStateType State { get; } /// - /// Gets or sets the reason of the state change. + /// Gets the reason of the state change. /// /// The reason of the state change. - public PlaybackRequestType Reason { get; set; } + public PlaybackRequestType Reason { get; } } } diff --git a/MediaBrowser.Model/SyncPlay/GroupUpdate.cs b/MediaBrowser.Model/SyncPlay/GroupUpdate.cs index 12d6058ac3..6f159d653c 100644 --- a/MediaBrowser.Model/SyncPlay/GroupUpdate.cs +++ b/MediaBrowser.Model/SyncPlay/GroupUpdate.cs @@ -1,4 +1,4 @@ -#nullable disable +using System; namespace MediaBrowser.Model.SyncPlay { @@ -9,21 +9,34 @@ namespace MediaBrowser.Model.SyncPlay public class GroupUpdate { /// - /// Gets or sets the group identifier. + /// Initializes a new instance of the class. + /// + /// The group identifier. + /// The update type. + /// The update data. + public GroupUpdate(Guid groupId, GroupUpdateType type, T data) + { + GroupId = groupId; + Type = type; + Data = data; + } + + /// + /// Gets the group identifier. /// /// The group identifier. - public string GroupId { get; set; } + public Guid GroupId { get; } /// - /// Gets or sets the update type. + /// Gets the update type. /// /// The update type. - public GroupUpdateType Type { get; set; } + public GroupUpdateType Type { get; } /// - /// Gets or sets the data. + /// Gets the update data. /// - /// The data. - public T Data { get; set; } + /// The update data. + public T Data { get; } } } diff --git a/MediaBrowser.Model/SyncPlay/JoinGroupRequest.cs b/MediaBrowser.Model/SyncPlay/JoinGroupRequest.cs index 27a29b8998..7402c4ce29 100644 --- a/MediaBrowser.Model/SyncPlay/JoinGroupRequest.cs +++ b/MediaBrowser.Model/SyncPlay/JoinGroupRequest.cs @@ -8,9 +8,18 @@ namespace MediaBrowser.Model.SyncPlay public class JoinGroupRequest { /// - /// Gets or sets the group identifier. + /// Initializes a new instance of the class. + /// + /// The identifier of the group to join. + public JoinGroupRequest(Guid groupId) + { + GroupId = groupId; + } + + /// + /// Gets the group identifier. /// /// The identifier of the group to join. - public Guid GroupId { get; set; } + public Guid GroupId { get; } } } diff --git a/MediaBrowser.Model/SyncPlay/NewGroupRequest.cs b/MediaBrowser.Model/SyncPlay/NewGroupRequest.cs index eb61a68d15..ba4bd3ef1c 100644 --- a/MediaBrowser.Model/SyncPlay/NewGroupRequest.cs +++ b/MediaBrowser.Model/SyncPlay/NewGroupRequest.cs @@ -8,15 +8,16 @@ namespace MediaBrowser.Model.SyncPlay /// /// Initializes a new instance of the class. /// - public NewGroupRequest() + /// The name of the new group. + public NewGroupRequest(string groupName) { - GroupName = string.Empty; + GroupName = groupName; } /// - /// Gets or sets the group name. + /// Gets the group name. /// /// The name of the new group. - public string GroupName { get; set; } + public string GroupName { get; } } } diff --git a/MediaBrowser.Model/SyncPlay/PlayQueueUpdate.cs b/MediaBrowser.Model/SyncPlay/PlayQueueUpdate.cs index d193b4c663..a851229f74 100644 --- a/MediaBrowser.Model/SyncPlay/PlayQueueUpdate.cs +++ b/MediaBrowser.Model/SyncPlay/PlayQueueUpdate.cs @@ -11,51 +11,64 @@ namespace MediaBrowser.Model.SyncPlay /// /// Initializes a new instance of the class. /// - public PlayQueueUpdate() + /// The reason for the update. + /// The UTC time of the last change to the playing queue. + /// The playlist. + /// The playing item index in the playlist. + /// The start position ticks. + /// The shuffle mode. + /// The repeat mode. + public PlayQueueUpdate(PlayQueueUpdateReason reason, DateTime lastUpdate, IReadOnlyList playlist, int playingItemIndex, long startPositionTicks, GroupShuffleMode shuffleMode, GroupRepeatMode repeatMode) { - Playlist = new List(); + Reason = reason; + LastUpdate = lastUpdate; + Playlist = playlist; + PlayingItemIndex = playingItemIndex; + StartPositionTicks = startPositionTicks; + ShuffleMode = shuffleMode; + RepeatMode = repeatMode; } /// - /// Gets or sets the request type that originated this update. + /// Gets the request type that originated this update. /// /// The reason for the update. - public PlayQueueUpdateReason Reason { get; set; } + public PlayQueueUpdateReason Reason { get; } /// - /// Gets or sets the UTC time of the last change to the playing queue. + /// Gets the UTC time of the last change to the playing queue. /// /// The UTC time of the last change to the playing queue. - public DateTime LastUpdate { get; set; } + public DateTime LastUpdate { get; } /// - /// Gets or sets the playlist. + /// Gets the playlist. /// /// The playlist. - public IReadOnlyList Playlist { get; set; } + public IReadOnlyList Playlist { get; } /// - /// Gets or sets the playing item index in the playlist. + /// Gets the playing item index in the playlist. /// /// The playing item index in the playlist. - public int PlayingItemIndex { get; set; } + public int PlayingItemIndex { get; } /// - /// Gets or sets the start position ticks. + /// Gets the start position ticks. /// /// The start position ticks. - public long StartPositionTicks { get; set; } + public long StartPositionTicks { get; } /// - /// Gets or sets the shuffle mode. + /// Gets the shuffle mode. /// /// The shuffle mode. - public GroupShuffleMode ShuffleMode { get; set; } + public GroupShuffleMode ShuffleMode { get; } /// - /// Gets or sets the repeat mode. + /// Gets the repeat mode. /// /// The repeat mode. - public GroupRepeatMode RepeatMode { get; set; } + public GroupRepeatMode RepeatMode { get; } } } diff --git a/MediaBrowser.Model/SyncPlay/SendCommand.cs b/MediaBrowser.Model/SyncPlay/SendCommand.cs index a3aa54b380..ab4c64130c 100644 --- a/MediaBrowser.Model/SyncPlay/SendCommand.cs +++ b/MediaBrowser.Model/SyncPlay/SendCommand.cs @@ -10,23 +10,33 @@ namespace MediaBrowser.Model.SyncPlay /// /// Initializes a new instance of the class. /// - public SendCommand() + /// The group identifier. + /// The playlist identifier of the playing item. + /// The UTC time when to execute the command. + /// The command. + /// The position ticks, for commands that require it. + /// The UTC time when this command has been emitted. + public SendCommand(Guid groupId, string playlistItemId, DateTime when, SendCommandType command, long? positionTicks, DateTime emittedAt) { - GroupId = string.Empty; - PlaylistItemId = string.Empty; + GroupId = groupId; + PlaylistItemId = playlistItemId; + When = when; + Command = command; + PositionTicks = positionTicks; + EmittedAt = emittedAt; } /// - /// Gets or sets the group identifier. + /// Gets the group identifier. /// /// The group identifier. - public string GroupId { get; set; } + public Guid GroupId { get; } /// - /// Gets or sets the playlist identifier of the playing item. + /// Gets the playlist identifier of the playing item. /// /// The playlist identifier of the playing item. - public string PlaylistItemId { get; set; } + public string PlaylistItemId { get; } /// /// Gets or sets the UTC time when to execute the command. @@ -35,21 +45,21 @@ namespace MediaBrowser.Model.SyncPlay public DateTime When { get; set; } /// - /// Gets or sets the position ticks. + /// Gets the position ticks. /// /// The position ticks. - public long? PositionTicks { get; set; } + public long? PositionTicks { get; } /// - /// Gets or sets the command. + /// Gets the command. /// /// The command. - public SendCommandType Command { get; set; } + public SendCommandType Command { get; } /// - /// Gets or sets the UTC time when this command has been emitted. + /// Gets the UTC time when this command has been emitted. /// /// The UTC time when this command has been emitted. - public DateTime EmittedAt { get; set; } + public DateTime EmittedAt { get; } } } diff --git a/MediaBrowser.Model/SyncPlay/UtcTimeResponse.cs b/MediaBrowser.Model/SyncPlay/UtcTimeResponse.cs index 8ec5eaab3b..219e7b1e0c 100644 --- a/MediaBrowser.Model/SyncPlay/UtcTimeResponse.cs +++ b/MediaBrowser.Model/SyncPlay/UtcTimeResponse.cs @@ -1,4 +1,4 @@ -#nullable disable +using System; namespace MediaBrowser.Model.SyncPlay { @@ -8,15 +8,26 @@ namespace MediaBrowser.Model.SyncPlay public class UtcTimeResponse { /// - /// Gets or sets the UTC time when request has been received. + /// Initializes a new instance of the class. + /// + /// The UTC time when request has been received. + /// The UTC time when response has been sent. + public UtcTimeResponse(DateTime requestReceptionTime, DateTime responseTransmissionTime) + { + RequestReceptionTime = requestReceptionTime; + ResponseTransmissionTime = responseTransmissionTime; + } + + /// + /// Gets the UTC time when request has been received. /// /// The UTC time when request has been received. - public string RequestReceptionTime { get; set; } + public DateTime RequestReceptionTime { get; } /// - /// Gets or sets the UTC time when response has been sent. + /// Gets the UTC time when response has been sent. /// /// The UTC time when response has been sent. - public string ResponseTransmissionTime { get; set; } + public DateTime ResponseTransmissionTime { get; } } } -- cgit v1.2.3 From a3ca36cb54a3e6e743fbcf90f19f0d76ba71aebc Mon Sep 17 00:00:00 2001 From: Ionut Andrei Oanca Date: Mon, 16 Nov 2020 17:40:19 +0100 Subject: Review logging and minor changes in SyncPlay --- .../SyncPlay/GroupController.cs | 83 +++++++++-------- .../SyncPlay/SyncPlayManager.cs | 28 +++--- MediaBrowser.Controller/SyncPlay/GroupMember.cs | 13 ++- .../SyncPlay/GroupStates/AbstractGroupState.cs | 28 +++--- .../SyncPlay/GroupStates/IdleGroupState.cs | 21 +++-- .../SyncPlay/GroupStates/PausedGroupState.cs | 29 +++--- .../SyncPlay/GroupStates/PlayingGroupState.cs | 29 +++--- .../SyncPlay/GroupStates/WaitingGroupState.cs | 103 +++++++++++---------- .../SyncPlay/Queue/PlayQueueManager.cs | 32 ++----- 9 files changed, 200 insertions(+), 166 deletions(-) (limited to 'MediaBrowser.Controller/SyncPlay/Queue') diff --git a/Emby.Server.Implementations/SyncPlay/GroupController.cs b/Emby.Server.Implementations/SyncPlay/GroupController.cs index 48596bb421..4efc671ffa 100644 --- a/Emby.Server.Implementations/SyncPlay/GroupController.cs +++ b/Emby.Server.Implementations/SyncPlay/GroupController.cs @@ -28,7 +28,12 @@ namespace Emby.Server.Implementations.SyncPlay /// /// The logger. /// - private readonly ILogger _logger; + private readonly ILogger _logger; + + /// + /// The logger factory. + /// + private readonly ILoggerFactory _loggerFactory; /// /// The user manager. @@ -45,6 +50,12 @@ namespace Emby.Server.Implementations.SyncPlay /// private readonly ILibraryManager _libraryManager; + /// + /// The participants, or members of the group. + /// + private readonly Dictionary _participants = + new Dictionary(StringComparer.OrdinalIgnoreCase); + /// /// Internal group state. /// @@ -54,37 +65,41 @@ namespace Emby.Server.Implementations.SyncPlay /// /// Initializes a new instance of the class. /// - /// The logger. + /// The logger factory. /// The user manager. /// The session manager. /// The library manager. public GroupController( - ILogger logger, + ILoggerFactory loggerFactory, IUserManager userManager, ISessionManager sessionManager, ILibraryManager libraryManager) { - _logger = logger; + _loggerFactory = loggerFactory; _userManager = userManager; _sessionManager = sessionManager; _libraryManager = libraryManager; + _logger = loggerFactory.CreateLogger(); - _state = new IdleGroupState(_logger); + _state = new IdleGroupState(loggerFactory); } /// /// Gets the default ping value used for sessions. /// + /// The default ping. public long DefaultPing { get; } = 500; /// /// Gets the maximum time offset error accepted for dates reported by clients, in milliseconds. /// + /// The maximum time offset error. public long TimeSyncOffset { get; } = 2000; /// /// Gets the maximum offset error accepted for position reported by clients, in milliseconds. /// + /// The maximum offset error. public long MaxPlaybackOffset { get; } = 500; /// @@ -123,24 +138,16 @@ namespace Emby.Server.Implementations.SyncPlay /// The last activity. public DateTime LastActivity { get; set; } - /// - /// Gets the participants. - /// - /// The participants, or members of the group. - public Dictionary Participants { get; } = - new Dictionary(StringComparer.OrdinalIgnoreCase); - /// /// Adds the session to the group. /// /// The session. private void AddSession(SessionInfo session) { - Participants.TryAdd( + _participants.TryAdd( session.Id, - new GroupMember + new GroupMember(session) { - Session = session, Ping = DefaultPing, IsBuffering = false }); @@ -152,7 +159,7 @@ namespace Emby.Server.Implementations.SyncPlay /// The session. private void RemoveSession(SessionInfo session) { - Participants.Remove(session.Id); + _participants.Remove(session.Id); } /// @@ -166,14 +173,14 @@ namespace Emby.Server.Implementations.SyncPlay return type switch { SyncPlayBroadcastType.CurrentSession => new SessionInfo[] { from }, - SyncPlayBroadcastType.AllGroup => Participants + SyncPlayBroadcastType.AllGroup => _participants .Values .Select(session => session.Session), - SyncPlayBroadcastType.AllExceptCurrentSession => Participants + SyncPlayBroadcastType.AllExceptCurrentSession => _participants .Values .Select(session => session.Session) .Where(session => !session.Id.Equals(from.Id, StringComparison.OrdinalIgnoreCase)), - SyncPlayBroadcastType.AllReady => Participants + SyncPlayBroadcastType.AllReady => _participants .Values .Where(session => !session.IsBuffering) .Select(session => session.Session), @@ -204,7 +211,7 @@ namespace Emby.Server.Implementations.SyncPlay private bool HasAccessToQueue(User user, IReadOnlyList queue) { // Check if queue is empty. - if (!queue?.Any() ?? true) + if (queue == null || queue.Count == 0) { return true; } @@ -229,13 +236,13 @@ namespace Emby.Server.Implementations.SyncPlay private bool AllUsersHaveAccessToQueue(IReadOnlyList queue) { // Check if queue is empty. - if (!queue?.Any() ?? true) + if (queue == null || queue.Count == 0) { return true; } // Get list of users. - var users = Participants + var users = _participants .Values .Select(participant => _userManager.GetUserById(participant.Session.UserId)); @@ -247,7 +254,7 @@ namespace Emby.Server.Implementations.SyncPlay } /// - public bool IsGroupEmpty() => Participants.Count == 0; + public bool IsGroupEmpty() => _participants.Count == 0; /// public void CreateGroup(SessionInfo session, NewGroupRequest request, CancellationToken cancellationToken) @@ -268,8 +275,8 @@ namespace Emby.Server.Implementations.SyncPlay RunTimeTicks = session.FullNowPlayingItem.RunTimeTicks ?? 0; PositionTicks = session.PlayState.PositionTicks ?? 0; - // Mantain playstate. - var waitingState = new WaitingGroupState(_logger) + // Maintain playstate. + var waitingState = new WaitingGroupState(_loggerFactory) { ResumePlaying = !session.PlayState.IsPaused }; @@ -281,7 +288,7 @@ namespace Emby.Server.Implementations.SyncPlay _state.SessionJoined(this, _state.Type, session, cancellationToken); - _logger.LogInformation("InitGroup: {SessionId} created group {GroupId}.", session.Id, GroupId.ToString()); + _logger.LogInformation("Session {SessionId} created group {GroupId}.", session.Id, GroupId.ToString()); } /// @@ -297,7 +304,7 @@ namespace Emby.Server.Implementations.SyncPlay _state.SessionJoined(this, _state.Type, session, cancellationToken); - _logger.LogInformation("SessionJoin: {SessionId} joined group {GroupId}.", session.Id, GroupId.ToString()); + _logger.LogInformation("Session {SessionId} joined group {GroupId}.", session.Id, GroupId.ToString()); } /// @@ -311,7 +318,7 @@ namespace Emby.Server.Implementations.SyncPlay _state.SessionJoined(this, _state.Type, session, cancellationToken); - _logger.LogInformation("SessionRestore: {SessionId} re-joined group {GroupId}.", session.Id, GroupId.ToString()); + _logger.LogInformation("Session {SessionId} re-joined group {GroupId}.", session.Id, GroupId.ToString()); } /// @@ -327,7 +334,7 @@ namespace Emby.Server.Implementations.SyncPlay var updateOthers = NewSyncPlayGroupUpdate(GroupUpdateType.UserLeft, session.UserName); SendGroupUpdate(session, SyncPlayBroadcastType.AllExceptCurrentSession, updateOthers, cancellationToken); - _logger.LogInformation("SessionLeave: {SessionId} left group {GroupId}.", session.Id, GroupId.ToString()); + _logger.LogInformation("Session {SessionId} left group {GroupId}.", session.Id, GroupId.ToString()); } /// @@ -336,14 +343,14 @@ namespace Emby.Server.Implementations.SyncPlay // The server's job is to maintain a consistent state for clients to reference // and notify clients of state changes. The actual syncing of media playback // happens client side. Clients are aware of the server's time and use it to sync. - _logger.LogInformation("HandleRequest: {SessionId} requested {RequestType}, group {GroupId} is {StateType}.", session.Id, request.Type, GroupId.ToString(), _state.Type); + _logger.LogInformation("Session {SessionId} requested {RequestType} in group {GroupId} that is {StateType}.", session.Id, request.Type, GroupId.ToString(), _state.Type); request.Apply(this, _state, session, cancellationToken); } /// public GroupInfoDto GetInfo() { - var participants = Participants.Values.Select(session => session.Session.UserName).Distinct().ToList(); + var participants = _participants.Values.Select(session => session.Session.UserName).Distinct().ToList(); return new GroupInfoDto(GroupId, GroupName, _state.Type, participants, DateTime.UtcNow); } @@ -357,7 +364,7 @@ namespace Emby.Server.Implementations.SyncPlay /// public void SetIgnoreGroupWait(SessionInfo session, bool ignoreGroupWait) { - if (Participants.TryGetValue(session.Id, out GroupMember value)) + if (_participants.TryGetValue(session.Id, out GroupMember value)) { value.IgnoreGroupWait = ignoreGroupWait; } @@ -366,7 +373,7 @@ namespace Emby.Server.Implementations.SyncPlay /// public void SetState(IGroupState state) { - _logger.LogInformation("SetState: {GroupId} switching from {FromStateType} to {ToStateType}.", GroupId.ToString(), _state.Type, state.Type); + _logger.LogInformation("Group {GroupId} switching from {FromStateType} to {ToStateType}.", GroupId.ToString(), _state.Type, state.Type); this._state = state; } @@ -426,7 +433,7 @@ namespace Emby.Server.Implementations.SyncPlay /// public void UpdatePing(SessionInfo session, long ping) { - if (Participants.TryGetValue(session.Id, out GroupMember value)) + if (_participants.TryGetValue(session.Id, out GroupMember value)) { value.Ping = ping; } @@ -436,7 +443,7 @@ namespace Emby.Server.Implementations.SyncPlay public long GetHighestPing() { long max = long.MinValue; - foreach (var session in Participants.Values) + foreach (var session in _participants.Values) { max = Math.Max(max, session.Ping); } @@ -447,7 +454,7 @@ namespace Emby.Server.Implementations.SyncPlay /// public void SetBuffering(SessionInfo session, bool isBuffering) { - if (Participants.TryGetValue(session.Id, out GroupMember value)) + if (_participants.TryGetValue(session.Id, out GroupMember value)) { value.IsBuffering = isBuffering; } @@ -456,7 +463,7 @@ namespace Emby.Server.Implementations.SyncPlay /// public void SetAllBuffering(bool isBuffering) { - foreach (var session in Participants.Values) + foreach (var session in _participants.Values) { session.IsBuffering = isBuffering; } @@ -465,7 +472,7 @@ namespace Emby.Server.Implementations.SyncPlay /// public bool IsBuffering() { - foreach (var session in Participants.Values) + foreach (var session in _participants.Values) { if (session.IsBuffering && !session.IgnoreGroupWait) { diff --git a/Emby.Server.Implementations/SyncPlay/SyncPlayManager.cs b/Emby.Server.Implementations/SyncPlay/SyncPlayManager.cs index ee75580cc1..fdaa12a04a 100644 --- a/Emby.Server.Implementations/SyncPlay/SyncPlayManager.cs +++ b/Emby.Server.Implementations/SyncPlay/SyncPlayManager.cs @@ -21,6 +21,11 @@ namespace Emby.Server.Implementations.SyncPlay /// private readonly ILogger _logger; + /// + /// The logger factory. + /// + private readonly ILoggerFactory _loggerFactory; + /// /// The user manager. /// @@ -58,20 +63,21 @@ namespace Emby.Server.Implementations.SyncPlay /// /// Initializes a new instance of the class. /// - /// The logger. + /// The logger factory. /// The user manager. /// The session manager. /// The library manager. public SyncPlayManager( - ILogger logger, + ILoggerFactory loggerFactory, IUserManager userManager, ISessionManager sessionManager, ILibraryManager libraryManager) { - _logger = logger; + _loggerFactory = loggerFactory; _userManager = userManager; _sessionManager = sessionManager; _libraryManager = libraryManager; + _logger = loggerFactory.CreateLogger(); _sessionManager.SessionStarted += OnSessionManagerSessionStarted; } @@ -98,7 +104,7 @@ namespace Emby.Server.Implementations.SyncPlay LeaveGroup(session, cancellationToken); } - var group = new GroupController(_logger, _userManager, _sessionManager, _libraryManager); + var group = new GroupController(_loggerFactory, _userManager, _sessionManager, _libraryManager); _groups[group.GroupId] = group; AddSessionToGroup(session, group); @@ -123,7 +129,7 @@ namespace Emby.Server.Implementations.SyncPlay if (group == null) { - _logger.LogWarning("JoinGroup: {SessionId} tried to join group {GroupId} that does not exist.", session.Id, groupId); + _logger.LogWarning("Session {SessionId} tried to join group {GroupId} that does not exist.", session.Id, groupId); var error = new GroupUpdate(Guid.Empty, GroupUpdateType.GroupDoesNotExist, string.Empty); _sessionManager.SendSyncPlayGroupUpdate(session, error, CancellationToken.None); @@ -132,7 +138,7 @@ namespace Emby.Server.Implementations.SyncPlay if (!group.HasAccessToPlayQueue(user)) { - _logger.LogWarning("JoinGroup: {SessionId} does not have access to some content from the playing queue of group {GroupId}.", session.Id, group.GroupId.ToString()); + _logger.LogWarning("Session {SessionId} tried to join group {GroupId} but does not have access to some content of the playing queue.", session.Id, group.GroupId.ToString()); var error = new GroupUpdate(group.GroupId, GroupUpdateType.LibraryAccessDenied, string.Empty); _sessionManager.SendSyncPlayGroupUpdate(session, error, CancellationToken.None); @@ -171,7 +177,7 @@ namespace Emby.Server.Implementations.SyncPlay if (group == null) { - _logger.LogWarning("LeaveGroup: {SessionId} does not belong to any group.", session.Id); + _logger.LogWarning("Session {SessionId} does not belong to any group.", session.Id); var error = new GroupUpdate(Guid.Empty, GroupUpdateType.NotInGroup, string.Empty); _sessionManager.SendSyncPlayGroupUpdate(session, error, CancellationToken.None); @@ -183,7 +189,7 @@ namespace Emby.Server.Implementations.SyncPlay if (group.IsGroupEmpty()) { - _logger.LogInformation("LeaveGroup: removing empty group {GroupId}.", group.GroupId); + _logger.LogInformation("Group {GroupId} is empty, removing it.", group.GroupId); _groups.Remove(group.GroupId, out _); } } @@ -225,7 +231,7 @@ namespace Emby.Server.Implementations.SyncPlay if (group == null) { - _logger.LogWarning("HandleRequest: {SessionId} does not belong to any group.", session.Id); + _logger.LogWarning("Session {SessionId} does not belong to any group.", session.Id); var error = new GroupUpdate(Guid.Empty, GroupUpdateType.NotInGroup, string.Empty); _sessionManager.SendSyncPlayGroupUpdate(session, error, CancellationToken.None); @@ -370,7 +376,7 @@ namespace Emby.Server.Implementations.SyncPlay if (user.SyncPlayAccess == SyncPlayAccess.None) { - _logger.LogWarning("IsRequestValid: {SessionId} does not have access to SyncPlay. Requested {RequestType}.", session.Id, requestType); + _logger.LogWarning("Session {SessionId} requested {RequestType} but does not have access to SyncPlay.", session.Id, requestType); // TODO: rename to a more generic error. Next PR will fix this. var error = new GroupUpdate(Guid.Empty, GroupUpdateType.JoinGroupDenied, string.Empty); @@ -380,7 +386,7 @@ namespace Emby.Server.Implementations.SyncPlay if (requestType.Equals(GroupRequestType.NewGroup) && user.SyncPlayAccess != SyncPlayAccess.CreateAndJoinGroups) { - _logger.LogWarning("IsRequestValid: {SessionId} does not have permission to create groups.", session.Id); + _logger.LogWarning("Session {SessionId} does not have permission to create groups.", session.Id); var error = new GroupUpdate(Guid.Empty, GroupUpdateType.CreateGroupDenied, string.Empty); _sessionManager.SendSyncPlayGroupUpdate(session, error, CancellationToken.None); diff --git a/MediaBrowser.Controller/SyncPlay/GroupMember.cs b/MediaBrowser.Controller/SyncPlay/GroupMember.cs index 9a9d30277f..5fb982e85a 100644 --- a/MediaBrowser.Controller/SyncPlay/GroupMember.cs +++ b/MediaBrowser.Controller/SyncPlay/GroupMember.cs @@ -8,10 +8,19 @@ namespace MediaBrowser.Controller.SyncPlay public class GroupMember { /// - /// Gets or sets the session. + /// Initializes a new instance of the class. + /// + /// The session. + public GroupMember(SessionInfo session) + { + Session = session; + } + + /// + /// Gets the session. /// /// The session. - public SessionInfo Session { get; set; } + public SessionInfo Session { get; } /// /// Gets or sets the ping, in milliseconds. diff --git a/MediaBrowser.Controller/SyncPlay/GroupStates/AbstractGroupState.cs b/MediaBrowser.Controller/SyncPlay/GroupStates/AbstractGroupState.cs index e5da0ef40f..057488d6b4 100644 --- a/MediaBrowser.Controller/SyncPlay/GroupStates/AbstractGroupState.cs +++ b/MediaBrowser.Controller/SyncPlay/GroupStates/AbstractGroupState.cs @@ -14,22 +14,28 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates /// public abstract class AbstractGroupState : IGroupState { + /// + /// The logger. + /// + private readonly ILogger _logger; + /// /// Initializes a new instance of the class. /// - /// Instance of the interface. - protected AbstractGroupState(ILogger logger) + /// Instance of the interface. + protected AbstractGroupState(ILoggerFactory loggerFactory) { - Logger = logger; + LoggerFactory = loggerFactory; + _logger = loggerFactory.CreateLogger(); } /// public abstract GroupStateType Type { get; } /// - /// Gets the logger. + /// Gets the logger factory. /// - protected ILogger Logger { get; } + protected ILoggerFactory LoggerFactory { get; } /// public abstract void SessionJoined(IGroupStateContext context, GroupStateType prevState, SessionInfo session, CancellationToken cancellationToken); @@ -52,7 +58,7 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates /// public virtual void HandleRequest(IGroupStateContext context, GroupStateType prevState, SetPlaylistItemGroupRequest request, SessionInfo session, CancellationToken cancellationToken) { - var waitingState = new WaitingGroupState(Logger); + var waitingState = new WaitingGroupState(LoggerFactory); context.SetState(waitingState); waitingState.HandleRequest(context, Type, request, session, cancellationToken); } @@ -68,9 +74,9 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates if (playingItemRemoved && !context.PlayQueue.IsItemPlaying()) { - Logger.LogDebug("HandleRequest: {RequestType} in group {GroupId}, play queue is empty.", request.Type, context.GroupId.ToString()); + _logger.LogDebug("Play queue in group {GroupId} is now empty.", context.GroupId.ToString()); - IGroupState idleState = new IdleGroupState(Logger); + IGroupState idleState = new IdleGroupState(LoggerFactory); context.SetState(idleState); var stopRequest = new StopGroupRequest(); idleState.HandleRequest(context, Type, stopRequest, session, cancellationToken); @@ -84,7 +90,7 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates if (!result) { - Logger.LogError("HandleRequest: {RequestType} in group {GroupId}, unable to move item in play queue.", request.Type, context.GroupId.ToString()); + _logger.LogError("Unable to move item in group {GroupId}.", context.GroupId.ToString()); return; } @@ -100,7 +106,7 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates if (!result) { - Logger.LogError("HandleRequest: {RequestType} in group {GroupId}, unable to add items to play queue.", request.Type, context.GroupId.ToString()); + _logger.LogError("Unable to add items to play queue in group {GroupId}.", context.GroupId.ToString()); return; } @@ -210,7 +216,7 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates private void UnhandledRequest(IGroupPlaybackRequest request) { - Logger.LogWarning("HandleRequest: unhandled {RequestType} request in {StateType} state.", request.Type, Type); + _logger.LogWarning("Unhandled request of type {RequestType} in {StateType} state.", request.Type, Type); } } } diff --git a/MediaBrowser.Controller/SyncPlay/GroupStates/IdleGroupState.cs b/MediaBrowser.Controller/SyncPlay/GroupStates/IdleGroupState.cs index 660afb607d..7730a298c2 100644 --- a/MediaBrowser.Controller/SyncPlay/GroupStates/IdleGroupState.cs +++ b/MediaBrowser.Controller/SyncPlay/GroupStates/IdleGroupState.cs @@ -14,14 +14,19 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates /// public class IdleGroupState : AbstractGroupState { + /// + /// The logger. + /// + private readonly ILogger _logger; + /// /// Initializes a new instance of the class. /// - /// Instance of the interface. - public IdleGroupState(ILogger logger) - : base(logger) + /// Instance of the interface. + public IdleGroupState(ILoggerFactory loggerFactory) + : base(loggerFactory) { - // Do nothing. + _logger = LoggerFactory.CreateLogger(); } /// @@ -43,7 +48,7 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates public override void HandleRequest(IGroupStateContext context, GroupStateType prevState, PlayGroupRequest request, SessionInfo session, CancellationToken cancellationToken) { // Change state. - var waitingState = new WaitingGroupState(Logger); + var waitingState = new WaitingGroupState(LoggerFactory); context.SetState(waitingState); waitingState.HandleRequest(context, Type, request, session, cancellationToken); } @@ -52,7 +57,7 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates public override void HandleRequest(IGroupStateContext context, GroupStateType prevState, UnpauseGroupRequest request, SessionInfo session, CancellationToken cancellationToken) { // Change state. - var waitingState = new WaitingGroupState(Logger); + var waitingState = new WaitingGroupState(LoggerFactory); context.SetState(waitingState); waitingState.HandleRequest(context, Type, request, session, cancellationToken); } @@ -91,7 +96,7 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates public override void HandleRequest(IGroupStateContext context, GroupStateType prevState, NextTrackGroupRequest request, SessionInfo session, CancellationToken cancellationToken) { // Change state. - var waitingState = new WaitingGroupState(Logger); + var waitingState = new WaitingGroupState(LoggerFactory); context.SetState(waitingState); waitingState.HandleRequest(context, Type, request, session, cancellationToken); } @@ -100,7 +105,7 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates public override void HandleRequest(IGroupStateContext context, GroupStateType prevState, PreviousTrackGroupRequest request, SessionInfo session, CancellationToken cancellationToken) { // Change state. - var waitingState = new WaitingGroupState(Logger); + var waitingState = new WaitingGroupState(LoggerFactory); context.SetState(waitingState); waitingState.HandleRequest(context, Type, request, session, cancellationToken); } diff --git a/MediaBrowser.Controller/SyncPlay/GroupStates/PausedGroupState.cs b/MediaBrowser.Controller/SyncPlay/GroupStates/PausedGroupState.cs index 29942898e6..90411f61bc 100644 --- a/MediaBrowser.Controller/SyncPlay/GroupStates/PausedGroupState.cs +++ b/MediaBrowser.Controller/SyncPlay/GroupStates/PausedGroupState.cs @@ -15,14 +15,19 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates /// public class PausedGroupState : AbstractGroupState { + /// + /// The logger. + /// + private readonly ILogger _logger; + /// /// Initializes a new instance of the class. /// - /// Instance of the interface. - public PausedGroupState(ILogger logger) - : base(logger) + /// Instance of the interface. + public PausedGroupState(ILoggerFactory loggerFactory) + : base(loggerFactory) { - // Do nothing. + _logger = LoggerFactory.CreateLogger(); } /// @@ -32,7 +37,7 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates public override void SessionJoined(IGroupStateContext context, GroupStateType prevState, SessionInfo session, CancellationToken cancellationToken) { // Wait for session to be ready. - var waitingState = new WaitingGroupState(Logger); + var waitingState = new WaitingGroupState(LoggerFactory); context.SetState(waitingState); waitingState.SessionJoined(context, Type, session, cancellationToken); } @@ -47,7 +52,7 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates public override void HandleRequest(IGroupStateContext context, GroupStateType prevState, PlayGroupRequest request, SessionInfo session, CancellationToken cancellationToken) { // Change state. - var waitingState = new WaitingGroupState(Logger); + var waitingState = new WaitingGroupState(LoggerFactory); context.SetState(waitingState); waitingState.HandleRequest(context, Type, request, session, cancellationToken); } @@ -56,7 +61,7 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates public override void HandleRequest(IGroupStateContext context, GroupStateType prevState, UnpauseGroupRequest request, SessionInfo session, CancellationToken cancellationToken) { // Change state. - var playingState = new PlayingGroupState(Logger); + var playingState = new PlayingGroupState(LoggerFactory); context.SetState(playingState); playingState.HandleRequest(context, Type, request, session, cancellationToken); } @@ -96,7 +101,7 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates public override void HandleRequest(IGroupStateContext context, GroupStateType prevState, StopGroupRequest request, SessionInfo session, CancellationToken cancellationToken) { // Change state. - var idleState = new IdleGroupState(Logger); + var idleState = new IdleGroupState(LoggerFactory); context.SetState(idleState); idleState.HandleRequest(context, Type, request, session, cancellationToken); } @@ -105,7 +110,7 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates public override void HandleRequest(IGroupStateContext context, GroupStateType prevState, SeekGroupRequest request, SessionInfo session, CancellationToken cancellationToken) { // Change state. - var waitingState = new WaitingGroupState(Logger); + var waitingState = new WaitingGroupState(LoggerFactory); context.SetState(waitingState); waitingState.HandleRequest(context, Type, request, session, cancellationToken); } @@ -114,7 +119,7 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates public override void HandleRequest(IGroupStateContext context, GroupStateType prevState, BufferGroupRequest request, SessionInfo session, CancellationToken cancellationToken) { // Change state. - var waitingState = new WaitingGroupState(Logger); + var waitingState = new WaitingGroupState(LoggerFactory); context.SetState(waitingState); waitingState.HandleRequest(context, Type, request, session, cancellationToken); } @@ -143,7 +148,7 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates public override void HandleRequest(IGroupStateContext context, GroupStateType prevState, NextTrackGroupRequest request, SessionInfo session, CancellationToken cancellationToken) { // Change state. - var waitingState = new WaitingGroupState(Logger); + var waitingState = new WaitingGroupState(LoggerFactory); context.SetState(waitingState); waitingState.HandleRequest(context, Type, request, session, cancellationToken); } @@ -152,7 +157,7 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates public override void HandleRequest(IGroupStateContext context, GroupStateType prevState, PreviousTrackGroupRequest request, SessionInfo session, CancellationToken cancellationToken) { // Change state. - var waitingState = new WaitingGroupState(Logger); + var waitingState = new WaitingGroupState(LoggerFactory); context.SetState(waitingState); waitingState.HandleRequest(context, Type, request, session, cancellationToken); } diff --git a/MediaBrowser.Controller/SyncPlay/GroupStates/PlayingGroupState.cs b/MediaBrowser.Controller/SyncPlay/GroupStates/PlayingGroupState.cs index c5d73dedb8..aab87d9c39 100644 --- a/MediaBrowser.Controller/SyncPlay/GroupStates/PlayingGroupState.cs +++ b/MediaBrowser.Controller/SyncPlay/GroupStates/PlayingGroupState.cs @@ -15,14 +15,19 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates /// public class PlayingGroupState : AbstractGroupState { + /// + /// The logger. + /// + private readonly ILogger _logger; + /// /// Initializes a new instance of the class. /// - /// Instance of the interface. - public PlayingGroupState(ILogger logger) - : base(logger) + /// Instance of the interface. + public PlayingGroupState(ILoggerFactory loggerFactory) + : base(loggerFactory) { - // Do nothing. + _logger = LoggerFactory.CreateLogger(); } /// @@ -37,7 +42,7 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates public override void SessionJoined(IGroupStateContext context, GroupStateType prevState, SessionInfo session, CancellationToken cancellationToken) { // Wait for session to be ready. - var waitingState = new WaitingGroupState(Logger); + var waitingState = new WaitingGroupState(LoggerFactory); context.SetState(waitingState); waitingState.SessionJoined(context, Type, session, cancellationToken); } @@ -52,7 +57,7 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates public override void HandleRequest(IGroupStateContext context, GroupStateType prevState, PlayGroupRequest request, SessionInfo session, CancellationToken cancellationToken) { // Change state. - var waitingState = new WaitingGroupState(Logger); + var waitingState = new WaitingGroupState(LoggerFactory); context.SetState(waitingState); waitingState.HandleRequest(context, Type, request, session, cancellationToken); } @@ -89,7 +94,7 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates public override void HandleRequest(IGroupStateContext context, GroupStateType prevState, PauseGroupRequest request, SessionInfo session, CancellationToken cancellationToken) { // Change state. - var pausedState = new PausedGroupState(Logger); + var pausedState = new PausedGroupState(LoggerFactory); context.SetState(pausedState); pausedState.HandleRequest(context, Type, request, session, cancellationToken); } @@ -98,7 +103,7 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates public override void HandleRequest(IGroupStateContext context, GroupStateType prevState, StopGroupRequest request, SessionInfo session, CancellationToken cancellationToken) { // Change state. - var idleState = new IdleGroupState(Logger); + var idleState = new IdleGroupState(LoggerFactory); context.SetState(idleState); idleState.HandleRequest(context, Type, request, session, cancellationToken); } @@ -107,7 +112,7 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates public override void HandleRequest(IGroupStateContext context, GroupStateType prevState, SeekGroupRequest request, SessionInfo session, CancellationToken cancellationToken) { // Change state. - var waitingState = new WaitingGroupState(Logger); + var waitingState = new WaitingGroupState(LoggerFactory); context.SetState(waitingState); waitingState.HandleRequest(context, Type, request, session, cancellationToken); } @@ -121,7 +126,7 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates } // Change state. - var waitingState = new WaitingGroupState(Logger); + var waitingState = new WaitingGroupState(LoggerFactory); context.SetState(waitingState); waitingState.HandleRequest(context, Type, request, session, cancellationToken); } @@ -146,7 +151,7 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates public override void HandleRequest(IGroupStateContext context, GroupStateType prevState, NextTrackGroupRequest request, SessionInfo session, CancellationToken cancellationToken) { // Change state. - var waitingState = new WaitingGroupState(Logger); + var waitingState = new WaitingGroupState(LoggerFactory); context.SetState(waitingState); waitingState.HandleRequest(context, Type, request, session, cancellationToken); } @@ -155,7 +160,7 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates public override void HandleRequest(IGroupStateContext context, GroupStateType prevState, PreviousTrackGroupRequest request, SessionInfo session, CancellationToken cancellationToken) { // Change state. - var waitingState = new WaitingGroupState(Logger); + var waitingState = new WaitingGroupState(LoggerFactory); context.SetState(waitingState); waitingState.HandleRequest(context, Type, request, session, cancellationToken); } diff --git a/MediaBrowser.Controller/SyncPlay/GroupStates/WaitingGroupState.cs b/MediaBrowser.Controller/SyncPlay/GroupStates/WaitingGroupState.cs index e33e711fb7..fefb8067fe 100644 --- a/MediaBrowser.Controller/SyncPlay/GroupStates/WaitingGroupState.cs +++ b/MediaBrowser.Controller/SyncPlay/GroupStates/WaitingGroupState.cs @@ -15,14 +15,19 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates /// public class WaitingGroupState : AbstractGroupState { + /// + /// The logger. + /// + private readonly ILogger _logger; + /// /// Initializes a new instance of the class. /// - /// Instance of the interface. - public WaitingGroupState(ILogger logger) - : base(logger) + /// Instance of the interface. + public WaitingGroupState(ILoggerFactory loggerFactory) + : base(loggerFactory) { - // Do nothing. + _logger = LoggerFactory.CreateLogger(); } /// @@ -97,21 +102,21 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates { if (ResumePlaying) { + _logger.LogDebug("Session {SessionId} left group {GroupId}, notifying others to resume.", session.Id, context.GroupId.ToString()); + // Client, that was buffering, left the group. - var playingState = new PlayingGroupState(Logger); + var playingState = new PlayingGroupState(LoggerFactory); context.SetState(playingState); var unpauseRequest = new UnpauseGroupRequest(); playingState.HandleRequest(context, Type, unpauseRequest, session, cancellationToken); - - Logger.LogDebug("SessionLeaving: {SessionId} left group {GroupId}, notifying others to resume.", session.Id, context.GroupId.ToString()); } else { + _logger.LogDebug("Session {SessionId} left group {GroupId}, returning to previous state.", session.Id, context.GroupId.ToString()); + // Group is ready, returning to previous state. - var pausedState = new PausedGroupState(Logger); + var pausedState = new PausedGroupState(LoggerFactory); context.SetState(pausedState); - - Logger.LogDebug("SessionLeaving: {SessionId} left group {GroupId}, returning to previous state.", session.Id, context.GroupId.ToString()); } } } @@ -131,13 +136,13 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates var setQueueStatus = context.SetPlayQueue(request.PlayingQueue, request.PlayingItemPosition, request.StartPositionTicks); if (!setQueueStatus) { - Logger.LogError("HandleRequest: {RequestType} in group {GroupId}, unable to set playing queue.", request.Type, context.GroupId.ToString()); + _logger.LogError("Unable to set playing queue in group {GroupId}.", context.GroupId.ToString()); // Ignore request and return to previous state. IGroupState newState = prevState switch { - GroupStateType.Playing => new PlayingGroupState(Logger), - GroupStateType.Paused => new PausedGroupState(Logger), - _ => new IdleGroupState(Logger) + GroupStateType.Playing => new PlayingGroupState(LoggerFactory), + GroupStateType.Paused => new PausedGroupState(LoggerFactory), + _ => new IdleGroupState(LoggerFactory) }; context.SetState(newState); @@ -151,7 +156,7 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates // Reset status of sessions and await for all Ready events. context.SetAllBuffering(true); - Logger.LogDebug("HandleRequest: {RequestType} in group {GroupId}, {SessionId} set a new play queue.", request.Type, context.GroupId.ToString(), session.Id); + _logger.LogDebug("Session {SessionId} set a new play queue in group {GroupId}.", session.Id, context.GroupId.ToString()); } /// @@ -181,14 +186,14 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates // Return to old state. IGroupState newState = prevState switch { - GroupStateType.Playing => new PlayingGroupState(Logger), - GroupStateType.Paused => new PausedGroupState(Logger), - _ => new IdleGroupState(Logger) + GroupStateType.Playing => new PlayingGroupState(LoggerFactory), + GroupStateType.Paused => new PausedGroupState(LoggerFactory), + _ => new IdleGroupState(LoggerFactory) }; context.SetState(newState); - Logger.LogDebug("HandleRequest: {RequestType} in group {GroupId}, unable to change current playing item.", request.Type, context.GroupId.ToString()); + _logger.LogDebug("Unable to change current playing item in group {GroupId}.", context.GroupId.ToString()); } } @@ -214,19 +219,19 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates // Reset status of sessions and await for all Ready events. context.SetAllBuffering(true); - Logger.LogDebug("HandleRequest: {RequestType} in group {GroupId}, waiting for all ready events.", request.Type, context.GroupId.ToString()); + _logger.LogDebug("Group {GroupId} is waiting for all ready events.", context.GroupId.ToString()); } else { if (ResumePlaying) { - Logger.LogDebug("HandleRequest: {RequestType} in group {GroupId}, ignoring sessions that are not ready and forcing the playback to start.", request.Type, context.GroupId.ToString()); + _logger.LogDebug("Forcing the playback to start in group {GroupId}. Group-wait is disabled until next state change.", context.GroupId.ToString()); // An Unpause request is forcing the playback to start, ignoring sessions that are not ready. context.SetAllBuffering(false); // Change state. - var playingState = new PlayingGroupState(Logger) + var playingState = new PlayingGroupState(LoggerFactory) { IgnoreBuffering = true }; @@ -272,7 +277,7 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates } // Change state. - var idleState = new IdleGroupState(Logger); + var idleState = new IdleGroupState(LoggerFactory); context.SetState(idleState); idleState.HandleRequest(context, Type, request, session, cancellationToken); } @@ -326,7 +331,7 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates // Make sure the client is playing the correct item. if (!request.PlaylistItemId.Equals(context.PlayQueue.GetPlayingItemPlaylistId(), StringComparison.OrdinalIgnoreCase)) { - Logger.LogDebug("HandleRequest: {RequestType} in group {GroupId}, {SessionId} has wrong playlist item.", request.Type, context.GroupId.ToString(), session.Id); + _logger.LogDebug("Session {SessionId} reported wrong playlist item in group {GroupId}.", session.Id, context.GroupId.ToString()); var playQueueUpdate = context.GetPlayQueueUpdate(PlayQueueUpdateReason.SetCurrentItem); var updateSession = context.NewSyncPlayGroupUpdate(GroupUpdateType.PlayQueue, playQueueUpdate); @@ -400,7 +405,7 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates // Make sure the client is playing the correct item. if (!request.PlaylistItemId.Equals(context.PlayQueue.GetPlayingItemPlaylistId(), StringComparison.OrdinalIgnoreCase)) { - Logger.LogDebug("HandleRequest: {RequestType} in group {GroupId}, {SessionId} has wrong playlist item.", request.Type, context.GroupId.ToString(), session.Id); + _logger.LogDebug("Session {SessionId} reported wrong playlist item in group {GroupId}.", session.Id, context.GroupId.ToString()); var playQueueUpdate = context.GetPlayQueueUpdate(PlayQueueUpdateReason.SetCurrentItem); var update = context.NewSyncPlayGroupUpdate(GroupUpdateType.PlayQueue, playQueueUpdate); @@ -420,7 +425,7 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates var timeSyncThresholdTicks = TimeSpan.FromMilliseconds(context.TimeSyncOffset).Ticks; if (Math.Abs(elapsedTime.Ticks) > timeSyncThresholdTicks) { - Logger.LogWarning("HandleRequest: {RequestType} in group {GroupId}, {SessionId} is not time syncing properly. Ignoring elapsed time.", request.Type, context.GroupId.ToString(), session.Id); + _logger.LogWarning("Session {SessionId} is not time syncing properly. Ignoring elapsed time.", session.Id); elapsedTime = TimeSpan.Zero; } @@ -436,7 +441,7 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates var delayTicks = context.PositionTicks - clientPosition.Ticks; var maxPlaybackOffsetTicks = TimeSpan.FromMilliseconds(context.MaxPlaybackOffset).Ticks; - Logger.LogDebug("HandleRequest: {RequestType} in group {GroupId}, {SessionId} at {PositionTicks} (delay of {Delay} seconds).", request.Type, context.GroupId.ToString(), session.Id, clientPosition, TimeSpan.FromTicks(delayTicks).TotalSeconds); + _logger.LogDebug("Session {SessionId} is at {PositionTicks} (delay of {Delay} seconds) in group {GroupId}.", session.Id, clientPosition, TimeSpan.FromTicks(delayTicks).TotalSeconds, context.GroupId.ToString()); if (ResumePlaying) { @@ -454,7 +459,7 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates // Notify relevant state change event. SendGroupStateUpdate(context, request, session, cancellationToken); - Logger.LogWarning("HandleRequest: {RequestType} in group {GroupId}, {SessionId} got lost in time, correcting.", request.Type, context.GroupId.ToString(), session.Id); + _logger.LogWarning("Session {SessionId} got lost in time, correcting.", session.Id); return; } @@ -468,7 +473,7 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates command.When = currentTime.AddTicks(delayTicks); context.SendCommand(session, SyncPlayBroadcastType.CurrentSession, command, cancellationToken); - Logger.LogInformation("HandleRequest: {RequestType} in group {GroupId}, others still buffering, {SessionId} will pause when ready in {Delay} seconds.", request.Type, context.GroupId.ToString(), session.Id, TimeSpan.FromTicks(delayTicks).TotalSeconds); + _logger.LogInformation("Session {SessionId} will pause when ready in {Delay} seconds. Group {GroupId} is waiting for all ready events.", session.Id, TimeSpan.FromTicks(delayTicks).TotalSeconds, context.GroupId.ToString()); } else { @@ -487,7 +492,7 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates context.SendCommand(session, filter, command, cancellationToken); - Logger.LogInformation("HandleRequest: {RequestType} in group {GroupId}, {SessionId} is recovering, notifying others to resume in {Delay} seconds.", request.Type, context.GroupId.ToString(), session.Id, TimeSpan.FromTicks(delayTicks).TotalSeconds); + _logger.LogInformation("Session {SessionId} is recovering, group {GroupId} will resume in {Delay} seconds.", session.Id, context.GroupId.ToString(), TimeSpan.FromTicks(delayTicks).TotalSeconds); } else { @@ -500,11 +505,11 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates var command = context.NewSyncPlayCommand(SendCommandType.Unpause); context.SendCommand(session, SyncPlayBroadcastType.AllGroup, command, cancellationToken); - Logger.LogWarning("HandleRequest: {RequestType} in group {GroupId}, {SessionId} resumed playback but did not update others in time. {Delay} seconds to recover.", request.Type, context.GroupId.ToString(), session.Id, TimeSpan.FromTicks(delayTicks).TotalSeconds); + _logger.LogWarning("Session {SessionId} resumed playback, group {GroupId} has {Delay} seconds to recover.", session.Id, context.GroupId.ToString(), TimeSpan.FromTicks(delayTicks).TotalSeconds); } // Change state. - var playingState = new PlayingGroupState(Logger); + var playingState = new PlayingGroupState(LoggerFactory); context.SetState(playingState); playingState.HandleRequest(context, Type, request, session, cancellationToken); } @@ -523,7 +528,7 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates // Notify relevant state change event. SendGroupStateUpdate(context, request, session, cancellationToken); - Logger.LogWarning("HandleRequest: {RequestType} in group {GroupId}, {SessionId} is seeking to wrong position, correcting.", request.Type, context.GroupId.ToString(), session.Id); + _logger.LogWarning("Session {SessionId} is seeking to wrong position, correcting.", session.Id); return; } else @@ -534,8 +539,10 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates if (!context.IsBuffering()) { + _logger.LogDebug("Session {SessionId} is ready, group {GroupId} is ready.", session.Id, context.GroupId.ToString()); + // Group is ready, returning to previous state. - var pausedState = new PausedGroupState(Logger); + var pausedState = new PausedGroupState(LoggerFactory); context.SetState(pausedState); if (InitialState.Equals(GroupStateType.Playing)) @@ -548,8 +555,6 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates { pausedState.HandleRequest(context, Type, request, session, cancellationToken); } - - Logger.LogDebug("HandleRequest: {RequestType} in group {GroupId}, {SessionId} is ready, returning to previous state.", request.Type, context.GroupId.ToString(), session.Id); } } } @@ -569,7 +574,7 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates // Make sure the client knows the playing item, to avoid duplicate requests. if (!request.PlaylistItemId.Equals(context.PlayQueue.GetPlayingItemPlaylistId(), StringComparison.OrdinalIgnoreCase)) { - Logger.LogDebug("HandleRequest: {RequestType} in group {GroupId}, {SessionId} provided the wrong playlist identifier.", request.Type, context.GroupId.ToString(), session.Id); + _logger.LogDebug("Session {SessionId} provided the wrong playlist item for group {GroupId}.", session.Id, context.GroupId.ToString()); return; } @@ -589,14 +594,14 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates // Return to old state. IGroupState newState = prevState switch { - GroupStateType.Playing => new PlayingGroupState(Logger), - GroupStateType.Paused => new PausedGroupState(Logger), - _ => new IdleGroupState(Logger) + GroupStateType.Playing => new PlayingGroupState(LoggerFactory), + GroupStateType.Paused => new PausedGroupState(LoggerFactory), + _ => new IdleGroupState(LoggerFactory) }; context.SetState(newState); - Logger.LogDebug("HandleRequest: {RequestType} in group {GroupId}, no next track available.", request.Type, context.GroupId.ToString()); + _logger.LogDebug("No next track available in group {GroupId}.", context.GroupId.ToString()); } } @@ -615,7 +620,7 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates // Make sure the client knows the playing item, to avoid duplicate requests. if (!request.PlaylistItemId.Equals(context.PlayQueue.GetPlayingItemPlaylistId(), StringComparison.OrdinalIgnoreCase)) { - Logger.LogDebug("HandleRequest: {RequestType} in group {GroupId}, {SessionId} provided the wrong playlist identifier.", request.Type, context.GroupId.ToString(), session.Id); + _logger.LogDebug("Session {SessionId} provided the wrong playlist item for group {GroupId}.", session.Id, context.GroupId.ToString()); return; } @@ -635,14 +640,14 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates // Return to old state. IGroupState newState = prevState switch { - GroupStateType.Playing => new PlayingGroupState(Logger), - GroupStateType.Paused => new PausedGroupState(Logger), - _ => new IdleGroupState(Logger) + GroupStateType.Playing => new PlayingGroupState(LoggerFactory), + GroupStateType.Paused => new PausedGroupState(LoggerFactory), + _ => new IdleGroupState(LoggerFactory) }; context.SetState(newState); - Logger.LogDebug("HandleRequest: {RequestType} in group {GroupId}, no previous track available.", request.Type, context.GroupId.ToString()); + _logger.LogDebug("No previous track available in group {GroupId}.", context.GroupId.ToString()); } } @@ -653,12 +658,12 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates if (!context.IsBuffering()) { - Logger.LogDebug("HandleRequest: {RequestType} in group {GroupId}, returning to previous state.", request.Type, context.GroupId.ToString()); + _logger.LogDebug("Ignoring session {SessionId}, group {GroupId} is ready.", session.Id, context.GroupId.ToString()); if (ResumePlaying) { // Client, that was buffering, stopped following playback. - var playingState = new PlayingGroupState(Logger); + var playingState = new PlayingGroupState(LoggerFactory); context.SetState(playingState); var unpauseRequest = new UnpauseGroupRequest(); playingState.HandleRequest(context, Type, unpauseRequest, session, cancellationToken); @@ -666,7 +671,7 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates else { // Group is ready, returning to previous state. - var pausedState = new PausedGroupState(Logger); + var pausedState = new PausedGroupState(LoggerFactory); context.SetState(pausedState); } } diff --git a/MediaBrowser.Controller/SyncPlay/Queue/PlayQueueManager.cs b/MediaBrowser.Controller/SyncPlay/Queue/PlayQueueManager.cs index 73457f4471..bfb9d1e4c1 100644 --- a/MediaBrowser.Controller/SyncPlay/Queue/PlayQueueManager.cs +++ b/MediaBrowser.Controller/SyncPlay/Queue/PlayQueueManager.cs @@ -20,7 +20,7 @@ namespace MediaBrowser.Controller.SyncPlay.Queue /// Random number generator used to shuffle lists. /// /// The random number generator. - private readonly Random randomNumberGenerator = new Random(); + private readonly Random _randomNumberGenerator = new Random(); /// /// Initializes a new instance of the class. @@ -102,7 +102,7 @@ namespace MediaBrowser.Controller.SyncPlay.Queue SortedPlaylist = CreateQueueItemsFromArray(items); if (ShuffleMode.Equals(GroupShuffleMode.Shuffle)) { - ShuffledPlaylist = SortedPlaylist.ToList(); + ShuffledPlaylist = new List(SortedPlaylist); Shuffle(ShuffledPlaylist); } @@ -134,17 +134,17 @@ namespace MediaBrowser.Controller.SyncPlay.Queue { if (PlayingItemIndex == NoPlayingItemIndex) { - ShuffledPlaylist = SortedPlaylist.ToList(); + ShuffledPlaylist = new List(SortedPlaylist); Shuffle(ShuffledPlaylist); } else if (ShuffleMode.Equals(GroupShuffleMode.Sorted)) { // First time shuffle. var playingItem = SortedPlaylist[PlayingItemIndex]; - ShuffledPlaylist = SortedPlaylist.ToList(); + ShuffledPlaylist = new List(SortedPlaylist); ShuffledPlaylist.RemoveAt(PlayingItemIndex); Shuffle(ShuffledPlaylist); - ShuffledPlaylist = ShuffledPlaylist.Prepend(playingItem).ToList(); + ShuffledPlaylist.Insert(0, playingItem); PlayingItemIndex = 0; } else @@ -153,7 +153,7 @@ namespace MediaBrowser.Controller.SyncPlay.Queue var playingItem = ShuffledPlaylist[PlayingItemIndex]; ShuffledPlaylist.RemoveAt(PlayingItemIndex); Shuffle(ShuffledPlaylist); - ShuffledPlaylist = ShuffledPlaylist.Prepend(playingItem).ToList(); + ShuffledPlaylist.Insert(0, playingItem); PlayingItemIndex = 0; } @@ -236,14 +236,7 @@ namespace MediaBrowser.Controller.SyncPlay.Queue public string GetPlayingItemPlaylistId() { var playingItem = GetPlayingItem(); - if (playingItem != null) - { - return playingItem.PlaylistItemId; - } - else - { - return null; - } + return playingItem?.PlaylistItemId; } /// @@ -253,14 +246,7 @@ namespace MediaBrowser.Controller.SyncPlay.Queue public Guid GetPlayingItemId() { var playingItem = GetPlayingItem(); - if (playingItem != null) - { - return playingItem.ItemId; - } - else - { - return Guid.Empty; - } + return playingItem?.ItemId ?? Guid.Empty; } /// @@ -536,7 +522,7 @@ namespace MediaBrowser.Controller.SyncPlay.Queue while (n > 1) { n--; - int k = randomNumberGenerator.Next(n + 1); + int k = _randomNumberGenerator.Next(n + 1); T value = list[k]; list[k] = list[n]; list[n] = value; -- cgit v1.2.3 From cbf70e7a037f9edb431cf0e0f43b261b9a1cf203 Mon Sep 17 00:00:00 2001 From: Ionut Andrei Oanca Date: Fri, 4 Dec 2020 20:15:16 +0100 Subject: Change type of PlaylistItemId to Guid --- Emby.Server.Implementations/SyncPlay/Group.cs | 6 ++-- .../Models/SyncPlayDtos/BufferRequestDto.cs | 4 +-- .../SyncPlayDtos/MovePlaylistItemRequestDto.cs | 6 ++-- .../Models/SyncPlayDtos/NextItemRequestDto.cs | 6 ++-- .../Models/SyncPlayDtos/PreviousItemRequestDto.cs | 6 ++-- .../Models/SyncPlayDtos/ReadyRequestDto.cs | 4 +-- .../SyncPlayDtos/RemoveFromPlaylistRequestDto.cs | 4 +-- .../SyncPlayDtos/SetPlaylistItemRequestDto.cs | 6 ++-- .../SyncPlay/GroupStates/WaitingGroupState.cs | 8 +++--- .../SyncPlay/IGroupStateContext.cs | 6 ++-- .../PlaybackRequests/BufferGroupRequest.cs | 4 +-- .../MovePlaylistItemGroupRequest.cs | 5 ++-- .../PlaybackRequests/NextItemGroupRequest.cs | 5 ++-- .../PlaybackRequests/PreviousItemGroupRequest.cs | 5 ++-- .../SyncPlay/PlaybackRequests/ReadyGroupRequest.cs | 4 +-- .../RemoveFromPlaylistGroupRequest.cs | 6 ++-- .../SetPlaylistItemGroupRequest.cs | 5 ++-- .../SyncPlay/Queue/PlayQueueManager.cs | 32 ++++++---------------- MediaBrowser.Model/SyncPlay/QueueItem.cs | 6 ++-- MediaBrowser.Model/SyncPlay/SendCommand.cs | 4 +-- 20 files changed, 63 insertions(+), 69 deletions(-) (limited to 'MediaBrowser.Controller/SyncPlay/Queue') diff --git a/Emby.Server.Implementations/SyncPlay/Group.cs b/Emby.Server.Implementations/SyncPlay/Group.cs index e32f5e25dc..b5031b708b 100644 --- a/Emby.Server.Implementations/SyncPlay/Group.cs +++ b/Emby.Server.Implementations/SyncPlay/Group.cs @@ -505,7 +505,7 @@ namespace Emby.Server.Implementations.SyncPlay } /// - public bool SetPlayingItem(string playlistItemId) + public bool SetPlayingItem(Guid playlistItemId) { var itemFound = PlayQueue.SetPlayingItemByPlaylistId(playlistItemId); @@ -525,7 +525,7 @@ namespace Emby.Server.Implementations.SyncPlay } /// - public bool RemoveFromPlayQueue(IReadOnlyList playlistItemIds) + public bool RemoveFromPlayQueue(IReadOnlyList playlistItemIds) { var playingItemRemoved = PlayQueue.RemoveFromPlaylist(playlistItemIds); if (playingItemRemoved) @@ -548,7 +548,7 @@ namespace Emby.Server.Implementations.SyncPlay } /// - public bool MoveItemInPlayQueue(string playlistItemId, int newIndex) + public bool MoveItemInPlayQueue(Guid playlistItemId, int newIndex) { return PlayQueue.MovePlaylistItem(playlistItemId, newIndex); } diff --git a/Jellyfin.Api/Models/SyncPlayDtos/BufferRequestDto.cs b/Jellyfin.Api/Models/SyncPlayDtos/BufferRequestDto.cs index cafc400c9c..479c440840 100644 --- a/Jellyfin.Api/Models/SyncPlayDtos/BufferRequestDto.cs +++ b/Jellyfin.Api/Models/SyncPlayDtos/BufferRequestDto.cs @@ -12,7 +12,7 @@ namespace Jellyfin.Api.Models.SyncPlayDtos /// public BufferRequestDto() { - PlaylistItemId = string.Empty; + PlaylistItemId = Guid.Empty; } /// @@ -37,6 +37,6 @@ namespace Jellyfin.Api.Models.SyncPlayDtos /// Gets or sets the playlist item identifier of the playing item. /// /// The playlist item identifier. - public string PlaylistItemId { get; set; } + public Guid PlaylistItemId { get; set; } } } diff --git a/Jellyfin.Api/Models/SyncPlayDtos/MovePlaylistItemRequestDto.cs b/Jellyfin.Api/Models/SyncPlayDtos/MovePlaylistItemRequestDto.cs index 9e9c0b1eab..3af25f3e3e 100644 --- a/Jellyfin.Api/Models/SyncPlayDtos/MovePlaylistItemRequestDto.cs +++ b/Jellyfin.Api/Models/SyncPlayDtos/MovePlaylistItemRequestDto.cs @@ -1,3 +1,5 @@ +using System; + namespace Jellyfin.Api.Models.SyncPlayDtos { /// @@ -10,14 +12,14 @@ namespace Jellyfin.Api.Models.SyncPlayDtos /// public MovePlaylistItemRequestDto() { - PlaylistItemId = string.Empty; + PlaylistItemId = Guid.Empty; } /// /// Gets or sets the playlist identifier of the item. /// /// The playlist identifier of the item. - public string PlaylistItemId { get; set; } + public Guid PlaylistItemId { get; set; } /// /// Gets or sets the new position. diff --git a/Jellyfin.Api/Models/SyncPlayDtos/NextItemRequestDto.cs b/Jellyfin.Api/Models/SyncPlayDtos/NextItemRequestDto.cs index aa67954e75..f59a93f13d 100644 --- a/Jellyfin.Api/Models/SyncPlayDtos/NextItemRequestDto.cs +++ b/Jellyfin.Api/Models/SyncPlayDtos/NextItemRequestDto.cs @@ -1,3 +1,5 @@ +using System; + namespace Jellyfin.Api.Models.SyncPlayDtos { /// @@ -10,13 +12,13 @@ namespace Jellyfin.Api.Models.SyncPlayDtos /// public NextItemRequestDto() { - PlaylistItemId = string.Empty; + PlaylistItemId = Guid.Empty; } /// /// Gets or sets the playing item identifier. /// /// The playing item identifier. - public string PlaylistItemId { get; set; } + public Guid PlaylistItemId { get; set; } } } diff --git a/Jellyfin.Api/Models/SyncPlayDtos/PreviousItemRequestDto.cs b/Jellyfin.Api/Models/SyncPlayDtos/PreviousItemRequestDto.cs index b23d4dee0a..7fd4a49be2 100644 --- a/Jellyfin.Api/Models/SyncPlayDtos/PreviousItemRequestDto.cs +++ b/Jellyfin.Api/Models/SyncPlayDtos/PreviousItemRequestDto.cs @@ -1,3 +1,5 @@ +using System; + namespace Jellyfin.Api.Models.SyncPlayDtos { /// @@ -10,13 +12,13 @@ namespace Jellyfin.Api.Models.SyncPlayDtos /// public PreviousItemRequestDto() { - PlaylistItemId = string.Empty; + PlaylistItemId = Guid.Empty; } /// /// Gets or sets the playing item identifier. /// /// The playing item identifier. - public string PlaylistItemId { get; set; } + public Guid PlaylistItemId { get; set; } } } diff --git a/Jellyfin.Api/Models/SyncPlayDtos/ReadyRequestDto.cs b/Jellyfin.Api/Models/SyncPlayDtos/ReadyRequestDto.cs index 0155d52495..d9c193016a 100644 --- a/Jellyfin.Api/Models/SyncPlayDtos/ReadyRequestDto.cs +++ b/Jellyfin.Api/Models/SyncPlayDtos/ReadyRequestDto.cs @@ -12,7 +12,7 @@ namespace Jellyfin.Api.Models.SyncPlayDtos /// public ReadyRequestDto() { - PlaylistItemId = string.Empty; + PlaylistItemId = Guid.Empty; } /// @@ -37,6 +37,6 @@ namespace Jellyfin.Api.Models.SyncPlayDtos /// Gets or sets the playlist item identifier of the playing item. /// /// The playlist item identifier. - public string PlaylistItemId { get; set; } + public Guid PlaylistItemId { get; set; } } } diff --git a/Jellyfin.Api/Models/SyncPlayDtos/RemoveFromPlaylistRequestDto.cs b/Jellyfin.Api/Models/SyncPlayDtos/RemoveFromPlaylistRequestDto.cs index facb809fca..e9b2b2cb37 100644 --- a/Jellyfin.Api/Models/SyncPlayDtos/RemoveFromPlaylistRequestDto.cs +++ b/Jellyfin.Api/Models/SyncPlayDtos/RemoveFromPlaylistRequestDto.cs @@ -13,13 +13,13 @@ namespace Jellyfin.Api.Models.SyncPlayDtos /// public RemoveFromPlaylistRequestDto() { - PlaylistItemIds = Array.Empty(); + PlaylistItemIds = Array.Empty(); } /// /// Gets or sets the playlist identifiers ot the items. /// /// The playlist identifiers ot the items. - public IReadOnlyList PlaylistItemIds { get; set; } + public IReadOnlyList PlaylistItemIds { get; set; } } } diff --git a/Jellyfin.Api/Models/SyncPlayDtos/SetPlaylistItemRequestDto.cs b/Jellyfin.Api/Models/SyncPlayDtos/SetPlaylistItemRequestDto.cs index 3440858712..b937679fc1 100644 --- a/Jellyfin.Api/Models/SyncPlayDtos/SetPlaylistItemRequestDto.cs +++ b/Jellyfin.Api/Models/SyncPlayDtos/SetPlaylistItemRequestDto.cs @@ -1,3 +1,5 @@ +using System; + namespace Jellyfin.Api.Models.SyncPlayDtos { /// @@ -10,13 +12,13 @@ namespace Jellyfin.Api.Models.SyncPlayDtos /// public SetPlaylistItemRequestDto() { - PlaylistItemId = string.Empty; + PlaylistItemId = Guid.Empty; } /// /// Gets or sets the playlist identifier of the playing item. /// /// The playlist identifier of the playing item. - public string PlaylistItemId { get; set; } + public Guid PlaylistItemId { get; set; } } } diff --git a/MediaBrowser.Controller/SyncPlay/GroupStates/WaitingGroupState.cs b/MediaBrowser.Controller/SyncPlay/GroupStates/WaitingGroupState.cs index f5f603c296..c2820604f3 100644 --- a/MediaBrowser.Controller/SyncPlay/GroupStates/WaitingGroupState.cs +++ b/MediaBrowser.Controller/SyncPlay/GroupStates/WaitingGroupState.cs @@ -329,7 +329,7 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates } // Make sure the client is playing the correct item. - if (!request.PlaylistItemId.Equals(context.PlayQueue.GetPlayingItemPlaylistId(), StringComparison.OrdinalIgnoreCase)) + if (!request.PlaylistItemId.Equals(context.PlayQueue.GetPlayingItemPlaylistId())) { _logger.LogDebug("Session {SessionId} reported wrong playlist item in group {GroupId}.", session.Id, context.GroupId.ToString()); @@ -403,7 +403,7 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates } // Make sure the client is playing the correct item. - if (!request.PlaylistItemId.Equals(context.PlayQueue.GetPlayingItemPlaylistId(), StringComparison.OrdinalIgnoreCase)) + if (!request.PlaylistItemId.Equals(context.PlayQueue.GetPlayingItemPlaylistId())) { _logger.LogDebug("Session {SessionId} reported wrong playlist item in group {GroupId}.", session.Id, context.GroupId.ToString()); @@ -572,7 +572,7 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates ResumePlaying = true; // Make sure the client knows the playing item, to avoid duplicate requests. - if (!request.PlaylistItemId.Equals(context.PlayQueue.GetPlayingItemPlaylistId(), StringComparison.OrdinalIgnoreCase)) + if (!request.PlaylistItemId.Equals(context.PlayQueue.GetPlayingItemPlaylistId())) { _logger.LogDebug("Session {SessionId} provided the wrong playlist item for group {GroupId}.", session.Id, context.GroupId.ToString()); return; @@ -618,7 +618,7 @@ namespace MediaBrowser.Controller.SyncPlay.GroupStates ResumePlaying = true; // Make sure the client knows the playing item, to avoid duplicate requests. - if (!request.PlaylistItemId.Equals(context.PlayQueue.GetPlayingItemPlaylistId(), StringComparison.OrdinalIgnoreCase)) + if (!request.PlaylistItemId.Equals(context.PlayQueue.GetPlayingItemPlaylistId())) { _logger.LogDebug("Session {SessionId} provided the wrong playlist item for group {GroupId}.", session.Id, context.GroupId.ToString()); return; diff --git a/MediaBrowser.Controller/SyncPlay/IGroupStateContext.cs b/MediaBrowser.Controller/SyncPlay/IGroupStateContext.cs index 13f1b23169..aa263638aa 100644 --- a/MediaBrowser.Controller/SyncPlay/IGroupStateContext.cs +++ b/MediaBrowser.Controller/SyncPlay/IGroupStateContext.cs @@ -158,14 +158,14 @@ namespace MediaBrowser.Controller.SyncPlay /// /// The new playing item identifier. /// true if the play queue has been changed; false if something went wrong. - bool SetPlayingItem(string playlistItemId); + bool SetPlayingItem(Guid playlistItemId); /// /// Removes items from the play queue. /// /// The items to remove. /// true if playing item got removed; false otherwise. - bool RemoveFromPlayQueue(IReadOnlyList playlistItemIds); + bool RemoveFromPlayQueue(IReadOnlyList playlistItemIds); /// /// Moves an item in the play queue. @@ -173,7 +173,7 @@ namespace MediaBrowser.Controller.SyncPlay /// The playlist identifier of the item to move. /// The new position. /// true if item has been moved; false if something went wrong. - bool MoveItemInPlayQueue(string playlistItemId, int newIndex); + bool MoveItemInPlayQueue(Guid playlistItemId, int newIndex); /// /// Updates the play queue. diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/BufferGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/BufferGroupRequest.cs index 2981dbbdd6..39e0ec2099 100644 --- a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/BufferGroupRequest.cs +++ b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/BufferGroupRequest.cs @@ -17,7 +17,7 @@ namespace MediaBrowser.Controller.SyncPlay.PlaybackRequests /// The position ticks. /// Whether the client playback is unpaused. /// The playlist item identifier of the playing item. - public BufferGroupRequest(DateTime when, long positionTicks, bool isPlaying, string playlistItemId) + public BufferGroupRequest(DateTime when, long positionTicks, bool isPlaying, Guid playlistItemId) { When = when; PositionTicks = positionTicks; @@ -47,7 +47,7 @@ namespace MediaBrowser.Controller.SyncPlay.PlaybackRequests /// Gets the playlist item identifier of the playing item. /// /// The playlist item identifier. - public string PlaylistItemId { get; } + public Guid PlaylistItemId { get; } /// public override PlaybackRequestType Action { get; } = PlaybackRequestType.Buffer; diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/MovePlaylistItemGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/MovePlaylistItemGroupRequest.cs index efca4ed3ef..7ebf67af1d 100644 --- a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/MovePlaylistItemGroupRequest.cs +++ b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/MovePlaylistItemGroupRequest.cs @@ -1,3 +1,4 @@ +using System; using System.Threading; using MediaBrowser.Controller.Session; using MediaBrowser.Model.SyncPlay; @@ -14,7 +15,7 @@ namespace MediaBrowser.Controller.SyncPlay.PlaybackRequests /// /// The playlist identifier of the item. /// The new position. - public MovePlaylistItemGroupRequest(string playlistItemId, int newIndex) + public MovePlaylistItemGroupRequest(Guid playlistItemId, int newIndex) { PlaylistItemId = playlistItemId; NewIndex = newIndex; @@ -24,7 +25,7 @@ namespace MediaBrowser.Controller.SyncPlay.PlaybackRequests /// Gets the playlist identifier of the item. /// /// The playlist identifier of the item. - public string PlaylistItemId { get; } + public Guid PlaylistItemId { get; } /// /// Gets the new position. diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/NextItemGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/NextItemGroupRequest.cs index ab60265a6b..478414137c 100644 --- a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/NextItemGroupRequest.cs +++ b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/NextItemGroupRequest.cs @@ -1,3 +1,4 @@ +using System; using System.Threading; using MediaBrowser.Controller.Session; using MediaBrowser.Model.SyncPlay; @@ -13,7 +14,7 @@ namespace MediaBrowser.Controller.SyncPlay.PlaybackRequests /// Initializes a new instance of the class. /// /// The playing item identifier. - public NextItemGroupRequest(string playlistItemId) + public NextItemGroupRequest(Guid playlistItemId) { PlaylistItemId = playlistItemId; } @@ -22,7 +23,7 @@ namespace MediaBrowser.Controller.SyncPlay.PlaybackRequests /// Gets the playing item identifier. /// /// The playing item identifier. - public string PlaylistItemId { get; } + public Guid PlaylistItemId { get; } /// public override PlaybackRequestType Action { get; } = PlaybackRequestType.NextItem; diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/PreviousItemGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/PreviousItemGroupRequest.cs index 445c5fce65..ad3ea5e553 100644 --- a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/PreviousItemGroupRequest.cs +++ b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/PreviousItemGroupRequest.cs @@ -1,3 +1,4 @@ +using System; using System.Threading; using MediaBrowser.Controller.Session; using MediaBrowser.Model.SyncPlay; @@ -13,7 +14,7 @@ namespace MediaBrowser.Controller.SyncPlay.PlaybackRequests /// Initializes a new instance of the class. /// /// The playing item identifier. - public PreviousItemGroupRequest(string playlistItemId) + public PreviousItemGroupRequest(Guid playlistItemId) { PlaylistItemId = playlistItemId; } @@ -22,7 +23,7 @@ namespace MediaBrowser.Controller.SyncPlay.PlaybackRequests /// Gets the playing item identifier. /// /// The playing item identifier. - public string PlaylistItemId { get; } + public Guid PlaylistItemId { get; } /// public override PlaybackRequestType Action { get; } = PlaybackRequestType.PreviousItem; diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/ReadyGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/ReadyGroupRequest.cs index b09db4ba80..b2efcc97df 100644 --- a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/ReadyGroupRequest.cs +++ b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/ReadyGroupRequest.cs @@ -17,7 +17,7 @@ namespace MediaBrowser.Controller.SyncPlay.PlaybackRequests /// The position ticks. /// Whether the client playback is unpaused. /// The playlist item identifier of the playing item. - public ReadyGroupRequest(DateTime when, long positionTicks, bool isPlaying, string playlistItemId) + public ReadyGroupRequest(DateTime when, long positionTicks, bool isPlaying, Guid playlistItemId) { When = when; PositionTicks = positionTicks; @@ -47,7 +47,7 @@ namespace MediaBrowser.Controller.SyncPlay.PlaybackRequests /// Gets the playlist item identifier of the playing item. /// /// The playlist item identifier. - public string PlaylistItemId { get; } + public Guid PlaylistItemId { get; } /// public override PlaybackRequestType Action { get; } = PlaybackRequestType.Ready; diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/RemoveFromPlaylistGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/RemoveFromPlaylistGroupRequest.cs index dac1914aa7..24009d93ca 100644 --- a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/RemoveFromPlaylistGroupRequest.cs +++ b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/RemoveFromPlaylistGroupRequest.cs @@ -15,16 +15,16 @@ namespace MediaBrowser.Controller.SyncPlay.PlaybackRequests /// Initializes a new instance of the class. /// /// The playlist ids of the items to remove. - public RemoveFromPlaylistGroupRequest(IReadOnlyList items) + public RemoveFromPlaylistGroupRequest(IReadOnlyList items) { - PlaylistItemIds = items ?? Array.Empty(); + PlaylistItemIds = items ?? Array.Empty(); } /// /// Gets the playlist identifiers ot the items. /// /// The playlist identifiers ot the items. - public IReadOnlyList PlaylistItemIds { get; } + public IReadOnlyList PlaylistItemIds { get; } /// public override PlaybackRequestType Action { get; } = PlaybackRequestType.RemoveFromPlaylist; diff --git a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/SetPlaylistItemGroupRequest.cs b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/SetPlaylistItemGroupRequest.cs index 58fed3fa07..3edf9b8a42 100644 --- a/MediaBrowser.Controller/SyncPlay/PlaybackRequests/SetPlaylistItemGroupRequest.cs +++ b/MediaBrowser.Controller/SyncPlay/PlaybackRequests/SetPlaylistItemGroupRequest.cs @@ -1,3 +1,4 @@ +using System; using System.Threading; using MediaBrowser.Controller.Session; using MediaBrowser.Model.SyncPlay; @@ -13,7 +14,7 @@ namespace MediaBrowser.Controller.SyncPlay.PlaybackRequests /// Initializes a new instance of the class. /// /// The playlist identifier of the item. - public SetPlaylistItemGroupRequest(string playlistItemId) + public SetPlaylistItemGroupRequest(Guid playlistItemId) { PlaylistItemId = playlistItemId; } @@ -22,7 +23,7 @@ namespace MediaBrowser.Controller.SyncPlay.PlaybackRequests /// Gets the playlist identifier of the playing item. /// /// The playlist identifier of the playing item. - public string PlaylistItemId { get; } + public Guid PlaylistItemId { get; } /// public override PlaybackRequestType Action { get; } = PlaybackRequestType.SetPlaylistItem; diff --git a/MediaBrowser.Controller/SyncPlay/Queue/PlayQueueManager.cs b/MediaBrowser.Controller/SyncPlay/Queue/PlayQueueManager.cs index bfb9d1e4c1..fdec29417e 100644 --- a/MediaBrowser.Controller/SyncPlay/Queue/PlayQueueManager.cs +++ b/MediaBrowser.Controller/SyncPlay/Queue/PlayQueueManager.cs @@ -66,12 +66,6 @@ namespace MediaBrowser.Controller.SyncPlay.Queue /// The shuffled playlist, or play queue of the group. private List ShuffledPlaylist { get; set; } = new List(); - /// - /// Gets or sets the progressive identifier counter. - /// - /// The progressive identifier. - private int ProgressiveId { get; set; } - /// /// Checks if an item is playing. /// @@ -233,10 +227,10 @@ namespace MediaBrowser.Controller.SyncPlay.Queue /// Gets playlist identifier of the playing item, if any. /// /// The playlist identifier of the playing item. - public string GetPlayingItemPlaylistId() + public Guid GetPlayingItemPlaylistId() { var playingItem = GetPlayingItem(); - return playingItem?.PlaylistItemId; + return playingItem?.PlaylistItemId ?? Guid.Empty; } /// @@ -265,10 +259,10 @@ namespace MediaBrowser.Controller.SyncPlay.Queue /// /// The new playing item identifier. /// true if playing item has been set; false if item is not in the playlist. - public bool SetPlayingItemByPlaylistId(string playlistItemId) + public bool SetPlayingItemByPlaylistId(Guid playlistItemId) { var playlist = GetPlaylistInternal(); - PlayingItemIndex = playlist.FindIndex(item => item.PlaylistItemId.Equals(playlistItemId, StringComparison.OrdinalIgnoreCase)); + PlayingItemIndex = playlist.FindIndex(item => item.PlaylistItemId.Equals(playlistItemId)); LastChange = DateTime.UtcNow; return PlayingItemIndex != NoPlayingItemIndex; @@ -298,7 +292,7 @@ namespace MediaBrowser.Controller.SyncPlay.Queue /// /// The items to remove. /// true if playing item got removed; false otherwise. - public bool RemoveFromPlaylist(IReadOnlyList playlistItemIds) + public bool RemoveFromPlaylist(IReadOnlyList playlistItemIds) { var playingItem = GetPlayingItem(); @@ -341,12 +335,12 @@ namespace MediaBrowser.Controller.SyncPlay.Queue /// The item to move. /// The new position. /// true if the item has been moved; false otherwise. - public bool MovePlaylistItem(string playlistItemId, int newIndex) + public bool MovePlaylistItem(Guid playlistItemId, int newIndex) { var playlist = GetPlaylistInternal(); var playingItem = GetPlayingItem(); - var oldIndex = playlist.FindIndex(item => item.PlaylistItemId.Equals(playlistItemId, StringComparison.OrdinalIgnoreCase)); + var oldIndex = playlist.FindIndex(item => item.PlaylistItemId.Equals(playlistItemId)); if (oldIndex < 0) { return false; @@ -367,7 +361,6 @@ namespace MediaBrowser.Controller.SyncPlay.Queue /// public void Reset() { - ProgressiveId = 0; SortedPlaylist.Clear(); ShuffledPlaylist.Clear(); PlayingItemIndex = NoPlayingItemIndex; @@ -529,15 +522,6 @@ namespace MediaBrowser.Controller.SyncPlay.Queue } } - /// - /// Gets the next available identifier. - /// - /// The next available identifier. - private int GetNextProgressiveId() - { - return ProgressiveId++; - } - /// /// Creates a list from the array of items. Each item is given an unique playlist identifier. /// @@ -547,7 +531,7 @@ namespace MediaBrowser.Controller.SyncPlay.Queue var list = new List(); foreach (var item in items) { - var queueItem = new QueueItem(item, "syncPlayItem" + GetNextProgressiveId()); + var queueItem = new QueueItem(item); list.Add(queueItem); } diff --git a/MediaBrowser.Model/SyncPlay/QueueItem.cs b/MediaBrowser.Model/SyncPlay/QueueItem.cs index 9c4d3a4ceb..a6dcc109ed 100644 --- a/MediaBrowser.Model/SyncPlay/QueueItem.cs +++ b/MediaBrowser.Model/SyncPlay/QueueItem.cs @@ -11,11 +11,9 @@ namespace MediaBrowser.Model.SyncPlay /// Initializes a new instance of the class. /// /// The item identifier. - /// The playlist identifier of the item. - public QueueItem(Guid itemId, string playlistItemId) + public QueueItem(Guid itemId) { ItemId = itemId; - PlaylistItemId = playlistItemId; } /// @@ -28,6 +26,6 @@ namespace MediaBrowser.Model.SyncPlay /// Gets the playlist identifier of the item. /// /// The playlist identifier of the item. - public string PlaylistItemId { get; } + public Guid PlaylistItemId { get; } = Guid.NewGuid(); } } diff --git a/MediaBrowser.Model/SyncPlay/SendCommand.cs b/MediaBrowser.Model/SyncPlay/SendCommand.cs index ab4c64130c..73cb50876d 100644 --- a/MediaBrowser.Model/SyncPlay/SendCommand.cs +++ b/MediaBrowser.Model/SyncPlay/SendCommand.cs @@ -16,7 +16,7 @@ namespace MediaBrowser.Model.SyncPlay /// The command. /// The position ticks, for commands that require it. /// The UTC time when this command has been emitted. - public SendCommand(Guid groupId, string playlistItemId, DateTime when, SendCommandType command, long? positionTicks, DateTime emittedAt) + public SendCommand(Guid groupId, Guid playlistItemId, DateTime when, SendCommandType command, long? positionTicks, DateTime emittedAt) { GroupId = groupId; PlaylistItemId = playlistItemId; @@ -36,7 +36,7 @@ namespace MediaBrowser.Model.SyncPlay /// Gets the playlist identifier of the playing item. /// /// The playlist identifier of the playing item. - public string PlaylistItemId { get; } + public Guid PlaylistItemId { get; } /// /// Gets or sets the UTC time when to execute the command. -- cgit v1.2.3