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/compose.h"
  27 #include "pbd/stacktrace.h"
  28 #include "pbd/types_convert.h"
  29 #include "pbd/xml++.h"
  30
  31 #include "midi++/types.h" // Added by JE - 06-01-2009. All instances of 'byte' changed to 'MIDI::byte' (for clarification)
  32 #include "midi++/port.h"
  33 #include "midi++/channel.h"
  34
  35 #include "ardour/async_midi_port.h"
  36 #include "ardour/automation_control.h"
  37 #include "ardour/midi_ui.h"
  38 #include "ardour/debug.h"
  39
  40 #include "midicontrollable.h"
  41 #include "generic_midi_control_protocol.h"
  42
  43 using namespace std;
  44 using namespace MIDI;
  45 using namespace PBD;
  46 using namespace ARDOUR;
  47
  48 MIDIControllable::MIDIControllable (GenericMidiControlProtocol* s, MIDI::Parser& p, bool m)
  49         : _surface (s)
  50         , controllable (0)
  51         , _parser (p)
  52         , _momentary (m)
  53 {
  54         _learned = false; /* from URI */
  55         _ctltype = Ctl_Momentary;
  56         _encoder = No_enc;
  57         setting = false;
  58         last_value = 0; // got a better idea ?
  59         last_incoming = 256; // any out of band value
  60         last_controllable_value = 0.0f;
  61         control_type = none;
  62         control_rpn = -1;
  63         control_nrpn = -1;
  64         _control_description = "MIDI Control: none";
  65         control_additional = (MIDI::byte) -1;
  66 }
  67
  68 MIDIControllable::MIDIControllable (GenericMidiControlProtocol* s, MIDI::Parser& p, Controllable& c, bool m)
  69         : _surface (s)
  70         , _parser (p)
  71         , _momentary (m)
  72 {
  73         set_controllable (&c);
  74
  75         _learned = true; /* from controllable */
  76         _ctltype = Ctl_Momentary;
  77         _encoder = No_enc;
  78         setting = false;
  79         last_value = 0; // got a better idea ?
  80         last_controllable_value = 0.0f;
  81         control_type = none;
  82         control_rpn = -1;
  83         control_nrpn = -1;
  84         _control_description = "MIDI Control: none";
  85         control_additional = (MIDI::byte) -1;
  86 }
  87
  88 MIDIControllable::~MIDIControllable ()
  89 {
  90         drop_external_control ();
  91 }
  92
  93 int
  94 MIDIControllable::init (const std::string& s)
  95 {
  96         _current_uri = s;
  97         return 0;
  98 }
  99
 100 void
 101 MIDIControllable::midi_forget ()
 102 {
 103         /* stop listening for incoming messages, but retain
 104            our existing event + type information.
 105         */
 106
 107         midi_sense_connection[0].disconnect ();
 108         midi_sense_connection[1].disconnect ();
 109         midi_learn_connection.disconnect ();
 110 }
 111
 112 void
 113 MIDIControllable::drop_external_control ()
 114 {
 115         midi_forget ();
 116         control_rpn = -1;
 117         control_nrpn = -1;
 118         control_type = none;
 119         control_additional = (MIDI::byte) -1;
 120 }
 121
 122 void
 123 MIDIControllable::set_controllable (Controllable* c)
 124 {
 125         if (c == controllable) {
 126                 return;
 127         }
 128
 129         controllable_death_connection.disconnect ();
 130
 131         controllable = c;
 132
 133         if (controllable) {
 134                 last_controllable_value = controllable->get_value();
 135         } else {
 136                 last_controllable_value = 0.0f; // is there a better value?
 137         }
 138
 139         last_incoming = 256;
 140
 141         if (controllable) {
 142                 controllable->Destroyed.connect (controllable_death_connection, MISSING_INVALIDATOR,
 143                                                  boost::bind (&MIDIControllable::drop_controllable, this, _1),
 144                                                  MidiControlUI::instance());
 145         }
 146 }
 147
 148 void
 149 MIDIControllable::midi_rebind (channel_t c)
 150 {
 151         if (c >= 0) {
 152                 bind_midi (c, control_type, control_additional);
 153         } else {
 154                 midi_forget ();
 155         }
 156 }
 157
 158 void
 159 MIDIControllable::learn_about_external_control ()
 160 {
 161         drop_external_control ();
 162         _parser.any.connect_same_thread (midi_learn_connection, boost::bind (&MIDIControllable::midi_receiver, this, _1, _2, _3));
 163 }
 164
 165 void
 166 MIDIControllable::stop_learning ()
 167 {
 168         midi_learn_connection.disconnect ();
 169 }
 170
 171 int
 172 MIDIControllable::control_to_midi (float val)
 173 {
 174         if (controllable->is_gain_like()) {
 175                 return controllable->internal_to_interface (val) * max_value_for_type ();
 176         }
 177
 178         float control_min = controllable->lower ();
 179         float control_max = controllable->upper ();
 180         float control_range = control_max - control_min;
 181
 182         if (controllable->is_toggle()) {
 183                 if (val >= (control_min + (control_range/2.0f))) {
 184                         return max_value_for_type();
 185                 } else {
 186                         return 0;
 187                 }
 188         } else {
 189                 AutomationControl *actl = dynamic_cast<AutomationControl*> (controllable);
 190                 if (actl) {
 191                         control_min = actl->internal_to_interface(control_min);
 192                         control_max = actl->internal_to_interface(control_max);
 193                         control_range = control_max - control_min;
 194                         val = actl->internal_to_interface(val);
 195                 }
 196         }
 197         // fiddle value of max so value doesn't jump from 125 to 127 for 1.0
 198         // otherwise decrement won't work.
 199         return (val - control_min) / control_range * (max_value_for_type () - 1);
 200 }
 201
 202 float
 203 MIDIControllable::midi_to_control (int val)
 204 {
 205         /* fiddle with MIDI value so that we get an odd number of integer steps
 206                 and can thus represent "middle" precisely as 0.5. this maps to
 207                 the range 0..+1.0 (0 to 126)
 208         */
 209
 210         float fv = (val == 0 ? 0 : float (val - 1) / (max_value_for_type() - 1));
 211
 212         if (controllable->is_gain_like()) {
 213                 return controllable->interface_to_internal (fv);
 214         }
 215         DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Raw value %1 float %2\n", val, fv));
 216
 217         float control_min = controllable->lower ();
 218         float control_max = controllable->upper ();
 219         float control_range = control_max - control_min;
 220         DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Min %1 Max %2 Range %3\n", control_min, control_max, control_range));
 221
 222         AutomationControl *actl = dynamic_cast<AutomationControl*> (controllable);
 223         if (actl) {
 224                 if (fv == 0.f) return control_min;
 225                 if (fv == 1.f) return control_max;
 226                 control_min = actl->internal_to_interface(control_min);
 227                 control_max = actl->internal_to_interface(control_max);
 228                 control_range = control_max - control_min;
 229                 return actl->interface_to_internal((fv * control_range) + control_min);
 230         }
 231         return (fv * control_range) + control_min;
 232 }
 233
 234 void
 235 MIDIControllable::midi_sense_note_on (Parser &p, EventTwoBytes *tb)
 236 {
 237         midi_sense_note (p, tb, true);
 238 }
 239
 240 void
 241 MIDIControllable::midi_sense_note_off (Parser &p, EventTwoBytes *tb)
 242 {
 243         midi_sense_note (p, tb, false);
 244 }
 245
 246 int
 247 MIDIControllable::lookup_controllable()
 248 {
 249         if (_current_uri.empty()) {
 250                 return -1;
 251         }
 252
 253         boost::shared_ptr<Controllable> c = _surface->lookup_controllable (_current_uri);
 254
 255         if (!c) {
 256                 return -1;
 257         }
 258
 259         set_controllable (c.get ());
 260
 261         return 0;
 262 }
 263
 264 void
 265 MIDIControllable::drop_controllable (Controllable* c)
 266 {
 267         if (c == controllable) {
 268                 set_controllable (0);
 269         }
 270 }
 271
 272 void
 273 MIDIControllable::midi_sense_note (Parser &, EventTwoBytes *msg, bool /*is_on*/)
 274 {
 275         if (!controllable) {
 276                 if (lookup_controllable()) {
 277                         return;
 278                 }
 279         }
 280
 281         _surface->maybe_start_touch (controllable);
 282
 283         if (!controllable->is_toggle()) {
 284                 if (control_additional == msg->note_number) {
 285                         controllable->set_value (midi_to_control (msg->velocity), Controllable::UseGroup);
 286                         DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Note %1 value %2  %3\n", (int) msg->note_number, (float) midi_to_control (msg->velocity), current_uri() ));
 287                 }
 288         } else {
 289                 if (control_additional == msg->note_number) {
 290                         float new_value = controllable->get_value() > 0.5f ? 0.0f : 1.0f;
 291                         controllable->set_value (new_value, Controllable::UseGroup);
 292                         DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Note %1 Value %2  %3\n", (int) msg->note_number, (float) new_value, current_uri()));
 293                 }
 294         }
 295
 296         last_value = (MIDI::byte) (controllable->get_value() * 127.0); // to prevent feedback fights
 297 }
 298
 299 void
 300 MIDIControllable::midi_sense_controller (Parser &, EventTwoBytes *msg)
 301 {
 302         if (!controllable) {
 303                 if (lookup_controllable ()) {
 304                         return;
 305                 }
 306         }
 307
 308         assert (controllable);
 309
 310         _surface->maybe_start_touch (controllable);
 311
 312         if (control_additional == msg->controller_number) {
 313
 314                 if (!controllable->is_toggle()) {
 315                         if (get_encoder() == No_enc) {
 316                                 float new_value = msg->value;
 317                                 float max_value = max(last_controllable_value, new_value);
 318                                 float min_value = min(last_controllable_value, new_value);
 319                                 float range = max_value - min_value;
 320                                 float threshold = (float) _surface->threshold ();
 321
 322                                 bool const in_sync = (
 323                                         range < threshold &&
 324                                         controllable->get_value() <= midi_to_control(max_value) &&
 325                                         controllable->get_value() >= midi_to_control(min_value)
 326                                         );
 327
 328                                 /* If the surface is not motorised, we try to prevent jumps when
 329                                    the MIDI controller and controllable are out of sync.
 330                                    There might be a better way of doing this.
 331                                 */
 332
 333                                 if (in_sync || _surface->motorised ()) {
 334                                         controllable->set_value (midi_to_control (new_value), Controllable::UseGroup);
 335                                 }
 336                                 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() ));
 337
 338                                 last_controllable_value = new_value;
 339                         } else {
 340                                 int offset = (msg->value & 0x3f);
 341                                 switch (get_encoder()) {
 342                                         case Enc_L:
 343                                                 if (msg->value > 0x40) {
 344                                                         controllable->set_value (midi_to_control (last_value - offset + 1), Controllable::UseGroup);
 345                                                 } else {
 346                                                         controllable->set_value (midi_to_control (last_value + offset + 1), Controllable::UseGroup);
 347                                                 }
 348                                                 break;
 349                                         case Enc_R:
 350                                                 if (msg->value > 0x40) {
 351                                                         controllable->set_value (midi_to_control (last_value + offset + 1), Controllable::UseGroup);
 352                                                 } else {
 353                                                         controllable->set_value (midi_to_control (last_value - offset + 1), Controllable::UseGroup);
 354                                                 }
 355                                                 break;
 356                                         case Enc_2:
 357                                                 if (msg->value > 0x40) {
 358                                                         controllable->set_value (midi_to_control (last_value - (0x7f - msg->value) + 1), Controllable::UseGroup);
 359                                                 } else {
 360                                                         controllable->set_value (midi_to_control (last_value + offset + 1), Controllable::UseGroup);
 361                                                 }
 362                                                 break;
 363                                         case Enc_B:
 364                                                 if (msg->value > 0x40) {
 365                                                         controllable->set_value (midi_to_control (last_value + offset + 1), Controllable::UseGroup);
 366                                                 } else {
 367                                                         controllable->set_value (midi_to_control (last_value - (0x40 - offset)), Controllable::UseGroup);
 368                                                 }
 369                                                 break;
 370                                         default:
 371                                                 break;
 372                                 }
 373                                 DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("MIDI CC %1 value %2  %3\n", (int) msg->controller_number, (int) last_value, current_uri() ));
 374
 375                         }
 376                 } else {
 377
 378                         switch (get_ctltype()) {
 379                         case Ctl_Dial:
 380                                 /* toggle value whenever direction of knob motion changes */
 381                                 if (last_incoming > 127) {
 382                                         /* relax ... first incoming message */
 383                                 } else {
 384                                         if (msg->value > last_incoming) {
 385                                                 controllable->set_value (1.0, Controllable::UseGroup);
 386                                         } else {
 387                                                 controllable->set_value (0.0, Controllable::UseGroup);
 388                                         }
 389                                         DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("dial Midi CC %1 value 1  %2\n", (int) msg->controller_number, current_uri()));
 390                                 }
 391                                 last_incoming = msg->value;
 392                                 break;
 393                         case Ctl_Momentary:
 394                                 /* toggle it if over 64, otherwise leave it alone. This behaviour that works with buttons which send a value > 64 each
 395                                  * time they are pressed.
 396                                  */
 397                                 if (msg->value >= 0x40) {
 398                                         controllable->set_value (controllable->get_value() >= 0.5 ? 0.0 : 1.0, Controllable::UseGroup);
 399                                         DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("toggle Midi CC %1 value 1  %2\n", (int) msg->controller_number, current_uri()));
 400                                 }
 401                                 break;
 402                         case Ctl_Toggle:
 403                                 /* toggle if value is over 64, otherwise turn it off. This is behaviour designed for buttons which send a value > 64 when pressed,
 404                                    maintain state (i.e. they know they were pressed) and then send zero the next time.
 405                                 */
 406                                 if (msg->value >= 0x40) {
 407                                         controllable->set_value (controllable->get_value() >= 0.5 ? 0.0 : 1.0, Controllable::UseGroup);
 408                                 } else {
 409                                         controllable->set_value (0.0, Controllable::NoGroup);
 410                                         DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Midi CC %1 value 0  %2\n", (int) msg->controller_number, current_uri()));
 411                                         break;
 412                                 }
 413                         }
 414                 }
 415
 416                 last_value = (MIDI::byte) (control_to_midi(controllable->get_value())); // to prevent feedback fights
 417         }
 418 }
 419
 420 void
 421 MIDIControllable::midi_sense_program_change (Parser &, MIDI::byte msg)
 422 {
 423         if (!controllable) {
 424                 if (lookup_controllable ()) {
 425                         return;
 426                 }
 427         }
 428
 429         _surface->maybe_start_touch (controllable);
 430
 431         if (msg == control_additional) {
 432
 433                 if (!controllable->is_toggle()) {
 434                         controllable->set_value (1.0, Controllable::UseGroup);
 435                         DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("MIDI program %1 value 1.0  %3\n", (int) msg, current_uri() ));
 436                 } else  {
 437                         float new_value = controllable->get_value() > 0.5f ? 0.0f : 1.0f;
 438                         controllable->set_value (new_value, Controllable::UseGroup);
 439                         DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("MIDI program %1 value %2  %3\n", (int) msg, (float) new_value, current_uri()));
 440                 }
 441         }
 442
 443         last_value = (MIDI::byte) (controllable->get_value() * 127.0); // to prevent feedback fights
 444 }
 445
 446 void
 447 MIDIControllable::midi_sense_pitchbend (Parser &, pitchbend_t pb)
 448 {
 449         if (!controllable) {
 450                 if (lookup_controllable ()) {
 451                         return;
 452                 }
 453         }
 454
 455         _surface->maybe_start_touch (controllable);
 456
 457         if (!controllable->is_toggle()) {
 458                 controllable->set_value (midi_to_control (pb), Controllable::UseGroup);
 459                 DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("MIDI pitchbend %1 value %2  %3\n", (int) control_channel, (float) midi_to_control (pb), current_uri() ));
 460         } else {
 461                 if (pb > 8065.0f) {
 462                         controllable->set_value (1, Controllable::UseGroup);
 463                         DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Midi pitchbend %1 value 1  %2\n", (int) control_channel, current_uri()));
 464                 } else {
 465                         controllable->set_value (0, Controllable::UseGroup);
 466                         DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Midi pitchbend %1 value 0  %2\n", (int) control_channel, current_uri()));
 467                 }
 468         }
 469
 470         last_value = control_to_midi (controllable->get_value ());
 471 }
 472
 473 void
 474 MIDIControllable::midi_receiver (Parser &, MIDI::byte *msg, size_t /*len*/)
 475 {
 476         /* we only respond to channel messages */
 477
 478         if ((msg[0] & 0xF0) < 0x80 || (msg[0] & 0xF0) > 0xE0) {
 479                 return;
 480         }
 481
 482         _surface->check_used_event(msg[0], msg[1]);
 483         bind_midi ((channel_t) (msg[0] & 0xf), eventType (msg[0] & 0xF0), msg[1]);
 484
 485         if (controllable) {
 486                 controllable->LearningFinished ();
 487         }
 488 }
 489
 490 void
 491 MIDIControllable::rpn_value_change (Parser&, uint16_t rpn, float val)
 492 {
 493         if (control_rpn == rpn) {
 494                 if (controllable) {
 495                         controllable->set_value (val, Controllable::UseGroup);
 496                 }
 497         }
 498 }
 499
 500 void
 501 MIDIControllable::nrpn_value_change (Parser&, uint16_t nrpn, float val)
 502 {
 503         if (control_nrpn == nrpn) {
 504                 if (controllable) {
 505                         controllable->set_value (val, Controllable::UseGroup);
 506                 }
 507         }
 508 }
 509
 510 void
 511 MIDIControllable::rpn_change (Parser&, uint16_t rpn, int dir)
 512 {
 513         if (control_rpn == rpn) {
 514                 if (controllable) {
 515                         /* XXX how to increment/decrement ? */
 516                         // controllable->set_value (val);
 517                 }
 518         }
 519 }
 520
 521 void
 522 MIDIControllable::nrpn_change (Parser&, uint16_t nrpn, int dir)
 523 {
 524         if (control_nrpn == nrpn) {
 525                 if (controllable) {
 526                         /* XXX how to increment/decrement ? */
 527                         // controllable->set_value (val);
 528                 }
 529         }
 530 }
 531
 532 void
 533 MIDIControllable::bind_rpn_value (channel_t chn, uint16_t rpn)
 534 {
 535         int chn_i = chn;
 536         drop_external_control ();
 537         control_rpn = rpn;
 538         control_channel = chn;
 539         _parser.channel_rpn[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::rpn_value_change, this, _1, _2, _3));
 540 }
 541
 542 void
 543 MIDIControllable::bind_nrpn_value (channel_t chn, uint16_t nrpn)
 544 {
 545         int chn_i = chn;
 546         drop_external_control ();
 547         control_nrpn = nrpn;
 548         control_channel = chn;
 549         _parser.channel_nrpn[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::rpn_value_change, this, _1, _2, _3));
 550 }
 551
 552 void
 553 MIDIControllable::bind_nrpn_change (channel_t chn, uint16_t nrpn)
 554 {
 555         int chn_i = chn;
 556         drop_external_control ();
 557         control_nrpn = nrpn;
 558         control_channel = chn;
 559         _parser.channel_nrpn_change[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::rpn_change, this, _1, _2, _3));
 560 }
 561
 562 void
 563 MIDIControllable::bind_rpn_change (channel_t chn, uint16_t rpn)
 564 {
 565         int chn_i = chn;
 566         drop_external_control ();
 567         control_rpn = rpn;
 568         control_channel = chn;
 569         _parser.channel_rpn_change[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::nrpn_change, this, _1, _2, _3));
 570 }
 571
 572 void
 573 MIDIControllable::bind_midi (channel_t chn, eventType ev, MIDI::byte additional)
 574 {
 575         char buf[64];
 576
 577         drop_external_control ();
 578
 579         control_type = ev;
 580         control_channel = chn;
 581         control_additional = additional;
 582
 583         int chn_i = chn;
 584         switch (ev) {
 585         case MIDI::off:
 586                 _parser.channel_note_off[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::midi_sense_note_off, this, _1, _2));
 587
 588                 /* if this is a togglee, connect to noteOn as well,
 589                    and we'll toggle back and forth between the two.
 590                 */
 591
 592                 if (_momentary) {
 593                         _parser.channel_note_on[chn_i].connect_same_thread (midi_sense_connection[1], boost::bind (&MIDIControllable::midi_sense_note_on, this, _1, _2));
 594                 }
 595
 596                 _control_description = "MIDI control: NoteOff";
 597                 break;
 598
 599         case MIDI::on:
 600                 _parser.channel_note_on[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::midi_sense_note_on, this, _1, _2));
 601                 if (_momentary) {
 602                         _parser.channel_note_off[chn_i].connect_same_thread (midi_sense_connection[1], boost::bind (&MIDIControllable::midi_sense_note_off, this, _1, _2));
 603                 }
 604                 _control_description = "MIDI control: NoteOn";
 605                 break;
 606
 607         case MIDI::controller:
 608                 _parser.channel_controller[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::midi_sense_controller, this, _1, _2));
 609                 snprintf (buf, sizeof (buf), "MIDI control: Controller %d", control_additional);
 610                 _control_description = buf;
 611                 break;
 612
 613         case MIDI::program:
 614                 _parser.channel_program_change[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::midi_sense_program_change, this, _1, _2));
 615                 _control_description = "MIDI control: ProgramChange";
 616                 break;
 617
 618         case MIDI::pitchbend:
 619                 _parser.channel_pitchbend[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::midi_sense_pitchbend, this, _1, _2));
 620                 _control_description = "MIDI control: Pitchbend";
 621                 break;
 622
 623         default:
 624                 break;
 625         }
 626         DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Controlable: bind_midi: %1 on Channel %2 value %3 \n", _control_description, chn_i + 1, (int) additional));
 627 }
 628
 629 MIDI::byte*
 630 MIDIControllable::write_feedback (MIDI::byte* buf, int32_t& bufsize, bool /*force*/)
 631 {
 632         if (!controllable || !_surface->get_feedback ()) {
 633                 return buf;
 634         }
 635
 636         float val = controllable->get_value ();
 637
 638         /* Note that when sending RPN/NPRN we do two things:
 639          *
 640          * always send MSB first, then LSB
 641          * null/reset the parameter ID after sending.
 642          *
 643          * this follows recommendations found online, eg. http://www.philrees.co.uk/nrpnq.htm
 644          */
 645
 646         if (control_rpn >= 0) {
 647                 if (bufsize < 13) {
 648                         return buf;
 649                 }
 650                 int rpn_val = (int) lrintf (val * 16384.0);
 651                 if (last_value == rpn_val) {
 652                         return buf;
 653                 }
 654                 *buf++ = (0xb0) | control_channel;
 655                 *buf++ = 0x62;
 656                 *buf++ = (int) ((control_rpn) >> 7);
 657                 *buf++ = 0x63;
 658                 *buf++ = (int) (control_rpn & 0x7f);
 659                 *buf++ = 0x06;
 660                 *buf++ = (int) (rpn_val >> 7);
 661                 *buf++ = 0x26;
 662                 *buf++ = (int) (rpn_val & 0x7f);
 663                 *buf++ = 0x62;
 664                 *buf++ = 0x7f;
 665                 *buf++ = 0x63;
 666                 *buf++ = 0x7f;
 667                 bufsize -= 13;
 668                 last_value = rpn_val;
 669                 DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("MIDI out: RPN %1 Channel %2 Value %3\n", control_rpn, (int) control_channel, val));
 670                 return buf;
 671         }
 672
 673         if (control_nrpn >= 0) {
 674                 int rpn_val = (int) lrintf (val * 16384.0);
 675                 if (last_value == rpn_val) {
 676                         return buf;
 677                 }
 678                 *buf++ = (0xb0) | control_channel;
 679                 *buf++ = 0x64;
 680                 *buf++ = (int) ((control_rpn) >> 7);
 681                 *buf++ = 0x65;
 682                 *buf++ = (int) (control_rpn & 0x7f);
 683                 *buf++ = 0x06;
 684                 *buf++ = (int) (rpn_val >> 7);
 685                 *buf++ = 0x26;
 686                 *buf++ = (int) (rpn_val & 0x7f);
 687                 *buf++ = 0x64;
 688                 *buf++ = 0x7f;
 689                 *buf++ = 0x65;
 690                 *buf++ = 0x7f;
 691                 last_value = rpn_val;
 692                 bufsize -= 13;
 693                 DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("MIDI out: NRPN %1 Channel %2 Value %3\n", control_nrpn, (int) control_channel, val));
 694                 return buf;
 695         }
 696
 697         if (control_type == none || bufsize <= 2) {
 698                 return buf;
 699         }
 700
 701         int const gm = control_to_midi (val);
 702
 703         if (gm == last_value) {
 704                 return buf;
 705         }
 706
 707         DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Feedback: %1 %2\n", control_description(), current_uri()));
 708
 709         *buf++ = (0xF0 & control_type) | (0xF & control_channel);
 710         int ev_size = 3;
 711         switch (control_type) {
 712         case MIDI::pitchbend:
 713                 *buf++ = int (gm) & 127;
 714                 *buf++ = (int (gm) >> 7) & 127;
 715                 break;
 716         case MIDI::program:
 717                 *buf++ = control_additional; /* program number */
 718                 ev_size = 2;
 719                 break;
 720         default:
 721                 *buf++ = control_additional; /* controller number */
 722                 *buf++ = gm;
 723                 break;
 724         }
 725         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)));
 726
 727         last_value = gm;
 728         bufsize -= ev_size;
 729
 730         return buf;
 731 }
 732
 733 int
 734 MIDIControllable::set_state (const XMLNode& node, int /*version*/)
 735 {
 736         int xx;
 737
 738         std::string str;
 739         if (node.get_property ("event", str)) {
 740                 sscanf (str.c_str(), "0x%x", &xx);
 741                 control_type = (MIDI::eventType) xx;
 742         } else {
 743                 return -1;
 744         }
 745
 746         if (node.get_property ("channel", xx)) {
 747                 control_channel = xx;
 748         } else {
 749                 return -1;
 750         }
 751
 752         if (node.get_property ("additional", str)) {
 753                 sscanf (str.c_str(), "0x%x", &xx);
 754                 control_additional = (MIDI::byte) xx;
 755         } else {
 756                 return -1;
 757         }
 758
 759         bind_midi (control_channel, control_type, control_additional);
 760
 761         return 0;
 762 }
 763
 764 XMLNode&
 765 MIDIControllable::get_state ()
 766 {
 767         char buf[32];
 768
 769         XMLNode* node = new XMLNode ("MIDIControllable");
 770
 771         if (_current_uri.empty()) {
 772                 node->set_property ("id", controllable->id ());
 773         } else {
 774                 node->set_property ("uri", _current_uri);
 775         }
 776
 777         if (controllable) {
 778                 snprintf (buf, sizeof(buf), "0x%x", (int) control_type);
 779                 node->set_property ("event", (const char *)buf);
 780                 node->set_property ("channel", (int16_t)control_channel);
 781                 snprintf (buf, sizeof(buf), "0x%x", (int) control_additional);
 782                 node->set_property ("additional", (const char *)buf);
 783         }
 784
 785         return *node;
 786 }
 787
 788 /** @return the maximum value for a control value transmitted
 789  *  using a given MIDI::eventType.
 790  */
 791 int
 792 MIDIControllable::max_value_for_type () const
 793 {
 794         /* XXX: this is not complete */
 795
 796         if (control_type == MIDI::pitchbend) {
 797                 return 16383;
 798         }
 799
 800         return 127;
 801 }