2 Copyright (C) 2000 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_io_h__
21 #define __ardour_io_h__
27 #include <glibmm/threads.h>
29 #include "pbd/fastlog.h"
31 #include "pbd/statefuldestructible.h"
32 #include "pbd/controllable.h"
33 #include "pbd/enum_convert.h"
35 #include "ardour/ardour.h"
36 #include "ardour/automation_control.h"
37 #include "ardour/bundle.h"
38 #include "ardour/chan_count.h"
39 #include "ardour/data_type.h"
40 #include "ardour/latent.h"
41 #include "ardour/port_set.h"
42 #include "ardour/session_object.h"
43 #include "ardour/libardour_visibility.h"
44 #include "ardour/types.h"
45 #include "ardour/utils.h"
46 #include "ardour/buffer_set.h"
63 /** A collection of ports (all input or all output) with connections.
65 * An IO can contain ports of varying types, making routes/inserts/etc with
66 * varied combinations of types (eg MIDI and audio) possible.
68 class LIBARDOUR_API IO : public SessionObject, public Latent
71 static const std::string state_node_name;
78 IO (Session&, const std::string& name, Direction, DataType default_type = DataType::AUDIO, bool sendish = false);
79 IO (Session&, const XMLNode&, DataType default_type = DataType::AUDIO, bool sendish = false);
83 Direction direction() const { return _direction; }
85 DataType default_type() const { return _default_type; }
86 void set_default_type(DataType t) { _default_type = t; }
88 bool active() const { return _active; }
89 void set_active(bool yn) { _active = yn; }
91 bool set_name (const std::string& str);
92 void set_pretty_name (const std::string& str);
93 std::string pretty_name () const { return _pretty_name_prefix; }
95 virtual void silence (samplecnt_t);
96 void increment_port_buffer_offset (pframes_t offset);
98 int ensure_io (ChanCount cnt, bool clear, void *src);
100 int connect_ports_to_bundle (boost::shared_ptr<Bundle>, bool exclusive, void *);
101 int connect_ports_to_bundle (boost::shared_ptr<Bundle>, bool, bool, void *);
102 int disconnect_ports_from_bundle (boost::shared_ptr<Bundle>, void *);
104 BundleList bundles_connected ();
106 boost::shared_ptr<Bundle> bundle () { return _bundle; }
108 int add_port (std::string connection, void *src, DataType type = DataType::NIL);
109 int remove_port (boost::shared_ptr<Port>, void *src);
110 int connect (boost::shared_ptr<Port> our_port, std::string other_port, void *src);
111 int disconnect (boost::shared_ptr<Port> our_port, std::string other_port, void *src);
112 int disconnect (void *src);
113 bool connected_to (boost::shared_ptr<const IO>) const;
114 bool connected_to (const std::string&) const;
115 bool connected () const;
116 bool physically_connected () const;
118 samplecnt_t signal_latency () const { return 0; }
120 samplecnt_t latency () const;
121 samplecnt_t public_latency () const;
122 samplecnt_t connected_latency (bool for_playback) const;
124 PortSet& ports() { return _ports; }
125 const PortSet& ports() const { return _ports; }
127 bool has_port (boost::shared_ptr<Port>) const;
129 boost::shared_ptr<Port> nth (uint32_t n) const {
130 if (n < _ports.num_ports()) {
131 return _ports.port(n);
133 return boost::shared_ptr<Port> ();
137 boost::shared_ptr<Port> port_by_name (const std::string& str) const;
139 boost::shared_ptr<AudioPort> audio(uint32_t n) const;
140 boost::shared_ptr<MidiPort> midi(uint32_t n) const;
142 const ChanCount& n_ports () const { return _ports.count(); }
144 /* The process lock will be held on emission of this signal if
145 * IOChange contains ConfigurationChanged. In other cases,
146 * the process lock status is undefined.
148 PBD::Signal2<void, IOChange, void *> changed;
150 virtual XMLNode& state (bool full);
151 XMLNode& get_state (void);
152 int set_state (const XMLNode&, int version);
153 int set_state_2X (const XMLNode&, int, bool);
154 static void prepare_for_reset (XMLNode&, const std::string&);
159 typedef bool result_type;
161 template <typename Iter>
162 result_type operator() (Iter first, Iter last) const {
164 while (first != last) {
175 /** Emitted when the port count is about to change. Objects
176 * can attach to this, and return `true' if they want to prevent
177 * the change from happening.
179 PBD::Signal1<bool, ChanCount, BoolCombiner> PortCountChanging;
181 static int disable_connecting ();
182 static int enable_connecting ();
184 static PBD::Signal1<void, ChanCount> PortCountChanged; // emitted when the number of ports changes
186 static std::string name_from_state (const XMLNode&);
187 static void set_name_in_state (XMLNode&, const std::string&);
189 /* we have to defer/order port connection. this is how we do it.
192 static PBD::Signal0<int> ConnectingLegal;
193 static bool connecting_legal;
195 XMLNode *pending_state_node;
196 int pending_state_node_version;
197 bool pending_state_node_in;
199 /* three utility functions - this just seems to be simplest place to put them */
201 void collect_input (BufferSet& bufs, pframes_t nframes, ChanCount offset);
202 void process_input (boost::shared_ptr<Processor>, samplepos_t start_sample, samplepos_t end_sample, double speed, pframes_t nframes);
203 void copy_to_outputs (BufferSet& bufs, DataType type, pframes_t nframes, samplecnt_t offset);
205 /* AudioTrack::deprecated_use_diskstream_connections() needs these */
207 int set_ports (const std::string& str);
210 mutable Glib::Threads::Mutex io_lock;
214 Direction _direction;
215 DataType _default_type;
220 int connecting_became_legal ();
221 PBD::ScopedConnection connection_legal_c;
223 boost::shared_ptr<Bundle> _bundle; ///< a bundle representing our ports
225 struct UserBundleInfo {
226 UserBundleInfo (IO*, boost::shared_ptr<UserBundle> b);
227 boost::shared_ptr<UserBundle> bundle;
228 PBD::ScopedConnection changed;
231 static int parse_io_string (const std::string&, std::vector<std::string>& chns);
232 static int parse_gain_string (const std::string&, std::vector<std::string>& chns);
234 int ensure_ports (ChanCount, bool clear, void *src);
236 void bundle_changed (Bundle::Change);
238 int get_port_counts (const XMLNode& node, int version, ChanCount& n, boost::shared_ptr<Bundle>& c);
239 int get_port_counts_2X (const XMLNode& node, int version, ChanCount& n, boost::shared_ptr<Bundle>& c);
240 int create_ports (const XMLNode&, int version);
241 int make_connections (const XMLNode&, int, bool);
242 int make_connections_2X (const XMLNode &, int, bool);
244 boost::shared_ptr<Bundle> find_possible_bundle (const std::string &desired_name);
246 int ensure_ports_locked (ChanCount, bool clear, bool& changed);
248 std::string build_legal_port_name (DataType type);
249 int32_t find_port_hole (const char* base);
251 void setup_bundle ();
252 std::string bundle_channel_name (uint32_t, uint32_t, DataType) const;
254 void apply_pretty_name ();
255 std::string _pretty_name_prefix;
257 void disconnect_check (boost::shared_ptr<ARDOUR::Port>, boost::shared_ptr<ARDOUR::Port>);
260 } // namespace ARDOUR
263 DEFINE_ENUM_CONVERT (ARDOUR::IO::Direction)
266 #endif /*__ardour_io_h__ */