add support for IP MIDI (multicast MIDI over IP UDP sockets) to ardour and use it if requested inside MCP code. required renaming the pre-existing MIDI::Port as MIDI:JackMIDIPort - MIDI::Port becomes the base type for both JackMIDIPort and IPMIDIPort

git-svn-id: svn://localhost/ardour2/branches/3.0@12069 d708f5d6-7413-0410-9779-e7cbd77b26cf

1 files changed, 67 insertions, 348 deletions

diff --git a/libs/midi++2/port.cc b/libs/midi++2/port.cc
index ef1704857d..3e7896631a 100644
--- a/libs/midi++2/port.cc
+++ b/libs/midi++2/port.cc
@@ -15,7 +15,7 @@
     along with this program; if not, write to the Free Software
     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 
-    $Id$
+    $Id: port.cc 11871 2012-04-10 16:27:01Z paul $
 */
 #include <iostream>
 #include <cstdio>
@@ -40,325 +40,117 @@ using namespace MIDI;
 using namespace std;
 using namespace PBD;
 
-pthread_t Port::_process_thread;
-Signal0<void> Port::JackHalted;
-Signal0<void> Port::MakeConnections;
-
-Port::Port (string const & name, Flags flags, jack_client_t* jack_client)
-	: PortBase (name, flags)
-	, _currently_in_cycle (false)
-	, _nframes_this_cycle (0)
-	, _jack_client (jack_client)
-	, _jack_port (0)
-	, output_fifo (512)
-	, input_fifo (1024)
-	, xthread (true)
+string Port::state_node_name = "MIDI-port";
+
+Port::Port (string const & name, Flags flags)
+	: _flags (flags)
+	, _centrally_parsed (true)
 {
-	assert (jack_client);
 	init (name, flags);
 }
 
-Port::Port (const XMLNode& node, jack_client_t* jack_client)
-	: PortBase (node)
-	, _currently_in_cycle (false)
-	, _nframes_this_cycle (0)
-	, _jack_client (jack_client)
-	, _jack_port (0)
-	, output_fifo (512)
-	, input_fifo (1024)
-	, xthread (true)
+Port::Port (const XMLNode& node)
+	: _centrally_parsed (true)
 {
-	assert (jack_client);
-
 	Descriptor desc (node);
+
 	init (desc.tag, desc.flags);
-	set_state (node);
+
+	/* derived class must call ::set_state() */
 }
 
 void
 Port::init (string const & name, Flags flags)
 {
-	if (!create_port ()) {
-		_ok = true;
-	}
+	_ok = false;  /* derived class must set to true if constructor
+			 succeeds.
+		      */
 
-	MakeConnections.connect_same_thread (connect_connection, boost::bind (&Port::make_connections, this));
-	JackHalted.connect_same_thread (halt_connection, boost::bind (&Port::jack_halted, this));
-}
+	_parser = 0;
 
+	_tagname = name;
+	_flags = flags;
 
-Port::~Port ()
-{
-	for (int i = 0; i < 16; i++) {
-		delete _channel[i];
-	}
+	_parser = new Parser (*this);
 
-	if (_jack_port) {
-		if (_jack_client) {
-			jack_port_unregister (_jack_client, _jack_port);
-			_jack_port = 0;
-		}
+	for (int i = 0; i < 16; i++) {
+		_channel[i] = new Channel (i, *this);
+		_channel[i]->connect_signals ();
 	}
 }
 
-void
-Port::parse (framecnt_t timestamp)
+Port::~Port ()
 {
-	byte buf[512];
-
-	/* NOTE: parsing is done (if at all) by initiating a read from 
-	   the port. Each port implementation calls on the parser
-	   once it has data ready.
-	*/
-	
-	_parser->set_timestamp (timestamp);
-
-	while (1) {
-		
-		// cerr << "+++ READ ON " << name() << endl;
-
-		int nread = read (buf, sizeof (buf));
-
-		// cerr << "-- READ (" << nread << " ON " << name() << endl;
-		
-		if (nread > 0) {
-			if ((size_t) nread < sizeof (buf)) {
-				break;
-			} else {
-				continue;
-			}
-		} else if (nread == 0) {
-			break;
-		} else if (errno == EAGAIN) {
-			break;
-		} else {
-			fatal << "Error reading from MIDI port " << name() << endmsg;
-			/*NOTREACHED*/
-		}
+	for (int i = 0; i < 16; i++) {
+		delete _channel[i];
 	}
 }
 
-void
-Port::cycle_start (pframes_t nframes)
+/** Send a clock tick message.
+ * \return true on success.
+ */
+bool
+Port::clock (timestamp_t timestamp)
 {
-	assert (_jack_port);
+	static byte clockmsg = 0xf8;
 	
-	_currently_in_cycle = true;
-	_nframes_this_cycle = nframes;
-
-	assert(_nframes_this_cycle == nframes);
-
 	if (sends_output()) {
-		void *buffer = jack_port_get_buffer (_jack_port, nframes);
-		jack_midi_clear_buffer (buffer);
-		flush (buffer);	
+		return midimsg (&clockmsg, 1, timestamp);
 	}
 	
-	if (receives_input()) {
-		void* jack_buffer = jack_port_get_buffer(_jack_port, nframes);
-		const pframes_t event_count = jack_midi_get_event_count(jack_buffer);
-
-		jack_midi_event_t ev;
-		timestamp_t cycle_start_frame = jack_last_frame_time (_jack_client);
-
-		for (pframes_t i = 0; i < event_count; ++i) {
-			jack_midi_event_get (&ev, jack_buffer, i);
-			input_fifo.write (cycle_start_frame + ev.time, (Evoral::EventType) 0, ev.size, ev.buffer);
-		}	
-		
-		if (event_count) {
-			xthread.wakeup ();
-		}
-	}
+	return false;
 }
 
-void
-Port::cycle_end ()
+std::ostream & MIDI::operator << ( std::ostream & os, const MIDI::Port & port )
 {
-	if (sends_output()) {
-		flush (jack_port_get_buffer (_jack_port, _nframes_this_cycle));
-	}
-
-	_currently_in_cycle = false;
-	_nframes_this_cycle = 0;
-}
-
-void
-Port::jack_halted ()
-{
-	_jack_client = 0;
-	_jack_port = 0;
-}
-
-void
-Port::drain (int check_interval_usecs)
-{
-	RingBuffer< Evoral::Event<double> >::rw_vector vec = { { 0, 0 }, { 0, 0} };
-
-	if (is_process_thread()) {
-		error << "Process thread called MIDI::Port::drain() - this cannot work" << endmsg;
-		return;
-	}
-
-	while (1) {
-		output_fifo.get_write_vector (&vec);
-		if (vec.len[0] + vec.len[1] >= output_fifo.bufsize() - 1) {
-			break;
-		}
-		usleep (check_interval_usecs);
-	}
+	using namespace std;
+	os << "MIDI::Port { ";
+	os << "name: " << port.name();
+	os << "; ";
+	os << "ok: " << port.ok();
+	os << "; ";
+	os << " }";
+	return os;
 }
 
-int
-Port::write(byte * msg, size_t msglen, timestamp_t timestamp)
+Port::Descriptor::Descriptor (const XMLNode& node)
 {
-	int ret = 0;
-
-	if (!sends_output()) {
-		return ret;
-	}
-	
-	if (!is_process_thread()) {
-
-		Glib::Mutex::Lock lm (output_fifo_lock);
-		RingBuffer< Evoral::Event<double> >::rw_vector vec = { { 0, 0 }, { 0, 0} };
-		
-		output_fifo.get_write_vector (&vec);
-
-		if (vec.len[0] + vec.len[1] < 1) {
-			error << "no space in FIFO for non-process thread MIDI write" << endmsg;
-			return 0;
-		}
-
-		if (vec.len[0]) {
-                        if (!vec.buf[0]->owns_buffer()) {
-                                vec.buf[0]->set_buffer (0, 0, true);
-                        }
-			vec.buf[0]->set (msg, msglen, timestamp);
-		} else {
-                        if (!vec.buf[1]->owns_buffer()) {
-                                vec.buf[1]->set_buffer (0, 0, true);
-                        }
-			vec.buf[1]->set (msg, msglen, timestamp);
-		}
-
-		output_fifo.increment_write_idx (1);
-		
-		ret = msglen;
-
-	} else {
-
-		// XXX This had to be temporarily commented out to make export work again
-		if (!(timestamp < _nframes_this_cycle)) {
-			std::cerr << "attempting to write MIDI event of " << msglen << " bytes at time "
-				  << timestamp << " of " << _nframes_this_cycle
-				  << " (this will not work - needs a code fix)"
-				  << std::endl;
-		}
+	const XMLProperty *prop;
+	bool have_tag = false;
+	bool have_mode = false;
 
-		if (_currently_in_cycle) {
-			if (timestamp == 0) {
-				timestamp = _last_write_timestamp;
-			} 
-
-			if (jack_midi_event_write (jack_port_get_buffer (_jack_port, _nframes_this_cycle), 
-						timestamp, msg, msglen) == 0) {
-				ret = msglen;
-				_last_write_timestamp = timestamp;
-
-			} else {
-				ret = 0;
-				cerr << "write of " << msglen << " failed, port holds "
-					<< jack_midi_get_event_count (jack_port_get_buffer (_jack_port, _nframes_this_cycle))
-					<< endl;
-			}
-		} else {
-			cerr << "write to JACK midi port failed: not currently in a process cycle." << endl;
-			PBD::stacktrace (cerr, 20);
-		}
+	if ((prop = node.property ("tag")) != 0) {
+		tag = prop->value();
+		have_tag = true;
 	}
 
-	if (ret > 0 && _parser) {
-		// ardour doesn't care about this and neither should your app, probably
-		// output_parser->raw_preparse (*output_parser, msg, ret);
-		for (int i = 0; i < ret; i++) {
-			_parser->scanner (msg[i]);
-		}
-		// ardour doesn't care about this and neither should your app, probably
-		// output_parser->raw_postparse (*output_parser, msg, ret);
-	}	
-
-	return ret;
-}
-
-void
-Port::flush (void* jack_port_buffer)
-{
-	RingBuffer< Evoral::Event<double> >::rw_vector vec = { { 0, 0 }, { 0, 0 } };
-	size_t written;
-
-	output_fifo.get_read_vector (&vec);
+	if ((prop = node.property ("mode")) != 0) {
 
-	if (vec.len[0] + vec.len[1]) {
-		// cerr << "Flush " << vec.len[0] + vec.len[1] << " events from non-process FIFO\n";
-	}
-
-	if (vec.len[0]) {
-		Evoral::Event<double>* evp = vec.buf[0];
-		
-		for (size_t n = 0; n < vec.len[0]; ++n, ++evp) {
-			jack_midi_event_write (jack_port_buffer,
-					       (timestamp_t) evp->time(), evp->buffer(), evp->size());
+		if (strings_equal_ignore_case (prop->value(), "output") || strings_equal_ignore_case (prop->value(), "out")) {
+			flags = IsOutput;
+		} else if (strings_equal_ignore_case (prop->value(), "input") || strings_equal_ignore_case (prop->value(), "in")) {
+			flags = IsInput;
 		}
-	}
-	
-	if (vec.len[1]) {
-		Evoral::Event<double>* evp = vec.buf[1];
 
-		for (size_t n = 0; n < vec.len[1]; ++n, ++evp) {
-			jack_midi_event_write (jack_port_buffer,
-					       (timestamp_t) evp->time(), evp->buffer(), evp->size());
-		}
-	}
-	
-	if ((written = vec.len[0] + vec.len[1]) != 0) {
-		output_fifo.increment_read_idx (written);
+		have_mode = true;
 	}
-}
 
-int
-Port::read (byte *, size_t)
-{
-	if (!receives_input()) {
-		return 0;
+	if (!have_tag || !have_mode) {
+		throw failed_constructor();
 	}
-	
-	timestamp_t time;
-	Evoral::EventType type;
-	uint32_t size;
-	byte buffer[input_fifo.capacity()];
-
-	while (input_fifo.read (&time, &type, &size, buffer)) {
-		_parser->set_timestamp (time);
-		for (uint32_t i = 0; i < size; ++i) {
-			_parser->scanner (buffer[i]);
-		}
-	}
-
-	return 0;
-}
-
-int
-Port::create_port ()
-{
-	_jack_port = jack_port_register(_jack_client, _tagname.c_str(), JACK_DEFAULT_MIDI_TYPE, _flags, 0);
-	return _jack_port == 0 ? -1 : 0;
 }
 
 XMLNode& 
 Port::get_state () const
 {
-	XMLNode& root = PortBase::get_state ();
+	XMLNode* root = new XMLNode (state_node_name);
+	root->add_property ("tag", _tagname);
+
+	if (_flags == IsInput) {
+		root->add_property ("mode", "input");
+	} else {
+		root->add_property ("mode", "output");
+	}
 	
 #if 0
 	byte device_inquiry[6];
@@ -373,30 +165,7 @@ Port::get_state () const
 	write (device_inquiry, sizeof (device_inquiry), 0);
 #endif
 
-	if (_jack_port) {
-		
-		const char** jc = jack_port_get_connections (_jack_port);
-		string connection_string;
-		if (jc) {
-			for (int i = 0; jc[i]; ++i) {
-				if (i > 0) {
-					connection_string += ',';
-				}
-				connection_string += jc[i];
-			}
-			free (jc);
-		}
-		
-		if (!connection_string.empty()) {
-			root.add_property ("connections", connection_string);
-		}
-	} else {
-		if (!_connections.empty()) {
-			root.add_property ("connections", _connections);
-		}
-	}
-
-	return root;
+	return *root;
 }
 
 void
@@ -407,60 +176,10 @@ Port::set_state (const XMLNode& node)
 	if ((prop = node.property ("tag")) == 0 || prop->value() != _tagname) {
 		return;
 	}
-	
-	PortBase::set_state (node);
-
-	if ((prop = node.property ("connections")) != 0) {
-		_connections = prop->value ();
-	}
-}
-
-void
-Port::make_connections ()
-{
-	if (!_connections.empty()) {
-		vector<string> ports;
-		split (_connections, ports, ',');
-		for (vector<string>::iterator x = ports.begin(); x != ports.end(); ++x) {
-			if (_jack_client) {
-				if (receives_input()) {
-					jack_connect (_jack_client, (*x).c_str(), jack_port_name (_jack_port));
-				} else {
-					jack_connect (_jack_client, jack_port_name (_jack_port), (*x).c_str());
-				}
-				/* ignore failures */
-			}
-		}
-	}
-
-	connect_connection.disconnect ();
-}
-
-void
-Port::set_process_thread (pthread_t thr)
-{
-	_process_thread = thr;
 }
 
 bool
-Port::is_process_thread()
-{
-	return (pthread_self() == _process_thread);
-}
-
-void
-Port::reestablish (jack_client_t* jack)
-{
-	_jack_client = jack;
-	int const r = create_port ();
-
-	if (r) {
-		PBD::error << "could not reregister ports for " << name() << endmsg;
-	}
-}
-
-void
-Port::reconnect ()
+Port::centrally_parsed() const
 {
-	make_connections ();
+	return _centrally_parsed;
 }