fix incorrect accumulation of export video options each time the dialog is used
[ardour.git] / gtk2_ardour / port_group.cc
index 7990eded89bfe1ca7ae68604ff8b53c98c1cb339..f68a00dd8faaeef1351b97bd6a5f868afda88e64 100644 (file)
 
 #include <cstring>
 #include <boost/shared_ptr.hpp>
+#include <boost/algorithm/string.hpp>
+
+#include "midi++/mmc.h"
 
-#include "ardour/audio_track.h"
 #include "ardour/audioengine.h"
+#include "ardour/auditioner.h"
 #include "ardour/bundle.h"
-#include "ardour/user_bundle.h"
+#include "ardour/control_protocol_manager.h"
 #include "ardour/io_processor.h"
-#include "ardour/midi_track.h"
+#include "ardour/midi_port.h"
+#include "ardour/midiport_manager.h"
+#include "ardour/plugin_insert.h"
 #include "ardour/port.h"
+#include "ardour/profile.h"
 #include "ardour/session.h"
-#include "ardour/auditioner.h"
+#include "ardour/sidechain.h"
+#include "ardour/user_bundle.h"
+
+#include "control_protocol/control_protocol.h"
 
 #include "gui_thread.h"
 #include "port_group.h"
@@ -36,7 +45,7 @@
 #include "time_axis_view.h"
 #include "public_editor.h"
 
-#include "i18n.h"
+#include "pbd/i18n.h"
 
 using namespace std;
 using namespace Gtk;
@@ -103,24 +112,24 @@ PortGroup::add_bundle_internal (boost::shared_ptr<Bundle> b, boost::shared_ptr<I
        assert (b.get());
 
        if (!allow_dups) {
-               
+
                /* don't add this bundle if we already have one with the same ports */
-               
+
                BundleList::iterator i = _bundles.begin ();
                while (i != _bundles.end() && b->has_same_ports ((*i)->bundle) == false) {
                        ++i;
                }
-               
+
                if (i != _bundles.end ()) {
                        return;
                }
        }
 
        BundleRecord* br = new BundleRecord (b, io, colour, has_colour);
-       b->Changed.connect (br->changed_connection, invalidator (*this), ui_bind (&PortGroup::bundle_changed, this, _1), gui_context());
+       b->Changed.connect (br->changed_connection, invalidator (*this), boost::bind (&PortGroup::bundle_changed, this, _1), gui_context());
        _bundles.push_back (br);
 
-       Changed ();     
+       Changed ();
 }
 
 void
@@ -204,7 +213,8 @@ PortGroup::io_from_bundle (boost::shared_ptr<ARDOUR::Bundle> b) const
                return boost::shared_ptr<IO> ();
        }
 
-       return (*i)->io;
+       boost::shared_ptr<IO> io ((*i)->io.lock ());
+       return io;
 }
 
 /** Remove bundles whose channels are already represented by other, larger bundles */
@@ -247,11 +257,11 @@ PortGroup::remove_duplicates ()
                                }
                        }
                }
-               
+
                if (remove) {
                        _bundles.erase (i);
                }
-               
+
                i = tmp;
        }
 }
@@ -265,14 +275,14 @@ PortGroupList::PortGroupList ()
 
 }
 
-PortGroupList::~PortGroupList() 
+PortGroupList::~PortGroupList()
 {
        /* XXX need to clean up bundles, but ownership shared with PortGroups */
 }
 
 void
 PortGroupList::maybe_add_processor_to_list (
-       boost::weak_ptr<Processor> wp, list<boost::shared_ptr<Bundle> >* route_bundles, bool inputs, set<boost::shared_ptr<IO> >& used_io
+       boost::weak_ptr<Processor> wp, list<boost::shared_ptr<IO> >* route_ios, bool inputs, set<boost::shared_ptr<IO> >& used_io
        )
 {
        boost::shared_ptr<Processor> p (wp.lock());
@@ -288,18 +298,38 @@ PortGroupList::maybe_add_processor_to_list (
                boost::shared_ptr<IO> io = inputs ? iop->input() : iop->output();
 
                if (io && used_io.find (io) == used_io.end()) {
-                       route_bundles->push_back (io->bundle ());
+                       route_ios->push_back (io);
                        used_io.insert (io);
                }
        }
 }
 
+struct RouteIOs {
+       RouteIOs (boost::shared_ptr<Route> r, boost::shared_ptr<IO> i) {
+               route = r;
+               ios.push_back (i);
+       }
+
+       boost::shared_ptr<Route> route;
+       /* it's ok to use a shared_ptr here as RouteIOs structs are only used during ::gather () */
+       std::list<boost::shared_ptr<IO> > ios;
+};
+
+class RouteIOsComparator {
+public:
+       bool operator() (RouteIOs const & a, RouteIOs const & b) {
+               return a.route->presentation_info ().order() < b.route->presentation_info().order();
+       }
+};
 
-/** Gather bundles from around the system and put them in this PortGroupList.
- *  @param type Type of bundles to collect, or NIL for all types.
+/** Gather ports from around the system and put them in this PortGroupList.
+ *  @param type Type of ports to collect, or NIL for all types.
+ *  @param use_session_bundles true to use the session's non-user bundles.  Doing this will mean that
+ *  hardware ports will be gathered into stereo pairs, as the session sets up bundles for these pairs.
+ *  Not using the session bundles will mean that all hardware IO will be presented separately.
  */
 void
-PortGroupList::gather (ARDOUR::Session* session, ARDOUR::DataType type, bool inputs, bool allow_dups)
+PortGroupList::gather (ARDOUR::Session* session, ARDOUR::DataType type, bool inputs, bool allow_dups, bool use_session_bundles)
 {
        clear ();
 
@@ -307,48 +337,88 @@ PortGroupList::gather (ARDOUR::Session* session, ARDOUR::DataType type, bool inp
                return;
        }
 
-       boost::shared_ptr<PortGroup> bus (new PortGroup (_("Bus")));
-       boost::shared_ptr<PortGroup> track (new PortGroup (_("Track")));
-       boost::shared_ptr<PortGroup> system (new PortGroup (_("System")));
-       boost::shared_ptr<PortGroup> ardour (new PortGroup (_("Ardour")));
+       boost::shared_ptr<PortGroup> bus (new PortGroup (string_compose (_("%1 Busses"), PROGRAM_NAME)));
+       boost::shared_ptr<PortGroup> track (new PortGroup (string_compose (_("%1 Tracks"), PROGRAM_NAME)));
+       boost::shared_ptr<PortGroup> sidechain (new PortGroup (string_compose (_("%1 Sidechains"), PROGRAM_NAME)));
+       boost::shared_ptr<PortGroup> system (new PortGroup (_("Hardware")));
+       boost::shared_ptr<PortGroup> program (new PortGroup (string_compose (_("%1 Misc"), PROGRAM_NAME)));
        boost::shared_ptr<PortGroup> other (new PortGroup (_("Other")));
 
-       /* Find the bundles for routes.  We use the RouteBundle class to join
-          the route's input/output and processor bundles together so that they
-          are presented as one bundle in the matrix. */
+       /* Find the IOs which have bundles for routes and their processors.  We store
+          these IOs in a RouteIOs class so that we can then sort the results by route
+          order key.
+       */
 
        boost::shared_ptr<RouteList> routes = session->get_routes ();
+       list<RouteIOs> route_ios;
 
        for (RouteList::const_iterator i = routes->begin(); i != routes->end(); ++i) {
 
-               list<boost::shared_ptr<Bundle> > route_bundles;
+               /* we never show the monitor bus inputs */
+
+               if (inputs && (*i)->is_monitor()) {
+                       continue;
+               }
 
                /* keep track of IOs that we have taken bundles from,
                   so that we can avoid taking the same IO from both
-                  Route::output() and the main_outs Delivery */
+                  Route::output() and the main_outs Delivery
+                */
 
                set<boost::shared_ptr<IO> > used_io;
                boost::shared_ptr<IO> io = inputs ? (*i)->input() : (*i)->output();
                used_io.insert (io);
 
-               route_bundles.push_back (io->bundle ());
+               RouteIOs rb (*i, io);
+               (*i)->foreach_processor (boost::bind (&PortGroupList::maybe_add_processor_to_list, this, _1, &rb.ios, inputs, used_io));
+
+               route_ios.push_back (rb);
+       }
+
+       /* Sort RouteIOs by the routes' editor order keys */
+       route_ios.sort (RouteIOsComparator ());
+
+       /* Now put the bundles that belong to these sorted RouteIOs into the PortGroup. */
 
-               (*i)->foreach_processor (boost::bind (&PortGroupList::maybe_add_processor_to_list, this, _1, &route_bundles, inputs, used_io));
+       for (list<RouteIOs>::iterator i = route_ios.begin(); i != route_ios.end(); ++i) {
+               TimeAxisView* tv = PublicEditor::instance().time_axis_view_from_stripable (i->route);
 
-               /* Work out which group to put these bundles in */
+               /* Work out which group to put these IOs' bundles in */
                boost::shared_ptr<PortGroup> g;
-               if (boost::dynamic_pointer_cast<Track> (*i)) {
+               if (boost::dynamic_pointer_cast<Track> (i->route)) {
                        g = track;
                } else {
                        g = bus;
                }
 
-               TimeAxisView* tv = PublicEditor::instance().axis_view_from_route (*i);
-               for (list<boost::shared_ptr<Bundle> >::iterator i = route_bundles.begin(); i != route_bundles.end(); ++i) {
-                       if (tv) {
-                               g->add_bundle (*i, io, tv->color ());
-                       } else {
-                               g->add_bundle (*i, io);
+               for (list<boost::shared_ptr<IO> >::iterator j = i->ios.begin(); j != i->ios.end(); ++j) {
+                       /* Only add the bundle if there is at least one port
+                        * with a type that's been asked for */
+                       if (type == DataType::NIL || (*j)->bundle()->nchannels().n(type) > 0) {
+                               if (tv) {
+                                       g->add_bundle ((*j)->bundle(), *j, tv->color ());
+                               } else {
+                                       g->add_bundle ((*j)->bundle(), *j);
+                               }
+                       }
+               }
+
+               /* When on input side, let's look for sidechains in the route's plugins
+                  to display them right next to their route */
+               for (uint32_t n = 0; inputs; ++n) {
+                       boost::shared_ptr<Processor> p = (i->route)->nth_plugin (n);
+                       if (!p) {
+                               break;
+                       }
+                       boost::shared_ptr<SideChain> sc = boost::static_pointer_cast<PluginInsert> (p)->sidechain ();
+
+                       if (sc) {
+                               boost::shared_ptr<IO> io = sc->input();
+                               if (tv) {
+                                       sidechain->add_bundle (io->bundle(), io, tv->color ());
+                               } else {
+                                       sidechain->add_bundle (io->bundle(), io);
+                               }
                        }
                }
        }
@@ -365,85 +435,230 @@ PortGroupList::gather (ARDOUR::Session* session, ARDOUR::DataType type, bool inp
                }
        }
 
-       for (BundleList::iterator i = b->begin(); i != b->end(); ++i) {
-               if (boost::dynamic_pointer_cast<UserBundle> (*i) == 0 && (*i)->ports_are_inputs() == inputs) {
-                       system->add_bundle (*i, allow_dups);
+       /* Only look for non-user bundles if instructed to do so */
+       if (use_session_bundles) {
+               for (BundleList::iterator i = b->begin(); i != b->end(); ++i) {
+                       if (boost::dynamic_pointer_cast<UserBundle> (*i) == 0 && (*i)->ports_are_inputs() == inputs) {
+                               system->add_bundle (*i, allow_dups);
+                       }
                }
        }
-       
-       /* Ardour stuff */
 
-       if (!inputs && (type == DataType::AUDIO || type == DataType::NIL)) {
-               ardour->add_bundle (session->the_auditioner()->output()->bundle());
-               ardour->add_bundle (session->click_io()->bundle());
+       /* miscellany */
+
+       if (type == DataType::AUDIO || type == DataType::NIL) {
+               if (!inputs) {
+                       program->add_bundle (session->the_auditioner()->output()->bundle());
+                       program->add_bundle (session->click_io()->bundle());
+                       /* Note: the LTC ports do not have the usual ":audio_out 1" postfix, so
+                        *  program->add_bundle (session->ltc_output_io()->bundle());
+                        *  won't work
+                        */
+                       boost::shared_ptr<Bundle> ltc (new Bundle (_("LTC Out"), inputs));
+                       ltc->add_channel (_("LTC Out"), DataType::AUDIO, session->engine().make_port_name_non_relative (session->ltc_output_port()->name()));
+                       program->add_bundle (ltc);
+               } else {
+                       // XXX TRANSPORTMASTERS
+                       //boost::shared_ptr<Bundle> ltc (new Bundle (_("LTC In"), inputs));
+                       // ltc->add_channel (_("LTC In"), DataType::AUDIO, session->engine().make_port_name_non_relative (session->ltc_input_port()->name()));
+                       // program->add_bundle (ltc);
+               }
+       }
+
+       /* our control surfaces */
+
+       /* XXX assume for now that all control protocols with ports use
+        * MIDI. If anyone created a control protocol that used audio ports,
+        * this will break.
+        */
+
+       if ((type == DataType::MIDI || type == DataType::NIL)) {
+               ControlProtocolManager& m = ControlProtocolManager::instance ();
+               for (list<ControlProtocolInfo*>::iterator i = m.control_protocol_info.begin(); i != m.control_protocol_info.end(); ++i) {
+                       if ((*i)->protocol) {
+                               list<boost::shared_ptr<Bundle> > b = (*i)->protocol->bundles ();
+                               for (list<boost::shared_ptr<Bundle> >::iterator j = b.begin(); j != b.end(); ++j) {
+                                       if ((*j)->ports_are_inputs() == inputs) {
+                                               program->add_bundle (*j);
+                                       }
+                               }
+                       }
+               }
+       }
+
+       /* our sync ports */
+
+       if ((type == DataType::MIDI || type == DataType::NIL)) {
+               boost::shared_ptr<Bundle> sync (new Bundle (_("Sync"), inputs));
+               AudioEngine* ae = AudioEngine::instance();
+
+               if (inputs) {
+                       // XXX TRANSPORTMASTER
+                       // sync->add_channel (
+                       // _("MTC in"), DataType::MIDI, ae->make_port_name_non_relative (session->mtc_input_port()->name())
+                       // );
+                       // sync->add_channel (
+                       // _("MIDI clock in"), DataType::MIDI, ae->make_port_name_non_relative (session->midi_clock_input_port()->name())
+                       //);
+                       sync->add_channel (
+                               _("MMC in"), DataType::MIDI, ae->make_port_name_non_relative (session->mmc_input_port()->name())
+                               );
+               } else {
+                       sync->add_channel (
+                               _("MTC out"), DataType::MIDI, ae->make_port_name_non_relative (session->mtc_output_port()->name())
+                               );
+                       sync->add_channel (
+                               _("MIDI clock out"), DataType::MIDI, ae->make_port_name_non_relative (session->midi_clock_output_port()->name())
+                               );
+                       sync->add_channel (
+                               _("MMC out"), DataType::MIDI, ae->make_port_name_non_relative (session->mmc_output_port()->name())
+                               );
+               }
+
+               program->add_bundle (sync);
        }
 
        /* Now find all other ports that we haven't thought of yet */
 
        std::vector<std::string> extra_system[DataType::num_types];
+       std::vector<std::string> extra_program[DataType::num_types];
        std::vector<std::string> extra_other[DataType::num_types];
 
-       const char ** ports = 0;
+       string lpn (PROGRAM_NAME);
+       boost::to_lower (lpn);
+       string lpnc = lpn;
+       lpnc += ':';
+
+       vector<string> ports;
        if (type == DataType::NIL) {
-               ports = session->engine().get_ports ("", "", inputs ? JackPortIsInput : JackPortIsOutput);
+               vector<string> p1;
+               AudioEngine::instance()->get_ports ("", DataType::AUDIO, inputs ? IsInput : IsOutput, ports);
+               AudioEngine::instance()->get_ports ("", DataType::MIDI, inputs ? IsInput : IsOutput, p1);
+               for (vector<string>::const_iterator s = p1.begin(); s != p1.end(); ++s) {
+                       ports.push_back (*s);
+               }
        } else {
-               ports = session->engine().get_ports ("", type.to_jack_type(), inputs ? JackPortIsInput : JackPortIsOutput);
+               AudioEngine::instance()->get_ports ("", type, inputs ? IsInput : IsOutput, ports);
        }
-       
-       if (ports) {
 
-               int n = 0;
+       if (ports.size () > 0) {
 
-               while (ports[n]) {
+               for (vector<string>::const_iterator s = ports.begin(); s != ports.end(); ) {
 
-                       std::string const p = ports[n];
+                       std::string const p = *s;
 
                        if (!system->has_port(p) &&
                            !bus->has_port(p) &&
                            !track->has_port(p) &&
-                           !ardour->has_port(p) &&
+                           !sidechain->has_port(p) &&
+                           !program->has_port(p) &&
                            !other->has_port(p)) {
-                                
-                                /* special hack: ignore MIDI ports labelled Midi-Through. these
-                                   are basically useless and mess things up for default
-                                   connections.
-                                */
-
-                                if (p.find ("MIDI-Through") != string::npos) {
-                                        ++n;
-                                        continue;
-                                }
-
-                               /* can't use the audio engine for this as we are looking at non-Ardour ports */
-
-                               jack_port_t* jp = jack_port_by_name (session->engine().jack(), p.c_str());
-                               if (jp) {
-                                       DataType t (jack_port_type (jp));
-                                       if (t != DataType::NIL) {
-                                               if (port_has_prefix (p, "system:") || port_has_prefix (p, "alsa_pcm") || port_has_prefix (p, "ardour:")) {
-                                                       extra_system[t].push_back (p);
-                                               } else {
-                                                       extra_other[t].push_back (p);
+
+                               /* special hack: ignore MIDI ports labelled Midi-Through. these
+                                  are basically useless and mess things up for default
+                                  connections.
+                               */
+
+                               if (p.find ("Midi-Through") != string::npos || p.find ("Midi Through") != string::npos) {
+                                       ++s;
+                                       continue;
+                               }
+
+                               /* special hack: ignore our monitor inputs (which show up here because
+                                  we excluded them earlier.
+                               */
+
+                               string lp = p;
+                               string monitor = _("Monitor");
+
+                               boost::to_lower (lp);
+                               boost::to_lower (monitor);
+
+                               if ((lp.find (monitor) != string::npos) &&
+                                   (lp.find (lpn) != string::npos)) {
+                                       ++s;
+                                       continue;
+                               }
+
+                               /* can't use the audio engine for this as we
+                                * are looking at ports not owned by the
+                                * application, and the audio engine/port
+                                * manager doesn't seem them.
+                                */
+
+                               PortEngine::PortHandle ph = AudioEngine::instance()->port_engine().get_port_by_name (p);
+
+                               if (!ph) {
+                                       continue;
+                               }
+
+                               DataType t (AudioEngine::instance()->port_engine().port_data_type (ph));
+
+                               if (t != DataType::NIL) {
+
+                                       PortFlags flags (AudioEngine::instance()->port_engine().get_port_flags (ph));
+
+                                       if (port_has_prefix (p, lpnc)) {
+
+                                               /* we own this port (named after the program) */
+
+                                               /* Hide scene ports from non-Tracks Live builds */
+                                               if (!ARDOUR::Profile->get_trx()) {
+                                                       if (p.find (_("Scene ")) != string::npos) {
+                                                               ++s;
+                                                               continue;
+                                                       }
                                                }
+
+                                               extra_program[t].push_back (p);
+
+                                       } else if (flags & IsPhysical) {
+
+                                               extra_system[t].push_back (p);
+
+                                       } else {
+                                               extra_other[t].push_back (p);
                                        }
                                }
                        }
 
-                       ++n;
+                       ++s;
                }
-
-               free (ports);
        }
 
        for (DataType::iterator i = DataType::begin(); i != DataType::end(); ++i) {
                if (!extra_system[*i].empty()) {
-                       system->add_bundle (make_bundle_from_ports (extra_system[*i], *i, inputs));
+                       boost::shared_ptr<Bundle> b = make_bundle_from_ports (extra_system[*i], *i, inputs);
+                       system->add_bundle (b);
                }
        }
 
        for (DataType::iterator i = DataType::begin(); i != DataType::end(); ++i) {
-               if (!extra_other[*i].empty()) {
-                       other->add_bundle (make_bundle_from_ports (extra_other[*i], *i, inputs));
+               if (!extra_program[*i].empty()) {
+                       /* used program name as bundle name */
+                       boost::shared_ptr<Bundle> b = make_bundle_from_ports (extra_program[*i], *i, inputs, lpn);
+                       program->add_bundle (b);
+               }
+       }
+
+       for (DataType::iterator i = DataType::begin(); i != DataType::end(); ++i) {
+               if (extra_other[*i].empty()) continue;
+               std::string cp;
+               std::vector<std::string> nb;
+               for (uint32_t j = 0; j < extra_other[*i].size(); ++j) {
+                       std::string nn = extra_other[*i][j];
+                       std::string pf = nn.substr (0, nn.find_first_of (":") + 1);
+                       if (pf != cp && !nb.empty()) {
+                               boost::shared_ptr<Bundle> b = make_bundle_from_ports (nb, *i, inputs);
+                               other->add_bundle (b);
+                               nb.clear();
+                       }
+                       cp = pf;
+                       nb.push_back(extra_other[*i][j]);
+               }
+               if (!nb.empty()) {
+                       boost::shared_ptr<Bundle> b = make_bundle_from_ports (nb, *i, inputs);
+                       other->add_bundle (b);
                }
        }
 
@@ -454,24 +669,34 @@ PortGroupList::gather (ARDOUR::Session* session, ARDOUR::DataType type, bool inp
        add_group_if_not_empty (other);
        add_group_if_not_empty (bus);
        add_group_if_not_empty (track);
-       add_group_if_not_empty (ardour);
+       add_group_if_not_empty (sidechain);
+       add_group_if_not_empty (program);
        add_group_if_not_empty (system);
 
        emit_changed ();
 }
 
 boost::shared_ptr<Bundle>
-PortGroupList::make_bundle_from_ports (std::vector<std::string> const & p, ARDOUR::DataType type, bool inputs) const
+PortGroupList::make_bundle_from_ports (std::vector<std::string> const & p, ARDOUR::DataType type, bool inputs, std::string const& bundle_name) const
 {
        boost::shared_ptr<Bundle> b (new Bundle ("", inputs));
-
        std::string const pre = common_prefix (p);
-       if (!pre.empty()) {
-               b->set_name (pre.substr (0, pre.length() - 1));
+
+       if (!bundle_name.empty()) {
+               b->set_name (bundle_name);
+       } else {
+               if (!pre.empty()) {
+                       b->set_name (pre.substr (0, pre.length() - 1));
+               }
        }
 
        for (uint32_t j = 0; j < p.size(); ++j) {
-               b->add_channel (p[j].substr (pre.length()), type);
+               std::string n = p[j].substr (pre.length());
+               std::string pn = AudioEngine::instance()->get_pretty_name_by_name (p[j]);
+               if (!pn.empty()) {
+                       n = pn;
+               }
+               b->add_channel (n, type);
                b->set_port (j, p[j]);
        }
 
@@ -576,7 +801,7 @@ PortGroupList::add_group (boost::shared_ptr<PortGroup> g)
        _groups.push_back (g);
 
        g->Changed.connect (_changed_connections, invalidator (*this), boost::bind (&PortGroupList::emit_changed, this), gui_context());
-       g->BundleChanged.connect (_bundle_changed_connections, invalidator (*this), ui_bind (&PortGroupList::emit_bundle_changed, this, _1), gui_context());
+       g->BundleChanged.connect (_bundle_changed_connections, invalidator (*this), boost::bind (&PortGroupList::emit_bundle_changed, this, _1), gui_context());
 
        emit_changed ();
 }
@@ -650,11 +875,5 @@ PortGroupList::io_from_bundle (boost::shared_ptr<ARDOUR::Bundle> b) const
 bool
 PortGroupList::empty () const
 {
-       List::const_iterator i = _groups.begin ();
-       while (i != _groups.end() && (*i)->total_channels() == ChanCount::ZERO) {
-               ++i;
-       }
-
-       return (i == _groups.end());
+       return _groups.empty ();
 }
-