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/send.h"
96 #include "ardour/session.h"
97 #include "ardour/session_directory.h"
98 #include "ardour/session_playlists.h"
99 #include "ardour/smf_source.h"
100 #include "ardour/solo_isolate_control.h"
101 #include "ardour/source_factory.h"
102 #include "ardour/speakers.h"
103 #include "ardour/tempo.h"
104 #include "ardour/ticker.h"
105 #include "ardour/track.h"
106 #include "ardour/user_bundle.h"
107 #include "ardour/utils.h"
108 #include "ardour/vca_manager.h"
109 #include "ardour/vca.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)
310 , ignore_route_processor_changes (false)
315 , _vca_manager (new VCAManager (*this))
319 pthread_mutex_init (&_rt_emit_mutex, 0);
320 pthread_cond_init (&_rt_emit_cond, 0);
322 pthread_mutex_init (&_auto_connect_mutex, 0);
323 pthread_cond_init (&_auto_connect_cond, 0);
325 init_name_id_counter (1); // reset for new sessions, start at 1
326 VCA::set_next_vca_number (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"), PresentationInfo::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, 0);
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 presentation order %2\n", (*i)->name(), (*i)->presentation_info().global_order()));
2312 SuccessfulGraphSort (); /* EMIT SIGNAL */
2315 /* The topological sort failed, so we have a problem. Tell everyone
2316 and stick to the old graph; this will continue to be processed, so
2317 until the feedback is fixed, what is played back will not quite
2318 reflect what is actually connected. Note also that we do not
2319 do trace_terminal here, as it would fail due to an endless recursion,
2320 so the solo code will think that everything is still connected
2324 FeedbackDetected (); /* EMIT SIGNAL */
2329 /** Find a route name starting with \a base, maybe followed by the
2330 * lowest \a id. \a id will always be added if \a definitely_add_number
2331 * is true on entry; otherwise it will only be added if required
2332 * to make the name unique.
2334 * Names are constructed like e.g. "Audio 3" for base="Audio" and id=3.
2335 * The available route name with the lowest ID will be used, and \a id
2336 * will be set to the ID.
2338 * \return false if a route name could not be found, and \a track_name
2339 * and \a id do not reflect a free route name.
2342 Session::find_route_name (string const & base, uint32_t& id, string& name, bool definitely_add_number)
2344 /* the base may conflict with ports that do not belong to existing
2345 routes, but hidden objects like the click track. So check port names
2346 before anything else.
2349 for (vector<string>::const_iterator reserved = reserved_io_names.begin(); reserved != reserved_io_names.end(); ++reserved) {
2350 if (base == *reserved) {
2351 /* Check if this reserved name already exists, and if
2352 so, disallow it without a numeric suffix.
2354 if (route_by_name (*reserved)) {
2355 definitely_add_number = true;
2364 if (!definitely_add_number && route_by_name (base) == 0) {
2365 /* juse use the base */
2371 name = string_compose ("%1 %2", base, id);
2373 if (route_by_name (name) == 0) {
2379 } while (id < (UINT_MAX-1));
2384 /** Count the total ins and outs of all non-hidden tracks in the session and return them in in and out */
2386 Session::count_existing_track_channels (ChanCount& in, ChanCount& out)
2388 in = ChanCount::ZERO;
2389 out = ChanCount::ZERO;
2391 boost::shared_ptr<RouteList> r = routes.reader ();
2393 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
2394 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
2395 if (tr && !tr->is_auditioner()) {
2396 in += tr->n_inputs();
2397 out += tr->n_outputs();
2403 Session::default_track_name_pattern (DataType t)
2406 case DataType::AUDIO:
2407 if (Profile->get_trx()) {
2414 case DataType::MIDI:
2421 /** Caller must not hold process lock
2422 * @param name_template string to use for the start of the name, or "" to use "MIDI".
2423 * @param instrument plugin info for the instrument to insert pre-fader, if any
2425 list<boost::shared_ptr<MidiTrack> >
2426 Session::new_midi_track (const ChanCount& input, const ChanCount& output,
2427 boost::shared_ptr<PluginInfo> instrument, Plugin::PresetRecord* pset,
2428 RouteGroup* route_group, uint32_t how_many, string name_template, PresentationInfo::order_t order,
2432 uint32_t track_id = 0;
2434 RouteList new_routes;
2435 list<boost::shared_ptr<MidiTrack> > ret;
2437 const string name_pattern = default_track_name_pattern (DataType::MIDI);
2438 bool const use_number = (how_many != 1) || name_template.empty () || (name_template == name_pattern);
2441 if (!find_route_name (name_template.empty() ? _("MIDI") : name_template, ++track_id, track_name, use_number)) {
2442 error << "cannot find name for new midi track" << endmsg;
2446 boost::shared_ptr<MidiTrack> track;
2449 track.reset (new MidiTrack (*this, track_name, mode));
2451 if (track->init ()) {
2455 if (Profile->get_mixbus ()) {
2456 track->set_strict_io (true);
2459 track->use_new_diskstream();
2461 BOOST_MARK_TRACK (track);
2464 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
2465 if (track->input()->ensure_io (input, false, this)) {
2466 error << "cannot configure " << input << " out configuration for new midi track" << endmsg;
2470 if (track->output()->ensure_io (output, false, this)) {
2471 error << "cannot configure " << output << " out configuration for new midi track" << endmsg;
2476 track->non_realtime_input_change();
2479 route_group->add (track);
2482 track->DiskstreamChanged.connect_same_thread (*this, boost::bind (&Session::resort_routes, this));
2484 new_routes.push_back (track);
2485 ret.push_back (track);
2488 catch (failed_constructor &err) {
2489 error << _("Session: could not create new midi track.") << endmsg;
2493 catch (AudioEngine::PortRegistrationFailure& pfe) {
2495 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;
2503 if (!new_routes.empty()) {
2504 StateProtector sp (this);
2505 if (Profile->get_trx()) {
2506 add_routes (new_routes, false, false, false, order);
2508 add_routes (new_routes, true, true, false, order);
2512 for (RouteList::iterator r = new_routes.begin(); r != new_routes.end(); ++r) {
2513 PluginPtr plugin = instrument->load (*this);
2515 plugin->load_preset (*pset);
2517 boost::shared_ptr<Processor> p (new PluginInsert (*this, plugin));
2518 (*r)->add_processor (p, PreFader);
2528 Session::new_midi_route (RouteGroup* route_group, uint32_t how_many, string name_template, boost::shared_ptr<PluginInfo> instrument, Plugin::PresetRecord* pset,
2529 PresentationInfo::Flag flag, PresentationInfo::order_t order)
2532 uint32_t bus_id = 0;
2536 bool const use_number = (how_many != 1) || name_template.empty () || name_template == _("Midi Bus");
2539 if (!find_route_name (name_template.empty () ? _("Midi Bus") : name_template, ++bus_id, bus_name, use_number)) {
2540 error << "cannot find name for new midi bus" << endmsg;
2545 boost::shared_ptr<Route> bus (new Route (*this, bus_name, flag, DataType::AUDIO)); // XXX Editor::add_routes is not ready for ARDOUR::DataType::MIDI
2551 if (Profile->get_mixbus ()) {
2552 bus->set_strict_io (true);
2555 BOOST_MARK_ROUTE(bus);
2558 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
2560 if (bus->input()->ensure_io (ChanCount(DataType::MIDI, 1), false, this)) {
2561 error << _("cannot configure new midi bus input") << endmsg;
2566 if (bus->output()->ensure_io (ChanCount(DataType::MIDI, 1), false, this)) {
2567 error << _("cannot configure new midi bus output") << endmsg;
2573 route_group->add (bus);
2576 ret.push_back (bus);
2579 catch (failed_constructor &err) {
2580 error << _("Session: could not create new audio route.") << endmsg;
2584 catch (AudioEngine::PortRegistrationFailure& pfe) {
2585 error << pfe.what() << endmsg;
2595 StateProtector sp (this);
2596 add_routes (ret, false, false, false, order);
2599 for (RouteList::iterator r = ret.begin(); r != ret.end(); ++r) {
2600 PluginPtr plugin = instrument->load (*this);
2602 plugin->load_preset (*pset);
2604 boost::shared_ptr<Processor> p (new PluginInsert (*this, plugin));
2605 (*r)->add_processor (p, PreFader);
2616 Session::midi_output_change_handler (IOChange change, void * /*src*/, boost::weak_ptr<Route> wmt)
2618 boost::shared_ptr<Route> midi_track (wmt.lock());
2624 if ((change.type & IOChange::ConfigurationChanged) && Config->get_output_auto_connect() != ManualConnect) {
2626 if (change.after.n_audio() <= change.before.n_audio()) {
2630 /* new audio ports: make sure the audio goes somewhere useful,
2631 * unless the user has no-auto-connect selected.
2633 * The existing ChanCounts don't matter for this call as they are only
2634 * to do with matching input and output indices, and we are only changing
2637 auto_connect_route (midi_track, false, ChanCount(), change.before);
2641 #ifdef USE_TRACKS_CODE_FEATURES
2644 compare_routes_by_remote_id (const boost::shared_ptr<Route>& route1, const boost::shared_ptr<Route>& route2)
2646 return route1->remote_control_id() < route2->remote_control_id();
2650 Session::reconnect_existing_routes (bool withLock, bool reconnect_master, bool reconnect_inputs, bool reconnect_outputs)
2652 // it is not allowed to perform connection
2653 if (!IO::connecting_legal) {
2657 // if we are deleting routes we will call this once at the end
2658 if (_route_deletion_in_progress) {
2662 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock (), Glib::Threads::NOT_LOCK);
2668 // We need to disconnect the route's inputs and outputs first
2669 // basing on autoconnect configuration
2670 bool reconnectIputs = !(Config->get_input_auto_connect() & ManualConnect) && reconnect_inputs;
2671 bool reconnectOutputs = !(Config->get_output_auto_connect() & ManualConnect) && reconnect_outputs;
2673 ChanCount existing_inputs;
2674 ChanCount existing_outputs;
2675 count_existing_track_channels (existing_inputs, existing_outputs);
2677 //ChanCount inputs = ChanCount::ZERO;
2678 //ChanCount outputs = ChanCount::ZERO;
2680 RouteList existing_routes = *routes.reader ();
2681 existing_routes.sort (compare_routes_by_remote_id);
2684 PBD::Unwinder<bool> protect_ignore_changes (_reconnecting_routes_in_progress, true);
2686 vector<string> physinputs;
2687 vector<string> physoutputs;
2689 EngineStateController::instance()->get_physical_audio_outputs(physoutputs);
2690 EngineStateController::instance()->get_physical_audio_inputs(physinputs);
2692 uint32_t input_n = 0;
2693 uint32_t output_n = 0;
2694 RouteList::iterator rIter = existing_routes.begin();
2695 const AutoConnectOption current_input_auto_connection (Config->get_input_auto_connect());
2696 const AutoConnectOption current_output_auto_connection (Config->get_output_auto_connect());
2697 for (; rIter != existing_routes.end(); ++rIter) {
2698 if (*rIter == _master_out || *rIter == _monitor_out ) {
2702 if (current_output_auto_connection == AutoConnectPhysical) {
2703 (*rIter)->amp()->deactivate();
2704 } else if (current_output_auto_connection == AutoConnectMaster) {
2705 (*rIter)->amp()->activate();
2708 if (reconnectIputs) {
2709 (*rIter)->input()->disconnect (this); //GZ: check this; could be heavy
2711 for (uint32_t route_input_n = 0; route_input_n < (*rIter)->n_inputs().get(DataType::AUDIO); ++route_input_n) {
2713 if (current_input_auto_connection & AutoConnectPhysical) {
2715 if ( input_n == physinputs.size() ) {
2719 string port = physinputs[input_n];
2721 if (port.empty() ) {
2722 error << "Physical Input number "<< input_n << " is unavailable and cannot be connected" << endmsg;
2725 //GZ: check this; could be heavy
2726 (*rIter)->input()->connect ((*rIter)->input()->ports().port(DataType::AUDIO, route_input_n), port, this);
2732 if (reconnectOutputs) {
2734 //normalize route ouptuts: reduce the amount outputs to be equal to the amount of inputs
2735 if (current_output_auto_connection & AutoConnectPhysical) {
2737 //GZ: check this; could be heavy
2738 (*rIter)->output()->disconnect (this);
2739 size_t route_inputs_count = (*rIter)->n_inputs().get(DataType::AUDIO);
2741 //GZ: check this; could be heavy
2742 (*rIter)->output()->ensure_io(ChanCount(DataType::AUDIO, route_inputs_count), false, this );
2744 } else if (current_output_auto_connection & AutoConnectMaster){
2746 if (!reconnect_master) {
2750 //GZ: check this; could be heavy
2751 (*rIter)->output()->disconnect (this);
2754 uint32_t master_inputs_count = _master_out->n_inputs().get(DataType::AUDIO);
2755 (*rIter)->output()->ensure_io(ChanCount(DataType::AUDIO, master_inputs_count), false, this );
2757 error << error << "Master bus is not available" << endmsg;
2762 for (uint32_t route_output_n = 0; route_output_n < (*rIter)->n_outputs().get(DataType::AUDIO); ++route_output_n) {
2763 if (current_output_auto_connection & AutoConnectPhysical) {
2765 if ( output_n == physoutputs.size() ) {
2769 string port = physoutputs[output_n];
2771 if (port.empty() ) {
2772 error << "Physical Output number "<< output_n << " is unavailable and cannot be connected" << endmsg;
2775 //GZ: check this; could be heavy
2776 (*rIter)->output()->connect ((*rIter)->output()->ports().port(DataType::AUDIO, route_output_n), port, this);
2779 } else if (current_output_auto_connection & AutoConnectMaster) {
2781 if ( route_output_n == _master_out->n_inputs().get(DataType::AUDIO) ) {
2785 // connect to master bus
2786 string port = _master_out->input()->ports().port(DataType::AUDIO, route_output_n)->name();
2788 if (port.empty() ) {
2789 error << "MasterBus Input number "<< route_output_n << " is unavailable and cannot be connected" << endmsg;
2793 //GZ: check this; could be heavy
2794 (*rIter)->output()->connect ((*rIter)->output()->ports().port(DataType::AUDIO, route_output_n), port, this);
2801 _master_out->output()->disconnect (this);
2802 auto_connect_master_bus ();
2807 session_routes_reconnected (); /* EMIT SIGNAL */
2811 Session::reconnect_midi_scene_ports(bool inputs)
2815 boost::shared_ptr<MidiPort> scene_in_ptr = scene_in();
2817 scene_in_ptr->disconnect_all ();
2819 std::vector<EngineStateController::MidiPortState> midi_port_states;
2820 EngineStateController::instance()->get_physical_midi_input_states (midi_port_states);
2822 std::vector<EngineStateController::MidiPortState>::iterator state_iter = midi_port_states.begin();
2824 for (; state_iter != midi_port_states.end(); ++state_iter) {
2825 if (state_iter->active && state_iter->available && state_iter->scene_connected) {
2826 scene_in_ptr->connect (state_iter->name);
2833 boost::shared_ptr<MidiPort> scene_out_ptr = scene_out();
2835 if (scene_out_ptr ) {
2836 scene_out_ptr->disconnect_all ();
2838 std::vector<EngineStateController::MidiPortState> midi_port_states;
2839 EngineStateController::instance()->get_physical_midi_output_states (midi_port_states);
2841 std::vector<EngineStateController::MidiPortState>::iterator state_iter = midi_port_states.begin();
2843 for (; state_iter != midi_port_states.end(); ++state_iter) {
2844 if (state_iter->active && state_iter->available && state_iter->scene_connected) {
2845 scene_out_ptr->connect (state_iter->name);
2853 Session::reconnect_mtc_ports ()
2855 boost::shared_ptr<MidiPort> mtc_in_ptr = _midi_ports->mtc_input_port();
2861 mtc_in_ptr->disconnect_all ();
2863 std::vector<EngineStateController::MidiPortState> midi_port_states;
2864 EngineStateController::instance()->get_physical_midi_input_states (midi_port_states);
2866 std::vector<EngineStateController::MidiPortState>::iterator state_iter = midi_port_states.begin();
2868 for (; state_iter != midi_port_states.end(); ++state_iter) {
2869 if (state_iter->available && state_iter->mtc_in) {
2870 mtc_in_ptr->connect (state_iter->name);
2874 if (!_midi_ports->mtc_input_port ()->connected () &&
2875 config.get_external_sync () &&
2876 (Config->get_sync_source () == MTC) ) {
2877 config.set_external_sync (false);
2880 if ( ARDOUR::Profile->get_trx () ) {
2881 // Tracks need this signal to update timecode_source_dropdown
2882 MtcOrLtcInputPortChanged (); //emit signal
2887 Session::reconnect_mmc_ports(bool inputs)
2889 if (inputs ) { // get all enabled midi input ports
2891 boost::shared_ptr<MidiPort> mmc_in_ptr = _midi_ports->mmc_in();
2893 mmc_in_ptr->disconnect_all ();
2894 std::vector<std::string> enabled_midi_inputs;
2895 EngineStateController::instance()->get_physical_midi_inputs (enabled_midi_inputs);
2897 std::vector<std::string>::iterator port_iter = enabled_midi_inputs.begin();
2899 for (; port_iter != enabled_midi_inputs.end(); ++port_iter) {
2900 mmc_in_ptr->connect (*port_iter);
2904 } else { // get all enabled midi output ports
2906 boost::shared_ptr<MidiPort> mmc_out_ptr = _midi_ports->mmc_out();
2908 mmc_out_ptr->disconnect_all ();
2909 std::vector<std::string> enabled_midi_outputs;
2910 EngineStateController::instance()->get_physical_midi_outputs (enabled_midi_outputs);
2912 std::vector<std::string>::iterator port_iter = enabled_midi_outputs.begin();
2914 for (; port_iter != enabled_midi_outputs.end(); ++port_iter) {
2915 mmc_out_ptr->connect (*port_iter);
2924 Session::ensure_presentation_info_gap (PresentationInfo::order_t first_new_order, uint32_t how_many)
2926 if (first_new_order == PresentationInfo::max_order) {
2927 /* adding at end, no worries */
2931 /* create a gap in the existing route order keys to accomodate new routes.*/
2932 boost::shared_ptr <RouteList> rd = routes.reader();
2933 for (RouteList::iterator ri = rd->begin(); ri != rd->end(); ++ri) {
2934 boost::shared_ptr<Route> rt (*ri);
2936 if (rt->presentation_info().special()) {
2940 if (rt->presentation_info().group_order () >= first_new_order) {
2941 rt->set_presentation_group_order (rt->presentation_info().group_order () + how_many);
2946 /** Caller must not hold process lock
2947 * @param name_template string to use for the start of the name, or "" to use "Audio".
2949 list< boost::shared_ptr<AudioTrack> >
2950 Session::new_audio_track (int input_channels, int output_channels, RouteGroup* route_group,
2951 uint32_t how_many, string name_template, PresentationInfo::order_t order,
2955 uint32_t track_id = 0;
2957 RouteList new_routes;
2958 list<boost::shared_ptr<AudioTrack> > ret;
2960 const string name_pattern = default_track_name_pattern (DataType::AUDIO);
2961 bool const use_number = (how_many != 1) || name_template.empty () || (name_template == name_pattern);
2965 if (!find_route_name (name_template.empty() ? _(name_pattern.c_str()) : name_template, ++track_id, track_name, use_number)) {
2966 error << "cannot find name for new audio track" << endmsg;
2970 boost::shared_ptr<AudioTrack> track;
2973 track.reset (new AudioTrack (*this, track_name, mode));
2975 if (track->init ()) {
2979 if (Profile->get_mixbus ()) {
2980 track->set_strict_io (true);
2983 if (ARDOUR::Profile->get_trx ()) {
2984 // TRACKS considers it's not a USE CASE, it's
2985 // a piece of behavior of the session model:
2987 // Gain for a newly created route depends on
2988 // the current output_auto_connect mode:
2990 // 0 for Stereo Out mode
2992 if (Config->get_output_auto_connect() & AutoConnectMaster) {
2993 track->gain_control()->set_value (dB_to_coefficient (0), Controllable::NoGroup);
2997 track->use_new_diskstream();
2999 BOOST_MARK_TRACK (track);
3002 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
3004 if (track->input()->ensure_io (ChanCount(DataType::AUDIO, input_channels), false, this)) {
3005 error << string_compose (
3006 _("cannot configure %1 in/%2 out configuration for new audio track"),
3007 input_channels, output_channels)
3012 if (track->output()->ensure_io (ChanCount(DataType::AUDIO, output_channels), false, this)) {
3013 error << string_compose (
3014 _("cannot configure %1 in/%2 out configuration for new audio track"),
3015 input_channels, output_channels)
3022 route_group->add (track);
3025 track->non_realtime_input_change();
3027 track->DiskstreamChanged.connect_same_thread (*this, boost::bind (&Session::resort_routes, this));
3029 new_routes.push_back (track);
3030 ret.push_back (track);
3033 catch (failed_constructor &err) {
3034 error << _("Session: could not create new audio track.") << endmsg;
3038 catch (AudioEngine::PortRegistrationFailure& pfe) {
3040 error << pfe.what() << endmsg;
3048 if (!new_routes.empty()) {
3049 StateProtector sp (this);
3050 if (Profile->get_trx()) {
3051 add_routes (new_routes, false, false, false, order);
3053 add_routes (new_routes, true, true, false, order);
3060 /** Caller must not hold process lock.
3061 * @param name_template string to use for the start of the name, or "" to use "Bus".
3064 Session::new_audio_route (int input_channels, int output_channels, RouteGroup* route_group, uint32_t how_many, string name_template,
3065 PresentationInfo::Flag flags, PresentationInfo::order_t order)
3068 uint32_t bus_id = 0;
3072 bool const use_number = (how_many != 1) || name_template.empty () || name_template == _("Bus");
3074 ensure_presentation_info_gap (order, how_many);
3077 if (!find_route_name (name_template.empty () ? _("Bus") : name_template, ++bus_id, bus_name, use_number)) {
3078 error << "cannot find name for new audio bus" << endmsg;
3083 boost::shared_ptr<Route> bus (new Route (*this, bus_name, flags, DataType::AUDIO));
3089 if (Profile->get_mixbus ()) {
3090 bus->set_strict_io (true);
3093 BOOST_MARK_ROUTE(bus);
3096 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
3098 if (bus->input()->ensure_io (ChanCount(DataType::AUDIO, input_channels), false, this)) {
3099 error << string_compose (_("cannot configure %1 in/%2 out configuration for new audio track"),
3100 input_channels, output_channels)
3106 if (bus->output()->ensure_io (ChanCount(DataType::AUDIO, output_channels), false, this)) {
3107 error << string_compose (_("cannot configure %1 in/%2 out configuration for new audio track"),
3108 input_channels, output_channels)
3115 route_group->add (bus);
3118 bus->add_internal_return ();
3119 ret.push_back (bus);
3122 catch (failed_constructor &err) {
3123 error << _("Session: could not create new audio route.") << endmsg;
3127 catch (AudioEngine::PortRegistrationFailure& pfe) {
3128 error << pfe.what() << endmsg;
3138 StateProtector sp (this);
3139 if (Profile->get_trx()) {
3140 add_routes (ret, false, false, false, order);
3142 add_routes (ret, false, true, true, order); // autoconnect // outputs only
3151 Session::new_route_from_template (uint32_t how_many, const std::string& template_path, const std::string& name_base, PlaylistDisposition pd)
3155 if (!tree.read (template_path.c_str())) {
3159 return new_route_from_template (how_many, *tree.root(), name_base, pd);
3163 Session::new_route_from_template (uint32_t how_many, XMLNode& node, const std::string& name_base, PlaylistDisposition pd)
3166 uint32_t number = 0;
3167 const uint32_t being_added = how_many;
3168 /* This will prevent the use of any existing XML-provided PBD::ID
3171 Stateful::ForceIDRegeneration force_ids;
3172 IO::disable_connecting ();
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 boost::shared_ptr<Track> track;
3296 if ((track = boost::dynamic_pointer_cast<Track> (route))) {
3299 track->use_new_playlist ();
3302 track->use_copy_playlist ();
3309 ret.push_back (route);
3312 catch (failed_constructor &err) {
3313 error << _("Session: could not create new route from template") << endmsg;
3317 catch (AudioEngine::PortRegistrationFailure& pfe) {
3318 error << pfe.what() << endmsg;
3327 StateProtector sp (this);
3328 if (Profile->get_trx()) {
3329 add_routes (ret, false, false, false, PresentationInfo::max_order);
3331 add_routes (ret, true, true, false, PresentationInfo::max_order);
3333 IO::enable_connecting ();
3340 Session::add_routes (RouteList& new_routes, bool input_auto_connect, bool output_auto_connect, bool save, PresentationInfo::order_t order)
3343 PBD::Unwinder<bool> aip (_adding_routes_in_progress, true);
3344 add_routes_inner (new_routes, input_auto_connect, output_auto_connect, order);
3347 error << _("Adding new tracks/busses failed") << endmsg;
3352 update_latency (true);
3353 update_latency (false);
3358 save_state (_current_snapshot_name);
3361 update_route_record_state ();
3363 RouteAdded (new_routes); /* EMIT SIGNAL */
3367 Session::add_routes_inner (RouteList& new_routes, bool input_auto_connect, bool output_auto_connect, PresentationInfo::order_t order)
3369 ChanCount existing_inputs;
3370 ChanCount existing_outputs;
3374 count_existing_track_channels (existing_inputs, existing_outputs);
3377 RCUWriter<RouteList> writer (routes);
3378 boost::shared_ptr<RouteList> r = writer.get_copy ();
3379 r->insert (r->end(), new_routes.begin(), new_routes.end());
3380 n_routes = r->size();
3382 /* if there is no control out and we're not in the middle of loading,
3383 * resort the graph here. if there is a control out, we will resort
3384 * toward the end of this method. if we are in the middle of loading,
3385 * we will resort when done.
3388 if (!_monitor_out && IO::connecting_legal) {
3389 resort_routes_using (r);
3393 DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("ensure order gap starting at %1 for %2\n", order, new_routes.size()));
3394 ensure_presentation_info_gap (order, new_routes.size());
3396 for (RouteList::iterator x = new_routes.begin(); x != new_routes.end(); ++x, ++added) {
3398 boost::weak_ptr<Route> wpr (*x);
3399 boost::shared_ptr<Route> r (*x);
3401 r->solo_control()->Changed.connect_same_thread (*this, boost::bind (&Session::route_solo_changed, this, _1, _2,wpr));
3402 r->solo_isolate_control()->Changed.connect_same_thread (*this, boost::bind (&Session::route_solo_isolated_changed, this, wpr));
3403 r->mute_control()->Changed.connect_same_thread (*this, boost::bind (&Session::route_mute_changed, this));
3405 r->output()->changed.connect_same_thread (*this, boost::bind (&Session::set_worst_io_latencies_x, this, _1, _2));
3406 r->processors_changed.connect_same_thread (*this, boost::bind (&Session::route_processors_changed, this, _1));
3408 if (r->is_master()) {
3412 if (r->is_monitor()) {
3416 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (r);
3418 tr->PlaylistChanged.connect_same_thread (*this, boost::bind (&Session::track_playlist_changed, this, boost::weak_ptr<Track> (tr)));
3419 track_playlist_changed (boost::weak_ptr<Track> (tr));
3420 tr->rec_enable_control()->Changed.connect_same_thread (*this, boost::bind (&Session::update_route_record_state, this));
3422 boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (tr);
3424 mt->StepEditStatusChange.connect_same_thread (*this, boost::bind (&Session::step_edit_status_change, this, _1));
3425 mt->output()->changed.connect_same_thread (*this, boost::bind (&Session::midi_output_change_handler, this, _1, _2, boost::weak_ptr<Route>(mt)));
3429 if (!r->presentation_info().special()) {
3431 DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("checking PI state for %1\n", r->name()));
3433 /* presentation info order may already have been set from XML */
3435 if (r->presentation_info().unordered()) {
3437 if (order == PresentationInfo::max_order) {
3438 /* just add to the end */
3439 r->set_presentation_group_order_explicit (n_routes + added);
3440 DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("group order not set, set to NR %1 + %2 = %3\n", n_routes, added, n_routes + added));
3442 r->set_presentation_group_order_explicit (order + added);
3443 DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("group order not set, set to %1 + %2 = %3\n", order, added, order + added));
3446 DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("group order already set to %1\n", r->presentation_info().group_order()));
3450 DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("added route %1, group order %2 global order %3 type %4 (summary: %5)\n",
3452 r->presentation_info().group_order(),
3453 r->presentation_info().global_order(),
3454 enum_2_string (r->presentation_info().flags()),
3455 r->presentation_info().to_string()));
3458 if (input_auto_connect || output_auto_connect) {
3459 auto_connect_route (r, input_auto_connect, ChanCount (), ChanCount (), existing_inputs, existing_outputs);
3460 existing_inputs += r->n_inputs();
3461 existing_outputs += r->n_outputs();
3467 if (_monitor_out && IO::connecting_legal) {
3468 Glib::Threads::Mutex::Lock lm (_engine.process_lock());
3470 for (RouteList::iterator x = new_routes.begin(); x != new_routes.end(); ++x) {
3471 if ((*x)->is_monitor()) {
3473 } else if ((*x)->is_master()) {
3476 (*x)->enable_monitor_send ();
3483 Session::globally_set_send_gains_to_zero (boost::shared_ptr<Route> dest)
3485 boost::shared_ptr<RouteList> r = routes.reader ();
3486 boost::shared_ptr<Send> s;
3488 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3489 if ((s = (*i)->internal_send_for (dest)) != 0) {
3490 s->amp()->gain_control()->set_value (GAIN_COEFF_ZERO, Controllable::NoGroup);
3496 Session::globally_set_send_gains_to_unity (boost::shared_ptr<Route> dest)
3498 boost::shared_ptr<RouteList> r = routes.reader ();
3499 boost::shared_ptr<Send> s;
3501 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3502 if ((s = (*i)->internal_send_for (dest)) != 0) {
3503 s->amp()->gain_control()->set_value (GAIN_COEFF_UNITY, Controllable::NoGroup);
3509 Session::globally_set_send_gains_from_track(boost::shared_ptr<Route> dest)
3511 boost::shared_ptr<RouteList> r = routes.reader ();
3512 boost::shared_ptr<Send> s;
3514 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3515 if ((s = (*i)->internal_send_for (dest)) != 0) {
3516 s->amp()->gain_control()->set_value ((*i)->gain_control()->get_value(), Controllable::NoGroup);
3521 /** @param include_buses true to add sends to buses and tracks, false for just tracks */
3523 Session::globally_add_internal_sends (boost::shared_ptr<Route> dest, Placement p, bool include_buses)
3525 boost::shared_ptr<RouteList> r = routes.reader ();
3526 boost::shared_ptr<RouteList> t (new RouteList);
3528 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3529 /* no MIDI sends because there are no MIDI busses yet */
3530 if (include_buses || boost::dynamic_pointer_cast<AudioTrack>(*i)) {
3535 add_internal_sends (dest, p, t);
3539 Session::add_internal_sends (boost::shared_ptr<Route> dest, Placement p, boost::shared_ptr<RouteList> senders)
3541 for (RouteList::iterator i = senders->begin(); i != senders->end(); ++i) {
3542 add_internal_send (dest, (*i)->before_processor_for_placement (p), *i);
3547 Session::add_internal_send (boost::shared_ptr<Route> dest, int index, boost::shared_ptr<Route> sender)
3549 add_internal_send (dest, sender->before_processor_for_index (index), sender);
3553 Session::add_internal_send (boost::shared_ptr<Route> dest, boost::shared_ptr<Processor> before, boost::shared_ptr<Route> sender)
3555 if (sender->is_monitor() || sender->is_master() || sender == dest || dest->is_monitor() || dest->is_master()) {
3559 if (!dest->internal_return()) {
3560 dest->add_internal_return ();
3563 sender->add_aux_send (dest, before);
3569 Session::remove_routes (boost::shared_ptr<RouteList> routes_to_remove)
3571 { // RCU Writer scope
3572 PBD::Unwinder<bool> uw_flag (_route_deletion_in_progress, true);
3573 RCUWriter<RouteList> writer (routes);
3574 boost::shared_ptr<RouteList> rs = writer.get_copy ();
3577 for (RouteList::iterator iter = routes_to_remove->begin(); iter != routes_to_remove->end(); ++iter) {
3579 if (*iter == _master_out) {
3583 (*iter)->solo_control()->set_value (0.0, Controllable::NoGroup);
3587 /* deleting the master out seems like a dumb
3588 idea, but its more of a UI policy issue
3592 if (*iter == _master_out) {
3593 _master_out = boost::shared_ptr<Route> ();
3596 if (*iter == _monitor_out) {
3597 _monitor_out.reset ();
3600 // We need to disconnect the route's inputs and outputs
3602 (*iter)->input()->disconnect (0);
3603 (*iter)->output()->disconnect (0);
3605 /* if the route had internal sends sending to it, remove them */
3606 if ((*iter)->internal_return()) {
3608 boost::shared_ptr<RouteList> r = routes.reader ();
3609 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3610 boost::shared_ptr<Send> s = (*i)->internal_send_for (*iter);
3612 (*i)->remove_processor (s);
3617 /* if the monitoring section had a pointer to this route, remove it */
3618 if (_monitor_out && !(*iter)->is_master() && !(*iter)->is_monitor()) {
3619 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
3620 PBD::Unwinder<bool> uw (ignore_route_processor_changes, true);
3621 (*iter)->remove_aux_or_listen (_monitor_out);
3624 boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (*iter);
3625 if (mt && mt->step_editing()) {
3626 if (_step_editors > 0) {
3632 /* writer goes out of scope, forces route list update */
3634 } // end of RCU Writer scope
3636 update_route_solo_state ();
3637 update_latency_compensation ();
3640 /* Re-sort routes to remove the graph's current references to the one that is
3641 * going away, then flush old references out of the graph.
3642 * Wave Tracks: reconnect routes
3645 #ifdef USE_TRACKS_CODE_FEATURES
3646 reconnect_existing_routes(true, false);
3648 routes.flush (); // maybe unsafe, see below.
3652 if (_process_graph && !(_state_of_the_state & Deletion)) {
3653 _process_graph->clear_other_chain ();
3656 /* get rid of it from the dead wood collection in the route list manager */
3657 /* XXX i think this is unsafe as it currently stands, but i am not sure. (pd, october 2nd, 2006) */
3661 /* try to cause everyone to drop their references
3662 * and unregister ports from the backend
3665 for (RouteList::iterator iter = routes_to_remove->begin(); iter != routes_to_remove->end(); ++iter) {
3666 (*iter)->drop_references ();
3669 if (_state_of_the_state & Deletion) {
3673 Stripable::PresentationInfoChange(); /* EMIT SIGNAL */
3675 /* save the new state of the world */
3677 if (save_state (_current_snapshot_name)) {
3678 save_history (_current_snapshot_name);
3681 update_route_record_state ();
3685 Session::remove_route (boost::shared_ptr<Route> route)
3687 boost::shared_ptr<RouteList> rl (new RouteList);
3688 rl->push_back (route);
3693 Session::route_mute_changed ()
3699 Session::route_listen_changed (Controllable::GroupControlDisposition group_override, boost::weak_ptr<Route> wpr)
3701 boost::shared_ptr<Route> route (wpr.lock());
3707 assert (Config->get_solo_control_is_listen_control());
3709 if (route->solo_control()->soloed_by_self_or_masters()) {
3711 if (Config->get_exclusive_solo()) {
3713 RouteGroup* rg = route->route_group ();
3714 const bool group_already_accounted_for = (group_override == Controllable::ForGroup);
3716 boost::shared_ptr<RouteList> r = routes.reader ();
3718 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3719 if ((*i) == route) {
3720 /* already changed */
3724 if ((*i)->solo_isolate_control()->solo_isolated() || !(*i)->can_solo()) {
3725 /* route does not get solo propagated to it */
3729 if ((group_already_accounted_for && (*i)->route_group() && (*i)->route_group() == rg)) {
3730 /* this route is a part of the same solo group as the route
3731 * that was changed. Changing that route did change or will
3732 * change all group members appropriately, so we can ignore it
3737 (*i)->solo_control()->set_value (0.0, Controllable::NoGroup);
3743 } else if (_listen_cnt > 0) {
3748 update_route_solo_state ();
3752 Session::route_solo_isolated_changed (boost::weak_ptr<Route> wpr)
3754 boost::shared_ptr<Route> route (wpr.lock());
3760 bool send_changed = false;
3762 if (route->solo_isolate_control()->solo_isolated()) {
3763 if (_solo_isolated_cnt == 0) {
3764 send_changed = true;
3766 _solo_isolated_cnt++;
3767 } else if (_solo_isolated_cnt > 0) {
3768 _solo_isolated_cnt--;
3769 if (_solo_isolated_cnt == 0) {
3770 send_changed = true;
3775 IsolatedChanged (); /* EMIT SIGNAL */
3780 Session::route_solo_changed (bool self_solo_changed, Controllable::GroupControlDisposition group_override, boost::weak_ptr<Route> wpr)
3782 DEBUG_TRACE (DEBUG::Solo, string_compose ("route solo change, self = %1\n", self_solo_changed));
3784 boost::shared_ptr<Route> route (wpr.lock());
3790 if (Config->get_solo_control_is_listen_control()) {
3791 route_listen_changed (group_override, wpr);
3795 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1: self %2 masters %3 transition %4\n", route->name(), route->self_soloed(), route->solo_control()->get_masters_value(), route->solo_control()->transitioned_into_solo()));
3797 if (route->solo_control()->transitioned_into_solo() == 0) {
3798 /* route solo changed by upstream/downstream; not interesting
3801 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1 not self-soloed nor soloed by master (%2), ignoring\n", route->name(), route->solo_control()->get_masters_value()));
3805 if (route->solo_control()->transitioned_into_solo() == 0) {
3806 /* reason for being soloed changed (e.g. master went away, we
3807 * took over the master state), but actual status did
3808 * not. nothing to do.
3810 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1: solo change was change in reason, not status\n", route->name()));
3813 boost::shared_ptr<RouteList> r = routes.reader ();
3814 int32_t delta = route->solo_control()->transitioned_into_solo ();
3816 /* the route may be a member of a group that has shared-solo
3817 * semantics. If so, then all members of that group should follow the
3818 * solo of the changed route. But ... this is optional, controlled by a
3819 * Controllable::GroupControlDisposition.
3821 * The first argument to the signal that this method is connected to is the
3822 * GroupControlDisposition value that was used to change solo.
3824 * If the solo change was done with group semantics (either InverseGroup
3825 * (force the entire group to change even if the group shared solo is
3826 * disabled) or UseGroup (use the group, which may or may not have the
3827 * shared solo property enabled)) then as we propagate the change to
3828 * the entire session we should IGNORE THE GROUP that the changed route
3832 RouteGroup* rg = route->route_group ();
3833 const bool group_already_accounted_for = (group_override == Controllable::ForGroup);
3835 if (delta == 1 && Config->get_exclusive_solo()) {
3837 /* new solo: disable all other solos, but not the group if its solo-enabled */
3839 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3841 if ((*i) == route) {
3842 /* already changed */
3846 if ((*i)->solo_isolate_control()->solo_isolated() || !(*i)->can_solo()) {
3847 /* route does not get solo propagated to it */
3851 if ((group_already_accounted_for && (*i)->route_group() && (*i)->route_group() == rg)) {
3852 /* this route is a part of the same solo group as the route
3853 * that was changed. Changing that route did change or will
3854 * change all group members appropriately, so we can ignore it
3860 (*i)->solo_control()->set_value (0.0, group_override);
3864 DEBUG_TRACE (DEBUG::Solo, string_compose ("propagate solo change, delta = %1\n", delta));
3866 RouteList uninvolved;
3868 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1\n", route->name()));
3870 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3871 bool via_sends_only;
3872 bool in_signal_flow;
3874 if ((*i) == route) {
3875 /* already changed */
3879 if ((*i)->solo_isolate_control()->solo_isolated() || !(*i)->can_solo()) {
3880 /* route does not get solo propagated to it */
3884 if ((group_already_accounted_for && (*i)->route_group() && (*i)->route_group() == rg)) {
3885 /* this route is a part of the same solo group as the route
3886 * that was changed. Changing that route did change or will
3887 * change all group members appropriately, so we can ignore it
3893 in_signal_flow = false;
3895 DEBUG_TRACE (DEBUG::Solo, string_compose ("check feed from %1\n", (*i)->name()));
3897 if ((*i)->feeds (route, &via_sends_only)) {
3898 DEBUG_TRACE (DEBUG::Solo, string_compose ("\tthere is a feed from %1\n", (*i)->name()));
3899 if (!via_sends_only) {
3900 if (!route->soloed_by_others_upstream()) {
3901 (*i)->solo_control()->mod_solo_by_others_downstream (delta);
3903 DEBUG_TRACE (DEBUG::Solo, "\talready soloed by others upstream\n");
3906 DEBUG_TRACE (DEBUG::Solo, string_compose ("\tthere is a send-only feed from %1\n", (*i)->name()));
3908 in_signal_flow = true;
3910 DEBUG_TRACE (DEBUG::Solo, string_compose ("\tno feed from %1\n", (*i)->name()));
3913 DEBUG_TRACE (DEBUG::Solo, string_compose ("check feed to %1\n", (*i)->name()));
3915 if (route->feeds (*i, &via_sends_only)) {
3916 /* propagate solo upstream only if routing other than
3917 sends is involved, but do consider the other route
3918 (*i) to be part of the signal flow even if only
3921 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1 feeds %2 via sends only %3 sboD %4 sboU %5\n",
3925 route->soloed_by_others_downstream(),
3926 route->soloed_by_others_upstream()));
3927 if (!via_sends_only) {
3928 //NB. Triggers Invert Push, which handles soloed by downstream
3929 DEBUG_TRACE (DEBUG::Solo, string_compose ("\tmod %1 by %2\n", (*i)->name(), delta));
3930 (*i)->solo_control()->mod_solo_by_others_upstream (delta);
3932 DEBUG_TRACE (DEBUG::Solo, string_compose ("\tfeed to %1 ignored, sends-only\n", (*i)->name()));
3934 in_signal_flow = true;
3936 DEBUG_TRACE (DEBUG::Solo, "\tno feed to\n");
3939 if (!in_signal_flow) {
3940 uninvolved.push_back (*i);
3944 DEBUG_TRACE (DEBUG::Solo, "propagation complete\n");
3946 update_route_solo_state (r);
3948 /* now notify that the mute state of the routes not involved in the signal
3949 pathway of the just-solo-changed route may have altered.
3952 for (RouteList::iterator i = uninvolved.begin(); i != uninvolved.end(); ++i) {
3953 DEBUG_TRACE (DEBUG::Solo, string_compose ("mute change for %1, which neither feeds or is fed by %2\n", (*i)->name(), route->name()));
3954 (*i)->act_on_mute ();
3955 (*i)->mute_control()->Changed (false, Controllable::NoGroup);
3958 SoloChanged (); /* EMIT SIGNAL */
3963 Session::update_route_solo_state (boost::shared_ptr<RouteList> r)
3965 /* now figure out if anything that matters is soloed (or is "listening")*/
3967 bool something_soloed = false;
3968 bool something_listening = false;
3969 uint32_t listeners = 0;
3970 uint32_t isolated = 0;
3973 r = routes.reader();
3976 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3977 if ((*i)->can_solo()) {
3978 if (Config->get_solo_control_is_listen_control()) {
3979 if ((*i)->self_soloed() || (*i)->solo_control()->get_masters_value()) {
3981 something_listening = true;
3984 (*i)->set_listen (false);
3985 if ((*i)->can_solo() && ((*i)->self_soloed() || (*i)->solo_control()->get_masters_value())) {
3986 something_soloed = true;
3991 if ((*i)->solo_isolate_control()->solo_isolated()) {
3996 if (something_soloed != _non_soloed_outs_muted) {
3997 _non_soloed_outs_muted = something_soloed;
3998 SoloActive (_non_soloed_outs_muted); /* EMIT SIGNAL */
4001 if (something_listening != _listening) {
4002 _listening = something_listening;
4003 SoloActive (_listening);
4006 _listen_cnt = listeners;
4008 if (isolated != _solo_isolated_cnt) {
4009 _solo_isolated_cnt = isolated;
4010 IsolatedChanged (); /* EMIT SIGNAL */
4013 DEBUG_TRACE (DEBUG::Solo, string_compose ("solo state updated by session, soloed? %1 listeners %2 isolated %3\n",
4014 something_soloed, listeners, isolated));
4018 Session::get_stripables (StripableList& sl) const
4020 boost::shared_ptr<RouteList> r = routes.reader ();
4021 sl.insert (sl.end(), r->begin(), r->end());
4023 VCAList v = _vca_manager->vcas ();
4024 sl.insert (sl.end(), v.begin(), v.end());
4027 boost::shared_ptr<RouteList>
4028 Session::get_routes_with_internal_returns() const
4030 boost::shared_ptr<RouteList> r = routes.reader ();
4031 boost::shared_ptr<RouteList> rl (new RouteList);
4033 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4034 if ((*i)->internal_return ()) {
4042 Session::io_name_is_legal (const std::string& name) const
4044 boost::shared_ptr<RouteList> r = routes.reader ();
4046 for (vector<string>::const_iterator reserved = reserved_io_names.begin(); reserved != reserved_io_names.end(); ++reserved) {
4047 if (name == *reserved) {
4048 if (!route_by_name (*reserved)) {
4049 /* first instance of a reserved name is allowed */
4052 /* all other instances of a reserved name are not allowed */
4057 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4058 if ((*i)->name() == name) {
4062 if ((*i)->has_io_processor_named (name)) {
4071 Session::set_exclusive_input_active (boost::shared_ptr<RouteList> rl, bool onoff, bool flip_others)
4074 vector<string> connections;
4076 /* if we are passed only a single route and we're not told to turn
4077 * others off, then just do the simple thing.
4080 if (flip_others == false && rl->size() == 1) {
4081 boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (rl->front());
4083 mt->set_input_active (onoff);
4088 for (RouteList::iterator rt = rl->begin(); rt != rl->end(); ++rt) {
4090 PortSet& ps ((*rt)->input()->ports());
4092 for (PortSet::iterator p = ps.begin(); p != ps.end(); ++p) {
4093 p->get_connections (connections);
4096 for (vector<string>::iterator s = connections.begin(); s != connections.end(); ++s) {
4097 routes_using_input_from (*s, rl2);
4100 /* scan all relevant routes to see if others are on or off */
4102 bool others_are_already_on = false;
4104 for (RouteList::iterator r = rl2.begin(); r != rl2.end(); ++r) {
4106 boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (*r);
4112 if ((*r) != (*rt)) {
4113 if (mt->input_active()) {
4114 others_are_already_on = true;
4117 /* this one needs changing */
4118 mt->set_input_active (onoff);
4124 /* globally reverse other routes */
4126 for (RouteList::iterator r = rl2.begin(); r != rl2.end(); ++r) {
4127 if ((*r) != (*rt)) {
4128 boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (*r);
4130 mt->set_input_active (!others_are_already_on);
4139 Session::routes_using_input_from (const string& str, RouteList& rl)
4141 boost::shared_ptr<RouteList> r = routes.reader();
4143 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4144 if ((*i)->input()->connected_to (str)) {
4150 boost::shared_ptr<Route>
4151 Session::route_by_name (string name) const
4153 boost::shared_ptr<RouteList> r = routes.reader ();
4155 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4156 if ((*i)->name() == name) {
4161 return boost::shared_ptr<Route> ((Route*) 0);
4164 boost::shared_ptr<Route>
4165 Session::route_by_id (PBD::ID id) const
4167 boost::shared_ptr<RouteList> r = routes.reader ();
4169 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4170 if ((*i)->id() == id) {
4175 return boost::shared_ptr<Route> ((Route*) 0);
4178 boost::shared_ptr<Processor>
4179 Session::processor_by_id (PBD::ID id) const
4181 boost::shared_ptr<RouteList> r = routes.reader ();
4183 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4184 boost::shared_ptr<Processor> p = (*i)->Route::processor_by_id (id);
4190 return boost::shared_ptr<Processor> ();
4193 boost::shared_ptr<Track>
4194 Session::track_by_diskstream_id (PBD::ID id) const
4196 boost::shared_ptr<RouteList> r = routes.reader ();
4198 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4199 boost::shared_ptr<Track> t = boost::dynamic_pointer_cast<Track> (*i);
4200 if (t && t->using_diskstream_id (id)) {
4205 return boost::shared_ptr<Track> ();
4208 boost::shared_ptr<Route>
4209 Session::get_remote_nth_route (uint16_t n) const
4211 return boost::dynamic_pointer_cast<Route> (get_remote_nth_stripable (n, PresentationInfo::Route));
4214 boost::shared_ptr<Stripable>
4215 Session::get_remote_nth_stripable (uint16_t n, PresentationInfo::Flag flags) const
4217 boost::shared_ptr<RouteList> r = routes.reader ();
4218 vector<boost::shared_ptr<Route> > v;
4220 if (n >= r->size()) {
4221 return boost::shared_ptr<Route> ();
4224 v.assign (r->size(), boost::shared_ptr<Route>());
4226 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4227 if ((*i)->presentation_info().flag_match (flags)) {
4228 v[(*i)->presentation_info().group_order()] = (*i);
4235 boost::shared_ptr<Route>
4236 Session::route_by_selected_count (uint32_t id) const
4238 boost::shared_ptr<RouteList> r = routes.reader ();
4240 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4241 /* NOT IMPLEMENTED */
4244 return boost::shared_ptr<Route> ((Route*) 0);
4247 struct PresentationOrderSorter {
4248 bool operator() (boost::shared_ptr<Stripable> a, boost::shared_ptr<Stripable> b) {
4249 if (a->presentation_info().special() && !b->presentation_info().special()) {
4250 /* a is not ordered, b is; b comes before a */
4252 } else if (b->presentation_info().unordered() && !a->presentation_info().unordered()) {
4253 /* b is not ordered, a is; a comes before b */
4256 return a->presentation_info().global_order() < b->presentation_info().global_order();
4262 Session::reassign_track_numbers ()
4266 RouteList r (*(routes.reader ()));
4267 PresentationOrderSorter sorter;
4270 StateProtector sp (this);
4272 for (RouteList::iterator i = r.begin(); i != r.end(); ++i) {
4273 if (boost::dynamic_pointer_cast<Track> (*i)) {
4274 (*i)->set_track_number(++tn);
4276 else if (!(*i)->is_master() && !(*i)->is_monitor() && !(*i)->is_auditioner()) {
4277 (*i)->set_track_number(--bn);
4280 const uint32_t decimals = ceilf (log10f (tn + 1));
4281 const bool decimals_changed = _track_number_decimals != decimals;
4282 _track_number_decimals = decimals;
4284 if (decimals_changed && config.get_track_name_number ()) {
4285 for (RouteList::iterator i = r.begin(); i != r.end(); ++i) {
4286 boost::shared_ptr<Track> t = boost::dynamic_pointer_cast<Track> (*i);
4288 t->resync_track_name();
4291 // trigger GUI re-layout
4292 config.ParameterChanged("track-name-number");
4297 Session::playlist_region_added (boost::weak_ptr<Region> w)
4299 boost::shared_ptr<Region> r = w.lock ();
4304 /* These are the operations that are currently in progress... */
4305 list<GQuark> curr = _current_trans_quarks;
4308 /* ...and these are the operations during which we want to update
4309 the session range location markers.
4312 ops.push_back (Operations::capture);
4313 ops.push_back (Operations::paste);
4314 ops.push_back (Operations::duplicate_region);
4315 ops.push_back (Operations::insert_file);
4316 ops.push_back (Operations::insert_region);
4317 ops.push_back (Operations::drag_region_brush);
4318 ops.push_back (Operations::region_drag);
4319 ops.push_back (Operations::selection_grab);
4320 ops.push_back (Operations::region_fill);
4321 ops.push_back (Operations::fill_selection);
4322 ops.push_back (Operations::create_region);
4323 ops.push_back (Operations::region_copy);
4324 ops.push_back (Operations::fixed_time_region_copy);
4327 /* See if any of the current operations match the ones that we want */
4329 set_intersection (_current_trans_quarks.begin(), _current_trans_quarks.end(), ops.begin(), ops.end(), back_inserter (in));
4331 /* If so, update the session range markers */
4333 maybe_update_session_range (r->position (), r->last_frame ());
4337 /** Update the session range markers if a is before the current start or
4338 * b is after the current end.
4341 Session::maybe_update_session_range (framepos_t a, framepos_t b)
4343 if (_state_of_the_state & Loading) {
4347 framepos_t session_end_marker_shift_samples = session_end_shift * _nominal_frame_rate;
4349 if (_session_range_location == 0) {
4351 set_session_range_location (a, b + session_end_marker_shift_samples);
4355 if (a < _session_range_location->start()) {
4356 _session_range_location->set_start (a);
4359 if (b > _session_range_location->end()) {
4360 _session_range_location->set_end (b);
4366 Session::playlist_ranges_moved (list<Evoral::RangeMove<framepos_t> > const & ranges)
4368 for (list<Evoral::RangeMove<framepos_t> >::const_iterator i = ranges.begin(); i != ranges.end(); ++i) {
4369 maybe_update_session_range (i->to, i->to + i->length);
4374 Session::playlist_regions_extended (list<Evoral::Range<framepos_t> > const & ranges)
4376 for (list<Evoral::Range<framepos_t> >::const_iterator i = ranges.begin(); i != ranges.end(); ++i) {
4377 maybe_update_session_range (i->from, i->to);
4381 /* Region management */
4383 boost::shared_ptr<Region>
4384 Session::find_whole_file_parent (boost::shared_ptr<Region const> child) const
4386 const RegionFactory::RegionMap& regions (RegionFactory::regions());
4387 RegionFactory::RegionMap::const_iterator i;
4388 boost::shared_ptr<Region> region;
4390 Glib::Threads::Mutex::Lock lm (region_lock);
4392 for (i = regions.begin(); i != regions.end(); ++i) {
4396 if (region->whole_file()) {
4398 if (child->source_equivalent (region)) {
4404 return boost::shared_ptr<Region> ();
4408 Session::destroy_sources (list<boost::shared_ptr<Source> > srcs)
4410 set<boost::shared_ptr<Region> > relevant_regions;
4412 for (list<boost::shared_ptr<Source> >::iterator s = srcs.begin(); s != srcs.end(); ++s) {
4413 RegionFactory::get_regions_using_source (*s, relevant_regions);
4416 for (set<boost::shared_ptr<Region> >::iterator r = relevant_regions.begin(); r != relevant_regions.end(); ) {
4417 set<boost::shared_ptr<Region> >::iterator tmp;
4422 playlists->destroy_region (*r);
4423 RegionFactory::map_remove (*r);
4425 (*r)->drop_sources ();
4426 (*r)->drop_references ();
4428 relevant_regions.erase (r);
4433 for (list<boost::shared_ptr<Source> >::iterator s = srcs.begin(); s != srcs.end(); ) {
4436 Glib::Threads::Mutex::Lock ls (source_lock);
4437 /* remove from the main source list */
4438 sources.erase ((*s)->id());
4441 (*s)->mark_for_remove ();
4442 (*s)->drop_references ();
4451 Session::remove_last_capture ()
4453 list<boost::shared_ptr<Source> > srcs;
4455 boost::shared_ptr<RouteList> rl = routes.reader ();
4456 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
4457 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
4462 list<boost::shared_ptr<Source> >& l = tr->last_capture_sources();
4465 srcs.insert (srcs.end(), l.begin(), l.end());
4470 destroy_sources (srcs);
4472 save_state (_current_snapshot_name);
4477 /* Source Management */
4480 Session::add_source (boost::shared_ptr<Source> source)
4482 pair<SourceMap::key_type, SourceMap::mapped_type> entry;
4483 pair<SourceMap::iterator,bool> result;
4485 entry.first = source->id();
4486 entry.second = source;
4489 Glib::Threads::Mutex::Lock lm (source_lock);
4490 result = sources.insert (entry);
4493 if (result.second) {
4495 /* yay, new source */
4497 boost::shared_ptr<FileSource> fs = boost::dynamic_pointer_cast<FileSource> (source);
4500 if (!fs->within_session()) {
4501 ensure_search_path_includes (Glib::path_get_dirname (fs->path()), fs->type());
4507 boost::shared_ptr<AudioFileSource> afs;
4509 if ((afs = boost::dynamic_pointer_cast<AudioFileSource>(source)) != 0) {
4510 if (Config->get_auto_analyse_audio()) {
4511 Analyser::queue_source_for_analysis (source, false);
4515 source->DropReferences.connect_same_thread (*this, boost::bind (&Session::remove_source, this, boost::weak_ptr<Source> (source)));
4520 Session::remove_source (boost::weak_ptr<Source> src)
4522 if (_state_of_the_state & Deletion) {
4526 SourceMap::iterator i;
4527 boost::shared_ptr<Source> source = src.lock();
4534 Glib::Threads::Mutex::Lock lm (source_lock);
4536 if ((i = sources.find (source->id())) != sources.end()) {
4541 if (!(_state_of_the_state & StateOfTheState (InCleanup|Loading))) {
4543 /* save state so we don't end up with a session file
4544 referring to non-existent sources.
4547 save_state (_current_snapshot_name);
4551 boost::shared_ptr<Source>
4552 Session::source_by_id (const PBD::ID& id)
4554 Glib::Threads::Mutex::Lock lm (source_lock);
4555 SourceMap::iterator i;
4556 boost::shared_ptr<Source> source;
4558 if ((i = sources.find (id)) != sources.end()) {
4565 boost::shared_ptr<AudioFileSource>
4566 Session::audio_source_by_path_and_channel (const string& path, uint16_t chn) const
4568 /* Restricted to audio files because only audio sources have channel
4572 Glib::Threads::Mutex::Lock lm (source_lock);
4574 for (SourceMap::const_iterator i = sources.begin(); i != sources.end(); ++i) {
4575 boost::shared_ptr<AudioFileSource> afs
4576 = boost::dynamic_pointer_cast<AudioFileSource>(i->second);
4578 if (afs && afs->path() == path && chn == afs->channel()) {
4583 return boost::shared_ptr<AudioFileSource>();
4586 boost::shared_ptr<MidiSource>
4587 Session::midi_source_by_path (const std::string& path) const
4589 /* Restricted to MIDI files because audio sources require a channel
4590 for unique identification, in addition to a path.
4593 Glib::Threads::Mutex::Lock lm (source_lock);
4595 for (SourceMap::const_iterator s = sources.begin(); s != sources.end(); ++s) {
4596 boost::shared_ptr<MidiSource> ms
4597 = boost::dynamic_pointer_cast<MidiSource>(s->second);
4598 boost::shared_ptr<FileSource> fs
4599 = boost::dynamic_pointer_cast<FileSource>(s->second);
4601 if (ms && fs && fs->path() == path) {
4606 return boost::shared_ptr<MidiSource>();
4610 Session::count_sources_by_origin (const string& path)
4613 Glib::Threads::Mutex::Lock lm (source_lock);
4615 for (SourceMap::iterator i = sources.begin(); i != sources.end(); ++i) {
4616 boost::shared_ptr<FileSource> fs
4617 = boost::dynamic_pointer_cast<FileSource>(i->second);
4619 if (fs && fs->origin() == path) {
4628 peak_file_helper (const string& peak_path, const string& file_path, const string& file_base, bool hash) {
4630 std::string checksum = Glib::Checksum::compute_checksum(Glib::Checksum::CHECKSUM_SHA1, file_path + G_DIR_SEPARATOR + file_base);
4631 return Glib::build_filename (peak_path, checksum + peakfile_suffix);
4633 return Glib::build_filename (peak_path, file_base + peakfile_suffix);
4638 Session::construct_peak_filepath (const string& filepath, const bool in_session, const bool old_peak_name) const
4640 string interchange_dir_string = string (interchange_dir_name) + G_DIR_SEPARATOR;
4642 if (Glib::path_is_absolute (filepath)) {
4644 /* rip the session dir from the audiofile source */
4646 string session_path;
4647 bool in_another_session = true;
4649 if (filepath.find (interchange_dir_string) != string::npos) {
4651 session_path = Glib::path_get_dirname (filepath); /* now ends in audiofiles */
4652 session_path = Glib::path_get_dirname (session_path); /* now ends in session name */
4653 session_path = Glib::path_get_dirname (session_path); /* now ends in interchange */
4654 session_path = Glib::path_get_dirname (session_path); /* now has session path */
4656 /* see if it is within our session */
4658 for (vector<space_and_path>::const_iterator i = session_dirs.begin(); i != session_dirs.end(); ++i) {
4659 if (i->path == session_path) {
4660 in_another_session = false;
4665 in_another_session = false;
4669 if (in_another_session) {
4670 SessionDirectory sd (session_path);
4671 return peak_file_helper (sd.peak_path(), "", Glib::path_get_basename (filepath), !old_peak_name);
4675 /* 1) if file belongs to this session
4676 * it may be a relative path (interchange/...)
4677 * or just basename (session_state, remove source)
4678 * -> just use the basename
4680 std::string filename = Glib::path_get_basename (filepath);
4683 /* 2) if the file is outside our session dir:
4684 * (imported but not copied) add the path for check-summming */
4686 path = Glib::path_get_dirname (filepath);
4689 return peak_file_helper (_session_dir->peak_path(), path, Glib::path_get_basename (filepath), !old_peak_name);
4693 Session::new_audio_source_path_for_embedded (const std::string& path)
4697 * we know that the filename is already unique because it exists
4698 * out in the filesystem.
4700 * However, when we bring it into the session, we could get a
4703 * Eg. two embedded files:
4708 * When merged into session, these collide.
4710 * There will not be a conflict with in-memory sources
4711 * because when the source was created we already picked
4712 * a unique name for it.
4714 * This collision is not likely to be common, but we have to guard
4715 * against it. So, if there is a collision, take the md5 hash of the
4716 * the path, and use that as the filename instead.
4719 SessionDirectory sdir (get_best_session_directory_for_new_audio());
4720 string base = Glib::path_get_basename (path);
4721 string newpath = Glib::build_filename (sdir.sound_path(), base);
4723 if (Glib::file_test (newpath, Glib::FILE_TEST_EXISTS)) {
4727 md5.digestString (path.c_str());
4728 md5.writeToString ();
4729 base = md5.digestChars;
4731 string ext = get_suffix (path);
4738 newpath = Glib::build_filename (sdir.sound_path(), base);
4740 /* if this collides, we're screwed */
4742 if (Glib::file_test (newpath, Glib::FILE_TEST_EXISTS)) {
4743 error << string_compose (_("Merging embedded file %1: name collision AND md5 hash collision!"), path) << endmsg;
4752 /** Return true if there are no audio file sources that use @param name as
4753 * the filename component of their path.
4755 * Return false otherwise.
4757 * This method MUST ONLY be used to check in-session, mono files since it
4758 * hard-codes the channel of the audio file source we are looking for as zero.
4760 * If/when Ardour supports native files in non-mono formats, the logic here
4761 * will need to be revisited.
4764 Session::audio_source_name_is_unique (const string& name)
4766 std::vector<string> sdirs = source_search_path (DataType::AUDIO);
4767 vector<space_and_path>::iterator i;
4768 uint32_t existing = 0;
4770 for (vector<string>::const_iterator i = sdirs.begin(); i != sdirs.end(); ++i) {
4772 /* note that we search *without* the extension so that
4773 we don't end up both "Audio 1-1.wav" and "Audio 1-1.caf"
4774 in the event that this new name is required for
4775 a file format change.
4778 const string spath = *i;
4780 if (matching_unsuffixed_filename_exists_in (spath, name)) {
4785 /* it is possible that we have the path already
4786 * assigned to a source that has not yet been written
4787 * (ie. the write source for a diskstream). we have to
4788 * check this in order to make sure that our candidate
4789 * path isn't used again, because that can lead to
4790 * two Sources point to the same file with different
4791 * notions of their removability.
4795 string possible_path = Glib::build_filename (spath, name);
4797 if (audio_source_by_path_and_channel (possible_path, 0)) {
4803 return (existing == 0);
4807 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)
4810 const string ext = native_header_format_extension (config.get_native_file_header_format(), DataType::AUDIO);
4812 if (Profile->get_trx() && destructive) {
4814 sstr << setfill ('0') << setw (4) << cnt;
4815 sstr << legalized_base;
4817 sstr << legalized_base;
4819 if (take_required || related_exists) {
4831 } else if (nchan > 2) {
4836 /* XXX what? more than 26 channels! */
4847 /** Return a unique name based on \a base for a new internal audio source */
4849 Session::new_audio_source_path (const string& base, uint32_t nchan, uint32_t chan, bool destructive, bool take_required)
4852 string possible_name;
4853 const uint32_t limit = 9999; // arbitrary limit on number of files with the same basic name
4855 bool some_related_source_name_exists = false;
4857 legalized = legalize_for_path (base);
4859 // Find a "version" of the base name that doesn't exist in any of the possible directories.
4861 for (cnt = (destructive ? ++destructive_index : 1); cnt <= limit; ++cnt) {
4863 possible_name = format_audio_source_name (legalized, nchan, chan, destructive, take_required, cnt, some_related_source_name_exists);
4865 if (audio_source_name_is_unique (possible_name)) {
4869 some_related_source_name_exists = true;
4872 error << string_compose(
4873 _("There are already %1 recordings for %2, which I consider too many."),
4874 limit, base) << endmsg;
4876 throw failed_constructor();
4880 /* We've established that the new name does not exist in any session
4881 * directory, so now find out which one we should use for this new
4885 SessionDirectory sdir (get_best_session_directory_for_new_audio());
4887 std::string s = Glib::build_filename (sdir.sound_path(), possible_name);
4892 /** Return a unique name based on `base` for a new internal MIDI source */
4894 Session::new_midi_source_path (const string& base)
4897 char buf[PATH_MAX+1];
4898 const uint32_t limit = 10000;
4900 string possible_path;
4901 string possible_name;
4904 legalized = legalize_for_path (base);
4906 // Find a "version" of the file name that doesn't exist in any of the possible directories.
4907 std::vector<string> sdirs = source_search_path(DataType::MIDI);
4909 /* - the main session folder is the first in the vector.
4910 * - after checking all locations for file-name uniqueness,
4911 * we keep the one from the last iteration as new file name
4912 * - midi files are small and should just be kept in the main session-folder
4914 * -> reverse the array, check main session folder last and use that as location
4917 std::reverse(sdirs.begin(), sdirs.end());
4919 for (cnt = 1; cnt <= limit; ++cnt) {
4921 vector<space_and_path>::iterator i;
4922 uint32_t existing = 0;
4924 for (vector<string>::const_iterator i = sdirs.begin(); i != sdirs.end(); ++i) {
4926 snprintf (buf, sizeof(buf), "%s-%u.mid", legalized.c_str(), cnt);
4927 possible_name = buf;
4929 possible_path = Glib::build_filename (*i, possible_name);
4931 if (Glib::file_test (possible_path, Glib::FILE_TEST_EXISTS)) {
4935 if (midi_source_by_path (possible_path)) {
4940 if (existing == 0) {
4945 error << string_compose(
4946 _("There are already %1 recordings for %2, which I consider too many."),
4947 limit, base) << endmsg;
4953 /* No need to "find best location" for software/app-based RAID, because
4954 MIDI is so small that we always put it in the same place.
4957 return possible_path;
4961 /** Create a new within-session audio source */
4962 boost::shared_ptr<AudioFileSource>
4963 Session::create_audio_source_for_session (size_t n_chans, string const & base, uint32_t chan, bool destructive)
4965 const string path = new_audio_source_path (base, n_chans, chan, destructive, true);
4967 if (!path.empty()) {
4968 return boost::dynamic_pointer_cast<AudioFileSource> (
4969 SourceFactory::createWritable (DataType::AUDIO, *this, path, destructive, frame_rate(), true, true));
4971 throw failed_constructor ();
4975 /** Create a new within-session MIDI source */
4976 boost::shared_ptr<MidiSource>
4977 Session::create_midi_source_for_session (string const & basic_name)
4979 const string path = new_midi_source_path (basic_name);
4981 if (!path.empty()) {
4982 return boost::dynamic_pointer_cast<SMFSource> (
4983 SourceFactory::createWritable (
4984 DataType::MIDI, *this, path, false, frame_rate()));
4986 throw failed_constructor ();
4990 /** Create a new within-session MIDI source */
4991 boost::shared_ptr<MidiSource>
4992 Session::create_midi_source_by_stealing_name (boost::shared_ptr<Track> track)
4994 /* the caller passes in the track the source will be used in,
4995 so that we can keep the numbering sane.
4997 Rationale: a track with the name "Foo" that has had N
4998 captures carried out so far will ALREADY have a write source
4999 named "Foo-N+1.mid" waiting to be used for the next capture.
5001 If we call new_midi_source_name() we will get "Foo-N+2". But
5002 there is no region corresponding to "Foo-N+1", so when
5003 "Foo-N+2" appears in the track, the gap presents the user
5004 with odd behaviour - why did it skip past Foo-N+1?
5006 We could explain this to the user in some odd way, but
5007 instead we rename "Foo-N+1.mid" as "Foo-N+2.mid", and then
5010 If that attempted rename fails, we get "Foo-N+2.mid" anyway.
5013 boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (track);
5015 std::string name = track->steal_write_source_name ();
5018 return boost::shared_ptr<MidiSource>();
5021 /* MIDI files are small, just put them in the first location of the
5022 session source search path.
5025 const string path = Glib::build_filename (source_search_path (DataType::MIDI).front(), name);
5027 return boost::dynamic_pointer_cast<SMFSource> (
5028 SourceFactory::createWritable (
5029 DataType::MIDI, *this, path, false, frame_rate()));
5034 Session::add_playlist (boost::shared_ptr<Playlist> playlist, bool unused)
5036 if (playlist->hidden()) {
5040 playlists->add (playlist);
5043 playlist->release();
5050 Session::remove_playlist (boost::weak_ptr<Playlist> weak_playlist)
5052 if (_state_of_the_state & Deletion) {
5056 boost::shared_ptr<Playlist> playlist (weak_playlist.lock());
5062 playlists->remove (playlist);
5068 Session::set_audition (boost::shared_ptr<Region> r)
5070 pending_audition_region = r;
5071 add_post_transport_work (PostTransportAudition);
5072 _butler->schedule_transport_work ();
5076 Session::audition_playlist ()
5078 SessionEvent* ev = new SessionEvent (SessionEvent::Audition, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
5079 ev->region.reset ();
5085 Session::register_lua_function (
5086 const std::string& name,
5087 const std::string& script,
5088 const LuaScriptParamList& args
5091 Glib::Threads::Mutex::Lock lm (lua_lock);
5093 lua_State* L = lua.getState();
5095 const std::string& bytecode = LuaScripting::get_factory_bytecode (script);
5096 luabridge::LuaRef tbl_arg (luabridge::newTable(L));
5097 for (LuaScriptParamList::const_iterator i = args.begin(); i != args.end(); ++i) {
5098 if ((*i)->optional && !(*i)->is_set) { continue; }
5099 tbl_arg[(*i)->name] = (*i)->value;
5101 (*_lua_add)(name, bytecode, tbl_arg); // throws luabridge::LuaException
5106 Session::unregister_lua_function (const std::string& name)
5108 Glib::Threads::Mutex::Lock lm (lua_lock);
5109 (*_lua_del)(name); // throws luabridge::LuaException
5110 lua.collect_garbage ();
5114 std::vector<std::string>
5115 Session::registered_lua_functions ()
5117 Glib::Threads::Mutex::Lock lm (lua_lock);
5118 std::vector<std::string> rv;
5121 luabridge::LuaRef list ((*_lua_list)());
5122 for (luabridge::Iterator i (list); !i.isNil (); ++i) {
5123 if (!i.key ().isString ()) { assert(0); continue; }
5124 rv.push_back (i.key ().cast<std::string> ());
5126 } catch (luabridge::LuaException const& e) { }
5131 static void _lua_print (std::string s) {
5132 std::cout << "SessionLua: " << s << "\n";
5137 Session::try_run_lua (pframes_t nframes)
5139 if (_n_lua_scripts == 0) return;
5140 Glib::Threads::Mutex::Lock tm (lua_lock, Glib::Threads::TRY_LOCK);
5142 try { (*_lua_run)(nframes); } catch (luabridge::LuaException const& e) { }
5147 Session::setup_lua ()
5150 lua.Print.connect (&_lua_print);
5153 "function ArdourSession ()"
5154 " local self = { scripts = {}, instances = {} }"
5156 " local remove = function (n)"
5157 " self.scripts[n] = nil"
5158 " self.instances[n] = nil"
5159 " Session:scripts_changed()" // call back
5162 " local addinternal = function (n, f, a)"
5163 " assert(type(n) == 'string', 'function-name must be string')"
5164 " assert(type(f) == 'function', 'Given script is a not a function')"
5165 " assert(type(a) == 'table' or type(a) == 'nil', 'Given argument is invalid')"
5166 " assert(self.scripts[n] == nil, 'Callback \"'.. n ..'\" already exists.')"
5167 " self.scripts[n] = { ['f'] = f, ['a'] = a }"
5168 " 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"
5169 " 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 }"
5170 " self.instances[n] = load (string.dump(f, true), nil, nil, env)(a)"
5171 " Session:scripts_changed()" // call back
5174 " local add = function (n, b, a)"
5175 " assert(type(b) == 'string', 'ByteCode must be string')"
5176 " load (b)()" // assigns f
5177 " assert(type(f) == 'string', 'Assigned ByteCode must be string')"
5178 " addinternal (n, load(f), a)"
5181 " local run = function (...)"
5182 " for n, s in pairs (self.instances) do"
5183 " local status, err = pcall (s, ...)"
5184 " if not status then"
5185 " print ('fn \"'.. n .. '\": ', err)"
5192 " local cleanup = function ()"
5193 " self.scripts = nil"
5194 " self.instances = nil"
5197 " local list = function ()"
5199 " for n, _ in pairs (self.scripts) do"
5205 " local function basic_serialize (o)"
5206 " if type(o) == \"number\" then"
5207 " return tostring(o)"
5209 " return string.format(\"%q\", o)"
5213 " local function serialize (name, value)"
5214 " local rv = name .. ' = '"
5216 " if type(value) == \"number\" or type(value) == \"string\" or type(value) == \"nil\" then"
5217 " return rv .. basic_serialize(value) .. ' '"
5218 " elseif type(value) == \"table\" then"
5220 " for k,v in pairs(value) do"
5221 " local fieldname = string.format(\"%s[%s]\", name, basic_serialize(k))"
5222 " rv = rv .. serialize(fieldname, v) .. ' '"
5223 " collectgarbage()" // string concatenation allocates a new string :(
5226 " elseif type(value) == \"function\" then"
5227 " return rv .. string.format(\"%q\", string.dump(value, true))"
5229 " error('cannot save a ' .. type(value))"
5234 " local save = function ()"
5235 " return (serialize('scripts', self.scripts))"
5238 " local restore = function (state)"
5239 " self.scripts = {}"
5241 " for n, s in pairs (scripts) do"
5242 " addinternal (n, load(s['f']), s['a'])"
5246 " return { run = run, add = add, remove = remove,"
5247 " list = list, restore = restore, save = save, cleanup = cleanup}"
5250 " sess = ArdourSession ()"
5251 " ArdourSession = nil"
5253 "function ardour () end"
5256 lua_State* L = lua.getState();
5259 luabridge::LuaRef lua_sess = luabridge::getGlobal (L, "sess");
5260 lua.do_command ("sess = nil"); // hide it.
5261 lua.do_command ("collectgarbage()");
5263 _lua_run = new luabridge::LuaRef(lua_sess["run"]);
5264 _lua_add = new luabridge::LuaRef(lua_sess["add"]);
5265 _lua_del = new luabridge::LuaRef(lua_sess["remove"]);
5266 _lua_list = new luabridge::LuaRef(lua_sess["list"]);
5267 _lua_save = new luabridge::LuaRef(lua_sess["save"]);
5268 _lua_load = new luabridge::LuaRef(lua_sess["restore"]);
5269 _lua_cleanup = new luabridge::LuaRef(lua_sess["cleanup"]);
5270 } catch (luabridge::LuaException const& e) {
5271 fatal << string_compose (_("programming error: %1"),
5272 X_("Failed to setup Lua interpreter"))
5274 abort(); /*NOTREACHED*/
5277 LuaBindings::stddef (L);
5278 LuaBindings::common (L);
5279 LuaBindings::dsp (L);
5280 luabridge::push <Session *> (L, this);
5281 lua_setglobal (L, "Session");
5285 Session::scripts_changed ()
5287 assert (!lua_lock.trylock()); // must hold lua_lock
5290 luabridge::LuaRef list ((*_lua_list)());
5292 for (luabridge::Iterator i (list); !i.isNil (); ++i) {
5293 if (!i.key ().isString ()) { assert(0); continue; }
5296 _n_lua_scripts = cnt;
5297 } catch (luabridge::LuaException const& e) {
5298 fatal << string_compose (_("programming error: %1"),
5299 X_("Indexing Lua Session Scripts failed."))
5301 abort(); /*NOTREACHED*/
5306 Session::non_realtime_set_audition ()
5308 assert (pending_audition_region);
5309 auditioner->audition_region (pending_audition_region);
5310 pending_audition_region.reset ();
5311 AuditionActive (true); /* EMIT SIGNAL */
5315 Session::audition_region (boost::shared_ptr<Region> r)
5317 SessionEvent* ev = new SessionEvent (SessionEvent::Audition, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
5323 Session::cancel_audition ()
5328 if (auditioner->auditioning()) {
5329 auditioner->cancel_audition ();
5330 AuditionActive (false); /* EMIT SIGNAL */
5335 Session::RoutePublicOrderSorter::operator() (boost::shared_ptr<Route> a, boost::shared_ptr<Route> b)
5337 if (a->is_monitor()) {
5340 if (b->is_monitor()) {
5343 return a->presentation_info() < b->presentation_info();
5347 Session::is_auditioning () const
5349 /* can be called before we have an auditioner object */
5351 return auditioner->auditioning();
5358 Session::graph_reordered ()
5360 /* don't do this stuff if we are setting up connections
5361 from a set_state() call or creating new tracks. Ditto for deletion.
5364 if ((_state_of_the_state & (InitialConnecting|Deletion)) || _adding_routes_in_progress || _reconnecting_routes_in_progress || _route_deletion_in_progress) {
5368 /* every track/bus asked for this to be handled but it was deferred because
5369 we were connecting. do it now.
5372 request_input_change_handling ();
5376 /* force all diskstreams to update their capture offset values to
5377 reflect any changes in latencies within the graph.
5380 boost::shared_ptr<RouteList> rl = routes.reader ();
5381 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
5382 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
5384 tr->set_capture_offset ();
5389 /** @return Number of frames that there is disk space available to write,
5392 boost::optional<framecnt_t>
5393 Session::available_capture_duration ()
5395 Glib::Threads::Mutex::Lock lm (space_lock);
5397 if (_total_free_4k_blocks_uncertain) {
5398 return boost::optional<framecnt_t> ();
5401 float sample_bytes_on_disk = 4.0; // keep gcc happy
5403 switch (config.get_native_file_data_format()) {
5405 sample_bytes_on_disk = 4.0;
5409 sample_bytes_on_disk = 3.0;
5413 sample_bytes_on_disk = 2.0;
5417 /* impossible, but keep some gcc versions happy */
5418 fatal << string_compose (_("programming error: %1"),
5419 X_("illegal native file data format"))
5421 abort(); /*NOTREACHED*/
5424 double scale = 4096.0 / sample_bytes_on_disk;
5426 if (_total_free_4k_blocks * scale > (double) max_framecnt) {
5427 return max_framecnt;
5430 return (framecnt_t) floor (_total_free_4k_blocks * scale);
5434 Session::add_bundle (boost::shared_ptr<Bundle> bundle, bool emit_signal)
5437 RCUWriter<BundleList> writer (_bundles);
5438 boost::shared_ptr<BundleList> b = writer.get_copy ();
5439 b->push_back (bundle);
5443 BundleAddedOrRemoved (); /* EMIT SIGNAL */
5450 Session::remove_bundle (boost::shared_ptr<Bundle> bundle)
5452 bool removed = false;
5455 RCUWriter<BundleList> writer (_bundles);
5456 boost::shared_ptr<BundleList> b = writer.get_copy ();
5457 BundleList::iterator i = find (b->begin(), b->end(), bundle);
5459 if (i != b->end()) {
5466 BundleAddedOrRemoved (); /* EMIT SIGNAL */
5472 boost::shared_ptr<Bundle>
5473 Session::bundle_by_name (string name) const
5475 boost::shared_ptr<BundleList> b = _bundles.reader ();
5477 for (BundleList::const_iterator i = b->begin(); i != b->end(); ++i) {
5478 if ((*i)->name() == name) {
5483 return boost::shared_ptr<Bundle> ();
5487 Session::tempo_map_changed (const PropertyChange&)
5491 playlists->update_after_tempo_map_change ();
5493 _locations->apply (*this, &Session::update_locations_after_tempo_map_change);
5499 Session::gui_tempo_map_changed ()
5503 playlists->update_after_tempo_map_change ();
5505 _locations->apply (*this, &Session::update_locations_after_tempo_map_change);
5509 Session::update_locations_after_tempo_map_change (const Locations::LocationList& loc)
5511 for (Locations::LocationList::const_iterator i = loc.begin(); i != loc.end(); ++i) {
5512 (*i)->recompute_frames_from_bbt ();
5516 /** Ensures that all buffers (scratch, send, silent, etc) are allocated for
5517 * the given count with the current block size.
5520 Session::ensure_buffers (ChanCount howmany)
5522 BufferManager::ensure_buffers (howmany, bounce_processing() ? bounce_chunk_size : 0);
5526 Session::ensure_buffer_set(BufferSet& buffers, const ChanCount& count)
5528 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
5529 buffers.ensure_buffers(*t, count.get(*t), _engine.raw_buffer_size(*t));
5534 Session::next_insert_id ()
5536 /* this doesn't really loop forever. just think about it */
5539 for (boost::dynamic_bitset<uint32_t>::size_type n = 1; n < insert_bitset.size(); ++n) {
5540 if (!insert_bitset[n]) {
5541 insert_bitset[n] = true;
5547 /* none available, so resize and try again */
5549 insert_bitset.resize (insert_bitset.size() + 16, false);
5554 Session::next_send_id ()
5556 /* this doesn't really loop forever. just think about it */
5559 for (boost::dynamic_bitset<uint32_t>::size_type n = 1; n < send_bitset.size(); ++n) {
5560 if (!send_bitset[n]) {
5561 send_bitset[n] = true;
5567 /* none available, so resize and try again */
5569 send_bitset.resize (send_bitset.size() + 16, false);
5574 Session::next_aux_send_id ()
5576 /* this doesn't really loop forever. just think about it */
5579 for (boost::dynamic_bitset<uint32_t>::size_type n = 1; n < aux_send_bitset.size(); ++n) {
5580 if (!aux_send_bitset[n]) {
5581 aux_send_bitset[n] = true;
5587 /* none available, so resize and try again */
5589 aux_send_bitset.resize (aux_send_bitset.size() + 16, false);
5594 Session::next_return_id ()
5596 /* this doesn't really loop forever. just think about it */
5599 for (boost::dynamic_bitset<uint32_t>::size_type n = 1; n < return_bitset.size(); ++n) {
5600 if (!return_bitset[n]) {
5601 return_bitset[n] = true;
5607 /* none available, so resize and try again */
5609 return_bitset.resize (return_bitset.size() + 16, false);
5614 Session::mark_send_id (uint32_t id)
5616 if (id >= send_bitset.size()) {
5617 send_bitset.resize (id+16, false);
5619 if (send_bitset[id]) {
5620 warning << string_compose (_("send ID %1 appears to be in use already"), id) << endmsg;
5622 send_bitset[id] = true;
5626 Session::mark_aux_send_id (uint32_t id)
5628 if (id >= aux_send_bitset.size()) {
5629 aux_send_bitset.resize (id+16, false);
5631 if (aux_send_bitset[id]) {
5632 warning << string_compose (_("aux send ID %1 appears to be in use already"), id) << endmsg;
5634 aux_send_bitset[id] = true;
5638 Session::mark_return_id (uint32_t id)
5640 if (id >= return_bitset.size()) {
5641 return_bitset.resize (id+16, false);
5643 if (return_bitset[id]) {
5644 warning << string_compose (_("return ID %1 appears to be in use already"), id) << endmsg;
5646 return_bitset[id] = true;
5650 Session::mark_insert_id (uint32_t id)
5652 if (id >= insert_bitset.size()) {
5653 insert_bitset.resize (id+16, false);
5655 if (insert_bitset[id]) {
5656 warning << string_compose (_("insert ID %1 appears to be in use already"), id) << endmsg;
5658 insert_bitset[id] = true;
5662 Session::unmark_send_id (uint32_t id)
5664 if (id < send_bitset.size()) {
5665 send_bitset[id] = false;
5670 Session::unmark_aux_send_id (uint32_t id)
5672 if (id < aux_send_bitset.size()) {
5673 aux_send_bitset[id] = false;
5678 Session::unmark_return_id (uint32_t id)
5680 if (_state_of_the_state & Deletion) { return; }
5681 if (id < return_bitset.size()) {
5682 return_bitset[id] = false;
5687 Session::unmark_insert_id (uint32_t id)
5689 if (id < insert_bitset.size()) {
5690 insert_bitset[id] = false;
5695 Session::reset_native_file_format ()
5697 boost::shared_ptr<RouteList> rl = routes.reader ();
5699 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
5700 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
5702 /* don't save state as we do this, there's no point
5704 _state_of_the_state = StateOfTheState (_state_of_the_state|InCleanup);
5705 tr->reset_write_sources (false);
5706 _state_of_the_state = StateOfTheState (_state_of_the_state & ~InCleanup);
5712 Session::route_name_unique (string n) const
5714 boost::shared_ptr<RouteList> r = routes.reader ();
5716 for (RouteList::const_iterator i = r->begin(); i != r->end(); ++i) {
5717 if ((*i)->name() == n) {
5726 Session::route_name_internal (string n) const
5728 if (auditioner && auditioner->name() == n) {
5732 if (_click_io && _click_io->name() == n) {
5740 Session::freeze_all (InterThreadInfo& itt)
5742 boost::shared_ptr<RouteList> r = routes.reader ();
5744 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
5746 boost::shared_ptr<Track> t;
5748 if ((t = boost::dynamic_pointer_cast<Track>(*i)) != 0) {
5749 /* XXX this is wrong because itt.progress will keep returning to zero at the start
5759 boost::shared_ptr<Region>
5760 Session::write_one_track (Track& track, framepos_t start, framepos_t end,
5761 bool /*overwrite*/, vector<boost::shared_ptr<Source> >& srcs,
5762 InterThreadInfo& itt,
5763 boost::shared_ptr<Processor> endpoint, bool include_endpoint,
5764 bool for_export, bool for_freeze)
5766 boost::shared_ptr<Region> result;
5767 boost::shared_ptr<Playlist> playlist;
5768 boost::shared_ptr<Source> source;
5769 ChanCount diskstream_channels (track.n_channels());
5770 framepos_t position;
5771 framecnt_t this_chunk;
5773 framepos_t latency_skip;
5775 framepos_t len = end - start;
5776 bool need_block_size_reset = false;
5777 ChanCount const max_proc = track.max_processor_streams ();
5778 string legal_playlist_name;
5779 string possible_path;
5782 error << string_compose (_("Cannot write a range where end <= start (e.g. %1 <= %2)"),
5783 end, start) << endmsg;
5787 diskstream_channels = track.bounce_get_output_streams (diskstream_channels, endpoint,
5788 include_endpoint, for_export, for_freeze);
5790 if (diskstream_channels.n(track.data_type()) < 1) {
5791 error << _("Cannot write a range with no data.") << endmsg;
5795 // block all process callback handling
5797 block_processing ();
5800 // synchronize with AudioEngine::process_callback()
5801 // make sure processing is not currently running
5802 // and processing_blocked() is honored before
5803 // acquiring thread buffers
5804 Glib::Threads::Mutex::Lock lm (_engine.process_lock());
5807 _bounce_processing_active = true;
5809 /* call tree *MUST* hold route_lock */
5811 if ((playlist = track.playlist()) == 0) {
5815 legal_playlist_name = legalize_for_path (playlist->name());
5817 for (uint32_t chan_n = 0; chan_n < diskstream_channels.n(track.data_type()); ++chan_n) {
5819 string base_name = string_compose ("%1-%2-bounce", playlist->name(), chan_n);
5820 string path = ((track.data_type() == DataType::AUDIO)
5821 ? new_audio_source_path (legal_playlist_name, diskstream_channels.n_audio(), chan_n, false, true)
5822 : new_midi_source_path (legal_playlist_name));
5829 source = SourceFactory::createWritable (track.data_type(), *this, path, false, frame_rate());
5832 catch (failed_constructor& err) {
5833 error << string_compose (_("cannot create new file \"%1\" for %2"), path, track.name()) << endmsg;
5837 srcs.push_back (source);
5840 /* tell redirects that care that we are about to use a much larger
5841 * blocksize. this will flush all plugins too, so that they are ready
5842 * to be used for this process.
5845 need_block_size_reset = true;
5846 track.set_block_size (bounce_chunk_size);
5847 _engine.main_thread()->get_buffers ();
5851 latency_skip = track.bounce_get_latency (endpoint, include_endpoint, for_export, for_freeze);
5853 /* create a set of reasonably-sized buffers */
5854 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
5855 buffers.ensure_buffers(*t, max_proc.get(*t), bounce_chunk_size);
5857 buffers.set_count (max_proc);
5859 for (vector<boost::shared_ptr<Source> >::iterator src = srcs.begin(); src != srcs.end(); ++src) {
5860 boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*src);
5861 boost::shared_ptr<MidiSource> ms;
5863 afs->prepare_for_peakfile_writes ();
5864 } else if ((ms = boost::dynamic_pointer_cast<MidiSource>(*src))) {
5865 Source::Lock lock(ms->mutex());
5866 ms->mark_streaming_write_started(lock);
5870 while (to_do && !itt.cancel) {
5872 this_chunk = min (to_do, bounce_chunk_size);
5874 if (track.export_stuff (buffers, start, this_chunk, endpoint, include_endpoint, for_export, for_freeze)) {
5878 start += this_chunk;
5879 to_do -= this_chunk;
5880 itt.progress = (float) (1.0 - ((double) to_do / len));
5882 if (latency_skip >= bounce_chunk_size) {
5883 latency_skip -= bounce_chunk_size;
5887 const framecnt_t current_chunk = this_chunk - latency_skip;
5890 for (vector<boost::shared_ptr<Source> >::iterator src=srcs.begin(); src != srcs.end(); ++src, ++n) {
5891 boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*src);
5892 boost::shared_ptr<MidiSource> ms;
5895 if (afs->write (buffers.get_audio(n).data(latency_skip), current_chunk) != current_chunk) {
5898 } else if ((ms = boost::dynamic_pointer_cast<MidiSource>(*src))) {
5899 Source::Lock lock(ms->mutex());
5901 const MidiBuffer& buf = buffers.get_midi(0);
5902 for (MidiBuffer::const_iterator i = buf.begin(); i != buf.end(); ++i) {
5903 Evoral::Event<framepos_t> ev = *i;
5904 ev.set_time(ev.time() - position);
5905 ms->append_event_frames(lock, ev, ms->timeline_position());
5912 /* post-roll, pick up delayed processor output */
5913 latency_skip = track.bounce_get_latency (endpoint, include_endpoint, for_export, for_freeze);
5915 while (latency_skip && !itt.cancel) {
5916 this_chunk = min (latency_skip, bounce_chunk_size);
5917 latency_skip -= this_chunk;
5919 buffers.silence (this_chunk, 0);
5920 track.bounce_process (buffers, start, this_chunk, endpoint, include_endpoint, for_export, for_freeze);
5923 for (vector<boost::shared_ptr<Source> >::iterator src=srcs.begin(); src != srcs.end(); ++src, ++n) {
5924 boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*src);
5927 if (afs->write (buffers.get_audio(n).data(), this_chunk) != this_chunk) {
5939 xnow = localtime (&now);
5941 for (vector<boost::shared_ptr<Source> >::iterator src=srcs.begin(); src != srcs.end(); ++src) {
5942 boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*src);
5943 boost::shared_ptr<MidiSource> ms;
5946 afs->update_header (position, *xnow, now);
5947 afs->flush_header ();
5948 } else if ((ms = boost::dynamic_pointer_cast<MidiSource>(*src))) {
5949 Source::Lock lock(ms->mutex());
5950 ms->mark_streaming_write_completed(lock);
5954 /* construct a region to represent the bounced material */
5958 plist.add (Properties::start, 0);
5959 plist.add (Properties::length, srcs.front()->length(srcs.front()->timeline_position()));
5960 plist.add (Properties::name, region_name_from_path (srcs.front()->name(), true));
5962 result = RegionFactory::create (srcs, plist);
5968 for (vector<boost::shared_ptr<Source> >::iterator src = srcs.begin(); src != srcs.end(); ++src) {
5969 (*src)->mark_for_remove ();
5970 (*src)->drop_references ();
5974 for (vector<boost::shared_ptr<Source> >::iterator src = srcs.begin(); src != srcs.end(); ++src) {
5975 boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*src);
5978 afs->done_with_peakfile_writes ();
5982 _bounce_processing_active = false;
5984 if (need_block_size_reset) {
5985 _engine.main_thread()->drop_buffers ();
5986 track.set_block_size (get_block_size());
5989 unblock_processing ();
5995 Session::gain_automation_buffer() const
5997 return ProcessThread::gain_automation_buffer ();
6001 Session::trim_automation_buffer() const
6003 return ProcessThread::trim_automation_buffer ();
6007 Session::send_gain_automation_buffer() const
6009 return ProcessThread::send_gain_automation_buffer ();
6013 Session::pan_automation_buffer() const
6015 return ProcessThread::pan_automation_buffer ();
6019 Session::get_silent_buffers (ChanCount count)
6021 return ProcessThread::get_silent_buffers (count);
6025 Session::get_scratch_buffers (ChanCount count, bool silence)
6027 return ProcessThread::get_scratch_buffers (count, silence);
6031 Session::get_noinplace_buffers (ChanCount count)
6033 return ProcessThread::get_noinplace_buffers (count);
6037 Session::get_route_buffers (ChanCount count, bool silence)
6039 return ProcessThread::get_route_buffers (count, silence);
6044 Session::get_mix_buffers (ChanCount count)
6046 return ProcessThread::get_mix_buffers (count);
6050 Session::ntracks () const
6053 boost::shared_ptr<RouteList> r = routes.reader ();
6055 for (RouteList::const_iterator i = r->begin(); i != r->end(); ++i) {
6056 if (boost::dynamic_pointer_cast<Track> (*i)) {
6065 Session::nbusses () const
6068 boost::shared_ptr<RouteList> r = routes.reader ();
6070 for (RouteList::const_iterator i = r->begin(); i != r->end(); ++i) {
6071 if (boost::dynamic_pointer_cast<Track>(*i) == 0) {
6080 Session::add_automation_list(AutomationList *al)
6082 automation_lists[al->id()] = al;
6085 /** @return true if there is at least one record-enabled track, otherwise false */
6087 Session::have_rec_enabled_track () const
6089 return g_atomic_int_get (const_cast<gint*>(&_have_rec_enabled_track)) == 1;
6093 Session::have_rec_disabled_track () const
6095 return g_atomic_int_get (const_cast<gint*>(&_have_rec_disabled_track)) == 1;
6098 /** Update the state of our rec-enabled tracks flag */
6100 Session::update_route_record_state ()
6102 boost::shared_ptr<RouteList> rl = routes.reader ();
6103 RouteList::iterator i = rl->begin();
6104 while (i != rl->end ()) {
6106 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
6107 if (tr && tr->rec_enable_control()->get_value()) {
6114 int const old = g_atomic_int_get (&_have_rec_enabled_track);
6116 g_atomic_int_set (&_have_rec_enabled_track, i != rl->end () ? 1 : 0);
6118 if (g_atomic_int_get (&_have_rec_enabled_track) != old) {
6119 RecordStateChanged (); /* EMIT SIGNAL */
6122 for (i = rl->begin(); i != rl->end (); ++i) {
6123 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
6124 if (tr && !tr->rec_enable_control()->get_value()) {
6129 g_atomic_int_set (&_have_rec_disabled_track, i != rl->end () ? 1 : 0);
6131 bool record_arm_state_changed = (old != g_atomic_int_get (&_have_rec_enabled_track) );
6133 if (record_status() == Recording && record_arm_state_changed ) {
6134 RecordArmStateChanged ();
6140 Session::listen_position_changed ()
6142 boost::shared_ptr<RouteList> r = routes.reader ();
6144 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6145 (*i)->listen_position_changed ();
6150 Session::solo_control_mode_changed ()
6152 if (soloing() || listening()) {
6153 /* We can't use ::clear_all_solo_state() here because during
6154 session loading at program startup, that will queue a call
6155 to rt_clear_all_solo_state() that will not execute until
6156 AFTER solo states have been established (thus throwing away
6157 the session's saved solo state). So just explicitly turn
6160 set_controls (route_list_to_control_list (get_routes(), &Route::solo_control), 0.0, Controllable::NoGroup);
6164 /** Called when a property of one of our route groups changes */
6166 Session::route_group_property_changed (RouteGroup* rg)
6168 RouteGroupPropertyChanged (rg); /* EMIT SIGNAL */
6171 /** Called when a route is added to one of our route groups */
6173 Session::route_added_to_route_group (RouteGroup* rg, boost::weak_ptr<Route> r)
6175 RouteAddedToRouteGroup (rg, r);
6178 /** Called when a route is removed from one of our route groups */
6180 Session::route_removed_from_route_group (RouteGroup* rg, boost::weak_ptr<Route> r)
6182 update_route_record_state ();
6183 RouteRemovedFromRouteGroup (rg, r); /* EMIT SIGNAL */
6186 boost::shared_ptr<RouteList>
6187 Session::get_tracks () const
6189 boost::shared_ptr<RouteList> rl = routes.reader ();
6190 boost::shared_ptr<RouteList> tl (new RouteList);
6192 for (RouteList::const_iterator r = rl->begin(); r != rl->end(); ++r) {
6193 if (boost::dynamic_pointer_cast<Track> (*r)) {
6194 if (!(*r)->is_auditioner()) {
6202 boost::shared_ptr<RouteList>
6203 Session::get_routes_with_regions_at (framepos_t const p) const
6205 boost::shared_ptr<RouteList> r = routes.reader ();
6206 boost::shared_ptr<RouteList> rl (new RouteList);
6208 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6209 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
6214 boost::shared_ptr<Playlist> pl = tr->playlist ();
6219 if (pl->has_region_at (p)) {
6228 Session::goto_end ()
6230 if (_session_range_location) {
6231 request_locate (_session_range_location->end(), false);
6233 request_locate (0, false);
6238 Session::goto_start ()
6240 if (_session_range_location) {
6241 request_locate (_session_range_location->start(), false);
6243 request_locate (0, false);
6248 Session::current_start_frame () const
6250 return _session_range_location ? _session_range_location->start() : 0;
6254 Session::current_end_frame () const
6256 return _session_range_location ? _session_range_location->end() : 0;
6260 Session::set_session_range_location (framepos_t start, framepos_t end)
6262 _session_range_location = new Location (*this, start, end, _("session"), Location::IsSessionRange);
6263 _locations->add (_session_range_location);
6267 Session::step_edit_status_change (bool yn)
6273 send = (_step_editors == 0);
6278 send = (_step_editors == 1);
6281 if (_step_editors > 0) {
6287 StepEditStatusChange (val);
6293 Session::start_time_changed (framepos_t old)
6295 /* Update the auto loop range to match the session range
6296 (unless the auto loop range has been changed by the user)
6299 Location* s = _locations->session_range_location ();
6304 Location* l = _locations->auto_loop_location ();
6306 if (l && l->start() == old) {
6307 l->set_start (s->start(), true);
6312 Session::end_time_changed (framepos_t old)
6314 /* Update the auto loop range to match the session range
6315 (unless the auto loop range has been changed by the user)
6318 Location* s = _locations->session_range_location ();
6323 Location* l = _locations->auto_loop_location ();
6325 if (l && l->end() == old) {
6326 l->set_end (s->end(), true);
6330 std::vector<std::string>
6331 Session::source_search_path (DataType type) const
6335 if (session_dirs.size() == 1) {
6337 case DataType::AUDIO:
6338 sp.push_back (_session_dir->sound_path());
6340 case DataType::MIDI:
6341 sp.push_back (_session_dir->midi_path());
6345 for (vector<space_and_path>::const_iterator i = session_dirs.begin(); i != session_dirs.end(); ++i) {
6346 SessionDirectory sdir (i->path);
6348 case DataType::AUDIO:
6349 sp.push_back (sdir.sound_path());
6351 case DataType::MIDI:
6352 sp.push_back (sdir.midi_path());
6358 if (type == DataType::AUDIO) {
6359 const string sound_path_2X = _session_dir->sound_path_2X();
6360 if (Glib::file_test (sound_path_2X, Glib::FILE_TEST_EXISTS|Glib::FILE_TEST_IS_DIR)) {
6361 if (find (sp.begin(), sp.end(), sound_path_2X) == sp.end()) {
6362 sp.push_back (sound_path_2X);
6367 // now check the explicit (possibly user-specified) search path
6370 case DataType::AUDIO:
6371 sp += Searchpath(config.get_audio_search_path ());
6373 case DataType::MIDI:
6374 sp += Searchpath(config.get_midi_search_path ());
6382 Session::ensure_search_path_includes (const string& path, DataType type)
6391 case DataType::AUDIO:
6392 sp += Searchpath(config.get_audio_search_path ());
6394 case DataType::MIDI:
6395 sp += Searchpath (config.get_midi_search_path ());
6399 for (vector<std::string>::iterator i = sp.begin(); i != sp.end(); ++i) {
6400 /* No need to add this new directory if it has the same inode as
6401 an existing one; checking inode rather than name prevents duplicated
6402 directories when we are using symlinks.
6404 On Windows, I think we could just do if (*i == path) here.
6406 if (PBD::equivalent_paths (*i, path)) {
6414 case DataType::AUDIO:
6415 config.set_audio_search_path (sp.to_string());
6417 case DataType::MIDI:
6418 config.set_midi_search_path (sp.to_string());
6424 Session::remove_dir_from_search_path (const string& dir, DataType type)
6429 case DataType::AUDIO:
6430 sp = Searchpath(config.get_audio_search_path ());
6432 case DataType::MIDI:
6433 sp = Searchpath (config.get_midi_search_path ());
6440 case DataType::AUDIO:
6441 config.set_audio_search_path (sp.to_string());
6443 case DataType::MIDI:
6444 config.set_midi_search_path (sp.to_string());
6450 boost::shared_ptr<Speakers>
6451 Session::get_speakers()
6457 Session::unknown_processors () const
6461 boost::shared_ptr<RouteList> r = routes.reader ();
6462 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6463 list<string> t = (*i)->unknown_processors ();
6464 copy (t.begin(), t.end(), back_inserter (p));
6474 Session::update_latency (bool playback)
6477 DEBUG_TRACE (DEBUG::Latency, string_compose ("JACK latency callback: %1\n", (playback ? "PLAYBACK" : "CAPTURE")));
6479 if ((_state_of_the_state & (InitialConnecting|Deletion)) || _adding_routes_in_progress || _route_deletion_in_progress) {
6483 boost::shared_ptr<RouteList> r = routes.reader ();
6484 framecnt_t max_latency = 0;
6487 /* reverse the list so that we work backwards from the last route to run to the first */
6488 RouteList* rl = routes.reader().get();
6489 r.reset (new RouteList (*rl));
6490 reverse (r->begin(), r->end());
6493 /* compute actual latency values for the given direction and store them all in per-port
6494 structures. this will also publish the same values (to JACK) so that computation of latency
6495 for routes can consistently use public latency values.
6498 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6499 max_latency = max (max_latency, (*i)->set_private_port_latencies (playback));
6502 /* because we latency compensate playback, our published playback latencies should
6503 be the same for all output ports - all material played back by ardour has
6504 the same latency, whether its caused by plugins or by latency compensation. since
6505 these may differ from the values computed above, reset all playback port latencies
6509 DEBUG_TRACE (DEBUG::Latency, string_compose ("Set public port latencies to %1\n", max_latency));
6511 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6512 (*i)->set_public_port_latencies (max_latency, playback);
6517 post_playback_latency ();
6521 post_capture_latency ();
6524 DEBUG_TRACE (DEBUG::Latency, "JACK latency callback: DONE\n");
6528 Session::post_playback_latency ()
6530 set_worst_playback_latency ();
6532 boost::shared_ptr<RouteList> r = routes.reader ();
6534 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6535 if (!(*i)->is_auditioner() && ((*i)->active())) {
6536 _worst_track_latency = max (_worst_track_latency, (*i)->update_signal_latency ());
6540 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6541 (*i)->set_latency_compensation (_worst_track_latency);
6546 Session::post_capture_latency ()
6548 set_worst_capture_latency ();
6550 /* reflect any changes in capture latencies into capture offsets
6553 boost::shared_ptr<RouteList> rl = routes.reader();
6554 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
6555 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
6557 tr->set_capture_offset ();
6563 Session::initialize_latencies ()
6566 Glib::Threads::Mutex::Lock lm (_engine.process_lock());
6567 update_latency (false);
6568 update_latency (true);
6571 set_worst_io_latencies ();
6575 Session::set_worst_io_latencies ()
6577 set_worst_playback_latency ();
6578 set_worst_capture_latency ();
6582 Session::set_worst_playback_latency ()
6584 if (_state_of_the_state & (InitialConnecting|Deletion)) {
6588 _worst_output_latency = 0;
6590 if (!_engine.connected()) {
6594 boost::shared_ptr<RouteList> r = routes.reader ();
6596 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6597 _worst_output_latency = max (_worst_output_latency, (*i)->output()->latency());
6600 DEBUG_TRACE (DEBUG::Latency, string_compose ("Worst output latency: %1\n", _worst_output_latency));
6604 Session::set_worst_capture_latency ()
6606 if (_state_of_the_state & (InitialConnecting|Deletion)) {
6610 _worst_input_latency = 0;
6612 if (!_engine.connected()) {
6616 boost::shared_ptr<RouteList> r = routes.reader ();
6618 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6619 _worst_input_latency = max (_worst_input_latency, (*i)->input()->latency());
6622 DEBUG_TRACE (DEBUG::Latency, string_compose ("Worst input latency: %1\n", _worst_input_latency));
6626 Session::update_latency_compensation (bool force_whole_graph)
6628 bool some_track_latency_changed = false;
6630 if (_state_of_the_state & (InitialConnecting|Deletion)) {
6634 DEBUG_TRACE(DEBUG::Latency, "---------------------------- update latency compensation\n\n");
6636 _worst_track_latency = 0;
6638 boost::shared_ptr<RouteList> r = routes.reader ();
6640 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6641 if (!(*i)->is_auditioner() && ((*i)->active())) {
6643 if ((*i)->signal_latency () != (tl = (*i)->update_signal_latency ())) {
6644 some_track_latency_changed = true;
6646 _worst_track_latency = max (tl, _worst_track_latency);
6650 DEBUG_TRACE (DEBUG::Latency, string_compose ("worst signal processing latency: %1 (changed ? %2)\n", _worst_track_latency,
6651 (some_track_latency_changed ? "yes" : "no")));
6653 DEBUG_TRACE(DEBUG::Latency, "---------------------------- DONE update latency compensation\n\n");
6655 if (some_track_latency_changed || force_whole_graph) {
6656 _engine.update_latencies ();
6660 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6661 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
6665 tr->set_capture_offset ();
6670 Session::session_name_is_legal (const string& path)
6672 char illegal_chars[] = { '/', '\\', ':', ';', '\0' };
6674 for (int i = 0; illegal_chars[i]; ++i) {
6675 if (path.find (illegal_chars[i]) != string::npos) {
6676 return illegal_chars[i];
6684 Session::notify_presentation_info_change ()
6686 if (deletion_in_progress()) {
6690 Stripable::PresentationInfoChange (); /* EMIT SIGNAL */
6691 reassign_track_numbers();
6693 #ifdef USE_TRACKS_CODE_FEATURES
6694 /* Waves Tracks: for Waves Tracks session it's required to reconnect their IOs
6695 * if track order has been changed by user
6697 reconnect_existing_routes(true, true);
6703 Session::operation_in_progress (GQuark op) const
6705 return (find (_current_trans_quarks.begin(), _current_trans_quarks.end(), op) != _current_trans_quarks.end());
6708 boost::shared_ptr<Port>
6709 Session::ltc_input_port () const
6711 return _ltc_input->nth (0);
6714 boost::shared_ptr<Port>
6715 Session::ltc_output_port () const
6717 return _ltc_output->nth (0);
6721 Session::reconnect_ltc_input ()
6725 string src = Config->get_ltc_source_port();
6727 _ltc_input->disconnect (this);
6729 if (src != _("None") && !src.empty()) {
6730 _ltc_input->nth (0)->connect (src);
6733 if ( ARDOUR::Profile->get_trx () ) {
6734 // Tracks need this signal to update timecode_source_dropdown
6735 MtcOrLtcInputPortChanged (); //emit signal
6741 Session::reconnect_ltc_output ()
6745 string src = Config->get_ltc_output_port();
6747 _ltc_output->disconnect (this);
6749 if (src != _("None") && !src.empty()) {
6750 _ltc_output->nth (0)->connect (src);
6756 Session::set_range_selection (framepos_t start, framepos_t end)
6758 _range_selection = Evoral::Range<framepos_t> (start, end);
6759 #ifdef USE_TRACKS_CODE_FEATURES
6760 follow_playhead_priority ();
6765 Session::set_object_selection (framepos_t start, framepos_t end)
6767 _object_selection = Evoral::Range<framepos_t> (start, end);
6768 #ifdef USE_TRACKS_CODE_FEATURES
6769 follow_playhead_priority ();
6774 Session::clear_range_selection ()
6776 _range_selection = Evoral::Range<framepos_t> (-1,-1);
6777 #ifdef USE_TRACKS_CODE_FEATURES
6778 follow_playhead_priority ();
6783 Session::clear_object_selection ()
6785 _object_selection = Evoral::Range<framepos_t> (-1,-1);
6786 #ifdef USE_TRACKS_CODE_FEATURES
6787 follow_playhead_priority ();
6792 Session::auto_connect_route (boost::shared_ptr<Route> route, bool connect_inputs,
6793 const ChanCount& input_start,
6794 const ChanCount& output_start,
6795 const ChanCount& input_offset,
6796 const ChanCount& output_offset)
6798 Glib::Threads::Mutex::Lock lx (_auto_connect_queue_lock);
6799 _auto_connect_queue.push (AutoConnectRequest (route, connect_inputs,
6800 input_start, output_start,
6801 input_offset, output_offset));
6803 if (pthread_mutex_trylock (&_auto_connect_mutex) == 0) {
6804 pthread_cond_signal (&_auto_connect_cond);
6805 pthread_mutex_unlock (&_auto_connect_mutex);
6810 Session::auto_connect (const AutoConnectRequest& ar)
6812 boost::shared_ptr<Route> route = ar.route.lock();
6814 if (!route) { return; }
6816 if (!IO::connecting_legal) {
6820 /* If both inputs and outputs are auto-connected to physical ports,
6821 * use the max of input and output offsets to ensure auto-connected
6822 * port numbers always match up (e.g. the first audio input and the
6823 * first audio output of the route will have the same physical
6824 * port number). Otherwise just use the lowest input or output
6828 const bool in_out_physical =
6829 (Config->get_input_auto_connect() & AutoConnectPhysical)
6830 && (Config->get_output_auto_connect() & AutoConnectPhysical)
6831 && ar.connect_inputs;
6833 const ChanCount in_offset = in_out_physical
6834 ? ChanCount::max(ar.input_offset, ar.output_offset)
6837 const ChanCount out_offset = in_out_physical
6838 ? ChanCount::max(ar.input_offset, ar.output_offset)
6841 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
6842 vector<string> physinputs;
6843 vector<string> physoutputs;
6845 _engine.get_physical_outputs (*t, physoutputs);
6846 _engine.get_physical_inputs (*t, physinputs);
6848 if (!physinputs.empty() && ar.connect_inputs) {
6849 uint32_t nphysical_in = physinputs.size();
6851 for (uint32_t i = ar.input_start.get(*t); i < route->n_inputs().get(*t) && i < nphysical_in; ++i) {
6854 if (Config->get_input_auto_connect() & AutoConnectPhysical) {
6855 port = physinputs[(in_offset.get(*t) + i) % nphysical_in];
6858 if (!port.empty() && route->input()->connect (route->input()->ports().port(*t, i), port, this)) {
6864 if (!physoutputs.empty()) {
6865 uint32_t nphysical_out = physoutputs.size();
6866 for (uint32_t i = ar.output_start.get(*t); i < route->n_outputs().get(*t); ++i) {
6870 * do not create new connections if we reached the limit of physical outputs
6873 if (!(Config->get_output_auto_connect() & AutoConnectMaster) &&
6874 ARDOUR::Profile->get_trx () &&
6875 ar.output_offset.get(*t) == nphysical_out ) {
6879 if ((*t) == DataType::MIDI && (Config->get_output_auto_connect() & AutoConnectPhysical)) {
6880 port = physoutputs[(out_offset.get(*t) + i) % nphysical_out];
6881 } else if ((*t) == DataType::AUDIO && (Config->get_output_auto_connect() & AutoConnectMaster)) {
6882 /* master bus is audio only */
6883 if (_master_out && _master_out->n_inputs().get(*t) > 0) {
6884 port = _master_out->input()->ports().port(*t,
6885 i % _master_out->input()->n_ports().get(*t))->name();
6889 if (!port.empty() && route->output()->connect (route->output()->ports().port(*t, i), port, this)) {
6898 Session::auto_connect_thread_start ()
6900 if (_ac_thread_active) {
6904 while (!_auto_connect_queue.empty ()) {
6905 _auto_connect_queue.pop ();
6908 _ac_thread_active = true;
6909 if (pthread_create (&_auto_connect_thread, NULL, auto_connect_thread, this)) {
6910 _ac_thread_active = false;
6915 Session::auto_connect_thread_terminate ()
6917 if (!_ac_thread_active) {
6920 _ac_thread_active = false;
6923 Glib::Threads::Mutex::Lock lx (_auto_connect_queue_lock);
6924 while (!_auto_connect_queue.empty ()) {
6925 _auto_connect_queue.pop ();
6929 if (pthread_mutex_lock (&_auto_connect_mutex) == 0) {
6930 pthread_cond_signal (&_auto_connect_cond);
6931 pthread_mutex_unlock (&_auto_connect_mutex);
6935 pthread_join (_auto_connect_thread, &status);
6939 Session::auto_connect_thread (void *arg)
6941 Session *s = static_cast<Session *>(arg);
6942 s->auto_connect_thread_run ();
6948 Session::auto_connect_thread_run ()
6950 pthread_set_name (X_("autoconnect"));
6951 SessionEvent::create_per_thread_pool (X_("autoconnect"), 1024);
6952 PBD::notify_event_loops_about_thread_creation (pthread_self(), X_("autoconnect"), 1024);
6953 pthread_mutex_lock (&_auto_connect_mutex);
6954 while (_ac_thread_active) {
6956 if (!_auto_connect_queue.empty ()) {
6957 // Why would we need the process lock ??
6958 // A: if ports are added while we're connecting, the backend's iterator may be invalidated:
6959 // graph_order_callback() -> resort_routes() -> direct_feeds_according_to_reality () -> backend::connected_to()
6960 // All ardour-internal backends use a std::vector xxxAudioBackend::find_port()
6961 // We have control over those, but what does jack do?
6962 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
6964 Glib::Threads::Mutex::Lock lx (_auto_connect_queue_lock);
6965 while (!_auto_connect_queue.empty ()) {
6966 const AutoConnectRequest ar (_auto_connect_queue.front());
6967 _auto_connect_queue.pop ();
6974 pthread_cond_wait (&_auto_connect_cond, &_auto_connect_mutex);
6976 pthread_mutex_unlock (&_auto_connect_mutex);