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/solo_isolate_control.h"
102 #include "ardour/source_factory.h"
103 #include "ardour/speakers.h"
104 #include "ardour/tempo.h"
105 #include "ardour/ticker.h"
106 #include "ardour/track.h"
107 #include "ardour/user_bundle.h"
108 #include "ardour/utils.h"
109 #include "ardour/vca_manager.h"
111 #include "midi++/port.h"
112 #include "midi++/mmc.h"
114 #include "LuaBridge/LuaBridge.h"
118 #include <glibmm/checksum.h>
127 using namespace ARDOUR;
130 bool Session::_disable_all_loaded_plugins = false;
131 bool Session::_bypass_all_loaded_plugins = false;
132 guint Session::_name_id_counter = 0;
134 PBD::Signal1<int,uint32_t> Session::AudioEngineSetupRequired;
135 PBD::Signal1<void,std::string> Session::Dialog;
136 PBD::Signal0<int> Session::AskAboutPendingState;
137 PBD::Signal2<int, framecnt_t, framecnt_t> Session::AskAboutSampleRateMismatch;
138 PBD::Signal2<void, framecnt_t, framecnt_t> Session::NotifyAboutSampleRateMismatch;
139 PBD::Signal0<void> Session::SendFeedback;
140 PBD::Signal3<int,Session*,std::string,DataType> Session::MissingFile;
142 PBD::Signal1<void, framepos_t> Session::StartTimeChanged;
143 PBD::Signal1<void, framepos_t> Session::EndTimeChanged;
144 PBD::Signal2<void,std::string, std::string> Session::Exported;
145 PBD::Signal1<int,boost::shared_ptr<Playlist> > Session::AskAboutPlaylistDeletion;
146 PBD::Signal0<void> Session::Quit;
147 PBD::Signal0<void> Session::FeedbackDetected;
148 PBD::Signal0<void> Session::SuccessfulGraphSort;
149 PBD::Signal2<void,std::string,std::string> Session::VersionMismatch;
151 const framecnt_t Session::bounce_chunk_size = 8192;
152 static void clean_up_session_event (SessionEvent* ev) { delete ev; }
153 const SessionEvent::RTeventCallback Session::rt_cleanup (clean_up_session_event);
155 // seconds should be added after the region exceeds end marker
156 #ifdef USE_TRACKS_CODE_FEATURES
157 const uint32_t Session::session_end_shift = 5;
159 const uint32_t Session::session_end_shift = 0;
162 /** @param snapshot_name Snapshot name, without .ardour suffix */
163 Session::Session (AudioEngine &eng,
164 const string& fullpath,
165 const string& snapshot_name,
166 BusProfile* bus_profile,
168 : playlists (new SessionPlaylists)
170 , process_function (&Session::process_with_events)
171 , _bounce_processing_active (false)
172 , waiting_for_sync_offset (false)
173 , _base_frame_rate (0)
174 , _nominal_frame_rate (0)
175 , _current_frame_rate (0)
176 , transport_sub_state (0)
177 , _record_status (Disabled)
178 , _transport_frame (0)
179 , _session_range_location (0)
182 , _transport_speed (0)
183 , _default_transport_speed (1.0)
184 , _last_transport_speed (0)
185 , _target_transport_speed (0.0)
186 , auto_play_legal (false)
187 , _last_slave_transport_frame (0)
188 , maximum_output_latency (0)
189 , _requested_return_frame (-1)
190 , current_block_size (0)
191 , _worst_output_latency (0)
192 , _worst_input_latency (0)
193 , _worst_track_latency (0)
194 , _have_captured (false)
195 , _non_soloed_outs_muted (false)
198 , _solo_isolated_cnt (0)
200 , _was_seamless (Config->get_seamless_loop ())
201 , _under_nsm_control (false)
203 , delta_accumulator_cnt (0)
204 , average_slave_delta (1800) // !!! why 1800 ???
206 , have_first_delta_accumulator (false)
207 , _slave_state (Stopped)
208 , _mtc_active (false)
209 , _ltc_active (false)
210 , post_export_sync (false)
211 , post_export_position (0)
213 , _export_rolling (false)
214 , _export_preroll (0)
215 , _pre_export_mmc_enabled (false)
216 , _name (snapshot_name)
218 , _send_qf_mtc (false)
219 , _pframes_since_last_mtc (0)
220 , session_midi_feedback (0)
222 , loop_changing (false)
224 , _session_dir (new SessionDirectory (fullpath))
225 , _current_snapshot_name (snapshot_name)
227 , state_was_pending (false)
228 , _state_of_the_state (StateOfTheState(CannotSave|InitialConnecting|Loading))
230 , _save_queued (false)
231 , _last_roll_location (0)
232 , _last_roll_or_reversal_location (0)
233 , _last_record_location (0)
234 , pending_locate_roll (false)
235 , pending_locate_frame (0)
236 , pending_locate_flush (false)
237 , pending_abort (false)
238 , pending_auto_loop (false)
239 , _mempool ("Session", 1048576)
240 , lua (lua_newstate (&PBD::ReallocPool::lalloc, &_mempool))
242 , _butler (new Butler (*this))
243 , _post_transport_work (0)
244 , cumulative_rf_motion (0)
246 , _locations (new Locations (*this))
247 , _ignore_skips_updates (false)
248 , _rt_thread_active (false)
249 , _rt_emit_pending (false)
250 , _ac_thread_active (false)
252 , outbound_mtc_timecode_frame (0)
253 , next_quarter_frame_to_send (-1)
254 , _frames_per_timecode_frame (0)
255 , _frames_per_hour (0)
256 , _timecode_frames_per_hour (0)
257 , last_timecode_valid (false)
258 , last_timecode_when (0)
259 , _send_timecode_update (false)
271 , ltc_timecode_offset (0)
272 , ltc_timecode_negative_offset (false)
273 , midi_control_ui (0)
275 , _all_route_group (new RouteGroup (*this, "all"))
276 , routes (new RouteList)
277 , _adding_routes_in_progress (false)
278 , _reconnecting_routes_in_progress (false)
279 , _route_deletion_in_progress (false)
280 , destructive_index (0)
281 , _track_number_decimals(1)
282 , default_fade_steepness (0)
283 , default_fade_msecs (0)
284 , _total_free_4k_blocks (0)
285 , _total_free_4k_blocks_uncertain (false)
286 , no_questions_about_missing_files (false)
289 , _bundles (new BundleList)
290 , _bundle_xml_node (0)
294 , click_emphasis_data (0)
296 , click_emphasis_length (0)
297 , _clicks_cleared (0)
298 , _play_range (false)
299 , _range_selection (-1,-1)
300 , _object_selection (-1,-1)
302 , first_file_data_format_reset (true)
303 , first_file_header_format_reset (true)
304 , have_looped (false)
305 , _have_rec_enabled_track (false)
306 , _have_rec_disabled_track (true)
308 , _suspend_timecode_transmission (0)
309 , _speakers (new Speakers)
311 , ignore_route_processor_changes (false)
316 , _vca_manager (new VCAManager (*this))
320 pthread_mutex_init (&_rt_emit_mutex, 0);
321 pthread_cond_init (&_rt_emit_cond, 0);
323 pthread_mutex_init (&_auto_connect_mutex, 0);
324 pthread_cond_init (&_auto_connect_cond, 0);
326 init_name_id_counter (1); // reset for new sessions, start at 1
328 pre_engine_init (fullpath);
334 Stateful::loading_state_version = CURRENT_SESSION_FILE_VERSION;
336 #ifdef USE_TRACKS_CODE_FEATURES
337 sr = EngineStateController::instance()->get_current_sample_rate();
339 if (ensure_engine (sr, true)) {
341 throw SessionException (_("Cannot connect to audio/midi engine"));
344 // set samplerate for plugins added early
345 // e.g from templates or MB channelstrip
346 set_block_size (_engine.samples_per_cycle());
347 set_frame_rate (_engine.sample_rate());
349 if (create (mix_template, bus_profile)) {
351 throw SessionException (_("Session initialization failed"));
354 /* if a mix template was provided, then ::create() will
355 * have copied it into the session and we need to load it
356 * so that we have the state ready for ::set_state()
357 * after the engine is started.
359 * Note that we do NOT try to get the sample rate from
360 * the template at this time, though doing so would
361 * be easy if we decided this was an appropriate part
365 if (!mix_template.empty()) {
366 if (load_state (_current_snapshot_name)) {
367 throw SessionException (_("Failed to load template/snapshot state"));
369 store_recent_templates (mix_template);
372 /* load default session properties - if any */
377 if (load_state (_current_snapshot_name)) {
378 throw SessionException (_("Failed to load state"));
381 /* try to get sample rate from XML state so that we
382 * can influence the SR if we set up the audio
387 XMLProperty const * prop;
388 XMLNode const * root (state_tree->root());
389 if ((prop = root->property (X_("sample-rate"))) != 0) {
390 sr = atoi (prop->value());
394 if (ensure_engine (sr, false)) {
396 throw SessionException (_("Cannot connect to audio/midi engine"));
400 if (post_engine_init ()) {
402 throw SessionException (_("Cannot configure audio/midi engine with session parameters"));
405 store_recent_sessions (_name, _path);
407 bool was_dirty = dirty();
409 _state_of_the_state = StateOfTheState (_state_of_the_state & ~Dirty);
411 Config->ParameterChanged.connect_same_thread (*this, boost::bind (&Session::config_changed, this, _1, false));
412 config.ParameterChanged.connect_same_thread (*this, boost::bind (&Session::config_changed, this, _1, true));
415 DirtyChanged (); /* EMIT SIGNAL */
418 StartTimeChanged.connect_same_thread (*this, boost::bind (&Session::start_time_changed, this, _1));
419 EndTimeChanged.connect_same_thread (*this, boost::bind (&Session::end_time_changed, this, _1));
421 emit_thread_start ();
422 auto_connect_thread_start ();
424 /* hook us up to the engine since we are now completely constructed */
426 BootMessage (_("Connect to engine"));
428 _engine.set_session (this);
429 _engine.reset_timebase ();
431 #ifdef USE_TRACKS_CODE_FEATURES
433 EngineStateController::instance()->set_session(this);
436 if ( ARDOUR::Profile->get_trx () ) {
438 /* Waves Tracks: fill session with tracks basing on the amount of inputs.
439 * each available input must have corresponding track when session starts.
442 uint32_t how_many (0);
444 std::vector<std::string> inputs;
445 EngineStateController::instance()->get_physical_audio_inputs(inputs);
447 how_many = inputs.size();
449 list<boost::shared_ptr<AudioTrack> > tracks;
451 // Track names after driver
452 if (Config->get_tracks_auto_naming() == NameAfterDriver) {
453 string track_name = "";
454 for (std::vector<string>::size_type i = 0; i < inputs.size(); ++i) {
456 track_name = inputs[i];
457 replace_all (track_name, "system:capture", "");
459 list<boost::shared_ptr<AudioTrack> > single_track = new_audio_track (1, 1, Normal, 0, 1, track_name);
460 tracks.insert(tracks.begin(), single_track.front());
462 } else { // Default track names
463 tracks = new_audio_track (1, 1, Normal, 0, how_many, string());
466 if (tracks.size() != how_many) {
468 throw failed_constructor ();
477 BootMessage (_("Session loading complete"));
489 Session::next_name_id ()
491 return g_atomic_int_add (&_name_id_counter, 1);
495 Session::name_id_counter ()
497 return g_atomic_int_get (&_name_id_counter);
501 Session::init_name_id_counter (guint n)
503 g_atomic_int_set (&_name_id_counter, n);
507 Session::ensure_engine (uint32_t desired_sample_rate, bool isnew)
509 if (_engine.current_backend() == 0) {
510 /* backend is unknown ... */
511 boost::optional<int> r = AudioEngineSetupRequired (desired_sample_rate);
512 if (r.get_value_or (-1) != 0) {
515 } else if (!isnew && _engine.running() && _engine.sample_rate () == desired_sample_rate) {
517 } else if (_engine.setup_required()) {
518 /* backend is known, but setup is needed */
519 boost::optional<int> r = AudioEngineSetupRequired (desired_sample_rate);
520 if (r.get_value_or (-1) != 0) {
523 } else if (!_engine.running()) {
524 if (_engine.start()) {
529 /* at this point the engine should be running */
531 if (!_engine.running()) {
535 return immediately_post_engine ();
540 Session::immediately_post_engine ()
542 /* Do various initializations that should take place directly after we
543 * know that the engine is running, but before we either create a
544 * session or set state for an existing one.
547 if (how_many_dsp_threads () > 1) {
548 /* For now, only create the graph if we are using >1 DSP threads, as
549 it is a bit slower than the old code with 1 thread.
551 _process_graph.reset (new Graph (*this));
554 /* every time we reconnect, recompute worst case output latencies */
556 _engine.Running.connect_same_thread (*this, boost::bind (&Session::initialize_latencies, this));
558 if (synced_to_engine()) {
559 _engine.transport_stop ();
562 if (config.get_jack_time_master()) {
563 _engine.transport_locate (_transport_frame);
568 BootMessage (_("Set up LTC"));
570 BootMessage (_("Set up Click"));
572 BootMessage (_("Set up standard connections"));
576 catch (failed_constructor& err) {
580 /* TODO, connect in different thread. (PortRegisteredOrUnregistered may be in RT context)
582 _engine.PortRegisteredOrUnregistered.connect_same_thread (*this, boost::bind (&Session::setup_bundles, this));
590 vector<void*> debug_pointers;
592 /* if we got to here, leaving pending capture state around
596 remove_pending_capture_state ();
600 _state_of_the_state = StateOfTheState (CannotSave|Deletion);
602 /* stop autoconnecting */
603 auto_connect_thread_terminate ();
605 /* disconnect from any and all signals that we are connected to */
607 Port::PortSignalDrop (); /* EMIT SIGNAL */
610 /* shutdown control surface protocols while we still have ports
611 and the engine to move data to any devices.
614 ControlProtocolManager::instance().drop_protocols ();
616 MIDI::Name::MidiPatchManager::instance().remove_search_path(session_directory().midi_patch_path());
618 _engine.remove_session ();
620 #ifdef USE_TRACKS_CODE_FEATURES
621 EngineStateController::instance()->remove_session();
624 /* deregister all ports - there will be no process or any other
625 * callbacks from the engine any more.
628 Port::PortDrop (); /* EMIT SIGNAL */
632 /* clear history so that no references to objects are held any more */
636 /* clear state tree so that no references to objects are held any more */
641 // unregister all lua functions, drop held references (if any)
643 lua.do_command ("Session = nil");
651 lua.collect_garbage ();
653 /* reset dynamic state version back to default */
654 Stateful::loading_state_version = 0;
656 _butler->drop_references ();
660 delete _all_route_group;
662 DEBUG_TRACE (DEBUG::Destruction, "delete route groups\n");
663 for (list<RouteGroup *>::iterator i = _route_groups.begin(); i != _route_groups.end(); ++i) {
667 if (click_data != default_click) {
668 delete [] click_data;
671 if (click_emphasis_data != default_click_emphasis) {
672 delete [] click_emphasis_data;
677 /* need to remove auditioner before monitoring section
678 * otherwise it is re-connected */
681 /* drop references to routes held by the monitoring section
682 * specifically _monitor_out aux/listen references */
683 remove_monitor_section();
685 /* clear out any pending dead wood from RCU managed objects */
690 AudioDiskstream::free_working_buffers();
692 /* tell everyone who is still standing that we're about to die */
695 /* tell everyone to drop references and delete objects as we go */
697 DEBUG_TRACE (DEBUG::Destruction, "delete regions\n");
698 RegionFactory::delete_all_regions ();
700 /* Do this early so that VCAs no longer hold references to routes */
702 DEBUG_TRACE (DEBUG::Destruction, "delete vcas\n");
705 DEBUG_TRACE (DEBUG::Destruction, "delete routes\n");
707 /* reset these three references to special routes before we do the usual route delete thing */
709 _master_out.reset ();
710 _monitor_out.reset ();
713 RCUWriter<RouteList> writer (routes);
714 boost::shared_ptr<RouteList> r = writer.get_copy ();
716 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
717 DEBUG_TRACE(DEBUG::Destruction, string_compose ("Dropping for route %1 ; pre-ref = %2\n", (*i)->name(), (*i).use_count()));
718 (*i)->drop_references ();
722 /* writer goes out of scope and updates master */
727 DEBUG_TRACE (DEBUG::Destruction, "delete sources\n");
728 Glib::Threads::Mutex::Lock lm (source_lock);
729 for (SourceMap::iterator i = sources.begin(); i != sources.end(); ++i) {
730 DEBUG_TRACE(DEBUG::Destruction, string_compose ("Dropping for source %1 ; pre-ref = %2\n", i->second->name(), i->second.use_count()));
731 i->second->drop_references ();
737 /* not strictly necessary, but doing it here allows the shared_ptr debugging to work */
740 emit_thread_terminate ();
742 pthread_cond_destroy (&_rt_emit_cond);
743 pthread_mutex_destroy (&_rt_emit_mutex);
745 pthread_cond_destroy (&_auto_connect_cond);
746 pthread_mutex_destroy (&_auto_connect_mutex);
748 delete _scene_changer; _scene_changer = 0;
749 delete midi_control_ui; midi_control_ui = 0;
751 delete _mmc; _mmc = 0;
752 delete _midi_ports; _midi_ports = 0;
753 delete _locations; _locations = 0;
758 /* clear event queue, the session is gone, nobody is interested in
759 * those anymore, but they do leak memory if not removed
761 while (!immediate_events.empty ()) {
762 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
763 SessionEvent *ev = immediate_events.front ();
764 DEBUG_TRACE (DEBUG::SessionEvents, string_compose ("Drop event: %1\n", enum_2_string (ev->type)));
765 immediate_events.pop_front ();
769 case SessionEvent::AutoLoop:
770 case SessionEvent::AutoLoopDeclick:
771 case SessionEvent::Skip:
772 case SessionEvent::PunchIn:
773 case SessionEvent::PunchOut:
774 case SessionEvent::StopOnce:
775 case SessionEvent::RangeStop:
776 case SessionEvent::RangeLocate:
780 case SessionEvent::RealTimeOperation:
787 del = del && !_remove_event (ev);
794 DEBUG_TRACE (DEBUG::Destruction, "Session::destroy() done\n");
796 BOOST_SHOW_POINTERS ();
800 Session::setup_ltc ()
804 _ltc_input.reset (new IO (*this, X_("LTC In"), IO::Input));
805 _ltc_output.reset (new IO (*this, X_("LTC Out"), IO::Output));
807 if (state_tree && (child = find_named_node (*state_tree->root(), X_("LTC In"))) != 0) {
808 _ltc_input->set_state (*(child->children().front()), Stateful::loading_state_version);
811 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
812 _ltc_input->ensure_io (ChanCount (DataType::AUDIO, 1), true, this);
814 reconnect_ltc_input ();
817 if (state_tree && (child = find_named_node (*state_tree->root(), X_("LTC Out"))) != 0) {
818 _ltc_output->set_state (*(child->children().front()), Stateful::loading_state_version);
821 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
822 _ltc_output->ensure_io (ChanCount (DataType::AUDIO, 1), true, this);
824 reconnect_ltc_output ();
827 /* fix up names of LTC ports because we don't want the normal
828 * IO style of NAME/TYPE-{in,out}N
831 _ltc_input->nth (0)->set_name (X_("LTC-in"));
832 _ltc_output->nth (0)->set_name (X_("LTC-out"));
836 Session::setup_click ()
840 boost::shared_ptr<AutomationList> gl (new AutomationList (Evoral::Parameter (GainAutomation)));
841 boost::shared_ptr<GainControl> gain_control = boost::shared_ptr<GainControl> (new GainControl (*this, Evoral::Parameter(GainAutomation), gl));
843 _click_io.reset (new ClickIO (*this, X_("Click")));
844 _click_gain.reset (new Amp (*this, _("Fader"), gain_control, true));
845 _click_gain->activate ();
847 setup_click_state (state_tree->root());
849 setup_click_state (0);
854 Session::setup_click_state (const XMLNode* node)
856 const XMLNode* child = 0;
858 if (node && (child = find_named_node (*node, "Click")) != 0) {
860 /* existing state for Click */
863 if (Stateful::loading_state_version < 3000) {
864 c = _click_io->set_state_2X (*child->children().front(), Stateful::loading_state_version, false);
866 const XMLNodeList& children (child->children());
867 XMLNodeList::const_iterator i = children.begin();
868 if ((c = _click_io->set_state (**i, Stateful::loading_state_version)) == 0) {
870 if (i != children.end()) {
871 c = _click_gain->set_state (**i, Stateful::loading_state_version);
877 _clicking = Config->get_clicking ();
881 error << _("could not setup Click I/O") << endmsg;
888 /* default state for Click: dual-mono to first 2 physical outputs */
891 _engine.get_physical_outputs (DataType::AUDIO, outs);
893 for (uint32_t physport = 0; physport < 2; ++physport) {
894 if (outs.size() > physport) {
895 if (_click_io->add_port (outs[physport], this)) {
896 // relax, even though its an error
901 if (_click_io->n_ports () > ChanCount::ZERO) {
902 _clicking = Config->get_clicking ();
908 Session::setup_bundles ()
912 RCUWriter<BundleList> writer (_bundles);
913 boost::shared_ptr<BundleList> b = writer.get_copy ();
914 for (BundleList::iterator i = b->begin(); i != b->end();) {
915 if (boost::dynamic_pointer_cast<UserBundle>(*i)) {
923 vector<string> inputs[DataType::num_types];
924 vector<string> outputs[DataType::num_types];
925 for (uint32_t i = 0; i < DataType::num_types; ++i) {
926 _engine.get_physical_inputs (DataType (DataType::Symbol (i)), inputs[i]);
927 _engine.get_physical_outputs (DataType (DataType::Symbol (i)), outputs[i]);
930 /* Create a set of Bundle objects that map
931 to the physical I/O currently available. We create both
932 mono and stereo bundles, so that the common cases of mono
933 and stereo tracks get bundles to put in their mixer strip
934 in / out menus. There may be a nicer way of achieving that;
935 it doesn't really scale that well to higher channel counts
938 /* mono output bundles */
940 for (uint32_t np = 0; np < outputs[DataType::AUDIO].size(); ++np) {
942 std::string pn = _engine.get_pretty_name_by_name (outputs[DataType::AUDIO][np]);
944 snprintf (buf, sizeof (buf), _("out %s"), pn.c_str());
946 snprintf (buf, sizeof (buf), _("out %" PRIu32), np+1);
949 boost::shared_ptr<Bundle> c (new Bundle (buf, true));
950 c->add_channel (_("mono"), DataType::AUDIO);
951 c->set_port (0, outputs[DataType::AUDIO][np]);
953 add_bundle (c, false);
956 /* stereo output bundles */
958 for (uint32_t np = 0; np < outputs[DataType::AUDIO].size(); np += 2) {
959 if (np + 1 < outputs[DataType::AUDIO].size()) {
961 snprintf (buf, sizeof(buf), _("out %" PRIu32 "+%" PRIu32), np + 1, np + 2);
962 boost::shared_ptr<Bundle> c (new Bundle (buf, true));
963 c->add_channel (_("L"), DataType::AUDIO);
964 c->set_port (0, outputs[DataType::AUDIO][np]);
965 c->add_channel (_("R"), DataType::AUDIO);
966 c->set_port (1, outputs[DataType::AUDIO][np + 1]);
968 add_bundle (c, false);
972 /* mono input bundles */
974 for (uint32_t np = 0; np < inputs[DataType::AUDIO].size(); ++np) {
976 std::string pn = _engine.get_pretty_name_by_name (inputs[DataType::AUDIO][np]);
978 snprintf (buf, sizeof (buf), _("in %s"), pn.c_str());
980 snprintf (buf, sizeof (buf), _("in %" PRIu32), np+1);
983 boost::shared_ptr<Bundle> c (new Bundle (buf, false));
984 c->add_channel (_("mono"), DataType::AUDIO);
985 c->set_port (0, inputs[DataType::AUDIO][np]);
987 add_bundle (c, false);
990 /* stereo input bundles */
992 for (uint32_t np = 0; np < inputs[DataType::AUDIO].size(); np += 2) {
993 if (np + 1 < inputs[DataType::AUDIO].size()) {
995 snprintf (buf, sizeof(buf), _("in %" PRIu32 "+%" PRIu32), np + 1, np + 2);
997 boost::shared_ptr<Bundle> c (new Bundle (buf, false));
998 c->add_channel (_("L"), DataType::AUDIO);
999 c->set_port (0, inputs[DataType::AUDIO][np]);
1000 c->add_channel (_("R"), DataType::AUDIO);
1001 c->set_port (1, inputs[DataType::AUDIO][np + 1]);
1003 add_bundle (c, false);
1007 /* MIDI input bundles */
1009 for (uint32_t np = 0; np < inputs[DataType::MIDI].size(); ++np) {
1010 string n = inputs[DataType::MIDI][np];
1011 std::string pn = _engine.get_pretty_name_by_name (n);
1015 boost::erase_first (n, X_("alsa_pcm:"));
1017 boost::shared_ptr<Bundle> c (new Bundle (n, false));
1018 c->add_channel ("", DataType::MIDI);
1019 c->set_port (0, inputs[DataType::MIDI][np]);
1020 add_bundle (c, false);
1023 /* MIDI output bundles */
1025 for (uint32_t np = 0; np < outputs[DataType::MIDI].size(); ++np) {
1026 string n = outputs[DataType::MIDI][np];
1027 std::string pn = _engine.get_pretty_name_by_name (n);
1031 boost::erase_first (n, X_("alsa_pcm:"));
1033 boost::shared_ptr<Bundle> c (new Bundle (n, true));
1034 c->add_channel ("", DataType::MIDI);
1035 c->set_port (0, outputs[DataType::MIDI][np]);
1036 add_bundle (c, false);
1039 // we trust the backend to only calls us if there's a change
1040 BundleAddedOrRemoved (); /* EMIT SIGNAL */
1044 Session::auto_connect_master_bus ()
1046 if (!_master_out || !Config->get_auto_connect_standard_busses() || _monitor_out) {
1050 // Waves Tracks: Do not connect master bas for Tracks if AutoConnectMaster option is not set
1051 // In this case it means "Multi Out" output mode
1052 if (ARDOUR::Profile->get_trx() && !(Config->get_output_auto_connect() & AutoConnectMaster) ) {
1056 /* if requested auto-connect the outputs to the first N physical ports.
1059 uint32_t limit = _master_out->n_outputs().n_total();
1060 vector<string> outputs[DataType::num_types];
1062 for (uint32_t i = 0; i < DataType::num_types; ++i) {
1063 _engine.get_physical_outputs (DataType (DataType::Symbol (i)), outputs[i]);
1066 for (uint32_t n = 0; n < limit; ++n) {
1067 boost::shared_ptr<Port> p = _master_out->output()->nth (n);
1069 if (outputs[p->type()].size() > n) {
1070 connect_to = outputs[p->type()][n];
1073 if (!connect_to.empty() && p->connected_to (connect_to) == false) {
1074 if (_master_out->output()->connect (p, connect_to, this)) {
1075 error << string_compose (_("cannot connect master output %1 to %2"), n, connect_to)
1084 Session::remove_monitor_section ()
1086 if (!_monitor_out || Profile->get_trx()) {
1090 /* force reversion to Solo-In-Place */
1091 Config->set_solo_control_is_listen_control (false);
1093 /* if we are auditioning, cancel it ... this is a workaround
1094 to a problem (auditioning does not execute the process graph,
1095 which is needed to remove routes when using >1 core for processing)
1100 /* Hold process lock while doing this so that we don't hear bits and
1101 * pieces of audio as we work on each route.
1104 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
1106 /* Connect tracks to monitor section. Note that in an
1107 existing session, the internal sends will already exist, but we want the
1108 routes to notice that they connect to the control out specifically.
1112 boost::shared_ptr<RouteList> r = routes.reader ();
1113 PBD::Unwinder<bool> uw (ignore_route_processor_changes, true);
1115 for (RouteList::iterator x = r->begin(); x != r->end(); ++x) {
1117 if ((*x)->is_monitor()) {
1119 } else if ((*x)->is_master()) {
1122 (*x)->remove_aux_or_listen (_monitor_out);
1127 remove_route (_monitor_out);
1128 if (_state_of_the_state & Deletion) {
1132 auto_connect_master_bus ();
1135 auditioner->connect ();
1138 Config->ParameterChanged ("use-monitor-bus");
1142 Session::add_monitor_section ()
1146 if (_monitor_out || !_master_out || Profile->get_trx()) {
1150 boost::shared_ptr<Route> r (new Route (*this, _("Monitor"), Route::MonitorOut, DataType::AUDIO));
1156 BOOST_MARK_ROUTE(r);
1159 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
1160 r->input()->ensure_io (_master_out->output()->n_ports(), false, this);
1161 r->output()->ensure_io (_master_out->output()->n_ports(), false, this);
1163 error << _("Cannot create monitor section. 'Monitor' Port name is not unique.") << endmsg;
1168 add_routes (rl, false, false, false);
1170 assert (_monitor_out);
1172 /* AUDIO ONLY as of june 29th 2009, because listen semantics for anything else
1173 are undefined, at best.
1176 uint32_t limit = _monitor_out->n_inputs().n_audio();
1180 /* connect the inputs to the master bus outputs. this
1181 * represents a separate data feed from the internal sends from
1182 * each route. as of jan 2011, it allows the monitor section to
1183 * conditionally ignore either the internal sends or the normal
1184 * input feed, but we should really find a better way to do
1188 _master_out->output()->disconnect (this);
1190 for (uint32_t n = 0; n < limit; ++n) {
1191 boost::shared_ptr<AudioPort> p = _monitor_out->input()->ports().nth_audio_port (n);
1192 boost::shared_ptr<AudioPort> o = _master_out->output()->ports().nth_audio_port (n);
1195 string connect_to = o->name();
1196 if (_monitor_out->input()->connect (p, connect_to, this)) {
1197 error << string_compose (_("cannot connect control input %1 to %2"), n, connect_to)
1205 /* if monitor section is not connected, connect it to physical outs
1208 if ((Config->get_auto_connect_standard_busses () || Profile->get_mixbus ()) && !_monitor_out->output()->connected ()) {
1210 if (!Config->get_monitor_bus_preferred_bundle().empty()) {
1212 boost::shared_ptr<Bundle> b = bundle_by_name (Config->get_monitor_bus_preferred_bundle());
1215 _monitor_out->output()->connect_ports_to_bundle (b, true, this);
1217 warning << string_compose (_("The preferred I/O for the monitor bus (%1) cannot be found"),
1218 Config->get_monitor_bus_preferred_bundle())
1224 /* Monitor bus is audio only */
1226 vector<string> outputs[DataType::num_types];
1228 for (uint32_t i = 0; i < DataType::num_types; ++i) {
1229 _engine.get_physical_outputs (DataType (DataType::Symbol (i)), outputs[i]);
1232 uint32_t mod = outputs[DataType::AUDIO].size();
1233 uint32_t limit = _monitor_out->n_outputs().get (DataType::AUDIO);
1237 for (uint32_t n = 0; n < limit; ++n) {
1239 boost::shared_ptr<Port> p = _monitor_out->output()->ports().port(DataType::AUDIO, n);
1241 if (outputs[DataType::AUDIO].size() > (n % mod)) {
1242 connect_to = outputs[DataType::AUDIO][n % mod];
1245 if (!connect_to.empty()) {
1246 if (_monitor_out->output()->connect (p, connect_to, this)) {
1247 error << string_compose (
1248 _("cannot connect control output %1 to %2"),
1259 /* Hold process lock while doing this so that we don't hear bits and
1260 * pieces of audio as we work on each route.
1263 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
1265 /* Connect tracks to monitor section. Note that in an
1266 existing session, the internal sends will already exist, but we want the
1267 routes to notice that they connect to the control out specifically.
1271 boost::shared_ptr<RouteList> rls = routes.reader ();
1273 PBD::Unwinder<bool> uw (ignore_route_processor_changes, true);
1275 for (RouteList::iterator x = rls->begin(); x != rls->end(); ++x) {
1277 if ((*x)->is_monitor()) {
1279 } else if ((*x)->is_master()) {
1282 (*x)->enable_monitor_send ();
1287 auditioner->connect ();
1289 Config->ParameterChanged ("use-monitor-bus");
1293 Session::reset_monitor_section ()
1295 /* Process lock should be held by the caller.*/
1297 if (!_monitor_out || Profile->get_trx()) {
1301 uint32_t limit = _master_out->n_outputs().n_audio();
1303 /* connect the inputs to the master bus outputs. this
1304 * represents a separate data feed from the internal sends from
1305 * each route. as of jan 2011, it allows the monitor section to
1306 * conditionally ignore either the internal sends or the normal
1307 * input feed, but we should really find a better way to do
1311 _master_out->output()->disconnect (this);
1312 _monitor_out->output()->disconnect (this);
1314 _monitor_out->input()->ensure_io (_master_out->output()->n_ports(), false, this);
1315 _monitor_out->output()->ensure_io (_master_out->output()->n_ports(), false, this);
1317 for (uint32_t n = 0; n < limit; ++n) {
1318 boost::shared_ptr<AudioPort> p = _monitor_out->input()->ports().nth_audio_port (n);
1319 boost::shared_ptr<AudioPort> o = _master_out->output()->ports().nth_audio_port (n);
1322 string connect_to = o->name();
1323 if (_monitor_out->input()->connect (p, connect_to, this)) {
1324 error << string_compose (_("cannot connect control input %1 to %2"), n, connect_to)
1331 /* connect monitor section to physical outs
1334 if (Config->get_auto_connect_standard_busses()) {
1336 if (!Config->get_monitor_bus_preferred_bundle().empty()) {
1338 boost::shared_ptr<Bundle> b = bundle_by_name (Config->get_monitor_bus_preferred_bundle());
1341 _monitor_out->output()->connect_ports_to_bundle (b, true, this);
1343 warning << string_compose (_("The preferred I/O for the monitor bus (%1) cannot be found"),
1344 Config->get_monitor_bus_preferred_bundle())
1350 /* Monitor bus is audio only */
1352 vector<string> outputs[DataType::num_types];
1354 for (uint32_t i = 0; i < DataType::num_types; ++i) {
1355 _engine.get_physical_outputs (DataType (DataType::Symbol (i)), outputs[i]);
1358 uint32_t mod = outputs[DataType::AUDIO].size();
1359 uint32_t limit = _monitor_out->n_outputs().get (DataType::AUDIO);
1363 for (uint32_t n = 0; n < limit; ++n) {
1365 boost::shared_ptr<Port> p = _monitor_out->output()->ports().port(DataType::AUDIO, n);
1367 if (outputs[DataType::AUDIO].size() > (n % mod)) {
1368 connect_to = outputs[DataType::AUDIO][n % mod];
1371 if (!connect_to.empty()) {
1372 if (_monitor_out->output()->connect (p, connect_to, this)) {
1373 error << string_compose (
1374 _("cannot connect control output %1 to %2"),
1385 /* Connect tracks to monitor section. Note that in an
1386 existing session, the internal sends will already exist, but we want the
1387 routes to notice that they connect to the control out specifically.
1391 boost::shared_ptr<RouteList> rls = routes.reader ();
1393 PBD::Unwinder<bool> uw (ignore_route_processor_changes, true);
1395 for (RouteList::iterator x = rls->begin(); x != rls->end(); ++x) {
1397 if ((*x)->is_monitor()) {
1399 } else if ((*x)->is_master()) {
1402 (*x)->enable_monitor_send ();
1408 Session::hookup_io ()
1410 /* stop graph reordering notifications from
1411 causing resorts, etc.
1414 _state_of_the_state = StateOfTheState (_state_of_the_state | InitialConnecting);
1418 /* we delay creating the auditioner till now because
1419 it makes its own connections to ports.
1423 boost::shared_ptr<Auditioner> a (new Auditioner (*this));
1425 throw failed_constructor ();
1427 a->use_new_diskstream ();
1431 catch (failed_constructor& err) {
1432 warning << _("cannot create Auditioner: no auditioning of regions possible") << endmsg;
1436 /* load bundles, which we may have postponed earlier on */
1437 if (_bundle_xml_node) {
1438 load_bundles (*_bundle_xml_node);
1439 delete _bundle_xml_node;
1442 /* Tell all IO objects to connect themselves together */
1444 IO::enable_connecting ();
1446 /* Now tell all "floating" ports to connect to whatever
1447 they should be connected to.
1450 AudioEngine::instance()->reconnect_ports ();
1452 /* Anyone who cares about input state, wake up and do something */
1454 IOConnectionsComplete (); /* EMIT SIGNAL */
1456 _state_of_the_state = StateOfTheState (_state_of_the_state & ~InitialConnecting);
1458 /* now handle the whole enchilada as if it was one
1459 graph reorder event.
1464 /* update the full solo state, which can't be
1465 correctly determined on a per-route basis, but
1466 needs the global overview that only the session
1470 update_route_solo_state ();
1474 Session::track_playlist_changed (boost::weak_ptr<Track> wp)
1476 boost::shared_ptr<Track> track = wp.lock ();
1481 boost::shared_ptr<Playlist> playlist;
1483 if ((playlist = track->playlist()) != 0) {
1484 playlist->RegionAdded.connect_same_thread (*this, boost::bind (&Session::playlist_region_added, this, _1));
1485 playlist->RangesMoved.connect_same_thread (*this, boost::bind (&Session::playlist_ranges_moved, this, _1));
1486 playlist->RegionsExtended.connect_same_thread (*this, boost::bind (&Session::playlist_regions_extended, this, _1));
1491 Session::record_enabling_legal () const
1493 /* this used to be in here, but survey says.... we don't need to restrict it */
1494 // if (record_status() == Recording) {
1498 if (Config->get_all_safe()) {
1505 Session::set_track_monitor_input_status (bool yn)
1507 boost::shared_ptr<RouteList> rl = routes.reader ();
1508 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
1509 boost::shared_ptr<AudioTrack> tr = boost::dynamic_pointer_cast<AudioTrack> (*i);
1510 if (tr && tr->rec_enable_control()->get_value()) {
1511 //cerr << "switching to input = " << !auto_input << __FILE__ << __LINE__ << endl << endl;
1512 tr->request_input_monitoring (yn);
1518 Session::auto_punch_start_changed (Location* location)
1520 replace_event (SessionEvent::PunchIn, location->start());
1522 if (get_record_enabled() && config.get_punch_in()) {
1523 /* capture start has been changed, so save new pending state */
1524 save_state ("", true);
1529 Session::auto_punch_end_changed (Location* location)
1531 framepos_t when_to_stop = location->end();
1532 // when_to_stop += _worst_output_latency + _worst_input_latency;
1533 replace_event (SessionEvent::PunchOut, when_to_stop);
1537 Session::auto_punch_changed (Location* location)
1539 framepos_t when_to_stop = location->end();
1541 replace_event (SessionEvent::PunchIn, location->start());
1542 //when_to_stop += _worst_output_latency + _worst_input_latency;
1543 replace_event (SessionEvent::PunchOut, when_to_stop);
1546 /** @param loc A loop location.
1547 * @param pos Filled in with the start time of the required fade-out (in session frames).
1548 * @param length Filled in with the length of the required fade-out.
1551 Session::auto_loop_declick_range (Location* loc, framepos_t & pos, framepos_t & length)
1553 pos = max (loc->start(), loc->end() - 64);
1554 length = loc->end() - pos;
1558 Session::auto_loop_changed (Location* location)
1560 replace_event (SessionEvent::AutoLoop, location->end(), location->start());
1563 auto_loop_declick_range (location, dcp, dcl);
1565 if (transport_rolling() && play_loop) {
1567 replace_event (SessionEvent::AutoLoopDeclick, dcp, dcl);
1569 // if (_transport_frame > location->end()) {
1571 if (_transport_frame < location->start() || _transport_frame > location->end()) {
1572 // relocate to beginning of loop
1573 clear_events (SessionEvent::LocateRoll);
1575 request_locate (location->start(), true);
1578 else if (Config->get_seamless_loop() && !loop_changing) {
1580 // schedule a locate-roll to refill the diskstreams at the
1581 // previous loop end
1582 loop_changing = true;
1584 if (location->end() > last_loopend) {
1585 clear_events (SessionEvent::LocateRoll);
1586 SessionEvent *ev = new SessionEvent (SessionEvent::LocateRoll, SessionEvent::Add, last_loopend, last_loopend, 0, true);
1592 clear_events (SessionEvent::AutoLoopDeclick);
1593 clear_events (SessionEvent::AutoLoop);
1596 /* possibly move playhead if not rolling; if we are rolling we'll move
1597 to the loop start on stop if that is appropriate.
1602 if (!transport_rolling() && select_playhead_priority_target (pos)) {
1603 if (pos == location->start()) {
1604 request_locate (pos);
1609 last_loopend = location->end();
1614 Session::set_auto_punch_location (Location* location)
1618 if ((existing = _locations->auto_punch_location()) != 0 && existing != location) {
1619 punch_connections.drop_connections();
1620 existing->set_auto_punch (false, this);
1621 remove_event (existing->start(), SessionEvent::PunchIn);
1622 clear_events (SessionEvent::PunchOut);
1623 auto_punch_location_changed (0);
1628 if (location == 0) {
1632 if (location->end() <= location->start()) {
1633 error << _("Session: you can't use that location for auto punch (start <= end)") << endmsg;
1637 punch_connections.drop_connections ();
1639 location->StartChanged.connect_same_thread (punch_connections, boost::bind (&Session::auto_punch_start_changed, this, location));
1640 location->EndChanged.connect_same_thread (punch_connections, boost::bind (&Session::auto_punch_end_changed, this, location));
1641 location->Changed.connect_same_thread (punch_connections, boost::bind (&Session::auto_punch_changed, this, location));
1643 location->set_auto_punch (true, this);
1645 auto_punch_changed (location);
1647 auto_punch_location_changed (location);
1651 Session::set_session_extents (framepos_t start, framepos_t end)
1654 if ((existing = _locations->session_range_location()) == 0) {
1655 //if there is no existing session, we need to make a new session location (should never happen)
1656 existing = new Location (*this, 0, 0, _("session"), Location::IsSessionRange);
1660 error << _("Session: you can't use that location for session start/end)") << endmsg;
1664 existing->set( start, end );
1670 Session::set_auto_loop_location (Location* location)
1674 if ((existing = _locations->auto_loop_location()) != 0 && existing != location) {
1675 loop_connections.drop_connections ();
1676 existing->set_auto_loop (false, this);
1677 remove_event (existing->end(), SessionEvent::AutoLoop);
1680 auto_loop_declick_range (existing, dcp, dcl);
1681 remove_event (dcp, SessionEvent::AutoLoopDeclick);
1682 auto_loop_location_changed (0);
1687 if (location == 0) {
1691 if (location->end() <= location->start()) {
1692 error << _("You cannot use this location for auto-loop because it has zero or negative length") << endmsg;
1696 last_loopend = location->end();
1698 loop_connections.drop_connections ();
1700 location->StartChanged.connect_same_thread (loop_connections, boost::bind (&Session::auto_loop_changed, this, location));
1701 location->EndChanged.connect_same_thread (loop_connections, boost::bind (&Session::auto_loop_changed, this, location));
1702 location->Changed.connect_same_thread (loop_connections, boost::bind (&Session::auto_loop_changed, this, location));
1703 location->FlagsChanged.connect_same_thread (loop_connections, boost::bind (&Session::auto_loop_changed, this, location));
1705 location->set_auto_loop (true, this);
1707 if (Config->get_loop_is_mode() && play_loop && Config->get_seamless_loop()) {
1708 // set all tracks to use internal looping
1709 boost::shared_ptr<RouteList> rl = routes.reader ();
1710 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
1711 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
1712 if (tr && !tr->hidden()) {
1713 tr->set_loop (location);
1718 /* take care of our stuff first */
1720 auto_loop_changed (location);
1722 /* now tell everyone else */
1724 auto_loop_location_changed (location);
1728 Session::update_marks (Location*)
1734 Session::update_skips (Location* loc, bool consolidate)
1736 if (_ignore_skips_updates) {
1740 Locations::LocationList skips;
1743 PBD::Unwinder<bool> uw (_ignore_skips_updates, true);
1744 consolidate_skips (loc);
1747 sync_locations_to_skips ();
1753 Session::consolidate_skips (Location* loc)
1755 Locations::LocationList all_locations = _locations->list ();
1757 for (Locations::LocationList::iterator l = all_locations.begin(); l != all_locations.end(); ) {
1759 if (!(*l)->is_skip ()) {
1764 /* don't test against self */
1771 switch (Evoral::coverage ((*l)->start(), (*l)->end(), loc->start(), loc->end())) {
1772 case Evoral::OverlapInternal:
1773 case Evoral::OverlapExternal:
1774 case Evoral::OverlapStart:
1775 case Evoral::OverlapEnd:
1776 /* adjust new location to cover existing one */
1777 loc->set_start (min (loc->start(), (*l)->start()));
1778 loc->set_end (max (loc->end(), (*l)->end()));
1779 /* we don't need this one any more */
1780 _locations->remove (*l);
1781 /* the location has been deleted, so remove reference to it in our local list */
1782 l = all_locations.erase (l);
1785 case Evoral::OverlapNone:
1793 Session::sync_locations_to_skips ()
1795 /* This happens asynchronously (in the audioengine thread). After the clear is done, we will call
1796 * Session::_sync_locations_to_skips() from the audioengine thread.
1798 clear_events (SessionEvent::Skip, boost::bind (&Session::_sync_locations_to_skips, this));
1802 Session::_sync_locations_to_skips ()
1804 /* called as a callback after existing Skip events have been cleared from a realtime audioengine thread */
1806 Locations::LocationList const & locs (_locations->list());
1808 for (Locations::LocationList::const_iterator i = locs.begin(); i != locs.end(); ++i) {
1810 Location* location = *i;
1812 if (location->is_skip() && location->is_skipping()) {
1813 SessionEvent* ev = new SessionEvent (SessionEvent::Skip, SessionEvent::Add, location->start(), location->end(), 1.0);
1821 Session::location_added (Location *location)
1823 if (location->is_auto_punch()) {
1824 set_auto_punch_location (location);
1827 if (location->is_auto_loop()) {
1828 set_auto_loop_location (location);
1831 if (location->is_session_range()) {
1832 /* no need for any signal handling or event setting with the session range,
1833 because we keep a direct reference to it and use its start/end directly.
1835 _session_range_location = location;
1838 if (location->is_mark()) {
1839 /* listen for per-location signals that require us to do any * global updates for marks */
1841 location->StartChanged.connect_same_thread (skip_update_connections, boost::bind (&Session::update_marks, this, location));
1842 location->EndChanged.connect_same_thread (skip_update_connections, boost::bind (&Session::update_marks, this, location));
1843 location->Changed.connect_same_thread (skip_update_connections, boost::bind (&Session::update_marks, this, location));
1844 location->FlagsChanged.connect_same_thread (skip_update_connections, boost::bind (&Session::update_marks, this, location));
1847 if (location->is_skip()) {
1848 /* listen for per-location signals that require us to update skip-locate events */
1850 location->StartChanged.connect_same_thread (skip_update_connections, boost::bind (&Session::update_skips, this, location, true));
1851 location->EndChanged.connect_same_thread (skip_update_connections, boost::bind (&Session::update_skips, this, location, true));
1852 location->Changed.connect_same_thread (skip_update_connections, boost::bind (&Session::update_skips, this, location, true));
1853 location->FlagsChanged.connect_same_thread (skip_update_connections, boost::bind (&Session::update_skips, this, location, false));
1855 update_skips (location, true);
1862 Session::location_removed (Location *location)
1864 if (location->is_auto_loop()) {
1865 set_auto_loop_location (0);
1866 set_track_loop (false);
1869 if (location->is_auto_punch()) {
1870 set_auto_punch_location (0);
1873 if (location->is_session_range()) {
1874 /* this is never supposed to happen */
1875 error << _("programming error: session range removed!") << endl;
1878 if (location->is_skip()) {
1880 update_skips (location, false);
1887 Session::locations_changed ()
1889 _locations->apply (*this, &Session::_locations_changed);
1893 Session::_locations_changed (const Locations::LocationList& locations)
1895 /* There was some mass-change in the Locations object.
1897 We might be re-adding a location here but it doesn't actually matter
1898 for all the locations that the Session takes an interest in.
1902 PBD::Unwinder<bool> protect_ignore_skip_updates (_ignore_skips_updates, true);
1903 for (Locations::LocationList::const_iterator i = locations.begin(); i != locations.end(); ++i) {
1904 location_added (*i);
1908 update_skips (NULL, false);
1912 Session::enable_record ()
1914 if (_transport_speed != 0.0 && _transport_speed != 1.0) {
1915 /* no recording at anything except normal speed */
1920 RecordState rs = (RecordState) g_atomic_int_get (&_record_status);
1922 if (rs == Recording) {
1926 if (g_atomic_int_compare_and_exchange (&_record_status, rs, Recording)) {
1928 _last_record_location = _transport_frame;
1929 send_immediate_mmc (MIDI::MachineControlCommand (MIDI::MachineControl::cmdRecordStrobe));
1931 if (Config->get_monitoring_model() == HardwareMonitoring && config.get_auto_input()) {
1932 set_track_monitor_input_status (true);
1935 RecordStateChanged ();
1942 Session::set_all_tracks_record_enabled (bool enable )
1944 boost::shared_ptr<RouteList> rl = routes.reader();
1945 set_controls (route_list_to_control_list (rl, &Track::rec_enable_control), enable, Controllable::NoGroup);
1949 Session::disable_record (bool rt_context, bool force)
1953 if ((rs = (RecordState) g_atomic_int_get (&_record_status)) != Disabled) {
1955 if (!Config->get_latched_record_enable () || force) {
1956 g_atomic_int_set (&_record_status, Disabled);
1957 send_immediate_mmc (MIDI::MachineControlCommand (MIDI::MachineControl::cmdRecordExit));
1959 if (rs == Recording) {
1960 g_atomic_int_set (&_record_status, Enabled);
1964 if (Config->get_monitoring_model() == HardwareMonitoring && config.get_auto_input()) {
1965 set_track_monitor_input_status (false);
1968 RecordStateChanged (); /* emit signal */
1971 remove_pending_capture_state ();
1977 Session::step_back_from_record ()
1979 if (g_atomic_int_compare_and_exchange (&_record_status, Recording, Enabled)) {
1981 if (Config->get_monitoring_model() == HardwareMonitoring && config.get_auto_input()) {
1982 set_track_monitor_input_status (false);
1985 RecordStateChanged (); /* emit signal */
1990 Session::maybe_enable_record ()
1992 if (_step_editors > 0) {
1996 g_atomic_int_set (&_record_status, Enabled);
1998 /* This function is currently called from somewhere other than an RT thread.
1999 This save_state() call therefore doesn't impact anything. Doing it here
2000 means that we save pending state of which sources the next record will use,
2001 which gives us some chance of recovering from a crash during the record.
2004 save_state ("", true);
2006 if (_transport_speed) {
2007 if (!config.get_punch_in()) {
2011 send_immediate_mmc (MIDI::MachineControlCommand (MIDI::MachineControl::cmdRecordPause));
2012 RecordStateChanged (); /* EMIT SIGNAL */
2019 Session::audible_frame () const
2025 offset = worst_playback_latency ();
2027 if (synced_to_engine()) {
2028 /* Note: this is basically just sync-to-JACK */
2029 tf = _engine.transport_frame();
2031 tf = _transport_frame;
2036 if (!non_realtime_work_pending()) {
2040 /* Check to see if we have passed the first guaranteed
2041 audible frame past our last start position. if not,
2042 return that last start point because in terms
2043 of audible frames, we have not moved yet.
2045 `Start position' in this context means the time we last
2046 either started, located, or changed transport direction.
2049 if (_transport_speed > 0.0f) {
2051 if (!play_loop || !have_looped) {
2052 if (tf < _last_roll_or_reversal_location + offset) {
2053 return _last_roll_or_reversal_location;
2061 } else if (_transport_speed < 0.0f) {
2063 /* XXX wot? no backward looping? */
2065 if (tf > _last_roll_or_reversal_location - offset) {
2066 return _last_roll_or_reversal_location;
2078 Session::set_frame_rate (framecnt_t frames_per_second)
2080 /** \fn void Session::set_frame_size(framecnt_t)
2081 the AudioEngine object that calls this guarantees
2082 that it will not be called while we are also in
2083 ::process(). Its fine to do things that block
2087 if (_base_frame_rate == 0) {
2088 _base_frame_rate = frames_per_second;
2090 else if (_base_frame_rate != frames_per_second && frames_per_second != _nominal_frame_rate) {
2091 NotifyAboutSampleRateMismatch (_base_frame_rate, frames_per_second);
2093 _nominal_frame_rate = frames_per_second;
2098 reset_write_sources (false);
2100 // XXX we need some equivalent to this, somehow
2101 // SndFileSource::setup_standard_crossfades (frames_per_second);
2105 /* XXX need to reset/reinstantiate all LADSPA plugins */
2109 Session::set_block_size (pframes_t nframes)
2111 /* the AudioEngine guarantees
2112 that it will not be called while we are also in
2113 ::process(). It is therefore fine to do things that block
2118 current_block_size = nframes;
2122 boost::shared_ptr<RouteList> r = routes.reader ();
2124 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
2125 (*i)->set_block_size (nframes);
2128 boost::shared_ptr<RouteList> rl = routes.reader ();
2129 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
2130 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
2132 tr->set_block_size (nframes);
2136 set_worst_io_latencies ();
2142 trace_terminal (boost::shared_ptr<Route> r1, boost::shared_ptr<Route> rbase)
2144 boost::shared_ptr<Route> r2;
2146 if (r1->feeds (rbase) && rbase->feeds (r1)) {
2147 info << string_compose(_("feedback loop setup between %1 and %2"), r1->name(), rbase->name()) << endmsg;
2151 /* make a copy of the existing list of routes that feed r1 */
2153 Route::FedBy existing (r1->fed_by());
2155 /* for each route that feeds r1, recurse, marking it as feeding
2159 for (Route::FedBy::iterator i = existing.begin(); i != existing.end(); ++i) {
2160 if (!(r2 = i->r.lock ())) {
2161 /* (*i) went away, ignore it */
2165 /* r2 is a route that feeds r1 which somehow feeds base. mark
2166 base as being fed by r2
2169 rbase->add_fed_by (r2, i->sends_only);
2173 /* 2nd level feedback loop detection. if r1 feeds or is fed by r2,
2177 if (r1->feeds (r2) && r2->feeds (r1)) {
2181 /* now recurse, so that we can mark base as being fed by
2182 all routes that feed r2
2185 trace_terminal (r2, rbase);
2192 Session::resort_routes ()
2194 /* don't do anything here with signals emitted
2195 by Routes during initial setup or while we
2196 are being destroyed.
2199 if (_state_of_the_state & (InitialConnecting | Deletion)) {
2203 if (_route_deletion_in_progress) {
2208 RCUWriter<RouteList> writer (routes);
2209 boost::shared_ptr<RouteList> r = writer.get_copy ();
2210 resort_routes_using (r);
2211 /* writer goes out of scope and forces update */
2215 if (DEBUG_ENABLED(DEBUG::Graph)) {
2216 boost::shared_ptr<RouteList> rl = routes.reader ();
2217 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
2218 DEBUG_TRACE (DEBUG::Graph, string_compose ("%1 fed by ...\n", (*i)->name()));
2220 const Route::FedBy& fb ((*i)->fed_by());
2222 for (Route::FedBy::const_iterator f = fb.begin(); f != fb.end(); ++f) {
2223 boost::shared_ptr<Route> sf = f->r.lock();
2225 DEBUG_TRACE (DEBUG::Graph, string_compose ("\t%1 (sends only ? %2)\n", sf->name(), f->sends_only));
2234 /** This is called whenever we need to rebuild the graph of how we will process
2236 * @param r List of routes, in any order.
2240 Session::resort_routes_using (boost::shared_ptr<RouteList> r)
2242 /* We are going to build a directed graph of our routes;
2243 this is where the edges of that graph are put.
2248 /* Go through all routes doing two things:
2250 * 1. Collect the edges of the route graph. Each of these edges
2251 * is a pair of routes, one of which directly feeds the other
2252 * either by a JACK connection or by an internal send.
2254 * 2. Begin the process of making routes aware of which other
2255 * routes directly or indirectly feed them. This information
2256 * is used by the solo code.
2259 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
2261 /* Clear out the route's list of direct or indirect feeds */
2262 (*i)->clear_fed_by ();
2264 for (RouteList::iterator j = r->begin(); j != r->end(); ++j) {
2266 bool via_sends_only;
2268 /* See if this *j feeds *i according to the current state of the JACK
2269 connections and internal sends.
2271 if ((*j)->direct_feeds_according_to_reality (*i, &via_sends_only)) {
2272 /* add the edge to the graph (part #1) */
2273 edges.add (*j, *i, via_sends_only);
2274 /* tell the route (for part #2) */
2275 (*i)->add_fed_by (*j, via_sends_only);
2280 /* Attempt a topological sort of the route graph */
2281 boost::shared_ptr<RouteList> sorted_routes = topological_sort (r, edges);
2283 if (sorted_routes) {
2284 /* We got a satisfactory topological sort, so there is no feedback;
2287 Note: the process graph rechain does not require a
2288 topologically-sorted list, but hey ho.
2290 if (_process_graph) {
2291 _process_graph->rechain (sorted_routes, edges);
2294 _current_route_graph = edges;
2296 /* Complete the building of the routes' lists of what directly
2297 or indirectly feeds them.
2299 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
2300 trace_terminal (*i, *i);
2303 *r = *sorted_routes;
2306 DEBUG_TRACE (DEBUG::Graph, "Routes resorted, order follows:\n");
2307 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
2308 DEBUG_TRACE (DEBUG::Graph, string_compose ("\t%1 signal order %2\n",
2309 (*i)->name(), (*i)->order_key ()));
2313 SuccessfulGraphSort (); /* EMIT SIGNAL */
2316 /* The topological sort failed, so we have a problem. Tell everyone
2317 and stick to the old graph; this will continue to be processed, so
2318 until the feedback is fixed, what is played back will not quite
2319 reflect what is actually connected. Note also that we do not
2320 do trace_terminal here, as it would fail due to an endless recursion,
2321 so the solo code will think that everything is still connected
2325 FeedbackDetected (); /* EMIT SIGNAL */
2330 /** Find a route name starting with \a base, maybe followed by the
2331 * lowest \a id. \a id will always be added if \a definitely_add_number
2332 * is true on entry; otherwise it will only be added if required
2333 * to make the name unique.
2335 * Names are constructed like e.g. "Audio 3" for base="Audio" and id=3.
2336 * The available route name with the lowest ID will be used, and \a id
2337 * will be set to the ID.
2339 * \return false if a route name could not be found, and \a track_name
2340 * and \a id do not reflect a free route name.
2343 Session::find_route_name (string const & base, uint32_t& id, string& name, bool definitely_add_number)
2345 /* the base may conflict with ports that do not belong to existing
2346 routes, but hidden objects like the click track. So check port names
2347 before anything else.
2350 for (vector<string>::const_iterator reserved = reserved_io_names.begin(); reserved != reserved_io_names.end(); ++reserved) {
2351 if (base == *reserved) {
2352 /* Check if this reserved name already exists, and if
2353 so, disallow it without a numeric suffix.
2355 if (route_by_name (*reserved)) {
2356 definitely_add_number = true;
2365 if (!definitely_add_number && route_by_name (base) == 0) {
2366 /* juse use the base */
2372 name = string_compose ("%1 %2", base, id);
2374 if (route_by_name (name) == 0) {
2380 } while (id < (UINT_MAX-1));
2385 /** Count the total ins and outs of all non-hidden tracks in the session and return them in in and out */
2387 Session::count_existing_track_channels (ChanCount& in, ChanCount& out)
2389 in = ChanCount::ZERO;
2390 out = ChanCount::ZERO;
2392 boost::shared_ptr<RouteList> r = routes.reader ();
2394 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
2395 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
2396 if (tr && !tr->is_auditioner()) {
2397 in += tr->n_inputs();
2398 out += tr->n_outputs();
2404 Session::default_track_name_pattern (DataType t)
2407 case DataType::AUDIO:
2408 if (Profile->get_trx()) {
2415 case DataType::MIDI:
2422 /** Caller must not hold process lock
2423 * @param name_template string to use for the start of the name, or "" to use "MIDI".
2424 * @param instrument plugin info for the instrument to insert pre-fader, if any
2426 list<boost::shared_ptr<MidiTrack> >
2427 Session::new_midi_track (const ChanCount& input, const ChanCount& output, boost::shared_ptr<PluginInfo> instrument,
2428 TrackMode mode, RouteGroup* route_group, uint32_t how_many, string name_template, Plugin::PresetRecord* pset)
2431 uint32_t track_id = 0;
2433 RouteList new_routes;
2434 list<boost::shared_ptr<MidiTrack> > ret;
2436 const string name_pattern = default_track_name_pattern (DataType::MIDI);
2437 bool const use_number = (how_many != 1) || name_template.empty () || (name_template == name_pattern);
2440 if (!find_route_name (name_template.empty() ? _("MIDI") : name_template, ++track_id, track_name, use_number)) {
2441 error << "cannot find name for new midi track" << endmsg;
2445 boost::shared_ptr<MidiTrack> track;
2448 track.reset (new MidiTrack (*this, track_name, Route::Flag (0), mode));
2450 if (track->init ()) {
2454 if (Profile->get_mixbus ()) {
2455 track->set_strict_io (true);
2458 track->use_new_diskstream();
2460 BOOST_MARK_TRACK (track);
2463 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
2464 if (track->input()->ensure_io (input, false, this)) {
2465 error << "cannot configure " << input << " out configuration for new midi track" << endmsg;
2469 if (track->output()->ensure_io (output, false, this)) {
2470 error << "cannot configure " << output << " out configuration for new midi track" << endmsg;
2475 track->non_realtime_input_change();
2478 route_group->add (track);
2481 track->DiskstreamChanged.connect_same_thread (*this, boost::bind (&Session::resort_routes, this));
2483 if (Config->get_remote_model() == UserOrdered) {
2484 track->set_remote_control_id (next_control_id());
2487 new_routes.push_back (track);
2488 ret.push_back (track);
2490 RouteAddedOrRemoved (true); /* EMIT SIGNAL */
2493 catch (failed_constructor &err) {
2494 error << _("Session: could not create new midi track.") << endmsg;
2498 catch (AudioEngine::PortRegistrationFailure& pfe) {
2500 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;
2508 if (!new_routes.empty()) {
2509 StateProtector sp (this);
2510 if (Profile->get_trx()) {
2511 add_routes (new_routes, false, false, false);
2513 add_routes (new_routes, true, true, false);
2517 for (RouteList::iterator r = new_routes.begin(); r != new_routes.end(); ++r) {
2518 PluginPtr plugin = instrument->load (*this);
2520 plugin->load_preset (*pset);
2522 boost::shared_ptr<Processor> p (new PluginInsert (*this, plugin));
2523 (*r)->add_processor (p, PreFader);
2533 Session::new_midi_route (RouteGroup* route_group, uint32_t how_many, string name_template, boost::shared_ptr<PluginInfo> instrument, Plugin::PresetRecord* pset)
2536 uint32_t bus_id = 0;
2540 bool const use_number = (how_many != 1) || name_template.empty () || name_template == _("Midi Bus");
2543 if (!find_route_name (name_template.empty () ? _("Midi Bus") : name_template, ++bus_id, bus_name, use_number)) {
2544 error << "cannot find name for new midi bus" << endmsg;
2549 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
2555 if (Profile->get_mixbus ()) {
2556 bus->set_strict_io (true);
2559 BOOST_MARK_ROUTE(bus);
2562 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
2564 if (bus->input()->ensure_io (ChanCount(DataType::MIDI, 1), false, this)) {
2565 error << _("cannot configure new midi bus input") << endmsg;
2570 if (bus->output()->ensure_io (ChanCount(DataType::MIDI, 1), false, this)) {
2571 error << _("cannot configure new midi bus output") << endmsg;
2577 route_group->add (bus);
2579 if (Config->get_remote_model() == UserOrdered) {
2580 bus->set_remote_control_id (next_control_id());
2583 ret.push_back (bus);
2584 RouteAddedOrRemoved (true); /* EMIT SIGNAL */
2588 catch (failed_constructor &err) {
2589 error << _("Session: could not create new audio route.") << endmsg;
2593 catch (AudioEngine::PortRegistrationFailure& pfe) {
2594 error << pfe.what() << endmsg;
2604 StateProtector sp (this);
2605 add_routes (ret, false, false, false);
2608 for (RouteList::iterator r = ret.begin(); r != ret.end(); ++r) {
2609 PluginPtr plugin = instrument->load (*this);
2611 plugin->load_preset (*pset);
2613 boost::shared_ptr<Processor> p (new PluginInsert (*this, plugin));
2614 (*r)->add_processor (p, PreFader);
2625 Session::midi_output_change_handler (IOChange change, void * /*src*/, boost::weak_ptr<Route> wmt)
2627 boost::shared_ptr<Route> midi_track (wmt.lock());
2633 if ((change.type & IOChange::ConfigurationChanged) && Config->get_output_auto_connect() != ManualConnect) {
2635 if (change.after.n_audio() <= change.before.n_audio()) {
2639 /* new audio ports: make sure the audio goes somewhere useful,
2640 * unless the user has no-auto-connect selected.
2642 * The existing ChanCounts don't matter for this call as they are only
2643 * to do with matching input and output indices, and we are only changing
2646 auto_connect_route (midi_track, false, ChanCount(), change.before);
2650 #ifdef USE_TRACKS_CODE_FEATURES
2653 compare_routes_by_remote_id (const boost::shared_ptr<Route>& route1, const boost::shared_ptr<Route>& route2)
2655 return route1->remote_control_id() < route2->remote_control_id();
2659 Session::reconnect_existing_routes (bool withLock, bool reconnect_master, bool reconnect_inputs, bool reconnect_outputs)
2661 // it is not allowed to perform connection
2662 if (!IO::connecting_legal) {
2666 // if we are deleting routes we will call this once at the end
2667 if (_route_deletion_in_progress) {
2671 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock (), Glib::Threads::NOT_LOCK);
2677 // We need to disconnect the route's inputs and outputs first
2678 // basing on autoconnect configuration
2679 bool reconnectIputs = !(Config->get_input_auto_connect() & ManualConnect) && reconnect_inputs;
2680 bool reconnectOutputs = !(Config->get_output_auto_connect() & ManualConnect) && reconnect_outputs;
2682 ChanCount existing_inputs;
2683 ChanCount existing_outputs;
2684 count_existing_track_channels (existing_inputs, existing_outputs);
2686 //ChanCount inputs = ChanCount::ZERO;
2687 //ChanCount outputs = ChanCount::ZERO;
2689 RouteList existing_routes = *routes.reader ();
2690 existing_routes.sort (compare_routes_by_remote_id);
2693 PBD::Unwinder<bool> protect_ignore_changes (_reconnecting_routes_in_progress, true);
2695 vector<string> physinputs;
2696 vector<string> physoutputs;
2698 EngineStateController::instance()->get_physical_audio_outputs(physoutputs);
2699 EngineStateController::instance()->get_physical_audio_inputs(physinputs);
2701 uint32_t input_n = 0;
2702 uint32_t output_n = 0;
2703 RouteList::iterator rIter = existing_routes.begin();
2704 const AutoConnectOption current_input_auto_connection (Config->get_input_auto_connect());
2705 const AutoConnectOption current_output_auto_connection (Config->get_output_auto_connect());
2706 for (; rIter != existing_routes.end(); ++rIter) {
2707 if (*rIter == _master_out || *rIter == _monitor_out ) {
2711 if (current_output_auto_connection == AutoConnectPhysical) {
2712 (*rIter)->amp()->deactivate();
2713 } else if (current_output_auto_connection == AutoConnectMaster) {
2714 (*rIter)->amp()->activate();
2717 if (reconnectIputs) {
2718 (*rIter)->input()->disconnect (this); //GZ: check this; could be heavy
2720 for (uint32_t route_input_n = 0; route_input_n < (*rIter)->n_inputs().get(DataType::AUDIO); ++route_input_n) {
2722 if (current_input_auto_connection & AutoConnectPhysical) {
2724 if ( input_n == physinputs.size() ) {
2728 string port = physinputs[input_n];
2730 if (port.empty() ) {
2731 error << "Physical Input number "<< input_n << " is unavailable and cannot be connected" << endmsg;
2734 //GZ: check this; could be heavy
2735 (*rIter)->input()->connect ((*rIter)->input()->ports().port(DataType::AUDIO, route_input_n), port, this);
2741 if (reconnectOutputs) {
2743 //normalize route ouptuts: reduce the amount outputs to be equal to the amount of inputs
2744 if (current_output_auto_connection & AutoConnectPhysical) {
2746 //GZ: check this; could be heavy
2747 (*rIter)->output()->disconnect (this);
2748 size_t route_inputs_count = (*rIter)->n_inputs().get(DataType::AUDIO);
2750 //GZ: check this; could be heavy
2751 (*rIter)->output()->ensure_io(ChanCount(DataType::AUDIO, route_inputs_count), false, this );
2753 } else if (current_output_auto_connection & AutoConnectMaster){
2755 if (!reconnect_master) {
2759 //GZ: check this; could be heavy
2760 (*rIter)->output()->disconnect (this);
2763 uint32_t master_inputs_count = _master_out->n_inputs().get(DataType::AUDIO);
2764 (*rIter)->output()->ensure_io(ChanCount(DataType::AUDIO, master_inputs_count), false, this );
2766 error << error << "Master bus is not available" << endmsg;
2771 for (uint32_t route_output_n = 0; route_output_n < (*rIter)->n_outputs().get(DataType::AUDIO); ++route_output_n) {
2772 if (current_output_auto_connection & AutoConnectPhysical) {
2774 if ( output_n == physoutputs.size() ) {
2778 string port = physoutputs[output_n];
2780 if (port.empty() ) {
2781 error << "Physical Output number "<< output_n << " is unavailable and cannot be connected" << endmsg;
2784 //GZ: check this; could be heavy
2785 (*rIter)->output()->connect ((*rIter)->output()->ports().port(DataType::AUDIO, route_output_n), port, this);
2788 } else if (current_output_auto_connection & AutoConnectMaster) {
2790 if ( route_output_n == _master_out->n_inputs().get(DataType::AUDIO) ) {
2794 // connect to master bus
2795 string port = _master_out->input()->ports().port(DataType::AUDIO, route_output_n)->name();
2797 if (port.empty() ) {
2798 error << "MasterBus Input number "<< route_output_n << " is unavailable and cannot be connected" << endmsg;
2802 //GZ: check this; could be heavy
2803 (*rIter)->output()->connect ((*rIter)->output()->ports().port(DataType::AUDIO, route_output_n), port, this);
2810 _master_out->output()->disconnect (this);
2811 auto_connect_master_bus ();
2816 session_routes_reconnected (); /* EMIT SIGNAL */
2820 Session::reconnect_midi_scene_ports(bool inputs)
2824 boost::shared_ptr<MidiPort> scene_in_ptr = scene_in();
2826 scene_in_ptr->disconnect_all ();
2828 std::vector<EngineStateController::MidiPortState> midi_port_states;
2829 EngineStateController::instance()->get_physical_midi_input_states (midi_port_states);
2831 std::vector<EngineStateController::MidiPortState>::iterator state_iter = midi_port_states.begin();
2833 for (; state_iter != midi_port_states.end(); ++state_iter) {
2834 if (state_iter->active && state_iter->available && state_iter->scene_connected) {
2835 scene_in_ptr->connect (state_iter->name);
2842 boost::shared_ptr<MidiPort> scene_out_ptr = scene_out();
2844 if (scene_out_ptr ) {
2845 scene_out_ptr->disconnect_all ();
2847 std::vector<EngineStateController::MidiPortState> midi_port_states;
2848 EngineStateController::instance()->get_physical_midi_output_states (midi_port_states);
2850 std::vector<EngineStateController::MidiPortState>::iterator state_iter = midi_port_states.begin();
2852 for (; state_iter != midi_port_states.end(); ++state_iter) {
2853 if (state_iter->active && state_iter->available && state_iter->scene_connected) {
2854 scene_out_ptr->connect (state_iter->name);
2862 Session::reconnect_mtc_ports ()
2864 boost::shared_ptr<MidiPort> mtc_in_ptr = _midi_ports->mtc_input_port();
2870 mtc_in_ptr->disconnect_all ();
2872 std::vector<EngineStateController::MidiPortState> midi_port_states;
2873 EngineStateController::instance()->get_physical_midi_input_states (midi_port_states);
2875 std::vector<EngineStateController::MidiPortState>::iterator state_iter = midi_port_states.begin();
2877 for (; state_iter != midi_port_states.end(); ++state_iter) {
2878 if (state_iter->available && state_iter->mtc_in) {
2879 mtc_in_ptr->connect (state_iter->name);
2883 if (!_midi_ports->mtc_input_port ()->connected () &&
2884 config.get_external_sync () &&
2885 (Config->get_sync_source () == MTC) ) {
2886 config.set_external_sync (false);
2889 if ( ARDOUR::Profile->get_trx () ) {
2890 // Tracks need this signal to update timecode_source_dropdown
2891 MtcOrLtcInputPortChanged (); //emit signal
2896 Session::reconnect_mmc_ports(bool inputs)
2898 if (inputs ) { // get all enabled midi input ports
2900 boost::shared_ptr<MidiPort> mmc_in_ptr = _midi_ports->mmc_in();
2902 mmc_in_ptr->disconnect_all ();
2903 std::vector<std::string> enabled_midi_inputs;
2904 EngineStateController::instance()->get_physical_midi_inputs (enabled_midi_inputs);
2906 std::vector<std::string>::iterator port_iter = enabled_midi_inputs.begin();
2908 for (; port_iter != enabled_midi_inputs.end(); ++port_iter) {
2909 mmc_in_ptr->connect (*port_iter);
2913 } else { // get all enabled midi output ports
2915 boost::shared_ptr<MidiPort> mmc_out_ptr = _midi_ports->mmc_out();
2917 mmc_out_ptr->disconnect_all ();
2918 std::vector<std::string> enabled_midi_outputs;
2919 EngineStateController::instance()->get_physical_midi_outputs (enabled_midi_outputs);
2921 std::vector<std::string>::iterator port_iter = enabled_midi_outputs.begin();
2923 for (; port_iter != enabled_midi_outputs.end(); ++port_iter) {
2924 mmc_out_ptr->connect (*port_iter);
2932 /** Caller must not hold process lock
2933 * @param name_template string to use for the start of the name, or "" to use "Audio".
2935 list< boost::shared_ptr<AudioTrack> >
2936 Session::new_audio_track (int input_channels, int output_channels, TrackMode mode, RouteGroup* route_group,
2937 uint32_t how_many, string name_template)
2940 uint32_t track_id = 0;
2942 RouteList new_routes;
2943 list<boost::shared_ptr<AudioTrack> > ret;
2945 const string name_pattern = default_track_name_pattern (DataType::AUDIO);
2946 bool const use_number = (how_many != 1) || name_template.empty () || (name_template == name_pattern);
2950 if (!find_route_name (name_template.empty() ? _(name_pattern.c_str()) : name_template, ++track_id, track_name, use_number)) {
2951 error << "cannot find name for new audio track" << endmsg;
2955 boost::shared_ptr<AudioTrack> track;
2958 track.reset (new AudioTrack (*this, track_name, Route::Flag (0), mode));
2960 if (track->init ()) {
2964 if (Profile->get_mixbus ()) {
2965 track->set_strict_io (true);
2969 if (ARDOUR::Profile->get_trx ()) {
2970 // TRACKS considers it's not a USE CASE, it's
2971 // a piece of behavior of the session model:
2973 // Gain for a newly created route depends on
2974 // the current output_auto_connect mode:
2976 // 0 for Stereo Out mode
2978 if (Config->get_output_auto_connect() & AutoConnectMaster) {
2979 track->gain_control()->set_value (dB_to_coefficient (0), Controllable::NoGroup);
2983 track->use_new_diskstream();
2985 BOOST_MARK_TRACK (track);
2988 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
2990 if (track->input()->ensure_io (ChanCount(DataType::AUDIO, input_channels), false, this)) {
2991 error << string_compose (
2992 _("cannot configure %1 in/%2 out configuration for new audio track"),
2993 input_channels, output_channels)
2998 if (track->output()->ensure_io (ChanCount(DataType::AUDIO, output_channels), false, this)) {
2999 error << string_compose (
3000 _("cannot configure %1 in/%2 out configuration for new audio track"),
3001 input_channels, output_channels)
3008 route_group->add (track);
3011 track->non_realtime_input_change();
3013 track->DiskstreamChanged.connect_same_thread (*this, boost::bind (&Session::resort_routes, this));
3014 if (Config->get_remote_model() == UserOrdered) {
3015 track->set_remote_control_id (next_control_id());
3018 new_routes.push_back (track);
3019 ret.push_back (track);
3021 RouteAddedOrRemoved (true); /* EMIT SIGNAL */
3024 catch (failed_constructor &err) {
3025 error << _("Session: could not create new audio track.") << endmsg;
3029 catch (AudioEngine::PortRegistrationFailure& pfe) {
3031 error << pfe.what() << endmsg;
3039 if (!new_routes.empty()) {
3040 StateProtector sp (this);
3041 if (Profile->get_trx()) {
3042 add_routes (new_routes, false, false, false);
3044 add_routes (new_routes, true, true, false);
3051 /** Caller must not hold process lock.
3052 * @param name_template string to use for the start of the name, or "" to use "Bus".
3055 Session::new_audio_route (int input_channels, int output_channels, RouteGroup* route_group, uint32_t how_many, string name_template)
3058 uint32_t bus_id = 0;
3062 bool const use_number = (how_many != 1) || name_template.empty () || name_template == _("Bus");
3065 if (!find_route_name (name_template.empty () ? _("Bus") : name_template, ++bus_id, bus_name, use_number)) {
3066 error << "cannot find name for new audio bus" << endmsg;
3071 boost::shared_ptr<Route> bus (new Route (*this, bus_name, Route::Flag(0), DataType::AUDIO));
3077 if (Profile->get_mixbus ()) {
3078 bus->set_strict_io (true);
3081 BOOST_MARK_ROUTE(bus);
3084 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
3086 if (bus->input()->ensure_io (ChanCount(DataType::AUDIO, input_channels), false, this)) {
3087 error << string_compose (_("cannot configure %1 in/%2 out configuration for new audio track"),
3088 input_channels, output_channels)
3094 if (bus->output()->ensure_io (ChanCount(DataType::AUDIO, output_channels), false, this)) {
3095 error << string_compose (_("cannot configure %1 in/%2 out configuration for new audio track"),
3096 input_channels, output_channels)
3103 route_group->add (bus);
3105 if (Config->get_remote_model() == UserOrdered) {
3106 bus->set_remote_control_id (next_control_id());
3109 bus->add_internal_return ();
3111 ret.push_back (bus);
3113 RouteAddedOrRemoved (true); /* EMIT SIGNAL */
3119 catch (failed_constructor &err) {
3120 error << _("Session: could not create new audio route.") << endmsg;
3124 catch (AudioEngine::PortRegistrationFailure& pfe) {
3125 error << pfe.what() << endmsg;
3135 StateProtector sp (this);
3136 if (Profile->get_trx()) {
3137 add_routes (ret, false, false, false);
3139 add_routes (ret, false, true, true); // autoconnect // outputs only
3148 Session::new_route_from_template (uint32_t how_many, const std::string& template_path, const std::string& name_base, PlaylistDisposition pd)
3152 if (!tree.read (template_path.c_str())) {
3156 return new_route_from_template (how_many, *tree.root(), name_base, pd);
3160 Session::new_route_from_template (uint32_t how_many, XMLNode& node, const std::string& name_base, PlaylistDisposition pd)
3163 uint32_t control_id;
3164 uint32_t number = 0;
3165 const uint32_t being_added = how_many;
3166 /* This will prevent the use of any existing XML-provided PBD::ID
3169 Stateful::ForceIDRegeneration force_ids;
3170 IO::disable_connecting ();
3172 control_id = next_control_id ();
3176 /* We're going to modify the node contents a bit so take a
3177 * copy. The node may be re-used when duplicating more than once.
3180 XMLNode node_copy (node);
3185 if (!name_base.empty()) {
3187 /* if we're adding more than one routes, force
3188 * all the names of the new routes to be
3189 * numbered, via the final parameter.
3192 if (!find_route_name (name_base.c_str(), ++number, name, (being_added > 1))) {
3193 fatal << _("Session: UINT_MAX routes? impossible!") << endmsg;
3199 string const route_name = node_copy.property(X_("name"))->value ();
3201 /* generate a new name by adding a number to the end of the template name */
3202 if (!find_route_name (route_name.c_str(), ++number, name, true)) {
3203 fatal << _("Session: UINT_MAX routes? impossible!") << endmsg;
3204 abort(); /*NOTREACHED*/
3208 /* set this name in the XML description that we are about to use */
3210 bool rename_playlist;
3213 rename_playlist = true;
3218 rename_playlist = false;
3221 Route::set_name_in_state (node_copy, name, rename_playlist);
3223 /* trim bitslots from listen sends so that new ones are used */
3224 XMLNodeList children = node_copy.children ();
3225 for (XMLNodeList::iterator i = children.begin(); i != children.end(); ++i) {
3226 if ((*i)->name() == X_("Processor")) {
3227 /* ForceIDRegeneration does not catch the following */
3228 XMLProperty const * role = (*i)->property (X_("role"));
3229 XMLProperty const * type = (*i)->property (X_("type"));
3230 if (role && role->value() == X_("Aux")) {
3231 /* check if the target bus exists.
3232 * we should not save aux-sends in templates.
3234 XMLProperty const * target = (*i)->property (X_("target"));
3236 (*i)->add_property ("type", "dangling-aux-send");
3239 boost::shared_ptr<Route> r = route_by_id (target->value());
3240 if (!r || boost::dynamic_pointer_cast<Track>(r)) {
3241 (*i)->add_property ("type", "dangling-aux-send");
3245 if (role && role->value() == X_("Listen")) {
3246 (*i)->remove_property (X_("bitslot"));
3248 else if (role && (role->value() == X_("Send") || role->value() == X_("Aux"))) {
3250 Delivery::Role xrole;
3251 uint32_t bitslot = 0;
3252 xrole = Delivery::Role (string_2_enum (role->value(), xrole));
3253 std::string name = Send::name_and_id_new_send(*this, xrole, bitslot, false);
3254 snprintf (buf, sizeof (buf), "%" PRIu32, bitslot);
3255 (*i)->remove_property (X_("bitslot"));
3256 (*i)->remove_property (X_("name"));
3257 (*i)->add_property ("bitslot", buf);
3258 (*i)->add_property ("name", name);
3260 else if (type && type->value() == X_("return")) {
3261 // Return::set_state() generates a new one
3262 (*i)->remove_property (X_("bitslot"));
3264 else if (type && type->value() == X_("port")) {
3265 // PortInsert::set_state() handles the bitslot
3266 (*i)->remove_property (X_("bitslot"));
3267 (*i)->add_property ("ignore-name", "1");
3272 boost::shared_ptr<Route> route (XMLRouteFactory (node_copy, 3000));
3275 error << _("Session: cannot create track/bus from template description") << endmsg;
3279 if (boost::dynamic_pointer_cast<Track>(route)) {
3280 /* force input/output change signals so that the new diskstream
3281 picks up the configuration of the route. During session
3282 loading this normally happens in a different way.
3285 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
3287 IOChange change (IOChange::Type (IOChange::ConfigurationChanged | IOChange::ConnectionsChanged));
3288 change.after = route->input()->n_ports();
3289 route->input()->changed (change, this);
3290 change.after = route->output()->n_ports();
3291 route->output()->changed (change, this);
3294 route->set_remote_control_id (control_id);
3297 boost::shared_ptr<Track> track;
3299 if ((track = boost::dynamic_pointer_cast<Track> (route))) {
3302 track->use_new_playlist ();
3305 track->use_copy_playlist ();
3312 ret.push_back (route);
3314 RouteAddedOrRemoved (true); /* EMIT SIGNAL */
3317 catch (failed_constructor &err) {
3318 error << _("Session: could not create new route from template") << endmsg;
3322 catch (AudioEngine::PortRegistrationFailure& pfe) {
3323 error << pfe.what() << endmsg;
3332 StateProtector sp (this);
3333 if (Profile->get_trx()) {
3334 add_routes (ret, false, false, false);
3336 add_routes (ret, true, true, false);
3338 IO::enable_connecting ();
3345 Session::add_routes (RouteList& new_routes, bool input_auto_connect, bool output_auto_connect, bool save)
3348 PBD::Unwinder<bool> aip (_adding_routes_in_progress, true);
3349 add_routes_inner (new_routes, input_auto_connect, output_auto_connect);
3352 error << _("Adding new tracks/busses failed") << endmsg;
3357 update_latency (true);
3358 update_latency (false);
3363 save_state (_current_snapshot_name);
3366 reassign_track_numbers();
3368 update_route_record_state ();
3370 RouteAdded (new_routes); /* EMIT SIGNAL */
3374 Session::add_routes_inner (RouteList& new_routes, bool input_auto_connect, bool output_auto_connect)
3376 ChanCount existing_inputs;
3377 ChanCount existing_outputs;
3378 uint32_t order = next_control_id();
3381 if (_order_hint > -1) {
3382 order = _order_hint;
3386 count_existing_track_channels (existing_inputs, existing_outputs);
3389 RCUWriter<RouteList> writer (routes);
3390 boost::shared_ptr<RouteList> r = writer.get_copy ();
3391 r->insert (r->end(), new_routes.begin(), new_routes.end());
3393 /* if there is no control out and we're not in the middle of loading,
3394 * resort the graph here. if there is a control out, we will resort
3395 * toward the end of this method. if we are in the middle of loading,
3396 * we will resort when done.
3399 if (!_monitor_out && IO::connecting_legal) {
3400 resort_routes_using (r);
3404 for (RouteList::iterator x = new_routes.begin(); x != new_routes.end(); ++x) {
3406 boost::weak_ptr<Route> wpr (*x);
3407 boost::shared_ptr<Route> r (*x);
3409 r->solo_control()->Changed.connect_same_thread (*this, boost::bind (&Session::route_solo_changed, this, _1, _2, wpr));
3410 r->solo_isolate_control()->Changed.connect_same_thread (*this, boost::bind (&Session::route_solo_isolated_changed, this, wpr));
3411 r->mute_control()->Changed.connect_same_thread (*this, boost::bind (&Session::route_mute_changed, this));
3413 r->output()->changed.connect_same_thread (*this, boost::bind (&Session::set_worst_io_latencies_x, this, _1, _2));
3414 r->processors_changed.connect_same_thread (*this, boost::bind (&Session::route_processors_changed, this, _1));
3416 if (r->is_master()) {
3420 if (r->is_monitor()) {
3424 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (r);
3426 tr->PlaylistChanged.connect_same_thread (*this, boost::bind (&Session::track_playlist_changed, this, boost::weak_ptr<Track> (tr)));
3427 track_playlist_changed (boost::weak_ptr<Track> (tr));
3428 tr->rec_enable_control()->Changed.connect_same_thread (*this, boost::bind (&Session::update_route_record_state, this));
3430 boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (tr);
3432 mt->StepEditStatusChange.connect_same_thread (*this, boost::bind (&Session::step_edit_status_change, this, _1));
3433 mt->output()->changed.connect_same_thread (*this, boost::bind (&Session::midi_output_change_handler, this, _1, _2, boost::weak_ptr<Route>(mt)));
3437 if (input_auto_connect || output_auto_connect) {
3438 auto_connect_route (r, input_auto_connect, ChanCount (), ChanCount (), existing_inputs, existing_outputs);
3439 existing_inputs += r->n_inputs();
3440 existing_outputs += r->n_outputs();
3443 /* order keys are a GUI responsibility but we need to set up
3444 reasonable defaults because they also affect the remote control
3445 ID in most situations.
3448 if (!r->has_order_key ()) {
3449 if (r->is_auditioner()) {
3450 /* use an arbitrarily high value */
3451 r->set_order_key (UINT_MAX);
3453 DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("while adding, set %1 to order key %2\n", r->name(), order));
3454 r->set_order_key (order);
3462 if (_monitor_out && IO::connecting_legal) {
3463 Glib::Threads::Mutex::Lock lm (_engine.process_lock());
3465 for (RouteList::iterator x = new_routes.begin(); x != new_routes.end(); ++x) {
3466 if ((*x)->is_monitor()) {
3468 } else if ((*x)->is_master()) {
3471 (*x)->enable_monitor_send ();
3478 Session::globally_set_send_gains_to_zero (boost::shared_ptr<Route> dest)
3480 boost::shared_ptr<RouteList> r = routes.reader ();
3481 boost::shared_ptr<Send> s;
3483 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3484 if ((s = (*i)->internal_send_for (dest)) != 0) {
3485 s->amp()->gain_control()->set_value (GAIN_COEFF_ZERO, Controllable::NoGroup);
3491 Session::globally_set_send_gains_to_unity (boost::shared_ptr<Route> dest)
3493 boost::shared_ptr<RouteList> r = routes.reader ();
3494 boost::shared_ptr<Send> s;
3496 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3497 if ((s = (*i)->internal_send_for (dest)) != 0) {
3498 s->amp()->gain_control()->set_value (GAIN_COEFF_UNITY, Controllable::NoGroup);
3504 Session::globally_set_send_gains_from_track(boost::shared_ptr<Route> dest)
3506 boost::shared_ptr<RouteList> r = routes.reader ();
3507 boost::shared_ptr<Send> s;
3509 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3510 if ((s = (*i)->internal_send_for (dest)) != 0) {
3511 s->amp()->gain_control()->set_value ((*i)->gain_control()->get_value(), Controllable::NoGroup);
3516 /** @param include_buses true to add sends to buses and tracks, false for just tracks */
3518 Session::globally_add_internal_sends (boost::shared_ptr<Route> dest, Placement p, bool include_buses)
3520 boost::shared_ptr<RouteList> r = routes.reader ();
3521 boost::shared_ptr<RouteList> t (new RouteList);
3523 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3524 /* no MIDI sends because there are no MIDI busses yet */
3525 if (include_buses || boost::dynamic_pointer_cast<AudioTrack>(*i)) {
3530 add_internal_sends (dest, p, t);
3534 Session::add_internal_sends (boost::shared_ptr<Route> dest, Placement p, boost::shared_ptr<RouteList> senders)
3536 for (RouteList::iterator i = senders->begin(); i != senders->end(); ++i) {
3537 add_internal_send (dest, (*i)->before_processor_for_placement (p), *i);
3542 Session::add_internal_send (boost::shared_ptr<Route> dest, int index, boost::shared_ptr<Route> sender)
3544 add_internal_send (dest, sender->before_processor_for_index (index), sender);
3548 Session::add_internal_send (boost::shared_ptr<Route> dest, boost::shared_ptr<Processor> before, boost::shared_ptr<Route> sender)
3550 if (sender->is_monitor() || sender->is_master() || sender == dest || dest->is_monitor() || dest->is_master()) {
3554 if (!dest->internal_return()) {
3555 dest->add_internal_return ();
3558 sender->add_aux_send (dest, before);
3564 Session::remove_routes (boost::shared_ptr<RouteList> routes_to_remove)
3566 { // RCU Writer scope
3567 PBD::Unwinder<bool> uw_flag (_route_deletion_in_progress, true);
3568 RCUWriter<RouteList> writer (routes);
3569 boost::shared_ptr<RouteList> rs = writer.get_copy ();
3572 for (RouteList::iterator iter = routes_to_remove->begin(); iter != routes_to_remove->end(); ++iter) {
3574 if (*iter == _master_out) {
3578 (*iter)->solo_control()->set_value (0.0, Controllable::NoGroup);
3582 /* deleting the master out seems like a dumb
3583 idea, but its more of a UI policy issue
3587 if (*iter == _master_out) {
3588 _master_out = boost::shared_ptr<Route> ();
3591 if (*iter == _monitor_out) {
3592 _monitor_out.reset ();
3595 // We need to disconnect the route's inputs and outputs
3597 (*iter)->input()->disconnect (0);
3598 (*iter)->output()->disconnect (0);
3600 /* if the route had internal sends sending to it, remove them */
3601 if ((*iter)->internal_return()) {
3603 boost::shared_ptr<RouteList> r = routes.reader ();
3604 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3605 boost::shared_ptr<Send> s = (*i)->internal_send_for (*iter);
3607 (*i)->remove_processor (s);
3612 /* if the monitoring section had a pointer to this route, remove it */
3613 if (_monitor_out && !(*iter)->is_master() && !(*iter)->is_monitor()) {
3614 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
3615 PBD::Unwinder<bool> uw (ignore_route_processor_changes, true);
3616 (*iter)->remove_aux_or_listen (_monitor_out);
3619 boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (*iter);
3620 if (mt && mt->step_editing()) {
3621 if (_step_editors > 0) {
3627 /* writer goes out of scope, forces route list update */
3629 } // end of RCU Writer scope
3631 update_route_solo_state ();
3632 RouteAddedOrRemoved (false); /* EMIT SIGNAL */
3633 update_latency_compensation ();
3636 /* Re-sort routes to remove the graph's current references to the one that is
3637 * going away, then flush old references out of the graph.
3638 * Wave Tracks: reconnect routes
3641 #ifdef USE_TRACKS_CODE_FEATURES
3642 reconnect_existing_routes(true, false);
3644 routes.flush (); // maybe unsafe, see below.
3648 if (_process_graph && !(_state_of_the_state & Deletion)) {
3649 _process_graph->clear_other_chain ();
3652 /* get rid of it from the dead wood collection in the route list manager */
3653 /* XXX i think this is unsafe as it currently stands, but i am not sure. (pd, october 2nd, 2006) */
3657 /* try to cause everyone to drop their references
3658 * and unregister ports from the backend
3661 for (RouteList::iterator iter = routes_to_remove->begin(); iter != routes_to_remove->end(); ++iter) {
3662 (*iter)->drop_references ();
3665 if (_state_of_the_state & Deletion) {
3669 Route::RemoteControlIDChange(); /* EMIT SIGNAL */
3671 /* save the new state of the world */
3673 if (save_state (_current_snapshot_name)) {
3674 save_history (_current_snapshot_name);
3677 reassign_track_numbers();
3678 update_route_record_state ();
3682 Session::remove_route (boost::shared_ptr<Route> route)
3684 boost::shared_ptr<RouteList> rl (new RouteList);
3685 rl->push_back (route);
3690 Session::route_mute_changed ()
3696 Session::route_listen_changed (Controllable::GroupControlDisposition group_override, boost::weak_ptr<Route> wpr)
3698 boost::shared_ptr<Route> route (wpr.lock());
3704 if (route->listening_via_monitor ()) {
3706 if (Config->get_exclusive_solo()) {
3708 RouteGroup* rg = route->route_group ();
3709 const bool group_already_accounted_for = route->use_group (group_override, &RouteGroup::is_solo);
3711 boost::shared_ptr<RouteList> r = routes.reader ();
3713 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3714 if ((*i) == route) {
3715 /* already changed */
3719 if ((*i)->solo_isolate_control()->solo_isolated() || !(*i)->can_solo()) {
3720 /* route does not get solo propagated to it */
3724 if ((group_already_accounted_for && (*i)->route_group() && (*i)->route_group() == rg)) {
3725 /* this route is a part of the same solo group as the route
3726 * that was changed. Changing that route did change or will
3727 * change all group members appropriately, so we can ignore it
3732 (*i)->solo_control()->set_value (0.0, Controllable::NoGroup);
3738 } else if (_listen_cnt > 0) {
3743 update_route_solo_state ();
3747 Session::route_solo_isolated_changed (boost::weak_ptr<Route> wpr)
3749 boost::shared_ptr<Route> route (wpr.lock());
3755 bool send_changed = false;
3757 if (route->solo_isolate_control()->solo_isolated()) {
3758 if (_solo_isolated_cnt == 0) {
3759 send_changed = true;
3761 _solo_isolated_cnt++;
3762 } else if (_solo_isolated_cnt > 0) {
3763 _solo_isolated_cnt--;
3764 if (_solo_isolated_cnt == 0) {
3765 send_changed = true;
3770 IsolatedChanged (); /* EMIT SIGNAL */
3775 Session::route_solo_changed (bool self_solo_change, Controllable::GroupControlDisposition group_override, boost::weak_ptr<Route> wpr)
3777 cerr << "route solo change (self ? " << self_solo_change << endl;
3779 DEBUG_TRACE (DEBUG::Solo, string_compose ("route solo change, self = %1\n", self_solo_change));
3781 boost::shared_ptr<Route> route (wpr.lock());
3787 if (Config->get_solo_control_is_listen_control()) {
3788 route_listen_changed (group_override, wpr);
3792 if (!self_solo_change) {
3793 // session doesn't care about changes to soloed-by-others
3797 boost::shared_ptr<RouteList> r = routes.reader ();
3800 if (route->self_soloed()) {
3806 /* the route may be a member of a group that has shared-solo
3807 * semantics. If so, then all members of that group should follow the
3808 * solo of the changed route. But ... this is optional, controlled by a
3809 * Controllable::GroupControlDisposition.
3811 * The first argument to the signal that this method is connected to is the
3812 * GroupControlDisposition value that was used to change solo.
3814 * If the solo change was done with group semantics (either InverseGroup
3815 * (force the entire group to change even if the group shared solo is
3816 * disabled) or UseGroup (use the group, which may or may not have the
3817 * shared solo property enabled)) then as we propagate the change to
3818 * the entire session we should IGNORE THE GROUP that the changed route
3822 RouteGroup* rg = route->route_group ();
3823 const bool group_already_accounted_for = (group_override == Controllable::ForGroup);
3825 if (delta == 1 && Config->get_exclusive_solo()) {
3827 /* new solo: disable all other solos, but not the group if its solo-enabled */
3829 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3831 if ((*i) == route) {
3832 /* already changed */
3836 if ((*i)->solo_isolate_control()->solo_isolated() || !(*i)->can_solo()) {
3837 /* route does not get solo propagated to it */
3841 if ((group_already_accounted_for && (*i)->route_group() && (*i)->route_group() == rg)) {
3842 /* this route is a part of the same solo group as the route
3843 * that was changed. Changing that route did change or will
3844 * change all group members appropriately, so we can ignore it
3850 (*i)->solo_control()->set_value (0.0, group_override);
3854 DEBUG_TRACE (DEBUG::Solo, string_compose ("propagate solo change, delta = %1\n", delta));
3856 RouteList uninvolved;
3858 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1\n", route->name()));
3860 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3861 bool via_sends_only;
3862 bool in_signal_flow;
3864 if ((*i) == route) {
3865 /* already changed */
3869 if ((*i)->solo_isolate_control()->solo_isolated() || !(*i)->can_solo()) {
3870 /* route does not get solo propagated to it */
3874 if ((group_already_accounted_for && (*i)->route_group() && (*i)->route_group() == rg)) {
3875 /* this route is a part of the same solo group as the route
3876 * that was changed. Changing that route did change or will
3877 * change all group members appropriately, so we can ignore it
3883 in_signal_flow = false;
3885 DEBUG_TRACE (DEBUG::Solo, string_compose ("check feed from %1\n", (*i)->name()));
3887 if ((*i)->feeds (route, &via_sends_only)) {
3888 DEBUG_TRACE (DEBUG::Solo, string_compose ("\tthere is a feed from %1\n", (*i)->name()));
3889 if (!via_sends_only) {
3890 if (!route->soloed_by_others_upstream()) {
3891 (*i)->solo_control()->mod_solo_by_others_downstream (delta);
3893 DEBUG_TRACE (DEBUG::Solo, "\talready soloed by others upstream\n");
3896 DEBUG_TRACE (DEBUG::Solo, string_compose ("\tthere is a send-only feed from %1\n", (*i)->name()));
3898 in_signal_flow = true;
3900 DEBUG_TRACE (DEBUG::Solo, string_compose ("\tno feed from %1\n", (*i)->name()));
3903 DEBUG_TRACE (DEBUG::Solo, string_compose ("check feed to %1\n", (*i)->name()));
3905 if (route->feeds (*i, &via_sends_only)) {
3906 /* propagate solo upstream only if routing other than
3907 sends is involved, but do consider the other route
3908 (*i) to be part of the signal flow even if only
3911 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1 feeds %2 via sends only %3 sboD %4 sboU %5\n",
3915 route->soloed_by_others_downstream(),
3916 route->soloed_by_others_upstream()));
3917 if (!via_sends_only) {
3918 //NB. Triggers Invert Push, which handles soloed by downstream
3919 DEBUG_TRACE (DEBUG::Solo, string_compose ("\tmod %1 by %2\n", (*i)->name(), delta));
3920 (*i)->solo_control()->mod_solo_by_others_upstream (delta);
3922 DEBUG_TRACE (DEBUG::Solo, string_compose ("\tfeed to %1 ignored, sends-only\n", (*i)->name()));
3924 in_signal_flow = true;
3926 DEBUG_TRACE (DEBUG::Solo, "\tno feed to\n");
3929 if (!in_signal_flow) {
3930 uninvolved.push_back (*i);
3934 DEBUG_TRACE (DEBUG::Solo, "propagation complete\n");
3936 update_route_solo_state (r);
3938 /* now notify that the mute state of the routes not involved in the signal
3939 pathway of the just-solo-changed route may have altered.
3942 for (RouteList::iterator i = uninvolved.begin(); i != uninvolved.end(); ++i) {
3943 DEBUG_TRACE (DEBUG::Solo, string_compose ("mute change for %1, which neither feeds or is fed by %2\n", (*i)->name(), route->name()));
3944 (*i)->act_on_mute ();
3945 (*i)->mute_control()->Changed (false, Controllable::NoGroup);
3948 SoloChanged (); /* EMIT SIGNAL */
3953 Session::update_route_solo_state (boost::shared_ptr<RouteList> r)
3955 /* now figure out if anything that matters is soloed (or is "listening")*/
3957 bool something_soloed = false;
3958 bool something_listening = false;
3959 uint32_t listeners = 0;
3960 uint32_t isolated = 0;
3963 r = routes.reader();
3966 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3967 if ((*i)->can_solo() && (*i)->self_soloed()) {
3968 something_soloed = true;
3971 if (!(*i)->is_auditioner() && (*i)->listening_via_monitor()) {
3972 if (Config->get_solo_control_is_listen_control()) {
3974 something_listening = true;
3976 (*i)->set_listen (false);
3980 if ((*i)->solo_isolate_control()->solo_isolated()) {
3985 if (something_soloed != _non_soloed_outs_muted) {
3986 _non_soloed_outs_muted = something_soloed;
3987 SoloActive (_non_soloed_outs_muted); /* EMIT SIGNAL */
3990 if (something_listening != _listening) {
3991 _listening = something_listening;
3992 SoloActive (_listening);
3995 _listen_cnt = listeners;
3997 if (isolated != _solo_isolated_cnt) {
3998 _solo_isolated_cnt = isolated;
3999 IsolatedChanged (); /* EMIT SIGNAL */
4002 DEBUG_TRACE (DEBUG::Solo, string_compose ("solo state updated by session, soloed? %1 listeners %2 isolated %3\n",
4003 something_soloed, listeners, isolated));
4006 boost::shared_ptr<RouteList>
4007 Session::get_routes_with_internal_returns() const
4009 boost::shared_ptr<RouteList> r = routes.reader ();
4010 boost::shared_ptr<RouteList> rl (new RouteList);
4012 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4013 if ((*i)->internal_return ()) {
4021 Session::io_name_is_legal (const std::string& name)
4023 boost::shared_ptr<RouteList> r = routes.reader ();
4025 for (vector<string>::const_iterator reserved = reserved_io_names.begin(); reserved != reserved_io_names.end(); ++reserved) {
4026 if (name == *reserved) {
4027 if (!route_by_name (*reserved)) {
4028 /* first instance of a reserved name is allowed */
4031 /* all other instances of a reserved name are not allowed */
4036 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4037 if ((*i)->name() == name) {
4041 if ((*i)->has_io_processor_named (name)) {
4050 Session::set_exclusive_input_active (boost::shared_ptr<RouteList> rl, bool onoff, bool flip_others)
4053 vector<string> connections;
4055 /* if we are passed only a single route and we're not told to turn
4056 * others off, then just do the simple thing.
4059 if (flip_others == false && rl->size() == 1) {
4060 boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (rl->front());
4062 mt->set_input_active (onoff);
4067 for (RouteList::iterator rt = rl->begin(); rt != rl->end(); ++rt) {
4069 PortSet& ps ((*rt)->input()->ports());
4071 for (PortSet::iterator p = ps.begin(); p != ps.end(); ++p) {
4072 p->get_connections (connections);
4075 for (vector<string>::iterator s = connections.begin(); s != connections.end(); ++s) {
4076 routes_using_input_from (*s, rl2);
4079 /* scan all relevant routes to see if others are on or off */
4081 bool others_are_already_on = false;
4083 for (RouteList::iterator r = rl2.begin(); r != rl2.end(); ++r) {
4085 boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (*r);
4091 if ((*r) != (*rt)) {
4092 if (mt->input_active()) {
4093 others_are_already_on = true;
4096 /* this one needs changing */
4097 mt->set_input_active (onoff);
4103 /* globally reverse other routes */
4105 for (RouteList::iterator r = rl2.begin(); r != rl2.end(); ++r) {
4106 if ((*r) != (*rt)) {
4107 boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (*r);
4109 mt->set_input_active (!others_are_already_on);
4118 Session::routes_using_input_from (const string& str, RouteList& rl)
4120 boost::shared_ptr<RouteList> r = routes.reader();
4122 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4123 if ((*i)->input()->connected_to (str)) {
4129 boost::shared_ptr<Route>
4130 Session::route_by_name (string name)
4132 boost::shared_ptr<RouteList> r = routes.reader ();
4134 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4135 if ((*i)->name() == name) {
4140 return boost::shared_ptr<Route> ((Route*) 0);
4143 boost::shared_ptr<Route>
4144 Session::route_by_id (PBD::ID id)
4146 boost::shared_ptr<RouteList> r = routes.reader ();
4148 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4149 if ((*i)->id() == id) {
4154 return boost::shared_ptr<Route> ((Route*) 0);
4157 boost::shared_ptr<Processor>
4158 Session::processor_by_id (PBD::ID id) const
4160 boost::shared_ptr<RouteList> r = routes.reader ();
4162 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4163 boost::shared_ptr<Processor> p = (*i)->Route::processor_by_id (id);
4169 return boost::shared_ptr<Processor> ();
4172 boost::shared_ptr<Track>
4173 Session::track_by_diskstream_id (PBD::ID id)
4175 boost::shared_ptr<RouteList> r = routes.reader ();
4177 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4178 boost::shared_ptr<Track> t = boost::dynamic_pointer_cast<Track> (*i);
4179 if (t && t->using_diskstream_id (id)) {
4184 return boost::shared_ptr<Track> ();
4187 boost::shared_ptr<Route>
4188 Session::route_by_remote_id (uint32_t id)
4190 boost::shared_ptr<RouteList> r = routes.reader ();
4192 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4193 if ((*i)->remote_control_id() == id) {
4198 return boost::shared_ptr<Route> ((Route*) 0);
4202 boost::shared_ptr<Stripable>
4203 Session::stripable_by_remote_id (uint32_t id)
4205 boost::shared_ptr<RouteList> r = routes.reader ();
4207 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4208 if ((*i)->remote_control_id() == id) {
4213 return boost::shared_ptr<Route> ((Route*) 0);
4217 boost::shared_ptr<Route>
4218 Session::route_by_selected_count (uint32_t id)
4220 boost::shared_ptr<RouteList> r = routes.reader ();
4222 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4223 /* NOT IMPLEMENTED */
4226 return boost::shared_ptr<Route> ((Route*) 0);
4231 Session::reassign_track_numbers ()
4235 RouteList r (*(routes.reader ()));
4236 SignalOrderRouteSorter sorter;
4239 StateProtector sp (this);
4241 for (RouteList::iterator i = r.begin(); i != r.end(); ++i) {
4242 if (boost::dynamic_pointer_cast<Track> (*i)) {
4243 (*i)->set_track_number(++tn);
4245 else if (!(*i)->is_master() && !(*i)->is_monitor() && !(*i)->is_auditioner()) {
4246 (*i)->set_track_number(--bn);
4249 const uint32_t decimals = ceilf (log10f (tn + 1));
4250 const bool decimals_changed = _track_number_decimals != decimals;
4251 _track_number_decimals = decimals;
4253 if (decimals_changed && config.get_track_name_number ()) {
4254 for (RouteList::iterator i = r.begin(); i != r.end(); ++i) {
4255 boost::shared_ptr<Track> t = boost::dynamic_pointer_cast<Track> (*i);
4257 t->resync_track_name();
4260 // trigger GUI re-layout
4261 config.ParameterChanged("track-name-number");
4266 Session::playlist_region_added (boost::weak_ptr<Region> w)
4268 boost::shared_ptr<Region> r = w.lock ();
4273 /* These are the operations that are currently in progress... */
4274 list<GQuark> curr = _current_trans_quarks;
4277 /* ...and these are the operations during which we want to update
4278 the session range location markers.
4281 ops.push_back (Operations::capture);
4282 ops.push_back (Operations::paste);
4283 ops.push_back (Operations::duplicate_region);
4284 ops.push_back (Operations::insert_file);
4285 ops.push_back (Operations::insert_region);
4286 ops.push_back (Operations::drag_region_brush);
4287 ops.push_back (Operations::region_drag);
4288 ops.push_back (Operations::selection_grab);
4289 ops.push_back (Operations::region_fill);
4290 ops.push_back (Operations::fill_selection);
4291 ops.push_back (Operations::create_region);
4292 ops.push_back (Operations::region_copy);
4293 ops.push_back (Operations::fixed_time_region_copy);
4296 /* See if any of the current operations match the ones that we want */
4298 set_intersection (_current_trans_quarks.begin(), _current_trans_quarks.end(), ops.begin(), ops.end(), back_inserter (in));
4300 /* If so, update the session range markers */
4302 maybe_update_session_range (r->position (), r->last_frame ());
4306 /** Update the session range markers if a is before the current start or
4307 * b is after the current end.
4310 Session::maybe_update_session_range (framepos_t a, framepos_t b)
4312 if (_state_of_the_state & Loading) {
4316 framepos_t session_end_marker_shift_samples = session_end_shift * _nominal_frame_rate;
4318 if (_session_range_location == 0) {
4320 set_session_range_location (a, b + session_end_marker_shift_samples);
4324 if (a < _session_range_location->start()) {
4325 _session_range_location->set_start (a);
4328 if (b > _session_range_location->end()) {
4329 _session_range_location->set_end (b);
4335 Session::playlist_ranges_moved (list<Evoral::RangeMove<framepos_t> > const & ranges)
4337 for (list<Evoral::RangeMove<framepos_t> >::const_iterator i = ranges.begin(); i != ranges.end(); ++i) {
4338 maybe_update_session_range (i->to, i->to + i->length);
4343 Session::playlist_regions_extended (list<Evoral::Range<framepos_t> > const & ranges)
4345 for (list<Evoral::Range<framepos_t> >::const_iterator i = ranges.begin(); i != ranges.end(); ++i) {
4346 maybe_update_session_range (i->from, i->to);
4350 /* Region management */
4352 boost::shared_ptr<Region>
4353 Session::find_whole_file_parent (boost::shared_ptr<Region const> child) const
4355 const RegionFactory::RegionMap& regions (RegionFactory::regions());
4356 RegionFactory::RegionMap::const_iterator i;
4357 boost::shared_ptr<Region> region;
4359 Glib::Threads::Mutex::Lock lm (region_lock);
4361 for (i = regions.begin(); i != regions.end(); ++i) {
4365 if (region->whole_file()) {
4367 if (child->source_equivalent (region)) {
4373 return boost::shared_ptr<Region> ();
4377 Session::destroy_sources (list<boost::shared_ptr<Source> > srcs)
4379 set<boost::shared_ptr<Region> > relevant_regions;
4381 for (list<boost::shared_ptr<Source> >::iterator s = srcs.begin(); s != srcs.end(); ++s) {
4382 RegionFactory::get_regions_using_source (*s, relevant_regions);
4385 for (set<boost::shared_ptr<Region> >::iterator r = relevant_regions.begin(); r != relevant_regions.end(); ) {
4386 set<boost::shared_ptr<Region> >::iterator tmp;
4391 playlists->destroy_region (*r);
4392 RegionFactory::map_remove (*r);
4394 (*r)->drop_sources ();
4395 (*r)->drop_references ();
4397 relevant_regions.erase (r);
4402 for (list<boost::shared_ptr<Source> >::iterator s = srcs.begin(); s != srcs.end(); ) {
4405 Glib::Threads::Mutex::Lock ls (source_lock);
4406 /* remove from the main source list */
4407 sources.erase ((*s)->id());
4410 (*s)->mark_for_remove ();
4411 (*s)->drop_references ();
4420 Session::remove_last_capture ()
4422 list<boost::shared_ptr<Source> > srcs;
4424 boost::shared_ptr<RouteList> rl = routes.reader ();
4425 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
4426 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
4431 list<boost::shared_ptr<Source> >& l = tr->last_capture_sources();
4434 srcs.insert (srcs.end(), l.begin(), l.end());
4439 destroy_sources (srcs);
4441 save_state (_current_snapshot_name);
4446 /* Source Management */
4449 Session::add_source (boost::shared_ptr<Source> source)
4451 pair<SourceMap::key_type, SourceMap::mapped_type> entry;
4452 pair<SourceMap::iterator,bool> result;
4454 entry.first = source->id();
4455 entry.second = source;
4458 Glib::Threads::Mutex::Lock lm (source_lock);
4459 result = sources.insert (entry);
4462 if (result.second) {
4464 /* yay, new source */
4466 boost::shared_ptr<FileSource> fs = boost::dynamic_pointer_cast<FileSource> (source);
4469 if (!fs->within_session()) {
4470 ensure_search_path_includes (Glib::path_get_dirname (fs->path()), fs->type());
4476 boost::shared_ptr<AudioFileSource> afs;
4478 if ((afs = boost::dynamic_pointer_cast<AudioFileSource>(source)) != 0) {
4479 if (Config->get_auto_analyse_audio()) {
4480 Analyser::queue_source_for_analysis (source, false);
4484 source->DropReferences.connect_same_thread (*this, boost::bind (&Session::remove_source, this, boost::weak_ptr<Source> (source)));
4489 Session::remove_source (boost::weak_ptr<Source> src)
4491 if (_state_of_the_state & Deletion) {
4495 SourceMap::iterator i;
4496 boost::shared_ptr<Source> source = src.lock();
4503 Glib::Threads::Mutex::Lock lm (source_lock);
4505 if ((i = sources.find (source->id())) != sources.end()) {
4510 if (!(_state_of_the_state & StateOfTheState (InCleanup|Loading))) {
4512 /* save state so we don't end up with a session file
4513 referring to non-existent sources.
4516 save_state (_current_snapshot_name);
4520 boost::shared_ptr<Source>
4521 Session::source_by_id (const PBD::ID& id)
4523 Glib::Threads::Mutex::Lock lm (source_lock);
4524 SourceMap::iterator i;
4525 boost::shared_ptr<Source> source;
4527 if ((i = sources.find (id)) != sources.end()) {
4534 boost::shared_ptr<AudioFileSource>
4535 Session::audio_source_by_path_and_channel (const string& path, uint16_t chn) const
4537 /* Restricted to audio files because only audio sources have channel
4541 Glib::Threads::Mutex::Lock lm (source_lock);
4543 for (SourceMap::const_iterator i = sources.begin(); i != sources.end(); ++i) {
4544 boost::shared_ptr<AudioFileSource> afs
4545 = boost::dynamic_pointer_cast<AudioFileSource>(i->second);
4547 if (afs && afs->path() == path && chn == afs->channel()) {
4552 return boost::shared_ptr<AudioFileSource>();
4555 boost::shared_ptr<MidiSource>
4556 Session::midi_source_by_path (const std::string& path) const
4558 /* Restricted to MIDI files because audio sources require a channel
4559 for unique identification, in addition to a path.
4562 Glib::Threads::Mutex::Lock lm (source_lock);
4564 for (SourceMap::const_iterator s = sources.begin(); s != sources.end(); ++s) {
4565 boost::shared_ptr<MidiSource> ms
4566 = boost::dynamic_pointer_cast<MidiSource>(s->second);
4567 boost::shared_ptr<FileSource> fs
4568 = boost::dynamic_pointer_cast<FileSource>(s->second);
4570 if (ms && fs && fs->path() == path) {
4575 return boost::shared_ptr<MidiSource>();
4579 Session::count_sources_by_origin (const string& path)
4582 Glib::Threads::Mutex::Lock lm (source_lock);
4584 for (SourceMap::iterator i = sources.begin(); i != sources.end(); ++i) {
4585 boost::shared_ptr<FileSource> fs
4586 = boost::dynamic_pointer_cast<FileSource>(i->second);
4588 if (fs && fs->origin() == path) {
4597 peak_file_helper (const string& peak_path, const string& file_path, const string& file_base, bool hash) {
4599 std::string checksum = Glib::Checksum::compute_checksum(Glib::Checksum::CHECKSUM_SHA1, file_path + G_DIR_SEPARATOR + file_base);
4600 return Glib::build_filename (peak_path, checksum + peakfile_suffix);
4602 return Glib::build_filename (peak_path, file_base + peakfile_suffix);
4607 Session::construct_peak_filepath (const string& filepath, const bool in_session, const bool old_peak_name) const
4609 string interchange_dir_string = string (interchange_dir_name) + G_DIR_SEPARATOR;
4611 if (Glib::path_is_absolute (filepath)) {
4613 /* rip the session dir from the audiofile source */
4615 string session_path;
4616 bool in_another_session = true;
4618 if (filepath.find (interchange_dir_string) != string::npos) {
4620 session_path = Glib::path_get_dirname (filepath); /* now ends in audiofiles */
4621 session_path = Glib::path_get_dirname (session_path); /* now ends in session name */
4622 session_path = Glib::path_get_dirname (session_path); /* now ends in interchange */
4623 session_path = Glib::path_get_dirname (session_path); /* now has session path */
4625 /* see if it is within our session */
4627 for (vector<space_and_path>::const_iterator i = session_dirs.begin(); i != session_dirs.end(); ++i) {
4628 if (i->path == session_path) {
4629 in_another_session = false;
4634 in_another_session = false;
4638 if (in_another_session) {
4639 SessionDirectory sd (session_path);
4640 return peak_file_helper (sd.peak_path(), "", Glib::path_get_basename (filepath), !old_peak_name);
4644 /* 1) if file belongs to this session
4645 * it may be a relative path (interchange/...)
4646 * or just basename (session_state, remove source)
4647 * -> just use the basename
4649 std::string filename = Glib::path_get_basename (filepath);
4652 /* 2) if the file is outside our session dir:
4653 * (imported but not copied) add the path for check-summming */
4655 path = Glib::path_get_dirname (filepath);
4658 return peak_file_helper (_session_dir->peak_path(), path, Glib::path_get_basename (filepath), !old_peak_name);
4662 Session::new_audio_source_path_for_embedded (const std::string& path)
4666 * we know that the filename is already unique because it exists
4667 * out in the filesystem.
4669 * However, when we bring it into the session, we could get a
4672 * Eg. two embedded files:
4677 * When merged into session, these collide.
4679 * There will not be a conflict with in-memory sources
4680 * because when the source was created we already picked
4681 * a unique name for it.
4683 * This collision is not likely to be common, but we have to guard
4684 * against it. So, if there is a collision, take the md5 hash of the
4685 * the path, and use that as the filename instead.
4688 SessionDirectory sdir (get_best_session_directory_for_new_audio());
4689 string base = Glib::path_get_basename (path);
4690 string newpath = Glib::build_filename (sdir.sound_path(), base);
4692 if (Glib::file_test (newpath, Glib::FILE_TEST_EXISTS)) {
4696 md5.digestString (path.c_str());
4697 md5.writeToString ();
4698 base = md5.digestChars;
4700 string ext = get_suffix (path);
4707 newpath = Glib::build_filename (sdir.sound_path(), base);
4709 /* if this collides, we're screwed */
4711 if (Glib::file_test (newpath, Glib::FILE_TEST_EXISTS)) {
4712 error << string_compose (_("Merging embedded file %1: name collision AND md5 hash collision!"), path) << endmsg;
4721 /** Return true if there are no audio file sources that use @param name as
4722 * the filename component of their path.
4724 * Return false otherwise.
4726 * This method MUST ONLY be used to check in-session, mono files since it
4727 * hard-codes the channel of the audio file source we are looking for as zero.
4729 * If/when Ardour supports native files in non-mono formats, the logic here
4730 * will need to be revisited.
4733 Session::audio_source_name_is_unique (const string& name)
4735 std::vector<string> sdirs = source_search_path (DataType::AUDIO);
4736 vector<space_and_path>::iterator i;
4737 uint32_t existing = 0;
4739 for (vector<string>::const_iterator i = sdirs.begin(); i != sdirs.end(); ++i) {
4741 /* note that we search *without* the extension so that
4742 we don't end up both "Audio 1-1.wav" and "Audio 1-1.caf"
4743 in the event that this new name is required for
4744 a file format change.
4747 const string spath = *i;
4749 if (matching_unsuffixed_filename_exists_in (spath, name)) {
4754 /* it is possible that we have the path already
4755 * assigned to a source that has not yet been written
4756 * (ie. the write source for a diskstream). we have to
4757 * check this in order to make sure that our candidate
4758 * path isn't used again, because that can lead to
4759 * two Sources point to the same file with different
4760 * notions of their removability.
4764 string possible_path = Glib::build_filename (spath, name);
4766 if (audio_source_by_path_and_channel (possible_path, 0)) {
4772 return (existing == 0);
4776 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)
4779 const string ext = native_header_format_extension (config.get_native_file_header_format(), DataType::AUDIO);
4781 if (Profile->get_trx() && destructive) {
4783 sstr << setfill ('0') << setw (4) << cnt;
4784 sstr << legalized_base;
4786 sstr << legalized_base;
4788 if (take_required || related_exists) {
4800 } else if (nchan > 2) {
4805 /* XXX what? more than 26 channels! */
4816 /** Return a unique name based on \a base for a new internal audio source */
4818 Session::new_audio_source_path (const string& base, uint32_t nchan, uint32_t chan, bool destructive, bool take_required)
4821 string possible_name;
4822 const uint32_t limit = 9999; // arbitrary limit on number of files with the same basic name
4824 bool some_related_source_name_exists = false;
4826 legalized = legalize_for_path (base);
4828 // Find a "version" of the base name that doesn't exist in any of the possible directories.
4830 for (cnt = (destructive ? ++destructive_index : 1); cnt <= limit; ++cnt) {
4832 possible_name = format_audio_source_name (legalized, nchan, chan, destructive, take_required, cnt, some_related_source_name_exists);
4834 if (audio_source_name_is_unique (possible_name)) {
4838 some_related_source_name_exists = true;
4841 error << string_compose(
4842 _("There are already %1 recordings for %2, which I consider too many."),
4843 limit, base) << endmsg;
4845 throw failed_constructor();
4849 /* We've established that the new name does not exist in any session
4850 * directory, so now find out which one we should use for this new
4854 SessionDirectory sdir (get_best_session_directory_for_new_audio());
4856 std::string s = Glib::build_filename (sdir.sound_path(), possible_name);
4861 /** Return a unique name based on `base` for a new internal MIDI source */
4863 Session::new_midi_source_path (const string& base)
4866 char buf[PATH_MAX+1];
4867 const uint32_t limit = 10000;
4869 string possible_path;
4870 string possible_name;
4873 legalized = legalize_for_path (base);
4875 // Find a "version" of the file name that doesn't exist in any of the possible directories.
4876 std::vector<string> sdirs = source_search_path(DataType::MIDI);
4878 /* - the main session folder is the first in the vector.
4879 * - after checking all locations for file-name uniqueness,
4880 * we keep the one from the last iteration as new file name
4881 * - midi files are small and should just be kept in the main session-folder
4883 * -> reverse the array, check main session folder last and use that as location
4886 std::reverse(sdirs.begin(), sdirs.end());
4888 for (cnt = 1; cnt <= limit; ++cnt) {
4890 vector<space_and_path>::iterator i;
4891 uint32_t existing = 0;
4893 for (vector<string>::const_iterator i = sdirs.begin(); i != sdirs.end(); ++i) {
4895 snprintf (buf, sizeof(buf), "%s-%u.mid", legalized.c_str(), cnt);
4896 possible_name = buf;
4898 possible_path = Glib::build_filename (*i, possible_name);
4900 if (Glib::file_test (possible_path, Glib::FILE_TEST_EXISTS)) {
4904 if (midi_source_by_path (possible_path)) {
4909 if (existing == 0) {
4914 error << string_compose(
4915 _("There are already %1 recordings for %2, which I consider too many."),
4916 limit, base) << endmsg;
4922 /* No need to "find best location" for software/app-based RAID, because
4923 MIDI is so small that we always put it in the same place.
4926 return possible_path;
4930 /** Create a new within-session audio source */
4931 boost::shared_ptr<AudioFileSource>
4932 Session::create_audio_source_for_session (size_t n_chans, string const & base, uint32_t chan, bool destructive)
4934 const string path = new_audio_source_path (base, n_chans, chan, destructive, true);
4936 if (!path.empty()) {
4937 return boost::dynamic_pointer_cast<AudioFileSource> (
4938 SourceFactory::createWritable (DataType::AUDIO, *this, path, destructive, frame_rate(), true, true));
4940 throw failed_constructor ();
4944 /** Create a new within-session MIDI source */
4945 boost::shared_ptr<MidiSource>
4946 Session::create_midi_source_for_session (string const & basic_name)
4948 const string path = new_midi_source_path (basic_name);
4950 if (!path.empty()) {
4951 return boost::dynamic_pointer_cast<SMFSource> (
4952 SourceFactory::createWritable (
4953 DataType::MIDI, *this, path, false, frame_rate()));
4955 throw failed_constructor ();
4959 /** Create a new within-session MIDI source */
4960 boost::shared_ptr<MidiSource>
4961 Session::create_midi_source_by_stealing_name (boost::shared_ptr<Track> track)
4963 /* the caller passes in the track the source will be used in,
4964 so that we can keep the numbering sane.
4966 Rationale: a track with the name "Foo" that has had N
4967 captures carried out so far will ALREADY have a write source
4968 named "Foo-N+1.mid" waiting to be used for the next capture.
4970 If we call new_midi_source_name() we will get "Foo-N+2". But
4971 there is no region corresponding to "Foo-N+1", so when
4972 "Foo-N+2" appears in the track, the gap presents the user
4973 with odd behaviour - why did it skip past Foo-N+1?
4975 We could explain this to the user in some odd way, but
4976 instead we rename "Foo-N+1.mid" as "Foo-N+2.mid", and then
4979 If that attempted rename fails, we get "Foo-N+2.mid" anyway.
4982 boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (track);
4984 std::string name = track->steal_write_source_name ();
4987 return boost::shared_ptr<MidiSource>();
4990 /* MIDI files are small, just put them in the first location of the
4991 session source search path.
4994 const string path = Glib::build_filename (source_search_path (DataType::MIDI).front(), name);
4996 return boost::dynamic_pointer_cast<SMFSource> (
4997 SourceFactory::createWritable (
4998 DataType::MIDI, *this, path, false, frame_rate()));
5003 Session::add_playlist (boost::shared_ptr<Playlist> playlist, bool unused)
5005 if (playlist->hidden()) {
5009 playlists->add (playlist);
5012 playlist->release();
5019 Session::remove_playlist (boost::weak_ptr<Playlist> weak_playlist)
5021 if (_state_of_the_state & Deletion) {
5025 boost::shared_ptr<Playlist> playlist (weak_playlist.lock());
5031 playlists->remove (playlist);
5037 Session::set_audition (boost::shared_ptr<Region> r)
5039 pending_audition_region = r;
5040 add_post_transport_work (PostTransportAudition);
5041 _butler->schedule_transport_work ();
5045 Session::audition_playlist ()
5047 SessionEvent* ev = new SessionEvent (SessionEvent::Audition, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
5048 ev->region.reset ();
5054 Session::register_lua_function (
5055 const std::string& name,
5056 const std::string& script,
5057 const LuaScriptParamList& args
5060 Glib::Threads::Mutex::Lock lm (lua_lock);
5062 lua_State* L = lua.getState();
5064 const std::string& bytecode = LuaScripting::get_factory_bytecode (script);
5065 luabridge::LuaRef tbl_arg (luabridge::newTable(L));
5066 for (LuaScriptParamList::const_iterator i = args.begin(); i != args.end(); ++i) {
5067 if ((*i)->optional && !(*i)->is_set) { continue; }
5068 tbl_arg[(*i)->name] = (*i)->value;
5070 (*_lua_add)(name, bytecode, tbl_arg); // throws luabridge::LuaException
5075 Session::unregister_lua_function (const std::string& name)
5077 Glib::Threads::Mutex::Lock lm (lua_lock);
5078 (*_lua_del)(name); // throws luabridge::LuaException
5079 lua.collect_garbage ();
5083 std::vector<std::string>
5084 Session::registered_lua_functions ()
5086 Glib::Threads::Mutex::Lock lm (lua_lock);
5087 std::vector<std::string> rv;
5090 luabridge::LuaRef list ((*_lua_list)());
5091 for (luabridge::Iterator i (list); !i.isNil (); ++i) {
5092 if (!i.key ().isString ()) { assert(0); continue; }
5093 rv.push_back (i.key ().cast<std::string> ());
5095 } catch (luabridge::LuaException const& e) { }
5100 static void _lua_print (std::string s) {
5101 std::cout << "SessionLua: " << s << "\n";
5106 Session::try_run_lua (pframes_t nframes)
5108 if (_n_lua_scripts == 0) return;
5109 Glib::Threads::Mutex::Lock tm (lua_lock, Glib::Threads::TRY_LOCK);
5111 try { (*_lua_run)(nframes); } catch (luabridge::LuaException const& e) { }
5116 Session::setup_lua ()
5119 lua.Print.connect (&_lua_print);
5122 "function ArdourSession ()"
5123 " local self = { scripts = {}, instances = {} }"
5125 " local remove = function (n)"
5126 " self.scripts[n] = nil"
5127 " self.instances[n] = nil"
5128 " Session:scripts_changed()" // call back
5131 " local addinternal = function (n, f, a)"
5132 " assert(type(n) == 'string', 'function-name must be string')"
5133 " assert(type(f) == 'function', 'Given script is a not a function')"
5134 " assert(type(a) == 'table' or type(a) == 'nil', 'Given argument is invalid')"
5135 " assert(self.scripts[n] == nil, 'Callback \"'.. n ..'\" already exists.')"
5136 " self.scripts[n] = { ['f'] = f, ['a'] = a }"
5137 " 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"
5138 " 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 }"
5139 " self.instances[n] = load (string.dump(f, true), nil, nil, env)(a)"
5140 " Session:scripts_changed()" // call back
5143 " local add = function (n, b, a)"
5144 " assert(type(b) == 'string', 'ByteCode must be string')"
5145 " load (b)()" // assigns f
5146 " assert(type(f) == 'string', 'Assigned ByteCode must be string')"
5147 " addinternal (n, load(f), a)"
5150 " local run = function (...)"
5151 " for n, s in pairs (self.instances) do"
5152 " local status, err = pcall (s, ...)"
5153 " if not status then"
5154 " print ('fn \"'.. n .. '\": ', err)"
5161 " local cleanup = function ()"
5162 " self.scripts = nil"
5163 " self.instances = nil"
5166 " local list = function ()"
5168 " for n, _ in pairs (self.scripts) do"
5174 " local function basic_serialize (o)"
5175 " if type(o) == \"number\" then"
5176 " return tostring(o)"
5178 " return string.format(\"%q\", o)"
5182 " local function serialize (name, value)"
5183 " local rv = name .. ' = '"
5185 " if type(value) == \"number\" or type(value) == \"string\" or type(value) == \"nil\" then"
5186 " return rv .. basic_serialize(value) .. ' '"
5187 " elseif type(value) == \"table\" then"
5189 " for k,v in pairs(value) do"
5190 " local fieldname = string.format(\"%s[%s]\", name, basic_serialize(k))"
5191 " rv = rv .. serialize(fieldname, v) .. ' '"
5192 " collectgarbage()" // string concatenation allocates a new string :(
5195 " elseif type(value) == \"function\" then"
5196 " return rv .. string.format(\"%q\", string.dump(value, true))"
5198 " error('cannot save a ' .. type(value))"
5203 " local save = function ()"
5204 " return (serialize('scripts', self.scripts))"
5207 " local restore = function (state)"
5208 " self.scripts = {}"
5210 " for n, s in pairs (scripts) do"
5211 " addinternal (n, load(s['f']), s['a'])"
5215 " return { run = run, add = add, remove = remove,"
5216 " list = list, restore = restore, save = save, cleanup = cleanup}"
5219 " sess = ArdourSession ()"
5220 " ArdourSession = nil"
5222 "function ardour () end"
5225 lua_State* L = lua.getState();
5228 luabridge::LuaRef lua_sess = luabridge::getGlobal (L, "sess");
5229 lua.do_command ("sess = nil"); // hide it.
5230 lua.do_command ("collectgarbage()");
5232 _lua_run = new luabridge::LuaRef(lua_sess["run"]);
5233 _lua_add = new luabridge::LuaRef(lua_sess["add"]);
5234 _lua_del = new luabridge::LuaRef(lua_sess["remove"]);
5235 _lua_list = new luabridge::LuaRef(lua_sess["list"]);
5236 _lua_save = new luabridge::LuaRef(lua_sess["save"]);
5237 _lua_load = new luabridge::LuaRef(lua_sess["restore"]);
5238 _lua_cleanup = new luabridge::LuaRef(lua_sess["cleanup"]);
5239 } catch (luabridge::LuaException const& e) {
5240 fatal << string_compose (_("programming error: %1"),
5241 X_("Failed to setup Lua interpreter"))
5243 abort(); /*NOTREACHED*/
5246 LuaBindings::stddef (L);
5247 LuaBindings::common (L);
5248 LuaBindings::dsp (L);
5249 luabridge::push <Session *> (L, this);
5250 lua_setglobal (L, "Session");
5254 Session::scripts_changed ()
5256 assert (!lua_lock.trylock()); // must hold lua_lock
5259 luabridge::LuaRef list ((*_lua_list)());
5261 for (luabridge::Iterator i (list); !i.isNil (); ++i) {
5262 if (!i.key ().isString ()) { assert(0); continue; }
5265 _n_lua_scripts = cnt;
5266 } catch (luabridge::LuaException const& e) {
5267 fatal << string_compose (_("programming error: %1"),
5268 X_("Indexing Lua Session Scripts failed."))
5270 abort(); /*NOTREACHED*/
5275 Session::non_realtime_set_audition ()
5277 assert (pending_audition_region);
5278 auditioner->audition_region (pending_audition_region);
5279 pending_audition_region.reset ();
5280 AuditionActive (true); /* EMIT SIGNAL */
5284 Session::audition_region (boost::shared_ptr<Region> r)
5286 SessionEvent* ev = new SessionEvent (SessionEvent::Audition, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
5292 Session::cancel_audition ()
5297 if (auditioner->auditioning()) {
5298 auditioner->cancel_audition ();
5299 AuditionActive (false); /* EMIT SIGNAL */
5304 Session::RoutePublicOrderSorter::operator() (boost::shared_ptr<Route> a, boost::shared_ptr<Route> b)
5306 if (a->is_monitor()) {
5309 if (b->is_monitor()) {
5312 return a->order_key () < b->order_key ();
5316 Session::is_auditioning () const
5318 /* can be called before we have an auditioner object */
5320 return auditioner->auditioning();
5327 Session::graph_reordered ()
5329 /* don't do this stuff if we are setting up connections
5330 from a set_state() call or creating new tracks. Ditto for deletion.
5333 if ((_state_of_the_state & (InitialConnecting|Deletion)) || _adding_routes_in_progress || _reconnecting_routes_in_progress || _route_deletion_in_progress) {
5337 /* every track/bus asked for this to be handled but it was deferred because
5338 we were connecting. do it now.
5341 request_input_change_handling ();
5345 /* force all diskstreams to update their capture offset values to
5346 reflect any changes in latencies within the graph.
5349 boost::shared_ptr<RouteList> rl = routes.reader ();
5350 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
5351 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
5353 tr->set_capture_offset ();
5358 /** @return Number of frames that there is disk space available to write,
5361 boost::optional<framecnt_t>
5362 Session::available_capture_duration ()
5364 Glib::Threads::Mutex::Lock lm (space_lock);
5366 if (_total_free_4k_blocks_uncertain) {
5367 return boost::optional<framecnt_t> ();
5370 float sample_bytes_on_disk = 4.0; // keep gcc happy
5372 switch (config.get_native_file_data_format()) {
5374 sample_bytes_on_disk = 4.0;
5378 sample_bytes_on_disk = 3.0;
5382 sample_bytes_on_disk = 2.0;
5386 /* impossible, but keep some gcc versions happy */
5387 fatal << string_compose (_("programming error: %1"),
5388 X_("illegal native file data format"))
5390 abort(); /*NOTREACHED*/
5393 double scale = 4096.0 / sample_bytes_on_disk;
5395 if (_total_free_4k_blocks * scale > (double) max_framecnt) {
5396 return max_framecnt;
5399 return (framecnt_t) floor (_total_free_4k_blocks * scale);
5403 Session::add_bundle (boost::shared_ptr<Bundle> bundle, bool emit_signal)
5406 RCUWriter<BundleList> writer (_bundles);
5407 boost::shared_ptr<BundleList> b = writer.get_copy ();
5408 b->push_back (bundle);
5412 BundleAddedOrRemoved (); /* EMIT SIGNAL */
5419 Session::remove_bundle (boost::shared_ptr<Bundle> bundle)
5421 bool removed = false;
5424 RCUWriter<BundleList> writer (_bundles);
5425 boost::shared_ptr<BundleList> b = writer.get_copy ();
5426 BundleList::iterator i = find (b->begin(), b->end(), bundle);
5428 if (i != b->end()) {
5435 BundleAddedOrRemoved (); /* EMIT SIGNAL */
5441 boost::shared_ptr<Bundle>
5442 Session::bundle_by_name (string name) const
5444 boost::shared_ptr<BundleList> b = _bundles.reader ();
5446 for (BundleList::const_iterator i = b->begin(); i != b->end(); ++i) {
5447 if ((*i)->name() == name) {
5452 return boost::shared_ptr<Bundle> ();
5456 Session::tempo_map_changed (const PropertyChange&)
5460 playlists->update_after_tempo_map_change ();
5462 _locations->apply (*this, &Session::update_locations_after_tempo_map_change);
5468 Session::gui_tempo_map_changed ()
5472 playlists->update_after_tempo_map_change ();
5474 _locations->apply (*this, &Session::update_locations_after_tempo_map_change);
5478 Session::update_locations_after_tempo_map_change (const Locations::LocationList& loc)
5480 for (Locations::LocationList::const_iterator i = loc.begin(); i != loc.end(); ++i) {
5481 (*i)->recompute_frames_from_bbt ();
5485 /** Ensures that all buffers (scratch, send, silent, etc) are allocated for
5486 * the given count with the current block size.
5489 Session::ensure_buffers (ChanCount howmany)
5491 BufferManager::ensure_buffers (howmany, bounce_processing() ? bounce_chunk_size : 0);
5495 Session::ensure_buffer_set(BufferSet& buffers, const ChanCount& count)
5497 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
5498 buffers.ensure_buffers(*t, count.get(*t), _engine.raw_buffer_size(*t));
5503 Session::next_insert_id ()
5505 /* this doesn't really loop forever. just think about it */
5508 for (boost::dynamic_bitset<uint32_t>::size_type n = 1; n < insert_bitset.size(); ++n) {
5509 if (!insert_bitset[n]) {
5510 insert_bitset[n] = true;
5516 /* none available, so resize and try again */
5518 insert_bitset.resize (insert_bitset.size() + 16, false);
5523 Session::next_send_id ()
5525 /* this doesn't really loop forever. just think about it */
5528 for (boost::dynamic_bitset<uint32_t>::size_type n = 1; n < send_bitset.size(); ++n) {
5529 if (!send_bitset[n]) {
5530 send_bitset[n] = true;
5536 /* none available, so resize and try again */
5538 send_bitset.resize (send_bitset.size() + 16, false);
5543 Session::next_aux_send_id ()
5545 /* this doesn't really loop forever. just think about it */
5548 for (boost::dynamic_bitset<uint32_t>::size_type n = 1; n < aux_send_bitset.size(); ++n) {
5549 if (!aux_send_bitset[n]) {
5550 aux_send_bitset[n] = true;
5556 /* none available, so resize and try again */
5558 aux_send_bitset.resize (aux_send_bitset.size() + 16, false);
5563 Session::next_return_id ()
5565 /* this doesn't really loop forever. just think about it */
5568 for (boost::dynamic_bitset<uint32_t>::size_type n = 1; n < return_bitset.size(); ++n) {
5569 if (!return_bitset[n]) {
5570 return_bitset[n] = true;
5576 /* none available, so resize and try again */
5578 return_bitset.resize (return_bitset.size() + 16, false);
5583 Session::mark_send_id (uint32_t id)
5585 if (id >= send_bitset.size()) {
5586 send_bitset.resize (id+16, false);
5588 if (send_bitset[id]) {
5589 warning << string_compose (_("send ID %1 appears to be in use already"), id) << endmsg;
5591 send_bitset[id] = true;
5595 Session::mark_aux_send_id (uint32_t id)
5597 if (id >= aux_send_bitset.size()) {
5598 aux_send_bitset.resize (id+16, false);
5600 if (aux_send_bitset[id]) {
5601 warning << string_compose (_("aux send ID %1 appears to be in use already"), id) << endmsg;
5603 aux_send_bitset[id] = true;
5607 Session::mark_return_id (uint32_t id)
5609 if (id >= return_bitset.size()) {
5610 return_bitset.resize (id+16, false);
5612 if (return_bitset[id]) {
5613 warning << string_compose (_("return ID %1 appears to be in use already"), id) << endmsg;
5615 return_bitset[id] = true;
5619 Session::mark_insert_id (uint32_t id)
5621 if (id >= insert_bitset.size()) {
5622 insert_bitset.resize (id+16, false);
5624 if (insert_bitset[id]) {
5625 warning << string_compose (_("insert ID %1 appears to be in use already"), id) << endmsg;
5627 insert_bitset[id] = true;
5631 Session::unmark_send_id (uint32_t id)
5633 if (id < send_bitset.size()) {
5634 send_bitset[id] = false;
5639 Session::unmark_aux_send_id (uint32_t id)
5641 if (id < aux_send_bitset.size()) {
5642 aux_send_bitset[id] = false;
5647 Session::unmark_return_id (uint32_t id)
5649 if (_state_of_the_state & Deletion) { return; }
5650 if (id < return_bitset.size()) {
5651 return_bitset[id] = false;
5656 Session::unmark_insert_id (uint32_t id)
5658 if (id < insert_bitset.size()) {
5659 insert_bitset[id] = false;
5664 Session::reset_native_file_format ()
5666 boost::shared_ptr<RouteList> rl = routes.reader ();
5668 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
5669 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
5671 /* don't save state as we do this, there's no point
5673 _state_of_the_state = StateOfTheState (_state_of_the_state|InCleanup);
5674 tr->reset_write_sources (false);
5675 _state_of_the_state = StateOfTheState (_state_of_the_state & ~InCleanup);
5681 Session::route_name_unique (string n) const
5683 boost::shared_ptr<RouteList> r = routes.reader ();
5685 for (RouteList::const_iterator i = r->begin(); i != r->end(); ++i) {
5686 if ((*i)->name() == n) {
5695 Session::route_name_internal (string n) const
5697 if (auditioner && auditioner->name() == n) {
5701 if (_click_io && _click_io->name() == n) {
5709 Session::freeze_all (InterThreadInfo& itt)
5711 boost::shared_ptr<RouteList> r = routes.reader ();
5713 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
5715 boost::shared_ptr<Track> t;
5717 if ((t = boost::dynamic_pointer_cast<Track>(*i)) != 0) {
5718 /* XXX this is wrong because itt.progress will keep returning to zero at the start
5728 boost::shared_ptr<Region>
5729 Session::write_one_track (Track& track, framepos_t start, framepos_t end,
5730 bool /*overwrite*/, vector<boost::shared_ptr<Source> >& srcs,
5731 InterThreadInfo& itt,
5732 boost::shared_ptr<Processor> endpoint, bool include_endpoint,
5733 bool for_export, bool for_freeze)
5735 boost::shared_ptr<Region> result;
5736 boost::shared_ptr<Playlist> playlist;
5737 boost::shared_ptr<Source> source;
5738 ChanCount diskstream_channels (track.n_channels());
5739 framepos_t position;
5740 framecnt_t this_chunk;
5742 framepos_t latency_skip;
5744 framepos_t len = end - start;
5745 bool need_block_size_reset = false;
5746 ChanCount const max_proc = track.max_processor_streams ();
5747 string legal_playlist_name;
5748 string possible_path;
5751 error << string_compose (_("Cannot write a range where end <= start (e.g. %1 <= %2)"),
5752 end, start) << endmsg;
5756 diskstream_channels = track.bounce_get_output_streams (diskstream_channels, endpoint,
5757 include_endpoint, for_export, for_freeze);
5759 if (diskstream_channels.n(track.data_type()) < 1) {
5760 error << _("Cannot write a range with no data.") << endmsg;
5764 // block all process callback handling
5766 block_processing ();
5769 // synchronize with AudioEngine::process_callback()
5770 // make sure processing is not currently running
5771 // and processing_blocked() is honored before
5772 // acquiring thread buffers
5773 Glib::Threads::Mutex::Lock lm (_engine.process_lock());
5776 _bounce_processing_active = true;
5778 /* call tree *MUST* hold route_lock */
5780 if ((playlist = track.playlist()) == 0) {
5784 legal_playlist_name = legalize_for_path (playlist->name());
5786 for (uint32_t chan_n = 0; chan_n < diskstream_channels.n(track.data_type()); ++chan_n) {
5788 string base_name = string_compose ("%1-%2-bounce", playlist->name(), chan_n);
5789 string path = ((track.data_type() == DataType::AUDIO)
5790 ? new_audio_source_path (legal_playlist_name, diskstream_channels.n_audio(), chan_n, false, true)
5791 : new_midi_source_path (legal_playlist_name));
5798 source = SourceFactory::createWritable (track.data_type(), *this, path, false, frame_rate());
5801 catch (failed_constructor& err) {
5802 error << string_compose (_("cannot create new file \"%1\" for %2"), path, track.name()) << endmsg;
5806 srcs.push_back (source);
5809 /* tell redirects that care that we are about to use a much larger
5810 * blocksize. this will flush all plugins too, so that they are ready
5811 * to be used for this process.
5814 need_block_size_reset = true;
5815 track.set_block_size (bounce_chunk_size);
5816 _engine.main_thread()->get_buffers ();
5820 latency_skip = track.bounce_get_latency (endpoint, include_endpoint, for_export, for_freeze);
5822 /* create a set of reasonably-sized buffers */
5823 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
5824 buffers.ensure_buffers(*t, max_proc.get(*t), bounce_chunk_size);
5826 buffers.set_count (max_proc);
5828 for (vector<boost::shared_ptr<Source> >::iterator src = srcs.begin(); src != srcs.end(); ++src) {
5829 boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*src);
5830 boost::shared_ptr<MidiSource> ms;
5832 afs->prepare_for_peakfile_writes ();
5833 } else if ((ms = boost::dynamic_pointer_cast<MidiSource>(*src))) {
5834 Source::Lock lock(ms->mutex());
5835 ms->mark_streaming_write_started(lock);
5839 while (to_do && !itt.cancel) {
5841 this_chunk = min (to_do, bounce_chunk_size);
5843 if (track.export_stuff (buffers, start, this_chunk, endpoint, include_endpoint, for_export, for_freeze)) {
5847 start += this_chunk;
5848 to_do -= this_chunk;
5849 itt.progress = (float) (1.0 - ((double) to_do / len));
5851 if (latency_skip >= bounce_chunk_size) {
5852 latency_skip -= bounce_chunk_size;
5856 const framecnt_t current_chunk = this_chunk - latency_skip;
5859 for (vector<boost::shared_ptr<Source> >::iterator src=srcs.begin(); src != srcs.end(); ++src, ++n) {
5860 boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*src);
5861 boost::shared_ptr<MidiSource> ms;
5864 if (afs->write (buffers.get_audio(n).data(latency_skip), current_chunk) != current_chunk) {
5867 } else if ((ms = boost::dynamic_pointer_cast<MidiSource>(*src))) {
5868 Source::Lock lock(ms->mutex());
5870 const MidiBuffer& buf = buffers.get_midi(0);
5871 for (MidiBuffer::const_iterator i = buf.begin(); i != buf.end(); ++i) {
5872 Evoral::Event<framepos_t> ev = *i;
5873 ev.set_time(ev.time() - position);
5874 ms->append_event_frames(lock, ev, ms->timeline_position());
5881 /* post-roll, pick up delayed processor output */
5882 latency_skip = track.bounce_get_latency (endpoint, include_endpoint, for_export, for_freeze);
5884 while (latency_skip && !itt.cancel) {
5885 this_chunk = min (latency_skip, bounce_chunk_size);
5886 latency_skip -= this_chunk;
5888 buffers.silence (this_chunk, 0);
5889 track.bounce_process (buffers, start, this_chunk, endpoint, include_endpoint, for_export, for_freeze);
5892 for (vector<boost::shared_ptr<Source> >::iterator src=srcs.begin(); src != srcs.end(); ++src, ++n) {
5893 boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*src);
5896 if (afs->write (buffers.get_audio(n).data(), this_chunk) != this_chunk) {
5908 xnow = localtime (&now);
5910 for (vector<boost::shared_ptr<Source> >::iterator src=srcs.begin(); src != srcs.end(); ++src) {
5911 boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*src);
5912 boost::shared_ptr<MidiSource> ms;
5915 afs->update_header (position, *xnow, now);
5916 afs->flush_header ();
5917 } else if ((ms = boost::dynamic_pointer_cast<MidiSource>(*src))) {
5918 Source::Lock lock(ms->mutex());
5919 ms->mark_streaming_write_completed(lock);
5923 /* construct a region to represent the bounced material */
5927 plist.add (Properties::start, 0);
5928 plist.add (Properties::length, srcs.front()->length(srcs.front()->timeline_position()));
5929 plist.add (Properties::name, region_name_from_path (srcs.front()->name(), true));
5931 result = RegionFactory::create (srcs, plist);
5937 for (vector<boost::shared_ptr<Source> >::iterator src = srcs.begin(); src != srcs.end(); ++src) {
5938 (*src)->mark_for_remove ();
5939 (*src)->drop_references ();
5943 for (vector<boost::shared_ptr<Source> >::iterator src = srcs.begin(); src != srcs.end(); ++src) {
5944 boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*src);
5947 afs->done_with_peakfile_writes ();
5951 _bounce_processing_active = false;
5953 if (need_block_size_reset) {
5954 _engine.main_thread()->drop_buffers ();
5955 track.set_block_size (get_block_size());
5958 unblock_processing ();
5964 Session::gain_automation_buffer() const
5966 return ProcessThread::gain_automation_buffer ();
5970 Session::trim_automation_buffer() const
5972 return ProcessThread::trim_automation_buffer ();
5976 Session::send_gain_automation_buffer() const
5978 return ProcessThread::send_gain_automation_buffer ();
5982 Session::pan_automation_buffer() const
5984 return ProcessThread::pan_automation_buffer ();
5988 Session::get_silent_buffers (ChanCount count)
5990 return ProcessThread::get_silent_buffers (count);
5994 Session::get_scratch_buffers (ChanCount count, bool silence)
5996 return ProcessThread::get_scratch_buffers (count, silence);
6000 Session::get_noinplace_buffers (ChanCount count)
6002 return ProcessThread::get_noinplace_buffers (count);
6006 Session::get_route_buffers (ChanCount count, bool silence)
6008 return ProcessThread::get_route_buffers (count, silence);
6013 Session::get_mix_buffers (ChanCount count)
6015 return ProcessThread::get_mix_buffers (count);
6019 Session::ntracks () const
6022 boost::shared_ptr<RouteList> r = routes.reader ();
6024 for (RouteList::const_iterator i = r->begin(); i != r->end(); ++i) {
6025 if (boost::dynamic_pointer_cast<Track> (*i)) {
6034 Session::nbusses () const
6037 boost::shared_ptr<RouteList> r = routes.reader ();
6039 for (RouteList::const_iterator i = r->begin(); i != r->end(); ++i) {
6040 if (boost::dynamic_pointer_cast<Track>(*i) == 0) {
6049 Session::add_automation_list(AutomationList *al)
6051 automation_lists[al->id()] = al;
6054 /** @return true if there is at least one record-enabled track, otherwise false */
6056 Session::have_rec_enabled_track () const
6058 return g_atomic_int_get (const_cast<gint*>(&_have_rec_enabled_track)) == 1;
6062 Session::have_rec_disabled_track () const
6064 return g_atomic_int_get (const_cast<gint*>(&_have_rec_disabled_track)) == 1;
6067 /** Update the state of our rec-enabled tracks flag */
6069 Session::update_route_record_state ()
6071 boost::shared_ptr<RouteList> rl = routes.reader ();
6072 RouteList::iterator i = rl->begin();
6073 while (i != rl->end ()) {
6075 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
6076 if (tr && tr->rec_enable_control()->get_value()) {
6083 int const old = g_atomic_int_get (&_have_rec_enabled_track);
6085 g_atomic_int_set (&_have_rec_enabled_track, i != rl->end () ? 1 : 0);
6087 if (g_atomic_int_get (&_have_rec_enabled_track) != old) {
6088 RecordStateChanged (); /* EMIT SIGNAL */
6091 for (i = rl->begin(); i != rl->end (); ++i) {
6092 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
6093 if (tr && !tr->rec_enable_control()->get_value()) {
6098 g_atomic_int_set (&_have_rec_disabled_track, i != rl->end () ? 1 : 0);
6100 bool record_arm_state_changed = (old != g_atomic_int_get (&_have_rec_enabled_track) );
6102 if (record_status() == Recording && record_arm_state_changed ) {
6103 RecordArmStateChanged ();
6109 Session::listen_position_changed ()
6111 boost::shared_ptr<RouteList> r = routes.reader ();
6113 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6114 (*i)->listen_position_changed ();
6119 Session::solo_control_mode_changed ()
6121 /* cancel all solo or all listen when solo control mode changes */
6122 clear_all_solo_state (get_routes());
6125 /** Called when a property of one of our route groups changes */
6127 Session::route_group_property_changed (RouteGroup* rg)
6129 RouteGroupPropertyChanged (rg); /* EMIT SIGNAL */
6132 /** Called when a route is added to one of our route groups */
6134 Session::route_added_to_route_group (RouteGroup* rg, boost::weak_ptr<Route> r)
6136 RouteAddedToRouteGroup (rg, r);
6139 /** Called when a route is removed from one of our route groups */
6141 Session::route_removed_from_route_group (RouteGroup* rg, boost::weak_ptr<Route> r)
6143 update_route_record_state ();
6144 RouteRemovedFromRouteGroup (rg, r); /* EMIT SIGNAL */
6147 boost::shared_ptr<RouteList>
6148 Session::get_tracks () const
6150 boost::shared_ptr<RouteList> rl = routes.reader ();
6151 boost::shared_ptr<RouteList> tl (new RouteList);
6153 for (RouteList::const_iterator r = rl->begin(); r != rl->end(); ++r) {
6154 if (boost::dynamic_pointer_cast<Track> (*r)) {
6155 if (!(*r)->is_auditioner()) {
6163 boost::shared_ptr<RouteList>
6164 Session::get_routes_with_regions_at (framepos_t const p) const
6166 boost::shared_ptr<RouteList> r = routes.reader ();
6167 boost::shared_ptr<RouteList> rl (new RouteList);
6169 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6170 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
6175 boost::shared_ptr<Playlist> pl = tr->playlist ();
6180 if (pl->has_region_at (p)) {
6189 Session::goto_end ()
6191 if (_session_range_location) {
6192 request_locate (_session_range_location->end(), false);
6194 request_locate (0, false);
6199 Session::goto_start ()
6201 if (_session_range_location) {
6202 request_locate (_session_range_location->start(), false);
6204 request_locate (0, false);
6209 Session::current_start_frame () const
6211 return _session_range_location ? _session_range_location->start() : 0;
6215 Session::current_end_frame () const
6217 return _session_range_location ? _session_range_location->end() : 0;
6221 Session::set_session_range_location (framepos_t start, framepos_t end)
6223 _session_range_location = new Location (*this, start, end, _("session"), Location::IsSessionRange);
6224 _locations->add (_session_range_location);
6228 Session::step_edit_status_change (bool yn)
6234 send = (_step_editors == 0);
6239 send = (_step_editors == 1);
6242 if (_step_editors > 0) {
6248 StepEditStatusChange (val);
6254 Session::start_time_changed (framepos_t old)
6256 /* Update the auto loop range to match the session range
6257 (unless the auto loop range has been changed by the user)
6260 Location* s = _locations->session_range_location ();
6265 Location* l = _locations->auto_loop_location ();
6267 if (l && l->start() == old) {
6268 l->set_start (s->start(), true);
6273 Session::end_time_changed (framepos_t old)
6275 /* Update the auto loop range to match the session range
6276 (unless the auto loop range has been changed by the user)
6279 Location* s = _locations->session_range_location ();
6284 Location* l = _locations->auto_loop_location ();
6286 if (l && l->end() == old) {
6287 l->set_end (s->end(), true);
6291 std::vector<std::string>
6292 Session::source_search_path (DataType type) const
6296 if (session_dirs.size() == 1) {
6298 case DataType::AUDIO:
6299 sp.push_back (_session_dir->sound_path());
6301 case DataType::MIDI:
6302 sp.push_back (_session_dir->midi_path());
6306 for (vector<space_and_path>::const_iterator i = session_dirs.begin(); i != session_dirs.end(); ++i) {
6307 SessionDirectory sdir (i->path);
6309 case DataType::AUDIO:
6310 sp.push_back (sdir.sound_path());
6312 case DataType::MIDI:
6313 sp.push_back (sdir.midi_path());
6319 if (type == DataType::AUDIO) {
6320 const string sound_path_2X = _session_dir->sound_path_2X();
6321 if (Glib::file_test (sound_path_2X, Glib::FILE_TEST_EXISTS|Glib::FILE_TEST_IS_DIR)) {
6322 if (find (sp.begin(), sp.end(), sound_path_2X) == sp.end()) {
6323 sp.push_back (sound_path_2X);
6328 // now check the explicit (possibly user-specified) search path
6331 case DataType::AUDIO:
6332 sp += Searchpath(config.get_audio_search_path ());
6334 case DataType::MIDI:
6335 sp += Searchpath(config.get_midi_search_path ());
6343 Session::ensure_search_path_includes (const string& path, DataType type)
6352 case DataType::AUDIO:
6353 sp += Searchpath(config.get_audio_search_path ());
6355 case DataType::MIDI:
6356 sp += Searchpath (config.get_midi_search_path ());
6360 for (vector<std::string>::iterator i = sp.begin(); i != sp.end(); ++i) {
6361 /* No need to add this new directory if it has the same inode as
6362 an existing one; checking inode rather than name prevents duplicated
6363 directories when we are using symlinks.
6365 On Windows, I think we could just do if (*i == path) here.
6367 if (PBD::equivalent_paths (*i, path)) {
6375 case DataType::AUDIO:
6376 config.set_audio_search_path (sp.to_string());
6378 case DataType::MIDI:
6379 config.set_midi_search_path (sp.to_string());
6385 Session::remove_dir_from_search_path (const string& dir, DataType type)
6390 case DataType::AUDIO:
6391 sp = Searchpath(config.get_audio_search_path ());
6393 case DataType::MIDI:
6394 sp = Searchpath (config.get_midi_search_path ());
6401 case DataType::AUDIO:
6402 config.set_audio_search_path (sp.to_string());
6404 case DataType::MIDI:
6405 config.set_midi_search_path (sp.to_string());
6411 boost::shared_ptr<Speakers>
6412 Session::get_speakers()
6418 Session::unknown_processors () const
6422 boost::shared_ptr<RouteList> r = routes.reader ();
6423 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6424 list<string> t = (*i)->unknown_processors ();
6425 copy (t.begin(), t.end(), back_inserter (p));
6435 Session::update_latency (bool playback)
6438 DEBUG_TRACE (DEBUG::Latency, string_compose ("JACK latency callback: %1\n", (playback ? "PLAYBACK" : "CAPTURE")));
6440 if ((_state_of_the_state & (InitialConnecting|Deletion)) || _adding_routes_in_progress || _route_deletion_in_progress) {
6444 boost::shared_ptr<RouteList> r = routes.reader ();
6445 framecnt_t max_latency = 0;
6448 /* reverse the list so that we work backwards from the last route to run to the first */
6449 RouteList* rl = routes.reader().get();
6450 r.reset (new RouteList (*rl));
6451 reverse (r->begin(), r->end());
6454 /* compute actual latency values for the given direction and store them all in per-port
6455 structures. this will also publish the same values (to JACK) so that computation of latency
6456 for routes can consistently use public latency values.
6459 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6460 max_latency = max (max_latency, (*i)->set_private_port_latencies (playback));
6463 /* because we latency compensate playback, our published playback latencies should
6464 be the same for all output ports - all material played back by ardour has
6465 the same latency, whether its caused by plugins or by latency compensation. since
6466 these may differ from the values computed above, reset all playback port latencies
6470 DEBUG_TRACE (DEBUG::Latency, string_compose ("Set public port latencies to %1\n", max_latency));
6472 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6473 (*i)->set_public_port_latencies (max_latency, playback);
6478 post_playback_latency ();
6482 post_capture_latency ();
6485 DEBUG_TRACE (DEBUG::Latency, "JACK latency callback: DONE\n");
6489 Session::post_playback_latency ()
6491 set_worst_playback_latency ();
6493 boost::shared_ptr<RouteList> r = routes.reader ();
6495 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6496 if (!(*i)->is_auditioner() && ((*i)->active())) {
6497 _worst_track_latency = max (_worst_track_latency, (*i)->update_signal_latency ());
6501 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6502 (*i)->set_latency_compensation (_worst_track_latency);
6507 Session::post_capture_latency ()
6509 set_worst_capture_latency ();
6511 /* reflect any changes in capture latencies into capture offsets
6514 boost::shared_ptr<RouteList> rl = routes.reader();
6515 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
6516 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
6518 tr->set_capture_offset ();
6524 Session::initialize_latencies ()
6527 Glib::Threads::Mutex::Lock lm (_engine.process_lock());
6528 update_latency (false);
6529 update_latency (true);
6532 set_worst_io_latencies ();
6536 Session::set_worst_io_latencies ()
6538 set_worst_playback_latency ();
6539 set_worst_capture_latency ();
6543 Session::set_worst_playback_latency ()
6545 if (_state_of_the_state & (InitialConnecting|Deletion)) {
6549 _worst_output_latency = 0;
6551 if (!_engine.connected()) {
6555 boost::shared_ptr<RouteList> r = routes.reader ();
6557 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6558 _worst_output_latency = max (_worst_output_latency, (*i)->output()->latency());
6561 DEBUG_TRACE (DEBUG::Latency, string_compose ("Worst output latency: %1\n", _worst_output_latency));
6565 Session::set_worst_capture_latency ()
6567 if (_state_of_the_state & (InitialConnecting|Deletion)) {
6571 _worst_input_latency = 0;
6573 if (!_engine.connected()) {
6577 boost::shared_ptr<RouteList> r = routes.reader ();
6579 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6580 _worst_input_latency = max (_worst_input_latency, (*i)->input()->latency());
6583 DEBUG_TRACE (DEBUG::Latency, string_compose ("Worst input latency: %1\n", _worst_input_latency));
6587 Session::update_latency_compensation (bool force_whole_graph)
6589 bool some_track_latency_changed = false;
6591 if (_state_of_the_state & (InitialConnecting|Deletion)) {
6595 DEBUG_TRACE(DEBUG::Latency, "---------------------------- update latency compensation\n\n");
6597 _worst_track_latency = 0;
6599 boost::shared_ptr<RouteList> r = routes.reader ();
6601 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6602 if (!(*i)->is_auditioner() && ((*i)->active())) {
6604 if ((*i)->signal_latency () != (tl = (*i)->update_signal_latency ())) {
6605 some_track_latency_changed = true;
6607 _worst_track_latency = max (tl, _worst_track_latency);
6611 DEBUG_TRACE (DEBUG::Latency, string_compose ("worst signal processing latency: %1 (changed ? %2)\n", _worst_track_latency,
6612 (some_track_latency_changed ? "yes" : "no")));
6614 DEBUG_TRACE(DEBUG::Latency, "---------------------------- DONE update latency compensation\n\n");
6616 if (some_track_latency_changed || force_whole_graph) {
6617 _engine.update_latencies ();
6621 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6622 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
6626 tr->set_capture_offset ();
6631 Session::session_name_is_legal (const string& path)
6633 char illegal_chars[] = { '/', '\\', ':', ';', '\0' };
6635 for (int i = 0; illegal_chars[i]; ++i) {
6636 if (path.find (illegal_chars[i]) != string::npos) {
6637 return illegal_chars[i];
6645 Session::next_control_id () const
6649 /* the monitor bus remote ID is in a different
6650 * "namespace" than regular routes. its existence doesn't
6651 * affect normal (low) numbered routes.
6658 /* the same about masterbus in Waves Tracks */
6660 if (Profile->get_trx() && _master_out) {
6664 return nroutes() - subtract;
6668 Session::notify_remote_id_change ()
6670 if (deletion_in_progress()) {
6674 switch (Config->get_remote_model()) {
6676 Route::RemoteControlIDChange (); /* EMIT SIGNAL */
6682 #ifdef USE_TRACKS_CODE_FEATURES
6683 /* Waves Tracks: for Waves Tracks session it's required to reconnect their IOs
6684 * if track order has been changed by user
6686 reconnect_existing_routes(true, true);
6692 Session::sync_order_keys ()
6694 if (deletion_in_progress()) {
6698 /* tell everyone that something has happened to the sort keys
6699 and let them sync up with the change(s)
6700 this will give objects that manage the sort order keys the
6701 opportunity to keep them in sync if they wish to.
6704 DEBUG_TRACE (DEBUG::OrderKeys, "Sync Order Keys.\n");
6706 reassign_track_numbers();
6708 Route::SyncOrderKeys (); /* EMIT SIGNAL */
6710 DEBUG_TRACE (DEBUG::OrderKeys, "\tsync done\n");
6714 Session::operation_in_progress (GQuark op) const
6716 return (find (_current_trans_quarks.begin(), _current_trans_quarks.end(), op) != _current_trans_quarks.end());
6719 boost::shared_ptr<Port>
6720 Session::ltc_input_port () const
6722 return _ltc_input->nth (0);
6725 boost::shared_ptr<Port>
6726 Session::ltc_output_port () const
6728 return _ltc_output->nth (0);
6732 Session::reconnect_ltc_input ()
6736 string src = Config->get_ltc_source_port();
6738 _ltc_input->disconnect (this);
6740 if (src != _("None") && !src.empty()) {
6741 _ltc_input->nth (0)->connect (src);
6744 if ( ARDOUR::Profile->get_trx () ) {
6745 // Tracks need this signal to update timecode_source_dropdown
6746 MtcOrLtcInputPortChanged (); //emit signal
6752 Session::reconnect_ltc_output ()
6756 string src = Config->get_ltc_output_port();
6758 _ltc_output->disconnect (this);
6760 if (src != _("None") && !src.empty()) {
6761 _ltc_output->nth (0)->connect (src);
6767 Session::set_range_selection (framepos_t start, framepos_t end)
6769 _range_selection = Evoral::Range<framepos_t> (start, end);
6770 #ifdef USE_TRACKS_CODE_FEATURES
6771 follow_playhead_priority ();
6776 Session::set_object_selection (framepos_t start, framepos_t end)
6778 _object_selection = Evoral::Range<framepos_t> (start, end);
6779 #ifdef USE_TRACKS_CODE_FEATURES
6780 follow_playhead_priority ();
6785 Session::clear_range_selection ()
6787 _range_selection = Evoral::Range<framepos_t> (-1,-1);
6788 #ifdef USE_TRACKS_CODE_FEATURES
6789 follow_playhead_priority ();
6794 Session::clear_object_selection ()
6796 _object_selection = Evoral::Range<framepos_t> (-1,-1);
6797 #ifdef USE_TRACKS_CODE_FEATURES
6798 follow_playhead_priority ();
6803 Session::auto_connect_route (boost::shared_ptr<Route> route, bool connect_inputs,
6804 const ChanCount& input_start,
6805 const ChanCount& output_start,
6806 const ChanCount& input_offset,
6807 const ChanCount& output_offset)
6809 Glib::Threads::Mutex::Lock lx (_auto_connect_queue_lock);
6810 _auto_connect_queue.push (AutoConnectRequest (route, connect_inputs,
6811 input_start, output_start,
6812 input_offset, output_offset));
6814 if (pthread_mutex_trylock (&_auto_connect_mutex) == 0) {
6815 pthread_cond_signal (&_auto_connect_cond);
6816 pthread_mutex_unlock (&_auto_connect_mutex);
6821 Session::auto_connect (const AutoConnectRequest& ar)
6823 boost::shared_ptr<Route> route = ar.route.lock();
6825 if (!route) { return; }
6827 if (!IO::connecting_legal) {
6831 /* If both inputs and outputs are auto-connected to physical ports,
6832 * use the max of input and output offsets to ensure auto-connected
6833 * port numbers always match up (e.g. the first audio input and the
6834 * first audio output of the route will have the same physical
6835 * port number). Otherwise just use the lowest input or output
6839 const bool in_out_physical =
6840 (Config->get_input_auto_connect() & AutoConnectPhysical)
6841 && (Config->get_output_auto_connect() & AutoConnectPhysical)
6842 && ar.connect_inputs;
6844 const ChanCount in_offset = in_out_physical
6845 ? ChanCount::max(ar.input_offset, ar.output_offset)
6848 const ChanCount out_offset = in_out_physical
6849 ? ChanCount::max(ar.input_offset, ar.output_offset)
6852 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
6853 vector<string> physinputs;
6854 vector<string> physoutputs;
6856 _engine.get_physical_outputs (*t, physoutputs);
6857 _engine.get_physical_inputs (*t, physinputs);
6859 if (!physinputs.empty() && ar.connect_inputs) {
6860 uint32_t nphysical_in = physinputs.size();
6862 for (uint32_t i = ar.input_start.get(*t); i < route->n_inputs().get(*t) && i < nphysical_in; ++i) {
6865 if (Config->get_input_auto_connect() & AutoConnectPhysical) {
6866 port = physinputs[(in_offset.get(*t) + i) % nphysical_in];
6869 if (!port.empty() && route->input()->connect (route->input()->ports().port(*t, i), port, this)) {
6875 if (!physoutputs.empty()) {
6876 uint32_t nphysical_out = physoutputs.size();
6877 for (uint32_t i = ar.output_start.get(*t); i < route->n_outputs().get(*t); ++i) {
6881 * do not create new connections if we reached the limit of physical outputs
6884 if (!(Config->get_output_auto_connect() & AutoConnectMaster) &&
6885 ARDOUR::Profile->get_trx () &&
6886 ar.output_offset.get(*t) == nphysical_out ) {
6890 if ((*t) == DataType::MIDI && (Config->get_output_auto_connect() & AutoConnectPhysical)) {
6891 port = physoutputs[(out_offset.get(*t) + i) % nphysical_out];
6892 } else if ((*t) == DataType::AUDIO && (Config->get_output_auto_connect() & AutoConnectMaster)) {
6893 /* master bus is audio only */
6894 if (_master_out && _master_out->n_inputs().get(*t) > 0) {
6895 port = _master_out->input()->ports().port(*t,
6896 i % _master_out->input()->n_ports().get(*t))->name();
6900 if (!port.empty() && route->output()->connect (route->output()->ports().port(*t, i), port, this)) {
6909 Session::auto_connect_thread_start ()
6911 if (_ac_thread_active) {
6915 while (!_auto_connect_queue.empty ()) {
6916 _auto_connect_queue.pop ();
6919 _ac_thread_active = true;
6920 if (pthread_create (&_auto_connect_thread, NULL, auto_connect_thread, this)) {
6921 _ac_thread_active = false;
6926 Session::auto_connect_thread_terminate ()
6928 if (!_ac_thread_active) {
6931 _ac_thread_active = false;
6934 Glib::Threads::Mutex::Lock lx (_auto_connect_queue_lock);
6935 while (!_auto_connect_queue.empty ()) {
6936 _auto_connect_queue.pop ();
6940 if (pthread_mutex_lock (&_auto_connect_mutex) == 0) {
6941 pthread_cond_signal (&_auto_connect_cond);
6942 pthread_mutex_unlock (&_auto_connect_mutex);
6946 pthread_join (_auto_connect_thread, &status);
6950 Session::auto_connect_thread (void *arg)
6952 Session *s = static_cast<Session *>(arg);
6953 s->auto_connect_thread_run ();
6959 Session::auto_connect_thread_run ()
6961 pthread_set_name (X_("autoconnect"));
6962 SessionEvent::create_per_thread_pool (X_("autoconnect"), 1024);
6963 PBD::notify_event_loops_about_thread_creation (pthread_self(), X_("autoconnect"), 1024);
6964 pthread_mutex_lock (&_auto_connect_mutex);
6965 while (_ac_thread_active) {
6967 if (!_auto_connect_queue.empty ()) {
6968 // Why would we need the process lock ??
6969 // A: if ports are added while we're connecting, the backend's iterator may be invalidated:
6970 // graph_order_callback() -> resort_routes() -> direct_feeds_according_to_reality () -> backend::connected_to()
6971 // All ardour-internal backends use a std::vector xxxAudioBackend::find_port()
6972 // We have control over those, but what does jack do?
6973 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
6975 Glib::Threads::Mutex::Lock lx (_auto_connect_queue_lock);
6976 while (!_auto_connect_queue.empty ()) {
6977 const AutoConnectRequest ar (_auto_connect_queue.front());
6978 _auto_connect_queue.pop ();
6985 pthread_cond_wait (&_auto_connect_cond, &_auto_connect_mutex);
6987 pthread_mutex_unlock (&_auto_connect_mutex);