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.h>
38 #include <ardour/utils.h>
39 #include <ardour/types.h>
40 #include <ardour/data_type.h>
41 #include <ardour/port_set.h>
42 #include <ardour/chan_count.h>
43 #include <ardour/latent.h>
44 #include <ardour/automation_control.h>
45 #include <ardour/user_bundle.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,
81 bool public_ports = true);
83 IO (Session&, const XMLNode&, DataType default_type = DataType::AUDIO);
87 ChanCount input_minimum() const { return _input_minimum; }
88 ChanCount input_maximum() const { return _input_maximum; }
89 ChanCount output_minimum() const { return _output_minimum; }
90 ChanCount output_maximum() const { return _output_maximum; }
92 void set_input_minimum (ChanCount n);
93 void set_input_maximum (ChanCount n);
94 void set_output_minimum (ChanCount n);
95 void set_output_maximum (ChanCount n);
97 bool active() const { return _active; }
98 void set_active (bool yn);
100 DataType default_type() const { return _default_type; }
101 void set_default_type(DataType t) { _default_type = t; }
103 bool set_name (const string& str);
105 virtual void silence (nframes_t, nframes_t offset);
107 void collect_input (BufferSet& bufs, nframes_t nframes, nframes_t offset);
108 void deliver_output (BufferSet& bufs, nframes_t start_frame, nframes_t end_frame,
109 nframes_t nframes, nframes_t offset);
110 void just_meter_input (nframes_t start_frame, nframes_t end_frame,
111 nframes_t nframes, nframes_t offset);
113 gain_t gain () const { return _desired_gain; }
114 virtual gain_t effective_gain () const;
116 void set_denormal_protection (bool yn, void *src);
117 bool denormal_protection() const { return _denormal_protection; }
119 void set_phase_invert (bool yn, void *src);
120 bool phase_invert() const { return _phase_invert; }
122 Panner& panner() { return *_panner; }
123 PeakMeter& peak_meter() { return *_meter; }
124 const Panner& panner() const { return *_panner; }
126 int ensure_io (ChanCount in, ChanCount out, bool clear, void *src);
128 int connect_input_ports_to_bundle (boost::shared_ptr<Bundle>, void *src);
129 int connect_output_ports_to_bundle (boost::shared_ptr<Bundle>, void *src);
131 std::vector<boost::shared_ptr<Bundle> > bundles_connected_to_inputs ();
132 std::vector<boost::shared_ptr<Bundle> > bundles_connected_to_outputs ();
134 boost::shared_ptr<AutoBundle> bundle_for_inputs () { return _bundle_for_inputs; }
135 boost::shared_ptr<AutoBundle> bundle_for_outputs () { return _bundle_for_outputs; }
137 int add_input_port (string source, void *src, DataType type = DataType::NIL);
138 int add_output_port (string destination, void *src, DataType type = DataType::NIL);
140 int remove_input_port (Port *, void *src);
141 int remove_output_port (Port *, void *src);
143 int set_input (Port *, void *src);
145 int connect_input (Port *our_port, string other_port, void *src);
146 int connect_output (Port *our_port, string other_port, void *src);
148 int disconnect_input (Port *our_port, string other_port, void *src);
149 int disconnect_output (Port *our_port, string other_port, void *src);
151 int disconnect_inputs (void *src);
152 int disconnect_outputs (void *src);
154 nframes_t signal_latency() const { return _own_latency; }
155 nframes_t output_latency() const;
156 nframes_t input_latency() const;
157 void set_port_latency (nframes_t);
159 void update_port_total_latencies ();
161 const PortSet& inputs() const { return _inputs; }
162 const PortSet& outputs() const { return _outputs; }
164 Port *output (uint32_t n) const {
165 if (n < _outputs.num_ports()) {
166 return _outputs.port(n);
172 Port *input (uint32_t n) const {
173 if (n < _inputs.num_ports()) {
174 return _inputs.port(n);
180 AudioPort* audio_input(uint32_t n) const;
181 AudioPort* audio_output(uint32_t n) const;
182 MidiPort* midi_input(uint32_t n) const;
183 MidiPort* midi_output(uint32_t n) const;
185 const ChanCount& n_inputs () const { return _inputs.count(); }
186 const ChanCount& n_outputs () const { return _outputs.count(); }
188 void attach_buffers(ChanCount ignored);
190 sigc::signal<void> active_changed;
192 sigc::signal<void,IOChange,void*> input_changed;
193 sigc::signal<void,IOChange,void*> output_changed;
195 virtual XMLNode& state (bool full);
196 XMLNode& get_state (void);
197 int set_state (const XMLNode&);
199 static int disable_connecting (void);
201 static int enable_connecting (void);
203 static int disable_ports (void);
205 static int enable_ports (void);
207 static int disable_panners (void);
209 static int reset_panners (void);
211 static sigc::signal<int> PortsLegal;
212 static sigc::signal<int> PannersLegal;
213 static sigc::signal<int> ConnectingLegal;
214 /// raised when the number of input or output ports changes
215 static sigc::signal<void,ChanCount> PortCountChanged;
216 static sigc::signal<int> PortsCreated;
218 static void update_meters();
222 static sigc::signal<void> Meter;
223 static Glib::StaticMutex m_meter_signal_lock;
224 sigc::connection m_meter_connection;
230 struct GainControl : public AutomationControl {
231 GainControl (std::string name, IO* i, const Evoral::Parameter ¶m,
232 boost::shared_ptr<AutomationList> al = boost::shared_ptr<AutomationList>() )
233 : AutomationControl (i->_session, param, al, name )
237 void set_value (float val);
238 float get_value (void) const;
243 boost::shared_ptr<GainControl> gain_control() {
244 return _gain_control;
246 boost::shared_ptr<const GainControl> gain_control() const {
247 return _gain_control;
250 void clear_automation ();
252 void set_parameter_automation_state (Evoral::Parameter, AutoState);
254 virtual void transport_stopped (nframes_t now);
255 virtual void automation_snapshot (nframes_t now, bool force);
257 void start_pan_touch (uint32_t which);
258 void end_pan_touch (uint32_t which);
260 void defer_pan_reset ();
261 void allow_pan_reset ();
263 /* the session calls this for master outs before
264 anyone else. controls outs too, at some point.
267 XMLNode *pending_state_node;
268 int ports_became_legal ();
271 mutable Glib::Mutex io_lock;
275 BufferSet* _output_buffers; //< Set directly to output port buffers
278 gain_t _effective_gain;
279 gain_t _desired_gain;
280 Glib::Mutex declick_lock;
284 bool no_panner_reset;
286 bool _denormal_protection;
287 XMLNode* deferred_state;
288 DataType _default_type;
291 virtual void prepare_inputs (nframes_t nframes, nframes_t offset);
293 virtual void set_deferred_state() {}
295 void reset_panner ();
297 virtual uint32_t pans_required() const
298 { return _inputs.count().n_audio(); }
300 boost::shared_ptr<GainControl> _gain_control;
302 virtual void set_gain (gain_t g, void *src);
303 void inc_gain (gain_t delta, void *src);
305 bool apply_gain_automation;
307 virtual int load_automation (std::string path);
309 /* AudioTrack::deprecated_use_diskstream_connections() needs these */
311 int set_inputs (const string& str);
312 int set_outputs (const string& str);
314 static bool connecting_legal;
315 static bool ports_legal;
317 BufferSet& output_buffers() { return *_output_buffers; }
323 static bool panners_legal;
325 int connecting_became_legal ();
326 int panners_became_legal ();
327 sigc::connection connection_legal_c;
328 sigc::connection port_legal_c;
329 sigc::connection panner_legal_c;
331 ChanCount _input_minimum; ///< minimum number of input channels (0 for no minimum)
332 ChanCount _input_maximum; ///< maximum number of input channels (ChanCount::INFINITE for no maximum)
333 ChanCount _output_minimum; ///< minimum number of output channels (0 for no minimum)
334 ChanCount _output_maximum; ///< maximum number of output channels (ChanCount::INFINITE for no maximum)
336 boost::shared_ptr<AutoBundle> _bundle_for_inputs; ///< a bundle representing our inputs
337 boost::shared_ptr<AutoBundle> _bundle_for_outputs; ///< a bundle representing our outputs
339 struct UserBundleInfo {
340 UserBundleInfo (IO*, boost::shared_ptr<UserBundle> b);
342 boost::shared_ptr<UserBundle> bundle;
343 sigc::connection configuration_will_change;
344 sigc::connection configuration_has_changed;
345 sigc::connection ports_will_change;
346 sigc::connection ports_have_changed;
349 std::vector<UserBundleInfo> _bundles_connected_to_outputs; ///< user bundles connected to our outputs
350 std::vector<UserBundleInfo> _bundles_connected_to_inputs; ///< user bundles connected to our inputs
352 static int parse_io_string (const string&, vector<string>& chns);
354 static int parse_gain_string (const string&, vector<string>& chns);
356 int set_sources (vector<string>&, void *src, bool add);
357 int set_destinations (vector<string>&, void *src, bool add);
359 int ensure_inputs (ChanCount, bool clear, bool lockit, void *src);
360 int ensure_outputs (ChanCount, bool clear, bool lockit, void *src);
362 void check_bundles_connected_to_inputs ();
363 void check_bundles_connected_to_outputs ();
364 void check_bundles (std::vector<UserBundleInfo>&, const PortSet&);
366 void bundle_configuration_will_change ();
367 void bundle_configuration_has_changed ();
368 void bundle_ports_will_change (int);
369 void bundle_ports_have_changed (int);
371 int create_ports (const XMLNode&);
372 int make_connections (const XMLNode&);
373 boost::shared_ptr<Bundle> find_possible_bundle (const string &desired_name, const string &default_name, const string &connection_type_name);
375 void setup_peak_meters ();
378 bool ensure_inputs_locked (ChanCount, bool clear, void *src);
379 bool ensure_outputs_locked (ChanCount, bool clear, void *src);
381 std::string build_legal_port_name (DataType type, bool for_input);
382 int32_t find_input_port_hole (const char* base);
383 int32_t find_output_port_hole (const char* base);
385 void create_bundles_for_inputs_and_outputs ();
386 void setup_bundles_for_inputs_and_outputs ();
388 void maybe_add_input_bundle_to_list (boost::shared_ptr<Bundle>, std::vector<boost::shared_ptr<Bundle> >*);
389 void maybe_add_output_bundle_to_list (boost::shared_ptr<Bundle>, std::vector<boost::shared_ptr<Bundle> >*);
392 } // namespace ARDOUR
394 #endif /*__ardour_io_h__ */