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/audio_track.h"
37 #include "ardour/audiofilesource.h"
38 #include "ardour/audioregion.h"
39 #include "ardour/midi_region.h"
40 #include "ardour/midi_track.h"
41 #include "ardour/operations.h"
42 #include "ardour/region_factory.h"
43 #include "ardour/smf_source.h"
44 #include "ardour/source_factory.h"
45 #include "ardour/utils.h"
46 #include "pbd/memento_command.h"
48 #include "ardour_ui.h"
49 #include "cursor_context.h"
53 #include "audio_time_axis.h"
54 #include "midi_time_axis.h"
55 #include "session_import_dialog.h"
56 #include "gui_thread.h"
57 #include "interthread_progress_window.h"
58 #include "mouse_cursors.h"
59 #include "editor_cursors.h"
64 using namespace ARDOUR;
67 using namespace Gtkmm2ext;
68 using namespace Editing;
71 /* Functions supporting the incorporation of external (non-captured) audio material into ardour */
74 Editor::add_external_audio_action (ImportMode mode_hint)
77 MessageDialog msg (_("You can't import or embed an audiofile until you have a session loaded."));
83 sfbrowser = new SoundFileOmega (_("Add Existing Media"), _session, 0, 0, true, mode_hint);
85 sfbrowser->set_mode (mode_hint);
88 external_audio_dialog ();
92 Editor::external_audio_dialog ()
95 uint32_t audio_track_cnt;
96 uint32_t midi_track_cnt;
99 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);
111 if (atv->is_audio_track()) {
116 MidiTimeAxisView* mtv = dynamic_cast<MidiTimeAxisView*>(*x);
119 if (mtv->is_midi_track()) {
126 if (sfbrowser == 0) {
127 sfbrowser = new SoundFileOmega (_("Add Existing Media"), _session, audio_track_cnt, midi_track_cnt, true);
129 sfbrowser->reset (audio_track_cnt, midi_track_cnt);
132 sfbrowser->show_all ();
136 Editor::session_import_dialog ()
138 SessionImportDialog dialog (_session);
142 typedef std::map<PBD::ID,boost::shared_ptr<ARDOUR::Source> > SourceMap;
145 * Updating is still disabled, see note in libs/ardour/import.cc Session::import_files()
148 * true = show "Update", "Import" and "Skip"
149 * false = show "Import", and "Cancel"
152 * 0 To update an existing source of the same name
153 * 1 To import/embed the file normally (make sure the new name will be unique)
154 * 2 If the user wants to skip this file
157 Editor::check_whether_and_how_to_import(string path, bool all_or_nothing)
159 string wave_name (Glib::path_get_basename(path));
161 bool already_exists = false;
164 if ((existing = _session->count_sources_by_origin (path)) > 0) {
165 already_exists = true;
170 if (already_exists) {
172 if (all_or_nothing) {
173 // updating is still disabled
174 //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);
175 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);
177 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);
180 MessageDialog dialog(message, false, Gtk::MESSAGE_QUESTION, Gtk::BUTTONS_NONE, true);
182 if (all_or_nothing) {
184 //dialog.add_button("Update", 0);
185 dialog.add_button("Import", 1);
186 dialog.add_button("Skip", 2);
188 dialog.add_button("Import", 1);
189 dialog.add_button("Cancel", 2);
192 //dialog.add_button("Skip all", 4); // All or rest?
196 function = dialog.run ();
204 boost::shared_ptr<AudioTrack>
205 Editor::get_nth_selected_audio_track (int nth) const
207 AudioTimeAxisView* atv;
208 TrackSelection::iterator x;
210 for (x = selection->tracks.begin(); nth > 0 && x != selection->tracks.end(); ++x) {
212 atv = dynamic_cast<AudioTimeAxisView*>(*x);
216 } else if (atv->is_audio_track()) {
221 if (x == selection->tracks.end()) {
222 atv = dynamic_cast<AudioTimeAxisView*>(selection->tracks.back());
224 atv = dynamic_cast<AudioTimeAxisView*>(*x);
227 if (!atv || !atv->is_audio_track()) {
228 return boost::shared_ptr<AudioTrack>();
231 return atv->audio_track();
234 boost::shared_ptr<MidiTrack>
235 Editor::get_nth_selected_midi_track (int nth) const
237 MidiTimeAxisView* mtv;
238 TrackSelection::iterator x;
240 for (x = selection->tracks.begin(); nth > 0 && x != selection->tracks.end(); ++x) {
242 mtv = dynamic_cast<MidiTimeAxisView*>(*x);
246 } else if (mtv->is_midi_track()) {
251 if (x == selection->tracks.end()) {
252 mtv = dynamic_cast<MidiTimeAxisView*>(selection->tracks.back());
254 mtv = dynamic_cast<MidiTimeAxisView*>(*x);
257 if (!mtv || !mtv->is_midi_track()) {
258 return boost::shared_ptr<MidiTrack>();
261 return mtv->midi_track();
265 Editor::do_import (vector<string> paths,
266 ImportDisposition disposition,
269 MidiTrackNameSource midi_track_name_source,
270 MidiTempoMapDisposition smf_tempo_disposition,
272 ARDOUR::PluginInfoPtr instrument)
274 boost::shared_ptr<Track> track;
275 vector<string> to_import;
277 bool use_timestamp = (pos == -1);
279 current_interthread_info = &import_status;
280 import_status.current = 1;
281 import_status.total = paths.size ();
282 import_status.all_done = false;
283 import_status.midi_track_name_source = midi_track_name_source;
285 ImportProgressWindow ipw (&import_status, _("Import"), _("Cancel Import"));
289 if (disposition == Editing::ImportMergeFiles) {
291 /* create 1 region from all paths, add to 1 track,
296 for (vector<string>::iterator a = paths.begin(); a != paths.end(); ++a) {
297 int check = check_whether_and_how_to_import(*a, false);
308 ok = (import_sndfiles (paths, disposition, mode, quality, pos, 1, 1, track, false, instrument) == 0);
309 import_status.sources.clear();
314 bool replace = false;
316 for (vector<string>::iterator a = paths.begin(); a != paths.end(); ++a) {
318 const int check = check_whether_and_how_to_import (*a, true);
325 fatal << "Updating existing sources should be disabled!" << endmsg;
326 abort(); /* NOTREACHED*/
332 fatal << "Illegal return " << check << " from check_whether_and_how_to_import()!" << endmsg;
333 abort(); /* NOTREACHED*/
336 /* have to reset this for every file we handle */
344 switch (disposition) {
345 case Editing::ImportDistinctFiles:
348 to_import.push_back (*a);
350 if (mode == Editing::ImportToTrack) {
351 track = get_nth_selected_audio_track (nth++);
354 ok = (import_sndfiles (to_import, disposition, mode, quality, pos, 1, -1, track, replace, instrument) == 0);
355 import_status.sources.clear();
358 case Editing::ImportDistinctChannels:
361 to_import.push_back (*a);
363 ok = (import_sndfiles (to_import, disposition, mode, quality, pos, -1, -1, track, replace, instrument) == 0);
364 import_status.sources.clear();
367 case Editing::ImportSerializeFiles:
370 to_import.push_back (*a);
372 ok = (import_sndfiles (to_import, disposition, mode, quality, pos, 1, 1, track, replace, instrument) == 0);
373 import_status.sources.clear();
376 case Editing::ImportMergeFiles:
377 // Not entered, handled in earlier if() branch
384 _session->save_state ("");
387 import_status.all_done = true;
391 Editor::do_embed (vector<string> paths, ImportDisposition import_as, ImportMode mode, framepos_t& pos, ARDOUR::PluginInfoPtr instrument)
393 boost::shared_ptr<Track> track;
394 bool check_sample_rate = true;
396 vector<string> to_embed;
397 bool multi = paths.size() > 1;
399 bool use_timestamp = (pos == -1);
402 case Editing::ImportDistinctFiles:
403 for (vector<string>::iterator a = paths.begin(); a != paths.end(); ++a) {
405 /* have to reset this for every file we handle */
411 to_embed.push_back (*a);
413 if (mode == Editing::ImportToTrack) {
414 track = get_nth_selected_audio_track (nth++);
417 if (embed_sndfiles (to_embed, multi, check_sample_rate, import_as, mode, pos, 1, -1, track, instrument) < -1) {
423 case Editing::ImportDistinctChannels:
424 for (vector<string>::iterator a = paths.begin(); a != paths.end(); ++a) {
426 /* have to reset this for every file we handle */
432 to_embed.push_back (*a);
434 if (embed_sndfiles (to_embed, multi, check_sample_rate, import_as, mode, pos, -1, -1, track, instrument) < -1) {
440 case Editing::ImportMergeFiles:
441 if (embed_sndfiles (paths, multi, check_sample_rate, import_as, mode, pos, 1, 1, track, instrument) < -1) {
446 case Editing::ImportSerializeFiles:
447 for (vector<string>::iterator a = paths.begin(); a != paths.end(); ++a) {
449 /* have to reset this for every file we handle */
455 to_embed.push_back (*a);
457 if (embed_sndfiles (to_embed, multi, check_sample_rate, import_as, mode, pos, 1, 1, track, instrument) < -1) {
468 _session->save_state ("");
473 Editor::import_sndfiles (vector<string> paths,
474 ImportDisposition disposition,
480 boost::shared_ptr<Track>& track,
482 ARDOUR::PluginInfoPtr instrument)
484 import_status.paths = paths;
485 import_status.done = false;
486 import_status.cancel = false;
487 import_status.freeze = false;
488 import_status.quality = quality;
489 import_status.replace_existing_source = replace;
490 import_status.split_midi_channels = (disposition == Editing::ImportDistinctChannels);
492 import_status.mode = mode;
493 import_status.pos = pos;
494 import_status.target_tracks = target_tracks;
495 import_status.target_regions = target_regions;
496 import_status.track = track;
497 import_status.replace = replace;
499 CursorContext::Handle cursor_ctx = CursorContext::create(*this, _cursors->wait);
502 /* start import thread for this spec. this will ultimately call Session::import_files()
503 which, if successful, will add the files as regions to the region list. its up to us
504 (the GUI) to direct additional steps after that.
507 pthread_create_and_store ("import", &import_status.thread, _import_thread, this);
508 pthread_detach (import_status.thread);
510 while (!import_status.done && !import_status.cancel) {
511 gtk_main_iteration ();
514 // wait for thread to terminate
515 while (!import_status.done) {
516 gtk_main_iteration ();
521 if (!import_status.cancel && !import_status.sources.empty()) {
522 result = add_sources (
524 import_status.sources,
528 import_status.target_regions,
529 import_status.target_tracks,
530 track, false, instrument
533 /* update position from results */
535 pos = import_status.pos;
542 Editor::embed_sndfiles (vector<string> paths,
544 bool& check_sample_rate,
545 ImportDisposition disposition,
550 boost::shared_ptr<Track>& track,
551 ARDOUR::PluginInfoPtr instrument)
553 boost::shared_ptr<AudioFileSource> source;
558 CursorContext::Handle cursor_ctx = CursorContext::create(*this, _cursors->wait);
561 for (vector<string>::iterator p = paths.begin(); p != paths.end(); ++p) {
566 /* note that we temporarily truncated _id at the colon */
568 if (!AudioFileSource::get_soundfile_info (path, finfo, error_msg)) {
569 error << string_compose(_("Editor: cannot open file \"%1\", (%2)"), path, error_msg ) << endmsg;
573 if (check_sample_rate && (finfo.samplerate != (int) _session->frame_rate())) {
574 vector<string> choices;
577 choices.push_back (_("Cancel entire import"));
578 choices.push_back (_("Don't embed it"));
579 choices.push_back (_("Embed all without questions"));
581 Gtkmm2ext::Choice rate_choice (
583 string_compose (_("%1\nThis audiofile's sample rate doesn't match the session sample rate!"),
584 short_path (path, 40)),
588 int resx = rate_choice.run ();
591 case 0: /* stop a multi-file import */
593 case 1: /* don't embed this one */
595 case 2: /* do it, and the rest without asking */
596 check_sample_rate = false;
604 choices.push_back (_("Cancel"));
605 choices.push_back (_("Embed it anyway"));
607 Gtkmm2ext::Choice rate_choice (
609 string_compose (_("%1\nThis audiofile's sample rate doesn't match the session sample rate!"), path),
613 int resx = rate_choice.run ();
616 case 0: /* don't import */
626 for (int n = 0; n < finfo.channels; ++n) {
630 /* check if we have this thing embedded already */
632 boost::shared_ptr<Source> s;
634 if ((s = _session->audio_source_by_path_and_channel (path, n)) == 0) {
636 source = boost::dynamic_pointer_cast<AudioFileSource> (
637 SourceFactory::createExternal (DataType::AUDIO, *_session,
639 (mode == ImportAsTapeTrack
640 ? Source::Destructive
644 source = boost::dynamic_pointer_cast<AudioFileSource> (s);
647 sources.push_back(source);
650 catch (failed_constructor& err) {
651 error << string_compose(_("could not open %1"), path) << endmsg;
655 gtk_main_iteration();
659 if (!sources.empty()) {
660 return add_sources (paths, sources, pos, disposition, mode, target_regions, target_tracks, track, true, instrument);
667 Editor::add_sources (vector<string> paths,
670 ImportDisposition disposition,
674 boost::shared_ptr<Track>& track,
675 bool /*add_channel_suffix*/,
676 ARDOUR::PluginInfoPtr instrument)
678 vector<boost::shared_ptr<Region> > regions;
680 uint32_t input_chan = 0;
681 uint32_t output_chan = 0;
683 vector<string> track_names;
685 use_timestamp = (pos == -1);
687 // kludge (for MIDI we're abusing "channel" for "track" here)
688 if (SMFSource::safe_midi_file_extension (paths.front())) {
692 if (target_regions == 1) {
694 /* take all the sources we have and package them up as a region */
696 region_name = region_name_from_path (paths.front(), (sources.size() > 1), false);
698 /* we checked in import_sndfiles() that there were not too many */
700 while (RegionFactory::region_by_name (region_name)) {
701 region_name = bump_name_once (region_name, '.');
706 plist.add (ARDOUR::Properties::start, 0);
707 plist.add (ARDOUR::Properties::length, sources[0]->length (pos));
708 plist.add (ARDOUR::Properties::name, region_name);
709 plist.add (ARDOUR::Properties::layer, 0);
710 plist.add (ARDOUR::Properties::whole_file, true);
711 plist.add (ARDOUR::Properties::external, true);
713 boost::shared_ptr<Region> r = RegionFactory::create (sources, plist);
715 if (use_timestamp && boost::dynamic_pointer_cast<AudioRegion>(r)) {
716 boost::dynamic_pointer_cast<AudioRegion>(r)->special_set_position(sources[0]->natural_position());
719 regions.push_back (r);
721 /* if we're creating a new track, name it after the cleaned-up
722 * and "merged" region name.
725 track_names.push_back (region_name);
727 } else if (target_regions == -1 || target_regions > 1) {
729 /* take each source and create a region for each one */
732 SourceList::iterator x;
735 for (n = 0, x = sources.begin(); x != sources.end(); ++x, ++n) {
738 just_one.push_back (*x);
740 boost::shared_ptr<FileSource> fs = boost::dynamic_pointer_cast<FileSource> (*x);
742 if (sources.size() > 1 && disposition == ImportDistinctChannels) {
744 /* generate a per-channel region name so that things work as
751 region_name = basename_nosuffix (fs->path());
753 region_name = (*x)->name();
756 if (sources.size() == 2) {
762 } else if (sources.size() > 2) {
763 region_name += string_compose ("-%1", n+1);
766 track_names.push_back (region_name);
770 region_name = region_name_from_path (fs->path(), false, false, sources.size(), n);
772 region_name = (*x)->name();
775 if (SMFSource::safe_midi_file_extension (paths.front())) {
776 string track_name = string_compose ("%1-t%2", PBD::basename_nosuffix (fs->path()), (n + 1));
777 track_names.push_back (track_name);
779 track_names.push_back (PBD::basename_nosuffix (paths[n]));
785 /* Fudge region length to ensure it is non-zero; make it 1 beat at 120bpm
786 for want of a better idea. It can't be too small, otherwise if this
787 is a MIDI region the conversion from frames -> beats -> frames will
788 round it back down to 0 again.
790 framecnt_t len = (*x)->length (pos);
792 len = (60.0 / 120.0) * _session->frame_rate ();
795 plist.add (ARDOUR::Properties::start, 0);
796 plist.add (ARDOUR::Properties::length, len);
797 plist.add (ARDOUR::Properties::name, region_name);
798 plist.add (ARDOUR::Properties::layer, 0);
799 plist.add (ARDOUR::Properties::whole_file, true);
800 plist.add (ARDOUR::Properties::external, true);
802 boost::shared_ptr<Region> r = RegionFactory::create (just_one, plist);
804 if (use_timestamp && boost::dynamic_pointer_cast<AudioRegion>(r)) {
805 boost::dynamic_pointer_cast<AudioRegion>(r)->special_set_position((*x)->natural_position());
808 regions.push_back (r);
812 if (target_regions == 1) {
813 input_chan = regions.front()->n_channels();
815 if (target_tracks == 1) {
816 input_chan = regions.size();
822 if (Config->get_output_auto_connect() & AutoConnectMaster) {
823 output_chan = (_session->master_out() ? _session->master_out()->n_inputs().n_audio() : input_chan);
825 output_chan = input_chan;
831 begin_reversible_command (Operations::insert_file);
833 /* we only use tracks names when importing to new tracks, but we
834 * require that one is defined for every region, just to keep
837 assert (regions.size() == track_names.size());
839 for (vector<boost::shared_ptr<Region> >::iterator r = regions.begin(); r != regions.end(); ++r, ++n) {
840 boost::shared_ptr<AudioRegion> ar = boost::dynamic_pointer_cast<AudioRegion> (*r);
845 /* get timestamp for this region */
847 const boost::shared_ptr<Source> s (ar->sources().front());
848 const boost::shared_ptr<AudioSource> as = boost::dynamic_pointer_cast<AudioSource> (s);
852 if (as->natural_position() != 0) {
853 pos = as->natural_position();
854 } else if (target_tracks == 1) {
855 /* hmm, no timestamp available, put it after the previous region
858 pos = get_preferred_edit_position ();
863 pos = get_preferred_edit_position ();
866 /* should really get first position in MIDI file, but for now, use edit position*/
867 pos = get_preferred_edit_position ();
871 finish_bringing_in_material (*r, input_chan, output_chan, pos, mode, track, track_names[n], instrument);
873 rlen = (*r)->length();
875 if (target_tracks != 1) {
878 if (!use_timestamp || !ar) {
879 /* line each one up right after the other */
880 pos += (*r)->length();
885 commit_reversible_command ();
887 /* setup peak file building in another thread */
889 for (SourceList::iterator x = sources.begin(); x != sources.end(); ++x) {
890 SourceFactory::setup_peakfile (*x, true);
897 Editor::finish_bringing_in_material (boost::shared_ptr<Region> region,
902 boost::shared_ptr<Track>& existing_track,
903 const string& new_track_name,
904 ARDOUR::PluginInfoPtr instrument)
906 boost::shared_ptr<AudioRegion> ar = boost::dynamic_pointer_cast<AudioRegion>(region);
907 boost::shared_ptr<MidiRegion> mr = boost::dynamic_pointer_cast<MidiRegion>(region);
911 /* relax, its been done */
916 if (!existing_track) {
919 existing_track = get_nth_selected_audio_track (0);
921 existing_track = get_nth_selected_midi_track (0);
924 if (!existing_track) {
929 boost::shared_ptr<Playlist> playlist = existing_track->playlist();
930 boost::shared_ptr<Region> copy (RegionFactory::create (region, region->properties()));
931 playlist->clear_changes ();
932 playlist->add_region (copy, pos);
933 if (Config->get_edit_mode() == Ripple)
934 playlist->ripple (pos, copy->length(), copy);
936 _session->add_command (new StatefulDiffCommand (playlist));
942 if (!existing_track) {
944 list<boost::shared_ptr<AudioTrack> > at (_session->new_audio_track (in_chans, out_chans, 0, 1, string(), PresentationInfo::max_order, Normal));
949 if (Config->get_strict_io ()) {
950 for (list<boost::shared_ptr<AudioTrack> >::iterator i = at.begin(); i != at.end(); ++i) {
951 (*i)->set_strict_io (true);
955 existing_track = at.front();
957 list<boost::shared_ptr<MidiTrack> > mt (
958 _session->new_midi_track (ChanCount (DataType::MIDI, 1),
959 ChanCount (DataType::MIDI, 1),
960 instrument, (Plugin::PresetRecord*) 0,
964 PresentationInfo::max_order));
969 if (Config->get_strict_io ()) {
970 for (list<boost::shared_ptr<MidiTrack> >::iterator i = mt.begin(); i != mt.end(); ++i) {
971 (*i)->set_strict_io (true);
975 // TODO set strict_io from preferences
976 existing_track = mt.front();
979 if (!new_track_name.empty()) {
980 existing_track->set_name (new_track_name);
982 existing_track->set_name (region->name());
986 boost::shared_ptr<Playlist> playlist = existing_track->playlist();
987 boost::shared_ptr<Region> copy (RegionFactory::create (region, true));
988 playlist->clear_changes ();
989 playlist->add_region (copy, pos);
990 _session->add_command (new StatefulDiffCommand (playlist));
994 case ImportAsTapeTrack:
1000 list<boost::shared_ptr<AudioTrack> > at (_session->new_audio_track (in_chans, out_chans, 0, 1, string(), PresentationInfo::max_order, Destructive));
1002 boost::shared_ptr<Playlist> playlist = at.front()->playlist();
1003 boost::shared_ptr<Region> copy (RegionFactory::create (region, true));
1004 playlist->clear_changes ();
1005 playlist->add_region (copy, pos);
1006 _session->add_command (new StatefulDiffCommand (playlist));
1008 if (Config->get_strict_io ()) {
1009 for (list<boost::shared_ptr<AudioTrack> >::iterator i = at.begin(); i != at.end(); ++i) {
1010 (*i)->set_strict_io (true);
1021 Editor::_import_thread (void *arg)
1023 SessionEvent::create_per_thread_pool ("import events", 64);
1025 Editor *ed = (Editor *) arg;
1026 return ed->import_thread ();
1030 Editor::import_thread ()
1032 _session->import_files (import_status);