2 Copyright (C) 2009 Paul Davis
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.
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.
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.
20 #ifndef __ardour_port_h__
21 #define __ardour_port_h__
26 #include <jack/jack.h>
27 #include <boost/utility.hpp>
28 #include "pbd/signals.h"
30 #include "ardour/data_type.h"
31 #include "ardour/types.h"
38 class Port : public boost::noncopyable
42 IsInput = JackPortIsInput,
43 IsOutput = JackPortIsOutput,
48 static nframes_t port_offset() { return _port_offset; }
50 static void set_port_offset (nframes_t off) {
53 static void increment_port_offset (nframes_t n) {
56 static void set_buffer_size (nframes_t sz) {
60 /** @return Port short name */
61 std::string name () const {
65 int set_name (std::string const &);
68 Flags flags () const {
72 /** @return true if this Port receives input, otherwise false */
73 bool receives_input () const {
74 return _flags & IsInput;
77 /** @return true if this Port sends output, otherwise false */
78 bool sends_output () const {
79 return _flags & IsOutput;
82 bool connected () const;
83 int disconnect_all ();
84 int get_connections (std::vector<std::string> &) const;
86 /* connection by name */
87 bool connected_to (std::string const &) const;
88 int connect (std::string const &);
89 int disconnect (std::string const &);
91 /* connection by Port* */
92 bool connected_to (Port *) const;
93 virtual int connect (Port *);
94 int disconnect (Port *);
96 void ensure_monitor_input (bool);
97 bool monitoring_input () const;
98 nframes_t total_latency () const;
101 void request_monitor_input (bool);
102 void set_latency (nframes_t);
104 virtual void reset ();
106 /** @return the size of the raw buffer (bytes) for duration @a nframes (audio frames) */
107 virtual size_t raw_buffer_size(jack_nframes_t nframes) const = 0;
109 virtual DataType type () const = 0;
110 virtual void cycle_start (nframes_t) = 0;
111 virtual void cycle_end (nframes_t) = 0;
112 virtual void cycle_split () = 0;
113 virtual Buffer& get_buffer (nframes_t nframes, nframes_t offset = 0) = 0;
114 virtual void flush_buffers (nframes_t nframes, nframes64_t /*time*/, nframes_t offset = 0) {
115 assert(offset < nframes);
117 virtual void transport_stopped () {}
119 static void set_engine (AudioEngine *);
121 PBD::Signal1<void,bool> MonitorInputChanged;
125 Port (std::string const &, DataType, Flags);
127 jack_port_t* _jack_port; ///< JACK port
129 static nframes_t _port_offset;
130 static nframes_t _buffer_size;
132 static AudioEngine* _engine; ///< the AudioEngine
135 friend class AudioEngine;
137 void recompute_total_latency () const;
142 std::string _name; ///< port short name
143 Flags _flags; ///< flags
145 /** ports that we are connected to, kept so that we can
146 reconnect to JACK when required */
147 std::set<std::string> _connections;
152 #endif /* __ardour_port_h__ */