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 "pbd/memento_command.h"
52 #include "ardour_ui.h"
56 #include "audio_time_axis.h"
57 #include "midi_time_axis.h"
58 #include "session_import_dialog.h"
60 #include "gui_thread.h"
61 #include "interthread_progress_window.h"
66 using namespace ARDOUR;
69 using namespace Gtkmm2ext;
70 using namespace Editing;
73 /* Functions supporting the incorporation of external (non-captured) audio material into ardour */
76 Editor::add_external_audio_action (ImportMode mode_hint)
79 MessageDialog msg (_("You can't import or embed an audiofile until you have a session loaded."));
85 sfbrowser = new SoundFileOmega (*this, _("Add Existing Media"), _session, 0, true, mode_hint);
87 sfbrowser->set_mode (mode_hint);
90 external_audio_dialog ();
94 Editor::external_audio_dialog ()
96 vector<Glib::ustring> paths;
100 MessageDialog msg (_("You can't import or embed an audiofile until you have a session loaded."));
107 for (TrackSelection::iterator x = selection->tracks.begin(); x != selection->tracks.end(); ++x) {
108 AudioTimeAxisView* atv = dynamic_cast<AudioTimeAxisView*>(*x);
112 } else if (atv->is_audio_track()) {
117 if (sfbrowser == 0) {
118 sfbrowser = new SoundFileOmega (*this, _("Add Existing Media"), _session, track_cnt, true);
120 sfbrowser->reset (track_cnt);
123 sfbrowser->show_all ();
131 int response = sfbrowser->run ();
135 // leave the dialog open
143 // cancel from the browser - we are done
150 paths = sfbrowser->get_paths ();
152 ImportPosition pos = sfbrowser->get_position ();
153 ImportMode mode = sfbrowser->get_mode ();
154 ImportDisposition chns = sfbrowser->get_channel_disposition ();
158 case ImportAtEditPoint:
159 where = get_preferred_edit_position ();
161 case ImportAtTimestamp:
164 case ImportAtPlayhead:
165 where = playhead_cursor->current_frame;
168 where = _session->current_start_frame();
172 SrcQuality quality = sfbrowser->get_src_quality();
175 if (sfbrowser->copy_files_btn.get_active()) {
176 do_import (paths, chns, mode, quality, where);
178 do_embed (paths, chns, mode, where);
181 if (response == RESPONSE_APPLY) {
182 sfbrowser->clear_selection ();
186 } while (keepRunning);
190 Editor::session_import_dialog ()
192 SessionImportDialog dialog (_session);
193 ensure_float (dialog);
197 typedef std::map<PBD::ID,boost::shared_ptr<ARDOUR::Source> > SourceMap;
200 * Updating is still disabled, see note in libs/ardour/import.cc Session::import_audiofiles()
203 * true = show "Update", "Import" and "Skip"
204 * false = show "Import", and "Cancel"
207 * 0 To update an existing source of the same name
208 * 1 To import/embed the file normally (make sure the new name will be unique)
209 * 2 If the user wants to skip this file
212 Editor::check_whether_and_how_to_import(string path, bool all_or_nothing)
214 string wave_name (Glib::path_get_basename(path));
216 SourceMap all_sources = _session->get_sources();
217 bool wave_name_exists = false;
219 for (SourceMap::iterator i = all_sources.begin(); i != all_sources.end(); ++i) {
220 string tmp (Glib::path_get_basename (i->second->path()));
221 if (tmp == wave_name) {
222 wave_name_exists = true;
229 if (wave_name_exists) {
231 if (all_or_nothing) {
232 // updating is still disabled
233 //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);
234 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);
236 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);
239 MessageDialog dialog(message, false, Gtk::MESSAGE_QUESTION, Gtk::BUTTONS_NONE, true);
241 if (all_or_nothing) {
243 //dialog.add_button("Update", 0);
244 dialog.add_button("Import", 1);
245 dialog.add_button("Skip", 2);
247 dialog.add_button("Import", 1);
248 dialog.add_button("Cancel", 2);
251 //dialog.add_button("Skip all", 4); // All or rest?
255 function = dialog.run ();
263 boost::shared_ptr<AudioTrack>
264 Editor::get_nth_selected_audio_track (int nth) const
266 AudioTimeAxisView* atv;
267 TrackSelection::iterator x;
269 for (x = selection->tracks.begin(); nth > 0 && x != selection->tracks.end(); ++x) {
271 atv = dynamic_cast<AudioTimeAxisView*>(*x);
275 } else if (atv->is_audio_track()) {
280 if (x == selection->tracks.end()) {
281 atv = dynamic_cast<AudioTimeAxisView*>(selection->tracks.back());
283 atv = dynamic_cast<AudioTimeAxisView*>(*x);
286 if (!atv || !atv->is_audio_track()) {
287 return boost::shared_ptr<AudioTrack>();
290 return atv->audio_track();
293 boost::shared_ptr<MidiTrack>
294 Editor::get_nth_selected_midi_track (int nth) const
296 MidiTimeAxisView* mtv;
297 TrackSelection::iterator x;
299 for (x = selection->tracks.begin(); nth > 0 && x != selection->tracks.end(); ++x) {
301 mtv = dynamic_cast<MidiTimeAxisView*>(*x);
305 } else if (mtv->is_midi_track()) {
310 if (x == selection->tracks.end()) {
311 mtv = dynamic_cast<MidiTimeAxisView*>(selection->tracks.back());
313 mtv = dynamic_cast<MidiTimeAxisView*>(*x);
316 if (!mtv || !mtv->is_midi_track()) {
317 return boost::shared_ptr<MidiTrack>();
320 return mtv->midi_track();
324 Editor::do_import (vector<ustring> paths, ImportDisposition chns, ImportMode mode, SrcQuality quality, nframes64_t& pos)
326 boost::shared_ptr<Track> track;
327 vector<ustring> to_import;
330 current_interthread_info = &import_status;
331 import_status.current = 1;
332 import_status.total = paths.size ();
334 ImportProgressWindow ipw (&import_status, _("Import"), _("Cancel Import"));
336 if (chns == Editing::ImportMergeFiles) {
338 /* create 1 region from all paths, add to 1 track,
343 for (vector<ustring>::iterator a = paths.begin(); a != paths.end(); ++a) {
344 int check = check_whether_and_how_to_import(*a, false);
352 import_sndfiles (paths, mode, quality, pos, 1, 1, track, false);
357 bool replace = false;
360 for (vector<ustring>::iterator a = paths.begin(); a != paths.end(); ++a) {
362 const int check = check_whether_and_how_to_import (*a, true);
369 fatal << "Updating existing sources should be disabled!" << endmsg;
376 fatal << "Illegal return " << check << " from check_whether_and_how_to_import()!" << endmsg;
381 case Editing::ImportDistinctFiles:
384 to_import.push_back (*a);
386 if (mode == Editing::ImportToTrack) {
387 track = get_nth_selected_audio_track (nth++);
390 ok = (import_sndfiles (to_import, mode, quality, pos, 1, -1, track, replace) == 0);
393 case Editing::ImportDistinctChannels:
396 to_import.push_back (*a);
398 ok = (import_sndfiles (to_import, mode, quality, pos, -1, -1, track, replace) == 0);
401 case Editing::ImportSerializeFiles:
404 to_import.push_back (*a);
406 ok = (import_sndfiles (to_import, mode, quality, pos, 1, 1, track, replace) == 0);
409 case Editing::ImportMergeFiles:
410 // Not entered, handled in earlier if() branch
418 Editor::do_embed (vector<ustring> paths, ImportDisposition chns, ImportMode mode, nframes64_t& pos)
420 boost::shared_ptr<Track> track;
421 bool check_sample_rate = true;
423 vector<ustring> to_embed;
424 bool multi = paths.size() > 1;
428 case Editing::ImportDistinctFiles:
429 for (vector<ustring>::iterator a = paths.begin(); a != paths.end(); ++a) {
432 to_embed.push_back (*a);
434 if (mode == Editing::ImportToTrack) {
435 track = get_nth_selected_audio_track (nth++);
438 if (embed_sndfiles (to_embed, multi, check_sample_rate, mode, pos, 1, -1, track) < -1) {
444 case Editing::ImportDistinctChannels:
445 for (vector<ustring>::iterator a = paths.begin(); a != paths.end(); ++a) {
448 to_embed.push_back (*a);
450 if (embed_sndfiles (to_embed, multi, check_sample_rate, mode, pos, -1, -1, track) < -1) {
456 case Editing::ImportMergeFiles:
457 if (embed_sndfiles (paths, multi, check_sample_rate, mode, pos, 1, 1, track) < -1) {
462 case Editing::ImportSerializeFiles:
463 for (vector<ustring>::iterator a = paths.begin(); a != paths.end(); ++a) {
466 to_embed.push_back (*a);
468 if (embed_sndfiles (to_embed, multi, check_sample_rate, mode, pos, 1, 1, track) < -1) {
479 _session->save_state ("");
484 Editor::import_sndfiles (vector<ustring> paths, ImportMode mode, SrcQuality quality, nframes64_t& pos,
485 int target_regions, int target_tracks, boost::shared_ptr<Track>& track, bool replace)
487 import_status.paths = paths;
488 import_status.done = false;
489 import_status.cancel = false;
490 import_status.freeze = false;
491 import_status.done = 0.0;
492 import_status.quality = quality;
493 import_status.replace_existing_source = replace;
495 import_status.mode = mode;
496 import_status.pos = pos;
497 import_status.target_tracks = target_tracks;
498 import_status.target_regions = target_regions;
499 import_status.track = track;
500 import_status.replace = replace;
502 track_canvas->get_window()->set_cursor (Gdk::Cursor (Gdk::WATCH));
505 /* start import thread for this spec. this will ultimately call Session::import_audiofiles()
506 which, if successful, will add the files as regions to the region list. its up to us
507 (the GUI) to direct additional steps after that.
510 pthread_create_and_store ("import", &import_status.thread, _import_thread, this);
511 pthread_detach (import_status.thread);
513 while (!import_status.done && !import_status.cancel) {
514 gtk_main_iteration ();
517 import_status.done = true;
519 if (!import_status.cancel && !import_status.sources.empty()) {
520 if (add_sources (import_status.paths,
521 import_status.sources,
524 import_status.target_regions,
525 import_status.target_tracks,
526 track, false) == 0) {
527 _session->save_state ("");
530 /* update position from results */
532 pos = import_status.pos;
536 track_canvas->get_window()->set_cursor (*current_canvas_cursor);
541 Editor::embed_sndfiles (vector<Glib::ustring> paths, bool multifile,
542 bool& check_sample_rate, ImportMode mode, nframes64_t& pos, int target_regions, int target_tracks,
543 boost::shared_ptr<Track>& track)
545 boost::shared_ptr<AudioFileSource> source;
550 Glib::ustring path_to_use;
552 track_canvas->get_window()->set_cursor (Gdk::Cursor (Gdk::WATCH));
555 for (vector<Glib::ustring>::iterator p = paths.begin(); p != paths.end(); ++p) {
559 if (Config->get_try_link_for_embed()) {
561 /* lets see if we can link it into the session */
563 sys::path tmp = _session->session_directory().sound_path() / Glib::path_get_basename(path);
564 linked_path = tmp.to_string();
566 path_to_use = linked_path;
568 if (link (path.c_str(), linked_path.c_str()) == 0) {
570 /* there are many reasons why link(2) might have failed.
571 but if it succeeds, we now have a link in the
572 session sound dir that will protect against
573 unlinking of the original path. nice.
577 path_to_use = Glib::path_get_basename (path);
581 /* one possible reason is that its already linked */
583 if (errno == EEXIST) {
586 if (stat (linked_path.c_str(), &sb) == 0) {
587 if (sb.st_nlink > 1) { // its a hard link, assume its the one we want
589 path_to_use = Glib::path_get_basename (path);
596 /* note that we temporarily truncated _id at the colon */
600 if (!AudioFileSource::get_soundfile_info (path, finfo, error_msg)) {
601 error << string_compose(_("Editor: cannot open file \"%1\", (%2)"), path, error_msg ) << endmsg;
605 if (check_sample_rate && (finfo.samplerate != (int) _session->frame_rate())) {
606 vector<string> choices;
609 choices.push_back (_("Cancel entire import"));
610 choices.push_back (_("Don't embed it"));
611 choices.push_back (_("Embed all without questions"));
613 Gtkmm2ext::Choice rate_choice (
615 string_compose (_("%1\nThis audiofile's sample rate doesn't match the session sample rate!"),
616 short_path (path, 40)),
620 int resx = rate_choice.run ();
623 case 0: /* stop a multi-file import */
626 case 1: /* don't embed this one */
629 case 2: /* do it, and the rest without asking */
630 check_sample_rate = false;
639 choices.push_back (_("Cancel"));
640 choices.push_back (_("Embed it anyway"));
642 Gtkmm2ext::Choice rate_choice (
644 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 source = boost::dynamic_pointer_cast<AudioFileSource> (
675 SourceFactory::createReadable (DataType::AUDIO, *_session,
677 (mode == ImportAsTapeTrack
678 ? Source::Destructive
682 source = boost::dynamic_pointer_cast<AudioFileSource> (s);
685 sources.push_back(source);
688 catch (failed_constructor& err) {
689 error << string_compose(_("could not open %1"), path) << endmsg;
693 ARDOUR_UI::instance()->flush_pending ();
697 if (sources.empty()) {
701 ret = add_sources (paths, sources, pos, mode, target_regions, target_tracks, track, true);
704 track_canvas->get_window()->set_cursor (*current_canvas_cursor);
709 Editor::add_sources (vector<Glib::ustring> paths, SourceList& sources, nframes64_t& pos, ImportMode mode,
710 int target_regions, int target_tracks, boost::shared_ptr<Track>& track, bool /*add_channel_suffix*/)
712 vector<boost::shared_ptr<Region> > regions;
714 uint32_t input_chan = 0;
715 uint32_t output_chan = 0;
718 use_timestamp = (pos == -1);
721 if (sources[0]->natural_position() != 0) {
722 pos = sources[0]->natural_position();
724 pos = _session->current_start_frame();
728 // kludge (for MIDI we're abusing "channel" for "track" here)
729 if (paths.front().rfind(".mid") != Glib::ustring::npos)
732 if (target_regions == 1) {
734 /* take all the sources we have and package them up as a region */
736 region_name = region_name_from_path (paths.front(), (sources.size() > 1), false);
740 plist.add (ARDOUR::Properties::start, 0);
741 plist.add (ARDOUR::Properties::length, sources[0]->length (pos));
742 plist.add (ARDOUR::Properties::name, region_name);
743 plist.add (ARDOUR::Properties::layer, 0);
744 plist.add (ARDOUR::Properties::whole_file, true);
745 plist.add (ARDOUR::Properties::external, true);
747 boost::shared_ptr<Region> r = RegionFactory::create (sources, plist);
749 if (use_timestamp && boost::dynamic_pointer_cast<AudioRegion>(r)) {
750 boost::dynamic_pointer_cast<AudioRegion>(r)->special_set_position(sources[0]->natural_position());
753 regions.push_back (r);
756 } else if (target_regions == -1 || target_regions > 1) {
758 /* take each source and create a region for each one */
761 SourceList::iterator x;
764 for (n = 0, x = sources.begin(); x != sources.end(); ++x, ++n) {
767 just_one.push_back (*x);
769 region_name = region_name_from_path ((*x)->path(), false, false, sources.size(), n);
773 plist.add (ARDOUR::Properties::start, 0);
774 plist.add (ARDOUR::Properties::length, (*x)->length (pos));
775 plist.add (ARDOUR::Properties::name, region_name);
776 plist.add (ARDOUR::Properties::layer, 0);
777 plist.add (ARDOUR::Properties::whole_file, true);
778 plist.add (ARDOUR::Properties::external, true);
780 boost::shared_ptr<Region> r = RegionFactory::create (just_one, plist);
782 if (use_timestamp && boost::dynamic_pointer_cast<AudioRegion>(r)) {
783 boost::dynamic_pointer_cast<AudioRegion>(r)->special_set_position((*x)->natural_position());
786 regions.push_back (r);
790 if (target_regions == 1) {
791 input_chan = regions.front()->n_channels();
793 if (target_tracks == 1) {
794 input_chan = regions.size();
800 if (Config->get_output_auto_connect() & AutoConnectMaster) {
801 output_chan = (_session->master_out() ? _session->master_out()->n_inputs().n_audio() : input_chan);
803 output_chan = input_chan;
808 for (vector<boost::shared_ptr<Region> >::iterator r = regions.begin(); r != regions.end(); ++r, ++n) {
810 finish_bringing_in_material (*r, input_chan, output_chan, pos, mode, track);
812 if (target_tracks != 1) {
815 pos += (*r)->length();
819 /* setup peak file building in another thread */
821 for (SourceList::iterator x = sources.begin(); x != sources.end(); ++x) {
822 SourceFactory::setup_peakfile (*x, true);
829 Editor::finish_bringing_in_material (boost::shared_ptr<Region> region, uint32_t in_chans, uint32_t out_chans, nframes64_t& pos,
830 ImportMode mode, boost::shared_ptr<Track>& existing_track)
832 boost::shared_ptr<AudioRegion> ar = boost::dynamic_pointer_cast<AudioRegion>(region);
833 boost::shared_ptr<MidiRegion> mr = boost::dynamic_pointer_cast<MidiRegion>(region);
837 /* relax, its been done */
842 if (!existing_track) {
845 existing_track = get_nth_selected_audio_track (0);
847 existing_track = get_nth_selected_midi_track (0);
850 if (!existing_track) {
855 boost::shared_ptr<Playlist> playlist = existing_track->playlist();
856 boost::shared_ptr<Region> copy (RegionFactory::create (region, region->properties()));
857 begin_reversible_command (_("insert file"));
858 playlist->clear_history ();
859 playlist->add_region (copy, pos);
860 _session->add_command (new StatefulDiffCommand (playlist));
861 commit_reversible_command ();
867 if (!existing_track) {
869 list<boost::shared_ptr<AudioTrack> > at (_session->new_audio_track (in_chans, out_chans, Normal, 0, 1));
875 existing_track = at.front();
877 list<boost::shared_ptr<MidiTrack> > mt (_session->new_midi_track (Normal, 0, 1));
883 existing_track = mt.front();
886 existing_track->set_name (region->name());
889 boost::shared_ptr<Region> copy (RegionFactory::create (region));
890 existing_track->playlist()->add_region (copy, pos);
895 case ImportAsTapeTrack:
900 list<boost::shared_ptr<AudioTrack> > at (_session->new_audio_track (in_chans, out_chans, Destructive));
902 boost::shared_ptr<Region> copy (RegionFactory::create (region));
903 at.front()->set_name (basename_nosuffix (copy->name()));
904 at.front()->playlist()->add_region (copy, pos);
914 Editor::_import_thread (void *arg)
916 SessionEvent::create_per_thread_pool ("import events", 64);
918 Editor *ed = (Editor *) arg;
919 return ed->import_thread ();
923 Editor::import_thread ()
925 _session->import_audiofiles (import_status);
926 pthread_exit_pbd (0);