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     $Id$
  19 */
  20
  21 #ifndef __ardour_io_h__
  22 #define __ardour_io_h__
  23
  24 #include <string>
  25 #include <vector>
  26 #include <cmath>
  27 #include <sigc++/signal.h>
  28 #include <jack/jack.h>
  29
  30 #include <glibmm/thread.h>
  31
  32 #include <pbd/fastlog.h>
  33 #include <pbd/undo.h>
  34 #include <pbd/statefuldestructible.h>
  35 #include <pbd/controllable.h>
  36
  37 #include <ardour/ardour.h>
  38 #include <ardour/utils.h>
  39 #include <ardour/state_manager.h>
  40 #include <ardour/curve.h>
  41 #include <ardour/types.h>
  42 #include <ardour/data_type.h>
  43
  44 using std::string;
  45 using std::vector;
  46
  47 class XMLNode;
  48
  49 namespace ARDOUR {
  50
  51 class Session;
  52 class AudioEngine;
  53 class Port;
  54 class Connection;
  55 class Panner;
  56
  57 /** A collection of input and output ports with connections.
  58  *
  59  * An IO can contain ports of varying types, making routes/inserts/etc with
  60  * varied combinations of types (eg MIDI and audio) possible.
  61  */
  62 class IO : public PBD::StatefulDestructible
  63 {
  64
  65   public:
  66         static const string state_node_name;
  67
  68         IO (Session&, string name,
  69             int input_min = -1, int input_max = -1,
  70             int output_min = -1, int output_max = -1,
  71                 DataType default_type = DataType::AUDIO);
  72
  73 virtual ~IO();
  74
  75         int input_minimum() const { return _input_minimum; }
  76         int input_maximum() const { return _input_maximum; }
  77         int output_minimum() const { return _output_minimum; }
  78         int output_maximum() const { return _output_maximum; }
  79
  80         void set_input_minimum (int n);
  81         void set_input_maximum (int n);
  82         void set_output_minimum (int n);
  83         void set_output_maximum (int n);
  84
  85         DataType default_type() const { return _default_type; }
  86
  87         const string& name() const { return _name; }
  88         virtual int set_name (string str, void *src);
  89
  90         virtual void silence  (nframes_t, nframes_t offset);
  91
  92         // These should be moved in to a separate object that manipulates an IO
  93
  94         void pan (vector<Sample*>& bufs, uint32_t nbufs, nframes_t nframes, nframes_t offset, gain_t gain_coeff);
  95         void pan_automated (vector<Sample*>& bufs, uint32_t nbufs, nframes_t start_frame, nframes_t end_frame,
  96                             nframes_t nframes, nframes_t offset);
  97         void collect_input  (vector<Sample*>&, uint32_t nbufs, nframes_t nframes, nframes_t offset);
  98         void deliver_output (vector<Sample*>&, uint32_t nbufs, nframes_t nframes, nframes_t offset);
  99         void deliver_output_no_pan (vector<Sample*>&, uint32_t nbufs, nframes_t nframes, nframes_t offset);
 100         void just_meter_input (nframes_t start_frame, nframes_t end_frame,
 101                                nframes_t nframes, nframes_t offset);
 102
 103         virtual uint32_t n_process_buffers () { return 0; }
 104
 105         virtual void   set_gain (gain_t g, void *src);
 106         void           inc_gain (gain_t delta, void *src);
 107         gain_t         gain () const { return _desired_gain; }
 108         virtual gain_t effective_gain () const;
 109
 110         Panner& panner() { return *_panner; }
 111
 112         int ensure_io (uint32_t, uint32_t, bool clear, void *src);
 113
 114         int use_input_connection (Connection&, void *src);
 115         int use_output_connection (Connection&, void *src);
 116
 117         Connection *input_connection() const { return _input_connection; }
 118         Connection *output_connection() const { return _output_connection; }
 119
 120         int add_input_port (string source, void *src, DataType type = DataType::NIL);
 121         int add_output_port (string destination, void *src, DataType type = DataType::NIL);
 122
 123         int remove_input_port (Port *, void *src);
 124         int remove_output_port (Port *, void *src);
 125
 126         int set_input (Port *, void *src);
 127
 128         int connect_input (Port *our_port, string other_port, void *src);
 129         int connect_output (Port *our_port, string other_port, void *src);
 130
 131         int disconnect_input (Port *our_port, string other_port, void *src);
 132         int disconnect_output (Port *our_port, string other_port, void *src);
 133
 134         int disconnect_inputs (void *src);
 135         int disconnect_outputs (void *src);
 136
 137         nframes_t output_latency() const;
 138         nframes_t input_latency() const;
 139         void           set_port_latency (nframes_t);
 140
 141         Port *output (uint32_t n) const {
 142                 if (n < _noutputs) {
 143                         return _outputs[n];
 144                 } else {
 145                         return 0;
 146                 }
 147         }
 148
 149         Port *input (uint32_t n) const {
 150                 if (n < _ninputs) {
 151                         return _inputs[n];
 152                 } else {
 153                         return 0;
 154                 }
 155         }
 156
 157         uint32_t n_inputs () const { return _ninputs; }
 158         uint32_t n_outputs () const { return _noutputs; }
 159
 160         sigc::signal<void,IOChange,void*> input_changed;
 161         sigc::signal<void,IOChange,void*> output_changed;
 162
 163         sigc::signal<void,void*> gain_changed;
 164         sigc::signal<void,void*> name_changed;
 165
 166         virtual XMLNode& state (bool full);
 167         XMLNode& get_state (void);
 168         int set_state (const XMLNode&);
 169
 170 #ifdef STATE_MANAGER
 171         virtual UndoAction get_memento() const;
 172 #endif
 173
 174         static int  disable_connecting (void);
 175
 176         static int  enable_connecting (void);
 177
 178         static int  disable_ports (void);
 179
 180         static int  enable_ports (void);
 181
 182         static int  disable_panners (void);
 183
 184         static int  reset_panners (void);
 185
 186         static sigc::signal<int> PortsLegal;
 187         static sigc::signal<int> PannersLegal;
 188         static sigc::signal<int> ConnectingLegal;
 189         static sigc::signal<void,uint32_t> MoreOutputs;
 190         static sigc::signal<int> PortsCreated;
 191
 192         PBD::Controllable& gain_control() {
 193                 return _gain_control;
 194         }
 195
 196         /* Peak metering */
 197
 198         float peak_input_power (uint32_t n) {
 199                 if (n < std::max (_ninputs, _noutputs)) {
 200                         return _visible_peak_power[n];
 201                 } else {
 202                         return minus_infinity();
 203                 }
 204         }
 205
 206     static void update_meters();
 207
 208 private:
 209
 210     static sigc::signal<void>   Meter;
 211     static Glib::StaticMutex    m_meter_signal_lock;
 212     sigc::connection            m_meter_connection;
 213
 214 public:
 215
 216         /* automation */
 217
 218         void clear_automation ();
 219
 220         bool gain_automation_recording() const {
 221                 return (_gain_automation_curve.automation_state() & (Write|Touch));
 222         }
 223
 224         bool gain_automation_playback() const {
 225                 return (_gain_automation_curve.automation_state() & Play) ||
 226                         ((_gain_automation_curve.automation_state() & Touch) &&
 227                          !_gain_automation_curve.touching());
 228         }
 229
 230         virtual void set_gain_automation_state (AutoState);
 231         AutoState gain_automation_state() const { return _gain_automation_curve.automation_state(); }
 232         sigc::signal<void> gain_automation_state_changed;
 233
 234         virtual void set_gain_automation_style (AutoStyle);
 235         AutoStyle gain_automation_style () const { return _gain_automation_curve.automation_style(); }
 236         sigc::signal<void> gain_automation_style_changed;
 237
 238         virtual void transport_stopped (nframes_t now);
 239
 240         ARDOUR::Curve& gain_automation_curve () { return _gain_automation_curve; }
 241
 242         void start_gain_touch ();
 243         void end_gain_touch ();
 244
 245         void start_pan_touch (uint32_t which);
 246         void end_pan_touch (uint32_t which);
 247
 248         void defer_pan_reset ();
 249         void allow_pan_reset ();
 250
 251         /* the session calls this for master outs before
 252            anyone else. controls outs too, at some point.
 253         */
 254
 255         XMLNode *pending_state_node;
 256         int ports_became_legal ();
 257
 258   private:
 259         mutable Glib::Mutex io_lock;
 260
 261   protected:
 262         Session&            _session;
 263         Panner*             _panner;
 264         gain_t              _gain;
 265         gain_t              _effective_gain;
 266         gain_t              _desired_gain;
 267         Glib::Mutex         declick_lock;
 268         vector<Port*>       _outputs;
 269         vector<Port*>       _inputs;
 270         vector<float>       _peak_power;
 271         vector<float>       _visible_peak_power;
 272         string              _name;
 273         Connection*         _input_connection;
 274         Connection*         _output_connection;
 275         bool                 no_panner_reset;
 276         XMLNode*             deferred_state;
 277         DataType            _default_type;
 278         bool                _ignore_gain_on_deliver;
 279
 280
 281         virtual void set_deferred_state() {}
 282
 283         void reset_peak_meters();
 284         void reset_panner ();
 285
 286         virtual uint32_t pans_required() const { return _ninputs; }
 287
 288         static void apply_declick (vector<Sample*>&, uint32_t nbufs, nframes_t nframes,
 289                                    gain_t initial, gain_t target, bool invert_polarity);
 290
 291         struct GainControllable : public PBD::Controllable {
 292             GainControllable (std::string name, IO& i) : Controllable (name), io (i) {}
 293
 294             void set_value (float val);
 295             float get_value (void) const;
 296
 297             IO& io;
 298         };
 299
 300         GainControllable _gain_control;
 301
 302         /* state management */
 303
 304 #ifdef STATE_MANAGER
 305         Change               restore_state (State&);
 306         StateManager::State* state_factory (std::string why) const;
 307 #endif
 308
 309         AutoState      _gain_automation_state;
 310         AutoStyle      _gain_automation_style;
 311
 312         bool     apply_gain_automation;
 313         Curve    _gain_automation_curve;
 314
 315         int  save_automation (const string&);
 316         int  load_automation (const string&);
 317
 318         Glib::Mutex automation_lock;
 319
 320         /* AudioTrack::deprecated_use_diskstream_connections() needs these */
 321
 322         int set_inputs (const string& str);
 323         int set_outputs (const string& str);
 324
 325         static bool connecting_legal;
 326         static bool ports_legal;
 327
 328   private:
 329
 330         uint32_t _ninputs;
 331         uint32_t _noutputs;
 332
 333         /* are these the best variable names ever, or what? */
 334
 335         sigc::connection input_connection_configuration_connection;
 336         sigc::connection output_connection_configuration_connection;
 337         sigc::connection input_connection_connection_connection;
 338         sigc::connection output_connection_connection_connection;
 339
 340         static bool panners_legal;
 341
 342         int connecting_became_legal ();
 343         int panners_became_legal ();
 344         sigc::connection connection_legal_c;
 345         sigc::connection port_legal_c;
 346         sigc::connection panner_legal_c;
 347
 348         int _input_minimum;
 349         int _input_maximum;
 350         int _output_minimum;
 351         int _output_maximum;
 352
 353
 354         static int parse_io_string (const string&, vector<string>& chns);
 355
 356         static int parse_gain_string (const string&, vector<string>& chns);
 357
 358         int set_sources (vector<string>&, void *src, bool add);
 359         int set_destinations (vector<string>&, void *src, bool add);
 360
 361         int ensure_inputs (uint32_t, bool clear, bool lockit, void *src);
 362         int ensure_outputs (uint32_t, bool clear, bool lockit, void *src);
 363
 364         void drop_input_connection ();
 365         void drop_output_connection ();
 366
 367         void input_connection_configuration_changed ();
 368         void input_connection_connection_changed (int);
 369         void output_connection_configuration_changed ();
 370         void output_connection_connection_changed (int);
 371
 372         int create_ports (const XMLNode&);
 373         int make_connections (const XMLNode&);
 374
 375         void setup_peak_meters ();
 376         void meter ();
 377
 378         bool ensure_inputs_locked (uint32_t, bool clear, void *src);
 379         bool ensure_outputs_locked (uint32_t, bool clear, void *src);
 380
 381         int32_t find_input_port_hole ();
 382         int32_t find_output_port_hole ();
 383 };
 384
 385 } // namespace ARDOUR
 386
 387 #endif /*__ardour_io_h__ */