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_beat (std::pair<double, Timecode::BBT_Time>& w) {
 153                 _beat = w.first;
 154                 _bbt = w.second;
 155         }
 156
 157         const Timecode::BBT_Time& bbt() const { return _bbt; }
 158         const double& beat () const { return _beat; }
 159         void set_beat (double beat) { _beat = beat; }
 160
 161 private:
 162         Timecode::BBT_Time _bbt;
 163         double _beat;
 164 };
 165
 166 /** A section of timeline with a certain Tempo. */
 167 class LIBARDOUR_API TempoSection : public MetricSection, public Tempo {
 168   public:
 169         enum Type {
 170                 Ramp,
 171                 Constant,
 172         };
 173
 174         TempoSection (const double& pulse, const framepos_t& frame, double qpm, double note_type, Type tempo_type, PositionLockStyle pls)
 175                 : MetricSection (pulse, frame, pls), Tempo (qpm, note_type), _type (tempo_type), _c_func (0.0), _active (true), _locked_to_meter (false)  {}
 176
 177         TempoSection (const XMLNode&);
 178
 179         static const std::string xml_state_node_name;
 180
 181         XMLNode& get_state() const;
 182
 183         double c_func () const { return _c_func; }
 184         void set_c_func (double c_func) { _c_func = c_func; }
 185
 186         void set_type (Type type);
 187         Type type () const { return _type; }
 188
 189         bool active () const { return _active; }
 190         void set_active (bool yn) { _active = yn; }
 191
 192         bool locked_to_meter ()  const { return _locked_to_meter; }
 193         void set_locked_to_meter (bool yn) { _locked_to_meter = yn; }
 194
 195         double tempo_at_frame (const framepos_t& frame, const framecnt_t& frame_rate) const;
 196         framepos_t frame_at_tempo (const double& ppm, const double& beat, const framecnt_t& frame_rate) const;
 197
 198         double tempo_at_pulse (const double& pulse) const;
 199         double pulse_at_tempo (const double& ppm, const framepos_t& frame, const framecnt_t& frame_rate) const;
 200
 201         double pulse_at_frame (const framepos_t& frame, const framecnt_t& frame_rate) const;
 202         frameoffset_t frame_at_pulse (const double& pulse, const framecnt_t& frame_rate) const;
 203
 204         double compute_c_func_pulse (const double& end_bpm, const double& end_pulse, const framecnt_t& frame_rate);
 205         double compute_c_func_frame (const double& end_bpm, const framepos_t& end_frame, const framecnt_t& frame_rate) const;
 206
 207         Timecode::BBT_Time legacy_bbt () { return _legacy_bbt; }
 208
 209   private:
 210
 211         framepos_t minute_to_frame (const double& time, const framecnt_t& frame_rate) const;
 212         double frame_to_minute (const framepos_t& frame, const framecnt_t& frame_rate) const;
 213
 214         /*  tempo ramp functions. zero-based with time in minutes,
 215          * 'tick tempo' in ticks per minute and tempo in bpm.
 216          *  time relative to section start.
 217          */
 218         double a_func (double end_tpm, double c_func) const;
 219         double c_func (double end_tpm, double end_time) const;
 220
 221         double pulse_tempo_at_time (const double& time) const;
 222         double time_at_pulse_tempo (const double& pulse_tempo) const;
 223
 224         double pulse_tempo_at_pulse (const double& pulse) const;
 225         double pulse_at_pulse_tempo (const double& pulse_tempo) const;
 226
 227         double pulse_at_time (const double& time) const;
 228         double time_at_pulse (const double& pulse) const;
 229
 230         /* this value provides a fractional offset into the bar in which
 231            the tempo section is located in. A value of 0.0 indicates that
 232            it occurs on the first beat of the bar, a value of 0.5 indicates
 233            that it occurs halfway through the bar and so on.
 234
 235            this enables us to keep the tempo change at the same relative
 236            position within the bar if/when the meter changes.
 237         */
 238         Type _type;
 239         double _c_func;
 240         bool _active;
 241         bool _locked_to_meter;
 242         Timecode::BBT_Time _legacy_bbt;
 243 };
 244
 245 typedef std::list<MetricSection*> Metrics;
 246
 247 /** Helper class to keep track of the Meter *AND* Tempo in effect
 248     at a given point in time.
 249 */
 250 class LIBARDOUR_API TempoMetric {
 251   public:
 252         TempoMetric (const Meter& m, const Tempo& t)
 253                 : _meter (&m), _tempo (&t), _frame (0) {}
 254
 255         void set_tempo (const Tempo& t)              { _tempo = &t; }
 256         void set_meter (const Meter& m)              { _meter = &m; }
 257         void set_frame (framepos_t f)                { _frame = f; }
 258         void set_pulse (const double& p)             { _pulse = p; }
 259
 260         void set_metric (const MetricSection* section) {
 261                 const MeterSection* meter;
 262                 const TempoSection* tempo;
 263                 if ((meter = dynamic_cast<const MeterSection*>(section))) {
 264                         set_meter(*meter);
 265                 } else if ((tempo = dynamic_cast<const TempoSection*>(section))) {
 266                         set_tempo(*tempo);
 267                 }
 268
 269                 set_frame (section->frame());
 270                 set_pulse (section->pulse());
 271         }
 272
 273         const Meter&              meter() const { return *_meter; }
 274         const Tempo&              tempo() const { return *_tempo; }
 275         framepos_t                frame() const { return _frame; }
 276         const double&             pulse() const { return _pulse; }
 277
 278   private:
 279         const Meter*       _meter;
 280         const Tempo*       _tempo;
 281         framepos_t         _frame;
 282         double             _pulse;
 283 };
 284
 285 /** Tempo Map - mapping of timecode to musical time.
 286  * convert audio-samples, sample-rate to Bar/Beat/Tick, Meter/Tempo
 287  */
 288 class LIBARDOUR_API TempoMap : public PBD::StatefulDestructible
 289 {
 290   public:
 291         TempoMap (framecnt_t frame_rate);
 292         ~TempoMap();
 293
 294         /* measure-based stuff */
 295
 296         enum BBTPointType {
 297                 Bar,
 298                 Beat,
 299         };
 300
 301         struct BBTPoint {
 302                 framepos_t          frame;
 303                 Meter               meter;
 304                 Tempo               tempo;
 305                 double              c;
 306                 uint32_t            bar;
 307                 uint32_t            beat;
 308
 309                 BBTPoint (const MeterSection& m, const Tempo& t, framepos_t f,
 310                           uint32_t b, uint32_t e, double func_c)
 311                 : 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) {}
 312
 313                 Timecode::BBT_Time bbt() const { return Timecode::BBT_Time (bar, beat, 0); }
 314                 operator Timecode::BBT_Time() const { return bbt(); }
 315                 operator framepos_t() const { return frame; }
 316                 bool is_bar() const { return beat == 1; }
 317         };
 318
 319         template<class T> void apply_with_metrics (T& obj, void (T::*method)(const Metrics&)) {
 320                 Glib::Threads::RWLock::ReaderLock lm (lock);
 321                 (obj.*method)(_metrics);
 322         }
 323
 324         void get_grid (std::vector<BBTPoint>&,
 325                        framepos_t start, framepos_t end);
 326
 327         static const Tempo& default_tempo() { return _default_tempo; }
 328         static const Meter& default_meter() { return _default_meter; }
 329
 330         /* because tempos may be ramped, this is only valid for the instant requested.*/
 331         double frames_per_beat_at (const framepos_t&, const framecnt_t& sr) const;
 332
 333         const TempoSection& tempo_section_at_frame (framepos_t frame) const;
 334         const MeterSection& meter_section_at_frame (framepos_t frame) const;
 335         const MeterSection& meter_section_at_beat (double beat) const;
 336
 337         /** add a tempo section locked to pls. ignored values will be set in recompute_tempos()
 338          * @param pulse pulse position of new section. ignored if pls == AudioTime
 339          * @param frame frame position of new section. ignored if pls == MusicTime
 340          * @param type type of new tempo section (Ramp, Constant)
 341          */
 342         TempoSection* add_tempo (const Tempo&, const double& pulse, const framepos_t& frame, TempoSection::Type type, PositionLockStyle pls);
 343
 344         /** add an meter section locked to pls.. ignored values will be set in recompute_meters()
 345          * @param beat beat position of new section
 346          * @param where bbt position of new section
 347          * @param frame frame position of new section. ignored if pls == MusicTime
 348          */
 349         MeterSection* add_meter (const Meter&, const double& beat, const Timecode::BBT_Time& where, const framepos_t& frame, PositionLockStyle pls);
 350
 351         void remove_tempo (const TempoSection&, bool send_signal);
 352         void remove_meter (const MeterSection&, bool send_signal);
 353
 354         void replace_tempo (const TempoSection&, const Tempo&, const double& pulse, const framepos_t& frame
 355                             , TempoSection::Type type, PositionLockStyle pls);
 356
 357         void replace_meter (const MeterSection&, const Meter&, const Timecode::BBT_Time& where, const framepos_t& frame
 358                             , PositionLockStyle pls);
 359
 360         framepos_t round_to_bar  (framepos_t frame, RoundMode dir);
 361         framepos_t round_to_beat (framepos_t frame, RoundMode dir);
 362         framepos_t round_to_beat_subdivision (framepos_t fr, int sub_num, RoundMode dir);
 363
 364         void set_length (framepos_t frames);
 365
 366         XMLNode& get_state (void);
 367         int set_state (const XMLNode&, int version);
 368
 369         void dump (const Metrics& metrics, std::ostream&) const;
 370         void clear ();
 371
 372         TempoMetric metric_at (Timecode::BBT_Time bbt) const;
 373
 374         /** Return the TempoMetric at frame @p t, and point @p last to the latest
 375          * metric change <= t, if it is non-NULL.
 376          */
 377         TempoMetric metric_at (framepos_t, Metrics::const_iterator* last=NULL) const;
 378
 379         Metrics::const_iterator metrics_end() { return _metrics.end(); }
 380
 381         void change_existing_tempo_at (framepos_t, double bpm, double note_type);
 382         void change_initial_tempo (double bpm, double note_type);
 383
 384         void insert_time (framepos_t, framecnt_t);
 385         bool remove_time (framepos_t where, framecnt_t amount);  //returns true if anything was moved
 386
 387         int n_tempos () const;
 388         int n_meters () const;
 389
 390         framecnt_t frame_rate () const { return _frame_rate; }
 391
 392         /* TEMPO- AND METER-SENSITIVE FUNCTIONS
 393
 394            bbt_at_frame(), frame_at_bbt(), beat_at_frame(), frame_at_beat(), tempo_at_beat()
 395            and bbt_duration_at()
 396            are all sensitive to tempo and meter, and will give answers
 397            that align with the grid formed by tempo and meter sections.
 398
 399            They SHOULD NOT be used to determine the position of events
 400            whose location is canonically defined in beats.
 401         */
 402
 403         double beat_at_frame (const framecnt_t& frame) const;
 404         framecnt_t frame_at_beat (const double& beat) const;
 405
 406         Tempo tempo_at_frame (const framepos_t& frame) const;
 407         framepos_t frame_at_tempo (const Tempo& tempo) const;
 408
 409         Tempo tempo_at_beat (const double& beat) const;
 410
 411         const Meter& meter_at_frame (framepos_t) const;
 412
 413         /* you probably only need to use pulses when moving tempos */
 414         double pulse_at_beat (const double& beat) const;
 415         double beat_at_pulse (const double& pulse) const;
 416
 417         double pulse_at_frame (const framecnt_t& frame) const;
 418         framecnt_t frame_at_pulse (const double& pulse) const;
 419
 420         /* bbt - it's nearly always better to use beats.*/
 421         Timecode::BBT_Time bbt_at_frame (framepos_t when);
 422         Timecode::BBT_Time bbt_at_frame_rt (framepos_t when);
 423         framepos_t frame_at_bbt (const Timecode::BBT_Time&);
 424
 425         double beat_at_bbt (const Timecode::BBT_Time& bbt);
 426         Timecode::BBT_Time bbt_at_beat (const double& beats);
 427
 428         double pulse_at_bbt (const Timecode::BBT_Time& bbt);
 429         Timecode::BBT_Time bbt_at_pulse (const double& pulse);
 430
 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, const int& sub_num);
 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         std::pair<double, framepos_t> predict_tempo_position (TempoSection* section, const Timecode::BBT_Time& bbt);
 454         bool can_solve_bbt (TempoSection* section, const Timecode::BBT_Time& bbt);
 455
 456         PBD::Signal0<void> MetricPositionChanged;
 457         void fix_legacy_session();
 458
 459 private:
 460
 461         double beat_at_frame_locked (const Metrics& metrics, const framecnt_t& frame) const;
 462         framecnt_t frame_at_beat_locked (const Metrics& metrics, const double& beat) const;
 463
 464         double pulse_at_beat_locked (const Metrics& metrics, const double& beat) const;
 465         double beat_at_pulse_locked (const Metrics& metrics, const double& pulse) const;
 466
 467         double pulse_at_frame_locked (const Metrics& metrics, const framecnt_t& frame) const;
 468         framecnt_t frame_at_pulse_locked (const Metrics& metrics, const double& pulse) const;
 469
 470         Tempo tempo_at_frame_locked (const Metrics& metrics, const framepos_t& frame) const;
 471         framepos_t frame_at_tempo_locked (const Metrics& metrics, const Tempo& tempo) const;
 472
 473         Timecode::BBT_Time bbt_at_frame_locked (const Metrics& metrics, const framepos_t& frame) const;
 474         framepos_t frame_at_bbt_locked (const Metrics& metrics, const Timecode::BBT_Time&) const;
 475
 476         double beat_at_bbt_locked (const Metrics& metrics, const Timecode::BBT_Time& bbt) const ;
 477         Timecode::BBT_Time bbt_at_beat_locked (const Metrics& metrics, const double& beats) const;
 478
 479         double pulse_at_bbt_locked (const Metrics& metrics, const Timecode::BBT_Time& bbt) const;
 480         Timecode::BBT_Time bbt_at_pulse_locked (const Metrics& metrics, const double& pulse) const;
 481
 482         const TempoSection& tempo_section_at_frame_locked (const Metrics& metrics, framepos_t frame) const;
 483         const TempoSection& tempo_section_at_beat_locked (const Metrics& metrics, const double& beat) const;
 484
 485         const MeterSection& meter_section_at_frame_locked (const Metrics& metrics, framepos_t frame) const;
 486         const MeterSection& meter_section_at_beat_locked (const Metrics& metrics, const double& beat) const;
 487
 488         bool check_solved (const Metrics& metrics) const;
 489         bool set_active_tempos (const Metrics& metrics, const framepos_t& frame);
 490
 491         bool solve_map_frame (Metrics& metrics, TempoSection* section, const framepos_t& frame);
 492         bool solve_map_pulse (Metrics& metrics, TempoSection* section, const double& pulse);
 493         bool solve_map_frame (Metrics& metrics, MeterSection* section, const framepos_t& frame);
 494         bool solve_map_bbt (Metrics& metrics, MeterSection* section, const Timecode::BBT_Time& bbt);
 495
 496         friend class ::BBTTest;
 497         friend class ::FrameposPlusBeatsTest;
 498         friend class ::TempoTest;
 499
 500         static Tempo    _default_tempo;
 501         static Meter    _default_meter;
 502
 503         Metrics                       _metrics;
 504         framecnt_t                    _frame_rate;
 505         mutable Glib::Threads::RWLock lock;
 506
 507         void recompute_tempos (Metrics& metrics);
 508         void recompute_meters (Metrics& metrics);
 509         void recompute_map (Metrics& metrics, framepos_t end = -1);
 510
 511         framepos_t round_to_type (framepos_t fr, RoundMode dir, BBTPointType);
 512
 513         const MeterSection& first_meter() const;
 514         MeterSection&       first_meter();
 515         const TempoSection& first_tempo() const;
 516         TempoSection&       first_tempo();
 517
 518         void do_insert (MetricSection* section);
 519
 520         TempoSection* add_tempo_locked (const Tempo&, double pulse, framepos_t frame
 521                                , TempoSection::Type type, PositionLockStyle pls, bool recompute, bool locked_to_meter = false);
 522
 523         MeterSection* add_meter_locked (const Meter&, double beat, const Timecode::BBT_Time& where, framepos_t frame
 524                                         , PositionLockStyle pls, bool recompute);
 525
 526         bool remove_tempo_locked (const TempoSection&);
 527         bool remove_meter_locked (const MeterSection&);
 528
 529         TempoSection* copy_metrics_and_point (const Metrics& metrics, Metrics& copy, TempoSection* section);
 530         MeterSection* copy_metrics_and_point (const Metrics& metrics, Metrics& copy, MeterSection* section);
 531 };
 532
 533 }; /* namespace ARDOUR */
 534
 535 std::ostream& operator<< (std::ostream&, const ARDOUR::Meter&);
 536 std::ostream& operator<< (std::ostream&, const ARDOUR::Tempo&);
 537 std::ostream& operator<< (std::ostream&, const ARDOUR::MetricSection&);
 538
 539 #endif /* __ardour_tempo_h__ */