Tempo ramps - use consistent naming for _locked methods, use enum_2_string for TempoS...
[ardour.git] / libs / ardour / ardour / tempo.h
index 9a2248414224f1e778109ead4f039a4cdee0eb95..bc52c489024bab747964fb5538a418e6bcdbbdb3 100644 (file)
@@ -27,6 +27,7 @@
 #include <glibmm/threads.h>
 
 #include "pbd/undo.h"
+
 #include "pbd/stateful.h"
 #include "pbd/statefuldestructible.h"
 
@@ -54,7 +55,8 @@ class LIBARDOUR_API Tempo {
        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
@@ -97,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
@@ -124,38 +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:
-       enum TempoSectionType {
+       enum Type {
                Ramp,
                Constant,
        };
 
-       TempoSection (const Timecode::BBT_Time& start, double qpm, double note_type, TempoSectionType tempo_type)
-               : MetricSection (start), Tempo (qpm, note_type), _bar_offset (-1.0), _type (tempo_type)  {}
-       TempoSection (framepos_t start, double qpm, double note_type, TempoSectionType tempo_type)
-               : MetricSection (start), Tempo (qpm, note_type), _bar_offset (-1.0), _type (tempo_type) {}
+       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;
@@ -166,8 +178,8 @@ 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 (TempoSectionType type);
-       TempoSectionType type () const { return _type; }
+       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;
@@ -178,6 +190,8 @@ class LIBARDOUR_API TempoSection : public MetricSection, public Tempo {
        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;
@@ -188,10 +202,8 @@ class LIBARDOUR_API TempoSection : public MetricSection, public Tempo {
         *  time relative to section start.
         */
        double c_func (double end_tpm, double end_time) const;
-       double a_func (double begin_tpm, double end_tpm, double end_time) const;
+       double a_func (double end_tpm, double c_func) const;
 
-       double tempo_at_time (double time, double end_bpm, double end_time) const;
-       double time_at_tempo (double tempo, double end_bpm, double end_time) 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;
 
@@ -210,7 +222,8 @@ class LIBARDOUR_API TempoSection : public MetricSection, public Tempo {
           position within the bar if/when the meter changes.
        */
        double _bar_offset;
-       TempoSectionType _type;
+       Type _type;
+       Timecode::BBT_Time _legacy_bbt;
 };
 
 typedef std::list<MetricSection*> Metrics;
@@ -226,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;
@@ -238,19 +251,19 @@ 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.
@@ -340,16 +353,16 @@ class LIBARDOUR_API TempoMap : public PBD::StatefulDestructible
        const Meter& meter_at (framepos_t) const;
 
        const TempoSection& tempo_section_at (framepos_t) const;
-       TempoSection* tempo_section_after (framepos_t) const;
        const MeterSection& meter_section_at (framepos_t) const;
 
-       void add_tempo (const Tempo&, Timecode::BBT_Time where, TempoSection::TempoSectionType type);
-       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, TempoSection::TempoSectionType type);
+       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, RoundMode dir);
@@ -384,7 +397,14 @@ class LIBARDOUR_API TempoMap : public PBD::StatefulDestructible
 
        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;
@@ -399,10 +419,6 @@ class LIBARDOUR_API TempoMap : public PBD::StatefulDestructible
 
        void recompute_map (bool reassign_tempo_bbt, framepos_t end = -1);
 
-       void _extend_map (TempoSection* tempo, MeterSection* meter,
-                         Metrics::iterator next_metric,
-                         Timecode::BBT_Time current, framepos_t current_frame, framepos_t end);
-
        framepos_t round_to_type (framepos_t fr, RoundMode dir, BBTPointType);
 
        const MeterSection& first_meter() const;
@@ -410,13 +426,10 @@ class LIBARDOUR_API TempoMap : public PBD::StatefulDestructible
        const TempoSection& first_tempo() const;
        TempoSection&       first_tempo();
 
-       Timecode::BBT_Time beats_to_bbt (double beats);
-       int32_t bars_in_meter_section (MeterSection* ms) const;
-
        void do_insert (MetricSection* section);
 
-       void add_tempo_locked (const Tempo&, Timecode::BBT_Time where, bool recompute, TempoSection::TempoSectionType type);
-       void add_meter_locked (const Meter&, Timecode::BBT_Time where, bool recompute);
+       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&);