Merge pull request #80 from lathoub/feat/2.0.0

Feat/2.0.0

Author: lathoub

.gitignore

@@ -1,3 +1,10 @@
 .DS_Store
 examples/.DS_Store
 src/.DS_Store
+test/.vs
+test/Debug
+examples/ESP32_NoteOnOffEverySec/config.h
+src/.vscode
+test/x64
+.development
+examples/ESP32_NoteOnOffEverySec/credentials.h

.travis.yml

@@ -10,16 +10,7 @@ cache:
 install:
     - pip install -U platformio
     - platformio update
-    - platformio lib -g install 870 872
+    - platformio lib -g install [email protected] 870 872
 
 script:
-- platformio ci --board=huzzah --lib=. examples/Esp32_NoteOnOffEverySec/Esp32_NoteOnOffEverySec.ino;
-- platformio ci --board=huzzah --lib=. examples/Esp8266_2Sessions_NoteOnOffEverySec/Esp8266_2Sessions_NoteOnOffEverySec.ino;
-- platformio ci --board=huzzah --lib=. examples/Esp8266_NoteOnOffEverySec/Esp8266_NoteOnOffEverySec.ino;
-- platformio ci --board=uno    --lib=. examples/EthernetShield_InitiateSession/EthernetShield_InitiateSession.ino;
-- platformio ci --board=uno    --lib=. examples/EthernetShield_InitiateSessions/EthernetShield_InitiateSessions.ino;
 - platformio ci --board=uno    --lib=. examples/EthernetShield_NoteOnOffEverySec/EthernetShield_NoteOnOffEverySec.ino;
-- platformio ci --board=uno    --lib=. examples/EthernetShield_RealTimeMessages/EthernetShield_RealTimeMessages.ino;
-- platformio ci --board=uno    --lib=. examples/EthernetShield_ReceiveMTC/EthernetShield_ReceiveMTC.ino;
-- platformio ci --board=uno    --lib=. examples/EthernetShield_SysEx/EthernetShield_SysEx.ino;
-- platformio ci --board=uno    --lib=. examples/Wifi_NoteOnOffEverySec/Wifi_NoteOnOffEverySec.ino;

README.md

@@ -4,7 +4,7 @@
 Enables an Arduino with IP/UDP capabilities (Ethernet shield, ESP8266, ESP32, ...) to particpate in an AppleMIDI session.
 
 ## Features
-* Tested with AppleMIDI on Mac OS (High Sierra) and using [rtpMIDI](https://www.tobias-erichsen.de/software/rtpmidi.html) from Tobias Erichsen on Windows 10
+* Tested with AppleMIDI on Mac OS (Catalina) and using [rtpMIDI](https://www.tobias-erichsen.de/software/rtpmidi.html) from Tobias Erichsen on Windows 10
 * Send and receive all MIDI messages
 * Uses callbacks to receive MIDI commands (no need for polling)
 * Automatic instantiation of AppleMIDI object (see at the end of 'AppleMidi.h')
@@ -15,23 +15,29 @@ From the Arduino IDE Library Manager, search for AppleMIDI
 
 ## Basic Usage
 ```
-#include "AppleMidi.h"
+#include <Ethernet.h>
+#include <AppleMidi.h>
 
-APPLEMIDI_CREATE_DEFAULT_INSTANCE(); 
+APPLEMIDI_CREATE_DEFAULTSESSION_INSTANCE(); 
 
 void setup()
 {
-  // ...setup ethernet connection
-  AppleMIDI.begin("test"); // 'test' will show up as the session name
+  MIDI.begin(1);
+  
+  // Optional
+  AppleMIDI.setHandleConnected(OnAppleMidiConnected);
 }
 
 void loop()
 {
-  AppleMIDI.run();
-  // ...
+  // Listen to incoming notes
+  MIDI.read();
   
   // Send MIDI note 40 on, velocity 55 on channel 1
-  AppleMIDI.sendNoteOn(40, 55, 1);
+  MIDI.sendNoteOn(40, 55, 1);
+}
+
+void OnAppleMidiConnected(uint32_t ssrc, const char* name) {
 }
 ```
 More usages in the `examples` folder
@@ -44,21 +50,21 @@ More usages in the `examples` folder
 * Adafruit Feather M0 WiFi - ATSAMD21 + ATWINC1500 
 
 ## Memory usage
-The code has been pseudo optimized to minimize the memory footprint.
-Internal buffers also use valuable memory space. The biggest buffer `PACKET_MAX_SIZE` is set to 350 by default in `AppleMidi_Settings.h`. Albeit this number is somewhat arbitratry (large enough to receive full SysEx messages), it can be reduced significantly if you do not have to receive large messages.
+This library is not using any dynamic memory allocation methods - all buffers have a fixed size, set in the `AppleMIDI_Settings.h` file, avoiding potential memory leaks and memory fragmentation.
 
-On an Arduino, 2 sessions can be active at once (W5100 can have max 4 sockets open at the same time, each session needs 2 UDP sockets). Setting MAX_SESSIONS to 1 saves 228 bytes (each session takes 228 bytes).
+The minimum buffer size (`MaxBufferSize`) should be set to 64 bytes (also the default). Setting it to a higher value will make sending larger SysEx messages more efficiant (large SysEx messages are chopped in pieces, the larger the buffer, the less pieces needed), at the price of a bigger memory footprint.
 
-Save memory (about 2000 bytes) when the device does not initiate sessions by `#undef APPLEMIDI_REMOTE_SESSIONS` in `AppleMidi_Settings.h`. See the `EthernetShield_NoteOnOffEverySec.ino` example
+`MaxNumberOfParticipants` is another way to cut memory - each particpants uses approx 300 bytes. Default number of participants is 1 (using 2 sockets). 
+Beware: the number of sockets on the Arduino is limited. The W5100 support 4, the W5200 and W5500 based IP chips can use 8 sockets. (Each participant uses 2 sockets: port 5004 and 5004+1). (Base port can be set in `APPLEMIDI_CREATE_DEFAULT_INSTANCE`)
 
 ## Network Shields
-* Arduino Ethernet shield (Wiznet W5100)
+* Arduino Ethernet shield (Wiznet W5100 and W5500)
 * Arduino Wifi R3 shield
 * MKR ETH shield
 * Teensy WIZ820io W5200
 
 ## Arduino IDE (arduino.cc)
-* 1.8.9
+* 1.8.10
 
 ## Contributing
 I would love to include your enhancements or bug fixes! In lieu of a formal styleguide, please take care to maintain the existing coding style. Please test your code before sending a pull request. It would be very helpful if you include a detailed explanation of your changes in the pull request.

examples/Basic_IO/Basic_IO.ino

@@ -0,0 +1,37 @@
+#include <Ethernet.h>
+#include <AppleMIDI.h>
+
+// Enter a MAC address for your controller below.
+// Newer Ethernet shields have a MAC address printed on a sticker on the shield
+byte mac[] = {
+  0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0xED
+};
+
+// Simple tutorial on how to receive and send MIDI messages.
+// Here, when receiving any message on channel 4, the Arduino
+// will blink a led and play back a note for 1 second.
+
+APPLEMIDI_CREATE_DEFAULTSESSION_INSTANCE();
+
+void setup()
+{
+  if (Ethernet.begin(mac) == 0) {
+    Serial.println(F("Failed DHCP, check network cable & reboot"));
+    for (;;);
+  }
+
+  pinMode(LED_BUILTIN, OUTPUT);
+  MIDI.begin(4);                      // Launch MIDI and listen to channel 4
+}
+
+void loop()
+{
+  if (MIDI.read())                    // If we have received a message
+  {
+    digitalWrite(LED_BUILTIN, HIGH);
+    MIDI.sendNoteOn(42, 127, 1);    // Send a Note (pitch 42, velo 127 on channel 1)
+    delay(1000);                    // Wait for a second
+    MIDI.sendNoteOff(42, 0, 1);     // Stop the note
+    digitalWrite(LED_BUILTIN, LOW);
+  }
+}

examples/Esp32_NoteOnOffEverySec/Esp32_NoteOnOffEverySec.ino renamed to examples/ESP32-Ethernet-Kit_A_v1.1_NoteOnOffEverySec/ESP32-Ethernet-Kit_A_v1.1_NoteOnOffEverySec.ino

@@ -1,63 +1,48 @@
-// These need to be included when using standard Ethernet
-#include <WiFi.h>
-#include <WiFiClient.h>
-#include <WiFiUdp.h>
+#include "ETH_Helper.h"
 
-#include "AppleMidi.h"
-
-char ssid[] = "yourNetwork"; //  your network SSID (name)
-char pass[] = "password";    // your network password (use for WPA, or use as key for WEP)
+#include <AppleMIDI.h>
+USING_NAMESPACE_APPLEMIDI
 
 unsigned long t0 = millis();
 bool isConnected = false;
 
-APPLEMIDI_CREATE_INSTANCE(WiFiUDP, AppleMIDI); // see definition in AppleMidi_Defs.h
+APPLEMIDI_CREATE_DEFAULTSESSION_ESP32_INSTANCE();
 
 // -----------------------------------------------------------------------------
 //
 // -----------------------------------------------------------------------------
 void setup()
 {
-  // Serial communications and wait for port to open:
   Serial.begin(115200);
-  while (!Serial) {
-    ; // wait for serial port to connect. Needed for Leonardo only
-  }
-
-  Serial.print(F("Getting IP address..."));
-
+  while (!Serial);
+  Serial.println("Booting");
 
-  WiFi.begin(ssid, pass);
-
-  while (WiFi.status() != WL_CONNECTED) {
-    delay(500);
-    Serial.print(F("."));
-  }
-  Serial.println(F(""));
-  Serial.println(F("WiFi connected"));
+  ETH_startup();
+  
+  MDNS.begin(AppleMIDI.getName());
 
-
-  Serial.println();
-  Serial.print(F("IP address is "));
-  Serial.println(WiFi.localIP());
+  Serial.print("\nIP address is ");
+  Serial.println(ETH.localIP());
 
   Serial.println(F("OK, now make sure you an rtpMIDI session that is Enabled"));
   Serial.print(F("Add device named Arduino with Host/Port "));
-  Serial.print(WiFi.localIP());
+  Serial.print(ETH.localIP());
   Serial.println(F(":5004"));
   Serial.println(F("Then press the Connect button"));
   Serial.println(F("Then open a MIDI listener (eg MIDI-OX) and monitor incoming notes"));
 
   // Create a session and wait for a remote host to connect to us
-  AppleMIDI.begin("test");
+  MIDI.begin(1); // listen on channel 1
+
+  AppleMIDI.setHandleConnected(OnAppleMidiConnected);
+  AppleMIDI.setHandleDisconnected(OnAppleMidiDisconnected);
 
-  AppleMIDI.OnConnected(OnAppleMidiConnected);
-  AppleMIDI.OnDisconnected(OnAppleMidiDisconnected);
+  MIDI.setHandleNoteOn(OnAppleMidiNoteOn);
+  MIDI.setHandleNoteOff(OnAppleMidiNoteOff);
 
-  AppleMIDI.OnReceiveNoteOn(OnAppleMidiNoteOn);
-  AppleMIDI.OnReceiveNoteOff(OnAppleMidiNoteOff);
+  MDNS.addService("apple-midi", "udp", AppleMIDI.getPort());
 
-  Serial.println(F("Sending NoteOn/Off of note 45, every second"));
+  Serial.println(F("Every second send a random NoteOn/Off"));
 }
 
 // -----------------------------------------------------------------------------
@@ -66,21 +51,21 @@ void setup()
 void loop()
 {
   // Listen to incoming notes
-  AppleMIDI.read();
+  MIDI.read();
 
   // send a note every second
   // (dont cáll delay(1000) as it will stall the pipeline)
   if (isConnected && (millis() - t0) > 1000)
   {
     t0 = millis();
-    //   Serial.print(".");
+    //   Serial.print(F(".");
 
-    byte note = 45;
+    byte note = random(1, 127);
     byte velocity = 55;
     byte channel = 1;
 
-    AppleMIDI.sendNoteOn(note, velocity, channel);
-    AppleMIDI.sendNoteOff(note, velocity, channel);
+    MIDI.sendNoteOn(note, velocity, channel);
+    MIDI.sendNoteOff(note, velocity, channel);
   }
 }
 
@@ -91,42 +76,40 @@ void loop()
 // -----------------------------------------------------------------------------
 // rtpMIDI session. Device connected
 // -----------------------------------------------------------------------------
-void OnAppleMidiConnected(uint32_t ssrc, char* name) {
-  isConnected  = true;
+void OnAppleMidiConnected(const ssrc_t & ssrc, const char* name) {
+  isConnected = true;
   Serial.print(F("Connected to session "));
   Serial.println(name);
 }
 
 // -----------------------------------------------------------------------------
 // rtpMIDI session. Device disconnected
 // -----------------------------------------------------------------------------
-void OnAppleMidiDisconnected(uint32_t ssrc) {
-  isConnected  = false;
+void OnAppleMidiDisconnected(const ssrc_t & ssrc) {
+  isConnected = false;
   Serial.println(F("Disconnected"));
 }
 
 // -----------------------------------------------------------------------------
 //
 // -----------------------------------------------------------------------------
-void OnAppleMidiNoteOn(byte channel, byte note, byte velocity) {
-  Serial.print(F("Incoming NoteOn from channel:"));
+static void OnAppleMidiNoteOn(byte channel, byte note, byte velocity) {
+  Serial.print(F("Incoming NoteOn  from channel: "));
   Serial.print(channel);
-  Serial.print(F(" note:"));
+  Serial.print(F(", note: "));
   Serial.print(note);
-  Serial.print(F(" velocity:"));
-  Serial.print(velocity);
-  Serial.println();
+  Serial.print(F(", velocity: "));
+  Serial.println(velocity);
 }
 
 // -----------------------------------------------------------------------------
 //
 // -----------------------------------------------------------------------------
-void OnAppleMidiNoteOff(byte channel, byte note, byte velocity) {
-  Serial.print(F("Incoming NoteOff from channel:"));
+static void OnAppleMidiNoteOff(byte channel, byte note, byte velocity) {
+  Serial.print(F("Incoming NoteOff from channel: "));
   Serial.print(channel);
-  Serial.print(F(" note:"));
+  Serial.print(F(", note: "));
   Serial.print(note);
-  Serial.print(F(" velocity:"));
-  Serial.print(velocity);
-  Serial.println();
+  Serial.print(F(", velocity: "));
+  Serial.println(velocity);
 }

examples/ESP32-Ethernet-Kit_A_v1.1_NoteOnOffEverySec/ETH_Helper.h

@@ -0,0 +1,60 @@
+#include <ETH.h>
+#include <ESPmDNS.h>
+
+#define ETH_ADDR        1
+#define ETH_POWER_PIN   5
+#define ETH_MDC_PIN     23
+#define ETH_MDIO_PIN    18
+#define ETH_TYPE        ETH_PHY_IP101
+
+static bool eth_connected = false;
+
+void WiFiEvent(WiFiEvent_t event)
+{
+  switch (event) {
+    case SYSTEM_EVENT_ETH_START:
+      Serial.println("ETH Started");
+      //set eth hostname here
+      ETH.setHostname("esp32-ethernet");
+      break;
+    case SYSTEM_EVENT_ETH_CONNECTED:
+      Serial.println("ETH Connected");
+      break;
+    case SYSTEM_EVENT_ETH_GOT_IP:
+      Serial.print("ETH MAC: ");
+      Serial.print(ETH.macAddress());
+      Serial.print(", IPv4: ");
+      Serial.print(ETH.localIP());
+      if (ETH.fullDuplex()) {
+        Serial.print(", FULL_DUPLEX");
+      }
+      Serial.print(", ");
+      Serial.print(ETH.linkSpeed());
+      Serial.println("Mbps");
+      eth_connected = true;
+      break;
+    case SYSTEM_EVENT_ETH_DISCONNECTED:
+      Serial.println("ETH Disconnected");
+      eth_connected = false;
+      break;
+    case SYSTEM_EVENT_ETH_STOP:
+      Serial.println("ETH Stopped");
+      eth_connected = false;
+      break;
+    default:
+      break;
+  }
+}
+
+bool ETH_startup()
+{
+  WiFi.onEvent(WiFiEvent);
+  ETH.begin(ETH_ADDR, ETH_POWER_PIN, ETH_MDC_PIN, ETH_MDIO_PIN, ETH_TYPE);
+
+  Serial.println(F("Getting IP address..."));
+
+  while (!eth_connected)
+    delay(100);
+
+  return true;
+}