Tempo ramps - fix more constructor confusion.
[ardour.git] / libs / ardour / tempo.cc
1 /*
2     Copyright (C) 2000-2002 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 #include <algorithm>
21 #include <stdexcept>
22 #include <cmath>
23
24 #include <unistd.h>
25
26 #include <glibmm/threads.h>
27
28 #include "pbd/enumwriter.h"
29 #include "pbd/xml++.h"
30 #include "evoral/Beats.hpp"
31
32 #include "ardour/debug.h"
33 #include "ardour/lmath.h"
34 #include "ardour/tempo.h"
35
36 #include "i18n.h"
37 #include <locale.h>
38
39 using namespace std;
40 using namespace ARDOUR;
41 using namespace PBD;
42
43 using Timecode::BBT_Time;
44
45 /* _default tempo is 4/4 qtr=120 */
46
47 Meter    TempoMap::_default_meter (4.0, 4.0);
48 Tempo    TempoMap::_default_tempo (120.0);
49
50 /***********************************************************************/
51
52 double
53 Meter::frames_per_grid (const Tempo& tempo, framecnt_t sr) const
54 {
55         /* This is tempo- and meter-sensitive. The number it returns
56            is based on the interval between any two lines in the
57            grid that is constructed from tempo and meter sections.
58
59            The return value IS NOT interpretable in terms of "beats".
60         */
61
62         return (60.0 * sr) / (tempo.beats_per_minute() * (_note_type/tempo.note_type()));
63 }
64
65 double
66 Meter::frames_per_bar (const Tempo& tempo, framecnt_t sr) const
67 {
68         return frames_per_grid (tempo, sr) * _divisions_per_bar;
69 }
70
71 /***********************************************************************/
72
73 const string TempoSection::xml_state_node_name = "Tempo";
74
75 TempoSection::TempoSection (const XMLNode& node)
76         : MetricSection (0.0)
77         , Tempo (TempoMap::default_tempo())
78         , _c_func (0.0)
79         , _active (true)
80 {
81         const XMLProperty *prop;
82         LocaleGuard lg;
83         BBT_Time bbt;
84         double pulse;
85         uint32_t frame;
86
87         _legacy_bbt = BBT_Time (0, 0, 0);
88
89         if ((prop = node.property ("start")) != 0) {
90                 if (sscanf (prop->value().c_str(), "%" PRIu32 "|%" PRIu32 "|%" PRIu32,
91                             &bbt.bars,
92                             &bbt.beats,
93                             &bbt.ticks) == 3) {
94                         /* legacy session - start used to be in bbt*/
95                         _legacy_bbt = bbt;
96                         pulse = -1.0;
97                         info << _("Legacy session detected. TempoSection XML node will be altered.") << endmsg;
98                 }
99         }
100
101         if ((prop = node.property ("pulse")) != 0) {
102                 if (sscanf (prop->value().c_str(), "%lf", &pulse) != 1) {
103                         error << _("TempoSection XML node has an illegal \"pulse\" value") << endmsg;
104                 }
105         }
106
107         set_pulse (pulse);
108
109         if ((prop = node.property ("frame")) != 0) {
110                 if (sscanf (prop->value().c_str(), "%" PRIu32, &frame) != 1) {
111                         error << _("TempoSection XML node has an illegal \"frame\" value") << endmsg;
112                 } else {
113                         set_frame (frame);
114                 }
115         }
116
117         if ((prop = node.property ("beats-per-minute")) == 0) {
118                 error << _("TempoSection XML node has no \"beats-per-minute\" property") << endmsg;
119                 throw failed_constructor();
120         }
121
122         if (sscanf (prop->value().c_str(), "%lf", &_beats_per_minute) != 1 || _beats_per_minute < 0.0) {
123                 error << _("TempoSection XML node has an illegal \"beats_per_minute\" value") << endmsg;
124                 throw failed_constructor();
125         }
126
127         if ((prop = node.property ("note-type")) == 0) {
128                 /* older session, make note type be quarter by default */
129                 _note_type = 4.0;
130         } else {
131                 if (sscanf (prop->value().c_str(), "%lf", &_note_type) != 1 || _note_type < 1.0) {
132                         error << _("TempoSection XML node has an illegal \"note-type\" value") << endmsg;
133                         throw failed_constructor();
134                 }
135         }
136
137         if ((prop = node.property ("movable")) == 0) {
138                 error << _("TempoSection XML node has no \"movable\" property") << endmsg;
139                 throw failed_constructor();
140         }
141
142         set_movable (string_is_affirmative (prop->value()));
143
144         if ((prop = node.property ("active")) == 0) {
145                 warning << _("TempoSection XML node has no \"active\" property") << endmsg;
146                 set_active(true);
147         } else {
148                 set_active (string_is_affirmative (prop->value()));
149         }
150
151         if ((prop = node.property ("tempo-type")) == 0) {
152                 _type = Constant;
153         } else {
154                 _type = Type (string_2_enum (prop->value(), _type));
155         }
156
157         if ((prop = node.property ("lock-style")) == 0) {
158                 if (movable()) {
159                         set_position_lock_style (MusicTime);
160                 } else {
161                         set_position_lock_style (AudioTime);
162                 }
163         } else {
164                 set_position_lock_style (PositionLockStyle (string_2_enum (prop->value(), position_lock_style())));
165         }
166 }
167
168 XMLNode&
169 TempoSection::get_state() const
170 {
171         XMLNode *root = new XMLNode (xml_state_node_name);
172         char buf[256];
173         LocaleGuard lg;
174
175         snprintf (buf, sizeof (buf), "%f", pulse());
176         root->add_property ("pulse", buf);
177         snprintf (buf, sizeof (buf), "%li", frame());
178         root->add_property ("frame", buf);
179         snprintf (buf, sizeof (buf), "%f", _beats_per_minute);
180         root->add_property ("beats-per-minute", buf);
181         snprintf (buf, sizeof (buf), "%f", _note_type);
182         root->add_property ("note-type", buf);
183         snprintf (buf, sizeof (buf), "%s", movable()?"yes":"no");
184         root->add_property ("movable", buf);
185         snprintf (buf, sizeof (buf), "%s", active()?"yes":"no");
186         root->add_property ("active", buf);
187         root->add_property ("tempo-type", enum_2_string (_type));
188         root->add_property ("lock-style", enum_2_string (position_lock_style()));
189
190         return *root;
191 }
192
193 void
194 TempoSection::set_type (Type type)
195 {
196         _type = type;
197 }
198
199 /** returns the tempo in whole pulses per minute at the zero-based (relative to session) frame.
200 */
201 double
202 TempoSection::tempo_at_frame (const framepos_t& f, const framecnt_t& frame_rate) const
203 {
204
205         if (_type == Constant || _c_func == 0.0) {
206                 return pulses_per_minute();
207         }
208
209         return pulse_tempo_at_time (frame_to_minute (f - frame(), frame_rate));
210 }
211
212 /** returns the zero-based frame (relative to session)
213    where the tempo in whole pulses per minute occurs in this section.
214    beat b is only used for constant tempos.
215    note that the tempo map may have multiple such values.
216 */
217 framepos_t
218 TempoSection::frame_at_tempo (const double& ppm, const double& b, const framecnt_t& frame_rate) const
219 {
220         if (_type == Constant || _c_func == 0.0) {
221                 return ((b - pulse())  * frames_per_pulse (frame_rate))  + frame();
222         }
223
224         return minute_to_frame (time_at_pulse_tempo (ppm), frame_rate) + frame();
225 }
226 /** returns the tempo in pulses per minute at the zero-based (relative to session) beat.
227 */
228 double
229 TempoSection::tempo_at_pulse (const double& p) const
230 {
231
232         if (_type == Constant || _c_func == 0.0) {
233                 return pulses_per_minute();
234         }
235         double const ppm = pulse_tempo_at_pulse (p - pulse());
236         return ppm;
237 }
238
239 /** returns the zero-based beat (relative to session)
240    where the tempo in whole pulses per minute occurs given frame f. frame f is only used for constant tempos.
241    note that the session tempo map may have multiple beats at a given tempo.
242 */
243 double
244 TempoSection::pulse_at_tempo (const double& ppm, const framepos_t& f, const framecnt_t& frame_rate) const
245 {
246         if (_type == Constant || _c_func == 0.0) {
247                 double const pulses = ((f - frame()) / frames_per_pulse (frame_rate)) + pulse();
248                 return  pulses;
249         }
250         return pulse_at_pulse_tempo (ppm) + pulse();
251 }
252
253 /** returns the zero-based pulse (relative to session origin)
254    where the zero-based frame (relative to session)
255    lies.
256 */
257 double
258 TempoSection::pulse_at_frame (const framepos_t& f, const framecnt_t& frame_rate) const
259 {
260         if (_type == Constant || _c_func == 0.0) {
261                 return ((f - frame()) / frames_per_pulse (frame_rate)) + pulse();
262         }
263
264         return pulse_at_time (frame_to_minute (f - frame(), frame_rate)) + pulse();
265 }
266
267 /** returns the zero-based frame (relative to session start frame)
268    where the zero-based pulse (relative to session start)
269    falls.
270 */
271
272 framepos_t
273 TempoSection::frame_at_pulse (const double& p, const framecnt_t& frame_rate) const
274 {
275         if (_type == Constant || _c_func == 0.0) {
276                 return (framepos_t) floor ((p - pulse()) * frames_per_pulse (frame_rate)) + frame();
277         }
278
279         return minute_to_frame (time_at_pulse (p - pulse()), frame_rate) + frame();
280 }
281
282 /*
283 Ramp Overview
284
285       |                     *
286 Tempo |                   *
287 Tt----|-----------------*|
288 Ta----|--------------|*  |
289       |            * |   |
290       |         *    |   |
291       |     *        |   |
292 T0----|*             |   |
293   *   |              |   |
294       _______________|___|____
295       time           a   t (next tempo)
296       [        c         ] defines c
297
298 Duration in beats at time a is the integral of some Tempo function.
299 In our case, the Tempo function (Tempo at time t) is
300 T(t) = T0(e^(ct))
301
302 with function constant
303 c = log(Ta/T0)/a
304 so
305 a = log(Ta/T0)/c
306
307 The integral over t of our Tempo function (the beat function, which is the duration in beats at some time t) is:
308 b(t) = T0(e^(ct) - 1) / c
309
310 To find the time t at beat duration b, we use the inverse function of the beat function (the time function) which can be shown to be:
311 t(b) = log((cb / T0) + 1) / c
312
313 The time t at which Tempo T occurs is a as above:
314 t(T) = log(T / T0) / c
315
316 The beat at which a Tempo T occurs is:
317 b(T) = (T - T0) / c
318
319 The Tempo at which beat b occurs is:
320 T(b) = b.c + T0
321
322 We define c for this tempo ramp by placing a new tempo section at some time t after this one.
323 Our problem is that we usually don't know t.
324 We almost always know the duration in beats between this and the new section, so we need to find c in terms of the beat function.
325 Where a = t (i.e. when a is equal to the time of the next tempo section), the beat function reveals:
326 t = b log (Ta / T0) / (T0 (e^(log (Ta / T0)) - 1))
327
328 By substituting our expanded t as a in the c function above, our problem is reduced to:
329 c = T0 (e^(log (Ta / T0)) - 1) / b
330
331 We can now store c for future time calculations.
332 If the following tempo section (the one that defines c in conjunction with this one)
333 is changed or moved, c is no longer valid.
334
335 The public methods are session-relative.
336
337 Most of this stuff is taken from this paper:
338
339 WHERE’S THE BEAT?
340 TOOLS FOR DYNAMIC TEMPO CALCULATIONS
341 Jan C. Schacher
342 Martin Neukom
343 Zurich University of Arts
344 Institute for Computer Music and Sound Technology
345
346 https://www.zhdk.ch/fileadmin/data_subsites/data_icst/Downloads/Timegrid/ICST_Tempopolyphony_ICMC07.pdf
347
348 */
349
350 /*
351   compute this ramp's function constant using the end tempo (in whole pulses per minute)
352   and duration (pulses into global start) of some later tempo section.
353 */
354 double
355 TempoSection::compute_c_func_pulse (const double& end_bpm, const double& end_pulse, const framecnt_t& frame_rate)
356 {
357         double const log_tempo_ratio = log (end_bpm / pulses_per_minute());
358         return pulses_per_minute() *  (expm1 (log_tempo_ratio)) / (end_pulse - pulse());
359 }
360
361 /* compute the function constant from some later tempo section, given tempo (whole pulses/min.) and distance (in frames) from session origin */
362 double
363 TempoSection::compute_c_func_frame (const double& end_bpm, const framepos_t& end_frame, const framecnt_t& frame_rate) const
364 {
365         return c_func (end_bpm, frame_to_minute (end_frame - frame(), frame_rate));
366 }
367
368 framecnt_t
369 TempoSection::minute_to_frame (const double& time, const framecnt_t& frame_rate) const
370 {
371         return (framecnt_t) floor ((time * 60.0 * frame_rate) + 0.5);
372 }
373
374 double
375 TempoSection::frame_to_minute (const framecnt_t& frame, const framecnt_t& frame_rate) const
376 {
377         return (frame / (double) frame_rate) / 60.0;
378 }
379
380 /* position function */
381 double
382 TempoSection::a_func (double end_bpm, double c_func) const
383 {
384         return log (end_bpm / pulses_per_minute()) /  c_func;
385 }
386
387 /*function constant*/
388 double
389 TempoSection::c_func (double end_bpm, double end_time) const
390 {
391         return log (end_bpm / pulses_per_minute()) /  end_time;
392 }
393
394 /* tempo in ppm at time in minutes */
395 double
396 TempoSection::pulse_tempo_at_time (const double& time) const
397 {
398         return exp (_c_func * time) * pulses_per_minute();
399 }
400
401 /* time in minutes at tempo in ppm */
402 double
403 TempoSection::time_at_pulse_tempo (const double& pulse_tempo) const
404 {
405         return log (pulse_tempo / pulses_per_minute()) / _c_func;
406 }
407
408 /* tick at tempo in ppm */
409 double
410 TempoSection::pulse_at_pulse_tempo (const double& pulse_tempo) const
411 {
412         return (pulse_tempo - pulses_per_minute()) / _c_func;
413 }
414
415 /* tempo in ppm at tick */
416 double
417 TempoSection::pulse_tempo_at_pulse (const double& pulse) const
418 {
419         return (pulse * _c_func) + pulses_per_minute();
420 }
421
422 /* pulse at time in minutes */
423 double
424 TempoSection::pulse_at_time (const double& time) const
425 {
426         return expm1 (_c_func * time) * (pulses_per_minute() / _c_func);
427 }
428
429 /* time in minutes at pulse */
430 double
431 TempoSection::time_at_pulse (const double& pulse) const
432 {
433         return log1p ((_c_func * pulse) / pulses_per_minute()) / _c_func;
434 }
435
436 /***********************************************************************/
437
438 const string MeterSection::xml_state_node_name = "Meter";
439
440 MeterSection::MeterSection (const XMLNode& node)
441         : MetricSection (0.0), Meter (TempoMap::default_meter())
442 {
443         XMLProperty const * prop;
444         BBT_Time start;
445         LocaleGuard lg;
446         const XMLProperty *prop;
447         BBT_Time bbt;
448         double pulse = 0.0;
449         double beat = 0.0;
450         framepos_t frame = 0;
451         pair<double, BBT_Time> start;
452
453         if ((prop = node.property ("start")) != 0) {
454                 if (sscanf (prop->value().c_str(), "%" PRIu32 "|%" PRIu32 "|%" PRIu32,
455                     &bbt.bars,
456                     &bbt.beats,
457                     &bbt.ticks) < 3) {
458                         error << _("MeterSection XML node has an illegal \"start\" value") << endmsg;
459                 } else {
460                         /* legacy session - start used to be in bbt*/
461                         info << _("Legacy session detected - MeterSection XML node will be altered.") << endmsg;
462                         pulse = -1.0;
463                 }
464         }
465
466         if ((prop = node.property ("pulse")) != 0) {
467                 if (sscanf (prop->value().c_str(), "%lf", &pulse) != 1) {
468                         error << _("MeterSection XML node has an illegal \"pulse\" value") << endmsg;
469                 }
470         }
471         set_pulse (pulse);
472
473         if ((prop = node.property ("beat")) != 0) {
474                 if (sscanf (prop->value().c_str(), "%lf", &beat) != 1) {
475                         error << _("MeterSection XML node has an illegal \"beat\" value") << endmsg;
476                 }
477         }
478
479         start.first = beat;
480
481         if ((prop = node.property ("bbt")) == 0) {
482                 warning << _("MeterSection XML node has no \"bbt\" property") << endmsg;
483         } else if (sscanf (prop->value().c_str(), "%" PRIu32 "|%" PRIu32 "|%" PRIu32,
484                     &bbt.bars,
485                     &bbt.beats,
486                     &bbt.ticks) < 3) {
487                 error << _("MeterSection XML node has an illegal \"bbt\" value") << endmsg;
488                 throw failed_constructor();
489         }
490
491         start.second = bbt;
492         set_beat (start);
493
494         if ((prop = node.property ("frame")) != 0) {
495                 if (sscanf (prop->value().c_str(), "%li", &frame) != 1) {
496                         error << _("MeterSection XML node has an illegal \"frame\" value") << endmsg;
497                 } else {
498                         set_frame (frame);
499                 }
500         }
501
502         /* beats-per-bar is old; divisions-per-bar is new */
503
504         if ((prop = node.property ("divisions-per-bar")) == 0) {
505                 if ((prop = node.property ("beats-per-bar")) == 0) {
506                         error << _("MeterSection XML node has no \"beats-per-bar\" or \"divisions-per-bar\" property") << endmsg;
507                         throw failed_constructor();
508                 }
509         }
510         if (sscanf (prop->value().c_str(), "%lf", &_divisions_per_bar) != 1 || _divisions_per_bar < 0.0) {
511                 error << _("MeterSection XML node has an illegal \"divisions-per-bar\" value") << endmsg;
512                 throw failed_constructor();
513         }
514
515         if ((prop = node.property ("note-type")) == 0) {
516                 error << _("MeterSection XML node has no \"note-type\" property") << endmsg;
517                 throw failed_constructor();
518         }
519         if (sscanf (prop->value().c_str(), "%lf", &_note_type) != 1 || _note_type < 0.0) {
520                 error << _("MeterSection XML node has an illegal \"note-type\" value") << endmsg;
521                 throw failed_constructor();
522         }
523
524         if ((prop = node.property ("movable")) == 0) {
525                 error << _("MeterSection XML node has no \"movable\" property") << endmsg;
526                 throw failed_constructor();
527         }
528
529         set_movable (string_is_affirmative (prop->value()));
530
531         if ((prop = node.property ("lock-style")) == 0) {
532                 warning << _("MeterSection XML node has no \"lock-style\" property") << endmsg;
533                 if (movable()) {
534                         set_position_lock_style (MusicTime);
535                 } else {
536                         set_position_lock_style (AudioTime);
537                 }
538         } else {
539                 set_position_lock_style (PositionLockStyle (string_2_enum (prop->value(), position_lock_style())));
540         }
541 }
542
543 XMLNode&
544 MeterSection::get_state() const
545 {
546         XMLNode *root = new XMLNode (xml_state_node_name);
547         char buf[256];
548         LocaleGuard lg;
549
550         snprintf (buf, sizeof (buf), "%lf", pulse());
551         root->add_property ("pulse", buf);
552         snprintf (buf, sizeof (buf), "%" PRIu32 "|%" PRIu32 "|%" PRIu32,
553                   bbt().bars,
554                   bbt().beats,
555                   bbt().ticks);
556         root->add_property ("bbt", buf);
557         snprintf (buf, sizeof (buf), "%lf", beat());
558         root->add_property ("beat", buf);
559         snprintf (buf, sizeof (buf), "%f", _note_type);
560         root->add_property ("note-type", buf);
561         snprintf (buf, sizeof (buf), "%li", frame());
562         root->add_property ("frame", buf);
563         root->add_property ("lock-style", enum_2_string (position_lock_style()));
564         snprintf (buf, sizeof (buf), "%f", _divisions_per_bar);
565         root->add_property ("divisions-per-bar", buf);
566         snprintf (buf, sizeof (buf), "%s", movable()?"yes":"no");
567         root->add_property ("movable", buf);
568
569         return *root;
570 }
571
572 /***********************************************************************/
573 /*
574   Tempo Map Overview
575
576   Tempo can be thought of as a source of the musical pulse.
577   Meters divide that pulse into measures and beats.
578   Tempo pulses can be divided to be in sympathy with the meter, but this does not affect the beat
579   at any particular time.
580   Note that Tempo::beats_per_minute() has nothing to do with musical beats.
581   It should rather be thought of as tempo note divisions per minute.
582
583   TempoSections, which are nice to think of in whole pulses per minute,
584   and MeterSecions which divide tempo pulses into measures (via divisions_per_bar)
585   and beats (via note_divisor) are used to form a tempo map.
586   TempoSections and MeterSections may be locked to either audio or music (position lock style).
587   We construct the tempo map by first using the frame or pulse position (depending on position lock style) of each tempo.
588   We then use this pulse/frame layout to find the beat & pulse or frame position of each meter (again depending on lock style).
589
590   Having done this, we can now find any one of tempo, beat, frame or pulse if a beat, frame, pulse or tempo is known.
591
592   The first tempo and first meter are special. they must move together, and must be locked to audio.
593   Audio locked tempos which lie before the first meter are made inactive.
594   They will be re-activated if the first meter is again placed before them.
595
596   Both tempos and meters have a pulse position and a frame position.
597   Meters also have a beat position, which is always 0.0 for the first meter.
598
599   A tempo locked to music is locked to musical pulses.
600   A meter locked to music is locked to beats.
601
602   Recomputing the tempo map is the process where the 'missing' position
603   (tempo pulse or meter pulse & beat in the case of AudioTime, frame for MusicTime) is calculated.
604
605   It is important to keep the _metrics in an order that makes sense.
606   Because ramped MusicTime and AudioTime tempos can interact with each other,
607   reordering is frequent. Care must be taken to keep _metrics in a solved state.
608   Solved means ordered by frame or pulse with frame-accurate precision (see check_solved()).
609 */
610 struct MetricSectionSorter {
611     bool operator() (const MetricSection* a, const MetricSection* b) {
612             return a->pulse() < b->pulse();
613     }
614 };
615
616 struct MetricSectionFrameSorter {
617     bool operator() (const MetricSection* a, const MetricSection* b) {
618             return a->frame() < b->frame();
619     }
620 };
621
622 TempoMap::TempoMap (framecnt_t fr)
623 {
624         _frame_rate = fr;
625         BBT_Time start (1, 1, 0);
626
627         TempoSection *t = new TempoSection ((framepos_t) 0, _default_tempo.beats_per_minute(), _default_tempo.note_type(), TempoSection::Constant);
628         MeterSection *m = new MeterSection ((framepos_t) 0, 0.0, start, _default_meter.divisions_per_bar(), _default_meter.note_divisor());
629
630         t->set_movable (false);
631         m->set_movable (false);
632
633         /* note: frame time is correct (zero) for both of these */
634
635         _metrics.push_back (t);
636         _metrics.push_back (m);
637
638 }
639
640 TempoMap::~TempoMap ()
641 {
642 }
643
644 void
645 TempoMap::remove_tempo (const TempoSection& tempo, bool complete_operation)
646 {
647         bool removed = false;
648
649         {
650                 Glib::Threads::RWLock::WriterLock lm (lock);
651                 if ((removed = remove_tempo_locked (tempo))) {
652                         if (complete_operation) {
653                                 recompute_map (_metrics);
654                         }
655                 }
656         }
657
658         if (removed && complete_operation) {
659                 PropertyChanged (PropertyChange ());
660         }
661 }
662
663 bool
664 TempoMap::remove_tempo_locked (const TempoSection& tempo)
665 {
666         Metrics::iterator i;
667
668         for (i = _metrics.begin(); i != _metrics.end(); ++i) {
669                 if (dynamic_cast<TempoSection*> (*i) != 0) {
670                         if (tempo.frame() == (*i)->frame()) {
671                                 if ((*i)->movable()) {
672                                         _metrics.erase (i);
673                                         return true;
674                                 }
675                         }
676                 }
677         }
678
679         return false;
680 }
681
682 void
683 TempoMap::remove_meter (const MeterSection& tempo, bool complete_operation)
684 {
685         bool removed = false;
686
687         {
688                 Glib::Threads::RWLock::WriterLock lm (lock);
689                 if ((removed = remove_meter_locked (tempo))) {
690                         if (complete_operation) {
691                                 recompute_map (_metrics);
692                         }
693                 }
694         }
695
696         if (removed && complete_operation) {
697                 PropertyChanged (PropertyChange ());
698         }
699 }
700
701 bool
702 TempoMap::remove_meter_locked (const MeterSection& tempo)
703 {
704         Metrics::iterator i;
705
706         for (i = _metrics.begin(); i != _metrics.end(); ++i) {
707                 if (dynamic_cast<MeterSection*> (*i) != 0) {
708                         if (tempo.frame() == (*i)->frame()) {
709                                 if ((*i)->movable()) {
710                                         _metrics.erase (i);
711                                         return true;
712                                 }
713                         }
714                 }
715         }
716
717         return false;
718 }
719
720 void
721 TempoMap::do_insert (MetricSection* section)
722 {
723         bool need_add = true;
724         /* we only allow new meters to be inserted on beat 1 of an existing
725          * measure.
726          */
727         MeterSection* m = 0;
728         if ((m = dynamic_cast<MeterSection*>(section)) != 0) {
729                 //assert (m->bbt().ticks == 0);
730
731                 if ((m->bbt().beats != 1) || (m->bbt().ticks != 0)) {
732
733                         pair<double, BBT_Time> corrected = make_pair (m->pulse(), m->bbt());
734                         corrected.second.beats = 1;
735                         corrected.second.ticks = 0;
736                         corrected.first = bbt_to_beats_locked (_metrics, corrected.second);
737                         warning << string_compose (_("Meter changes can only be positioned on the first beat of a bar. Moving from %1 to %2"),
738                                                    m->bbt(), corrected.second) << endmsg;
739                         //m->set_pulse (corrected);
740                 }
741         }
742
743         /* Look for any existing MetricSection that is of the same type and
744            in the same bar as the new one, and remove it before adding
745            the new one. Note that this means that if we find a matching,
746            existing section, we can break out of the loop since we're
747            guaranteed that there is only one such match.
748         */
749
750         for (Metrics::iterator i = _metrics.begin(); i != _metrics.end(); ++i) {
751
752                 TempoSection* const tempo = dynamic_cast<TempoSection*> (*i);
753                 TempoSection* const insert_tempo = dynamic_cast<TempoSection*> (section);
754                 MeterSection* const meter = dynamic_cast<MeterSection*> (*i);
755                 MeterSection* const insert_meter = dynamic_cast<MeterSection*> (section);
756
757                 if (tempo && insert_tempo) {
758
759                         /* Tempo sections */
760                         bool const ipm = insert_tempo->position_lock_style() == MusicTime;
761                         if ((ipm && tempo->pulse() == insert_tempo->pulse()) || (!ipm && tempo->frame() == insert_tempo->frame())) {
762
763                                 if (!tempo->movable()) {
764
765                                         /* can't (re)move this section, so overwrite
766                                          * its data content (but not its properties as
767                                          * a section).
768                                          */
769
770                                         *(dynamic_cast<Tempo*>(*i)) = *(dynamic_cast<Tempo*>(insert_tempo));
771                                         (*i)->set_position_lock_style (AudioTime);
772                                         TempoSection* t;
773                                         if ((t = dynamic_cast<TempoSection*>(*i)) != 0) {
774                                                 t->set_type (insert_tempo->type());
775                                         }
776                                         need_add = false;
777                                 } else {
778                                         _metrics.erase (i);
779                                 }
780                                 break;
781                         }
782
783                 } else if (meter && insert_meter) {
784
785                         /* Meter Sections */
786
787                         bool const ipm = insert_meter->position_lock_style() == MusicTime;
788
789                         if ((ipm && meter->beat() == insert_meter->beat()) || (!ipm && meter->frame() == insert_meter->frame())) {
790
791                                 if (!meter->movable()) {
792
793                                         /* can't (re)move this section, so overwrite
794                                          * its data content (but not its properties as
795                                          * a section
796                                          */
797
798                                         *(dynamic_cast<Meter*>(*i)) = *(dynamic_cast<Meter*>(insert_meter));
799                                         (*i)->set_position_lock_style (AudioTime);
800                                         need_add = false;
801                                 } else {
802                                         _metrics.erase (i);
803                                 }
804
805                                 break;
806                         }
807                 } else {
808                         /* non-matching types, so we don't care */
809                 }
810         }
811
812         /* Add the given MetricSection, if we didn't just reset an existing
813          * one above
814          */
815
816         if (need_add) {
817                 MeterSection* const insert_meter = dynamic_cast<MeterSection*> (section);
818                 TempoSection* const insert_tempo = dynamic_cast<TempoSection*> (section);
819                 Metrics::iterator i;
820                 if (insert_meter) {
821                         for (i = _metrics.begin(); i != _metrics.end(); ++i) {
822                                 MeterSection* const meter = dynamic_cast<MeterSection*> (*i);
823
824                                 if (meter) {
825                                         bool const ipm = insert_meter->position_lock_style() == MusicTime;
826                                         if ((ipm && meter->beat() > insert_meter->beat()) || (!ipm && meter->frame() > insert_meter->frame())) {
827                                                 break;
828                                         }
829                                 }
830                         }
831                 } else if (insert_tempo) {
832                         for (i = _metrics.begin(); i != _metrics.end(); ++i) {
833                                 TempoSection* const tempo = dynamic_cast<TempoSection*> (*i);
834
835                                 if (tempo) {
836                                         bool const ipm = insert_tempo->position_lock_style() == MusicTime;
837                                         if ((ipm && tempo->pulse() > insert_tempo->pulse()) || (!ipm && tempo->frame() > insert_tempo->frame())) {
838                                                 break;
839                                         }
840                                 }
841                         }
842                 }
843
844                 _metrics.insert (i, section);
845                 //dump (_metrics, std::cerr);
846         }
847 }
848
849 void
850 TempoMap::replace_tempo (const TempoSection& ts, const Tempo& tempo, const double& pulse, TempoSection::Type type)
851 {
852         {
853                 Glib::Threads::RWLock::WriterLock lm (lock);
854                 TempoSection& first (first_tempo());
855                 if (ts.pulse() != first.pulse()) {
856                         remove_tempo_locked (ts);
857                         add_tempo_locked (tempo, pulse, true, type);
858                 } else {
859                         first.set_type (type);
860                         {
861                                 /* cannot move the first tempo section */
862                                 *static_cast<Tempo*>(&first) = tempo;
863                                 recompute_map (_metrics);
864                         }
865                 }
866         }
867
868         PropertyChanged (PropertyChange ());
869 }
870
871 void
872 TempoMap::replace_tempo (const TempoSection& ts, const Tempo& tempo, const framepos_t& frame, TempoSection::Type type)
873 {
874         {
875                 Glib::Threads::RWLock::WriterLock lm (lock);
876                 TempoSection& first (first_tempo());
877                 if (ts.frame() != first.frame()) {
878                         remove_tempo_locked (ts);
879                         add_tempo_locked (tempo, frame, true, type);
880                 } else {
881                         first.set_type (type);
882                         first.set_pulse (0.0);
883                         first.set_position_lock_style (AudioTime);
884                         {
885                                 /* cannot move the first tempo section */
886                                 *static_cast<Tempo*>(&first) = tempo;
887                                 recompute_map (_metrics);
888                         }
889                 }
890         }
891
892         PropertyChanged (PropertyChange ());
893 }
894
895 TempoSection*
896 TempoMap::add_tempo (const Tempo& tempo, const double& pulse, ARDOUR::TempoSection::Type type)
897 {
898         TempoSection* ts = 0;
899         {
900                 Glib::Threads::RWLock::WriterLock lm (lock);
901                 ts = add_tempo_locked (tempo, pulse, true, type);
902         }
903
904         PropertyChanged (PropertyChange ());
905
906         return ts;
907 }
908
909 TempoSection*
910 TempoMap::add_tempo (const Tempo& tempo, const framepos_t& frame, ARDOUR::TempoSection::Type type)
911 {
912         TempoSection* ts = 0;
913         {
914                 Glib::Threads::RWLock::WriterLock lm (lock);
915                 ts = add_tempo_locked (tempo, frame, true, type);
916         }
917
918
919         PropertyChanged (PropertyChange ());
920
921         return ts;
922 }
923
924 TempoSection*
925 TempoMap::add_tempo_locked (const Tempo& tempo, double pulse, bool recompute, ARDOUR::TempoSection::Type type)
926 {
927         TempoSection* t = new TempoSection (pulse, tempo.beats_per_minute(), tempo.note_type(), type);
928
929         do_insert (t);
930
931         if (recompute) {
932                 solve_map (_metrics, t, t->pulse());
933         }
934
935         return t;
936 }
937
938 TempoSection*
939 TempoMap::add_tempo_locked (const Tempo& tempo, framepos_t frame, bool recompute, ARDOUR::TempoSection::Type type)
940 {
941         TempoSection* t = new TempoSection (frame, tempo.beats_per_minute(), tempo.note_type(), type);
942
943         do_insert (t);
944
945         if (recompute) {
946                 solve_map (_metrics, t, t->frame());
947         }
948
949         return t;
950 }
951
952 void
953 TempoMap::replace_meter (const MeterSection& ms, const Meter& meter, const BBT_Time& where)
954 {
955         {
956                 Glib::Threads::RWLock::WriterLock lm (lock);
957
958                 if (ms.movable()) {
959                         remove_meter_locked (ms);
960                         add_meter_locked (meter, bbt_to_beats_locked (_metrics, where), where, true);
961                 } else {
962                         MeterSection& first (first_meter());
963                         /* cannot move the first meter section */
964                         *static_cast<Meter*>(&first) = meter;
965                         first.set_position_lock_style (AudioTime);
966                 }
967                 recompute_map (_metrics);
968         }
969
970         PropertyChanged (PropertyChange ());
971 }
972
973 void
974 TempoMap::replace_meter (const MeterSection& ms, const Meter& meter, const framepos_t& frame)
975 {
976         {
977                 Glib::Threads::RWLock::WriterLock lm (lock);
978
979                 const double beat = ms.beat();
980                 const BBT_Time bbt = ms.bbt();
981
982                 if (ms.movable()) {
983                         remove_meter_locked (ms);
984                         add_meter_locked (meter, frame, beat, bbt, true);
985                 } else {
986                         MeterSection& first (first_meter());
987                         TempoSection& first_t (first_tempo());
988                         /* cannot move the first meter section */
989                         *static_cast<Meter*>(&first) = meter;
990                         first.set_position_lock_style (AudioTime);
991                         first.set_pulse (0.0);
992                         first.set_frame (frame);
993                         pair<double, BBT_Time> beat = make_pair (0.0, BBT_Time (1, 1, 0));
994                         first.set_beat (beat);
995                         first_t.set_frame (first.frame());
996                         first_t.set_pulse (0.0);
997                         first_t.set_position_lock_style (AudioTime);
998                 }
999                 recompute_map (_metrics);
1000         }
1001         PropertyChanged (PropertyChange ());
1002 }
1003
1004
1005 MeterSection*
1006 TempoMap::add_meter (const Meter& meter, const double& beat, const BBT_Time& where)
1007 {
1008         MeterSection* m = 0;
1009         {
1010                 Glib::Threads::RWLock::WriterLock lm (lock);
1011                 m = add_meter_locked (meter, beat, where, true);
1012         }
1013
1014
1015 #ifndef NDEBUG
1016         if (DEBUG_ENABLED(DEBUG::TempoMap)) {
1017                 dump (_metrics, std::cerr);
1018         }
1019 #endif
1020
1021         PropertyChanged (PropertyChange ());
1022
1023         return m;
1024 }
1025
1026 MeterSection*
1027 TempoMap::add_meter (const Meter& meter, const framepos_t& frame, const double& beat, const Timecode::BBT_Time& where)
1028 {
1029         MeterSection* m = 0;
1030         {
1031                 Glib::Threads::RWLock::WriterLock lm (lock);
1032                 m = add_meter_locked (meter, frame, beat, where, true);
1033         }
1034
1035
1036 #ifndef NDEBUG
1037         if (DEBUG_ENABLED(DEBUG::TempoMap)) {
1038                 dump (_metrics, std::cerr);
1039         }
1040 #endif
1041
1042         PropertyChanged (PropertyChange ());
1043
1044         return m;
1045 }
1046
1047 MeterSection*
1048 TempoMap::add_meter_locked (const Meter& meter, double beat, BBT_Time where, bool recompute)
1049 {
1050         /* a new meter always starts a new bar on the first beat. so
1051            round the start time appropriately. remember that
1052            `where' is based on the existing tempo map, not
1053            the result after we insert the new meter.
1054
1055         */
1056
1057         if (where.beats != 1) {
1058                 where.beats = 1;
1059                 where.bars++;
1060         }
1061         /* new meters *always* start on a beat. */
1062         where.ticks = 0;
1063         const double pulse = pulse_at_beat_locked (_metrics, beat);
1064         MeterSection* new_meter = new MeterSection (pulse, beat, where, meter.divisions_per_bar(), meter.note_divisor());
1065         do_insert (new_meter);
1066
1067         if (recompute) {
1068                 solve_map (_metrics, new_meter, pulse);
1069         }
1070
1071         return new_meter;
1072 }
1073
1074 MeterSection*
1075 TempoMap::add_meter_locked (const Meter& meter, framepos_t frame, double beat, Timecode::BBT_Time where, bool recompute)
1076 {
1077         MeterSection* new_meter = new MeterSection (frame, beat, where, meter.divisions_per_bar(), meter.note_divisor());
1078
1079         double pulse = pulse_at_frame_locked (_metrics, frame);
1080         new_meter->set_pulse (pulse);
1081
1082         do_insert (new_meter);
1083
1084         if (recompute) {
1085                 solve_map (_metrics, new_meter, frame);
1086         }
1087
1088         return new_meter;
1089 }
1090
1091 void
1092 TempoMap::change_initial_tempo (double beats_per_minute, double note_type)
1093 {
1094         Tempo newtempo (beats_per_minute, note_type);
1095         TempoSection* t;
1096
1097         for (Metrics::iterator i = _metrics.begin(); i != _metrics.end(); ++i) {
1098                 if ((t = dynamic_cast<TempoSection*> (*i)) != 0) {
1099                         if (!t->active()) {
1100                                 continue;
1101                         }
1102                         {
1103                                 Glib::Threads::RWLock::WriterLock lm (lock);
1104                                 *((Tempo*) t) = newtempo;
1105                                 recompute_map (_metrics);
1106                         }
1107                         PropertyChanged (PropertyChange ());
1108                         break;
1109                 }
1110         }
1111 }
1112
1113 void
1114 TempoMap::change_existing_tempo_at (framepos_t where, double beats_per_minute, double note_type)
1115 {
1116         Tempo newtempo (beats_per_minute, note_type);
1117
1118         TempoSection* prev;
1119         TempoSection* first;
1120         Metrics::iterator i;
1121
1122         /* find the TempoSection immediately preceding "where"
1123          */
1124
1125         for (first = 0, i = _metrics.begin(), prev = 0; i != _metrics.end(); ++i) {
1126
1127                 if ((*i)->frame() > where) {
1128                         break;
1129                 }
1130
1131                 TempoSection* t;
1132
1133                 if ((t = dynamic_cast<TempoSection*>(*i)) != 0) {
1134                         if (!t->active()) {
1135                                 continue;
1136                         }
1137                         if (!first) {
1138                                 first = t;
1139                         }
1140                         prev = t;
1141                 }
1142         }
1143
1144         if (!prev) {
1145                 if (!first) {
1146                         error << string_compose (_("no tempo sections defined in tempo map - cannot change tempo @ %1"), where) << endmsg;
1147                         return;
1148                 }
1149
1150                 prev = first;
1151         }
1152
1153         /* reset */
1154
1155         {
1156                 Glib::Threads::RWLock::WriterLock lm (lock);
1157                 /* cannot move the first tempo section */
1158                 *((Tempo*)prev) = newtempo;
1159                 recompute_map (_metrics);
1160         }
1161
1162         PropertyChanged (PropertyChange ());
1163 }
1164
1165 const MeterSection&
1166 TempoMap::first_meter () const
1167 {
1168         const MeterSection *m = 0;
1169
1170         for (Metrics::const_iterator i = _metrics.begin(); i != _metrics.end(); ++i) {
1171                 if ((m = dynamic_cast<const MeterSection *> (*i)) != 0) {
1172                         return *m;
1173                 }
1174         }
1175
1176         fatal << _("programming error: no meter section in tempo map!") << endmsg;
1177         abort(); /*NOTREACHED*/
1178         return *m;
1179 }
1180
1181 MeterSection&
1182 TempoMap::first_meter ()
1183 {
1184         MeterSection *m = 0;
1185
1186         /* CALLER MUST HOLD LOCK */
1187
1188         for (Metrics::iterator i = _metrics.begin(); i != _metrics.end(); ++i) {
1189                 if ((m = dynamic_cast<MeterSection *> (*i)) != 0) {
1190                         return *m;
1191                 }
1192         }
1193
1194         fatal << _("programming error: no tempo section in tempo map!") << endmsg;
1195         abort(); /*NOTREACHED*/
1196         return *m;
1197 }
1198
1199 const TempoSection&
1200 TempoMap::first_tempo () const
1201 {
1202         const TempoSection *t = 0;
1203
1204         /* CALLER MUST HOLD LOCK */
1205
1206         for (Metrics::const_iterator i = _metrics.begin(); i != _metrics.end(); ++i) {
1207                 if ((t = dynamic_cast<const TempoSection *> (*i)) != 0) {
1208                         if (!t->active()) {
1209                                 continue;
1210                         }
1211                         if (!t->movable()) {
1212                                 return *t;
1213                         }
1214                 }
1215         }
1216
1217         fatal << _("programming error: no tempo section in tempo map!") << endmsg;
1218         abort(); /*NOTREACHED*/
1219         return *t;
1220 }
1221
1222 TempoSection&
1223 TempoMap::first_tempo ()
1224 {
1225         TempoSection *t = 0;
1226
1227         for (Metrics::const_iterator i = _metrics.begin(); i != _metrics.end(); ++i) {
1228                 if ((t = dynamic_cast<TempoSection *> (*i)) != 0) {
1229                         if (!t->active()) {
1230                                 continue;
1231                         }
1232                         if (!t->movable()) {
1233                                 return *t;
1234                         }
1235                 }
1236         }
1237
1238         fatal << _("programming error: no tempo section in tempo map!") << endmsg;
1239         abort(); /*NOTREACHED*/
1240         return *t;
1241 }
1242 void
1243 TempoMap::recompute_tempos (Metrics& metrics)
1244 {
1245         TempoSection* prev_t = 0;
1246
1247         for (Metrics::const_iterator i = metrics.begin(); i != metrics.end(); ++i) {
1248                 TempoSection* t;
1249
1250                 if ((t = dynamic_cast<TempoSection*> (*i)) != 0) {
1251                         if (!t->active()) {
1252                                 continue;
1253                         }
1254                         if (!t->movable()) {
1255                                 t->set_pulse (0.0);
1256                                 prev_t = t;
1257                                 continue;
1258                         }
1259                         if (prev_t) {
1260                                 if (t->position_lock_style() == AudioTime) {
1261                                         prev_t->set_c_func (prev_t->compute_c_func_frame (t->pulses_per_minute(), t->frame(), _frame_rate));
1262                                         t->set_pulse (prev_t->pulse_at_tempo (t->pulses_per_minute(), t->frame(), _frame_rate));
1263
1264                                 } else {
1265                                         prev_t->set_c_func (prev_t->compute_c_func_pulse (t->pulses_per_minute(), t->pulse(), _frame_rate));
1266                                         t->set_frame (prev_t->frame_at_tempo (t->pulses_per_minute(), t->pulse(), _frame_rate));
1267
1268                                 }
1269                         }
1270                         prev_t = t;
1271                 }
1272         }
1273         prev_t->set_c_func (0.0);
1274 }
1275
1276 /* tempos must be positioned correctly */
1277 void
1278 TempoMap::recompute_meters (Metrics& metrics)
1279 {
1280         MeterSection* meter = 0;
1281         MeterSection* prev_m = 0;
1282
1283         for (Metrics::const_iterator mi = metrics.begin(); mi != metrics.end(); ++mi) {
1284                 if ((meter = dynamic_cast<MeterSection*> (*mi)) != 0) {
1285                         if (meter->position_lock_style() == AudioTime) {
1286                                 double pulse = 0.0;
1287                                 pair<double, BBT_Time> b_bbt;
1288                                 if (meter->movable()) {
1289                                         const double beats = ((pulse_at_frame_locked (metrics, meter->frame()) - prev_m->pulse()) * prev_m->note_divisor());
1290                                         const double floor_beats = beats - fmod (beats, prev_m->divisions_per_bar());
1291                                         b_bbt = make_pair (floor_beats + prev_m->beat(), BBT_Time ((floor_beats / prev_m->divisions_per_bar()) + prev_m->bbt().bars, 1, 0));
1292                                         const double true_pulse = prev_m->pulse() + (floor_beats / prev_m->note_divisor());
1293                                         const double pulse_off = true_pulse - (beats / prev_m->note_divisor()) - prev_m->pulse();
1294                                         pulse = true_pulse - pulse_off;
1295                                 } else {
1296                                         b_bbt = make_pair (0.0, BBT_Time (1, 1, 0));
1297                                 }
1298                                 meter->set_beat (b_bbt);
1299                                 meter->set_pulse (pulse);
1300                         } else {
1301                                 double pulse = 0.0;
1302                                 pair<double, BBT_Time> new_beat;
1303                                 if (prev_m) {
1304                                         pulse = prev_m->pulse() + ((meter->bbt().bars - prev_m->bbt().bars) *  prev_m->divisions_per_bar() / prev_m->note_divisor());
1305                                         new_beat = make_pair (((pulse - prev_m->pulse()) * prev_m->note_divisor()) + prev_m->beat(), meter->bbt());
1306                                 } else {
1307                                         /* shouldn't happen - the first is audio-locked */
1308                                         pulse = pulse_at_beat_locked (metrics, meter->beat());
1309                                         new_beat = make_pair (pulse, meter->bbt());
1310                                 }
1311
1312                                 meter->set_beat (new_beat);
1313                                 meter->set_frame (frame_at_pulse_locked (metrics, pulse));
1314                                 meter->set_pulse (pulse);
1315                         }
1316
1317                         prev_m = meter;
1318                 }
1319         }
1320         //dump (_metrics, std::cerr;
1321 }
1322
1323 void
1324 TempoMap::recompute_map (Metrics& metrics, framepos_t end)
1325 {
1326         /* CALLER MUST HOLD WRITE LOCK */
1327
1328         if (end < 0) {
1329
1330                 /* we will actually stop once we hit
1331                    the last metric.
1332                 */
1333                 end = max_framepos;
1334
1335         }
1336
1337         DEBUG_TRACE (DEBUG::TempoMath, string_compose ("recomputing tempo map, zero to %1\n", end));
1338
1339         if (end == 0) {
1340                 /* silly call from Session::process() during startup
1341                  */
1342                 return;
1343         }
1344
1345         recompute_tempos (metrics);
1346         recompute_meters (metrics);
1347 }
1348
1349 TempoMetric
1350 TempoMap::metric_at (framepos_t frame, Metrics::const_iterator* last) const
1351 {
1352         Glib::Threads::RWLock::ReaderLock lm (lock);
1353         TempoMetric m (first_meter(), first_tempo());
1354
1355         /* at this point, we are *guaranteed* to have m.meter and m.tempo pointing
1356            at something, because we insert the default tempo and meter during
1357            TempoMap construction.
1358
1359            now see if we can find better candidates.
1360         */
1361
1362         for (Metrics::const_iterator i = _metrics.begin(); i != _metrics.end(); ++i) {
1363
1364                 if ((*i)->frame() > frame) {
1365                         break;
1366                 }
1367
1368                 m.set_metric(*i);
1369
1370                 if (last) {
1371                         *last = i;
1372                 }
1373         }
1374
1375         return m;
1376 }
1377
1378 /* XX meters only */
1379 TempoMetric
1380 TempoMap::metric_at (BBT_Time bbt) const
1381 {
1382         Glib::Threads::RWLock::ReaderLock lm (lock);
1383         TempoMetric m (first_meter(), first_tempo());
1384
1385         /* at this point, we are *guaranteed* to have m.meter and m.tempo pointing
1386            at something, because we insert the default tempo and meter during
1387            TempoMap construction.
1388
1389            now see if we can find better candidates.
1390         */
1391
1392         for (Metrics::const_iterator i = _metrics.begin(); i != _metrics.end(); ++i) {
1393                 MeterSection* mw;
1394                 if ((mw = dynamic_cast<MeterSection*> (*i)) != 0) {
1395                         BBT_Time section_start (mw->bbt());
1396
1397                         if (section_start.bars > bbt.bars || (section_start.bars == bbt.bars && section_start.beats > bbt.beats)) {
1398                                 break;
1399                         }
1400
1401                         m.set_metric (*i);
1402                 }
1403         }
1404
1405         return m;
1406 }
1407
1408 double
1409 TempoMap::pulse_at_beat_locked (const Metrics& metrics, const double& beat) const
1410 {
1411         MeterSection* prev_m = 0;
1412
1413         for (Metrics::const_iterator i = metrics.begin(); i != metrics.end(); ++i) {
1414                 MeterSection* m;
1415                 if ((m = dynamic_cast<MeterSection*> (*i)) != 0) {
1416                         if (prev_m && m->beat() > beat) {
1417                                 break;
1418                         }
1419                         prev_m = m;
1420                 }
1421
1422         }
1423         double const ret = prev_m->pulse() + ((beat - prev_m->beat()) / prev_m->note_divisor());
1424         return ret;
1425 }
1426
1427 double
1428 TempoMap::pulse_at_beat (const double& beat) const
1429 {
1430         Glib::Threads::RWLock::ReaderLock lm (lock);
1431         return pulse_at_beat_locked (_metrics, beat);
1432 }
1433
1434 double
1435 TempoMap::beat_at_pulse_locked (const Metrics& metrics, const double& pulse) const
1436 {
1437         MeterSection* prev_m = 0;
1438
1439         for (Metrics::const_iterator i = metrics.begin(); i != metrics.end(); ++i) {
1440                 MeterSection* m;
1441                 if ((m = dynamic_cast<MeterSection*> (*i)) != 0) {
1442                         if (prev_m && m->pulse() > pulse) {
1443                                 break;
1444                         }
1445                         prev_m = m;
1446                 }
1447         }
1448
1449         double const beats_in_section = (pulse - prev_m->pulse()) * prev_m->note_divisor();
1450
1451         return beats_in_section + prev_m->beat();
1452 }
1453
1454 double
1455 TempoMap::beat_at_pulse (const double& pulse) const
1456 {
1457         Glib::Threads::RWLock::ReaderLock lm (lock);
1458         return beat_at_pulse_locked (_metrics, pulse);
1459 }
1460
1461 double
1462 TempoMap::pulse_at_frame_locked (const Metrics& metrics, const framecnt_t& frame) const
1463 {
1464         /* HOLD (at least) THE READER LOCK */
1465         TempoSection* prev_t = 0;
1466
1467         for (Metrics::const_iterator i = metrics.begin(); i != metrics.end(); ++i) {
1468                 TempoSection* t;
1469                 if ((t = dynamic_cast<TempoSection*> (*i)) != 0) {
1470                         if (!t->active()) {
1471                                 continue;
1472                         }
1473                         if (prev_t && t->frame() > frame) {
1474                                 /*the previous ts is the one containing the frame */
1475                                 const double ret = prev_t->pulse_at_frame (frame, _frame_rate);
1476                                 return ret;
1477                         }
1478                         prev_t = t;
1479                 }
1480         }
1481
1482         /* treated as constant for this ts */
1483         const double pulses_in_section = (frame - prev_t->frame()) / prev_t->frames_per_pulse (_frame_rate);
1484
1485         return pulses_in_section + prev_t->pulse();
1486 }
1487
1488 framecnt_t
1489 TempoMap::frame_at_pulse_locked (const Metrics& metrics, const double& pulse) const
1490 {
1491         /* HOLD THE READER LOCK */
1492
1493         const TempoSection* prev_t = 0;
1494
1495         for (Metrics::const_iterator i = metrics.begin(); i != metrics.end(); ++i) {
1496                 TempoSection* t;
1497
1498                 if ((t = dynamic_cast<TempoSection*> (*i)) != 0) {
1499                         if (!t->active()) {
1500                                 continue;
1501                         }
1502                         if (prev_t && t->pulse() > pulse) {
1503                                 return prev_t->frame_at_pulse (pulse, _frame_rate);
1504                         }
1505
1506                         prev_t = t;
1507                 }
1508         }
1509         /* must be treated as constant, irrespective of _type */
1510         double const pulses_in_section = pulse - prev_t->pulse();
1511         double const dtime = pulses_in_section * prev_t->frames_per_pulse (_frame_rate);
1512
1513         framecnt_t const ret = (framecnt_t) floor (dtime) + prev_t->frame();
1514
1515         return ret;
1516 }
1517
1518 double
1519 TempoMap::beat_at_frame_locked (const Metrics& metrics, const framecnt_t& frame) const
1520 {
1521         const double pulse = pulse_at_frame_locked (metrics, frame);
1522         return beat_at_pulse_locked (metrics, pulse);
1523 }
1524
1525 double
1526 TempoMap::beat_at_frame (const framecnt_t& frame) const
1527 {
1528         Glib::Threads::RWLock::ReaderLock lm (lock);
1529         return beat_at_frame_locked (_metrics, frame);
1530 }
1531
1532 framecnt_t
1533 TempoMap::frame_at_beat_locked (const Metrics& metrics, const double& beat) const
1534 {
1535         const framecnt_t frame = frame_at_pulse_locked (metrics, pulse_at_beat_locked (metrics, beat));
1536         return frame;
1537 }
1538
1539 framecnt_t
1540 TempoMap::frame_at_beat (const double& beat) const
1541 {
1542         Glib::Threads::RWLock::ReaderLock lm (lock);
1543         return frame_at_beat_locked (_metrics, beat);
1544 }
1545
1546 double
1547 TempoMap::bbt_to_beats_locked (const Metrics& metrics, const Timecode::BBT_Time& bbt) const
1548 {
1549         /* CALLER HOLDS READ LOCK */
1550
1551         MeterSection* prev_m = 0;
1552
1553         /* because audio-locked meters have 'fake' integral beats,
1554            there is no pulse offset here.
1555         */
1556         for (Metrics::const_iterator i = metrics.begin(); i != metrics.end(); ++i) {
1557                 MeterSection* m;
1558                 if ((m = dynamic_cast<MeterSection*> (*i)) != 0) {
1559                         if (prev_m) {
1560                                 const double bars_to_m = (m->beat() - prev_m->beat()) / prev_m->divisions_per_bar();
1561                                 if ((bars_to_m + (prev_m->bbt().bars - 1)) > (bbt.bars - 1)) {
1562                                         break;
1563                                 }
1564                         }
1565                         prev_m = m;
1566                 }
1567         }
1568
1569         const double remaining_bars = bbt.bars - prev_m->bbt().bars;
1570         const double remaining_bars_in_beats = remaining_bars * prev_m->divisions_per_bar();
1571         const double ret = remaining_bars_in_beats + prev_m->beat() + (bbt.beats - 1) + (bbt.ticks / BBT_Time::ticks_per_beat);
1572
1573         return ret;
1574 }
1575
1576 double
1577 TempoMap::bbt_to_beats (const Timecode::BBT_Time& bbt)
1578 {
1579         Glib::Threads::RWLock::ReaderLock lm (lock);
1580         return bbt_to_beats_locked (_metrics, bbt);
1581 }
1582
1583 Timecode::BBT_Time
1584 TempoMap::beats_to_bbt_locked (const Metrics& metrics, const double& b) const
1585 {
1586         /* CALLER HOLDS READ LOCK */
1587         MeterSection* prev_m = 0;
1588         const double beats = (b < 0.0) ? 0.0 : b;
1589
1590         for (Metrics::const_iterator i = metrics.begin(); i != metrics.end(); ++i) {
1591                 MeterSection* m = 0;
1592
1593                 if ((m = dynamic_cast<MeterSection*> (*i)) != 0) {
1594                         if (prev_m) {
1595                                 if (m->beat() > beats) {
1596                                         /* this is the meter after the one our beat is on*/
1597                                         break;
1598                                 }
1599                         }
1600
1601                         prev_m = m;
1602                 }
1603         }
1604
1605         const double beats_in_ms = beats - prev_m->beat();
1606         const uint32_t bars_in_ms = (uint32_t) floor (beats_in_ms / prev_m->divisions_per_bar());
1607         const uint32_t total_bars = bars_in_ms + (prev_m->bbt().bars - 1);
1608         const double remaining_beats = beats_in_ms - (bars_in_ms * prev_m->divisions_per_bar());
1609         const double remaining_ticks = (remaining_beats - floor (remaining_beats)) * BBT_Time::ticks_per_beat;
1610
1611         BBT_Time ret;
1612
1613         ret.ticks = (uint32_t) floor (remaining_ticks + 0.5);
1614         ret.beats = (uint32_t) floor (remaining_beats);
1615         ret.bars = total_bars;
1616
1617         /* 0 0 0 to 1 1 0 - based mapping*/
1618         ++ret.bars;
1619         ++ret.beats;
1620
1621         if (ret.ticks >= BBT_Time::ticks_per_beat) {
1622                 ++ret.beats;
1623                 ret.ticks -= BBT_Time::ticks_per_beat;
1624         }
1625
1626         if (ret.beats >= prev_m->divisions_per_bar() + 1) {
1627                 ++ret.bars;
1628                 ret.beats = 1;
1629         }
1630
1631         return ret;
1632 }
1633
1634 Timecode::BBT_Time
1635 TempoMap::beats_to_bbt (const double& beats)
1636 {
1637         Glib::Threads::RWLock::ReaderLock lm (lock);
1638         return beats_to_bbt_locked (_metrics, beats);
1639 }
1640
1641 Timecode::BBT_Time
1642 TempoMap::pulse_to_bbt (const double& pulse)
1643 {
1644         Glib::Threads::RWLock::ReaderLock lm (lock);
1645         MeterSection* prev_m = 0;
1646
1647         for (Metrics::const_iterator i = _metrics.begin(); i != _metrics.end(); ++i) {
1648                 MeterSection* m = 0;
1649
1650                 if ((m = dynamic_cast<MeterSection*> (*i)) != 0) {
1651
1652                         if (prev_m) {
1653                                 double const pulses_to_m = m->pulse() - prev_m->pulse();
1654                                 if (prev_m->pulse() + pulses_to_m > pulse) {
1655                                         /* this is the meter after the one our beat is on*/
1656                                         break;
1657                                 }
1658                         }
1659
1660                         prev_m = m;
1661                 }
1662         }
1663
1664         const double beats_in_ms = (pulse - prev_m->pulse()) * prev_m->note_divisor();
1665         const uint32_t bars_in_ms = (uint32_t) floor (beats_in_ms / prev_m->divisions_per_bar());
1666         const uint32_t total_bars = bars_in_ms + (prev_m->bbt().bars - 1);
1667         const double remaining_beats = beats_in_ms - (bars_in_ms * prev_m->divisions_per_bar());
1668         const double remaining_ticks = (remaining_beats - floor (remaining_beats)) * BBT_Time::ticks_per_beat;
1669
1670         BBT_Time ret;
1671
1672         ret.ticks = (uint32_t) floor (remaining_ticks + 0.5);
1673         ret.beats = (uint32_t) floor (remaining_beats);
1674         ret.bars = total_bars;
1675
1676         /* 0 0 0 to 1 1 0 mapping*/
1677         ++ret.bars;
1678         ++ret.beats;
1679
1680         if (ret.ticks >= BBT_Time::ticks_per_beat) {
1681                 ++ret.beats;
1682                 ret.ticks -= BBT_Time::ticks_per_beat;
1683         }
1684
1685         if (ret.beats >= prev_m->divisions_per_bar() + 1) {
1686                 ++ret.bars;
1687                 ret.beats = 1;
1688         }
1689
1690         return ret;
1691 }
1692
1693 void
1694 TempoMap::bbt_time (framepos_t frame, BBT_Time& bbt)
1695 {
1696
1697         if (frame < 0) {
1698                 bbt.bars = 1;
1699                 bbt.beats = 1;
1700                 bbt.ticks = 0;
1701                 warning << string_compose (_("tempo map asked for BBT time at frame %1\n"), frame) << endmsg;
1702                 return;
1703         }
1704         Glib::Threads::RWLock::ReaderLock lm (lock);
1705         const double beat = beat_at_frame_locked (_metrics, frame);
1706
1707         bbt = beats_to_bbt_locked (_metrics, beat);
1708 }
1709
1710 framepos_t
1711 TempoMap::frame_time_locked (const Metrics& metrics, const BBT_Time& bbt) const
1712 {
1713         /* HOLD THE READER LOCK */
1714
1715         const framepos_t ret = frame_at_beat_locked (metrics, bbt_to_beats_locked (metrics, bbt));
1716         return ret;
1717 }
1718
1719 framepos_t
1720 TempoMap::frame_time (const BBT_Time& bbt)
1721 {
1722         if (bbt.bars < 1) {
1723                 warning << string_compose (_("tempo map asked for frame time at bar < 1  (%1)\n"), bbt) << endmsg;
1724                 return 0;
1725         }
1726
1727         if (bbt.beats < 1) {
1728                 throw std::logic_error ("beats are counted from one");
1729         }
1730         Glib::Threads::RWLock::ReaderLock lm (lock);
1731
1732         return frame_time_locked (_metrics, bbt);
1733 }
1734
1735 bool
1736 TempoMap::check_solved (Metrics& metrics, bool by_frame)
1737 {
1738         TempoSection* prev_t = 0;
1739
1740         for (Metrics::const_iterator i = metrics.begin(); i != metrics.end(); ++i) {
1741                 TempoSection* t;
1742                 if ((t = dynamic_cast<TempoSection*> (*i)) != 0) {
1743                         if (!t->active()) {
1744                                 continue;
1745                         }
1746                         if (prev_t) {
1747                                 if ((by_frame && t->frame() < prev_t->frame()) || (!by_frame && t->pulse() < prev_t->pulse())) {
1748                                         return false;
1749                                 }
1750
1751                                 if (t->frame() == prev_t->frame()) {
1752                                         return false;
1753                                 }
1754
1755                                 /* precision check ensures pulses and frames align.*/
1756                                 if (t->frame() != prev_t->frame_at_pulse (t->pulse(), _frame_rate)) {
1757                                         return false;
1758                                 }
1759                         }
1760                         prev_t = t;
1761                 }
1762         }
1763
1764         return true;
1765 }
1766
1767 bool
1768 TempoMap::set_active_tempos (const Metrics& metrics, const framepos_t& frame)
1769 {
1770         for (Metrics::const_iterator i = metrics.begin(); i != metrics.end(); ++i) {
1771                 TempoSection* t;
1772                 if ((t = dynamic_cast<TempoSection*> (*i)) != 0) {
1773                         if (!t->movable()) {
1774                                 t->set_active (true);
1775                                 continue;
1776                         }
1777                         if (t->movable() && t->active () && t->position_lock_style() == AudioTime && t->frame() < frame) {
1778                                 t->set_active (false);
1779                                 t->set_pulse (0.0);
1780                         } else if (t->movable() && t->position_lock_style() == AudioTime && t->frame() > frame) {
1781                                 t->set_active (true);
1782                         } else if (t->movable() && t->position_lock_style() == AudioTime && t->frame() == frame) {
1783                                 return false;
1784                         }
1785                 }
1786         }
1787         return true;
1788 }
1789
1790 bool
1791 TempoMap::solve_map (Metrics& imaginary, TempoSection* section, const framepos_t& frame)
1792 {
1793         TempoSection* prev_t = 0;
1794         TempoSection* section_prev = 0;
1795         framepos_t first_m_frame = 0;
1796
1797         for (Metrics::iterator i = imaginary.begin(); i != imaginary.end(); ++i) {
1798                 MeterSection* m;
1799                 if ((m = dynamic_cast<MeterSection*> (*i)) != 0) {
1800                         if (!m->movable()) {
1801                                 first_m_frame = m->frame();
1802                                 break;
1803                         }
1804                 }
1805         }
1806         if (section->movable() && frame <= first_m_frame) {
1807                 return false;
1808         }
1809
1810         section->set_active (true);
1811         section->set_frame (frame);
1812
1813         for (Metrics::iterator i = imaginary.begin(); i != imaginary.end(); ++i) {
1814                 TempoSection* t;
1815                 if ((t = dynamic_cast<TempoSection*> (*i)) != 0) {
1816
1817                         if (!t->active()) {
1818                                 continue;
1819                         }
1820                         if (prev_t) {
1821                                 if (t == section) {
1822                                         section_prev = prev_t;
1823                                         continue;
1824                                 }
1825                                 if (t->position_lock_style() == MusicTime) {
1826                                         prev_t->set_c_func (prev_t->compute_c_func_pulse (t->pulses_per_minute(), t->pulse(), _frame_rate));
1827                                         t->set_frame (prev_t->frame_at_pulse (t->pulse(), _frame_rate));
1828                                 } else {
1829                                         prev_t->set_c_func (prev_t->compute_c_func_frame (t->pulses_per_minute(), t->frame(), _frame_rate));
1830                                         t->set_pulse (prev_t->pulse_at_frame (t->frame(), _frame_rate));
1831                                 }
1832                         }
1833                         prev_t = t;
1834                 }
1835         }
1836
1837         if (section_prev) {
1838                 section_prev->set_c_func (section_prev->compute_c_func_frame (section->pulses_per_minute(), frame, _frame_rate));
1839                 section->set_pulse (section_prev->pulse_at_frame (frame, _frame_rate));
1840         }
1841
1842         if (section->position_lock_style() == MusicTime) {
1843                 /* we're setting the frame */
1844                 section->set_position_lock_style (AudioTime);
1845                 recompute_tempos (imaginary);
1846                 section->set_position_lock_style (MusicTime);
1847         } else {
1848                 recompute_tempos (imaginary);
1849         }
1850
1851         if (check_solved (imaginary, true)) {
1852                 recompute_meters (imaginary);
1853                 return true;
1854         }
1855
1856         MetricSectionFrameSorter fcmp;
1857         imaginary.sort (fcmp);
1858         if (section->position_lock_style() == MusicTime) {
1859                 /* we're setting the frame */
1860                 section->set_position_lock_style (AudioTime);
1861                 recompute_tempos (imaginary);
1862                 section->set_position_lock_style (MusicTime);
1863         } else {
1864                 recompute_tempos (imaginary);
1865         }
1866
1867         if (check_solved (imaginary, true)) {
1868                 recompute_meters (imaginary);
1869                 return true;
1870         }
1871 #if (0)
1872         MetricSectionSorter cmp;
1873         imaginary.sort (cmp);
1874         if (section->position_lock_style() == MusicTime) {
1875                 /* we're setting the frame */
1876                 section->set_position_lock_style (AudioTime);
1877                 recompute_tempos (imaginary);
1878                 section->set_position_lock_style (MusicTime);
1879         } else {
1880                 recompute_tempos (imaginary);
1881         }
1882
1883         if (check_solved (imaginary, true)) {
1884                 recompute_meters (imaginary);
1885                 return true;
1886         }
1887 #endif
1888         //dump (imaginary, std::cerr);
1889
1890         return false;
1891 }
1892
1893 bool
1894 TempoMap::solve_map (Metrics& imaginary, TempoSection* section, const double& pulse)
1895 {
1896         TempoSection* prev_t = 0;
1897         TempoSection* section_prev = 0;
1898
1899         section->set_pulse (pulse);
1900
1901         for (Metrics::iterator i = imaginary.begin(); i != imaginary.end(); ++i) {
1902                 TempoSection* t;
1903                 if ((t = dynamic_cast<TempoSection*> (*i)) != 0) {
1904                         if (!t->active()) {
1905                                 continue;
1906                         }
1907                         if (!t->movable()) {
1908                                 t->set_pulse (0.0);
1909                                 prev_t = t;
1910                                 continue;
1911                         }
1912                         if (prev_t) {
1913                                 if (t == section) {
1914                                         section_prev = prev_t;
1915                                         continue;
1916                                 }
1917                                 if (t->position_lock_style() == MusicTime) {
1918                                         prev_t->set_c_func (prev_t->compute_c_func_pulse (t->pulses_per_minute(), t->pulse(), _frame_rate));
1919                                         t->set_frame (prev_t->frame_at_pulse (t->pulse(), _frame_rate));
1920                                 } else {
1921                                         prev_t->set_c_func (prev_t->compute_c_func_frame (t->pulses_per_minute(), t->frame(), _frame_rate));
1922                                         t->set_pulse (prev_t->pulse_at_frame (t->frame(), _frame_rate));
1923                                 }
1924                         }
1925                         prev_t = t;
1926                 }
1927         }
1928         if (section_prev) {
1929                 section_prev->set_c_func (section_prev->compute_c_func_pulse (section->pulses_per_minute(), pulse, _frame_rate));
1930                 section->set_frame (section_prev->frame_at_pulse (pulse, _frame_rate));
1931         }
1932
1933         if (section->position_lock_style() == AudioTime) {
1934                 /* we're setting the pulse */
1935                 section->set_position_lock_style (MusicTime);
1936                 recompute_tempos (imaginary);
1937                 section->set_position_lock_style (AudioTime);
1938         } else {
1939                 recompute_tempos (imaginary);
1940         }
1941
1942         if (check_solved (imaginary, false)) {
1943                 recompute_meters (imaginary);
1944                 return true;
1945         }
1946
1947         MetricSectionSorter cmp;
1948         imaginary.sort (cmp);
1949         if (section->position_lock_style() == AudioTime) {
1950                 /* we're setting the pulse */
1951                 section->set_position_lock_style (MusicTime);
1952                 recompute_tempos (imaginary);
1953                 section->set_position_lock_style (AudioTime);
1954         } else {
1955                 recompute_tempos (imaginary);
1956         }
1957
1958         if (check_solved (imaginary, false)) {
1959                 recompute_meters (imaginary);
1960                 return true;
1961         }
1962 #if (0)
1963         MetricSectionFrameSorter fcmp;
1964         imaginary.sort (fcmp);
1965         if (section->position_lock_style() == AudioTime) {
1966                 /* we're setting the pulse */
1967                 section->set_position_lock_style (MusicTime);
1968                 recompute_tempos (imaginary);
1969                 section->set_position_lock_style (AudioTime);
1970         } else {
1971                 recompute_tempos (imaginary);
1972         }
1973
1974         if (check_solved (imaginary, false)) {
1975                 recompute_meters (imaginary);
1976                 return true;
1977         }
1978 #endif
1979         //dump (imaginary, std::cerr);
1980
1981         return false;
1982 }
1983
1984 void
1985 TempoMap::solve_map (Metrics& imaginary, MeterSection* section, const framepos_t& frame)
1986 {
1987         MeterSection* prev_m = 0;
1988
1989         if (!section->movable()) {
1990                 /* lock the first tempo to our first meter */
1991                 if (!set_active_tempos (imaginary, frame)) {
1992                         return;
1993                 }
1994                 TempoSection* first_t = &first_tempo();
1995                 Metrics future_map;
1996                 TempoSection* new_section = copy_metrics_and_point (future_map, first_t);
1997
1998                 new_section->set_frame (frame);
1999                 new_section->set_pulse (0.0);
2000                 new_section->set_active (true);
2001
2002                 if (solve_map (future_map, new_section, frame)) {
2003                         first_t->set_frame (frame);
2004                         first_t->set_pulse (0.0);
2005                         first_t->set_active (true);
2006                         solve_map (imaginary, first_t, frame);
2007                 } else {
2008                         return;
2009                 }
2010         }
2011
2012         section->set_frame (frame);
2013
2014         for (Metrics::iterator i = imaginary.begin(); i != imaginary.end(); ++i) {
2015                 MeterSection* m;
2016                 if ((m = dynamic_cast<MeterSection*> (*i)) != 0) {
2017                         if (m == section){
2018                                 /*
2019                                   here we set the beat for this frame.
2020                                   we set it 'incorrectly' to the next bar's first beat
2021                                   and use the delat to find the meter's pulse.
2022                                 */
2023                                 double new_pulse = 0.0;
2024                                 pair<double, BBT_Time> b_bbt;
2025
2026                                 if (section->movable()) {
2027                                         const double beats = ((pulse_at_frame_locked (imaginary, frame) - prev_m->pulse()) * prev_m->note_divisor());
2028                                         const double floor_beats = beats - fmod (beats,  prev_m->divisions_per_bar());
2029                                         b_bbt = make_pair (floor_beats + prev_m->beat(), BBT_Time ((floor_beats / prev_m->divisions_per_bar()) + prev_m->bbt().bars, 1, 0));
2030                                         const double true_pulse = prev_m->pulse() + (floor_beats / prev_m->note_divisor());
2031                                         const double pulse_off = true_pulse - (beats / prev_m->note_divisor()) - prev_m->pulse();
2032                                         new_pulse = true_pulse - pulse_off;
2033                                 } else {
2034                                         b_bbt = make_pair (0.0, BBT_Time (1, 1, 0));
2035                                 }
2036
2037                                 section->set_beat (b_bbt);
2038                                 section->set_pulse (new_pulse);
2039                                 prev_m = m;
2040
2041                                 continue;
2042                         }
2043                         if (prev_m) {
2044                                 double new_pulse = 0.0;
2045                                 if (m->position_lock_style() == MusicTime) {
2046                                         new_pulse = prev_m->pulse() + ((m->bbt().bars - prev_m->bbt().bars) *  prev_m->divisions_per_bar() / prev_m->note_divisor());
2047                                         m->set_frame (frame_at_pulse_locked (imaginary, new_pulse));
2048                                         if (m->frame() > section->frame()) {
2049                                                 /* moving 'section' will affect later meters' beat (but not bbt).*/
2050                                                 pair<double, BBT_Time> new_beat (((new_pulse - prev_m->pulse()) * prev_m->note_divisor()) + prev_m->beat(), m->bbt());
2051                                                 m->set_beat (new_beat);
2052                                         }
2053                                 } else {
2054                                         pair<double, BBT_Time> b_bbt;
2055                                         if (m->movable()) {
2056                                                 const double beats = ((pulse_at_frame_locked (imaginary, m->frame()) - prev_m->pulse()) * prev_m->note_divisor());
2057                                                 const double floor_beats = beats - fmod (beats , prev_m->divisions_per_bar());
2058                                                 b_bbt = make_pair (floor_beats + prev_m->beat()
2059                                                                    , BBT_Time ((floor_beats / prev_m->divisions_per_bar()) + prev_m->bbt().bars, 1, 0));
2060                                                 const double true_pulse = prev_m->pulse() + (floor_beats / prev_m->note_divisor());
2061                                                 const double pulse_off = true_pulse - (beats / prev_m->note_divisor()) - prev_m->pulse();
2062                                                 new_pulse = true_pulse - pulse_off;
2063                                         } else {
2064                                                 b_bbt = make_pair (0.0, BBT_Time (1, 1, 0));
2065                                                 new_pulse = 0.0;
2066                                         }
2067                                         m->set_beat (b_bbt);
2068                                 }
2069                                 m->set_pulse (new_pulse);
2070                         }
2071                         prev_m = m;
2072                 }
2073         }
2074
2075         MetricSectionFrameSorter fcmp;
2076         imaginary.sort (fcmp);
2077         if (section->position_lock_style() == MusicTime) {
2078                 /* we're setting the frame */
2079                 section->set_position_lock_style (AudioTime);
2080                 recompute_meters (imaginary);
2081                 section->set_position_lock_style (MusicTime);
2082         } else {
2083                 recompute_meters (imaginary);
2084         }
2085         //dump (imaginary, std::cerr);
2086 }
2087
2088 void
2089 TempoMap::solve_map (Metrics& imaginary, MeterSection* section, const double& pulse)
2090 {
2091         MeterSection* prev_m = 0;
2092         MeterSection* section_prev = 0;
2093
2094         section->set_pulse (pulse);
2095
2096         for (Metrics::iterator i = imaginary.begin(); i != imaginary.end(); ++i) {
2097                 MeterSection* m;
2098                 if ((m = dynamic_cast<MeterSection*> (*i)) != 0) {
2099                         if (m == section){
2100                                 section_prev = prev_m;
2101                                 continue;
2102                         }
2103                         if (prev_m) {
2104                                 double new_pulse = 0.0;
2105                                 if (m->position_lock_style() == MusicTime) {
2106                                         new_pulse = prev_m->pulse() + ((m->bbt().bars - prev_m->bbt().bars) *  prev_m->divisions_per_bar() / prev_m->note_divisor());
2107                                         m->set_frame (frame_at_pulse_locked (imaginary, new_pulse));
2108
2109                                         if (new_pulse > section->pulse()) {
2110                                                 /* moving 'section' will affect later meters' beat (but not bbt).*/
2111                                                 pair<double, BBT_Time> new_beat (((new_pulse - prev_m->pulse()) * prev_m->note_divisor()) + prev_m->beat(), m->bbt());
2112                                                 m->set_beat (new_beat);
2113                                         }
2114                                 } else {
2115                                         pair<double, BBT_Time> b_bbt;
2116                                         if (m->movable()) {
2117                                                 const double beats = ((pulse_at_frame_locked (imaginary, m->frame()) - prev_m->pulse()) * prev_m->note_divisor());
2118                                                 const double floor_beats = beats - fmod (beats, prev_m->divisions_per_bar());
2119                                                 b_bbt = make_pair (floor_beats + prev_m->beat()
2120                                                                    , BBT_Time ((floor_beats / prev_m->divisions_per_bar()) + prev_m->bbt().bars, 1, 0));
2121                                                 const double true_pulse = prev_m->pulse() + (floor_beats / prev_m->note_divisor());
2122                                                 const double pulse_off = true_pulse - (beats / prev_m->note_divisor()) - prev_m->pulse();
2123                                                 new_pulse = true_pulse - pulse_off;
2124                                         } else {
2125                                                 b_bbt = make_pair (0.0, BBT_Time (1, 1, 0));
2126                                         }
2127                                         m->set_beat (b_bbt);
2128                                 }
2129                                 m->set_pulse (new_pulse);
2130                         }
2131                         prev_m = m;
2132                 }
2133         }
2134
2135         if (section_prev) {
2136                 const double beats = ((pulse - section_prev->pulse()) * section_prev->note_divisor());
2137                 const int32_t bars = (beats + 1) / section_prev->divisions_per_bar();
2138                 pair<double, BBT_Time> b_bbt = make_pair (beats + section_prev->beat(), BBT_Time (bars + section_prev->bbt().bars, 1, 0));
2139                 section->set_beat (b_bbt);
2140                 section->set_frame (frame_at_pulse_locked (imaginary, pulse));
2141         }
2142
2143         MetricSectionSorter cmp;
2144         imaginary.sort (cmp);
2145         if (section->position_lock_style() == AudioTime) {
2146                 /* we're setting the pulse */
2147                 section->set_position_lock_style (MusicTime);
2148                 recompute_meters (imaginary);
2149                 section->set_position_lock_style (AudioTime);
2150         } else {
2151                 recompute_meters (imaginary);
2152         }
2153 }
2154
2155 /** places a copy of _metrics into copy and returns a pointer
2156  *  to section's equivalent in copy.
2157  */
2158 TempoSection*
2159 TempoMap::copy_metrics_and_point (Metrics& copy, TempoSection* section)
2160 {
2161         TempoSection* t;
2162         MeterSection* m;
2163         TempoSection* ret = 0;
2164
2165         for (Metrics::iterator i = _metrics.begin(); i != _metrics.end(); ++i) {
2166                 if ((t = dynamic_cast<TempoSection*> (*i)) != 0) {
2167                         if (t == section) {
2168                                 if (t->position_lock_style() == MusicTime) {
2169                                         ret = new TempoSection (t->pulse(), t->beats_per_minute(), t->note_type(), t->type());
2170                                         ret->set_frame (t->frame());
2171                                 } else {
2172                                         ret = new TempoSection (t->frame(), t->beats_per_minute(), t->note_type(), t->type());
2173                                         ret->set_pulse (t->pulse());
2174                                 }
2175                                 ret->set_active (t->active());
2176                                 ret->set_movable (t->movable());
2177                                 copy.push_back (ret);
2178                                 continue;
2179                         }
2180                         TempoSection* cp = 0;
2181                         if (t->position_lock_style() == MusicTime) {
2182                                 cp = new TempoSection (t->pulse(), t->beats_per_minute(), t->note_type(), t->type());
2183                                 cp->set_frame (t->frame());
2184                         } else {
2185                                 cp = new TempoSection (t->frame(), t->beats_per_minute(), t->note_type(), t->type());
2186                                 cp->set_pulse (t->pulse());
2187                         }
2188                         cp->set_active (t->active());
2189                         cp->set_movable (t->movable());
2190                         copy.push_back (cp);
2191                 }
2192                 if ((m = dynamic_cast<MeterSection *> (*i)) != 0) {
2193                         MeterSection* cp = 0;
2194                         if (m->position_lock_style() == MusicTime) {
2195                                 cp = new MeterSection (m->pulse(), m->beat(), m->bbt(), m->divisions_per_bar(), m->note_divisor());
2196                                 cp->set_frame (m->frame());
2197                         } else {
2198                                 cp = new MeterSection (m->frame(), m->beat(), m->bbt(), m->divisions_per_bar(), m->note_divisor());
2199                                 cp->set_pulse (m->pulse());
2200                         }
2201                         cp->set_movable (m->movable());
2202                         copy.push_back (cp);
2203                 }
2204         }
2205
2206         return ret;
2207 }
2208
2209 bool
2210 TempoMap::can_solve_bbt (TempoSection* ts, const BBT_Time& bbt)
2211 {
2212         Metrics copy;
2213         TempoSection* new_section = 0;
2214
2215         {
2216                 Glib::Threads::RWLock::ReaderLock lm (lock);
2217                 new_section = copy_metrics_and_point (copy, ts);
2218         }
2219
2220         double const beat = bbt_to_beats_locked (copy, bbt);
2221         bool ret = solve_map (copy, new_section, pulse_at_beat_locked (copy, beat));
2222
2223         Metrics::const_iterator d = copy.begin();
2224         while (d != copy.end()) {
2225                 delete (*d);
2226                 ++d;
2227         }
2228
2229         return ret;
2230 }
2231
2232 /**
2233 * This is for a gui that needs to know the frame of a tempo section if it were to be moved to some bbt time,
2234 * taking any possible reordering as a consequence of this into account.
2235 * @param section - the section to be altered
2236 * @param bpm - the new Tempo
2237 * @param bbt - the bbt where the altered tempo will fall
2238 * @return returns - the position in frames where the new tempo section will lie.
2239 */
2240 framepos_t
2241 TempoMap::predict_tempo_frame (TempoSection* section, const BBT_Time& bbt)
2242 {
2243         Glib::Threads::RWLock::ReaderLock lm (lock);
2244         Metrics future_map;
2245         framepos_t ret = 0;
2246         TempoSection* new_section = copy_metrics_and_point (future_map, section);
2247
2248         const double beat = bbt_to_beats_locked (future_map, bbt);
2249
2250         if (solve_map (future_map, new_section, pulse_at_beat_locked (future_map, beat))) {
2251                 ret = new_section->frame();
2252         } else {
2253                 ret = frame_at_beat_locked (_metrics, beat);
2254         }
2255
2256         Metrics::const_iterator d = future_map.begin();
2257         while (d != future_map.end()) {
2258                 delete (*d);
2259                 ++d;
2260         }
2261         return ret;
2262 }
2263
2264 double
2265 TempoMap::predict_tempo_pulse (TempoSection* section, const framepos_t& frame)
2266 {
2267         Glib::Threads::RWLock::ReaderLock lm (lock);
2268         Metrics future_map;
2269         double ret = 0.0;
2270         TempoSection* new_section = copy_metrics_and_point (future_map, section);
2271
2272         if (solve_map (future_map, new_section, frame)) {
2273                 ret = new_section->pulse();
2274         } else {
2275                 ret = pulse_at_frame_locked (_metrics, frame);
2276         }
2277
2278         Metrics::const_iterator d = future_map.begin();
2279         while (d != future_map.end()) {
2280                 delete (*d);
2281                 ++d;
2282         }
2283         return ret;
2284 }
2285
2286 void
2287 TempoMap::gui_move_tempo_frame (TempoSection* ts, const framepos_t& frame)
2288 {
2289         Metrics future_map;
2290         {
2291                 Glib::Threads::RWLock::WriterLock lm (lock);
2292                 TempoSection* new_section = copy_metrics_and_point (future_map, ts);
2293                 if (solve_map (future_map, new_section, frame)) {
2294                         solve_map (_metrics, ts, frame);
2295                 }
2296         }
2297
2298         Metrics::const_iterator d = future_map.begin();
2299         while (d != future_map.end()) {
2300                 delete (*d);
2301                 ++d;
2302         }
2303
2304         MetricPositionChanged (); // Emit Signal
2305 }
2306
2307 void
2308 TempoMap::gui_move_tempo_beat (TempoSection* ts, const double& beat)
2309 {
2310         Metrics future_map;
2311         {
2312                 Glib::Threads::RWLock::WriterLock lm (lock);
2313                 TempoSection* new_section = copy_metrics_and_point (future_map, ts);
2314                 if (solve_map (future_map, new_section, pulse_at_beat_locked (future_map, beat))) {
2315                         solve_map (_metrics, ts, pulse_at_beat_locked (_metrics, beat));
2316                 }
2317         }
2318
2319         Metrics::const_iterator d = future_map.begin();
2320         while (d != future_map.end()) {
2321                 delete (*d);
2322                 ++d;
2323         }
2324
2325         MetricPositionChanged (); // Emit Signal
2326 }
2327
2328 void
2329 TempoMap::gui_move_meter (MeterSection* ms, const framepos_t&  frame)
2330 {
2331         {
2332                 Glib::Threads::RWLock::WriterLock lm (lock);
2333                 solve_map (_metrics, ms, frame);
2334         }
2335
2336         MetricPositionChanged (); // Emit Signal
2337 }
2338
2339 void
2340 TempoMap::gui_move_meter (MeterSection* ms, const double&  beat)
2341 {
2342         {
2343                 Glib::Threads::RWLock::WriterLock lm (lock);
2344                 solve_map (_metrics, ms, pulse_at_beat_locked (_metrics, beat));
2345         }
2346
2347         MetricPositionChanged (); // Emit Signal
2348 }
2349
2350 bool
2351 TempoMap::gui_change_tempo (TempoSection* ts, const Tempo& bpm)
2352 {
2353         Metrics future_map;
2354         bool can_solve = false;
2355         {
2356                 Glib::Threads::RWLock::WriterLock lm (lock);
2357                 TempoSection* new_section = copy_metrics_and_point (future_map, ts);
2358                 new_section->set_beats_per_minute (bpm.beats_per_minute());
2359                 recompute_tempos (future_map);
2360
2361                 if (check_solved (future_map, true)) {
2362                         ts->set_beats_per_minute (bpm.beats_per_minute());
2363                         recompute_map (_metrics);
2364                         can_solve = true;
2365                 }
2366         }
2367
2368         Metrics::const_iterator d = future_map.begin();
2369         while (d != future_map.end()) {
2370                 delete (*d);
2371                 ++d;
2372         }
2373         if (can_solve) {
2374                 MetricPositionChanged (); // Emit Signal
2375         }
2376         return can_solve;
2377 }
2378
2379 framecnt_t
2380 TempoMap::bbt_duration_at (framepos_t pos, const BBT_Time& bbt, int dir)
2381 {
2382         Glib::Threads::RWLock::ReaderLock lm (lock);
2383
2384         const double tick_at_time = beat_at_frame_locked (_metrics, pos) * BBT_Time::ticks_per_beat;
2385         const double bbt_ticks = bbt.ticks + (bbt.beats * BBT_Time::ticks_per_beat);
2386         const double total_beats = (tick_at_time + bbt_ticks) / BBT_Time::ticks_per_beat;
2387
2388         return frame_at_beat_locked (_metrics, total_beats);
2389 }
2390
2391 framepos_t
2392 TempoMap::round_to_bar (framepos_t fr, RoundMode dir)
2393 {
2394         return round_to_type (fr, dir, Bar);
2395 }
2396
2397 framepos_t
2398 TempoMap::round_to_beat (framepos_t fr, RoundMode dir)
2399 {
2400         return round_to_type (fr, dir, Beat);
2401 }
2402
2403 framepos_t
2404 TempoMap::round_to_beat_subdivision (framepos_t fr, int sub_num, RoundMode dir)
2405 {
2406         Glib::Threads::RWLock::ReaderLock lm (lock);
2407         uint32_t ticks = (uint32_t) floor (beat_at_frame_locked (_metrics, fr) * BBT_Time::ticks_per_beat);
2408         uint32_t beats = (uint32_t) floor (ticks / BBT_Time::ticks_per_beat);
2409         uint32_t ticks_one_subdivisions_worth = (uint32_t) BBT_Time::ticks_per_beat / sub_num;
2410
2411         ticks -= beats * BBT_Time::ticks_per_beat;
2412
2413         if (dir > 0) {
2414                 /* round to next (or same iff dir == RoundUpMaybe) */
2415
2416                 uint32_t mod = ticks % ticks_one_subdivisions_worth;
2417
2418                 if (mod == 0 && dir == RoundUpMaybe) {
2419                         /* right on the subdivision, which is fine, so do nothing */
2420
2421                 } else if (mod == 0) {
2422                         /* right on the subdivision, so the difference is just the subdivision ticks */
2423                         ticks += ticks_one_subdivisions_worth;
2424
2425                 } else {
2426                         /* not on subdivision, compute distance to next subdivision */
2427
2428                         ticks += ticks_one_subdivisions_worth - mod;
2429                 }
2430
2431                 if (ticks >= BBT_Time::ticks_per_beat) {
2432                         ticks -= BBT_Time::ticks_per_beat;
2433                 }
2434         } else if (dir < 0) {
2435
2436                 /* round to previous (or same iff dir == RoundDownMaybe) */
2437
2438                 uint32_t difference = ticks % ticks_one_subdivisions_worth;
2439
2440                 if (difference == 0 && dir == RoundDownAlways) {
2441                         /* right on the subdivision, but force-rounding down,
2442                            so the difference is just the subdivision ticks */
2443                         difference = ticks_one_subdivisions_worth;
2444                 }
2445
2446                 if (ticks < difference) {
2447                         ticks = BBT_Time::ticks_per_beat - ticks;
2448                 } else {
2449                         ticks -= difference;
2450                 }
2451
2452         } else {
2453                 /* round to nearest */
2454                 double rem;
2455
2456                 /* compute the distance to the previous and next subdivision */
2457
2458                 if ((rem = fmod ((double) ticks, (double) ticks_one_subdivisions_worth)) > ticks_one_subdivisions_worth/2.0) {
2459
2460                         /* closer to the next subdivision, so shift forward */
2461
2462                         ticks = lrint (ticks + (ticks_one_subdivisions_worth - rem));
2463
2464                         DEBUG_TRACE (DEBUG::SnapBBT, string_compose ("moved forward to %1\n", ticks));
2465
2466                         if (ticks > BBT_Time::ticks_per_beat) {
2467                                 ++beats;
2468                                 ticks -= BBT_Time::ticks_per_beat;
2469                                 DEBUG_TRACE (DEBUG::SnapBBT, string_compose ("fold beat to %1\n", beats));
2470                         }
2471
2472                 } else if (rem > 0) {
2473
2474                         /* closer to previous subdivision, so shift backward */
2475
2476                         if (rem > ticks) {
2477                                 if (beats == 0) {
2478                                         /* can't go backwards past zero, so ... */
2479                                         return 0;
2480                                 }
2481                                 /* step back to previous beat */
2482                                 --beats;
2483                                 ticks = lrint (BBT_Time::ticks_per_beat - rem);
2484                                 DEBUG_TRACE (DEBUG::SnapBBT, string_compose ("step back beat to %1\n", beats));
2485                         } else {
2486                                 ticks = lrint (ticks - rem);
2487                                 DEBUG_TRACE (DEBUG::SnapBBT, string_compose ("moved backward to %1\n", ticks));
2488                         }
2489                 } else {
2490                         /* on the subdivision, do nothing */
2491                 }
2492         }
2493
2494         const framepos_t ret_frame = frame_at_beat_locked (_metrics, beats + (ticks / BBT_Time::ticks_per_beat));
2495
2496         return ret_frame;
2497 }
2498
2499 void
2500 TempoMap::round_bbt (BBT_Time& when, const int32_t& sub_num)
2501 {
2502         if (sub_num == -1) {
2503                 const double bpb = meter_section_at (bbt_to_beats_locked (_metrics, when)).divisions_per_bar();
2504                 if ((double) when.beats > bpb / 2.0) {
2505                         ++when.bars;
2506                 }
2507                 when.beats = 1;
2508                 when.ticks = 0;
2509                 return;
2510         } else if (sub_num == 0) {
2511                 const double bpb = meter_section_at (bbt_to_beats_locked (_metrics, when)).divisions_per_bar();
2512                 if ((double) when.ticks > BBT_Time::ticks_per_beat / 2.0) {
2513                         ++when.beats;
2514                         while ((double) when.beats > bpb) {
2515                                 ++when.bars;
2516                                 when.beats -= (uint32_t) floor (bpb);
2517                         }
2518                 }
2519                 when.ticks = 0;
2520                 return;
2521         }
2522         const uint32_t ticks_one_subdivisions_worth = BBT_Time::ticks_per_beat / sub_num;
2523         double rem;
2524         if ((rem = fmod ((double) when.ticks, (double) ticks_one_subdivisions_worth)) > (ticks_one_subdivisions_worth / 2.0)) {
2525                 /* closer to the next subdivision, so shift forward */
2526
2527                 when.ticks = when.ticks + (ticks_one_subdivisions_worth - rem);
2528
2529                 if (when.ticks > Timecode::BBT_Time::ticks_per_beat) {
2530                         ++when.beats;
2531                         when.ticks -= Timecode::BBT_Time::ticks_per_beat;
2532                 }
2533
2534         } else if (rem > 0) {
2535                 /* closer to previous subdivision, so shift backward */
2536
2537                 if (rem > when.ticks) {
2538                         if (when.beats == 0) {
2539                                 /* can't go backwards past zero, so ... */
2540                         }
2541                         /* step back to previous beat */
2542                         --when.beats;
2543                         when.ticks = Timecode::BBT_Time::ticks_per_beat - rem;
2544                 } else {
2545                         when.ticks = when.ticks - rem;
2546                 }
2547         }
2548 }
2549
2550 framepos_t
2551 TempoMap::round_to_type (framepos_t frame, RoundMode dir, BBTPointType type)
2552 {
2553         Glib::Threads::RWLock::ReaderLock lm (lock);
2554
2555         const double beat_at_framepos = beat_at_frame_locked (_metrics, frame);
2556         BBT_Time bbt (beats_to_bbt_locked (_metrics, beat_at_framepos));
2557
2558         switch (type) {
2559         case Bar:
2560                 if (dir < 0) {
2561                         /* find bar previous to 'frame' */
2562                         bbt.beats = 1;
2563                         bbt.ticks = 0;
2564                         return frame_time_locked (_metrics, bbt);
2565
2566                 } else if (dir > 0) {
2567                         /* find bar following 'frame' */
2568                         ++bbt.bars;
2569                         bbt.beats = 1;
2570                         bbt.ticks = 0;
2571                         return frame_time_locked (_metrics, bbt);
2572                 } else {
2573                         /* true rounding: find nearest bar */
2574                         framepos_t raw_ft = frame_time_locked (_metrics, bbt);
2575                         bbt.beats = 1;
2576                         bbt.ticks = 0;
2577                         framepos_t prev_ft = frame_time_locked (_metrics, bbt);
2578                         ++bbt.bars;
2579                         framepos_t next_ft = frame_time_locked (_metrics, bbt);
2580
2581                         if ((raw_ft - prev_ft) > (next_ft - prev_ft) / 2) { 
2582                                 return next_ft;
2583                         } else {
2584                                 return prev_ft;
2585                         }
2586                 }
2587
2588                 break;
2589
2590         case Beat:
2591                 if (dir < 0) {
2592                         return frame_at_beat_locked (_metrics, floor (beat_at_framepos));
2593                 } else if (dir > 0) {
2594                         return frame_at_beat_locked (_metrics, ceil (beat_at_framepos));
2595                 } else {
2596                         return frame_at_beat_locked (_metrics, floor (beat_at_framepos + 0.5));
2597                 }
2598                 break;
2599         }
2600
2601         return 0;
2602 }
2603
2604 void
2605 TempoMap::get_grid (vector<TempoMap::BBTPoint>& points,
2606                     framepos_t lower, framepos_t upper)
2607 {
2608         Glib::Threads::RWLock::ReaderLock lm (lock);
2609         const int32_t upper_beat = (int32_t) ceil (beat_at_frame_locked (_metrics, upper));
2610         int32_t cnt = floor (beat_at_frame_locked (_metrics, lower));
2611         /* although the map handles negative beats, bbt doesn't. */
2612         if (cnt < 0.0) {
2613                 cnt = 0.0;
2614         }
2615         while (cnt <= upper_beat) {
2616                 framecnt_t pos = frame_at_beat_locked (_metrics, cnt);
2617                 const TempoSection tempo = tempo_section_at_locked (pos);
2618                 const MeterSection meter = meter_section_at_locked (pos);
2619                 const BBT_Time bbt = beats_to_bbt (cnt);
2620                 points.push_back (BBTPoint (meter, tempo_at_locked (pos), pos, bbt.bars, bbt.beats, tempo.c_func()));
2621                 ++cnt;
2622         }
2623 }
2624
2625 const TempoSection&
2626 TempoMap::tempo_section_at (framepos_t frame) const
2627 {
2628         Glib::Threads::RWLock::ReaderLock lm (lock);
2629         return tempo_section_at_locked (frame);
2630 }
2631
2632 const TempoSection&
2633 TempoMap::tempo_section_at_locked (framepos_t frame) const
2634 {
2635         Metrics::const_iterator i;
2636         TempoSection* prev = 0;
2637
2638         for (i = _metrics.begin(); i != _metrics.end(); ++i) {
2639                 TempoSection* t;
2640
2641                 if ((t = dynamic_cast<TempoSection*> (*i)) != 0) {
2642                         if (!t->active()) {
2643                                 continue;
2644                         }
2645                         if (t->frame() > frame) {
2646                                 break;
2647                         }
2648
2649                         prev = t;
2650                 }
2651         }
2652
2653         if (prev == 0) {
2654                 fatal << endmsg;
2655                 abort(); /*NOTREACHED*/
2656         }
2657
2658         return *prev;
2659 }
2660
2661
2662 /* don't use this to calculate length (the tempo is only correct for this frame).
2663    do that stuff based on the beat_at_frame and frame_at_beat api
2664 */
2665 double
2666 TempoMap::frames_per_beat_at (const framepos_t& frame, const framecnt_t& sr) const
2667 {
2668         Glib::Threads::RWLock::ReaderLock lm (lock);
2669
2670         const TempoSection* ts_at = &tempo_section_at_locked (frame);
2671         const TempoSection* ts_after = 0;
2672         Metrics::const_iterator i;
2673
2674         for (i = _metrics.begin(); i != _metrics.end(); ++i) {
2675                 TempoSection* t;
2676
2677                 if ((t = dynamic_cast<TempoSection*> (*i)) != 0) {
2678                         if (!t->active()) {
2679                                 continue;
2680                         }
2681                         if ((*i)->frame() > frame) {
2682                                 ts_after = t;
2683                                 break;
2684                         }
2685                 }
2686         }
2687
2688         if (ts_after) {
2689                 return  (60.0 * _frame_rate) / (ts_at->tempo_at_frame (frame, _frame_rate));
2690         }
2691         /* must be treated as constant tempo */
2692         return ts_at->frames_per_beat (_frame_rate);
2693 }
2694
2695 const Tempo
2696 TempoMap::tempo_at (const framepos_t& frame) const
2697 {
2698         Glib::Threads::RWLock::ReaderLock lm (lock);
2699         return tempo_at_locked (frame);
2700 }
2701
2702 const Tempo
2703 TempoMap::tempo_at_locked (const framepos_t& frame) const
2704 {
2705         TempoSection* prev_t = 0;
2706
2707         Metrics::const_iterator i;
2708
2709         for (i = _metrics.begin(); i != _metrics.end(); ++i) {
2710                 TempoSection* t;
2711                 if ((t = dynamic_cast<TempoSection*> (*i)) != 0) {
2712                         if (!t->active()) {
2713                                 continue;
2714                         }
2715                         if ((prev_t) && t->frame() > frame) {
2716                                 /* t is the section past frame */
2717                                 const double ret_bpm = prev_t->tempo_at_frame (frame, _frame_rate) * prev_t->note_type();
2718                                 const Tempo ret_tempo (ret_bpm, prev_t->note_type());
2719                                 return ret_tempo;
2720                         }
2721                         prev_t = t;
2722                 }
2723         }
2724
2725         const double ret = prev_t->beats_per_minute();
2726         const Tempo ret_tempo (ret, prev_t->note_type ());
2727
2728         return ret_tempo;
2729 }
2730
2731 const MeterSection&
2732 TempoMap::meter_section_at (framepos_t frame) const
2733 {
2734         Glib::Threads::RWLock::ReaderLock lm (lock);
2735         return meter_section_at_locked (frame);
2736 }
2737
2738 const MeterSection&
2739 TempoMap::meter_section_at_locked (framepos_t frame) const
2740 {
2741         Metrics::const_iterator i;
2742         MeterSection* prev = 0;
2743
2744         for (i = _metrics.begin(); i != _metrics.end(); ++i) {
2745                 MeterSection* m;
2746
2747                 if ((m = dynamic_cast<MeterSection*> (*i)) != 0) {
2748
2749                         if (prev && (*i)->frame() > frame) {
2750                                 break;
2751                         }
2752
2753                         prev = m;
2754                 }
2755         }
2756
2757         if (prev == 0) {
2758                 fatal << endmsg;
2759                 abort(); /*NOTREACHED*/
2760         }
2761
2762         return *prev;
2763 }
2764
2765 const Meter&
2766 TempoMap::meter_at (framepos_t frame) const
2767 {
2768         TempoMetric m (metric_at (frame));
2769         return m.meter();
2770 }
2771
2772 const MeterSection&
2773 TempoMap::meter_section_at (const double& beat) const
2774 {
2775         MeterSection* prev_m = 0;
2776         Glib::Threads::RWLock::ReaderLock lm (lock);
2777
2778         for (Metrics::const_iterator i = _metrics.begin(); i != _metrics.end(); ++i) {
2779                 MeterSection* m;
2780                 if ((m = dynamic_cast<MeterSection*> (*i)) != 0) {
2781                         if (prev_m && m->beat() > beat) {
2782                                 break;
2783                         }
2784                         prev_m = m;
2785                 }
2786
2787         }
2788         return *prev_m;
2789 }
2790
2791 void
2792 TempoMap::fix_legacy_session ()
2793 {
2794         MeterSection* prev_m = 0;
2795         TempoSection* prev_t = 0;
2796
2797         for (Metrics::iterator i = _metrics.begin(); i != _metrics.end(); ++i) {
2798                 MeterSection* m;
2799                 TempoSection* t;
2800
2801                 if ((m = dynamic_cast<MeterSection*>(*i)) != 0) {
2802                         if (!m->movable()) {
2803                                 pair<double, BBT_Time> bbt = make_pair (0.0, BBT_Time (1, 1, 0));
2804                                 m->set_beat (bbt);
2805                                 m->set_pulse (0.0);
2806                                 m->set_frame (0);
2807                                 m->set_position_lock_style (AudioTime);
2808                                 prev_m = m;
2809                                 continue;
2810                         }
2811                         if (prev_m) {
2812                                 pair<double, BBT_Time> start = make_pair (((m->bbt().bars - 1) * prev_m->note_divisor())
2813                                                                           + (m->bbt().beats - 1)
2814                                                                           + (m->bbt().ticks / BBT_Time::ticks_per_beat)
2815                                                                           , m->bbt());
2816                                 m->set_beat (start);
2817                                 const double start_beat = ((m->bbt().bars - 1) * prev_m->note_divisor())
2818                                         + (m->bbt().beats - 1)
2819                                         + (m->bbt().ticks / BBT_Time::ticks_per_beat);
2820                                 m->set_pulse (start_beat / prev_m->note_divisor());
2821                         }
2822                         prev_m = m;
2823                 } else if ((t = dynamic_cast<TempoSection*>(*i)) != 0) {
2824
2825                         if (!t->active()) {
2826                                 continue;
2827                         }
2828
2829                         if (!t->movable()) {
2830                                 t->set_pulse (0.0);
2831                                 t->set_frame (0);
2832                                 t->set_position_lock_style (AudioTime);
2833                                 prev_t = t;
2834                                 continue;
2835                         }
2836
2837                         if (prev_t) {
2838                                 const double beat = ((t->legacy_bbt().bars - 1) * ((prev_m) ? prev_m->note_divisor() : 4.0))
2839                                         + (t->legacy_bbt().beats - 1)
2840                                         + (t->legacy_bbt().ticks / BBT_Time::ticks_per_beat);
2841                                 if (prev_m) {
2842                                         t->set_pulse (beat / prev_m->note_divisor());
2843                                 } else {
2844                                         /* really shouldn't happen but.. */
2845                                         t->set_pulse (beat / 4.0);
2846                                 }
2847                         }
2848                         prev_t = t;
2849                 }
2850         }
2851 }
2852
2853 XMLNode&
2854 TempoMap::get_state ()
2855 {
2856         Metrics::const_iterator i;
2857         XMLNode *root = new XMLNode ("TempoMap");
2858
2859         {
2860                 Glib::Threads::RWLock::ReaderLock lm (lock);
2861                 for (i = _metrics.begin(); i != _metrics.end(); ++i) {
2862                         root->add_child_nocopy ((*i)->get_state());
2863                 }
2864         }
2865
2866         return *root;
2867 }
2868
2869 int
2870 TempoMap::set_state (const XMLNode& node, int /*version*/)
2871 {
2872         {
2873                 Glib::Threads::RWLock::WriterLock lm (lock);
2874
2875                 XMLNodeList nlist;
2876                 XMLNodeConstIterator niter;
2877                 Metrics old_metrics (_metrics);
2878                 _metrics.clear();
2879
2880                 nlist = node.children();
2881
2882                 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
2883                         XMLNode* child = *niter;
2884
2885                         if (child->name() == TempoSection::xml_state_node_name) {
2886
2887                                 try {
2888                                         TempoSection* ts = new TempoSection (*child);
2889                                         _metrics.push_back (ts);
2890                                 }
2891
2892                                 catch (failed_constructor& err){
2893                                         error << _("Tempo map: could not set new state, restoring old one.") << endmsg;
2894                                         _metrics = old_metrics;
2895                                         break;
2896                                 }
2897
2898                         } else if (child->name() == MeterSection::xml_state_node_name) {
2899
2900                                 try {
2901                                         MeterSection* ms = new MeterSection (*child);
2902                                         _metrics.push_back (ms);
2903                                 }
2904
2905                                 catch (failed_constructor& err) {
2906                                         error << _("Tempo map: could not set new state, restoring old one.") << endmsg;
2907                                         _metrics = old_metrics;
2908                                         break;
2909                                 }
2910                         }
2911                 }
2912
2913                 if (niter == nlist.end()) {
2914                         MetricSectionSorter cmp;
2915                         _metrics.sort (cmp);
2916                 }
2917
2918                 /* check for legacy sessions where bbt was the base musical unit for tempo */
2919                 for (Metrics::const_iterator i = _metrics.begin(); i != _metrics.end(); ++i) {
2920                         TempoSection* t;
2921                         if ((t = dynamic_cast<TempoSection*> (*i)) != 0) {
2922                                 if (t->legacy_bbt().bars != 0) {
2923                                         fix_legacy_session();
2924                                         break;
2925                                 }
2926                                 break;
2927                         }
2928                 }
2929
2930                 /* check for multiple tempo/meters at the same location, which
2931                    ardour2 somehow allowed.
2932                 */
2933
2934                 Metrics::iterator prev = _metrics.end();
2935                 for (Metrics::iterator i = _metrics.begin(); i != _metrics.end(); ++i) {
2936                         if (prev != _metrics.end()) {
2937                                 MeterSection* ms;
2938                                 MeterSection* prev_m;
2939                                 TempoSection* ts;
2940                                 TempoSection* prev_t;
2941                                 if ((prev_m = dynamic_cast<MeterSection*>(*prev)) != 0 && (ms = dynamic_cast<MeterSection*>(*i)) != 0) {
2942                                         if (prev_m->pulse() == ms->pulse()) {
2943                                                 cerr << string_compose (_("Multiple meter definitions found at %1"), prev_m->pulse()) << endmsg;
2944                                                 error << string_compose (_("Multiple meter definitions found at %1"), prev_m->pulse()) << endmsg;
2945                                                 return -1;
2946                                         }
2947                                 } else if ((prev_t = dynamic_cast<TempoSection*>(*prev)) != 0 && (ts = dynamic_cast<TempoSection*>(*i)) != 0) {
2948                                         if (prev_t->pulse() == ts->pulse()) {
2949                                                 cerr << string_compose (_("Multiple tempo definitions found at %1"), prev_t->pulse()) << endmsg;
2950                                                 error << string_compose (_("Multiple tempo definitions found at %1"), prev_t->pulse()) << endmsg;
2951                                                 return -1;
2952                                         }
2953                                 }
2954                         }
2955                         prev = i;
2956                 }
2957
2958                 recompute_map (_metrics);
2959         }
2960
2961         PropertyChanged (PropertyChange ());
2962
2963         return 0;
2964 }
2965
2966 void
2967 TempoMap::dump (const Metrics& metrics, std::ostream& o) const
2968 {
2969         Glib::Threads::RWLock::ReaderLock lm (lock, Glib::Threads::TRY_LOCK);
2970         const MeterSection* m;
2971         const TempoSection* t;
2972         const TempoSection* prev_t = 0;
2973
2974         for (Metrics::const_iterator i = metrics.begin(); i != metrics.end(); ++i) {
2975
2976                 if ((t = dynamic_cast<const TempoSection*>(*i)) != 0) {
2977                         o << "Tempo @ " << *i << t->beats_per_minute() << " BPM (pulse = 1/" << t->note_type() << ") at " << t->pulse() << " frame= " << t->frame() << " (movable? "
2978                           << t->movable() << ')' << " pos lock: " << enum_2_string (t->position_lock_style()) << std::endl;
2979                         o << "current      : " << t->beats_per_minute() << " | " << t->pulse() << " | " << t->frame() << std::endl;
2980                         if (prev_t) {
2981                                 o << "previous     : " << prev_t->beats_per_minute() << " | " << prev_t->pulse() << " | " << prev_t->frame() << std::endl;
2982                                 o << "calculated   : " << prev_t->tempo_at_pulse (t->pulse()) *  prev_t->note_type() << " | " << prev_t->pulse_at_tempo (t->pulses_per_minute(), t->frame(), _frame_rate) <<  " | " << prev_t->frame_at_tempo (t->pulses_per_minute(), t->pulse(), _frame_rate) << std::endl;
2983                         }
2984                         prev_t = t;
2985                 } else if ((m = dynamic_cast<const MeterSection*>(*i)) != 0) {
2986                         o << "Meter @ " << *i << ' ' << m->divisions_per_bar() << '/' << m->note_divisor() << " at " << m->bbt() << " frame= " << m->frame()
2987                           << " pulse: " << m->pulse() <<  " beat : " << m->beat() << " pos lock: " << enum_2_string (m->position_lock_style()) << " (movable? " << m->movable() << ')' << endl;
2988                 }
2989         }
2990         o << "------" << std::endl;
2991 }
2992
2993 int
2994 TempoMap::n_tempos() const
2995 {
2996         Glib::Threads::RWLock::ReaderLock lm (lock);
2997         int cnt = 0;
2998
2999         for (Metrics::const_iterator i = _metrics.begin(); i != _metrics.end(); ++i) {
3000                 if (dynamic_cast<const TempoSection*>(*i) != 0) {
3001                         cnt++;
3002                 }
3003         }
3004
3005         return cnt;
3006 }
3007
3008 int
3009 TempoMap::n_meters() const
3010 {
3011         Glib::Threads::RWLock::ReaderLock lm (lock);
3012         int cnt = 0;
3013
3014         for (Metrics::const_iterator i = _metrics.begin(); i != _metrics.end(); ++i) {
3015                 if (dynamic_cast<const MeterSection*>(*i) != 0) {
3016                         cnt++;
3017                 }
3018         }
3019
3020         return cnt;
3021 }
3022
3023 void
3024 TempoMap::insert_time (framepos_t where, framecnt_t amount)
3025 {
3026         {
3027                 Glib::Threads::RWLock::WriterLock lm (lock);
3028                 for (Metrics::iterator i = _metrics.begin(); i != _metrics.end(); ++i) {
3029                         if ((*i)->frame() >= where && (*i)->movable ()) {
3030                                 (*i)->set_frame ((*i)->frame() + amount);
3031                         }
3032                 }
3033
3034                 /* now reset the BBT time of all metrics, based on their new
3035                  * audio time. This is the only place where we do this reverse
3036                  * timestamp.
3037                  */
3038
3039                 Metrics::iterator i;
3040                 const MeterSection* meter;
3041                 const TempoSection* tempo;
3042                 MeterSection *m;
3043                 TempoSection *t;
3044
3045                 meter = &first_meter ();
3046                 tempo = &first_tempo ();
3047
3048                 BBT_Time start;
3049                 BBT_Time end;
3050
3051                 // cerr << "\n###################### TIMESTAMP via AUDIO ##############\n" << endl;
3052
3053                 bool first = true;
3054                 MetricSection* prev = 0;
3055
3056                 for (i = _metrics.begin(); i != _metrics.end(); ++i) {
3057
3058                         BBT_Time bbt;
3059                         //TempoMetric metric (*meter, *tempo);
3060                         MeterSection* ms = const_cast<MeterSection*>(meter);
3061                         TempoSection* ts = const_cast<TempoSection*>(tempo);
3062                         if (prev) {
3063                                 if (ts){
3064                                         if ((t = dynamic_cast<TempoSection*>(prev)) != 0) {
3065                                                 if (!t->active()) {
3066                                                         continue;
3067                                                 }
3068                                                 ts->set_pulse (t->pulse());
3069                                         }
3070                                         if ((m = dynamic_cast<MeterSection*>(prev)) != 0) {
3071                                                 ts->set_pulse (m->pulse());
3072                                         }
3073                                         ts->set_frame (prev->frame());
3074
3075                                 }
3076                                 if (ms) {
3077                                         if ((m = dynamic_cast<MeterSection*>(prev)) != 0) {
3078                                                 pair<double, BBT_Time> start = make_pair (m->beat(), m->bbt());
3079                                                 ms->set_beat (start);
3080                                                 ms->set_pulse (m->pulse());
3081                                         }
3082                                         if ((t = dynamic_cast<TempoSection*>(prev)) != 0) {
3083                                                 if (!t->active()) {
3084                                                         continue;
3085                                                 }
3086                                                 const double beat = beat_at_pulse_locked (_metrics, t->pulse());
3087                                                 pair<double, BBT_Time> start = make_pair (beat, beats_to_bbt_locked (_metrics, beat));
3088                                                 ms->set_beat (start);
3089                                                 ms->set_pulse (t->pulse());
3090                                         }
3091                                         ms->set_frame (prev->frame());
3092                                 }
3093
3094                         } else {
3095                                 // metric will be at frames=0 bbt=1|1|0 by default
3096                                 // which is correct for our purpose
3097                         }
3098
3099                         // cerr << bbt << endl;
3100
3101                         if ((t = dynamic_cast<TempoSection*>(*i)) != 0) {
3102                                 if (!t->active()) {
3103                                         continue;
3104                                 }
3105                                 t->set_pulse (pulse_at_frame_locked (_metrics, m->frame()));
3106                                 tempo = t;
3107                                 // cerr << "NEW TEMPO, frame = " << (*i)->frame() << " beat = " << (*i)->pulse() <<endl;
3108                         } else if ((m = dynamic_cast<MeterSection*>(*i)) != 0) {
3109                                 bbt_time (m->frame(), bbt);
3110
3111                                 // cerr << "timestamp @ " << (*i)->frame() << " with " << bbt.bars << "|" << bbt.beats << "|" << bbt.ticks << " => ";
3112
3113                                 if (first) {
3114                                         first = false;
3115                                 } else {
3116
3117                                         if (bbt.ticks > BBT_Time::ticks_per_beat/2) {
3118                                                 /* round up to next beat */
3119                                                 bbt.beats += 1;
3120                                         }
3121
3122                                         bbt.ticks = 0;
3123
3124                                         if (bbt.beats != 1) {
3125                                                 /* round up to next bar */
3126                                                 bbt.bars += 1;
3127                                                 bbt.beats = 1;
3128                                         }
3129                                 }
3130                                 pair<double, BBT_Time> start = make_pair (beat_at_frame_locked (_metrics, m->frame()), bbt);
3131                                 m->set_beat (start);
3132                                 m->set_pulse (pulse_at_frame_locked (_metrics, m->frame()));
3133                                 meter = m;
3134                                 // cerr << "NEW METER, frame = " << (*i)->frame() << " beat = " << (*i)->pulse() <<endl;
3135                         } else {
3136                                 fatal << _("programming error: unhandled MetricSection type") << endmsg;
3137                                 abort(); /*NOTREACHED*/
3138                         }
3139
3140                         prev = (*i);
3141                 }
3142
3143                 recompute_map (_metrics);
3144         }
3145
3146
3147         PropertyChanged (PropertyChange ());
3148 }
3149 bool
3150 TempoMap::remove_time (framepos_t where, framecnt_t amount)
3151 {
3152         bool moved = false;
3153
3154         std::list<MetricSection*> metric_kill_list;
3155
3156         TempoSection* last_tempo = NULL;
3157         MeterSection* last_meter = NULL;
3158         bool tempo_after = false; // is there a tempo marker at the first sample after the removed range?
3159         bool meter_after = false; // is there a meter marker likewise?
3160         {
3161                 Glib::Threads::RWLock::WriterLock lm (lock);
3162                 for (Metrics::iterator i = _metrics.begin(); i != _metrics.end(); ++i) {
3163                         if ((*i)->frame() >= where && (*i)->frame() < where+amount) {
3164                                 metric_kill_list.push_back(*i);
3165                                 TempoSection *lt = dynamic_cast<TempoSection*> (*i);
3166                                 if (lt)
3167                                         last_tempo = lt;
3168                                 MeterSection *lm = dynamic_cast<MeterSection*> (*i);
3169                                 if (lm)
3170                                         last_meter = lm;
3171                         }
3172                         else if ((*i)->frame() >= where) {
3173                                 // TODO: make sure that moved tempo/meter markers are rounded to beat/bar boundaries
3174                                 (*i)->set_frame ((*i)->frame() - amount);
3175                                 if ((*i)->frame() == where) {
3176                                         // marker was immediately after end of range
3177                                         tempo_after = dynamic_cast<TempoSection*> (*i);
3178                                         meter_after = dynamic_cast<MeterSection*> (*i);
3179                                 }
3180                                 moved = true;
3181                         }
3182                 }
3183
3184                 //find the last TEMPO and METER metric (if any) and move it to the cut point so future stuff is correct
3185                 if (last_tempo && !tempo_after) {
3186                         metric_kill_list.remove(last_tempo);
3187                         last_tempo->set_frame(where);
3188                         moved = true;
3189                 }
3190                 if (last_meter && !meter_after) {
3191                         metric_kill_list.remove(last_meter);
3192                         last_meter->set_frame(where);
3193                         moved = true;
3194                 }
3195
3196                 //remove all the remaining metrics
3197                 for (std::list<MetricSection*>::iterator i = metric_kill_list.begin(); i != metric_kill_list.end(); ++i) {
3198                         _metrics.remove(*i);
3199                         moved = true;
3200                 }
3201
3202                 if (moved) {
3203                         recompute_map (_metrics);
3204                 }
3205         }
3206         PropertyChanged (PropertyChange ());
3207         return moved;
3208 }
3209
3210 /** Add some (fractional) beats to a session frame position, and return the result in frames.
3211  *  pos can be -ve, if required.
3212  */
3213 framepos_t
3214 TempoMap::framepos_plus_beats (framepos_t pos, Evoral::Beats beats) const
3215 {
3216         return frame_at_beat (beat_at_frame (pos) + beats.to_double());
3217 }
3218
3219 /** Subtract some (fractional) beats from a frame position, and return the result in frames */
3220 framepos_t
3221 TempoMap::framepos_minus_beats (framepos_t pos, Evoral::Beats beats) const
3222 {
3223         return frame_at_beat (beat_at_frame (pos) - beats.to_double());
3224 }
3225
3226 /** Add the BBT interval op to pos and return the result */
3227 framepos_t
3228 TempoMap::framepos_plus_bbt (framepos_t pos, BBT_Time op) const
3229 {
3230         Glib::Threads::RWLock::ReaderLock lm (lock);
3231
3232         BBT_Time pos_bbt = beats_to_bbt_locked (_metrics, beat_at_frame_locked (_metrics, pos));
3233         pos_bbt.ticks += op.ticks;
3234         if (pos_bbt.ticks >= BBT_Time::ticks_per_beat) {
3235                 ++pos_bbt.beats;
3236                 pos_bbt.ticks -= BBT_Time::ticks_per_beat;
3237         }
3238         pos_bbt.beats += op.beats;
3239         /* the meter in effect will start on the bar */
3240         double divisions_per_bar = meter_section_at (bbt_to_beats_locked (_metrics, BBT_Time (pos_bbt.bars + op.bars, 1, 0))).divisions_per_bar();
3241         while (pos_bbt.beats >= divisions_per_bar + 1) {
3242                 ++pos_bbt.bars;
3243                 divisions_per_bar = meter_section_at (bbt_to_beats_locked (_metrics, BBT_Time (pos_bbt.bars + op.bars, 1, 0))).divisions_per_bar();
3244                 pos_bbt.beats -= divisions_per_bar;
3245         }
3246         pos_bbt.bars += op.bars;
3247
3248         return frame_time_locked (_metrics, pos_bbt);
3249 }
3250
3251 /** Count the number of beats that are equivalent to distance when going forward,
3252     starting at pos.
3253 */
3254 Evoral::Beats
3255 TempoMap::framewalk_to_beats (framepos_t pos, framecnt_t distance) const
3256 {
3257         return Evoral::Beats (beat_at_frame (pos + distance) - beat_at_frame (pos));
3258 }
3259
3260 struct bbtcmp {
3261     bool operator() (const BBT_Time& a, const BBT_Time& b) {
3262             return a < b;
3263     }
3264 };
3265
3266 std::ostream&
3267 operator<< (std::ostream& o, const Meter& m) {
3268         return o << m.divisions_per_bar() << '/' << m.note_divisor();
3269 }
3270
3271 std::ostream&
3272 operator<< (std::ostream& o, const Tempo& t) {
3273         return o << t.beats_per_minute() << " 1/" << t.note_type() << "'s per minute";
3274 }
3275
3276 std::ostream&
3277 operator<< (std::ostream& o, const MetricSection& section) {
3278
3279         o << "MetricSection @ " << section.frame() << ' ';
3280
3281         const TempoSection* ts;
3282         const MeterSection* ms;
3283
3284         if ((ts = dynamic_cast<const TempoSection*> (&section)) != 0) {
3285                 o << *((const Tempo*) ts);
3286         } else if ((ms = dynamic_cast<const MeterSection*> (&section)) != 0) {
3287                 o << *((const Meter*) ms);
3288         }
3289
3290         return o;
3291 }