X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;ds=sidebyside;f=libs%2Fardour%2Fardour%2Ftempo.h;h=8fa5ed45a0242104f51d9fe78bafee09ae3d687f;hb=5399425f534e2d96d07cf29f427bfa0f39d904b7;hp=cd6c51df86e9b4477c8da32a6f2892c01914f625;hpb=f135947606e8d8374ff5567cf4bb0e0450ed3f84;p=ardour.git diff --git a/libs/ardour/ardour/tempo.h b/libs/ardour/ardour/tempo.h index cd6c51df86..8fa5ed45a0 100644 --- a/libs/ardour/ardour/tempo.h +++ b/libs/ardour/ardour/tempo.h @@ -24,7 +24,7 @@ #include #include #include -#include +#include #include "pbd/undo.h" #include "pbd/stateful.h" @@ -34,6 +34,9 @@ #include "ardour/ardour.h" +class BBTTest; +class FrameposPlusBeatsTest; +class TempoTest; class XMLNode; namespace ARDOUR { @@ -41,21 +44,25 @@ namespace ARDOUR { class Meter; class TempoMap; -class Tempo { +/** Tempo, the speed at which musical time progresses (BPM). */ +class LIBARDOUR_API Tempo { public: 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 note_type () const { return _note_type;} - double frames_per_beat (framecnt_t sr) const; + double frames_per_beat (framecnt_t sr) const { + return (60.0 * sr) / _beats_per_minute; + } protected: double _beats_per_minute; double _note_type; }; -class Meter { +/** Meter, or time signature (beats per bar, and which note type is a beat). */ +class LIBARDOUR_API Meter { public: Meter (double dpb, double bt) : _divisions_per_bar (dpb), _note_type (bt) {} @@ -64,7 +71,7 @@ class Meter { double note_divisor() const { return _note_type; } double frames_per_bar (const Tempo&, framecnt_t sr) const; - double frames_per_division (const Tempo&, framecnt_t sr) const; + double frames_per_grid (const Tempo&, framecnt_t sr) const; protected: /** The number of divisions in a bar. This is a floating point value because @@ -79,7 +86,8 @@ class Meter { double _note_type; }; -class MetricSection { +/** 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) {} @@ -108,17 +116,14 @@ class MetricSection { */ virtual XMLNode& get_state() const = 0; - int compare (const MetricSection&) const; - bool operator== (const MetricSection& other) const; - bool operator!= (const MetricSection& other) const; - private: Timecode::BBT_Time _start; framepos_t _frame; bool _movable; }; -class MeterSection : public MetricSection, public Meter { +/** 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) {} @@ -131,7 +136,8 @@ class MeterSection : public MetricSection, public Meter { XMLNode& get_state() const; }; -class TempoSection : public MetricSection, public Tempo { +/** 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) {} @@ -161,21 +167,35 @@ class TempoSection : public MetricSection, public Tempo { typedef std::list 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. +/** Helper class to keep track of the Meter *AND* Tempo in effect + at a given point in time. */ -class TempoMetric { +class LIBARDOUR_API TempoMetric { public: - TempoMetric (const Meter& m, const Tempo& t) : _meter (&m), _tempo (&t), _frame (0) {} + 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_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; } + void set_metric (const MetricSection* section) { + const MeterSection* meter; + const TempoSection* tempo; + if ((meter = dynamic_cast(section))) { + set_meter(*meter); + } else if ((tempo = dynamic_cast(section))) { + set_tempo(*tempo); + } + + set_frame(section->frame()); + set_start(section->start()); + } + + 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: @@ -185,7 +205,7 @@ class TempoMetric { Timecode::BBT_Time _start; }; -class TempoMap : public PBD::StatefulDestructible +class LIBARDOUR_API TempoMap : public PBD::StatefulDestructible { public: TempoMap (framecnt_t frame_rate); @@ -199,36 +219,67 @@ class TempoMap : public PBD::StatefulDestructible }; struct BBTPoint { - BBTPointType type; - framepos_t frame; - const Meter* meter; - const Tempo* tempo; - uint32_t bar; - uint32_t beat; - - 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; } + framepos_t frame; + const MeterSection* meter; + const TempoSection* 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) {} + 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); + Glib::Threads::RWLock::ReaderLock lm (lock); + (obj.*method)(metrics); } - const BBTPointList& map() const { return _map ; } - void map (BBTPointList&, framepos_t start, framepos_t end); + void get_grid (BBTPointList::const_iterator&, BBTPointList::const_iterator&, + framepos_t start, framepos_t end); - void bbt_time (framepos_t when, Timecode::BBT_Time&); - framecnt_t frame_time (const Timecode::BBT_Time&); + /* 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. + */ + + 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; } @@ -237,11 +288,11 @@ class TempoMap : public PBD::StatefulDestructible 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&, Timecode::BBT_Time where); + void add_meter (const Meter&, Timecode::BBT_Time where); - void remove_tempo(const TempoSection&, bool send_signal); - void remove_meter(const MeterSection&, bool send_signal); + 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_meter (const MeterSection&, const Meter&, const Timecode::BBT_Time& where); @@ -260,12 +311,13 @@ class TempoMap : public PBD::StatefulDestructible void clear (); TempoMetric metric_at (Timecode::BBT_Time bbt) const; - TempoMetric metric_at (framepos_t) const; - framepos_t framepos_plus_bbt (framepos_t pos, Timecode::BBT_Time b); - framepos_t framepos_plus_beats (framepos_t, Evoral::MusicalTime); - framepos_t framepos_minus_beats (framepos_t, Evoral::MusicalTime); - Evoral::MusicalTime framewalk_to_beats (framepos_t pos, framecnt_t distance); + /** Return the TempoMetric at frame @p t, and point @p last to the latest + * metric change <= t, if it is non-NULL. + */ + TempoMetric metric_at (framepos_t, Metrics::const_iterator* last=NULL) const; + + Metrics::const_iterator metrics_end() { return metrics.end(); } void change_existing_tempo_at (framepos_t, double bpm, double note_type); void change_initial_tempo (double bpm, double note_type); @@ -278,42 +330,39 @@ 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; - mutable Glib::RWLock lock; - BBTPointList _map; + 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 require_map_to (framepos_t pos); - void require_map_to (const Timecode::BBT_Time&); - - BBTPointList::const_iterator bbt_before_or_at (framepos_t); - BBTPointList::const_iterator bbt_after_or_at (framepos_t); - BBTPointList::const_iterator bbt_point_for (const Timecode::BBT_Time&); - - void timestamp_metrics_from_audio_time (); - + 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_unlocked (framepos_t, Timecode::BBT_Time&); - - framecnt_t bbt_duration_at_unlocked (const Timecode::BBT_Time& when, const Timecode::BBT_Time& bbt, int dir); - + 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; - - int move_metric_section (MetricSection&, const Timecode::BBT_Time& to); + void do_insert (MetricSection* section); - - 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; }; }; /* namespace ARDOUR */