add guide mode to schedule items (#430)

CHANGELOG.md

@@ -16,6 +16,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
   - Filler collection will always be randomized (to fill as much time as possible)
   - Filler will be hidden from channel guide, but visible in playout details in ErsatzTV
   - Unfilled time will show offline image
+- Add `Guide Mode` option to all schedule items
+  - `Normal` guide mode will show all scheduled items in the channel guide (xmltv)
+  - `Filler` guide mode will hide all scheduled items from the channel guide, and extend the end time for the previous item in the guide
 
 ## [0.1.3-alpha] - 2021-10-12
 ### Fixed

ErsatzTV.Application/ProgramSchedules/Commands/AddProgramScheduleItem.cs

@@ -25,5 +25,6 @@ namespace ErsatzTV.Application.ProgramSchedules.Commands
         int? TailMultiCollectionId,
         int? TailSmartCollectionId,
         int? TailMediaItemId,
-        string CustomTitle) : IRequest<Either<BaseError, ProgramScheduleItemViewModel>>, IProgramScheduleItemRequest;
+        string CustomTitle,
+        GuideMode GuideMode) : IRequest<Either<BaseError, ProgramScheduleItemViewModel>>, IProgramScheduleItemRequest;
 }

ErsatzTV.Application/ProgramSchedules/Commands/IProgramScheduleItemRequest.cs

@@ -22,5 +22,6 @@ namespace ErsatzTV.Application.ProgramSchedules.Commands
         int? TailSmartCollectionId { get; }
         int? TailMediaItemId { get; }
         string CustomTitle { get; }
+        GuideMode GuideMode { get; }
     }
 }

ErsatzTV.Application/ProgramSchedules/Commands/ProgramScheduleItemCommandBase.cs

@@ -135,7 +135,8 @@ namespace ErsatzTV.Application.ProgramSchedules.Commands
                     SmartCollectionId = item.SmartCollectionId,
                     MediaItemId = item.MediaItemId,
                     PlaybackOrder = item.PlaybackOrder,
-                    CustomTitle = item.CustomTitle
+                    CustomTitle = item.CustomTitle,
+                    GuideMode = item.GuideMode
                 },
                 PlayoutMode.One => new ProgramScheduleItemOne
                 {
@@ -148,7 +149,8 @@ namespace ErsatzTV.Application.ProgramSchedules.Commands
                     SmartCollectionId = item.SmartCollectionId,
                     MediaItemId = item.MediaItemId,
                     PlaybackOrder = item.PlaybackOrder,
-                    CustomTitle = item.CustomTitle
+                    CustomTitle = item.CustomTitle,
+                    GuideMode = item.GuideMode
                 },
                 PlayoutMode.Multiple => new ProgramScheduleItemMultiple
                 {
@@ -162,7 +164,8 @@ namespace ErsatzTV.Application.ProgramSchedules.Commands
                     MediaItemId = item.MediaItemId,
                     PlaybackOrder = item.PlaybackOrder,
                     Count = item.MultipleCount.GetValueOrDefault(),
-                    CustomTitle = item.CustomTitle
+                    CustomTitle = item.CustomTitle,
+                    GuideMode = item.GuideMode
                 },
                 PlayoutMode.Duration => new ProgramScheduleItemDuration
                 {
@@ -182,7 +185,8 @@ namespace ErsatzTV.Application.ProgramSchedules.Commands
                     TailMultiCollectionId = item.TailMultiCollectionId,
                     TailSmartCollectionId = item.TailSmartCollectionId,
                     TailMediaItemId = item.TailMediaItemId,
-                    CustomTitle = item.CustomTitle
+                    CustomTitle = item.CustomTitle,
+                    GuideMode = item.GuideMode
                 },
                 _ => throw new NotSupportedException($"Unsupported playout mode {item.PlayoutMode}")
             };

ErsatzTV.Application/ProgramSchedules/Commands/ReplaceProgramScheduleItems.cs

@@ -26,7 +26,8 @@ namespace ErsatzTV.Application.ProgramSchedules.Commands
         int? TailMultiCollectionId,
         int? TailSmartCollectionId,
         int? TailMediaItemId,
-        string CustomTitle) : IProgramScheduleItemRequest;
+        string CustomTitle,
+        GuideMode GuideMode) : IProgramScheduleItemRequest;
 
     public record ReplaceProgramScheduleItems
         (int ProgramScheduleId, List<ReplaceProgramScheduleItem> Items) : IRequest<

ErsatzTV.Application/ProgramSchedules/Mapper.cs

@@ -58,7 +58,8 @@ namespace ErsatzTV.Application.ProgramSchedules
                             Artist artist => MediaItems.Mapper.ProjectToViewModel(artist),
                             _ => null
                         },
-                        duration.CustomTitle),
+                        duration.CustomTitle,
+                        duration.GuideMode),
                 ProgramScheduleItemFlood flood =>
                     new ProgramScheduleItemFloodViewModel(
                         flood.Id,
@@ -83,7 +84,8 @@ namespace ErsatzTV.Application.ProgramSchedules
                             _ => null
                         },
                         flood.PlaybackOrder,
-                        flood.CustomTitle),
+                        flood.CustomTitle,
+                        flood.GuideMode),
                 ProgramScheduleItemMultiple multiple =>
                     new ProgramScheduleItemMultipleViewModel(
                         multiple.Id,
@@ -109,7 +111,8 @@ namespace ErsatzTV.Application.ProgramSchedules
                         },
                         multiple.PlaybackOrder,
                         multiple.Count,
-                        multiple.CustomTitle),
+                        multiple.CustomTitle,
+                        multiple.GuideMode),
                 ProgramScheduleItemOne one =>
                     new ProgramScheduleItemOneViewModel(
                         one.Id,
@@ -134,7 +137,8 @@ namespace ErsatzTV.Application.ProgramSchedules
                             _ => null
                         },
                         one.PlaybackOrder,
-                        one.CustomTitle),
+                        one.CustomTitle,
+                        one.GuideMode),
                 _ => throw new NotSupportedException(
                     $"Unsupported program schedule item type {programScheduleItem.GetType().Name}")
             };

ErsatzTV.Application/ProgramSchedules/ProgramScheduleItemDurationViewModel.cs

@@ -25,7 +25,8 @@ namespace ErsatzTV.Application.ProgramSchedules
             MultiCollectionViewModel tailMultiCollection,
             SmartCollectionViewModel tailSmartCollection,
             NamedMediaItemViewModel tailMediaItem,
-            string customTitle) : base(
+            string customTitle,
+            GuideMode guideMode) : base(
             id,
             index,
             startType,
@@ -37,7 +38,8 @@ namespace ErsatzTV.Application.ProgramSchedules
             smartCollection,
             mediaItem,
             playbackOrder,
-            customTitle)
+            customTitle,
+            guideMode)
         {
             PlayoutDuration = playoutDuration;
             TailMode = tailMode;

ErsatzTV.Application/ProgramSchedules/ProgramScheduleItemFloodViewModel.cs

@@ -18,7 +18,8 @@ namespace ErsatzTV.Application.ProgramSchedules
             SmartCollectionViewModel smartCollection,
             NamedMediaItemViewModel mediaItem,
             PlaybackOrder playbackOrder,
-            string customTitle) : base(
+            string customTitle,
+            GuideMode guideMode) : base(
             id,
             index,
             startType,
@@ -30,7 +31,8 @@ namespace ErsatzTV.Application.ProgramSchedules
             smartCollection,
             mediaItem,
             playbackOrder,
-            customTitle)
+            customTitle,
+            guideMode)
         {
         }
     }

ErsatzTV.Application/ProgramSchedules/ProgramScheduleItemMultipleViewModel.cs

@@ -19,7 +19,8 @@ namespace ErsatzTV.Application.ProgramSchedules
             NamedMediaItemViewModel mediaItem,
             PlaybackOrder playbackOrder,
             int count,
-            string customTitle) : base(
+            string customTitle,
+            GuideMode guideMode) : base(
             id,
             index,
             startType,
@@ -31,7 +32,8 @@ namespace ErsatzTV.Application.ProgramSchedules
             smartCollection,
             mediaItem,
             playbackOrder,
-            customTitle) =>
+            customTitle,
+            guideMode) =>
             Count = count;
 
         public int Count { get; }

ErsatzTV.Application/ProgramSchedules/ProgramScheduleItemOneViewModel.cs

@@ -18,7 +18,8 @@ namespace ErsatzTV.Application.ProgramSchedules
             SmartCollectionViewModel smartCollection,
             NamedMediaItemViewModel mediaItem,
             PlaybackOrder playbackOrder,
-            string customTitle) : base(
+            string customTitle,
+            GuideMode guideMode) : base(
             id,
             index,
             startType,
@@ -30,7 +31,8 @@ namespace ErsatzTV.Application.ProgramSchedules
             smartCollection,
             mediaItem,
             playbackOrder,
-            customTitle)
+            customTitle,
+            guideMode)
         {
         }
     }

ErsatzTV.Application/ProgramSchedules/ProgramScheduleItemViewModel.cs

@@ -17,7 +17,8 @@ namespace ErsatzTV.Application.ProgramSchedules
         SmartCollectionViewModel SmartCollection,
         NamedMediaItemViewModel MediaItem,
         PlaybackOrder PlaybackOrder,
-        string CustomTitle)
+        string CustomTitle,
+        GuideMode GuideMode)
     {
         public string Name => CollectionType switch
         {

ErsatzTV.Core/Domain/GuideMode.cs

@@ -0,0 +1,8 @@
+namespace ErsatzTV.Core.Domain
+{
+    public enum GuideMode
+    {
+        Normal = 0,
+        Filler = 1
+    }
+}

ErsatzTV.Core/Domain/ProgramScheduleItem.cs

@@ -9,6 +9,7 @@ namespace ErsatzTV.Core.Domain
         public StartType StartType => StartTime.HasValue ? StartType.Fixed : StartType.Dynamic;
         public TimeSpan? StartTime { get; set; }
         public ProgramScheduleItemCollectionType CollectionType { get; set; }
+        public GuideMode GuideMode { get; set; }
         public string CustomTitle { get; set; }
         public int ProgramScheduleId { get; set; }
         public ProgramSchedule ProgramSchedule { get; set; }

ErsatzTV.Core/Scheduling/PlayoutBuilder.cs

@@ -285,7 +285,7 @@ namespace ErsatzTV.Core.Scheduling
                             Start = itemStartTime.UtcDateTime,
                             Finish = itemStartTime.UtcDateTime + version.Duration,
                             CustomGroup = customGroup,
-                            IsFiller = inDurationFiller
+                            IsFiller = inDurationFiller || scheduleItem.GuideMode == GuideMode.Filler
                         };
 
                         if (!string.IsNullOrWhiteSpace(scheduleItem.CustomTitle))

ErsatzTV.Infrastructure/Migrations/20211014180849_Add_ProgramScheduleItem_GuideMode.cs

@@ -0,0 +1,24 @@
+using Microsoft.EntityFrameworkCore.Migrations;
+
+namespace ErsatzTV.Infrastructure.Migrations
+{
+    public partial class Add_ProgramScheduleItem_GuideMode : Migration
+    {
+        protected override void Up(MigrationBuilder migrationBuilder)
+        {
+            migrationBuilder.AddColumn<int>(
+                name: "GuideMode",
+                table: "ProgramScheduleItem",
+                type: "INTEGER",
+                nullable: false,
+                defaultValue: 0);
+        }
+
+        protected override void Down(MigrationBuilder migrationBuilder)
+        {
+            migrationBuilder.DropColumn(
+                name: "GuideMode",
+                table: "ProgramScheduleItem");
+        }
+    }
+}

ErsatzTV.Infrastructure/Migrations/TvContextModelSnapshot.cs

@@ -1312,6 +1312,9 @@ namespace ErsatzTV.Infrastructure.Migrations
                     b.Property<string>("CustomTitle")
                         .HasColumnType("TEXT");
 
+                    b.Property<int>("GuideMode")
+                        .HasColumnType("INTEGER");
+
                     b.Property<int>("Index")
                         .HasColumnType("INTEGER");
 

ErsatzTV/Pages/Artist.razor

@@ -213,7 +213,7 @@
         DialogResult result = await dialog.Result;
         if (!result.Cancelled && result.Data is ProgramScheduleViewModel schedule)
         {
-            await _mediator.Send(new AddProgramScheduleItem(schedule.Id, StartType.Dynamic, null, PlayoutMode.One, ProgramScheduleItemCollectionType.Artist, null, null, null, ArtistId, PlaybackOrder.Shuffle, null, null, TailMode.None, ProgramScheduleItemCollectionType.Collection, null, null, null, null, null));
+            await _mediator.Send(new AddProgramScheduleItem(schedule.Id, StartType.Dynamic, null, PlayoutMode.One, ProgramScheduleItemCollectionType.Artist, null, null, null, ArtistId, PlaybackOrder.Shuffle, null, null, TailMode.None, ProgramScheduleItemCollectionType.Collection, null, null, null, null, null, GuideMode.Normal));
             _navigationManager.NavigateTo($"/schedules/{schedule.Id}/items");
         }
     }

ErsatzTV/Pages/ScheduleItemsEditor.razor

@@ -255,6 +255,10 @@
                                                  Disabled="@(_selectedItem.PlayoutMode != PlayoutMode.Duration || _selectedItem.TailMode != TailMode.Filler)"/>
                             }
                             <MudTextField Class="mt-3" Label="Custom Title" @bind-Value="@_selectedItem.CustomTitle" For="@(() => _selectedItem.CustomTitle)"/>
+                            <MudSelect Class="mt-3" Label="Guide Mode" @bind-Value="@_selectedItem.GuideMode" For="@(() => _selectedItem.GuideMode)">
+                                <MudSelectItem Value="@GuideMode.Normal">Normal</MudSelectItem>
+                                <MudSelectItem Value="@GuideMode.Filler">Filler</MudSelectItem>
+                            </MudSelect>
                         </MudCardContent>
                     </MudCard>
                 </EditForm>
@@ -343,6 +347,7 @@
             MediaItem = item.MediaItem,
             PlaybackOrder = item.PlaybackOrder,
             CustomTitle = item.CustomTitle,
+            GuideMode = item.GuideMode
         };
 
         switch (item)
@@ -438,7 +443,8 @@
             item.TailMultiCollection?.Id,
             item.TailSmartCollection?.Id,
             item.TailMediaItem?.MediaItemId,
-            item.CustomTitle)).ToList();
+            item.CustomTitle,
+            item.GuideMode)).ToList();
 
         Seq<BaseError> errorMessages = await _mediator.Send(new ReplaceProgramScheduleItems(Id, items)).Map(e => e.LeftToSeq());
 

ErsatzTV/Pages/TelevisionEpisodeList.razor

@@ -197,7 +197,7 @@
         DialogResult result = await dialog.Result;
         if (!result.Cancelled && result.Data is ProgramScheduleViewModel schedule)
         {
-            await _mediator.Send(new AddProgramScheduleItem(schedule.Id, StartType.Dynamic, null, PlayoutMode.One, ProgramScheduleItemCollectionType.TelevisionSeason, null, null, null, SeasonId, PlaybackOrder.Shuffle, null, null, TailMode.None, ProgramScheduleItemCollectionType.Collection, null, null, null, null, null));
+            await _mediator.Send(new AddProgramScheduleItem(schedule.Id, StartType.Dynamic, null, PlayoutMode.One, ProgramScheduleItemCollectionType.TelevisionSeason, null, null, null, SeasonId, PlaybackOrder.Shuffle, null, null, TailMode.None, ProgramScheduleItemCollectionType.Collection, null, null, null, null, null, GuideMode.Normal));
             _navigationManager.NavigateTo($"/schedules/{schedule.Id}/items");
         }
     }

ErsatzTV/Pages/TelevisionSeasonList.razor

@@ -225,7 +225,7 @@
         DialogResult result = await dialog.Result;
         if (!result.Cancelled && result.Data is ProgramScheduleViewModel schedule)
         {
-            await _mediator.Send(new AddProgramScheduleItem(schedule.Id, StartType.Dynamic, null, PlayoutMode.One, ProgramScheduleItemCollectionType.TelevisionShow, null, null, null, ShowId, PlaybackOrder.Shuffle, null, null, TailMode.None, ProgramScheduleItemCollectionType.Collection, null, null, null, null, null));
+            await _mediator.Send(new AddProgramScheduleItem(schedule.Id, StartType.Dynamic, null, PlayoutMode.One, ProgramScheduleItemCollectionType.TelevisionShow, null, null, null, ShowId, PlaybackOrder.Shuffle, null, null, TailMode.None, ProgramScheduleItemCollectionType.Collection, null, null, null, null, null, GuideMode.Normal));
             _navigationManager.NavigateTo($"/schedules/{schedule.Id}/items");
         }
     }

ErsatzTV/ViewModels/ProgramScheduleItemEditViewModel.cs

@@ -116,6 +116,8 @@ namespace ErsatzTV.ViewModels
 
         public string CustomTitle { get; set; }
 
+        public GuideMode GuideMode { get; set; }
+
         public event PropertyChangedEventHandler PropertyChanged;
 
         [NotifyPropertyChangedInvocator]