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 <sigc++/trackable.h>
29 #include "ardour/data_type.h"
30 #include "ardour/types.h"
37 class Port : public sigc::trackable, public boost::noncopyable
41 IsInput = JackPortIsInput,
42 IsOutput = JackPortIsOutput,
47 static nframes_t port_offset() { return _port_offset; }
49 static void set_port_offset (nframes_t off) {
52 static void increment_port_offset (nframes_t n) {
55 static void set_buffer_size (nframes_t sz) {
59 /** @return Port short name */
60 std::string name () const {
64 int set_name (std::string const &);
67 Flags flags () const {
71 /** @return true if this Port receives input, otherwise false */
72 bool receives_input () const {
73 return _flags & IsInput;
76 /** @return true if this Port sends output, otherwise false */
77 bool sends_output () const {
78 return _flags & IsOutput;
81 bool connected () const;
82 int disconnect_all ();
83 int get_connections (std::vector<std::string> &) const;
85 /* connection by name */
86 bool connected_to (std::string const &) const;
87 int connect (std::string const &);
88 int disconnect (std::string const &);
90 /* connection by Port* */
91 bool connected_to (Port *) const;
92 virtual int connect (Port *);
93 int disconnect (Port *);
95 void ensure_monitor_input (bool);
96 bool monitoring_input () const;
97 nframes_t total_latency () const;
100 void request_monitor_input (bool);
101 void set_latency (nframes_t);
103 virtual void reset ();
105 /** @return the size of the raw buffer (bytes) for duration @a nframes (audio frames) */
106 virtual size_t raw_buffer_size(jack_nframes_t nframes) const = 0;
108 virtual DataType type () const = 0;
109 virtual void cycle_start (nframes_t) = 0;
110 virtual void cycle_end (nframes_t) = 0;
111 virtual void cycle_split () = 0;
112 virtual Buffer& get_buffer (nframes_t nframes, nframes_t offset = 0) = 0;
113 virtual void flush_buffers (nframes_t nframes, nframes64_t /*time*/, nframes_t offset = 0) {
114 assert(offset < nframes);
116 virtual void transport_stopped () {}
118 static void set_engine (AudioEngine *);
120 sigc::signal<void, bool> MonitorInputChanged;
124 Port (std::string const &, DataType, Flags);
126 jack_port_t* _jack_port; ///< JACK port
128 static nframes_t _port_offset;
129 static nframes_t _buffer_size;
131 static AudioEngine* _engine; ///< the AudioEngine
134 friend class AudioEngine;
136 void recompute_total_latency () const;
141 std::string _name; ///< port short name
142 Flags _flags; ///< flags
144 /** ports that we are connected to, kept so that we can
145 reconnect to JACK when required */
146 std::set<std::string> _connections;
151 #endif /* __ardour_port_h__ */