2 Copyright (C) 2006 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.
27 #include <pbd/mountpoint.h>
28 #include <pbd/pathscanner.h>
29 #include <pbd/stl_delete.h>
30 #include <pbd/strsplit.h>
34 #include <glibmm/miscutils.h>
36 #include <ardour/audiofilesource.h>
37 #include <ardour/sndfile_helpers.h>
38 #include <ardour/sndfilesource.h>
39 #include <ardour/destructive_filesource.h>
40 #include <ardour/session.h>
41 #include <ardour/source_factory.h>
43 // if these headers come before sigc++ is included
44 // the parser throws ObjC++ errors. (nil is a keyword)
46 #include <ardour/coreaudiosource.h>
47 #include <AudioToolbox/ExtendedAudioFile.h>
48 #include <AudioToolbox/AudioFormat.h>
49 #endif // HAVE_COREAUDIO
53 using namespace ARDOUR;
56 string AudioFileSource::peak_dir = "";
57 string AudioFileSource::search_path;
59 sigc::signal<void> AudioFileSource::HeaderPositionOffsetChanged;
60 uint64_t AudioFileSource::header_position_offset = 0;
62 /* XXX maybe this too */
63 char AudioFileSource::bwf_serial_number[13] = "000000000000";
65 AudioFileSource::AudioFileSource (Session& s, string idstr, Flag flags)
66 : AudioSource (s, idstr), _flags (flags)
68 /* constructor used for existing external to session files. file must exist already */
69 _is_embedded = AudioFileSource::determine_embeddedness (idstr);
71 if (init (idstr, true)) {
72 throw failed_constructor ();
77 AudioFileSource::AudioFileSource (Session& s, std::string path, Flag flags, SampleFormat samp_format, HeaderFormat hdr_format)
78 : AudioSource (s, path), _flags (flags)
80 /* constructor used for new internal-to-session files. file cannot exist */
83 if (init (path, false)) {
84 throw failed_constructor ();
88 AudioFileSource::AudioFileSource (Session& s, const XMLNode& node)
89 : AudioSource (s, node), _flags (Flag (Writable|CanRename))
91 /* constructor used for existing internal-to-session files. file must exist */
93 if (set_state (node)) {
94 throw failed_constructor ();
97 if (init (_name, true)) {
98 throw failed_constructor ();
102 AudioFileSource::~AudioFileSource ()
105 unlink (_path.c_str());
106 unlink (peakpath.c_str());
111 AudioFileSource::determine_embeddedness (std::string path)
113 return (path.find("/") == 0);
117 AudioFileSource::removable () const
119 return (_flags & Removable) && ((_flags & RemoveAtDestroy) || ((_flags & RemovableIfEmpty) && length() == 0));
123 AudioFileSource::init (string pathstr, bool must_exist)
128 timeline_position = 0;
129 next_peak_clear_should_notify = false;
130 _peaks_built = false;
133 if (!find (pathstr, must_exist, is_new)) {
137 if (is_new && must_exist) {
146 AudioFileSource::peak_path (string audio_path)
148 return _session.peak_path_from_audio_path (audio_path);
152 AudioFileSource::old_peak_path (string audio_path)
154 /* XXX hardly bombproof! fix me */
156 struct stat stat_file;
157 struct stat stat_mount;
159 string mp = mountpoint (audio_path);
161 stat (audio_path.c_str(), &stat_file);
162 stat (mp.c_str(), &stat_mount);
166 snprintf (buf, sizeof (buf), "%u-%u-%d.peak", stat_mount.st_ino, stat_file.st_ino, channel);
168 snprintf (buf, sizeof (buf), "%ld-%ld-%d.peak", stat_mount.st_ino, stat_file.st_ino, channel);
171 string res = peak_dir;
178 AudioFileSource::get_soundfile_info (string path, SoundFileInfo& _info, string& error_msg)
180 #ifdef HAVE_COREAUDIO
181 OSStatus err = noErr;
183 ExtAudioFileRef af = 0;
187 err = FSPathMakeRef ((UInt8*)path.c_str(), &ref, 0);
189 ExtAudioFileDispose (af);
193 err = ExtAudioFileOpen(&ref, &af);
195 ExtAudioFileDispose (af);
199 AudioStreamBasicDescription absd;
200 memset(&absd, 0, sizeof(absd));
201 size = sizeof(AudioStreamBasicDescription);
202 err = ExtAudioFileGetProperty(af,
203 kExtAudioFileProperty_FileDataFormat, &size, &absd);
205 ExtAudioFileDispose (af);
209 _info.samplerate = absd.mSampleRate;
210 _info.channels = absd.mChannelsPerFrame;
212 size = sizeof(_info.length);
213 err = ExtAudioFileGetProperty(af, kExtAudioFileProperty_FileLengthFrames, &size, &_info.length);
215 ExtAudioFileDispose (af);
219 size = sizeof(CFStringRef);
220 err = AudioFormatGetProperty(
221 kAudioFormatProperty_FormatName, sizeof(absd), &absd, &size, &name);
223 ExtAudioFileDispose (af);
227 _info.format_name = CFStringRefToStdString(name);
229 ExtAudioFileDispose (af);
233 #endif // HAVE_COREAUDIO
238 sf_info.format = 0; // libsndfile says to clear this before sf_open().
240 if ((sf = sf_open ((char*) path.c_str(), SFM_READ, &sf_info)) == 0) {
242 error_msg = sf_error_str (0, errbuf, sizeof (errbuf) - 1);
248 _info.samplerate = sf_info.samplerate;
249 _info.channels = sf_info.channels;
250 _info.length = sf_info.frames;
251 _info.format_name = string_compose("Format: %1, %2",
252 sndfile_major_format(sf_info.format),
253 sndfile_minor_format(sf_info.format));
258 AudioFileSource::get_state ()
260 XMLNode& root (AudioSource::get_state());
262 snprintf (buf, sizeof (buf), "0x%x", (int)_flags);
263 root.add_property ("flags", buf);
268 AudioFileSource::set_state (const XMLNode& node)
270 const XMLProperty* prop;
272 if (AudioSource::set_state (node)) {
276 if ((prop = node.property (X_("flags"))) != 0) {
279 sscanf (prop->value().c_str(), "0x%x", &ival);
280 _flags = Flag (ival);
288 if ((prop = node.property (X_("name"))) != 0) {
289 _is_embedded = AudioFileSource::determine_embeddedness (prop->value());
291 _is_embedded = false;
298 AudioFileSource::mark_for_remove ()
304 _flags = Flag (_flags | Removable | RemoveAtDestroy);
308 AudioFileSource::mark_streaming_write_completed ()
314 Glib::Mutex::Lock lm (_lock);
316 next_peak_clear_should_notify = true;
318 if (_peaks_built || pending_peak_builds.empty()) {
320 PeaksReady (); /* EMIT SIGNAL */
325 AudioFileSource::mark_take (string id)
333 AudioFileSource::move_to_trash (const string trash_dir_name)
336 cerr << "tried to move an embedded region to trash" << endl;
346 /* don't move the file across filesystems, just
347 stick it in the `trash_dir_name' directory
348 on whichever filesystem it was already on.
351 newpath = Glib::path_get_dirname (_path);
352 newpath = Glib::path_get_dirname (newpath);
355 newpath += trash_dir_name;
357 newpath += Glib::path_get_basename (_path);
359 if (access (newpath.c_str(), F_OK) == 0) {
361 /* the new path already exists, try versioning */
363 char buf[PATH_MAX+1];
367 snprintf (buf, sizeof (buf), "%s.%d", newpath.c_str(), version);
370 while (access (newpath_v.c_str(), F_OK) == 0 && version < 999) {
371 snprintf (buf, sizeof (buf), "%s.%d", newpath.c_str(), ++version);
375 if (version == 999) {
376 error << string_compose (_("there are already 1000 files with names like %1; versioning discontinued"),
385 /* it doesn't exist, or we can't read it or something */
389 if (::rename (_path.c_str(), newpath.c_str()) != 0) {
390 error << string_compose (_("cannot rename audio file source from %1 to %2 (%3)"),
391 _path, newpath, strerror (errno))
396 if (::unlink (peakpath.c_str()) != 0) {
397 error << string_compose (_("cannot remove peakfile %1 for %2 (%3)"),
398 peakpath, _path, strerror (errno))
400 /* try to back out */
401 rename (newpath.c_str(), _path.c_str());
408 /* file can not be removed twice, since the operation is not idempotent */
410 _flags = Flag (_flags & ~(RemoveAtDestroy|Removable|RemovableIfEmpty));
416 AudioFileSource::find (string pathstr, bool must_exist, bool& isnew)
418 string::size_type pos;
423 /* clean up PATH:CHANNEL notation so that we are looking for the correct path */
425 if ((pos = pathstr.find_last_of (':')) == string::npos) {
428 pathstr = pathstr.substr (0, pos);
431 if (pathstr[0] != '/') {
433 /* non-absolute pathname: find pathstr in search path */
440 if (search_path.length() == 0) {
441 error << _("FileSource: search path not set") << endmsg;
445 split (search_path, dirs, ':');
449 for (vector<string>::iterator i = dirs.begin(); i != dirs.end(); ++i) {
452 if (fullpath[fullpath.length()-1] != '/') {
457 if (access (fullpath.c_str(), R_OK) == 0) {
465 error << string_compose (_("FileSource: \"%1\" is ambigous when searching %2\n\t"), pathstr, search_path) << endmsg;
468 } else if (cnt == 0) {
471 error << string_compose(_("Filesource: cannot find required file (%1): while searching %2"), pathstr, search_path) << endmsg;
484 /* external files and/or very very old style sessions include full paths */
490 _name = pathstr.substr (pathstr.find_last_of ('/') + 1);
493 if (access (_path.c_str(), R_OK) != 0) {
495 /* file does not exist or we cannot read it */
498 error << string_compose(_("Filesource: cannot find required file (%1): %2"), _path, strerror (errno)) << endmsg;
502 if (errno != ENOENT) {
503 error << string_compose(_("Filesource: cannot check for existing file (%1): %2"), _path, strerror (errno)) << endmsg;
525 AudioFileSource::set_search_path (string p)
531 AudioFileSource::set_header_position_offset (nframes_t offset)
533 header_position_offset = offset;
534 HeaderPositionOffsetChanged ();
538 AudioFileSource::set_timeline_position (nframes_t pos)
540 timeline_position = pos;
544 AudioFileSource::set_allow_remove_if_empty (bool yn)
551 _flags = Flag (_flags | RemovableIfEmpty);
553 _flags = Flag (_flags & ~RemovableIfEmpty);
558 AudioFileSource::set_name (string newname, bool destructive)
560 Glib::Mutex::Lock lm (_lock);
561 string oldpath = _path;
562 string newpath = Session::change_audio_path_by_name (oldpath, _name, newname, destructive);
564 if (newpath.empty()) {
565 error << string_compose (_("programming error: %1"), "cannot generate a changed audio path") << endmsg;
569 // Test whether newpath exists, if yes notify the user but continue.
570 if (access(newpath.c_str(),F_OK) == 0) {
571 error << _("Programming error! Ardour tried to rename a file over another file! It's safe to continue working, but please report this to the developers.") << endmsg;
575 if (rename (oldpath.c_str(), newpath.c_str()) != 0) {
576 error << string_compose (_("cannot rename audio file for %1 to %2"), _name, newpath) << endmsg;
580 _name = Glib::path_get_basename (newpath);
583 return rename_peakfile (peak_path (_path));
587 AudioFileSource::is_empty (Session& s, string path)
590 boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource> (SourceFactory::createReadable (s, path, NoPeakFile, false));
593 ret = (afs->length() == 0);
600 AudioFileSource::setup_peakfile ()
602 if (!(_flags & NoPeakFile)) {
603 return initialize_peakfile (file_is_new, _path);