/*
- 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
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
- $Id$
*/
#ifndef __ardour_tempo_h__
#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/state_manager.h>
+#include "ardour/ardour.h"
class XMLNode;
-using std::list;
-using std::vector;
+class BBTTest;
+class FrameposPlusBeatsTest;
+class TempoTest;
namespace ARDOUR {
+class Meter;
+class TempoMap;
+
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;
protected:
double _beats_per_minute;
+ double _note_type;
};
class Meter {
public:
- static const double ticks_per_beat;
-
- 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;
- }
- }
+ 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&, nframes_t sr) const;
- protected:
+ double frames_per_bar (const Tempo&, framecnt_t sr) const;
+ double frames_per_grid (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 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 _divisions_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 division 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;
}
but we do want them to control their own
XML state information.
*/
-
virtual XMLNode& get_state() const = 0;
+ int compare (const MetricSection&) const;
+ bool operator== (const MetricSection& other) const;
+ bool operator!= (const MetricSection& other) 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), _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 string xml_state_node_name;
+ 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 list<MetricSection*> Metrics;
+typedef std::list<MetricSection*> Metrics;
-#ifdef STATE_MANAGER
-class TempoMapState : public StateManager::State {
+/** 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:
- TempoMapState (std::string why)
- : StateManager::State (why) {
- metrics = new Metrics;
- }
+ 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; }
- Metrics *metrics;
+ private:
+ const Meter* _meter;
+ const Tempo* _tempo;
+ framepos_t _frame;
+ Timecode::BBT_Time _start;
};
-#endif
class TempoMap : public PBD::StatefulDestructible
{
public:
-
- TempoMap (nframes_t frame_rate);
+ TempoMap (framecnt_t frame_rate);
~TempoMap();
/* measure-based stuff */
};
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) {}
+ 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 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);
- (obj.*method)(*metrics);
+ Glib::RWLock::ReaderLock lm (lock);
+ (obj.*method)(metrics);
}
- BBTPointList *get_points (nframes_t start, nframes_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&);
+ framecnt_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 (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;
+ 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 (nframes_t);
- const Meter& meter_at (nframes_t);
+ const Tempo& tempo_at (framepos_t) const;
+ const Meter& meter_at (framepos_t) const;
- void add_tempo(const Tempo&, BBT_Time where);
- void add_meter(const Meter&, BBT_Time where);
-
- 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&);
+ const TempoSection& tempo_section_at (framepos_t) const;
- void replace_tempo (TempoSection& existing, const Tempo& replacement);
- void replace_meter (MeterSection& existing, const Meter& replacement);
+ 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);
- nframes_t round_to_bar (nframes_t frame, int dir);
+ void replace_tempo (const TempoSection&, const Tempo&, const Timecode::BBT_Time& where);
+ void replace_meter (const MeterSection&, const Meter&, const Timecode::BBT_Time& where);
- nframes_t round_to_beat (nframes_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);
- 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 ();
-#ifdef STATE_MANAGER
- UndoAction get_memento() const;
-#endif
+ TempoMetric metric_at (Timecode::BBT_Time bbt) const;
+ TempoMetric metric_at (framepos_t) const;
- /* 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.
- */
- 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;
-
- };
+ void change_existing_tempo_at (framepos_t, double bpm, double note_type);
+ void change_initial_tempo (double bpm, double note_type);
- 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;
+ void insert_time (framepos_t, framecnt_t);
- sigc::signal<void,ARDOUR::Change> StateChanged;
+ int n_tempos () const;
+ int n_meters () const;
+
+ 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;
- nframes_t last_bbt_when;
- bool last_bbt_valid;
- BBT_Time last_bbt;
- mutable Glib::RWLock lock;
+ Metrics metrics;
+ framecnt_t _frame_rate;
+ mutable Glib::RWLock lock;
+ 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);
- void timestamp_metrics ();
-
-
- nframes_t round_to_type (nframes_t fr, int dir, BBTPointType);
-
- nframes_t frame_time_unlocked (const BBT_Time&) const;
-
- void bbt_time_unlocked (nframes_t, BBT_Time&) const;
-
- nframes_t bbt_duration_at_unlocked (const BBT_Time& when, const 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;
-
- int move_metric_section (MetricSection&, const BBT_Time& to);
+
void do_insert (MetricSection* section);
-
-#ifdef STATE_MANAGER
- Change restore_state (StateManager::State&);
- StateManager::State* state_factory (std::string why) const;
-
- bool in_set_state;
-
- /* override state_manager::save_state so we can check in_set_state */
-
- void save_state (std::string why);
-#endif
};
}; /* 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__ */