libs/surfaces/generic_midi/midicontrollable.cc

   1 /*
   2     Copyright (C) 1998-2006 Paul Davis
   3
   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.
   8
   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.
  13
  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.
  17
  18 */
  19
  20 #include <stdint.h>
  21 #include <cmath>
  22 #include <climits>
  23 #include <iostream>
  24
  25 #include "pbd/error.h"
  26 #include "pbd/controllable_descriptor.h"
  27 #include "pbd/xml++.h"
  28
  29 #include "midi++/port.h"
  30 #include "midi++/channel.h"
  31
  32 #include "ardour/automation_control.h"
  33 #include "ardour/utils.h"
  34
  35 #include "midicontrollable.h"
  36 #include "generic_midi_control_protocol.h"
  37
  38 using namespace std;
  39 using namespace MIDI;
  40 using namespace PBD;
  41 using namespace ARDOUR;
  42
  43 MIDIControllable::MIDIControllable (GenericMidiControlProtocol* s, Port& p, bool m)
  44         : _surface (s)
  45         , controllable (0)
  46         , _descriptor (0)
  47         , _port (p)
  48         , _momentary (m)
  49 {
  50         _learned = false; /* from URI */
  51         setting = false;
  52         last_value = 0; // got a better idea ?
  53         last_controllable_value = 0.0f;
  54         control_type = none;
  55         _control_description = "MIDI Control: none";
  56         control_additional = (byte) -1;
  57         feedback = true; // for now
  58 }
  59
  60 MIDIControllable::MIDIControllable (GenericMidiControlProtocol* s, Port& p, Controllable& c, bool m)
  61         : _surface (s)
  62         , controllable (&c)
  63         , _descriptor (0)
  64         , _port (p)
  65         , _momentary (m)
  66 {
  67         _learned = true; /* from controllable */
  68         setting = false;
  69         last_value = 0; // got a better idea ?
  70         last_controllable_value = 0.0f;
  71         control_type = none;
  72         _control_description = "MIDI Control: none";
  73         control_additional = (byte) -1;
  74         feedback = true; // for now
  75 }
  76
  77 MIDIControllable::~MIDIControllable ()
  78 {
  79         drop_external_control ();
  80 }
  81
  82 int
  83 MIDIControllable::init (const std::string& s)
  84 {
  85         _current_uri = s;
  86         delete _descriptor;
  87         _descriptor = new ControllableDescriptor;
  88         return _descriptor->set (s);
  89 }
  90
  91 void
  92 MIDIControllable::midi_forget ()
  93 {
  94         /* stop listening for incoming messages, but retain
  95            our existing event + type information.
  96         */
  97
  98         midi_sense_connection[0].disconnect ();
  99         midi_sense_connection[1].disconnect ();
 100         midi_learn_connection.disconnect ();
 101 }
 102
 103 void
 104 MIDIControllable::drop_external_control ()
 105 {
 106         midi_forget ();
 107         control_type = none;
 108         control_additional = (byte) -1;
 109 }
 110
 111 void
 112 MIDIControllable::set_controllable (Controllable* c)
 113 {
 114         controllable = c;
 115 }
 116
 117 void
 118 MIDIControllable::midi_rebind (channel_t c)
 119 {
 120         if (c >= 0) {
 121                 bind_midi (c, control_type, control_additional);
 122         } else {
 123                 midi_forget ();
 124         }
 125 }
 126
 127 void
 128 MIDIControllable::learn_about_external_control ()
 129 {
 130         drop_external_control ();
 131         _port.parser()->any.connect_same_thread (midi_learn_connection, boost::bind (&MIDIControllable::midi_receiver, this, _1, _2, _3));
 132 }
 133
 134 void
 135 MIDIControllable::stop_learning ()
 136 {
 137         midi_learn_connection.disconnect ();
 138 }
 139
 140 int
 141 MIDIControllable::control_to_midi (float val)
 142 {
 143         if (controllable->is_gain_like()) {
 144                 return gain_to_slider_position (val) * max_value_for_type ();
 145         }
 146
 147         float control_min = controllable->lower ();
 148         float control_max = controllable->upper ();
 149         const float control_range = control_max - control_min;
 150
 151         return (val - control_min) / control_range * max_value_for_type ();
 152 }
 153
 154 float
 155 MIDIControllable::midi_to_control (int val)
 156 {
 157         /* fiddle with MIDI value so that we get an odd number of integer steps
 158            and can thus represent "middle" precisely as 0.5. this maps to
 159            the range 0..+1.0
 160         */
 161
 162         float fv = (val == 0 ? 0 : float (val - 1) / (max_value_for_type() - 1));
 163
 164         if (controllable->is_gain_like()) {
 165                 return slider_position_to_gain (fv);
 166         }
 167
 168         float control_min = controllable->lower ();
 169         float control_max = controllable->upper ();
 170         const float control_range = control_max - control_min;
 171
 172         return (fv * control_range) + control_min;
 173 }
 174
 175 void
 176 MIDIControllable::midi_sense_note_on (Parser &p, EventTwoBytes *tb)
 177 {
 178         midi_sense_note (p, tb, true);
 179 }
 180
 181 void
 182 MIDIControllable::midi_sense_note_off (Parser &p, EventTwoBytes *tb)
 183 {
 184         midi_sense_note (p, tb, false);
 185 }
 186
 187 int
 188 MIDIControllable::lookup_controllable()
 189 {
 190         if (!_descriptor) {
 191                 return -1;
 192         }
 193
 194         boost::shared_ptr<Controllable> c = _surface->lookup_controllable (*_descriptor);
 195
 196         if (!c) {
 197                 return -1;
 198         }
 199
 200         controllable = c.get();
 201
 202         return 0;
 203 }
 204
 205 void
 206 MIDIControllable::midi_sense_note (Parser &, EventTwoBytes *msg, bool /*is_on*/)
 207 {
 208         if (!controllable) {
 209                 if (lookup_controllable()) {
 210                         return;
 211                 }
 212         }
 213
 214         if (!controllable->is_toggle()) {
 215                 controllable->set_value (midi_to_control (msg->note_number));
 216         } else {
 217                 if (control_additional == msg->note_number) {
 218                         controllable->set_value (controllable->get_value() > 0.5f ? 0.0f : 1.0f);
 219                 }
 220         }
 221
 222         last_value = (MIDI::byte) (controllable->get_value() * 127.0); // to prevent feedback fights
 223 }
 224
 225 void
 226 MIDIControllable::midi_sense_controller (Parser &, EventTwoBytes *msg)
 227 {
 228         if (!controllable) {
 229                 if (lookup_controllable ()) {
 230                         return;
 231                 }
 232         }
 233
 234         if (controllable->touching()) {
 235                 return; // to prevent feedback fights when e.g. dragging a UI slider
 236         }
 237
 238         if (control_additional == msg->controller_number) {
 239
 240                 if (!controllable->is_toggle()) {
 241                         float new_value = msg->value;
 242                         float max_value = max(last_controllable_value, new_value);
 243                         float min_value = min(last_controllable_value, new_value);
 244                         float range = max_value - min_value;
 245                         float threshold = (float) _surface->threshold ();
 246
 247                         bool const in_sync = (
 248                                 range < threshold &&
 249                                 controllable->get_value() <= midi_to_control(max_value) &&
 250                                 controllable->get_value() >= midi_to_control(min_value)
 251                                 );
 252
 253                         /* If the surface is not motorised, we try to prevent jumps when
 254                            the MIDI controller and controllable are out of sync.
 255                            There might be a better way of doing this.
 256                         */
 257
 258                         if (in_sync || _surface->motorised ()) {
 259                                 controllable->set_value (midi_to_control (new_value));
 260                         }
 261
 262                         last_controllable_value = new_value;
 263                 } else {
 264                         if (msg->value > 64.0f) {
 265                                 controllable->set_value (1);
 266                         } else {
 267                                 controllable->set_value (0);
 268                         }
 269                 }
 270
 271                 last_value = (MIDI::byte) (control_to_midi(controllable->get_value())); // to prevent feedback fights
 272         }
 273 }
 274
 275 void
 276 MIDIControllable::midi_sense_program_change (Parser &, byte msg)
 277 {
 278         if (!controllable) {
 279                 if (lookup_controllable ()) {
 280                         return;
 281                 }
 282         }
 283
 284         if (!controllable->is_toggle()) {
 285                 controllable->set_value (midi_to_control (msg));
 286         } else if (msg == control_additional) {
 287                 controllable->set_value (controllable->get_value() > 0.5f ? 0.0f : 1.0f);
 288         }
 289
 290         last_value = (MIDI::byte) (controllable->get_value() * 127.0); // to prevent feedback fights
 291 }
 292
 293 void
 294 MIDIControllable::midi_sense_pitchbend (Parser &, pitchbend_t pb)
 295 {
 296         if (!controllable) {
 297                 if (lookup_controllable ()) {
 298                         return;
 299                 }
 300         }
 301
 302         if (!controllable->is_toggle()) {
 303                 controllable->set_value (midi_to_control (pb));
 304         } else {
 305                 controllable->set_value (controllable->get_value() > 0.5f ? 0.0f : 1.0f);
 306         }
 307
 308         last_value = control_to_midi (controllable->get_value ());
 309 }
 310
 311 void
 312 MIDIControllable::midi_receiver (Parser &, byte *msg, size_t /*len*/)
 313 {
 314         /* we only respond to channel messages */
 315
 316         if ((msg[0] & 0xF0) < 0x80 || (msg[0] & 0xF0) > 0xE0) {
 317                 return;
 318         }
 319
 320         /* if the our port doesn't do input anymore, forget it ... */
 321
 322         if (!_port.parser()) {
 323                 return;
 324         }
 325
 326         bind_midi ((channel_t) (msg[0] & 0xf), eventType (msg[0] & 0xF0), msg[1]);
 327
 328         if (controllable) {
 329                 controllable->LearningFinished ();
 330         }
 331 }
 332
 333 void
 334 MIDIControllable::bind_midi (channel_t chn, eventType ev, MIDI::byte additional)
 335 {
 336         char buf[64];
 337
 338         drop_external_control ();
 339
 340         control_type = ev;
 341         control_channel = chn;
 342         control_additional = additional;
 343
 344         if (_port.parser() == 0) {
 345                 return;
 346         }
 347
 348         Parser& p = *_port.parser();
 349
 350         int chn_i = chn;
 351         switch (ev) {
 352         case MIDI::off:
 353                 p.channel_note_off[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::midi_sense_note_off, this, _1, _2));
 354
 355                 /* if this is a togglee, connect to noteOn as well,
 356                    and we'll toggle back and forth between the two.
 357                 */
 358
 359                 if (_momentary) {
 360                         p.channel_note_on[chn_i].connect_same_thread (midi_sense_connection[1], boost::bind (&MIDIControllable::midi_sense_note_on, this, _1, _2));
 361                 }
 362
 363                 _control_description = "MIDI control: NoteOff";
 364                 break;
 365
 366         case MIDI::on:
 367                 p.channel_note_on[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::midi_sense_note_on, this, _1, _2));
 368                 if (_momentary) {
 369                         p.channel_note_off[chn_i].connect_same_thread (midi_sense_connection[1], boost::bind (&MIDIControllable::midi_sense_note_off, this, _1, _2));
 370                 }
 371                 _control_description = "MIDI control: NoteOn";
 372                 break;
 373
 374         case MIDI::controller:
 375                 p.channel_controller[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::midi_sense_controller, this, _1, _2));
 376                 snprintf (buf, sizeof (buf), "MIDI control: Controller %d", control_additional);
 377                 _control_description = buf;
 378                 break;
 379
 380         case MIDI::program:
 381                 p.channel_program_change[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::midi_sense_program_change, this, _1, _2));
 382                 _control_description = "MIDI control: ProgramChange";
 383                 break;
 384
 385         case MIDI::pitchbend:
 386                 p.channel_pitchbend[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::midi_sense_pitchbend, this, _1, _2));
 387                 _control_description = "MIDI control: Pitchbend";
 388                 break;
 389
 390         default:
 391                 break;
 392         }
 393 }
 394
 395 MIDI::byte*
 396 MIDIControllable::write_feedback (MIDI::byte* buf, int32_t& bufsize, bool /*force*/)
 397 {
 398         if (!controllable || control_type == none || !feedback || bufsize <= 2) {
 399                 return buf;
 400         }
 401
 402         int const gm = control_to_midi (controllable->get_value());
 403
 404         if (gm == last_value) {
 405                 return buf;
 406         }
 407
 408         *buf++ = (0xF0 & control_type) | (0xF & control_channel);
 409
 410         switch (control_type) {
 411         case MIDI::pitchbend:
 412                 *buf++ = int (gm) & 127;
 413                 *buf++ = (int (gm) >> 7) & 127;
 414                 break;
 415         default:
 416                 *buf++ = control_additional; /* controller number */
 417                 *buf++ = gm;
 418                 break;
 419         }
 420
 421         last_value = gm;
 422         bufsize -= 3;
 423
 424         return buf;
 425 }
 426
 427 int
 428 MIDIControllable::set_state (const XMLNode& node, int /*version*/)
 429 {
 430         const XMLProperty* prop;
 431         int xx;
 432
 433         if ((prop = node.property ("event")) != 0) {
 434                 sscanf (prop->value().c_str(), "0x%x", &xx);
 435                 control_type = (MIDI::eventType) xx;
 436         } else {
 437                 return -1;
 438         }
 439
 440         if ((prop = node.property ("channel")) != 0) {
 441                 sscanf (prop->value().c_str(), "%d", &xx);
 442                 control_channel = (MIDI::channel_t) xx;
 443         } else {
 444                 return -1;
 445         }
 446
 447         if ((prop = node.property ("additional")) != 0) {
 448                 sscanf (prop->value().c_str(), "0x%x", &xx);
 449                 control_additional = (MIDI::byte) xx;
 450         } else {
 451                 return -1;
 452         }
 453
 454         if ((prop = node.property ("feedback")) != 0) {
 455                 feedback = (prop->value() == "yes");
 456         } else {
 457                 feedback = true; // default
 458         }
 459
 460         bind_midi (control_channel, control_type, control_additional);
 461
 462         return 0;
 463 }
 464
 465 XMLNode&
 466 MIDIControllable::get_state ()
 467 {
 468         char buf[32];
 469
 470         XMLNode* node = new XMLNode ("MIDIControllable");
 471
 472         if (_current_uri.empty()) {
 473                 node->add_property ("id", controllable->id().to_s());
 474         } else {
 475                 node->add_property ("uri", _current_uri);
 476         }
 477
 478         if (controllable) {
 479                 snprintf (buf, sizeof(buf), "0x%x", (int) control_type);
 480                 node->add_property ("event", buf);
 481                 snprintf (buf, sizeof(buf), "%d", (int) control_channel);
 482                 node->add_property ("channel", buf);
 483                 snprintf (buf, sizeof(buf), "0x%x", (int) control_additional);
 484                 node->add_property ("additional", buf);
 485                 node->add_property ("feedback", (feedback ? "yes" : "no"));
 486         }
 487
 488         return *node;
 489 }
 490
 491 /** @return the maximum value for a control value transmitted
 492  *  using a given MIDI::eventType.
 493  */
 494 int
 495 MIDIControllable::max_value_for_type () const
 496 {
 497         /* XXX: this is not complete */
 498
 499         if (control_type == MIDI::pitchbend) {
 500                 return 16383;
 501         }
 502
 503         return 127;
 504 }