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/file_utils.h"
  32 #include "pbd/xml++.h"
  33 #include "pbd/compose.h"
  34
  35 #include "midi++/port.h"
  36
  37 #include "ardour/audioengine.h"
  38 #include "ardour/filesystem_paths.h"
  39 #include "ardour/session.h"
  40 #include "ardour/route.h"
  41 #include "ardour/midi_ui.h"
  42 #include "ardour/rc_configuration.h"
  43 #include "ardour/midiport_manager.h"
  44 #include "ardour/debug.h"
  45
  46 #include "generic_midi_control_protocol.h"
  47 #include "midicontrollable.h"
  48 #include "midifunction.h"
  49 #include "midiaction.h"
  50
  51 using namespace ARDOUR;
  52 using namespace PBD;
  53 using namespace std;
  54
  55 #include "i18n.h"
  56
  57 #define midi_ui_context() MidiControlUI::instance() /* a UICallback-derived object that specifies the event loop for signal handling */
  58
  59 GenericMidiControlProtocol::GenericMidiControlProtocol (Session& s)
  60         : ControlProtocol (s, _("Generic MIDI"))
  61         , _motorised (false)
  62         , _threshold (10)
  63         , gui (0)
  64 {
  65         _input_port = s.midi_input_port ();
  66         _output_port = s.midi_output_port ();
  67
  68         do_feedback = false;
  69         _feedback_interval = 10000; // microseconds
  70         last_feedback_time = 0;
  71
  72         _current_bank = 0;
  73         _bank_size = 0;
  74
  75         /* these signals are emitted by the MidiControlUI's event loop thread
  76          * and we may as well handle them right there in the same the same
  77          * thread
  78          */
  79
  80         Controllable::StartLearning.connect_same_thread (*this, boost::bind (&GenericMidiControlProtocol::start_learning, this, _1));
  81         Controllable::StopLearning.connect_same_thread (*this, boost::bind (&GenericMidiControlProtocol::stop_learning, this, _1));
  82         Controllable::CreateBinding.connect_same_thread (*this, boost::bind (&GenericMidiControlProtocol::create_binding, this, _1, _2, _3));
  83         Controllable::DeleteBinding.connect_same_thread (*this, boost::bind (&GenericMidiControlProtocol::delete_binding, this, _1));
  84
  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         //Session::SendFeedback.connect (*this, MISSING_INVALIDATOR, boost::bind (&GenericMidiControlProtocol::send_feedback, this), midi_ui_context());;
  92
  93         /* this one is cross-thread */
  94
  95         Route::RemoteControlIDChange.connect (*this, MISSING_INVALIDATOR, boost::bind (&GenericMidiControlProtocol::reset_controllables, this), midi_ui_context());
  96
  97         reload_maps ();
  98 }
  99
 100 GenericMidiControlProtocol::~GenericMidiControlProtocol ()
 101 {
 102         drop_all ();
 103         tear_down_gui ();
 104 }
 105
 106 static const char * const midimap_env_variable_name = "ARDOUR_MIDIMAPS_PATH";
 107 static const char* const midi_map_dir_name = "midi_maps";
 108 static const char* const midi_map_suffix = ".map";
 109
 110 Searchpath
 111 system_midi_map_search_path ()
 112 {
 113         bool midimap_path_defined = false;
 114         std::string spath_env (Glib::getenv (midimap_env_variable_name, midimap_path_defined));
 115
 116         if (midimap_path_defined) {
 117                 return spath_env;
 118         }
 119
 120         Searchpath spath (ardour_data_search_path());
 121         spath.add_subdirectory_to_paths(midi_map_dir_name);
 122         return spath;
 123 }
 124
 125 static std::string
 126 user_midi_map_directory ()
 127 {
 128         return Glib::build_filename (user_config_directory(), midi_map_dir_name);
 129 }
 130
 131 static bool
 132 midi_map_filter (const string &str, void* /*arg*/)
 133 {
 134         return (str.length() > strlen(midi_map_suffix) &&
 135                 str.find (midi_map_suffix) == (str.length() - strlen (midi_map_suffix)));
 136 }
 137
 138 void
 139 GenericMidiControlProtocol::reload_maps ()
 140 {
 141         vector<string> midi_maps;
 142         Searchpath spath (system_midi_map_search_path());
 143         spath += user_midi_map_directory ();
 144
 145         find_files_matching_filter (midi_maps, spath, midi_map_filter, 0, false, true);
 146
 147         if (midi_maps.empty()) {
 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
 176 void
 177 GenericMidiControlProtocol::drop_all ()
 178 {
 179         DEBUG_TRACE (DEBUG::GenericMidi, "Drop all bindings\n");
 180         Glib::Threads::Mutex::Lock lm (pending_lock);
 181         Glib::Threads::Mutex::Lock lm2 (controllables_lock);
 182
 183         for (MIDIControllables::iterator i = controllables.begin(); i != controllables.end(); ++i) {
 184                 delete *i;
 185         }
 186         controllables.clear ();
 187
 188         for (MIDIPendingControllables::iterator i = pending_controllables.begin(); i != pending_controllables.end(); ++i) {
 189                 delete *i;
 190         }
 191         pending_controllables.clear ();
 192
 193         for (MIDIFunctions::iterator i = functions.begin(); i != functions.end(); ++i) {
 194                 delete *i;
 195         }
 196         functions.clear ();
 197
 198         for (MIDIActions::iterator i = actions.begin(); i != actions.end(); ++i) {
 199                 delete *i;
 200         }
 201         actions.clear ();
 202 }
 203
 204 void
 205 GenericMidiControlProtocol::drop_bindings ()
 206 {
 207         DEBUG_TRACE (DEBUG::GenericMidi, "Drop bindings, leave learned\n");
 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->parser(), *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->parser(), *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                 DEBUG_TRACE (DEBUG::GenericMidi, string_compose ("Create binding: Channel: %1 Controller: %2 Value: %3 \n", channel, MIDI::controller, value));
 461                 controllables.push_back (mc);
 462         }
 463 }
 464
 465 XMLNode&
 466 GenericMidiControlProtocol::get_state ()
 467 {
 468         XMLNode& node (ControlProtocol::get_state());
 469         char buf[32];
 470
 471         snprintf (buf, sizeof (buf), "%" PRIu64, _feedback_interval);
 472         node.add_property (X_("feedback_interval"), buf);
 473         snprintf (buf, sizeof (buf), "%d", _threshold);
 474         node.add_property (X_("threshold"), 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 (ControlProtocol::set_state (node, version)) {
 508                 return -1;
 509         }
 510
 511         if ((prop = node.property ("feedback_interval")) != 0) {
 512                 if (sscanf (prop->value().c_str(), "%" PRIu64, &_feedback_interval) != 1) {
 513                         _feedback_interval = 10000;
 514                 }
 515         } else {
 516                 _feedback_interval = 10000;
 517         }
 518
 519         if ((prop = node.property ("threshold")) != 0) {
 520                 if (sscanf (prop->value().c_str(), "%d", &_threshold) != 1) {
 521                         _threshold = 10;
 522                 }
 523         } else {
 524                 _threshold = 10;
 525         }
 526
 527         boost::shared_ptr<Controllable> c;
 528
 529         {
 530                 Glib::Threads::Mutex::Lock lm (pending_lock);
 531                 for (MIDIPendingControllables::iterator i = pending_controllables.begin(); i != pending_controllables.end(); ++i) {
 532                         delete *i;
 533                 }
 534                 pending_controllables.clear ();
 535         }
 536
 537         /* Load up specific bindings from the
 538          * <Controls><MidiControllable>...</MidiControllable><Controls> section
 539          */
 540
 541         {
 542                 Glib::Threads::Mutex::Lock lm2 (controllables_lock);
 543                 controllables.clear ();
 544                 nlist = node.children(); // "Controls"
 545
 546                 if (!nlist.empty()) {
 547                         nlist = nlist.front()->children(); // "MIDIControllable" ...
 548
 549                         if (!nlist.empty()) {
 550                                 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
 551
 552                                         if ((prop = (*niter)->property ("id")) != 0) {
 553
 554                                                 ID id = prop->value ();
 555                                                 Controllable* c = Controllable::by_id (id);
 556
 557                                                 if (c) {
 558                                                         MIDIControllable* mc = new MIDIControllable (this, *_input_port->parser(), *c, false);
 559
 560                                                         if (mc->set_state (**niter, version) == 0) {
 561                                                                 controllables.push_back (mc);
 562                                                         }
 563
 564                                                 } else {
 565                                                         warning << string_compose (
 566                                                                 _("Generic MIDI control: controllable %1 not found in session (ignored)"),
 567                                                                 id) << endmsg;
 568                                                 }
 569                                         }
 570                                 }
 571                         }
 572                 }
 573         }
 574
 575         if ((prop = node.property ("binding")) != 0) {
 576                 for (list<MapInfo>::iterator x = map_info.begin(); x != map_info.end(); ++x) {
 577                         if (prop->value() == (*x).name) {
 578                                 load_bindings ((*x).path);
 579                                 break;
 580                         }
 581                 }
 582         }
 583
 584         return 0;
 585 }
 586
 587 int
 588 GenericMidiControlProtocol::set_feedback (bool yn)
 589 {
 590         do_feedback = yn;
 591         last_feedback_time = 0;
 592         return 0;
 593 }
 594
 595 bool
 596 GenericMidiControlProtocol::get_feedback () const
 597 {
 598         return do_feedback;
 599 }
 600
 601 int
 602 GenericMidiControlProtocol::load_bindings (const string& xmlpath)
 603 {
 604         DEBUG_TRACE (DEBUG::GenericMidi, "Load bindings: Reading midi map\n");
 605         XMLTree state_tree;
 606
 607         if (!state_tree.read (xmlpath.c_str())) {
 608                 error << string_compose(_("Could not understand MIDI bindings file %1"), xmlpath) << endmsg;
 609                 return -1;
 610         }
 611
 612         XMLNode* root = state_tree.root();
 613
 614         if (root->name() != X_("ArdourMIDIBindings")) {
 615                 error << string_compose (_("MIDI Bindings file %1 is not really a MIDI bindings file"), xmlpath) << endmsg;
 616                 return -1;
 617         }
 618
 619         const XMLProperty* prop;
 620
 621         if ((prop = root->property ("version")) == 0) {
 622                 return -1;
 623         } else {
 624                 int major;
 625                 int minor;
 626                 int micro;
 627
 628                 sscanf (prop->value().c_str(), "%d.%d.%d", &major, &minor, &micro);
 629                 Stateful::loading_state_version = (major * 1000) + minor;
 630         }
 631
 632         const XMLNodeList& children (root->children());
 633         XMLNodeConstIterator citer;
 634         XMLNodeConstIterator gciter;
 635
 636         MIDIControllable* mc;
 637
 638         drop_all ();
 639
 640         DEBUG_TRACE (DEBUG::GenericMidi, "Loading bindings\n");
 641         for (citer = children.begin(); citer != children.end(); ++citer) {
 642
 643                 if ((*citer)->name() == "DeviceInfo") {
 644                         const XMLProperty* prop;
 645
 646                         if ((prop = (*citer)->property ("bank-size")) != 0) {
 647                                 _bank_size = atoi (prop->value());
 648                                 _current_bank = 0;
 649                         }
 650
 651                         if ((prop = (*citer)->property ("motorised")) != 0 || ((prop = (*citer)->property ("motorized")) != 0)) {
 652                                 _motorised = string_is_affirmative (prop->value ());
 653                         } else {
 654                                 _motorised = false;
 655                         }
 656
 657                         if ((prop = (*citer)->property ("threshold")) != 0) {
 658                                 _threshold = atoi (prop->value ());
 659                         } else {
 660                                 _threshold = 10;
 661                         }
 662
 663                 }
 664
 665                 if ((*citer)->name() == "Binding") {
 666                         const XMLNode* child = *citer;
 667
 668                         if (child->property ("uri")) {
 669                                 /* controllable */
 670
 671                                 if ((mc = create_binding (*child)) != 0) {
 672                                         Glib::Threads::Mutex::Lock lm2 (controllables_lock);
 673                                         controllables.push_back (mc);
 674                                 }
 675
 676                         } else if (child->property ("function")) {
 677
 678                                 /* function */
 679                                 MIDIFunction* mf;
 680
 681                                 if ((mf = create_function (*child)) != 0) {
 682                                         functions.push_back (mf);
 683                                 }
 684
 685                         } else if (child->property ("action")) {
 686                                 MIDIAction* ma;
 687
 688                                 if ((ma = create_action (*child)) != 0) {
 689                                         actions.push_back (ma);
 690                                 }
 691                         }
 692                 }
 693         }
 694
 695         if ((prop = root->property ("name")) != 0) {
 696                 _current_binding = prop->value ();
 697         }
 698
 699         reset_controllables ();
 700
 701         return 0;
 702 }
 703
 704 MIDIControllable*
 705 GenericMidiControlProtocol::create_binding (const XMLNode& node)
 706 {
 707         const XMLProperty* prop;
 708         MIDI::byte detail;
 709         MIDI::channel_t channel;
 710         string uri;
 711         MIDI::eventType ev;
 712         int intval;
 713         bool momentary;
 714
 715         if ((prop = node.property (X_("ctl"))) != 0) {
 716                 ev = MIDI::controller;
 717         } else if ((prop = node.property (X_("note"))) != 0) {
 718                 ev = MIDI::on;
 719         } else if ((prop = node.property (X_("pgm"))) != 0) {
 720                 ev = MIDI::program;
 721         } else if ((prop = node.property (X_("pb"))) != 0) {
 722                 ev = MIDI::pitchbend;
 723         } else {
 724                 return 0;
 725         }
 726
 727         if (sscanf (prop->value().c_str(), "%d", &intval) != 1) {
 728                 return 0;
 729         }
 730
 731         detail = (MIDI::byte) intval;
 732
 733         if ((prop = node.property (X_("channel"))) == 0) {
 734                 return 0;
 735         }
 736
 737         if (sscanf (prop->value().c_str(), "%d", &intval) != 1) {
 738                 return 0;
 739         }
 740         channel = (MIDI::channel_t) intval;
 741         /* adjust channel to zero-based counting */
 742         if (channel > 0) {
 743                 channel -= 1;
 744         }
 745
 746         if ((prop = node.property (X_("momentary"))) != 0) {
 747                 momentary = string_is_affirmative (prop->value());
 748         } else {
 749                 momentary = false;
 750         }
 751
 752         prop = node.property (X_("uri"));
 753         uri = prop->value();
 754
 755         MIDIControllable* mc = new MIDIControllable (this, *_input_port->parser(), momentary);
 756
 757         if (mc->init (uri)) {
 758                 delete mc;
 759                 return 0;
 760         }
 761
 762         mc->bind_midi (channel, ev, detail);
 763
 764         return mc;
 765 }
 766
 767 void
 768 GenericMidiControlProtocol::reset_controllables ()
 769 {
 770         Glib::Threads::Mutex::Lock lm2 (controllables_lock);
 771
 772         for (MIDIControllables::iterator iter = controllables.begin(); iter != controllables.end(); ) {
 773                 MIDIControllable* existingBinding = (*iter);
 774                 MIDIControllables::iterator next = iter;
 775                 ++next;
 776
 777                 if (!existingBinding->learned()) {
 778                         ControllableDescriptor& desc (existingBinding->descriptor());
 779
 780                         if (desc.banked()) {
 781                                 desc.set_bank_offset (_current_bank * _bank_size);
 782                         }
 783
 784                         /* its entirely possible that the session doesn't have
 785                          * the specified controllable (e.g. it has too few
 786                          * tracks). if we find this to be the case, we just leave
 787                          * the binding around, unbound, and it will do "late
 788                          * binding" (or "lazy binding") if/when any data arrives.
 789                          */
 790
 791                         existingBinding->lookup_controllable ();
 792                 }
 793
 794                 iter = next;
 795         }
 796 }
 797
 798 boost::shared_ptr<Controllable>
 799 GenericMidiControlProtocol::lookup_controllable (const ControllableDescriptor& desc) const
 800 {
 801         return session->controllable_by_descriptor (desc);
 802 }
 803
 804 MIDIFunction*
 805 GenericMidiControlProtocol::create_function (const XMLNode& node)
 806 {
 807         const XMLProperty* prop;
 808         int intval;
 809         MIDI::byte detail = 0;
 810         MIDI::channel_t channel = 0;
 811         string uri;
 812         MIDI::eventType ev;
 813         MIDI::byte* data = 0;
 814         uint32_t data_size = 0;
 815         string argument;
 816
 817         if ((prop = node.property (X_("ctl"))) != 0) {
 818                 ev = MIDI::controller;
 819         } else if ((prop = node.property (X_("note"))) != 0) {
 820                 ev = MIDI::on;
 821         } else if ((prop = node.property (X_("pgm"))) != 0) {
 822                 ev = MIDI::program;
 823         } else if ((prop = node.property (X_("sysex"))) != 0 || (prop = node.property (X_("msg"))) != 0) {
 824
 825                 if (prop->name() == X_("sysex")) {
 826                         ev = MIDI::sysex;
 827                 } else {
 828                         ev = MIDI::any;
 829                 }
 830
 831                 int val;
 832                 uint32_t cnt;
 833
 834                 {
 835                         cnt = 0;
 836                         stringstream ss (prop->value());
 837                         ss << hex;
 838
 839                         while (ss >> val) {
 840                                 cnt++;
 841                         }
 842                 }
 843
 844                 if (cnt == 0) {
 845                         return 0;
 846                 }
 847
 848                 data = new MIDI::byte[cnt];
 849                 data_size = cnt;
 850
 851                 {
 852                         stringstream ss (prop->value());
 853                         ss << hex;
 854                         cnt = 0;
 855
 856                         while (ss >> val) {
 857                                 data[cnt++] = (MIDI::byte) val;
 858                         }
 859                 }
 860
 861         } else {
 862                 warning << "Binding ignored - unknown type" << endmsg;
 863                 return 0;
 864         }
 865
 866         if (data_size == 0) {
 867                 if (sscanf (prop->value().c_str(), "%d", &intval) != 1) {
 868                         return 0;
 869                 }
 870
 871                 detail = (MIDI::byte) intval;
 872
 873                 if ((prop = node.property (X_("channel"))) == 0) {
 874                         return 0;
 875                 }
 876
 877                 if (sscanf (prop->value().c_str(), "%d", &intval) != 1) {
 878                         return 0;
 879                 }
 880                 channel = (MIDI::channel_t) intval;
 881                 /* adjust channel to zero-based counting */
 882                 if (channel > 0) {
 883                         channel -= 1;
 884                 }
 885         }
 886
 887         if ((prop = node.property (X_("arg"))) != 0 || (prop = node.property (X_("argument"))) != 0 || (prop = node.property (X_("arguments"))) != 0) {
 888                 argument = prop->value ();
 889         }
 890
 891         prop = node.property (X_("function"));
 892
 893         MIDIFunction* mf = new MIDIFunction (*_input_port->parser());
 894
 895         if (mf->setup (*this, prop->value(), argument, data, data_size)) {
 896                 delete mf;
 897                 return 0;
 898         }
 899
 900         mf->bind_midi (channel, ev, detail);
 901
 902         return mf;
 903 }
 904
 905 MIDIAction*
 906 GenericMidiControlProtocol::create_action (const XMLNode& node)
 907 {
 908         const XMLProperty* prop;
 909         int intval;
 910         MIDI::byte detail = 0;
 911         MIDI::channel_t channel = 0;
 912         string uri;
 913         MIDI::eventType ev;
 914         MIDI::byte* data = 0;
 915         uint32_t data_size = 0;
 916
 917         if ((prop = node.property (X_("ctl"))) != 0) {
 918                 ev = MIDI::controller;
 919         } else if ((prop = node.property (X_("note"))) != 0) {
 920                 ev = MIDI::on;
 921         } else if ((prop = node.property (X_("pgm"))) != 0) {
 922                 ev = MIDI::program;
 923         } else if ((prop = node.property (X_("sysex"))) != 0 || (prop = node.property (X_("msg"))) != 0) {
 924
 925                 if (prop->name() == X_("sysex")) {
 926                         ev = MIDI::sysex;
 927                 } else {
 928                         ev = MIDI::any;
 929                 }
 930
 931                 int val;
 932                 uint32_t cnt;
 933
 934                 {
 935                         cnt = 0;
 936                         stringstream ss (prop->value());
 937                         ss << hex;
 938
 939                         while (ss >> val) {
 940                                 cnt++;
 941                         }
 942                 }
 943
 944                 if (cnt == 0) {
 945                         return 0;
 946                 }
 947
 948                 data = new MIDI::byte[cnt];
 949                 data_size = cnt;
 950
 951                 {
 952                         stringstream ss (prop->value());
 953                         ss << hex;
 954                         cnt = 0;
 955
 956                         while (ss >> val) {
 957                                 data[cnt++] = (MIDI::byte) val;
 958                         }
 959                 }
 960
 961         } else {
 962                 warning << "Binding ignored - unknown type" << endmsg;
 963                 return 0;
 964         }
 965
 966         if (data_size == 0) {
 967                 if (sscanf (prop->value().c_str(), "%d", &intval) != 1) {
 968                         return 0;
 969                 }
 970
 971                 detail = (MIDI::byte) intval;
 972
 973                 if ((prop = node.property (X_("channel"))) == 0) {
 974                         return 0;
 975                 }
 976
 977                 if (sscanf (prop->value().c_str(), "%d", &intval) != 1) {
 978                         return 0;
 979                 }
 980                 channel = (MIDI::channel_t) intval;
 981                 /* adjust channel to zero-based counting */
 982                 if (channel > 0) {
 983                         channel -= 1;
 984                 }
 985         }
 986
 987         prop = node.property (X_("action"));
 988
 989         MIDIAction* ma = new MIDIAction (*_input_port->parser());
 990
 991         if (ma->init (*this, prop->value(), data, data_size)) {
 992                 delete ma;
 993                 return 0;
 994         }
 995
 996         ma->bind_midi (channel, ev, detail);
 997
 998         return ma;
 999 }
1000
1001 void
1002 GenericMidiControlProtocol::set_current_bank (uint32_t b)
1003 {
1004         _current_bank = b;
1005         reset_controllables ();
1006 }
1007
1008 void
1009 GenericMidiControlProtocol::next_bank ()
1010 {
1011         _current_bank++;
1012         reset_controllables ();
1013 }
1014
1015 void
1016 GenericMidiControlProtocol::prev_bank()
1017 {
1018         if (_current_bank) {
1019                 _current_bank--;
1020                 reset_controllables ();
1021         }
1022 }
1023
1024 void
1025 GenericMidiControlProtocol::set_motorised (bool m)
1026 {
1027         _motorised = m;
1028 }
1029
1030 void
1031 GenericMidiControlProtocol::set_threshold (int t)
1032 {
1033         _threshold = t;
1034 }