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>
28 #include <pbd/pthread_utils.h>
29 #include <pbd/basename.h>
30 #include <pbd/shortpath.h>
32 #include <gtkmm2ext/choice.h>
33 #include <gtkmm2ext/window_title.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"
62 using namespace ARDOUR;
66 using namespace Gtkmm2ext;
67 using namespace Editing;
70 /* Functions supporting the incorporation of external (non-captured) audio material into ardour */
73 Editor::add_external_audio_action (ImportMode mode_hint)
76 MessageDialog msg (0, _("You can't import or embed a file until you have a session loaded."));
82 sfbrowser = new SoundFileOmega (*this, _("Add existing media"), session, 0, true, mode_hint);
84 sfbrowser->set_mode (mode_hint);
87 external_audio_dialog ();
91 Editor::external_audio_dialog ()
93 vector<Glib::ustring> paths;
97 MessageDialog msg (0, _("You can't import or embed a file until you have a session loaded."));
104 for (TrackSelection::iterator x = selection->tracks.begin(); x != selection->tracks.end(); ++x) {
105 AudioTimeAxisView* atv = dynamic_cast<AudioTimeAxisView*>(*x);
109 } else if (atv->is_audio_track()) {
114 if (sfbrowser == 0) {
115 sfbrowser = new SoundFileOmega (*this, _("Add existing media"), session, track_cnt, true);
117 sfbrowser->reset (track_cnt);
120 sfbrowser->show_all ();
128 int response = sfbrowser->run ();
132 // leave the dialog open
140 // cancel from the browser - we are done
147 paths = sfbrowser->get_paths ();
149 ImportPosition pos = sfbrowser->get_position ();
150 ImportMode mode = sfbrowser->get_mode ();
151 ImportDisposition chns = sfbrowser->get_channel_disposition ();
155 case ImportAtEditPoint:
156 where = get_preferred_edit_position ();
158 case ImportAtTimestamp:
161 case ImportAtPlayhead:
162 where = playhead_cursor->current_frame;
165 where = session->current_start_frame();
169 SrcQuality quality = sfbrowser->get_src_quality();
172 if (sfbrowser->copy_files_btn.get_active()) {
173 do_import (paths, chns, mode, quality, where);
175 do_embed (paths, chns, mode, where);
178 if (response == RESPONSE_APPLY) {
179 sfbrowser->clear_selection ();
183 } while (keepRunning);
186 typedef std::map<PBD::ID,boost::shared_ptr<ARDOUR::Source> > SourceMap;
189 * Updating is still disabled, see note in libs/ardour/import.cc Session::import_audiofiles()
192 * true = show "Update", "Import" and "Skip"
193 * false = show "Import", and "Cancel"
196 * 0 To update an existing source of the same name
197 * 1 To import/embed the file normally (make sure the new name will be unique)
198 * 2 If the user wants to skip this file
201 Editor::check_whether_and_how_to_import(string path, bool all_or_nothing)
203 string wave_name (Glib::path_get_basename(path));
205 SourceMap all_sources = session->get_sources();
206 bool wave_name_exists = false;
208 for (SourceMap::iterator i = all_sources.begin(); i != all_sources.end(); ++i) {
209 string tmp (Glib::path_get_basename (i->second->path()));
211 if (tmp == wave_name) {
212 wave_name_exists = true;
220 if (wave_name_exists) {
222 if (all_or_nothing) {
223 // updating is still disabled
224 //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);
225 message = string_compose(_("The session already contains a source file named %1. This file will be imported as a new file, please confirm."),wave_name);
227 message = _("Lorem ipsum. Do you want to skidaddle?");
230 MessageDialog dialog(message, false,Gtk::MESSAGE_QUESTION, Gtk::BUTTONS_NONE, true);
232 if (all_or_nothing) {
234 //dialog.add_button("Update", 0);
235 dialog.add_button("Import", 1);
236 dialog.add_button("Skip", 2);
238 dialog.add_button("Import", 1);
239 dialog.add_button("Cancel", 2);
243 //dialog.add_button("Skip all", 4); // All or rest?
247 function = dialog.run ();
255 boost::shared_ptr<AudioTrack>
256 Editor::get_nth_selected_audio_track (int nth) const
258 AudioTimeAxisView* atv;
259 TrackSelection::iterator x;
261 for (x = selection->tracks.begin(); nth > 0 && x != selection->tracks.end(); ++x) {
263 atv = dynamic_cast<AudioTimeAxisView*>(*x);
267 } else if (atv->is_audio_track()) {
272 if (x == selection->tracks.end()) {
273 atv = dynamic_cast<AudioTimeAxisView*>(selection->tracks.back());
275 atv = dynamic_cast<AudioTimeAxisView*>(*x);
278 if (!atv || !atv->is_audio_track()) {
279 return boost::shared_ptr<AudioTrack>();
282 return atv->audio_track();
285 boost::shared_ptr<MidiTrack>
286 Editor::get_nth_selected_midi_track (int nth) const
288 MidiTimeAxisView* mtv;
289 TrackSelection::iterator x;
291 for (x = selection->tracks.begin(); nth > 0 && x != selection->tracks.end(); ++x) {
293 mtv = dynamic_cast<MidiTimeAxisView*>(*x);
297 } else if (mtv->is_midi_track()) {
302 if (x == selection->tracks.end()) {
303 mtv = dynamic_cast<MidiTimeAxisView*>(selection->tracks.back());
305 mtv = dynamic_cast<MidiTimeAxisView*>(*x);
308 if (!mtv || !mtv->is_midi_track()) {
309 return boost::shared_ptr<MidiTrack>();
312 return mtv->midi_track();
316 Editor::do_import (vector<ustring> paths, ImportDisposition chns, ImportMode mode, SrcQuality quality, nframes64_t& pos)
318 boost::shared_ptr<Track> track;
319 vector<ustring> to_import;
323 if (interthread_progress_window == 0) {
324 build_interthread_progress_window ();
328 if (chns == Editing::ImportMergeFiles) {
329 /* create 1 region from all paths, add to 1 track,
333 for (vector<ustring>::iterator a = paths.begin(); a != paths.end() && ok; ++a) {
334 int check = check_whether_and_how_to_import(*a, false);
342 if (import_sndfiles (paths, mode, quality, pos, 1, 1, track, false)) {
348 bool replace = false;
350 for (vector<ustring>::iterator a = paths.begin(); a != paths.end() && ok; ++a) {
352 int check = check_whether_and_how_to_import(*a, true);
360 fatal << "Updating existing sources should be disabled!" << endl;
362 } else if (check == 1) {
368 case Editing::ImportDistinctFiles:
371 to_import.push_back (*a);
373 if (mode == Editing::ImportToTrack) {
374 track = get_nth_selected_audio_track (nth++);
377 if (import_sndfiles (to_import, mode, quality, pos, 1, -1, track, replace)) {
383 case Editing::ImportDistinctChannels:
386 to_import.push_back (*a);
388 if (import_sndfiles (to_import, mode, quality, pos, -1, -1, track, replace)) {
394 case Editing::ImportSerializeFiles:
397 to_import.push_back (*a);
399 /* create 1 region from this path, add to 1 track,
400 reuse "track" across paths
403 if (import_sndfiles (to_import, mode, quality, pos, 1, 1, track, replace)) {
409 case Editing::ImportMergeFiles:
416 session->save_state ("");
419 interthread_progress_window->hide_all ();
424 Editor::idle_do_embed (vector<ustring> paths, ImportDisposition chns, ImportMode mode, nframes64_t& pos)
426 _do_embed (paths, chns, mode, pos);
431 Editor::do_embed (vector<ustring> paths, ImportDisposition chns, ImportMode mode, nframes64_t& pos)
434 Glib::signal_idle().connect (bind (mem_fun (*this, &Editor::idle_do_embed), paths, chns, mode, pos));
436 _do_embed (paths, chns, mode, pos);
441 Editor::_do_embed (vector<ustring> paths, ImportDisposition chns, ImportMode mode, nframes64_t& pos)
443 boost::shared_ptr<Track> track;
444 bool check_sample_rate = true;
446 vector<ustring> to_embed;
447 bool multi = paths.size() > 1;
451 case Editing::ImportDistinctFiles:
452 for (vector<ustring>::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<ustring>::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<ustring>::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<ustring> paths, ImportMode mode, SrcQuality quality, nframes64_t& pos,
508 int target_regions, int target_tracks, boost::shared_ptr<Track>& track, bool replace)
510 WindowTitle title = string_compose (_("importing %1"), paths.front());
512 interthread_progress_window->set_title (title.get_string());
513 interthread_progress_window->set_position (Gtk::WIN_POS_MOUSE);
514 interthread_progress_window->show_all ();
515 interthread_progress_bar.set_fraction (0.0f);
516 interthread_cancel_label.set_text (_("Cancel Import"));
517 current_interthread_info = &import_status;
519 import_status.paths = paths;
520 import_status.done = false;
521 import_status.cancel = false;
522 import_status.freeze = false;
523 import_status.done = 0.0;
524 import_status.quality = quality;
525 import_status.replace_existing_source = replace;
527 interthread_progress_connection = Glib::signal_timeout().connect
528 (bind (mem_fun(*this, &Editor::import_progress_timeout), (gpointer) 0), 100);
530 track_canvas.get_window()->set_cursor (Gdk::Cursor (Gdk::WATCH));
531 ARDOUR_UI::instance()->flush_pending ();
533 /* start import thread for this spec. this will ultimately call Session::import_audiofiles()
534 and if successful will add the file(s) as a region to the session region list.
537 pthread_create_and_store ("import", &import_status.thread, 0, _import_thread, this);
538 pthread_detach (import_status.thread);
540 while (!(import_status.done || import_status.cancel)) {
541 gtk_main_iteration ();
544 interthread_progress_window->hide ();
546 import_status.done = true;
547 interthread_progress_connection.disconnect ();
549 /* import thread finished - see if we should build a new track */
551 boost::shared_ptr<AudioRegion> r;
553 if (import_status.cancel || import_status.sources.empty()) {
557 if (add_sources (paths, import_status.sources, pos, mode, target_regions, target_tracks, track, false) == 0) {
558 session->save_state ("");
562 track_canvas.get_window()->set_cursor (*current_canvas_cursor);
567 Editor::embed_sndfiles (vector<Glib::ustring> paths, bool multifile,
568 bool& check_sample_rate, ImportMode mode, nframes64_t& pos, int target_regions, int target_tracks,
569 boost::shared_ptr<Track>& track)
571 boost::shared_ptr<AudioFileSource> source;
577 track_canvas.get_window()->set_cursor (Gdk::Cursor (Gdk::WATCH));
578 ARDOUR_UI::instance()->flush_pending ();
580 for (vector<Glib::ustring>::iterator p = paths.begin(); p != paths.end(); ++p) {
584 /* lets see if we can link it into the session */
586 sys::path tmp = session->session_directory().sound_path() / Glib::path_get_basename(path);
587 linked_path = tmp.to_string();
589 if (link (path.c_str(), linked_path.c_str()) == 0) {
591 /* there are many reasons why link(2) might have failed.
592 but if it succeeds, we now have a link in the
593 session sound dir that will protect against
594 unlinking of the original path. nice.
601 /* one possible reason is that its already linked */
603 if (errno == EEXIST) {
606 if (stat (linked_path.c_str(), &sb) == 0) {
607 if (sb.st_nlink > 1) { // its a hard link, assume its the one we want
614 /* note that we temporarily truncated _id at the colon */
618 if (!AudioFileSource::get_soundfile_info (path, finfo, error_msg)) {
619 error << string_compose(_("Editor: cannot open file \"%1\", (%2)"), path, error_msg ) << endmsg;
623 if (check_sample_rate && (finfo.samplerate != (int) session->frame_rate())) {
624 vector<string> choices;
627 choices.push_back (_("Cancel entire import"));
628 choices.push_back (_("Don't embed it"));
629 choices.push_back (_("Embed all without questions"));
631 Gtkmm2ext::Choice rate_choice (
632 string_compose (_("%1\nThis audiofile's sample rate doesn't match the session sample rate!"),
633 short_path (path, 40)),
636 int resx = rate_choice.run ();
639 case 0: /* stop a multi-file import */
642 case 1: /* don't embed this one */
645 case 2: /* do it, and the rest without asking */
646 check_sample_rate = false;
655 choices.push_back (_("Cancel"));
656 choices.push_back (_("Embed it anyway"));
658 Gtkmm2ext::Choice rate_choice (
659 string_compose (_("%1\nThis audiofile's sample rate doesn't match the session sample rate!"), path),
662 int resx = rate_choice.run ();
665 case 0: /* don't import */
677 track_canvas.get_window()->set_cursor (Gdk::Cursor (Gdk::WATCH));
679 for (int n = 0; n < finfo.channels; ++n) {
682 /* check if we have this thing embedded already */
684 boost::shared_ptr<Source> s;
686 if ((s = session->source_by_path_and_channel (path, n)) == 0) {
687 source = boost::dynamic_pointer_cast<AudioFileSource> (SourceFactory::createReadable
688 (DataType::AUDIO, *session, path, n,
689 (mode == ImportAsTapeTrack ?
690 AudioFileSource::Destructive :
691 AudioFileSource::Flag (0)),
694 source = boost::dynamic_pointer_cast<AudioFileSource> (s);
697 sources.push_back(source);
700 catch (failed_constructor& err) {
701 error << string_compose(_("could not open %1"), path) << endmsg;
705 ARDOUR_UI::instance()->flush_pending ();
709 if (sources.empty()) {
713 ret = add_sources (paths, sources, pos, mode, target_regions, target_tracks, track, true);
716 track_canvas.get_window()->set_cursor (*current_canvas_cursor);
721 Editor::add_sources (vector<Glib::ustring> paths, SourceList& sources, nframes64_t& pos, ImportMode mode,
722 int target_regions, int target_tracks, boost::shared_ptr<Track>& track, bool add_channel_suffix)
724 vector<boost::shared_ptr<Region> > regions;
726 uint32_t input_chan = 0;
727 uint32_t output_chan = 0;
729 if (pos == -1) { // "use timestamp"
730 if (sources[0]->natural_position() != 0) {
731 pos = sources[0]->natural_position();
733 pos = get_preferred_edit_position ();
737 cout << "TARGET REGIONS: " << target_regions << endl;
739 if (target_regions == 1) {
741 /* take all the sources we have and package them up as a region */
743 region_name = region_name_from_path (paths.front(), (sources.size() > 1), false);
745 regions.push_back (RegionFactory::create (sources, 0, sources[0]->length(), region_name, 0,
746 Region::Flag (Region::DefaultFlags|Region::WholeFile|Region::External)));
748 } else if (target_regions == -1) {
750 /* take each source and create a region for each one */
753 SourceList::iterator x;
756 for (n = 0, x = sources.begin(); x != sources.end(); ++x, ++n) {
759 just_one.push_back (*x);
761 region_name = region_name_from_path ((*x)->path(), false, true, sources.size(), n);
763 cout << "REGION NAME: " << region_name << endl;
764 cout << "SOURCE LENGTH: " << (*x)->length() << endl;
766 regions.push_back (RegionFactory::create (just_one, 0, (*x)->length(), region_name, 0,
767 Region::Flag (Region::DefaultFlags|Region::WholeFile|Region::External)));
772 if (target_regions == 1) {
773 input_chan = regions.front()->n_channels();
775 if (target_tracks == 1) {
776 input_chan = regions.size();
782 if (Config->get_output_auto_connect() & AutoConnectMaster) {
783 output_chan = (session->master_out() ? session->master_out()->n_inputs().n_audio() : input_chan);
785 output_chan = input_chan;
790 for (vector<boost::shared_ptr<Region> >::iterator r = regions.begin(); r != regions.end(); ++r, ++n) {
792 finish_bringing_in_material (*r, input_chan, output_chan, pos, mode, track);
794 if (target_tracks != 1) {
797 pos += (*r)->length();
801 /* setup peak file building in another thread */
803 for (SourceList::iterator x = sources.begin(); x != sources.end(); ++x) {
804 SourceFactory::setup_peakfile (*x, true);
811 Editor::finish_bringing_in_material (boost::shared_ptr<Region> region, uint32_t in_chans, uint32_t out_chans, nframes64_t& pos,
812 ImportMode mode, boost::shared_ptr<Track>& existing_track)
814 boost::shared_ptr<AudioRegion> ar = boost::dynamic_pointer_cast<AudioRegion>(region);
815 boost::shared_ptr<MidiRegion> mr = boost::dynamic_pointer_cast<MidiRegion>(region);
819 /* relax, its been done */
824 if (!existing_track) {
827 existing_track = get_nth_selected_audio_track (0);
829 existing_track = get_nth_selected_midi_track (0);
832 if (!existing_track) {
837 boost::shared_ptr<Playlist> playlist = existing_track->diskstream()->playlist();
838 boost::shared_ptr<Region> copy (RegionFactory::create (region));
839 begin_reversible_command (_("insert file"));
840 XMLNode &before = playlist->get_state();
841 playlist->add_region (copy, pos);
842 session->add_command (new MementoCommand<Playlist>(*playlist, &before, &playlist->get_state()));
843 commit_reversible_command ();
849 if (!existing_track) {
851 list<boost::shared_ptr<AudioTrack> > at (session->new_audio_track (in_chans, out_chans, Normal, 1));
857 existing_track = at.front();
859 list<boost::shared_ptr<MidiTrack> > mt (session->new_midi_track (Normal, 1));
865 existing_track = mt.front();
868 existing_track->set_name (region->name());
871 boost::shared_ptr<Region> copy (RegionFactory::create (region));
872 existing_track->diskstream()->playlist()->add_region (copy, pos);
877 case ImportAsTapeTrack:
882 list<boost::shared_ptr<AudioTrack> > at (session->new_audio_track (in_chans, out_chans, Destructive));
884 boost::shared_ptr<Region> copy (RegionFactory::create (region));
885 at.front()->set_name (basename_nosuffix (copy->name()));
886 at.front()->diskstream()->playlist()->add_region (copy, pos);
896 Editor::_import_thread (void *arg)
898 PBD::ThreadCreated (pthread_self(), X_("Import"));
900 Editor *ed = (Editor *) arg;
901 return ed->import_thread ();
905 Editor::import_thread ()
907 session->import_audiofiles (import_status);
908 pthread_exit_pbd (0);
914 Editor::import_progress_timeout (void *arg)
916 interthread_progress_label.set_text (import_status.doing_what);
918 if (import_status.freeze) {
919 interthread_cancel_button.set_sensitive(false);
921 interthread_cancel_button.set_sensitive(true);
924 if (import_status.doing_what == "building peak files") {
925 interthread_progress_bar.pulse ();
928 interthread_progress_bar.set_fraction (import_status.progress);
931 return !(import_status.done || import_status.cancel);