2 Copyright (C) 2000 Paul Davis
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 #ifndef __ardour_tempo_h__
21 #define __ardour_tempo_h__
27 #include <glibmm/thread.h>
30 #include "pbd/stateful.h"
31 #include "pbd/statefuldestructible.h"
33 #include "evoral/types.hpp"
35 #include "ardour/ardour.h"
43 Tempo (double bpm, double type=4.0) // defaulting to quarter note
44 : _beats_per_minute (bpm), _note_type(type) {}
46 double beats_per_minute () const { return _beats_per_minute;}
47 double note_type () const { return _note_type;}
48 double frames_per_beat (framecnt_t sr) const;
51 double _beats_per_minute;
57 Meter (double dpb, double bt)
58 : _divisions_per_bar (dpb), _note_type (bt) {}
60 double divisions_per_bar () const { return _divisions_per_bar; }
61 double note_divisor() const { return _note_type; }
63 double frames_per_bar (const Tempo&, framecnt_t sr) const;
64 double frames_per_division (const Tempo&, framecnt_t sr) const;
67 /** The number of divisions in a bar. This is a floating point value because
68 there are musical traditions on our planet that do not limit
69 themselves to integral numbers of beats per bar.
71 double _divisions_per_bar;
73 /** The type of "note" that a division represents. For example, 4.0 is
74 a quarter (crotchet) note, 8.0 is an eighth (quaver) note, etc.
81 MetricSection (const Timecode::BBT_Time& start)
82 : _start (start), _frame (0), _movable (true) {}
83 MetricSection (framepos_t start)
84 : _frame (start), _movable (true) {}
86 virtual ~MetricSection() {}
88 const Timecode::BBT_Time& start() const { return _start; }
89 framepos_t frame() const { return _frame; }
91 void set_movable (bool yn) { _movable = yn; }
92 bool movable() const { return _movable; }
94 virtual void set_frame (framepos_t f) {
98 virtual void set_start (const Timecode::BBT_Time& w) {
102 /* MeterSections are not stateful in the full sense,
103 but we do want them to control their own
104 XML state information.
106 virtual XMLNode& get_state() const = 0;
108 int compare (MetricSection *, bool) const;
111 Timecode::BBT_Time _start;
116 class MeterSection : public MetricSection, public Meter {
118 MeterSection (const Timecode::BBT_Time& start, double bpb, double note_type)
119 : MetricSection (start), Meter (bpb, note_type) {}
120 MeterSection (framepos_t start, double bpb, double note_type)
121 : MetricSection (start), Meter (bpb, note_type) {}
122 MeterSection (const XMLNode&);
124 static const std::string xml_state_node_name;
126 XMLNode& get_state() const;
129 class TempoSection : public MetricSection, public Tempo {
131 TempoSection (const Timecode::BBT_Time& start, double qpm, double note_type)
132 : MetricSection (start), Tempo (qpm, note_type) {}
133 TempoSection (framepos_t start, double qpm, double note_type)
134 : MetricSection (start), Tempo (qpm, note_type) {}
135 TempoSection (const XMLNode&);
137 static const std::string xml_state_node_name;
139 XMLNode& get_state() const;
142 typedef std::list<MetricSection*> Metrics;
144 /** Helper class that we use to be able to keep track of which
145 meter *AND* tempo are in effect at a given point in time.
149 TempoMetric (const Meter& m, const Tempo& t) : _meter (&m), _tempo (&t), _frame (0) {}
151 void set_tempo (const Tempo& t) { _tempo = &t; }
152 void set_meter (const Meter& m) { _meter = &m; }
153 void set_frame (framepos_t f) { _frame = f; }
154 void set_start (const Timecode::BBT_Time& t) { _start = t; }
156 const Meter& meter() const { return *_meter; }
157 const Tempo& tempo() const { return *_tempo; }
158 framepos_t frame() const { return _frame; }
159 const Timecode::BBT_Time& start() const { return _start; }
165 Timecode::BBT_Time _start;
168 class TempoMap : public PBD::StatefulDestructible
171 TempoMap (framecnt_t frame_rate);
174 /* measure-based stuff */
189 BBTPoint (const Meter& m, const Tempo& t, framepos_t f,
190 BBTPointType ty, uint32_t b, uint32_t e)
191 : type (ty), frame (f), meter (&m), tempo (&t), bar (b), beat (e) {}
194 typedef std::vector<BBTPoint> BBTPointList;
196 template<class T> void apply_with_metrics (T& obj, void (T::*method)(const Metrics&)) {
197 Glib::RWLock::ReaderLock lm (lock);
198 (obj.*method)(*metrics);
201 BBTPointList *get_points (framepos_t start, framepos_t end) const;
203 void bbt_time (framepos_t when, Timecode::BBT_Time&) const;
204 framecnt_t frame_time (const Timecode::BBT_Time&) const;
205 framecnt_t bbt_duration_at (framepos_t, const Timecode::BBT_Time&, int dir) const;
207 static const Tempo& default_tempo() { return _default_tempo; }
208 static const Meter& default_meter() { return _default_meter; }
210 const Tempo& tempo_at (framepos_t) const;
211 const Meter& meter_at (framepos_t) const;
213 const TempoSection& tempo_section_at (framepos_t) const;
215 void add_tempo(const Tempo&, Timecode::BBT_Time where);
216 void add_meter(const Meter&, Timecode::BBT_Time where);
218 void add_tempo(const Tempo&, framepos_t where);
219 void add_meter(const Meter&, framepos_t where);
221 void move_tempo (TempoSection&, const Timecode::BBT_Time& to);
222 void move_meter (MeterSection&, const Timecode::BBT_Time& to);
224 void remove_tempo(const TempoSection&);
225 void remove_meter(const MeterSection&);
227 void replace_tempo (TempoSection& existing, const Tempo& replacement);
228 void replace_meter (MeterSection& existing, const Meter& replacement);
230 framepos_t round_to_bar (framepos_t frame, int dir);
231 framepos_t round_to_beat (framepos_t frame, int dir);
232 framepos_t round_to_beat_subdivision (framepos_t fr, int sub_num, int dir);
233 framepos_t round_to_tick (framepos_t frame, int dir);
235 void set_length (framepos_t frames);
237 XMLNode& get_state (void);
238 int set_state (const XMLNode&, int version);
240 void dump (std::ostream&) const;
243 TempoMetric metric_at (Timecode::BBT_Time bbt) const;
244 TempoMetric metric_at (framepos_t) const;
245 void bbt_time_with_metric (framepos_t, Timecode::BBT_Time&, const TempoMetric&) const;
247 Timecode::BBT_Time bbt_add (const Timecode::BBT_Time&, const Timecode::BBT_Time&, const TempoMetric&) const;
248 Timecode::BBT_Time bbt_add (const Timecode::BBT_Time& a, const Timecode::BBT_Time& b) const;
249 Timecode::BBT_Time bbt_subtract (const Timecode::BBT_Time&, const Timecode::BBT_Time&) const;
251 framepos_t framepos_plus_bbt (framepos_t pos, Timecode::BBT_Time b) const;
252 framepos_t framepos_plus_beats (framepos_t, Evoral::MusicalTime) const;
253 framepos_t framepos_minus_beats (framepos_t, Evoral::MusicalTime) const;
254 Evoral::MusicalTime framewalk_to_beats (framepos_t pos, framecnt_t distance) const;
256 void change_existing_tempo_at (framepos_t, double bpm, double note_type);
257 void change_initial_tempo (double bpm, double note_type);
259 void insert_time (framepos_t, framecnt_t);
261 int n_tempos () const;
262 int n_meters () const;
264 framecnt_t frame_rate () const { return _frame_rate; }
267 static Tempo _default_tempo;
268 static Meter _default_meter;
271 framecnt_t _frame_rate;
272 framepos_t last_bbt_when;
274 Timecode::BBT_Time last_bbt;
275 mutable Glib::RWLock lock;
277 void timestamp_metrics (bool use_bbt);
279 framepos_t round_to_type (framepos_t fr, int dir, BBTPointType);
281 framepos_t frame_time_unlocked (const Timecode::BBT_Time&) const;
283 void bbt_time_unlocked (framepos_t, Timecode::BBT_Time&) const;
285 framecnt_t bbt_duration_at_unlocked (const Timecode::BBT_Time& when, const Timecode::BBT_Time& bbt, int dir) const;
287 const MeterSection& first_meter() const;
288 const TempoSection& first_tempo() const;
290 framecnt_t count_frames_between (const Timecode::BBT_Time&, const Timecode::BBT_Time&) const;
291 framecnt_t count_frames_between_metrics (const Meter&, const Tempo&,
292 const Timecode::BBT_Time&, const Timecode::BBT_Time&) const;
294 int move_metric_section (MetricSection&, const Timecode::BBT_Time& to);
295 void do_insert (MetricSection* section, bool with_bbt);
298 }; /* namespace ARDOUR */
300 std::ostream& operator<< (std::ostream&, const ARDOUR::Meter&);
301 std::ostream& operator<< (std::ostream&, const ARDOUR::Tempo&);
302 std::ostream& operator<< (std::ostream&, const ARDOUR::MetricSection&);
304 #endif /* __ardour_tempo_h__ */