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;
40 class FrameposMinusBeatsTest;
49 /** Tempo, the speed at which musical time progresses (BPM). */
50 class LIBARDOUR_API Tempo {
53 * @param bpm Beats Per Minute
54 * @param type Note Type (default `4': quarter note)
56 Tempo (double bpm, double type=4.0) // defaulting to quarter note
57 : _beats_per_minute (bpm), _note_type(type) {}
59 /* ..or more aptly 'pulse divisions per minute'.
60 Nothing to do with actual beats, which are defined by the meter and tempo.
62 double beats_per_minute () const { return _beats_per_minute; }
63 void set_beats_per_minute (double bpm) { _beats_per_minute = bpm; }
64 double note_type () const { return _note_type; }
65 double pulses_per_minute () const { return _beats_per_minute / 4.0; }
66 /** audio samples per beat
67 * @param sr samplerate
69 double frames_per_beat (framecnt_t sr) const {
70 return (60.0 * sr) / _beats_per_minute;
72 double frames_per_pulse (framecnt_t sr) const {
73 return (_note_type * 60.0 * sr) / _beats_per_minute;
77 double _beats_per_minute;
81 /** Meter, or time signature (beats per bar, and which note type is a beat). */
82 class LIBARDOUR_API Meter {
84 Meter (double dpb, double bt)
85 : _divisions_per_bar (dpb), _note_type (bt) {}
87 double divisions_per_bar () const { return _divisions_per_bar; }
88 double note_divisor() const { return _note_type; }
90 double frames_per_bar (const Tempo&, framecnt_t sr) const;
91 double frames_per_grid (const Tempo&, framecnt_t sr) const;
94 /** The number of divisions in a bar. This is a floating point value because
95 there are musical traditions on our planet that do not limit
96 themselves to integral numbers of beats per bar.
98 double _divisions_per_bar;
100 /** The type of "note" that a division represents. For example, 4.0 is
101 a quarter (crotchet) note, 8.0 is an eighth (quaver) note, etc.
106 /** A section of timeline with a certain Tempo or Meter. */
107 class LIBARDOUR_API MetricSection {
109 MetricSection (double pulse, framepos_t frame, PositionLockStyle pls, bool is_tempo)
110 : _pulse (pulse), _frame (frame), _movable (true), _position_lock_style (pls), _is_tempo (is_tempo) {}
112 virtual ~MetricSection() {}
114 const double& pulse () const { return _pulse; }
115 void set_pulse (double pulse) { _pulse = pulse; }
117 framepos_t frame() const { return _frame; }
118 virtual void set_frame (framepos_t f) {
122 void set_movable (bool yn) { _movable = yn; }
123 bool movable() const { return _movable; }
125 /* MeterSections are not stateful in the full sense,
126 but we do want them to control their own
127 XML state information.
129 virtual XMLNode& get_state() const = 0;
131 PositionLockStyle position_lock_style () const { return _position_lock_style; }
132 void set_position_lock_style (PositionLockStyle ps) { _position_lock_style = ps; }
133 bool is_tempo () const { return _is_tempo; }
139 PositionLockStyle _position_lock_style;
140 const bool _is_tempo;
143 /** A section of timeline with a certain Meter. */
144 class LIBARDOUR_API MeterSection : public MetricSection, public Meter {
146 MeterSection (double pulse, framepos_t frame, double beat, const Timecode::BBT_Time& bbt, double bpb, double note_type, PositionLockStyle pls)
147 : MetricSection (pulse, frame, pls, false), Meter (bpb, note_type), _bbt (bbt), _beat (beat) {}
149 MeterSection (const XMLNode&);
151 static const std::string xml_state_node_name;
153 XMLNode& get_state() const;
155 void set_beat (std::pair<double, Timecode::BBT_Time>& w) {
160 const Timecode::BBT_Time& bbt() const { return _bbt; }
161 const double& beat () const { return _beat; }
162 void set_beat (double beat) { _beat = beat; }
165 Timecode::BBT_Time _bbt;
169 /** A section of timeline with a certain Tempo. */
170 class LIBARDOUR_API TempoSection : public MetricSection, public Tempo {
177 TempoSection (const double& pulse, const framepos_t& frame, double qpm, double note_type, Type tempo_type, PositionLockStyle pls)
178 : MetricSection (pulse, frame, pls, true), Tempo (qpm, note_type), _type (tempo_type), _c_func (0.0), _active (true), _locked_to_meter (false) {}
180 TempoSection (const XMLNode&);
182 static const std::string xml_state_node_name;
184 XMLNode& get_state() const;
186 double c_func () const { return _c_func; }
187 void set_c_func (double c_func) { _c_func = c_func; }
189 void set_type (Type type);
190 Type type () const { return _type; }
192 bool active () const { return _active; }
193 void set_active (bool yn) { _active = yn; }
195 bool locked_to_meter () const { return _locked_to_meter; }
196 void set_locked_to_meter (bool yn) { _locked_to_meter = yn; }
198 double tempo_at_frame (const framepos_t& frame, const framecnt_t& frame_rate) const;
199 framepos_t frame_at_tempo (const double& ppm, const double& beat, const framecnt_t& frame_rate) const;
201 double tempo_at_pulse (const double& pulse) const;
202 double pulse_at_tempo (const double& ppm, const framepos_t& frame, const framecnt_t& frame_rate) const;
204 double pulse_at_frame (const framepos_t& frame, const framepos_t& frame_rate) const;
205 framepos_t frame_at_pulse (const double& pulse, const framecnt_t& frame_rate) const;
207 double compute_c_func_pulse (const double& end_bpm, const double& end_pulse, const framecnt_t& frame_rate);
208 double compute_c_func_frame (const double& end_bpm, const framepos_t& end_frame, const framecnt_t& frame_rate) const;
210 Timecode::BBT_Time legacy_bbt () { return _legacy_bbt; }
214 framepos_t minute_to_frame (const double& time, const framecnt_t& frame_rate) const;
215 double frame_to_minute (const framepos_t& frame, const framecnt_t& frame_rate) const;
217 /* tempo ramp functions. zero-based with time in minutes,
218 * 'tick tempo' in ticks per minute and tempo in bpm.
219 * time relative to section start.
221 double a_func (double end_tpm, double c_func) const;
222 double c_func (double end_tpm, double end_time) const;
224 double pulse_tempo_at_time (const double& time) const;
225 double time_at_pulse_tempo (const double& pulse_tempo) const;
227 double pulse_tempo_at_pulse (const double& pulse) const;
228 double pulse_at_pulse_tempo (const double& pulse_tempo) const;
230 double pulse_at_time (const double& time) const;
231 double time_at_pulse (const double& pulse) const;
233 /* this value provides a fractional offset into the bar in which
234 the tempo section is located in. A value of 0.0 indicates that
235 it occurs on the first beat of the bar, a value of 0.5 indicates
236 that it occurs halfway through the bar and so on.
238 this enables us to keep the tempo change at the same relative
239 position within the bar if/when the meter changes.
244 bool _locked_to_meter;
245 Timecode::BBT_Time _legacy_bbt;
248 typedef std::list<MetricSection*> Metrics;
250 /** Helper class to keep track of the Meter *AND* Tempo in effect
251 at a given point in time.
253 class LIBARDOUR_API TempoMetric {
255 TempoMetric (const Meter& m, const Tempo& t)
256 : _meter (&m), _tempo (&t), _frame (0) {}
258 void set_tempo (const Tempo& t) { _tempo = &t; }
259 void set_meter (const Meter& m) { _meter = &m; }
260 void set_frame (framepos_t f) { _frame = f; }
261 void set_pulse (const double& p) { _pulse = p; }
263 void set_metric (const MetricSection* section) {
264 const MeterSection* meter;
265 const TempoSection* tempo;
266 if ((meter = dynamic_cast<const MeterSection*>(section))) {
268 } else if ((tempo = dynamic_cast<const TempoSection*>(section))) {
272 set_frame (section->frame());
273 set_pulse (section->pulse());
276 const Meter& meter() const { return *_meter; }
277 const Tempo& tempo() const { return *_tempo; }
278 framepos_t frame() const { return _frame; }
279 const double& pulse() const { return _pulse; }
288 /** Tempo Map - mapping of timecode to musical time.
289 * convert audio-samples, sample-rate to Bar/Beat/Tick, Meter/Tempo
291 class LIBARDOUR_API TempoMap : public PBD::StatefulDestructible
294 TempoMap (framecnt_t frame_rate);
297 /* measure-based stuff */
312 BBTPoint (const MeterSection& m, const Tempo& t, framepos_t f,
313 uint32_t b, uint32_t e, double func_c)
314 : frame (f), meter (m.divisions_per_bar(), m.note_divisor()), tempo (t.beats_per_minute(), t.note_type()), c (func_c), bar (b), beat (e) {}
316 Timecode::BBT_Time bbt() const { return Timecode::BBT_Time (bar, beat, 0); }
317 operator Timecode::BBT_Time() const { return bbt(); }
318 operator framepos_t() const { return frame; }
319 bool is_bar() const { return beat == 1; }
322 template<class T> void apply_with_metrics (T& obj, void (T::*method)(const Metrics&)) {
323 Glib::Threads::RWLock::ReaderLock lm (lock);
324 (obj.*method)(_metrics);
327 void get_grid (std::vector<BBTPoint>&,
328 framepos_t start, framepos_t end);
330 static const Tempo& default_tempo() { return _default_tempo; }
331 static const Meter& default_meter() { return _default_meter; }
333 /* because tempos may be ramped, this is only valid for the instant requested.*/
334 double frames_per_beat_at (const framepos_t&, const framecnt_t& sr) const;
336 const TempoSection& tempo_section_at_frame (framepos_t frame) const;
337 const MeterSection& meter_section_at_frame (framepos_t frame) const;
338 const MeterSection& meter_section_at_beat (double beat) const;
340 /** add a tempo section locked to pls. ignored values will be set in recompute_tempi()
341 * @param pulse pulse position of new section. ignored if pls == AudioTime
342 * @param frame frame position of new section. ignored if pls == MusicTime
343 * @param type type of new tempo section (Ramp, Constant)
345 TempoSection* add_tempo (const Tempo&, const double& pulse, const framepos_t& frame, TempoSection::Type type, PositionLockStyle pls);
347 /** add an meter section locked to pls.. ignored values will be set in recompute_meters()
348 * @param beat beat position of new section
349 * @param where bbt position of new section
350 * @param frame frame position of new section. ignored if pls == MusicTime
352 MeterSection* add_meter (const Meter&, const double& beat, const Timecode::BBT_Time& where, const framepos_t& frame, PositionLockStyle pls);
354 void remove_tempo (const TempoSection&, bool send_signal);
355 void remove_meter (const MeterSection&, bool send_signal);
357 void replace_tempo (const TempoSection&, const Tempo&, const double& pulse, const framepos_t& frame
358 , TempoSection::Type type, PositionLockStyle pls);
360 void replace_meter (const MeterSection&, const Meter&, const Timecode::BBT_Time& where, const framepos_t& frame
361 , PositionLockStyle pls);
363 framepos_t round_to_bar (framepos_t frame, RoundMode dir);
364 framepos_t round_to_beat (framepos_t frame, RoundMode dir);
365 framepos_t round_to_beat_subdivision (framepos_t fr, int sub_num, RoundMode dir);
366 framepos_t round_to_quarter_note_subdivision (framepos_t fr, int sub_num, RoundMode dir);
368 void set_length (framepos_t frames);
370 XMLNode& get_state (void);
371 int set_state (const XMLNode&, int version);
373 void dump (const Metrics& metrics, std::ostream&) const;
376 TempoMetric metric_at (Timecode::BBT_Time bbt) const;
378 /** Return the TempoMetric at frame @p t, and point @p last to the latest
379 * metric change <= t, if it is non-NULL.
381 TempoMetric metric_at (framepos_t, Metrics::const_iterator* last=NULL) const;
383 Metrics::const_iterator metrics_end() { return _metrics.end(); }
385 void change_existing_tempo_at (framepos_t, double bpm, double note_type);
386 void change_initial_tempo (double bpm, double note_type);
388 void insert_time (framepos_t, framecnt_t);
389 bool remove_time (framepos_t where, framecnt_t amount); //returns true if anything was moved
391 int n_tempos () const;
392 int n_meters () const;
394 framecnt_t frame_rate () const { return _frame_rate; }
396 /* TEMPO- AND METER-SENSITIVE FUNCTIONS
398 bbt_at_frame(), frame_at_bbt(), beat_at_frame(), frame_at_beat(), tempo_at_beat()
399 and bbt_duration_at()
400 are all sensitive to tempo and meter, and will give answers
401 that align with the grid formed by tempo and meter sections.
403 They SHOULD NOT be used to determine the position of events
404 whose location is canonically defined in beats.
407 double beat_at_frame (const framecnt_t& frame) const;
408 framepos_t frame_at_beat (const double& beat) const;
410 Tempo tempo_at_frame (const framepos_t& frame) const;
411 framepos_t frame_at_tempo (const Tempo& tempo) const;
413 Tempo tempo_at_beat (const double& beat) const;
415 const Meter& meter_at_frame (framepos_t) const;
417 /* you probably only need to use pulses when moving tempos */
418 double pulse_at_beat (const double& beat) const;
419 double beat_at_pulse (const double& pulse) const;
421 double pulse_at_frame (const framecnt_t& frame) const;
422 framepos_t frame_at_pulse (const double& pulse) const;
424 /* bbt - it's nearly always better to use beats.*/
425 Timecode::BBT_Time bbt_at_frame (framepos_t when);
426 Timecode::BBT_Time bbt_at_frame_rt (framepos_t when);
427 framepos_t frame_at_bbt (const Timecode::BBT_Time&);
429 double beat_at_bbt (const Timecode::BBT_Time& bbt);
430 Timecode::BBT_Time bbt_at_beat (const double& beats);
432 double pulse_at_bbt (const Timecode::BBT_Time& bbt);
433 double pulse_at_bbt_rt (const Timecode::BBT_Time& bbt);
434 Timecode::BBT_Time bbt_at_pulse (const double& pulse);
436 framecnt_t bbt_duration_at (framepos_t, const Timecode::BBT_Time&, int dir);
438 /* TEMPO-SENSITIVE FUNCTIONS
440 These next 4 functions will all take tempo in account and should be
441 used to determine position (and in the last case, distance in beats)
442 when tempo matters but meter does not.
444 They SHOULD be used to determine the position of events
445 whose location is canonically defined in beats.
448 framepos_t framepos_plus_bbt (framepos_t pos, Timecode::BBT_Time b) const;
449 framepos_t framepos_plus_beats (framepos_t, Evoral::Beats) const;
450 framepos_t framepos_plus_qn (framepos_t, Evoral::Beats) const;
451 framepos_t framepos_minus_beats (framepos_t, Evoral::Beats) const;
452 Evoral::Beats framewalk_to_beats (framepos_t pos, framecnt_t distance) const;
453 Evoral::Beats framewalk_to_qn (framepos_t pos, framecnt_t distance) const;
455 double quarter_note_at_frame (const framepos_t frame);
456 double quarter_note_at_frame_rt (const framepos_t frame);
457 framepos_t frame_at_quarter_note (const double quarter_note);
458 double quarter_note_at_beat (const double beat);
459 double beat_at_quarter_note (const double beat);
461 void gui_move_tempo (TempoSection*, const framepos_t& frame, const int& sub_num);
462 void gui_move_meter (MeterSection*, const framepos_t& frame);
463 bool gui_change_tempo (TempoSection*, const Tempo& bpm);
464 void gui_dilate_tempo (TempoSection* tempo, const framepos_t& frame, const framepos_t& end_frame, const double& pulse);
466 double exact_beat_at_frame (const framepos_t& frame, const int32_t sub_num);
467 double exact_qn_at_frame (const framepos_t& frame, const int32_t sub_num);
469 std::pair<double, framepos_t> predict_tempo_position (TempoSection* section, const Timecode::BBT_Time& bbt);
470 bool can_solve_bbt (TempoSection* section, const Timecode::BBT_Time& bbt);
472 PBD::Signal0<void> MetricPositionChanged;
473 void fix_legacy_session();
477 double beat_at_frame_locked (const Metrics& metrics, const framecnt_t& frame) const;
478 framepos_t frame_at_beat_locked (const Metrics& metrics, const double& beat) const;
480 double pulse_at_beat_locked (const Metrics& metrics, const double& beat) const;
481 double beat_at_pulse_locked (const Metrics& metrics, const double& pulse) const;
483 double pulse_at_frame_locked (const Metrics& metrics, const framepos_t& frame) const;
484 framepos_t frame_at_pulse_locked (const Metrics& metrics, const double& pulse) const;
486 Tempo tempo_at_frame_locked (const Metrics& metrics, const framepos_t& frame) const;
487 framepos_t frame_at_tempo_locked (const Metrics& metrics, const Tempo& tempo) const;
489 Timecode::BBT_Time bbt_at_frame_locked (const Metrics& metrics, const framepos_t& frame) const;
490 framepos_t frame_at_bbt_locked (const Metrics& metrics, const Timecode::BBT_Time&) const;
492 double beat_at_bbt_locked (const Metrics& metrics, const Timecode::BBT_Time& bbt) const ;
493 Timecode::BBT_Time bbt_at_beat_locked (const Metrics& metrics, const double& beats) const;
495 double pulse_at_bbt_locked (const Metrics& metrics, const Timecode::BBT_Time& bbt) const;
496 Timecode::BBT_Time bbt_at_pulse_locked (const Metrics& metrics, const double& pulse) const;
498 framepos_t frame_at_quarter_note_locked (const Metrics& metrics, const double quarter_note) const;
499 double quarter_note_at_frame_locked (const Metrics& metrics, const framepos_t frame) const;
500 double quarter_note_at_beat_locked (const Metrics& metrics, const double beat) const;
502 const TempoSection& tempo_section_at_frame_locked (const Metrics& metrics, framepos_t frame) const;
503 const TempoSection& tempo_section_at_beat_locked (const Metrics& metrics, const double& beat) const;
505 const MeterSection& meter_section_at_frame_locked (const Metrics& metrics, framepos_t frame) const;
506 const MeterSection& meter_section_at_beat_locked (const Metrics& metrics, const double& beat) const;
508 bool check_solved (const Metrics& metrics) const;
509 bool set_active_tempos (const Metrics& metrics, const framepos_t& frame);
511 bool solve_map_frame (Metrics& metrics, TempoSection* section, const framepos_t& frame);
512 bool solve_map_pulse (Metrics& metrics, TempoSection* section, const double& pulse);
513 bool solve_map_frame (Metrics& metrics, MeterSection* section, const framepos_t& frame);
514 bool solve_map_bbt (Metrics& metrics, MeterSection* section, const Timecode::BBT_Time& bbt);
516 double exact_beat_at_frame_locked (const Metrics& metrics, const framepos_t& frame, const int32_t sub_num);
517 double exact_qn_at_frame_locked (const Metrics& metrics, const framepos_t& frame, const int32_t sub_num);
519 friend class ::BBTTest;
520 friend class ::FrameposPlusBeatsTest;
521 friend class ::FrameposMinusBeatsTest;
522 friend class ::TempoTest;
524 static Tempo _default_tempo;
525 static Meter _default_meter;
528 framecnt_t _frame_rate;
529 mutable Glib::Threads::RWLock lock;
531 void recompute_tempi (Metrics& metrics);
532 void recompute_meters (Metrics& metrics);
533 void recompute_map (Metrics& metrics, framepos_t end = -1);
535 framepos_t round_to_type (framepos_t fr, RoundMode dir, BBTPointType);
537 const MeterSection& first_meter() const;
538 MeterSection& first_meter();
539 const TempoSection& first_tempo() const;
540 TempoSection& first_tempo();
542 void do_insert (MetricSection* section);
544 TempoSection* add_tempo_locked (const Tempo&, double pulse, framepos_t frame
545 , TempoSection::Type type, PositionLockStyle pls, bool recompute, bool locked_to_meter = false);
547 MeterSection* add_meter_locked (const Meter&, double beat, const Timecode::BBT_Time& where, framepos_t frame
548 , PositionLockStyle pls, bool recompute);
550 bool remove_tempo_locked (const TempoSection&);
551 bool remove_meter_locked (const MeterSection&);
553 TempoSection* copy_metrics_and_point (const Metrics& metrics, Metrics& copy, TempoSection* section);
554 MeterSection* copy_metrics_and_point (const Metrics& metrics, Metrics& copy, MeterSection* section);
557 }; /* namespace ARDOUR */
559 std::ostream& operator<< (std::ostream&, const ARDOUR::Meter&);
560 std::ostream& operator<< (std::ostream&, const ARDOUR::Tempo&);
561 std::ostream& operator<< (std::ostream&, const ARDOUR::MetricSection&);
563 #endif /* __ardour_tempo_h__ */