libs/ardour/ardour/tempo.h

   1 /*
   2     Copyright (C) 2000 Paul Davis
   3
   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.
   8
   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.
  13
  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.
  17
  18 */
  19
  20 #ifndef __ardour_tempo_h__
  21 #define __ardour_tempo_h__
  22
  23 #include <list>
  24 #include <string>
  25 #include <vector>
  26 #include <cmath>
  27 #include <glibmm/threads.h>
  28
  29 #include "pbd/undo.h"
  30
  31 #include "pbd/stateful.h"
  32 #include "pbd/statefuldestructible.h"
  33
  34 #include "evoral/Beats.hpp"
  35
  36 #include "ardour/ardour.h"
  37
  38 class BBTTest;
  39 class FrameposPlusBeatsTest;
  40 class TempoTest;
  41 class XMLNode;
  42
  43 namespace ARDOUR {
  44
  45 class Meter;
  46 class TempoMap;
  47
  48 /** Tempo, the speed at which musical time progresses (BPM). */
  49 class LIBARDOUR_API Tempo {
  50   public:
  51         /**
  52          * @param bpm Beats Per Minute
  53          * @param type Note Type (default `4': quarter note)
  54          */
  55         Tempo (double bpm, double type=4.0) // defaulting to quarter note
  56                 : _beats_per_minute (bpm), _note_type(type) {}
  57
  58         /* ..or more aptly 'pulse divisions per minute'.
  59            Nothing to do with actual beats, which are defined by the meter and tempo.
  60         */
  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
  67          */
  68         double frames_per_beat (framecnt_t sr) const {
  69                 return (60.0 * sr) / _beats_per_minute;
  70         }
  71         double frames_per_pulse (framecnt_t sr) const {
  72                 return (_note_type * 60.0 * sr) / _beats_per_minute;
  73         }
  74
  75   protected:
  76         double _beats_per_minute;
  77         double _note_type;
  78 };
  79
  80 /** Meter, or time signature (beats per bar, and which note type is a beat). */
  81 class LIBARDOUR_API Meter {
  82   public:
  83         Meter (double dpb, double bt)
  84                 : _divisions_per_bar (dpb), _note_type (bt) {}
  85
  86         double divisions_per_bar () const { return _divisions_per_bar; }
  87         double note_divisor() const { return _note_type; }
  88
  89         double frames_per_bar (const Tempo&, framecnt_t sr) const;
  90         double frames_per_grid (const Tempo&, framecnt_t sr) const;
  91
  92   protected:
  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.
  96         */
  97         double _divisions_per_bar;
  98
  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.
 101         */
 102         double _note_type;
 103 };
 104
 105 /** A section of timeline with a certain Tempo or Meter. */
 106 class LIBARDOUR_API MetricSection {
 107   public:
 108         MetricSection (double pulse)
 109                 : _pulse (pulse), _frame (0), _movable (true), _position_lock_style (PositionLockStyle::MusicTime) {}
 110         MetricSection (framepos_t frame)
 111                 : _pulse (0.0), _frame (frame), _movable (true), _position_lock_style (PositionLockStyle::AudioTime) {}
 112
 113         virtual ~MetricSection() {}
 114
 115         const double& pulse () const { return _pulse; }
 116         void set_pulse (double pulse) { _pulse = pulse; }
 117
 118         framepos_t frame() const { return _frame; }
 119         virtual void set_frame (framepos_t f) {
 120                 _frame = f;
 121         }
 122
 123         void set_movable (bool yn) { _movable = yn; }
 124         bool movable() const { return _movable; }
 125
 126         /* MeterSections are not stateful in the full sense,
 127            but we do want them to control their own
 128            XML state information.
 129         */
 130         virtual XMLNode& get_state() const = 0;
 131
 132         PositionLockStyle position_lock_style () const { return _position_lock_style; }
 133         void set_position_lock_style (PositionLockStyle ps) { _position_lock_style = ps; }
 134
 135 private:
 136         double             _pulse;
 137         framepos_t         _frame;
 138         bool               _movable;
 139         PositionLockStyle  _position_lock_style;
 140 };
 141
 142 /** A section of timeline with a certain Meter. */
 143 class LIBARDOUR_API MeterSection : public MetricSection, public Meter {
 144   public:
 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, double bpb, double note_type)
 148                 : MetricSection (frame), Meter (bpb, note_type), _bbt (1, 1, 0), _beat (beat) {}
 149         MeterSection (const XMLNode&);
 150
 151         static const std::string xml_state_node_name;
 152
 153         XMLNode& get_state() const;
 154
 155         void set_pulse (double w) {
 156                 MetricSection::set_pulse (w);
 157         }
 158         void set_beat (std::pair<double, Timecode::BBT_Time>& w) {
 159                 _beat = w.first;
 160                 _bbt = w.second;
 161         }
 162
 163         const Timecode::BBT_Time& bbt() const { return _bbt; }
 164         const double& beat () const { return _beat; }
 165         void set_beat (double beat) { _beat = beat; }
 166
 167 private:
 168         Timecode::BBT_Time _bbt;
 169         double _beat;
 170 };
 171
 172 /** A section of timeline with a certain Tempo. */
 173 class LIBARDOUR_API TempoSection : public MetricSection, public Tempo {
 174   public:
 175         enum Type {
 176                 Ramp,
 177                 Constant,
 178         };
 179
 180         TempoSection (const double& beat, double qpm, double note_type, Type tempo_type)
 181                 : MetricSection (beat), Tempo (qpm, note_type), _bar_offset (-1.0), _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), _bar_offset (-1.0), _type (tempo_type), _c_func (0.0), _active (true) {}
 184         TempoSection (const XMLNode&);
 185
 186         static const std::string xml_state_node_name;
 187
 188         XMLNode& get_state() const;
 189
 190         void update_bar_offset_from_bbt (const Meter&);
 191         void update_bbt_time_from_bar_offset (const Meter&);
 192         double bar_offset() const { return _bar_offset; }
 193
 194         bool active () const { return _active; }
 195         void set_active (bool yn) { _active = yn; }
 196
 197         void set_type (Type type);
 198         Type type () const { return _type; }
 199
 200         double tempo_at_frame (const framepos_t& frame, const framecnt_t& frame_rate) const;
 201         framepos_t frame_at_tempo (const double& ppm, const double& beat, const framecnt_t& frame_rate) const;
 202
 203         double tempo_at_pulse (const double& pulse) const;
 204         double pulse_at_tempo (const double& ppm, const framepos_t& frame, const framecnt_t& frame_rate) const;
 205
 206         double pulse_at_frame (const framepos_t& frame, const framecnt_t& frame_rate) const;
 207         framepos_t frame_at_pulse (const double& pulse, const framecnt_t& frame_rate) const;
 208
 209         double compute_c_func_pulse (const double& end_bpm, const double& end_pulse, const framecnt_t& frame_rate);
 210         double compute_c_func_frame (const double& end_bpm, const framepos_t& end_frame, const framecnt_t& frame_rate) const;
 211
 212         double get_c_func () const { return _c_func; }
 213         void set_c_func (double c_func) { _c_func = c_func; }
 214
 215         Timecode::BBT_Time legacy_bbt () { return _legacy_bbt; }
 216
 217   private:
 218
 219         framecnt_t minute_to_frame (const double& time, const framecnt_t& frame_rate) const;
 220         double frame_to_minute (const framecnt_t& frame, const framecnt_t& frame_rate) const;
 221
 222         /*  tempo ramp functions. zero-based with time in minutes,
 223          * 'tick tempo' in ticks per minute and tempo in bpm.
 224          *  time relative to section start.
 225          */
 226         double a_func (double end_tpm, double c_func) const;
 227         double c_func (double end_tpm, double end_time) const;
 228
 229         double pulse_tempo_at_time (const double& time) const;
 230         double time_at_pulse_tempo (const double& pulse_tempo) const;
 231
 232         double pulse_tempo_at_pulse (const double& pulse) const;
 233         double pulse_at_pulse_tempo (const double& pulse_tempo) const;
 234
 235         double pulse_at_time (const double& time) const;
 236         double time_at_pulse (const double& pulse) const;
 237
 238         /* this value provides a fractional offset into the bar in which
 239            the tempo section is located in. A value of 0.0 indicates that
 240            it occurs on the first beat of the bar, a value of 0.5 indicates
 241            that it occurs halfway through the bar and so on.
 242
 243            this enables us to keep the tempo change at the same relative
 244            position within the bar if/when the meter changes.
 245         */
 246         double _bar_offset;
 247         Type _type;
 248         double _c_func;
 249         bool _active;
 250         Timecode::BBT_Time _legacy_bbt;
 251 };
 252
 253 typedef std::list<MetricSection*> Metrics;
 254
 255 /** Helper class to keep track of the Meter *AND* Tempo in effect
 256     at a given point in time.
 257 */
 258 class LIBARDOUR_API TempoMetric {
 259   public:
 260         TempoMetric (const Meter& m, const Tempo& t)
 261                 : _meter (&m), _tempo (&t), _frame (0) {}
 262
 263         void set_tempo (const Tempo& t)              { _tempo = &t; }
 264         void set_meter (const Meter& m)              { _meter = &m; }
 265         void set_frame (framepos_t f)                { _frame = f; }
 266         void set_pulse (const double& p)             { _pulse = p; }
 267
 268         void set_metric (const MetricSection* section) {
 269                 const MeterSection* meter;
 270                 const TempoSection* tempo;
 271                 if ((meter = dynamic_cast<const MeterSection*>(section))) {
 272                         set_meter(*meter);
 273                 } else if ((tempo = dynamic_cast<const TempoSection*>(section))) {
 274                         set_tempo(*tempo);
 275                 }
 276
 277                 set_frame (section->frame());
 278                 set_pulse (section->pulse());
 279         }
 280
 281         const Meter&              meter() const { return *_meter; }
 282         const Tempo&              tempo() const { return *_tempo; }
 283         framepos_t                frame() const { return _frame; }
 284         const double&             pulse() const { return _pulse; }
 285
 286   private:
 287         const Meter*       _meter;
 288         const Tempo*       _tempo;
 289         framepos_t         _frame;
 290         double             _pulse;
 291 };
 292
 293 /** Tempo Map - mapping of timecode to musical time.
 294  * convert audio-samples, sample-rate to Bar/Beat/Tick, Meter/Tempo
 295  */
 296 class LIBARDOUR_API TempoMap : public PBD::StatefulDestructible
 297 {
 298   public:
 299         TempoMap (framecnt_t frame_rate);
 300         ~TempoMap();
 301
 302         /* measure-based stuff */
 303
 304         enum BBTPointType {
 305                 Bar,
 306                 Beat,
 307         };
 308
 309         struct BBTPoint {
 310                 framepos_t          frame;
 311                 const MeterSection* meter;
 312                 const Tempo tempo;
 313                 double              c;
 314                 uint32_t            bar;
 315                 uint32_t            beat;
 316
 317                 BBTPoint (const MeterSection& m, const Tempo& t, framepos_t f,
 318                           uint32_t b, uint32_t e, double func_c)
 319                 : frame (f), meter (&m), tempo (t.beats_per_minute(), t.note_type()), c (func_c), bar (b), beat (e) {}
 320
 321                 Timecode::BBT_Time bbt() const { return Timecode::BBT_Time (bar, beat, 0); }
 322                 operator Timecode::BBT_Time() const { return bbt(); }
 323                 operator framepos_t() const { return frame; }
 324                 bool is_bar() const { return beat == 1; }
 325         };
 326
 327         template<class T> void apply_with_metrics (T& obj, void (T::*method)(const Metrics&)) {
 328                 Glib::Threads::RWLock::ReaderLock lm (lock);
 329                 (obj.*method)(_metrics);
 330         }
 331
 332         void get_grid (std::vector<BBTPoint>&,
 333                        framepos_t start, framepos_t end);
 334
 335         /* TEMPO- AND METER-SENSITIVE FUNCTIONS
 336
 337            bbt_time(), beat_at_frame(), frame_at_beat(), tick_at_frame(),
 338            frame_at_tick(),frame_time() and bbt_duration_at()
 339            are all sensitive to tempo and meter, and will give answers
 340            that align with the grid formed by tempo and meter sections.
 341
 342            They SHOULD NOT be used to determine the position of events
 343            whose location is canonically defined in beats.
 344         */
 345
 346         void bbt_time (framepos_t when, Timecode::BBT_Time&);
 347
 348         double beat_at_frame (const framecnt_t& frame) const;
 349         framecnt_t frame_at_beat (const double& beat) const;
 350
 351         framepos_t frame_time (const Timecode::BBT_Time&);
 352         framecnt_t bbt_duration_at (framepos_t, const Timecode::BBT_Time&, int dir);
 353
 354         /* TEMPO-SENSITIVE FUNCTIONS
 355
 356            These next 4 functions will all take tempo in account and should be
 357            used to determine position (and in the last case, distance in beats)
 358            when tempo matters but meter does not.
 359
 360            They SHOULD be used to determine the position of events
 361            whose location is canonically defined in beats.
 362         */
 363
 364         framepos_t framepos_plus_bbt (framepos_t pos, Timecode::BBT_Time b) const;
 365         framepos_t framepos_plus_beats (framepos_t, Evoral::Beats) const;
 366         framepos_t framepos_minus_beats (framepos_t, Evoral::Beats) const;
 367         Evoral::Beats framewalk_to_beats (framepos_t pos, framecnt_t distance) const;
 368
 369         static const Tempo& default_tempo() { return _default_tempo; }
 370         static const Meter& default_meter() { return _default_meter; }
 371
 372         const Tempo tempo_at (const framepos_t& frame) const;
 373         double frames_per_beat_at (const framepos_t&, const framecnt_t& sr) const;
 374
 375         const Meter& meter_at (framepos_t) const;
 376
 377         const TempoSection& tempo_section_at (framepos_t frame) const;
 378         const MeterSection& meter_section_at (framepos_t frame) const;
 379         const MeterSection& meter_section_at (const double& beat) const;
 380
 381         void add_tempo (const Tempo&, const double& pulse, TempoSection::Type type);
 382         void add_tempo (const Tempo&, const framepos_t& frame, TempoSection::Type type);
 383
 384         void add_meter (const Meter&, const double& beat, const Timecode::BBT_Time& where);
 385         void add_meter (const Meter&, const framepos_t& frame);
 386
 387         void remove_tempo (const TempoSection&, bool send_signal);
 388         void remove_meter (const MeterSection&, bool send_signal);
 389
 390         framepos_t predict_tempo_frame (TempoSection* section, const Tempo& bpm, const Timecode::BBT_Time& bbt);
 391         double predict_tempo_pulse (TempoSection* section, const Tempo& bpm, const framepos_t& frame);
 392
 393         void replace_tempo (const TempoSection&, const Tempo&, const double& where, TempoSection::Type type);
 394         void replace_tempo (const TempoSection&, const Tempo&, const framepos_t& frame, TempoSection::Type type);
 395
 396         void gui_move_tempo_frame (TempoSection*, const Tempo& bpm, const framepos_t& frame);
 397         void gui_move_tempo_beat (TempoSection*, const Tempo& bpm, const double& frame);
 398         void gui_move_meter (MeterSection*, const Meter& mt, const framepos_t& frame);
 399         void gui_move_meter (MeterSection*, const Meter& mt, const double& beat);
 400         bool gui_change_tempo (TempoSection*, const Tempo& bpm);
 401
 402         bool can_solve_bbt (TempoSection* section, const Tempo& bpm, const Timecode::BBT_Time& bbt);
 403
 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);
 406
 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);
 411
 412         void set_length (framepos_t frames);
 413
 414         XMLNode& get_state (void);
 415         int set_state (const XMLNode&, int version);
 416
 417         void dump (const Metrics& metrics, std::ostream&) const;
 418         void clear ();
 419
 420         TempoMetric metric_at (Timecode::BBT_Time bbt) const;
 421
 422         /** Return the TempoMetric at frame @p t, and point @p last to the latest
 423          * metric change <= t, if it is non-NULL.
 424          */
 425         TempoMetric metric_at (framepos_t, Metrics::const_iterator* last=NULL) const;
 426
 427         Metrics::const_iterator metrics_end() { return _metrics.end(); }
 428
 429         void change_existing_tempo_at (framepos_t, double bpm, double note_type);
 430         void change_initial_tempo (double bpm, double note_type);
 431
 432         void insert_time (framepos_t, framecnt_t);
 433         bool remove_time (framepos_t where, framecnt_t amount);  //returns true if anything was moved
 434
 435         int n_tempos () const;
 436         int n_meters () const;
 437
 438         framecnt_t frame_rate () const { return _frame_rate; }
 439
 440         double bbt_to_beats (const Timecode::BBT_Time& bbt);
 441         Timecode::BBT_Time beats_to_bbt (const double& beats);
 442         Timecode::BBT_Time pulse_to_bbt (const double& pulse);
 443
 444         double pulse_at_beat (const double& beat) const;
 445         double beat_at_pulse (const double& pulse) const;
 446
 447         PBD::Signal0<void> MetricPositionChanged;
 448
 449 private:
 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& beat) const;
 454
 455         double beat_offset_at (const Metrics& metrics, const double& beat) const;
 456         frameoffset_t frame_offset_at (const Metrics& metrics, const framepos_t& frame) const;
 457
 458         double beat_at_frame_locked (const Metrics& metrics, const framecnt_t& frame) const;
 459         framecnt_t frame_at_beat_locked (const Metrics& metrics, const double& beat) const;
 460         double bbt_to_beats_locked (const Metrics& metrics, const Timecode::BBT_Time& bbt) const ;
 461         Timecode::BBT_Time beats_to_bbt_locked (const Metrics& metrics, const double& beats) const;
 462
 463         framepos_t frame_time_locked (const Metrics& metrics, const Timecode::BBT_Time&) const;
 464
 465         const MeterSection& meter_section_at_locked (framepos_t frame) const;
 466         const TempoSection& tempo_section_at_locked (framepos_t frame) const;
 467         const Tempo tempo_at_locked (const framepos_t& frame) const;
 468
 469         bool check_solved (Metrics& metrics, bool by_frame);
 470         bool solve_map (Metrics& metrics, TempoSection* section, const Tempo& bpm, const framepos_t& frame);
 471         bool solve_map (Metrics& metrics, TempoSection* section, const Tempo& bpm, const double& pulse);
 472         void solve_map (Metrics& metrics, MeterSection* section, const Meter& mt, const framepos_t& frame);
 473         void solve_map (Metrics& metrics, MeterSection* section, const Meter& mt, const double& pulse);
 474
 475         friend class ::BBTTest;
 476         friend class ::FrameposPlusBeatsTest;
 477         friend class ::TempoTest;
 478
 479         static Tempo    _default_tempo;
 480         static Meter    _default_meter;
 481
 482         Metrics                       _metrics;
 483         framecnt_t                    _frame_rate;
 484         mutable Glib::Threads::RWLock lock;
 485
 486         void recompute_tempos (Metrics& metrics);
 487         void recompute_meters (Metrics& metrics);
 488         void recompute_map (Metrics& metrics, framepos_t end = -1);
 489
 490         framepos_t round_to_type (framepos_t fr, RoundMode dir, BBTPointType);
 491
 492         const MeterSection& first_meter() const;
 493         MeterSection&       first_meter();
 494         const TempoSection& first_tempo() const;
 495         TempoSection&       first_tempo();
 496
 497         void do_insert (MetricSection* section);
 498
 499         void add_tempo_locked (const Tempo&, double pulse, bool recompute, TempoSection::Type type);
 500         void add_tempo_locked (const Tempo&, framepos_t frame, bool recompute, TempoSection::Type type);
 501
 502         void add_meter_locked (const Meter&, double beat, Timecode::BBT_Time where, bool recompute);
 503         void add_meter_locked (const Meter&, framepos_t frame, bool recompute);
 504
 505         bool remove_tempo_locked (const TempoSection&);
 506         bool remove_meter_locked (const MeterSection&);
 507
 508         TempoSection* copy_metrics_and_point (Metrics& copy, TempoSection* section);
 509 };
 510
 511 }; /* namespace ARDOUR */
 512
 513 std::ostream& operator<< (std::ostream&, const ARDOUR::Meter&);
 514 std::ostream& operator<< (std::ostream&, const ARDOUR::Tempo&);
 515 std::ostream& operator<< (std::ostream&, const ARDOUR::MetricSection&);
 516
 517 #endif /* __ardour_tempo_h__ */