Merge pull request #51 from bkshepherd/new-gml-modules

New gml modules

Author: GuitarML

.gitmodules

@@ -1,12 +1,21 @@
-[submodule "Software/GuitarPedal/DaisySP"]
-	path = Software/GuitarPedal/DaisySP
-	url = https://github.com/electro-smith/DaisySP.git
-[submodule "Software/GuitarPedal/libDaisy"]
-	path = Software/GuitarPedal/libDaisy
-	url = https://github.com/electro-smith/libDaisy.git
-[submodule "Software/GuitarPedal/infra"]
-	path = Software/GuitarPedal/q/infra
-	url = https://github.com/cycfi/infra.git
-[submodule "Software/GuitarPedal/q"]
-	path = Software/GuitarPedal/q/q
-	url = https://github.com/cycfi/q.git
+[submodule "Software/GuitarPedal/dependencies/DaisySP"]
+path = Software/GuitarPedal/dependencies/DaisySP
+url = https://github.com/electro-smith/DaisySP.git
+[submodule "Software/GuitarPedal/dependencies/libDaisy"]
+path = Software/GuitarPedal/dependencies/libDaisy
+url = https://github.com/electro-smith/libDaisy.git
+[submodule "Software/GuitarPedal/dependencies/infra"]
+path = Software/GuitarPedal/dependencies/q/infra
+url = https://github.com/cycfi/infra.git
+[submodule "Software/GuitarPedal/dependencies/q"]
+path = Software/GuitarPedal/dependencies/q/q
+url = https://github.com/cycfi/q.git
+[submodule "Software/GuitarPedal/dependencies/gcem"]
+path = Software/GuitarPedal/dependencies/gcem
+url = https://github.com/kthohr/gcem.git
+[submodule "Software/GuitarPedal/dependencies/RTNeural"]
+path = Software/GuitarPedal/dependencies/RTNeural
+url = https://github.com/jatinchowdhury18/RTNeural
+[submodule "Software/GuitarPedal/dependencies/eigen"]
+path = Software/GuitarPedal/dependencies/eigen
+url = https://gitlab.com/libeigen/eigen

Software/GuitarPedal/Effect-Modules/ImpulseResponse/ImpulseResponse.cpp

@@ -0,0 +1,58 @@
+//
+//  ImpulseResponse.cpp
+//  NeuralAmpModeler-macOS
+//
+//  Created by Steven Atkinson on 12/30/22.
+//
+//  Modified by Keith Bloemer on 12/28/23
+//    Greatly simplified by assuming 1 channel, 1 input per Process call, and constant samplerate.
+//    For initial investigation into running IR's on the Daisy Seed
+
+#include "ImpulseResponse.h"
+
+ImpulseResponse::ImpulseResponse() {}
+
+// Destructor
+ImpulseResponse::~ImpulseResponse() {
+    // No Code Needed
+}
+
+void ImpulseResponse::Init(std::vector<float> irData) {
+    mRawAudio = irData;
+    _SetWeights();
+}
+
+float ImpulseResponse::Process(float inputs) {
+
+    _UpdateHistory(inputs);
+
+    int j = mHistoryIndex - mHistoryRequired;
+    auto input = Eigen::Map<const Eigen::VectorXf>(&mHistory[j], mHistoryRequired + 1);
+
+    _AdvanceHistoryIndex(1); // KAB MOD - for Daisy implementation numFrames is always 1
+
+    return (float)mWeight.dot(input);
+}
+
+void ImpulseResponse::_SetWeights() {
+
+    const size_t irLength = std::min(mRawAudio.size(), mMaxLength);
+    mWeight.resize(irLength);
+    // Gain reduction.
+    // https://github.com/sdatkinson/NeuralAmpModelerPlugin/issues/100#issuecomment-1455273839
+    // Add sample rate-dependence
+    // const float gain = pow(10, -18 * 0.05) * 48000 / mSampleRate;  //KAB NOTE: This made a very bad/loud sound on Daisy Seed
+    for (size_t i = 0, j = irLength - 1; i < irLength; i++, j--)
+        // mWeight[j] = gain * mRawAudio[i];
+        mWeight[j] = mRawAudio[i];
+    mHistoryRequired = irLength - 1;
+
+    // Moved from HISTORY::EnsureHistorySize since only doing once for this module (assuming same size IR's)
+    //   TODO: Maybe find a more efficient method of indexing mHistory,
+    //         rather than copying the end of the vector (length of IR) back to the beginning all at once.
+    const size_t requiredHistoryArraySize =
+        5 * mHistoryRequired; // Just so we don't spend too much time copying back. // KAB NOTE: was 10 *
+    mHistory.resize(requiredHistoryArraySize);
+    std::fill(mHistory.begin(), mHistory.end(), 0.0f);
+    mHistoryIndex = mHistoryRequired;
+}

Software/GuitarPedal/Effect-Modules/ImpulseResponse/ImpulseResponse.h

@@ -0,0 +1,40 @@
+//
+//  ImpulseResponse.h
+//  NeuralAmpModeler-macOS
+//
+//  Created by Steven Atkinson on 12/30/22.
+//
+// Impulse response processing
+//
+//  Modified by Keith Bloemer on 12/28/23
+//    Greatly simplified by assuming 1 channel, 1 input per Process call, and constant samplerate.
+//    For initial investigation into running IR's on the Daisy Seed
+
+#pragma once
+
+#include "dsp.h"
+#include <Eigen/Dense>
+
+class ImpulseResponse : public History {
+  public:
+    ImpulseResponse();
+    ~ImpulseResponse();
+
+    void Init(std::vector<float> irData);
+    float Process(float inputs);
+
+  private:
+    // Set the weights, given that the plugin is running at the provided sample
+    // rate.
+    void _SetWeights();
+
+    // State of audio
+    // Keep a copy of the raw audio that was loaded so that it can be resampled
+    std::vector<float> mRawAudio;
+    float mRawAudioSampleRate;
+    float mSampleRate;
+
+    const size_t mMaxLength = 8192;
+    // The weights
+    Eigen::VectorXf mWeight;
+};

Software/GuitarPedal/Effect-Modules/ImpulseResponse/dsp.cpp

@@ -0,0 +1,33 @@
+/*
+ * File: dsp.cpp
+ * Created Date: March 17, 2023
+ * Author: Steven Atkinson (steven@atkinson.mn)
+ */
+//  Modified by Keith Bloemer on 12/28/23
+//    Greatly simplified by assuming 1 channel, 1 input per Process call, and constant samplerate.
+//    For initial investigation into running IR's on the Daisy Seed
+
+#include "dsp.h"
+
+History::History() {}
+
+// Destructor
+History::~History() {
+    // No Code Needed
+}
+
+void History::_AdvanceHistoryIndex(const size_t bufferSize) { mHistoryIndex += bufferSize; }
+
+void History::_RewindHistory() {
+    // TODO memcpy?  Should be fine w/ history array being >2x the history length.
+    for (size_t i = 0, j = mHistoryIndex - mHistoryRequired; i < mHistoryRequired; i++, j++)
+        mHistory[i] = mHistory[j];
+    mHistoryIndex = mHistoryRequired;
+}
+
+void History::_UpdateHistory(float inputs) {
+    if (mHistoryIndex + 1 >= mHistory.size())
+        _RewindHistory();
+
+    mHistory[mHistoryIndex] = inputs;
+}

Software/GuitarPedal/Effect-Modules/ImpulseResponse/dsp.h

@@ -0,0 +1,36 @@
+#pragma once
+
+#include <vector>
+
+// A class where a longer buffer of history is needed to correctly calculate
+// the DSP algorithm (e.g. algorithms involving convolution).
+//
+// Hacky stuff:
+// * Mono
+// * Single-precision floats.
+class History {
+  public:
+    History();
+    ~History();
+
+  protected:
+    // Called at the end of the DSP, advance the hsitory index to the next open
+    // spot.  Does not ensure that it's at a valid address.
+    void _AdvanceHistoryIndex(const size_t bufferSize);
+    // Drop the new samples into the history array.
+    // Manages history array size
+    void _UpdateHistory(float inputs);
+
+    // The history array that's used for DSP calculations.
+    std::vector<float> mHistory;
+    // How many samples previous are required.
+    // Zero means that no history is required--only the current sample.
+    size_t mHistoryRequired = 0;
+    // Location of the first sample in the current buffer.
+    // Shall always be in the range [mHistoryRequired, mHistory.size()).
+    size_t mHistoryIndex = 0;
+
+  private:
+    // Copy the end of the history back to the front and reset mHistoryIndex
+    void _RewindHistory();
+};