DRAFT support for maximilian

Author: pschatzmann

README.md

@@ -120,6 +120,7 @@ Dependent on the example you might need to install some of the following librari
 - [TTS](https://github.com/pschatzmann/TTS) A Text to Speach Engine
 - [flite](https://github.com/pschatzmann/arduino-flite) A Text to Speach Engine
 - [arduino-stk](https://github.com/pschatzmann/Arduino-STK) Synthesis ToolKit in C++ (STK) 
+- [Maximilian](https://github.com/pschatzmann/Maximilian) cross-platform and multi-target audio synthesis and signal processing library
 - [Mozzi](https://github.com/pschatzmann/Mozzi) A sound synthesis library for Arduino
 - [ESP8266Audio](https://github.com/earlephilhower/ESP8266Audio) to play different audio Formats
 

examples/examples-maximilian/01-TestTone/01-testTone.ino

@@ -0,0 +1,29 @@
+#include "AudioTools.h"
+#include "AudioLibs/MaximilianDSP.h"
+
+// Define output
+I2SStream out;
+Maximilian maximilian(out);
+
+//This shows how the fundamental building block of digital audio - the sine wave.
+maxiOsc mySine;//One oscillator - can be called anything. Can be any of the available waveforms.
+
+void setup() {//some inits
+  // setup logging
+  Serial.begin(115200);
+  AudioLogger::instance().begin(Serial, AudioLogger::Info);
+  // setup Aduio output
+  auto cfg = out.defaultConfig(TX_MODE);
+  out.begin(cfg);
+  maxiSettings::setup(cfg.sample_rate, cfg.channels, 512);
+}
+
+void play(double *output) {
+    output[0]=mySine.sinewave(440);
+    output[1]=output[0];
+}
+
+// Arduino loop
+void loop() {
+    maximilian.loop();
+}

examples/examples-maximilian/02-TwoTones/02-TwoTones.ino

@@ -0,0 +1,32 @@
+//This examples shows another fundamental building block of digital audio - adding two sine waves together. When you add waves together they create a new wave whose amplitude at any time is computed by adding the current amplitudes of each wave together. So, if one wave has an amplitude of 1, and the other has an amplitude of 1, the new wave will be equal to 2 at that point in time. Whereas, later, if one wave has an amplitude of -1, and the other has an amplitude of 1, the new wave - the one you hear - will equal 0. This can create some interesting effects, including 'beating', when the waves interact to create a single wave that fades up and down based on the frequencies of the two interacting waves. The frequency of the 'beating' i.e. the fading in and out, is equal to the difference in frequency between the two waves.
+
+#include "MaximilianDSP.h"
+
+// Define output
+I2SStream out;
+Maximilian maximilian(out);
+
+maxiOsc mySine,myOtherSine;//Two oscillators with names.
+
+void setup() {//some inits
+  // setup logging
+  Serial.begin(115200);
+  AudioLogger::instance().begin(Serial, AudioLogger::Info);
+
+  // setup Aduio output
+  auto cfg = out.defaultConfig(TX_MODE);
+  out.begin(cfg);
+  maxiSettings::setup(cfg.sample_rate, cfg.channels, 512);
+}
+
+void play(double *output) {//this is where the magic happens. Very slow magic.
+    //output[0] is the left output. output[1] is the right output
+    output[0]=mySine.sinewave(440)+myOtherSine.sinewave(441);//these two sines will beat together. They're now a bit too loud though..
+    output[1]=output[0];
+}
+
+
+// Arduino loop
+void loop() {
+    maximilian.loop();
+}

examples/examples-maximilian/03-AM1/03-AM1.ino

@@ -0,0 +1,37 @@
+#include "MaximilianDSP.h"
+
+// Define Arduino output
+I2SStream out;
+Maximilian maximilian(out);
+
+//This shows how to use maximilian to do basic amplitude modulation. Amplitude modulation is when you multiply waves together. In maximilian you just use the * inbetween the two waveforms.
+
+maxiOsc mySine,myOtherSine;//Two oscillators. They can be called anything. They can be any of the available waveforms. These ones will be sinewaves
+
+void setup() {//some inits
+  // setup logging
+  Serial.begin(115200);
+  AudioLogger::instance().begin(Serial, AudioLogger::Info);
+
+  // setup Aduio output
+  auto cfg = out.defaultConfig(TX_MODE);
+  out.begin(cfg);
+  maxiSettings::setup(cfg.sample_rate, cfg.channels, 512);
+}
+
+void play(double *output) {
+    
+    // This form of amplitude modulation is straightforward multiplication of two waveforms.
+    // Notice that the maths is different to when you add waves.
+    // The waves aren't 'beating'. Instead, the amplitude of one is modulating the amplitude of the other
+    // Remember that the sine wave has positive and negative sections as it oscillates.
+    // When you multiply something by -1, its phase is inverted but it retains its amplitude.
+    // So you hear 2 waves per second, not 1, even though the frequency is 1.
+    output[0]=mySine.sinewave(440)*myOtherSine.sinewave(1);
+    output[1]=output[0];
+}
+
+// Arduino loop
+void loop() {
+    maximilian.loop();
+}

examples/examples-maximilian/04-AM2/04-AM2.ino

@@ -0,0 +1,41 @@
+#include "MaximilianDSP.h"
+
+// Define Arduino output
+I2SStream out;
+Maximilian maximilian(out);
+
+//This shows how to use maximilian to do basic amplitude modulation.
+//It also shows what happens when you modulate waves with waves that have frequencies over 20 hz.
+//You start to get interesting effects.
+
+maxiOsc mySine,myOtherSine,myPhasor;//Three oscillators. They can be called anything. They can be any of the available waveforms.
+
+
+void setup() {//some inits
+  // setup logging
+  Serial.begin(115200);
+  AudioLogger::instance().begin(Serial, AudioLogger::Info);
+
+  // setup Aduio output
+  auto cfg = out.defaultConfig(TX_MODE);
+  out.begin(cfg);
+  maxiSettings::setup(cfg.sample_rate, cfg.channels, 512);
+}
+
+void play(double *output) {
+    
+    //Using the phasor we can create a ramp, and use this ramp to set the frequency of one of the waves.
+    //When the frequency of the lower waveform passes over the threshold of 20hz, we start to hear two new waveforms.
+    //The frequency of the first new wave is the sum of the two original waves.
+    //The frequency of the second new wave is the difference of the two original waves.
+    //So you hear two new waves, one going up, one going down.
+    
+    output[0]=mySine.sinewave(440)*myOtherSine.sinewave(myPhasor.phasor(0.01,0,440));
+    output[1]=output[0];
+   
+}
+
+// Arduino loop
+void loop() {
+    maximilian.loop();
+}

examples/examples-maximilian/05-FM1/05-FM1.ino

@@ -0,0 +1,51 @@
+// One way of thinking about FM synthesis is to see it as vibrato.
+// You make a pitch, then vary it up and down at some rate.
+// You can change the speed of the pitch variation (modulation frequency), and also the amount of variation (modulation index).
+// In FM, usually only one of the waveforms - the carrier that provides the initial pitch - is sent to the output.
+// The frequency of the the carrier wave is continually adjusted at a rate equal to the frequency of the second wave (the modulator).
+// So at any given point in time, the frequency of the carrier can increase by an amount equal to the current amp of the modulator.
+// This has some interesting effects.
+
+#include "MaximilianDSP.h"
+
+// Define Arduino output
+I2SStream out;
+Maximilian maximilian(out);
+// Maximilian
+maxiOsc mySine,myOtherSine;//Two oscillators
+
+
+void setup() {//some inits
+  // setup logging
+  Serial.begin(115200);
+  AudioLogger::instance().begin(Serial, AudioLogger::Info);
+
+  // setup Aduio output
+  auto cfg = out.defaultConfig(TX_MODE);
+  out.begin(cfg);
+  maxiSettings::setup(cfg.sample_rate, cfg.channels, 512);
+}
+
+void play(double *output) {
+    
+    // In this example, the 'myOtherSine.sinewave' is at an amplitude of 1, it's original amplitude.
+    // This is pretty simple and not too useful.
+    //output[0]=mySine.sinewave(440*myOtherSine.sinewave(1));
+    
+    // Perhaps you should comment out the above line and uncomment the below one instead
+    // It shows how the frequency of the carrier is altered by ADDING a second waveform to its frequency value.
+    // The carrier frequency is 440, and the modulation frequency is 1.
+    // It also shows how the modulation index works. In this case the modulation index is 100
+    // Try adjusting the modolation index. Also, try altering the modulation frequency.
+    output[0]=mySine.sinewave(440+(myOtherSine.sinewave(1)*100));
+    output[1]=output[0];
+
+}
+
+// In complex FM systems you can have lots of modulators stacked together in interesting ways, and theoretically this can make any sound.
+// John Chowning is the guy you probably want to talk to about that.
+
+// Arduino loop
+void loop() {
+    maximilian.loop();
+}

examples/examples-maximilian/06-FM2/06-FM2.ino

@@ -0,0 +1,31 @@
+// Nothing much to say about this other than I like it.
+
+#include "MaximilianDSP.h"
+
+// Define Arduino output
+I2SStream out;
+Maximilian maximilian(out);
+// Maximilian 
+maxiOsc mySine,myOtherSine,myLastSine,myPhasor;//Three oscillators
+
+
+void setup() {//some inits
+  // setup logging
+  Serial.begin(115200);
+  AudioLogger::instance().begin(Serial, AudioLogger::Info);
+
+  // setup Aduio output
+  auto cfg = out.defaultConfig(TX_MODE);
+  out.begin(cfg);
+  maxiSettings::setup(cfg.sample_rate, cfg.channels, 512);
+}
+
+void play(double *output) {
+    output[0]=mySine.sinewave(myOtherSine.sinewave(myLastSine.sinewave(0.1)*30)*440);//awesome bassline
+    output[1]=output[0];
+}
+
+// Arduino loop
+void loop() {
+    maximilian.loop();
+}

examples/examples-maximilian/07-Counting1/07-Counting1.ino

@@ -0,0 +1,51 @@
+
+#include "MaximilianDSP.h"
+
+// Define Arduino output
+I2SStream out;
+Maximilian maximilian(out);
+
+// Maximilian
+maxiOsc mySine; // This is the oscillator we will use to generate the test tone
+maxiClock myClock; // This will allow us to generate a clock signal and do things at specific times
+double freq; // This is a variable that we will use to hold and set the current frequency of the oscillator
+
+void setup() {
+    // setup logging
+    Serial.begin(115200);
+    AudioLogger::instance().begin(Serial, AudioLogger::Info);
+
+    // setup audio output
+    auto cfg = out.defaultConfig(TX_MODE);
+    out.begin(cfg);
+    maxiSettings::setup(cfg.sample_rate, cfg.channels, 512);
+
+    // setup maximilian   
+    myClock.setTicksPerBeat(1);//This sets the number of ticks per beat
+    myClock.setTempo(120);// This sets the tempo in Beats Per Minute
+    freq=20; // Here we initialise the variable
+}
+
+void play(double *output) {
+    
+    myClock.ticker(); // This makes the clock object count at the current samplerate
+    
+    //This is a 'conditional'. It does a test and then does something if the test is true 
+
+    if (myClock.tick) { // If there is an actual tick at this time, this will be true.
+        
+        freq+=100; // DO SOMETHING
+        
+    } // The curly braces close the conditional
+    
+    //output[0] is the left output. output[1] is the right output
+    
+    output[0]=mySine.sinewave(freq);//simple as that!
+    output[1]=output[0];
+
+}
+
+// Arduino loop
+void loop() {
+    maximilian.loop();
+}

examples/examples-maximilian/08-Counting2/08-Counting2.ino

@@ -0,0 +1,52 @@
+// This example shows how you can create a basic counter with a phasor.
+// A phasor oscillator can create a ramp between any two values.
+// It takes three inputs - frequency, start value and stop value.
+// These are all double precision floats, so it's a continuous slide.
+// If you write it into an integer, it will round it off for you.
+// This creates a bunch of steps.
+
+#include "MaximilianDSP.h"
+
+// Define Arduino output
+I2SStream out;
+Maximilian maximilian(out);
+
+// Maximilian
+maxiOsc myCounter,mySquare;//these oscillators will help us count and play sound
+int CurrentCount;//we're going to put the current count in this variable so that we can use it more easily.
+
+
+void setup() {//some inits
+    // setup logging
+    Serial.begin(115200);
+    AudioLogger::instance().begin(Serial, AudioLogger::Info);
+
+    // setup audio output
+    auto cfg = out.defaultConfig(TX_MODE);
+    out.begin(cfg);
+    maxiSettings::setup(cfg.sample_rate, cfg.channels, 512);
+}
+
+void play(double *output) {
+    
+    // Here you can see that CurrentCount is an int. It's taking the continuous output of the phasor and convering it.
+    // You don't need to explicityly 'cast' (i.e. change) the value from a float to an int.
+    // It happens automagically in these cases.
+    
+    // Once every second, CurrentCount counts from 1 until it gets to 9, then resets itself.
+    // When it reaches 9 it resets, so the values you get are 1-8.
+    
+    CurrentCount=myCounter.phasor(1, 1, 9);//phasor can take three arguments; frequency, start value and end value.
+    
+    // If we multiply the output of CurrentCount by 100, we get 100,200,300,400,500,600,700,800 in that order.
+    // These become the frequency of the oscillator.
+    // In this case, the oscillator is an antialiased sawtooth wave. Yum.
+    output[0]=mySquare.sawn(CurrentCount*100);
+    output[1]=output[0];
+
+}
+
+// Arduino loop
+void loop() {
+    maximilian.loop();
+}

examples/examples-maximilian/08-Counting3/08-Counting3.ino

@@ -0,0 +1,45 @@
+#include "MaximilianDSP.h"
+
+// Define Arduino output
+I2SStream out;
+Maximilian maximilian(out);
+
+// Maximilian
+maxiOsc myCounter,mySwitchableOsc;//these oscillators will help us count and make sound.
+int CurrentCount;//we're going to put the current count in this variable so that we can use it more easily.
+double myOscOutput;//we're going to stick the output here to make it easier to mess with stuff.
+
+void setup() {//some inits
+    // setup logging
+    Serial.begin(115200);
+    AudioLogger::instance().begin(Serial, AudioLogger::Info);
+
+    // setup audio output
+    auto cfg = out.defaultConfig(TX_MODE);
+    out.begin(cfg);
+    maxiSettings::setup(cfg.sample_rate, cfg.channels, 512);
+}
+
+void play(double *output) {
+	
+	CurrentCount=myCounter.phasor(1, 1, 9);//phasor can take three arguments; frequency, start value and end value.
+
+// here we use a conditional to make something happen at a specific time.	
+
+	if (CurrentCount<5)//simple if statement
+		
+		myOscOutput=mySwitchableOsc.square(CurrentCount*100);
+	
+	else if (CurrentCount>=5)//and the 'else' bit.
+		
+		myOscOutput=mySwitchableOsc.sinewave(CurrentCount*50);//one osc object can produce whichever waveform you want. 
+	
+    output[0]=myOscOutput;
+    output[1]=output[0];
+
+}
+
+// Arduino loop
+void loop() {
+    maximilian.loop();
+}