mega-commit to save state of first "it compilesand links" state for separated disk...
[ardour.git] / libs / ardour / ardour / location.h
index 7a6832eb2d5721c1357574f604c36d3e7317ffc1..24ee5639153357bf11a40af07d1299b1f0229a4f 100644 (file)
@@ -41,6 +41,7 @@ namespace ARDOUR {
 
 class SceneChange;
 
+/** Location on Timeline - abstract representation for Markers, Loop/Punch Ranges, CD-Markers etc. */
 class LIBARDOUR_API Location : public SessionHandleRef, public PBD::StatefulDestructible
 {
   public:
@@ -57,11 +58,11 @@ class LIBARDOUR_API Location : public SessionHandleRef, public PBD::StatefulDest
        };
 
        Location (Session &);
-       Location (Session &, framepos_t, framepos_t, const std::string &, Flags bits = Flags(0));
+       Location (Session &, framepos_t, framepos_t, const std::string &, Flags bits = Flags(0), const uint32_t sub_num = 0);
        Location (const Location& other);
        Location (Session &, const XMLNode&);
        Location* operator= (const Location& other);
-    
+
        bool operator==(const Location& other);
 
        bool locked() const { return _locked; }
@@ -72,11 +73,11 @@ class LIBARDOUR_API Location : public SessionHandleRef, public PBD::StatefulDest
        framepos_t end() const { return _end; }
        framecnt_t length() const { return _end - _start; }
 
-       int set_start (framepos_t s, bool force = false, bool allow_bbt_recompute = true);
-       int set_end (framepos_t e, bool force = false, bool allow_bbt_recompute = true);
-       int set (framepos_t start, framepos_t end, bool allow_bbt_recompute = true);
+       int set_start (framepos_t s, bool force = false, bool allow_beat_recompute = true, const uint32_t sub_num = 0);
+       int set_end (framepos_t e, bool force = false, bool allow_beat_recompute = true, const uint32_t sub_num = 0);
+       int set (framepos_t start, framepos_t end, bool allow_beat_recompute = true, const uint32_t sub_num = 0);
 
-       int move_to (framepos_t pos);
+       int move_to (framepos_t pos, const uint32_t sub_num);
 
        const std::string& name() const { return _name; }
        void set_name (const std::string &str);
@@ -120,18 +121,18 @@ class LIBARDOUR_API Location : public SessionHandleRef, public PBD::StatefulDest
        static PBD::Signal1<void,Location*> changed;
 
        /* these are member signals for objects that care only about
-          changes to this object 
+          changes to this object
        */
 
        PBD::Signal0<void> Changed;
-    
+
        PBD::Signal0<void> NameChanged;
        PBD::Signal0<void> EndChanged;
        PBD::Signal0<void> StartChanged;
        PBD::Signal0<void> FlagsChanged;
        PBD::Signal0<void> LockChanged;
        PBD::Signal0<void> PositionLockStyleChanged;
-        
+
        /* CD Track / CD-Text info */
 
        std::map<std::string, std::string> cd_info;
@@ -142,26 +143,28 @@ class LIBARDOUR_API Location : public SessionHandleRef, public PBD::StatefulDest
 
        PositionLockStyle position_lock_style() const { return _position_lock_style; }
        void set_position_lock_style (PositionLockStyle ps);
-       void recompute_frames_from_bbt ();
+       void recompute_frames_from_beat ();
 
-       static PBD::Signal0<void> scene_changed;
+       static PBD::Signal0<void> scene_changed; /* for use by backend scene change management, class level */
+        PBD::Signal0<void> SceneChangeChanged;   /* for use by objects interested in this object */
 
   private:
        std::string        _name;
        framepos_t         _start;
-       Timecode::BBT_Time _bbt_start;
+       double             _start_beat;
        framepos_t         _end;
-       Timecode::BBT_Time _bbt_end;
+       double             _end_beat;
        Flags              _flags;
        bool               _locked;
        PositionLockStyle  _position_lock_style;
        boost::shared_ptr<SceneChange> _scene_change;
-    
+
        void set_mark (bool yn);
        bool set_flag_internal (bool yn, Flags flag);
-       void recompute_bbt_from_frames ();
+       void recompute_beat_from_frames (const uint32_t sub_num);
 };
 
+/** A collection of session locations including unique dedicated locations (loop, punch, etc) */
 class LIBARDOUR_API Locations : public SessionHandleRef, public PBD::StatefulDestructible
 {
   public:
@@ -170,7 +173,8 @@ class LIBARDOUR_API Locations : public SessionHandleRef, public PBD::StatefulDes
        Locations (Session &);
        ~Locations ();
 
-       const LocationList& list() { return locations; }
+       const LocationList& list () const { return locations; }
+       LocationList list () { return locations; }
 
        void add (Location *, bool make_current = false);
        void remove (Location *);
@@ -200,7 +204,7 @@ class LIBARDOUR_API Locations : public SessionHandleRef, public PBD::StatefulDes
        void marks_either_side (framepos_t const, framepos_t &, framepos_t &) const;
 
        void find_all_between (framepos_t start, framepos_t, LocationList&, Location::Flags);
-    
+
        PBD::Signal1<void,Location*> current_changed;
 
        /* Objects that care about individual addition and removal of Locations should connect to added/removed.