From c31501f0f20e4298a9bb9a999073f0832de8d6ac Mon Sep 17 00:00:00 2001
From: Fyodor Sobolev <117388856+fsobolev@users.noreply.github.com>
Date: Mon, 2 Oct 2023 19:56:26 +0300
Subject: [PATCH] Add missing MPVRenderFrameInfo

---
 .../Internal/MPVRenderFrameInfo.cs            | 25 ++++++++++
 .../Internal/MPVRenderFrameInfoFlag.cs        | 50 +++++++++++++++++++
 Nickvision.MPVSharp/RenderContext.cs          |  7 +--
 3 files changed, 79 insertions(+), 3 deletions(-)
 create mode 100644 Nickvision.MPVSharp/Internal/MPVRenderFrameInfo.cs
 create mode 100644 Nickvision.MPVSharp/Internal/MPVRenderFrameInfoFlag.cs

diff --git a/Nickvision.MPVSharp/Internal/MPVRenderFrameInfo.cs b/Nickvision.MPVSharp/Internal/MPVRenderFrameInfo.cs
new file mode 100644
index 0000000..a228f9d
--- /dev/null
+++ b/Nickvision.MPVSharp/Internal/MPVRenderFrameInfo.cs
@@ -0,0 +1,25 @@
+namespace Nickvision.MPVSharp.Internal;
+
+/// <summary>
+/// Information about the next video frame that will be rendered. Can be
+/// retrieved with <see cref="MPVRenderParamType.NextFrameInfo"/>.
+/// </summary>
+public struct MPVRenderFrameInfo
+{
+    /// <summary>
+    /// A bitset of <see cref="MPVRenderFrameInfoFlag"/> values (i.e. multiple flags are
+    /// combined with bitwise or).
+    /// </summary>
+    public ulong Flags;
+    /// <summary>
+    /// Absolute time at which the frame is supposed to be displayed. This is in
+    /// the same unit and base as the time returned by <see cref="MPVClient.GetTimeUs"/>. For
+    /// frames that are redrawn, or if vsync locked video timing is used (see
+    /// "video-sync" option), then this can be 0. The "video-timing-offset"
+    /// option determines how much "headroom" the render thread gets (but a high
+    /// enough frame rate can reduce it anyway). <see cref="MPVRenderContext.Render"/> will
+    /// normally block until the time is elapsed, unless you pass it
+    /// <see cref="MPVRenderParamType.BlockForTargetTime"/> = 0.
+    /// </summary>
+    ulong TargetTime;
+}
\ No newline at end of file
diff --git a/Nickvision.MPVSharp/Internal/MPVRenderFrameInfoFlag.cs b/Nickvision.MPVSharp/Internal/MPVRenderFrameInfoFlag.cs
new file mode 100644
index 0000000..052f2dc
--- /dev/null
+++ b/Nickvision.MPVSharp/Internal/MPVRenderFrameInfoFlag.cs
@@ -0,0 +1,50 @@
+namespace Nickvision.MPVSharp.Internal;
+
+/// <summary>
+/// Flags used in <see cref="MPVRenderFrameInfo.Flags"/>. Each value represents a bit in it.
+/// </summary>
+public enum MPVRenderFrameInfoFlag
+{
+    /// <summary>
+    /// Set if there is actually a next frame. If unset, there is no next frame
+    /// yet, and other flags and fields that require a frame to be queued will
+    /// be unset.
+    /// This is set for _any_ kind of frame, even for redraw requests.
+    /// Note that when this is unset, it simply means no new frame was
+    /// decoded/queued yet, not necessarily that the end of the video was
+    /// reached. A new frame can be queued after some time.
+    /// If the return value of <see cref="MPVRenderContext.Render"/> had the
+    /// <see cref="MPVRenderUpdateFlags.UpdateFrame"/> flag set, this flag will usually be set as well,
+    /// unless the frame is rendered, or discarded by other asynchronous events.
+    /// </summary>
+    Present = 1 << 0,
+    /// <summary>
+    /// If set, the frame is not an actual new video frame, but a redraw request.
+    /// For example if the video is paused, and an option that affects video
+    /// rendering was changed (or any other reason), an update request can be
+    /// issued and this flag will be set.
+    /// Typically, redraw frames will not be subject to video timing.
+    /// </summary>
+    /// <remarks>
+    /// Implies <see cref="Present"/>.
+    /// </remarks>
+    Redraw = 1 << 1,
+    /// <summary>
+    /// If set, this is supposed to reproduce the previous frame perfectly. This
+    /// is usually used for certain "video-sync" options ("display-..." modes).
+    /// Typically the renderer will blit the video from a FBO. Unset otherwise.
+    /// </summary>
+    /// <remarks>
+    /// Implies <see cref="Present"/>.
+    /// </remarks>
+    Repeat = 1 << 2,
+    /// <summary>
+    /// If set, the player timing code expects that the user thread blocks on
+    /// vsync (by either delaying the render call, or by making a call to
+    /// <see cref="MPVRenderContext.ReportSwap"/> at vsync time).
+    /// </summary>
+    /// <remarks>
+    /// Implies <see cref="Present"/>.
+    /// </remarks>
+    BlockVsync = 1 << 3
+}
\ No newline at end of file
diff --git a/Nickvision.MPVSharp/RenderContext.cs b/Nickvision.MPVSharp/RenderContext.cs
index b101386..9f0edf9 100644
--- a/Nickvision.MPVSharp/RenderContext.cs
+++ b/Nickvision.MPVSharp/RenderContext.cs
@@ -29,7 +29,7 @@ public Func<string, nint> GetProcAddressFn
     }
 
     /// <summary>
-    /// Construct RenderContext
+    /// Constructs RenderContext
     /// </summary>
     public RenderContext(nint clientHandle)
     {
@@ -69,8 +69,9 @@ protected virtual void Dispose(bool disposing)
     }
     
     /// <summary>
-    /// Setup OpenGL rendering
+    /// Setups OpenGL rendering
     /// </summary>
+    /// <param name="callback">Callback to be called when a new frame needs to be rendered</param>
     /// <exception cref="ClientException">Thrown if unable to setup GL</exception>
     public void SetupGL(Action? callback)
     {
@@ -134,7 +135,7 @@ public void SetupGL(Action? callback)
     /// </summary>
     /// <param name="width">Rendering area width</param>
     /// <param name="height">Rendering area width</param>
-    /// <param name="fb">Framebuffer</param>
+    /// <param name="fb">Framebuffer object name</param>
     public void RenderGL(int width, int height, int? fb = null)
     {
         if (fb == null)