ardour/gtk2_ardour/port_group.cc

/*
    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 "port_group.h"
#include "port_matrix.h"
#include "i18n.h"
#include "ardour/session.h"
#include "ardour/audio_track.h"
#include "ardour/midi_track.h"
#include "ardour/audioengine.h"
#include "ardour/port.h"
#include "ardour/bundle.h"
#include <boost/shared_ptr.hpp>
#include <cstring>

using namespace std;
using namespace Gtk;

/** Add a bundle to a group.
 *  @param b Bundle.
 */
void
PortGroup::add_bundle (boost::shared_ptr<ARDOUR::Bundle> b)
{
	assert (b.get());
	_bundles.push_back (b);
}

/** Add a port to a group.
 *  @param p Port.
 */
void
PortGroup::add_port (std::string const &p)
{
	ports.push_back (p);
}

void
PortGroup::clear ()
{
	_bundles.clear ();
	ports.clear ();
}

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

	for (vector<std::string>::const_iterator i = ports.begin(); i != ports.end(); ++i) {
		if (*i == p) {
			return true;
		}
	}

	return false;
}

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

/** PortGroupUI constructor.
 *  @param m PortMatrix to work for.
 *  @Param g PortGroup to represent.
 */

PortGroupUI::PortGroupUI (PortMatrix* m, PortGroup* g)
	: _port_matrix (m)
	, _port_group (g)
	, _visibility_checkbutton (g->name)
{
	_port_group->set_visible (true);
	setup_visibility_checkbutton ();
	
	_visibility_checkbutton.signal_toggled().connect (sigc::mem_fun (*this, &PortGroupUI::visibility_checkbutton_toggled));
}

/** The visibility of a PortGroupUI has been toggled */
void
PortGroupUI::visibility_checkbutton_toggled ()
{
	_port_group->set_visible (_visibility_checkbutton.get_active ());
	setup_visibility_checkbutton ();
	_port_matrix->setup ();
}

/** Set up the visibility checkbutton according to PortGroup::visible */
void
PortGroupUI::setup_visibility_checkbutton ()
{
	if (_visibility_checkbutton.get_active () != _port_group->visible()) {
		_visibility_checkbutton.set_active (_port_group->visible());
	}
}

/** PortGroupList constructor.
 *  @param type Type of bundles to offer (audio or MIDI)
 *  @param offer_inputs true to offer output bundles, otherwise false.
 */

PortGroupList::PortGroupList (ARDOUR::DataType type, bool offer_inputs)
	: _type (type), _offer_inputs (offer_inputs), _bundles_dirty (true),
	  _buss (_("Bus"), true),
	  _track (_("Track"), true),
	  _system (_("System"), true),
	  _other (_("Other"), true)
{
	
}

/** Gather bundles from around the system and put them in this PortGroupList */
void
PortGroupList::gather (ARDOUR::Session& session)
{
	clear_list ();

	/* Find the bundles for routes */

	boost::shared_ptr<ARDOUR::Session::RouteList> routes = session.get_routes ();

	for (ARDOUR::Session::RouteList::const_iterator i = routes->begin(); i != routes->end(); ++i) {

		/* Route IO */
		PortGroup* g = 0;

		if (_type == ARDOUR::DataType::AUDIO) {

			if (boost::dynamic_pointer_cast<ARDOUR::AudioTrack> (*i)) {
				g = &_track;
			} else if (!boost::dynamic_pointer_cast<ARDOUR::MidiTrack>(*i)) {
				g = &_buss;
			} 


		} else if (_type == ARDOUR::DataType::MIDI) {

			if (boost::dynamic_pointer_cast<ARDOUR::MidiTrack> (*i)) {
				g = &_track;
			}

			/* No MIDI busses yet */
		} 
			
		if (g) {
			g->add_bundle (_offer_inputs ? (*i)->bundle_for_inputs() : (*i)->bundle_for_outputs ());
		}

		/* Ports from this route's processors */

		uint32_t n = 0;
		while (1) {
			boost::shared_ptr<ARDOUR::Processor> p = (*i)->nth_processor (n);
			if (p == 0) {
				break;
			}

			boost::shared_ptr<ARDOUR::IOProcessor> iop = boost::dynamic_pointer_cast<ARDOUR::IOProcessor> (p);
			if (iop) {
				g->add_bundle (_offer_inputs ? iop->io()->bundle_for_inputs() : iop->io()->bundle_for_outputs());
			}

			++n;
		}
	}

	/* Bundles created by the session */
	
	boost::shared_ptr<ARDOUR::BundleList> b = session.bundles ();
	for (ARDOUR::BundleList::iterator i = b->begin(); i != b->end(); ++i) {
		if ((*i)->ports_are_inputs() == _offer_inputs && (*i)->type() == _type) {
			_system.add_bundle (*i);
		}
	}

	/* Now find all other ports that we haven't thought of yet */

 	const char **ports = session.engine().get_ports ("", _type.to_jack_type(), _offer_inputs ? 
 							  JackPortIsInput : JackPortIsOutput);
 	if (ports) {

		int n = 0;
		string client_matching_string;

		client_matching_string = session.engine().client_name();
		client_matching_string += ':';

		while (ports[n]) {
			
			std::string const p = ports[n];

			if (!_system.has_port(p) && !_buss.has_port(p) && !_track.has_port(p) && !_other.has_port(p)) {
				
				if (port_has_prefix (p, "system:") ||
				    port_has_prefix (p, "alsa_pcm") ||
				    port_has_prefix (p, "ardour:")) {
					_system.add_port (p);
				} else {
					_other.add_port (p);
				}
			}
			
			++n;
		}

		free (ports);
	}

	push_back (&_system);
	push_back (&_buss);
	push_back (&_track);
	push_back (&_other);

	for (iterator i = begin(); i != end(); ++i) {
		_visibility_connections.push_back (
			(*i)->VisibilityChanged.connect (sigc::mem_fun (*this, &PortGroupList::visibility_changed))
			);
	}

	_bundles_dirty = true;
}

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

void
PortGroupList::set_type (ARDOUR::DataType t)
{
	_type = t;
	_bundles_dirty = true;
}

void
PortGroupList::set_offer_inputs (bool i)
{
	_offer_inputs = i;
	_bundles_dirty = true;
}

void
PortGroupList::update_bundles () const
{
	_bundles.clear ();
		
	for (const_iterator i = begin (); i != end (); ++i) {
		if ((*i)->visible()) {
			
			std::copy ((*i)->bundles().begin(), (*i)->bundles().end(), std::back_inserter (_bundles));

			/* make a bundle for the ports, if there are any */
			if (!(*i)->ports.empty()) {

				boost::shared_ptr<ARDOUR::Bundle> b (new ARDOUR::Bundle ("", _type, !_offer_inputs));
				
				std::string const pre = common_prefix ((*i)->ports);
				if (!pre.empty()) {
					b->set_name (pre.substr (0, pre.length() - 1));
				}

				for (uint32_t j = 0; j < (*i)->ports.size(); ++j) {
					std::string const p = (*i)->ports[j];
					b->add_channel (p.substr (pre.length()));
					b->set_port (j, p);
				}
					
				_bundles.push_back (b);
			}
		}
	}

	_bundles_dirty = false;
}

std::string
PortGroupList::common_prefix (std::vector<std::string> const & p) const
{
	/* common prefix before '/' ? */
	if (p[0].find_first_of ("/") != std::string::npos) {
		std::string const fp = p[0].substr (0, (p[0].find_first_of ("/") + 1));
		uint32_t j = 1;
		while (j < p.size()) {
			if (p[j].substr (0, fp.length()) != fp) {
				break;
			}
			++j;
		}
		
		if (j == p.size()) {
			return fp;
		}
	}
	
	/* or before ':' ? */
	if (p[0].find_first_of (":") != std::string::npos) {
		std::string const fp = p[0].substr (0, (p[0].find_first_of (":") + 1));
		uint32_t j = 1;
		while (j < p.size()) {
			if (p[j].substr (0, fp.length()) != fp) {
				break;
			}
			++j;
		}
		
		if (j == p.size()) {
			return fp;
		}
	}

	return "";
}

void
PortGroupList::visibility_changed ()
{
	VisibilityChanged ();
}

void
PortGroupList::take_visibility_from (PortGroupList const & o)
{
	iterator i = begin ();
	const_iterator j = o.begin ();

	while (i != end() && j != o.end()) {
		(*i)->set_visible ((*j)->visible());
		++i;
		++j;
	}
}

void
PortGroupList::clear_list ()
{
	clear ();

	_buss.clear ();
	_track.clear ();
	_system.clear ();
	_other.clear ();

	for (std::vector<sigc::connection>::iterator i = _visibility_connections.begin(); i != _visibility_connections.end(); ++i) {
		i->disconnect ();
	}

	_visibility_connections.clear ();
	_bundles_dirty = true;
}

ARDOUR::BundleList const &
PortGroupList::bundles () const
{
	if (_bundles_dirty) {
		update_bundles ();
	}

	return _bundles;
}