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 /* ..or more aptly 'pulse divisions per minute'.
59 Nothing to do with actual beats, which are defined by the meter and tempo.
61 double beats_per_minute () const { return _beats_per_minute; }
62 void set_beats_per_minute (double bpm) { _beats_per_minute = bpm; }
63 double note_type () const { return _note_type; }
64 double pulses_per_minute () const { return _beats_per_minute / _note_type; }
65 /** audio samples per beat
66 * @param sr samplerate
68 double frames_per_beat (framecnt_t sr) const {
69 return (60.0 * sr) / _beats_per_minute;
71 double frames_per_pulse (framecnt_t sr) const {
72 return (_note_type * 60.0 * sr) / _beats_per_minute;
76 double _beats_per_minute;
80 /** Meter, or time signature (beats per bar, and which note type is a beat). */
81 class LIBARDOUR_API Meter {
83 Meter (double dpb, double bt)
84 : _divisions_per_bar (dpb), _note_type (bt) {}
86 double divisions_per_bar () const { return _divisions_per_bar; }
87 double note_divisor() const { return _note_type; }
89 double frames_per_bar (const Tempo&, framecnt_t sr) const;
90 double frames_per_grid (const Tempo&, framecnt_t sr) const;
93 /** The number of divisions in a bar. This is a floating point value because
94 there are musical traditions on our planet that do not limit
95 themselves to integral numbers of beats per bar.
97 double _divisions_per_bar;
99 /** The type of "note" that a division represents. For example, 4.0 is
100 a quarter (crotchet) note, 8.0 is an eighth (quaver) note, etc.
105 /** A section of timeline with a certain Tempo or Meter. */
106 class LIBARDOUR_API MetricSection {
108 MetricSection (double pulse)
109 : _pulse (pulse), _frame (0), _movable (true), _position_lock_style (MusicTime) {}
110 MetricSection (framepos_t frame)
111 : _pulse (0.0), _frame (frame), _movable (true), _position_lock_style (AudioTime) {}
113 virtual ~MetricSection() {}
115 const double& pulse () const { return _pulse; }
116 void set_pulse (double pulse) { _pulse = pulse; }
118 framepos_t frame() const { return _frame; }
119 virtual void set_frame (framepos_t f) {
123 void set_movable (bool yn) { _movable = yn; }
124 bool movable() const { return _movable; }
126 /* MeterSections are not stateful in the full sense,
127 but we do want them to control their own
128 XML state information.
130 virtual XMLNode& get_state() const = 0;
132 PositionLockStyle position_lock_style () const { return _position_lock_style; }
133 void set_position_lock_style (PositionLockStyle ps) { _position_lock_style = ps; }
139 PositionLockStyle _position_lock_style;
142 /** A section of timeline with a certain Meter. */
143 class LIBARDOUR_API MeterSection : public MetricSection, public Meter {
145 MeterSection (double pulse, double beat, const Timecode::BBT_Time& bbt, double bpb, double note_type)
146 : MetricSection (pulse), Meter (bpb, note_type), _bbt (bbt), _beat (beat) {}
147 MeterSection (framepos_t frame, double beat, const Timecode::BBT_Time& bbt, double bpb, double note_type)
148 : MetricSection (frame), 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_pulse (double w) {
156 MetricSection::set_pulse (w);
158 void set_beat (std::pair<double, Timecode::BBT_Time>& w) {
163 const Timecode::BBT_Time& bbt() const { return _bbt; }
164 const double& beat () const { return _beat; }
165 void set_beat (double beat) { _beat = beat; }
168 Timecode::BBT_Time _bbt;
172 /** A section of timeline with a certain Tempo. */
173 class LIBARDOUR_API TempoSection : public MetricSection, public Tempo {
180 TempoSection (const double& beat, double qpm, double note_type, Type tempo_type)
181 : MetricSection (beat), Tempo (qpm, note_type), _type (tempo_type), _c_func (0.0), _active (true), _locked_to_meter (false) {}
182 TempoSection (framepos_t frame, double qpm, double note_type, Type tempo_type)
183 : MetricSection (frame), Tempo (qpm, note_type), _type (tempo_type), _c_func (0.0), _active (true), _locked_to_meter (false) {}
184 TempoSection (const XMLNode&);
186 static const std::string xml_state_node_name;
188 XMLNode& get_state() const;
190 double c_func () const { return _c_func; }
191 void set_c_func (double c_func) { _c_func = c_func; }
193 void set_type (Type type);
194 Type type () const { return _type; }
196 bool active () const { return _active; }
197 void set_active (bool yn) { _active = yn; }
199 bool locked_to_meter () const { return _locked_to_meter; }
200 void set_locked_to_meter (bool yn) { _locked_to_meter = yn; }
202 double tempo_at_frame (const frameoffset_t& frame, const framecnt_t& frame_rate) const;
203 frameoffset_t frame_at_tempo (const double& ppm, const double& beat, const framecnt_t& frame_rate) const;
205 double tempo_at_pulse (const double& pulse) const;
206 double pulse_at_tempo (const double& ppm, const framepos_t& frame, const framecnt_t& frame_rate) const;
208 double pulse_at_frame (const framepos_t& frame, const framecnt_t& frame_rate) const;
209 framepos_t frame_at_pulse (const double& pulse, const framecnt_t& frame_rate) const;
211 double compute_c_func_pulse (const double& end_bpm, const double& end_pulse, const framecnt_t& frame_rate);
212 double compute_c_func_frame (const double& end_bpm, const framepos_t& end_frame, const framecnt_t& frame_rate) const;
214 Timecode::BBT_Time legacy_bbt () { return _legacy_bbt; }
218 frameoffset_t minute_to_frame (const double& time, const framecnt_t& frame_rate) const;
219 double frame_to_minute (const frameoffset_t& frame, const framecnt_t& frame_rate) const;
221 /* tempo ramp functions. zero-based with time in minutes,
222 * 'tick tempo' in ticks per minute and tempo in bpm.
223 * time relative to section start.
225 double a_func (double end_tpm, double c_func) const;
226 double c_func (double end_tpm, double end_time) const;
228 double pulse_tempo_at_time (const double& time) const;
229 double time_at_pulse_tempo (const double& pulse_tempo) const;
231 double pulse_tempo_at_pulse (const double& pulse) const;
232 double pulse_at_pulse_tempo (const double& pulse_tempo) const;
234 double pulse_at_time (const double& time) const;
235 double time_at_pulse (const double& pulse) const;
237 /* this value provides a fractional offset into the bar in which
238 the tempo section is located in. A value of 0.0 indicates that
239 it occurs on the first beat of the bar, a value of 0.5 indicates
240 that it occurs halfway through the bar and so on.
242 this enables us to keep the tempo change at the same relative
243 position within the bar if/when the meter changes.
248 bool _locked_to_meter;
249 Timecode::BBT_Time _legacy_bbt;
252 typedef std::list<MetricSection*> Metrics;
254 /** Helper class to keep track of the Meter *AND* Tempo in effect
255 at a given point in time.
257 class LIBARDOUR_API TempoMetric {
259 TempoMetric (const Meter& m, const Tempo& t)
260 : _meter (&m), _tempo (&t), _frame (0) {}
262 void set_tempo (const Tempo& t) { _tempo = &t; }
263 void set_meter (const Meter& m) { _meter = &m; }
264 void set_frame (framepos_t f) { _frame = f; }
265 void set_pulse (const double& p) { _pulse = p; }
267 void set_metric (const MetricSection* section) {
268 const MeterSection* meter;
269 const TempoSection* tempo;
270 if ((meter = dynamic_cast<const MeterSection*>(section))) {
272 } else if ((tempo = dynamic_cast<const TempoSection*>(section))) {
276 set_frame (section->frame());
277 set_pulse (section->pulse());
280 const Meter& meter() const { return *_meter; }
281 const Tempo& tempo() const { return *_tempo; }
282 framepos_t frame() const { return _frame; }
283 const double& pulse() const { return _pulse; }
292 /** Tempo Map - mapping of timecode to musical time.
293 * convert audio-samples, sample-rate to Bar/Beat/Tick, Meter/Tempo
295 class LIBARDOUR_API TempoMap : public PBD::StatefulDestructible
298 TempoMap (framecnt_t frame_rate);
301 /* measure-based stuff */
316 BBTPoint (const MeterSection& m, const Tempo& t, framepos_t f,
317 uint32_t b, uint32_t e, double func_c)
318 : frame (f), meter (m.note_divisor(), m.divisions_per_bar()), tempo (t.beats_per_minute(), t.note_type()), c (func_c), bar (b), beat (e) {}
320 Timecode::BBT_Time bbt() const { return Timecode::BBT_Time (bar, beat, 0); }
321 operator Timecode::BBT_Time() const { return bbt(); }
322 operator framepos_t() const { return frame; }
323 bool is_bar() const { return beat == 1; }
326 template<class T> void apply_with_metrics (T& obj, void (T::*method)(const Metrics&)) {
327 Glib::Threads::RWLock::ReaderLock lm (lock);
328 (obj.*method)(_metrics);
331 void get_grid (std::vector<BBTPoint>&,
332 framepos_t start, framepos_t end);
334 /* TEMPO- AND METER-SENSITIVE FUNCTIONS
336 bbt_time(), beat_at_frame(), frame_at_beat(), tick_at_frame(),
337 frame_at_tick(),frame_time() and bbt_duration_at()
338 are all sensitive to tempo and meter, and will give answers
339 that align with the grid formed by tempo and meter sections.
341 They SHOULD NOT be used to determine the position of events
342 whose location is canonically defined in beats.
345 void bbt_time (framepos_t when, Timecode::BBT_Time&);
347 double beat_at_frame (const framecnt_t& frame) const;
348 framecnt_t frame_at_beat (const double& beat) const;
350 framepos_t frame_time (const Timecode::BBT_Time&);
351 framecnt_t bbt_duration_at (framepos_t, const Timecode::BBT_Time&, int dir);
353 /* TEMPO-SENSITIVE FUNCTIONS
355 These next 4 functions will all take tempo in account and should be
356 used to determine position (and in the last case, distance in beats)
357 when tempo matters but meter does not.
359 They SHOULD be used to determine the position of events
360 whose location is canonically defined in beats.
363 framepos_t framepos_plus_bbt (framepos_t pos, Timecode::BBT_Time b) const;
364 framepos_t framepos_plus_beats (framepos_t, Evoral::Beats) const;
365 framepos_t framepos_minus_beats (framepos_t, Evoral::Beats) const;
366 Evoral::Beats framewalk_to_beats (framepos_t pos, framecnt_t distance) const;
368 static const Tempo& default_tempo() { return _default_tempo; }
369 static const Meter& default_meter() { return _default_meter; }
371 const Tempo tempo_at (const framepos_t& frame) const;
372 double frames_per_beat_at (const framepos_t&, const framecnt_t& sr) const;
374 const Meter& meter_at (framepos_t) const;
376 const TempoSection& tempo_section_at (framepos_t frame) const;
377 const MeterSection& meter_section_at (framepos_t frame) const;
378 const MeterSection& meter_section_at_beat (double beat) const;
380 TempoSection* add_tempo (const Tempo&, const double& pulse, TempoSection::Type type);
381 TempoSection* add_tempo (const Tempo&, const framepos_t& frame, TempoSection::Type type);
383 MeterSection* add_meter (const Meter&, const double& beat, const Timecode::BBT_Time& where);
384 MeterSection* add_meter (const Meter&, const framepos_t& frame, const double& beat, const Timecode::BBT_Time& where);
386 void remove_tempo (const TempoSection&, bool send_signal);
387 void remove_meter (const MeterSection&, bool send_signal);
389 framepos_t predict_tempo_frame (TempoSection* section, const Timecode::BBT_Time& bbt);
390 double predict_tempo_pulse (TempoSection* section, const framepos_t& frame);
392 void replace_tempo (const TempoSection&, const Tempo&, const double& where, TempoSection::Type type);
393 void replace_tempo (const TempoSection&, const Tempo&, const framepos_t& frame, TempoSection::Type type);
395 void gui_move_tempo_frame (TempoSection*, const framepos_t& frame);
396 void gui_move_tempo_beat (TempoSection*, const double& frame);
397 void gui_move_meter (MeterSection*, const framepos_t& frame);
398 void gui_move_meter (MeterSection*, const double& pulse);
399 bool gui_change_tempo (TempoSection*, const Tempo& bpm);
400 void gui_dilate_tempo (MeterSection*, const framepos_t& frame);
402 bool can_solve_bbt (TempoSection* section, const Timecode::BBT_Time& bbt);
404 void replace_meter (const MeterSection&, const Meter&, const Timecode::BBT_Time& where);
405 void replace_meter (const MeterSection&, const Meter&, const framepos_t& frame);
407 framepos_t round_to_bar (framepos_t frame, RoundMode dir);
408 framepos_t round_to_beat (framepos_t frame, RoundMode dir);
409 framepos_t round_to_beat_subdivision (framepos_t fr, int sub_num, RoundMode dir);
410 void round_bbt (Timecode::BBT_Time& when, const int32_t& snap_divisor);
412 void set_length (framepos_t frames);
414 void fix_legacy_session();
416 XMLNode& get_state (void);
417 int set_state (const XMLNode&, int version);
419 void dump (const Metrics& metrics, std::ostream&) const;
422 TempoMetric metric_at (Timecode::BBT_Time bbt) const;
424 /** Return the TempoMetric at frame @p t, and point @p last to the latest
425 * metric change <= t, if it is non-NULL.
427 TempoMetric metric_at (framepos_t, Metrics::const_iterator* last=NULL) const;
429 Metrics::const_iterator metrics_end() { return _metrics.end(); }
431 void change_existing_tempo_at (framepos_t, double bpm, double note_type);
432 void change_initial_tempo (double bpm, double note_type);
434 void insert_time (framepos_t, framecnt_t);
435 bool remove_time (framepos_t where, framecnt_t amount); //returns true if anything was moved
437 int n_tempos () const;
438 int n_meters () const;
440 framecnt_t frame_rate () const { return _frame_rate; }
442 double bbt_to_beats (const Timecode::BBT_Time& bbt);
443 Timecode::BBT_Time beats_to_bbt (const double& beats);
444 Timecode::BBT_Time pulse_to_bbt (const double& pulse);
446 double pulse_at_beat (const double& beat) const;
447 double beat_at_pulse (const double& pulse) const;
449 double pulse_at_frame (const framecnt_t& frame) const;
450 framecnt_t frame_at_pulse (const double& pulse) const;
452 PBD::Signal0<void> MetricPositionChanged;
455 double pulse_at_beat_locked (const Metrics& metrics, const double& beat) const;
456 double beat_at_pulse_locked (const Metrics& metrics, const double& pulse) const;
457 double pulse_at_frame_locked (const Metrics& metrics, const framecnt_t& frame) const;
458 framecnt_t frame_at_pulse_locked (const Metrics& metrics, const double& pulse) const;
460 double beat_at_frame_locked (const Metrics& metrics, const framecnt_t& frame) const;
461 framecnt_t frame_at_beat_locked (const Metrics& metrics, const double& beat) const;
462 double bbt_to_beats_locked (const Metrics& metrics, const Timecode::BBT_Time& bbt) const ;
463 Timecode::BBT_Time beats_to_bbt_locked (const Metrics& metrics, const double& beats) const;
465 framepos_t frame_time_locked (const Metrics& metrics, const Timecode::BBT_Time&) const;
467 const MeterSection& meter_section_at_locked (const Metrics& metrics, framepos_t frame) const;
468 const TempoSection& tempo_section_at_locked (const Metrics& metrics, framepos_t frame) const;
469 const MeterSection& meter_section_at_beat_locked (const Metrics& metrics, const double& beat) const;
470 const TempoSection& tempo_section_at_beat_locked (const Metrics& metrics, const double& beat) const;
471 const TempoSection& tempo_section_at_pulse_locked (const Metrics& metrics, const double& pulse) const;
472 const Tempo tempo_at_locked (const Metrics& metrics, const framepos_t& frame) const;
474 bool check_solved (const Metrics& metrics, bool by_frame) const;
475 bool set_active_tempos (const Metrics& metrics, const framepos_t& frame);
476 bool solve_map (Metrics& metrics, TempoSection* section, const framepos_t& frame);
477 bool solve_map (Metrics& metrics, TempoSection* section, const double& pulse);
478 void solve_map (Metrics& metrics, MeterSection* section, const framepos_t& frame);
479 void solve_map (Metrics& metrics, MeterSection* section, const double& pulse);
481 friend class ::BBTTest;
482 friend class ::FrameposPlusBeatsTest;
483 friend class ::TempoTest;
485 static Tempo _default_tempo;
486 static Meter _default_meter;
489 framecnt_t _frame_rate;
490 mutable Glib::Threads::RWLock lock;
492 void recompute_tempos (Metrics& metrics);
493 void recompute_meters (Metrics& metrics);
494 void recompute_map (Metrics& metrics, framepos_t end = -1);
496 framepos_t round_to_type (framepos_t fr, RoundMode dir, BBTPointType);
498 const MeterSection& first_meter() const;
499 MeterSection& first_meter();
500 const TempoSection& first_tempo() const;
501 TempoSection& first_tempo();
503 void do_insert (MetricSection* section);
505 TempoSection* add_tempo_locked (const Tempo&, double pulse, bool recompute, TempoSection::Type type);
506 TempoSection* add_tempo_locked (const Tempo&, framepos_t frame, bool recompute, TempoSection::Type type);
508 MeterSection* add_meter_locked (const Meter&, double beat, Timecode::BBT_Time where, bool recompute);
509 MeterSection* add_meter_locked (const Meter&, framepos_t frame, double beat, Timecode::BBT_Time where, bool recompute);
511 bool remove_tempo_locked (const TempoSection&);
512 bool remove_meter_locked (const MeterSection&);
514 TempoSection* copy_metrics_and_point (Metrics& copy, TempoSection* section);
517 }; /* namespace ARDOUR */
519 std::ostream& operator<< (std::ostream&, const ARDOUR::Meter&);
520 std::ostream& operator<< (std::ostream&, const ARDOUR::Tempo&);
521 std::ostream& operator<< (std::ostream&, const ARDOUR::MetricSection&);
523 #endif /* __ardour_tempo_h__ */