X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=libs%2Fevoral%2Fevoral%2FControlList.hpp;h=8e72c21c48d7863c11c8e68c3a432e2334217d2d;hb=2f0dc088446d6fb4b7e58120f4faee951d6ac359;hp=cfb7564ab643d6642ef4fcd6e2fb0c754b80e588;hpb=15b5fce90480490455237da917167b0bcb5ce946;p=ardour.git diff --git a/libs/evoral/evoral/ControlList.hpp b/libs/evoral/evoral/ControlList.hpp index cfb7564ab6..8e72c21c48 100644 --- a/libs/evoral/evoral/ControlList.hpp +++ b/libs/evoral/evoral/ControlList.hpp @@ -1,5 +1,5 @@ /* This file is part of Evoral. - * Copyright (C) 2008 Dave Robillard + * Copyright (C) 2008 David Robillard * Copyright (C) 2000-2008 Paul Davis * * Evoral is free software; you can redistribute it and/or modify it under the @@ -21,26 +21,35 @@ #include #include +#include + #include #include -#include + +#include + #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 */ -struct ControlEvent { - ControlEvent (double w, double v) - : when (w), value (v), coeff (0) +class LIBEVORAL_API ControlEvent { +public: + ControlEvent (double w, double v) + : when (w), value (v), coeff (0) {} - ControlEvent (const ControlEvent& other) - : when (other.when), value (other.value), coeff (0) + ControlEvent (const ControlEvent& other) + : when (other.when), value (other.value), coeff (0) { if (other.coeff) { create_coeffs(); @@ -58,42 +67,34 @@ struct ControlEvent { coeff[0] = coeff[1] = coeff[2] = coeff[3] = 0.0; } - double when; - double value; - double* coeff; ///< double[4] allocated by Curve as needed + double when; + double value; + double* coeff; ///< double[4] allocated by Curve as needed }; - -/** Pool allocator for control lists that does not use a lock - * and allocates 8k blocks of new pointers at a time - */ -typedef boost::fast_pool_allocator< - ControlEvent*, - boost::default_user_allocator_new_delete, - boost::details::pool::null_mutex, - 8192> - ControlEventAllocator; - - /** A list (sequence) of time-stamped values for a control */ -class ControlList +class LIBEVORAL_API ControlList { public: - typedef std::list EventList; + typedef std::list EventList; typedef EventList::iterator iterator; typedef EventList::reverse_iterator reverse_iterator; 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 create(Parameter id); + virtual boost::shared_ptr create(const Parameter& id, const ParameterDescriptor& desc); + + void dump (std::ostream&); ControlList& operator= (const ControlList&); bool operator== (const ControlList&); + void copy_events (const ControlList&); virtual void freeze(); virtual void thaw (); @@ -102,7 +103,14 @@ public: 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::RWLock::ReaderLock lm (_lock); + return _events.empty() ? 0.0 : _events.back()->when; + } bool empty() const { return _events.empty(); } void reset_default (double val) { @@ -115,14 +123,19 @@ public: 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); - void rt_add (double when, double value); - 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 merge_nascent (double when); - void reset_range (double start, double end); void erase_range (double start, double end); void erase (iterator); void erase (iterator, iterator); @@ -130,11 +143,36 @@ public: bool move_ranges (std::list< RangeMove > const &); void modify (iterator, double, double); + /** 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 cut (double, double); boost::shared_ptr 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, float times); void set_yrange (double min, double max) { _min_yval = min; @@ -144,13 +182,23 @@ public: 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(); } iterator end() { return _events.end(); } const_iterator end() const { return _events.end(); } + reverse_iterator rbegin() { return _events.rbegin(); } + const_reverse_iterator rbegin() const { return _events.rbegin(); } + reverse_iterator rend() { return _events.rend(); } + const_reverse_iterator rend() const { return _events.rend(); } ControlEvent* back() { return _events.back(); } const ControlEvent* back() const { return _events.back(); } ControlEvent* front() { return _events.front(); } @@ -159,21 +207,27 @@ public: std::pair control_points_adjacent (double when); template void apply_to_points (T& obj, void (T::*method)(const ControlList&)) { - Glib::Mutex::Lock lm (_lock); + Glib::Threads::RWLock::WriterLock lm (_lock); (obj.*method)(*this); } - void set_max_xval (double); - double get_max_xval() const { return _max_xval; } - + /** 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::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::Mutex::Lock lm (_lock, Glib::TRY_LOCK); + Glib::Threads::RWLock::ReaderLock lm (_lock, Glib::Threads::TRY_LOCK); if ((ok = lm.locked())) { return unlocked_eval (where); @@ -201,10 +255,10 @@ public: }; 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::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; } @@ -234,19 +288,34 @@ public: 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 write_pass_finished (double when); + 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 Dirty; /** Emitted when our interpolation style changes */ PBD::Signal1 InterpolationChanged; - + + bool operator!= (ControlList const &) const; + + void invalidate_insert_iterator (); + protected: /** Called by unlocked_eval() to handle cases of 3 or more control points. */ @@ -257,6 +326,10 @@ protected: boost::shared_ptr 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); @@ -264,13 +337,14 @@ protected: mutable LookupCache _lookup_cache; mutable SearchCache _search_cache; + mutable Glib::Threads::RWLock _lock; + Parameter _parameter; + ParameterDescriptor _desc; InterpolationStyle _interpolation; EventList _events; - mutable Glib::Mutex _lock; int8_t _frozen; bool _changed_when_thawed; - double _max_xval; double _min_yval; double _max_yval; double _default_value; @@ -278,20 +352,14 @@ protected: Curve* _curve; - struct NascentInfo { - EventList events; - bool is_touch; - double start_time; - double end_time; - - NascentInfo (bool touching, double start = -1.0) - : is_touch (touching) - , start_time (start) - , end_time (-1.0) - {} - }; - - std::list nascent; + private: + iterator most_recent_insert_iterator; + double insert_position; + bool new_write_pass; + bool did_write_during_pass; + bool _in_write_pass; + void unlocked_invalidate_insert_iterator (); + void add_guard_point (double when); }; } // namespace Evoral