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