libs/ardour/ardour/stripable.h

   1 /*
   2   Copyright (C) 2016 Paul Davis
   3
   4   This program is free software; you can redistribute it and/or modify
   5   it under the terms of the GNU General Public License as published by
   6   the Free Software Foundation; either version 2 of the License, or
   7   (at your option) any later version.
   8
   9   This program is distributed in the hope that it will be useful,
  10   but WITHOUT ANY WARRANTY; without even the implied warranty of
  11   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12   GNU General Public License for more details.
  13
  14   You should have received a copy of the GNU General Public License
  15   along with this program; if not, write to the Free Software
  16   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #ifndef __libardour_stripable_h__
  21 #define __libardour_stripable_h__
  22
  23 #include <stdint.h>
  24
  25 #include <string>
  26 #include <boost/utility.hpp>
  27 #include <boost/shared_ptr.hpp>
  28
  29 #include "pbd/signals.h"
  30
  31 #include "ardour/presentation_info.h"
  32 #include "ardour/session_object.h"
  33 #include "ardour/libardour_visibility.h"
  34
  35 namespace ARDOUR {
  36
  37 class AutomationControl;
  38 class GainControl;
  39 class PeakMeter;
  40 class SoloControl;
  41 class MuteControl;
  42 class PhaseControl;
  43 class SoloIsolateControl;
  44 class SoloSafeControl;
  45 class MonitorControl;
  46 class MonitorProcessor;
  47 class RecordEnableControl;
  48 class RecordSafeControl;
  49
  50 /* This is a virtual base class for any object that needs to be potentially
  51  * represented by a control-centric user interface using the general model of a
  52  * mixing console "strip" - a collection of controls that determine the state
  53  * and behaviour of the object.
  54  */
  55
  56 class LIBARDOUR_API Stripable : public SessionObject {
  57    public:
  58         Stripable (Session& session, std::string const & name, PresentationInfo const &);
  59         virtual ~Stripable () {}
  60
  61         /* XXX
  62            midi on/off
  63          */
  64
  65         bool is_auditioner() const { return _presentation_info.flags() & PresentationInfo::Auditioner; }
  66         bool is_master() const { return _presentation_info.flags() & PresentationInfo::MasterOut; }
  67         bool is_monitor() const { return _presentation_info.flags() & PresentationInfo::MonitorOut; }
  68
  69         int set_state (XMLNode const&, int);
  70
  71         bool is_hidden() const { return _presentation_info.flags() & PresentationInfo::Hidden; }
  72         bool is_selected() const { return _presentation_info.flags() & PresentationInfo::Selected; }
  73
  74         PresentationInfo const & presentation_info () const { return _presentation_info; }
  75         PresentationInfo& presentation_info () { return _presentation_info; }
  76
  77         /* set just the order */
  78
  79         void  set_presentation_order (PresentationInfo::order_t, bool notify_class_listeners = true);
  80         void  set_presentation_order_explicit (PresentationInfo::order_t);
  81
  82         /***************************************************************
  83          * Pure interface begins here
  84          ***************************************************************/
  85
  86
  87         virtual boost::shared_ptr<PeakMeter>       peak_meter() = 0;
  88         virtual boost::shared_ptr<const PeakMeter> peak_meter() const = 0;
  89
  90         virtual boost::shared_ptr<GainControl> gain_control() const = 0;
  91
  92         virtual boost::shared_ptr<SoloControl> solo_control() const = 0;
  93         virtual boost::shared_ptr<SoloIsolateControl> solo_isolate_control() const = 0;
  94         virtual boost::shared_ptr<SoloSafeControl> solo_safe_control() const = 0;
  95         virtual boost::shared_ptr<MuteControl> mute_control() const = 0;
  96
  97         virtual boost::shared_ptr<PhaseControl> phase_control() const = 0;
  98         virtual boost::shared_ptr<GainControl> trim_control() const = 0;
  99
 100         virtual boost::shared_ptr<MonitorControl> monitoring_control() const = 0;
 101
 102         virtual boost::shared_ptr<AutomationControl> rec_enable_control() const { return boost::shared_ptr<AutomationControl>(); }
 103         virtual boost::shared_ptr<AutomationControl> rec_safe_control() const { return boost::shared_ptr<AutomationControl>(); }
 104
 105         /* "well-known" controls for panning. Any or all of these may return
 106          * null.
 107          */
 108
 109         virtual boost::shared_ptr<AutomationControl> pan_azimuth_control() const = 0;
 110         virtual boost::shared_ptr<AutomationControl> pan_elevation_control() const = 0;
 111         virtual boost::shared_ptr<AutomationControl> pan_width_control() const = 0;
 112         virtual boost::shared_ptr<AutomationControl> pan_frontback_control() const = 0;
 113         virtual boost::shared_ptr<AutomationControl> pan_lfe_control() const = 0;
 114
 115         /* "well-known" controls for an EQ in this route. Any or all may
 116          * be null. eq_band_cnt() must return 0 if there is no EQ present.
 117          * Passing an @param band value >= eq_band_cnt() will guarantee the
 118          * return of a null ptr (or an empty string for eq_band_name()).
 119          */
 120         virtual uint32_t eq_band_cnt () const = 0;
 121         virtual std::string eq_band_name (uint32_t) const = 0;
 122         virtual boost::shared_ptr<AutomationControl> eq_gain_controllable (uint32_t band) const = 0;
 123         virtual boost::shared_ptr<AutomationControl> eq_freq_controllable (uint32_t band) const = 0;
 124         virtual boost::shared_ptr<AutomationControl> eq_q_controllable (uint32_t band) const = 0;
 125         virtual boost::shared_ptr<AutomationControl> eq_shape_controllable (uint32_t band) const = 0;
 126         virtual boost::shared_ptr<AutomationControl> eq_enable_controllable () const = 0;
 127         virtual boost::shared_ptr<AutomationControl> eq_hpf_controllable () const = 0;
 128
 129         /* "well-known" controls for a compressor in this route. Any or all may
 130          * be null.
 131          */
 132         virtual boost::shared_ptr<AutomationControl> comp_enable_controllable () const = 0;
 133         virtual boost::shared_ptr<AutomationControl> comp_threshold_controllable () const = 0;
 134         virtual boost::shared_ptr<AutomationControl> comp_speed_controllable () const = 0;
 135         virtual boost::shared_ptr<AutomationControl> comp_mode_controllable () const = 0;
 136         virtual boost::shared_ptr<AutomationControl> comp_makeup_controllable () const = 0;
 137         virtual boost::shared_ptr<AutomationControl> comp_redux_controllable () const = 0;
 138
 139         /* @param mode must be supplied by the comp_mode_controllable(). All other values
 140          * result in undefined behaviour
 141          */
 142         virtual std::string comp_mode_name (uint32_t mode) const = 0;
 143         /* @param mode - as for comp mode name. This returns the name for the
 144          * parameter/control accessed via comp_speed_controllable(), which can
 145          * be mode dependent.
 146          */
 147         virtual std::string comp_speed_name (uint32_t mode) const = 0;
 148
 149         /* "well-known" controls for sends to well-known busses in this route. Any or all may
 150          * be null.
 151          *
 152          * In Mixbus, these are the sends that connect to the mixbusses.
 153          * In Ardour, these are user-created sends that connect to user-created
 154          * Aux busses.
 155          */
 156         virtual boost::shared_ptr<AutomationControl> send_level_controllable (uint32_t n) const = 0;
 157         virtual boost::shared_ptr<AutomationControl> send_enable_controllable (uint32_t n) const = 0;
 158         /* for the same value of @param n, this returns the name of the send
 159          * associated with the pair of controllables returned by the above two methods.
 160          */
 161         virtual std::string send_name (uint32_t n) const = 0;
 162
 163         /* well known control that enables/disables sending to the master bus.
 164          *
 165          * In Ardour, this returns null.
 166          * In Mixbus, it will return a suitable control, or null depending on
 167          * the route.
 168          */
 169         virtual boost::shared_ptr<AutomationControl> master_send_enable_controllable () const = 0;
 170
 171         virtual bool muted_by_others_soloing () const = 0;
 172
 173         virtual boost::shared_ptr<MonitorProcessor> monitor_control() const = 0;
 174
 175   protected:
 176         PresentationInfo _presentation_info;
 177 };
 178
 179 struct PresentationInfoSorter {
 180         bool operator() (boost::shared_ptr<Stripable> a, boost::shared_ptr<Stripable> b) {
 181                 return a->presentation_info() < b->presentation_info();
 182         }
 183 };
 184
 185
 186 }
 187
 188 #endif /* __libardour_stripable_h__ */