libs/ardour/ardour/port.h

   1 /*
   2     Copyright (C) 2009 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #ifndef __ardour_port_h__
  21 #define __ardour_port_h__
  22
  23 #include "libardour-config.h"
  24
  25 #include <set>
  26 #include <string>
  27 #include <vector>
  28 #include <jack/jack.h>
  29 #include <boost/utility.hpp>
  30 #include "pbd/signals.h"
  31
  32 #include "ardour/data_type.h"
  33 #include "ardour/port_engine.h"
  34 #include "ardour/libardour_visibility.h"
  35 #include "ardour/types.h"
  36
  37 namespace ARDOUR {
  38
  39 class AudioEngine;
  40 class Buffer;
  41
  42 class LIBARDOUR_API Port : public boost::noncopyable
  43 {
  44 public:
  45         virtual ~Port ();
  46
  47         static void set_connecting_blocked( bool yn ) {
  48                 _connecting_blocked = yn;
  49         }
  50         static bool connecting_blocked() {
  51                 return _connecting_blocked;
  52         }
  53
  54         /** @return Port short name */
  55         std::string name () const {
  56                 return _name;
  57         }
  58
  59         int set_name (std::string const &);
  60
  61         /** @return flags */
  62         PortFlags flags () const {
  63                 return _flags;
  64         }
  65
  66         /** @return true if this Port receives input, otherwise false */
  67         bool receives_input () const {
  68                 return _flags & IsInput;
  69         }
  70
  71         /** @return true if this Port sends output, otherwise false */
  72         bool sends_output () const {
  73                 return _flags & IsOutput;
  74         }
  75
  76         bool connected () const;
  77         int disconnect_all ();
  78         int get_connections (std::vector<std::string> &) const;
  79
  80         /* connection by name */
  81         bool connected_to (std::string const &) const;
  82         int connect (std::string const &);
  83         int disconnect (std::string const &);
  84
  85         /* connection by Port* */
  86         bool connected_to (Port *) const;
  87         virtual int connect (Port *);
  88         int disconnect (Port *);
  89
  90         void request_input_monitoring (bool);
  91         void ensure_input_monitoring (bool);
  92         bool monitoring_input () const;
  93         int reestablish ();
  94         int reconnect ();
  95
  96         bool last_monitor() const { return _last_monitor; }
  97         void set_last_monitor (bool yn) { _last_monitor = yn; }
  98
  99         PortEngine::PortHandle port_handle() { return _port_handle; }
 100
 101         void get_connected_latency_range (LatencyRange& range, bool playback) const;
 102
 103         void set_private_latency_range (LatencyRange& range, bool playback);
 104         const LatencyRange&  private_latency_range (bool playback) const;
 105
 106         void set_public_latency_range (LatencyRange& range, bool playback) const;
 107         LatencyRange public_latency_range (bool playback) const;
 108
 109         virtual void reset ();
 110
 111         virtual DataType type () const = 0;
 112         virtual void cycle_start (pframes_t);
 113         virtual void cycle_end (pframes_t) = 0;
 114         virtual void cycle_split () = 0;
 115         virtual Buffer& get_buffer (pframes_t nframes) = 0;
 116         virtual void flush_buffers (pframes_t /*nframes*/) {}
 117         virtual void transport_stopped () {}
 118         virtual void realtime_locate () {}
 119
 120         bool physically_connected () const;
 121
 122         PBD::Signal1<void,bool> MonitorInputChanged;
 123         static PBD::Signal2<void,boost::shared_ptr<Port>,boost::shared_ptr<Port> > PostDisconnect;
 124         static PBD::Signal0<void> PortDrop;
 125
 126         static void set_cycle_framecnt (pframes_t n) {
 127                 _cycle_nframes = n;
 128         }
 129         static framecnt_t port_offset() { return _global_port_buffer_offset; }
 130         static void set_global_port_buffer_offset (pframes_t off) {
 131                 _global_port_buffer_offset = off;
 132         }
 133         static void increment_global_port_buffer_offset (pframes_t n) {
 134                 _global_port_buffer_offset += n;
 135         }
 136
 137         virtual void increment_port_buffer_offset (pframes_t n);
 138
 139         virtual XMLNode& get_state (void) const;
 140         virtual int set_state (const XMLNode&, int version);
 141
 142         static std::string state_node_name;
 143
 144 protected:
 145
 146         Port (std::string const &, DataType, PortFlags);
 147
 148         PortEngine::PortHandle _port_handle;
 149
 150         static bool       _connecting_blocked;
 151         static pframes_t  _global_port_buffer_offset;   /* access only from process() tree */
 152         static pframes_t  _cycle_nframes; /* access only from process() tree */
 153
 154         framecnt_t _port_buffer_offset; /* access only from process() tree */
 155
 156         LatencyRange _private_playback_latency;
 157         LatencyRange _private_capture_latency;
 158
 159 private:
 160         std::string _name;  ///< port short name
 161         PortFlags       _flags; ///< flags
 162         bool        _last_monitor;
 163
 164         /** ports that we are connected to, kept so that we can
 165             reconnect to the backend when required
 166         */
 167         std::set<std::string> _connections;
 168
 169        void drop ();
 170        PBD::ScopedConnection drop_connection;
 171 };
 172
 173 }
 174
 175 #endif /* __ardour_port_h__ */