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 (MusicTime) {}
 110         MetricSection (framepos_t frame)
 111                 : _pulse (0.0), _frame (frame), _movable (true), _position_lock_style (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, 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&);
 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& pulse, double qpm, double note_type, Type tempo_type)
 181                 : MetricSection (pulse), 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&);
 185
 186         static const std::string xml_state_node_name;
 187
 188         XMLNode& get_state() const;
 189
 190         double c_func () const { return _c_func; }
 191         void set_c_func (double c_func) { _c_func = c_func; }
 192
 193         void set_type (Type type);
 194         Type type () const { return _type; }
 195
 196         bool active () const { return _active; }
 197         void set_active (bool yn) { _active = yn; }
 198
 199         bool locked_to_meter ()  const { return _locked_to_meter; }
 200         void set_locked_to_meter (bool yn) { _locked_to_meter = yn; }
 201
 202         double tempo_at_frame (const framepos_t& frame, const framecnt_t& frame_rate) const;
 203         framepos_t frame_at_tempo (const double& ppm, const double& beat, const framecnt_t& frame_rate) const;
 204
 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;
 207
 208         double pulse_at_frame (const framepos_t& frame, const framecnt_t& frame_rate) const;
 209         frameoffset_t frame_at_pulse (const double& pulse, const framecnt_t& frame_rate) const;
 210
 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;
 213
 214         Timecode::BBT_Time legacy_bbt () { return _legacy_bbt; }
 215
 216   private:
 217
 218         framepos_t minute_to_frame (const double& time, const framecnt_t& frame_rate) const;
 219         double frame_to_minute (const framepos_t& frame, const framecnt_t& frame_rate) const;
 220
 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.
 224          */
 225         double a_func (double end_tpm, double c_func) const;
 226         double c_func (double end_tpm, double end_time) const;
 227
 228         double pulse_tempo_at_time (const double& time) const;
 229         double time_at_pulse_tempo (const double& pulse_tempo) const;
 230
 231         double pulse_tempo_at_pulse (const double& pulse) const;
 232         double pulse_at_pulse_tempo (const double& pulse_tempo) const;
 233
 234         double pulse_at_time (const double& time) const;
 235         double time_at_pulse (const double& pulse) const;
 236
 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.
 241
 242            this enables us to keep the tempo change at the same relative
 243            position within the bar if/when the meter changes.
 244         */
 245         Type _type;
 246         double _c_func;
 247         bool _active;
 248         bool _locked_to_meter;
 249         Timecode::BBT_Time _legacy_bbt;
 250 };
 251
 252 typedef std::list<MetricSection*> Metrics;
 253
 254 /** Helper class to keep track of the Meter *AND* Tempo in effect
 255     at a given point in time.
 256 */
 257 class LIBARDOUR_API TempoMetric {
 258   public:
 259         TempoMetric (const Meter& m, const Tempo& t)
 260                 : _meter (&m), _tempo (&t), _frame (0) {}
 261
 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; }
 266
 267         void set_metric (const MetricSection* section) {
 268                 const MeterSection* meter;
 269                 const TempoSection* tempo;
 270                 if ((meter = dynamic_cast<const MeterSection*>(section))) {
 271                         set_meter(*meter);
 272                 } else if ((tempo = dynamic_cast<const TempoSection*>(section))) {
 273                         set_tempo(*tempo);
 274                 }
 275
 276                 set_frame (section->frame());
 277                 set_pulse (section->pulse());
 278         }
 279
 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; }
 284
 285   private:
 286         const Meter*       _meter;
 287         const Tempo*       _tempo;
 288         framepos_t         _frame;
 289         double             _pulse;
 290 };
 291
 292 /** Tempo Map - mapping of timecode to musical time.
 293  * convert audio-samples, sample-rate to Bar/Beat/Tick, Meter/Tempo
 294  */
 295 class LIBARDOUR_API TempoMap : public PBD::StatefulDestructible
 296 {
 297   public:
 298         TempoMap (framecnt_t frame_rate);
 299         ~TempoMap();
 300
 301         /* measure-based stuff */
 302
 303         enum BBTPointType {
 304                 Bar,
 305                 Beat,
 306         };
 307
 308         struct BBTPoint {
 309                 framepos_t          frame;
 310                 Meter               meter;
 311                 Tempo               tempo;
 312                 double              c;
 313                 uint32_t            bar;
 314                 uint32_t            beat;
 315
 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) {}
 319
 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; }
 324         };
 325
 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);
 329         }
 330
 331         void get_grid (std::vector<BBTPoint>&,
 332                        framepos_t start, framepos_t end);
 333
 334         /* TEMPO- AND METER-SENSITIVE FUNCTIONS
 335
 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.
 340
 341            They SHOULD NOT be used to determine the position of events
 342            whose location is canonically defined in beats.
 343         */
 344
 345         void bbt_time (framepos_t when, Timecode::BBT_Time&);
 346
 347         double beat_at_frame (const framecnt_t& frame) const;
 348         framecnt_t frame_at_beat (const double& beat) const;
 349
 350         framepos_t frame_time (const Timecode::BBT_Time&);
 351         framecnt_t bbt_duration_at (framepos_t, const Timecode::BBT_Time&, int dir);
 352
 353         /* TEMPO-SENSITIVE FUNCTIONS
 354
 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.
 358
 359            They SHOULD be used to determine the position of events
 360            whose location is canonically defined in beats.
 361         */
 362
 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;
 367
 368         static const Tempo& default_tempo() { return _default_tempo; }
 369         static const Meter& default_meter() { return _default_meter; }
 370
 371         const Tempo tempo_at (const framepos_t& frame) const;
 372         double frames_per_beat_at (const framepos_t&, const framecnt_t& sr) const;
 373
 374         const Meter& meter_at (framepos_t) const;
 375
 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;
 379
 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);
 382
 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);
 385
 386         void remove_tempo (const TempoSection&, bool send_signal);
 387         void remove_meter (const MeterSection&, bool send_signal);
 388
 389         framepos_t predict_tempo_frame (TempoSection* section, const Timecode::BBT_Time& bbt);
 390         double predict_tempo_pulse (TempoSection* section, const framepos_t& frame);
 391
 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);
 394
 395         void gui_move_tempo_frame (TempoSection*, const framepos_t& frame);
 396         void gui_move_tempo_beat (TempoSection*, const double& beat);
 397         void gui_move_tempo_pulse (TempoSection*, const double& pulse);
 398         void gui_move_meter (MeterSection*, const framepos_t& frame);
 399         void gui_move_meter (MeterSection*, const Timecode::BBT_Time& bbt);
 400         bool gui_change_tempo (TempoSection*, const Tempo& bpm);
 401         void gui_dilate_tempo (MeterSection*, const framepos_t& frame);
 402         void gui_dilate_tempo (const framepos_t& frame, const framepos_t& end_frame);
 403
 404         bool can_solve_bbt (TempoSection* section, const Timecode::BBT_Time& bbt);
 405
 406         void replace_meter (const MeterSection&, const Meter&, const Timecode::BBT_Time& where);
 407         void replace_meter (const MeterSection&, const Meter&, const framepos_t& frame);
 408
 409         framepos_t round_to_bar  (framepos_t frame, RoundMode dir);
 410         framepos_t round_to_beat (framepos_t frame, RoundMode dir);
 411         framepos_t round_to_beat_subdivision (framepos_t fr, int sub_num, RoundMode dir);
 412         void round_bbt (Timecode::BBT_Time& when, const int32_t& snap_divisor, RoundMode dir);
 413
 414         void set_length (framepos_t frames);
 415
 416         void fix_legacy_session();
 417
 418         XMLNode& get_state (void);
 419         int set_state (const XMLNode&, int version);
 420
 421         void dump (const Metrics& metrics, std::ostream&) const;
 422         void clear ();
 423
 424         TempoMetric metric_at (Timecode::BBT_Time bbt) const;
 425
 426         /** Return the TempoMetric at frame @p t, and point @p last to the latest
 427          * metric change <= t, if it is non-NULL.
 428          */
 429         TempoMetric metric_at (framepos_t, Metrics::const_iterator* last=NULL) const;
 430
 431         Metrics::const_iterator metrics_end() { return _metrics.end(); }
 432
 433         void change_existing_tempo_at (framepos_t, double bpm, double note_type);
 434         void change_initial_tempo (double bpm, double note_type);
 435
 436         void insert_time (framepos_t, framecnt_t);
 437         bool remove_time (framepos_t where, framecnt_t amount);  //returns true if anything was moved
 438
 439         int n_tempos () const;
 440         int n_meters () const;
 441
 442         framecnt_t frame_rate () const { return _frame_rate; }
 443
 444         double bbt_to_beats (const Timecode::BBT_Time& bbt);
 445         Timecode::BBT_Time beats_to_bbt (const double& beats);
 446         Timecode::BBT_Time pulse_to_bbt (const double& pulse);
 447
 448         double pulse_at_beat (const double& beat) const;
 449         double beat_at_pulse (const double& pulse) const;
 450
 451         double pulse_at_frame (const framecnt_t& frame) const;
 452         framecnt_t frame_at_pulse (const double& pulse) const;
 453
 454         PBD::Signal0<void> MetricPositionChanged;
 455
 456 private:
 457         double pulse_at_beat_locked (const Metrics& metrics, const double& beat) const;
 458         double beat_at_pulse_locked (const Metrics& metrics, const double& pulse) const;
 459         double pulse_at_frame_locked (const Metrics& metrics, const framecnt_t& frame) const;
 460         framecnt_t frame_at_pulse_locked (const Metrics& metrics, const double& pulse) const;
 461
 462         double beat_at_frame_locked (const Metrics& metrics, const framecnt_t& frame) const;
 463         framecnt_t frame_at_beat_locked (const Metrics& metrics, const double& beat) const;
 464         double bbt_to_beats_locked (const Metrics& metrics, const Timecode::BBT_Time& bbt) const ;
 465         Timecode::BBT_Time beats_to_bbt_locked (const Metrics& metrics, const double& beats) const;
 466
 467         framepos_t frame_time_locked (const Metrics& metrics, const Timecode::BBT_Time&) const;
 468
 469         const MeterSection& meter_section_at_locked (const Metrics& metrics, framepos_t frame) const;
 470         const TempoSection& tempo_section_at_locked (const Metrics& metrics, framepos_t frame) const;
 471         const MeterSection& meter_section_at_beat_locked (const Metrics& metrics, const double& beat) const;
 472         const TempoSection& tempo_section_at_beat_locked (const Metrics& metrics, const double& beat) const;
 473         const TempoSection& tempo_section_at_pulse_locked (const Metrics& metrics, const double& pulse) const;
 474         const Tempo tempo_at_locked (const Metrics& metrics, const framepos_t& frame) const;
 475
 476         bool check_solved (const Metrics& metrics, bool by_frame) const;
 477         bool set_active_tempos (const Metrics& metrics, const framepos_t& frame);
 478         bool solve_map (Metrics& metrics, TempoSection* section, const framepos_t& frame);
 479         bool solve_map (Metrics& metrics, TempoSection* section, const double& pulse);
 480         bool solve_map (Metrics& metrics, MeterSection* section, const framepos_t& frame);
 481         bool solve_map (Metrics& metrics, MeterSection* section, const Timecode::BBT_Time& bbt);
 482
 483         friend class ::BBTTest;
 484         friend class ::FrameposPlusBeatsTest;
 485         friend class ::TempoTest;
 486
 487         static Tempo    _default_tempo;
 488         static Meter    _default_meter;
 489
 490         Metrics                       _metrics;
 491         framecnt_t                    _frame_rate;
 492         mutable Glib::Threads::RWLock lock;
 493
 494         void recompute_tempos (Metrics& metrics);
 495         void recompute_meters (Metrics& metrics);
 496         void recompute_map (Metrics& metrics, framepos_t end = -1);
 497
 498         framepos_t round_to_type (framepos_t fr, RoundMode dir, BBTPointType);
 499
 500         const MeterSection& first_meter() const;
 501         MeterSection&       first_meter();
 502         const TempoSection& first_tempo() const;
 503         TempoSection&       first_tempo();
 504
 505         void do_insert (MetricSection* section);
 506
 507         TempoSection* add_tempo_locked (const Tempo&, double pulse, bool recompute, TempoSection::Type type);
 508         TempoSection* add_tempo_locked (const Tempo&, framepos_t frame, bool recompute, TempoSection::Type type);
 509
 510         MeterSection* add_meter_locked (const Meter&, double beat, const Timecode::BBT_Time& where, bool recompute);
 511         MeterSection* add_meter_locked (const Meter&, framepos_t frame, double beat, const Timecode::BBT_Time& where, bool recompute);
 512
 513         bool remove_tempo_locked (const TempoSection&);
 514         bool remove_meter_locked (const MeterSection&);
 515
 516         TempoSection* copy_metrics_and_point (const Metrics& metrics, Metrics& copy, TempoSection* section);
 517         MeterSection* copy_metrics_and_point (const Metrics& metrics, Metrics& copy, MeterSection* section);
 518 };
 519
 520 }; /* namespace ARDOUR */
 521
 522 std::ostream& operator<< (std::ostream&, const ARDOUR::Meter&);
 523 std::ostream& operator<< (std::ostream&, const ARDOUR::Tempo&);
 524 std::ostream& operator<< (std::ostream&, const ARDOUR::MetricSection&);
 525
 526 #endif /* __ardour_tempo_h__ */