refactor MIDISceneChange color property addition by moving it into SceneChange to...
[ardour.git] / libs / ardour / sndfilesource.cc
index 8fad3b37059873a1c1d291ada94d4859d7ccb509..58fbab233b3f05bfa1d355a2817caa90e15529f5 100644 (file)
 #include <climits>
 #include <cstdarg>
 
-#include <pwd.h>
-#include <sys/utsname.h>
 #include <sys/stat.h>
 
+#ifdef PLATFORM_WINDOWS
+#include <glibmm/convert.h>
+#endif
+#include <glibmm/fileutils.h>
 #include <glibmm/miscutils.h>
 
 #include "ardour/sndfilesource.h"
 #include "ardour/sndfile_helpers.h"
 #include "ardour/utils.h"
-#include "ardour/version.h"
-#include "ardour/rc_configuration.h"
 #include "ardour/session.h"
 
 #include "i18n.h"
@@ -58,39 +58,70 @@ const Source::Flag SndFileSource::default_writable_flags = Source::Flag (
 SndFileSource::SndFileSource (Session& s, const XMLNode& node)
        : Source(s, node)
        , AudioFileSource (s, node)
+       , _descriptor (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)))
+       , _descriptor (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)
+       , _descriptor (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) {
@@ -143,32 +174,54 @@ SndFileSource::SndFileSource (Session& s, const string& path, const string& orig
        _info.channels = 1;
        _info.samplerate = rate;
        _info.format = fmt;
-        
-        /* do not open the file here - do that in write_unlocked() as needed
-         */
+
+       if (_flags & Destructive) {
+               if (open()) {
+                       throw failed_constructor();
+               }
+       } else {
+               /* normal mode: do not open the file here - do that in 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))
+       , _descriptor (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;
@@ -180,22 +233,30 @@ SndFileSource::init_sndfile ()
 int
 SndFileSource::open ()
 {
-       _descriptor = new SndFileDescriptor (_path, writable(), &_info);
+       string path_to_open;
+
+#ifdef PLATFORM_WINDOWS
+       path_to_open = Glib::locale_from_utf8(_path);
+#else
+       path_to_open = _path;
+#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 (sf == 0) {
-               char errbuf[256];
+               char errbuf[1024];
                sf_error_str (0, errbuf, sizeof (errbuf) - 1);
 #ifndef HAVE_COREAUDIO
                /* if we have CoreAudio, we will be falling back to that if libsndfile fails,
                   so we don't want to see this message.
                */
 
-                cerr << "failed to open " << _path << " with name " << _name << endl;
+                cerr << "failed to open " << path_to_open << " with name " << _name << endl;
 
                error << string_compose(_("SndFileSource: cannot open file \"%1\" for %2 (%3)"),
-                                       _path, (writable() ? "read+write" : "reading"), errbuf) << endmsg;
+                                       path_to_open, (writable() ? "read+write" : "reading"), errbuf) << endmsg;
 #endif
                return -1;
        }
@@ -217,29 +278,47 @@ SndFileSource::open ()
 
        bool bwf_info_exists = _broadcast_info->load_from_file (sf);
 
+       if (_file_is_new && _length == 0 && writable() && !bwf_info_exists) {
+               /* newly created files will not have a BWF header at this point in time.
+                * Import will have called Source::set_timeline_position() if one exists
+                * in the original. */
+               header_position_offset = _timeline_position;
+       }
+
+       /* Set our timeline position to either the time reference from a BWF header or the current
+          start of the session.
+       */
        set_timeline_position (bwf_info_exists ? _broadcast_info->get_time_reference() : header_position_offset);
 
        if (_length != 0 && !bwf_info_exists) {
                delete _broadcast_info;
                _broadcast_info = 0;
                _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);
-                
+
                 if (_flags & Broadcast) {
-                        
+
                         if (!_broadcast_info) {
                                 _broadcast_info = new BroadcastInfo;
                         }
-                        
+
                         _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)) {
                                 error << string_compose (_("cannot set broadcast info for audio file %1 (%2); dropping broadcast info for this file"),
-                                                         _path, _broadcast_info->get_error())
+                                                         path_to_open, _broadcast_info->get_error())
                                       << endmsg;
                                 _flags = Flag (_flags & ~Broadcast);
                                 delete _broadcast_info;
@@ -269,6 +348,8 @@ SndFileSource::sample_rate () const
 framecnt_t
 SndFileSource::read_unlocked (Sample *dst, framepos_t start, framecnt_t cnt) const
 {
+       assert (cnt >= 0);
+       
        int32_t nread;
        float *ptr;
        uint32_t real_cnt;
@@ -306,6 +387,8 @@ SndFileSource::read_unlocked (Sample *dst, framepos_t start, framecnt_t cnt) con
                file_cnt = cnt;
        }
 
+       assert (file_cnt >= 0);
+
        if (file_cnt != cnt) {
                framepos_t delta = cnt - file_cnt;
                memset (dst+file_cnt, 0, sizeof (Sample) * delta);
@@ -323,11 +406,10 @@ SndFileSource::read_unlocked (Sample *dst, framepos_t start, framecnt_t cnt) con
 
                if (_info.channels == 1) {
                        framecnt_t ret = sf_read_float (sf, dst, file_cnt);
-                       _read_data_count = ret * sizeof(float);
                        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)"), start, file_cnt, _name.val().substr (1), errbuf, _length) << endl;
+                               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;
@@ -349,8 +431,6 @@ SndFileSource::read_unlocked (Sample *dst, framepos_t start, framecnt_t cnt) con
                ptr += _info.channels;
        }
 
-       _read_data_count = cnt * sizeof(float);
-
        _descriptor->release ();
        return nread;
 }
@@ -383,30 +463,24 @@ SndFileSource::nondestructive_write_unlocked (Sample *data, framecnt_t cnt)
                return 0;
        }
 
-       framecnt_t oldlen;
        int32_t frame_pos = _length;
 
        if (write_float (data, frame_pos, cnt) != cnt) {
                return 0;
        }
 
-       oldlen = _length;
-       update_length (oldlen, cnt);
+       update_length (_length + cnt);
 
        if (_build_peakfiles) {
                compute_and_write_peaks (data, frame_pos, cnt, false, true);
        }
 
-       _write_data_count = cnt;
-
        return cnt;
 }
 
 framecnt_t
 SndFileSource::destructive_write_unlocked (Sample* data, framecnt_t cnt)
 {
-       framepos_t old_file_pos;
-
        if (!writable()) {
                warning << string_compose (_("attempt to write a non-writable audio file source (%1)"), _path) << endmsg;
                return 0;
@@ -482,8 +556,7 @@ SndFileSource::destructive_write_unlocked (Sample* data, framecnt_t cnt)
                }
        }
 
-       old_file_pos = file_pos;
-       update_length (file_pos, cnt);
+       update_length (file_pos + cnt);
 
        if (_build_peakfiles) {
                compute_and_write_peaks (data, file_pos, cnt, false, true);
@@ -526,13 +599,37 @@ SndFileSource::flush_header ()
                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 ();
 
        return r;
 }
 
+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) {
+               error << string_compose (_("could not allocate file %1 to flush contents"), _path) << endmsg;
+               return;
+       }
+
+       // Hopefully everything OK
+       sf_write_sync (sf);
+       _descriptor->release ();
+}
+
 int
 SndFileSource::setup_broadcast_info (framepos_t /*when*/, struct tm& now, time_t /*tnow*/)
 {
@@ -599,11 +696,11 @@ 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) {
                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;
+               error << string_compose (_("%1: cannot seek to %2 (libsndfile error: %3)"), _path, frame_pos, errbuf) << endmsg;
                _descriptor->release ();
                return 0;
        }
@@ -760,17 +857,17 @@ SndFileSource::crossfade (Sample* data, framecnt_t cnt, int fade_in)
 
        } else if (xfade < xfade_frames) {
 
-               gain_t in[xfade];
-               gain_t out[xfade];
+               std::vector<gain_t> in(xfade);
+               std::vector<gain_t> out(xfade);
 
                /* short xfade, compute custom curve */
 
-               compute_equal_power_fades (xfade, in, out);
+               compute_equal_power_fades (xfade, &in[0], &out[0]);
 
                for (framecnt_t n = 0; n < xfade; ++n) {
                        xfade_buf[n] = (xfade_buf[n] * out[n]) + (fade_data[n] * in[n]);
                }
-               
+
        } else if (xfade) {
 
                /* long xfade length, has to be computed across several calls */
@@ -857,7 +954,7 @@ 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 ((char*) path.c_str(), SFM_READ, &sf_info)) == 0) {
+       if ((sf = sf_open (const_cast<char*>(path.c_str()), SFM_READ, &sf_info)) == 0) {
                char errbuf[256];
                error_msg = sf_error_str (0, errbuf, sizeof (errbuf) - 1);
                return false;
@@ -866,10 +963,10 @@ SndFileSource::get_soundfile_info (const string& path, SoundFileInfo& info, stri
        info.samplerate  = sf_info.samplerate;
        info.channels    = sf_info.channels;
        info.length      = sf_info.frames;
-        
+
         string major = sndfile_major_format(sf_info.format);
         string minor = sndfile_minor_format(sf_info.format);
-        
+
         if (major.length() + minor.length() < 16) { /* arbitrary */
                 info.format_name = string_compose("%1/%2", major, minor);
         } else {
@@ -906,7 +1003,7 @@ SndFileSource::file_closed ()
           to make sure its time is as new as the audio
           file.
        */
-       
+
        touch_peakfile ();
 }
 
@@ -919,3 +1016,12 @@ SndFileSource::set_path (const string& p)
                 _descriptor->set_path (_path);
         }
 }
+
+void
+SndFileSource::release_descriptor ()
+{
+       if (_descriptor) {
+               _descriptor->release ();
+               _descriptor = 0;
+       }
+}