2 Copyright (C) 2000-2006 Paul Davis
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.
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.
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.
20 #include <sys/types.h>
28 #include <pbd/pthread_utils.h>
29 #include <pbd/basename.h>
30 #include <pbd/shortpath.h>
32 #include <gtkmm2ext/choice.h>
33 #include <gtkmm2ext/window_title.h>
35 #include <ardour/session.h>
36 #include <ardour/audioplaylist.h>
37 #include <ardour/audioregion.h>
38 #include <ardour/audio_diskstream.h>
39 #include <ardour/utils.h>
40 #include <ardour/audio_track.h>
41 #include <ardour/audioplaylist.h>
42 #include <ardour/audiofilesource.h>
43 #include <ardour/region_factory.h>
44 #include <ardour/source_factory.h>
45 #include <ardour/session.h>
46 #include <pbd/memento_command.h>
48 #include "ardour_ui.h"
52 #include "audio_time_axis.h"
58 using namespace ARDOUR;
62 using namespace Gtkmm2ext;
63 using namespace Editing;
66 /* Functions supporting the incorporation of external (non-captured) audio material into ardour */
69 Editor::add_external_audio_action (ImportMode mode_hint)
72 MessageDialog msg (0, _("You can't import or embed an audiofile until you have a session loaded."));
78 sfbrowser = new SoundFileOmega (*this, _("Add existing audio"), session, 0, true, mode_hint);
80 sfbrowser->set_mode (mode_hint);
83 external_audio_dialog ();
87 Editor::external_audio_dialog ()
89 vector<Glib::ustring> paths;
93 MessageDialog msg (0, _("You can't import or embed an audiofile until you have a session loaded."));
100 for (TrackSelection::iterator x = selection->tracks.begin(); x != selection->tracks.end(); ++x) {
101 AudioTimeAxisView* atv = dynamic_cast<AudioTimeAxisView*>(*x);
105 } else if (atv->is_audio_track()) {
110 if (sfbrowser == 0) {
111 sfbrowser = new SoundFileOmega (*this, _("Add existing audio"), session, track_cnt, true);
113 sfbrowser->reset (track_cnt);
116 sfbrowser->show_all ();
124 int response = sfbrowser->run ();
128 // leave the dialog open
136 // cancel from the browser - we are done
143 paths = sfbrowser->get_paths ();
145 ImportPosition pos = sfbrowser->get_position ();
146 ImportMode mode = sfbrowser->get_mode ();
147 ImportDisposition chns = sfbrowser->get_channel_disposition ();
151 case ImportAtEditPoint:
152 where = get_preferred_edit_position ();
154 case ImportAtTimestamp:
157 case ImportAtPlayhead:
158 where = playhead_cursor->current_frame;
161 where = session->current_start_frame();
165 SrcQuality quality = sfbrowser->get_src_quality();
168 if (sfbrowser->copy_files_btn.get_active()) {
169 do_import (paths, chns, mode, quality, where);
171 do_embed (paths, chns, mode, where);
174 if (response == RESPONSE_APPLY) {
175 sfbrowser->clear_selection ();
179 } while (keepRunning);
182 typedef std::map<PBD::ID,boost::shared_ptr<AudioSource> > AudioSourceList;
185 * Updating is still disabled, see note in libs/ardour/import.cc Session::import_audiofiles()
188 * true = show "Update", "Import" and "Skip"
189 * false = show "Import", and "Cancel"
192 * 0 To update an existing source of the same name
193 * 1 To import/embed the file normally (make sure the new name will be unique)
194 * 2 If the user wants to skip this file
197 Editor::check_whether_and_how_to_import(string path, bool all_or_nothing)
199 string wave_name (Glib::path_get_basename(path));
201 AudioSourceList all_sources = session->get_audio_sources();
202 bool wave_name_exists = false;
204 for (AudioSourceList::iterator i = all_sources.begin(); i != all_sources.end(); ++i) {
205 boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(i->second);
207 string tmp (Glib::path_get_basename (afs->path()));
209 if (tmp == wave_name) {
210 wave_name_exists = true;
218 if (wave_name_exists) {
220 if (all_or_nothing) {
221 // updating is still disabled
222 //message = string_compose(_("The session already contains a source file named %1. Do you want to update that file (and thus all regions using the file) or import this file as a new file?"),wave_name);
223 message = string_compose(_("The session already contains a source file named %1. This file will be imported as a new file, please confirm."),wave_name);
225 message = _("Lorem ipsum. Do you want to skidaddle?");
228 MessageDialog dialog(message, false,Gtk::MESSAGE_QUESTION, Gtk::BUTTONS_NONE, true);
230 if (all_or_nothing) {
232 //dialog.add_button("Update", 0);
233 dialog.add_button("Import", 1);
234 dialog.add_button("Skip", 2);
236 dialog.add_button("Import", 1);
237 dialog.add_button("Cancel", 2);
241 //dialog.add_button("Skip all", 4); // All or rest?
245 function = dialog.run ();
253 boost::shared_ptr<AudioTrack>
254 Editor::get_nth_selected_audio_track (int nth) const
256 AudioTimeAxisView* atv;
257 TrackSelection::iterator x;
259 for (x = selection->tracks.begin(); nth > 0 && x != selection->tracks.end(); ++x) {
261 atv = dynamic_cast<AudioTimeAxisView*>(*x);
265 } else if (atv->is_audio_track()) {
270 if (x == selection->tracks.end()) {
271 atv = dynamic_cast<AudioTimeAxisView*>(selection->tracks.back());
273 atv = dynamic_cast<AudioTimeAxisView*>(*x);
276 if (!atv || !atv->is_audio_track()) {
277 return boost::shared_ptr<AudioTrack>();
280 return atv->audio_track();
284 Editor::idle_do_import (vector<ustring> paths, ImportDisposition chns, ImportMode mode, SrcQuality quality, nframes64_t& pos)
286 _do_import (paths, chns, mode, quality, pos);
291 Editor::do_import (vector<ustring> paths, ImportDisposition chns, ImportMode mode, SrcQuality quality, nframes64_t& pos)
294 Glib::signal_idle().connect (bind (mem_fun (*this, &Editor::idle_do_import), paths, chns, mode, quality, pos));
296 _do_import (paths, chns, mode, quality, pos);
301 Editor::_do_import (vector<ustring> paths, ImportDisposition chns, ImportMode mode, SrcQuality quality, nframes64_t& pos)
303 boost::shared_ptr<AudioTrack> track;
304 vector<ustring> to_import;
308 if (interthread_progress_window == 0) {
309 build_interthread_progress_window ();
313 if (chns == Editing::ImportMergeFiles) {
314 /* create 1 region from all paths, add to 1 track,
318 for (vector<ustring>::iterator a = paths.begin(); a != paths.end() && ok; ++a) {
319 int check = check_whether_and_how_to_import(*a, false);
327 if (import_sndfiles (paths, mode, quality, pos, 1, 1, track, false)) {
335 for (vector<ustring>::iterator a = paths.begin(); a != paths.end() && ok; ++a) {
337 int check = check_whether_and_how_to_import(*a, true);
345 fatal << "Updating existing sources should be disabled!" << endl;
347 } else if (check == 1) {
353 case Editing::ImportDistinctFiles:
356 to_import.push_back (*a);
358 if (mode == Editing::ImportToTrack) {
359 track = get_nth_selected_audio_track (nth++);
362 if (import_sndfiles (to_import, mode, quality, pos, 1, -1, track, replace)) {
368 case Editing::ImportDistinctChannels:
371 to_import.push_back (*a);
373 if (import_sndfiles (to_import, mode, quality, pos, -1, -1, track, replace)) {
379 case Editing::ImportSerializeFiles:
382 to_import.push_back (*a);
384 /* create 1 region from this path, add to 1 track,
385 reuse "track" across paths
388 if (import_sndfiles (to_import, mode, quality, pos, 1, 1, track, replace)) {
394 case Editing::ImportMergeFiles:
401 session->save_state ("");
404 interthread_progress_window->hide_all ();
409 Editor::idle_do_embed (vector<ustring> paths, ImportDisposition chns, ImportMode mode, nframes64_t& pos)
411 _do_embed (paths, chns, mode, pos);
416 Editor::do_embed (vector<ustring> paths, ImportDisposition chns, ImportMode mode, nframes64_t& pos)
419 Glib::signal_idle().connect (bind (mem_fun (*this, &Editor::idle_do_embed), paths, chns, mode, pos));
421 _do_embed (paths, chns, mode, pos);
426 Editor::_do_embed (vector<ustring> paths, ImportDisposition chns, ImportMode mode, nframes64_t& pos)
428 boost::shared_ptr<AudioTrack> track;
429 bool check_sample_rate = true;
431 vector<ustring> to_embed;
432 bool multi = paths.size() > 1;
436 case Editing::ImportDistinctFiles:
437 for (vector<ustring>::iterator a = paths.begin(); a != paths.end(); ++a) {
440 to_embed.push_back (*a);
442 if (mode == Editing::ImportToTrack) {
443 track = get_nth_selected_audio_track (nth++);
446 if (embed_sndfiles (to_embed, multi, check_sample_rate, mode, pos, 1, -1, track) < -1) {
452 case Editing::ImportDistinctChannels:
453 for (vector<ustring>::iterator a = paths.begin(); a != paths.end(); ++a) {
456 to_embed.push_back (*a);
458 if (embed_sndfiles (to_embed, multi, check_sample_rate, mode, pos, -1, -1, track) < -1) {
464 case Editing::ImportMergeFiles:
465 if (embed_sndfiles (paths, multi, check_sample_rate, mode, pos, 1, 1, track) < -1) {
470 case Editing::ImportSerializeFiles:
471 for (vector<ustring>::iterator a = paths.begin(); a != paths.end(); ++a) {
474 to_embed.push_back (*a);
476 if (embed_sndfiles (to_embed, multi, check_sample_rate, mode, pos, 1, 1, track) < -1) {
487 session->save_state ("");
492 Editor::import_sndfiles (vector<ustring> paths, ImportMode mode, SrcQuality quality, nframes64_t& pos,
493 int target_regions, int target_tracks, boost::shared_ptr<AudioTrack>& track, bool replace)
495 WindowTitle title = string_compose (_("importing %1"), paths.front());
497 interthread_progress_window->set_title (title.get_string());
498 interthread_progress_window->set_position (Gtk::WIN_POS_MOUSE);
499 interthread_progress_window->show_all ();
500 interthread_progress_bar.set_fraction (0.0f);
501 interthread_cancel_label.set_text (_("Cancel Import"));
502 current_interthread_info = &import_status;
504 import_status.paths = paths;
505 import_status.done = false;
506 import_status.cancel = false;
507 import_status.freeze = false;
508 import_status.done = 0.0;
509 import_status.quality = quality;
510 import_status.replace_existing_source = replace;
512 interthread_progress_connection = Glib::signal_timeout().connect
513 (bind (mem_fun(*this, &Editor::import_progress_timeout), (gpointer) 0), 100);
515 track_canvas->get_window()->set_cursor (Gdk::Cursor (Gdk::WATCH));
516 ARDOUR_UI::instance()->flush_pending ();
518 /* start import thread for this spec. this will ultimately call Session::import_audiofile()
519 and if successful will add the file(s) as a region to the session region list.
522 pthread_create_and_store ("import", &import_status.thread, 0, _import_thread, this);
523 pthread_detach (import_status.thread);
525 while (!(import_status.done || import_status.cancel)) {
526 gtk_main_iteration ();
529 interthread_progress_window->hide ();
531 import_status.done = true;
532 interthread_progress_connection.disconnect ();
534 /* import thread finished - see if we should build a new track */
536 boost::shared_ptr<AudioRegion> r;
538 if (import_status.cancel || import_status.sources.empty()) {
542 if (add_sources (paths, import_status.sources, pos, mode, target_regions, target_tracks, track, false) == 0) {
543 session->save_state ("");
547 track_canvas->get_window()->set_cursor (*current_canvas_cursor);
552 Editor::embed_sndfiles (vector<Glib::ustring> paths, bool multifile,
553 bool& check_sample_rate, ImportMode mode, nframes64_t& pos, int target_regions, int target_tracks,
554 boost::shared_ptr<AudioTrack>& track)
556 boost::shared_ptr<AudioFileSource> source;
562 track_canvas->get_window()->set_cursor (Gdk::Cursor (Gdk::WATCH));
563 ARDOUR_UI::instance()->flush_pending ();
565 for (vector<Glib::ustring>::iterator p = paths.begin(); p != paths.end(); ++p) {
569 /* lets see if we can link it into the session */
571 linked_path = session->sound_dir();
573 linked_path += Glib::path_get_basename (path);
575 if (link (path.c_str(), linked_path.c_str()) == 0) {
577 /* there are many reasons why link(2) might have failed.
578 but if it succeeds, we now have a link in the
579 session sound dir that will protect against
580 unlinking of the original path. nice.
587 /* one possible reason is that its already linked */
589 if (errno == EEXIST) {
592 if (stat (linked_path.c_str(), &sb) == 0) {
593 if (sb.st_nlink > 1) { // its a hard link, assume its the one we want
600 /* note that we temporarily truncated _id at the colon */
604 if (!AudioFileSource::get_soundfile_info (path, finfo, error_msg)) {
605 error << string_compose(_("Editor: cannot open file \"%1\", (%2)"), path, error_msg ) << endmsg;
609 if (check_sample_rate && (finfo.samplerate != (int) session->frame_rate())) {
610 vector<string> choices;
613 choices.push_back (_("Cancel entire import"));
614 choices.push_back (_("Don't embed it"));
615 choices.push_back (_("Embed all without questions"));
617 Gtkmm2ext::Choice rate_choice (
618 string_compose (_("%1\nThis audiofile's sample rate doesn't match the session sample rate!"),
619 short_path (path, 40)),
622 int resx = rate_choice.run ();
625 case 0: /* stop a multi-file import */
628 case 1: /* don't embed this one */
631 case 2: /* do it, and the rest without asking */
632 check_sample_rate = false;
641 choices.push_back (_("Cancel"));
642 choices.push_back (_("Embed it anyway"));
644 Gtkmm2ext::Choice rate_choice (
645 string_compose (_("%1\nThis audiofile's sample rate doesn't match the session sample rate!"), path),
648 int resx = rate_choice.run ();
651 case 0: /* don't import */
663 track_canvas->get_window()->set_cursor (Gdk::Cursor (Gdk::WATCH));
665 for (int n = 0; n < finfo.channels; ++n) {
668 /* check if we have this thing embedded already */
670 boost::shared_ptr<Source> s;
672 if ((s = session->source_by_path_and_channel (path, n)) == 0) {
674 cerr << "add embed/import source with defer_peaks = true\n";
676 source = boost::dynamic_pointer_cast<AudioFileSource> (SourceFactory::createReadable
678 (mode == ImportAsTapeTrack ?
679 AudioFileSource::Destructive :
680 AudioFileSource::Flag (0)),
683 source = boost::dynamic_pointer_cast<AudioFileSource> (s);
686 sources.push_back(source);
689 catch (failed_constructor& err) {
690 error << string_compose(_("could not open %1"), path) << endmsg;
694 ARDOUR_UI::instance()->flush_pending ();
698 if (sources.empty()) {
702 ret = add_sources (paths, sources, pos, mode, target_regions, target_tracks, track, true);
705 track_canvas->get_window()->set_cursor (*current_canvas_cursor);
710 Editor::add_sources (vector<Glib::ustring> paths, SourceList& sources, nframes64_t& pos, ImportMode mode,
711 int target_regions, int target_tracks, boost::shared_ptr<AudioTrack>& track, bool add_channel_suffix)
713 vector<boost::shared_ptr<AudioRegion> > regions;
715 uint32_t input_chan = 0;
716 uint32_t output_chan = 0;
718 if (pos == -1) { // "use timestamp"
719 if (sources[0]->natural_position() != 0) {
720 pos = sources[0]->natural_position();
722 pos = get_preferred_edit_position ();
726 if (target_regions == 1) {
728 /* take all the sources we have and package them up as a region */
730 region_name = region_name_from_path (paths.front(), (sources.size() > 1), false);
732 regions.push_back (boost::dynamic_pointer_cast<AudioRegion>
733 (RegionFactory::create (sources, 0, sources[0]->length(), region_name, 0,
734 Region::Flag (Region::DefaultFlags|Region::WholeFile|Region::External))));
736 } else if (target_regions == -1) {
738 /* take each source and create a region for each one */
741 SourceList::iterator x;
744 for (n = 0, x = sources.begin(); x != sources.end(); ++x, ++n) {
747 just_one.push_back (*x);
749 boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource> (*x);
751 region_name = region_name_from_path (afs->path(), false, true, sources.size(), n);
753 regions.push_back (boost::dynamic_pointer_cast<AudioRegion>
754 (RegionFactory::create (just_one, 0, (*x)->length(), region_name, 0,
755 Region::Flag (Region::DefaultFlags|Region::WholeFile|Region::External))));
760 if (target_regions == 1) {
761 input_chan = regions.front()->n_channels();
763 if (target_tracks == 1) {
764 input_chan = regions.size();
770 if (Config->get_output_auto_connect() & AutoConnectMaster) {
771 output_chan = (session->master_out() ? session->master_out()->n_inputs() : input_chan);
773 output_chan = input_chan;
778 for (vector<boost::shared_ptr<AudioRegion> >::iterator r = regions.begin(); r != regions.end(); ++r, ++n) {
780 finish_bringing_in_audio (*r, input_chan, output_chan, pos, mode, track);
782 if (target_tracks != 1) {
785 pos += (*r)->length();
789 /* setup peak file building in another thread */
791 for (SourceList::iterator x = sources.begin(); x != sources.end(); ++x) {
792 SourceFactory::setup_peakfile (*x, true);
799 Editor::finish_bringing_in_audio (boost::shared_ptr<AudioRegion> region, uint32_t in_chans, uint32_t out_chans, nframes64_t& pos,
800 ImportMode mode, boost::shared_ptr<AudioTrack>& existing_track)
804 /* relax, its been done */
809 if (!existing_track) {
811 existing_track = get_nth_selected_audio_track (0);
813 if (!existing_track) {
818 boost::shared_ptr<Playlist> playlist = existing_track->diskstream()->playlist();
819 boost::shared_ptr<AudioRegion> copy (boost::dynamic_pointer_cast<AudioRegion> (RegionFactory::create (region)));
820 begin_reversible_command (_("insert sndfile"));
821 XMLNode &before = playlist->get_state();
822 playlist->add_region (copy, pos);
823 session->add_command (new MementoCommand<Playlist>(*playlist, &before, &playlist->get_state()));
824 commit_reversible_command ();
830 if (!existing_track) {
831 list<boost::shared_ptr<AudioTrack> > at (session->new_audio_track (in_chans, out_chans, Normal, 1));
837 existing_track = at.front();
838 existing_track->set_name (region->name(), this);
841 boost::shared_ptr<AudioRegion> copy (boost::dynamic_pointer_cast<AudioRegion> (RegionFactory::create (region)));
842 existing_track->diskstream()->playlist()->add_region (copy, pos);
847 case ImportAsTapeTrack:
849 list<boost::shared_ptr<AudioTrack> > at (session->new_audio_track (in_chans, out_chans, Destructive));
851 boost::shared_ptr<AudioRegion> copy (boost::dynamic_pointer_cast<AudioRegion> (RegionFactory::create (region)));
852 at.front()->set_name (basename_nosuffix (copy->name()), this);
853 at.front()->diskstream()->playlist()->add_region (copy, pos);
863 Editor::_import_thread (void *arg)
865 PBD::ThreadCreated (pthread_self(), X_("Import"));
867 Editor *ed = (Editor *) arg;
868 return ed->import_thread ();
872 Editor::import_thread ()
874 session->import_audiofiles (import_status);
875 pthread_exit_pbd (0);
881 Editor::import_progress_timeout (void *arg)
883 interthread_progress_label.set_text (import_status.doing_what);
885 if (import_status.freeze) {
886 interthread_cancel_button.set_sensitive(false);
888 interthread_cancel_button.set_sensitive(true);
891 if (import_status.doing_what == "building peak files") {
892 interthread_progress_bar.pulse ();
895 interthread_progress_bar.set_fraction (import_status.progress);
898 return !(import_status.done || import_status.cancel);