Merged with trunk R1141
[ardour.git] / libs / ardour / sndfilesource.cc
index fcc6a33d81623dcf5bce351c7f38ced42b3481a3..a30bfcf49b928383c23927f27443e0432bece818 100644 (file)
@@ -28,6 +28,8 @@
 #include <glibmm/miscutils.h>
 
 #include <ardour/sndfilesource.h>
+#include <ardour/sndfile_helpers.h>
+#include <ardour/utils.h>
 
 #include "i18n.h"
 
@@ -35,6 +37,14 @@ using namespace std;
 using namespace ARDOUR;
 using namespace PBD;
 
+gain_t* SndFileSource::out_coefficient = 0;
+gain_t* SndFileSource::in_coefficient = 0;
+nframes_t SndFileSource::xfade_frames = 64;
+const AudioFileSource::Flag SndFileSource::default_writable_flags = AudioFileSource::Flag (AudioFileSource::Writable|
+                                                                                          AudioFileSource::Removable|
+                                                                                          AudioFileSource::RemovableIfEmpty|
+                                                                                          AudioFileSource::CanRename);
+
 SndFileSource::SndFileSource (Session& s, const XMLNode& node)
        : AudioFileSource (s, node)
 {
@@ -164,22 +174,32 @@ SndFileSource::SndFileSource (Session& s, string idstr, SampleFormat sfmt, Heade
 }
 
 void 
-SndFileSource::init (const string& idstr)
+SndFileSource::init (string idstr)
 {
        string::size_type pos;
        string file;
 
+       // lets try to keep the object initalizations here at the top
+       xfade_buf = 0;
        interleave_buf = 0;
        interleave_bufsize = 0;
        sf = 0;
        _broadcast_info = 0;
 
+       string tmp_name;
+
        if ((pos = idstr.find_last_of (':')) == string::npos) {
                channel = 0;
-               _name = Glib::path_get_basename (idstr);
+               tmp_name = idstr;
        } else {
                channel = atoi (idstr.substr (pos+1).c_str());
-               _name = Glib::path_get_basename (idstr.substr (0, pos));
+               tmp_name = idstr.substr (0, pos);
+       }
+
+       if (is_embedded()) {
+               _name = tmp_name;
+       } else {
+               _name = Glib::path_get_basename (tmp_name);
        }
 
        /* although libsndfile says we don't need to set this,
@@ -187,6 +207,17 @@ SndFileSource::init (const string& idstr)
        */
 
        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;
+       }
+
+       AudioFileSource::HeaderPositionOffsetChanged.connect (mem_fun (*this, &SndFileSource::handle_header_position_change));
 }
 
 int
@@ -212,27 +243,14 @@ SndFileSource::open ()
        _broadcast_info = new SF_BROADCAST_INFO;
        memset (_broadcast_info, 0, sizeof (*_broadcast_info));
        
-       /* lookup broadcast info */
-       
-       if (sf_command (sf, SFC_GET_BROADCAST_INFO, _broadcast_info, sizeof (*_broadcast_info)) != SF_TRUE) {
-
-               /* if the file has data but no broadcast info, then clearly, there is no broadcast info */
-
-               if (_length) {
-                       delete _broadcast_info;
-                       _broadcast_info = 0;
-                       _flags = Flag (_flags & ~Broadcast);
-               }
-
-               set_timeline_position (header_position_offset);
+       bool timecode_info_exists;
 
-       } else {
-       
-               /* XXX 64 bit alert: when JACK switches to a 64 bit frame count, this needs to use the high bits
-                  of the time reference.
-               */
+       set_timeline_position (get_timecode_info (sf, _broadcast_info, timecode_info_exists));
 
-               set_timeline_position ( _broadcast_info->time_reference_low );
+       if (!timecode_info_exists) {
+               delete _broadcast_info;
+               _broadcast_info = 0;
+               _flags = Flag (_flags & ~Broadcast);
        }
 
        if (writable()) {
@@ -266,6 +284,10 @@ SndFileSource::~SndFileSource ()
        if (_broadcast_info) {
                delete _broadcast_info;
        }
+
+       if (xfade_buf) {
+               delete [] xfade_buf;
+       }
 }
 
 float
@@ -351,6 +373,16 @@ SndFileSource::read_unlocked (Sample *dst, nframes_t start, nframes_t cnt) const
 
 nframes_t 
 SndFileSource::write_unlocked (Sample *data, nframes_t cnt)
+{
+       if (destructive()) {
+               return destructive_write_unlocked (data, cnt);
+       } else {
+               return nondestructive_write_unlocked (data, cnt);
+       }
+}
+
+nframes_t 
+SndFileSource::nondestructive_write_unlocked (Sample *data, nframes_t cnt)
 {
        if (!writable()) {
                return 0;
@@ -403,6 +435,117 @@ SndFileSource::write_unlocked (Sample *data, nframes_t cnt)
        return cnt;
 }
 
+nframes_t
+SndFileSource::destructive_write_unlocked (Sample* data, nframes_t cnt)
+{
+       nframes_t old_file_pos;
+
+       if (!writable()) {
+               return 0;
+       }
+
+       if (_capture_start && _capture_end) {
+
+               /* start and end of capture both occur within the data we are writing,
+                  so do both crossfades.
+               */
+
+               _capture_start = false;
+               _capture_end = false;
+               
+               /* move to the correct location place */
+               file_pos = capture_start_frame - timeline_position;
+               
+               // split cnt in half
+               nframes_t subcnt = cnt / 2;
+               nframes_t ofilepos = file_pos;
+               
+               // fade in
+               if (crossfade (data, subcnt, 1) != subcnt) {
+                       return 0;
+               }
+               
+               file_pos += subcnt;
+               Sample * tmpdata = data + subcnt;
+               
+               // fade out
+               subcnt = cnt - subcnt;
+               if (crossfade (tmpdata, subcnt, 0) != subcnt) {
+                       return 0;
+               }
+               
+               file_pos = ofilepos; // adjusted below
+
+       } else if (_capture_start) {
+
+               /* start of capture both occur within the data we are writing,
+                  so do the fade in
+               */
+
+               _capture_start = false;
+               _capture_end = false;
+               
+               /* move to the correct location place */
+               file_pos = capture_start_frame - timeline_position;
+
+               if (crossfade (data, cnt, 1) != cnt) {
+                       return 0;
+               }
+               
+       } else if (_capture_end) {
+
+               /* end of capture both occur within the data we are writing,
+                  so do the fade out
+               */
+
+               _capture_start = false;
+               _capture_end = false;
+               
+               if (crossfade (data, cnt, 0) != cnt) {
+                       return 0;
+               }
+
+       } else {
+
+               /* in the middle of recording */
+
+               if (write_float (data, file_pos, cnt) != cnt) {
+                       return 0;
+               }
+       }
+
+       old_file_pos = file_pos;
+       update_length (file_pos, cnt);
+       file_pos += cnt;
+
+       if (_build_peakfiles) {
+               PeakBuildRecord *pbr = 0;
+               
+               if (pending_peak_builds.size()) {
+                       pbr = pending_peak_builds.back();
+               }
+               
+               if (pbr && pbr->frame + pbr->cnt == old_file_pos) {
+                       
+                       /* the last PBR extended to the start of the current write,
+                          so just extend it again.
+                       */
+                       
+                       pbr->cnt += cnt;
+               } else {
+                       pending_peak_builds.push_back (new PeakBuildRecord (old_file_pos, cnt));
+               }
+               
+               _peaks_built = false;
+       }
+
+       if (_build_peakfiles) {
+               queue_for_peaks (shared_from_this ());
+       }
+       
+       return cnt;
+}
+
 int
 SndFileSource::update_header (nframes_t when, struct tm& now, time_t tnow)
 {      
@@ -499,8 +642,10 @@ SndFileSource::set_header_timeline_position ()
 nframes_t
 SndFileSource::write_float (Sample* data, nframes_t frame_pos, nframes_t cnt)
 {
-       if (sf_seek (sf, frame_pos, SEEK_SET|SFM_WRITE) != frame_pos) {
-               error << string_compose (_("%1: cannot seek to %2"), _path, frame_pos) << endmsg;
+       if (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;
                return 0;
        }
        
@@ -516,3 +661,286 @@ SndFileSource::natural_position() const
 {
        return timeline_position;
 }
+
+bool
+SndFileSource::set_destructive (bool yn)
+{
+       if (yn) {
+               _flags = Flag (_flags | Destructive);
+               if (!xfade_buf) {
+                       xfade_buf = new Sample[xfade_frames];
+               }
+               clear_capture_marks ();
+               timeline_position = header_position_offset;
+       } else {
+               _flags = Flag (_flags & ~Destructive);
+               timeline_position = 0;
+               /* leave xfade buf alone in case we need it again later */
+       }
+
+       return true;
+}
+
+void
+SndFileSource::clear_capture_marks ()
+{
+       _capture_start = false;
+       _capture_end = false;
+}      
+
+void
+SndFileSource::mark_capture_start (nframes_t pos)
+{
+       if (destructive()) {
+               if (pos < timeline_position) {
+                       _capture_start = false;
+               } else {
+                       _capture_start = true;
+                       capture_start_frame = pos;
+               }
+       }
+}
+
+void
+SndFileSource::mark_capture_end()
+{
+       if (destructive()) {
+               _capture_end = true;
+       }
+}
+
+nframes_t
+SndFileSource::crossfade (Sample* data, nframes_t cnt, int fade_in)
+{
+       nframes_t xfade = min (xfade_frames, cnt);
+       nframes_t nofade = cnt - xfade;
+       Sample* fade_data = 0;
+       nframes_t fade_position = 0; // in frames
+       ssize_t retval;
+       nframes_t file_cnt;
+
+       if (fade_in) {
+               fade_position = file_pos;
+               fade_data = data;
+       } else {
+               fade_position = file_pos + nofade;
+               fade_data = data + nofade;
+       }
+
+       if (fade_position > _length) {
+               
+               /* read starts beyond end of data, just memset to zero */
+               
+               file_cnt = 0;
+
+       } else if (fade_position + xfade > _length) {
+               
+               /* read ends beyond end of data, read some, memset the rest */
+               
+               file_cnt = _length - fade_position;
+
+       } else {
+               
+               /* read is entirely within data */
+
+               file_cnt = xfade;
+       }
+
+       if (file_cnt) {
+               
+               if ((retval = read_unlocked (xfade_buf, fade_position, file_cnt)) != (ssize_t) file_cnt) {
+                       if (retval >= 0 && errno == EAGAIN) {
+                               /* XXX - can we really trust that errno is meaningful here?  yes POSIX, i'm talking to you.
+                                * short or no data there */
+                               memset (xfade_buf, 0, xfade * sizeof(Sample));
+                       } else {
+                               error << string_compose(_("SndFileSource: \"%1\" bad read retval: %2 of %5 (%3: %4)"), _path, retval, errno, strerror (errno), xfade) << endmsg;
+                               return 0;
+                       }
+               }
+       } 
+
+       if (file_cnt != xfade) {
+               nframes_t delta = xfade - file_cnt;
+               memset (xfade_buf+file_cnt, 0, sizeof (Sample) * delta);
+       }
+       
+       if (nofade && !fade_in) {
+               if (write_float (data, file_pos, nofade) != nofade) {
+                       error << string_compose(_("SndFileSource: \"%1\" bad write (%2)"), _path, strerror (errno)) << endmsg;
+                       return 0;
+               }
+       }
+
+       if (xfade == xfade_frames) {
+
+               nframes_t n;
+
+               /* use the standard xfade curve */
+               
+               if (fade_in) {
+
+                       /* fade new material in */
+                       
+                       for (n = 0; n < xfade; ++n) {
+                               xfade_buf[n] = (xfade_buf[n] * out_coefficient[n]) + (fade_data[n] * in_coefficient[n]);
+                       }
+
+               } else {
+
+
+                       /* fade new material out */
+                       
+                       for (n = 0; n < xfade; ++n) {
+                               xfade_buf[n] = (xfade_buf[n] * in_coefficient[n]) + (fade_data[n] * out_coefficient[n]);
+                       }
+               }
+
+       } else if (xfade < xfade_frames) {
+
+               gain_t in[xfade];
+               gain_t out[xfade];
+
+               /* short xfade, compute custom curve */
+
+               compute_equal_power_fades (xfade, in, out);
+
+               for (nframes_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 */
+
+       }
+
+       if (xfade) {
+               if (write_float (xfade_buf, fade_position, xfade) != xfade) {
+                       error << string_compose(_("SndFileSource: \"%1\" bad write (%2)"), _path, strerror (errno)) << endmsg;
+                       return 0;
+               }
+       }
+       
+       if (fade_in && nofade) {
+               if (write_float (data + xfade, file_pos + xfade, nofade) != nofade) {
+                       error << string_compose(_("SndFileSource: \"%1\" bad write (%2)"), _path, strerror (errno)) << endmsg;
+                       return 0;
+               }
+       }
+
+       return cnt;
+}
+
+nframes_t
+SndFileSource::last_capture_start_frame () const
+{
+       if (destructive()) {
+               return capture_start_frame;
+       } else {
+               return 0;
+       }
+}
+
+void
+SndFileSource::handle_header_position_change ()
+{
+       if (destructive()) {
+               if ( _length != 0 ) {
+                       error << string_compose(_("Filesource: start time is already set for existing file (%1): Cannot change start time."), _path ) << endmsg;
+                       //in the future, pop up a dialog here that allows user to regenerate file with new start offset
+               } else if (writable()) {
+                       timeline_position = header_position_offset;
+                       set_header_timeline_position ();  //this will get flushed if/when the file is recorded to
+               }
+       }
+}
+
+void
+SndFileSource::setup_standard_crossfades (nframes_t rate)
+{
+       /* This static method is assumed to have been called by the Session
+          before any DFS's are created.
+       */
+
+       xfade_frames = (nframes_t) floor ((Config->get_destructive_xfade_msecs () / 1000.0) * rate);
+
+       if (out_coefficient) {
+               delete [] out_coefficient;
+       }
+
+       if (in_coefficient) {
+               delete [] in_coefficient;
+       }
+
+       out_coefficient = new gain_t[xfade_frames];
+       in_coefficient = new gain_t[xfade_frames];
+
+       compute_equal_power_fades (xfade_frames, in_coefficient, out_coefficient);
+}
+
+void
+SndFileSource::set_timeline_position (int64_t pos)
+{
+       // destructive track timeline postion does not change
+       // except at instantion or when header_position_offset 
+       // (session start) changes
+
+       if (!destructive()) {
+               AudioFileSource::set_timeline_position (pos);
+       } 
+}
+
+int
+SndFileSource::get_soundfile_info (string path, SoundFileInfo& info, string& error_msg)
+{
+       SNDFILE *sf;
+       SF_INFO sf_info;
+       SF_BROADCAST_INFO binfo;
+       bool timecode_exists;
+
+       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) { 
+               char errbuf[256];
+               error_msg = sf_error_str (0, errbuf, sizeof (errbuf) - 1);
+               return false;
+       }
+
+       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));
+
+       memset (&binfo, 0, sizeof (binfo));
+       info.timecode  = get_timecode_info (sf, &binfo, timecode_exists);
+
+       if (!timecode_exists) {
+               info.timecode = 0;
+       }
+       
+       sf_close (sf);
+
+       return true;
+}
+
+int64_t
+SndFileSource::get_timecode_info (SNDFILE* sf, SF_BROADCAST_INFO* binfo, bool& exists)
+{
+       if (sf_command (sf, SFC_GET_BROADCAST_INFO, binfo, sizeof (*binfo)) != SF_TRUE) {
+               exists = false;
+               return (header_position_offset);
+       } 
+       
+       /* XXX 64 bit alert: when JACK switches to a 64 bit frame count, this needs to use the high bits
+          of the time reference.
+       */
+       
+       exists = true;
+       int64_t ret = (uint32_t) binfo->time_reference_high;
+       ret <<= 32;
+       ret |= (uint32_t) binfo->time_reference_low;
+       return ret;
+}