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"
46 Tempo (double bpm, double type=4.0) // defaulting to quarter note
47 : _beats_per_minute (bpm), _note_type(type) {}
49 double beats_per_minute () const { return _beats_per_minute;}
50 double note_type () const { return _note_type;}
51 double frames_per_beat (framecnt_t sr) const;
54 double _beats_per_minute;
60 Meter (double dpb, double bt)
61 : _divisions_per_bar (dpb), _note_type (bt) {}
63 double divisions_per_bar () const { return _divisions_per_bar; }
64 double note_divisor() const { return _note_type; }
66 double frames_per_bar (const Tempo&, framecnt_t sr) const;
67 double frames_per_division (const Tempo&, framecnt_t sr) const;
70 /** The number of divisions in a bar. This is a floating point value because
71 there are musical traditions on our planet that do not limit
72 themselves to integral numbers of beats per bar.
74 double _divisions_per_bar;
76 /** The type of "note" that a division represents. For example, 4.0 is
77 a quarter (crotchet) note, 8.0 is an eighth (quaver) note, etc.
84 MetricSection (const Timecode::BBT_Time& start)
85 : _start (start), _frame (0), _movable (true) {}
86 MetricSection (framepos_t start)
87 : _frame (start), _movable (true) {}
89 virtual ~MetricSection() {}
91 const Timecode::BBT_Time& start() const { return _start; }
92 framepos_t frame() const { return _frame; }
94 void set_movable (bool yn) { _movable = yn; }
95 bool movable() const { return _movable; }
97 virtual void set_frame (framepos_t f) {
101 virtual void set_start (const Timecode::BBT_Time& w) {
105 /* MeterSections are not stateful in the full sense,
106 but we do want them to control their own
107 XML state information.
109 virtual XMLNode& get_state() const = 0;
111 int compare (const MetricSection&) const;
112 bool operator== (const MetricSection& other) const;
113 bool operator!= (const MetricSection& other) const;
116 Timecode::BBT_Time _start;
121 class MeterSection : public MetricSection, public Meter {
123 MeterSection (const Timecode::BBT_Time& start, double bpb, double note_type)
124 : MetricSection (start), Meter (bpb, note_type) {}
125 MeterSection (framepos_t start, double bpb, double note_type)
126 : MetricSection (start), Meter (bpb, note_type) {}
127 MeterSection (const XMLNode&);
129 static const std::string xml_state_node_name;
131 XMLNode& get_state() const;
134 class TempoSection : public MetricSection, public Tempo {
136 TempoSection (const Timecode::BBT_Time& start, double qpm, double note_type)
137 : MetricSection (start), Tempo (qpm, note_type), _bar_offset (-1.0) {}
138 TempoSection (framepos_t start, double qpm, double note_type)
139 : MetricSection (start), Tempo (qpm, note_type), _bar_offset (-1.0) {}
140 TempoSection (const XMLNode&);
142 static const std::string xml_state_node_name;
144 XMLNode& get_state() const;
146 void update_bar_offset_from_bbt (const Meter&);
147 void update_bbt_time_from_bar_offset (const Meter&);
148 double bar_offset() const { return _bar_offset; }
151 /* this value provides a fractional offset into the bar in which
152 the tempo section is located in. A value of 0.0 indicates that
153 it occurs on the first beat of the bar, a value of 0.5 indicates
154 that it occurs halfway through the bar and so on.
156 this enables us to keep the tempo change at the same relative
157 position within the bar if/when the meter changes.
162 typedef std::list<MetricSection*> Metrics;
164 /** Helper class that we use to be able to keep track of which
165 meter *AND* tempo are in effect at a given point in time.
169 TempoMetric (const Meter& m, const Tempo& t) : _meter (&m), _tempo (&t), _frame (0) {}
171 void set_tempo (const Tempo& t) { _tempo = &t; }
172 void set_meter (const Meter& m) { _meter = &m; }
173 void set_frame (framepos_t f) { _frame = f; }
174 void set_start (const Timecode::BBT_Time& t) { _start = t; }
176 const Meter& meter() const { return *_meter; }
177 const Tempo& tempo() const { return *_tempo; }
178 framepos_t frame() const { return _frame; }
179 const Timecode::BBT_Time& start() const { return _start; }
185 Timecode::BBT_Time _start;
188 class TempoMap : public PBD::StatefulDestructible
191 TempoMap (framecnt_t frame_rate);
194 /* measure-based stuff */
209 Timecode::BBT_Time bbt() const { return Timecode::BBT_Time (bar, beat, 0); }
210 operator Timecode::BBT_Time() const { return bbt(); }
211 operator framepos_t() const { return frame; }
213 BBTPoint (const Meter& m, const Tempo& t, framepos_t f,
214 BBTPointType ty, uint32_t b, uint32_t e)
215 : type (ty), frame (f), meter (&m), tempo (&t), bar (b), beat (e) {}
218 typedef std::vector<BBTPoint> BBTPointList;
220 template<class T> void apply_with_metrics (T& obj, void (T::*method)(const Metrics&)) {
221 Glib::RWLock::ReaderLock lm (lock);
222 (obj.*method)(*metrics);
225 const BBTPointList& map() const { return _map ; }
226 void map (BBTPointList&, framepos_t start, framepos_t end);
228 void bbt_time (framepos_t when, Timecode::BBT_Time&);
229 framecnt_t frame_time (const Timecode::BBT_Time&);
230 framecnt_t bbt_duration_at (framepos_t, const Timecode::BBT_Time&, int dir);
232 static const Tempo& default_tempo() { return _default_tempo; }
233 static const Meter& default_meter() { return _default_meter; }
235 const Tempo& tempo_at (framepos_t) const;
236 const Meter& meter_at (framepos_t) const;
238 const TempoSection& tempo_section_at (framepos_t) const;
240 void add_tempo(const Tempo&, Timecode::BBT_Time where);
241 void add_meter(const Meter&, Timecode::BBT_Time where);
243 void remove_tempo(const TempoSection&, bool send_signal);
244 void remove_meter(const MeterSection&, bool send_signal);
246 void replace_tempo (const TempoSection&, const Tempo&, const Timecode::BBT_Time& where);
247 void replace_meter (const MeterSection&, const Meter&, const Timecode::BBT_Time& where);
249 framepos_t round_to_bar (framepos_t frame, int dir);
250 framepos_t round_to_beat (framepos_t frame, int dir);
251 framepos_t round_to_beat_subdivision (framepos_t fr, int sub_num, int dir);
252 framepos_t round_to_tick (framepos_t frame, int dir);
254 void set_length (framepos_t frames);
256 XMLNode& get_state (void);
257 int set_state (const XMLNode&, int version);
259 void dump (std::ostream&) const;
262 TempoMetric metric_at (Timecode::BBT_Time bbt) const;
263 TempoMetric metric_at (framepos_t) const;
265 framepos_t framepos_plus_bbt (framepos_t pos, Timecode::BBT_Time b);
266 framepos_t framepos_plus_beats (framepos_t, Evoral::MusicalTime);
267 framepos_t framepos_minus_beats (framepos_t, Evoral::MusicalTime);
268 Evoral::MusicalTime framewalk_to_beats (framepos_t pos, framecnt_t distance);
270 void change_existing_tempo_at (framepos_t, double bpm, double note_type);
271 void change_initial_tempo (double bpm, double note_type);
273 void insert_time (framepos_t, framecnt_t);
275 int n_tempos () const;
276 int n_meters () const;
278 framecnt_t frame_rate () const { return _frame_rate; }
281 static Tempo _default_tempo;
282 static Meter _default_meter;
285 framecnt_t _frame_rate;
286 framepos_t last_bbt_when;
288 Timecode::BBT_Time last_bbt;
289 mutable Glib::RWLock lock;
292 void recompute_map (bool reassign_tempo_bbt, framepos_t end = -1);
293 void require_map_to (framepos_t pos);
294 void require_map_to (const Timecode::BBT_Time&);
296 BBTPointList::const_iterator bbt_before_or_at (framepos_t);
297 BBTPointList::const_iterator bbt_after_or_at (framepos_t);
298 BBTPointList::const_iterator bbt_point_for (const Timecode::BBT_Time&);
300 void timestamp_metrics_from_audio_time ();
302 framepos_t round_to_type (framepos_t fr, int dir, BBTPointType);
304 void bbt_time_unlocked (framepos_t, Timecode::BBT_Time&);
306 framecnt_t bbt_duration_at_unlocked (const Timecode::BBT_Time& when, const Timecode::BBT_Time& bbt, int dir);
308 const MeterSection& first_meter() const;
309 const TempoSection& first_tempo() const;
311 int move_metric_section (MetricSection&, const Timecode::BBT_Time& to);
312 void do_insert (MetricSection* section);
314 Timecode::BBT_Time bbt_add (const Timecode::BBT_Time&, const Timecode::BBT_Time&, const TempoMetric&) const;
315 Timecode::BBT_Time bbt_add (const Timecode::BBT_Time& a, const Timecode::BBT_Time& b) const;
316 Timecode::BBT_Time bbt_subtract (const Timecode::BBT_Time&, const Timecode::BBT_Time&) const;
319 }; /* namespace ARDOUR */
321 std::ostream& operator<< (std::ostream&, const ARDOUR::Meter&);
322 std::ostream& operator<< (std::ostream&, const ARDOUR::Tempo&);
323 std::ostream& operator<< (std::ostream&, const ARDOUR::MetricSection&);
325 #endif /* __ardour_tempo_h__ */