Add ability to read tick-by-tick with StartReadingAsync and MoveNextAsync

README.md

@@ -40,7 +40,7 @@ internal class Program
             Console.WriteLine($"{e.Attacker?.PlayerName} [{e.Weapon}] {e.Player?.PlayerName}");
         };
 
-        await demo.Start(File.OpenRead(path));
+        await demo.ReadAllAsync(File.OpenRead(path));
 
         Console.WriteLine("\nFinished!");
     }

RELEASE_NOTES.md

@@ -1,3 +1,9 @@
+### 0.8.1 (2023-12-30)
+
+- BREAKING CHANGE: `DemoParser.Start` is now `DemoParser.ReadAllAsync`
+- Added ability to read tick-by-tick with `DemoParser.StartReadingAsync` and `DemoParser.MoveNextAsync`
+- Added comparison operators to `DemoTick` and `GameTick`
+
 ### 0.7.1 (2023-12-23)
 
 - Read CDemoFileInfo in seekable streams (available on complete demo recordings only)

demofile-net.sln

@@ -34,6 +34,8 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "DemoFile.Example.Inventory"
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "DemoFile.GameStaticGen", "src\DemoFile.GameStaticGen\DemoFile.GameStaticGen.csproj", "{40A1ECD4-3817-4618-906C-8EC0F3E7120A}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "DemoFile.Example.TickByTick", "examples\DemoFile.Example.TickByTick\DemoFile.Example.TickByTick.csproj", "{2C6DF000-2878-454F-8C4C-0EB68E3C2B3A}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -80,11 +82,16 @@ Global
 		{40A1ECD4-3817-4618-906C-8EC0F3E7120A}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{40A1ECD4-3817-4618-906C-8EC0F3E7120A}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{40A1ECD4-3817-4618-906C-8EC0F3E7120A}.Release|Any CPU.Build.0 = Release|Any CPU
+		{2C6DF000-2878-454F-8C4C-0EB68E3C2B3A}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{2C6DF000-2878-454F-8C4C-0EB68E3C2B3A}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{2C6DF000-2878-454F-8C4C-0EB68E3C2B3A}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{2C6DF000-2878-454F-8C4C-0EB68E3C2B3A}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(NestedProjects) = preSolution
 		{C2452138-91E4-4160-B051-A201080C1953} = {20EAA685-6916-4B0C-8D0C-E407B072E28F}
 		{1A0CF2C7-AE27-4BB7-8BE0-A35DDEF6CBBA} = {20EAA685-6916-4B0C-8D0C-E407B072E28F}
 		{0FB0D403-E4B2-4073-B8B0-6FB296861DCA} = {20EAA685-6916-4B0C-8D0C-E407B072E28F}
 		{718DE4D1-54C9-452B-86AC-1647F669D3CD} = {20EAA685-6916-4B0C-8D0C-E407B072E28F}
+		{2C6DF000-2878-454F-8C4C-0EB68E3C2B3A} = {20EAA685-6916-4B0C-8D0C-E407B072E28F}
 	EndGlobalSection
 EndGlobal

examples/DemoFile.Example.Basic/DemoFile.Example.Basic.csproj

@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <OutputType>Exe</OutputType>
-    <TargetFramework>net7.0</TargetFramework>
+    <TargetFramework>net8.0</TargetFramework>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
     <TreatWarningsAsErrors>true</TreatWarningsAsErrors>

examples/DemoFile.Example.Basic/Program.cs

@@ -12,7 +12,7 @@ public static async Task Main(string[] args)
             Console.WriteLine($"{e.Attacker?.PlayerName} [{e.Weapon}] {e.Player?.PlayerName}");
         };
 
-        await demo.Start(File.OpenRead(path));
+        await demo.ReadAllAsync(File.OpenRead(path));
 
         Console.WriteLine("\nFinished!");
     }

examples/DemoFile.Example.Inventory/Program.cs

@@ -85,7 +85,7 @@ void DumpGrenadeInventory()
         var sw = Stopwatch.StartNew();
         try
         {
-            await demo.Start(File.OpenRead(path), cts.Token);
+            await demo.ReadAllAsync(File.OpenRead(path), cts.Token);
         }
         catch (OperationCanceledException) when (cts.IsCancellationRequested)
         {

examples/DemoFile.Example.KillFeed/Program.cs

@@ -46,7 +46,7 @@ public static async Task Main(string[] args)
 
         // Now that we've attached the event listeners, start reading the demo
         var sw = Stopwatch.StartNew();
-        await demo.Start(File.OpenRead(path));
+        await demo.ReadAllAsync(File.OpenRead(path));
         sw.Stop();
 
         var ticks = demo.CurrentDemoTick.Value;

examples/DemoFile.Example.Scoreboard/Program.cs

@@ -35,7 +35,7 @@ public static async Task Main(string[] args)
             AnsiConsole.Write(table);
         };
 
-        await demo.Start(File.OpenRead(path));
+        await demo.ReadAllAsync(File.OpenRead(path));
     }
 
     private static void AddTeamRows(DemoParser demo, Table table, CCSTeam team)

examples/DemoFile.Example.TickByTick/DemoFile.Example.TickByTick.csproj

@@ -0,0 +1,15 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <TargetFramework>net7.0</TargetFramework>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <Nullable>enable</Nullable>
+    <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\..\src\DemoFile\DemoFile.csproj" />
+  </ItemGroup>
+
+</Project>

examples/DemoFile.Example.TickByTick/Program.cs

@@ -0,0 +1,30 @@
+using DemoFile;
+
+internal class Program
+{
+    public static async Task Main(string[] args)
+    {
+        var path = args.SingleOrDefault() ?? throw new Exception("Expected a single argument: <path to .dem>");
+
+        var demo = new DemoParser();
+        demo.Source1GameEvents.PlayerDeath += e =>
+        {
+            Console.WriteLine($"{e.Attacker?.PlayerName} [{e.Weapon}] {e.Player?.PlayerName}");
+        };
+
+        // Read 20 minutes of gameplay before stopping
+        var readUntilTicks = DemoTick.Zero + TimeSpan.FromMinutes(20);
+
+        await demo.StartReadingAsync(File.OpenRead(path), default(CancellationToken));
+        while (demo.CurrentDemoTick < readUntilTicks)
+        {
+            if (!await demo.MoveNextAsync(default(CancellationToken)))
+            {
+                // We've reached the end of the demo file
+                break;
+            }
+        }
+
+        Console.WriteLine("\nFinished!");
+    }
+}

src/DemoFile.Benchmark/DemoFile.Benchmark.csproj

@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <OutputType>Exe</OutputType>
-    <TargetFramework>net7.0</TargetFramework>
+    <TargetFramework>net8.0</TargetFramework>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
   </PropertyGroup>

src/DemoFile.Benchmark/DemoParserBenchmark.cs

@@ -17,13 +17,14 @@
             var baseJob = Job.Default;
 
             AddJob(baseJob.WithArguments(new[] { new MsBuildArgument("/p:Baseline=true") }).AsBaseline().WithId("Baseline"));
-            AddJob(baseJob.WithId("Current"));
+            AddJob(baseJob);
+            //AddJob(baseJob.WithArguments(new[] { new MsBuildArgument("/p:ClearBuf=true") }).WithId("ClearBuf"));
         }
     }
 
     private DemoParser _demoParser;
     private MemoryStream _fileStream;
     private byte[] _demoBytes;
 
     [GlobalSetup]
     public void GlobalSetup()
@@ -41,6 +42,10 @@
     public async Task ParseDemo()
     {
         _demoParser = new DemoParser();
+#if BASELINE
         await _demoParser.Start(_fileStream, default);
+#else
+        await _demoParser.ReadAllAsync(_fileStream, default);
+#endif
     }
 }

src/DemoFile.SdkGen/Program.cs

@@ -211,7 +211,7 @@ public static async Task Main(string[] args)
 
         try
         {
-            await demo.Start(File.OpenRead(demoPath), cts.Token);
+            await demo.ReadAllAsync(File.OpenRead(demoPath), cts.Token);
         }
         catch (OperationCanceledException) when (cts.IsCancellationRequested)
         {

src/DemoFile.Source1EventGen/Program.cs

@@ -25,7 +25,7 @@ public static async Task Main(string[] args)
 
         try
         {
-            await demo.Start(File.OpenRead(demoPath), cts.Token);
+            await demo.ReadAllAsync(File.OpenRead(demoPath), cts.Token);
         }
         catch (OperationCanceledException) when (cts.IsCancellationRequested)
         {

src/DemoFile.Test/Integration/DemoEventsIntegrationTest.cs

@@ -3,9 +3,17 @@
 
 namespace DemoFile.Test.Integration;
 
-[TestFixture]
+[TestFixture(true)]
+[TestFixture(false)]
 public class DemoEventsIntegrationTest
 {
+    private readonly bool _readAll;
+
+    public DemoEventsIntegrationTest(bool readAll)
+    {
+        _readAll = readAll;
+    }
+
     [Test]
     public async Task DemoFileInfo()
     {
@@ -25,7 +33,17 @@ public async Task DemoFileInfo()
         };
 
         // Act
-        await demo.Start(GotvCompetitiveProtocol13963, default);
+        if (_readAll)
+        {
+            await demo.ReadAllAsync(GotvCompetitiveProtocol13963, default);
+        }
+        else
+        {
+            await demo.StartReadingAsync(GotvCompetitiveProtocol13963, default);
+            while (await demo.MoveNextAsync(default))
+            {
+            }
+        }
 
         // Assert
         Snapshot.Assert(snapshot.ToString());

src/DemoFile.Test/Integration/DemoParserIntegrationTest.cs

@@ -1,16 +1,34 @@
-using System.Text;
-using System.Text.Json;
-
-namespace DemoFile.Test.Integration;
+namespace DemoFile.Test.Integration;
 
 [TestFixture]
 public class DemoParserIntegrationTest
 {
     [Test]
-    public async Task Parse()
+    public async Task ReadAll()
+    {
+        var demo = new DemoParser();
+        await demo.ReadAllAsync(GotvCompetitiveProtocol13963, default);
+        Assert.That(demo.CurrentDemoTick.Value, Is.EqualTo(217866));
+    }
+
+    [Test]
+    public async Task ByTick()
     {
+        // Arrange
         var demo = new DemoParser();
-        await demo.Start(GotvCompetitiveProtocol13963, default);
+        var tick = demo.CurrentDemoTick;
+
+        // Act
+        await demo.StartReadingAsync(GotvCompetitiveProtocol13963, default);
+        while (await demo.MoveNextAsync(default))
+        {
+            // Tick is monotonic
+            Assert.That(demo.CurrentDemoTick.Value, Is.GreaterThanOrEqualTo(tick.Value));
+            tick = demo.CurrentDemoTick;
+        }
+
+        // Assert
+        Assert.That(demo.CurrentDemoTick.Value, Is.EqualTo(217866));
     }
 
     private static readonly KeyValuePair<string, Stream>[] CompatibilityCases =
@@ -20,16 +38,16 @@ public async Task Parse()
     };
 
     [TestCaseSource(nameof(CompatibilityCases))]
-    public async Task Parse_Compatibility(KeyValuePair<string, Stream> testCase)
+    public async Task ReadAll_Compatibility(KeyValuePair<string, Stream> testCase)
     {
         var demo = new DemoParser();
-        await demo.Start(testCase.Value, default);
+        await demo.ReadAllAsync(testCase.Value, default);
     }
 
     [Test]
-    public async Task Parse_AlternateBaseline()
+    public async Task ReadAll_AlternateBaseline()
     {
         var demo = new DemoParser();
-        await demo.Start(MatchmakingProtocol13968, default);
+        await demo.ReadAllAsync(MatchmakingProtocol13968, default);
     }
 }

src/DemoFile.Test/Integration/PlayerPropsIntegrationTest.cs

@@ -3,9 +3,17 @@
 
 namespace DemoFile.Test.Integration;
 
-[TestFixture]
+[TestFixture(true)]
+[TestFixture(false)]
 public class PlayerPropsIntegrationTest
 {
+    private readonly bool _readAll;
+
+    public PlayerPropsIntegrationTest(bool readAll)
+    {
+        _readAll = readAll;
+    }
+
     [Test]
     public async Task Position()
     {
@@ -82,7 +90,17 @@ void OnSnapshotTimer()
         demo.CreateTimer(DemoTick.Zero + playerSnapshotInterval, OnSnapshotTimer);
 
         // Act
-        await demo.Start(GotvCompetitiveProtocol13963, default);
+        if (_readAll)
+        {
+            await demo.ReadAllAsync(GotvCompetitiveProtocol13963, default);
+        }
+        else
+        {
+            await demo.StartReadingAsync(GotvCompetitiveProtocol13963, default);
+            while (await demo.MoveNextAsync(default))
+            {
+            }
+        }
 
         // Assert
         Snapshot.Assert(snapshot.ToString());

src/DemoFile.Test/Integration/Source1GameEventIntegrationTest.cs

@@ -3,9 +3,17 @@
 
 namespace DemoFile.Test.Integration;
 
-[TestFixture]
+[TestFixture(true)]
+[TestFixture(false)]
 public class Source1GameEventIntegrationTest
 {
+    private readonly bool _readAll;
+
+    public Source1GameEventIntegrationTest(bool readAll)
+    {
+        _readAll = readAll;
+    }
+
     [Test]
     public async Task GameEvent()
     {
@@ -27,7 +35,17 @@ public async Task GameEvent()
         };
 
         // Act
-        await demo.Start(GotvCompetitiveProtocol13963, default);
+        if (_readAll)
+        {
+            await demo.ReadAllAsync(GotvCompetitiveProtocol13963, default);
+        }
+        else
+        {
+            await demo.StartReadingAsync(GotvCompetitiveProtocol13963, default);
+            while (await demo.MoveNextAsync(default))
+            {
+            }
+        }
 
         // Assert
         Snapshot.Assert(snapshot.ToString());
@@ -56,6 +74,16 @@ public async Task PlayerProperties()
             Assert.That(e.PlayerPawn, Is.Not.Null);
         };
 
-        await demo.Start(GotvCompetitiveProtocol13963, default);
+        if (_readAll)
+        {
+            await demo.ReadAllAsync(GotvCompetitiveProtocol13963, default);
+        }
+        else
+        {
+            await demo.StartReadingAsync(GotvCompetitiveProtocol13963, default);
+            while (await demo.MoveNextAsync(default))
+            {
+            }
+        }
     }
 }