2 Copyright (C) 1999-2010 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.
26 #include <cstdio> /* sprintf(3) ... grrr */
32 #include <glibmm/threads.h>
33 #include <glibmm/miscutils.h>
34 #include <glibmm/fileutils.h>
36 #include <boost/algorithm/string/erase.hpp>
38 #include "pbd/basename.h"
39 #include "pbd/convert.h"
40 #include "pbd/convert.h"
41 #include "pbd/error.h"
42 #include "pbd/file_utils.h"
44 #include "pbd/pthread_utils.h"
45 #include "pbd/search_path.h"
46 #include "pbd/stacktrace.h"
47 #include "pbd/stl_delete.h"
48 #include "pbd/replace_all.h"
49 #include "pbd/unwind.h"
51 #include "ardour/amp.h"
52 #include "ardour/analyser.h"
53 #include "ardour/async_midi_port.h"
54 #include "ardour/audio_buffer.h"
55 #include "ardour/audio_diskstream.h"
56 #include "ardour/audio_port.h"
57 #include "ardour/audio_track.h"
58 #include "ardour/audioengine.h"
59 #include "ardour/audiofilesource.h"
60 #include "ardour/auditioner.h"
61 #include "ardour/boost_debug.h"
62 #include "ardour/buffer_manager.h"
63 #include "ardour/buffer_set.h"
64 #include "ardour/bundle.h"
65 #include "ardour/butler.h"
66 #include "ardour/click.h"
67 #include "ardour/control_protocol_manager.h"
68 #include "ardour/data_type.h"
69 #include "ardour/debug.h"
70 #include "ardour/directory_names.h"
71 #ifdef USE_TRACKS_CODE_FEATURES
72 #include "ardour/engine_state_controller.h"
74 #include "ardour/filename_extensions.h"
75 #include "ardour/gain_control.h"
76 #include "ardour/graph.h"
77 #include "ardour/luabindings.h"
78 #include "ardour/midiport_manager.h"
79 #include "ardour/scene_changer.h"
80 #include "ardour/midi_patch_manager.h"
81 #include "ardour/midi_track.h"
82 #include "ardour/midi_ui.h"
83 #include "ardour/operations.h"
84 #include "ardour/playlist.h"
85 #include "ardour/plugin.h"
86 #include "ardour/plugin_insert.h"
87 #include "ardour/process_thread.h"
88 #include "ardour/profile.h"
89 #include "ardour/rc_configuration.h"
90 #include "ardour/recent_sessions.h"
91 #include "ardour/region.h"
92 #include "ardour/region_factory.h"
93 #include "ardour/route_graph.h"
94 #include "ardour/route_group.h"
95 #include "ardour/route_sorters.h"
96 #include "ardour/send.h"
97 #include "ardour/session.h"
98 #include "ardour/session_directory.h"
99 #include "ardour/session_playlists.h"
100 #include "ardour/smf_source.h"
101 #include "ardour/source_factory.h"
102 #include "ardour/speakers.h"
103 #include "ardour/tempo.h"
104 #include "ardour/ticker.h"
105 #include "ardour/track.h"
106 #include "ardour/user_bundle.h"
107 #include "ardour/utils.h"
109 #include "midi++/port.h"
110 #include "midi++/mmc.h"
112 #include "LuaBridge/LuaBridge.h"
116 #include <glibmm/checksum.h>
125 using namespace ARDOUR;
128 bool Session::_disable_all_loaded_plugins = false;
129 bool Session::_bypass_all_loaded_plugins = false;
130 guint Session::_name_id_counter = 0;
132 PBD::Signal1<int,uint32_t> Session::AudioEngineSetupRequired;
133 PBD::Signal1<void,std::string> Session::Dialog;
134 PBD::Signal0<int> Session::AskAboutPendingState;
135 PBD::Signal2<int, framecnt_t, framecnt_t> Session::AskAboutSampleRateMismatch;
136 PBD::Signal2<void, framecnt_t, framecnt_t> Session::NotifyAboutSampleRateMismatch;
137 PBD::Signal0<void> Session::SendFeedback;
138 PBD::Signal3<int,Session*,std::string,DataType> Session::MissingFile;
140 PBD::Signal1<void, framepos_t> Session::StartTimeChanged;
141 PBD::Signal1<void, framepos_t> Session::EndTimeChanged;
142 PBD::Signal2<void,std::string, std::string> Session::Exported;
143 PBD::Signal1<int,boost::shared_ptr<Playlist> > Session::AskAboutPlaylistDeletion;
144 PBD::Signal0<void> Session::Quit;
145 PBD::Signal0<void> Session::FeedbackDetected;
146 PBD::Signal0<void> Session::SuccessfulGraphSort;
147 PBD::Signal2<void,std::string,std::string> Session::VersionMismatch;
149 const framecnt_t Session::bounce_chunk_size = 8192;
150 static void clean_up_session_event (SessionEvent* ev) { delete ev; }
151 const SessionEvent::RTeventCallback Session::rt_cleanup (clean_up_session_event);
153 // seconds should be added after the region exceeds end marker
154 #ifdef USE_TRACKS_CODE_FEATURES
155 const uint32_t Session::session_end_shift = 5;
157 const uint32_t Session::session_end_shift = 0;
160 /** @param snapshot_name Snapshot name, without .ardour suffix */
161 Session::Session (AudioEngine &eng,
162 const string& fullpath,
163 const string& snapshot_name,
164 BusProfile* bus_profile,
166 : playlists (new SessionPlaylists)
168 , process_function (&Session::process_with_events)
169 , _bounce_processing_active (false)
170 , waiting_for_sync_offset (false)
171 , _base_frame_rate (0)
172 , _nominal_frame_rate (0)
173 , _current_frame_rate (0)
174 , transport_sub_state (0)
175 , _record_status (Disabled)
176 , _transport_frame (0)
177 , _session_range_location (0)
180 , _transport_speed (0)
181 , _default_transport_speed (1.0)
182 , _last_transport_speed (0)
183 , _target_transport_speed (0.0)
184 , auto_play_legal (false)
185 , _last_slave_transport_frame (0)
186 , maximum_output_latency (0)
187 , _requested_return_frame (-1)
188 , current_block_size (0)
189 , _worst_output_latency (0)
190 , _worst_input_latency (0)
191 , _worst_track_latency (0)
192 , _have_captured (false)
193 , _non_soloed_outs_muted (false)
196 , _solo_isolated_cnt (0)
198 , _was_seamless (Config->get_seamless_loop ())
199 , _under_nsm_control (false)
201 , delta_accumulator_cnt (0)
202 , average_slave_delta (1800) // !!! why 1800 ???
204 , have_first_delta_accumulator (false)
205 , _slave_state (Stopped)
206 , _mtc_active (false)
207 , _ltc_active (false)
208 , post_export_sync (false)
209 , post_export_position (0)
211 , _export_rolling (false)
212 , _export_preroll (0)
213 , _pre_export_mmc_enabled (false)
214 , _name (snapshot_name)
216 , _send_qf_mtc (false)
217 , _pframes_since_last_mtc (0)
218 , session_midi_feedback (0)
220 , loop_changing (false)
222 , _session_dir (new SessionDirectory (fullpath))
223 , _current_snapshot_name (snapshot_name)
225 , state_was_pending (false)
226 , _state_of_the_state (StateOfTheState(CannotSave|InitialConnecting|Loading))
228 , _save_queued (false)
229 , _last_roll_location (0)
230 , _last_roll_or_reversal_location (0)
231 , _last_record_location (0)
232 , pending_locate_roll (false)
233 , pending_locate_frame (0)
234 , pending_locate_flush (false)
235 , pending_abort (false)
236 , pending_auto_loop (false)
237 , _mempool ("Session", 1048576)
238 , lua (lua_newstate (&PBD::ReallocPool::lalloc, &_mempool))
240 , _butler (new Butler (*this))
241 , _post_transport_work (0)
242 , cumulative_rf_motion (0)
244 , _locations (new Locations (*this))
245 , _ignore_skips_updates (false)
246 , _rt_thread_active (false)
247 , _rt_emit_pending (false)
248 , _ac_thread_active (false)
250 , outbound_mtc_timecode_frame (0)
251 , next_quarter_frame_to_send (-1)
252 , _frames_per_timecode_frame (0)
253 , _frames_per_hour (0)
254 , _timecode_frames_per_hour (0)
255 , last_timecode_valid (false)
256 , last_timecode_when (0)
257 , _send_timecode_update (false)
269 , ltc_timecode_offset (0)
270 , ltc_timecode_negative_offset (false)
271 , midi_control_ui (0)
273 , _all_route_group (new RouteGroup (*this, "all"))
274 , routes (new RouteList)
275 , _adding_routes_in_progress (false)
276 , _reconnecting_routes_in_progress (false)
277 , _route_deletion_in_progress (false)
278 , destructive_index (0)
279 , _track_number_decimals(1)
280 , default_fade_steepness (0)
281 , default_fade_msecs (0)
282 , _total_free_4k_blocks (0)
283 , _total_free_4k_blocks_uncertain (false)
284 , no_questions_about_missing_files (false)
287 , _bundles (new BundleList)
288 , _bundle_xml_node (0)
292 , click_emphasis_data (0)
294 , click_emphasis_length (0)
295 , _clicks_cleared (0)
296 , _play_range (false)
297 , _range_selection (-1,-1)
298 , _object_selection (-1,-1)
300 , first_file_data_format_reset (true)
301 , first_file_header_format_reset (true)
302 , have_looped (false)
303 , _have_rec_enabled_track (false)
304 , _have_rec_disabled_track (true)
306 , _suspend_timecode_transmission (0)
307 , _speakers (new Speakers)
309 , ignore_route_processor_changes (false)
317 pthread_mutex_init (&_rt_emit_mutex, 0);
318 pthread_cond_init (&_rt_emit_cond, 0);
320 pthread_mutex_init (&_auto_connect_mutex, 0);
321 pthread_cond_init (&_auto_connect_cond, 0);
323 init_name_id_counter (1); // reset for new sessions, start at 1
325 pre_engine_init (fullpath);
331 Stateful::loading_state_version = CURRENT_SESSION_FILE_VERSION;
333 #ifdef USE_TRACKS_CODE_FEATURES
334 sr = EngineStateController::instance()->get_current_sample_rate();
336 if (ensure_engine (sr, true)) {
338 throw SessionException (_("Cannot connect to audio/midi engine"));
341 // set samplerate for plugins added early
342 // e.g from templates or MB channelstrip
343 set_block_size (_engine.samples_per_cycle());
344 set_frame_rate (_engine.sample_rate());
346 if (create (mix_template, bus_profile)) {
348 throw SessionException (_("Session initialization failed"));
351 /* if a mix template was provided, then ::create() will
352 * have copied it into the session and we need to load it
353 * so that we have the state ready for ::set_state()
354 * after the engine is started.
356 * Note that we do NOT try to get the sample rate from
357 * the template at this time, though doing so would
358 * be easy if we decided this was an appropriate part
362 if (!mix_template.empty()) {
363 if (load_state (_current_snapshot_name)) {
364 throw SessionException (_("Failed to load template/snapshot state"));
366 store_recent_templates (mix_template);
369 /* load default session properties - if any */
374 if (load_state (_current_snapshot_name)) {
375 throw SessionException (_("Failed to load state"));
378 /* try to get sample rate from XML state so that we
379 * can influence the SR if we set up the audio
384 XMLProperty const * prop;
385 XMLNode const * root (state_tree->root());
386 if ((prop = root->property (X_("sample-rate"))) != 0) {
387 sr = atoi (prop->value());
391 if (ensure_engine (sr, false)) {
393 throw SessionException (_("Cannot connect to audio/midi engine"));
397 if (post_engine_init ()) {
399 throw SessionException (_("Cannot configure audio/midi engine with session parameters"));
402 store_recent_sessions (_name, _path);
404 bool was_dirty = dirty();
406 _state_of_the_state = StateOfTheState (_state_of_the_state & ~Dirty);
408 Config->ParameterChanged.connect_same_thread (*this, boost::bind (&Session::config_changed, this, _1, false));
409 config.ParameterChanged.connect_same_thread (*this, boost::bind (&Session::config_changed, this, _1, true));
412 DirtyChanged (); /* EMIT SIGNAL */
415 StartTimeChanged.connect_same_thread (*this, boost::bind (&Session::start_time_changed, this, _1));
416 EndTimeChanged.connect_same_thread (*this, boost::bind (&Session::end_time_changed, this, _1));
418 emit_thread_start ();
419 auto_connect_thread_start ();
421 /* hook us up to the engine since we are now completely constructed */
423 BootMessage (_("Connect to engine"));
425 _engine.set_session (this);
426 _engine.reset_timebase ();
428 #ifdef USE_TRACKS_CODE_FEATURES
430 EngineStateController::instance()->set_session(this);
433 if ( ARDOUR::Profile->get_trx () ) {
435 /* Waves Tracks: fill session with tracks basing on the amount of inputs.
436 * each available input must have corresponding track when session starts.
439 uint32_t how_many (0);
441 std::vector<std::string> inputs;
442 EngineStateController::instance()->get_physical_audio_inputs(inputs);
444 how_many = inputs.size();
446 list<boost::shared_ptr<AudioTrack> > tracks;
448 // Track names after driver
449 if (Config->get_tracks_auto_naming() == NameAfterDriver) {
450 string track_name = "";
451 for (std::vector<string>::size_type i = 0; i < inputs.size(); ++i) {
453 track_name = inputs[i];
454 replace_all (track_name, "system:capture", "");
456 list<boost::shared_ptr<AudioTrack> > single_track = new_audio_track (1, 1, Normal, 0, 1, track_name);
457 tracks.insert(tracks.begin(), single_track.front());
459 } else { // Default track names
460 tracks = new_audio_track (1, 1, Normal, 0, how_many, string());
463 if (tracks.size() != how_many) {
465 throw failed_constructor ();
474 BootMessage (_("Session loading complete"));
486 Session::next_name_id ()
488 return g_atomic_int_add (&_name_id_counter, 1);
492 Session::name_id_counter ()
494 return g_atomic_int_get (&_name_id_counter);
498 Session::init_name_id_counter (guint n)
500 g_atomic_int_set (&_name_id_counter, n);
504 Session::ensure_engine (uint32_t desired_sample_rate, bool isnew)
506 if (_engine.current_backend() == 0) {
507 /* backend is unknown ... */
508 boost::optional<int> r = AudioEngineSetupRequired (desired_sample_rate);
509 if (r.get_value_or (-1) != 0) {
512 } else if (!isnew && _engine.running() && _engine.sample_rate () == desired_sample_rate) {
514 } else if (_engine.setup_required()) {
515 /* backend is known, but setup is needed */
516 boost::optional<int> r = AudioEngineSetupRequired (desired_sample_rate);
517 if (r.get_value_or (-1) != 0) {
520 } else if (!_engine.running()) {
521 if (_engine.start()) {
526 /* at this point the engine should be running */
528 if (!_engine.running()) {
532 return immediately_post_engine ();
537 Session::immediately_post_engine ()
539 /* Do various initializations that should take place directly after we
540 * know that the engine is running, but before we either create a
541 * session or set state for an existing one.
544 if (how_many_dsp_threads () > 1) {
545 /* For now, only create the graph if we are using >1 DSP threads, as
546 it is a bit slower than the old code with 1 thread.
548 _process_graph.reset (new Graph (*this));
551 /* every time we reconnect, recompute worst case output latencies */
553 _engine.Running.connect_same_thread (*this, boost::bind (&Session::initialize_latencies, this));
555 if (synced_to_engine()) {
556 _engine.transport_stop ();
559 if (config.get_jack_time_master()) {
560 _engine.transport_locate (_transport_frame);
565 BootMessage (_("Set up LTC"));
567 BootMessage (_("Set up Click"));
569 BootMessage (_("Set up standard connections"));
573 catch (failed_constructor& err) {
577 /* TODO, connect in different thread. (PortRegisteredOrUnregistered may be in RT context)
579 _engine.PortRegisteredOrUnregistered.connect_same_thread (*this, boost::bind (&Session::setup_bundles, this));
587 vector<void*> debug_pointers;
589 /* if we got to here, leaving pending capture state around
593 remove_pending_capture_state ();
597 _state_of_the_state = StateOfTheState (CannotSave|Deletion);
599 /* stop autoconnecting */
600 auto_connect_thread_terminate ();
602 /* disconnect from any and all signals that we are connected to */
604 Port::PortSignalDrop (); /* EMIT SIGNAL */
607 /* shutdown control surface protocols while we still have ports
608 and the engine to move data to any devices.
611 ControlProtocolManager::instance().drop_protocols ();
613 MIDI::Name::MidiPatchManager::instance().remove_search_path(session_directory().midi_patch_path());
615 _engine.remove_session ();
617 #ifdef USE_TRACKS_CODE_FEATURES
618 EngineStateController::instance()->remove_session();
621 /* deregister all ports - there will be no process or any other
622 * callbacks from the engine any more.
625 Port::PortDrop (); /* EMIT SIGNAL */
629 /* clear history so that no references to objects are held any more */
633 /* clear state tree so that no references to objects are held any more */
638 // unregister all lua functions, drop held references (if any)
640 lua.do_command ("Session = nil");
648 lua.collect_garbage ();
650 /* reset dynamic state version back to default */
651 Stateful::loading_state_version = 0;
653 _butler->drop_references ();
657 delete _all_route_group;
659 DEBUG_TRACE (DEBUG::Destruction, "delete route groups\n");
660 for (list<RouteGroup *>::iterator i = _route_groups.begin(); i != _route_groups.end(); ++i) {
664 if (click_data != default_click) {
665 delete [] click_data;
668 if (click_emphasis_data != default_click_emphasis) {
669 delete [] click_emphasis_data;
674 /* need to remove auditioner before monitoring section
675 * otherwise it is re-connected */
678 /* drop references to routes held by the monitoring section
679 * specifically _monitor_out aux/listen references */
680 remove_monitor_section();
682 /* clear out any pending dead wood from RCU managed objects */
687 AudioDiskstream::free_working_buffers();
689 /* tell everyone who is still standing that we're about to die */
692 /* tell everyone to drop references and delete objects as we go */
694 DEBUG_TRACE (DEBUG::Destruction, "delete regions\n");
695 RegionFactory::delete_all_regions ();
697 DEBUG_TRACE (DEBUG::Destruction, "delete routes\n");
699 /* reset these three references to special routes before we do the usual route delete thing */
701 _master_out.reset ();
702 _monitor_out.reset ();
705 RCUWriter<RouteList> writer (routes);
706 boost::shared_ptr<RouteList> r = writer.get_copy ();
708 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
709 DEBUG_TRACE(DEBUG::Destruction, string_compose ("Dropping for route %1 ; pre-ref = %2\n", (*i)->name(), (*i).use_count()));
710 (*i)->drop_references ();
714 /* writer goes out of scope and updates master */
719 DEBUG_TRACE (DEBUG::Destruction, "delete sources\n");
720 Glib::Threads::Mutex::Lock lm (source_lock);
721 for (SourceMap::iterator i = sources.begin(); i != sources.end(); ++i) {
722 DEBUG_TRACE(DEBUG::Destruction, string_compose ("Dropping for source %1 ; pre-ref = %2\n", i->second->name(), i->second.use_count()));
723 i->second->drop_references ();
729 /* not strictly necessary, but doing it here allows the shared_ptr debugging to work */
732 emit_thread_terminate ();
734 pthread_cond_destroy (&_rt_emit_cond);
735 pthread_mutex_destroy (&_rt_emit_mutex);
737 pthread_cond_destroy (&_auto_connect_cond);
738 pthread_mutex_destroy (&_auto_connect_mutex);
740 delete _scene_changer; _scene_changer = 0;
741 delete midi_control_ui; midi_control_ui = 0;
743 delete _mmc; _mmc = 0;
744 delete _midi_ports; _midi_ports = 0;
745 delete _locations; _locations = 0;
750 /* clear event queue, the session is gone, nobody is interested in
751 * those anymore, but they do leak memory if not removed
753 while (!immediate_events.empty ()) {
754 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
755 SessionEvent *ev = immediate_events.front ();
756 DEBUG_TRACE (DEBUG::SessionEvents, string_compose ("Drop event: %1\n", enum_2_string (ev->type)));
757 immediate_events.pop_front ();
761 case SessionEvent::AutoLoop:
762 case SessionEvent::AutoLoopDeclick:
763 case SessionEvent::Skip:
764 case SessionEvent::PunchIn:
765 case SessionEvent::PunchOut:
766 case SessionEvent::StopOnce:
767 case SessionEvent::RangeStop:
768 case SessionEvent::RangeLocate:
772 case SessionEvent::RealTimeOperation:
779 del = del && !_remove_event (ev);
786 DEBUG_TRACE (DEBUG::Destruction, "Session::destroy() done\n");
788 BOOST_SHOW_POINTERS ();
792 Session::setup_ltc ()
796 _ltc_input.reset (new IO (*this, X_("LTC In"), IO::Input));
797 _ltc_output.reset (new IO (*this, X_("LTC Out"), IO::Output));
799 if (state_tree && (child = find_named_node (*state_tree->root(), X_("LTC In"))) != 0) {
800 _ltc_input->set_state (*(child->children().front()), Stateful::loading_state_version);
803 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
804 _ltc_input->ensure_io (ChanCount (DataType::AUDIO, 1), true, this);
806 reconnect_ltc_input ();
809 if (state_tree && (child = find_named_node (*state_tree->root(), X_("LTC Out"))) != 0) {
810 _ltc_output->set_state (*(child->children().front()), Stateful::loading_state_version);
813 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
814 _ltc_output->ensure_io (ChanCount (DataType::AUDIO, 1), true, this);
816 reconnect_ltc_output ();
819 /* fix up names of LTC ports because we don't want the normal
820 * IO style of NAME/TYPE-{in,out}N
823 _ltc_input->nth (0)->set_name (X_("LTC-in"));
824 _ltc_output->nth (0)->set_name (X_("LTC-out"));
828 Session::setup_click ()
832 boost::shared_ptr<AutomationList> gl (new AutomationList (Evoral::Parameter (GainAutomation)));
833 boost::shared_ptr<GainControl> gain_control = boost::shared_ptr<GainControl> (new GainControl (*this, Evoral::Parameter(GainAutomation), gl));
835 _click_io.reset (new ClickIO (*this, X_("Click")));
836 _click_gain.reset (new Amp (*this, _("Fader"), gain_control, true));
837 _click_gain->activate ();
839 setup_click_state (state_tree->root());
841 setup_click_state (0);
846 Session::setup_click_state (const XMLNode* node)
848 const XMLNode* child = 0;
850 if (node && (child = find_named_node (*node, "Click")) != 0) {
852 /* existing state for Click */
855 if (Stateful::loading_state_version < 3000) {
856 c = _click_io->set_state_2X (*child->children().front(), Stateful::loading_state_version, false);
858 const XMLNodeList& children (child->children());
859 XMLNodeList::const_iterator i = children.begin();
860 if ((c = _click_io->set_state (**i, Stateful::loading_state_version)) == 0) {
862 if (i != children.end()) {
863 c = _click_gain->set_state (**i, Stateful::loading_state_version);
869 _clicking = Config->get_clicking ();
873 error << _("could not setup Click I/O") << endmsg;
880 /* default state for Click: dual-mono to first 2 physical outputs */
883 _engine.get_physical_outputs (DataType::AUDIO, outs);
885 for (uint32_t physport = 0; physport < 2; ++physport) {
886 if (outs.size() > physport) {
887 if (_click_io->add_port (outs[physport], this)) {
888 // relax, even though its an error
893 if (_click_io->n_ports () > ChanCount::ZERO) {
894 _clicking = Config->get_clicking ();
900 Session::setup_bundles ()
904 RCUWriter<BundleList> writer (_bundles);
905 boost::shared_ptr<BundleList> b = writer.get_copy ();
906 for (BundleList::iterator i = b->begin(); i != b->end();) {
907 if (boost::dynamic_pointer_cast<UserBundle>(*i)) {
915 vector<string> inputs[DataType::num_types];
916 vector<string> outputs[DataType::num_types];
917 for (uint32_t i = 0; i < DataType::num_types; ++i) {
918 _engine.get_physical_inputs (DataType (DataType::Symbol (i)), inputs[i]);
919 _engine.get_physical_outputs (DataType (DataType::Symbol (i)), outputs[i]);
922 /* Create a set of Bundle objects that map
923 to the physical I/O currently available. We create both
924 mono and stereo bundles, so that the common cases of mono
925 and stereo tracks get bundles to put in their mixer strip
926 in / out menus. There may be a nicer way of achieving that;
927 it doesn't really scale that well to higher channel counts
930 /* mono output bundles */
932 for (uint32_t np = 0; np < outputs[DataType::AUDIO].size(); ++np) {
934 std::string pn = _engine.get_pretty_name_by_name (outputs[DataType::AUDIO][np]);
936 snprintf (buf, sizeof (buf), _("out %s"), pn.c_str());
938 snprintf (buf, sizeof (buf), _("out %" PRIu32), np+1);
941 boost::shared_ptr<Bundle> c (new Bundle (buf, true));
942 c->add_channel (_("mono"), DataType::AUDIO);
943 c->set_port (0, outputs[DataType::AUDIO][np]);
945 add_bundle (c, false);
948 /* stereo output bundles */
950 for (uint32_t np = 0; np < outputs[DataType::AUDIO].size(); np += 2) {
951 if (np + 1 < outputs[DataType::AUDIO].size()) {
953 snprintf (buf, sizeof(buf), _("out %" PRIu32 "+%" PRIu32), np + 1, np + 2);
954 boost::shared_ptr<Bundle> c (new Bundle (buf, true));
955 c->add_channel (_("L"), DataType::AUDIO);
956 c->set_port (0, outputs[DataType::AUDIO][np]);
957 c->add_channel (_("R"), DataType::AUDIO);
958 c->set_port (1, outputs[DataType::AUDIO][np + 1]);
960 add_bundle (c, false);
964 /* mono input bundles */
966 for (uint32_t np = 0; np < inputs[DataType::AUDIO].size(); ++np) {
968 std::string pn = _engine.get_pretty_name_by_name (inputs[DataType::AUDIO][np]);
970 snprintf (buf, sizeof (buf), _("in %s"), pn.c_str());
972 snprintf (buf, sizeof (buf), _("in %" PRIu32), np+1);
975 boost::shared_ptr<Bundle> c (new Bundle (buf, false));
976 c->add_channel (_("mono"), DataType::AUDIO);
977 c->set_port (0, inputs[DataType::AUDIO][np]);
979 add_bundle (c, false);
982 /* stereo input bundles */
984 for (uint32_t np = 0; np < inputs[DataType::AUDIO].size(); np += 2) {
985 if (np + 1 < inputs[DataType::AUDIO].size()) {
987 snprintf (buf, sizeof(buf), _("in %" PRIu32 "+%" PRIu32), np + 1, np + 2);
989 boost::shared_ptr<Bundle> c (new Bundle (buf, false));
990 c->add_channel (_("L"), DataType::AUDIO);
991 c->set_port (0, inputs[DataType::AUDIO][np]);
992 c->add_channel (_("R"), DataType::AUDIO);
993 c->set_port (1, inputs[DataType::AUDIO][np + 1]);
995 add_bundle (c, false);
999 /* MIDI input bundles */
1001 for (uint32_t np = 0; np < inputs[DataType::MIDI].size(); ++np) {
1002 string n = inputs[DataType::MIDI][np];
1003 std::string pn = _engine.get_pretty_name_by_name (n);
1007 boost::erase_first (n, X_("alsa_pcm:"));
1009 boost::shared_ptr<Bundle> c (new Bundle (n, false));
1010 c->add_channel ("", DataType::MIDI);
1011 c->set_port (0, inputs[DataType::MIDI][np]);
1012 add_bundle (c, false);
1015 /* MIDI output bundles */
1017 for (uint32_t np = 0; np < outputs[DataType::MIDI].size(); ++np) {
1018 string n = outputs[DataType::MIDI][np];
1019 std::string pn = _engine.get_pretty_name_by_name (n);
1023 boost::erase_first (n, X_("alsa_pcm:"));
1025 boost::shared_ptr<Bundle> c (new Bundle (n, true));
1026 c->add_channel ("", DataType::MIDI);
1027 c->set_port (0, outputs[DataType::MIDI][np]);
1028 add_bundle (c, false);
1031 // we trust the backend to only calls us if there's a change
1032 BundleAddedOrRemoved (); /* EMIT SIGNAL */
1036 Session::auto_connect_master_bus ()
1038 if (!_master_out || !Config->get_auto_connect_standard_busses() || _monitor_out) {
1042 // Waves Tracks: Do not connect master bas for Tracks if AutoConnectMaster option is not set
1043 // In this case it means "Multi Out" output mode
1044 if (ARDOUR::Profile->get_trx() && !(Config->get_output_auto_connect() & AutoConnectMaster) ) {
1048 /* if requested auto-connect the outputs to the first N physical ports.
1051 uint32_t limit = _master_out->n_outputs().n_total();
1052 vector<string> outputs[DataType::num_types];
1054 for (uint32_t i = 0; i < DataType::num_types; ++i) {
1055 _engine.get_physical_outputs (DataType (DataType::Symbol (i)), outputs[i]);
1058 for (uint32_t n = 0; n < limit; ++n) {
1059 boost::shared_ptr<Port> p = _master_out->output()->nth (n);
1061 if (outputs[p->type()].size() > n) {
1062 connect_to = outputs[p->type()][n];
1065 if (!connect_to.empty() && p->connected_to (connect_to) == false) {
1066 if (_master_out->output()->connect (p, connect_to, this)) {
1067 error << string_compose (_("cannot connect master output %1 to %2"), n, connect_to)
1076 Session::remove_monitor_section ()
1078 if (!_monitor_out || Profile->get_trx()) {
1082 /* force reversion to Solo-In-Place */
1083 Config->set_solo_control_is_listen_control (false);
1085 /* if we are auditioning, cancel it ... this is a workaround
1086 to a problem (auditioning does not execute the process graph,
1087 which is needed to remove routes when using >1 core for processing)
1092 /* Hold process lock while doing this so that we don't hear bits and
1093 * pieces of audio as we work on each route.
1096 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
1098 /* Connect tracks to monitor section. Note that in an
1099 existing session, the internal sends will already exist, but we want the
1100 routes to notice that they connect to the control out specifically.
1104 boost::shared_ptr<RouteList> r = routes.reader ();
1105 PBD::Unwinder<bool> uw (ignore_route_processor_changes, true);
1107 for (RouteList::iterator x = r->begin(); x != r->end(); ++x) {
1109 if ((*x)->is_monitor()) {
1111 } else if ((*x)->is_master()) {
1114 (*x)->remove_aux_or_listen (_monitor_out);
1119 remove_route (_monitor_out);
1120 if (_state_of_the_state & Deletion) {
1124 auto_connect_master_bus ();
1127 auditioner->connect ();
1130 Config->ParameterChanged ("use-monitor-bus");
1134 Session::add_monitor_section ()
1138 if (_monitor_out || !_master_out || Profile->get_trx()) {
1142 boost::shared_ptr<Route> r (new Route (*this, _("Monitor"), Route::MonitorOut, DataType::AUDIO));
1148 BOOST_MARK_ROUTE(r);
1151 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
1152 r->input()->ensure_io (_master_out->output()->n_ports(), false, this);
1153 r->output()->ensure_io (_master_out->output()->n_ports(), false, this);
1155 error << _("Cannot create monitor section. 'Monitor' Port name is not unique.") << endmsg;
1160 add_routes (rl, false, false, false);
1162 assert (_monitor_out);
1164 /* AUDIO ONLY as of june 29th 2009, because listen semantics for anything else
1165 are undefined, at best.
1168 uint32_t limit = _monitor_out->n_inputs().n_audio();
1172 /* connect the inputs to the master bus outputs. this
1173 * represents a separate data feed from the internal sends from
1174 * each route. as of jan 2011, it allows the monitor section to
1175 * conditionally ignore either the internal sends or the normal
1176 * input feed, but we should really find a better way to do
1180 _master_out->output()->disconnect (this);
1182 for (uint32_t n = 0; n < limit; ++n) {
1183 boost::shared_ptr<AudioPort> p = _monitor_out->input()->ports().nth_audio_port (n);
1184 boost::shared_ptr<AudioPort> o = _master_out->output()->ports().nth_audio_port (n);
1187 string connect_to = o->name();
1188 if (_monitor_out->input()->connect (p, connect_to, this)) {
1189 error << string_compose (_("cannot connect control input %1 to %2"), n, connect_to)
1197 /* if monitor section is not connected, connect it to physical outs
1200 if ((Config->get_auto_connect_standard_busses () || Profile->get_mixbus ()) && !_monitor_out->output()->connected ()) {
1202 if (!Config->get_monitor_bus_preferred_bundle().empty()) {
1204 boost::shared_ptr<Bundle> b = bundle_by_name (Config->get_monitor_bus_preferred_bundle());
1207 _monitor_out->output()->connect_ports_to_bundle (b, true, this);
1209 warning << string_compose (_("The preferred I/O for the monitor bus (%1) cannot be found"),
1210 Config->get_monitor_bus_preferred_bundle())
1216 /* Monitor bus is audio only */
1218 vector<string> outputs[DataType::num_types];
1220 for (uint32_t i = 0; i < DataType::num_types; ++i) {
1221 _engine.get_physical_outputs (DataType (DataType::Symbol (i)), outputs[i]);
1224 uint32_t mod = outputs[DataType::AUDIO].size();
1225 uint32_t limit = _monitor_out->n_outputs().get (DataType::AUDIO);
1229 for (uint32_t n = 0; n < limit; ++n) {
1231 boost::shared_ptr<Port> p = _monitor_out->output()->ports().port(DataType::AUDIO, n);
1233 if (outputs[DataType::AUDIO].size() > (n % mod)) {
1234 connect_to = outputs[DataType::AUDIO][n % mod];
1237 if (!connect_to.empty()) {
1238 if (_monitor_out->output()->connect (p, connect_to, this)) {
1239 error << string_compose (
1240 _("cannot connect control output %1 to %2"),
1251 /* Hold process lock while doing this so that we don't hear bits and
1252 * pieces of audio as we work on each route.
1255 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
1257 /* Connect tracks to monitor section. Note that in an
1258 existing session, the internal sends will already exist, but we want the
1259 routes to notice that they connect to the control out specifically.
1263 boost::shared_ptr<RouteList> rls = routes.reader ();
1265 PBD::Unwinder<bool> uw (ignore_route_processor_changes, true);
1267 for (RouteList::iterator x = rls->begin(); x != rls->end(); ++x) {
1269 if ((*x)->is_monitor()) {
1271 } else if ((*x)->is_master()) {
1274 (*x)->enable_monitor_send ();
1279 auditioner->connect ();
1281 Config->ParameterChanged ("use-monitor-bus");
1285 Session::reset_monitor_section ()
1287 /* Process lock should be held by the caller.*/
1289 if (!_monitor_out || Profile->get_trx()) {
1293 uint32_t limit = _master_out->n_outputs().n_audio();
1295 /* connect the inputs to the master bus outputs. this
1296 * represents a separate data feed from the internal sends from
1297 * each route. as of jan 2011, it allows the monitor section to
1298 * conditionally ignore either the internal sends or the normal
1299 * input feed, but we should really find a better way to do
1303 _master_out->output()->disconnect (this);
1304 _monitor_out->output()->disconnect (this);
1306 _monitor_out->input()->ensure_io (_master_out->output()->n_ports(), false, this);
1307 _monitor_out->output()->ensure_io (_master_out->output()->n_ports(), false, this);
1309 for (uint32_t n = 0; n < limit; ++n) {
1310 boost::shared_ptr<AudioPort> p = _monitor_out->input()->ports().nth_audio_port (n);
1311 boost::shared_ptr<AudioPort> o = _master_out->output()->ports().nth_audio_port (n);
1314 string connect_to = o->name();
1315 if (_monitor_out->input()->connect (p, connect_to, this)) {
1316 error << string_compose (_("cannot connect control input %1 to %2"), n, connect_to)
1323 /* connect monitor section to physical outs
1326 if (Config->get_auto_connect_standard_busses()) {
1328 if (!Config->get_monitor_bus_preferred_bundle().empty()) {
1330 boost::shared_ptr<Bundle> b = bundle_by_name (Config->get_monitor_bus_preferred_bundle());
1333 _monitor_out->output()->connect_ports_to_bundle (b, true, this);
1335 warning << string_compose (_("The preferred I/O for the monitor bus (%1) cannot be found"),
1336 Config->get_monitor_bus_preferred_bundle())
1342 /* Monitor bus is audio only */
1344 vector<string> outputs[DataType::num_types];
1346 for (uint32_t i = 0; i < DataType::num_types; ++i) {
1347 _engine.get_physical_outputs (DataType (DataType::Symbol (i)), outputs[i]);
1350 uint32_t mod = outputs[DataType::AUDIO].size();
1351 uint32_t limit = _monitor_out->n_outputs().get (DataType::AUDIO);
1355 for (uint32_t n = 0; n < limit; ++n) {
1357 boost::shared_ptr<Port> p = _monitor_out->output()->ports().port(DataType::AUDIO, n);
1359 if (outputs[DataType::AUDIO].size() > (n % mod)) {
1360 connect_to = outputs[DataType::AUDIO][n % mod];
1363 if (!connect_to.empty()) {
1364 if (_monitor_out->output()->connect (p, connect_to, this)) {
1365 error << string_compose (
1366 _("cannot connect control output %1 to %2"),
1377 /* Connect tracks to monitor section. Note that in an
1378 existing session, the internal sends will already exist, but we want the
1379 routes to notice that they connect to the control out specifically.
1383 boost::shared_ptr<RouteList> rls = routes.reader ();
1385 PBD::Unwinder<bool> uw (ignore_route_processor_changes, true);
1387 for (RouteList::iterator x = rls->begin(); x != rls->end(); ++x) {
1389 if ((*x)->is_monitor()) {
1391 } else if ((*x)->is_master()) {
1394 (*x)->enable_monitor_send ();
1400 Session::hookup_io ()
1402 /* stop graph reordering notifications from
1403 causing resorts, etc.
1406 _state_of_the_state = StateOfTheState (_state_of_the_state | InitialConnecting);
1410 /* we delay creating the auditioner till now because
1411 it makes its own connections to ports.
1415 boost::shared_ptr<Auditioner> a (new Auditioner (*this));
1417 throw failed_constructor ();
1419 a->use_new_diskstream ();
1423 catch (failed_constructor& err) {
1424 warning << _("cannot create Auditioner: no auditioning of regions possible") << endmsg;
1428 /* load bundles, which we may have postponed earlier on */
1429 if (_bundle_xml_node) {
1430 load_bundles (*_bundle_xml_node);
1431 delete _bundle_xml_node;
1434 /* Tell all IO objects to connect themselves together */
1436 IO::enable_connecting ();
1438 /* Now tell all "floating" ports to connect to whatever
1439 they should be connected to.
1442 AudioEngine::instance()->reconnect_ports ();
1444 /* Anyone who cares about input state, wake up and do something */
1446 IOConnectionsComplete (); /* EMIT SIGNAL */
1448 _state_of_the_state = StateOfTheState (_state_of_the_state & ~InitialConnecting);
1450 /* now handle the whole enchilada as if it was one
1451 graph reorder event.
1456 /* update the full solo state, which can't be
1457 correctly determined on a per-route basis, but
1458 needs the global overview that only the session
1462 update_route_solo_state ();
1466 Session::track_playlist_changed (boost::weak_ptr<Track> wp)
1468 boost::shared_ptr<Track> track = wp.lock ();
1473 boost::shared_ptr<Playlist> playlist;
1475 if ((playlist = track->playlist()) != 0) {
1476 playlist->RegionAdded.connect_same_thread (*this, boost::bind (&Session::playlist_region_added, this, _1));
1477 playlist->RangesMoved.connect_same_thread (*this, boost::bind (&Session::playlist_ranges_moved, this, _1));
1478 playlist->RegionsExtended.connect_same_thread (*this, boost::bind (&Session::playlist_regions_extended, this, _1));
1483 Session::record_enabling_legal () const
1485 /* this used to be in here, but survey says.... we don't need to restrict it */
1486 // if (record_status() == Recording) {
1490 if (Config->get_all_safe()) {
1497 Session::set_track_monitor_input_status (bool yn)
1499 boost::shared_ptr<RouteList> rl = routes.reader ();
1500 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
1501 boost::shared_ptr<AudioTrack> tr = boost::dynamic_pointer_cast<AudioTrack> (*i);
1502 if (tr && tr->record_enabled ()) {
1503 //cerr << "switching to input = " << !auto_input << __FILE__ << __LINE__ << endl << endl;
1504 tr->request_input_monitoring (yn);
1510 Session::auto_punch_start_changed (Location* location)
1512 replace_event (SessionEvent::PunchIn, location->start());
1514 if (get_record_enabled() && config.get_punch_in()) {
1515 /* capture start has been changed, so save new pending state */
1516 save_state ("", true);
1521 Session::auto_punch_end_changed (Location* location)
1523 framepos_t when_to_stop = location->end();
1524 // when_to_stop += _worst_output_latency + _worst_input_latency;
1525 replace_event (SessionEvent::PunchOut, when_to_stop);
1529 Session::auto_punch_changed (Location* location)
1531 framepos_t when_to_stop = location->end();
1533 replace_event (SessionEvent::PunchIn, location->start());
1534 //when_to_stop += _worst_output_latency + _worst_input_latency;
1535 replace_event (SessionEvent::PunchOut, when_to_stop);
1538 /** @param loc A loop location.
1539 * @param pos Filled in with the start time of the required fade-out (in session frames).
1540 * @param length Filled in with the length of the required fade-out.
1543 Session::auto_loop_declick_range (Location* loc, framepos_t & pos, framepos_t & length)
1545 pos = max (loc->start(), loc->end() - 64);
1546 length = loc->end() - pos;
1550 Session::auto_loop_changed (Location* location)
1552 replace_event (SessionEvent::AutoLoop, location->end(), location->start());
1555 auto_loop_declick_range (location, dcp, dcl);
1557 if (transport_rolling() && play_loop) {
1559 replace_event (SessionEvent::AutoLoopDeclick, dcp, dcl);
1561 // if (_transport_frame > location->end()) {
1563 if (_transport_frame < location->start() || _transport_frame > location->end()) {
1564 // relocate to beginning of loop
1565 clear_events (SessionEvent::LocateRoll);
1567 request_locate (location->start(), true);
1570 else if (Config->get_seamless_loop() && !loop_changing) {
1572 // schedule a locate-roll to refill the diskstreams at the
1573 // previous loop end
1574 loop_changing = true;
1576 if (location->end() > last_loopend) {
1577 clear_events (SessionEvent::LocateRoll);
1578 SessionEvent *ev = new SessionEvent (SessionEvent::LocateRoll, SessionEvent::Add, last_loopend, last_loopend, 0, true);
1584 clear_events (SessionEvent::AutoLoopDeclick);
1585 clear_events (SessionEvent::AutoLoop);
1588 /* possibly move playhead if not rolling; if we are rolling we'll move
1589 to the loop start on stop if that is appropriate.
1594 if (!transport_rolling() && select_playhead_priority_target (pos)) {
1595 if (pos == location->start()) {
1596 request_locate (pos);
1601 last_loopend = location->end();
1606 Session::set_auto_punch_location (Location* location)
1610 if ((existing = _locations->auto_punch_location()) != 0 && existing != location) {
1611 punch_connections.drop_connections();
1612 existing->set_auto_punch (false, this);
1613 remove_event (existing->start(), SessionEvent::PunchIn);
1614 clear_events (SessionEvent::PunchOut);
1615 auto_punch_location_changed (0);
1620 if (location == 0) {
1624 if (location->end() <= location->start()) {
1625 error << _("Session: you can't use that location for auto punch (start <= end)") << endmsg;
1629 punch_connections.drop_connections ();
1631 location->StartChanged.connect_same_thread (punch_connections, boost::bind (&Session::auto_punch_start_changed, this, location));
1632 location->EndChanged.connect_same_thread (punch_connections, boost::bind (&Session::auto_punch_end_changed, this, location));
1633 location->Changed.connect_same_thread (punch_connections, boost::bind (&Session::auto_punch_changed, this, location));
1635 location->set_auto_punch (true, this);
1637 auto_punch_changed (location);
1639 auto_punch_location_changed (location);
1643 Session::set_session_extents (framepos_t start, framepos_t end)
1646 if ((existing = _locations->session_range_location()) == 0) {
1647 //if there is no existing session, we need to make a new session location (should never happen)
1648 existing = new Location (*this, 0, 0, _("session"), Location::IsSessionRange);
1652 error << _("Session: you can't use that location for session start/end)") << endmsg;
1656 existing->set( start, end );
1662 Session::set_auto_loop_location (Location* location)
1666 if ((existing = _locations->auto_loop_location()) != 0 && existing != location) {
1667 loop_connections.drop_connections ();
1668 existing->set_auto_loop (false, this);
1669 remove_event (existing->end(), SessionEvent::AutoLoop);
1672 auto_loop_declick_range (existing, dcp, dcl);
1673 remove_event (dcp, SessionEvent::AutoLoopDeclick);
1674 auto_loop_location_changed (0);
1679 if (location == 0) {
1683 if (location->end() <= location->start()) {
1684 error << _("You cannot use this location for auto-loop because it has zero or negative length") << endmsg;
1688 last_loopend = location->end();
1690 loop_connections.drop_connections ();
1692 location->StartChanged.connect_same_thread (loop_connections, boost::bind (&Session::auto_loop_changed, this, location));
1693 location->EndChanged.connect_same_thread (loop_connections, boost::bind (&Session::auto_loop_changed, this, location));
1694 location->Changed.connect_same_thread (loop_connections, boost::bind (&Session::auto_loop_changed, this, location));
1695 location->FlagsChanged.connect_same_thread (loop_connections, boost::bind (&Session::auto_loop_changed, this, location));
1697 location->set_auto_loop (true, this);
1699 if (Config->get_loop_is_mode() && play_loop && Config->get_seamless_loop()) {
1700 // set all tracks to use internal looping
1701 boost::shared_ptr<RouteList> rl = routes.reader ();
1702 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
1703 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
1704 if (tr && !tr->hidden()) {
1705 tr->set_loop (location);
1710 /* take care of our stuff first */
1712 auto_loop_changed (location);
1714 /* now tell everyone else */
1716 auto_loop_location_changed (location);
1720 Session::update_marks (Location*)
1726 Session::update_skips (Location* loc, bool consolidate)
1728 if (_ignore_skips_updates) {
1732 Locations::LocationList skips;
1735 PBD::Unwinder<bool> uw (_ignore_skips_updates, true);
1736 consolidate_skips (loc);
1739 sync_locations_to_skips ();
1745 Session::consolidate_skips (Location* loc)
1747 Locations::LocationList all_locations = _locations->list ();
1749 for (Locations::LocationList::iterator l = all_locations.begin(); l != all_locations.end(); ) {
1751 if (!(*l)->is_skip ()) {
1756 /* don't test against self */
1763 switch (Evoral::coverage ((*l)->start(), (*l)->end(), loc->start(), loc->end())) {
1764 case Evoral::OverlapInternal:
1765 case Evoral::OverlapExternal:
1766 case Evoral::OverlapStart:
1767 case Evoral::OverlapEnd:
1768 /* adjust new location to cover existing one */
1769 loc->set_start (min (loc->start(), (*l)->start()));
1770 loc->set_end (max (loc->end(), (*l)->end()));
1771 /* we don't need this one any more */
1772 _locations->remove (*l);
1773 /* the location has been deleted, so remove reference to it in our local list */
1774 l = all_locations.erase (l);
1777 case Evoral::OverlapNone:
1785 Session::sync_locations_to_skips ()
1787 /* This happens asynchronously (in the audioengine thread). After the clear is done, we will call
1788 * Session::_sync_locations_to_skips() from the audioengine thread.
1790 clear_events (SessionEvent::Skip, boost::bind (&Session::_sync_locations_to_skips, this));
1794 Session::_sync_locations_to_skips ()
1796 /* called as a callback after existing Skip events have been cleared from a realtime audioengine thread */
1798 Locations::LocationList const & locs (_locations->list());
1800 for (Locations::LocationList::const_iterator i = locs.begin(); i != locs.end(); ++i) {
1802 Location* location = *i;
1804 if (location->is_skip() && location->is_skipping()) {
1805 SessionEvent* ev = new SessionEvent (SessionEvent::Skip, SessionEvent::Add, location->start(), location->end(), 1.0);
1813 Session::location_added (Location *location)
1815 if (location->is_auto_punch()) {
1816 set_auto_punch_location (location);
1819 if (location->is_auto_loop()) {
1820 set_auto_loop_location (location);
1823 if (location->is_session_range()) {
1824 /* no need for any signal handling or event setting with the session range,
1825 because we keep a direct reference to it and use its start/end directly.
1827 _session_range_location = location;
1830 if (location->is_mark()) {
1831 /* listen for per-location signals that require us to do any * global updates for marks */
1833 location->StartChanged.connect_same_thread (skip_update_connections, boost::bind (&Session::update_marks, this, location));
1834 location->EndChanged.connect_same_thread (skip_update_connections, boost::bind (&Session::update_marks, this, location));
1835 location->Changed.connect_same_thread (skip_update_connections, boost::bind (&Session::update_marks, this, location));
1836 location->FlagsChanged.connect_same_thread (skip_update_connections, boost::bind (&Session::update_marks, this, location));
1839 if (location->is_skip()) {
1840 /* listen for per-location signals that require us to update skip-locate events */
1842 location->StartChanged.connect_same_thread (skip_update_connections, boost::bind (&Session::update_skips, this, location, true));
1843 location->EndChanged.connect_same_thread (skip_update_connections, boost::bind (&Session::update_skips, this, location, true));
1844 location->Changed.connect_same_thread (skip_update_connections, boost::bind (&Session::update_skips, this, location, true));
1845 location->FlagsChanged.connect_same_thread (skip_update_connections, boost::bind (&Session::update_skips, this, location, false));
1847 update_skips (location, true);
1854 Session::location_removed (Location *location)
1856 if (location->is_auto_loop()) {
1857 set_auto_loop_location (0);
1858 set_track_loop (false);
1861 if (location->is_auto_punch()) {
1862 set_auto_punch_location (0);
1865 if (location->is_session_range()) {
1866 /* this is never supposed to happen */
1867 error << _("programming error: session range removed!") << endl;
1870 if (location->is_skip()) {
1872 update_skips (location, false);
1879 Session::locations_changed ()
1881 _locations->apply (*this, &Session::_locations_changed);
1885 Session::_locations_changed (const Locations::LocationList& locations)
1887 /* There was some mass-change in the Locations object.
1889 We might be re-adding a location here but it doesn't actually matter
1890 for all the locations that the Session takes an interest in.
1894 PBD::Unwinder<bool> protect_ignore_skip_updates (_ignore_skips_updates, true);
1895 for (Locations::LocationList::const_iterator i = locations.begin(); i != locations.end(); ++i) {
1896 location_added (*i);
1900 update_skips (NULL, false);
1904 Session::enable_record ()
1906 if (_transport_speed != 0.0 && _transport_speed != 1.0) {
1907 /* no recording at anything except normal speed */
1912 RecordState rs = (RecordState) g_atomic_int_get (&_record_status);
1914 if (rs == Recording) {
1918 if (g_atomic_int_compare_and_exchange (&_record_status, rs, Recording)) {
1920 _last_record_location = _transport_frame;
1921 send_immediate_mmc (MIDI::MachineControlCommand (MIDI::MachineControl::cmdRecordStrobe));
1923 if (Config->get_monitoring_model() == HardwareMonitoring && config.get_auto_input()) {
1924 set_track_monitor_input_status (true);
1927 RecordStateChanged ();
1934 Session::set_all_tracks_record_enabled (bool enable )
1936 boost::shared_ptr<RouteList> rl = routes.reader();
1937 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
1938 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
1940 tr->set_record_enabled (enable, Controllable::NoGroup);
1947 Session::disable_record (bool rt_context, bool force)
1951 if ((rs = (RecordState) g_atomic_int_get (&_record_status)) != Disabled) {
1953 if (!Config->get_latched_record_enable () || force) {
1954 g_atomic_int_set (&_record_status, Disabled);
1955 send_immediate_mmc (MIDI::MachineControlCommand (MIDI::MachineControl::cmdRecordExit));
1957 if (rs == Recording) {
1958 g_atomic_int_set (&_record_status, Enabled);
1962 if (Config->get_monitoring_model() == HardwareMonitoring && config.get_auto_input()) {
1963 set_track_monitor_input_status (false);
1966 RecordStateChanged (); /* emit signal */
1969 remove_pending_capture_state ();
1975 Session::step_back_from_record ()
1977 if (g_atomic_int_compare_and_exchange (&_record_status, Recording, Enabled)) {
1979 if (Config->get_monitoring_model() == HardwareMonitoring && config.get_auto_input()) {
1980 set_track_monitor_input_status (false);
1983 RecordStateChanged (); /* emit signal */
1988 Session::maybe_enable_record ()
1990 if (_step_editors > 0) {
1994 g_atomic_int_set (&_record_status, Enabled);
1996 /* This function is currently called from somewhere other than an RT thread.
1997 This save_state() call therefore doesn't impact anything. Doing it here
1998 means that we save pending state of which sources the next record will use,
1999 which gives us some chance of recovering from a crash during the record.
2002 save_state ("", true);
2004 if (_transport_speed) {
2005 if (!config.get_punch_in()) {
2009 send_immediate_mmc (MIDI::MachineControlCommand (MIDI::MachineControl::cmdRecordPause));
2010 RecordStateChanged (); /* EMIT SIGNAL */
2017 Session::audible_frame () const
2023 offset = worst_playback_latency ();
2025 if (synced_to_engine()) {
2026 /* Note: this is basically just sync-to-JACK */
2027 tf = _engine.transport_frame();
2029 tf = _transport_frame;
2034 if (!non_realtime_work_pending()) {
2038 /* Check to see if we have passed the first guaranteed
2039 audible frame past our last start position. if not,
2040 return that last start point because in terms
2041 of audible frames, we have not moved yet.
2043 `Start position' in this context means the time we last
2044 either started, located, or changed transport direction.
2047 if (_transport_speed > 0.0f) {
2049 if (!play_loop || !have_looped) {
2050 if (tf < _last_roll_or_reversal_location + offset) {
2051 return _last_roll_or_reversal_location;
2059 } else if (_transport_speed < 0.0f) {
2061 /* XXX wot? no backward looping? */
2063 if (tf > _last_roll_or_reversal_location - offset) {
2064 return _last_roll_or_reversal_location;
2076 Session::set_frame_rate (framecnt_t frames_per_second)
2078 /** \fn void Session::set_frame_size(framecnt_t)
2079 the AudioEngine object that calls this guarantees
2080 that it will not be called while we are also in
2081 ::process(). Its fine to do things that block
2085 if (_base_frame_rate == 0) {
2086 _base_frame_rate = frames_per_second;
2088 else if (_base_frame_rate != frames_per_second && frames_per_second != _nominal_frame_rate) {
2089 NotifyAboutSampleRateMismatch (_base_frame_rate, frames_per_second);
2091 _nominal_frame_rate = frames_per_second;
2096 reset_write_sources (false);
2098 // XXX we need some equivalent to this, somehow
2099 // SndFileSource::setup_standard_crossfades (frames_per_second);
2103 /* XXX need to reset/reinstantiate all LADSPA plugins */
2107 Session::set_block_size (pframes_t nframes)
2109 /* the AudioEngine guarantees
2110 that it will not be called while we are also in
2111 ::process(). It is therefore fine to do things that block
2116 current_block_size = nframes;
2120 boost::shared_ptr<RouteList> r = routes.reader ();
2122 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
2123 (*i)->set_block_size (nframes);
2126 boost::shared_ptr<RouteList> rl = routes.reader ();
2127 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
2128 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
2130 tr->set_block_size (nframes);
2134 set_worst_io_latencies ();
2140 trace_terminal (boost::shared_ptr<Route> r1, boost::shared_ptr<Route> rbase)
2142 boost::shared_ptr<Route> r2;
2144 if (r1->feeds (rbase) && rbase->feeds (r1)) {
2145 info << string_compose(_("feedback loop setup between %1 and %2"), r1->name(), rbase->name()) << endmsg;
2149 /* make a copy of the existing list of routes that feed r1 */
2151 Route::FedBy existing (r1->fed_by());
2153 /* for each route that feeds r1, recurse, marking it as feeding
2157 for (Route::FedBy::iterator i = existing.begin(); i != existing.end(); ++i) {
2158 if (!(r2 = i->r.lock ())) {
2159 /* (*i) went away, ignore it */
2163 /* r2 is a route that feeds r1 which somehow feeds base. mark
2164 base as being fed by r2
2167 rbase->add_fed_by (r2, i->sends_only);
2171 /* 2nd level feedback loop detection. if r1 feeds or is fed by r2,
2175 if (r1->feeds (r2) && r2->feeds (r1)) {
2179 /* now recurse, so that we can mark base as being fed by
2180 all routes that feed r2
2183 trace_terminal (r2, rbase);
2190 Session::resort_routes ()
2192 /* don't do anything here with signals emitted
2193 by Routes during initial setup or while we
2194 are being destroyed.
2197 if (_state_of_the_state & (InitialConnecting | Deletion)) {
2201 if (_route_deletion_in_progress) {
2206 RCUWriter<RouteList> writer (routes);
2207 boost::shared_ptr<RouteList> r = writer.get_copy ();
2208 resort_routes_using (r);
2209 /* writer goes out of scope and forces update */
2213 if (DEBUG_ENABLED(DEBUG::Graph)) {
2214 boost::shared_ptr<RouteList> rl = routes.reader ();
2215 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
2216 DEBUG_TRACE (DEBUG::Graph, string_compose ("%1 fed by ...\n", (*i)->name()));
2218 const Route::FedBy& fb ((*i)->fed_by());
2220 for (Route::FedBy::const_iterator f = fb.begin(); f != fb.end(); ++f) {
2221 boost::shared_ptr<Route> sf = f->r.lock();
2223 DEBUG_TRACE (DEBUG::Graph, string_compose ("\t%1 (sends only ? %2)\n", sf->name(), f->sends_only));
2232 /** This is called whenever we need to rebuild the graph of how we will process
2234 * @param r List of routes, in any order.
2238 Session::resort_routes_using (boost::shared_ptr<RouteList> r)
2240 /* We are going to build a directed graph of our routes;
2241 this is where the edges of that graph are put.
2246 /* Go through all routes doing two things:
2248 * 1. Collect the edges of the route graph. Each of these edges
2249 * is a pair of routes, one of which directly feeds the other
2250 * either by a JACK connection or by an internal send.
2252 * 2. Begin the process of making routes aware of which other
2253 * routes directly or indirectly feed them. This information
2254 * is used by the solo code.
2257 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
2259 /* Clear out the route's list of direct or indirect feeds */
2260 (*i)->clear_fed_by ();
2262 for (RouteList::iterator j = r->begin(); j != r->end(); ++j) {
2264 bool via_sends_only;
2266 /* See if this *j feeds *i according to the current state of the JACK
2267 connections and internal sends.
2269 if ((*j)->direct_feeds_according_to_reality (*i, &via_sends_only)) {
2270 /* add the edge to the graph (part #1) */
2271 edges.add (*j, *i, via_sends_only);
2272 /* tell the route (for part #2) */
2273 (*i)->add_fed_by (*j, via_sends_only);
2278 /* Attempt a topological sort of the route graph */
2279 boost::shared_ptr<RouteList> sorted_routes = topological_sort (r, edges);
2281 if (sorted_routes) {
2282 /* We got a satisfactory topological sort, so there is no feedback;
2285 Note: the process graph rechain does not require a
2286 topologically-sorted list, but hey ho.
2288 if (_process_graph) {
2289 _process_graph->rechain (sorted_routes, edges);
2292 _current_route_graph = edges;
2294 /* Complete the building of the routes' lists of what directly
2295 or indirectly feeds them.
2297 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
2298 trace_terminal (*i, *i);
2301 *r = *sorted_routes;
2304 DEBUG_TRACE (DEBUG::Graph, "Routes resorted, order follows:\n");
2305 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
2306 DEBUG_TRACE (DEBUG::Graph, string_compose ("\t%1 signal order %2\n",
2307 (*i)->name(), (*i)->order_key ()));
2311 SuccessfulGraphSort (); /* EMIT SIGNAL */
2314 /* The topological sort failed, so we have a problem. Tell everyone
2315 and stick to the old graph; this will continue to be processed, so
2316 until the feedback is fixed, what is played back will not quite
2317 reflect what is actually connected. Note also that we do not
2318 do trace_terminal here, as it would fail due to an endless recursion,
2319 so the solo code will think that everything is still connected
2323 FeedbackDetected (); /* EMIT SIGNAL */
2328 /** Find a route name starting with \a base, maybe followed by the
2329 * lowest \a id. \a id will always be added if \a definitely_add_number
2330 * is true on entry; otherwise it will only be added if required
2331 * to make the name unique.
2333 * Names are constructed like e.g. "Audio 3" for base="Audio" and id=3.
2334 * The available route name with the lowest ID will be used, and \a id
2335 * will be set to the ID.
2337 * \return false if a route name could not be found, and \a track_name
2338 * and \a id do not reflect a free route name.
2341 Session::find_route_name (string const & base, uint32_t& id, string& name, bool definitely_add_number)
2343 /* the base may conflict with ports that do not belong to existing
2344 routes, but hidden objects like the click track. So check port names
2345 before anything else.
2348 for (vector<string>::const_iterator reserved = reserved_io_names.begin(); reserved != reserved_io_names.end(); ++reserved) {
2349 if (base == *reserved) {
2350 /* Check if this reserved name already exists, and if
2351 so, disallow it without a numeric suffix.
2353 if (route_by_name (*reserved)) {
2354 definitely_add_number = true;
2363 if (!definitely_add_number && route_by_name (base) == 0) {
2364 /* juse use the base */
2370 name = string_compose ("%1 %2", base, id);
2372 if (route_by_name (name) == 0) {
2378 } while (id < (UINT_MAX-1));
2383 /** Count the total ins and outs of all non-hidden tracks in the session and return them in in and out */
2385 Session::count_existing_track_channels (ChanCount& in, ChanCount& out)
2387 in = ChanCount::ZERO;
2388 out = ChanCount::ZERO;
2390 boost::shared_ptr<RouteList> r = routes.reader ();
2392 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
2393 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
2394 if (tr && !tr->is_auditioner()) {
2395 in += tr->n_inputs();
2396 out += tr->n_outputs();
2402 Session::default_track_name_pattern (DataType t)
2405 case DataType::AUDIO:
2406 if (Profile->get_trx()) {
2413 case DataType::MIDI:
2420 /** Caller must not hold process lock
2421 * @param name_template string to use for the start of the name, or "" to use "MIDI".
2422 * @param instrument plugin info for the instrument to insert pre-fader, if any
2424 list<boost::shared_ptr<MidiTrack> >
2425 Session::new_midi_track (const ChanCount& input, const ChanCount& output, boost::shared_ptr<PluginInfo> instrument,
2426 TrackMode mode, RouteGroup* route_group, uint32_t how_many, string name_template, Plugin::PresetRecord* pset)
2429 uint32_t track_id = 0;
2431 RouteList new_routes;
2432 list<boost::shared_ptr<MidiTrack> > ret;
2434 const string name_pattern = default_track_name_pattern (DataType::MIDI);
2435 bool const use_number = (how_many != 1) || name_template.empty () || (name_template == name_pattern);
2438 if (!find_route_name (name_template.empty() ? _("MIDI") : name_template, ++track_id, track_name, use_number)) {
2439 error << "cannot find name for new midi track" << endmsg;
2443 boost::shared_ptr<MidiTrack> track;
2446 track.reset (new MidiTrack (*this, track_name, Route::Flag (0), mode));
2448 if (track->init ()) {
2452 if (Profile->get_mixbus ()) {
2453 track->set_strict_io (true);
2456 track->use_new_diskstream();
2458 BOOST_MARK_TRACK (track);
2461 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
2462 if (track->input()->ensure_io (input, false, this)) {
2463 error << "cannot configure " << input << " out configuration for new midi track" << endmsg;
2467 if (track->output()->ensure_io (output, false, this)) {
2468 error << "cannot configure " << output << " out configuration for new midi track" << endmsg;
2473 track->non_realtime_input_change();
2476 route_group->add (track);
2479 track->DiskstreamChanged.connect_same_thread (*this, boost::bind (&Session::resort_routes, this));
2481 if (Config->get_remote_model() == UserOrdered) {
2482 track->set_remote_control_id (next_control_id());
2485 new_routes.push_back (track);
2486 ret.push_back (track);
2488 RouteAddedOrRemoved (true); /* EMIT SIGNAL */
2491 catch (failed_constructor &err) {
2492 error << _("Session: could not create new midi track.") << endmsg;
2496 catch (AudioEngine::PortRegistrationFailure& pfe) {
2498 error << string_compose (_("No more JACK ports are available. You will need to stop %1 and restart JACK with more ports if you need this many tracks."), PROGRAM_NAME) << endmsg;
2506 if (!new_routes.empty()) {
2507 StateProtector sp (this);
2508 if (Profile->get_trx()) {
2509 add_routes (new_routes, false, false, false);
2511 add_routes (new_routes, true, true, false);
2515 for (RouteList::iterator r = new_routes.begin(); r != new_routes.end(); ++r) {
2516 PluginPtr plugin = instrument->load (*this);
2518 plugin->load_preset (*pset);
2520 boost::shared_ptr<Processor> p (new PluginInsert (*this, plugin));
2521 (*r)->add_processor (p, PreFader);
2531 Session::new_midi_route (RouteGroup* route_group, uint32_t how_many, string name_template, boost::shared_ptr<PluginInfo> instrument, Plugin::PresetRecord* pset)
2534 uint32_t bus_id = 0;
2538 bool const use_number = (how_many != 1) || name_template.empty () || name_template == _("Midi Bus");
2541 if (!find_route_name (name_template.empty () ? _("Midi Bus") : name_template, ++bus_id, bus_name, use_number)) {
2542 error << "cannot find name for new midi bus" << endmsg;
2547 boost::shared_ptr<Route> bus (new Route (*this, bus_name, Route::Flag(0), DataType::AUDIO)); // XXX Editor::add_routes is not ready for ARDOUR::DataType::MIDI
2553 if (Profile->get_mixbus ()) {
2554 bus->set_strict_io (true);
2557 BOOST_MARK_ROUTE(bus);
2560 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
2562 if (bus->input()->ensure_io (ChanCount(DataType::MIDI, 1), false, this)) {
2563 error << _("cannot configure new midi bus input") << endmsg;
2568 if (bus->output()->ensure_io (ChanCount(DataType::MIDI, 1), false, this)) {
2569 error << _("cannot configure new midi bus output") << endmsg;
2575 route_group->add (bus);
2577 if (Config->get_remote_model() == UserOrdered) {
2578 bus->set_remote_control_id (next_control_id());
2581 ret.push_back (bus);
2582 RouteAddedOrRemoved (true); /* EMIT SIGNAL */
2586 catch (failed_constructor &err) {
2587 error << _("Session: could not create new audio route.") << endmsg;
2591 catch (AudioEngine::PortRegistrationFailure& pfe) {
2592 error << pfe.what() << endmsg;
2602 StateProtector sp (this);
2603 add_routes (ret, false, false, false);
2606 for (RouteList::iterator r = ret.begin(); r != ret.end(); ++r) {
2607 PluginPtr plugin = instrument->load (*this);
2609 plugin->load_preset (*pset);
2611 boost::shared_ptr<Processor> p (new PluginInsert (*this, plugin));
2612 (*r)->add_processor (p, PreFader);
2623 Session::midi_output_change_handler (IOChange change, void * /*src*/, boost::weak_ptr<Route> wmt)
2625 boost::shared_ptr<Route> midi_track (wmt.lock());
2631 if ((change.type & IOChange::ConfigurationChanged) && Config->get_output_auto_connect() != ManualConnect) {
2633 if (change.after.n_audio() <= change.before.n_audio()) {
2637 /* new audio ports: make sure the audio goes somewhere useful,
2638 * unless the user has no-auto-connect selected.
2640 * The existing ChanCounts don't matter for this call as they are only
2641 * to do with matching input and output indices, and we are only changing
2644 auto_connect_route (midi_track, false, ChanCount(), change.before);
2648 #ifdef USE_TRACKS_CODE_FEATURES
2651 compare_routes_by_remote_id (const boost::shared_ptr<Route>& route1, const boost::shared_ptr<Route>& route2)
2653 return route1->remote_control_id() < route2->remote_control_id();
2657 Session::reconnect_existing_routes (bool withLock, bool reconnect_master, bool reconnect_inputs, bool reconnect_outputs)
2659 // it is not allowed to perform connection
2660 if (!IO::connecting_legal) {
2664 // if we are deleting routes we will call this once at the end
2665 if (_route_deletion_in_progress) {
2669 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock (), Glib::Threads::NOT_LOCK);
2675 // We need to disconnect the route's inputs and outputs first
2676 // basing on autoconnect configuration
2677 bool reconnectIputs = !(Config->get_input_auto_connect() & ManualConnect) && reconnect_inputs;
2678 bool reconnectOutputs = !(Config->get_output_auto_connect() & ManualConnect) && reconnect_outputs;
2680 ChanCount existing_inputs;
2681 ChanCount existing_outputs;
2682 count_existing_track_channels (existing_inputs, existing_outputs);
2684 //ChanCount inputs = ChanCount::ZERO;
2685 //ChanCount outputs = ChanCount::ZERO;
2687 RouteList existing_routes = *routes.reader ();
2688 existing_routes.sort (compare_routes_by_remote_id);
2691 PBD::Unwinder<bool> protect_ignore_changes (_reconnecting_routes_in_progress, true);
2693 vector<string> physinputs;
2694 vector<string> physoutputs;
2696 EngineStateController::instance()->get_physical_audio_outputs(physoutputs);
2697 EngineStateController::instance()->get_physical_audio_inputs(physinputs);
2699 uint32_t input_n = 0;
2700 uint32_t output_n = 0;
2701 RouteList::iterator rIter = existing_routes.begin();
2702 const AutoConnectOption current_input_auto_connection (Config->get_input_auto_connect());
2703 const AutoConnectOption current_output_auto_connection (Config->get_output_auto_connect());
2704 for (; rIter != existing_routes.end(); ++rIter) {
2705 if (*rIter == _master_out || *rIter == _monitor_out ) {
2709 if (current_output_auto_connection == AutoConnectPhysical) {
2710 (*rIter)->amp()->deactivate();
2711 } else if (current_output_auto_connection == AutoConnectMaster) {
2712 (*rIter)->amp()->activate();
2715 if (reconnectIputs) {
2716 (*rIter)->input()->disconnect (this); //GZ: check this; could be heavy
2718 for (uint32_t route_input_n = 0; route_input_n < (*rIter)->n_inputs().get(DataType::AUDIO); ++route_input_n) {
2720 if (current_input_auto_connection & AutoConnectPhysical) {
2722 if ( input_n == physinputs.size() ) {
2726 string port = physinputs[input_n];
2728 if (port.empty() ) {
2729 error << "Physical Input number "<< input_n << " is unavailable and cannot be connected" << endmsg;
2732 //GZ: check this; could be heavy
2733 (*rIter)->input()->connect ((*rIter)->input()->ports().port(DataType::AUDIO, route_input_n), port, this);
2739 if (reconnectOutputs) {
2741 //normalize route ouptuts: reduce the amount outputs to be equal to the amount of inputs
2742 if (current_output_auto_connection & AutoConnectPhysical) {
2744 //GZ: check this; could be heavy
2745 (*rIter)->output()->disconnect (this);
2746 size_t route_inputs_count = (*rIter)->n_inputs().get(DataType::AUDIO);
2748 //GZ: check this; could be heavy
2749 (*rIter)->output()->ensure_io(ChanCount(DataType::AUDIO, route_inputs_count), false, this );
2751 } else if (current_output_auto_connection & AutoConnectMaster){
2753 if (!reconnect_master) {
2757 //GZ: check this; could be heavy
2758 (*rIter)->output()->disconnect (this);
2761 uint32_t master_inputs_count = _master_out->n_inputs().get(DataType::AUDIO);
2762 (*rIter)->output()->ensure_io(ChanCount(DataType::AUDIO, master_inputs_count), false, this );
2764 error << error << "Master bus is not available" << endmsg;
2769 for (uint32_t route_output_n = 0; route_output_n < (*rIter)->n_outputs().get(DataType::AUDIO); ++route_output_n) {
2770 if (current_output_auto_connection & AutoConnectPhysical) {
2772 if ( output_n == physoutputs.size() ) {
2776 string port = physoutputs[output_n];
2778 if (port.empty() ) {
2779 error << "Physical Output number "<< output_n << " is unavailable and cannot be connected" << endmsg;
2782 //GZ: check this; could be heavy
2783 (*rIter)->output()->connect ((*rIter)->output()->ports().port(DataType::AUDIO, route_output_n), port, this);
2786 } else if (current_output_auto_connection & AutoConnectMaster) {
2788 if ( route_output_n == _master_out->n_inputs().get(DataType::AUDIO) ) {
2792 // connect to master bus
2793 string port = _master_out->input()->ports().port(DataType::AUDIO, route_output_n)->name();
2795 if (port.empty() ) {
2796 error << "MasterBus Input number "<< route_output_n << " is unavailable and cannot be connected" << endmsg;
2800 //GZ: check this; could be heavy
2801 (*rIter)->output()->connect ((*rIter)->output()->ports().port(DataType::AUDIO, route_output_n), port, this);
2808 _master_out->output()->disconnect (this);
2809 auto_connect_master_bus ();
2814 session_routes_reconnected (); /* EMIT SIGNAL */
2818 Session::reconnect_midi_scene_ports(bool inputs)
2822 boost::shared_ptr<MidiPort> scene_in_ptr = scene_in();
2824 scene_in_ptr->disconnect_all ();
2826 std::vector<EngineStateController::MidiPortState> midi_port_states;
2827 EngineStateController::instance()->get_physical_midi_input_states (midi_port_states);
2829 std::vector<EngineStateController::MidiPortState>::iterator state_iter = midi_port_states.begin();
2831 for (; state_iter != midi_port_states.end(); ++state_iter) {
2832 if (state_iter->active && state_iter->available && state_iter->scene_connected) {
2833 scene_in_ptr->connect (state_iter->name);
2840 boost::shared_ptr<MidiPort> scene_out_ptr = scene_out();
2842 if (scene_out_ptr ) {
2843 scene_out_ptr->disconnect_all ();
2845 std::vector<EngineStateController::MidiPortState> midi_port_states;
2846 EngineStateController::instance()->get_physical_midi_output_states (midi_port_states);
2848 std::vector<EngineStateController::MidiPortState>::iterator state_iter = midi_port_states.begin();
2850 for (; state_iter != midi_port_states.end(); ++state_iter) {
2851 if (state_iter->active && state_iter->available && state_iter->scene_connected) {
2852 scene_out_ptr->connect (state_iter->name);
2860 Session::reconnect_mtc_ports ()
2862 boost::shared_ptr<MidiPort> mtc_in_ptr = _midi_ports->mtc_input_port();
2868 mtc_in_ptr->disconnect_all ();
2870 std::vector<EngineStateController::MidiPortState> midi_port_states;
2871 EngineStateController::instance()->get_physical_midi_input_states (midi_port_states);
2873 std::vector<EngineStateController::MidiPortState>::iterator state_iter = midi_port_states.begin();
2875 for (; state_iter != midi_port_states.end(); ++state_iter) {
2876 if (state_iter->available && state_iter->mtc_in) {
2877 mtc_in_ptr->connect (state_iter->name);
2881 if (!_midi_ports->mtc_input_port ()->connected () &&
2882 config.get_external_sync () &&
2883 (Config->get_sync_source () == MTC) ) {
2884 config.set_external_sync (false);
2887 if ( ARDOUR::Profile->get_trx () ) {
2888 // Tracks need this signal to update timecode_source_dropdown
2889 MtcOrLtcInputPortChanged (); //emit signal
2894 Session::reconnect_mmc_ports(bool inputs)
2896 if (inputs ) { // get all enabled midi input ports
2898 boost::shared_ptr<MidiPort> mmc_in_ptr = _midi_ports->mmc_in();
2900 mmc_in_ptr->disconnect_all ();
2901 std::vector<std::string> enabled_midi_inputs;
2902 EngineStateController::instance()->get_physical_midi_inputs (enabled_midi_inputs);
2904 std::vector<std::string>::iterator port_iter = enabled_midi_inputs.begin();
2906 for (; port_iter != enabled_midi_inputs.end(); ++port_iter) {
2907 mmc_in_ptr->connect (*port_iter);
2911 } else { // get all enabled midi output ports
2913 boost::shared_ptr<MidiPort> mmc_out_ptr = _midi_ports->mmc_out();
2915 mmc_out_ptr->disconnect_all ();
2916 std::vector<std::string> enabled_midi_outputs;
2917 EngineStateController::instance()->get_physical_midi_outputs (enabled_midi_outputs);
2919 std::vector<std::string>::iterator port_iter = enabled_midi_outputs.begin();
2921 for (; port_iter != enabled_midi_outputs.end(); ++port_iter) {
2922 mmc_out_ptr->connect (*port_iter);
2930 /** Caller must not hold process lock
2931 * @param name_template string to use for the start of the name, or "" to use "Audio".
2933 list< boost::shared_ptr<AudioTrack> >
2934 Session::new_audio_track (int input_channels, int output_channels, TrackMode mode, RouteGroup* route_group,
2935 uint32_t how_many, string name_template)
2938 uint32_t track_id = 0;
2940 RouteList new_routes;
2941 list<boost::shared_ptr<AudioTrack> > ret;
2943 const string name_pattern = default_track_name_pattern (DataType::AUDIO);
2944 bool const use_number = (how_many != 1) || name_template.empty () || (name_template == name_pattern);
2948 if (!find_route_name (name_template.empty() ? _(name_pattern.c_str()) : name_template, ++track_id, track_name, use_number)) {
2949 error << "cannot find name for new audio track" << endmsg;
2953 boost::shared_ptr<AudioTrack> track;
2956 track.reset (new AudioTrack (*this, track_name, Route::Flag (0), mode));
2958 if (track->init ()) {
2962 if (Profile->get_mixbus ()) {
2963 track->set_strict_io (true);
2967 if (ARDOUR::Profile->get_trx ()) {
2968 // TRACKS considers it's not a USE CASE, it's
2969 // a piece of behavior of the session model:
2971 // Gain for a newly created route depends on
2972 // the current output_auto_connect mode:
2974 // 0 for Stereo Out mode
2976 if (Config->get_output_auto_connect() & AutoConnectMaster) {
2977 track->set_gain (dB_to_coefficient (0), Controllable::NoGroup);
2981 track->use_new_diskstream();
2983 BOOST_MARK_TRACK (track);
2986 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
2988 if (track->input()->ensure_io (ChanCount(DataType::AUDIO, input_channels), false, this)) {
2989 error << string_compose (
2990 _("cannot configure %1 in/%2 out configuration for new audio track"),
2991 input_channels, output_channels)
2996 if (track->output()->ensure_io (ChanCount(DataType::AUDIO, output_channels), false, this)) {
2997 error << string_compose (
2998 _("cannot configure %1 in/%2 out configuration for new audio track"),
2999 input_channels, output_channels)
3006 route_group->add (track);
3009 track->non_realtime_input_change();
3011 track->DiskstreamChanged.connect_same_thread (*this, boost::bind (&Session::resort_routes, this));
3012 if (Config->get_remote_model() == UserOrdered) {
3013 track->set_remote_control_id (next_control_id());
3016 new_routes.push_back (track);
3017 ret.push_back (track);
3019 RouteAddedOrRemoved (true); /* EMIT SIGNAL */
3022 catch (failed_constructor &err) {
3023 error << _("Session: could not create new audio track.") << endmsg;
3027 catch (AudioEngine::PortRegistrationFailure& pfe) {
3029 error << pfe.what() << endmsg;
3037 if (!new_routes.empty()) {
3038 StateProtector sp (this);
3039 if (Profile->get_trx()) {
3040 add_routes (new_routes, false, false, false);
3042 add_routes (new_routes, true, true, false);
3049 /** Caller must not hold process lock.
3050 * @param name_template string to use for the start of the name, or "" to use "Bus".
3053 Session::new_audio_route (int input_channels, int output_channels, RouteGroup* route_group, uint32_t how_many, string name_template)
3056 uint32_t bus_id = 0;
3060 bool const use_number = (how_many != 1) || name_template.empty () || name_template == _("Bus");
3063 if (!find_route_name (name_template.empty () ? _("Bus") : name_template, ++bus_id, bus_name, use_number)) {
3064 error << "cannot find name for new audio bus" << endmsg;
3069 boost::shared_ptr<Route> bus (new Route (*this, bus_name, Route::Flag(0), DataType::AUDIO));
3075 if (Profile->get_mixbus ()) {
3076 bus->set_strict_io (true);
3079 BOOST_MARK_ROUTE(bus);
3082 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
3084 if (bus->input()->ensure_io (ChanCount(DataType::AUDIO, input_channels), false, this)) {
3085 error << string_compose (_("cannot configure %1 in/%2 out configuration for new audio track"),
3086 input_channels, output_channels)
3092 if (bus->output()->ensure_io (ChanCount(DataType::AUDIO, output_channels), false, this)) {
3093 error << string_compose (_("cannot configure %1 in/%2 out configuration for new audio track"),
3094 input_channels, output_channels)
3101 route_group->add (bus);
3103 if (Config->get_remote_model() == UserOrdered) {
3104 bus->set_remote_control_id (next_control_id());
3107 bus->add_internal_return ();
3109 ret.push_back (bus);
3111 RouteAddedOrRemoved (true); /* EMIT SIGNAL */
3117 catch (failed_constructor &err) {
3118 error << _("Session: could not create new audio route.") << endmsg;
3122 catch (AudioEngine::PortRegistrationFailure& pfe) {
3123 error << pfe.what() << endmsg;
3133 StateProtector sp (this);
3134 if (Profile->get_trx()) {
3135 add_routes (ret, false, false, false);
3137 add_routes (ret, false, true, true); // autoconnect // outputs only
3146 Session::new_route_from_template (uint32_t how_many, const std::string& template_path, const std::string& name_base, PlaylistDisposition pd)
3150 if (!tree.read (template_path.c_str())) {
3154 return new_route_from_template (how_many, *tree.root(), name_base, pd);
3158 Session::new_route_from_template (uint32_t how_many, XMLNode& node, const std::string& name_base, PlaylistDisposition pd)
3161 uint32_t control_id;
3162 uint32_t number = 0;
3163 const uint32_t being_added = how_many;
3164 /* This will prevent the use of any existing XML-provided PBD::ID
3167 Stateful::ForceIDRegeneration force_ids;
3168 IO::disable_connecting ();
3170 control_id = next_control_id ();
3174 /* We're going to modify the node contents a bit so take a
3175 * copy. The node may be re-used when duplicating more than once.
3178 XMLNode node_copy (node);
3183 if (!name_base.empty()) {
3185 /* if we're adding more than one routes, force
3186 * all the names of the new routes to be
3187 * numbered, via the final parameter.
3190 if (!find_route_name (name_base.c_str(), ++number, name, (being_added > 1))) {
3191 fatal << _("Session: UINT_MAX routes? impossible!") << endmsg;
3197 string const route_name = node_copy.property(X_("name"))->value ();
3199 /* generate a new name by adding a number to the end of the template name */
3200 if (!find_route_name (route_name.c_str(), ++number, name, true)) {
3201 fatal << _("Session: UINT_MAX routes? impossible!") << endmsg;
3202 abort(); /*NOTREACHED*/
3206 /* set this name in the XML description that we are about to use */
3208 bool rename_playlist;
3211 rename_playlist = true;
3215 rename_playlist = false;
3218 Route::set_name_in_state (node_copy, name, rename_playlist);
3220 /* trim bitslots from listen sends so that new ones are used */
3221 XMLNodeList children = node_copy.children ();
3222 for (XMLNodeList::iterator i = children.begin(); i != children.end(); ++i) {
3223 if ((*i)->name() == X_("Processor")) {
3224 /* ForceIDRegeneration does not catch the following */
3225 XMLProperty const * role = (*i)->property (X_("role"));
3226 XMLProperty const * type = (*i)->property (X_("type"));
3227 if (role && role->value() == X_("Aux")) {
3228 /* check if the target bus exists.
3229 * we should not save aux-sends in templates.
3231 XMLProperty const * target = (*i)->property (X_("target"));
3233 (*i)->add_property ("type", "dangling-aux-send");
3236 boost::shared_ptr<Route> r = route_by_id (target->value());
3237 if (!r || boost::dynamic_pointer_cast<Track>(r)) {
3238 (*i)->add_property ("type", "dangling-aux-send");
3242 if (role && role->value() == X_("Listen")) {
3243 (*i)->remove_property (X_("bitslot"));
3245 else if (role && (role->value() == X_("Send") || role->value() == X_("Aux"))) {
3247 Delivery::Role xrole;
3248 uint32_t bitslot = 0;
3249 xrole = Delivery::Role (string_2_enum (role->value(), xrole));
3250 std::string name = Send::name_and_id_new_send(*this, xrole, bitslot, false);
3251 snprintf (buf, sizeof (buf), "%" PRIu32, bitslot);
3252 (*i)->remove_property (X_("bitslot"));
3253 (*i)->remove_property (X_("name"));
3254 (*i)->add_property ("bitslot", buf);
3255 (*i)->add_property ("name", name);
3257 else if (type && type->value() == X_("return")) {
3258 // Return::set_state() generates a new one
3259 (*i)->remove_property (X_("bitslot"));
3261 else if (type && type->value() == X_("port")) {
3262 // PortInsert::set_state() handles the bitslot
3263 (*i)->remove_property (X_("bitslot"));
3264 (*i)->add_property ("ignore-name", "1");
3269 boost::shared_ptr<Route> route (XMLRouteFactory (node_copy, 3000));
3272 error << _("Session: cannot create track/bus from template description") << endmsg;
3276 if (boost::dynamic_pointer_cast<Track>(route)) {
3277 /* force input/output change signals so that the new diskstream
3278 picks up the configuration of the route. During session
3279 loading this normally happens in a different way.
3282 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
3284 IOChange change (IOChange::Type (IOChange::ConfigurationChanged | IOChange::ConnectionsChanged));
3285 change.after = route->input()->n_ports();
3286 route->input()->changed (change, this);
3287 change.after = route->output()->n_ports();
3288 route->output()->changed (change, this);
3291 route->set_remote_control_id (control_id);
3294 boost::shared_ptr<Track> track;
3296 if ((track = boost::dynamic_pointer_cast<Track> (route))) {
3299 track->use_new_playlist ();
3302 track->use_copy_playlist ();
3309 ret.push_back (route);
3311 RouteAddedOrRemoved (true); /* EMIT SIGNAL */
3314 catch (failed_constructor &err) {
3315 error << _("Session: could not create new route from template") << endmsg;
3319 catch (AudioEngine::PortRegistrationFailure& pfe) {
3320 error << pfe.what() << endmsg;
3329 StateProtector sp (this);
3330 if (Profile->get_trx()) {
3331 add_routes (ret, false, false, false);
3333 add_routes (ret, true, true, false);
3335 IO::enable_connecting ();
3342 Session::add_routes (RouteList& new_routes, bool input_auto_connect, bool output_auto_connect, bool save)
3345 PBD::Unwinder<bool> aip (_adding_routes_in_progress, true);
3346 add_routes_inner (new_routes, input_auto_connect, output_auto_connect);
3349 error << _("Adding new tracks/busses failed") << endmsg;
3354 update_latency (true);
3355 update_latency (false);
3360 save_state (_current_snapshot_name);
3363 reassign_track_numbers();
3365 update_route_record_state ();
3367 RouteAdded (new_routes); /* EMIT SIGNAL */
3371 Session::add_routes_inner (RouteList& new_routes, bool input_auto_connect, bool output_auto_connect)
3373 ChanCount existing_inputs;
3374 ChanCount existing_outputs;
3375 uint32_t order = next_control_id();
3378 if (_order_hint > -1) {
3379 order = _order_hint;
3383 count_existing_track_channels (existing_inputs, existing_outputs);
3386 RCUWriter<RouteList> writer (routes);
3387 boost::shared_ptr<RouteList> r = writer.get_copy ();
3388 r->insert (r->end(), new_routes.begin(), new_routes.end());
3390 /* if there is no control out and we're not in the middle of loading,
3391 * resort the graph here. if there is a control out, we will resort
3392 * toward the end of this method. if we are in the middle of loading,
3393 * we will resort when done.
3396 if (!_monitor_out && IO::connecting_legal) {
3397 resort_routes_using (r);
3401 for (RouteList::iterator x = new_routes.begin(); x != new_routes.end(); ++x) {
3403 boost::weak_ptr<Route> wpr (*x);
3404 boost::shared_ptr<Route> r (*x);
3406 r->listen_changed.connect_same_thread (*this, boost::bind (&Session::route_listen_changed, this, _1, wpr));
3407 r->solo_changed.connect_same_thread (*this, boost::bind (&Session::route_solo_changed, this, _1, _2, wpr));
3408 r->solo_isolated_changed.connect_same_thread (*this, boost::bind (&Session::route_solo_isolated_changed, this, wpr));
3409 r->mute_changed.connect_same_thread (*this, boost::bind (&Session::route_mute_changed, this));
3410 r->output()->changed.connect_same_thread (*this, boost::bind (&Session::set_worst_io_latencies_x, this, _1, _2));
3411 r->processors_changed.connect_same_thread (*this, boost::bind (&Session::route_processors_changed, this, _1));
3413 if (r->is_master()) {
3417 if (r->is_monitor()) {
3421 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (r);
3423 tr->PlaylistChanged.connect_same_thread (*this, boost::bind (&Session::track_playlist_changed, this, boost::weak_ptr<Track> (tr)));
3424 track_playlist_changed (boost::weak_ptr<Track> (tr));
3425 tr->RecordEnableChanged.connect_same_thread (*this, boost::bind (&Session::update_route_record_state, this));
3427 boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (tr);
3429 mt->StepEditStatusChange.connect_same_thread (*this, boost::bind (&Session::step_edit_status_change, this, _1));
3430 mt->output()->changed.connect_same_thread (*this, boost::bind (&Session::midi_output_change_handler, this, _1, _2, boost::weak_ptr<Route>(mt)));
3434 if (input_auto_connect || output_auto_connect) {
3435 auto_connect_route (r, input_auto_connect, ChanCount (), ChanCount (), existing_inputs, existing_outputs);
3436 existing_inputs += r->n_inputs();
3437 existing_outputs += r->n_outputs();
3440 /* order keys are a GUI responsibility but we need to set up
3441 reasonable defaults because they also affect the remote control
3442 ID in most situations.
3445 if (!r->has_order_key ()) {
3446 if (r->is_auditioner()) {
3447 /* use an arbitrarily high value */
3448 r->set_order_key (UINT_MAX);
3450 DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("while adding, set %1 to order key %2\n", r->name(), order));
3451 r->set_order_key (order);
3459 if (_monitor_out && IO::connecting_legal) {
3460 Glib::Threads::Mutex::Lock lm (_engine.process_lock());
3462 for (RouteList::iterator x = new_routes.begin(); x != new_routes.end(); ++x) {
3463 if ((*x)->is_monitor()) {
3465 } else if ((*x)->is_master()) {
3468 (*x)->enable_monitor_send ();
3475 Session::globally_set_send_gains_to_zero (boost::shared_ptr<Route> dest)
3477 boost::shared_ptr<RouteList> r = routes.reader ();
3478 boost::shared_ptr<Send> s;
3480 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3481 if ((s = (*i)->internal_send_for (dest)) != 0) {
3482 s->amp()->gain_control()->set_value (GAIN_COEFF_ZERO, Controllable::NoGroup);
3488 Session::globally_set_send_gains_to_unity (boost::shared_ptr<Route> dest)
3490 boost::shared_ptr<RouteList> r = routes.reader ();
3491 boost::shared_ptr<Send> s;
3493 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3494 if ((s = (*i)->internal_send_for (dest)) != 0) {
3495 s->amp()->gain_control()->set_value (GAIN_COEFF_UNITY, Controllable::NoGroup);
3501 Session::globally_set_send_gains_from_track(boost::shared_ptr<Route> dest)
3503 boost::shared_ptr<RouteList> r = routes.reader ();
3504 boost::shared_ptr<Send> s;
3506 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3507 if ((s = (*i)->internal_send_for (dest)) != 0) {
3508 s->amp()->gain_control()->set_value ((*i)->gain_control()->get_value(), Controllable::NoGroup);
3513 /** @param include_buses true to add sends to buses and tracks, false for just tracks */
3515 Session::globally_add_internal_sends (boost::shared_ptr<Route> dest, Placement p, bool include_buses)
3517 boost::shared_ptr<RouteList> r = routes.reader ();
3518 boost::shared_ptr<RouteList> t (new RouteList);
3520 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3521 /* no MIDI sends because there are no MIDI busses yet */
3522 if (include_buses || boost::dynamic_pointer_cast<AudioTrack>(*i)) {
3527 add_internal_sends (dest, p, t);
3531 Session::add_internal_sends (boost::shared_ptr<Route> dest, Placement p, boost::shared_ptr<RouteList> senders)
3533 for (RouteList::iterator i = senders->begin(); i != senders->end(); ++i) {
3534 add_internal_send (dest, (*i)->before_processor_for_placement (p), *i);
3539 Session::add_internal_send (boost::shared_ptr<Route> dest, int index, boost::shared_ptr<Route> sender)
3541 add_internal_send (dest, sender->before_processor_for_index (index), sender);
3545 Session::add_internal_send (boost::shared_ptr<Route> dest, boost::shared_ptr<Processor> before, boost::shared_ptr<Route> sender)
3547 if (sender->is_monitor() || sender->is_master() || sender == dest || dest->is_monitor() || dest->is_master()) {
3551 if (!dest->internal_return()) {
3552 dest->add_internal_return ();
3555 sender->add_aux_send (dest, before);
3561 Session::remove_routes (boost::shared_ptr<RouteList> routes_to_remove)
3563 { // RCU Writer scope
3564 PBD::Unwinder<bool> uw_flag (_route_deletion_in_progress, true);
3565 RCUWriter<RouteList> writer (routes);
3566 boost::shared_ptr<RouteList> rs = writer.get_copy ();
3569 for (RouteList::iterator iter = routes_to_remove->begin(); iter != routes_to_remove->end(); ++iter) {
3571 if (*iter == _master_out) {
3575 (*iter)->set_solo (false, Controllable::NoGroup);
3579 /* deleting the master out seems like a dumb
3580 idea, but its more of a UI policy issue
3584 if (*iter == _master_out) {
3585 _master_out = boost::shared_ptr<Route> ();
3588 if (*iter == _monitor_out) {
3589 _monitor_out.reset ();
3592 // We need to disconnect the route's inputs and outputs
3594 (*iter)->input()->disconnect (0);
3595 (*iter)->output()->disconnect (0);
3597 /* if the route had internal sends sending to it, remove them */
3598 if ((*iter)->internal_return()) {
3600 boost::shared_ptr<RouteList> r = routes.reader ();
3601 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3602 boost::shared_ptr<Send> s = (*i)->internal_send_for (*iter);
3604 (*i)->remove_processor (s);
3609 /* if the monitoring section had a pointer to this route, remove it */
3610 if (_monitor_out && !(*iter)->is_master() && !(*iter)->is_monitor()) {
3611 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
3612 PBD::Unwinder<bool> uw (ignore_route_processor_changes, true);
3613 (*iter)->remove_aux_or_listen (_monitor_out);
3616 boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (*iter);
3617 if (mt && mt->step_editing()) {
3618 if (_step_editors > 0) {
3624 /* writer goes out of scope, forces route list update */
3626 } // end of RCU Writer scope
3628 update_route_solo_state ();
3629 RouteAddedOrRemoved (false); /* EMIT SIGNAL */
3630 update_latency_compensation ();
3633 /* Re-sort routes to remove the graph's current references to the one that is
3634 * going away, then flush old references out of the graph.
3635 * Wave Tracks: reconnect routes
3638 #ifdef USE_TRACKS_CODE_FEATURES
3639 reconnect_existing_routes(true, false);
3641 routes.flush (); // maybe unsafe, see below.
3645 if (_process_graph && !(_state_of_the_state & Deletion)) {
3646 _process_graph->clear_other_chain ();
3649 /* get rid of it from the dead wood collection in the route list manager */
3650 /* XXX i think this is unsafe as it currently stands, but i am not sure. (pd, october 2nd, 2006) */
3654 /* try to cause everyone to drop their references
3655 * and unregister ports from the backend
3658 for (RouteList::iterator iter = routes_to_remove->begin(); iter != routes_to_remove->end(); ++iter) {
3659 (*iter)->drop_references ();
3662 if (_state_of_the_state & Deletion) {
3666 Route::RemoteControlIDChange(); /* EMIT SIGNAL */
3668 /* save the new state of the world */
3670 if (save_state (_current_snapshot_name)) {
3671 save_history (_current_snapshot_name);
3674 reassign_track_numbers();
3675 update_route_record_state ();
3679 Session::remove_route (boost::shared_ptr<Route> route)
3681 boost::shared_ptr<RouteList> rl (new RouteList);
3682 rl->push_back (route);
3687 Session::route_mute_changed ()
3693 Session::route_listen_changed (Controllable::GroupControlDisposition group_override, boost::weak_ptr<Route> wpr)
3695 boost::shared_ptr<Route> route = wpr.lock();
3697 error << string_compose (_("programming error: %1"), X_("invalid route weak ptr passed to route_listen_changed")) << endmsg;
3701 if (route->listening_via_monitor ()) {
3703 if (Config->get_exclusive_solo()) {
3705 RouteGroup* rg = route->route_group ();
3706 const bool group_already_accounted_for = route->use_group (group_override, &RouteGroup::is_solo);
3708 boost::shared_ptr<RouteList> r = routes.reader ();
3710 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3711 if ((*i) == route) {
3712 /* already changed */
3716 if ((*i)->solo_isolated() || (*i)->is_master() || (*i)->is_monitor() || (*i)->is_auditioner()) {
3717 /* route does not get solo propagated to it */
3721 if ((group_already_accounted_for && (*i)->route_group() && (*i)->route_group() == rg)) {
3722 /* this route is a part of the same solo group as the route
3723 * that was changed. Changing that route did change or will
3724 * change all group members appropriately, so we can ignore it
3729 (*i)->set_listen (false, Controllable::NoGroup);
3735 } else if (_listen_cnt > 0) {
3740 update_route_solo_state ();
3743 Session::route_solo_isolated_changed (boost::weak_ptr<Route> wpr)
3745 boost::shared_ptr<Route> route = wpr.lock ();
3748 /* should not happen */
3749 error << string_compose (_("programming error: %1"), X_("invalid route weak ptr passed to route_solo_isolated_changed")) << endmsg;
3753 bool send_changed = false;
3755 if (route->solo_isolated()) {
3756 if (_solo_isolated_cnt == 0) {
3757 send_changed = true;
3759 _solo_isolated_cnt++;
3760 } else if (_solo_isolated_cnt > 0) {
3761 _solo_isolated_cnt--;
3762 if (_solo_isolated_cnt == 0) {
3763 send_changed = true;
3768 IsolatedChanged (); /* EMIT SIGNAL */
3773 Session::route_solo_changed (bool self_solo_change, Controllable::GroupControlDisposition group_override, boost::weak_ptr<Route> wpr)
3775 DEBUG_TRACE (DEBUG::Solo, string_compose ("route solo change, self = %1\n", self_solo_change));
3777 if (!self_solo_change) {
3778 // session doesn't care about changes to soloed-by-others
3782 boost::shared_ptr<Route> route = wpr.lock ();
3785 boost::shared_ptr<RouteList> r = routes.reader ();
3788 if (route->self_soloed()) {
3794 /* the route may be a member of a group that has shared-solo
3795 * semantics. If so, then all members of that group should follow the
3796 * solo of the changed route. But ... this is optional, controlled by a
3797 * Controllable::GroupControlDisposition.
3799 * The first argument to the signal that this method is connected to is the
3800 * GroupControlDisposition value that was used to change solo.
3802 * If the solo change was done with group semantics (either InverseGroup
3803 * (force the entire group to change even if the group shared solo is
3804 * disabled) or UseGroup (use the group, which may or may not have the
3805 * shared solo property enabled)) then as we propagate the change to
3806 * the entire session we should IGNORE THE GROUP that the changed route
3810 RouteGroup* rg = route->route_group ();
3811 const bool group_already_accounted_for = (group_override == Controllable::ForGroup);
3813 if (delta == 1 && Config->get_exclusive_solo()) {
3815 /* new solo: disable all other solos, but not the group if its solo-enabled */
3817 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3819 if ((*i) == route) {
3820 /* already changed */
3824 if ((*i)->solo_isolated() || (*i)->is_master() || (*i)->is_monitor() || (*i)->is_auditioner()) {
3825 /* route does not get solo propagated to it */
3829 if ((group_already_accounted_for && (*i)->route_group() && (*i)->route_group() == rg)) {
3830 /* this route is a part of the same solo group as the route
3831 * that was changed. Changing that route did change or will
3832 * change all group members appropriately, so we can ignore it
3838 (*i)->set_solo (false, group_override);
3842 DEBUG_TRACE (DEBUG::Solo, string_compose ("propagate solo change, delta = %1\n", delta));
3844 RouteList uninvolved;
3846 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1\n", route->name()));
3848 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3849 bool via_sends_only;
3850 bool in_signal_flow;
3852 if ((*i) == route) {
3853 /* already changed */
3857 if ((*i)->solo_isolated() || (*i)->is_master() || (*i)->is_monitor() || (*i)->is_auditioner()) {
3858 /* route does not get solo propagated to it */
3862 if ((group_already_accounted_for && (*i)->route_group() && (*i)->route_group() == rg)) {
3863 /* this route is a part of the same solo group as the route
3864 * that was changed. Changing that route did change or will
3865 * change all group members appropriately, so we can ignore it
3871 in_signal_flow = false;
3873 DEBUG_TRACE (DEBUG::Solo, string_compose ("check feed from %1\n", (*i)->name()));
3875 if ((*i)->feeds (route, &via_sends_only)) {
3876 DEBUG_TRACE (DEBUG::Solo, string_compose ("\tthere is a feed from %1\n", (*i)->name()));
3877 if (!via_sends_only) {
3878 if (!route->soloed_by_others_upstream()) {
3879 (*i)->mod_solo_by_others_downstream (delta);
3881 DEBUG_TRACE (DEBUG::Solo, "\talready soloed by others upstream\n");
3884 DEBUG_TRACE (DEBUG::Solo, string_compose ("\tthere is a send-only feed from %1\n", (*i)->name()));
3886 in_signal_flow = true;
3888 DEBUG_TRACE (DEBUG::Solo, string_compose ("\tno feed from %1\n", (*i)->name()));
3891 DEBUG_TRACE (DEBUG::Solo, string_compose ("check feed to %1\n", (*i)->name()));
3893 if (route->feeds (*i, &via_sends_only)) {
3894 /* propagate solo upstream only if routing other than
3895 sends is involved, but do consider the other route
3896 (*i) to be part of the signal flow even if only
3899 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1 feeds %2 via sends only %3 sboD %4 sboU %5\n",
3903 route->soloed_by_others_downstream(),
3904 route->soloed_by_others_upstream()));
3905 if (!via_sends_only) {
3906 //NB. Triggers Invert Push, which handles soloed by downstream
3907 DEBUG_TRACE (DEBUG::Solo, string_compose ("\tmod %1 by %2\n", (*i)->name(), delta));
3908 (*i)->mod_solo_by_others_upstream (delta);
3910 DEBUG_TRACE (DEBUG::Solo, string_compose ("\tfeed to %1 ignored, sends-only\n", (*i)->name()));
3912 in_signal_flow = true;
3914 DEBUG_TRACE (DEBUG::Solo, "\tno feed to\n");
3917 if (!in_signal_flow) {
3918 uninvolved.push_back (*i);
3922 DEBUG_TRACE (DEBUG::Solo, "propagation complete\n");
3924 update_route_solo_state (r);
3926 /* now notify that the mute state of the routes not involved in the signal
3927 pathway of the just-solo-changed route may have altered.
3930 for (RouteList::iterator i = uninvolved.begin(); i != uninvolved.end(); ++i) {
3931 DEBUG_TRACE (DEBUG::Solo, string_compose ("mute change for %1, which neither feeds or is fed by %2\n", (*i)->name(), route->name()));
3932 (*i)->act_on_mute ();
3933 (*i)->mute_changed ();
3936 SoloChanged (); /* EMIT SIGNAL */
3941 Session::update_route_solo_state (boost::shared_ptr<RouteList> r)
3943 /* now figure out if anything that matters is soloed (or is "listening")*/
3945 bool something_soloed = false;
3946 bool something_listening = false;
3947 uint32_t listeners = 0;
3948 uint32_t isolated = 0;
3951 r = routes.reader();
3954 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3955 if (!(*i)->is_master() && !(*i)->is_monitor() && !(*i)->is_auditioner() && (*i)->self_soloed()) {
3956 something_soloed = true;
3959 if (!(*i)->is_auditioner() && (*i)->listening_via_monitor()) {
3960 if (Config->get_solo_control_is_listen_control()) {
3962 something_listening = true;
3964 (*i)->set_listen (false, Controllable::NoGroup);
3968 if ((*i)->solo_isolated()) {
3973 if (something_soloed != _non_soloed_outs_muted) {
3974 _non_soloed_outs_muted = something_soloed;
3975 SoloActive (_non_soloed_outs_muted); /* EMIT SIGNAL */
3978 if (something_listening != _listening) {
3979 _listening = something_listening;
3980 SoloActive (_listening);
3983 _listen_cnt = listeners;
3985 if (isolated != _solo_isolated_cnt) {
3986 _solo_isolated_cnt = isolated;
3987 IsolatedChanged (); /* EMIT SIGNAL */
3990 DEBUG_TRACE (DEBUG::Solo, string_compose ("solo state updated by session, soloed? %1 listeners %2 isolated %3\n",
3991 something_soloed, listeners, isolated));
3994 boost::shared_ptr<RouteList>
3995 Session::get_routes_with_internal_returns() const
3997 boost::shared_ptr<RouteList> r = routes.reader ();
3998 boost::shared_ptr<RouteList> rl (new RouteList);
4000 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4001 if ((*i)->internal_return ()) {
4009 Session::io_name_is_legal (const std::string& name)
4011 boost::shared_ptr<RouteList> r = routes.reader ();
4013 for (vector<string>::const_iterator reserved = reserved_io_names.begin(); reserved != reserved_io_names.end(); ++reserved) {
4014 if (name == *reserved) {
4015 if (!route_by_name (*reserved)) {
4016 /* first instance of a reserved name is allowed */
4019 /* all other instances of a reserved name are not allowed */
4024 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4025 if ((*i)->name() == name) {
4029 if ((*i)->has_io_processor_named (name)) {
4038 Session::set_exclusive_input_active (boost::shared_ptr<RouteList> rl, bool onoff, bool flip_others)
4041 vector<string> connections;
4043 /* if we are passed only a single route and we're not told to turn
4044 * others off, then just do the simple thing.
4047 if (flip_others == false && rl->size() == 1) {
4048 boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (rl->front());
4050 mt->set_input_active (onoff);
4055 for (RouteList::iterator rt = rl->begin(); rt != rl->end(); ++rt) {
4057 PortSet& ps ((*rt)->input()->ports());
4059 for (PortSet::iterator p = ps.begin(); p != ps.end(); ++p) {
4060 p->get_connections (connections);
4063 for (vector<string>::iterator s = connections.begin(); s != connections.end(); ++s) {
4064 routes_using_input_from (*s, rl2);
4067 /* scan all relevant routes to see if others are on or off */
4069 bool others_are_already_on = false;
4071 for (RouteList::iterator r = rl2.begin(); r != rl2.end(); ++r) {
4073 boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (*r);
4079 if ((*r) != (*rt)) {
4080 if (mt->input_active()) {
4081 others_are_already_on = true;
4084 /* this one needs changing */
4085 mt->set_input_active (onoff);
4091 /* globally reverse other routes */
4093 for (RouteList::iterator r = rl2.begin(); r != rl2.end(); ++r) {
4094 if ((*r) != (*rt)) {
4095 boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (*r);
4097 mt->set_input_active (!others_are_already_on);
4106 Session::routes_using_input_from (const string& str, RouteList& rl)
4108 boost::shared_ptr<RouteList> r = routes.reader();
4110 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4111 if ((*i)->input()->connected_to (str)) {
4117 boost::shared_ptr<Route>
4118 Session::route_by_name (string name)
4120 boost::shared_ptr<RouteList> r = routes.reader ();
4122 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4123 if ((*i)->name() == name) {
4128 return boost::shared_ptr<Route> ((Route*) 0);
4131 boost::shared_ptr<Route>
4132 Session::route_by_id (PBD::ID id)
4134 boost::shared_ptr<RouteList> r = routes.reader ();
4136 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4137 if ((*i)->id() == id) {
4142 return boost::shared_ptr<Route> ((Route*) 0);
4145 boost::shared_ptr<Processor>
4146 Session::processor_by_id (PBD::ID id) const
4148 boost::shared_ptr<RouteList> r = routes.reader ();
4150 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4151 boost::shared_ptr<Processor> p = (*i)->Route::processor_by_id (id);
4157 return boost::shared_ptr<Processor> ();
4160 boost::shared_ptr<Track>
4161 Session::track_by_diskstream_id (PBD::ID id)
4163 boost::shared_ptr<RouteList> r = routes.reader ();
4165 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4166 boost::shared_ptr<Track> t = boost::dynamic_pointer_cast<Track> (*i);
4167 if (t && t->using_diskstream_id (id)) {
4172 return boost::shared_ptr<Track> ();
4175 boost::shared_ptr<Route>
4176 Session::route_by_remote_id (uint32_t id)
4178 boost::shared_ptr<RouteList> r = routes.reader ();
4180 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4181 if ((*i)->remote_control_id() == id) {
4186 return boost::shared_ptr<Route> ((Route*) 0);
4190 boost::shared_ptr<Route>
4191 Session::route_by_selected_count (uint32_t id)
4193 boost::shared_ptr<RouteList> r = routes.reader ();
4195 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4196 /* NOT IMPLEMENTED */
4199 return boost::shared_ptr<Route> ((Route*) 0);
4204 Session::reassign_track_numbers ()
4208 RouteList r (*(routes.reader ()));
4209 SignalOrderRouteSorter sorter;
4212 StateProtector sp (this);
4214 for (RouteList::iterator i = r.begin(); i != r.end(); ++i) {
4215 if (boost::dynamic_pointer_cast<Track> (*i)) {
4216 (*i)->set_track_number(++tn);
4218 else if (!(*i)->is_master() && !(*i)->is_monitor() && !(*i)->is_auditioner()) {
4219 (*i)->set_track_number(--bn);
4222 const uint32_t decimals = ceilf (log10f (tn + 1));
4223 const bool decimals_changed = _track_number_decimals != decimals;
4224 _track_number_decimals = decimals;
4226 if (decimals_changed && config.get_track_name_number ()) {
4227 for (RouteList::iterator i = r.begin(); i != r.end(); ++i) {
4228 boost::shared_ptr<Track> t = boost::dynamic_pointer_cast<Track> (*i);
4230 t->resync_track_name();
4233 // trigger GUI re-layout
4234 config.ParameterChanged("track-name-number");
4239 Session::playlist_region_added (boost::weak_ptr<Region> w)
4241 boost::shared_ptr<Region> r = w.lock ();
4246 /* These are the operations that are currently in progress... */
4247 list<GQuark> curr = _current_trans_quarks;
4250 /* ...and these are the operations during which we want to update
4251 the session range location markers.
4254 ops.push_back (Operations::capture);
4255 ops.push_back (Operations::paste);
4256 ops.push_back (Operations::duplicate_region);
4257 ops.push_back (Operations::insert_file);
4258 ops.push_back (Operations::insert_region);
4259 ops.push_back (Operations::drag_region_brush);
4260 ops.push_back (Operations::region_drag);
4261 ops.push_back (Operations::selection_grab);
4262 ops.push_back (Operations::region_fill);
4263 ops.push_back (Operations::fill_selection);
4264 ops.push_back (Operations::create_region);
4265 ops.push_back (Operations::region_copy);
4266 ops.push_back (Operations::fixed_time_region_copy);
4269 /* See if any of the current operations match the ones that we want */
4271 set_intersection (_current_trans_quarks.begin(), _current_trans_quarks.end(), ops.begin(), ops.end(), back_inserter (in));
4273 /* If so, update the session range markers */
4275 maybe_update_session_range (r->position (), r->last_frame ());
4279 /** Update the session range markers if a is before the current start or
4280 * b is after the current end.
4283 Session::maybe_update_session_range (framepos_t a, framepos_t b)
4285 if (_state_of_the_state & Loading) {
4289 framepos_t session_end_marker_shift_samples = session_end_shift * _nominal_frame_rate;
4291 if (_session_range_location == 0) {
4293 set_session_range_location (a, b + session_end_marker_shift_samples);
4297 if (a < _session_range_location->start()) {
4298 _session_range_location->set_start (a);
4301 if (b > _session_range_location->end()) {
4302 _session_range_location->set_end (b);
4308 Session::playlist_ranges_moved (list<Evoral::RangeMove<framepos_t> > const & ranges)
4310 for (list<Evoral::RangeMove<framepos_t> >::const_iterator i = ranges.begin(); i != ranges.end(); ++i) {
4311 maybe_update_session_range (i->to, i->to + i->length);
4316 Session::playlist_regions_extended (list<Evoral::Range<framepos_t> > const & ranges)
4318 for (list<Evoral::Range<framepos_t> >::const_iterator i = ranges.begin(); i != ranges.end(); ++i) {
4319 maybe_update_session_range (i->from, i->to);
4323 /* Region management */
4325 boost::shared_ptr<Region>
4326 Session::find_whole_file_parent (boost::shared_ptr<Region const> child) const
4328 const RegionFactory::RegionMap& regions (RegionFactory::regions());
4329 RegionFactory::RegionMap::const_iterator i;
4330 boost::shared_ptr<Region> region;
4332 Glib::Threads::Mutex::Lock lm (region_lock);
4334 for (i = regions.begin(); i != regions.end(); ++i) {
4338 if (region->whole_file()) {
4340 if (child->source_equivalent (region)) {
4346 return boost::shared_ptr<Region> ();
4350 Session::destroy_sources (list<boost::shared_ptr<Source> > srcs)
4352 set<boost::shared_ptr<Region> > relevant_regions;
4354 for (list<boost::shared_ptr<Source> >::iterator s = srcs.begin(); s != srcs.end(); ++s) {
4355 RegionFactory::get_regions_using_source (*s, relevant_regions);
4358 for (set<boost::shared_ptr<Region> >::iterator r = relevant_regions.begin(); r != relevant_regions.end(); ) {
4359 set<boost::shared_ptr<Region> >::iterator tmp;
4364 playlists->destroy_region (*r);
4365 RegionFactory::map_remove (*r);
4367 (*r)->drop_sources ();
4368 (*r)->drop_references ();
4370 relevant_regions.erase (r);
4375 for (list<boost::shared_ptr<Source> >::iterator s = srcs.begin(); s != srcs.end(); ) {
4378 Glib::Threads::Mutex::Lock ls (source_lock);
4379 /* remove from the main source list */
4380 sources.erase ((*s)->id());
4383 (*s)->mark_for_remove ();
4384 (*s)->drop_references ();
4393 Session::remove_last_capture ()
4395 list<boost::shared_ptr<Source> > srcs;
4397 boost::shared_ptr<RouteList> rl = routes.reader ();
4398 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
4399 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
4404 list<boost::shared_ptr<Source> >& l = tr->last_capture_sources();
4407 srcs.insert (srcs.end(), l.begin(), l.end());
4412 destroy_sources (srcs);
4414 save_state (_current_snapshot_name);
4419 /* Source Management */
4422 Session::add_source (boost::shared_ptr<Source> source)
4424 pair<SourceMap::key_type, SourceMap::mapped_type> entry;
4425 pair<SourceMap::iterator,bool> result;
4427 entry.first = source->id();
4428 entry.second = source;
4431 Glib::Threads::Mutex::Lock lm (source_lock);
4432 result = sources.insert (entry);
4435 if (result.second) {
4437 /* yay, new source */
4439 boost::shared_ptr<FileSource> fs = boost::dynamic_pointer_cast<FileSource> (source);
4442 if (!fs->within_session()) {
4443 ensure_search_path_includes (Glib::path_get_dirname (fs->path()), fs->type());
4449 boost::shared_ptr<AudioFileSource> afs;
4451 if ((afs = boost::dynamic_pointer_cast<AudioFileSource>(source)) != 0) {
4452 if (Config->get_auto_analyse_audio()) {
4453 Analyser::queue_source_for_analysis (source, false);
4457 source->DropReferences.connect_same_thread (*this, boost::bind (&Session::remove_source, this, boost::weak_ptr<Source> (source)));
4462 Session::remove_source (boost::weak_ptr<Source> src)
4464 if (_state_of_the_state & Deletion) {
4468 SourceMap::iterator i;
4469 boost::shared_ptr<Source> source = src.lock();
4476 Glib::Threads::Mutex::Lock lm (source_lock);
4478 if ((i = sources.find (source->id())) != sources.end()) {
4483 if (!(_state_of_the_state & StateOfTheState (InCleanup|Loading))) {
4485 /* save state so we don't end up with a session file
4486 referring to non-existent sources.
4489 save_state (_current_snapshot_name);
4493 boost::shared_ptr<Source>
4494 Session::source_by_id (const PBD::ID& id)
4496 Glib::Threads::Mutex::Lock lm (source_lock);
4497 SourceMap::iterator i;
4498 boost::shared_ptr<Source> source;
4500 if ((i = sources.find (id)) != sources.end()) {
4507 boost::shared_ptr<AudioFileSource>
4508 Session::audio_source_by_path_and_channel (const string& path, uint16_t chn) const
4510 /* Restricted to audio files because only audio sources have channel
4514 Glib::Threads::Mutex::Lock lm (source_lock);
4516 for (SourceMap::const_iterator i = sources.begin(); i != sources.end(); ++i) {
4517 boost::shared_ptr<AudioFileSource> afs
4518 = boost::dynamic_pointer_cast<AudioFileSource>(i->second);
4520 if (afs && afs->path() == path && chn == afs->channel()) {
4525 return boost::shared_ptr<AudioFileSource>();
4528 boost::shared_ptr<MidiSource>
4529 Session::midi_source_by_path (const std::string& path) const
4531 /* Restricted to MIDI files because audio sources require a channel
4532 for unique identification, in addition to a path.
4535 Glib::Threads::Mutex::Lock lm (source_lock);
4537 for (SourceMap::const_iterator s = sources.begin(); s != sources.end(); ++s) {
4538 boost::shared_ptr<MidiSource> ms
4539 = boost::dynamic_pointer_cast<MidiSource>(s->second);
4540 boost::shared_ptr<FileSource> fs
4541 = boost::dynamic_pointer_cast<FileSource>(s->second);
4543 if (ms && fs && fs->path() == path) {
4548 return boost::shared_ptr<MidiSource>();
4552 Session::count_sources_by_origin (const string& path)
4555 Glib::Threads::Mutex::Lock lm (source_lock);
4557 for (SourceMap::iterator i = sources.begin(); i != sources.end(); ++i) {
4558 boost::shared_ptr<FileSource> fs
4559 = boost::dynamic_pointer_cast<FileSource>(i->second);
4561 if (fs && fs->origin() == path) {
4570 peak_file_helper (const string& peak_path, const string& file_path, const string& file_base, bool hash) {
4572 std::string checksum = Glib::Checksum::compute_checksum(Glib::Checksum::CHECKSUM_SHA1, file_path + G_DIR_SEPARATOR + file_base);
4573 return Glib::build_filename (peak_path, checksum + peakfile_suffix);
4575 return Glib::build_filename (peak_path, file_base + peakfile_suffix);
4580 Session::construct_peak_filepath (const string& filepath, const bool in_session, const bool old_peak_name) const
4582 string interchange_dir_string = string (interchange_dir_name) + G_DIR_SEPARATOR;
4584 if (Glib::path_is_absolute (filepath)) {
4586 /* rip the session dir from the audiofile source */
4588 string session_path;
4589 bool in_another_session = true;
4591 if (filepath.find (interchange_dir_string) != string::npos) {
4593 session_path = Glib::path_get_dirname (filepath); /* now ends in audiofiles */
4594 session_path = Glib::path_get_dirname (session_path); /* now ends in session name */
4595 session_path = Glib::path_get_dirname (session_path); /* now ends in interchange */
4596 session_path = Glib::path_get_dirname (session_path); /* now has session path */
4598 /* see if it is within our session */
4600 for (vector<space_and_path>::const_iterator i = session_dirs.begin(); i != session_dirs.end(); ++i) {
4601 if (i->path == session_path) {
4602 in_another_session = false;
4607 in_another_session = false;
4611 if (in_another_session) {
4612 SessionDirectory sd (session_path);
4613 return peak_file_helper (sd.peak_path(), "", Glib::path_get_basename (filepath), !old_peak_name);
4617 /* 1) if file belongs to this session
4618 * it may be a relative path (interchange/...)
4619 * or just basename (session_state, remove source)
4620 * -> just use the basename
4622 std::string filename = Glib::path_get_basename (filepath);
4625 /* 2) if the file is outside our session dir:
4626 * (imported but not copied) add the path for check-summming */
4628 path = Glib::path_get_dirname (filepath);
4631 return peak_file_helper (_session_dir->peak_path(), path, Glib::path_get_basename (filepath), !old_peak_name);
4635 Session::new_audio_source_path_for_embedded (const std::string& path)
4639 * we know that the filename is already unique because it exists
4640 * out in the filesystem.
4642 * However, when we bring it into the session, we could get a
4645 * Eg. two embedded files:
4650 * When merged into session, these collide.
4652 * There will not be a conflict with in-memory sources
4653 * because when the source was created we already picked
4654 * a unique name for it.
4656 * This collision is not likely to be common, but we have to guard
4657 * against it. So, if there is a collision, take the md5 hash of the
4658 * the path, and use that as the filename instead.
4661 SessionDirectory sdir (get_best_session_directory_for_new_audio());
4662 string base = Glib::path_get_basename (path);
4663 string newpath = Glib::build_filename (sdir.sound_path(), base);
4665 if (Glib::file_test (newpath, Glib::FILE_TEST_EXISTS)) {
4669 md5.digestString (path.c_str());
4670 md5.writeToString ();
4671 base = md5.digestChars;
4673 string ext = get_suffix (path);
4680 newpath = Glib::build_filename (sdir.sound_path(), base);
4682 /* if this collides, we're screwed */
4684 if (Glib::file_test (newpath, Glib::FILE_TEST_EXISTS)) {
4685 error << string_compose (_("Merging embedded file %1: name collision AND md5 hash collision!"), path) << endmsg;
4694 /** Return true if there are no audio file sources that use @param name as
4695 * the filename component of their path.
4697 * Return false otherwise.
4699 * This method MUST ONLY be used to check in-session, mono files since it
4700 * hard-codes the channel of the audio file source we are looking for as zero.
4702 * If/when Ardour supports native files in non-mono formats, the logic here
4703 * will need to be revisited.
4706 Session::audio_source_name_is_unique (const string& name)
4708 std::vector<string> sdirs = source_search_path (DataType::AUDIO);
4709 vector<space_and_path>::iterator i;
4710 uint32_t existing = 0;
4712 for (vector<string>::const_iterator i = sdirs.begin(); i != sdirs.end(); ++i) {
4714 /* note that we search *without* the extension so that
4715 we don't end up both "Audio 1-1.wav" and "Audio 1-1.caf"
4716 in the event that this new name is required for
4717 a file format change.
4720 const string spath = *i;
4722 if (matching_unsuffixed_filename_exists_in (spath, name)) {
4727 /* it is possible that we have the path already
4728 * assigned to a source that has not yet been written
4729 * (ie. the write source for a diskstream). we have to
4730 * check this in order to make sure that our candidate
4731 * path isn't used again, because that can lead to
4732 * two Sources point to the same file with different
4733 * notions of their removability.
4737 string possible_path = Glib::build_filename (spath, name);
4739 if (audio_source_by_path_and_channel (possible_path, 0)) {
4745 return (existing == 0);
4749 Session::format_audio_source_name (const string& legalized_base, uint32_t nchan, uint32_t chan, bool destructive, bool take_required, uint32_t cnt, bool related_exists)
4752 const string ext = native_header_format_extension (config.get_native_file_header_format(), DataType::AUDIO);
4754 if (Profile->get_trx() && destructive) {
4756 sstr << setfill ('0') << setw (4) << cnt;
4757 sstr << legalized_base;
4759 sstr << legalized_base;
4761 if (take_required || related_exists) {
4773 } else if (nchan > 2) {
4778 /* XXX what? more than 26 channels! */
4789 /** Return a unique name based on \a base for a new internal audio source */
4791 Session::new_audio_source_path (const string& base, uint32_t nchan, uint32_t chan, bool destructive, bool take_required)
4794 string possible_name;
4795 const uint32_t limit = 9999; // arbitrary limit on number of files with the same basic name
4797 bool some_related_source_name_exists = false;
4799 legalized = legalize_for_path (base);
4801 // Find a "version" of the base name that doesn't exist in any of the possible directories.
4803 for (cnt = (destructive ? ++destructive_index : 1); cnt <= limit; ++cnt) {
4805 possible_name = format_audio_source_name (legalized, nchan, chan, destructive, take_required, cnt, some_related_source_name_exists);
4807 if (audio_source_name_is_unique (possible_name)) {
4811 some_related_source_name_exists = true;
4814 error << string_compose(
4815 _("There are already %1 recordings for %2, which I consider too many."),
4816 limit, base) << endmsg;
4818 throw failed_constructor();
4822 /* We've established that the new name does not exist in any session
4823 * directory, so now find out which one we should use for this new
4827 SessionDirectory sdir (get_best_session_directory_for_new_audio());
4829 std::string s = Glib::build_filename (sdir.sound_path(), possible_name);
4834 /** Return a unique name based on `base` for a new internal MIDI source */
4836 Session::new_midi_source_path (const string& base)
4839 char buf[PATH_MAX+1];
4840 const uint32_t limit = 10000;
4842 string possible_path;
4843 string possible_name;
4846 legalized = legalize_for_path (base);
4848 // Find a "version" of the file name that doesn't exist in any of the possible directories.
4849 std::vector<string> sdirs = source_search_path(DataType::MIDI);
4851 /* - the main session folder is the first in the vector.
4852 * - after checking all locations for file-name uniqueness,
4853 * we keep the one from the last iteration as new file name
4854 * - midi files are small and should just be kept in the main session-folder
4856 * -> reverse the array, check main session folder last and use that as location
4859 std::reverse(sdirs.begin(), sdirs.end());
4861 for (cnt = 1; cnt <= limit; ++cnt) {
4863 vector<space_and_path>::iterator i;
4864 uint32_t existing = 0;
4866 for (vector<string>::const_iterator i = sdirs.begin(); i != sdirs.end(); ++i) {
4868 snprintf (buf, sizeof(buf), "%s-%u.mid", legalized.c_str(), cnt);
4869 possible_name = buf;
4871 possible_path = Glib::build_filename (*i, possible_name);
4873 if (Glib::file_test (possible_path, Glib::FILE_TEST_EXISTS)) {
4877 if (midi_source_by_path (possible_path)) {
4882 if (existing == 0) {
4887 error << string_compose(
4888 _("There are already %1 recordings for %2, which I consider too many."),
4889 limit, base) << endmsg;
4895 /* No need to "find best location" for software/app-based RAID, because
4896 MIDI is so small that we always put it in the same place.
4899 return possible_path;
4903 /** Create a new within-session audio source */
4904 boost::shared_ptr<AudioFileSource>
4905 Session::create_audio_source_for_session (size_t n_chans, string const & base, uint32_t chan, bool destructive)
4907 const string path = new_audio_source_path (base, n_chans, chan, destructive, true);
4909 if (!path.empty()) {
4910 return boost::dynamic_pointer_cast<AudioFileSource> (
4911 SourceFactory::createWritable (DataType::AUDIO, *this, path, destructive, frame_rate(), true, true));
4913 throw failed_constructor ();
4917 /** Create a new within-session MIDI source */
4918 boost::shared_ptr<MidiSource>
4919 Session::create_midi_source_for_session (string const & basic_name)
4921 const string path = new_midi_source_path (basic_name);
4923 if (!path.empty()) {
4924 return boost::dynamic_pointer_cast<SMFSource> (
4925 SourceFactory::createWritable (
4926 DataType::MIDI, *this, path, false, frame_rate()));
4928 throw failed_constructor ();
4932 /** Create a new within-session MIDI source */
4933 boost::shared_ptr<MidiSource>
4934 Session::create_midi_source_by_stealing_name (boost::shared_ptr<Track> track)
4936 /* the caller passes in the track the source will be used in,
4937 so that we can keep the numbering sane.
4939 Rationale: a track with the name "Foo" that has had N
4940 captures carried out so far will ALREADY have a write source
4941 named "Foo-N+1.mid" waiting to be used for the next capture.
4943 If we call new_midi_source_name() we will get "Foo-N+2". But
4944 there is no region corresponding to "Foo-N+1", so when
4945 "Foo-N+2" appears in the track, the gap presents the user
4946 with odd behaviour - why did it skip past Foo-N+1?
4948 We could explain this to the user in some odd way, but
4949 instead we rename "Foo-N+1.mid" as "Foo-N+2.mid", and then
4952 If that attempted rename fails, we get "Foo-N+2.mid" anyway.
4955 boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (track);
4957 std::string name = track->steal_write_source_name ();
4960 return boost::shared_ptr<MidiSource>();
4963 /* MIDI files are small, just put them in the first location of the
4964 session source search path.
4967 const string path = Glib::build_filename (source_search_path (DataType::MIDI).front(), name);
4969 return boost::dynamic_pointer_cast<SMFSource> (
4970 SourceFactory::createWritable (
4971 DataType::MIDI, *this, path, false, frame_rate()));
4976 Session::add_playlist (boost::shared_ptr<Playlist> playlist, bool unused)
4978 if (playlist->hidden()) {
4982 playlists->add (playlist);
4985 playlist->release();
4992 Session::remove_playlist (boost::weak_ptr<Playlist> weak_playlist)
4994 if (_state_of_the_state & Deletion) {
4998 boost::shared_ptr<Playlist> playlist (weak_playlist.lock());
5004 playlists->remove (playlist);
5010 Session::set_audition (boost::shared_ptr<Region> r)
5012 pending_audition_region = r;
5013 add_post_transport_work (PostTransportAudition);
5014 _butler->schedule_transport_work ();
5018 Session::audition_playlist ()
5020 SessionEvent* ev = new SessionEvent (SessionEvent::Audition, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
5021 ev->region.reset ();
5027 Session::register_lua_function (
5028 const std::string& name,
5029 const std::string& script,
5030 const LuaScriptParamList& args
5033 Glib::Threads::Mutex::Lock lm (lua_lock);
5035 lua_State* L = lua.getState();
5037 const std::string& bytecode = LuaScripting::get_factory_bytecode (script);
5038 luabridge::LuaRef tbl_arg (luabridge::newTable(L));
5039 for (LuaScriptParamList::const_iterator i = args.begin(); i != args.end(); ++i) {
5040 if ((*i)->optional && !(*i)->is_set) { continue; }
5041 tbl_arg[(*i)->name] = (*i)->value;
5043 (*_lua_add)(name, bytecode, tbl_arg); // throws luabridge::LuaException
5048 Session::unregister_lua_function (const std::string& name)
5050 Glib::Threads::Mutex::Lock lm (lua_lock);
5051 (*_lua_del)(name); // throws luabridge::LuaException
5052 lua.collect_garbage ();
5056 std::vector<std::string>
5057 Session::registered_lua_functions ()
5059 Glib::Threads::Mutex::Lock lm (lua_lock);
5060 std::vector<std::string> rv;
5063 luabridge::LuaRef list ((*_lua_list)());
5064 for (luabridge::Iterator i (list); !i.isNil (); ++i) {
5065 if (!i.key ().isString ()) { assert(0); continue; }
5066 rv.push_back (i.key ().cast<std::string> ());
5068 } catch (luabridge::LuaException const& e) { }
5073 static void _lua_print (std::string s) {
5074 std::cout << "SessionLua: " << s << "\n";
5079 Session::try_run_lua (pframes_t nframes)
5081 if (_n_lua_scripts == 0) return;
5082 Glib::Threads::Mutex::Lock tm (lua_lock, Glib::Threads::TRY_LOCK);
5084 try { (*_lua_run)(nframes); } catch (luabridge::LuaException const& e) { }
5089 Session::setup_lua ()
5092 lua.Print.connect (&_lua_print);
5095 "function ArdourSession ()"
5096 " local self = { scripts = {}, instances = {} }"
5098 " local remove = function (n)"
5099 " self.scripts[n] = nil"
5100 " self.instances[n] = nil"
5101 " Session:scripts_changed()" // call back
5104 " local addinternal = function (n, f, a)"
5105 " assert(type(n) == 'string', 'function-name must be string')"
5106 " assert(type(f) == 'function', 'Given script is a not a function')"
5107 " assert(type(a) == 'table' or type(a) == 'nil', 'Given argument is invalid')"
5108 " assert(self.scripts[n] == nil, 'Callback \"'.. n ..'\" already exists.')"
5109 " self.scripts[n] = { ['f'] = f, ['a'] = a }"
5110 " local env = _ENV; env.f = nil env.io = nil env.os = nil env.loadfile = nil env.require = nil env.dofile = nil env.package = nil env.debug = nil"
5111 " local env = { print = print, tostring = tostring, assert = assert, ipairs = ipairs, error = error, select = select, string = string, type = type, tonumber = tonumber, collectgarbage = collectgarbage, pairs = pairs, math = math, table = table, pcall = pcall, Session = Session, PBD = PBD, Timecode = Timecode, Evoral = Evoral, C = C, ARDOUR = ARDOUR }"
5112 " self.instances[n] = load (string.dump(f, true), nil, nil, env)(a)"
5113 " Session:scripts_changed()" // call back
5116 " local add = function (n, b, a)"
5117 " assert(type(b) == 'string', 'ByteCode must be string')"
5118 " load (b)()" // assigns f
5119 " assert(type(f) == 'string', 'Assigned ByteCode must be string')"
5120 " addinternal (n, load(f), a)"
5123 " local run = function (...)"
5124 " for n, s in pairs (self.instances) do"
5125 " local status, err = pcall (s, ...)"
5126 " if not status then"
5127 " print ('fn \"'.. n .. '\": ', err)"
5134 " local cleanup = function ()"
5135 " self.scripts = nil"
5136 " self.instances = nil"
5139 " local list = function ()"
5141 " for n, _ in pairs (self.scripts) do"
5147 " local function basic_serialize (o)"
5148 " if type(o) == \"number\" then"
5149 " return tostring(o)"
5151 " return string.format(\"%q\", o)"
5155 " local function serialize (name, value)"
5156 " local rv = name .. ' = '"
5158 " if type(value) == \"number\" or type(value) == \"string\" or type(value) == \"nil\" then"
5159 " return rv .. basic_serialize(value) .. ' '"
5160 " elseif type(value) == \"table\" then"
5162 " for k,v in pairs(value) do"
5163 " local fieldname = string.format(\"%s[%s]\", name, basic_serialize(k))"
5164 " rv = rv .. serialize(fieldname, v) .. ' '"
5165 " collectgarbage()" // string concatenation allocates a new string :(
5168 " elseif type(value) == \"function\" then"
5169 " return rv .. string.format(\"%q\", string.dump(value, true))"
5171 " error('cannot save a ' .. type(value))"
5176 " local save = function ()"
5177 " return (serialize('scripts', self.scripts))"
5180 " local restore = function (state)"
5181 " self.scripts = {}"
5183 " for n, s in pairs (scripts) do"
5184 " addinternal (n, load(s['f']), s['a'])"
5188 " return { run = run, add = add, remove = remove,"
5189 " list = list, restore = restore, save = save, cleanup = cleanup}"
5192 " sess = ArdourSession ()"
5193 " ArdourSession = nil"
5195 "function ardour () end"
5198 lua_State* L = lua.getState();
5201 luabridge::LuaRef lua_sess = luabridge::getGlobal (L, "sess");
5202 lua.do_command ("sess = nil"); // hide it.
5203 lua.do_command ("collectgarbage()");
5205 _lua_run = new luabridge::LuaRef(lua_sess["run"]);
5206 _lua_add = new luabridge::LuaRef(lua_sess["add"]);
5207 _lua_del = new luabridge::LuaRef(lua_sess["remove"]);
5208 _lua_list = new luabridge::LuaRef(lua_sess["list"]);
5209 _lua_save = new luabridge::LuaRef(lua_sess["save"]);
5210 _lua_load = new luabridge::LuaRef(lua_sess["restore"]);
5211 _lua_cleanup = new luabridge::LuaRef(lua_sess["cleanup"]);
5212 } catch (luabridge::LuaException const& e) {
5213 fatal << string_compose (_("programming error: %1"),
5214 X_("Failed to setup Lua interpreter"))
5216 abort(); /*NOTREACHED*/
5219 LuaBindings::stddef (L);
5220 LuaBindings::common (L);
5221 LuaBindings::dsp (L);
5222 luabridge::push <Session *> (L, this);
5223 lua_setglobal (L, "Session");
5227 Session::scripts_changed ()
5229 assert (!lua_lock.trylock()); // must hold lua_lock
5232 luabridge::LuaRef list ((*_lua_list)());
5234 for (luabridge::Iterator i (list); !i.isNil (); ++i) {
5235 if (!i.key ().isString ()) { assert(0); continue; }
5238 _n_lua_scripts = cnt;
5239 } catch (luabridge::LuaException const& e) {
5240 fatal << string_compose (_("programming error: %1"),
5241 X_("Indexing Lua Session Scripts failed."))
5243 abort(); /*NOTREACHED*/
5248 Session::non_realtime_set_audition ()
5250 assert (pending_audition_region);
5251 auditioner->audition_region (pending_audition_region);
5252 pending_audition_region.reset ();
5253 AuditionActive (true); /* EMIT SIGNAL */
5257 Session::audition_region (boost::shared_ptr<Region> r)
5259 SessionEvent* ev = new SessionEvent (SessionEvent::Audition, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
5265 Session::cancel_audition ()
5270 if (auditioner->auditioning()) {
5271 auditioner->cancel_audition ();
5272 AuditionActive (false); /* EMIT SIGNAL */
5277 Session::RoutePublicOrderSorter::operator() (boost::shared_ptr<Route> a, boost::shared_ptr<Route> b)
5279 if (a->is_monitor()) {
5282 if (b->is_monitor()) {
5285 return a->order_key () < b->order_key ();
5289 Session::is_auditioning () const
5291 /* can be called before we have an auditioner object */
5293 return auditioner->auditioning();
5300 Session::graph_reordered ()
5302 /* don't do this stuff if we are setting up connections
5303 from a set_state() call or creating new tracks. Ditto for deletion.
5306 if ((_state_of_the_state & (InitialConnecting|Deletion)) || _adding_routes_in_progress || _reconnecting_routes_in_progress || _route_deletion_in_progress) {
5310 /* every track/bus asked for this to be handled but it was deferred because
5311 we were connecting. do it now.
5314 request_input_change_handling ();
5318 /* force all diskstreams to update their capture offset values to
5319 reflect any changes in latencies within the graph.
5322 boost::shared_ptr<RouteList> rl = routes.reader ();
5323 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
5324 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
5326 tr->set_capture_offset ();
5331 /** @return Number of frames that there is disk space available to write,
5334 boost::optional<framecnt_t>
5335 Session::available_capture_duration ()
5337 Glib::Threads::Mutex::Lock lm (space_lock);
5339 if (_total_free_4k_blocks_uncertain) {
5340 return boost::optional<framecnt_t> ();
5343 float sample_bytes_on_disk = 4.0; // keep gcc happy
5345 switch (config.get_native_file_data_format()) {
5347 sample_bytes_on_disk = 4.0;
5351 sample_bytes_on_disk = 3.0;
5355 sample_bytes_on_disk = 2.0;
5359 /* impossible, but keep some gcc versions happy */
5360 fatal << string_compose (_("programming error: %1"),
5361 X_("illegal native file data format"))
5363 abort(); /*NOTREACHED*/
5366 double scale = 4096.0 / sample_bytes_on_disk;
5368 if (_total_free_4k_blocks * scale > (double) max_framecnt) {
5369 return max_framecnt;
5372 return (framecnt_t) floor (_total_free_4k_blocks * scale);
5376 Session::add_bundle (boost::shared_ptr<Bundle> bundle, bool emit_signal)
5379 RCUWriter<BundleList> writer (_bundles);
5380 boost::shared_ptr<BundleList> b = writer.get_copy ();
5381 b->push_back (bundle);
5385 BundleAddedOrRemoved (); /* EMIT SIGNAL */
5392 Session::remove_bundle (boost::shared_ptr<Bundle> bundle)
5394 bool removed = false;
5397 RCUWriter<BundleList> writer (_bundles);
5398 boost::shared_ptr<BundleList> b = writer.get_copy ();
5399 BundleList::iterator i = find (b->begin(), b->end(), bundle);
5401 if (i != b->end()) {
5408 BundleAddedOrRemoved (); /* EMIT SIGNAL */
5414 boost::shared_ptr<Bundle>
5415 Session::bundle_by_name (string name) const
5417 boost::shared_ptr<BundleList> b = _bundles.reader ();
5419 for (BundleList::const_iterator i = b->begin(); i != b->end(); ++i) {
5420 if ((*i)->name() == name) {
5425 return boost::shared_ptr<Bundle> ();
5429 Session::tempo_map_changed (const PropertyChange&)
5433 playlists->update_after_tempo_map_change ();
5435 _locations->apply (*this, &Session::update_locations_after_tempo_map_change);
5441 Session::update_locations_after_tempo_map_change (const Locations::LocationList& loc)
5443 for (Locations::LocationList::const_iterator i = loc.begin(); i != loc.end(); ++i) {
5444 (*i)->recompute_frames_from_bbt ();
5448 /** Ensures that all buffers (scratch, send, silent, etc) are allocated for
5449 * the given count with the current block size.
5452 Session::ensure_buffers (ChanCount howmany)
5454 BufferManager::ensure_buffers (howmany, bounce_processing() ? bounce_chunk_size : 0);
5458 Session::ensure_buffer_set(BufferSet& buffers, const ChanCount& count)
5460 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
5461 buffers.ensure_buffers(*t, count.get(*t), _engine.raw_buffer_size(*t));
5466 Session::next_insert_id ()
5468 /* this doesn't really loop forever. just think about it */
5471 for (boost::dynamic_bitset<uint32_t>::size_type n = 1; n < insert_bitset.size(); ++n) {
5472 if (!insert_bitset[n]) {
5473 insert_bitset[n] = true;
5479 /* none available, so resize and try again */
5481 insert_bitset.resize (insert_bitset.size() + 16, false);
5486 Session::next_send_id ()
5488 /* this doesn't really loop forever. just think about it */
5491 for (boost::dynamic_bitset<uint32_t>::size_type n = 1; n < send_bitset.size(); ++n) {
5492 if (!send_bitset[n]) {
5493 send_bitset[n] = true;
5499 /* none available, so resize and try again */
5501 send_bitset.resize (send_bitset.size() + 16, false);
5506 Session::next_aux_send_id ()
5508 /* this doesn't really loop forever. just think about it */
5511 for (boost::dynamic_bitset<uint32_t>::size_type n = 1; n < aux_send_bitset.size(); ++n) {
5512 if (!aux_send_bitset[n]) {
5513 aux_send_bitset[n] = true;
5519 /* none available, so resize and try again */
5521 aux_send_bitset.resize (aux_send_bitset.size() + 16, false);
5526 Session::next_return_id ()
5528 /* this doesn't really loop forever. just think about it */
5531 for (boost::dynamic_bitset<uint32_t>::size_type n = 1; n < return_bitset.size(); ++n) {
5532 if (!return_bitset[n]) {
5533 return_bitset[n] = true;
5539 /* none available, so resize and try again */
5541 return_bitset.resize (return_bitset.size() + 16, false);
5546 Session::mark_send_id (uint32_t id)
5548 if (id >= send_bitset.size()) {
5549 send_bitset.resize (id+16, false);
5551 if (send_bitset[id]) {
5552 warning << string_compose (_("send ID %1 appears to be in use already"), id) << endmsg;
5554 send_bitset[id] = true;
5558 Session::mark_aux_send_id (uint32_t id)
5560 if (id >= aux_send_bitset.size()) {
5561 aux_send_bitset.resize (id+16, false);
5563 if (aux_send_bitset[id]) {
5564 warning << string_compose (_("aux send ID %1 appears to be in use already"), id) << endmsg;
5566 aux_send_bitset[id] = true;
5570 Session::mark_return_id (uint32_t id)
5572 if (id >= return_bitset.size()) {
5573 return_bitset.resize (id+16, false);
5575 if (return_bitset[id]) {
5576 warning << string_compose (_("return ID %1 appears to be in use already"), id) << endmsg;
5578 return_bitset[id] = true;
5582 Session::mark_insert_id (uint32_t id)
5584 if (id >= insert_bitset.size()) {
5585 insert_bitset.resize (id+16, false);
5587 if (insert_bitset[id]) {
5588 warning << string_compose (_("insert ID %1 appears to be in use already"), id) << endmsg;
5590 insert_bitset[id] = true;
5594 Session::unmark_send_id (uint32_t id)
5596 if (id < send_bitset.size()) {
5597 send_bitset[id] = false;
5602 Session::unmark_aux_send_id (uint32_t id)
5604 if (id < aux_send_bitset.size()) {
5605 aux_send_bitset[id] = false;
5610 Session::unmark_return_id (uint32_t id)
5612 if (_state_of_the_state & Deletion) { return; }
5613 if (id < return_bitset.size()) {
5614 return_bitset[id] = false;
5619 Session::unmark_insert_id (uint32_t id)
5621 if (id < insert_bitset.size()) {
5622 insert_bitset[id] = false;
5627 Session::reset_native_file_format ()
5629 boost::shared_ptr<RouteList> rl = routes.reader ();
5631 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
5632 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
5634 /* don't save state as we do this, there's no point
5636 _state_of_the_state = StateOfTheState (_state_of_the_state|InCleanup);
5637 tr->reset_write_sources (false);
5638 _state_of_the_state = StateOfTheState (_state_of_the_state & ~InCleanup);
5644 Session::route_name_unique (string n) const
5646 boost::shared_ptr<RouteList> r = routes.reader ();
5648 for (RouteList::const_iterator i = r->begin(); i != r->end(); ++i) {
5649 if ((*i)->name() == n) {
5658 Session::route_name_internal (string n) const
5660 if (auditioner && auditioner->name() == n) {
5664 if (_click_io && _click_io->name() == n) {
5672 Session::freeze_all (InterThreadInfo& itt)
5674 boost::shared_ptr<RouteList> r = routes.reader ();
5676 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
5678 boost::shared_ptr<Track> t;
5680 if ((t = boost::dynamic_pointer_cast<Track>(*i)) != 0) {
5681 /* XXX this is wrong because itt.progress will keep returning to zero at the start
5691 boost::shared_ptr<Region>
5692 Session::write_one_track (Track& track, framepos_t start, framepos_t end,
5693 bool /*overwrite*/, vector<boost::shared_ptr<Source> >& srcs,
5694 InterThreadInfo& itt,
5695 boost::shared_ptr<Processor> endpoint, bool include_endpoint,
5696 bool for_export, bool for_freeze)
5698 boost::shared_ptr<Region> result;
5699 boost::shared_ptr<Playlist> playlist;
5700 boost::shared_ptr<Source> source;
5701 ChanCount diskstream_channels (track.n_channels());
5702 framepos_t position;
5703 framecnt_t this_chunk;
5705 framepos_t latency_skip;
5707 framepos_t len = end - start;
5708 bool need_block_size_reset = false;
5709 ChanCount const max_proc = track.max_processor_streams ();
5710 string legal_playlist_name;
5711 string possible_path;
5714 error << string_compose (_("Cannot write a range where end <= start (e.g. %1 <= %2)"),
5715 end, start) << endmsg;
5719 diskstream_channels = track.bounce_get_output_streams (diskstream_channels, endpoint,
5720 include_endpoint, for_export, for_freeze);
5722 if (diskstream_channels.n(track.data_type()) < 1) {
5723 error << _("Cannot write a range with no data.") << endmsg;
5727 // block all process callback handling
5729 block_processing ();
5732 // synchronize with AudioEngine::process_callback()
5733 // make sure processing is not currently running
5734 // and processing_blocked() is honored before
5735 // acquiring thread buffers
5736 Glib::Threads::Mutex::Lock lm (_engine.process_lock());
5739 _bounce_processing_active = true;
5741 /* call tree *MUST* hold route_lock */
5743 if ((playlist = track.playlist()) == 0) {
5747 legal_playlist_name = legalize_for_path (playlist->name());
5749 for (uint32_t chan_n = 0; chan_n < diskstream_channels.n(track.data_type()); ++chan_n) {
5751 string base_name = string_compose ("%1-%2-bounce", playlist->name(), chan_n);
5752 string path = ((track.data_type() == DataType::AUDIO)
5753 ? new_audio_source_path (legal_playlist_name, diskstream_channels.n_audio(), chan_n, false, true)
5754 : new_midi_source_path (legal_playlist_name));
5761 source = SourceFactory::createWritable (track.data_type(), *this, path, false, frame_rate());
5764 catch (failed_constructor& err) {
5765 error << string_compose (_("cannot create new file \"%1\" for %2"), path, track.name()) << endmsg;
5769 srcs.push_back (source);
5772 /* tell redirects that care that we are about to use a much larger
5773 * blocksize. this will flush all plugins too, so that they are ready
5774 * to be used for this process.
5777 need_block_size_reset = true;
5778 track.set_block_size (bounce_chunk_size);
5779 _engine.main_thread()->get_buffers ();
5783 latency_skip = track.bounce_get_latency (endpoint, include_endpoint, for_export, for_freeze);
5785 /* create a set of reasonably-sized buffers */
5786 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
5787 buffers.ensure_buffers(*t, max_proc.get(*t), bounce_chunk_size);
5789 buffers.set_count (max_proc);
5791 for (vector<boost::shared_ptr<Source> >::iterator src = srcs.begin(); src != srcs.end(); ++src) {
5792 boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*src);
5793 boost::shared_ptr<MidiSource> ms;
5795 afs->prepare_for_peakfile_writes ();
5796 } else if ((ms = boost::dynamic_pointer_cast<MidiSource>(*src))) {
5797 Source::Lock lock(ms->mutex());
5798 ms->mark_streaming_write_started(lock);
5802 while (to_do && !itt.cancel) {
5804 this_chunk = min (to_do, bounce_chunk_size);
5806 if (track.export_stuff (buffers, start, this_chunk, endpoint, include_endpoint, for_export, for_freeze)) {
5810 start += this_chunk;
5811 to_do -= this_chunk;
5812 itt.progress = (float) (1.0 - ((double) to_do / len));
5814 if (latency_skip >= bounce_chunk_size) {
5815 latency_skip -= bounce_chunk_size;
5819 const framecnt_t current_chunk = this_chunk - latency_skip;
5822 for (vector<boost::shared_ptr<Source> >::iterator src=srcs.begin(); src != srcs.end(); ++src, ++n) {
5823 boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*src);
5824 boost::shared_ptr<MidiSource> ms;
5827 if (afs->write (buffers.get_audio(n).data(latency_skip), current_chunk) != current_chunk) {
5830 } else if ((ms = boost::dynamic_pointer_cast<MidiSource>(*src))) {
5831 Source::Lock lock(ms->mutex());
5833 const MidiBuffer& buf = buffers.get_midi(0);
5834 for (MidiBuffer::const_iterator i = buf.begin(); i != buf.end(); ++i) {
5835 Evoral::Event<framepos_t> ev = *i;
5836 ev.set_time(ev.time() - position);
5837 ms->append_event_frames(lock, ev, ms->timeline_position());
5844 /* post-roll, pick up delayed processor output */
5845 latency_skip = track.bounce_get_latency (endpoint, include_endpoint, for_export, for_freeze);
5847 while (latency_skip && !itt.cancel) {
5848 this_chunk = min (latency_skip, bounce_chunk_size);
5849 latency_skip -= this_chunk;
5851 buffers.silence (this_chunk, 0);
5852 track.bounce_process (buffers, start, this_chunk, endpoint, include_endpoint, for_export, for_freeze);
5855 for (vector<boost::shared_ptr<Source> >::iterator src=srcs.begin(); src != srcs.end(); ++src, ++n) {
5856 boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*src);
5859 if (afs->write (buffers.get_audio(n).data(), this_chunk) != this_chunk) {
5871 xnow = localtime (&now);
5873 for (vector<boost::shared_ptr<Source> >::iterator src=srcs.begin(); src != srcs.end(); ++src) {
5874 boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*src);
5875 boost::shared_ptr<MidiSource> ms;
5878 afs->update_header (position, *xnow, now);
5879 afs->flush_header ();
5880 } else if ((ms = boost::dynamic_pointer_cast<MidiSource>(*src))) {
5881 Source::Lock lock(ms->mutex());
5882 ms->mark_streaming_write_completed(lock);
5886 /* construct a region to represent the bounced material */
5890 plist.add (Properties::start, 0);
5891 plist.add (Properties::length, srcs.front()->length(srcs.front()->timeline_position()));
5892 plist.add (Properties::name, region_name_from_path (srcs.front()->name(), true));
5894 result = RegionFactory::create (srcs, plist);
5900 for (vector<boost::shared_ptr<Source> >::iterator src = srcs.begin(); src != srcs.end(); ++src) {
5901 (*src)->mark_for_remove ();
5902 (*src)->drop_references ();
5906 for (vector<boost::shared_ptr<Source> >::iterator src = srcs.begin(); src != srcs.end(); ++src) {
5907 boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*src);
5910 afs->done_with_peakfile_writes ();
5914 _bounce_processing_active = false;
5916 if (need_block_size_reset) {
5917 _engine.main_thread()->drop_buffers ();
5918 track.set_block_size (get_block_size());
5921 unblock_processing ();
5928 Session::gain_automation_buffer() const
5930 return ProcessThread::gain_automation_buffer ();
5934 Session::trim_automation_buffer() const
5936 return ProcessThread::trim_automation_buffer ();
5940 Session::send_gain_automation_buffer() const
5942 return ProcessThread::send_gain_automation_buffer ();
5946 Session::pan_automation_buffer() const
5948 return ProcessThread::pan_automation_buffer ();
5952 Session::get_silent_buffers (ChanCount count)
5954 return ProcessThread::get_silent_buffers (count);
5958 Session::get_scratch_buffers (ChanCount count, bool silence)
5960 return ProcessThread::get_scratch_buffers (count, silence);
5964 Session::get_noinplace_buffers (ChanCount count)
5966 return ProcessThread::get_noinplace_buffers (count);
5970 Session::get_route_buffers (ChanCount count, bool silence)
5972 return ProcessThread::get_route_buffers (count, silence);
5977 Session::get_mix_buffers (ChanCount count)
5979 return ProcessThread::get_mix_buffers (count);
5983 Session::ntracks () const
5986 boost::shared_ptr<RouteList> r = routes.reader ();
5988 for (RouteList::const_iterator i = r->begin(); i != r->end(); ++i) {
5989 if (boost::dynamic_pointer_cast<Track> (*i)) {
5998 Session::nbusses () const
6001 boost::shared_ptr<RouteList> r = routes.reader ();
6003 for (RouteList::const_iterator i = r->begin(); i != r->end(); ++i) {
6004 if (boost::dynamic_pointer_cast<Track>(*i) == 0) {
6013 Session::add_automation_list(AutomationList *al)
6015 automation_lists[al->id()] = al;
6018 /** @return true if there is at least one record-enabled track, otherwise false */
6020 Session::have_rec_enabled_track () const
6022 return g_atomic_int_get (const_cast<gint*>(&_have_rec_enabled_track)) == 1;
6026 Session::have_rec_disabled_track () const
6028 return g_atomic_int_get (const_cast<gint*>(&_have_rec_disabled_track)) == 1;
6031 /** Update the state of our rec-enabled tracks flag */
6033 Session::update_route_record_state ()
6035 boost::shared_ptr<RouteList> rl = routes.reader ();
6036 RouteList::iterator i = rl->begin();
6037 while (i != rl->end ()) {
6039 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
6040 if (tr && tr->record_enabled ()) {
6047 int const old = g_atomic_int_get (&_have_rec_enabled_track);
6049 g_atomic_int_set (&_have_rec_enabled_track, i != rl->end () ? 1 : 0);
6051 if (g_atomic_int_get (&_have_rec_enabled_track) != old) {
6052 RecordStateChanged (); /* EMIT SIGNAL */
6055 for (i = rl->begin(); i != rl->end (); ++i) {
6056 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
6057 if (tr && !tr->record_enabled ()) {
6062 g_atomic_int_set (&_have_rec_disabled_track, i != rl->end () ? 1 : 0);
6064 bool record_arm_state_changed = (old != g_atomic_int_get (&_have_rec_enabled_track) );
6066 if (record_status() == Recording && record_arm_state_changed ) {
6067 RecordArmStateChanged ();
6073 Session::listen_position_changed ()
6075 boost::shared_ptr<RouteList> r = routes.reader ();
6077 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6078 (*i)->listen_position_changed ();
6083 Session::solo_control_mode_changed ()
6085 /* cancel all solo or all listen when solo control mode changes */
6088 set_solo (get_routes(), false);
6089 } else if (listening()) {
6090 set_listen (get_routes(), false);
6094 /** Called when a property of one of our route groups changes */
6096 Session::route_group_property_changed (RouteGroup* rg)
6098 RouteGroupPropertyChanged (rg); /* EMIT SIGNAL */
6101 /** Called when a route is added to one of our route groups */
6103 Session::route_added_to_route_group (RouteGroup* rg, boost::weak_ptr<Route> r)
6105 RouteAddedToRouteGroup (rg, r);
6108 /** Called when a route is removed from one of our route groups */
6110 Session::route_removed_from_route_group (RouteGroup* rg, boost::weak_ptr<Route> r)
6112 update_route_record_state ();
6113 RouteRemovedFromRouteGroup (rg, r); /* EMIT SIGNAL */
6116 boost::shared_ptr<RouteList>
6117 Session::get_tracks () const
6119 boost::shared_ptr<RouteList> rl = routes.reader ();
6120 boost::shared_ptr<RouteList> tl (new RouteList);
6122 for (RouteList::const_iterator r = rl->begin(); r != rl->end(); ++r) {
6123 if (boost::dynamic_pointer_cast<Track> (*r)) {
6124 if (!(*r)->is_auditioner()) {
6132 boost::shared_ptr<RouteList>
6133 Session::get_routes_with_regions_at (framepos_t const p) const
6135 boost::shared_ptr<RouteList> r = routes.reader ();
6136 boost::shared_ptr<RouteList> rl (new RouteList);
6138 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6139 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
6144 boost::shared_ptr<Playlist> pl = tr->playlist ();
6149 if (pl->has_region_at (p)) {
6158 Session::goto_end ()
6160 if (_session_range_location) {
6161 request_locate (_session_range_location->end(), false);
6163 request_locate (0, false);
6168 Session::goto_start ()
6170 if (_session_range_location) {
6171 request_locate (_session_range_location->start(), false);
6173 request_locate (0, false);
6178 Session::current_start_frame () const
6180 return _session_range_location ? _session_range_location->start() : 0;
6184 Session::current_end_frame () const
6186 return _session_range_location ? _session_range_location->end() : 0;
6190 Session::set_session_range_location (framepos_t start, framepos_t end)
6192 _session_range_location = new Location (*this, start, end, _("session"), Location::IsSessionRange);
6193 _locations->add (_session_range_location);
6197 Session::step_edit_status_change (bool yn)
6203 send = (_step_editors == 0);
6208 send = (_step_editors == 1);
6211 if (_step_editors > 0) {
6217 StepEditStatusChange (val);
6223 Session::start_time_changed (framepos_t old)
6225 /* Update the auto loop range to match the session range
6226 (unless the auto loop range has been changed by the user)
6229 Location* s = _locations->session_range_location ();
6234 Location* l = _locations->auto_loop_location ();
6236 if (l && l->start() == old) {
6237 l->set_start (s->start(), true);
6242 Session::end_time_changed (framepos_t old)
6244 /* Update the auto loop range to match the session range
6245 (unless the auto loop range has been changed by the user)
6248 Location* s = _locations->session_range_location ();
6253 Location* l = _locations->auto_loop_location ();
6255 if (l && l->end() == old) {
6256 l->set_end (s->end(), true);
6260 std::vector<std::string>
6261 Session::source_search_path (DataType type) const
6265 if (session_dirs.size() == 1) {
6267 case DataType::AUDIO:
6268 sp.push_back (_session_dir->sound_path());
6270 case DataType::MIDI:
6271 sp.push_back (_session_dir->midi_path());
6275 for (vector<space_and_path>::const_iterator i = session_dirs.begin(); i != session_dirs.end(); ++i) {
6276 SessionDirectory sdir (i->path);
6278 case DataType::AUDIO:
6279 sp.push_back (sdir.sound_path());
6281 case DataType::MIDI:
6282 sp.push_back (sdir.midi_path());
6288 if (type == DataType::AUDIO) {
6289 const string sound_path_2X = _session_dir->sound_path_2X();
6290 if (Glib::file_test (sound_path_2X, Glib::FILE_TEST_EXISTS|Glib::FILE_TEST_IS_DIR)) {
6291 if (find (sp.begin(), sp.end(), sound_path_2X) == sp.end()) {
6292 sp.push_back (sound_path_2X);
6297 // now check the explicit (possibly user-specified) search path
6300 case DataType::AUDIO:
6301 sp += Searchpath(config.get_audio_search_path ());
6303 case DataType::MIDI:
6304 sp += Searchpath(config.get_midi_search_path ());
6312 Session::ensure_search_path_includes (const string& path, DataType type)
6321 case DataType::AUDIO:
6322 sp += Searchpath(config.get_audio_search_path ());
6324 case DataType::MIDI:
6325 sp += Searchpath (config.get_midi_search_path ());
6329 for (vector<std::string>::iterator i = sp.begin(); i != sp.end(); ++i) {
6330 /* No need to add this new directory if it has the same inode as
6331 an existing one; checking inode rather than name prevents duplicated
6332 directories when we are using symlinks.
6334 On Windows, I think we could just do if (*i == path) here.
6336 if (PBD::equivalent_paths (*i, path)) {
6344 case DataType::AUDIO:
6345 config.set_audio_search_path (sp.to_string());
6347 case DataType::MIDI:
6348 config.set_midi_search_path (sp.to_string());
6354 Session::remove_dir_from_search_path (const string& dir, DataType type)
6359 case DataType::AUDIO:
6360 sp = Searchpath(config.get_audio_search_path ());
6362 case DataType::MIDI:
6363 sp = Searchpath (config.get_midi_search_path ());
6370 case DataType::AUDIO:
6371 config.set_audio_search_path (sp.to_string());
6373 case DataType::MIDI:
6374 config.set_midi_search_path (sp.to_string());
6380 boost::shared_ptr<Speakers>
6381 Session::get_speakers()
6387 Session::unknown_processors () const
6391 boost::shared_ptr<RouteList> r = routes.reader ();
6392 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6393 list<string> t = (*i)->unknown_processors ();
6394 copy (t.begin(), t.end(), back_inserter (p));
6404 Session::update_latency (bool playback)
6407 DEBUG_TRACE (DEBUG::Latency, string_compose ("JACK latency callback: %1\n", (playback ? "PLAYBACK" : "CAPTURE")));
6409 if ((_state_of_the_state & (InitialConnecting|Deletion)) || _adding_routes_in_progress || _route_deletion_in_progress) {
6413 boost::shared_ptr<RouteList> r = routes.reader ();
6414 framecnt_t max_latency = 0;
6417 /* reverse the list so that we work backwards from the last route to run to the first */
6418 RouteList* rl = routes.reader().get();
6419 r.reset (new RouteList (*rl));
6420 reverse (r->begin(), r->end());
6423 /* compute actual latency values for the given direction and store them all in per-port
6424 structures. this will also publish the same values (to JACK) so that computation of latency
6425 for routes can consistently use public latency values.
6428 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6429 max_latency = max (max_latency, (*i)->set_private_port_latencies (playback));
6432 /* because we latency compensate playback, our published playback latencies should
6433 be the same for all output ports - all material played back by ardour has
6434 the same latency, whether its caused by plugins or by latency compensation. since
6435 these may differ from the values computed above, reset all playback port latencies
6439 DEBUG_TRACE (DEBUG::Latency, string_compose ("Set public port latencies to %1\n", max_latency));
6441 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6442 (*i)->set_public_port_latencies (max_latency, playback);
6447 post_playback_latency ();
6451 post_capture_latency ();
6454 DEBUG_TRACE (DEBUG::Latency, "JACK latency callback: DONE\n");
6458 Session::post_playback_latency ()
6460 set_worst_playback_latency ();
6462 boost::shared_ptr<RouteList> r = routes.reader ();
6464 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6465 if (!(*i)->is_auditioner() && ((*i)->active())) {
6466 _worst_track_latency = max (_worst_track_latency, (*i)->update_signal_latency ());
6470 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6471 (*i)->set_latency_compensation (_worst_track_latency);
6476 Session::post_capture_latency ()
6478 set_worst_capture_latency ();
6480 /* reflect any changes in capture latencies into capture offsets
6483 boost::shared_ptr<RouteList> rl = routes.reader();
6484 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
6485 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
6487 tr->set_capture_offset ();
6493 Session::initialize_latencies ()
6496 Glib::Threads::Mutex::Lock lm (_engine.process_lock());
6497 update_latency (false);
6498 update_latency (true);
6501 set_worst_io_latencies ();
6505 Session::set_worst_io_latencies ()
6507 set_worst_playback_latency ();
6508 set_worst_capture_latency ();
6512 Session::set_worst_playback_latency ()
6514 if (_state_of_the_state & (InitialConnecting|Deletion)) {
6518 _worst_output_latency = 0;
6520 if (!_engine.connected()) {
6524 boost::shared_ptr<RouteList> r = routes.reader ();
6526 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6527 _worst_output_latency = max (_worst_output_latency, (*i)->output()->latency());
6530 DEBUG_TRACE (DEBUG::Latency, string_compose ("Worst output latency: %1\n", _worst_output_latency));
6534 Session::set_worst_capture_latency ()
6536 if (_state_of_the_state & (InitialConnecting|Deletion)) {
6540 _worst_input_latency = 0;
6542 if (!_engine.connected()) {
6546 boost::shared_ptr<RouteList> r = routes.reader ();
6548 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6549 _worst_input_latency = max (_worst_input_latency, (*i)->input()->latency());
6552 DEBUG_TRACE (DEBUG::Latency, string_compose ("Worst input latency: %1\n", _worst_input_latency));
6556 Session::update_latency_compensation (bool force_whole_graph)
6558 bool some_track_latency_changed = false;
6560 if (_state_of_the_state & (InitialConnecting|Deletion)) {
6564 DEBUG_TRACE(DEBUG::Latency, "---------------------------- update latency compensation\n\n");
6566 _worst_track_latency = 0;
6568 boost::shared_ptr<RouteList> r = routes.reader ();
6570 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6571 if (!(*i)->is_auditioner() && ((*i)->active())) {
6573 if ((*i)->signal_latency () != (tl = (*i)->update_signal_latency ())) {
6574 some_track_latency_changed = true;
6576 _worst_track_latency = max (tl, _worst_track_latency);
6580 DEBUG_TRACE (DEBUG::Latency, string_compose ("worst signal processing latency: %1 (changed ? %2)\n", _worst_track_latency,
6581 (some_track_latency_changed ? "yes" : "no")));
6583 DEBUG_TRACE(DEBUG::Latency, "---------------------------- DONE update latency compensation\n\n");
6585 if (some_track_latency_changed || force_whole_graph) {
6586 _engine.update_latencies ();
6590 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6591 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
6595 tr->set_capture_offset ();
6600 Session::session_name_is_legal (const string& path)
6602 char illegal_chars[] = { '/', '\\', ':', ';', '\0' };
6604 for (int i = 0; illegal_chars[i]; ++i) {
6605 if (path.find (illegal_chars[i]) != string::npos) {
6606 return illegal_chars[i];
6614 Session::next_control_id () const
6618 /* the monitor bus remote ID is in a different
6619 * "namespace" than regular routes. its existence doesn't
6620 * affect normal (low) numbered routes.
6627 /* the same about masterbus in Waves Tracks */
6629 if (Profile->get_trx() && _master_out) {
6633 return nroutes() - subtract;
6637 Session::notify_remote_id_change ()
6639 if (deletion_in_progress()) {
6643 switch (Config->get_remote_model()) {
6645 Route::RemoteControlIDChange (); /* EMIT SIGNAL */
6651 #ifdef USE_TRACKS_CODE_FEATURES
6652 /* Waves Tracks: for Waves Tracks session it's required to reconnect their IOs
6653 * if track order has been changed by user
6655 reconnect_existing_routes(true, true);
6661 Session::sync_order_keys ()
6663 if (deletion_in_progress()) {
6667 /* tell everyone that something has happened to the sort keys
6668 and let them sync up with the change(s)
6669 this will give objects that manage the sort order keys the
6670 opportunity to keep them in sync if they wish to.
6673 DEBUG_TRACE (DEBUG::OrderKeys, "Sync Order Keys.\n");
6675 reassign_track_numbers();
6677 Route::SyncOrderKeys (); /* EMIT SIGNAL */
6679 DEBUG_TRACE (DEBUG::OrderKeys, "\tsync done\n");
6683 Session::operation_in_progress (GQuark op) const
6685 return (find (_current_trans_quarks.begin(), _current_trans_quarks.end(), op) != _current_trans_quarks.end());
6688 boost::shared_ptr<Port>
6689 Session::ltc_input_port () const
6691 return _ltc_input->nth (0);
6694 boost::shared_ptr<Port>
6695 Session::ltc_output_port () const
6697 return _ltc_output->nth (0);
6701 Session::reconnect_ltc_input ()
6705 string src = Config->get_ltc_source_port();
6707 _ltc_input->disconnect (this);
6709 if (src != _("None") && !src.empty()) {
6710 _ltc_input->nth (0)->connect (src);
6713 if ( ARDOUR::Profile->get_trx () ) {
6714 // Tracks need this signal to update timecode_source_dropdown
6715 MtcOrLtcInputPortChanged (); //emit signal
6721 Session::reconnect_ltc_output ()
6725 string src = Config->get_ltc_output_port();
6727 _ltc_output->disconnect (this);
6729 if (src != _("None") && !src.empty()) {
6730 _ltc_output->nth (0)->connect (src);
6736 Session::set_range_selection (framepos_t start, framepos_t end)
6738 _range_selection = Evoral::Range<framepos_t> (start, end);
6739 #ifdef USE_TRACKS_CODE_FEATURES
6740 follow_playhead_priority ();
6745 Session::set_object_selection (framepos_t start, framepos_t end)
6747 _object_selection = Evoral::Range<framepos_t> (start, end);
6748 #ifdef USE_TRACKS_CODE_FEATURES
6749 follow_playhead_priority ();
6754 Session::clear_range_selection ()
6756 _range_selection = Evoral::Range<framepos_t> (-1,-1);
6757 #ifdef USE_TRACKS_CODE_FEATURES
6758 follow_playhead_priority ();
6763 Session::clear_object_selection ()
6765 _object_selection = Evoral::Range<framepos_t> (-1,-1);
6766 #ifdef USE_TRACKS_CODE_FEATURES
6767 follow_playhead_priority ();
6772 Session::auto_connect_route (boost::shared_ptr<Route> route, bool connect_inputs,
6773 const ChanCount& input_start,
6774 const ChanCount& output_start,
6775 const ChanCount& input_offset,
6776 const ChanCount& output_offset)
6778 Glib::Threads::Mutex::Lock lx (_auto_connect_queue_lock);
6779 _auto_connect_queue.push (AutoConnectRequest (route, connect_inputs,
6780 input_start, output_start,
6781 input_offset, output_offset));
6783 if (pthread_mutex_trylock (&_auto_connect_mutex) == 0) {
6784 pthread_cond_signal (&_auto_connect_cond);
6785 pthread_mutex_unlock (&_auto_connect_mutex);
6790 Session::auto_connect (const AutoConnectRequest& ar)
6792 boost::shared_ptr<Route> route = ar.route.lock();
6794 if (!route) { return; }
6796 if (!IO::connecting_legal) {
6800 /* If both inputs and outputs are auto-connected to physical ports,
6801 * use the max of input and output offsets to ensure auto-connected
6802 * port numbers always match up (e.g. the first audio input and the
6803 * first audio output of the route will have the same physical
6804 * port number). Otherwise just use the lowest input or output
6808 const bool in_out_physical =
6809 (Config->get_input_auto_connect() & AutoConnectPhysical)
6810 && (Config->get_output_auto_connect() & AutoConnectPhysical)
6811 && ar.connect_inputs;
6813 const ChanCount in_offset = in_out_physical
6814 ? ChanCount::max(ar.input_offset, ar.output_offset)
6817 const ChanCount out_offset = in_out_physical
6818 ? ChanCount::max(ar.input_offset, ar.output_offset)
6821 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
6822 vector<string> physinputs;
6823 vector<string> physoutputs;
6825 _engine.get_physical_outputs (*t, physoutputs);
6826 _engine.get_physical_inputs (*t, physinputs);
6828 if (!physinputs.empty() && ar.connect_inputs) {
6829 uint32_t nphysical_in = physinputs.size();
6831 for (uint32_t i = ar.input_start.get(*t); i < route->n_inputs().get(*t) && i < nphysical_in; ++i) {
6834 if (Config->get_input_auto_connect() & AutoConnectPhysical) {
6835 port = physinputs[(in_offset.get(*t) + i) % nphysical_in];
6838 if (!port.empty() && route->input()->connect (route->input()->ports().port(*t, i), port, this)) {
6844 if (!physoutputs.empty()) {
6845 uint32_t nphysical_out = physoutputs.size();
6846 for (uint32_t i = ar.output_start.get(*t); i < route->n_outputs().get(*t); ++i) {
6850 * do not create new connections if we reached the limit of physical outputs
6853 if (!(Config->get_output_auto_connect() & AutoConnectMaster) &&
6854 ARDOUR::Profile->get_trx () &&
6855 ar.output_offset.get(*t) == nphysical_out ) {
6859 if ((*t) == DataType::MIDI && (Config->get_output_auto_connect() & AutoConnectPhysical)) {
6860 port = physoutputs[(out_offset.get(*t) + i) % nphysical_out];
6861 } else if ((*t) == DataType::AUDIO && (Config->get_output_auto_connect() & AutoConnectMaster)) {
6862 /* master bus is audio only */
6863 if (_master_out && _master_out->n_inputs().get(*t) > 0) {
6864 port = _master_out->input()->ports().port(*t,
6865 i % _master_out->input()->n_ports().get(*t))->name();
6869 if (!port.empty() && route->output()->connect (route->output()->ports().port(*t, i), port, this)) {
6878 Session::auto_connect_thread_start ()
6880 if (_ac_thread_active) {
6884 while (!_auto_connect_queue.empty ()) {
6885 _auto_connect_queue.pop ();
6888 _ac_thread_active = true;
6889 if (pthread_create (&_auto_connect_thread, NULL, auto_connect_thread, this)) {
6890 _ac_thread_active = false;
6895 Session::auto_connect_thread_terminate ()
6897 if (!_ac_thread_active) {
6900 _ac_thread_active = false;
6903 Glib::Threads::Mutex::Lock lx (_auto_connect_queue_lock);
6904 while (!_auto_connect_queue.empty ()) {
6905 _auto_connect_queue.pop ();
6909 if (pthread_mutex_lock (&_auto_connect_mutex) == 0) {
6910 pthread_cond_signal (&_auto_connect_cond);
6911 pthread_mutex_unlock (&_auto_connect_mutex);
6915 pthread_join (_auto_connect_thread, &status);
6919 Session::auto_connect_thread (void *arg)
6921 Session *s = static_cast<Session *>(arg);
6922 s->auto_connect_thread_run ();
6928 Session::auto_connect_thread_run ()
6930 pthread_set_name (X_("autoconnect"));
6931 SessionEvent::create_per_thread_pool (X_("autoconnect"), 1024);
6932 PBD::notify_event_loops_about_thread_creation (pthread_self(), X_("autoconnect"), 1024);
6933 pthread_mutex_lock (&_auto_connect_mutex);
6934 while (_ac_thread_active) {
6936 if (!_auto_connect_queue.empty ()) {
6937 // Why would we need the process lock ??
6938 // A: if ports are added while we're connecting, the backend's iterator may be invalidated:
6939 // graph_order_callback() -> resort_routes() -> direct_feeds_according_to_reality () -> backend::connected_to()
6940 // All ardour-internal backends use a std::vector xxxAudioBackend::find_port()
6941 // We have control over those, but what does jack do?
6942 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
6944 Glib::Threads::Mutex::Lock lx (_auto_connect_queue_lock);
6945 while (!_auto_connect_queue.empty ()) {
6946 const AutoConnectRequest ar (_auto_connect_queue.front());
6947 _auto_connect_queue.pop ();
6954 pthread_cond_wait (&_auto_connect_cond, &_auto_connect_mutex);
6956 pthread_mutex_unlock (&_auto_connect_mutex);