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>
22 #include <boost/algorithm/string.hpp>
24 #include "midi++/mmc.h"
26 #include "ardour/audioengine.h"
27 #include "ardour/auditioner.h"
28 #include "ardour/bundle.h"
29 #include "ardour/control_protocol_manager.h"
30 #include "ardour/io_processor.h"
31 #include "ardour/midi_port.h"
32 #include "ardour/midiport_manager.h"
33 #include "ardour/port.h"
34 #include "ardour/profile.h"
35 #include "ardour/session.h"
36 #include "ardour/user_bundle.h"
38 #include "control_protocol/control_protocol.h"
40 #include "gui_thread.h"
41 #include "port_group.h"
42 #include "port_matrix.h"
43 #include "time_axis_view.h"
44 #include "public_editor.h"
50 using namespace ARDOUR;
52 /** PortGroup constructor.
55 PortGroup::PortGroup (std::string const & n)
61 PortGroup::~PortGroup()
63 for (BundleList::iterator i = _bundles.begin(); i != _bundles.end(); ++i) {
69 /** Add a bundle to a group.
71 * @param allow_dups true to allow the group to contain more than one bundle with the same port, otherwise false.
74 PortGroup::add_bundle (boost::shared_ptr<Bundle> b, bool allow_dups)
76 add_bundle_internal (b, boost::shared_ptr<IO> (), false, Gdk::Color (), allow_dups);
79 /** Add a bundle to a group.
81 * @param io IO whose ports are in the bundle.
84 PortGroup::add_bundle (boost::shared_ptr<Bundle> b, boost::shared_ptr<IO> io)
86 add_bundle_internal (b, io, false, Gdk::Color (), false);
89 /** Add a bundle to a group.
91 * @param c Colour to represent the bundle with.
94 PortGroup::add_bundle (boost::shared_ptr<Bundle> b, boost::shared_ptr<IO> io, Gdk::Color c)
96 add_bundle_internal (b, io, true, c, false);
99 PortGroup::BundleRecord::BundleRecord (boost::shared_ptr<ARDOUR::Bundle> b, boost::shared_ptr<ARDOUR::IO> iop, Gdk::Color c, bool has_c)
108 PortGroup::add_bundle_internal (boost::shared_ptr<Bundle> b, boost::shared_ptr<IO> io, bool has_colour, Gdk::Color colour, bool allow_dups)
114 /* don't add this bundle if we already have one with the same ports */
116 BundleList::iterator i = _bundles.begin ();
117 while (i != _bundles.end() && b->has_same_ports ((*i)->bundle) == false) {
121 if (i != _bundles.end ()) {
126 BundleRecord* br = new BundleRecord (b, io, colour, has_colour);
127 b->Changed.connect (br->changed_connection, invalidator (*this), boost::bind (&PortGroup::bundle_changed, this, _1), gui_context());
128 _bundles.push_back (br);
134 PortGroup::remove_bundle (boost::shared_ptr<Bundle> b)
138 BundleList::iterator i = _bundles.begin ();
139 while (i != _bundles.end() && (*i)->bundle != b) {
143 if (i == _bundles.end()) {
154 PortGroup::bundle_changed (Bundle::Change c)
163 for (BundleList::iterator i = _bundles.begin(); i != _bundles.end(); ++i) {
172 PortGroup::has_port (std::string const& p) const
174 for (BundleList::const_iterator i = _bundles.begin(); i != _bundles.end(); ++i) {
175 if ((*i)->bundle->offers_port_alone (p)) {
183 boost::shared_ptr<Bundle>
184 PortGroup::only_bundle ()
186 assert (_bundles.size() == 1);
187 return _bundles.front()->bundle;
192 PortGroup::total_channels () const
195 for (BundleList::const_iterator i = _bundles.begin(); i != _bundles.end(); ++i) {
196 n += (*i)->bundle->nchannels ();
202 boost::shared_ptr<IO>
203 PortGroup::io_from_bundle (boost::shared_ptr<ARDOUR::Bundle> b) const
205 BundleList::const_iterator i = _bundles.begin ();
206 while (i != _bundles.end() && (*i)->bundle != b) {
210 if (i == _bundles.end()) {
211 return boost::shared_ptr<IO> ();
214 boost::shared_ptr<IO> io ((*i)->io.lock ());
218 /** Remove bundles whose channels are already represented by other, larger bundles */
220 PortGroup::remove_duplicates ()
222 BundleList::iterator i = _bundles.begin();
223 while (i != _bundles.end()) {
225 BundleList::iterator tmp = i;
230 for (BundleList::iterator j = _bundles.begin(); j != _bundles.end(); ++j) {
232 if ((*j)->bundle->nchannels() > (*i)->bundle->nchannels()) {
233 /* this bundle is larger */
236 while (k < (*i)->bundle->nchannels().n_total()) {
237 /* see if this channel on *i has an equivalent on *j */
239 while (l < (*j)->bundle->nchannels().n_total() && (*i)->bundle->channel_ports (k) != (*j)->bundle->channel_ports (l)) {
243 if (l == (*j)->bundle->nchannels().n_total()) {
251 if (k == (*i)->bundle->nchannels().n_total()) {
252 /* all channels on *i are represented by the larger bundle *j, so remove *i */
268 /** PortGroupList constructor.
270 PortGroupList::PortGroupList ()
271 : _signals_suspended (false), _pending_change (false), _pending_bundle_change ((Bundle::Change) 0)
276 PortGroupList::~PortGroupList()
278 /* XXX need to clean up bundles, but ownership shared with PortGroups */
282 PortGroupList::maybe_add_processor_to_list (
283 boost::weak_ptr<Processor> wp, list<boost::shared_ptr<IO> >* route_ios, bool inputs, set<boost::shared_ptr<IO> >& used_io
286 boost::shared_ptr<Processor> p (wp.lock());
292 boost::shared_ptr<IOProcessor> iop = boost::dynamic_pointer_cast<IOProcessor> (p);
296 boost::shared_ptr<IO> io = inputs ? iop->input() : iop->output();
298 if (io && used_io.find (io) == used_io.end()) {
299 route_ios->push_back (io);
306 RouteIOs (boost::shared_ptr<Route> r, boost::shared_ptr<IO> i) {
311 boost::shared_ptr<Route> route;
312 /* it's ok to use a shared_ptr here as RouteIOs structs are only used during ::gather () */
313 std::list<boost::shared_ptr<IO> > ios;
316 class RouteIOsComparator {
318 bool operator() (RouteIOs const & a, RouteIOs const & b) {
319 return a.route->order_key () < b.route->order_key ();
323 /** Gather ports from around the system and put them in this PortGroupList.
324 * @param type Type of ports to collect, or NIL for all types.
325 * @param use_session_bundles true to use the session's non-user bundles. Doing this will mean that
326 * hardware ports will be gathered into stereo pairs, as the session sets up bundles for these pairs.
327 * Not using the session bundles will mean that all hardware IO will be presented separately.
330 PortGroupList::gather (ARDOUR::Session* session, ARDOUR::DataType type, bool inputs, bool allow_dups, bool use_session_bundles)
338 boost::shared_ptr<PortGroup> bus (new PortGroup (string_compose (_("%1 Busses"), PROGRAM_NAME)));
339 boost::shared_ptr<PortGroup> track (new PortGroup (string_compose (_("%1 Tracks"), PROGRAM_NAME)));
340 boost::shared_ptr<PortGroup> system (new PortGroup (_("Hardware")));
341 boost::shared_ptr<PortGroup> program (new PortGroup (string_compose (_("%1 Misc"), PROGRAM_NAME)));
342 boost::shared_ptr<PortGroup> other (new PortGroup (_("Other")));
344 /* Find the IOs which have bundles for routes and their processors. We store
345 these IOs in a RouteIOs class so that we can then sort the results by route
349 boost::shared_ptr<RouteList> routes = session->get_routes ();
350 list<RouteIOs> route_ios;
352 for (RouteList::const_iterator i = routes->begin(); i != routes->end(); ++i) {
354 /* we never show the monitor bus inputs */
356 if (inputs && (*i)->is_monitor()) {
360 /* keep track of IOs that we have taken bundles from,
361 so that we can avoid taking the same IO from both
362 Route::output() and the main_outs Delivery
365 set<boost::shared_ptr<IO> > used_io;
366 boost::shared_ptr<IO> io = inputs ? (*i)->input() : (*i)->output();
369 RouteIOs rb (*i, io);
370 (*i)->foreach_processor (boost::bind (&PortGroupList::maybe_add_processor_to_list, this, _1, &rb.ios, inputs, used_io));
372 route_ios.push_back (rb);
375 /* Sort RouteIOs by the routes' editor order keys */
376 route_ios.sort (RouteIOsComparator ());
378 /* Now put the bundles that belong to these sorted RouteIOs into the PortGroup.
379 Note that if the RouteIO's bundles are multi-type, we may make new Bundles
380 with only the ports of one type.
383 for (list<RouteIOs>::iterator i = route_ios.begin(); i != route_ios.end(); ++i) {
384 TimeAxisView* tv = PublicEditor::instance().axis_view_from_route (i->route);
386 /* Work out which group to put these IOs' bundles in */
387 boost::shared_ptr<PortGroup> g;
388 if (boost::dynamic_pointer_cast<Track> (i->route)) {
394 for (list<boost::shared_ptr<IO> >::iterator j = i->ios.begin(); j != i->ios.end(); ++j) {
396 g->add_bundle ((*j)->bundle(), *j, tv->color ());
398 g->add_bundle ((*j)->bundle(), *j);
403 /* Bundles owned by the session; add user bundles first, then normal ones, so
404 that UserBundles that offer the same ports as a normal bundle get priority
407 boost::shared_ptr<BundleList> b = session->bundles ();
409 for (BundleList::iterator i = b->begin(); i != b->end(); ++i) {
410 if (boost::dynamic_pointer_cast<UserBundle> (*i) && (*i)->ports_are_inputs() == inputs) {
411 system->add_bundle (*i, allow_dups);
415 /* Only look for non-user bundles if instructed to do so */
416 if (use_session_bundles) {
417 for (BundleList::iterator i = b->begin(); i != b->end(); ++i) {
418 if (boost::dynamic_pointer_cast<UserBundle> (*i) == 0 && (*i)->ports_are_inputs() == inputs) {
419 system->add_bundle (*i, allow_dups);
426 if (type == DataType::AUDIO || type == DataType::NIL) {
428 program->add_bundle (session->the_auditioner()->output()->bundle());
429 program->add_bundle (session->click_io()->bundle());
430 /* Note: the LTC ports do not have the usual ":audio_out 1" postfix, so
431 * program->add_bundle (session->ltc_output_io()->bundle());
434 boost::shared_ptr<Bundle> ltc (new Bundle (_("LTC Out"), inputs));
435 ltc->add_channel (_("LTC Out"), DataType::AUDIO, session->engine().make_port_name_non_relative (session->ltc_output_port()->name()));
436 program->add_bundle (ltc);
438 boost::shared_ptr<Bundle> ltc (new Bundle (_("LTC In"), inputs));
439 ltc->add_channel (_("LTC In"), DataType::AUDIO, session->engine().make_port_name_non_relative (session->ltc_input_port()->name()));
440 program->add_bundle (ltc);
444 /* our control surfaces */
446 /* XXX assume for now that all control protocols with ports use
447 * MIDI. If anyone created a control protocol that used audio ports,
451 if ((type == DataType::MIDI || type == DataType::NIL)) {
452 ControlProtocolManager& m = ControlProtocolManager::instance ();
453 for (list<ControlProtocolInfo*>::iterator i = m.control_protocol_info.begin(); i != m.control_protocol_info.end(); ++i) {
454 if ((*i)->protocol) {
455 list<boost::shared_ptr<Bundle> > b = (*i)->protocol->bundles ();
456 for (list<boost::shared_ptr<Bundle> >::iterator j = b.begin(); j != b.end(); ++j) {
457 if ((*j)->ports_are_inputs() == inputs) {
458 program->add_bundle (*j);
467 if ((type == DataType::MIDI || type == DataType::NIL)) {
468 boost::shared_ptr<Bundle> sync (new Bundle (_("Sync"), inputs));
469 AudioEngine* ae = AudioEngine::instance();
473 _("MTC in"), DataType::MIDI, ae->make_port_name_non_relative (session->mtc_input_port()->name())
476 _("MIDI control in"), DataType::MIDI, ae->make_port_name_non_relative (session->midi_input_port()->name())
479 _("MIDI clock in"), DataType::MIDI, ae->make_port_name_non_relative (session->midi_clock_input_port()->name())
482 _("MMC in"), DataType::MIDI, ae->make_port_name_non_relative (session->mmc_input_port()->name())
486 _("MTC out"), DataType::MIDI, ae->make_port_name_non_relative (session->mtc_output_port()->name())
489 _("MIDI control out"), DataType::MIDI, ae->make_port_name_non_relative (session->midi_output_port()->name())
492 _("MIDI clock out"), DataType::MIDI, ae->make_port_name_non_relative (session->midi_clock_output_port()->name())
495 _("MMC out"), DataType::MIDI, ae->make_port_name_non_relative (session->mmc_output_port()->name())
499 program->add_bundle (sync);
502 /* Now find all other ports that we haven't thought of yet */
504 std::vector<std::string> extra_system[DataType::num_types];
505 std::vector<std::string> extra_program[DataType::num_types];
506 std::vector<std::string> extra_other[DataType::num_types];
508 string lpn (PROGRAM_NAME);
509 boost::to_lower (lpn);
513 vector<string> ports;
514 if (AudioEngine::instance()->get_ports ("", type, inputs ? IsInput : IsOutput, ports) > 0) {
516 for (vector<string>::const_iterator s = ports.begin(); s != ports.end(); ) {
518 std::string const p = *s;
520 if (!system->has_port(p) &&
522 !track->has_port(p) &&
523 !program->has_port(p) &&
524 !other->has_port(p)) {
526 /* special hack: ignore MIDI ports labelled Midi-Through. these
527 are basically useless and mess things up for default
531 if (p.find ("Midi-Through") != string::npos) {
536 /* special hack: ignore our monitor inputs (which show up here because
537 we excluded them earlier.
541 boost::to_lower (lp);
543 if ((lp.find (N_(":monitor")) != string::npos) &&
544 (lp.find (lpn) != string::npos)) {
549 /* can't use the audio engine for this as we
550 * are looking at ports not owned by the
551 * application, and the audio engine/port
552 * manager doesn't seem them.
555 PortEngine::PortHandle ph = AudioEngine::instance()->port_engine().get_port_by_name (p);
557 DataType t (AudioEngine::instance()->port_engine().port_data_type (ph));
558 if (t != DataType::NIL) {
559 if (port_has_prefix (p, N_("system:")) ||
560 port_has_prefix (p, N_("alsa_pcm:")) ||
561 port_has_prefix (p, N_("alsa_midi:"))) {
562 extra_system[t].push_back (p);
563 } else if (port_has_prefix (p, lpnc)) {
564 /* Hide scene ports from non-Tracks Live builds */
565 if (!ARDOUR::Profile->get_trx()) {
566 if (p.find (_("Scene ")) != string::npos) {
571 extra_program[t].push_back (p);
573 extra_other[t].push_back (p);
583 for (DataType::iterator i = DataType::begin(); i != DataType::end(); ++i) {
584 if (!extra_system[*i].empty()) {
585 boost::shared_ptr<Bundle> b = make_bundle_from_ports (extra_system[*i], *i, inputs);
586 system->add_bundle (b);
590 for (DataType::iterator i = DataType::begin(); i != DataType::end(); ++i) {
591 if (!extra_program[*i].empty()) {
592 /* remove program name prefix from port name and use rest as bundle name */
593 std::string bundle_name = extra_program[*i].front().substr (lpnc.length());
594 boost::shared_ptr<Bundle> b = make_bundle_from_ports (extra_program[*i], *i, inputs, bundle_name);
595 program->add_bundle (b);
599 for (DataType::iterator i = DataType::begin(); i != DataType::end(); ++i) {
600 if (extra_other[*i].empty()) continue;
602 std::vector<std::string> nb;
603 for (uint32_t j = 0; j < extra_other[*i].size(); ++j) {
604 std::string nn = extra_other[*i][j];
605 std::string pf = nn.substr (0, nn.find_first_of (":") + 1);
606 if (pf != cp && !nb.empty()) {
607 boost::shared_ptr<Bundle> b = make_bundle_from_ports (nb, *i, inputs);
608 other->add_bundle (b);
612 nb.push_back(extra_other[*i][j]);
615 boost::shared_ptr<Bundle> b = make_bundle_from_ports (nb, *i, inputs);
616 other->add_bundle (b);
621 system->remove_duplicates ();
624 add_group_if_not_empty (other);
625 if (type != DataType::MIDI) {
626 add_group_if_not_empty (bus);
628 add_group_if_not_empty (track);
629 add_group_if_not_empty (program);
630 add_group_if_not_empty (system);
635 boost::shared_ptr<Bundle>
636 PortGroupList::make_bundle_from_ports (std::vector<std::string> const & p, ARDOUR::DataType type, bool inputs, std::string const& bundle_name) const
638 boost::shared_ptr<Bundle> b (new Bundle ("", inputs));
639 std::string const pre = common_prefix (p);
641 if (!bundle_name.empty()) {
642 b->set_name (bundle_name);
645 b->set_name (pre.substr (0, pre.length() - 1));
649 for (uint32_t j = 0; j < p.size(); ++j) {
650 std::string n = p[j].substr (pre.length());
651 std::string pn = AudioEngine::instance()->get_pretty_name_by_name (p[j]);
655 b->add_channel (n, type);
656 b->set_port (j, p[j]);
663 PortGroupList::port_has_prefix (const std::string& n, const std::string& p) const
665 return n.substr (0, p.length()) == p;
669 PortGroupList::common_prefix_before (std::vector<std::string> const & p, std::string const & s) const
671 /* we must have some strings and the first must contain the separator string */
672 if (p.empty() || p[0].find_first_of (s) == std::string::npos) {
676 /* prefix of the first string */
677 std::string const fp = p[0].substr (0, p[0].find_first_of (s) + 1);
679 /* see if the other strings also start with fp */
681 while (j < p.size()) {
682 if (p[j].substr (0, fp.length()) != fp) {
697 PortGroupList::common_prefix (std::vector<std::string> const & p) const
699 /* common prefix before '/' ? */
700 std::string cp = common_prefix_before (p, "/");
705 cp = common_prefix_before (p, ":");
714 PortGroupList::clear ()
717 _bundle_changed_connections.drop_connections ();
722 PortGroup::BundleList const &
723 PortGroupList::bundles () const
727 for (PortGroupList::List::const_iterator i = begin (); i != end (); ++i) {
728 std::copy ((*i)->bundles().begin(), (*i)->bundles().end(), std::back_inserter (_bundles));
735 PortGroupList::total_channels () const
739 for (PortGroupList::List::const_iterator i = begin(); i != end(); ++i) {
740 n += (*i)->total_channels ();
747 PortGroupList::add_group_if_not_empty (boost::shared_ptr<PortGroup> g)
749 if (!g->bundles().empty ()) {
755 PortGroupList::add_group (boost::shared_ptr<PortGroup> g)
757 _groups.push_back (g);
759 g->Changed.connect (_changed_connections, invalidator (*this), boost::bind (&PortGroupList::emit_changed, this), gui_context());
760 g->BundleChanged.connect (_bundle_changed_connections, invalidator (*this), boost::bind (&PortGroupList::emit_bundle_changed, this, _1), gui_context());
766 PortGroupList::remove_bundle (boost::shared_ptr<Bundle> b)
768 for (List::iterator i = _groups.begin(); i != _groups.end(); ++i) {
769 (*i)->remove_bundle (b);
776 PortGroupList::emit_changed ()
778 if (_signals_suspended) {
779 _pending_change = true;
786 PortGroupList::emit_bundle_changed (Bundle::Change c)
788 if (_signals_suspended) {
789 _pending_bundle_change = c;
795 PortGroupList::suspend_signals ()
797 _signals_suspended = true;
801 PortGroupList::resume_signals ()
803 if (_pending_change) {
805 _pending_change = false;
808 if (_pending_bundle_change != 0) {
809 BundleChanged (_pending_bundle_change);
810 _pending_bundle_change = (ARDOUR::Bundle::Change) 0;
813 _signals_suspended = false;
816 boost::shared_ptr<IO>
817 PortGroupList::io_from_bundle (boost::shared_ptr<ARDOUR::Bundle> b) const
819 List::const_iterator i = _groups.begin ();
820 while (i != _groups.end()) {
821 boost::shared_ptr<IO> io = (*i)->io_from_bundle (b);
828 return boost::shared_ptr<IO> ();
832 PortGroupList::empty () const
834 return _groups.empty ();