SysCommon input support

Make Channel and Cable printable

examples/Other/MIDI-Input-Callback/MIDI-Input-Callback.ino

@@ -48,6 +48,16 @@ bool sysExMessageCallback(SysExMessage se) {
                // return false.
 }
 
+bool sysCommonMessageCallback(SysCommonMessage sc) {
+  Serial << F("System Common message: ") << hex                   //
+         << sc.header << ' ' << sc.data1 << ' ' << sc.data2 //
+         << dec << F(" on cable ") << sc.cable.getOneBased() << endl;
+  return true; // Return true to indicate that handling is done,
+               // and Control_Surface shouldn't handle it anymore.
+               // If you want Control_Surface to handle it as well,
+               // return false.
+}
+
 bool realTimeMessageCallback(RealTimeMessage rt) {
   Serial << F("Real-time message: ") //
          << hex << rt.message << dec //
@@ -63,8 +73,9 @@ void setup() {
   Control_Surface.begin();
   Control_Surface.setMIDIInputCallbacks(channelMessageCallback,   //
                                         sysExMessageCallback,     //
+                                        sysCommonMessageCallback, //
                                         realTimeMessageCallback); //
-  // If you don't need all three callbacks, you can pass `nullptr` instead of a
+  // If you don't need all four callbacks, you can pass `nullptr` instead of a
   // function pointer
 }
 

examples/Other/Mackie-Control-Universal-Reverse-Engineering/Mackie-Control-Universal-Reverse-Engineering.ino

@@ -38,6 +38,19 @@ bool sysExMessageCallback(SysExMessage se) {
                 // return false.
 }
 
+bool sysCommonMessageCallback(SysCommonMessage sc) {
+  Serial << F("System Common message: ") << hex << sc.getMessageType();
+  if (sc.getNumberOfDataBytes() >= 1)
+    Serial << sc.getData1();
+  if (sc.getNumberOfDataBytes() >= 2)
+    Serial << sc.getData2();
+  Serial << dec << F(" on cable ") << sc.cable.getOneBased() << endl;
+  return false; // Return true to indicate that handling is done,
+                // and Control_Surface shouldn't handle it anymore.
+                // If you want Control_Surface to handle it as well,
+                // return false.
+}
+
 bool realTimeMessageCallback(RealTimeMessage rt) {
   Serial << F("Real-Time: ") << hex << rt.message << dec << F(" on cable ")
          << rt.cable.getOneBased() << endl;
@@ -54,6 +67,7 @@ void setup() {
   Control_Surface.begin();
   Control_Surface.setMIDIInputCallbacks(channelMessageCallback,   //
                                         sysExMessageCallback,     //
+                                        sysCommonMessageCallback, //
                                         realTimeMessageCallback); //
 }
 

src/Control_Surface/Control_Surface_Class.cpp

@@ -85,6 +85,9 @@ void Control_Surface_::sendChannelMessageImpl(ChannelMessage msg) {
 void Control_Surface_::sendSysExImpl(SysExMessage msg) {
     this->sourceMIDItoPipe(msg);
 }
+void Control_Surface_::sendSysCommonImpl(SysCommonMessage msg) {
+    this->sourceMIDItoPipe(msg);
+}
 void Control_Surface_::sendRealTimeImpl(RealTimeMessage msg) {
     this->sourceMIDItoPipe(msg);
 }
@@ -191,6 +194,18 @@ void Control_Surface_::sinkMIDIfromPipe(SysExMessage msg) {
     MIDIInputElementSysEx::updateAllWith(msg);
 }
 
+void Control_Surface_::sinkMIDIfromPipe(SysCommonMessage msg) {
+#ifdef DEBUG_MIDI_PACKETS
+    DEBUG_OUT << ">>> " << hex << msg.getMessageType() << ' ' << msg.getData1()
+              << ' ' << msg.getData2() << " (" << msg.cable << ')' << dec
+              << endl;
+#endif
+    // If the SysEx Message callback exists, call it to see if we have to
+    // continue handling it.
+    if (sysCommonMessageCallback && sysCommonMessageCallback(msg))
+        return;
+}
+
 void Control_Surface_::sinkMIDIfromPipe(RealTimeMessage rtMessage) {
 #ifdef DEBUG_MIDI_PACKETS
     DEBUG(">>> " << hex << rtMessage.message << " ("

src/Control_Surface/Control_Surface_Class.hpp

@@ -37,7 +37,7 @@ class Control_Surface_ : public MIDI_Sender<Control_Surface_>,
     /// Copying is not allowed
     Control_Surface_ &operator=(Control_Surface_ const &) = delete;
 
-    /// Return the static Control_Surface_ instance (Control_Surface_ is a 
+    /// Return the static Control_Surface_ instance (Control_Surface_ is a
     /// singleton.)
     static Control_Surface_ &getInstance();
 
@@ -74,17 +74,19 @@ class Control_Surface_ : public MIDI_Sender<Control_Surface_>,
     /// Low-level function for sending a MIDI channel voice message.
     void sendChannelMessageImpl(ChannelMessage);
     /// Low-level function for sending a MIDI system common message.
-    void sendSysCommonImpl(SysCommonMessage) { /* TODO */ }
+    void sendSysCommonImpl(SysCommonMessage);
     /// Low-level function for sending a system exclusive MIDI message.
     void sendSysExImpl(SysExMessage);
     /// Low-level function for sending a MIDI real-time message.
     void sendRealTimeImpl(RealTimeMessage);
     /// Low-level function for sending any buffered outgoing MIDI messages.
+    /// @todo Implement this in MIDI_Pipe
     void sendNowImpl() { /* TODO */ }
 
   private:
     void sinkMIDIfromPipe(ChannelMessage msg) override;
     void sinkMIDIfromPipe(SysExMessage msg) override;
+    void sinkMIDIfromPipe(SysCommonMessage msg) override;
     void sinkMIDIfromPipe(RealTimeMessage msg) override;
 
   private:
@@ -105,6 +107,10 @@ class Control_Surface_ : public MIDI_Sender<Control_Surface_>,
     /// done in the user-provided callback, false if `Control_Surface`
     /// should handle the message.
     using SysExMessageCallback = bool (*)(SysExMessage);
+    /// Callback function type for System Common messages. Return true if
+    /// handling is done in the user-provided callback, false if
+    /// `Control_Surface` should handle the message.
+    using SysCommonMessageCallback = bool (*)(SysCommonMessage);
     /// Callback function type for Real-Time messages. Return true if handling
     /// is done in the user-provided callback, false if `Control_Surface`
     /// should handle the message.
@@ -114,9 +120,11 @@ class Control_Surface_ : public MIDI_Sender<Control_Surface_>,
     void
     setMIDIInputCallbacks(ChannelMessageCallback channelMessageCallback,
                           SysExMessageCallback sysExMessageCallback,
+                          SysCommonMessageCallback sysCommonMessageCallback,
                           RealTimeMessageCallback realTimeMessageCallback) {
         this->channelMessageCallback = channelMessageCallback;
         this->sysExMessageCallback = sysExMessageCallback;
+        this->sysCommonMessageCallback = sysCommonMessageCallback;
         this->realTimeMessageCallback = realTimeMessageCallback;
     }
 
@@ -125,6 +133,7 @@ class Control_Surface_ : public MIDI_Sender<Control_Surface_>,
   private:
     ChannelMessageCallback channelMessageCallback = nullptr;
     SysExMessageCallback sysExMessageCallback = nullptr;
+    SysCommonMessageCallback sysCommonMessageCallback = nullptr;
     RealTimeMessageCallback realTimeMessageCallback = nullptr;
     MIDI_Pipe inpipe, outpipe;
 };

src/Def/Cable.cpp

@@ -0,0 +1,10 @@
+#include "Cable.hpp"
+#include <AH/PrintStream/PrintStream.hpp>
+
+BEGIN_CS_NAMESPACE
+
+Print &operator<<(Print &os, Cable c) {
+    return os << F("Cable ") << c.getOneBased();
+}
+
+END_CS_NAMESPACE

src/Def/Cable.hpp

@@ -2,8 +2,8 @@
 
 #pragma once
 
+#include <AH/Arduino-Wrapper.h> // Print
 #include <Settings/NamespaceSettings.hpp>
-#include <stdint.h> // uint8_t
 
 BEGIN_CS_NAMESPACE
 
@@ -132,4 +132,6 @@ constexpr Cable CABLE_14 = Cable::createCable(14);
 constexpr Cable CABLE_15 = Cable::createCable(15);
 constexpr Cable CABLE_16 = Cable::createCable(16);
 
+Print &operator<<(Print &, Cable);
+
 END_CS_NAMESPACE

src/Def/Channel.cpp

@@ -1,3 +1,10 @@
-#ifdef TEST_COMPILE_ALL_HEADERS_SEPARATELY
 #include "Channel.hpp"
-#endif
+#include <AH/PrintStream/PrintStream.hpp>
+
+BEGIN_CS_NAMESPACE
+
+Print &operator<<(Print &os, Channel c) {
+    return os << F("Channel ") << c.getOneBased();
+}
+
+END_CS_NAMESPACE

src/Def/Channel.hpp

@@ -2,8 +2,8 @@
 
 #pragma once
 
+#include <AH/Arduino-Wrapper.h> // Print
 #include <Settings/NamespaceSettings.hpp>
-#include <stdint.h> // uint8_t
 
 BEGIN_CS_NAMESPACE
 
@@ -132,4 +132,6 @@ constexpr Channel CHANNEL_14 = Channel::createChannel(14);
 constexpr Channel CHANNEL_15 = Channel::createChannel(15);
 constexpr Channel CHANNEL_16 = Channel::createChannel(16);
 
+Print &operator<<(Print &, Channel);
+
 END_CS_NAMESPACE

src/MIDI_Interfaces/BluetoothMIDI_Interface.cpp

@@ -169,6 +169,10 @@ void BluetoothMIDI_Interface::sendSysExImpl(SysExMessage msg) {
     cv.notify_one();
 }
 
+void BluetoothMIDI_Interface::sendSysCommonImpl(SysCommonMessage) {
+    // TODO
+}
+
 // -------------------------------------------------------------------------- //
 
 void BluetoothMIDI_Interface::parse(const uint8_t *const data,

src/MIDI_Interfaces/BluetoothMIDI_Interface.hpp

@@ -79,8 +79,7 @@ class BluetoothMIDI_Interface : public MIDI_Interface {
   protected:
     // MIDI send implementations
     void sendChannelMessageImpl(ChannelMessage) override;
-    void sendSysCommonImpl(SysCommonMessage) override { /* TODO */
-    }
+    void sendSysCommonImpl(SysCommonMessage) override;
     void sendSysExImpl(SysExMessage) override;
     void sendRealTimeImpl(RealTimeMessage) override;
     void sendNowImpl() override { flush(); }