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, framepos_t frame, PositionLockStyle pls)
 109                 : _pulse (pulse), _frame (frame), _movable (true), _position_lock_style (pls) {}
 110
 111         virtual ~MetricSection() {}
 112
 113         const double& pulse () const { return _pulse; }
 114         void set_pulse (double pulse) { _pulse = pulse; }
 115
 116         framepos_t frame() const { return _frame; }
 117         virtual void set_frame (framepos_t f) {
 118                 _frame = f;
 119         }
 120
 121         void set_movable (bool yn) { _movable = yn; }
 122         bool movable() const { return _movable; }
 123
 124         /* MeterSections are not stateful in the full sense,
 125            but we do want them to control their own
 126            XML state information.
 127         */
 128         virtual XMLNode& get_state() const = 0;
 129
 130         PositionLockStyle position_lock_style () const { return _position_lock_style; }
 131         void set_position_lock_style (PositionLockStyle ps) { _position_lock_style = ps; }
 132
 133 private:
 134         double             _pulse;
 135         framepos_t         _frame;
 136         bool               _movable;
 137         PositionLockStyle  _position_lock_style;
 138 };
 139
 140 /** A section of timeline with a certain Meter. */
 141 class LIBARDOUR_API MeterSection : public MetricSection, public Meter {
 142   public:
 143         MeterSection (double pulse, framepos_t frame, double beat, const Timecode::BBT_Time& bbt, double bpb, double note_type, PositionLockStyle pls)
 144                 : MetricSection (pulse, frame, pls), Meter (bpb, note_type), _bbt (bbt),  _beat (beat) {}
 145
 146         MeterSection (const XMLNode&);
 147
 148         static const std::string xml_state_node_name;
 149
 150         XMLNode& get_state() const;
 151
 152         void set_pulse (double w) {
 153                 MetricSection::set_pulse (w);
 154         }
 155         void set_beat (std::pair<double, Timecode::BBT_Time>& w) {
 156                 _beat = w.first;
 157                 _bbt = w.second;
 158         }
 159
 160         const Timecode::BBT_Time& bbt() const { return _bbt; }
 161         const double& beat () const { return _beat; }
 162         void set_beat (double beat) { _beat = beat; }
 163
 164 private:
 165         Timecode::BBT_Time _bbt;
 166         double _beat;
 167 };
 168
 169 /** A section of timeline with a certain Tempo. */
 170 class LIBARDOUR_API TempoSection : public MetricSection, public Tempo {
 171   public:
 172         enum Type {
 173                 Ramp,
 174                 Constant,
 175         };
 176
 177         TempoSection (const double& pulse, const framepos_t& frame, double qpm, double note_type, Type tempo_type, PositionLockStyle pls)
 178                 : MetricSection (pulse, frame, pls), Tempo (qpm, note_type), _type (tempo_type), _c_func (0.0), _active (true), _locked_to_meter (false)  {}
 179
 180         TempoSection (const XMLNode&);
 181
 182         static const std::string xml_state_node_name;
 183
 184         XMLNode& get_state() const;
 185
 186         double c_func () const { return _c_func; }
 187         void set_c_func (double c_func) { _c_func = c_func; }
 188
 189         void set_type (Type type);
 190         Type type () const { return _type; }
 191
 192         bool active () const { return _active; }
 193         void set_active (bool yn) { _active = yn; }
 194
 195         bool locked_to_meter ()  const { return _locked_to_meter; }
 196         void set_locked_to_meter (bool yn) { _locked_to_meter = yn; }
 197
 198         double tempo_at_frame (const framepos_t& frame, const framecnt_t& frame_rate) const;
 199         framepos_t frame_at_tempo (const double& ppm, const double& beat, const framecnt_t& frame_rate) const;
 200
 201         double tempo_at_pulse (const double& pulse) const;
 202         double pulse_at_tempo (const double& ppm, const framepos_t& frame, const framecnt_t& frame_rate) const;
 203
 204         double pulse_at_frame (const framepos_t& frame, const framecnt_t& frame_rate) const;
 205         frameoffset_t frame_at_pulse (const double& pulse, const framecnt_t& frame_rate) const;
 206
 207         double compute_c_func_pulse (const double& end_bpm, const double& end_pulse, const framecnt_t& frame_rate);
 208         double compute_c_func_frame (const double& end_bpm, const framepos_t& end_frame, const framecnt_t& frame_rate) const;
 209
 210         Timecode::BBT_Time legacy_bbt () { return _legacy_bbt; }
 211
 212   private:
 213
 214         framepos_t minute_to_frame (const double& time, const framecnt_t& frame_rate) const;
 215         double frame_to_minute (const framepos_t& frame, const framecnt_t& frame_rate) const;
 216
 217         /*  tempo ramp functions. zero-based with time in minutes,
 218          * 'tick tempo' in ticks per minute and tempo in bpm.
 219          *  time relative to section start.
 220          */
 221         double a_func (double end_tpm, double c_func) const;
 222         double c_func (double end_tpm, double end_time) const;
 223
 224         double pulse_tempo_at_time (const double& time) const;
 225         double time_at_pulse_tempo (const double& pulse_tempo) const;
 226
 227         double pulse_tempo_at_pulse (const double& pulse) const;
 228         double pulse_at_pulse_tempo (const double& pulse_tempo) const;
 229
 230         double pulse_at_time (const double& time) const;
 231         double time_at_pulse (const double& pulse) const;
 232
 233         /* this value provides a fractional offset into the bar in which
 234            the tempo section is located in. A value of 0.0 indicates that
 235            it occurs on the first beat of the bar, a value of 0.5 indicates
 236            that it occurs halfway through the bar and so on.
 237
 238            this enables us to keep the tempo change at the same relative
 239            position within the bar if/when the meter changes.
 240         */
 241         Type _type;
 242         double _c_func;
 243         bool _active;
 244         bool _locked_to_meter;
 245         Timecode::BBT_Time _legacy_bbt;
 246 };
 247
 248 typedef std::list<MetricSection*> Metrics;
 249
 250 /** Helper class to keep track of the Meter *AND* Tempo in effect
 251     at a given point in time.
 252 */
 253 class LIBARDOUR_API TempoMetric {
 254   public:
 255         TempoMetric (const Meter& m, const Tempo& t)
 256                 : _meter (&m), _tempo (&t), _frame (0) {}
 257
 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; }
 262
 263         void set_metric (const MetricSection* section) {
 264                 const MeterSection* meter;
 265                 const TempoSection* tempo;
 266                 if ((meter = dynamic_cast<const MeterSection*>(section))) {
 267                         set_meter(*meter);
 268                 } else if ((tempo = dynamic_cast<const TempoSection*>(section))) {
 269                         set_tempo(*tempo);
 270                 }
 271
 272                 set_frame (section->frame());
 273                 set_pulse (section->pulse());
 274         }
 275
 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; }
 280
 281   private:
 282         const Meter*       _meter;
 283         const Tempo*       _tempo;
 284         framepos_t         _frame;
 285         double             _pulse;
 286 };
 287
 288 /** Tempo Map - mapping of timecode to musical time.
 289  * convert audio-samples, sample-rate to Bar/Beat/Tick, Meter/Tempo
 290  */
 291 class LIBARDOUR_API TempoMap : public PBD::StatefulDestructible
 292 {
 293   public:
 294         TempoMap (framecnt_t frame_rate);
 295         ~TempoMap();
 296
 297         /* measure-based stuff */
 298
 299         enum BBTPointType {
 300                 Bar,
 301                 Beat,
 302         };
 303
 304         struct BBTPoint {
 305                 framepos_t          frame;
 306                 Meter               meter;
 307                 Tempo               tempo;
 308                 double              c;
 309                 uint32_t            bar;
 310                 uint32_t            beat;
 311
 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.divisions_per_bar(), m.note_divisor()), tempo (t.beats_per_minute(), t.note_type()), c (func_c), bar (b), beat (e) {}
 315
 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; }
 320         };
 321
 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);
 325         }
 326
 327         void get_grid (std::vector<BBTPoint>&,
 328                        framepos_t start, framepos_t end);
 329
 330         static const Tempo& default_tempo() { return _default_tempo; }
 331         static const Meter& default_meter() { return _default_meter; }
 332
 333         double frames_per_beat_at (const framepos_t&, const framecnt_t& sr) const;
 334
 335         const Meter& meter_at (framepos_t) const;
 336
 337         const TempoSection& tempo_section_at (framepos_t frame) const;
 338         const MeterSection& meter_section_at (framepos_t frame) const;
 339         const MeterSection& meter_section_at_beat (double beat) const;
 340
 341
 342         /** add a tempo section locked to pls. ignored values will be set in recompute_tempos()
 343          * @param pulse pulse position of new section. ignored if pls == AudioTime
 344          * @param frame frame position of new section. ignored if pls == MusicTime
 345          * @param type type of new tempo section (Ramp, Constant)
 346          */
 347         TempoSection* add_tempo (const Tempo&, const double& pulse, const framepos_t& frame, TempoSection::Type type, PositionLockStyle pls);
 348
 349         /** add an meter section locked to pls.. ignored values will be set in recompute_meters()
 350          * @param beat beat position of new section
 351          * @param where bbt position of new section
 352          * @param frame frame position of new section. ignored if pls == MusicTime
 353          */
 354         MeterSection* add_meter (const Meter&, const double& beat, const Timecode::BBT_Time& where, const framepos_t& frame, PositionLockStyle pls);
 355
 356         void remove_tempo (const TempoSection&, bool send_signal);
 357         void remove_meter (const MeterSection&, bool send_signal);
 358
 359         void replace_tempo (const TempoSection&, const Tempo&, const double& pulse, const framepos_t& frame
 360                             , TempoSection::Type type, PositionLockStyle pls);
 361
 362         void replace_meter (const MeterSection&, const Meter&, const Timecode::BBT_Time& where, const framepos_t& frame
 363                             , PositionLockStyle pls);
 364
 365         framepos_t round_to_bar  (framepos_t frame, RoundMode dir);
 366         framepos_t round_to_beat (framepos_t frame, RoundMode dir);
 367         framepos_t round_to_beat_subdivision (framepos_t fr, int sub_num, RoundMode dir);
 368
 369         void set_length (framepos_t frames);
 370
 371         void fix_legacy_session();
 372
 373         XMLNode& get_state (void);
 374         int set_state (const XMLNode&, int version);
 375
 376         void dump (const Metrics& metrics, std::ostream&) const;
 377         void clear ();
 378
 379         TempoMetric metric_at (Timecode::BBT_Time bbt) const;
 380
 381         /** Return the TempoMetric at frame @p t, and point @p last to the latest
 382          * metric change <= t, if it is non-NULL.
 383          */
 384         TempoMetric metric_at (framepos_t, Metrics::const_iterator* last=NULL) const;
 385
 386         Metrics::const_iterator metrics_end() { return _metrics.end(); }
 387
 388         void change_existing_tempo_at (framepos_t, double bpm, double note_type);
 389         void change_initial_tempo (double bpm, double note_type);
 390
 391         void insert_time (framepos_t, framecnt_t);
 392         bool remove_time (framepos_t where, framecnt_t amount);  //returns true if anything was moved
 393
 394         int n_tempos () const;
 395         int n_meters () const;
 396
 397         framecnt_t frame_rate () const { return _frame_rate; }
 398
 399         /* TEMPO- AND METER-SENSITIVE FUNCTIONS
 400
 401            bbt_time(), beat_at_frame(), frame_at_beat(), frame_time()
 402            and bbt_duration_at()
 403            are all sensitive to tempo and meter, and will give answers
 404            that align with the grid formed by tempo and meter sections.
 405
 406            They SHOULD NOT be used to determine the position of events
 407            whose location is canonically defined in beats.
 408         */
 409
 410         double beat_at_frame (const framecnt_t& frame) const;
 411         framecnt_t frame_at_beat (const double& beat) const;
 412
 413         double pulse_at_beat (const double& beat) const;
 414         double beat_at_pulse (const double& pulse) const;
 415
 416         double pulse_at_frame (const framecnt_t& frame) const;
 417         framecnt_t frame_at_pulse (const double& pulse) const;
 418
 419         const Tempo tempo_at_frame (const framepos_t& frame) const;
 420
 421         double beat_at_bbt (const Timecode::BBT_Time& bbt);
 422         Timecode::BBT_Time bbt_at_beat (const double& beats);
 423
 424         double pulse_at_bbt (const Timecode::BBT_Time& bbt);
 425         Timecode::BBT_Time bbt_at_pulse (const double& pulse);
 426
 427         std::pair<double, framepos_t> predict_tempo_position (TempoSection* section, const Timecode::BBT_Time& bbt);
 428
 429         void bbt_time (framepos_t when, Timecode::BBT_Time&);
 430         framepos_t frame_time (const Timecode::BBT_Time&);
 431         framecnt_t bbt_duration_at (framepos_t, const Timecode::BBT_Time&, int dir);
 432
 433         /* TEMPO-SENSITIVE FUNCTIONS
 434
 435            These next 4 functions will all take tempo in account and should be
 436            used to determine position (and in the last case, distance in beats)
 437            when tempo matters but meter does not.
 438
 439            They SHOULD be used to determine the position of events
 440            whose location is canonically defined in beats.
 441         */
 442
 443         framepos_t framepos_plus_bbt (framepos_t pos, Timecode::BBT_Time b) const;
 444         framepos_t framepos_plus_beats (framepos_t, Evoral::Beats) const;
 445         framepos_t framepos_minus_beats (framepos_t, Evoral::Beats) const;
 446         Evoral::Beats framewalk_to_beats (framepos_t pos, framecnt_t distance) const;
 447
 448         void gui_move_tempo (TempoSection*, const framepos_t& frame);
 449         void gui_move_meter (MeterSection*, const framepos_t& frame);
 450         bool gui_change_tempo (TempoSection*, const Tempo& bpm);
 451         void gui_dilate_tempo (TempoSection* tempo, const framepos_t& frame, const framepos_t& end_frame, const double& pulse);
 452
 453         bool can_solve_bbt (TempoSection* section, const Timecode::BBT_Time& bbt);
 454
 455         PBD::Signal0<void> MetricPositionChanged;
 456
 457 private:
 458         double pulse_at_beat_locked (const Metrics& metrics, const double& beat) const;
 459         double beat_at_pulse_locked (const Metrics& metrics, const double& pulse) const;
 460
 461         double pulse_at_frame_locked (const Metrics& metrics, const framecnt_t& frame) const;
 462         framecnt_t frame_at_pulse_locked (const Metrics& metrics, const double& pulse) const;
 463
 464         double beat_at_frame_locked (const Metrics& metrics, const framecnt_t& frame) const;
 465         framecnt_t frame_at_beat_locked (const Metrics& metrics, const double& beat) const;
 466
 467         double beat_at_bbt_locked (const Metrics& metrics, const Timecode::BBT_Time& bbt) const ;
 468         Timecode::BBT_Time bbt_at_beat_locked (const Metrics& metrics, const double& beats) const;
 469
 470         double pulse_at_bbt_locked (const Metrics& metrics, const Timecode::BBT_Time& bbt) const;
 471         Timecode::BBT_Time bbt_at_pulse_locked (const Metrics& metrics, const double& pulse) const;
 472
 473         const Tempo tempo_at_frame_locked (const Metrics& metrics, const framepos_t& frame) const;
 474
 475         framepos_t frame_time_locked (const Metrics& metrics, const Timecode::BBT_Time&) const;
 476
 477         const TempoSection& tempo_section_at_locked (const Metrics& metrics, framepos_t frame) const;
 478         const TempoSection& tempo_section_at_beat_locked (const Metrics& metrics, const double& beat) const;
 479         const TempoSection& tempo_section_at_pulse_locked (const Metrics& metrics, const double& pulse) const;
 480
 481         const MeterSection& meter_section_at_locked (const Metrics& metrics, framepos_t frame) const;
 482         const MeterSection& meter_section_at_beat_locked (const Metrics& metrics, const double& beat) const;
 483
 484         bool check_solved (const Metrics& metrics) const;
 485         bool set_active_tempos (const Metrics& metrics, const framepos_t& frame);
 486
 487         bool solve_map_frame (Metrics& metrics, TempoSection* section, const framepos_t& frame);
 488         bool solve_map_pulse (Metrics& metrics, TempoSection* section, const double& pulse);
 489         bool solve_map_frame (Metrics& metrics, MeterSection* section, const framepos_t& frame);
 490         bool solve_map_bbt (Metrics& metrics, MeterSection* section, const Timecode::BBT_Time& bbt);
 491
 492         friend class ::BBTTest;
 493         friend class ::FrameposPlusBeatsTest;
 494         friend class ::TempoTest;
 495
 496         static Tempo    _default_tempo;
 497         static Meter    _default_meter;
 498
 499         Metrics                       _metrics;
 500         framecnt_t                    _frame_rate;
 501         mutable Glib::Threads::RWLock lock;
 502
 503         void recompute_tempos (Metrics& metrics);
 504         void recompute_meters (Metrics& metrics);
 505         void recompute_map (Metrics& metrics, framepos_t end = -1);
 506
 507         framepos_t round_to_type (framepos_t fr, RoundMode dir, BBTPointType);
 508
 509         const MeterSection& first_meter() const;
 510         MeterSection&       first_meter();
 511         const TempoSection& first_tempo() const;
 512         TempoSection&       first_tempo();
 513
 514         void do_insert (MetricSection* section);
 515
 516         TempoSection* add_tempo_locked (const Tempo&, double pulse, framepos_t frame
 517                                , TempoSection::Type type, PositionLockStyle pls, bool recompute, bool locked_to_meter = false);
 518
 519         MeterSection* add_meter_locked (const Meter&, double beat, const Timecode::BBT_Time& where, framepos_t frame
 520                                         , PositionLockStyle pls, bool recompute);
 521
 522         bool remove_tempo_locked (const TempoSection&);
 523         bool remove_meter_locked (const MeterSection&);
 524
 525         TempoSection* copy_metrics_and_point (const Metrics& metrics, Metrics& copy, TempoSection* section);
 526         MeterSection* copy_metrics_and_point (const Metrics& metrics, Metrics& copy, MeterSection* section);
 527 };
 528
 529 }; /* namespace ARDOUR */
 530
 531 std::ostream& operator<< (std::ostream&, const ARDOUR::Meter&);
 532 std::ostream& operator<< (std::ostream&, const ARDOUR::Tempo&);
 533 std::ostream& operator<< (std::ostream&, const ARDOUR::MetricSection&);
 534
 535 #endif /* __ardour_tempo_h__ */