2 Copyright (C) 2002-2009 Paul Davis
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.
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.
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.
21 #include <boost/shared_ptr.hpp>
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"
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"
43 using namespace ARDOUR;
45 /** PortGroup constructor.
48 PortGroup::PortGroup (std::string const & n)
54 PortGroup::~PortGroup()
56 for (BundleList::iterator i = _bundles.begin(); i != _bundles.end(); ++i) {
62 /** Add a bundle to a group.
64 * @param allow_dups true to allow the group to contain more than one bundle with the same port, otherwise false.
67 PortGroup::add_bundle (boost::shared_ptr<Bundle> b, bool allow_dups)
69 add_bundle_internal (b, boost::shared_ptr<IO> (), false, Gdk::Color (), allow_dups);
72 /** Add a bundle to a group.
74 * @param io IO whose ports are in the bundle.
77 PortGroup::add_bundle (boost::shared_ptr<Bundle> b, boost::shared_ptr<IO> io)
79 add_bundle_internal (b, io, false, Gdk::Color (), false);
82 /** Add a bundle to a group.
84 * @param c Colour to represent the bundle with.
87 PortGroup::add_bundle (boost::shared_ptr<Bundle> b, boost::shared_ptr<IO> io, Gdk::Color c)
89 add_bundle_internal (b, io, true, c, false);
92 PortGroup::BundleRecord::BundleRecord (boost::shared_ptr<ARDOUR::Bundle> b, boost::shared_ptr<ARDOUR::IO> iop, Gdk::Color c, bool has_c)
101 PortGroup::add_bundle_internal (boost::shared_ptr<Bundle> b, boost::shared_ptr<IO> io, bool has_colour, Gdk::Color colour, bool allow_dups)
107 /* don't add this bundle if we already have one with the same ports */
109 BundleList::iterator i = _bundles.begin ();
110 while (i != _bundles.end() && b->has_same_ports ((*i)->bundle) == false) {
114 if (i != _bundles.end ()) {
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);
127 PortGroup::remove_bundle (boost::shared_ptr<Bundle> b)
131 BundleList::iterator i = _bundles.begin ();
132 while (i != _bundles.end() && (*i)->bundle != b) {
136 if (i == _bundles.end()) {
147 PortGroup::bundle_changed (Bundle::Change c)
156 for (BundleList::iterator i = _bundles.begin(); i != _bundles.end(); ++i) {
165 PortGroup::has_port (std::string const& p) const
167 for (BundleList::const_iterator i = _bundles.begin(); i != _bundles.end(); ++i) {
168 if ((*i)->bundle->offers_port_alone (p)) {
176 boost::shared_ptr<Bundle>
177 PortGroup::only_bundle ()
179 assert (_bundles.size() == 1);
180 return _bundles.front()->bundle;
185 PortGroup::total_channels () const
188 for (BundleList::const_iterator i = _bundles.begin(); i != _bundles.end(); ++i) {
189 n += (*i)->bundle->nchannels ();
195 boost::shared_ptr<IO>
196 PortGroup::io_from_bundle (boost::shared_ptr<ARDOUR::Bundle> b) const
198 BundleList::const_iterator i = _bundles.begin ();
199 while (i != _bundles.end() && (*i)->bundle != b) {
203 if (i == _bundles.end()) {
204 return boost::shared_ptr<IO> ();
210 /** Remove bundles whose channels are already represented by other, larger bundles */
212 PortGroup::remove_duplicates ()
214 BundleList::iterator i = _bundles.begin();
215 while (i != _bundles.end()) {
217 BundleList::iterator tmp = i;
222 for (BundleList::iterator j = _bundles.begin(); j != _bundles.end(); ++j) {
224 if ((*j)->bundle->nchannels() > (*i)->bundle->nchannels()) {
225 /* this bundle is larger */
228 while (k < (*i)->bundle->nchannels().n_total()) {
229 /* see if this channel on *i has an equivalent on *j */
231 while (l < (*j)->bundle->nchannels().n_total() && (*i)->bundle->channel_ports (k) != (*j)->bundle->channel_ports (l)) {
235 if (l == (*j)->bundle->nchannels().n_total()) {
243 if (k == (*i)->bundle->nchannels().n_total()) {
244 /* all channels on *i are represented by the larger bundle *j, so remove *i */
260 /** PortGroupList constructor.
262 PortGroupList::PortGroupList ()
263 : _signals_suspended (false), _pending_change (false), _pending_bundle_change ((Bundle::Change) 0)
268 PortGroupList::~PortGroupList()
270 /* XXX need to clean up bundles, but ownership shared with PortGroups */
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
278 boost::shared_ptr<Processor> p (wp.lock());
284 boost::shared_ptr<IOProcessor> iop = boost::dynamic_pointer_cast<IOProcessor> (p);
288 boost::shared_ptr<IO> io = inputs ? iop->input() : iop->output();
290 if (io && used_io.find (io) == used_io.end()) {
291 route_bundles->push_back (io->bundle ());
298 /** Gather bundles from around the system and put them in this PortGroupList */
300 PortGroupList::gather (ARDOUR::Session* session, ARDOUR::DataType type, bool inputs, bool allow_dups)
308 boost::shared_ptr<PortGroup> bus (new PortGroup (_("Bus")));
309 boost::shared_ptr<PortGroup> track (new PortGroup (_("Track")));
310 boost::shared_ptr<PortGroup> system (new PortGroup (_("System")));
311 boost::shared_ptr<PortGroup> ardour (new PortGroup (_("Ardour")));
312 boost::shared_ptr<PortGroup> other (new PortGroup (_("Other")));
314 /* Find the bundles for routes. We use the RouteBundle class to join
315 the route's input/output and processor bundles together so that they
316 are presented as one bundle in the matrix. */
318 boost::shared_ptr<RouteList> routes = session->get_routes ();
320 for (RouteList::const_iterator i = routes->begin(); i != routes->end(); ++i) {
322 list<boost::shared_ptr<Bundle> > route_bundles;
324 /* keep track of IOs that we have taken bundles from,
325 so that we can avoid taking the same IO from both
326 Route::output() and the main_outs Delivery */
328 set<boost::shared_ptr<IO> > used_io;
329 boost::shared_ptr<IO> io = inputs ? (*i)->input() : (*i)->output();
332 route_bundles.push_back (io->bundle ());
334 (*i)->foreach_processor (boost::bind (&PortGroupList::maybe_add_processor_to_list, this, _1, &route_bundles, inputs, used_io));
336 /* Work out which group to put these bundles in */
337 boost::shared_ptr<PortGroup> g;
338 if (boost::dynamic_pointer_cast<Track> (*i)) {
344 TimeAxisView* tv = PublicEditor::instance().axis_view_from_route (*i);
345 for (list<boost::shared_ptr<Bundle> >::iterator i = route_bundles.begin(); i != route_bundles.end(); ++i) {
347 g->add_bundle (*i, io, tv->color ());
349 g->add_bundle (*i, io);
354 /* Bundles owned by the session; add user bundles first, then normal ones, so
355 that UserBundles that offer the same ports as a normal bundle get priority
358 boost::shared_ptr<BundleList> b = session->bundles ();
360 for (BundleList::iterator i = b->begin(); i != b->end(); ++i) {
361 if (boost::dynamic_pointer_cast<UserBundle> (*i) && (*i)->ports_are_inputs() == inputs) {
362 system->add_bundle (*i, allow_dups);
366 for (BundleList::iterator i = b->begin(); i != b->end(); ++i) {
367 if (boost::dynamic_pointer_cast<UserBundle> (*i) == 0 && (*i)->ports_are_inputs() == inputs) {
368 system->add_bundle (*i, allow_dups);
374 if (!inputs && type == DataType::AUDIO) {
375 ardour->add_bundle (session->the_auditioner()->output()->bundle());
376 ardour->add_bundle (session->click_io()->bundle());
379 /* Now find all other ports that we haven't thought of yet */
381 std::vector<std::string> extra_system;
382 std::vector<std::string> extra_other;
384 const char **ports = session->engine().get_ports ("", type.to_jack_type(), inputs ?
385 JackPortIsInput : JackPortIsOutput);
389 string client_matching_string;
391 client_matching_string = session->engine().client_name();
392 client_matching_string += ':';
396 std::string const p = ports[n];
398 if (!system->has_port(p) &&
400 !track->has_port(p) &&
401 !ardour->has_port(p) &&
402 !other->has_port(p)) {
404 /* special hack: ignore MIDI ports labelled Midi-Through. these
405 are basically useless and mess things up for default
409 if (p.find ("MIDI-Through") != string::npos) {
414 if (port_has_prefix (p, "system:") ||
415 port_has_prefix (p, "alsa_pcm") ||
416 port_has_prefix (p, "ardour:")) {
417 extra_system.push_back (p);
419 extra_other.push_back (p);
429 if (!extra_system.empty()) {
430 boost::shared_ptr<Bundle> b = make_bundle_from_ports (extra_system, type, inputs);
431 system->add_bundle (b);
434 if (!extra_other.empty()) {
435 other->add_bundle (make_bundle_from_ports (extra_other, type, inputs));
439 system->remove_duplicates ();
442 add_group_if_not_empty (other);
443 add_group_if_not_empty (bus);
444 add_group_if_not_empty (track);
445 add_group_if_not_empty (ardour);
446 add_group_if_not_empty (system);
451 boost::shared_ptr<Bundle>
452 PortGroupList::make_bundle_from_ports (std::vector<std::string> const & p, ARDOUR::DataType type, bool inputs) const
454 boost::shared_ptr<Bundle> b (new Bundle ("", inputs));
456 std::string const pre = common_prefix (p);
458 b->set_name (pre.substr (0, pre.length() - 1));
461 for (uint32_t j = 0; j < p.size(); ++j) {
462 b->add_channel (p[j].substr (pre.length()), type);
463 b->set_port (j, p[j]);
470 PortGroupList::port_has_prefix (const std::string& n, const std::string& p) const
472 return n.substr (0, p.length()) == p;
476 PortGroupList::common_prefix_before (std::vector<std::string> const & p, std::string const & s) const
478 /* we must have some strings and the first must contain the separator string */
479 if (p.empty() || p[0].find_first_of (s) == std::string::npos) {
483 /* prefix of the first string */
484 std::string const fp = p[0].substr (0, p[0].find_first_of (s) + 1);
486 /* see if the other strings also start with fp */
488 while (j < p.size()) {
489 if (p[j].substr (0, fp.length()) != fp) {
504 PortGroupList::common_prefix (std::vector<std::string> const & p) const
506 /* common prefix before '/' ? */
507 std::string cp = common_prefix_before (p, "/");
512 cp = common_prefix_before (p, ":");
521 PortGroupList::clear ()
524 _bundle_changed_connections.drop_connections ();
529 PortGroup::BundleList const &
530 PortGroupList::bundles () const
534 for (PortGroupList::List::const_iterator i = begin (); i != end (); ++i) {
535 std::copy ((*i)->bundles().begin(), (*i)->bundles().end(), std::back_inserter (_bundles));
542 PortGroupList::total_channels () const
546 for (PortGroupList::List::const_iterator i = begin(); i != end(); ++i) {
547 n += (*i)->total_channels ();
554 PortGroupList::add_group_if_not_empty (boost::shared_ptr<PortGroup> g)
556 if (!g->bundles().empty ()) {
562 PortGroupList::add_group (boost::shared_ptr<PortGroup> g)
564 _groups.push_back (g);
566 g->Changed.connect (_changed_connections, invalidator (*this), boost::bind (&PortGroupList::emit_changed, this), gui_context());
567 g->BundleChanged.connect (_bundle_changed_connections, invalidator (*this), ui_bind (&PortGroupList::emit_bundle_changed, this, _1), gui_context());
573 PortGroupList::remove_bundle (boost::shared_ptr<Bundle> b)
575 for (List::iterator i = _groups.begin(); i != _groups.end(); ++i) {
576 (*i)->remove_bundle (b);
583 PortGroupList::emit_changed ()
585 if (_signals_suspended) {
586 _pending_change = true;
593 PortGroupList::emit_bundle_changed (Bundle::Change c)
595 if (_signals_suspended) {
596 _pending_bundle_change = c;
602 PortGroupList::suspend_signals ()
604 _signals_suspended = true;
608 PortGroupList::resume_signals ()
610 if (_pending_change) {
612 _pending_change = false;
615 if (_pending_bundle_change != 0) {
616 BundleChanged (_pending_bundle_change);
617 _pending_bundle_change = (ARDOUR::Bundle::Change) 0;
620 _signals_suspended = false;
623 boost::shared_ptr<IO>
624 PortGroupList::io_from_bundle (boost::shared_ptr<ARDOUR::Bundle> b) const
626 List::const_iterator i = _groups.begin ();
627 while (i != _groups.end()) {
628 boost::shared_ptr<IO> io = (*i)->io_from_bundle (b);
635 return boost::shared_ptr<IO> ();
639 PortGroupList::empty () const
641 List::const_iterator i = _groups.begin ();
642 while (i != _groups.end() && (*i)->total_channels() == ChanCount::ZERO) {
646 return (i == _groups.end());