Merge branch 'master' into windows
[ardour.git] / libs / ardour / sndfilesource.cc
index 9ab647e98e55a02d6f985d5fa951d0b4ae6d8b05..1c3144f16421177f140b7da1753ec7bfaa8cf92f 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/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"
@@ -44,7 +43,7 @@
 using namespace std;
 using namespace ARDOUR;
 using namespace PBD;
-using Glib::ustring;
+using std::string;
 
 gain_t* SndFileSource::out_coefficient = 0;
 gain_t* SndFileSource::in_coefficient = 0;
@@ -67,8 +66,9 @@ SndFileSource::SndFileSource (Session& s, const XMLNode& node)
 }
 
 /** Files created this way are never writable or removable */
-SndFileSource::SndFileSource (Session& s, const ustring& path, int chn, Flag flags)
+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)))
 {
        _channel = chn;
@@ -81,14 +81,14 @@ SndFileSource::SndFileSource (Session& s, const ustring& path, int chn, Flag fla
 }
 
 /** This constructor is used to construct new files, not open existing ones. */
-SndFileSource::SndFileSource (Session& s, const ustring& path, 
-               SampleFormat sfmt, HeaderFormat hf, nframes_t rate, Flag flags)
+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, flags, sfmt, hf)
+       , AudioFileSource (s, path, origin, flags, sfmt, hf)
 {
        int fmt = 0;
 
-       init_sndfile ();
+        init_sndfile ();
 
        _file_is_new = true;
 
@@ -143,42 +143,22 @@ SndFileSource::SndFileSource (Session& s, const ustring& path,
        _info.samplerate = rate;
        _info.format = fmt;
 
-       if (open()) {
-               throw failed_constructor();
-       }
-
-       if (writable() && (_flags & Broadcast)) {
-
-               SNDFILE* sf = _descriptor->allocate ();
-               if (sf == 0) {
-                       error << string_compose (_("could not allocate file %1"), _path) << endmsg;
-                       throw failed_constructor ();
-               }
-
-               if (!_broadcast_info) {
-                       _broadcast_info = new BroadcastInfo;
+       if (_flags & Destructive) {
+               if (open()) {
+                       throw failed_constructor();
                }
-
-               _broadcast_info->set_from_session (s, 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())
-                             << endmsg;
-                       _flags = Flag (_flags & ~Broadcast);
-                       delete _broadcast_info;
-                       _broadcast_info = 0;
-               }
-
-               _descriptor->release ();
+       } else {
+               /* normal mode: do not open the file here - do that in write_unlocked() as needed
+                */
        }
 }
 
 void
 SndFileSource::init_sndfile ()
 {
-       ustring file;
+       string file;
+
+        _descriptor = 0;
 
        // lets try to keep the object initalizations here at the top
        xfade_buf = 0;
@@ -205,20 +185,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_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;
        }
@@ -240,6 +230,16 @@ 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) {
@@ -250,9 +250,29 @@ SndFileSource::open ()
 
        if (writable()) {
                sf_command (sf, SFC_SET_UPDATE_HEADER_AUTO, 0, SF_FALSE);
-       }
 
-       _descriptor->release ();
+                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_to_open, _broadcast_info->get_error())
+                                      << endmsg;
+                                _flags = Flag (_flags & ~Broadcast);
+                                delete _broadcast_info;
+                                _broadcast_info = 0;
+                        }
+                }
+        }
+
+        _descriptor->release ();
+        _open = true;
        return 0;
 }
 
@@ -272,12 +292,21 @@ 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;
        framepos_t file_cnt;
 
+        if (writable() && !_open) {
+                /* 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;
                return 0;
@@ -302,6 +331,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);
@@ -318,12 +349,11 @@ SndFileSource::read_unlocked (Sample *dst, framepos_t start, framecnt_t cnt) con
                }
 
                if (_info.channels == 1) {
-                       nframes_t ret = sf_read_float (sf, dst, file_cnt);
-                       _read_data_count = ret * sizeof(float);
+                       framecnt_t ret = sf_read_float (sf, 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)"), 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;
@@ -345,8 +375,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;
 }
@@ -354,6 +382,10 @@ SndFileSource::read_unlocked (Sample *dst, framepos_t start, framecnt_t cnt) con
 framecnt_t
 SndFileSource::write_unlocked (Sample *data, framecnt_t cnt)
 {
+        if (!_open && open()) {
+                return 0; // failure
+        }
+
        if (destructive()) {
                return destructive_write_unlocked (data, cnt);
        } else {
@@ -375,30 +407,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;
@@ -417,8 +443,8 @@ SndFileSource::destructive_write_unlocked (Sample* data, framecnt_t cnt)
                file_pos = capture_start_frame - _timeline_position;
 
                // split cnt in half
-               nframes_t subcnt = cnt / 2;
-               nframes_t ofilepos = file_pos;
+               framecnt_t subcnt = cnt / 2;
+               framecnt_t ofilepos = file_pos;
 
                // fade in
                if (crossfade (data, subcnt, 1) != subcnt) {
@@ -474,8 +500,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);
@@ -487,7 +512,7 @@ SndFileSource::destructive_write_unlocked (Sample* data, framecnt_t cnt)
 }
 
 int
-SndFileSource::update_header (sframes_t when, struct tm& now, time_t tnow)
+SndFileSource::update_header (framepos_t when, struct tm& now, time_t tnow)
 {
        set_timeline_position (when);
 
@@ -508,26 +533,60 @@ 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) {
                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 (sframes_t /*when*/, struct tm& now, time_t /*tnow*/)
+SndFileSource::setup_broadcast_info (framepos_t /*when*/, struct tm& now, time_t /*tnow*/)
 {
        if (!writable()) {
                warning << string_compose (_("attempt to store broadcast info in a non-writable audio file source (%1)"), _path) << endmsg;
                return -1;
        }
 
+        if (!_open) {
+               warning << string_compose (_("attempt to set BWF info for an un-opened audio file source (%1)"), _path) << endmsg;
+               return -1;
+        }
+
        if (!(_flags & Broadcast)) {
                return 0;
        }
@@ -581,11 +640,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;
        }
@@ -609,7 +668,7 @@ bool
 SndFileSource::set_destructive (bool yn)
 {
        if (yn) {
-               _flags = Flag (_flags | Destructive);
+               _flags = Flag (_flags | Writable | Destructive);
                if (!xfade_buf) {
                        xfade_buf = new Sample[xfade_frames];
                }
@@ -631,8 +690,9 @@ SndFileSource::clear_capture_marks ()
        _capture_end = false;
 }
 
+/** @param pos Capture start position in session frames */
 void
-SndFileSource::mark_capture_start (sframes_t pos)
+SndFileSource::mark_capture_start (framepos_t pos)
 {
        if (destructive()) {
                if (pos < _timeline_position) {
@@ -741,17 +801,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 */
@@ -775,7 +835,7 @@ SndFileSource::crossfade (Sample* data, framecnt_t cnt, int fade_in)
        return cnt;
 }
 
-sframes_t
+framepos_t
 SndFileSource::last_capture_start_frame () const
 {
        if (destructive()) {
@@ -800,7 +860,7 @@ SndFileSource::handle_header_position_change ()
 }
 
 void
-SndFileSource::setup_standard_crossfades (Session const & s, nframes_t rate)
+SndFileSource::setup_standard_crossfades (Session const & s, framecnt_t rate)
 {
        /* This static method is assumed to have been called by the Session
           before any DFS's are created.
@@ -818,7 +878,7 @@ SndFileSource::setup_standard_crossfades (Session const & s, nframes_t rate)
 }
 
 void
-SndFileSource::set_timeline_position (int64_t pos)
+SndFileSource::set_timeline_position (framepos_t pos)
 {
        // destructive track timeline postion does not change
        // except at instantion or when header_position_offset
@@ -830,7 +890,7 @@ SndFileSource::set_timeline_position (int64_t pos)
 }
 
 int
-SndFileSource::get_soundfile_info (const ustring& path, SoundFileInfo& info, string& error_msg)
+SndFileSource::get_soundfile_info (const string& path, SoundFileInfo& info, string& error_msg)
 {
        SNDFILE *sf;
        SF_INFO sf_info;
@@ -838,7 +898,7 @@ SndFileSource::get_soundfile_info (const ustring& path, SoundFileInfo& info, str
 
        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;
@@ -847,10 +907,10 @@ SndFileSource::get_soundfile_info (const ustring& path, SoundFileInfo& info, str
        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 {
@@ -873,9 +933,10 @@ SndFileSource::one_of_several_channels () const
 bool
 SndFileSource::clamped_at_unity () const
 {
+       int const type = _info.format & SF_FORMAT_TYPEMASK;
        int const sub = _info.format & SF_FORMAT_SUBMASK;
        /* XXX: this may not be the full list of formats that are unclamped */
-       return (sub != SF_FORMAT_FLOAT && sub != SF_FORMAT_DOUBLE);
+       return (sub != SF_FORMAT_FLOAT && sub != SF_FORMAT_DOUBLE && type != SF_FORMAT_OGG);
 }
 
 void
@@ -886,7 +947,7 @@ SndFileSource::file_closed ()
           to make sure its time is as new as the audio
           file.
        */
-       
+
        touch_peakfile ();
 }