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) {}
60 quarter note beats as distinct from a beat derived from meter and pulse.
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 /** audio samples per quarter note beat.
66 * this is only useful for constant tempo and should not be used.
67 * if you want an instantaneous value for this, use frames_per_beat_at() instead.
68 * @param sr samplerate
70 double frames_per_beat (framecnt_t sr) const {
71 return (60.0 * sr) / _beats_per_minute;
75 double _beats_per_minute;
79 /** Meter, or time signature (beats per bar, and which note type is a beat). */
80 class LIBARDOUR_API Meter {
82 Meter (double dpb, double bt)
83 : _divisions_per_bar (dpb), _note_type (bt) {}
85 double divisions_per_bar () const { return _divisions_per_bar; }
86 double note_divisor() const { return _note_type; }
88 double frames_per_bar (const Tempo&, framecnt_t sr) const;
89 double frames_per_grid (const Tempo&, framecnt_t sr) const;
92 /** The number of divisions in a bar. This is a floating point value because
93 there are musical traditions on our planet that do not limit
94 themselves to integral numbers of beats per bar.
96 double _divisions_per_bar;
98 /** The type of "note" that a division represents. For example, 4.0 is
99 a quarter (crotchet) note, 8.0 is an eighth (quaver) note, etc.
104 /** A section of timeline with a certain Tempo or Meter. */
105 class LIBARDOUR_API MetricSection {
107 MetricSection (double pulse, double minute, PositionLockStyle pls, bool is_tempo, framecnt_t sample_rate)
108 : _pulse (pulse), _minute (minute), _movable (true), _position_lock_style (pls), _is_tempo (is_tempo), _sample_rate (sample_rate) {}
110 virtual ~MetricSection() {}
112 const double& pulse () const { return _pulse; }
113 void set_pulse (double pulse) { _pulse = pulse; }
115 double minute() const { return _minute; }
116 virtual void set_minute (double m) {
120 framepos_t frame () const { return frame_at_minute (_minute); }
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; }
135 framepos_t frame_at_minute (const double& time) const;
136 double minute_at_frame (const framepos_t& frame) const;
143 PositionLockStyle _position_lock_style;
144 const bool _is_tempo;
145 framecnt_t _sample_rate;
148 /** A section of timeline with a certain Meter. */
149 class LIBARDOUR_API MeterSection : public MetricSection, public Meter {
151 MeterSection (double pulse, double minute, double beat, const Timecode::BBT_Time& bbt, double bpb, double note_type, PositionLockStyle pls, framecnt_t sr)
152 : MetricSection (pulse, minute, pls, false, sr), Meter (bpb, note_type), _bbt (bbt), _beat (beat) {}
154 MeterSection (const XMLNode&, const framecnt_t sample_rate);
156 static const std::string xml_state_node_name;
158 XMLNode& get_state() const;
160 void set_beat (std::pair<double, Timecode::BBT_Time>& w) {
165 const Timecode::BBT_Time& bbt() const { return _bbt; }
166 const double& beat () const { return _beat; }
167 void set_beat (double beat) { _beat = beat; }
170 Timecode::BBT_Time _bbt;
174 /** A section of timeline with a certain Tempo. */
175 class LIBARDOUR_API TempoSection : public MetricSection, public Tempo {
182 TempoSection (const double& pulse, const double& minute, double qpm, double note_type, Type tempo_type, PositionLockStyle pls, framecnt_t sr)
183 : MetricSection (pulse, minute, pls, true, sr), Tempo (qpm, note_type), _type (tempo_type), _c_func (0.0), _active (true), _locked_to_meter (false) {}
185 TempoSection (const XMLNode&, const framecnt_t sample_rate);
187 static const std::string xml_state_node_name;
189 XMLNode& get_state() const;
191 double c_func () const { return _c_func; }
192 void set_c_func (double c_func) { _c_func = c_func; }
194 void set_type (Type type);
195 Type type () const { return _type; }
197 bool active () const { return _active; }
198 void set_active (bool yn) { _active = yn; }
200 bool locked_to_meter () const { return _locked_to_meter; }
201 void set_locked_to_meter (bool yn) { _locked_to_meter = yn; }
203 double tempo_at_minute (const double& minute) const;
204 double minute_at_tempo (const double& bpm, const double& pulse) const;
206 double tempo_at_pulse (const double& pulse) const;
207 double pulse_at_tempo (const double& bpm, const double& minute) const;
209 double pulse_at_minute (const double& minute) const;
210 double minute_at_pulse (const double& pulse) const;
212 double compute_c_func_pulse (const double& end_bpm, const double& end_pulse) const;
213 double compute_c_func_minute (const double& end_bpm, const double& end_minute) const;
215 Timecode::BBT_Time legacy_bbt () { return _legacy_bbt; }
219 /* tempo ramp functions. zero-based with time in minutes,
220 * 'tick tempo' in ticks per minute and tempo in bpm.
221 * time relative to section start.
223 double a_func (double end_tpm, double c_func) const;
224 double c_func (double end_tpm, double end_time) const;
226 double _tempo_at_time (const double& time) const;
227 double _time_at_tempo (const double& tempo) const;
229 double _tempo_at_pulse (const double& pulse) const;
230 double _pulse_at_tempo (const double& tempo) const;
232 double _pulse_at_time (const double& time) const;
233 double _time_at_pulse (const double& pulse) const;
235 /* this value provides a fractional offset into the bar in which
236 the tempo section is located in. A value of 0.0 indicates that
237 it occurs on the first beat of the bar, a value of 0.5 indicates
238 that it occurs halfway through the bar and so on.
240 this enables us to keep the tempo change at the same relative
241 position within the bar if/when the meter changes.
246 bool _locked_to_meter;
247 Timecode::BBT_Time _legacy_bbt;
250 typedef std::list<MetricSection*> Metrics;
252 /** Helper class to keep track of the Meter *AND* Tempo in effect
253 at a given point in time.
255 class LIBARDOUR_API TempoMetric {
257 TempoMetric (const Meter& m, const Tempo& t)
258 : _meter (&m), _tempo (&t), _minute (0.0), _pulse (0.0) {}
260 void set_tempo (const Tempo& t) { _tempo = &t; }
261 void set_meter (const Meter& m) { _meter = &m; }
262 void set_minute (double m) { _minute = m; }
263 void set_pulse (const double& p) { _pulse = p; }
265 void set_metric (const MetricSection* section) {
266 const MeterSection* meter;
267 const TempoSection* tempo;
268 if ((meter = dynamic_cast<const MeterSection*>(section))) {
270 } else if ((tempo = dynamic_cast<const TempoSection*>(section))) {
274 set_minute (section->minute());
275 set_pulse (section->pulse());
278 const Meter& meter() const { return *_meter; }
279 const Tempo& tempo() const { return *_tempo; }
280 double minute() const { return _minute; }
281 const double& pulse() const { return _pulse; }
290 /** Tempo Map - mapping of timecode to musical time.
291 * convert audio-samples, sample-rate to Bar/Beat/Tick, Meter/Tempo
293 class LIBARDOUR_API TempoMap : public PBD::StatefulDestructible
296 TempoMap (framecnt_t frame_rate);
299 /* measure-based stuff */
314 BBTPoint (const MeterSection& m, const Tempo& t, framepos_t f,
315 uint32_t b, uint32_t e, double func_c)
316 : 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) {}
318 Timecode::BBT_Time bbt() const { return Timecode::BBT_Time (bar, beat, 0); }
319 operator Timecode::BBT_Time() const { return bbt(); }
320 operator framepos_t() const { return frame; }
321 bool is_bar() const { return beat == 1; }
324 template<class T> void apply_with_metrics (T& obj, void (T::*method)(const Metrics&)) {
325 Glib::Threads::RWLock::ReaderLock lm (lock);
326 (obj.*method)(_metrics);
329 void get_grid (std::vector<BBTPoint>&,
330 framepos_t start, framepos_t end, uint32_t bar_mod = 0);
332 static const Tempo& default_tempo() { return _default_tempo; }
333 static const Meter& default_meter() { return _default_meter; }
335 /* because tempos may be ramped, this is only valid for the instant requested.*/
336 double frames_per_beat_at (const framepos_t&, const framecnt_t& sr) const;
338 const TempoSection& tempo_section_at_frame (framepos_t frame) const;
339 const MeterSection& meter_section_at_frame (framepos_t frame) const;
340 const MeterSection& meter_section_at_beat (double beat) const;
342 /** add a tempo section locked to pls. ignored values will be set in recompute_tempi()
343 * @param pulse pulse position of new section. ignored if pls == AudioTime
344 * @param frame frame position of new section. ignored if pls == MusicTime
345 * @param type type of new tempo section (Ramp, Constant)
347 TempoSection* add_tempo (const Tempo&, const double& pulse, const framepos_t& frame, TempoSection::Type type, PositionLockStyle pls);
349 /** add an meter section locked to pls.. ignored values will be set in recompute_meters()
350 * @param beat beat position of new section
351 * @param where bbt position of new section
352 * @param frame frame position of new section. ignored if pls == MusicTime
354 MeterSection* add_meter (const Meter&, const double& beat, const Timecode::BBT_Time& where, PositionLockStyle pls);
356 void remove_tempo (const TempoSection&, bool send_signal);
357 void remove_meter (const MeterSection&, bool send_signal);
359 void replace_tempo (const TempoSection&, const Tempo&, const double& pulse, const framepos_t& frame
360 , TempoSection::Type type, PositionLockStyle pls);
362 void replace_meter (const MeterSection&, const Meter&, const Timecode::BBT_Time& where, PositionLockStyle pls);
364 framepos_t round_to_bar (framepos_t frame, RoundMode dir);
365 framepos_t round_to_beat (framepos_t frame, RoundMode dir);
366 framepos_t round_to_beat_subdivision (framepos_t fr, int sub_num, RoundMode dir);
367 framepos_t round_to_quarter_note_subdivision (framepos_t fr, int sub_num, RoundMode dir);
369 void set_length (framepos_t frames);
371 XMLNode& get_state (void);
372 int set_state (const XMLNode&, int version);
374 void dump (const Metrics& metrics, std::ostream&) const;
377 TempoMetric metric_at (Timecode::BBT_Time bbt) const;
379 /** Return the TempoMetric at frame @p t, and point @p last to the latest
380 * metric change <= t, if it is non-NULL.
382 TempoMetric metric_at (framepos_t, Metrics::const_iterator* last=NULL) const;
384 Metrics::const_iterator metrics_end() { return _metrics.end(); }
386 void change_existing_tempo_at (framepos_t, double bpm, double note_type);
387 void change_initial_tempo (double bpm, double note_type);
389 void insert_time (framepos_t, framecnt_t);
390 bool remove_time (framepos_t where, framecnt_t amount); //returns true if anything was moved
392 int n_tempos () const;
393 int n_meters () const;
395 framecnt_t frame_rate () const { return _frame_rate; }
397 /* TEMPO- AND METER-SENSITIVE FUNCTIONS
399 bbt_at_frame(), frame_at_bbt(), beat_at_frame(), frame_at_beat()
400 and bbt_duration_at()
401 are all sensitive to tempo and meter, and will give answers
402 that align with the grid formed by tempo and meter sections.
404 They SHOULD NOT be used to determine the position of events
405 whose location is canonically defined in Evoral::Beats.
408 double beat_at_frame (const framecnt_t& frame) const;
409 framepos_t frame_at_beat (const double& beat) const;
411 const Meter& meter_at_frame (framepos_t) const;
413 /* bbt - it's nearly always better to use meter-based beat (above)
414 unless tick resolution is desirable.
416 Timecode::BBT_Time bbt_at_frame (framepos_t when);
417 Timecode::BBT_Time bbt_at_frame_rt (framepos_t when);
418 framepos_t frame_at_bbt (const Timecode::BBT_Time&);
420 double beat_at_bbt (const Timecode::BBT_Time& bbt);
421 Timecode::BBT_Time bbt_at_beat (const double& beats);
423 double quarter_note_at_bbt (const Timecode::BBT_Time& bbt);
424 double quarter_note_at_bbt_rt (const Timecode::BBT_Time& bbt);
425 Timecode::BBT_Time bbt_at_quarter_note (const double& quarter_note);
427 framecnt_t bbt_duration_at (framepos_t, const Timecode::BBT_Time&, int dir);
428 framepos_t framepos_plus_bbt (framepos_t pos, Timecode::BBT_Time b) const;
430 /* TEMPO-SENSITIVE FUNCTIONS
432 These next 2 functions will all take tempo in account and should be
433 used to determine position (and in the last case, distance in beats)
434 when tempo matters but meter does not.
436 They SHOULD be used to determine the position of events
437 whose location is canonically defined in Evoral::Beats.
440 framepos_t framepos_plus_qn (framepos_t, Evoral::Beats) const;
441 Evoral::Beats framewalk_to_qn (framepos_t pos, framecnt_t distance) const;
443 /* quarter note related functions are also tempo-sensitive and ignore meter.
445 double quarter_note_at_frame (const framepos_t frame);
446 double quarter_note_at_frame_rt (const framepos_t frame);
447 framepos_t frame_at_quarter_note (const double quarter_note);
449 framecnt_t frames_between_quarter_notes (const double start, const double end);
451 double quarter_note_at_beat (const double beat);
452 double beat_at_quarter_note (const double beat);
454 double exact_qn_at_frame (const framepos_t& frame, const int32_t sub_num);
455 double exact_beat_at_frame (const framepos_t& frame, const int32_t sub_num);
457 Tempo tempo_at_frame (const framepos_t& frame) const;
458 framepos_t frame_at_tempo (const Tempo& tempo) const;
459 Tempo tempo_at_quarter_note (const double& beat) const;
460 double quarter_note_at_tempo (const Tempo& tempo) const;
462 void gui_move_tempo (TempoSection*, const framepos_t& frame, const int& sub_num);
463 void gui_move_meter (MeterSection*, const framepos_t& frame);
464 bool gui_change_tempo (TempoSection*, const Tempo& bpm);
465 void gui_dilate_tempo (TempoSection* tempo, const framepos_t& frame, const framepos_t& end_frame);
467 std::pair<double, framepos_t> predict_tempo_position (TempoSection* section, const Timecode::BBT_Time& bbt);
468 bool can_solve_bbt (TempoSection* section, const Timecode::BBT_Time& bbt);
470 PBD::Signal0<void> MetricPositionChanged;
471 void fix_legacy_session();
475 double beat_at_minute_locked (const Metrics& metrics, const double& minute) const;
476 double minute_at_beat_locked (const Metrics& metrics, const double& beat) const;
478 double pulse_at_beat_locked (const Metrics& metrics, const double& beat) const;
479 double beat_at_pulse_locked (const Metrics& metrics, const double& pulse) const;
481 double pulse_at_minute_locked (const Metrics& metrics, const double& minute) const;
482 double minute_at_pulse_locked (const Metrics& metrics, const double& pulse) const;
484 Tempo tempo_at_minute_locked (const Metrics& metrics, const double& minute) const;
485 double minute_at_tempo_locked (const Metrics& metrics, const Tempo& tempo) const;
487 Tempo tempo_at_pulse_locked (const Metrics& metrics, const double& pulse) const;
488 double pulse_at_tempo_locked (const Metrics& metrics, const Tempo& tempo) const;
490 Timecode::BBT_Time bbt_at_minute_locked (const Metrics& metrics, const double& minute) const;
491 double minute_at_bbt_locked (const Metrics& metrics, const Timecode::BBT_Time&) const;
493 double beat_at_bbt_locked (const Metrics& metrics, const Timecode::BBT_Time& bbt) const ;
494 Timecode::BBT_Time bbt_at_beat_locked (const Metrics& metrics, const double& beats) const;
496 double pulse_at_bbt_locked (const Metrics& metrics, const Timecode::BBT_Time& bbt) const;
497 Timecode::BBT_Time bbt_at_pulse_locked (const Metrics& metrics, const double& pulse) const;
499 double minute_at_quarter_note_locked (const Metrics& metrics, const double quarter_note) const;
500 double quarter_note_at_minute_locked (const Metrics& metrics, const double minute) const;
502 double quarter_note_at_beat_locked (const Metrics& metrics, const double beat) const;
503 double beat_at_quarter_note_locked (const Metrics& metrics, const double beat) const;
505 double minutes_between_quarter_notes_locked (const Metrics& metrics, const double start_qn, const double end_qn);
507 const TempoSection& tempo_section_at_minute_locked (const Metrics& metrics, double minute) const;
508 const TempoSection& tempo_section_at_beat_locked (const Metrics& metrics, const double& beat) const;
510 const MeterSection& meter_section_at_minute_locked (const Metrics& metrics, double minute) const;
511 const MeterSection& meter_section_at_beat_locked (const Metrics& metrics, const double& beat) const;
513 bool check_solved (const Metrics& metrics) const;
514 bool set_active_tempos (const Metrics& metrics, const framepos_t& frame);
516 bool solve_map_minute (Metrics& metrics, TempoSection* section, const double& minute);
517 bool solve_map_pulse (Metrics& metrics, TempoSection* section, const double& pulse);
518 bool solve_map_minute (Metrics& metrics, MeterSection* section, const double& minute);
519 bool solve_map_bbt (Metrics& metrics, MeterSection* section, const Timecode::BBT_Time& bbt);
521 double exact_beat_at_frame_locked (const Metrics& metrics, const framepos_t& frame, const int32_t sub_num);
522 double exact_qn_at_frame_locked (const Metrics& metrics, const framepos_t& frame, const int32_t sub_num);
524 double minute_at_frame (const framepos_t frame) const;
525 framepos_t frame_at_minute (const double minute) const;
527 friend class ::BBTTest;
528 friend class ::FrameposPlusBeatsTest;
529 friend class ::FrameposMinusBeatsTest;
530 friend class ::TempoTest;
532 static Tempo _default_tempo;
533 static Meter _default_meter;
536 framecnt_t _frame_rate;
537 mutable Glib::Threads::RWLock lock;
539 void recompute_tempi (Metrics& metrics);
540 void recompute_meters (Metrics& metrics);
541 void recompute_map (Metrics& metrics, framepos_t end = -1);
543 framepos_t round_to_type (framepos_t fr, RoundMode dir, BBTPointType);
545 const MeterSection& first_meter() const;
546 MeterSection& first_meter();
547 const TempoSection& first_tempo() const;
548 TempoSection& first_tempo();
550 void do_insert (MetricSection* section);
552 TempoSection* add_tempo_locked (const Tempo&, double pulse, double minute
553 , TempoSection::Type type, PositionLockStyle pls, bool recompute, bool locked_to_meter = false);
555 MeterSection* add_meter_locked (const Meter&, double beat, const Timecode::BBT_Time& where, PositionLockStyle pls, bool recompute);
557 bool remove_tempo_locked (const TempoSection&);
558 bool remove_meter_locked (const MeterSection&);
560 TempoSection* copy_metrics_and_point (const Metrics& metrics, Metrics& copy, TempoSection* section);
561 MeterSection* copy_metrics_and_point (const Metrics& metrics, Metrics& copy, MeterSection* section);
564 }; /* namespace ARDOUR */
566 std::ostream& operator<< (std::ostream&, const ARDOUR::Meter&);
567 std::ostream& operator<< (std::ostream&, const ARDOUR::Tempo&);
568 std::ostream& operator<< (std::ostream&, const ARDOUR::MetricSection&);
570 #endif /* __ardour_tempo_h__ */