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 <set>
  24 #include <map>
  25 #include <boost/shared_ptr.hpp>
  26 #include <ardour/session_object.h>
  27 #include <ardour/automation_list.h>
  28 #include <ardour/automation_control.h>
  29 #include <ardour/event_type_map.h>
  30 #include <evoral/ControlSet.hpp>
  31 #include <evoral/Sequence.hpp>
  32
  33 namespace ARDOUR {
  34
  35 class Session;
  36 class AutomationControl;
  37
  38
  39 /** Note this class is abstract, actual objects must either be
  40  * an AutomatableControls or an AutomatableSequence
  41  */
  42 class Automatable : virtual public Evoral::ControlSet
  43 {
  44 public:
  45         Automatable(Session&);
  46         Automatable();
  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
  61         virtual void automation_snapshot(nframes_t now, bool force);
  62         virtual void transport_stopped(nframes_t now);
  63
  64         virtual string describe_parameter(Evoral::Parameter param);
  65
  66         AutoState get_parameter_automation_state (Evoral::Parameter param, bool lock = true);
  67         virtual void set_parameter_automation_state (Evoral::Parameter param, AutoState);
  68
  69         AutoStyle get_parameter_automation_style (Evoral::Parameter param);
  70         void set_parameter_automation_style (Evoral::Parameter param, AutoStyle);
  71
  72         void protect_automation ();
  73
  74         void what_has_visible_data(std::set<Evoral::Parameter>&) const;
  75         const std::set<Evoral::Parameter>& what_can_be_automated() const { return _can_automate_list; }
  76
  77         void mark_automation_visible(Evoral::Parameter, bool);
  78
  79         inline bool should_snapshot (nframes_t now) {
  80                 return (_last_automation_snapshot > now
  81                                 || (now - _last_automation_snapshot) > _automation_interval);
  82         }
  83
  84         static void set_automation_interval (jack_nframes_t frames) {
  85                 _automation_interval = frames;
  86         }
  87
  88         static jack_nframes_t automation_interval() {
  89                 return _automation_interval;
  90         }
  91
  92         typedef Evoral::ControlSet::Controls Controls;
  93
  94         Evoral::ControlSet&       data()       { return *this; }
  95         const Evoral::ControlSet& data() const { return *this; }
  96
  97 protected:
  98         Session& _a_session;
  99
 100         void can_automate(Evoral::Parameter);
 101
 102         virtual void auto_state_changed (Evoral::Parameter which) {}
 103
 104         int set_automation_state(const XMLNode&, Evoral::Parameter default_param);
 105         XMLNode& get_automation_state();
 106
 107         int load_automation (const std::string& path);
 108         int old_set_automation_state(const XMLNode&);
 109
 110         std::set<Evoral::Parameter> _visible_controls;
 111         std::set<Evoral::Parameter> _can_automate_list;
 112
 113         nframes_t        _last_automation_snapshot;
 114         static nframes_t _automation_interval;
 115 };
 116
 117
 118 /** Contains notes and controllers */
 119 class AutomatableSequence : public Automatable, public Evoral::Sequence {
 120 public:
 121         AutomatableSequence(Session& s, size_t size)
 122                 : Evoral::ControlSet()
 123                 , Automatable(s)
 124                 , Evoral::Sequence(EventTypeMap::instance())
 125         {}
 126 };
 127
 128
 129 /** Contains only controllers */
 130 class AutomatableControls : public Automatable {
 131 public:
 132         AutomatableControls(Session& s) : Evoral::ControlSet(), Automatable(s) {}
 133 };
 134
 135
 136 } // namespace ARDOUR
 137
 138 #endif /* __ardour_automatable_h__ */