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 "port_group.h"
34 #include "port_matrix.h"
35 #include "time_axis_view.h"
36 #include "public_editor.h"
42 using namespace ARDOUR;
44 /** PortGroup constructor.
47 PortGroup::PortGroup (std::string const & n)
53 PortGroup::~PortGroup()
55 for (BundleList::iterator i = _bundles.begin(); i != _bundles.end(); ++i) {
61 /** Add a bundle to a group.
63 * @param allow_dups true to allow the group to contain more than one bundle with the same port, otherwise false.
66 PortGroup::add_bundle (boost::shared_ptr<Bundle> b, bool allow_dups)
68 add_bundle_internal (b, boost::shared_ptr<IO> (), false, Gdk::Color (), allow_dups);
71 /** Add a bundle to a group.
73 * @param io IO whose ports are in the bundle.
76 PortGroup::add_bundle (boost::shared_ptr<Bundle> b, boost::shared_ptr<IO> io)
78 add_bundle_internal (b, io, false, Gdk::Color (), false);
81 /** Add a bundle to a group.
83 * @param c Colour to represent the bundle with.
86 PortGroup::add_bundle (boost::shared_ptr<Bundle> b, boost::shared_ptr<IO> io, Gdk::Color c)
88 add_bundle_internal (b, io, true, c, false);
91 PortGroup::BundleRecord::BundleRecord (boost::shared_ptr<ARDOUR::Bundle> b, boost::shared_ptr<ARDOUR::IO> iop, Gdk::Color c, bool has_c)
100 PortGroup::add_bundle_internal (boost::shared_ptr<Bundle> b, boost::shared_ptr<IO> io, bool has_colour, Gdk::Color colour, bool allow_dups)
106 /* don't add this bundle if we already have one with the same ports */
108 BundleList::iterator i = _bundles.begin ();
109 while (i != _bundles.end() && b->has_same_ports ((*i)->bundle) == false) {
113 if (i != _bundles.end ()) {
118 BundleRecord* br = new BundleRecord (b, io, colour, has_colour);
119 b->Changed.connect (br->changed_connection, boost::bind (&PortGroup::bundle_changed, this, _1));
120 _bundles.push_back (br);
126 PortGroup::remove_bundle (boost::shared_ptr<Bundle> b)
130 BundleList::iterator i = _bundles.begin ();
131 while (i != _bundles.end() && (*i)->bundle != b) {
135 if (i == _bundles.end()) {
146 PortGroup::bundle_changed (Bundle::Change c)
155 for (BundleList::iterator i = _bundles.begin(); i != _bundles.end(); ++i) {
164 PortGroup::has_port (std::string const& p) const
166 for (BundleList::const_iterator i = _bundles.begin(); i != _bundles.end(); ++i) {
167 if ((*i)->bundle->offers_port_alone (p)) {
175 boost::shared_ptr<Bundle>
176 PortGroup::only_bundle ()
178 assert (_bundles.size() == 1);
179 return _bundles.front()->bundle;
184 PortGroup::total_channels () const
187 for (BundleList::const_iterator i = _bundles.begin(); i != _bundles.end(); ++i) {
188 n += (*i)->bundle->nchannels ();
194 boost::shared_ptr<IO>
195 PortGroup::io_from_bundle (boost::shared_ptr<ARDOUR::Bundle> b) const
197 BundleList::const_iterator i = _bundles.begin ();
198 while (i != _bundles.end() && (*i)->bundle != b) {
202 if (i == _bundles.end()) {
203 return boost::shared_ptr<IO> ();
210 /** PortGroupList constructor.
212 PortGroupList::PortGroupList ()
213 : _type (DataType::AUDIO), _signals_suspended (false), _pending_change (false), _pending_bundle_change ((Bundle::Change) 0)
218 PortGroupList::~PortGroupList()
220 /* XXX need to clean up bundles, but ownership shared with PortGroups */
224 PortGroupList::set_type (DataType t)
231 PortGroupList::maybe_add_processor_to_list (
232 boost::weak_ptr<Processor> wp, list<boost::shared_ptr<Bundle> >* route_bundles, bool inputs, set<boost::shared_ptr<IO> >& used_io
235 boost::shared_ptr<Processor> p (wp.lock());
241 boost::shared_ptr<IOProcessor> iop = boost::dynamic_pointer_cast<IOProcessor> (p);
245 boost::shared_ptr<IO> io = inputs ? iop->input() : iop->output();
247 if (io && used_io.find (io) == used_io.end()) {
248 route_bundles->push_back (io->bundle ());
255 /** Gather bundles from around the system and put them in this PortGroupList */
257 PortGroupList::gather (ARDOUR::Session* session, bool inputs, bool allow_dups)
265 boost::shared_ptr<PortGroup> bus (new PortGroup (_("Bus")));
266 boost::shared_ptr<PortGroup> track (new PortGroup (_("Track")));
267 boost::shared_ptr<PortGroup> system (new PortGroup (_("System")));
268 boost::shared_ptr<PortGroup> ardour (new PortGroup (_("Ardour")));
269 boost::shared_ptr<PortGroup> other (new PortGroup (_("Other")));
271 /* Find the bundles for routes. We use the RouteBundle class to join
272 the route's input/output and processor bundles together so that they
273 are presented as one bundle in the matrix. */
275 boost::shared_ptr<RouteList> routes = session->get_routes ();
277 for (RouteList::const_iterator i = routes->begin(); i != routes->end(); ++i) {
279 list<boost::shared_ptr<Bundle> > route_bundles;
281 /* keep track of IOs that we have taken bundles from,
282 so that we can avoid taking the same IO from both
283 Route::output() and the main_outs Delivery */
285 set<boost::shared_ptr<IO> > used_io;
286 boost::shared_ptr<IO> io = inputs ? (*i)->input() : (*i)->output();
289 route_bundles.push_back (io->bundle ());
291 (*i)->foreach_processor (boost::bind (&PortGroupList::maybe_add_processor_to_list, this, _1, &route_bundles, inputs, used_io));
293 /* Work out which group to put these bundles in */
294 boost::shared_ptr<PortGroup> g;
295 if (_type == DataType::AUDIO) {
297 if (boost::dynamic_pointer_cast<AudioTrack> (*i)) {
299 } else if (!boost::dynamic_pointer_cast<MidiTrack>(*i)) {
304 } else if (_type == DataType::MIDI) {
306 if (boost::dynamic_pointer_cast<MidiTrack> (*i)) {
310 /* No MIDI busses yet */
315 TimeAxisView* tv = PublicEditor::instance().axis_view_from_route (*i);
316 for (list<boost::shared_ptr<Bundle> >::iterator i = route_bundles.begin(); i != route_bundles.end(); ++i) {
318 g->add_bundle (*i, io, tv->color ());
320 g->add_bundle (*i, io);
326 /* Bundles owned by the session; add user bundles first, then normal ones, so
327 that UserBundles that offer the same ports as a normal bundle get priority
330 boost::shared_ptr<BundleList> b = session->bundles ();
332 for (BundleList::iterator i = b->begin(); i != b->end(); ++i) {
333 if (boost::dynamic_pointer_cast<UserBundle> (*i) && (*i)->ports_are_inputs() == inputs && (*i)->type() == _type) {
334 system->add_bundle (*i, allow_dups);
338 for (BundleList::iterator i = b->begin(); i != b->end(); ++i) {
339 if (boost::dynamic_pointer_cast<UserBundle> (*i) == 0 && (*i)->ports_are_inputs() == inputs && (*i)->type() == _type) {
340 system->add_bundle (*i, allow_dups);
346 if (!inputs && _type == DataType::AUDIO) {
347 ardour->add_bundle (session->the_auditioner()->output()->bundle());
348 ardour->add_bundle (session->click_io()->bundle());
351 /* Now find all other ports that we haven't thought of yet */
353 std::vector<std::string> extra_system;
354 std::vector<std::string> extra_other;
356 const char **ports = session->engine().get_ports ("", _type.to_jack_type(), inputs ?
357 JackPortIsInput : JackPortIsOutput);
361 string client_matching_string;
363 client_matching_string = session->engine().client_name();
364 client_matching_string += ':';
368 std::string const p = ports[n];
370 if (!system->has_port(p) &&
372 !track->has_port(p) &&
373 !ardour->has_port(p) &&
374 !other->has_port(p)) {
376 if (port_has_prefix (p, "system:") ||
377 port_has_prefix (p, "alsa_pcm") ||
378 port_has_prefix (p, "ardour:")) {
379 extra_system.push_back (p);
381 extra_other.push_back (p);
391 if (!extra_system.empty()) {
392 boost::shared_ptr<Bundle> b = make_bundle_from_ports (extra_system, inputs);
393 system->add_bundle (b);
396 if (!extra_other.empty()) {
397 other->add_bundle (make_bundle_from_ports (extra_other, inputs));
400 add_group_if_not_empty (system);
401 add_group_if_not_empty (bus);
402 add_group_if_not_empty (track);
403 add_group_if_not_empty (ardour);
404 add_group_if_not_empty (other);
409 boost::shared_ptr<Bundle>
410 PortGroupList::make_bundle_from_ports (std::vector<std::string> const & p, bool inputs) const
412 boost::shared_ptr<Bundle> b (new Bundle ("", _type, inputs));
414 std::string const pre = common_prefix (p);
416 b->set_name (pre.substr (0, pre.length() - 1));
419 for (uint32_t j = 0; j < p.size(); ++j) {
420 b->add_channel (p[j].substr (pre.length()));
421 b->set_port (j, p[j]);
428 PortGroupList::port_has_prefix (const std::string& n, const std::string& p) const
430 return n.substr (0, p.length()) == p;
434 PortGroupList::common_prefix_before (std::vector<std::string> const & p, std::string const & s) const
436 /* we must have some strings and the first must contain the separator string */
437 if (p.empty() || p[0].find_first_of (s) == std::string::npos) {
441 /* prefix of the first string */
442 std::string const fp = p[0].substr (0, p[0].find_first_of (s) + 1);
444 /* see if the other strings also start with fp */
446 while (j < p.size()) {
447 if (p[j].substr (0, fp.length()) != fp) {
462 PortGroupList::common_prefix (std::vector<std::string> const & p) const
464 /* common prefix before '/' ? */
465 std::string cp = common_prefix_before (p, "/");
470 cp = common_prefix_before (p, ":");
479 PortGroupList::clear ()
482 _bundle_changed_connections.drop_connections ();
487 PortGroup::BundleList const &
488 PortGroupList::bundles () const
492 for (PortGroupList::List::const_iterator i = begin (); i != end (); ++i) {
493 std::copy ((*i)->bundles().begin(), (*i)->bundles().end(), std::back_inserter (_bundles));
500 PortGroupList::total_channels () const
504 for (PortGroupList::List::const_iterator i = begin(); i != end(); ++i) {
505 n += (*i)->total_channels ();
512 PortGroupList::add_group_if_not_empty (boost::shared_ptr<PortGroup> g)
514 if (!g->bundles().empty ()) {
520 PortGroupList::add_group (boost::shared_ptr<PortGroup> g)
522 _groups.push_back (g);
524 g->Changed.connect (_changed_connections, boost::bind (&PortGroupList::emit_changed, this));
525 g->BundleChanged.connect (_bundle_changed_connections, boost::bind (&PortGroupList::emit_bundle_changed, this, _1));
531 PortGroupList::remove_bundle (boost::shared_ptr<Bundle> b)
533 for (List::iterator i = _groups.begin(); i != _groups.end(); ++i) {
534 (*i)->remove_bundle (b);
541 PortGroupList::emit_changed ()
543 if (_signals_suspended) {
544 _pending_change = true;
551 PortGroupList::emit_bundle_changed (Bundle::Change c)
553 if (_signals_suspended) {
554 _pending_bundle_change = c;
560 PortGroupList::suspend_signals ()
562 _signals_suspended = true;
566 PortGroupList::resume_signals ()
568 if (_pending_change) {
570 _pending_change = false;
573 if (_pending_bundle_change != 0) {
574 BundleChanged (_pending_bundle_change);
575 _pending_bundle_change = (ARDOUR::Bundle::Change) 0;
578 _signals_suspended = false;
581 boost::shared_ptr<IO>
582 PortGroupList::io_from_bundle (boost::shared_ptr<ARDOUR::Bundle> b) const
584 List::const_iterator i = _groups.begin ();
585 while (i != _groups.end()) {
586 boost::shared_ptr<IO> io = (*i)->io_from_bundle (b);
593 return boost::shared_ptr<IO> ();
597 PortGroupList::empty () const
599 List::const_iterator i = _groups.begin ();
600 while (i != _groups.end() && (*i)->total_channels() == 0) {
604 return (i == _groups.end());