fix crash when copy'ing latent plugins
[ardour.git] / libs / ardour / sndfilesource.cc
index 1c3144f16421177f140b7da1753ec7bfaa8cf92f..4522e8a54dc794cd106ea0a362297625a0c932a5 100644 (file)
 #include <cerrno>
 #include <climits>
 #include <cstdarg>
+#include <fcntl.h>
 
 #include <sys/stat.h>
 
-#ifdef PLATFORM_WINDOWS
+#include <glib.h>
+#include "pbd/gstdio_compat.h"
+
 #include <glibmm/convert.h>
-#endif
+#include <glibmm/fileutils.h>
 #include <glibmm/miscutils.h>
 
 #include "ardour/sndfilesource.h"
@@ -38,7 +41,7 @@
 #include "ardour/utils.h"
 #include "ardour/session.h"
 
-#include "i18n.h"
+#include "pbd/i18n.h"
 
 using namespace std;
 using namespace ARDOUR;
@@ -57,39 +60,70 @@ const Source::Flag SndFileSource::default_writable_flags = Source::Flag (
 SndFileSource::SndFileSource (Session& s, const XMLNode& node)
        : Source(s, node)
        , AudioFileSource (s, node)
+       , _sndfile (0)
+       , _broadcast_info (0)
+       , _capture_start (false)
+       , _capture_end (false)
+       , file_pos (0)
+       , xfade_buf (0)
 {
        init_sndfile ();
 
+        assert (Glib::file_test (_path, Glib::FILE_TEST_EXISTS));
+       existence_check ();
+
        if (open()) {
                throw failed_constructor ();
        }
 }
 
-/** Files created this way are never writable or removable */
+/** Constructor for existing external-to-session files.
+    Files created this way are never writable or removable
+*/
 SndFileSource::SndFileSource (Session& s, const string& path, int chn, Flag flags)
        : Source(s, DataType::AUDIO, path, flags)
           /* note that the origin of an external file is itself */
        , AudioFileSource (s, path, Flag (flags & ~(Writable|Removable|RemovableIfEmpty|RemoveAtDestroy)))
+       , _sndfile (0)
+       , _broadcast_info (0)
+       , _capture_start (false)
+       , _capture_end (false)
+       , file_pos (0)
+       , xfade_buf (0)
 {
        _channel = chn;
 
        init_sndfile ();
 
+        assert (Glib::file_test (_path, Glib::FILE_TEST_EXISTS));
+       existence_check ();
+
        if (open()) {
                throw failed_constructor ();
        }
 }
 
-/** This constructor is used to construct new files, not open existing ones. */
+/** This constructor is used to construct new internal-to-session files,
+    not open existing ones.
+*/
 SndFileSource::SndFileSource (Session& s, const string& path, const string& origin,
                               SampleFormat sfmt, HeaderFormat hf, framecnt_t rate, Flag flags)
        : Source(s, DataType::AUDIO, path, flags)
        , AudioFileSource (s, path, origin, flags, sfmt, hf)
+       , _sndfile (0)
+       , _broadcast_info (0)
+       , _capture_start (false)
+       , _capture_end (false)
+       , file_pos (0)
+       , xfade_buf (0)
 {
        int fmt = 0;
 
         init_sndfile ();
 
+        assert (!Glib::file_test (_path, Glib::FILE_TEST_EXISTS));
+       existence_check ();
+
        _file_is_new = true;
 
        switch (hf) {
@@ -118,9 +152,26 @@ SndFileSource::SndFileSource (Session& s, const string& path, const string& orig
                _flags = Flag (_flags & ~Broadcast);
                break;
 
+       case RF64_WAV:
+               fmt = SF_FORMAT_RF64;
+               _flags = Flag (_flags & ~Broadcast);
+               _flags = Flag (_flags | RF64_RIFF);
+               break;
+
+       case MBWF:
+               fmt = SF_FORMAT_RF64;
+               _flags = Flag (_flags | Broadcast);
+               _flags = Flag (_flags | RF64_RIFF);
+               break;
+
+       case RF64:
+               fmt = SF_FORMAT_RF64;
+               _flags = Flag (_flags & ~Broadcast);
+               break;
+
        default:
                fatal << string_compose (_("programming error: %1"), X_("unsupported audio header format requested")) << endmsg;
-               /*NOTREACHED*/
+               abort(); /*NOTREACHED*/
                break;
 
        }
@@ -148,32 +199,48 @@ SndFileSource::SndFileSource (Session& s, const string& path, const string& orig
                        throw failed_constructor();
                }
        } else {
-               /* normal mode: do not open the file here - do that in write_unlocked() as needed
+               /* normal mode: do not open the file here - do that in {read,write}_unlocked() as needed
                 */
        }
 }
 
-void
-SndFileSource::init_sndfile ()
+/** Constructor to be called for recovering files being used for
+ * capture. They are in-session, they already exist, they should not
+ * be writable. They are an odd hybrid (from a constructor point of
+ * view) of the previous two constructors.
+ */
+SndFileSource::SndFileSource (Session& s, const string& path, int chn)
+       : Source (s, DataType::AUDIO, path, Flag (0))
+         /* the final boolean argument is not used, its value is irrelevant. see audiofilesource.h for explanation */
+       , AudioFileSource (s, path, Flag (0))
+       , _sndfile (0)
+       , _broadcast_info (0)
+       , _capture_start (false)
+       , _capture_end (false)
+       , file_pos (0)
+       , xfade_buf (0)
 {
-       string file;
+       _channel = chn;
 
-        _descriptor = 0;
+       init_sndfile ();
 
-       // lets try to keep the object initalizations here at the top
-       xfade_buf = 0;
-       _broadcast_info = 0;
+        assert (Glib::file_test (_path, Glib::FILE_TEST_EXISTS));
+       existence_check ();
 
+       if (open()) {
+               throw failed_constructor ();
+       }
+}
+
+void
+SndFileSource::init_sndfile ()
+{
        /* although libsndfile says we don't need to set this,
           valgrind and source code shows us that we do.
        */
 
        memset (&_info, 0, sizeof(_info));
 
-       _capture_start = false;
-       _capture_end = false;
-       file_pos = 0;
-
        if (destructive()) {
                xfade_buf = new Sample[xfade_frames];
                _timeline_position = header_position_offset;
@@ -182,22 +249,45 @@ SndFileSource::init_sndfile ()
        AudioFileSource::HeaderPositionOffsetChanged.connect_same_thread (header_position_connection, boost::bind (&SndFileSource::handle_header_position_change, this));
 }
 
+void
+SndFileSource::close ()
+{
+       if (_sndfile) {
+               sf_close (_sndfile);
+               _sndfile = 0;
+               file_closed ();
+       }
+}
+
 int
 SndFileSource::open ()
 {
-       string path_to_open;
+       if (_sndfile) {
+               return 0;
+       }
 
+// We really only want to use g_open for all platforms but because of this
+// method(SndfileSource::open), the compiler(or at least GCC) is confused
+// because g_open will expand to "open" on non-POSIX systems and needs the
+// global namespace qualifer. The problem is since since C99 ::g_open will
+// apparently expand to ":: open"
 #ifdef PLATFORM_WINDOWS
-       path_to_open = Glib::locale_from_utf8(_path);
+       int fd = g_open (_path.c_str(), writable() ? O_CREAT | O_RDWR : O_RDONLY, writable() ? 0644 : 0444);
 #else
-       path_to_open = _path;
+       int fd = ::open (_path.c_str(), writable() ? O_CREAT | O_RDWR : O_RDONLY, writable() ? 0644 : 0444);
 #endif
 
-       _descriptor = new SndFileDescriptor (path_to_open.c_str(), writable(), &_info);
-       _descriptor->Closed.connect_same_thread (file_manager_connection, boost::bind (&SndFileSource::file_closed, this));
-       SNDFILE* sf = _descriptor->allocate ();
+       if (fd == -1) {
+               error << string_compose (
+                            _ ("SndFileSource: cannot open file \"%1\" for %2"),
+                            _path,
+                            (writable () ? "read+write" : "reading")) << endmsg;
+               return -1;
+       }
+
+       _sndfile = sf_open_fd (fd, writable() ? SFM_RDWR : SFM_READ, &_info, true);
 
-       if (sf == 0) {
+       if (_sndfile == 0) {
                char errbuf[1024];
                sf_error_str (0, errbuf, sizeof (errbuf) - 1);
 #ifndef HAVE_COREAUDIO
@@ -205,10 +295,10 @@ SndFileSource::open ()
                   so we don't want to see this message.
                */
 
-                cerr << "failed to open " << path_to_open << " with name " << _name << endl;
+                cerr << "failed to open " << _path << " with name " << _name << endl;
 
                error << string_compose(_("SndFileSource: cannot open file \"%1\" for %2 (%3)"),
-                                       path_to_open, (writable() ? "read+write" : "reading"), errbuf) << endmsg;
+                                       _path, (writable() ? "read+write" : "reading"), errbuf) << endmsg;
 #endif
                return -1;
        }
@@ -217,18 +307,31 @@ SndFileSource::open ()
 #ifndef HAVE_COREAUDIO
                error << string_compose(_("SndFileSource: file only contains %1 channels; %2 is invalid as a channel number"), _info.channels, _channel) << endmsg;
 #endif
-               delete _descriptor;
-               _descriptor = 0;
+               sf_close (_sndfile);
+               _sndfile = 0;
                return -1;
        }
 
        _length = _info.frames;
 
+#ifdef HAVE_RF64_RIFF
+       if (_file_is_new && _length == 0 && writable()) {
+               if (_flags & RF64_RIFF) {
+                       if (sf_command (_sndfile, SFC_RF64_AUTO_DOWNGRADE, 0, 0) != SF_TRUE) {
+                               char errbuf[256];
+                               sf_error_str (_sndfile, errbuf, sizeof (errbuf) - 1);
+                               error << string_compose (_("Cannot mark RF64 audio file for automatic downgrade to WAV: %1"), errbuf)
+                                     << endmsg;
+                       }
+               }
+       }
+#endif
+
        if (!_broadcast_info) {
                _broadcast_info = new BroadcastInfo;
        }
 
-       bool bwf_info_exists = _broadcast_info->load_from_file (sf);
+       bool bwf_info_exists = _broadcast_info->load_from_file (_sndfile);
 
        if (_file_is_new && _length == 0 && writable() && !bwf_info_exists) {
                /* newly created files will not have a BWF header at this point in time.
@@ -248,8 +351,16 @@ SndFileSource::open ()
                _flags = Flag (_flags & ~Broadcast);
        }
 
+       /* Set the broadcast flag if the BWF info is already there. We need
+        * this when recovering or using existing files.
+        */
+
+       if (bwf_info_exists) {
+               _flags = Flag (_flags | Broadcast);
+       }
+
        if (writable()) {
-               sf_command (sf, SFC_SET_UPDATE_HEADER_AUTO, 0, SF_FALSE);
+               sf_command (_sndfile, SFC_SET_UPDATE_HEADER_AUTO, 0, SF_FALSE);
 
                 if (_flags & Broadcast) {
 
@@ -260,9 +371,9 @@ SndFileSource::open ()
                         _broadcast_info->set_from_session (_session, header_position_offset);
                         _broadcast_info->set_description (string_compose ("BWF %1", _name));
 
-                        if (!_broadcast_info->write_to_file (sf)) {
+                        if (!_broadcast_info->write_to_file (_sndfile)) {
                                 error << string_compose (_("cannot set broadcast info for audio file %1 (%2); dropping broadcast info for this file"),
-                                                         path_to_open, _broadcast_info->get_error())
+                                                         _path, _broadcast_info->get_error())
                                       << endmsg;
                                 _flags = Flag (_flags & ~Broadcast);
                                 delete _broadcast_info;
@@ -271,14 +382,12 @@ SndFileSource::open ()
                 }
         }
 
-        _descriptor->release ();
-        _open = true;
        return 0;
 }
 
 SndFileSource::~SndFileSource ()
 {
-       delete _descriptor;
+       close ();
        delete _broadcast_info;
        delete [] xfade_buf;
 }
@@ -293,24 +402,22 @@ framecnt_t
 SndFileSource::read_unlocked (Sample *dst, framepos_t start, framecnt_t cnt) const
 {
        assert (cnt >= 0);
-       
-       int32_t nread;
+
+       framecnt_t nread;
        float *ptr;
-       uint32_t real_cnt;
+       framecnt_t real_cnt;
        framepos_t file_cnt;
 
-        if (writable() && !_open) {
+        if (writable() && !_sndfile) {
                 /* file has not been opened yet - nothing written to it */
                 memset (dst, 0, sizeof (Sample) * cnt);
                 return cnt;
         }
 
-       SNDFILE* sf = _descriptor->allocate ();
-
-       if (sf == 0) {
-               error << string_compose (_("could not allocate file %1 for reading."), _path) << endmsg;
+        if (const_cast<SndFileSource*>(this)->open()) {
+               error << string_compose (_("could not open file %1 for reading."), _path) << endmsg;
                return 0;
-       }
+        }
 
        if (start > _length) {
 
@@ -340,22 +447,20 @@ SndFileSource::read_unlocked (Sample *dst, framepos_t start, framecnt_t cnt) con
 
        if (file_cnt) {
 
-               if (sf_seek (sf, (sf_count_t) start, SEEK_SET|SFM_READ) != (sf_count_t) start) {
+               if (sf_seek (_sndfile, (sf_count_t) start, SEEK_SET|SFM_READ) != (sf_count_t) start) {
                        char errbuf[256];
                        sf_error_str (0, errbuf, sizeof (errbuf) - 1);
                        error << string_compose(_("SndFileSource: could not seek to frame %1 within %2 (%3)"), start, _name.val().substr (1), errbuf) << endmsg;
-                       _descriptor->release ();
                        return 0;
                }
 
                if (_info.channels == 1) {
-                       framecnt_t ret = sf_read_float (sf, dst, file_cnt);
+                       framecnt_t ret = sf_read_float (_sndfile, dst, file_cnt);
                        if (ret != file_cnt) {
                                char errbuf[256];
                                sf_error_str (0, errbuf, sizeof (errbuf) - 1);
                                error << string_compose(_("SndFileSource: @ %1 could not read %2 within %3 (%4) (len = %5, ret was %6)"), start, file_cnt, _name.val().substr (1), errbuf, _length, ret) << endl;
                        }
-                       _descriptor->release ();
                        return ret;
                }
        }
@@ -364,25 +469,24 @@ SndFileSource::read_unlocked (Sample *dst, framepos_t start, framecnt_t cnt) con
 
        Sample* interleave_buf = get_interleave_buffer (real_cnt);
 
-       nread = sf_read_float (sf, interleave_buf, real_cnt);
+       nread = sf_read_float (_sndfile, interleave_buf, real_cnt);
        ptr = interleave_buf + _channel;
        nread /= _info.channels;
 
        /* stride through the interleaved data */
 
-       for (int32_t n = 0; n < nread; ++n) {
+       for (framecnt_t n = 0; n < nread; ++n) {
                dst[n] = *ptr;
                ptr += _info.channels;
        }
 
-       _descriptor->release ();
        return nread;
 }
 
 framecnt_t
 SndFileSource::write_unlocked (Sample *data, framecnt_t cnt)
 {
-        if (!_open && open()) {
+        if (open()) {
                 return 0; // failure
         }
 
@@ -403,11 +507,11 @@ SndFileSource::nondestructive_write_unlocked (Sample *data, framecnt_t cnt)
 
        if (_info.channels != 1) {
                fatal << string_compose (_("programming error: %1 %2"), X_("SndFileSource::write called on non-mono file"), _path) << endmsg;
-               /*NOTREACHED*/
+               abort(); /*NOTREACHED*/
                return 0;
        }
 
-       int32_t frame_pos = _length;
+       framepos_t frame_pos = _length;
 
        if (write_float (data, frame_pos, cnt) != cnt) {
                return 0;
@@ -416,7 +520,7 @@ SndFileSource::nondestructive_write_unlocked (Sample *data, framecnt_t cnt)
        update_length (_length + cnt);
 
        if (_build_peakfiles) {
-               compute_and_write_peaks (data, frame_pos, cnt, false, true);
+               compute_and_write_peaks (data, frame_pos, cnt, true, true);
        }
 
        return cnt;
@@ -503,7 +607,7 @@ SndFileSource::destructive_write_unlocked (Sample* data, framecnt_t cnt)
        update_length (file_pos + cnt);
 
        if (_build_peakfiles) {
-               compute_and_write_peaks (data, file_pos, cnt, false, true);
+               compute_and_write_peaks (data, file_pos, cnt, true, true);
        }
 
        file_pos += cnt;
@@ -533,19 +637,12 @@ SndFileSource::flush_header ()
                return -1;
        }
 
-        if (!_open) {
-               warning << string_compose (_("attempt to flush an un-opened audio file source (%1)"), _path) << endmsg;
-               return -1;
-        }
-
-       SNDFILE* sf = _descriptor->allocate ();
-       if (sf == 0) {
+       if (_sndfile == 0) {
                error << string_compose (_("could not allocate file %1 to write header"), _path) << endmsg;
                return -1;
        }
 
-       int const r = sf_command (sf, SFC_UPDATE_HEADER_NOW, 0, 0) != SF_TRUE;
-       _descriptor->release ();
+       int const r = sf_command (_sndfile, SFC_UPDATE_HEADER_NOW, 0, 0) != SF_TRUE;
 
        return r;
 }
@@ -553,25 +650,18 @@ SndFileSource::flush_header ()
 void
 SndFileSource::flush ()
 {
-       if (!_open) {
-               warning << string_compose (_("attempt to flush an un-opened audio file source (%1)"), _path) << endmsg;
-               return;
-       }
-
        if (!writable()) {
                warning << string_compose (_("attempt to flush a non-writable audio file source (%1)"), _path) << endmsg;
                return;
        }
 
-       SNDFILE* sf = _descriptor->allocate ();
-       if (sf == 0) {
+       if (_sndfile == 0) {
                error << string_compose (_("could not allocate file %1 to flush contents"), _path) << endmsg;
                return;
        }
 
        // Hopefully everything OK
-       sf_write_sync (sf);
-       _descriptor->release ();
+       sf_write_sync (_sndfile);
 }
 
 int
@@ -582,12 +672,12 @@ SndFileSource::setup_broadcast_info (framepos_t /*when*/, struct tm& now, time_t
                return -1;
        }
 
-        if (!_open) {
+        if (!_sndfile) {
                warning << string_compose (_("attempt to set BWF info for an un-opened audio file source (%1)"), _path) << endmsg;
                return -1;
         }
 
-       if (!(_flags & Broadcast)) {
+       if (!(_flags & Broadcast) || !_broadcast_info) {
                return 0;
        }
 
@@ -598,18 +688,6 @@ SndFileSource::setup_broadcast_info (framepos_t /*when*/, struct tm& now, time_t
 
        set_header_timeline_position ();
 
-       SNDFILE* sf = _descriptor->allocate ();
-
-       if (sf == 0 || !_broadcast_info->write_to_file (sf)) {
-               error << string_compose (_("cannot set broadcast info for audio file %1 (%2); dropping broadcast info for this file"),
-                                          _path, _broadcast_info->get_error())
-                     << endmsg;
-               _flags = Flag (_flags & ~Broadcast);
-               delete _broadcast_info;
-               _broadcast_info = 0;
-       }
-
-       _descriptor->release ();
        return 0;
 }
 
@@ -619,12 +697,11 @@ SndFileSource::set_header_timeline_position ()
        if (!(_flags & Broadcast)) {
                return;
        }
+       assert (_broadcast_info);
 
        _broadcast_info->set_time_reference (_timeline_position);
 
-       SNDFILE* sf = _descriptor->allocate ();
-       
-       if (sf == 0 || !_broadcast_info->write_to_file (sf)) {
+       if (_sndfile == 0 || !_broadcast_info->write_to_file (_sndfile)) {
                error << string_compose (_("cannot set broadcast info for audio file %1 (%2); dropping broadcast info for this file"),
                                           _path, _broadcast_info->get_error())
                      << endmsg;
@@ -632,29 +709,22 @@ SndFileSource::set_header_timeline_position ()
                delete _broadcast_info;
                _broadcast_info = 0;
        }
-
-       _descriptor->release ();
 }
 
 framecnt_t
 SndFileSource::write_float (Sample* data, framepos_t frame_pos, framecnt_t cnt)
 {
-       SNDFILE* sf = _descriptor->allocate ();
-
-       if (sf == 0 || sf_seek (sf, frame_pos, SEEK_SET|SFM_WRITE) < 0) {
+       if (_sndfile == 0 || sf_seek (_sndfile, frame_pos, SEEK_SET|SFM_WRITE) < 0) {
                char errbuf[256];
                sf_error_str (0, errbuf, sizeof (errbuf) - 1);
                error << string_compose (_("%1: cannot seek to %2 (libsndfile error: %3)"), _path, frame_pos, errbuf) << endmsg;
-               _descriptor->release ();
                return 0;
        }
 
-       if (sf_writef_float (sf, data, cnt) != (ssize_t) cnt) {
-               _descriptor->release ();
+       if (sf_writef_float (_sndfile, data, cnt) != (ssize_t) cnt) {
                return 0;
        }
 
-       _descriptor->release ();
        return cnt;
 }
 
@@ -898,8 +968,23 @@ SndFileSource::get_soundfile_info (const string& path, SoundFileInfo& info, stri
 
        sf_info.format = 0; // libsndfile says to clear this before sf_open().
 
-       if ((sf = sf_open (const_cast<char*>(path.c_str()), SFM_READ, &sf_info)) == 0) {
-               char errbuf[256];
+       if (path.empty() || Glib::file_test(path, Glib::FILE_TEST_IS_DIR)) {
+               return false;
+       }
+
+#ifdef PLATFORM_WINDOWS
+       int fd = g_open (path.c_str(), O_RDONLY, 0444);
+#else
+       int fd = ::open (path.c_str(), O_RDONLY, 0444);
+#endif
+
+       if (fd == -1) {
+               error << string_compose ( _("SndFileSource: cannot open file \"%1\" for reading"), path)
+                     << endmsg;
+               return false;
+       }
+       if ((sf = sf_open_fd (fd, SFM_READ, &sf_info, true)) == 0) {
+               char errbuf[1024];
                error_msg = sf_error_str (0, errbuf, sizeof (errbuf) - 1);
                return false;
        }
@@ -955,8 +1040,5 @@ void
 SndFileSource::set_path (const string& p)
 {
         FileSource::set_path (p);
-
-        if (_descriptor) {
-                _descriptor->set_path (_path);
-        }
 }
+