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