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"
63 #include "mouse_cursors.h"
64 #include "editor_cursors.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<string> upaths = sfbrowser->get_paths ();
154 for (vector<string>::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 already_exists = false;
226 if ((existing = _session->count_sources_by_origin (path)) > 0) {
227 already_exists = true;
232 if (already_exists) {
234 if (all_or_nothing) {
235 // updating is still disabled
236 //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);
237 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);
239 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);
242 MessageDialog dialog(message, false, Gtk::MESSAGE_QUESTION, Gtk::BUTTONS_NONE, true);
244 if (all_or_nothing) {
246 //dialog.add_button("Update", 0);
247 dialog.add_button("Import", 1);
248 dialog.add_button("Skip", 2);
250 dialog.add_button("Import", 1);
251 dialog.add_button("Cancel", 2);
254 //dialog.add_button("Skip all", 4); // All or rest?
258 function = dialog.run ();
266 boost::shared_ptr<AudioTrack>
267 Editor::get_nth_selected_audio_track (int nth) const
269 AudioTimeAxisView* atv;
270 TrackSelection::iterator x;
272 for (x = selection->tracks.begin(); nth > 0 && x != selection->tracks.end(); ++x) {
274 atv = dynamic_cast<AudioTimeAxisView*>(*x);
278 } else if (atv->is_audio_track()) {
283 if (x == selection->tracks.end()) {
284 atv = dynamic_cast<AudioTimeAxisView*>(selection->tracks.back());
286 atv = dynamic_cast<AudioTimeAxisView*>(*x);
289 if (!atv || !atv->is_audio_track()) {
290 return boost::shared_ptr<AudioTrack>();
293 return atv->audio_track();
296 boost::shared_ptr<MidiTrack>
297 Editor::get_nth_selected_midi_track (int nth) const
299 MidiTimeAxisView* mtv;
300 TrackSelection::iterator x;
302 for (x = selection->tracks.begin(); nth > 0 && x != selection->tracks.end(); ++x) {
304 mtv = dynamic_cast<MidiTimeAxisView*>(*x);
308 } else if (mtv->is_midi_track()) {
313 if (x == selection->tracks.end()) {
314 mtv = dynamic_cast<MidiTimeAxisView*>(selection->tracks.back());
316 mtv = dynamic_cast<MidiTimeAxisView*>(*x);
319 if (!mtv || !mtv->is_midi_track()) {
320 return boost::shared_ptr<MidiTrack>();
323 return mtv->midi_track();
327 Editor::do_import (vector<string> paths, ImportDisposition chns, ImportMode mode, SrcQuality quality, framepos_t& pos)
329 boost::shared_ptr<Track> track;
330 vector<string> to_import;
332 bool use_timestamp = (pos == -1);
334 current_interthread_info = &import_status;
335 import_status.current = 1;
336 import_status.total = paths.size ();
337 import_status.all_done = false;
339 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);
362 ok = (import_sndfiles (paths, mode, quality, pos, 1, 1, track, false) == 0);
367 bool replace = false;
369 for (vector<string>::iterator a = paths.begin(); a != paths.end(); ++a) {
371 const int check = check_whether_and_how_to_import (*a, true);
378 fatal << "Updating existing sources should be disabled!" << endmsg;
385 fatal << "Illegal return " << check << " from check_whether_and_how_to_import()!" << endmsg;
389 /* have to reset this for every file we handle */
398 case Editing::ImportDistinctFiles:
401 to_import.push_back (*a);
403 if (mode == Editing::ImportToTrack) {
404 track = get_nth_selected_audio_track (nth++);
407 ok = (import_sndfiles (to_import, mode, quality, pos, 1, -1, track, replace) == 0);
410 case Editing::ImportDistinctChannels:
413 to_import.push_back (*a);
415 ok = (import_sndfiles (to_import, mode, quality, pos, -1, -1, track, replace) == 0);
418 case Editing::ImportSerializeFiles:
421 to_import.push_back (*a);
423 ok = (import_sndfiles (to_import, mode, quality, pos, 1, 1, track, replace) == 0);
426 case Editing::ImportMergeFiles:
427 // Not entered, handled in earlier if() branch
434 _session->save_state ("");
437 import_status.all_done = true;
441 Editor::do_embed (vector<string> paths, ImportDisposition chns, ImportMode mode, framepos_t& pos)
443 boost::shared_ptr<Track> track;
444 bool check_sample_rate = true;
446 vector<string> to_embed;
447 bool multi = paths.size() > 1;
451 case Editing::ImportDistinctFiles:
452 for (vector<string>::iterator a = paths.begin(); a != paths.end(); ++a) {
455 to_embed.push_back (*a);
457 if (mode == Editing::ImportToTrack) {
458 track = get_nth_selected_audio_track (nth++);
461 if (embed_sndfiles (to_embed, multi, check_sample_rate, mode, pos, 1, -1, track) < -1) {
467 case Editing::ImportDistinctChannels:
468 for (vector<string>::iterator a = paths.begin(); a != paths.end(); ++a) {
471 to_embed.push_back (*a);
473 if (embed_sndfiles (to_embed, multi, check_sample_rate, mode, pos, -1, -1, track) < -1) {
479 case Editing::ImportMergeFiles:
480 if (embed_sndfiles (paths, multi, check_sample_rate, mode, pos, 1, 1, track) < -1) {
485 case Editing::ImportSerializeFiles:
486 for (vector<string>::iterator a = paths.begin(); a != paths.end(); ++a) {
489 to_embed.push_back (*a);
491 if (embed_sndfiles (to_embed, multi, check_sample_rate, mode, pos, 1, 1, track) < -1) {
502 _session->save_state ("");
507 Editor::import_sndfiles (vector<string> paths, ImportMode mode, SrcQuality quality, framepos_t& pos,
508 int target_regions, int target_tracks, boost::shared_ptr<Track>& track, bool replace)
510 import_status.paths = paths;
511 import_status.done = false;
512 import_status.cancel = false;
513 import_status.freeze = false;
514 import_status.quality = quality;
515 import_status.replace_existing_source = replace;
517 import_status.mode = mode;
518 import_status.pos = pos;
519 import_status.target_tracks = target_tracks;
520 import_status.target_regions = target_regions;
521 import_status.track = track;
522 import_status.replace = replace;
524 set_canvas_cursor (_cursors->wait);
527 /* start import thread for this spec. this will ultimately call Session::import_audiofiles()
528 which, if successful, will add the files as regions to the region list. its up to us
529 (the GUI) to direct additional steps after that.
532 pthread_create_and_store ("import", &import_status.thread, _import_thread, this);
533 pthread_detach (import_status.thread);
535 while (!import_status.done && !import_status.cancel) {
536 gtk_main_iteration ();
539 import_status.done = true;
543 if (!import_status.cancel && !import_status.sources.empty()) {
544 result = add_sources (
546 import_status.sources,
549 import_status.target_regions,
550 import_status.target_tracks,
554 /* update position from results */
556 pos = import_status.pos;
559 set_canvas_cursor (current_canvas_cursor);
564 Editor::embed_sndfiles (vector<string> paths, bool multifile,
565 bool& check_sample_rate, ImportMode mode, framepos_t& pos, int target_regions, int target_tracks,
566 boost::shared_ptr<Track>& track)
568 boost::shared_ptr<AudioFileSource> source;
574 set_canvas_cursor (_cursors->wait);
577 for (vector<string>::iterator p = paths.begin(); p != paths.end(); ++p) {
582 /* note that we temporarily truncated _id at the colon */
584 if (!AudioFileSource::get_soundfile_info (path, finfo, error_msg)) {
585 error << string_compose(_("Editor: cannot open file \"%1\", (%2)"), path, error_msg ) << endmsg;
589 if (check_sample_rate && (finfo.samplerate != (int) _session->frame_rate())) {
590 vector<string> choices;
593 choices.push_back (_("Cancel entire import"));
594 choices.push_back (_("Don't embed it"));
595 choices.push_back (_("Embed all without questions"));
597 Gtkmm2ext::Choice rate_choice (
599 string_compose (_("%1\nThis audiofile's sample rate doesn't match the session sample rate!"),
600 short_path (path, 40)),
604 int resx = rate_choice.run ();
607 case 0: /* stop a multi-file import */
610 case 1: /* don't embed this one */
613 case 2: /* do it, and the rest without asking */
614 check_sample_rate = false;
623 choices.push_back (_("Cancel"));
624 choices.push_back (_("Embed it anyway"));
626 Gtkmm2ext::Choice rate_choice (
628 string_compose (_("%1\nThis audiofile's sample rate doesn't match the session sample rate!"), path),
632 int resx = rate_choice.run ();
635 case 0: /* don't import */
647 set_canvas_cursor (_cursors->wait);
649 for (int n = 0; n < finfo.channels; ++n) {
652 /* check if we have this thing embedded already */
654 boost::shared_ptr<Source> s;
656 if ((s = _session->source_by_path_and_channel (path, n)) == 0) {
658 source = boost::dynamic_pointer_cast<AudioFileSource> (
659 SourceFactory::createReadable (DataType::AUDIO, *_session,
661 (mode == ImportAsTapeTrack
662 ? Source::Destructive
666 source = boost::dynamic_pointer_cast<AudioFileSource> (s);
669 sources.push_back(source);
672 catch (failed_constructor& err) {
673 error << string_compose(_("could not open %1"), path) << endmsg;
677 ARDOUR_UI::instance()->flush_pending ();
681 if (sources.empty()) {
685 ret = add_sources (paths, sources, pos, mode, target_regions, target_tracks, track, true);
688 set_canvas_cursor (current_canvas_cursor);
693 Editor::add_sources (vector<string> paths, SourceList& sources, framepos_t& pos, ImportMode mode,
694 int target_regions, int target_tracks, boost::shared_ptr<Track>& track, bool /*add_channel_suffix*/)
696 vector<boost::shared_ptr<Region> > regions;
698 uint32_t input_chan = 0;
699 uint32_t output_chan = 0;
702 use_timestamp = (pos == -1);
704 // kludge (for MIDI we're abusing "channel" for "track" here)
705 if (SMFSource::safe_midi_file_extension (paths.front())) {
709 if (target_regions == 1) {
711 /* take all the sources we have and package them up as a region */
713 region_name = region_name_from_path (paths.front(), (sources.size() > 1), false);
715 /* we checked in import_sndfiles() that there were not too many */
717 while (RegionFactory::region_by_name (region_name)) {
718 region_name = bump_name_once (region_name, '.');
723 plist.add (ARDOUR::Properties::start, 0);
724 plist.add (ARDOUR::Properties::length, sources[0]->length (pos));
725 plist.add (ARDOUR::Properties::name, region_name);
726 plist.add (ARDOUR::Properties::layer, 0);
727 plist.add (ARDOUR::Properties::whole_file, true);
728 plist.add (ARDOUR::Properties::external, true);
730 boost::shared_ptr<Region> r = RegionFactory::create (sources, plist);
732 if (use_timestamp && boost::dynamic_pointer_cast<AudioRegion>(r)) {
733 boost::dynamic_pointer_cast<AudioRegion>(r)->special_set_position(sources[0]->natural_position());
736 regions.push_back (r);
739 } else if (target_regions == -1 || target_regions > 1) {
741 /* take each source and create a region for each one */
744 SourceList::iterator x;
747 for (n = 0, x = sources.begin(); x != sources.end(); ++x, ++n) {
750 just_one.push_back (*x);
752 region_name = region_name_from_path ((*x)->path(), false, false, sources.size(), n);
756 plist.add (ARDOUR::Properties::start, 0);
757 plist.add (ARDOUR::Properties::length, (*x)->length (pos));
758 plist.add (ARDOUR::Properties::name, region_name);
759 plist.add (ARDOUR::Properties::layer, 0);
760 plist.add (ARDOUR::Properties::whole_file, true);
761 plist.add (ARDOUR::Properties::external, true);
763 boost::shared_ptr<Region> r = RegionFactory::create (just_one, plist);
765 if (use_timestamp && boost::dynamic_pointer_cast<AudioRegion>(r)) {
766 boost::dynamic_pointer_cast<AudioRegion>(r)->special_set_position((*x)->natural_position());
769 regions.push_back (r);
773 if (target_regions == 1) {
774 input_chan = regions.front()->n_channels();
776 if (target_tracks == 1) {
777 input_chan = regions.size();
783 if (Config->get_output_auto_connect() & AutoConnectMaster) {
784 output_chan = (_session->master_out() ? _session->master_out()->n_inputs().n_audio() : input_chan);
786 output_chan = input_chan;
792 for (vector<boost::shared_ptr<Region> >::iterator r = regions.begin(); r != regions.end(); ++r, ++n) {
793 boost::shared_ptr<AudioRegion> ar = boost::dynamic_pointer_cast<AudioRegion> (*r);
795 if (use_timestamp && ar) {
797 /* get timestamp for this region */
799 const boost::shared_ptr<Source> s (ar->sources().front());
800 const boost::shared_ptr<AudioSource> as = boost::dynamic_pointer_cast<AudioSource> (s);
804 if (as->natural_position() != 0) {
805 pos = as->natural_position();
806 } else if (target_tracks == 1) {
807 /* hmm, no timestamp available, put it after the previous region
810 pos = get_preferred_edit_position ();
815 pos = get_preferred_edit_position ();
820 finish_bringing_in_material (*r, input_chan, output_chan, pos, mode, track);
822 rlen = (*r)->length();
824 if (target_tracks != 1) {
827 if (!use_timestamp || !ar) {
828 /* line each one up right after the other */
829 pos += (*r)->length();
834 /* setup peak file building in another thread */
836 for (SourceList::iterator x = sources.begin(); x != sources.end(); ++x) {
837 SourceFactory::setup_peakfile (*x, true);
844 Editor::finish_bringing_in_material (boost::shared_ptr<Region> region, uint32_t in_chans, uint32_t out_chans, framepos_t& pos,
845 ImportMode mode, boost::shared_ptr<Track>& existing_track)
847 boost::shared_ptr<AudioRegion> ar = boost::dynamic_pointer_cast<AudioRegion>(region);
848 boost::shared_ptr<MidiRegion> mr = boost::dynamic_pointer_cast<MidiRegion>(region);
852 /* relax, its been done */
857 if (!existing_track) {
860 existing_track = get_nth_selected_audio_track (0);
862 existing_track = get_nth_selected_midi_track (0);
865 if (!existing_track) {
870 boost::shared_ptr<Playlist> playlist = existing_track->playlist();
871 boost::shared_ptr<Region> copy (RegionFactory::create (region, region->properties()));
872 begin_reversible_command (_("insert file"));
873 playlist->clear_changes ();
874 playlist->add_region (copy, pos);
875 _session->add_command (new StatefulDiffCommand (playlist));
876 commit_reversible_command ();
882 if (!existing_track) {
884 list<boost::shared_ptr<AudioTrack> > at (_session->new_audio_track (in_chans, out_chans, Normal, 0, 1));
890 existing_track = at.front();
892 list<boost::shared_ptr<MidiTrack> > mt (_session->new_midi_track (Normal, 0, 1));
898 existing_track = mt.front();
901 existing_track->set_name (region->name());
904 boost::shared_ptr<Region> copy (RegionFactory::create (region));
905 existing_track->playlist()->add_region (copy, pos);
910 case ImportAsTapeTrack:
915 list<boost::shared_ptr<AudioTrack> > at (_session->new_audio_track (in_chans, out_chans, Destructive));
917 boost::shared_ptr<Region> copy (RegionFactory::create (region));
918 at.front()->set_name (basename_nosuffix (copy->name()));
919 at.front()->playlist()->add_region (copy, pos);
929 Editor::_import_thread (void *arg)
931 SessionEvent::create_per_thread_pool ("import events", 64);
933 Editor *ed = (Editor *) arg;
934 return ed->import_thread ();
938 Editor::import_thread ()
940 _session->import_audiofiles (import_status);
941 pthread_exit_pbd (0);