more fixes/tweaks from the land of the lion
[ardour.git] / libs / midi++2 / midi++ / port.h
index 6d1191866b82c8a98dd3b435328e07de33971f37..03abd1a41c9d382d208decb83eb76ef6a7210db4 100644 (file)
@@ -16,8 +16,8 @@
 
 */
 
-#ifndef  __libmidi_port_h__
-#define  __libmidi_port_h__
+#ifndef  __libmidi_port_base_h__
+#define  __libmidi_port_base_h__
 
 #include <string>
 #include <iostream>
@@ -47,9 +47,9 @@ class Port {
                IsOutput = JackPortIsOutput,
        };
        
-       Port (std::string const &, Flags, jack_client_t *);
-       Port (const XMLNode&, jack_client_t *);
-       ~Port ();
+       Port (std::string const &, Flags);
+       Port (const XMLNode&);
+       virtual ~Port ();
 
        XMLNode& get_state () const;
        void set_state (const XMLNode&);
@@ -57,9 +57,9 @@ class Port {
        // 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(nframes_t nframes);
+       virtual void cycle_start (pframes_t) {}
        /* Only for use by MidiManager.  Don't ever call this. */
-       void cycle_end();
+       virtual void cycle_end () {}
 
        /** Write a message to port.
         * @param msg Raw MIDI message to send
@@ -67,17 +67,23 @@ class Port {
         * @param timestamp Time stamp in frames of this message (relative to cycle start)
         * @return number of bytes successfully written
         */
-       int write (byte *msg, size_t msglen, timestamp_t timestamp);
+       virtual int write (const 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
         */
-       int read (byte *buf, size_t bufsize);
+       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 */) {}
 
-       void parse (nframes_t timestamp);
-       
        /** Write a message to port.
         * @return true on success.
         * FIXME: describe semantics here
@@ -86,6 +92,8 @@ class Port {
                return !(write (msg, len, timestamp) == (int) len);
        } 
 
+       virtual void parse (framecnt_t timestamp) = 0;
+
        bool clock (timestamp_t timestamp);
 
        /* select(2)/poll(2)-based I/O */
@@ -93,9 +101,7 @@ class Port {
        /** Get the file descriptor for port.
         * @return File descriptor, or -1 if not selectable. 
         */
-       int selectable () const {
-               return xthread.selectable();
-       }
+       virtual int selectable () const = 0;
 
        Channel *channel (channel_t chn) { 
                return _channel[chn&0x7F];
@@ -108,6 +114,9 @@ class Port {
        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;
        }
@@ -124,53 +133,17 @@ class Port {
            XMLNode& get_state();
        };
 
-       nframes_t nframes_this_cycle() const {  return _nframes_this_cycle; }
+       static std::string state_node_name;
 
-       void reestablish (void *);
-       void reconnect ();
+  protected:
+       bool              _ok;
+       std::string       _tagname;
+       Channel*          _channel[16];
+       Parser*           _parser;
+       Flags             _flags;
+       bool              _centrally_parsed;
 
-       static void set_process_thread (pthread_t);
-       static pthread_t get_process_thread () { return _process_thread; }
-       static bool is_process_thread();
-       
-       static PBD::Signal0<void> MakeConnections;
-       static PBD::Signal0<void> JackHalted;
-
-private:       
-       bool             _ok;
-       bool             _currently_in_cycle;
-       nframes_t        _nframes_this_cycle;
-       std::string      _tagname;
-       size_t           _number;
-       Channel          *_channel[16];
-       Parser           *_parser;
-
-       int create_port ();
-
-       jack_client_t* _jack_client;
-       jack_port_t*   _jack_port;
-       nframes_t      _last_read_index;
-       timestamp_t    _last_write_timestamp;
-
-       /** Channel used to signal to the MidiControlUI that input has arrived */
-       CrossThreadChannel xthread;
-       
-       std::string _connections;
-       PBD::ScopedConnection connect_connection;
-       PBD::ScopedConnection halt_connection;
-       void flush (void* jack_port_buffer);
-       void jack_halted ();
-       void make_connections ();
        void init (std::string const &, Flags);
-
-       static pthread_t _process_thread;
-
-       RingBuffer< Evoral::Event<double> > output_fifo;
-       Evoral::EventRingBuffer<timestamp_t> input_fifo;
-
-       Glib::Mutex output_fifo_lock;
-
-       Flags _flags;
 };
 
 struct PortSet {
@@ -180,8 +153,8 @@ struct PortSet {
     std::list<XMLNode> ports;
 };
 
-std::ostream & operator << ( std::ostream & os, const Port & port );
+std::ostream & operator << (std::ostream& os, const Port& port);
 
 } // namespace MIDI
 
-#endif // __libmidi_port_h__
+#endif // __libmidi_port_base_h__