Tempo ramps - use consistent naming for _locked methods, use enum_2_string for TempoS...
[ardour.git] / libs / ardour / ardour / tempo.h
index 8fa5ed45a0242104f51d9fe78bafee09ae3d687f..bc52c489024bab747964fb5538a418e6bcdbbdb3 100644 (file)
 #include <glibmm/threads.h>
 
 #include "pbd/undo.h"
+
 #include "pbd/stateful.h"
 #include "pbd/statefuldestructible.h"
 
-#include "evoral/types.hpp"
+#include "evoral/Beats.hpp"
 
 #include "ardour/ardour.h"
 
@@ -47,11 +48,20 @@ class TempoMap;
 /** Tempo, the speed at which musical time progresses (BPM). */
 class LIBARDOUR_API Tempo {
   public:
+       /**
+        * @param bpm Beats Per Minute
+        * @param type Note Type (default `4': quarter note)
+        */
        Tempo (double bpm, double type=4.0) // defaulting to quarter note
                : _beats_per_minute (bpm), _note_type(type) {}
 
-       double beats_per_minute () const { return _beats_per_minute;}
+       double beats_per_minute () const { return _beats_per_minute; }
+
+       double ticks_per_minute () const { return _beats_per_minute * Timecode::BBT_Time::ticks_per_beat;}
        double note_type () const { return _note_type;}
+       /** audio samples per beat
+        * @param sr samplerate
+        */
        double frames_per_beat (framecnt_t sr) const {
                return (60.0 * sr) / _beats_per_minute;
        }
@@ -89,26 +99,23 @@ class LIBARDOUR_API Meter {
 /** A section of timeline with a certain Tempo or Meter. */
 class LIBARDOUR_API MetricSection {
   public:
-       MetricSection (const Timecode::BBT_Time& start)
-               : _start (start), _frame (0), _movable (true) {}
-       MetricSection (framepos_t start)
-               : _frame (start), _movable (true) {}
+       MetricSection (double beat)
+               : _beat (beat), _frame (0), _movable (true), _position_lock_style (MusicTime) {}
+       MetricSection (framepos_t frame)
+               : _beat (0), _frame (frame), _movable (true), _position_lock_style (MusicTime) {}
 
        virtual ~MetricSection() {}
 
-       const Timecode::BBT_Time& start() const { return _start; }
-       framepos_t                frame() const { return _frame; }
-
-       void set_movable (bool yn) { _movable = yn; }
-       bool movable() const { return _movable; }
+       const double& beat () const { return _beat; }
+       void set_beat (double beat) { _beat = beat;}
 
+       framepos_t frame() const { return _frame; }
        virtual void set_frame (framepos_t f) {
                _frame = f;
        }
 
-       virtual void set_start (const Timecode::BBT_Time& w) {
-               _start = w;
-       }
+       void set_movable (bool yn) { _movable = yn; }
+       bool movable() const { return _movable; }
 
        /* MeterSections are not stateful in the full sense,
           but we do want them to control their own
@@ -116,33 +123,51 @@ class LIBARDOUR_API MetricSection {
        */
        virtual XMLNode& get_state() const = 0;
 
-  private:
-       Timecode::BBT_Time _start;
+       PositionLockStyle position_lock_style () const { return _position_lock_style; }
+       void set_position_lock_style (PositionLockStyle ps) { _position_lock_style = ps; }
+
+private:
+       double             _beat;
        framepos_t         _frame;
        bool               _movable;
+       PositionLockStyle  _position_lock_style;
 };
 
 /** A section of timeline with a certain Meter. */
 class LIBARDOUR_API MeterSection : public MetricSection, public Meter {
   public:
-       MeterSection (const Timecode::BBT_Time& start, double bpb, double note_type)
-               : MetricSection (start), Meter (bpb, note_type) {}
-       MeterSection (framepos_t start, double bpb, double note_type)
-               : MetricSection (start), Meter (bpb, note_type) {}
+       MeterSection (double beat, const Timecode::BBT_Time& bbt, double bpb, double note_type)
+               : MetricSection (beat), Meter (bpb, note_type), _bbt (bbt) {}
+       MeterSection (framepos_t frame, double bpb, double note_type)
+               : MetricSection (frame), Meter (bpb, note_type) {}
        MeterSection (const XMLNode&);
 
        static const std::string xml_state_node_name;
 
        XMLNode& get_state() const;
+
+       void set_beat (std::pair<double, Timecode::BBT_Time>& w) {
+               MetricSection::set_beat (w.first);
+               _bbt = w.second;
+       }
+
+       const Timecode::BBT_Time& bbt() const { return _bbt; }
+private:
+       Timecode::BBT_Time _bbt;
 };
 
 /** A section of timeline with a certain Tempo. */
 class LIBARDOUR_API TempoSection : public MetricSection, public Tempo {
   public:
-       TempoSection (const Timecode::BBT_Time& start, double qpm, double note_type)
-               : MetricSection (start), Tempo (qpm, note_type), _bar_offset (-1.0)  {}
-       TempoSection (framepos_t start, double qpm, double note_type)
-               : MetricSection (start), Tempo (qpm, note_type), _bar_offset (-1.0) {}
+       enum Type {
+               Ramp,
+               Constant,
+       };
+
+       TempoSection (const double& beat, double qpm, double note_type, Type tempo_type)
+               : MetricSection (beat), Tempo (qpm, note_type), _bar_offset (-1.0), _type (tempo_type)  {}
+       TempoSection (framepos_t frame, double qpm, double note_type, Type tempo_type)
+               : MetricSection (frame), Tempo (qpm, note_type), _bar_offset (-1.0), _type (tempo_type) {}
        TempoSection (const XMLNode&);
 
        static const std::string xml_state_node_name;
@@ -153,16 +178,52 @@ class LIBARDOUR_API TempoSection : public MetricSection, public Tempo {
        void update_bbt_time_from_bar_offset (const Meter&);
        double bar_offset() const { return _bar_offset; }
 
+       void set_type (Type type);
+       Type type () const { return _type; }
+
+       double tempo_at_frame (framepos_t frame, double end_bpm, framepos_t end_frame, framecnt_t frame_rate) const;
+       framepos_t frame_at_tempo (double tempo, double end_bpm, framepos_t end_frame, framecnt_t frame_rate) const;
+
+       double tick_at_frame (framepos_t frame, double end_bpm, framepos_t end_frame, framecnt_t frame_rate) const;
+       framepos_t frame_at_tick (double tick, double end_bpm, framepos_t end_frame, framecnt_t frame_rate) const;
+
+       double beat_at_frame (framepos_t frame, double end_bpm, framepos_t end_frame, framecnt_t frame_rate) const;
+       framepos_t frame_at_beat (double beat, double end_bpm, framepos_t end_frame, framecnt_t frame_rate) const;
+
+       Timecode::BBT_Time legacy_bbt () { return _legacy_bbt; }
+
   private:
+
+       framecnt_t minute_to_frame (double time, framecnt_t frame_rate) const;
+       double frame_to_minute (framecnt_t frame, framecnt_t frame_rate) const;
+
+       /*  tempo ramp functions. zero-based with time in minutes,
+        * 'tick tempo' in ticks per minute and tempo in bpm.
+        *  time relative to section start.
+        */
+       double c_func (double end_tpm, double end_time) const;
+       double a_func (double end_tpm, double c_func) const;
+
+       double tick_tempo_at_time (double time, double end_tpm, double end_time) const;
+       double time_at_tick_tempo (double tick_tempo, double end_tpm, double end_time) const;
+
+       double tick_at_time (double time, double end_tpm, double end_time) const;
+       double time_at_tick (double tick, double end_tpm, double end_time) const;
+
+       double beat_at_time (double time, double end_tpm, double end_time) const;
+       double time_at_beat (double beat, double end_tpm, double end_time) const;
+
        /* this value provides a fractional offset into the bar in which
           the tempo section is located in. A value of 0.0 indicates that
           it occurs on the first beat of the bar, a value of 0.5 indicates
           that it occurs halfway through the bar and so on.
-          
+
           this enables us to keep the tempo change at the same relative
           position within the bar if/when the meter changes.
        */
        double _bar_offset;
+       Type _type;
+       Timecode::BBT_Time _legacy_bbt;
 };
 
 typedef std::list<MetricSection*> Metrics;
@@ -178,7 +239,7 @@ class LIBARDOUR_API TempoMetric {
        void set_tempo (const Tempo& t)              { _tempo = &t; }
        void set_meter (const Meter& m)              { _meter = &m; }
        void set_frame (framepos_t f)                { _frame = f; }
-       void set_start (const Timecode::BBT_Time& t) { _start = t; }
+       void set_beat (const double& t)              { _beat = t; }
 
        void set_metric (const MetricSection* section) {
                const MeterSection* meter;
@@ -190,21 +251,24 @@ class LIBARDOUR_API TempoMetric {
                }
 
                set_frame(section->frame());
-               set_start(section->start());
+               set_beat(section->beat());
        }
 
        const Meter&              meter() const { return *_meter; }
        const Tempo&              tempo() const { return *_tempo; }
        framepos_t                frame() const { return _frame; }
-       const Timecode::BBT_Time& start() const { return _start; }
+       const double&             beat() const { return _beat; }
 
   private:
        const Meter*       _meter;
        const Tempo*       _tempo;
        framepos_t         _frame;
-       Timecode::BBT_Time _start;
+       double             _beat;
 };
 
+/** Tempo Map - mapping of timecode to musical time.
+ * convert audio-samples, sample-rate to Bar/Beat/Tick, Meter/Tempo
+ */
 class LIBARDOUR_API TempoMap : public PBD::StatefulDestructible
 {
   public:
@@ -221,86 +285,89 @@ class LIBARDOUR_API TempoMap : public PBD::StatefulDestructible
        struct BBTPoint {
                framepos_t          frame;
                const MeterSection* meter;
-               const TempoSection* tempo;
+               const Tempo* tempo;
                uint32_t            bar;
                uint32_t            beat;
-            
-               BBTPoint (const MeterSection& m, const TempoSection& t, framepos_t f,
+
+               BBTPoint (const MeterSection& m, const Tempo& t, framepos_t f,
                          uint32_t b, uint32_t e)
                        : frame (f), meter (&m), tempo (&t), bar (b), beat (e) {}
-               
+
                Timecode::BBT_Time bbt() const { return Timecode::BBT_Time (bar, beat, 0); }
                operator Timecode::BBT_Time() const { return bbt(); }
                operator framepos_t() const { return frame; }
                bool is_bar() const { return beat == 1; }
        };
 
-       typedef std::vector<BBTPoint> BBTPointList;
-
        template<class T> void apply_with_metrics (T& obj, void (T::*method)(const Metrics&)) {
                Glib::Threads::RWLock::ReaderLock lm (lock);
                (obj.*method)(metrics);
        }
 
-       void get_grid (BBTPointList::const_iterator&, BBTPointList::const_iterator&, 
+       void get_grid (std::vector<BBTPoint>&,
                       framepos_t start, framepos_t end);
-       
-       /* TEMPO- AND METER-SENSITIVE FUNCTIONS 
 
-          bbt_time(), bbt_time_rt(), frame_time() and bbt_duration_at()
+       /* TEMPO- AND METER-SENSITIVE FUNCTIONS
+
+          bbt_time(), beat_at_frame(), frame_at_beat(), tick_at_frame(),
+          frame_at_tick(),frame_time() and bbt_duration_at()
           are all sensitive to tempo and meter, and will give answers
           that align with the grid formed by tempo and meter sections.
-          
-          They SHOULD NOT be used to determine the position of events 
+
+          They SHOULD NOT be used to determine the position of events
           whose location is canonically defined in beats.
        */
 
        void bbt_time (framepos_t when, Timecode::BBT_Time&);
 
-       /* realtime safe variant of ::bbt_time(), will throw 
-          std::logic_error if the map is not large enough
-          to provide an answer.
-       */
-       void       bbt_time_rt (framepos_t when, Timecode::BBT_Time&);
+       double tick_at_frame (framecnt_t frame) const;
+       framecnt_t frame_at_tick (double tick) const;
+
+       double beat_at_frame (framecnt_t frame) const;
+       framecnt_t frame_at_beat (double beat) const;
+
        framepos_t frame_time (const Timecode::BBT_Time&);
        framecnt_t bbt_duration_at (framepos_t, const Timecode::BBT_Time&, int dir);
 
        /* TEMPO-SENSITIVE FUNCTIONS
-          
+
           These next 4 functions will all take tempo in account and should be
           used to determine position (and in the last case, distance in beats)
           when tempo matters but meter does not.
 
-          They SHOULD be used to determine the position of events 
+          They SHOULD be used to determine the position of events
           whose location is canonically defined in beats.
        */
 
        framepos_t framepos_plus_bbt (framepos_t pos, Timecode::BBT_Time b) const;
-       framepos_t framepos_plus_beats (framepos_t, Evoral::MusicalTime) const;
-       framepos_t framepos_minus_beats (framepos_t, Evoral::MusicalTime) const;
-       Evoral::MusicalTime framewalk_to_beats (framepos_t pos, framecnt_t distance) const;
+       framepos_t framepos_plus_beats (framepos_t, Evoral::Beats) const;
+       framepos_t framepos_minus_beats (framepos_t, Evoral::Beats) const;
+       Evoral::Beats framewalk_to_beats (framepos_t pos, framecnt_t distance) const;
 
        static const Tempo& default_tempo() { return _default_tempo; }
        static const Meter& default_meter() { return _default_meter; }
 
-       const Tempo& tempo_at (framepos_t) const;
+       const Tempo tempo_at (framepos_t) const;
+       double frames_per_beat_at (framepos_t, framecnt_t sr) const;
+
        const Meter& meter_at (framepos_t) const;
 
        const TempoSection& tempo_section_at (framepos_t) const;
+       const MeterSection& meter_section_at (framepos_t) const;
 
-       void add_tempo (const Tempo&, Timecode::BBT_Time where);
-       void add_meter (const Meter&, Timecode::BBT_Time where);
+       void add_tempo (const Tempo&, double where, TempoSection::Type type);
+       void add_meter (const Meter&, double beat, Timecode::BBT_Time where);
 
        void remove_tempo (const TempoSection&, bool send_signal);
        void remove_meter (const MeterSection&, bool send_signal);
 
-       void replace_tempo (const TempoSection&, const Tempo&, const Timecode::BBT_Time& where);
+       void replace_tempo (const TempoSection&, const Tempo&, const double& where, TempoSection::Type type);
+       void gui_set_tempo_frame (TempoSection&, framepos_t where, double beat);
        void replace_meter (const MeterSection&, const Meter&, const Timecode::BBT_Time& where);
 
-       framepos_t round_to_bar  (framepos_t frame, int dir);
-       framepos_t round_to_beat (framepos_t frame, int dir);
-       framepos_t round_to_beat_subdivision (framepos_t fr, int sub_num, int dir);
-       framepos_t round_to_tick (framepos_t frame, int dir);
+       framepos_t round_to_bar  (framepos_t frame, RoundMode dir);
+       framepos_t round_to_beat (framepos_t frame, RoundMode dir);
+       framepos_t round_to_beat_subdivision (framepos_t fr, int sub_num, RoundMode dir);
 
        void set_length (framepos_t frames);
 
@@ -323,46 +390,50 @@ class LIBARDOUR_API TempoMap : public PBD::StatefulDestructible
        void change_initial_tempo (double bpm, double note_type);
 
        void insert_time (framepos_t, framecnt_t);
+       bool remove_time (framepos_t where, framecnt_t amount);  //returns true if anything was moved
 
        int n_tempos () const;
        int n_meters () const;
 
        framecnt_t frame_rate () const { return _frame_rate; }
 
-  private:
+       PBD::Signal0<void> MetricPositionChanged;
+
+       double bbt_to_beats (Timecode::BBT_Time bbt);
+       Timecode::BBT_Time beats_to_bbt (double beats);
+
+private:
+       double bbt_to_beats_locked (Timecode::BBT_Time bbt);
+       Timecode::BBT_Time beats_to_bbt_locked (double beats);
 
        friend class ::BBTTest;
        friend class ::FrameposPlusBeatsTest;
        friend class ::TempoTest;
-       
+
        static Tempo    _default_tempo;
        static Meter    _default_meter;
 
        Metrics                       metrics;
        framecnt_t                    _frame_rate;
        mutable Glib::Threads::RWLock lock;
-       BBTPointList                  _map;
 
        void recompute_map (bool reassign_tempo_bbt, framepos_t end = -1);
-       void extend_map (framepos_t end);
-       void require_map_to (framepos_t pos);
-       void require_map_to (const Timecode::BBT_Time&);
-       void _extend_map (TempoSection* tempo, MeterSection* meter, 
-                         Metrics::iterator next_metric,
-                         Timecode::BBT_Time current, framepos_t current_frame, framepos_t end);
-
-       BBTPointList::const_iterator bbt_before_or_at (framepos_t);
-       BBTPointList::const_iterator bbt_before_or_at (const Timecode::BBT_Time&);
-       BBTPointList::const_iterator bbt_after_or_at (framepos_t);
-       
-       framepos_t round_to_type (framepos_t fr, int dir, BBTPointType);
-       void bbt_time (framepos_t, Timecode::BBT_Time&, const BBTPointList::const_iterator&);
-       framecnt_t bbt_duration_at_unlocked (const Timecode::BBT_Time& when, const Timecode::BBT_Time& bbt, int dir);
-       
+
+       framepos_t round_to_type (framepos_t fr, RoundMode dir, BBTPointType);
+
        const MeterSection& first_meter() const;
+       MeterSection&       first_meter();
        const TempoSection& first_tempo() const;
-       
+       TempoSection&       first_tempo();
+
        void do_insert (MetricSection* section);
+
+       void add_tempo_locked (const Tempo&, double where, bool recompute, TempoSection::Type type);
+       void add_meter_locked (const Meter&, double beat, Timecode::BBT_Time where, bool recompute);
+
+       bool remove_tempo_locked (const TempoSection&);
+       bool remove_meter_locked (const MeterSection&);
+
 };
 
 }; /* namespace ARDOUR */