libs/ardour/ardour/send.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_send_h__
  21 #define __ardour_send_h__
  22
  23 #include <string>
  24
  25 #include "pbd/stateful.h"
  26
  27 #include "ardour/ardour.h"
  28 #include "ardour/delivery.h"
  29
  30 namespace ARDOUR {
  31
  32 class PeakMeter;
  33 class Amp;
  34 class GainControl;
  35 class DelayLine;
  36
  37 class LIBARDOUR_API Send : public Delivery
  38 {
  39 public:
  40         Send (Session&, boost::shared_ptr<Pannable> pannable, boost::shared_ptr<MuteMaster>, Delivery::Role r = Delivery::Send, bool ignore_bitslot = false);
  41         virtual ~Send ();
  42
  43         uint32_t bit_slot() const { return _bitslot; }
  44
  45         bool display_to_user() const;
  46         bool is_personal () const { return _role == Personal; }
  47
  48         boost::shared_ptr<Amp> amp() const { return _amp; }
  49         boost::shared_ptr<PeakMeter> meter() const { return _meter; }
  50         boost::shared_ptr<GainControl> gain_control() const { return _gain_control; }
  51
  52         bool metering() const { return _metering; }
  53         void set_metering (bool yn) { _metering = yn; }
  54
  55         int set_state(const XMLNode&, int version);
  56
  57         PBD::Signal0<void> SelfDestruct;
  58         void set_remove_on_disconnect (bool b) { _remove_on_disconnect = b; }
  59         bool remove_on_disconnect () const { return _remove_on_disconnect; }
  60
  61         uint32_t pans_required() const { return _configured_input.n_audio(); }
  62
  63         void run (BufferSet& bufs, samplepos_t start_sample, samplepos_t end_sample, double speed, pframes_t nframes, bool);
  64
  65         bool can_support_io_configuration (const ChanCount& in, ChanCount& out);
  66         bool configure_io (ChanCount in, ChanCount out);
  67
  68         /* latency compensation */
  69         void set_delay_in (samplecnt_t); // should only be called by Route::update_signal_latency
  70         void set_delay_out (samplecnt_t);  // should only be called by InternalReturn::set_playback_offset (via Route::update_signal_latency)
  71         samplecnt_t get_delay_in () const { return _delay_in; }
  72         samplecnt_t get_delay_out () const { return _delay_out; }
  73         samplecnt_t signal_latency () const;
  74
  75         static PBD::Signal0<void> ChangedLatency;
  76
  77         void activate ();
  78         void deactivate ();
  79
  80         bool set_name (const std::string& str);
  81
  82         static uint32_t how_many_sends();
  83         static std::string name_and_id_new_send (Session&, Delivery::Role r, uint32_t&, bool);
  84
  85 protected:
  86         XMLNode& state ();
  87
  88         bool _metering;
  89         boost::shared_ptr<GainControl> _gain_control;
  90         boost::shared_ptr<Amp> _amp;
  91         boost::shared_ptr<PeakMeter> _meter;
  92         boost::shared_ptr<DelayLine> _send_delay;
  93         boost::shared_ptr<DelayLine> _thru_delay;
  94
  95 private:
  96         /* disallow copy construction */
  97         Send (const Send&);
  98
  99         void panshell_changed ();
 100         void snd_output_changed (IOChange, void*);
 101
 102         void update_delaylines ();
 103
 104         int set_state_2X (XMLNode const &, int);
 105
 106         uint32_t  _bitslot;
 107
 108         samplecnt_t _delay_in;
 109         samplecnt_t _delay_out;
 110         bool       _remove_on_disconnect;
 111 };
 112
 113 } // namespace ARDOUR
 114
 115 #endif /* __ardour_send_h__ */