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