add method to get play index

Author: timhendriks93

.github/workflows/ci.yml

@@ -3,8 +3,8 @@ name: Continuous Integration
 on: [push]
 
 jobs:
-  build-library:
-    name: "Build library"
+  build:
+    name: "Build"
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3

src/show/Show.cpp

@@ -54,7 +54,8 @@ void Show::play(unsigned long currentMicros) {
 void Show::playSingle(byte index, unsigned long currentMicros) {
   Animation *animation = this->animations[index];
 
-  if (animation == nullptr || !this->modeIsIn(2, MODE_DEFAULT, MODE_PAUSE)) {
+  if (animation == nullptr || !this->modeIsIn(2, MODE_DEFAULT, MODE_PAUSE) ||
+      (this->mode == MODE_PAUSE && playIndex != index)) {
     return;
   }
 
@@ -138,6 +139,10 @@ byte Show::getMode() {
   return this->mode;
 }
 
+byte Show::getPlayIndex() {
+  return this->playIndex;
+}
+
 void Show::run(unsigned long currentMicros) {
   switch (this->mode) {
   case MODE_PLAY:

src/show/Show.h

@@ -39,6 +39,7 @@ class Show {
   static const byte MODE_LIVE = 7;
 
   byte getMode();
+  byte getPlayIndex();
   byte countAnimations();
 
   void addAnimation(Animation &animation);

test/show/test_mode_callback/test_mode_callback.cpp

@@ -0,0 +1,104 @@
+#include "BlenderServoAnimation.h"
+#include <unity.h>
+
+using namespace BlenderServoAnimation;
+
+#define FPS 60
+#define FRAMES 5
+
+int prevMode = -1;
+int newMode = -1;
+
+void setUp(void) {
+  prevMode = -1;
+  newMode = -1;
+}
+
+void onModeChange(byte prevArg, byte newArg) {
+  prevMode = prevArg;
+  newMode = newArg;
+}
+
+void test_different_mode(void) {
+  Show show;
+  Animation animationA(FPS, FRAMES);
+  Animation animationB(FPS, FRAMES);
+  show.addAnimation(animationA);
+  show.addAnimation(animationB);
+  show.onModeChange(onModeChange);
+
+  TEST_ASSERT_EQUAL(-1, prevMode);
+  TEST_ASSERT_EQUAL(-1, newMode);
+  show.playSingle(1, 0);
+  TEST_ASSERT_EQUAL(Show::MODE_DEFAULT, prevMode);
+  TEST_ASSERT_EQUAL(Show::MODE_PLAY_SINGLE, newMode);
+  TEST_ASSERT_EQUAL(1, show.getPlayIndex());
+  show.pause();
+  TEST_ASSERT_EQUAL(Show::MODE_PLAY_SINGLE, prevMode);
+  TEST_ASSERT_EQUAL(Show::MODE_PAUSE, newMode);
+}
+
+void test_same_mode(void) {
+  Show show;
+  Animation animation(FPS, FRAMES);
+  show.addAnimation(animation);
+  show.onModeChange(onModeChange);
+
+  show.loop(0);
+  TEST_ASSERT_EQUAL(Show::MODE_DEFAULT, prevMode);
+  TEST_ASSERT_EQUAL(Show::MODE_LOOP, newMode);
+  show.loop(0);
+  TEST_ASSERT_EQUAL(Show::MODE_DEFAULT, prevMode);
+  TEST_ASSERT_EQUAL(Show::MODE_LOOP, newMode);
+}
+
+void test_all_modes(void) {
+  Serial_ mock;
+  Show show;
+  Animation animation(FPS, FRAMES);
+  show.addAnimation(animation);
+  show.onModeChange(onModeChange);
+
+  show.play(0);
+  TEST_ASSERT_EQUAL(Show::MODE_DEFAULT, prevMode);
+  TEST_ASSERT_EQUAL(Show::MODE_PLAY, newMode);
+  TEST_ASSERT_EQUAL(0, show.getPlayIndex());
+  show.pause();
+  TEST_ASSERT_EQUAL(Show::MODE_PLAY, prevMode);
+  TEST_ASSERT_EQUAL(Show::MODE_PAUSE, newMode);
+  TEST_ASSERT_EQUAL(0, show.getPlayIndex());
+  show.playRandom(0);
+  TEST_ASSERT_EQUAL(Show::MODE_PAUSE, prevMode);
+  TEST_ASSERT_EQUAL(Show::MODE_PLAY_RANDOM, newMode);
+  TEST_ASSERT_EQUAL(0, show.getPlayIndex());
+  show.pause();
+  show.playSingle(0, 0);
+  TEST_ASSERT_EQUAL(Show::MODE_PAUSE, prevMode);
+  TEST_ASSERT_EQUAL(Show::MODE_PLAY_SINGLE, newMode);
+  TEST_ASSERT_EQUAL(0, show.getPlayIndex());
+  show.pause();
+  show.loop(0);
+  TEST_ASSERT_EQUAL(Show::MODE_PAUSE, prevMode);
+  TEST_ASSERT_EQUAL(Show::MODE_LOOP, newMode);
+  TEST_ASSERT_EQUAL(0, show.getPlayIndex());
+  show.stop();
+  TEST_ASSERT_EQUAL(Show::MODE_LOOP, prevMode);
+  TEST_ASSERT_EQUAL(Show::MODE_STOP, newMode);
+  TEST_ASSERT_EQUAL(0, show.getPlayIndex());
+  show.run(0);
+  TEST_ASSERT_EQUAL(Show::MODE_STOP, prevMode);
+  TEST_ASSERT_EQUAL(Show::MODE_DEFAULT, newMode);
+  TEST_ASSERT_EQUAL(0, show.getPlayIndex());
+  show.live(mock);
+  TEST_ASSERT_EQUAL(Show::MODE_DEFAULT, prevMode);
+  TEST_ASSERT_EQUAL(Show::MODE_LIVE, newMode);
+  TEST_ASSERT_EQUAL(0, show.getPlayIndex());
+}
+
+int main(int argc, char **argv) {
+  UNITY_BEGIN();
+  RUN_TEST(test_different_mode);
+  RUN_TEST(test_same_mode);
+  RUN_TEST(test_all_modes);
+  UNITY_END();
+}

test/show/test_pause/test_pause.cpp

@@ -60,7 +60,7 @@ void test_pause(byte mode) {
     show.play(0);
     break;
   case Show::MODE_PLAY_SINGLE:
-    show.playSingle(1, 0);
+    show.playSingle(0, 0);
     break;
   case Show::MODE_PLAY_RANDOM:
     show.playRandom(0);

test/show/test_play_single/test_play_single.cpp

@@ -91,11 +91,28 @@ void test_allowed(void) {
   TEST_ASSERT_EQUAL(Show::MODE_PLAY_SINGLE, show.getMode());
 }
 
+void test_prevent_sudden_index_change(void) {
+  Show show;
+  Animation animationA(FPS, FRAMES);
+  Animation animationB(FPS, FRAMES);
+  show.addAnimation(animationA);
+  show.addAnimation(animationB);
+
+  show.play(0);
+  TEST_ASSERT_EQUAL(Show::MODE_PLAY, show.getMode());
+  show.run(FRAME_MICROS);
+  show.pause();
+  TEST_ASSERT_EQUAL(Show::MODE_PAUSE, show.getMode());
+  show.playSingle(1, 0);
+  TEST_ASSERT_EQUAL(Show::MODE_PAUSE, show.getMode());
+}
+
 int main(int argc, char **argv) {
   UNITY_BEGIN();
   RUN_TEST(test_play_single);
   RUN_TEST(test_without_animations);
   RUN_TEST(test_prevented);
   RUN_TEST(test_allowed);
+  RUN_TEST(test_prevent_sudden_index_change);
   UNITY_END();
 }