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"
65 using namespace ARDOUR;
68 using namespace Gtkmm2ext;
69 using namespace Editing;
72 /* Functions supporting the incorporation of external (non-captured) audio material into ardour */
75 Editor::add_external_audio_action (ImportMode mode_hint)
78 MessageDialog msg (_("You can't import or embed an audiofile until you have a session loaded."));
84 sfbrowser = new SoundFileOmega (*this, _("Add Existing Media"), _session, 0, true, mode_hint);
86 sfbrowser->set_mode (mode_hint);
89 external_audio_dialog ();
93 Editor::external_audio_dialog ()
95 vector<Glib::ustring> paths;
99 MessageDialog msg (_("You can't import or embed an audiofile until you have a session loaded."));
106 for (TrackSelection::iterator x = selection->tracks.begin(); x != selection->tracks.end(); ++x) {
107 AudioTimeAxisView* atv = dynamic_cast<AudioTimeAxisView*>(*x);
111 } else if (atv->is_audio_track()) {
116 if (sfbrowser == 0) {
117 sfbrowser = new SoundFileOmega (*this, _("Add Existing Media"), _session, track_cnt, true);
119 sfbrowser->reset (track_cnt);
122 sfbrowser->show_all ();
130 int response = sfbrowser->run ();
134 // leave the dialog open
142 // cancel from the browser - we are done
149 paths = sfbrowser->get_paths ();
151 ImportPosition pos = sfbrowser->get_position ();
152 ImportMode mode = sfbrowser->get_mode ();
153 ImportDisposition chns = sfbrowser->get_channel_disposition ();
157 case ImportAtEditPoint:
158 where = get_preferred_edit_position ();
160 case ImportAtTimestamp:
163 case ImportAtPlayhead:
164 where = playhead_cursor->current_frame;
167 where = _session->current_start_frame();
171 SrcQuality quality = sfbrowser->get_src_quality();
174 if (sfbrowser->copy_files_btn.get_active()) {
175 do_import (paths, chns, mode, quality, where);
177 do_embed (paths, chns, mode, where);
180 if (response == RESPONSE_APPLY) {
181 sfbrowser->clear_selection ();
185 } while (keepRunning);
189 Editor::session_import_dialog ()
191 SessionImportDialog dialog (_session);
192 ensure_float (dialog);
196 typedef std::map<PBD::ID,boost::shared_ptr<ARDOUR::Source> > SourceMap;
199 * Updating is still disabled, see note in libs/ardour/import.cc Session::import_audiofiles()
202 * true = show "Update", "Import" and "Skip"
203 * false = show "Import", and "Cancel"
206 * 0 To update an existing source of the same name
207 * 1 To import/embed the file normally (make sure the new name will be unique)
208 * 2 If the user wants to skip this file
211 Editor::check_whether_and_how_to_import(string path, bool all_or_nothing)
213 string wave_name (Glib::path_get_basename(path));
215 SourceMap all_sources = _session->get_sources();
216 bool wave_name_exists = false;
218 for (SourceMap::iterator i = all_sources.begin(); i != all_sources.end(); ++i) {
219 string tmp (Glib::path_get_basename (i->second->path()));
220 if (tmp == wave_name) {
221 wave_name_exists = true;
228 if (wave_name_exists) {
230 if (all_or_nothing) {
231 // updating is still disabled
232 //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);
233 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);
235 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);
238 MessageDialog dialog(message, false, Gtk::MESSAGE_QUESTION, Gtk::BUTTONS_NONE, true);
240 if (all_or_nothing) {
242 //dialog.add_button("Update", 0);
243 dialog.add_button("Import", 1);
244 dialog.add_button("Skip", 2);
246 dialog.add_button("Import", 1);
247 dialog.add_button("Cancel", 2);
250 //dialog.add_button("Skip all", 4); // All or rest?
254 function = dialog.run ();
262 boost::shared_ptr<AudioTrack>
263 Editor::get_nth_selected_audio_track (int nth) const
265 AudioTimeAxisView* atv;
266 TrackSelection::iterator x;
268 for (x = selection->tracks.begin(); nth > 0 && x != selection->tracks.end(); ++x) {
270 atv = dynamic_cast<AudioTimeAxisView*>(*x);
274 } else if (atv->is_audio_track()) {
279 if (x == selection->tracks.end()) {
280 atv = dynamic_cast<AudioTimeAxisView*>(selection->tracks.back());
282 atv = dynamic_cast<AudioTimeAxisView*>(*x);
285 if (!atv || !atv->is_audio_track()) {
286 return boost::shared_ptr<AudioTrack>();
289 return atv->audio_track();
292 boost::shared_ptr<MidiTrack>
293 Editor::get_nth_selected_midi_track (int nth) const
295 MidiTimeAxisView* mtv;
296 TrackSelection::iterator x;
298 for (x = selection->tracks.begin(); nth > 0 && x != selection->tracks.end(); ++x) {
300 mtv = dynamic_cast<MidiTimeAxisView*>(*x);
304 } else if (mtv->is_midi_track()) {
309 if (x == selection->tracks.end()) {
310 mtv = dynamic_cast<MidiTimeAxisView*>(selection->tracks.back());
312 mtv = dynamic_cast<MidiTimeAxisView*>(*x);
315 if (!mtv || !mtv->is_midi_track()) {
316 return boost::shared_ptr<MidiTrack>();
319 return mtv->midi_track();
323 Editor::do_import (vector<ustring> paths, ImportDisposition chns, ImportMode mode, SrcQuality quality, nframes64_t& pos)
325 boost::shared_ptr<Track> track;
326 vector<ustring> to_import;
329 current_interthread_info = &import_status;
330 import_status.current = 1;
331 import_status.total = paths.size ();
333 if (interthread_progress_window == 0) {
334 build_interthread_progress_window ();
337 interthread_progress_window->set_title (_("Import"));
338 interthread_progress_bar.set_fraction (0.0f);
339 interthread_cancel_label.set_text (_("Cancel Import"));
340 interthread_progress_connection = Glib::signal_timeout().connect
341 (sigc::bind (sigc::mem_fun(*this, &Editor::import_progress_timeout), (gpointer) 0), 500);
343 if (chns == Editing::ImportMergeFiles) {
345 /* create 1 region from all paths, add to 1 track,
350 for (vector<ustring>::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<ustring>::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;
388 case Editing::ImportDistinctFiles:
391 to_import.push_back (*a);
393 if (mode == Editing::ImportToTrack) {
394 track = get_nth_selected_audio_track (nth++);
397 ok = (import_sndfiles (to_import, mode, quality, pos, 1, -1, track, replace) == 0);
400 case Editing::ImportDistinctChannels:
403 to_import.push_back (*a);
405 ok = (import_sndfiles (to_import, mode, quality, pos, -1, -1, track, replace) == 0);
408 case Editing::ImportSerializeFiles:
411 to_import.push_back (*a);
413 ok = (import_sndfiles (to_import, mode, quality, pos, 1, 1, track, replace) == 0);
416 case Editing::ImportMergeFiles:
417 // Not entered, handled in earlier if() branch
423 interthread_progress_window->hide_all ();
424 interthread_progress_connection.disconnect ();
428 Editor::do_embed (vector<ustring> paths, ImportDisposition chns, ImportMode mode, nframes64_t& pos)
430 boost::shared_ptr<Track> track;
431 bool check_sample_rate = true;
433 vector<ustring> to_embed;
434 bool multi = paths.size() > 1;
438 case Editing::ImportDistinctFiles:
439 for (vector<ustring>::iterator a = paths.begin(); a != paths.end(); ++a) {
442 to_embed.push_back (*a);
444 if (mode == Editing::ImportToTrack) {
445 track = get_nth_selected_audio_track (nth++);
448 if (embed_sndfiles (to_embed, multi, check_sample_rate, mode, pos, 1, -1, track) < -1) {
454 case Editing::ImportDistinctChannels:
455 for (vector<ustring>::iterator a = paths.begin(); a != paths.end(); ++a) {
458 to_embed.push_back (*a);
460 if (embed_sndfiles (to_embed, multi, check_sample_rate, mode, pos, -1, -1, track) < -1) {
466 case Editing::ImportMergeFiles:
467 if (embed_sndfiles (paths, multi, check_sample_rate, mode, pos, 1, 1, track) < -1) {
472 case Editing::ImportSerializeFiles:
473 for (vector<ustring>::iterator a = paths.begin(); a != paths.end(); ++a) {
476 to_embed.push_back (*a);
478 if (embed_sndfiles (to_embed, multi, check_sample_rate, mode, pos, 1, 1, track) < -1) {
489 _session->save_state ("");
494 Editor::import_sndfiles (vector<ustring> paths, ImportMode mode, SrcQuality quality, nframes64_t& pos,
495 int target_regions, int target_tracks, boost::shared_ptr<Track>& track, bool replace)
497 import_status.paths = paths;
498 import_status.done = false;
499 import_status.cancel = false;
500 import_status.freeze = false;
501 import_status.done = 0.0;
502 import_status.quality = quality;
503 import_status.replace_existing_source = replace;
505 import_status.mode = mode;
506 import_status.pos = pos;
507 import_status.target_tracks = target_tracks;
508 import_status.target_regions = target_regions;
509 import_status.track = track;
510 import_status.replace = replace;
512 track_canvas->get_window()->set_cursor (Gdk::Cursor (Gdk::WATCH));
515 /* start import thread for this spec. this will ultimately call Session::import_audiofiles()
516 which, if successful, will add the files as regions to the region list. its up to us
517 (the GUI) to direct additional steps after that.
520 pthread_create_and_store ("import", &import_status.thread, _import_thread, this);
521 pthread_detach (import_status.thread);
523 while (!import_status.done && !import_status.cancel) {
524 gtk_main_iteration ();
527 import_status.done = true;
529 if (!import_status.cancel && !import_status.sources.empty()) {
530 if (add_sources (import_status.paths,
531 import_status.sources,
534 import_status.target_regions,
535 import_status.target_tracks,
536 track, false) == 0) {
537 _session->save_state ("");
540 /* update position from results */
542 pos = import_status.pos;
546 track_canvas->get_window()->set_cursor (*current_canvas_cursor);
551 Editor::embed_sndfiles (vector<Glib::ustring> paths, bool multifile,
552 bool& check_sample_rate, ImportMode mode, nframes64_t& pos, int target_regions, int target_tracks,
553 boost::shared_ptr<Track>& track)
555 boost::shared_ptr<AudioFileSource> source;
560 Glib::ustring path_to_use;
562 track_canvas->get_window()->set_cursor (Gdk::Cursor (Gdk::WATCH));
565 for (vector<Glib::ustring>::iterator p = paths.begin(); p != paths.end(); ++p) {
569 if (Config->get_try_link_for_embed()) {
571 /* lets see if we can link it into the session */
573 sys::path tmp = _session->session_directory().sound_path() / Glib::path_get_basename(path);
574 linked_path = tmp.to_string();
576 path_to_use = linked_path;
578 if (link (path.c_str(), linked_path.c_str()) == 0) {
580 /* there are many reasons why link(2) might have failed.
581 but if it succeeds, we now have a link in the
582 session sound dir that will protect against
583 unlinking of the original path. nice.
587 path_to_use = Glib::path_get_basename (path);
591 /* one possible reason is that its already linked */
593 if (errno == EEXIST) {
596 if (stat (linked_path.c_str(), &sb) == 0) {
597 if (sb.st_nlink > 1) { // its a hard link, assume its the one we want
599 path_to_use = Glib::path_get_basename (path);
606 /* note that we temporarily truncated _id at the colon */
610 if (!AudioFileSource::get_soundfile_info (path, finfo, error_msg)) {
611 error << string_compose(_("Editor: cannot open file \"%1\", (%2)"), path, error_msg ) << endmsg;
615 if (check_sample_rate && (finfo.samplerate != (int) _session->frame_rate())) {
616 vector<string> choices;
619 choices.push_back (_("Cancel entire import"));
620 choices.push_back (_("Don't embed it"));
621 choices.push_back (_("Embed all without questions"));
623 Gtkmm2ext::Choice rate_choice (
625 string_compose (_("%1\nThis audiofile's sample rate doesn't match the session sample rate!"),
626 short_path (path, 40)),
630 int resx = rate_choice.run ();
633 case 0: /* stop a multi-file import */
636 case 1: /* don't embed this one */
639 case 2: /* do it, and the rest without asking */
640 check_sample_rate = false;
649 choices.push_back (_("Cancel"));
650 choices.push_back (_("Embed it anyway"));
652 Gtkmm2ext::Choice rate_choice (
654 string_compose (_("%1\nThis audiofile's sample rate doesn't match the session sample rate!"), path),
658 int resx = rate_choice.run ();
661 case 0: /* don't import */
673 track_canvas->get_window()->set_cursor (Gdk::Cursor (Gdk::WATCH));
675 for (int n = 0; n < finfo.channels; ++n) {
678 /* check if we have this thing embedded already */
680 boost::shared_ptr<Source> s;
682 if ((s = _session->source_by_path_and_channel (path, n)) == 0) {
684 source = boost::dynamic_pointer_cast<AudioFileSource> (
685 SourceFactory::createReadable (DataType::AUDIO, *_session,
687 (mode == ImportAsTapeTrack
688 ? Source::Destructive
692 source = boost::dynamic_pointer_cast<AudioFileSource> (s);
695 sources.push_back(source);
698 catch (failed_constructor& err) {
699 error << string_compose(_("could not open %1"), path) << endmsg;
703 ARDOUR_UI::instance()->flush_pending ();
707 if (sources.empty()) {
711 ret = add_sources (paths, sources, pos, mode, target_regions, target_tracks, track, true);
714 track_canvas->get_window()->set_cursor (*current_canvas_cursor);
719 Editor::add_sources (vector<Glib::ustring> paths, SourceList& sources, nframes64_t& pos, ImportMode mode,
720 int target_regions, int target_tracks, boost::shared_ptr<Track>& track, bool /*add_channel_suffix*/)
722 vector<boost::shared_ptr<Region> > regions;
724 uint32_t input_chan = 0;
725 uint32_t output_chan = 0;
728 use_timestamp = (pos == -1);
731 if (sources[0]->natural_position() != 0) {
732 pos = sources[0]->natural_position();
734 pos = get_preferred_edit_position ();
738 // kludge (for MIDI we're abusing "channel" for "track" here)
739 if (paths.front().rfind(".mid") != Glib::ustring::npos)
742 if (target_regions == 1) {
744 /* take all the sources we have and package them up as a region */
746 region_name = region_name_from_path (paths.front(), (sources.size() > 1), false);
750 plist.add (ARDOUR::Properties::start, 0);
751 plist.add (ARDOUR::Properties::length, sources[0]->length (pos));
752 plist.add (ARDOUR::Properties::name, region_name);
753 plist.add (ARDOUR::Properties::layer, 0);
754 plist.add (ARDOUR::Properties::whole_file, true);
755 plist.add (ARDOUR::Properties::external, true);
757 boost::shared_ptr<Region> r = RegionFactory::create (sources, plist);
759 if (use_timestamp && boost::dynamic_pointer_cast<AudioRegion>(r)) {
760 boost::dynamic_pointer_cast<AudioRegion>(r)->special_set_position(sources[0]->natural_position());
763 regions.push_back (r);
766 } else if (target_regions == -1 || target_regions > 1) {
768 /* take each source and create a region for each one */
771 SourceList::iterator x;
774 for (n = 0, x = sources.begin(); x != sources.end(); ++x, ++n) {
777 just_one.push_back (*x);
779 region_name = region_name_from_path ((*x)->path(), false, false, sources.size(), n);
783 plist.add (ARDOUR::Properties::start, 0);
784 plist.add (ARDOUR::Properties::length, (*x)->length (pos));
785 plist.add (ARDOUR::Properties::name, region_name);
786 plist.add (ARDOUR::Properties::layer, 0);
787 plist.add (ARDOUR::Properties::whole_file, true);
788 plist.add (ARDOUR::Properties::external, true);
790 boost::shared_ptr<Region> r = RegionFactory::create (just_one, plist);
792 if (use_timestamp && boost::dynamic_pointer_cast<AudioRegion>(r)) {
793 boost::dynamic_pointer_cast<AudioRegion>(r)->special_set_position((*x)->natural_position());
796 regions.push_back (r);
800 if (target_regions == 1) {
801 input_chan = regions.front()->n_channels();
803 if (target_tracks == 1) {
804 input_chan = regions.size();
810 if (Config->get_output_auto_connect() & AutoConnectMaster) {
811 output_chan = (_session->master_out() ? _session->master_out()->n_inputs().n_audio() : input_chan);
813 output_chan = input_chan;
818 for (vector<boost::shared_ptr<Region> >::iterator r = regions.begin(); r != regions.end(); ++r, ++n) {
820 finish_bringing_in_material (*r, input_chan, output_chan, pos, mode, track);
822 if (target_tracks != 1) {
825 pos += (*r)->length();
829 /* setup peak file building in another thread */
831 for (SourceList::iterator x = sources.begin(); x != sources.end(); ++x) {
832 SourceFactory::setup_peakfile (*x, true);
839 Editor::finish_bringing_in_material (boost::shared_ptr<Region> region, uint32_t in_chans, uint32_t out_chans, nframes64_t& pos,
840 ImportMode mode, boost::shared_ptr<Track>& existing_track)
842 boost::shared_ptr<AudioRegion> ar = boost::dynamic_pointer_cast<AudioRegion>(region);
843 boost::shared_ptr<MidiRegion> mr = boost::dynamic_pointer_cast<MidiRegion>(region);
847 /* relax, its been done */
852 if (!existing_track) {
855 existing_track = get_nth_selected_audio_track (0);
857 existing_track = get_nth_selected_midi_track (0);
860 if (!existing_track) {
865 boost::shared_ptr<Playlist> playlist = existing_track->diskstream()->playlist();
866 boost::shared_ptr<Region> copy (RegionFactory::create (region, region->properties()));
867 begin_reversible_command (_("insert file"));
868 playlist->clear_history ();
869 playlist->add_region (copy, pos);
870 _session->add_command (new StatefulDiffCommand (playlist));
871 commit_reversible_command ();
877 if (!existing_track) {
879 list<boost::shared_ptr<AudioTrack> > at (_session->new_audio_track (in_chans, out_chans, Normal, 0, 1));
885 existing_track = at.front();
887 list<boost::shared_ptr<MidiTrack> > mt (_session->new_midi_track (Normal, 0, 1));
893 existing_track = mt.front();
896 existing_track->set_name (region->name());
899 boost::shared_ptr<Region> copy (RegionFactory::create (region));
900 existing_track->diskstream()->playlist()->add_region (copy, pos);
905 case ImportAsTapeTrack:
910 list<boost::shared_ptr<AudioTrack> > at (_session->new_audio_track (in_chans, out_chans, Destructive));
912 boost::shared_ptr<Region> copy (RegionFactory::create (region));
913 at.front()->set_name (basename_nosuffix (copy->name()));
914 at.front()->diskstream()->playlist()->add_region (copy, pos);
924 Editor::_import_thread (void *arg)
926 SessionEvent::create_per_thread_pool ("import events", 64);
928 Editor *ed = (Editor *) arg;
929 return ed->import_thread ();
933 Editor::import_thread ()
935 _session->import_audiofiles (import_status);
936 pthread_exit_pbd (0);
942 Editor::import_progress_timeout (void */*arg*/)
946 if (!interthread_progress_window->is_visible()) {
947 interthread_progress_window->show_all ();
951 interthread_progress_label.set_markup (import_status.doing_what);
953 if (import_status.freeze) {
954 interthread_cancel_button.set_sensitive(false);
956 interthread_cancel_button.set_sensitive(true);
959 if (import_status.doing_what == "building peak files") {
960 interthread_progress_bar.pulse ();
963 float val = import_status.progress;
964 interthread_progress_bar.set_fraction (min (max (0.0f, val), 1.0f));
969 /* the window is now visible, speed up the updates */
971 interthread_progress_connection.disconnect ();
972 interthread_progress_connection = Glib::signal_timeout().connect
973 (sigc::bind (sigc::mem_fun(*this, &Editor::import_progress_timeout), (gpointer) 0), 100);
976 return !(import_status.done || import_status.cancel);