add watermark z-index (#2279)

CHANGELOG.md

@@ -17,6 +17,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
   - The expression can also use functions:
     - `LinearFadeDuration(time, start, fadeSeconds, peakSeconds)`
     - `LinearFadePoints(time, start, peakStart, peakEnd, end)`
+- Add `Z-Index` to watermark editor
+  - The graphics engine will order by z-index when overlaying watermarks
 
 ### Fix
 - Fix database operations that were slowing down playout builds

ErsatzTV.Application/Playouts/Commands/BuildPlayoutHandler.cs

@@ -134,7 +134,29 @@ public class BuildPlayoutHandler : IRequestHandler<BuildPlayout, Either<BaseErro
             if (result.AddedItems.Count > 0)
             {
                 changeCount += 1;
-                await dbContext.BulkInsertAsync(result.AddedItems, cancellationToken: cancellationToken);
+                var bulkConfig = new BulkConfig();
+                bool anyWatermarks = result.AddedItems.Any(i => i.PlayoutItemWatermarks is not null && i.PlayoutItemWatermarks.Count > 0);
+                if (anyWatermarks)
+                {
+                    bulkConfig.SetOutputIdentity = true;
+                }
+
+                await dbContext.BulkInsertAsync(result.AddedItems, bulkConfig, cancellationToken: cancellationToken);
+
+                if (anyWatermarks)
+                {
+                    // copy playout item ids back to watermarks
+                    var allWatermarks = result.AddedItems.SelectMany(item =>
+                        item.PlayoutItemWatermarks.Select(watermark =>
+                        {
+                            watermark.PlayoutItemId = item.Id;
+                            watermark.PlayoutItem = null;
+                            return watermark;
+                        })
+                    ).ToList();
+
+                    await dbContext.BulkInsertAsync(allWatermarks, cancellationToken: cancellationToken);
+                }
             }
 
             if (result.HistoryToRemove.Count > 0)

ErsatzTV.Application/Watermarks/Commands/CreateWatermark.cs

@@ -19,6 +19,7 @@ public record CreateWatermark(
     int DurationSeconds,
     int Opacity,
     bool PlaceWithinSourceContent,
-    string OpacityExpression) : IRequest<Either<BaseError, CreateWatermarkResult>>;
+    string OpacityExpression,
+    int ZIndex) : IRequest<Either<BaseError, CreateWatermarkResult>>;
 
 public record CreateWatermarkResult(int WatermarkId) : EntityIdResult(WatermarkId);

ErsatzTV.Application/Watermarks/Commands/CreateWatermarkHandler.cs

@@ -56,7 +56,8 @@ public class CreateWatermarkHandler : IRequestHandler<CreateWatermark, Either<Ba
                     DurationSeconds = request.DurationSeconds,
                     Opacity = request.Opacity,
                     PlaceWithinSourceContent = request.PlaceWithinSourceContent,
-                    OpacityExpression = request.OpacityExpression
+                    OpacityExpression = request.OpacityExpression,
+                    ZIndex = request.ZIndex
                 };
 
                 if (request.ImageSource == ChannelWatermarkImageSource.Custom)

ErsatzTV.Application/Watermarks/Commands/UpdateWatermark.cs

@@ -20,6 +20,7 @@ public record UpdateWatermark(
     int DurationSeconds,
     int Opacity,
     bool PlaceWithinSourceContent,
-    string OpacityExpression) : IRequest<Either<BaseError, UpdateWatermarkResult>>;
+    string OpacityExpression,
+    int ZIndex) : IRequest<Either<BaseError, UpdateWatermarkResult>>;
 
 public record UpdateWatermarkResult(int WatermarkId) : EntityIdResult(WatermarkId);

ErsatzTV.Application/Watermarks/Commands/UpdateWatermarkHandler.cs

@@ -54,6 +54,7 @@ public class UpdateWatermarkHandler : IRequestHandler<UpdateWatermark, Either<Ba
         p.Opacity = update.Opacity;
         p.PlaceWithinSourceContent = update.PlaceWithinSourceContent;
         p.OpacityExpression = update.Mode is ChannelWatermarkMode.OpacityExpression ? update.OpacityExpression : null;
+        p.ZIndex = update.ZIndex;
 
         await dbContext.SaveChangesAsync();
         _searchTargets.SearchTargetsChanged();

ErsatzTV.Application/Watermarks/Mapper.cs

@@ -21,5 +21,6 @@ internal static class Mapper
             watermark.DurationSeconds,
             watermark.Opacity,
             watermark.PlaceWithinSourceContent,
-            watermark.OpacityExpression);
+            watermark.OpacityExpression,
+            watermark.ZIndex);
 }

ErsatzTV.Application/Watermarks/WatermarkViewModel.cs

@@ -19,5 +19,5 @@ public record WatermarkViewModel(
     int DurationSeconds,
     int Opacity,
     bool PlaceWithinSourceContent,
-    string OpacityExpression
-);
+    string OpacityExpression,
+    int ZIndex);

ErsatzTV.Core/Domain/ChannelWatermark.cs

@@ -22,6 +22,7 @@ public class ChannelWatermark
     public string OpacityExpression { get; set; }
     public List<PlayoutItem> PlayoutItems { get; set; }
     public List<PlayoutItemWatermark> PlayoutItemWatermarks { get; set; }
+    public int ZIndex { get; set; }
 }
 
 public enum ChannelWatermarkMode

ErsatzTV.Core/Interfaces/Streaming/IGraphicsElement.cs

@@ -4,6 +4,8 @@ namespace ErsatzTV.Core.Interfaces.Streaming;
 
 public interface IGraphicsElement
 {
+    int ZIndex { get; }
+
     bool IsFailed { get; set; }
 
     Task InitializeAsync(Resolution frameSize, int frameRate, CancellationToken cancellationToken);

ErsatzTV.Infrastructure.MySql/Migrations/20250808002108_Add_ChannelWatermarkZIndex.cs

@@ -0,0 +1,29 @@
+using Microsoft.EntityFrameworkCore.Migrations;
+
+#nullable disable
+
+namespace ErsatzTV.Infrastructure.MySql.Migrations
+{
+    /// <inheritdoc />
+    public partial class Add_ChannelWatermarkZIndex : Migration
+    {
+        /// <inheritdoc />
+        protected override void Up(MigrationBuilder migrationBuilder)
+        {
+            migrationBuilder.AddColumn<int>(
+                name: "ZIndex",
+                table: "ChannelWatermark",
+                type: "int",
+                nullable: false,
+                defaultValue: 0);
+        }
+
+        /// <inheritdoc />
+        protected override void Down(MigrationBuilder migrationBuilder)
+        {
+            migrationBuilder.DropColumn(
+                name: "ZIndex",
+                table: "ChannelWatermark");
+        }
+    }
+}

ErsatzTV.Infrastructure.MySql/Migrations/TvContextModelSnapshot.cs

@@ -397,6 +397,9 @@ namespace ErsatzTV.Infrastructure.MySql.Migrations
                     b.Property<double>("WidthPercent")
                         .HasColumnType("double");
 
+                    b.Property<int>("ZIndex")
+                        .HasColumnType("int");
+
                     b.HasKey("Id");
 
                     b.ToTable("ChannelWatermark", (string)null);

ErsatzTV.Infrastructure.Sqlite/Migrations/20250808002026_Add_ChannelWatermarkZIndex.cs

@@ -0,0 +1,29 @@
+using Microsoft.EntityFrameworkCore.Migrations;
+
+#nullable disable
+
+namespace ErsatzTV.Infrastructure.Sqlite.Migrations
+{
+    /// <inheritdoc />
+    public partial class Add_ChannelWatermarkZIndex : Migration
+    {
+        /// <inheritdoc />
+        protected override void Up(MigrationBuilder migrationBuilder)
+        {
+            migrationBuilder.AddColumn<int>(
+                name: "ZIndex",
+                table: "ChannelWatermark",
+                type: "INTEGER",
+                nullable: false,
+                defaultValue: 0);
+        }
+
+        /// <inheritdoc />
+        protected override void Down(MigrationBuilder migrationBuilder)
+        {
+            migrationBuilder.DropColumn(
+                name: "ZIndex",
+                table: "ChannelWatermark");
+        }
+    }
+}

ErsatzTV.Infrastructure.Sqlite/Migrations/TvContextModelSnapshot.cs

@@ -382,6 +382,9 @@ namespace ErsatzTV.Infrastructure.Sqlite.Migrations
                     b.Property<double>("WidthPercent")
                         .HasColumnType("REAL");
 
+                    b.Property<int>("ZIndex")
+                        .HasColumnType("INTEGER");
+
                     b.HasKey("Id");
 
                     b.ToTable("ChannelWatermark", (string)null);

ErsatzTV.Infrastructure/Streaming/GraphicsEngine.cs

@@ -61,7 +61,7 @@ public class GraphicsEngine(ILogger<GraphicsEngine> logger) : IGraphicsEngine
                 // draw each element
                 outputFrame.Mutate(ctx =>
                 {
-                    foreach (var element in elements)
+                    foreach (var element in elements.OrderBy(e => e.ZIndex))
                     {
                         try
                         {

ErsatzTV.Infrastructure/Streaming/WatermarkElement.cs

@@ -35,11 +35,14 @@ public class WatermarkElement : IGraphicsElement, IDisposable
         foreach (var watermark in watermarkOptions.Watermark)
         {
             _watermark = watermark;
+            ZIndex = watermark.ZIndex;
         }
     }
 
     public bool IsValid => _imagePath != null && _watermark != null;
 
+    public int ZIndex { get; }
+
     public bool IsFailed { get; set; }
 
     public async Task InitializeAsync(Resolution frameSize, int frameRate, CancellationToken cancellationToken)

ErsatzTV/Pages/WatermarkEditor.razor

@@ -188,6 +188,12 @@
                               For="@(() => _model.OpacityExpression)"
                               Disabled="@(_model.Mode != ChannelWatermarkMode.OpacityExpression)"/>
             </MudStack>
+            <MudStack Row="true" Breakpoint="Breakpoint.SmAndDown" Class="form-field-stack gap-md-8 mb-5">
+                <div class="d-flex">
+                    <MudText>Z-Index</MudText>
+                </div>
+                <MudTextField @bind-Value="_model.ZIndex" For="@(() => _model.ZIndex)"/>
+            </MudStack>
         </MudContainer>
     </div>
 </MudForm>
@@ -233,7 +239,8 @@
                 DurationSeconds = 15,
                 Opacity = 100,
                 PlaceWithinSourceContent = false,
-                OpacityExpression = string.Empty
+                OpacityExpression = string.Empty,
+                ZIndex = 0
             };
         }
     }

ErsatzTV/ViewModels/WatermarkEditViewModel.cs

@@ -28,6 +28,7 @@ public class WatermarkEditViewModel
         Opacity = vm.Opacity;
         PlaceWithinSourceContent = vm.PlaceWithinSourceContent;
         OpacityExpression = vm.OpacityExpression;
+        ZIndex = vm.ZIndex;
     }
 
     public int Id { get; set; }
@@ -45,6 +46,7 @@ public class WatermarkEditViewModel
     public int Opacity { get; set; }
     public bool PlaceWithinSourceContent { get; set; }
     public string OpacityExpression { get; set; }
+    public int ZIndex { get; set; }
 
     public CreateWatermark ToCreate() =>
         new(
@@ -61,7 +63,8 @@ public class WatermarkEditViewModel
             DurationSeconds,
             Opacity,
             PlaceWithinSourceContent,
-            OpacityExpression);
+            OpacityExpression,
+            ZIndex);
 
     public UpdateWatermark ToUpdate() =>
         new(
@@ -79,5 +82,6 @@ public class WatermarkEditViewModel
             DurationSeconds,
             Opacity,
             PlaceWithinSourceContent,
-            OpacityExpression);
+            OpacityExpression,
+            ZIndex);
 }