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         double beats_per_minute () const { return _beats_per_minute; }
  59
  60         double ticks_per_minute () const { return _beats_per_minute * Timecode::BBT_Time::ticks_per_beat;}
  61         double note_type () const { return _note_type;}
  62         /** audio samples per beat
  63          * @param sr samplerate
  64          */
  65         double frames_per_beat (framecnt_t sr) const {
  66                 return (60.0 * sr) / _beats_per_minute;
  67         }
  68
  69   protected:
  70         double _beats_per_minute;
  71         double _note_type;
  72 };
  73
  74 /** Meter, or time signature (beats per bar, and which note type is a beat). */
  75 class LIBARDOUR_API Meter {
  76   public:
  77         Meter (double dpb, double bt)
  78                 : _divisions_per_bar (dpb), _note_type (bt) {}
  79
  80         double divisions_per_bar () const { return _divisions_per_bar; }
  81         double note_divisor() const { return _note_type; }
  82
  83         double frames_per_bar (const Tempo&, framecnt_t sr) const;
  84         double frames_per_grid (const Tempo&, framecnt_t sr) const;
  85
  86   protected:
  87         /** The number of divisions in a bar.  This is a floating point value because
  88             there are musical traditions on our planet that do not limit
  89             themselves to integral numbers of beats per bar.
  90         */
  91         double _divisions_per_bar;
  92
  93         /** The type of "note" that a division represents.  For example, 4.0 is
  94             a quarter (crotchet) note, 8.0 is an eighth (quaver) note, etc.
  95         */
  96         double _note_type;
  97 };
  98
  99 /** A section of timeline with a certain Tempo or Meter. */
 100 class LIBARDOUR_API MetricSection {
 101   public:
 102         MetricSection (double beat)
 103                 : _beat (beat), _frame (0), _movable (true), _position_lock_style (PositionLockStyle::MusicTime) {}
 104         MetricSection (framepos_t frame)
 105                 : _beat (0), _frame (frame), _movable (true), _position_lock_style (PositionLockStyle::AudioTime) {}
 106
 107         virtual ~MetricSection() {}
 108
 109         const double& beat () const { return _beat; }
 110         void set_beat (double beat) { _beat = beat;}
 111
 112         framepos_t frame() const { return _frame; }
 113         virtual void set_frame (framepos_t f) {
 114                 _frame = f;
 115         }
 116
 117         void set_movable (bool yn) { _movable = yn; }
 118         bool movable() const { return _movable; }
 119
 120         /* MeterSections are not stateful in the full sense,
 121            but we do want them to control their own
 122            XML state information.
 123         */
 124         virtual XMLNode& get_state() const = 0;
 125
 126         PositionLockStyle position_lock_style () const { return _position_lock_style; }
 127         void set_position_lock_style (PositionLockStyle ps) { _position_lock_style = ps; }
 128
 129 private:
 130         double             _beat;
 131         framepos_t         _frame;
 132         bool               _movable;
 133         PositionLockStyle  _position_lock_style;
 134 };
 135
 136 /** A section of timeline with a certain Meter. */
 137 class LIBARDOUR_API MeterSection : public MetricSection, public Meter {
 138   public:
 139         MeterSection (double beat, const Timecode::BBT_Time& bbt, double bpb, double note_type)
 140                 : MetricSection (beat), Meter (bpb, note_type), _bbt (bbt) {}
 141         MeterSection (framepos_t frame, double bpb, double note_type)
 142                 : MetricSection (frame), Meter (bpb, note_type) {}
 143         MeterSection (const XMLNode&);
 144
 145         static const std::string xml_state_node_name;
 146
 147         XMLNode& get_state() const;
 148
 149         void set_beat (std::pair<double, Timecode::BBT_Time>& w) {
 150                 MetricSection::set_beat (w.first);
 151                 _bbt = w.second;
 152         }
 153
 154         const Timecode::BBT_Time& bbt() const { return _bbt; }
 155 private:
 156         Timecode::BBT_Time _bbt;
 157 };
 158
 159 /** A section of timeline with a certain Tempo. */
 160 class LIBARDOUR_API TempoSection : public MetricSection, public Tempo {
 161   public:
 162         enum Type {
 163                 Ramp,
 164                 Constant,
 165         };
 166
 167         TempoSection (const double& beat, double qpm, double note_type, Type tempo_type)
 168                 : MetricSection (beat), Tempo (qpm, note_type), _bar_offset (-1.0), _type (tempo_type), _c_func (0.0)  {}
 169         TempoSection (framepos_t frame, double qpm, double note_type, Type tempo_type)
 170                 : MetricSection (frame), Tempo (qpm, note_type), _bar_offset (-1.0), _type (tempo_type), _c_func (0.0) {}
 171         TempoSection (const XMLNode&);
 172
 173         static const std::string xml_state_node_name;
 174
 175         XMLNode& get_state() const;
 176
 177         void update_bar_offset_from_bbt (const Meter&);
 178         void update_bbt_time_from_bar_offset (const Meter&);
 179         double bar_offset() const { return _bar_offset; }
 180
 181         void set_type (Type type);
 182         Type type () const { return _type; }
 183
 184         double tempo_at_frame (framepos_t frame, framecnt_t frame_rate) const;
 185         framepos_t frame_at_tempo (double tempo, framecnt_t frame_rate) const;
 186
 187         double tick_at_frame (framepos_t frame, framecnt_t frame_rate) const;
 188         framepos_t frame_at_tick (double tick, framecnt_t frame_rate) const;
 189
 190         double beat_at_frame (framepos_t frame, framecnt_t frame_rate) const;
 191         framepos_t frame_at_beat (double beat, framecnt_t frame_rate) const;
 192
 193         void set_c_func_from_tempo_and_beat (double end_bpm, double end_beat, framecnt_t frame_rate);
 194         double compute_c_func (double end_bpm, framepos_t end_frame, framecnt_t frame_rate) const;
 195         double get_c_func () const { return _c_func; }
 196         void set_c_func (double c_func) { _c_func = c_func; }
 197
 198         Timecode::BBT_Time legacy_bbt () { return _legacy_bbt; }
 199
 200   private:
 201
 202         framecnt_t minute_to_frame (double time, framecnt_t frame_rate) const;
 203         double frame_to_minute (framecnt_t frame, framecnt_t frame_rate) const;
 204
 205         /*  tempo ramp functions. zero-based with time in minutes,
 206          * 'tick tempo' in ticks per minute and tempo in bpm.
 207          *  time relative to section start.
 208          */
 209         double a_func (double end_tpm, double c_func) const;
 210         double c_func (double end_tpm, double end_time) const;
 211
 212         double tick_tempo_at_time (double time) const;
 213         double time_at_tick_tempo (double tick_tempo) const;
 214
 215         double tick_at_time (double time) const;
 216         double time_at_tick (double tick) const;
 217
 218         double beat_at_time (double time) const;
 219         double time_at_beat (double beat) const;
 220
 221         /* this value provides a fractional offset into the bar in which
 222            the tempo section is located in. A value of 0.0 indicates that
 223            it occurs on the first beat of the bar, a value of 0.5 indicates
 224            that it occurs halfway through the bar and so on.
 225
 226            this enables us to keep the tempo change at the same relative
 227            position within the bar if/when the meter changes.
 228         */
 229         double _bar_offset;
 230         Type _type;
 231         double _c_func;
 232         Timecode::BBT_Time _legacy_bbt;
 233 };
 234
 235 typedef std::list<MetricSection*> Metrics;
 236
 237 /** Helper class to keep track of the Meter *AND* Tempo in effect
 238     at a given point in time.
 239 */
 240 class LIBARDOUR_API TempoMetric {
 241   public:
 242         TempoMetric (const Meter& m, const Tempo& t)
 243                 : _meter (&m), _tempo (&t), _frame (0) {}
 244
 245         void set_tempo (const Tempo& t)              { _tempo = &t; }
 246         void set_meter (const Meter& m)              { _meter = &m; }
 247         void set_frame (framepos_t f)                { _frame = f; }
 248         void set_beat (const double& t)              { _beat = t; }
 249
 250         void set_metric (const MetricSection* section) {
 251                 const MeterSection* meter;
 252                 const TempoSection* tempo;
 253                 if ((meter = dynamic_cast<const MeterSection*>(section))) {
 254                         set_meter(*meter);
 255                 } else if ((tempo = dynamic_cast<const TempoSection*>(section))) {
 256                         set_tempo(*tempo);
 257                 }
 258
 259                 set_frame(section->frame());
 260                 set_beat(section->beat());
 261         }
 262
 263         const Meter&              meter() const { return *_meter; }
 264         const Tempo&              tempo() const { return *_tempo; }
 265         framepos_t                frame() const { return _frame; }
 266         const double&             beat() const { return _beat; }
 267
 268   private:
 269         const Meter*       _meter;
 270         const Tempo*       _tempo;
 271         framepos_t         _frame;
 272         double             _beat;
 273 };
 274
 275 /** Tempo Map - mapping of timecode to musical time.
 276  * convert audio-samples, sample-rate to Bar/Beat/Tick, Meter/Tempo
 277  */
 278 class LIBARDOUR_API TempoMap : public PBD::StatefulDestructible
 279 {
 280   public:
 281         TempoMap (framecnt_t frame_rate);
 282         ~TempoMap();
 283
 284         /* measure-based stuff */
 285
 286         enum BBTPointType {
 287                 Bar,
 288                 Beat,
 289         };
 290
 291         struct BBTPoint {
 292                 framepos_t          frame;
 293                 const MeterSection* meter;
 294                 const Tempo* tempo;
 295                 uint32_t            bar;
 296                 uint32_t            beat;
 297
 298                 BBTPoint (const MeterSection& m, const Tempo& t, framepos_t f,
 299                           uint32_t b, uint32_t e)
 300                         : frame (f), meter (&m), tempo (&t), bar (b), beat (e) {}
 301
 302                 Timecode::BBT_Time bbt() const { return Timecode::BBT_Time (bar, beat, 0); }
 303                 operator Timecode::BBT_Time() const { return bbt(); }
 304                 operator framepos_t() const { return frame; }
 305                 bool is_bar() const { return beat == 1; }
 306         };
 307
 308         template<class T> void apply_with_metrics (T& obj, void (T::*method)(const Metrics&)) {
 309                 Glib::Threads::RWLock::ReaderLock lm (lock);
 310                 (obj.*method)(metrics);
 311         }
 312
 313         void get_grid (std::vector<BBTPoint>&,
 314                        framepos_t start, framepos_t end);
 315
 316         /* TEMPO- AND METER-SENSITIVE FUNCTIONS
 317
 318            bbt_time(), beat_at_frame(), frame_at_beat(), tick_at_frame(),
 319            frame_at_tick(),frame_time() and bbt_duration_at()
 320            are all sensitive to tempo and meter, and will give answers
 321            that align with the grid formed by tempo and meter sections.
 322
 323            They SHOULD NOT be used to determine the position of events
 324            whose location is canonically defined in beats.
 325         */
 326
 327         void bbt_time (framepos_t when, Timecode::BBT_Time&);
 328
 329         double tick_at_frame (framecnt_t frame) const;
 330         framecnt_t frame_at_tick (double tick) const;
 331
 332         double beat_at_frame (framecnt_t frame) const;
 333         framecnt_t frame_at_beat (double beat) const;
 334
 335         framepos_t frame_time (const Timecode::BBT_Time&);
 336         framecnt_t bbt_duration_at (framepos_t, const Timecode::BBT_Time&, int dir);
 337
 338         /* TEMPO-SENSITIVE FUNCTIONS
 339
 340            These next 4 functions will all take tempo in account and should be
 341            used to determine position (and in the last case, distance in beats)
 342            when tempo matters but meter does not.
 343
 344            They SHOULD be used to determine the position of events
 345            whose location is canonically defined in beats.
 346         */
 347
 348         framepos_t framepos_plus_bbt (framepos_t pos, Timecode::BBT_Time b) const;
 349         framepos_t framepos_plus_beats (framepos_t, Evoral::Beats) const;
 350         framepos_t framepos_minus_beats (framepos_t, Evoral::Beats) const;
 351         Evoral::Beats framewalk_to_beats (framepos_t pos, framecnt_t distance) const;
 352
 353         static const Tempo& default_tempo() { return _default_tempo; }
 354         static const Meter& default_meter() { return _default_meter; }
 355
 356         const Tempo tempo_at (framepos_t) const;
 357         double frames_per_beat_at (framepos_t, framecnt_t sr) const;
 358
 359         const Meter& meter_at (framepos_t) const;
 360
 361         const TempoSection& tempo_section_at (framepos_t) const;
 362         const MeterSection& meter_section_at (framepos_t) const;
 363
 364         void add_tempo (const Tempo&, double where, TempoSection::Type type);
 365         void add_tempo (const Tempo&, framepos_t frame, TempoSection::Type type);
 366
 367         void add_meter (const Meter&, double beat, Timecode::BBT_Time where);
 368         void add_meter (const Meter&, framepos_t frame);
 369
 370         void remove_tempo (const TempoSection&, bool send_signal);
 371         void remove_meter (const MeterSection&, bool send_signal);
 372
 373         void replace_tempo (const TempoSection&, const Tempo&, const double& where, TempoSection::Type type);
 374         void replace_tempo (const TempoSection&, const Tempo&, const framepos_t& where, TempoSection::Type type);
 375
 376         void gui_set_tempo_frame (TempoSection&, framepos_t where, double beat);
 377         void replace_meter (const MeterSection&, const Meter&, const Timecode::BBT_Time& where);
 378         void replace_meter (const MeterSection&, const Meter&, const framepos_t& frame);
 379
 380         framepos_t round_to_bar  (framepos_t frame, RoundMode dir);
 381         framepos_t round_to_beat (framepos_t frame, RoundMode dir);
 382         framepos_t round_to_beat_subdivision (framepos_t fr, int sub_num, RoundMode dir);
 383
 384         void set_length (framepos_t frames);
 385
 386         XMLNode& get_state (void);
 387         int set_state (const XMLNode&, int version);
 388
 389         void dump (std::ostream&) const;
 390         void clear ();
 391
 392         TempoMetric metric_at (Timecode::BBT_Time bbt) const;
 393
 394         /** Return the TempoMetric at frame @p t, and point @p last to the latest
 395          * metric change <= t, if it is non-NULL.
 396          */
 397         TempoMetric metric_at (framepos_t, Metrics::const_iterator* last=NULL) const;
 398
 399         Metrics::const_iterator metrics_end() { return metrics.end(); }
 400
 401         void change_existing_tempo_at (framepos_t, double bpm, double note_type);
 402         void change_initial_tempo (double bpm, double note_type);
 403
 404         void insert_time (framepos_t, framecnt_t);
 405         bool remove_time (framepos_t where, framecnt_t amount);  //returns true if anything was moved
 406
 407         int n_tempos () const;
 408         int n_meters () const;
 409
 410         framecnt_t frame_rate () const { return _frame_rate; }
 411
 412         PBD::Signal0<void> MetricPositionChanged;
 413
 414         double bbt_to_beats (Timecode::BBT_Time bbt);
 415         Timecode::BBT_Time beats_to_bbt (double beats);
 416
 417 private:
 418         double bbt_to_beats_locked (Timecode::BBT_Time bbt);
 419         Timecode::BBT_Time beats_to_bbt_locked (double beats);
 420
 421         friend class ::BBTTest;
 422         friend class ::FrameposPlusBeatsTest;
 423         friend class ::TempoTest;
 424
 425         static Tempo    _default_tempo;
 426         static Meter    _default_meter;
 427
 428         Metrics                       metrics;
 429         framecnt_t                    _frame_rate;
 430         mutable Glib::Threads::RWLock lock;
 431
 432         void recompute_map (bool reassign_tempo_bbt, framepos_t end = -1);
 433
 434         framepos_t round_to_type (framepos_t fr, RoundMode dir, BBTPointType);
 435
 436         const MeterSection& first_meter() const;
 437         MeterSection&       first_meter();
 438         const TempoSection& first_tempo() const;
 439         TempoSection&       first_tempo();
 440
 441         void do_insert (MetricSection* section);
 442
 443         void add_tempo_locked (const Tempo&, double where, bool recompute, TempoSection::Type type);
 444         void add_tempo_locked (const Tempo&, framepos_t frame, bool recompute, TempoSection::Type type);
 445
 446         void add_meter_locked (const Meter&, double beat, Timecode::BBT_Time where, bool recompute);
 447         void add_meter_locked (const Meter&, framepos_t frame, bool recompute);
 448
 449         bool remove_tempo_locked (const TempoSection&);
 450         bool remove_meter_locked (const MeterSection&);
 451
 452 };
 453
 454 }; /* namespace ARDOUR */
 455
 456 std::ostream& operator<< (std::ostream&, const ARDOUR::Meter&);
 457 std::ostream& operator<< (std::ostream&, const ARDOUR::Tempo&);
 458 std::ostream& operator<< (std::ostream&, const ARDOUR::MetricSection&);
 459
 460 #endif /* __ardour_tempo_h__ */