2 Copyright (C) 2000-2002 Paul Davis
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
26 #include <glibmm/threads.h>
28 #include "pbd/enumwriter.h"
29 #include "pbd/xml++.h"
30 #include "evoral/Beats.hpp"
32 #include "ardour/debug.h"
33 #include "ardour/lmath.h"
34 #include "ardour/tempo.h"
40 using namespace ARDOUR;
43 using Timecode::BBT_Time;
45 /* _default tempo is 4/4 qtr=120 */
47 Meter TempoMap::_default_meter (4.0, 4.0);
48 Tempo TempoMap::_default_tempo (120.0);
50 /***********************************************************************/
53 Meter::frames_per_grid (const Tempo& tempo, framecnt_t sr) const
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.
59 The return value IS NOT interpretable in terms of "beats".
62 return (60.0 * sr) / (tempo.beats_per_minute() * (_note_type/tempo.note_type()));
66 Meter::frames_per_bar (const Tempo& tempo, framecnt_t sr) const
68 return frames_per_grid (tempo, sr) * _divisions_per_bar;
71 /***********************************************************************/
73 const string TempoSection::xml_state_node_name = "Tempo";
75 TempoSection::TempoSection (const XMLNode& node)
76 : MetricSection (0.0, 0, MusicTime, true)
77 , Tempo (TempoMap::default_tempo())
80 , _locked_to_meter (false)
82 XMLProperty const * prop;
88 _legacy_bbt = BBT_Time (0, 0, 0);
90 if ((prop = node.property ("start")) != 0) {
91 if (sscanf (prop->value().c_str(), "%" PRIu32 "|%" PRIu32 "|%" PRIu32,
95 /* legacy session - start used to be in bbt*/
98 info << _("Legacy session detected. TempoSection XML node will be altered.") << endmsg;
102 if ((prop = node.property ("pulse")) != 0) {
103 if (sscanf (prop->value().c_str(), "%lf", &pulse) != 1) {
104 error << _("TempoSection XML node has an illegal \"pulse\" value") << endmsg;
110 if ((prop = node.property ("frame")) != 0) {
111 if (sscanf (prop->value().c_str(), "%" PRIu32, &frame) != 1) {
112 error << _("TempoSection XML node has an illegal \"frame\" value") << endmsg;
118 if ((prop = node.property ("beats-per-minute")) == 0) {
119 error << _("TempoSection XML node has no \"beats-per-minute\" property") << endmsg;
120 throw failed_constructor();
123 if (sscanf (prop->value().c_str(), "%lf", &_beats_per_minute) != 1 || _beats_per_minute < 0.0) {
124 error << _("TempoSection XML node has an illegal \"beats_per_minute\" value") << endmsg;
125 throw failed_constructor();
128 if ((prop = node.property ("note-type")) == 0) {
129 /* older session, make note type be quarter by default */
132 if (sscanf (prop->value().c_str(), "%lf", &_note_type) != 1 || _note_type < 1.0) {
133 error << _("TempoSection XML node has an illegal \"note-type\" value") << endmsg;
134 throw failed_constructor();
138 if ((prop = node.property ("movable")) == 0) {
139 error << _("TempoSection XML node has no \"movable\" property") << endmsg;
140 throw failed_constructor();
143 set_movable (string_is_affirmative (prop->value()));
145 if ((prop = node.property ("active")) == 0) {
146 warning << _("TempoSection XML node has no \"active\" property") << endmsg;
149 set_active (string_is_affirmative (prop->value()));
152 if ((prop = node.property ("tempo-type")) == 0) {
155 _type = Type (string_2_enum (prop->value(), _type));
158 if ((prop = node.property ("lock-style")) == 0) {
160 set_position_lock_style (MusicTime);
162 set_position_lock_style (AudioTime);
165 set_position_lock_style (PositionLockStyle (string_2_enum (prop->value(), position_lock_style())));
168 if ((prop = node.property ("locked-to-meter")) == 0) {
169 set_locked_to_meter (false);
171 set_locked_to_meter (string_is_affirmative (prop->value()));
176 TempoSection::get_state() const
178 XMLNode *root = new XMLNode (xml_state_node_name);
182 snprintf (buf, sizeof (buf), "%lf", pulse());
183 root->add_property ("pulse", buf);
184 snprintf (buf, sizeof (buf), "%li", frame());
185 root->add_property ("frame", buf);
186 snprintf (buf, sizeof (buf), "%lf", _beats_per_minute);
187 root->add_property ("beats-per-minute", buf);
188 snprintf (buf, sizeof (buf), "%lf", _note_type);
189 root->add_property ("note-type", buf);
190 snprintf (buf, sizeof (buf), "%s", movable()?"yes":"no");
191 root->add_property ("movable", buf);
192 snprintf (buf, sizeof (buf), "%s", active()?"yes":"no");
193 root->add_property ("active", buf);
194 root->add_property ("tempo-type", enum_2_string (_type));
195 root->add_property ("lock-style", enum_2_string (position_lock_style()));
196 root->add_property ("locked-to-meter", locked_to_meter()?"yes":"no");
202 TempoSection::set_type (Type type)
207 /** returns the tempo in whole pulses per minute at the zero-based (relative to session) frame.
210 TempoSection::tempo_at_frame (const framepos_t& f, const framecnt_t& frame_rate) const
213 if (_type == Constant || _c_func == 0.0) {
214 return pulses_per_minute();
217 return pulse_tempo_at_time (frame_to_minute (f - frame(), frame_rate));
220 /** returns the zero-based frame (relative to session)
221 where the tempo in whole pulses per minute occurs in this section.
222 pulse p is only used for constant tempos.
223 note that the tempo map may have multiple such values.
226 TempoSection::frame_at_tempo (const double& ppm, const double& p, const framecnt_t& frame_rate) const
228 if (_type == Constant || _c_func == 0.0) {
229 return ((p - pulse()) * frames_per_pulse (frame_rate)) + frame();
232 return minute_to_frame (time_at_pulse_tempo (ppm), frame_rate) + frame();
234 /** returns the tempo in pulses per minute at the zero-based (relative to session) beat.
237 TempoSection::tempo_at_pulse (const double& p) const
240 if (_type == Constant || _c_func == 0.0) {
241 return pulses_per_minute();
243 double const ppm = pulse_tempo_at_pulse (p - pulse());
247 /** returns the zero-based beat (relative to session)
248 where the tempo in whole pulses per minute occurs given frame f. frame f is only used for constant tempos.
249 note that the session tempo map may have multiple beats at a given tempo.
252 TempoSection::pulse_at_tempo (const double& ppm, const framepos_t& f, const framecnt_t& frame_rate) const
254 if (_type == Constant || _c_func == 0.0) {
255 double const pulses = ((f - frame()) / frames_per_pulse (frame_rate)) + pulse();
258 return pulse_at_pulse_tempo (ppm) + pulse();
261 /** returns the zero-based pulse (relative to session origin)
262 where the zero-based frame (relative to session)
266 TempoSection::pulse_at_frame (const framepos_t& f, const framecnt_t& frame_rate) const
268 if (_type == Constant || _c_func == 0.0) {
269 return ((f - frame()) / frames_per_pulse (frame_rate)) + pulse();
272 return pulse_at_time (frame_to_minute (f - frame(), frame_rate)) + pulse();
275 /** returns the zero-based frame (relative to session start frame)
276 where the zero-based pulse (relative to session start)
281 TempoSection::frame_at_pulse (const double& p, const framecnt_t& frame_rate) const
283 if (_type == Constant || _c_func == 0.0) {
284 return (framepos_t) floor ((p - pulse()) * frames_per_pulse (frame_rate)) + frame();
287 return minute_to_frame (time_at_pulse (p - pulse()), frame_rate) + frame();
295 Tt----|-----------------*|
296 Ta----|--------------|* |
302 _______________|___|____
303 time a t (next tempo)
306 Duration in beats at time a is the integral of some Tempo function.
307 In our case, the Tempo function (Tempo at time t) is
310 with function constant
315 The integral over t of our Tempo function (the beat function, which is the duration in beats at some time t) is:
316 b(t) = T0(e^(ct) - 1) / c
318 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:
319 t(b) = log((c.b / T0) + 1) / c
321 The time t at which Tempo T occurs is a as above:
322 t(T) = log(T / T0) / c
324 The beat at which a Tempo T occurs is:
327 The Tempo at which beat b occurs is:
330 We define c for this tempo ramp by placing a new tempo section at some time t after this one.
331 Our problem is that we usually don't know t.
332 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.
333 Where a = t (i.e. when a is equal to the time of the next tempo section), the beat function reveals:
334 t = b log (Ta / T0) / (T0 (e^(log (Ta / T0)) - 1))
336 By substituting our expanded t as a in the c function above, our problem is reduced to:
337 c = T0 (e^(log (Ta / T0)) - 1) / b
339 Of course the word 'beat' has been left loosely defined above.
340 In music, a beat is defined by the musical pulse (which comes from the tempo)
341 and the meter in use at a particular time (how many pulse divisions there are in one bar).
342 It would be more accurate to substitute the work 'pulse' for 'beat' above.
346 We can now store c for future time calculations.
347 If the following tempo section (the one that defines c in conjunction with this one)
348 is changed or moved, c is no longer valid.
350 The public methods are session-relative.
352 Most of this stuff is taken from this paper:
355 TOOLS FOR DYNAMIC TEMPO CALCULATIONS
358 Zurich University of Arts
359 Institute for Computer Music and Sound Technology
361 https://www.zhdk.ch/fileadmin/data_subsites/data_icst/Downloads/Timegrid/ICST_Tempopolyphony_ICMC07.pdf
366 compute this ramp's function constant using the end tempo (in whole pulses per minute)
367 and duration (pulses into global start) of some later tempo section.
370 TempoSection::compute_c_func_pulse (const double& end_bpm, const double& end_pulse, const framecnt_t& frame_rate)
372 double const log_tempo_ratio = log (end_bpm / pulses_per_minute());
373 return pulses_per_minute() * (expm1 (log_tempo_ratio)) / (end_pulse - pulse());
376 /* compute the function constant from some later tempo section, given tempo (whole pulses/min.) and distance (in frames) from session origin */
378 TempoSection::compute_c_func_frame (const double& end_bpm, const framepos_t& end_frame, const framecnt_t& frame_rate) const
380 return c_func (end_bpm, frame_to_minute (end_frame - frame(), frame_rate));
384 TempoSection::minute_to_frame (const double& time, const framecnt_t& frame_rate) const
386 return (framepos_t) floor ((time * 60.0 * frame_rate) + 0.5);
390 TempoSection::frame_to_minute (const framepos_t& frame, const framecnt_t& frame_rate) const
392 return (frame / (double) frame_rate) / 60.0;
395 /* position function */
397 TempoSection::a_func (double end_ppm, double c_func) const
399 return log (end_ppm / pulses_per_minute()) / c_func;
402 /*function constant*/
404 TempoSection::c_func (double end_ppm, double end_time) const
406 return log (end_ppm / pulses_per_minute()) / end_time;
409 /* tempo in ppm at time in minutes */
411 TempoSection::pulse_tempo_at_time (const double& time) const
413 return exp (_c_func * time) * pulses_per_minute();
416 /* time in minutes at tempo in ppm */
418 TempoSection::time_at_pulse_tempo (const double& pulse_tempo) const
420 return log (pulse_tempo / pulses_per_minute()) / _c_func;
423 /* tick at tempo in ppm */
425 TempoSection::pulse_at_pulse_tempo (const double& pulse_tempo) const
427 return (pulse_tempo - pulses_per_minute()) / _c_func;
430 /* tempo in ppm at tick */
432 TempoSection::pulse_tempo_at_pulse (const double& pulse) const
434 return (pulse * _c_func) + pulses_per_minute();
437 /* pulse at time in minutes */
439 TempoSection::pulse_at_time (const double& time) const
441 return expm1 (_c_func * time) * (pulses_per_minute() / _c_func);
444 /* time in minutes at pulse */
446 TempoSection::time_at_pulse (const double& pulse) const
448 return log1p ((_c_func * pulse) / pulses_per_minute()) / _c_func;
451 /***********************************************************************/
453 const string MeterSection::xml_state_node_name = "Meter";
455 MeterSection::MeterSection (const XMLNode& node)
456 : MetricSection (0.0, 0, MusicTime, false), Meter (TempoMap::default_meter())
458 XMLProperty const * prop;
463 framepos_t frame = 0;
464 pair<double, BBT_Time> start;
466 if ((prop = node.property ("start")) != 0) {
467 if (sscanf (prop->value().c_str(), "%" PRIu32 "|%" PRIu32 "|%" PRIu32,
471 error << _("MeterSection XML node has an illegal \"start\" value") << endmsg;
473 /* legacy session - start used to be in bbt*/
474 info << _("Legacy session detected - MeterSection XML node will be altered.") << endmsg;
479 if ((prop = node.property ("pulse")) != 0) {
480 if (sscanf (prop->value().c_str(), "%lf", &pulse) != 1) {
481 error << _("MeterSection XML node has an illegal \"pulse\" value") << endmsg;
486 if ((prop = node.property ("beat")) != 0) {
487 if (sscanf (prop->value().c_str(), "%lf", &beat) != 1) {
488 error << _("MeterSection XML node has an illegal \"beat\" value") << endmsg;
494 if ((prop = node.property ("bbt")) == 0) {
495 warning << _("MeterSection XML node has no \"bbt\" property") << endmsg;
496 } else if (sscanf (prop->value().c_str(), "%" PRIu32 "|%" PRIu32 "|%" PRIu32,
500 error << _("MeterSection XML node has an illegal \"bbt\" value") << endmsg;
501 throw failed_constructor();
507 if ((prop = node.property ("frame")) != 0) {
508 if (sscanf (prop->value().c_str(), "%li", &frame) != 1) {
509 error << _("MeterSection XML node has an illegal \"frame\" value") << endmsg;
515 /* beats-per-bar is old; divisions-per-bar is new */
517 if ((prop = node.property ("divisions-per-bar")) == 0) {
518 if ((prop = node.property ("beats-per-bar")) == 0) {
519 error << _("MeterSection XML node has no \"beats-per-bar\" or \"divisions-per-bar\" property") << endmsg;
520 throw failed_constructor();
523 if (sscanf (prop->value().c_str(), "%lf", &_divisions_per_bar) != 1 || _divisions_per_bar < 0.0) {
524 error << _("MeterSection XML node has an illegal \"divisions-per-bar\" value") << endmsg;
525 throw failed_constructor();
528 if ((prop = node.property ("note-type")) == 0) {
529 error << _("MeterSection XML node has no \"note-type\" property") << endmsg;
530 throw failed_constructor();
532 if (sscanf (prop->value().c_str(), "%lf", &_note_type) != 1 || _note_type < 0.0) {
533 error << _("MeterSection XML node has an illegal \"note-type\" value") << endmsg;
534 throw failed_constructor();
537 if ((prop = node.property ("movable")) == 0) {
538 error << _("MeterSection XML node has no \"movable\" property") << endmsg;
539 throw failed_constructor();
542 set_movable (string_is_affirmative (prop->value()));
544 if ((prop = node.property ("lock-style")) == 0) {
545 warning << _("MeterSection XML node has no \"lock-style\" property") << endmsg;
547 set_position_lock_style (MusicTime);
549 set_position_lock_style (AudioTime);
552 set_position_lock_style (PositionLockStyle (string_2_enum (prop->value(), position_lock_style())));
557 MeterSection::get_state() const
559 XMLNode *root = new XMLNode (xml_state_node_name);
563 snprintf (buf, sizeof (buf), "%lf", pulse());
564 root->add_property ("pulse", buf);
565 snprintf (buf, sizeof (buf), "%" PRIu32 "|%" PRIu32 "|%" PRIu32,
569 root->add_property ("bbt", buf);
570 snprintf (buf, sizeof (buf), "%lf", beat());
571 root->add_property ("beat", buf);
572 snprintf (buf, sizeof (buf), "%lf", _note_type);
573 root->add_property ("note-type", buf);
574 snprintf (buf, sizeof (buf), "%li", frame());
575 root->add_property ("frame", buf);
576 root->add_property ("lock-style", enum_2_string (position_lock_style()));
577 snprintf (buf, sizeof (buf), "%lf", _divisions_per_bar);
578 root->add_property ("divisions-per-bar", buf);
579 snprintf (buf, sizeof (buf), "%s", movable()?"yes":"no");
580 root->add_property ("movable", buf);
585 /***********************************************************************/
589 The Shaggs - Things I Wonder
590 https://www.youtube.com/watch?v=9wQK6zMJOoQ
592 Tempo is the rate of the musical pulse.
593 Meters divide the pulses into measures and beats.
595 TempoSections - provide pulses in the form of beats_per_minute() and note_type() where note_type is the division of a whole pulse,
596 and beats_per_minute is the number of note_types in one minute (unlike what its name suggests).
597 Note that Tempo::beats_per_minute() has nothing to do with musical beats. It has been left that way because
598 a shorter one hasn't been found yet (pulse_divisions_per_minute()?).
600 MeterSecions - divide pulses into measures (via divisions_per_bar) and beats (via note_divisor).
602 Both tempos and meters have a pulse position and a frame position.
603 Meters also have a beat position, which is always 0.0 for the first meter.
604 TempoSections and MeterSections may be locked to either audio or music (position lock style).
605 The lock style determines the 'true' position of the section wich is used to calculate the other postion parameters of the section.
607 The first tempo and first meter are special. they must move together, and must be locked to audio.
608 Audio locked tempos which lie before the first meter are made inactive.
609 They will be re-activated if the first meter is again placed before them.
611 With tepo sections potentially being ramped, meters provide a way of mapping beats to whole pulses without
612 referring to the tempo function(s) involved as the distance in whole pulses between a meter and a subsequent beat is
613 sb->beat() - meter->beat() / meter->note_divisor().
614 Because every meter falls on a known pulse, (derived from its bar), the rest is easy as the duration in pulses between
615 two meters is of course
616 (meater_b->bar - meter_a->bar) * meter_a->divisions_per_bar / meter_a->note_divisor.
618 Below, beat calculations are based on meter sections and all pulse and tempo calculations are based on tempo sections.
619 Beat to frame conversion of course requires the use of meter and tempo.
621 Remembering that ramped tempo sections interact, it is important to avoid referring to any other tempos when moving tempo sections,
622 Here, beats (meters) are used to determine the new pulse (see predict_tempo_position())
624 Recomputing the map is the process where the 'missing' position
625 (tempo pulse or meter pulse & beat in the case of AudioTime, frame for MusicTime) is calculated.
626 We construct the tempo map by first using the frame or pulse position (depending on position lock style) of each tempo.
627 We then use this tempo map (really just the tempos) to find the pulse or frame position of each meter (again depending on lock style).
629 Having done this, we can now find any musical duration by selecting the tempo and meter covering the position (or tempo) in question
630 and querying its appropriate meter/tempo.
632 It is important to keep the _metrics in an order that makes sense.
633 Because ramped MusicTime and AudioTime tempos can interact with each other,
634 reordering is frequent. Care must be taken to keep _metrics in a solved state.
635 Solved means ordered by frame or pulse with frame-accurate precision (see check_solved()).
639 Music and audio-locked objects may seem interchangeable on the surface, but when translating
640 between audio samples and beats, keep in mind that a sample is only a quantised approximation
641 of the actual time (in minutes) of a beat.
642 Thus if a gui user points to the frame occupying the start of a music-locked object on 1|3|0, it does not
643 mean that this frame is the actual location in time of 1|3|0.
645 You cannot use a frame measurement to determine beat distance except under special circumstances
646 (e.g. where the user has requested that a beat lie on a SMPTE frame or if the tempo is known to be constant over the duration).
648 This means is that a user operating on a musical grid must supply the desired beat position and/or current beat quantization in order for the
649 sample space the user is operating at to be translated correctly to the object.
651 The current approach is to interpret the supplied frame using the grid division the user has currently selected.
652 If the user has no musical grid set, they are actually operating in sample space (even SMPTE frames are rounded to audio frame), so
653 the supplied audio frame is interpreted as the desired musical location (beat_at_frame()).
655 tldr: Beat, being a function of time, has nothing to do with sample rate, but time quantization can get in the way of precision.
657 When frame_at_beat() is called, the position calculation is performed in pulses and minutes.
658 The result is rounded to audio frames.
659 When beat_at_frame() is called, the frame is converted to minutes, with no rounding performed on the result.
662 frame_at_beat (beat_at_frame (frame)) == frame
664 beat_at_frame (frame_at_beat (beat)) != beat due to the time quantization of frame_at_beat().
666 Doing the second one will result in a beat distance error of up to 0.5 audio samples.
667 So instead work in pulses and/or beats and only use beat position to caclulate frame position (e.g. after tempo change).
668 For audio-locked objects, use frame position to calculate beat position.
670 The above pointless example would then do:
671 beat_at_pulse (pulse_at_beat (beat)) to avoid rounding.
674 struct MetricSectionSorter {
675 bool operator() (const MetricSection* a, const MetricSection* b) {
676 return a->pulse() < b->pulse();
680 struct MetricSectionFrameSorter {
681 bool operator() (const MetricSection* a, const MetricSection* b) {
682 return a->frame() < b->frame();
686 TempoMap::TempoMap (framecnt_t fr)
689 BBT_Time start (1, 1, 0);
691 TempoSection *t = new TempoSection (0.0, 0, _default_tempo.beats_per_minute(), _default_tempo.note_type(), TempoSection::Ramp, AudioTime);
692 MeterSection *m = new MeterSection (0.0, 0, 0.0, start, _default_meter.divisions_per_bar(), _default_meter.note_divisor(), AudioTime);
694 t->set_movable (false);
695 m->set_movable (false);
697 /* note: frame time is correct (zero) for both of these */
699 _metrics.push_back (t);
700 _metrics.push_back (m);
704 TempoMap::~TempoMap ()
706 Metrics::const_iterator d = _metrics.begin();
707 while (d != _metrics.end()) {
715 TempoMap::remove_tempo (const TempoSection& tempo, bool complete_operation)
717 bool removed = false;
720 Glib::Threads::RWLock::WriterLock lm (lock);
721 if ((removed = remove_tempo_locked (tempo))) {
722 if (complete_operation) {
723 recompute_map (_metrics);
728 if (removed && complete_operation) {
729 PropertyChanged (PropertyChange ());
734 TempoMap::remove_tempo_locked (const TempoSection& tempo)
738 for (i = _metrics.begin(); i != _metrics.end(); ++i) {
739 if (dynamic_cast<TempoSection*> (*i) != 0) {
740 if (tempo.frame() == (*i)->frame()) {
741 if ((*i)->movable()) {
754 TempoMap::remove_meter (const MeterSection& tempo, bool complete_operation)
756 bool removed = false;
759 Glib::Threads::RWLock::WriterLock lm (lock);
760 if ((removed = remove_meter_locked (tempo))) {
761 if (complete_operation) {
762 recompute_map (_metrics);
767 if (removed && complete_operation) {
768 PropertyChanged (PropertyChange ());
773 TempoMap::remove_meter_locked (const MeterSection& meter)
776 if (meter.position_lock_style() == AudioTime) {
777 /* remove meter-locked tempo */
778 for (Metrics::iterator i = _metrics.begin(); i != _metrics.end(); ++i) {
780 if ((t = dynamic_cast<TempoSection*> (*i)) != 0) {
781 if (t->locked_to_meter() && meter.frame() == (*i)->frame()) {
790 for (Metrics::iterator i = _metrics.begin(); i != _metrics.end(); ++i) {
791 if (dynamic_cast<MeterSection*> (*i) != 0) {
792 if (meter.frame() == (*i)->frame()) {
793 if ((*i)->movable()) {
806 TempoMap::do_insert (MetricSection* section)
808 bool need_add = true;
809 /* we only allow new meters to be inserted on beat 1 of an existing
813 if ((m = dynamic_cast<MeterSection*>(section)) != 0) {
815 if ((m->bbt().beats != 1) || (m->bbt().ticks != 0)) {
817 pair<double, BBT_Time> corrected = make_pair (m->beat(), m->bbt());
818 corrected.second.beats = 1;
819 corrected.second.ticks = 0;
820 corrected.first = beat_at_bbt_locked (_metrics, corrected.second);
821 warning << string_compose (_("Meter changes can only be positioned on the first beat of a bar. Moving from %1 to %2"),
822 m->bbt(), corrected.second) << endmsg;
823 //m->set_pulse (corrected);
827 /* Look for any existing MetricSection that is of the same type and
828 in the same bar as the new one, and remove it before adding
829 the new one. Note that this means that if we find a matching,
830 existing section, we can break out of the loop since we're
831 guaranteed that there is only one such match.
834 for (Metrics::iterator i = _metrics.begin(); i != _metrics.end(); ++i) {
836 TempoSection* const tempo = dynamic_cast<TempoSection*> (*i);
837 TempoSection* const insert_tempo = dynamic_cast<TempoSection*> (section);
838 MeterSection* const meter = dynamic_cast<MeterSection*> (*i);
839 MeterSection* const insert_meter = dynamic_cast<MeterSection*> (section);
841 if (tempo && insert_tempo) {
844 bool const ipm = insert_tempo->position_lock_style() == MusicTime;
845 if ((ipm && tempo->pulse() == insert_tempo->pulse()) || (!ipm && tempo->frame() == insert_tempo->frame())) {
847 if (!tempo->movable()) {
849 /* can't (re)move this section, so overwrite
850 * its data content (but not its properties as
854 *(dynamic_cast<Tempo*>(*i)) = *(dynamic_cast<Tempo*>(insert_tempo));
855 (*i)->set_position_lock_style (AudioTime);
857 if ((t = dynamic_cast<TempoSection*>(*i)) != 0) {
858 t->set_type (insert_tempo->type());
868 } else if (meter && insert_meter) {
872 bool const ipm = insert_meter->position_lock_style() == MusicTime;
874 if ((ipm && meter->beat() == insert_meter->beat()) || (!ipm && meter->frame() == insert_meter->frame())) {
876 if (!meter->movable()) {
878 /* can't (re)move this section, so overwrite
879 * its data content (but not its properties as
883 *(dynamic_cast<Meter*>(*i)) = *(dynamic_cast<Meter*>(insert_meter));
884 (*i)->set_position_lock_style (AudioTime);
894 /* non-matching types, so we don't care */
898 /* Add the given MetricSection, if we didn't just reset an existing
903 MeterSection* const insert_meter = dynamic_cast<MeterSection*> (section);
904 TempoSection* const insert_tempo = dynamic_cast<TempoSection*> (section);
907 for (i = _metrics.begin(); i != _metrics.end(); ++i) {
908 MeterSection* const meter = dynamic_cast<MeterSection*> (*i);
911 bool const ipm = insert_meter->position_lock_style() == MusicTime;
912 if ((ipm && meter->beat() > insert_meter->beat()) || (!ipm && meter->frame() > insert_meter->frame())) {
917 } else if (insert_tempo) {
918 for (i = _metrics.begin(); i != _metrics.end(); ++i) {
919 TempoSection* const tempo = dynamic_cast<TempoSection*> (*i);
922 bool const ipm = insert_tempo->position_lock_style() == MusicTime;
923 if ((ipm && tempo->pulse() > insert_tempo->pulse()) || (!ipm && tempo->frame() > insert_tempo->frame())) {
930 _metrics.insert (i, section);
931 //dump (_metrics, std::cout);
936 TempoMap::add_tempo (const Tempo& tempo, const double& pulse, const framepos_t& frame, ARDOUR::TempoSection::Type type, PositionLockStyle pls)
938 TempoSection* ts = 0;
940 Glib::Threads::RWLock::WriterLock lm (lock);
941 ts = add_tempo_locked (tempo, pulse, frame, type, pls, true);
945 PropertyChanged (PropertyChange ());
951 TempoMap::replace_tempo (const TempoSection& ts, const Tempo& tempo, const double& pulse, const framepos_t& frame, TempoSection::Type type, PositionLockStyle pls)
953 const bool locked_to_meter = ts.locked_to_meter();
956 Glib::Threads::RWLock::WriterLock lm (lock);
957 TempoSection& first (first_tempo());
958 if (ts.frame() != first.frame()) {
959 remove_tempo_locked (ts);
960 add_tempo_locked (tempo, pulse, frame, type, pls, true, locked_to_meter);
962 first.set_type (type);
963 first.set_pulse (0.0);
964 first.set_frame (frame);
965 first.set_position_lock_style (AudioTime);
967 /* cannot move the first tempo section */
968 *static_cast<Tempo*>(&first) = tempo;
969 recompute_map (_metrics);
974 PropertyChanged (PropertyChange ());
978 TempoMap::add_tempo_locked (const Tempo& tempo, double pulse, framepos_t frame
979 , TempoSection::Type type, PositionLockStyle pls, bool recompute, bool locked_to_meter)
981 TempoSection* t = new TempoSection (pulse, frame, tempo.beats_per_minute(), tempo.note_type(), type, pls);
982 t->set_locked_to_meter (locked_to_meter);
988 if (pls == AudioTime) {
989 solved = solve_map_frame (_metrics, t, t->frame());
991 solved = solve_map_pulse (_metrics, t, t->pulse());
993 recompute_meters (_metrics);
996 if (!solved && recompute) {
997 recompute_map (_metrics);
1004 TempoMap::add_meter (const Meter& meter, const double& beat, const Timecode::BBT_Time& where, const framepos_t& frame, PositionLockStyle pls)
1006 MeterSection* m = 0;
1008 Glib::Threads::RWLock::WriterLock lm (lock);
1009 m = add_meter_locked (meter, beat, where, frame, pls, true);
1014 if (DEBUG_ENABLED(DEBUG::TempoMap)) {
1015 dump (_metrics, std::cerr);
1019 PropertyChanged (PropertyChange ());
1024 TempoMap::replace_meter (const MeterSection& ms, const Meter& meter, const BBT_Time& where, const framepos_t& frame, PositionLockStyle pls)
1027 Glib::Threads::RWLock::WriterLock lm (lock);
1028 const double beat = beat_at_bbt_locked (_metrics, where);
1031 remove_meter_locked (ms);
1032 add_meter_locked (meter, beat, where, frame, pls, true);
1034 MeterSection& first (first_meter());
1035 TempoSection& first_t (first_tempo());
1036 /* cannot move the first meter section */
1037 *static_cast<Meter*>(&first) = meter;
1038 first.set_position_lock_style (AudioTime);
1039 first.set_pulse (0.0);
1040 first.set_frame (frame);
1041 pair<double, BBT_Time> beat = make_pair (0.0, BBT_Time (1, 1, 0));
1042 first.set_beat (beat);
1043 first_t.set_frame (first.frame());
1044 first_t.set_pulse (0.0);
1045 first_t.set_position_lock_style (AudioTime);
1046 recompute_map (_metrics);
1050 PropertyChanged (PropertyChange ());
1054 TempoMap::add_meter_locked (const Meter& meter, double beat, const BBT_Time& where, framepos_t frame, PositionLockStyle pls, bool recompute)
1056 const MeterSection& prev_m = meter_section_at_frame_locked (_metrics, frame - 1);
1057 const double pulse = ((where.bars - prev_m.bbt().bars) * (prev_m.divisions_per_bar() / prev_m.note_divisor())) + prev_m.pulse();
1058 TempoSection* mlt = 0;
1060 if (pls == AudioTime) {
1061 /* add meter-locked tempo */
1062 mlt = add_tempo_locked (tempo_at_frame_locked (_metrics, frame), pulse, frame, TempoSection::Ramp, AudioTime, true, true);
1070 MeterSection* new_meter = new MeterSection (pulse, frame, beat, where, meter.divisions_per_bar(), meter.note_divisor(), pls);
1071 bool solved = false;
1073 do_insert (new_meter);
1077 if (pls == AudioTime) {
1078 solved = solve_map_frame (_metrics, new_meter, frame);
1080 solved = solve_map_bbt (_metrics, new_meter, where);
1081 /* required due to resetting the pulse of meter-locked tempi above.
1082 Arguably solve_map_bbt() should use solve_map_pulse (_metrics, TempoSection) instead,
1083 but afaict this cannot cause the map to be left unsolved (these tempi are all audio locked).
1085 recompute_map (_metrics);
1089 if (!solved && recompute) {
1090 /* if this has failed to solve, there is little we can do other than to ensure that
1091 the new map is recalculated.
1093 warning << "Adding meter may have left the tempo map unsolved." << endmsg;
1094 recompute_map (_metrics);
1101 TempoMap::change_initial_tempo (double beats_per_minute, double note_type)
1103 Tempo newtempo (beats_per_minute, note_type);
1106 for (Metrics::iterator i = _metrics.begin(); i != _metrics.end(); ++i) {
1107 if ((t = dynamic_cast<TempoSection*> (*i)) != 0) {
1112 Glib::Threads::RWLock::WriterLock lm (lock);
1113 *((Tempo*) t) = newtempo;
1114 recompute_map (_metrics);
1116 PropertyChanged (PropertyChange ());
1123 TempoMap::change_existing_tempo_at (framepos_t where, double beats_per_minute, double note_type)
1125 Tempo newtempo (beats_per_minute, note_type);
1128 TempoSection* first;
1129 Metrics::iterator i;
1131 /* find the TempoSection immediately preceding "where"
1134 for (first = 0, i = _metrics.begin(), prev = 0; i != _metrics.end(); ++i) {
1136 if ((*i)->frame() > where) {
1142 if ((t = dynamic_cast<TempoSection*>(*i)) != 0) {
1155 error << string_compose (_("no tempo sections defined in tempo map - cannot change tempo @ %1"), where) << endmsg;
1165 Glib::Threads::RWLock::WriterLock lm (lock);
1166 /* cannot move the first tempo section */
1167 *((Tempo*)prev) = newtempo;
1168 recompute_map (_metrics);
1171 PropertyChanged (PropertyChange ());
1175 TempoMap::first_meter () const
1177 const MeterSection *m = 0;
1179 for (Metrics::const_iterator i = _metrics.begin(); i != _metrics.end(); ++i) {
1180 if ((m = dynamic_cast<const MeterSection *> (*i)) != 0) {
1185 fatal << _("programming error: no meter section in tempo map!") << endmsg;
1186 abort(); /*NOTREACHED*/
1191 TempoMap::first_meter ()
1193 MeterSection *m = 0;
1195 /* CALLER MUST HOLD LOCK */
1197 for (Metrics::iterator i = _metrics.begin(); i != _metrics.end(); ++i) {
1198 if ((m = dynamic_cast<MeterSection *> (*i)) != 0) {
1203 fatal << _("programming error: no tempo section in tempo map!") << endmsg;
1204 abort(); /*NOTREACHED*/
1209 TempoMap::first_tempo () const
1211 const TempoSection *t = 0;
1213 /* CALLER MUST HOLD LOCK */
1215 for (Metrics::const_iterator i = _metrics.begin(); i != _metrics.end(); ++i) {
1216 if ((t = dynamic_cast<const TempoSection *> (*i)) != 0) {
1220 if (!t->movable()) {
1226 fatal << _("programming error: no tempo section in tempo map!") << endmsg;
1227 abort(); /*NOTREACHED*/
1232 TempoMap::first_tempo ()
1234 TempoSection *t = 0;
1236 for (Metrics::const_iterator i = _metrics.begin(); i != _metrics.end(); ++i) {
1237 if ((t = dynamic_cast<TempoSection *> (*i)) != 0) {
1241 if (!t->movable()) {
1247 fatal << _("programming error: no tempo section in tempo map!") << endmsg;
1248 abort(); /*NOTREACHED*/
1252 TempoMap::recompute_tempi (Metrics& metrics)
1254 TempoSection* prev_t = 0;
1256 for (Metrics::const_iterator i = metrics.begin(); i != metrics.end(); ++i) {
1259 if ((*i)->is_tempo()) {
1260 t = static_cast<TempoSection*> (*i);
1264 if (!t->movable()) {
1272 if (t->position_lock_style() == AudioTime) {
1273 prev_t->set_c_func (prev_t->compute_c_func_frame (t->pulses_per_minute(), t->frame(), _frame_rate));
1274 if (!t->locked_to_meter()) {
1275 t->set_pulse (prev_t->pulse_at_tempo (t->pulses_per_minute(), t->frame(), _frame_rate));
1279 prev_t->set_c_func (prev_t->compute_c_func_pulse (t->pulses_per_minute(), t->pulse(), _frame_rate));
1280 t->set_frame (prev_t->frame_at_tempo (t->pulses_per_minute(), t->pulse(), _frame_rate));
1287 prev_t->set_c_func (0.0);
1290 /* tempos must be positioned correctly.
1291 the current approach is to use a meter's bbt time as its base position unit.
1292 an audio-locked meter requires a recomputation of pulse and beat (but not bbt),
1293 while a music-locked meter requires recomputations of frame pulse and beat (but not bbt)
1296 TempoMap::recompute_meters (Metrics& metrics)
1298 MeterSection* meter = 0;
1299 MeterSection* prev_m = 0;
1301 for (Metrics::const_iterator mi = metrics.begin(); mi != metrics.end(); ++mi) {
1302 if (!(*mi)->is_tempo()) {
1303 meter = static_cast<MeterSection*> (*mi);
1304 if (meter->position_lock_style() == AudioTime) {
1306 pair<double, BBT_Time> b_bbt;
1307 TempoSection* meter_locked_tempo = 0;
1308 for (Metrics::const_iterator ii = metrics.begin(); ii != metrics.end(); ++ii) {
1310 if ((*ii)->is_tempo()) {
1311 t = static_cast<TempoSection*> (*ii);
1312 if ((t->locked_to_meter() || !t->movable()) && t->frame() == meter->frame()) {
1313 meter_locked_tempo = t;
1320 const double beats = (meter->bbt().bars - prev_m->bbt().bars) * prev_m->divisions_per_bar();
1321 if (beats + prev_m->beat() != meter->beat()) {
1322 /* reordering caused a bbt change */
1323 b_bbt = make_pair (beats + prev_m->beat()
1324 , BBT_Time ((beats / prev_m->divisions_per_bar()) + prev_m->bbt().bars, 1, 0));
1325 pulse = prev_m->pulse() + (beats / prev_m->note_divisor());
1327 } else if (meter->movable()) {
1328 b_bbt = make_pair (meter->beat(), meter->bbt());
1329 pulse = prev_m->pulse() + (beats / prev_m->note_divisor());
1332 b_bbt = make_pair (0.0, BBT_Time (1, 1, 0));
1334 if (meter_locked_tempo) {
1335 meter_locked_tempo->set_pulse (pulse);
1337 meter->set_beat (b_bbt);
1338 meter->set_pulse (pulse);
1343 pair<double, BBT_Time> b_bbt;
1345 const double beats = (meter->bbt().bars - prev_m->bbt().bars) * prev_m->divisions_per_bar();
1346 if (beats + prev_m->beat() != meter->beat()) {
1347 /* reordering caused a bbt change */
1348 b_bbt = make_pair (beats + prev_m->beat()
1349 , BBT_Time ((beats / prev_m->divisions_per_bar()) + prev_m->bbt().bars, 1, 0));
1351 b_bbt = make_pair (beats + prev_m->beat(), meter->bbt());
1353 pulse = (beats / prev_m->note_divisor()) + prev_m->pulse();
1355 /* shouldn't happen - the first is audio-locked */
1356 pulse = pulse_at_beat_locked (metrics, meter->beat());
1357 b_bbt = make_pair (meter->beat(), meter->bbt());
1360 meter->set_beat (b_bbt);
1361 meter->set_pulse (pulse);
1362 meter->set_frame (frame_at_pulse_locked (metrics, pulse));
1371 TempoMap::recompute_map (Metrics& metrics, framepos_t end)
1373 /* CALLER MUST HOLD WRITE LOCK */
1377 /* we will actually stop once we hit
1384 DEBUG_TRACE (DEBUG::TempoMath, string_compose ("recomputing tempo map, zero to %1\n", end));
1387 /* silly call from Session::process() during startup
1392 recompute_tempi (metrics);
1393 recompute_meters (metrics);
1397 TempoMap::metric_at (framepos_t frame, Metrics::const_iterator* last) const
1399 Glib::Threads::RWLock::ReaderLock lm (lock);
1400 TempoMetric m (first_meter(), first_tempo());
1402 /* at this point, we are *guaranteed* to have m.meter and m.tempo pointing
1403 at something, because we insert the default tempo and meter during
1404 TempoMap construction.
1406 now see if we can find better candidates.
1409 for (Metrics::const_iterator i = _metrics.begin(); i != _metrics.end(); ++i) {
1411 if ((*i)->frame() > frame) {
1425 /* XX meters only */
1427 TempoMap::metric_at (BBT_Time bbt) const
1429 Glib::Threads::RWLock::ReaderLock lm (lock);
1430 TempoMetric m (first_meter(), first_tempo());
1432 /* at this point, we are *guaranteed* to have m.meter and m.tempo pointing
1433 at something, because we insert the default tempo and meter during
1434 TempoMap construction.
1436 now see if we can find better candidates.
1439 for (Metrics::const_iterator i = _metrics.begin(); i != _metrics.end(); ++i) {
1441 if (!(*i)->is_tempo()) {
1442 mw = static_cast<MeterSection*> (*i);
1443 BBT_Time section_start (mw->bbt());
1445 if (section_start.bars > bbt.bars || (section_start.bars == bbt.bars && section_start.beats > bbt.beats)) {
1456 /** Returns the beat duration corresponding to the supplied frame, possibly returning a negative value.
1457 * @param frame The session frame position.
1458 * @return The beat duration according to the tempo map at the supplied frame.
1459 * If the supplied frame lies before the first meter, the returned beat duration will be negative.
1460 * The returned beat is obtained using the first meter and the continuation of the tempo curve (backwards).
1462 * This function uses both tempo and meter.
1465 TempoMap::beat_at_frame (const framecnt_t& frame) const
1467 Glib::Threads::RWLock::ReaderLock lm (lock);
1468 return beat_at_frame_locked (_metrics, frame);
1471 /* This function uses both tempo and meter.*/
1473 TempoMap::beat_at_frame_locked (const Metrics& metrics, const framecnt_t& frame) const
1475 const TempoSection& ts = tempo_section_at_frame_locked (metrics, frame);
1476 MeterSection* prev_m = 0;
1477 MeterSection* next_m = 0;
1479 for (Metrics::const_iterator i = metrics.begin(); i != metrics.end(); ++i) {
1480 if (!(*i)->is_tempo()) {
1481 if (prev_m && (*i)->frame() > frame) {
1482 next_m = static_cast<MeterSection*> (*i);
1485 prev_m = static_cast<MeterSection*> (*i);
1489 const double beat = prev_m->beat() + (ts.pulse_at_frame (frame, _frame_rate) - prev_m->pulse()) * prev_m->note_divisor();
1491 /* audio locked meters fake their beat */
1492 if (next_m && next_m->beat() < beat) {
1493 return next_m->beat();
1500 TempoMap::frame_at_beat (const double& beat) const
1502 Glib::Threads::RWLock::ReaderLock lm (lock);
1503 return frame_at_beat_locked (_metrics, beat);
1506 /* meter & tempo section based */
1508 TempoMap::frame_at_beat_locked (const Metrics& metrics, const double& beat) const
1510 MeterSection* prev_m = 0;
1511 TempoSection* prev_t = 0;
1515 for (Metrics::const_iterator i = metrics.begin(); i != metrics.end(); ++i) {
1516 if (!(*i)->is_tempo()) {
1517 m = static_cast<MeterSection*> (*i);
1518 if (prev_m && m->beat() > beat) {
1527 for (Metrics::const_iterator i = metrics.begin(); i != metrics.end(); ++i) {
1528 if ((*i)->is_tempo()) {
1529 t = static_cast<TempoSection*> (*i);
1530 if (prev_t && ((t->pulse() - prev_m->pulse()) * prev_m->note_divisor()) + prev_m->beat() > beat) {
1538 return prev_t->frame_at_pulse (((beat - prev_m->beat()) / prev_m->note_divisor()) + prev_m->pulse(), _frame_rate);
1542 TempoMap::tempo_at_frame (const framepos_t& frame) const
1544 Glib::Threads::RWLock::ReaderLock lm (lock);
1545 return tempo_at_frame_locked (_metrics, frame);
1549 TempoMap::tempo_at_frame_locked (const Metrics& metrics, const framepos_t& frame) const
1551 TempoSection* prev_t = 0;
1555 for (Metrics::const_iterator i = _metrics.begin(); i != _metrics.end(); ++i) {
1556 if ((*i)->is_tempo()) {
1557 t = static_cast<TempoSection*> (*i);
1561 if ((prev_t) && t->frame() > frame) {
1562 /* t is the section past frame */
1563 const double ret_bpm = prev_t->tempo_at_frame (frame, _frame_rate) * 4.0;
1564 const Tempo ret_tempo (ret_bpm, prev_t->note_type());
1571 const double ret = prev_t->beats_per_minute();
1572 const Tempo ret_tempo (ret, prev_t->note_type ());
1577 /** returns the frame at which the supplied tempo occurs, or
1578 * the frame of the last tempo section (search exhausted)
1579 * only the position of the first occurence will be returned
1583 TempoMap::frame_at_tempo (const Tempo& tempo) const
1585 Glib::Threads::RWLock::ReaderLock lm (lock);
1586 return frame_at_tempo_locked (_metrics, tempo);
1591 TempoMap::frame_at_tempo_locked (const Metrics& metrics, const Tempo& tempo) const
1593 TempoSection* prev_t = 0;
1594 const double tempo_ppm = tempo.beats_per_minute() / 4.0;
1596 Metrics::const_iterator i;
1598 for (i = _metrics.begin(); i != _metrics.end(); ++i) {
1600 if ((*i)->is_tempo()) {
1601 t = static_cast<TempoSection*> (*i);
1607 const double t_ppm = t->beats_per_minute() / 4.0;
1609 if (t_ppm == tempo_ppm) {
1614 const double prev_t_ppm = prev_t->beats_per_minute() / 4.0;
1616 if ((t_ppm > tempo_ppm && prev_t_ppm < tempo_ppm) || (t_ppm < tempo_ppm && prev_t_ppm > tempo_ppm)) {
1617 return prev_t->frame_at_tempo (tempo_ppm, prev_t->pulse(), _frame_rate);
1624 return prev_t->frame();
1627 /** more precise than doing tempo_at_frame (frame_at_beat (b)),
1628 * as there is no intermediate frame rounding.
1631 TempoMap::tempo_at_beat (const double& beat) const
1633 Glib::Threads::RWLock::ReaderLock lm (lock);
1634 const MeterSection* prev_m = &meter_section_at_beat_locked (_metrics, beat);
1635 const TempoSection* prev_t = &tempo_section_at_beat_locked (_metrics, beat);
1636 const double note_type = prev_t->note_type();
1638 return Tempo (prev_t->tempo_at_pulse (((beat - prev_m->beat()) / prev_m->note_divisor()) + prev_m->pulse()) * 4.0, note_type);
1642 TempoMap::pulse_at_beat (const double& beat) const
1644 Glib::Threads::RWLock::ReaderLock lm (lock);
1645 return pulse_at_beat_locked (_metrics, beat);
1649 TempoMap::pulse_at_beat_locked (const Metrics& metrics, const double& beat) const
1651 const MeterSection* prev_m = &meter_section_at_beat_locked (metrics, beat);
1653 return prev_m->pulse() + ((beat - prev_m->beat()) / prev_m->note_divisor());
1657 TempoMap::beat_at_pulse (const double& pulse) const
1659 Glib::Threads::RWLock::ReaderLock lm (lock);
1660 return beat_at_pulse_locked (_metrics, pulse);
1664 TempoMap::beat_at_pulse_locked (const Metrics& metrics, const double& pulse) const
1666 MeterSection* prev_m = 0;
1668 for (Metrics::const_iterator i = metrics.begin(); i != metrics.end(); ++i) {
1670 if (!(*i)->is_tempo()) {
1671 m = static_cast<MeterSection*> (*i);
1672 if (prev_m && m->pulse() > pulse) {
1673 if (((pulse - prev_m->pulse()) * prev_m->note_divisor()) + prev_m->beat() > m->beat()) {
1681 double const ret = ((pulse - prev_m->pulse()) * prev_m->note_divisor()) + prev_m->beat();
1686 TempoMap::pulse_at_frame (const framepos_t& frame) const
1688 Glib::Threads::RWLock::ReaderLock lm (lock);
1689 return pulse_at_frame_locked (_metrics, frame);
1692 /* tempo section based */
1694 TempoMap::pulse_at_frame_locked (const Metrics& metrics, const framepos_t& frame) const
1696 /* HOLD (at least) THE READER LOCK */
1697 TempoSection* prev_t = 0;
1699 for (Metrics::const_iterator i = metrics.begin(); i != metrics.end(); ++i) {
1701 if ((*i)->is_tempo()) {
1702 t = static_cast<TempoSection*> (*i);
1706 if (prev_t && t->frame() > frame) {
1707 /*the previous ts is the one containing the frame */
1708 const double ret = prev_t->pulse_at_frame (frame, _frame_rate);
1709 /* audio locked section in new meter*/
1710 if (t->pulse() < ret) {
1719 /* treated as constant for this ts */
1720 const double pulses_in_section = (frame - prev_t->frame()) / prev_t->frames_per_pulse (_frame_rate);
1722 return pulses_in_section + prev_t->pulse();
1726 TempoMap::frame_at_pulse (const double& pulse) const
1728 Glib::Threads::RWLock::ReaderLock lm (lock);
1729 return frame_at_pulse_locked (_metrics, pulse);
1732 /* tempo section based */
1734 TempoMap::frame_at_pulse_locked (const Metrics& metrics, const double& pulse) const
1736 /* HOLD THE READER LOCK */
1738 const TempoSection* prev_t = 0;
1740 for (Metrics::const_iterator i = metrics.begin(); i != metrics.end(); ++i) {
1743 if ((*i)->is_tempo()) {
1744 t = static_cast<TempoSection*> (*i);
1748 if (prev_t && t->pulse() > pulse) {
1749 return prev_t->frame_at_pulse (pulse, _frame_rate);
1755 /* must be treated as constant, irrespective of _type */
1756 double const dtime = (pulse - prev_t->pulse()) * prev_t->frames_per_pulse (_frame_rate);
1758 return (framecnt_t) floor (dtime) + prev_t->frame();
1762 TempoMap::beat_at_bbt (const Timecode::BBT_Time& bbt)
1764 Glib::Threads::RWLock::ReaderLock lm (lock);
1765 return beat_at_bbt_locked (_metrics, bbt);
1770 TempoMap::beat_at_bbt_locked (const Metrics& metrics, const Timecode::BBT_Time& bbt) const
1772 /* CALLER HOLDS READ LOCK */
1774 MeterSection* prev_m = 0;
1776 /* because audio-locked meters have 'fake' integral beats,
1777 there is no pulse offset here.
1781 for (Metrics::const_iterator i = metrics.begin(); i != metrics.end(); ++i) {
1782 if (!(*i)->is_tempo()) {
1783 m = static_cast<MeterSection*> (*i);
1785 const double bars_to_m = (m->beat() - prev_m->beat()) / prev_m->divisions_per_bar();
1786 if ((bars_to_m + (prev_m->bbt().bars - 1)) > (bbt.bars - 1)) {
1794 const double remaining_bars = bbt.bars - prev_m->bbt().bars;
1795 const double remaining_bars_in_beats = remaining_bars * prev_m->divisions_per_bar();
1796 const double ret = remaining_bars_in_beats + prev_m->beat() + (bbt.beats - 1) + (bbt.ticks / BBT_Time::ticks_per_beat);
1802 TempoMap::bbt_at_beat (const double& beats)
1804 Glib::Threads::RWLock::ReaderLock lm (lock);
1805 return bbt_at_beat_locked (_metrics, beats);
1809 TempoMap::bbt_at_beat_locked (const Metrics& metrics, const double& b) const
1811 /* CALLER HOLDS READ LOCK */
1812 MeterSection* prev_m = 0;
1813 const double beats = max (0.0, b);
1815 MeterSection* m = 0;
1817 for (Metrics::const_iterator i = metrics.begin(); i != metrics.end(); ++i) {
1818 if (!(*i)->is_tempo()) {
1819 m = static_cast<MeterSection*> (*i);
1821 if (m->beat() > beats) {
1822 /* this is the meter after the one our beat is on*/
1831 const double beats_in_ms = beats - prev_m->beat();
1832 const uint32_t bars_in_ms = (uint32_t) floor (beats_in_ms / prev_m->divisions_per_bar());
1833 const uint32_t total_bars = bars_in_ms + (prev_m->bbt().bars - 1);
1834 const double remaining_beats = beats_in_ms - (bars_in_ms * prev_m->divisions_per_bar());
1835 const double remaining_ticks = (remaining_beats - floor (remaining_beats)) * BBT_Time::ticks_per_beat;
1839 ret.ticks = (uint32_t) floor (remaining_ticks + 0.5);
1840 ret.beats = (uint32_t) floor (remaining_beats);
1841 ret.bars = total_bars;
1843 /* 0 0 0 to 1 1 0 - based mapping*/
1847 if (ret.ticks >= BBT_Time::ticks_per_beat) {
1849 ret.ticks -= BBT_Time::ticks_per_beat;
1852 if (ret.beats >= prev_m->divisions_per_bar() + 1) {
1861 TempoMap::pulse_at_bbt (const Timecode::BBT_Time& bbt)
1863 Glib::Threads::RWLock::ReaderLock lm (lock);
1865 return pulse_at_bbt_locked (_metrics, bbt);
1869 TempoMap::pulse_at_bbt_rt (const Timecode::BBT_Time& bbt)
1871 Glib::Threads::RWLock::ReaderLock lm (lock);
1874 throw std::logic_error ("TempoMap::pulse_at_bbt_rt() could not lock tempo map");
1877 return pulse_at_bbt_locked (_metrics, bbt);
1881 TempoMap::pulse_at_bbt_locked (const Metrics& metrics, const Timecode::BBT_Time& bbt) const
1883 /* CALLER HOLDS READ LOCK */
1885 MeterSection* prev_m = 0;
1887 /* because audio-locked meters have 'fake' integral beats,
1888 there is no pulse offset here.
1892 for (Metrics::const_iterator i = metrics.begin(); i != metrics.end(); ++i) {
1893 if (!(*i)->is_tempo()) {
1894 m = static_cast<MeterSection*> (*i);
1896 if (m->bbt().bars > bbt.bars) {
1904 const double remaining_bars = bbt.bars - prev_m->bbt().bars;
1905 const double remaining_pulses = remaining_bars * prev_m->divisions_per_bar() / prev_m->note_divisor();
1906 const double ret = remaining_pulses + prev_m->pulse() + (((bbt.beats - 1) + (bbt.ticks / BBT_Time::ticks_per_beat)) / prev_m->note_divisor());
1912 TempoMap::bbt_at_pulse (const double& pulse)
1914 Glib::Threads::RWLock::ReaderLock lm (lock);
1916 return bbt_at_pulse_locked (_metrics, pulse);
1920 TempoMap::bbt_at_pulse_locked (const Metrics& metrics, const double& pulse) const
1922 MeterSection* prev_m = 0;
1924 MeterSection* m = 0;
1926 for (Metrics::const_iterator i = metrics.begin(); i != metrics.end(); ++i) {
1928 if (!(*i)->is_tempo()) {
1929 m = static_cast<MeterSection*> (*i);
1932 double const pulses_to_m = m->pulse() - prev_m->pulse();
1933 if (prev_m->pulse() + pulses_to_m > pulse) {
1934 /* this is the meter after the one our beat is on*/
1943 const double beats_in_ms = (pulse - prev_m->pulse()) * prev_m->note_divisor();
1944 const uint32_t bars_in_ms = (uint32_t) floor (beats_in_ms / prev_m->divisions_per_bar());
1945 const uint32_t total_bars = bars_in_ms + (prev_m->bbt().bars - 1);
1946 const double remaining_beats = beats_in_ms - (bars_in_ms * prev_m->divisions_per_bar());
1947 const double remaining_ticks = (remaining_beats - floor (remaining_beats)) * BBT_Time::ticks_per_beat;
1951 ret.ticks = (uint32_t) floor (remaining_ticks + 0.5);
1952 ret.beats = (uint32_t) floor (remaining_beats);
1953 ret.bars = total_bars;
1955 /* 0 0 0 to 1 1 0 mapping*/
1959 if (ret.ticks >= BBT_Time::ticks_per_beat) {
1961 ret.ticks -= BBT_Time::ticks_per_beat;
1964 if (ret.beats >= prev_m->divisions_per_bar() + 1) {
1973 TempoMap::bbt_at_frame (framepos_t frame)
1980 warning << string_compose (_("tempo map asked for BBT time at frame %1\n"), frame) << endmsg;
1983 Glib::Threads::RWLock::ReaderLock lm (lock);
1985 return bbt_at_frame_locked (_metrics, frame);
1989 TempoMap::bbt_at_frame_rt (framepos_t frame)
1991 Glib::Threads::RWLock::ReaderLock lm (lock, Glib::Threads::TRY_LOCK);
1994 throw std::logic_error ("TempoMap::bbt_at_frame_rt() could not lock tempo map");
1997 return bbt_at_frame_locked (_metrics, frame);
2001 TempoMap::bbt_at_frame_locked (const Metrics& metrics, const framepos_t& frame) const
2011 const TempoSection& ts = tempo_section_at_frame_locked (metrics, frame);
2012 MeterSection* prev_m = 0;
2013 MeterSection* next_m = 0;
2017 for (Metrics::const_iterator i = metrics.begin(); i != metrics.end(); ++i) {
2018 if (!(*i)->is_tempo()) {
2019 m = static_cast<MeterSection*> (*i);
2020 if (prev_m && m->frame() > frame) {
2028 double beat = prev_m->beat() + (ts.pulse_at_frame (frame, _frame_rate) - prev_m->pulse()) * prev_m->note_divisor();
2030 /* handle frame before first meter */
2031 if (frame < prev_m->frame()) {
2034 /* audio locked meters fake their beat */
2035 if (next_m && next_m->beat() < beat) {
2036 beat = next_m->beat();
2039 beat = max (0.0, beat);
2041 const double beats_in_ms = beat - prev_m->beat();
2042 const uint32_t bars_in_ms = (uint32_t) floor (beats_in_ms / prev_m->divisions_per_bar());
2043 const uint32_t total_bars = bars_in_ms + (prev_m->bbt().bars - 1);
2044 const double remaining_beats = beats_in_ms - (bars_in_ms * prev_m->divisions_per_bar());
2045 const double remaining_ticks = (remaining_beats - floor (remaining_beats)) * BBT_Time::ticks_per_beat;
2049 ret.ticks = (uint32_t) floor (remaining_ticks + 0.5);
2050 ret.beats = (uint32_t) floor (remaining_beats);
2051 ret.bars = total_bars;
2053 /* 0 0 0 to 1 1 0 - based mapping*/
2057 if (ret.ticks >= BBT_Time::ticks_per_beat) {
2059 ret.ticks -= BBT_Time::ticks_per_beat;
2062 if (ret.beats >= prev_m->divisions_per_bar() + 1) {
2071 TempoMap::frame_at_bbt (const BBT_Time& bbt)
2074 warning << string_compose (_("tempo map asked for frame time at bar < 1 (%1)\n"), bbt) << endmsg;
2078 if (bbt.beats < 1) {
2079 throw std::logic_error ("beats are counted from one");
2081 Glib::Threads::RWLock::ReaderLock lm (lock);
2083 return frame_at_bbt_locked (_metrics, bbt);
2086 /* meter & tempo section based */
2088 TempoMap::frame_at_bbt_locked (const Metrics& metrics, const BBT_Time& bbt) const
2090 /* HOLD THE READER LOCK */
2092 const framepos_t ret = frame_at_beat_locked (metrics, beat_at_bbt_locked (metrics, bbt));
2097 * Returns the distance from 0 in quarter pulses at the supplied frame.
2099 * Plugin APIs don't count ticks in the same way PROGRAM_NAME does.
2100 * We use ticks per beat whereas the rest of the world uses ticks per quarter note.
2101 * This is more or less the VST's ppqPos (a scalar you use to obtain tick position
2102 * in whatever ppqn you're using).
2104 * @param frame The distance in frames relative to session 0 whose quarter note distance you would like.
2105 * @return The quarter note (quarter pulse) distance from session 0 to the supplied frame. Ignores meter.
2109 TempoMap::quarter_note_at_frame (const framepos_t frame)
2111 Glib::Threads::RWLock::ReaderLock lm (lock, Glib::Threads::TRY_LOCK);
2113 const double ret = quarter_note_at_frame_locked (_metrics, frame);
2119 TempoMap::quarter_note_at_frame_locked (const Metrics& metrics, const framepos_t frame) const
2121 const double ret = pulse_at_frame_locked (metrics, frame) * 4.0;
2127 TempoMap::quarter_note_at_frame_rt (const framepos_t frame)
2129 Glib::Threads::RWLock::ReaderLock lm (lock, Glib::Threads::TRY_LOCK);
2132 throw std::logic_error ("TempoMap::quarter_note_at_frame_rt() could not lock tempo map");
2135 const double ret = pulse_at_frame_locked (_metrics, frame) * 4.0;
2141 TempoMap::frame_at_quarter_note (const double quarter_note)
2143 Glib::Threads::RWLock::ReaderLock lm (lock, Glib::Threads::TRY_LOCK);
2145 const framepos_t ret = frame_at_quarter_note_locked (_metrics, quarter_note);
2151 TempoMap::frame_at_quarter_note_locked (const Metrics& metrics, const double quarter_note) const
2153 const framepos_t ret = frame_at_pulse_locked (metrics, quarter_note / 4.0);
2159 TempoMap::quarter_note_at_beat (const double beat)
2161 Glib::Threads::RWLock::ReaderLock lm (lock, Glib::Threads::TRY_LOCK);
2163 const double ret = quarter_note_at_beat_locked (_metrics, beat);
2169 TempoMap::quarter_note_at_beat_locked (const Metrics& metrics, const double beat) const
2171 const double ret = pulse_at_beat_locked (metrics, beat) * 4.0;
2177 TempoMap::beat_at_quarter_note (const double quarter_note)
2179 Glib::Threads::RWLock::ReaderLock lm (lock, Glib::Threads::TRY_LOCK);
2181 const double ret = beat_at_pulse_locked (_metrics, quarter_note / 4.0);
2187 TempoMap::check_solved (const Metrics& metrics) const
2189 TempoSection* prev_t = 0;
2190 MeterSection* prev_m = 0;
2192 for (Metrics::const_iterator i = metrics.begin(); i != metrics.end(); ++i) {
2195 if ((*i)->is_tempo()) {
2196 t = static_cast<TempoSection*> (*i);
2201 /* check ordering */
2202 if ((t->frame() <= prev_t->frame()) || (t->pulse() <= prev_t->pulse())) {
2206 /* precision check ensures tempo and frames align.*/
2207 if (t->frame() != prev_t->frame_at_tempo (t->pulses_per_minute(), t->pulse(), _frame_rate)) {
2208 if (!t->locked_to_meter()) {
2213 /* gradient limit - who knows what it should be?
2214 things are also ok (if a little chaotic) without this
2216 if (fabs (prev_t->c_func()) > 1000.0) {
2217 //std::cout << "c : " << prev_t->c_func() << std::endl;
2224 if (!(*i)->is_tempo()) {
2225 m = static_cast<MeterSection*> (*i);
2226 if (prev_m && m->position_lock_style() == AudioTime) {
2227 const TempoSection* t = &tempo_section_at_frame_locked (metrics, m->frame() - 1);
2228 const framepos_t nascent_m_frame = t->frame_at_pulse (m->pulse(), _frame_rate);
2229 /* Here we check that a preceding section of music doesn't overlap a subsequent one.
2230 It is complicated by the fact that audio locked meters represent a discontinuity in the pulse
2231 (they place an exact pulse at a particular time expressed only in frames).
2232 This has the effect of shifting the calculated frame at the meter pulse (wrt the previous section of music)
2233 away from its actual frame (which is now the frame location of the exact pulse).
2234 This can result in the calculated frame (from the previous musical section)
2235 differing from the exact frame by one sample.
2238 if (t && (nascent_m_frame > m->frame() + 1 || nascent_m_frame < 0)) {
2252 TempoMap::set_active_tempos (const Metrics& metrics, const framepos_t& frame)
2254 for (Metrics::const_iterator i = metrics.begin(); i != metrics.end(); ++i) {
2256 if ((*i)->is_tempo()) {
2257 t = static_cast<TempoSection*> (*i);
2258 if (!t->movable()) {
2259 t->set_active (true);
2262 if (t->movable() && t->active () && t->position_lock_style() == AudioTime && t->frame() < frame) {
2263 t->set_active (false);
2265 } else if (t->movable() && t->position_lock_style() == AudioTime && t->frame() > frame) {
2266 t->set_active (true);
2267 } else if (t->movable() && t->position_lock_style() == AudioTime && t->frame() == frame) {
2276 TempoMap::solve_map_frame (Metrics& imaginary, TempoSection* section, const framepos_t& frame)
2278 TempoSection* prev_t = 0;
2279 TempoSection* section_prev = 0;
2280 framepos_t first_m_frame = 0;
2282 /* can't move a tempo before the first meter */
2283 for (Metrics::iterator i = imaginary.begin(); i != imaginary.end(); ++i) {
2285 if (!(*i)->is_tempo()) {
2286 m = static_cast<MeterSection*> (*i);
2287 if (!m->movable()) {
2288 first_m_frame = m->frame();
2293 if (section->movable() && frame <= first_m_frame) {
2297 section->set_active (true);
2298 section->set_frame (frame);
2300 for (Metrics::iterator i = imaginary.begin(); i != imaginary.end(); ++i) {
2302 if ((*i)->is_tempo()) {
2303 t = static_cast<TempoSection*> (*i);
2310 section_prev = prev_t;
2311 if (t->locked_to_meter()) {
2316 if (t->position_lock_style() == MusicTime) {
2317 prev_t->set_c_func (prev_t->compute_c_func_pulse (t->pulses_per_minute(), t->pulse(), _frame_rate));
2318 t->set_frame (prev_t->frame_at_pulse (t->pulse(), _frame_rate));
2320 prev_t->set_c_func (prev_t->compute_c_func_frame (t->pulses_per_minute(), t->frame(), _frame_rate));
2321 if (!t->locked_to_meter()) {
2322 t->set_pulse (prev_t->pulse_at_frame (t->frame(), _frame_rate));
2331 section_prev->set_c_func (section_prev->compute_c_func_frame (section->pulses_per_minute(), frame, _frame_rate));
2332 if (!section->locked_to_meter()) {
2333 section->set_pulse (section_prev->pulse_at_frame (frame, _frame_rate));
2338 recompute_tempi (imaginary);
2340 if (check_solved (imaginary)) {
2343 dunp (imaginary, std::cout);
2347 MetricSectionFrameSorter fcmp;
2348 imaginary.sort (fcmp);
2350 recompute_tempi (imaginary);
2352 if (check_solved (imaginary)) {
2360 TempoMap::solve_map_pulse (Metrics& imaginary, TempoSection* section, const double& pulse)
2362 TempoSection* prev_t = 0;
2363 TempoSection* section_prev = 0;
2365 section->set_pulse (pulse);
2367 for (Metrics::iterator i = imaginary.begin(); i != imaginary.end(); ++i) {
2369 if ((*i)->is_tempo()) {
2370 t = static_cast<TempoSection*> (*i);
2374 if (!t->movable()) {
2381 section_prev = prev_t;
2384 if (t->position_lock_style() == MusicTime) {
2385 prev_t->set_c_func (prev_t->compute_c_func_pulse (t->pulses_per_minute(), t->pulse(), _frame_rate));
2386 t->set_frame (prev_t->frame_at_pulse (t->pulse(), _frame_rate));
2388 prev_t->set_c_func (prev_t->compute_c_func_frame (t->pulses_per_minute(), t->frame(), _frame_rate));
2389 if (!t->locked_to_meter()) {
2390 t->set_pulse (prev_t->pulse_at_frame (t->frame(), _frame_rate));
2399 section_prev->set_c_func (section_prev->compute_c_func_pulse (section->pulses_per_minute(), pulse, _frame_rate));
2400 section->set_frame (section_prev->frame_at_pulse (pulse, _frame_rate));
2404 recompute_tempi (imaginary);
2406 if (check_solved (imaginary)) {
2409 dunp (imaginary, std::cout);
2413 MetricSectionSorter cmp;
2414 imaginary.sort (cmp);
2416 recompute_tempi (imaginary);
2418 * XX need a restriction here, but only for this case,
2419 * as audio locked tempos don't interact in the same way.
2421 * With music-locked tempos, the solution to cross-dragging can fly off the screen
2423 * |50 bpm |250 bpm |60 bpm
2424 * drag 250 to the pulse after 60->
2425 * a clue: dragging the second 60 <- past the 250 would cause no such problem.
2427 if (check_solved (imaginary)) {
2435 TempoMap::solve_map_frame (Metrics& imaginary, MeterSection* section, const framepos_t& frame)
2437 /* disallow moving first meter past any subsequent one, and any movable meter before the first one */
2438 const MeterSection* other = &meter_section_at_frame_locked (imaginary, frame);
2439 if ((!section->movable() && other->movable()) || (!other->movable() && section->movable() && other->frame() >= frame)) {
2443 if (!section->movable()) {
2444 /* lock the first tempo to our first meter */
2445 if (!set_active_tempos (imaginary, frame)) {
2450 TempoSection* meter_locked_tempo = 0;
2452 for (Metrics::const_iterator ii = imaginary.begin(); ii != imaginary.end(); ++ii) {
2454 if ((*ii)->is_tempo()) {
2455 t = static_cast<TempoSection*> (*ii);
2456 if ((t->locked_to_meter() || !t->movable()) && t->frame() == section->frame()) {
2457 meter_locked_tempo = t;
2463 if (!meter_locked_tempo) {
2467 MeterSection* prev_m = 0;
2469 TempoSection* tempo_copy = copy_metrics_and_point (imaginary, future_map, meter_locked_tempo);
2470 bool solved = false;
2472 for (Metrics::iterator i = imaginary.begin(); i != imaginary.end(); ++i) {
2474 if (!(*i)->is_tempo()) {
2475 m = static_cast<MeterSection*> (*i);
2477 if (prev_m && section->movable()) {
2478 const double beats = (pulse_at_frame_locked (imaginary, frame) - prev_m->pulse()) * prev_m->note_divisor();
2479 if (beats + prev_m->beat() < section->beat()) {
2480 /* set the frame/pulse corresponding to its musical position,
2481 * as an earlier time than this has been requested.
2483 const double new_pulse = ((section->beat() - prev_m->beat())
2484 / prev_m->note_divisor()) + prev_m->pulse();
2486 const framepos_t smallest_frame = frame_at_pulse_locked (future_map, new_pulse);
2488 if ((solved = solve_map_frame (future_map, tempo_copy, smallest_frame))) {
2489 meter_locked_tempo->set_pulse (new_pulse);
2490 solve_map_frame (imaginary, meter_locked_tempo, smallest_frame);
2491 section->set_frame (smallest_frame);
2492 section->set_pulse (new_pulse);
2497 Metrics::const_iterator d = future_map.begin();
2498 while (d != future_map.end()) {
2507 /* all is ok. set section's locked tempo if allowed.
2508 possibly disallowed if there is an adjacent audio-locked tempo.
2509 XX this check could possibly go. its never actually happened here.
2511 MeterSection* meter_copy = const_cast<MeterSection*> (&meter_section_at_frame_locked (future_map, section->frame()));
2512 meter_copy->set_frame (frame);
2514 if ((solved = solve_map_frame (future_map, tempo_copy, frame))) {
2515 section->set_frame (frame);
2516 meter_locked_tempo->set_pulse (((section->beat() - prev_m->beat())
2517 / prev_m->note_divisor()) + prev_m->pulse());
2518 solve_map_frame (imaginary, meter_locked_tempo, frame);
2523 Metrics::const_iterator d = future_map.begin();
2524 while (d != future_map.end()) {
2534 /* not movable (first meter atm) */
2536 tempo_copy->set_frame (frame);
2537 tempo_copy->set_pulse (0.0);
2539 if ((solved = solve_map_frame (future_map, tempo_copy, frame))) {
2540 section->set_frame (frame);
2541 meter_locked_tempo->set_frame (frame);
2542 meter_locked_tempo->set_pulse (0.0);
2543 solve_map_frame (imaginary, meter_locked_tempo, frame);
2548 Metrics::const_iterator d = future_map.begin();
2549 while (d != future_map.end()) {
2558 pair<double, BBT_Time> b_bbt = make_pair (0.0, BBT_Time (1, 1, 0));
2559 section->set_beat (b_bbt);
2560 section->set_pulse (0.0);
2570 MetricSectionFrameSorter fcmp;
2571 imaginary.sort (fcmp);
2573 recompute_meters (imaginary);
2579 TempoMap::solve_map_bbt (Metrics& imaginary, MeterSection* section, const BBT_Time& when)
2581 /* disallow setting section to an existing meter's bbt */
2582 for (Metrics::iterator i = imaginary.begin(); i != imaginary.end(); ++i) {
2584 if (!(*i)->is_tempo()) {
2585 m = static_cast<MeterSection*> (*i);
2586 if (m != section && m->bbt().bars == when.bars) {
2592 MeterSection* prev_m = 0;
2593 MeterSection* section_prev = 0;
2595 for (Metrics::iterator i = imaginary.begin(); i != imaginary.end(); ++i) {
2597 if (!(*i)->is_tempo()) {
2598 m = static_cast<MeterSection*> (*i);
2599 pair<double, BBT_Time> b_bbt;
2600 double new_pulse = 0.0;
2602 if (prev_m && m->bbt().bars > when.bars && !section_prev){
2603 section_prev = prev_m;
2604 const double beats = (when.bars - section_prev->bbt().bars) * section_prev->divisions_per_bar();
2605 const double pulse = (beats / section_prev->note_divisor()) + section_prev->pulse();
2606 pair<double, BBT_Time> b_bbt = make_pair (beats + section_prev->beat(), when);
2608 section->set_beat (b_bbt);
2609 section->set_pulse (pulse);
2610 section->set_frame (frame_at_pulse_locked (imaginary, pulse));
2615 if (m->position_lock_style() == AudioTime) {
2616 TempoSection* meter_locked_tempo = 0;
2618 for (Metrics::const_iterator ii = imaginary.begin(); ii != imaginary.end(); ++ii) {
2620 if ((*ii)->is_tempo()) {
2621 t = static_cast<TempoSection*> (*ii);
2622 if ((t->locked_to_meter() || !t->movable()) && t->frame() == m->frame()) {
2623 meter_locked_tempo = t;
2629 if (!meter_locked_tempo) {
2634 const double beats = ((m->bbt().bars - prev_m->bbt().bars) * prev_m->divisions_per_bar());
2636 if (beats + prev_m->beat() != m->beat()) {
2637 /* tempo/ meter change caused a change in beat (bar). */
2638 b_bbt = make_pair (beats + prev_m->beat()
2639 , BBT_Time ((beats / prev_m->divisions_per_bar()) + prev_m->bbt().bars, 1, 0));
2640 new_pulse = prev_m->pulse() + (beats / prev_m->note_divisor());
2641 } else if (m->movable()) {
2642 b_bbt = make_pair (m->beat(), m->bbt());
2643 new_pulse = prev_m->pulse() + (beats / prev_m->note_divisor());
2646 b_bbt = make_pair (0.0, BBT_Time (1, 1, 0));
2649 meter_locked_tempo->set_pulse (new_pulse);
2650 m->set_beat (b_bbt);
2651 m->set_pulse (new_pulse);
2655 const double beats = ((m->bbt().bars - prev_m->bbt().bars) * prev_m->divisions_per_bar());
2656 if (beats + prev_m->beat() != m->beat()) {
2657 /* tempo/ meter change caused a change in beat (bar). */
2658 b_bbt = make_pair (beats + prev_m->beat()
2659 , BBT_Time ((beats / prev_m->divisions_per_bar()) + prev_m->bbt().bars, 1, 0));
2661 b_bbt = make_pair (beats + prev_m->beat()
2664 new_pulse = (beats / prev_m->note_divisor()) + prev_m->pulse();
2665 m->set_beat (b_bbt);
2666 m->set_pulse (new_pulse);
2667 m->set_frame (frame_at_pulse_locked (imaginary, new_pulse));
2674 if (!section_prev) {
2676 const double beats = (when.bars - prev_m->bbt().bars) * prev_m->divisions_per_bar();
2677 const double pulse = (beats / prev_m->note_divisor()) + prev_m->pulse();
2678 pair<double, BBT_Time> b_bbt = make_pair (beats + prev_m->beat(), when);
2680 section->set_beat (b_bbt);
2681 section->set_pulse (pulse);
2682 section->set_frame (frame_at_pulse_locked (imaginary, pulse));
2685 MetricSectionSorter cmp;
2686 imaginary.sort (cmp);
2688 recompute_meters (imaginary);
2693 /** places a copy of _metrics into copy and returns a pointer
2694 * to section's equivalent in copy.
2697 TempoMap::copy_metrics_and_point (const Metrics& metrics, Metrics& copy, TempoSection* section)
2699 TempoSection* ret = 0;
2701 for (Metrics::const_iterator i = metrics.begin(); i != metrics.end(); ++i) {
2704 if ((*i)->is_tempo()) {
2705 t = static_cast<TempoSection*> (*i);
2707 ret = new TempoSection (*t);
2708 copy.push_back (ret);
2712 TempoSection* cp = new TempoSection (*t);
2713 copy.push_back (cp);
2715 if (!(*i)->is_tempo()) {
2716 m = static_cast<MeterSection *> (*i);
2717 MeterSection* cp = new MeterSection (*m);
2718 copy.push_back (cp);
2726 TempoMap::copy_metrics_and_point (const Metrics& metrics, Metrics& copy, MeterSection* section)
2728 MeterSection* ret = 0;
2730 for (Metrics::const_iterator i = metrics.begin(); i != metrics.end(); ++i) {
2733 if ((*i)->is_tempo()) {
2734 t = static_cast<TempoSection*> (*i);
2735 TempoSection* cp = new TempoSection (*t);
2736 copy.push_back (cp);
2739 if (!(*i)->is_tempo()) {
2740 m = static_cast<MeterSection *> (*i);
2742 ret = new MeterSection (*m);
2743 copy.push_back (ret);
2746 MeterSection* cp = new MeterSection (*m);
2747 copy.push_back (cp);
2754 /** answers the question "is this a valid beat position for this tempo section?".
2755 * it returns true if the tempo section can be moved to the requested bbt position,
2756 * leaving the tempo map in a solved state.
2757 * @param section the tempo section to be moved
2758 * @param bbt the requested new position for the tempo section
2759 * @return true if the tempo section can be moved to the position, otherwise false.
2762 TempoMap::can_solve_bbt (TempoSection* ts, const BBT_Time& bbt)
2765 TempoSection* tempo_copy = 0;
2768 Glib::Threads::RWLock::ReaderLock lm (lock);
2769 tempo_copy = copy_metrics_and_point (_metrics, copy, ts);
2775 const bool ret = solve_map_pulse (copy, tempo_copy, pulse_at_bbt_locked (copy, bbt));
2777 Metrics::const_iterator d = copy.begin();
2778 while (d != copy.end()) {
2787 * This is for a gui that needs to know the pulse or frame of a tempo section if it were to be moved to some bbt time,
2788 * taking any possible reordering as a consequence of this into account.
2789 * @param section - the section to be altered
2790 * @param bbt - the bbt where the altered tempo will fall
2791 * @return returns - the position in pulses and frames (as a pair) where the new tempo section will lie.
2793 pair<double, framepos_t>
2794 TempoMap::predict_tempo_position (TempoSection* section, const BBT_Time& bbt)
2797 pair<double, framepos_t> ret = make_pair (0.0, 0);
2799 Glib::Threads::RWLock::ReaderLock lm (lock);
2801 TempoSection* tempo_copy = copy_metrics_and_point (_metrics, future_map, section);
2803 const double beat = beat_at_bbt_locked (future_map, bbt);
2805 if (solve_map_pulse (future_map, tempo_copy, pulse_at_beat_locked (future_map, beat))) {
2806 ret.first = tempo_copy->pulse();
2807 ret.second = tempo_copy->frame();
2809 ret.first = section->pulse();
2810 ret.second = section->frame();
2813 Metrics::const_iterator d = future_map.begin();
2814 while (d != future_map.end()) {
2822 TempoMap::gui_move_tempo (TempoSection* ts, const framepos_t& frame, const int& sub_num)
2826 if (ts->position_lock_style() == MusicTime) {
2828 /* if we're snapping to a musical grid, set the pulse exactly instead of via the supplied frame. */
2829 Glib::Threads::RWLock::WriterLock lm (lock);
2830 TempoSection* tempo_copy = copy_metrics_and_point (_metrics, future_map, ts);
2832 tempo_copy->set_position_lock_style (AudioTime);
2834 if (solve_map_frame (future_map, tempo_copy, frame)) {
2835 const double beat = exact_beat_at_frame_locked (future_map, frame, sub_num);
2836 const double pulse = pulse_at_beat_locked (future_map, beat);
2838 if (solve_map_pulse (future_map, tempo_copy, pulse)) {
2839 solve_map_pulse (_metrics, ts, pulse);
2840 recompute_meters (_metrics);
2848 Glib::Threads::RWLock::WriterLock lm (lock);
2849 TempoSection* tempo_copy = copy_metrics_and_point (_metrics, future_map, ts);
2851 if (solve_map_frame (future_map, tempo_copy, frame)) {
2853 /* We're moving the object that defines the grid while snapping to it...
2854 * Placing the ts at the beat corresponding to the requested frame may shift the
2855 * grid in such a way that the mouse is left hovering over a completerly different division,
2856 * causing jittering when the mouse next moves (esp. large tempo deltas).
2857 * To avoid this, place the ts at the requested frame in a dummy map
2858 * then find the closest beat subdivision to that frame in the dummy.
2859 * This alters the snap behaviour slightly in that we snap to beat divisions
2860 * in the future map rather than the existing one.
2862 const double beat = exact_beat_at_frame_locked (future_map, frame, sub_num);
2863 const double pulse = pulse_at_beat_locked (future_map, beat);
2865 if (solve_map_pulse (future_map, tempo_copy, pulse)) {
2866 /* snapping to a grid. force MusicTime temporarily. */
2867 ts->set_position_lock_style (MusicTime);
2868 solve_map_pulse (_metrics, ts, pulse);
2869 ts->set_position_lock_style (AudioTime);
2871 recompute_meters (_metrics);
2874 solve_map_frame (_metrics, ts, frame);
2875 recompute_meters (_metrics);
2881 Metrics::const_iterator d = future_map.begin();
2882 while (d != future_map.end()) {
2887 MetricPositionChanged (); // Emit Signal
2891 TempoMap::gui_move_meter (MeterSection* ms, const framepos_t& frame)
2895 if (ms->position_lock_style() == AudioTime) {
2898 Glib::Threads::RWLock::WriterLock lm (lock);
2899 MeterSection* copy = copy_metrics_and_point (_metrics, future_map, ms);
2901 if (solve_map_frame (future_map, copy, frame)) {
2902 solve_map_frame (_metrics, ms, frame);
2903 recompute_tempi (_metrics);
2908 Glib::Threads::RWLock::WriterLock lm (lock);
2909 MeterSection* copy = copy_metrics_and_point (_metrics, future_map, ms);
2911 const double beat = beat_at_frame_locked (_metrics, frame);
2912 const Timecode::BBT_Time bbt = bbt_at_beat_locked (_metrics, beat);
2914 if (solve_map_bbt (future_map, copy, bbt)) {
2915 solve_map_bbt (_metrics, ms, bbt);
2916 recompute_tempi (_metrics);
2921 Metrics::const_iterator d = future_map.begin();
2922 while (d != future_map.end()) {
2927 MetricPositionChanged (); // Emit Signal
2931 TempoMap::gui_change_tempo (TempoSection* ts, const Tempo& bpm)
2934 bool can_solve = false;
2936 Glib::Threads::RWLock::WriterLock lm (lock);
2937 TempoSection* tempo_copy = copy_metrics_and_point (_metrics, future_map, ts);
2938 tempo_copy->set_beats_per_minute (bpm.beats_per_minute());
2939 recompute_tempi (future_map);
2941 if (check_solved (future_map)) {
2942 ts->set_beats_per_minute (bpm.beats_per_minute());
2943 recompute_map (_metrics);
2948 Metrics::const_iterator d = future_map.begin();
2949 while (d != future_map.end()) {
2954 MetricPositionChanged (); // Emit Signal
2960 TempoMap::gui_dilate_tempo (TempoSection* ts, const framepos_t& frame, const framepos_t& end_frame, const double& pulse)
2963 Ts (future prev_t) Tnext
2966 |----------|----------
2973 Glib::Threads::RWLock::WriterLock lm (lock);
2979 TempoSection* prev_t = copy_metrics_and_point (_metrics, future_map, ts);
2980 TempoSection* prev_to_prev_t = 0;
2981 const frameoffset_t fr_off = end_frame - frame;
2983 if (prev_t && prev_t->pulse() > 0.0) {
2984 prev_to_prev_t = const_cast<TempoSection*>(&tempo_section_at_frame_locked (future_map, prev_t->frame() - 1));
2987 TempoSection* next_t = 0;
2988 for (Metrics::iterator i = future_map.begin(); i != future_map.end(); ++i) {
2989 TempoSection* t = 0;
2990 if ((*i)->is_tempo()) {
2991 t = static_cast<TempoSection*> (*i);
2992 if (t->frame() > ts->frame()) {
2998 /* minimum allowed measurement distance in frames */
2999 const framepos_t min_dframe = 2;
3001 /* the change in frames is the result of changing the slope of at most 2 previous tempo sections.
3002 constant to constant is straightforward, as the tempo prev to prev_t has constant slope.
3004 double contribution = 0.0;
3006 if (next_t && prev_to_prev_t && prev_to_prev_t->type() == TempoSection::Ramp) {
3007 contribution = (prev_t->frame() - prev_to_prev_t->frame()) / (double) (next_t->frame() - prev_to_prev_t->frame());
3010 const frameoffset_t prev_t_frame_contribution = fr_off - (contribution * (double) fr_off);
3012 const double start_pulse = prev_t->pulse_at_frame (frame, _frame_rate);
3013 const double end_pulse = prev_t->pulse_at_frame (end_frame, _frame_rate);
3017 if (prev_t->type() == TempoSection::Constant || prev_t->c_func() == 0.0) {
3019 if (prev_t->position_lock_style() == MusicTime) {
3020 if (prev_to_prev_t && prev_to_prev_t->type() == TempoSection::Ramp) {
3021 if (frame > prev_to_prev_t->frame() + min_dframe && (frame + prev_t_frame_contribution) > prev_to_prev_t->frame() + min_dframe) {
3023 new_bpm = prev_t->beats_per_minute() * ((frame - prev_to_prev_t->frame())
3024 / (double) ((frame + prev_t_frame_contribution) - prev_to_prev_t->frame()));
3026 new_bpm = prev_t->beats_per_minute();
3029 /* prev to prev is irrelevant */
3031 if (start_pulse > prev_t->pulse() && end_pulse > prev_t->pulse()) {
3032 new_bpm = prev_t->beats_per_minute() * ((start_pulse - prev_t->pulse()) / (end_pulse - prev_t->pulse()));
3034 new_bpm = prev_t->beats_per_minute();
3039 if (prev_to_prev_t && prev_to_prev_t->type() == TempoSection::Ramp) {
3040 if (frame > prev_to_prev_t->frame() + min_dframe && end_frame > prev_to_prev_t->frame() + min_dframe) {
3042 new_bpm = prev_t->beats_per_minute() * ((frame - prev_to_prev_t->frame())
3043 / (double) ((end_frame) - prev_to_prev_t->frame()));
3045 new_bpm = prev_t->beats_per_minute();
3048 /* prev_to_prev_t is irrelevant */
3050 if (frame > prev_t->frame() + min_dframe && end_frame > prev_t->frame() + min_dframe) {
3051 new_bpm = prev_t->beats_per_minute() * ((frame - prev_t->frame()) / (double) (end_frame - prev_t->frame()));
3053 new_bpm = prev_t->beats_per_minute();
3059 double frame_ratio = 1.0;
3060 double pulse_ratio = 1.0;
3061 const framepos_t pulse_pos = prev_t->frame_at_pulse (pulse, _frame_rate);
3063 if (prev_to_prev_t) {
3064 if (pulse_pos > prev_to_prev_t->frame() + min_dframe && (pulse_pos - fr_off) > prev_to_prev_t->frame() + min_dframe) {
3065 frame_ratio = (((pulse_pos - fr_off) - prev_to_prev_t->frame()) / (double) ((pulse_pos) - prev_to_prev_t->frame()));
3067 if (end_pulse > prev_to_prev_t->pulse() && start_pulse > prev_to_prev_t->pulse()) {
3068 pulse_ratio = ((start_pulse - prev_to_prev_t->pulse()) / (end_pulse - prev_to_prev_t->pulse()));
3071 if (pulse_pos > prev_t->frame() + min_dframe && (pulse_pos - fr_off) > prev_t->frame() + min_dframe) {
3072 frame_ratio = (((pulse_pos - fr_off) - prev_t->frame()) / (double) ((pulse_pos) - prev_t->frame()));
3074 pulse_ratio = (start_pulse / end_pulse);
3076 new_bpm = prev_t->beats_per_minute() * (pulse_ratio * frame_ratio);
3079 /* don't clamp and proceed here.
3080 testing has revealed that this can go negative,
3081 which is an entirely different thing to just being too low.
3083 if (new_bpm < 0.5) {
3086 new_bpm = min (new_bpm, (double) 1000.0);
3087 prev_t->set_beats_per_minute (new_bpm);
3088 recompute_tempi (future_map);
3089 recompute_meters (future_map);
3091 if (check_solved (future_map)) {
3092 ts->set_beats_per_minute (new_bpm);
3093 recompute_tempi (_metrics);
3094 recompute_meters (_metrics);
3098 Metrics::const_iterator d = future_map.begin();
3099 while (d != future_map.end()) {
3104 MetricPositionChanged (); // Emit Signal
3107 /** Returns the exact beat subdivision closest to the supplied frame, possibly returning a negative value.
3108 * @param frame The session frame position.
3109 * @param sub_num The requested beat subdivision to use when rounding the frame position.
3110 * @return The beat position of the supplied frame.
3111 * If the supplied frame lies before the first meter, the return will be negative.
3112 * The returned beat is obtained using the first meter and the continuation of the tempo curve (backwards).
3114 * This function uses both tempo and meter.
3117 TempoMap::exact_beat_at_frame (const framepos_t& frame, const int32_t sub_num)
3119 Glib::Threads::RWLock::ReaderLock lm (lock);
3121 return exact_beat_at_frame_locked (_metrics, frame, sub_num);
3125 TempoMap::exact_beat_at_frame_locked (const Metrics& metrics, const framepos_t& frame, const int32_t sub_num)
3127 double beat = beat_at_frame_locked (metrics, frame);
3130 beat = floor (beat) + (floor (((beat - floor (beat)) * (double) sub_num) + 0.5) / sub_num);
3131 } else if (sub_num == 1) {
3133 beat = floor (beat + 0.5);
3134 } else if (sub_num == -1) {
3136 Timecode::BBT_Time bbt = bbt_at_beat_locked (metrics, beat);
3140 const double prev_b = beat_at_bbt_locked (_metrics, bbt);
3142 const double next_b = beat_at_bbt_locked (_metrics, bbt);
3144 if ((beat - prev_b) > (next_b - prev_b) / 2.0) {
3154 TempoMap::exact_qn_at_frame (const framepos_t& frame, const int32_t sub_num)
3156 Glib::Threads::RWLock::ReaderLock lm (lock);
3158 return exact_qn_at_frame_locked (_metrics, frame, sub_num);
3162 TempoMap::exact_qn_at_frame_locked (const Metrics& metrics, const framepos_t& frame, const int32_t sub_num)
3164 double qn = quarter_note_at_frame_locked (metrics, frame);
3167 qn = floor (qn) + (floor (((qn - floor (qn)) * (double) sub_num) + 0.5) / sub_num);
3168 } else if (sub_num == 1) {
3169 /* snap to quarter note */
3170 qn = floor (qn + 0.5);
3171 } else if (sub_num == -1) {
3173 Timecode::BBT_Time bbt = bbt_at_pulse_locked (metrics, qn / 4.0);
3177 const double prev_b = pulse_at_bbt_locked (_metrics, bbt) * 4.0;
3179 const double next_b = pulse_at_bbt_locked (_metrics, bbt) * 4.0;
3181 if ((qn - prev_b) > (next_b - prev_b) / 2.0) {
3192 TempoMap::bbt_duration_at (framepos_t pos, const BBT_Time& bbt, int dir)
3194 Glib::Threads::RWLock::ReaderLock lm (lock);
3196 const double tick_at_time = max (0.0, beat_at_frame_locked (_metrics, pos)) * BBT_Time::ticks_per_beat;
3197 const double bbt_ticks = bbt.ticks + (bbt.beats * BBT_Time::ticks_per_beat);
3198 const double total_beats = (tick_at_time + bbt_ticks) / BBT_Time::ticks_per_beat;
3200 return frame_at_beat_locked (_metrics, total_beats);
3204 TempoMap::round_to_bar (framepos_t fr, RoundMode dir)
3206 return round_to_type (fr, dir, Bar);
3210 TempoMap::round_to_beat (framepos_t fr, RoundMode dir)
3212 return round_to_type (fr, dir, Beat);
3216 TempoMap::round_to_beat_subdivision (framepos_t fr, int sub_num, RoundMode dir)
3218 Glib::Threads::RWLock::ReaderLock lm (lock);
3219 uint32_t ticks = (uint32_t) floor (max (0.0, beat_at_frame_locked (_metrics, fr)) * BBT_Time::ticks_per_beat);
3220 uint32_t beats = (uint32_t) floor (ticks / BBT_Time::ticks_per_beat);
3221 uint32_t ticks_one_subdivisions_worth = (uint32_t) BBT_Time::ticks_per_beat / sub_num;
3223 ticks -= beats * BBT_Time::ticks_per_beat;
3226 /* round to next (or same iff dir == RoundUpMaybe) */
3228 uint32_t mod = ticks % ticks_one_subdivisions_worth;
3230 if (mod == 0 && dir == RoundUpMaybe) {
3231 /* right on the subdivision, which is fine, so do nothing */
3233 } else if (mod == 0) {
3234 /* right on the subdivision, so the difference is just the subdivision ticks */
3235 ticks += ticks_one_subdivisions_worth;
3238 /* not on subdivision, compute distance to next subdivision */
3240 ticks += ticks_one_subdivisions_worth - mod;
3243 if (ticks >= BBT_Time::ticks_per_beat) {
3244 ticks -= BBT_Time::ticks_per_beat;
3246 } else if (dir < 0) {
3248 /* round to previous (or same iff dir == RoundDownMaybe) */
3250 uint32_t difference = ticks % ticks_one_subdivisions_worth;
3252 if (difference == 0 && dir == RoundDownAlways) {
3253 /* right on the subdivision, but force-rounding down,
3254 so the difference is just the subdivision ticks */
3255 difference = ticks_one_subdivisions_worth;
3258 if (ticks < difference) {
3259 ticks = BBT_Time::ticks_per_beat - ticks;
3261 ticks -= difference;
3265 /* round to nearest */
3268 /* compute the distance to the previous and next subdivision */
3270 if ((rem = fmod ((double) ticks, (double) ticks_one_subdivisions_worth)) > ticks_one_subdivisions_worth/2.0) {
3272 /* closer to the next subdivision, so shift forward */
3274 ticks = lrint (ticks + (ticks_one_subdivisions_worth - rem));
3276 DEBUG_TRACE (DEBUG::SnapBBT, string_compose ("moved forward to %1\n", ticks));
3278 if (ticks > BBT_Time::ticks_per_beat) {
3280 ticks -= BBT_Time::ticks_per_beat;
3281 DEBUG_TRACE (DEBUG::SnapBBT, string_compose ("fold beat to %1\n", beats));
3284 } else if (rem > 0) {
3286 /* closer to previous subdivision, so shift backward */
3290 /* can't go backwards past zero, so ... */
3293 /* step back to previous beat */
3295 ticks = lrint (BBT_Time::ticks_per_beat - rem);
3296 DEBUG_TRACE (DEBUG::SnapBBT, string_compose ("step back beat to %1\n", beats));
3298 ticks = lrint (ticks - rem);
3299 DEBUG_TRACE (DEBUG::SnapBBT, string_compose ("moved backward to %1\n", ticks));
3302 /* on the subdivision, do nothing */
3306 const framepos_t ret_frame = frame_at_beat_locked (_metrics, beats + (ticks / BBT_Time::ticks_per_beat));
3312 TempoMap::round_to_quarter_note_subdivision (framepos_t fr, int sub_num, RoundMode dir)
3314 Glib::Threads::RWLock::ReaderLock lm (lock);
3315 uint32_t ticks = (uint32_t) floor (max (0.0, quarter_note_at_frame_locked (_metrics, fr)) * BBT_Time::ticks_per_beat);
3316 uint32_t beats = (uint32_t) floor (ticks / BBT_Time::ticks_per_beat);
3317 uint32_t ticks_one_subdivisions_worth = (uint32_t) BBT_Time::ticks_per_beat / sub_num;
3319 ticks -= beats * BBT_Time::ticks_per_beat;
3322 /* round to next (or same iff dir == RoundUpMaybe) */
3324 uint32_t mod = ticks % ticks_one_subdivisions_worth;
3326 if (mod == 0 && dir == RoundUpMaybe) {
3327 /* right on the subdivision, which is fine, so do nothing */
3329 } else if (mod == 0) {
3330 /* right on the subdivision, so the difference is just the subdivision ticks */
3331 ticks += ticks_one_subdivisions_worth;
3334 /* not on subdivision, compute distance to next subdivision */
3336 ticks += ticks_one_subdivisions_worth - mod;
3339 if (ticks >= BBT_Time::ticks_per_beat) {
3340 ticks -= BBT_Time::ticks_per_beat;
3342 } else if (dir < 0) {
3344 /* round to previous (or same iff dir == RoundDownMaybe) */
3346 uint32_t difference = ticks % ticks_one_subdivisions_worth;
3348 if (difference == 0 && dir == RoundDownAlways) {
3349 /* right on the subdivision, but force-rounding down,
3350 so the difference is just the subdivision ticks */
3351 difference = ticks_one_subdivisions_worth;
3354 if (ticks < difference) {
3355 ticks = BBT_Time::ticks_per_beat - ticks;
3357 ticks -= difference;
3361 /* round to nearest */
3364 /* compute the distance to the previous and next subdivision */
3366 if ((rem = fmod ((double) ticks, (double) ticks_one_subdivisions_worth)) > ticks_one_subdivisions_worth/2.0) {
3368 /* closer to the next subdivision, so shift forward */
3370 ticks = lrint (ticks + (ticks_one_subdivisions_worth - rem));
3372 DEBUG_TRACE (DEBUG::SnapBBT, string_compose ("moved forward to %1\n", ticks));
3374 if (ticks > BBT_Time::ticks_per_beat) {
3376 ticks -= BBT_Time::ticks_per_beat;
3377 DEBUG_TRACE (DEBUG::SnapBBT, string_compose ("fold beat to %1\n", beats));
3380 } else if (rem > 0) {
3382 /* closer to previous subdivision, so shift backward */
3386 /* can't go backwards past zero, so ... */
3389 /* step back to previous beat */
3391 ticks = lrint (BBT_Time::ticks_per_beat - rem);
3392 DEBUG_TRACE (DEBUG::SnapBBT, string_compose ("step back beat to %1\n", beats));
3394 ticks = lrint (ticks - rem);
3395 DEBUG_TRACE (DEBUG::SnapBBT, string_compose ("moved backward to %1\n", ticks));
3398 /* on the subdivision, do nothing */
3402 const framepos_t ret_frame = frame_at_quarter_note_locked (_metrics, beats + (ticks / BBT_Time::ticks_per_beat));
3408 TempoMap::round_to_type (framepos_t frame, RoundMode dir, BBTPointType type)
3410 Glib::Threads::RWLock::ReaderLock lm (lock);
3412 const double beat_at_framepos = max (0.0, beat_at_frame_locked (_metrics, frame));
3413 BBT_Time bbt (bbt_at_beat_locked (_metrics, beat_at_framepos));
3418 /* find bar previous to 'frame' */
3421 return frame_at_bbt_locked (_metrics, bbt);
3423 } else if (dir > 0) {
3424 /* find bar following 'frame' */
3428 return frame_at_bbt_locked (_metrics, bbt);
3430 /* true rounding: find nearest bar */
3431 framepos_t raw_ft = frame_at_bbt_locked (_metrics, bbt);
3434 framepos_t prev_ft = frame_at_bbt_locked (_metrics, bbt);
3436 framepos_t next_ft = frame_at_bbt_locked (_metrics, bbt);
3438 if ((raw_ft - prev_ft) > (next_ft - prev_ft) / 2) {
3449 return frame_at_beat_locked (_metrics, floor (beat_at_framepos));
3450 } else if (dir > 0) {
3451 return frame_at_beat_locked (_metrics, ceil (beat_at_framepos));
3453 return frame_at_beat_locked (_metrics, floor (beat_at_framepos + 0.5));
3462 TempoMap::get_grid (vector<TempoMap::BBTPoint>& points,
3463 framepos_t lower, framepos_t upper)
3465 Glib::Threads::RWLock::ReaderLock lm (lock);
3466 int32_t cnt = ceil (beat_at_frame_locked (_metrics, lower));
3468 /* although the map handles negative beats, bbt doesn't. */
3473 if (frame_at_beat_locked (_metrics, cnt) >= upper) {
3477 while (pos < upper) {
3478 pos = frame_at_beat_locked (_metrics, cnt);
3479 const TempoSection tempo = tempo_section_at_frame_locked (_metrics, pos);
3480 const MeterSection meter = meter_section_at_frame_locked (_metrics, pos);
3481 const BBT_Time bbt = bbt_at_beat_locked (_metrics, cnt);
3482 points.push_back (BBTPoint (meter, tempo_at_frame_locked (_metrics, pos), pos, bbt.bars, bbt.beats, tempo.c_func()));
3488 TempoMap::tempo_section_at_frame (framepos_t frame) const
3490 Glib::Threads::RWLock::ReaderLock lm (lock);
3491 return tempo_section_at_frame_locked (_metrics, frame);
3495 TempoMap::tempo_section_at_frame_locked (const Metrics& metrics, framepos_t frame) const
3497 TempoSection* prev = 0;
3501 for (Metrics::const_iterator i = metrics.begin(); i != metrics.end(); ++i) {
3503 if ((*i)->is_tempo()) {
3504 t = static_cast<TempoSection*> (*i);
3508 if (prev && t->frame() > frame) {
3518 abort(); /*NOTREACHED*/
3525 TempoMap::tempo_section_at_beat_locked (const Metrics& metrics, const double& beat) const
3527 TempoSection* prev_t = 0;
3528 const MeterSection* prev_m = &meter_section_at_beat_locked (metrics, beat);
3532 for (Metrics::const_iterator i = metrics.begin(); i != metrics.end(); ++i) {
3533 if ((*i)->is_tempo()) {
3534 t = static_cast<TempoSection*> (*i);
3535 if (prev_t && ((t->pulse() - prev_m->pulse()) * prev_m->note_divisor()) + prev_m->beat() > beat) {
3545 /* don't use this to calculate length (the tempo is only correct for this frame).
3546 do that stuff based on the beat_at_frame and frame_at_beat api
3549 TempoMap::frames_per_beat_at (const framepos_t& frame, const framecnt_t& sr) const
3551 Glib::Threads::RWLock::ReaderLock lm (lock);
3553 const TempoSection* ts_at = 0;
3554 const TempoSection* ts_after = 0;
3555 Metrics::const_iterator i;
3558 for (i = _metrics.begin(); i != _metrics.end(); ++i) {
3560 if ((*i)->is_tempo()) {
3561 t = static_cast<TempoSection*> (*i);
3565 if (ts_at && (*i)->frame() > frame) {
3574 return (60.0 * _frame_rate) / (ts_at->tempo_at_frame (frame, _frame_rate) * 4.0);
3576 /* must be treated as constant tempo */
3577 return ts_at->frames_per_beat (_frame_rate);
3581 TempoMap::meter_section_at_frame_locked (const Metrics& metrics, framepos_t frame) const
3583 Metrics::const_iterator i;
3584 MeterSection* prev = 0;
3588 for (i = metrics.begin(); i != metrics.end(); ++i) {
3590 if (!(*i)->is_tempo()) {
3591 m = static_cast<MeterSection*> (*i);
3593 if (prev && (*i)->frame() > frame) {
3603 abort(); /*NOTREACHED*/
3611 TempoMap::meter_section_at_frame (framepos_t frame) const
3613 Glib::Threads::RWLock::ReaderLock lm (lock);
3614 return meter_section_at_frame_locked (_metrics, frame);
3618 TempoMap::meter_section_at_beat_locked (const Metrics& metrics, const double& beat) const
3620 MeterSection* prev_m = 0;
3622 for (Metrics::const_iterator i = metrics.begin(); i != metrics.end(); ++i) {
3624 if (!(*i)->is_tempo()) {
3625 m = static_cast<MeterSection*> (*i);
3626 if (prev_m && m->beat() > beat) {
3637 TempoMap::meter_section_at_beat (double beat) const
3639 Glib::Threads::RWLock::ReaderLock lm (lock);
3640 return meter_section_at_beat_locked (_metrics, beat);
3644 TempoMap::meter_at_frame (framepos_t frame) const
3646 TempoMetric m (metric_at (frame));
3651 TempoMap::fix_legacy_session ()
3653 MeterSection* prev_m = 0;
3654 TempoSection* prev_t = 0;
3656 for (Metrics::iterator i = _metrics.begin(); i != _metrics.end(); ++i) {
3660 if ((m = dynamic_cast<MeterSection*>(*i)) != 0) {
3661 if (!m->movable()) {
3662 pair<double, BBT_Time> bbt = make_pair (0.0, BBT_Time (1, 1, 0));
3666 m->set_position_lock_style (AudioTime);
3671 pair<double, BBT_Time> start = make_pair (((m->bbt().bars - 1) * prev_m->note_divisor())
3672 + (m->bbt().beats - 1)
3673 + (m->bbt().ticks / BBT_Time::ticks_per_beat)
3675 m->set_beat (start);
3676 const double start_beat = ((m->bbt().bars - 1) * prev_m->note_divisor())
3677 + (m->bbt().beats - 1)
3678 + (m->bbt().ticks / BBT_Time::ticks_per_beat);
3679 m->set_pulse (start_beat / prev_m->note_divisor());
3682 } else if ((t = dynamic_cast<TempoSection*>(*i)) != 0) {
3688 if (!t->movable()) {
3691 t->set_position_lock_style (AudioTime);
3697 const double beat = ((t->legacy_bbt().bars - 1) * ((prev_m) ? prev_m->note_divisor() : 4.0))
3698 + (t->legacy_bbt().beats - 1)
3699 + (t->legacy_bbt().ticks / BBT_Time::ticks_per_beat);
3701 t->set_pulse (beat / prev_m->note_divisor());
3703 /* really shouldn't happen but.. */
3704 t->set_pulse (beat / 4.0);
3713 TempoMap::get_state ()
3715 Metrics::const_iterator i;
3716 XMLNode *root = new XMLNode ("TempoMap");
3719 Glib::Threads::RWLock::ReaderLock lm (lock);
3720 for (i = _metrics.begin(); i != _metrics.end(); ++i) {
3721 root->add_child_nocopy ((*i)->get_state());
3729 TempoMap::set_state (const XMLNode& node, int /*version*/)
3732 Glib::Threads::RWLock::WriterLock lm (lock);
3735 XMLNodeConstIterator niter;
3736 Metrics old_metrics (_metrics);
3739 nlist = node.children();
3741 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
3742 XMLNode* child = *niter;
3744 if (child->name() == TempoSection::xml_state_node_name) {
3747 TempoSection* ts = new TempoSection (*child);
3748 _metrics.push_back (ts);
3751 catch (failed_constructor& err){
3752 error << _("Tempo map: could not set new state, restoring old one.") << endmsg;
3753 _metrics = old_metrics;
3754 old_metrics.clear();
3758 } else if (child->name() == MeterSection::xml_state_node_name) {
3761 MeterSection* ms = new MeterSection (*child);
3762 _metrics.push_back (ms);
3765 catch (failed_constructor& err) {
3766 error << _("Tempo map: could not set new state, restoring old one.") << endmsg;
3767 _metrics = old_metrics;
3768 old_metrics.clear();
3774 if (niter == nlist.end()) {
3775 MetricSectionSorter cmp;
3776 _metrics.sort (cmp);
3779 /* check for legacy sessions where bbt was the base musical unit for tempo */
3780 for (Metrics::const_iterator i = _metrics.begin(); i != _metrics.end(); ++i) {
3782 if ((t = dynamic_cast<TempoSection*> (*i)) != 0) {
3783 if (t->legacy_bbt().bars != 0) {
3784 fix_legacy_session();
3791 /* check for multiple tempo/meters at the same location, which
3792 ardour2 somehow allowed.
3795 Metrics::iterator prev = _metrics.end();
3796 for (Metrics::iterator i = _metrics.begin(); i != _metrics.end(); ++i) {
3797 if (prev != _metrics.end()) {
3799 MeterSection* prev_m;
3801 TempoSection* prev_t;
3802 if ((prev_m = dynamic_cast<MeterSection*>(*prev)) != 0 && (ms = dynamic_cast<MeterSection*>(*i)) != 0) {
3803 if (prev_m->pulse() == ms->pulse()) {
3804 cerr << string_compose (_("Multiple meter definitions found at %1"), prev_m->pulse()) << endmsg;
3805 error << string_compose (_("Multiple meter definitions found at %1"), prev_m->pulse()) << endmsg;
3808 } else if ((prev_t = dynamic_cast<TempoSection*>(*prev)) != 0 && (ts = dynamic_cast<TempoSection*>(*i)) != 0) {
3809 if (prev_t->pulse() == ts->pulse()) {
3810 cerr << string_compose (_("Multiple tempo definitions found at %1"), prev_t->pulse()) << endmsg;
3811 error << string_compose (_("Multiple tempo definitions found at %1"), prev_t->pulse()) << endmsg;
3819 recompute_map (_metrics);
3821 Metrics::const_iterator d = old_metrics.begin();
3822 while (d != old_metrics.end()) {
3826 old_metrics.clear ();
3829 PropertyChanged (PropertyChange ());
3835 TempoMap::dump (const Metrics& metrics, std::ostream& o) const
3837 Glib::Threads::RWLock::ReaderLock lm (lock, Glib::Threads::TRY_LOCK);
3838 const MeterSection* m;
3839 const TempoSection* t;
3840 const TempoSection* prev_t = 0;
3842 for (Metrics::const_iterator i = metrics.begin(); i != metrics.end(); ++i) {
3844 if ((t = dynamic_cast<const TempoSection*>(*i)) != 0) {
3845 o << "Tempo @ " << *i << t->beats_per_minute() << " BPM (pulse = 1/" << t->note_type() << ") at " << t->pulse() << " frame= " << t->frame() << " (movable? "
3846 << t->movable() << ')' << " pos lock: " << enum_2_string (t->position_lock_style()) << std::endl;
3847 o << "current : " << t->beats_per_minute() << " | " << t->pulse() << " | " << t->frame() << std::endl;
3849 o << "previous : " << prev_t->beats_per_minute() << " | " << prev_t->pulse() << " | " << prev_t->frame() << std::endl;
3850 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;
3853 } else if ((m = dynamic_cast<const MeterSection*>(*i)) != 0) {
3854 o << "Meter @ " << *i << ' ' << m->divisions_per_bar() << '/' << m->note_divisor() << " at " << m->bbt() << " frame= " << m->frame()
3855 << " pulse: " << m->pulse() << " beat : " << m->beat() << " pos lock: " << enum_2_string (m->position_lock_style()) << " (movable? " << m->movable() << ')' << endl;
3858 o << "------" << std::endl;
3862 TempoMap::n_tempos() const
3864 Glib::Threads::RWLock::ReaderLock lm (lock);
3867 for (Metrics::const_iterator i = _metrics.begin(); i != _metrics.end(); ++i) {
3868 if ((*i)->is_tempo()) {
3877 TempoMap::n_meters() const
3879 Glib::Threads::RWLock::ReaderLock lm (lock);
3882 for (Metrics::const_iterator i = _metrics.begin(); i != _metrics.end(); ++i) {
3883 if (!(*i)->is_tempo()) {
3892 TempoMap::insert_time (framepos_t where, framecnt_t amount)
3895 Glib::Threads::RWLock::WriterLock lm (lock);
3896 for (Metrics::iterator i = _metrics.begin(); i != _metrics.end(); ++i) {
3897 if ((*i)->frame() >= where && (*i)->movable ()) {
3898 (*i)->set_frame ((*i)->frame() + amount);
3902 /* now reset the BBT time of all metrics, based on their new
3903 * audio time. This is the only place where we do this reverse
3907 Metrics::iterator i;
3908 const MeterSection* meter;
3909 const TempoSection* tempo;
3913 meter = &first_meter ();
3914 tempo = &first_tempo ();
3919 // cerr << "\n###################### TIMESTAMP via AUDIO ##############\n" << endl;
3922 MetricSection* prev = 0;
3924 for (i = _metrics.begin(); i != _metrics.end(); ++i) {
3927 //TempoMetric metric (*meter, *tempo);
3928 MeterSection* ms = const_cast<MeterSection*>(meter);
3929 TempoSection* ts = const_cast<TempoSection*>(tempo);
3932 if ((t = dynamic_cast<TempoSection*>(prev)) != 0) {
3936 ts->set_pulse (t->pulse());
3938 if ((m = dynamic_cast<MeterSection*>(prev)) != 0) {
3939 ts->set_pulse (m->pulse());
3941 ts->set_frame (prev->frame());
3945 if ((m = dynamic_cast<MeterSection*>(prev)) != 0) {
3946 pair<double, BBT_Time> start = make_pair (m->beat(), m->bbt());
3947 ms->set_beat (start);
3948 ms->set_pulse (m->pulse());
3950 if ((t = dynamic_cast<TempoSection*>(prev)) != 0) {
3954 const double beat = beat_at_pulse_locked (_metrics, t->pulse());
3955 pair<double, BBT_Time> start = make_pair (beat, bbt_at_beat_locked (_metrics, beat));
3956 ms->set_beat (start);
3957 ms->set_pulse (t->pulse());
3959 ms->set_frame (prev->frame());
3963 // metric will be at frames=0 bbt=1|1|0 by default
3964 // which is correct for our purpose
3967 // cerr << bbt << endl;
3969 if ((t = dynamic_cast<TempoSection*>(*i)) != 0) {
3973 t->set_pulse (pulse_at_frame_locked (_metrics, m->frame()));
3975 // cerr << "NEW TEMPO, frame = " << (*i)->frame() << " beat = " << (*i)->pulse() <<endl;
3976 } else if ((m = dynamic_cast<MeterSection*>(*i)) != 0) {
3977 bbt = bbt_at_frame_locked (_metrics, m->frame());
3979 // cerr << "timestamp @ " << (*i)->frame() << " with " << bbt.bars << "|" << bbt.beats << "|" << bbt.ticks << " => ";
3985 if (bbt.ticks > BBT_Time::ticks_per_beat/2) {
3986 /* round up to next beat */
3992 if (bbt.beats != 1) {
3993 /* round up to next bar */
3998 pair<double, BBT_Time> start = make_pair (max (0.0, beat_at_frame_locked (_metrics, m->frame())), bbt);
3999 m->set_beat (start);
4000 m->set_pulse (pulse_at_frame_locked (_metrics, m->frame()));
4002 // cerr << "NEW METER, frame = " << (*i)->frame() << " beat = " << (*i)->pulse() <<endl;
4004 fatal << _("programming error: unhandled MetricSection type") << endmsg;
4005 abort(); /*NOTREACHED*/
4011 recompute_map (_metrics);
4015 PropertyChanged (PropertyChange ());
4018 TempoMap::remove_time (framepos_t where, framecnt_t amount)
4022 std::list<MetricSection*> metric_kill_list;
4024 TempoSection* last_tempo = NULL;
4025 MeterSection* last_meter = NULL;
4026 bool tempo_after = false; // is there a tempo marker at the first sample after the removed range?
4027 bool meter_after = false; // is there a meter marker likewise?
4029 Glib::Threads::RWLock::WriterLock lm (lock);
4030 for (Metrics::iterator i = _metrics.begin(); i != _metrics.end(); ++i) {
4031 if ((*i)->frame() >= where && (*i)->frame() < where+amount) {
4032 metric_kill_list.push_back(*i);
4033 TempoSection *lt = dynamic_cast<TempoSection*> (*i);
4036 MeterSection *lm = dynamic_cast<MeterSection*> (*i);
4040 else if ((*i)->frame() >= where) {
4041 // TODO: make sure that moved tempo/meter markers are rounded to beat/bar boundaries
4042 (*i)->set_frame ((*i)->frame() - amount);
4043 if ((*i)->frame() == where) {
4044 // marker was immediately after end of range
4045 tempo_after = dynamic_cast<TempoSection*> (*i);
4046 meter_after = dynamic_cast<MeterSection*> (*i);
4052 //find the last TEMPO and METER metric (if any) and move it to the cut point so future stuff is correct
4053 if (last_tempo && !tempo_after) {
4054 metric_kill_list.remove(last_tempo);
4055 last_tempo->set_frame(where);
4058 if (last_meter && !meter_after) {
4059 metric_kill_list.remove(last_meter);
4060 last_meter->set_frame(where);
4064 //remove all the remaining metrics
4065 for (std::list<MetricSection*>::iterator i = metric_kill_list.begin(); i != metric_kill_list.end(); ++i) {
4066 _metrics.remove(*i);
4071 recompute_map (_metrics);
4074 PropertyChanged (PropertyChange ());
4078 /** Add some (fractional) beats to a session frame position, and return the result in frames.
4079 * pos can be -ve, if required.
4082 TempoMap::framepos_plus_beats (framepos_t frame, Evoral::Beats beats) const
4084 Glib::Threads::RWLock::ReaderLock lm (lock);
4086 return frame_at_beat_locked (_metrics, beat_at_frame_locked (_metrics, frame) + beats.to_double());
4089 TempoMap::framepos_plus_qn (framepos_t frame, Evoral::Beats quarter_note) const
4091 Glib::Threads::RWLock::ReaderLock lm (lock);
4093 return frame_at_quarter_note_locked (_metrics, quarter_note_at_frame_locked (_metrics, frame) + quarter_note.to_double());
4096 /** Subtract some (fractional) beats from a frame position, and return the result in frames */
4098 TempoMap::framepos_minus_beats (framepos_t pos, Evoral::Beats beats) const
4100 Glib::Threads::RWLock::ReaderLock lm (lock);
4102 return frame_at_beat_locked (_metrics, beat_at_frame_locked (_metrics, pos) - beats.to_double());
4105 /** Add the BBT interval op to pos and return the result */
4107 TempoMap::framepos_plus_bbt (framepos_t pos, BBT_Time op) const
4109 Glib::Threads::RWLock::ReaderLock lm (lock);
4111 BBT_Time pos_bbt = bbt_at_beat_locked (_metrics, beat_at_frame_locked (_metrics, pos));
4112 pos_bbt.ticks += op.ticks;
4113 if (pos_bbt.ticks >= BBT_Time::ticks_per_beat) {
4115 pos_bbt.ticks -= BBT_Time::ticks_per_beat;
4117 pos_bbt.beats += op.beats;
4118 /* the meter in effect will start on the bar */
4119 double divisions_per_bar = meter_section_at_beat (beat_at_bbt_locked (_metrics, BBT_Time (pos_bbt.bars + op.bars, 1, 0))).divisions_per_bar();
4120 while (pos_bbt.beats >= divisions_per_bar + 1) {
4122 divisions_per_bar = meter_section_at_beat (beat_at_bbt_locked (_metrics, BBT_Time (pos_bbt.bars + op.bars, 1, 0))).divisions_per_bar();
4123 pos_bbt.beats -= divisions_per_bar;
4125 pos_bbt.bars += op.bars;
4127 return frame_at_bbt_locked (_metrics, pos_bbt);
4130 /** Count the number of beats that are equivalent to distance when going forward,
4134 TempoMap::framewalk_to_beats (framepos_t pos, framecnt_t distance) const
4136 Glib::Threads::RWLock::ReaderLock lm (lock);
4138 return Evoral::Beats (beat_at_frame_locked (_metrics, pos + distance) - beat_at_frame_locked (_metrics, pos));
4142 TempoMap::framewalk_to_qn (framepos_t pos, framecnt_t distance) const
4144 Glib::Threads::RWLock::ReaderLock lm (lock);
4146 return Evoral::Beats (quarter_note_at_frame_locked (_metrics, pos + distance) - quarter_note_at_frame_locked (_metrics, pos));
4149 bool operator() (const BBT_Time& a, const BBT_Time& b) {
4155 operator<< (std::ostream& o, const Meter& m) {
4156 return o << m.divisions_per_bar() << '/' << m.note_divisor();
4160 operator<< (std::ostream& o, const Tempo& t) {
4161 return o << t.beats_per_minute() << " 1/" << t.note_type() << "'s per minute";
4165 operator<< (std::ostream& o, const MetricSection& section) {
4167 o << "MetricSection @ " << section.frame() << ' ';
4169 const TempoSection* ts;
4170 const MeterSection* ms;
4172 if ((ts = dynamic_cast<const TempoSection*> (§ion)) != 0) {
4173 o << *((const Tempo*) ts);
4174 } else if ((ms = dynamic_cast<const MeterSection*> (§ion)) != 0) {
4175 o << *((const Meter*) ms);