NOOP, remove trailing tabs/whitespace.
[ardour.git] / libs / surfaces / generic_midi / midicontrollable.cc
index bae32010725c28248adac375142c7cc86ac071e2..9dca702e686c7424f01b5aab94a39e506a190eb6 100644 (file)
 #include "pbd/error.h"
 #include "pbd/controllable_descriptor.h"
 #include "pbd/xml++.h"
+#include "pbd/stacktrace.h"
+#include "pbd/compose.h"
 
+#include "midi++/types.h" // Added by JE - 06-01-2009. All instances of 'byte' changed to 'MIDI::byte' (for clarification)
 #include "midi++/port.h"
 #include "midi++/channel.h"
 
+#include "ardour/async_midi_port.h"
 #include "ardour/automation_control.h"
+#include "ardour/midi_ui.h"
 #include "ardour/utils.h"
+#include "ardour/debug.h"
 
 #include "midicontrollable.h"
+#include "generic_midi_control_protocol.h"
 
 using namespace std;
 using namespace MIDI;
 using namespace PBD;
 using namespace ARDOUR;
 
-MIDIControllable::MIDIControllable (Port& p, bool m)
-       : controllable (0)
+MIDIControllable::MIDIControllable (GenericMidiControlProtocol* s, MIDI::Parser& p, bool m)
+       : _surface (s)
+       , controllable (0)
        , _descriptor (0)
-       , _port (p)
+       , _parser (p)
        , _momentary (m)
 {
        _learned = false; /* from URI */
+       _encoder = No_enc;
        setting = false;
        last_value = 0; // got a better idea ?
+       last_controllable_value = 0.0f;
        control_type = none;
        _control_description = "MIDI Control: none";
-       control_additional = (byte) -1;
+       control_additional = (MIDI::byte) -1;
        feedback = true; // for now
 }
 
-MIDIControllable::MIDIControllable (Port& p, Controllable& c, bool m)
-       : controllable (&c)
+MIDIControllable::MIDIControllable (GenericMidiControlProtocol* s, MIDI::Parser& p, Controllable& c, bool m)
+       : _surface (s)
        , _descriptor (0)
-       , _port (p)
+       , _parser (p)
        , _momentary (m)
 {
+       set_controllable (&c);
+
        _learned = true; /* from controllable */
+       _encoder = No_enc;
        setting = false;
        last_value = 0; // got a better idea ?
+       last_controllable_value = 0.0f;
        control_type = none;
        _control_description = "MIDI Control: none";
-       control_additional = (byte) -1;
+       control_additional = (MIDI::byte) -1;
        feedback = true; // for now
 }
 
@@ -100,13 +114,31 @@ MIDIControllable::drop_external_control ()
 {
        midi_forget ();
        control_type = none;
-       control_additional = (byte) -1;
+       control_additional = (MIDI::byte) -1;
 }
 
 void
 MIDIControllable::set_controllable (Controllable* c)
 {
+       if (c == controllable) {
+               return;
+       }
+
+       controllable_death_connection.disconnect ();
+
        controllable = c;
+
+       if (controllable) {
+               last_controllable_value = controllable->get_value();
+       } else {
+               last_controllable_value = 0.0f; // is there a better value?
+       }
+
+       if (controllable) {
+               controllable->Destroyed.connect (controllable_death_connection, MISSING_INVALIDATOR,
+                                                boost::bind (&MIDIControllable::drop_controllable, this),
+                                                MidiControlUI::instance());
+       }
 }
 
 void
@@ -123,7 +155,7 @@ void
 MIDIControllable::learn_about_external_control ()
 {
        drop_external_control ();
-       _port.parser()->any.connect_same_thread (midi_learn_connection, boost::bind (&MIDIControllable::midi_receiver, this, _1, _2, _3));
+       _parser.any.connect_same_thread (midi_learn_connection, boost::bind (&MIDIControllable::midi_receiver, this, _1, _2, _3));
 }
 
 void
@@ -132,43 +164,65 @@ MIDIControllable::stop_learning ()
        midi_learn_connection.disconnect ();
 }
 
-float
+int
 MIDIControllable::control_to_midi (float val)
 {
-       const float midi_range = 127.0f; // TODO: NRPN etc.
-
         if (controllable->is_gain_like()) {
-                return gain_to_slider_position (val/midi_range);
+                return gain_to_slider_position (val) * max_value_for_type ();
         }
 
        float control_min = controllable->lower ();
        float control_max = controllable->upper ();
-       const float control_range = control_max - control_min;
+       float control_range = control_max - control_min;
 
-       return (val - control_min) / control_range * midi_range;
+       if (controllable->is_toggle()) {
+               if (val >= (control_min + (control_range/2.0f))) {
+                       return max_value_for_type();
+               } else {
+                       return 0;
+               }
+       } else {
+               AutomationControl *actl = dynamic_cast<AutomationControl*> (controllable);
+               if (actl) {
+                       control_min = actl->internal_to_interface(control_min);
+                       control_max = actl->internal_to_interface(control_max);
+                       control_range = control_max - control_min;
+                       val = actl->internal_to_interface(val);
+               }
+       }
+       // fiddle value of max so value doesn't jump from 125 to 127 for 1.0
+       // otherwise decrement won't work.
+       return (val - control_min) / control_range * (max_value_for_type () - 1);
 }
 
 float
-MIDIControllable::midi_to_control(float val)
+MIDIControllable::midi_to_control (int val)
 {
         /* fiddle with MIDI value so that we get an odd number of integer steps
            and can thus represent "middle" precisely as 0.5. this maps to
-           the range 0..+1.0
-
-           TODO: 14bit values
+           the range 0..+1.0 (0 to 126)
         */
 
-        val = (val == 0.0f ? 0.0f : (val-1.0f) / 126.0f);
+        float fv = (val == 0 ? 0 : float (val - 1) / (max_value_for_type() - 1));
 
         if (controllable->is_gain_like()) {
-                return slider_position_to_gain (val);
+                return slider_position_to_gain (fv);
         }
 
        float control_min = controllable->lower ();
        float control_max = controllable->upper ();
-       const float control_range = control_max - control_min;
-
-       return  (val * control_range) + control_min;
+       float control_range = control_max - control_min;
+
+       AutomationControl *actl = dynamic_cast<AutomationControl*> (controllable);
+       if (actl) {
+               if (fv == 0.f) return control_min;
+               if (fv == 1.f) return control_max;
+               control_min = actl->internal_to_interface(control_min);
+               control_max = actl->internal_to_interface(control_max);
+               control_range = control_max - control_min;
+               return actl->interface_to_internal((fv * control_range) + control_min);
+       }
+       return (fv * control_range) + control_min;
 }
 
 void
@@ -183,20 +237,49 @@ MIDIControllable::midi_sense_note_off (Parser &p, EventTwoBytes *tb)
        midi_sense_note (p, tb, false);
 }
 
+int
+MIDIControllable::lookup_controllable()
+{
+       if (!_descriptor) {
+               return -1;
+       }
+
+       boost::shared_ptr<Controllable> c = _surface->lookup_controllable (*_descriptor);
+
+       if (!c) {
+               return -1;
+       }
+
+       set_controllable (c.get ());
+
+       return 0;
+}
+
+void
+MIDIControllable::drop_controllable ()
+{
+       set_controllable (0);
+}
+
 void
 MIDIControllable::midi_sense_note (Parser &, EventTwoBytes *msg, bool /*is_on*/)
 {
-       if (!controllable) { 
-               return;
+       if (!controllable) {
+               if (lookup_controllable()) {
+                       return;
+               }
        }
 
-
        if (!controllable->is_toggle()) {
-               controllable->set_value (msg->note_number/127.0);
+               if (control_additional == msg->note_number) {
+                       controllable->set_value (midi_to_control (msg->velocity));
+                       DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Note %1 value %2  %3\n", (int) msg->note_number, (float) midi_to_control (msg->velocity), current_uri() ));
+               }
        } else {
-
                if (control_additional == msg->note_number) {
-                       controllable->set_value (controllable->get_value() > 0.5f ? 0.0f : 1.0f);
+                       float new_value = controllable->get_value() > 0.5f ? 0.0f : 1.0f;
+                       controllable->set_value (new_value);
+                       DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Note %1 Value %2  %3\n", (int) msg->note_number, (float) new_value, current_uri()));
                }
        }
 
@@ -206,10 +289,14 @@ MIDIControllable::midi_sense_note (Parser &, EventTwoBytes *msg, bool /*is_on*/)
 void
 MIDIControllable::midi_sense_controller (Parser &, EventTwoBytes *msg)
 {
-       if (!controllable) { 
-               return;
+       if (!controllable) {
+               if (lookup_controllable ()) {
+                       return;
+               }
        }
 
+       assert (controllable);
+
        if (controllable->touching()) {
                return; // to prevent feedback fights when e.g. dragging a UI slider
        }
@@ -217,12 +304,74 @@ MIDIControllable::midi_sense_controller (Parser &, EventTwoBytes *msg)
        if (control_additional == msg->controller_number) {
 
                if (!controllable->is_toggle()) {
-                       controllable->set_value (midi_to_control (msg->value));
+                       if (get_encoder() == No_enc) {
+                               float new_value = msg->value;
+                               float max_value = max(last_controllable_value, new_value);
+                               float min_value = min(last_controllable_value, new_value);
+                               float range = max_value - min_value;
+                               float threshold = (float) _surface->threshold ();
+
+                               bool const in_sync = (
+                                       range < threshold &&
+                                       controllable->get_value() <= midi_to_control(max_value) &&
+                                       controllable->get_value() >= midi_to_control(min_value)
+                                       );
+
+                               /* If the surface is not motorised, we try to prevent jumps when
+                                  the MIDI controller and controllable are out of sync.
+                                  There might be a better way of doing this.
+                               */
+
+                               if (in_sync || _surface->motorised ()) {
+                                       controllable->set_value (midi_to_control (new_value));
+                               }
+                               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() ));
+
+                               last_controllable_value = new_value;
+                       } else {
+                               int offset = (msg->value & 0x3f);
+                               switch (get_encoder()) {
+                                       case Enc_L:
+                                               if (msg->value > 0x40) {
+                                                       controllable->set_value (midi_to_control (last_value - offset + 1));
+                                               } else {
+                                                       controllable->set_value (midi_to_control (last_value + offset + 1));
+                                               }
+                                               break;
+                                       case Enc_R:
+                                               if (msg->value > 0x40) {
+                                                       controllable->set_value (midi_to_control (last_value + offset + 1));
+                                               } else {
+                                                       controllable->set_value (midi_to_control (last_value - offset + 1));
+                                               }
+                                               break;
+                                       case Enc_2:
+                                               if (msg->value > 0x40) {
+                                                       controllable->set_value (midi_to_control (last_value - (0x7f - msg->value) + 1));
+                                               } else {
+                                                       controllable->set_value (midi_to_control (last_value + offset + 1));
+                                               }
+                                               break;
+                                       case Enc_B:
+                                               if (msg->value > 0x40) {
+                                                       controllable->set_value (midi_to_control (last_value + offset + 1));
+                                               } else {
+                                                       controllable->set_value (midi_to_control (last_value - (0x40 - offset)));
+                                               }
+                                               break;
+                                       default:
+                                               break;
+                               }
+                               DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("MIDI CC %1 value %2  %3\n", (int) msg->controller_number, (int) last_value, current_uri() ));
+
+                       }
                } else {
                        if (msg->value > 64.0f) {
                                controllable->set_value (1);
+                               DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Midi CC %1 value 1  %2\n", (int) msg->controller_number, current_uri()));
                        } else {
                                controllable->set_value (0);
+                               DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Midi CC %1 value 0  %2\n", (int) msg->controller_number, current_uri()));
                        }
                }
 
@@ -231,16 +380,23 @@ MIDIControllable::midi_sense_controller (Parser &, EventTwoBytes *msg)
 }
 
 void
-MIDIControllable::midi_sense_program_change (Parser &, byte msg)
+MIDIControllable::midi_sense_program_change (Parser &, MIDI::byte msg)
 {
-       if (!controllable) { 
-               return;
+       if (!controllable) {
+               if (lookup_controllable ()) {
+                       return;
+               }
        }
+       if (msg == control_additional) {
 
-       if (!controllable->is_toggle()) {
-               controllable->set_value (msg/127.0);
-       } else {
-               controllable->set_value (controllable->get_value() > 0.5f ? 0.0f : 1.0f);
+               if (!controllable->is_toggle()) {
+                       controllable->set_value (1.0);
+                       DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("MIDI program %1 value 1.0  %3\n", (int) msg, current_uri() ));
+               } else  {
+                       float new_value = controllable->get_value() > 0.5f ? 0.0f : 1.0f;
+                       controllable->set_value (new_value);
+                       DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("MIDI program %1 value %2  %3\n", (int) msg, (float) new_value, current_uri()));
+               }
        }
 
        last_value = (MIDI::byte) (controllable->get_value() * 127.0); // to prevent feedback fights
@@ -249,22 +405,30 @@ MIDIControllable::midi_sense_program_change (Parser &, byte msg)
 void
 MIDIControllable::midi_sense_pitchbend (Parser &, pitchbend_t pb)
 {
-       if (!controllable) { 
-               return;
+       if (!controllable) {
+               if (lookup_controllable ()) {
+                       return;
+               }
        }
 
        if (!controllable->is_toggle()) {
-               /* XXX gack - get rid of assumption about typeof pitchbend_t */
-               controllable->set_value ((pb/(float) SHRT_MAX));
+               controllable->set_value (midi_to_control (pb));
+               DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("MIDI pitchbend %1 value %2  %3\n", (int) control_channel, (float) midi_to_control (pb), current_uri() ));
        } else {
-               controllable->set_value (controllable->get_value() > 0.5f ? 0.0f : 1.0f);
+               if (pb > 8065.0f) {
+                       controllable->set_value (1);
+                       DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Midi pitchbend %1 value 1  %2\n", (int) control_channel, current_uri()));
+               } else {
+                       controllable->set_value (0);
+                       DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Midi pitchbend %1 value 0  %2\n", (int) control_channel, current_uri()));
+               }
        }
 
-       last_value = (MIDI::byte) (controllable->get_value() * 127.0); // to prevent feedback fights
+       last_value = control_to_midi (controllable->get_value ());
 }
 
 void
-MIDIControllable::midi_receiver (Parser &, byte *msg, size_t /*len*/)
+MIDIControllable::midi_receiver (Parser &, MIDI::byte *msg, size_t /*len*/)
 {
        /* we only respond to channel messages */
 
@@ -272,15 +436,12 @@ MIDIControllable::midi_receiver (Parser &, byte *msg, size_t /*len*/)
                return;
        }
 
-       /* if the our port doesn't do input anymore, forget it ... */
-
-       if (!_port.parser()) {
-               return;
-       }
-
+       _surface->check_used_event(msg[0], msg[1]);
        bind_midi ((channel_t) (msg[0] & 0xf), eventType (msg[0] & 0xF0), msg[1]);
 
-       controllable->LearningFinished ();
+       if (controllable) {
+               controllable->LearningFinished ();
+       }
 }
 
 void
@@ -294,99 +455,87 @@ MIDIControllable::bind_midi (channel_t chn, eventType ev, MIDI::byte additional)
        control_channel = chn;
        control_additional = additional;
 
-       if (_port.parser() == 0) {
-               return;
-       }
-
-       Parser& p = *_port.parser();
-
        int chn_i = chn;
        switch (ev) {
        case MIDI::off:
-               p.channel_note_off[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::midi_sense_note_off, this, _1, _2));
+               _parser.channel_note_off[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::midi_sense_note_off, this, _1, _2));
 
                /* if this is a togglee, connect to noteOn as well,
                   and we'll toggle back and forth between the two.
                */
 
                if (_momentary) {
-                       p.channel_note_on[chn_i].connect_same_thread (midi_sense_connection[1], boost::bind (&MIDIControllable::midi_sense_note_on, this, _1, _2));
-               } 
+                       _parser.channel_note_on[chn_i].connect_same_thread (midi_sense_connection[1], boost::bind (&MIDIControllable::midi_sense_note_on, this, _1, _2));
+               }
 
                _control_description = "MIDI control: NoteOff";
                break;
 
        case MIDI::on:
-               p.channel_note_on[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::midi_sense_note_on, this, _1, _2));
+               _parser.channel_note_on[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::midi_sense_note_on, this, _1, _2));
                if (_momentary) {
-                       p.channel_note_off[chn_i].connect_same_thread (midi_sense_connection[1], boost::bind (&MIDIControllable::midi_sense_note_off, this, _1, _2));
+                       _parser.channel_note_off[chn_i].connect_same_thread (midi_sense_connection[1], boost::bind (&MIDIControllable::midi_sense_note_off, this, _1, _2));
                }
                _control_description = "MIDI control: NoteOn";
                break;
-               
+
        case MIDI::controller:
-               p.channel_controller[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::midi_sense_controller, this, _1, _2));
+               _parser.channel_controller[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::midi_sense_controller, this, _1, _2));
                snprintf (buf, sizeof (buf), "MIDI control: Controller %d", control_additional);
                _control_description = buf;
                break;
 
        case MIDI::program:
-               p.channel_program_change[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::midi_sense_program_change, this, _1, _2));
+               _parser.channel_program_change[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::midi_sense_program_change, this, _1, _2));
                _control_description = "MIDI control: ProgramChange";
                break;
 
        case MIDI::pitchbend:
-               p.channel_pitchbend[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::midi_sense_pitchbend, this, _1, _2));
+               _parser.channel_pitchbend[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::midi_sense_pitchbend, this, _1, _2));
                _control_description = "MIDI control: Pitchbend";
                break;
 
        default:
                break;
        }
+       DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Controlable: bind_midi: %1 on Channel %2 value %3 \n", _control_description, chn_i + 1, (int) additional));
 }
 
-void
-MIDIControllable::send_feedback ()
+MIDI::byte*
+MIDIControllable::write_feedback (MIDI::byte* buf, int32_t& bufsize, bool /*force*/)
 {
-       byte msg[3];
-
-       if (!_learned || setting || !feedback || control_type == none || !controllable) {
-               return;
+       if (!controllable || control_type == none || !feedback || bufsize <= 2) {
+               return buf;
        }
 
-       msg[0] = (control_type & 0xF0) | (control_channel & 0xF);
-       msg[1] = control_additional;
+       int const gm = control_to_midi (controllable->get_value());
 
-       if (controllable->is_gain_like()) {
-               msg[2] = (byte) lrintf (gain_to_slider_position (controllable->get_value()) * 127.0f);
-       } else {
-               msg[2] = (byte) (control_to_midi(controllable->get_value()));
+       if (gm == last_value) {
+               return buf;
        }
 
-       _port.write (msg, 3, 0);
-}
+        DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Feedback: %1 %2\n", control_description(), current_uri()));
 
-MIDI::byte*
-MIDIControllable::write_feedback (MIDI::byte* buf, int32_t& bufsize, bool /*force*/)
-{
-       if (controllable && control_type != none && feedback && bufsize > 2) {
-
-               MIDI::byte gm;
-
-               if (controllable->is_gain_like()) {
-                       gm = (byte) lrintf (gain_to_slider_position (controllable->get_value()) * 127.0f);
-               } else {
-                       gm = (byte) (control_to_midi(controllable->get_value()));
-               }
-
-               if (gm != last_value) {
-                       *buf++ = (0xF0 & control_type) | (0xF & control_channel);
-                       *buf++ = control_additional; /* controller number */
-                       *buf++ = gm;
-                       last_value = gm;
-                       bufsize -= 3;
-               }
+       *buf++ = (0xF0 & control_type) | (0xF & control_channel);
+       int ev_size = 3;
+       switch (control_type) {
+       case MIDI::pitchbend:
+               *buf++ = int (gm) & 127;
+               *buf++ = (int (gm) >> 7) & 127;
+               break;
+       case MIDI::program:
+               *buf++ = control_additional; /* program number */
+               ev_size = 2;
+               break;
+       default:
+               *buf++ = control_additional; /* controller number */
+               *buf++ = gm;
+               break;
        }
+       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)));
+
+       last_value = gm;
+       bufsize -= ev_size;
 
        return buf;
 }
@@ -455,3 +604,17 @@ MIDIControllable::get_state ()
        return *node;
 }
 
+/** @return the maximum value for a control value transmitted
+ *  using a given MIDI::eventType.
+ */
+int
+MIDIControllable::max_value_for_type () const
+{
+       /* XXX: this is not complete */
+
+       if (control_type == MIDI::pitchbend) {
+               return 16383;
+       }
+
+       return 127;
+}