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>
29 #include "pbd/pthread_utils.h"
30 #include "pbd/basename.h"
31 #include "pbd/shortpath.h"
32 #include "pbd/stateful_diff_command.h"
34 #include <gtkmm2ext/choice.h>
36 #include "ardour/session.h"
37 #include "ardour/session_directory.h"
38 #include "ardour/audioplaylist.h"
39 #include "ardour/audioregion.h"
40 #include "ardour/audio_diskstream.h"
41 #include "ardour/midi_track.h"
42 #include "ardour/midi_region.h"
43 #include "ardour/utils.h"
44 #include "ardour/audio_track.h"
45 #include "ardour/audioplaylist.h"
46 #include "ardour/audiofilesource.h"
47 #include "ardour/region_factory.h"
48 #include "ardour/source_factory.h"
49 #include "ardour/session.h"
50 #include "ardour/smf_source.h"
51 #include "pbd/memento_command.h"
53 #include "ardour_ui.h"
57 #include "audio_time_axis.h"
58 #include "midi_time_axis.h"
59 #include "session_import_dialog.h"
61 #include "gui_thread.h"
62 #include "interthread_progress_window.h"
67 using namespace ARDOUR;
70 using namespace Gtkmm2ext;
71 using namespace Editing;
74 /* Functions supporting the incorporation of external (non-captured) audio material into ardour */
77 Editor::add_external_audio_action (ImportMode mode_hint)
80 MessageDialog msg (_("You can't import or embed an audiofile until you have a session loaded."));
86 sfbrowser = new SoundFileOmega (*this, _("Add Existing Media"), _session, 0, true, mode_hint);
88 sfbrowser->set_mode (mode_hint);
91 external_audio_dialog ();
95 Editor::external_audio_dialog ()
101 MessageDialog msg (_("You can't import or embed an audiofile until you have a session loaded."));
108 for (TrackSelection::iterator x = selection->tracks.begin(); x != selection->tracks.end(); ++x) {
109 AudioTimeAxisView* atv = dynamic_cast<AudioTimeAxisView*>(*x);
113 } else if (atv->is_audio_track()) {
118 if (sfbrowser == 0) {
119 sfbrowser = new SoundFileOmega (*this, _("Add Existing Media"), _session, track_cnt, true);
121 sfbrowser->reset (track_cnt);
124 sfbrowser->show_all ();
132 int response = sfbrowser->run ();
136 // leave the dialog open
144 // cancel from the browser - we are done
151 vector<string> upaths = sfbrowser->get_paths ();
152 for (vector<string>::iterator x = upaths.begin(); x != upaths.end(); ++x) {
153 paths.push_back (*x);
156 ImportPosition pos = sfbrowser->get_position ();
157 ImportMode mode = sfbrowser->get_mode ();
158 ImportDisposition chns = sfbrowser->get_channel_disposition ();
162 case ImportAtEditPoint:
163 where = get_preferred_edit_position ();
165 case ImportAtTimestamp:
168 case ImportAtPlayhead:
169 where = playhead_cursor->current_frame;
172 where = _session->current_start_frame();
176 SrcQuality quality = sfbrowser->get_src_quality();
179 if (sfbrowser->copy_files_btn.get_active()) {
180 do_import (paths, chns, mode, quality, where);
182 do_embed (paths, chns, mode, where);
185 if (response == RESPONSE_APPLY) {
186 sfbrowser->clear_selection ();
190 } while (keepRunning);
194 Editor::session_import_dialog ()
196 SessionImportDialog dialog (_session);
197 ensure_float (dialog);
201 typedef std::map<PBD::ID,boost::shared_ptr<ARDOUR::Source> > SourceMap;
204 * Updating is still disabled, see note in libs/ardour/import.cc Session::import_audiofiles()
207 * true = show "Update", "Import" and "Skip"
208 * false = show "Import", and "Cancel"
211 * 0 To update an existing source of the same name
212 * 1 To import/embed the file normally (make sure the new name will be unique)
213 * 2 If the user wants to skip this file
216 Editor::check_whether_and_how_to_import(string path, bool all_or_nothing)
218 string wave_name (Glib::path_get_basename(path));
220 SourceMap all_sources = _session->get_sources();
221 bool wave_name_exists = false;
223 for (SourceMap::iterator i = all_sources.begin(); i != all_sources.end(); ++i) {
224 string tmp (Glib::path_get_basename (i->second->path()));
225 if (tmp == wave_name) {
226 wave_name_exists = true;
233 if (wave_name_exists) {
235 if (all_or_nothing) {
236 // updating is still disabled
237 //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);
238 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);
240 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);
243 MessageDialog dialog(message, false, Gtk::MESSAGE_QUESTION, Gtk::BUTTONS_NONE, true);
245 if (all_or_nothing) {
247 //dialog.add_button("Update", 0);
248 dialog.add_button("Import", 1);
249 dialog.add_button("Skip", 2);
251 dialog.add_button("Import", 1);
252 dialog.add_button("Cancel", 2);
255 //dialog.add_button("Skip all", 4); // All or rest?
259 function = dialog.run ();
267 boost::shared_ptr<AudioTrack>
268 Editor::get_nth_selected_audio_track (int nth) const
270 AudioTimeAxisView* atv;
271 TrackSelection::iterator x;
273 for (x = selection->tracks.begin(); nth > 0 && x != selection->tracks.end(); ++x) {
275 atv = dynamic_cast<AudioTimeAxisView*>(*x);
279 } else if (atv->is_audio_track()) {
284 if (x == selection->tracks.end()) {
285 atv = dynamic_cast<AudioTimeAxisView*>(selection->tracks.back());
287 atv = dynamic_cast<AudioTimeAxisView*>(*x);
290 if (!atv || !atv->is_audio_track()) {
291 return boost::shared_ptr<AudioTrack>();
294 return atv->audio_track();
297 boost::shared_ptr<MidiTrack>
298 Editor::get_nth_selected_midi_track (int nth) const
300 MidiTimeAxisView* mtv;
301 TrackSelection::iterator x;
303 for (x = selection->tracks.begin(); nth > 0 && x != selection->tracks.end(); ++x) {
305 mtv = dynamic_cast<MidiTimeAxisView*>(*x);
309 } else if (mtv->is_midi_track()) {
314 if (x == selection->tracks.end()) {
315 mtv = dynamic_cast<MidiTimeAxisView*>(selection->tracks.back());
317 mtv = dynamic_cast<MidiTimeAxisView*>(*x);
320 if (!mtv || !mtv->is_midi_track()) {
321 return boost::shared_ptr<MidiTrack>();
324 return mtv->midi_track();
328 Editor::do_import (vector<string> paths, ImportDisposition chns, ImportMode mode, SrcQuality quality, framepos_t& pos)
330 boost::shared_ptr<Track> track;
331 vector<string> to_import;
333 bool use_timestamp = (pos == -1);
335 current_interthread_info = &import_status;
336 import_status.current = 1;
337 import_status.total = paths.size ();
338 import_status.all_done = false;
340 ImportProgressWindow ipw (&import_status, _("Import"), _("Cancel Import"));
344 if (chns == Editing::ImportMergeFiles) {
346 /* create 1 region from all paths, add to 1 track,
351 for (vector<string>::iterator a = paths.begin(); a != paths.end(); ++a) {
352 int check = check_whether_and_how_to_import(*a, false);
363 ok = (import_sndfiles (paths, mode, quality, pos, 1, 1, track, false) == 0);
368 bool replace = false;
370 for (vector<string>::iterator a = paths.begin(); a != paths.end(); ++a) {
372 const int check = check_whether_and_how_to_import (*a, true);
379 fatal << "Updating existing sources should be disabled!" << endmsg;
386 fatal << "Illegal return " << check << " from check_whether_and_how_to_import()!" << endmsg;
390 /* have to reset this for every file we handle */
399 case Editing::ImportDistinctFiles:
402 to_import.push_back (*a);
404 if (mode == Editing::ImportToTrack) {
405 track = get_nth_selected_audio_track (nth++);
408 ok = (import_sndfiles (to_import, mode, quality, pos, 1, -1, track, replace) == 0);
411 case Editing::ImportDistinctChannels:
414 to_import.push_back (*a);
416 ok = (import_sndfiles (to_import, mode, quality, pos, -1, -1, track, replace) == 0);
419 case Editing::ImportSerializeFiles:
422 to_import.push_back (*a);
424 ok = (import_sndfiles (to_import, mode, quality, pos, 1, 1, track, replace) == 0);
427 case Editing::ImportMergeFiles:
428 // Not entered, handled in earlier if() branch
435 _session->save_state ("");
438 import_status.all_done = true;
442 Editor::do_embed (vector<string> paths, ImportDisposition chns, ImportMode mode, framepos_t& pos)
444 boost::shared_ptr<Track> track;
445 bool check_sample_rate = true;
447 vector<string> to_embed;
448 bool multi = paths.size() > 1;
452 case Editing::ImportDistinctFiles:
453 for (vector<string>::iterator a = paths.begin(); a != paths.end(); ++a) {
456 to_embed.push_back (*a);
458 if (mode == Editing::ImportToTrack) {
459 track = get_nth_selected_audio_track (nth++);
462 if (embed_sndfiles (to_embed, multi, check_sample_rate, mode, pos, 1, -1, track) < -1) {
468 case Editing::ImportDistinctChannels:
469 for (vector<string>::iterator a = paths.begin(); a != paths.end(); ++a) {
472 to_embed.push_back (*a);
474 if (embed_sndfiles (to_embed, multi, check_sample_rate, mode, pos, -1, -1, track) < -1) {
480 case Editing::ImportMergeFiles:
481 if (embed_sndfiles (paths, multi, check_sample_rate, mode, pos, 1, 1, track) < -1) {
486 case Editing::ImportSerializeFiles:
487 for (vector<string>::iterator a = paths.begin(); a != paths.end(); ++a) {
490 to_embed.push_back (*a);
492 if (embed_sndfiles (to_embed, multi, check_sample_rate, mode, pos, 1, 1, track) < -1) {
503 _session->save_state ("");
508 Editor::import_sndfiles (vector<string> paths, ImportMode mode, SrcQuality quality, framepos_t& pos,
509 int target_regions, int target_tracks, boost::shared_ptr<Track>& track, bool replace)
511 /* check for existing wholefile regions of the same name,
512 which can happen when we import foo.wav but end up with foo-L.wav
513 and foo-R.wav inside the session. this case doesn't trigger
514 source name collisions, so we have to catch it at the region
518 string region_name = region_name_from_path (paths.front(), true, false);
520 if (RegionFactory::wholefile_region_by_name (region_name)) {
521 string message = string_compose ( _("You appear to have already imported this file, since a region called %1 already exists.\nDo you really want to import it again?"),
523 MessageDialog dialog (message, false, Gtk::MESSAGE_QUESTION, Gtk::BUTTONS_OK_CANCEL, true);
530 if (ret != RESPONSE_OK) {
536 while (RegionFactory::region_by_name (region_name) && ++l < 999) {
537 region_name = bump_name_once (region_name, '.');
541 error << string_compose (_("Too many regions already named something like \"%1\""), paths.front()) << endmsg;
546 import_status.paths = paths;
547 import_status.done = false;
548 import_status.cancel = false;
549 import_status.freeze = false;
550 import_status.quality = quality;
551 import_status.replace_existing_source = replace;
553 import_status.mode = mode;
554 import_status.pos = pos;
555 import_status.target_tracks = target_tracks;
556 import_status.target_regions = target_regions;
557 import_status.track = track;
558 import_status.replace = replace;
560 set_canvas_cursor (wait_cursor);
563 /* start import thread for this spec. this will ultimately call Session::import_audiofiles()
564 which, if successful, will add the files as regions to the region list. its up to us
565 (the GUI) to direct additional steps after that.
568 pthread_create_and_store ("import", &import_status.thread, _import_thread, this);
569 pthread_detach (import_status.thread);
571 while (!import_status.done && !import_status.cancel) {
572 gtk_main_iteration ();
575 import_status.done = true;
579 if (!import_status.cancel && !import_status.sources.empty()) {
580 result = add_sources (
582 import_status.sources,
585 import_status.target_regions,
586 import_status.target_tracks,
590 /* update position from results */
592 pos = import_status.pos;
595 set_canvas_cursor (current_canvas_cursor);
600 Editor::embed_sndfiles (vector<string> paths, bool multifile,
601 bool& check_sample_rate, ImportMode mode, framepos_t& pos, int target_regions, int target_tracks,
602 boost::shared_ptr<Track>& track)
604 boost::shared_ptr<AudioFileSource> source;
611 set_canvas_cursor (wait_cursor);
614 for (vector<string>::iterator p = paths.begin(); p != paths.end(); ++p) {
618 if (Config->get_try_link_for_embed()) {
620 /* lets see if we can link it into the session */
622 sys::path tmp = _session->session_directory().sound_path() / Glib::path_get_basename(path);
623 linked_path = tmp.to_string();
625 path_to_use = linked_path;
627 if (link (path.c_str(), linked_path.c_str()) == 0) {
629 /* there are many reasons why link(2) might have failed.
630 but if it succeeds, we now have a link in the
631 session sound dir that will protect against
632 unlinking of the original path. nice.
636 path_to_use = Glib::path_get_basename (path);
640 /* one possible reason is that its already linked */
642 if (errno == EEXIST) {
645 if (stat (linked_path.c_str(), &sb) == 0) {
646 if (sb.st_nlink > 1) { // its a hard link, assume its the one we want
648 path_to_use = Glib::path_get_basename (path);
655 /* note that we temporarily truncated _id at the colon */
659 if (!AudioFileSource::get_soundfile_info (path, finfo, error_msg)) {
660 error << string_compose(_("Editor: cannot open file \"%1\", (%2)"), path, error_msg ) << endmsg;
664 if (check_sample_rate && (finfo.samplerate != (int) _session->frame_rate())) {
665 vector<string> choices;
668 choices.push_back (_("Cancel entire import"));
669 choices.push_back (_("Don't embed it"));
670 choices.push_back (_("Embed all without questions"));
672 Gtkmm2ext::Choice rate_choice (
674 string_compose (_("%1\nThis audiofile's sample rate doesn't match the session sample rate!"),
675 short_path (path, 40)),
679 int resx = rate_choice.run ();
682 case 0: /* stop a multi-file import */
685 case 1: /* don't embed this one */
688 case 2: /* do it, and the rest without asking */
689 check_sample_rate = false;
698 choices.push_back (_("Cancel"));
699 choices.push_back (_("Embed it anyway"));
701 Gtkmm2ext::Choice rate_choice (
703 string_compose (_("%1\nThis audiofile's sample rate doesn't match the session sample rate!"), path),
707 int resx = rate_choice.run ();
710 case 0: /* don't import */
722 set_canvas_cursor (wait_cursor);
724 for (int n = 0; n < finfo.channels; ++n) {
727 /* check if we have this thing embedded already */
729 boost::shared_ptr<Source> s;
731 if ((s = _session->source_by_path_and_channel (path, n)) == 0) {
733 source = boost::dynamic_pointer_cast<AudioFileSource> (
734 SourceFactory::createReadable (DataType::AUDIO, *_session,
736 (mode == ImportAsTapeTrack
737 ? Source::Destructive
741 source = boost::dynamic_pointer_cast<AudioFileSource> (s);
744 sources.push_back(source);
747 catch (failed_constructor& err) {
748 error << string_compose(_("could not open %1"), path) << endmsg;
752 ARDOUR_UI::instance()->flush_pending ();
756 if (sources.empty()) {
760 ret = add_sources (paths, sources, pos, mode, target_regions, target_tracks, track, true);
763 set_canvas_cursor (current_canvas_cursor);
768 Editor::add_sources (vector<string> paths, SourceList& sources, framepos_t& pos, ImportMode mode,
769 int target_regions, int target_tracks, boost::shared_ptr<Track>& track, bool /*add_channel_suffix*/)
771 vector<boost::shared_ptr<Region> > regions;
773 uint32_t input_chan = 0;
774 uint32_t output_chan = 0;
777 use_timestamp = (pos == -1);
779 // kludge (for MIDI we're abusing "channel" for "track" here)
780 if (SMFSource::safe_midi_file_extension (paths.front())) {
784 if (target_regions == 1) {
786 /* take all the sources we have and package them up as a region */
788 region_name = region_name_from_path (paths.front(), (sources.size() > 1), false);
790 /* we checked in import_sndfiles() that there were not too many */
792 while (RegionFactory::region_by_name (region_name)) {
793 region_name = bump_name_once (region_name, '.');
798 plist.add (ARDOUR::Properties::start, 0);
799 plist.add (ARDOUR::Properties::length, sources[0]->length (pos));
800 plist.add (ARDOUR::Properties::name, region_name);
801 plist.add (ARDOUR::Properties::layer, 0);
802 plist.add (ARDOUR::Properties::whole_file, true);
803 plist.add (ARDOUR::Properties::external, true);
805 boost::shared_ptr<Region> r = RegionFactory::create (sources, plist);
807 if (use_timestamp && boost::dynamic_pointer_cast<AudioRegion>(r)) {
808 boost::dynamic_pointer_cast<AudioRegion>(r)->special_set_position(sources[0]->natural_position());
811 regions.push_back (r);
814 } else if (target_regions == -1 || target_regions > 1) {
816 /* take each source and create a region for each one */
819 SourceList::iterator x;
822 for (n = 0, x = sources.begin(); x != sources.end(); ++x, ++n) {
825 just_one.push_back (*x);
827 region_name = region_name_from_path ((*x)->path(), false, false, sources.size(), n);
831 plist.add (ARDOUR::Properties::start, 0);
832 plist.add (ARDOUR::Properties::length, (*x)->length (pos));
833 plist.add (ARDOUR::Properties::name, region_name);
834 plist.add (ARDOUR::Properties::layer, 0);
835 plist.add (ARDOUR::Properties::whole_file, true);
836 plist.add (ARDOUR::Properties::external, true);
838 boost::shared_ptr<Region> r = RegionFactory::create (just_one, plist);
840 if (use_timestamp && boost::dynamic_pointer_cast<AudioRegion>(r)) {
841 boost::dynamic_pointer_cast<AudioRegion>(r)->special_set_position((*x)->natural_position());
844 regions.push_back (r);
848 if (target_regions == 1) {
849 input_chan = regions.front()->n_channels();
851 if (target_tracks == 1) {
852 input_chan = regions.size();
858 if (Config->get_output_auto_connect() & AutoConnectMaster) {
859 output_chan = (_session->master_out() ? _session->master_out()->n_inputs().n_audio() : input_chan);
861 output_chan = input_chan;
867 for (vector<boost::shared_ptr<Region> >::iterator r = regions.begin(); r != regions.end(); ++r, ++n) {
869 boost::shared_ptr<AudioRegion> ar = boost::dynamic_pointer_cast<AudioRegion> (*r);
871 if (use_timestamp && ar) {
873 /* get timestamp for this region */
875 const boost::shared_ptr<Source> s (ar->sources().front());
876 const boost::shared_ptr<AudioSource> as = boost::dynamic_pointer_cast<AudioSource> (s);
880 if (as->natural_position() != 0) {
881 pos = as->natural_position();
882 } else if (target_tracks == 1) {
883 /* hmm, no timestamp available, put it after the previous region
886 pos = get_preferred_edit_position ();
891 pos = get_preferred_edit_position ();
896 finish_bringing_in_material (*r, input_chan, output_chan, pos, mode, track);
898 rlen = (*r)->length();
900 if (target_tracks != 1) {
903 if (!use_timestamp || !ar) {
904 /* line each one up right after the other */
905 pos += (*r)->length();
910 /* setup peak file building in another thread */
912 for (SourceList::iterator x = sources.begin(); x != sources.end(); ++x) {
913 SourceFactory::setup_peakfile (*x, true);
920 Editor::finish_bringing_in_material (boost::shared_ptr<Region> region, uint32_t in_chans, uint32_t out_chans, framepos_t& pos,
921 ImportMode mode, boost::shared_ptr<Track>& existing_track)
923 boost::shared_ptr<AudioRegion> ar = boost::dynamic_pointer_cast<AudioRegion>(region);
924 boost::shared_ptr<MidiRegion> mr = boost::dynamic_pointer_cast<MidiRegion>(region);
928 /* relax, its been done */
933 if (!existing_track) {
936 existing_track = get_nth_selected_audio_track (0);
938 existing_track = get_nth_selected_midi_track (0);
941 if (!existing_track) {
946 boost::shared_ptr<Playlist> playlist = existing_track->playlist();
947 boost::shared_ptr<Region> copy (RegionFactory::create (region, region->properties()));
948 begin_reversible_command (_("insert file"));
949 playlist->clear_changes ();
950 playlist->add_region (copy, pos);
951 _session->add_command (new StatefulDiffCommand (playlist));
952 commit_reversible_command ();
958 if (!existing_track) {
960 list<boost::shared_ptr<AudioTrack> > at (_session->new_audio_track (in_chans, out_chans, Normal, 0, 1));
966 existing_track = at.front();
968 list<boost::shared_ptr<MidiTrack> > mt (_session->new_midi_track (Normal, 0, 1));
974 existing_track = mt.front();
977 existing_track->set_name (region->name());
980 boost::shared_ptr<Region> copy (RegionFactory::create (region));
981 existing_track->playlist()->add_region (copy, pos);
986 case ImportAsTapeTrack:
991 list<boost::shared_ptr<AudioTrack> > at (_session->new_audio_track (in_chans, out_chans, Destructive));
993 boost::shared_ptr<Region> copy (RegionFactory::create (region));
994 at.front()->set_name (basename_nosuffix (copy->name()));
995 at.front()->playlist()->add_region (copy, pos);
1005 Editor::_import_thread (void *arg)
1007 SessionEvent::create_per_thread_pool ("import events", 64);
1009 Editor *ed = (Editor *) arg;
1010 return ed->import_thread ();
1014 Editor::import_thread ()
1016 _session->import_audiofiles (import_status);
1017 pthread_exit_pbd (0);