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__
26 #include <sigc++/signal.h>
27 #include <jack/jack.h>
29 #include <glibmm/thread.h>
31 #include <pbd/fastlog.h>
33 #include <pbd/statefuldestructible.h>
34 #include <pbd/controllable.h>
36 #include <ardour/ardour.h>
37 #include <ardour/automatable_controls.h>
38 #include <ardour/automation_control.h>
39 #include <ardour/bundle.h>
40 #include <ardour/chan_count.h>
41 #include <ardour/data_type.h>
42 #include <ardour/latent.h>
43 #include <ardour/port_set.h>
44 #include <ardour/session_object.h>
45 #include <ardour/types.h>
46 #include <ardour/utils.h>
66 /** A collection of input and output ports with connections.
68 * An IO can contain ports of varying types, making routes/inserts/etc with
69 * varied combinations of types (eg MIDI and audio) possible.
72 class IO : public SessionObject, public AutomatableControls, public Latent
75 static const string state_node_name;
77 IO (Session&, const string& name,
78 int input_min = -1, int input_max = -1,
79 int output_min = -1, int output_max = -1,
80 DataType default_type = DataType::AUDIO);
82 IO (Session&, const XMLNode&, DataType default_type = DataType::AUDIO);
86 ChanCount input_minimum() const { return _input_minimum; }
87 ChanCount input_maximum() const { return _input_maximum; }
88 ChanCount output_minimum() const { return _output_minimum; }
89 ChanCount output_maximum() const { return _output_maximum; }
91 void set_input_minimum (ChanCount n);
92 void set_input_maximum (ChanCount n);
93 void set_output_minimum (ChanCount n);
94 void set_output_maximum (ChanCount n);
96 bool active() const { return _active; }
97 void set_active (bool yn);
99 DataType default_type() const { return _default_type; }
100 void set_default_type(DataType t) { _default_type = t; }
102 bool set_name (const string& str);
104 virtual void silence (nframes_t, nframes_t offset);
106 void collect_input (BufferSet& bufs, nframes_t nframes, nframes_t offset);
107 void deliver_output (BufferSet& bufs, nframes_t start_frame, nframes_t end_frame,
108 nframes_t nframes, nframes_t offset);
109 void just_meter_input (nframes_t start_frame, nframes_t end_frame,
110 nframes_t nframes, nframes_t offset);
112 BufferSet& output_buffers() { return *_output_buffers; }
114 gain_t gain () const { return _desired_gain; }
115 virtual gain_t effective_gain () const;
117 void set_denormal_protection (bool yn, void *src);
118 bool denormal_protection() const { return _denormal_protection; }
120 void set_phase_invert (bool yn, void *src);
121 bool phase_invert() const { return _phase_invert; }
123 Panner& panner() { return *_panner; }
124 PeakMeter& peak_meter() { return *_meter; }
125 const Panner& panner() const { return *_panner; }
126 void reset_panner ();
128 int ensure_io (ChanCount in, ChanCount out, bool clear, void *src);
130 int connect_input_ports_to_bundle (boost::shared_ptr<Bundle>, void *);
131 int disconnect_input_ports_from_bundle (boost::shared_ptr<Bundle>, void *);
132 int connect_output_ports_to_bundle (boost::shared_ptr<Bundle>, void *);
133 int disconnect_output_ports_from_bundle (boost::shared_ptr<Bundle>, void *);
135 BundleList bundles_connected_to_inputs ();
136 BundleList bundles_connected_to_outputs ();
138 boost::shared_ptr<Bundle> bundle_for_inputs () { return _bundle_for_inputs; }
139 boost::shared_ptr<Bundle> bundle_for_outputs () { return _bundle_for_outputs; }
141 int add_input_port (string source, void *src, DataType type = DataType::NIL);
142 int add_output_port (string destination, void *src, DataType type = DataType::NIL);
144 int remove_input_port (Port *, void *src);
145 int remove_output_port (Port *, void *src);
147 int set_input (Port *, void *src);
149 int connect_input (Port *our_port, string other_port, void *src);
150 int connect_output (Port *our_port, string other_port, void *src);
152 int disconnect_input (Port *our_port, string other_port, void *src);
153 int disconnect_output (Port *our_port, string other_port, void *src);
155 int disconnect_inputs (void *src);
156 int disconnect_outputs (void *src);
158 nframes_t signal_latency() const { return _own_latency; }
159 nframes_t output_latency() const;
160 nframes_t input_latency() const;
161 void set_port_latency (nframes_t);
163 void update_port_total_latencies ();
165 const PortSet& inputs() const { return _inputs; }
166 const PortSet& outputs() const { return _outputs; }
168 Port *output (uint32_t n) const {
169 if (n < _outputs.num_ports()) {
170 return _outputs.port(n);
176 Port *input (uint32_t n) const {
177 if (n < _inputs.num_ports()) {
178 return _inputs.port(n);
184 AudioPort* audio_input(uint32_t n) const;
185 AudioPort* audio_output(uint32_t n) const;
186 MidiPort* midi_input(uint32_t n) const;
187 MidiPort* midi_output(uint32_t n) const;
189 const ChanCount& n_inputs () const { return _inputs.count(); }
190 const ChanCount& n_outputs () const { return _outputs.count(); }
192 void attach_buffers(ChanCount ignored);
194 sigc::signal<void> active_changed;
196 sigc::signal<void,IOChange,void*> input_changed;
197 sigc::signal<void,IOChange,void*> output_changed;
199 virtual XMLNode& state (bool full);
200 XMLNode& get_state (void);
201 int set_state (const XMLNode&);
203 static int disable_connecting (void);
204 static int enable_connecting (void);
205 static int disable_ports (void);
206 static int enable_ports (void);
207 static int disable_panners (void);
208 static int reset_panners (void);
210 static sigc::signal<int> PortsLegal;
211 static sigc::signal<int> PannersLegal;
212 static sigc::signal<int> ConnectingLegal;
213 /// raised when the number of input or output ports changes
214 static sigc::signal<void,ChanCount> PortCountChanged;
215 static sigc::signal<int> PortsCreated;
217 static void update_meters();
221 static sigc::signal<void> Meter;
222 static Glib::StaticMutex m_meter_signal_lock;
223 sigc::connection m_meter_connection;
229 struct GainControl : public AutomationControl {
230 GainControl (std::string name, IO* i, const Evoral::Parameter ¶m,
231 boost::shared_ptr<AutomationList> al = boost::shared_ptr<AutomationList>() )
232 : AutomationControl (i->_session, param, al, name )
236 void set_value (float val);
237 float get_value (void) const;
242 boost::shared_ptr<GainControl> gain_control() {
243 return _gain_control;
245 boost::shared_ptr<const GainControl> gain_control() const {
246 return _gain_control;
249 void clear_automation ();
251 void set_parameter_automation_state (Evoral::Parameter, AutoState);
253 virtual void transport_stopped (nframes_t now);
254 virtual void automation_snapshot (nframes_t now, bool force);
256 void start_pan_touch (uint32_t which);
257 void end_pan_touch (uint32_t which);
259 void defer_pan_reset ();
260 void allow_pan_reset ();
262 /* the session calls this for master outs before
263 anyone else. controls outs too, at some point.
266 XMLNode *pending_state_node;
267 int ports_became_legal ();
270 mutable Glib::Mutex io_lock;
274 BufferSet* _output_buffers; //< Set directly to output port buffers
277 gain_t _effective_gain;
278 gain_t _desired_gain;
279 Glib::Mutex declick_lock;
283 bool no_panner_reset;
285 bool _denormal_protection;
286 XMLNode* deferred_state;
287 DataType _default_type;
289 virtual void prepare_inputs (nframes_t nframes, nframes_t offset);
290 virtual void flush_outputs (nframes_t nframes, nframes_t offset);
292 virtual void set_deferred_state() {}
294 virtual uint32_t pans_required() const
295 { return _inputs.count().n_audio(); }
297 boost::shared_ptr<GainControl> _gain_control;
299 virtual void set_gain (gain_t g, void *src);
300 void inc_gain (gain_t delta, void *src);
302 bool apply_gain_automation;
304 virtual int load_automation (std::string path);
306 /* AudioTrack::deprecated_use_diskstream_connections() needs these */
308 int set_inputs (const string& str);
309 int set_outputs (const string& str);
311 static bool connecting_legal;
312 static bool ports_legal;
315 static bool panners_legal;
317 void copy_to_outputs (BufferSet& bufs, DataType type, nframes_t nframes, nframes_t offset);
319 int connecting_became_legal ();
320 int panners_became_legal ();
321 sigc::connection connection_legal_c;
322 sigc::connection port_legal_c;
323 sigc::connection panner_legal_c;
325 ChanCount _input_minimum; ///< minimum number of input channels (0 for no minimum)
326 ChanCount _input_maximum; ///< maximum number of input channels (ChanCount::INFINITE for no maximum)
327 ChanCount _output_minimum; ///< minimum number of output channels (0 for no minimum)
328 ChanCount _output_maximum; ///< maximum number of output channels (ChanCount::INFINITE for no maximum)
330 boost::shared_ptr<Bundle> _bundle_for_inputs; ///< a bundle representing our inputs
331 boost::shared_ptr<Bundle> _bundle_for_outputs; ///< a bundle representing our outputs
333 struct UserBundleInfo {
334 UserBundleInfo (IO*, boost::shared_ptr<UserBundle> b);
336 boost::shared_ptr<UserBundle> bundle;
337 sigc::connection changed;
340 std::vector<UserBundleInfo> _bundles_connected_to_outputs; ///< user bundles connected to our outputs
341 std::vector<UserBundleInfo> _bundles_connected_to_inputs; ///< user bundles connected to our inputs
343 static int parse_io_string (const string&, vector<string>& chns);
345 static int parse_gain_string (const string&, vector<string>& chns);
347 int set_sources (vector<string>&, void *src, bool add);
348 int set_destinations (vector<string>&, void *src, bool add);
350 int ensure_inputs (ChanCount, bool clear, bool lockit, void *src);
351 int ensure_outputs (ChanCount, bool clear, bool lockit, void *src);
353 void check_bundles_connected_to_inputs ();
354 void check_bundles_connected_to_outputs ();
355 void check_bundles (std::vector<UserBundleInfo>&, const PortSet&);
357 void bundle_changed (Bundle::Change);
359 int create_ports (const XMLNode&);
360 int make_connections (const XMLNode&);
361 boost::shared_ptr<Bundle> find_possible_bundle (const string &desired_name, const string &default_name, const string &connection_type_name);
363 void setup_peak_meters ();
366 bool ensure_inputs_locked (ChanCount, bool clear, void *src);
367 bool ensure_outputs_locked (ChanCount, bool clear, void *src);
369 std::string build_legal_port_name (DataType type, bool for_input);
370 int32_t find_input_port_hole (const char* base);
371 int32_t find_output_port_hole (const char* base);
373 void setup_bundles_for_inputs_and_outputs ();
374 void setup_bundle_for_inputs ();
375 void setup_bundle_for_outputs ();
376 std::string bundle_channel_name (uint32_t, uint32_t) const;
379 } // namespace ARDOUR
381 #endif /*__ardour_io_h__ */