libs/ardour/ardour/vca.h

   1 /*
   2     Copyright (C) 2016 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_vca_h__
  20 #define __ardour_vca_h__
  21
  22 #include <string>
  23 #include <boost/shared_ptr.hpp>
  24 #include <boost/enable_shared_from_this.hpp>
  25
  26 #include "pbd/controllable.h"
  27 #include "pbd/statefuldestructible.h"
  28
  29 #include "ardour/automatable.h"
  30 #include "ardour/muteable.h"
  31 #include "ardour/monitorable.h"
  32 #include "ardour/recordable.h"
  33 #include "ardour/soloable.h"
  34 #include "ardour/slavable.h"
  35 #include "ardour/stripable.h"
  36
  37 namespace ARDOUR {
  38
  39 class Route;
  40 class GainControl;
  41 class SoloControl;
  42 class MuteControl;
  43 class MonitorControl;
  44
  45 class LIBARDOUR_API VCA : public Stripable,
  46                           public Soloable,
  47                           public Muteable,
  48                           public Automatable,
  49                           public Slavable,
  50                           public Recordable,
  51                           public Monitorable,
  52                           public boost::enable_shared_from_this<VCA> {
  53   public:
  54         VCA (Session& session,  uint32_t num, const std::string& name);
  55         ~VCA();
  56
  57         uint32_t number () const { return _number; }
  58         uint32_t remote_control_id() const;
  59
  60         int init ();
  61         XMLNode& get_state();
  62         int set_state (XMLNode const&, int version);
  63
  64         /* Soloable API */
  65
  66         void clear_all_solo_state ();
  67
  68         bool soloed () const;
  69         void push_solo_upstream (int32_t) {}
  70         void push_solo_isolate_upstream (int32_t) {}
  71         bool can_solo() const { return true; }
  72         bool is_safe () const { return false; }
  73
  74         /* Muteable API */
  75
  76         bool can_be_muted_by_others () const { return true; }
  77         bool muted_by_others_soloing() const { return false; }
  78
  79         /* Recordable API */
  80
  81         int prep_record_enabled (bool yn) { return 0; }
  82         bool can_be_record_enabled() { return true; }
  83         bool can_be_record_safe() { return true; }
  84
  85         /* Monitorable API */
  86
  87         MonitorState monitoring_state() const;
  88
  89         static std::string default_name_template ();
  90         static int next_vca_number ();
  91         static std::string xml_node_name;
  92
  93         /* used by Session to save/restore the atomic counter */
  94         static uint32_t get_next_vca_number ();
  95         static void set_next_vca_number (uint32_t);
  96
  97         virtual boost::shared_ptr<GainControl> gain_control() const { return _gain_control; }
  98         virtual boost::shared_ptr<SoloControl> solo_control() const { return _solo_control; }
  99         virtual boost::shared_ptr<MuteControl> mute_control() const { return _mute_control; }
 100         virtual boost::shared_ptr<AutomationControl> recenable_control() const { return _recenable_control; }
 101         virtual boost::shared_ptr<MonitorControl>    monitoring_control() const { return _monitor_control; }
 102
 103         /* null Stripable API, because VCAs don't have any of this */
 104
 105         virtual boost::shared_ptr<PeakMeter>         peak_meter() { return boost::shared_ptr<PeakMeter>(); }
 106         virtual boost::shared_ptr<const PeakMeter>   peak_meter() const { return boost::shared_ptr<PeakMeter>(); }
 107         virtual boost::shared_ptr<PhaseControl>      phase_control() const { return boost::shared_ptr<PhaseControl>(); }
 108         virtual boost::shared_ptr<GainControl>       trim_control() const { return boost::shared_ptr<GainControl>(); }
 109         virtual boost::shared_ptr<AutomationControl> pan_azimuth_control() const { return boost::shared_ptr<AutomationControl>(); }
 110         virtual boost::shared_ptr<AutomationControl> pan_elevation_control() const { return boost::shared_ptr<AutomationControl>(); }
 111         virtual boost::shared_ptr<AutomationControl> pan_width_control() const { return boost::shared_ptr<AutomationControl>(); }
 112         virtual boost::shared_ptr<AutomationControl> pan_frontback_control() const { return boost::shared_ptr<AutomationControl>(); }
 113         virtual boost::shared_ptr<AutomationControl> pan_lfe_control() const { return boost::shared_ptr<AutomationControl>(); }
 114         virtual uint32_t eq_band_cnt () const { return 0; }
 115         virtual std::string eq_band_name (uint32_t) const { return std::string(); }
 116         virtual boost::shared_ptr<AutomationControl> eq_gain_controllable (uint32_t band) const { return boost::shared_ptr<AutomationControl>(); }
 117         virtual boost::shared_ptr<AutomationControl> eq_freq_controllable (uint32_t band) const { return boost::shared_ptr<AutomationControl>(); }
 118         virtual boost::shared_ptr<AutomationControl> eq_q_controllable (uint32_t band) const { return boost::shared_ptr<AutomationControl>(); }
 119         virtual boost::shared_ptr<AutomationControl> eq_shape_controllable (uint32_t band) const { return boost::shared_ptr<AutomationControl>(); }
 120         virtual boost::shared_ptr<AutomationControl> eq_enable_controllable () const { return boost::shared_ptr<AutomationControl>(); }
 121         virtual boost::shared_ptr<AutomationControl> eq_hpf_controllable () const { return boost::shared_ptr<AutomationControl>(); }
 122         virtual boost::shared_ptr<AutomationControl> comp_enable_controllable () const { return boost::shared_ptr<AutomationControl>(); }
 123         virtual boost::shared_ptr<AutomationControl> comp_threshold_controllable () const { return boost::shared_ptr<AutomationControl>(); }
 124         virtual boost::shared_ptr<AutomationControl> comp_speed_controllable () const { return boost::shared_ptr<AutomationControl>(); }
 125         virtual boost::shared_ptr<AutomationControl> comp_mode_controllable () const { return boost::shared_ptr<AutomationControl>(); }
 126         virtual boost::shared_ptr<AutomationControl> comp_makeup_controllable () const { return boost::shared_ptr<AutomationControl>(); }
 127         virtual boost::shared_ptr<AutomationControl> comp_redux_controllable () const { return boost::shared_ptr<AutomationControl>(); }
 128         virtual std::string comp_mode_name (uint32_t mode) const { return std::string(); }
 129         virtual std::string comp_speed_name (uint32_t mode) const { return std::string(); }
 130         virtual boost::shared_ptr<AutomationControl> send_level_controllable (uint32_t n) const { return boost::shared_ptr<AutomationControl>(); }
 131         virtual boost::shared_ptr<AutomationControl> send_enable_controllable (uint32_t n) const { return boost::shared_ptr<AutomationControl>(); }
 132         virtual std::string send_name (uint32_t n) const { return std::string(); }
 133         virtual boost::shared_ptr<AutomationControl> master_send_enable_controllable () const { return boost::shared_ptr<AutomationControl>(); }
 134
 135   protected:
 136         int assign_controls (boost::shared_ptr<VCA>);
 137         int unassign_controls (boost::shared_ptr<VCA>);
 138
 139   private:
 140         uint32_t    _number;
 141
 142         boost::shared_ptr<GainControl> _gain_control;
 143         boost::shared_ptr<SoloControl> _solo_control;
 144         boost::shared_ptr<MuteControl> _mute_control;
 145         boost::shared_ptr<AutomationControl> _recenable_control;
 146         // boost::shared_ptr<AutomationControl> _record_safe_control;
 147         boost::shared_ptr<MonitorControl> _monitor_control;
 148
 149         static gint next_number;
 150
 151         void solo_target_going_away (boost::weak_ptr<Route>);
 152         void mute_target_going_away (boost::weak_ptr<Route>);
 153         bool soloed_locked () const;
 154         bool muted_locked () const;
 155 };
 156
 157 } /* namespace */
 158
 159 #endif /* __ardour_vca_h__ */