Add LocalCast native reservoir binding

This commit is contained in:
Meta Vens 2026-05-19 10:43:07 +01:00
commit 4d5aec7e2e
2 changed files with 283 additions and 0 deletions

View file

@ -0,0 +1,241 @@
using System.Runtime.InteropServices;
namespace Aquarium.LocalCast;
public enum LocalCastNativeSampleKind : uint
{
CameraFrame = 0,
CameraFeature = 1,
SceneRay = 2,
SurfaceClaim = 3,
MaterialClaim = 4,
AudioBlock = 5,
PhaseClaim = 6,
EventClaim = 7,
RenderPacket = 8,
}
[Flags]
public enum LocalCastNativeSampleFlags : uint
{
None = 0,
Diagnostic = 1u << 0,
}
[StructLayout(LayoutKind.Sequential)]
public struct LocalCastNativeSampleHandle
{
public ulong SensorIdHash;
public ulong TimestampNs;
public ulong ArrivalNs;
public ulong Sequence;
public ulong PayloadHandle;
public LocalCastNativeSampleFlags Flags;
public uint Reserved;
public readonly bool IsLive => Flags == LocalCastNativeSampleFlags.None;
}
[StructLayout(LayoutKind.Sequential)]
public struct LocalCastNativeRuntimeStatus
{
public ulong EdgeNs;
public ulong WindowStartNs;
public UIntPtr TotalSampleCount;
public UIntPtr CameraFrameCount;
public UIntPtr CameraFeatureCount;
public UIntPtr SceneRayCount;
public UIntPtr SurfaceClaimCount;
public UIntPtr MaterialClaimCount;
public UIntPtr AudioBlockCount;
public UIntPtr PhaseClaimCount;
public UIntPtr EventClaimCount;
public UIntPtr RenderPacketCount;
}
public interface ILocalCastNativeRuntime : IDisposable
{
bool TryGetStatus(out LocalCastNativeRuntimeStatus status);
bool TryReadSample(nuint index, out LocalCastNativeSampleKind kind, out LocalCastNativeSampleHandle sample);
bool TryReadViewSample(LocalCastNativeSampleKind kind, nuint index, out LocalCastNativeSampleHandle sample);
bool TryReadLatestForSensor(LocalCastNativeSampleKind kind, ulong sensorIdHash, out LocalCastNativeSampleHandle sample);
}
public interface ILocalCastNativeProducer : IDisposable
{
ulong NextSequence { get; }
bool TryPush(ulong timestampNs, ulong arrivalNs, ulong payloadHandle, out LocalCastNativeSampleHandle sample);
}
public sealed class LocalCastNativeRuntime : ILocalCastNativeRuntime
{
private IntPtr handle;
public LocalCastNativeRuntime(ulong durationNs)
{
handle = LocalCastNativeMethods.RuntimeCreate(durationNs);
if (handle == IntPtr.Zero)
{
throw new InvalidOperationException("LocalCast native runtime creation failed.");
}
}
internal IntPtr Handle => handle;
public bool TryGetStatus(out LocalCastNativeRuntimeStatus status)
{
EnsureNotDisposed();
return LocalCastNativeMethods.RuntimeStatus(handle, out status);
}
public bool TryReadSample(nuint index, out LocalCastNativeSampleKind kind, out LocalCastNativeSampleHandle sample)
{
EnsureNotDisposed();
var ok = LocalCastNativeMethods.RuntimeSampleAt(handle, index, out var rawKind, out sample);
kind = (LocalCastNativeSampleKind)rawKind;
return ok;
}
public bool TryReadViewSample(LocalCastNativeSampleKind kind, nuint index, out LocalCastNativeSampleHandle sample)
{
EnsureNotDisposed();
return LocalCastNativeMethods.RuntimeViewSampleAt(handle, (uint)kind, index, out sample);
}
public bool TryReadLatestForSensor(LocalCastNativeSampleKind kind, ulong sensorIdHash, out LocalCastNativeSampleHandle sample)
{
EnsureNotDisposed();
return LocalCastNativeMethods.RuntimeLatestForSensor(handle, (uint)kind, sensorIdHash, out sample);
}
public LocalCastNativeProducer CreateProducer(LocalCastNativeSampleKind kind, ulong sensorIdHash, ulong initialSequence = 0)
{
EnsureNotDisposed();
return new LocalCastNativeProducer(this, kind, sensorIdHash, initialSequence);
}
public void Dispose()
{
if (handle == IntPtr.Zero)
{
return;
}
LocalCastNativeMethods.RuntimeDestroy(handle);
handle = IntPtr.Zero;
}
private void EnsureNotDisposed()
{
ObjectDisposedException.ThrowIf(handle == IntPtr.Zero, this);
}
}
public sealed class LocalCastNativeProducer : ILocalCastNativeProducer
{
private readonly LocalCastNativeRuntime runtime;
private IntPtr handle;
internal LocalCastNativeProducer(LocalCastNativeRuntime runtime, LocalCastNativeSampleKind kind, ulong sensorIdHash, ulong initialSequence)
{
this.runtime = runtime;
handle = LocalCastNativeMethods.ProducerCreate((uint)kind, sensorIdHash, initialSequence);
if (handle == IntPtr.Zero)
{
throw new InvalidOperationException("LocalCast native producer creation failed.");
}
}
public ulong NextSequence
{
get
{
EnsureNotDisposed();
return LocalCastNativeMethods.ProducerNextSequence(handle);
}
}
public bool TryPush(ulong timestampNs, ulong arrivalNs, ulong payloadHandle, out LocalCastNativeSampleHandle sample)
{
EnsureNotDisposed();
return LocalCastNativeMethods.ProducerPush(handle, runtime.Handle, timestampNs, arrivalNs, payloadHandle, out sample);
}
public void Dispose()
{
if (handle == IntPtr.Zero)
{
return;
}
LocalCastNativeMethods.ProducerDestroy(handle);
handle = IntPtr.Zero;
}
private void EnsureNotDisposed()
{
ObjectDisposedException.ThrowIf(handle == IntPtr.Zero, this);
}
}
internal static class LocalCastNativeMethods
{
private const string LibraryName = "localcast_reservoir";
[DllImport(LibraryName, EntryPoint = "localcast_runtime_create")]
internal static extern IntPtr RuntimeCreate(ulong durationNs);
[DllImport(LibraryName, EntryPoint = "localcast_runtime_destroy")]
internal static extern void RuntimeDestroy(IntPtr runtime);
[DllImport(LibraryName, EntryPoint = "localcast_runtime_status")]
[return: MarshalAs(UnmanagedType.I1)]
internal static extern bool RuntimeStatus(IntPtr runtime, out LocalCastNativeRuntimeStatus status);
[DllImport(LibraryName, EntryPoint = "localcast_runtime_sample_at")]
[return: MarshalAs(UnmanagedType.I1)]
internal static extern bool RuntimeSampleAt(
IntPtr runtime,
UIntPtr index,
out uint sampleKind,
out LocalCastNativeSampleHandle sample);
[DllImport(LibraryName, EntryPoint = "localcast_runtime_view_sample_at")]
[return: MarshalAs(UnmanagedType.I1)]
internal static extern bool RuntimeViewSampleAt(
IntPtr runtime,
uint sampleKind,
UIntPtr index,
out LocalCastNativeSampleHandle sample);
[DllImport(LibraryName, EntryPoint = "localcast_runtime_latest_for_sensor")]
[return: MarshalAs(UnmanagedType.I1)]
internal static extern bool RuntimeLatestForSensor(
IntPtr runtime,
uint sampleKind,
ulong sensorIdHash,
out LocalCastNativeSampleHandle sample);
[DllImport(LibraryName, EntryPoint = "localcast_producer_create")]
internal static extern IntPtr ProducerCreate(uint sampleKind, ulong sensorIdHash, ulong initialSequence);
[DllImport(LibraryName, EntryPoint = "localcast_producer_destroy")]
internal static extern void ProducerDestroy(IntPtr producer);
[DllImport(LibraryName, EntryPoint = "localcast_producer_next_sequence")]
internal static extern ulong ProducerNextSequence(IntPtr producer);
[DllImport(LibraryName, EntryPoint = "localcast_producer_push")]
[return: MarshalAs(UnmanagedType.I1)]
internal static extern bool ProducerPush(
IntPtr producer,
IntPtr runtime,
ulong timestampNs,
ulong arrivalNs,
ulong payloadHandle,
out LocalCastNativeSampleHandle sample);
}

View file

@ -0,0 +1,42 @@
using System.Runtime.InteropServices;
using Aquarium.LocalCast;
namespace Aquarium.LocalCast.Tests;
public sealed class LocalCastNativeReservoirTests
{
[Fact]
public void SampleKindIdsMatchLocalcastReservoirHeader()
{
Assert.Equal(0u, (uint)LocalCastNativeSampleKind.CameraFrame);
Assert.Equal(5u, (uint)LocalCastNativeSampleKind.AudioBlock);
Assert.Equal(8u, (uint)LocalCastNativeSampleKind.RenderPacket);
}
[Fact]
public void SampleHandleLayoutMatchesNativeAbi()
{
Assert.Equal(48, Marshal.SizeOf<LocalCastNativeSampleHandle>());
var handle = new LocalCastNativeSampleHandle
{
SensorIdHash = 10,
TimestampNs = 20,
ArrivalNs = 21,
Sequence = 7,
PayloadHandle = 99,
Flags = LocalCastNativeSampleFlags.None,
};
Assert.True(handle.IsLive);
handle.Flags = LocalCastNativeSampleFlags.Diagnostic;
Assert.False(handle.IsLive);
}
[Fact]
public void RuntimeStatusLayoutUsesNativeSizeCounts()
{
var expected = 16 + (10 * UIntPtr.Size);
Assert.Equal(expected, Marshal.SizeOf<LocalCastNativeRuntimeStatus>());
}
}