Exact beat - provide audio->music mapping for region split.
[ardour.git] / libs / ardour / ardour / port.h
index 7539aac9d56ed8f594590c9d46b462954201663f..619b8ba0f2dfb729fb2e8242467c4d0454fbca63 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2009 Paul Davis 
+    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
 #ifndef __ardour_port_h__
 #define __ardour_port_h__
 
-#include "ardour/data_type.h"
-#include "ardour/types.h"
-#include <sigc++/trackable.h>
-#include <jack/jack.h>
-#include <string>
+#include "libardour-config.h"
+
 #include <set>
+#include <string>
 #include <vector>
+#include <boost/utility.hpp>
+#include "pbd/signals.h"
+
+#include "ardour/data_type.h"
+#include "ardour/port_engine.h"
+#include "ardour/libardour_visibility.h"
+#include "ardour/types.h"
 
 namespace ARDOUR {
 
 class AudioEngine;
-class Buffer;  
+class Buffer;
 
-class Port : public sigc::trackable
+class LIBARDOUR_API Port : public boost::noncopyable
 {
 public:
-       enum Flags {
-               IsInput = JackPortIsInput,
-               IsOutput = JackPortIsOutput,
-       };
-
        virtual ~Port ();
 
+       static void set_connecting_blocked( bool yn ) {
+               _connecting_blocked = yn;
+       }
+       static bool connecting_blocked() {
+               return _connecting_blocked;
+       }
+
        /** @return Port short name */
        std::string name () const {
                return _name;
        }
 
+       /** @return Port human readable name */
+       std::string pretty_name (bool fallback_to_name = false) const;
+       bool set_pretty_name (const std::string&);
+
        int set_name (std::string const &);
 
        /** @return flags */
-       Flags flags () const {
+       PortFlags flags () const {
                return _flags;
        }
 
@@ -65,11 +76,6 @@ public:
                return _flags & IsOutput;
        }
 
-       /* @return true if this port is visible outside Ardour (via JACK) */
-       bool external () const {
-               return _jack_port != 0;
-       }
-
        bool connected () const;
        int disconnect_all ();
        int get_connections (std::vector<std::string> &) const;
@@ -81,57 +87,96 @@ public:
 
        /* connection by Port* */
        bool connected_to (Port *) const;
-       int connect (Port *);
+       virtual int connect (Port *);
        int disconnect (Port *);
 
-       void ensure_monitor_input (bool);
+       void request_input_monitoring (bool);
+       void ensure_input_monitoring (bool);
        bool monitoring_input () const;
-       nframes_t total_latency () const;
        int reestablish ();
        int reconnect ();
-       void set_latency (nframes_t);
-       void request_monitor_input (bool);
-       void make_external ();
+
+       bool last_monitor() const { return _last_monitor; }
+       void set_last_monitor (bool yn) { _last_monitor = yn; }
+
+       PortEngine::PortHandle port_handle() { return _port_handle; }
+
+       void get_connected_latency_range (LatencyRange& range, bool playback) const;
+
+       void set_private_latency_range (LatencyRange& range, bool playback);
+       const LatencyRange&  private_latency_range (bool playback) const;
+
+       void set_public_latency_range (LatencyRange& range, bool playback) const;
+       LatencyRange public_latency_range (bool playback) const;
 
        virtual void reset ();
 
        virtual DataType type () const = 0;
-       virtual void cycle_start (nframes_t, nframes_t) = 0;
-       virtual void cycle_end (nframes_t, nframes_t) = 0;
-       virtual Buffer& get_buffer (nframes_t, nframes_t) = 0;
-       virtual void flush_buffers (nframes_t, nframes_t) {}
+       virtual void cycle_start (pframes_t);
+       virtual void cycle_end (pframes_t) = 0;
+       virtual void cycle_split () = 0;
+       virtual Buffer& get_buffer (pframes_t nframes) = 0;
+       virtual void flush_buffers (pframes_t /*nframes*/) {}
+       virtual void transport_stopped () {}
+       virtual void realtime_locate () {}
+
+       bool physically_connected () const;
+
+       PBD::Signal1<void,bool> MonitorInputChanged;
+       static PBD::Signal2<void,boost::shared_ptr<Port>,boost::shared_ptr<Port> > PostDisconnect;
+       static PBD::Signal0<void> PortDrop;
+       static PBD::Signal0<void> PortSignalDrop;
+
+       static void set_cycle_framecnt (pframes_t n) {
+               _cycle_nframes = n;
+       }
+       static framecnt_t port_offset() { return _global_port_buffer_offset; }
+       static void set_global_port_buffer_offset (pframes_t off) {
+               _global_port_buffer_offset = off;
+       }
+       static void increment_global_port_buffer_offset (pframes_t n) {
+               _global_port_buffer_offset += n;
+       }
+
+       virtual void increment_port_buffer_offset (pframes_t n);
 
-       static void set_engine (AudioEngine *);
+       virtual XMLNode& get_state (void) const;
+       virtual int set_state (const XMLNode&, int version);
 
-       sigc::signal<void, bool> MonitorInputChanged;
+        static std::string state_node_name;
 
 protected:
-       
-       Port (std::string const &, DataType, Flags, bool);
 
-       jack_port_t* _jack_port; ///< JACK port, or 0 if we don't have one
-       std::set<Port*> _connections; ///< internal Ports that we are connected to
+       Port (std::string const &, DataType, PortFlags);
 
-       static AudioEngine* _engine; ///< the AudioEngine
-       
-private:
-       friend class AudioEngine;
+        PortEngine::PortHandle _port_handle;
+
+       static bool       _connecting_blocked;
+       static pframes_t  _global_port_buffer_offset;   /* access only from process() tree */
+       static pframes_t  _cycle_nframes; /* access only from process() tree */
 
-       void recompute_total_latency () const;
-       void do_make_external (DataType);
-       
-       /* XXX */
-       bool _last_monitor;
-       nframes_t _latency;
+       framecnt_t _port_buffer_offset; /* access only from process() tree */
 
-       std::string _name; ///< port short name
-       Flags _flags; ///< flags
+       LatencyRange _private_playback_latency;
+       LatencyRange _private_capture_latency;
 
-       /// list of JACK ports that we are connected to; we only keep this around
-       /// so that we can implement ::reconnect ()
-       std::set<std::string> _named_connections;
+private:
+       std::string _name;  ///< port short name
+       PortFlags       _flags; ///< flags
+       bool        _last_monitor;
+
+       /** ports that we are connected to, kept so that we can
+           reconnect to the backend when required
+       */
+       std::set<std::string> _connections;
+
+       void port_connected_or_disconnected (boost::weak_ptr<Port>, boost::weak_ptr<Port>, bool);
+       void signal_drop ();
+       void drop ();
+       PBD::ScopedConnection drop_connection;
+       PBD::ScopedConnection engine_connection;
 };
 
 }
 
-#endif
+#endif /* __ardour_port_h__ */