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/parameter.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         virtual void add_control(boost::shared_ptr<Evoral::Control>);
  54
  55         virtual void automation_snapshot(nframes_t now, bool force);
  56         bool should_snapshot (nframes_t now) {
  57                 return (_last_automation_snapshot > now || (now - _last_automation_snapshot) > _automation_interval);
  58         }
  59         virtual void transport_stopped(nframes_t now);
  60
  61         virtual string describe_parameter(Parameter param);
  62
  63         AutoState get_parameter_automation_state (Parameter param, bool lock = true);
  64         virtual void set_parameter_automation_state (Parameter param, AutoState);
  65
  66         AutoStyle get_parameter_automation_style (Parameter param);
  67         void set_parameter_automation_style (Parameter param, AutoStyle);
  68
  69         void protect_automation ();
  70
  71         void what_has_visible_data(std::set<Parameter>&) const;
  72         const std::set<Parameter>& what_can_be_automated() const { return _can_automate_list; }
  73
  74         void mark_automation_visible(Parameter, bool);
  75
  76         static void set_automation_interval (jack_nframes_t frames) {
  77                 _automation_interval = frames;
  78         }
  79
  80         static jack_nframes_t automation_interval() {
  81                 return _automation_interval;
  82         }
  83
  84         typedef Evoral::ControlSet::Controls Controls;
  85
  86         Evoral::ControlSet&       data()       { return *this; }
  87         const Evoral::ControlSet& data() const { return *this; }
  88
  89 protected:
  90         Session& _a_session;
  91
  92         void can_automate(Parameter);
  93
  94         virtual void auto_state_changed (Parameter which) {}
  95
  96         int set_automation_state(const XMLNode&, Parameter default_param);
  97         XMLNode& get_automation_state();
  98
  99         int load_automation (const std::string& path);
 100         int old_set_automation_state(const XMLNode&);
 101
 102         std::set<Parameter> _visible_controls;
 103         std::set<Parameter> _can_automate_list;
 104
 105         nframes_t        _last_automation_snapshot;
 106         static nframes_t _automation_interval;
 107 };
 108
 109
 110 /** Contains notes and controllers */
 111 class AutomatableSequence : public Automatable, public Evoral::Sequence {
 112 public:
 113         AutomatableSequence(Session& s, size_t size)
 114                 : Evoral::ControlSet()
 115                 , Automatable(s)
 116                 , Evoral::Sequence(size)
 117         {}
 118 };
 119
 120
 121 /** Contains only controllers */
 122 class AutomatableControls : public Automatable {
 123 public:
 124         AutomatableControls(Session& s) : Evoral::ControlSet(), Automatable(s) {}
 125 };
 126
 127
 128 } // namespace ARDOUR
 129
 130 #endif /* __ardour_automatable_h__ */