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) {}
59 double note_types_per_minute () const { return _note_types_per_minute; }
60 double note_types_per_minute (double note_type) const { return (_note_types_per_minute / _note_type) * note_type; }
61 void set_note_types_per_minute (double npm) { _note_types_per_minute = npm; }
62 double note_type () const { return _note_type; }
64 double quarter_notes_per_minute () const { return note_types_per_minute (4.0); }
65 double pulses_per_minute () const { return note_types_per_minute (1.0); }
66 /** audio samples per note type.
67 * if you want an instantaneous value for this, use TempoMap::frames_per_quarter_note_at() instead.
68 * @param sr samplerate
70 double frames_per_note_type (framecnt_t sr) const {
71 return (60.0 * sr) / _note_types_per_minute;
73 /** audio samples per quarter note.
74 * if you want an instantaneous value for this, use TempoMap::frames_per_quarter_note_at() instead.
75 * @param sr samplerate
77 double frames_per_quarter_note (framecnt_t sr) const {
78 return (60.0 * sr) / quarter_notes_per_minute ();
82 double _note_types_per_minute;
86 /** Meter, or time signature (beats per bar, and which note type is a beat). */
87 class LIBARDOUR_API Meter {
89 Meter (double dpb, double bt)
90 : _divisions_per_bar (dpb), _note_type (bt) {}
92 double divisions_per_bar () const { return _divisions_per_bar; }
93 double note_divisor() const { return _note_type; }
95 double frames_per_bar (const Tempo&, framecnt_t sr) const;
96 double frames_per_grid (const Tempo&, framecnt_t sr) const;
98 inline bool operator==(const Meter& other)
99 { return _divisions_per_bar == other.divisions_per_bar() && _note_type == other.note_divisor(); }
102 /** The number of divisions in a bar. This is a floating point value because
103 there are musical traditions on our planet that do not limit
104 themselves to integral numbers of beats per bar.
106 double _divisions_per_bar;
108 /** The type of "note" that a division represents. For example, 4.0 is
109 a quarter (crotchet) note, 8.0 is an eighth (quaver) note, etc.
114 /** A section of timeline with a certain Tempo or Meter. */
115 class LIBARDOUR_API MetricSection {
117 MetricSection (double pulse, double minute, PositionLockStyle pls, bool is_tempo, framecnt_t sample_rate)
118 : _pulse (pulse), _minute (minute), _initial (false), _position_lock_style (pls), _is_tempo (is_tempo), _sample_rate (sample_rate) {}
120 virtual ~MetricSection() {}
122 const double& pulse () const { return _pulse; }
123 void set_pulse (double pulse) { _pulse = pulse; }
125 double minute() const { return _minute; }
126 virtual void set_minute (double m) {
130 framepos_t frame () const { return frame_at_minute (_minute); }
132 void set_initial (bool yn) { _initial = yn; }
133 bool initial() const { return _initial; }
135 /* MeterSections are not stateful in the full sense,
136 but we do want them to control their own
137 XML state information.
139 virtual XMLNode& get_state() const = 0;
141 PositionLockStyle position_lock_style () const { return _position_lock_style; }
142 void set_position_lock_style (PositionLockStyle ps) { _position_lock_style = ps; }
143 bool is_tempo () const { return _is_tempo; }
145 framepos_t frame_at_minute (const double& time) const;
146 double minute_at_frame (const framepos_t& frame) const;
153 PositionLockStyle _position_lock_style;
154 const bool _is_tempo;
155 framecnt_t _sample_rate;
158 /** A section of timeline with a certain Meter. */
159 class LIBARDOUR_API MeterSection : public MetricSection, public Meter {
161 MeterSection (double pulse, double minute, double beat, const Timecode::BBT_Time& bbt, double bpb, double note_type, PositionLockStyle pls, framecnt_t sr)
162 : MetricSection (pulse, minute, pls, false, sr), Meter (bpb, note_type), _bbt (bbt), _beat (beat) {}
164 MeterSection (const XMLNode&, const framecnt_t sample_rate);
166 static const std::string xml_state_node_name;
168 XMLNode& get_state() const;
170 void set_beat (std::pair<double, Timecode::BBT_Time>& w) {
175 const Timecode::BBT_Time& bbt() const { return _bbt; }
176 const double& beat () const { return _beat; }
177 void set_beat (double beat) { _beat = beat; }
180 Timecode::BBT_Time _bbt;
184 /** A section of timeline with a certain Tempo. */
185 class LIBARDOUR_API TempoSection : public MetricSection, public Tempo {
192 TempoSection (const double& pulse, const double& minute, double qpm, double note_type, Type tempo_type, PositionLockStyle pls, framecnt_t sr)
193 : MetricSection (pulse, minute, pls, true, sr), Tempo (qpm, note_type), _type (tempo_type), _c (0.0), _active (true), _locked_to_meter (false) {}
195 TempoSection (const XMLNode&, const framecnt_t sample_rate);
197 static const std::string xml_state_node_name;
199 XMLNode& get_state() const;
201 double c () const { return _c; }
202 void set_c (double c) { _c = c; }
204 void set_type (Type type);
205 Type type () const { return _type; }
207 bool active () const { return _active; }
208 void set_active (bool yn) { _active = yn; }
210 bool locked_to_meter () const { return _locked_to_meter; }
211 void set_locked_to_meter (bool yn) { _locked_to_meter = yn; }
213 Tempo tempo_at_minute (const double& minute) const;
214 double minute_at_ntpm (const double& ntpm, const double& pulse) const;
216 Tempo tempo_at_pulse (const double& pulse) const;
217 double pulse_at_ntpm (const double& ntpm, const double& minute) const;
219 double pulse_at_minute (const double& minute) const;
220 double minute_at_pulse (const double& pulse) const;
222 double compute_c_pulse (const double& end_ntpm, const double& end_pulse) const;
223 double compute_c_minute (const double& end_ntpm, const double& end_minute) const;
225 double pulse_at_frame (const framepos_t& frame) const;
226 framepos_t frame_at_pulse (const double& pulse) const;
228 Timecode::BBT_Time legacy_bbt () { return _legacy_bbt; }
232 /* tempo ramp functions. zero-based with time in minutes,
233 * 'tick tempo' in ticks per minute and tempo in bpm.
234 * time relative to section start.
236 double a_func (double end_tpm, double c_func) const;
237 double c_func (double end_tpm, double end_time) const;
239 double _tempo_at_time (const double& time) const;
240 double _time_at_tempo (const double& tempo) const;
242 double _tempo_at_pulse (const double& pulse) const;
243 double _pulse_at_tempo (const double& tempo) const;
245 double _pulse_at_time (const double& time) const;
246 double _time_at_pulse (const double& pulse) const;
248 /* this value provides a fractional offset into the bar in which
249 the tempo section is located in. A value of 0.0 indicates that
250 it occurs on the first beat of the bar, a value of 0.5 indicates
251 that it occurs halfway through the bar and so on.
253 this enables us to keep the tempo change at the same relative
254 position within the bar if/when the meter changes.
259 bool _locked_to_meter;
260 Timecode::BBT_Time _legacy_bbt;
263 typedef std::list<MetricSection*> Metrics;
265 /** Helper class to keep track of the Meter *AND* Tempo in effect
266 at a given point in time.
268 class LIBARDOUR_API TempoMetric {
270 TempoMetric (const Meter& m, const Tempo& t)
271 : _meter (&m), _tempo (&t), _minute (0.0), _pulse (0.0) {}
273 void set_tempo (const Tempo& t) { _tempo = &t; }
274 void set_meter (const Meter& m) { _meter = &m; }
275 void set_minute (double m) { _minute = m; }
276 void set_pulse (const double& p) { _pulse = p; }
278 void set_metric (const MetricSection* section) {
279 const MeterSection* meter;
280 const TempoSection* tempo;
281 if ((meter = dynamic_cast<const MeterSection*>(section))) {
283 } else if ((tempo = dynamic_cast<const TempoSection*>(section))) {
287 set_minute (section->minute());
288 set_pulse (section->pulse());
291 const Meter& meter() const { return *_meter; }
292 const Tempo& tempo() const { return *_tempo; }
293 double minute() const { return _minute; }
294 const double& pulse() const { return _pulse; }
303 /** Tempo Map - mapping of timecode to musical time.
304 * convert audio-samples, sample-rate to Bar/Beat/Tick, Meter/Tempo
306 class LIBARDOUR_API TempoMap : public PBD::StatefulDestructible
309 TempoMap (framecnt_t frame_rate);
310 TempoMap (TempoMap const &);
313 TempoMap& operator= (TempoMap const &);
315 /* measure-based stuff */
330 BBTPoint (const MeterSection& m, const Tempo& t, framepos_t f,
331 uint32_t b, uint32_t e, double func_c)
332 : frame (f), meter (m.divisions_per_bar(), m.note_divisor()), tempo (t.note_types_per_minute(), t.note_type()), c (func_c), bar (b), beat (e) {}
334 Timecode::BBT_Time bbt() const { return Timecode::BBT_Time (bar, beat, 0); }
335 operator Timecode::BBT_Time() const { return bbt(); }
336 operator framepos_t() const { return frame; }
337 bool is_bar() const { return beat == 1; }
340 template<class T> void apply_with_metrics (T& obj, void (T::*method)(const Metrics&)) {
341 Glib::Threads::RWLock::ReaderLock lm (lock);
342 (obj.*method)(_metrics);
345 void get_grid (std::vector<BBTPoint>&,
346 framepos_t start, framepos_t end, uint32_t bar_mod = 0);
348 static const Tempo& default_tempo() { return _default_tempo; }
349 static const Meter& default_meter() { return _default_meter; }
351 /* because tempi may be ramped, this is only valid for the instant requested.*/
352 double frames_per_quarter_note_at (const framepos_t&, const framecnt_t& sr) const;
354 const TempoSection& tempo_section_at_frame (framepos_t frame) const;
355 TempoSection& tempo_section_at_frame (framepos_t frame);
356 const MeterSection& meter_section_at_frame (framepos_t frame) const;
357 const MeterSection& meter_section_at_beat (double beat) const;
359 /** add a tempo section locked to pls. ignored values will be set in recompute_tempi()
360 * @param pulse pulse position of new section. ignored if pls == AudioTime
361 * @param frame frame position of new section. ignored if pls == MusicTime
362 * @param type type of new tempo section (Ramp, Constant)
364 TempoSection* add_tempo (const Tempo&, const double& pulse, const framepos_t& frame, TempoSection::Type type, PositionLockStyle pls);
366 /** add a meter section locked to pls.. ignored values will be set in recompute_meters()
367 * @param meter the Meter to be added
368 * @param beat beat position of new section
369 * @param where bbt position of new section
370 * @param frame frame position of new section. ignored if pls == MusicTime
371 * note that @frame may also be ignored if it would create an un-solvable map
372 * (previous audio-locked tempi may place the requested beat at an earlier time than frame)
373 * in which case the new meter will be placed at the specified BBT.
374 * @param pls the position lock style
376 * adding an audio-locked meter will add a meter-locked tempo section at the meter position.
377 * the meter-locked tempo tempo will be the Tempo at @beat
379 MeterSection* add_meter (const Meter& meter, const double& beat, const Timecode::BBT_Time& where, framepos_t frame, PositionLockStyle pls);
381 void remove_tempo (const TempoSection&, bool send_signal);
382 void remove_meter (const MeterSection&, bool send_signal);
384 void replace_tempo (TempoSection&, const Tempo&, const double& pulse, const framepos_t& frame
385 , TempoSection::Type type, PositionLockStyle pls);
387 void replace_meter (const MeterSection&, const Meter&, const Timecode::BBT_Time& where, framepos_t frame, PositionLockStyle pls);
389 MusicFrame round_to_bar (framepos_t frame, RoundMode dir);
390 MusicFrame round_to_beat (framepos_t frame, RoundMode dir);
391 framepos_t round_to_beat_subdivision (framepos_t fr, int sub_num, RoundMode dir);
392 MusicFrame round_to_quarter_note_subdivision (framepos_t fr, int sub_num, RoundMode dir);
394 void set_length (framepos_t frames);
396 XMLNode& get_state (void);
397 int set_state (const XMLNode&, int version);
399 void dump (std::ostream&) const;
402 TempoMetric metric_at (Timecode::BBT_Time bbt) const;
404 /** Return the TempoMetric at frame @p t, and point @p last to the latest
405 * metric change <= t, if it is non-NULL.
407 TempoMetric metric_at (framepos_t, Metrics::const_iterator* last=NULL) const;
409 Metrics::const_iterator metrics_end() { return _metrics.end(); }
411 void change_existing_tempo_at (framepos_t, double bpm, double note_type);
412 void change_initial_tempo (double bpm, double note_type);
414 void insert_time (framepos_t, framecnt_t);
415 bool remove_time (framepos_t where, framecnt_t amount); //returns true if anything was moved
417 int n_tempos () const;
418 int n_meters () const;
420 framecnt_t frame_rate () const { return _frame_rate; }
422 /* TEMPO- AND METER-SENSITIVE FUNCTIONS
424 bbt_at_frame(), frame_at_bbt(), beat_at_frame(), frame_at_beat()
425 and bbt_duration_at()
426 are all sensitive to tempo and meter, and will give answers
427 that align with the grid formed by tempo and meter sections.
429 They SHOULD NOT be used to determine the position of events
430 whose location is canonically defined in Evoral::Beats.
433 double beat_at_frame (const framecnt_t& frame) const;
434 framepos_t frame_at_beat (const double& beat) const;
436 const Meter& meter_at_frame (framepos_t) const;
438 /* bbt - it's nearly always better to use meter-based beat (above)
439 unless tick resolution is desirable.
441 Timecode::BBT_Time bbt_at_frame (framepos_t when);
442 Timecode::BBT_Time bbt_at_frame_rt (framepos_t when);
443 framepos_t frame_at_bbt (const Timecode::BBT_Time&);
445 double beat_at_bbt (const Timecode::BBT_Time& bbt);
446 Timecode::BBT_Time bbt_at_beat (const double& beats);
448 double quarter_note_at_bbt (const Timecode::BBT_Time& bbt);
449 double quarter_note_at_bbt_rt (const Timecode::BBT_Time& bbt);
450 Timecode::BBT_Time bbt_at_quarter_note (const double& quarter_note);
452 framecnt_t bbt_duration_at (framepos_t, const Timecode::BBT_Time&, int dir);
453 framepos_t framepos_plus_bbt (framepos_t pos, Timecode::BBT_Time b) const;
455 /* TEMPO-SENSITIVE FUNCTIONS
457 These next 2 functions will all take tempo in account and should be
458 used to determine position (and in the last case, distance in beats)
459 when tempo matters but meter does not.
461 They SHOULD be used to determine the position of events
462 whose location is canonically defined in Evoral::Beats.
465 framepos_t framepos_plus_qn (framepos_t, Evoral::Beats) const;
466 Evoral::Beats framewalk_to_qn (framepos_t pos, framecnt_t distance) const;
468 /* quarter note related functions are also tempo-sensitive and ignore meter.
469 quarter notes may be compared with and assigned to Evoral::Beats.
471 double quarter_note_at_frame (const framepos_t frame) const;
472 double quarter_note_at_frame_rt (const framepos_t frame) const;
473 framepos_t frame_at_quarter_note (const double quarter_note) const;
475 framecnt_t frames_between_quarter_notes (const double start, const double end) const;
476 double quarter_notes_between_frames (const framecnt_t start, const framecnt_t end) const;
478 double quarter_note_at_beat (const double beat) const;
479 double beat_at_quarter_note (const double beat) const;
481 /* obtain a musical subdivision via a frame position and magic note divisor.*/
482 double exact_qn_at_frame (const framepos_t& frame, const int32_t sub_num) const;
483 double exact_beat_at_frame (const framepos_t& frame, const int32_t sub_num) const;
485 Tempo tempo_at_frame (const framepos_t& frame) const;
486 framepos_t frame_at_tempo (const Tempo& tempo) const;
487 Tempo tempo_at_quarter_note (const double& beat) const;
488 double quarter_note_at_tempo (const Tempo& tempo) const;
490 void gui_set_tempo_position (TempoSection*, const framepos_t& frame, const int& sub_num);
491 void gui_set_meter_position (MeterSection*, const framepos_t& frame);
492 bool gui_change_tempo (TempoSection*, const Tempo& bpm);
493 void gui_stretch_tempo (TempoSection* tempo, const framepos_t& frame, const framepos_t& end_frame);
495 std::pair<double, framepos_t> predict_tempo_position (TempoSection* section, const Timecode::BBT_Time& bbt);
496 bool can_solve_bbt (TempoSection* section, const Timecode::BBT_Time& bbt);
498 PBD::Signal1<void,const PBD::PropertyChange&> MetricPositionChanged;
499 void fix_legacy_session();
503 double beat_at_minute_locked (const Metrics& metrics, const double& minute) const;
504 double minute_at_beat_locked (const Metrics& metrics, const double& beat) const;
506 double pulse_at_beat_locked (const Metrics& metrics, const double& beat) const;
507 double beat_at_pulse_locked (const Metrics& metrics, const double& pulse) const;
509 double pulse_at_minute_locked (const Metrics& metrics, const double& minute) const;
510 double minute_at_pulse_locked (const Metrics& metrics, const double& pulse) const;
512 Tempo tempo_at_minute_locked (const Metrics& metrics, const double& minute) const;
513 double minute_at_tempo_locked (const Metrics& metrics, const Tempo& tempo) const;
515 Tempo tempo_at_pulse_locked (const Metrics& metrics, const double& pulse) const;
516 double pulse_at_tempo_locked (const Metrics& metrics, const Tempo& tempo) const;
518 Timecode::BBT_Time bbt_at_minute_locked (const Metrics& metrics, const double& minute) const;
519 double minute_at_bbt_locked (const Metrics& metrics, const Timecode::BBT_Time&) const;
521 double beat_at_bbt_locked (const Metrics& metrics, const Timecode::BBT_Time& bbt) const ;
522 Timecode::BBT_Time bbt_at_beat_locked (const Metrics& metrics, const double& beats) const;
524 double pulse_at_bbt_locked (const Metrics& metrics, const Timecode::BBT_Time& bbt) const;
525 Timecode::BBT_Time bbt_at_pulse_locked (const Metrics& metrics, const double& pulse) const;
527 double minutes_between_quarter_notes_locked (const Metrics& metrics, const double start_qn, const double end_qn) const;
528 double quarter_notes_between_frames_locked (const Metrics& metrics, const framecnt_t start, const framecnt_t end) const;
530 const TempoSection& tempo_section_at_minute_locked (const Metrics& metrics, double minute) const;
531 TempoSection& tempo_section_at_minute_locked (const Metrics& metrics, double minute);
532 const TempoSection& tempo_section_at_beat_locked (const Metrics& metrics, const double& beat) const;
534 const MeterSection& meter_section_at_minute_locked (const Metrics& metrics, double minute) const;
535 const MeterSection& meter_section_at_beat_locked (const Metrics& metrics, const double& beat) const;
537 bool check_solved (const Metrics& metrics) const;
538 bool set_active_tempi (const Metrics& metrics, const framepos_t& frame);
540 bool solve_map_minute (Metrics& metrics, TempoSection* section, const double& minute);
541 bool solve_map_pulse (Metrics& metrics, TempoSection* section, const double& pulse);
542 bool solve_map_minute (Metrics& metrics, MeterSection* section, const double& minute);
543 bool solve_map_bbt (Metrics& metrics, MeterSection* section, const Timecode::BBT_Time& bbt);
545 double exact_beat_at_frame_locked (const Metrics& metrics, const framepos_t& frame, const int32_t sub_num) const;
546 double exact_qn_at_frame_locked (const Metrics& metrics, const framepos_t& frame, const int32_t sub_num) const;
548 double minute_at_frame (const framepos_t frame) const;
549 framepos_t frame_at_minute (const double minute) const;
551 friend class ::BBTTest;
552 friend class ::FrameposPlusBeatsTest;
553 friend class ::FrameposMinusBeatsTest;
554 friend class ::TempoTest;
556 static Tempo _default_tempo;
557 static Meter _default_meter;
560 framecnt_t _frame_rate;
561 mutable Glib::Threads::RWLock lock;
563 void recompute_tempi (Metrics& metrics);
564 void recompute_meters (Metrics& metrics);
565 void recompute_map (Metrics& metrics, framepos_t end = -1);
567 MusicFrame round_to_type (framepos_t fr, RoundMode dir, BBTPointType);
569 const MeterSection& first_meter() const;
570 MeterSection& first_meter();
571 const TempoSection& first_tempo() const;
572 TempoSection& first_tempo();
574 void do_insert (MetricSection* section);
576 TempoSection* add_tempo_locked (const Tempo&, double pulse, double minute
577 , TempoSection::Type type, PositionLockStyle pls, bool recompute, bool locked_to_meter = false);
579 MeterSection* add_meter_locked (const Meter&, double beat, const Timecode::BBT_Time& where, framepos_t frame, PositionLockStyle pls, bool recompute);
581 bool remove_tempo_locked (const TempoSection&);
582 bool remove_meter_locked (const MeterSection&);
584 TempoSection* copy_metrics_and_point (const Metrics& metrics, Metrics& copy, TempoSection* section);
585 MeterSection* copy_metrics_and_point (const Metrics& metrics, Metrics& copy, MeterSection* section);
588 }; /* namespace ARDOUR */
590 LIBARDOUR_API std::ostream& operator<< (std::ostream&, const ARDOUR::Meter&);
591 LIBARDOUR_API std::ostream& operator<< (std::ostream&, const ARDOUR::Tempo&);
592 LIBARDOUR_API std::ostream& operator<< (std::ostream&, const ARDOUR::MetricSection&);
594 #endif /* __ardour_tempo_h__ */