automation_control.h

Go to the documentation of this file.

/*
    Copyright (C) 2007 Paul Davis
    Author: David Robillard

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

*/

#ifndef __ardour_automation_control_h__
#define __ardour_automation_control_h__

#include <boost/shared_ptr.hpp>
#include <boost/enable_shared_from_this.hpp>

#include "evoral/types.hpp"
#include "pbd/controllable.h"
#include "evoral/Control.hpp"

#include "ardour/libardour_visibility.h"
#include "ardour/automation_list.h"
#include "ardour/parameter_descriptor.h"

namespace ARDOUR {

class Session;
class Automatable;


class LIBARDOUR_API AutomationControl
        : public PBD::Controllable
        , public Evoral::Control
        , public boost::enable_shared_from_this<AutomationControl>
{
public:
        AutomationControl(ARDOUR::Session&,
                          const Evoral::Parameter&                  parameter,
                          const ParameterDescriptor&                desc,
                          boost::shared_ptr<ARDOUR::AutomationList> l=boost::shared_ptr<ARDOUR::AutomationList>(),
                          const std::string&                        name="");

        ~AutomationControl ();

        boost::shared_ptr<AutomationList> alist() const {
                return boost::dynamic_pointer_cast<AutomationList>(_list);
        }

        void set_list (boost::shared_ptr<Evoral::ControlList>);

        inline bool automation_playback() const {
                return alist() ? alist()->automation_playback() : false;
        }

        inline bool automation_write() const {
                return alist() ? alist()->automation_write() : false;
        }

        inline AutoState automation_state() const {
                return alist() ? alist()->automation_state() : Off;
        }

        inline AutoStyle automation_style() const {
                return alist() ? alist()->automation_style() : Absolute;
        }

        void set_automation_state(AutoState as);
        void set_automation_style(AutoStyle as);
        void start_touch(double when);
        void stop_touch(bool mark, double when);

        void set_value (double);
        double get_value () const;

        double lower()   const { return _desc.lower; }
        double upper()   const { return _desc.upper; }
        double normal()  const { return _desc.normal; }
        bool   toggled() const { return _desc.toggled; }

        const ParameterDescriptor& desc() const { return _desc; }

        const ARDOUR::Session& session() const { return _session; }

protected:

        ARDOUR::Session& _session;

        const ParameterDescriptor _desc;
};


} // namespace ARDOUR

#endif /* __ardour_automation_control_h__ */