libs/ardour/import.cc

   1 /*
   2     Copyright (C) 2000 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #include <cstdio>
  21 #include <cstdlib>
  22 #include <string>
  23 #include <climits>
  24 #include <cerrno>
  25 #include <unistd.h>
  26 #include <sys/stat.h>
  27 #include <time.h>
  28
  29 #include <sndfile.h>
  30 #include <samplerate.h>
  31
  32 #include <glibmm.h>
  33
  34 #include <boost/scoped_array.hpp>
  35 #include <boost/shared_array.hpp>
  36
  37 #include <pbd/basename.h>
  38 #include <pbd/convert.h>
  39
  40 #include <evoral/SMFReader.hpp>
  41
  42 #include <ardour/ardour.h>
  43 #include <ardour/session.h>
  44 #include <ardour/session_directory.h>
  45 #include <ardour/audio_diskstream.h>
  46 #include <ardour/audioengine.h>
  47 #include <ardour/sndfilesource.h>
  48 #include <ardour/sndfile_helpers.h>
  49 #include <ardour/audioregion.h>
  50 #include <ardour/region_factory.h>
  51 #include <ardour/source_factory.h>
  52 #include <ardour/resampled_source.h>
  53 #include <ardour/sndfileimportable.h>
  54 #include <ardour/analyser.h>
  55 #include <ardour/smf_source.h>
  56 #include <ardour/tempo.h>
  57
  58 #ifdef HAVE_COREAUDIO
  59 #include <ardour/caimportable.h>
  60 #endif
  61
  62 #include "i18n.h"
  63
  64 using namespace ARDOUR;
  65 using namespace PBD;
  66
  67
  68 static boost::shared_ptr<ImportableSource>
  69 open_importable_source (const string& path, nframes_t samplerate, ARDOUR::SrcQuality quality)
  70 {
  71 #ifdef HAVE_COREAUDIO
  72
  73         /* see if we can use CoreAudio to handle the IO */
  74
  75         try {
  76                 boost::shared_ptr<CAImportableSource> source(new CAImportableSource(path));
  77
  78                 if (source->samplerate() == samplerate) {
  79                         return source;
  80                 }
  81
  82                 /* rewrap as a resampled source */
  83
  84                 return boost::shared_ptr<ImportableSource>(new ResampledImportableSource(source, samplerate, quality));
  85         }
  86
  87         catch (...) {
  88
  89                 /* fall back to SndFile */
  90
  91 #endif
  92
  93                 try {
  94                         boost::shared_ptr<SndFileImportableSource> source(new SndFileImportableSource(path));
  95
  96                         if (source->samplerate() == samplerate) {
  97                                 return source;
  98                         }
  99
 100                         /* rewrap as a resampled source */
 101
 102                         return boost::shared_ptr<ImportableSource>(new ResampledImportableSource(source, samplerate, quality));
 103                 }
 104
 105                 catch (...) {
 106                         throw; // rethrow
 107                 }
 108
 109 #ifdef HAVE_COREAUDIO
 110         }
 111 #endif
 112 }
 113
 114 static std::string
 115 get_non_existent_filename (DataType type, const bool allow_replacing, const std::string destdir, const std::string& basename, uint channel, uint channels)
 116 {
 117         char buf[PATH_MAX+1];
 118         bool goodfile = false;
 119         string base(basename);
 120         const char* ext = (type == DataType::AUDIO) ? "wav" : "mid";
 121
 122         do {
 123
 124                 if (type == DataType::AUDIO && channels == 2) {
 125                         if (channel == 0) {
 126                                 snprintf (buf, sizeof(buf), "%s-L.wav", base.c_str());
 127                         } else {
 128                                 snprintf (buf, sizeof(buf), "%s-R.wav", base.c_str());
 129                         }
 130                 } else if (channels > 1) {
 131                         snprintf (buf, sizeof(buf), "%s-c%d.%s", base.c_str(), channel, ext);
 132                 } else {
 133                         snprintf (buf, sizeof(buf), "%s.%s", base.c_str(), ext);
 134                 }
 135
 136
 137                 string tempname = destdir + "/" + buf;
 138                 if (!allow_replacing && Glib::file_test (tempname, Glib::FILE_TEST_EXISTS)) {
 139
 140                         /* if the file already exists, we must come up with
 141                          *  a new name for it.  for now we just keep appending
 142                          *  _ to basename
 143                          */
 144
 145                         base += "_";
 146
 147                 } else {
 148
 149                         goodfile = true;
 150                 }
 151
 152         } while ( !goodfile);
 153
 154         return buf;
 155 }
 156
 157 static vector<string>
 158 get_paths_for_new_sources (const bool allow_replacing, const string& import_file_path, const string& session_dir, uint channels)
 159 {
 160         vector<string> new_paths;
 161         const string basename = basename_nosuffix (import_file_path);
 162
 163         SessionDirectory sdir(session_dir);
 164
 165         for (uint n = 0; n < channels; ++n) {
 166
 167                 const DataType type = (import_file_path.rfind(".mid") != string::npos)
 168                                 ? DataType::MIDI : DataType::AUDIO;
 169
 170                 std::string filepath = (type == DataType::MIDI)
 171                                 ? sdir.midi_path().to_string() : sdir.sound_path().to_string();
 172
 173                 filepath += '/';
 174                 filepath += get_non_existent_filename (type, allow_replacing, filepath, basename, n, channels);
 175                 new_paths.push_back (filepath);
 176         }
 177
 178         return new_paths;
 179 }
 180
 181 static bool
 182 map_existing_mono_sources (const vector<string>& new_paths, Session& sess,
 183                            uint samplerate, vector<boost::shared_ptr<Source> >& newfiles, Session *session)
 184 {
 185         for (vector<string>::const_iterator i = new_paths.begin();
 186                         i != new_paths.end(); ++i)
 187         {
 188                 boost::shared_ptr<Source> source = session->source_by_path_and_channel(*i, 0);
 189
 190                 if (source == 0) {
 191                         error << string_compose(_("Could not find a source for %1 even though we are updating this file!"), (*i)) << endl;
 192                         return false;
 193                 }
 194
 195                 newfiles.push_back(boost::dynamic_pointer_cast<Source>(source));
 196         }
 197         return true;
 198 }
 199
 200 static bool
 201 create_mono_sources_for_writing (const vector<string>& new_paths, Session& sess,
 202                 uint samplerate, vector<boost::shared_ptr<Source> >& newfiles)
 203 {
 204         for (vector<string>::const_iterator i = new_paths.begin();
 205                         i != new_paths.end(); ++i)
 206         {
 207                 boost::shared_ptr<Source> source;
 208
 209                 try
 210                 {
 211                         const DataType type = ((*i).rfind(".mid") != string::npos)
 212                                 ? DataType::MIDI : DataType::AUDIO;
 213
 214                         source = SourceFactory::createWritable (
 215                                         type,
 216                                         sess,
 217                                         i->c_str(),
 218                                         false, // destructive
 219                                         samplerate
 220                                         );
 221                 }
 222                 catch (const failed_constructor& err)
 223                 {
 224                         error << string_compose (_("Unable to create file %1 during import"), *i) << endmsg;
 225                         return false;
 226                 }
 227
 228                 newfiles.push_back(boost::dynamic_pointer_cast<Source>(source));
 229         }
 230         return true;
 231 }
 232
 233 static Glib::ustring
 234 compose_status_message (const string& path,
 235                         uint file_samplerate,
 236                         uint session_samplerate,
 237                         uint current_file,
 238                         uint total_files)
 239 {
 240         if (file_samplerate != session_samplerate) {
 241                 return string_compose (_("converting %1\n(resample from %2KHz to %3KHz)\n(%4 of %5)"),
 242                                        Glib::path_get_basename (path),
 243                                        file_samplerate/1000.0f,
 244                                        session_samplerate/1000.0f,
 245                                        current_file, total_files);
 246         }
 247
 248         return  string_compose (_("converting %1\n(%2 of %3)"),
 249                                 Glib::path_get_basename (path),
 250                                 current_file, total_files);
 251 }
 252
 253 static void
 254 write_audio_data_to_new_files (ImportableSource* source, Session::import_status& status,
 255                                vector<boost::shared_ptr<Source> >& newfiles)
 256 {
 257         const nframes_t nframes = ResampledImportableSource::blocksize;
 258         boost::shared_ptr<AudioFileSource> afs;
 259         uint channels = source->channels();
 260
 261         boost::scoped_array<float> data(new float[nframes * channels]);
 262         vector<boost::shared_array<Sample> > channel_data;
 263
 264         for (uint n = 0; n < channels; ++n) {
 265                 channel_data.push_back(boost::shared_array<Sample>(new Sample[nframes]));
 266         }
 267
 268         uint read_count = 0;
 269         status.progress = 0.0f;
 270
 271         while (!status.cancel) {
 272
 273                 nframes_t nread, nfread;
 274                 uint x;
 275                 uint chn;
 276
 277                 if ((nread = source->read (data.get(), nframes)) == 0) {
 278                         break;
 279                 }
 280                 nfread = nread / channels;
 281
 282                 /* de-interleave */
 283
 284                 for (chn = 0; chn < channels; ++chn) {
 285
 286                         nframes_t n;
 287                         for (x = chn, n = 0; n < nfread; x += channels, ++n) {
 288                                 channel_data[chn][n] = (Sample) data[x];
 289                         }
 290                 }
 291
 292                 /* flush to disk */
 293
 294                 for (chn = 0; chn < channels; ++chn) {
 295                         if ((afs = boost::dynamic_pointer_cast<AudioFileSource>(newfiles[chn])) != 0) {
 296                                 afs->write (channel_data[chn].get(), nfread);
 297                         }
 298                 }
 299
 300                 read_count += nread;
 301                 status.progress = read_count / (source->ratio () * source->length() * channels);
 302         }
 303 }
 304
 305 static void
 306 write_midi_data_to_new_files (Evoral::SMFReader* source, Session::import_status& status,
 307                                vector<boost::shared_ptr<Source> >& newfiles)
 308 {
 309         Evoral::Event ev(0, 0.0, 4, NULL, true);
 310
 311         status.progress = 0.0f;
 312
 313         try {
 314
 315         for (unsigned i = 1; i <= source->num_tracks(); ++i) {
 316
 317                 boost::shared_ptr<SMFSource> smfs = boost::dynamic_pointer_cast<SMFSource>(newfiles[i-1]);
 318
 319                 source->seek_to_track(i);
 320
 321                 uint64_t t       = 0;
 322                 uint32_t delta_t = 0;
 323                 uint32_t size    = 0;
 324
 325                 while (!status.cancel) {
 326
 327                         if (source->read_event(4, ev.buffer(), &size, &delta_t) < 0)
 328                                 break;
 329
 330                         t += delta_t;
 331                         ev.time() = (double)t / (double)source->ppqn();
 332                         ev.size() = size;
 333
 334                         smfs->append_event_unlocked(Beats, ev);
 335                         if (status.progress < 0.99)
 336                                 status.progress += 0.01;
 337                 }
 338
 339                 nframes_t timeline_position = 0; // FIXME: ?
 340
 341                 // FIXME: kluuuuudge: assumes tempo never changes after start
 342                 const double frames_per_beat = smfs->session().tempo_map().tempo_at(
 343                                 timeline_position).frames_per_beat(
 344                                         smfs->session().engine().frame_rate(),
 345                                         smfs->session().tempo_map().meter_at(timeline_position));
 346
 347                 smfs->update_length(0, (nframes_t) ceil ((t / (double)source->ppqn()) * frames_per_beat));
 348                 smfs->end_write();
 349
 350                 if (status.cancel)
 351                         break;
 352         }
 353
 354         } catch (...) {
 355                 error << "Corrupt MIDI file " << source->filename() << endl;
 356         }
 357 }
 358
 359 static void
 360 remove_file_source (boost::shared_ptr<Source> source)
 361 {
 362         ::unlink (source->path().c_str());
 363 }
 364
 365 // This function is still unable to cleanly update an existing source, even though
 366 // it is possible to set the import_status flag accordingly. The functinality
 367 // is disabled at the GUI until the Source implementations are able to provide
 368 // the necessary API.
 369 void
 370 Session::import_audiofiles (import_status& status)
 371 {
 372         uint32_t cnt = 1;
 373         typedef vector<boost::shared_ptr<Source> > Sources;
 374         Sources all_new_sources;
 375         boost::shared_ptr<AudioFileSource> afs;
 376         boost::shared_ptr<SMFSource> smfs;
 377         uint channels = 0;
 378
 379         status.sources.clear ();
 380
 381         for (vector<Glib::ustring>::iterator p = status.paths.begin();
 382                         p != status.paths.end() && !status.cancel;
 383                         ++p, ++cnt)
 384         {
 385                 boost::shared_ptr<ImportableSource> source;
 386                 std::auto_ptr<Evoral::SMFReader>    smf_reader;
 387                 const DataType type = ((*p).rfind(".mid") != string::npos) ?
 388                         DataType::MIDI : DataType::AUDIO;
 389
 390                 if (type == DataType::AUDIO) {
 391                         try {
 392                                 source = open_importable_source (*p, frame_rate(), status.quality);
 393                                 channels = source->channels();
 394                         } catch (const failed_constructor& err) {
 395                                 error << string_compose(_("Import: cannot open input sound file \"%1\""), (*p)) << endmsg;
 396                                 status.done = status.cancel = true;
 397                                 return;
 398                         }
 399
 400                 } else {
 401                         try {
 402                                 smf_reader = std::auto_ptr<Evoral::SMFReader>(new Evoral::SMFReader(*p));
 403                                 channels = smf_reader->num_tracks();
 404                         } catch (const Evoral::SMFReader::UnsupportedTime& err) {
 405                                 error << _("Import: unsupported MIDI time stamp format") << endmsg;
 406                                 status.done = status.cancel = true;
 407                                 return;
 408                         } catch (...) {
 409                                 error << _("Import: error reading MIDI file") << endmsg;
 410                                 status.done = status.cancel = true;
 411                                 return;
 412                         }
 413                 }
 414
 415                 vector<string> new_paths = get_paths_for_new_sources (status.replace_existing_source, *p,
 416                                                                       get_best_session_directory_for_new_source (),
 417                                                                       channels);
 418                 Sources newfiles;
 419
 420                 if (status.replace_existing_source) {
 421                         fatal << "THIS IS NOT IMPLEMENTED YET, IT SHOULD NEVER GET CALLED!!! DYING!" << endl;
 422                         status.cancel = !map_existing_mono_sources (new_paths, *this, frame_rate(), newfiles, this);
 423                 } else {
 424                         status.cancel = !create_mono_sources_for_writing (new_paths, *this, frame_rate(), newfiles);
 425                 }
 426
 427                 // copy on cancel/failure so that any files that were created will be removed below
 428                 std::copy (newfiles.begin(), newfiles.end(), std::back_inserter(all_new_sources));
 429
 430                 if (status.cancel) break;
 431
 432                 for (Sources::iterator i = newfiles.begin(); i != newfiles.end(); ++i) {
 433                         if ((afs = boost::dynamic_pointer_cast<AudioFileSource>(*i)) != 0) {
 434                                 afs->prepare_for_peakfile_writes ();
 435                         }
 436                 }
 437
 438                 if (source) { // audio
 439                         status.doing_what = compose_status_message (*p, source->samplerate(),
 440                                                                     frame_rate(), cnt, status.paths.size());
 441                         write_audio_data_to_new_files (source.get(), status, newfiles);
 442                 } else if (smf_reader.get()) { // midi
 443                         status.doing_what = string_compose(_("loading MIDI file %1"), *p);
 444                         write_midi_data_to_new_files (smf_reader.get(), status, newfiles);
 445                 }
 446         }
 447
 448         if (!status.cancel) {
 449                 struct tm* now;
 450                 time_t xnow;
 451                 time (&xnow);
 452                 now = localtime (&xnow);
 453                 status.freeze = true;
 454
 455                 /* flush the final length(s) to the header(s) */
 456
 457                 for (Sources::iterator x = all_new_sources.begin(); x != all_new_sources.end(); ) {
 458                         if ((afs = boost::dynamic_pointer_cast<AudioFileSource>(*x)) != 0) {
 459                                 afs->update_header(0, *now, xnow);
 460                                 afs->done_with_peakfile_writes ();
 461
 462                                 /* now that there is data there, requeue the file for analysis */
 463
 464                                 if (Config->get_auto_analyse_audio()) {
 465                                         Analyser::queue_source_for_analysis (boost::static_pointer_cast<Source>(*x), false);
 466                                 }
 467                         }
 468
 469                         /* don't create tracks for empty MIDI sources (channels) */
 470
 471                         if ((smfs = boost::dynamic_pointer_cast<SMFSource>(*x)) != 0 && smfs->is_empty()) {
 472                                 x = all_new_sources.erase(x);
 473                         } else {
 474                                 ++x;
 475                         }
 476                 }
 477
 478                 /* save state so that we don't lose these new Sources */
 479
 480                 save_state (_name);
 481
 482                 std::copy (all_new_sources.begin(), all_new_sources.end(),
 483                                 std::back_inserter(status.sources));
 484         } else {
 485                 // this can throw...but it seems very unlikely
 486                 std::for_each (all_new_sources.begin(), all_new_sources.end(), remove_file_source);
 487         }
 488
 489         status.done = true;
 490 }
 491