Loop mode, UI improvements

Author: jakubthedeveloper

docs/documentation.md

@@ -90,7 +90,8 @@ Minimal format:
     {
       "note": 60,
       "sample_path": "/samples/kick.wav",
-      "volume": 100
+      "volume": 100,
+      "playback_mode": "shot"
     }
   ]
 }
@@ -100,6 +101,7 @@ Notes:
 
 - `note`: `0..127`
 - `panic_note`: optional `0..127`; when received as MIDI NOTE ON, all active voices are stopped immediately
+- `playback_mode`: optional `"shot"` or `"loop"` stored per assignment/sample
 - `volume`: clamped to `0..100`
 - `volume = 100`: full per-voice level (before fixed mixer headroom)
 - `sample_path`: full SD path, for example `/samples/snare.wav`
@@ -149,6 +151,7 @@ UI states:
 Flow:
 
 - in `Library`, you select a sample and trigger preview,
+- in `Main`, `SHOT/LOOP` toggles one-shot vs loop for the currently active sample,
 - `L rotate` in `Library` toggles assignment mode between `Sample` and `Panic`,
 - long-pressing the right button enters `AssignNote` for the current mode,
 - the first received MIDI note assigns either the current sample or the global panic note (depending on selected mode),

include/audio.h

@@ -20,15 +20,21 @@ class Audio {
 
   void begin();
   void update();
-  void playSamplePath(const String &samplePath, uint8_t volume = 100, int16_t retriggerGroupId = -1);
+  void playSamplePath(const String &samplePath,
+                      uint8_t volume = 100,
+                      int16_t retriggerGroupId = -1,
+                      bool loopEnabled = false);
   void stopAllVoices();
+  void stopLoopingVoicesForGroup(int16_t retriggerGroupId);
+  void setLoopEnabledForGroup(int16_t retriggerGroupId, bool loopEnabled);
   bool playSampleRam(const uint8_t *pcmData,
                      uint32_t dataBytes,
                      uint16_t channelCount,
                      uint32_t sampleRate,
                      uint16_t bitsPerSample,
                      uint8_t volume = 100,
-                     int16_t retriggerGroupId = -1);
+                     int16_t retriggerGroupId = -1,
+                     bool loopEnabled = false);
   RuntimeStats runtimeStats() const;
   uint32_t voiceStealCount() const;
 

include/sampler_callback_binder.h

@@ -20,6 +20,7 @@ class SamplerCallbackBinder {
   static void onPreviewSample(int sampleIndex, void *context);
   static void onAssignedMidiNoteOn(int midiNote, void *context);
   static bool onSaveConfiguration(void *context);
+  static void onPlaybackModeChanged(Ui::PlaybackMode mode, int sampleIndex, void *context);
 
   Ui *ui_ = nullptr;
   Midi *midi_ = nullptr;

include/sampler_playback_router.h

@@ -14,6 +14,7 @@ class SamplerPlaybackRouter {
 
   void onPreviewSample(int sampleIndex) const;
   void onAssignedMidiNoteOn(int midiNote) const;
+  void onPlaybackModeChanged(Ui::PlaybackMode mode, int sampleIndex) const;
 
  private:
   Ui *ui_ = nullptr;

include/settings_store.h

@@ -9,6 +9,7 @@ struct MidiAssignment {
   uint8_t note = 0;
   String samplePath;
   uint8_t volume = 100;
+  bool loopPlaybackEnabled = false;
 };
 
 struct SamplerSettings {

include/trigger_engine.h

@@ -12,12 +12,15 @@ enum class TriggerSourceType : uint8_t {
   StreamPath,
   RamData,
   PanicAll,
+  StopLoopingVoicesForGroup,
+  SetLoopEnabledForGroup,
 };
 
 struct TriggerEvent {
   TriggerSourceType source = TriggerSourceType::StreamPath;
   uint8_t volume = 100;
   int16_t retriggerGroupId = -1;
+  bool loopEnabled = false;
   char path[128] = {0};
 
   const uint8_t *ramData = nullptr;
@@ -37,6 +40,8 @@ class TriggerEngine {
              QueueHandle_t uiStatusQueue = nullptr);
   bool enqueue(const TriggerEvent &event);
   bool panicAll();
+  bool stopLoopingVoicesForGroup(int16_t retriggerGroupId);
+  bool setLoopEnabledForGroup(int16_t retriggerGroupId, bool loopEnabled);
   bool waitForIdle(uint32_t timeoutMs) const;
 
  private:

include/ui.h

@@ -6,6 +6,11 @@ class Ui {
  public:
   static constexpr int kMaxSamples = 32;
 
+  enum class PlaybackMode : uint8_t {
+    OneShot,
+    Loop,
+  };
+
   enum class State : uint8_t {
     Main,
     Library,
@@ -31,7 +36,7 @@ class Ui {
     State state = State::Main;
     bool dirty = true;
 
-    int mainSelection = 0;  // 0:LIB 1:VOL 2:SAVE
+    int mainSelection = 0;  // 0:LIB 1:VOL 2:SHOT/LOOP 3:SAVE
     int currentSampleIndex = -1;
     int sampleCount = 0;
 
@@ -40,6 +45,7 @@ class Ui {
     int lastMidiNote = -1;
 
     int currentVolume = 0;
+    PlaybackMode playbackMode = PlaybackMode::OneShot;
 
     int libraryWindowStart = 0;
     int assignedNoteForSelectedSample = -1;
@@ -54,10 +60,14 @@ class Ui {
 
   using OnPreviewSampleCallback = void (*)(int sampleIndex, void *context);
   using OnSaveCallback = bool (*)(void *context);
+  using OnPlaybackModeChangedCallback = void (*)(PlaybackMode mode,
+                                                 int sampleIndex,
+                                                 void *context);
 
   void begin(const String *sampleNames, const String *samplePaths, int sampleCount);
   void setPreviewCallback(OnPreviewSampleCallback callback, void *context);
   void setSaveCallback(OnSaveCallback callback, void *context);
+  void setPlaybackModeChangedCallback(OnPlaybackModeChangedCallback callback, void *context);
   void handleEvent(const Event &event);
   void update();
   bool consumeDirty();
@@ -72,12 +82,14 @@ class Ui {
   int panicMidiNote() const;
   bool setSampleVolume(int sampleIndex, int volume);
   int sampleVolumeForSample(int sampleIndex) const;
+  bool setSamplePlaybackMode(int sampleIndex, PlaybackMode mode);
+  PlaybackMode playbackModeForSample(int sampleIndex) const;
+  bool sampleLoopPlaybackEnabled(int sampleIndex) const;
   void reportTriggeredSample(int sampleIndex);
   void clearTriggeredSample();
   void clearUnsavedChanges();
 
  private:
-  static constexpr int kMenuItems = 3;
   static constexpr int kVolumeMin = 0;
   static constexpr int kVolumeMax = 100;
   static constexpr int kVolumeStep = 5;
@@ -110,6 +122,7 @@ class Ui {
   int sampleVolumes_[kMaxSamples] = {0};
   int sampleForMidiNote_[128] = {0};  // -1 means unassigned.
   int panicMidiNote_ = -1;
+  PlaybackMode samplePlaybackModes_[kMaxSamples] = {PlaybackMode::OneShot};
   bool libraryAssignsPanic_ = false;
   bool assigningPanic_ = false;
 
@@ -128,4 +141,6 @@ class Ui {
   void *previewContext_ = nullptr;
   OnSaveCallback onSave_ = nullptr;
   void *saveContext_ = nullptr;
+  OnPlaybackModeChangedCallback onPlaybackModeChanged_ = nullptr;
+  void *playbackModeChangedContext_ = nullptr;
 };

src/audio.cpp

@@ -190,6 +190,12 @@ float voiceGainFromVolume(uint8_t volume) {
 // Keep disabled by default to preserve percussive transients.
 constexpr uint32_t kVoiceFadeInUs = 0;
 
+enum class VoiceSourceType : uint8_t {
+  None,
+  StreamPath,
+  RamData,
+};
+
 }  // namespace
 
 struct Audio::Impl {
@@ -204,6 +210,15 @@ struct Audio::Impl {
     AudioOutputMixerStub *stub = nullptr;
     float targetGain = 0.0f;
     float currentGain = 0.0f;
+    uint8_t volume = 100;
+    bool loopEnabled = false;
+    VoiceSourceType sourceType = VoiceSourceType::None;
+    char path[128] = {0};
+    const uint8_t *ramData = nullptr;
+    uint32_t ramDataBytes = 0;
+    uint16_t channelCount = 0;
+    uint32_t sampleRate = 0;
+    uint16_t bitsPerSample = 0;
   };
 
   StableAudioOutputI2S *out = nullptr;
@@ -243,6 +258,15 @@ void stopVoice(Audio::Impl::Voice &voice) {
   voice.retriggerGroupId = -1;
   voice.targetGain = 0.0f;
   voice.currentGain = 0.0f;
+  voice.volume = 100;
+  voice.loopEnabled = false;
+  voice.sourceType = VoiceSourceType::None;
+  voice.path[0] = '\0';
+  voice.ramData = nullptr;
+  voice.ramDataBytes = 0;
+  voice.channelCount = 0;
+  voice.sampleRate = 0;
+  voice.bitsPerSample = 0;
 }
 
 void refreshStats(Audio::Impl *impl) {
@@ -378,7 +402,8 @@ bool beginVoiceFromPath(Audio::Impl *impl,
                         int voiceIndex,
                         const String &samplePath,
                         uint8_t volume,
-                        int16_t retriggerGroupId) {
+                        int16_t retriggerGroupId,
+                        bool loopEnabled) {
   if (!impl || voiceIndex < 0 || voiceIndex >= Audio::kVoiceCount) return false;
 
   Audio::Impl::Voice &voice = impl->voices[voiceIndex];
@@ -407,6 +432,15 @@ bool beginVoiceFromPath(Audio::Impl *impl,
     impl->nextStartOrder = 1;
   }
   voice.active = true;
+  voice.volume = volume;
+  voice.loopEnabled = loopEnabled;
+  voice.sourceType = VoiceSourceType::StreamPath;
+  samplePath.toCharArray(voice.path, sizeof(voice.path));
+  voice.ramData = nullptr;
+  voice.ramDataBytes = 0;
+  voice.channelCount = 0;
+  voice.sampleRate = 0;
+  voice.bitsPerSample = 0;
   voice.retriggerGroupId = retriggerGroupId;
   return true;
 }
@@ -419,7 +453,8 @@ bool beginVoiceFromRam(Audio::Impl *impl,
                        uint32_t sampleRate,
                        uint16_t bitsPerSample,
                        uint8_t volume,
-                       int16_t retriggerGroupId) {
+                       int16_t retriggerGroupId,
+                       bool loopEnabled) {
   if (!impl || voiceIndex < 0 || voiceIndex >= Audio::kVoiceCount) return false;
 
   Audio::Impl::Voice &voice = impl->voices[voiceIndex];
@@ -445,10 +480,56 @@ bool beginVoiceFromRam(Audio::Impl *impl,
     impl->nextStartOrder = 1;
   }
   voice.active = true;
+  voice.volume = volume;
+  voice.loopEnabled = loopEnabled;
+  voice.sourceType = VoiceSourceType::RamData;
+  voice.path[0] = '\0';
+  voice.ramData = pcmData;
+  voice.ramDataBytes = dataBytes;
+  voice.channelCount = channelCount;
+  voice.sampleRate = sampleRate;
+  voice.bitsPerSample = bitsPerSample;
   voice.retriggerGroupId = retriggerGroupId;
   return true;
 }
 
+bool restartVoiceLoop(Audio::Impl *impl, int voiceIndex) {
+  if (!impl || voiceIndex < 0 || voiceIndex >= Audio::kVoiceCount) return false;
+
+  const Audio::Impl::Voice &voice = impl->voices[voiceIndex];
+  if (!voice.loopEnabled) return false;
+
+  const VoiceSourceType sourceType = voice.sourceType;
+  const String path(voice.path);
+  const uint8_t volume = voice.volume;
+  const int16_t retriggerGroupId = voice.retriggerGroupId;
+  const bool loopEnabled = voice.loopEnabled;
+  const uint8_t *ramData = voice.ramData;
+  const uint32_t ramDataBytes = voice.ramDataBytes;
+  const uint16_t channelCount = voice.channelCount;
+  const uint32_t sampleRate = voice.sampleRate;
+  const uint16_t bitsPerSample = voice.bitsPerSample;
+
+  stopVoice(impl->voices[voiceIndex]);
+
+  if (sourceType == VoiceSourceType::StreamPath && path.length() > 0) {
+    return beginVoiceFromPath(impl, voiceIndex, path, volume, retriggerGroupId, loopEnabled);
+  }
+  if (sourceType == VoiceSourceType::RamData && ramData && ramDataBytes > 0) {
+    return beginVoiceFromRam(impl,
+                             voiceIndex,
+                             ramData,
+                             ramDataBytes,
+                             channelCount,
+                             sampleRate,
+                             bitsPerSample,
+                             volume,
+                             retriggerGroupId,
+                             loopEnabled);
+  }
+  return false;
+}
+
 }  // namespace
 
 Audio::Audio() = default;
@@ -566,8 +647,10 @@ void Audio::update() {
     updateVoiceFadeIn(voice, nowUs);
 
     if (!voice.wav->loop()) {
-      stopVoice(voice);
-      stateChanged = true;
+      if (!voice.loopEnabled || !restartVoiceLoop(impl_, i)) {
+        stopVoice(voice);
+        stateChanged = true;
+      }
     }
   }
 
@@ -581,7 +664,10 @@ void Audio::update() {
   maybeLogRuntimeDiagnostics(impl_);
 }
 
-void Audio::playSamplePath(const String &samplePath, uint8_t volume, int16_t retriggerGroupId) {
+void Audio::playSamplePath(const String &samplePath,
+                           uint8_t volume,
+                           int16_t retriggerGroupId,
+                           bool loopEnabled) {
   if (!impl_ || samplePath.length() == 0) return;
   const uint32_t playStartUs = micros();
 
@@ -601,7 +687,7 @@ void Audio::playSamplePath(const String &samplePath, uint8_t volume, int16_t ret
   }
 
   stopVoice(voice);
-  if (!beginVoiceFromPath(impl_, voiceIndex, samplePath, volume, retriggerGroupId)) {
+  if (!beginVoiceFromPath(impl_, voiceIndex, samplePath, volume, retriggerGroupId, loopEnabled)) {
     Serial.println("Sample open/start failed");
     refreshStats(impl_);
     recordPlayCost(impl_, micros() - playStartUs);
@@ -620,13 +706,39 @@ void Audio::stopAllVoices() {
   refreshStats(impl_);
 }
 
+void Audio::stopLoopingVoicesForGroup(int16_t retriggerGroupId) {
+  if (!impl_ || retriggerGroupId < 0) return;
+  bool changed = false;
+  for (int i = 0; i < kVoiceCount; i++) {
+    Impl::Voice &voice = impl_->voices[i];
+    if (!voice.active || !voice.loopEnabled) continue;
+    if (voice.retriggerGroupId != retriggerGroupId) continue;
+    stopVoice(voice);
+    changed = true;
+  }
+  if (changed) {
+    refreshStats(impl_);
+  }
+}
+
+void Audio::setLoopEnabledForGroup(int16_t retriggerGroupId, bool loopEnabled) {
+  if (!impl_ || retriggerGroupId < 0) return;
+  for (int i = 0; i < kVoiceCount; i++) {
+    Impl::Voice &voice = impl_->voices[i];
+    if (!voice.active) continue;
+    if (voice.retriggerGroupId != retriggerGroupId) continue;
+    voice.loopEnabled = loopEnabled;
+  }
+}
+
 bool Audio::playSampleRam(const uint8_t *pcmData,
                           uint32_t dataBytes,
                           uint16_t channelCount,
                           uint32_t sampleRate,
                           uint16_t bitsPerSample,
                           uint8_t volume,
-                          int16_t retriggerGroupId) {
+                          int16_t retriggerGroupId,
+                          bool loopEnabled) {
   if (!impl_ || !pcmData || dataBytes == 0) return false;
   const uint32_t playStartUs = micros();
 
@@ -653,7 +765,8 @@ bool Audio::playSampleRam(const uint8_t *pcmData,
                                          sampleRate,
                                          bitsPerSample,
                                          volume,
-                                         retriggerGroupId);
+                                         retriggerGroupId,
+                                         loopEnabled);
   refreshStats(impl_);
   recordPlayCost(impl_, micros() - playStartUs);
   return started;