ControlList.h

Go to the documentation of this file.

/*
 * Copyright (C) 2008-2012 Carl Hetherington <carl@carlh.net>
 * Copyright (C) 2008-2014 Paul Davis <paul@linuxaudiosystems.com>
 * Copyright (C) 2008-2015 David Robillard <d@drobilla.net>
 * Copyright (C) 2012-2017 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 EVORAL_CONTROL_LIST_HPP
#define EVORAL_CONTROL_LIST_HPP
 
#include <cassert>
#include <list>
#include <stdint.h>
 
#include <boost/pool/pool.hpp>
#include <boost/pool/pool_alloc.hpp>
 
#include "pbd/rwlock.h"
#include "pbd/signals.h"
 
#include "temporal/domain_provider.h"
#include "temporal/domain_swap.h"
#include "temporal/timeline.h"
#include "temporal/types.h"
#include "temporal/range.h"
 
#include "evoral/visibility.h"
 
#include "evoral/Parameter.h"
#include "evoral/ParameterDescriptor.h"
 
namespace Evoral {
 
class Curve;
class TypeMap;
 
class LIBEVORAL_API ControlEvent {
public:
 
        ControlEvent (Temporal::timepos_t const & w, double v)
                : when (w), value (v), coeff (0)
        {}
 
        ControlEvent (const ControlEvent& other)
                : when (other.when), value (other.value), coeff (0)
        {
                if (other.coeff) {
                        create_coeffs();
                        for (size_t i = 0; i < 4; ++i)
                                coeff[i] = other.coeff[i];
                }
        }
 
        ~ControlEvent() { if (coeff) delete[] coeff; }
 
        void create_coeffs() {
                if (!coeff)
                        coeff = new double[4];
 
                coeff[0] = coeff[1] = coeff[2] = coeff[3] = 0.0;
        }
 
        Temporal::timepos_t when;
        double  value;
        double* coeff; 
};
 
 
class LIBEVORAL_API ControlList : public Temporal::TimeDomainProvider, public Temporal::TimeDomainSwapper
{
public:
        typedef std::list<ControlEvent*> 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, const ParameterDescriptor& desc, Temporal::TimeDomainProvider const &);
        ControlList (const ControlList&, Temporal::timepos_t const & start, Temporal::timepos_t const & end);
        ControlList (const ControlList&);
        virtual ~ControlList();
 
        virtual std::shared_ptr<ControlList> create(const Parameter& id, const ParameterDescriptor& desc, Temporal::TimeDomainProvider const &);
 
        void dump (std::ostream&);
 
        ControlList& operator= (const ControlList&);
        bool operator== (const ControlList&);
        void copy_events (const ControlList&);
 
        virtual void freeze();
        virtual void thaw ();
        bool frozen() const { return _frozen; }
 
        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(); }
 
        Temporal::timepos_t when (bool at_start) const {
                PBD::RWLock::ReaderLock lm (_lock);
                if (_events.empty()) {
                        return std::numeric_limits<Temporal::timepos_t>::min();
                }
                return at_start ? _events.front()->when : _events.back()->when;
        }
 
        Temporal::timecnt_t length() const {
                PBD::RWLock::ReaderLock lm (_lock);
                return _events.empty() ? std::numeric_limits<Temporal::timecnt_t>::min() : Temporal::timecnt_t (_events.back()->when);
        }
        bool empty() const { return _events.empty(); }
 
        void clear ();
        void x_scale (Temporal::ratio_t const &);
        bool extend_to (Temporal::timepos_t const & );
        void slide (iterator before, Temporal::timecnt_t const &  distance);
        void shift (Temporal::timepos_t const & before, Temporal::timecnt_t const & distance);
        void simple_shift (Temporal::timepos_t const & distance);
 
        void y_transform (std::function<double(double)> callback);
        void list_merge (ControlList const& other, std::function<double(double, double)> callback);
 
        virtual void add (Temporal::timepos_t const & when, double value, bool with_guards=true, bool with_initial=true);
 
        virtual bool editor_add (Temporal::timepos_t const & when, double value, bool with_guard);
 
        struct OrderedPoint {
                Temporal::timepos_t when;
                double value;
                OrderedPoint (Temporal::timepos_t const & t, double v) : when (t), value (v) {}
        };
        typedef std::vector<OrderedPoint> OrderedPoints;
 
        virtual bool editor_add_ordered (OrderedPoints const &, bool with_guard);
 
        /* to be used only for loading pre-sorted data from saved state */
        void fast_simple_add (Temporal::timepos_t const & when, double value);
 
        void erase_range (Temporal::timepos_t const & start , Temporal::timepos_t const & end);
        void erase (iterator);
        void erase (iterator, iterator);
        void erase (Temporal::timepos_t const &, double);
        bool move_ranges (std::list<Temporal::RangeMove> const &);
        void modify (iterator, Temporal::timepos_t const &, double);
 
        void thin (double thinning_factor);
 
        std::shared_ptr<ControlList> cut (Temporal::timepos_t const &, Temporal::timepos_t const &);
        std::shared_ptr<ControlList> copy (Temporal::timepos_t const &, Temporal::timepos_t const &);
 
        bool has_event_at (Temporal::timepos_t const &) const;
 
        void clear (Temporal::timepos_t const & start, Temporal::timepos_t const & end);
 
        bool paste (const ControlList&, Temporal::timepos_t const &);
 
        void truncate_end (Temporal::timepos_t const & last_coordinate);
 
        void truncate_start (Temporal::timecnt_t const & 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(); }
        const ControlEvent* front() const { return _events.front(); }
 
        std::pair<ControlList::iterator,ControlList::iterator> control_points_adjacent (Temporal::timepos_t const & when);
 
        template<class T> void apply_to_points (T& obj, void (T::*method)(const ControlList&)) {
                PBD::RWLock::WriterLock lm (_lock);
                (obj.*method)(*this);
        }
 
        double eval (Temporal::timepos_t const & where) const {
                PBD::RWLock::ReaderLock lm (_lock);
                return unlocked_eval (where);
        }
 
        double rt_safe_eval (Temporal::timepos_t const & where, bool& ok) const {
 
                PBD::RWLock::ReaderLock lm (_lock, PBD::RWLock::TryLock);
 
                if ((ok = lm.locked())) {
                        return unlocked_eval (where);
                } else {
                        return 0.0;
                }
        }
 
        static inline bool time_comparator (const ControlEvent* a, const ControlEvent* b) {
                return a->when < b->when;
        }
 
        struct LookupCache {
                LookupCache() : left (std::numeric_limits<Temporal::timepos_t>::max()) {}
                Temporal::timepos_t left;  /* leftmost x coordinate used when finding "range" */
                std::pair<ControlList::const_iterator,ControlList::const_iterator> range;
        };
 
        struct SearchCache {
                SearchCache () : left (std::numeric_limits<Temporal::timepos_t>::max()) {}
                Temporal::timepos_t left;  /* leftmost x coordinate used when finding "first" */
                ControlList::const_iterator first;
        };
 
        const EventList& events() const { return _events; }
 
        // FIXME: const violations for Curve
        PBD::RWLock& lock()         const { return _lock; }
        LookupCache& lookup_cache() const { return _lookup_cache; }
        SearchCache& search_cache() const { return _search_cache; }
 
        double unlocked_eval (Temporal::timepos_t const & x) const;
 
        bool rt_safe_earliest_event_discrete_unlocked (Temporal::timepos_t const & start, Temporal::timepos_t & x, double& y, bool inclusive) const;
        bool rt_safe_earliest_event_linear_unlocked (Temporal::timepos_t const & start, Temporal::timepos_t & x, double& y, bool inclusive, Temporal::timecnt_t min_x_delta = Temporal::timecnt_t::max()) const;
 
        void create_curve();
        void destroy_curve();
 
        Curve&       curve()       { assert(_curve); return *_curve; }
        const Curve& curve() const { assert(_curve); return *_curve; }
 
        void mark_dirty () const;
 
        enum InterpolationStyle {
                Discrete,
                Linear,
                Curved, // spline, used for x-fades
                Logarithmic,
                Exponential // fader, gain
        };
 
        InterpolationStyle interpolation() const { return _interpolation; }
 
        virtual InterpolationStyle default_interpolation() const;
 
        bool 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 (Temporal::timepos_t const &);
        void write_pass_finished (Temporal::timepos_t const &, double thinning_factor=0.0);
        void set_in_write_pass (bool, bool add_point = false, Temporal::timepos_t = std::numeric_limits<Temporal::timepos_t>::min());
        bool in_write_pass () const;
        bool in_new_write_pass () { return new_write_pass; }
 
        PBD::Signal<void()> WritePassStarted;
        mutable PBD::Signal<void()> Dirty;
        PBD::Signal<void(InterpolationStyle)> InterpolationChanged;
 
        bool operator!= (ControlList const &) const;
 
        void invalidate_insert_iterator ();
 
        void start_domain_bounce (Temporal::DomainBounceInfo&);
        void finish_domain_bounce (Temporal::DomainBounceInfo&);
 
  protected:
 
        double multipoint_eval (Temporal::timepos_t const & x) const;
 
        void build_search_cache_if_necessary (Temporal::timepos_t const & start) const;
 
        std::shared_ptr<ControlList> cut_copy_clear (Temporal::timepos_t const &, Temporal::timepos_t const &, int op);
        bool erase_range_internal (Temporal::timepos_t const & start, Temporal::timepos_t const & end, EventList &);
 
        void     maybe_add_insert_guard (Temporal::timepos_t const & when);
        iterator erase_from_iterator_to (iterator iter, Temporal::timepos_t const & when);
        bool     maybe_insert_straight_line (Temporal::timepos_t const & when, double value);
 
        virtual void maybe_signal_changed ();
 
        void _x_scale (Temporal::ratio_t const &);
 
        mutable LookupCache   _lookup_cache;
        mutable SearchCache   _search_cache;
 
        mutable PBD::RWLock _lock;
 
        Parameter             _parameter;
        ParameterDescriptor   _desc;
        InterpolationStyle    _interpolation;
        EventList             _events;
        int8_t                _frozen;
        bool                  _changed_when_thawed;
        bool                  _sort_pending;
 
        Curve* _curve;
 
  private:
        iterator   most_recent_insert_iterator;
        Temporal::timepos_t insert_position;
        bool       new_write_pass;
        bool       did_write_during_pass;
        bool       _in_write_pass;
 
        void unlocked_remove_duplicates ();
        void unlocked_invalidate_insert_iterator ();
        void add_guard_point (Temporal::timepos_t const & when, Temporal::timecnt_t const & offset);
 
        bool is_sorted () const;
        Temporal::timepos_t ensure_time_domain (Temporal::timepos_t const & ) const;
 
};
 
} // namespace Evoral
 
#endif // EVORAL_CONTROL_LIST_HPP