libs/ardour/ardour/io.h

   1 /*
   2     Copyright (C) 2000 Paul Davis
   3
   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.
   8
   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.
  13
  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.
  17
  18 */
  19
  20 #ifndef __ardour_io_h__
  21 #define __ardour_io_h__
  22
  23 #include <string>
  24 #include <vector>
  25 #include <cmath>
  26 #include <sigc++/signal.h>
  27 #include <jack/jack.h>
  28
  29 #include <glibmm/thread.h>
  30
  31 #include <pbd/fastlog.h>
  32 #include <pbd/undo.h>
  33 #include <pbd/statefuldestructible.h>
  34 #include <pbd/controllable.h>
  35
  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
  46 using std::string;
  47 using std::vector;
  48
  49 class XMLNode;
  50
  51 namespace ARDOUR {
  52
  53 class Session;
  54 class AudioEngine;
  55 class Bundle;
  56 class UserBundle;
  57 class Panner;
  58 class PeakMeter;
  59 class Port;
  60 class AudioPort;
  61 class MidiPort;
  62 class BufferSet;
  63
  64
  65 /** A collection of input and output ports with connections.
  66  *
  67  * An IO can contain ports of varying types, making routes/inserts/etc with
  68  * varied combinations of types (eg MIDI and audio) possible.
  69  */
  70
  71 class IO : public SessionObject, public AutomatableControls, public Latent
  72 {
  73   public:
  74         static const string state_node_name;
  75
  76         IO (Session&, const string& name,
  77             int input_min = -1, int input_max = -1,
  78             int output_min = -1, int output_max = -1,
  79             DataType default_type = DataType::AUDIO,
  80             bool public_ports = true);
  81
  82         IO (Session&, const XMLNode&, DataType default_type = DataType::AUDIO);
  83
  84         virtual ~IO();
  85
  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; }
  90
  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);
  95
  96         bool active() const { return _active; }
  97         void set_active (bool yn);
  98
  99         DataType default_type() const         { return _default_type; }
 100         void     set_default_type(DataType t) { _default_type = t; }
 101
 102         bool set_name (const string& str);
 103
 104         virtual void silence  (nframes_t, nframes_t offset);
 105
 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);
 111
 112         BufferSet& output_buffers() { return *_output_buffers; }
 113
 114         gain_t         gain () const { return _desired_gain; }
 115         virtual gain_t effective_gain () const;
 116
 117         void set_denormal_protection (bool yn, void *src);
 118         bool denormal_protection() const { return _denormal_protection; }
 119
 120         void set_phase_invert (bool yn, void *src);
 121         bool phase_invert() const { return _phase_invert; }
 122
 123         Panner& panner()        { return *_panner; }
 124         PeakMeter& peak_meter() { return *_meter; }
 125         const Panner& panner() const { return *_panner; }
 126         void reset_panner ();
 127
 128         int ensure_io (ChanCount in, ChanCount out, bool clear, void *src);
 129
 130         int connect_input_ports_to_bundle (boost::shared_ptr<Bundle>, void *src);
 131         int connect_output_ports_to_bundle (boost::shared_ptr<Bundle>, void *src);
 132
 133         BundleList bundles_connected_to_inputs ();
 134         BundleList bundles_connected_to_outputs ();
 135
 136         boost::shared_ptr<Bundle> bundle_for_inputs () { return _bundle_for_inputs; }
 137         boost::shared_ptr<Bundle> bundle_for_outputs () { return _bundle_for_outputs; }
 138
 139         int add_input_port (string source, void *src, DataType type = DataType::NIL);
 140         int add_output_port (string destination, void *src, DataType type = DataType::NIL);
 141
 142         int remove_input_port (Port *, void *src);
 143         int remove_output_port (Port *, void *src);
 144
 145         int set_input (Port *, void *src);
 146
 147         int connect_input (Port *our_port, string other_port, void *src);
 148         int connect_output (Port *our_port, string other_port, void *src);
 149
 150         int disconnect_input (Port *our_port, string other_port, void *src);
 151         int disconnect_output (Port *our_port, string other_port, void *src);
 152
 153         int disconnect_inputs (void *src);
 154         int disconnect_outputs (void *src);
 155
 156         nframes_t signal_latency() const { return _own_latency; }
 157         nframes_t output_latency() const;
 158         nframes_t input_latency() const;
 159         void      set_port_latency (nframes_t);
 160
 161         void update_port_total_latencies ();
 162
 163         const PortSet& inputs()  const { return _inputs; }
 164         const PortSet& outputs() const { return _outputs; }
 165
 166         Port *output (uint32_t n) const {
 167                 if (n < _outputs.num_ports()) {
 168                         return _outputs.port(n);
 169                 } else {
 170                         return 0;
 171                 }
 172         }
 173
 174         Port *input (uint32_t n) const {
 175                 if (n < _inputs.num_ports()) {
 176                         return _inputs.port(n);
 177                 } else {
 178                         return 0;
 179                 }
 180         }
 181
 182         AudioPort* audio_input(uint32_t n) const;
 183         AudioPort* audio_output(uint32_t n) const;
 184         MidiPort*  midi_input(uint32_t n) const;
 185         MidiPort*  midi_output(uint32_t n) const;
 186
 187         const ChanCount& n_inputs ()  const { return _inputs.count(); }
 188         const ChanCount& n_outputs () const { return _outputs.count(); }
 189
 190         void attach_buffers(ChanCount ignored);
 191
 192         sigc::signal<void>                active_changed;
 193
 194         sigc::signal<void,IOChange,void*> input_changed;
 195         sigc::signal<void,IOChange,void*> output_changed;
 196
 197         virtual XMLNode& state (bool full);
 198         XMLNode& get_state (void);
 199         int set_state (const XMLNode&);
 200
 201         static int  disable_connecting (void);
 202         static int  enable_connecting (void);
 203         static int  disable_ports (void);
 204         static int  enable_ports (void);
 205         static int  disable_panners (void);
 206         static int  reset_panners (void);
 207
 208         static sigc::signal<int>            PortsLegal;
 209         static sigc::signal<int>            PannersLegal;
 210         static sigc::signal<int>            ConnectingLegal;
 211         /// raised when the number of input or output ports changes
 212         static sigc::signal<void,ChanCount> PortCountChanged;
 213         static sigc::signal<int>            PortsCreated;
 214
 215         static void update_meters();
 216
 217   private:
 218
 219         static sigc::signal<void>   Meter;
 220         static Glib::StaticMutex    m_meter_signal_lock;
 221         sigc::connection            m_meter_connection;
 222
 223   public:
 224
 225         /* automation */
 226
 227         struct GainControl : public AutomationControl {
 228             GainControl (std::string name, IO* i, const Evoral::Parameter &param,
 229                     boost::shared_ptr<AutomationList> al = boost::shared_ptr<AutomationList>() )
 230                         : AutomationControl (i->_session, param, al, name )
 231                         , _io (i)
 232                 {}
 233
 234             void set_value (float val);
 235             float get_value (void) const;
 236
 237             IO* _io;
 238         };
 239
 240         boost::shared_ptr<GainControl> gain_control() {
 241                 return _gain_control;
 242         }
 243         boost::shared_ptr<const GainControl> gain_control() const {
 244                 return _gain_control;
 245         }
 246
 247         void clear_automation ();
 248
 249         void set_parameter_automation_state (Evoral::Parameter, AutoState);
 250
 251         virtual void transport_stopped (nframes_t now);
 252         virtual void automation_snapshot (nframes_t now, bool force);
 253
 254         void start_pan_touch (uint32_t which);
 255         void end_pan_touch (uint32_t which);
 256
 257         void defer_pan_reset ();
 258         void allow_pan_reset ();
 259
 260         /* the session calls this for master outs before
 261            anyone else. controls outs too, at some point.
 262         */
 263
 264         XMLNode *pending_state_node;
 265         int ports_became_legal ();
 266
 267   private:
 268         mutable Glib::Mutex io_lock;
 269
 270   protected:
 271         Panner*             _panner;
 272         BufferSet*          _output_buffers; //< Set directly to output port buffers
 273         bool                _active;
 274         gain_t              _gain;
 275         gain_t              _effective_gain;
 276         gain_t              _desired_gain;
 277         Glib::Mutex          declick_lock;
 278         PortSet             _outputs;
 279         PortSet             _inputs;
 280         PeakMeter*          _meter;
 281         bool                 no_panner_reset;
 282         bool                _phase_invert;
 283         bool                _denormal_protection;
 284         XMLNode*             deferred_state;
 285         DataType            _default_type;
 286         bool                _public_ports;
 287
 288         virtual void prepare_inputs (nframes_t nframes, nframes_t offset);
 289         virtual void flush_outputs (nframes_t nframes, nframes_t offset);
 290
 291         virtual void set_deferred_state() {}
 292
 293         virtual uint32_t pans_required() const
 294                 { return _inputs.count().n_audio(); }
 295
 296         boost::shared_ptr<GainControl> _gain_control;
 297
 298         virtual void   set_gain (gain_t g, void *src);
 299         void           inc_gain (gain_t delta, void *src);
 300
 301         bool apply_gain_automation;
 302
 303         virtual int load_automation (std::string path);
 304
 305         /* AudioTrack::deprecated_use_diskstream_connections() needs these */
 306
 307         int set_inputs (const string& str);
 308         int set_outputs (const string& str);
 309
 310         static bool connecting_legal;
 311         static bool ports_legal;
 312
 313   private:
 314         static bool panners_legal;
 315
 316         void copy_to_outputs (BufferSet& bufs, DataType type, nframes_t nframes, nframes_t offset);
 317
 318         int connecting_became_legal ();
 319         int panners_became_legal ();
 320         sigc::connection connection_legal_c;
 321         sigc::connection port_legal_c;
 322         sigc::connection panner_legal_c;
 323
 324         ChanCount _input_minimum; ///< minimum number of input channels (0 for no minimum)
 325         ChanCount _input_maximum; ///< maximum number of input channels (ChanCount::INFINITE for no maximum)
 326         ChanCount _output_minimum; ///< minimum number of output channels (0 for no minimum)
 327         ChanCount _output_maximum; ///< maximum number of output channels (ChanCount::INFINITE for no maximum)
 328
 329         boost::shared_ptr<Bundle> _bundle_for_inputs; ///< a bundle representing our inputs
 330         boost::shared_ptr<Bundle> _bundle_for_outputs; ///< a bundle representing our outputs
 331
 332         struct UserBundleInfo {
 333                 UserBundleInfo (IO*, boost::shared_ptr<UserBundle> b);
 334
 335                 boost::shared_ptr<UserBundle> bundle;
 336                 sigc::connection configuration_changed;
 337                 sigc::connection ports_changed;
 338         };
 339
 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
 342
 343         static int parse_io_string (const string&, vector<string>& chns);
 344
 345         static int parse_gain_string (const string&, vector<string>& chns);
 346
 347         int set_sources (vector<string>&, void *src, bool add);
 348         int set_destinations (vector<string>&, void *src, bool add);
 349
 350         int ensure_inputs (ChanCount, bool clear, bool lockit, void *src);
 351         int ensure_outputs (ChanCount, bool clear, bool lockit, void *src);
 352
 353         void check_bundles_connected_to_inputs ();
 354         void check_bundles_connected_to_outputs ();
 355         void check_bundles (std::vector<UserBundleInfo>&, const PortSet&);
 356
 357         void bundle_configuration_changed ();
 358         void bundle_ports_changed (int);
 359
 360         int create_ports (const XMLNode&);
 361         int make_connections (const XMLNode&);
 362         boost::shared_ptr<Bundle> find_possible_bundle (const string &desired_name, const string &default_name, const string &connection_type_name);
 363
 364         void setup_peak_meters ();
 365         void meter ();
 366
 367         bool ensure_inputs_locked (ChanCount, bool clear, void *src);
 368         bool ensure_outputs_locked (ChanCount, bool clear, void *src);
 369
 370         std::string build_legal_port_name (DataType type, bool for_input);
 371         int32_t find_input_port_hole (const char* base);
 372         int32_t find_output_port_hole (const char* base);
 373
 374         void create_bundles_for_inputs_and_outputs ();
 375         void setup_bundles_for_inputs_and_outputs ();
 376         std::string bundle_channel_name (uint32_t, uint32_t) const;
 377 };
 378
 379 } // namespace ARDOUR
 380
 381 #endif /*__ardour_io_h__ */