libs/ardour/ardour/return.h

   1 /*
   2     Copyright (C) 2009 Paul Davis
   3     Author: David Robillard
   4
   5     This program is free software; you can redistribute it and/or modify
   6     it under the terms of the GNU General Public License as published by
   7     the Free Software Foundation; either version 2 of the License, or
   8     (at your option) any later version.
   9
  10     This program is distributed in the hope that it will be useful,
  11     but WITHOUT ANY WARRANTY; without even the implied warranty of
  12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13     GNU General Public License for more details.
  14
  15     You should have received a copy of the GNU General Public License
  16     along with this program; if not, write to the Free Software
  17     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18
  19 */
  20
  21 #ifndef __ardour_return_h__
  22 #define __ardour_return_h__
  23
  24 #include <string>
  25
  26
  27 #include "pbd/stateful.h"
  28 #include "ardour/ardour.h"
  29 #include "ardour/io_processor.h"
  30
  31 namespace ARDOUR {
  32
  33 class Amp;
  34 class PeakMeter;
  35 class GainControl;
  36
  37 class LIBARDOUR_API Return : public IOProcessor
  38 {
  39 public:
  40         Return (Session&, bool internal = false);
  41         virtual ~Return ();
  42
  43         uint32_t bit_slot() const { return _bitslot; }
  44
  45         void run (BufferSet& bufs, framepos_t start_frame, framepos_t end_frame, pframes_t nframes, bool);
  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(void);
  56         int      set_state(const XMLNode&, int version);
  57
  58         uint32_t pans_required() const { return _configured_input.n_audio(); }
  59
  60         bool can_support_io_configuration (const ChanCount& in, ChanCount& out);
  61         bool configure_io (ChanCount in, ChanCount out);
  62
  63         static uint32_t how_many_returns();
  64         static std::string name_and_id_new_return (Session&, uint32_t&);
  65
  66   protected:
  67         bool _metering;
  68         boost::shared_ptr<GainControl> _gain_control;
  69         boost::shared_ptr<Amp> _amp;
  70         boost::shared_ptr<PeakMeter> _meter;
  71
  72 private:
  73         /* disallow copy construction */
  74         Return (const Return&);
  75
  76         uint32_t _bitslot;
  77
  78         void collect_input (BufferSet& bufs, pframes_t nframes, ChanCount offset = ChanCount::ZERO);
  79 };
  80
  81 } // namespace ARDOUR
  82
  83 #endif /* __ardour_return_h__ */
  84