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) {}
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) {}
184 TempoSection (const XMLNode&);
186 static const std::string xml_state_node_name;
188 XMLNode& get_state() const;
190 bool active () const { return _active; }
191 void set_active (bool yn) { _active = yn; }
193 void set_type (Type type);
194 Type type () const { return _type; }
196 double c_func () const { return _c_func; }
197 void set_c_func (double c_func) { _c_func = c_func; }
199 double tempo_at_frame (const framepos_t& frame, const framecnt_t& frame_rate) const;
200 framepos_t frame_at_tempo (const double& ppm, const double& beat, const framecnt_t& frame_rate) const;
202 double tempo_at_pulse (const double& pulse) const;
203 double pulse_at_tempo (const double& ppm, const framepos_t& frame, const framecnt_t& frame_rate) const;
205 double pulse_at_frame (const framepos_t& frame, const framecnt_t& frame_rate) const;
206 framepos_t frame_at_pulse (const double& pulse, const framecnt_t& frame_rate) const;
208 double compute_c_func_pulse (const double& end_bpm, const double& end_pulse, const framecnt_t& frame_rate);
209 double compute_c_func_frame (const double& end_bpm, const framepos_t& end_frame, const framecnt_t& frame_rate) const;
211 Timecode::BBT_Time legacy_bbt () { return _legacy_bbt; }
215 framecnt_t minute_to_frame (const double& time, const framecnt_t& frame_rate) const;
216 double frame_to_minute (const framecnt_t& frame, const framecnt_t& frame_rate) const;
218 /* tempo ramp functions. zero-based with time in minutes,
219 * 'tick tempo' in ticks per minute and tempo in bpm.
220 * time relative to section start.
222 double a_func (double end_tpm, double c_func) const;
223 double c_func (double end_tpm, double end_time) const;
225 double pulse_tempo_at_time (const double& time) const;
226 double time_at_pulse_tempo (const double& pulse_tempo) const;
228 double pulse_tempo_at_pulse (const double& pulse) const;
229 double pulse_at_pulse_tempo (const double& pulse_tempo) const;
231 double pulse_at_time (const double& time) const;
232 double time_at_pulse (const double& pulse) const;
234 /* this value provides a fractional offset into the bar in which
235 the tempo section is located in. A value of 0.0 indicates that
236 it occurs on the first beat of the bar, a value of 0.5 indicates
237 that it occurs halfway through the bar and so on.
239 this enables us to keep the tempo change at the same relative
240 position within the bar if/when the meter changes.
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.note_divisor(), m.divisions_per_bar()), 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 /* TEMPO- AND METER-SENSITIVE FUNCTIONS
332 bbt_time(), beat_at_frame(), frame_at_beat(), tick_at_frame(),
333 frame_at_tick(),frame_time() and bbt_duration_at()
334 are all sensitive to tempo and meter, and will give answers
335 that align with the grid formed by tempo and meter sections.
337 They SHOULD NOT be used to determine the position of events
338 whose location is canonically defined in beats.
341 void bbt_time (framepos_t when, Timecode::BBT_Time&);
343 double beat_at_frame (const framecnt_t& frame) const;
344 framecnt_t frame_at_beat (const double& beat) const;
346 framepos_t frame_time (const Timecode::BBT_Time&);
347 framecnt_t bbt_duration_at (framepos_t, const Timecode::BBT_Time&, int dir);
349 /* TEMPO-SENSITIVE FUNCTIONS
351 These next 4 functions will all take tempo in account and should be
352 used to determine position (and in the last case, distance in beats)
353 when tempo matters but meter does not.
355 They SHOULD be used to determine the position of events
356 whose location is canonically defined in beats.
359 framepos_t framepos_plus_bbt (framepos_t pos, Timecode::BBT_Time b) const;
360 framepos_t framepos_plus_beats (framepos_t, Evoral::Beats) const;
361 framepos_t framepos_minus_beats (framepos_t, Evoral::Beats) const;
362 Evoral::Beats framewalk_to_beats (framepos_t pos, framecnt_t distance) const;
364 static const Tempo& default_tempo() { return _default_tempo; }
365 static const Meter& default_meter() { return _default_meter; }
367 const Tempo tempo_at (const framepos_t& frame) const;
368 double frames_per_beat_at (const framepos_t&, const framecnt_t& sr) const;
370 const Meter& meter_at (framepos_t) const;
372 const TempoSection& tempo_section_at (framepos_t frame) const;
373 const MeterSection& meter_section_at (framepos_t frame) const;
374 const MeterSection& meter_section_at (const double& beat) const;
376 TempoSection* add_tempo (const Tempo&, const double& pulse, TempoSection::Type type);
377 TempoSection* add_tempo (const Tempo&, const framepos_t& frame, TempoSection::Type type);
379 MeterSection* add_meter (const Meter&, const double& beat, const Timecode::BBT_Time& where);
380 MeterSection* add_meter (const Meter&, const framepos_t& frame, const double& beat, const Timecode::BBT_Time& where);
382 void remove_tempo (const TempoSection&, bool send_signal);
383 void remove_meter (const MeterSection&, bool send_signal);
385 framepos_t predict_tempo_frame (TempoSection* section, const Timecode::BBT_Time& bbt);
386 double predict_tempo_pulse (TempoSection* section, const framepos_t& frame);
388 void replace_tempo (const TempoSection&, const Tempo&, const double& where, TempoSection::Type type);
389 void replace_tempo (const TempoSection&, const Tempo&, const framepos_t& frame, TempoSection::Type type);
391 void gui_move_tempo_frame (TempoSection*, const framepos_t& frame);
392 void gui_move_tempo_beat (TempoSection*, const double& frame);
393 void gui_move_meter (MeterSection*, const framepos_t& frame);
394 void gui_move_meter (MeterSection*, const double& beat);
395 bool gui_change_tempo (TempoSection*, const Tempo& bpm);
397 bool can_solve_bbt (TempoSection* section, const Timecode::BBT_Time& bbt);
399 void replace_meter (const MeterSection&, const Meter&, const Timecode::BBT_Time& where);
400 void replace_meter (const MeterSection&, const Meter&, const framepos_t& frame);
402 framepos_t round_to_bar (framepos_t frame, RoundMode dir);
403 framepos_t round_to_beat (framepos_t frame, RoundMode dir);
404 framepos_t round_to_beat_subdivision (framepos_t fr, int sub_num, RoundMode dir);
405 void round_bbt (Timecode::BBT_Time& when, const int32_t& snap_divisor);
407 void set_length (framepos_t frames);
409 void fix_legacy_session();
411 XMLNode& get_state (void);
412 int set_state (const XMLNode&, int version);
414 void dump (const Metrics& metrics, std::ostream&) const;
417 TempoMetric metric_at (Timecode::BBT_Time bbt) const;
419 /** Return the TempoMetric at frame @p t, and point @p last to the latest
420 * metric change <= t, if it is non-NULL.
422 TempoMetric metric_at (framepos_t, Metrics::const_iterator* last=NULL) const;
424 Metrics::const_iterator metrics_end() { return _metrics.end(); }
426 void change_existing_tempo_at (framepos_t, double bpm, double note_type);
427 void change_initial_tempo (double bpm, double note_type);
429 void insert_time (framepos_t, framecnt_t);
430 bool remove_time (framepos_t where, framecnt_t amount); //returns true if anything was moved
432 int n_tempos () const;
433 int n_meters () const;
435 framecnt_t frame_rate () const { return _frame_rate; }
437 double bbt_to_beats (const Timecode::BBT_Time& bbt);
438 Timecode::BBT_Time beats_to_bbt (const double& beats);
439 Timecode::BBT_Time pulse_to_bbt (const double& pulse);
441 double pulse_at_beat (const double& beat) const;
442 double beat_at_pulse (const double& pulse) const;
444 double pulse_at_frame (const framecnt_t& frame) const;
445 framecnt_t frame_at_pulse (const double& pulse) const;
447 PBD::Signal0<void> MetricPositionChanged;
450 double pulse_at_beat_locked (const Metrics& metrics, const double& beat) const;
451 double beat_at_pulse_locked (const Metrics& metrics, const double& pulse) const;
452 double pulse_at_frame_locked (const Metrics& metrics, const framecnt_t& frame) const;
453 framecnt_t frame_at_pulse_locked (const Metrics& metrics, const double& pulse) const;
455 double beat_at_frame_locked (const Metrics& metrics, const framecnt_t& frame) const;
456 framecnt_t frame_at_beat_locked (const Metrics& metrics, const double& beat) const;
457 double bbt_to_beats_locked (const Metrics& metrics, const Timecode::BBT_Time& bbt) const ;
458 Timecode::BBT_Time beats_to_bbt_locked (const Metrics& metrics, const double& beats) const;
460 framepos_t frame_time_locked (const Metrics& metrics, const Timecode::BBT_Time&) const;
462 const MeterSection& meter_section_at_locked (framepos_t frame) const;
463 const TempoSection& tempo_section_at_locked (framepos_t frame) const;
464 const Tempo tempo_at_locked (const framepos_t& frame) const;
466 bool check_solved (Metrics& metrics, bool by_frame);
467 bool set_active_tempos (const Metrics& metrics, const framepos_t& frame);
468 bool solve_map (Metrics& metrics, TempoSection* section, const framepos_t& frame);
469 bool solve_map (Metrics& metrics, TempoSection* section, const double& pulse);
470 void solve_map (Metrics& metrics, MeterSection* section, const framepos_t& frame);
471 void solve_map (Metrics& metrics, MeterSection* section, const double& pulse);
473 friend class ::BBTTest;
474 friend class ::FrameposPlusBeatsTest;
475 friend class ::TempoTest;
477 static Tempo _default_tempo;
478 static Meter _default_meter;
481 framecnt_t _frame_rate;
482 mutable Glib::Threads::RWLock lock;
484 void recompute_tempos (Metrics& metrics);
485 void recompute_meters (Metrics& metrics);
486 void recompute_map (Metrics& metrics, framepos_t end = -1);
488 framepos_t round_to_type (framepos_t fr, RoundMode dir, BBTPointType);
490 const MeterSection& first_meter() const;
491 MeterSection& first_meter();
492 const TempoSection& first_tempo() const;
493 TempoSection& first_tempo();
495 void do_insert (MetricSection* section);
497 TempoSection* add_tempo_locked (const Tempo&, double pulse, bool recompute, TempoSection::Type type);
498 TempoSection* add_tempo_locked (const Tempo&, framepos_t frame, bool recompute, TempoSection::Type type);
500 MeterSection* add_meter_locked (const Meter&, double beat, Timecode::BBT_Time where, bool recompute);
501 MeterSection* add_meter_locked (const Meter&, framepos_t frame, double beat, Timecode::BBT_Time where, bool recompute);
503 bool remove_tempo_locked (const TempoSection&);
504 bool remove_meter_locked (const MeterSection&);
506 TempoSection* copy_metrics_and_point (Metrics& copy, TempoSection* section);
509 }; /* namespace ARDOUR */
511 std::ostream& operator<< (std::ostream&, const ARDOUR::Meter&);
512 std::ostream& operator<< (std::ostream&, const ARDOUR::Tempo&);
513 std::ostream& operator<< (std::ostream&, const ARDOUR::MetricSection&);
515 #endif /* __ardour_tempo_h__ */