Merged with trunk revision 600

git-svn-id: svn://localhost/ardour2/branches/midi@601 d708f5d6-7413-0410-9779-e7cbd77b26cf

1 files changed, 661 insertions, 0 deletions

diff --git a/libs/ardour/audiofilesource.cc b/libs/ardour/audiofilesource.cc
new file mode 100644
index 0000000000..fbddcdafdf
--- /dev/null
+++ b/libs/ardour/audiofilesource.cc
@@ -0,0 +1,661 @@
+/*
+    Copyright (C) 2006 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 <vector>
+
+#include <sys/time.h>
+#include <sys/stat.h>
+#include <unistd.h>
+#include <errno.h>
+
+#include <pbd/mountpoint.h>
+#include <pbd/pathscanner.h>
+#include <pbd/stl_delete.h>
+#include <pbd/strsplit.h>
+
+#include <sndfile.h>
+
+#include <glibmm/miscutils.h>
+
+#include <ardour/audiofilesource.h>
+#include <ardour/sndfile_helpers.h>
+#include <ardour/sndfilesource.h>
+#include <ardour/destructive_filesource.h>
+#include <ardour/session.h>
+
+// if these headers come before sigc++ is included
+// the parser throws ObjC++ errors. (nil is a keyword)
+#ifdef HAVE_COREAUDIO 
+#include <ardour/coreaudio_source.h>
+#include <AudioToolbox/ExtendedAudioFile.h>
+#include <AudioToolbox/AudioFormat.h>
+#endif // HAVE_COREAUDIO
+
+#include "i18n.h"
+
+using namespace ARDOUR;
+
+string AudioFileSource::peak_dir = "";
+string AudioFileSource::search_path;
+
+sigc::signal<void,struct tm*, time_t> AudioFileSource::HeaderPositionOffsetChanged;
+bool                                  AudioFileSource::header_position_negative;
+uint64_t                              AudioFileSource::header_position_offset;
+
+char   AudioFileSource::bwf_country_code[3] = "US";
+char   AudioFileSource::bwf_organization_code[4] = "LAS";
+char   AudioFileSource::bwf_serial_number[13] = "000000000000";
+
+AudioFileSource::AudioFileSource (string idstr, Flag flags)
+	: AudioSource (idstr), _flags (flags)
+{
+	/* constructor used for existing external to session files. file must exist already */
+
+	if (init (idstr, true)) {
+		throw failed_constructor ();
+	}
+
+}
+
+AudioFileSource::AudioFileSource (std::string path, Flag flags, SampleFormat samp_format, HeaderFormat hdr_format)
+	: AudioSource (path), _flags (flags)
+{
+	/* constructor used for new internal-to-session files. file cannot exist */
+
+	if (init (path, false)) {
+		throw failed_constructor ();
+	}
+}
+
+AudioFileSource::AudioFileSource (const XMLNode& node)
+	: AudioSource (node), _flags (Flag (Writable|CanRename))
+{
+	/* constructor used for existing internal-to-session files. file must exist */
+
+	if (set_state (node)) {
+		throw failed_constructor ();
+	}
+	
+	if (init (_name, true)) {
+		throw failed_constructor ();
+	}
+}
+
+AudioFileSource::~AudioFileSource ()
+{
+	if (removable()) {
+		unlink (_path.c_str());
+		unlink (peakpath.c_str());
+	}
+}
+
+bool
+AudioFileSource::removable () const
+{
+	return (_flags & Removable) && ((_flags & RemoveAtDestroy) || 
+				      ((_flags & RemovableIfEmpty) && is_empty (_path)));
+}
+
+int
+AudioFileSource::init (string pathstr, bool must_exist)
+{
+	bool is_new = false;
+
+	_length = 0;
+	next_peak_clear_should_notify = false;
+	
+	if (!find (pathstr, must_exist, is_new)) {
+		cerr << "cannot find " << pathstr << " with me = " << must_exist << endl;
+		return -1;
+	}
+
+	if (is_new && must_exist) {
+		return -1;
+	}
+
+	return 0;
+}
+
+
+string
+AudioFileSource::peak_path (string audio_path)
+{
+	return Session::peak_path_from_audio_path (audio_path);
+}
+
+string
+AudioFileSource::old_peak_path (string audio_path)
+{
+	/* XXX hardly bombproof! fix me */
+
+	struct stat stat_file;
+	struct stat stat_mount;
+
+	string mp = mountpoint (audio_path);
+
+	stat (audio_path.c_str(), &stat_file);
+	stat (mp.c_str(), &stat_mount);
+
+	char buf[32];
+#ifdef __APPLE__
+	snprintf (buf, sizeof (buf), "%u-%u-%d.peak", stat_mount.st_ino, stat_file.st_ino, channel);
+#else
+	snprintf (buf, sizeof (buf), "%ld-%ld-%d.peak", stat_mount.st_ino, stat_file.st_ino, channel);
+#endif
+
+	string res = peak_dir;
+	res += buf;
+
+	return res;
+}
+
+#ifdef HAVE_COREAUDIO
+
+AudioFileSource*
+AudioFileSource::create (const XMLNode& node)
+{
+	AudioFileSource* es = 0;
+
+	if (node.property (X_("destructive")) != 0) {
+		
+		es = new DestructiveFileSource (node);
+	
+	} else {
+		
+		try {
+			es = new CoreAudioSource (node);
+		} 
+		
+		
+		catch (failed_constructor& err) {
+			es = new SndFileSource (node);
+		}
+	}
+	
+	return es;
+}
+
+#else
+
+AudioFileSource*
+AudioFileSource::create (const XMLNode& node)
+{
+	if (node.property (X_("destructive")) != 0) {
+		
+		return new DestructiveFileSource (node);
+		
+	} else {
+		
+		return new SndFileSource (node);
+	}
+}
+
+#endif // HAVE_COREAUDIO
+
+#ifdef HAVE_COREAUDIO
+AudioFileSource*
+AudioFileSource::create (const string& idstr)
+{
+	AudioFileSource* es = 0;
+
+	try {
+		es = new CoreAudioSource (idstr);
+	}
+
+	catch (failed_constructor& err) {
+		es = new SndFileSource (idstr);
+	}
+
+	return es;
+}
+
+#else
+
+AudioFileSource*
+AudioFileSource::create (string idstr)
+{
+	return new SndFileSource (idstr);
+}
+
+#endif // HAVE_COREAUDIO
+
+#ifdef HAVE_COREAUDIO
+std::string 
+CFStringRefToStdString(CFStringRef stringRef)
+{
+	CFIndex size = 
+		CFStringGetMaximumSizeForEncoding(CFStringGetLength(stringRef) , 
+		kCFStringEncodingASCII);
+	    char *buf = new char[size];
+	
+	std::string result;
+
+	if(CFStringGetCString(stringRef, buf, size, kCFStringEncodingASCII)) {
+	    result = buf;
+	}
+	delete [] buf;
+	return result;
+}
+#endif // HAVE_COREAUDIO
+
+bool
+AudioFileSource::get_soundfile_info (string path, SoundFileInfo& _info, string& error_msg)
+{
+#ifdef HAVE_COREAUDIO
+	OSStatus err = noErr;
+    FSRef ref; 
+	ExtAudioFileRef af = 0;
+	size_t size;
+    CFStringRef name;
+
+    err = FSPathMakeRef ((UInt8*)path.c_str(), &ref, 0);
+	if (err != noErr) {
+        ExtAudioFileDispose (af);
+		goto libsndfile;
+	}
+
+	err = ExtAudioFileOpen(&ref, &af);
+	if (err != noErr) {
+        ExtAudioFileDispose (af);
+		goto libsndfile;
+	}
+
+	AudioStreamBasicDescription absd;
+	memset(&absd, 0, sizeof(absd));
+	size = sizeof(AudioStreamBasicDescription);
+	err = ExtAudioFileGetProperty(af,
+			kExtAudioFileProperty_FileDataFormat, &size, &absd);
+	if (err != noErr) {
+        ExtAudioFileDispose (af);
+		goto libsndfile;
+	}
+
+	_info.samplerate = absd.mSampleRate;
+	_info.channels   = absd.mChannelsPerFrame;
+
+    size = sizeof(_info.length);
+    err = ExtAudioFileGetProperty(af, kExtAudioFileProperty_FileLengthFrames, &size, &_info.length);
+    if (err != noErr) {
+        ExtAudioFileDispose (af);
+		goto libsndfile;
+    }
+
+	size = sizeof(CFStringRef);
+	err = AudioFormatGetProperty(
+			kAudioFormatProperty_FormatName, sizeof(absd), &absd, &size, &name);
+	if (err != noErr) {
+        ExtAudioFileDispose (af);
+		goto libsndfile;
+	}
+
+	_info.format_name = CFStringRefToStdString(name);
+
+    ExtAudioFileDispose (af);
+	return true;
+	
+libsndfile:
+#endif // HAVE_COREAUDIO
+
+	SNDFILE *sf;
+	SF_INFO sf_info;
+
+	sf_info.format = 0; // libsndfile says to clear this before sf_open().
+
+	if ((sf = sf_open ((char*) path.c_str(), SFM_READ, &sf_info)) == 0) { 
+		char errbuf[256];
+		error_msg = sf_error_str (0, errbuf, sizeof (errbuf) - 1);
+		return false;
+	}
+
+	sf_close (sf);
+
+	_info.samplerate  = sf_info.samplerate;
+	_info.channels    = sf_info.channels;
+	_info.length      = sf_info.frames;
+	_info.format_name = string_compose("Format: %1, %2",
+					   sndfile_major_format(sf_info.format),
+					   sndfile_minor_format(sf_info.format));
+	return true;
+}
+
+XMLNode&
+AudioFileSource::get_state ()
+{
+	XMLNode& root (AudioSource::get_state());
+	char buf[16];
+	snprintf (buf, sizeof (buf), "0x%x", (int)_flags);
+	root.add_property ("flags", buf);
+	return root;
+}
+
+int
+AudioFileSource::set_state (const XMLNode& node)
+{
+	const XMLProperty* prop;
+
+	if (AudioSource::set_state (node)) {
+		return -1;
+	}
+
+	if ((prop = node.property (X_("flags"))) != 0) {
+
+		int ival;
+		sscanf (prop->value().c_str(), "0x%x", &ival);
+		_flags = Flag (ival);
+
+	} else {
+
+		_flags = Flag (0);
+
+	}
+
+	return 0;
+}
+
+void
+AudioFileSource::mark_for_remove ()
+{
+	if (!writable()) {
+		return;
+	}
+	_flags = Flag (_flags | RemoveAtDestroy);
+}
+
+void
+AudioFileSource::mark_streaming_write_completed ()
+{
+	if (!writable()) {
+		return;
+	}
+
+	Glib::Mutex::Lock lm (_lock);
+
+	next_peak_clear_should_notify = true;
+
+	if (_peaks_built || pending_peak_builds.empty()) {
+		_peaks_built = true;
+		 PeaksReady (); /* EMIT SIGNAL */
+	}
+}
+
+void
+AudioFileSource::mark_take (string id)
+{
+	if (writable()) {
+		_take_id = id;
+	}
+}
+
+int
+AudioFileSource::move_to_trash (const string trash_dir_name)
+{
+	string newpath;
+
+	if (!writable()) {
+		return -1;
+	}
+
+	/* don't move the file across filesystems, just
+	   stick it in the `trash_dir_name' directory
+	   on whichever filesystem it was already on.
+	*/
+
+	newpath = Glib::path_get_dirname (_path);
+	newpath = Glib::path_get_dirname (newpath);
+
+	newpath += '/';
+	newpath += trash_dir_name;
+	newpath += '/';
+	newpath += Glib::path_get_basename (_path);
+
+	if (access (newpath.c_str(), F_OK) == 0) {
+
+		/* the new path already exists, try versioning */
+		
+		char buf[PATH_MAX+1];
+		int version = 1;
+		string newpath_v;
+
+		snprintf (buf, sizeof (buf), "%s.%d", newpath.c_str(), version);
+		newpath_v = buf;
+
+		while (access (newpath_v.c_str(), F_OK) == 0 && version < 999) {
+			snprintf (buf, sizeof (buf), "%s.%d", newpath.c_str(), ++version);
+			newpath_v = buf;
+		}
+		
+		if (version == 999) {
+			error << string_compose (_("there are already 1000 files with names like %1; versioning discontinued"),
+					  newpath)
+			      << endmsg;
+		} else {
+			newpath = newpath_v;
+		}
+
+	} else {
+
+		/* it doesn't exist, or we can't read it or something */
+
+	}
+
+	if (::rename (_path.c_str(), newpath.c_str()) != 0) {
+		error << string_compose (_("cannot rename audio file source from %1 to %2 (%3)"),
+				  _path, newpath, strerror (errno))
+		      << endmsg;
+		return -1;
+	}
+
+	if (::unlink (peakpath.c_str()) != 0) {
+		error << string_compose (_("cannot remove peakfile %1 for %2 (%3)"),
+				  peakpath, _path, strerror (errno))
+		      << endmsg;
+		/* try to back out */
+		rename (newpath.c_str(), _path.c_str());
+		return -1;
+	}
+	    
+	_path = newpath;
+	peakpath = "";
+	
+	/* file can not be removed twice, since the operation is not idempotent */
+
+	_flags = Flag (_flags & ~(RemoveAtDestroy|Removable|RemovableIfEmpty));
+
+	return 0;
+}
+
+bool
+AudioFileSource::find (string pathstr, bool must_exist, bool& isnew)
+{
+	string::size_type pos;
+	bool ret = false;
+
+	isnew = false;
+
+	/* clean up PATH:CHANNEL notation so that we are looking for the correct path */
+
+	if ((pos = pathstr.find_last_of (':')) == string::npos) {
+		pathstr = pathstr;
+	} else {
+		pathstr = pathstr.substr (0, pos);
+	}
+
+	if (pathstr[0] != '/') {
+
+		/* non-absolute pathname: find pathstr in search path */
+
+		vector<string> dirs;
+		int cnt;
+		string fullpath;
+		string keeppath;
+
+		if (search_path.length() == 0) {
+			error << _("FileSource: search path not set") << endmsg;
+			goto out;
+		}
+
+		split (search_path, dirs, ':');
+
+		cnt = 0;
+		
+		for (vector<string>::iterator i = dirs.begin(); i != dirs.end(); ++i) {
+
+			fullpath = *i;
+			if (fullpath[fullpath.length()-1] != '/') {
+				fullpath += '/';
+			}
+			fullpath += pathstr;
+			
+			if (access (fullpath.c_str(), R_OK) == 0) {
+				keeppath = fullpath;
+				++cnt;
+			} 
+		}
+
+		if (cnt > 1) {
+
+			error << string_compose (_("FileSource: \"%1\" is ambigous when searching %2\n\t"), pathstr, search_path) << endmsg;
+			goto out;
+
+		} else if (cnt == 0) {
+
+			if (must_exist) {
+				error << string_compose(_("Filesource: cannot find required file (%1): while searching %2"), pathstr, search_path) << endmsg;
+				goto out;
+			} else {
+				isnew = true;
+			}
+		}
+		
+		_name = pathstr;
+		_path = keeppath;
+		ret = true;
+
+	} else {
+		
+		/* external files and/or very very old style sessions include full paths */
+		
+		_path = pathstr;
+		_name = pathstr.substr (pathstr.find_last_of ('/') + 1);
+		
+		if (access (_path.c_str(), R_OK) != 0) {
+
+			/* file does not exist or we cannot read it */
+
+			if (must_exist) {
+				error << string_compose(_("Filesource: cannot find required file (%1): %2"), _path, strerror (errno)) << endmsg;
+				goto out;
+			}
+			
+			if (errno != ENOENT) {
+				error << string_compose(_("Filesource: cannot check for existing file (%1): %2"), _path, strerror (errno)) << endmsg;
+				goto out;
+			}
+			
+			/* a new file */
+
+			isnew = true;
+			ret = true;
+
+		} else {
+			
+			/* already exists */
+
+			ret = true;
+		}
+	}
+	
+  out:
+	return ret;
+}
+
+void
+AudioFileSource::set_search_path (string p)
+{
+	search_path = p;
+}
+
+void
+AudioFileSource::set_header_position_offset (jack_nframes_t offset, bool negative)
+{
+	time_t tnow;
+
+	time (&tnow);
+
+	header_position_offset = offset;
+	header_position_negative = negative;
+	HeaderPositionOffsetChanged (localtime (&tnow), tnow); /* EMIT SIGNAL */
+}
+
+void
+AudioFileSource::set_timeline_position (jack_nframes_t pos)
+{
+	timeline_position = pos;
+}
+
+void
+AudioFileSource::handle_header_position_change (struct tm* now, time_t tnow)
+{
+	/* don't do this if the file has never had its header flushed to disk yet */
+
+	if (writable() && _timestamp) {
+		set_header_timeline_position ();
+		flush_header ();
+	}
+}
+
+void
+AudioFileSource::set_allow_remove_if_empty (bool yn)
+{
+	if (writable()) {
+		allow_remove_if_empty = yn;
+	}
+}
+
+int
+AudioFileSource::set_name (string newname, bool destructive)
+{
+	Glib::Mutex::Lock lm (_lock);
+	string oldpath = _path;
+	string newpath = Session::change_audio_path_by_name (oldpath, _name, newname, destructive);
+
+	if (newpath.empty()) {
+		error << string_compose (_("programming error: %1"), "cannot generate a changed audio path") << endmsg;
+		return -1;
+	}
+
+	if (rename (oldpath.c_str(), newpath.c_str()) != 0) {
+		error << string_compose (_("cannot rename audio file for %1 to %2"), _name, newpath) << endmsg;
+		return -1;
+	}
+
+	_name = Glib::path_get_basename (newpath);
+	_path = newpath;
+
+	return rename_peakfile (peak_path (_path));
+}
+
+bool
+AudioFileSource::is_empty (string path)
+{
+	/* XXX fix me */
+
+	return false;
+}
+