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/thread.h>
  28
  29 #include "pbd/undo.h"
  30 #include "pbd/stateful.h"
  31 #include "pbd/statefuldestructible.h"
  32
  33 #include "evoral/types.hpp"
  34
  35 #include "ardour/ardour.h"
  36
  37 class XMLNode;
  38
  39 namespace ARDOUR {
  40
  41 class Meter;
  42 class TempoMap;
  43
  44 class Tempo {
  45   public:
  46         Tempo (double bpm, double type=4.0) // defaulting to quarter note
  47                 : _beats_per_minute (bpm), _note_type(type) {}
  48
  49         double beats_per_minute () const { return _beats_per_minute;}
  50         double note_type () const { return _note_type;}
  51         double frames_per_beat (framecnt_t sr) const;
  52
  53   protected:
  54         double _beats_per_minute;
  55         double _note_type;
  56 };
  57
  58 class Meter {
  59   public:
  60         Meter (double dpb, double bt)
  61                 : _divisions_per_bar (dpb), _note_type (bt) {}
  62
  63         double divisions_per_bar () const { return _divisions_per_bar; }
  64         double note_divisor() const { return _note_type; }
  65
  66         double frames_per_bar (const Tempo&, framecnt_t sr) const;
  67         double frames_per_division (const Tempo&, framecnt_t sr) const;
  68
  69   protected:
  70         /** The number of divisions in a bar.  This is a floating point value because
  71             there are musical traditions on our planet that do not limit
  72             themselves to integral numbers of beats per bar.
  73         */
  74         double _divisions_per_bar;
  75
  76         /** The type of "note" that a division represents.  For example, 4.0 is
  77             a quarter (crotchet) note, 8.0 is an eighth (quaver) note, etc.
  78         */
  79         double _note_type;
  80 };
  81
  82 class MetricSection {
  83   public:
  84         MetricSection (const Timecode::BBT_Time& start)
  85                 : _start (start), _frame (0), _movable (true) {}
  86         MetricSection (framepos_t start)
  87                 : _frame (start), _movable (true) {}
  88
  89         virtual ~MetricSection() {}
  90
  91         const Timecode::BBT_Time& start() const { return _start; }
  92         framepos_t                frame() const { return _frame; }
  93
  94         void set_movable (bool yn) { _movable = yn; }
  95         bool movable() const { return _movable; }
  96
  97         virtual void set_frame (framepos_t f) {
  98                 _frame = f;
  99         }
 100
 101         virtual void set_start (const Timecode::BBT_Time& w) {
 102                 _start = w;
 103         }
 104
 105         /* MeterSections are not stateful in the full sense,
 106            but we do want them to control their own
 107            XML state information.
 108         */
 109         virtual XMLNode& get_state() const = 0;
 110
 111         int compare (const MetricSection&) const;
 112         bool operator== (const MetricSection& other) const;
 113         bool operator!= (const MetricSection& other) const;
 114
 115   private:
 116         Timecode::BBT_Time _start;
 117         framepos_t         _frame;
 118         bool               _movable;
 119 };
 120
 121 class MeterSection : public MetricSection, public Meter {
 122   public:
 123         MeterSection (const Timecode::BBT_Time& start, double bpb, double note_type)
 124                 : MetricSection (start), Meter (bpb, note_type) {}
 125         MeterSection (framepos_t start, double bpb, double note_type)
 126                 : MetricSection (start), Meter (bpb, note_type) {}
 127         MeterSection (const XMLNode&);
 128
 129         static const std::string xml_state_node_name;
 130
 131         XMLNode& get_state() const;
 132 };
 133
 134 class TempoSection : public MetricSection, public Tempo {
 135   public:
 136         TempoSection (const Timecode::BBT_Time& start, double qpm, double note_type)
 137                 : MetricSection (start), Tempo (qpm, note_type), _bar_offset (-1.0)  {}
 138         TempoSection (framepos_t start, double qpm, double note_type)
 139                 : MetricSection (start), Tempo (qpm, note_type), _bar_offset (-1.0) {}
 140         TempoSection (const XMLNode&);
 141
 142         static const std::string xml_state_node_name;
 143
 144         XMLNode& get_state() const;
 145
 146         void update_bar_offset_from_bbt (const Meter&);
 147         void update_bbt_time_from_bar_offset (const Meter&);
 148         double bar_offset() const { return _bar_offset; }
 149
 150   private:
 151         /* this value provides a fractional offset into the bar in which
 152            the tempo section is located in. A value of 0.0 indicates that
 153            it occurs on the first beat of the bar, a value of 0.5 indicates
 154            that it occurs halfway through the bar and so on.
 155
 156            this enables us to keep the tempo change at the same relative
 157            position within the bar if/when the meter changes.
 158         */
 159         double _bar_offset;
 160 };
 161
 162 typedef std::list<MetricSection*> Metrics;
 163
 164 /** Helper class that we use to be able to keep track of which
 165     meter *AND* tempo are in effect at a given point in time.
 166 */
 167 class TempoMetric {
 168   public:
 169         TempoMetric (const Meter& m, const Tempo& t) : _meter (&m), _tempo (&t), _frame (0) {}
 170
 171         void set_tempo (const Tempo& t)    { _tempo = &t; }
 172         void set_meter (const Meter& m)    { _meter = &m; }
 173         void set_frame (framepos_t f)      { _frame = f; }
 174         void set_start (const Timecode::BBT_Time& t) { _start = t; }
 175
 176         const Meter&    meter() const { return *_meter; }
 177         const Tempo&    tempo() const { return *_tempo; }
 178         framepos_t      frame() const { return _frame; }
 179         const Timecode::BBT_Time& start() const { return _start; }
 180
 181   private:
 182         const Meter*       _meter;
 183         const Tempo*       _tempo;
 184         framepos_t         _frame;
 185         Timecode::BBT_Time _start;
 186 };
 187
 188 class TempoMap : public PBD::StatefulDestructible
 189 {
 190   public:
 191         TempoMap (framecnt_t frame_rate);
 192         ~TempoMap();
 193
 194         /* measure-based stuff */
 195
 196         enum BBTPointType {
 197                 Bar,
 198                 Beat,
 199         };
 200
 201         struct BBTPoint {
 202                 BBTPointType type;
 203                 framepos_t  frame;
 204                 const Meter* meter;
 205                 const Tempo* tempo;
 206                 uint32_t bar;
 207                 uint32_t beat;
 208
 209                 BBTPoint (const Meter& m, const Tempo& t, framepos_t f,
 210                                 BBTPointType ty, uint32_t b, uint32_t e)
 211                         : type (ty), frame (f), meter (&m), tempo (&t), bar (b), beat (e) {}
 212         };
 213
 214         typedef std::vector<BBTPoint> BBTPointList;
 215
 216         template<class T> void apply_with_metrics (T& obj, void (T::*method)(const Metrics&)) {
 217                 Glib::RWLock::ReaderLock lm (lock);
 218                 (obj.*method)(*metrics);
 219         }
 220
 221         BBTPointList *get_points (framepos_t start, framepos_t end) const;
 222
 223         void      bbt_time (framepos_t when, Timecode::BBT_Time&) const;
 224         framecnt_t frame_time (const Timecode::BBT_Time&) const;
 225         framecnt_t bbt_duration_at (framepos_t, const Timecode::BBT_Time&, int dir) const;
 226
 227         static const Tempo& default_tempo() { return _default_tempo; }
 228         static const Meter& default_meter() { return _default_meter; }
 229
 230         const Tempo& tempo_at (framepos_t) const;
 231         const Meter& meter_at (framepos_t) const;
 232
 233         const TempoSection& tempo_section_at (framepos_t) const;
 234
 235         void add_tempo(const Tempo&, Timecode::BBT_Time where);
 236         void add_meter(const Meter&, Timecode::BBT_Time where);
 237
 238         void remove_tempo(const TempoSection&, bool send_signal);
 239         void remove_meter(const MeterSection&, bool send_signal);
 240
 241         void replace_tempo (const TempoSection&, const Tempo&, const Timecode::BBT_Time& where);
 242         void replace_meter (const MeterSection&, const Meter&, const Timecode::BBT_Time& where);
 243
 244         framepos_t round_to_bar  (framepos_t frame, int dir);
 245         framepos_t round_to_beat (framepos_t frame, int dir);
 246         framepos_t round_to_beat_subdivision (framepos_t fr, int sub_num, int dir);
 247         framepos_t round_to_tick (framepos_t frame, int dir);
 248
 249         void set_length (framepos_t frames);
 250
 251         XMLNode& get_state (void);
 252         int set_state (const XMLNode&, int version);
 253
 254         void dump (std::ostream&) const;
 255         void clear ();
 256
 257         TempoMetric metric_at (Timecode::BBT_Time bbt) const;
 258         TempoMetric metric_at (framepos_t) const;
 259         void bbt_time_with_metric (framepos_t, Timecode::BBT_Time&, const TempoMetric&) const;
 260
 261         Timecode::BBT_Time bbt_add (const Timecode::BBT_Time&, const Timecode::BBT_Time&, const TempoMetric&) const;
 262         Timecode::BBT_Time bbt_add (const Timecode::BBT_Time& a, const Timecode::BBT_Time& b) const;
 263         Timecode::BBT_Time bbt_subtract (const Timecode::BBT_Time&, const Timecode::BBT_Time&) const;
 264
 265         framepos_t framepos_plus_bbt (framepos_t pos, Timecode::BBT_Time b) const;
 266         framepos_t framepos_plus_beats (framepos_t, Evoral::MusicalTime) const;
 267         framepos_t framepos_minus_beats (framepos_t, Evoral::MusicalTime) const;
 268         Evoral::MusicalTime framewalk_to_beats (framepos_t pos, framecnt_t distance) const;
 269
 270         void change_existing_tempo_at (framepos_t, double bpm, double note_type);
 271         void change_initial_tempo (double bpm, double note_type);
 272
 273         void insert_time (framepos_t, framecnt_t);
 274
 275         int n_tempos () const;
 276         int n_meters () const;
 277
 278         framecnt_t frame_rate () const { return _frame_rate; }
 279
 280   private:
 281         static Tempo    _default_tempo;
 282         static Meter    _default_meter;
 283
 284         Metrics*             metrics;
 285         framecnt_t           _frame_rate;
 286         framepos_t           last_bbt_when;
 287         bool                 last_bbt_valid;
 288         Timecode::BBT_Time   last_bbt;
 289         mutable Glib::RWLock lock;
 290
 291         void timestamp_metrics (bool reassign_bar_references);
 292         void timestamp_metrics_from_audio_time ();
 293
 294         framepos_t round_to_type (framepos_t fr, int dir, BBTPointType);
 295
 296         framepos_t frame_time_unlocked (const Timecode::BBT_Time&) const;
 297
 298         void bbt_time_unlocked (framepos_t, Timecode::BBT_Time&) const;
 299
 300         framecnt_t bbt_duration_at_unlocked (const Timecode::BBT_Time& when, const Timecode::BBT_Time& bbt, int dir) const;
 301
 302         const MeterSection& first_meter() const;
 303         const TempoSection& first_tempo() const;
 304
 305         framecnt_t count_frames_between (const Timecode::BBT_Time&, const Timecode::BBT_Time&) const;
 306         framecnt_t count_frames_with_metrics (const TempoMetric&, const TempoMetric&, const Timecode::BBT_Time&, const Timecode::BBT_Time&) const;
 307         framecnt_t count_frames_between_metrics (const Meter& meter, const Tempo& tempo, const Timecode::BBT_Time& start, const Timecode::BBT_Time& end) const;
 308
 309         int move_metric_section (MetricSection&, const Timecode::BBT_Time& to);
 310         void do_insert (MetricSection* section);
 311 };
 312
 313 }; /* namespace ARDOUR */
 314
 315 std::ostream& operator<< (std::ostream&, const ARDOUR::Meter&);
 316 std::ostream& operator<< (std::ostream&, const ARDOUR::Tempo&);
 317 std::ostream& operator<< (std::ostream&, const ARDOUR::MetricSection&);
 318
 319 #endif /* __ardour_tempo_h__ */