/*
- 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
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 <glibmm/threads.h>
-#include <pbd/undo.h>
-#include <pbd/stateful.h>
-#include <pbd/statefuldestructible.h>
+#include "pbd/undo.h"
+#include "pbd/stateful.h"
+#include "pbd/statefuldestructible.h"
-#include <ardour/ardour.h>
-
-using std::string;
+#include "ardour/ardour.h"
+#include "ardour/scene_change.h"
+#include "ardour/session_handle.h"
namespace ARDOUR {
-class Location : public PBD::StatefulDestructible
+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:
enum Flags {
IsAutoLoop = 0x4,
IsHidden = 0x8,
IsCDMarker = 0x10,
- IsEnd = 0x20,
- IsRangeMarker = 0x40,
- IsStart = 0x80
+ IsRangeMarker = 0x20,
+ IsSessionRange = 0x40,
+ IsSkip = 0x80,
+ IsSkipping = 0x100, /* skipping is active (or not) */
};
- Location (nframes_t sample_start,
- 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 = Flags (0);
- }
-
+ Location (Session &);
+ Location (Session &, framepos_t, framepos_t, const std::string &, Flags bits = Flags(0));
Location (const Location& other);
- Location (const XMLNode&);
+ Location (Session &, const XMLNode&);
Location* operator= (const Location& other);
- nframes_t start() { return _start; }
- nframes_t end() { return _end; }
- nframes_t length() { return _end - _start; }
+ bool operator==(const Location& other);
+
+ bool locked() const { return _locked; }
+ void lock ();
+ void unlock ();
- int set_start (nframes_t s);
- int set_end (nframes_t e);
- int set (nframes_t start, nframes_t end);
+ framepos_t start() const { return _start; }
+ framepos_t end() const { return _end; }
+ framecnt_t length() const { return _end - _start; }
- const string& name() { return _name; }
- void set_name (const string &str) { _name = str; name_changed(this); }
+ 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 move_to (framepos_t pos);
+
+ const std::string& name() const { return _name; }
+ void set_name (const std::string &str);
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);
-
- 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; }
-
- sigc::signal<void,Location*> name_changed;
- sigc::signal<void,Location*> end_changed;
- sigc::signal<void,Location*> start_changed;
+ void set_is_range_marker (bool yn, void* src);
+ void set_skip (bool yn);
+ void set_skipping (bool yn);
+
+ 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 is_skip() const { return _flags & IsSkip; }
+ bool is_skipping() const { return (_flags & IsSkip) && (_flags & IsSkipping); }
+ bool matches (Flags f) const { return _flags & f; }
+
+ Flags flags () const { return _flags; }
+
+ boost::shared_ptr<SceneChange> scene_change() const { return _scene_change; }
+ void set_scene_change (boost::shared_ptr<SceneChange>);
+
+ /* these are static signals for objects that want to listen to all
+ locations at once.
+ */
+
+ static PBD::Signal1<void,Location*> name_changed;
+ static PBD::Signal1<void,Location*> end_changed;
+ static PBD::Signal1<void,Location*> start_changed;
+ static PBD::Signal1<void,Location*> flags_changed;
+ static PBD::Signal1<void,Location*> lock_changed;
+ static PBD::Signal1<void,Location*> position_lock_style_changed;
+
+ /* this is sent only when both start and end change at the same time */
+ static PBD::Signal1<void,Location*> changed;
+
+ /* these are member signals for objects that care only about
+ 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;
- sigc::signal<void,Location*,void*> FlagsChanged;
-
- /* this is sent only when both start&end change at the same time */
-
- 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);
+
+ PositionLockStyle position_lock_style() const { return _position_lock_style; }
+ void set_position_lock_style (PositionLockStyle ps);
+ void recompute_frames_from_bbt ();
+
+ 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:
- string _name;
- nframes_t _start;
- nframes_t _end;
- Flags _flags;
+ std::string _name;
+ framepos_t _start;
+ double _bbt_start;
+ framepos_t _end;
+ double _bbt_end;
+ 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 ();
};
-class Locations : public PBD::StatefulDestructible
+/** A collection of session locations including unique dedicated locations (loop, punch, etc) */
+class LIBARDOUR_API 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 ();
void clear_ranges ();
XMLNode& get_state (void);
- int set_state (const XMLNode&);
- Location *get_location_by_id(PBD::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(string& result,string base);
+ 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 (nframes_t);
- Location *first_location_after (nframes_t);
+ Location* mark_at (framepos_t, framecnt_t slop = 0) const;
- nframes_t first_mark_before (nframes_t);
- nframes_t first_mark_after (nframes_t);
+ framepos_t first_mark_before (framepos_t, bool include_special_ranges = false);
+ framepos_t first_mark_after (framepos_t, bool include_special_ranges = false);
- sigc::signal<void,Location*> current_changed;
- sigc::signal<void> changed;
- sigc::signal<void,Location*> added;
- sigc::signal<void,Location*> removed;
- sigc::signal<void,Change> StateChanged;
+ void marks_either_side (framepos_t const, framepos_t &, framepos_t &) const;
- template<class T> void apply (T& obj, void (T::*method)(LocationList&)) {
- Glib::Mutex::Lock lm (lock);
- (obj.*method)(locations);
- }
+ 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.
+ If an object additionally cares about potential mass clearance of Locations, they should connect to changed.
+ */
+
+ PBD::Signal1<void,Location*> added;
+ PBD::Signal1<void,Location*> removed;
+ PBD::Signal0<void> changed; /* emitted when any action that could have added/removed more than 1 location actually removed 1 or more */
- template<class T1, class T2> void apply (T1& obj, void (T1::*method)(LocationList&, T2& arg), T2& arg) {
- Glib::Mutex::Lock lm (lock);
- (obj.*method)(locations, arg);
+ template<class T> void apply (T& obj, void (T::*method)(const LocationList&)) const {
+ /* We don't want to hold the lock while the given method runs, so take a copy
+ of the list and pass that instead.
+ */
+ Locations::LocationList copy;
+ {
+ Glib::Threads::Mutex::Lock lm (lock);
+ copy = locations;
+ }
+ (obj.*method)(copy);
}
private:
- LocationList locations;
- Location *current_location;
- mutable Glib::Mutex lock;
+ LocationList locations;
+ Location *current_location;
+ mutable Glib::Threads::Mutex lock;
int set_current_unlocked (Location *);
void location_changed (Location*);
+ void listen_to (Location*);
};
} // namespace ARDOUR
projects / ardour.git / blobdiff