2 Copyright (C) 1998-2006 Paul Davis
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
25 #include "pbd/error.h"
26 #include "pbd/xml++.h"
27 #include "pbd/stacktrace.h"
28 #include "pbd/compose.h"
30 #include "midi++/types.h" // Added by JE - 06-01-2009. All instances of 'byte' changed to 'MIDI::byte' (for clarification)
31 #include "midi++/port.h"
32 #include "midi++/channel.h"
34 #include "ardour/async_midi_port.h"
35 #include "ardour/automation_control.h"
36 #include "ardour/controllable_descriptor.h"
37 #include "ardour/midi_ui.h"
38 #include "ardour/utils.h"
39 #include "ardour/debug.h"
41 #include "midicontrollable.h"
42 #include "generic_midi_control_protocol.h"
47 using namespace ARDOUR;
49 MIDIControllable::MIDIControllable (GenericMidiControlProtocol* s, MIDI::Parser& p, bool m)
56 _learned = false; /* from URI */
59 last_value = 0; // got a better idea ?
60 last_controllable_value = 0.0f;
64 _control_description = "MIDI Control: none";
65 control_additional = (MIDI::byte) -1;
66 feedback = true; // for now
69 MIDIControllable::MIDIControllable (GenericMidiControlProtocol* s, MIDI::Parser& p, Controllable& c, bool m)
75 set_controllable (&c);
77 _learned = true; /* from controllable */
80 last_value = 0; // got a better idea ?
81 last_controllable_value = 0.0f;
85 _control_description = "MIDI Control: none";
86 control_additional = (MIDI::byte) -1;
87 feedback = true; // for now
90 MIDIControllable::~MIDIControllable ()
92 drop_external_control ();
96 MIDIControllable::init (const std::string& s)
100 _descriptor = new ControllableDescriptor;
101 return _descriptor->set (s);
105 MIDIControllable::midi_forget ()
107 /* stop listening for incoming messages, but retain
108 our existing event + type information.
111 midi_sense_connection[0].disconnect ();
112 midi_sense_connection[1].disconnect ();
113 midi_learn_connection.disconnect ();
117 MIDIControllable::drop_external_control ()
123 control_additional = (MIDI::byte) -1;
127 MIDIControllable::set_controllable (Controllable* c)
129 if (c == controllable) {
133 controllable_death_connection.disconnect ();
138 last_controllable_value = controllable->get_value();
140 last_controllable_value = 0.0f; // is there a better value?
144 controllable->Destroyed.connect (controllable_death_connection, MISSING_INVALIDATOR,
145 boost::bind (&MIDIControllable::drop_controllable, this, _1),
146 MidiControlUI::instance());
151 MIDIControllable::midi_rebind (channel_t c)
154 bind_midi (c, control_type, control_additional);
161 MIDIControllable::learn_about_external_control ()
163 drop_external_control ();
164 _parser.any.connect_same_thread (midi_learn_connection, boost::bind (&MIDIControllable::midi_receiver, this, _1, _2, _3));
168 MIDIControllable::stop_learning ()
170 midi_learn_connection.disconnect ();
174 MIDIControllable::control_to_midi (float val)
176 if (controllable->is_gain_like()) {
177 return gain_to_slider_position (val) * max_value_for_type ();
180 float control_min = controllable->lower ();
181 float control_max = controllable->upper ();
182 float control_range = control_max - control_min;
184 if (controllable->is_toggle()) {
185 if (val >= (control_min + (control_range/2.0f))) {
186 return max_value_for_type();
191 AutomationControl *actl = dynamic_cast<AutomationControl*> (controllable);
193 control_min = actl->internal_to_interface(control_min);
194 control_max = actl->internal_to_interface(control_max);
195 control_range = control_max - control_min;
196 val = actl->internal_to_interface(val);
199 // fiddle value of max so value doesn't jump from 125 to 127 for 1.0
200 // otherwise decrement won't work.
201 return (val - control_min) / control_range * (max_value_for_type () - 1);
205 MIDIControllable::midi_to_control (int val)
207 /* fiddle with MIDI value so that we get an odd number of integer steps
208 and can thus represent "middle" precisely as 0.5. this maps to
209 the range 0..+1.0 (0 to 126)
212 float fv = (val == 0 ? 0 : float (val - 1) / (max_value_for_type() - 1));
214 if (controllable->is_gain_like()) {
215 return controllable->interface_to_internal (fv);
217 DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Raw value %1 float %2\n", val, fv));
219 float control_min = controllable->lower ();
220 float control_max = controllable->upper ();
221 float control_range = control_max - control_min;
222 DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Min %1 Max %2 Range %3\n", control_min, control_max, control_range));
224 AutomationControl *actl = dynamic_cast<AutomationControl*> (controllable);
226 if (fv == 0.f) return control_min;
227 if (fv == 1.f) return control_max;
228 control_min = actl->internal_to_interface(control_min);
229 control_max = actl->internal_to_interface(control_max);
230 control_range = control_max - control_min;
231 return actl->interface_to_internal((fv * control_range) + control_min);
233 return (fv * control_range) + control_min;
237 MIDIControllable::midi_sense_note_on (Parser &p, EventTwoBytes *tb)
239 midi_sense_note (p, tb, true);
243 MIDIControllable::midi_sense_note_off (Parser &p, EventTwoBytes *tb)
245 midi_sense_note (p, tb, false);
249 MIDIControllable::lookup_controllable()
255 boost::shared_ptr<Controllable> c = _surface->lookup_controllable (*_descriptor);
261 set_controllable (c.get ());
267 MIDIControllable::drop_controllable (Controllable* c)
269 if (c == controllable) {
270 set_controllable (0);
275 MIDIControllable::midi_sense_note (Parser &, EventTwoBytes *msg, bool /*is_on*/)
278 if (lookup_controllable()) {
283 if (!controllable->is_toggle()) {
284 if (control_additional == msg->note_number) {
285 controllable->set_value (midi_to_control (msg->velocity), Controllable::NoGroup);
286 DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Note %1 value %2 %3\n", (int) msg->note_number, (float) midi_to_control (msg->velocity), current_uri() ));
289 if (control_additional == msg->note_number) {
290 float new_value = controllable->get_value() > 0.5f ? 0.0f : 1.0f;
291 controllable->set_value (new_value, Controllable::NoGroup);
292 DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Note %1 Value %2 %3\n", (int) msg->note_number, (float) new_value, current_uri()));
296 last_value = (MIDI::byte) (controllable->get_value() * 127.0); // to prevent feedback fights
300 MIDIControllable::midi_sense_controller (Parser &, EventTwoBytes *msg)
303 if (lookup_controllable ()) {
308 assert (controllable);
310 if (controllable->touching()) {
311 return; // to prevent feedback fights when e.g. dragging a UI slider
314 if (control_additional == msg->controller_number) {
316 if (!controllable->is_toggle()) {
317 if (get_encoder() == No_enc) {
318 float new_value = msg->value;
319 float max_value = max(last_controllable_value, new_value);
320 float min_value = min(last_controllable_value, new_value);
321 float range = max_value - min_value;
322 float threshold = (float) _surface->threshold ();
324 bool const in_sync = (
326 controllable->get_value() <= midi_to_control(max_value) &&
327 controllable->get_value() >= midi_to_control(min_value)
330 /* If the surface is not motorised, we try to prevent jumps when
331 the MIDI controller and controllable are out of sync.
332 There might be a better way of doing this.
335 if (in_sync || _surface->motorised ()) {
336 controllable->set_value (midi_to_control (new_value), Controllable::NoGroup);
338 DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("MIDI CC %1 value %2 %3\n", (int) msg->controller_number, (float) midi_to_control(new_value), current_uri() ));
340 last_controllable_value = new_value;
342 int offset = (msg->value & 0x3f);
343 switch (get_encoder()) {
345 if (msg->value > 0x40) {
346 controllable->set_value (midi_to_control (last_value - offset + 1), Controllable::NoGroup);
348 controllable->set_value (midi_to_control (last_value + offset + 1), Controllable::NoGroup);
352 if (msg->value > 0x40) {
353 controllable->set_value (midi_to_control (last_value + offset + 1), Controllable::NoGroup);
355 controllable->set_value (midi_to_control (last_value - offset + 1), Controllable::NoGroup);
359 if (msg->value > 0x40) {
360 controllable->set_value (midi_to_control (last_value - (0x7f - msg->value) + 1), Controllable::NoGroup);
362 controllable->set_value (midi_to_control (last_value + offset + 1), Controllable::NoGroup);
366 if (msg->value > 0x40) {
367 controllable->set_value (midi_to_control (last_value + offset + 1), Controllable::NoGroup);
369 controllable->set_value (midi_to_control (last_value - (0x40 - offset)), Controllable::NoGroup);
375 DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("MIDI CC %1 value %2 %3\n", (int) msg->controller_number, (int) last_value, current_uri() ));
380 /* toggle control: make the toggle flip only if the
381 * incoming control value exceeds 0.5 (0x40), so that
382 * the typical button which sends "CC N=0x7f" on press
383 * and "CC N=0x0" on release can be used to drive
386 * No other arrangement really makes sense for a toggle
387 * controllable. Acting on the press+release makes the
388 * action momentary, which is almost never
389 * desirable. If the physical button only sends a
390 * message on press (or release), then it will be
391 * expected to send a controller value >= 0.5
392 * (0x40). It is hard to imagine why anyone would make
393 * a MIDI controller button that sent 0x0 when pressed.
396 if (msg->value >= 0x40) {
397 controllable->set_value (controllable->get_value() >= 0.5 ? 0.0 : 1.0, Controllable::NoGroup);
398 DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Midi CC %1 value 1 %2\n", (int) msg->controller_number, current_uri()));
402 last_value = (MIDI::byte) (control_to_midi(controllable->get_value())); // to prevent feedback fights
407 MIDIControllable::midi_sense_program_change (Parser &, MIDI::byte msg)
410 if (lookup_controllable ()) {
414 if (msg == control_additional) {
416 if (!controllable->is_toggle()) {
417 controllable->set_value (1.0, Controllable::NoGroup);
418 DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("MIDI program %1 value 1.0 %3\n", (int) msg, current_uri() ));
420 float new_value = controllable->get_value() > 0.5f ? 0.0f : 1.0f;
421 controllable->set_value (new_value, Controllable::NoGroup);
422 DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("MIDI program %1 value %2 %3\n", (int) msg, (float) new_value, current_uri()));
426 last_value = (MIDI::byte) (controllable->get_value() * 127.0); // to prevent feedback fights
430 MIDIControllable::midi_sense_pitchbend (Parser &, pitchbend_t pb)
433 if (lookup_controllable ()) {
438 if (!controllable->is_toggle()) {
439 controllable->set_value (midi_to_control (pb), Controllable::NoGroup);
440 DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("MIDI pitchbend %1 value %2 %3\n", (int) control_channel, (float) midi_to_control (pb), current_uri() ));
443 controllable->set_value (1, Controllable::NoGroup);
444 DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Midi pitchbend %1 value 1 %2\n", (int) control_channel, current_uri()));
446 controllable->set_value (0, Controllable::NoGroup);
447 DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Midi pitchbend %1 value 0 %2\n", (int) control_channel, current_uri()));
451 last_value = control_to_midi (controllable->get_value ());
455 MIDIControllable::midi_receiver (Parser &, MIDI::byte *msg, size_t /*len*/)
457 /* we only respond to channel messages */
459 if ((msg[0] & 0xF0) < 0x80 || (msg[0] & 0xF0) > 0xE0) {
463 _surface->check_used_event(msg[0], msg[1]);
464 bind_midi ((channel_t) (msg[0] & 0xf), eventType (msg[0] & 0xF0), msg[1]);
467 controllable->LearningFinished ();
472 MIDIControllable::rpn_value_change (Parser&, uint16_t rpn, float val)
474 if (control_rpn == rpn) {
476 controllable->set_value (val, Controllable::NoGroup);
482 MIDIControllable::nrpn_value_change (Parser&, uint16_t nrpn, float val)
484 if (control_nrpn == nrpn) {
486 controllable->set_value (val, Controllable::NoGroup);
492 MIDIControllable::rpn_change (Parser&, uint16_t rpn, int dir)
494 if (control_rpn == rpn) {
496 /* XXX how to increment/decrement ? */
497 // controllable->set_value (val);
503 MIDIControllable::nrpn_change (Parser&, uint16_t nrpn, int dir)
505 if (control_nrpn == nrpn) {
507 /* XXX how to increment/decrement ? */
508 // controllable->set_value (val);
514 MIDIControllable::bind_rpn_value (channel_t chn, uint16_t rpn)
517 drop_external_control ();
519 control_channel = chn;
520 _parser.channel_rpn[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::rpn_value_change, this, _1, _2, _3));
524 MIDIControllable::bind_nrpn_value (channel_t chn, uint16_t nrpn)
527 drop_external_control ();
529 control_channel = chn;
530 _parser.channel_nrpn[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::rpn_value_change, this, _1, _2, _3));
534 MIDIControllable::bind_nrpn_change (channel_t chn, uint16_t nrpn)
537 drop_external_control ();
539 control_channel = chn;
540 _parser.channel_nrpn_change[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::rpn_change, this, _1, _2, _3));
544 MIDIControllable::bind_rpn_change (channel_t chn, uint16_t rpn)
547 drop_external_control ();
549 control_channel = chn;
550 _parser.channel_rpn_change[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::nrpn_change, this, _1, _2, _3));
554 MIDIControllable::bind_midi (channel_t chn, eventType ev, MIDI::byte additional)
558 drop_external_control ();
561 control_channel = chn;
562 control_additional = additional;
567 _parser.channel_note_off[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::midi_sense_note_off, this, _1, _2));
569 /* if this is a togglee, connect to noteOn as well,
570 and we'll toggle back and forth between the two.
574 _parser.channel_note_on[chn_i].connect_same_thread (midi_sense_connection[1], boost::bind (&MIDIControllable::midi_sense_note_on, this, _1, _2));
577 _control_description = "MIDI control: NoteOff";
581 _parser.channel_note_on[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::midi_sense_note_on, this, _1, _2));
583 _parser.channel_note_off[chn_i].connect_same_thread (midi_sense_connection[1], boost::bind (&MIDIControllable::midi_sense_note_off, this, _1, _2));
585 _control_description = "MIDI control: NoteOn";
588 case MIDI::controller:
589 _parser.channel_controller[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::midi_sense_controller, this, _1, _2));
590 snprintf (buf, sizeof (buf), "MIDI control: Controller %d", control_additional);
591 _control_description = buf;
595 _parser.channel_program_change[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::midi_sense_program_change, this, _1, _2));
596 _control_description = "MIDI control: ProgramChange";
599 case MIDI::pitchbend:
600 _parser.channel_pitchbend[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::midi_sense_pitchbend, this, _1, _2));
601 _control_description = "MIDI control: Pitchbend";
607 DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Controlable: bind_midi: %1 on Channel %2 value %3 \n", _control_description, chn_i + 1, (int) additional));
611 MIDIControllable::write_feedback (MIDI::byte* buf, int32_t& bufsize, bool /*force*/)
613 if (!controllable || !feedback) {
617 float val = controllable->get_value ();
619 /* Note that when sending RPN/NPRN we do two things:
621 * always send MSB first, then LSB
622 * null/reset the parameter ID after sending.
624 * this follows recommendations found online, eg. http://www.philrees.co.uk/nrpnq.htm
627 if (control_rpn >= 0) {
631 int rpn_val = (int) lrintf (val * 16384.0);
632 if (last_value == rpn_val) {
635 *buf++ = (0xb0) | control_channel;
637 *buf++ = (int) ((control_rpn) >> 7);
639 *buf++ = (int) (control_rpn & 0x7f);
641 *buf++ = (int) (rpn_val >> 7);
643 *buf++ = (int) (rpn_val & 0x7f);
649 last_value = rpn_val;
650 DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("MIDI out: RPN %1 Channel %2 Value %3\n", control_rpn, (int) control_channel, val));
654 if (control_nrpn >= 0) {
655 int rpn_val = (int) lrintf (val * 16384.0);
656 if (last_value == rpn_val) {
659 *buf++ = (0xb0) | control_channel;
661 *buf++ = (int) ((control_rpn) >> 7);
663 *buf++ = (int) (control_rpn & 0x7f);
665 *buf++ = (int) (rpn_val >> 7);
667 *buf++ = (int) (rpn_val & 0x7f);
672 last_value = rpn_val;
674 DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("MIDI out: NRPN %1 Channel %2 Value %3\n", control_nrpn, (int) control_channel, val));
678 if (control_type == none || bufsize <= 2) {
682 int const gm = control_to_midi (val);
684 if (gm == last_value) {
688 DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Feedback: %1 %2\n", control_description(), current_uri()));
690 *buf++ = (0xF0 & control_type) | (0xF & control_channel);
692 switch (control_type) {
693 case MIDI::pitchbend:
694 *buf++ = int (gm) & 127;
695 *buf++ = (int (gm) >> 7) & 127;
698 *buf++ = control_additional; /* program number */
702 *buf++ = control_additional; /* controller number */
706 DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("MIDI out: Type %1 Channel %2 Bytes %3 %4\n", (int) control_type, (int) control_channel , (int) *(buf - 2), (int) *(buf - 1)));
715 MIDIControllable::set_state (const XMLNode& node, int /*version*/)
717 const XMLProperty* prop;
720 if ((prop = node.property ("event")) != 0) {
721 sscanf (prop->value().c_str(), "0x%x", &xx);
722 control_type = (MIDI::eventType) xx;
727 if ((prop = node.property ("channel")) != 0) {
728 sscanf (prop->value().c_str(), "%d", &xx);
729 control_channel = (MIDI::channel_t) xx;
734 if ((prop = node.property ("additional")) != 0) {
735 sscanf (prop->value().c_str(), "0x%x", &xx);
736 control_additional = (MIDI::byte) xx;
741 if ((prop = node.property ("feedback")) != 0) {
742 feedback = (prop->value() == "yes");
744 feedback = true; // default
747 bind_midi (control_channel, control_type, control_additional);
753 MIDIControllable::get_state ()
757 XMLNode* node = new XMLNode ("MIDIControllable");
759 if (_current_uri.empty()) {
760 node->add_property ("id", controllable->id().to_s());
762 node->add_property ("uri", _current_uri);
766 snprintf (buf, sizeof(buf), "0x%x", (int) control_type);
767 node->add_property ("event", buf);
768 snprintf (buf, sizeof(buf), "%d", (int) control_channel);
769 node->add_property ("channel", buf);
770 snprintf (buf, sizeof(buf), "0x%x", (int) control_additional);
771 node->add_property ("additional", buf);
772 node->add_property ("feedback", (feedback ? "yes" : "no"));
778 /** @return the maximum value for a control value transmitted
779 * using a given MIDI::eventType.
782 MIDIControllable::max_value_for_type () const
784 /* XXX: this is not complete */
786 if (control_type == MIDI::pitchbend) {