libs/ardour/tempo.cc

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