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