fix SConstruct so that it can build from a git checkout rather than an svn checkout
[ardour.git] / libs / ardour / ardour / port.h
index 86c99cb7e3e24533f326a1d1b2d2c5691c70a2f7..084022541d3993d3c9639237215e87f0dbc501a8 100644 (file)
     along with this program; if not, write to the Free Software
     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 
-    $Id$
 */
 
 #ifndef __ardour_port_h__
 #define __ardour_port_h__
 
+#include <set>
+#include <vector>
+#include <string>
+#include <cstring>
 #include <sigc++/signal.h>
 #include <pbd/failed_constructor.h>
 #include <ardour/ardour.h>
+#include <ardour/data_type.h>
 #include <jack/jack.h>
 
 namespace ARDOUR {
 
 class AudioEngine;
+class Buffer;
 
-class Port : public sigc::trackable {
+/** Abstract base for ports
+ */
+class Port : public virtual sigc::trackable {
    public:
-       virtual ~Port() { 
-               free (_port);
-       }
-
-       Sample *get_buffer (jack_nframes_t nframes) {
-               if (_flags & JackPortIsOutput) {
-                       return _buffer;
-               } else {
-                       return (Sample *) jack_port_get_buffer (_port, nframes);
-               }
-       }
+       enum Flags {
+               IsInput = JackPortIsInput,
+               IsOutput = JackPortIsOutput,
+               IsPhysical = JackPortIsPhysical,
+               IsTerminal = JackPortIsTerminal,
+               CanMonitor = JackPortCanMonitor
+       };
 
-       void reset_buffer () {
-               if (_flags & JackPortIsOutput) {
-                       _buffer = (Sample *) jack_port_get_buffer (_port, 0);
-               } else {
-                       _buffer = 0; /* catch illegal attempts to use it */
-               }
-               _silent = false;
-       }
+       virtual ~Port();
 
-       std::string name() { 
+       std::string name() const 
                return _name;
        }
 
-       std::string short_name() { 
-               return jack_port_short_name (_port);
-       }
-       
-       int set_name (std::string str);
-
-       JackPortFlags flags() const {
+       Flags flags() const {
                return _flags;
        }
 
-       bool is_mine (jack_client_t *client) { 
-               return jack_port_is_mine (client, _port);
-       }
-
-       const char* type() const {
-               return _type.c_str();
-       }
-
-       int connected () const {
-               return jack_port_connected (_port);
-       }
-       
-       bool connected_to (const std::string& portname) const {
-               return jack_port_connected_to (_port, portname.c_str());
-       }
-
-       const char ** get_connections () const {
-               return jack_port_get_connections (_port);
+       bool receives_input() const {
+               return _flags & IsInput;
        }
 
-       void reset_overs () {
-               _short_overs = 0;
-               _long_overs = 0;
-               _overlen = 0;
+       bool sends_output () const {
+               return _flags & IsOutput;
        }
 
-       void reset_peak_meter () {
-               _peak = 0;
-       }
-       
-       void reset_meters () {
-               reset_peak_meter ();
-               reset_overs ();
+       bool can_monitor () const {
+               return _flags & CanMonitor;
        }
 
        void enable_metering() {
@@ -110,103 +77,104 @@ class Port : public sigc::trackable {
                if (_metering) { _metering--; }
        }
 
-       float                       peak_db() const { return _peak_db; }
-       jack_default_audio_sample_t peak()    const { return _peak; }
+       virtual void cycle_start (nframes_t nframes, nframes_t offset) {}
+       virtual void cycle_end (nframes_t nframes, nframes_t offset) {}
+       virtual DataType type() const = 0;
+       virtual Buffer& get_buffer() = 0;
 
-       uint32_t short_overs () const { return _short_overs; }
-       uint32_t long_overs ()  const { return _long_overs; }
-       
-       static void set_short_over_length (jack_nframes_t);
-       static void set_long_over_length (jack_nframes_t);
-
-       bool receives_input() const {
-               return _flags & JackPortIsInput;
-       }
+       virtual bool connected () const;
+       virtual bool connected_to (const std::string& portname) const;
+       virtual int get_connections (std::vector<std::string>&) const;
 
-       bool sends_output () const {
-               return _flags & JackPortIsOutput;
-       }
+       virtual int connect (Port& other);
+       virtual int disconnect (Port& other);
+       virtual int disconnect_all ();
        
-       bool monitoring_input () const {
-               return jack_port_monitoring_input (_port);
-       }
+       virtual void reset ();
+       virtual int reestablish () {return 0; }
+       virtual int reconnect () { return 0; }
 
-       bool can_monitor () const {
-               return _flags & JackPortCanMonitor;
-       }
-       
-       void ensure_monitor_input (bool yn) {
-               jack_port_request_monitor (_port, yn);
-       }
-       
-       void request_monitor_input (bool yn) {
-               jack_port_request_monitor (_port, yn);
+       virtual int set_name (const std::string& str) {
+               _name = str;
+               return 0;
        }
 
-       jack_nframes_t latency () const {
-               return jack_port_get_latency (_port);
-       }
-
-       void set_latency (jack_nframes_t nframes) {
-               jack_port_set_latency (_port, nframes);
-       }
+       virtual std::string short_name() const = 0;
+       virtual bool monitoring_input () const = 0;
+       virtual void ensure_monitor_input (bool yn) = 0;
+       virtual void request_monitor_input (bool yn) = 0;
+       virtual nframes_t latency () const = 0;
+       virtual nframes_t total_latency () const = 0;
+       virtual void set_latency (nframes_t nframes) = 0;
 
        sigc::signal<void,bool> MonitorInputChanged;
        sigc::signal<void,bool> ClockSyncChanged;
 
-       bool is_silent() const { return _silent; }
-
-       /** Assumes that the port is an audio output port */
-       void silence (jack_nframes_t nframes, jack_nframes_t offset) {
-               if (!_silent) {
-                       memset (_buffer + offset, 0, sizeof (Sample) * nframes);
-                       if (offset == 0) {
-                               /* XXX this isn't really true, but i am not sure
-                                  how to set this correctly. we really just
-                                  want to set it true when the entire port
-                                  buffer has been overrwritten.
-                               */
-                               _silent = true;
-                       }
-               }
-       }
-       
-       void mark_silence (bool yn) {
-               _silent = yn;
-       }
+       static void set_engine (AudioEngine*);
 
-  private:
+  protected:
        friend class AudioEngine;
 
-       Port (jack_port_t *port);
-       void reset ();
-       
-       /* engine isn't supposed to below here */
-
-       Sample *_buffer;
-
-       /* cache these 3 from JACK so that we can
-          access them for reconnecting.
-       */
-
-       JackPortFlags _flags;
-       std::string   _type;
-       std::string   _name;
-
-       bool                         _last_monitor : 1;
-       bool                         _silent : 1;
-       jack_port_t                 *_port;
-       jack_nframes_t               _overlen;
-       jack_default_audio_sample_t  _peak;
-       float                        _peak_db;
-       uint32_t                     _short_overs;
-       uint32_t                     _long_overs;
-       unsigned short               _metering;
+       Port (const std::string& name, Flags flgs);
+
+       virtual void recompute_total_latency() const {}
        
-       static jack_nframes_t        _long_over_length;
-       static jack_nframes_t        _short_over_length;
+       /* engine isn't supposed to access below here */
+
+       Flags          _flags;
+       std::string    _type;
+       std::string    _name;
+       unsigned short _metering;
+       bool           _last_monitor;
+       nframes_t      _latency;
+
+       std::set<Port*> _connections;
+
+       static AudioEngine* engine;
+};
+
+class PortConnectableByName {
+  public:
+       PortConnectableByName() {}
+       virtual ~PortConnectableByName() {}
+
+       virtual int connect (const std::string& other_name) = 0;
+       virtual int disconnect (const std::string& other_name) = 0;
 };
  
+class PortFacade : public virtual Port, public PortConnectableByName { 
+  public:
+       PortFacade (const std::string& name, Flags flgs) : Port (name, flgs), _ext_port (0) {}
+       ~PortFacade() {}
+
+       void reset ();
+       int reestablish ();
+       int reconnect ();
+
+       int connect (Port& other);
+       int disconnect (Port& other);
+       int disconnect_all ();
+
+       int connect (const std::string& other_name);
+       int disconnect (const std::string& other_name);
+
+       bool connected () const;
+       bool connected_to (const std::string& portname) const;
+       int get_connections (std::vector<std::string>&) const;
+
+       std::string short_name() const;
+       int         set_name (const std::string& str);
+       bool        monitoring_input () const;
+       void        ensure_monitor_input (bool yn);
+       void        request_monitor_input (bool yn);
+       nframes_t   latency () const;
+       nframes_t   total_latency () const;
+       void        set_latency (nframes_t nframes);
+
+  protected:
+       Port* _ext_port;
+};
+
 } // namespace ARDOUR
 
 #endif /* __ardour_port_h__ */