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/threads.h>
31 #include "pbd/stateful.h"
32 #include "pbd/statefuldestructible.h"
34 #include "evoral/Beats.hpp"
36 #include "ardour/ardour.h"
39 class FrameposPlusBeatsTest;
48 /** Tempo, the speed at which musical time progresses (BPM). */
49 class LIBARDOUR_API Tempo {
52 * @param bpm Beats Per Minute
53 * @param type Note Type (default `4': quarter note)
55 Tempo (double bpm, double type=4.0) // defaulting to quarter note
56 : _beats_per_minute (bpm), _note_type(type) {}
58 double beats_per_minute () const { return _beats_per_minute; }
60 double ticks_per_minute () const { return _beats_per_minute * Timecode::BBT_Time::ticks_per_beat;}
61 double note_type () const { return _note_type;}
62 /** audio samples per beat
63 * @param sr samplerate
65 double frames_per_beat (framecnt_t sr) const {
66 return (60.0 * sr) / _beats_per_minute;
70 double _beats_per_minute;
74 /** Meter, or time signature (beats per bar, and which note type is a beat). */
75 class LIBARDOUR_API Meter {
77 Meter (double dpb, double bt)
78 : _divisions_per_bar (dpb), _note_type (bt) {}
80 double divisions_per_bar () const { return _divisions_per_bar; }
81 double note_divisor() const { return _note_type; }
83 double frames_per_bar (const Tempo&, framecnt_t sr) const;
84 double frames_per_grid (const Tempo&, framecnt_t sr) const;
87 /** The number of divisions in a bar. This is a floating point value because
88 there are musical traditions on our planet that do not limit
89 themselves to integral numbers of beats per bar.
91 double _divisions_per_bar;
93 /** The type of "note" that a division represents. For example, 4.0 is
94 a quarter (crotchet) note, 8.0 is an eighth (quaver) note, etc.
99 /** A section of timeline with a certain Tempo or Meter. */
100 class LIBARDOUR_API MetricSection {
102 MetricSection (double beat)
103 : _beat (beat), _frame (0), _movable (true), _position_lock_style (PositionLockStyle::MusicTime) {}
104 MetricSection (framepos_t frame)
105 : _beat (0.0), _frame (frame), _movable (true), _position_lock_style (PositionLockStyle::AudioTime) {}
107 virtual ~MetricSection() {}
109 const double& beat () const { return _beat; }
110 const double tick () const { return _beat * Timecode::BBT_Time::ticks_per_beat; }
111 void set_beat (double beat) { _beat = beat;}
113 framepos_t frame() const { return _frame; }
114 virtual void set_frame (framepos_t f) {
118 void set_movable (bool yn) { _movable = yn; }
119 bool movable() const { return _movable; }
121 /* MeterSections are not stateful in the full sense,
122 but we do want them to control their own
123 XML state information.
125 virtual XMLNode& get_state() const = 0;
127 PositionLockStyle position_lock_style () const { return _position_lock_style; }
128 void set_position_lock_style (PositionLockStyle ps) { _position_lock_style = ps; }
134 PositionLockStyle _position_lock_style;
137 /** A section of timeline with a certain Meter. */
138 class LIBARDOUR_API MeterSection : public MetricSection, public Meter {
140 MeterSection (double beat, const Timecode::BBT_Time& bbt, double bpb, double note_type)
141 : MetricSection (beat), Meter (bpb, note_type), _bbt (bbt) {}
142 MeterSection (framepos_t frame, double bpb, double note_type)
143 : MetricSection (frame), Meter (bpb, note_type), _bbt (1, 1, 0) {}
144 MeterSection (const XMLNode&);
146 static const std::string xml_state_node_name;
148 XMLNode& get_state() const;
150 void set_beat (std::pair<double, Timecode::BBT_Time>& w) {
151 MetricSection::set_beat (w.first);
155 const Timecode::BBT_Time& bbt() const { return _bbt; }
157 Timecode::BBT_Time _bbt;
160 /** A section of timeline with a certain Tempo. */
161 class LIBARDOUR_API TempoSection : public MetricSection, public Tempo {
168 TempoSection (const double& beat, double qpm, double note_type, Type tempo_type)
169 : MetricSection (beat), Tempo (qpm, note_type), _bar_offset (-1.0), _type (tempo_type), _c_func (0.0) {}
170 TempoSection (framepos_t frame, double qpm, double note_type, Type tempo_type)
171 : MetricSection (frame), Tempo (qpm, note_type), _bar_offset (-1.0), _type (tempo_type), _c_func (0.0) {}
172 TempoSection (const XMLNode&);
174 static const std::string xml_state_node_name;
176 XMLNode& get_state() const;
178 void update_bar_offset_from_bbt (const Meter&);
179 void update_bbt_time_from_bar_offset (const Meter&);
180 double bar_offset() const { return _bar_offset; }
182 void set_type (Type type);
183 Type type () const { return _type; }
185 double tempo_at_frame (framepos_t frame, framecnt_t frame_rate) const;
186 framepos_t frame_at_tempo (double tempo, double beat, framecnt_t frame_rate) const;
188 double tempo_at_beat (double beat) const;
189 double beat_at_tempo (double tempo, framepos_t frame, framecnt_t frame_rate) const;
191 double beat_at_frame (framepos_t frame, framecnt_t frame_rate) const;
192 framepos_t frame_at_beat (double beat, framecnt_t frame_rate) const;
194 double tick_at_frame (framepos_t frame, framecnt_t frame_rate) const;
195 framepos_t frame_at_tick (double tick, framecnt_t frame_rate) const;
197 double compute_c_func_beat (double end_bpm, double end_beat, framecnt_t frame_rate);
198 double compute_c_func_frame (double end_bpm, framepos_t end_frame, framecnt_t frame_rate) const;
200 double get_c_func () const { return _c_func; }
201 void set_c_func (double c_func) { _c_func = c_func; }
203 Timecode::BBT_Time legacy_bbt () { return _legacy_bbt; }
207 framecnt_t minute_to_frame (double time, framecnt_t frame_rate) const;
208 double frame_to_minute (framecnt_t frame, framecnt_t frame_rate) const;
210 /* tempo ramp functions. zero-based with time in minutes,
211 * 'tick tempo' in ticks per minute and tempo in bpm.
212 * time relative to section start.
214 double a_func (double end_tpm, double c_func) const;
215 double c_func (double end_tpm, double end_time) const;
217 double tick_tempo_at_time (double time) const;
218 double time_at_tick_tempo (double tick_tempo) const;
220 double tick_tempo_at_tick (double tick) const;
221 double tick_at_tick_tempo (double tick_tempo) const;
223 double tick_at_time (double time) const;
224 double time_at_tick (double tick) const;
226 double beat_at_time (double time) const;
227 double time_at_beat (double beat) const;
229 /* this value provides a fractional offset into the bar in which
230 the tempo section is located in. A value of 0.0 indicates that
231 it occurs on the first beat of the bar, a value of 0.5 indicates
232 that it occurs halfway through the bar and so on.
234 this enables us to keep the tempo change at the same relative
235 position within the bar if/when the meter changes.
240 Timecode::BBT_Time _legacy_bbt;
243 typedef std::list<MetricSection*> Metrics;
245 /** Helper class to keep track of the Meter *AND* Tempo in effect
246 at a given point in time.
248 class LIBARDOUR_API TempoMetric {
250 TempoMetric (const Meter& m, const Tempo& t)
251 : _meter (&m), _tempo (&t), _frame (0) {}
253 void set_tempo (const Tempo& t) { _tempo = &t; }
254 void set_meter (const Meter& m) { _meter = &m; }
255 void set_frame (framepos_t f) { _frame = f; }
256 void set_beat (const double& t) { _beat = t; }
258 void set_metric (const MetricSection* section) {
259 const MeterSection* meter;
260 const TempoSection* tempo;
261 if ((meter = dynamic_cast<const MeterSection*>(section))) {
263 } else if ((tempo = dynamic_cast<const TempoSection*>(section))) {
267 set_frame(section->frame());
268 set_beat(section->beat());
271 const Meter& meter() const { return *_meter; }
272 const Tempo& tempo() const { return *_tempo; }
273 framepos_t frame() const { return _frame; }
274 const double& beat() const { return _beat; }
283 /** Tempo Map - mapping of timecode to musical time.
284 * convert audio-samples, sample-rate to Bar/Beat/Tick, Meter/Tempo
286 class LIBARDOUR_API TempoMap : public PBD::StatefulDestructible
289 TempoMap (framecnt_t frame_rate);
292 /* measure-based stuff */
301 const MeterSection* meter;
306 BBTPoint (const MeterSection& m, const Tempo& t, framepos_t f,
307 uint32_t b, uint32_t e)
308 : frame (f), meter (&m), tempo (&t), bar (b), beat (e) {}
310 Timecode::BBT_Time bbt() const { return Timecode::BBT_Time (bar, beat, 0); }
311 operator Timecode::BBT_Time() const { return bbt(); }
312 operator framepos_t() const { return frame; }
313 bool is_bar() const { return beat == 1; }
316 template<class T> void apply_with_metrics (T& obj, void (T::*method)(const Metrics&)) {
317 Glib::Threads::RWLock::ReaderLock lm (lock);
318 (obj.*method)(_metrics);
321 void get_grid (std::vector<BBTPoint>&,
322 framepos_t start, framepos_t end);
324 /* TEMPO- AND METER-SENSITIVE FUNCTIONS
326 bbt_time(), beat_at_frame(), frame_at_beat(), tick_at_frame(),
327 frame_at_tick(),frame_time() and bbt_duration_at()
328 are all sensitive to tempo and meter, and will give answers
329 that align with the grid formed by tempo and meter sections.
331 They SHOULD NOT be used to determine the position of events
332 whose location is canonically defined in beats.
335 void bbt_time (framepos_t when, Timecode::BBT_Time&);
337 double beat_at_frame (framecnt_t frame) const;
338 framecnt_t frame_at_beat (double beat) const;
340 framepos_t frame_time (const Timecode::BBT_Time&);
341 framecnt_t bbt_duration_at (framepos_t, const Timecode::BBT_Time&, int dir);
343 /* TEMPO-SENSITIVE FUNCTIONS
345 These next 4 functions will all take tempo in account and should be
346 used to determine position (and in the last case, distance in beats)
347 when tempo matters but meter does not.
349 They SHOULD be used to determine the position of events
350 whose location is canonically defined in beats.
353 framepos_t framepos_plus_bbt (framepos_t pos, Timecode::BBT_Time b) const;
354 framepos_t framepos_plus_beats (framepos_t, Evoral::Beats) const;
355 framepos_t framepos_minus_beats (framepos_t, Evoral::Beats) const;
356 Evoral::Beats framewalk_to_beats (framepos_t pos, framecnt_t distance) const;
358 static const Tempo& default_tempo() { return _default_tempo; }
359 static const Meter& default_meter() { return _default_meter; }
361 const Tempo tempo_at (framepos_t) const;
362 double frames_per_beat_at (framepos_t, framecnt_t sr) const;
364 const Meter& meter_at (framepos_t) const;
366 const TempoSection& tempo_section_at (framepos_t) const;
367 const MeterSection& meter_section_at (framepos_t) const;
368 const MeterSection& meter_section_at (double) const;
371 void add_tempo (const Tempo&, double where, TempoSection::Type type);
372 void add_tempo (const Tempo&, framepos_t frame, TempoSection::Type type);
374 void add_meter (const Meter&, double beat, Timecode::BBT_Time where);
375 void add_meter (const Meter&, framepos_t frame);
377 void remove_tempo (const TempoSection&, bool send_signal);
378 void remove_meter (const MeterSection&, bool send_signal);
380 framepos_t predict_tempo_frame (TempoSection* section, const Tempo& bpm, const Timecode::BBT_Time& bbt);
382 void replace_tempo (const TempoSection&, const Tempo&, const double& where, TempoSection::Type type);
383 void replace_tempo (const TempoSection&, const Tempo&, const framepos_t& frame, TempoSection::Type type);
385 void gui_move_tempo_frame (TempoSection*, const Tempo& bpm, const framepos_t& frame);
386 void gui_move_tempo_beat (TempoSection*, const Tempo& bpm, const double& frame);
387 void gui_move_meter (MeterSection*, const Meter& mt, const framepos_t& frame);
388 void gui_move_meter (MeterSection*, const Meter& mt, const double& beat);
390 bool can_solve_bbt (TempoSection* section, const Tempo& bpm, const Timecode::BBT_Time& bbt);
392 void replace_meter (const MeterSection&, const Meter&, const Timecode::BBT_Time& where);
393 void replace_meter (const MeterSection&, const Meter&, const framepos_t& frame);
395 framepos_t round_to_bar (framepos_t frame, RoundMode dir);
396 framepos_t round_to_beat (framepos_t frame, RoundMode dir);
397 framepos_t round_to_beat_subdivision (framepos_t fr, int sub_num, RoundMode dir);
399 void set_length (framepos_t frames);
401 XMLNode& get_state (void);
402 int set_state (const XMLNode&, int version);
404 void dump (Metrics& metrics, std::ostream&) const;
407 TempoMetric metric_at (Timecode::BBT_Time bbt) const;
409 /** Return the TempoMetric at frame @p t, and point @p last to the latest
410 * metric change <= t, if it is non-NULL.
412 TempoMetric metric_at (framepos_t, Metrics::const_iterator* last=NULL) const;
414 Metrics::const_iterator metrics_end() { return _metrics.end(); }
416 void change_existing_tempo_at (framepos_t, double bpm, double note_type);
417 void change_initial_tempo (double bpm, double note_type);
419 void insert_time (framepos_t, framecnt_t);
420 bool remove_time (framepos_t where, framecnt_t amount); //returns true if anything was moved
422 int n_tempos () const;
423 int n_meters () const;
425 framecnt_t frame_rate () const { return _frame_rate; }
427 double bbt_to_beats (Timecode::BBT_Time bbt);
428 Timecode::BBT_Time beats_to_bbt (double beats);
430 PBD::Signal0<void> MetricPositionChanged;
433 double bbt_to_beats_locked (const Metrics& metrics, Timecode::BBT_Time bbt);
434 Timecode::BBT_Time beats_to_bbt_locked (Metrics& metrics, double beats);
435 double beat_at_frame_locked (const Metrics& metrics, framecnt_t frame) const;
436 framecnt_t frame_at_beat_locked (const Metrics& metrics, double beat) const;
437 double tick_at_frame_locked (const Metrics& metrics, framecnt_t frame) const;
438 double tick_offset_at (const Metrics& metrics, double tick) const;
439 framecnt_t frame_offset_at (const Metrics& metrics, framepos_t frame) const;
441 framecnt_t frame_at_tick_locked (const Metrics& metrics, double tick) const;
442 framepos_t frame_time_locked (const Metrics& metrics, const Timecode::BBT_Time&);
444 bool check_solved (Metrics& metrics, bool by_frame);
445 bool solve_map (Metrics& metrics, TempoSection* section, const Tempo& bpm, const framepos_t& frame);
446 bool solve_map (Metrics& metrics, TempoSection* section, const Tempo& bpm, const double& beat);
447 void solve_map (Metrics& metrics, MeterSection* section, const Meter& mt, const framepos_t& frame);
448 void solve_map (Metrics& metrics, MeterSection* section, const Meter& mt, const double& beat);
450 friend class ::BBTTest;
451 friend class ::FrameposPlusBeatsTest;
452 friend class ::TempoTest;
454 static Tempo _default_tempo;
455 static Meter _default_meter;
458 framecnt_t _frame_rate;
459 mutable Glib::Threads::RWLock lock;
461 void recompute_tempos (Metrics& metrics);
462 void recompute_meters (Metrics& metrics);
463 void recompute_map (Metrics& metrics, framepos_t end = -1);
465 framepos_t round_to_type (framepos_t fr, RoundMode dir, BBTPointType);
467 const MeterSection& first_meter() const;
468 MeterSection& first_meter();
469 const TempoSection& first_tempo() const;
470 TempoSection& first_tempo();
472 void do_insert (MetricSection* section);
474 void add_tempo_locked (const Tempo&, double where, bool recompute, TempoSection::Type type);
475 void add_tempo_locked (const Tempo&, framepos_t frame, bool recompute, TempoSection::Type type);
477 void add_meter_locked (const Meter&, double beat, Timecode::BBT_Time where, bool recompute);
478 void add_meter_locked (const Meter&, framepos_t frame, bool recompute);
480 bool remove_tempo_locked (const TempoSection&);
481 bool remove_meter_locked (const MeterSection&);
483 TempoSection* copy_metrics_and_point (Metrics& copy, TempoSection* section);
486 }; /* namespace ARDOUR */
488 std::ostream& operator<< (std::ostream&, const ARDOUR::Meter&);
489 std::ostream& operator<< (std::ostream&, const ARDOUR::Tempo&);
490 std::ostream& operator<< (std::ostream&, const ARDOUR::MetricSection&);
492 #endif /* __ardour_tempo_h__ */