ardour/libs/ardour/port.cc

/*
    Copyright (C) 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 "ardour/port.h"
#include "ardour/audioengine.h"
#include "ardour/i18n.h"
#include "pbd/failed_constructor.h"
#include "pbd/error.h"
#include "pbd/compose.h"
#include <stdexcept>

ARDOUR::AudioEngine* ARDOUR::Port::_engine = 0;

ARDOUR::Port::Port (std::string const & n, DataType t, Flags f, bool e) : _jack_port (0), _last_monitor (false), _latency (0), _name (n), _flags (f)
{
	/* Unfortunately we have to pass the DataType into this constructor so that we can
	   create the right kind of JACK port; aside from this we'll use the virtual function type ()
	   to establish type. */
	
	if (e) {
		try {
			do_make_external (t);
		}
		catch (...) {
			throw failed_constructor ();
		}
	}
}

/** Port destructor */
ARDOUR::Port::~Port ()
{
	if (_jack_port) {
		jack_port_unregister (_engine->jack (), _jack_port);
	}
}

/** Make this port externally visible by setting it up to use a JACK port.
 * @param t Data type, so that we can call this method from the constructor.
 */
void
ARDOUR::Port::do_make_external (DataType t)
{
	if (_jack_port) {
		/* already external */
		return;
	}
	
	_jack_port = jack_port_register (_engine->jack (), _name.c_str (), t.to_jack_type (), _flags, 0);
	if (_jack_port == 0) {
		throw std::runtime_error ("Could not register JACK port");
	}
}

void
ARDOUR::Port::make_external ()
{
	do_make_external (type ());
}

/** @return true if this port is connected to anything */
bool
ARDOUR::Port::connected () const
{
	if (!_connections.empty ()) {
		/* connected to a Port* */
		return true;
	}

	if (_jack_port == 0) {
		/* not using a JACK port, so can't be connected to anything else */
		return false;
	}
	
	return (jack_port_connected (_jack_port) != 0);
}

int
ARDOUR::Port::disconnect_all ()
{
	/* Disconnect from Port* connections */
	for (std::set<Port*>::iterator i = _connections.begin (); i != _connections.end (); ++i) {
		(*i)->_connections.erase (this);
	}

	_connections.clear ();

	/* And JACK connections */
	jack_port_disconnect (_engine->jack(), _jack_port);
	_named_connections.clear ();

	return 0;
}

/** @param o Port name
 * @return true if this port is connected to o, otherwise false.
 */
bool
ARDOUR::Port::connected_to (std::string const & o) const
{
	if (_jack_port && jack_port_connected_to (_jack_port, o.c_str ())) {
		/* connected via JACK */
		return true;
	}

	for (std::set<Port*>::iterator i = _connections.begin (); i != _connections.end (); ++i) {
		if ((*i)->name () == o) {
			/* connected internally */
			return true;
		}
	}

	return false;
}

int
ARDOUR::Port::get_connections (std::vector<std::string> & c) const
{
	int n = 0;

	/* JACK connections */
	if (_jack_port) {
		const char** jc = jack_port_get_connections (_jack_port);
		if (jc) {
			for (int i = 0; jc[i]; ++i) {
				c.push_back (jc[i]);
				++n;
			}
		}
	}

	/* Internal connections */
	for (std::set<Port*>::iterator i = _connections.begin (); i != _connections.end (); ++i) {
		c.push_back ((*i)->name ());
		++n;
	}

	return n;
}

int
ARDOUR::Port::connect (std::string const & other)
{
	/* caller must hold process lock */
	
	Port* p = _engine->get_port_by_name_locked (other);
	
	int r;
	
	if (p && !p->external ()) {
		/* non-external Ardour port; connect using Port* */
		r = connect (p);
	} else {
		/* connect using name */

		/* for this to work, we must be an external port */
		if (!external ()) {
			make_external ();
		}

		std::string const this_nr = _engine->make_port_name_non_relative (_name);
		std::string const other_nr = _engine->make_port_name_non_relative (other);

		if (sends_output ()) {
			r = jack_connect (_engine->jack (), this_nr.c_str (), other_nr.c_str ());
		} else {
			r = jack_connect (_engine->jack (), other_nr.c_str (), this_nr.c_str());
		}

		if (r == 0) {
			_named_connections.insert (other);
		}
	}

	return r;
}

int
ARDOUR::Port::disconnect (std::string const & other)
{
	/* caller must hold process lock */
	
	Port* p = _engine->get_port_by_name_locked (other);
	int r;

	if (p && !p->external ()) {
		/* non-external Ardour port; disconnect using Port* */
		r = disconnect (p);
	} else {
		/* disconnect using name */

		std::string const this_nr = _engine->make_port_name_non_relative (_name);
		std::string const other_nr = _engine->make_port_name_non_relative (other);

		if (sends_output ()) {
			r = jack_disconnect (_engine->jack (), this_nr.c_str (), other_nr.c_str ());
		} else {
			r = jack_disconnect (_engine->jack (), other_nr.c_str (), this_nr.c_str ());
		}

		if (r == 0) {
			_named_connections.erase (other);
		}
	}

	return r;
}


bool
ARDOUR::Port::connected_to (Port *o) const
{
	return connected_to (o->name ());
}

int
ARDOUR::Port::connect (Port* o)
{
	/* caller must hold process lock */

	if (external () && o->external ()) {
		/* we're both external; connect using name */
		return connect (o->name ());
	}

	/* otherwise connect by Port* */
	_connections.insert (o);
	o->_connections.insert (this);

	return 0;
}

int
ARDOUR::Port::disconnect (Port* o)
{
	if (external () && o->external ()) {
		/* we're both external; try disconnecting using name */
		int const r = disconnect (o->name ());
		if (r == 0) {
			return 0;
		}
	}
	
	_connections.erase (o);
	o->_connections.erase (this);

	return 0;
}

void
ARDOUR::Port::set_engine (AudioEngine* e)
{
	_engine = e;
}

void
ARDOUR::Port::ensure_monitor_input (bool yn)
{
	if (_jack_port) {
		jack_port_ensure_monitor (_jack_port, yn);
	}
}

bool
ARDOUR::Port::monitoring_input () const
{
	if (_jack_port) {
		return jack_port_monitoring_input (_jack_port);
	} else {
		return false;
	}
}

void
ARDOUR::Port::reset ()
{
	_last_monitor = false;

	// XXX
	// _metering = 0;
	// reset_meters ();
}

void
ARDOUR::Port::recompute_total_latency () const
{
#ifdef HAVE_JACK_RECOMPUTE_LATENCY	
	if (_jack_port) {
		jack_recompute_total_latency (_engine->jack (), _jack_port);
	}
#endif	
}

nframes_t
ARDOUR::Port::total_latency () const
{
	if (_jack_port) {
		return jack_port_get_total_latency (_engine->jack (), _jack_port);
	} else {
		return _latency;
	}
}

int
ARDOUR::Port::reestablish ()
{
	if (!_jack_port) {
		return 0;
	}

	_jack_port = jack_port_register (_engine->jack(), _name.c_str(), type().to_jack_type(), _flags, 0);

	if (_jack_port == 0) {
		PBD::error << string_compose (_("could not reregister %1"), _name) << endmsg;
		return -1;
	}

	reset ();

	return 0;
}


int
ARDOUR::Port::reconnect ()
{
	/* caller must hold process lock; intended to be used only after reestablish() */

	if (!_jack_port) {
		return 0;
	}
	
	for (std::set<string>::iterator i = _named_connections.begin(); i != _named_connections.end(); ++i) {
		if (connect (*i)) {
			return -1;
		}
	}

	return 0;
}


int
ARDOUR::Port::set_name (std::string const & n)
{
	int r = 0;
	
	if (_jack_port) {
		r = jack_port_set_name (_jack_port, n.c_str());
		if (r) {
			_name = n;
		}
	} else {
		_name = n;
	}

	return r;
}

void
ARDOUR::Port::set_latency (nframes_t n)
{
	_latency = n;
}

void
ARDOUR::Port::request_monitor_input (bool yn)
{
	if (_jack_port) {
		jack_port_request_monitor (_jack_port, yn);
	}
}