From dbd8089fb8ba65ffff60dda497cb271e074e35f6 Mon Sep 17 00:00:00 2001
From: Robin Gareus <robin@gareus.org>
Date: Tue, 30 Nov 2021 18:36:00 +0100
Subject: [PATCH] Sort concurrent MIDI events on port-level #8828

See also 8dbbc195676 as well as
Evoral::Sequence<Time>::const_iterator::choose_next
ARDOUR::MidiBuffer::second_simultaneous_midi_byte_is_first
---
 libs/ardour/ardour/port_engine_shared.h | 10 ++++
 libs/ardour/port_engine_shared.cc       | 78 +++++++++++++++++++++++++
 2 files changed, 88 insertions(+)

diff --git a/libs/ardour/ardour/port_engine_shared.h b/libs/ardour/ardour/port_engine_shared.h
index 6dbd012961..9dd0004d59 100644
--- a/libs/ardour/ardour/port_engine_shared.h
+++ b/libs/ardour/ardour/port_engine_shared.h
@@ -121,6 +121,16 @@ private:
 
 }; // class BackendPort
 
+class LIBARDOUR_API BackendMIDIEvent
+{
+public:
+	virtual ~BackendMIDIEvent () {}
+	virtual size_t size () const = 0;
+	virtual pframes_t timestamp () const = 0;
+	virtual const uint8_t* data () const = 0;
+	bool operator< (const BackendMIDIEvent &other) const;
+};
+
 class LIBARDOUR_API PortEngineSharedImpl
 {
 public:
diff --git a/libs/ardour/port_engine_shared.cc b/libs/ardour/port_engine_shared.cc
index 5aae77f2a4..a9c2accaf1 100644
--- a/libs/ardour/port_engine_shared.cc
+++ b/libs/ardour/port_engine_shared.cc
@@ -186,7 +186,85 @@ BackendPort::update_connected_latency (bool for_playback)
 	set_latency_range (lr, for_playback);
 }
 
+bool
+BackendMIDIEvent::operator< (const BackendMIDIEvent &other) const {
+	if (timestamp() == other.timestamp ()) {
+		/* concurrent MIDI events, sort
+		 * - CC first (may include bank/patch)
+		 * - Program Change
+		 * - Note Off
+		 * - Note On
+		 * - Note Pressure
+		 * - Channel Pressure
+		 * - Pitch Bend
+		 * - SysEx/RT, etc
+		 *
+		 * see Evoral::Sequence<Time>::const_iterator::choose_next
+		 * and MidiBuffer::second_simultaneous_midi_byte_is_first
+		 */
+		uint8_t ta = 9;
+		uint8_t tb = 9;
+		if (size () > 0 && size () < 4) {
+			switch (data ()[0] & 0xf0) {
+				case 0xB0: /* Control Change */
+					ta = 1;
+					break;
+				case 0xC0: /* Program Change */
+					ta = 2;
+					break;
+				case 0x80: /* Note Off */
+					ta = 3;
+					break;
+				case 0x90: /* Note On */
+					ta = 4;
+					break;
+				case 0xA0: /* Key Pressure */
+					ta = 5;
+					break;
+				case 0xD0: /* Channel Pressure */
+					ta = 6;
+					break;
+				case 0xE0: /* Pitch Bend */
+					ta = 7;
+					break;
+				default:
+					ta = 8;
+					break;
+			}
+		}
 
+		if (other.size () > 0 && other.size () < 4) {
+			switch (other.data ()[0] & 0xf0) {
+				case 0xB0: /* Control Change */
+					tb = 1;
+					break;
+				case 0xC0: /* Program Change */
+					tb = 2;
+					break;
+				case 0x80: /* Note Off */
+					tb = 3;
+					break;
+				case 0x90: /* Note On */
+					tb = 4;
+					break;
+				case 0xA0: /* Key Pressure */
+					tb = 5;
+					break;
+				case 0xD0: /* Channel Pressure */
+					tb = 6;
+					break;
+				case 0xE0: /* Pitch Bend */
+					tb = 7;
+					break;
+				default:
+					tb = 8;
+					break;
+			}
+		}
+		return ta < tb;
+	}
+	return timestamp () < other.timestamp ();
+};
 
 PortEngineSharedImpl::PortEngineSharedImpl (PortManager& mgr, std::string const & str)
 	: _instance_name (str)