libmidi++: split apart "base-y" aspects of MIDI::Port into MIDI::PortBase and make MIDI::Port derive from it. This actually makes MIDI::Port effectively into MIDI::JackPort, but i'm not interested in the name changing at that level at this moment in time

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

4 files changed, 173 insertions, 103 deletions

diff --git a/libs/midi++2/midi++/channel.h b/libs/midi++2/midi++/channel.h
index 162eea1e9a..370a569156 100644
--- a/libs/midi++2/midi++/channel.h
+++ b/libs/midi++2/midi++/channel.h
@@ -39,9 +39,9 @@ class Port;
 class Channel : public PBD::ScopedConnectionList {
 
   public:
-	Channel (byte channel_number, Port &);
+	Channel (byte channel_number, PortBase &);
 
-	Port &midi_port()               { return _port; }
+	PortBase &midi_port()           { return _port; }
 	byte channel()                  { return _channel_number; }
 	byte program()                  { return _program_number; }
 	byte bank()                     { return _bank_number; }
@@ -111,11 +111,11 @@ class Channel : public PBD::ScopedConnectionList {
 	}
 
   protected:
-	friend class Port;
+	friend class PortBase;
 	void connect_signals ();
 
   private:
-	Port & _port;
+	PortBase& _port;
 
 	/* Current channel values */
 	byte               _channel_number;
diff --git a/libs/midi++2/midi++/parser.h b/libs/midi++2/midi++/parser.h
index e57323e72d..ac452798cc 100644
--- a/libs/midi++2/midi++/parser.h
+++ b/libs/midi++2/midi++/parser.h
@@ -29,7 +29,7 @@
 
 namespace MIDI {
 
-class Port;
+class PortBase;
 class Parser;
 
 typedef PBD::Signal1<void,Parser&>                   ZeroByteSignal;
@@ -41,7 +41,7 @@ typedef PBD::Signal3<void,Parser &, byte *, size_t>  Signal;
 
 class Parser {
  public:
-	Parser (Port &p);
+	Parser (PortBase &p);
 	~Parser ();
 
 	/* sets the time that will be reported for any MTC or MIDI Clock
@@ -105,7 +105,7 @@ class Parser {
 	const char *midi_event_type_name (MIDI::eventType);
 	void trace (bool onoff, std::ostream *o, const std::string &prefix = "");
 	bool tracing() { return trace_stream != 0; }
-	Port &port() { return _port; }
+	PortBase &port() { return _port; }
 
 	void set_offline (bool);
 	bool offline() const { return _offline; }
@@ -136,9 +136,9 @@ class Parser {
 	void reset_mtc_state ();
 	
   private:
-	Port &_port;
+	PortBase&_port;
 	/* tracing */
-
+	
 	std::ostream *trace_stream;
 	std::string trace_prefix;
 	void trace_event (Parser &p, byte *msg, size_t len);
diff --git a/libs/midi++2/midi++/port.h b/libs/midi++2/midi++/port.h
index 6b4381d496..e7b532013e 100644
--- a/libs/midi++2/midi++/port.h
+++ b/libs/midi++2/midi++/port.h
@@ -34,98 +34,30 @@
 
 #include "midi++/types.h"
 #include "midi++/parser.h"
+#include "midi++/port_base.h"
 
 namespace MIDI {
 
 class Channel;
 class PortRequest;
 
-class Port {
+class Port : public PortBase {
   public:
-	enum Flags {
-		IsInput = JackPortIsInput,
-		IsOutput = JackPortIsOutput,
-	};
-	
-	Port (std::string const &, Flags, jack_client_t *);
+	Port (std::string const &, PortBase::Flags, jack_client_t *);
 	Port (const XMLNode&, jack_client_t *);
 	~Port ();
 
 	XMLNode& get_state () const;
 	void set_state (const XMLNode&);
 
-	// FIXME: make Manager a friend of port so these can be hidden?
-
-	/* Only for use by MidiManager.  Don't ever call this. */
 	void cycle_start (pframes_t nframes);
-	/* Only for use by MidiManager.  Don't ever call this. */
 	void cycle_end ();
 
-	/** Write a message to port.
-	 * @param msg Raw MIDI message to send
-	 * @param msglen Size of @a msg
-	 * @param timestamp Time stamp in frames of this message (relative to cycle start)
-	 * @return number of bytes successfully written
-	 */
+	void parse (framecnt_t timestamp);
 	int write (byte *msg, size_t msglen, timestamp_t timestamp);
-
-	/** Read raw bytes from a port.
-	 * @param buf memory to store read data in
-	 * @param bufsize size of @a buf
-	 * @return number of bytes successfully read, negative if error
-	 */
 	int read (byte *buf, size_t bufsize);
-
-	void parse (framecnt_t timestamp);
-	
-	/** Write a message to port.
-	 * @return true on success.
-	 * FIXME: describe semantics here
-	 */
-	int midimsg (byte *msg, size_t len, timestamp_t timestamp) {
-		return !(write (msg, len, timestamp) == (int) len);
-	} 
-
-	bool clock (timestamp_t timestamp);
-
-	/* select(2)/poll(2)-based I/O */
-
-	/** Get the file descriptor for port.
-	 * @return File descriptor, or -1 if not selectable. 
-	 */
-	int selectable () const {
-		return xthread.selectable();
-	}
-
-	Channel *channel (channel_t chn) { 
-		return _channel[chn&0x7F];
-	}
-	
-	Parser* parser () {
-		return _parser;
-	}
-	
-	const char *name () const   { return _tagname.c_str(); }
-	bool   ok ()   const        { return _ok; }
-
-	bool centrally_parsed() const { return _centrally_parsed; }
-	void set_centrally_parsed(bool yn) { _centrally_parsed = yn; }
-
-	bool receives_input () const {
-		return _flags == IsInput;
-	}
-
-	bool sends_output () const {
-		return _flags == IsOutput;
-	}
-
-	struct Descriptor {
-	    std::string tag;
-	    Flags flags;
-
-	    Descriptor (const XMLNode&);
-	    XMLNode& get_state();
-	};
+	void drain (int check_interval_usecs);
+	int selectable () const { return xthread.selectable(); }
 
 	pframes_t nframes_this_cycle() const { return _nframes_this_cycle; }
 
@@ -136,30 +68,19 @@ class Port {
 	static pthread_t get_process_thread () { return _process_thread; }
 	static bool is_process_thread();
 
-	static std::string state_node_name;
-	
 	static PBD::Signal0<void> MakeConnections;
 	static PBD::Signal0<void> JackHalted;
 
 private:	
-	bool              _ok;
 	bool              _currently_in_cycle;
 	pframes_t         _nframes_this_cycle;
-	std::string       _tagname;
-	size_t            _number;
-	Channel*          _channel[16];
-	Parser*           _parser;
 	jack_client_t*    _jack_client;
 	jack_port_t*      _jack_port;
-	framecnt_t        _last_read_index;
 	timestamp_t       _last_write_timestamp;
 	RingBuffer< Evoral::Event<double> > output_fifo;
 	Evoral::EventRingBuffer<timestamp_t> input_fifo;
 	Glib::Mutex output_fifo_lock;
 	CrossThreadChannel xthread;
-	Flags             _flags;
-	bool              _centrally_parsed;
-
 
 	int create_port ();
 
@@ -177,15 +98,6 @@ private:
 
 };
 
-struct PortSet {
-    PortSet (std::string str) : owner (str) { }
-    
-    std::string owner;
-    std::list<XMLNode> ports;
-};
-
-std::ostream & operator << ( std::ostream & os, const Port & port );
-
 } // namespace MIDI
 
 #endif // __libmidi_port_h__
diff --git a/libs/midi++2/midi++/port_base.h b/libs/midi++2/midi++/port_base.h
new file mode 100644
index 0000000000..ceb7834643
--- /dev/null
+++ b/libs/midi++2/midi++/port_base.h
@@ -0,0 +1,158 @@
+/*
+    Copyright (C) 1998-2010 Paul Barton-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.
+
+*/
+
+#ifndef  __libmidi_port_base_h__
+#define  __libmidi_port_base_h__
+
+#include <string>
+#include <iostream>
+
+#include <jack/types.h>
+
+#include "pbd/xml++.h"
+#include "pbd/crossthread.h"
+#include "pbd/signals.h"
+#include "pbd/ringbuffer.h"
+
+#include "evoral/Event.hpp"
+#include "evoral/EventRingBuffer.hpp"
+
+#include "midi++/types.h"
+#include "midi++/parser.h"
+
+namespace MIDI {
+
+class Channel;
+class PortRequest;
+
+class PortBase {
+  public:
+	enum Flags {
+		IsInput = JackPortIsInput,
+		IsOutput = JackPortIsOutput,
+	};
+	
+	PortBase (std::string const &, Flags);
+	PortBase (const XMLNode&);
+	virtual ~PortBase ();
+
+	XMLNode& get_state () const;
+	void set_state (const XMLNode&);
+
+	// FIXME: make Manager a friend of port so these can be hidden?
+
+	/* Only for use by MidiManager.  Don't ever call this. */
+	virtual void cycle_start (pframes_t nframes) {}
+	/* Only for use by MidiManager.  Don't ever call this. */
+	virtual void cycle_end () {}
+
+	/** Write a message to port.
+	 * @param msg Raw MIDI message to send
+	 * @param msglen Size of @a msg
+	 * @param timestamp Time stamp in frames of this message (relative to cycle start)
+	 * @return number of bytes successfully written
+	 */
+	virtual int write (byte *msg, size_t msglen, timestamp_t timestamp) = 0;
+
+	/** Read raw bytes from a port.
+	 * @param buf memory to store read data in
+	 * @param bufsize size of @a buf
+	 * @return number of bytes successfully read, negative if error
+	 */
+	virtual int read (byte *buf, size_t bufsize) = 0;
+
+	/** block until the output FIFO used by non-process threads
+	 * is empty, checking every @a check_interval_usecs usecs
+	 * for current status. Not to be called by a thread that
+	 * executes any part of a JACK process callback (will 
+	 * simply return immediately in that situation).
+	 */
+	virtual void drain (int check_interval_usecs) {}
+
+	/** Write a message to port.
+	 * @return true on success.
+	 * FIXME: describe semantics here
+	 */
+	int midimsg (byte *msg, size_t len, timestamp_t timestamp) {
+		return !(write (msg, len, timestamp) == (int) len);
+	} 
+
+	bool clock (timestamp_t timestamp);
+
+	/* select(2)/poll(2)-based I/O */
+
+	/** Get the file descriptor for port.
+	 * @return File descriptor, or -1 if not selectable. 
+	 */
+	virtual int selectable () const = 0;
+
+	Channel *channel (channel_t chn) { 
+		return _channel[chn&0x7F];
+	}
+	
+	Parser* parser () {
+		return _parser;
+	}
+	
+	const char *name () const   { return _tagname.c_str(); }
+	bool   ok ()   const        { return _ok; }
+
+	virtual bool centrally_parsed() const;
+	void set_centrally_parsed (bool yn) { _centrally_parsed = yn; }
+
+	bool receives_input () const {
+		return _flags == IsInput;
+	}
+
+	bool sends_output () const {
+		return _flags == IsOutput;
+	}
+
+	struct Descriptor {
+	    std::string tag;
+	    Flags flags;
+
+	    Descriptor (const XMLNode&);
+	    XMLNode& get_state();
+	};
+
+	static std::string state_node_name;
+
+  protected:
+	bool              _ok;
+	std::string       _tagname;
+	Channel*          _channel[16];
+	Parser*           _parser;
+	Flags             _flags;
+	bool              _centrally_parsed;
+
+	virtual void init (std::string const &, Flags);
+};
+
+struct PortSet {
+    PortSet (std::string str) : owner (str) { }
+    
+    std::string owner;
+    std::list<XMLNode> ports;
+};
+
+std::ostream & operator << (std::ostream& os, const PortBase& port);
+
+} // namespace MIDI
+
+#endif // __libmidi_port_base_h__