fix LTC slave latency compensation typo
[ardour.git] / libs / ardour / sndfilesource.cc
index 20d6067c36f745b3294cff5c30327585cc8a3822..ca2544054cc9b8e12d59ba59c220830b64d26729 100644 (file)
@@ -35,8 +35,6 @@
 #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"
@@ -89,7 +87,7 @@ SndFileSource::SndFileSource (Session& s, const string& path, const string& orig
 {
        int fmt = 0;
 
-       init_sndfile ();
+        init_sndfile ();
 
        _file_is_new = true;
 
@@ -144,35 +142,13 @@ SndFileSource::SndFileSource (Session& s, const string& path, const string& orig
        _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
+                */
        }
 }
 
@@ -181,6 +157,8 @@ SndFileSource::init_sndfile ()
 {
        string file;
 
+        _descriptor = 0;
+
        // lets try to keep the object initalizations here at the top
        xfade_buf = 0;
        _broadcast_info = 0;
@@ -209,7 +187,7 @@ SndFileSource::open ()
        _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);
@@ -243,6 +221,9 @@ SndFileSource::open ()
 
        bool bwf_info_exists = _broadcast_info->load_from_file (sf);
 
+       /* 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) {
@@ -253,9 +234,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, _broadcast_info->get_error())
+                                      << endmsg;
+                                _flags = Flag (_flags & ~Broadcast);
+                                delete _broadcast_info;
+                                _broadcast_info = 0;
+                        }
+                }
+        }
+
+        _descriptor->release ();
+        _open = true;
        return 0;
 }
 
@@ -275,12 +276,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;
@@ -305,6 +315,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);
@@ -322,11 +334,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;
@@ -348,8 +359,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;
 }
@@ -357,6 +366,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 {
@@ -378,30 +391,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;
@@ -477,8 +484,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);
@@ -511,12 +517,17 @@ 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 ();
 
@@ -531,6 +542,11 @@ SndFileSource::setup_broadcast_info (framepos_t /*when*/, struct tm& now, time_t
                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;
        }
@@ -584,7 +600,7 @@ 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);
@@ -755,7 +771,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 */
@@ -842,7 +858,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;
@@ -851,10 +867,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 {
@@ -891,7 +907,7 @@ SndFileSource::file_closed ()
           to make sure its time is as new as the audio
           file.
        */
-       
+
        touch_peakfile ();
 }