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