align stem-export (raw track outputs (with and w/p processing)
[ardour.git] / libs / ardour / audiosource.cc
index beb53a79bb6db58d7742cb93f53caf8d512f7cd7..7b3f424663ab78b8ce879c8ba4531dd3dc21a2c9 100644 (file)
@@ -30,7 +30,6 @@
 #include <ctime>
 #include <cmath>
 #include <iomanip>
-#include <fstream>
 #include <algorithm>
 #include <vector>
 
 #endif
 
 #include <glib.h>
-#include <glib/gstdio.h>
+#include "pbd/gstdio_compat.h"
 
 #include <boost/scoped_ptr.hpp>
 
 #include <glibmm/fileutils.h>
 #include <glibmm/miscutils.h>
 
+#include "pbd/file_utils.h"
 #include "pbd/scoped_file_descriptor.h"
 #include "pbd/xml++.h"
 
 #include "ardour/audiosource.h"
 #include "ardour/rc_configuration.h"
 #include "ardour/runtime_functions.h"
+#include "ardour/session.h"
 
 #include "i18n.h"
 
@@ -68,7 +69,6 @@ using namespace PBD;
 Glib::Threads::Mutex AudioSource::_level_buffer_lock;
 vector<boost::shared_array<Sample> > AudioSource::_mixdown_buffers;
 vector<boost::shared_array<gain_t> > AudioSource::_gain_buffers;
-size_t AudioSource::_working_buffers_size = 0;
 bool AudioSource::_build_missing_peakfiles = false;
 
 /** true if we want peakfiles (e.g. if we are displaying a GUI) */
@@ -76,7 +76,7 @@ bool AudioSource::_build_peakfiles = false;
 
 #define _FPP 256
 
-AudioSource::AudioSource (Session& s, string name)
+AudioSource::AudioSource (Session& s, const string& name)
        : Source (s, DataType::AUDIO, name)
        , _length (0)
        , _peak_byte_max (0)
@@ -142,7 +142,7 @@ AudioSource::get_state ()
 int
 AudioSource::set_state (const XMLNode& node, int /*version*/)
 {
-       const XMLProperty* prop;
+       XMLProperty const * prop;
 
        if ((prop = node.property ("captured-for")) != 0) {
                _captured_for = prop->value();
@@ -204,7 +204,7 @@ AudioSource::touch_peakfile ()
 {
        GStatBuf statbuf;
 
-       if (g_stat (peakpath.c_str(), &statbuf) != 0 || statbuf.st_size == 0) {
+       if (g_stat (_peakpath.c_str(), &statbuf) != 0 || statbuf.st_size == 0) {
                return;
        }
 
@@ -213,7 +213,7 @@ AudioSource::touch_peakfile ()
        tbuf.actime = statbuf.st_atime;
        tbuf.modtime = time ((time_t*) 0);
 
-       g_utime (peakpath.c_str(), &tbuf);
+       g_utime (_peakpath.c_str(), &tbuf);
 }
 
 int
@@ -221,7 +221,7 @@ AudioSource::rename_peakfile (string newpath)
 {
        /* caller must hold _lock */
 
-       string oldpath = peakpath;
+       string oldpath = _peakpath;
 
        if (Glib::file_test (oldpath, Glib::FILE_TEST_EXISTS)) {
                if (g_rename (oldpath.c_str(), newpath.c_str()) != 0) {
@@ -230,35 +230,40 @@ AudioSource::rename_peakfile (string newpath)
                }
        }
 
-       peakpath = newpath;
+       _peakpath = newpath;
 
        return 0;
 }
 
 int
-AudioSource::initialize_peakfile (string audio_path)
+AudioSource::initialize_peakfile (const string& audio_path, const bool in_session)
 {
+       Glib::Threads::Mutex::Lock lm (_initialize_peaks_lock);
        GStatBuf statbuf;
 
-       peakpath = peak_path (audio_path);
+       _peakpath = construct_peak_filepath (audio_path, in_session);
 
-       DEBUG_TRACE(DEBUG::Peaks, string_compose ("Initialize Peakfile %1 for Audio file %2\n", peakpath, audio_path));
-
-       /* if the peak file should be there, but isn't .... */
-
-       if (!empty() && !Glib::file_test (peakpath.c_str(), Glib::FILE_TEST_EXISTS)) {
-               peakpath = find_broken_peakfile (peakpath, audio_path);
+       if (!empty() && !Glib::file_test (_peakpath.c_str(), Glib::FILE_TEST_EXISTS)) {
+               string oldpeak = construct_peak_filepath (audio_path, in_session, true);
+               DEBUG_TRACE(DEBUG::Peaks, string_compose ("Looking for old peak file %1 for Audio file %2\n", oldpeak, audio_path));
+               if (Glib::file_test (oldpeak.c_str(), Glib::FILE_TEST_EXISTS)) {
+                       // TODO use hard-link if possible
+                       DEBUG_TRACE(DEBUG::Peaks, string_compose ("Copy old peakfile %1 to %2\n", oldpeak, _peakpath));
+                       PBD::copy_file (oldpeak, _peakpath);
+               }
        }
 
-       if (g_stat (peakpath.c_str(), &statbuf)) {
+       DEBUG_TRACE(DEBUG::Peaks, string_compose ("Initialize Peakfile %1 for Audio file %2\n", _peakpath, audio_path));
+
+       if (g_stat (_peakpath.c_str(), &statbuf)) {
                if (errno != ENOENT) {
                        /* it exists in the peaks dir, but there is some kind of error */
 
-                       error << string_compose(_("AudioSource: cannot stat peakfile \"%1\""), peakpath) << endmsg;
+                       error << string_compose(_("AudioSource: cannot stat peakfile \"%1\""), _peakpath) << endmsg;
                        return -1;
                }
 
-               DEBUG_TRACE(DEBUG::Peaks, string_compose("Peakfile %1 does not exist\n", peakpath));
+               DEBUG_TRACE(DEBUG::Peaks, string_compose("Peakfile %1 does not exist\n", _peakpath));
 
                _peaks_built = false;
 
@@ -267,19 +272,19 @@ AudioSource::initialize_peakfile (string audio_path)
                /* we found it in the peaks dir, so check it out */
 
                if (statbuf.st_size == 0 || (statbuf.st_size < (off_t) ((length(_timeline_position) / _FPP) * sizeof (PeakData)))) {
-                       DEBUG_TRACE(DEBUG::Peaks, string_compose("Peakfile %1 is empty\n", peakpath));
+                       DEBUG_TRACE(DEBUG::Peaks, string_compose("Peakfile %1 is empty\n", _peakpath));
                        _peaks_built = false;
                } else {
                        // Check if the audio file has changed since the peakfile was built.
-                       struct stat stat_file;
-                       int err = stat (audio_path.c_str(), &stat_file);
+                       GStatBuf stat_file;
+                       int err = g_stat (audio_path.c_str(), &stat_file);
 
                        if (err) {
 
                                /* no audio path - nested source or we can't
                                   read it or ... whatever, use the peakfile as-is.
                                */
-                               DEBUG_TRACE(DEBUG::Peaks, string_compose("Error when calling stat on Peakfile %1\n", peakpath));
+                               DEBUG_TRACE(DEBUG::Peaks, string_compose("Error when calling stat on Peakfile %1\n", _peakpath));
 
                                _peaks_built = true;
                                _peak_byte_max = statbuf.st_size;
@@ -312,7 +317,7 @@ framecnt_t
 AudioSource::read (Sample *dst, framepos_t start, framecnt_t cnt, int /*channel*/) const
 {
        assert (cnt >= 0);
-       
+
        Glib::Threads::Mutex::Lock lm (_lock);
        return read_unlocked (dst, start, cnt);
 }
@@ -359,37 +364,47 @@ AudioSource::read_peaks_with_fpp (PeakData *peaks, framecnt_t npeaks, framepos_t
        GStatBuf statbuf;
 
        expected_peaks = (cnt / (double) samples_per_file_peak);
-       if (g_stat (peakpath.c_str(), &statbuf) != 0) {
-               error << string_compose (_("Cannot open peakfile @ %1 for size check (%2)"), peakpath, strerror (errno)) << endmsg;
+       if (g_stat (_peakpath.c_str(), &statbuf) != 0) {
+               error << string_compose (_("Cannot open peakfile @ %1 for size check (%2)"), _peakpath, strerror (errno)) << endmsg;
                return -1;
        }
 
-       /* check actual size of the peakfile is at least large enough for all
-        * the data in the audio file. if it is too short, assume that a crash
-        * or other error truncated it, and rebuild it from scratch.
-        */
-       
-       const off_t expected_file_size = (_length / (double) samples_per_file_peak) * sizeof (PeakData);
-
-       if (statbuf.st_size < expected_file_size) {
-               warning << string_compose (_("peak file %1 is truncated from %2 to %3"), peakpath, expected_file_size, statbuf.st_size) << endmsg;
-               const_cast<AudioSource*>(this)->build_peaks_from_scratch ();
-               if (g_stat (peakpath.c_str(), &statbuf) != 0) {
-                       error << string_compose (_("Cannot open peakfile @ %1 for size check (%2) after rebuild"), peakpath, strerror (errno)) << endmsg;
-               }
+       if (!_captured_for.empty()) {
+
+               /* _captured_for is only set after a capture pass is
+                * complete. so we know that capturing is finished for this
+                * file, and now we can check actual size of the peakfile is at
+                * least large enough for all the data in the audio file. if it
+                * is too short, assume that a crash or other error truncated
+                * it, and rebuild it from scratch.
+                *
+                * XXX this may not work for destructive recording, but we
+                * might decided to get rid of that anyway.
+                *
+                */
+
+               const off_t expected_file_size = (_length / (double) samples_per_file_peak) * sizeof (PeakData);
+
                if (statbuf.st_size < expected_file_size) {
-                       fatal << "peak file is still truncated after rebuild" << endmsg;
-                       /*NOTREACHED*/
+                       warning << string_compose (_("peak file %1 is truncated from %2 to %3"), _peakpath, expected_file_size, statbuf.st_size) << endmsg;
+                       const_cast<AudioSource*>(this)->build_peaks_from_scratch ();
+                       if (g_stat (_peakpath.c_str(), &statbuf) != 0) {
+                               error << string_compose (_("Cannot open peakfile @ %1 for size check (%2) after rebuild"), _peakpath, strerror (errno)) << endmsg;
+                       }
+                       if (statbuf.st_size < expected_file_size) {
+                               fatal << "peak file is still truncated after rebuild" << endmsg;
+                               /*NOTREACHED*/
+                       }
                }
        }
 
-       ScopedFileDescriptor sfd (::open (peakpath.c_str(), O_RDONLY));
+       ScopedFileDescriptor sfd (g_open (_peakpath.c_str(), O_RDONLY, 0444));
 
        if (sfd < 0) {
-               error << string_compose (_("Cannot open peakfile @ %1 for reading (%2)"), peakpath, strerror (errno)) << endmsg;
+               error << string_compose (_("Cannot open peakfile @ %1 for reading (%2)"), _peakpath, strerror (errno)) << endmsg;
                return -1;
        }
-                                 
+
        scale = npeaks/expected_peaks;
 
 
@@ -455,13 +470,13 @@ AudioSource::read_peaks_with_fpp (PeakData *peaks, framecnt_t npeaks, framepos_t
 
                        map_handle = CreateFileMapping(file_handle, NULL, PAGE_READONLY, 0, 0, NULL);
                        if (map_handle == NULL) {
-                               error << string_compose (_("map failed - could not create file mapping for peakfile %1."), peakpath) << endmsg;
+                               error << string_compose (_("map failed - could not create file mapping for peakfile %1."), _peakpath) << endmsg;
                                return -1;
                        }
 
                        view_handle = MapViewOfFile(map_handle, FILE_MAP_READ, 0, read_map_off, map_length);
                        if (view_handle == NULL) {
-                               error << string_compose (_("map failed - could not map peakfile %1."), peakpath) << endmsg;
+                               error << string_compose (_("map failed - could not map peakfile %1."), _peakpath) << endmsg;
                                return -1;
                        }
 
@@ -472,13 +487,13 @@ AudioSource::read_peaks_with_fpp (PeakData *peaks, framecnt_t npeaks, framepos_t
                        err_flag = UnmapViewOfFile (view_handle);
                        err_flag = CloseHandle(map_handle);
                        if(!err_flag) {
-                               error << string_compose (_("unmap failed - could not unmap peakfile %1."), peakpath) << endmsg;
+                               error << string_compose (_("unmap failed - could not unmap peakfile %1."), _peakpath) << endmsg;
                                return -1;
                        }
 #else
                        addr = (char*) mmap (0, map_length, PROT_READ, MAP_PRIVATE, sfd, read_map_off);
                        if (addr ==  MAP_FAILED) {
-                               error << string_compose (_("map failed - could not mmap peakfile %1."), peakpath) << endmsg;
+                               error << string_compose (_("map failed - could not mmap peakfile %1."), _peakpath) << endmsg;
                                return -1;
                        }
 
@@ -550,13 +565,13 @@ AudioSource::read_peaks_with_fpp (PeakData *peaks, framecnt_t npeaks, framepos_t
 
                        map_handle = CreateFileMapping(file_handle, NULL, PAGE_READONLY, 0, 0, NULL);
                        if (map_handle == NULL) {
-                               error << string_compose (_("map failed - could not create file mapping for peakfile %1."), peakpath) << endmsg;
+                               error << string_compose (_("map failed - could not create file mapping for peakfile %1."), _peakpath) << endmsg;
                                return -1;
                        }
 
                        view_handle = MapViewOfFile(map_handle, FILE_MAP_READ, 0, read_map_off, map_length);
                        if (view_handle == NULL) {
-                               error << string_compose (_("map failed - could not map peakfile %1."), peakpath) << endmsg;
+                               error << string_compose (_("map failed - could not map peakfile %1."), _peakpath) << endmsg;
                                return -1;
                        }
 
@@ -567,13 +582,13 @@ AudioSource::read_peaks_with_fpp (PeakData *peaks, framecnt_t npeaks, framepos_t
                        err_flag = UnmapViewOfFile (view_handle);
                        err_flag = CloseHandle(map_handle);
                        if(!err_flag) {
-                               error << string_compose (_("unmap failed - could not unmap peakfile %1."), peakpath) << endmsg;
+                               error << string_compose (_("unmap failed - could not unmap peakfile %1."), _peakpath) << endmsg;
                                return -1;
                        }
 #else
                        addr = (char*) mmap (0, map_length, PROT_READ, MAP_PRIVATE, sfd, read_map_off);
                        if (addr ==  MAP_FAILED) {
-                               error << string_compose (_("map failed - could not mmap peakfile %1."), peakpath) << endmsg;
+                               error << string_compose (_("map failed - could not mmap peakfile %1."), _peakpath) << endmsg;
                                return -1;
                        }
 
@@ -728,19 +743,30 @@ AudioSource::build_peaks_from_scratch ()
 
                        framecnt_t frames_to_read = min (bufsize, cnt);
                        framecnt_t frames_read;
-                       
+
                        if ((frames_read = read_unlocked (buf.get(), current_frame, frames_to_read)) != frames_to_read) {
                                error << string_compose(_("%1: could not write read raw data for peak computation (%2)"), _name, strerror (errno)) << endmsg;
                                done_with_peakfile_writes (false);
                                goto out;
                        }
 
+                       lp.release(); // allow butler to refill buffers
+
+                       if (_session.deletion_in_progress() || _session.peaks_cleanup_in_progres()) {
+                               cerr << "peak file creation interrupted: " << _name << endmsg;
+                               lp.acquire();
+                               done_with_peakfile_writes (false);
+                               goto out;
+                       }
+
                        if (compute_and_write_peaks (buf.get(), current_frame, frames_read, true, false, _FPP)) {
                                break;
                        }
 
                        current_frame += frames_read;
                        cnt -= frames_read;
+
+                       lp.acquire();
                }
 
                if (cnt == 0) {
@@ -756,18 +782,37 @@ AudioSource::build_peaks_from_scratch ()
 
   out:
        if (ret) {
-               DEBUG_TRACE (DEBUG::Peaks, string_compose("Could not write peak data, attempting to remove peakfile %1\n", peakpath));
-               ::g_unlink (peakpath.c_str());
+               DEBUG_TRACE (DEBUG::Peaks, string_compose("Could not write peak data, attempting to remove peakfile %1\n", _peakpath));
+               ::g_unlink (_peakpath.c_str());
        }
 
        return ret;
 }
 
+int
+AudioSource::close_peakfile ()
+{
+       Glib::Threads::Mutex::Lock lp (_lock);
+       if (_peakfile_fd >= 0) {
+               close (_peakfile_fd);
+               _peakfile_fd = -1;
+       }
+       if (!_peakpath.empty()) {
+               ::g_unlink (_peakpath.c_str());
+       }
+       _peaks_built = false;
+       return 0;
+}
+
 int
 AudioSource::prepare_for_peakfile_writes ()
 {
-       if ((_peakfile_fd = open (peakpath.c_str(), O_CREAT|O_RDWR, 0664)) < 0) {
-               error << string_compose(_("AudioSource: cannot open peakpath (c) \"%1\" (%2)"), peakpath, strerror (errno)) << endmsg;
+       if (_session.deletion_in_progress() || _session.peaks_cleanup_in_progres()) {
+               return -1;
+       }
+
+       if ((_peakfile_fd = g_open (_peakpath.c_str(), O_CREAT|O_RDWR, 0664)) < 0) {
+               error << string_compose(_("AudioSource: cannot open _peakpath (c) \"%1\" (%2)"), _peakpath, strerror (errno)) << endmsg;
                return -1;
        }
        return 0;
@@ -776,6 +821,14 @@ AudioSource::prepare_for_peakfile_writes ()
 void
 AudioSource::done_with_peakfile_writes (bool done)
 {
+       if (_session.deletion_in_progress() || _session.peaks_cleanup_in_progres()) {
+               if (_peakfile_fd) {
+                       close (_peakfile_fd);
+                       _peakfile_fd = -1;
+               }
+               return;
+       }
+
        if (peak_leftover_cnt) {
                compute_and_write_peaks (0, 0, 0, true, false, _FPP);
        }
@@ -790,7 +843,9 @@ AudioSource::done_with_peakfile_writes (bool done)
        _peakfile_fd = -1;
 }
 
-/** @param first_frame Offset from the source start of the first frame to process */
+/** @param first_frame Offset from the source start of the first frame to
+ * process. _lock MUST be held by caller.
+*/
 int
 AudioSource::compute_and_write_peaks (Sample* buf, framecnt_t first_frame, framecnt_t cnt,
                                      bool force, bool intermediate_peaks_ready)
@@ -947,7 +1002,7 @@ AudioSource::compute_and_write_peaks (Sample* buf, framecnt_t first_frame, frame
                off_t target_length = blocksize * ((first_peak_byte + blocksize + 1) / blocksize);
 
                if (endpos < target_length) {
-                       DEBUG_TRACE(DEBUG::Peaks, string_compose ("Truncating Peakfile %1\n", peakpath));
+                       DEBUG_TRACE(DEBUG::Peaks, string_compose ("Truncating Peakfile %1\n", _peakpath));
                        if (ftruncate (_peakfile_fd, target_length)) {
                                /* error doesn't actually matter so continue on without testing */
                        }
@@ -998,10 +1053,10 @@ AudioSource::truncate_peakfile ()
        off_t end = lseek (_peakfile_fd, 0, SEEK_END);
 
        if (end > _peak_byte_max) {
-               DEBUG_TRACE(DEBUG::Peaks, string_compose ("Truncating Peakfile  %1\n", peakpath));
+               DEBUG_TRACE(DEBUG::Peaks, string_compose ("Truncating Peakfile  %1\n", _peakpath));
                if (ftruncate (_peakfile_fd, _peak_byte_max)) {
                        error << string_compose (_("could not truncate peakfile %1 to %2 (error: %3)"),
-                                                peakpath, _peak_byte_max, errno) << endmsg;
+                                                _peakpath, _peak_byte_max, errno) << endmsg;
                }
        }
 }