Keep track of MIDI region's start positions in beats, to
[ardour.git] / libs / ardour / ardour / tempo.h
index 5e3e93e48b8595ac6f2be64b2435d16a9f59d343..05d65602cf841fb71d2e20a163b14862f3210820 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2000 Paul Davis 
+    Copyright (C) 2000 Paul Davis
 
     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
 #include <cmath>
 #include <glibmm/thread.h>
 
-#include <pbd/undo.h>
-#include <pbd/stateful.h> 
-#include <pbd/statefuldestructible.h> 
+#include "pbd/undo.h"
+#include "pbd/stateful.h"
+#include "pbd/statefuldestructible.h"
 
-#include <sigc++/signal.h>
+#include "evoral/types.hpp"
 
-#include <ardour/ardour.h>
+#include "ardour/ardour.h"
 
 class XMLNode;
 
-using std::list;
-using std::vector;
-
 namespace ARDOUR {
-
+class Meter;
 class Tempo {
   public:
-       Tempo (double bpm)
-               : _beats_per_minute (bpm) {}
-       Tempo (const Tempo& other) {
-               _beats_per_minute = other._beats_per_minute;
-       }
-       void operator= (const Tempo& other) {
-               if (&other != this) {
-                       _beats_per_minute = other._beats_per_minute;
-               }
-       }
+       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 frames_per_beat (nframes_t sr) const {
-               return  ((60.0 * sr) / _beats_per_minute);
-       }
+       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;
 
   protected:
        double _beats_per_minute;
+       double _note_type;
 };
 
 class Meter {
   public:
-       static const double ticks_per_beat;
-
-       Meter (double bpb, double bt) 
+       Meter (double bpb, double bt)
                : _beats_per_bar (bpb), _note_type (bt) {}
-       Meter (const Meter& other) {
-               _beats_per_bar = other._beats_per_bar;
-               _note_type = other._note_type;
-       }
-       void operator= (const Meter& other) {
-               if (&other != this) {
-                       _beats_per_bar = other._beats_per_bar;
-                       _note_type = other._note_type;
-               }
-       }
 
        double beats_per_bar () const { return _beats_per_bar; }
        double note_divisor() const { return _note_type; }
-       
-       double frames_per_bar (const Tempo&, nframes_t sr) const;
 
-  protected:
+       double frames_per_bar (const Tempo&, framecnt_t sr) const;
 
-       /* this is the number of beats in a bar. it is a real value
-          because there are musical traditions on our planet
-          that do not limit themselves to integral numbers of beats
-          per bar.
+  protected:
+       /** The number of beats in a bar.  This is a real 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;
 
-       /* this is the type of "note" that a beat represents. for example,
-          4.0 would be a quarter (crotchet) note, 8.0 would be an eighth 
-          (quaver) note, etc.
+       /** The type of "note" that a beat represents.  For example, 4.0 is
+           a quarter (crotchet) note, 8.0 is an eighth (quaver) note, etc.
        */
-
        double _note_type;
 };
 
 class MetricSection {
   public:
-       MetricSection (const BBT_Time& start)
+       MetricSection (const Timecode::BBT_Time& start)
                : _start (start), _frame (0), _movable (true) {}
+       MetricSection (framepos_t start)
+               : _frame (start), _movable (true) {}
+
        virtual ~MetricSection() {}
 
-       const BBT_Time& start() const { return _start; }
-       const nframes_t frame() const { return _frame; }
+       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; }
 
-       virtual void set_frame (nframes_t f) {
+       virtual void set_frame (framepos_t f) {
                _frame = f;
-       };
+       }
 
-       virtual void set_start (const BBT_Time& w) {
+       virtual void set_start (const Timecode::BBT_Time& w) {
                _start = w;
        }
 
@@ -127,44 +102,72 @@ class MetricSection {
           but we do want them to control their own
           XML state information.
        */
-
        virtual XMLNode& get_state() const = 0;
 
+       int compare (MetricSection *, bool) const;
+
   private:
-       BBT_Time       _start;
-       nframes_t _frame;
-       bool           _movable;
+       Timecode::BBT_Time _start;
+       framepos_t         _frame;
+       bool               _movable;
 };
 
 class MeterSection : public MetricSection, public Meter {
   public:
-       MeterSection (const BBT_Time& start, double bpb, double note_type)
+       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 (const XMLNode&);
 
-       static const string xml_state_node_name;
+       static const std::string xml_state_node_name;
 
        XMLNode& get_state() const;
 };
 
 class TempoSection : public MetricSection, public Tempo {
   public:
-       TempoSection (const BBT_Time& start, double qpm)
-               : MetricSection (start), Tempo (qpm) {}
+       TempoSection (const Timecode::BBT_Time& start, double qpm, double note_type)
+               : MetricSection (start), Tempo (qpm, note_type) {}
+       TempoSection (framepos_t start, double qpm, double note_type)
+               : MetricSection (start), Tempo (qpm, note_type) {}
        TempoSection (const XMLNode&);
 
-       static const string xml_state_node_name;
+       static const std::string xml_state_node_name;
 
        XMLNode& get_state() const;
 };
 
-typedef list<MetricSection*> Metrics;
+typedef std::list<MetricSection*> Metrics;
+
+/** Helper class that we use to be able to keep track of which
+    meter *AND* tempo are in effect at a given point in time.
+*/
+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;
+       framepos_t         _frame;
+       Timecode::BBT_Time _start;
+};
 
 class TempoMap : public PBD::StatefulDestructible
 {
   public:
-
-       TempoMap (nframes_t frame_rate);
+       TempoMap (framecnt_t frame_rate);
        ~TempoMap();
 
        /* measure-based stuff */
@@ -175,128 +178,120 @@ class TempoMap : public PBD::StatefulDestructible
        };
 
        struct BBTPoint {
-           BBTPointType type;
-           nframes_t frame;
-           const Meter* meter;
-           const Tempo* tempo;
-           uint32_t bar;
-           uint32_t beat;
-           
-           BBTPoint (const Meter& m, const Tempo& t, nframes_t f, BBTPointType ty, uint32_t b, uint32_t e) 
-                   : type (ty), frame (f), meter (&m), tempo (&t), bar (b), beat (e) {}
+               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) {}
        };
 
-       typedef vector<BBTPoint> BBTPointList;
-       
+       typedef std::vector<BBTPoint> BBTPointList;
+
        template<class T> void apply_with_metrics (T& obj, void (T::*method)(const Metrics&)) {
-               Glib::RWLock::ReaderLock lm (lock);
+               Glib::RWLock::ReaderLock lm (lock);
                (obj.*method)(*metrics);
        }
 
-       BBTPointList *get_points (nframes_t start, nframes_t end) const;
+       BBTPointList *get_points (framepos_t start, framepos_t end) const;
 
-       void           bbt_time (nframes_t when, BBT_Time&) const;
-       nframes_t frame_time (const BBT_Time&) const;
-       nframes_t bbt_duration_at (nframes_t, const BBT_Time&, int dir) const;
+       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;
 
        static const Tempo& default_tempo() { return _default_tempo; }
        static const Meter& default_meter() { return _default_meter; }
 
-       const Tempo& tempo_at (nframes_t);
-       const Meter& meter_at (nframes_t);
+       const Tempo& tempo_at (framepos_t) const;
+       const Meter& meter_at (framepos_t) const;
+
+       const TempoSection& tempo_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&, BBT_Time where);
-       void add_meter(const Meter&, 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 move_tempo (TempoSection&, const BBT_Time& to);
-       void move_meter (MeterSection&, const BBT_Time& to);
-       
        void remove_tempo(const TempoSection&);
        void remove_meter(const MeterSection&);
 
        void replace_tempo (TempoSection& existing, const Tempo& replacement);
        void replace_meter (MeterSection& existing, const Meter& replacement);
 
+       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);
 
-       nframes_t round_to_bar  (nframes_t frame, int dir);
-
-       nframes_t round_to_beat (nframes_t frame, int dir);
-
-       nframes_t round_to_beat_subdivision (nframes_t fr, int sub_num);
-
-       nframes_t round_to_tick (nframes_t frame, int dir);
-
-       void set_length (nframes_t frames);
+       void set_length (framepos_t frames);
 
        XMLNode& get_state (void);
-       int set_state (const XMLNode&);
+       int set_state (const XMLNode&, int version);
 
        void dump (std::ostream&) const;
        void clear ();
 
-       /* this is a helper class that we use to be able to keep
-          track of which meter *AND* tempo are in effect at
-          a given point in time.
-       */
+       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;
 
-       class Metric {
-         public:
-               Metric (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 (nframes_t f)  { _frame = f; }
-               void set_start (const BBT_Time& t) { _start = t; }
-               
-               const Meter&    meter() const { return *_meter; }
-               const Tempo&    tempo() const { return *_tempo; }
-               nframes_t  frame() const { return _frame; }
-               const BBT_Time& start() const { return _start; }
-               
-         private:
-               const Meter*   _meter;
-               const Tempo*   _tempo;
-               nframes_t _frame;
-               BBT_Time       _start;
-               
-       };
+       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;
+       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;
+
+       void change_existing_tempo_at (framepos_t, double bpm, double note_type);
+       void change_initial_tempo (double bpm, double note_type);
+
+       void insert_time (framepos_t, framecnt_t);
 
-       Metric metric_at (BBT_Time bbt) const;
-       Metric metric_at (nframes_t) const;
-        void bbt_time_with_metric (nframes_t, BBT_Time&, const Metric&) const;
+       int n_tempos () const;
+       int n_meters () const;
 
-       sigc::signal<void,ARDOUR::Change> StateChanged;
+       framecnt_t frame_rate () const { return _frame_rate; }
 
   private:
        static Tempo    _default_tempo;
        static Meter    _default_meter;
 
-       Metrics            *metrics;
-       nframes_t     _frame_rate;
-       nframes_t      last_bbt_when;
-       bool                last_bbt_valid;
-       BBT_Time            last_bbt;
-       mutable Glib::RWLock    lock;
-       
-       void timestamp_metrics ();
+       Metrics*             metrics;
+       framecnt_t           _frame_rate;
+       framepos_t           last_bbt_when;
+       bool                 last_bbt_valid;
+       Timecode::BBT_Time   last_bbt;
+       mutable Glib::RWLock lock;
 
+       void timestamp_metrics (bool use_bbt);
 
-       nframes_t round_to_type (nframes_t fr, int dir, BBTPointType);
+       framepos_t round_to_type (framepos_t fr, int dir, BBTPointType);
 
-       nframes_t frame_time_unlocked (const BBT_Time&) const;
+       framepos_t frame_time_unlocked (const Timecode::BBT_Time&) const;
 
-       void bbt_time_unlocked (nframes_t, BBT_Time&) const;
+       void bbt_time_unlocked (framepos_t, Timecode::BBT_Time&) const;
 
-       nframes_t bbt_duration_at_unlocked (const BBT_Time& when, const BBT_Time& bbt, int dir) const;
+       framecnt_t bbt_duration_at_unlocked (const Timecode::BBT_Time& when, const Timecode::BBT_Time& bbt, int dir) const;
 
        const MeterSection& first_meter() const;
        const TempoSection& first_tempo() const;
 
-       nframes_t count_frames_between (const BBT_Time&, const BBT_Time&) const;
-       nframes_t count_frames_between_metrics (const Meter&, const Tempo&, const BBT_Time&, const BBT_Time&) 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 BBT_Time& to);
-       void do_insert (MetricSection* section);
+       int move_metric_section (MetricSection&, const Timecode::BBT_Time& to);
+       void do_insert (MetricSection* section, bool with_bbt);
 };
 
 }; /* namespace ARDOUR */