Thought-to-be-fix for #2794; fix route process order sorting.
[ardour.git] / libs / ardour / import.cc
index 4e759451c5ed349a04a011c08e89c52fd23ba6f7..3dd2a99ee109f8497d8ef1589e9eb6c78a4c1dda 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2000 Paul Davis 
+    Copyright (C) 2000 Paul Davis
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
 
 */
 
+
+#ifdef WAF_BUILD
+#include "libardour-config.h"
+#endif
+
 #include <cstdio>
 #include <cstdlib>
 #include <string>
@@ -25,6 +30,7 @@
 #include <unistd.h>
 #include <sys/stat.h>
 #include <time.h>
+#include <stdint.h>
 
 #include <sndfile.h>
 #include <samplerate.h>
 #include <boost/scoped_array.hpp>
 #include <boost/shared_array.hpp>
 
-#include <pbd/convert.h>
-
-#include <ardour/ardour.h>
-#include <ardour/session.h>
-#include <ardour/session_directory.h>
-#include <ardour/audio_diskstream.h>
-#include <ardour/sndfilesource.h>
-#include <ardour/sndfile_helpers.h>
-#include <ardour/audioregion.h>
-#include <ardour/region_factory.h>
-#include <ardour/source_factory.h>
-#include <ardour/resampled_source.h>
+#include "pbd/basename.h"
+#include "pbd/convert.h"
+
+#include "evoral/SMF.hpp"
+
+#include "ardour/analyser.h"
+#include "ardour/ardour.h"
+#include "ardour/audio_diskstream.h"
+#include "ardour/audioengine.h"
+#include "ardour/audioregion.h"
+#include "ardour/import_status.h"
+#include "ardour/region_factory.h"
+#include "ardour/resampled_source.h"
+#include "ardour/session.h"
+#include "ardour/session_directory.h"
+#include "ardour/smf_source.h"
+#include "ardour/sndfile_helpers.h"
+#include "ardour/sndfileimportable.h"
+#include "ardour/sndfilesource.h"
+#include "ardour/source_factory.h"
+#include "ardour/tempo.h"
+
+#ifdef HAVE_COREAUDIO
+#include "ardour/caimportable.h"
+#endif
 
 #include "i18n.h"
 
+using namespace std;
 using namespace ARDOUR;
 using namespace PBD;
 
-std::auto_ptr<ImportableSource>
-open_importable_source (const string& path, nframes_t samplerate,
-               ARDOUR::SrcQuality quality)
+static boost::shared_ptr<ImportableSource>
+open_importable_source (const string& path, nframes_t samplerate, ARDOUR::SrcQuality quality)
 {
-       std::auto_ptr<ImportableSource> source(new ImportableSource(path));
-
-       if (source->samplerate() == samplerate) {
-               return source;
+       /* try libsndfile first, because it can get BWF info from .wav, which ExtAudioFile cannot.
+          We don't necessarily need that information in an ImportableSource, but it keeps the 
+          logic the same as in SourceFactory::create() 
+        */
+
+       try { 
+               boost::shared_ptr<SndFileImportableSource> source(new SndFileImportableSource(path));
+               
+               if (source->samplerate() == samplerate) {
+                       return source;
+               }
+               
+               /* rewrap as a resampled source */
+               
+               return boost::shared_ptr<ImportableSource>(new ResampledImportableSource(source, samplerate, quality));
        }
 
-       return std::auto_ptr<ImportableSource>(
-                       new ResampledImportableSource(path, samplerate, quality)
-                       );
+       catch (...) {
+
+#ifdef HAVE_COREAUDIO
+
+               /* libsndfile failed, see if we can use CoreAudio to handle the IO */
+               
+               CAImportableSource* src = new CAImportableSource(path);
+               boost::shared_ptr<CAImportableSource> source (src);
+               
+               if (source->samplerate() == samplerate) {
+                       return source;
+               }
+               
+               /* rewrap as a resampled source */
+               
+               return boost::shared_ptr<ImportableSource>(new ResampledImportableSource(source, samplerate, quality));
+
+#else
+               throw; // rethrow
+#endif
+
+       }
 }
 
-std::string
-get_non_existent_filename (const std::string& basename, uint channel, uint channels)
+static std::string
+get_non_existent_filename (HeaderFormat hf, DataType type, const bool allow_replacing, const std::string& destdir, const std::string& basename, uint channel, uint channels)
 {
        char buf[PATH_MAX+1];
        bool goodfile = false;
-       string base(basename);
+       string base = basename;
+       string ext = native_header_format_extension (hf, type);
+        uint32_t cnt = 1;
 
        do {
-               if (channels == 2) {
+
+               if (type == DataType::AUDIO && channels == 2) {
                        if (channel == 0) {
-                               snprintf (buf, sizeof(buf), "%s-L.wav", base.c_str());
+                                if (cnt == 1) {
+                                        snprintf (buf, sizeof(buf), "%s-L%s", base.c_str(), ext.c_str());
+                                } else {
+                                        snprintf (buf, sizeof(buf), "%s-%d-L%s", base.c_str(), cnt, ext.c_str());
+                                }
                        } else {
-                               snprintf (buf, sizeof(buf), "%s-R.wav", base.c_str());
+                                if (cnt == 1) {
+                                        snprintf (buf, sizeof(buf), "%s-R%s", base.c_str(), ext.c_str());
+                                } else {
+                                        snprintf (buf, sizeof(buf), "%s-%d-R%s", base.c_str(), cnt, ext.c_str());
+                                }
                        }
                } else if (channels > 1) {
-                       snprintf (buf, sizeof(buf), "%s-c%d.wav", base.c_str(), channel+1);
+                        if (cnt == 1) {
+                                snprintf (buf, sizeof(buf), "%s-c%d%s", base.c_str(), channel, ext.c_str());
+                        } else {
+                                snprintf (buf, sizeof(buf), "%s-%d-c%d%s", base.c_str(), cnt, channel, ext.c_str());
+                        }
                } else {
-                       snprintf (buf, sizeof(buf), "%s.wav", base.c_str());
+                        if (cnt == 1) {
+                                snprintf (buf, sizeof(buf), "%s%s", base.c_str(), ext.c_str());
+                        } else {
+                                snprintf (buf, sizeof(buf), "%s-%d%s", base.c_str(), cnt, ext.c_str());
+                        }
                }
 
-               if (sys::exists (buf)) {
-
-                       /* if the file already exists, we must come up with
-                        *  a new name for it.  for now we just keep appending
-                        *  _ to basename
-                        */
-
-                       base += "_";
+               string tempname = destdir + "/" + buf;
+                
+               if (!allow_replacing && Glib::file_test (tempname, Glib::FILE_TEST_EXISTS)) {
+                        
+                        cnt++;
 
                } else {
 
                        goodfile = true;
                }
 
-       } while ( !goodfile);
+       } while (!goodfile);
 
        return buf;
 }
 
-void
-write_audio_data_to_new_files (ImportableSource* source, Session::import_status& status,
-               vector<boost::shared_ptr<AudioFileSource> >& newfiles)
+static vector<string>
+get_paths_for_new_sources (HeaderFormat hf, const bool allow_replacing, const string& import_file_path, const string& session_dir, uint channels)
+{
+       vector<string> new_paths;
+       const string basename = basename_nosuffix (import_file_path);
+
+       SessionDirectory sdir(session_dir);
+
+       for (uint n = 0; n < channels; ++n) {
+
+               const DataType type = SMFSource::safe_midi_file_extension (import_file_path) ? DataType::MIDI : DataType::AUDIO;
+
+               std::string filepath = (type == DataType::MIDI)
+                               ? sdir.midi_path().to_string() : sdir.sound_path().to_string();
+
+                filepath = Glib::build_filename (filepath, 
+                                                 get_non_existent_filename (hf, type, allow_replacing, filepath, basename, n, channels));
+               new_paths.push_back (filepath);
+       }
+
+       return new_paths;
+}
+
+static bool
+map_existing_mono_sources (const vector<string>& new_paths, Session& /*sess*/,
+                          uint /*samplerate*/, vector<boost::shared_ptr<Source> >& newfiles, Session *session)
+{
+       for (vector<string>::const_iterator i = new_paths.begin();
+                       i != new_paths.end(); ++i)
+       {
+               boost::shared_ptr<Source> source = session->source_by_path_and_channel(*i, 0);
+
+               if (source == 0) {
+                       error << string_compose(_("Could not find a source for %1 even though we are updating this file!"), (*i)) << endl;
+                       return false;
+               }
+
+               newfiles.push_back(boost::dynamic_pointer_cast<Source>(source));
+       }
+       return true;
+}
+
+static bool
+create_mono_sources_for_writing (const string& origin,
+                                 const vector<string>& new_paths, 
+                                 Session& sess, uint samplerate, 
+                                 vector<boost::shared_ptr<Source> >& newfiles,
+                                framepos_t timeline_position)
+{
+       for (vector<string>::const_iterator i = new_paths.begin(); i != new_paths.end(); ++i) {
+
+               boost::shared_ptr<Source> source;
+
+               try {
+                       const DataType type = SMFSource::safe_midi_file_extension (*i) ? DataType::MIDI : DataType::AUDIO;
+
+                       source = SourceFactory::createWritable (type, sess,
+                                                                i->c_str(),
+                                                                origin,
+                                                                false, // destructive
+                                                                samplerate);
+               }
+
+               catch (const failed_constructor& err) {
+                       error << string_compose (_("Unable to create file %1 during import"), *i) << endmsg;
+                       return false;
+               }
+
+               newfiles.push_back(boost::dynamic_pointer_cast<Source>(source));
+
+                /* for audio files, reset the timeline position so that any BWF-ish
+                   information in the original files we are importing from is maintained.
+                */
+
+                boost::shared_ptr<AudioFileSource> afs;
+                if ((afs = boost::dynamic_pointer_cast<AudioFileSource>(source)) != 0) {
+                        afs->set_timeline_position(timeline_position);
+                }
+       }
+       return true;
+}
+
+static string
+compose_status_message (const string& path,
+                       uint file_samplerate,
+                       uint session_samplerate,
+                       uint /* current_file */,
+                       uint /* total_files */)
+{
+       if (file_samplerate != session_samplerate) {
+               return string_compose (_("Resampling %1 from %2kHz to %3kHz"),
+                                      Glib::path_get_basename (path),
+                                      file_samplerate/1000.0f,
+                                      session_samplerate/1000.0f);
+       }
+       
+       return string_compose (_("Copying %1"), Glib::path_get_basename (path));
+}
+
+static void
+write_audio_data_to_new_files (ImportableSource* source, ImportStatus& status,
+                              vector<boost::shared_ptr<Source> >& newfiles)
 {
        const nframes_t nframes = ResampledImportableSource::blocksize;
+       boost::shared_ptr<AudioFileSource> afs;
        uint channels = source->channels();
 
        boost::scoped_array<float> data(new float[nframes * channels]);
@@ -119,9 +284,49 @@ write_audio_data_to_new_files (ImportableSource* source, Session::import_status&
        for (uint n = 0; n < channels; ++n) {
                channel_data.push_back(boost::shared_array<Sample>(new Sample[nframes]));
        }
-       
-       uint read_count = 0;
+
+       float gain = 1;
+
+       boost::shared_ptr<AudioSource> s = boost::dynamic_pointer_cast<AudioSource> (newfiles[0]);
+       assert (s);
+
        status.progress = 0.0f;
+       float progress_multiplier = 1;
+       float progress_base = 0;
+
+       if (!source->clamped_at_unity() && s->clamped_at_unity()) {
+
+               /* The source we are importing from can return sample values with a magnitude greater than 1,
+                  and the file we are writing the imported data to cannot handle such values.  Compute the gain
+                  factor required to normalize the input sources to have a magnitude of less than 1.
+               */
+               
+               float peak = 0;
+               uint read_count = 0;
+               
+               while (!status.cancel) {
+                       nframes_t const nread = source->read (data.get(), nframes);
+                       if (nread == 0) {
+                               break;
+                       }
+
+                       peak = compute_peak (data.get(), nread, peak);
+
+                       read_count += nread;
+                       status.progress = 0.5 * read_count / (source->ratio() * source->length() * channels);
+               }
+
+               if (peak >= 1) {
+                       /* we are out of range: compute a gain to fix it */
+                       gain = (1 - FLT_EPSILON) / peak;
+               }
+               
+               source->seek (0);
+               progress_multiplier = 0.5;
+               progress_base = 0.5;
+       }
+
+       uint read_count = 0;
 
        while (!status.cancel) {
 
@@ -132,6 +337,12 @@ write_audio_data_to_new_files (ImportableSource* source, Session::import_status&
                if ((nread = source->read (data.get(), nframes)) == 0) {
                        break;
                }
+
+               if (gain != 1) {
+                       /* here is the gain fix for out-of-range sample values that we computed earlier */
+                       apply_gain_to_buffer (data.get(), nread, gain);
+               }
+               
                nfread = nread / channels;
 
                /* de-interleave */
@@ -147,92 +358,179 @@ write_audio_data_to_new_files (ImportableSource* source, Session::import_status&
                /* flush to disk */
 
                for (chn = 0; chn < channels; ++chn) {
-                       newfiles[chn]->write (channel_data[chn].get(), nfread);
+                       if ((afs = boost::dynamic_pointer_cast<AudioFileSource>(newfiles[chn])) != 0) {
+                               afs->write (channel_data[chn].get(), nfread);
+                       }
                }
 
                read_count += nread;
-               status.progress = read_count / (source->ratio () * source->length() * channels);
+               status.progress = progress_base + progress_multiplier * read_count / (source->ratio () * source->length() * channels);
        }
 }
 
-int
-Session::import_audiofile (import_status& status)
+static void
+write_midi_data_to_new_files (Evoral::SMF* source, ImportStatus& status,
+                              vector<boost::shared_ptr<Source> >& newfiles)
 {
-       int ret = -1;
-       vector<string> new_paths;
-       uint32_t cnt = 1;
+       uint32_t buf_size = 4;
+       uint8_t* buf      = (uint8_t*)malloc(buf_size);
 
-       status.sources.clear ();
-       
-       for (vector<Glib::ustring>::iterator p = status.paths.begin();
-                       p != status.paths.end() && !status.cancel;
-                       ++p, ++cnt)
-       {
-               std::auto_ptr<ImportableSource> source;
+       status.progress = 0.0f;
 
-               try
-               {
-                       source = open_importable_source (*p, frame_rate(), status.quality);
-               }
-               catch (const failed_constructor& err)
-               {
-                       error << string_compose(_("Import: cannot open input sound file \"%1\""), (*p)) << endmsg;
-                       status.done = status.cancel = true;
-                       return -1;
+       try {
+
+       for (unsigned i = 1; i <= source->num_tracks(); ++i) {
+               boost::shared_ptr<SMFSource> smfs = boost::dynamic_pointer_cast<SMFSource>(newfiles[i-1]);
+               smfs->drop_model();
+
+               source->seek_to_track(i);
+
+               uint64_t t       = 0;
+               uint32_t delta_t = 0;
+               uint32_t size    = 0;
+                bool first = true;
+
+               while (!status.cancel) {
+                        gint ignored; // imported files either don't have NoteID's or
+                                      // we ignore them.
+
+                       size = buf_size;
+                        
+                       int ret = source->read_event(&delta_t, &size, &buf, &ignored);
+                       if (size > buf_size)
+                               buf_size = size;
+
+                       if (ret < 0) { // EOT
+                               break;
+                       }
+
+                       t += delta_t;
+
+                       if (ret == 0) { // Meta
+                               continue;
+                       }
+                        
+                        if (first) {
+                                smfs->mark_streaming_write_started ();
+                                first = false;
+                        }
+
+                       smfs->append_event_unlocked_beats(Evoral::Event<double>(0,
+                                       (double)t / (double)source->ppqn(),
+                                       size,
+                                       buf));
+
+                       if (status.progress < 0.99)
+                               status.progress += 0.01;
                }
 
-               vector<boost::shared_ptr<AudioFileSource> > newfiles;
+               const framepos_t pos = 0;
+               const double length_beats = ceil(t / (double)source->ppqn());
+               BeatsFramesConverter converter(smfs->session().tempo_map(), pos);
+               smfs->update_length(pos, converter.to(length_beats));
+               smfs->mark_streaming_write_completed ();
 
-               for (uint n = 0; n < source->channels(); ++n) {
-                       newfiles.push_back (boost::shared_ptr<AudioFileSource>());
+               if (status.cancel) {
+                       break;
                }
+       }
 
-               SessionDirectory sdir(get_best_session_directory_for_new_source ());
-       
-               const string basename = sys::basename (string(*p));
+       } catch (...) {
+               error << "Corrupt MIDI file " << source->file_path() << endl;
+       }
+}
 
-               for (uint n = 0; n < source->channels(); ++n) {
+static void
+remove_file_source (boost::shared_ptr<Source> source)
+{
+       ::unlink (source->path().c_str());
+}
 
-                       std::string filename = get_non_existent_filename (basename, n, source->channels()); 
+// This function is still unable to cleanly update an existing source, even though
+// it is possible to set the ImportStatus flag accordingly. The functinality
+// is disabled at the GUI until the Source implementations are able to provide
+// the necessary API.
+void
+Session::import_audiofiles (ImportStatus& status)
+{
+       typedef vector<boost::shared_ptr<Source> > Sources;
+       Sources all_new_sources;
+       boost::shared_ptr<AudioFileSource> afs;
+       boost::shared_ptr<SMFSource> smfs;
+       uint channels = 0;
 
-                       sys::path filepath = sdir.sound_path() / filename;
+       status.sources.clear ();
 
-                       try { 
-                               newfiles[n] = boost::dynamic_pointer_cast<AudioFileSource> (SourceFactory::createWritable (DataType::AUDIO, *this, filepath.to_string().c_str(), false, frame_rate()));
+       for (vector<string>::iterator p = status.paths.begin();
+            p != status.paths.end() && !status.cancel;
+            ++p)
+       {
+               boost::shared_ptr<ImportableSource> source;
+               std::auto_ptr<Evoral::SMF>          smf_reader;
+               const DataType type = SMFSource::safe_midi_file_extension (*p) ? DataType::MIDI : DataType::AUDIO;
+
+               if (type == DataType::AUDIO) {
+                       try {
+                               source = open_importable_source (*p, frame_rate(), status.quality);
+                               channels = source->channels();
+                       } catch (const failed_constructor& err) {
+                               error << string_compose(_("Import: cannot open input sound file \"%1\""), (*p)) << endmsg;
+                               status.done = status.cancel = true;
+                               return;
                        }
 
-                       catch (failed_constructor& err) {
-                               error << string_compose(_("Session::import_audiofile: cannot open new file source for channel %1"), n+1) << endmsg;
-                               goto out;
+               } else {
+                       try {
+                               smf_reader = std::auto_ptr<Evoral::SMF>(new Evoral::SMF());
+                               smf_reader->open(*p);
+                               channels = smf_reader->num_tracks();
+                       } catch (...) {
+                               error << _("Import: error opening MIDI file") << endmsg;
+                               status.done = status.cancel = true;
+                               return;
                        }
-
-                       new_paths.push_back (filepath.to_string());
-                       newfiles[n]->prepare_for_peakfile_writes ();
                }
 
-               if ((nframes_t) source->samplerate() != frame_rate()) {
-                       status.doing_what = string_compose (_("converting %1\n(resample from %2KHz to %3KHz)\n(%4 of %5)"),
-                                                           sys::path(*p).leaf(),
-                                                           source->samplerate()/1000.0f,
-                                                           frame_rate()/1000.0f,
-                                                           cnt, status.paths.size());
-                                                           
-               } else {
-                       status.doing_what = string_compose (_("converting %1\n(%2 of %3)"), 
-                                                           sys::path(*p).leaf(),
-                                                           cnt, status.paths.size());
+               vector<string> new_paths = get_paths_for_new_sources (config.get_native_file_header_format(),
+                                                                      status.replace_existing_source, *p,
+                                                                     get_best_session_directory_for_new_source (),
+                                                                     channels);
+               Sources newfiles;
+               framepos_t natural_position = source ? source->natural_position() : 0;
 
+               if (status.replace_existing_source) {
+                       fatal << "THIS IS NOT IMPLEMENTED YET, IT SHOULD NEVER GET CALLED!!! DYING!" << endmsg;
+                       status.cancel = !map_existing_mono_sources (new_paths, *this, frame_rate(), newfiles, this);
+               } else {
+                        status.cancel = !create_mono_sources_for_writing (*p, new_paths, *this, frame_rate(), newfiles, natural_position);
                }
 
-               write_audio_data_to_new_files (source.get(), status, newfiles);
+               // copy on cancel/failure so that any files that were created will be removed below
+               std::copy (newfiles.begin(), newfiles.end(), std::back_inserter(all_new_sources));
 
                if (status.cancel) {
-                       goto out;
+                       break;
                }
-       
-               std::copy (newfiles.begin(), newfiles.end(), std::back_inserter(status.sources));
+
+               for (Sources::iterator i = newfiles.begin(); i != newfiles.end(); ++i) {
+                       if ((afs = boost::dynamic_pointer_cast<AudioFileSource>(*i)) != 0) {
+                               afs->prepare_for_peakfile_writes ();
+                       }
+               }
+
+               if (source) { // audio
+                       status.doing_what = compose_status_message (*p, source->samplerate(),
+                                                                   frame_rate(), status.current, status.total);
+                       write_audio_data_to_new_files (source.get(), status, newfiles);
+               } else if (smf_reader.get()) { // midi
+                       status.doing_what = string_compose(_("Loading MIDI file %1"), *p);
+                       write_midi_data_to_new_files (smf_reader.get(), status, newfiles);
+               }
+
+               ++status.current;
+               status.progress = 0;
        }
-       
+
        if (!status.cancel) {
                struct tm* now;
                time_t xnow;
@@ -242,29 +540,37 @@ Session::import_audiofile (import_status& status)
 
                /* flush the final length(s) to the header(s) */
 
-               for (SourceList::iterator x = status.sources.begin(); x != status.sources.end(); ++x) {
-                       boost::dynamic_pointer_cast<AudioFileSource>(*x)->update_header(0, *now, xnow);
-                       boost::dynamic_pointer_cast<AudioSource>(*x)->done_with_peakfile_writes ();
-               }
+               for (Sources::iterator x = all_new_sources.begin(); x != all_new_sources.end(); ) {
+                       if ((afs = boost::dynamic_pointer_cast<AudioFileSource>(*x)) != 0) {
+                                afs->update_header((*x)->natural_position(), *now, xnow);
+                               afs->done_with_peakfile_writes ();
 
-               /* save state so that we don't lose these new Sources */
+                               /* now that there is data there, requeue the file for analysis */
 
-               save_state (_name);
-               ret = 0;
-       }
+                               if (Config->get_auto_analyse_audio()) {
+                                       Analyser::queue_source_for_analysis (boost::static_pointer_cast<Source>(*x), false);
+                               }
+                       }
 
-  out:
+                       /* don't create tracks for empty MIDI sources (channels) */
 
-       if (status.cancel) {
+                       if ((smfs = boost::dynamic_pointer_cast<SMFSource>(*x)) != 0 && smfs->is_empty()) {
+                               x = all_new_sources.erase(x);
+                       } else {
+                               ++x;
+                       }
+               }
 
-               status.sources.clear ();
+               /* save state so that we don't lose these new Sources */
 
-               for (vector<string>::iterator i = new_paths.begin(); i != new_paths.end(); ++i) {
-                       sys::remove (*i);
-               }
+               save_state (_name);
+
+               std::copy (all_new_sources.begin(), all_new_sources.end(), std::back_inserter(status.sources));
+       } else {
+               // this can throw...but it seems very unlikely
+               std::for_each (all_new_sources.begin(), all_new_sources.end(), remove_file_source);
        }
 
        status.done = true;
-
-       return ret;
 }
+