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"
33 #include <gtkmm2ext/choice.h>
35 #include "ardour/session.h"
36 #include "ardour/session_directory.h"
37 #include "ardour/audioplaylist.h"
38 #include "ardour/audioregion.h"
39 #include "ardour/audio_diskstream.h"
40 #include "ardour/midi_track.h"
41 #include "ardour/midi_region.h"
42 #include "ardour/utils.h"
43 #include "ardour/audio_track.h"
44 #include "ardour/audioplaylist.h"
45 #include "ardour/audiofilesource.h"
46 #include "ardour/region_factory.h"
47 #include "ardour/source_factory.h"
48 #include "ardour/session.h"
49 #include "pbd/memento_command.h"
51 #include "ardour_ui.h"
55 #include "audio_time_axis.h"
56 #include "midi_time_axis.h"
57 #include "session_import_dialog.h"
59 #include "gui_thread.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 (*this, _("Add Existing Media"), _session, 0, true, mode_hint);
85 sfbrowser->set_mode (mode_hint);
88 external_audio_dialog ();
92 Editor::external_audio_dialog ()
94 vector<Glib::ustring> paths;
98 MessageDialog msg (_("You can't import or embed an audiofile until you have a session loaded."));
105 for (TrackSelection::iterator x = selection->tracks.begin(); x != selection->tracks.end(); ++x) {
106 AudioTimeAxisView* atv = dynamic_cast<AudioTimeAxisView*>(*x);
110 } else if (atv->is_audio_track()) {
115 if (sfbrowser == 0) {
116 sfbrowser = new SoundFileOmega (*this, _("Add Existing Media"), _session, track_cnt, true);
118 sfbrowser->reset (track_cnt);
121 sfbrowser->show_all ();
129 int response = sfbrowser->run ();
133 // leave the dialog open
141 // cancel from the browser - we are done
148 paths = sfbrowser->get_paths ();
150 ImportPosition pos = sfbrowser->get_position ();
151 ImportMode mode = sfbrowser->get_mode ();
152 ImportDisposition chns = sfbrowser->get_channel_disposition ();
156 case ImportAtEditPoint:
157 where = get_preferred_edit_position ();
159 case ImportAtTimestamp:
162 case ImportAtPlayhead:
163 where = playhead_cursor->current_frame;
166 where = _session->current_start_frame();
170 SrcQuality quality = sfbrowser->get_src_quality();
173 if (sfbrowser->copy_files_btn.get_active()) {
174 do_import (paths, chns, mode, quality, where);
176 do_embed (paths, chns, mode, where);
179 if (response == RESPONSE_APPLY) {
180 sfbrowser->clear_selection ();
184 } while (keepRunning);
188 Editor::session_import_dialog ()
190 SessionImportDialog dialog (_session);
191 ensure_float (dialog);
195 typedef std::map<PBD::ID,boost::shared_ptr<ARDOUR::Source> > SourceMap;
198 * Updating is still disabled, see note in libs/ardour/import.cc Session::import_audiofiles()
201 * true = show "Update", "Import" and "Skip"
202 * false = show "Import", and "Cancel"
205 * 0 To update an existing source of the same name
206 * 1 To import/embed the file normally (make sure the new name will be unique)
207 * 2 If the user wants to skip this file
210 Editor::check_whether_and_how_to_import(string path, bool all_or_nothing)
212 string wave_name (Glib::path_get_basename(path));
214 SourceMap all_sources = _session->get_sources();
215 bool wave_name_exists = false;
217 for (SourceMap::iterator i = all_sources.begin(); i != all_sources.end(); ++i) {
218 string tmp (Glib::path_get_basename (i->second->path()));
219 if (tmp == wave_name) {
220 wave_name_exists = true;
227 if (wave_name_exists) {
229 if (all_or_nothing) {
230 // updating is still disabled
231 //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);
232 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);
234 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);
237 MessageDialog dialog(message, false, Gtk::MESSAGE_QUESTION, Gtk::BUTTONS_NONE, true);
239 if (all_or_nothing) {
241 //dialog.add_button("Update", 0);
242 dialog.add_button("Import", 1);
243 dialog.add_button("Skip", 2);
245 dialog.add_button("Import", 1);
246 dialog.add_button("Cancel", 2);
249 //dialog.add_button("Skip all", 4); // All or rest?
253 function = dialog.run ();
261 boost::shared_ptr<AudioTrack>
262 Editor::get_nth_selected_audio_track (int nth) const
264 AudioTimeAxisView* atv;
265 TrackSelection::iterator x;
267 for (x = selection->tracks.begin(); nth > 0 && x != selection->tracks.end(); ++x) {
269 atv = dynamic_cast<AudioTimeAxisView*>(*x);
273 } else if (atv->is_audio_track()) {
278 if (x == selection->tracks.end()) {
279 atv = dynamic_cast<AudioTimeAxisView*>(selection->tracks.back());
281 atv = dynamic_cast<AudioTimeAxisView*>(*x);
284 if (!atv || !atv->is_audio_track()) {
285 return boost::shared_ptr<AudioTrack>();
288 return atv->audio_track();
291 boost::shared_ptr<MidiTrack>
292 Editor::get_nth_selected_midi_track (int nth) const
294 MidiTimeAxisView* mtv;
295 TrackSelection::iterator x;
297 for (x = selection->tracks.begin(); nth > 0 && x != selection->tracks.end(); ++x) {
299 mtv = dynamic_cast<MidiTimeAxisView*>(*x);
303 } else if (mtv->is_midi_track()) {
308 if (x == selection->tracks.end()) {
309 mtv = dynamic_cast<MidiTimeAxisView*>(selection->tracks.back());
311 mtv = dynamic_cast<MidiTimeAxisView*>(*x);
314 if (!mtv || !mtv->is_midi_track()) {
315 return boost::shared_ptr<MidiTrack>();
318 return mtv->midi_track();
322 Editor::do_import (vector<ustring> paths, ImportDisposition chns, ImportMode mode, SrcQuality quality, nframes64_t& pos)
324 boost::shared_ptr<Track> track;
325 vector<ustring> to_import;
328 if (interthread_progress_window == 0) {
329 build_interthread_progress_window ();
332 if (chns == Editing::ImportMergeFiles) {
334 /* create 1 region from all paths, add to 1 track,
339 for (vector<ustring>::iterator a = paths.begin(); a != paths.end(); ++a) {
340 int check = check_whether_and_how_to_import(*a, false);
348 import_sndfiles (paths, mode, quality, pos, 1, 1, track, false, paths.size());
353 for (vector<ustring>::iterator a = paths.begin(); a != paths.end(); ++a) {
355 int const check = check_whether_and_how_to_import (*a, true);
358 to_import.push_back (*a);
365 case Editing::ImportDistinctFiles:
367 if (mode == Editing::ImportToTrack) {
368 track = get_nth_selected_audio_track (nth++);
371 ok = (import_sndfiles (to_import, mode, quality, pos, 1, -1, track, false, to_import.size()) == 0);
374 case Editing::ImportDistinctChannels:
375 ok = (import_sndfiles (to_import, mode, quality, pos, -1, -1, track, false, to_import.size()) == 0);
378 case Editing::ImportSerializeFiles:
379 ok = (import_sndfiles (to_import, mode, quality, pos, 1, 1, track, false, to_import.size()) == 0);
382 case Editing::ImportMergeFiles:
383 // Not entered, handled in earlier if() branch
388 interthread_progress_window->hide_all ();
392 Editor::do_embed (vector<ustring> paths, ImportDisposition chns, ImportMode mode, nframes64_t& pos)
394 boost::shared_ptr<Track> track;
395 bool check_sample_rate = true;
397 vector<ustring> to_embed;
398 bool multi = paths.size() > 1;
402 case Editing::ImportDistinctFiles:
403 for (vector<ustring>::iterator a = paths.begin(); a != paths.end(); ++a) {
406 to_embed.push_back (*a);
408 if (mode == Editing::ImportToTrack) {
409 track = get_nth_selected_audio_track (nth++);
412 if (embed_sndfiles (to_embed, multi, check_sample_rate, mode, pos, 1, -1, track) < -1) {
418 case Editing::ImportDistinctChannels:
419 for (vector<ustring>::iterator a = paths.begin(); a != paths.end(); ++a) {
422 to_embed.push_back (*a);
424 if (embed_sndfiles (to_embed, multi, check_sample_rate, mode, pos, -1, -1, track) < -1) {
430 case Editing::ImportMergeFiles:
431 if (embed_sndfiles (paths, multi, check_sample_rate, mode, pos, 1, 1, track) < -1) {
436 case Editing::ImportSerializeFiles:
437 for (vector<ustring>::iterator a = paths.begin(); a != paths.end(); ++a) {
440 to_embed.push_back (*a);
442 if (embed_sndfiles (to_embed, multi, check_sample_rate, mode, pos, 1, 1, track) < -1) {
453 _session->save_state ("");
458 Editor::import_sndfiles (vector<ustring> paths, ImportMode mode, SrcQuality quality, nframes64_t& pos,
459 int target_regions, int target_tracks, boost::shared_ptr<Track> track, bool replace, uint32_t total)
461 interthread_progress_window->set_title (string_compose (_("Importing %1"), paths.front()));
462 interthread_progress_window->set_position (Gtk::WIN_POS_MOUSE);
463 interthread_progress_bar.set_fraction (0.0f);
464 interthread_cancel_label.set_text (_("Cancel Import"));
465 current_interthread_info = &import_status;
467 import_status.paths = paths;
468 import_status.done = false;
469 import_status.cancel = false;
470 import_status.freeze = false;
471 import_status.done = 0.0;
472 import_status.quality = quality;
473 import_status.replace_existing_source = replace;
474 import_status.total = total;
476 import_status.mode = mode;
477 import_status.pos = pos;
478 import_status.target_tracks = target_tracks;
479 import_status.target_regions = target_regions;
480 import_status.track = track;
481 import_status.replace = replace;
482 interthread_progress_connection = Glib::signal_timeout().connect
483 (sigc::bind (sigc::mem_fun(*this, &Editor::import_progress_timeout), (gpointer) 0), 500);
485 track_canvas->get_window()->set_cursor (Gdk::Cursor (Gdk::WATCH));
488 /* start import thread for this spec. this will ultimately call Session::import_audiofiles()
489 which, if successful, will add the files as regions to the region list. its up to us
490 (the GUI) to direct additional steps after that.
493 pthread_create_and_store ("import", &import_status.thread, _import_thread, this);
494 pthread_detach (import_status.thread);
496 while (!import_status.done && !import_status.cancel) {
497 gtk_main_iteration ();
500 interthread_progress_window->hide ();
501 import_status.done = true;
502 interthread_progress_connection.disconnect ();
504 if (!import_status.cancel && !import_status.sources.empty()) {
505 if (add_sources (import_status.paths,
506 import_status.sources,
509 import_status.target_regions,
510 import_status.target_tracks,
511 import_status.track, false) == 0) {
512 _session->save_state ("");
515 /* update position from results */
517 pos = import_status.pos;
521 track_canvas->get_window()->set_cursor (*current_canvas_cursor);
526 Editor::embed_sndfiles (vector<Glib::ustring> paths, bool multifile,
527 bool& check_sample_rate, ImportMode mode, nframes64_t& pos, int target_regions, int target_tracks,
528 boost::shared_ptr<Track>& track)
530 boost::shared_ptr<AudioFileSource> source;
535 Glib::ustring path_to_use;
537 track_canvas->get_window()->set_cursor (Gdk::Cursor (Gdk::WATCH));
540 for (vector<Glib::ustring>::iterator p = paths.begin(); p != paths.end(); ++p) {
544 if (Config->get_try_link_for_embed()) {
546 /* lets see if we can link it into the session */
548 sys::path tmp = _session->session_directory().sound_path() / Glib::path_get_basename(path);
549 linked_path = tmp.to_string();
551 path_to_use = linked_path;
553 if (link (path.c_str(), linked_path.c_str()) == 0) {
555 /* there are many reasons why link(2) might have failed.
556 but if it succeeds, we now have a link in the
557 session sound dir that will protect against
558 unlinking of the original path. nice.
562 path_to_use = Glib::path_get_basename (path);
566 /* one possible reason is that its already linked */
568 if (errno == EEXIST) {
571 if (stat (linked_path.c_str(), &sb) == 0) {
572 if (sb.st_nlink > 1) { // its a hard link, assume its the one we want
574 path_to_use = Glib::path_get_basename (path);
581 /* note that we temporarily truncated _id at the colon */
585 if (!AudioFileSource::get_soundfile_info (path, finfo, error_msg)) {
586 error << string_compose(_("Editor: cannot open file \"%1\", (%2)"), path, error_msg ) << endmsg;
590 if (check_sample_rate && (finfo.samplerate != (int) _session->frame_rate())) {
591 vector<string> choices;
594 choices.push_back (_("Cancel entire import"));
595 choices.push_back (_("Don't embed it"));
596 choices.push_back (_("Embed all without questions"));
598 Gtkmm2ext::Choice rate_choice (
600 string_compose (_("%1\nThis audiofile's sample rate doesn't match the session sample rate!"),
601 short_path (path, 40)),
605 int resx = rate_choice.run ();
608 case 0: /* stop a multi-file import */
611 case 1: /* don't embed this one */
614 case 2: /* do it, and the rest without asking */
615 check_sample_rate = false;
624 choices.push_back (_("Cancel"));
625 choices.push_back (_("Embed it anyway"));
627 Gtkmm2ext::Choice rate_choice (
629 string_compose (_("%1\nThis audiofile's sample rate doesn't match the session sample rate!"), path),
633 int resx = rate_choice.run ();
636 case 0: /* don't import */
648 track_canvas->get_window()->set_cursor (Gdk::Cursor (Gdk::WATCH));
650 for (int n = 0; n < finfo.channels; ++n) {
653 /* check if we have this thing embedded already */
655 boost::shared_ptr<Source> s;
657 if ((s = _session->source_by_path_and_channel (path, n)) == 0) {
659 source = boost::dynamic_pointer_cast<AudioFileSource> (
660 SourceFactory::createReadable (DataType::AUDIO, *_session,
662 (mode == ImportAsTapeTrack
663 ? Source::Destructive
667 source = boost::dynamic_pointer_cast<AudioFileSource> (s);
670 sources.push_back(source);
673 catch (failed_constructor& err) {
674 error << string_compose(_("could not open %1"), path) << endmsg;
678 ARDOUR_UI::instance()->flush_pending ();
682 if (sources.empty()) {
686 ret = add_sources (paths, sources, pos, mode, target_regions, target_tracks, track, true);
689 track_canvas->get_window()->set_cursor (*current_canvas_cursor);
694 Editor::add_sources (vector<Glib::ustring> paths, SourceList& sources, nframes64_t& pos, ImportMode mode,
695 int target_regions, int target_tracks, boost::shared_ptr<Track>& track, bool /*add_channel_suffix*/)
697 vector<boost::shared_ptr<Region> > regions;
699 uint32_t input_chan = 0;
700 uint32_t output_chan = 0;
703 use_timestamp = (pos == -1);
706 if (sources[0]->natural_position() != 0) {
707 pos = sources[0]->natural_position();
709 pos = get_preferred_edit_position ();
713 // kludge (for MIDI we're abusing "channel" for "track" here)
714 if (paths.front().rfind(".mid") != Glib::ustring::npos)
717 if (target_regions == 1) {
719 /* take all the sources we have and package them up as a region */
721 region_name = region_name_from_path (paths.front(), (sources.size() > 1), false);
723 boost::shared_ptr<Region> r = RegionFactory::create (sources, 0, sources[0]->length(pos), region_name, 0,
724 Region::Flag (Region::DefaultFlags|Region::WholeFile|Region::External));
726 if (use_timestamp && boost::dynamic_pointer_cast<AudioRegion>(r)) {
727 boost::dynamic_pointer_cast<AudioRegion>(r)->special_set_position(sources[0]->natural_position());
730 regions.push_back (r);
733 } else if (target_regions == -1 || target_regions > 1) {
735 /* take each source and create a region for each one */
738 SourceList::iterator x;
741 for (n = 0, x = sources.begin(); x != sources.end(); ++x, ++n) {
744 just_one.push_back (*x);
746 region_name = region_name_from_path ((*x)->path(), false, false, sources.size(), n);
748 boost::shared_ptr<Region> r = RegionFactory::create (just_one, 0, (*x)->length(pos), region_name, 0,
749 Region::Flag (Region::DefaultFlags|Region::WholeFile|Region::External));
751 if (use_timestamp && boost::dynamic_pointer_cast<AudioRegion>(r)) {
752 boost::dynamic_pointer_cast<AudioRegion>(r)->special_set_position((*x)->natural_position());
755 regions.push_back (r);
759 if (target_regions == 1) {
760 input_chan = regions.front()->n_channels();
762 if (target_tracks == 1) {
763 input_chan = regions.size();
769 if (Config->get_output_auto_connect() & AutoConnectMaster) {
770 output_chan = (_session->master_out() ? _session->master_out()->n_inputs().n_audio() : input_chan);
772 output_chan = input_chan;
777 for (vector<boost::shared_ptr<Region> >::iterator r = regions.begin(); r != regions.end(); ++r, ++n) {
779 finish_bringing_in_material (*r, input_chan, output_chan, pos, mode, track);
781 if (target_tracks != 1) {
784 pos += (*r)->length();
788 /* setup peak file building in another thread */
790 for (SourceList::iterator x = sources.begin(); x != sources.end(); ++x) {
791 SourceFactory::setup_peakfile (*x, true);
798 Editor::finish_bringing_in_material (boost::shared_ptr<Region> region, uint32_t in_chans, uint32_t out_chans, nframes64_t& pos,
799 ImportMode mode, boost::shared_ptr<Track>& existing_track)
801 boost::shared_ptr<AudioRegion> ar = boost::dynamic_pointer_cast<AudioRegion>(region);
802 boost::shared_ptr<MidiRegion> mr = boost::dynamic_pointer_cast<MidiRegion>(region);
806 /* relax, its been done */
811 if (!existing_track) {
814 existing_track = get_nth_selected_audio_track (0);
816 existing_track = get_nth_selected_midi_track (0);
819 if (!existing_track) {
824 boost::shared_ptr<Playlist> playlist = existing_track->diskstream()->playlist();
825 boost::shared_ptr<Region> copy (RegionFactory::create (region));
826 begin_reversible_command (_("insert file"));
827 XMLNode &before = playlist->get_state();
828 playlist->add_region (copy, pos);
829 _session->add_command (new MementoCommand<Playlist>(*playlist, &before, &playlist->get_state()));
830 commit_reversible_command ();
836 if (!existing_track) {
838 list<boost::shared_ptr<AudioTrack> > at (_session->new_audio_track (in_chans, out_chans, Normal, 0, 1));
844 existing_track = at.front();
846 list<boost::shared_ptr<MidiTrack> > mt (_session->new_midi_track (Normal, 0, 1));
852 existing_track = mt.front();
855 existing_track->set_name (region->name());
858 boost::shared_ptr<Region> copy (RegionFactory::create (region));
859 existing_track->diskstream()->playlist()->add_region (copy, pos);
864 case ImportAsTapeTrack:
869 list<boost::shared_ptr<AudioTrack> > at (_session->new_audio_track (in_chans, out_chans, Destructive));
871 boost::shared_ptr<Region> copy (RegionFactory::create (region));
872 at.front()->set_name (basename_nosuffix (copy->name()));
873 at.front()->diskstream()->playlist()->add_region (copy, pos);
883 Editor::_import_thread (void *arg)
885 SessionEvent::create_per_thread_pool ("import events", 64);
887 Editor *ed = (Editor *) arg;
888 return ed->import_thread ();
892 Editor::import_thread ()
894 _session->import_audiofiles (import_status);
895 pthread_exit_pbd (0);
901 Editor::import_progress_timeout (void */*arg*/)
905 if (!interthread_progress_window->is_visible()) {
906 interthread_progress_window->show_all ();
910 interthread_progress_label.set_text (import_status.doing_what);
912 if (import_status.freeze) {
913 interthread_cancel_button.set_sensitive(false);
915 interthread_cancel_button.set_sensitive(true);
918 if (import_status.doing_what == "building peak files") {
919 interthread_progress_bar.pulse ();
922 float val = import_status.progress;
923 interthread_progress_bar.set_fraction (min (max (0.0f, val), 1.0f));
928 /* the window is now visible, speed up the updates */
930 interthread_progress_connection.disconnect ();
931 interthread_progress_connection = Glib::signal_timeout().connect
932 (sigc::bind (sigc::mem_fun(*this, &Editor::import_progress_timeout), (gpointer) 0), 100);
935 return !(import_status.done || import_status.cancel);