change API for BasicUI::goto_start() to use optional roll-after arg
[ardour.git] / libs / ardour / ardour / stripable.h
index f68cb07b91d967a40636b024221c328d8ea1e2e3..942b48815b312fee5d7c3f33a4a48c1069d9f74e 100644 (file)
 #include <boost/utility.hpp>
 #include <boost/shared_ptr.hpp>
 
+#include "pbd/signals.h"
+
+#include "ardour/presentation_info.h"
 #include "ardour/session_object.h"
+#include "ardour/libardour_visibility.h"
 
 namespace ARDOUR {
 
@@ -39,6 +43,9 @@ class PhaseControl;
 class SoloIsolateControl;
 class SoloSafeControl;
 class MonitorControl;
+class MonitorProcessor;
+class RecordEnableControl;
+class RecordSafeControl;
 
 /* This is a virtual base class for any object that needs to be potentially
  * represented by a control-centric user interface using the general model of a
@@ -46,18 +53,45 @@ class MonitorControl;
  * and behaviour of the object.
  */
 
-class Stripable : public SessionObject {
+class LIBARDOUR_API Stripable : public SessionObject {
    public:
-       Stripable (Session& session, const std::string& name)
-               : SessionObject (session, name) {}
+       Stripable (Session& session, std::string const & name, PresentationInfo const &);
+       virtual ~Stripable () {}
 
        /* XXX
           midi on/off
-          selected status
-          visible/hidden
         */
 
-       virtual uint32_t remote_control_id () const = 0;
+       bool is_auditioner() const { return _presentation_info.flags() & PresentationInfo::Auditioner; }
+       bool is_master() const { return _presentation_info.flags() & PresentationInfo::MasterOut; }
+       bool is_monitor() const { return _presentation_info.flags() & PresentationInfo::MonitorOut; }
+
+       int set_state (XMLNode const&, int);
+
+       bool is_hidden() const { return _presentation_info.flags() & PresentationInfo::Hidden; }
+       bool is_selected() const { return _presentation_info.flags() & PresentationInfo::Selected; }
+
+       PresentationInfo const & presentation_info () const { return _presentation_info; }
+       PresentationInfo& presentation_info () { return _presentation_info; }
+       PresentationInfo* presentation_info_ptr () { return &_presentation_info; }
+
+       /* set just the order */
+
+       void  set_presentation_order (PresentationInfo::order_t, bool notify_class_listeners = true);
+
+       struct PresentationOrderSorter {
+               bool operator() (boost::shared_ptr<Stripable> a, boost::shared_ptr<Stripable> b) {
+                       return a->presentation_info().order() < b->presentation_info().order();
+               }
+       };
+
+       /* gui's call this for their own purposes. */
+
+       PBD::Signal2<void,std::string,void*> gui_changed;
+
+       /***************************************************************
+        * Pure interface begins here
+        ***************************************************************/
 
        virtual boost::shared_ptr<PeakMeter>       peak_meter() = 0;
        virtual boost::shared_ptr<const PeakMeter> peak_meter() const = 0;
@@ -65,29 +99,32 @@ class Stripable : public SessionObject {
        virtual boost::shared_ptr<GainControl> gain_control() const = 0;
 
        virtual boost::shared_ptr<SoloControl> solo_control() const = 0;
+       virtual boost::shared_ptr<SoloIsolateControl> solo_isolate_control() const = 0;
+       virtual boost::shared_ptr<SoloSafeControl> solo_safe_control() const = 0;
        virtual boost::shared_ptr<MuteControl> mute_control() const = 0;
 
        virtual boost::shared_ptr<PhaseControl> phase_control() const = 0;
        virtual boost::shared_ptr<GainControl> trim_control() const = 0;
 
        virtual boost::shared_ptr<MonitorControl> monitoring_control() const = 0;
-       virtual boost::shared_ptr<AutomationControl> recenable_control() const { return boost::shared_ptr<AutomationControl>(); }
 
-       /* "well-known" controls for panning. Any or all of these may return
-         * null.
-         */
+       virtual boost::shared_ptr<AutomationControl> rec_enable_control() const { return boost::shared_ptr<AutomationControl>(); }
+       virtual boost::shared_ptr<AutomationControl> rec_safe_control() const { return boost::shared_ptr<AutomationControl>(); }
 
+       /* "well-known" controls for panning. Any or all of these may return
+        * null.
+        */
        virtual boost::shared_ptr<AutomationControl> pan_azimuth_control() const = 0;
        virtual boost::shared_ptr<AutomationControl> pan_elevation_control() const = 0;
        virtual boost::shared_ptr<AutomationControl> pan_width_control() const = 0;
        virtual boost::shared_ptr<AutomationControl> pan_frontback_control() const = 0;
        virtual boost::shared_ptr<AutomationControl> pan_lfe_control() const = 0;
 
-        /* "well-known" controls for an EQ in this route. Any or all may
-         * be null. eq_band_cnt() must return 0 if there is no EQ present.
-         * Passing an @param band value >= eq_band_cnt() will guarantee the
-         * return of a null ptr (or an empty string for eq_band_name()).
-         */
+       /* "well-known" controls for an EQ in this route. Any or all may
+        * be null. eq_band_cnt() must return 0 if there is no EQ present.
+        * Passing an @param band value >= eq_band_cnt() will guarantee the
+        * return of a null ptr (or an empty string for eq_band_name()).
+        */
        virtual uint32_t eq_band_cnt () const = 0;
        virtual std::string eq_band_name (uint32_t) const = 0;
        virtual boost::shared_ptr<AutomationControl> eq_gain_controllable (uint32_t band) const = 0;
@@ -97,9 +134,9 @@ class Stripable : public SessionObject {
        virtual boost::shared_ptr<AutomationControl> eq_enable_controllable () const = 0;
        virtual boost::shared_ptr<AutomationControl> eq_hpf_controllable () const = 0;
 
-        /* "well-known" controls for a compressor in this route. Any or all may
-         * be null.
-         */
+       /* "well-known" controls for a compressor in this route. Any or all may
+        * be null.
+        */
        virtual boost::shared_ptr<AutomationControl> comp_enable_controllable () const = 0;
        virtual boost::shared_ptr<AutomationControl> comp_threshold_controllable () const = 0;
        virtual boost::shared_ptr<AutomationControl> comp_speed_controllable () const = 0;
@@ -107,42 +144,47 @@ class Stripable : public SessionObject {
        virtual boost::shared_ptr<AutomationControl> comp_makeup_controllable () const = 0;
        virtual boost::shared_ptr<AutomationControl> comp_redux_controllable () const = 0;
 
-        /* @param mode must be supplied by the comp_mode_controllable(). All other values
-         * result in undefined behaviour
-         */
+       /* @param mode must be supplied by the comp_mode_controllable(). All other values
+        * result in undefined behaviour
+        */
        virtual std::string comp_mode_name (uint32_t mode) const = 0;
-        /* @param mode - as for comp mode name. This returns the name for the
-         * parameter/control accessed via comp_speed_controllable(), which can
-         * be mode dependent.
-         */
+
+       /* @param mode - as for comp mode name. This returns the name for the
+        * parameter/control accessed via comp_speed_controllable(), which can
+        * be mode dependent.
+        */
        virtual std::string comp_speed_name (uint32_t mode) const = 0;
 
-        /* "well-known" controls for sends to well-known busses in this route. Any or all may
-         * be null.
-         *
-         * In Mixbus, these are the sends that connect to the mixbusses.
-         * In Ardour, these are user-created sends that connect to user-created
-         * Aux busses.
-         */
+       /* "well-known" controls for sends to well-known busses in this route. Any or all may
+        * be null.
+        *
+        * In Mixbus, these are the sends that connect to the mixbusses.
+        * In Ardour, these are user-created sends that connect to user-created
+        * Aux busses.
+        */
        virtual boost::shared_ptr<AutomationControl> send_level_controllable (uint32_t n) const = 0;
        virtual boost::shared_ptr<AutomationControl> send_enable_controllable (uint32_t n) const = 0;
-        /* for the same value of @param n, this returns the name of the send
-         * associated with the pair of controllables returned by the above two methods.
-         */
+
+       /* for the same value of @param n, this returns the name of the send
+        * associated with the pair of controllables returned by the above two methods.
+        */
        virtual std::string send_name (uint32_t n) const = 0;
 
-        /* well known control that enables/disables sending to the master bus.
-         *
-         * In Ardour, this returns null.
-         * In Mixbus, it will return a suitable control, or null depending on
-         * the route.
-         */
+       /* well known control that enables/disables sending to the master bus.
+        *
+        * In Ardour, this returns null.
+        * In Mixbus, it will return a suitable control, or null depending on
+        * the route.
+        */
        virtual boost::shared_ptr<AutomationControl> master_send_enable_controllable () const = 0;
 
        virtual bool muted_by_others_soloing () const = 0;
-       virtual bool muted_by_others () const = 0;
-};
 
+       virtual boost::shared_ptr<MonitorProcessor> monitor_control() const = 0;
+
+  protected:
+       PresentationInfo _presentation_info;
+};
 
 }