libs/ardour/ardour/delivery.h

   1 /*
   2     Copyright (C) 2006 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 #ifndef __ardour_delivery_h__
  20 #define __ardour_delivery_h__
  21
  22 #include <string>
  23 #include "ardour/types.h"
  24 #include "ardour/chan_count.h"
  25 #include "ardour/io_processor.h"
  26
  27 namespace ARDOUR {
  28
  29 class BufferSet;
  30 class IO;
  31 class MuteMaster;
  32 class Panner;
  33
  34 class Delivery : public IOProcessor {
  35 public:
  36         enum Role {
  37                 Insert = 0x1,
  38                 Send   = 0x2,
  39                 Listen = 0x4,
  40                 Main   = 0x8,
  41                 Aux    = 0x10
  42         };
  43
  44         /* Delivery to an existing output */
  45
  46         Delivery (Session& s, boost::shared_ptr<IO> io, boost::shared_ptr<MuteMaster> mm, const std::string& name, Role);
  47         Delivery (Session& s, boost::shared_ptr<IO> io, boost::shared_ptr<MuteMaster> mm, const XMLNode&);
  48
  49         /* Delivery to a new output owned by this object */
  50
  51         Delivery (Session& s, boost::shared_ptr<MuteMaster> mm, const std::string& name, Role);
  52         Delivery (Session&, boost::shared_ptr<MuteMaster> mm, const XMLNode&);
  53
  54         bool set_name (const std::string& name);
  55         std::string display_name() const;
  56
  57         bool visible() const;
  58         Role role() const { return _role; }
  59         bool can_support_io_configuration (const ChanCount& in, ChanCount& out) const;
  60         bool configure_io (ChanCount in, ChanCount out);
  61
  62         void run (BufferSet& bufs, sframes_t start_frame, sframes_t end_frame, nframes_t nframes);
  63
  64         /* supplemental method use with MIDI */
  65
  66         void flush (nframes_t nframes);
  67
  68         void no_outs_cuz_we_no_monitor(bool);
  69
  70         void set_solo_level (int32_t sl) { _solo_level = sl; }
  71         void set_solo_isolated (bool yn) { _solo_isolated = yn; }
  72
  73         void cycle_start (nframes_t);
  74         void increment_output_offset (nframes_t);
  75         void transport_stopped (sframes_t frame);
  76
  77         BufferSet& output_buffers() { return *_output_buffers; }
  78
  79         sigc::signal<void> MuteChange;
  80
  81         static sigc::signal<void,nframes_t> CycleStart;
  82
  83         XMLNode& state (bool full);
  84         int set_state (const XMLNode&);
  85
  86         /* Panning */
  87
  88         static int  disable_panners (void);
  89         static int  reset_panners (void);
  90
  91         boost::shared_ptr<Panner> panner() const { return _panner; }
  92
  93         void reset_panner ();
  94         void defer_pan_reset ();
  95         void allow_pan_reset ();
  96
  97         uint32_t pans_required() const { return _configured_input.n_audio(); }
  98         void start_pan_touch (uint32_t which);
  99         void end_pan_touch (uint32_t which);
 100
 101   protected:
 102         Role        _role;
 103         BufferSet*  _output_buffers;
 104         gain_t      _current_gain;
 105         nframes_t   _output_offset;
 106         bool        _no_outs_cuz_we_no_monitor;
 107         uint32_t    _solo_level;
 108         bool        _solo_isolated;
 109         boost::shared_ptr<MuteMaster> _mute_master;
 110         bool         no_panner_reset;
 111         boost::shared_ptr<Panner> _panner;
 112
 113         static bool panners_legal;
 114         static sigc::signal<int>            PannersLegal;
 115
 116         int panners_became_legal ();
 117         sigc::connection panner_legal_c;
 118         void output_changed (IOChange, void*);
 119
 120         gain_t target_gain ();
 121 };
 122
 123
 124 } // namespace ARDOUR
 125
 126 #endif // __ardour__h__
 127