add first scene callback tests

examples/SwitchModeButton/SwitchModeButton.ino

@@ -106,9 +106,6 @@ void setup() {
   // Add a scene based on PROGMEM data
   animation.addScene(ANIMATION_DATA, LENGTH, FPS, FRAMES);
 
-  // Add a scene based on (live) Serial data
-  animation.addScene(Serial);
-
   // Register the mode change callback function
   animation.onModeChange(modeChanged);
 }

platformio.ini

@@ -3,6 +3,6 @@ platform = native
 test_build_src = yes
 build_flags =
 	-Wno-deprecated-declarations
-debug_test = animation/test_stop
+debug_test = animation/test_scene_callback
 lib_deps = 
 	ArduinoFake

src/internal/Animation.cpp

@@ -57,15 +57,42 @@ void Animation::setServoThreshold(byte id, byte value) {
   this->servoManager.setThreshold(id, value);
 }
 
+void Animation::setScene(byte index) {
+  Scene *scene = this->scenes[index];
+
+  if (!scene) {
+    return;
+  }
+
+  byte prevIndex = this->playIndex;
+
+  this->playIndex = index;
+  this->scene = scene;
+
+  if (this->sceneCallback) {
+    this->sceneCallback(prevIndex, index);
+  }
+}
+
 void Animation::setRandomScene() {
   byte randomIndex = 0;
 
   if (this->countScenes() > 1) {
     randomIndex = random(this->addIndex);
   }
 
-  this->playIndex = randomIndex;
-  this->scene = this->scenes[this->playIndex];
+  this->setScene(randomIndex);
+}
+
+void Animation::resetScene() {
+  byte prevIndex = this->playIndex;
+
+  this->scene = nullptr;
+  this->playIndex = 0;
+
+  if (this->sceneCallback) {
+    this->sceneCallback(prevIndex, 0);
+  }
 }
 
 void Animation::play() {
@@ -74,7 +101,7 @@ void Animation::play() {
   }
 
   if (!this->scene) {
-    this->scene = this->scenes[this->playIndex];
+    this->setScene(this->playIndex);
   }
 
   this->changeMode(MODE_PLAY);
@@ -89,8 +116,7 @@ void Animation::playSingle(byte index) {
   }
 
   if (!this->scene || this->scene->getFrame() == 0) {
-    this->playIndex = index;
-    this->scene = scene;
+    this->setScene(index);
   }
 
   this->changeMode(MODE_PLAY_SINGLE);
@@ -114,7 +140,7 @@ void Animation::loop() {
   }
 
   if (!this->scene) {
-    this->scene = this->scenes[this->playIndex];
+    this->setScene(this->playIndex);
   }
 
   this->changeMode(MODE_LOOP);
@@ -196,26 +222,24 @@ void Animation::handlePlayMode(unsigned long currentMicros) {
   switch (this->mode) {
   case MODE_PLAY:
     if (this->hasFinished()) {
-      this->scene = nullptr;
+      this->resetScene();
     } else {
-      this->playIndex++;
-      this->scene = this->scenes[this->playIndex];
+      this->setScene(this->playIndex + 1);
     }
     break;
   case MODE_PLAY_SINGLE:
-    this->scene = nullptr;
+    this->resetScene();
     break;
   case MODE_PLAY_RANDOM:
     this->setRandomScene();
     this->changeMode(MODE_PLAY_RANDOM);
     break;
   case MODE_LOOP:
     if (this->hasFinished()) {
-      this->playIndex = 0;
+      this->setScene(0);
     } else {
-      this->playIndex++;
+      this->setScene(this->playIndex + 1);
     }
-    this->scene = this->scenes[this->playIndex];
     this->changeMode(MODE_LOOP);
     break;
   }

src/internal/Animation.h

@@ -77,7 +77,9 @@ class Animation {
   void handlePlayMode(unsigned long currentMicros);
   void handleStopMode(unsigned long currentMicros);
   void handleLiveMode();
+  void setScene(byte index);
   void setRandomScene();
+  void resetScene();
 
   bool modeIsIn(byte modeAmount, ...);
 };

test/animation/test_play/test_play.cpp

@@ -38,6 +38,7 @@ void test_play(void) {
   }
 
   TEST_ASSERT_EQUAL(Animation::MODE_DEFAULT, animation.getMode());
+  TEST_ASSERT_EQUAL(nullptr, animation.getCurrentScene());
   TEST_ASSERT_EQUAL(10, logIndex);
 }
 

test/animation/test_scene_callback/test_scene_callback.cpp

@@ -0,0 +1,70 @@
+#include "../test/helper.h"
+#include "internal/Animation.h"
+
+#include <unity.h>
+
+using namespace BlenderServoAnimation;
+
+int prevSceneIndex = -1;
+int nextSceneIndex = -1;
+
+void setUp(void) {
+  prevSceneIndex = -1;
+  nextSceneIndex = -1;
+}
+
+void onSceneChange(byte prevArg, byte newArg) {
+  prevSceneIndex = prevArg;
+  nextSceneIndex = newArg;
+}
+
+void test_play(void) {
+  Animation animation;
+  animation.onSceneChange(onSceneChange);
+  animation.addScene(PROGMEM_DATA, DATA_SIZE, FPS, FRAMES);
+  animation.addScene(PROGMEM_DATA, DATA_SIZE, FPS, FRAMES);
+
+  TEST_ASSERT_EQUAL(-1, prevSceneIndex);
+  TEST_ASSERT_EQUAL(-1, nextSceneIndex);
+
+  animation.play();
+
+  TEST_ASSERT_EQUAL(0, prevSceneIndex);
+  TEST_ASSERT_EQUAL(0, nextSceneIndex);
+
+  for (int i = 0; i < ANIMATION_MICROS; i += FRAME_MICROS) {
+    animation.run(i);
+  }
+
+  TEST_ASSERT_EQUAL(0, prevSceneIndex);
+  TEST_ASSERT_EQUAL(1, nextSceneIndex);
+}
+
+void test_play_single(void) {
+  Animation animation;
+  animation.onSceneChange(onSceneChange);
+  animation.addScene(PROGMEM_DATA, DATA_SIZE, FPS, FRAMES);
+  animation.addScene(PROGMEM_DATA, DATA_SIZE, FPS, FRAMES);
+
+  TEST_ASSERT_EQUAL(-1, prevSceneIndex);
+  TEST_ASSERT_EQUAL(-1, nextSceneIndex);
+
+  animation.playSingle(1);
+
+  TEST_ASSERT_EQUAL(0, prevSceneIndex);
+  TEST_ASSERT_EQUAL(1, nextSceneIndex);
+
+  for (int i = 0; i < ANIMATION_MICROS; i += FRAME_MICROS) {
+    animation.run(i);
+  }
+
+  TEST_ASSERT_EQUAL(1, prevSceneIndex);
+  TEST_ASSERT_EQUAL(0, nextSceneIndex);
+}
+
+int main(int argc, char **argv) {
+  UNITY_BEGIN();
+  RUN_TEST(test_play);
+  RUN_TEST(test_play_single);
+  UNITY_END();
+}