port_group.cc

Go to the documentation of this file.

/*
    Copyright (C) 2002-2009 Paul Davis

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

*/

#include <cstring>
#include <boost/shared_ptr.hpp>
#include <boost/algorithm/string.hpp>

#include "midi++/mmc.h"

#include "ardour/audioengine.h"
#include "ardour/auditioner.h"
#include "ardour/bundle.h"
#include "ardour/control_protocol_manager.h"
#include "ardour/io_processor.h"
#include "ardour/midi_port.h"
#include "ardour/midiport_manager.h"
#include "ardour/session.h"
#include "ardour/user_bundle.h"
#include "ardour/port.h"

#include "control_protocol/control_protocol.h"

#include "gui_thread.h"
#include "port_group.h"
#include "port_matrix.h"
#include "time_axis_view.h"
#include "public_editor.h"

#include "i18n.h"

using namespace std;
using namespace Gtk;
using namespace ARDOUR;

PortGroup::PortGroup (std::string const & n)
        : name (n)
{

}

PortGroup::~PortGroup()
{
        for (BundleList::iterator i = _bundles.begin(); i != _bundles.end(); ++i) {
                delete *i;
        }
        _bundles.clear ();
}

void
PortGroup::add_bundle (boost::shared_ptr<Bundle> b, bool allow_dups)
{
        add_bundle_internal (b, boost::shared_ptr<IO> (), false, Gdk::Color (), allow_dups);
}

void
PortGroup::add_bundle (boost::shared_ptr<Bundle> b, boost::shared_ptr<IO> io)
{
        add_bundle_internal (b, io, false, Gdk::Color (), false);
}

void
PortGroup::add_bundle (boost::shared_ptr<Bundle> b, boost::shared_ptr<IO> io, Gdk::Color c)
{
        add_bundle_internal (b, io, true, c, false);
}

PortGroup::BundleRecord::BundleRecord (boost::shared_ptr<ARDOUR::Bundle> b, boost::shared_ptr<ARDOUR::IO> iop, Gdk::Color c, bool has_c)
        : bundle (b)
        , io (iop)
        , colour (c)
        , has_colour (has_c)
{
}

void
PortGroup::add_bundle_internal (boost::shared_ptr<Bundle> b, boost::shared_ptr<IO> io, bool has_colour, Gdk::Color colour, bool allow_dups)
{
        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), boost::bind (&PortGroup::bundle_changed, this, _1), gui_context());
        _bundles.push_back (br);

        Changed ();
}

void
PortGroup::remove_bundle (boost::shared_ptr<Bundle> b)
{
        assert (b.get());

        BundleList::iterator i = _bundles.begin ();
        while (i != _bundles.end() && (*i)->bundle != b) {
                ++i;
        }

        if (i == _bundles.end()) {
                return;
        }

        delete *i;
        _bundles.erase (i);

        Changed ();
}

void
PortGroup::bundle_changed (Bundle::Change c)
{
        BundleChanged (c);
}


void
PortGroup::clear ()
{
        for (BundleList::iterator i = _bundles.begin(); i != _bundles.end(); ++i) {
                delete *i;
        }

        _bundles.clear ();
        Changed ();
}

bool
PortGroup::has_port (std::string const& p) const
{
        for (BundleList::const_iterator i = _bundles.begin(); i != _bundles.end(); ++i) {
                if ((*i)->bundle->offers_port_alone (p)) {
                        return true;
                }
        }

        return false;
}

boost::shared_ptr<Bundle>
PortGroup::only_bundle ()
{
        assert (_bundles.size() == 1);
        return _bundles.front()->bundle;
}


ChanCount
PortGroup::total_channels () const
{
        ChanCount n;
        for (BundleList::const_iterator i = _bundles.begin(); i != _bundles.end(); ++i) {
                n += (*i)->bundle->nchannels ();
        }

        return n;
}

boost::shared_ptr<IO>
PortGroup::io_from_bundle (boost::shared_ptr<ARDOUR::Bundle> b) const
{
        BundleList::const_iterator i = _bundles.begin ();
        while (i != _bundles.end() && (*i)->bundle != b) {
                ++i;
        }

        if (i == _bundles.end()) {
                return boost::shared_ptr<IO> ();
        }

        boost::shared_ptr<IO> io ((*i)->io.lock ());
        return io;
}

void
PortGroup::remove_duplicates ()
{
        BundleList::iterator i = _bundles.begin();
        while (i != _bundles.end()) {

                BundleList::iterator tmp = i;
                ++tmp;

                bool remove = false;

                for (BundleList::iterator j = _bundles.begin(); j != _bundles.end(); ++j) {

                        if ((*j)->bundle->nchannels() > (*i)->bundle->nchannels()) {
                                /* this bundle is larger */

                                uint32_t k = 0;
                                while (k < (*i)->bundle->nchannels().n_total()) {
                                        /* see if this channel on *i has an equivalent on *j */
                                        uint32_t l = 0;
                                        while (l < (*j)->bundle->nchannels().n_total() && (*i)->bundle->channel_ports (k) != (*j)->bundle->channel_ports (l)) {
                                                ++l;
                                        }

                                        if (l == (*j)->bundle->nchannels().n_total()) {
                                                /* it does not */
                                                break;
                                        }

                                        ++k;
                                }

                                if (k == (*i)->bundle->nchannels().n_total()) {
                                        /* all channels on *i are represented by the larger bundle *j, so remove *i */
                                        remove = true;
                                        break;
                                }
                        }
                }

                if (remove) {
                        _bundles.erase (i);
                }

                i = tmp;
        }
}


PortGroupList::PortGroupList ()
        : _signals_suspended (false), _pending_change (false), _pending_bundle_change ((Bundle::Change) 0)
{

}

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<IO> >* route_ios, bool inputs, set<boost::shared_ptr<IO> >& used_io
        )
{
        boost::shared_ptr<Processor> p (wp.lock());

        if (!p) {
                return;
        }

        boost::shared_ptr<IOProcessor> iop = boost::dynamic_pointer_cast<IOProcessor> (p);

        if (iop) {

                boost::shared_ptr<IO> io = inputs ? iop->input() : iop->output();

                if (io && used_io.find (io) == used_io.end()) {
                        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->order_key () < b.route->order_key ();
        }
};

void
PortGroupList::gather (ARDOUR::Session* session, ARDOUR::DataType type, bool inputs, bool allow_dups, bool use_session_bundles)
{
        clear ();

        if (session == 0) {
                return;
        }

        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> system (new PortGroup (_("Hardware")));
        boost::shared_ptr<PortGroup> ardour (new PortGroup (string_compose (_("%1 Misc"), PROGRAM_NAME)));
        boost::shared_ptr<PortGroup> other (new PortGroup (_("Other")));

        /* 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) {

                /* 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
                */

                set<boost::shared_ptr<IO> > used_io;
                boost::shared_ptr<IO> io = inputs ? (*i)->input() : (*i)->output();
                used_io.insert (io);

                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.
           Note that if the RouteIO's bundles are multi-type, we may make new Bundles
           with only the ports of one type.
        */

        for (list<RouteIOs>::iterator i = route_ios.begin(); i != route_ios.end(); ++i) {
                TimeAxisView* tv = PublicEditor::instance().axis_view_from_route (i->route);

                /* Work out which group to put these IOs' bundles in */
                boost::shared_ptr<PortGroup> g;
                if (boost::dynamic_pointer_cast<Track> (i->route)) {
                        g = track;
                } else {
                        g = bus;
                }

                for (list<boost::shared_ptr<IO> >::iterator j = i->ios.begin(); j != i->ios.end(); ++j) {
                        if (tv) {
                                g->add_bundle ((*j)->bundle(), *j, tv->color ());
                        } else {
                                g->add_bundle ((*j)->bundle(), *j);
                        }
                }
        }

        /* Bundles owned by the session; add user bundles first, then normal ones, so
           that UserBundles that offer the same ports as a normal bundle get priority
        */

        boost::shared_ptr<BundleList> b = session->bundles ();

        for (BundleList::iterator i = b->begin(); i != b->end(); ++i) {
                if (boost::dynamic_pointer_cast<UserBundle> (*i) && (*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) {
                ardour->add_bundle (session->the_auditioner()->output()->bundle());
                ardour->add_bundle (session->click_io()->bundle());
                /* Note: the LTC ports do not have the usual ":audio_out 1" postfix, so
                 *  ardour->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()));
                ardour->add_bundle (ltc);
        } else {
                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()));
                ardour->add_bundle (ltc);
        }

        /* Ardour's control surfaces */

        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) {
                                        ardour->add_bundle (*j);
                                }
                        }
                }
        }

        /* Ardour's sync ports */

        if ((type == DataType::MIDI || type == DataType::NIL)) {
                boost::shared_ptr<Bundle> sync (new Bundle (_("Sync"), inputs));
                AudioEngine* ae = AudioEngine::instance();

                if (inputs) {
                        sync->add_channel (
                                _("MTC in"), DataType::MIDI, ae->make_port_name_non_relative (session->mtc_input_port()->name())
                                );
                        sync->add_channel (
                                _("MIDI control in"), DataType::MIDI, ae->make_port_name_non_relative (session->midi_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 control out"), DataType::MIDI, ae->make_port_name_non_relative (session->midi_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())
                                );
                }

                ardour->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_other[DataType::num_types];

        string lpn (PROGRAM_NAME);
        boost::to_lower (lpn);
        string lpnc = lpn;
        lpnc += ':';

        vector<string> ports;
        if (AudioEngine::instance()->get_ports ("", type, inputs ? IsInput : IsOutput, ports) > 0) {

                for (vector<string>::const_iterator s = ports.begin(); s != ports.end(); ) {

                        std::string const p = *s;

                        if (!system->has_port(p) &&
                            !bus->has_port(p) &&
                            !track->has_port(p) &&
                            !ardour->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) {
                                        ++s;
                                        continue;
                                }

                                /* special hack: ignore our monitor inputs (which show up here because
                                   we excluded them earlier.
                                */

                                string lp = p;
                                boost::to_lower (lp);

                                if ((lp.find (N_(":monitor")) != string::npos) &&
                                    (lp.find (lpn) != string::npos)) {
                                        ++s;
                                        continue;
                                }

                                /* can't use the audio engine for this as we are looking at non-Ardour ports */

                                PortEngine::PortHandle ph = AudioEngine::instance()->port_engine().get_port_by_name (p);
                                if (ph) {
                                        DataType t (AudioEngine::instance()->port_engine().port_data_type (ph));
                                        if (t != DataType::NIL) {
                                                if (port_has_prefix (p, N_("system:")) ||
                                                    port_has_prefix (p, N_("alsa_pcm")) ||
                                                    port_has_prefix (p, lpnc)) {
                                                        extra_system[t].push_back (p);
                                                } else {
                                                        extra_other[t].push_back (p);
                                                }
                                        }
                                }
                        }

                        ++s;
                }
        }

        for (DataType::iterator i = DataType::begin(); i != DataType::end(); ++i) {
                if (!extra_system[*i].empty()) {
                        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()) 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);
                }
        }

        if (!allow_dups) {
                system->remove_duplicates ();
        }

        add_group_if_not_empty (other);
        if (type != DataType::MIDI) {
                add_group_if_not_empty (bus);
        }
        add_group_if_not_empty (track);
        add_group_if_not_empty (ardour);
        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
{
        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));
        }

        for (uint32_t j = 0; j < p.size(); ++j) {
                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]);
        }

        return b;
}

bool
PortGroupList::port_has_prefix (const std::string& n, const std::string& p) const
{
        return n.substr (0, p.length()) == p;
}

std::string
PortGroupList::common_prefix_before (std::vector<std::string> const & p, std::string const & s) const
{
        /* we must have some strings and the first must contain the separator string */
        if (p.empty() || p[0].find_first_of (s) == std::string::npos) {
                return "";
        }

        /* prefix of the first string */
        std::string const fp = p[0].substr (0, p[0].find_first_of (s) + 1);

        /* see if the other strings also start with fp */
        uint32_t j = 1;
        while (j < p.size()) {
                if (p[j].substr (0, fp.length()) != fp) {
                        break;
                }
                ++j;
        }

        if (j != p.size()) {
                return "";
        }

        return fp;
}


std::string
PortGroupList::common_prefix (std::vector<std::string> const & p) const
{
        /* common prefix before '/' ? */
        std::string cp = common_prefix_before (p, "/");
        if (!cp.empty()) {
                return cp;
        }

        cp = common_prefix_before (p, ":");
        if (!cp.empty()) {
                return cp;
        }

        return "";
}

void
PortGroupList::clear ()
{
        _groups.clear ();
        _bundle_changed_connections.drop_connections ();
        emit_changed ();
}


PortGroup::BundleList const &
PortGroupList::bundles () const
{
        _bundles.clear ();

        for (PortGroupList::List::const_iterator i = begin (); i != end (); ++i) {
                std::copy ((*i)->bundles().begin(), (*i)->bundles().end(), std::back_inserter (_bundles));
        }

        return _bundles;
}

ChanCount
PortGroupList::total_channels () const
{
        ChanCount n;

        for (PortGroupList::List::const_iterator i = begin(); i != end(); ++i) {
                n += (*i)->total_channels ();
        }

        return n;
}

void
PortGroupList::add_group_if_not_empty (boost::shared_ptr<PortGroup> g)
{
        if (!g->bundles().empty ()) {
                add_group (g);
        }
}

void
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), boost::bind (&PortGroupList::emit_bundle_changed, this, _1), gui_context());

        emit_changed ();
}

void
PortGroupList::remove_bundle (boost::shared_ptr<Bundle> b)
{
        for (List::iterator i = _groups.begin(); i != _groups.end(); ++i) {
                (*i)->remove_bundle (b);
        }

        emit_changed ();
}

void
PortGroupList::emit_changed ()
{
        if (_signals_suspended) {
                _pending_change = true;
        } else {
                Changed ();
        }
}

void
PortGroupList::emit_bundle_changed (Bundle::Change c)
{
        if (_signals_suspended) {
                _pending_bundle_change = c;
        } else {
                BundleChanged (c);
        }
}
void
PortGroupList::suspend_signals ()
{
        _signals_suspended = true;
}

void
PortGroupList::resume_signals ()
{
        if (_pending_change) {
                Changed ();
                _pending_change = false;
        }

        if (_pending_bundle_change != 0) {
                BundleChanged (_pending_bundle_change);
                _pending_bundle_change = (ARDOUR::Bundle::Change) 0;
        }

        _signals_suspended = false;
}

boost::shared_ptr<IO>
PortGroupList::io_from_bundle (boost::shared_ptr<ARDOUR::Bundle> b) const
{
        List::const_iterator i = _groups.begin ();
        while (i != _groups.end()) {
                boost::shared_ptr<IO> io = (*i)->io_from_bundle (b);
                if (io) {
                        return io;
                }
                ++i;
        }

        return boost::shared_ptr<IO> ();
}

bool
PortGroupList::empty () const
{
        return _groups.empty ();
}