libs/ardour/delivery.cc

   1 /*
   2     Copyright (C) 2009 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify it
   5     under the terms of the GNU General Public License as published by the Free
   6     Software Foundation; either version 2 of the License, or (at your option)
   7     any later version.
   8
   9     This program is distributed in the hope that it will be useful, but WITHOUT
  10     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12     for more details.
  13
  14     You should have received a copy of the GNU General Public License along
  15     with this program; if not, write to the Free Software Foundation, Inc.,
  16     675 Mass Ave, Cambridge, MA 02139, USA.
  17 */
  18
  19 #include <cmath>
  20 #include <algorithm>
  21
  22 #include "pbd/enumwriter.h"
  23 #include "pbd/convert.h"
  24
  25 #include "ardour/delivery.h"
  26 #include "ardour/audio_buffer.h"
  27 #include "ardour/amp.h"
  28 #include "ardour/buffer_set.h"
  29 #include "ardour/configuration.h"
  30 #include "ardour/io.h"
  31 #include "ardour/meter.h"
  32 #include "ardour/mute_master.h"
  33 #include "ardour/panner.h"
  34 #include "ardour/port.h"
  35 #include "ardour/session.h"
  36
  37 #include "i18n.h"
  38
  39 using namespace std;
  40 using namespace PBD;
  41 using namespace ARDOUR;
  42
  43 sigc::signal<void,nframes_t> Delivery::CycleStart;
  44 sigc::signal<int>            Delivery::PannersLegal;
  45 bool                         Delivery::panners_legal = false;
  46
  47 /* deliver to an existing IO object */
  48
  49 Delivery::Delivery (Session& s, boost::shared_ptr<IO> io, boost::shared_ptr<MuteMaster> mm, const string& name, Role r)
  50         : IOProcessor(s, boost::shared_ptr<IO>(), io, name)
  51         , _role (r)
  52         , _output_buffers (new BufferSet())
  53         , _solo_level (0)
  54         , _solo_isolated (false)
  55         , _mute_master (mm)
  56 {
  57         _output_offset = 0;
  58         _current_gain = 1.0;
  59         _panner = boost::shared_ptr<Panner>(new Panner (_name, _session));
  60
  61         _output->changed.connect (mem_fun (*this, &Delivery::output_changed));
  62 }
  63
  64 /* deliver to a new IO object */
  65
  66 Delivery::Delivery (Session& s, boost::shared_ptr<MuteMaster> mm, const string& name, Role r)
  67         : IOProcessor(s, false, true, name)
  68         , _role (r)
  69         , _output_buffers (new BufferSet())
  70         , _solo_level (0)
  71         , _solo_isolated (false)
  72         , _mute_master (mm)
  73 {
  74         _output_offset = 0;
  75         _current_gain = 1.0;
  76         _panner = boost::shared_ptr<Panner>(new Panner (_name, _session));
  77
  78         _output->changed.connect (mem_fun (*this, &Delivery::output_changed));
  79 }
  80
  81 /* deliver to a new IO object, reconstruct from XML */
  82
  83 Delivery::Delivery (Session& s, boost::shared_ptr<MuteMaster> mm, const XMLNode& node)
  84         : IOProcessor (s, false, true, "reset")
  85         , _role (Role (0))
  86         , _output_buffers (new BufferSet())
  87         , _solo_level (0)
  88         , _solo_isolated (false)
  89         , _mute_master (mm)
  90 {
  91         _output_offset = 0;
  92         _current_gain = 1.0;
  93         _panner = boost::shared_ptr<Panner>(new Panner (_name, _session));
  94
  95         if (set_state (node)) {
  96                 throw failed_constructor ();
  97         }
  98
  99         _output->changed.connect (mem_fun (*this, &Delivery::output_changed));
 100 }
 101
 102 void
 103 Delivery::cycle_start (nframes_t nframes)
 104 {
 105         _output_offset = 0;
 106         _no_outs_cuz_we_no_monitor = false;
 107 }
 108
 109 void
 110 Delivery::increment_output_offset (nframes_t n)
 111 {
 112         _output_offset += n;
 113 }
 114
 115 bool
 116 Delivery::visible () const
 117 {
 118         if (_role & Main) {
 119                 return false;
 120         }
 121
 122         return true;
 123 }
 124
 125 bool
 126 Delivery::can_support_io_configuration (const ChanCount& in, ChanCount& out) const
 127 {
 128         out = in;
 129         return true;
 130 }
 131
 132 bool
 133 Delivery::configure_io (ChanCount in, ChanCount out)
 134 {
 135         if (out != in) { // always 1:1
 136                 return false;
 137         }
 138
 139         reset_panner ();
 140
 141         return Processor::configure_io (in, out);
 142 }
 143
 144 void
 145 Delivery::run (BufferSet& bufs, sframes_t start_frame, sframes_t end_frame, nframes_t nframes)
 146 {
 147         if (_output->n_ports ().get (_output->default_type()) == 0) {
 148                 return;
 149         }
 150
 151         /* this setup is not just for our purposes, but for anything that comes after us in the
 152            processing pathway that wants to use this->output_buffers() for some reason.
 153         */
 154
 155         PortSet& ports (_output->ports());
 156         output_buffers().attach_buffers (ports, nframes, _output_offset);
 157
 158         // this Delivery processor is not a derived type, and thus we assume
 159         // we really can modify the buffers passed in (it is almost certainly
 160         // the main output stage of a Route). Contrast with Send::run()
 161         // which cannot do this.
 162
 163         gain_t tgain = target_gain ();
 164
 165         if (tgain != _current_gain) {
 166
 167                 /* target gain has changed */
 168
 169                 Amp::apply_gain (bufs, nframes, _current_gain, tgain);
 170                 _current_gain = tgain;
 171
 172         } else if (tgain == 0.0) {
 173
 174                 /* we were quiet last time, and we're still supposed to be quiet.
 175                    Silence the outputs, and make sure the buffers are quiet too,
 176                 */
 177
 178                 _output->silence (nframes);
 179                 Amp::apply_simple_gain (bufs, nframes, 0.0);
 180
 181                 return;
 182
 183         } else if (tgain != 1.0) {
 184
 185                 /* target gain has not changed, but is not unity */
 186                 Amp::apply_simple_gain (bufs, nframes, tgain);
 187         }
 188
 189         // Attach output buffers to port buffers
 190
 191         if (_panner && _panner->npanners() && !_panner->bypassed()) {
 192
 193                 // Use the panner to distribute audio to output port buffers
 194
 195                 _panner->run (bufs, output_buffers(), start_frame, end_frame, nframes);
 196
 197         } else {
 198                 // Do a 1:1 copy of data to output ports
 199
 200                 if (bufs.count().n_audio() > 0 && ports.count().n_audio () > 0) {
 201                         _output->copy_to_outputs (bufs, DataType::AUDIO, nframes, _output_offset);
 202                 }
 203
 204                 if (bufs.count().n_midi() > 0 && ports.count().n_midi () > 0) {
 205                         _output->copy_to_outputs (bufs, DataType::MIDI, nframes, _output_offset);
 206                 }
 207         }
 208 }
 209
 210
 211 XMLNode&
 212 Delivery::state (bool full_state)
 213 {
 214         XMLNode& node (IOProcessor::state (full_state));
 215
 216         if (_role & Main) {
 217                 node.add_property("type", "main-outs");
 218         } else if (_role & Listen) {
 219                 node.add_property("type", "listen");
 220         } else {
 221                 node.add_property("type", "delivery");
 222         }
 223
 224         node.add_property("role", enum_2_string(_role));
 225         node.add_child_nocopy (_panner->state (full_state));
 226
 227         return node;
 228 }
 229
 230 int
 231 Delivery::set_state (const XMLNode& node)
 232 {
 233         const XMLProperty* prop;
 234
 235         if (IOProcessor::set_state (node)) {
 236                 return -1;
 237         }
 238
 239         if ((prop = node.property ("role")) != 0) {
 240                 _role = Role (string_2_enum (prop->value(), _role));
 241         }
 242
 243         if ((prop = node.property ("solo_level")) != 0) {
 244                 _solo_level = 0; // needed for the reset to work
 245                 mod_solo_level (atoi (prop->value()));
 246         }
 247
 248         if ((prop = node.property ("solo-isolated")) != 0) {
 249                 set_solo_isolated (prop->value() == "yes");
 250         }
 251
 252         XMLNode* pan_node = node.child (X_("Panner"));
 253
 254         if (pan_node) {
 255                 _panner->set_state (*pan_node);
 256         }
 257
 258         reset_panner ();
 259
 260         return 0;
 261 }
 262
 263 void
 264 Delivery::reset_panner ()
 265 {
 266         if (panners_legal) {
 267                 if (!no_panner_reset) {
 268                         _panner->reset (_output->n_ports().n_audio(), pans_required());
 269                 }
 270         } else {
 271                 panner_legal_c.disconnect ();
 272                 panner_legal_c = PannersLegal.connect (mem_fun (*this, &Delivery::panners_became_legal));
 273         }
 274 }
 275
 276 int
 277 Delivery::panners_became_legal ()
 278 {
 279         _panner->reset (_output->n_ports().n_audio(), pans_required());
 280         _panner->load (); // automation
 281         panner_legal_c.disconnect ();
 282         return 0;
 283 }
 284
 285 void
 286 Delivery::defer_pan_reset ()
 287 {
 288         no_panner_reset = true;
 289 }
 290
 291 void
 292 Delivery::allow_pan_reset ()
 293 {
 294         no_panner_reset = false;
 295         reset_panner ();
 296 }
 297
 298
 299 int
 300 Delivery::disable_panners (void)
 301 {
 302         panners_legal = false;
 303         return 0;
 304 }
 305
 306 int
 307 Delivery::reset_panners ()
 308 {
 309         panners_legal = true;
 310         return PannersLegal ();
 311 }
 312
 313
 314 void
 315 Delivery::start_pan_touch (uint32_t which)
 316 {
 317         if (which < _panner->npanners()) {
 318                 _panner->pan_control(which)->start_touch();
 319         }
 320 }
 321
 322 void
 323 Delivery::end_pan_touch (uint32_t which)
 324 {
 325         if (which < _panner->npanners()) {
 326                 _panner->pan_control(which)->stop_touch();
 327         }
 328
 329 }
 330
 331 void
 332 Delivery::transport_stopped (sframes_t frame)
 333 {
 334         _panner->transport_stopped (frame);
 335 }
 336
 337 void
 338 Delivery::flush (nframes_t nframes)
 339 {
 340         /* io_lock, not taken: function must be called from Session::process() calltree */
 341
 342         PortSet& ports (_output->ports());
 343
 344         for (PortSet::iterator i = ports.begin(); i != ports.end(); ++i) {
 345                 (*i).flush_buffers (nframes, _output_offset);
 346         }
 347 }
 348
 349 gain_t
 350 Delivery::target_gain ()
 351 {
 352         /* if we've been told not to output because its a monitoring situation and
 353            we're not monitoring, then be quiet.
 354         */
 355
 356         if (_no_outs_cuz_we_no_monitor) {
 357                 return 0.0;
 358         }
 359
 360         gain_t desired_gain;
 361         MuteMaster::MutePoint mp;
 362
 363         switch (_role) {
 364         case Main:
 365                 mp = MuteMaster::Main;
 366                 break;
 367         case Listen:
 368                 mp = MuteMaster::Listen;
 369                 break;
 370         case Send:
 371         case Insert:
 372                 if (_placement == PreFader) {
 373                         mp = MuteMaster::PreFader;
 374                 } else {
 375                         mp = MuteMaster::PostFader;
 376                 }
 377                 break;
 378         }
 379
 380         if (_solo_level) {
 381                 desired_gain = 1.0;
 382         } else {
 383                 if (_solo_isolated) {
 384
 385                         desired_gain = _mute_master->mute_gain_at (mp);
 386
 387                 } else if (_session.soloing()) {
 388
 389                         desired_gain = min (Config->get_solo_mute_gain(), _mute_master->mute_gain_at (mp));
 390
 391                 } else {
 392                         desired_gain = _mute_master->mute_gain_at (mp);
 393                 }
 394         }
 395
 396         return desired_gain;
 397 }
 398
 399 void
 400 Delivery::mod_solo_level (int32_t delta)
 401 {
 402         if (delta < 0) {
 403                 if (_solo_level >= (uint32_t) delta) {
 404                         _solo_level += delta;
 405                 } else {
 406                         _solo_level = 0;
 407                 }
 408         } else {
 409                 _solo_level += delta;
 410         }
 411 }
 412
 413 void
 414 Delivery::set_solo_isolated (bool yn)
 415 {
 416         _solo_isolated = yn;
 417 }
 418
 419 void
 420 Delivery::no_outs_cuz_we_no_monitor (bool yn)
 421 {
 422         _no_outs_cuz_we_no_monitor = yn;
 423 }
 424
 425 bool
 426 Delivery::set_name (const std::string& name)
 427 {
 428         bool ret = IOProcessor::set_name (name);
 429
 430         if (ret) {
 431                 ret = _panner->set_name (name);
 432         }
 433
 434         return ret;
 435 }
 436
 437 void
 438 Delivery::output_changed (IOChange change, void* src)
 439 {
 440         if (change & ARDOUR::ConfigurationChanged) {
 441                 reset_panner ();
 442         }
 443 }