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/xml++.h"
  27 #include "pbd/stacktrace.h"
  28 #include "pbd/compose.h"
  29
  30 #include "midi++/types.h" // Added by JE - 06-01-2009. All instances of 'byte' changed to 'MIDI::byte' (for clarification)
  31 #include "midi++/port.h"
  32 #include "midi++/channel.h"
  33
  34 #include "ardour/async_midi_port.h"
  35 #include "ardour/automation_control.h"
  36 #include "ardour/controllable_descriptor.h"
  37 #include "ardour/midi_ui.h"
  38 #include "ardour/utils.h"
  39 #include "ardour/debug.h"
  40
  41 #include "midicontrollable.h"
  42 #include "generic_midi_control_protocol.h"
  43
  44 using namespace std;
  45 using namespace MIDI;
  46 using namespace PBD;
  47 using namespace ARDOUR;
  48
  49 MIDIControllable::MIDIControllable (GenericMidiControlProtocol* s, MIDI::Parser& p, bool m)
  50         : _surface (s)
  51         , controllable (0)
  52         , _descriptor (0)
  53         , _parser (p)
  54         , _momentary (m)
  55 {
  56         _learned = false; /* from URI */
  57         _encoder = No_enc;
  58         setting = false;
  59         last_value = 0; // got a better idea ?
  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         , _descriptor (0)
  71         , _parser (p)
  72         , _momentary (m)
  73 {
  74         set_controllable (&c);
  75
  76         _learned = true; /* from controllable */
  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         delete _descriptor;
  98         _descriptor = new ControllableDescriptor;
  99         return _descriptor->set (s);
 100 }
 101
 102 void
 103 MIDIControllable::midi_forget ()
 104 {
 105         /* stop listening for incoming messages, but retain
 106            our existing event + type information.
 107         */
 108
 109         midi_sense_connection[0].disconnect ();
 110         midi_sense_connection[1].disconnect ();
 111         midi_learn_connection.disconnect ();
 112 }
 113
 114 void
 115 MIDIControllable::drop_external_control ()
 116 {
 117         midi_forget ();
 118         control_rpn = -1;
 119         control_nrpn = -1;
 120         control_type = none;
 121         control_additional = (MIDI::byte) -1;
 122 }
 123
 124 void
 125 MIDIControllable::set_controllable (Controllable* c)
 126 {
 127         if (c == controllable) {
 128                 return;
 129         }
 130
 131         controllable_death_connection.disconnect ();
 132
 133         controllable = c;
 134
 135         if (controllable) {
 136                 last_controllable_value = controllable->get_value();
 137         } else {
 138                 last_controllable_value = 0.0f; // is there a better value?
 139         }
 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 gain_to_slider_position (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 (!_descriptor) {
 250                 return -1;
 251         }
 252
 253         boost::shared_ptr<Controllable> c = _surface->lookup_controllable (*_descriptor);
 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         if (!controllable->is_toggle()) {
 282                 if (control_additional == msg->note_number) {
 283                         controllable->set_value (midi_to_control (msg->velocity), Controllable::NoGroup);
 284                         DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Note %1 value %2  %3\n", (int) msg->note_number, (float) midi_to_control (msg->velocity), current_uri() ));
 285                 }
 286         } else {
 287                 if (control_additional == msg->note_number) {
 288                         float new_value = controllable->get_value() > 0.5f ? 0.0f : 1.0f;
 289                         controllable->set_value (new_value, Controllable::NoGroup);
 290                         DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Note %1 Value %2  %3\n", (int) msg->note_number, (float) new_value, current_uri()));
 291                 }
 292         }
 293
 294         last_value = (MIDI::byte) (controllable->get_value() * 127.0); // to prevent feedback fights
 295 }
 296
 297 void
 298 MIDIControllable::midi_sense_controller (Parser &, EventTwoBytes *msg)
 299 {
 300         if (!controllable) {
 301                 if (lookup_controllable ()) {
 302                         return;
 303                 }
 304         }
 305
 306         assert (controllable);
 307
 308         if (controllable->touching()) {
 309                 return; // to prevent feedback fights when e.g. dragging a UI slider
 310         }
 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::NoGroup);
 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::NoGroup);
 345                                                 } else {
 346                                                         controllable->set_value (midi_to_control (last_value + offset + 1), Controllable::NoGroup);
 347                                                 }
 348                                                 break;
 349                                         case Enc_R:
 350                                                 if (msg->value > 0x40) {
 351                                                         controllable->set_value (midi_to_control (last_value + offset + 1), Controllable::NoGroup);
 352                                                 } else {
 353                                                         controllable->set_value (midi_to_control (last_value - offset + 1), Controllable::NoGroup);
 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::NoGroup);
 359                                                 } else {
 360                                                         controllable->set_value (midi_to_control (last_value + offset + 1), Controllable::NoGroup);
 361                                                 }
 362                                                 break;
 363                                         case Enc_B:
 364                                                 if (msg->value > 0x40) {
 365                                                         controllable->set_value (midi_to_control (last_value + offset + 1), Controllable::NoGroup);
 366                                                 } else {
 367                                                         controllable->set_value (midi_to_control (last_value - (0x40 - offset)), Controllable::NoGroup);
 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                         /* toggle control: make the toggle flip only if the
 379                          * incoming control value exceeds 0.5 (0x40), so that
 380                          * the typical button which sends "CC N=0x7f" on press
 381                          * and "CC N=0x0" on release can be used to drive
 382                          * toggles on press.
 383                          *
 384                          * No other arrangement really makes sense for a toggle
 385                          * controllable. Acting on the press+release makes the
 386                          * action momentary, which is almost never
 387                          * desirable. If the physical button only sends a
 388                          * message on press (or release), then it will be
 389                          * expected to send a controller value >= 0.5
 390                          * (0x40). It is hard to imagine why anyone would make
 391                          * a MIDI controller button that sent 0x0 when pressed.
 392                          */
 393
 394                         if (msg->value >= 0x40) {
 395                                 controllable->set_value (controllable->get_value() >= 0.5 ? 0.0 : 1.0, Controllable::NoGroup);
 396                                 DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Midi CC %1 value 1  %2\n", (int) msg->controller_number, current_uri()));
 397                         }
 398                 }
 399
 400                 last_value = (MIDI::byte) (control_to_midi(controllable->get_value())); // to prevent feedback fights
 401         }
 402 }
 403
 404 void
 405 MIDIControllable::midi_sense_program_change (Parser &, MIDI::byte msg)
 406 {
 407         if (!controllable) {
 408                 if (lookup_controllable ()) {
 409                         return;
 410                 }
 411         }
 412         if (msg == control_additional) {
 413
 414                 if (!controllable->is_toggle()) {
 415                         controllable->set_value (1.0, Controllable::NoGroup);
 416                         DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("MIDI program %1 value 1.0  %3\n", (int) msg, current_uri() ));
 417                 } else  {
 418                         float new_value = controllable->get_value() > 0.5f ? 0.0f : 1.0f;
 419                         controllable->set_value (new_value, Controllable::NoGroup);
 420                         DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("MIDI program %1 value %2  %3\n", (int) msg, (float) new_value, current_uri()));
 421                 }
 422         }
 423
 424         last_value = (MIDI::byte) (controllable->get_value() * 127.0); // to prevent feedback fights
 425 }
 426
 427 void
 428 MIDIControllable::midi_sense_pitchbend (Parser &, pitchbend_t pb)
 429 {
 430         if (!controllable) {
 431                 if (lookup_controllable ()) {
 432                         return;
 433                 }
 434         }
 435
 436         if (!controllable->is_toggle()) {
 437                 controllable->set_value (midi_to_control (pb), Controllable::NoGroup);
 438                 DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("MIDI pitchbend %1 value %2  %3\n", (int) control_channel, (float) midi_to_control (pb), current_uri() ));
 439         } else {
 440                 if (pb > 8065.0f) {
 441                         controllable->set_value (1, Controllable::NoGroup);
 442                         DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Midi pitchbend %1 value 1  %2\n", (int) control_channel, current_uri()));
 443                 } else {
 444                         controllable->set_value (0, Controllable::NoGroup);
 445                         DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Midi pitchbend %1 value 0  %2\n", (int) control_channel, current_uri()));
 446                 }
 447         }
 448
 449         last_value = control_to_midi (controllable->get_value ());
 450 }
 451
 452 void
 453 MIDIControllable::midi_receiver (Parser &, MIDI::byte *msg, size_t /*len*/)
 454 {
 455         /* we only respond to channel messages */
 456
 457         if ((msg[0] & 0xF0) < 0x80 || (msg[0] & 0xF0) > 0xE0) {
 458                 return;
 459         }
 460
 461         _surface->check_used_event(msg[0], msg[1]);
 462         bind_midi ((channel_t) (msg[0] & 0xf), eventType (msg[0] & 0xF0), msg[1]);
 463
 464         if (controllable) {
 465                 controllable->LearningFinished ();
 466         }
 467 }
 468
 469 void
 470 MIDIControllable::rpn_value_change (Parser&, uint16_t rpn, float val)
 471 {
 472         if (control_rpn == rpn) {
 473                 if (controllable) {
 474                         controllable->set_value (val, Controllable::NoGroup);
 475                 }
 476         }
 477 }
 478
 479 void
 480 MIDIControllable::nrpn_value_change (Parser&, uint16_t nrpn, float val)
 481 {
 482         if (control_nrpn == nrpn) {
 483                 if (controllable) {
 484                         controllable->set_value (val, Controllable::NoGroup);
 485                 }
 486         }
 487 }
 488
 489 void
 490 MIDIControllable::rpn_change (Parser&, uint16_t rpn, int dir)
 491 {
 492         if (control_rpn == rpn) {
 493                 if (controllable) {
 494                         /* XXX how to increment/decrement ? */
 495                         // controllable->set_value (val);
 496                 }
 497         }
 498 }
 499
 500 void
 501 MIDIControllable::nrpn_change (Parser&, uint16_t nrpn, int dir)
 502 {
 503         if (control_nrpn == nrpn) {
 504                 if (controllable) {
 505                         /* XXX how to increment/decrement ? */
 506                         // controllable->set_value (val);
 507                 }
 508         }
 509 }
 510
 511 void
 512 MIDIControllable::bind_rpn_value (channel_t chn, uint16_t rpn)
 513 {
 514         int chn_i = chn;
 515         drop_external_control ();
 516         control_rpn = rpn;
 517         control_channel = chn;
 518         _parser.channel_rpn[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::rpn_value_change, this, _1, _2, _3));
 519 }
 520
 521 void
 522 MIDIControllable::bind_nrpn_value (channel_t chn, uint16_t nrpn)
 523 {
 524         int chn_i = chn;
 525         drop_external_control ();
 526         control_nrpn = nrpn;
 527         control_channel = chn;
 528         _parser.channel_nrpn[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::rpn_value_change, this, _1, _2, _3));
 529 }
 530
 531 void
 532 MIDIControllable::bind_nrpn_change (channel_t chn, uint16_t nrpn)
 533 {
 534         int chn_i = chn;
 535         drop_external_control ();
 536         control_nrpn = nrpn;
 537         control_channel = chn;
 538         _parser.channel_nrpn_change[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::rpn_change, this, _1, _2, _3));
 539 }
 540
 541 void
 542 MIDIControllable::bind_rpn_change (channel_t chn, uint16_t rpn)
 543 {
 544         int chn_i = chn;
 545         drop_external_control ();
 546         control_rpn = rpn;
 547         control_channel = chn;
 548         _parser.channel_rpn_change[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::nrpn_change, this, _1, _2, _3));
 549 }
 550
 551 void
 552 MIDIControllable::bind_midi (channel_t chn, eventType ev, MIDI::byte additional)
 553 {
 554         char buf[64];
 555
 556         drop_external_control ();
 557
 558         control_type = ev;
 559         control_channel = chn;
 560         control_additional = additional;
 561
 562         int chn_i = chn;
 563         switch (ev) {
 564         case MIDI::off:
 565                 _parser.channel_note_off[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::midi_sense_note_off, this, _1, _2));
 566
 567                 /* if this is a togglee, connect to noteOn as well,
 568                    and we'll toggle back and forth between the two.
 569                 */
 570
 571                 if (_momentary) {
 572                         _parser.channel_note_on[chn_i].connect_same_thread (midi_sense_connection[1], boost::bind (&MIDIControllable::midi_sense_note_on, this, _1, _2));
 573                 }
 574
 575                 _control_description = "MIDI control: NoteOff";
 576                 break;
 577
 578         case MIDI::on:
 579                 _parser.channel_note_on[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::midi_sense_note_on, this, _1, _2));
 580                 if (_momentary) {
 581                         _parser.channel_note_off[chn_i].connect_same_thread (midi_sense_connection[1], boost::bind (&MIDIControllable::midi_sense_note_off, this, _1, _2));
 582                 }
 583                 _control_description = "MIDI control: NoteOn";
 584                 break;
 585
 586         case MIDI::controller:
 587                 _parser.channel_controller[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::midi_sense_controller, this, _1, _2));
 588                 snprintf (buf, sizeof (buf), "MIDI control: Controller %d", control_additional);
 589                 _control_description = buf;
 590                 break;
 591
 592         case MIDI::program:
 593                 _parser.channel_program_change[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::midi_sense_program_change, this, _1, _2));
 594                 _control_description = "MIDI control: ProgramChange";
 595                 break;
 596
 597         case MIDI::pitchbend:
 598                 _parser.channel_pitchbend[chn_i].connect_same_thread (midi_sense_connection[0], boost::bind (&MIDIControllable::midi_sense_pitchbend, this, _1, _2));
 599                 _control_description = "MIDI control: Pitchbend";
 600                 break;
 601
 602         default:
 603                 break;
 604         }
 605         DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Controlable: bind_midi: %1 on Channel %2 value %3 \n", _control_description, chn_i + 1, (int) additional));
 606 }
 607
 608 MIDI::byte*
 609 MIDIControllable::write_feedback (MIDI::byte* buf, int32_t& bufsize, bool /*force*/)
 610 {
 611         if (!controllable || !_surface->get_feedback ()) {
 612                 return buf;
 613         }
 614
 615         float val = controllable->get_value ();
 616
 617         /* Note that when sending RPN/NPRN we do two things:
 618          *
 619          * always send MSB first, then LSB
 620          * null/reset the parameter ID after sending.
 621          *
 622          * this follows recommendations found online, eg. http://www.philrees.co.uk/nrpnq.htm
 623          */
 624
 625         if (control_rpn >= 0) {
 626                 if (bufsize < 13) {
 627                         return buf;
 628                 }
 629                 int rpn_val = (int) lrintf (val * 16384.0);
 630                 if (last_value == rpn_val) {
 631                         return buf;
 632                 }
 633                 *buf++ = (0xb0) | control_channel;
 634                 *buf++ = 0x62;
 635                 *buf++ = (int) ((control_rpn) >> 7);
 636                 *buf++ = 0x63;
 637                 *buf++ = (int) (control_rpn & 0x7f);
 638                 *buf++ = 0x06;
 639                 *buf++ = (int) (rpn_val >> 7);
 640                 *buf++ = 0x26;
 641                 *buf++ = (int) (rpn_val & 0x7f);
 642                 *buf++ = 0x62;
 643                 *buf++ = 0x7f;
 644                 *buf++ = 0x63;
 645                 *buf++ = 0x7f;
 646                 bufsize -= 13;
 647                 last_value = rpn_val;
 648                 DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("MIDI out: RPN %1 Channel %2 Value %3\n", control_rpn, (int) control_channel, val));
 649                 return buf;
 650         }
 651
 652         if (control_nrpn >= 0) {
 653                 int rpn_val = (int) lrintf (val * 16384.0);
 654                 if (last_value == rpn_val) {
 655                         return buf;
 656                 }
 657                 *buf++ = (0xb0) | control_channel;
 658                 *buf++ = 0x64;
 659                 *buf++ = (int) ((control_rpn) >> 7);
 660                 *buf++ = 0x65;
 661                 *buf++ = (int) (control_rpn & 0x7f);
 662                 *buf++ = 0x06;
 663                 *buf++ = (int) (rpn_val >> 7);
 664                 *buf++ = 0x26;
 665                 *buf++ = (int) (rpn_val & 0x7f);
 666                 *buf++ = 0x64;
 667                 *buf++ = 0x7f;
 668                 *buf++ = 0x65;
 669                 *buf++ = 0x7f;
 670                 last_value = rpn_val;
 671                 bufsize -= 13;
 672                 DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("MIDI out: NRPN %1 Channel %2 Value %3\n", control_nrpn, (int) control_channel, val));
 673                 return buf;
 674         }
 675
 676         if (control_type == none || bufsize <= 2) {
 677                 return buf;
 678         }
 679
 680         int const gm = control_to_midi (val);
 681
 682         if (gm == last_value) {
 683                 return buf;
 684         }
 685
 686         DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Feedback: %1 %2\n", control_description(), current_uri()));
 687
 688         *buf++ = (0xF0 & control_type) | (0xF & control_channel);
 689         int ev_size = 3;
 690         switch (control_type) {
 691         case MIDI::pitchbend:
 692                 *buf++ = int (gm) & 127;
 693                 *buf++ = (int (gm) >> 7) & 127;
 694                 break;
 695         case MIDI::program:
 696                 *buf++ = control_additional; /* program number */
 697                 ev_size = 2;
 698                 break;
 699         default:
 700                 *buf++ = control_additional; /* controller number */
 701                 *buf++ = gm;
 702                 break;
 703         }
 704         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)));
 705
 706         last_value = gm;
 707         bufsize -= ev_size;
 708
 709         return buf;
 710 }
 711
 712 int
 713 MIDIControllable::set_state (const XMLNode& node, int /*version*/)
 714 {
 715         const XMLProperty* prop;
 716         int xx;
 717
 718         if ((prop = node.property ("event")) != 0) {
 719                 sscanf (prop->value().c_str(), "0x%x", &xx);
 720                 control_type = (MIDI::eventType) xx;
 721         } else {
 722                 return -1;
 723         }
 724
 725         if ((prop = node.property ("channel")) != 0) {
 726                 sscanf (prop->value().c_str(), "%d", &xx);
 727                 control_channel = (MIDI::channel_t) xx;
 728         } else {
 729                 return -1;
 730         }
 731
 732         if ((prop = node.property ("additional")) != 0) {
 733                 sscanf (prop->value().c_str(), "0x%x", &xx);
 734                 control_additional = (MIDI::byte) xx;
 735         } else {
 736                 return -1;
 737         }
 738
 739         bind_midi (control_channel, control_type, control_additional);
 740
 741         return 0;
 742 }
 743
 744 XMLNode&
 745 MIDIControllable::get_state ()
 746 {
 747         char buf[32];
 748
 749         XMLNode* node = new XMLNode ("MIDIControllable");
 750
 751         if (_current_uri.empty()) {
 752                 node->add_property ("id", controllable->id().to_s());
 753         } else {
 754                 node->add_property ("uri", _current_uri);
 755         }
 756
 757         if (controllable) {
 758                 snprintf (buf, sizeof(buf), "0x%x", (int) control_type);
 759                 node->add_property ("event", buf);
 760                 snprintf (buf, sizeof(buf), "%d", (int) control_channel);
 761                 node->add_property ("channel", buf);
 762                 snprintf (buf, sizeof(buf), "0x%x", (int) control_additional);
 763                 node->add_property ("additional", buf);
 764         }
 765
 766         return *node;
 767 }
 768
 769 /** @return the maximum value for a control value transmitted
 770  *  using a given MIDI::eventType.
 771  */
 772 int
 773 MIDIControllable::max_value_for_type () const
 774 {
 775         /* XXX: this is not complete */
 776
 777         if (control_type == MIDI::pitchbend) {
 778                 return 16383;
 779         }
 780
 781         return 127;
 782 }