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, double beat, framecnt_t frame_rate) const;
 187
 188         double tempo_at_beat (double beat) const;
 189         double beat_at_tempo (double tempo, framepos_t frame, 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         double tick_at_frame (framepos_t frame, framecnt_t frame_rate) const;
 195         framepos_t frame_at_tick (double tick, framecnt_t frame_rate) const;
 196
 197         void set_c_func_from_tempo_and_beat (double end_bpm, double end_beat, framecnt_t frame_rate);
 198         double compute_c_func (double end_bpm, framepos_t end_frame, framecnt_t frame_rate) const;
 199
 200         double get_c_func () const { return _c_func; }
 201         void set_c_func (double c_func) { _c_func = c_func; }
 202
 203         Timecode::BBT_Time legacy_bbt () { return _legacy_bbt; }
 204
 205   private:
 206
 207         framecnt_t minute_to_frame (double time, framecnt_t frame_rate) const;
 208         double frame_to_minute (framecnt_t frame, framecnt_t frame_rate) const;
 209
 210         /*  tempo ramp functions. zero-based with time in minutes,
 211          * 'tick tempo' in ticks per minute and tempo in bpm.
 212          *  time relative to section start.
 213          */
 214         double a_func (double end_tpm, double c_func) const;
 215         double c_func (double end_tpm, double end_time) const;
 216
 217         double tick_tempo_at_time (double time) const;
 218         double time_at_tick_tempo (double tick_tempo) const;
 219
 220         double tick_tempo_at_tick (double tick) const;
 221         double tick_at_tick_tempo (double tick_tempo) const;
 222
 223         double tick_at_time (double time) const;
 224         double time_at_tick (double tick) const;
 225
 226         double beat_at_time (double time) const;
 227         double time_at_beat (double beat) const;
 228
 229         /* this value provides a fractional offset into the bar in which
 230            the tempo section is located in. A value of 0.0 indicates that
 231            it occurs on the first beat of the bar, a value of 0.5 indicates
 232            that it occurs halfway through the bar and so on.
 233
 234            this enables us to keep the tempo change at the same relative
 235            position within the bar if/when the meter changes.
 236         */
 237         double _bar_offset;
 238         Type _type;
 239         double _c_func;
 240         Timecode::BBT_Time _legacy_bbt;
 241 };
 242
 243 typedef std::list<MetricSection*> Metrics;
 244
 245 /** Helper class to keep track of the Meter *AND* Tempo in effect
 246     at a given point in time.
 247 */
 248 class LIBARDOUR_API TempoMetric {
 249   public:
 250         TempoMetric (const Meter& m, const Tempo& t)
 251                 : _meter (&m), _tempo (&t), _frame (0) {}
 252
 253         void set_tempo (const Tempo& t)              { _tempo = &t; }
 254         void set_meter (const Meter& m)              { _meter = &m; }
 255         void set_frame (framepos_t f)                { _frame = f; }
 256         void set_beat (const double& t)              { _beat = t; }
 257
 258         void set_metric (const MetricSection* section) {
 259                 const MeterSection* meter;
 260                 const TempoSection* tempo;
 261                 if ((meter = dynamic_cast<const MeterSection*>(section))) {
 262                         set_meter(*meter);
 263                 } else if ((tempo = dynamic_cast<const TempoSection*>(section))) {
 264                         set_tempo(*tempo);
 265                 }
 266
 267                 set_frame(section->frame());
 268                 set_beat(section->beat());
 269         }
 270
 271         const Meter&              meter() const { return *_meter; }
 272         const Tempo&              tempo() const { return *_tempo; }
 273         framepos_t                frame() const { return _frame; }
 274         const double&             beat() const { return _beat; }
 275
 276   private:
 277         const Meter*       _meter;
 278         const Tempo*       _tempo;
 279         framepos_t         _frame;
 280         double             _beat;
 281 };
 282
 283 /** Tempo Map - mapping of timecode to musical time.
 284  * convert audio-samples, sample-rate to Bar/Beat/Tick, Meter/Tempo
 285  */
 286 class LIBARDOUR_API TempoMap : public PBD::StatefulDestructible
 287 {
 288   public:
 289         TempoMap (framecnt_t frame_rate);
 290         ~TempoMap();
 291
 292         /* measure-based stuff */
 293
 294         enum BBTPointType {
 295                 Bar,
 296                 Beat,
 297         };
 298
 299         struct BBTPoint {
 300                 framepos_t          frame;
 301                 const MeterSection* meter;
 302                 const Tempo* tempo;
 303                 uint32_t            bar;
 304                 uint32_t            beat;
 305
 306                 BBTPoint (const MeterSection& m, const Tempo& t, framepos_t f,
 307                           uint32_t b, uint32_t e)
 308                         : frame (f), meter (&m), tempo (&t), bar (b), beat (e) {}
 309
 310                 Timecode::BBT_Time bbt() const { return Timecode::BBT_Time (bar, beat, 0); }
 311                 operator Timecode::BBT_Time() const { return bbt(); }
 312                 operator framepos_t() const { return frame; }
 313                 bool is_bar() const { return beat == 1; }
 314         };
 315
 316         template<class T> void apply_with_metrics (T& obj, void (T::*method)(const Metrics&)) {
 317                 Glib::Threads::RWLock::ReaderLock lm (lock);
 318                 (obj.*method)(metrics);
 319         }
 320
 321         void get_grid (std::vector<BBTPoint>&,
 322                        framepos_t start, framepos_t end);
 323
 324         /* TEMPO- AND METER-SENSITIVE FUNCTIONS
 325
 326            bbt_time(), beat_at_frame(), frame_at_beat(), tick_at_frame(),
 327            frame_at_tick(),frame_time() and bbt_duration_at()
 328            are all sensitive to tempo and meter, and will give answers
 329            that align with the grid formed by tempo and meter sections.
 330
 331            They SHOULD NOT be used to determine the position of events
 332            whose location is canonically defined in beats.
 333         */
 334
 335         void bbt_time (framepos_t when, Timecode::BBT_Time&);
 336
 337         double beat_at_frame (framecnt_t frame) const;
 338         framecnt_t frame_at_beat (double beat) const;
 339
 340         framepos_t frame_time (const Timecode::BBT_Time&);
 341         framecnt_t bbt_duration_at (framepos_t, const Timecode::BBT_Time&, int dir);
 342
 343         /* TEMPO-SENSITIVE FUNCTIONS
 344
 345            These next 4 functions will all take tempo in account and should be
 346            used to determine position (and in the last case, distance in beats)
 347            when tempo matters but meter does not.
 348
 349            They SHOULD be used to determine the position of events
 350            whose location is canonically defined in beats.
 351         */
 352
 353         framepos_t framepos_plus_bbt (framepos_t pos, Timecode::BBT_Time b) const;
 354         framepos_t framepos_plus_beats (framepos_t, Evoral::Beats) const;
 355         framepos_t framepos_minus_beats (framepos_t, Evoral::Beats) const;
 356         Evoral::Beats framewalk_to_beats (framepos_t pos, framecnt_t distance) const;
 357
 358         static const Tempo& default_tempo() { return _default_tempo; }
 359         static const Meter& default_meter() { return _default_meter; }
 360
 361         const Tempo tempo_at (framepos_t) const;
 362         double frames_per_beat_at (framepos_t, framecnt_t sr) const;
 363
 364         const Meter& meter_at (framepos_t) const;
 365
 366         const TempoSection& tempo_section_at (framepos_t) const;
 367         const MeterSection& meter_section_at (framepos_t) const;
 368
 369         void add_tempo (const Tempo&, double where, TempoSection::Type type);
 370         void add_tempo (const Tempo&, framepos_t frame, TempoSection::Type type);
 371
 372         void add_meter (const Meter&, double beat, Timecode::BBT_Time where);
 373         void add_meter (const Meter&, framepos_t frame);
 374
 375         void remove_tempo (const TempoSection&, bool send_signal);
 376         void remove_meter (const MeterSection&, bool send_signal);
 377
 378         framepos_t compute_new_tempo_frame (TempoSection* section, const Tempo& bpm, const double& beat);
 379
 380         void replace_tempo (const TempoSection&, const Tempo&, const double& where, TempoSection::Type type);
 381         void replace_tempo (const TempoSection&, const Tempo&, const framepos_t& frame, TempoSection::Type type);
 382
 383         void gui_move_tempo (TempoSection*, const Tempo& bpm, const framepos_t& frame);
 384         void gui_move_meter (MeterSection*, const Meter& mt, const framepos_t& frame);
 385
 386         void replace_meter (const MeterSection&, const Meter&, const Timecode::BBT_Time& where);
 387         void replace_meter (const MeterSection&, const Meter&, const framepos_t& frame);
 388
 389         framepos_t round_to_bar  (framepos_t frame, RoundMode dir);
 390         framepos_t round_to_beat (framepos_t frame, RoundMode dir);
 391         framepos_t round_to_beat_subdivision (framepos_t fr, int sub_num, RoundMode dir);
 392
 393         void set_length (framepos_t frames);
 394
 395         XMLNode& get_state (void);
 396         int set_state (const XMLNode&, int version);
 397
 398         void dump (std::ostream&) const;
 399         void clear ();
 400
 401         TempoMetric metric_at (Timecode::BBT_Time bbt) const;
 402
 403         /** Return the TempoMetric at frame @p t, and point @p last to the latest
 404          * metric change <= t, if it is non-NULL.
 405          */
 406         TempoMetric metric_at (framepos_t, Metrics::const_iterator* last=NULL) const;
 407
 408         Metrics::const_iterator metrics_end() { return metrics.end(); }
 409
 410         void change_existing_tempo_at (framepos_t, double bpm, double note_type);
 411         void change_initial_tempo (double bpm, double note_type);
 412
 413         void insert_time (framepos_t, framecnt_t);
 414         bool remove_time (framepos_t where, framecnt_t amount);  //returns true if anything was moved
 415
 416         int n_tempos () const;
 417         int n_meters () const;
 418
 419         framecnt_t frame_rate () const { return _frame_rate; }
 420
 421         PBD::Signal0<void> MetricPositionChanged;
 422
 423         double bbt_to_beats (Timecode::BBT_Time bbt);
 424         Timecode::BBT_Time beats_to_bbt (double beats);
 425
 426 private:
 427         double bbt_to_beats_locked (Timecode::BBT_Time bbt);
 428         Timecode::BBT_Time beats_to_bbt_locked (double beats);
 429         double beat_at_frame_locked (framecnt_t frame) const;
 430         framecnt_t frame_at_beat_locked (double beat) const;
 431         double tick_at_frame_locked (framecnt_t frame) const;
 432         framecnt_t frame_at_tick_locked (double tick) const;
 433         framepos_t frame_time_locked (const Timecode::BBT_Time&);
 434
 435         Metrics get_new_order (TempoSection* section, const Tempo& bpm, const framepos_t& frame);
 436         Metrics get_new_order (TempoSection* section, const Tempo& bpm, const double& beat);
 437         Metrics get_new_order (MeterSection* section, const Meter& mt, const framepos_t& frame);
 438         Metrics get_new_order (MeterSection* section, const Meter& mt, const double& beat);
 439
 440         friend class ::BBTTest;
 441         friend class ::FrameposPlusBeatsTest;
 442         friend class ::TempoTest;
 443
 444         static Tempo    _default_tempo;
 445         static Meter    _default_meter;
 446
 447         Metrics                       metrics;
 448         framecnt_t                    _frame_rate;
 449         mutable Glib::Threads::RWLock lock;
 450
 451         void recompute_tempos ();
 452         void recompute_meters ();
 453         void recompute_map (bool reassign_tempo_bbt, framepos_t end = -1);
 454
 455         framepos_t round_to_type (framepos_t fr, RoundMode dir, BBTPointType);
 456
 457         const MeterSection& first_meter() const;
 458         MeterSection&       first_meter();
 459         const TempoSection& first_tempo() const;
 460         TempoSection&       first_tempo();
 461
 462         void do_insert (MetricSection* section);
 463
 464         void add_tempo_locked (const Tempo&, double where, bool recompute, TempoSection::Type type);
 465         void add_tempo_locked (const Tempo&, framepos_t frame, bool recompute, TempoSection::Type type);
 466
 467         void add_meter_locked (const Meter&, double beat, Timecode::BBT_Time where, bool recompute);
 468         void add_meter_locked (const Meter&, framepos_t frame, bool recompute);
 469
 470         bool remove_tempo_locked (const TempoSection&);
 471         bool remove_meter_locked (const MeterSection&);
 472
 473 };
 474
 475 }; /* namespace ARDOUR */
 476
 477 std::ostream& operator<< (std::ostream&, const ARDOUR::Meter&);
 478 std::ostream& operator<< (std::ostream&, const ARDOUR::Tempo&);
 479 std::ostream& operator<< (std::ostream&, const ARDOUR::MetricSection&);
 480
 481 #endif /* __ardour_tempo_h__ */