From e7217c5bc7a755234924c2297fe40b4e1617c674 Mon Sep 17 00:00:00 2001
From: Arthur Yousif <ay.se.contract@outlook.com>
Date: Sat, 8 Mar 2025 15:45:04 -0600
Subject: [PATCH] Added support for multiple windows in a WDS based on the spec
 def at
 https://blog.thescorpius.com/index.php/2017/07/15/presentation-graphic-stream-sup-files-bluray-subtitle-format/

---
 libsup/WindowDefinition.cs        | 85 +++++++++++++++++++++++++++++++
 libsup/WindowDefinitionSegment.cs | 67 +++++++-----------------
 2 files changed, 104 insertions(+), 48 deletions(-)
 create mode 100644 libsup/WindowDefinition.cs

diff --git a/libsup/WindowDefinition.cs b/libsup/WindowDefinition.cs
new file mode 100644
index 0000000..5718b7d
--- /dev/null
+++ b/libsup/WindowDefinition.cs
@@ -0,0 +1,85 @@
+using JetBrains.Annotations;
+using System;
+using System.IO;
+
+namespace libsup
+{
+    /// <summary>
+    /// A window
+    /// </summary>
+    [PublicAPI]
+    public sealed class WindowDefinition
+    {
+        /// <summary>
+        /// Gets the window identifier.
+        /// </summary>
+        /// <value>
+        /// The window identifier.
+        /// </value>
+        public byte WindowId { get; }
+        /// <summary>
+        /// Gets the window horizontal position.
+        /// </summary>
+        /// <value>
+        /// The window horizontal position.
+        /// </value>
+        public ushort WindowHorizontalPosition { get; }
+        /// <summary>
+        /// Gets the window vertical position.
+        /// </summary>
+        /// <value>
+        /// The window vertical position.
+        /// </value>
+        public ushort WindowVerticalPosition { get; }
+        /// <summary>
+        /// Gets the width of the window.
+        /// </summary>
+        /// <value>
+        /// The width of the window.
+        /// </value>
+        public ushort WindowWidth { get; }
+        /// <summary>
+        /// Gets the height of the window.
+        /// </summary>
+        /// <value>
+        /// The height of the window.
+        /// </value>
+        public ushort WindowHeight { get; }
+        /// <summary>
+        /// Initializes a new instance of the <see cref="WindowDefinition"/> class.
+        /// </summary>
+        internal WindowDefinition()
+        {
+            // do nothing
+        }
+        internal WindowDefinition(byte[] bytes)
+        {
+            // Check for invalid amount of bytes in the given byte collection.
+            if (bytes.Length != 9)
+            {
+                throw new InvalidDataException(
+                    "The given byte array has an invalid amount of data and cannot be parsed as a window item!");
+            }
+
+            // Map the byte values in the given collection to their corresponding properties.
+            WindowId = bytes[0];
+
+            var horizpos = bytes.Slice(1, 2);
+            var vertipos = bytes.Slice(3, 2);
+            var width = bytes.Slice(5, 2);
+            var height = bytes.Slice(7, 2);
+
+            if (!BitConverter.IsLittleEndian)
+            {
+                Array.Reverse(horizpos);
+                Array.Reverse(vertipos);
+                Array.Reverse(width);
+                Array.Reverse(height);
+            }
+            WindowHorizontalPosition = BitConverter.ToUInt16(horizpos, 0);
+            WindowVerticalPosition = BitConverter.ToUInt16(vertipos, 0);
+            WindowWidth = BitConverter.ToUInt16(width, 0);
+            WindowHeight = BitConverter.ToUInt16(height, 0);
+        }
+    }
+}
diff --git a/libsup/WindowDefinitionSegment.cs b/libsup/WindowDefinitionSegment.cs
index a849fa8..bbb71d1 100644
--- a/libsup/WindowDefinitionSegment.cs
+++ b/libsup/WindowDefinitionSegment.cs
@@ -1,6 +1,6 @@
-using System;
+using JetBrains.Annotations;
+using System.Collections.Immutable;
 using System.IO;
-using JetBrains.Annotations;
 
 namespace libsup
 {
@@ -19,30 +19,19 @@ public sealed class WindowDefinitionSegment : SegmentDetail
         public override SegmentType SegmentType => SegmentType.WDS;
 
         /// <summary>
-        /// ID of this window.
+        /// Number of windows defined in this segment.  Added support for multiple
+        /// windows based on the PGS spec. available here:
+        /// https://blog.thescorpius.com/index.php/2017/07/15/presentation-graphic-stream-sup-files-bluray-subtitle-format/
         /// </summary>
-        public byte WindowId { get; }
+        public byte NumberOfWindows { get; internal set; } = 1;
 
         /// <summary>
-        /// X offset from the top left pixel of the window in the screen.
+        /// Gets the windows.
         /// </summary>
-        public ushort WindowHorizontalPosition { get; }
-
-        /// <summary>
-        /// Y offset from the top left pixel of the window in the screen.
-        /// </summary>
-        public ushort WindowVerticalPosition { get; }
-
-        /// <summary>
-        /// Width of the window.
-        /// </summary>
-        public ushort WindowWidth { get; }
-
-        /// <summary>
-        /// Height of the window.
-        /// </summary>
-        public ushort WindowHeight { get; }
-
+        /// <value>
+        /// The windows.
+        /// </value>
+        public ImmutableList<WindowDefinition> Windows { get; }
         /// <inheritdoc />
         public override object Clone()
         {
@@ -50,16 +39,13 @@ public override object Clone()
         }
 
         /// <summary>
-        /// Create a clone of an existing <see cref="WindowDefinitionSegment"/>.
+        /// Initializes a new instance of the <see cref="WindowDefinitionSegment"/> class.
         /// </summary>
-        /// <param name="old">The original <see cref="WindowDefinitionSegment"/>.</param>
+        /// <param name="old">The old.</param>
         private WindowDefinitionSegment(WindowDefinitionSegment old)
         {
-            WindowId = old.WindowId;
-            WindowHorizontalPosition = old.WindowHorizontalPosition;
-            WindowVerticalPosition = old.WindowVerticalPosition;
-            WindowWidth = old.WindowWidth;
-            WindowHeight = old.WindowHeight;
+            NumberOfWindows = old.NumberOfWindows;
+            Windows = ImmutableList<WindowDefinition>.Empty.AddRange(old.Windows);
         }
 
         /// <summary>
@@ -78,27 +64,12 @@ internal WindowDefinitionSegment(byte[] bytes)
             }
 
             // Read values into temporary byte arrays.
-            var winid = bytes.Slice(0, 1);
-            var horizpos = bytes.Slice(1, 2);
-            var vertipos = bytes.Slice(3, 2);
-            var width = bytes.Slice(5, 2);
-            var height = bytes.Slice(7, 2);
-
-            // Reverse the big-endian encoded arrays if our system is not a big-endian system.
-            if (!BitConverter.IsLittleEndian)
+            var numWindows = bytes.Slice(0, 1);
+            Windows = ImmutableList<WindowDefinition>.Empty;
+            for (var i = 1; i < bytes.Length; i += MinimumLength)
             {
-                Array.Reverse(horizpos);
-                Array.Reverse(vertipos);
-                Array.Reverse(width);
-                Array.Reverse(height);
+                Windows = Windows.Add(new WindowDefinition(bytes.Slice(i, 9)));
             }
-
-            // Map the byte arrays into their corresponding property.
-            WindowId = winid[0];
-            WindowHorizontalPosition = BitConverter.ToUInt16(horizpos, 0);
-            WindowVerticalPosition = BitConverter.ToUInt16(vertipos, 0);
-            WindowWidth = BitConverter.ToUInt16(width, 0);
-            WindowHeight = BitConverter.ToUInt16(height, 0);
         }
     }
 }