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