2 Copyright (C) 2000 Paul Davis
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.
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.
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.
21 #ifndef __ardour_tempo_h__
22 #define __ardour_tempo_h__
28 #include <glibmm/thread.h>
31 #include <pbd/stateful.h>
32 #include <pbd/statefuldestructible.h>
34 #include <sigc++/signal.h>
36 #include <ardour/ardour.h>
37 #include <ardour/state_manager.h>
49 : _beats_per_minute (bpm) {}
50 Tempo (const Tempo& other) {
51 _beats_per_minute = other._beats_per_minute;
53 void operator= (const Tempo& other) {
55 _beats_per_minute = other._beats_per_minute;
59 double beats_per_minute () const { return _beats_per_minute; }
60 double frames_per_beat (jack_nframes_t sr) const {
61 return ((60.0 * sr) / _beats_per_minute);
65 double _beats_per_minute;
70 static const double ticks_per_beat;
72 Meter (double bpb, double bt)
73 : _beats_per_bar (bpb), _note_type (bt) {}
74 Meter (const Meter& other) {
75 _beats_per_bar = other._beats_per_bar;
76 _note_type = other._note_type;
78 void operator= (const Meter& other) {
80 _beats_per_bar = other._beats_per_bar;
81 _note_type = other._note_type;
85 double beats_per_bar () const { return _beats_per_bar; }
86 double note_divisor() const { return _note_type; }
88 double frames_per_bar (const Tempo&, jack_nframes_t sr) const;
92 /* this is the number of beats in a bar. it is a real value
93 because there are musical traditions on our planet
94 that do not limit themselves to integral numbers of beats
98 double _beats_per_bar;
100 /* this is the type of "note" that a beat represents. for example,
101 4.0 would be a quarter (crotchet) note, 8.0 would be an eighth
108 class MetricSection {
110 MetricSection (const BBT_Time& start)
111 : _start (start), _frame (0), _movable (true) {}
112 virtual ~MetricSection() {}
114 const BBT_Time& start() const { return _start; }
115 const jack_nframes_t frame() const { return _frame; }
117 void set_movable (bool yn) { _movable = yn; }
118 bool movable() const { return _movable; }
120 virtual void set_frame (jack_nframes_t f) {
124 virtual void set_start (const BBT_Time& w) {
128 /* MeterSections are not stateful in the full sense,
129 but we do want them to control their own
130 XML state information.
133 virtual XMLNode& get_state() const = 0;
137 jack_nframes_t _frame;
141 class MeterSection : public MetricSection, public Meter {
143 MeterSection (const BBT_Time& start, double bpb, double note_type)
144 : MetricSection (start), Meter (bpb, note_type) {}
145 MeterSection (const XMLNode&);
147 static const string xml_state_node_name;
149 XMLNode& get_state() const;
152 class TempoSection : public MetricSection, public Tempo {
154 TempoSection (const BBT_Time& start, double qpm)
155 : MetricSection (start), Tempo (qpm) {}
156 TempoSection (const XMLNode&);
158 static const string xml_state_node_name;
160 XMLNode& get_state() const;
163 typedef list<MetricSection*> Metrics;
165 class TempoMapState : public StateManager::State {
167 TempoMapState (std::string why)
168 : StateManager::State (why) {
169 metrics = new Metrics;
175 class TempoMap : public StateManager, public PBD::StatefulDestructible
179 TempoMap (jack_nframes_t frame_rate);
182 /* measure-based stuff */
191 jack_nframes_t frame;
197 BBTPoint (const Meter& m, const Tempo& t, jack_nframes_t f, BBTPointType ty, uint32_t b, uint32_t e)
198 : type (ty), frame (f), meter (&m), tempo (&t), bar (b), beat (e) {}
201 typedef vector<BBTPoint> BBTPointList;
203 template<class T> void apply_with_metrics (T& obj, void (T::*method)(const Metrics&)) {
204 Glib::Mutex::Lock lm (lock);
205 (obj.*method)(*metrics);
208 BBTPointList *get_points (jack_nframes_t start, jack_nframes_t end) const;
210 void bbt_time (jack_nframes_t when, BBT_Time&) const;
211 jack_nframes_t frame_time (const BBT_Time&) const;
212 jack_nframes_t bbt_duration_at (jack_nframes_t, const BBT_Time&, int dir) const;
214 static const Tempo& default_tempo() { return _default_tempo; }
215 static const Meter& default_meter() { return _default_meter; }
217 const Tempo& tempo_at (jack_nframes_t);
218 const Meter& meter_at (jack_nframes_t);
220 void add_tempo(const Tempo&, BBT_Time where);
221 void add_meter(const Meter&, BBT_Time where);
223 void move_tempo (TempoSection&, const BBT_Time& to);
224 void move_meter (MeterSection&, const BBT_Time& to);
226 void remove_tempo(const TempoSection&);
227 void remove_meter(const MeterSection&);
229 void replace_tempo (TempoSection& existing, const Tempo& replacement);
230 void replace_meter (MeterSection& existing, const Meter& replacement);
233 jack_nframes_t round_to_bar (jack_nframes_t frame, int dir);
235 jack_nframes_t round_to_beat (jack_nframes_t frame, int dir);
237 jack_nframes_t round_to_beat_subdivision (jack_nframes_t fr, int sub_num);
239 jack_nframes_t round_to_tick (jack_nframes_t frame, int dir);
241 void set_length (jack_nframes_t frames);
243 XMLNode& get_state (void);
244 int set_state (const XMLNode&);
245 PBD::ID id() { return _id; }
247 void dump (std::ostream&) const;
250 UndoAction get_memento() const;
252 /* this is a helper class that we use to be able to keep
253 track of which meter *AND* tempo are in effect at
254 a given point in time.
259 Metric (const Meter& m, const Tempo& t) : _meter (&m), _tempo (&t), _frame (0) {}
261 void set_tempo (const Tempo& t) { _tempo = &t; }
262 void set_meter (const Meter& m) { _meter = &m; }
263 void set_frame (jack_nframes_t f) { _frame = f; }
264 void set_start (const BBT_Time& t) { _start = t; }
266 const Meter& meter() const { return *_meter; }
267 const Tempo& tempo() const { return *_tempo; }
268 jack_nframes_t frame() const { return _frame; }
269 const BBT_Time& start() const { return _start; }
274 jack_nframes_t _frame;
279 Metric metric_at (BBT_Time bbt) const;
280 Metric metric_at (jack_nframes_t) const;
281 void bbt_time_with_metric (jack_nframes_t, BBT_Time&, const Metric&) const;
284 static Tempo _default_tempo;
285 static Meter _default_meter;
288 jack_nframes_t _frame_rate;
289 jack_nframes_t last_bbt_when;
292 mutable Glib::Mutex lock;
294 void timestamp_metrics ();
297 jack_nframes_t round_to_type (jack_nframes_t fr, int dir, BBTPointType);
299 jack_nframes_t frame_time_unlocked (const BBT_Time&) const;
301 void bbt_time_unlocked (jack_nframes_t, BBT_Time&) const;
303 jack_nframes_t bbt_duration_at_unlocked (const BBT_Time& when, const BBT_Time& bbt, int dir) const;
305 const MeterSection& first_meter() const;
306 const TempoSection& first_tempo() const;
308 jack_nframes_t count_frames_between (const BBT_Time&, const BBT_Time&) const;
309 jack_nframes_t count_frames_between_metrics (const Meter&, const Tempo&, const BBT_Time&, const BBT_Time&) const;
311 int move_metric_section (MetricSection&, const BBT_Time& to);
312 void do_insert (MetricSection* section);
314 Change restore_state (StateManager::State&);
315 StateManager::State* state_factory (std::string why) const;
319 /* override state_manager::save_state so we can check in_set_state */
321 void save_state (std::string why);
327 }; /* namespace ARDOUR */
329 #endif /* __ardour_tempo_h__ */