libs/ardour/bundle.cc

   1 /*
   2     Copyright (C) 2002 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 <algorithm>
  21
  22 #include "ardour/bundle.h"
  23 #include "ardour/audioengine.h"
  24 #include "ardour/port.h"
  25
  26 #include "pbd/i18n.h"
  27
  28 using namespace std;
  29 using namespace ARDOUR;
  30 using namespace PBD;
  31
  32 /** Construct an audio bundle.
  33  *  @param i true if ports are inputs, otherwise false.
  34  */
  35 Bundle::Bundle (bool i)
  36         : _ports_are_inputs (i),
  37           _signals_suspended (false),
  38           _pending_change (Change (0))
  39 {
  40
  41 }
  42
  43
  44 /** Construct an audio bundle.
  45  *  @param n Name.
  46  *  @param i true if ports are inputs, otherwise false.
  47  */
  48 Bundle::Bundle (std::string const & n, bool i)
  49         : _name (n),
  50           _ports_are_inputs (i),
  51           _signals_suspended (false),
  52           _pending_change (Change (0))
  53 {
  54
  55 }
  56
  57 Bundle::Bundle (boost::shared_ptr<Bundle> other)
  58         : _channel (other->_channel),
  59           _name (other->_name),
  60           _ports_are_inputs (other->_ports_are_inputs),
  61           _signals_suspended (other->_signals_suspended),
  62           _pending_change (other->_pending_change)
  63 {
  64
  65 }
  66
  67 ChanCount
  68 Bundle::nchannels () const
  69 {
  70         Glib::Threads::Mutex::Lock lm (_channel_mutex);
  71
  72         ChanCount c;
  73         for (vector<Channel>::const_iterator i = _channel.begin(); i != _channel.end(); ++i) {
  74                 c.set (i->type, c.get (i->type) + 1);
  75         }
  76
  77         return c;
  78 }
  79
  80 Bundle::PortList const &
  81 Bundle::channel_ports (uint32_t c) const
  82 {
  83         assert (c < nchannels().n_total());
  84
  85         Glib::Threads::Mutex::Lock lm (_channel_mutex);
  86         return _channel[c].ports;
  87 }
  88
  89 /** Add an association between one of our channels and a port.
  90  *  @param ch Channel index.
  91  *  @param portname full port name to associate with (including prefix).
  92  */
  93 void
  94 Bundle::add_port_to_channel (uint32_t ch, string portname)
  95 {
  96         assert (ch < nchannels().n_total());
  97         assert (portname.find_first_of (':') != string::npos);
  98
  99         {
 100                 Glib::Threads::Mutex::Lock lm (_channel_mutex);
 101                 _channel[ch].ports.push_back (portname);
 102         }
 103
 104         emit_changed (PortsChanged);
 105 }
 106
 107 /** Disassociate a port from one of our channels.
 108  *  @param ch Channel index.
 109  *  @param portname port name to disassociate from.
 110  */
 111 void
 112 Bundle::remove_port_from_channel (uint32_t ch, string portname)
 113 {
 114         assert (ch < nchannels().n_total());
 115
 116         bool changed = false;
 117
 118         {
 119                 Glib::Threads::Mutex::Lock lm (_channel_mutex);
 120                 PortList& pl = _channel[ch].ports;
 121                 PortList::iterator i = find (pl.begin(), pl.end(), portname);
 122
 123                 if (i != pl.end()) {
 124                         pl.erase (i);
 125                         changed = true;
 126                 }
 127         }
 128
 129         if (changed) {
 130                 emit_changed (PortsChanged);
 131         }
 132 }
 133
 134 /** Set a single port to be associated with a channel, removing any others.
 135  *  @param ch Channel.
 136  *  @param portname Full port name, including prefix.
 137  */
 138 void
 139 Bundle::set_port (uint32_t ch, string portname)
 140 {
 141         assert (ch < nchannels().n_total());
 142         assert (portname.find_first_of (':') != string::npos);
 143
 144         {
 145                 Glib::Threads::Mutex::Lock lm (_channel_mutex);
 146                 _channel[ch].ports.clear ();
 147                 _channel[ch].ports.push_back (portname);
 148         }
 149
 150         emit_changed (PortsChanged);
 151 }
 152
 153 /** @param n Channel name */
 154 void
 155 Bundle::add_channel (std::string const & n, DataType t)
 156 {
 157         {
 158                 Glib::Threads::Mutex::Lock lm (_channel_mutex);
 159                 _channel.push_back (Channel (n, t));
 160         }
 161
 162         emit_changed (ConfigurationChanged);
 163 }
 164
 165 /** @param n Channel name */
 166 void
 167 Bundle::add_channel (std::string const & n, DataType t, PortList p)
 168 {
 169         {
 170                 Glib::Threads::Mutex::Lock lm (_channel_mutex);
 171                 _channel.push_back (Channel (n, t, p));
 172         }
 173
 174         emit_changed (ConfigurationChanged);
 175 }
 176
 177 /** @param n Channel name */
 178 void
 179 Bundle::add_channel (std::string const & n, DataType t, std::string const & p)
 180 {
 181         {
 182                 Glib::Threads::Mutex::Lock lm (_channel_mutex);
 183                 _channel.push_back (Channel (n, t, p));
 184         }
 185
 186         emit_changed (ConfigurationChanged);
 187 }
 188
 189 bool
 190 Bundle::port_attached_to_channel (uint32_t ch, std::string portname)
 191 {
 192         assert (ch < nchannels().n_total());
 193
 194         Glib::Threads::Mutex::Lock lm (_channel_mutex);
 195         return (std::find (_channel[ch].ports.begin (), _channel[ch].ports.end (), portname) != _channel[ch].ports.end ());
 196 }
 197
 198 /** Remove a channel.
 199  *  @param ch Channel.
 200  */
 201 void
 202 Bundle::remove_channel (uint32_t ch)
 203 {
 204         assert (ch < nchannels().n_total());
 205
 206         Glib::Threads::Mutex::Lock lm (_channel_mutex);
 207         _channel.erase (_channel.begin () + ch);
 208
 209         lm.release();
 210         emit_changed (ConfigurationChanged);
 211 }
 212
 213 /** Remove all channels */
 214 void
 215 Bundle::remove_channels ()
 216 {
 217         Glib::Threads::Mutex::Lock lm (_channel_mutex);
 218
 219         _channel.clear ();
 220
 221         lm.release();
 222         emit_changed (ConfigurationChanged);
 223 }
 224
 225 /** @param p Port name.
 226  *  @return true if any channel is associated with p.
 227  */
 228 bool
 229 Bundle::offers_port (std::string p) const
 230 {
 231         Glib::Threads::Mutex::Lock lm (_channel_mutex);
 232
 233         for (std::vector<Channel>::const_iterator i = _channel.begin(); i != _channel.end(); ++i) {
 234                 for (PortList::const_iterator j = i->ports.begin(); j != i->ports.end(); ++j) {
 235                         if (*j == p) {
 236                                 return true;
 237                         }
 238                 }
 239         }
 240
 241         return false;
 242 }
 243
 244 /** @param p Port name.
 245  *  @return true if this bundle offers this port on its own on a channel.
 246  */
 247 bool
 248 Bundle::offers_port_alone (std::string p) const
 249 {
 250         Glib::Threads::Mutex::Lock lm (_channel_mutex);
 251
 252         for (std::vector<Channel>::const_iterator i = _channel.begin(); i != _channel.end(); ++i) {
 253                 if (i->ports.size() == 1 && i->ports[0] == p) {
 254                         return true;
 255                 }
 256         }
 257
 258         return false;
 259 }
 260
 261
 262 /** @param ch Channel.
 263  *  @return Channel name.
 264  */
 265 std::string
 266 Bundle::channel_name (uint32_t ch) const
 267 {
 268         assert (ch < nchannels().n_total());
 269
 270         Glib::Threads::Mutex::Lock lm (_channel_mutex);
 271         return _channel[ch].name;
 272 }
 273
 274 /** Set the name of a channel.
 275  *  @param ch Channel.
 276  *  @param n New name.
 277  */
 278 void
 279 Bundle::set_channel_name (uint32_t ch, std::string const & n)
 280 {
 281         assert (ch < nchannels().n_total());
 282
 283         {
 284                 Glib::Threads::Mutex::Lock lm (_channel_mutex);
 285                 _channel[ch].name = n;
 286         }
 287
 288         emit_changed (NameChanged);
 289 }
 290
 291 /** Take the channels from another bundle and add them to this bundle,
 292  *  so that channels from other are added to this (with their ports)
 293  *  and are named "<other_bundle_name> <other_channel_name>".
 294  */
 295 void
 296 Bundle::add_channels_from_bundle (boost::shared_ptr<Bundle> other)
 297 {
 298         uint32_t const ch = nchannels().n_total();
 299
 300         for (uint32_t i = 0; i < other->nchannels().n_total(); ++i) {
 301
 302                 std::stringstream s;
 303                 s << other->name() << " " << other->channel_name(i);
 304
 305                 add_channel (s.str(), other->channel_type(i));
 306
 307                 PortList const& pl = other->channel_ports (i);
 308                 for (uint32_t j = 0; j < pl.size(); ++j) {
 309                         add_port_to_channel (ch + i, pl[j]);
 310                 }
 311         }
 312 }
 313
 314 /** Connect the ports associated with our channels to the ports associated
 315  *  with another bundle's channels.
 316  *  @param other Other bundle.
 317  *  @param engine AudioEngine to use to make the connections.
 318  */
 319 void
 320 Bundle::connect (boost::shared_ptr<Bundle> other, AudioEngine & engine)
 321 {
 322         uint32_t const N = nchannels().n_total();
 323         assert (N == other->nchannels().n_total());
 324
 325         for (uint32_t i = 0; i < N; ++i) {
 326                 Bundle::PortList const & our_ports = channel_ports (i);
 327                 Bundle::PortList const & other_ports = other->channel_ports (i);
 328
 329                 for (Bundle::PortList::const_iterator j = our_ports.begin(); j != our_ports.end(); ++j) {
 330                         for (Bundle::PortList::const_iterator k = other_ports.begin(); k != other_ports.end(); ++k) {
 331                                 engine.connect (*j, *k);
 332                         }
 333                 }
 334         }
 335 }
 336
 337 void
 338 Bundle::disconnect (boost::shared_ptr<Bundle> other, AudioEngine & engine)
 339 {
 340         uint32_t const N = nchannels().n_total();
 341         assert (N == other->nchannels().n_total());
 342
 343         for (uint32_t i = 0; i < N; ++i) {
 344                 Bundle::PortList const & our_ports = channel_ports (i);
 345                 Bundle::PortList const & other_ports = other->channel_ports (i);
 346
 347                 for (Bundle::PortList::const_iterator j = our_ports.begin(); j != our_ports.end(); ++j) {
 348                         for (Bundle::PortList::const_iterator k = other_ports.begin(); k != other_ports.end(); ++k) {
 349                                 engine.disconnect (*j, *k);
 350                         }
 351                 }
 352         }
 353 }
 354
 355 /** Remove all ports from all channels */
 356 void
 357 Bundle::remove_ports_from_channels ()
 358 {
 359         {
 360                 Glib::Threads::Mutex::Lock lm (_channel_mutex);
 361                 for (uint32_t c = 0; c < _channel.size(); ++c) {
 362                         _channel[c].ports.clear ();
 363                 }
 364
 365         }
 366
 367         emit_changed (PortsChanged);
 368 }
 369
 370 /** Remove all ports from a given channel.
 371  *  @param ch Channel.
 372  */
 373 void
 374 Bundle::remove_ports_from_channel (uint32_t ch)
 375 {
 376         assert (ch < nchannels().n_total());
 377
 378         {
 379                 Glib::Threads::Mutex::Lock lm (_channel_mutex);
 380                 _channel[ch].ports.clear ();
 381         }
 382
 383         emit_changed (PortsChanged);
 384 }
 385
 386 void
 387 Bundle::suspend_signals ()
 388 {
 389         _signals_suspended = true;
 390 }
 391
 392 void
 393 Bundle::resume_signals ()
 394 {
 395         if (_pending_change) {
 396                 Changed (_pending_change);
 397                 _pending_change = Change (0);
 398         }
 399
 400         _signals_suspended = false;
 401 }
 402
 403 void
 404 Bundle::emit_changed (Change c)
 405 {
 406         if (_signals_suspended) {
 407                 _pending_change = Change (int (_pending_change) | int (c));
 408         } else {
 409                 Changed (c);
 410         }
 411 }
 412
 413 bool
 414 Bundle::connected_to (boost::shared_ptr<Bundle> other, AudioEngine & engine)
 415 {
 416         if (_ports_are_inputs == other->_ports_are_inputs || nchannels() != other->nchannels()) {
 417                 return false;
 418         }
 419
 420         for (uint32_t i = 0; i < nchannels().n_total(); ++i) {
 421                 Bundle::PortList const & A = channel_ports (i);
 422                 Bundle::PortList const & B = other->channel_ports (i);
 423
 424                 for (uint32_t j = 0; j < A.size(); ++j) {
 425                         for (uint32_t k = 0; k < B.size(); ++k) {
 426
 427                                 boost::shared_ptr<Port> p = engine.get_port_by_name (A[j]);
 428                                 boost::shared_ptr<Port> q = engine.get_port_by_name (B[k]);
 429
 430                                 if (!p && !q) {
 431                                         return false;
 432                                 }
 433
 434                                 if (p && !p->connected_to (B[k])) {
 435                                         return false;
 436                                 } else if (q && !q->connected_to (A[j])) {
 437                                         return false;
 438                                 }
 439                         }
 440                 }
 441         }
 442
 443         return true;
 444 }
 445
 446 /** This must not be called in code executed as a response to a backend event,
 447  *  as it uses the backend port_get_all_connections().
 448  *  @return true if any of this bundle's channels are connected to anything.
 449  */
 450 bool
 451 Bundle::connected_to_anything (AudioEngine& engine)
 452 {
 453         PortManager& pm (engine);
 454
 455         for (uint32_t i = 0; i < nchannels().n_total(); ++i) {
 456                 Bundle::PortList const & ports = channel_ports (i);
 457
 458                 for (uint32_t j = 0; j < ports.size(); ++j) {
 459
 460                         /* ports[j] may not be an Ardour port, so use the port manager directly
 461                            rather than doing it with Port.
 462                         */
 463
 464                         if (pm.connected (ports[j])) {
 465                                 return true;
 466                         }
 467                 }
 468         }
 469
 470         return false;
 471 }
 472
 473 void
 474 Bundle::set_ports_are_inputs ()
 475 {
 476         _ports_are_inputs = true;
 477         emit_changed (DirectionChanged);
 478 }
 479
 480 void
 481 Bundle::set_ports_are_outputs ()
 482 {
 483         _ports_are_inputs = false;
 484         emit_changed (DirectionChanged);
 485 }
 486
 487 /** Set the name.
 488  *  @param n New name.
 489  */
 490 void
 491 Bundle::set_name (string const & n)
 492 {
 493         _name = n;
 494         emit_changed (NameChanged);
 495 }
 496
 497 /** @param b Other bundle.
 498  *  @return true if b has the same number of channels as this bundle, and those channels have corresponding ports.
 499  */
 500 bool
 501 Bundle::has_same_ports (boost::shared_ptr<Bundle> b) const
 502 {
 503         uint32_t const N = nchannels().n_total();
 504
 505         if (b->nchannels().n_total() != N) {
 506                 return false;
 507         }
 508
 509         /* XXX: probably should sort channel port lists before comparing them */
 510
 511         for (uint32_t i = 0; i < N; ++i) {
 512                 if (channel_ports (i) != b->channel_ports (i)) {
 513                         return false;
 514                 }
 515         }
 516
 517         return true;
 518 }
 519
 520 DataType
 521 Bundle::channel_type (uint32_t c) const
 522 {
 523         assert (c < nchannels().n_total());
 524
 525         Glib::Threads::Mutex::Lock lm (_channel_mutex);
 526         return _channel[c].type;
 527 }
 528
 529 ostream &
 530 operator<< (ostream& os, Bundle const & b)
 531 {
 532         os << "BUNDLE " << b.nchannels() << " channels: ";
 533         for (uint32_t i = 0; i < b.nchannels().n_total(); ++i) {
 534                 os << "( ";
 535                 Bundle::PortList const & pl = b.channel_ports (i);
 536                 for (Bundle::PortList::const_iterator j = pl.begin(); j != pl.end(); ++j) {
 537                         os << *j << " ";
 538                 }
 539                 os << ") ";
 540         }
 541
 542         return os;
 543 }
 544
 545 bool
 546 Bundle::operator== (Bundle const & other)
 547 {
 548         return _channel == other._channel;
 549 }
 550
 551 /** Given an index of a channel as the nth channel of a particular type,
 552  *  return an index of that channel when considering channels of all types.
 553  *
 554  *  e.g. given a bundle with channels:
 555  *          fred   [audio]
 556  *          jim    [audio]
 557  *          sheila [midi]
 558  *
 559  * If t == MIDI and c == 0, then we would return 2, as 2 is the index of the
 560  * 0th MIDI channel.
 561  *
 562  * If t == NIL, we just return c.
 563  */
 564
 565 uint32_t
 566 Bundle::type_channel_to_overall (DataType t, uint32_t c) const
 567 {
 568         if (t == DataType::NIL) {
 569                 return c;
 570         }
 571
 572         Glib::Threads::Mutex::Lock lm (_channel_mutex);
 573
 574         vector<Channel>::const_iterator i = _channel.begin ();
 575
 576         uint32_t o = 0;
 577
 578         while (1) {
 579
 580                 assert (i != _channel.end ());
 581
 582                 if (i->type != t) {
 583                         ++i;
 584                 } else {
 585                         if (c == 0) {
 586                                 return o;
 587                         }
 588                         --c;
 589                 }
 590
 591                 ++o;
 592         }
 593
 594         abort(); /* NOTREACHED */
 595         return -1;
 596 }
 597
 598 /** Perform the reverse of type_channel_to_overall */
 599 uint32_t
 600 Bundle::overall_channel_to_type (DataType t, uint32_t c) const
 601 {
 602         if (t == DataType::NIL) {
 603                 return c;
 604         }
 605
 606         Glib::Threads::Mutex::Lock lm (_channel_mutex);
 607
 608         uint32_t s = 0;
 609
 610         vector<Channel>::const_iterator i = _channel.begin ();
 611         for (uint32_t j = 0; j < c; ++j) {
 612                 if (i->type == t) {
 613                         ++s;
 614                 }
 615                 ++i;
 616         }
 617
 618         return s;
 619 }