common: Better field types for DemoHeader

+ Tests

Author: markus-wa

common/common.go

@@ -21,39 +21,39 @@ const (
 
 // DemoHeader contains information from a demo's header.
 type DemoHeader struct {
-	Filestamp       string  // aka. File-type, must be HL2DEMO
-	Protocol        int     // Should be 4
-	NetworkProtocol int     // Not sure what this is for
-	ServerName      string  // Server's 'hostname' config value
-	ClientName      string  // Usually 'GOTV Demo'
-	MapName         string  // E.g. de_cache, de_nuke, cs_office, etc.
-	GameDirectory   string  // Usually 'csgo'
-	PlaybackTime    float32 // Demo duration in seconds (= PlaybackTicks / Server's tickrate)
-	PlaybackTicks   int     // Game duration in ticks (= PlaybackTime * Server's tickrate)
-	PlaybackFrames  int     // Amount of 'frames' aka demo-ticks recorded (= PlaybackTime * Demo's recording rate)
-	SignonLength    int     // Length of the Signon package in bytes
+	Filestamp       string        // aka. File-type, must be HL2DEMO
+	Protocol        int           // Should be 4
+	NetworkProtocol int           // Not sure what this is for
+	ServerName      string        // Server's 'hostname' config value
+	ClientName      string        // Usually 'GOTV Demo'
+	MapName         string        // E.g. de_cache, de_nuke, cs_office, etc.
+	GameDirectory   string        // Usually 'csgo'
+	PlaybackTime    time.Duration // Demo duration in seconds (= PlaybackTicks / Server's tickrate)
+	PlaybackTicks   int           // Game duration in ticks (= PlaybackTime * Server's tickrate)
+	PlaybackFrames  int           // Amount of 'frames' aka demo-ticks recorded (= PlaybackTime * Demo's recording rate)
+	SignonLength    int           // Length of the Signon package in bytes
 }
 
 // FrameRate returns the frame rate of the demo (frames / demo-ticks per second).
 // Not necessarily the tick-rate the server ran on during the game.
-func (h DemoHeader) FrameRate() float32 {
-	return float32(h.PlaybackFrames) / h.PlaybackTime
+func (h DemoHeader) FrameRate() float64 {
+	return float64(h.PlaybackFrames) / h.PlaybackTime.Seconds()
 }
 
 // FrameTime returns the time a frame / demo-tick takes in seconds.
 func (h DemoHeader) FrameTime() time.Duration {
-	return time.Duration(h.PlaybackTime / float32(h.PlaybackFrames) * float32(time.Second))
+	return time.Duration(h.PlaybackTime.Nanoseconds() / int64(h.PlaybackFrames))
 }
 
 // TickRate returns the tick-rate the server ran on during the game.
 // VolvoPlx128TixKTnxBye
-func (h DemoHeader) TickRate() float32 {
-	return float32(h.PlaybackTicks) / h.PlaybackTime
+func (h DemoHeader) TickRate() float64 {
+	return float64(h.PlaybackTicks) / h.PlaybackTime.Seconds()
 }
 
 // TickTime returns the time a single tick takes in seconds.
 func (h DemoHeader) TickTime() time.Duration {
-	return time.Duration(h.PlaybackTime / float32(h.PlaybackTicks) * float32(time.Second))
+	return time.Duration(h.PlaybackTime.Nanoseconds() / int64(h.PlaybackTicks))
 }
 
 // GrenadeProjectile is a grenade thrown intentionally by a player. It is used to track grenade projectile

common/common_test.go

@@ -0,0 +1,40 @@
+package common
+
+import (
+	"testing"
+	"time"
+
+	r3 "github.com/golang/geo/r3"
+	assert "github.com/stretchr/testify/assert"
+)
+
+func TestBombPosition(t *testing.T) {
+	groundPos := r3.Vector{X: 1, Y: 2, Z: 3}
+	bomb := Bomb{
+		LastOnGroundPosition: groundPos,
+	}
+
+	assert.Equal(t, groundPos, bomb.Position(), "Bomb position should be LastOnGroundPosition")
+
+	playerPos := r3.Vector{X: 4, Y: 5, Z: 6}
+	bomb.Carrier = &Player{Position: playerPos}
+	assert.Equal(t, playerPos, bomb.Position(), "Bomb position should be Player.Position")
+}
+
+func TestGrenadeProjectileUniqueID(t *testing.T) {
+	assert.NotEqual(t, NewGrenadeProjectile().UniqueID(), NewGrenadeProjectile().UniqueID(), "UniqueIDs of different grenade projectiles should be different")
+}
+
+func TestDemoHeader(t *testing.T) {
+	header := DemoHeader{
+		PlaybackFrames: 256,
+		PlaybackTicks:  512,
+		PlaybackTime:   time.Duration(4 * time.Second),
+	}
+
+	assert.Equal(t, float64(64), header.FrameRate(), "FrameRate should be 64")
+	assert.Equal(t, time.Duration(time.Second/64), header.FrameTime(), "FrameTime should be 1/64 sec")
+
+	assert.Equal(t, float64(128.0), header.TickRate(), "TickRate should be 128")
+	assert.Equal(t, time.Duration(time.Second/128), header.TickTime(), "TickTime should be 1/128")
+}

parsing.go

@@ -4,6 +4,7 @@ import (
 	"errors"
 	"fmt"
 	"io"
+	"time"
 
 	common "github.com/markus-wa/demoinfocs-golang/common"
 	events "github.com/markus-wa/demoinfocs-golang/events"
@@ -44,7 +45,7 @@ func (p *Parser) ParseHeader() (common.DemoHeader, error) {
 	h.ClientName = p.bitReader.ReadCString(maxOsPath)
 	h.MapName = p.bitReader.ReadCString(maxOsPath)
 	h.GameDirectory = p.bitReader.ReadCString(maxOsPath)
-	h.PlaybackTime = p.bitReader.ReadFloat()
+	h.PlaybackTime = time.Duration(p.bitReader.ReadFloat() * float32(time.Second))
 	h.PlaybackTicks = p.bitReader.ReadSignedInt(32)
 	h.PlaybackFrames = p.bitReader.ReadSignedInt(32)
 	h.SignonLength = p.bitReader.ReadSignedInt(32)