libs/ardour/ardour/automation_control.h

   1 /*
   2     Copyright (C) 2007 Paul Davis
   3     Author: David Robillard
   4
   5     This program is free software; you can redistribute it and/or modify
   6     it under the terms of the GNU General Public License as published by
   7     the Free Software Foundation; either version 2 of the License, or
   8     (at your option) any later version.
   9
  10     This program is distributed in the hope that it will be useful,
  11     but WITHOUT ANY WARRANTY; without even the implied warranty of
  12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13     GNU General Public License for more details.
  14
  15     You should have received a copy of the GNU General Public License
  16     along with this program; if not, write to the Free Software
  17     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18
  19 */
  20
  21 #ifndef __ardour_automation_control_h__
  22 #define __ardour_automation_control_h__
  23
  24 #include <boost/shared_ptr.hpp>
  25 #include <boost/enable_shared_from_this.hpp>
  26
  27 #include "pbd/controllable.h"
  28 #include "evoral/Control.hpp"
  29
  30 #include "ardour/libardour_visibility.h"
  31 #include "ardour/automation_list.h"
  32 #include "ardour/parameter_descriptor.h"
  33
  34 namespace ARDOUR {
  35
  36 class Session;
  37 class Automatable;
  38
  39
  40 /** A PBD::Controllable with associated automation data (AutomationList)
  41  */
  42 class LIBARDOUR_API AutomationControl : public PBD::Controllable, public Evoral::Control, public boost::enable_shared_from_this<AutomationControl>
  43 {
  44 public:
  45         AutomationControl(ARDOUR::Session&,
  46                           const Evoral::Parameter&                  parameter,
  47                           const ParameterDescriptor&                desc,
  48                           boost::shared_ptr<ARDOUR::AutomationList> l=boost::shared_ptr<ARDOUR::AutomationList>(),
  49                           const std::string&                        name="");
  50
  51         ~AutomationControl ();
  52
  53         boost::shared_ptr<AutomationList> alist() const {
  54                 return boost::dynamic_pointer_cast<AutomationList>(_list);
  55         }
  56
  57         void set_list (boost::shared_ptr<Evoral::ControlList>);
  58
  59         inline bool automation_playback() const {
  60                 return alist()->automation_playback();
  61         }
  62
  63         inline bool automation_write() const {
  64                 return alist()->automation_write();
  65         }
  66
  67         inline AutoState automation_state() const {
  68                 return alist()->automation_state();
  69         }
  70
  71         inline AutoStyle automation_style() const {
  72                 return alist()->automation_style();
  73         }
  74
  75         void set_automation_state(AutoState as);
  76         void set_automation_style(AutoStyle as);
  77         void start_touch (double when);
  78         void stop_touch (bool mark, double when);
  79
  80         void set_value (double);
  81         double get_value () const;
  82
  83         double lower()   const { return _desc.lower; }
  84         double upper()   const { return _desc.upper; }
  85         double normal()  const { return _desc.normal; }
  86         bool   toggled() const { return _desc.toggled; }
  87
  88         const ParameterDescriptor& desc() const { return _desc; }
  89
  90         const ARDOUR::Session& session() const { return _session; }
  91
  92 protected:
  93
  94         ARDOUR::Session& _session;
  95
  96         const ParameterDescriptor _desc;
  97 };
  98
  99
 100 } // namespace ARDOUR
 101
 102 #endif /* __ardour_automation_control_h__ */