track templates, backported from 2.X
[ardour.git] / libs / ardour / ardour / tempo.h
index db0689460728a34670d324122f2b421fc7e94906..e82639ef517f405efa0463f53acbd0521063eab1 100644 (file)
@@ -15,7 +15,6 @@
     along with this program; if not, write to the Free Software
     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 
-    $Id$
 */
 
 #ifndef __ardour_tempo_h__
 #include <vector>
 #include <cmath>
 #include <glibmm/thread.h>
-#include <pbd/undo.h>
-#include <pbd/stateful.h> 
+
+#include "pbd/undo.h"
+#include "pbd/stateful.h" 
+#include "pbd/statefuldestructible.h" 
+
 #include <sigc++/signal.h>
 
-#include <ardour/ardour.h>
-#include <ardour/state_manager.h>
+#include "ardour/ardour.h"
 
 class XMLNode;
 
@@ -39,27 +40,19 @@ using std::list;
 using std::vector;
 
 namespace ARDOUR {
-
+class Meter;
 class Tempo {
   public:
-       Tempo (double bpm)
-               : _beats_per_minute (bpm) {}
-       Tempo (const Tempo& other) {
-               _beats_per_minute = other._beats_per_minute;
-       }
-       void operator= (const Tempo& other) {
-               if (&other != this) {
-                       _beats_per_minute = other._beats_per_minute;
-               }
-       }
+       Tempo (double bpm, double type=4.0) // defaulting to quarter note
+               : _beats_per_minute (bpm), _note_type(type) {} 
 
-       double beats_per_minute () const { return _beats_per_minute; }
-       double frames_per_beat (jack_nframes_t sr) const {
-               return  ((60.0 * sr) / _beats_per_minute);
-       }
+       double beats_per_minute () const { return _beats_per_minute;}
+       double note_type () const { return _note_type;}
+       double frames_per_beat (nframes_t sr, const Meter& meter) const;
 
   protected:
        double _beats_per_minute;
+       double _note_type;
 };
 
 class Meter {
@@ -68,37 +61,22 @@ class Meter {
 
        Meter (double bpb, double bt) 
                : _beats_per_bar (bpb), _note_type (bt) {}
-       Meter (const Meter& other) {
-               _beats_per_bar = other._beats_per_bar;
-               _note_type = other._note_type;
-       }
-       void operator= (const Meter& other) {
-               if (&other != this) {
-                       _beats_per_bar = other._beats_per_bar;
-                       _note_type = other._note_type;
-               }
-       }
 
        double beats_per_bar () const { return _beats_per_bar; }
        double note_divisor() const { return _note_type; }
        
-       double frames_per_bar (const Tempo&, jack_nframes_t sr) const;
+       double frames_per_bar (const Tempo&, nframes_t sr) const;
 
   protected:
-
-       /* this is the number of beats in a bar. it is a real value
-          because there are musical traditions on our planet
-          that do not limit themselves to integral numbers of beats
-          per bar.
+       /** The number of beats in a bar.  This is a real value because
+           there are musical traditions on our planet that do not limit
+           themselves to integral numbers of beats per bar.
        */
-
        double _beats_per_bar;
 
-       /* this is the type of "note" that a beat represents. for example,
-          4.0 would be a quarter (crotchet) note, 8.0 would be an eighth 
-          (quaver) note, etc.
+       /** The type of "note" that a beat represents.  For example, 4.0 is
+           a quarter (crotchet) note, 8.0 is an eighth (quaver) note, etc.
        */
-
        double _note_type;
 };
 
@@ -106,17 +84,20 @@ class MetricSection {
   public:
        MetricSection (const BBT_Time& start)
                : _start (start), _frame (0), _movable (true) {}
+       MetricSection (nframes_t start)
+               : _frame (start), _movable (true) {}
+
        virtual ~MetricSection() {}
 
        const BBT_Time& start() const { return _start; }
-       const jack_nframes_t frame() const { return _frame; }
+       nframes_t       frame() const { return _frame; }
 
        void set_movable (bool yn) { _movable = yn; }
        bool movable() const { return _movable; }
 
-       virtual void set_frame (jack_nframes_t f) {
+       virtual void set_frame (nframes_t f) {
                _frame = f;
-       };
+       }
 
        virtual void set_start (const BBT_Time& w) {
                _start = w;
@@ -126,12 +107,11 @@ class MetricSection {
           but we do want them to control their own
           XML state information.
        */
-
        virtual XMLNode& get_state() const = 0;
 
   private:
        BBT_Time       _start;
-       jack_nframes_t _frame;
+       nframes_t      _frame;
        bool           _movable;
 };
 
@@ -139,6 +119,8 @@ class MeterSection : public MetricSection, public Meter {
   public:
        MeterSection (const BBT_Time& start, double bpb, double note_type)
                : MetricSection (start), Meter (bpb, note_type) {}
+       MeterSection (nframes_t start, double bpb, double note_type)
+               : MetricSection (start), Meter (bpb, note_type) {}
        MeterSection (const XMLNode&);
 
        static const string xml_state_node_name;
@@ -148,8 +130,10 @@ class MeterSection : public MetricSection, public Meter {
 
 class TempoSection : public MetricSection, public Tempo {
   public:
-       TempoSection (const BBT_Time& start, double qpm)
-               : MetricSection (start), Tempo (qpm) {}
+       TempoSection (const BBT_Time& start, double qpm, double note_type)
+               : MetricSection (start), Tempo (qpm, note_type) {}
+       TempoSection (nframes_t start, double qpm, double note_type)
+               : MetricSection (start), Tempo (qpm, note_type) {}
        TempoSection (const XMLNode&);
 
        static const string xml_state_node_name;
@@ -159,20 +143,10 @@ class TempoSection : public MetricSection, public Tempo {
 
 typedef list<MetricSection*> Metrics;
 
-class TempoMapState : public StateManager::State {
+class TempoMap : public PBD::StatefulDestructible
+{
   public:
-       TempoMapState (std::string why) 
-               : StateManager::State (why) {
-               metrics = new Metrics;
-       }
-
-       Metrics *metrics;
-};
-
-class TempoMap : public Stateful, public StateManager {
-  public:
-
-       TempoMap (jack_nframes_t frame_rate);
+       TempoMap (nframes_t frame_rate);
        ~TempoMap();
 
        /* measure-based stuff */
@@ -184,38 +158,44 @@ class TempoMap : public Stateful, public StateManager {
 
        struct BBTPoint {
            BBTPointType type;
-           jack_nframes_t frame;
+           nframes_t frame;
            const Meter* meter;
            const Tempo* tempo;
            uint32_t bar;
            uint32_t beat;
            
-           BBTPoint (const Meter& m, const Tempo& t, jack_nframes_t f, BBTPointType ty, uint32_t b, uint32_t e) 
+           BBTPoint (const Meter& m, const Tempo& t, nframes_t f,
+                               BBTPointType ty, uint32_t b, uint32_t e) 
                    : type (ty), frame (f), meter (&m), tempo (&t), bar (b), beat (e) {}
        };
 
        typedef vector<BBTPoint> BBTPointList;
        
        template<class T> void apply_with_metrics (T& obj, void (T::*method)(const Metrics&)) {
-               Glib::Mutex::Lock lm (lock);
+               Glib::RWLock::ReaderLock lm (lock);
                (obj.*method)(*metrics);
        }
 
-       BBTPointList *get_points (jack_nframes_t start, jack_nframes_t end) const;
+       BBTPointList *get_points (nframes_t start, nframes_t end) const;
 
-       void           bbt_time (jack_nframes_t when, BBT_Time&) const;
-       jack_nframes_t frame_time (const BBT_Time&) const;
-       jack_nframes_t bbt_duration_at (jack_nframes_t, const BBT_Time&, int dir) const;
+       void      bbt_time (nframes_t when, BBT_Time&) const;
+       nframes_t frame_time (const BBT_Time&) const;
+       nframes_t bbt_duration_at (nframes_t, const BBT_Time&, int dir) const;
 
        static const Tempo& default_tempo() { return _default_tempo; }
        static const Meter& default_meter() { return _default_meter; }
 
-       const Tempo& tempo_at (jack_nframes_t);
-       const Meter& meter_at (jack_nframes_t);
+       const Tempo& tempo_at (nframes_t);
+       const Meter& meter_at (nframes_t);
+
+       const TempoSection& tempo_section_at (nframes_t);
 
        void add_tempo(const Tempo&, BBT_Time where);
        void add_meter(const Meter&, BBT_Time where);
 
+       void add_tempo(const Tempo&, nframes_t where);
+       void add_meter(const Meter&, nframes_t where);
+
        void move_tempo (TempoSection&, const BBT_Time& to);
        void move_meter (MeterSection&, const BBT_Time& to);
        
@@ -225,16 +205,12 @@ class TempoMap : public Stateful, public StateManager {
        void replace_tempo (TempoSection& existing, const Tempo& replacement);
        void replace_meter (MeterSection& existing, const Meter& replacement);
 
+       nframes_t round_to_bar  (nframes_t frame, int dir);
+       nframes_t round_to_beat (nframes_t frame, int dir);
+       nframes_t round_to_beat_subdivision (nframes_t fr, int sub_num);
+       nframes_t round_to_tick (nframes_t frame, int dir);
 
-       jack_nframes_t round_to_bar  (jack_nframes_t frame, int dir);
-
-       jack_nframes_t round_to_beat (jack_nframes_t frame, int dir);
-
-       jack_nframes_t round_to_beat_subdivision (jack_nframes_t fr, int sub_num);
-
-       jack_nframes_t round_to_tick (jack_nframes_t frame, int dir);
-
-       void set_length (jack_nframes_t frames);
+       void set_length (nframes_t frames);
 
        XMLNode& get_state (void);
        int set_state (const XMLNode&);
@@ -242,79 +218,72 @@ class TempoMap : public Stateful, public StateManager {
        void dump (std::ostream&) const;
        void clear ();
 
-       UndoAction get_memento() const;
-
-       /* this is a helper class that we use to be able to keep
-          track of which meter *AND* tempo are in effect at
-          a given point in time.
+       /** Helper class that we use to be able to keep track of which
+           meter *AND* tempo are in effect at a given point in time.
        */
-
        class Metric {
          public:
                Metric (const Meter& m, const Tempo& t) : _meter (&m), _tempo (&t), _frame (0) {}
                
                void set_tempo (const Tempo& t)    { _tempo = &t; }
                void set_meter (const Meter& m)    { _meter = &m; }
-               void set_frame (jack_nframes_t f)  { _frame = f; }
+               void set_frame (nframes_t f)       { _frame = f; }
                void set_start (const BBT_Time& t) { _start = t; }
                
                const Meter&    meter() const { return *_meter; }
                const Tempo&    tempo() const { return *_tempo; }
-               jack_nframes_t  frame() const { return _frame; }
+               nframes_t       frame() const { return _frame; }
                const BBT_Time& start() const { return _start; }
                
          private:
                const Meter*   _meter;
                const Tempo*   _tempo;
-               jack_nframes_t _frame;
+               nframes_t      _frame;
                BBT_Time       _start;
-               
        };
 
        Metric metric_at (BBT_Time bbt) const;
-       Metric metric_at (jack_nframes_t) const;
-        void bbt_time_with_metric (jack_nframes_t, BBT_Time&, const Metric&) const;
+       Metric metric_at (nframes_t) const;
+       void bbt_time_with_metric (nframes_t, BBT_Time&, const Metric&) const;
+
+       void change_existing_tempo_at (nframes_t, double bpm, double note_type);
+       void change_initial_tempo (double bpm, double note_type);
+
+       int n_tempos () const;
+       int n_meters () const;
+
+       sigc::signal<void,ARDOUR::Change> StateChanged;
 
   private:
        static Tempo    _default_tempo;
        static Meter    _default_meter;
 
-       Metrics            *metrics;
-       jack_nframes_t     _frame_rate;
-       jack_nframes_t      last_bbt_when;
-       bool                last_bbt_valid;
-       BBT_Time            last_bbt;
-       mutable Glib::Mutex   lock;
+       Metrics*             metrics;
+       nframes_t           _frame_rate;
+       nframes_t            last_bbt_when;
+       bool                 last_bbt_valid;
+       BBT_Time             last_bbt;
+       mutable Glib::RWLock lock;
        
-       void timestamp_metrics ();
-
+       void timestamp_metrics (bool use_bbt);
 
-       jack_nframes_t round_to_type (jack_nframes_t fr, int dir, BBTPointType);
+       nframes_t round_to_type (nframes_t fr, int dir, BBTPointType);
 
-       jack_nframes_t frame_time_unlocked (const BBT_Time&) const;
+       nframes_t frame_time_unlocked (const BBT_Time&) const;
 
-       void bbt_time_unlocked (jack_nframes_t, BBT_Time&) const;
+       void bbt_time_unlocked (nframes_t, BBT_Time&) const;
 
-       jack_nframes_t bbt_duration_at_unlocked (const BBT_Time& when, const BBT_Time& bbt, int dir) const;
+       nframes_t bbt_duration_at_unlocked (const BBT_Time& when, const BBT_Time& bbt, int dir) const;
 
        const MeterSection& first_meter() const;
        const TempoSection& first_tempo() const;
 
-       jack_nframes_t count_frames_between (const BBT_Time&, const BBT_Time&) const;
-       jack_nframes_t count_frames_between_metrics (const Meter&, const Tempo&, const BBT_Time&, const BBT_Time&) const;
+       nframes_t count_frames_between (const BBT_Time&, const BBT_Time&) const;
+       nframes_t count_frames_between_metrics (const Meter&, const Tempo&,
+                       const BBT_Time&, const BBT_Time&) const;
 
        int move_metric_section (MetricSection&, const BBT_Time& to);
-       void do_insert (MetricSection* section);
-
-       Change  restore_state (StateManager::State&);
-       StateManager::State* state_factory (std::string why) const;
-
-       bool        in_set_state;
-
-       /* override state_manager::save_state so we can check in_set_state */
-
-       void save_state (std::string why);
-
+       void do_insert (MetricSection* section, bool with_bbt);
 };
 
 }; /* namespace ARDOUR */