184 lines
5.9 KiB
C++
184 lines
5.9 KiB
C++
/*
|
|
* Copyright (C) 2007-2015 David Robillard <d@drobilla.net>
|
|
* Copyright (C) 2008-2017 Paul Davis <paul@linuxaudiosystems.com>
|
|
* Copyright (C) 2009-2012 Carl Hetherington <carl@carlh.net>
|
|
* Copyright (C) 2015-2019 Robin Gareus <robin@gareus.org>
|
|
* Copyright (C) 2015 Nick Mainsbridge <mainsbridge@gmail.com>
|
|
*
|
|
* 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.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
*/
|
|
|
|
#ifndef __ardour_automation_control_h__
|
|
#define __ardour_automation_control_h__
|
|
|
|
#include <map>
|
|
#include <memory>
|
|
|
|
#include <glibmm/threads.h>
|
|
|
|
#include "pbd/controllable.h"
|
|
|
|
#include "evoral/types.h"
|
|
#include "evoral/Control.h"
|
|
|
|
#include "ardour/automation_list.h"
|
|
#include "ardour/control_group_member.h"
|
|
#include "ardour/parameter_descriptor.h"
|
|
#include "ardour/session_handle.h"
|
|
|
|
#include "ardour/libardour_visibility.h"
|
|
|
|
namespace ARDOUR {
|
|
|
|
class Session;
|
|
class Automatable;
|
|
class ControlGroup;
|
|
|
|
/** A PBD::Controllable with associated automation data (AutomationList)
|
|
*/
|
|
class LIBARDOUR_API AutomationControl
|
|
: public PBD::Controllable
|
|
, public Evoral::Control
|
|
, public ControlGroupMember
|
|
, public SessionHandleRef
|
|
{
|
|
public:
|
|
AutomationControl(ARDOUR::Session&,
|
|
const Evoral::Parameter& parameter,
|
|
const ParameterDescriptor& desc,
|
|
std::shared_ptr<ARDOUR::AutomationList> l=std::shared_ptr<ARDOUR::AutomationList>(),
|
|
const std::string& name="",
|
|
PBD::Controllable::Flag flags=PBD::Controllable::Flag (0)
|
|
);
|
|
|
|
virtual ~AutomationControl ();
|
|
|
|
std::shared_ptr<AutomationList> alist() const {
|
|
return std::dynamic_pointer_cast<AutomationList>(_list);
|
|
}
|
|
|
|
void set_list (std::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;
|
|
}
|
|
|
|
void set_automation_state(AutoState as);
|
|
void start_touch(timepos_t const & when);
|
|
void stop_touch(timepos_t const & when);
|
|
|
|
/* inherited from PBD::Controllable. */
|
|
virtual double get_value () const;
|
|
virtual double get_save_value () const;
|
|
|
|
/* inherited from PBD::Controllable.
|
|
* Derived classes MUST call ::writable() to verify
|
|
* that writing to the parameter is legal at that time.
|
|
*/
|
|
void set_value (double value, PBD::Controllable::GroupControlDisposition group_override);
|
|
/* automation related value setting */
|
|
virtual bool writable () const;
|
|
/* Call to ::set_value() with no test for writable() because
|
|
* this is only used by automation playback.
|
|
*/
|
|
void set_value_unchecked (double val) {
|
|
actually_set_value (val, PBD::Controllable::NoGroup);
|
|
}
|
|
|
|
virtual void automation_run (samplepos_t start, pframes_t nframes);
|
|
|
|
double lower() const { return _desc.lower; }
|
|
double upper() const { return _desc.upper; }
|
|
double normal() const { return _desc.normal; }
|
|
bool toggled() const { return _desc.toggled; }
|
|
|
|
double internal_to_interface (double, bool rotary = false) const;
|
|
double interface_to_internal (double, bool rotary = false) const;
|
|
|
|
virtual std::string get_user_string() const;
|
|
|
|
const ParameterDescriptor& desc() const { return _desc; }
|
|
|
|
const ARDOUR::Session& session() const { return _session; }
|
|
void commit_transaction (bool did_write);
|
|
|
|
AutomationControlList grouped_controls () const;
|
|
|
|
void add_visually_linked_control (std::shared_ptr<AutomationControl> ctrl) {
|
|
_visually_linked_ctrls.push_back (ctrl);
|
|
}
|
|
|
|
void clear_visually_linked_control () {
|
|
_visually_linked_ctrls.clear ();
|
|
}
|
|
|
|
WeakAutomationControlList visually_linked_controls () const {
|
|
return _visually_linked_ctrls;
|
|
}
|
|
|
|
protected:
|
|
std::shared_ptr<ControlGroup> _group;
|
|
std::shared_ptr<ControlGroup> _pushed_group;
|
|
|
|
const ParameterDescriptor _desc;
|
|
|
|
bool check_rt (double val, Controllable::GroupControlDisposition gcd);
|
|
|
|
/* derived classes may reimplement this, but should either
|
|
call this explicitly inside their version OR make sure that the
|
|
Controllable::Changed signal is emitted when necessary.
|
|
*/
|
|
|
|
virtual void actually_set_value (double value, PBD::Controllable::GroupControlDisposition);
|
|
|
|
/* Session needs to call this method before it queues up the real
|
|
change for execution in a realtime context. C++ access control sucks.
|
|
*/
|
|
friend class Session;
|
|
/* this is what the session invokes */
|
|
void pre_realtime_queue_stuff (double new_value, PBD::Controllable::GroupControlDisposition);
|
|
/* this will be invoked in turn on behalf of the group or the control by itself */
|
|
virtual void do_pre_realtime_queue_stuff (double new_value) {}
|
|
|
|
void session_going_away ();
|
|
|
|
WeakAutomationControlList _visually_linked_ctrls;
|
|
|
|
private:
|
|
/* I am unclear on why we have to make ControlGroup a friend in order
|
|
to get access to the ::set_group() method when it is already
|
|
declared to be a friend in ControlGroupMember. Oh well.
|
|
*/
|
|
friend class ControlGroup;
|
|
void set_group (std::shared_ptr<ControlGroup>);
|
|
bool push_group (std::shared_ptr<ControlGroup>);
|
|
bool pop_group ();
|
|
PBD::ScopedConnection _state_changed_connection;
|
|
bool _no_session;
|
|
};
|
|
|
|
|
|
} // namespace ARDOUR
|
|
|
|
#endif /* __ardour_automation_control_h__ */
|