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