trigger PUP scenes from outside

mkalkbrenner · mkalkbrenner · commit c65c5aaa0a86 · 2025-08-04T19:18:31.000+02:00
diff --git a/include/DMDUtil/DMD.h b/include/DMDUtil/DMD.h
@@ -68,7 +68,7 @@ class PixelcadeDMD;
 class LevelDMD;
 class RGB24DMD;
 class ConsoleDMD;
-
+class SceneGenerator;
 class DMDServerConnector;
 
 class DMDUTILAPI DMD
@@ -152,6 +152,13 @@ class DMDUTILAPI DMD
     void convertToHostByteOrder() {}
     void convertToNetworkByteOrder() {}
   };
+
+  struct PUPTrigger
+  {
+    char source = 0;
+    uint16_t id = 0;
+    uint8_t value = 1;
+  };
 #pragma pack(pop)  // Reset to default packing
 
   void FindDisplays();
@@ -161,6 +168,7 @@ class DMDUTILAPI DMD
   void SetRomName(const char* name);
   void SetAltColorPath(const char* path);
   void SetPUPVideosPath(const char* path);
+  void SetPUPTrigger(const char source, const uint16_t id, const uint8_t value = 1);
   void DumpDMDTxt();
   void DumpDMDRaw();
   LevelDMD* CreateLevelDMD(uint16_t width, uint16_t height, bool sam);
@@ -213,6 +221,7 @@ class DMDUTILAPI DMD
   SerumFrameStruct* m_pSerum;
   ZeDMD* m_pZeDMD;
   PUPDMD::DMD* m_pPUPDMD;
+  SceneGenerator* m_pGenerator;
   std::vector<LevelDMD*> m_levelDMDs;
   std::vector<RGB24DMD*> m_rgb24DMDs;
   std::vector<ConsoleDMD*> m_consoleDMDs;
@@ -233,6 +242,7 @@ class DMDUTILAPI DMD
   std::atomic<bool> m_dmdFrameReady;
   std::atomic<bool> m_stopFlag;
   std::atomic<uint8_t> m_updateBufferQueuePosition;
+  std::atomic<PUPTrigger> m_pupTrigger;
 
   bool m_hasUpdateBuffered = false;
   static bool m_finding;
diff --git a/include/DMDUtil/SceneGenerator.h b/include/DMDUtil/SceneGenerator.h
@@ -17,7 +17,9 @@ namespace DMDUtil
 
 struct SceneData
 {
+  char source;
   int sceneId;
+  int value;
   int frameCount;
   int durationPerFrame;
   bool interruptable = false;
@@ -39,8 +41,9 @@ class DMDUTILAPI SceneGenerator
 
   bool parseCSV(const std::string& csv_filename);
   bool generateDump(const std::string& dump_filename, int id = -1);
-  bool getSceneInfo(int sceneId, int& frameCount, int& durationPerFrame, bool& interruptable, bool& startImmediately,
-                    int& repeat, int& endFrame) const;
+  bool getSceneExists(char source, int sceneId, int value) const;
+  bool getSceneInfo(char source, int sceneId, int value, int& frameCount, int& durationPerFrame, bool& interruptable,
+                    bool& startImmediately, int& repeat, int& endFrame) const;
   bool generateFrame(int sceneId, int frameIndex, uint8_t* buffer, int group = -1);
   void setDepth(int depth);
   void Reset()
diff --git a/scene_test.csv b/scene_test.csv
@@ -1,32 +1,34 @@
 # Format of a PUP scene line:
 #
-#  1: PUP trigger ID,
-#  2: number of frames,
-#  3: duration of each frame,
-#  4: 0 - not interruptable, 1 - interruptable by frame match or PUP trigger
-#  5: 0 - start immediately, replacing triggering frame, 1 - start after frame duration (see 3)
-#  6: 0 - play once, 1 - loop, >= 2 - repeat x times
-#  7: 0 - no frame groups, >= 2 - create x frame groups (you get x times the number of frames entered in 2 to play changing scenes)
-#  8: 0 - play frame group in order, 1 - play random frame group
-#  9: 0 - no autostart, >= 1 - start this scene after x seconds of inactivity (no new frames), only use once, could be combined with frame groups
-# 10: 0 - when scene is finished, show last frame of the scene until a new frame is matched, 1 - black screen, 2 - show last frame before scene started
+#  1: PUP trigger source (D - DMD, W - Switch, S - Solenoid, L - Light),
+#  2: PUP trigger ID,
+#  3: PUP trigger value,
+#  4: number of frames,
+#  5: duration of each frame,
+#  6: 0 - not interruptable, 1 - interruptable by frame match or PUP trigger
+#  7: 0 - start immediately, replacing triggering frame, 1 - start after frame duration (see 5)
+#  8: 0 - play once, 1 - loop, >= 2 - repeat x times
+#  9: 0 - no frame groups, >= 2 - create x frame groups (you get x times the number of frames entered in 2 to play changing scenes)
+# 10: 0 - play frame group in order, 1 - play random frame group
+# 11: 0 - no autostart, >= 1 - start this scene after x seconds of inactivity (no new frames), only use once, could be combined with frame groups
+# 12: 0 - when scene is finished, show last frame of the scene until a new frame is matched, 1 - black screen, 2 - show last frame before scene started
 #
 # Postions 4 - 10 are optional. If not provided, the default is 0.
 
 # Scene 60001
-60001,38,16
+D,60001,1,38,16
 
 # Scene 61479, interruptable
-61479,52,20,1
+D,61479,1,52,20,1
 
 # Scene 63500, interruptable, starting delayed by frame duration, loop
-63500,40,20,1,1,1
+D,63500,1,40,20,1,1,1
 
 # Scene 63511, interruptable, starting delayed by frame duration, play once, 3 frame groups
 # This will generate 3 groups of 75 frames, so 225 frames in total.
 # Every time the PUP ID 63511 get triggered, only one of the three groups gets played (75 frames).
 # First occurrence of the PUP ID will play group 1, the second group 2. After the third group, it will start again with group 1.
-63511,75,20,1,1,0,3
+D,63511,1,75,20,1,1,0,3
 
 # This will generate 4 groups of 200 frames, so 800 frames in total.
 # If no frame is matched for 5 seconds, randomly one of the 4 groups gets played once.
@@ -37,4 +39,4 @@
 # Normally, the last scores are shown until someone starts a new game.
 # Now the scores are displayed for 5 seconds, than a random short video scene out of four gets played for 4 seconds.
 # Then the scores are shown again and so on until someone starts a game.
-63600,200,20,1,1,0,4,1,5,2
+D,63600,1,200,20,1,1,0,4,1,5,2
diff --git a/src/DMD.cpp b/src/DMD.cpp
@@ -146,6 +146,7 @@ DMD::DMD()
   m_updateBuffered = std::make_shared<Update>();
 
   m_pAlphaNumeric = new AlphaNumeric();
+  m_pGenerator = new SceneGenerator();
   m_pSerum = nullptr;
   m_pZeDMD = nullptr;
   m_pPUPDMD = nullptr;
@@ -247,6 +248,7 @@ DMD::~DMD()
   }
 #endif
   delete m_pAlphaNumeric;
+  delete m_pGenerator;
   delete m_pZeDMD;
   delete m_pPUPDMD;
 #if !(                                                                                                                \
@@ -873,7 +875,6 @@ void DMD::SerumThread()
     bool showNotColorizedFrames = pConfig->IsShowNotColorizedFrames();
     bool dumpNotColorizedFrames = pConfig->IsDumpNotColorizedFrames();
 
-    SceneGenerator generator;
     int sceneFrameCount = 0;
     int sceneCurrentFrame = 0;
     int sceneDurationPerFrame = 0;
@@ -895,7 +896,28 @@ void DMD::SerumThread()
       }
       else
       {
-        std::this_thread::sleep_for(std::chrono::milliseconds(2));
+        PUPTrigger pupTrigger = m_pupTrigger.load(std::memory_order_relaxed);
+        if (pupTrigger.source != 0)
+        {
+          if (m_pGenerator->getSceneInfo(pupTrigger.source, pupTrigger.id, pupTrigger.value, sceneFrameCount,
+                                         sceneDurationPerFrame, sceneInterruptable, sceneStartImmediately,
+                                         sceneRepeatCount, sceneEndFrame))
+          {
+            Log(DMDUtil_LogLevel_DEBUG, "Serum: trigger ID %lu found in scenes, frame count=%d, duration=%dms",
+                pupTrigger.id, sceneFrameCount, sceneDurationPerFrame);
+            sceneCurrentFrame = 0;
+            nextSceneFrame = std::chrono::duration_cast<std::chrono::milliseconds>(
+                                 std::chrono::system_clock::now().time_since_epoch())
+                                 .count() +
+                             (sceneStartImmediately ? 0 : sceneDurationPerFrame);
+          }
+          pupTrigger.source = 0;  // Reset the trigger after processing
+          m_pupTrigger.store(pupTrigger, std::memory_order_release);
+        }
+        else
+        {
+          std::this_thread::sleep_for(std::chrono::milliseconds(1));
+        }
       }
 
       if (m_stopFlag.load(std::memory_order_acquire))
@@ -923,7 +945,7 @@ void DMD::SerumThread()
         sceneUpdate->r = 0;
         sceneUpdate->g = 0;
         sceneUpdate->b = 0;
-        if (generator.generateFrame(prevTriggerId, sceneCurrentFrame++, sceneUpdate->data))
+        if (m_pGenerator->generateFrame(prevTriggerId, sceneCurrentFrame++, sceneUpdate->data))
         {
           uint32_t result = Serum_Colorize(sceneUpdate->data);
 
@@ -994,7 +1016,7 @@ void DMD::SerumThread()
               Serum_Dispose();
               m_pSerum = nullptr;
               lastDmdUpdate = nullptr;
-              generator.Reset();
+              m_pGenerator->Reset();
               sceneFrameCount = 0;
             }
 
@@ -1020,9 +1042,9 @@ void DMD::SerumThread()
               }
               Log(DMDUtil_LogLevel_INFO, "Check for PUP scenes for %s at %s", m_romName, csvPath);
 
-              if (generator.parseCSV(csvPath))
+              if (m_pGenerator->parseCSV(csvPath))
               {
-                generator.setDepth(m_pUpdateBufferQueue[bufferPosition]->depth);
+                m_pGenerator->setDepth(m_pUpdateBufferQueue[bufferPosition]->depth);
                 Log(DMDUtil_LogLevel_INFO, "Loaded PUP scenes for %s, bit depth %d", m_romName,
                     m_pUpdateBufferQueue[bufferPosition]->depth);
               }
@@ -1047,13 +1069,13 @@ void DMD::SerumThread()
 
               if (m_pSerum->triggerID < 0xffffffff)
               {
-                if (generator.getSceneInfo(m_pSerum->triggerID, sceneFrameCount, sceneDurationPerFrame,
-                                           sceneInterruptable, sceneStartImmediately, sceneRepeatCount, sceneEndFrame))
+                if (m_pGenerator->getSceneInfo('D', m_pSerum->triggerID, 1, sceneFrameCount, sceneDurationPerFrame,
+                                               sceneInterruptable, sceneStartImmediately, sceneRepeatCount,
+                                               sceneEndFrame))
                 {
                   Log(DMDUtil_LogLevel_DEBUG, "Serum: trigger ID %lu found in scenes, frame count=%d, duration=%dms",
                       m_pSerum->triggerID, sceneFrameCount, sceneDurationPerFrame);
                   sceneCurrentFrame = 0;
-                  nextSceneFrame = now + (sceneStartImmediately ? 0 : sceneDurationPerFrame);
                   if (sceneStartImmediately)
                   {
                     nextSceneFrame = now;
@@ -2040,4 +2062,16 @@ void DMD::HandleTrigger(uint16_t id)
   }
 }
 
+void DMD::SetPUPTrigger(const char source, const uint16_t id, const uint8_t value)
+{
+  if (m_pSerum && m_pGenerator->getSceneExists(source, id, value))
+  {
+    while (m_pupTrigger.load(std::memory_order_acquire).source != 0)
+    {
+      std::this_thread::sleep_for(std::chrono::milliseconds(1));
+    }
+    m_pupTrigger.store({source, id, value}, std::memory_order_release);
+  }
+}
+
 }  // namespace DMDUtil
diff --git a/src/SceneGenerator.cpp b/src/SceneGenerator.cpp
@@ -94,16 +94,18 @@ bool SceneGenerator::parseCSV(const std::string& csv_filename)
     try
     {
       SceneData data;
-      data.sceneId = std::stoi(row[0]);
-      data.frameCount = std::stoi(row[1]);
-      data.durationPerFrame = std::stoi(row[2]);
-      if (row.size() >= 4) data.interruptable = (std::stoi(row[3]) == 1);
-      if (row.size() >= 5) data.immediateStart = (std::stoi(row[4]) == 1);
-      if (row.size() >= 6) data.repeat = std::stoi(row[5]);
-      if (row.size() >= 7) data.frameGroups = std::stoi(row[6]) == 0 ? 1 : std::stoi(row[6]);
-      if (row.size() >= 8) data.random = (std::stoi(row[7]) == 1);
-      if (row.size() >= 9) data.autoStart = std::stoi(row[8]);
-      if (row.size() >= 10) data.endFrame = std::stoi(row[9]);
+      data.source = row[0][0];  // First character of the first column
+      data.sceneId = std::stoi(row[1]);
+      data.value = std::stoi(row[2]);
+      data.frameCount = std::stoi(row[3]);
+      data.durationPerFrame = std::stoi(row[4]);
+      if (row.size() >= 6) data.interruptable = (std::stoi(row[5]) == 1);
+      if (row.size() >= 7) data.immediateStart = (std::stoi(row[6]) == 1);
+      if (row.size() >= 8) data.repeat = std::stoi(row[7]);
+      if (row.size() >= 9) data.frameGroups = std::stoi(row[8]) == 0 ? 1 : std::stoi(row[8]);
+      if (row.size() >= 10) data.random = (std::stoi(row[9]) == 1);
+      if (row.size() >= 11) data.autoStart = std::stoi(row[10]);
+      if (row.size() >= 12) data.endFrame = std::stoi(row[11]);
 
       m_sceneData.push_back(data);
     }
@@ -171,11 +173,24 @@ bool SceneGenerator::generateDump(const std::string& dump_filename, int id)
   return true;
 }
 
-bool SceneGenerator::getSceneInfo(int sceneId, int& frameCount, int& durationPerFrame, bool& interruptable,
-                                  bool& startImmediately, int& repeat, int& endFrame) const
+bool SceneGenerator::getSceneExists(char source, int sceneId, int value) const
 {
-  auto it = std::find_if(m_sceneData.begin(), m_sceneData.end(),
-                         [sceneId](const SceneData& data) { return data.sceneId == sceneId; });
+  auto it = std::find_if(m_sceneData.begin(), m_sceneData.end(), [source, sceneId, value](const SceneData& data)
+                         { return data.source == source && data.sceneId == sceneId && data.value == value; });
+
+  if (it == m_sceneData.end())
+  {
+    return false;
+  }
+
+  return true;
+}
+
+bool SceneGenerator::getSceneInfo(char source, int sceneId, int value, int& frameCount, int& durationPerFrame,
+                                  bool& interruptable, bool& startImmediately, int& repeat, int& endFrame) const
+{
+  auto it = std::find_if(m_sceneData.begin(), m_sceneData.end(), [source, sceneId, value](const SceneData& data)
+                         { return data.source == source && data.sceneId == sceneId && data.value == value; });
 
   if (it == m_sceneData.end())
   {
