gtk2_ardour/port_group.cc

   1 /*
   2     Copyright (C) 2002-2009 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 <cstring>
  21 #include <boost/shared_ptr.hpp>
  22
  23 #include "ardour/audio_track.h"
  24 #include "ardour/audioengine.h"
  25 #include "ardour/bundle.h"
  26 #include "ardour/user_bundle.h"
  27 #include "ardour/io_processor.h"
  28 #include "ardour/midi_track.h"
  29 #include "ardour/port.h"
  30 #include "ardour/session.h"
  31 #include "ardour/auditioner.h"
  32
  33 #include "gui_thread.h"
  34 #include "port_group.h"
  35 #include "port_matrix.h"
  36 #include "time_axis_view.h"
  37 #include "public_editor.h"
  38
  39 #include "i18n.h"
  40
  41 using namespace std;
  42 using namespace Gtk;
  43 using namespace ARDOUR;
  44
  45 /** PortGroup constructor.
  46  * @param n Name.
  47  */
  48 PortGroup::PortGroup (std::string const & n)
  49         : name (n)
  50 {
  51
  52 }
  53
  54 PortGroup::~PortGroup()
  55 {
  56         for (BundleList::iterator i = _bundles.begin(); i != _bundles.end(); ++i) {
  57                 delete *i;
  58         }
  59         _bundles.clear ();
  60 }
  61
  62 /** Add a bundle to a group.
  63  *  @param b Bundle.
  64  *  @param allow_dups true to allow the group to contain more than one bundle with the same port, otherwise false.
  65  */
  66 void
  67 PortGroup::add_bundle (boost::shared_ptr<Bundle> b, bool allow_dups)
  68 {
  69         add_bundle_internal (b, boost::shared_ptr<IO> (), false, Gdk::Color (), allow_dups);
  70 }
  71
  72 /** Add a bundle to a group.
  73  *  @param b Bundle.
  74  *  @param io IO whose ports are in the bundle.
  75  */
  76 void
  77 PortGroup::add_bundle (boost::shared_ptr<Bundle> b, boost::shared_ptr<IO> io)
  78 {
  79         add_bundle_internal (b, io, false, Gdk::Color (), false);
  80 }
  81
  82 /** Add a bundle to a group.
  83  *  @param b Bundle.
  84  *  @param c Colour to represent the bundle with.
  85  */
  86 void
  87 PortGroup::add_bundle (boost::shared_ptr<Bundle> b, boost::shared_ptr<IO> io, Gdk::Color c)
  88 {
  89         add_bundle_internal (b, io, true, c, false);
  90 }
  91
  92 PortGroup::BundleRecord::BundleRecord (boost::shared_ptr<ARDOUR::Bundle> b, boost::shared_ptr<ARDOUR::IO> iop, Gdk::Color c, bool has_c)
  93         : bundle (b)
  94         , io (iop)
  95         , colour (c)
  96         , has_colour (has_c)
  97 {
  98 }
  99
 100 void
 101 PortGroup::add_bundle_internal (boost::shared_ptr<Bundle> b, boost::shared_ptr<IO> io, bool has_colour, Gdk::Color colour, bool allow_dups)
 102 {
 103         assert (b.get());
 104
 105         if (!allow_dups) {
 106
 107                 /* don't add this bundle if we already have one with the same ports */
 108
 109                 BundleList::iterator i = _bundles.begin ();
 110                 while (i != _bundles.end() && b->has_same_ports ((*i)->bundle) == false) {
 111                         ++i;
 112                 }
 113
 114                 if (i != _bundles.end ()) {
 115                         return;
 116                 }
 117         }
 118
 119         BundleRecord* br = new BundleRecord (b, io, colour, has_colour);
 120         b->Changed.connect (br->changed_connection, invalidator (*this), ui_bind (&PortGroup::bundle_changed, this, _1), gui_context());
 121         _bundles.push_back (br);
 122
 123         Changed ();
 124 }
 125
 126 void
 127 PortGroup::remove_bundle (boost::shared_ptr<Bundle> b)
 128 {
 129         assert (b.get());
 130
 131         BundleList::iterator i = _bundles.begin ();
 132         while (i != _bundles.end() && (*i)->bundle != b) {
 133                 ++i;
 134         }
 135
 136         if (i == _bundles.end()) {
 137                 return;
 138         }
 139
 140         delete *i;
 141         _bundles.erase (i);
 142
 143         Changed ();
 144 }
 145
 146 void
 147 PortGroup::bundle_changed (Bundle::Change c)
 148 {
 149         BundleChanged (c);
 150 }
 151
 152
 153 void
 154 PortGroup::clear ()
 155 {
 156         for (BundleList::iterator i = _bundles.begin(); i != _bundles.end(); ++i) {
 157                 delete *i;
 158         }
 159
 160         _bundles.clear ();
 161         Changed ();
 162 }
 163
 164 bool
 165 PortGroup::has_port (std::string const& p) const
 166 {
 167         for (BundleList::const_iterator i = _bundles.begin(); i != _bundles.end(); ++i) {
 168                 if ((*i)->bundle->offers_port_alone (p)) {
 169                         return true;
 170                 }
 171         }
 172
 173         return false;
 174 }
 175
 176 boost::shared_ptr<Bundle>
 177 PortGroup::only_bundle ()
 178 {
 179         assert (_bundles.size() == 1);
 180         return _bundles.front()->bundle;
 181 }
 182
 183
 184 ChanCount
 185 PortGroup::total_channels () const
 186 {
 187         ChanCount n;
 188         for (BundleList::const_iterator i = _bundles.begin(); i != _bundles.end(); ++i) {
 189                 n += (*i)->bundle->nchannels ();
 190         }
 191
 192         return n;
 193 }
 194
 195 boost::shared_ptr<IO>
 196 PortGroup::io_from_bundle (boost::shared_ptr<ARDOUR::Bundle> b) const
 197 {
 198         BundleList::const_iterator i = _bundles.begin ();
 199         while (i != _bundles.end() && (*i)->bundle != b) {
 200                 ++i;
 201         }
 202
 203         if (i == _bundles.end()) {
 204                 return boost::shared_ptr<IO> ();
 205         }
 206
 207         return (*i)->io;
 208 }
 209
 210 /** Remove bundles whose channels are already represented by other, larger bundles */
 211 void
 212 PortGroup::remove_duplicates ()
 213 {
 214         BundleList::iterator i = _bundles.begin();
 215         while (i != _bundles.end()) {
 216
 217                 BundleList::iterator tmp = i;
 218                 ++tmp;
 219
 220                 bool remove = false;
 221
 222                 for (BundleList::iterator j = _bundles.begin(); j != _bundles.end(); ++j) {
 223
 224                         if ((*j)->bundle->nchannels() > (*i)->bundle->nchannels()) {
 225                                 /* this bundle is larger */
 226
 227                                 uint32_t k = 0;
 228                                 while (k < (*i)->bundle->nchannels().n_total()) {
 229                                         /* see if this channel on *i has an equivalent on *j */
 230                                         uint32_t l = 0;
 231                                         while (l < (*j)->bundle->nchannels().n_total() && (*i)->bundle->channel_ports (k) != (*j)->bundle->channel_ports (l)) {
 232                                                 ++l;
 233                                         }
 234
 235                                         if (l == (*j)->bundle->nchannels().n_total()) {
 236                                                 /* it does not */
 237                                                 break;
 238                                         }
 239
 240                                         ++k;
 241                                 }
 242
 243                                 if (k == (*i)->bundle->nchannels().n_total()) {
 244                                         /* all channels on *i are represented by the larger bundle *j, so remove *i */
 245                                         remove = true;
 246                                         break;
 247                                 }
 248                         }
 249                 }
 250
 251                 if (remove) {
 252                         _bundles.erase (i);
 253                 }
 254
 255                 i = tmp;
 256         }
 257 }
 258
 259
 260 /** PortGroupList constructor.
 261  */
 262 PortGroupList::PortGroupList ()
 263         : _signals_suspended (false), _pending_change (false), _pending_bundle_change ((Bundle::Change) 0)
 264 {
 265
 266 }
 267
 268 PortGroupList::~PortGroupList()
 269 {
 270         /* XXX need to clean up bundles, but ownership shared with PortGroups */
 271 }
 272
 273 void
 274 PortGroupList::maybe_add_processor_to_list (
 275         boost::weak_ptr<Processor> wp, list<boost::shared_ptr<Bundle> >* route_bundles, bool inputs, set<boost::shared_ptr<IO> >& used_io
 276         )
 277 {
 278         boost::shared_ptr<Processor> p (wp.lock());
 279
 280         if (!p) {
 281                 return;
 282         }
 283
 284         boost::shared_ptr<IOProcessor> iop = boost::dynamic_pointer_cast<IOProcessor> (p);
 285
 286         if (iop) {
 287
 288                 boost::shared_ptr<IO> io = inputs ? iop->input() : iop->output();
 289
 290                 if (io && used_io.find (io) == used_io.end()) {
 291                         route_bundles->push_back (io->bundle ());
 292                         used_io.insert (io);
 293                 }
 294         }
 295 }
 296
 297
 298 /** Gather bundles from around the system and put them in this PortGroupList.
 299  *  @param type Type of bundles to collect, or NIL for all types.
 300  */
 301 void
 302 PortGroupList::gather (ARDOUR::Session* session, ARDOUR::DataType type, bool inputs, bool allow_dups)
 303 {
 304         clear ();
 305
 306         if (session == 0) {
 307                 return;
 308         }
 309
 310         boost::shared_ptr<PortGroup> bus (new PortGroup (_("Bus")));
 311         boost::shared_ptr<PortGroup> track (new PortGroup (_("Track")));
 312         boost::shared_ptr<PortGroup> system (new PortGroup (_("System")));
 313         boost::shared_ptr<PortGroup> ardour (new PortGroup (_("Ardour")));
 314         boost::shared_ptr<PortGroup> other (new PortGroup (_("Other")));
 315
 316         /* Find the bundles for routes.  We use the RouteBundle class to join
 317            the route's input/output and processor bundles together so that they
 318            are presented as one bundle in the matrix. */
 319
 320         boost::shared_ptr<RouteList> routes = session->get_routes ();
 321
 322         for (RouteList::const_iterator i = routes->begin(); i != routes->end(); ++i) {
 323
 324                 list<boost::shared_ptr<Bundle> > route_bundles;
 325
 326                 /* keep track of IOs that we have taken bundles from,
 327                    so that we can avoid taking the same IO from both
 328                    Route::output() and the main_outs Delivery */
 329
 330                 set<boost::shared_ptr<IO> > used_io;
 331                 boost::shared_ptr<IO> io = inputs ? (*i)->input() : (*i)->output();
 332                 used_io.insert (io);
 333
 334                 route_bundles.push_back (io->bundle ());
 335
 336                 (*i)->foreach_processor (boost::bind (&PortGroupList::maybe_add_processor_to_list, this, _1, &route_bundles, inputs, used_io));
 337
 338                 /* Work out which group to put these bundles in */
 339                 boost::shared_ptr<PortGroup> g;
 340                 if (boost::dynamic_pointer_cast<Track> (*i)) {
 341                         g = track;
 342                 } else {
 343                         g = bus;
 344                 }
 345
 346                 TimeAxisView* tv = PublicEditor::instance().axis_view_from_route (*i);
 347                 for (list<boost::shared_ptr<Bundle> >::iterator i = route_bundles.begin(); i != route_bundles.end(); ++i) {
 348                         if (tv) {
 349                                 g->add_bundle (*i, io, tv->color ());
 350                         } else {
 351                                 g->add_bundle (*i, io);
 352                         }
 353                 }
 354         }
 355
 356         /* Bundles owned by the session; add user bundles first, then normal ones, so
 357            that UserBundles that offer the same ports as a normal bundle get priority
 358         */
 359
 360         boost::shared_ptr<BundleList> b = session->bundles ();
 361
 362         for (BundleList::iterator i = b->begin(); i != b->end(); ++i) {
 363                 if (boost::dynamic_pointer_cast<UserBundle> (*i) && (*i)->ports_are_inputs() == inputs) {
 364                         system->add_bundle (*i, allow_dups);
 365                 }
 366         }
 367
 368         for (BundleList::iterator i = b->begin(); i != b->end(); ++i) {
 369                 if (boost::dynamic_pointer_cast<UserBundle> (*i) == 0 && (*i)->ports_are_inputs() == inputs) {
 370                         system->add_bundle (*i, allow_dups);
 371                 }
 372         }
 373
 374         /* Ardour stuff */
 375
 376         if (!inputs && (type == DataType::AUDIO || type == DataType::NIL)) {
 377                 ardour->add_bundle (session->the_auditioner()->output()->bundle());
 378                 ardour->add_bundle (session->click_io()->bundle());
 379         }
 380
 381         /* Now find all other ports that we haven't thought of yet */
 382
 383         std::vector<std::string> extra_system[DataType::num_types];
 384         std::vector<std::string> extra_other[DataType::num_types];
 385
 386         const char ** ports = 0;
 387         if (type == DataType::NIL) {
 388                 ports = session->engine().get_ports ("", "", inputs ? JackPortIsInput : JackPortIsOutput);
 389         } else {
 390                 ports = session->engine().get_ports ("", type.to_jack_type(), inputs ? JackPortIsInput : JackPortIsOutput);
 391         }
 392
 393         if (ports) {
 394
 395                 int n = 0;
 396
 397                 while (ports[n]) {
 398
 399                         std::string const p = ports[n];
 400
 401                         if (!system->has_port(p) &&
 402                             !bus->has_port(p) &&
 403                             !track->has_port(p) &&
 404                             !ardour->has_port(p) &&
 405                             !other->has_port(p)) {
 406
 407                                 /* special hack: ignore MIDI ports labelled Midi-Through. these
 408                                    are basically useless and mess things up for default
 409                                    connections.
 410                                 */
 411
 412                                 if (p.find ("MIDI-Through") != string::npos) {
 413                                         ++n;
 414                                         continue;
 415                                 }
 416
 417                                 /* can't use the audio engine for this as we are looking at non-Ardour ports */
 418
 419                                 jack_port_t* jp = jack_port_by_name (session->engine().jack(), p.c_str());
 420                                 if (jp) {
 421                                         DataType t (jack_port_type (jp));
 422                                         if (t != DataType::NIL) {
 423                                                 if (port_has_prefix (p, "system:") || port_has_prefix (p, "alsa_pcm") || port_has_prefix (p, "ardour:")) {
 424                                                         extra_system[t].push_back (p);
 425                                                 } else {
 426                                                         extra_other[t].push_back (p);
 427                                                 }
 428                                         }
 429                                 }
 430                         }
 431
 432                         ++n;
 433                 }
 434
 435                 free (ports);
 436         }
 437
 438         for (DataType::iterator i = DataType::begin(); i != DataType::end(); ++i) {
 439                 if (!extra_system[*i].empty()) {
 440                         system->add_bundle (make_bundle_from_ports (extra_system[*i], *i, inputs));
 441                 }
 442         }
 443
 444         for (DataType::iterator i = DataType::begin(); i != DataType::end(); ++i) {
 445                 if (!extra_other[*i].empty()) {
 446                         other->add_bundle (make_bundle_from_ports (extra_other[*i], *i, inputs));
 447                 }
 448         }
 449
 450         if (!allow_dups) {
 451                 system->remove_duplicates ();
 452         }
 453
 454         add_group_if_not_empty (other);
 455         add_group_if_not_empty (bus);
 456         add_group_if_not_empty (track);
 457         add_group_if_not_empty (ardour);
 458         add_group_if_not_empty (system);
 459
 460         emit_changed ();
 461 }
 462
 463 boost::shared_ptr<Bundle>
 464 PortGroupList::make_bundle_from_ports (std::vector<std::string> const & p, ARDOUR::DataType type, bool inputs) const
 465 {
 466         boost::shared_ptr<Bundle> b (new Bundle ("", inputs));
 467
 468         std::string const pre = common_prefix (p);
 469         if (!pre.empty()) {
 470                 b->set_name (pre.substr (0, pre.length() - 1));
 471         }
 472
 473         for (uint32_t j = 0; j < p.size(); ++j) {
 474                 b->add_channel (p[j].substr (pre.length()), type);
 475                 b->set_port (j, p[j]);
 476         }
 477
 478         return b;
 479 }
 480
 481 bool
 482 PortGroupList::port_has_prefix (const std::string& n, const std::string& p) const
 483 {
 484         return n.substr (0, p.length()) == p;
 485 }
 486
 487 std::string
 488 PortGroupList::common_prefix_before (std::vector<std::string> const & p, std::string const & s) const
 489 {
 490         /* we must have some strings and the first must contain the separator string */
 491         if (p.empty() || p[0].find_first_of (s) == std::string::npos) {
 492                 return "";
 493         }
 494
 495         /* prefix of the first string */
 496         std::string const fp = p[0].substr (0, p[0].find_first_of (s) + 1);
 497
 498         /* see if the other strings also start with fp */
 499         uint32_t j = 1;
 500         while (j < p.size()) {
 501                 if (p[j].substr (0, fp.length()) != fp) {
 502                         break;
 503                 }
 504                 ++j;
 505         }
 506
 507         if (j != p.size()) {
 508                 return "";
 509         }
 510
 511         return fp;
 512 }
 513
 514
 515 std::string
 516 PortGroupList::common_prefix (std::vector<std::string> const & p) const
 517 {
 518         /* common prefix before '/' ? */
 519         std::string cp = common_prefix_before (p, "/");
 520         if (!cp.empty()) {
 521                 return cp;
 522         }
 523
 524         cp = common_prefix_before (p, ":");
 525         if (!cp.empty()) {
 526                 return cp;
 527         }
 528
 529         return "";
 530 }
 531
 532 void
 533 PortGroupList::clear ()
 534 {
 535         _groups.clear ();
 536         _bundle_changed_connections.drop_connections ();
 537         emit_changed ();
 538 }
 539
 540
 541 PortGroup::BundleList const &
 542 PortGroupList::bundles () const
 543 {
 544         _bundles.clear ();
 545
 546         for (PortGroupList::List::const_iterator i = begin (); i != end (); ++i) {
 547                 std::copy ((*i)->bundles().begin(), (*i)->bundles().end(), std::back_inserter (_bundles));
 548         }
 549
 550         return _bundles;
 551 }
 552
 553 ChanCount
 554 PortGroupList::total_channels () const
 555 {
 556         ChanCount n;
 557
 558         for (PortGroupList::List::const_iterator i = begin(); i != end(); ++i) {
 559                 n += (*i)->total_channels ();
 560         }
 561
 562         return n;
 563 }
 564
 565 void
 566 PortGroupList::add_group_if_not_empty (boost::shared_ptr<PortGroup> g)
 567 {
 568         if (!g->bundles().empty ()) {
 569                 add_group (g);
 570         }
 571 }
 572
 573 void
 574 PortGroupList::add_group (boost::shared_ptr<PortGroup> g)
 575 {
 576         _groups.push_back (g);
 577
 578         g->Changed.connect (_changed_connections, invalidator (*this), boost::bind (&PortGroupList::emit_changed, this), gui_context());
 579         g->BundleChanged.connect (_bundle_changed_connections, invalidator (*this), ui_bind (&PortGroupList::emit_bundle_changed, this, _1), gui_context());
 580
 581         emit_changed ();
 582 }
 583
 584 void
 585 PortGroupList::remove_bundle (boost::shared_ptr<Bundle> b)
 586 {
 587         for (List::iterator i = _groups.begin(); i != _groups.end(); ++i) {
 588                 (*i)->remove_bundle (b);
 589         }
 590
 591         emit_changed ();
 592 }
 593
 594 void
 595 PortGroupList::emit_changed ()
 596 {
 597         if (_signals_suspended) {
 598                 _pending_change = true;
 599         } else {
 600                 Changed ();
 601         }
 602 }
 603
 604 void
 605 PortGroupList::emit_bundle_changed (Bundle::Change c)
 606 {
 607         if (_signals_suspended) {
 608                 _pending_bundle_change = c;
 609         } else {
 610                 BundleChanged (c);
 611         }
 612 }
 613 void
 614 PortGroupList::suspend_signals ()
 615 {
 616         _signals_suspended = true;
 617 }
 618
 619 void
 620 PortGroupList::resume_signals ()
 621 {
 622         if (_pending_change) {
 623                 Changed ();
 624                 _pending_change = false;
 625         }
 626
 627         if (_pending_bundle_change != 0) {
 628                 BundleChanged (_pending_bundle_change);
 629                 _pending_bundle_change = (ARDOUR::Bundle::Change) 0;
 630         }
 631
 632         _signals_suspended = false;
 633 }
 634
 635 boost::shared_ptr<IO>
 636 PortGroupList::io_from_bundle (boost::shared_ptr<ARDOUR::Bundle> b) const
 637 {
 638         List::const_iterator i = _groups.begin ();
 639         while (i != _groups.end()) {
 640                 boost::shared_ptr<IO> io = (*i)->io_from_bundle (b);
 641                 if (io) {
 642                         return io;
 643                 }
 644                 ++i;
 645         }
 646
 647         return boost::shared_ptr<IO> ();
 648 }
 649
 650 bool
 651 PortGroupList::empty () const
 652 {
 653         List::const_iterator i = _groups.begin ();
 654         while (i != _groups.end() && (*i)->total_channels() == ChanCount::ZERO) {
 655                 ++i;
 656         }
 657
 658         return (i == _groups.end());
 659 }
 660