Later code depends on prev_t not being NULL, use an assert()
[ardour.git] / libs / ardour / tempo.cc
index ad894708f887eae755193aa2cc57a83501a12a80..d800eb6f6083fa029f44e989ae604a9c590a690d 100644 (file)
@@ -96,7 +96,6 @@ TempoSection::TempoSection (const XMLNode& node, framecnt_t sample_rate)
        BBT_Time bbt;
        double pulse;
        uint32_t frame;
-       bool had_beats_per_minute = false;
 
        _legacy_bbt = BBT_Time (0, 0, 0);
 
@@ -123,29 +122,18 @@ TempoSection::TempoSection (const XMLNode& node, framecnt_t sample_rate)
        if ((prop = node.property ("frame")) != 0) {
                if (sscanf (prop->value().c_str(), "%" PRIu32, &frame) != 1) {
                        error << _("TempoSection XML node has an illegal \"frame\" value") << endmsg;
+                       throw failed_constructor();
                } else {
                        set_minute (minute_at_frame (frame));
                }
        }
 
-       /* replace old beats-per-minute with note-types-per-minute */
+       /* XX replace old beats-per-minute name with note-types-per-minute */
        if ((prop = node.property ("beats-per-minute")) != 0) {
-               info << _("Renaming legacy \"beats-per-minute\" XML node to note-types-per-minute") << endmsg;
                if (sscanf (prop->value().c_str(), "%lf", &_note_types_per_minute) != 1 || _note_types_per_minute < 0.0) {
                        error << _("TempoSection XML node has an illegal \"beats-per-minutee\" value") << endmsg;
                        throw failed_constructor();
                }
-               had_beats_per_minute = true;
-       }
-
-       if ((prop = node.property ("note-types-per-minute")) != 0) {
-               if (sscanf (prop->value().c_str(), "%lf", &_note_types_per_minute) != 1 || _note_types_per_minute < 0.0) {
-                       error << _("TempoSection XML node has an illegal \"note-types-per-minute\" value") << endmsg;
-                       throw failed_constructor();
-               }
-       } else if (!had_beats_per_minute) {
-               error << _("TempoSection XML node has no \"note-types-per-minute\" or \"beats-per-minute\" property") << endmsg;
-               throw failed_constructor();
        }
 
        if ((prop = node.property ("note-type")) == 0) {
@@ -207,7 +195,7 @@ TempoSection::get_state() const
        snprintf (buf, sizeof (buf), "%li", frame());
        root->add_property ("frame", buf);
        snprintf (buf, sizeof (buf), "%lf", _note_types_per_minute);
-       root->add_property ("note-types-per-minute", buf);
+       root->add_property ("beats-per-minute", buf);
        snprintf (buf, sizeof (buf), "%lf", _note_type);
        root->add_property ("note-type", buf);
        snprintf (buf, sizeof (buf), "%s", movable()?"yes":"no");
@@ -249,12 +237,11 @@ TempoSection::tempo_at_minute (const double& m) const
  *
 */
 
-/** user feedback dictates that if tempoA (120, 4.0) precedes tempoB (120, 8.0),
- *  there will be no ramp between the two even if set to ramped.
+/** if tempoA (120, 4.0) precedes tempoB (120, 8.0),
+ *  there should be no ramp between the two even if we are ramped.
  *  in other words a ramp should only place a curve on note_types_per_minute.
  *  we should be able to use Tempo note type here, but the above
  *  complicates things a bit.
- *  we would ideally like to use arbitrary Tempo structs here.
 */
 double
 TempoSection::minute_at_ntpm (const double& ntpm, const double& p) const
@@ -323,6 +310,12 @@ TempoSection::minute_at_pulse (const double& p) const
        return _time_at_pulse (p - pulse()) + minute();
 }
 
+/** returns thw whole-note pulse at session frame position f.
+ *  @param f the frame position.
+ *  @return the position in whole-note pulses corresponding to f
+ *
+ *  for use with musical units whose granularity is coarser than frames (e.g. ticks)
+*/
 double
 TempoSection::pulse_at_frame (const framepos_t& f) const
 {
@@ -556,6 +549,7 @@ MeterSection::MeterSection (const XMLNode& node, const framecnt_t sample_rate)
        if ((prop = node.property ("frame")) != 0) {
                if (sscanf (prop->value().c_str(), "%li", &frame) != 1) {
                        error << _("MeterSection XML node has an illegal \"frame\" value") << endmsg;
+                       throw failed_constructor();
                } else {
                        set_minute (minute_at_frame (frame));
                }
@@ -1339,6 +1333,7 @@ TempoMap::recompute_tempi (Metrics& metrics)
                        prev_t = t;
                }
        }
+       assert (prev_t);
        prev_t->set_c_func (0.0);
 }
 
@@ -1576,6 +1571,7 @@ TempoMap::minute_at_beat_locked (const Metrics& metrics, const double& beat) con
                        prev_m = m;
                }
        }
+       assert (prev_m);
 
        TempoSection* t;
 
@@ -1589,6 +1585,7 @@ TempoMap::minute_at_beat_locked (const Metrics& metrics, const double& beat) con
                }
 
        }
+       assert (prev_t);
 
        return prev_t->minute_at_pulse (((beat - prev_m->beat()) / prev_m->note_divisor()) + prev_m->pulse());
 }
@@ -1806,6 +1803,7 @@ TempoMap::beat_at_pulse_locked (const Metrics& metrics, const double& pulse) con
                        prev_m = m;
                }
        }
+       assert (prev_m);
 
        double const ret = ((pulse - prev_m->pulse()) * prev_m->note_divisor()) + prev_m->beat();
        return ret;
@@ -1952,6 +1950,7 @@ TempoMap::bbt_at_beat_locked (const Metrics& metrics, const double& b) const
                        prev_m = m;
                }
        }
+       assert (prev_m);
 
        const double beats_in_ms = beats - prev_m->beat();
        const uint32_t bars_in_ms = (uint32_t) floor (beats_in_ms / prev_m->divisions_per_bar());
@@ -2089,6 +2088,8 @@ TempoMap::bbt_at_pulse_locked (const Metrics& metrics, const double& pulse) cons
                }
        }
 
+       assert (prev_m);
+
        const double beats_in_ms = (pulse - prev_m->pulse()) * prev_m->note_divisor();
        const uint32_t bars_in_ms = (uint32_t) floor (beats_in_ms / prev_m->divisions_per_bar());
        const uint32_t total_bars = bars_in_ms + (prev_m->bbt().bars - 1);
@@ -2418,6 +2419,7 @@ TempoMap::quarter_notes_between_frames_locked (const Metrics& metrics, const fra
                        prev_t = t;
                }
        }
+       assert (prev_t);
        const double start_qn = prev_t->pulse_at_frame (start);
 
        for (Metrics::const_iterator i = metrics.begin(); i != metrics.end(); ++i) {
@@ -3258,7 +3260,9 @@ TempoMap::gui_dilate_tempo (TempoSection* ts, const framepos_t& frame, const fra
                TempoSection* prev_to_prev_t = 0;
                const frameoffset_t fr_off = end_frame - frame;
 
-               if (prev_t && prev_t->pulse() > 0.0) {
+               assert (prev_t);
+
+               if (prev_t->pulse() > 0.0) {
                        prev_to_prev_t = const_cast<TempoSection*>(&tempo_section_at_minute_locked (future_map, minute_at_frame (prev_t->frame() - 1)));
                }
 
@@ -3925,6 +3929,7 @@ TempoMap::frames_per_quarter_note_at (const framepos_t& frame, const framecnt_t&
                        ts_at = t;
                }
        }
+       assert (ts_at);
 
        if (ts_after) {
                return  (60.0 * _frame_rate) / ts_at->tempo_at_minute (minute_at_frame (frame)).quarter_notes_per_minute();