first vaguely working version using PresentationInfo
[ardour.git] / gtk2_ardour / port_group.cc
1 /*
2     Copyright (C) 2002-2009 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 <cstring>
21 #include <boost/shared_ptr.hpp>
22 #include <boost/algorithm/string.hpp>
23
24 #include "midi++/mmc.h"
25
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"
37
38 #include "control_protocol/control_protocol.h"
39
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"
45
46 #include "i18n.h"
47
48 using namespace std;
49 using namespace Gtk;
50 using namespace ARDOUR;
51
52 /** PortGroup constructor.
53  * @param n Name.
54  */
55 PortGroup::PortGroup (std::string const & n)
56         : name (n)
57 {
58
59 }
60
61 PortGroup::~PortGroup()
62 {
63         for (BundleList::iterator i = _bundles.begin(); i != _bundles.end(); ++i) {
64                 delete *i;
65         }
66         _bundles.clear ();
67 }
68
69 /** Add a bundle to a group.
70  *  @param b Bundle.
71  *  @param allow_dups true to allow the group to contain more than one bundle with the same port, otherwise false.
72  */
73 void
74 PortGroup::add_bundle (boost::shared_ptr<Bundle> b, bool allow_dups)
75 {
76         add_bundle_internal (b, boost::shared_ptr<IO> (), false, Gdk::Color (), allow_dups);
77 }
78
79 /** Add a bundle to a group.
80  *  @param b Bundle.
81  *  @param io IO whose ports are in the bundle.
82  */
83 void
84 PortGroup::add_bundle (boost::shared_ptr<Bundle> b, boost::shared_ptr<IO> io)
85 {
86         add_bundle_internal (b, io, false, Gdk::Color (), false);
87 }
88
89 /** Add a bundle to a group.
90  *  @param b Bundle.
91  *  @param c Colour to represent the bundle with.
92  */
93 void
94 PortGroup::add_bundle (boost::shared_ptr<Bundle> b, boost::shared_ptr<IO> io, Gdk::Color c)
95 {
96         add_bundle_internal (b, io, true, c, false);
97 }
98
99 PortGroup::BundleRecord::BundleRecord (boost::shared_ptr<ARDOUR::Bundle> b, boost::shared_ptr<ARDOUR::IO> iop, Gdk::Color c, bool has_c)
100         : bundle (b)
101         , io (iop)
102         , colour (c)
103         , has_colour (has_c)
104 {
105 }
106
107 void
108 PortGroup::add_bundle_internal (boost::shared_ptr<Bundle> b, boost::shared_ptr<IO> io, bool has_colour, Gdk::Color colour, bool allow_dups)
109 {
110         assert (b.get());
111
112         if (!allow_dups) {
113
114                 /* don't add this bundle if we already have one with the same ports */
115
116                 BundleList::iterator i = _bundles.begin ();
117                 while (i != _bundles.end() && b->has_same_ports ((*i)->bundle) == false) {
118                         ++i;
119                 }
120
121                 if (i != _bundles.end ()) {
122                         return;
123                 }
124         }
125
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);
129
130         Changed ();
131 }
132
133 void
134 PortGroup::remove_bundle (boost::shared_ptr<Bundle> b)
135 {
136         assert (b.get());
137
138         BundleList::iterator i = _bundles.begin ();
139         while (i != _bundles.end() && (*i)->bundle != b) {
140                 ++i;
141         }
142
143         if (i == _bundles.end()) {
144                 return;
145         }
146
147         delete *i;
148         _bundles.erase (i);
149
150         Changed ();
151 }
152
153 void
154 PortGroup::bundle_changed (Bundle::Change c)
155 {
156         BundleChanged (c);
157 }
158
159
160 void
161 PortGroup::clear ()
162 {
163         for (BundleList::iterator i = _bundles.begin(); i != _bundles.end(); ++i) {
164                 delete *i;
165         }
166
167         _bundles.clear ();
168         Changed ();
169 }
170
171 bool
172 PortGroup::has_port (std::string const& p) const
173 {
174         for (BundleList::const_iterator i = _bundles.begin(); i != _bundles.end(); ++i) {
175                 if ((*i)->bundle->offers_port_alone (p)) {
176                         return true;
177                 }
178         }
179
180         return false;
181 }
182
183 boost::shared_ptr<Bundle>
184 PortGroup::only_bundle ()
185 {
186         assert (_bundles.size() == 1);
187         return _bundles.front()->bundle;
188 }
189
190
191 ChanCount
192 PortGroup::total_channels () const
193 {
194         ChanCount n;
195         for (BundleList::const_iterator i = _bundles.begin(); i != _bundles.end(); ++i) {
196                 n += (*i)->bundle->nchannels ();
197         }
198
199         return n;
200 }
201
202 boost::shared_ptr<IO>
203 PortGroup::io_from_bundle (boost::shared_ptr<ARDOUR::Bundle> b) const
204 {
205         BundleList::const_iterator i = _bundles.begin ();
206         while (i != _bundles.end() && (*i)->bundle != b) {
207                 ++i;
208         }
209
210         if (i == _bundles.end()) {
211                 return boost::shared_ptr<IO> ();
212         }
213
214         boost::shared_ptr<IO> io ((*i)->io.lock ());
215         return io;
216 }
217
218 /** Remove bundles whose channels are already represented by other, larger bundles */
219 void
220 PortGroup::remove_duplicates ()
221 {
222         BundleList::iterator i = _bundles.begin();
223         while (i != _bundles.end()) {
224
225                 BundleList::iterator tmp = i;
226                 ++tmp;
227
228                 bool remove = false;
229
230                 for (BundleList::iterator j = _bundles.begin(); j != _bundles.end(); ++j) {
231
232                         if ((*j)->bundle->nchannels() > (*i)->bundle->nchannels()) {
233                                 /* this bundle is larger */
234
235                                 uint32_t k = 0;
236                                 while (k < (*i)->bundle->nchannels().n_total()) {
237                                         /* see if this channel on *i has an equivalent on *j */
238                                         uint32_t l = 0;
239                                         while (l < (*j)->bundle->nchannels().n_total() && (*i)->bundle->channel_ports (k) != (*j)->bundle->channel_ports (l)) {
240                                                 ++l;
241                                         }
242
243                                         if (l == (*j)->bundle->nchannels().n_total()) {
244                                                 /* it does not */
245                                                 break;
246                                         }
247
248                                         ++k;
249                                 }
250
251                                 if (k == (*i)->bundle->nchannels().n_total()) {
252                                         /* all channels on *i are represented by the larger bundle *j, so remove *i */
253                                         remove = true;
254                                         break;
255                                 }
256                         }
257                 }
258
259                 if (remove) {
260                         _bundles.erase (i);
261                 }
262
263                 i = tmp;
264         }
265 }
266
267
268 /** PortGroupList constructor.
269  */
270 PortGroupList::PortGroupList ()
271         : _signals_suspended (false), _pending_change (false), _pending_bundle_change ((Bundle::Change) 0)
272 {
273
274 }
275
276 PortGroupList::~PortGroupList()
277 {
278         /* XXX need to clean up bundles, but ownership shared with PortGroups */
279 }
280
281 void
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
284         )
285 {
286         boost::shared_ptr<Processor> p (wp.lock());
287
288         if (!p) {
289                 return;
290         }
291
292         boost::shared_ptr<IOProcessor> iop = boost::dynamic_pointer_cast<IOProcessor> (p);
293
294         if (iop) {
295
296                 boost::shared_ptr<IO> io = inputs ? iop->input() : iop->output();
297
298                 if (io && used_io.find (io) == used_io.end()) {
299                         route_ios->push_back (io);
300                         used_io.insert (io);
301                 }
302         }
303 }
304
305 struct RouteIOs {
306         RouteIOs (boost::shared_ptr<Route> r, boost::shared_ptr<IO> i) {
307                 route = r;
308                 ios.push_back (i);
309         }
310
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;
314 };
315
316 class RouteIOsComparator {
317 public:
318         bool operator() (RouteIOs const & a, RouteIOs const & b) {
319                 return a.route->presentation_info ().group_order() < b.route->presentation_info().group_order();
320         }
321 };
322
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.
328  */
329 void
330 PortGroupList::gather (ARDOUR::Session* session, ARDOUR::DataType type, bool inputs, bool allow_dups, bool use_session_bundles)
331 {
332         clear ();
333
334         if (session == 0) {
335                 return;
336         }
337
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")));
343
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
346            order key.
347         */
348
349         boost::shared_ptr<RouteList> routes = session->get_routes ();
350         list<RouteIOs> route_ios;
351
352         for (RouteList::const_iterator i = routes->begin(); i != routes->end(); ++i) {
353
354                 /* we never show the monitor bus inputs */
355
356                 if (inputs && (*i)->is_monitor()) {
357                         continue;
358                 }
359
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
363                 */
364
365                 set<boost::shared_ptr<IO> > used_io;
366                 boost::shared_ptr<IO> io = inputs ? (*i)->input() : (*i)->output();
367                 used_io.insert (io);
368
369                 RouteIOs rb (*i, io);
370                 (*i)->foreach_processor (boost::bind (&PortGroupList::maybe_add_processor_to_list, this, _1, &rb.ios, inputs, used_io));
371
372                 route_ios.push_back (rb);
373         }
374
375         /* Sort RouteIOs by the routes' editor order keys */
376         route_ios.sort (RouteIOsComparator ());
377
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.
381         */
382
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);
385
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)) {
389                         g = track;
390                 } else {
391                         g = bus;
392                 }
393
394                 for (list<boost::shared_ptr<IO> >::iterator j = i->ios.begin(); j != i->ios.end(); ++j) {
395                         if (tv) {
396                                 g->add_bundle ((*j)->bundle(), *j, tv->color ());
397                         } else {
398                                 g->add_bundle ((*j)->bundle(), *j);
399                         }
400                 }
401         }
402
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
405         */
406
407         boost::shared_ptr<BundleList> b = session->bundles ();
408
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);
412                 }
413         }
414
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);
420                         }
421                 }
422         }
423
424         /* miscellany */
425
426         if (type == DataType::AUDIO || type == DataType::NIL) {
427                 if (!inputs) {
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());
432                          *  won't work
433                          */
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);
437                 } else {
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);
441                 }
442         }
443
444         /* our control surfaces */
445
446         /* XXX assume for now that all control protocols with ports use
447          * MIDI. If anyone created a control protocol that used audio ports,
448          * this will break.
449          */
450
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);
459                                         }
460                                 }
461                         }
462                 }
463         }
464
465         /* our sync ports */
466
467         if ((type == DataType::MIDI || type == DataType::NIL)) {
468                 boost::shared_ptr<Bundle> sync (new Bundle (_("Sync"), inputs));
469                 AudioEngine* ae = AudioEngine::instance();
470
471                 if (inputs) {
472                         sync->add_channel (
473                                 _("MTC in"), DataType::MIDI, ae->make_port_name_non_relative (session->mtc_input_port()->name())
474                                 );
475                         sync->add_channel (
476                                 _("MIDI control in"), DataType::MIDI, ae->make_port_name_non_relative (session->midi_input_port()->name())
477                                 );
478                         sync->add_channel (
479                                 _("MIDI clock in"), DataType::MIDI, ae->make_port_name_non_relative (session->midi_clock_input_port()->name())
480                                 );
481                         sync->add_channel (
482                                 _("MMC in"), DataType::MIDI, ae->make_port_name_non_relative (session->mmc_input_port()->name())
483                                 );
484                 } else {
485                         sync->add_channel (
486                                 _("MTC out"), DataType::MIDI, ae->make_port_name_non_relative (session->mtc_output_port()->name())
487                                 );
488                         sync->add_channel (
489                                 _("MIDI control out"), DataType::MIDI, ae->make_port_name_non_relative (session->midi_output_port()->name())
490                                 );
491                         sync->add_channel (
492                                 _("MIDI clock out"), DataType::MIDI, ae->make_port_name_non_relative (session->midi_clock_output_port()->name())
493                                 );
494                         sync->add_channel (
495                                 _("MMC out"), DataType::MIDI, ae->make_port_name_non_relative (session->mmc_output_port()->name())
496                                 );
497                 }
498
499                 program->add_bundle (sync);
500         }
501
502         /* Now find all other ports that we haven't thought of yet */
503
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];
507
508         string lpn (PROGRAM_NAME);
509         boost::to_lower (lpn);
510         string lpnc = lpn;
511         lpnc += ':';
512
513         vector<string> ports;
514         if (type == DataType::NIL) {
515                 vector<string> p1;
516                 AudioEngine::instance()->get_ports ("", DataType::AUDIO, inputs ? IsInput : IsOutput, ports);
517                 AudioEngine::instance()->get_ports ("", DataType::MIDI, inputs ? IsInput : IsOutput, p1);
518                 for (vector<string>::const_iterator s = p1.begin(); s != p1.end(); ++s) {
519                         ports.push_back (*s);
520                 }
521         } else {
522                 AudioEngine::instance()->get_ports ("", type, inputs ? IsInput : IsOutput, ports);
523         }
524
525         if (ports.size () > 0) {
526
527                 for (vector<string>::const_iterator s = ports.begin(); s != ports.end(); ) {
528
529                         std::string const p = *s;
530
531                         if (!system->has_port(p) &&
532                             !bus->has_port(p) &&
533                             !track->has_port(p) &&
534                             !program->has_port(p) &&
535                             !other->has_port(p)) {
536
537                                 /* special hack: ignore MIDI ports labelled Midi-Through. these
538                                    are basically useless and mess things up for default
539                                    connections.
540                                 */
541
542                                 if (p.find ("Midi-Through") != string::npos) {
543                                         ++s;
544                                         continue;
545                                 }
546
547                                 /* special hack: ignore our monitor inputs (which show up here because
548                                    we excluded them earlier.
549                                 */
550
551                                 string lp = p;
552                                 boost::to_lower (lp);
553
554                                 if ((lp.find (N_(":monitor")) != string::npos) &&
555                                     (lp.find (lpn) != string::npos)) {
556                                         ++s;
557                                         continue;
558                                 }
559
560                                 /* can't use the audio engine for this as we
561                                  * are looking at ports not owned by the
562                                  * application, and the audio engine/port
563                                  * manager doesn't seem them.
564                                  */
565
566                                 PortEngine::PortHandle ph = AudioEngine::instance()->port_engine().get_port_by_name (p);
567                                 if (ph) {
568                                         DataType t (AudioEngine::instance()->port_engine().port_data_type (ph));
569                                         if (t != DataType::NIL) {
570                                                 if (port_has_prefix (p, N_("system:")) ||
571                                                     port_has_prefix (p, N_("alsa_pcm:")) ||
572                                                     port_has_prefix (p, N_("alsa_midi:"))) {
573                                                         extra_system[t].push_back (p);
574                                                 } else if (port_has_prefix (p, lpnc)) {
575                                                         /* Hide scene ports from non-Tracks Live builds */
576                                                         if (!ARDOUR::Profile->get_trx()) {
577                                                                 if (p.find (_("Scene ")) != string::npos) {
578                                                                         ++s;
579                                                                         continue;
580                                                                 }
581                                                         }
582                                                         extra_program[t].push_back (p);
583                                                 } else {
584                                                         extra_other[t].push_back (p);
585                                                 }
586                                         }
587                                 }
588                         }
589
590                         ++s;
591                 }
592         }
593
594         for (DataType::iterator i = DataType::begin(); i != DataType::end(); ++i) {
595                 if (!extra_system[*i].empty()) {
596                         boost::shared_ptr<Bundle> b = make_bundle_from_ports (extra_system[*i], *i, inputs);
597                         system->add_bundle (b);
598                 }
599         }
600
601         for (DataType::iterator i = DataType::begin(); i != DataType::end(); ++i) {
602                 if (!extra_program[*i].empty()) {
603                         /* remove program name prefix from port name and use rest as bundle name */
604                         std::string bundle_name = extra_program[*i].front().substr (lpnc.length());
605                         boost::shared_ptr<Bundle> b = make_bundle_from_ports (extra_program[*i], *i, inputs, bundle_name);
606                         program->add_bundle (b);
607                 }
608         }
609
610         for (DataType::iterator i = DataType::begin(); i != DataType::end(); ++i) {
611                 if (extra_other[*i].empty()) continue;
612                 std::string cp;
613                 std::vector<std::string> nb;
614                 for (uint32_t j = 0; j < extra_other[*i].size(); ++j) {
615                         std::string nn = extra_other[*i][j];
616                         std::string pf = nn.substr (0, nn.find_first_of (":") + 1);
617                         if (pf != cp && !nb.empty()) {
618                                 boost::shared_ptr<Bundle> b = make_bundle_from_ports (nb, *i, inputs);
619                                 other->add_bundle (b);
620                                 nb.clear();
621                         }
622                         cp = pf;
623                         nb.push_back(extra_other[*i][j]);
624                 }
625                 if (!nb.empty()) {
626                         boost::shared_ptr<Bundle> b = make_bundle_from_ports (nb, *i, inputs);
627                         other->add_bundle (b);
628                 }
629         }
630
631         if (!allow_dups) {
632                 system->remove_duplicates ();
633         }
634
635         add_group_if_not_empty (other);
636         if (type != DataType::MIDI) {
637                 add_group_if_not_empty (bus);
638         }
639         add_group_if_not_empty (track);
640         add_group_if_not_empty (program);
641         add_group_if_not_empty (system);
642
643         emit_changed ();
644 }
645
646 boost::shared_ptr<Bundle>
647 PortGroupList::make_bundle_from_ports (std::vector<std::string> const & p, ARDOUR::DataType type, bool inputs, std::string const& bundle_name) const
648 {
649         boost::shared_ptr<Bundle> b (new Bundle ("", inputs));
650         std::string const pre = common_prefix (p);
651
652         if (!bundle_name.empty()) {
653                 b->set_name (bundle_name);
654         } else {
655                 if (!pre.empty()) {
656                         b->set_name (pre.substr (0, pre.length() - 1));
657                 }
658         }
659
660         for (uint32_t j = 0; j < p.size(); ++j) {
661                 std::string n = p[j].substr (pre.length());
662                 std::string pn = AudioEngine::instance()->get_pretty_name_by_name (p[j]);
663                 if (!pn.empty()) {
664                         n = pn;
665                 }
666                 b->add_channel (n, type);
667                 b->set_port (j, p[j]);
668         }
669
670         return b;
671 }
672
673 bool
674 PortGroupList::port_has_prefix (const std::string& n, const std::string& p) const
675 {
676         return n.substr (0, p.length()) == p;
677 }
678
679 std::string
680 PortGroupList::common_prefix_before (std::vector<std::string> const & p, std::string const & s) const
681 {
682         /* we must have some strings and the first must contain the separator string */
683         if (p.empty() || p[0].find_first_of (s) == std::string::npos) {
684                 return "";
685         }
686
687         /* prefix of the first string */
688         std::string const fp = p[0].substr (0, p[0].find_first_of (s) + 1);
689
690         /* see if the other strings also start with fp */
691         uint32_t j = 1;
692         while (j < p.size()) {
693                 if (p[j].substr (0, fp.length()) != fp) {
694                         break;
695                 }
696                 ++j;
697         }
698
699         if (j != p.size()) {
700                 return "";
701         }
702
703         return fp;
704 }
705
706
707 std::string
708 PortGroupList::common_prefix (std::vector<std::string> const & p) const
709 {
710         /* common prefix before '/' ? */
711         std::string cp = common_prefix_before (p, "/");
712         if (!cp.empty()) {
713                 return cp;
714         }
715
716         cp = common_prefix_before (p, ":");
717         if (!cp.empty()) {
718                 return cp;
719         }
720
721         return "";
722 }
723
724 void
725 PortGroupList::clear ()
726 {
727         _groups.clear ();
728         _bundle_changed_connections.drop_connections ();
729         emit_changed ();
730 }
731
732
733 PortGroup::BundleList const &
734 PortGroupList::bundles () const
735 {
736         _bundles.clear ();
737
738         for (PortGroupList::List::const_iterator i = begin (); i != end (); ++i) {
739                 std::copy ((*i)->bundles().begin(), (*i)->bundles().end(), std::back_inserter (_bundles));
740         }
741
742         return _bundles;
743 }
744
745 ChanCount
746 PortGroupList::total_channels () const
747 {
748         ChanCount n;
749
750         for (PortGroupList::List::const_iterator i = begin(); i != end(); ++i) {
751                 n += (*i)->total_channels ();
752         }
753
754         return n;
755 }
756
757 void
758 PortGroupList::add_group_if_not_empty (boost::shared_ptr<PortGroup> g)
759 {
760         if (!g->bundles().empty ()) {
761                 add_group (g);
762         }
763 }
764
765 void
766 PortGroupList::add_group (boost::shared_ptr<PortGroup> g)
767 {
768         _groups.push_back (g);
769
770         g->Changed.connect (_changed_connections, invalidator (*this), boost::bind (&PortGroupList::emit_changed, this), gui_context());
771         g->BundleChanged.connect (_bundle_changed_connections, invalidator (*this), boost::bind (&PortGroupList::emit_bundle_changed, this, _1), gui_context());
772
773         emit_changed ();
774 }
775
776 void
777 PortGroupList::remove_bundle (boost::shared_ptr<Bundle> b)
778 {
779         for (List::iterator i = _groups.begin(); i != _groups.end(); ++i) {
780                 (*i)->remove_bundle (b);
781         }
782
783         emit_changed ();
784 }
785
786 void
787 PortGroupList::emit_changed ()
788 {
789         if (_signals_suspended) {
790                 _pending_change = true;
791         } else {
792                 Changed ();
793         }
794 }
795
796 void
797 PortGroupList::emit_bundle_changed (Bundle::Change c)
798 {
799         if (_signals_suspended) {
800                 _pending_bundle_change = c;
801         } else {
802                 BundleChanged (c);
803         }
804 }
805 void
806 PortGroupList::suspend_signals ()
807 {
808         _signals_suspended = true;
809 }
810
811 void
812 PortGroupList::resume_signals ()
813 {
814         if (_pending_change) {
815                 Changed ();
816                 _pending_change = false;
817         }
818
819         if (_pending_bundle_change != 0) {
820                 BundleChanged (_pending_bundle_change);
821                 _pending_bundle_change = (ARDOUR::Bundle::Change) 0;
822         }
823
824         _signals_suspended = false;
825 }
826
827 boost::shared_ptr<IO>
828 PortGroupList::io_from_bundle (boost::shared_ptr<ARDOUR::Bundle> b) const
829 {
830         List::const_iterator i = _groups.begin ();
831         while (i != _groups.end()) {
832                 boost::shared_ptr<IO> io = (*i)->io_from_bundle (b);
833                 if (io) {
834                         return io;
835                 }
836                 ++i;
837         }
838
839         return boost::shared_ptr<IO> ();
840 }
841
842 bool
843 PortGroupList::empty () const
844 {
845         return _groups.empty ();
846 }