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/error.h"
41 #include "pbd/file_utils.h"
43 #include "pbd/pthread_utils.h"
44 #include "pbd/search_path.h"
45 #include "pbd/stacktrace.h"
46 #include "pbd/stl_delete.h"
47 #include "pbd/replace_all.h"
48 #include "pbd/unwind.h"
50 #include "ardour/amp.h"
51 #include "ardour/analyser.h"
52 #include "ardour/async_midi_port.h"
53 #include "ardour/audio_buffer.h"
54 #include "ardour/audio_diskstream.h"
55 #include "ardour/audio_port.h"
56 #include "ardour/audio_track.h"
57 #include "ardour/audioengine.h"
58 #include "ardour/audiofilesource.h"
59 #include "ardour/auditioner.h"
60 #include "ardour/boost_debug.h"
61 #include "ardour/buffer_manager.h"
62 #include "ardour/buffer_set.h"
63 #include "ardour/bundle.h"
64 #include "ardour/butler.h"
65 #include "ardour/click.h"
66 #include "ardour/control_protocol_manager.h"
67 #include "ardour/data_type.h"
68 #include "ardour/debug.h"
69 #include "ardour/directory_names.h"
70 #ifdef USE_TRACKS_CODE_FEATURES
71 #include "ardour/engine_state_controller.h"
73 #include "ardour/filename_extensions.h"
74 #include "ardour/gain_control.h"
75 #include "ardour/graph.h"
76 #include "ardour/luabindings.h"
77 #include "ardour/midiport_manager.h"
78 #include "ardour/scene_changer.h"
79 #include "ardour/midi_patch_manager.h"
80 #include "ardour/midi_track.h"
81 #include "ardour/midi_ui.h"
82 #include "ardour/operations.h"
83 #include "ardour/playlist.h"
84 #include "ardour/plugin.h"
85 #include "ardour/plugin_insert.h"
86 #include "ardour/process_thread.h"
87 #include "ardour/profile.h"
88 #include "ardour/rc_configuration.h"
89 #include "ardour/recent_sessions.h"
90 #include "ardour/region.h"
91 #include "ardour/region_factory.h"
92 #include "ardour/revision.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"
116 #include "pbd/i18n.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)
180 , _session_range_end_is_free (true)
183 , _transport_speed (0)
184 , _default_transport_speed (1.0)
185 , _last_transport_speed (0)
186 , _target_transport_speed (0.0)
187 , auto_play_legal (false)
188 , _last_slave_transport_frame (0)
189 , maximum_output_latency (0)
190 , _requested_return_frame (-1)
191 , current_block_size (0)
192 , _worst_output_latency (0)
193 , _worst_input_latency (0)
194 , _worst_track_latency (0)
195 , _have_captured (false)
196 , _non_soloed_outs_muted (false)
199 , _solo_isolated_cnt (0)
201 , _was_seamless (Config->get_seamless_loop ())
202 , _under_nsm_control (false)
204 , delta_accumulator_cnt (0)
205 , average_slave_delta (1800) // !!! why 1800 ???
207 , have_first_delta_accumulator (false)
208 , _slave_state (Stopped)
209 , _mtc_active (false)
210 , _ltc_active (false)
211 , post_export_sync (false)
212 , post_export_position (0)
214 , _export_rolling (false)
215 , _realtime_export (false)
216 , _region_export (false)
217 , _export_preroll (0)
218 , _export_latency (0)
219 , _pre_export_mmc_enabled (false)
220 , _name (snapshot_name)
222 , _send_qf_mtc (false)
223 , _pframes_since_last_mtc (0)
224 , session_midi_feedback (0)
226 , loop_changing (false)
228 , _session_dir (new SessionDirectory (fullpath))
229 , _current_snapshot_name (snapshot_name)
231 , state_was_pending (false)
232 , _state_of_the_state (StateOfTheState(CannotSave|InitialConnecting|Loading))
234 , _save_queued (false)
235 , _last_roll_location (0)
236 , _last_roll_or_reversal_location (0)
237 , _last_record_location (0)
238 , pending_locate_roll (false)
239 , pending_locate_frame (0)
240 , pending_locate_flush (false)
241 , pending_abort (false)
242 , pending_auto_loop (false)
243 , _mempool ("Session", 2097152)
244 , lua (lua_newstate (&PBD::ReallocPool::lalloc, &_mempool))
246 , _butler (new Butler (*this))
247 , _post_transport_work (0)
248 , cumulative_rf_motion (0)
250 , _locations (new Locations (*this))
251 , _ignore_skips_updates (false)
252 , _rt_thread_active (false)
253 , _rt_emit_pending (false)
254 , _ac_thread_active (false)
255 , _latency_recompute_pending (0)
257 , outbound_mtc_timecode_frame (0)
258 , next_quarter_frame_to_send (-1)
259 , _frames_per_timecode_frame (0)
260 , _frames_per_hour (0)
261 , _timecode_frames_per_hour (0)
262 , last_timecode_valid (false)
263 , last_timecode_when (0)
264 , _send_timecode_update (false)
276 , ltc_timecode_offset (0)
277 , ltc_timecode_negative_offset (false)
278 , midi_control_ui (0)
280 , _all_route_group (new RouteGroup (*this, "all"))
281 , routes (new RouteList)
282 , _adding_routes_in_progress (false)
283 , _reconnecting_routes_in_progress (false)
284 , _route_deletion_in_progress (false)
285 , destructive_index (0)
286 , _track_number_decimals(1)
287 , default_fade_steepness (0)
288 , default_fade_msecs (0)
289 , _total_free_4k_blocks (0)
290 , _total_free_4k_blocks_uncertain (false)
291 , no_questions_about_missing_files (false)
294 , _bundles (new BundleList)
295 , _bundle_xml_node (0)
299 , click_emphasis_data (0)
301 , click_emphasis_length (0)
302 , _clicks_cleared (0)
303 , _play_range (false)
304 , _range_selection (-1,-1)
305 , _object_selection (-1,-1)
307 , first_file_data_format_reset (true)
308 , first_file_header_format_reset (true)
309 , have_looped (false)
310 , _have_rec_enabled_track (false)
311 , _have_rec_disabled_track (true)
313 , _suspend_timecode_transmission (0)
314 , _speakers (new Speakers)
315 , ignore_route_processor_changes (false)
320 , _vca_manager (new VCAManager (*this))
324 created_with = string_compose ("%1 %2", PROGRAM_NAME, revision);
326 pthread_mutex_init (&_rt_emit_mutex, 0);
327 pthread_cond_init (&_rt_emit_cond, 0);
329 pthread_mutex_init (&_auto_connect_mutex, 0);
330 pthread_cond_init (&_auto_connect_cond, 0);
332 init_name_id_counter (1); // reset for new sessions, start at 1
333 VCA::set_next_vca_number (1); // reset for new sessions, start at 1
335 pre_engine_init (fullpath);
341 Stateful::loading_state_version = CURRENT_SESSION_FILE_VERSION;
343 #ifdef USE_TRACKS_CODE_FEATURES
344 sr = EngineStateController::instance()->get_current_sample_rate();
346 if (ensure_engine (sr, true)) {
348 throw SessionException (_("Cannot connect to audio/midi engine"));
351 // set samplerate for plugins added early
352 // e.g from templates or MB channelstrip
353 set_block_size (_engine.samples_per_cycle());
354 set_frame_rate (_engine.sample_rate());
356 if (create (mix_template, bus_profile)) {
358 throw SessionException (_("Session initialization failed"));
361 /* if a mix template was provided, then ::create() will
362 * have copied it into the session and we need to load it
363 * so that we have the state ready for ::set_state()
364 * after the engine is started.
366 * Note that we do NOT try to get the sample rate from
367 * the template at this time, though doing so would
368 * be easy if we decided this was an appropriate part
372 if (!mix_template.empty()) {
373 if (load_state (_current_snapshot_name)) {
374 throw SessionException (_("Failed to load template/snapshot state"));
376 store_recent_templates (mix_template);
379 /* load default session properties - if any */
384 if (load_state (_current_snapshot_name)) {
385 throw SessionException (_("Failed to load state"));
388 /* try to get sample rate from XML state so that we
389 * can influence the SR if we set up the audio
394 XMLProperty const * prop;
395 XMLNode const * root (state_tree->root());
396 if ((prop = root->property (X_("sample-rate"))) != 0) {
397 sr = atoi (prop->value());
401 if (ensure_engine (sr, false)) {
403 throw SessionException (_("Cannot connect to audio/midi engine"));
407 if (post_engine_init ()) {
409 throw SessionException (_("Cannot configure audio/midi engine with session parameters"));
412 store_recent_sessions (_name, _path);
414 bool was_dirty = dirty();
416 _state_of_the_state = StateOfTheState (_state_of_the_state & ~Dirty);
418 Config->ParameterChanged.connect_same_thread (*this, boost::bind (&Session::config_changed, this, _1, false));
419 config.ParameterChanged.connect_same_thread (*this, boost::bind (&Session::config_changed, this, _1, true));
422 DirtyChanged (); /* EMIT SIGNAL */
425 StartTimeChanged.connect_same_thread (*this, boost::bind (&Session::start_time_changed, this, _1));
426 EndTimeChanged.connect_same_thread (*this, boost::bind (&Session::end_time_changed, this, _1));
428 emit_thread_start ();
429 auto_connect_thread_start ();
431 /* hook us up to the engine since we are now completely constructed */
433 BootMessage (_("Connect to engine"));
435 _engine.set_session (this);
436 _engine.reset_timebase ();
438 #ifdef USE_TRACKS_CODE_FEATURES
440 EngineStateController::instance()->set_session(this);
443 if ( ARDOUR::Profile->get_trx () ) {
445 /* Waves Tracks: fill session with tracks basing on the amount of inputs.
446 * each available input must have corresponding track when session starts.
449 uint32_t how_many (0);
451 std::vector<std::string> inputs;
452 EngineStateController::instance()->get_physical_audio_inputs(inputs);
454 how_many = inputs.size();
456 list<boost::shared_ptr<AudioTrack> > tracks;
458 // Track names after driver
459 if (Config->get_tracks_auto_naming() == NameAfterDriver) {
460 string track_name = "";
461 for (std::vector<string>::size_type i = 0; i < inputs.size(); ++i) {
463 track_name = inputs[i];
464 replace_all (track_name, "system:capture", "");
466 list<boost::shared_ptr<AudioTrack> > single_track = new_audio_track (1, 1, Normal, 0, 1, track_name);
467 tracks.insert(tracks.begin(), single_track.front());
469 } else { // Default track names
470 tracks = new_audio_track (1, 1, Normal, 0, how_many, string());
473 if (tracks.size() != how_many) {
475 throw failed_constructor ();
484 BootMessage (_("Session loading complete"));
496 Session::next_name_id ()
498 return g_atomic_int_add (&_name_id_counter, 1);
502 Session::name_id_counter ()
504 return g_atomic_int_get (&_name_id_counter);
508 Session::init_name_id_counter (guint n)
510 g_atomic_int_set (&_name_id_counter, n);
514 Session::ensure_engine (uint32_t desired_sample_rate, bool isnew)
516 if (_engine.current_backend() == 0) {
517 /* backend is unknown ... */
518 boost::optional<int> r = AudioEngineSetupRequired (desired_sample_rate);
519 if (r.get_value_or (-1) != 0) {
522 } else if (!isnew && _engine.running() && _engine.sample_rate () == desired_sample_rate) {
524 } else if (_engine.setup_required()) {
525 /* backend is known, but setup is needed */
526 boost::optional<int> r = AudioEngineSetupRequired (desired_sample_rate);
527 if (r.get_value_or (-1) != 0) {
530 } else if (!_engine.running()) {
531 if (_engine.start()) {
536 /* at this point the engine should be running */
538 if (!_engine.running()) {
542 return immediately_post_engine ();
547 Session::immediately_post_engine ()
549 /* Do various initializations that should take place directly after we
550 * know that the engine is running, but before we either create a
551 * session or set state for an existing one.
554 if (how_many_dsp_threads () > 1) {
555 /* For now, only create the graph if we are using >1 DSP threads, as
556 it is a bit slower than the old code with 1 thread.
558 _process_graph.reset (new Graph (*this));
561 /* every time we reconnect, recompute worst case output latencies */
563 _engine.Running.connect_same_thread (*this, boost::bind (&Session::initialize_latencies, this));
565 if (synced_to_engine()) {
566 _engine.transport_stop ();
569 if (config.get_jack_time_master()) {
570 _engine.transport_locate (_transport_frame);
575 BootMessage (_("Set up LTC"));
577 BootMessage (_("Set up Click"));
579 BootMessage (_("Set up standard connections"));
583 catch (failed_constructor& err) {
587 /* TODO, connect in different thread. (PortRegisteredOrUnregistered may be in RT context)
589 _engine.PortRegisteredOrUnregistered.connect_same_thread (*this, boost::bind (&Session::setup_bundles, this));
597 vector<void*> debug_pointers;
599 /* if we got to here, leaving pending capture state around
603 remove_pending_capture_state ();
607 _state_of_the_state = StateOfTheState (CannotSave|Deletion);
609 /* stop autoconnecting */
610 auto_connect_thread_terminate ();
612 /* disconnect from any and all signals that we are connected to */
614 Port::PortSignalDrop (); /* EMIT SIGNAL */
617 /* shutdown control surface protocols while we still have ports
618 and the engine to move data to any devices.
621 ControlProtocolManager::instance().drop_protocols ();
623 MIDI::Name::MidiPatchManager::instance().remove_search_path(session_directory().midi_patch_path());
625 _engine.remove_session ();
627 #ifdef USE_TRACKS_CODE_FEATURES
628 EngineStateController::instance()->remove_session();
631 /* deregister all ports - there will be no process or any other
632 * callbacks from the engine any more.
635 Port::PortDrop (); /* EMIT SIGNAL */
639 /* clear history so that no references to objects are held any more */
643 /* clear state tree so that no references to objects are held any more */
648 // unregister all lua functions, drop held references (if any)
650 lua.do_command ("Session = nil");
658 lua.collect_garbage ();
660 /* reset dynamic state version back to default */
661 Stateful::loading_state_version = 0;
663 _butler->drop_references ();
667 delete _all_route_group;
669 DEBUG_TRACE (DEBUG::Destruction, "delete route groups\n");
670 for (list<RouteGroup *>::iterator i = _route_groups.begin(); i != _route_groups.end(); ++i) {
674 if (click_data != default_click) {
675 delete [] click_data;
678 if (click_emphasis_data != default_click_emphasis) {
679 delete [] click_emphasis_data;
684 /* need to remove auditioner before monitoring section
685 * otherwise it is re-connected */
688 /* drop references to routes held by the monitoring section
689 * specifically _monitor_out aux/listen references */
690 remove_monitor_section();
692 /* clear out any pending dead wood from RCU managed objects */
697 AudioDiskstream::free_working_buffers();
699 /* tell everyone who is still standing that we're about to die */
702 /* tell everyone to drop references and delete objects as we go */
704 DEBUG_TRACE (DEBUG::Destruction, "delete regions\n");
705 RegionFactory::delete_all_regions ();
707 /* Do this early so that VCAs no longer hold references to routes */
709 DEBUG_TRACE (DEBUG::Destruction, "delete vcas\n");
712 DEBUG_TRACE (DEBUG::Destruction, "delete routes\n");
714 /* reset these three references to special routes before we do the usual route delete thing */
716 _master_out.reset ();
717 _monitor_out.reset ();
720 RCUWriter<RouteList> writer (routes);
721 boost::shared_ptr<RouteList> r = writer.get_copy ();
723 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
724 DEBUG_TRACE(DEBUG::Destruction, string_compose ("Dropping for route %1 ; pre-ref = %2\n", (*i)->name(), (*i).use_count()));
725 (*i)->drop_references ();
729 /* writer goes out of scope and updates master */
734 DEBUG_TRACE (DEBUG::Destruction, "delete sources\n");
735 Glib::Threads::Mutex::Lock lm (source_lock);
736 for (SourceMap::iterator i = sources.begin(); i != sources.end(); ++i) {
737 DEBUG_TRACE(DEBUG::Destruction, string_compose ("Dropping for source %1 ; pre-ref = %2\n", i->second->name(), i->second.use_count()));
738 i->second->drop_references ();
744 /* not strictly necessary, but doing it here allows the shared_ptr debugging to work */
747 emit_thread_terminate ();
749 pthread_cond_destroy (&_rt_emit_cond);
750 pthread_mutex_destroy (&_rt_emit_mutex);
752 pthread_cond_destroy (&_auto_connect_cond);
753 pthread_mutex_destroy (&_auto_connect_mutex);
755 delete _scene_changer; _scene_changer = 0;
756 delete midi_control_ui; midi_control_ui = 0;
758 delete _mmc; _mmc = 0;
759 delete _midi_ports; _midi_ports = 0;
760 delete _locations; _locations = 0;
765 /* clear event queue, the session is gone, nobody is interested in
766 * those anymore, but they do leak memory if not removed
768 while (!immediate_events.empty ()) {
769 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
770 SessionEvent *ev = immediate_events.front ();
771 DEBUG_TRACE (DEBUG::SessionEvents, string_compose ("Drop event: %1\n", enum_2_string (ev->type)));
772 immediate_events.pop_front ();
776 case SessionEvent::AutoLoop:
777 case SessionEvent::AutoLoopDeclick:
778 case SessionEvent::Skip:
779 case SessionEvent::PunchIn:
780 case SessionEvent::PunchOut:
781 case SessionEvent::StopOnce:
782 case SessionEvent::RangeStop:
783 case SessionEvent::RangeLocate:
787 case SessionEvent::RealTimeOperation:
794 del = del && !_remove_event (ev);
801 DEBUG_TRACE (DEBUG::Destruction, "Session::destroy() done\n");
803 BOOST_SHOW_POINTERS ();
807 Session::setup_ltc ()
811 _ltc_input.reset (new IO (*this, X_("LTC In"), IO::Input));
812 _ltc_output.reset (new IO (*this, X_("LTC Out"), IO::Output));
814 if (state_tree && (child = find_named_node (*state_tree->root(), X_("LTC In"))) != 0) {
815 _ltc_input->set_state (*(child->children().front()), Stateful::loading_state_version);
818 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
819 _ltc_input->ensure_io (ChanCount (DataType::AUDIO, 1), true, this);
821 reconnect_ltc_input ();
824 if (state_tree && (child = find_named_node (*state_tree->root(), X_("LTC Out"))) != 0) {
825 _ltc_output->set_state (*(child->children().front()), Stateful::loading_state_version);
828 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
829 _ltc_output->ensure_io (ChanCount (DataType::AUDIO, 1), true, this);
831 reconnect_ltc_output ();
834 /* fix up names of LTC ports because we don't want the normal
835 * IO style of NAME/TYPE-{in,out}N
838 _ltc_input->nth (0)->set_name (X_("LTC-in"));
839 _ltc_output->nth (0)->set_name (X_("LTC-out"));
843 Session::setup_click ()
847 boost::shared_ptr<AutomationList> gl (new AutomationList (Evoral::Parameter (GainAutomation)));
848 boost::shared_ptr<GainControl> gain_control = boost::shared_ptr<GainControl> (new GainControl (*this, Evoral::Parameter(GainAutomation), gl));
850 _click_io.reset (new ClickIO (*this, X_("Click")));
851 _click_gain.reset (new Amp (*this, _("Fader"), gain_control, true));
852 _click_gain->activate ();
854 setup_click_state (state_tree->root());
856 setup_click_state (0);
861 Session::setup_click_state (const XMLNode* node)
863 const XMLNode* child = 0;
865 if (node && (child = find_named_node (*node, "Click")) != 0) {
867 /* existing state for Click */
870 if (Stateful::loading_state_version < 3000) {
871 c = _click_io->set_state_2X (*child->children().front(), Stateful::loading_state_version, false);
873 const XMLNodeList& children (child->children());
874 XMLNodeList::const_iterator i = children.begin();
875 if ((c = _click_io->set_state (**i, Stateful::loading_state_version)) == 0) {
877 if (i != children.end()) {
878 c = _click_gain->set_state (**i, Stateful::loading_state_version);
884 _clicking = Config->get_clicking ();
888 error << _("could not setup Click I/O") << endmsg;
895 /* default state for Click: dual-mono to first 2 physical outputs */
898 _engine.get_physical_outputs (DataType::AUDIO, outs);
900 for (uint32_t physport = 0; physport < 2; ++physport) {
901 if (outs.size() > physport) {
902 if (_click_io->add_port (outs[physport], this)) {
903 // relax, even though its an error
908 if (_click_io->n_ports () > ChanCount::ZERO) {
909 _clicking = Config->get_clicking ();
915 Session::get_physical_ports (vector<string>& inputs, vector<string>& outputs, DataType type,
916 MidiPortFlags include, MidiPortFlags exclude)
918 _engine.get_physical_inputs (type, inputs, include, exclude);
919 _engine.get_physical_outputs (type, outputs, include, exclude);
923 Session::setup_bundles ()
927 RCUWriter<BundleList> writer (_bundles);
928 boost::shared_ptr<BundleList> b = writer.get_copy ();
929 for (BundleList::iterator i = b->begin(); i != b->end();) {
930 if (boost::dynamic_pointer_cast<UserBundle>(*i)) {
938 vector<string> inputs[DataType::num_types];
939 vector<string> outputs[DataType::num_types];
941 for (uint32_t i = 0; i < DataType::num_types; ++i) {
942 get_physical_ports (inputs[i], outputs[i], DataType (DataType::Symbol (i)),
943 MidiPortFlags (0), /* no specific inclusions */
944 MidiPortFlags (MidiPortControl|MidiPortVirtual) /* exclude control & virtual ports */
948 /* Create a set of Bundle objects that map
949 to the physical I/O currently available. We create both
950 mono and stereo bundles, so that the common cases of mono
951 and stereo tracks get bundles to put in their mixer strip
952 in / out menus. There may be a nicer way of achieving that;
953 it doesn't really scale that well to higher channel counts
956 /* mono output bundles */
958 for (uint32_t np = 0; np < outputs[DataType::AUDIO].size(); ++np) {
960 std::string pn = _engine.get_pretty_name_by_name (outputs[DataType::AUDIO][np]);
962 snprintf (buf, sizeof (buf), _("out %s"), pn.c_str());
964 snprintf (buf, sizeof (buf), _("out %" PRIu32), np+1);
967 boost::shared_ptr<Bundle> c (new Bundle (buf, true));
968 c->add_channel (_("mono"), DataType::AUDIO);
969 c->set_port (0, outputs[DataType::AUDIO][np]);
971 add_bundle (c, false);
974 /* stereo output bundles */
976 for (uint32_t np = 0; np < outputs[DataType::AUDIO].size(); np += 2) {
977 if (np + 1 < outputs[DataType::AUDIO].size()) {
979 snprintf (buf, sizeof(buf), _("out %" PRIu32 "+%" PRIu32), np + 1, np + 2);
980 boost::shared_ptr<Bundle> c (new Bundle (buf, true));
981 c->add_channel (_("L"), DataType::AUDIO);
982 c->set_port (0, outputs[DataType::AUDIO][np]);
983 c->add_channel (_("R"), DataType::AUDIO);
984 c->set_port (1, outputs[DataType::AUDIO][np + 1]);
986 add_bundle (c, false);
990 /* mono input bundles */
992 for (uint32_t np = 0; np < inputs[DataType::AUDIO].size(); ++np) {
994 std::string pn = _engine.get_pretty_name_by_name (inputs[DataType::AUDIO][np]);
996 snprintf (buf, sizeof (buf), _("in %s"), pn.c_str());
998 snprintf (buf, sizeof (buf), _("in %" PRIu32), np+1);
1001 boost::shared_ptr<Bundle> c (new Bundle (buf, false));
1002 c->add_channel (_("mono"), DataType::AUDIO);
1003 c->set_port (0, inputs[DataType::AUDIO][np]);
1005 add_bundle (c, false);
1008 /* stereo input bundles */
1010 for (uint32_t np = 0; np < inputs[DataType::AUDIO].size(); np += 2) {
1011 if (np + 1 < inputs[DataType::AUDIO].size()) {
1013 snprintf (buf, sizeof(buf), _("in %" PRIu32 "+%" PRIu32), np + 1, np + 2);
1015 boost::shared_ptr<Bundle> c (new Bundle (buf, false));
1016 c->add_channel (_("L"), DataType::AUDIO);
1017 c->set_port (0, inputs[DataType::AUDIO][np]);
1018 c->add_channel (_("R"), DataType::AUDIO);
1019 c->set_port (1, inputs[DataType::AUDIO][np + 1]);
1021 add_bundle (c, false);
1025 /* MIDI input bundles */
1027 for (uint32_t np = 0; np < inputs[DataType::MIDI].size(); ++np) {
1028 string n = inputs[DataType::MIDI][np];
1030 std::string pn = _engine.get_pretty_name_by_name (n);
1034 boost::erase_first (n, X_("alsa_pcm:"));
1036 boost::shared_ptr<Bundle> c (new Bundle (n, false));
1037 c->add_channel ("", DataType::MIDI);
1038 c->set_port (0, inputs[DataType::MIDI][np]);
1039 add_bundle (c, false);
1042 /* MIDI output bundles */
1044 for (uint32_t np = 0; np < outputs[DataType::MIDI].size(); ++np) {
1045 string n = outputs[DataType::MIDI][np];
1046 std::string pn = _engine.get_pretty_name_by_name (n);
1050 boost::erase_first (n, X_("alsa_pcm:"));
1052 boost::shared_ptr<Bundle> c (new Bundle (n, true));
1053 c->add_channel ("", DataType::MIDI);
1054 c->set_port (0, outputs[DataType::MIDI][np]);
1055 add_bundle (c, false);
1058 // we trust the backend to only calls us if there's a change
1059 BundleAddedOrRemoved (); /* EMIT SIGNAL */
1063 Session::auto_connect_master_bus ()
1065 if (!_master_out || !Config->get_auto_connect_standard_busses() || _monitor_out) {
1069 // Waves Tracks: Do not connect master bas for Tracks if AutoConnectMaster option is not set
1070 // In this case it means "Multi Out" output mode
1071 if (ARDOUR::Profile->get_trx() && !(Config->get_output_auto_connect() & AutoConnectMaster) ) {
1075 /* if requested auto-connect the outputs to the first N physical ports.
1078 uint32_t limit = _master_out->n_outputs().n_total();
1079 vector<string> outputs[DataType::num_types];
1081 for (uint32_t i = 0; i < DataType::num_types; ++i) {
1082 _engine.get_physical_outputs (DataType (DataType::Symbol (i)), outputs[i]);
1085 for (uint32_t n = 0; n < limit; ++n) {
1086 boost::shared_ptr<Port> p = _master_out->output()->nth (n);
1088 if (outputs[p->type()].size() > n) {
1089 connect_to = outputs[p->type()][n];
1092 if (!connect_to.empty() && p->connected_to (connect_to) == false) {
1093 if (_master_out->output()->connect (p, connect_to, this)) {
1094 error << string_compose (_("cannot connect master output %1 to %2"), n, connect_to)
1103 Session::remove_monitor_section ()
1105 if (!_monitor_out || Profile->get_trx()) {
1109 /* force reversion to Solo-In-Place */
1110 Config->set_solo_control_is_listen_control (false);
1112 /* if we are auditioning, cancel it ... this is a workaround
1113 to a problem (auditioning does not execute the process graph,
1114 which is needed to remove routes when using >1 core for processing)
1119 /* Hold process lock while doing this so that we don't hear bits and
1120 * pieces of audio as we work on each route.
1123 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
1125 /* Connect tracks to monitor section. Note that in an
1126 existing session, the internal sends will already exist, but we want the
1127 routes to notice that they connect to the control out specifically.
1131 boost::shared_ptr<RouteList> r = routes.reader ();
1132 PBD::Unwinder<bool> uw (ignore_route_processor_changes, true);
1134 for (RouteList::iterator x = r->begin(); x != r->end(); ++x) {
1136 if ((*x)->is_monitor()) {
1138 } else if ((*x)->is_master()) {
1141 (*x)->remove_aux_or_listen (_monitor_out);
1146 remove_route (_monitor_out);
1147 if (_state_of_the_state & Deletion) {
1151 auto_connect_master_bus ();
1154 auditioner->connect ();
1157 Config->ParameterChanged ("use-monitor-bus");
1161 Session::add_monitor_section ()
1165 if (_monitor_out || !_master_out || Profile->get_trx()) {
1169 boost::shared_ptr<Route> r (new Route (*this, _("Monitor"), PresentationInfo::MonitorOut, DataType::AUDIO));
1175 BOOST_MARK_ROUTE(r);
1178 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
1179 r->input()->ensure_io (_master_out->output()->n_ports(), false, this);
1180 r->output()->ensure_io (_master_out->output()->n_ports(), false, this);
1182 error << _("Cannot create monitor section. 'Monitor' Port name is not unique.") << endmsg;
1187 add_routes (rl, false, false, false, 0);
1189 assert (_monitor_out);
1191 /* AUDIO ONLY as of june 29th 2009, because listen semantics for anything else
1192 are undefined, at best.
1195 uint32_t limit = _monitor_out->n_inputs().n_audio();
1199 /* connect the inputs to the master bus outputs. this
1200 * represents a separate data feed from the internal sends from
1201 * each route. as of jan 2011, it allows the monitor section to
1202 * conditionally ignore either the internal sends or the normal
1203 * input feed, but we should really find a better way to do
1207 _master_out->output()->disconnect (this);
1209 for (uint32_t n = 0; n < limit; ++n) {
1210 boost::shared_ptr<AudioPort> p = _monitor_out->input()->ports().nth_audio_port (n);
1211 boost::shared_ptr<AudioPort> o = _master_out->output()->ports().nth_audio_port (n);
1214 string connect_to = o->name();
1215 if (_monitor_out->input()->connect (p, connect_to, this)) {
1216 error << string_compose (_("cannot connect control input %1 to %2"), n, connect_to)
1224 /* if monitor section is not connected, connect it to physical outs
1227 if ((Config->get_auto_connect_standard_busses () || Profile->get_mixbus ()) && !_monitor_out->output()->connected ()) {
1229 if (!Config->get_monitor_bus_preferred_bundle().empty()) {
1231 boost::shared_ptr<Bundle> b = bundle_by_name (Config->get_monitor_bus_preferred_bundle());
1234 _monitor_out->output()->connect_ports_to_bundle (b, true, this);
1236 warning << string_compose (_("The preferred I/O for the monitor bus (%1) cannot be found"),
1237 Config->get_monitor_bus_preferred_bundle())
1243 /* Monitor bus is audio only */
1245 vector<string> outputs[DataType::num_types];
1247 for (uint32_t i = 0; i < DataType::num_types; ++i) {
1248 _engine.get_physical_outputs (DataType (DataType::Symbol (i)), outputs[i]);
1251 uint32_t mod = outputs[DataType::AUDIO].size();
1252 uint32_t limit = _monitor_out->n_outputs().get (DataType::AUDIO);
1256 for (uint32_t n = 0; n < limit; ++n) {
1258 boost::shared_ptr<Port> p = _monitor_out->output()->ports().port(DataType::AUDIO, n);
1260 if (outputs[DataType::AUDIO].size() > (n % mod)) {
1261 connect_to = outputs[DataType::AUDIO][n % mod];
1264 if (!connect_to.empty()) {
1265 if (_monitor_out->output()->connect (p, connect_to, this)) {
1266 error << string_compose (
1267 _("cannot connect control output %1 to %2"),
1278 /* Hold process lock while doing this so that we don't hear bits and
1279 * pieces of audio as we work on each route.
1282 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
1284 /* Connect tracks to monitor section. Note that in an
1285 existing session, the internal sends will already exist, but we want the
1286 routes to notice that they connect to the control out specifically.
1290 boost::shared_ptr<RouteList> rls = routes.reader ();
1292 PBD::Unwinder<bool> uw (ignore_route_processor_changes, true);
1294 for (RouteList::iterator x = rls->begin(); x != rls->end(); ++x) {
1296 if ((*x)->is_monitor()) {
1298 } else if ((*x)->is_master()) {
1301 (*x)->enable_monitor_send ();
1306 auditioner->connect ();
1308 Config->ParameterChanged ("use-monitor-bus");
1312 Session::reset_monitor_section ()
1314 /* Process lock should be held by the caller.*/
1316 if (!_monitor_out || Profile->get_trx()) {
1320 uint32_t limit = _master_out->n_outputs().n_audio();
1322 /* connect the inputs to the master bus outputs. this
1323 * represents a separate data feed from the internal sends from
1324 * each route. as of jan 2011, it allows the monitor section to
1325 * conditionally ignore either the internal sends or the normal
1326 * input feed, but we should really find a better way to do
1330 _master_out->output()->disconnect (this);
1331 _monitor_out->output()->disconnect (this);
1333 // monitor section follow master bus - except midi
1334 ChanCount mon_chn (_master_out->output()->n_ports());
1335 mon_chn.set_midi (0);
1337 _monitor_out->input()->ensure_io (mon_chn, false, this);
1338 _monitor_out->output()->ensure_io (mon_chn, false, this);
1340 for (uint32_t n = 0; n < limit; ++n) {
1341 boost::shared_ptr<AudioPort> p = _monitor_out->input()->ports().nth_audio_port (n);
1342 boost::shared_ptr<AudioPort> o = _master_out->output()->ports().nth_audio_port (n);
1345 string connect_to = o->name();
1346 if (_monitor_out->input()->connect (p, connect_to, this)) {
1347 error << string_compose (_("cannot connect control input %1 to %2"), n, connect_to)
1354 /* connect monitor section to physical outs
1357 if (Config->get_auto_connect_standard_busses()) {
1359 if (!Config->get_monitor_bus_preferred_bundle().empty()) {
1361 boost::shared_ptr<Bundle> b = bundle_by_name (Config->get_monitor_bus_preferred_bundle());
1364 _monitor_out->output()->connect_ports_to_bundle (b, true, this);
1366 warning << string_compose (_("The preferred I/O for the monitor bus (%1) cannot be found"),
1367 Config->get_monitor_bus_preferred_bundle())
1373 /* Monitor bus is audio only */
1375 vector<string> outputs[DataType::num_types];
1377 for (uint32_t i = 0; i < DataType::num_types; ++i) {
1378 _engine.get_physical_outputs (DataType (DataType::Symbol (i)), outputs[i]);
1381 uint32_t mod = outputs[DataType::AUDIO].size();
1382 uint32_t limit = _monitor_out->n_outputs().get (DataType::AUDIO);
1386 for (uint32_t n = 0; n < limit; ++n) {
1388 boost::shared_ptr<Port> p = _monitor_out->output()->ports().port(DataType::AUDIO, n);
1390 if (outputs[DataType::AUDIO].size() > (n % mod)) {
1391 connect_to = outputs[DataType::AUDIO][n % mod];
1394 if (!connect_to.empty()) {
1395 if (_monitor_out->output()->connect (p, connect_to, this)) {
1396 error << string_compose (
1397 _("cannot connect control output %1 to %2"),
1408 /* Connect tracks to monitor section. Note that in an
1409 existing session, the internal sends will already exist, but we want the
1410 routes to notice that they connect to the control out specifically.
1414 boost::shared_ptr<RouteList> rls = routes.reader ();
1416 PBD::Unwinder<bool> uw (ignore_route_processor_changes, true);
1418 for (RouteList::iterator x = rls->begin(); x != rls->end(); ++x) {
1420 if ((*x)->is_monitor()) {
1422 } else if ((*x)->is_master()) {
1425 (*x)->enable_monitor_send ();
1431 Session::hookup_io ()
1433 /* stop graph reordering notifications from
1434 causing resorts, etc.
1437 _state_of_the_state = StateOfTheState (_state_of_the_state | InitialConnecting);
1441 /* we delay creating the auditioner till now because
1442 it makes its own connections to ports.
1446 boost::shared_ptr<Auditioner> a (new Auditioner (*this));
1448 throw failed_constructor ();
1450 a->use_new_diskstream ();
1454 catch (failed_constructor& err) {
1455 warning << _("cannot create Auditioner: no auditioning of regions possible") << endmsg;
1459 /* load bundles, which we may have postponed earlier on */
1460 if (_bundle_xml_node) {
1461 load_bundles (*_bundle_xml_node);
1462 delete _bundle_xml_node;
1465 /* Tell all IO objects to connect themselves together */
1467 IO::enable_connecting ();
1469 /* Now tell all "floating" ports to connect to whatever
1470 they should be connected to.
1473 AudioEngine::instance()->reconnect_ports ();
1475 /* Anyone who cares about input state, wake up and do something */
1477 IOConnectionsComplete (); /* EMIT SIGNAL */
1479 _state_of_the_state = StateOfTheState (_state_of_the_state & ~InitialConnecting);
1481 /* now handle the whole enchilada as if it was one
1482 graph reorder event.
1487 /* update the full solo state, which can't be
1488 correctly determined on a per-route basis, but
1489 needs the global overview that only the session
1493 update_route_solo_state ();
1497 Session::track_playlist_changed (boost::weak_ptr<Track> wp)
1499 boost::shared_ptr<Track> track = wp.lock ();
1504 boost::shared_ptr<Playlist> playlist;
1506 if ((playlist = track->playlist()) != 0) {
1507 playlist->RegionAdded.connect_same_thread (*this, boost::bind (&Session::playlist_region_added, this, _1));
1508 playlist->RangesMoved.connect_same_thread (*this, boost::bind (&Session::playlist_ranges_moved, this, _1));
1509 playlist->RegionsExtended.connect_same_thread (*this, boost::bind (&Session::playlist_regions_extended, this, _1));
1514 Session::record_enabling_legal () const
1516 /* this used to be in here, but survey says.... we don't need to restrict it */
1517 // if (record_status() == Recording) {
1521 if (Config->get_all_safe()) {
1528 Session::set_track_monitor_input_status (bool yn)
1530 boost::shared_ptr<RouteList> rl = routes.reader ();
1531 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
1532 boost::shared_ptr<AudioTrack> tr = boost::dynamic_pointer_cast<AudioTrack> (*i);
1533 if (tr && tr->rec_enable_control()->get_value()) {
1534 //cerr << "switching to input = " << !auto_input << __FILE__ << __LINE__ << endl << endl;
1535 tr->request_input_monitoring (yn);
1541 Session::auto_punch_start_changed (Location* location)
1543 replace_event (SessionEvent::PunchIn, location->start());
1545 if (get_record_enabled() && config.get_punch_in()) {
1546 /* capture start has been changed, so save new pending state */
1547 save_state ("", true);
1552 Session::auto_punch_end_changed (Location* location)
1554 framepos_t when_to_stop = location->end();
1555 // when_to_stop += _worst_output_latency + _worst_input_latency;
1556 replace_event (SessionEvent::PunchOut, when_to_stop);
1560 Session::auto_punch_changed (Location* location)
1562 framepos_t when_to_stop = location->end();
1564 replace_event (SessionEvent::PunchIn, location->start());
1565 //when_to_stop += _worst_output_latency + _worst_input_latency;
1566 replace_event (SessionEvent::PunchOut, when_to_stop);
1569 /** @param loc A loop location.
1570 * @param pos Filled in with the start time of the required fade-out (in session frames).
1571 * @param length Filled in with the length of the required fade-out.
1574 Session::auto_loop_declick_range (Location* loc, framepos_t & pos, framepos_t & length)
1576 pos = max (loc->start(), loc->end() - 64);
1577 length = loc->end() - pos;
1581 Session::auto_loop_changed (Location* location)
1583 replace_event (SessionEvent::AutoLoop, location->end(), location->start());
1586 auto_loop_declick_range (location, dcp, dcl);
1588 if (transport_rolling() && play_loop) {
1590 replace_event (SessionEvent::AutoLoopDeclick, dcp, dcl);
1592 // if (_transport_frame > location->end()) {
1594 if (_transport_frame < location->start() || _transport_frame > location->end()) {
1595 // relocate to beginning of loop
1596 clear_events (SessionEvent::LocateRoll);
1598 request_locate (location->start(), true);
1601 else if (Config->get_seamless_loop() && !loop_changing) {
1603 // schedule a locate-roll to refill the diskstreams at the
1604 // previous loop end
1605 loop_changing = true;
1607 if (location->end() > last_loopend) {
1608 clear_events (SessionEvent::LocateRoll);
1609 SessionEvent *ev = new SessionEvent (SessionEvent::LocateRoll, SessionEvent::Add, last_loopend, last_loopend, 0, true);
1615 clear_events (SessionEvent::AutoLoopDeclick);
1616 clear_events (SessionEvent::AutoLoop);
1619 /* possibly move playhead if not rolling; if we are rolling we'll move
1620 to the loop start on stop if that is appropriate.
1625 if (!transport_rolling() && select_playhead_priority_target (pos)) {
1626 if (pos == location->start()) {
1627 request_locate (pos);
1632 last_loopend = location->end();
1637 Session::set_auto_punch_location (Location* location)
1641 if ((existing = _locations->auto_punch_location()) != 0 && existing != location) {
1642 punch_connections.drop_connections();
1643 existing->set_auto_punch (false, this);
1644 remove_event (existing->start(), SessionEvent::PunchIn);
1645 clear_events (SessionEvent::PunchOut);
1646 auto_punch_location_changed (0);
1651 if (location == 0) {
1655 if (location->end() <= location->start()) {
1656 error << _("Session: you can't use that location for auto punch (start <= end)") << endmsg;
1660 punch_connections.drop_connections ();
1662 location->StartChanged.connect_same_thread (punch_connections, boost::bind (&Session::auto_punch_start_changed, this, location));
1663 location->EndChanged.connect_same_thread (punch_connections, boost::bind (&Session::auto_punch_end_changed, this, location));
1664 location->Changed.connect_same_thread (punch_connections, boost::bind (&Session::auto_punch_changed, this, location));
1666 location->set_auto_punch (true, this);
1668 auto_punch_changed (location);
1670 auto_punch_location_changed (location);
1674 Session::set_session_extents (framepos_t start, framepos_t end)
1677 if ((existing = _locations->session_range_location()) == 0) {
1678 //if there is no existing session, we need to make a new session location (should never happen)
1679 existing = new Location (*this, 0, 0, _("session"), Location::IsSessionRange);
1683 error << _("Session: you can't use that location for session start/end)") << endmsg;
1687 existing->set( start, end );
1693 Session::set_auto_loop_location (Location* location)
1697 if ((existing = _locations->auto_loop_location()) != 0 && existing != location) {
1698 loop_connections.drop_connections ();
1699 existing->set_auto_loop (false, this);
1700 remove_event (existing->end(), SessionEvent::AutoLoop);
1703 auto_loop_declick_range (existing, dcp, dcl);
1704 remove_event (dcp, SessionEvent::AutoLoopDeclick);
1705 auto_loop_location_changed (0);
1710 if (location == 0) {
1714 if (location->end() <= location->start()) {
1715 error << _("You cannot use this location for auto-loop because it has zero or negative length") << endmsg;
1719 last_loopend = location->end();
1721 loop_connections.drop_connections ();
1723 location->StartChanged.connect_same_thread (loop_connections, boost::bind (&Session::auto_loop_changed, this, location));
1724 location->EndChanged.connect_same_thread (loop_connections, boost::bind (&Session::auto_loop_changed, this, location));
1725 location->Changed.connect_same_thread (loop_connections, boost::bind (&Session::auto_loop_changed, this, location));
1726 location->FlagsChanged.connect_same_thread (loop_connections, boost::bind (&Session::auto_loop_changed, this, location));
1728 location->set_auto_loop (true, this);
1730 if (Config->get_loop_is_mode() && play_loop && Config->get_seamless_loop()) {
1731 // set all tracks to use internal looping
1732 boost::shared_ptr<RouteList> rl = routes.reader ();
1733 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
1734 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
1735 if (tr && !tr->hidden()) {
1736 tr->set_loop (location);
1741 /* take care of our stuff first */
1743 auto_loop_changed (location);
1745 /* now tell everyone else */
1747 auto_loop_location_changed (location);
1751 Session::update_marks (Location*)
1757 Session::update_skips (Location* loc, bool consolidate)
1759 if (_ignore_skips_updates) {
1763 Locations::LocationList skips;
1766 PBD::Unwinder<bool> uw (_ignore_skips_updates, true);
1767 consolidate_skips (loc);
1770 sync_locations_to_skips ();
1776 Session::consolidate_skips (Location* loc)
1778 Locations::LocationList all_locations = _locations->list ();
1780 for (Locations::LocationList::iterator l = all_locations.begin(); l != all_locations.end(); ) {
1782 if (!(*l)->is_skip ()) {
1787 /* don't test against self */
1794 switch (Evoral::coverage ((*l)->start(), (*l)->end(), loc->start(), loc->end())) {
1795 case Evoral::OverlapInternal:
1796 case Evoral::OverlapExternal:
1797 case Evoral::OverlapStart:
1798 case Evoral::OverlapEnd:
1799 /* adjust new location to cover existing one */
1800 loc->set_start (min (loc->start(), (*l)->start()));
1801 loc->set_end (max (loc->end(), (*l)->end()));
1802 /* we don't need this one any more */
1803 _locations->remove (*l);
1804 /* the location has been deleted, so remove reference to it in our local list */
1805 l = all_locations.erase (l);
1808 case Evoral::OverlapNone:
1816 Session::sync_locations_to_skips ()
1818 /* This happens asynchronously (in the audioengine thread). After the clear is done, we will call
1819 * Session::_sync_locations_to_skips() from the audioengine thread.
1821 clear_events (SessionEvent::Skip, boost::bind (&Session::_sync_locations_to_skips, this));
1825 Session::_sync_locations_to_skips ()
1827 /* called as a callback after existing Skip events have been cleared from a realtime audioengine thread */
1829 Locations::LocationList const & locs (_locations->list());
1831 for (Locations::LocationList::const_iterator i = locs.begin(); i != locs.end(); ++i) {
1833 Location* location = *i;
1835 if (location->is_skip() && location->is_skipping()) {
1836 SessionEvent* ev = new SessionEvent (SessionEvent::Skip, SessionEvent::Add, location->start(), location->end(), 1.0);
1844 Session::location_added (Location *location)
1846 if (location->is_auto_punch()) {
1847 set_auto_punch_location (location);
1850 if (location->is_auto_loop()) {
1851 set_auto_loop_location (location);
1854 if (location->is_session_range()) {
1855 /* no need for any signal handling or event setting with the session range,
1856 because we keep a direct reference to it and use its start/end directly.
1858 _session_range_location = location;
1861 if (location->is_mark()) {
1862 /* listen for per-location signals that require us to do any * global updates for marks */
1864 location->StartChanged.connect_same_thread (skip_update_connections, boost::bind (&Session::update_marks, this, location));
1865 location->EndChanged.connect_same_thread (skip_update_connections, boost::bind (&Session::update_marks, this, location));
1866 location->Changed.connect_same_thread (skip_update_connections, boost::bind (&Session::update_marks, this, location));
1867 location->FlagsChanged.connect_same_thread (skip_update_connections, boost::bind (&Session::update_marks, this, location));
1870 if (location->is_skip()) {
1871 /* listen for per-location signals that require us to update skip-locate events */
1873 location->StartChanged.connect_same_thread (skip_update_connections, boost::bind (&Session::update_skips, this, location, true));
1874 location->EndChanged.connect_same_thread (skip_update_connections, boost::bind (&Session::update_skips, this, location, true));
1875 location->Changed.connect_same_thread (skip_update_connections, boost::bind (&Session::update_skips, this, location, true));
1876 location->FlagsChanged.connect_same_thread (skip_update_connections, boost::bind (&Session::update_skips, this, location, false));
1878 update_skips (location, true);
1885 Session::location_removed (Location *location)
1887 if (location->is_auto_loop()) {
1888 set_auto_loop_location (0);
1889 set_track_loop (false);
1892 if (location->is_auto_punch()) {
1893 set_auto_punch_location (0);
1896 if (location->is_session_range()) {
1897 /* this is never supposed to happen */
1898 error << _("programming error: session range removed!") << endl;
1901 if (location->is_skip()) {
1903 update_skips (location, false);
1910 Session::locations_changed ()
1912 _locations->apply (*this, &Session::_locations_changed);
1916 Session::_locations_changed (const Locations::LocationList& locations)
1918 /* There was some mass-change in the Locations object.
1920 We might be re-adding a location here but it doesn't actually matter
1921 for all the locations that the Session takes an interest in.
1925 PBD::Unwinder<bool> protect_ignore_skip_updates (_ignore_skips_updates, true);
1926 for (Locations::LocationList::const_iterator i = locations.begin(); i != locations.end(); ++i) {
1927 location_added (*i);
1931 update_skips (NULL, false);
1935 Session::enable_record ()
1937 if (_transport_speed != 0.0 && _transport_speed != 1.0) {
1938 /* no recording at anything except normal speed */
1943 RecordState rs = (RecordState) g_atomic_int_get (&_record_status);
1945 if (rs == Recording) {
1949 if (g_atomic_int_compare_and_exchange (&_record_status, rs, Recording)) {
1951 _last_record_location = _transport_frame;
1952 send_immediate_mmc (MIDI::MachineControlCommand (MIDI::MachineControl::cmdRecordStrobe));
1954 if (Config->get_monitoring_model() == HardwareMonitoring && config.get_auto_input()) {
1955 set_track_monitor_input_status (true);
1958 RecordStateChanged ();
1965 Session::set_all_tracks_record_enabled (bool enable )
1967 boost::shared_ptr<RouteList> rl = routes.reader();
1968 set_controls (route_list_to_control_list (rl, &Stripable::rec_enable_control), enable, Controllable::NoGroup);
1972 Session::disable_record (bool rt_context, bool force)
1976 if ((rs = (RecordState) g_atomic_int_get (&_record_status)) != Disabled) {
1978 if (!Config->get_latched_record_enable () || force) {
1979 g_atomic_int_set (&_record_status, Disabled);
1980 send_immediate_mmc (MIDI::MachineControlCommand (MIDI::MachineControl::cmdRecordExit));
1982 if (rs == Recording) {
1983 g_atomic_int_set (&_record_status, Enabled);
1987 if (Config->get_monitoring_model() == HardwareMonitoring && config.get_auto_input()) {
1988 set_track_monitor_input_status (false);
1991 RecordStateChanged (); /* emit signal */
1994 remove_pending_capture_state ();
2000 Session::step_back_from_record ()
2002 if (g_atomic_int_compare_and_exchange (&_record_status, Recording, Enabled)) {
2004 if (Config->get_monitoring_model() == HardwareMonitoring && config.get_auto_input()) {
2005 set_track_monitor_input_status (false);
2008 RecordStateChanged (); /* emit signal */
2013 Session::maybe_enable_record ()
2015 if (_step_editors > 0) {
2019 g_atomic_int_set (&_record_status, Enabled);
2021 /* This function is currently called from somewhere other than an RT thread.
2022 This save_state() call therefore doesn't impact anything. Doing it here
2023 means that we save pending state of which sources the next record will use,
2024 which gives us some chance of recovering from a crash during the record.
2027 save_state ("", true);
2029 if (_transport_speed) {
2030 if (!config.get_punch_in()) {
2034 send_immediate_mmc (MIDI::MachineControlCommand (MIDI::MachineControl::cmdRecordPause));
2035 RecordStateChanged (); /* EMIT SIGNAL */
2042 Session::audible_frame () const
2046 frameoffset_t offset = worst_playback_latency (); // - _engine.samples_since_cycle_start ();
2047 offset *= transport_speed ();
2049 if (synced_to_engine()) {
2050 /* Note: this is basically just sync-to-JACK */
2051 ret = _engine.transport_frame();
2053 ret = _transport_frame;
2056 if (transport_rolling()) {
2059 /* Check to see if we have passed the first guaranteed
2060 * audible frame past our last start position. if not,
2061 * return that last start point because in terms
2062 * of audible frames, we have not moved yet.
2064 * `Start position' in this context means the time we last
2065 * either started, located, or changed transport direction.
2068 if (_transport_speed > 0.0f) {
2070 if (!play_loop || !have_looped) {
2071 if (ret < _last_roll_or_reversal_location) {
2072 return _last_roll_or_reversal_location;
2076 Location *location = _locations->auto_loop_location();
2077 frameoffset_t lo = location->start() - ret;
2079 ret = location->end () - lo;
2083 } else if (_transport_speed < 0.0f) {
2085 /* XXX wot? no backward looping? */
2087 if (ret > _last_roll_or_reversal_location) {
2088 return _last_roll_or_reversal_location;
2093 return std::max ((framepos_t)0, ret);
2097 Session::set_frame_rate (framecnt_t frames_per_second)
2099 /** \fn void Session::set_frame_size(framecnt_t)
2100 the AudioEngine object that calls this guarantees
2101 that it will not be called while we are also in
2102 ::process(). Its fine to do things that block
2106 if (_base_frame_rate == 0) {
2107 _base_frame_rate = frames_per_second;
2109 else if (_base_frame_rate != frames_per_second && frames_per_second != _nominal_frame_rate) {
2110 NotifyAboutSampleRateMismatch (_base_frame_rate, frames_per_second);
2112 _nominal_frame_rate = frames_per_second;
2117 reset_write_sources (false);
2119 // XXX we need some equivalent to this, somehow
2120 // SndFileSource::setup_standard_crossfades (frames_per_second);
2124 /* XXX need to reset/reinstantiate all LADSPA plugins */
2128 Session::set_block_size (pframes_t nframes)
2130 /* the AudioEngine guarantees
2131 that it will not be called while we are also in
2132 ::process(). It is therefore fine to do things that block
2137 current_block_size = nframes;
2141 boost::shared_ptr<RouteList> r = routes.reader ();
2143 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
2144 (*i)->set_block_size (nframes);
2147 boost::shared_ptr<RouteList> rl = routes.reader ();
2148 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
2149 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
2151 tr->set_block_size (nframes);
2155 set_worst_io_latencies ();
2161 trace_terminal (boost::shared_ptr<Route> r1, boost::shared_ptr<Route> rbase)
2163 boost::shared_ptr<Route> r2;
2165 if (r1->feeds (rbase) && rbase->feeds (r1)) {
2166 info << string_compose(_("feedback loop setup between %1 and %2"), r1->name(), rbase->name()) << endmsg;
2170 /* make a copy of the existing list of routes that feed r1 */
2172 Route::FedBy existing (r1->fed_by());
2174 /* for each route that feeds r1, recurse, marking it as feeding
2178 for (Route::FedBy::iterator i = existing.begin(); i != existing.end(); ++i) {
2179 if (!(r2 = i->r.lock ())) {
2180 /* (*i) went away, ignore it */
2184 /* r2 is a route that feeds r1 which somehow feeds base. mark
2185 base as being fed by r2
2188 rbase->add_fed_by (r2, i->sends_only);
2192 /* 2nd level feedback loop detection. if r1 feeds or is fed by r2,
2196 if (r1->feeds (r2) && r2->feeds (r1)) {
2200 /* now recurse, so that we can mark base as being fed by
2201 all routes that feed r2
2204 trace_terminal (r2, rbase);
2211 Session::resort_routes ()
2213 /* don't do anything here with signals emitted
2214 by Routes during initial setup or while we
2215 are being destroyed.
2218 if (_state_of_the_state & (InitialConnecting | Deletion)) {
2222 if (_route_deletion_in_progress) {
2227 RCUWriter<RouteList> writer (routes);
2228 boost::shared_ptr<RouteList> r = writer.get_copy ();
2229 resort_routes_using (r);
2230 /* writer goes out of scope and forces update */
2234 if (DEBUG_ENABLED(DEBUG::Graph)) {
2235 boost::shared_ptr<RouteList> rl = routes.reader ();
2236 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
2237 DEBUG_TRACE (DEBUG::Graph, string_compose ("%1 fed by ...\n", (*i)->name()));
2239 const Route::FedBy& fb ((*i)->fed_by());
2241 for (Route::FedBy::const_iterator f = fb.begin(); f != fb.end(); ++f) {
2242 boost::shared_ptr<Route> sf = f->r.lock();
2244 DEBUG_TRACE (DEBUG::Graph, string_compose ("\t%1 (sends only ? %2)\n", sf->name(), f->sends_only));
2253 /** This is called whenever we need to rebuild the graph of how we will process
2255 * @param r List of routes, in any order.
2259 Session::resort_routes_using (boost::shared_ptr<RouteList> r)
2261 /* We are going to build a directed graph of our routes;
2262 this is where the edges of that graph are put.
2267 /* Go through all routes doing two things:
2269 * 1. Collect the edges of the route graph. Each of these edges
2270 * is a pair of routes, one of which directly feeds the other
2271 * either by a JACK connection or by an internal send.
2273 * 2. Begin the process of making routes aware of which other
2274 * routes directly or indirectly feed them. This information
2275 * is used by the solo code.
2278 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
2280 /* Clear out the route's list of direct or indirect feeds */
2281 (*i)->clear_fed_by ();
2283 for (RouteList::iterator j = r->begin(); j != r->end(); ++j) {
2285 bool via_sends_only;
2287 /* See if this *j feeds *i according to the current state of the JACK
2288 connections and internal sends.
2290 if ((*j)->direct_feeds_according_to_reality (*i, &via_sends_only)) {
2291 /* add the edge to the graph (part #1) */
2292 edges.add (*j, *i, via_sends_only);
2293 /* tell the route (for part #2) */
2294 (*i)->add_fed_by (*j, via_sends_only);
2299 /* Attempt a topological sort of the route graph */
2300 boost::shared_ptr<RouteList> sorted_routes = topological_sort (r, edges);
2302 if (sorted_routes) {
2303 /* We got a satisfactory topological sort, so there is no feedback;
2306 Note: the process graph rechain does not require a
2307 topologically-sorted list, but hey ho.
2309 if (_process_graph) {
2310 _process_graph->rechain (sorted_routes, edges);
2313 _current_route_graph = edges;
2315 /* Complete the building of the routes' lists of what directly
2316 or indirectly feeds them.
2318 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
2319 trace_terminal (*i, *i);
2322 *r = *sorted_routes;
2325 DEBUG_TRACE (DEBUG::Graph, "Routes resorted, order follows:\n");
2326 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
2327 DEBUG_TRACE (DEBUG::Graph, string_compose ("\t%1 presentation order %2\n", (*i)->name(), (*i)->presentation_info().order()));
2331 SuccessfulGraphSort (); /* EMIT SIGNAL */
2334 /* The topological sort failed, so we have a problem. Tell everyone
2335 and stick to the old graph; this will continue to be processed, so
2336 until the feedback is fixed, what is played back will not quite
2337 reflect what is actually connected. Note also that we do not
2338 do trace_terminal here, as it would fail due to an endless recursion,
2339 so the solo code will think that everything is still connected
2343 FeedbackDetected (); /* EMIT SIGNAL */
2348 /** Find a route name starting with \a base, maybe followed by the
2349 * lowest \a id. \a id will always be added if \a definitely_add_number
2350 * is true on entry; otherwise it will only be added if required
2351 * to make the name unique.
2353 * Names are constructed like e.g. "Audio 3" for base="Audio" and id=3.
2354 * The available route name with the lowest ID will be used, and \a id
2355 * will be set to the ID.
2357 * \return false if a route name could not be found, and \a track_name
2358 * and \a id do not reflect a free route name.
2361 Session::find_route_name (string const & base, uint32_t& id, string& name, bool definitely_add_number)
2363 /* the base may conflict with ports that do not belong to existing
2364 routes, but hidden objects like the click track. So check port names
2365 before anything else.
2368 for (vector<string>::const_iterator reserved = reserved_io_names.begin(); reserved != reserved_io_names.end(); ++reserved) {
2369 if (base == *reserved) {
2370 /* Check if this reserved name already exists, and if
2371 so, disallow it without a numeric suffix.
2373 if (route_by_name (*reserved)) {
2374 definitely_add_number = true;
2383 /* if we have "base 1" already, it doesn't make sense to add "base"
2384 * if "base 1" has been deleted, adding "base" is no worse than "base 1"
2386 if (!definitely_add_number && route_by_name (base) == 0 && (route_by_name (string_compose("%1 1", base)) == 0)) {
2387 /* just use the base */
2393 name = string_compose ("%1 %2", base, id);
2395 if (route_by_name (name) == 0) {
2401 } while (id < (UINT_MAX-1));
2406 /** Count the total ins and outs of all non-hidden tracks in the session and return them in in and out */
2408 Session::count_existing_track_channels (ChanCount& in, ChanCount& out)
2410 in = ChanCount::ZERO;
2411 out = ChanCount::ZERO;
2413 boost::shared_ptr<RouteList> r = routes.reader ();
2415 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
2416 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
2417 if (tr && !tr->is_auditioner()) {
2418 in += tr->n_inputs();
2419 out += tr->n_outputs();
2425 Session::default_track_name_pattern (DataType t)
2428 case DataType::AUDIO:
2429 if (Profile->get_trx()) {
2436 case DataType::MIDI:
2443 /** Caller must not hold process lock
2444 * @param name_template string to use for the start of the name, or "" to use "MIDI".
2445 * @param instrument plugin info for the instrument to insert pre-fader, if any
2447 list<boost::shared_ptr<MidiTrack> >
2448 Session::new_midi_track (const ChanCount& input, const ChanCount& output,
2449 boost::shared_ptr<PluginInfo> instrument, Plugin::PresetRecord* pset,
2450 RouteGroup* route_group, uint32_t how_many, string name_template, PresentationInfo::order_t order,
2454 uint32_t track_id = 0;
2456 RouteList new_routes;
2457 list<boost::shared_ptr<MidiTrack> > ret;
2459 const string name_pattern = default_track_name_pattern (DataType::MIDI);
2460 bool const use_number = (how_many != 1) || name_template.empty () || (name_template == name_pattern);
2463 if (!find_route_name (name_template.empty() ? _("MIDI") : name_template, ++track_id, track_name, use_number)) {
2464 error << "cannot find name for new midi track" << endmsg;
2468 boost::shared_ptr<MidiTrack> track;
2471 track.reset (new MidiTrack (*this, track_name, mode));
2473 if (track->init ()) {
2477 if (Profile->get_mixbus ()) {
2478 track->set_strict_io (true);
2481 track->use_new_diskstream();
2483 BOOST_MARK_TRACK (track);
2486 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
2487 if (track->input()->ensure_io (input, false, this)) {
2488 error << "cannot configure " << input << " out configuration for new midi track" << endmsg;
2492 if (track->output()->ensure_io (output, false, this)) {
2493 error << "cannot configure " << output << " out configuration for new midi track" << endmsg;
2498 track->non_realtime_input_change();
2501 route_group->add (track);
2504 track->DiskstreamChanged.connect_same_thread (*this, boost::bind (&Session::resort_routes, this));
2506 new_routes.push_back (track);
2507 ret.push_back (track);
2510 catch (failed_constructor &err) {
2511 error << _("Session: could not create new midi track.") << endmsg;
2515 catch (AudioEngine::PortRegistrationFailure& pfe) {
2517 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;
2525 if (!new_routes.empty()) {
2526 StateProtector sp (this);
2527 if (Profile->get_trx()) {
2528 add_routes (new_routes, false, false, false, order);
2530 add_routes (new_routes, true, true, false, order);
2534 for (RouteList::iterator r = new_routes.begin(); r != new_routes.end(); ++r) {
2535 PluginPtr plugin = instrument->load (*this);
2537 warning << "Failed to add Synth Plugin to newly created track." << endmsg;
2541 plugin->load_preset (*pset);
2543 boost::shared_ptr<Processor> p (new PluginInsert (*this, plugin));
2544 (*r)->add_processor (p, PreFader);
2553 Session::new_midi_route (RouteGroup* route_group, uint32_t how_many, string name_template, boost::shared_ptr<PluginInfo> instrument, Plugin::PresetRecord* pset,
2554 PresentationInfo::Flag flag, PresentationInfo::order_t order)
2557 uint32_t bus_id = 0;
2561 bool const use_number = (how_many != 1) || name_template.empty () || name_template == _("Midi Bus");
2564 if (!find_route_name (name_template.empty () ? _("Midi Bus") : name_template, ++bus_id, bus_name, use_number)) {
2565 error << "cannot find name for new midi bus" << endmsg;
2570 boost::shared_ptr<Route> bus (new Route (*this, bus_name, flag, DataType::AUDIO)); // XXX Editor::add_routes is not ready for ARDOUR::DataType::MIDI
2576 if (Profile->get_mixbus ()) {
2577 bus->set_strict_io (true);
2580 BOOST_MARK_ROUTE(bus);
2583 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
2585 if (bus->input()->ensure_io (ChanCount(DataType::MIDI, 1), false, this)) {
2586 error << _("cannot configure new midi bus input") << endmsg;
2591 if (bus->output()->ensure_io (ChanCount(DataType::MIDI, 1), false, this)) {
2592 error << _("cannot configure new midi bus output") << endmsg;
2598 route_group->add (bus);
2601 bus->add_internal_return ();
2602 ret.push_back (bus);
2605 catch (failed_constructor &err) {
2606 error << _("Session: could not create new audio route.") << endmsg;
2610 catch (AudioEngine::PortRegistrationFailure& pfe) {
2611 error << pfe.what() << endmsg;
2621 StateProtector sp (this);
2622 add_routes (ret, false, false, false, order);
2625 for (RouteList::iterator r = ret.begin(); r != ret.end(); ++r) {
2626 PluginPtr plugin = instrument->load (*this);
2628 warning << "Failed to add Synth Plugin to newly created track." << endmsg;
2632 plugin->load_preset (*pset);
2634 boost::shared_ptr<Processor> p (new PluginInsert (*this, plugin));
2635 (*r)->add_processor (p, PreFader);
2646 Session::midi_output_change_handler (IOChange change, void * /*src*/, boost::weak_ptr<Route> wmt)
2648 boost::shared_ptr<Route> midi_track (wmt.lock());
2654 if ((change.type & IOChange::ConfigurationChanged) && Config->get_output_auto_connect() != ManualConnect) {
2656 if (change.after.n_audio() <= change.before.n_audio()) {
2660 /* new audio ports: make sure the audio goes somewhere useful,
2661 * unless the user has no-auto-connect selected.
2663 * The existing ChanCounts don't matter for this call as they are only
2664 * to do with matching input and output indices, and we are only changing
2667 auto_connect_route (midi_track, false, ChanCount(), change.before);
2671 #ifdef USE_TRACKS_CODE_FEATURES
2674 compare_routes_by_remote_id (const boost::shared_ptr<Route>& route1, const boost::shared_ptr<Route>& route2)
2676 return route1->remote_control_id() < route2->remote_control_id();
2680 Session::reconnect_existing_routes (bool withLock, bool reconnect_master, bool reconnect_inputs, bool reconnect_outputs)
2682 // it is not allowed to perform connection
2683 if (!IO::connecting_legal) {
2687 // if we are deleting routes we will call this once at the end
2688 if (_route_deletion_in_progress) {
2692 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock (), Glib::Threads::NOT_LOCK);
2698 // We need to disconnect the route's inputs and outputs first
2699 // basing on autoconnect configuration
2700 bool reconnectIputs = !(Config->get_input_auto_connect() & ManualConnect) && reconnect_inputs;
2701 bool reconnectOutputs = !(Config->get_output_auto_connect() & ManualConnect) && reconnect_outputs;
2703 ChanCount existing_inputs;
2704 ChanCount existing_outputs;
2705 count_existing_track_channels (existing_inputs, existing_outputs);
2707 //ChanCount inputs = ChanCount::ZERO;
2708 //ChanCount outputs = ChanCount::ZERO;
2710 RouteList existing_routes = *routes.reader ();
2711 existing_routes.sort (compare_routes_by_remote_id);
2714 PBD::Unwinder<bool> protect_ignore_changes (_reconnecting_routes_in_progress, true);
2716 vector<string> physinputs;
2717 vector<string> physoutputs;
2719 EngineStateController::instance()->get_physical_audio_outputs(physoutputs);
2720 EngineStateController::instance()->get_physical_audio_inputs(physinputs);
2722 uint32_t input_n = 0;
2723 uint32_t output_n = 0;
2724 RouteList::iterator rIter = existing_routes.begin();
2725 const AutoConnectOption current_input_auto_connection (Config->get_input_auto_connect());
2726 const AutoConnectOption current_output_auto_connection (Config->get_output_auto_connect());
2727 for (; rIter != existing_routes.end(); ++rIter) {
2728 if (*rIter == _master_out || *rIter == _monitor_out ) {
2732 if (current_output_auto_connection == AutoConnectPhysical) {
2733 (*rIter)->amp()->deactivate();
2734 } else if (current_output_auto_connection == AutoConnectMaster) {
2735 (*rIter)->amp()->activate();
2738 if (reconnectIputs) {
2739 (*rIter)->input()->disconnect (this); //GZ: check this; could be heavy
2741 for (uint32_t route_input_n = 0; route_input_n < (*rIter)->n_inputs().get(DataType::AUDIO); ++route_input_n) {
2743 if (current_input_auto_connection & AutoConnectPhysical) {
2745 if ( input_n == physinputs.size() ) {
2749 string port = physinputs[input_n];
2751 if (port.empty() ) {
2752 error << "Physical Input number "<< input_n << " is unavailable and cannot be connected" << endmsg;
2755 //GZ: check this; could be heavy
2756 (*rIter)->input()->connect ((*rIter)->input()->ports().port(DataType::AUDIO, route_input_n), port, this);
2762 if (reconnectOutputs) {
2764 //normalize route ouptuts: reduce the amount outputs to be equal to the amount of inputs
2765 if (current_output_auto_connection & AutoConnectPhysical) {
2767 //GZ: check this; could be heavy
2768 (*rIter)->output()->disconnect (this);
2769 size_t route_inputs_count = (*rIter)->n_inputs().get(DataType::AUDIO);
2771 //GZ: check this; could be heavy
2772 (*rIter)->output()->ensure_io(ChanCount(DataType::AUDIO, route_inputs_count), false, this );
2774 } else if (current_output_auto_connection & AutoConnectMaster){
2776 if (!reconnect_master) {
2780 //GZ: check this; could be heavy
2781 (*rIter)->output()->disconnect (this);
2784 uint32_t master_inputs_count = _master_out->n_inputs().get(DataType::AUDIO);
2785 (*rIter)->output()->ensure_io(ChanCount(DataType::AUDIO, master_inputs_count), false, this );
2787 error << error << "Master bus is not available" << endmsg;
2792 for (uint32_t route_output_n = 0; route_output_n < (*rIter)->n_outputs().get(DataType::AUDIO); ++route_output_n) {
2793 if (current_output_auto_connection & AutoConnectPhysical) {
2795 if ( output_n == physoutputs.size() ) {
2799 string port = physoutputs[output_n];
2801 if (port.empty() ) {
2802 error << "Physical Output number "<< output_n << " is unavailable and cannot be connected" << endmsg;
2805 //GZ: check this; could be heavy
2806 (*rIter)->output()->connect ((*rIter)->output()->ports().port(DataType::AUDIO, route_output_n), port, this);
2809 } else if (current_output_auto_connection & AutoConnectMaster) {
2811 if ( route_output_n == _master_out->n_inputs().get(DataType::AUDIO) ) {
2815 // connect to master bus
2816 string port = _master_out->input()->ports().port(DataType::AUDIO, route_output_n)->name();
2818 if (port.empty() ) {
2819 error << "MasterBus Input number "<< route_output_n << " is unavailable and cannot be connected" << endmsg;
2823 //GZ: check this; could be heavy
2824 (*rIter)->output()->connect ((*rIter)->output()->ports().port(DataType::AUDIO, route_output_n), port, this);
2831 _master_out->output()->disconnect (this);
2832 auto_connect_master_bus ();
2837 session_routes_reconnected (); /* EMIT SIGNAL */
2841 Session::reconnect_midi_scene_ports(bool inputs)
2845 boost::shared_ptr<MidiPort> scene_in_ptr = scene_in();
2847 scene_in_ptr->disconnect_all ();
2849 std::vector<EngineStateController::MidiPortState> midi_port_states;
2850 EngineStateController::instance()->get_physical_midi_input_states (midi_port_states);
2852 std::vector<EngineStateController::MidiPortState>::iterator state_iter = midi_port_states.begin();
2854 for (; state_iter != midi_port_states.end(); ++state_iter) {
2855 if (state_iter->active && state_iter->available && state_iter->scene_connected) {
2856 scene_in_ptr->connect (state_iter->name);
2863 boost::shared_ptr<MidiPort> scene_out_ptr = scene_out();
2865 if (scene_out_ptr ) {
2866 scene_out_ptr->disconnect_all ();
2868 std::vector<EngineStateController::MidiPortState> midi_port_states;
2869 EngineStateController::instance()->get_physical_midi_output_states (midi_port_states);
2871 std::vector<EngineStateController::MidiPortState>::iterator state_iter = midi_port_states.begin();
2873 for (; state_iter != midi_port_states.end(); ++state_iter) {
2874 if (state_iter->active && state_iter->available && state_iter->scene_connected) {
2875 scene_out_ptr->connect (state_iter->name);
2883 Session::reconnect_mtc_ports ()
2885 boost::shared_ptr<MidiPort> mtc_in_ptr = _midi_ports->mtc_input_port();
2891 mtc_in_ptr->disconnect_all ();
2893 std::vector<EngineStateController::MidiPortState> midi_port_states;
2894 EngineStateController::instance()->get_physical_midi_input_states (midi_port_states);
2896 std::vector<EngineStateController::MidiPortState>::iterator state_iter = midi_port_states.begin();
2898 for (; state_iter != midi_port_states.end(); ++state_iter) {
2899 if (state_iter->available && state_iter->mtc_in) {
2900 mtc_in_ptr->connect (state_iter->name);
2904 if (!_midi_ports->mtc_input_port ()->connected () &&
2905 config.get_external_sync () &&
2906 (Config->get_sync_source () == MTC) ) {
2907 config.set_external_sync (false);
2910 if ( ARDOUR::Profile->get_trx () ) {
2911 // Tracks need this signal to update timecode_source_dropdown
2912 MtcOrLtcInputPortChanged (); //emit signal
2917 Session::reconnect_mmc_ports(bool inputs)
2919 if (inputs ) { // get all enabled midi input ports
2921 boost::shared_ptr<MidiPort> mmc_in_ptr = _midi_ports->mmc_in();
2923 mmc_in_ptr->disconnect_all ();
2924 std::vector<std::string> enabled_midi_inputs;
2925 EngineStateController::instance()->get_physical_midi_inputs (enabled_midi_inputs);
2927 std::vector<std::string>::iterator port_iter = enabled_midi_inputs.begin();
2929 for (; port_iter != enabled_midi_inputs.end(); ++port_iter) {
2930 mmc_in_ptr->connect (*port_iter);
2934 } else { // get all enabled midi output ports
2936 boost::shared_ptr<MidiPort> mmc_out_ptr = _midi_ports->mmc_out();
2938 mmc_out_ptr->disconnect_all ();
2939 std::vector<std::string> enabled_midi_outputs;
2940 EngineStateController::instance()->get_physical_midi_outputs (enabled_midi_outputs);
2942 std::vector<std::string>::iterator port_iter = enabled_midi_outputs.begin();
2944 for (; port_iter != enabled_midi_outputs.end(); ++port_iter) {
2945 mmc_out_ptr->connect (*port_iter);
2954 Session::ensure_route_presentation_info_gap (PresentationInfo::order_t first_new_order, uint32_t how_many)
2956 if (first_new_order == PresentationInfo::max_order) {
2957 /* adding at end, no worries */
2961 /* create a gap in the presentation info to accomodate @param how_many
2965 get_stripables (sl);
2967 for (StripableList::iterator si = sl.begin(); si != sl.end(); ++si) {
2968 boost::shared_ptr<Stripable> s (*si);
2970 if (s->is_monitor() || s->is_auditioner()) {
2974 if (s->presentation_info().order () >= first_new_order) {
2975 s->set_presentation_order (s->presentation_info().order () + how_many);
2980 /** Caller must not hold process lock
2981 * @param name_template string to use for the start of the name, or "" to use "Audio".
2983 list< boost::shared_ptr<AudioTrack> >
2984 Session::new_audio_track (int input_channels, int output_channels, RouteGroup* route_group,
2985 uint32_t how_many, string name_template, PresentationInfo::order_t order,
2989 uint32_t track_id = 0;
2991 RouteList new_routes;
2992 list<boost::shared_ptr<AudioTrack> > ret;
2994 const string name_pattern = default_track_name_pattern (DataType::AUDIO);
2995 bool const use_number = (how_many != 1) || name_template.empty () || (name_template == name_pattern);
2999 if (!find_route_name (name_template.empty() ? _(name_pattern.c_str()) : name_template, ++track_id, track_name, use_number)) {
3000 error << "cannot find name for new audio track" << endmsg;
3004 boost::shared_ptr<AudioTrack> track;
3007 track.reset (new AudioTrack (*this, track_name, mode));
3009 if (track->init ()) {
3013 if (Profile->get_mixbus ()) {
3014 track->set_strict_io (true);
3017 if (ARDOUR::Profile->get_trx ()) {
3018 // TRACKS considers it's not a USE CASE, it's
3019 // a piece of behavior of the session model:
3021 // Gain for a newly created route depends on
3022 // the current output_auto_connect mode:
3024 // 0 for Stereo Out mode
3026 if (Config->get_output_auto_connect() & AutoConnectMaster) {
3027 track->gain_control()->set_value (dB_to_coefficient (0), Controllable::NoGroup);
3031 track->use_new_diskstream();
3033 BOOST_MARK_TRACK (track);
3036 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
3038 if (track->input()->ensure_io (ChanCount(DataType::AUDIO, input_channels), false, this)) {
3039 error << string_compose (
3040 _("cannot configure %1 in/%2 out configuration for new audio track"),
3041 input_channels, output_channels)
3046 if (track->output()->ensure_io (ChanCount(DataType::AUDIO, output_channels), false, this)) {
3047 error << string_compose (
3048 _("cannot configure %1 in/%2 out configuration for new audio track"),
3049 input_channels, output_channels)
3056 route_group->add (track);
3059 track->non_realtime_input_change();
3061 track->DiskstreamChanged.connect_same_thread (*this, boost::bind (&Session::resort_routes, this));
3063 new_routes.push_back (track);
3064 ret.push_back (track);
3067 catch (failed_constructor &err) {
3068 error << _("Session: could not create new audio track.") << endmsg;
3072 catch (AudioEngine::PortRegistrationFailure& pfe) {
3074 error << pfe.what() << endmsg;
3082 if (!new_routes.empty()) {
3083 StateProtector sp (this);
3084 if (Profile->get_trx()) {
3085 add_routes (new_routes, false, false, false, order);
3087 add_routes (new_routes, true, true, false, order);
3094 /** Caller must not hold process lock.
3095 * @param name_template string to use for the start of the name, or "" to use "Bus".
3098 Session::new_audio_route (int input_channels, int output_channels, RouteGroup* route_group, uint32_t how_many, string name_template,
3099 PresentationInfo::Flag flags, PresentationInfo::order_t order)
3102 uint32_t bus_id = 0;
3106 bool const use_number = (how_many != 1) || name_template.empty () || name_template == _("Bus");
3109 if (!find_route_name (name_template.empty () ? _("Bus") : name_template, ++bus_id, bus_name, use_number)) {
3110 error << "cannot find name for new audio bus" << endmsg;
3115 boost::shared_ptr<Route> bus (new Route (*this, bus_name, flags, DataType::AUDIO));
3121 if (Profile->get_mixbus ()) {
3122 bus->set_strict_io (true);
3125 BOOST_MARK_ROUTE(bus);
3128 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
3130 if (bus->input()->ensure_io (ChanCount(DataType::AUDIO, input_channels), false, this)) {
3131 error << string_compose (_("cannot configure %1 in/%2 out configuration for new audio track"),
3132 input_channels, output_channels)
3138 if (bus->output()->ensure_io (ChanCount(DataType::AUDIO, output_channels), false, this)) {
3139 error << string_compose (_("cannot configure %1 in/%2 out configuration for new audio track"),
3140 input_channels, output_channels)
3147 route_group->add (bus);
3150 bus->add_internal_return ();
3151 ret.push_back (bus);
3154 catch (failed_constructor &err) {
3155 error << _("Session: could not create new audio route.") << endmsg;
3159 catch (AudioEngine::PortRegistrationFailure& pfe) {
3160 error << pfe.what() << endmsg;
3170 StateProtector sp (this);
3171 if (Profile->get_trx()) {
3172 add_routes (ret, false, false, false, order);
3174 add_routes (ret, false, true, true, order); // autoconnect // outputs only
3183 Session::new_route_from_template (uint32_t how_many, PresentationInfo::order_t insert_at, const std::string& template_path, const std::string& name_base,
3184 PlaylistDisposition pd)
3188 if (!tree.read (template_path.c_str())) {
3192 return new_route_from_template (how_many, insert_at, *tree.root(), name_base, pd);
3196 Session::new_route_from_template (uint32_t how_many, PresentationInfo::order_t insert_at, XMLNode& node, const std::string& name_base, PlaylistDisposition pd)
3199 uint32_t number = 0;
3200 const uint32_t being_added = how_many;
3201 /* This will prevent the use of any existing XML-provided PBD::ID
3204 Stateful::ForceIDRegeneration force_ids;
3205 IO::disable_connecting ();
3209 /* We're going to modify the node contents a bit so take a
3210 * copy. The node may be re-used when duplicating more than once.
3213 XMLNode node_copy (node);
3218 if (!name_base.empty()) {
3220 /* if we're adding more than one routes, force
3221 * all the names of the new routes to be
3222 * numbered, via the final parameter.
3225 if (!find_route_name (name_base.c_str(), ++number, name, (being_added > 1))) {
3226 fatal << _("Session: UINT_MAX routes? impossible!") << endmsg;
3232 string const route_name = node_copy.property(X_("name"))->value ();
3234 /* generate a new name by adding a number to the end of the template name */
3235 if (!find_route_name (route_name.c_str(), ++number, name, true)) {
3236 fatal << _("Session: UINT_MAX routes? impossible!") << endmsg;
3237 abort(); /*NOTREACHED*/
3241 /* set this name in the XML description that we are about to use */
3243 bool rename_playlist;
3246 rename_playlist = true;
3251 rename_playlist = false;
3254 Route::set_name_in_state (node_copy, name, rename_playlist);
3256 /* trim bitslots from listen sends so that new ones are used */
3257 XMLNodeList children = node_copy.children ();
3258 for (XMLNodeList::iterator i = children.begin(); i != children.end(); ++i) {
3259 if ((*i)->name() == X_("Processor")) {
3260 /* ForceIDRegeneration does not catch the following */
3261 XMLProperty const * role = (*i)->property (X_("role"));
3262 XMLProperty const * type = (*i)->property (X_("type"));
3263 if (role && role->value() == X_("Aux")) {
3264 /* check if the target bus exists.
3265 * we should not save aux-sends in templates.
3267 XMLProperty const * target = (*i)->property (X_("target"));
3269 (*i)->add_property ("type", "dangling-aux-send");
3272 boost::shared_ptr<Route> r = route_by_id (target->value());
3273 if (!r || boost::dynamic_pointer_cast<Track>(r)) {
3274 (*i)->add_property ("type", "dangling-aux-send");
3278 if (role && role->value() == X_("Listen")) {
3279 (*i)->remove_property (X_("bitslot"));
3281 else if (role && (role->value() == X_("Send") || role->value() == X_("Aux"))) {
3283 Delivery::Role xrole;
3284 uint32_t bitslot = 0;
3285 xrole = Delivery::Role (string_2_enum (role->value(), xrole));
3286 std::string name = Send::name_and_id_new_send(*this, xrole, bitslot, false);
3287 snprintf (buf, sizeof (buf), "%" PRIu32, bitslot);
3288 (*i)->remove_property (X_("bitslot"));
3289 (*i)->remove_property (X_("name"));
3290 (*i)->add_property ("bitslot", buf);
3291 (*i)->add_property ("name", name);
3293 else if (type && type->value() == X_("intreturn")) {
3294 (*i)->remove_property (X_("bitslot"));
3295 (*i)->add_property ("ignore-bitslot", "1");
3297 else if (type && type->value() == X_("return")) {
3298 // Return::set_state() generates a new one
3299 (*i)->remove_property (X_("bitslot"));
3301 else if (type && type->value() == X_("port")) {
3302 // PortInsert::set_state() handles the bitslot
3303 (*i)->remove_property (X_("bitslot"));
3304 (*i)->add_property ("ignore-name", "1");
3309 boost::shared_ptr<Route> route (XMLRouteFactory (node_copy, 3000));
3312 error << _("Session: cannot create track/bus from template description") << endmsg;
3316 if (boost::dynamic_pointer_cast<Track>(route)) {
3317 /* force input/output change signals so that the new diskstream
3318 picks up the configuration of the route. During session
3319 loading this normally happens in a different way.
3322 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
3324 IOChange change (IOChange::Type (IOChange::ConfigurationChanged | IOChange::ConnectionsChanged));
3325 change.after = route->input()->n_ports();
3326 route->input()->changed (change, this);
3327 change.after = route->output()->n_ports();
3328 route->output()->changed (change, this);
3331 boost::shared_ptr<Track> track;
3333 if ((track = boost::dynamic_pointer_cast<Track> (route))) {
3336 track->use_new_playlist ();
3339 track->use_copy_playlist ();
3346 ret.push_back (route);
3349 catch (failed_constructor &err) {
3350 error << _("Session: could not create new route from template") << endmsg;
3354 catch (AudioEngine::PortRegistrationFailure& pfe) {
3355 error << pfe.what() << endmsg;
3364 StateProtector sp (this);
3365 if (Profile->get_trx()) {
3366 add_routes (ret, false, false, false, insert_at);
3368 add_routes (ret, true, true, false, insert_at);
3370 IO::enable_connecting ();
3377 Session::add_routes (RouteList& new_routes, bool input_auto_connect, bool output_auto_connect, bool save, PresentationInfo::order_t order)
3380 PBD::Unwinder<bool> aip (_adding_routes_in_progress, true);
3381 add_routes_inner (new_routes, input_auto_connect, output_auto_connect, order);
3384 error << _("Adding new tracks/busses failed") << endmsg;
3389 update_latency (true);
3390 update_latency (false);
3395 save_state (_current_snapshot_name);
3398 update_route_record_state ();
3400 RouteAdded (new_routes); /* EMIT SIGNAL */
3404 Session::add_routes_inner (RouteList& new_routes, bool input_auto_connect, bool output_auto_connect, PresentationInfo::order_t order)
3406 ChanCount existing_inputs;
3407 ChanCount existing_outputs;
3411 count_existing_track_channels (existing_inputs, existing_outputs);
3414 RCUWriter<RouteList> writer (routes);
3415 boost::shared_ptr<RouteList> r = writer.get_copy ();
3416 r->insert (r->end(), new_routes.begin(), new_routes.end());
3417 n_routes = r->size();
3419 /* if there is no control out and we're not in the middle of loading,
3420 * resort the graph here. if there is a control out, we will resort
3421 * toward the end of this method. if we are in the middle of loading,
3422 * we will resort when done.
3425 if (!_monitor_out && IO::connecting_legal) {
3426 resort_routes_using (r);
3430 DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("ensure order gap starting at %1 for %2\n", order, new_routes.size()));
3431 ensure_route_presentation_info_gap (order, new_routes.size());
3433 for (RouteList::iterator x = new_routes.begin(); x != new_routes.end(); ++x, ++added) {
3435 boost::weak_ptr<Route> wpr (*x);
3436 boost::shared_ptr<Route> r (*x);
3438 r->solo_control()->Changed.connect_same_thread (*this, boost::bind (&Session::route_solo_changed, this, _1, _2,wpr));
3439 r->solo_isolate_control()->Changed.connect_same_thread (*this, boost::bind (&Session::route_solo_isolated_changed, this, wpr));
3440 r->mute_control()->Changed.connect_same_thread (*this, boost::bind (&Session::route_mute_changed, this));
3442 r->output()->changed.connect_same_thread (*this, boost::bind (&Session::set_worst_io_latencies_x, this, _1, _2));
3443 r->processors_changed.connect_same_thread (*this, boost::bind (&Session::route_processors_changed, this, _1));
3444 r->processor_latency_changed.connect_same_thread (*this, boost::bind (&Session::queue_latency_recompute, this));
3446 if (r->is_master()) {
3450 if (r->is_monitor()) {
3454 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (r);
3456 tr->PlaylistChanged.connect_same_thread (*this, boost::bind (&Session::track_playlist_changed, this, boost::weak_ptr<Track> (tr)));
3457 track_playlist_changed (boost::weak_ptr<Track> (tr));
3458 tr->rec_enable_control()->Changed.connect_same_thread (*this, boost::bind (&Session::update_route_record_state, this));
3460 boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (tr);
3462 mt->StepEditStatusChange.connect_same_thread (*this, boost::bind (&Session::step_edit_status_change, this, _1));
3463 mt->output()->changed.connect_same_thread (*this, boost::bind (&Session::midi_output_change_handler, this, _1, _2, boost::weak_ptr<Route>(mt)));
3464 mt->presentation_info().PropertyChanged.connect_same_thread (*this, boost::bind (&Session::midi_track_presentation_info_changed, this, _1, boost::weak_ptr<MidiTrack>(mt)));
3468 if (!r->presentation_info().special()) {
3470 DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("checking PI state for %1\n", r->name()));
3472 /* presentation info order may already have been set from XML */
3474 if (!r->presentation_info().order_set()) {
3476 if (order == PresentationInfo::max_order) {
3477 /* just add to the end */
3478 r->set_presentation_order (n_routes + added, false);
3479 DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("group order not set, set to NR %1 + %2 = %3\n", n_routes, added, n_routes + added));
3481 r->set_presentation_order (order + added);
3482 DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("group order not set, set to %1 + %2 = %3\n", order, added, order + added));
3485 DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("group order already set to %1\n", r->presentation_info().order()));
3489 #if !defined(__APPLE__) && !defined(__FreeBSD__)
3490 /* clang complains: 'operator<<' should be declared prior to the call site or in an associated namespace of one of its
3491 * arguments std::ostream& operator<<(std::ostream& o, ARDOUR::PresentationInfo const& rid)"
3493 DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("added route %1, group order %2 type %3 (summary: %4)\n",
3495 r->presentation_info().order(),
3496 enum_2_string (r->presentation_info().flags()),
3497 r->presentation_info()));
3501 if (input_auto_connect || output_auto_connect) {
3502 auto_connect_route (r, input_auto_connect, ChanCount (), ChanCount (), existing_inputs, existing_outputs);
3503 existing_inputs += r->n_inputs();
3504 existing_outputs += r->n_outputs();
3510 if (_monitor_out && IO::connecting_legal) {
3511 Glib::Threads::Mutex::Lock lm (_engine.process_lock());
3513 for (RouteList::iterator x = new_routes.begin(); x != new_routes.end(); ++x) {
3514 if ((*x)->is_monitor()) {
3516 } else if ((*x)->is_master()) {
3519 (*x)->enable_monitor_send ();
3524 reassign_track_numbers ();
3528 Session::globally_set_send_gains_to_zero (boost::shared_ptr<Route> dest)
3530 boost::shared_ptr<RouteList> r = routes.reader ();
3531 boost::shared_ptr<Send> s;
3533 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3534 if ((s = (*i)->internal_send_for (dest)) != 0) {
3535 s->amp()->gain_control()->set_value (GAIN_COEFF_ZERO, Controllable::NoGroup);
3541 Session::globally_set_send_gains_to_unity (boost::shared_ptr<Route> dest)
3543 boost::shared_ptr<RouteList> r = routes.reader ();
3544 boost::shared_ptr<Send> s;
3546 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3547 if ((s = (*i)->internal_send_for (dest)) != 0) {
3548 s->amp()->gain_control()->set_value (GAIN_COEFF_UNITY, Controllable::NoGroup);
3554 Session::globally_set_send_gains_from_track(boost::shared_ptr<Route> dest)
3556 boost::shared_ptr<RouteList> r = routes.reader ();
3557 boost::shared_ptr<Send> s;
3559 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3560 if ((s = (*i)->internal_send_for (dest)) != 0) {
3561 s->amp()->gain_control()->set_value ((*i)->gain_control()->get_value(), Controllable::NoGroup);
3566 /** @param include_buses true to add sends to buses and tracks, false for just tracks */
3568 Session::globally_add_internal_sends (boost::shared_ptr<Route> dest, Placement p, bool include_buses)
3570 boost::shared_ptr<RouteList> r = routes.reader ();
3571 boost::shared_ptr<RouteList> t (new RouteList);
3573 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3574 /* no MIDI sends because there are no MIDI busses yet */
3575 if (include_buses || boost::dynamic_pointer_cast<AudioTrack>(*i)) {
3580 add_internal_sends (dest, p, t);
3584 Session::add_internal_sends (boost::shared_ptr<Route> dest, Placement p, boost::shared_ptr<RouteList> senders)
3586 for (RouteList::iterator i = senders->begin(); i != senders->end(); ++i) {
3587 add_internal_send (dest, (*i)->before_processor_for_placement (p), *i);
3592 Session::add_internal_send (boost::shared_ptr<Route> dest, int index, boost::shared_ptr<Route> sender)
3594 add_internal_send (dest, sender->before_processor_for_index (index), sender);
3598 Session::add_internal_send (boost::shared_ptr<Route> dest, boost::shared_ptr<Processor> before, boost::shared_ptr<Route> sender)
3600 if (sender->is_monitor() || sender->is_master() || sender == dest || dest->is_monitor() || dest->is_master()) {
3604 if (!dest->internal_return()) {
3605 dest->add_internal_return ();
3608 sender->add_aux_send (dest, before);
3614 Session::remove_routes (boost::shared_ptr<RouteList> routes_to_remove)
3616 { // RCU Writer scope
3617 PBD::Unwinder<bool> uw_flag (_route_deletion_in_progress, true);
3618 RCUWriter<RouteList> writer (routes);
3619 boost::shared_ptr<RouteList> rs = writer.get_copy ();
3622 for (RouteList::iterator iter = routes_to_remove->begin(); iter != routes_to_remove->end(); ++iter) {
3624 if (*iter == _master_out) {
3628 (*iter)->solo_control()->set_value (0.0, Controllable::NoGroup);
3632 /* deleting the master out seems like a dumb
3633 idea, but its more of a UI policy issue
3637 if (*iter == _master_out) {
3638 _master_out = boost::shared_ptr<Route> ();
3641 if (*iter == _monitor_out) {
3642 _monitor_out.reset ();
3645 // We need to disconnect the route's inputs and outputs
3647 (*iter)->input()->disconnect (0);
3648 (*iter)->output()->disconnect (0);
3650 /* if the route had internal sends sending to it, remove them */
3651 if ((*iter)->internal_return()) {
3653 boost::shared_ptr<RouteList> r = routes.reader ();
3654 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3655 boost::shared_ptr<Send> s = (*i)->internal_send_for (*iter);
3657 (*i)->remove_processor (s);
3662 /* if the monitoring section had a pointer to this route, remove it */
3663 if (_monitor_out && !(*iter)->is_master() && !(*iter)->is_monitor()) {
3664 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
3665 PBD::Unwinder<bool> uw (ignore_route_processor_changes, true);
3666 (*iter)->remove_aux_or_listen (_monitor_out);
3669 boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (*iter);
3670 if (mt && mt->step_editing()) {
3671 if (_step_editors > 0) {
3677 /* writer goes out of scope, forces route list update */
3679 } // end of RCU Writer scope
3681 update_route_solo_state ();
3682 update_latency_compensation ();
3685 /* Re-sort routes to remove the graph's current references to the one that is
3686 * going away, then flush old references out of the graph.
3687 * Wave Tracks: reconnect routes
3690 #ifdef USE_TRACKS_CODE_FEATURES
3691 reconnect_existing_routes(true, false);
3693 routes.flush (); // maybe unsafe, see below.
3697 if (_process_graph && !(_state_of_the_state & Deletion)) {
3698 _process_graph->clear_other_chain ();
3701 /* get rid of it from the dead wood collection in the route list manager */
3702 /* XXX i think this is unsafe as it currently stands, but i am not sure. (pd, october 2nd, 2006) */
3706 /* try to cause everyone to drop their references
3707 * and unregister ports from the backend
3710 for (RouteList::iterator iter = routes_to_remove->begin(); iter != routes_to_remove->end(); ++iter) {
3711 cerr << "Drop references to " << (*iter)->name() << endl;
3712 (*iter)->drop_references ();
3715 if (_state_of_the_state & Deletion) {
3719 PresentationInfo::Change(); /* EMIT SIGNAL */
3721 /* save the new state of the world */
3723 if (save_state (_current_snapshot_name)) {
3724 save_history (_current_snapshot_name);
3727 update_route_record_state ();
3731 Session::remove_route (boost::shared_ptr<Route> route)
3733 boost::shared_ptr<RouteList> rl (new RouteList);
3734 rl->push_back (route);
3739 Session::route_mute_changed ()
3745 Session::route_listen_changed (Controllable::GroupControlDisposition group_override, boost::weak_ptr<Route> wpr)
3747 boost::shared_ptr<Route> route (wpr.lock());
3753 assert (Config->get_solo_control_is_listen_control());
3755 if (route->solo_control()->soloed_by_self_or_masters()) {
3757 if (Config->get_exclusive_solo()) {
3759 RouteGroup* rg = route->route_group ();
3760 const bool group_already_accounted_for = (group_override == Controllable::ForGroup);
3762 boost::shared_ptr<RouteList> r = routes.reader ();
3764 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3765 if ((*i) == route) {
3766 /* already changed */
3770 if ((*i)->solo_isolate_control()->solo_isolated() || !(*i)->can_solo()) {
3771 /* route does not get solo propagated to it */
3775 if ((group_already_accounted_for && (*i)->route_group() && (*i)->route_group() == rg)) {
3776 /* this route is a part of the same solo group as the route
3777 * that was changed. Changing that route did change or will
3778 * change all group members appropriately, so we can ignore it
3783 (*i)->solo_control()->set_value (0.0, Controllable::NoGroup);
3789 } else if (_listen_cnt > 0) {
3796 Session::route_solo_isolated_changed (boost::weak_ptr<Route> wpr)
3798 boost::shared_ptr<Route> route (wpr.lock());
3804 bool send_changed = false;
3806 if (route->solo_isolate_control()->solo_isolated()) {
3807 if (_solo_isolated_cnt == 0) {
3808 send_changed = true;
3810 _solo_isolated_cnt++;
3811 } else if (_solo_isolated_cnt > 0) {
3812 _solo_isolated_cnt--;
3813 if (_solo_isolated_cnt == 0) {
3814 send_changed = true;
3819 IsolatedChanged (); /* EMIT SIGNAL */
3824 Session::route_solo_changed (bool self_solo_changed, Controllable::GroupControlDisposition group_override, boost::weak_ptr<Route> wpr)
3826 DEBUG_TRACE (DEBUG::Solo, string_compose ("route solo change, self = %1, update\n", self_solo_changed));
3828 boost::shared_ptr<Route> route (wpr.lock());
3834 if (Config->get_solo_control_is_listen_control()) {
3835 route_listen_changed (group_override, wpr);
3839 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()));
3841 if (route->solo_control()->transitioned_into_solo() == 0) {
3842 /* route solo changed by upstream/downstream; not interesting
3845 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()));
3849 if (route->solo_control()->transitioned_into_solo() == 0) {
3850 /* reason for being soloed changed (e.g. master went away, we
3851 * took over the master state), but actual status did
3852 * not. nothing to do.
3854 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1: solo change was change in reason, not status\n", route->name()));
3857 boost::shared_ptr<RouteList> r = routes.reader ();
3858 int32_t delta = route->solo_control()->transitioned_into_solo ();
3860 /* the route may be a member of a group that has shared-solo
3861 * semantics. If so, then all members of that group should follow the
3862 * solo of the changed route. But ... this is optional, controlled by a
3863 * Controllable::GroupControlDisposition.
3865 * The first argument to the signal that this method is connected to is the
3866 * GroupControlDisposition value that was used to change solo.
3868 * If the solo change was done with group semantics (either InverseGroup
3869 * (force the entire group to change even if the group shared solo is
3870 * disabled) or UseGroup (use the group, which may or may not have the
3871 * shared solo property enabled)) then as we propagate the change to
3872 * the entire session we should IGNORE THE GROUP that the changed route
3876 RouteGroup* rg = route->route_group ();
3877 const bool group_already_accounted_for = (group_override == Controllable::ForGroup);
3879 DEBUG_TRACE (DEBUG::Solo, string_compose ("propagate to session, group accounted for ? %1\n", group_already_accounted_for));
3881 if (delta == 1 && Config->get_exclusive_solo()) {
3883 /* new solo: disable all other solos, but not the group if its solo-enabled */
3885 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3887 if ((*i) == route) {
3888 /* already changed */
3892 if ((*i)->solo_isolate_control()->solo_isolated() || !(*i)->can_solo()) {
3893 /* route does not get solo propagated to it */
3897 if ((group_already_accounted_for && (*i)->route_group() && (*i)->route_group() == rg)) {
3898 /* this route is a part of the same solo group as the route
3899 * that was changed. Changing that route did change or will
3900 * change all group members appropriately, so we can ignore it
3906 (*i)->solo_control()->set_value (0.0, group_override);
3910 DEBUG_TRACE (DEBUG::Solo, string_compose ("propagate solo change, delta = %1\n", delta));
3912 RouteList uninvolved;
3914 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1\n", route->name()));
3916 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3917 bool via_sends_only;
3918 bool in_signal_flow;
3920 if ((*i) == route) {
3921 /* already changed */
3925 if ((*i)->solo_isolate_control()->solo_isolated() || !(*i)->can_solo()) {
3926 /* route does not get solo propagated to it */
3927 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1 excluded from solo because iso = %2 can_solo = %3\n", (*i)->name(), (*i)->solo_isolate_control()->solo_isolated(),
3932 if ((group_already_accounted_for && (*i)->route_group() && (*i)->route_group() == rg)) {
3933 /* this route is a part of the same solo group as the route
3934 * that was changed. Changing that route did change or will
3935 * change all group members appropriately, so we can ignore it
3941 in_signal_flow = false;
3943 DEBUG_TRACE (DEBUG::Solo, string_compose ("check feed from %1\n", (*i)->name()));
3945 if ((*i)->feeds (route, &via_sends_only)) {
3946 DEBUG_TRACE (DEBUG::Solo, string_compose ("\tthere is a feed from %1\n", (*i)->name()));
3947 if (!via_sends_only) {
3948 if (!route->soloed_by_others_upstream()) {
3949 (*i)->solo_control()->mod_solo_by_others_downstream (delta);
3951 DEBUG_TRACE (DEBUG::Solo, "\talready soloed by others upstream\n");
3954 DEBUG_TRACE (DEBUG::Solo, string_compose ("\tthere is a send-only feed from %1\n", (*i)->name()));
3956 in_signal_flow = true;
3958 DEBUG_TRACE (DEBUG::Solo, string_compose ("\tno feed from %1\n", (*i)->name()));
3961 DEBUG_TRACE (DEBUG::Solo, string_compose ("check feed to %1\n", (*i)->name()));
3963 if (route->feeds (*i, &via_sends_only)) {
3964 /* propagate solo upstream only if routing other than
3965 sends is involved, but do consider the other route
3966 (*i) to be part of the signal flow even if only
3969 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1 feeds %2 via sends only %3 sboD %4 sboU %5\n",
3973 route->soloed_by_others_downstream(),
3974 route->soloed_by_others_upstream()));
3975 if (!via_sends_only) {
3976 //NB. Triggers Invert Push, which handles soloed by downstream
3977 DEBUG_TRACE (DEBUG::Solo, string_compose ("\tmod %1 by %2\n", (*i)->name(), delta));
3978 (*i)->solo_control()->mod_solo_by_others_upstream (delta);
3980 DEBUG_TRACE (DEBUG::Solo, string_compose ("\tfeed to %1 ignored, sends-only\n", (*i)->name()));
3982 in_signal_flow = true;
3984 DEBUG_TRACE (DEBUG::Solo, "\tno feed to\n");
3987 if (!in_signal_flow) {
3988 uninvolved.push_back (*i);
3992 DEBUG_TRACE (DEBUG::Solo, "propagation complete\n");
3994 /* now notify that the mute state of the routes not involved in the signal
3995 pathway of the just-solo-changed route may have altered.
3998 for (RouteList::iterator i = uninvolved.begin(); i != uninvolved.end(); ++i) {
3999 DEBUG_TRACE (DEBUG::Solo, string_compose ("mute change for %1, which neither feeds or is fed by %2\n", (*i)->name(), route->name()));
4000 (*i)->act_on_mute ();
4001 /* Session will emit SoloChanged() after all solo changes are
4002 * complete, which should be used by UIs to update mute status
4008 Session::update_route_solo_state (boost::shared_ptr<RouteList> r)
4010 /* now figure out if anything that matters is soloed (or is "listening")*/
4012 bool something_soloed = false;
4013 bool something_listening = false;
4014 uint32_t listeners = 0;
4015 uint32_t isolated = 0;
4018 r = routes.reader();
4021 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4022 if ((*i)->can_solo()) {
4023 if (Config->get_solo_control_is_listen_control()) {
4024 if ((*i)->solo_control()->soloed_by_self_or_masters()) {
4026 something_listening = true;
4029 (*i)->set_listen (false);
4030 if ((*i)->can_solo() && (*i)->solo_control()->soloed_by_self_or_masters()) {
4031 something_soloed = true;
4036 if ((*i)->solo_isolate_control()->solo_isolated()) {
4041 if (something_soloed != _non_soloed_outs_muted) {
4042 _non_soloed_outs_muted = something_soloed;
4043 SoloActive (_non_soloed_outs_muted); /* EMIT SIGNAL */
4046 if (something_listening != _listening) {
4047 _listening = something_listening;
4048 SoloActive (_listening);
4051 _listen_cnt = listeners;
4053 if (isolated != _solo_isolated_cnt) {
4054 _solo_isolated_cnt = isolated;
4055 IsolatedChanged (); /* EMIT SIGNAL */
4058 DEBUG_TRACE (DEBUG::Solo, string_compose ("solo state updated by session, soloed? %1 listeners %2 isolated %3\n",
4059 something_soloed, listeners, isolated));
4062 SoloChanged (); /* EMIT SIGNAL */
4067 Session::get_stripables (StripableList& sl) const
4069 boost::shared_ptr<RouteList> r = routes.reader ();
4070 sl.insert (sl.end(), r->begin(), r->end());
4072 VCAList v = _vca_manager->vcas ();
4073 sl.insert (sl.end(), v.begin(), v.end());
4076 boost::shared_ptr<RouteList>
4077 Session::get_routes_with_internal_returns() const
4079 boost::shared_ptr<RouteList> r = routes.reader ();
4080 boost::shared_ptr<RouteList> rl (new RouteList);
4082 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4083 if ((*i)->internal_return ()) {
4091 Session::io_name_is_legal (const std::string& name) const
4093 boost::shared_ptr<RouteList> r = routes.reader ();
4095 for (vector<string>::const_iterator reserved = reserved_io_names.begin(); reserved != reserved_io_names.end(); ++reserved) {
4096 if (name == *reserved) {
4097 if (!route_by_name (*reserved)) {
4098 /* first instance of a reserved name is allowed */
4101 /* all other instances of a reserved name are not allowed */
4106 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4107 if ((*i)->name() == name) {
4111 if ((*i)->has_io_processor_named (name)) {
4120 Session::set_exclusive_input_active (boost::shared_ptr<RouteList> rl, bool onoff, bool flip_others)
4123 vector<string> connections;
4125 /* if we are passed only a single route and we're not told to turn
4126 * others off, then just do the simple thing.
4129 if (flip_others == false && rl->size() == 1) {
4130 boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (rl->front());
4132 mt->set_input_active (onoff);
4137 for (RouteList::iterator rt = rl->begin(); rt != rl->end(); ++rt) {
4139 PortSet& ps ((*rt)->input()->ports());
4141 for (PortSet::iterator p = ps.begin(); p != ps.end(); ++p) {
4142 p->get_connections (connections);
4145 for (vector<string>::iterator s = connections.begin(); s != connections.end(); ++s) {
4146 routes_using_input_from (*s, rl2);
4149 /* scan all relevant routes to see if others are on or off */
4151 bool others_are_already_on = false;
4153 for (RouteList::iterator r = rl2.begin(); r != rl2.end(); ++r) {
4155 boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (*r);
4161 if ((*r) != (*rt)) {
4162 if (mt->input_active()) {
4163 others_are_already_on = true;
4166 /* this one needs changing */
4167 mt->set_input_active (onoff);
4173 /* globally reverse other routes */
4175 for (RouteList::iterator r = rl2.begin(); r != rl2.end(); ++r) {
4176 if ((*r) != (*rt)) {
4177 boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (*r);
4179 mt->set_input_active (!others_are_already_on);
4188 Session::routes_using_input_from (const string& str, RouteList& rl)
4190 boost::shared_ptr<RouteList> r = routes.reader();
4192 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4193 if ((*i)->input()->connected_to (str)) {
4199 boost::shared_ptr<Route>
4200 Session::route_by_name (string name) const
4202 boost::shared_ptr<RouteList> r = routes.reader ();
4204 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4205 if ((*i)->name() == name) {
4210 return boost::shared_ptr<Route> ((Route*) 0);
4213 boost::shared_ptr<Route>
4214 Session::route_by_id (PBD::ID id) const
4216 boost::shared_ptr<RouteList> r = routes.reader ();
4218 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4219 if ((*i)->id() == id) {
4224 return boost::shared_ptr<Route> ((Route*) 0);
4227 boost::shared_ptr<Processor>
4228 Session::processor_by_id (PBD::ID id) const
4230 boost::shared_ptr<RouteList> r = routes.reader ();
4232 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4233 boost::shared_ptr<Processor> p = (*i)->Route::processor_by_id (id);
4239 return boost::shared_ptr<Processor> ();
4242 boost::shared_ptr<Track>
4243 Session::track_by_diskstream_id (PBD::ID id) const
4245 boost::shared_ptr<RouteList> r = routes.reader ();
4247 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4248 boost::shared_ptr<Track> t = boost::dynamic_pointer_cast<Track> (*i);
4249 if (t && t->using_diskstream_id (id)) {
4254 return boost::shared_ptr<Track> ();
4257 boost::shared_ptr<Route>
4258 Session::get_remote_nth_route (PresentationInfo::order_t n) const
4260 return boost::dynamic_pointer_cast<Route> (get_remote_nth_stripable (n, PresentationInfo::Route));
4263 boost::shared_ptr<Stripable>
4264 Session::get_remote_nth_stripable (PresentationInfo::order_t n, PresentationInfo::Flag flags) const
4267 PresentationInfo::order_t match_cnt = 0;
4269 get_stripables (sl);
4270 sl.sort (Stripable::PresentationOrderSorter());
4272 for (StripableList::const_iterator s = sl.begin(); s != sl.end(); ++s) {
4274 if ((*s)->presentation_info().hidden()) {
4275 /* if the caller didn't explicitly ask for hidden
4276 stripables, ignore hidden ones. This matches
4277 the semantics of the pre-PresentationOrder
4278 "get by RID" logic of Ardour 4.x and earlier.
4280 XXX at some point we should likely reverse
4281 the logic of the flags, because asking for "the
4282 hidden stripables" is not going to be common,
4283 whereas asking for visible ones is normal.
4286 if (! (flags & PresentationInfo::Hidden)) {
4291 if ((*s)->presentation_info().flag_match (flags)) {
4292 if (match_cnt++ == n) {
4298 /* there is no nth stripable that matches the given flags */
4299 return boost::shared_ptr<Stripable>();
4302 boost::shared_ptr<Route>
4303 Session::route_by_selected_count (uint32_t id) const
4305 boost::shared_ptr<RouteList> r = routes.reader ();
4307 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4308 /* NOT IMPLEMENTED */
4311 return boost::shared_ptr<Route> ((Route*) 0);
4314 struct PresentationOrderSorter {
4315 bool operator() (boost::shared_ptr<Stripable> a, boost::shared_ptr<Stripable> b) {
4316 if (a->presentation_info().special() && !b->presentation_info().special()) {
4317 /* a is not ordered, b is; b comes before a */
4319 } else if (!b->presentation_info().order_set() && a->presentation_info().order_set()) {
4320 /* b is not ordered, a is; a comes before b */
4323 return a->presentation_info().order() < b->presentation_info().order();
4329 Session::reassign_track_numbers ()
4333 RouteList r (*(routes.reader ()));
4334 PresentationOrderSorter sorter;
4337 StateProtector sp (this);
4339 for (RouteList::iterator i = r.begin(); i != r.end(); ++i) {
4340 if (boost::dynamic_pointer_cast<Track> (*i)) {
4341 (*i)->set_track_number(++tn);
4343 else if (!(*i)->is_master() && !(*i)->is_monitor() && !(*i)->is_auditioner()) {
4344 (*i)->set_track_number(--bn);
4347 const uint32_t decimals = ceilf (log10f (tn + 1));
4348 const bool decimals_changed = _track_number_decimals != decimals;
4349 _track_number_decimals = decimals;
4351 if (decimals_changed && config.get_track_name_number ()) {
4352 for (RouteList::iterator i = r.begin(); i != r.end(); ++i) {
4353 boost::shared_ptr<Track> t = boost::dynamic_pointer_cast<Track> (*i);
4355 t->resync_track_name();
4358 // trigger GUI re-layout
4359 config.ParameterChanged("track-name-number");
4363 if (DEBUG_ENABLED(DEBUG::OrderKeys)) {
4364 boost::shared_ptr<RouteList> rl = routes.reader ();
4365 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
4366 DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("%1 numbered %2\n", (*i)->name(), (*i)->track_number()));
4374 Session::playlist_region_added (boost::weak_ptr<Region> w)
4376 boost::shared_ptr<Region> r = w.lock ();
4381 /* These are the operations that are currently in progress... */
4382 list<GQuark> curr = _current_trans_quarks;
4385 /* ...and these are the operations during which we want to update
4386 the session range location markers.
4389 ops.push_back (Operations::capture);
4390 ops.push_back (Operations::paste);
4391 ops.push_back (Operations::duplicate_region);
4392 ops.push_back (Operations::insert_file);
4393 ops.push_back (Operations::insert_region);
4394 ops.push_back (Operations::drag_region_brush);
4395 ops.push_back (Operations::region_drag);
4396 ops.push_back (Operations::selection_grab);
4397 ops.push_back (Operations::region_fill);
4398 ops.push_back (Operations::fill_selection);
4399 ops.push_back (Operations::create_region);
4400 ops.push_back (Operations::region_copy);
4401 ops.push_back (Operations::fixed_time_region_copy);
4404 /* See if any of the current operations match the ones that we want */
4406 set_intersection (_current_trans_quarks.begin(), _current_trans_quarks.end(), ops.begin(), ops.end(), back_inserter (in));
4408 /* If so, update the session range markers */
4410 maybe_update_session_range (r->position (), r->last_frame ());
4414 /** Update the session range markers if a is before the current start or
4415 * b is after the current end.
4418 Session::maybe_update_session_range (framepos_t a, framepos_t b)
4420 if (_state_of_the_state & Loading) {
4424 framepos_t session_end_marker_shift_samples = session_end_shift * _nominal_frame_rate;
4426 if (_session_range_location == 0) {
4428 set_session_range_location (a, b + session_end_marker_shift_samples);
4432 if (a < _session_range_location->start()) {
4433 _session_range_location->set_start (a);
4436 if (_session_range_end_is_free && (b > _session_range_location->end())) {
4437 _session_range_location->set_end (b);
4443 Session::set_end_is_free (bool yn)
4445 _session_range_end_is_free = yn;
4449 Session::playlist_ranges_moved (list<Evoral::RangeMove<framepos_t> > const & ranges)
4451 for (list<Evoral::RangeMove<framepos_t> >::const_iterator i = ranges.begin(); i != ranges.end(); ++i) {
4452 maybe_update_session_range (i->to, i->to + i->length);
4457 Session::playlist_regions_extended (list<Evoral::Range<framepos_t> > const & ranges)
4459 for (list<Evoral::Range<framepos_t> >::const_iterator i = ranges.begin(); i != ranges.end(); ++i) {
4460 maybe_update_session_range (i->from, i->to);
4464 /* Region management */
4466 boost::shared_ptr<Region>
4467 Session::find_whole_file_parent (boost::shared_ptr<Region const> child) const
4469 const RegionFactory::RegionMap& regions (RegionFactory::regions());
4470 RegionFactory::RegionMap::const_iterator i;
4471 boost::shared_ptr<Region> region;
4473 Glib::Threads::Mutex::Lock lm (region_lock);
4475 for (i = regions.begin(); i != regions.end(); ++i) {
4479 if (region->whole_file()) {
4481 if (child->source_equivalent (region)) {
4487 return boost::shared_ptr<Region> ();
4491 Session::destroy_sources (list<boost::shared_ptr<Source> > srcs)
4493 set<boost::shared_ptr<Region> > relevant_regions;
4495 for (list<boost::shared_ptr<Source> >::iterator s = srcs.begin(); s != srcs.end(); ++s) {
4496 RegionFactory::get_regions_using_source (*s, relevant_regions);
4499 for (set<boost::shared_ptr<Region> >::iterator r = relevant_regions.begin(); r != relevant_regions.end(); ) {
4500 set<boost::shared_ptr<Region> >::iterator tmp;
4505 playlists->destroy_region (*r);
4506 RegionFactory::map_remove (*r);
4508 (*r)->drop_sources ();
4509 (*r)->drop_references ();
4511 relevant_regions.erase (r);
4516 for (list<boost::shared_ptr<Source> >::iterator s = srcs.begin(); s != srcs.end(); ) {
4519 Glib::Threads::Mutex::Lock ls (source_lock);
4520 /* remove from the main source list */
4521 sources.erase ((*s)->id());
4524 (*s)->mark_for_remove ();
4525 (*s)->drop_references ();
4534 Session::remove_last_capture ()
4536 list<boost::shared_ptr<Source> > srcs;
4538 boost::shared_ptr<RouteList> rl = routes.reader ();
4539 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
4540 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
4545 list<boost::shared_ptr<Source> >& l = tr->last_capture_sources();
4548 srcs.insert (srcs.end(), l.begin(), l.end());
4553 destroy_sources (srcs);
4555 save_state (_current_snapshot_name);
4560 /* Source Management */
4563 Session::add_source (boost::shared_ptr<Source> source)
4565 pair<SourceMap::key_type, SourceMap::mapped_type> entry;
4566 pair<SourceMap::iterator,bool> result;
4568 entry.first = source->id();
4569 entry.second = source;
4572 Glib::Threads::Mutex::Lock lm (source_lock);
4573 result = sources.insert (entry);
4576 if (result.second) {
4578 /* yay, new source */
4580 boost::shared_ptr<FileSource> fs = boost::dynamic_pointer_cast<FileSource> (source);
4583 if (!fs->within_session()) {
4584 ensure_search_path_includes (Glib::path_get_dirname (fs->path()), fs->type());
4590 boost::shared_ptr<AudioFileSource> afs;
4592 if ((afs = boost::dynamic_pointer_cast<AudioFileSource>(source)) != 0) {
4593 if (Config->get_auto_analyse_audio()) {
4594 Analyser::queue_source_for_analysis (source, false);
4598 source->DropReferences.connect_same_thread (*this, boost::bind (&Session::remove_source, this, boost::weak_ptr<Source> (source)));
4603 Session::remove_source (boost::weak_ptr<Source> src)
4605 if (_state_of_the_state & Deletion) {
4609 SourceMap::iterator i;
4610 boost::shared_ptr<Source> source = src.lock();
4617 Glib::Threads::Mutex::Lock lm (source_lock);
4619 if ((i = sources.find (source->id())) != sources.end()) {
4624 if (!(_state_of_the_state & StateOfTheState (InCleanup|Loading))) {
4626 /* save state so we don't end up with a session file
4627 referring to non-existent sources.
4630 save_state (_current_snapshot_name);
4634 boost::shared_ptr<Source>
4635 Session::source_by_id (const PBD::ID& id)
4637 Glib::Threads::Mutex::Lock lm (source_lock);
4638 SourceMap::iterator i;
4639 boost::shared_ptr<Source> source;
4641 if ((i = sources.find (id)) != sources.end()) {
4648 boost::shared_ptr<AudioFileSource>
4649 Session::audio_source_by_path_and_channel (const string& path, uint16_t chn) const
4651 /* Restricted to audio files because only audio sources have channel
4655 Glib::Threads::Mutex::Lock lm (source_lock);
4657 for (SourceMap::const_iterator i = sources.begin(); i != sources.end(); ++i) {
4658 boost::shared_ptr<AudioFileSource> afs
4659 = boost::dynamic_pointer_cast<AudioFileSource>(i->second);
4661 if (afs && afs->path() == path && chn == afs->channel()) {
4666 return boost::shared_ptr<AudioFileSource>();
4669 boost::shared_ptr<MidiSource>
4670 Session::midi_source_by_path (const std::string& path) const
4672 /* Restricted to MIDI files because audio sources require a channel
4673 for unique identification, in addition to a path.
4676 Glib::Threads::Mutex::Lock lm (source_lock);
4678 for (SourceMap::const_iterator s = sources.begin(); s != sources.end(); ++s) {
4679 boost::shared_ptr<MidiSource> ms
4680 = boost::dynamic_pointer_cast<MidiSource>(s->second);
4681 boost::shared_ptr<FileSource> fs
4682 = boost::dynamic_pointer_cast<FileSource>(s->second);
4684 if (ms && fs && fs->path() == path) {
4689 return boost::shared_ptr<MidiSource>();
4693 Session::count_sources_by_origin (const string& path)
4696 Glib::Threads::Mutex::Lock lm (source_lock);
4698 for (SourceMap::iterator i = sources.begin(); i != sources.end(); ++i) {
4699 boost::shared_ptr<FileSource> fs
4700 = boost::dynamic_pointer_cast<FileSource>(i->second);
4702 if (fs && fs->origin() == path) {
4711 peak_file_helper (const string& peak_path, const string& file_path, const string& file_base, bool hash) {
4713 std::string checksum = Glib::Checksum::compute_checksum(Glib::Checksum::CHECKSUM_SHA1, file_path + G_DIR_SEPARATOR + file_base);
4714 return Glib::build_filename (peak_path, checksum + peakfile_suffix);
4716 return Glib::build_filename (peak_path, file_base + peakfile_suffix);
4721 Session::construct_peak_filepath (const string& filepath, const bool in_session, const bool old_peak_name) const
4723 string interchange_dir_string = string (interchange_dir_name) + G_DIR_SEPARATOR;
4725 if (Glib::path_is_absolute (filepath)) {
4727 /* rip the session dir from the audiofile source */
4729 string session_path;
4730 bool in_another_session = true;
4732 if (filepath.find (interchange_dir_string) != string::npos) {
4734 session_path = Glib::path_get_dirname (filepath); /* now ends in audiofiles */
4735 session_path = Glib::path_get_dirname (session_path); /* now ends in session name */
4736 session_path = Glib::path_get_dirname (session_path); /* now ends in interchange */
4737 session_path = Glib::path_get_dirname (session_path); /* now has session path */
4739 /* see if it is within our session */
4741 for (vector<space_and_path>::const_iterator i = session_dirs.begin(); i != session_dirs.end(); ++i) {
4742 if (i->path == session_path) {
4743 in_another_session = false;
4748 in_another_session = false;
4752 if (in_another_session) {
4753 SessionDirectory sd (session_path);
4754 return peak_file_helper (sd.peak_path(), "", Glib::path_get_basename (filepath), !old_peak_name);
4758 /* 1) if file belongs to this session
4759 * it may be a relative path (interchange/...)
4760 * or just basename (session_state, remove source)
4761 * -> just use the basename
4763 std::string filename = Glib::path_get_basename (filepath);
4766 /* 2) if the file is outside our session dir:
4767 * (imported but not copied) add the path for check-summming */
4769 path = Glib::path_get_dirname (filepath);
4772 return peak_file_helper (_session_dir->peak_path(), path, Glib::path_get_basename (filepath), !old_peak_name);
4776 Session::new_audio_source_path_for_embedded (const std::string& path)
4780 * we know that the filename is already unique because it exists
4781 * out in the filesystem.
4783 * However, when we bring it into the session, we could get a
4786 * Eg. two embedded files:
4791 * When merged into session, these collide.
4793 * There will not be a conflict with in-memory sources
4794 * because when the source was created we already picked
4795 * a unique name for it.
4797 * This collision is not likely to be common, but we have to guard
4798 * against it. So, if there is a collision, take the md5 hash of the
4799 * the path, and use that as the filename instead.
4802 SessionDirectory sdir (get_best_session_directory_for_new_audio());
4803 string base = Glib::path_get_basename (path);
4804 string newpath = Glib::build_filename (sdir.sound_path(), base);
4806 if (Glib::file_test (newpath, Glib::FILE_TEST_EXISTS)) {
4810 md5.digestString (path.c_str());
4811 md5.writeToString ();
4812 base = md5.digestChars;
4814 string ext = get_suffix (path);
4821 newpath = Glib::build_filename (sdir.sound_path(), base);
4823 /* if this collides, we're screwed */
4825 if (Glib::file_test (newpath, Glib::FILE_TEST_EXISTS)) {
4826 error << string_compose (_("Merging embedded file %1: name collision AND md5 hash collision!"), path) << endmsg;
4835 /** Return true if there are no audio file sources that use @param name as
4836 * the filename component of their path.
4838 * Return false otherwise.
4840 * This method MUST ONLY be used to check in-session, mono files since it
4841 * hard-codes the channel of the audio file source we are looking for as zero.
4843 * If/when Ardour supports native files in non-mono formats, the logic here
4844 * will need to be revisited.
4847 Session::audio_source_name_is_unique (const string& name)
4849 std::vector<string> sdirs = source_search_path (DataType::AUDIO);
4850 vector<space_and_path>::iterator i;
4851 uint32_t existing = 0;
4853 for (vector<string>::const_iterator i = sdirs.begin(); i != sdirs.end(); ++i) {
4855 /* note that we search *without* the extension so that
4856 we don't end up both "Audio 1-1.wav" and "Audio 1-1.caf"
4857 in the event that this new name is required for
4858 a file format change.
4861 const string spath = *i;
4863 if (matching_unsuffixed_filename_exists_in (spath, name)) {
4868 /* it is possible that we have the path already
4869 * assigned to a source that has not yet been written
4870 * (ie. the write source for a diskstream). we have to
4871 * check this in order to make sure that our candidate
4872 * path isn't used again, because that can lead to
4873 * two Sources point to the same file with different
4874 * notions of their removability.
4878 string possible_path = Glib::build_filename (spath, name);
4880 if (audio_source_by_path_and_channel (possible_path, 0)) {
4886 return (existing == 0);
4890 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)
4893 const string ext = native_header_format_extension (config.get_native_file_header_format(), DataType::AUDIO);
4895 if (Profile->get_trx() && destructive) {
4897 sstr << setfill ('0') << setw (4) << cnt;
4898 sstr << legalized_base;
4900 sstr << legalized_base;
4902 if (take_required || related_exists) {
4914 } else if (nchan > 2) {
4919 /* XXX what? more than 26 channels! */
4930 /** Return a unique name based on \a base for a new internal audio source */
4932 Session::new_audio_source_path (const string& base, uint32_t nchan, uint32_t chan, bool destructive, bool take_required)
4935 string possible_name;
4936 const uint32_t limit = 9999; // arbitrary limit on number of files with the same basic name
4938 bool some_related_source_name_exists = false;
4940 legalized = legalize_for_path (base);
4942 // Find a "version" of the base name that doesn't exist in any of the possible directories.
4944 for (cnt = (destructive ? ++destructive_index : 1); cnt <= limit; ++cnt) {
4946 possible_name = format_audio_source_name (legalized, nchan, chan, destructive, take_required, cnt, some_related_source_name_exists);
4948 if (audio_source_name_is_unique (possible_name)) {
4952 some_related_source_name_exists = true;
4955 error << string_compose(
4956 _("There are already %1 recordings for %2, which I consider too many."),
4957 limit, base) << endmsg;
4959 throw failed_constructor();
4963 /* We've established that the new name does not exist in any session
4964 * directory, so now find out which one we should use for this new
4968 SessionDirectory sdir (get_best_session_directory_for_new_audio());
4970 std::string s = Glib::build_filename (sdir.sound_path(), possible_name);
4975 /** Return a unique name based on `base` for a new internal MIDI source */
4977 Session::new_midi_source_path (const string& base)
4980 char buf[PATH_MAX+1];
4981 const uint32_t limit = 10000;
4983 string possible_path;
4984 string possible_name;
4987 legalized = legalize_for_path (base);
4989 // Find a "version" of the file name that doesn't exist in any of the possible directories.
4990 std::vector<string> sdirs = source_search_path(DataType::MIDI);
4992 /* - the main session folder is the first in the vector.
4993 * - after checking all locations for file-name uniqueness,
4994 * we keep the one from the last iteration as new file name
4995 * - midi files are small and should just be kept in the main session-folder
4997 * -> reverse the array, check main session folder last and use that as location
5000 std::reverse(sdirs.begin(), sdirs.end());
5002 for (cnt = 1; cnt <= limit; ++cnt) {
5004 vector<space_and_path>::iterator i;
5005 uint32_t existing = 0;
5007 for (vector<string>::const_iterator i = sdirs.begin(); i != sdirs.end(); ++i) {
5009 snprintf (buf, sizeof(buf), "%s-%u.mid", legalized.c_str(), cnt);
5010 possible_name = buf;
5012 possible_path = Glib::build_filename (*i, possible_name);
5014 if (Glib::file_test (possible_path, Glib::FILE_TEST_EXISTS)) {
5018 if (midi_source_by_path (possible_path)) {
5023 if (existing == 0) {
5028 error << string_compose(
5029 _("There are already %1 recordings for %2, which I consider too many."),
5030 limit, base) << endmsg;
5036 /* No need to "find best location" for software/app-based RAID, because
5037 MIDI is so small that we always put it in the same place.
5040 return possible_path;
5044 /** Create a new within-session audio source */
5045 boost::shared_ptr<AudioFileSource>
5046 Session::create_audio_source_for_session (size_t n_chans, string const & base, uint32_t chan, bool destructive)
5048 const string path = new_audio_source_path (base, n_chans, chan, destructive, true);
5050 if (!path.empty()) {
5051 return boost::dynamic_pointer_cast<AudioFileSource> (
5052 SourceFactory::createWritable (DataType::AUDIO, *this, path, destructive, frame_rate(), true, true));
5054 throw failed_constructor ();
5058 /** Create a new within-session MIDI source */
5059 boost::shared_ptr<MidiSource>
5060 Session::create_midi_source_for_session (string const & basic_name)
5062 const string path = new_midi_source_path (basic_name);
5064 if (!path.empty()) {
5065 return boost::dynamic_pointer_cast<SMFSource> (
5066 SourceFactory::createWritable (
5067 DataType::MIDI, *this, path, false, frame_rate()));
5069 throw failed_constructor ();
5073 /** Create a new within-session MIDI source */
5074 boost::shared_ptr<MidiSource>
5075 Session::create_midi_source_by_stealing_name (boost::shared_ptr<Track> track)
5077 /* the caller passes in the track the source will be used in,
5078 so that we can keep the numbering sane.
5080 Rationale: a track with the name "Foo" that has had N
5081 captures carried out so far will ALREADY have a write source
5082 named "Foo-N+1.mid" waiting to be used for the next capture.
5084 If we call new_midi_source_name() we will get "Foo-N+2". But
5085 there is no region corresponding to "Foo-N+1", so when
5086 "Foo-N+2" appears in the track, the gap presents the user
5087 with odd behaviour - why did it skip past Foo-N+1?
5089 We could explain this to the user in some odd way, but
5090 instead we rename "Foo-N+1.mid" as "Foo-N+2.mid", and then
5093 If that attempted rename fails, we get "Foo-N+2.mid" anyway.
5096 boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (track);
5098 std::string name = track->steal_write_source_name ();
5101 return boost::shared_ptr<MidiSource>();
5104 /* MIDI files are small, just put them in the first location of the
5105 session source search path.
5108 const string path = Glib::build_filename (source_search_path (DataType::MIDI).front(), name);
5110 return boost::dynamic_pointer_cast<SMFSource> (
5111 SourceFactory::createWritable (
5112 DataType::MIDI, *this, path, false, frame_rate()));
5117 Session::add_playlist (boost::shared_ptr<Playlist> playlist, bool unused)
5119 if (playlist->hidden()) {
5123 playlists->add (playlist);
5126 playlist->release();
5133 Session::remove_playlist (boost::weak_ptr<Playlist> weak_playlist)
5135 if (_state_of_the_state & Deletion) {
5139 boost::shared_ptr<Playlist> playlist (weak_playlist.lock());
5145 playlists->remove (playlist);
5151 Session::set_audition (boost::shared_ptr<Region> r)
5153 pending_audition_region = r;
5154 add_post_transport_work (PostTransportAudition);
5155 _butler->schedule_transport_work ();
5159 Session::audition_playlist ()
5161 SessionEvent* ev = new SessionEvent (SessionEvent::Audition, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
5162 ev->region.reset ();
5168 Session::register_lua_function (
5169 const std::string& name,
5170 const std::string& script,
5171 const LuaScriptParamList& args
5174 Glib::Threads::Mutex::Lock lm (lua_lock);
5176 lua_State* L = lua.getState();
5178 const std::string& bytecode = LuaScripting::get_factory_bytecode (script);
5179 luabridge::LuaRef tbl_arg (luabridge::newTable(L));
5180 for (LuaScriptParamList::const_iterator i = args.begin(); i != args.end(); ++i) {
5181 if ((*i)->optional && !(*i)->is_set) { continue; }
5182 tbl_arg[(*i)->name] = (*i)->value;
5184 (*_lua_add)(name, bytecode, tbl_arg); // throws luabridge::LuaException
5189 Session::unregister_lua_function (const std::string& name)
5191 Glib::Threads::Mutex::Lock lm (lua_lock);
5192 (*_lua_del)(name); // throws luabridge::LuaException
5193 lua.collect_garbage ();
5197 std::vector<std::string>
5198 Session::registered_lua_functions ()
5200 Glib::Threads::Mutex::Lock lm (lua_lock);
5201 std::vector<std::string> rv;
5204 luabridge::LuaRef list ((*_lua_list)());
5205 for (luabridge::Iterator i (list); !i.isNil (); ++i) {
5206 if (!i.key ().isString ()) { assert(0); continue; }
5207 rv.push_back (i.key ().cast<std::string> ());
5209 } catch (luabridge::LuaException const& e) { }
5214 static void _lua_print (std::string s) {
5215 std::cout << "SessionLua: " << s << "\n";
5220 Session::try_run_lua (pframes_t nframes)
5222 if (_n_lua_scripts == 0) return;
5223 Glib::Threads::Mutex::Lock tm (lua_lock, Glib::Threads::TRY_LOCK);
5225 try { (*_lua_run)(nframes); } catch (luabridge::LuaException const& e) { }
5226 lua.collect_garbage_step ();
5231 Session::setup_lua ()
5234 lua.Print.connect (&_lua_print);
5238 "function ArdourSession ()"
5239 " local self = { scripts = {}, instances = {} }"
5241 " local remove = function (n)"
5242 " self.scripts[n] = nil"
5243 " self.instances[n] = nil"
5244 " Session:scripts_changed()" // call back
5247 " local addinternal = function (n, f, a)"
5248 " assert(type(n) == 'string', 'function-name must be string')"
5249 " assert(type(f) == 'function', 'Given script is a not a function')"
5250 " assert(type(a) == 'table' or type(a) == 'nil', 'Given argument is invalid')"
5251 " assert(self.scripts[n] == nil, 'Callback \"'.. n ..'\" already exists.')"
5252 " self.scripts[n] = { ['f'] = f, ['a'] = a }"
5253 " 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"
5254 " 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 }"
5255 " self.instances[n] = load (string.dump(f, true), nil, nil, env)(a)"
5256 " Session:scripts_changed()" // call back
5259 " local add = function (n, b, a)"
5260 " assert(type(b) == 'string', 'ByteCode must be string')"
5261 " load (b)()" // assigns f
5262 " assert(type(f) == 'string', 'Assigned ByteCode must be string')"
5263 " addinternal (n, load(f), a)"
5266 " local run = function (...)"
5267 " for n, s in pairs (self.instances) do"
5268 " local status, err = pcall (s, ...)"
5269 " if not status then"
5270 " print ('fn \"'.. n .. '\": ', err)"
5277 " local cleanup = function ()"
5278 " self.scripts = nil"
5279 " self.instances = nil"
5282 " local list = function ()"
5284 " for n, _ in pairs (self.scripts) do"
5290 " local function basic_serialize (o)"
5291 " if type(o) == \"number\" then"
5292 " return tostring(o)"
5294 " return string.format(\"%q\", o)"
5298 " local function serialize (name, value)"
5299 " local rv = name .. ' = '"
5301 " if type(value) == \"number\" or type(value) == \"string\" or type(value) == \"nil\" then"
5302 " return rv .. basic_serialize(value) .. ' '"
5303 " elseif type(value) == \"table\" then"
5305 " for k,v in pairs(value) do"
5306 " local fieldname = string.format(\"%s[%s]\", name, basic_serialize(k))"
5307 " rv = rv .. serialize(fieldname, v) .. ' '"
5308 " collectgarbage()" // string concatenation allocates a new string :(
5311 " elseif type(value) == \"function\" then"
5312 " return rv .. string.format(\"%q\", string.dump(value, true))"
5314 " error('cannot save a ' .. type(value))"
5319 " local save = function ()"
5320 " return (serialize('scripts', self.scripts))"
5323 " local restore = function (state)"
5324 " self.scripts = {}"
5326 " for n, s in pairs (scripts) do"
5327 " addinternal (n, load(s['f']), s['a'])"
5331 " return { run = run, add = add, remove = remove,"
5332 " list = list, restore = restore, save = save, cleanup = cleanup}"
5335 " sess = ArdourSession ()"
5336 " ArdourSession = nil"
5338 "function ardour () end"
5341 lua_State* L = lua.getState();
5344 luabridge::LuaRef lua_sess = luabridge::getGlobal (L, "sess");
5345 lua.do_command ("sess = nil"); // hide it.
5346 lua.do_command ("collectgarbage()");
5348 _lua_run = new luabridge::LuaRef(lua_sess["run"]);
5349 _lua_add = new luabridge::LuaRef(lua_sess["add"]);
5350 _lua_del = new luabridge::LuaRef(lua_sess["remove"]);
5351 _lua_list = new luabridge::LuaRef(lua_sess["list"]);
5352 _lua_save = new luabridge::LuaRef(lua_sess["save"]);
5353 _lua_load = new luabridge::LuaRef(lua_sess["restore"]);
5354 _lua_cleanup = new luabridge::LuaRef(lua_sess["cleanup"]);
5355 } catch (luabridge::LuaException const& e) {
5356 fatal << string_compose (_("programming error: %1"),
5357 X_("Failed to setup Lua interpreter"))
5359 abort(); /*NOTREACHED*/
5362 LuaBindings::stddef (L);
5363 LuaBindings::common (L);
5364 LuaBindings::dsp (L);
5365 luabridge::push <Session *> (L, this);
5366 lua_setglobal (L, "Session");
5370 Session::scripts_changed ()
5372 assert (!lua_lock.trylock()); // must hold lua_lock
5375 luabridge::LuaRef list ((*_lua_list)());
5377 for (luabridge::Iterator i (list); !i.isNil (); ++i) {
5378 if (!i.key ().isString ()) { assert(0); continue; }
5381 _n_lua_scripts = cnt;
5382 } catch (luabridge::LuaException const& e) {
5383 fatal << string_compose (_("programming error: %1"),
5384 X_("Indexing Lua Session Scripts failed."))
5386 abort(); /*NOTREACHED*/
5391 Session::non_realtime_set_audition ()
5393 assert (pending_audition_region);
5394 auditioner->audition_region (pending_audition_region);
5395 pending_audition_region.reset ();
5396 AuditionActive (true); /* EMIT SIGNAL */
5400 Session::audition_region (boost::shared_ptr<Region> r)
5402 SessionEvent* ev = new SessionEvent (SessionEvent::Audition, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
5408 Session::cancel_audition ()
5413 if (auditioner->auditioning()) {
5414 auditioner->cancel_audition ();
5415 AuditionActive (false); /* EMIT SIGNAL */
5420 Session::RoutePublicOrderSorter::operator() (boost::shared_ptr<Route> a, boost::shared_ptr<Route> b)
5422 if (a->is_monitor()) {
5425 if (b->is_monitor()) {
5428 return a->presentation_info().order() < b->presentation_info().order();
5432 Session::is_auditioning () const
5434 /* can be called before we have an auditioner object */
5436 return auditioner->auditioning();
5443 Session::graph_reordered ()
5445 /* don't do this stuff if we are setting up connections
5446 from a set_state() call or creating new tracks. Ditto for deletion.
5449 if ((_state_of_the_state & (InitialConnecting|Deletion)) || _adding_routes_in_progress || _reconnecting_routes_in_progress || _route_deletion_in_progress) {
5453 /* every track/bus asked for this to be handled but it was deferred because
5454 we were connecting. do it now.
5457 request_input_change_handling ();
5461 /* force all diskstreams to update their capture offset values to
5462 reflect any changes in latencies within the graph.
5465 boost::shared_ptr<RouteList> rl = routes.reader ();
5466 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
5467 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
5469 tr->set_capture_offset ();
5474 /** @return Number of frames that there is disk space available to write,
5477 boost::optional<framecnt_t>
5478 Session::available_capture_duration ()
5480 Glib::Threads::Mutex::Lock lm (space_lock);
5482 if (_total_free_4k_blocks_uncertain) {
5483 return boost::optional<framecnt_t> ();
5486 float sample_bytes_on_disk = 4.0; // keep gcc happy
5488 switch (config.get_native_file_data_format()) {
5490 sample_bytes_on_disk = 4.0;
5494 sample_bytes_on_disk = 3.0;
5498 sample_bytes_on_disk = 2.0;
5502 /* impossible, but keep some gcc versions happy */
5503 fatal << string_compose (_("programming error: %1"),
5504 X_("illegal native file data format"))
5506 abort(); /*NOTREACHED*/
5509 double scale = 4096.0 / sample_bytes_on_disk;
5511 if (_total_free_4k_blocks * scale > (double) max_framecnt) {
5512 return max_framecnt;
5515 return (framecnt_t) floor (_total_free_4k_blocks * scale);
5519 Session::add_bundle (boost::shared_ptr<Bundle> bundle, bool emit_signal)
5522 RCUWriter<BundleList> writer (_bundles);
5523 boost::shared_ptr<BundleList> b = writer.get_copy ();
5524 b->push_back (bundle);
5528 BundleAddedOrRemoved (); /* EMIT SIGNAL */
5535 Session::remove_bundle (boost::shared_ptr<Bundle> bundle)
5537 bool removed = false;
5540 RCUWriter<BundleList> writer (_bundles);
5541 boost::shared_ptr<BundleList> b = writer.get_copy ();
5542 BundleList::iterator i = find (b->begin(), b->end(), bundle);
5544 if (i != b->end()) {
5551 BundleAddedOrRemoved (); /* EMIT SIGNAL */
5557 boost::shared_ptr<Bundle>
5558 Session::bundle_by_name (string name) const
5560 boost::shared_ptr<BundleList> b = _bundles.reader ();
5562 for (BundleList::const_iterator i = b->begin(); i != b->end(); ++i) {
5563 if ((*i)->name() == name) {
5568 return boost::shared_ptr<Bundle> ();
5572 Session::tempo_map_changed (const PropertyChange&)
5576 playlists->update_after_tempo_map_change ();
5578 _locations->apply (*this, &Session::update_locations_after_tempo_map_change);
5584 Session::gui_tempo_map_changed ()
5588 playlists->update_after_tempo_map_change ();
5590 _locations->apply (*this, &Session::update_locations_after_tempo_map_change);
5594 Session::update_locations_after_tempo_map_change (const Locations::LocationList& loc)
5596 for (Locations::LocationList::const_iterator i = loc.begin(); i != loc.end(); ++i) {
5597 (*i)->recompute_frames_from_bbt ();
5601 /** Ensures that all buffers (scratch, send, silent, etc) are allocated for
5602 * the given count with the current block size.
5605 Session::ensure_buffers (ChanCount howmany)
5607 BufferManager::ensure_buffers (howmany, bounce_processing() ? bounce_chunk_size : 0);
5611 Session::ensure_buffer_set(BufferSet& buffers, const ChanCount& count)
5613 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
5614 buffers.ensure_buffers(*t, count.get(*t), _engine.raw_buffer_size(*t));
5619 Session::next_insert_id ()
5621 /* this doesn't really loop forever. just think about it */
5624 for (boost::dynamic_bitset<uint32_t>::size_type n = 1; n < insert_bitset.size(); ++n) {
5625 if (!insert_bitset[n]) {
5626 insert_bitset[n] = true;
5632 /* none available, so resize and try again */
5634 insert_bitset.resize (insert_bitset.size() + 16, false);
5639 Session::next_send_id ()
5641 /* this doesn't really loop forever. just think about it */
5644 for (boost::dynamic_bitset<uint32_t>::size_type n = 1; n < send_bitset.size(); ++n) {
5645 if (!send_bitset[n]) {
5646 send_bitset[n] = true;
5652 /* none available, so resize and try again */
5654 send_bitset.resize (send_bitset.size() + 16, false);
5659 Session::next_aux_send_id ()
5661 /* this doesn't really loop forever. just think about it */
5664 for (boost::dynamic_bitset<uint32_t>::size_type n = 1; n < aux_send_bitset.size(); ++n) {
5665 if (!aux_send_bitset[n]) {
5666 aux_send_bitset[n] = true;
5672 /* none available, so resize and try again */
5674 aux_send_bitset.resize (aux_send_bitset.size() + 16, false);
5679 Session::next_return_id ()
5681 /* this doesn't really loop forever. just think about it */
5684 for (boost::dynamic_bitset<uint32_t>::size_type n = 1; n < return_bitset.size(); ++n) {
5685 if (!return_bitset[n]) {
5686 return_bitset[n] = true;
5692 /* none available, so resize and try again */
5694 return_bitset.resize (return_bitset.size() + 16, false);
5699 Session::mark_send_id (uint32_t id)
5701 if (id >= send_bitset.size()) {
5702 send_bitset.resize (id+16, false);
5704 if (send_bitset[id]) {
5705 warning << string_compose (_("send ID %1 appears to be in use already"), id) << endmsg;
5707 send_bitset[id] = true;
5711 Session::mark_aux_send_id (uint32_t id)
5713 if (id >= aux_send_bitset.size()) {
5714 aux_send_bitset.resize (id+16, false);
5716 if (aux_send_bitset[id]) {
5717 warning << string_compose (_("aux send ID %1 appears to be in use already"), id) << endmsg;
5719 aux_send_bitset[id] = true;
5723 Session::mark_return_id (uint32_t id)
5725 if (id >= return_bitset.size()) {
5726 return_bitset.resize (id+16, false);
5728 if (return_bitset[id]) {
5729 warning << string_compose (_("return ID %1 appears to be in use already"), id) << endmsg;
5731 return_bitset[id] = true;
5735 Session::mark_insert_id (uint32_t id)
5737 if (id >= insert_bitset.size()) {
5738 insert_bitset.resize (id+16, false);
5740 if (insert_bitset[id]) {
5741 warning << string_compose (_("insert ID %1 appears to be in use already"), id) << endmsg;
5743 insert_bitset[id] = true;
5747 Session::unmark_send_id (uint32_t id)
5749 if (id < send_bitset.size()) {
5750 send_bitset[id] = false;
5755 Session::unmark_aux_send_id (uint32_t id)
5757 if (id < aux_send_bitset.size()) {
5758 aux_send_bitset[id] = false;
5763 Session::unmark_return_id (uint32_t id)
5765 if (_state_of_the_state & Deletion) { return; }
5766 if (id < return_bitset.size()) {
5767 return_bitset[id] = false;
5772 Session::unmark_insert_id (uint32_t id)
5774 if (id < insert_bitset.size()) {
5775 insert_bitset[id] = false;
5780 Session::reset_native_file_format ()
5782 boost::shared_ptr<RouteList> rl = routes.reader ();
5784 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
5785 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
5787 /* don't save state as we do this, there's no point
5789 _state_of_the_state = StateOfTheState (_state_of_the_state|InCleanup);
5790 tr->reset_write_sources (false);
5791 _state_of_the_state = StateOfTheState (_state_of_the_state & ~InCleanup);
5797 Session::route_name_unique (string n) const
5799 boost::shared_ptr<RouteList> r = routes.reader ();
5801 for (RouteList::const_iterator i = r->begin(); i != r->end(); ++i) {
5802 if ((*i)->name() == n) {
5811 Session::route_name_internal (string n) const
5813 if (auditioner && auditioner->name() == n) {
5817 if (_click_io && _click_io->name() == n) {
5825 Session::freeze_all (InterThreadInfo& itt)
5827 boost::shared_ptr<RouteList> r = routes.reader ();
5829 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
5831 boost::shared_ptr<Track> t;
5833 if ((t = boost::dynamic_pointer_cast<Track>(*i)) != 0) {
5834 /* XXX this is wrong because itt.progress will keep returning to zero at the start
5844 boost::shared_ptr<Region>
5845 Session::write_one_track (Track& track, framepos_t start, framepos_t end,
5846 bool /*overwrite*/, vector<boost::shared_ptr<Source> >& srcs,
5847 InterThreadInfo& itt,
5848 boost::shared_ptr<Processor> endpoint, bool include_endpoint,
5849 bool for_export, bool for_freeze)
5851 boost::shared_ptr<Region> result;
5852 boost::shared_ptr<Playlist> playlist;
5853 boost::shared_ptr<Source> source;
5854 ChanCount diskstream_channels (track.n_channels());
5855 framepos_t position;
5856 framecnt_t this_chunk;
5858 framepos_t latency_skip;
5860 framepos_t len = end - start;
5861 bool need_block_size_reset = false;
5862 ChanCount const max_proc = track.max_processor_streams ();
5863 string legal_playlist_name;
5864 string possible_path;
5867 error << string_compose (_("Cannot write a range where end <= start (e.g. %1 <= %2)"),
5868 end, start) << endmsg;
5872 diskstream_channels = track.bounce_get_output_streams (diskstream_channels, endpoint,
5873 include_endpoint, for_export, for_freeze);
5875 if (diskstream_channels.n(track.data_type()) < 1) {
5876 error << _("Cannot write a range with no data.") << endmsg;
5880 // block all process callback handling
5882 block_processing ();
5885 // synchronize with AudioEngine::process_callback()
5886 // make sure processing is not currently running
5887 // and processing_blocked() is honored before
5888 // acquiring thread buffers
5889 Glib::Threads::Mutex::Lock lm (_engine.process_lock());
5892 _bounce_processing_active = true;
5894 /* call tree *MUST* hold route_lock */
5896 if ((playlist = track.playlist()) == 0) {
5900 legal_playlist_name = legalize_for_path (playlist->name());
5902 for (uint32_t chan_n = 0; chan_n < diskstream_channels.n(track.data_type()); ++chan_n) {
5904 string base_name = string_compose ("%1-%2-bounce", playlist->name(), chan_n);
5905 string path = ((track.data_type() == DataType::AUDIO)
5906 ? new_audio_source_path (legal_playlist_name, diskstream_channels.n_audio(), chan_n, false, true)
5907 : new_midi_source_path (legal_playlist_name));
5914 source = SourceFactory::createWritable (track.data_type(), *this, path, false, frame_rate());
5917 catch (failed_constructor& err) {
5918 error << string_compose (_("cannot create new file \"%1\" for %2"), path, track.name()) << endmsg;
5922 srcs.push_back (source);
5925 /* tell redirects that care that we are about to use a much larger
5926 * blocksize. this will flush all plugins too, so that they are ready
5927 * to be used for this process.
5930 need_block_size_reset = true;
5931 track.set_block_size (bounce_chunk_size);
5932 _engine.main_thread()->get_buffers ();
5936 latency_skip = track.bounce_get_latency (endpoint, include_endpoint, for_export, for_freeze);
5938 /* create a set of reasonably-sized buffers */
5939 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
5940 buffers.ensure_buffers(*t, max_proc.get(*t), bounce_chunk_size);
5942 buffers.set_count (max_proc);
5944 for (vector<boost::shared_ptr<Source> >::iterator src = srcs.begin(); src != srcs.end(); ++src) {
5945 boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*src);
5946 boost::shared_ptr<MidiSource> ms;
5948 afs->prepare_for_peakfile_writes ();
5949 } else if ((ms = boost::dynamic_pointer_cast<MidiSource>(*src))) {
5950 Source::Lock lock(ms->mutex());
5951 ms->mark_streaming_write_started(lock);
5955 while (to_do && !itt.cancel) {
5957 this_chunk = min (to_do, bounce_chunk_size);
5959 if (track.export_stuff (buffers, start, this_chunk, endpoint, include_endpoint, for_export, for_freeze)) {
5963 start += this_chunk;
5964 to_do -= this_chunk;
5965 itt.progress = (float) (1.0 - ((double) to_do / len));
5967 if (latency_skip >= bounce_chunk_size) {
5968 latency_skip -= bounce_chunk_size;
5972 const framecnt_t current_chunk = this_chunk - latency_skip;
5975 for (vector<boost::shared_ptr<Source> >::iterator src=srcs.begin(); src != srcs.end(); ++src, ++n) {
5976 boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*src);
5977 boost::shared_ptr<MidiSource> ms;
5980 if (afs->write (buffers.get_audio(n).data(latency_skip), current_chunk) != current_chunk) {
5983 } else if ((ms = boost::dynamic_pointer_cast<MidiSource>(*src))) {
5984 Source::Lock lock(ms->mutex());
5986 const MidiBuffer& buf = buffers.get_midi(0);
5987 for (MidiBuffer::const_iterator i = buf.begin(); i != buf.end(); ++i) {
5988 Evoral::Event<framepos_t> ev = *i;
5989 ev.set_time(ev.time() - position);
5990 ms->append_event_frames(lock, ev, ms->timeline_position());
5997 /* post-roll, pick up delayed processor output */
5998 latency_skip = track.bounce_get_latency (endpoint, include_endpoint, for_export, for_freeze);
6000 while (latency_skip && !itt.cancel) {
6001 this_chunk = min (latency_skip, bounce_chunk_size);
6002 latency_skip -= this_chunk;
6004 buffers.silence (this_chunk, 0);
6005 track.bounce_process (buffers, start, this_chunk, endpoint, include_endpoint, for_export, for_freeze);
6008 for (vector<boost::shared_ptr<Source> >::iterator src=srcs.begin(); src != srcs.end(); ++src, ++n) {
6009 boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*src);
6012 if (afs->write (buffers.get_audio(n).data(), this_chunk) != this_chunk) {
6024 xnow = localtime (&now);
6026 for (vector<boost::shared_ptr<Source> >::iterator src=srcs.begin(); src != srcs.end(); ++src) {
6027 boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*src);
6028 boost::shared_ptr<MidiSource> ms;
6031 afs->update_header (position, *xnow, now);
6032 afs->flush_header ();
6033 } else if ((ms = boost::dynamic_pointer_cast<MidiSource>(*src))) {
6034 Source::Lock lock(ms->mutex());
6035 ms->mark_streaming_write_completed(lock);
6039 /* construct a region to represent the bounced material */
6043 plist.add (Properties::start, 0);
6044 plist.add (Properties::length, srcs.front()->length(srcs.front()->timeline_position()));
6045 plist.add (Properties::name, region_name_from_path (srcs.front()->name(), true));
6047 result = RegionFactory::create (srcs, plist);
6053 for (vector<boost::shared_ptr<Source> >::iterator src = srcs.begin(); src != srcs.end(); ++src) {
6054 (*src)->mark_for_remove ();
6055 (*src)->drop_references ();
6059 for (vector<boost::shared_ptr<Source> >::iterator src = srcs.begin(); src != srcs.end(); ++src) {
6060 boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*src);
6063 afs->done_with_peakfile_writes ();
6067 _bounce_processing_active = false;
6069 if (need_block_size_reset) {
6070 _engine.main_thread()->drop_buffers ();
6071 track.set_block_size (get_block_size());
6074 unblock_processing ();
6080 Session::gain_automation_buffer() const
6082 return ProcessThread::gain_automation_buffer ();
6086 Session::trim_automation_buffer() const
6088 return ProcessThread::trim_automation_buffer ();
6092 Session::send_gain_automation_buffer() const
6094 return ProcessThread::send_gain_automation_buffer ();
6098 Session::pan_automation_buffer() const
6100 return ProcessThread::pan_automation_buffer ();
6104 Session::get_silent_buffers (ChanCount count)
6106 return ProcessThread::get_silent_buffers (count);
6110 Session::get_scratch_buffers (ChanCount count, bool silence)
6112 return ProcessThread::get_scratch_buffers (count, silence);
6116 Session::get_noinplace_buffers (ChanCount count)
6118 return ProcessThread::get_noinplace_buffers (count);
6122 Session::get_route_buffers (ChanCount count, bool silence)
6124 return ProcessThread::get_route_buffers (count, silence);
6129 Session::get_mix_buffers (ChanCount count)
6131 return ProcessThread::get_mix_buffers (count);
6135 Session::ntracks () const
6138 boost::shared_ptr<RouteList> r = routes.reader ();
6140 for (RouteList::const_iterator i = r->begin(); i != r->end(); ++i) {
6141 if (boost::dynamic_pointer_cast<Track> (*i)) {
6150 Session::nbusses () const
6153 boost::shared_ptr<RouteList> r = routes.reader ();
6155 for (RouteList::const_iterator i = r->begin(); i != r->end(); ++i) {
6156 if (boost::dynamic_pointer_cast<Track>(*i) == 0) {
6165 Session::add_automation_list(AutomationList *al)
6167 automation_lists[al->id()] = al;
6170 /** @return true if there is at least one record-enabled track, otherwise false */
6172 Session::have_rec_enabled_track () const
6174 return g_atomic_int_get (const_cast<gint*>(&_have_rec_enabled_track)) == 1;
6178 Session::have_rec_disabled_track () const
6180 return g_atomic_int_get (const_cast<gint*>(&_have_rec_disabled_track)) == 1;
6183 /** Update the state of our rec-enabled tracks flag */
6185 Session::update_route_record_state ()
6187 boost::shared_ptr<RouteList> rl = routes.reader ();
6188 RouteList::iterator i = rl->begin();
6189 while (i != rl->end ()) {
6191 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
6192 if (tr && tr->rec_enable_control()->get_value()) {
6199 int const old = g_atomic_int_get (&_have_rec_enabled_track);
6201 g_atomic_int_set (&_have_rec_enabled_track, i != rl->end () ? 1 : 0);
6203 if (g_atomic_int_get (&_have_rec_enabled_track) != old) {
6204 RecordStateChanged (); /* EMIT SIGNAL */
6207 for (i = rl->begin(); i != rl->end (); ++i) {
6208 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
6209 if (tr && !tr->rec_enable_control()->get_value()) {
6214 g_atomic_int_set (&_have_rec_disabled_track, i != rl->end () ? 1 : 0);
6216 bool record_arm_state_changed = (old != g_atomic_int_get (&_have_rec_enabled_track) );
6218 if (record_status() == Recording && record_arm_state_changed ) {
6219 RecordArmStateChanged ();
6225 Session::listen_position_changed ()
6228 boost::shared_ptr<RouteList> r = routes.reader ();
6229 PBD::Unwinder<bool> uw (ignore_route_processor_changes, true);
6230 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6231 (*i)->listen_position_changed ();
6234 route_processors_changed (RouteProcessorChange ());
6238 Session::solo_control_mode_changed ()
6240 if (soloing() || listening()) {
6241 /* We can't use ::clear_all_solo_state() here because during
6242 session loading at program startup, that will queue a call
6243 to rt_clear_all_solo_state() that will not execute until
6244 AFTER solo states have been established (thus throwing away
6245 the session's saved solo state). So just explicitly turn
6248 set_controls (route_list_to_control_list (get_routes(), &Stripable::solo_control), 0.0, Controllable::NoGroup);
6252 /** Called when a property of one of our route groups changes */
6254 Session::route_group_property_changed (RouteGroup* rg)
6256 RouteGroupPropertyChanged (rg); /* EMIT SIGNAL */
6259 /** Called when a route is added to one of our route groups */
6261 Session::route_added_to_route_group (RouteGroup* rg, boost::weak_ptr<Route> r)
6263 RouteAddedToRouteGroup (rg, r);
6266 /** Called when a route is removed from one of our route groups */
6268 Session::route_removed_from_route_group (RouteGroup* rg, boost::weak_ptr<Route> r)
6270 update_route_record_state ();
6271 RouteRemovedFromRouteGroup (rg, r); /* EMIT SIGNAL */
6273 if (!rg->has_control_master () && !rg->has_subgroup () && rg->empty()) {
6274 remove_route_group (*rg);
6278 boost::shared_ptr<RouteList>
6279 Session::get_tracks () const
6281 boost::shared_ptr<RouteList> rl = routes.reader ();
6282 boost::shared_ptr<RouteList> tl (new RouteList);
6284 for (RouteList::const_iterator r = rl->begin(); r != rl->end(); ++r) {
6285 if (boost::dynamic_pointer_cast<Track> (*r)) {
6286 if (!(*r)->is_auditioner()) {
6294 boost::shared_ptr<RouteList>
6295 Session::get_routes_with_regions_at (framepos_t const p) const
6297 boost::shared_ptr<RouteList> r = routes.reader ();
6298 boost::shared_ptr<RouteList> rl (new RouteList);
6300 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6301 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
6306 boost::shared_ptr<Playlist> pl = tr->playlist ();
6311 if (pl->has_region_at (p)) {
6320 Session::goto_end ()
6322 if (_session_range_location) {
6323 request_locate (_session_range_location->end(), false);
6325 request_locate (0, false);
6330 Session::goto_start (bool and_roll)
6332 if (_session_range_location) {
6333 request_locate (_session_range_location->start(), and_roll);
6335 request_locate (0, and_roll);
6340 Session::current_start_frame () const
6342 return _session_range_location ? _session_range_location->start() : 0;
6346 Session::current_end_frame () const
6348 return _session_range_location ? _session_range_location->end() : 0;
6352 Session::set_session_range_location (framepos_t start, framepos_t end)
6354 _session_range_location = new Location (*this, start, end, _("session"), Location::IsSessionRange);
6355 _locations->add (_session_range_location);
6359 Session::step_edit_status_change (bool yn)
6365 send = (_step_editors == 0);
6370 send = (_step_editors == 1);
6373 if (_step_editors > 0) {
6379 StepEditStatusChange (val);
6385 Session::start_time_changed (framepos_t old)
6387 /* Update the auto loop range to match the session range
6388 (unless the auto loop range has been changed by the user)
6391 Location* s = _locations->session_range_location ();
6396 Location* l = _locations->auto_loop_location ();
6398 if (l && l->start() == old) {
6399 l->set_start (s->start(), true);
6405 Session::end_time_changed (framepos_t old)
6407 /* Update the auto loop range to match the session range
6408 (unless the auto loop range has been changed by the user)
6411 Location* s = _locations->session_range_location ();
6416 Location* l = _locations->auto_loop_location ();
6418 if (l && l->end() == old) {
6419 l->set_end (s->end(), true);
6424 std::vector<std::string>
6425 Session::source_search_path (DataType type) const
6429 if (session_dirs.size() == 1) {
6431 case DataType::AUDIO:
6432 sp.push_back (_session_dir->sound_path());
6434 case DataType::MIDI:
6435 sp.push_back (_session_dir->midi_path());
6439 for (vector<space_and_path>::const_iterator i = session_dirs.begin(); i != session_dirs.end(); ++i) {
6440 SessionDirectory sdir (i->path);
6442 case DataType::AUDIO:
6443 sp.push_back (sdir.sound_path());
6445 case DataType::MIDI:
6446 sp.push_back (sdir.midi_path());
6452 if (type == DataType::AUDIO) {
6453 const string sound_path_2X = _session_dir->sound_path_2X();
6454 if (Glib::file_test (sound_path_2X, Glib::FILE_TEST_EXISTS|Glib::FILE_TEST_IS_DIR)) {
6455 if (find (sp.begin(), sp.end(), sound_path_2X) == sp.end()) {
6456 sp.push_back (sound_path_2X);
6461 // now check the explicit (possibly user-specified) search path
6464 case DataType::AUDIO:
6465 sp += Searchpath(config.get_audio_search_path ());
6467 case DataType::MIDI:
6468 sp += Searchpath(config.get_midi_search_path ());
6476 Session::ensure_search_path_includes (const string& path, DataType type)
6485 case DataType::AUDIO:
6486 sp += Searchpath(config.get_audio_search_path ());
6488 case DataType::MIDI:
6489 sp += Searchpath (config.get_midi_search_path ());
6493 for (vector<std::string>::iterator i = sp.begin(); i != sp.end(); ++i) {
6494 /* No need to add this new directory if it has the same inode as
6495 an existing one; checking inode rather than name prevents duplicated
6496 directories when we are using symlinks.
6498 On Windows, I think we could just do if (*i == path) here.
6500 if (PBD::equivalent_paths (*i, path)) {
6508 case DataType::AUDIO:
6509 config.set_audio_search_path (sp.to_string());
6511 case DataType::MIDI:
6512 config.set_midi_search_path (sp.to_string());
6518 Session::remove_dir_from_search_path (const string& dir, DataType type)
6523 case DataType::AUDIO:
6524 sp = Searchpath(config.get_audio_search_path ());
6526 case DataType::MIDI:
6527 sp = Searchpath (config.get_midi_search_path ());
6534 case DataType::AUDIO:
6535 config.set_audio_search_path (sp.to_string());
6537 case DataType::MIDI:
6538 config.set_midi_search_path (sp.to_string());
6544 boost::shared_ptr<Speakers>
6545 Session::get_speakers()
6551 Session::unknown_processors () const
6555 boost::shared_ptr<RouteList> r = routes.reader ();
6556 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6557 list<string> t = (*i)->unknown_processors ();
6558 copy (t.begin(), t.end(), back_inserter (p));
6568 Session::update_latency (bool playback)
6571 DEBUG_TRACE (DEBUG::Latency, string_compose ("JACK latency callback: %1\n", (playback ? "PLAYBACK" : "CAPTURE")));
6573 if ((_state_of_the_state & (InitialConnecting|Deletion)) || _adding_routes_in_progress || _route_deletion_in_progress) {
6577 boost::shared_ptr<RouteList> r = routes.reader ();
6578 framecnt_t max_latency = 0;
6581 /* reverse the list so that we work backwards from the last route to run to the first */
6582 RouteList* rl = routes.reader().get();
6583 r.reset (new RouteList (*rl));
6584 reverse (r->begin(), r->end());
6587 /* compute actual latency values for the given direction and store them all in per-port
6588 structures. this will also publish the same values (to JACK) so that computation of latency
6589 for routes can consistently use public latency values.
6592 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6593 max_latency = max (max_latency, (*i)->set_private_port_latencies (playback));
6596 /* because we latency compensate playback, our published playback latencies should
6597 be the same for all output ports - all material played back by ardour has
6598 the same latency, whether its caused by plugins or by latency compensation. since
6599 these may differ from the values computed above, reset all playback port latencies
6603 DEBUG_TRACE (DEBUG::Latency, string_compose ("Set public port latencies to %1\n", max_latency));
6605 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6606 (*i)->set_public_port_latencies (max_latency, playback);
6611 post_playback_latency ();
6615 post_capture_latency ();
6618 DEBUG_TRACE (DEBUG::Latency, "JACK latency callback: DONE\n");
6622 Session::post_playback_latency ()
6624 set_worst_playback_latency ();
6626 boost::shared_ptr<RouteList> r = routes.reader ();
6628 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6629 if (!(*i)->is_auditioner() && ((*i)->active())) {
6630 _worst_track_latency = max (_worst_track_latency, (*i)->update_signal_latency ());
6634 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6635 (*i)->set_latency_compensation (_worst_track_latency);
6640 Session::post_capture_latency ()
6642 set_worst_capture_latency ();
6644 /* reflect any changes in capture latencies into capture offsets
6647 boost::shared_ptr<RouteList> rl = routes.reader();
6648 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
6649 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
6651 tr->set_capture_offset ();
6657 Session::initialize_latencies ()
6660 Glib::Threads::Mutex::Lock lm (_engine.process_lock());
6661 update_latency (false);
6662 update_latency (true);
6665 set_worst_io_latencies ();
6669 Session::set_worst_io_latencies ()
6671 set_worst_playback_latency ();
6672 set_worst_capture_latency ();
6676 Session::set_worst_playback_latency ()
6678 if (_state_of_the_state & (InitialConnecting|Deletion)) {
6682 _worst_output_latency = 0;
6684 if (!_engine.connected()) {
6688 boost::shared_ptr<RouteList> r = routes.reader ();
6690 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6691 _worst_output_latency = max (_worst_output_latency, (*i)->output()->latency());
6694 DEBUG_TRACE (DEBUG::Latency, string_compose ("Worst output latency: %1\n", _worst_output_latency));
6698 Session::set_worst_capture_latency ()
6700 if (_state_of_the_state & (InitialConnecting|Deletion)) {
6704 _worst_input_latency = 0;
6706 if (!_engine.connected()) {
6710 boost::shared_ptr<RouteList> r = routes.reader ();
6712 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6713 _worst_input_latency = max (_worst_input_latency, (*i)->input()->latency());
6716 DEBUG_TRACE (DEBUG::Latency, string_compose ("Worst input latency: %1\n", _worst_input_latency));
6720 Session::update_latency_compensation (bool force_whole_graph)
6722 bool some_track_latency_changed = false;
6724 if (_state_of_the_state & (InitialConnecting|Deletion)) {
6728 DEBUG_TRACE(DEBUG::Latency, "---------------------------- update latency compensation\n\n");
6730 _worst_track_latency = 0;
6732 boost::shared_ptr<RouteList> r = routes.reader ();
6734 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6735 if (!(*i)->is_auditioner() && ((*i)->active())) {
6737 if ((*i)->signal_latency () != (tl = (*i)->update_signal_latency ())) {
6738 some_track_latency_changed = true;
6740 _worst_track_latency = max (tl, _worst_track_latency);
6744 DEBUG_TRACE (DEBUG::Latency, string_compose ("worst signal processing latency: %1 (changed ? %2)\n", _worst_track_latency,
6745 (some_track_latency_changed ? "yes" : "no")));
6747 DEBUG_TRACE(DEBUG::Latency, "---------------------------- DONE update latency compensation\n\n");
6749 if (some_track_latency_changed || force_whole_graph) {
6750 _engine.update_latencies ();
6754 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6755 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
6759 tr->set_capture_offset ();
6764 Session::session_name_is_legal (const string& path)
6766 char illegal_chars[] = { '/', '\\', ':', ';', '\0' };
6768 for (int i = 0; illegal_chars[i]; ++i) {
6769 if (path.find (illegal_chars[i]) != string::npos) {
6770 return illegal_chars[i];
6778 Session::notify_presentation_info_change ()
6780 if (deletion_in_progress()) {
6784 PresentationInfo::Change (); /* EMIT SIGNAL */
6785 reassign_track_numbers();
6787 #ifdef USE_TRACKS_CODE_FEATURES
6788 /* Waves Tracks: for Waves Tracks session it's required to reconnect their IOs
6789 * if track order has been changed by user
6791 reconnect_existing_routes(true, true);
6797 Session::operation_in_progress (GQuark op) const
6799 return (find (_current_trans_quarks.begin(), _current_trans_quarks.end(), op) != _current_trans_quarks.end());
6802 boost::shared_ptr<Port>
6803 Session::ltc_input_port () const
6805 return _ltc_input->nth (0);
6808 boost::shared_ptr<Port>
6809 Session::ltc_output_port () const
6811 return _ltc_output->nth (0);
6815 Session::reconnect_ltc_input ()
6819 string src = Config->get_ltc_source_port();
6821 _ltc_input->disconnect (this);
6823 if (src != _("None") && !src.empty()) {
6824 _ltc_input->nth (0)->connect (src);
6827 if ( ARDOUR::Profile->get_trx () ) {
6828 // Tracks need this signal to update timecode_source_dropdown
6829 MtcOrLtcInputPortChanged (); //emit signal
6835 Session::reconnect_ltc_output ()
6839 string src = Config->get_ltc_output_port();
6841 _ltc_output->disconnect (this);
6843 if (src != _("None") && !src.empty()) {
6844 _ltc_output->nth (0)->connect (src);
6850 Session::set_range_selection (framepos_t start, framepos_t end)
6852 _range_selection = Evoral::Range<framepos_t> (start, end);
6853 #ifdef USE_TRACKS_CODE_FEATURES
6854 follow_playhead_priority ();
6859 Session::set_object_selection (framepos_t start, framepos_t end)
6861 _object_selection = Evoral::Range<framepos_t> (start, end);
6862 #ifdef USE_TRACKS_CODE_FEATURES
6863 follow_playhead_priority ();
6868 Session::clear_range_selection ()
6870 _range_selection = Evoral::Range<framepos_t> (-1,-1);
6871 #ifdef USE_TRACKS_CODE_FEATURES
6872 follow_playhead_priority ();
6877 Session::clear_object_selection ()
6879 _object_selection = Evoral::Range<framepos_t> (-1,-1);
6880 #ifdef USE_TRACKS_CODE_FEATURES
6881 follow_playhead_priority ();
6886 Session::auto_connect_route (boost::shared_ptr<Route> route, bool connect_inputs,
6887 const ChanCount& input_start,
6888 const ChanCount& output_start,
6889 const ChanCount& input_offset,
6890 const ChanCount& output_offset)
6892 Glib::Threads::Mutex::Lock lx (_auto_connect_queue_lock);
6893 _auto_connect_queue.push (AutoConnectRequest (route, connect_inputs,
6894 input_start, output_start,
6895 input_offset, output_offset));
6897 auto_connect_thread_wakeup ();
6901 Session::auto_connect_thread_wakeup ()
6903 if (pthread_mutex_trylock (&_auto_connect_mutex) == 0) {
6904 pthread_cond_signal (&_auto_connect_cond);
6905 pthread_mutex_unlock (&_auto_connect_mutex);
6910 Session::queue_latency_recompute ()
6912 g_atomic_int_inc (&_latency_recompute_pending);
6913 auto_connect_thread_wakeup ();
6917 Session::auto_connect (const AutoConnectRequest& ar)
6919 boost::shared_ptr<Route> route = ar.route.lock();
6921 if (!route) { return; }
6923 if (!IO::connecting_legal) {
6927 /* If both inputs and outputs are auto-connected to physical ports,
6928 * use the max of input and output offsets to ensure auto-connected
6929 * port numbers always match up (e.g. the first audio input and the
6930 * first audio output of the route will have the same physical
6931 * port number). Otherwise just use the lowest input or output
6935 const bool in_out_physical =
6936 (Config->get_input_auto_connect() & AutoConnectPhysical)
6937 && (Config->get_output_auto_connect() & AutoConnectPhysical)
6938 && ar.connect_inputs;
6940 const ChanCount in_offset = in_out_physical
6941 ? ChanCount::max(ar.input_offset, ar.output_offset)
6944 const ChanCount out_offset = in_out_physical
6945 ? ChanCount::max(ar.input_offset, ar.output_offset)
6948 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
6949 vector<string> physinputs;
6950 vector<string> physoutputs;
6953 /* for connecting track inputs we only want MIDI ports marked
6957 get_physical_ports (physinputs, physoutputs, *t, MidiPortMusic);
6959 if (!physinputs.empty() && ar.connect_inputs) {
6960 uint32_t nphysical_in = physinputs.size();
6962 for (uint32_t i = ar.input_start.get(*t); i < route->n_inputs().get(*t) && i < nphysical_in; ++i) {
6965 if (Config->get_input_auto_connect() & AutoConnectPhysical) {
6966 port = physinputs[(in_offset.get(*t) + i) % nphysical_in];
6969 if (!port.empty() && route->input()->connect (route->input()->ports().port(*t, i), port, this)) {
6975 if (!physoutputs.empty()) {
6976 uint32_t nphysical_out = physoutputs.size();
6977 for (uint32_t i = ar.output_start.get(*t); i < route->n_outputs().get(*t); ++i) {
6981 * do not create new connections if we reached the limit of physical outputs
6984 if (!(Config->get_output_auto_connect() & AutoConnectMaster) &&
6985 ARDOUR::Profile->get_trx () &&
6986 ar.output_offset.get(*t) == nphysical_out ) {
6990 if ((*t) == DataType::MIDI && (Config->get_output_auto_connect() & AutoConnectPhysical)) {
6991 port = physoutputs[(out_offset.get(*t) + i) % nphysical_out];
6992 } else if ((*t) == DataType::AUDIO && (Config->get_output_auto_connect() & AutoConnectMaster)) {
6993 /* master bus is audio only */
6994 if (_master_out && _master_out->n_inputs().get(*t) > 0) {
6995 port = _master_out->input()->ports().port(*t,
6996 i % _master_out->input()->n_ports().get(*t))->name();
7000 if (!port.empty() && route->output()->connect (route->output()->ports().port(*t, i), port, this)) {
7009 Session::auto_connect_thread_start ()
7011 if (_ac_thread_active) {
7015 while (!_auto_connect_queue.empty ()) {
7016 _auto_connect_queue.pop ();
7019 _ac_thread_active = true;
7020 if (pthread_create (&_auto_connect_thread, NULL, auto_connect_thread, this)) {
7021 _ac_thread_active = false;
7026 Session::auto_connect_thread_terminate ()
7028 if (!_ac_thread_active) {
7031 _ac_thread_active = false;
7034 Glib::Threads::Mutex::Lock lx (_auto_connect_queue_lock);
7035 while (!_auto_connect_queue.empty ()) {
7036 _auto_connect_queue.pop ();
7040 auto_connect_thread_wakeup ();
7043 pthread_join (_auto_connect_thread, &status);
7047 Session::auto_connect_thread (void *arg)
7049 Session *s = static_cast<Session *>(arg);
7050 s->auto_connect_thread_run ();
7056 Session::auto_connect_thread_run ()
7058 pthread_set_name (X_("autoconnect"));
7059 SessionEvent::create_per_thread_pool (X_("autoconnect"), 1024);
7060 PBD::notify_event_loops_about_thread_creation (pthread_self(), X_("autoconnect"), 1024);
7061 pthread_mutex_lock (&_auto_connect_mutex);
7062 while (_ac_thread_active) {
7064 if (!_auto_connect_queue.empty ()) {
7065 // Why would we need the process lock ??
7066 // A: if ports are added while we're connecting, the backend's iterator may be invalidated:
7067 // graph_order_callback() -> resort_routes() -> direct_feeds_according_to_reality () -> backend::connected_to()
7068 // All ardour-internal backends use a std::vector xxxAudioBackend::find_port()
7069 // We have control over those, but what does jack do?
7070 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
7072 Glib::Threads::Mutex::Lock lx (_auto_connect_queue_lock);
7073 while (!_auto_connect_queue.empty ()) {
7074 const AutoConnectRequest ar (_auto_connect_queue.front());
7075 _auto_connect_queue.pop ();
7082 if (!actively_recording ()) { // might not be needed,
7083 /* this is only used for updating plugin latencies, the
7084 * graph does not change. so it's safe in general.
7086 * .. update_latency_compensation () entails set_capture_offset()
7087 * which calls Diskstream::set_capture_offset () which
7088 * modifies the capture offset... which can be a proplem
7089 * in "prepare_to_stop"
7091 while (g_atomic_int_and (&_latency_recompute_pending, 0)) {
7092 update_latency_compensation ();
7096 AudioEngine::instance()->clear_pending_port_deletions ();
7098 pthread_cond_wait (&_auto_connect_cond, &_auto_connect_mutex);
7100 pthread_mutex_unlock (&_auto_connect_mutex);
7104 Session::cancel_all_solo ()
7108 get_stripables (sl);
7110 set_controls (stripable_list_to_control_list (sl, &Stripable::solo_control), 0.0, Controllable::NoGroup);
7111 clear_all_solo_state (routes.reader());