libs/ardour/ardour/automatable.h

   1 /*
   2     Copyright (C) 2000-2007 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 __ardour_automatable_h__
  21 #define __ardour_automatable_h__
  22
  23 #include <map>
  24 #include <set>
  25 #include <string>
  26
  27 #include <boost/shared_ptr.hpp>
  28
  29 #include "pbd/signals.h"
  30
  31 #include "evoral/ControlSet.hpp"
  32
  33 #include "ardour/libardour_visibility.h"
  34 #include "ardour/slavable.h"
  35 #include "ardour/types.h"
  36
  37 class XMLNode;
  38
  39 namespace ARDOUR {
  40
  41 class Session;
  42 class AutomationControl;
  43
  44 /* The inherited ControlSet is virtual because AutomatableSequence inherits
  45  * from this AND EvoralSequence, which is also a ControlSet
  46  */
  47 class LIBARDOUR_API Automatable : virtual public Evoral::ControlSet, public Slavable
  48 {
  49 public:
  50         Automatable(Session&);
  51         Automatable (const Automatable& other);
  52
  53         virtual ~Automatable();
  54
  55         static bool skip_saving_automation; // to be used only by session-state
  56
  57         boost::shared_ptr<Evoral::Control> control_factory(const Evoral::Parameter& id);
  58
  59         boost::shared_ptr<AutomationControl> automation_control (PBD::ID const & id) const;
  60         /* derived classes need to provide some way to search their own child
  61            automatable's for a control. normally, we'd just make the method
  62            above virtual, and let them override it. But that wouldn't
  63            differentiate the "check children" and "just your own" cases.
  64
  65            We could theoretically just overload the above method with an extra
  66            "bool recurse = default", but the rules of name hiding for C++ mean
  67            that making a method virtual will hide other overloaded versions of
  68            the same name. This means that virtual automation_control (PBD::ID
  69            const &) would hide automation_control (Evoral::Parameter const &
  70            id).
  71
  72            So, skip around all that with a different name.
  73         */
  74         virtual boost::shared_ptr<AutomationControl> automation_control_recurse (PBD::ID const & id) const {
  75                 return automation_control (id);
  76         }
  77
  78         boost::shared_ptr<AutomationControl> automation_control (const Evoral::Parameter& id) {
  79                 return automation_control (id, false);
  80         }
  81         boost::shared_ptr<AutomationControl> automation_control (const Evoral::Parameter& id, bool create_if_missing);
  82         boost::shared_ptr<const AutomationControl> automation_control (const Evoral::Parameter& id) const;
  83
  84         virtual void add_control(boost::shared_ptr<Evoral::Control>);
  85         virtual bool find_next_event (double start, double end, Evoral::ControlEvent& ev, bool only_active = true) const;
  86         void clear_controls ();
  87
  88         virtual void non_realtime_locate (samplepos_t now);
  89         virtual void non_realtime_transport_stop (samplepos_t now, bool flush);
  90
  91         virtual void automation_run (samplepos_t, pframes_t);
  92
  93         virtual std::string describe_parameter(Evoral::Parameter param);
  94
  95         AutoState get_parameter_automation_state (Evoral::Parameter param);
  96         virtual void set_parameter_automation_state (Evoral::Parameter param, AutoState);
  97
  98         void protect_automation ();
  99
 100         const std::set<Evoral::Parameter>& what_can_be_automated() const { return _can_automate_list; }
 101         void what_has_existing_automation (std::set<Evoral::Parameter>&) const;
 102
 103         static const std::string xml_node_name;
 104
 105         int set_automation_xml_state (const XMLNode&, Evoral::Parameter default_param);
 106         XMLNode& get_automation_xml_state();
 107
 108         PBD::Signal0<void> AutomationStateChanged;
 109
 110 protected:
 111         Session& _a_session;
 112
 113         void can_automate(Evoral::Parameter);
 114
 115         virtual void automation_list_automation_state_changed (Evoral::Parameter, AutoState) {}
 116
 117         int load_automation (const std::string& path);
 118         int old_set_automation_state(const XMLNode&);
 119
 120         std::set<Evoral::Parameter> _can_automate_list;
 121
 122         samplepos_t _last_automation_snapshot;
 123
 124         SlavableControlList slavables () const { return SlavableControlList(); }
 125
 126 private:
 127         PBD::ScopedConnectionList _control_connections; ///< connections to our controls' signals
 128 };
 129
 130
 131 } // namespace ARDOUR
 132
 133 #endif /* __ardour_automatable_h__ */