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