libs/ardour/ardour/return.h

   1 /*
   2     Copyright (C) 2009 Paul Davis
   3     Author: Dave 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 <sigc++/signal.h>
  25 #include <string>
  26
  27
  28 #include "pbd/stateful.h"
  29 #include "ardour/ardour.h"
  30 #include "ardour/audioengine.h"
  31 #include "ardour/io_processor.h"
  32
  33 namespace ARDOUR {
  34
  35 class Amp;
  36 class PeakMeter;
  37
  38 class Return : public IOProcessor
  39 {
  40 public:
  41         Return (Session&);
  42         Return (Session&, const XMLNode&);
  43         virtual ~Return ();
  44
  45         uint32_t bit_slot() const { return _bitslot; }
  46
  47         void run_in_place (BufferSet& bufs, sframes_t start_frame, sframes_t end_frame, nframes_t nframes);
  48
  49         boost::shared_ptr<Amp> amp() const { return _amp; }
  50         boost::shared_ptr<PeakMeter> meter() const { return _meter; }
  51
  52         bool metering() const { return _metering; }
  53         void set_metering (bool yn) { _metering = yn; }
  54
  55         XMLNode& state(bool full);
  56         XMLNode& get_state(void);
  57         int      set_state(const XMLNode& node);
  58
  59         uint32_t pans_required() const { return _configured_input.n_audio(); }
  60
  61         bool can_support_io_configuration (const ChanCount& in, ChanCount& out) const;
  62         bool configure_io (ChanCount in, ChanCount out);
  63
  64         static uint32_t how_many_returns();
  65         static void make_unique (XMLNode &, Session &);
  66
  67   protected:
  68         bool _metering;
  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, nframes_t nframes, ChanCount offset=ChanCount::ZERO);
  79         void just_meter_input (sframes_t start_frame, sframes_t end_frame, nframes_t nframes);
  80 };
  81
  82 } // namespace ARDOUR
  83
  84 #endif /* __ardour_return_h__ */
  85