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 "ardour/operations.h"
52 #include "pbd/memento_command.h"
54 #include "ardour_ui.h"
58 #include "audio_time_axis.h"
59 #include "midi_time_axis.h"
60 #include "session_import_dialog.h"
62 #include "gui_thread.h"
63 #include "interthread_progress_window.h"
64 #include "mouse_cursors.h"
65 #include "editor_cursors.h"
70 using namespace ARDOUR
;
73 using namespace Gtkmm2ext
;
74 using namespace Editing
;
77 /* Functions supporting the incorporation of external (non-captured) audio material into ardour */
80 Editor::add_external_audio_action (ImportMode mode_hint
)
83 MessageDialog
msg (_("You can't import or embed an audiofile until you have a session loaded."));
89 sfbrowser
= new SoundFileOmega (*this, _("Add Existing Media"), _session
, 0, true, mode_hint
);
91 sfbrowser
->set_mode (mode_hint
);
94 external_audio_dialog ();
98 Editor::external_audio_dialog ()
100 vector
<string
> paths
;
104 MessageDialog
msg (_("You can't import or embed an audiofile until you have a session loaded."));
111 for (TrackSelection::iterator x
= selection
->tracks
.begin(); x
!= selection
->tracks
.end(); ++x
) {
112 AudioTimeAxisView
* atv
= dynamic_cast<AudioTimeAxisView
*>(*x
);
116 } else if (atv
->is_audio_track()) {
121 if (sfbrowser
== 0) {
122 sfbrowser
= new SoundFileOmega (*this, _("Add Existing Media"), _session
, track_cnt
, true);
124 sfbrowser
->reset (track_cnt
);
127 sfbrowser
->show_all ();
135 int response
= sfbrowser
->run ();
139 // leave the dialog open
147 // cancel from the browser - we are done
154 vector
<string
> upaths
= sfbrowser
->get_paths ();
155 for (vector
<string
>::iterator x
= upaths
.begin(); x
!= upaths
.end(); ++x
) {
156 paths
.push_back (*x
);
159 ImportPosition pos
= sfbrowser
->get_position ();
160 ImportMode mode
= sfbrowser
->get_mode ();
161 ImportDisposition chns
= sfbrowser
->get_channel_disposition ();
165 case ImportAtEditPoint
:
166 where
= get_preferred_edit_position ();
168 case ImportAtTimestamp
:
171 case ImportAtPlayhead
:
172 where
= playhead_cursor
->current_frame
;
175 where
= _session
->current_start_frame();
179 SrcQuality quality
= sfbrowser
->get_src_quality();
182 if (sfbrowser
->copy_files_btn
.get_active()) {
183 do_import (paths
, chns
, mode
, quality
, where
);
185 do_embed (paths
, chns
, mode
, where
);
188 if (response
== RESPONSE_APPLY
) {
189 sfbrowser
->clear_selection ();
193 } while (keepRunning
);
197 Editor::session_import_dialog ()
199 SessionImportDialog
dialog (_session
);
200 ensure_float (dialog
);
204 typedef std::map
<PBD::ID
,boost::shared_ptr
<ARDOUR::Source
> > SourceMap
;
207 * Updating is still disabled, see note in libs/ardour/import.cc Session::import_audiofiles()
210 * true = show "Update", "Import" and "Skip"
211 * false = show "Import", and "Cancel"
214 * 0 To update an existing source of the same name
215 * 1 To import/embed the file normally (make sure the new name will be unique)
216 * 2 If the user wants to skip this file
219 Editor::check_whether_and_how_to_import(string path
, bool all_or_nothing
)
221 string
wave_name (Glib::path_get_basename(path
));
223 SourceMap all_sources
= _session
->get_sources();
224 bool already_exists
= false;
227 if ((existing
= _session
->count_sources_by_origin (path
)) > 0) {
228 already_exists
= true;
233 if (already_exists
) {
235 if (all_or_nothing
) {
236 // updating is still disabled
237 //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);
238 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
);
240 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
);
243 MessageDialog
dialog(message
, false, Gtk::MESSAGE_QUESTION
, Gtk::BUTTONS_NONE
, true);
245 if (all_or_nothing
) {
247 //dialog.add_button("Update", 0);
248 dialog
.add_button("Import", 1);
249 dialog
.add_button("Skip", 2);
251 dialog
.add_button("Import", 1);
252 dialog
.add_button("Cancel", 2);
255 //dialog.add_button("Skip all", 4); // All or rest?
259 function
= dialog
.run ();
267 boost::shared_ptr
<AudioTrack
>
268 Editor::get_nth_selected_audio_track (int nth
) const
270 AudioTimeAxisView
* atv
;
271 TrackSelection::iterator x
;
273 for (x
= selection
->tracks
.begin(); nth
> 0 && x
!= selection
->tracks
.end(); ++x
) {
275 atv
= dynamic_cast<AudioTimeAxisView
*>(*x
);
279 } else if (atv
->is_audio_track()) {
284 if (x
== selection
->tracks
.end()) {
285 atv
= dynamic_cast<AudioTimeAxisView
*>(selection
->tracks
.back());
287 atv
= dynamic_cast<AudioTimeAxisView
*>(*x
);
290 if (!atv
|| !atv
->is_audio_track()) {
291 return boost::shared_ptr
<AudioTrack
>();
294 return atv
->audio_track();
297 boost::shared_ptr
<MidiTrack
>
298 Editor::get_nth_selected_midi_track (int nth
) const
300 MidiTimeAxisView
* mtv
;
301 TrackSelection::iterator x
;
303 for (x
= selection
->tracks
.begin(); nth
> 0 && x
!= selection
->tracks
.end(); ++x
) {
305 mtv
= dynamic_cast<MidiTimeAxisView
*>(*x
);
309 } else if (mtv
->is_midi_track()) {
314 if (x
== selection
->tracks
.end()) {
315 mtv
= dynamic_cast<MidiTimeAxisView
*>(selection
->tracks
.back());
317 mtv
= dynamic_cast<MidiTimeAxisView
*>(*x
);
320 if (!mtv
|| !mtv
->is_midi_track()) {
321 return boost::shared_ptr
<MidiTrack
>();
324 return mtv
->midi_track();
328 Editor::do_import (vector
<string
> paths
, ImportDisposition chns
, ImportMode mode
, SrcQuality quality
, framepos_t
& pos
)
330 boost::shared_ptr
<Track
> track
;
331 vector
<string
> to_import
;
333 bool use_timestamp
= (pos
== -1);
335 current_interthread_info
= &import_status
;
336 import_status
.current
= 1;
337 import_status
.total
= paths
.size ();
338 import_status
.all_done
= false;
340 ImportProgressWindow
ipw (&import_status
, _("Import"), _("Cancel Import"));
344 if (chns
== Editing::ImportMergeFiles
) {
346 /* create 1 region from all paths, add to 1 track,
351 for (vector
<string
>::iterator a
= paths
.begin(); a
!= paths
.end(); ++a
) {
352 int check
= check_whether_and_how_to_import(*a
, false);
363 ok
= (import_sndfiles (paths
, mode
, quality
, pos
, 1, 1, track
, false) == 0);
368 bool replace
= false;
370 for (vector
<string
>::iterator a
= paths
.begin(); a
!= paths
.end(); ++a
) {
372 const int check
= check_whether_and_how_to_import (*a
, true);
379 fatal
<< "Updating existing sources should be disabled!" << endmsg
;
386 fatal
<< "Illegal return " << check
<< " from check_whether_and_how_to_import()!" << endmsg
;
390 /* have to reset this for every file we handle */
399 case Editing::ImportDistinctFiles
:
402 to_import
.push_back (*a
);
404 if (mode
== Editing::ImportToTrack
) {
405 track
= get_nth_selected_audio_track (nth
++);
408 ok
= (import_sndfiles (to_import
, mode
, quality
, pos
, 1, -1, track
, replace
) == 0);
411 case Editing::ImportDistinctChannels
:
414 to_import
.push_back (*a
);
416 ok
= (import_sndfiles (to_import
, mode
, quality
, pos
, -1, -1, track
, replace
) == 0);
419 case Editing::ImportSerializeFiles
:
422 to_import
.push_back (*a
);
424 ok
= (import_sndfiles (to_import
, mode
, quality
, pos
, 1, 1, track
, replace
) == 0);
427 case Editing::ImportMergeFiles
:
428 // Not entered, handled in earlier if() branch
435 _session
->save_state ("");
438 import_status
.all_done
= true;
442 Editor::do_embed (vector
<string
> paths
, ImportDisposition chns
, ImportMode mode
, framepos_t
& pos
)
444 boost::shared_ptr
<Track
> track
;
445 bool check_sample_rate
= true;
447 vector
<string
> to_embed
;
448 bool multi
= paths
.size() > 1;
452 case Editing::ImportDistinctFiles
:
453 for (vector
<string
>::iterator a
= paths
.begin(); a
!= paths
.end(); ++a
) {
456 to_embed
.push_back (*a
);
458 if (mode
== Editing::ImportToTrack
) {
459 track
= get_nth_selected_audio_track (nth
++);
462 if (embed_sndfiles (to_embed
, multi
, check_sample_rate
, mode
, pos
, 1, -1, track
) < -1) {
468 case Editing::ImportDistinctChannels
:
469 for (vector
<string
>::iterator a
= paths
.begin(); a
!= paths
.end(); ++a
) {
472 to_embed
.push_back (*a
);
474 if (embed_sndfiles (to_embed
, multi
, check_sample_rate
, mode
, pos
, -1, -1, track
) < -1) {
480 case Editing::ImportMergeFiles
:
481 if (embed_sndfiles (paths
, multi
, check_sample_rate
, mode
, pos
, 1, 1, track
) < -1) {
486 case Editing::ImportSerializeFiles
:
487 for (vector
<string
>::iterator a
= paths
.begin(); a
!= paths
.end(); ++a
) {
490 to_embed
.push_back (*a
);
492 if (embed_sndfiles (to_embed
, multi
, check_sample_rate
, mode
, pos
, 1, 1, track
) < -1) {
503 _session
->save_state ("");
508 Editor::import_sndfiles (vector
<string
> paths
, ImportMode mode
, SrcQuality quality
, framepos_t
& pos
,
509 int target_regions
, int target_tracks
, boost::shared_ptr
<Track
>& track
, bool replace
)
511 import_status
.paths
= paths
;
512 import_status
.done
= false;
513 import_status
.cancel
= false;
514 import_status
.freeze
= false;
515 import_status
.quality
= quality
;
516 import_status
.replace_existing_source
= replace
;
518 import_status
.mode
= mode
;
519 import_status
.pos
= pos
;
520 import_status
.target_tracks
= target_tracks
;
521 import_status
.target_regions
= target_regions
;
522 import_status
.track
= track
;
523 import_status
.replace
= replace
;
525 set_canvas_cursor (_cursors
->wait
);
528 /* start import thread for this spec. this will ultimately call Session::import_audiofiles()
529 which, if successful, will add the files as regions to the region list. its up to us
530 (the GUI) to direct additional steps after that.
533 pthread_create_and_store ("import", &import_status
.thread
, _import_thread
, this);
534 pthread_detach (import_status
.thread
);
536 while (!import_status
.done
&& !import_status
.cancel
) {
537 gtk_main_iteration ();
540 import_status
.done
= true;
544 if (!import_status
.cancel
&& !import_status
.sources
.empty()) {
545 result
= add_sources (
547 import_status
.sources
,
550 import_status
.target_regions
,
551 import_status
.target_tracks
,
555 /* update position from results */
557 pos
= import_status
.pos
;
560 set_canvas_cursor (current_canvas_cursor
);
565 Editor::embed_sndfiles (vector
<string
> paths
, bool multifile
,
566 bool& check_sample_rate
, ImportMode mode
, framepos_t
& pos
, int target_regions
, int target_tracks
,
567 boost::shared_ptr
<Track
>& track
)
569 boost::shared_ptr
<AudioFileSource
> source
;
575 set_canvas_cursor (_cursors
->wait
);
578 for (vector
<string
>::iterator p
= paths
.begin(); p
!= paths
.end(); ++p
) {
583 /* 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 set_canvas_cursor (_cursors
->wait
);
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 set_canvas_cursor (current_canvas_cursor
);
694 Editor::add_sources (vector
<string
> paths
, SourceList
& sources
, framepos_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);
705 // kludge (for MIDI we're abusing "channel" for "track" here)
706 if (SMFSource::safe_midi_file_extension (paths
.front())) {
710 if (target_regions
== 1) {
712 /* take all the sources we have and package them up as a region */
714 region_name
= region_name_from_path (paths
.front(), (sources
.size() > 1), false);
716 /* we checked in import_sndfiles() that there were not too many */
718 while (RegionFactory::region_by_name (region_name
)) {
719 region_name
= bump_name_once (region_name
, '.');
724 plist
.add (ARDOUR::Properties::start
, 0);
725 plist
.add (ARDOUR::Properties::length
, sources
[0]->length (pos
));
726 plist
.add (ARDOUR::Properties::name
, region_name
);
727 plist
.add (ARDOUR::Properties::layer
, 0);
728 plist
.add (ARDOUR::Properties::whole_file
, true);
729 plist
.add (ARDOUR::Properties::external
, true);
731 boost::shared_ptr
<Region
> r
= RegionFactory::create (sources
, plist
);
733 if (use_timestamp
&& boost::dynamic_pointer_cast
<AudioRegion
>(r
)) {
734 boost::dynamic_pointer_cast
<AudioRegion
>(r
)->special_set_position(sources
[0]->natural_position());
737 regions
.push_back (r
);
740 } else if (target_regions
== -1 || target_regions
> 1) {
742 /* take each source and create a region for each one */
745 SourceList::iterator x
;
748 for (n
= 0, x
= sources
.begin(); x
!= sources
.end(); ++x
, ++n
) {
751 just_one
.push_back (*x
);
753 region_name
= region_name_from_path ((*x
)->path(), false, false, sources
.size(), n
);
757 plist
.add (ARDOUR::Properties::start
, 0);
758 plist
.add (ARDOUR::Properties::length
, (*x
)->length (pos
));
759 plist
.add (ARDOUR::Properties::name
, region_name
);
760 plist
.add (ARDOUR::Properties::layer
, 0);
761 plist
.add (ARDOUR::Properties::whole_file
, true);
762 plist
.add (ARDOUR::Properties::external
, true);
764 boost::shared_ptr
<Region
> r
= RegionFactory::create (just_one
, plist
);
766 if (use_timestamp
&& boost::dynamic_pointer_cast
<AudioRegion
>(r
)) {
767 boost::dynamic_pointer_cast
<AudioRegion
>(r
)->special_set_position((*x
)->natural_position());
770 regions
.push_back (r
);
774 if (target_regions
== 1) {
775 input_chan
= regions
.front()->n_channels();
777 if (target_tracks
== 1) {
778 input_chan
= regions
.size();
784 if (Config
->get_output_auto_connect() & AutoConnectMaster
) {
785 output_chan
= (_session
->master_out() ? _session
->master_out()->n_inputs().n_audio() : input_chan
);
787 output_chan
= input_chan
;
793 for (vector
<boost::shared_ptr
<Region
> >::iterator r
= regions
.begin(); r
!= regions
.end(); ++r
, ++n
) {
794 boost::shared_ptr
<AudioRegion
> ar
= boost::dynamic_pointer_cast
<AudioRegion
> (*r
);
799 /* get timestamp for this region */
801 const boost::shared_ptr
<Source
> s (ar
->sources().front());
802 const boost::shared_ptr
<AudioSource
> as
= boost::dynamic_pointer_cast
<AudioSource
> (s
);
806 if (as
->natural_position() != 0) {
807 pos
= as
->natural_position();
808 } else if (target_tracks
== 1) {
809 /* hmm, no timestamp available, put it after the previous region
812 pos
= get_preferred_edit_position ();
817 pos
= get_preferred_edit_position ();
820 /* should really get first position in MIDI file, but for now, use edit position*/
821 pos
= get_preferred_edit_position ();
826 finish_bringing_in_material (*r
, input_chan
, output_chan
, pos
, mode
, track
);
828 rlen
= (*r
)->length();
830 if (target_tracks
!= 1) {
833 if (!use_timestamp
|| !ar
) {
834 /* line each one up right after the other */
835 pos
+= (*r
)->length();
840 /* setup peak file building in another thread */
842 for (SourceList::iterator x
= sources
.begin(); x
!= sources
.end(); ++x
) {
843 SourceFactory::setup_peakfile (*x
, true);
850 Editor::finish_bringing_in_material (boost::shared_ptr
<Region
> region
, uint32_t in_chans
, uint32_t out_chans
, framepos_t
& pos
,
851 ImportMode mode
, boost::shared_ptr
<Track
>& existing_track
)
853 boost::shared_ptr
<AudioRegion
> ar
= boost::dynamic_pointer_cast
<AudioRegion
>(region
);
854 boost::shared_ptr
<MidiRegion
> mr
= boost::dynamic_pointer_cast
<MidiRegion
>(region
);
858 /* relax, its been done */
863 if (!existing_track
) {
866 existing_track
= get_nth_selected_audio_track (0);
868 existing_track
= get_nth_selected_midi_track (0);
871 if (!existing_track
) {
876 boost::shared_ptr
<Playlist
> playlist
= existing_track
->playlist();
877 boost::shared_ptr
<Region
> copy (RegionFactory::create (region
, region
->properties()));
878 begin_reversible_command (Operations::insert_file
);
879 playlist
->clear_changes ();
880 playlist
->add_region (copy
, pos
);
881 _session
->add_command (new StatefulDiffCommand (playlist
));
882 commit_reversible_command ();
888 if (!existing_track
) {
890 list
<boost::shared_ptr
<AudioTrack
> > at (_session
->new_audio_track (in_chans
, out_chans
, Normal
, 0, 1));
896 existing_track
= at
.front();
898 list
<boost::shared_ptr
<MidiTrack
> > mt (_session
->new_midi_track (Normal
, 0, 1));
904 existing_track
= mt
.front();
907 existing_track
->set_name (region
->name());
911 boost::shared_ptr
<Playlist
> playlist
= existing_track
->playlist();
912 boost::shared_ptr
<Region
> copy (RegionFactory::create (region
));
913 begin_reversible_command (Operations::insert_file
);
914 playlist
->clear_changes ();
915 playlist
->add_region (copy
, pos
);
916 _session
->add_command (new StatefulDiffCommand (playlist
));
917 commit_reversible_command ();
922 case ImportAsTapeTrack
:
928 list
<boost::shared_ptr
<AudioTrack
> > at (_session
->new_audio_track (in_chans
, out_chans
, Destructive
));
930 boost::shared_ptr
<Playlist
> playlist
= at
.front()->playlist();
931 boost::shared_ptr
<Region
> copy (RegionFactory::create (region
));
932 begin_reversible_command (Operations::insert_file
);
933 playlist
->clear_changes ();
934 playlist
->add_region (copy
, pos
);
935 _session
->add_command (new StatefulDiffCommand (playlist
));
936 commit_reversible_command ();
946 Editor::_import_thread (void *arg
)
948 SessionEvent::create_per_thread_pool ("import events", 64);
950 Editor
*ed
= (Editor
*) arg
;
951 return ed
->import_thread ();
955 Editor::import_thread ()
957 _session
->import_audiofiles (import_status
);
958 pthread_exit_pbd (0);