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)
48 : name (n), _visible (true)
54 PortGroup::add_bundle (boost::shared_ptr<Bundle> b)
56 add_bundle (b, boost::shared_ptr<IO> ());
59 /** Add a bundle to a group.
63 PortGroup::add_bundle (boost::shared_ptr<Bundle> b, boost::shared_ptr<IO> io)
71 r.changed_connection = b->Changed.connect (sigc::mem_fun (*this, &PortGroup::bundle_changed));
73 _bundles.push_back (r);
78 /** Add a bundle to a group.
80 * @param c Colour to represent the group with.
83 PortGroup::add_bundle (boost::shared_ptr<Bundle> b, boost::shared_ptr<IO> io, Gdk::Color c)
92 r.changed_connection = b->Changed.connect (sigc::mem_fun (*this, &PortGroup::bundle_changed));
94 _bundles.push_back (r);
100 PortGroup::remove_bundle (boost::shared_ptr<Bundle> b)
104 BundleList::iterator i = _bundles.begin ();
105 while (i != _bundles.end() && i->bundle != b) {
109 if (i == _bundles.end()) {
113 i->changed_connection.disconnect ();
120 PortGroup::bundle_changed (Bundle::Change c)
129 for (BundleList::iterator i = _bundles.begin(); i != _bundles.end(); ++i) {
130 i->changed_connection.disconnect ();
138 PortGroup::has_port (std::string const& p) const
140 for (BundleList::const_iterator i = _bundles.begin(); i != _bundles.end(); ++i) {
141 if (i->bundle->offers_port_alone (p)) {
149 boost::shared_ptr<Bundle>
150 PortGroup::only_bundle ()
152 assert (_bundles.size() == 1);
153 return _bundles.front().bundle;
158 PortGroup::total_channels () const
161 for (BundleList::const_iterator i = _bundles.begin(); i != _bundles.end(); ++i) {
162 n += i->bundle->nchannels ();
168 boost::shared_ptr<IO>
169 PortGroup::io_from_bundle (boost::shared_ptr<ARDOUR::Bundle> b) const
171 BundleList::const_iterator i = _bundles.begin ();
172 while (i != _bundles.end() && i->bundle != b) {
176 if (i == _bundles.end()) {
177 return boost::shared_ptr<IO> ();
184 /** PortGroupList constructor.
186 PortGroupList::PortGroupList ()
187 : _type (DataType::AUDIO), _signals_suspended (false), _pending_change (false)
193 PortGroupList::set_type (DataType t)
200 PortGroupList::maybe_add_processor_to_bundle (boost::weak_ptr<Processor> wp, boost::shared_ptr<RouteBundle> rb, bool inputs, set<boost::shared_ptr<IO> >& used_io)
202 boost::shared_ptr<Processor> p (wp.lock());
208 boost::shared_ptr<IOProcessor> iop = boost::dynamic_pointer_cast<IOProcessor> (p);
212 boost::shared_ptr<IO> io = inputs ? iop->input() : iop->output();
214 if (io && used_io.find (io) == used_io.end()) {
215 rb->add_processor_bundle (io->bundle ());
222 /** Gather bundles from around the system and put them in this PortGroupList */
224 PortGroupList::gather (ARDOUR::Session& session, bool inputs)
228 boost::shared_ptr<PortGroup> bus (new PortGroup (_("Bus")));
229 boost::shared_ptr<PortGroup> track (new PortGroup (_("Track")));
230 boost::shared_ptr<PortGroup> system (new PortGroup (_("System")));
231 boost::shared_ptr<PortGroup> ardour (new PortGroup (_("Ardour")));
232 boost::shared_ptr<PortGroup> other (new PortGroup (_("Other")));
234 /* Find the bundles for routes. We use the RouteBundle class to join
235 the route's input/output and processor bundles together so that they
236 are presented as one bundle in the matrix. */
238 boost::shared_ptr<RouteList> routes = session.get_routes ();
240 for (RouteList::const_iterator i = routes->begin(); i != routes->end(); ++i) {
242 /* keep track of IOs that we have taken bundles from, so that maybe_add_processor... below
243 can avoid taking the same IO from both Route::output() and the main_outs Delivery */
245 set<boost::shared_ptr<IO> > used_io;
246 boost::shared_ptr<IO> io = inputs ? (*i)->input() : (*i)->output();
249 boost::shared_ptr<RouteBundle> rb (new RouteBundle (io->bundle()));
251 (*i)->foreach_processor (bind (mem_fun (*this, &PortGroupList::maybe_add_processor_to_bundle), rb, inputs, used_io));
253 /* Work out which group to put this bundle in */
254 boost::shared_ptr<PortGroup> g;
255 if (_type == DataType::AUDIO) {
257 if (boost::dynamic_pointer_cast<AudioTrack> (*i)) {
259 } else if (!boost::dynamic_pointer_cast<MidiTrack>(*i)) {
264 } else if (_type == DataType::MIDI) {
266 if (boost::dynamic_pointer_cast<MidiTrack> (*i)) {
270 /* No MIDI busses yet */
275 TimeAxisView* tv = PublicEditor::instance().axis_view_from_route (i->get());
277 g->add_bundle (rb, io, tv->color ());
279 g->add_bundle (rb, io);
284 /* Bundles owned by the session. We only add the mono ones and the User ones
285 otherwise there is duplication of the same ports within the matrix */
287 boost::shared_ptr<BundleList> b = session.bundles ();
288 for (BundleList::iterator i = b->begin(); i != b->end(); ++i) {
289 if ((*i)->ports_are_inputs() == inputs && (*i)->type() == _type) {
291 if ((*i)->nchannels() == 1 || boost::dynamic_pointer_cast<UserBundle> (*i)) {
292 system->add_bundle (*i);
300 if (!inputs && _type == DataType::AUDIO) {
301 ardour->add_bundle (session.the_auditioner()->output()->bundle());
302 ardour->add_bundle (session.click_io()->bundle());
305 /* Now find all other ports that we haven't thought of yet */
307 std::vector<std::string> extra_system;
308 std::vector<std::string> extra_other;
310 const char **ports = session.engine().get_ports ("", _type.to_jack_type(), inputs ?
311 JackPortIsInput : JackPortIsOutput);
315 string client_matching_string;
317 client_matching_string = session.engine().client_name();
318 client_matching_string += ':';
322 std::string const p = ports[n];
324 if (!system->has_port(p) && !bus->has_port(p) && !track->has_port(p) && !ardour->has_port(p) && !other->has_port(p)) {
326 if (port_has_prefix (p, "system:") ||
327 port_has_prefix (p, "alsa_pcm") ||
328 port_has_prefix (p, "ardour:")) {
329 extra_system.push_back (p);
331 extra_other.push_back (p);
341 if (!extra_system.empty()) {
342 system->add_bundle (make_bundle_from_ports (extra_system, inputs));
345 if (!extra_other.empty()) {
346 other->add_bundle (make_bundle_from_ports (extra_other, inputs));
358 boost::shared_ptr<Bundle>
359 PortGroupList::make_bundle_from_ports (std::vector<std::string> const & p, bool inputs) const
361 boost::shared_ptr<Bundle> b (new Bundle ("", _type, inputs));
363 std::string const pre = common_prefix (p);
365 b->set_name (pre.substr (0, pre.length() - 1));
368 for (uint32_t j = 0; j < p.size(); ++j) {
369 b->add_channel (p[j].substr (pre.length()));
370 b->set_port (j, p[j]);
377 PortGroupList::port_has_prefix (const std::string& n, const std::string& p) const
379 return n.substr (0, p.length()) == p;
383 PortGroupList::common_prefix_before (std::vector<std::string> const & p, std::string const & s) const
385 /* we must have some strings and the first must contain the separator string */
386 if (p.empty() || p[0].find_first_of (s) == std::string::npos) {
390 /* prefix of the first string */
391 std::string const fp = p[0].substr (0, p[0].find_first_of (s) + 1);
393 /* see if the other strings also start with fp */
395 while (j < p.size()) {
396 if (p[j].substr (0, fp.length()) != fp) {
411 PortGroupList::common_prefix (std::vector<std::string> const & p) const
413 /* common prefix before '/' ? */
414 std::string cp = common_prefix_before (p, "/");
419 cp = common_prefix_before (p, ":");
428 PortGroupList::clear ()
432 for (std::vector<sigc::connection>::iterator i = _bundle_changed_connections.begin(); i != _bundle_changed_connections.end(); ++i) {
436 _bundle_changed_connections.clear ();
442 PortGroup::BundleList const &
443 PortGroupList::bundles () const
447 for (PortGroupList::List::const_iterator i = begin (); i != end (); ++i) {
448 std::copy ((*i)->bundles().begin(), (*i)->bundles().end(), std::back_inserter (_bundles));
455 PortGroupList::total_visible_channels () const
459 for (PortGroupList::List::const_iterator i = begin(); i != end(); ++i) {
460 if ((*i)->visible()) {
461 n += (*i)->total_channels ();
470 PortGroupList::add_group (boost::shared_ptr<PortGroup> g)
472 _groups.push_back (g);
474 g->Changed.connect (sigc::mem_fun (*this, &PortGroupList::emit_changed));
476 _bundle_changed_connections.push_back (
477 g->BundleChanged.connect (sigc::hide (sigc::mem_fun (*this, &PortGroupList::emit_changed)))
484 PortGroupList::remove_bundle (boost::shared_ptr<Bundle> b)
486 for (List::iterator i = _groups.begin(); i != _groups.end(); ++i) {
487 (*i)->remove_bundle (b);
494 PortGroupList::emit_changed ()
496 if (_signals_suspended) {
497 _pending_change = true;
504 PortGroupList::suspend_signals ()
506 _signals_suspended = true;
510 PortGroupList::resume_signals ()
512 if (_pending_change) {
514 _pending_change = false;
517 _signals_suspended = false;
520 boost::shared_ptr<IO>
521 PortGroupList::io_from_bundle (boost::shared_ptr<ARDOUR::Bundle> b) const
523 List::const_iterator i = _groups.begin ();
524 while (i != _groups.end()) {
525 boost::shared_ptr<IO> io = (*i)->io_from_bundle (b);
532 return boost::shared_ptr<IO> ();
536 RouteBundle::RouteBundle (boost::shared_ptr<Bundle> r)
539 _route->Changed.connect (sigc::hide (sigc::mem_fun (*this, &RouteBundle::reread_component_bundles)));
540 reread_component_bundles ();
544 RouteBundle::reread_component_bundles ()
550 set_name (_route->name());
552 for (uint32_t i = 0; i < _route->nchannels(); ++i) {
553 add_channel (_route->channel_name (i));
554 PortList const & pl = _route->channel_ports (i);
555 for (uint32_t j = 0; j < pl.size(); ++j) {
556 add_port_to_channel (i, pl[j]);
560 for (std::vector<boost::shared_ptr<Bundle> >::iterator i = _processor.begin(); i != _processor.end(); ++i) {
561 add_channels_from_bundle (*i);
568 RouteBundle::add_processor_bundle (boost::shared_ptr<Bundle> p)
570 p->Changed.connect (sigc::hide (sigc::mem_fun (*this, &RouteBundle::reread_component_bundles)));
571 _processor.push_back (p);
573 reread_component_bundles ();