13
0
livetrax/libs/ardour/location.cc
Carl Hetherington 1f8d176c13 Add lots of asserts to try to track down #3553.
git-svn-id: svn://localhost/ardour2/branches/3.0@8096 d708f5d6-7413-0410-9779-e7cbd77b26cf
2010-11-26 22:45:20 +00:00

1083 lines
21 KiB
C++

/*
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
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#include <algorithm>
#include <set>
#include <cstdio> /* for sprintf */
#include <unistd.h>
#include <cerrno>
#include <ctime>
#include <list>
#include "pbd/stl_delete.h"
#include "pbd/xml++.h"
#include "pbd/enumwriter.h"
#include "ardour/location.h"
#include "ardour/session.h"
#include "ardour/audiofilesource.h"
#include "ardour/tempo.h"
#include "i18n.h"
#define SUFFIX_MAX 32
using namespace std;
using namespace ARDOUR;
using namespace PBD;
Location::Location (Session& s)
: SessionHandleRef (s)
, _start (0)
, _end (0)
, _flags (Flags (0))
, _locked (false)
, _position_lock_style (AudioTime)
{
assert (_start >= 0);
assert (_end >= 0);
}
Location::Location (Session& s, framepos_t sample_start, framepos_t sample_end, const std::string &name, Flags bits)
: SessionHandleRef (s)
, _name (name)
, _start (sample_start)
, _end (sample_end)
, _flags (bits)
, _locked (false)
, _position_lock_style (AudioTime)
{
recompute_bbt_from_frames ();
assert (_start >= 0);
assert (_end >= 0);
}
Location::Location (const Location& other)
: SessionHandleRef (other._session)
, StatefulDestructible()
, _name (other._name)
, _start (other._start)
, _bbt_start (other._bbt_start)
, _end (other._end)
, _bbt_end (other._bbt_end)
, _flags (other._flags)
, _position_lock_style (other._position_lock_style)
{
/* copy is not locked even if original was */
_locked = false;
assert (_start >= 0);
assert (_end >= 0);
}
Location::Location (Session& s, const XMLNode& node)
: SessionHandleRef (s)
, _position_lock_style (AudioTime)
{
/* Note: _position_lock_style is initialised above in case set_state doesn't set it
(for 2.X session file compatibility).
*/
if (set_state (node, Stateful::loading_state_version)) {
throw failed_constructor ();
}
assert (_start >= 0);
assert (_end >= 0);
}
Location*
Location::operator= (const Location& other)
{
if (this == &other) {
return this;
}
_name = other._name;
_start = other._start;
_bbt_start = other._bbt_start;
_end = other._end;
_bbt_end = other._bbt_end;
_flags = other._flags;
_position_lock_style = other._position_lock_style;
/* copy is not locked even if original was */
_locked = false;
/* "changed" not emitted on purpose */
assert (_start >= 0);
assert (_end >= 0);
return this;
}
/** Set start position.
* @param s New start.
* @param force true to force setting, even if the given new start is after the current end.
* @param allow_bbt_recompute True to recompute BBT start time from the new given start time.
*/
int
Location::set_start (framepos_t s, bool force, bool allow_bbt_recompute)
{
if (_locked) {
return -1;
}
if (!force) {
if (((is_auto_punch() || is_auto_loop()) && s >= _end) || (!is_mark() && s > _end)) {
return -1;
}
}
if (is_mark()) {
if (_start != s) {
_start = s;
_end = s;
if (allow_bbt_recompute) {
recompute_bbt_from_frames ();
}
start_changed (this); /* EMIT SIGNAL */
end_changed (this); /* EMIT SIGNAL */
}
assert (_start >= 0);
assert (_end >= 0);
return 0;
}
if (s != _start) {
framepos_t const old = _start;
_start = s;
if (allow_bbt_recompute) {
recompute_bbt_from_frames ();
}
start_changed (this); /* EMIT SIGNAL */
if (is_session_range ()) {
Session::StartTimeChanged (old); /* EMIT SIGNAL */
AudioFileSource::set_header_position_offset (s);
}
}
assert (_start >= 0);
return 0;
}
/** Set end position.
* @param s New end.
* @param force true to force setting, even if the given new start is after the current end.
* @param allow_bbt_recompute True to recompute BBT end time from the new given end time.
*/
int
Location::set_end (framepos_t e, bool force, bool allow_bbt_recompute)
{
if (_locked) {
return -1;
}
if (!force) {
if (((is_auto_punch() || is_auto_loop()) && e <= _start) || e < _start) {
return -1;
}
}
if (is_mark()) {
if (_start != e) {
_start = e;
_end = e;
if (allow_bbt_recompute) {
recompute_bbt_from_frames ();
}
start_changed (this); /* EMIT SIGNAL */
end_changed (this); /* EMIT SIGNAL */
}
assert (_start >= 0);
assert (_end >= 0);
return 0;
}
if (e != _end) {
framepos_t const old = _end;
_end = e;
if (allow_bbt_recompute) {
recompute_bbt_from_frames ();
}
end_changed(this); /* EMIT SIGNAL */
if (is_session_range()) {
Session::EndTimeChanged (old); /* EMIT SIGNAL */
}
}
assert (_end >= 0);
return 0;
}
int
Location::set (framepos_t start, framepos_t end, bool allow_bbt_recompute)
{
/* check validity */
if (((is_auto_punch() || is_auto_loop()) && start >= end) || (!is_mark() && start > end)) {
return -1;
}
/* now we know these values are ok, so force-set them */
int const s = set_start (start, true, allow_bbt_recompute);
int const e = set_end (end, true, allow_bbt_recompute);
return (s == 0 && e == 0) ? 0 : -1;
}
int
Location::move_to (framepos_t pos)
{
if (_locked) {
return -1;
}
if (_start != pos) {
_start = pos;
_end = _start + length();
recompute_bbt_from_frames ();
changed (this); /* EMIT SIGNAL */
}
assert (_start >= 0);
assert (_end >= 0);
return 0;
}
void
Location::set_hidden (bool yn, void *src)
{
if (set_flag_internal (yn, IsHidden)) {
FlagsChanged (this, src); /* EMIT SIGNAL */
}
}
void
Location::set_cd (bool yn, void *src)
{
// XXX this really needs to be session start
// but its not available here - leave to GUI
if (_start == 0) {
error << _("You cannot put a CD marker at this position") << endmsg;
return;
}
if (set_flag_internal (yn, IsCDMarker)) {
FlagsChanged (this, src); /* EMIT SIGNAL */
}
}
void
Location::set_is_range_marker (bool yn, void *src)
{
if (set_flag_internal (yn, IsRangeMarker)) {
FlagsChanged (this, src); /* EMIT SIGNAL */
}
}
void
Location::set_auto_punch (bool yn, void *src)
{
if (is_mark() || _start == _end) {
return;
}
if (set_flag_internal (yn, IsAutoPunch)) {
FlagsChanged (this, src); /* EMIT SIGNAL */
}
}
void
Location::set_auto_loop (bool yn, void *src)
{
if (is_mark() || _start == _end) {
return;
}
if (set_flag_internal (yn, IsAutoLoop)) {
FlagsChanged (this, src); /* EMIT SIGNAL */
}
}
bool
Location::set_flag_internal (bool yn, Flags flag)
{
if (yn) {
if (!(_flags & flag)) {
_flags = Flags (_flags | flag);
return true;
}
} else {
if (_flags & flag) {
_flags = Flags (_flags & ~flag);
return true;
}
}
return false;
}
void
Location::set_mark (bool yn)
{
/* This function is private, and so does not emit signals */
if (_start != _end) {
return;
}
set_flag_internal (yn, IsMark);
}
XMLNode&
Location::cd_info_node(const string & name, const string & value)
{
XMLNode* root = new XMLNode("CD-Info");
root->add_property("name", name);
root->add_property("value", value);
return *root;
}
XMLNode&
Location::get_state ()
{
XMLNode *node = new XMLNode ("Location");
char buf[64];
typedef map<string, string>::const_iterator CI;
for(CI m = cd_info.begin(); m != cd_info.end(); ++m){
node->add_child_nocopy(cd_info_node(m->first, m->second));
}
id().print (buf, sizeof (buf));
node->add_property("id", buf);
node->add_property ("name", name());
snprintf (buf, sizeof (buf), "%" PRId64, start());
node->add_property ("start", buf);
snprintf (buf, sizeof (buf), "%" PRId64, end());
node->add_property ("end", buf);
node->add_property ("flags", enum_2_string (_flags));
node->add_property ("locked", (_locked ? "yes" : "no"));
node->add_property ("position-lock-style", enum_2_string (_position_lock_style));
return *node;
}
int
Location::set_state (const XMLNode& node, int /*version*/)
{
const XMLProperty *prop;
XMLNodeList cd_list = node.children();
XMLNodeConstIterator cd_iter;
XMLNode *cd_node;
string cd_name;
string cd_value;
if (node.name() != "Location") {
error << _("incorrect XML node passed to Location::set_state") << endmsg;
return -1;
}
if ((prop = node.property ("id")) == 0) {
warning << _("XML node for Location has no ID information") << endmsg;
} else {
_id = prop->value ();
}
if ((prop = node.property ("name")) == 0) {
error << _("XML node for Location has no name information") << endmsg;
return -1;
}
set_name (prop->value());
if ((prop = node.property ("start")) == 0) {
error << _("XML node for Location has no start information") << endmsg;
return -1;
}
/* can't use set_start() here, because _end
may make the value of _start illegal.
*/
sscanf (prop->value().c_str(), "%" PRId64, &_start);
if ((prop = node.property ("end")) == 0) {
error << _("XML node for Location has no end information") << endmsg;
return -1;
}
sscanf (prop->value().c_str(), "%" PRId64, &_end);
if ((prop = node.property ("flags")) == 0) {
error << _("XML node for Location has no flags information") << endmsg;
return -1;
}
_flags = Flags (string_2_enum (prop->value(), _flags));
if ((prop = node.property ("locked")) != 0) {
_locked = string_is_affirmative (prop->value());
} else {
_locked = false;
}
for (cd_iter = cd_list.begin(); cd_iter != cd_list.end(); ++cd_iter) {
cd_node = *cd_iter;
if (cd_node->name() != "CD-Info") {
continue;
}
if ((prop = cd_node->property ("name")) != 0) {
cd_name = prop->value();
} else {
throw failed_constructor ();
}
if ((prop = cd_node->property ("value")) != 0) {
cd_value = prop->value();
} else {
throw failed_constructor ();
}
cd_info[cd_name] = cd_value;
}
if ((prop = node.property ("position-lock-style")) != 0) {
_position_lock_style = PositionLockStyle (string_2_enum (prop->value(), _position_lock_style));
}
recompute_bbt_from_frames ();
changed (this); /* EMIT SIGNAL */
assert (_start >= 0);
assert (_end >= 0);
return 0;
}
void
Location::set_position_lock_style (PositionLockStyle ps)
{
if (_position_lock_style == ps) {
return;
}
_position_lock_style = ps;
recompute_bbt_from_frames ();
PositionLockStyleChanged (this); /* EMIT SIGNAL */
}
void
Location::recompute_bbt_from_frames ()
{
if (_position_lock_style != MusicTime) {
return;
}
_session.tempo_map().bbt_time (_start, _bbt_start);
_session.tempo_map().bbt_time (_end, _bbt_end);
}
void
Location::recompute_frames_from_bbt ()
{
if (_position_lock_style != MusicTime) {
return;
}
TempoMap& map (_session.tempo_map());
set (map.frame_time (_bbt_start), map.frame_time (_bbt_end), false);
}
void
Location::lock ()
{
_locked = true;
LockChanged (this);
}
void
Location::unlock ()
{
_locked = false;
LockChanged (this);
}
/*---------------------------------------------------------------------- */
Locations::Locations (Session& s)
: SessionHandleRef (s)
{
current_location = 0;
}
Locations::~Locations ()
{
for (LocationList::iterator i = locations.begin(); i != locations.end(); ) {
LocationList::iterator tmp = i;
++tmp;
delete *i;
i = tmp;
}
}
int
Locations::set_current (Location *loc, bool want_lock)
{
int ret;
if (want_lock) {
Glib::Mutex::Lock lm (lock);
ret = set_current_unlocked (loc);
} else {
ret = set_current_unlocked (loc);
}
if (ret == 0) {
current_changed (current_location); /* EMIT SIGNAL */
}
return ret;
}
int
Locations::next_available_name(string& result,string base)
{
LocationList::iterator i;
Location* location;
string temp;
string::size_type l;
int suffix;
char buf[32];
bool available[SUFFIX_MAX+1];
result = base;
for (int k=1; k<SUFFIX_MAX; k++) {
available[k] = true;
}
l = base.length();
for (i = locations.begin(); i != locations.end(); ++i) {
location =* i;
temp = location->name();
if (l && !temp.find(base,0)) {
suffix = atoi(temp.substr(l,3).c_str());
if (suffix) available[suffix] = false;
}
}
for (int k=1; k<=SUFFIX_MAX; k++) {
if (available[k]) {
snprintf (buf, 31, "%d", k);
result += buf;
return 1;
}
}
return 0;
}
int
Locations::set_current_unlocked (Location *loc)
{
if (find (locations.begin(), locations.end(), loc) == locations.end()) {
error << _("Locations: attempt to use unknown location as selected location") << endmsg;
return -1;
}
current_location = loc;
return 0;
}
void
Locations::clear ()
{
{
Glib::Mutex::Lock lm (lock);
for (LocationList::iterator i = locations.begin(); i != locations.end(); ) {
LocationList::iterator tmp = i;
++tmp;
if (!(*i)->is_session_range()) {
locations.erase (i);
}
i = tmp;
}
current_location = 0;
}
changed (OTHER); /* EMIT SIGNAL */
current_changed (0); /* EMIT SIGNAL */
}
void
Locations::clear_markers ()
{
{
Glib::Mutex::Lock lm (lock);
LocationList::iterator tmp;
for (LocationList::iterator i = locations.begin(); i != locations.end(); ) {
tmp = i;
++tmp;
if ((*i)->is_mark() && !(*i)->is_session_range()) {
locations.erase (i);
}
i = tmp;
}
}
changed (OTHER); /* EMIT SIGNAL */
}
void
Locations::clear_ranges ()
{
{
Glib::Mutex::Lock lm (lock);
LocationList::iterator tmp;
for (LocationList::iterator i = locations.begin(); i != locations.end(); ) {
tmp = i;
++tmp;
if (!(*i)->is_mark()) {
locations.erase (i);
}
i = tmp;
}
current_location = 0;
}
changed (OTHER); /* EMIT SIGNAL */
current_changed (0); /* EMIT SIGNAL */
}
void
Locations::add (Location *loc, bool make_current)
{
assert (loc);
{
Glib::Mutex::Lock lm (lock);
locations.push_back (loc);
if (make_current) {
current_location = loc;
}
}
added (loc); /* EMIT SIGNAL */
if (make_current) {
current_changed (current_location); /* EMIT SIGNAL */
}
if (loc->is_session_range()) {
Session::StartTimeChanged (0);
Session::EndTimeChanged (1);
}
}
void
Locations::remove (Location *loc)
{
bool was_removed = false;
bool was_current = false;
LocationList::iterator i;
if (loc->is_session_range()) {
return;
}
{
Glib::Mutex::Lock lm (lock);
for (i = locations.begin(); i != locations.end(); ++i) {
if ((*i) == loc) {
locations.erase (i);
was_removed = true;
if (current_location == loc) {
current_location = 0;
was_current = true;
}
break;
}
}
}
if (was_removed) {
removed (loc); /* EMIT SIGNAL */
if (was_current) {
current_changed (0); /* EMIT SIGNAL */
}
changed (REMOVAL); /* EMIT_SIGNAL */
}
}
void
Locations::location_changed (Location* /*loc*/)
{
changed (OTHER); /* EMIT SIGNAL */
}
XMLNode&
Locations::get_state ()
{
XMLNode *node = new XMLNode ("Locations");
LocationList::iterator iter;
Glib::Mutex::Lock lm (lock);
for (iter = locations.begin(); iter != locations.end(); ++iter) {
node->add_child_nocopy ((*iter)->get_state ());
}
return *node;
}
int
Locations::set_state (const XMLNode& node, int version)
{
if (node.name() != "Locations") {
error << _("incorrect XML mode passed to Locations::set_state") << endmsg;
return -1;
}
XMLNodeList nlist = node.children();
locations.clear ();
current_location = 0;
Location* session_range_location = 0;
if (version < 3000) {
session_range_location = new Location (_session, 0, 0, _("session"), Location::IsSessionRange);
locations.push_back (session_range_location);
}
{
Glib::Mutex::Lock lm (lock);
XMLNodeConstIterator niter;
for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
try {
Location *loc = new Location (_session, **niter);
bool add = true;
if (version < 3000) {
/* look for old-style IsStart / IsEnd properties in this location;
if they are present, update the session_range_location accordingly
*/
XMLProperty const * prop = (*niter)->property ("flags");
if (prop) {
string v = prop->value ();
while (1) {
string::size_type const c = v.find_first_of (',');
string const s = v.substr (0, c);
if (s == X_("IsStart")) {
session_range_location->set_start (loc->start(), true);
add = false;
} else if (s == X_("IsEnd")) {
session_range_location->set_end (loc->start(), true);
add = false;
}
if (c == string::npos) {
break;
}
v = v.substr (c + 1);
}
}
}
if (add) {
locations.push_back (loc);
}
}
catch (failed_constructor& err) {
error << _("could not load location from session file - ignored") << endmsg;
}
}
if (locations.size()) {
current_location = locations.front();
} else {
current_location = 0;
}
}
changed (OTHER); /* EMIT SIGNAL */
return 0;
}
struct LocationStartEarlierComparison
{
bool operator() (Location *a, Location *b) {
return a->start() < b->start();
}
};
struct LocationStartLaterComparison
{
bool operator() (Location *a, Location *b) {
return a->start() > b->start();
}
};
Location *
Locations::first_location_before (framepos_t frame, bool include_special_ranges)
{
LocationList locs;
{
Glib::Mutex::Lock lm (lock);
locs = locations;
}
LocationStartLaterComparison cmp;
locs.sort (cmp);
/* locs is now sorted latest..earliest */
for (LocationList::iterator i = locs.begin(); i != locs.end(); ++i) {
if (!include_special_ranges && ((*i)->is_auto_loop() || (*i)->is_auto_punch())) {
continue;
}
if (!(*i)->is_hidden() && (*i)->start() < frame) {
return (*i);
}
}
return 0;
}
Location *
Locations::first_location_after (framepos_t frame, bool include_special_ranges)
{
LocationList locs;
{
Glib::Mutex::Lock lm (lock);
locs = locations;
}
LocationStartEarlierComparison cmp;
locs.sort (cmp);
/* locs is now sorted earliest..latest */
for (LocationList::iterator i = locs.begin(); i != locs.end(); ++i) {
if (!include_special_ranges && ((*i)->is_auto_loop() || (*i)->is_auto_punch())) {
continue;
}
if (!(*i)->is_hidden() && (*i)->start() > frame) {
return (*i);
}
}
return 0;
}
/** Look for the `marks' (either locations which are marks, or start/end points of range markers) either
* side of a frame. Note that if frame is exactly on a `mark', that mark will not be considered for returning
* as before/after.
* @param frame Frame to look for.
* @param before Filled in with the position of the last `mark' before `frame' (or max_framepos if none exists)
* @param after Filled in with the position of the next `mark' after `frame' (or max_framepos if none exists)
*/
void
Locations::marks_either_side (framepos_t const frame, framepos_t& before, framepos_t& after) const
{
before = after = max_framepos;
LocationList locs;
{
Glib::Mutex::Lock lm (lock);
locs = locations;
}
/* Get a list of positions; don't store any that are exactly on our requested position */
std::list<framepos_t> positions;
for (LocationList::const_iterator i = locs.begin(); i != locs.end(); ++i) {
if (((*i)->is_auto_loop() || (*i)->is_auto_punch())) {
continue;
}
if (!(*i)->is_hidden()) {
if ((*i)->is_mark ()) {
if ((*i)->start() != frame) {
positions.push_back ((*i)->start ());
}
} else {
if ((*i)->start() != frame) {
positions.push_back ((*i)->start ());
}
if ((*i)->end() != frame) {
positions.push_back ((*i)->end ());
}
}
}
}
if (positions.empty ()) {
return;
}
positions.sort ();
std::list<framepos_t>::iterator i = positions.begin ();
while (i != positions.end () && *i < frame) {
++i;
}
if (i == positions.end ()) {
/* run out of marks */
before = positions.back ();
return;
}
after = *i;
if (i == positions.begin ()) {
/* none before */
return;
}
--i;
before = *i;
}
Location*
Locations::session_range_location () const
{
for (LocationList::const_iterator i = locations.begin(); i != locations.end(); ++i) {
if ((*i)->is_session_range()) {
return const_cast<Location*> (*i);
}
}
return 0;
}
Location*
Locations::auto_loop_location () const
{
for (LocationList::const_iterator i = locations.begin(); i != locations.end(); ++i) {
if ((*i)->is_auto_loop()) {
return const_cast<Location*> (*i);
}
}
return 0;
}
Location*
Locations::auto_punch_location () const
{
for (LocationList::const_iterator i = locations.begin(); i != locations.end(); ++i) {
if ((*i)->is_auto_punch()) {
return const_cast<Location*> (*i);
}
}
return 0;
}
uint32_t
Locations::num_range_markers () const
{
uint32_t cnt = 0;
Glib::Mutex::Lock lm (lock);
for (LocationList::const_iterator i = locations.begin(); i != locations.end(); ++i) {
if ((*i)->is_range_marker()) {
++cnt;
}
}
return cnt;
}
Location *
Locations::get_location_by_id(PBD::ID id)
{
LocationList::iterator it;
for (it = locations.begin(); it != locations.end(); ++it)
if (id == (*it)->id())
return *it;
return 0;
}
void
Locations::find_all_between (framepos_t start, framepos_t end, LocationList& ll, Location::Flags flags)
{
Glib::Mutex::Lock lm (lock);
for (LocationList::const_iterator i = locations.begin(); i != locations.end(); ++i) {
if ((flags == 0 || (*i)->matches (flags)) &&
((*i)->start() >= start && (*i)->end() < end)) {
ll.push_back (*i);
}
}
}