2 Copyright (C) 2000 Paul Davis
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 #ifndef __ardour_location_h__
21 #define __ardour_location_h__
28 #include <sys/types.h>
30 #include <glibmm/threads.h>
33 #include "pbd/stateful.h"
34 #include "pbd/statefuldestructible.h"
36 #include "ardour/ardour.h"
37 #include "ardour/scene_change.h"
38 #include "ardour/session_handle.h"
44 class LIBARDOUR_API Location : public SessionHandleRef, public PBD::StatefulDestructible
54 IsSessionRange = 0x40,
59 Location (Session &, framepos_t, framepos_t, const std::string &, Flags bits = Flags(0));
60 Location (const Location& other);
61 Location (Session &, const XMLNode&);
62 Location* operator= (const Location& other);
64 bool operator==(const Location& other);
66 bool locked() const { return _locked; }
70 framepos_t start() const { return _start; }
71 framepos_t end() const { return _end; }
72 framecnt_t length() const { return _end - _start; }
74 int set_start (framepos_t s, bool force = false, bool allow_bbt_recompute = true);
75 int set_end (framepos_t e, bool force = false, bool allow_bbt_recompute = true);
76 int set (framepos_t start, framepos_t end, bool allow_bbt_recompute = true);
78 int move_to (framepos_t pos);
80 const std::string& name() const { return _name; }
81 void set_name (const std::string &str) { _name = str; name_changed(this); }
83 void set_auto_punch (bool yn, void *src);
84 void set_auto_loop (bool yn, void *src);
85 void set_hidden (bool yn, void *src);
86 void set_cd (bool yn, void *src);
87 void set_is_range_marker (bool yn, void* src);
88 void set_skip (bool yn);
90 bool is_auto_punch () const { return _flags & IsAutoPunch; }
91 bool is_auto_loop () const { return _flags & IsAutoLoop; }
92 bool is_mark () const { return _flags & IsMark; }
93 bool is_hidden () const { return _flags & IsHidden; }
94 bool is_cd_marker () const { return _flags & IsCDMarker; }
95 bool is_session_range () const { return _flags & IsSessionRange; }
96 bool is_range_marker() const { return _flags & IsRangeMarker; }
97 bool is_skip() const { return _flags & IsSkip; }
98 bool matches (Flags f) const { return _flags & f; }
100 Flags flags () const { return _flags; }
102 boost::shared_ptr<SceneChange> scene_change() const { return _scene_change; }
103 void set_scene_change (boost::shared_ptr<SceneChange>);
105 /* these are static signals for objects that want to listen to all
109 static PBD::Signal1<void,Location*> name_changed;
110 static PBD::Signal1<void,Location*> end_changed;
111 static PBD::Signal1<void,Location*> start_changed;
112 static PBD::Signal1<void,Location*> flags_changed;
113 static PBD::Signal1<void,Location*> lock_changed;
114 static PBD::Signal1<void,Location*> position_lock_style_changed;
116 /* this is sent only when both start and end change at the same time */
117 static PBD::Signal1<void,Location*> changed;
119 /* these are member signals for objects that care only about
120 changes to this object
123 PBD::Signal0<void> NameChanged;
124 PBD::Signal0<void> EndChanged;
125 PBD::Signal0<void> StartChanged;
126 PBD::Signal0<void> Changed;
127 PBD::Signal0<void> FlagsChanged;
128 PBD::Signal0<void> LockChanged;
129 PBD::Signal0<void> PositionLockStyleChanged;
131 /* CD Track / CD-Text info */
133 std::map<std::string, std::string> cd_info;
134 XMLNode& cd_info_node (const std::string &, const std::string &);
136 XMLNode& get_state (void);
137 int set_state (const XMLNode&, int version);
139 PositionLockStyle position_lock_style() const { return _position_lock_style; }
140 void set_position_lock_style (PositionLockStyle ps);
141 void recompute_frames_from_bbt ();
143 static PBD::Signal0<void> scene_changed;
148 Timecode::BBT_Time _bbt_start;
150 Timecode::BBT_Time _bbt_end;
153 PositionLockStyle _position_lock_style;
154 boost::shared_ptr<SceneChange> _scene_change;
156 void set_mark (bool yn);
157 bool set_flag_internal (bool yn, Flags flag);
158 void recompute_bbt_from_frames ();
161 class LIBARDOUR_API Locations : public SessionHandleRef, public PBD::StatefulDestructible
164 typedef std::list<Location *> LocationList;
166 Locations (Session &);
169 const LocationList& list() { return locations; }
171 void add (Location *, bool make_current = false);
172 void remove (Location *);
174 void clear_markers ();
175 void clear_ranges ();
177 XMLNode& get_state (void);
178 int set_state (const XMLNode&, int version);
179 Location *get_location_by_id(PBD::ID);
181 Location* auto_loop_location () const;
182 Location* auto_punch_location () const;
183 Location* session_range_location() const;
185 int next_available_name(std::string& result,std::string base);
186 uint32_t num_range_markers() const;
188 int set_current (Location *, bool want_lock = true);
189 Location *current () const { return current_location; }
191 Location* mark_at (framepos_t, framecnt_t slop = 0) const;
193 framepos_t first_mark_before (framepos_t, bool include_special_ranges = false);
194 framepos_t first_mark_after (framepos_t, bool include_special_ranges = false);
196 void marks_either_side (framepos_t const, framepos_t &, framepos_t &) const;
198 void find_all_between (framepos_t start, framepos_t, LocationList&, Location::Flags);
201 ADDITION, ///< a location was added, but nothing else changed
202 REMOVAL, ///< a location was removed, but nothing else changed
203 OTHER ///< something more complicated happened
206 PBD::Signal1<void,Location*> current_changed;
207 /** something changed about the location list; the parameter gives some idea as to what */
208 PBD::Signal1<void,Change> changed;
209 /** a location has been added to the end of the list */
210 PBD::Signal1<void,Location*> added;
211 PBD::Signal1<void,Location*> removed;
212 PBD::Signal1<void,const PBD::PropertyChange&> StateChanged;
214 template<class T> void apply (T& obj, void (T::*method)(LocationList&)) {
215 Glib::Threads::Mutex::Lock lm (lock);
216 (obj.*method)(locations);
219 template<class T1, class T2> void apply (T1& obj, void (T1::*method)(LocationList&, T2& arg), T2& arg) {
220 Glib::Threads::Mutex::Lock lm (lock);
221 (obj.*method)(locations, arg);
226 LocationList locations;
227 Location *current_location;
228 mutable Glib::Threads::Mutex lock;
230 int set_current_unlocked (Location *);
231 void location_changed (Location*);
232 void listen_to (Location*);
235 } // namespace ARDOUR
237 #endif /* __ardour_location_h__ */