Fix broken whitespace. I'd apologize for the compile times if it was my fault :D
[ardour.git] / libs / ardour / sndfilesource.cc
index 05de692016117e465ebd1b9388f853163744bd6b..7006c6c7eb2464a37de125c92e51920dec1d0e7a 100644 (file)
@@ -44,7 +44,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 +67,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 +82,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,38 +144,19 @@ SndFileSource::SndFileSource (Session& s, const ustring& path,
        _info.samplerate = rate;
        _info.format = fmt;
 
-       if (open()) {
-               throw failed_constructor();
-       }
-
-       if (writable() && (_flags & Broadcast)) {
-
-               if (!_broadcast_info) {
-                       _broadcast_info = new BroadcastInfo;
-               }
-
-               _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;
-               }
-       }
+        /* 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;
-       sf = 0;
        _broadcast_info = 0;
 
        /* although libsndfile says we don't need to set this,
@@ -198,7 +180,11 @@ SndFileSource::init_sndfile ()
 int
 SndFileSource::open ()
 {
-       if ((sf = sf_open (_path.c_str(), (writable() ? SFM_RDWR : SFM_READ), &_info)) == 0) {
+       _descriptor = new SndFileDescriptor (_path, 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];
                sf_error_str (0, errbuf, sizeof (errbuf) - 1);
 #ifndef HAVE_COREAUDIO
@@ -206,6 +192,8 @@ SndFileSource::open ()
                   so we don't want to see this message.
                */
 
+                cerr << "failed to open " << _path << " with name " << _name << endl;
+
                error << string_compose(_("SndFileSource: cannot open file \"%1\" for %2 (%3)"),
                                        _path, (writable() ? "read+write" : "reading"), errbuf) << endmsg;
 #endif
@@ -216,8 +204,8 @@ 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
-               sf_close (sf);
-               sf = 0;
+               delete _descriptor;
+               _descriptor = 0;
                return -1;
        }
 
@@ -239,26 +227,35 @@ SndFileSource::open ()
 
        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())
+                                      << endmsg;
+                                _flags = Flag (_flags & ~Broadcast);
+                                delete _broadcast_info;
+                                _broadcast_info = 0;
+                        }
+                }
+        }
+
+        _descriptor->release ();
+        _open = true;
        return 0;
 }
 
 SndFileSource::~SndFileSource ()
 {
-       if (sf) {
-               sf_close (sf);
-               sf = 0;
-
-               /* stupid libsndfile updated the headers on close,
-                  so touch the peakfile if it exists and has data
-                  to make sure its time is as new as the audio
-                  file.
-               */
-
-               touch_peakfile ();
-       }
-
+       delete _descriptor;
        delete _broadcast_info;
        delete [] xfade_buf;
 }
@@ -277,6 +274,19 @@ SndFileSource::read_unlocked (Sample *dst, framepos_t start, framecnt_t cnt) con
        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;
+       }
+
        if (start > _length) {
 
                /* read starts beyond end of data, just memset to zero */
@@ -307,17 +317,19 @@ SndFileSource::read_unlocked (Sample *dst, framepos_t start, framecnt_t cnt) con
                        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) {
-                       nframes_t ret = sf_read_float (sf, dst, file_cnt);
+                       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);
-                               cerr << 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)"), start, file_cnt, _name.val().substr (1), errbuf, _length) << endl;
                        }
+                       _descriptor->release ();
                        return ret;
                }
        }
@@ -339,12 +351,17 @@ SndFileSource::read_unlocked (Sample *dst, framepos_t start, framecnt_t cnt) con
 
        _read_data_count = cnt * sizeof(float);
 
+       _descriptor->release ();
        return nread;
 }
 
 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 {
@@ -408,8 +425,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) {
@@ -478,7 +495,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);
 
@@ -494,33 +511,55 @@ SndFileSource::update_header (sframes_t when, struct tm& now, time_t tnow)
 int
 SndFileSource::flush_header ()
 {
-       if (!writable() || (sf == 0)) {
+       if (!writable()) {
                warning << string_compose (_("attempt to flush a non-writable audio file source (%1)"), _path) << endmsg;
                return -1;
        }
-       return (sf_command (sf, SFC_UPDATE_HEADER_NOW, 0, 0) != SF_TRUE);
+
+        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;
 }
 
 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;
        }
 
-       _broadcast_info->set_originator_ref (_session);
+       _broadcast_info->set_originator_ref_from_session (_session);
        _broadcast_info->set_origination_time (&now);
 
        /* now update header position taking header offset into account */
 
        set_header_timeline_position ();
 
-       if (!_broadcast_info->write_to_file (sf)) {
+       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;
@@ -529,6 +568,7 @@ SndFileSource::setup_broadcast_info (sframes_t /*when*/, struct tm& now, time_t
                _broadcast_info = 0;
        }
 
+       _descriptor->release ();
        return 0;
 }
 
@@ -541,7 +581,9 @@ SndFileSource::set_header_timeline_position ()
 
        _broadcast_info->set_time_reference (_timeline_position);
 
-       if (!_broadcast_info->write_to_file (sf)) {
+       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;
@@ -549,22 +591,29 @@ 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)
 {
-       if (sf_seek (sf, frame_pos, SEEK_SET|SFM_WRITE) < 0) {
+       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;
+               _descriptor->release ();
                return 0;
        }
 
        if (sf_writef_float (sf, data, cnt) != (ssize_t) cnt) {
+               _descriptor->release ();
                return 0;
        }
 
+       _descriptor->release ();
        return cnt;
 }
 
@@ -578,7 +627,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];
                }
@@ -600,8 +649,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) {
@@ -720,7 +770,7 @@ SndFileSource::crossfade (Sample* data, framecnt_t cnt, int fade_in)
                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 */
@@ -744,7 +794,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()) {
@@ -769,7 +819,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.
@@ -787,7 +837,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
@@ -799,7 +849,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;
@@ -816,9 +866,15 @@ 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;
-       info.format_name = string_compose("Format: %1, %2",
-                                          sndfile_major_format(sf_info.format),
-                                          sndfile_minor_format(sf_info.format));
+
+        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 {
+                info.format_name = string_compose("%1\n%2", major, minor);
+        }
 
        info.timecode = binfo.load_from_file (sf) ? binfo.get_time_reference() : 0;
 
@@ -833,3 +889,33 @@ SndFileSource::one_of_several_channels () const
        return _info.channels > 1;
 }
 
+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 && type != SF_FORMAT_OGG);
+}
+
+void
+SndFileSource::file_closed ()
+{
+       /* stupid libsndfile updated the headers on close,
+          so touch the peakfile if it exists and has data
+          to make sure its time is as new as the audio
+          file.
+       */
+
+       touch_peakfile ();
+}
+
+void
+SndFileSource::set_path (const string& p)
+{
+        FileSource::set_path (p);
+
+        if (_descriptor) {
+                _descriptor->set_path (_path);
+        }
+}