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 already_exists = false;
224 if ((existing = _session->count_sources_by_origin (path)) > 0) {
225 already_exists = true;
230 if (already_exists) {
232 if (all_or_nothing) {
233 // updating is still disabled
234 //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);
235 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);
237 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);
240 MessageDialog dialog(message, false, Gtk::MESSAGE_QUESTION, Gtk::BUTTONS_NONE, true);
242 if (all_or_nothing) {
244 //dialog.add_button("Update", 0);
245 dialog.add_button("Import", 1);
246 dialog.add_button("Skip", 2);
248 dialog.add_button("Import", 1);
249 dialog.add_button("Cancel", 2);
252 //dialog.add_button("Skip all", 4); // All or rest?
256 function = dialog.run ();
264 boost::shared_ptr<AudioTrack>
265 Editor::get_nth_selected_audio_track (int nth) const
267 AudioTimeAxisView* atv;
268 TrackSelection::iterator x;
270 for (x = selection->tracks.begin(); nth > 0 && x != selection->tracks.end(); ++x) {
272 atv = dynamic_cast<AudioTimeAxisView*>(*x);
276 } else if (atv->is_audio_track()) {
281 if (x == selection->tracks.end()) {
282 atv = dynamic_cast<AudioTimeAxisView*>(selection->tracks.back());
284 atv = dynamic_cast<AudioTimeAxisView*>(*x);
287 if (!atv || !atv->is_audio_track()) {
288 return boost::shared_ptr<AudioTrack>();
291 return atv->audio_track();
294 boost::shared_ptr<MidiTrack>
295 Editor::get_nth_selected_midi_track (int nth) const
297 MidiTimeAxisView* mtv;
298 TrackSelection::iterator x;
300 for (x = selection->tracks.begin(); nth > 0 && x != selection->tracks.end(); ++x) {
302 mtv = dynamic_cast<MidiTimeAxisView*>(*x);
306 } else if (mtv->is_midi_track()) {
311 if (x == selection->tracks.end()) {
312 mtv = dynamic_cast<MidiTimeAxisView*>(selection->tracks.back());
314 mtv = dynamic_cast<MidiTimeAxisView*>(*x);
317 if (!mtv || !mtv->is_midi_track()) {
318 return boost::shared_ptr<MidiTrack>();
321 return mtv->midi_track();
325 Editor::do_import (vector<string> paths, ImportDisposition chns, ImportMode mode, SrcQuality quality, framepos_t& pos)
327 boost::shared_ptr<Track> track;
328 vector<string> to_import;
330 bool use_timestamp = (pos == -1);
332 current_interthread_info = &import_status;
333 import_status.current = 1;
334 import_status.total = paths.size ();
335 import_status.all_done = false;
337 ImportProgressWindow ipw (&import_status, _("Import"), _("Cancel Import"));
341 if (chns == Editing::ImportMergeFiles) {
343 /* create 1 region from all paths, add to 1 track,
348 for (vector<string>::iterator a = paths.begin(); a != paths.end(); ++a) {
349 int check = check_whether_and_how_to_import(*a, false);
360 ok = (import_sndfiles (paths, mode, quality, pos, 1, 1, track, false) == 0);
365 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 */
396 case Editing::ImportDistinctFiles:
399 to_import.push_back (*a);
401 if (mode == Editing::ImportToTrack) {
402 track = get_nth_selected_audio_track (nth++);
405 ok = (import_sndfiles (to_import, mode, quality, pos, 1, -1, track, replace) == 0);
408 case Editing::ImportDistinctChannels:
411 to_import.push_back (*a);
413 ok = (import_sndfiles (to_import, mode, quality, pos, -1, -1, track, replace) == 0);
416 case Editing::ImportSerializeFiles:
419 to_import.push_back (*a);
421 ok = (import_sndfiles (to_import, mode, quality, pos, 1, 1, track, replace) == 0);
424 case Editing::ImportMergeFiles:
425 // Not entered, handled in earlier if() branch
432 _session->save_state ("");
435 import_status.all_done = true;
439 Editor::do_embed (vector<string> paths, ImportDisposition chns, ImportMode mode, framepos_t& pos)
441 boost::shared_ptr<Track> track;
442 bool check_sample_rate = true;
444 vector<string> to_embed;
445 bool multi = paths.size() > 1;
449 case Editing::ImportDistinctFiles:
450 for (vector<string>::iterator a = paths.begin(); a != paths.end(); ++a) {
453 to_embed.push_back (*a);
455 if (mode == Editing::ImportToTrack) {
456 track = get_nth_selected_audio_track (nth++);
459 if (embed_sndfiles (to_embed, multi, check_sample_rate, mode, pos, 1, -1, track) < -1) {
465 case Editing::ImportDistinctChannels:
466 for (vector<string>::iterator a = paths.begin(); a != paths.end(); ++a) {
469 to_embed.push_back (*a);
471 if (embed_sndfiles (to_embed, multi, check_sample_rate, mode, pos, -1, -1, track) < -1) {
477 case Editing::ImportMergeFiles:
478 if (embed_sndfiles (paths, multi, check_sample_rate, mode, pos, 1, 1, track) < -1) {
483 case Editing::ImportSerializeFiles:
484 for (vector<string>::iterator a = paths.begin(); a != paths.end(); ++a) {
487 to_embed.push_back (*a);
489 if (embed_sndfiles (to_embed, multi, check_sample_rate, mode, pos, 1, 1, track) < -1) {
500 _session->save_state ("");
505 Editor::import_sndfiles (vector<string> paths, ImportMode mode, SrcQuality quality, framepos_t& pos,
506 int target_regions, int target_tracks, boost::shared_ptr<Track>& track, bool replace)
508 import_status.paths = paths;
509 import_status.done = false;
510 import_status.cancel = false;
511 import_status.freeze = false;
512 import_status.quality = quality;
513 import_status.replace_existing_source = replace;
515 import_status.mode = mode;
516 import_status.pos = pos;
517 import_status.target_tracks = target_tracks;
518 import_status.target_regions = target_regions;
519 import_status.track = track;
520 import_status.replace = replace;
522 set_canvas_cursor (wait_cursor);
525 /* start import thread for this spec. this will ultimately call Session::import_audiofiles()
526 which, if successful, will add the files as regions to the region list. its up to us
527 (the GUI) to direct additional steps after that.
530 pthread_create_and_store ("import", &import_status.thread, _import_thread, this);
531 pthread_detach (import_status.thread);
533 while (!import_status.done && !import_status.cancel) {
534 gtk_main_iteration ();
537 import_status.done = true;
541 if (!import_status.cancel && !import_status.sources.empty()) {
542 result = add_sources (
544 import_status.sources,
547 import_status.target_regions,
548 import_status.target_tracks,
552 /* update position from results */
554 pos = import_status.pos;
557 set_canvas_cursor (current_canvas_cursor);
562 Editor::embed_sndfiles (vector<string> paths, bool multifile,
563 bool& check_sample_rate, ImportMode mode, framepos_t& pos, int target_regions, int target_tracks,
564 boost::shared_ptr<Track>& track)
566 boost::shared_ptr<AudioFileSource> source;
572 set_canvas_cursor (wait_cursor);
575 for (vector<string>::iterator p = paths.begin(); p != paths.end(); ++p) {
580 /* note that we temporarily truncated _id at the colon */
582 if (!AudioFileSource::get_soundfile_info (path, finfo, error_msg)) {
583 error << string_compose(_("Editor: cannot open file \"%1\", (%2)"), path, error_msg ) << endmsg;
587 if (check_sample_rate && (finfo.samplerate != (int) _session->frame_rate())) {
588 vector<string> choices;
591 choices.push_back (_("Cancel entire import"));
592 choices.push_back (_("Don't embed it"));
593 choices.push_back (_("Embed all without questions"));
595 Gtkmm2ext::Choice rate_choice (
597 string_compose (_("%1\nThis audiofile's sample rate doesn't match the session sample rate!"),
598 short_path (path, 40)),
602 int resx = rate_choice.run ();
605 case 0: /* stop a multi-file import */
608 case 1: /* don't embed this one */
611 case 2: /* do it, and the rest without asking */
612 check_sample_rate = false;
621 choices.push_back (_("Cancel"));
622 choices.push_back (_("Embed it anyway"));
624 Gtkmm2ext::Choice rate_choice (
626 string_compose (_("%1\nThis audiofile's sample rate doesn't match the session sample rate!"), path),
630 int resx = rate_choice.run ();
633 case 0: /* don't import */
645 set_canvas_cursor (wait_cursor);
647 for (int n = 0; n < finfo.channels; ++n) {
650 /* check if we have this thing embedded already */
652 boost::shared_ptr<Source> s;
654 if ((s = _session->source_by_path_and_channel (path, n)) == 0) {
656 source = boost::dynamic_pointer_cast<AudioFileSource> (
657 SourceFactory::createReadable (DataType::AUDIO, *_session,
659 (mode == ImportAsTapeTrack
660 ? Source::Destructive
664 source = boost::dynamic_pointer_cast<AudioFileSource> (s);
667 sources.push_back(source);
670 catch (failed_constructor& err) {
671 error << string_compose(_("could not open %1"), path) << endmsg;
675 ARDOUR_UI::instance()->flush_pending ();
679 if (sources.empty()) {
683 ret = add_sources (paths, sources, pos, mode, target_regions, target_tracks, track, true);
686 set_canvas_cursor (current_canvas_cursor);
691 Editor::add_sources (vector<string> paths, SourceList& sources, framepos_t& pos, ImportMode mode,
692 int target_regions, int target_tracks, boost::shared_ptr<Track>& track, bool /*add_channel_suffix*/)
694 vector<boost::shared_ptr<Region> > regions;
696 uint32_t input_chan = 0;
697 uint32_t output_chan = 0;
700 use_timestamp = (pos == -1);
702 // kludge (for MIDI we're abusing "channel" for "track" here)
703 if (SMFSource::safe_midi_file_extension (paths.front())) {
707 if (target_regions == 1) {
709 /* take all the sources we have and package them up as a region */
711 region_name = region_name_from_path (paths.front(), (sources.size() > 1), false);
713 /* we checked in import_sndfiles() that there were not too many */
715 while (RegionFactory::region_by_name (region_name)) {
716 region_name = bump_name_once (region_name, '.');
721 plist.add (ARDOUR::Properties::start, 0);
722 plist.add (ARDOUR::Properties::length, sources[0]->length (pos));
723 plist.add (ARDOUR::Properties::name, region_name);
724 plist.add (ARDOUR::Properties::layer, 0);
725 plist.add (ARDOUR::Properties::whole_file, true);
726 plist.add (ARDOUR::Properties::external, true);
728 boost::shared_ptr<Region> r = RegionFactory::create (sources, plist);
730 if (use_timestamp && boost::dynamic_pointer_cast<AudioRegion>(r)) {
731 boost::dynamic_pointer_cast<AudioRegion>(r)->special_set_position(sources[0]->natural_position());
734 regions.push_back (r);
737 } else if (target_regions == -1 || target_regions > 1) {
739 /* take each source and create a region for each one */
742 SourceList::iterator x;
745 for (n = 0, x = sources.begin(); x != sources.end(); ++x, ++n) {
748 just_one.push_back (*x);
750 region_name = region_name_from_path ((*x)->path(), false, false, sources.size(), n);
754 plist.add (ARDOUR::Properties::start, 0);
755 plist.add (ARDOUR::Properties::length, (*x)->length (pos));
756 plist.add (ARDOUR::Properties::name, region_name);
757 plist.add (ARDOUR::Properties::layer, 0);
758 plist.add (ARDOUR::Properties::whole_file, true);
759 plist.add (ARDOUR::Properties::external, true);
761 boost::shared_ptr<Region> r = RegionFactory::create (just_one, plist);
763 if (use_timestamp && boost::dynamic_pointer_cast<AudioRegion>(r)) {
764 boost::dynamic_pointer_cast<AudioRegion>(r)->special_set_position((*x)->natural_position());
767 regions.push_back (r);
771 if (target_regions == 1) {
772 input_chan = regions.front()->n_channels();
774 if (target_tracks == 1) {
775 input_chan = regions.size();
781 if (Config->get_output_auto_connect() & AutoConnectMaster) {
782 output_chan = (_session->master_out() ? _session->master_out()->n_inputs().n_audio() : input_chan);
784 output_chan = input_chan;
790 for (vector<boost::shared_ptr<Region> >::iterator r = regions.begin(); r != regions.end(); ++r, ++n) {
792 boost::shared_ptr<AudioRegion> ar = boost::dynamic_pointer_cast<AudioRegion> (*r);
794 if (use_timestamp && ar) {
796 /* get timestamp for this region */
798 const boost::shared_ptr<Source> s (ar->sources().front());
799 const boost::shared_ptr<AudioSource> as = boost::dynamic_pointer_cast<AudioSource> (s);
803 if (as->natural_position() != 0) {
804 pos = as->natural_position();
805 } else if (target_tracks == 1) {
806 /* hmm, no timestamp available, put it after the previous region
809 pos = get_preferred_edit_position ();
814 pos = get_preferred_edit_position ();
819 finish_bringing_in_material (*r, input_chan, output_chan, pos, mode, track);
821 rlen = (*r)->length();
823 if (target_tracks != 1) {
826 if (!use_timestamp || !ar) {
827 /* line each one up right after the other */
828 pos += (*r)->length();
833 /* setup peak file building in another thread */
835 for (SourceList::iterator x = sources.begin(); x != sources.end(); ++x) {
836 SourceFactory::setup_peakfile (*x, true);
843 Editor::finish_bringing_in_material (boost::shared_ptr<Region> region, uint32_t in_chans, uint32_t out_chans, framepos_t& pos,
844 ImportMode mode, boost::shared_ptr<Track>& existing_track)
846 boost::shared_ptr<AudioRegion> ar = boost::dynamic_pointer_cast<AudioRegion>(region);
847 boost::shared_ptr<MidiRegion> mr = boost::dynamic_pointer_cast<MidiRegion>(region);
851 /* relax, its been done */
856 if (!existing_track) {
859 existing_track = get_nth_selected_audio_track (0);
861 existing_track = get_nth_selected_midi_track (0);
864 if (!existing_track) {
869 boost::shared_ptr<Playlist> playlist = existing_track->playlist();
870 boost::shared_ptr<Region> copy (RegionFactory::create (region, region->properties()));
871 begin_reversible_command (_("insert file"));
872 playlist->clear_changes ();
873 playlist->add_region (copy, pos);
874 _session->add_command (new StatefulDiffCommand (playlist));
875 commit_reversible_command ();
881 if (!existing_track) {
883 list<boost::shared_ptr<AudioTrack> > at (_session->new_audio_track (in_chans, out_chans, Normal, 0, 1));
889 existing_track = at.front();
891 list<boost::shared_ptr<MidiTrack> > mt (_session->new_midi_track (Normal, 0, 1));
897 existing_track = mt.front();
900 existing_track->set_name (region->name());
903 boost::shared_ptr<Region> copy (RegionFactory::create (region));
904 existing_track->playlist()->add_region (copy, pos);
909 case ImportAsTapeTrack:
914 list<boost::shared_ptr<AudioTrack> > at (_session->new_audio_track (in_chans, out_chans, Destructive));
916 boost::shared_ptr<Region> copy (RegionFactory::create (region));
917 at.front()->set_name (basename_nosuffix (copy->name()));
918 at.front()->playlist()->add_region (copy, pos);
928 Editor::_import_thread (void *arg)
930 SessionEvent::create_per_thread_pool ("import events", 64);
932 Editor *ed = (Editor *) arg;
933 return ed->import_thread ();
937 Editor::import_thread ()
939 _session->import_audiofiles (import_status);
940 pthread_exit_pbd (0);