DJMFix.cpp
author František Kučera <franta-hg@frantovo.cz>
Mon, 04 Jan 2021 17:11:57 +0100
branchv_0
changeset 13 334b727f7516
parent 12 15d87fdd6e6c
permissions -rw-r--r--
improved logging and error messages
franta-hg@0
     1
/**
franta-hg@0
     2
 * DJM-Fix
franta-hg@0
     3
 * Copyright © 2020 František Kučera (Frantovo.cz, GlobalCode.info)
franta-hg@0
     4
 *
franta-hg@0
     5
 * This program is free software: you can redistribute it and/or modify
franta-hg@0
     6
 * it under the terms of the GNU General Public License as published by
franta-hg@0
     7
 * the Free Software Foundation, version 3 of the License.
franta-hg@0
     8
 *
franta-hg@0
     9
 * This program is distributed in the hope that it will be useful,
franta-hg@0
    10
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
franta-hg@0
    11
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
franta-hg@0
    12
 * GNU General Public License for more details.
franta-hg@0
    13
 *
franta-hg@0
    14
 * You should have received a copy of the GNU General Public License
franta-hg@0
    15
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
franta-hg@0
    16
 */
franta-hg@1
    17
#include <iostream>
franta-hg@12
    18
#include <sstream>
franta-hg@5
    19
#include <iomanip>
franta-hg@2
    20
#include <thread>
franta-hg@6
    21
#include <mutex>
franta-hg@5
    22
#include <atomic>
franta-hg@2
    23
#include <chrono>
franta-hg@2
    24
#include <stdexcept>
franta-hg@6
    25
#include <vector>
franta-hg@1
    26
franta-hg@1
    27
#include "DJMFix.h"
franta-hg@1
    28
franta-hg@1
    29
namespace djmfix {
franta-hg@1
    30
franta-hg@12
    31
using L = djmfix::logging::Level;
franta-hg@6
    32
using Bytes = std::vector<uint8_t>;
franta-hg@6
    33
franta-hg@1
    34
class DJMFixImpl : public DJMFix {
franta-hg@1
    35
private:
franta-hg@2
    36
	MidiSender* midiSender;
franta-hg@12
    37
	djmfix::logging::Logger* logger;
franta-hg@13
    38
	const int keepAliveInterval = 200;
franta-hg@13
    39
	int keepAliveCounter = 0;
franta-hg@2
    40
	std::thread keepAliveThread;
franta-hg@6
    41
	std::recursive_mutex midiMutex;
franta-hg@5
    42
	std::atomic<bool> running{false};
franta-hg@5
    43
	std::atomic<bool> stopped{false};
franta-hg@8
    44
	std::atomic<bool> sendKeepAlive{false};
franta-hg@8
    45
	Bytes seed2;
franta-hg@2
    46
franta-hg@2
    47
	void run() {
franta-hg@2
    48
		while (!stopped) {
franta-hg@12
    49
			logger->log(L::FINE, "DJMFixImpl::run()");
franta-hg@8
    50
			if (sendKeepAlive) send({0xf0, 0x00, 0x40, 0x05, 0x00, 0x00, 0x00, 0x17, 0x00, 0x50, 0x01, 0xf7});
franta-hg@13
    51
			std::this_thread::sleep_for(std::chrono::milliseconds(keepAliveInterval));
franta-hg@13
    52
			keepAliveCounter++;
franta-hg@13
    53
			if (keepAliveCounter % (60 * 1000 / keepAliveInterval) == 0) logger->log(L::INFO, "Still sending periodic keep-alive messages (each " + std::to_string(keepAliveInterval) + " ms).");
franta-hg@2
    54
		}
franta-hg@2
    55
	}
franta-hg@2
    56
franta-hg@6
    57
	void send(const MidiMessage& midiMessage) {
franta-hg@6
    58
		std::lock_guard<std::recursive_mutex> lock(midiMutex);
franta-hg@6
    59
		midiSender->send(midiMessage);
franta-hg@6
    60
	}
franta-hg@6
    61
franta-hg@6
    62
	std::string toString(const Bytes& midiMessage) {
franta-hg@5
    63
		std::stringstream result;
franta-hg@5
    64
		for (uint8_t b : midiMessage) result << std::hex << std::setw(2) << std::setfill('0') << (int) b;
franta-hg@5
    65
		return result.str();
franta-hg@5
    66
	}
franta-hg@5
    67
franta-hg@6
    68
	Bytes normalize(const Bytes& data) {
franta-hg@13
    69
		if (data.size() % 2) throw std::invalid_argument("Data before normalization must have even number of bytes.");
franta-hg@6
    70
		Bytes result;
franta-hg@6
    71
		result.reserve(data.size() / 2);
franta-hg@6
    72
		for (size_t i = 0; i < data.size() / 2; i++) result.push_back((data[i * 2] & 0x0F) << 4 | (data[i * 2 + 1] & 0x0F));
franta-hg@6
    73
		return result;
franta-hg@6
    74
	}
franta-hg@6
    75
franta-hg@8
    76
	Bytes denormalize(const Bytes& data) {
franta-hg@8
    77
		Bytes result;
franta-hg@8
    78
		result.reserve(data.size()*2);
franta-hg@8
    79
		for (size_t i = 0; i < data.size(); i++) {
franta-hg@8
    80
			result.push_back(data[i] >> 4);
franta-hg@8
    81
			result.push_back(data[i] & 0x0F);
franta-hg@8
    82
		}
franta-hg@8
    83
		return result;
franta-hg@8
    84
	}
franta-hg@8
    85
franta-hg@6
    86
	uint32_t fnv32hash(const Bytes& buff) {
franta-hg@6
    87
		uint32_t hash = 0x811c9dc5;
franta-hg@6
    88
		for (uint8_t b : buff) hash = ((b^hash) * 0x1000193);
franta-hg@6
    89
		return hash;
franta-hg@6
    90
	}
franta-hg@6
    91
franta-hg@6
    92
	Bytes toBytes(const uint32_t value) {
franta-hg@6
    93
		Bytes result;
franta-hg@6
    94
		result.reserve(4);
franta-hg@6
    95
		result.push_back(value >> 24);
franta-hg@6
    96
		result.push_back(value >> 16);
franta-hg@6
    97
		result.push_back(value >> 8);
franta-hg@6
    98
		result.push_back(value >> 0);
franta-hg@6
    99
		return result;
franta-hg@6
   100
	}
franta-hg@6
   101
franta-hg@6
   102
	bool equals(Bytes a, Bytes b) {
franta-hg@6
   103
		if (a.size() != b.size()) return false;
franta-hg@6
   104
		for (size_t i = 0; i < a.size(); i++) if (a[i] != b[i]) return false;
franta-hg@6
   105
		return true;
franta-hg@6
   106
	}
franta-hg@6
   107
franta-hg@6
   108
	template<typename T> std::vector<T> concat(const std::vector<T>& a, const std::vector<T>& b, const std::vector<T>& c = {}) {
franta-hg@6
   109
		std::vector<T> result;
franta-hg@6
   110
		result.reserve(a.size() + b.size() + c.size());
franta-hg@6
   111
		for (size_t i = 0; i < a.size(); i++) result.push_back(a[i]);
franta-hg@6
   112
		for (size_t i = 0; i < b.size(); i++) result.push_back(b[i]);
franta-hg@6
   113
		for (size_t i = 0; i < c.size(); i++) result.push_back(c[i]);
franta-hg@6
   114
		return result;
franta-hg@6
   115
	}
franta-hg@6
   116
franta-hg@6
   117
	template<typename T> std::vector<T> xOR(const std::vector<T>& a, const std::vector<T>& b) {
franta-hg@13
   118
		if (a.size() != b.size()) throw std::invalid_argument("Both must be the same length when doing XOR.");
franta-hg@6
   119
		std::vector<T> result;
franta-hg@6
   120
		result.reserve(a.size());
franta-hg@6
   121
		for (size_t i = 0; i < a.size(); i++) result.push_back(a[i] ^ b[i]);
franta-hg@6
   122
		return result;
franta-hg@6
   123
	}
franta-hg@6
   124
franta-hg@1
   125
public:
franta-hg@1
   126
franta-hg@12
   127
	DJMFixImpl(djmfix::logging::Logger* logger) : logger(logger ? logger : djmfix::logging::blackhole()) {
franta-hg@12
   128
	}
franta-hg@12
   129
franta-hg@1
   130
	virtual ~DJMFixImpl() override {
franta-hg@13
   131
		logger->log(L::FINER, "~DJMFixImpl()");
franta-hg@2
   132
		if (running) stop();
franta-hg@2
   133
	}
franta-hg@2
   134
franta-hg@2
   135
	void setMidiSender(MidiSender* midiSender) {
franta-hg@13
   136
		logger->log(L::FINER, "DJMFixImpl::setMidiSender()");
franta-hg@2
   137
		this->midiSender = midiSender;
franta-hg@1
   138
	}
franta-hg@1
   139
franta-hg@6
   140
	virtual void receive(const MidiMessage& midiMessage) override {
franta-hg@13
   141
		logger->log(L::FINE, "Received a message: size = " + std::to_string(midiMessage.size()) + " data = " + toString(midiMessage));
franta-hg@6
   142
		std::lock_guard<std::recursive_mutex> lock(midiMutex);
franta-hg@5
   143
franta-hg@7
   144
franta-hg@7
   145
		if (midiMessage.size() == 12 && midiMessage[9] == 0x11) {
franta-hg@13
   146
			logger->log(L::INFO, "Received greeting message.");
franta-hg@7
   147
			send({0xf0, 0x00, 0x40, 0x05, 0x00, 0x00, 0x00, 0x17, 0x00, 0x12, 0x2a, 0x01, 0x0b, 0x50, 0x69, 0x6f, 0x6e, 0x65, 0x65, 0x72, 0x44, 0x4a, 0x02, 0x0b, 0x72, 0x65, 0x6b, 0x6f, 0x72, 0x64, 0x62, 0x6f, 0x78, 0x03, 0x12, 0x02, 0x09, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02, 0x03, 0x04, 0x08, 0x00, 0x00, 0x00, 0x00, 0xf7});
franta-hg@13
   148
			logger->log(L::INFO, "Sent message with seed1.");
franta-hg@7
   149
		} else if (midiMessage.size() == 54 && midiMessage[9] == 0x13 && midiMessage[33] == 0x04 && midiMessage[43] == 0x03) {
franta-hg@6
   150
			Bytes hash1(midiMessage.begin() + 35, midiMessage.begin() + 35 + 8);
franta-hg@8
   151
			seed2 = Bytes(midiMessage.begin() + 45, midiMessage.begin() + 45 + 8);
franta-hg@6
   152
			hash1 = normalize(hash1);
franta-hg@6
   153
			seed2 = normalize(seed2);
franta-hg@13
   154
			logger->log(L::INFO, "Received message with hash1 = " + toString(hash1) + " and seed2 = " + toString(seed2));
franta-hg@6
   155
franta-hg@6
   156
			Bytes seed0 = {0x68, 0x01, 0x31, 0xFB};
franta-hg@6
   157
			Bytes seed1 = {0x29, 0x00, 0x00, 0x00, 0x23, 0x48, 0x00, 0x00};
franta-hg@6
   158
franta-hg@6
   159
			Bytes hash1check = toBytes(fnv32hash(concat(seed1, xOR(seed0, seed2))));
franta-hg@6
   160
franta-hg@6
   161
			if (equals(hash1, hash1check)) {
franta-hg@13
   162
				logger->log(L::INFO, "Verification of hash1 was successful.");
franta-hg@8
   163
				Bytes hash2 = toBytes(fnv32hash(concat(seed2, xOR(seed0, seed2))));
franta-hg@8
   164
				send(concat({0xf0, 0x00, 0x40, 0x05, 0x00, 0x00, 0x00, 0x17, 0x00, 0x14, 0x38, 0x01, 0x0b, 0x50, 0x69, 0x6f, 0x6e, 0x65, 0x65, 0x72, 0x44, 0x4a, 0x02, 0x0b, 0x72, 0x65, 0x6b, 0x6f, 0x72, 0x64, 0x62, 0x6f, 0x78, 0x04, 0x0a}, concat(denormalize(hash2),{0x05, 0x16, 0x05, 0x09, 0x0b, 0x05, 0x04, 0x0b, 0x0f, 0x0e, 0x0e, 0x04, 0x04, 0x0a, 0x05, 0x0a, 0x0c, 0x08, 0x0e, 0x04, 0x0c, 0x05, 0xf7})));
franta-hg@13
   165
				logger->log(L::INFO, "Sent message with hash2.");
franta-hg@6
   166
			} else {
franta-hg@12
   167
				std::stringstream logMessage;
franta-hg@12
   168
				logMessage
franta-hg@13
   169
						<< "Verification of hash1 failed: "
franta-hg@8
   170
						<< " midiMessage = " << toString(midiMessage)
franta-hg@8
   171
						<< " seed0 = " << toString(seed0)
franta-hg@8
   172
						<< " seed1 = " << toString(seed1)
franta-hg@8
   173
						<< " seed2 = " << toString(seed2)
franta-hg@8
   174
						<< " hash1 = " << toString(hash1)
franta-hg@12
   175
						<< " hash1check = " << toString(hash1check);
franta-hg@12
   176
				logger->log(L::SEVERE, logMessage.str());
franta-hg@8
   177
				// TODO: graceful death
franta-hg@6
   178
			}
franta-hg@8
   179
		} else if (midiMessage.size() == 12 && midiMessage[9] == 0x15) {
franta-hg@8
   180
			sendKeepAlive = true;
franta-hg@13
   181
			logger->log(L::INFO, "Received acknowledgment message. Started sending keep-alive messages. LINE/PHONO channels should work now.");
franta-hg@5
   182
		}
franta-hg@5
   183
franta-hg@1
   184
	}
franta-hg@1
   185
franta-hg@1
   186
	void start() override {
franta-hg@12
   187
		logger->log(L::FINE, "DJMFixImpl::start()");
franta-hg@13
   188
		if (midiSender == nullptr) throw std::logic_error("Need a midiSender when starting DJMFix");
franta-hg@5
   189
franta-hg@5
   190
		// TODO: methods for parsing and constructing messages from parts (TLV)
franta-hg@6
   191
		send({0xf0, 0x00, 0x40, 0x05, 0x00, 0x00, 0x00, 0x17, 0x00, 0x50, 0x01, 0xf7});
franta-hg@13
   192
		logger->log(L::INFO, "Sent greeting message.");
franta-hg@2
   193
franta-hg@2
   194
		keepAliveThread = std::thread(&DJMFixImpl::run, this);
franta-hg@2
   195
		running = true;
franta-hg@2
   196
franta-hg@1
   197
	}
franta-hg@1
   198
franta-hg@1
   199
	void stop() override {
franta-hg@2
   200
		stopped = true;
franta-hg@2
   201
		keepAliveThread.join();
franta-hg@2
   202
		running = false;
franta-hg@12
   203
		logger->log(L::FINE, "DJMFixImpl::stop()");
franta-hg@1
   204
	}
franta-hg@1
   205
};
franta-hg@1
   206
franta-hg@12
   207
DJMFix* create(djmfix::logging::Logger* logger) {
franta-hg@12
   208
	return new DJMFixImpl(logger);
franta-hg@1
   209
}
franta-hg@1
   210
franta-hg@1
   211
}