rework design of midi clock ticker to avoid expensive generalization that has turned...
[ardour.git] / libs / surfaces / generic_midi / midicontrollable.cc
index d960140958d7d6939375f73e6acc1cb46d174aec..226502f0ae2cc4b04a1064fbd1ce681bf312f264 100644 (file)
 
 */
 
-#define __STDC_FORMAT_MACROS 1
 #include <stdint.h>
-
-#include <cstdio> /* for sprintf, sigh */
+#include <cmath>
 #include <climits>
+#include <iostream>
 
 #include "pbd/error.h"
 #include "pbd/controllable_descriptor.h"
@@ -40,31 +39,32 @@ using namespace MIDI;
 using namespace PBD;
 using namespace ARDOUR;
 
-MIDIControllable::MIDIControllable (Port& p, bool is_bistate)
+MIDIControllable::MIDIControllable (Port& p, bool m)
        : controllable (0)
        , _descriptor (0)
        , _port (p)
-       , bistate (is_bistate)
+       , _momentary (m)
 {
        _learned = false; /* from URI */
        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;
        feedback = true; // for now
 }
 
-MIDIControllable::MIDIControllable (Port& p, Controllable& c, bool is_bistate)
+MIDIControllable::MIDIControllable (Port& p, Controllable& c, bool m)
        : controllable (&c)
        , _descriptor (0)
        , _port (p)
-       , bistate (is_bistate)
-
+       , _momentary (m)
 {
        _learned = true; /* from controllable */
        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;
@@ -125,7 +125,7 @@ void
 MIDIControllable::learn_about_external_control ()
 {
        drop_external_control ();
-       _port.input()->any.connect_same_thread (midi_learn_connection, boost::bind (&MIDIControllable::midi_receiver, this, _1, _2, _3));
+       _port.parser()->any.connect_same_thread (midi_learn_connection, boost::bind (&MIDIControllable::midi_receiver, this, _1, _2, _3));
 }
 
 void
@@ -135,18 +135,17 @@ MIDIControllable::stop_learning ()
 }
 
 float
-MIDIControllable::control_to_midi(float val)
+MIDIControllable::control_to_midi (float val)
 {
-       float control_min = 0.0f;
-       float control_max = 1.0f;
-       ARDOUR::AutomationControl* ac = dynamic_cast<ARDOUR::AutomationControl*>(controllable);
-       if (ac) {
-               control_min = ac->parameter().min();
-               control_max = ac->parameter().max();
-       }
+       const float midi_range = 127.0f; // TODO: NRPN etc.
+
+        if (controllable->is_gain_like()) {
+                return gain_to_slider_position (val/midi_range);
+        }
 
+       float control_min = controllable->lower ();
+       float control_max = controllable->upper ();
        const float control_range = control_max - control_min;
-       const float midi_range    = 127.0f; // TODO: NRPN etc.
 
        return (val - control_min) / control_range * midi_range;
 }
@@ -154,24 +153,24 @@ MIDIControllable::control_to_midi(float val)
 float
 MIDIControllable::midi_to_control(float val)
 {
-       float control_min = 0.0f;
-       float control_max = 1.0f;
-       ARDOUR::AutomationControl* ac = dynamic_cast<ARDOUR::AutomationControl*>(controllable);
+        /* 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
 
-       const float midi_range = 127.0f; // TODO: NRPN etc.
-       
-       if (ac) {
+           TODO: 14bit values
+        */
 
-               if (ac->is_gain_like()) {
-                       return slider_position_to_gain (val/midi_range);
-               }
-               
-               control_min = ac->parameter().min();
-               control_max = ac->parameter().max();
-       }
+        val = (val == 0.0f ? 0.0f : (val-1.0f) / 126.0f);
 
+        if (controllable->is_gain_like()) {
+                return slider_position_to_gain (val);
+        }
+
+       float control_min = controllable->lower ();
+       float control_max = controllable->upper ();
        const float control_range = control_max - control_min;
-       return  val / midi_range * control_range + control_min;
+
+       return  (val * control_range) + control_min;
 }
 
 void
@@ -187,23 +186,19 @@ MIDIControllable::midi_sense_note_off (Parser &p, EventTwoBytes *tb)
 }
 
 void
-MIDIControllable::midi_sense_note (Parser &, EventTwoBytes *msg, bool is_on)
+MIDIControllable::midi_sense_note (Parser &, EventTwoBytes *msg, bool /*is_on*/)
 {
        if (!controllable) { 
                return;
        }
 
-       if (!bistate) {
+
+       if (!controllable->is_toggle()) {
                controllable->set_value (msg->note_number/127.0);
        } else {
 
-               /* Note: parser handles the use of zero velocity to
-                  mean note off. if we get called with is_on=true, then we
-                  got a *real* note on.
-               */
-
-               if (msg->note_number == control_additional) {
-                       controllable->set_value (is_on ? 1 : 0);
+               if (control_additional == msg->note_number) {
+                       controllable->set_value (controllable->get_value() > 0.5f ? 0.0f : 1.0f);
                }
        }
 
@@ -222,10 +217,24 @@ MIDIControllable::midi_sense_controller (Parser &, EventTwoBytes *msg)
        }
 
        if (control_additional == msg->controller_number) {
-               if (!bistate) {
-                       controllable->set_value (midi_to_control(msg->value));
+
+               if (!controllable->is_toggle()) {
+                       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 = 10;
+
+                       // prevent jumps when MIDI controller and controllable are "out of sync"
+                       if (range < threshold &&
+                           controllable->get_value() <= midi_to_control(max_value) &&
+                           controllable->get_value() >= midi_to_control(min_value)) {
+                               controllable->set_value (midi_to_control (new_value) );
+                       }
+
+                       last_controllable_value = new_value;
                } else {
-                       if (msg->value > 64.0) {
+                       if (msg->value > 64.0f) {
                                controllable->set_value (1);
                        } else {
                                controllable->set_value (0);
@@ -242,12 +251,14 @@ MIDIControllable::midi_sense_program_change (Parser &, byte msg)
        if (!controllable) { 
                return;
        }
-       /* XXX program change messages make no sense for bistates */
 
-       if (!bistate) {
+       if (!controllable->is_toggle()) {
                controllable->set_value (msg/127.0);
-               last_value = (MIDI::byte) (controllable->get_value() * 127.0); // to prevent feedback fights
+       } else {
+               controllable->set_value (controllable->get_value() > 0.5f ? 0.0f : 1.0f);
        }
+
+       last_value = (MIDI::byte) (controllable->get_value() * 127.0); // to prevent feedback fights
 }
 
 void
@@ -257,11 +268,13 @@ MIDIControllable::midi_sense_pitchbend (Parser &, pitchbend_t pb)
                return;
        }
 
-       /* pitchbend messages make no sense for bistates */
-
-       /* XXX gack - get rid of assumption about typeof pitchbend_t */
+       if (!controllable->is_toggle()) {
+               /* XXX gack - get rid of assumption about typeof pitchbend_t */
+               controllable->set_value ((pb/(float) SHRT_MAX));
+       } else {
+               controllable->set_value (controllable->get_value() > 0.5f ? 0.0f : 1.0f);
+       }
 
-       controllable->set_value ((pb/(float) SHRT_MAX));
        last_value = (MIDI::byte) (controllable->get_value() * 127.0); // to prevent feedback fights
 }
 
@@ -276,7 +289,7 @@ MIDIControllable::midi_receiver (Parser &, byte *msg, size_t /*len*/)
 
        /* if the our port doesn't do input anymore, forget it ... */
 
-       if (!_port.input()) {
+       if (!_port.parser()) {
                return;
        }
 
@@ -296,22 +309,22 @@ MIDIControllable::bind_midi (channel_t chn, eventType ev, MIDI::byte additional)
        control_channel = chn;
        control_additional = additional;
 
-       if (_port.input() == 0) {
+       if (_port.parser() == 0) {
                return;
        }
 
-       Parser& p = *_port.input();
+       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));
 
-               /* if this is a bistate, connect to noteOn as well,
+               /* if this is a togglee, connect to noteOn as well,
                   and we'll toggle back and forth between the two.
                */
 
-               if (bistate) {
+               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));
                } 
 
@@ -320,7 +333,7 @@ MIDIControllable::bind_midi (channel_t chn, eventType ev, MIDI::byte additional)
 
        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));
-               if (bistate) {
+               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));
                }
                _control_description = "MIDI control: NoteOn";
@@ -333,17 +346,13 @@ MIDIControllable::bind_midi (channel_t chn, eventType ev, MIDI::byte additional)
                break;
 
        case MIDI::program:
-               if (!bistate) {
-                       p.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";
-               }
+               p.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:
-               if (!bistate) {
-                       p.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";
-               }
+               p.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:
@@ -356,13 +365,18 @@ MIDIControllable::send_feedback ()
 {
        byte msg[3];
 
-       if (setting || !feedback || control_type == none) {
+       if (!_learned || setting || !feedback || control_type == none || !controllable) {
                return;
        }
 
        msg[0] = (control_type & 0xF0) | (control_channel & 0xF);
        msg[1] = control_additional;
-       msg[2] = (byte) (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()));
+       }
 
        _port.write (msg, 3, 0);
 }
@@ -370,9 +384,15 @@ MIDIControllable::send_feedback ()
 MIDI::byte*
 MIDIControllable::write_feedback (MIDI::byte* buf, int32_t& bufsize, bool /*force*/)
 {
-       if (control_type != none && feedback && bufsize > 2) {
+       if (controllable && control_type != none && feedback && bufsize > 2) {
+
+               MIDI::byte gm;
 
-               MIDI::byte gm = (MIDI::byte) (control_to_midi(controllable->get_value()));
+               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);
@@ -431,9 +451,11 @@ MIDIControllable::get_state ()
 
        XMLNode* node = new XMLNode ("MIDIControllable");
 
-       if (!_current_uri.empty()) {
+       if (_current_uri.empty()) {
+                node->add_property ("id", controllable->id().to_s());
+       } else {
                node->add_property ("uri", _current_uri);
-       }
+        }
 
        if (controllable) {
                snprintf (buf, sizeof(buf), "0x%x", (int) control_type);