tempo doc explains that currently Tempo::beats_per_minute means something else.

[ardour.git] / libs / ardour / ardour / tempo.h

diff --git a/libs/ardour/ardour/tempo.h b/libs/ardour/ardour/tempo.h
index 57c6ced2759b799f87adf7ccfd9e6b4b83bf2b98..d52232e88e5cd7d886a8e11745b74542608cb71a 100644 (file)
--- a/libs/ardour/ardour/tempo.h
+++ b/libs/ardour/ardour/tempo.h
@@ -50,14 +50,14 @@ class TempoMap;
 class LIBARDOUR_API Tempo {
   public:
        /**
-        * @param bpm Beats Per Minute
+        * @param npm Note Types per minute
         * @param type Note Type (default `4': quarter note)
         */
-       Tempo (double bpm, double type=4.0) // defaulting to quarter note
-               : _beats_per_minute (bpm), _note_type(type) {}
+       Tempo (double npm, double type=4.0) // defaulting to quarter note
+               : _beats_per_minute (npm), _note_type(type) {}
 
        /*
-          quarter note beats as distinct from a beat derived from meter and pulse.
+          note types per minute.
        */
        double beats_per_minute () const { return _beats_per_minute; }
        void set_beats_per_minute (double bpm) { _beats_per_minute = bpm; }
@@ -441,6 +441,7 @@ class LIBARDOUR_API TempoMap : public PBD::StatefulDestructible
        Evoral::Beats framewalk_to_qn (framepos_t pos, framecnt_t distance) const;
 
        /* quarter note related functions are also tempo-sensitive and ignore meter.
+          quarter notes may be compared with and assigned to Evoral::Beats.
        */
        double quarter_note_at_frame (const framepos_t frame);
        double quarter_note_at_frame_rt (const framepos_t frame);
@@ -451,6 +452,7 @@ class LIBARDOUR_API TempoMap : public PBD::StatefulDestructible
        double quarter_note_at_beat (const double beat);
        double beat_at_quarter_note (const double beat);
 
+       /* obtain a musical subdivision via a frame position and magic note divisor.*/
        double exact_qn_at_frame (const framepos_t& frame, const int32_t sub_num);
        double exact_beat_at_frame (const framepos_t& frame, const int32_t sub_num);