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.
23 #include <cstdio> /* for sprintf */
27 #include <sigc++/bind.h>
29 #include <pbd/stl_delete.h>
30 #include <pbd/xml++.h>
32 #include <ardour/location.h>
33 #include <ardour/session.h>
34 #include <ardour/audiofilesource.h>
39 using namespace ARDOUR;
43 Location::Location (const Location& other)
44 : _name (other._name),
45 _start (other._start),
49 /* start and end flags can never be copied, because there can only ever be one of each */
51 _flags = Flags (_flags & ~IsStart);
52 _flags = Flags (_flags & ~IsEnd);
55 Location::Location (const XMLNode& node)
57 if (set_state (node)) {
58 throw failed_constructor ();
63 Location::operator= (const Location& other)
70 _start = other._start;
72 _flags = other._flags;
74 /* "changed" not emitted on purpose */
80 Location::set_start (nframes_t s)
88 start_changed(this); /* EMIT SIGNAL */
92 Session::StartTimeChanged (); /* EMIT SIGNAL */
93 AudioFileSource::set_header_position_offset ( s );
97 Session::EndTimeChanged (); /* EMIT SIGNAL */
103 if (((is_auto_punch() || is_auto_loop()) && s >= _end) || s > _end) {
109 start_changed(this); /* EMIT SIGNAL */
116 Location::set_end (nframes_t e)
122 end_changed(this); /* EMIT SIGNAL */
127 if (((is_auto_punch() || is_auto_loop()) && e <= _start) || e < _start) {
133 end_changed(this); /* EMIT SIGNAL */
139 Location::set (nframes_t start, nframes_t end)
141 if (is_mark() && start != end) {
143 } else if (((is_auto_punch() || is_auto_loop()) && start >= end) || (start > end)) {
147 if (_start != start) {
149 start_changed(this); /* EMIT SIGNAL */
154 end_changed(this); /* EMIT SIGNAL */
160 Location::set_hidden (bool yn, void *src)
162 if (set_flag_internal (yn, IsHidden)) {
163 FlagsChanged (this, src); /* EMIT SIGNAL */
168 Location::set_cd (bool yn, void *src)
170 if (set_flag_internal (yn, IsCDMarker)) {
171 FlagsChanged (this, src); /* EMIT SIGNAL */
176 Location::set_is_end (bool yn, void *src)
178 if (set_flag_internal (yn, IsEnd)) {
179 FlagsChanged (this, src); /* EMIT SIGNAL */
184 Location::set_is_start (bool yn, void *src)
186 if (set_flag_internal (yn, IsStart)) {
187 FlagsChanged (this, src); /* EMIT SIGNAL */
192 Location::set_auto_punch (bool yn, void *src)
194 if (is_mark() || _start == _end) {
198 if (set_flag_internal (yn, IsAutoPunch)) {
199 FlagsChanged (this, src); /* EMIT SIGNAL */
204 Location::set_auto_loop (bool yn, void *src)
206 if (is_mark() || _start == _end) {
210 if (set_flag_internal (yn, IsAutoLoop)) {
211 FlagsChanged (this, src); /* EMIT SIGNAL */
216 Location::set_flag_internal (bool yn, Flags flag)
219 if (!(_flags & flag)) {
233 Location::set_mark (bool yn)
235 /* This function is private, and so does not emit signals */
237 if (_start != _end) {
241 set_flag_internal (yn, IsMark);
246 Location::cd_info_node(const string & name, const string & value)
248 XMLNode* root = new XMLNode("CD-Info");
250 root->add_property("name", name);
251 root->add_property("value", value);
258 Location::get_state (void)
260 XMLNode *node = new XMLNode ("Location");
263 typedef map<string, string>::const_iterator CI;
265 for(CI m = cd_info.begin(); m != cd_info.end(); ++m){
266 node->add_child_nocopy(cd_info_node(m->first, m->second));
270 node->add_property("id", buf);
271 node->add_property ("name", name());
272 snprintf (buf, sizeof (buf), "%u", start());
273 node->add_property ("start", buf);
274 snprintf (buf, sizeof (buf), "%u", end());
275 node->add_property ("end", buf);
276 snprintf (buf, sizeof (buf), "%" PRIu32, (uint32_t) _flags);
277 node->add_property ("flags", buf);
283 Location::set_state (const XMLNode& node)
285 const XMLProperty *prop;
287 XMLNodeList cd_list = node.children();
288 XMLNodeConstIterator cd_iter;
294 if (node.name() != "Location") {
295 error << _("incorrect XML node passed to Location::set_state") << endmsg;
299 if ((prop = node.property ("id")) == 0) {
300 warning << _("XML node for Location has no ID information") << endmsg;
302 _id = prop->value ();
305 if ((prop = node.property ("name")) == 0) {
306 error << _("XML node for Location has no name information") << endmsg;
310 set_name (prop->value());
312 if ((prop = node.property ("start")) == 0) {
313 error << _("XML node for Location has no start information") << endmsg;
317 /* can't use set_start() here, because _end
318 may make the value of _start illegal.
321 _start = atoi (prop->value().c_str());
323 if ((prop = node.property ("end")) == 0) {
324 error << _("XML node for Location has no end information") << endmsg;
328 _end = atoi (prop->value().c_str());
332 if ((prop = node.property ("flags")) == 0) {
333 error << _("XML node for Location has no flags information") << endmsg;
337 _flags = Flags (atoi (prop->value().c_str()));
339 for (cd_iter = cd_list.begin(); cd_iter != cd_list.end(); ++cd_iter) {
343 if (cd_node->name() != "CD-Info") {
347 if ((prop = cd_node->property ("name")) != 0) {
348 cd_name = prop->value();
350 throw failed_constructor ();
353 if ((prop = cd_node->property ("value")) != 0) {
354 cd_value = prop->value();
356 throw failed_constructor ();
360 cd_info[cd_name] = cd_value;
364 changed(this); /* EMIT SIGNAL */
369 /*---------------------------------------------------------------------- */
371 Locations::Locations ()
374 current_location = 0;
375 save_state (_("initial"));
378 Locations::~Locations ()
380 std::set<Location*> all_locations;
382 for (StateMap::iterator siter = states.begin(); siter != states.end(); ++siter) {
384 State* lstate = dynamic_cast<State*> (*siter);
386 for (LocationList::iterator liter = lstate->locations.begin(); liter != lstate->locations.end(); ++liter) {
387 all_locations.insert (*liter);
390 for (LocationList::iterator siter = lstate->states.begin(); siter != lstate->states.end(); ++siter) {
391 all_locations.insert (*siter);
395 set_delete (&all_locations);
399 Locations::set_current (Location *loc, bool want_lock)
405 Glib::Mutex::Lock lm (lock);
406 ret = set_current_unlocked (loc);
408 ret = set_current_unlocked (loc);
412 current_changed (current_location); /* EMIT SIGNAL */
418 Locations::set_current_unlocked (Location *loc)
420 if (find (locations.begin(), locations.end(), loc) == locations.end()) {
421 error << _("Locations: attempt to use unknown location as selected location") << endmsg;
425 current_location = loc;
433 Glib::Mutex::Lock lm (lock);
434 LocationList::iterator tmp;
435 for (LocationList::iterator i = locations.begin(); i != locations.end(); ) {
438 if (!(*i)->is_end() && !(*i)->is_start()) {
445 current_location = 0;
448 save_state (_("clear"));
450 changed (); /* EMIT SIGNAL */
451 current_changed (0); /* EMIT SIGNAL */
455 Locations::clear_markers ()
458 Glib::Mutex::Lock lm (lock);
459 LocationList::iterator tmp;
461 for (LocationList::iterator i = locations.begin(); i != locations.end(); ) {
465 if ((*i)->is_mark() && !(*i)->is_end() && !(*i)->is_start()) {
473 save_state (_("clear markers"));
475 changed (); /* EMIT SIGNAL */
479 Locations::clear_ranges ()
482 Glib::Mutex::Lock lm (lock);
483 LocationList::iterator tmp;
485 for (LocationList::iterator i = locations.begin(); i != locations.end(); ) {
490 if (!(*i)->is_mark()) {
498 current_location = 0;
501 save_state (_("clear ranges"));
503 changed (); /* EMIT SIGNAL */
504 current_changed (0); /* EMIT SIGNAL */
508 Locations::add (Location *loc, bool make_current)
511 Glib::Mutex::Lock lm (lock);
512 locations.push_back (loc);
515 current_location = loc;
519 save_state (_("add"));
521 added (loc); /* EMIT SIGNAL */
524 current_changed (current_location); /* EMIT SIGNAL */
529 Locations::remove (Location *loc)
532 bool was_removed = false;
533 bool was_current = false;
534 LocationList::iterator i;
536 if (loc->is_end() || loc->is_start()) {
541 Glib::Mutex::Lock lm (lock);
543 for (i = locations.begin(); i != locations.end(); ++i) {
547 if (current_location == loc) {
548 current_location = 0;
557 save_state (_("remove"));
559 removed (loc); /* EMIT SIGNAL */
562 current_changed (0); /* EMIT SIGNAL */
565 changed (); /* EMIT_SIGNAL */
570 Locations::location_changed (Location* loc)
572 save_state (X_("location changed"));
573 changed (); /* EMIT SIGNAL */
577 Locations::get_state ()
579 XMLNode *node = new XMLNode ("Locations");
580 LocationList::iterator iter;
581 Glib::Mutex::Lock lm (lock);
583 for (iter = locations.begin(); iter != locations.end(); ++iter) {
584 node->add_child_nocopy ((*iter)->get_state ());
591 Locations::set_state (const XMLNode& node)
594 XMLNodeConstIterator niter;
596 if (node.name() != "Locations") {
597 error << _("incorrect XML mode passed to Locations::set_state") << endmsg;
601 nlist = node.children();
604 Glib::Mutex::Lock lm (lock);
606 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
610 Location *loc = new Location (**niter);
611 locations.push_back (loc);
614 catch (failed_constructor& err) {
615 error << _("could not load location from session file - ignored") << endmsg;
619 if (locations.size()) {
621 current_location = locations.front();
623 current_location = 0;
627 changed (); /* EMIT SIGNAL */
632 struct LocationStartEarlierComparison
634 bool operator() (Location *a, Location *b) {
635 return a->start() < b->start();
639 struct LocationStartLaterComparison
641 bool operator() (Location *a, Location *b) {
642 return a->start() > b->start();
647 Locations::first_location_before (nframes_t frame)
652 Glib::Mutex::Lock lm (lock);
656 LocationStartLaterComparison cmp;
659 /* locs is now sorted latest..earliest */
661 for (LocationList::iterator i = locs.begin(); i != locs.end(); ++i) {
662 if (!(*i)->is_hidden() && (*i)->start() < frame) {
671 Locations::first_location_after (nframes_t frame)
676 Glib::Mutex::Lock lm (lock);
680 LocationStartEarlierComparison cmp;
683 /* locs is now sorted earliest..latest */
685 for (LocationList::iterator i = locs.begin(); i != locs.end(); ++i) {
686 if (!(*i)->is_hidden() && (*i)->start() > frame) {
695 Locations::first_mark_before (nframes_t frame)
700 Glib::Mutex::Lock lm (lock);
704 LocationStartLaterComparison cmp;
707 /* locs is now sorted latest..earliest */
709 for (LocationList::iterator i = locs.begin(); i != locs.end(); ++i) {
710 if (!(*i)->is_hidden()) {
711 if ((*i)->is_mark()) {
712 /* MARK: start == end */
713 if ((*i)->start() < frame) {
714 return (*i)->start();
717 /* RANGE: start != end, compare start and end */
718 if ((*i)->end() < frame) {
721 if ((*i)->start () < frame) {
722 return (*i)->start();
732 Locations::first_mark_after (nframes_t frame)
737 Glib::Mutex::Lock lm (lock);
741 LocationStartEarlierComparison cmp;
744 /* locs is now sorted earliest..latest */
746 for (LocationList::iterator i = locs.begin(); i != locs.end(); ++i) {
747 if (!(*i)->is_hidden()) {
748 if ((*i)->is_mark()) {
749 /* MARK, start == end so just compare start */
750 if ((*i)->start() > frame) {
751 return (*i)->start();
754 /* RANGE, start != end, compare start and end */
755 if ((*i)->start() > frame ) {
756 return (*i)->start ();
758 if ((*i)->end() > frame) {
769 Locations::end_location () const
771 for (LocationList::const_iterator i = locations.begin(); i != locations.end(); ++i) {
772 if ((*i)->is_end()) {
773 return const_cast<Location*> (*i);
780 Locations::start_location () const
782 for (LocationList::const_iterator i = locations.begin(); i != locations.end(); ++i) {
783 if ((*i)->is_start()) {
784 return const_cast<Location*> (*i);
791 Locations::auto_loop_location () const
793 for (LocationList::const_iterator i = locations.begin(); i != locations.end(); ++i) {
794 if ((*i)->is_auto_loop()) {
795 return const_cast<Location*> (*i);
802 Locations::auto_punch_location () const
804 for (LocationList::const_iterator i = locations.begin(); i != locations.end(); ++i) {
805 if ((*i)->is_auto_punch()) {
806 return const_cast<Location*> (*i);
813 Locations::state_factory (std::string why) const
815 State* state = new State (why);
817 state->locations = locations;
819 for (LocationList::const_iterator i = locations.begin(); i != locations.end(); ++i) {
820 state->states.push_back (new Location (**i));
827 Locations::restore_state (StateManager::State& state)
830 Glib::Mutex::Lock lm (lock);
831 State* lstate = dynamic_cast<State*> (&state);
833 locations = lstate->locations;
834 LocationList& states = lstate->states;
835 LocationList::iterator l, s;
837 for (l = locations.begin(), s = states.begin(); s != states.end(); ++s, ++l) {
846 Locations::get_memento () const
848 return sigc::bind (mem_fun (*(const_cast<Locations*> (this)), &StateManager::use_state), _current_state_id);
852 Locations::num_range_markers () const
855 Glib::Mutex::Lock lm (lock);
856 for (LocationList::const_iterator i = locations.begin(); i != locations.end(); ++i) {
857 if ((*i)->is_range_marker()) {
865 Locations::get_location_by_id(PBD::ID id)
867 LocationList::iterator it;
868 for (it = locations.begin(); it != locations.end(); it++)
869 if (id == (*it)->id())