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