X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=libs%2Fardour%2Fardour%2Ftempo.h;h=15032b87419c6ff15414b4e60c4763b9d3839052;hb=04416e2d1df3cc8d9f014765e5ca5ce818b7b4d7;hp=21a1185725860fadab9f230e072d8ca31cc1719c;hpb=c2da4ec8f988f6f8b9e426b03222a2c687c72edb;p=ardour.git diff --git a/libs/ardour/ardour/tempo.h b/libs/ardour/ardour/tempo.h index 21a1185725..15032b8741 100644 --- a/libs/ardour/ardour/tempo.h +++ b/libs/ardour/ardour/tempo.h @@ -30,13 +30,21 @@ #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 (nframes_t sr, const Meter& meter) const; + double frames_per_beat (framecnt_t sr) const; protected: double _beats_per_minute; @@ -53,24 +61,23 @@ class Tempo { class Meter { public: - static const double ticks_per_beat; + Meter (double dpb, double bt) + : _divisions_per_bar (dpb), _note_type (bt) {} - Meter (double bpb, double bt) - : _beats_per_bar (bpb), _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&, nframes_t sr) const; + 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; @@ -78,24 +85,24 @@ class Meter { class MetricSection { public: - MetricSection (const BBT_Time& start) + MetricSection (const Timecode::BBT_Time& start) : _start (start), _frame (0), _movable (true) {} - MetricSection (nframes64_t start) + MetricSection (framepos_t start) : _frame (start), _movable (true) {} virtual ~MetricSection() {} - const BBT_Time& start() const { return _start; } - nframes64_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 (nframes64_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; } @@ -105,19 +112,17 @@ class MetricSection { */ virtual XMLNode& get_state() const = 0; - int compare (MetricSection *, bool) const; - private: - BBT_Time _start; - nframes64_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 (nframes64_t start, double bpb, double note_type) + MeterSection (framepos_t start, double bpb, double note_type) : MetricSection (start), Meter (bpb, note_type) {} MeterSection (const XMLNode&); @@ -128,15 +133,30 @@ class MeterSection : public MetricSection, public Meter { class TempoSection : public MetricSection, public Tempo { public: - TempoSection (const BBT_Time& start, double qpm, double note_type) - : MetricSection (start), Tempo (qpm, note_type) {} - TempoSection (nframes64_t start, double qpm, double note_type) - : MetricSection (start), Tempo (qpm, note_type) {} + 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) {} 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 Metrics; @@ -147,28 +167,28 @@ typedef std::list 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 (nframes64_t f) { _frame = f; } - void set_start (const BBT_Time& t) { _start = t; } - + 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; } - nframes64_t frame() const { return _frame; } - const BBT_Time& start() const { return _start; } - + framepos_t frame() const { return _frame; } + const Timecode::BBT_Time& start() const { return _start; } + private: - const Meter* _meter; - const Tempo* _tempo; - nframes64_t _frame; - BBT_Time _start; + const Meter* _meter; + const Tempo* _tempo; + framepos_t _frame; + Timecode::BBT_Time _start; }; class TempoMap : public PBD::StatefulDestructible { public: - TempoMap (nframes64_t frame_rate); + TempoMap (framecnt_t frame_rate); ~TempoMap(); /* measure-based stuff */ @@ -179,62 +199,89 @@ class TempoMap : public PBD::StatefulDestructible }; struct BBTPoint { - BBTPointType type; - nframes64_t frame; - const Meter* meter; - const Tempo* tempo; - uint32_t bar; - uint32_t beat; - - BBTPoint (const Meter& m, const Tempo& t, nframes64_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 BBTPointList; template 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 (nframes64_t start, nframes64_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 (nframes64_t when, BBT_Time&) const; - nframes64_t frame_time (const BBT_Time&) const; - nframes64_t bbt_duration_at (nframes64_t, const BBT_Time&, int dir) const; + 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_add (nframes64_t origin, BBT_Time& start, const BBT_Time& shift); + 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; } - const Tempo& tempo_at (nframes64_t) const; - const Meter& meter_at (nframes64_t) const; - - const TempoSection& tempo_section_at (nframes64_t); - - void add_tempo(const Tempo&, BBT_Time where); - void add_meter(const Meter&, BBT_Time where); + const Tempo& tempo_at (framepos_t) const; + const Meter& meter_at (framepos_t) const; - void add_tempo(const Tempo&, nframes64_t where); - void add_meter(const Meter&, nframes64_t where); + const TempoSection& tempo_section_at (framepos_t) const; - void move_tempo (TempoSection&, const BBT_Time& to); - void move_meter (MeterSection&, const BBT_Time& to); + void add_tempo(const Tempo&, Timecode::BBT_Time where); + void add_meter(const Meter&, Timecode::BBT_Time where); - 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); - nframes64_t round_to_bar (nframes64_t frame, int dir); - nframes64_t round_to_beat (nframes64_t frame, int dir); - nframes64_t round_to_beat_subdivision (nframes64_t fr, int sub_num, int dir); - nframes64_t round_to_tick (nframes64_t frame, int dir); + 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); - void set_length (nframes64_t frames); + void set_length (framepos_t frames); XMLNode& get_state (void); int set_state (const XMLNode&, int version); @@ -242,56 +289,60 @@ class TempoMap : public PBD::StatefulDestructible void dump (std::ostream&) const; void clear (); - TempoMetric metric_at (BBT_Time bbt) const; - TempoMetric metric_at (nframes64_t) const; - void bbt_time_with_metric (nframes64_t, BBT_Time&, const TempoMetric&) const; + TempoMetric metric_at (Timecode::BBT_Time bbt) const; + TempoMetric metric_at (framepos_t) const; - BBT_Time bbt_add (const BBT_Time&, const BBT_Time&, const TempoMetric&) const; - BBT_Time bbt_add (const BBT_Time& a, const BBT_Time& b) const; - BBT_Time bbt_subtract (const BBT_Time&, const BBT_Time&) const; - void change_existing_tempo_at (nframes64_t, double bpm, double note_type); + void change_existing_tempo_at (framepos_t, double bpm, double note_type); void change_initial_tempo (double bpm, double note_type); - void insert_time (nframes64_t, nframes64_t); + void insert_time (framepos_t, framecnt_t); int n_tempos () const; int n_meters () const; - nframes_t frame_rate () const { return _frame_rate; } + 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; - nframes_t _frame_rate; - nframes64_t last_bbt_when; - bool last_bbt_valid; - BBT_Time last_bbt; + Metrics metrics; + framecnt_t _frame_rate; mutable Glib::RWLock lock; - - void timestamp_metrics (bool use_bbt); - - nframes64_t round_to_type (nframes64_t fr, int dir, BBTPointType); - - nframes64_t frame_time_unlocked (const BBT_Time&) const; - - void bbt_time_unlocked (nframes64_t, BBT_Time&) const; - - nframes64_t bbt_duration_at_unlocked (const BBT_Time& when, const BBT_Time& bbt, int dir) const; - + 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); + const MeterSection& first_meter() const; const TempoSection& first_tempo() const; - - nframes64_t count_frames_between (const BBT_Time&, const BBT_Time&) const; - nframes64_t count_frames_between_metrics (const Meter&, const Tempo&, - const BBT_Time&, const BBT_Time&) const; - - int move_metric_section (MetricSection&, const 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__ */