]> git.sesse.net Git - nageru/blob - midi_mapping_dialog.cpp
Highlight which controllers have currently active MIDI mappings. Very useful with...
[nageru] / midi_mapping_dialog.cpp
1 #include "midi_mapping_dialog.h"
2
3 #include "midi_mapper.h"
4 #include "midi_mapping.pb.h"
5 #include "post_to_main_thread.h"
6 #include "ui_midi_mapping.h"
7
8 #include <QComboBox>
9 #include <QFileDialog>
10 #include <QMessageBox>
11 #include <QSpinBox>
12
13 #include <algorithm>
14 #include <string>
15
16 using namespace google::protobuf;
17 using namespace std;
18
19 vector<MIDIMappingDialog::Control> per_bus_controllers = {
20         { "Treble",                   MIDIMappingBusProto::kTrebleFieldNumber, MIDIMappingProto::kTrebleBankFieldNumber },
21         { "Mid",                      MIDIMappingBusProto::kMidFieldNumber,    MIDIMappingProto::kMidBankFieldNumber },
22         { "Bass",                     MIDIMappingBusProto::kBassFieldNumber,   MIDIMappingProto::kBassBankFieldNumber },
23         { "Gain",                     MIDIMappingBusProto::kGainFieldNumber,   MIDIMappingProto::kGainBankFieldNumber },
24         { "Compressor threshold",     MIDIMappingBusProto::kCompressorThresholdFieldNumber,
25                                       MIDIMappingProto::kCompressorThresholdBankFieldNumber},
26         { "Fader",                    MIDIMappingBusProto::kFaderFieldNumber,  MIDIMappingProto::kFaderBankFieldNumber }
27 };
28 vector<MIDIMappingDialog::Control> per_bus_buttons = {
29         { "Toggle locut",             MIDIMappingBusProto::kToggleLocutFieldNumber,
30                                       MIDIMappingProto::kToggleLocutBankFieldNumber },
31         { "Togle auto gain staging",  MIDIMappingBusProto::kToggleAutoGainStagingFieldNumber,
32                                       MIDIMappingProto::kToggleAutoGainStagingBankFieldNumber },
33         { "Togle compressor",         MIDIMappingBusProto::kToggleCompressorFieldNumber,
34                                       MIDIMappingProto::kToggleCompressorBankFieldNumber },
35         { "Clear peak",               MIDIMappingBusProto::kClearPeakFieldNumber,
36                                       MIDIMappingProto::kClearPeakBankFieldNumber }
37 };
38 vector<MIDIMappingDialog::Control> global_controllers = {
39         { "Locut cutoff",             MIDIMappingBusProto::kLocutFieldNumber,  MIDIMappingProto::kLocutBankFieldNumber },
40         { "Limiter threshold",        MIDIMappingBusProto::kLimiterThresholdFieldNumber,
41                                       MIDIMappingProto::kLimiterThresholdBankFieldNumber },
42         { "Makeup gain",              MIDIMappingBusProto::kMakeupGainFieldNumber,
43                                       MIDIMappingProto::kMakeupGainBankFieldNumber }
44 };
45 vector<MIDIMappingDialog::Control> global_buttons = {
46         { "Previous bank",            MIDIMappingBusProto::kPrevBankFieldNumber, 0 },
47         { "Next bank",                MIDIMappingBusProto::kNextBankFieldNumber, 0 },
48         { "Select bank 1",            MIDIMappingBusProto::kSelectBank1FieldNumber, 0 },
49         { "Select bank 2",            MIDIMappingBusProto::kSelectBank2FieldNumber, 0 },
50         { "Select bank 3",            MIDIMappingBusProto::kSelectBank3FieldNumber, 0 },
51         { "Select bank 4",            MIDIMappingBusProto::kSelectBank4FieldNumber, 0 },
52         { "Select bank 5",            MIDIMappingBusProto::kSelectBank5FieldNumber, 0 }
53 };
54
55 namespace {
56
57 int get_bank(const MIDIMappingProto &mapping_proto, int bank_field_number, int default_value)
58 {
59         const FieldDescriptor *bank_descriptor = mapping_proto.GetDescriptor()->FindFieldByNumber(bank_field_number);
60         const Reflection *reflection = mapping_proto.GetReflection();
61         if (!reflection->HasField(mapping_proto, bank_descriptor)) {
62                 return default_value;
63         }
64         return reflection->GetInt32(mapping_proto, bank_descriptor);
65 }
66
67 int get_controller_mapping(const MIDIMappingProto &mapping_proto, size_t bus_idx, int field_number, int default_value)
68 {
69         if (bus_idx >= size_t(mapping_proto.bus_mapping_size())) {
70                 return default_value;
71         }
72
73         const MIDIMappingBusProto &bus_mapping = mapping_proto.bus_mapping(bus_idx);
74         const FieldDescriptor *descriptor = bus_mapping.GetDescriptor()->FindFieldByNumber(field_number);
75         const Reflection *bus_reflection = bus_mapping.GetReflection();
76         if (!bus_reflection->HasField(bus_mapping, descriptor)) {
77                 return default_value;
78         }
79         const MIDIControllerProto &controller_proto = 
80                 static_cast<const MIDIControllerProto &>(bus_reflection->GetMessage(bus_mapping, descriptor));
81         return controller_proto.controller_number();
82 }
83
84 int get_button_mapping(const MIDIMappingProto &mapping_proto, size_t bus_idx, int field_number, int default_value)
85 {
86         if (bus_idx >= size_t(mapping_proto.bus_mapping_size())) {
87                 return default_value;
88         }
89
90         const MIDIMappingBusProto &bus_mapping = mapping_proto.bus_mapping(bus_idx);
91         const FieldDescriptor *descriptor = bus_mapping.GetDescriptor()->FindFieldByNumber(field_number);
92         const Reflection *bus_reflection = bus_mapping.GetReflection();
93         if (!bus_reflection->HasField(bus_mapping, descriptor)) {
94                 return default_value;
95         }
96         const MIDIButtonProto &bus_proto = 
97                 static_cast<const MIDIButtonProto &>(bus_reflection->GetMessage(bus_mapping, descriptor));
98         return bus_proto.note_number();
99 }
100
101 }  // namespace
102
103 MIDIMappingDialog::MIDIMappingDialog(MIDIMapper *mapper)
104         : ui(new Ui::MIDIMappingDialog),
105           mapper(mapper)
106 {
107         ui->setupUi(this);
108
109         const MIDIMappingProto mapping_proto = mapper->get_current_mapping();  // Take a copy.
110         old_receiver = mapper->set_receiver(this);
111
112         QStringList labels;
113         labels << "";
114         labels << "Controller bank";
115         for (unsigned bus_idx = 0; bus_idx < num_buses; ++bus_idx) {
116                 char buf[256];
117                 snprintf(buf, sizeof(buf), "Bus %d", bus_idx + 1);
118                 labels << buf;
119         }
120         labels << "";
121         ui->treeWidget->setColumnCount(num_buses + 3);
122         ui->treeWidget->setHeaderLabels(labels);
123
124         add_controls("Per-bus controllers", ControlType::CONTROLLER, SpinnerGroup::PER_BUS_CONTROLLERS, mapping_proto, per_bus_controllers);
125         add_controls("Per-bus buttons", ControlType::BUTTON, SpinnerGroup::PER_BUS_BUTTONS, mapping_proto, per_bus_buttons);
126         add_controls("Global controllers", ControlType::CONTROLLER, SpinnerGroup::GLOBAL_CONTROLLERS, mapping_proto, global_controllers);
127         add_controls("Global buttons", ControlType::BUTTON, SpinnerGroup::GLOBAL_BUTTONS, mapping_proto, global_buttons);
128         fill_controls_from_mapping(mapping_proto);
129
130         // Auto-resize every column but the last.
131         for (unsigned column_idx = 0; column_idx < num_buses + 3; ++column_idx) {
132                 ui->treeWidget->resizeColumnToContents(column_idx);
133         }
134
135         connect(ui->guess_bus_button, &QPushButton::clicked,
136                 bind(&MIDIMappingDialog::guess_clicked, this, false));
137         connect(ui->guess_group_button, &QPushButton::clicked,
138                 bind(&MIDIMappingDialog::guess_clicked, this, true));
139         connect(ui->ok_cancel_buttons, &QDialogButtonBox::accepted, this, &MIDIMappingDialog::ok_clicked);
140         connect(ui->ok_cancel_buttons, &QDialogButtonBox::rejected, this, &MIDIMappingDialog::cancel_clicked);
141         connect(ui->save_button, &QPushButton::clicked, this, &MIDIMappingDialog::save_clicked);
142         connect(ui->load_button, &QPushButton::clicked, this, &MIDIMappingDialog::load_clicked);
143
144         update_guess_button_state();
145 }
146
147 MIDIMappingDialog::~MIDIMappingDialog()
148 {
149         mapper->set_receiver(old_receiver);
150         mapper->refresh_highlights();
151 }
152
153 bool MIDIMappingDialog::eventFilter(QObject *obj, QEvent *event)
154 {
155         if (event->type() == QEvent::FocusIn ||
156             event->type() == QEvent::FocusOut) {
157                 // We ignore the guess buttons themselves; it should be allowed
158                 // to navigate from a spinner to focus on a button (to click it).
159                 if (obj != ui->guess_bus_button && obj != ui->guess_group_button) {
160                         update_guess_button_state();
161                 }
162         }
163         return false;
164 }
165
166 void MIDIMappingDialog::guess_clicked(bool limit_to_group)
167 {
168         FocusInfo focus = find_focus();
169         if (focus.bus_idx == -1) {
170                 // The guess button probably took the focus away from us.
171                 focus = last_focus;
172         }
173         assert(focus.bus_idx != -1);  // The button should have been disabled.
174         pair<int, int> bus_and_offset = guess_offset(focus.bus_idx, limit_to_group ? focus.spinner_group : SpinnerGroup::ALL_GROUPS);
175         const int source_bus_idx = bus_and_offset.first;
176         const int offset = bus_and_offset.second;
177         assert(source_bus_idx != -1);  // The button should have been disabled.
178
179         for (const auto &field_number_and_spinner : spinners[focus.bus_idx]) {
180                 int field_number = field_number_and_spinner.first;
181                 QSpinBox *spinner = field_number_and_spinner.second.spinner;
182                 SpinnerGroup this_spinner_group = field_number_and_spinner.second.group;
183
184                 if (limit_to_group && this_spinner_group != focus.spinner_group) {
185                         continue;
186                 }
187
188                 assert(spinners[source_bus_idx].count(field_number));
189                 QSpinBox *source_spinner = spinners[source_bus_idx][field_number].spinner;
190                 assert(spinners[source_bus_idx][field_number].group == this_spinner_group);
191
192                 if (source_spinner->value() != 0) {
193                         spinner->setValue(source_spinner->value() + offset);
194                 }
195         }
196
197         // See if we can find a “next” bus to move the focus to.
198         const int next_bus_idx = focus.bus_idx + (focus.bus_idx - source_bus_idx);  // Note: Could become e.g. -1.
199         for (const InstantiatedSpinner &is : controller_spinners) {
200                 if (int(is.bus_idx) == next_bus_idx && is.field_number == focus.field_number) {
201                         is.spinner->setFocus();
202                 }
203         }
204         for (const InstantiatedSpinner &is : button_spinners) {
205                 if (int(is.bus_idx) == next_bus_idx && is.field_number == focus.field_number) {
206                         is.spinner->setFocus();
207                 }
208         }
209 }
210
211 void MIDIMappingDialog::ok_clicked()
212 {
213         unique_ptr<MIDIMappingProto> new_mapping = construct_mapping_proto_from_ui();
214         mapper->set_midi_mapping(*new_mapping);
215         mapper->set_receiver(old_receiver);
216         accept();
217 }
218
219 void MIDIMappingDialog::cancel_clicked()
220 {
221         mapper->set_receiver(old_receiver);
222         reject();
223 }
224
225 void MIDIMappingDialog::save_clicked()
226 {
227         unique_ptr<MIDIMappingProto> new_mapping = construct_mapping_proto_from_ui();
228         QString filename = QFileDialog::getSaveFileName(this,
229                 "Save MIDI mapping", QString(), tr("Mapping files (*.midimapping)"));
230         if (!filename.endsWith(".midimapping")) {
231                 filename += ".midimapping";
232         }
233         if (!save_midi_mapping_to_file(*new_mapping, filename.toStdString())) {
234                 QMessageBox box;
235                 box.setText("Could not save mapping to '" + filename + "'. Check that you have the right permissions and try again.");
236                 box.exec();
237         }
238 }
239
240 void MIDIMappingDialog::load_clicked()
241 {
242         QString filename = QFileDialog::getOpenFileName(this,
243                 "Load MIDI mapping", QString(), tr("Mapping files (*.midimapping)"));
244         MIDIMappingProto new_mapping;
245         if (!load_midi_mapping_from_file(filename.toStdString(), &new_mapping)) {
246                 QMessageBox box;
247                 box.setText("Could not load mapping from '" + filename + "'. Check that the file exists, has the right permissions and is valid.");
248                 box.exec();
249                 return;
250         }
251
252         fill_controls_from_mapping(new_mapping);
253 }
254
255 namespace {
256
257 template<class T>
258 T *get_mutable_bus_message(MIDIMappingProto *mapping_proto, unsigned bus_idx, int field_number)
259 {
260         while (size_t(mapping_proto->bus_mapping_size()) <= bus_idx) {
261                 mapping_proto->add_bus_mapping();
262         }
263
264         MIDIMappingBusProto *bus_mapping = mapping_proto->mutable_bus_mapping(bus_idx);
265         const FieldDescriptor *descriptor = bus_mapping->GetDescriptor()->FindFieldByNumber(field_number);
266         const Reflection *bus_reflection = bus_mapping->GetReflection();
267         return static_cast<T *>(bus_reflection->MutableMessage(bus_mapping, descriptor));
268 }
269
270 }  // namespace
271
272 unique_ptr<MIDIMappingProto> MIDIMappingDialog::construct_mapping_proto_from_ui()
273 {
274         unique_ptr<MIDIMappingProto> mapping_proto(new MIDIMappingProto);
275         for (const InstantiatedSpinner &is : controller_spinners) {
276                 const int val = is.spinner->value();
277                 if (val == 0) {
278                         continue;
279                 }
280
281                 MIDIControllerProto *controller_proto =
282                         get_mutable_bus_message<MIDIControllerProto>(mapping_proto.get(), is.bus_idx, is.field_number);
283                 controller_proto->set_controller_number(val);
284         }
285         for (const InstantiatedSpinner &is : button_spinners) {
286                 const int val = is.spinner->value();
287                 if (val == 0) {
288                         continue;
289                 }
290
291                 MIDIButtonProto *button_proto =
292                         get_mutable_bus_message<MIDIButtonProto>(mapping_proto.get(), is.bus_idx, is.field_number);
293                 button_proto->set_note_number(val);
294         }
295         int highest_bank_used = 0;  // 1-indexed.
296         for (const InstantiatedComboBox &ic : bank_combo_boxes) {
297                 const int val = ic.combo_box->currentIndex();
298                 highest_bank_used = std::max(highest_bank_used, val);
299                 if (val == 0) {
300                         continue;
301                 }
302
303                 const FieldDescriptor *descriptor = mapping_proto->GetDescriptor()->FindFieldByNumber(ic.field_number);
304                 const Reflection *bus_reflection = mapping_proto->GetReflection();
305                 bus_reflection->SetInt32(mapping_proto.get(), descriptor, val - 1);
306         }
307         mapping_proto->set_num_controller_banks(highest_bank_used);
308         return mapping_proto;
309 }
310
311 void MIDIMappingDialog::add_bank_selector(QTreeWidgetItem *item, const MIDIMappingProto &mapping_proto, int bank_field_number)
312 {
313         if (bank_field_number == 0) {
314                 return;
315         }
316         QComboBox *bank_selector = new QComboBox(this);
317         bank_selector->addItems(QStringList() << "" << "Bank 1" << "Bank 2" << "Bank 3" << "Bank 4" << "Bank 5");
318         bank_selector->setAutoFillBackground(true);
319
320         bank_combo_boxes.push_back(InstantiatedComboBox{ bank_selector, bank_field_number });
321
322         ui->treeWidget->setItemWidget(item, 1, bank_selector);
323 }
324
325 void MIDIMappingDialog::add_controls(const string &heading,
326                                      MIDIMappingDialog::ControlType control_type,
327                                      MIDIMappingDialog::SpinnerGroup spinner_group,
328                                      const MIDIMappingProto &mapping_proto,
329                                      const vector<MIDIMappingDialog::Control> &controls)
330 {
331         QTreeWidgetItem *heading_item = new QTreeWidgetItem(ui->treeWidget);
332         heading_item->setText(0, QString::fromStdString(heading));
333         heading_item->setFirstColumnSpanned(true);
334         heading_item->setExpanded(true);
335         for (const Control &control : controls) {
336                 QTreeWidgetItem *item = new QTreeWidgetItem(heading_item);
337                 heading_item->addChild(item);
338                 add_bank_selector(item, mapping_proto, control.bank_field_number);
339                 item->setText(0, QString::fromStdString(control.label + "   "));
340
341                 for (unsigned bus_idx = 0; bus_idx < num_buses; ++bus_idx) {
342                         QSpinBox *spinner = new QSpinBox(this);
343                         spinner->setRange(0, 127);
344                         spinner->setAutoFillBackground(true);
345                         spinner->setSpecialValueText("\u200d");  // Zero-width joiner (ie., empty).
346                         spinner->installEventFilter(this);  // So we know when the focus changes.
347                         ui->treeWidget->setItemWidget(item, bus_idx + 2, spinner);
348
349                         if (control_type == ControlType::CONTROLLER) {
350                                 controller_spinners.push_back(InstantiatedSpinner{ spinner, bus_idx, spinner_group, control.field_number });
351                         } else {
352                                 assert(control_type == ControlType::BUTTON);
353                                 button_spinners.push_back(InstantiatedSpinner{ spinner, bus_idx, spinner_group, control.field_number });
354                         }
355                         spinners[bus_idx][control.field_number] = SpinnerAndGroup{ spinner, spinner_group };
356                         connect(spinner, static_cast<void(QSpinBox::*)(int)>(&QSpinBox::valueChanged),
357                                 bind(&MIDIMappingDialog::update_guess_button_state, this));
358                 }
359         }
360         ui->treeWidget->addTopLevelItem(heading_item);
361 }
362
363 void MIDIMappingDialog::fill_controls_from_mapping(const MIDIMappingProto &mapping_proto)
364 {
365         for (const InstantiatedSpinner &is : controller_spinners) {
366                 is.spinner->setValue(get_controller_mapping(mapping_proto, is.bus_idx, is.field_number, 0));
367         }
368         for (const InstantiatedSpinner &is : button_spinners) {
369                 is.spinner->setValue(get_button_mapping(mapping_proto, is.bus_idx, is.field_number, 0));
370         }
371         for (const InstantiatedComboBox &ic : bank_combo_boxes) {
372                 ic.combo_box->setCurrentIndex(get_bank(mapping_proto, ic.field_number, -1) + 1);
373         }
374 }
375
376 void MIDIMappingDialog::controller_changed(unsigned controller)
377 {
378         for (const InstantiatedSpinner &is : controller_spinners) {
379                 if (is.spinner->hasFocus()) {
380                         is.spinner->setValue(controller);
381                         is.spinner->selectAll();
382                 }
383         }
384 }
385
386 void MIDIMappingDialog::note_on(unsigned note)
387 {
388         for (const InstantiatedSpinner &is : button_spinners) {
389                 if (is.spinner->hasFocus()) {
390                         is.spinner->setValue(note);
391                         is.spinner->selectAll();
392                 }
393         }
394 }
395
396 pair<int, int> MIDIMappingDialog::guess_offset(unsigned bus_idx, MIDIMappingDialog::SpinnerGroup spinner_group)
397 {
398         constexpr pair<int, int> not_found(-1, 0);
399
400         if (bus_is_empty(bus_idx, spinner_group)) {
401                 return not_found;
402         }
403
404         // See if we can find a non-empty bus to source from (prefer from the left).
405         unsigned source_bus_idx;
406         if (bus_idx > 0 && !bus_is_empty(bus_idx - 1, spinner_group)) {
407                 source_bus_idx = bus_idx - 1;
408         } else if (bus_idx < num_buses - 1 && !bus_is_empty(bus_idx + 1, spinner_group)) {
409                 source_bus_idx = bus_idx + 1;
410         } else {
411                 return not_found;
412         }
413
414         // See if we can find a consistent offset.
415         bool found_offset = false;
416         int offset = 0;
417         int minimum_allowed_offset = numeric_limits<int>::min();
418         int maximum_allowed_offset = numeric_limits<int>::max();
419         for (const auto &field_number_and_spinner : spinners[bus_idx]) {
420                 int field_number = field_number_and_spinner.first;
421                 QSpinBox *spinner = field_number_and_spinner.second.spinner;
422                 SpinnerGroup this_spinner_group = field_number_and_spinner.second.group;
423                 assert(spinners[source_bus_idx].count(field_number));
424                 QSpinBox *source_spinner = spinners[source_bus_idx][field_number].spinner;
425                 assert(spinners[source_bus_idx][field_number].group == this_spinner_group);
426
427                 if (spinner_group != SpinnerGroup::ALL_GROUPS &&
428                     spinner_group != this_spinner_group) {
429                         continue;
430                 }
431                 if (spinner->value() == 0) {
432                         if (source_spinner->value() != 0) {
433                                 // If the source value is e.g. 3, offset can't be less than -2 or larger than 124.
434                                 // Otherwise, we'd extrapolate values outside [1..127].
435                                 minimum_allowed_offset = max(minimum_allowed_offset, 1 - source_spinner->value());
436                                 maximum_allowed_offset = min(maximum_allowed_offset, 127 - source_spinner->value());
437                         }
438                         continue;
439                 }
440                 if (source_spinner->value() == 0) {
441                         // The bus has a controller set that the source bus doesn't set.
442                         return not_found;
443                 }
444
445                 int candidate_offset = spinner->value() - source_spinner->value();
446                 if (!found_offset) {
447                         offset = candidate_offset;
448                         found_offset = true;
449                 } else if (candidate_offset != offset) {
450                         return not_found;
451                 }
452         }
453
454         if (!found_offset) {
455                 // Given that the bus wasn't empty, this shouldn't happen.
456                 assert(false);
457                 return not_found;
458         }
459
460         if (offset < minimum_allowed_offset || offset > maximum_allowed_offset) {
461                 return not_found;
462         }
463         return make_pair(source_bus_idx, offset);
464 }
465
466 bool MIDIMappingDialog::bus_is_empty(unsigned bus_idx, SpinnerGroup spinner_group)
467 {
468         for (const auto &field_number_and_spinner : spinners[bus_idx]) {
469                 QSpinBox *spinner = field_number_and_spinner.second.spinner;
470                 SpinnerGroup this_spinner_group = field_number_and_spinner.second.group;
471                 if (spinner_group != SpinnerGroup::ALL_GROUPS &&
472                     spinner_group != this_spinner_group) {
473                         continue;
474                 }
475                 if (spinner->value() != 0) {
476                         return false;
477                 }
478         }
479         return true;
480 }
481
482 void MIDIMappingDialog::update_guess_button_state()
483 {
484         FocusInfo focus = find_focus();
485         if (focus.bus_idx < 0) {
486                 return;
487         }
488         {
489                 pair<int, int> bus_and_offset = guess_offset(focus.bus_idx, SpinnerGroup::ALL_GROUPS);
490                 ui->guess_bus_button->setEnabled(bus_and_offset.first != -1);
491         }
492         {
493                 pair<int, int> bus_and_offset = guess_offset(focus.bus_idx, focus.spinner_group);
494                 ui->guess_group_button->setEnabled(bus_and_offset.first != -1);
495         }
496         last_focus = focus;
497 }
498
499 MIDIMappingDialog::FocusInfo MIDIMappingDialog::find_focus() const
500 {
501         for (const InstantiatedSpinner &is : controller_spinners) {
502                 if (is.spinner->hasFocus()) {
503                         return FocusInfo{ int(is.bus_idx), is.spinner_group, is.field_number };
504                 }
505         }
506         for (const InstantiatedSpinner &is : button_spinners) {
507                 if (is.spinner->hasFocus()) {
508                         return FocusInfo{ int(is.bus_idx), is.spinner_group, is.field_number };
509                 }
510         }
511         for (const InstantiatedSpinner &is : light_spinners) {
512                 if (is.spinner->hasFocus()) {
513                         return FocusInfo{ int(is.bus_idx), is.spinner_group, is.field_number };
514                 }
515         }
516         return FocusInfo{ -1, SpinnerGroup::ALL_GROUPS, -1 };
517 }