Fix broken whitespace. I'd apologize for the compile times if it was my fault :D
[ardour.git] / libs / ardour / ardour / location.h
index ff953d1d7895ab8c138776acc1565480900bd0ce..71f4c1aa6ac1110c88239f69360b04ebf1e9f072 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2000 Paul Davis 
+    Copyright (C) 2000 Paul Davis
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
@@ -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_location_h__
 #include <map>
 
 #include <sys/types.h>
-#include <sigc++/signal.h>
 
 #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 <ardour/ardour.h>
-#include <ardour/state_manager.h>
-
-using std::string;
+#include "ardour/ardour.h"
+#include "ardour/session_handle.h"
 
 namespace ARDOUR {
 
-class Location : public Stateful, public sigc::trackable
+class Location : public SessionHandleRef, public PBD::StatefulDestructible
 {
   public:
        enum Flags {
@@ -50,96 +47,98 @@ class Location : public Stateful, public sigc::trackable
                IsAutoLoop = 0x4,
                IsHidden = 0x8,
                IsCDMarker = 0x10,
-               IsEnd = 0x20,
-               IsRangeMarker = 0x40,
-               IsStart = 0x80
+               IsRangeMarker = 0x20,
+               IsSessionRange = 0x40
        };
 
-       Location (jack_nframes_t sample_start,
-                 jack_nframes_t sample_end,
-                 const string &name,
-                 Flags bits = Flags(0))                
-               
-               : _name (name),
-               _start (sample_start),
-               _end (sample_end),
-               _flags (bits) { }
-       
-       Location () {
-               _start = 0;
-               _end = 0;
-               _flags = 0;     
-       }
-
+       Location (Session &);
+       Location (Session &, framepos_t, framepos_t, const std::string &, Flags bits = Flags(0));
        Location (const Location& other);
+       Location (Session &, const XMLNode&);
        Location* operator= (const Location& other);
 
-       jack_nframes_t start() { return _start; }
-       jack_nframes_t end() { return _end; }
-       jack_nframes_t length() { return _end - _start; }
+       bool locked() const { return _locked; }
+       void lock ();
+       void unlock ();
+
+       framepos_t start() const  { return _start; }
+       framepos_t end() const { return _end; }
+       framepos_t length() const { return _end - _start; }
 
-       int set_start (jack_nframes_t s);
-       int set_end (jack_nframes_t e);
-       int set (jack_nframes_t start, jack_nframes_t end);
+       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);
 
-       const string& name() { return _name; }
-       void set_name (const string &str) { _name = str; name_changed(this); }
+       int move_to (framepos_t pos);
+
+       const std::string& name() const { return _name; }
+       void set_name (const std::string &str) { _name = str; name_changed(this); }
 
        void set_auto_punch (bool yn, void *src);
        void set_auto_loop (bool yn, void *src);
        void set_hidden (bool yn, void *src);
        void set_cd (bool yn, void *src);
-       void set_is_end (bool yn, void* src);
-       void set_is_start (bool yn, void* src);
+       void set_is_range_marker (bool yn, void* src);
+
+       bool is_auto_punch () const { return _flags & IsAutoPunch; }
+       bool is_auto_loop () const { return _flags & IsAutoLoop; }
+       bool is_mark () const { return _flags & IsMark; }
+       bool is_hidden () const { return _flags & IsHidden; }
+       bool is_cd_marker () const { return _flags & IsCDMarker; }
+       bool is_session_range () const { return _flags & IsSessionRange; }
+       bool is_range_marker() const { return _flags & IsRangeMarker; }
+       bool matches (Flags f) const { return _flags & f; }
 
-       bool is_auto_punch ()  { return _flags & IsAutoPunch; }
-       bool is_auto_loop () { return _flags & IsAutoLoop; }
-       bool is_mark () { return _flags & IsMark; }
-       bool is_hidden () { return _flags & IsHidden; }
-       bool is_cd_marker () { return _flags & IsCDMarker; }
-       bool is_end() { return _flags & IsEnd; }
-       bool is_start() { return _flags & IsStart; }
-       bool is_range_marker() { return _flags & IsRangeMarker; }
+       Flags flags () const { return _flags; }
 
-       sigc::signal<void,Location*> name_changed;
-       sigc::signal<void,Location*> end_changed;
-       sigc::signal<void,Location*> start_changed;
+       PBD::Signal1<void,Location*> name_changed;
+       PBD::Signal1<void,Location*> end_changed;
+       PBD::Signal1<void,Location*> start_changed;
 
-       sigc::signal<void,Location*,void*> FlagsChanged;
+       PBD::Signal1<void,Location*> LockChanged;
+       PBD::Signal2<void,Location*,void*> FlagsChanged;
+       PBD::Signal1<void,Location*> PositionLockStyleChanged;
 
-       /* this is sent only when both start&end change at the same time */
+       /* this is sent only when both start and end change at the same time */
+       PBD::Signal1<void,Location*> changed;
 
-       sigc::signal<void,Location*> changed;
-   
        /* CD Track / CD-Text info */
 
-       std::map<string, string> cd_info;
-       XMLNode& cd_info_node (const string &, const string &);
+       std::map<std::string, std::string> cd_info;
+       XMLNode& cd_info_node (const std::string &, const std::string &);
 
        XMLNode& get_state (void);
-       int set_state (const XMLNode&);
+       int set_state (const XMLNode&, int version);
 
-        PBD::ID id() { return _id; }
+       PositionLockStyle position_lock_style() const { return _position_lock_style; }
+       void set_position_lock_style (PositionLockStyle ps);
+       void recompute_frames_from_bbt ();
 
   private:
-        PBD::ID _id;
-       string        _name;
-       jack_nframes_t     _start;
-       jack_nframes_t     _end;
-       uint32_t _flags;
+       std::string        _name;
+       framepos_t         _start;
+       Timecode::BBT_Time _bbt_start;
+       framepos_t         _end;
+       Timecode::BBT_Time _bbt_end;
+       Flags              _flags;
+       bool               _locked;
+       PositionLockStyle  _position_lock_style;
 
        void set_mark (bool yn);
        bool set_flag_internal (bool yn, Flags flag);
+       void recompute_bbt_from_frames ();
 };
 
-class Locations : public Stateful, public StateManager
+class Locations : public SessionHandleRef, public PBD::StatefulDestructible
 {
   public:
        typedef std::list<Location *> LocationList;
 
-       Locations ();
+       Locations (Session &);
        ~Locations ();
 
+       const LocationList& list() { return locations; }
+
        void add (Location *, bool make_current = false);
        void remove (Location *);
        void clear ();
@@ -147,29 +146,39 @@ class Locations : public Stateful, public StateManager
        void clear_ranges ();
 
        XMLNode& get_state (void);
-       int set_state (const XMLNode&);
-        PBD::ID id() { return _id; }
+       int set_state (const XMLNode&, int version);
+       Location *get_location_by_id(PBD::ID);
 
        Location* auto_loop_location () const;
        Location* auto_punch_location () const;
-       Location* end_location() const;
-       Location* start_location() const;
+       Location* session_range_location() const;
 
+       int next_available_name(std::string& result,std::string base);
        uint32_t num_range_markers() const;
 
        int set_current (Location *, bool want_lock = true);
        Location *current () const { return current_location; }
 
-       Location *first_location_before (jack_nframes_t);
-       Location *first_location_after (jack_nframes_t);
+       Location* first_location_before (framepos_t, bool include_special_ranges = false);
+       Location* first_location_after (framepos_t, bool include_special_ranges = false);
+
+       void marks_either_side (framepos_t const, framepos_t &, framepos_t &) const;
 
-       jack_nframes_t first_mark_before (jack_nframes_t);
-       jack_nframes_t first_mark_after (jack_nframes_t);
+       void find_all_between (framepos_t start, framepos_t, LocationList&, Location::Flags);
 
-       sigc::signal<void,Location*> current_changed;
-       sigc::signal<void>           changed;
-       sigc::signal<void,Location*> added;
-       sigc::signal<void,Location*> removed;
+       enum Change {
+               ADDITION, ///< a location was added, but nothing else changed
+               REMOVAL, ///< a location was removed, but nothing else changed
+               OTHER ///< something more complicated happened
+       };
+
+       PBD::Signal1<void,Location*> current_changed;
+       /** something changed about the location list; the parameter gives some idea as to what */
+       PBD::Signal1<void,Change>    changed;
+       /** a location has been added to the end of the list */
+       PBD::Signal1<void,Location*> added;
+       PBD::Signal1<void,Location*> removed;
+       PBD::Signal1<void,const PBD::PropertyChange&>    StateChanged;
 
        template<class T> void apply (T& obj, void (T::*method)(LocationList&)) {
                Glib::Mutex::Lock lm (lock);
@@ -181,28 +190,14 @@ class Locations : public Stateful, public StateManager
                (obj.*method)(locations, arg);
        }
 
-       UndoAction get_memento () const;
-
   private:
 
-       struct State : public ARDOUR::StateManager::State {
-           LocationList locations;
-           LocationList states;
-
-           State (std::string why) : ARDOUR::StateManager::State (why) {}
-       };
-
-       LocationList       locations;
-       Location          *current_location;
+       LocationList         locations;
+       Location            *current_location;
        mutable Glib::Mutex  lock;
 
        int set_current_unlocked (Location *);
        void location_changed (Location*);
-
-       Change   restore_state (StateManager::State&);
-       StateManager::State* state_factory (std::string why) const;
-
-        PBD::ID _id;
 };
 
 } // namespace ARDOUR