/* Copyright (C) 2016 Paul Davis This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */ #ifndef __libardour_stripable_h__ #define __libardour_stripable_h__ #include #include #include #include #include "pbd/signals.h" #include "ardour/presentation_info.h" #include "ardour/session_object.h" #include "ardour/libardour_visibility.h" namespace ARDOUR { class AutomationControl; class GainControl; class PeakMeter; class SoloControl; class MuteControl; 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 * mixing console "strip" - a collection of controls that determine the state * and behaviour of the object. */ class LIBARDOUR_API Stripable : public SessionObject { public: Stripable (Session& session, std::string const & name, PresentationInfo const &); virtual ~Stripable () {} /* XXX midi on/off */ 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 a, boost::shared_ptr b) { return a->presentation_info().order() < b->presentation_info().order(); } }; /* gui's call this for their own purposes. */ PBD::Signal2 gui_changed; /*************************************************************** * Pure interface begins here ***************************************************************/ virtual boost::shared_ptr peak_meter() = 0; virtual boost::shared_ptr peak_meter() const = 0; virtual boost::shared_ptr gain_control() const = 0; virtual boost::shared_ptr solo_control() const = 0; virtual boost::shared_ptr solo_isolate_control() const = 0; virtual boost::shared_ptr solo_safe_control() const = 0; virtual boost::shared_ptr mute_control() const = 0; virtual boost::shared_ptr phase_control() const = 0; virtual boost::shared_ptr trim_control() const = 0; virtual boost::shared_ptr monitoring_control() const = 0; virtual boost::shared_ptr rec_enable_control() const { return boost::shared_ptr(); } virtual boost::shared_ptr rec_safe_control() const { return boost::shared_ptr(); } /* "well-known" controls for panning. Any or all of these may return * null. */ virtual boost::shared_ptr pan_azimuth_control() const = 0; virtual boost::shared_ptr pan_elevation_control() const = 0; virtual boost::shared_ptr pan_width_control() const = 0; virtual boost::shared_ptr pan_frontback_control() const = 0; virtual boost::shared_ptr 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()). */ virtual uint32_t eq_band_cnt () const = 0; virtual std::string eq_band_name (uint32_t) const = 0; virtual boost::shared_ptr eq_gain_controllable (uint32_t band) const = 0; virtual boost::shared_ptr eq_freq_controllable (uint32_t band) const = 0; virtual boost::shared_ptr eq_q_controllable (uint32_t band) const = 0; virtual boost::shared_ptr eq_shape_controllable (uint32_t band) const = 0; virtual boost::shared_ptr eq_enable_controllable () const = 0; virtual boost::shared_ptr eq_hpf_controllable () const = 0; /* "well-known" controls for a compressor in this route. Any or all may * be null. */ virtual boost::shared_ptr comp_enable_controllable () const = 0; virtual boost::shared_ptr comp_threshold_controllable () const = 0; virtual boost::shared_ptr comp_speed_controllable () const = 0; virtual boost::shared_ptr comp_mode_controllable () const = 0; virtual boost::shared_ptr comp_makeup_controllable () const = 0; virtual boost::shared_ptr comp_redux_controllable () const = 0; /* @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. */ 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. */ virtual boost::shared_ptr send_level_controllable (uint32_t n) const = 0; virtual boost::shared_ptr 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. */ 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. */ virtual boost::shared_ptr master_send_enable_controllable () const = 0; virtual bool muted_by_others_soloing () const = 0; virtual boost::shared_ptr monitor_control() const = 0; protected: PresentationInfo _presentation_info; }; } #endif /* __libardour_stripable_h__ */