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