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/thread.h>
33 #include "pbd/stateful.h"
34 #include "pbd/statefuldestructible.h"
36 #include "ardour/ardour.h"
37 #include "ardour/session_handle.h"
41 class Location : public SessionHandleRef, public PBD::StatefulDestructible
55 Location (Session &, nframes64_t, nframes64_t, const std::string &, Flags bits = Flags(0));
56 Location (const Location& other);
57 Location (Session &, const XMLNode&);
58 Location* operator= (const Location& other);
60 bool locked() const { return _locked; }
61 void lock() { _locked = true; changed (this); }
62 void unlock() { _locked = false; changed (this); }
64 nframes64_t start() const { return _start; }
65 nframes64_t end() const { return _end; }
66 nframes64_t length() const { return _end - _start; }
68 int set_start (nframes64_t s, bool force = false, bool allow_bbt_recompute = true);
69 int set_end (nframes64_t e, bool force = false, bool allow_bbt_recompute = true);
70 int set (nframes64_t start, nframes64_t end, bool allow_bbt_recompute = true);
72 int move_to (nframes64_t pos);
74 const std::string& name() const { return _name; }
75 void set_name (const std::string &str) { _name = str; name_changed(this); }
77 void set_auto_punch (bool yn, void *src);
78 void set_auto_loop (bool yn, void *src);
79 void set_hidden (bool yn, void *src);
80 void set_cd (bool yn, void *src);
81 void set_is_range_marker (bool yn, void* src);
83 bool is_auto_punch () const { return _flags & IsAutoPunch; }
84 bool is_auto_loop () const { return _flags & IsAutoLoop; }
85 bool is_mark () const { return _flags & IsMark; }
86 bool is_hidden () const { return _flags & IsHidden; }
87 bool is_cd_marker () const { return _flags & IsCDMarker; }
88 bool is_session_range () const { return _flags & IsSessionRange; }
89 bool is_range_marker() const { return _flags & IsRangeMarker; }
90 bool matches (Flags f) const { return _flags & f; }
92 Flags flags () const { return _flags; }
94 PBD::Signal1<void,Location*> name_changed;
95 PBD::Signal1<void,Location*> end_changed;
96 PBD::Signal1<void,Location*> start_changed;
98 PBD::Signal2<void,Location*,void*> FlagsChanged;
100 /* this is sent only when both start&end change at the same time */
102 PBD::Signal1<void,Location*> changed;
104 /* CD Track / CD-Text info */
106 std::map<std::string, std::string> cd_info;
107 XMLNode& cd_info_node (const std::string &, const std::string &);
109 XMLNode& get_state (void);
110 int set_state (const XMLNode&, int version);
112 PositionLockStyle position_lock_style() const { return _position_lock_style; }
113 void set_position_lock_style (PositionLockStyle ps);
114 void recompute_frames_from_bbt ();
124 PositionLockStyle _position_lock_style;
126 void set_mark (bool yn);
127 bool set_flag_internal (bool yn, Flags flag);
128 void recompute_bbt_from_frames ();
131 class Locations : public SessionHandleRef, public PBD::StatefulDestructible
134 typedef std::list<Location *> LocationList;
136 Locations (Session &);
139 const LocationList& list() { return locations; }
141 void add (Location *, bool make_current = false);
142 void remove (Location *);
144 void clear_markers ();
145 void clear_ranges ();
147 XMLNode& get_state (void);
148 int set_state (const XMLNode&, int version);
149 Location *get_location_by_id(PBD::ID);
151 Location* auto_loop_location () const;
152 Location* auto_punch_location () const;
153 Location* session_range_location() const;
155 int next_available_name(std::string& result,std::string base);
156 uint32_t num_range_markers() const;
158 int set_current (Location *, bool want_lock = true);
159 Location *current () const { return current_location; }
161 Location* first_location_before (nframes64_t, bool include_special_ranges = false);
162 Location* first_location_after (nframes64_t, bool include_special_ranges = false);
164 void marks_either_side (nframes64_t const, nframes64_t &, nframes64_t &) const;
166 void find_all_between (nframes64_t start, nframes64_t, LocationList&, Location::Flags);
169 ADDITION, ///< a location was added, but nothing else changed
170 REMOVAL, ///< a location was removed, but nothing else changed
171 OTHER ///< something more complicated happened
174 PBD::Signal1<void,Location*> current_changed;
175 /** something changed about the location list; the parameter gives some idea as to what */
176 PBD::Signal1<void,Change> changed;
177 /** a location has been added to the end of the list */
178 PBD::Signal1<void,Location*> added;
179 PBD::Signal1<void,Location*> removed;
180 PBD::Signal1<void,const PBD::PropertyChange&> StateChanged;
182 template<class T> void apply (T& obj, void (T::*method)(LocationList&)) {
183 Glib::Mutex::Lock lm (lock);
184 (obj.*method)(locations);
187 template<class T1, class T2> void apply (T1& obj, void (T1::*method)(LocationList&, T2& arg), T2& arg) {
188 Glib::Mutex::Lock lm (lock);
189 (obj.*method)(locations, arg);
194 LocationList locations;
195 Location *current_location;
196 mutable Glib::Mutex lock;
198 int set_current_unlocked (Location *);
199 void location_changed (Location*);
202 } // namespace ARDOUR
204 #endif /* __ardour_location_h__ */