Corrected copying of shared memory to FrameBuffer. Corrected measurement of bot idleness and frame buffer size.

Author: dgant

src/main/java/bwapi/BWClient.java

@@ -50,42 +50,47 @@ public void startGame(BWClientConfiguration configuration) {
         client.reconnect();
 
         do {
+            ClientData.GameData gameData = client.clientData().gameData();
             long lastUpdateTimestampMillis = 0;
-            System.out.println("Client: Starting game");
-            while (!getGame().isInGame()) {
-                if (!client.isConnected()) {
+            System.out.println("Client: Beginning game loop");
+            while (!gameData.isInGame()) {
+                botWrapper = null;
+                if (client.isConnected()) {
+                    System.out.println("Client: Not in game; Connected.");
+                } else  {
+                    System.out.println("Client: Not in game; Not connected.");
                     return;
                 }
-                System.out.println("Client: connected.");
                 lastUpdateTimestampMillis = System.currentTimeMillis();
                 client.update();
             }
-
-            System.out.println("Client: Creating bot wrapper");
-            BotWrapper botWrapper = new BotWrapper(configuration, eventListener, client.mapFile());
-
-            while (getGame().isInGame()) {
-                System.out.println("Client: Stepping bot wrapper");
+            while (gameData.isInGame()) {
+                System.out.println("Client: In game on frame " + gameData.getFrameCount());
+                if (botWrapper == null) {
+                    botWrapper = new BotWrapper(configuration, eventListener, client.mapFile());
+                }
                 botWrapper.step();
-                System.out.println("Client: Waiting for idle bot or frame duration");
 
                 // Proceed immediately once framebuffer is empty
                 // Otherwise, wait for bot to catch up
                 // TODO: Replace with a wait instead of a sleep
-                // TODO: Respect configuration.asyncWaitOnFrameZero
-                while ( ! botWrapper.botIdle()) {
-                    long frameDuration = System.currentTimeMillis() - lastUpdateTimestampMillis;
-                    if (frameDuration > configuration.asyncFrameDurationMillis && (client.clientData().gameData().getFrameCount() > 0 || ! configuration.asyncWaitOnFrameZero)) {
-                        System.out.println("Client: Exceeded frame duration while waiting for bot: " + frameDuration + "ms on frame " + client.clientData().gameData().getFrameCount());
+                while(true) {
+                    if (botWrapper.botIdle()) {
+                        System.out.println("Client: Proceeding because bot is idle.");
                         break;
                     }
-                    try {
-                        Thread.sleep(1);
-                    } catch (InterruptedException ignored) {}
+                    long frameDurationMillis = System.currentTimeMillis() - lastUpdateTimestampMillis;
+                    if (frameDurationMillis > configuration.asyncFrameDurationMillis && (client.clientData().gameData().getFrameCount() > 0 || ! configuration.asyncWaitOnFrameZero)) {
+                        System.out.println("Client: Proceeding because frame " + botWrapper.getGame().getFrameCount() + " lasted " + frameDurationMillis + "ms");
+                        break;
+                    }
+                    try { Thread.sleep(1); } catch (InterruptedException ignored) {}
                 }
 
-                System.out.println("Client: Ending frame. Frames buffered: ");
-                lastUpdateTimestampMillis = System.currentTimeMillis();
+                long currentTimeMillis = System.currentTimeMillis();
+                long frameDurationMillis = currentTimeMillis - lastUpdateTimestampMillis;
+                lastUpdateTimestampMillis = currentTimeMillis;
+                System.out.println("Client: Ending frame after " + frameDurationMillis + "ms");
                 client.update();
                 if (!client.isConnected()) {
                     System.out.println("Reconnecting...");

src/main/java/bwapi/BWClientConfiguration.java

@@ -32,7 +32,7 @@ public class BWClientConfiguration {
      * If JBWAPI detects that this much time (in milliseconds) has passed since a bot's event handlers began, returns control back to BWAPI.
      * Real-time human play typically uses the "fastest" game speed, which has 42.86ms (42,860ns) between frames.
      */
-    public int asyncFrameDurationMillis = 40000;
+    public int asyncFrameDurationMillis = 40;
 
     /**
      * The maximum number of frames to buffer while waiting on a bot.

src/main/java/bwapi/BotWrapper.java

@@ -26,7 +26,6 @@ of this software and associated documentation files (the "Software"), to deal
 package bwapi;
 
 import java.nio.ByteBuffer;
-import java.util.EventListener;
 
 /**
  * Manages invocation of bot event handlers
@@ -35,8 +34,9 @@ class BotWrapper {
     private final BWClientConfiguration configuration;
     private final BWEventListener eventListener;
     private final Game game;
-    private final FrameBuffer frameBuffer;
-    private final Thread botThread;
+    private FrameBuffer frameBuffer = null;
+    private Thread botThread = null;
+    private volatile boolean idle = false;
 
     BotWrapper(BWClientConfiguration configuration, BWEventListener eventListener, ByteBuffer dataSource) {
         this.configuration = configuration;
@@ -48,43 +48,47 @@ class BotWrapper {
 
         if (configuration.async) {
             frameBuffer = new FrameBuffer(configuration.asyncFrameBufferSize, dataSource);
-            botThread = new Thread(() -> {
-                while(true) {
-                    while(frameBuffer.empty()) try { Thread.sleep(0, 100); } catch (InterruptedException ignored) {}
-
-                    System.out.println("Bot thread: Dequeuing frame. There are " + frameBuffer.framesBuffered() + " frames buffered.");
-                    game.clientData().setBuffer(frameBuffer.dequeueFrame());
+        }
+    }
 
-                    System.out.println("Bot thread: Handling events.");
-                    handleEvents();
-                    if (!game.clientData().gameData().isInGame()) {
-                        System.out.println("Bot thread: Exiting.");
-                        return;
-                    } else {
-                        System.out.println("Bot thread: Handled events.");
-                    }
-                }
-            });
-            botThread.setName("JBWAPI Bot");
+    void startBot() {
+        if (configuration.async) {
             botThread.start();
-        } else {
-            frameBuffer = null;
-            botThread = null;
         }
     }
 
     Game getGame() {
         return game;
     }
 
+    /**
+     * True if the bot has handled all enqueued frames and is waiting for a new frame from StarCraft.
+     */
     boolean botIdle() {
-        // TODO: This returns true if the bot is still processing the newest frame, leaving the bot permanently one frame behind
-        return frameBuffer.empty();
+        return idle || ! configuration.async;
     }
 
     void step() {
         if (configuration.async) {
             frameBuffer.enqueueFrame();
+            if (botThread == null) {
+                botThread = new Thread(() -> {
+                    //noinspection InfiniteLoopStatement
+                    while(true) {
+                        while(frameBuffer.empty()) try {
+                            idle = true;
+                            Thread.sleep(0, 100);
+                        } catch (InterruptedException ignored) {}
+                        idle = false;
+                        System.out.println("Bot thread: Dequeuing frame. There are " + frameBuffer.framesBuffered() + " frames buffered.");
+                        game.clientData().setBuffer(frameBuffer.dequeueFrame());
+                        System.out.println("Bot thread: Handling events.");
+                        handleEvents();
+                        System.out.println("Bot thread: Handled events.");
+                    }});
+                botThread.setName("JBWAPI Bot");
+                botThread.start();
+            }
         } else {
             handleEvents();
         }

src/main/java/bwapi/FrameBuffer.java

@@ -37,7 +37,6 @@ class FrameBuffer {
     private int size;
     private int stepGame = 0;
     private int stepBot = 0;
-    private ClientData clientData = new ClientData();
     private ArrayList<ByteBuffer> dataBuffer = new ArrayList<>();
 
     // Synchronization locks
@@ -86,9 +85,11 @@ synchronized private int indexBot() {
      */
     void enqueueFrame() {
         while(full()) try { Thread.sleep(0, 100); } catch (InterruptedException ignored) {}
-        int indexGame = indexGame();
-        System.out.println("FrameBuffer: Moving game to " + indexGame);
-        dataBuffer.get(indexGame).put(dataSource);
+        System.out.println("FrameBuffer: Enqueuing buffer " + indexGame() + " on game step #" + stepGame + " with " + framesBuffered() + " frames buffered.");
+        ByteBuffer dataTarget = dataBuffer.get(indexGame());
+        dataSource.rewind();
+        dataTarget.rewind();
+        dataTarget.put(dataSource);
         ++stepGame;
     }
 
@@ -97,7 +98,7 @@ void enqueueFrame() {
      */
     ByteBuffer dequeueFrame() {
         while(empty()) try { Thread.sleep(0, 100); } catch (InterruptedException ignored) {}
-        System.out.println("FrameBuffer: Moving bot to " + indexBot());
+        System.out.println("FrameBuffer: Dequeuing buffer " + indexBot() + " on bot step #" + stepBot);
         ByteBuffer output = dataBuffer.get(indexBot());
         ++stepBot;
         return output;