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 "ardour/gain_control.h"
  30 #include "ardour/session_object.h"
  31
  32 namespace ARDOUR {
  33
  34 class AutomationControl;
  35 class PeakMeter;
  36
  37 /* This is a virtual base class for any object that needs to be potentially
  38  * represented by a control-centric user interface using the general model of a
  39  * mixing console "strip" - a collection of controls that determine the state
  40  * and behaviour of the object.
  41  */
  42
  43 class Stripable : public SessionObject {
  44    public:
  45         Stripable (Session& session, const std::string& name)
  46                 : SessionObject (session, name) {}
  47
  48         /* XXX
  49            midi on/off
  50            selected status
  51            visible/hidden
  52          */
  53
  54         virtual uint32_t remote_control_id () const = 0;
  55
  56         virtual boost::shared_ptr<PeakMeter>       peak_meter() = 0;
  57         virtual boost::shared_ptr<const PeakMeter> peak_meter() const = 0;
  58
  59         virtual boost::shared_ptr<GainControl> gain_control() const = 0;
  60
  61         virtual boost::shared_ptr<AutomationControl> solo_control() const = 0;
  62         virtual boost::shared_ptr<AutomationControl> mute_control() const = 0;
  63         virtual boost::shared_ptr<AutomationControl> phase_control() const = 0;
  64         virtual boost::shared_ptr<AutomationControl> trim_control() const = 0;
  65
  66         virtual boost::shared_ptr<AutomationControl> monitoring_control() const = 0;
  67         virtual boost::shared_ptr<AutomationControl> recenable_control() const { return boost::shared_ptr<AutomationControl>(); }
  68
  69         /* "well-known" controls for panning. Any or all of these may return
  70          * null.
  71          */
  72
  73         virtual boost::shared_ptr<AutomationControl> pan_azimuth_control() const = 0;
  74         virtual boost::shared_ptr<AutomationControl> pan_elevation_control() const = 0;
  75         virtual boost::shared_ptr<AutomationControl> pan_width_control() const = 0;
  76         virtual boost::shared_ptr<AutomationControl> pan_frontback_control() const = 0;
  77         virtual boost::shared_ptr<AutomationControl> pan_lfe_control() const = 0;
  78
  79         /* "well-known" controls for an EQ in this route. Any or all may
  80          * be null. eq_band_cnt() must return 0 if there is no EQ present.
  81          * Passing an @param band value >= eq_band_cnt() will guarantee the
  82          * return of a null ptr (or an empty string for eq_band_name()).
  83          */
  84         virtual uint32_t eq_band_cnt () const = 0;
  85         virtual std::string eq_band_name (uint32_t) const = 0;
  86         virtual boost::shared_ptr<AutomationControl> eq_gain_controllable (uint32_t band) const = 0;
  87         virtual boost::shared_ptr<AutomationControl> eq_freq_controllable (uint32_t band) const = 0;
  88         virtual boost::shared_ptr<AutomationControl> eq_q_controllable (uint32_t band) const = 0;
  89         virtual boost::shared_ptr<AutomationControl> eq_shape_controllable (uint32_t band) const = 0;
  90         virtual boost::shared_ptr<AutomationControl> eq_enable_controllable () const = 0;
  91         virtual boost::shared_ptr<AutomationControl> eq_hpf_controllable () const = 0;
  92
  93         /* "well-known" controls for a compressor in this route. Any or all may
  94          * be null.
  95          */
  96         virtual boost::shared_ptr<AutomationControl> comp_enable_controllable () const = 0;
  97         virtual boost::shared_ptr<AutomationControl> comp_threshold_controllable () const = 0;
  98         virtual boost::shared_ptr<AutomationControl> comp_speed_controllable () const = 0;
  99         virtual boost::shared_ptr<AutomationControl> comp_mode_controllable () const = 0;
 100         virtual boost::shared_ptr<AutomationControl> comp_makeup_controllable () const = 0;
 101         virtual boost::shared_ptr<AutomationControl> comp_redux_controllable () const = 0;
 102
 103         /* @param mode must be supplied by the comp_mode_controllable(). All other values
 104          * result in undefined behaviour
 105          */
 106         virtual std::string comp_mode_name (uint32_t mode) const = 0;
 107         /* @param mode - as for comp mode name. This returns the name for the
 108          * parameter/control accessed via comp_speed_controllable(), which can
 109          * be mode dependent.
 110          */
 111         virtual std::string comp_speed_name (uint32_t mode) const = 0;
 112
 113         /* "well-known" controls for sends to well-known busses in this route. Any or all may
 114          * be null.
 115          *
 116          * In Mixbus, these are the sends that connect to the mixbusses.
 117          * In Ardour, these are user-created sends that connect to user-created
 118          * Aux busses.
 119          */
 120         virtual boost::shared_ptr<AutomationControl> send_level_controllable (uint32_t n) const = 0;
 121         virtual boost::shared_ptr<AutomationControl> send_enable_controllable (uint32_t n) const = 0;
 122         /* for the same value of @param n, this returns the name of the send
 123          * associated with the pair of controllables returned by the above two methods.
 124          */
 125         virtual std::string send_name (uint32_t n) const = 0;
 126
 127         /* well known control that enables/disables sending to the master bus.
 128          *
 129          * In Ardour, this returns null.
 130          * In Mixbus, it will return a suitable control, or null depending on
 131          * the route.
 132          */
 133         virtual boost::shared_ptr<AutomationControl> master_send_enable_controllable () const = 0;
 134 };
 135
 136
 137 }
 138
 139 #endif /* __libardour_stripable_h__ */