fixes major bugs, adds testing for input queue, does a bit of refactoring

Author: Assem Blaj

example/game.go

@@ -16,7 +16,7 @@ import (
 )
 
 //var session *ggthx.SyncTestBackend
-var session *ggthx.Peer2PeerBackend
+var session ggthx.Peer2PeerBackend
 var player1 Player
 var player2 Player
 var game *Game
@@ -42,7 +42,10 @@ type Player struct {
 
 func (g *Game) Update() error {
 	now = int(time.Now().UnixMilli())
-	ggthx.Idle(session, int(math.Max(0, float64(next-now-1))))
+	//ggthx.Idle(session, int(math.Max(0, float64(next-now-1))))
+	fmt.Println("Idling ")
+	session.DoPoll(int(math.Max(0, float64(next-now-1))))
+	fmt.Println("Idling Complete")
 	if now >= next {
 		g.RunFrame()
 		next = now + 1000/60
@@ -54,22 +57,35 @@ func (g *Game) RunFrame() {
 	input := g.ReadInputs()
 	buffer := encodeInputs(input)
 
-	result := ggthx.AddLocalInput(session, ggthx.PlayerHandle(currentPlayer), buffer, len(buffer))
+	fmt.Println("Attempting to add local inputs")
+	//result := ggthx.AddLocalInput(session, ggthx.PlayerHandle(currentPlayer), buffer, len(buffer))
+	result := session.AddLocalInput(ggthx.PlayerHandle(currentPlayer), buffer, len(buffer))
+	fmt.Println("Attempt to add local inputs complete")
 	if result == nil {
+		fmt.Println("Attempt to add local inputs was successful")
 		var values [][]byte
 		disconnectFlags := 0
 
-		values, result = ggthx.SynchronizeInput(session, &disconnectFlags)
+		fmt.Println("Attempting to synchronize inputs")
+		//values, result = ggthx.SynchronizeInput(session, &disconnectFlags)
+		values, result = session.SyncInput(&disconnectFlags)
 		if result == nil {
+			fmt.Println("Attempt synchronize inputs was sucessful")
+
 			inputs := decodeInputs(values)
 			g.AdvanceFrame(inputs, disconnectFlags)
+		} else {
+			fmt.Println("Attempt synchronize inputs was unsucessful")
 		}
+	} else {
+		fmt.Println("Attempt to add local inputs unsuccessful")
 	}
 }
 
 func (g *Game) AdvanceFrame(inputs []Input, disconnectFlags int) {
 	g.UpdateByInputs(inputs)
-	err := ggthx.AdvanceFrame(session)
+	//err := ggthx.AdvanceFrame(session)
+	err := session.IncrementFrame()
 	if err != nil {
 		panic(err)
 	}
@@ -191,11 +207,13 @@ func freeBuffer(buffer []byte) {
 }
 
 func advanceFrame(flags int) bool {
+	fmt.Println("Advancing frame. ")
 	var discconectFlags int
 
 	// Make sure we fetch the inputs from GGPO and use these to update
 	// the game state instead of reading from the keyboard.
-	inputs, result := ggthx.SynchronizeInput(session, &discconectFlags)
+	//inputs, result := ggthx.SynchronizeInput(session, &discconectFlags)
+	inputs, result := session.SyncInput(&discconectFlags)
 	if result != nil {
 		log.Fatal("Error from GGTHXSynchronizeInput")
 	}
@@ -242,19 +260,27 @@ func GameInit(localPort int, numPlayers int, players []ggthx.Player, numSpectato
 	callbacks.OnEvent = onEvent
 	callbacks.SaveGameState = saveGameState
 
-	session = ggthx.StartSession(&callbacks, "Test", numPlayers, inputSize, localPort)
+	//session = ggthx.StartSession(&callbacks, "Test", numPlayers, inputSize, localPort)
+	session = ggthx.NewPeer2PeerBackend(&callbacks, "Test", localPort, numPlayers, inputSize)
+	session.SetDisconnectTimeout(3000)
+	session.SetDisconnectNotifyStart(1000)
 
-	ggthx.SetDisconnectTimeout(session, 3000)
-	ggthx.SetDisconnectNotifyStart(session, 1000)
+	//ggthx.SetDisconnectTimeout(session, 3000)
+	//ggthx.SetDisconnectNotifyStart(session, 1000)
 
 	for i := 0; i < numPlayers+numSpectators; i++ {
 		var handle ggthx.PlayerHandle
-		result = ggthx.AddPlayer(session, &players[i], &handle)
+		//result = ggthx.AddPlayer(session, &players[i], &handle)
+		result = session.AddPlayer(&players[i], &handle)
+		if players[i].PlayerType == ggthx.PlayerTypeLocal {
+			currentPlayer = int(handle)
+		}
 		if result != nil {
 			log.Fatalf("There's an issue from AddPlayer")
 		}
 		if players[i].PlayerType == ggthx.PlayerTypeLocal {
-			ggthx.SetFrameDelay(session, handle, FRAME_DELAY)
+			//ggthx.SetFrameDelay(session, handle, FRAME_DELAY)
+			session.SetFrameDelay(handle, FRAME_DELAY)
 
 		}
 	}

go.mod

@@ -2,12 +2,14 @@ module github.com/assemblaj/ggthx
 
 go 1.18
 
-require golang.org/x/exp v0.0.0-20220609121020-a51bd0440498
+require (
+	github.com/hajimehoshi/ebiten/v2 v2.3.4
+	golang.org/x/exp v0.0.0-20220609121020-a51bd0440498
+)
 
 require (
 	github.com/go-gl/glfw/v3.3/glfw v0.0.0-20220320163800-277f93cfa958 // indirect
 	github.com/gofrs/flock v0.8.1 // indirect
-	github.com/hajimehoshi/ebiten/v2 v2.3.4 // indirect
 	github.com/jezek/xgb v1.0.0 // indirect
 	golang.org/x/exp/shiny v0.0.0-20220613132600-b0d781184e0d // indirect
 	golang.org/x/image v0.0.0-20220321031419-a8550c1d254a // indirect

go.sum

@@ -15,8 +15,10 @@ github.com/jezek/xgb v1.0.0 h1:s2rRzAV8KQRlpsYA7Uyxoidv1nodMF0m6dIG6FhhVLQ=
 github.com/jezek/xgb v1.0.0/go.mod h1:nrhwO0FX/enq75I7Y7G8iN1ubpSGZEiA3v9e9GyRFlk=
 github.com/jfreymuth/oggvorbis v1.0.3/go.mod h1:1U4pqWmghcoVsCJJ4fRBKv9peUJMBHixthRlBeD6uII=
 github.com/jfreymuth/vorbis v1.0.2/go.mod h1:DoftRo4AznKnShRl1GxiTFCseHr4zR9BN3TWXyuzrqQ=
+github.com/kr/pretty v0.2.1 h1:Fmg33tUaq4/8ym9TJN1x7sLJnHVwhP33CNkpYV/7rwI=
 github.com/kr/pretty v0.2.1/go.mod h1:ipq/a2n7PKx3OHsz4KJII5eveXtPO4qwEXGdVfWzfnI=
 github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
+github.com/kr/text v0.1.0 h1:45sCR5RtlFHMR4UwH9sdQ5TC8v0qDQCHnXt+kaKSTVE=
 github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
 github.com/pkg/browser v0.0.0-20210911075715-681adbf594b8/go.mod h1:HKlIX3XHQyzLZPlr7++PzdhaXEj94dEiJgZDTsxEqUI=
 github.com/yuin/goldmark v1.4.0/go.mod h1:mwnBkeHKe2W/ZEtQ+71ViKU8L12m81fl3OWwC1Zlc8k=
@@ -77,4 +79,5 @@ golang.org/x/tools v0.1.10/go.mod h1:Uh6Zz+xoGYZom868N8YTex3t7RhtHDBrE8Gzo9bV56E
 golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
 golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
 golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
+gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk=
 gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q=

src/input_queue.go

@@ -54,17 +54,17 @@ func NewInputQueue(id int, inputSize int) InputQueue {
 
 }
 
-func (i InputQueue) LastConfirmedFrame() int {
+func (i *InputQueue) LastConfirmedFrame() int {
 	log.Printf("returning last confirmed frame %d.\n", i.lastUserAddedFrame)
 	return i.lastAddedFrame
 }
 
-func (i InputQueue) FirstIncorrectFrame() int {
+func (i *InputQueue) FirstIncorrectFrame() int {
 	return i.firstIncorrectFrame
 }
 
 func (i *InputQueue) DiscardConfirmedFrames(frame int) error {
-	if frame <= 0 {
+	if frame < 0 {
 		return errors.New("ggthx: InputQueue discardConfirmedFrames: frames <= 0")
 	}
 
@@ -108,7 +108,7 @@ func (i *InputQueue) ResetPrediction(frame int) error {
 	return nil
 }
 
-func (i InputQueue) GetConfirmedInput(requestedFrame int, input *GameInput) (bool, error) {
+func (i *InputQueue) GetConfirmedInput(requestedFrame int, input *GameInput) (bool, error) {
 	if !(i.firstIncorrectFrame == NullFrame || requestedFrame < i.firstIncorrectFrame) {
 		return false, errors.New("ggthx: InputQueue GetConfirmedInput : i.firstIncorrectFrame != NullFrame && requestedFrame >")
 	}
@@ -176,7 +176,7 @@ func (i *InputQueue) AddInput(input *GameInput) error {
 	log.Printf("adding input frame number %d to queue.\n", input.Frame)
 
 	if !(i.lastUserAddedFrame == NullFrame || input.Frame == i.lastUserAddedFrame+1) {
-		return errors.New("ggthx : AddInput : !(i.lastUserAddedFrame == NullFrame || input.Frame == i.lastUserAddedFrame+1)")
+		return errors.New("ggthx : InputQueue AddInput : !(i.lastUserAddedFrame == NullFrame || input.Frame == i.lastUserAddedFrame+1)")
 	}
 	i.lastUserAddedFrame = input.Frame
 
@@ -213,7 +213,6 @@ func (i *InputQueue) AddDelayedInputToQueue(input *GameInput, frameNumber int) e
 	i.firstFrame = false
 
 	i.lastAddedFrame = frameNumber
-
 	if i.prediction.Frame != NullFrame {
 		if frameNumber != i.prediction.Frame {
 			return errors.New("ggthx: InputQueue AddDelayedInputToQueue : frameNumber != i.prediction.Frame")
@@ -286,3 +285,7 @@ func previousFrame(offset int) int {
 func (i *InputQueue) SetFrameDelay(delay int) {
 	i.frameDelay = delay
 }
+
+func (i *InputQueue) Length() int {
+	return i.length
+}

src/input_queue_test.go

@@ -0,0 +1,89 @@
+package ggthx_test
+
+import (
+	"testing"
+
+	ggthx "github.com/assemblaj/ggthx/src"
+)
+
+/*
+	Charecterization Tests
+*/
+func TestFirstLastConfirmedFrame(t *testing.T) {
+	queue := ggthx.NewInputQueue(0, 50)
+	want := ggthx.NullFrame
+	got := queue.LastConfirmedFrame()
+	if want != got {
+		t.Errorf("expected '%#v' but got '%#v'", want, got)
+	}
+}
+
+func TestFirstFirstIncorrectFrame(t *testing.T) {
+	queue := ggthx.NewInputQueue(0, 50)
+	want := ggthx.NullFrame
+	got := queue.FirstIncorrectFrame()
+	if want != got {
+		t.Errorf("expected '%#v' but got '%#v'", want, got)
+	}
+}
+
+// AddInput
+func TestAddFirstInput(t *testing.T) {
+	queue := ggthx.NewInputQueue(0, 50)
+	input, _ := ggthx.NewGameInput(0, nil, 50)
+	queue.AddInput(&input)
+	want := 0
+	got := queue.LastConfirmedFrame()
+	if want != got {
+		t.Errorf("expected '%#v' but got '%#v'", want, got)
+	}
+}
+
+func TestAddFirstInputLength(t *testing.T) {
+	queue := ggthx.NewInputQueue(0, 50)
+	input, _ := ggthx.NewGameInput(0, nil, 50)
+	queue.AddInput(&input)
+	want := 1
+	got := queue.Length()
+	if want != got {
+		t.Errorf("expected '%#v' but got '%#v'", want, got)
+	}
+
+}
+
+func TestAddTenInputsDifferentFrame(t *testing.T) {
+	queue := ggthx.NewInputQueue(0, 50)
+	for i := 0; i < 10; i++ {
+		input, _ := ggthx.NewGameInput(i, nil, 50)
+		queue.AddInput(&input)
+	}
+	want := 10
+	got := queue.Length()
+	if want != got {
+		t.Errorf("expected '%#v' but got '%#v'", want, got)
+	}
+
+}
+
+func TestAddTenInputsSameFrame(t *testing.T) {
+	queue := ggthx.NewInputQueue(0, 50)
+	for i := 0; i < 10; i++ {
+		input, _ := ggthx.NewGameInput(0, nil, 50)
+		queue.AddInput(&input)
+	}
+	want := 1
+	got := queue.Length()
+	if want != got {
+		t.Errorf("expected '%#v' but got '%#v'", want, got)
+	}
+}
+
+// GetInput
+func TestGetInputEmptyQueue(t *testing.T) {
+	queue := ggthx.NewInputQueue(0, 50)
+	var input ggthx.GameInput
+	_, err := queue.GetInput(0, &input)
+	if err != nil {
+		t.Errorf("expected nil, got an error %s", err)
+	}
+}