libs/surfaces/generic_midi/generic_midi_control_protocol.cc

   1 /*
   2     Copyright (C) 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
  22 #include <sstream>
  23 #include <algorithm>
  24
  25 #include <glibmm/miscutils.h>
  26
  27 #include "pbd/controllable_descriptor.h"
  28 #include "pbd/error.h"
  29 #include "pbd/failed_constructor.h"
  30 #include "pbd/pathscanner.h"
  31 #include "pbd/xml++.h"
  32
  33 #include "midi++/port.h"
  34 #include "midi++/manager.h"
  35
  36 #include "ardour/filesystem_paths.h"
  37 #include "ardour/session.h"
  38 #include "ardour/route.h"
  39 #include "ardour/midi_ui.h"
  40 #include "ardour/rc_configuration.h"
  41
  42 #include "generic_midi_control_protocol.h"
  43 #include "midicontrollable.h"
  44 #include "midifunction.h"
  45 #include "midiaction.h"
  46
  47 using namespace ARDOUR;
  48 using namespace PBD;
  49 using namespace std;
  50
  51 #include "i18n.h"
  52
  53 #define midi_ui_context() MidiControlUI::instance() /* a UICallback-derived object that specifies the event loop for signal handling */
  54
  55 GenericMidiControlProtocol::GenericMidiControlProtocol (Session& s)
  56         : ControlProtocol (s, _("Generic MIDI"))
  57         , _motorised (false)
  58         , gui (0)
  59 {
  60         _input_port = MIDI::Manager::instance()->midi_input_port ();
  61         _output_port = MIDI::Manager::instance()->midi_output_port ();
  62
  63         do_feedback = false;
  64         _feedback_interval = 10000; // microseconds
  65         last_feedback_time = 0;
  66
  67         _current_bank = 0;
  68         _bank_size = 0;
  69
  70         /* these signals are emitted by the MidiControlUI's event loop thread
  71          * and we may as well handle them right there in the same the same
  72          * thread
  73          */
  74
  75         Controllable::StartLearning.connect_same_thread (*this, boost::bind (&GenericMidiControlProtocol::start_learning, this, _1));
  76         Controllable::StopLearning.connect_same_thread (*this, boost::bind (&GenericMidiControlProtocol::stop_learning, this, _1));
  77         Controllable::CreateBinding.connect_same_thread (*this, boost::bind (&GenericMidiControlProtocol::create_binding, this, _1, _2, _3));
  78         Controllable::DeleteBinding.connect_same_thread (*this, boost::bind (&GenericMidiControlProtocol::delete_binding, this, _1));
  79
  80         Session::SendFeedback.connect (*this, MISSING_INVALIDATOR, boost::bind (&GenericMidiControlProtocol::send_feedback, this), midi_ui_context());;
  81 #if 0
  82         /* XXXX SOMETHING GOES WRONG HERE (april 2012) - STILL DEBUGGING */
  83         /* this signal is emitted by the process() callback, and if
  84          * send_feedback() is going to do anything, it should do it in the
  85          * context of the process() callback itself.
  86          */
  87
  88         Session::SendFeedback.connect_same_thread (*this, boost::bind (&GenericMidiControlProtocol::send_feedback, this));
  89 #endif
  90         /* this one is cross-thread */
  91
  92         Route::RemoteControlIDChange.connect (*this, MISSING_INVALIDATOR, boost::bind (&GenericMidiControlProtocol::reset_controllables, this), midi_ui_context());
  93
  94         reload_maps ();
  95 }
  96
  97 GenericMidiControlProtocol::~GenericMidiControlProtocol ()
  98 {
  99         drop_all ();
 100         tear_down_gui ();
 101 }
 102
 103 static const char * const midimap_env_variable_name = "ARDOUR_MIDIMAPS_PATH";
 104 static const char* const midi_map_dir_name = "midi_maps";
 105 static const char* const midi_map_suffix = ".map";
 106
 107 static sys::path
 108 system_midi_map_search_path ()
 109 {
 110         bool midimap_path_defined = false;
 111         sys::path spath_env (Glib::getenv (midimap_env_variable_name, midimap_path_defined));
 112
 113         if (midimap_path_defined) {
 114                 return spath_env;
 115         }
 116
 117         SearchPath spath (ardour_data_search_path());
 118         spath.add_subdirectory_to_paths(midi_map_dir_name);
 119
 120         // just return the first directory in the search path that exists
 121         SearchPath::const_iterator i = std::find_if(spath.begin(), spath.end(), sys::exists);
 122
 123         if (i == spath.end()) return sys::path();
 124
 125         return *i;
 126 }
 127
 128 static sys::path
 129 user_midi_map_directory ()
 130 {
 131         sys::path p(user_config_directory());
 132         p /= midi_map_dir_name;
 133
 134         return p;
 135 }
 136
 137 static bool
 138 midi_map_filter (const string &str, void */*arg*/)
 139 {
 140         return (str.length() > strlen(midi_map_suffix) &&
 141                 str.find (midi_map_suffix) == (str.length() - strlen (midi_map_suffix)));
 142 }
 143
 144 void
 145 GenericMidiControlProtocol::reload_maps ()
 146 {
 147         vector<string *> *midi_maps;
 148         PathScanner scanner;
 149         SearchPath spath (system_midi_map_search_path());
 150         spath += user_midi_map_directory ();
 151
 152         midi_maps = scanner (spath.to_string(), midi_map_filter, 0, false, true);
 153
 154         if (!midi_maps) {
 155                 cerr << "No MIDI maps found using " << spath.to_string() << endl;
 156                 return;
 157         }
 158
 159         for (vector<string*>::iterator i = midi_maps->begin(); i != midi_maps->end(); ++i) {
 160                 string fullpath = *(*i);
 161
 162                 XMLTree tree;
 163
 164                 if (!tree.read (fullpath.c_str())) {
 165                         continue;
 166                 }
 167
 168                 MapInfo mi;
 169
 170                 XMLProperty* prop = tree.root()->property ("name");
 171
 172                 if (!prop) {
 173                         continue;
 174                 }
 175
 176                 mi.name = prop->value ();
 177                 mi.path = fullpath;
 178
 179                 map_info.push_back (mi);
 180         }
 181
 182         delete midi_maps;
 183 }
 184
 185 void
 186 GenericMidiControlProtocol::drop_all ()
 187 {
 188         Glib::Mutex::Lock lm (pending_lock);
 189         Glib::Mutex::Lock lm2 (controllables_lock);
 190
 191         for (MIDIControllables::iterator i = controllables.begin(); i != controllables.end(); ++i) {
 192                 delete *i;
 193         }
 194         controllables.clear ();
 195
 196         for (MIDIPendingControllables::iterator i = pending_controllables.begin(); i != pending_controllables.end(); ++i) {
 197                 delete *i;
 198         }
 199         pending_controllables.clear ();
 200
 201         for (MIDIFunctions::iterator i = functions.begin(); i != functions.end(); ++i) {
 202                 delete *i;
 203         }
 204         functions.clear ();
 205
 206         for (MIDIActions::iterator i = actions.begin(); i != actions.end(); ++i) {
 207                 delete *i;
 208         }
 209         actions.clear ();
 210 }
 211
 212 void
 213 GenericMidiControlProtocol::drop_bindings ()
 214 {
 215         Glib::Mutex::Lock lm2 (controllables_lock);
 216
 217         for (MIDIControllables::iterator i = controllables.begin(); i != controllables.end(); ) {
 218                 if (!(*i)->learned()) {
 219                         delete *i;
 220                         i = controllables.erase (i);
 221                 } else {
 222                         ++i;
 223                 }
 224         }
 225
 226         for (MIDIFunctions::iterator i = functions.begin(); i != functions.end(); ++i) {
 227                 delete *i;
 228         }
 229         functions.clear ();
 230
 231         _current_binding = "";
 232         _bank_size = 0;
 233         _current_bank = 0;
 234 }
 235
 236 int
 237 GenericMidiControlProtocol::set_active (bool /*yn*/)
 238 {
 239         /* start/stop delivery/outbound thread */
 240         return 0;
 241 }
 242
 243 void
 244 GenericMidiControlProtocol::set_feedback_interval (microseconds_t ms)
 245 {
 246         _feedback_interval = ms;
 247 }
 248
 249 void
 250 GenericMidiControlProtocol::send_feedback ()
 251 {
 252         /* This is executed in RT "process" context", so no blocking calls
 253          */
 254
 255         if (!do_feedback) {
 256                 return;
 257         }
 258
 259         microseconds_t now = get_microseconds ();
 260
 261         if (last_feedback_time != 0) {
 262                 if ((now - last_feedback_time) < _feedback_interval) {
 263                         return;
 264                 }
 265         }
 266
 267         _send_feedback ();
 268
 269         last_feedback_time = now;
 270 }
 271
 272 void
 273 GenericMidiControlProtocol::_send_feedback ()
 274 {
 275         /* This is executed in RT "process" context", so no blocking calls
 276          */
 277
 278         const int32_t bufsize = 16 * 1024; /* XXX too big */
 279         MIDI::byte buf[bufsize];
 280         int32_t bsize = bufsize;
 281
 282         /* XXX: due to bugs in some ALSA / JACK MIDI bridges, we have to do separate
 283            writes for each controllable here; if we send more than one MIDI message
 284            in a single jack_midi_event_write then some bridges will only pass the
 285            first on to ALSA.
 286         */
 287         for (MIDIControllables::iterator r = controllables.begin(); r != controllables.end(); ++r) {
 288                 MIDI::byte* end = (*r)->write_feedback (buf, bsize);
 289                 if (end != buf) {
 290                         _output_port->write (buf, (int32_t) (end - buf), 0);
 291                 }
 292         }
 293 }
 294
 295 bool
 296 GenericMidiControlProtocol::start_learning (Controllable* c)
 297 {
 298         if (c == 0) {
 299                 return false;
 300         }
 301
 302         Glib::Mutex::Lock lm2 (controllables_lock);
 303
 304         MIDIControllables::iterator tmp;
 305         for (MIDIControllables::iterator i = controllables.begin(); i != controllables.end(); ) {
 306                 tmp = i;
 307                 ++tmp;
 308                 if ((*i)->get_controllable() == c) {
 309                         delete (*i);
 310                         controllables.erase (i);
 311                 }
 312                 i = tmp;
 313         }
 314
 315         {
 316                 Glib::Mutex::Lock lm (pending_lock);
 317
 318                 MIDIPendingControllables::iterator ptmp;
 319                 for (MIDIPendingControllables::iterator i = pending_controllables.begin(); i != pending_controllables.end(); ) {
 320                         ptmp = i;
 321                         ++ptmp;
 322                         if (((*i)->first)->get_controllable() == c) {
 323                                 (*i)->second.disconnect();
 324                                 delete (*i)->first;
 325                                 delete *i;
 326                                 pending_controllables.erase (i);
 327                         }
 328                         i = ptmp;
 329                 }
 330         }
 331
 332         MIDIControllable* mc = 0;
 333
 334         for (MIDIControllables::iterator i = controllables.begin(); i != controllables.end(); ++i) {
 335                 if ((*i)->get_controllable() && ((*i)->get_controllable()->id() == c->id())) {
 336                         mc = *i;
 337                         break;
 338                 }
 339         }
 340
 341         if (!mc) {
 342                 mc = new MIDIControllable (this, *_input_port, *c, false);
 343         }
 344
 345         {
 346                 Glib::Mutex::Lock lm (pending_lock);
 347
 348                 MIDIPendingControllable* element = new MIDIPendingControllable;
 349                 element->first = mc;
 350                 c->LearningFinished.connect_same_thread (element->second, boost::bind (&GenericMidiControlProtocol::learning_stopped, this, mc));
 351
 352                 pending_controllables.push_back (element);
 353         }
 354
 355         mc->learn_about_external_control ();
 356         return true;
 357 }
 358
 359 void
 360 GenericMidiControlProtocol::learning_stopped (MIDIControllable* mc)
 361 {
 362         Glib::Mutex::Lock lm (pending_lock);
 363         Glib::Mutex::Lock lm2 (controllables_lock);
 364
 365         MIDIPendingControllables::iterator tmp;
 366
 367         for (MIDIPendingControllables::iterator i = pending_controllables.begin(); i != pending_controllables.end(); ) {
 368                 tmp = i;
 369                 ++tmp;
 370
 371                 if ( (*i)->first == mc) {
 372                         (*i)->second.disconnect();
 373                         delete *i;
 374                         pending_controllables.erase(i);
 375                 }
 376
 377                 i = tmp;
 378         }
 379
 380         controllables.push_back (mc);
 381 }
 382
 383 void
 384 GenericMidiControlProtocol::stop_learning (Controllable* c)
 385 {
 386         Glib::Mutex::Lock lm (pending_lock);
 387         Glib::Mutex::Lock lm2 (controllables_lock);
 388         MIDIControllable* dptr = 0;
 389
 390         /* learning timed out, and we've been told to consider this attempt to learn to be cancelled. find the
 391            relevant MIDIControllable and remove it from the pending list.
 392         */
 393
 394         for (MIDIPendingControllables::iterator i = pending_controllables.begin(); i != pending_controllables.end(); ++i) {
 395                 if (((*i)->first)->get_controllable() == c) {
 396                         (*i)->first->stop_learning ();
 397                         dptr = (*i)->first;
 398                         (*i)->second.disconnect();
 399
 400                         delete *i;
 401                         pending_controllables.erase (i);
 402                         break;
 403                 }
 404         }
 405
 406         delete dptr;
 407 }
 408
 409 void
 410 GenericMidiControlProtocol::delete_binding (PBD::Controllable* control)
 411 {
 412         if (control != 0) {
 413                 Glib::Mutex::Lock lm2 (controllables_lock);
 414
 415                 for (MIDIControllables::iterator iter = controllables.begin(); iter != controllables.end();) {
 416                         MIDIControllable* existingBinding = (*iter);
 417
 418                         if (control == (existingBinding->get_controllable())) {
 419                                 delete existingBinding;
 420                                 iter = controllables.erase (iter);
 421                         } else {
 422                                 ++iter;
 423                         }
 424
 425                 }
 426         }
 427 }
 428
 429 void
 430 GenericMidiControlProtocol::create_binding (PBD::Controllable* control, int pos, int control_number)
 431 {
 432         if (control != NULL) {
 433                 Glib::Mutex::Lock lm2 (controllables_lock);
 434
 435                 MIDI::channel_t channel = (pos & 0xf);
 436                 MIDI::byte value = control_number;
 437
 438                 // Create a MIDIControllable
 439                 MIDIControllable* mc = new MIDIControllable (this, *_input_port, *control, false);
 440
 441                 // Remove any old binding for this midi channel/type/value pair
 442                 // Note:  can't use delete_binding() here because we don't know the specific controllable we want to remove, only the midi information
 443                 for (MIDIControllables::iterator iter = controllables.begin(); iter != controllables.end();) {
 444                         MIDIControllable* existingBinding = (*iter);
 445
 446                         if ((existingBinding->get_control_channel() & 0xf ) == channel &&
 447                             existingBinding->get_control_additional() == value &&
 448                             (existingBinding->get_control_type() & 0xf0 ) == MIDI::controller) {
 449
 450                                 delete existingBinding;
 451                                 iter = controllables.erase (iter);
 452                         } else {
 453                                 ++iter;
 454                         }
 455
 456                 }
 457
 458                 // Update the MIDI Controllable based on the the pos param
 459                 // Here is where a table lookup for user mappings could go; for now we'll just wing it...
 460                 mc->bind_midi(channel, MIDI::controller, value);
 461
 462                 controllables.push_back (mc);
 463         }
 464 }
 465
 466 XMLNode&
 467 GenericMidiControlProtocol::get_state ()
 468 {
 469         XMLNode* node = new XMLNode ("Protocol");
 470         char buf[32];
 471
 472         node->add_property (X_("name"), _name);
 473         node->add_property (X_("feedback"), do_feedback ? "1" : "0");
 474         snprintf (buf, sizeof (buf), "%" PRIu64, _feedback_interval);
 475         node->add_property (X_("feedback_interval"), buf);
 476
 477         if (!_current_binding.empty()) {
 478                 node->add_property ("binding", _current_binding);
 479         }
 480
 481         XMLNode* children = new XMLNode (X_("Controls"));
 482
 483         node->add_child_nocopy (*children);
 484
 485         Glib::Mutex::Lock lm2 (controllables_lock);
 486         for (MIDIControllables::iterator i = controllables.begin(); i != controllables.end(); ++i) {
 487
 488                 /* we don't care about bindings that come from a bindings map, because
 489                    they will all be reset/recreated when we load the relevant bindings
 490                    file.
 491                 */
 492
 493                 if ((*i)->learned()) {
 494                         children->add_child_nocopy ((*i)->get_state());
 495                 }
 496         }
 497
 498         return *node;
 499 }
 500
 501 int
 502 GenericMidiControlProtocol::set_state (const XMLNode& node, int version)
 503 {
 504         XMLNodeList nlist;
 505         XMLNodeConstIterator niter;
 506         const XMLProperty* prop;
 507
 508         if ((prop = node.property ("feedback")) != 0) {
 509                 do_feedback = (bool) atoi (prop->value().c_str());
 510         } else {
 511                 do_feedback = false;
 512         }
 513
 514         if ((prop = node.property ("feedback_interval")) != 0) {
 515                 if (sscanf (prop->value().c_str(), "%" PRIu64, &_feedback_interval) != 1) {
 516                         _feedback_interval = 10000;
 517                 }
 518         } else {
 519                 _feedback_interval = 10000;
 520         }
 521
 522         boost::shared_ptr<Controllable> c;
 523
 524         {
 525                 Glib::Mutex::Lock lm (pending_lock);
 526                 for (MIDIPendingControllables::iterator i = pending_controllables.begin(); i != pending_controllables.end(); ++i) {
 527                         delete *i;
 528                 }
 529                 pending_controllables.clear ();
 530         }
 531
 532         {
 533                 Glib::Mutex::Lock lm2 (controllables_lock);
 534                 controllables.clear ();
 535                 nlist = node.children(); // "Controls"
 536
 537                 if (nlist.empty()) {
 538                         return 0;
 539                 }
 540
 541                 nlist = nlist.front()->children ();
 542
 543                 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
 544
 545                         if ((prop = (*niter)->property ("id")) != 0) {
 546
 547                                 cerr << "Looking for MIDI Controllable with ID " << prop->value() << endl;
 548
 549                                 ID id = prop->value ();
 550                                 Controllable* c = Controllable::by_id (id);
 551
 552                                 cerr << "\tresult = " << c << endl;
 553
 554                                 if (c) {
 555                                         MIDIControllable* mc = new MIDIControllable (this, *_input_port, *c, false);
 556
 557                                         if (mc->set_state (**niter, version) == 0) {
 558                                                 controllables.push_back (mc);
 559                                         }
 560
 561                                 } else {
 562                                         warning << string_compose (
 563                                                 _("Generic MIDI control: controllable %1 not found in session (ignored)"),
 564                                                 id) << endmsg;
 565                                 }
 566                         }
 567                 }
 568
 569         }
 570
 571         if ((prop = node.property ("binding")) != 0) {
 572                 for (list<MapInfo>::iterator x = map_info.begin(); x != map_info.end(); ++x) {
 573                         if (prop->value() == (*x).name) {
 574                                 load_bindings ((*x).path);
 575                                 break;
 576                         }
 577                 }
 578         }
 579
 580         return 0;
 581 }
 582
 583 int
 584 GenericMidiControlProtocol::set_feedback (bool yn)
 585 {
 586         do_feedback = yn;
 587         last_feedback_time = 0;
 588         return 0;
 589 }
 590
 591 bool
 592 GenericMidiControlProtocol::get_feedback () const
 593 {
 594         return do_feedback;
 595 }
 596
 597 int
 598 GenericMidiControlProtocol::load_bindings (const string& xmlpath)
 599 {
 600         XMLTree state_tree;
 601
 602         if (!state_tree.read (xmlpath.c_str())) {
 603                 error << string_compose(_("Could not understand MIDI bindings file %1"), xmlpath) << endmsg;
 604                 return -1;
 605         }
 606
 607         XMLNode* root = state_tree.root();
 608
 609         if (root->name() != X_("ArdourMIDIBindings")) {
 610                 error << string_compose (_("MIDI Bindings file %1 is not really a MIDI bindings file"), xmlpath) << endmsg;
 611                 return -1;
 612         }
 613
 614         const XMLProperty* prop;
 615
 616         if ((prop = root->property ("version")) == 0) {
 617                 return -1;
 618         } else {
 619                 int major;
 620                 int minor;
 621                 int micro;
 622
 623                 sscanf (prop->value().c_str(), "%d.%d.%d", &major, &minor, &micro);
 624                 Stateful::loading_state_version = (major * 1000) + minor;
 625         }
 626
 627         const XMLNodeList& children (root->children());
 628         XMLNodeConstIterator citer;
 629         XMLNodeConstIterator gciter;
 630
 631         MIDIControllable* mc;
 632
 633         drop_all ();
 634
 635         for (citer = children.begin(); citer != children.end(); ++citer) {
 636
 637                 if ((*citer)->name() == "DeviceInfo") {
 638                         const XMLProperty* prop;
 639
 640                         if ((prop = (*citer)->property ("bank-size")) != 0) {
 641                                 _bank_size = atoi (prop->value());
 642                                 _current_bank = 0;
 643                         }
 644
 645                         if ((prop = (*citer)->property ("motorised")) != 0) {
 646                                 _motorised = string_is_affirmative (prop->value ());
 647                         } else {
 648                                 _motorised = false;
 649                         }
 650                 }
 651
 652                 if ((*citer)->name() == "Binding") {
 653                         const XMLNode* child = *citer;
 654
 655                         if (child->property ("uri")) {
 656                                 /* controllable */
 657
 658                                 if ((mc = create_binding (*child)) != 0) {
 659                                         Glib::Mutex::Lock lm2 (controllables_lock);
 660                                         controllables.push_back (mc);
 661                                 }
 662
 663                         } else if (child->property ("function")) {
 664
 665                                 /* function */
 666                                 MIDIFunction* mf;
 667
 668                                 if ((mf = create_function (*child)) != 0) {
 669                                         functions.push_back (mf);
 670                                 }
 671
 672                         } else if (child->property ("action")) {
 673                                 MIDIAction* ma;
 674
 675                                 if ((ma = create_action (*child)) != 0) {
 676                                         actions.push_back (ma);
 677                                 }
 678                         }
 679                 }
 680         }
 681
 682         if ((prop = root->property ("name")) != 0) {
 683                 _current_binding = prop->value ();
 684         }
 685
 686         reset_controllables ();
 687
 688         return 0;
 689 }
 690
 691 MIDIControllable*
 692 GenericMidiControlProtocol::create_binding (const XMLNode& node)
 693 {
 694         const XMLProperty* prop;
 695         MIDI::byte detail;
 696         MIDI::channel_t channel;
 697         string uri;
 698         MIDI::eventType ev;
 699         int intval;
 700         bool momentary;
 701
 702         if ((prop = node.property (X_("ctl"))) != 0) {
 703                 ev = MIDI::controller;
 704         } else if ((prop = node.property (X_("note"))) != 0) {
 705                 ev = MIDI::on;
 706         } else if ((prop = node.property (X_("pgm"))) != 0) {
 707                 ev = MIDI::program;
 708         } else if ((prop = node.property (X_("pb"))) != 0) {
 709                 ev = MIDI::pitchbend;
 710         } else {
 711                 return 0;
 712         }
 713
 714         if (sscanf (prop->value().c_str(), "%d", &intval) != 1) {
 715                 return 0;
 716         }
 717
 718         detail = (MIDI::byte) intval;
 719
 720         if ((prop = node.property (X_("channel"))) == 0) {
 721                 return 0;
 722         }
 723
 724         if (sscanf (prop->value().c_str(), "%d", &intval) != 1) {
 725                 return 0;
 726         }
 727         channel = (MIDI::channel_t) intval;
 728         /* adjust channel to zero-based counting */
 729         if (channel > 0) {
 730                 channel -= 1;
 731         }
 732
 733         if ((prop = node.property (X_("momentary"))) != 0) {
 734                 momentary = string_is_affirmative (prop->value());
 735         } else {
 736                 momentary = false;
 737         }
 738
 739         prop = node.property (X_("uri"));
 740         uri = prop->value();
 741
 742         MIDIControllable* mc = new MIDIControllable (this, *_input_port, momentary);
 743
 744         if (mc->init (uri)) {
 745                 delete mc;
 746                 return 0;
 747         }
 748
 749         mc->bind_midi (channel, ev, detail);
 750
 751         return mc;
 752 }
 753
 754 void
 755 GenericMidiControlProtocol::reset_controllables ()
 756 {
 757         Glib::Mutex::Lock lm2 (controllables_lock);
 758
 759         for (MIDIControllables::iterator iter = controllables.begin(); iter != controllables.end(); ) {
 760                 MIDIControllable* existingBinding = (*iter);
 761                 MIDIControllables::iterator next = iter;
 762                 ++next;
 763
 764                 if (!existingBinding->learned()) {
 765                         ControllableDescriptor& desc (existingBinding->descriptor());
 766
 767                         if (desc.banked()) {
 768                                 desc.set_bank_offset (_current_bank * _bank_size);
 769                         }
 770
 771                         /* its entirely possible that the session doesn't have
 772                          * the specified controllable (e.g. it has too few
 773                          * tracks). if we find this to be the case, drop any
 774                          * bindings that would be left without controllables.
 775                          */
 776
 777                         boost::shared_ptr<Controllable> c = session->controllable_by_descriptor (desc);
 778                         if (c) {
 779                                 existingBinding->set_controllable (c.get());
 780                         } else {
 781                                 controllables.erase (iter);
 782                         }
 783                 }
 784
 785                 iter = next;
 786         }
 787 }
 788
 789 MIDIFunction*
 790 GenericMidiControlProtocol::create_function (const XMLNode& node)
 791 {
 792         const XMLProperty* prop;
 793         int intval;
 794         MIDI::byte detail = 0;
 795         MIDI::channel_t channel = 0;
 796         string uri;
 797         MIDI::eventType ev;
 798         MIDI::byte* data = 0;
 799         uint32_t data_size = 0;
 800         string argument;
 801
 802         if ((prop = node.property (X_("ctl"))) != 0) {
 803                 ev = MIDI::controller;
 804         } else if ((prop = node.property (X_("note"))) != 0) {
 805                 ev = MIDI::on;
 806         } else if ((prop = node.property (X_("pgm"))) != 0) {
 807                 ev = MIDI::program;
 808         } else if ((prop = node.property (X_("sysex"))) != 0 || (prop = node.property (X_("msg"))) != 0) {
 809
 810                 if (prop->name() == X_("sysex")) {
 811                         ev = MIDI::sysex;
 812                 } else {
 813                         ev = MIDI::any;
 814                 }
 815
 816                 int val;
 817                 uint32_t cnt;
 818
 819                 {
 820                         cnt = 0;
 821                         stringstream ss (prop->value());
 822                         ss << hex;
 823
 824                         while (ss >> val) {
 825                                 cnt++;
 826                         }
 827                 }
 828
 829                 if (cnt == 0) {
 830                         return 0;
 831                 }
 832
 833                 data = new MIDI::byte[cnt];
 834                 data_size = cnt;
 835
 836                 {
 837                         stringstream ss (prop->value());
 838                         ss << hex;
 839                         cnt = 0;
 840
 841                         while (ss >> val) {
 842                                 data[cnt++] = (MIDI::byte) val;
 843                         }
 844                 }
 845
 846         } else {
 847                 warning << "Binding ignored - unknown type" << endmsg;
 848                 return 0;
 849         }
 850
 851         if (data_size == 0) {
 852                 if (sscanf (prop->value().c_str(), "%d", &intval) != 1) {
 853                         return 0;
 854                 }
 855
 856                 detail = (MIDI::byte) intval;
 857
 858                 if ((prop = node.property (X_("channel"))) == 0) {
 859                         return 0;
 860                 }
 861
 862                 if (sscanf (prop->value().c_str(), "%d", &intval) != 1) {
 863                         return 0;
 864                 }
 865                 channel = (MIDI::channel_t) intval;
 866                 /* adjust channel to zero-based counting */
 867                 if (channel > 0) {
 868                         channel -= 1;
 869                 }
 870         }
 871
 872         if ((prop = node.property (X_("arg"))) != 0 || (prop = node.property (X_("argument"))) != 0 || (prop = node.property (X_("arguments"))) != 0) {
 873                 argument = prop->value ();
 874         }
 875
 876         prop = node.property (X_("function"));
 877
 878         MIDIFunction* mf = new MIDIFunction (*_input_port);
 879
 880         if (mf->setup (*this, prop->value(), argument, data, data_size)) {
 881                 delete mf;
 882                 return 0;
 883         }
 884
 885         mf->bind_midi (channel, ev, detail);
 886
 887         return mf;
 888 }
 889
 890 MIDIAction*
 891 GenericMidiControlProtocol::create_action (const XMLNode& node)
 892 {
 893         const XMLProperty* prop;
 894         int intval;
 895         MIDI::byte detail = 0;
 896         MIDI::channel_t channel = 0;
 897         string uri;
 898         MIDI::eventType ev;
 899         MIDI::byte* data = 0;
 900         uint32_t data_size = 0;
 901
 902         if ((prop = node.property (X_("ctl"))) != 0) {
 903                 ev = MIDI::controller;
 904         } else if ((prop = node.property (X_("note"))) != 0) {
 905                 ev = MIDI::on;
 906         } else if ((prop = node.property (X_("pgm"))) != 0) {
 907                 ev = MIDI::program;
 908         } else if ((prop = node.property (X_("sysex"))) != 0 || (prop = node.property (X_("msg"))) != 0) {
 909
 910                 if (prop->name() == X_("sysex")) {
 911                         ev = MIDI::sysex;
 912                 } else {
 913                         ev = MIDI::any;
 914                 }
 915
 916                 int val;
 917                 uint32_t cnt;
 918
 919                 {
 920                         cnt = 0;
 921                         stringstream ss (prop->value());
 922                         ss << hex;
 923
 924                         while (ss >> val) {
 925                                 cnt++;
 926                         }
 927                 }
 928
 929                 if (cnt == 0) {
 930                         return 0;
 931                 }
 932
 933                 data = new MIDI::byte[cnt];
 934                 data_size = cnt;
 935
 936                 {
 937                         stringstream ss (prop->value());
 938                         ss << hex;
 939                         cnt = 0;
 940
 941                         while (ss >> val) {
 942                                 data[cnt++] = (MIDI::byte) val;
 943                         }
 944                 }
 945
 946         } else {
 947                 warning << "Binding ignored - unknown type" << endmsg;
 948                 return 0;
 949         }
 950
 951         if (data_size == 0) {
 952                 if (sscanf (prop->value().c_str(), "%d", &intval) != 1) {
 953                         return 0;
 954                 }
 955
 956                 detail = (MIDI::byte) intval;
 957
 958                 if ((prop = node.property (X_("channel"))) == 0) {
 959                         return 0;
 960                 }
 961
 962                 if (sscanf (prop->value().c_str(), "%d", &intval) != 1) {
 963                         return 0;
 964                 }
 965                 channel = (MIDI::channel_t) intval;
 966                 /* adjust channel to zero-based counting */
 967                 if (channel > 0) {
 968                         channel -= 1;
 969                 }
 970         }
 971
 972         prop = node.property (X_("action"));
 973
 974         MIDIAction* ma = new MIDIAction (*_input_port);
 975
 976         if (ma->init (*this, prop->value(), data, data_size)) {
 977                 delete ma;
 978                 return 0;
 979         }
 980
 981         ma->bind_midi (channel, ev, detail);
 982
 983         return ma;
 984 }
 985
 986 void
 987 GenericMidiControlProtocol::set_current_bank (uint32_t b)
 988 {
 989         _current_bank = b;
 990         reset_controllables ();
 991 }
 992
 993 void
 994 GenericMidiControlProtocol::next_bank ()
 995 {
 996         _current_bank++;
 997         reset_controllables ();
 998 }
 999
1000 void
1001 GenericMidiControlProtocol::prev_bank()
1002 {
1003         if (_current_bank) {
1004                 _current_bank--;
1005                 reset_controllables ();
1006         }
1007 }
1008
1009 void
1010 GenericMidiControlProtocol::set_motorised (bool m)
1011 {
1012         _motorised = m;
1013 }