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>
34 #include <gtkmm2ext/window_title.h>
36 #include <ardour/session.h>
37 #include <ardour/audioplaylist.h>
38 #include <ardour/audioregion.h>
39 #include <ardour/audio_diskstream.h>
40 #include <ardour/utils.h>
41 #include <ardour/audio_track.h>
42 #include <ardour/audioplaylist.h>
43 #include <ardour/audiofilesource.h>
44 #include <ardour/region_factory.h>
45 #include <ardour/source_factory.h>
46 #include <ardour/session.h>
47 #include <pbd/memento_command.h>
49 #include "ardour_ui.h"
53 #include "audio_time_axis.h"
55 #include "gui_thread.h"
60 using namespace ARDOUR
;
64 using namespace Gtkmm2ext
;
65 using namespace Editing
;
68 /* Functions supporting the incorporation of external (non-captured) audio material into ardour */
71 Editor::add_external_audio_action (ImportMode mode_hint
)
74 MessageDialog
msg (_("You can't import or embed an audiofile until you have a session loaded."));
80 sfbrowser
= new SoundFileOmega (*this, _("Add existing audio"), session
, 0, true, mode_hint
);
82 sfbrowser
->set_mode (mode_hint
);
85 external_audio_dialog ();
89 Editor::external_audio_dialog ()
91 vector
<Glib::ustring
> paths
;
95 MessageDialog
msg (_("You can't import or embed an audiofile until you have a session loaded."));
102 for (TrackSelection::iterator x
= selection
->tracks
.begin(); x
!= selection
->tracks
.end(); ++x
) {
103 AudioTimeAxisView
* atv
= dynamic_cast<AudioTimeAxisView
*>(*x
);
107 } else if (atv
->is_audio_track()) {
112 if (sfbrowser
== 0) {
113 sfbrowser
= new SoundFileOmega (*this, _("Add existing audio"), session
, track_cnt
, true);
115 sfbrowser
->reset (track_cnt
);
118 sfbrowser
->show_all ();
126 int response
= sfbrowser
->run ();
130 // leave the dialog open
138 // cancel from the browser - we are done
145 paths
= sfbrowser
->get_paths ();
147 ImportPosition pos
= sfbrowser
->get_position ();
148 ImportMode mode
= sfbrowser
->get_mode ();
149 ImportDisposition chns
= sfbrowser
->get_channel_disposition ();
153 case ImportAtEditPoint
:
154 where
= get_preferred_edit_position ();
156 case ImportAtTimestamp
:
159 case ImportAtPlayhead
:
160 where
= playhead_cursor
->current_frame
;
163 where
= session
->current_start_frame();
167 SrcQuality quality
= sfbrowser
->get_src_quality();
170 if (sfbrowser
->copy_files_btn
.get_active()) {
171 do_import (paths
, chns
, mode
, quality
, where
);
173 do_embed (paths
, chns
, mode
, where
);
176 if (response
== RESPONSE_APPLY
) {
177 sfbrowser
->clear_selection ();
181 } while (keepRunning
);
184 typedef std::map
<PBD::ID
,boost::shared_ptr
<AudioSource
> > AudioSourceList
;
187 * Updating is still disabled, see note in libs/ardour/import.cc Session::import_audiofiles()
190 * true = show "Update", "Import" and "Skip"
191 * false = show "Import", and "Cancel"
194 * 0 To update an existing source of the same name
195 * 1 To import/embed the file normally (make sure the new name will be unique)
196 * 2 If the user wants to skip this file
199 Editor::check_whether_and_how_to_import(string path
, bool all_or_nothing
)
201 string
wave_name (Glib::path_get_basename(path
));
203 AudioSourceList all_sources
= session
->get_audio_sources();
204 bool wave_name_exists
= false;
206 for (AudioSourceList::iterator i
= all_sources
.begin(); i
!= all_sources
.end(); ++i
) {
208 boost::shared_ptr
<AudioFileSource
> afs
= boost::dynamic_pointer_cast
<AudioFileSource
>(i
->second
);
210 string
tmp (Glib::path_get_basename (afs
->path()));
212 if (tmp
== wave_name
) {
213 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
= string_compose(_("A source file %1 already exists. This operation will not update that source but import the file %2 as a new source, please confirm."), wave_name
, wave_name
);
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);
242 //dialog.add_button("Skip all", 4); // All or rest?
246 function
= dialog
.run ();
254 boost::shared_ptr
<AudioTrack
>
255 Editor::get_nth_selected_audio_track (int nth
) const
257 AudioTimeAxisView
* atv
;
258 TrackSelection::iterator x
;
260 for (x
= selection
->tracks
.begin(); nth
> 0 && x
!= selection
->tracks
.end(); ++x
) {
262 atv
= dynamic_cast<AudioTimeAxisView
*>(*x
);
266 } else if (atv
->is_audio_track()) {
271 if (x
== selection
->tracks
.end()) {
272 atv
= dynamic_cast<AudioTimeAxisView
*>(selection
->tracks
.back());
274 atv
= dynamic_cast<AudioTimeAxisView
*>(*x
);
277 if (!atv
|| !atv
->is_audio_track()) {
278 return boost::shared_ptr
<AudioTrack
>();
281 return atv
->audio_track();
285 Editor::do_import (vector
<ustring
> paths
, ImportDisposition chns
, ImportMode mode
, SrcQuality quality
, nframes64_t
& pos
)
287 boost::shared_ptr
<AudioTrack
> track
;
288 vector
<ustring
> to_import
;
291 if (interthread_progress_window
== 0) {
292 build_interthread_progress_window ();
295 if (chns
== Editing::ImportMergeFiles
) {
297 /* create 1 region from all paths, add to 1 track,
302 for (vector
<ustring
>::iterator a
= paths
.begin(); a
!= paths
.end(); ++a
) {
303 int check
= check_whether_and_how_to_import(*a
, false);
311 import_sndfiles (paths
, mode
, quality
, pos
, 1, 1, track
, false, paths
.size());
316 bool replace
= false;
318 vector
<ustring
>::size_type total
= paths
.size();
320 for (vector
<ustring
>::iterator a
= paths
.begin(); a
!= paths
.end() && ok
; ++a
) {
322 int check
= check_whether_and_how_to_import (*a
, true);
329 fatal
<< "Updating existing sources should be disabled!" << endmsg
;
336 fatal
<< "Illegal return " << check
<< " from check_whether_and_how_to_import()!" << endmsg
;
342 case Editing::ImportDistinctFiles
:
345 to_import
.push_back (*a
);
347 if (mode
== Editing::ImportToTrack
) {
348 track
= get_nth_selected_audio_track (nth
++);
351 ok
= (import_sndfiles (to_import
, mode
, quality
, pos
, 1, -1, track
, replace
, total
) == 0);
354 case Editing::ImportDistinctChannels
:
357 to_import
.push_back (*a
);
359 ok
= (import_sndfiles (to_import
, mode
, quality
, pos
, -1, -1, track
, replace
, total
) == 0);
362 case Editing::ImportSerializeFiles
:
365 to_import
.push_back (*a
);
367 ok
= (import_sndfiles (to_import
, mode
, quality
, pos
, 1, 1, track
, replace
, total
) == 0);
370 case Editing::ImportMergeFiles
:
371 // Not entered, handled in earlier if() branch
377 interthread_progress_window
->hide_all ();
381 Editor::do_embed (vector
<ustring
> paths
, ImportDisposition chns
, ImportMode mode
, nframes64_t
& pos
)
383 boost::shared_ptr
<AudioTrack
> track
;
384 bool check_sample_rate
= true;
386 vector
<ustring
> to_embed
;
387 bool multi
= paths
.size() > 1;
391 case Editing::ImportDistinctFiles
:
392 for (vector
<ustring
>::iterator a
= paths
.begin(); a
!= paths
.end(); ++a
) {
395 to_embed
.push_back (*a
);
397 if (mode
== Editing::ImportToTrack
) {
398 track
= get_nth_selected_audio_track (nth
++);
401 if (embed_sndfiles (to_embed
, multi
, check_sample_rate
, mode
, pos
, 1, -1, track
) < -1) {
407 case Editing::ImportDistinctChannels
:
408 for (vector
<ustring
>::iterator a
= paths
.begin(); a
!= paths
.end(); ++a
) {
411 to_embed
.push_back (*a
);
413 if (embed_sndfiles (to_embed
, multi
, check_sample_rate
, mode
, pos
, -1, -1, track
) < -1) {
419 case Editing::ImportMergeFiles
:
420 if (embed_sndfiles (paths
, multi
, check_sample_rate
, mode
, pos
, 1, 1, track
) < -1) {
425 case Editing::ImportSerializeFiles
:
426 for (vector
<ustring
>::iterator a
= paths
.begin(); a
!= paths
.end(); ++a
) {
429 to_embed
.push_back (*a
);
431 if (embed_sndfiles (to_embed
, multi
, check_sample_rate
, mode
, pos
, 1, 1, track
) < -1) {
442 session
->save_state ("");
447 Editor::import_sndfiles (vector
<ustring
> paths
, ImportMode mode
, SrcQuality quality
, nframes64_t
& pos
,
448 int target_regions
, int target_tracks
, boost::shared_ptr
<AudioTrack
> track
, bool replace
,
451 WindowTitle title
= string_compose (_("importing %1"), paths
.front());
453 interthread_progress_window
->set_title (title
.get_string());
454 interthread_progress_window
->set_position (Gtk::WIN_POS_MOUSE
);
455 interthread_progress_bar
.set_fraction (0.0f
);
456 interthread_cancel_label
.set_text (_("Cancel Import"));
457 current_interthread_info
= &import_status
;
459 import_status
.paths
= paths
;
460 import_status
.done
= false;
461 import_status
.cancel
= false;
462 import_status
.freeze
= false;
463 import_status
.done
= 0.0;
464 import_status
.quality
= quality
;
465 import_status
.replace_existing_source
= replace
;
466 import_status
.total
= total
;
468 import_status
.mode
= mode
;
469 import_status
.pos
= pos
;
470 import_status
.target_tracks
= target_tracks
;
471 import_status
.target_regions
= target_regions
;
472 import_status
.track
= track
;
473 import_status
.replace
= replace
;
474 interthread_progress_connection
= Glib::signal_timeout().connect
475 (bind (mem_fun(*this, &Editor::import_progress_timeout
), (gpointer
) 0), 500);
477 track_canvas
->get_window()->set_cursor (Gdk::Cursor (Gdk::WATCH
));
480 /* start import thread for this spec. this will ultimately call Session::import_audiofile()
481 which, if successful, will add the files as regions to the region list. its up to us
482 (the GUI) to direct additional steps after that.
485 pthread_create_and_store ("import", &import_status
.thread
, 0, _import_thread
, this);
486 pthread_detach (import_status
.thread
);
488 while (!import_status
.done
&& !import_status
.cancel
) {
489 gtk_main_iteration ();
492 interthread_progress_window
->hide ();
493 import_status
.done
= true;
494 interthread_progress_connection
.disconnect ();
496 if (!import_status
.cancel
&& !import_status
.sources
.empty()) {
497 if (add_sources (import_status
.paths
,
498 import_status
.sources
,
501 import_status
.target_regions
,
502 import_status
.target_tracks
,
503 import_status
.track
, false) == 0) {
504 session
->save_state ("");
507 /* update position from results */
509 pos
= import_status
.pos
;
513 track_canvas
->get_window()->set_cursor (*current_canvas_cursor
);
518 Editor::embed_sndfiles (vector
<Glib::ustring
> paths
, bool multifile
,
519 bool& check_sample_rate
, ImportMode mode
, nframes64_t
& pos
, int target_regions
, int target_tracks
,
520 boost::shared_ptr
<AudioTrack
> track
)
522 boost::shared_ptr
<AudioFileSource
> source
;
527 Glib::ustring path_to_use
;
529 track_canvas
->get_window()->set_cursor (Gdk::Cursor (Gdk::WATCH
));
532 for (vector
<Glib::ustring
>::iterator p
= paths
.begin(); p
!= paths
.end(); ++p
) {
536 /* lets see if we can link it into the session */
538 linked_path
= session
->sound_dir();
540 linked_path
+= Glib::path_get_basename (path
);
544 if (link (path
.c_str(), linked_path
.c_str()) == 0) {
546 /* there are many reasons why link(2) might have failed.
547 but if it succeeds, we now have a link in the
548 session sound dir that will protect against
549 unlinking of the original path. nice.
553 path_to_use
= Glib::path_get_basename (linked_path
);
557 /* one possible reason is that its already linked */
559 if (errno
== EEXIST
) {
562 if (stat (linked_path
.c_str(), &sb
) == 0) {
563 if (sb
.st_nlink
> 1) { // its a hard link, assume its the one we want
565 path_to_use
= Glib::path_get_basename (linked_path
);
571 /* note that we temporarily truncated _id at the colon */
575 if (!AudioFileSource::get_soundfile_info (path
, finfo
, error_msg
)) {
576 error
<< string_compose(_("Editor: cannot open file \"%1\", (%2)"), path
, error_msg
) << endmsg
;
580 if (check_sample_rate
&& (finfo
.samplerate
!= (int) session
->frame_rate())) {
581 vector
<string
> choices
;
584 choices
.push_back (_("Cancel entire import"));
585 choices
.push_back (_("Don't embed it"));
586 choices
.push_back (_("Embed all without questions"));
588 Gtkmm2ext::Choice
rate_choice (
589 string_compose (_("%1\nThis audiofile's sample rate doesn't match the session sample rate!"),
590 short_path (path
, 40)),
593 int resx
= rate_choice
.run ();
596 case 0: /* stop a multi-file import */
599 case 1: /* don't embed this one */
602 case 2: /* do it, and the rest without asking */
603 check_sample_rate
= false;
612 choices
.push_back (_("Cancel"));
613 choices
.push_back (_("Embed it anyway"));
615 Gtkmm2ext::Choice
rate_choice (
616 string_compose (_("%1\nThis audiofile's sample rate doesn't match the session sample rate!"), path
),
619 int resx
= rate_choice
.run ();
622 case 0: /* don't import */
634 track_canvas
->get_window()->set_cursor (Gdk::Cursor (Gdk::WATCH
));
636 for (int n
= 0; n
< finfo
.channels
; ++n
) {
639 /* check if we have this thing embedded already */
641 boost::shared_ptr
<Source
> s
;
643 if ((s
= session
->source_by_path_and_channel (path
, n
)) == 0) {
645 source
= boost::dynamic_pointer_cast
<AudioFileSource
> (SourceFactory::createReadable
646 (*session
, path_to_use
, n
,
647 (mode
== ImportAsTapeTrack
?
648 AudioFileSource::Destructive
:
649 AudioFileSource::Flag (0)),
652 source
= boost::dynamic_pointer_cast
<AudioFileSource
> (s
);
655 sources
.push_back(source
);
658 catch (failed_constructor
& err
) {
659 error
<< string_compose(_("could not open %1"), path
) << endmsg
;
663 ARDOUR_UI::instance()->flush_pending ();
667 if (sources
.empty()) {
671 ret
= add_sources (paths
, sources
, pos
, mode
, target_regions
, target_tracks
, track
, true);
674 track_canvas
->get_window()->set_cursor (*current_canvas_cursor
);
679 Editor::add_sources (vector
<Glib::ustring
> paths
, SourceList
& sources
, nframes64_t
& pos
, ImportMode mode
,
680 int target_regions
, int target_tracks
, boost::shared_ptr
<AudioTrack
>& track
, bool add_channel_suffix
)
682 vector
<boost::shared_ptr
<AudioRegion
> > regions
;
684 uint32_t input_chan
= 0;
685 uint32_t output_chan
= 0;
687 if (pos
== -1) { // "use timestamp"
688 if (sources
[0]->natural_position() != 0) {
689 pos
= sources
[0]->natural_position();
691 pos
= get_preferred_edit_position ();
695 if (target_regions
== 1) {
697 /* take all the sources we have and package them up as a region */
699 region_name
= region_name_from_path (paths
.front(), (sources
.size() > 1), false);
701 regions
.push_back (boost::dynamic_pointer_cast
<AudioRegion
>
702 (RegionFactory::create (sources
, 0, sources
[0]->length(), region_name
, 0,
703 Region::Flag (Region::DefaultFlags
|Region::WholeFile
|Region::External
))));
705 } else if (target_regions
== -1 || target_regions
> 1) {
707 /* take each source and create a region for each one */
710 SourceList::iterator x
;
713 for (n
= 0, x
= sources
.begin(); x
!= sources
.end(); ++x
, ++n
) {
716 just_one
.push_back (*x
);
718 boost::shared_ptr
<AudioFileSource
> afs
= boost::dynamic_pointer_cast
<AudioFileSource
> (*x
);
720 region_name
= region_name_from_path (afs
->path(), false, true, sources
.size(), n
);
722 regions
.push_back (boost::dynamic_pointer_cast
<AudioRegion
>
723 (RegionFactory::create (just_one
, 0, (*x
)->length(), region_name
, 0,
724 Region::Flag (Region::DefaultFlags
|Region::WholeFile
|Region::External
))));
729 if (target_regions
== 1) {
730 input_chan
= regions
.front()->n_channels();
732 if (target_tracks
== 1) {
733 input_chan
= regions
.size();
739 if (Config
->get_output_auto_connect() & AutoConnectMaster
) {
740 output_chan
= (session
->master_out() ? session
->master_out()->n_inputs() : input_chan
);
742 output_chan
= input_chan
;
747 for (vector
<boost::shared_ptr
<AudioRegion
> >::iterator r
= regions
.begin(); r
!= regions
.end(); ++r
, ++n
) {
749 finish_bringing_in_audio (*r
, input_chan
, output_chan
, pos
, mode
, track
);
751 if (target_tracks
!= 1) {
754 pos
+= (*r
)->length();
758 /* setup peak file building in another thread */
760 for (SourceList::iterator x
= sources
.begin(); x
!= sources
.end(); ++x
) {
761 SourceFactory::setup_peakfile (*x
, true);
768 Editor::finish_bringing_in_audio (boost::shared_ptr
<AudioRegion
> region
, uint32_t in_chans
, uint32_t out_chans
, nframes64_t
& pos
,
769 ImportMode mode
, boost::shared_ptr
<AudioTrack
>& existing_track
)
773 /* relax, its been done */
778 if (!existing_track
) {
780 existing_track
= get_nth_selected_audio_track (0);
782 if (!existing_track
) {
787 boost::shared_ptr
<Playlist
> playlist
= existing_track
->diskstream()->playlist();
788 boost::shared_ptr
<AudioRegion
> copy (boost::dynamic_pointer_cast
<AudioRegion
> (RegionFactory::create (region
)));
789 begin_reversible_command (_("insert sndfile"));
790 XMLNode
&before
= playlist
->get_state();
791 playlist
->add_region (copy
, pos
);
792 session
->add_command (new MementoCommand
<Playlist
>(*playlist
, &before
, &playlist
->get_state()));
793 commit_reversible_command ();
799 if (!existing_track
) {
800 list
<boost::shared_ptr
<AudioTrack
> > at (session
->new_audio_track (in_chans
, out_chans
, Normal
, 1));
806 existing_track
= at
.front();
807 existing_track
->set_name (region
->name(), this);
810 boost::shared_ptr
<AudioRegion
> copy (boost::dynamic_pointer_cast
<AudioRegion
> (RegionFactory::create (region
)));
811 existing_track
->diskstream()->playlist()->add_region (copy
, pos
);
816 case ImportAsTapeTrack
:
818 list
<boost::shared_ptr
<AudioTrack
> > at (session
->new_audio_track (in_chans
, out_chans
, Destructive
));
820 boost::shared_ptr
<AudioRegion
> copy (boost::dynamic_pointer_cast
<AudioRegion
> (RegionFactory::create (region
)));
821 at
.front()->set_name (basename_nosuffix (copy
->name()), this);
822 at
.front()->diskstream()->playlist()->add_region (copy
, pos
);
832 Editor::_import_thread (void *arg
)
834 PBD::notify_gui_about_thread_creation (pthread_self(), X_("Import"));
836 Editor
*ed
= (Editor
*) arg
;
837 return ed
->import_thread ();
841 Editor::import_thread ()
843 session
->import_audiofiles (import_status
);
844 pthread_exit_pbd (0);
850 Editor::import_progress_timeout (void *arg
)
854 if (!interthread_progress_window
->is_visible()) {
855 interthread_progress_window
->show_all ();
859 interthread_progress_label
.set_text (import_status
.doing_what
);
861 if (import_status
.freeze
) {
862 interthread_cancel_button
.set_sensitive(false);
864 interthread_cancel_button
.set_sensitive(true);
867 if (import_status
.doing_what
== "building peak files") {
868 interthread_progress_bar
.pulse ();
871 float val
= import_status
.progress
;
872 interthread_progress_bar
.set_fraction (min (max (0.0f
, val
), 1.0f
));
877 /* the window is now visible, speed up the updates */
879 interthread_progress_connection
.disconnect ();
880 interthread_progress_connection
= Glib::signal_timeout().connect
881 (bind (mem_fun(*this, &Editor::import_progress_timeout
), (gpointer
) 0), 100);
884 return !(import_status
.done
|| import_status
.cancel
);