/*
- Copyright (C) 2006 Paul Davis
+ 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
*/
+#ifdef WAF_BUILD
+#include "libardour-config.h"
+#endif
+
#include <vector>
#include <sys/time.h>
#include <sys/stat.h>
+#include <stdio.h> // for rename(), sigh
#include <unistd.h>
+#include <fcntl.h>
#include <errno.h>
-#include <pbd/mountpoint.h>
-#include <pbd/pathscanner.h>
-#include <pbd/stl_delete.h>
-#include <pbd/strsplit.h>
+#include "pbd/convert.h"
+#include "pbd/basename.h"
+#include "pbd/mountpoint.h"
+#include "pbd/stl_delete.h"
+#include "pbd/strsplit.h"
+#include "pbd/shortpath.h"
+#include "pbd/enumwriter.h"
#include <sndfile.h>
#include <glibmm/miscutils.h>
+#include <glibmm/fileutils.h>
+#include <glibmm/threads.h>
-#include <ardour/audiofilesource.h>
-#include <ardour/sndfile_helpers.h>
-#include <ardour/sndfilesource.h>
-#include <ardour/destructive_filesource.h>
-#include <ardour/session.h>
+#include "ardour/audiofilesource.h"
+#include "ardour/debug.h"
+#include "ardour/sndfilesource.h"
+#include "ardour/session.h"
+#include "ardour/filename_extensions.h"
// if these headers come before sigc++ is included
// the parser throws ObjC++ errors. (nil is a keyword)
-#ifdef HAVE_COREAUDIO
-#include <ardour/coreaudiosource.h>
+#ifdef HAVE_COREAUDIO
+#include "ardour/coreaudiosource.h"
#include <AudioToolbox/ExtendedAudioFile.h>
#include <AudioToolbox/AudioFormat.h>
#endif // HAVE_COREAUDIO
#include "i18n.h"
+using namespace std;
using namespace ARDOUR;
using namespace PBD;
+using namespace Glib;
string AudioFileSource::peak_dir = "";
-string AudioFileSource::search_path;
-sigc::signal<void> AudioFileSource::HeaderPositionOffsetChanged;
-uint64_t AudioFileSource::header_position_offset = 0;
+PBD::Signal0<void> AudioFileSource::HeaderPositionOffsetChanged;
+framecnt_t AudioFileSource::header_position_offset = 0;
-char AudioFileSource::bwf_country_code[3] = "US";
-char AudioFileSource::bwf_organization_code[4] = "LAS";
-char AudioFileSource::bwf_serial_number[13] = "000000000000";
+/* XXX maybe this too */
+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 */
+struct SizedSampleBuffer {
+ framecnt_t size;
+ Sample* buf;
- if (init (idstr, true)) {
- throw failed_constructor ();
+ SizedSampleBuffer (framecnt_t sz) : size (sz) {
+ buf = new Sample[size];
+ }
+
+ ~SizedSampleBuffer() {
+ delete [] buf;
}
+};
+Glib::Threads::Private<SizedSampleBuffer> thread_interleave_buffer;
+
+/** Constructor used for existing external-to-session files. */
+AudioFileSource::AudioFileSource (Session& s, const string& path, Source::Flag flags)
+ : Source (s, DataType::AUDIO, path, flags)
+ , AudioSource (s, path)
+ /* note that external files have their own path as "origin" */
+ , FileSource (s, DataType::AUDIO, path, path, flags)
+{
+ if (init (_path, 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. */
+AudioFileSource::AudioFileSource (Session& s, const string& path, const string& origin, Source::Flag flags,
+ SampleFormat /*samp_format*/, HeaderFormat /*hdr_format*/)
+ : Source (s, DataType::AUDIO, path, flags)
+ , AudioSource (s, path)
+ , FileSource (s, DataType::AUDIO, path, origin, flags)
{
- /* constructor used for new internal-to-session files. file cannot exist */
+ /* note that origin remains empty */
- if (init (path, false)) {
+ 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 via XML. File must exist. */
+AudioFileSource::AudioFileSource (Session& s, const XMLNode& node, bool must_exist)
+ : Source (s, node)
+ , AudioSource (s, node)
+ , FileSource (s, node, must_exist)
{
- /* constructor used for existing internal-to-session files. file must exist */
-
- if (set_state (node)) {
+ if (set_state (node, Stateful::loading_state_version)) {
throw failed_constructor ();
}
-
- if (init (_name, true)) {
+
+ if (init (_path, must_exist)) {
throw failed_constructor ();
}
}
AudioFileSource::~AudioFileSource ()
{
+ DEBUG_TRACE (DEBUG::Destruction, string_compose ("AudioFileSource destructor %1, removable? %2\n", _path, removable()));
if (removable()) {
unlink (_path.c_str());
unlink (peakpath.c_str());
}
}
-bool
-AudioFileSource::removable () const
+int
+AudioFileSource::init (const string& pathstr, bool must_exist)
{
- return (_flags & Removable) && ((_flags & RemoveAtDestroy) ||
- ((_flags & RemovableIfEmpty) && is_empty (_path)));
+ return FileSource::init (pathstr, must_exist);
}
-int
-AudioFileSource::init (string pathstr, bool must_exist)
+string
+AudioFileSource::peak_path (string audio_path)
{
- bool is_new = false;
+ string base;
- _length = 0;
- next_peak_clear_should_notify = false;
-
- if (!find (pathstr, must_exist, is_new)) {
- return -1;
- }
+ base = PBD::basename_nosuffix (audio_path);
+ base += '%';
+ base += (char) ('A' + _channel);
- if (is_new && must_exist) {
- return -1;
+ return _session.peak_path (base);
+}
+
+string
+AudioFileSource::find_broken_peakfile (string peak_path, string audio_path)
+{
+ string str;
+
+ /* check for the broken location in use by 2.0 for several months */
+
+ str = broken_peak_path (audio_path);
+
+ if (Glib::file_test (str, Glib::FILE_TEST_EXISTS)) {
+
+ if (!within_session()) {
+
+ /* it would be nice to rename it but the nature of
+ the bug means that we can't reliably use it.
+ */
+
+ peak_path = str;
+
+ } else {
+ /* all native files are mono, so we can just rename
+ it.
+ */
+ ::rename (str.c_str(), peak_path.c_str());
+ }
+
+ } else {
+ /* Nasty band-aid for older sessions that were created before we
+ used libsndfile for all audio files.
+ */
+
+
+ str = old_peak_path (audio_path);
+ if (Glib::file_test (str, Glib::FILE_TEST_EXISTS)) {
+ peak_path = str;
+ }
}
- return 0;
+ return peak_path;
}
-
string
-AudioFileSource::peak_path (string audio_path)
+AudioFileSource::broken_peak_path (string audio_path)
{
- return Session::peak_path_from_audio_path (audio_path);
+ return _session.peak_path (basename_nosuffix (audio_path));
}
string
char buf[32];
#ifdef __APPLE__
- snprintf (buf, sizeof (buf), "%u-%u-%d.peak", stat_mount.st_ino, stat_file.st_ino, channel);
+ 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);
+ snprintf (buf, sizeof (buf), "%" PRId64 "-%" PRId64 "-%d.peak", (int64_t) stat_mount.st_ino, (int64_t) stat_file.st_ino, _channel);
#endif
string res = peak_dir;
res += buf;
+ res += peakfile_suffix;
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, Flag flags)
-{
- AudioFileSource* es = 0;
-
- if (flags & Destructive) {
- return new DestructiveFileSource (idstr, flags);
- }
-
- try {
- es = new CoreAudioSource (idstr, flags);
- }
-
- catch (failed_constructor& err) {
- es = new SndFileSource (idstr, flags);
- }
-
- return es;
-}
-
-#else
-
-AudioFileSource*
-AudioFileSource::create (const string& idstr, Flag flags)
-{
- return new SndFileSource (idstr, flags);
-}
-
-#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;
- }
+ /* try sndfile first because it gets timecode info from .wav (BWF) if it exists,
+ which at present, ExtAudioFile from Apple seems unable to do.
+ */
- AudioStreamBasicDescription absd;
- memset(&absd, 0, sizeof(absd));
- size = sizeof(AudioStreamBasicDescription);
- err = ExtAudioFileGetProperty(af,
- kExtAudioFileProperty_FileDataFormat, &size, &absd);
- if (err != noErr) {
- ExtAudioFileDispose (af);
- goto libsndfile;
+ if (SndFileSource::get_soundfile_info (path, _info, error_msg) != 0) {
+ return true;
}
- _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;
+#ifdef HAVE_COREAUDIO
+ if (CoreAudioSource::get_soundfile_info (path, _info, error_msg) == 0) {
+ return true;
}
-
- _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;
+ return false;
}
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);
+ char buf[32];
+ snprintf (buf, sizeof (buf), "%u", _channel);
+ root.add_property (X_("channel"), buf);
+ root.add_property (X_("origin"), _origin);
return root;
}
int
-AudioFileSource::set_state (const XMLNode& node)
+AudioFileSource::set_state (const XMLNode& node, int version)
{
- const XMLProperty* prop;
-
- if (AudioSource::set_state (node)) {
+ if (Source::set_state (node, version)) {
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);
+ if (AudioSource::set_state (node, version)) {
+ return -1;
+ }
+ if (FileSource::set_state (node, version)) {
+ return -1;
}
return 0;
}
-void
-AudioFileSource::mark_for_remove ()
-{
- if (!writable()) {
- return;
- }
- _flags = Flag (_flags | RemoveAtDestroy);
-}
-
void
AudioFileSource::mark_streaming_write_completed ()
{
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;
- }
+ AudioSource::mark_streaming_write_completed ();
}
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)
+AudioFileSource::move_dependents_to_trash()
{
- 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;
+ return ::unlink (peakpath.c_str());
}
void
-AudioFileSource::set_search_path (string p)
-{
- search_path = p;
-}
-
-void
-AudioFileSource::set_header_position_offset (jack_nframes_t offset)
+AudioFileSource::set_header_position_offset (framecnt_t offset)
{
header_position_offset = offset;
- cerr << "hpo set to " << offset << endl;
HeaderPositionOffsetChanged ();
}
-void
-AudioFileSource::handle_header_position_change ()
+bool
+AudioFileSource::is_empty (Session& /*s*/, string path)
{
- if (writable()) {
- set_header_timeline_position ();
- flush_header ();
+ SoundFileInfo info;
+ string err;
+
+ if (!get_soundfile_info (path, info, err)) {
+ /* dangerous: we can't get info, so assume that its not empty */
+ return false;
}
-}
-void
-AudioFileSource::set_timeline_position (jack_nframes_t pos)
-{
- timeline_position = pos;
+ return info.length == 0;
}
-void
-AudioFileSource::set_allow_remove_if_empty (bool yn)
+int
+AudioFileSource::setup_peakfile ()
{
- if (writable()) {
- allow_remove_if_empty = yn;
+ if (!(_flags & NoPeakFile)) {
+ return initialize_peakfile (_path);
+ } else {
+ return 0;
}
}
-int
-AudioFileSource::set_name (string newname, bool destructive)
+bool
+AudioFileSource::safe_audio_file_extension(const string& file)
{
- 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;
- }
+ const char* suffixes[] = {
+ ".aif", ".AIF",
+ ".aifc", ".AIFC",
+ ".aiff", ".AIFF",
+ ".amb", ".AMB",
+ ".au", ".AU",
+ ".caf", ".CAF",
+ ".cdr", ".CDR",
+ ".flac", ".FLAC",
+ ".htk", ".HTK",
+ ".iff", ".IFF",
+ ".mat", ".MAT",
+ ".oga", ".OGA",
+ ".ogg", ".OGG",
+ ".paf", ".PAF",
+ ".pvf", ".PVF",
+ ".sf", ".SF",
+ ".smp", ".SMP",
+ ".snd", ".SND",
+ ".maud", ".MAUD",
+ ".voc", ".VOC"
+ ".vwe", ".VWE",
+ ".w64", ".W64",
+ ".wav", ".WAV",
+#ifdef HAVE_COREAUDIO
+ ".aac", ".AAC",
+ ".adts", ".ADTS",
+ ".ac3", ".AC3",
+ ".amr", ".AMR",
+ ".mpa", ".MPA",
+ ".mpeg", ".MPEG",
+ ".mp1", ".MP1",
+ ".mp2", ".MP2",
+ ".mp3", ".MP3",
+ ".mp4", ".MP4",
+ ".m4a", ".M4A",
+ ".sd2", ".SD2", // libsndfile supports sd2 also, but the resource fork is required to open.
+#endif // HAVE_COREAUDIO
+ };
- 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;
+ for (size_t n = 0; n < sizeof(suffixes)/sizeof(suffixes[0]); ++n) {
+ if (file.rfind (suffixes[n]) == file.length() - strlen (suffixes[n])) {
+ return true;
+ }
}
- _name = Glib::path_get_basename (newpath);
- _path = newpath;
-
- return rename_peakfile (peak_path (_path));
+ return false;
}
-bool
-AudioFileSource::is_empty (string path)
+Sample*
+AudioFileSource::get_interleave_buffer (framecnt_t size)
{
- bool ret = false;
- AudioFileSource* afs = create (path, NoPeakFile);
+ SizedSampleBuffer* ssb;
- if (afs) {
- ret = (afs->length() == 0);
- delete afs;
+ if ((ssb = thread_interleave_buffer.get()) == 0) {
+ ssb = new SizedSampleBuffer (size);
+ thread_interleave_buffer.set (ssb);
}
- return ret;
-}
+ if (ssb->size < size) {
+ ssb = new SizedSampleBuffer (size);
+ thread_interleave_buffer.set (ssb);
+ }
+ return ssb->buf;
+}