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