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>
27 #include <glibmm/ustring.h>
31 #include "pbd/pthread_utils.h"
32 #include "pbd/basename.h"
33 #include "pbd/shortpath.h"
34 #include "pbd/stateful_diff_command.h"
36 #include <gtkmm2ext/choice.h>
38 #include "ardour/session.h"
39 #include "ardour/session_directory.h"
40 #include "ardour/audioplaylist.h"
41 #include "ardour/audioregion.h"
42 #include "ardour/audio_diskstream.h"
43 #include "ardour/midi_track.h"
44 #include "ardour/midi_region.h"
45 #include "ardour/utils.h"
46 #include "ardour/audio_track.h"
47 #include "ardour/audioplaylist.h"
48 #include "ardour/audiofilesource.h"
49 #include "ardour/region_factory.h"
50 #include "ardour/source_factory.h"
51 #include "ardour/session.h"
52 #include "ardour/smf_source.h"
53 #include "pbd/memento_command.h"
55 #include "ardour_ui.h"
59 #include "audio_time_axis.h"
60 #include "midi_time_axis.h"
61 #include "session_import_dialog.h"
63 #include "gui_thread.h"
64 #include "interthread_progress_window.h"
69 using namespace ARDOUR;
72 using namespace Gtkmm2ext;
73 using namespace Editing;
76 /* Functions supporting the incorporation of external (non-captured) audio material into ardour */
79 Editor::add_external_audio_action (ImportMode mode_hint)
82 MessageDialog msg (_("You can't import or embed an audiofile until you have a session loaded."));
88 sfbrowser = new SoundFileOmega (*this, _("Add Existing Media"), _session, 0, true, mode_hint);
90 sfbrowser->set_mode (mode_hint);
93 external_audio_dialog ();
97 Editor::external_audio_dialog ()
103 MessageDialog msg (_("You can't import or embed an audiofile until you have a session loaded."));
110 for (TrackSelection::iterator x = selection->tracks.begin(); x != selection->tracks.end(); ++x) {
111 AudioTimeAxisView* atv = dynamic_cast<AudioTimeAxisView*>(*x);
115 } else if (atv->is_audio_track()) {
120 if (sfbrowser == 0) {
121 sfbrowser = new SoundFileOmega (*this, _("Add Existing Media"), _session, track_cnt, true);
123 sfbrowser->reset (track_cnt);
126 sfbrowser->show_all ();
134 int response = sfbrowser->run ();
138 // leave the dialog open
146 // cancel from the browser - we are done
153 vector<ustring> upaths = sfbrowser->get_paths ();
154 for (vector<ustring>::iterator x = upaths.begin(); x != upaths.end(); ++x) {
155 paths.push_back (*x);
158 ImportPosition pos = sfbrowser->get_position ();
159 ImportMode mode = sfbrowser->get_mode ();
160 ImportDisposition chns = sfbrowser->get_channel_disposition ();
164 case ImportAtEditPoint:
165 where = get_preferred_edit_position ();
167 case ImportAtTimestamp:
170 case ImportAtPlayhead:
171 where = playhead_cursor->current_frame;
174 where = _session->current_start_frame();
178 SrcQuality quality = sfbrowser->get_src_quality();
181 if (sfbrowser->copy_files_btn.get_active()) {
182 do_import (paths, chns, mode, quality, where);
184 do_embed (paths, chns, mode, where);
187 if (response == RESPONSE_APPLY) {
188 sfbrowser->clear_selection ();
192 } while (keepRunning);
196 Editor::session_import_dialog ()
198 SessionImportDialog dialog (_session);
199 ensure_float (dialog);
203 typedef std::map<PBD::ID,boost::shared_ptr<ARDOUR::Source> > SourceMap;
206 * Updating is still disabled, see note in libs/ardour/import.cc Session::import_audiofiles()
209 * true = show "Update", "Import" and "Skip"
210 * false = show "Import", and "Cancel"
213 * 0 To update an existing source of the same name
214 * 1 To import/embed the file normally (make sure the new name will be unique)
215 * 2 If the user wants to skip this file
218 Editor::check_whether_and_how_to_import(string path, bool all_or_nothing)
220 string wave_name (Glib::path_get_basename(path));
222 SourceMap all_sources = _session->get_sources();
223 bool wave_name_exists = false;
225 for (SourceMap::iterator i = all_sources.begin(); i != all_sources.end(); ++i) {
226 string tmp (Glib::path_get_basename (i->second->path()));
227 if (tmp == wave_name) {
228 wave_name_exists = true;
235 if (wave_name_exists) {
237 if (all_or_nothing) {
238 // updating is still disabled
239 //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);
240 message = string_compose (_("The session already contains a source file named %1. Do you want to import %1 as a new file, or skip it?"), wave_name);
242 message = string_compose (_("The session already contains a source file named %1. Do you want to import %2 as a new source, or skip it?"), wave_name, wave_name);
245 MessageDialog dialog(message, false, Gtk::MESSAGE_QUESTION, Gtk::BUTTONS_NONE, true);
247 if (all_or_nothing) {
249 //dialog.add_button("Update", 0);
250 dialog.add_button("Import", 1);
251 dialog.add_button("Skip", 2);
253 dialog.add_button("Import", 1);
254 dialog.add_button("Cancel", 2);
257 //dialog.add_button("Skip all", 4); // All or rest?
261 function = dialog.run ();
269 boost::shared_ptr<AudioTrack>
270 Editor::get_nth_selected_audio_track (int nth) const
272 AudioTimeAxisView* atv;
273 TrackSelection::iterator x;
275 for (x = selection->tracks.begin(); nth > 0 && x != selection->tracks.end(); ++x) {
277 atv = dynamic_cast<AudioTimeAxisView*>(*x);
281 } else if (atv->is_audio_track()) {
286 if (x == selection->tracks.end()) {
287 atv = dynamic_cast<AudioTimeAxisView*>(selection->tracks.back());
289 atv = dynamic_cast<AudioTimeAxisView*>(*x);
292 if (!atv || !atv->is_audio_track()) {
293 return boost::shared_ptr<AudioTrack>();
296 return atv->audio_track();
299 boost::shared_ptr<MidiTrack>
300 Editor::get_nth_selected_midi_track (int nth) const
302 MidiTimeAxisView* mtv;
303 TrackSelection::iterator x;
305 for (x = selection->tracks.begin(); nth > 0 && x != selection->tracks.end(); ++x) {
307 mtv = dynamic_cast<MidiTimeAxisView*>(*x);
311 } else if (mtv->is_midi_track()) {
316 if (x == selection->tracks.end()) {
317 mtv = dynamic_cast<MidiTimeAxisView*>(selection->tracks.back());
319 mtv = dynamic_cast<MidiTimeAxisView*>(*x);
322 if (!mtv || !mtv->is_midi_track()) {
323 return boost::shared_ptr<MidiTrack>();
326 return mtv->midi_track();
330 Editor::do_import (vector<string> paths, ImportDisposition chns, ImportMode mode, SrcQuality quality, nframes64_t& pos)
332 boost::shared_ptr<Track> track;
333 vector<string> to_import;
335 bool use_timestamp = (pos == -1);
337 current_interthread_info = &import_status;
338 import_status.current = 1;
339 import_status.total = paths.size ();
341 ImportProgressWindow ipw (&import_status, _("Import"), _("Cancel Import"));
343 if (chns == Editing::ImportMergeFiles) {
345 /* create 1 region from all paths, add to 1 track,
350 for (vector<string>::iterator a = paths.begin(); a != paths.end(); ++a) {
351 int check = check_whether_and_how_to_import(*a, false);
359 import_sndfiles (paths, mode, quality, pos, 1, 1, track, false);
364 bool replace = false;
367 for (vector<string>::iterator a = paths.begin(); a != paths.end(); ++a) {
369 const int check = check_whether_and_how_to_import (*a, true);
376 fatal << "Updating existing sources should be disabled!" << endmsg;
383 fatal << "Illegal return " << check << " from check_whether_and_how_to_import()!" << endmsg;
387 /* have to reset this for every file we handle */
394 case Editing::ImportDistinctFiles:
397 to_import.push_back (*a);
399 if (mode == Editing::ImportToTrack) {
400 track = get_nth_selected_audio_track (nth++);
403 ok = (import_sndfiles (to_import, mode, quality, pos, 1, -1, track, replace) == 0);
406 case Editing::ImportDistinctChannels:
409 to_import.push_back (*a);
411 ok = (import_sndfiles (to_import, mode, quality, pos, -1, -1, track, replace) == 0);
414 case Editing::ImportSerializeFiles:
417 to_import.push_back (*a);
419 ok = (import_sndfiles (to_import, mode, quality, pos, 1, 1, track, replace) == 0);
422 case Editing::ImportMergeFiles:
423 // Not entered, handled in earlier if() branch
431 Editor::do_embed (vector<string> paths, ImportDisposition chns, ImportMode mode, nframes64_t& pos)
433 boost::shared_ptr<Track> track;
434 bool check_sample_rate = true;
436 vector<string> to_embed;
437 bool multi = paths.size() > 1;
441 case Editing::ImportDistinctFiles:
442 for (vector<string>::iterator a = paths.begin(); a != paths.end(); ++a) {
445 to_embed.push_back (*a);
447 if (mode == Editing::ImportToTrack) {
448 track = get_nth_selected_audio_track (nth++);
451 if (embed_sndfiles (to_embed, multi, check_sample_rate, mode, pos, 1, -1, track) < -1) {
457 case Editing::ImportDistinctChannels:
458 for (vector<string>::iterator a = paths.begin(); a != paths.end(); ++a) {
461 to_embed.push_back (*a);
463 if (embed_sndfiles (to_embed, multi, check_sample_rate, mode, pos, -1, -1, track) < -1) {
469 case Editing::ImportMergeFiles:
470 if (embed_sndfiles (paths, multi, check_sample_rate, mode, pos, 1, 1, track) < -1) {
475 case Editing::ImportSerializeFiles:
476 for (vector<string>::iterator a = paths.begin(); a != paths.end(); ++a) {
479 to_embed.push_back (*a);
481 if (embed_sndfiles (to_embed, multi, check_sample_rate, mode, pos, 1, 1, track) < -1) {
492 _session->save_state ("");
497 Editor::import_sndfiles (vector<string> paths, ImportMode mode, SrcQuality quality, nframes64_t& pos,
498 int target_regions, int target_tracks, boost::shared_ptr<Track>& track, bool replace)
500 import_status.paths = paths;
501 import_status.done = false;
502 import_status.cancel = false;
503 import_status.freeze = false;
504 import_status.done = 0.0;
505 import_status.quality = quality;
506 import_status.replace_existing_source = replace;
508 import_status.mode = mode;
509 import_status.pos = pos;
510 import_status.target_tracks = target_tracks;
511 import_status.target_regions = target_regions;
512 import_status.track = track;
513 import_status.replace = replace;
515 track_canvas->get_window()->set_cursor (Gdk::Cursor (Gdk::WATCH));
518 /* start import thread for this spec. this will ultimately call Session::import_audiofiles()
519 which, if successful, will add the files as regions to the region list. its up to us
520 (the GUI) to direct additional steps after that.
523 pthread_create_and_store ("import", &import_status.thread, _import_thread, this);
524 pthread_detach (import_status.thread);
526 while (!import_status.done && !import_status.cancel) {
527 gtk_main_iteration ();
530 import_status.done = true;
532 if (!import_status.cancel && !import_status.sources.empty()) {
533 if (add_sources (import_status.paths,
534 import_status.sources,
537 import_status.target_regions,
538 import_status.target_tracks,
539 track, false) == 0) {
540 _session->save_state ("");
543 /* update position from results */
545 pos = import_status.pos;
549 track_canvas->get_window()->set_cursor (*current_canvas_cursor);
554 Editor::embed_sndfiles (vector<string> paths, bool multifile,
555 bool& check_sample_rate, ImportMode mode, nframes64_t& pos, int target_regions, int target_tracks,
556 boost::shared_ptr<Track>& track)
558 boost::shared_ptr<AudioFileSource> source;
565 track_canvas->get_window()->set_cursor (Gdk::Cursor (Gdk::WATCH));
568 for (vector<string>::iterator p = paths.begin(); p != paths.end(); ++p) {
572 if (Config->get_try_link_for_embed()) {
574 /* lets see if we can link it into the session */
576 sys::path tmp = _session->session_directory().sound_path() / Glib::path_get_basename(path);
577 linked_path = tmp.to_string();
579 path_to_use = linked_path;
581 if (link (path.c_str(), linked_path.c_str()) == 0) {
583 /* there are many reasons why link(2) might have failed.
584 but if it succeeds, we now have a link in the
585 session sound dir that will protect against
586 unlinking of the original path. nice.
590 path_to_use = Glib::path_get_basename (path);
594 /* one possible reason is that its already linked */
596 if (errno == EEXIST) {
599 if (stat (linked_path.c_str(), &sb) == 0) {
600 if (sb.st_nlink > 1) { // its a hard link, assume its the one we want
602 path_to_use = Glib::path_get_basename (path);
609 /* note that we temporarily truncated _id at the colon */
613 if (!AudioFileSource::get_soundfile_info (path, finfo, error_msg)) {
614 error << string_compose(_("Editor: cannot open file \"%1\", (%2)"), path, error_msg ) << endmsg;
618 if (check_sample_rate && (finfo.samplerate != (int) _session->frame_rate())) {
619 vector<string> choices;
622 choices.push_back (_("Cancel entire import"));
623 choices.push_back (_("Don't embed it"));
624 choices.push_back (_("Embed all without questions"));
626 Gtkmm2ext::Choice rate_choice (
628 string_compose (_("%1\nThis audiofile's sample rate doesn't match the session sample rate!"),
629 short_path (path, 40)),
633 int resx = rate_choice.run ();
636 case 0: /* stop a multi-file import */
639 case 1: /* don't embed this one */
642 case 2: /* do it, and the rest without asking */
643 check_sample_rate = false;
652 choices.push_back (_("Cancel"));
653 choices.push_back (_("Embed it anyway"));
655 Gtkmm2ext::Choice rate_choice (
657 string_compose (_("%1\nThis audiofile's sample rate doesn't match the session sample rate!"), path),
661 int resx = rate_choice.run ();
664 case 0: /* don't import */
676 track_canvas->get_window()->set_cursor (Gdk::Cursor (Gdk::WATCH));
678 for (int n = 0; n < finfo.channels; ++n) {
681 /* check if we have this thing embedded already */
683 boost::shared_ptr<Source> s;
685 if ((s = _session->source_by_path_and_channel (path, n)) == 0) {
687 source = boost::dynamic_pointer_cast<AudioFileSource> (
688 SourceFactory::createReadable (DataType::AUDIO, *_session,
690 (mode == ImportAsTapeTrack
691 ? Source::Destructive
695 source = boost::dynamic_pointer_cast<AudioFileSource> (s);
698 sources.push_back(source);
701 catch (failed_constructor& err) {
702 error << string_compose(_("could not open %1"), path) << endmsg;
706 ARDOUR_UI::instance()->flush_pending ();
710 if (sources.empty()) {
714 ret = add_sources (paths, sources, pos, mode, target_regions, target_tracks, track, true);
717 track_canvas->get_window()->set_cursor (*current_canvas_cursor);
722 Editor::add_sources (vector<string> paths, SourceList& sources, nframes64_t& pos, ImportMode mode,
723 int target_regions, int target_tracks, boost::shared_ptr<Track>& track, bool /*add_channel_suffix*/)
725 vector<boost::shared_ptr<Region> > regions;
727 uint32_t input_chan = 0;
728 uint32_t output_chan = 0;
731 use_timestamp = (pos == -1);
733 // kludge (for MIDI we're abusing "channel" for "track" here)
734 if (SMFSource::safe_midi_file_extension (paths.front())) {
738 if (target_regions == 1) {
740 /* take all the sources we have and package them up as a region */
742 region_name = region_name_from_path (paths.front(), (sources.size() > 1), false);
746 plist.add (ARDOUR::Properties::start, 0);
747 plist.add (ARDOUR::Properties::length, sources[0]->length (pos));
748 plist.add (ARDOUR::Properties::name, region_name);
749 plist.add (ARDOUR::Properties::layer, 0);
750 plist.add (ARDOUR::Properties::whole_file, true);
751 plist.add (ARDOUR::Properties::external, true);
753 boost::shared_ptr<Region> r = RegionFactory::create (sources, plist);
755 if (use_timestamp && boost::dynamic_pointer_cast<AudioRegion>(r)) {
756 boost::dynamic_pointer_cast<AudioRegion>(r)->special_set_position(sources[0]->natural_position());
759 regions.push_back (r);
762 } else if (target_regions == -1 || target_regions > 1) {
764 /* take each source and create a region for each one */
767 SourceList::iterator x;
770 for (n = 0, x = sources.begin(); x != sources.end(); ++x, ++n) {
773 just_one.push_back (*x);
775 region_name = region_name_from_path ((*x)->path(), false, false, sources.size(), n);
779 plist.add (ARDOUR::Properties::start, 0);
780 plist.add (ARDOUR::Properties::length, (*x)->length (pos));
781 plist.add (ARDOUR::Properties::name, region_name);
782 plist.add (ARDOUR::Properties::layer, 0);
783 plist.add (ARDOUR::Properties::whole_file, true);
784 plist.add (ARDOUR::Properties::external, true);
786 boost::shared_ptr<Region> r = RegionFactory::create (just_one, plist);
788 if (use_timestamp && boost::dynamic_pointer_cast<AudioRegion>(r)) {
789 boost::dynamic_pointer_cast<AudioRegion>(r)->special_set_position((*x)->natural_position());
792 regions.push_back (r);
796 if (target_regions == 1) {
797 input_chan = regions.front()->n_channels();
799 if (target_tracks == 1) {
800 input_chan = regions.size();
806 if (Config->get_output_auto_connect() & AutoConnectMaster) {
807 output_chan = (_session->master_out() ? _session->master_out()->n_inputs().n_audio() : input_chan);
809 output_chan = input_chan;
815 for (vector<boost::shared_ptr<Region> >::iterator r = regions.begin(); r != regions.end(); ++r, ++n) {
817 boost::shared_ptr<AudioRegion> ar = boost::dynamic_pointer_cast<AudioRegion> (*r);
819 if (use_timestamp && ar) {
821 cerr << "Using timestamp to place region " << (*r)->name() << endl;
823 /* get timestamp for this region */
825 const boost::shared_ptr<Source> s (ar->sources().front());
826 const boost::shared_ptr<AudioSource> as = boost::dynamic_pointer_cast<AudioSource> (s);
830 if (as->natural_position() != 0) {
831 pos = as->natural_position();
832 cerr << "\tgot " << pos << " from source TC info\n";
833 } else if (target_tracks == 1) {
834 /* hmm, no timestamp available, put it after the previous region
837 pos = get_preferred_edit_position ();
838 cerr << "\tno timestamp, first file, use edit pos = " << pos << endl;
841 cerr << "\tpacked-sequence-shuffle to " << pos << endl;
844 pos = get_preferred_edit_position ();
845 cerr << "\tmultitracks, using edit position = " << pos << endl;
850 finish_bringing_in_material (*r, input_chan, output_chan, pos, mode, track);
852 rlen = (*r)->length();
854 if (target_tracks != 1) {
857 if (!use_timestamp || !ar) {
858 /* line each one up right after the other */
859 pos += (*r)->length();
864 /* setup peak file building in another thread */
866 for (SourceList::iterator x = sources.begin(); x != sources.end(); ++x) {
867 SourceFactory::setup_peakfile (*x, true);
874 Editor::finish_bringing_in_material (boost::shared_ptr<Region> region, uint32_t in_chans, uint32_t out_chans, nframes64_t& pos,
875 ImportMode mode, boost::shared_ptr<Track>& existing_track)
877 boost::shared_ptr<AudioRegion> ar = boost::dynamic_pointer_cast<AudioRegion>(region);
878 boost::shared_ptr<MidiRegion> mr = boost::dynamic_pointer_cast<MidiRegion>(region);
882 /* relax, its been done */
887 if (!existing_track) {
890 existing_track = get_nth_selected_audio_track (0);
892 existing_track = get_nth_selected_midi_track (0);
895 if (!existing_track) {
900 boost::shared_ptr<Playlist> playlist = existing_track->playlist();
901 boost::shared_ptr<Region> copy (RegionFactory::create (region, region->properties()));
902 begin_reversible_command (_("insert file"));
903 playlist->clear_changes ();
904 playlist->add_region (copy, pos);
905 _session->add_command (new StatefulDiffCommand (playlist));
906 commit_reversible_command ();
912 if (!existing_track) {
914 list<boost::shared_ptr<AudioTrack> > at (_session->new_audio_track (in_chans, out_chans, Normal, 0, 1));
920 existing_track = at.front();
922 list<boost::shared_ptr<MidiTrack> > mt (_session->new_midi_track (Normal, 0, 1));
928 existing_track = mt.front();
931 existing_track->set_name (region->name());
934 boost::shared_ptr<Region> copy (RegionFactory::create (region));
935 existing_track->playlist()->add_region (copy, pos);
940 case ImportAsTapeTrack:
945 list<boost::shared_ptr<AudioTrack> > at (_session->new_audio_track (in_chans, out_chans, Destructive));
947 boost::shared_ptr<Region> copy (RegionFactory::create (region));
948 at.front()->set_name (basename_nosuffix (copy->name()));
949 at.front()->playlist()->add_region (copy, pos);
959 Editor::_import_thread (void *arg)
961 SessionEvent::create_per_thread_pool ("import events", 64);
963 Editor *ed = (Editor *) arg;
964 return ed->import_thread ();
968 Editor::import_thread ()
970 _session->import_audiofiles (import_status);
971 pthread_exit_pbd (0);