#include <cassert>
#include <list>
+#include <stdint.h>
+
#include <boost/pool/pool.hpp>
#include <boost/pool/pool_alloc.hpp>
+
#include <glibmm/threads.h>
+
#include "pbd/signals.h"
-#include "evoral/types.hpp"
+
+#include "evoral/visibility.h"
#include "evoral/Range.hpp"
#include "evoral/Parameter.hpp"
+#include "evoral/ParameterDescriptor.hpp"
namespace Evoral {
class Curve;
+class TypeMap;
/** A single event (time-stamped value) for a control
*/
-class ControlEvent {
+class LIBEVORAL_API ControlEvent {
public:
ControlEvent (double w, double v)
: when (w), value (v), coeff (0)
/** A list (sequence) of time-stamped values for a control
*/
-class ControlList
+class LIBEVORAL_API ControlList
{
public:
typedef std::list<ControlEvent*> EventList;
typedef EventList::const_iterator const_iterator;
typedef EventList::const_reverse_iterator const_reverse_iterator;
- ControlList (const Parameter& id);
+ ControlList (const Parameter& id, const ParameterDescriptor& desc);
ControlList (const ControlList&);
ControlList (const ControlList&, double start, double end);
virtual ~ControlList();
- virtual boost::shared_ptr<ControlList> create(Parameter id);
+ virtual boost::shared_ptr<ControlList> create(const Parameter& id, const ParameterDescriptor& desc);
- void dump (std::ostream&);
+ void dump (std::ostream&);
ControlList& operator= (const ControlList&);
bool operator== (const ControlList&);
- void copy_events (const ControlList&);
+ void copy_events (const ControlList&);
virtual void freeze();
virtual void thaw ();
const Parameter& parameter() const { return _parameter; }
void set_parameter(const Parameter& p) { _parameter = p; }
+ const ParameterDescriptor& descriptor() const { return _desc; }
+ void set_descriptor(const ParameterDescriptor& d) { _desc = d; }
+
EventList::size_type size() const { return _events.size(); }
- double length() const {
- Glib::Threads::Mutex::Lock lm (_lock);
+ double length() const {
+ Glib::Threads::RWLock::ReaderLock lm (_lock);
return _events.empty() ? 0.0 : _events.back()->when;
}
bool empty() const { return _events.empty(); }
void slide (iterator before, double distance);
void shift (double before, double distance);
- virtual bool clamp_value (double& /*when*/, double& /*value*/) const { return true; }
+ /** add automation events
+ * @param when absolute time in samples
+ * @param value parameter value
+ * @param with_guards if true, add guard-points
+ * @param with_initial if true, add an initial point if the list is empty
+ */
+ virtual void add (double when, double value, bool with_guards=true, bool with_initial=true);
+
+ virtual bool editor_add (double when, double value, bool with_guard);
- virtual void add (double when, double value);
+ /* to be used only for loading pre-sorted data from saved state */
void fast_simple_add (double when, double value);
void erase_range (double start, double end);
bool move_ranges (std::list< RangeMove<double> > const &);
void modify (iterator, double, double);
- void thin ();
+ /** Thin the number of events in this list.
+ *
+ * The thinning factor corresponds to the area of a triangle computed
+ * between three points in the list (time-difference * value-difference).
+ * If the area is large, it indicates significant non-linearity between
+ * the points.
+ *
+ * Time is measured in samples, value is usually normalized to 0..1.
+ *
+ * During automation recording we thin the recorded points using this
+ * value. If a point is sufficiently co-linear with its neighbours (as
+ * defined by the area of the triangle formed by three of them), we will
+ * not include it in the list. The larger the value, the more points are
+ * excluded, so this effectively measures the amount of thinning to be
+ * done.
+ *
+ * @param thinning_factor area-size (default: 20)
+ */
+ void thin (double thinning_factor);
boost::shared_ptr<ControlList> cut (double, double);
boost::shared_ptr<ControlList> copy (double, double);
- void clear (double, double);
- bool paste (ControlList&, double position, float times);
+ /** remove all automation events between the given time range
+ * @param start start of range (inclusive) in audio samples
+ * @param end end of range (inclusive) in audio samples
+ */
+ void clear (double start, double end);
+
+ bool paste (const ControlList&, double position);
void set_yrange (double min, double max) {
_min_yval = min;
double get_max_y() const { return _max_yval; }
double get_min_y() const { return _min_yval; }
- void truncate_end (double length);
- void truncate_start (double length);
+ /** truncate the event list after the given time
+ * @param last_coordinate last event to include
+ */
+ void truncate_end (double last_coordinate);
+ /** truncate the event list to the given time
+ * @param overall_length overall length
+ */
+ void truncate_start (double overall_length);
iterator begin() { return _events.begin(); }
const_iterator begin() const { return _events.begin(); }
std::pair<ControlList::iterator,ControlList::iterator> control_points_adjacent (double when);
template<class T> void apply_to_points (T& obj, void (T::*method)(const ControlList&)) {
- Glib::Threads::Mutex::Lock lm (_lock);
+ Glib::Threads::RWLock::WriterLock lm (_lock);
(obj.*method)(*this);
}
+ /** query value at given time (takes a read-lock, not safe while writing automation)
+ * @param where absolute time in samples
+ * @returns parameter value
+ */
double eval (double where) {
- Glib::Threads::Mutex::Lock lm (_lock);
+ Glib::Threads::RWLock::ReaderLock lm (_lock);
return unlocked_eval (where);
}
+ /** realtime safe version of eval, may fail if read-lock cannot be taken
+ * @param where absolute time in samples
+ * @param ok boolean reference if returned value is valid
+ * @returns parameter value
+ */
double rt_safe_eval (double where, bool& ok) {
- Glib::Threads::Mutex::Lock lm (_lock, Glib::Threads::TRY_LOCK);
+ Glib::Threads::RWLock::ReaderLock lm (_lock, Glib::Threads::TRY_LOCK);
if ((ok = lm.locked())) {
return unlocked_eval (where);
};
const EventList& events() const { return _events; }
- double default_value() const { return _parameter.normal(); }
+ double default_value() const { return _default_value; }
// FIXME: const violations for Curve
- Glib::Threads::Mutex& lock() const { return _lock; }
+ Glib::Threads::RWLock& lock() const { return _lock; }
LookupCache& lookup_cache() const { return _lookup_cache; }
SearchCache& search_cache() const { return _search_cache; }
Curved
};
+ /** query interpolation style of the automation data
+ * @returns Interpolation Style
+ */
InterpolationStyle interpolation() const { return _interpolation; }
- void set_interpolation (InterpolationStyle);
+
+ /** set the interpolation style of the automation data
+ * @param is interpolation style
+ */
+ void set_interpolation (InterpolationStyle is);
virtual bool touching() const { return false; }
virtual bool writing() const { return false; }
virtual bool touch_enabled() const { return false; }
- void start_write_pass (double time);
- void write_pass_finished (double when);
- void set_in_write_pass (bool, bool add_point = false, double when = 0.0);
- bool in_write_pass () const;
+ void start_write_pass (double when);
+ void write_pass_finished (double when, double thinning_factor=0.0);
+ void set_in_write_pass (bool, bool add_point = false, double when = 0.0);
+ bool in_write_pass () const;
+ bool in_new_write_pass () { return new_write_pass; }
/** Emitted when mark_dirty() is called on this object */
mutable PBD::Signal0<void> Dirty;
/** Emitted when our interpolation style changes */
PBD::Signal1<void, InterpolationStyle> InterpolationChanged;
- static void set_thinning_factor (double d);
- static double thinning_factor() { return _thinning_factor; }
-
bool operator!= (ControlList const &) const;
- void invalidate_insert_iterator ();
+ void invalidate_insert_iterator ();
protected:
boost::shared_ptr<ControlList> cut_copy_clear (double, double, int op);
bool erase_range_internal (double start, double end, EventList &);
+ void maybe_add_insert_guard (double when);
+ iterator erase_from_iterator_to (iterator iter, double when);
+ bool maybe_insert_straight_line (double when, double value);
+
virtual void maybe_signal_changed ();
void _x_scale (double factor);
mutable LookupCache _lookup_cache;
mutable SearchCache _search_cache;
+ mutable Glib::Threads::RWLock _lock;
+
Parameter _parameter;
+ ParameterDescriptor _desc;
InterpolationStyle _interpolation;
EventList _events;
- mutable Glib::Threads::Mutex _lock;
int8_t _frozen;
bool _changed_when_thawed;
double _min_yval;
Curve* _curve;
- static double _thinning_factor;
-
private:
iterator most_recent_insert_iterator;
double insert_position;