In export format dialog, show preview of generated part of description. Fix to #0004941
[ardour.git] / libs / ardour / ardour / tempo.h
index f4de25e711ae23637bc4e59f7084c15c49ed4226..15032b87419c6ff15414b4e60c4763b9d3839052 100644 (file)
 #include "pbd/stateful.h"
 #include "pbd/statefuldestructible.h"
 
+#include "evoral/types.hpp"
 
 #include "ardour/ardour.h"
 
 class XMLNode;
 
+class BBTTest;
+class FrameposPlusBeatsTest;
+class TempoTest;
+
 namespace ARDOUR {
+
 class Meter;
+class TempoMap;
+
 class Tempo {
   public:
        Tempo (double bpm, double type=4.0) // defaulting to quarter note
@@ -44,7 +52,7 @@ class Tempo {
 
        double beats_per_minute () const { return _beats_per_minute;}
        double note_type () const { return _note_type;}
-       double frames_per_beat (framecnt_t sr, const Meter& meter) const;
+       double frames_per_beat (framecnt_t sr) const;
 
   protected:
        double _beats_per_minute;
@@ -53,22 +61,23 @@ class Tempo {
 
 class Meter {
   public:
-       Meter (double bpb, double bt)
-               : _beats_per_bar (bpb), _note_type (bt) {}
+       Meter (double dpb, double bt)
+               : _divisions_per_bar (dpb), _note_type (bt) {}
 
-       double beats_per_bar () const { return _beats_per_bar; }
+       double divisions_per_bar () const { return _divisions_per_bar; }
        double note_divisor() const { return _note_type; }
 
        double frames_per_bar (const Tempo&, framecnt_t sr) const;
+       double frames_per_grid (const Tempo&, framecnt_t sr) const;
 
   protected:
-       /** The number of beats in a bar.  This is a real value because
+       /** The number of divisions in a bar.  This is a floating point value because
            there are musical traditions on our planet that do not limit
            themselves to integral numbers of beats per bar.
        */
-       double _beats_per_bar;
+       double _divisions_per_bar;
 
-       /** The type of "note" that a beat represents.  For example, 4.0 is
+       /** The type of "note" that a division represents.  For example, 4.0 is
            a quarter (crotchet) note, 8.0 is an eighth (quaver) note, etc.
        */
        double _note_type;
@@ -103,8 +112,6 @@ class MetricSection {
        */
        virtual XMLNode& get_state() const = 0;
 
-       int compare (MetricSection *, bool) const;
-
   private:
        Timecode::BBT_Time _start;
        framepos_t         _frame;
@@ -127,14 +134,29 @@ class MeterSection : public MetricSection, public Meter {
 class TempoSection : public MetricSection, public Tempo {
   public:
        TempoSection (const Timecode::BBT_Time& start, double qpm, double note_type)
-               : MetricSection (start), Tempo (qpm, 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) {}
+               : MetricSection (start), Tempo (qpm, note_type), _bar_offset (-1.0) {}
        TempoSection (const XMLNode&);
 
        static const std::string xml_state_node_name;
 
        XMLNode& get_state() const;
+
+       void update_bar_offset_from_bbt (const Meter&);
+       void update_bbt_time_from_bar_offset (const Meter&);
+       double bar_offset() const { return _bar_offset; }
+
+  private:
+       /* 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;
 };
 
 typedef std::list<MetricSection*> Metrics;
@@ -145,17 +167,17 @@ typedef std::list<MetricSection*> Metrics;
 class TempoMetric {
   public:
        TempoMetric (const Meter& m, const Tempo& t) : _meter (&m), _tempo (&t), _frame (0) {}
-       
+
        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; }
-       
+
        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; }
-       
+
   private:
        const Meter*       _meter;
        const Tempo*       _tempo;
@@ -177,30 +199,65 @@ class TempoMap : public PBD::StatefulDestructible
        };
 
        struct BBTPoint {
-               BBTPointType type;
-               framepos_t  frame;
-               const Meter* meter;
-               const Tempo* tempo;
-               uint32_t bar;
-               uint32_t beat;
-
-               BBTPoint (const Meter& m, const Tempo& t, framepos_t f,
-                               BBTPointType ty, uint32_t b, uint32_t e)
-                       : type (ty), frame (f), meter (&m), tempo (&t), bar (b), beat (e) {}
+            framepos_t  frame;
+            const MeterSection* meter;
+            const TempoSection* tempo;
+            uint32_t bar;
+            uint32_t beat;
+            
+            BBTPoint (const MeterSection& m, const TempoSection& 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::RWLock::ReaderLock lm (lock);
-               (obj.*method)(*metrics);
+               (obj.*method)(metrics);
        }
 
-       BBTPointList *get_points (framepos_t start, framepos_t end) const;
+       void get_grid (BBTPointList::const_iterator&, BBTPointList::const_iterator&, 
+                      framepos_t start, framepos_t end);
+       
+       /* TEMPO- AND METER-SENSITIVE FUNCTIONS 
+
+          bbt_time(), bbt_time_rt(), 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 
+          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&);
+        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 
+          whose location is canonically defined in beats.
+       */
 
-       void      bbt_time (framepos_t when, Timecode::BBT_Time&) const;
-       framecnt_t frame_time (const Timecode::BBT_Time&) const;
-       framecnt_t bbt_duration_at (framepos_t, const Timecode::BBT_Time&, int dir) const;
+       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;
 
        static const Tempo& default_tempo() { return _default_tempo; }
        static const Meter& default_meter() { return _default_meter; }
@@ -213,17 +270,11 @@ class TempoMap : public PBD::StatefulDestructible
        void add_tempo(const Tempo&, Timecode::BBT_Time where);
        void add_meter(const Meter&, Timecode::BBT_Time where);
 
-       void add_tempo(const Tempo&, framepos_t where);
-       void add_meter(const Meter&, framepos_t where);
-
-       void move_tempo (TempoSection&, const Timecode::BBT_Time& to);
-       void move_meter (MeterSection&, const Timecode::BBT_Time& to);
-
-       void remove_tempo(const TempoSection&);
-       void remove_meter(const MeterSection&);
+       void remove_tempo(const TempoSection&, bool send_signal);
+       void remove_meter(const MeterSection&, bool send_signal);
 
-       void replace_tempo (TempoSection& existing, const Tempo& replacement);
-       void replace_meter (MeterSection& existing, const Meter& replacement);
+       void replace_tempo (const TempoSection&, const Tempo&, const Timecode::BBT_Time& where);
+       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);
@@ -240,14 +291,7 @@ class TempoMap : public PBD::StatefulDestructible
 
        TempoMetric metric_at (Timecode::BBT_Time bbt) const;
        TempoMetric metric_at (framepos_t) const;
-       void bbt_time_with_metric (framepos_t, Timecode::BBT_Time&, const TempoMetric&) const;
 
-       Timecode::BBT_Time bbt_add (const Timecode::BBT_Time&, const Timecode::BBT_Time&, const TempoMetric&) const;
-       Timecode::BBT_Time bbt_add (const Timecode::BBT_Time& a, const Timecode::BBT_Time& b) const;
-       Timecode::BBT_Time bbt_subtract (const Timecode::BBT_Time&, const Timecode::BBT_Time&) const;
-
-        framepos_t framepos_plus_bbt (framepos_t pos, Timecode::BBT_Time b) const;
-        double framewalk_to_beats (framepos_t pos, framecnt_t distance) const;
 
        void change_existing_tempo_at (framepos_t, double bpm, double note_type);
        void change_initial_tempo (double bpm, double note_type);
@@ -260,37 +304,45 @@ class TempoMap : public PBD::StatefulDestructible
        framecnt_t frame_rate () const { return _frame_rate; }
 
   private:
+
+       friend class ::BBTTest;
+       friend class ::FrameposPlusBeatsTest;
+       friend class ::TempoTest;
+       
        static Tempo    _default_tempo;
        static Meter    _default_meter;
 
-       Metrics*             metrics;
-       framecnt_t           _frame_rate;
-       framepos_t           last_bbt_when;
-       bool                 last_bbt_valid;
-       Timecode::BBT_Time   last_bbt;
+       Metrics              metrics;
+       framecnt_t          _frame_rate;
        mutable Glib::RWLock lock;
-
-       void timestamp_metrics (bool use_bbt);
-
+       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);
-
-       framepos_t frame_time_unlocked (const Timecode::BBT_Time&) const;
-
-       void bbt_time_unlocked (framepos_t, Timecode::BBT_Time&) const;
-
-       framecnt_t bbt_duration_at_unlocked (const Timecode::BBT_Time& when, const Timecode::BBT_Time& bbt, int dir) const;
-
+        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);
+       
        const MeterSection& first_meter() const;
        const TempoSection& first_tempo() const;
-
-       framecnt_t count_frames_between (const Timecode::BBT_Time&, const Timecode::BBT_Time&) const;
-       framecnt_t count_frames_between_metrics (const Meter&, const Tempo&,
-                                                const Timecode::BBT_Time&, const Timecode::BBT_Time&) const;
-
-       int move_metric_section (MetricSection&, const Timecode::BBT_Time& to);
-       void do_insert (MetricSection* section, bool with_bbt);
+       
+       void do_insert (MetricSection* section);
 };
 
 }; /* namespace ARDOUR */
 
+std::ostream& operator<< (std::ostream&, const ARDOUR::Meter&);
+std::ostream& operator<< (std::ostream&, const ARDOUR::Tempo&);
+std::ostream& operator<< (std::ostream&, const ARDOUR::MetricSection&);
+
 #endif /* __ardour_tempo_h__ */