Merge branch 'main' of https://github.com/marcel-licence/ML_SynthTools

Author: marcel-licence

.github/workflows/compile-sketch.yml

@@ -36,10 +36,10 @@ jobs:
             - examples/ml_epiano_example
             - examples/ml_mod_tracker
             - examples/ml_synth_basic_example
-            - examples/ml_synth_fm_example
+            #- examples/ml_synth_fm_example
             - examples/ml_synth_multi_saw_example
             - examples/ml_synth_organ_example
-            - examples/ml_synth_pwm_osc_example
+            #- examples/ml_synth_pwm_osc_example
             - examples/ml_synth_sampler_example
           libraries: |
               - source-url: https://github.com/marcel-licence/ML_SynthTools.git
@@ -109,6 +109,66 @@ jobs:
               - source-url: https://github.com/marcel-licence/AC101.git
                 name: AC101
 
+
+  build_rp2040:
+
+    name: build rp2040
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        fqbn:
+          - rp2040:rp2040:rpipico
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+        with:
+          submodules: 'true'
+          
+      - name: Compile sketch
+        uses: arduino/compile-sketches@v1
+        with:
+          fqbn: ${{ matrix.fqbn }}
+          cli-compile-flags: |
+            - --build-property
+            - "build.usbstack_flags=-DUSE_TINYUSB -I{runtime.platform.path}/libraries/Adafruit_TinyUSB_Arduino/src/arduino"
+          platforms: |
+            - name: rp2040:rp2040
+              source-url: https://github.com/earlephilhower/arduino-pico/releases/download/global/package_rp2040_index.json
+          sketch-paths: |
+            - examples/ml_epiano_example
+            - examples/ml_mod_tracker
+            - examples/ml_synth_basic_example
+            #- examples/ml_synth_fm_example
+            - examples/ml_synth_multi_saw_example
+            - examples/ml_synth_organ_example
+            #- examples/ml_synth_pwm_osc_example
+            - examples/ml_synth_sampler_example
+          libraries: |
+              - source-url: https://github.com/marcel-licence/ML_SynthTools.git
+                name: ML_SynthTools
+              - source-url: https://github.com/marcel-licence/ML_SynthTools_Lib.git
+                name: ML_SynthTools_Lib
+              - source-url: https://github.com/adafruit/Adafruit-GFX-Library.git
+                name: Adafruit_GFX_Library
+                version: 1.10.10
+              - source-url: https://github.com/adafruit/Adafruit_SSD1306.git
+                name: Adafruit_SSD1306
+                version: 2.4.5
+              - source-url: https://github.com/adafruit/Adafruit_BusIO.git
+                name: Adafruit BusIO
+                version: 1.14.1
+              - source-url: https://github.com/marcel-licence/AC101.git
+                name: AC101
+              - source-url: https://github.com/marcel-licence/ML_SynthTools.git
+                name: ML_SynthTools
+              - source-url: https://github.com/FortySevenEffects/arduino_midi_library.git
+                name: MIDI_Library
+                version: 5.0.2
+
   build_stm32:
 
     if: false
@@ -164,7 +224,7 @@ jobs:
 
   build_teensy:
 
-    if: false
+    if: true
 
     name: build teensy
 
@@ -188,16 +248,16 @@ jobs:
           platforms: |
             - name: teensy:avr
               source-url: https://www.pjrc.com/teensy/package_teensy_index.json
-              version: 1.56.2
+              version: 1.59.0
           sketch-paths: |
-            - examples/ml_epiano_example
-            - examples/ml_mod_tracker
+            #- examples/ml_epiano_example
+            #- examples/ml_mod_tracker
             - examples/ml_synth_basic_example
             - examples/ml_synth_fm_example
-            - examples/ml_synth_multi_saw_example
-            - examples/ml_synth_organ_example
-            - examples/ml_synth_pwm_osc_example
-            - examples/ml_synth_sampler_example
+            #- examples/ml_synth_multi_saw_example
+            #- examples/ml_synth_organ_example
+            #- examples/ml_synth_pwm_osc_example
+            #- examples/ml_synth_sampler_example
           libraries: |
               - source-url: https://github.com/marcel-licence/ML_SynthTools.git
                 name: ML_SynthTools

README.md

@@ -116,3 +116,13 @@ Some changes in the toolchain cause that the linker searches the lib in the cort
 ---
 
 Please feel free to share your experience and ideas. 
+
+## Support & Donations
+
+If you appreciate the work done on this project and would like to support its development, I would be more than happy to accept donations!
+
+For more information on how to donate, please send an email to:
+
+📧 **[email protected]**
+
+Thank you for your support!

extras/ml_sampler.md

@@ -0,0 +1,56 @@
+# Sampler
+This synthesizer module is made to playback samples from RAM or FLASH memory.
+It allows to manipulate the playback by changing the pitch, volume and tweak parameters like ADSR (attack, decay, sustain, release).
+In addition to that it is possible to loop samples.
+
+To use the **sampler** you need to include ml_sampler.h into your project:
+```cpp
+#include <ml_sampler.h>
+
+```
+
+The sampler requires an initialization by calling its init routine for example from the setup():
+```cpp
+#include <ml_sampler.h>
+
+#define SAMPLE_RATE 44100
+
+void setup(void)
+{
+  Sampler_Init(SAMPLE_RATE);
+  /*
+   * some other setup routines might be called here
+   */
+}
+```
+
+
+## playing samples from FLASH
+### preparing samples
+Samples can be played directly from FLASH when they are compiled into the program code.
+It is possible to convert wav-files into c files into a data array.
+For example prepare a 16bit mono wav-file and store it as test.wav.
+[Audacity](https://www.audacity.de/) can be used for this conversation
+![image](https://github.com/user-attachments/assets/7cbfe52e-24f7-45c9-a8a6-a54b0d1aa272)
+
+Then you can use [Bin2c](https://www.segger.com/free-utilities/bin2c/) to convert it to a c-file.
+You will find an array in the c-file:
+```cpp
+static const unsigned char _actest[55164UL + 1] = {
+```
+which can be used as a sample in the sampler by loading it:
+```cpp
+#include <ml_sampler.h>
+
+#define SAMPLE_RATE 44100
+
+void setup(void)
+{
+  Sampler_Init(SAMPLE_RATE);
+  Sampler_NewSampleStatic(_actest, sizeof(_actest));
+  /*
+   * some other setup routines might be called here
+   */
+}
+```
+Now the sampler is ready to playback the loaded sample.