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