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<IO> >* route_ios, 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_ios->push_back (io);
 292                         used_io.insert (io);
 293                 }
 294         }
 295 }
 296
 297 struct RouteIOs {
 298         RouteIOs (boost::shared_ptr<Route> r, boost::shared_ptr<IO> i) {
 299                 route = r;
 300                 ios.push_back (i);
 301         }
 302
 303         boost::shared_ptr<Route> route;
 304         std::list<boost::shared_ptr<IO> > ios;
 305 };
 306
 307 class RouteIOsComparator {
 308 public:
 309         bool operator() (RouteIOs const & a, RouteIOs const & b) {
 310                 return a.route->order_key (X_("editor")) < b.route->order_key (X_("editor"));
 311         }
 312 };
 313
 314 /** Gather bundles from around the system and put them in this PortGroupList.
 315  *  @param type Type of bundles to collect, or NIL for all types.
 316  */
 317 void
 318 PortGroupList::gather (ARDOUR::Session* session, ARDOUR::DataType type, bool inputs, bool allow_dups)
 319 {
 320         clear ();
 321
 322         if (session == 0) {
 323                 return;
 324         }
 325
 326         boost::shared_ptr<PortGroup> bus (new PortGroup (_("Bus")));
 327         boost::shared_ptr<PortGroup> track (new PortGroup (_("Track")));
 328         boost::shared_ptr<PortGroup> system (new PortGroup (_("System")));
 329         boost::shared_ptr<PortGroup> ardour (new PortGroup (_("Ardour")));
 330         boost::shared_ptr<PortGroup> other (new PortGroup (_("Other")));
 331
 332         /* Find the IOs which have bundles for routes and their processors.  We store
 333            these IOs in a RouteIOs class so that we can then sort the results by route
 334            order key.
 335         */
 336
 337         boost::shared_ptr<RouteList> routes = session->get_routes ();
 338         list<RouteIOs> route_ios;
 339
 340         for (RouteList::const_iterator i = routes->begin(); i != routes->end(); ++i) {
 341
 342                 /* keep track of IOs that we have taken bundles from,
 343                    so that we can avoid taking the same IO from both
 344                    Route::output() and the main_outs Delivery */
 345
 346                 set<boost::shared_ptr<IO> > used_io;
 347                 boost::shared_ptr<IO> io = inputs ? (*i)->input() : (*i)->output();
 348                 used_io.insert (io);
 349
 350                 RouteIOs rb (*i, io);
 351                 (*i)->foreach_processor (boost::bind (&PortGroupList::maybe_add_processor_to_list, this, _1, &rb.ios, inputs, used_io));
 352
 353                 route_ios.push_back (rb);
 354         }
 355
 356         /* Sort RouteIOs by the routes' editor order keys */
 357         route_ios.sort (RouteIOsComparator ());
 358
 359         /* Now put the bundles that belong to these sorted RouteIOs into the PortGroup */
 360         for (list<RouteIOs>::iterator i = route_ios.begin(); i != route_ios.end(); ++i) {
 361                 TimeAxisView* tv = PublicEditor::instance().axis_view_from_route (i->route);
 362
 363                 /* Work out which group to put these IOs' bundles in */
 364                 boost::shared_ptr<PortGroup> g;
 365                 if (boost::dynamic_pointer_cast<Track> (i->route)) {
 366                         g = track;
 367                 } else {
 368                         g = bus;
 369                 }
 370
 371                 for (list<boost::shared_ptr<IO> >::iterator j = i->ios.begin(); j != i->ios.end(); ++j) {
 372                         if (tv) {
 373                                 g->add_bundle ((*j)->bundle(), *j, tv->color ());
 374                         } else {
 375                                 g->add_bundle ((*j)->bundle(), *j);
 376                         }
 377                 }
 378         }
 379
 380         /* Bundles owned by the session; add user bundles first, then normal ones, so
 381            that UserBundles that offer the same ports as a normal bundle get priority
 382         */
 383
 384         boost::shared_ptr<BundleList> b = session->bundles ();
 385
 386         for (BundleList::iterator i = b->begin(); i != b->end(); ++i) {
 387                 if (boost::dynamic_pointer_cast<UserBundle> (*i) && (*i)->ports_are_inputs() == inputs) {
 388                         system->add_bundle (*i, allow_dups);
 389                 }
 390         }
 391
 392         for (BundleList::iterator i = b->begin(); i != b->end(); ++i) {
 393                 if (boost::dynamic_pointer_cast<UserBundle> (*i) == 0 && (*i)->ports_are_inputs() == inputs) {
 394                         system->add_bundle (*i, allow_dups);
 395                 }
 396         }
 397
 398         /* Ardour stuff */
 399
 400         if (!inputs && (type == DataType::AUDIO || type == DataType::NIL)) {
 401                 ardour->add_bundle (session->the_auditioner()->output()->bundle());
 402                 ardour->add_bundle (session->click_io()->bundle());
 403         }
 404
 405         /* Now find all other ports that we haven't thought of yet */
 406
 407         std::vector<std::string> extra_system[DataType::num_types];
 408         std::vector<std::string> extra_other[DataType::num_types];
 409
 410         const char ** ports = 0;
 411         if (type == DataType::NIL) {
 412                 ports = session->engine().get_ports ("", "", inputs ? JackPortIsInput : JackPortIsOutput);
 413         } else {
 414                 ports = session->engine().get_ports ("", type.to_jack_type(), inputs ? JackPortIsInput : JackPortIsOutput);
 415         }
 416
 417         if (ports) {
 418
 419                 int n = 0;
 420
 421                 while (ports[n]) {
 422
 423                         std::string const p = ports[n];
 424
 425                         if (!system->has_port(p) &&
 426                             !bus->has_port(p) &&
 427                             !track->has_port(p) &&
 428                             !ardour->has_port(p) &&
 429                             !other->has_port(p)) {
 430
 431                                 /* special hack: ignore MIDI ports labelled Midi-Through. these
 432                                    are basically useless and mess things up for default
 433                                    connections.
 434                                 */
 435
 436                                 if (p.find ("MIDI-Through") != string::npos) {
 437                                         ++n;
 438                                         continue;
 439                                 }
 440
 441                                 /* can't use the audio engine for this as we are looking at non-Ardour ports */
 442
 443                                 jack_port_t* jp = jack_port_by_name (session->engine().jack(), p.c_str());
 444                                 if (jp) {
 445                                         DataType t (jack_port_type (jp));
 446                                         if (t != DataType::NIL) {
 447                                                 if (port_has_prefix (p, "system:") || port_has_prefix (p, "alsa_pcm") || port_has_prefix (p, "ardour:")) {
 448                                                         extra_system[t].push_back (p);
 449                                                 } else {
 450                                                         extra_other[t].push_back (p);
 451                                                 }
 452                                         }
 453                                 }
 454                         }
 455
 456                         ++n;
 457                 }
 458
 459                 free (ports);
 460         }
 461
 462         for (DataType::iterator i = DataType::begin(); i != DataType::end(); ++i) {
 463                 if (!extra_system[*i].empty()) {
 464                         system->add_bundle (make_bundle_from_ports (extra_system[*i], *i, inputs));
 465                 }
 466         }
 467
 468         for (DataType::iterator i = DataType::begin(); i != DataType::end(); ++i) {
 469                 if (!extra_other[*i].empty()) {
 470                         other->add_bundle (make_bundle_from_ports (extra_other[*i], *i, inputs));
 471                 }
 472         }
 473
 474         if (!allow_dups) {
 475                 system->remove_duplicates ();
 476         }
 477
 478         add_group_if_not_empty (other);
 479         add_group_if_not_empty (bus);
 480         add_group_if_not_empty (track);
 481         add_group_if_not_empty (ardour);
 482         add_group_if_not_empty (system);
 483
 484         emit_changed ();
 485 }
 486
 487 boost::shared_ptr<Bundle>
 488 PortGroupList::make_bundle_from_ports (std::vector<std::string> const & p, ARDOUR::DataType type, bool inputs) const
 489 {
 490         boost::shared_ptr<Bundle> b (new Bundle ("", inputs));
 491
 492         std::string const pre = common_prefix (p);
 493         if (!pre.empty()) {
 494                 b->set_name (pre.substr (0, pre.length() - 1));
 495         }
 496
 497         for (uint32_t j = 0; j < p.size(); ++j) {
 498                 b->add_channel (p[j].substr (pre.length()), type);
 499                 b->set_port (j, p[j]);
 500         }
 501
 502         return b;
 503 }
 504
 505 bool
 506 PortGroupList::port_has_prefix (const std::string& n, const std::string& p) const
 507 {
 508         return n.substr (0, p.length()) == p;
 509 }
 510
 511 std::string
 512 PortGroupList::common_prefix_before (std::vector<std::string> const & p, std::string const & s) const
 513 {
 514         /* we must have some strings and the first must contain the separator string */
 515         if (p.empty() || p[0].find_first_of (s) == std::string::npos) {
 516                 return "";
 517         }
 518
 519         /* prefix of the first string */
 520         std::string const fp = p[0].substr (0, p[0].find_first_of (s) + 1);
 521
 522         /* see if the other strings also start with fp */
 523         uint32_t j = 1;
 524         while (j < p.size()) {
 525                 if (p[j].substr (0, fp.length()) != fp) {
 526                         break;
 527                 }
 528                 ++j;
 529         }
 530
 531         if (j != p.size()) {
 532                 return "";
 533         }
 534
 535         return fp;
 536 }
 537
 538
 539 std::string
 540 PortGroupList::common_prefix (std::vector<std::string> const & p) const
 541 {
 542         /* common prefix before '/' ? */
 543         std::string cp = common_prefix_before (p, "/");
 544         if (!cp.empty()) {
 545                 return cp;
 546         }
 547
 548         cp = common_prefix_before (p, ":");
 549         if (!cp.empty()) {
 550                 return cp;
 551         }
 552
 553         return "";
 554 }
 555
 556 void
 557 PortGroupList::clear ()
 558 {
 559         _groups.clear ();
 560         _bundle_changed_connections.drop_connections ();
 561         emit_changed ();
 562 }
 563
 564
 565 PortGroup::BundleList const &
 566 PortGroupList::bundles () const
 567 {
 568         _bundles.clear ();
 569
 570         for (PortGroupList::List::const_iterator i = begin (); i != end (); ++i) {
 571                 std::copy ((*i)->bundles().begin(), (*i)->bundles().end(), std::back_inserter (_bundles));
 572         }
 573
 574         return _bundles;
 575 }
 576
 577 ChanCount
 578 PortGroupList::total_channels () const
 579 {
 580         ChanCount n;
 581
 582         for (PortGroupList::List::const_iterator i = begin(); i != end(); ++i) {
 583                 n += (*i)->total_channels ();
 584         }
 585
 586         return n;
 587 }
 588
 589 void
 590 PortGroupList::add_group_if_not_empty (boost::shared_ptr<PortGroup> g)
 591 {
 592         if (!g->bundles().empty ()) {
 593                 add_group (g);
 594         }
 595 }
 596
 597 void
 598 PortGroupList::add_group (boost::shared_ptr<PortGroup> g)
 599 {
 600         _groups.push_back (g);
 601
 602         g->Changed.connect (_changed_connections, invalidator (*this), boost::bind (&PortGroupList::emit_changed, this), gui_context());
 603         g->BundleChanged.connect (_bundle_changed_connections, invalidator (*this), ui_bind (&PortGroupList::emit_bundle_changed, this, _1), gui_context());
 604
 605         emit_changed ();
 606 }
 607
 608 void
 609 PortGroupList::remove_bundle (boost::shared_ptr<Bundle> b)
 610 {
 611         for (List::iterator i = _groups.begin(); i != _groups.end(); ++i) {
 612                 (*i)->remove_bundle (b);
 613         }
 614
 615         emit_changed ();
 616 }
 617
 618 void
 619 PortGroupList::emit_changed ()
 620 {
 621         if (_signals_suspended) {
 622                 _pending_change = true;
 623         } else {
 624                 Changed ();
 625         }
 626 }
 627
 628 void
 629 PortGroupList::emit_bundle_changed (Bundle::Change c)
 630 {
 631         if (_signals_suspended) {
 632                 _pending_bundle_change = c;
 633         } else {
 634                 BundleChanged (c);
 635         }
 636 }
 637 void
 638 PortGroupList::suspend_signals ()
 639 {
 640         _signals_suspended = true;
 641 }
 642
 643 void
 644 PortGroupList::resume_signals ()
 645 {
 646         if (_pending_change) {
 647                 Changed ();
 648                 _pending_change = false;
 649         }
 650
 651         if (_pending_bundle_change != 0) {
 652                 BundleChanged (_pending_bundle_change);
 653                 _pending_bundle_change = (ARDOUR::Bundle::Change) 0;
 654         }
 655
 656         _signals_suspended = false;
 657 }
 658
 659 boost::shared_ptr<IO>
 660 PortGroupList::io_from_bundle (boost::shared_ptr<ARDOUR::Bundle> b) const
 661 {
 662         List::const_iterator i = _groups.begin ();
 663         while (i != _groups.end()) {
 664                 boost::shared_ptr<IO> io = (*i)->io_from_bundle (b);
 665                 if (io) {
 666                         return io;
 667                 }
 668                 ++i;
 669         }
 670
 671         return boost::shared_ptr<IO> ();
 672 }
 673
 674 bool
 675 PortGroupList::empty () const
 676 {
 677         List::const_iterator i = _groups.begin ();
 678         while (i != _groups.end() && (*i)->total_channels() == ChanCount::ZERO) {
 679                 ++i;
 680         }
 681
 682         return (i == _groups.end());
 683 }
 684