add DAW Controller support for various Arturia controllers

MiniLab 3
Keylab Essential
KeyLab Essential mk3
KeyLab mkII

based on https://github.com/PrzemekBarski/arturia-keylab-essential-mk3-programming-guide

Tested on a Arturia MiniLab 3 and KeyLab mkII

Keylab Essential and Keylab Essential mk3 is not tested

Author: soyersoyer

README.md

@@ -15,6 +15,173 @@ DreamDexed is a [MiniDexed](https://github.com/probonopd/MiniDexed) fork with th
 - [ ] Overlay Menu for easier parameter changes
 - [ ] MIDI Controller DAW integration
 
+# DreamDexed Arturia fork
+
+This is a fork of DreamDexed that integrates better with Arturia keyboards.
+
+Maybe someday it will be part of the DreamDexed
+
+## Enabling
+
+This feature can be enabled in the minidexed.ini with:
+```
+DAWControllerEnabled=1
+```
+
+## Features
+
+### Controller Display, Main Encoder
+The controller display in DAW mode shows the DreamDexed menu.
+
+With the main encoder you can navigate in the menu.
+
+The Home is the shift+Main click
+
+Supported:
+- MiniLab 3 (tested)
+- KeyLab mkII (tested)
+- Keylab Essential
+- Keylab Essential 3
+
+### MiniLab 3 features:
+
+#### Encoders
+
+By holding down shift will bring up an overlay menu, where you can see and adjust what the encoders do.
+
+You can use the main encoder to select the current encoding page.
+
+Short pressing the shift will show the actual values.
+
+Holding down the shift will goes back to the normal menu.
+
+This overlay menu is context-aware, it is different if you are in the effect menu, or in a TG menu.
+
+If you are in a TG menu, it only affects the selected TG.
+
+If you are in the main menu, it affects the TGs on the first TG's channel.
+
+- Main Overlay 1 (default)
+  - Cutoff, Resonance, FX1Send, FX2Send
+  - PortamentoTime, Program, Volume, MasterVolume
+  - Faders: ChG 1 Vol, ChG 2 Vol, ChG 3 Vol, ChG 4 Vol
+
+- Effect Overlay 1
+  - MasterEQLow, MasterEQMid, MasterEQHigh, MasterEQGain
+  - MasterEQLowMidFreq, MasterEQMidHighFreq, None, None
+  - Faders: MasterEQLow, MasterEQMid, MasterEQHigh, MasterEQGain
+
+- Effect Overlay 2
+  - MasterCREnable, MasterCRPreGain, MasterCRAttack, MasterCRRelease
+  - MasterCRThresh, MasterCRRatio, MasterCRHPFilter, None
+  - Faders: MasterCRPreGain, MasterCRAttack, MasterCRRelease, MasterCRThresh
+
+- Main Overlay 2
+  - Pan1, Pan2, Pan3, Pan4
+  - Det1, Det2, Det3, Det4
+  - Faders: TG1 Vol, TG2 Vol, TG3 Vol, TG4 Vol
+
+- Main Overlay 3
+  - Pan5, Pan6, Pan7, Pan8
+  - Det5, Det6, Det7, Det8
+  - Faders: TG5 Vol, TG6 Vol, TG7 Vol, TG8 Vol
+
+- TG Overlay 1
+  - Cutoff, Resonance, FX1Send, FX2Send
+  - MasterTune, PortamentoTime, Volume, Pan
+  - Faders: Cutoff, FX1Send, FX2Send, Volume
+
+- TG Overlay 2
+  - MIDIChannel, Program, None, PitchBendRange
+  - PortamentoGlissando, MonoMode, None, PitchBendStep
+
+- TG Overlay 3
+  - TGEQLow, TGEQMid, TGEQHigh, TGEQGain
+  - TGEQLowMidFreq, TGEQMidHighFreq, None, None
+  - Faders: TGEQLow, TGEQMid, TGEQHigh, TGEQGain
+
+- TG Overlay 4
+  - CompressorEnable, CompressorPreGain, CompressorMakeupGain, None
+  - CompressorAttack, CompressorRelease, CompressorThresh, CompressorRatio
+  - Faders: CompressorPreGain, CompressorAttack, CompressorRelease, CompressorThresh
+
+- TG Overlay 5
+  - MWRange, MWPitch, FCRange, FCPitch
+  - MWEGBias, MWAmplitude, FCEGBias, FCAmplitude
+
+- TG Overlay 6
+  - BCRange, BCPitch, ATRange, ATPitch
+  - BCEGBias, BCAmplitude, ATEGBias, ATAmplitude
+
+- Voice Overlay 1
+  - ALGORITHM, FEEDBACK, TRANSPOSE, None,
+  - None, None, None, None
+
+- Voice Overlay 2
+  - PITCH_EG_R1, PITCH_EG_R2, PITCH_EG_R3, PITCH_EG_R4
+  - PITCH_EG_L1, PITCH_EG_L2, PITCH_EG_L3, PITCH_EG_L4
+  - Faders: PITCH_EG_L1, PITCH_EG_L2, PITCH_EG_L3, PITCH_EG_L4
+
+- Voice Overlay 3
+  - OSC_KEY_SYNC, LFO_SPEED, LFO_DELAY, LFO_PITCH_MOD_DEP
+  - LFO_SYNC, LFO_WAVE, LFO_PITCH_MOD_SENS, LFO_AMP_MOD_DEP
+
+- OP Overlay 1
+  - OP_OUTPUT_LEV, OP_FREQ_COARSE, OP_FREQ_FINE, OP_OSC_DETUNE,
+  - OP_OSC_MODE, OP_ENABLE, None, None
+
+- OP Overlay 2
+  - OP_EG_R1, OP_EG_R2, P_EG_R3, OP_EG_R4
+  - OP_EG_L1, OP_EG_L2, OP_EG_L3, OP_EG_L4,
+  - Faders: OP_EG_L1, OP_EG_L2, OP_EG_L3, OP_EG_L4,
+
+- OP Overlay 3
+  - OP_LEV_SCL_BRK_PT, OP_SCL_LEFT_DEPTH, OP_SCL_RGHT_DEPTH, OP_AMP_MOD_SENS
+  - OP_OSC_RATE_SCALE, OP_SCL_LEFT_CURVE, OP_SCL_RGHT_CURVE, OP_KEY_VEL_SENS
+
+In the Main overlay you can reach the TG and voice overlays also.
+
+In the voice overlay there is a page for every OP control also, with the 6 operator and with an encoder which sets all.
+
+#### Pads on Bank A
+- Mono/Poly mode
+- Portamento enable/disable, hard press to enable/disable Portamento Glissando
+- Sostenuto
+- Sustain
+- All Sound Off
+- Hold2
+- None
+- Channel AfterTouch Pad
+
+#### Pads on Bank B
+- Short press a TG will enable/disable that TG
+- Long press will enable/disable all the TG on the TG's channel
+- Hard press will enable only that TG (it uses the pad's AT messsages)
+
+
+### KeyLab mkII features
+
+#### Faders
+- The faders 1-8 adjust the volume of the MIDI channels of the current performance
+- The fader 9 adjusts the master volume.
+
+#### Encoders
+- Cutoff, Resonance, Portamento Time
+- None, None, Dry Level, FX1 Send, FX2 Send, None
+
+#### DAW buttons
+- Mono/Poly mode
+- Portamento enable/disable, hard press to enable/disable Portamento Glissando
+- Sostenuto
+- Sustain
+- Hold2
+
+#### Track select buttons
+- Short press a TG will enable/disable that TG
+- Long press will enable only that TG
+
+
+
 ![minidexed](https://user-images.githubusercontent.com/2480569/161813414-bb156a1c-efec-44c0-802a-8926412a08e0.jpg)
 
 DreamDexed is a FM synthesizer closely modeled on the famous DX7 by a well-known Japanese manufacturer running on a bare metal Raspberry Pi (without a Linux kernel or operating system). On Raspberry Pi 2 and larger, it can run 8 tone generators, not unlike the TX816/TX802 (8 DX7 instances without the keyboard in one box). [Featured by HACKADAY](https://hackaday.com/2022/04/19/bare-metal-gives-this-pi-some-classic-synths/), [Adafruit](https://blog.adafruit.com/2022/04/25/free-yamaha-dx7-synth-emulator-on-a-raspberry-pi/), [The MagPi magazine](https://magpi.raspberrypi.com/articles/mini-dexed) (Issue 142 June 2024, [PDF](https://magpi.raspberrypi.com/issues/142)) and [Synth Geekery](https://www.youtube.com/watch?v=TDSy5nnm0jA).

src/Makefile

@@ -12,7 +12,8 @@ OBJS = main.o kernel.o minidexed.o config.o userinterface.o uimenu.o \
        effect.o effect_cloudseed2.o effect_platervbstereo.o effect_dreamdelay.o uibuttons.o midipin.o \
        ../CloudSeedCore/DSP/Biquad.o ../CloudSeedCore/DSP/RandomBuffer.o ../CloudSeedCore/DSP/FastSin.o \
        arm_float_to_q23.o arm_zip_f32.o arm_scale_zip_f32.o \
-       net/ftpdaemon.o net/ftpworker.o net/applemidi.o net/udpmidi.o net/mdnspublisher.o udpmididevice.o
+       net/ftpdaemon.o net/ftpworker.o net/applemidi.o net/udpmidi.o net/mdnspublisher.o udpmididevice.o \
+       dawcontroller.o
 
 EXTRACLEAN = $(OBJS) $(OBJS:.o=.d)
 

src/common.h

@@ -2,6 +2,8 @@
 #ifndef _common_h
 #define _common_h
 
+#define ARRAY_LENGTH(x) (sizeof(x) / sizeof((x)[0]))
+
 inline long maplong(long x, long in_min, long in_max, long out_min, long out_max) {
   return (x - in_min) * (out_max - out_min) / (in_max - in_min) + out_min;
 }
@@ -16,6 +18,12 @@ inline float32_t mapfloat(int val, int in_min, int in_max, float32_t out_min, fl
   return (val - in_min) * (out_max - out_min) / (in_max - in_min) + out_min;
 }
 
+inline long mapfloatr(int val, int in_min, int in_max, float32_t out_min, float32_t out_max)
+{
+  return lround((val - in_min) * (out_max - out_min) / (in_max - in_min) + out_min);
+}
+
+
 #define constrain(amt, low, high) ({ \
   __typeof__(amt) _amt = (amt); \
   __typeof__(low) _low = (low); \

src/config.cpp

@@ -206,7 +206,9 @@ void CConfig::Load (void)
 	m_MIDIButtonActionBankDown = m_Properties.GetString ("MIDIButtonActionBankDown", "");
 	m_MIDIButtonActionTGUp = m_Properties.GetString ("MIDIButtonActionTGUp", "");
 	m_MIDIButtonActionTGDown = m_Properties.GetString ("MIDIButtonActionTGDown", "");
-	
+
+	m_bDAWControllerEnabled = m_Properties.GetNumber ("DAWControllerEnabled", 0) != 0;
+
 	m_bEncoderEnabled = m_Properties.GetNumber ("EncoderEnabled", 0) != 0;
 	m_nEncoderPinClock = m_Properties.GetNumber ("EncoderPinClock", 10);
 	m_nEncoderPinData = m_Properties.GetNumber ("EncoderPinData", 9);
@@ -782,6 +784,11 @@ const char *CConfig::GetMIDIButtonActionTGDown (void) const
 	return m_MIDIButtonActionTGDown.c_str();
 }
 
+bool CConfig::GetDAWControllerEnabled (void) const
+{
+	return m_bDAWControllerEnabled;
+}
+
 bool CConfig::GetEncoderEnabled (void) const
 {
 	return m_bEncoderEnabled;

src/config.h

@@ -251,6 +251,8 @@ class CConfig		// Configuration for MiniDexed
 	const char *GetMIDIButtonActionTGUp (void) const;
 	const char *GetMIDIButtonActionTGDown (void) const;
 
+	bool GetDAWControllerEnabled (void) const;
+
 	// KY-040 Rotary Encoder
 	// GPIO pin numbers are chip numbers, not header positions
 	bool GetEncoderEnabled (void) const;
@@ -402,6 +404,8 @@ class CConfig		// Configuration for MiniDexed
 	unsigned m_nMIDIButtonTGUp;
 	unsigned m_nMIDIButtonTGDown;
 
+	bool m_bDAWControllerEnabled;
+
 	bool m_bEncoderEnabled;
 	unsigned m_nEncoderPinClock;
 	unsigned m_nEncoderPinData;