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 #include <boost/shared_ptr.hpp>
  27 #include "pbd/signals.h"
  28 #include "evoral/ControlSet.hpp"
  29 #include "ardour/libardour_visibility.h"
  30 #include "ardour/types.h"
  31
  32 class XMLNode;
  33
  34 namespace ARDOUR {
  35
  36 class Session;
  37 class AutomationControl;
  38
  39 /* The inherited ControlSet is virtual because AutomatableSequence inherits
  40  * from this AND EvoralSequence, which is also a ControlSet
  41  */
  42 class LIBARDOUR_API Automatable : virtual public Evoral::ControlSet
  43 {
  44 public:
  45         Automatable(Session&);
  46         Automatable (const Automatable& other);
  47
  48         virtual ~Automatable();
  49
  50         boost::shared_ptr<Evoral::Control>
  51         control_factory(const Evoral::Parameter& id);
  52
  53         boost::shared_ptr<AutomationControl>
  54         automation_control (const Evoral::Parameter& id, bool create_if_missing=false);
  55
  56         boost::shared_ptr<const AutomationControl>
  57         automation_control (const Evoral::Parameter& id) const;
  58
  59         virtual void add_control(boost::shared_ptr<Evoral::Control>);
  60         virtual bool find_next_event(double start, double end, Evoral::ControlEvent& ev, bool only_active = true) const;
  61         void clear_controls ();
  62
  63         virtual void transport_located (framepos_t now);
  64         virtual void transport_stopped (framepos_t now);
  65
  66         virtual std::string describe_parameter(Evoral::Parameter param);
  67         virtual std::string value_as_string (boost::shared_ptr<AutomationControl>) const;
  68
  69         AutoState get_parameter_automation_state (Evoral::Parameter param);
  70         virtual void set_parameter_automation_state (Evoral::Parameter param, AutoState);
  71
  72         AutoStyle get_parameter_automation_style (Evoral::Parameter param);
  73         void set_parameter_automation_style (Evoral::Parameter param, AutoStyle);
  74
  75         void protect_automation ();
  76
  77         const std::set<Evoral::Parameter>& what_can_be_automated() const { return _can_automate_list; }
  78         void what_has_existing_automation (std::set<Evoral::Parameter>&) const;
  79
  80         static const std::string xml_node_name;
  81
  82         int set_automation_xml_state (const XMLNode&, Evoral::Parameter default_param);
  83         XMLNode& get_automation_xml_state();
  84
  85         PBD::Signal0<void> AutomationStateChanged;
  86
  87   protected:
  88         Session& _a_session;
  89
  90         void can_automate(Evoral::Parameter);
  91
  92         virtual void automation_list_automation_state_changed (Evoral::Parameter, AutoState) {}
  93
  94         int load_automation (const std::string& path);
  95         int old_set_automation_state(const XMLNode&);
  96
  97         std::set<Evoral::Parameter> _can_automate_list;
  98
  99         framepos_t _last_automation_snapshot;
 100
 101 private:
 102         PBD::ScopedConnectionList _control_connections; ///< connections to our controls' signals
 103 };
 104
 105
 106 } // namespace ARDOUR
 107
 108 #endif /* __ardour_automatable_h__ */