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.
21 #ifndef __ardour_location_h__
22 #define __ardour_location_h__
29 #include <sys/types.h>
30 #include <sigc++/signal.h>
32 #include <glibmm/thread.h>
35 #include <pbd/stateful.h>
36 #include <pbd/statefuldestructible.h>
38 #include <ardour/ardour.h>
39 #include <ardour/state_manager.h>
45 class Location : public PBD::StatefulDestructible
59 Location (nframes_t sample_start,
62 Flags bits = Flags(0))
65 _start (sample_start),
75 Location (const Location& other);
76 Location (const XMLNode&);
77 Location* operator= (const Location& other);
79 nframes_t start() { return _start; }
80 nframes_t end() { return _end; }
81 nframes_t length() { return _end - _start; }
83 int set_start (nframes_t s);
84 int set_end (nframes_t e);
85 int set (nframes_t start, nframes_t end);
87 const string& name() { return _name; }
88 void set_name (const string &str) { _name = str; name_changed(this); }
90 void set_auto_punch (bool yn, void *src);
91 void set_auto_loop (bool yn, void *src);
92 void set_hidden (bool yn, void *src);
93 void set_cd (bool yn, void *src);
94 void set_is_end (bool yn, void* src);
95 void set_is_start (bool yn, void* src);
97 bool is_auto_punch () { return _flags & IsAutoPunch; }
98 bool is_auto_loop () { return _flags & IsAutoLoop; }
99 bool is_mark () { return _flags & IsMark; }
100 bool is_hidden () { return _flags & IsHidden; }
101 bool is_cd_marker () { return _flags & IsCDMarker; }
102 bool is_end() { return _flags & IsEnd; }
103 bool is_start() { return _flags & IsStart; }
104 bool is_range_marker() { return _flags & IsRangeMarker; }
106 sigc::signal<void,Location*> name_changed;
107 sigc::signal<void,Location*> end_changed;
108 sigc::signal<void,Location*> start_changed;
110 sigc::signal<void,Location*,void*> FlagsChanged;
112 /* this is sent only when both start&end change at the same time */
114 sigc::signal<void,Location*> changed;
116 /* CD Track / CD-Text info */
118 std::map<string, string> cd_info;
119 XMLNode& cd_info_node (const string &, const string &);
121 XMLNode& get_state (void);
122 int set_state (const XMLNode&);
130 void set_mark (bool yn);
131 bool set_flag_internal (bool yn, Flags flag);
134 class Locations : public StateManager, public PBD::StatefulDestructible
137 typedef std::list<Location *> LocationList;
142 void add (Location *, bool make_current = false);
143 void remove (Location *);
145 void clear_markers ();
146 void clear_ranges ();
148 XMLNode& get_state (void);
149 int set_state (const XMLNode&);
150 Location *get_location_by_id(PBD::ID);
152 Location* auto_loop_location () const;
153 Location* auto_punch_location () const;
154 Location* end_location() const;
155 Location* start_location() const;
157 uint32_t num_range_markers() const;
159 int set_current (Location *, bool want_lock = true);
160 Location *current () const { return current_location; }
162 Location *first_location_before (nframes_t);
163 Location *first_location_after (nframes_t);
165 nframes_t first_mark_before (nframes_t);
166 nframes_t first_mark_after (nframes_t);
168 sigc::signal<void,Location*> current_changed;
169 sigc::signal<void> changed;
170 sigc::signal<void,Location*> added;
171 sigc::signal<void,Location*> removed;
173 template<class T> void apply (T& obj, void (T::*method)(LocationList&)) {
174 Glib::Mutex::Lock lm (lock);
175 (obj.*method)(locations);
178 template<class T1, class T2> void apply (T1& obj, void (T1::*method)(LocationList&, T2& arg), T2& arg) {
179 Glib::Mutex::Lock lm (lock);
180 (obj.*method)(locations, arg);
183 UndoAction get_memento () const;
187 struct State : public ARDOUR::StateManager::State {
188 LocationList locations;
191 State (std::string why) : ARDOUR::StateManager::State (why) {}
194 LocationList locations;
195 Location *current_location;
196 mutable Glib::Mutex lock;
198 int set_current_unlocked (Location *);
199 void location_changed (Location*);
201 Change restore_state (StateManager::State&);
202 StateManager::State* state_factory (std::string why) const;
205 } // namespace ARDOUR
207 #endif /* __ardour_location_h__ */