new PBD::ControllableDescriptor class to encapsulate parsing of binding URIs and...
[ardour.git] / libs / surfaces / generic_midi / midicontrollable.cc
index 75b5699f18bf7c3e460bce2ab5c810f338ba5c8e..d960140958d7d6939375f73e6acc1cb46d174aec 100644 (file)
@@ -1,6 +1,6 @@
 /*
     Copyright (C) 1998-2006 Paul Davis
+
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     the Free Software Foundation; either version 2 of the License, or
     along with this program; if not, write to the Free Software
     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 
-    $Id: midicontrollable.cc 629 2006-06-21 23:01:03Z paul $
 */
 
+#define __STDC_FORMAT_MACROS 1
+#include <stdint.h>
+
 #include <cstdio> /* for sprintf, sigh */
 #include <climits>
-#include <pbd/error.h>
-#include <pbd/xml++.h>
-#include <midi++/port.h>
-#include <midi++/channel.h>
+
+#include "pbd/error.h"
+#include "pbd/controllable_descriptor.h"
+#include "pbd/xml++.h"
+
+#include "midi++/port.h"
+#include "midi++/channel.h"
+
+#include "ardour/automation_control.h"
+#include "ardour/utils.h"
 
 #include "midicontrollable.h"
 
-using namespace sigc;
+using namespace std;
 using namespace MIDI;
 using namespace PBD;
 using namespace ARDOUR;
 
-MIDIControllable::MIDIControllable (Port& p, Controllable& c, bool is_bistate)
-       : controllable (c), _port (p), bistate (is_bistate)
+MIDIControllable::MIDIControllable (Port& p, bool is_bistate)
+       : controllable (0)
+       , _descriptor (0)
+       , _port (p)
+       , bistate (is_bistate)
 {
+       _learned = false; /* from URI */
        setting = false;
-       last_written = 0; // got a better idea ?
+       last_value = 0; // got a better idea ?
        control_type = none;
        _control_description = "MIDI Control: none";
        control_additional = (byte) -1;
-       connections = 0;
        feedback = true; // for now
-       
-       /* use channel 0 ("1") as the initial channel */
+}
+
+MIDIControllable::MIDIControllable (Port& p, Controllable& c, bool is_bistate)
+       : controllable (&c)
+       , _descriptor (0)
+       , _port (p)
+       , bistate (is_bistate)
 
-       midi_rebind (0);
+{
+       _learned = true; /* from controllable */
+       setting = false;
+       last_value = 0; // got a better idea ?
+       control_type = none;
+       _control_description = "MIDI Control: none";
+       control_additional = (byte) -1;
+       feedback = true; // for now
 }
 
 MIDIControllable::~MIDIControllable ()
@@ -53,24 +76,39 @@ MIDIControllable::~MIDIControllable ()
        drop_external_control ();
 }
 
+int
+MIDIControllable::init (const std::string& s)
+{
+       _current_uri = s;
+       delete _descriptor;
+       _descriptor = new ControllableDescriptor;
+       return _descriptor->set (s);
+}
+
 void
 MIDIControllable::midi_forget ()
 {
        /* stop listening for incoming messages, but retain
           our existing event + type information.
        */
-       
-       if (connections > 0) {
-               midi_sense_connection[0].disconnect ();
-       } 
-       
-       if (connections > 1) {
-               midi_sense_connection[1].disconnect ();
-       }
-       
-       connections = 0;
+
+       midi_sense_connection[0].disconnect ();
+       midi_sense_connection[1].disconnect ();
        midi_learn_connection.disconnect ();
-       
+}
+
+void
+MIDIControllable::drop_external_control ()
+{
+       midi_forget ();
+       control_type = none;
+       control_additional = (byte) -1;
+}
+
+void
+MIDIControllable::set_controllable (Controllable* c)
+{
+       controllable = c;
 }
 
 void
@@ -87,7 +125,7 @@ void
 MIDIControllable::learn_about_external_control ()
 {
        drop_external_control ();
-       midi_learn_connection = _port.input()->any.connect (mem_fun (*this, &MIDIControllable::midi_receiver));
+       _port.input()->any.connect_same_thread (midi_learn_connection, boost::bind (&MIDIControllable::midi_receiver, this, _1, _2, _3));
 }
 
 void
@@ -96,91 +134,139 @@ MIDIControllable::stop_learning ()
        midi_learn_connection.disconnect ();
 }
 
-void
-MIDIControllable::drop_external_control ()
+float
+MIDIControllable::control_to_midi(float val)
 {
-       if (connections > 0) {
-               midi_sense_connection[0].disconnect ();
-       } 
-       if (connections > 1) {
-               midi_sense_connection[1].disconnect ();
+       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();
        }
 
-       connections = 0;
-       midi_learn_connection.disconnect ();
+       const float control_range = control_max - control_min;
+       const float midi_range    = 127.0f; // TODO: NRPN etc.
 
-       control_type = none;
-       control_additional = (byte) -1;
+       return (val - control_min) / control_range * midi_range;
+}
+
+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);
+
+       const float midi_range = 127.0f; // TODO: NRPN etc.
+       
+       if (ac) {
+
+               if (ac->is_gain_like()) {
+                       return slider_position_to_gain (val/midi_range);
+               }
+               
+               control_min = ac->parameter().min();
+               control_max = ac->parameter().max();
+       }
+
+       const float control_range = control_max - control_min;
+       return  val / midi_range * control_range + control_min;
 }
 
-void 
-MIDIControllable::midi_sense_note_on (Parser &p, EventTwoBytes *tb) 
+void
+MIDIControllable::midi_sense_note_on (Parser &p, EventTwoBytes *tb)
 {
        midi_sense_note (p, tb, true);
 }
 
-void 
-MIDIControllable::midi_sense_note_off (Parser &p, EventTwoBytes *tb) 
+void
+MIDIControllable::midi_sense_note_off (Parser &p, EventTwoBytes *tb)
 {
        midi_sense_note (p, tb, false);
 }
 
 void
-MIDIControllable::midi_sense_note (Parser &p, EventTwoBytes *msg, bool is_on)
+MIDIControllable::midi_sense_note (Parser &, EventTwoBytes *msg, bool is_on)
 {
+       if (!controllable) { 
+               return;
+       }
+
        if (!bistate) {
-               controllable.set_value (msg->note_number/127.0);
+               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.  
+                  got a *real* note on.
                */
 
                if (msg->note_number == control_additional) {
-                       controllable.set_value (is_on ? 1 : 0);
+                       controllable->set_value (is_on ? 1 : 0);
                }
        }
+
+       last_value = (MIDI::byte) (controllable->get_value() * 127.0); // to prevent feedback fights
 }
 
 void
 MIDIControllable::midi_sense_controller (Parser &, EventTwoBytes *msg)
 {
+       if (!controllable) { 
+               return;
+       }
+
+       if (controllable->touching()) {
+               return; // to prevent feedback fights when e.g. dragging a UI slider
+       }
+
        if (control_additional == msg->controller_number) {
                if (!bistate) {
-                       controllable.set_value (msg->value/127.0);
+                       controllable->set_value (midi_to_control(msg->value));
                } else {
                        if (msg->value > 64.0) {
-                               controllable.set_value (1);
+                               controllable->set_value (1);
                        } else {
-                               controllable.set_value (0);
+                               controllable->set_value (0);
                        }
                }
+
+               last_value = (MIDI::byte) (control_to_midi(controllable->get_value())); // to prevent feedback fights
        }
 }
 
 void
-MIDIControllable::midi_sense_program_change (Parser &p, byte msg)
+MIDIControllable::midi_sense_program_change (Parser &, byte msg)
 {
+       if (!controllable) { 
+               return;
+       }
        /* XXX program change messages make no sense for bistates */
 
        if (!bistate) {
-               controllable.set_value (msg/127.0);
-       } 
+               controllable->set_value (msg/127.0);
+               last_value = (MIDI::byte) (controllable->get_value() * 127.0); // to prevent feedback fights
+       }
 }
 
 void
-MIDIControllable::midi_sense_pitchbend (Parser &p, pitchbend_t pb)
+MIDIControllable::midi_sense_pitchbend (Parser &, pitchbend_t pb)
 {
+       if (!controllable) { 
+               return;
+       }
+
        /* pitchbend messages make no sense for bistates */
 
        /* XXX gack - get rid of assumption about typeof pitchbend_t */
 
-       controllable.set_value ((pb/(float) SHRT_MAX));
-}                      
+       controllable->set_value ((pb/(float) SHRT_MAX));
+       last_value = (MIDI::byte) (controllable->get_value() * 127.0); // to prevent feedback fights
+}
 
 void
-MIDIControllable::midi_receiver (Parser &p, byte *msg, size_t len)
+MIDIControllable::midi_receiver (Parser &, byte *msg, size_t /*len*/)
 {
        /* we only respond to channel messages */
 
@@ -196,7 +282,7 @@ MIDIControllable::midi_receiver (Parser &p, byte *msg, size_t len)
 
        bind_midi ((channel_t) (msg[0] & 0xf), eventType (msg[0] & 0xF0), msg[1]);
 
-       controllable.LearningFinished ();
+       controllable->LearningFinished ();
 }
 
 void
@@ -213,65 +299,49 @@ MIDIControllable::bind_midi (channel_t chn, eventType ev, MIDI::byte additional)
        if (_port.input() == 0) {
                return;
        }
-       
+
        Parser& p = *_port.input();
 
        int chn_i = chn;
        switch (ev) {
        case MIDI::off:
-               midi_sense_connection[0] = p.channel_note_off[chn_i].connect
-                       (mem_fun (*this, &MIDIControllable::midi_sense_note_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,
                   and we'll toggle back and forth between the two.
                */
 
                if (bistate) {
-                       midi_sense_connection[1] = p.channel_note_on[chn_i].connect
-                               (mem_fun (*this, &MIDIControllable::midi_sense_note_on));
-                       connections = 2;
-               } else {
-                       connections = 1;
-               }
+                       p.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:
-               midi_sense_connection[0] = p.channel_note_on[chn_i].connect
-                       (mem_fun (*this, &MIDIControllable::midi_sense_note_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) {
-                       midi_sense_connection[1] = p.channel_note_off[chn_i].connect 
-                               (mem_fun (*this, &MIDIControllable::midi_sense_note_off));
-                       connections = 2;
-               } else {
-                       connections = 1;
+                       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";
                break;
-
+               
        case MIDI::controller:
-               midi_sense_connection[0] = p.channel_controller[chn_i].connect 
-                       (mem_fun (*this, &MIDIControllable::midi_sense_controller));
-               connections = 1;
+               p.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:
                if (!bistate) {
-                       midi_sense_connection[0] = p.channel_program_change[chn_i].connect
-                               (mem_fun (*this, 
-                                      &MIDIControllable::midi_sense_program_change));
-                       connections = 1;
+                       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) {
-                       midi_sense_connection[0] = p.channel_pitchbend[chn_i].connect
-                               (mem_fun (*this, &MIDIControllable::midi_sense_pitchbend));
-                       connections = 1;
+                       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;
@@ -289,35 +359,35 @@ MIDIControllable::send_feedback ()
        if (setting || !feedback || control_type == none) {
                return;
        }
-       
-       msg[0] = (control_type & 0xF0) | (control_channel & 0xF); 
+
+       msg[0] = (control_type & 0xF0) | (control_channel & 0xF);
        msg[1] = control_additional;
-       msg[2] = (byte) (controllable.get_value() * 127.0f);
+       msg[2] = (byte) (control_to_midi(controllable->get_value()));
 
-       //_port.write (msg, 3);
+       _port.write (msg, 3, 0);
 }
 
 MIDI::byte*
-MIDIControllable::write_feedback (MIDI::byte* buf, int32_t& bufsize, bool force)
+MIDIControllable::write_feedback (MIDI::byte* buf, int32_t& bufsize, bool /*force*/)
 {
        if (control_type != none && feedback && bufsize > 2) {
 
-               MIDI::byte gm = (MIDI::byte) (controllable.get_value() * 127.0);
-               
-               if (gm != last_written) {
+               MIDI::byte gm = (MIDI::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_written = gm;
+                       last_value = gm;
                        bufsize -= 3;
                }
        }
-       
+
        return buf;
 }
 
-int 
-MIDIControllable::set_state (const XMLNode& node)
+int
+MIDIControllable::set_state (const XMLNode& node, int /*version*/)
 {
        const XMLProperty* prop;
        int xx;
@@ -350,7 +420,7 @@ MIDIControllable::set_state (const XMLNode& node)
        }
 
        bind_midi (control_channel, control_type, control_additional);
-       
+
        return 0;
 }
 
@@ -358,16 +428,23 @@ XMLNode&
 MIDIControllable::get_state ()
 {
        char buf[32];
-       XMLNode& node (controllable.get_state ());
 
-       snprintf (buf, sizeof(buf), "0x%x", (int) control_type);
-       node.add_property ("event", buf);
-       snprintf (buf, sizeof(buf), "%d", (int) control_channel);
-       node.add_property ("channel", buf);
-       snprintf (buf, sizeof(buf), "0x%x", (int) control_additional);
-       node.add_property ("additional", buf);
-       node.add_property ("feedback", (feedback ? "yes" : "no"));
+       XMLNode* node = new XMLNode ("MIDIControllable");
+
+       if (!_current_uri.empty()) {
+               node->add_property ("uri", _current_uri);
+       }
+
+       if (controllable) {
+               snprintf (buf, sizeof(buf), "0x%x", (int) control_type);
+               node->add_property ("event", buf);
+               snprintf (buf, sizeof(buf), "%d", (int) control_channel);
+               node->add_property ("channel", buf);
+               snprintf (buf, sizeof(buf), "0x%x", (int) control_additional);
+               node->add_property ("additional", buf);
+               node->add_property ("feedback", (feedback ? "yes" : "no"));
+       }
 
-       return node;
+       return *node;
 }