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 #include "ardour/delayline.h"
  30
  31 namespace ARDOUR {
  32
  33 class PeakMeter;
  34 class Amp;
  35 class GainControl;
  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
  47         boost::shared_ptr<Amp> amp() const { return _amp; }
  48         boost::shared_ptr<PeakMeter> meter() const { return _meter; }
  49         boost::shared_ptr<GainControl> gain_control() const { return _gain_control; }
  50
  51         bool metering() const { return _metering; }
  52         void set_metering (bool yn) { _metering = yn; }
  53
  54         XMLNode& state (bool full);
  55         XMLNode& get_state ();
  56         int set_state(const XMLNode&, int version);
  57
  58         PBD::Signal0<void> SelfDestruct;
  59         void set_remove_on_disconnect (bool b) { _remove_on_disconnect = b; }
  60         bool remove_on_disconnect () const { return _remove_on_disconnect; }
  61
  62         uint32_t pans_required() const { return _configured_input.n_audio(); }
  63
  64         void run (BufferSet& bufs, framepos_t start_frame, framepos_t end_frame, double speed, pframes_t nframes, bool);
  65
  66         bool can_support_io_configuration (const ChanCount& in, ChanCount& out);
  67         bool configure_io (ChanCount in, ChanCount out);
  68
  69         /* latency compensation */
  70         void set_delay_in (framecnt_t);
  71         void set_delay_out (framecnt_t);
  72         framecnt_t get_delay_in () const { return _delay_in; }
  73         framecnt_t get_delay_out () const { return _delay_out; }
  74
  75         void activate ();
  76         void deactivate ();
  77
  78         bool set_name (const std::string& str);
  79
  80         std::string value_as_string (boost::shared_ptr<const AutomationControl>) const;
  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         bool _metering;
  87         boost::shared_ptr<GainControl> _gain_control;
  88         boost::shared_ptr<Amp> _amp;
  89         boost::shared_ptr<PeakMeter> _meter;
  90         boost::shared_ptr<DelayLine> _delayline;
  91
  92   private:
  93         /* disallow copy construction */
  94         Send (const Send&);
  95         void panshell_changed ();
  96         void snd_output_changed (IOChange, void*);
  97
  98         int set_state_2X (XMLNode const &, int);
  99
 100         uint32_t  _bitslot;
 101
 102         framecnt_t _delay_in;
 103         framecnt_t _delay_out;
 104         bool       _remove_on_disconnect;
 105 };
 106
 107 } // namespace ARDOUR
 108
 109 #endif /* __ardour_send_h__ */