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 npm Note Types per minute
54 * @param type Note Type (default `4': quarter note)
56 Tempo (double npm, double type=4.0) // defaulting to quarter note
57 : _note_types_per_minute (npm), _note_type (type), _end_note_types_per_minute (npm) {}
58 Tempo (double start_npm, double type, double end_npm)
59 : _note_types_per_minute (start_npm), _note_type (type), _end_note_types_per_minute (end_npm) {}
61 double note_types_per_minute () const { return _note_types_per_minute; }
62 double note_types_per_minute (double note_type) const { return (_note_types_per_minute / _note_type) * note_type; }
63 void set_note_types_per_minute (double npm) { _note_types_per_minute = npm; }
64 double note_type () const { return _note_type; }
66 double quarter_notes_per_minute () const { return note_types_per_minute (4.0); }
67 double pulses_per_minute () const { return note_types_per_minute (1.0); }
69 double end_note_types_per_minute () const { return _end_note_types_per_minute; }
70 double end_note_types_per_minute (double note_type) const { return (_end_note_types_per_minute / _note_type) * note_type; }
71 void set_end_note_types_per_minute (double npm) { _end_note_types_per_minute = npm; }
73 double end_quarter_notes_per_minute () const { return end_note_types_per_minute (4.0); }
74 double end_pulses_per_minute () const { return end_note_types_per_minute (1.0); }
76 /** audio samples per note type.
77 * if you want an instantaneous value for this, use TempoMap::frames_per_quarter_note_at() instead.
78 * @param sr samplerate
80 double frames_per_note_type (framecnt_t sr) const {
81 return (60.0 * sr) / _note_types_per_minute;
83 /** audio samples per quarter note.
84 * if you want an instantaneous value for this, use TempoMap::frames_per_quarter_note_at() instead.
85 * @param sr samplerate
87 double frames_per_quarter_note (framecnt_t sr) const {
88 return (60.0 * sr) / quarter_notes_per_minute ();
92 double _note_types_per_minute;
94 double _end_note_types_per_minute;
97 /** Meter, or time signature (beats per bar, and which note type is a beat). */
98 class LIBARDOUR_API Meter {
100 Meter (double dpb, double bt)
101 : _divisions_per_bar (dpb), _note_type (bt) {}
103 double divisions_per_bar () const { return _divisions_per_bar; }
104 double note_divisor() const { return _note_type; }
106 double frames_per_bar (const Tempo&, framecnt_t sr) const;
107 double frames_per_grid (const Tempo&, framecnt_t sr) const;
109 inline bool operator==(const Meter& other)
110 { return _divisions_per_bar == other.divisions_per_bar() && _note_type == other.note_divisor(); }
113 /** The number of divisions in a bar. This is a floating point value because
114 there are musical traditions on our planet that do not limit
115 themselves to integral numbers of beats per bar.
117 double _divisions_per_bar;
119 /** The type of "note" that a division represents. For example, 4.0 is
120 a quarter (crotchet) note, 8.0 is an eighth (quaver) note, etc.
125 /** A section of timeline with a certain Tempo or Meter. */
126 class LIBARDOUR_API MetricSection {
128 MetricSection (double pulse, double minute, PositionLockStyle pls, bool is_tempo, framecnt_t sample_rate)
129 : _pulse (pulse), _minute (minute), _initial (false), _position_lock_style (pls), _is_tempo (is_tempo), _sample_rate (sample_rate) {}
131 virtual ~MetricSection() {}
133 const double& pulse () const { return _pulse; }
134 void set_pulse (double pulse) { _pulse = pulse; }
136 double minute() const { return _minute; }
137 virtual void set_minute (double m) {
141 framepos_t frame () const { return frame_at_minute (_minute); }
143 void set_initial (bool yn) { _initial = yn; }
144 bool initial() const { return _initial; }
146 /* MeterSections are not stateful in the full sense,
147 but we do want them to control their own
148 XML state information.
150 virtual XMLNode& get_state() const = 0;
152 PositionLockStyle position_lock_style () const { return _position_lock_style; }
153 void set_position_lock_style (PositionLockStyle ps) { _position_lock_style = ps; }
154 bool is_tempo () const { return _is_tempo; }
156 framepos_t frame_at_minute (const double& time) const;
157 double minute_at_frame (const framepos_t& frame) const;
164 PositionLockStyle _position_lock_style;
165 const bool _is_tempo;
166 framecnt_t _sample_rate;
169 /** A section of timeline with a certain Meter. */
170 class LIBARDOUR_API MeterSection : public MetricSection, public Meter {
172 MeterSection (double pulse, double minute, double beat, const Timecode::BBT_Time& bbt, double bpb, double note_type, PositionLockStyle pls, framecnt_t sr)
173 : MetricSection (pulse, minute, pls, false, sr), Meter (bpb, note_type), _bbt (bbt), _beat (beat) {}
175 MeterSection (const XMLNode&, const framecnt_t sample_rate);
177 static const std::string xml_state_node_name;
179 XMLNode& get_state() const;
181 void set_beat (std::pair<double, Timecode::BBT_Time>& w) {
186 const Timecode::BBT_Time& bbt() const { return _bbt; }
187 const double& beat () const { return _beat; }
188 void set_beat (double beat) { _beat = beat; }
191 Timecode::BBT_Time _bbt;
195 /** A section of timeline with a certain Tempo. */
196 class LIBARDOUR_API TempoSection : public MetricSection, public Tempo {
203 TempoSection (const double& pulse, const double& minute, Tempo tempo, PositionLockStyle pls, framecnt_t sr)
204 : MetricSection (pulse, minute, pls, true, sr), Tempo (tempo), _c (0.0), _active (true), _locked_to_meter (false), _clamped (false) {}
206 TempoSection (const XMLNode&, const framecnt_t sample_rate);
208 static const std::string xml_state_node_name;
210 XMLNode& get_state() const;
212 double c () const { return _c; }
213 void set_c (double c) { _c = c; }
215 Type type () const { if (note_types_per_minute() == end_note_types_per_minute()) { return Constant; } else { return Ramp; } }
217 bool active () const { return _active; }
218 void set_active (bool yn) { _active = yn; }
220 bool locked_to_meter () const { return _locked_to_meter; }
221 void set_locked_to_meter (bool yn) { _locked_to_meter = yn; }
223 bool clamped () const { return _clamped; }
224 void set_clamped (bool yn) { _clamped = yn; }
226 Tempo tempo_at_minute (const double& minute) const;
227 double minute_at_ntpm (const double& ntpm, const double& pulse) const;
229 Tempo tempo_at_pulse (const double& pulse) const;
230 double pulse_at_ntpm (const double& ntpm, const double& minute) const;
232 double pulse_at_minute (const double& minute) const;
233 double minute_at_pulse (const double& pulse) const;
235 double compute_c_pulse (const double& end_ntpm, const double& end_pulse) const;
236 double compute_c_minute (const double& end_ntpm, const double& end_minute) const;
238 double pulse_at_frame (const framepos_t& frame) const;
239 framepos_t frame_at_pulse (const double& pulse) const;
241 Timecode::BBT_Time legacy_bbt () { return _legacy_bbt; }
242 bool legacy_end () { return _legacy_end; }
246 /* tempo ramp functions. zero-based with time in minutes,
247 * 'tick tempo' in ticks per minute and tempo in bpm.
248 * time relative to section start.
250 double a_func (double end_tpm, double c_func) const;
251 double c_func (double end_tpm, double end_time) const;
253 double _tempo_at_time (const double& time) const;
254 double _time_at_tempo (const double& tempo) const;
256 double _tempo_at_pulse (const double& pulse) const;
257 double _pulse_at_tempo (const double& tempo) const;
259 double _pulse_at_time (const double& time) const;
260 double _time_at_pulse (const double& pulse) const;
262 /* this value provides a fractional offset into the bar in which
263 the tempo section is located in. A value of 0.0 indicates that
264 it occurs on the first beat of the bar, a value of 0.5 indicates
265 that it occurs halfway through the bar and so on.
267 this enables us to keep the tempo change at the same relative
268 position within the bar if/when the meter changes.
273 bool _locked_to_meter;
275 Timecode::BBT_Time _legacy_bbt;
279 typedef std::list<MetricSection*> Metrics;
281 /** Helper class to keep track of the Meter *AND* Tempo in effect
282 at a given point in time.
284 class LIBARDOUR_API TempoMetric {
286 TempoMetric (const Meter& m, const Tempo& t)
287 : _meter (&m), _tempo (&t), _minute (0.0), _pulse (0.0) {}
289 void set_tempo (const Tempo& t) { _tempo = &t; }
290 void set_meter (const Meter& m) { _meter = &m; }
291 void set_minute (double m) { _minute = m; }
292 void set_pulse (const double& p) { _pulse = p; }
294 void set_metric (const MetricSection* section) {
295 const MeterSection* meter;
296 const TempoSection* tempo;
297 if ((meter = dynamic_cast<const MeterSection*>(section))) {
299 } else if ((tempo = dynamic_cast<const TempoSection*>(section))) {
303 set_minute (section->minute());
304 set_pulse (section->pulse());
307 const Meter& meter() const { return *_meter; }
308 const Tempo& tempo() const { return *_tempo; }
309 double minute() const { return _minute; }
310 const double& pulse() const { return _pulse; }
319 /** Tempo Map - mapping of timecode to musical time.
320 * convert audio-samples, sample-rate to Bar/Beat/Tick, Meter/Tempo
322 class LIBARDOUR_API TempoMap : public PBD::StatefulDestructible
325 TempoMap (framecnt_t frame_rate);
328 TempoMap& operator= (TempoMap const &);
330 /* measure-based stuff */
345 BBTPoint (const MeterSection& m, const Tempo& t, framepos_t f,
346 uint32_t b, uint32_t e, double func_c)
347 : frame (f), meter (m.divisions_per_bar(), m.note_divisor()), tempo (t.note_types_per_minute(), t.note_type(), t.end_note_types_per_minute()), c (func_c), bar (b), beat (e) {}
349 Timecode::BBT_Time bbt() const { return Timecode::BBT_Time (bar, beat, 0); }
350 operator Timecode::BBT_Time() const { return bbt(); }
351 operator framepos_t() const { return frame; }
352 bool is_bar() const { return beat == 1; }
355 template<class T> void apply_with_metrics (T& obj, void (T::*method)(const Metrics&)) {
356 Glib::Threads::RWLock::ReaderLock lm (lock);
357 (obj.*method)(_metrics);
360 void get_grid (std::vector<BBTPoint>&,
361 framepos_t start, framepos_t end, uint32_t bar_mod = 0);
363 static const Tempo& default_tempo() { return _default_tempo; }
364 static const Meter& default_meter() { return _default_meter; }
366 /* because tempi may be ramped, this is only valid for the instant requested.*/
367 double frames_per_quarter_note_at (const framepos_t&, const framecnt_t& sr) const;
369 const TempoSection& tempo_section_at_frame (framepos_t frame) const;
370 TempoSection& tempo_section_at_frame (framepos_t frame);
371 const MeterSection& meter_section_at_frame (framepos_t frame) const;
372 const MeterSection& meter_section_at_beat (double beat) const;
374 TempoSection* previous_tempo_section (TempoSection*) const;
375 TempoSection* next_tempo_section (TempoSection*) const;
377 /** add a tempo section locked to pls. ignored values will be set in recompute_tempi()
378 * @param pulse pulse position of new section. ignored if pls == AudioTime
379 * @param frame frame position of new section. ignored if pls == MusicTime
380 * @param type type of new tempo section (Ramp, Constant)
382 TempoSection* add_tempo (const Tempo&, const double& pulse, const framepos_t& frame, PositionLockStyle pls);
384 /** add a meter section locked to pls.. ignored values will be set in recompute_meters()
385 * @param meter the Meter to be added
386 * @param beat beat position of new section
387 * @param where bbt position of new section
388 * @param frame frame position of new section. ignored if pls == MusicTime
389 * note that @frame may also be ignored if it would create an un-solvable map
390 * (previous audio-locked tempi may place the requested beat at an earlier time than frame)
391 * in which case the new meter will be placed at the specified BBT.
392 * @param pls the position lock style
394 * adding an audio-locked meter will add a meter-locked tempo section at the meter position.
395 * the meter-locked tempo tempo will be the Tempo at @beat
397 MeterSection* add_meter (const Meter& meter, const double& beat, const Timecode::BBT_Time& where, framepos_t frame, PositionLockStyle pls);
399 void remove_tempo (const TempoSection&, bool send_signal);
400 void remove_meter (const MeterSection&, bool send_signal);
402 void replace_tempo (TempoSection&, const Tempo&, const double& pulse, const framepos_t& frame, PositionLockStyle pls);
404 void replace_meter (const MeterSection&, const Meter&, const Timecode::BBT_Time& where, framepos_t frame, PositionLockStyle pls);
406 MusicFrame round_to_bar (framepos_t frame, RoundMode dir);
407 MusicFrame round_to_beat (framepos_t frame, RoundMode dir);
408 MusicFrame round_to_quarter_note_subdivision (framepos_t fr, int sub_num, RoundMode dir);
410 void set_length (framepos_t frames);
412 XMLNode& get_state (void);
413 int set_state (const XMLNode&, int version);
415 void dump (std::ostream&) const;
418 TempoMetric metric_at (Timecode::BBT_Time bbt) const;
420 /** Return the TempoMetric at frame @p t, and point @p last to the latest
421 * metric change <= t, if it is non-NULL.
423 TempoMetric metric_at (framepos_t, Metrics::const_iterator* last=NULL) const;
425 Metrics::const_iterator metrics_end() { return _metrics.end(); }
427 void change_existing_tempo_at (framepos_t, double bpm, double note_type, double end_ntpm);
428 void change_initial_tempo (double ntpm, double note_type, double end_ntpm);
430 void insert_time (framepos_t, framecnt_t);
431 bool remove_time (framepos_t where, framecnt_t amount); //returns true if anything was moved
433 int n_tempos () const;
434 int n_meters () const;
436 framecnt_t frame_rate () const { return _frame_rate; }
438 /* TEMPO- AND METER-SENSITIVE FUNCTIONS
440 bbt_at_frame(), frame_at_bbt(), beat_at_frame(), frame_at_beat()
441 and bbt_duration_at()
442 are all sensitive to tempo and meter, and will give answers
443 that align with the grid formed by tempo and meter sections.
445 They SHOULD NOT be used to determine the position of events
446 whose location is canonically defined in Evoral::Beats.
449 double beat_at_frame (const framecnt_t& frame) const;
450 framepos_t frame_at_beat (const double& beat) const;
452 const Meter& meter_at_frame (framepos_t) const;
454 /* bbt - it's nearly always better to use meter-based beat (above)
455 unless tick resolution is desirable.
457 Timecode::BBT_Time bbt_at_frame (framepos_t when);
458 Timecode::BBT_Time bbt_at_frame_rt (framepos_t when);
459 framepos_t frame_at_bbt (const Timecode::BBT_Time&);
461 double beat_at_bbt (const Timecode::BBT_Time& bbt);
462 Timecode::BBT_Time bbt_at_beat (const double& beats);
464 double quarter_note_at_bbt (const Timecode::BBT_Time& bbt);
465 double quarter_note_at_bbt_rt (const Timecode::BBT_Time& bbt);
466 Timecode::BBT_Time bbt_at_quarter_note (const double& quarter_note);
468 framecnt_t bbt_duration_at (framepos_t, const Timecode::BBT_Time&, int dir);
469 framepos_t framepos_plus_bbt (framepos_t pos, Timecode::BBT_Time b) const;
471 /* TEMPO-SENSITIVE FUNCTIONS
473 These next 2 functions will all take tempo in account and should be
474 used to determine position (and in the last case, distance in beats)
475 when tempo matters but meter does not.
477 They SHOULD be used to determine the position of events
478 whose location is canonically defined in Evoral::Beats.
481 framepos_t framepos_plus_qn (framepos_t, Evoral::Beats) const;
482 Evoral::Beats framewalk_to_qn (framepos_t pos, framecnt_t distance) const;
484 /* quarter note related functions are also tempo-sensitive and ignore meter.
485 quarter notes may be compared with and assigned to Evoral::Beats.
487 double quarter_note_at_frame (const framepos_t frame) const;
488 double quarter_note_at_frame_rt (const framepos_t frame) const;
489 framepos_t frame_at_quarter_note (const double quarter_note) const;
491 framecnt_t frames_between_quarter_notes (const double start, const double end) const;
492 double quarter_notes_between_frames (const framecnt_t start, const framecnt_t end) const;
494 double quarter_note_at_beat (const double beat) const;
495 double beat_at_quarter_note (const double beat) const;
497 /* obtain a musical subdivision via a frame position and magic note divisor.*/
498 double exact_qn_at_frame (const framepos_t& frame, const int32_t sub_num) const;
499 double exact_beat_at_frame (const framepos_t& frame, const int32_t sub_num) const;
501 Tempo tempo_at_frame (const framepos_t& frame) const;
502 framepos_t frame_at_tempo (const Tempo& tempo) const;
503 Tempo tempo_at_quarter_note (const double& beat) const;
504 double quarter_note_at_tempo (const Tempo& tempo) const;
506 void gui_set_tempo_position (TempoSection*, const framepos_t& frame, const int& sub_num);
507 void gui_set_meter_position (MeterSection*, const framepos_t& frame);
508 bool gui_change_tempo (TempoSection*, const Tempo& bpm);
509 void gui_stretch_tempo (TempoSection* tempo, const framepos_t frame, const framepos_t end_frame);
510 void gui_stretch_tempo_end (TempoSection* tempo, const framepos_t frame, const framepos_t end_frame);
511 bool gui_twist_tempi (TempoSection* first, const Tempo& bpm, const framepos_t frame, const framepos_t end_frame);
513 std::pair<double, framepos_t> predict_tempo_position (TempoSection* section, const Timecode::BBT_Time& bbt);
514 bool can_solve_bbt (TempoSection* section, const Timecode::BBT_Time& bbt);
516 PBD::Signal1<void,const PBD::PropertyChange&> MetricPositionChanged;
517 void fix_legacy_session();
518 void fix_legacy_end_session();
521 /* prevent copy construction */
522 TempoMap (TempoMap const&);
524 TempoSection* previous_tempo_section_locked (const Metrics& metrics, TempoSection*) const;
525 TempoSection* next_tempo_section_locked (const Metrics& metrics, TempoSection*) const;
527 double beat_at_minute_locked (const Metrics& metrics, const double& minute) const;
528 double minute_at_beat_locked (const Metrics& metrics, const double& beat) const;
530 double pulse_at_beat_locked (const Metrics& metrics, const double& beat) const;
531 double beat_at_pulse_locked (const Metrics& metrics, const double& pulse) const;
533 double pulse_at_minute_locked (const Metrics& metrics, const double& minute) const;
534 double minute_at_pulse_locked (const Metrics& metrics, const double& pulse) const;
536 Tempo tempo_at_minute_locked (const Metrics& metrics, const double& minute) const;
537 double minute_at_tempo_locked (const Metrics& metrics, const Tempo& tempo) const;
539 Tempo tempo_at_pulse_locked (const Metrics& metrics, const double& pulse) const;
540 double pulse_at_tempo_locked (const Metrics& metrics, const Tempo& tempo) const;
542 Timecode::BBT_Time bbt_at_minute_locked (const Metrics& metrics, const double& minute) const;
543 double minute_at_bbt_locked (const Metrics& metrics, const Timecode::BBT_Time&) const;
545 double beat_at_bbt_locked (const Metrics& metrics, const Timecode::BBT_Time& bbt) const ;
546 Timecode::BBT_Time bbt_at_beat_locked (const Metrics& metrics, const double& beats) const;
548 double pulse_at_bbt_locked (const Metrics& metrics, const Timecode::BBT_Time& bbt) const;
549 Timecode::BBT_Time bbt_at_pulse_locked (const Metrics& metrics, const double& pulse) const;
551 double minutes_between_quarter_notes_locked (const Metrics& metrics, const double start_qn, const double end_qn) const;
552 double quarter_notes_between_frames_locked (const Metrics& metrics, const framecnt_t start, const framecnt_t end) const;
554 const TempoSection& tempo_section_at_minute_locked (const Metrics& metrics, double minute) const;
555 TempoSection& tempo_section_at_minute_locked (const Metrics& metrics, double minute);
556 const TempoSection& tempo_section_at_beat_locked (const Metrics& metrics, const double& beat) const;
558 const MeterSection& meter_section_at_minute_locked (const Metrics& metrics, double minute) const;
559 const MeterSection& meter_section_at_beat_locked (const Metrics& metrics, const double& beat) const;
561 bool check_solved (const Metrics& metrics) const;
562 bool set_active_tempi (const Metrics& metrics, const framepos_t& frame);
564 bool solve_map_minute (Metrics& metrics, TempoSection* section, const double& minute);
565 bool solve_map_pulse (Metrics& metrics, TempoSection* section, const double& pulse);
566 bool solve_map_minute (Metrics& metrics, MeterSection* section, const double& minute);
567 bool solve_map_bbt (Metrics& metrics, MeterSection* section, const Timecode::BBT_Time& bbt);
569 double exact_beat_at_frame_locked (const Metrics& metrics, const framepos_t& frame, const int32_t sub_num) const;
570 double exact_qn_at_frame_locked (const Metrics& metrics, const framepos_t& frame, const int32_t sub_num) const;
572 double minute_at_frame (const framepos_t frame) const;
573 framepos_t frame_at_minute (const double minute) const;
575 friend class ::BBTTest;
576 friend class ::FrameposPlusBeatsTest;
577 friend class ::FrameposMinusBeatsTest;
578 friend class ::TempoTest;
580 static Tempo _default_tempo;
581 static Meter _default_meter;
584 framecnt_t _frame_rate;
585 mutable Glib::Threads::RWLock lock;
587 void recompute_tempi (Metrics& metrics);
588 void recompute_meters (Metrics& metrics);
589 void recompute_map (Metrics& metrics, framepos_t end = -1);
591 MusicFrame round_to_type (framepos_t fr, RoundMode dir, BBTPointType);
593 const MeterSection& first_meter() const;
594 MeterSection& first_meter();
595 const TempoSection& first_tempo() const;
596 TempoSection& first_tempo();
598 void do_insert (MetricSection* section);
600 TempoSection* add_tempo_locked (const Tempo&, double pulse, double minute
601 , PositionLockStyle pls, bool recompute, bool locked_to_meter = false);
603 MeterSection* add_meter_locked (const Meter&, double beat, const Timecode::BBT_Time& where, framepos_t frame, PositionLockStyle pls, bool recompute);
605 bool remove_tempo_locked (const TempoSection&);
606 bool remove_meter_locked (const MeterSection&);
608 TempoSection* copy_metrics_and_point (const Metrics& metrics, Metrics& copy, TempoSection* section) const;
609 MeterSection* copy_metrics_and_point (const Metrics& metrics, Metrics& copy, MeterSection* section) const;
612 }; /* namespace ARDOUR */
614 LIBARDOUR_API std::ostream& operator<< (std::ostream&, const ARDOUR::Meter&);
615 LIBARDOUR_API std::ostream& operator<< (std::ostream&, const ARDOUR::Tempo&);
616 LIBARDOUR_API std::ostream& operator<< (std::ostream&, const ARDOUR::MetricSection&);
618 #endif /* __ardour_tempo_h__ */