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 (MusicTime) {}
 104         MetricSection (framepos_t frame)
 105                 : _beat (0), _frame (frame), _movable (true), _position_lock_style (MusicTime) {}
 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         framecnt_t ramp_duration_from_tempo_and_beat (double end_tpm, double end_beat, framecnt_t frame_rate);
 194
 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 tick_at_frame (framecnt_t frame) const;
 331         framecnt_t frame_at_tick (double tick) const;
 332
 333         double beat_at_frame (framecnt_t frame) const;
 334         framecnt_t frame_at_beat (double beat) const;
 335
 336         framepos_t frame_time (const Timecode::BBT_Time&);
 337         framecnt_t bbt_duration_at (framepos_t, const Timecode::BBT_Time&, int dir);
 338
 339         /* TEMPO-SENSITIVE FUNCTIONS
 340
 341            These next 4 functions will all take tempo in account and should be
 342            used to determine position (and in the last case, distance in beats)
 343            when tempo matters but meter does not.
 344
 345            They SHOULD be used to determine the position of events
 346            whose location is canonically defined in beats.
 347         */
 348
 349         framepos_t framepos_plus_bbt (framepos_t pos, Timecode::BBT_Time b) const;
 350         framepos_t framepos_plus_beats (framepos_t, Evoral::Beats) const;
 351         framepos_t framepos_minus_beats (framepos_t, Evoral::Beats) const;
 352         Evoral::Beats framewalk_to_beats (framepos_t pos, framecnt_t distance) const;
 353
 354         static const Tempo& default_tempo() { return _default_tempo; }
 355         static const Meter& default_meter() { return _default_meter; }
 356
 357         const Tempo tempo_at (framepos_t) const;
 358         double frames_per_beat_at (framepos_t, framecnt_t sr) const;
 359
 360         const Meter& meter_at (framepos_t) const;
 361
 362         const TempoSection& tempo_section_at (framepos_t) const;
 363         const MeterSection& meter_section_at (framepos_t) const;
 364
 365         void add_tempo (const Tempo&, double where, TempoSection::Type type);
 366         void add_meter (const Meter&, double beat, Timecode::BBT_Time where);
 367
 368         void remove_tempo (const TempoSection&, bool send_signal);
 369         void remove_meter (const MeterSection&, bool send_signal);
 370
 371         void replace_tempo (const TempoSection&, const Tempo&, const double& where, TempoSection::Type type);
 372         void gui_set_tempo_frame (TempoSection&, framepos_t where, double beat);
 373         void replace_meter (const MeterSection&, const Meter&, const Timecode::BBT_Time& where);
 374
 375         framepos_t round_to_bar  (framepos_t frame, RoundMode dir);
 376         framepos_t round_to_beat (framepos_t frame, RoundMode dir);
 377         framepos_t round_to_beat_subdivision (framepos_t fr, int sub_num, RoundMode dir);
 378
 379         void set_length (framepos_t frames);
 380
 381         XMLNode& get_state (void);
 382         int set_state (const XMLNode&, int version);
 383
 384         void dump (std::ostream&) const;
 385         void clear ();
 386
 387         TempoMetric metric_at (Timecode::BBT_Time bbt) const;
 388
 389         /** Return the TempoMetric at frame @p t, and point @p last to the latest
 390          * metric change <= t, if it is non-NULL.
 391          */
 392         TempoMetric metric_at (framepos_t, Metrics::const_iterator* last=NULL) const;
 393
 394         Metrics::const_iterator metrics_end() { return metrics.end(); }
 395
 396         void change_existing_tempo_at (framepos_t, double bpm, double note_type);
 397         void change_initial_tempo (double bpm, double note_type);
 398
 399         void insert_time (framepos_t, framecnt_t);
 400         bool remove_time (framepos_t where, framecnt_t amount);  //returns true if anything was moved
 401
 402         int n_tempos () const;
 403         int n_meters () const;
 404
 405         framecnt_t frame_rate () const { return _frame_rate; }
 406
 407         PBD::Signal0<void> MetricPositionChanged;
 408
 409         double bbt_to_beats (Timecode::BBT_Time bbt);
 410         Timecode::BBT_Time beats_to_bbt (double beats);
 411
 412 private:
 413         double bbt_to_beats_locked (Timecode::BBT_Time bbt);
 414         Timecode::BBT_Time beats_to_bbt_locked (double beats);
 415
 416         friend class ::BBTTest;
 417         friend class ::FrameposPlusBeatsTest;
 418         friend class ::TempoTest;
 419
 420         static Tempo    _default_tempo;
 421         static Meter    _default_meter;
 422
 423         Metrics                       metrics;
 424         framecnt_t                    _frame_rate;
 425         mutable Glib::Threads::RWLock lock;
 426
 427         void recompute_map (bool reassign_tempo_bbt, framepos_t end = -1);
 428
 429         framepos_t round_to_type (framepos_t fr, RoundMode dir, BBTPointType);
 430
 431         const MeterSection& first_meter() const;
 432         MeterSection&       first_meter();
 433         const TempoSection& first_tempo() const;
 434         TempoSection&       first_tempo();
 435
 436         void do_insert (MetricSection* section);
 437
 438         void add_tempo_locked (const Tempo&, double where, bool recompute, TempoSection::Type type);
 439         void add_meter_locked (const Meter&, double beat, Timecode::BBT_Time where, bool recompute);
 440
 441         bool remove_tempo_locked (const TempoSection&);
 442         bool remove_meter_locked (const MeterSection&);
 443
 444 };
 445
 446 }; /* namespace ARDOUR */
 447
 448 std::ostream& operator<< (std::ostream&, const ARDOUR::Meter&);
 449 std::ostream& operator<< (std::ostream&, const ARDOUR::Tempo&);
 450 std::ostream& operator<< (std::ostream&, const ARDOUR::MetricSection&);
 451
 452 #endif /* __ardour_tempo_h__ */