make sure that rec-enable changes get to do their non-RT stuff before being queued...
[ardour.git] / libs / ardour / ardour / delivery.h
index 7f1d964264e46a054e75be660018d8611b4248ec..80b8431737bdfd2046e2cf94f6d6b63ad5d418a0 100644 (file)
@@ -1,16 +1,16 @@
 /*
-    Copyright (C) 2006 Paul Davis 
-    
+    Copyright (C) 2006 Paul Davis
+
     This program is free software; you can redistribute it and/or modify it
     under the terms of the GNU General Public License as published by the Free
     Software Foundation; either version 2 of the License, or (at your option)
     any later version.
-    
+
     This program is distributed in the hope that it will be useful, but WITHOUT
     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
     for more details.
-    
+
     You should have received a copy of the GNU General Public License along
     with this program; if not, write to the Free Software Foundation, Inc.,
     675 Mass Ave, Cambridge, MA 02139, USA.
@@ -20,6 +20,8 @@
 #define __ardour_delivery_h__
 
 #include <string>
+
+#include "ardour/libardour_visibility.h"
 #include "ardour/types.h"
 #include "ardour/chan_count.h"
 #include "ardour/io_processor.h"
@@ -29,92 +31,98 @@ namespace ARDOUR {
 class BufferSet;
 class IO;
 class MuteMaster;
+class PannerShell;
 class Panner;
+class Pannable;
 
-class Delivery : public IOProcessor {
+class LIBARDOUR_API Delivery : public IOProcessor
+{
 public:
        enum Role {
-               Insert = 0x1,
+               /* main outputs - delivers out-of-place to port buffers, and cannot be removed */
+               Main   = 0x1,
+               /* send - delivers to port buffers, leaves input buffers untouched */
                Send   = 0x2,
-               Listen = 0x4,
-               Main   = 0x8
+               /* insert - delivers to port buffers and receives in-place from port buffers */
+               Insert = 0x4,
+               /* listen - internal send used only to deliver to control/monitor bus */
+               Listen = 0x8,
+               /* aux - internal send used to deliver to any bus, by user request */
+               Aux    = 0x10
        };
 
+       static bool role_requires_output_ports (Role r) { return r == Main || r == Send || r == Insert; }
+
+       bool does_routing() const { return true; }
+
        /* Delivery to an existing output */
 
-       Delivery (Session& s, boost::shared_ptr<IO> io, boost::shared_ptr<MuteMaster> mm, const std::string& name, Role);
-       Delivery (Session& s, boost::shared_ptr<IO> io, boost::shared_ptr<MuteMaster> mm, const XMLNode&);
+       Delivery (Session& s, boost::shared_ptr<IO> io, boost::shared_ptr<Pannable>, boost::shared_ptr<MuteMaster> mm, const std::string& name, Role);
 
        /* Delivery to a new output owned by this object */
 
-       Delivery (Session& s, boost::shared_ptr<MuteMaster> mm, const std::string& name, Role);
-       Delivery (Session&, boost::shared_ptr<MuteMaster> mm, const XMLNode&);
+       Delivery (Session& s, boost::shared_ptr<Pannable>, boost::shared_ptr<MuteMaster> mm, const std::string& name, Role);
+       ~Delivery ();
 
        bool set_name (const std::string& name);
-       bool visible() const;
+       std::string display_name() const;
+
        Role role() const { return _role; }
-       bool can_support_io_configuration (const ChanCount& in, ChanCount& out) const;
+       bool can_support_io_configuration (const ChanCount& in, ChanCount& out);
        bool configure_io (ChanCount in, ChanCount out);
 
-       void run (BufferSet& bufs, sframes_t start_frame, sframes_t end_frame, nframes_t nframes);
-
-       /* supplemental method use with MIDI */
+       void run (BufferSet& bufs, framepos_t start_frame, framepos_t end_frame, double speed, pframes_t nframes, bool);
 
-       void flush (nframes_t nframes);
+       /* supplemental method used with MIDI */
 
+       void flush_buffers (framecnt_t nframes);
        void no_outs_cuz_we_no_monitor(bool);
-
-       void set_solo_level (int32_t sl) { _solo_level = sl; }
-       void set_solo_isolated (bool yn) { _solo_isolated = yn; }
-
-       void cycle_start (nframes_t);
-       void increment_output_offset (nframes_t);
-       void transport_stopped (sframes_t frame);
+       void transport_stopped (framepos_t frame);
+       void realtime_locate ();
 
        BufferSet& output_buffers() { return *_output_buffers; }
 
-       sigc::signal<void> MuteChange;
-
-       static sigc::signal<void,nframes_t> CycleStart;
+       PBD::Signal0<void> MuteChange;
 
        XMLNode& state (bool full);
-       int set_state (const XMLNode&);
+       int set_state (const XMLNode&, int version);
 
        /* Panning */
 
        static int  disable_panners (void);
-       static int  reset_panners (void);
+       static void reset_panners ();
 
-       boost::shared_ptr<Panner> panner() const { return _panner; }
+       boost::shared_ptr<PannerShell> panner_shell() const { return _panshell; }
+       boost::shared_ptr<Panner> panner() const;
 
+       void unpan ();
        void reset_panner ();
        void defer_pan_reset ();
        void allow_pan_reset ();
 
        uint32_t pans_required() const { return _configured_input.n_audio(); }
-       void start_pan_touch (uint32_t which);
-       void end_pan_touch (uint32_t which);
+       virtual uint32_t pan_outs() const;
 
   protected:
        Role        _role;
        BufferSet*  _output_buffers;
        gain_t      _current_gain;
-       nframes_t   _output_offset;
+       boost::shared_ptr<PannerShell> _panshell;
+
+       gain_t target_gain ();
+
+  private:
        bool        _no_outs_cuz_we_no_monitor;
-       uint32_t    _solo_level;
-       bool        _solo_isolated;
        boost::shared_ptr<MuteMaster> _mute_master;
-       bool         no_panner_reset;
-       boost::shared_ptr<Panner> _panner;
 
        static bool panners_legal;
-       static sigc::signal<int>            PannersLegal;
+       static PBD::Signal0<void> PannersLegal;
 
-       int panners_became_legal ();
-       sigc::connection panner_legal_c;
+       void panners_became_legal ();
+       PBD::ScopedConnection panner_legal_c;
        void output_changed (IOChange, void*);
 
-       gain_t target_gain ();
+       bool _no_panner_reset;
 };