Add support for timing steps and pipelines

core/src/main/java/edu/wpi/grip/core/PipelineRunner.java

@@ -5,6 +5,8 @@
 import edu.wpi.grip.core.events.RunPipelineEvent;
 import edu.wpi.grip.core.events.RunStartedEvent;
 import edu.wpi.grip.core.events.RunStoppedEvent;
+import edu.wpi.grip.core.events.StepFinishedEvent;
+import edu.wpi.grip.core.events.StepStartedEvent;
 import edu.wpi.grip.core.events.StopPipelineEvent;
 import edu.wpi.grip.core.util.SinglePermitSemaphore;
 import edu.wpi.grip.core.util.service.AutoRestartingService;
@@ -47,6 +49,7 @@ public class PipelineRunner implements RestartableService {
   private final Supplier<ImmutableList<Step>> stepSupplier;
   private final AutoRestartingService pipelineService;
 
+  private final EventBus eventBus;
 
   @Inject
   PipelineRunner(EventBus eventBus, Provider<Pipeline> pipelineProvider) {
@@ -56,6 +59,7 @@ public class PipelineRunner implements RestartableService {
 
   PipelineRunner(EventBus eventBus, Supplier<ImmutableList<Source>> sourceSupplier,
                  Supplier<ImmutableList<Step>> stepSupplier) {
+    this.eventBus = checkNotNull(eventBus, "eventBus");
     this.sourceSupplier = sourceSupplier;
     this.stepSupplier = stepSupplier;
     this.pipelineService = new AutoRestartingService<>(
@@ -79,10 +83,10 @@ protected void runOneIteration() throws InterruptedException {
             }
             runPipeline(super::isRunning);
             // This should not block access to the steps array
+            eventBus.post(new RunStoppedEvent());
             if (super.isRunning()) {
               eventBus.post(new RenderEvent());
             }
-            eventBus.post(new RunStoppedEvent());
           }
 
           @Override
@@ -195,7 +199,9 @@ private void runPipeline(Supplier<Boolean> isRunning) {
       if (!isRunning.get()) {
         break;
       }
+      eventBus.post(new StepStartedEvent(step));
       step.runPerformIfPossible();
+      eventBus.post(new StepFinishedEvent(step));
     }
   }
 

core/src/main/java/edu/wpi/grip/core/events/StepFinishedEvent.java

@@ -0,0 +1,22 @@
+package edu.wpi.grip.core.events;
+
+import edu.wpi.grip.core.Step;
+
+import static com.google.common.base.Preconditions.checkNotNull;
+
+/**
+ * An event fired when a step has finished running.
+ */
+public class StepFinishedEvent {
+
+  private final Step step;
+
+  public StepFinishedEvent(Step step) {
+    this.step = checkNotNull(step, "step");
+  }
+
+  public boolean isRegarding(Step step) {
+    return this.step.equals(step);
+  }
+
+}

core/src/main/java/edu/wpi/grip/core/events/StepStartedEvent.java

@@ -0,0 +1,23 @@
+package edu.wpi.grip.core.events;
+
+import edu.wpi.grip.core.Step;
+
+import static com.google.common.base.Preconditions.checkNotNull;
+
+/**
+ * An event fired when a step has started to be run. This will be accompanied by a
+ * {@link StepFinishedEvent} after the step has finished running.
+ */
+public class StepStartedEvent {
+
+  private final Step step;
+
+  public StepStartedEvent(Step step) {
+    this.step = checkNotNull(step, "step");
+  }
+
+  public boolean isRegarding(Step step) {
+    return this.step.equals(step);
+  }
+
+}

ui/src/main/java/edu/wpi/grip/ui/MainWindowController.java

@@ -4,6 +4,8 @@
 import edu.wpi.grip.core.Pipeline;
 import edu.wpi.grip.core.PipelineRunner;
 import edu.wpi.grip.core.events.ProjectSettingsChangedEvent;
+import edu.wpi.grip.core.events.RunStartedEvent;
+import edu.wpi.grip.core.events.RunStoppedEvent;
 import edu.wpi.grip.core.serialization.Project;
 import edu.wpi.grip.core.settings.ProjectSettings;
 import edu.wpi.grip.core.settings.SettingsProvider;
@@ -13,26 +15,31 @@
 import edu.wpi.grip.ui.util.DPIUtility;
 
 import com.google.common.base.CaseFormat;
+import com.google.common.base.Stopwatch;
 import com.google.common.eventbus.EventBus;
+import com.google.common.eventbus.Subscribe;
 import com.google.common.util.concurrent.Service;
 
 import org.controlsfx.control.StatusBar;
 
 import java.io.File;
 import java.io.IOException;
 import java.util.Optional;
+import java.util.concurrent.TimeUnit;
 
 import javafx.application.Platform;
 import javafx.fxml.FXML;
 import javafx.scene.Parent;
 import javafx.scene.Scene;
 import javafx.scene.control.ButtonType;
 import javafx.scene.control.Dialog;
+import javafx.scene.control.Label;
 import javafx.scene.control.SplitPane;
 import javafx.scene.image.Image;
 import javafx.scene.image.ImageView;
 import javafx.scene.layout.Pane;
 import javafx.scene.layout.Region;
+import javafx.scene.text.TextAlignment;
 import javafx.stage.FileChooser;
 import javafx.stage.FileChooser.ExtensionFilter;
 import javafx.stage.Stage;
@@ -59,6 +66,7 @@ public class MainWindowController {
   private Pane aboutPane;
   @FXML
   private StatusBar statusBar;
+  private Label elapsedTimeLabel; // TODO improve the layout of this label
   @Inject
   private EventBus eventBus;
   @Inject
@@ -76,10 +84,16 @@ public class MainWindowController {
 
   private Stage aboutDialogStage;
 
+  private final Stopwatch stopwatch = Stopwatch.createUnstarted();
+
   @FXML
   protected void initialize() {
+    elapsedTimeLabel = new Label();
+    updateElapsedTimeLabel(0);
+    elapsedTimeLabel.setTextAlignment(TextAlignment.CENTER);
     pipelineView.prefHeightProperty().bind(bottomPane.heightProperty());
     statusBar.getLeftItems().add(startStoppableButtonFactory.create(pipelineRunner));
+    statusBar.getLeftItems().add(elapsedTimeLabel);
     pipelineRunner.addListener(new SingleActionListener(() -> {
       final Service.State state = pipelineRunner.state();
       final String stateMessage =
@@ -89,7 +103,6 @@ protected void initialize() {
               .toString());
       statusBar.setText(" Pipeline " + stateMessage);
     }), Platform::runLater);
-
   }
 
   /**
@@ -261,4 +274,24 @@ protected void deploy() {
     dialog.setResizable(true);
     dialog.showAndWait();
   }
+
+  @Subscribe
+  private void runStarted(RunStartedEvent event) {
+    stopwatch.reset().start();
+  }
+
+  @Subscribe
+  private void runStopped(RunStoppedEvent event) {
+    // Compute elapsed time first because another run
+    // may start before updateElapsedTimeLabel gets called
+    final long elapsed = stopwatch.elapsed(TimeUnit.MICROSECONDS);
+    Platform.runLater(() -> updateElapsedTimeLabel(elapsed));
+  }
+
+  private void updateElapsedTimeLabel(long elapsed) {
+    elapsedTimeLabel.setText(
+        String.format("Ran in %.1f ms (%.1f fps)",
+            elapsed / 1e3,
+            elapsed != 0 ? (1e6 / elapsed) : Double.NaN));
+  }
 }

ui/src/main/java/edu/wpi/grip/ui/pipeline/StepController.java

@@ -2,6 +2,8 @@
 
 import edu.wpi.grip.core.Pipeline;
 import edu.wpi.grip.core.Step;
+import edu.wpi.grip.core.events.StepFinishedEvent;
+import edu.wpi.grip.core.events.StepStartedEvent;
 import edu.wpi.grip.core.sockets.InputSocket;
 import edu.wpi.grip.core.sockets.OutputSocket;
 import edu.wpi.grip.ui.Controller;
@@ -13,13 +15,18 @@
 import edu.wpi.grip.ui.util.ControllerMap;
 import edu.wpi.grip.ui.util.StyleClassNameUtility;
 
+import com.google.common.base.Stopwatch;
+import com.google.common.eventbus.Subscribe;
 import com.google.inject.assistedinject.Assisted;
 
 import java.io.InputStream;
 import java.util.Collection;
+import java.util.concurrent.TimeUnit;
 
+import javafx.application.Platform;
 import javafx.fxml.FXML;
 import javafx.scene.Node;
+import javafx.scene.control.Label;
 import javafx.scene.control.Labeled;
 import javafx.scene.image.Image;
 import javafx.scene.image.ImageView;
@@ -46,6 +53,8 @@ public class StepController implements Controller {
   @FXML
   private Labeled title;
   @FXML
+  private Label elapsedTime;
+  @FXML
   private ImageView icon;
   @FXML
   private HBox buttons;
@@ -56,6 +65,8 @@ public class StepController implements Controller {
   private ControllerMap<InputSocketController, Node> inputSocketMapManager;
   private ControllerMap<OutputSocketController, Node> outputSocketMapManager;
 
+  private final Stopwatch stopwatch = Stopwatch.createUnstarted();
+
   @Inject
   StepController(Pipeline pipeline,
                  InputSocketControllerFactory inputSocketControllerFactory,
@@ -142,6 +153,24 @@ private void moveStepRight() {
     pipeline.moveStep(step, +1);
   }
 
+  @Subscribe
+  private void started(StepStartedEvent event) {
+    if (!event.isRegarding(this.step)) {
+      return;
+    }
+    stopwatch.reset().start();
+  }
+
+  @Subscribe
+  private void finished(StepFinishedEvent event) {
+    if (!event.isRegarding(this.step)) {
+      return;
+    }
+    // Use micros and divide by 1e3 to get decimal points (e.g. 0.3ms instead of 0ms)
+    final long elapsed = stopwatch.elapsed(TimeUnit.MICROSECONDS);
+    Platform.runLater(() -> elapsedTime.setText(String.format("Ran in %.1f ms", elapsed / 1e3)));
+  }
+
   /**
    * Used for assisted injects.  Guice will automatically create an instance of this interface so we
    * can create step controllers.  This lets us use injection with StepController even though it

ui/src/main/resources/edu/wpi/grip/ui/pipeline/Step.fxml

@@ -66,18 +66,21 @@
         </HBox>
     </HBox>
     <Separator orientation="HORIZONTAL" />
-    <Label fx:id="title" maxWidth="Infinity" styleClass="title">
-        <graphic>
-            <ImageView fx:id="icon">
-                <fitWidth>
-                    <DPIUtility fx:constant="SMALL_ICON_SIZE" />
-                </fitWidth>
-                <fitHeight>
-                    <DPIUtility fx:constant="SMALL_ICON_SIZE" />
-                </fitHeight>
-            </ImageView>
-        </graphic>
-    </Label>
+    <VBox>
+        <Label fx:id="title" maxWidth="Infinity" styleClass="title">
+            <graphic>
+                <ImageView fx:id="icon">
+                    <fitWidth>
+                        <DPIUtility fx:constant="SMALL_ICON_SIZE" />
+                    </fitWidth>
+                    <fitHeight>
+                        <DPIUtility fx:constant="SMALL_ICON_SIZE" />
+                    </fitHeight>
+                </ImageView>
+            </graphic>
+        </Label>
+        <Label fx:id="elapsedTime" maxWidth="Infinity" />
+    </VBox>
     <Separator orientation="HORIZONTAL" />
     <VBox fx:id="inputs" styleClass="sockets" />
     <Separator orientation="HORIZONTAL" />