gtk2_ardour/editor_audio_import.cc

   1 /*
   2     Copyright (C) 2000-2006 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 <sys/types.h>
  21 #include <sys/stat.h>
  22 #include <errno.h>
  23 #include <unistd.h>
  24
  25 #include <pbd/pthread_utils.h>
  26 #include <pbd/basename.h>
  27 #include <pbd/shortpath.h>
  28
  29 #include <gtkmm2ext/choice.h>
  30 #include <gtkmm2ext/window_title.h>
  31
  32 #include <ardour/session.h>
  33 #include <ardour/audioplaylist.h>
  34 #include <ardour/audioregion.h>
  35 #include <ardour/audio_diskstream.h>
  36 #include <ardour/utils.h>
  37 #include <ardour/audio_track.h>
  38 #include <ardour/audioplaylist.h>
  39 #include <ardour/audiofilesource.h>
  40 #include <ardour/region_factory.h>
  41 #include <ardour/source_factory.h>
  42 #include <pbd/memento_command.h>
  43
  44 #include "ardour_ui.h"
  45 #include "editor.h"
  46 #include "sfdb_ui.h"
  47 #include "editing.h"
  48 #include "audio_time_axis.h"
  49 #include "utils.h"
  50
  51 #include "i18n.h"
  52
  53 using namespace std;
  54 using namespace ARDOUR;
  55 using namespace PBD;
  56 using namespace sigc;
  57 using namespace Gtk;
  58 using namespace Gtkmm2ext;
  59 using namespace Editing;
  60 using Glib::ustring;
  61
  62 /* Functions supporting the incorporation of external (non-captured) audio material into ardour */
  63
  64 void
  65 Editor::add_external_audio_action (ImportMode mode)
  66 {
  67         nframes_t& pos = edit_cursor->current_frame;
  68         boost::shared_ptr<AudioTrack> track;
  69
  70         if (!selection->tracks.empty()) {
  71                 AudioTimeAxisView* atv = dynamic_cast<AudioTimeAxisView*>(selection->tracks.front());
  72                 if (atv) {
  73                         track = atv->audio_track();
  74                 }
  75         }
  76
  77         bring_in_external_audio (mode, track.get(), pos, false);
  78 }
  79
  80 void
  81 Editor::bring_in_external_audio (ImportMode mode, AudioTrack* track, nframes_t& pos, bool prompt)
  82 {
  83         if (session == 0) {
  84                 MessageDialog msg (0, _("You can't import or embed an audiofile until you have a session loaded."));
  85                 msg.run ();
  86                 return;
  87         }
  88
  89         SoundFileOmega sfdb (_("Add existing audio to session"), session);
  90         sfdb.set_mode (mode);
  91
  92         switch (sfdb.run()) {
  93         case SoundFileOmega::ResponseImport:
  94                 do_import (sfdb.get_paths(), sfdb.get_split(), sfdb.get_mode(), track, pos, prompt);
  95                 break;
  96
  97         case SoundFileOmega::ResponseEmbed:
  98                 do_embed (sfdb.get_paths(), sfdb.get_split(), sfdb.get_mode(), track, pos, prompt);
  99                 break;
 100
 101         default:
 102                 break;
 103         }
 104 }
 105
 106 void
 107 Editor::do_import (vector<ustring> paths, bool split, ImportMode mode, AudioTrack* track, nframes_t& pos, bool prompt)
 108 {
 109         /* SFDB sets "multichan" to true to indicate "split channels"
 110            so reverse the setting to match the way libardour
 111            interprets it.
 112         */
 113
 114         import_status.multichan = !split;
 115
 116         if (interthread_progress_window == 0) {
 117                 build_interthread_progress_window ();
 118         }
 119
 120         vector<ustring> to_import;
 121
 122         for (vector<ustring>::iterator a = paths.begin(); a != paths.end(); ++a) {
 123
 124                 to_import.clear ();
 125                 to_import.push_back (*a);
 126
 127                 import_sndfile (to_import, mode, track, pos);
 128         }
 129
 130         interthread_progress_window->hide_all ();
 131 }
 132
 133 void
 134 Editor::do_embed (vector<ustring> paths, bool split, ImportMode mode, AudioTrack* track, nframes_t& pos, bool prompt)
 135 {
 136         bool multiple_files = paths.size() > 1;
 137         bool check_sample_rate = true;
 138         vector<ustring>::iterator a;
 139
 140         for (a = paths.begin(); a != paths.end(); ) {
 141
 142                 cerr << "Considering embed of " << (*a) << endl;
 143
 144                 Glib::ustring path = *a;
 145                 Glib::ustring pair_base;
 146                 vector<ustring> to_embed;
 147
 148                 to_embed.push_back (path);
 149                 a = paths.erase (a);
 150
 151                 if (path_is_paired (path, pair_base)) {
 152
 153                         ustring::size_type len = pair_base.length();
 154
 155                         for (vector<Glib::ustring>::iterator b = paths.begin(); b != paths.end(); ) {
 156
 157                                 if (((*b).substr (0, len) == pair_base) && ((*b).length() == path.length())) {
 158
 159                                         to_embed.push_back (*b);
 160
 161                                         /* don't process this one again */
 162
 163                                         b = paths.erase (b);
 164                                         break;
 165
 166                                 } else {
 167                                         ++b;
 168                                 }
 169                         }
 170                 }
 171
 172                 if (to_embed.size() > 1) {
 173
 174                         vector<string> choices;
 175
 176                         choices.push_back (string_compose (_("Import as a %1 region"),
 177                                                            to_embed.size() > 2 ? _("multichannel") : _("stereo")));
 178                         choices.push_back (_("Import as multiple regions"));
 179
 180                         Choice chooser (string_compose (_("Paired files detected (%1, %2 ...).\nDo you want to:"),
 181                                                                    to_embed[0],
 182                                                                    to_embed[1]),
 183                                                    choices);
 184
 185                         if (chooser.run () == 0) {
 186
 187                                 /* keep them paired */
 188
 189                                 if (embed_sndfile (to_embed, split, multiple_files, check_sample_rate, mode, track, pos, prompt) < -1) {
 190                                         break;
 191                                 }
 192
 193                         } else {
 194
 195                                 /* one thing per file */
 196
 197                                 vector<ustring> foo;
 198
 199                                 for (vector<ustring>::iterator x = to_embed.begin(); x != to_embed.end(); ++x) {
 200
 201                                         foo.clear ();
 202                                         foo.push_back (*x);
 203
 204                                         if (embed_sndfile (foo, split, multiple_files, check_sample_rate, mode, track, pos, prompt) < -1) {
 205                                                 break;
 206                                         }
 207                                 }
 208                         }
 209
 210                 } else {
 211
 212                         if (embed_sndfile (to_embed, split, multiple_files, check_sample_rate, mode, track, pos, prompt) < -1) {
 213                                 break;
 214                         }
 215                 }
 216         }
 217
 218         if (a == paths.end()) {
 219                 session->save_state ("");
 220         }
 221 }
 222
 223 int
 224 Editor::import_sndfile (vector<ustring> paths, ImportMode mode, AudioTrack* track, nframes_t& pos)
 225 {
 226         WindowTitle title = string_compose (_("importing %1"), paths.front());
 227
 228         interthread_progress_window->set_title (title.get_string());
 229         interthread_progress_window->set_position (Gtk::WIN_POS_MOUSE);
 230         interthread_progress_window->show_all ();
 231         interthread_progress_bar.set_fraction (0.0f);
 232         interthread_cancel_label.set_text (_("Cancel Import"));
 233         current_interthread_info = &import_status;
 234
 235         import_status.paths = paths;
 236         import_status.done = false;
 237         import_status.cancel = false;
 238         import_status.freeze = false;
 239         import_status.done = 0.0;
 240
 241         interthread_progress_connection = Glib::signal_timeout().connect
 242                 (bind (mem_fun(*this, &Editor::import_progress_timeout), (gpointer) 0), 100);
 243
 244         track_canvas.get_window()->set_cursor (Gdk::Cursor (Gdk::WATCH));
 245         ARDOUR_UI::instance()->flush_pending ();
 246
 247         /* start import thread for this spec. this will ultimately call Session::import_audiofile()
 248            and if successful will add the file(s) as a region to the session region list.
 249         */
 250
 251         pthread_create_and_store ("import", &import_status.thread, 0, _import_thread, this);
 252         pthread_detach (import_status.thread);
 253
 254         while (!(import_status.done || import_status.cancel)) {
 255                 gtk_main_iteration ();
 256         }
 257
 258         interthread_progress_window->hide ();
 259
 260         import_status.done = true;
 261         interthread_progress_connection.disconnect ();
 262
 263         /* import thread finished - see if we should build a new track */
 264
 265         if (!import_status.new_regions.empty()) {
 266                 boost::shared_ptr<AudioRegion> region = boost::dynamic_pointer_cast<AudioRegion>(import_status.new_regions.front());
 267                 finish_bringing_in_audio (region, region->n_channels(), region->n_channels(), track, pos, mode);
 268         }
 269
 270         track_canvas.get_window()->set_cursor (*current_canvas_cursor);
 271         return 0;
 272 }
 273
 274 int
 275 Editor::embed_sndfile (vector<Glib::ustring> paths, bool split, bool multiple_files, bool& check_sample_rate, ImportMode mode,
 276                        AudioTrack* track, nframes_t& pos, bool prompt)
 277 {
 278         boost::shared_ptr<AudioFileSource> source;
 279         SourceList sources;
 280         boost::shared_ptr<AudioRegion> region;
 281         string linked_path;
 282         SoundFileInfo finfo;
 283         ustring region_name;
 284         uint32_t input_chan = 0;
 285         uint32_t output_chan = 0;
 286         int ret = 0;
 287
 288         track_canvas.get_window()->set_cursor (Gdk::Cursor (Gdk::WATCH));
 289         ARDOUR_UI::instance()->flush_pending ();
 290
 291         for (vector<Glib::ustring>::iterator p = paths.begin(); p != paths.end(); ++p) {
 292
 293                 ustring path = *p;
 294
 295                 /* lets see if we can link it into the session */
 296
 297                 linked_path = session->sound_dir();
 298                 linked_path += '/';
 299                 linked_path += Glib::path_get_basename (path);
 300
 301                 if (link (path.c_str(), linked_path.c_str()) == 0) {
 302
 303                         /* there are many reasons why link(2) might have failed.
 304                            but if it succeeds, we now have a link in the
 305                            session sound dir that will protect against
 306                            unlinking of the original path. nice.
 307                         */
 308
 309                         path = linked_path;
 310
 311                 } else {
 312
 313                         /* one possible reason is that its already linked */
 314
 315                         if (errno == EEXIST) {
 316                                 struct stat sb;
 317
 318                                 if (stat (linked_path.c_str(), &sb) == 0) {
 319                                         if (sb.st_nlink > 1) { // its a hard link, assume its the one we want
 320                                                 path = linked_path;
 321                                         }
 322                                 }
 323                         }
 324
 325                 }
 326
 327                 /* note that we temporarily truncated _id at the colon */
 328
 329                 string error_msg;
 330
 331                 if (!AudioFileSource::get_soundfile_info (path, finfo, error_msg)) {
 332                         error << string_compose(_("Editor: cannot open file \"%1\", (%2)"), selection, error_msg ) << endmsg;
 333                         goto out;
 334                 }
 335
 336                 if (check_sample_rate  && (finfo.samplerate != (int) session->frame_rate())) {
 337                         vector<string> choices;
 338
 339                         if (multiple_files) {
 340                                 choices.push_back (_("Cancel entire import"));
 341                                 choices.push_back (_("Don't embed it"));
 342                                 choices.push_back (_("Embed all without questions"));
 343
 344                                 Gtkmm2ext::Choice rate_choice (
 345                                         string_compose (_("%1\nThis audiofile's sample rate doesn't match the session sample rate!"),
 346                                                         short_path (path, 40)),
 347                                         choices, false);
 348
 349                                 int resx = rate_choice.run ();
 350
 351                                 switch (resx) {
 352                                 case 0: /* stop a multi-file import */
 353                                 case 1: /* don't import this one */
 354                                         ret = -1;
 355                                         goto out;
 356                                 case 2: /* do it, and the rest without asking */
 357                                         check_sample_rate = false;
 358                                         break;
 359                                 case 3: /* do it */
 360                                         break;
 361                                 default:
 362                                         ret = -2;
 363                                         goto out;
 364                                 }
 365                         } else {
 366                                 choices.push_back (_("Cancel"));
 367                                 choices.push_back (_("Embed it anyway"));
 368
 369                                 Gtkmm2ext::Choice rate_choice (
 370                                         string_compose (_("%1\nThis audiofile's sample rate doesn't match the session sample rate!"), path),
 371                                         choices, false);
 372
 373                                 int resx = rate_choice.run ();
 374
 375                                 switch (resx) {
 376                                 case 0: /* don't import */
 377                                         ret = -1;
 378                                         goto out;
 379                                 case 1: /* do it */
 380                                         break;
 381                                 default:
 382                                         ret = -2;
 383                                         goto out;
 384                                 }
 385                         }
 386                 }
 387
 388                 track_canvas.get_window()->set_cursor (Gdk::Cursor (Gdk::WATCH));
 389                 ARDOUR_UI::instance()->flush_pending ();
 390
 391                 /* make the proper number of channels in the region */
 392
 393                 input_chan += finfo.channels;
 394
 395                 for (int n = 0; n < finfo.channels; ++n)
 396                 {
 397                         try {
 398
 399                                 /* check if we have this thing embedded already */
 400
 401                                 boost::shared_ptr<Source> s;
 402
 403                                 if ((s = session->source_by_path_and_channel (path, n)) == 0) {
 404                                         source = boost::dynamic_pointer_cast<AudioFileSource> (SourceFactory::createReadable
 405                                                                                                (DataType::AUDIO, *session, path,  n,
 406                                                                                                 (mode == ImportAsTapeTrack ?
 407                                                                                                  AudioFileSource::Destructive :
 408                                                                                                  AudioFileSource::Flag (0))));
 409                                 } else {
 410                                         source = boost::dynamic_pointer_cast<AudioFileSource> (s);
 411                                 }
 412
 413                                 sources.push_back(source);
 414                         }
 415
 416                         catch (failed_constructor& err) {
 417                                 error << string_compose(_("could not open %1"), path) << endmsg;
 418                                 goto out;
 419                         }
 420
 421                         ARDOUR_UI::instance()->flush_pending ();
 422                 }
 423         }
 424
 425         if (sources.empty()) {
 426                 goto out;
 427         }
 428
 429         if (sources[0]->natural_position() != 0) {
 430                 pos = sources[0]->natural_position();
 431         }
 432
 433         region_name = region_name_from_path (paths.front(), (sources.size() > 1));
 434
 435         region = boost::dynamic_pointer_cast<AudioRegion> (RegionFactory::create (sources, 0, sources[0]->length(), region_name, 0,
 436                                                                                   Region::Flag (Region::DefaultFlags|Region::WholeFile|Region::External)));
 437
 438         if (Config->get_output_auto_connect() & AutoConnectMaster) {
 439                 output_chan = (session->master_out() ? session->master_out()->n_inputs().n_audio() : input_chan);
 440         } else {
 441                 output_chan = input_chan;
 442         }
 443
 444         finish_bringing_in_audio (region, input_chan, output_chan, track, pos, mode);
 445
 446   out:
 447         track_canvas.get_window()->set_cursor (*current_canvas_cursor);
 448         return ret;
 449 }
 450
 451 int
 452 Editor::finish_bringing_in_audio (boost::shared_ptr<AudioRegion> region, uint32_t in_chans, uint32_t out_chans, AudioTrack* track, nframes_t& pos, ImportMode mode)
 453 {
 454         switch (mode) {
 455         case ImportAsRegion:
 456                 /* relax, its been done */
 457                 break;
 458
 459         case ImportToTrack:
 460                 if (track) {
 461                         boost::shared_ptr<Playlist> playlist = track->diskstream()->playlist();
 462
 463                         boost::shared_ptr<AudioRegion> copy (boost::dynamic_pointer_cast<AudioRegion> (RegionFactory::create (region)));
 464                         begin_reversible_command (_("insert sndfile"));
 465                         XMLNode &before = playlist->get_state();
 466                         playlist->add_region (copy, pos);
 467                         session->add_command (new MementoCommand<Playlist>(*playlist, &before, &playlist->get_state()));
 468                         commit_reversible_command ();
 469
 470                         pos += region->length();
 471                 }
 472                 break;
 473
 474         case ImportAsTrack:
 475         {
 476                 list<boost::shared_ptr<AudioTrack> > at (session->new_audio_track (in_chans, out_chans, Normal, 1));
 477                 if (!at.empty()) {
 478                         boost::shared_ptr<AudioRegion> copy (boost::dynamic_pointer_cast<AudioRegion> (RegionFactory::create (region)));
 479                         at.front()->diskstream()->playlist()->add_region (copy, pos);
 480                 }
 481                 break;
 482         }
 483
 484         case ImportAsTapeTrack:
 485         {
 486                 list<boost::shared_ptr<AudioTrack> > at (session->new_audio_track (in_chans, out_chans, Destructive));
 487                 if (!at.empty()) {
 488                         boost::shared_ptr<AudioRegion> copy (boost::dynamic_pointer_cast<AudioRegion> (RegionFactory::create (region)));
 489                         at.front()->diskstream()->playlist()->add_region (copy, pos);
 490                 }
 491                 break;
 492         }
 493         }
 494
 495         return 0;
 496 }
 497
 498 void *
 499 Editor::_import_thread (void *arg)
 500 {
 501         PBD::ThreadCreated (pthread_self(), X_("Import"));
 502
 503         Editor *ed = (Editor *) arg;
 504         return ed->import_thread ();
 505 }
 506
 507 void *
 508 Editor::import_thread ()
 509 {
 510         session->import_audiofile (import_status);
 511         pthread_exit_pbd (0);
 512         /*NOTREACHED*/
 513         return 0;
 514 }
 515
 516 gint
 517 Editor::import_progress_timeout (void *arg)
 518 {
 519         interthread_progress_label.set_text (import_status.doing_what);
 520
 521         if (import_status.freeze) {
 522                 interthread_cancel_button.set_sensitive(false);
 523         } else {
 524                 interthread_cancel_button.set_sensitive(true);
 525         }
 526
 527         if (import_status.doing_what == "building peak files") {
 528                 interthread_progress_bar.pulse ();
 529                 return FALSE;
 530         } else {
 531                 interthread_progress_bar.set_fraction (import_status.progress);
 532         }
 533
 534         return !(import_status.done || import_status.cancel);
 535 }
 536