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/types_convert.h"
29 #include "pbd/compose.h"
31 #include "midi++/types.h" // Added by JE - 06-01-2009. All instances of 'byte' changed to 'MIDI::byte' (for clarification)
32 #include "midi++/port.h"
33 #include "midi++/channel.h"
35 #include "ardour/async_midi_port.h"
36 #include "ardour/automation_control.h"
37 #include "ardour/controllable_descriptor.h"
38 #include "ardour/midi_ui.h"
39 #include "ardour/utils.h"
40 #include "ardour/debug.h"
42 #include "midicontrollable.h"
43 #include "generic_midi_control_protocol.h"
48 using namespace ARDOUR;
50 MIDIControllable::MIDIControllable (GenericMidiControlProtocol* s, MIDI::Parser& p, bool m)
57 _learned = false; /* from URI */
60 last_value = 0; // got a better idea ?
61 last_controllable_value = 0.0f;
65 _control_description = "MIDI Control: none";
66 control_additional = (MIDI::byte) -1;
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;
89 MIDIControllable::~MIDIControllable ()
91 drop_external_control ();
97 MIDIControllable::init (const std::string& s)
101 _descriptor = new ControllableDescriptor;
102 return _descriptor->set (s);
106 MIDIControllable::midi_forget ()
108 /* stop listening for incoming messages, but retain
109 our existing event + type information.
112 midi_sense_connection[0].disconnect ();
113 midi_sense_connection[1].disconnect ();
114 midi_learn_connection.disconnect ();
118 MIDIControllable::drop_external_control ()
124 control_additional = (MIDI::byte) -1;
128 MIDIControllable::set_controllable (Controllable* c)
130 if (c == controllable) {
134 controllable_death_connection.disconnect ();
139 last_controllable_value = controllable->get_value();
141 last_controllable_value = 0.0f; // is there a better value?
145 controllable->Destroyed.connect (controllable_death_connection, MISSING_INVALIDATOR,
146 boost::bind (&MIDIControllable::drop_controllable, this, _1),
147 MidiControlUI::instance());
152 MIDIControllable::midi_rebind (channel_t c)
155 bind_midi (c, control_type, control_additional);
162 MIDIControllable::learn_about_external_control ()
164 drop_external_control ();
165 _parser.any.connect_same_thread (midi_learn_connection, boost::bind (&MIDIControllable::midi_receiver, this, _1, _2, _3));
169 MIDIControllable::stop_learning ()
171 midi_learn_connection.disconnect ();
175 MIDIControllable::control_to_midi (float val)
177 if (controllable->is_gain_like()) {
178 return gain_to_slider_position (val) * max_value_for_type ();
181 float control_min = controllable->lower ();
182 float control_max = controllable->upper ();
183 float control_range = control_max - control_min;
185 if (controllable->is_toggle()) {
186 if (val >= (control_min + (control_range/2.0f))) {
187 return max_value_for_type();
192 AutomationControl *actl = dynamic_cast<AutomationControl*> (controllable);
194 control_min = actl->internal_to_interface(control_min);
195 control_max = actl->internal_to_interface(control_max);
196 control_range = control_max - control_min;
197 val = actl->internal_to_interface(val);
200 // fiddle value of max so value doesn't jump from 125 to 127 for 1.0
201 // otherwise decrement won't work.
202 return (val - control_min) / control_range * (max_value_for_type () - 1);
206 MIDIControllable::midi_to_control (int val)
208 /* fiddle with MIDI value so that we get an odd number of integer steps
209 and can thus represent "middle" precisely as 0.5. this maps to
210 the range 0..+1.0 (0 to 126)
213 float fv = (val == 0 ? 0 : float (val - 1) / (max_value_for_type() - 1));
215 if (controllable->is_gain_like()) {
216 return controllable->interface_to_internal (fv);
218 DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Raw value %1 float %2\n", val, fv));
220 float control_min = controllable->lower ();
221 float control_max = controllable->upper ();
222 float control_range = control_max - control_min;
223 DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Min %1 Max %2 Range %3\n", control_min, control_max, control_range));
225 AutomationControl *actl = dynamic_cast<AutomationControl*> (controllable);
227 if (fv == 0.f) return control_min;
228 if (fv == 1.f) return control_max;
229 control_min = actl->internal_to_interface(control_min);
230 control_max = actl->internal_to_interface(control_max);
231 control_range = control_max - control_min;
232 return actl->interface_to_internal((fv * control_range) + control_min);
234 return (fv * control_range) + control_min;
238 MIDIControllable::midi_sense_note_on (Parser &p, EventTwoBytes *tb)
240 midi_sense_note (p, tb, true);
244 MIDIControllable::midi_sense_note_off (Parser &p, EventTwoBytes *tb)
246 midi_sense_note (p, tb, false);
250 MIDIControllable::lookup_controllable()
256 boost::shared_ptr<Controllable> c = _surface->lookup_controllable (*_descriptor);
262 set_controllable (c.get ());
268 MIDIControllable::drop_controllable (Controllable* c)
270 if (c == controllable) {
271 set_controllable (0);
276 MIDIControllable::midi_sense_note (Parser &, EventTwoBytes *msg, bool /*is_on*/)
279 if (lookup_controllable()) {
284 _surface->maybe_start_touch (controllable);
286 if (!controllable->is_toggle()) {
287 if (control_additional == msg->note_number) {
288 controllable->set_value (midi_to_control (msg->velocity), Controllable::UseGroup);
289 DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Note %1 value %2 %3\n", (int) msg->note_number, (float) midi_to_control (msg->velocity), current_uri() ));
292 if (control_additional == msg->note_number) {
293 float new_value = controllable->get_value() > 0.5f ? 0.0f : 1.0f;
294 controllable->set_value (new_value, Controllable::UseGroup);
295 DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Note %1 Value %2 %3\n", (int) msg->note_number, (float) new_value, current_uri()));
299 last_value = (MIDI::byte) (controllable->get_value() * 127.0); // to prevent feedback fights
303 MIDIControllable::midi_sense_controller (Parser &, EventTwoBytes *msg)
306 if (lookup_controllable ()) {
311 assert (controllable);
313 _surface->maybe_start_touch (controllable);
315 if (control_additional == msg->controller_number) {
317 if (!controllable->is_toggle()) {
318 if (get_encoder() == No_enc) {
319 float new_value = msg->value;
320 float max_value = max(last_controllable_value, new_value);
321 float min_value = min(last_controllable_value, new_value);
322 float range = max_value - min_value;
323 float threshold = (float) _surface->threshold ();
325 bool const in_sync = (
327 controllable->get_value() <= midi_to_control(max_value) &&
328 controllable->get_value() >= midi_to_control(min_value)
331 /* If the surface is not motorised, we try to prevent jumps when
332 the MIDI controller and controllable are out of sync.
333 There might be a better way of doing this.
336 if (in_sync || _surface->motorised ()) {
337 controllable->set_value (midi_to_control (new_value), Controllable::UseGroup);
339 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() ));
341 last_controllable_value = new_value;
343 int offset = (msg->value & 0x3f);
344 switch (get_encoder()) {
346 if (msg->value > 0x40) {
347 controllable->set_value (midi_to_control (last_value - offset + 1), Controllable::UseGroup);
349 controllable->set_value (midi_to_control (last_value + offset + 1), Controllable::UseGroup);
353 if (msg->value > 0x40) {
354 controllable->set_value (midi_to_control (last_value + offset + 1), Controllable::UseGroup);
356 controllable->set_value (midi_to_control (last_value - offset + 1), Controllable::UseGroup);
360 if (msg->value > 0x40) {
361 controllable->set_value (midi_to_control (last_value - (0x7f - msg->value) + 1), Controllable::UseGroup);
363 controllable->set_value (midi_to_control (last_value + offset + 1), Controllable::UseGroup);
367 if (msg->value > 0x40) {
368 controllable->set_value (midi_to_control (last_value + offset + 1), Controllable::UseGroup);
370 controllable->set_value (midi_to_control (last_value - (0x40 - offset)), Controllable::UseGroup);
376 DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("MIDI CC %1 value %2 %3\n", (int) msg->controller_number, (int) last_value, current_uri() ));
381 /* toggle control: make the toggle flip only if the
382 * incoming control value exceeds 0.5 (0x40), so that
383 * the typical button which sends "CC N=0x7f" on press
384 * and "CC N=0x0" on release can be used to drive
387 * No other arrangement really makes sense for a toggle
388 * controllable. Acting on the press+release makes the
389 * action momentary, which is almost never
390 * desirable. If the physical button only sends a
391 * message on press (or release), then it will be
392 * expected to send a controller value >= 0.5
393 * (0x40). It is hard to imagine why anyone would make
394 * a MIDI controller button that sent 0x0 when pressed.
397 if (msg->value >= 0x40) {
398 controllable->set_value (controllable->get_value() >= 0.5 ? 0.0 : 1.0, Controllable::UseGroup);
399 DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Midi CC %1 value 1 %2\n", (int) msg->controller_number, current_uri()));
403 last_value = (MIDI::byte) (control_to_midi(controllable->get_value())); // to prevent feedback fights
408 MIDIControllable::midi_sense_program_change (Parser &, MIDI::byte msg)
411 if (lookup_controllable ()) {
416 _surface->maybe_start_touch (controllable);
418 if (msg == control_additional) {
420 if (!controllable->is_toggle()) {
421 controllable->set_value (1.0, Controllable::UseGroup);
422 DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("MIDI program %1 value 1.0 %3\n", (int) msg, current_uri() ));
424 float new_value = controllable->get_value() > 0.5f ? 0.0f : 1.0f;
425 controllable->set_value (new_value, Controllable::UseGroup);
426 DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("MIDI program %1 value %2 %3\n", (int) msg, (float) new_value, current_uri()));
430 last_value = (MIDI::byte) (controllable->get_value() * 127.0); // to prevent feedback fights
434 MIDIControllable::midi_sense_pitchbend (Parser &, pitchbend_t pb)
437 if (lookup_controllable ()) {
442 _surface->maybe_start_touch (controllable);
444 if (!controllable->is_toggle()) {
445 controllable->set_value (midi_to_control (pb), Controllable::UseGroup);
446 DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("MIDI pitchbend %1 value %2 %3\n", (int) control_channel, (float) midi_to_control (pb), current_uri() ));
449 controllable->set_value (1, Controllable::UseGroup);
450 DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Midi pitchbend %1 value 1 %2\n", (int) control_channel, current_uri()));
452 controllable->set_value (0, Controllable::UseGroup);
453 DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Midi pitchbend %1 value 0 %2\n", (int) control_channel, current_uri()));
457 last_value = control_to_midi (controllable->get_value ());
461 MIDIControllable::midi_receiver (Parser &, MIDI::byte *msg, size_t /*len*/)
463 /* we only respond to channel messages */
465 if ((msg[0] & 0xF0) < 0x80 || (msg[0] & 0xF0) > 0xE0) {
469 _surface->check_used_event(msg[0], msg[1]);
470 bind_midi ((channel_t) (msg[0] & 0xf), eventType (msg[0] & 0xF0), msg[1]);
473 controllable->LearningFinished ();
478 MIDIControllable::rpn_value_change (Parser&, uint16_t rpn, float val)
480 if (control_rpn == rpn) {
482 controllable->set_value (val, Controllable::UseGroup);
488 MIDIControllable::nrpn_value_change (Parser&, uint16_t nrpn, float val)
490 if (control_nrpn == nrpn) {
492 controllable->set_value (val, Controllable::UseGroup);
498 MIDIControllable::rpn_change (Parser&, uint16_t rpn, int dir)
500 if (control_rpn == rpn) {
502 /* XXX how to increment/decrement ? */
503 // controllable->set_value (val);
509 MIDIControllable::nrpn_change (Parser&, uint16_t nrpn, int dir)
511 if (control_nrpn == nrpn) {
513 /* XXX how to increment/decrement ? */
514 // controllable->set_value (val);
520 MIDIControllable::bind_rpn_value (channel_t chn, uint16_t rpn)
523 drop_external_control ();
525 control_channel = chn;
526 _parser.channel_rpn[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::rpn_value_change, this, _1, _2, _3));
530 MIDIControllable::bind_nrpn_value (channel_t chn, uint16_t nrpn)
533 drop_external_control ();
535 control_channel = chn;
536 _parser.channel_nrpn[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::rpn_value_change, this, _1, _2, _3));
540 MIDIControllable::bind_nrpn_change (channel_t chn, uint16_t nrpn)
543 drop_external_control ();
545 control_channel = chn;
546 _parser.channel_nrpn_change[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::rpn_change, this, _1, _2, _3));
550 MIDIControllable::bind_rpn_change (channel_t chn, uint16_t rpn)
553 drop_external_control ();
555 control_channel = chn;
556 _parser.channel_rpn_change[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::nrpn_change, this, _1, _2, _3));
560 MIDIControllable::bind_midi (channel_t chn, eventType ev, MIDI::byte additional)
564 drop_external_control ();
567 control_channel = chn;
568 control_additional = additional;
573 _parser.channel_note_off[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::midi_sense_note_off, this, _1, _2));
575 /* if this is a togglee, connect to noteOn as well,
576 and we'll toggle back and forth between the two.
580 _parser.channel_note_on[chn_i].connect_same_thread (midi_sense_connection[1], boost::bind (&MIDIControllable::midi_sense_note_on, this, _1, _2));
583 _control_description = "MIDI control: NoteOff";
587 _parser.channel_note_on[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::midi_sense_note_on, this, _1, _2));
589 _parser.channel_note_off[chn_i].connect_same_thread (midi_sense_connection[1], boost::bind (&MIDIControllable::midi_sense_note_off, this, _1, _2));
591 _control_description = "MIDI control: NoteOn";
594 case MIDI::controller:
595 _parser.channel_controller[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::midi_sense_controller, this, _1, _2));
596 snprintf (buf, sizeof (buf), "MIDI control: Controller %d", control_additional);
597 _control_description = buf;
601 _parser.channel_program_change[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::midi_sense_program_change, this, _1, _2));
602 _control_description = "MIDI control: ProgramChange";
605 case MIDI::pitchbend:
606 _parser.channel_pitchbend[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::midi_sense_pitchbend, this, _1, _2));
607 _control_description = "MIDI control: Pitchbend";
613 DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Controlable: bind_midi: %1 on Channel %2 value %3 \n", _control_description, chn_i + 1, (int) additional));
617 MIDIControllable::write_feedback (MIDI::byte* buf, int32_t& bufsize, bool /*force*/)
619 if (!controllable || !_surface->get_feedback ()) {
623 float val = controllable->get_value ();
625 /* Note that when sending RPN/NPRN we do two things:
627 * always send MSB first, then LSB
628 * null/reset the parameter ID after sending.
630 * this follows recommendations found online, eg. http://www.philrees.co.uk/nrpnq.htm
633 if (control_rpn >= 0) {
637 int rpn_val = (int) lrintf (val * 16384.0);
638 if (last_value == rpn_val) {
641 *buf++ = (0xb0) | control_channel;
643 *buf++ = (int) ((control_rpn) >> 7);
645 *buf++ = (int) (control_rpn & 0x7f);
647 *buf++ = (int) (rpn_val >> 7);
649 *buf++ = (int) (rpn_val & 0x7f);
655 last_value = rpn_val;
656 DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("MIDI out: RPN %1 Channel %2 Value %3\n", control_rpn, (int) control_channel, val));
660 if (control_nrpn >= 0) {
661 int rpn_val = (int) lrintf (val * 16384.0);
662 if (last_value == rpn_val) {
665 *buf++ = (0xb0) | control_channel;
667 *buf++ = (int) ((control_rpn) >> 7);
669 *buf++ = (int) (control_rpn & 0x7f);
671 *buf++ = (int) (rpn_val >> 7);
673 *buf++ = (int) (rpn_val & 0x7f);
678 last_value = rpn_val;
680 DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("MIDI out: NRPN %1 Channel %2 Value %3\n", control_nrpn, (int) control_channel, val));
684 if (control_type == none || bufsize <= 2) {
688 int const gm = control_to_midi (val);
690 if (gm == last_value) {
694 DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Feedback: %1 %2\n", control_description(), current_uri()));
696 *buf++ = (0xF0 & control_type) | (0xF & control_channel);
698 switch (control_type) {
699 case MIDI::pitchbend:
700 *buf++ = int (gm) & 127;
701 *buf++ = (int (gm) >> 7) & 127;
704 *buf++ = control_additional; /* program number */
708 *buf++ = control_additional; /* controller number */
712 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)));
721 MIDIControllable::set_state (const XMLNode& node, int /*version*/)
726 if (node.get_property ("event", str)) {
727 sscanf (str.c_str(), "0x%x", &xx);
728 control_type = (MIDI::eventType) xx;
733 if (node.get_property ("channel", xx)) {
734 control_channel = xx;
739 if (node.get_property ("additional", str)) {
740 sscanf (str.c_str(), "0x%x", &xx);
741 control_additional = (MIDI::byte) xx;
746 bind_midi (control_channel, control_type, control_additional);
752 MIDIControllable::get_state ()
756 XMLNode* node = new XMLNode ("MIDIControllable");
758 if (_current_uri.empty()) {
759 node->set_property ("id", controllable->id ());
761 node->set_property ("uri", _current_uri);
765 snprintf (buf, sizeof(buf), "0x%x", (int) control_type);
766 node->set_property ("event", (const char *)buf);
767 node->set_property ("channel", (int16_t)control_channel);
768 snprintf (buf, sizeof(buf), "0x%x", (int) control_additional);
769 node->set_property ("additional", (const char *)buf);
775 /** @return the maximum value for a control value transmitted
776 * using a given MIDI::eventType.
779 MIDIControllable::max_value_for_type () const
781 /* XXX: this is not complete */
783 if (control_type == MIDI::pitchbend) {