1 // Mappings from MIDI controllers to the UI. (We don't really build
2 // a more complicated data structure than this in Nageru itself either;
3 // we just edit and match directly against the protobuf.)
7 // A single, given controller mapping.
8 message MIDIControllerProto {
9 required int32 controller_number = 1;
10 // TODO: Add flags like invert here if/when we need them.
13 message MIDIButtonProto {
14 required int32 note_number = 1;
17 // All the mappings for a given a bus.
18 message MIDIMappingBusProto {
19 // TODO: If we need support for lots of buses (i.e., more than the typical eight
20 // on a mixer), add a system for bus banks, like we have for controller banks.
21 // optional int32 bus_bank = 1;
23 optional MIDIControllerProto treble = 2;
24 optional MIDIControllerProto mid = 3;
25 optional MIDIControllerProto bass = 4;
26 optional MIDIControllerProto gain = 5;
27 optional MIDIControllerProto compressor_threshold = 6;
28 optional MIDIControllerProto fader = 7;
30 // TODO: Add mute and cue? (Of course, we should those to the UI before
31 // making them MIDI controllable.)
32 optional MIDIButtonProto toggle_locut = 8;
33 optional MIDIButtonProto toggle_auto_gain_staging = 9;
34 optional MIDIButtonProto toggle_compressor = 10;
35 optional MIDIButtonProto clear_peak = 11;
37 // These are really global (controller bank change affects all buss),
38 // but it's not uncommon that we'd want one button per bus to switch banks.
39 // E.g., if the user binds the “mute” button to “next bank”, they'd want every
40 // mute button on the mixer to do that, so they need one mapping per bus.
41 optional MIDIButtonProto prev_bank = 12;
42 optional MIDIButtonProto next_bank = 13;
43 optional MIDIButtonProto select_bank_1 = 14;
44 optional MIDIButtonProto select_bank_2 = 15;
45 optional MIDIButtonProto select_bank_3 = 16;
46 optional MIDIButtonProto select_bank_4 = 17;
47 optional MIDIButtonProto select_bank_5 = 18;
49 // These are also global (they belong to the master bus), and unlike
50 // the bank change commands, one would usually have only one of each,
51 // but there's no reason to limit them to one each, and the editor UI
52 // becomes simpler if they are the treated the same way as the bank
54 optional MIDIControllerProto locut = 19;
55 optional MIDIControllerProto limiter_threshold = 20;
56 optional MIDIControllerProto makeup_gain = 21;
59 // The top-level protobuf, containing all the bus mappings, as well as
60 // more global settings.
62 // Since a typical mixer will have fewer physical controls than what Nageru
63 // could use, Nageru supports so-called controller banks. A mapping can
64 // optionally belong to a bank, and if so, that mapping is only active when
65 // that bank is selected. The user can then select the current bank using
66 // other mappings, typically by having some mixer button assigned to
67 // “next bank”. This yields effective multiplexing of lesser-used controls.
68 message MIDIMappingProto {
69 optional int32 num_controller_banks = 1 [default = 0]; // Max 5.
71 // Bus controller banks.
72 optional int32 treble_bank = 2;
73 optional int32 mid_bank = 3;
74 optional int32 bass_bank = 4;
75 optional int32 gain_bank = 5;
76 optional int32 compressor_threshold_bank = 6;
77 optional int32 fader_bank = 7;
80 optional int32 toggle_locut_bank = 8;
81 optional int32 toggle_auto_gain_staging_bank = 9;
82 optional int32 toggle_compressor_bank = 10;
83 optional int32 clear_peak_bank = 11;
85 // Global controller banks.
86 optional int32 locut_bank = 12;
87 optional int32 limiter_threshold_bank = 13;
88 optional int32 makeup_gain_bank = 14;
90 repeated MIDIMappingBusProto bus_mapping = 15;