Oops, fix build.
[ardour.git] / libs / ardour / tempo.cc
index 2dc5eeaada266ff4a8eb916b6a4602e09a14cafe..8afdfb140bb92748834805c38d16a6512d3055c4 100644 (file)
@@ -24,7 +24,6 @@
 
 #include <cmath>
 
-#include <sigc++/bind.h>
 
 #include <glibmm/thread.h>
 #include "pbd/xml++.h"
@@ -46,7 +45,7 @@ Tempo    TempoMap::_default_tempo (120.0);
 
 const double Meter::ticks_per_beat = 1920.0;
 
-double Tempo::frames_per_beat (nframes_t sr, const Meter& meter) const
+double Tempo::frames_per_beat (framecnt_t sr, const Meter& meter) const
 {
        return  ((60.0 * sr) / (_beats_per_minute * meter.note_divisor()/_note_type));
 }
@@ -54,7 +53,7 @@ double Tempo::frames_per_beat (nframes_t sr, const Meter& meter) const
 /***********************************************************************/
 
 double
-Meter::frames_per_bar (const Tempo& tempo, nframes_t sr) const
+Meter::frames_per_bar (const Tempo& tempo, framecnt_t sr) const
 {
        return ((60.0 * sr * _beats_per_bar) / (tempo.beats_per_minute() * _note_type/tempo.note_type()));
 }
@@ -219,7 +218,7 @@ struct MetricSectionSorter {
     }
 };
 
-TempoMap::TempoMap (nframes64_t fr)
+TempoMap::TempoMap (framecnt_t fr)
 {
        metrics = new Metrics;
        _frame_rate = fr;
@@ -260,11 +259,11 @@ TempoMap::move_metric_section (MetricSection& section, const BBT_Time& when)
 
                /* position by audio frame, then recompute BBT timestamps from the audio ones */
 
-               nframes64_t frame = frame_time (when);
+               framepos_t frame = frame_time (when);
                // cerr << "nominal frame time = " << frame << endl;
 
-               nframes64_t prev_frame = round_to_type (frame, -1, Beat);
-               nframes64_t next_frame = round_to_type (frame, 1, Beat);
+               framepos_t prev_frame = round_to_type (frame, -1, Beat);
+               framepos_t next_frame = round_to_type (frame, 1, Beat);
 
                // cerr << "previous beat at " << prev_frame << " next at " << next_frame << endl;
 
@@ -300,7 +299,7 @@ void
 TempoMap::move_tempo (TempoSection& tempo, const BBT_Time& when)
 {
        if (move_metric_section (tempo, when) == 0) {
-               StateChanged (Change (0));
+               PropertyChanged (PropertyChange ());
        }
 }
 
@@ -308,7 +307,7 @@ void
 TempoMap::move_meter (MeterSection& meter, const BBT_Time& when)
 {
        if (move_metric_section (meter, when) == 0) {
-               StateChanged (Change (0));
+               PropertyChanged (PropertyChange ());
        }
 }
 
@@ -335,7 +334,7 @@ TempoMap::remove_tempo (const TempoSection& tempo)
        }
 
        if (removed) {
-               StateChanged (Change (0));
+               PropertyChanged (PropertyChange ());
        }
 }
 
@@ -362,7 +361,7 @@ TempoMap::remove_meter (const MeterSection& tempo)
        }
 
        if (removed) {
-               StateChanged (Change (0));
+               PropertyChanged (PropertyChange ());
        }
 }
 
@@ -371,16 +370,46 @@ TempoMap::do_insert (MetricSection* section, bool with_bbt)
 {
        Metrics::iterator i;
 
+       /* Look for any existing MetricSection that is of the same type and
+          at the same time as the new one, and remove it before adding
+          the new one.
+       */
+
+       Metrics::iterator to_remove = metrics->end ();
+
        for (i = metrics->begin(); i != metrics->end(); ++i) {
 
-               if (with_bbt) {
-                       if ((*i)->start() < section->start()) {
-                               continue;
-                       }
-               } else {
-                       if ((*i)->frame() < section->frame()) {
-                               continue;
-                       }
+               int const c = (*i)->compare (section, with_bbt);
+
+               if (c < 0) {
+                       /* this section is before the one to be added; go back round */
+                       continue;
+               } else if (c > 0) {
+                       /* this section is after the one to be added; there can't be any at the same time */
+                       break;
+               }
+
+               /* hacky comparison of type */
+               bool const a = dynamic_cast<TempoSection*> (*i) != 0;
+               bool const b = dynamic_cast<TempoSection*> (section) != 0;
+
+               if (a == b) {
+                       to_remove = i;
+                       break;
+               }
+       }
+
+       if (to_remove != metrics->end()) {
+               /* remove the MetricSection at the same time as the one we are about to add */
+               metrics->erase (to_remove);
+       }
+
+       /* Add the given MetricSection */
+
+       for (i = metrics->begin(); i != metrics->end(); ++i) {
+
+               if ((*i)->compare (section, with_bbt) < 0) {
+                       continue;
                }
 
                metrics->insert (i, section);
@@ -401,24 +430,23 @@ TempoMap::add_tempo (const Tempo& tempo, BBT_Time where)
                Glib::RWLock::WriterLock lm (lock);
 
                /* new tempos always start on a beat */
-
                where.ticks = 0;
 
                do_insert (new TempoSection (where, tempo.beats_per_minute(), tempo.note_type()), true);
        }
 
-       StateChanged (Change (0));
+       PropertyChanged (PropertyChange ());
 }
 
 void
-TempoMap::add_tempo (const Tempo& tempo, nframes64_t where)
+TempoMap::add_tempo (const Tempo& tempo, framepos_t where)
 {
        {
                Glib::RWLock::WriterLock lm (lock);
                do_insert (new TempoSection (where, tempo.beats_per_minute(), tempo.note_type()), false);
        }
 
-       StateChanged (Change (0));
+       PropertyChanged (PropertyChange ());
 }
 
 void
@@ -446,7 +474,7 @@ TempoMap::replace_tempo (TempoSection& existing, const Tempo& replacement)
        }
 
        if (replaced) {
-               StateChanged (Change (0));
+               PropertyChanged (PropertyChange ());
        }
 }
 
@@ -469,24 +497,23 @@ TempoMap::add_meter (const Meter& meter, BBT_Time where)
                }
 
                /* new meters *always* start on a beat. */
-
                where.ticks = 0;
 
                do_insert (new MeterSection (where, meter.beats_per_bar(), meter.note_divisor()), true);
        }
 
-       StateChanged (Change (0));
+       PropertyChanged (PropertyChange ());
 }
 
 void
-TempoMap::add_meter (const Meter& meter, nframes64_t where)
+TempoMap::add_meter (const Meter& meter, framepos_t where)
 {
        {
                Glib::RWLock::WriterLock lm (lock);
                do_insert (new MeterSection (where, meter.beats_per_bar(), meter.note_divisor()), false);
        }
 
-       StateChanged (Change (0));
+       PropertyChanged (PropertyChange ());
 }
 
 void
@@ -512,7 +539,7 @@ TempoMap::replace_meter (MeterSection& existing, const Meter& replacement)
        }
 
        if (replaced) {
-               StateChanged (Change (0));
+               PropertyChanged (PropertyChange ());
        }
 }
 
@@ -525,14 +552,14 @@ TempoMap::change_initial_tempo (double beats_per_minute, double note_type)
        for (Metrics::iterator i = metrics->begin(); i != metrics->end(); ++i) {
                if ((t = dynamic_cast<TempoSection*> (*i)) != 0) {
                        *((Tempo*) t) = newtempo;
-                       StateChanged (Change (0));
+                       PropertyChanged (PropertyChange ());
                        break;
                }
        }
 }
 
 void
-TempoMap::change_existing_tempo_at (nframes64_t where, double beats_per_minute, double note_type)
+TempoMap::change_existing_tempo_at (framepos_t where, double beats_per_minute, double note_type)
 {
        Tempo newtempo (beats_per_minute, note_type);
 
@@ -571,7 +598,7 @@ TempoMap::change_existing_tempo_at (nframes64_t where, double beats_per_minute,
        /* reset */
 
        *((Tempo*)prev) = newtempo;
-       StateChanged (Change (0));
+       PropertyChanged (PropertyChange ());
 }
 
 const MeterSection&
@@ -622,8 +649,8 @@ TempoMap::timestamp_metrics (bool use_bbt)
 
                // cerr << "\n\n\n ######################\nTIMESTAMP via BBT ##############\n" << endl;
 
-               nframes64_t current = 0;
-               nframes64_t section_frames;
+               framepos_t current = 0;
+               framepos_t section_frames;
                BBT_Time start;
                BBT_Time end;
 
@@ -717,7 +744,7 @@ TempoMap::timestamp_metrics (bool use_bbt)
 }
 
 TempoMetric
-TempoMap::metric_at (nframes64_t frame) const
+TempoMap::metric_at (framepos_t frame) const
 {
        TempoMetric m (first_meter(), first_tempo());
        const Meter* meter;
@@ -785,7 +812,7 @@ TempoMap::metric_at (BBT_Time bbt) const
 }
 
 void
-TempoMap::bbt_time (nframes64_t frame, BBT_Time& bbt) const
+TempoMap::bbt_time (framepos_t frame, BBT_Time& bbt) const
 {
        {
                Glib::RWLock::ReaderLock lm (lock);
@@ -794,15 +821,15 @@ TempoMap::bbt_time (nframes64_t frame, BBT_Time& bbt) const
 }
 
 void
-TempoMap::bbt_time_unlocked (nframes64_t frame, BBT_Time& bbt) const
+TempoMap::bbt_time_unlocked (framepos_t frame, BBT_Time& bbt) const
 {
        bbt_time_with_metric (frame, bbt, metric_at (frame));
 }
 
 void
-TempoMap::bbt_time_with_metric (nframes64_t frame, BBT_Time& bbt, const TempoMetric& metric) const
+TempoMap::bbt_time_with_metric (framepos_t frame, BBT_Time& bbt, const TempoMetric& metric) const
 {
-       nframes64_t frame_diff;
+       framecnt_t frame_diff;
 
        // cerr << "---- BBT time for " << frame << " using metric @ " << metric.frame() << " BBT " << metric.start() << endl;
 
@@ -845,16 +872,16 @@ TempoMap::bbt_time_with_metric (nframes64_t frame, BBT_Time& bbt, const TempoMet
        // cerr << "-----\t RETURN " << bbt << endl;
 }
 
-nframes64_t
-TempoMap::count_frames_between ( const BBT_Time& start, const BBT_Time& end) const
+framecnt_t
+TempoMap::count_frames_between (const BBT_Time& start, const BBT_Time& end) const
 {
         /* for this to work with fractional measure types, start and end have to be "legal" BBT types,
           that means that the beats and ticks should be inside a bar
        */
 
-       nframes64_t frames = 0;
-       nframes64_t start_frame = 0;
-       nframes64_t end_frame = 0;
+       framecnt_t frames = 0;
+       framepos_t start_frame = 0;
+       framepos_t end_frame = 0;
 
        TempoMetric m = metric_at (start);
 
@@ -864,7 +891,7 @@ TempoMap::count_frames_between ( const BBT_Time& start, const BBT_Time& end) con
                + start.ticks/Meter::ticks_per_beat;
 
 
-       start_frame = m.frame() + (nframes64_t) rint( beat_offset * m.tempo().frames_per_beat(_frame_rate, m.meter()));
+       start_frame = m.frame() + (framepos_t) rint( beat_offset * m.tempo().frames_per_beat(_frame_rate, m.meter()));
 
        m =  metric_at(end);
 
@@ -873,7 +900,7 @@ TempoMap::count_frames_between ( const BBT_Time& start, const BBT_Time& end) con
        beat_offset = bar_offset * m.meter().beats_per_bar() - (m.start().beats -1) + (end.beats - 1)
                + end.ticks/Meter::ticks_per_beat;
 
-       end_frame = m.frame() + (nframes64_t) rint(beat_offset * m.tempo().frames_per_beat(_frame_rate, m.meter()));
+       end_frame = m.frame() + (framepos_t) rint(beat_offset * m.tempo().frames_per_beat(_frame_rate, m.meter()));
 
        frames = end_frame - start_frame;
 
@@ -881,12 +908,12 @@ TempoMap::count_frames_between ( const BBT_Time& start, const BBT_Time& end) con
 
 }
 
-nframes64_t
+framecnt_t
 TempoMap::count_frames_between_metrics (const Meter& meter, const Tempo& tempo, const BBT_Time& start, const BBT_Time& end) const
 {
         /* this is used in timestamping the metrics by actually counting the beats */
 
-       nframes64_t frames = 0;
+       framecnt_t frames = 0;
        uint32_t bar = start.bars;
        double beat = (double) start.beats;
        double beats_counted = 0;
@@ -925,13 +952,13 @@ TempoMap::count_frames_between_metrics (const Meter& meter, const Tempo& tempo,
        // << " fpb was " << beat_frames
        // << endl;
 
-       frames = (nframes64_t) floor (beats_counted * beat_frames);
+       frames = (framecnt_t) llrint (floor (beats_counted * beat_frames));
 
        return frames;
 
 }
 
-nframes64_t
+framepos_t
 TempoMap::frame_time (const BBT_Time& bbt) const
 {
        BBT_Time start ; /* 1|1|0 */
@@ -939,10 +966,10 @@ TempoMap::frame_time (const BBT_Time& bbt) const
        return  count_frames_between ( start, bbt);
 }
 
-nframes64_t
-TempoMap::bbt_duration_at (nframes64_t pos, const BBT_Time& bbt, int dir) const
+framecnt_t
+TempoMap::bbt_duration_at (framepos_t pos, const BBT_Time& bbt, int dir) const
 {
-       nframes64_t frames = 0;
+       framecnt_t frames = 0;
 
        BBT_Time when;
        bbt_time(pos, when);
@@ -955,11 +982,10 @@ TempoMap::bbt_duration_at (nframes64_t pos, const BBT_Time& bbt, int dir) const
        return frames;
 }
 
-nframes64_t
+framecnt_t
 TempoMap::bbt_duration_at_unlocked (const BBT_Time& when, const BBT_Time& bbt, int dir) const
 {
-
-       nframes64_t frames = 0;
+       framecnt_t frames = 0;
 
        double beats_per_bar;
        BBT_Time result;
@@ -1082,8 +1108,8 @@ TempoMap::bbt_duration_at_unlocked (const BBT_Time& when, const BBT_Time& bbt, i
 
 
 
-nframes64_t
-TempoMap::round_to_bar (nframes64_t fr, int dir)
+framepos_t
+TempoMap::round_to_bar (framepos_t fr, int dir)
 {
         {
                Glib::RWLock::ReaderLock lm (lock);
@@ -1092,8 +1118,8 @@ TempoMap::round_to_bar (nframes64_t fr, int dir)
 }
 
 
-nframes64_t
-TempoMap::round_to_beat (nframes64_t fr, int dir)
+framepos_t
+TempoMap::round_to_beat (framepos_t fr, int dir)
 {
         {
                Glib::RWLock::ReaderLock lm (lock);
@@ -1101,10 +1127,9 @@ TempoMap::round_to_beat (nframes64_t fr, int dir)
        }
 }
 
-nframes64_t
-TempoMap::round_to_beat_subdivision (nframes64_t fr, int sub_num, int dir)
+framepos_t
+TempoMap::round_to_beat_subdivision (framepos_t fr, int sub_num, int dir)
 {
-
        BBT_Time the_beat;
        uint32_t ticks_one_half_subdivisions_worth;
        uint32_t ticks_one_subdivisions_worth;
@@ -1131,13 +1156,7 @@ TempoMap::round_to_beat_subdivision (nframes64_t fr, int sub_num, int dir)
                        difference = ticks_one_subdivisions_worth - mod;
                }
 
-               if (the_beat.ticks + difference >= (uint32_t)Meter::ticks_per_beat) {
-                       the_beat.beats++;
-                       the_beat.ticks += difference;
-                       the_beat.ticks -= (uint32_t)Meter::ticks_per_beat;
-               } else {
-                       the_beat.ticks += difference;
-               }
+               the_beat = bbt_add (the_beat, BBT_Time (0, 0, difference));
 
        } else if (dir < 0) {
 
@@ -1148,41 +1167,28 @@ TempoMap::round_to_beat_subdivision (nframes64_t fr, int sub_num, int dir)
                if (mod == 0) {
                        /* right on the subdivision, so the difference is just the subdivision ticks */
                        difference = ticks_one_subdivisions_worth;
-                       cerr << "On the sub, move by 1 sub = " << difference << endl;
                } else {
                        /* not on subdivision, compute distance to previous subdivision, which
                           is just the modulus.
                        */
 
                        difference = mod;
-                       cerr << "off the sub, move by 1 sub = " << difference << endl;
                }
 
-
-               cerr << "ticks = " << the_beat.ticks << endl;
-
-               if (the_beat.ticks < difference) {
-                       cerr << "backup beats, set ticks to "
-                            << (uint32_t)Meter::ticks_per_beat - difference << endl;
-                       the_beat.beats--;
-                       the_beat.ticks = (uint32_t)Meter::ticks_per_beat - difference;
-               } else {
-                       cerr << " reduce ticks\n";
-                       the_beat.ticks -= difference;
-               }
+                try { 
+                        the_beat = bbt_subtract (the_beat, BBT_Time (0, 0, difference));
+                } catch (...) {
+                        /* can't go backwards from wherever pos is, so just return it */
+                        return fr;
+                }
+                        
 
        } else {
                /* round to nearest */
 
                if (the_beat.ticks % ticks_one_subdivisions_worth > ticks_one_half_subdivisions_worth) {
                        difference = ticks_one_subdivisions_worth - (the_beat.ticks % ticks_one_subdivisions_worth);
-                       if (the_beat.ticks + difference >= (uint32_t)Meter::ticks_per_beat) {
-                               the_beat.beats++;
-                               the_beat.ticks += difference;
-                               the_beat.ticks -= (uint32_t)Meter::ticks_per_beat;
-                       } else {
-                               the_beat.ticks += difference;
-                       }
+                       the_beat = bbt_add (the_beat, BBT_Time (0, 0, difference));
                } else {
                        // difference = ticks_one_subdivisions_worth - (the_beat.ticks % ticks_one_subdivisions_worth);
                        the_beat.ticks -= the_beat.ticks % ticks_one_subdivisions_worth;
@@ -1192,8 +1198,8 @@ TempoMap::round_to_beat_subdivision (nframes64_t fr, int sub_num, int dir)
        return frame_time (the_beat);
 }
 
-nframes64_t
-TempoMap::round_to_type (nframes64_t frame, int dir, BBTPointType type)
+framepos_t
+TempoMap::round_to_type (framepos_t frame, int dir, BBTPointType type)
 {
        TempoMetric metric = metric_at (frame);
        BBT_Time bbt;
@@ -1205,7 +1211,7 @@ TempoMap::round_to_type (nframes64_t frame, int dir, BBTPointType type)
 
        switch (type) {
        case Bar:
-               DEBUG_TRACE(DEBUG::SnapBBT, string_compose ("round from %1 (%3) to bars in direction %2\n", frame, (dir < 0 ? "back" : "forward"), bbt));
+               DEBUG_TRACE(DEBUG::SnapBBT, string_compose ("round from %1 (%3) to bars in direction %2\n", frame, dir, bbt));
 
                if (dir < 0) {
 
@@ -1238,7 +1244,7 @@ TempoMap::round_to_type (nframes64_t frame, int dir, BBTPointType type)
                        float midbar_beats;
                        float midbar_ticks;
 
-                       midbar_beats = metric.meter().beats_per_bar() / 2;
+                       midbar_beats = metric.meter().beats_per_bar() / 2 + 1;
                        midbar_ticks = Meter::ticks_per_beat * fmod (midbar_beats, 1.0f);
                        midbar_beats = floor (midbar_beats);
                        
@@ -1313,7 +1319,7 @@ TempoMap::round_to_type (nframes64_t frame, int dir, BBTPointType type)
 }
 
 TempoMap::BBTPointList *
-TempoMap::get_points (nframes64_t lower, nframes64_t upper) const
+TempoMap::get_points (framepos_t lower, framepos_t upper) const
 {
 
        Metrics::const_iterator i;
@@ -1332,7 +1338,7 @@ TempoMap::get_points (nframes64_t lower, nframes64_t upper) const
        double delta_bars;
        double delta_beats;
        double dummy;
-       nframes64_t limit;
+       framepos_t limit;
 
        meter = &first_meter ();
        tempo = &first_tempo ();
@@ -1409,7 +1415,7 @@ TempoMap::get_points (nframes64_t lower, nframes64_t upper) const
                        if (beat == 1) {
                                if (current >= lower) {
                                        // cerr << "Add Bar at " << bar << "|1" << " @ " << current << endl;
-                                       points->push_back (BBTPoint (*meter, *tempo,(nframes64_t)rint(current), Bar, bar, 1));
+                                       points->push_back (BBTPoint (*meter, *tempo,(framepos_t)rint(current), Bar, bar, 1));
 
                                }
                        }
@@ -1421,7 +1427,7 @@ TempoMap::get_points (nframes64_t lower, nframes64_t upper) const
                        while (beat <= ceil( beats_per_bar) && beat_frame < limit) {
                                if (beat_frame >= lower) {
                                        // cerr << "Add Beat at " << bar << '|' << beat << " @ " << beat_frame << endl;
-                                       points->push_back (BBTPoint (*meter, *tempo, (nframes64_t) rint(beat_frame), Beat, bar, beat));
+                                       points->push_back (BBTPoint (*meter, *tempo, (framepos_t) rint(beat_frame), Beat, bar, beat));
                                }
                                beat_frame += beat_frames;
                                current+= beat_frames;
@@ -1502,7 +1508,7 @@ TempoMap::get_points (nframes64_t lower, nframes64_t upper) const
 }
 
 const TempoSection&
-TempoMap::tempo_section_at (nframes64_t frame)
+TempoMap::tempo_section_at (framepos_t frame)
 {
        Glib::RWLock::ReaderLock lm (lock);
        Metrics::iterator i;
@@ -1529,7 +1535,7 @@ TempoMap::tempo_section_at (nframes64_t frame)
 }
 
 const Tempo&
-TempoMap::tempo_at (nframes64_t frame) const
+TempoMap::tempo_at (framepos_t frame) const
 {
        TempoMetric m (metric_at (frame));
        return m.tempo();
@@ -1537,7 +1543,7 @@ TempoMap::tempo_at (nframes64_t frame) const
 
 
 const Meter&
-TempoMap::meter_at (nframes64_t frame) const
+TempoMap::meter_at (framepos_t frame) const
 {
        TempoMetric m (metric_at (frame));
        return m.meter();
@@ -1610,7 +1616,7 @@ TempoMap::set_state (const XMLNode& node, int /*version*/)
                }
        }
 
-       StateChanged (Change (0));
+       PropertyChanged (PropertyChange ());
 
        return 0;
 }
@@ -1664,7 +1670,7 @@ TempoMap::n_meters() const
 }
 
 void
-TempoMap::insert_time (nframes64_t where, nframes64_t amount)
+TempoMap::insert_time (framepos_t where, framecnt_t amount)
 {
        for (Metrics::iterator i = metrics->begin(); i != metrics->end(); ++i) {
                if ((*i)->frame() >= where) {
@@ -1674,7 +1680,7 @@ TempoMap::insert_time (nframes64_t where, nframes64_t amount)
 
        timestamp_metrics (false);
 
-       StateChanged (Change (0));
+       PropertyChanged (PropertyChange ());
 }
 
 BBT_Time
@@ -1688,7 +1694,7 @@ TempoMap::bbt_add (const BBT_Time& start, const BBT_Time& other) const
  * add the BBT interval @param increment to  @param start and return the result
  */
 BBT_Time
-TempoMap::bbt_add (const BBT_Time& start, const BBT_Time& increment, const TempoMetric& metric) const
+TempoMap::bbt_add (const BBT_Time& start, const BBT_Time& increment, const TempoMetric& /*metric*/) const
 {
        BBT_Time result = start;
        BBT_Time op = increment; /* argument is const, but we need to modify it */
@@ -1697,7 +1703,9 @@ TempoMap::bbt_add (const BBT_Time& start, const BBT_Time& increment, const Tempo
        if (ticks >= Meter::ticks_per_beat) {
                op.beats++;
                result.ticks = ticks % (uint32_t) Meter::ticks_per_beat;
-       } 
+       } else {
+               result.ticks += op.ticks;
+       }
 
        /* now comes the complicated part. we have to add one beat a time,
           checking for a new metric on every beat.
@@ -1893,3 +1901,33 @@ TempoMap::bbt_subtract (const BBT_Time& start, const BBT_Time& decrement) const
        result.bars -= op.bars;
        return result;
 }
+
+/** Compare the time of this with that of another MetricSection.
+ *  @param with_bbt True to compare using ::start(), false to use ::frame().
+ *  @return -1 for less than, 0 for equal, 1 for greater than.
+ */
+
+int
+MetricSection::compare (MetricSection* other, bool with_bbt) const
+{
+       if (with_bbt) {
+               if (start() == other->start()) {
+                       return 0;
+               } else if (start() < other->start()) {
+                       return -1;
+               } else {
+                       return 1;
+               }
+       } else {
+               if (frame() == other->frame()) {
+                       return 0;
+               } else if (frame() < other->frame()) {
+                       return -1;
+               } else {
+                       return 1;
+               }
+       }
+
+       /* NOTREACHED */
+       return 0;
+}