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/playlist_factory.h"
85 #include "ardour/plugin.h"
86 #include "ardour/plugin_insert.h"
87 #include "ardour/process_thread.h"
88 #include "ardour/profile.h"
89 #include "ardour/rc_configuration.h"
90 #include "ardour/recent_sessions.h"
91 #include "ardour/region.h"
92 #include "ardour/region_factory.h"
93 #include "ardour/revision.h"
94 #include "ardour/route_graph.h"
95 #include "ardour/route_group.h"
96 #include "ardour/send.h"
97 #include "ardour/session.h"
98 #include "ardour/session_directory.h"
99 #include "ardour/session_playlists.h"
100 #include "ardour/smf_source.h"
101 #include "ardour/solo_isolate_control.h"
102 #include "ardour/source_factory.h"
103 #include "ardour/speakers.h"
104 #include "ardour/tempo.h"
105 #include "ardour/ticker.h"
106 #include "ardour/track.h"
107 #include "ardour/user_bundle.h"
108 #include "ardour/utils.h"
109 #include "ardour/vca_manager.h"
110 #include "ardour/vca.h"
112 #include "midi++/port.h"
113 #include "midi++/mmc.h"
115 #include "LuaBridge/LuaBridge.h"
117 #include "pbd/i18n.h"
119 #include <glibmm/checksum.h>
128 using namespace ARDOUR;
131 bool Session::_disable_all_loaded_plugins = false;
132 bool Session::_bypass_all_loaded_plugins = false;
133 guint Session::_name_id_counter = 0;
135 PBD::Signal1<int,uint32_t> Session::AudioEngineSetupRequired;
136 PBD::Signal1<void,std::string> Session::Dialog;
137 PBD::Signal0<int> Session::AskAboutPendingState;
138 PBD::Signal2<int, framecnt_t, framecnt_t> Session::AskAboutSampleRateMismatch;
139 PBD::Signal2<void, framecnt_t, framecnt_t> Session::NotifyAboutSampleRateMismatch;
140 PBD::Signal0<void> Session::SendFeedback;
141 PBD::Signal3<int,Session*,std::string,DataType> Session::MissingFile;
143 PBD::Signal1<void, framepos_t> Session::StartTimeChanged;
144 PBD::Signal1<void, framepos_t> Session::EndTimeChanged;
145 PBD::Signal2<void,std::string, std::string> Session::Exported;
146 PBD::Signal1<int,boost::shared_ptr<Playlist> > Session::AskAboutPlaylistDeletion;
147 PBD::Signal0<void> Session::Quit;
148 PBD::Signal0<void> Session::FeedbackDetected;
149 PBD::Signal0<void> Session::SuccessfulGraphSort;
150 PBD::Signal2<void,std::string,std::string> Session::VersionMismatch;
152 const framecnt_t Session::bounce_chunk_size = 8192;
153 static void clean_up_session_event (SessionEvent* ev) { delete ev; }
154 const SessionEvent::RTeventCallback Session::rt_cleanup (clean_up_session_event);
156 // seconds should be added after the region exceeds end marker
157 #ifdef USE_TRACKS_CODE_FEATURES
158 const uint32_t Session::session_end_shift = 5;
160 const uint32_t Session::session_end_shift = 0;
163 /** @param snapshot_name Snapshot name, without .ardour suffix */
164 Session::Session (AudioEngine &eng,
165 const string& fullpath,
166 const string& snapshot_name,
167 BusProfile* bus_profile,
169 : playlists (new SessionPlaylists)
171 , process_function (&Session::process_with_events)
172 , _bounce_processing_active (false)
173 , waiting_for_sync_offset (false)
174 , _base_frame_rate (0)
175 , _nominal_frame_rate (0)
176 , _current_frame_rate (0)
177 , transport_sub_state (0)
178 , _record_status (Disabled)
179 , _transport_frame (0)
180 , _session_range_location (0)
181 , _session_range_end_is_free (true)
184 , _transport_speed (0)
185 , _default_transport_speed (1.0)
186 , _last_transport_speed (0)
187 , _target_transport_speed (0.0)
188 , auto_play_legal (false)
189 , _last_slave_transport_frame (0)
190 , maximum_output_latency (0)
191 , _requested_return_frame (-1)
192 , current_block_size (0)
193 , _worst_output_latency (0)
194 , _worst_input_latency (0)
195 , _worst_track_latency (0)
196 , _have_captured (false)
197 , _non_soloed_outs_muted (false)
200 , _solo_isolated_cnt (0)
202 , _was_seamless (Config->get_seamless_loop ())
203 , _under_nsm_control (false)
205 , delta_accumulator_cnt (0)
206 , average_slave_delta (1800) // !!! why 1800 ???
208 , have_first_delta_accumulator (false)
209 , _slave_state (Stopped)
210 , _mtc_active (false)
211 , _ltc_active (false)
212 , post_export_sync (false)
213 , post_export_position (0)
215 , _export_rolling (false)
216 , _realtime_export (false)
217 , _region_export (false)
218 , _export_preroll (0)
219 , _export_latency (0)
220 , _pre_export_mmc_enabled (false)
221 , _name (snapshot_name)
223 , _send_qf_mtc (false)
224 , _pframes_since_last_mtc (0)
225 , session_midi_feedback (0)
227 , loop_changing (false)
229 , _session_dir (new SessionDirectory (fullpath))
230 , _current_snapshot_name (snapshot_name)
232 , state_was_pending (false)
233 , _state_of_the_state (StateOfTheState(CannotSave|InitialConnecting|Loading))
235 , _save_queued (false)
236 , _last_roll_location (0)
237 , _last_roll_or_reversal_location (0)
238 , _last_record_location (0)
239 , pending_locate_roll (false)
240 , pending_locate_frame (0)
241 , pending_locate_flush (false)
242 , pending_abort (false)
243 , pending_auto_loop (false)
244 , _mempool ("Session", 2097152)
245 , lua (lua_newstate (&PBD::ReallocPool::lalloc, &_mempool))
247 , _butler (new Butler (*this))
248 , _post_transport_work (0)
249 , cumulative_rf_motion (0)
251 , _locations (new Locations (*this))
252 , _ignore_skips_updates (false)
253 , _rt_thread_active (false)
254 , _rt_emit_pending (false)
255 , _ac_thread_active (false)
256 , _latency_recompute_pending (0)
258 , outbound_mtc_timecode_frame (0)
259 , next_quarter_frame_to_send (-1)
260 , _samples_per_timecode_frame (0)
261 , _frames_per_hour (0)
262 , _timecode_frames_per_hour (0)
263 , last_timecode_valid (false)
264 , last_timecode_when (0)
265 , _send_timecode_update (false)
277 , ltc_timecode_offset (0)
278 , ltc_timecode_negative_offset (false)
279 , midi_control_ui (0)
281 , _all_route_group (new RouteGroup (*this, "all"))
282 , routes (new RouteList)
283 , _adding_routes_in_progress (false)
284 , _reconnecting_routes_in_progress (false)
285 , _route_deletion_in_progress (false)
286 , destructive_index (0)
287 , _track_number_decimals(1)
288 , default_fade_steepness (0)
289 , default_fade_msecs (0)
290 , _total_free_4k_blocks (0)
291 , _total_free_4k_blocks_uncertain (false)
292 , no_questions_about_missing_files (false)
295 , _bundles (new BundleList)
296 , _bundle_xml_node (0)
300 , click_emphasis_data (0)
302 , click_emphasis_length (0)
303 , _clicks_cleared (0)
304 , _play_range (false)
305 , _range_selection (-1,-1)
306 , _object_selection (-1,-1)
308 , first_file_data_format_reset (true)
309 , first_file_header_format_reset (true)
310 , have_looped (false)
311 , _have_rec_enabled_track (false)
312 , _have_rec_disabled_track (true)
314 , _suspend_timecode_transmission (0)
315 , _speakers (new Speakers)
316 , _ignore_route_processor_changes (0)
321 , _vca_manager (new VCAManager (*this))
325 created_with = string_compose ("%1 %2", PROGRAM_NAME, revision);
327 pthread_mutex_init (&_rt_emit_mutex, 0);
328 pthread_cond_init (&_rt_emit_cond, 0);
330 pthread_mutex_init (&_auto_connect_mutex, 0);
331 pthread_cond_init (&_auto_connect_cond, 0);
333 init_name_id_counter (1); // reset for new sessions, start at 1
334 VCA::set_next_vca_number (1); // reset for new sessions, start at 1
336 pre_engine_init (fullpath);
342 Stateful::loading_state_version = CURRENT_SESSION_FILE_VERSION;
344 #ifdef USE_TRACKS_CODE_FEATURES
345 sr = EngineStateController::instance()->get_current_sample_rate();
347 if (ensure_engine (sr, true)) {
349 throw SessionException (_("Cannot connect to audio/midi engine"));
352 // set samplerate for plugins added early
353 // e.g from templates or MB channelstrip
354 set_block_size (_engine.samples_per_cycle());
355 set_frame_rate (_engine.sample_rate());
357 if (create (mix_template, bus_profile)) {
359 throw SessionException (_("Session initialization failed"));
362 /* if a mix template was provided, then ::create() will
363 * have copied it into the session and we need to load it
364 * so that we have the state ready for ::set_state()
365 * after the engine is started.
367 * Note that we do NOT try to get the sample rate from
368 * the template at this time, though doing so would
369 * be easy if we decided this was an appropriate part
373 if (!mix_template.empty()) {
374 if (load_state (_current_snapshot_name)) {
375 throw SessionException (_("Failed to load template/snapshot state"));
377 store_recent_templates (mix_template);
380 /* load default session properties - if any */
385 if (load_state (_current_snapshot_name)) {
386 throw SessionException (_("Failed to load state"));
389 /* try to get sample rate from XML state so that we
390 * can influence the SR if we set up the audio
395 XMLProperty const * prop;
396 XMLNode const * root (state_tree->root());
397 if ((prop = root->property (X_("sample-rate"))) != 0) {
398 sr = atoi (prop->value());
402 if (ensure_engine (sr, false)) {
404 throw SessionException (_("Cannot connect to audio/midi engine"));
408 if (post_engine_init ()) {
410 throw SessionException (_("Cannot configure audio/midi engine with session parameters"));
413 store_recent_sessions (_name, _path);
415 bool was_dirty = dirty();
417 _state_of_the_state = StateOfTheState (_state_of_the_state & ~Dirty);
419 Config->ParameterChanged.connect_same_thread (*this, boost::bind (&Session::config_changed, this, _1, false));
420 config.ParameterChanged.connect_same_thread (*this, boost::bind (&Session::config_changed, this, _1, true));
423 DirtyChanged (); /* EMIT SIGNAL */
426 StartTimeChanged.connect_same_thread (*this, boost::bind (&Session::start_time_changed, this, _1));
427 EndTimeChanged.connect_same_thread (*this, boost::bind (&Session::end_time_changed, this, _1));
429 emit_thread_start ();
430 auto_connect_thread_start ();
432 /* hook us up to the engine since we are now completely constructed */
434 BootMessage (_("Connect to engine"));
436 _engine.set_session (this);
437 _engine.reset_timebase ();
439 #ifdef USE_TRACKS_CODE_FEATURES
441 EngineStateController::instance()->set_session(this);
444 if ( ARDOUR::Profile->get_trx () ) {
446 /* Waves Tracks: fill session with tracks basing on the amount of inputs.
447 * each available input must have corresponding track when session starts.
450 uint32_t how_many (0);
452 std::vector<std::string> inputs;
453 EngineStateController::instance()->get_physical_audio_inputs(inputs);
455 how_many = inputs.size();
457 list<boost::shared_ptr<AudioTrack> > tracks;
459 // Track names after driver
460 if (Config->get_tracks_auto_naming() == NameAfterDriver) {
461 string track_name = "";
462 for (std::vector<string>::size_type i = 0; i < inputs.size(); ++i) {
464 track_name = inputs[i];
465 replace_all (track_name, "system:capture", "");
467 list<boost::shared_ptr<AudioTrack> > single_track = new_audio_track (1, 1, Normal, 0, 1, track_name);
468 tracks.insert(tracks.begin(), single_track.front());
470 } else { // Default track names
471 tracks = new_audio_track (1, 1, Normal, 0, how_many, string());
474 if (tracks.size() != how_many) {
476 throw failed_constructor ();
485 BootMessage (_("Session loading complete"));
497 Session::next_name_id ()
499 return g_atomic_int_add (&_name_id_counter, 1);
503 Session::name_id_counter ()
505 return g_atomic_int_get (&_name_id_counter);
509 Session::init_name_id_counter (guint n)
511 g_atomic_int_set (&_name_id_counter, n);
515 Session::ensure_engine (uint32_t desired_sample_rate, bool isnew)
517 if (_engine.current_backend() == 0) {
518 /* backend is unknown ... */
519 boost::optional<int> r = AudioEngineSetupRequired (desired_sample_rate);
520 if (r.get_value_or (-1) != 0) {
523 } else if (!isnew && _engine.running() && _engine.sample_rate () == desired_sample_rate) {
525 } else if (_engine.setup_required()) {
526 /* backend is known, but setup is needed */
527 boost::optional<int> r = AudioEngineSetupRequired (desired_sample_rate);
528 if (r.get_value_or (-1) != 0) {
531 } else if (!_engine.running()) {
532 if (_engine.start()) {
537 /* at this point the engine should be running */
539 if (!_engine.running()) {
543 return immediately_post_engine ();
548 Session::immediately_post_engine ()
550 /* Do various initializations that should take place directly after we
551 * know that the engine is running, but before we either create a
552 * session or set state for an existing one.
555 if (how_many_dsp_threads () > 1) {
556 /* For now, only create the graph if we are using >1 DSP threads, as
557 it is a bit slower than the old code with 1 thread.
559 _process_graph.reset (new Graph (*this));
562 /* every time we reconnect, recompute worst case output latencies */
564 _engine.Running.connect_same_thread (*this, boost::bind (&Session::initialize_latencies, this));
566 if (synced_to_engine()) {
567 _engine.transport_stop ();
570 if (config.get_jack_time_master()) {
571 _engine.transport_locate (_transport_frame);
576 BootMessage (_("Set up LTC"));
578 BootMessage (_("Set up Click"));
580 BootMessage (_("Set up standard connections"));
584 catch (failed_constructor& err) {
588 /* TODO, connect in different thread. (PortRegisteredOrUnregistered may be in RT context)
590 _engine.PortRegisteredOrUnregistered.connect_same_thread (*this, boost::bind (&Session::setup_bundles, this));
598 vector<void*> debug_pointers;
600 /* if we got to here, leaving pending capture state around
604 remove_pending_capture_state ();
608 _state_of_the_state = StateOfTheState (CannotSave|Deletion);
610 /* stop autoconnecting */
611 auto_connect_thread_terminate ();
613 /* disconnect from any and all signals that we are connected to */
615 Port::PortSignalDrop (); /* EMIT SIGNAL */
618 /* shutdown control surface protocols while we still have ports
619 and the engine to move data to any devices.
622 ControlProtocolManager::instance().drop_protocols ();
624 MIDI::Name::MidiPatchManager::instance().remove_search_path(session_directory().midi_patch_path());
626 _engine.remove_session ();
628 #ifdef USE_TRACKS_CODE_FEATURES
629 EngineStateController::instance()->remove_session();
632 /* deregister all ports - there will be no process or any other
633 * callbacks from the engine any more.
636 Port::PortDrop (); /* EMIT SIGNAL */
640 /* clear history so that no references to objects are held any more */
644 /* clear state tree so that no references to objects are held any more */
649 // unregister all lua functions, drop held references (if any)
651 lua.do_command ("Session = nil");
659 lua.collect_garbage ();
661 /* reset dynamic state version back to default */
662 Stateful::loading_state_version = 0;
664 _butler->drop_references ();
668 delete _all_route_group;
670 DEBUG_TRACE (DEBUG::Destruction, "delete route groups\n");
671 for (list<RouteGroup *>::iterator i = _route_groups.begin(); i != _route_groups.end(); ++i) {
675 if (click_data != default_click) {
676 delete [] click_data;
679 if (click_emphasis_data != default_click_emphasis) {
680 delete [] click_emphasis_data;
685 /* need to remove auditioner before monitoring section
686 * otherwise it is re-connected */
689 /* drop references to routes held by the monitoring section
690 * specifically _monitor_out aux/listen references */
691 remove_monitor_section();
693 /* clear out any pending dead wood from RCU managed objects */
698 AudioDiskstream::free_working_buffers();
700 /* tell everyone who is still standing that we're about to die */
703 /* tell everyone to drop references and delete objects as we go */
705 DEBUG_TRACE (DEBUG::Destruction, "delete regions\n");
706 RegionFactory::delete_all_regions ();
708 /* Do this early so that VCAs no longer hold references to routes */
710 DEBUG_TRACE (DEBUG::Destruction, "delete vcas\n");
713 DEBUG_TRACE (DEBUG::Destruction, "delete routes\n");
715 /* reset these three references to special routes before we do the usual route delete thing */
717 _master_out.reset ();
718 _monitor_out.reset ();
721 RCUWriter<RouteList> writer (routes);
722 boost::shared_ptr<RouteList> r = writer.get_copy ();
724 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
725 DEBUG_TRACE(DEBUG::Destruction, string_compose ("Dropping for route %1 ; pre-ref = %2\n", (*i)->name(), (*i).use_count()));
726 (*i)->drop_references ();
730 /* writer goes out of scope and updates master */
735 DEBUG_TRACE (DEBUG::Destruction, "delete sources\n");
736 Glib::Threads::Mutex::Lock lm (source_lock);
737 for (SourceMap::iterator i = sources.begin(); i != sources.end(); ++i) {
738 DEBUG_TRACE(DEBUG::Destruction, string_compose ("Dropping for source %1 ; pre-ref = %2\n", i->second->name(), i->second.use_count()));
739 i->second->drop_references ();
745 /* not strictly necessary, but doing it here allows the shared_ptr debugging to work */
748 emit_thread_terminate ();
750 pthread_cond_destroy (&_rt_emit_cond);
751 pthread_mutex_destroy (&_rt_emit_mutex);
753 pthread_cond_destroy (&_auto_connect_cond);
754 pthread_mutex_destroy (&_auto_connect_mutex);
756 delete _scene_changer; _scene_changer = 0;
757 delete midi_control_ui; midi_control_ui = 0;
759 delete _mmc; _mmc = 0;
760 delete _midi_ports; _midi_ports = 0;
761 delete _locations; _locations = 0;
766 /* clear event queue, the session is gone, nobody is interested in
767 * those anymore, but they do leak memory if not removed
769 while (!immediate_events.empty ()) {
770 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
771 SessionEvent *ev = immediate_events.front ();
772 DEBUG_TRACE (DEBUG::SessionEvents, string_compose ("Drop event: %1\n", enum_2_string (ev->type)));
773 immediate_events.pop_front ();
777 case SessionEvent::AutoLoop:
778 case SessionEvent::AutoLoopDeclick:
779 case SessionEvent::Skip:
780 case SessionEvent::PunchIn:
781 case SessionEvent::PunchOut:
782 case SessionEvent::StopOnce:
783 case SessionEvent::RangeStop:
784 case SessionEvent::RangeLocate:
788 case SessionEvent::RealTimeOperation:
795 del = del && !_remove_event (ev);
802 DEBUG_TRACE (DEBUG::Destruction, "Session::destroy() done\n");
804 BOOST_SHOW_POINTERS ();
808 Session::setup_ltc ()
812 _ltc_input.reset (new IO (*this, X_("LTC In"), IO::Input));
813 _ltc_output.reset (new IO (*this, X_("LTC Out"), IO::Output));
815 if (state_tree && (child = find_named_node (*state_tree->root(), X_("LTC In"))) != 0) {
816 _ltc_input->set_state (*(child->children().front()), Stateful::loading_state_version);
819 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
820 _ltc_input->ensure_io (ChanCount (DataType::AUDIO, 1), true, this);
821 // TODO use auto-connect thread somehow (needs a route currently)
822 // see note in Session::auto_connect_thread_run() why process lock is needed.
823 reconnect_ltc_input ();
827 if (state_tree && (child = find_named_node (*state_tree->root(), X_("LTC Out"))) != 0) {
828 _ltc_output->set_state (*(child->children().front()), Stateful::loading_state_version);
831 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
832 _ltc_output->ensure_io (ChanCount (DataType::AUDIO, 1), true, this);
833 // TODO use auto-connect thread
834 reconnect_ltc_output ();
838 /* fix up names of LTC ports because we don't want the normal
839 * IO style of NAME/TYPE-{in,out}N
842 _ltc_input->nth (0)->set_name (X_("LTC-in"));
843 _ltc_output->nth (0)->set_name (X_("LTC-out"));
847 Session::setup_click ()
851 boost::shared_ptr<AutomationList> gl (new AutomationList (Evoral::Parameter (GainAutomation)));
852 boost::shared_ptr<GainControl> gain_control = boost::shared_ptr<GainControl> (new GainControl (*this, Evoral::Parameter(GainAutomation), gl));
854 _click_io.reset (new ClickIO (*this, X_("Click")));
855 _click_gain.reset (new Amp (*this, _("Fader"), gain_control, true));
856 _click_gain->activate ();
858 setup_click_state (state_tree->root());
860 setup_click_state (0);
865 Session::setup_click_state (const XMLNode* node)
867 const XMLNode* child = 0;
869 if (node && (child = find_named_node (*node, "Click")) != 0) {
871 /* existing state for Click */
874 if (Stateful::loading_state_version < 3000) {
875 c = _click_io->set_state_2X (*child->children().front(), Stateful::loading_state_version, false);
877 const XMLNodeList& children (child->children());
878 XMLNodeList::const_iterator i = children.begin();
879 if ((c = _click_io->set_state (**i, Stateful::loading_state_version)) == 0) {
881 if (i != children.end()) {
882 c = _click_gain->set_state (**i, Stateful::loading_state_version);
888 _clicking = Config->get_clicking ();
892 error << _("could not setup Click I/O") << endmsg;
899 /* default state for Click: dual-mono to first 2 physical outputs */
902 _engine.get_physical_outputs (DataType::AUDIO, outs);
904 for (uint32_t physport = 0; physport < 2; ++physport) {
905 if (outs.size() > physport) {
906 if (_click_io->add_port (outs[physport], this)) {
907 // relax, even though its an error
912 if (_click_io->n_ports () > ChanCount::ZERO) {
913 _clicking = Config->get_clicking ();
919 Session::get_physical_ports (vector<string>& inputs, vector<string>& outputs, DataType type,
920 MidiPortFlags include, MidiPortFlags exclude)
922 _engine.get_physical_inputs (type, inputs, include, exclude);
923 _engine.get_physical_outputs (type, outputs, include, exclude);
927 Session::setup_bundles ()
931 RCUWriter<BundleList> writer (_bundles);
932 boost::shared_ptr<BundleList> b = writer.get_copy ();
933 for (BundleList::iterator i = b->begin(); i != b->end();) {
934 if (boost::dynamic_pointer_cast<UserBundle>(*i)) {
942 vector<string> inputs[DataType::num_types];
943 vector<string> outputs[DataType::num_types];
945 for (uint32_t i = 0; i < DataType::num_types; ++i) {
946 get_physical_ports (inputs[i], outputs[i], DataType (DataType::Symbol (i)),
947 MidiPortFlags (0), /* no specific inclusions */
948 MidiPortFlags (MidiPortControl|MidiPortVirtual) /* exclude control & virtual ports */
952 /* Create a set of Bundle objects that map
953 to the physical I/O currently available. We create both
954 mono and stereo bundles, so that the common cases of mono
955 and stereo tracks get bundles to put in their mixer strip
956 in / out menus. There may be a nicer way of achieving that;
957 it doesn't really scale that well to higher channel counts
960 /* mono output bundles */
962 for (uint32_t np = 0; np < outputs[DataType::AUDIO].size(); ++np) {
964 std::string pn = _engine.get_pretty_name_by_name (outputs[DataType::AUDIO][np]);
966 snprintf (buf, sizeof (buf), _("out %s"), pn.c_str());
968 snprintf (buf, sizeof (buf), _("out %" PRIu32), np+1);
971 boost::shared_ptr<Bundle> c (new Bundle (buf, true));
972 c->add_channel (_("mono"), DataType::AUDIO);
973 c->set_port (0, outputs[DataType::AUDIO][np]);
975 add_bundle (c, false);
978 /* stereo output bundles */
980 for (uint32_t np = 0; np < outputs[DataType::AUDIO].size(); np += 2) {
981 if (np + 1 < outputs[DataType::AUDIO].size()) {
983 snprintf (buf, sizeof(buf), _("out %" PRIu32 "+%" PRIu32), np + 1, np + 2);
984 boost::shared_ptr<Bundle> c (new Bundle (buf, true));
985 c->add_channel (_("L"), DataType::AUDIO);
986 c->set_port (0, outputs[DataType::AUDIO][np]);
987 c->add_channel (_("R"), DataType::AUDIO);
988 c->set_port (1, outputs[DataType::AUDIO][np + 1]);
990 add_bundle (c, false);
994 /* mono input bundles */
996 for (uint32_t np = 0; np < inputs[DataType::AUDIO].size(); ++np) {
998 std::string pn = _engine.get_pretty_name_by_name (inputs[DataType::AUDIO][np]);
1000 snprintf (buf, sizeof (buf), _("in %s"), pn.c_str());
1002 snprintf (buf, sizeof (buf), _("in %" PRIu32), np+1);
1005 boost::shared_ptr<Bundle> c (new Bundle (buf, false));
1006 c->add_channel (_("mono"), DataType::AUDIO);
1007 c->set_port (0, inputs[DataType::AUDIO][np]);
1009 add_bundle (c, false);
1012 /* stereo input bundles */
1014 for (uint32_t np = 0; np < inputs[DataType::AUDIO].size(); np += 2) {
1015 if (np + 1 < inputs[DataType::AUDIO].size()) {
1017 snprintf (buf, sizeof(buf), _("in %" PRIu32 "+%" PRIu32), np + 1, np + 2);
1019 boost::shared_ptr<Bundle> c (new Bundle (buf, false));
1020 c->add_channel (_("L"), DataType::AUDIO);
1021 c->set_port (0, inputs[DataType::AUDIO][np]);
1022 c->add_channel (_("R"), DataType::AUDIO);
1023 c->set_port (1, inputs[DataType::AUDIO][np + 1]);
1025 add_bundle (c, false);
1029 /* MIDI input bundles */
1031 for (uint32_t np = 0; np < inputs[DataType::MIDI].size(); ++np) {
1032 string n = inputs[DataType::MIDI][np];
1034 std::string pn = _engine.get_pretty_name_by_name (n);
1038 boost::erase_first (n, X_("alsa_pcm:"));
1040 boost::shared_ptr<Bundle> c (new Bundle (n, false));
1041 c->add_channel ("", DataType::MIDI);
1042 c->set_port (0, inputs[DataType::MIDI][np]);
1043 add_bundle (c, false);
1046 /* MIDI output bundles */
1048 for (uint32_t np = 0; np < outputs[DataType::MIDI].size(); ++np) {
1049 string n = outputs[DataType::MIDI][np];
1050 std::string pn = _engine.get_pretty_name_by_name (n);
1054 boost::erase_first (n, X_("alsa_pcm:"));
1056 boost::shared_ptr<Bundle> c (new Bundle (n, true));
1057 c->add_channel ("", DataType::MIDI);
1058 c->set_port (0, outputs[DataType::MIDI][np]);
1059 add_bundle (c, false);
1062 // we trust the backend to only calls us if there's a change
1063 BundleAddedOrRemoved (); /* EMIT SIGNAL */
1067 Session::auto_connect_master_bus ()
1069 if (!_master_out || !Config->get_auto_connect_standard_busses() || _monitor_out) {
1073 // Waves Tracks: Do not connect master bas for Tracks if AutoConnectMaster option is not set
1074 // In this case it means "Multi Out" output mode
1075 if (ARDOUR::Profile->get_trx() && !(Config->get_output_auto_connect() & AutoConnectMaster) ) {
1079 /* if requested auto-connect the outputs to the first N physical ports.
1082 uint32_t limit = _master_out->n_outputs().n_total();
1083 vector<string> outputs[DataType::num_types];
1085 for (uint32_t i = 0; i < DataType::num_types; ++i) {
1086 _engine.get_physical_outputs (DataType (DataType::Symbol (i)), outputs[i]);
1089 for (uint32_t n = 0; n < limit; ++n) {
1090 boost::shared_ptr<Port> p = _master_out->output()->nth (n);
1092 if (outputs[p->type()].size() > n) {
1093 connect_to = outputs[p->type()][n];
1096 if (!connect_to.empty() && p->connected_to (connect_to) == false) {
1097 if (_master_out->output()->connect (p, connect_to, this)) {
1098 error << string_compose (_("cannot connect master output %1 to %2"), n, connect_to)
1107 Session::remove_monitor_section ()
1109 if (!_monitor_out || Profile->get_trx()) {
1113 /* force reversion to Solo-In-Place */
1114 Config->set_solo_control_is_listen_control (false);
1116 /* if we are auditioning, cancel it ... this is a workaround
1117 to a problem (auditioning does not execute the process graph,
1118 which is needed to remove routes when using >1 core for processing)
1123 /* Hold process lock while doing this so that we don't hear bits and
1124 * pieces of audio as we work on each route.
1127 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
1129 /* Connect tracks to monitor section. Note that in an
1130 existing session, the internal sends will already exist, but we want the
1131 routes to notice that they connect to the control out specifically.
1135 boost::shared_ptr<RouteList> r = routes.reader ();
1136 ProcessorChangeBlocker pcb (this, false);
1138 for (RouteList::iterator x = r->begin(); x != r->end(); ++x) {
1140 if ((*x)->is_monitor()) {
1142 } else if ((*x)->is_master()) {
1145 (*x)->remove_aux_or_listen (_monitor_out);
1150 remove_route (_monitor_out);
1151 if (_state_of_the_state & Deletion) {
1155 auto_connect_master_bus ();
1158 auditioner->connect ();
1161 Config->ParameterChanged ("use-monitor-bus");
1165 Session::add_monitor_section ()
1169 if (_monitor_out || !_master_out || Profile->get_trx()) {
1173 boost::shared_ptr<Route> r (new Route (*this, _("Monitor"), PresentationInfo::MonitorOut, DataType::AUDIO));
1179 BOOST_MARK_ROUTE(r);
1182 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
1183 r->input()->ensure_io (_master_out->output()->n_ports(), false, this);
1184 r->output()->ensure_io (_master_out->output()->n_ports(), false, this);
1186 error << _("Cannot create monitor section. 'Monitor' Port name is not unique.") << endmsg;
1191 add_routes (rl, false, false, false, 0);
1193 assert (_monitor_out);
1195 /* AUDIO ONLY as of june 29th 2009, because listen semantics for anything else
1196 are undefined, at best.
1199 uint32_t limit = _monitor_out->n_inputs().n_audio();
1203 /* connect the inputs to the master bus outputs. this
1204 * represents a separate data feed from the internal sends from
1205 * each route. as of jan 2011, it allows the monitor section to
1206 * conditionally ignore either the internal sends or the normal
1207 * input feed, but we should really find a better way to do
1211 _master_out->output()->disconnect (this);
1213 for (uint32_t n = 0; n < limit; ++n) {
1214 boost::shared_ptr<AudioPort> p = _monitor_out->input()->ports().nth_audio_port (n);
1215 boost::shared_ptr<AudioPort> o = _master_out->output()->ports().nth_audio_port (n);
1218 string connect_to = o->name();
1219 if (_monitor_out->input()->connect (p, connect_to, this)) {
1220 error << string_compose (_("cannot connect control input %1 to %2"), n, connect_to)
1228 /* if monitor section is not connected, connect it to physical outs
1231 if ((Config->get_auto_connect_standard_busses () || Profile->get_mixbus ()) && !_monitor_out->output()->connected ()) {
1233 if (!Config->get_monitor_bus_preferred_bundle().empty()) {
1235 boost::shared_ptr<Bundle> b = bundle_by_name (Config->get_monitor_bus_preferred_bundle());
1238 _monitor_out->output()->connect_ports_to_bundle (b, true, this);
1240 warning << string_compose (_("The preferred I/O for the monitor bus (%1) cannot be found"),
1241 Config->get_monitor_bus_preferred_bundle())
1247 /* Monitor bus is audio only */
1249 vector<string> outputs[DataType::num_types];
1251 for (uint32_t i = 0; i < DataType::num_types; ++i) {
1252 _engine.get_physical_outputs (DataType (DataType::Symbol (i)), outputs[i]);
1255 uint32_t mod = outputs[DataType::AUDIO].size();
1256 uint32_t limit = _monitor_out->n_outputs().get (DataType::AUDIO);
1260 for (uint32_t n = 0; n < limit; ++n) {
1262 boost::shared_ptr<Port> p = _monitor_out->output()->ports().port(DataType::AUDIO, n);
1264 if (outputs[DataType::AUDIO].size() > (n % mod)) {
1265 connect_to = outputs[DataType::AUDIO][n % mod];
1268 if (!connect_to.empty()) {
1269 if (_monitor_out->output()->connect (p, connect_to, this)) {
1270 error << string_compose (
1271 _("cannot connect control output %1 to %2"),
1282 /* Hold process lock while doing this so that we don't hear bits and
1283 * pieces of audio as we work on each route.
1286 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
1288 /* Connect tracks to monitor section. Note that in an
1289 existing session, the internal sends will already exist, but we want the
1290 routes to notice that they connect to the control out specifically.
1294 boost::shared_ptr<RouteList> rls = routes.reader ();
1296 ProcessorChangeBlocker pcb (this, false /* XXX */);
1298 for (RouteList::iterator x = rls->begin(); x != rls->end(); ++x) {
1300 if ((*x)->is_monitor()) {
1302 } else if ((*x)->is_master()) {
1305 (*x)->enable_monitor_send ();
1310 auditioner->connect ();
1312 Config->ParameterChanged ("use-monitor-bus");
1316 Session::reset_monitor_section ()
1318 /* Process lock should be held by the caller.*/
1320 if (!_monitor_out || Profile->get_trx()) {
1324 uint32_t limit = _master_out->n_outputs().n_audio();
1326 /* connect the inputs to the master bus outputs. this
1327 * represents a separate data feed from the internal sends from
1328 * each route. as of jan 2011, it allows the monitor section to
1329 * conditionally ignore either the internal sends or the normal
1330 * input feed, but we should really find a better way to do
1334 _master_out->output()->disconnect (this);
1335 _monitor_out->output()->disconnect (this);
1337 // monitor section follow master bus - except midi
1338 ChanCount mon_chn (_master_out->output()->n_ports());
1339 mon_chn.set_midi (0);
1341 _monitor_out->input()->ensure_io (mon_chn, false, this);
1342 _monitor_out->output()->ensure_io (mon_chn, false, this);
1344 for (uint32_t n = 0; n < limit; ++n) {
1345 boost::shared_ptr<AudioPort> p = _monitor_out->input()->ports().nth_audio_port (n);
1346 boost::shared_ptr<AudioPort> o = _master_out->output()->ports().nth_audio_port (n);
1349 string connect_to = o->name();
1350 if (_monitor_out->input()->connect (p, connect_to, this)) {
1351 error << string_compose (_("cannot connect control input %1 to %2"), n, connect_to)
1358 /* connect monitor section to physical outs
1361 if (Config->get_auto_connect_standard_busses()) {
1363 if (!Config->get_monitor_bus_preferred_bundle().empty()) {
1365 boost::shared_ptr<Bundle> b = bundle_by_name (Config->get_monitor_bus_preferred_bundle());
1368 _monitor_out->output()->connect_ports_to_bundle (b, true, this);
1370 warning << string_compose (_("The preferred I/O for the monitor bus (%1) cannot be found"),
1371 Config->get_monitor_bus_preferred_bundle())
1377 /* Monitor bus is audio only */
1379 vector<string> outputs[DataType::num_types];
1381 for (uint32_t i = 0; i < DataType::num_types; ++i) {
1382 _engine.get_physical_outputs (DataType (DataType::Symbol (i)), outputs[i]);
1385 uint32_t mod = outputs[DataType::AUDIO].size();
1386 uint32_t limit = _monitor_out->n_outputs().get (DataType::AUDIO);
1390 for (uint32_t n = 0; n < limit; ++n) {
1392 boost::shared_ptr<Port> p = _monitor_out->output()->ports().port(DataType::AUDIO, n);
1394 if (outputs[DataType::AUDIO].size() > (n % mod)) {
1395 connect_to = outputs[DataType::AUDIO][n % mod];
1398 if (!connect_to.empty()) {
1399 if (_monitor_out->output()->connect (p, connect_to, this)) {
1400 error << string_compose (
1401 _("cannot connect control output %1 to %2"),
1412 /* Connect tracks to monitor section. Note that in an
1413 existing session, the internal sends will already exist, but we want the
1414 routes to notice that they connect to the control out specifically.
1418 boost::shared_ptr<RouteList> rls = routes.reader ();
1420 ProcessorChangeBlocker pcb (this, false);
1422 for (RouteList::iterator x = rls->begin(); x != rls->end(); ++x) {
1424 if ((*x)->is_monitor()) {
1426 } else if ((*x)->is_master()) {
1429 (*x)->enable_monitor_send ();
1435 Session::hookup_io ()
1437 /* stop graph reordering notifications from
1438 causing resorts, etc.
1441 _state_of_the_state = StateOfTheState (_state_of_the_state | InitialConnecting);
1445 /* we delay creating the auditioner till now because
1446 it makes its own connections to ports.
1450 boost::shared_ptr<Auditioner> a (new Auditioner (*this));
1452 throw failed_constructor ();
1454 a->use_new_diskstream ();
1458 catch (failed_constructor& err) {
1459 warning << _("cannot create Auditioner: no auditioning of regions possible") << endmsg;
1463 /* load bundles, which we may have postponed earlier on */
1464 if (_bundle_xml_node) {
1465 load_bundles (*_bundle_xml_node);
1466 delete _bundle_xml_node;
1469 /* Tell all IO objects to connect themselves together */
1471 IO::enable_connecting ();
1473 /* Now tell all "floating" ports to connect to whatever
1474 they should be connected to.
1477 AudioEngine::instance()->reconnect_ports ();
1479 /* Anyone who cares about input state, wake up and do something */
1481 IOConnectionsComplete (); /* EMIT SIGNAL */
1483 _state_of_the_state = StateOfTheState (_state_of_the_state & ~InitialConnecting);
1485 /* now handle the whole enchilada as if it was one
1486 graph reorder event.
1491 /* update the full solo state, which can't be
1492 correctly determined on a per-route basis, but
1493 needs the global overview that only the session
1497 update_route_solo_state ();
1501 Session::track_playlist_changed (boost::weak_ptr<Track> wp)
1503 boost::shared_ptr<Track> track = wp.lock ();
1508 boost::shared_ptr<Playlist> playlist;
1510 if ((playlist = track->playlist()) != 0) {
1511 playlist->RegionAdded.connect_same_thread (*this, boost::bind (&Session::playlist_region_added, this, _1));
1512 playlist->RangesMoved.connect_same_thread (*this, boost::bind (&Session::playlist_ranges_moved, this, _1));
1513 playlist->RegionsExtended.connect_same_thread (*this, boost::bind (&Session::playlist_regions_extended, this, _1));
1518 Session::record_enabling_legal () const
1520 /* this used to be in here, but survey says.... we don't need to restrict it */
1521 // if (record_status() == Recording) {
1525 if (Config->get_all_safe()) {
1532 Session::set_track_monitor_input_status (bool yn)
1534 boost::shared_ptr<RouteList> rl = routes.reader ();
1535 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
1536 boost::shared_ptr<AudioTrack> tr = boost::dynamic_pointer_cast<AudioTrack> (*i);
1537 if (tr && tr->rec_enable_control()->get_value()) {
1538 //cerr << "switching to input = " << !auto_input << __FILE__ << __LINE__ << endl << endl;
1539 tr->request_input_monitoring (yn);
1545 Session::auto_punch_start_changed (Location* location)
1547 replace_event (SessionEvent::PunchIn, location->start());
1549 if (get_record_enabled() && config.get_punch_in()) {
1550 /* capture start has been changed, so save new pending state */
1551 save_state ("", true);
1556 Session::auto_punch_end_changed (Location* location)
1558 framepos_t when_to_stop = location->end();
1559 // when_to_stop += _worst_output_latency + _worst_input_latency;
1560 replace_event (SessionEvent::PunchOut, when_to_stop);
1564 Session::auto_punch_changed (Location* location)
1566 framepos_t when_to_stop = location->end();
1568 replace_event (SessionEvent::PunchIn, location->start());
1569 //when_to_stop += _worst_output_latency + _worst_input_latency;
1570 replace_event (SessionEvent::PunchOut, when_to_stop);
1573 /** @param loc A loop location.
1574 * @param pos Filled in with the start time of the required fade-out (in session frames).
1575 * @param length Filled in with the length of the required fade-out.
1578 Session::auto_loop_declick_range (Location* loc, framepos_t & pos, framepos_t & length)
1580 pos = max (loc->start(), loc->end() - 64);
1581 length = loc->end() - pos;
1585 Session::auto_loop_changed (Location* location)
1587 replace_event (SessionEvent::AutoLoop, location->end(), location->start());
1590 auto_loop_declick_range (location, dcp, dcl);
1592 if (transport_rolling() && play_loop) {
1594 replace_event (SessionEvent::AutoLoopDeclick, dcp, dcl);
1596 // if (_transport_frame > location->end()) {
1598 if (_transport_frame < location->start() || _transport_frame > location->end()) {
1599 // relocate to beginning of loop
1600 clear_events (SessionEvent::LocateRoll);
1602 request_locate (location->start(), true);
1605 else if (Config->get_seamless_loop() && !loop_changing) {
1607 // schedule a locate-roll to refill the diskstreams at the
1608 // previous loop end
1609 loop_changing = true;
1611 if (location->end() > last_loopend) {
1612 clear_events (SessionEvent::LocateRoll);
1613 SessionEvent *ev = new SessionEvent (SessionEvent::LocateRoll, SessionEvent::Add, last_loopend, last_loopend, 0, true);
1619 clear_events (SessionEvent::AutoLoopDeclick);
1620 clear_events (SessionEvent::AutoLoop);
1623 /* possibly move playhead if not rolling; if we are rolling we'll move
1624 to the loop start on stop if that is appropriate.
1629 if (!transport_rolling() && select_playhead_priority_target (pos)) {
1630 if (pos == location->start()) {
1631 request_locate (pos);
1636 last_loopend = location->end();
1641 Session::set_auto_punch_location (Location* location)
1645 if ((existing = _locations->auto_punch_location()) != 0 && existing != location) {
1646 punch_connections.drop_connections();
1647 existing->set_auto_punch (false, this);
1648 remove_event (existing->start(), SessionEvent::PunchIn);
1649 clear_events (SessionEvent::PunchOut);
1650 auto_punch_location_changed (0);
1655 if (location == 0) {
1659 if (location->end() <= location->start()) {
1660 error << _("Session: you can't use that location for auto punch (start <= end)") << endmsg;
1664 punch_connections.drop_connections ();
1666 location->StartChanged.connect_same_thread (punch_connections, boost::bind (&Session::auto_punch_start_changed, this, location));
1667 location->EndChanged.connect_same_thread (punch_connections, boost::bind (&Session::auto_punch_end_changed, this, location));
1668 location->Changed.connect_same_thread (punch_connections, boost::bind (&Session::auto_punch_changed, this, location));
1670 location->set_auto_punch (true, this);
1672 auto_punch_changed (location);
1674 auto_punch_location_changed (location);
1678 Session::set_session_extents (framepos_t start, framepos_t end)
1681 if ((existing = _locations->session_range_location()) == 0) {
1682 //if there is no existing session, we need to make a new session location (should never happen)
1683 existing = new Location (*this, 0, 0, _("session"), Location::IsSessionRange);
1687 error << _("Session: you can't use that location for session start/end)") << endmsg;
1691 existing->set( start, end );
1697 Session::set_auto_loop_location (Location* location)
1701 if ((existing = _locations->auto_loop_location()) != 0 && existing != location) {
1702 loop_connections.drop_connections ();
1703 existing->set_auto_loop (false, this);
1704 remove_event (existing->end(), SessionEvent::AutoLoop);
1707 auto_loop_declick_range (existing, dcp, dcl);
1708 remove_event (dcp, SessionEvent::AutoLoopDeclick);
1709 auto_loop_location_changed (0);
1714 if (location == 0) {
1718 if (location->end() <= location->start()) {
1719 error << _("You cannot use this location for auto-loop because it has zero or negative length") << endmsg;
1723 last_loopend = location->end();
1725 loop_connections.drop_connections ();
1727 location->StartChanged.connect_same_thread (loop_connections, boost::bind (&Session::auto_loop_changed, this, location));
1728 location->EndChanged.connect_same_thread (loop_connections, boost::bind (&Session::auto_loop_changed, this, location));
1729 location->Changed.connect_same_thread (loop_connections, boost::bind (&Session::auto_loop_changed, this, location));
1730 location->FlagsChanged.connect_same_thread (loop_connections, boost::bind (&Session::auto_loop_changed, this, location));
1732 location->set_auto_loop (true, this);
1734 if (Config->get_loop_is_mode() && play_loop && Config->get_seamless_loop()) {
1735 // set all tracks to use internal looping
1736 boost::shared_ptr<RouteList> rl = routes.reader ();
1737 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
1738 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
1739 if (tr && !tr->hidden()) {
1740 tr->set_loop (location);
1745 /* take care of our stuff first */
1747 auto_loop_changed (location);
1749 /* now tell everyone else */
1751 auto_loop_location_changed (location);
1755 Session::update_marks (Location*)
1761 Session::update_skips (Location* loc, bool consolidate)
1763 if (_ignore_skips_updates) {
1767 Locations::LocationList skips;
1770 PBD::Unwinder<bool> uw (_ignore_skips_updates, true);
1771 consolidate_skips (loc);
1774 sync_locations_to_skips ();
1780 Session::consolidate_skips (Location* loc)
1782 Locations::LocationList all_locations = _locations->list ();
1784 for (Locations::LocationList::iterator l = all_locations.begin(); l != all_locations.end(); ) {
1786 if (!(*l)->is_skip ()) {
1791 /* don't test against self */
1798 switch (Evoral::coverage ((*l)->start(), (*l)->end(), loc->start(), loc->end())) {
1799 case Evoral::OverlapInternal:
1800 case Evoral::OverlapExternal:
1801 case Evoral::OverlapStart:
1802 case Evoral::OverlapEnd:
1803 /* adjust new location to cover existing one */
1804 loc->set_start (min (loc->start(), (*l)->start()));
1805 loc->set_end (max (loc->end(), (*l)->end()));
1806 /* we don't need this one any more */
1807 _locations->remove (*l);
1808 /* the location has been deleted, so remove reference to it in our local list */
1809 l = all_locations.erase (l);
1812 case Evoral::OverlapNone:
1820 Session::sync_locations_to_skips ()
1822 /* This happens asynchronously (in the audioengine thread). After the clear is done, we will call
1823 * Session::_sync_locations_to_skips() from the audioengine thread.
1825 clear_events (SessionEvent::Skip, boost::bind (&Session::_sync_locations_to_skips, this));
1829 Session::_sync_locations_to_skips ()
1831 /* called as a callback after existing Skip events have been cleared from a realtime audioengine thread */
1833 Locations::LocationList const & locs (_locations->list());
1835 for (Locations::LocationList::const_iterator i = locs.begin(); i != locs.end(); ++i) {
1837 Location* location = *i;
1839 if (location->is_skip() && location->is_skipping()) {
1840 SessionEvent* ev = new SessionEvent (SessionEvent::Skip, SessionEvent::Add, location->start(), location->end(), 1.0);
1848 Session::location_added (Location *location)
1850 if (location->is_auto_punch()) {
1851 set_auto_punch_location (location);
1854 if (location->is_auto_loop()) {
1855 set_auto_loop_location (location);
1858 if (location->is_session_range()) {
1859 /* no need for any signal handling or event setting with the session range,
1860 because we keep a direct reference to it and use its start/end directly.
1862 _session_range_location = location;
1865 if (location->is_mark()) {
1866 /* listen for per-location signals that require us to do any * global updates for marks */
1868 location->StartChanged.connect_same_thread (skip_update_connections, boost::bind (&Session::update_marks, this, location));
1869 location->EndChanged.connect_same_thread (skip_update_connections, boost::bind (&Session::update_marks, this, location));
1870 location->Changed.connect_same_thread (skip_update_connections, boost::bind (&Session::update_marks, this, location));
1871 location->FlagsChanged.connect_same_thread (skip_update_connections, boost::bind (&Session::update_marks, this, location));
1874 if (location->is_skip()) {
1875 /* listen for per-location signals that require us to update skip-locate events */
1877 location->StartChanged.connect_same_thread (skip_update_connections, boost::bind (&Session::update_skips, this, location, true));
1878 location->EndChanged.connect_same_thread (skip_update_connections, boost::bind (&Session::update_skips, this, location, true));
1879 location->Changed.connect_same_thread (skip_update_connections, boost::bind (&Session::update_skips, this, location, true));
1880 location->FlagsChanged.connect_same_thread (skip_update_connections, boost::bind (&Session::update_skips, this, location, false));
1882 update_skips (location, true);
1889 Session::location_removed (Location *location)
1891 if (location->is_auto_loop()) {
1892 set_auto_loop_location (0);
1893 set_track_loop (false);
1896 if (location->is_auto_punch()) {
1897 set_auto_punch_location (0);
1900 if (location->is_session_range()) {
1901 /* this is never supposed to happen */
1902 error << _("programming error: session range removed!") << endl;
1905 if (location->is_skip()) {
1907 update_skips (location, false);
1914 Session::locations_changed ()
1916 _locations->apply (*this, &Session::_locations_changed);
1920 Session::_locations_changed (const Locations::LocationList& locations)
1922 /* There was some mass-change in the Locations object.
1924 We might be re-adding a location here but it doesn't actually matter
1925 for all the locations that the Session takes an interest in.
1929 PBD::Unwinder<bool> protect_ignore_skip_updates (_ignore_skips_updates, true);
1930 for (Locations::LocationList::const_iterator i = locations.begin(); i != locations.end(); ++i) {
1931 location_added (*i);
1935 update_skips (NULL, false);
1939 Session::enable_record ()
1941 if (_transport_speed != 0.0 && _transport_speed != 1.0) {
1942 /* no recording at anything except normal speed */
1947 RecordState rs = (RecordState) g_atomic_int_get (&_record_status);
1949 if (rs == Recording) {
1953 if (g_atomic_int_compare_and_exchange (&_record_status, rs, Recording)) {
1955 _last_record_location = _transport_frame;
1956 send_immediate_mmc (MIDI::MachineControlCommand (MIDI::MachineControl::cmdRecordStrobe));
1958 if (Config->get_monitoring_model() == HardwareMonitoring && config.get_auto_input()) {
1959 set_track_monitor_input_status (true);
1962 RecordStateChanged ();
1969 Session::set_all_tracks_record_enabled (bool enable )
1971 boost::shared_ptr<RouteList> rl = routes.reader();
1972 set_controls (route_list_to_control_list (rl, &Stripable::rec_enable_control), enable, Controllable::NoGroup);
1976 Session::disable_record (bool rt_context, bool force)
1980 if ((rs = (RecordState) g_atomic_int_get (&_record_status)) != Disabled) {
1982 if (!Config->get_latched_record_enable () || force) {
1983 g_atomic_int_set (&_record_status, Disabled);
1984 send_immediate_mmc (MIDI::MachineControlCommand (MIDI::MachineControl::cmdRecordExit));
1986 if (rs == Recording) {
1987 g_atomic_int_set (&_record_status, Enabled);
1991 if (Config->get_monitoring_model() == HardwareMonitoring && config.get_auto_input()) {
1992 set_track_monitor_input_status (false);
1995 RecordStateChanged (); /* emit signal */
1998 remove_pending_capture_state ();
2004 Session::step_back_from_record ()
2006 if (g_atomic_int_compare_and_exchange (&_record_status, Recording, Enabled)) {
2008 if (Config->get_monitoring_model() == HardwareMonitoring && config.get_auto_input()) {
2009 set_track_monitor_input_status (false);
2012 RecordStateChanged (); /* emit signal */
2017 Session::maybe_enable_record ()
2019 if (_step_editors > 0) {
2023 g_atomic_int_set (&_record_status, Enabled);
2025 /* This function is currently called from somewhere other than an RT thread.
2026 This save_state() call therefore doesn't impact anything. Doing it here
2027 means that we save pending state of which sources the next record will use,
2028 which gives us some chance of recovering from a crash during the record.
2031 save_state ("", true);
2033 if (_transport_speed) {
2034 if (!config.get_punch_in()) {
2038 send_immediate_mmc (MIDI::MachineControlCommand (MIDI::MachineControl::cmdRecordPause));
2039 RecordStateChanged (); /* EMIT SIGNAL */
2046 Session::audible_frame () const
2050 frameoffset_t offset = worst_playback_latency (); // - _engine.samples_since_cycle_start ();
2051 offset *= transport_speed ();
2053 if (synced_to_engine()) {
2054 /* Note: this is basically just sync-to-JACK */
2055 ret = _engine.transport_frame();
2057 ret = _transport_frame;
2060 if (transport_rolling()) {
2063 /* Check to see if we have passed the first guaranteed
2064 * audible frame past our last start position. if not,
2065 * return that last start point because in terms
2066 * of audible frames, we have not moved yet.
2068 * `Start position' in this context means the time we last
2069 * either started, located, or changed transport direction.
2072 if (_transport_speed > 0.0f) {
2074 if (!play_loop || !have_looped) {
2075 if (ret < _last_roll_or_reversal_location) {
2076 return _last_roll_or_reversal_location;
2080 Location *location = _locations->auto_loop_location();
2081 frameoffset_t lo = location->start() - ret;
2083 ret = location->end () - lo;
2087 } else if (_transport_speed < 0.0f) {
2089 /* XXX wot? no backward looping? */
2091 if (ret > _last_roll_or_reversal_location) {
2092 return _last_roll_or_reversal_location;
2097 return std::max ((framepos_t)0, ret);
2101 Session::set_frame_rate (framecnt_t frames_per_second)
2103 /** \fn void Session::set_frame_size(framecnt_t)
2104 the AudioEngine object that calls this guarantees
2105 that it will not be called while we are also in
2106 ::process(). Its fine to do things that block
2110 if (_base_frame_rate == 0) {
2111 _base_frame_rate = frames_per_second;
2113 else if (_base_frame_rate != frames_per_second && frames_per_second != _nominal_frame_rate) {
2114 NotifyAboutSampleRateMismatch (_base_frame_rate, frames_per_second);
2116 _nominal_frame_rate = frames_per_second;
2121 reset_write_sources (false);
2123 // XXX we need some equivalent to this, somehow
2124 // SndFileSource::setup_standard_crossfades (frames_per_second);
2128 /* XXX need to reset/reinstantiate all LADSPA plugins */
2132 Session::set_block_size (pframes_t nframes)
2134 /* the AudioEngine guarantees
2135 that it will not be called while we are also in
2136 ::process(). It is therefore fine to do things that block
2141 current_block_size = nframes;
2145 boost::shared_ptr<RouteList> r = routes.reader ();
2147 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
2148 (*i)->set_block_size (nframes);
2151 boost::shared_ptr<RouteList> rl = routes.reader ();
2152 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
2153 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
2155 tr->set_block_size (nframes);
2159 set_worst_io_latencies ();
2165 trace_terminal (boost::shared_ptr<Route> r1, boost::shared_ptr<Route> rbase)
2167 boost::shared_ptr<Route> r2;
2169 if (r1->feeds (rbase) && rbase->feeds (r1)) {
2170 info << string_compose(_("feedback loop setup between %1 and %2"), r1->name(), rbase->name()) << endmsg;
2174 /* make a copy of the existing list of routes that feed r1 */
2176 Route::FedBy existing (r1->fed_by());
2178 /* for each route that feeds r1, recurse, marking it as feeding
2182 for (Route::FedBy::iterator i = existing.begin(); i != existing.end(); ++i) {
2183 if (!(r2 = i->r.lock ())) {
2184 /* (*i) went away, ignore it */
2188 /* r2 is a route that feeds r1 which somehow feeds base. mark
2189 base as being fed by r2
2192 rbase->add_fed_by (r2, i->sends_only);
2196 /* 2nd level feedback loop detection. if r1 feeds or is fed by r2,
2200 if (r1->feeds (r2) && r2->feeds (r1)) {
2204 /* now recurse, so that we can mark base as being fed by
2205 all routes that feed r2
2208 trace_terminal (r2, rbase);
2215 Session::resort_routes ()
2217 /* don't do anything here with signals emitted
2218 by Routes during initial setup or while we
2219 are being destroyed.
2222 if (_state_of_the_state & (InitialConnecting | Deletion)) {
2226 if (_route_deletion_in_progress) {
2231 RCUWriter<RouteList> writer (routes);
2232 boost::shared_ptr<RouteList> r = writer.get_copy ();
2233 resort_routes_using (r);
2234 /* writer goes out of scope and forces update */
2238 if (DEBUG_ENABLED(DEBUG::Graph)) {
2239 boost::shared_ptr<RouteList> rl = routes.reader ();
2240 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
2241 DEBUG_TRACE (DEBUG::Graph, string_compose ("%1 fed by ...\n", (*i)->name()));
2243 const Route::FedBy& fb ((*i)->fed_by());
2245 for (Route::FedBy::const_iterator f = fb.begin(); f != fb.end(); ++f) {
2246 boost::shared_ptr<Route> sf = f->r.lock();
2248 DEBUG_TRACE (DEBUG::Graph, string_compose ("\t%1 (sends only ? %2)\n", sf->name(), f->sends_only));
2257 /** This is called whenever we need to rebuild the graph of how we will process
2259 * @param r List of routes, in any order.
2263 Session::resort_routes_using (boost::shared_ptr<RouteList> r)
2265 /* We are going to build a directed graph of our routes;
2266 this is where the edges of that graph are put.
2271 /* Go through all routes doing two things:
2273 * 1. Collect the edges of the route graph. Each of these edges
2274 * is a pair of routes, one of which directly feeds the other
2275 * either by a JACK connection or by an internal send.
2277 * 2. Begin the process of making routes aware of which other
2278 * routes directly or indirectly feed them. This information
2279 * is used by the solo code.
2282 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
2284 /* Clear out the route's list of direct or indirect feeds */
2285 (*i)->clear_fed_by ();
2287 for (RouteList::iterator j = r->begin(); j != r->end(); ++j) {
2289 bool via_sends_only;
2291 /* See if this *j feeds *i according to the current state of the JACK
2292 connections and internal sends.
2294 if ((*j)->direct_feeds_according_to_reality (*i, &via_sends_only)) {
2295 /* add the edge to the graph (part #1) */
2296 edges.add (*j, *i, via_sends_only);
2297 /* tell the route (for part #2) */
2298 (*i)->add_fed_by (*j, via_sends_only);
2303 /* Attempt a topological sort of the route graph */
2304 boost::shared_ptr<RouteList> sorted_routes = topological_sort (r, edges);
2306 if (sorted_routes) {
2307 /* We got a satisfactory topological sort, so there is no feedback;
2310 Note: the process graph rechain does not require a
2311 topologically-sorted list, but hey ho.
2313 if (_process_graph) {
2314 _process_graph->rechain (sorted_routes, edges);
2317 _current_route_graph = edges;
2319 /* Complete the building of the routes' lists of what directly
2320 or indirectly feeds them.
2322 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
2323 trace_terminal (*i, *i);
2326 *r = *sorted_routes;
2329 DEBUG_TRACE (DEBUG::Graph, "Routes resorted, order follows:\n");
2330 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
2331 DEBUG_TRACE (DEBUG::Graph, string_compose ("\t%1 presentation order %2\n", (*i)->name(), (*i)->presentation_info().order()));
2335 SuccessfulGraphSort (); /* EMIT SIGNAL */
2338 /* The topological sort failed, so we have a problem. Tell everyone
2339 and stick to the old graph; this will continue to be processed, so
2340 until the feedback is fixed, what is played back will not quite
2341 reflect what is actually connected. Note also that we do not
2342 do trace_terminal here, as it would fail due to an endless recursion,
2343 so the solo code will think that everything is still connected
2347 FeedbackDetected (); /* EMIT SIGNAL */
2352 /** Find a route name starting with \a base, maybe followed by the
2353 * lowest \a id. \a id will always be added if \a definitely_add_number
2354 * is true on entry; otherwise it will only be added if required
2355 * to make the name unique.
2357 * Names are constructed like e.g. "Audio 3" for base="Audio" and id=3.
2358 * The available route name with the lowest ID will be used, and \a id
2359 * will be set to the ID.
2361 * \return false if a route name could not be found, and \a track_name
2362 * and \a id do not reflect a free route name.
2365 Session::find_route_name (string const & base, uint32_t& id, string& name, bool definitely_add_number)
2367 /* the base may conflict with ports that do not belong to existing
2368 routes, but hidden objects like the click track. So check port names
2369 before anything else.
2372 for (map<string,bool>::const_iterator reserved = reserved_io_names.begin(); reserved != reserved_io_names.end(); ++reserved) {
2373 if (base == reserved->first) {
2374 /* Check if this reserved name already exists, and if
2375 so, disallow it without a numeric suffix.
2377 if (!reserved->second || route_by_name (reserved->first)) {
2378 definitely_add_number = true;
2387 /* if we have "base 1" already, it doesn't make sense to add "base"
2388 * if "base 1" has been deleted, adding "base" is no worse than "base 1"
2390 if (!definitely_add_number && route_by_name (base) == 0 && (route_by_name (string_compose("%1 1", base)) == 0)) {
2391 /* just use the base */
2397 name = string_compose ("%1 %2", base, id);
2399 if (route_by_name (name) == 0) {
2405 } while (id < (UINT_MAX-1));
2410 /** Count the total ins and outs of all non-hidden tracks in the session and return them in in and out */
2412 Session::count_existing_track_channels (ChanCount& in, ChanCount& out)
2414 in = ChanCount::ZERO;
2415 out = ChanCount::ZERO;
2417 boost::shared_ptr<RouteList> r = routes.reader ();
2419 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
2420 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
2421 if (tr && !tr->is_auditioner()) {
2422 in += tr->n_inputs();
2423 out += tr->n_outputs();
2429 Session::default_track_name_pattern (DataType t)
2432 case DataType::AUDIO:
2433 if (Profile->get_trx()) {
2440 case DataType::MIDI:
2447 /** Caller must not hold process lock
2448 * @param name_template string to use for the start of the name, or "" to use "MIDI".
2449 * @param instrument plugin info for the instrument to insert pre-fader, if any
2451 list<boost::shared_ptr<MidiTrack> >
2452 Session::new_midi_track (const ChanCount& input, const ChanCount& output,
2453 boost::shared_ptr<PluginInfo> instrument, Plugin::PresetRecord* pset,
2454 RouteGroup* route_group, uint32_t how_many, string name_template, PresentationInfo::order_t order,
2458 uint32_t track_id = 0;
2460 RouteList new_routes;
2461 list<boost::shared_ptr<MidiTrack> > ret;
2463 const string name_pattern = default_track_name_pattern (DataType::MIDI);
2464 bool const use_number = (how_many != 1) || name_template.empty () || (name_template == name_pattern);
2467 if (!find_route_name (name_template.empty() ? _("MIDI") : name_template, ++track_id, track_name, use_number)) {
2468 error << "cannot find name for new midi track" << endmsg;
2472 boost::shared_ptr<MidiTrack> track;
2475 track.reset (new MidiTrack (*this, track_name, mode));
2477 if (track->init ()) {
2481 if (Profile->get_mixbus ()) {
2482 track->set_strict_io (true);
2485 track->use_new_diskstream();
2487 BOOST_MARK_TRACK (track);
2490 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
2491 if (track->input()->ensure_io (input, false, this)) {
2492 error << "cannot configure " << input << " out configuration for new midi track" << endmsg;
2496 if (track->output()->ensure_io (output, false, this)) {
2497 error << "cannot configure " << output << " out configuration for new midi track" << endmsg;
2502 track->non_realtime_input_change();
2505 route_group->add (track);
2508 track->DiskstreamChanged.connect_same_thread (*this, boost::bind (&Session::resort_routes, this));
2510 new_routes.push_back (track);
2511 ret.push_back (track);
2514 catch (failed_constructor &err) {
2515 error << _("Session: could not create new midi track.") << endmsg;
2519 catch (AudioEngine::PortRegistrationFailure& pfe) {
2521 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;
2529 if (!new_routes.empty()) {
2530 StateProtector sp (this);
2531 if (Profile->get_trx()) {
2532 add_routes (new_routes, false, false, false, order);
2534 add_routes (new_routes, true, true, false, order);
2538 for (RouteList::iterator r = new_routes.begin(); r != new_routes.end(); ++r) {
2539 PluginPtr plugin = instrument->load (*this);
2541 warning << "Failed to add Synth Plugin to newly created track." << endmsg;
2545 plugin->load_preset (*pset);
2547 boost::shared_ptr<Processor> p (new PluginInsert (*this, plugin));
2548 (*r)->add_processor (p, PreFader);
2557 Session::new_midi_route (RouteGroup* route_group, uint32_t how_many, string name_template, boost::shared_ptr<PluginInfo> instrument, Plugin::PresetRecord* pset,
2558 PresentationInfo::Flag flag, PresentationInfo::order_t order)
2561 uint32_t bus_id = 0;
2565 bool const use_number = (how_many != 1) || name_template.empty () || name_template == _("Midi Bus");
2568 if (!find_route_name (name_template.empty () ? _("Midi Bus") : name_template, ++bus_id, bus_name, use_number)) {
2569 error << "cannot find name for new midi bus" << endmsg;
2574 boost::shared_ptr<Route> bus (new Route (*this, bus_name, flag, DataType::AUDIO)); // XXX Editor::add_routes is not ready for ARDOUR::DataType::MIDI
2580 if (Profile->get_mixbus ()) {
2581 bus->set_strict_io (true);
2584 BOOST_MARK_ROUTE(bus);
2587 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
2589 if (bus->input()->ensure_io (ChanCount(DataType::MIDI, 1), false, this)) {
2590 error << _("cannot configure new midi bus input") << endmsg;
2595 if (bus->output()->ensure_io (ChanCount(DataType::MIDI, 1), false, this)) {
2596 error << _("cannot configure new midi bus output") << endmsg;
2602 route_group->add (bus);
2605 bus->add_internal_return ();
2606 ret.push_back (bus);
2609 catch (failed_constructor &err) {
2610 error << _("Session: could not create new audio route.") << endmsg;
2614 catch (AudioEngine::PortRegistrationFailure& pfe) {
2615 error << pfe.what() << endmsg;
2625 StateProtector sp (this);
2626 add_routes (ret, false, false, false, order);
2629 for (RouteList::iterator r = ret.begin(); r != ret.end(); ++r) {
2630 PluginPtr plugin = instrument->load (*this);
2632 warning << "Failed to add Synth Plugin to newly created track." << endmsg;
2636 plugin->load_preset (*pset);
2638 boost::shared_ptr<Processor> p (new PluginInsert (*this, plugin));
2639 (*r)->add_processor (p, PreFader);
2650 Session::midi_output_change_handler (IOChange change, void * /*src*/, boost::weak_ptr<Route> wmt)
2652 boost::shared_ptr<Route> midi_track (wmt.lock());
2658 if ((change.type & IOChange::ConfigurationChanged) && Config->get_output_auto_connect() != ManualConnect) {
2660 if (change.after.n_audio() <= change.before.n_audio()) {
2664 /* new audio ports: make sure the audio goes somewhere useful,
2665 * unless the user has no-auto-connect selected.
2667 * The existing ChanCounts don't matter for this call as they are only
2668 * to do with matching input and output indices, and we are only changing
2671 auto_connect_route (midi_track, false, ChanCount(), change.before);
2675 #ifdef USE_TRACKS_CODE_FEATURES
2678 compare_routes_by_remote_id (const boost::shared_ptr<Route>& route1, const boost::shared_ptr<Route>& route2)
2680 return route1->remote_control_id() < route2->remote_control_id();
2684 Session::reconnect_existing_routes (bool withLock, bool reconnect_master, bool reconnect_inputs, bool reconnect_outputs)
2686 // it is not allowed to perform connection
2687 if (!IO::connecting_legal) {
2691 // if we are deleting routes we will call this once at the end
2692 if (_route_deletion_in_progress) {
2696 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock (), Glib::Threads::NOT_LOCK);
2702 // We need to disconnect the route's inputs and outputs first
2703 // basing on autoconnect configuration
2704 bool reconnectIputs = !(Config->get_input_auto_connect() & ManualConnect) && reconnect_inputs;
2705 bool reconnectOutputs = !(Config->get_output_auto_connect() & ManualConnect) && reconnect_outputs;
2707 ChanCount existing_inputs;
2708 ChanCount existing_outputs;
2709 count_existing_track_channels (existing_inputs, existing_outputs);
2711 //ChanCount inputs = ChanCount::ZERO;
2712 //ChanCount outputs = ChanCount::ZERO;
2714 RouteList existing_routes = *routes.reader ();
2715 existing_routes.sort (compare_routes_by_remote_id);
2718 PBD::Unwinder<bool> protect_ignore_changes (_reconnecting_routes_in_progress, true);
2720 vector<string> physinputs;
2721 vector<string> physoutputs;
2723 EngineStateController::instance()->get_physical_audio_outputs(physoutputs);
2724 EngineStateController::instance()->get_physical_audio_inputs(physinputs);
2726 uint32_t input_n = 0;
2727 uint32_t output_n = 0;
2728 RouteList::iterator rIter = existing_routes.begin();
2729 const AutoConnectOption current_input_auto_connection (Config->get_input_auto_connect());
2730 const AutoConnectOption current_output_auto_connection (Config->get_output_auto_connect());
2731 for (; rIter != existing_routes.end(); ++rIter) {
2732 if (*rIter == _master_out || *rIter == _monitor_out ) {
2736 if (current_output_auto_connection == AutoConnectPhysical) {
2737 (*rIter)->amp()->deactivate();
2738 } else if (current_output_auto_connection == AutoConnectMaster) {
2739 (*rIter)->amp()->activate();
2742 if (reconnectIputs) {
2743 (*rIter)->input()->disconnect (this); //GZ: check this; could be heavy
2745 for (uint32_t route_input_n = 0; route_input_n < (*rIter)->n_inputs().get(DataType::AUDIO); ++route_input_n) {
2747 if (current_input_auto_connection & AutoConnectPhysical) {
2749 if ( input_n == physinputs.size() ) {
2753 string port = physinputs[input_n];
2755 if (port.empty() ) {
2756 error << "Physical Input number "<< input_n << " is unavailable and cannot be connected" << endmsg;
2759 //GZ: check this; could be heavy
2760 (*rIter)->input()->connect ((*rIter)->input()->ports().port(DataType::AUDIO, route_input_n), port, this);
2766 if (reconnectOutputs) {
2768 //normalize route ouptuts: reduce the amount outputs to be equal to the amount of inputs
2769 if (current_output_auto_connection & AutoConnectPhysical) {
2771 //GZ: check this; could be heavy
2772 (*rIter)->output()->disconnect (this);
2773 size_t route_inputs_count = (*rIter)->n_inputs().get(DataType::AUDIO);
2775 //GZ: check this; could be heavy
2776 (*rIter)->output()->ensure_io(ChanCount(DataType::AUDIO, route_inputs_count), false, this );
2778 } else if (current_output_auto_connection & AutoConnectMaster){
2780 if (!reconnect_master) {
2784 //GZ: check this; could be heavy
2785 (*rIter)->output()->disconnect (this);
2788 uint32_t master_inputs_count = _master_out->n_inputs().get(DataType::AUDIO);
2789 (*rIter)->output()->ensure_io(ChanCount(DataType::AUDIO, master_inputs_count), false, this );
2791 error << error << "Master bus is not available" << endmsg;
2796 for (uint32_t route_output_n = 0; route_output_n < (*rIter)->n_outputs().get(DataType::AUDIO); ++route_output_n) {
2797 if (current_output_auto_connection & AutoConnectPhysical) {
2799 if ( output_n == physoutputs.size() ) {
2803 string port = physoutputs[output_n];
2805 if (port.empty() ) {
2806 error << "Physical Output number "<< output_n << " is unavailable and cannot be connected" << endmsg;
2809 //GZ: check this; could be heavy
2810 (*rIter)->output()->connect ((*rIter)->output()->ports().port(DataType::AUDIO, route_output_n), port, this);
2813 } else if (current_output_auto_connection & AutoConnectMaster) {
2815 if ( route_output_n == _master_out->n_inputs().get(DataType::AUDIO) ) {
2819 // connect to master bus
2820 string port = _master_out->input()->ports().port(DataType::AUDIO, route_output_n)->name();
2822 if (port.empty() ) {
2823 error << "MasterBus Input number "<< route_output_n << " is unavailable and cannot be connected" << endmsg;
2827 //GZ: check this; could be heavy
2828 (*rIter)->output()->connect ((*rIter)->output()->ports().port(DataType::AUDIO, route_output_n), port, this);
2835 _master_out->output()->disconnect (this);
2836 auto_connect_master_bus ();
2841 session_routes_reconnected (); /* EMIT SIGNAL */
2845 Session::reconnect_midi_scene_ports(bool inputs)
2849 boost::shared_ptr<MidiPort> scene_in_ptr = scene_in();
2851 scene_in_ptr->disconnect_all ();
2853 std::vector<EngineStateController::MidiPortState> midi_port_states;
2854 EngineStateController::instance()->get_physical_midi_input_states (midi_port_states);
2856 std::vector<EngineStateController::MidiPortState>::iterator state_iter = midi_port_states.begin();
2858 for (; state_iter != midi_port_states.end(); ++state_iter) {
2859 if (state_iter->active && state_iter->available && state_iter->scene_connected) {
2860 scene_in_ptr->connect (state_iter->name);
2867 boost::shared_ptr<MidiPort> scene_out_ptr = scene_out();
2869 if (scene_out_ptr ) {
2870 scene_out_ptr->disconnect_all ();
2872 std::vector<EngineStateController::MidiPortState> midi_port_states;
2873 EngineStateController::instance()->get_physical_midi_output_states (midi_port_states);
2875 std::vector<EngineStateController::MidiPortState>::iterator state_iter = midi_port_states.begin();
2877 for (; state_iter != midi_port_states.end(); ++state_iter) {
2878 if (state_iter->active && state_iter->available && state_iter->scene_connected) {
2879 scene_out_ptr->connect (state_iter->name);
2887 Session::reconnect_mtc_ports ()
2889 boost::shared_ptr<MidiPort> mtc_in_ptr = _midi_ports->mtc_input_port();
2895 mtc_in_ptr->disconnect_all ();
2897 std::vector<EngineStateController::MidiPortState> midi_port_states;
2898 EngineStateController::instance()->get_physical_midi_input_states (midi_port_states);
2900 std::vector<EngineStateController::MidiPortState>::iterator state_iter = midi_port_states.begin();
2902 for (; state_iter != midi_port_states.end(); ++state_iter) {
2903 if (state_iter->available && state_iter->mtc_in) {
2904 mtc_in_ptr->connect (state_iter->name);
2908 if (!_midi_ports->mtc_input_port ()->connected () &&
2909 config.get_external_sync () &&
2910 (Config->get_sync_source () == MTC) ) {
2911 config.set_external_sync (false);
2914 if ( ARDOUR::Profile->get_trx () ) {
2915 // Tracks need this signal to update timecode_source_dropdown
2916 MtcOrLtcInputPortChanged (); //emit signal
2921 Session::reconnect_mmc_ports(bool inputs)
2923 if (inputs ) { // get all enabled midi input ports
2925 boost::shared_ptr<MidiPort> mmc_in_ptr = _midi_ports->mmc_in();
2927 mmc_in_ptr->disconnect_all ();
2928 std::vector<std::string> enabled_midi_inputs;
2929 EngineStateController::instance()->get_physical_midi_inputs (enabled_midi_inputs);
2931 std::vector<std::string>::iterator port_iter = enabled_midi_inputs.begin();
2933 for (; port_iter != enabled_midi_inputs.end(); ++port_iter) {
2934 mmc_in_ptr->connect (*port_iter);
2938 } else { // get all enabled midi output ports
2940 boost::shared_ptr<MidiPort> mmc_out_ptr = _midi_ports->mmc_out();
2942 mmc_out_ptr->disconnect_all ();
2943 std::vector<std::string> enabled_midi_outputs;
2944 EngineStateController::instance()->get_physical_midi_outputs (enabled_midi_outputs);
2946 std::vector<std::string>::iterator port_iter = enabled_midi_outputs.begin();
2948 for (; port_iter != enabled_midi_outputs.end(); ++port_iter) {
2949 mmc_out_ptr->connect (*port_iter);
2958 Session::ensure_route_presentation_info_gap (PresentationInfo::order_t first_new_order, uint32_t how_many)
2960 if (first_new_order == PresentationInfo::max_order) {
2961 /* adding at end, no worries */
2965 /* create a gap in the presentation info to accomodate @param how_many
2969 get_stripables (sl);
2971 for (StripableList::iterator si = sl.begin(); si != sl.end(); ++si) {
2972 boost::shared_ptr<Stripable> s (*si);
2974 if (s->is_monitor() || s->is_auditioner()) {
2978 if (s->presentation_info().order () >= first_new_order) {
2979 s->set_presentation_order (s->presentation_info().order () + how_many);
2984 /** Caller must not hold process lock
2985 * @param name_template string to use for the start of the name, or "" to use "Audio".
2987 list< boost::shared_ptr<AudioTrack> >
2988 Session::new_audio_track (int input_channels, int output_channels, RouteGroup* route_group,
2989 uint32_t how_many, string name_template, PresentationInfo::order_t order,
2993 uint32_t track_id = 0;
2995 RouteList new_routes;
2996 list<boost::shared_ptr<AudioTrack> > ret;
2998 const string name_pattern = default_track_name_pattern (DataType::AUDIO);
2999 bool const use_number = (how_many != 1) || name_template.empty () || (name_template == name_pattern);
3003 if (!find_route_name (name_template.empty() ? _(name_pattern.c_str()) : name_template, ++track_id, track_name, use_number)) {
3004 error << "cannot find name for new audio track" << endmsg;
3008 boost::shared_ptr<AudioTrack> track;
3011 track.reset (new AudioTrack (*this, track_name, mode));
3013 if (track->init ()) {
3017 if (Profile->get_mixbus ()) {
3018 track->set_strict_io (true);
3021 if (ARDOUR::Profile->get_trx ()) {
3022 // TRACKS considers it's not a USE CASE, it's
3023 // a piece of behavior of the session model:
3025 // Gain for a newly created route depends on
3026 // the current output_auto_connect mode:
3028 // 0 for Stereo Out mode
3030 if (Config->get_output_auto_connect() & AutoConnectMaster) {
3031 track->gain_control()->set_value (dB_to_coefficient (0), Controllable::NoGroup);
3035 track->use_new_diskstream();
3037 BOOST_MARK_TRACK (track);
3040 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
3042 if (track->input()->ensure_io (ChanCount(DataType::AUDIO, input_channels), false, this)) {
3043 error << string_compose (
3044 _("cannot configure %1 in/%2 out configuration for new audio track"),
3045 input_channels, output_channels)
3050 if (track->output()->ensure_io (ChanCount(DataType::AUDIO, output_channels), false, this)) {
3051 error << string_compose (
3052 _("cannot configure %1 in/%2 out configuration for new audio track"),
3053 input_channels, output_channels)
3060 route_group->add (track);
3063 track->non_realtime_input_change();
3065 track->DiskstreamChanged.connect_same_thread (*this, boost::bind (&Session::resort_routes, this));
3067 new_routes.push_back (track);
3068 ret.push_back (track);
3071 catch (failed_constructor &err) {
3072 error << _("Session: could not create new audio track.") << endmsg;
3076 catch (AudioEngine::PortRegistrationFailure& pfe) {
3078 error << pfe.what() << endmsg;
3086 if (!new_routes.empty()) {
3087 StateProtector sp (this);
3088 if (Profile->get_trx()) {
3089 add_routes (new_routes, false, false, false, order);
3091 add_routes (new_routes, true, true, false, order);
3098 /** Caller must not hold process lock.
3099 * @param name_template string to use for the start of the name, or "" to use "Bus".
3102 Session::new_audio_route (int input_channels, int output_channels, RouteGroup* route_group, uint32_t how_many, string name_template,
3103 PresentationInfo::Flag flags, PresentationInfo::order_t order)
3106 uint32_t bus_id = 0;
3110 bool const use_number = (how_many != 1) || name_template.empty () || name_template == _("Bus");
3113 if (!find_route_name (name_template.empty () ? _("Bus") : name_template, ++bus_id, bus_name, use_number)) {
3114 error << "cannot find name for new audio bus" << endmsg;
3119 boost::shared_ptr<Route> bus (new Route (*this, bus_name, flags, DataType::AUDIO));
3125 if (Profile->get_mixbus ()) {
3126 bus->set_strict_io (true);
3129 BOOST_MARK_ROUTE(bus);
3132 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
3134 if (bus->input()->ensure_io (ChanCount(DataType::AUDIO, input_channels), false, this)) {
3135 error << string_compose (_("cannot configure %1 in/%2 out configuration for new audio track"),
3136 input_channels, output_channels)
3142 if (bus->output()->ensure_io (ChanCount(DataType::AUDIO, output_channels), false, this)) {
3143 error << string_compose (_("cannot configure %1 in/%2 out configuration for new audio track"),
3144 input_channels, output_channels)
3151 route_group->add (bus);
3154 bus->add_internal_return ();
3155 ret.push_back (bus);
3158 catch (failed_constructor &err) {
3159 error << _("Session: could not create new audio route.") << endmsg;
3163 catch (AudioEngine::PortRegistrationFailure& pfe) {
3164 error << pfe.what() << endmsg;
3174 StateProtector sp (this);
3175 if (Profile->get_trx()) {
3176 add_routes (ret, false, false, false, order);
3178 add_routes (ret, false, true, true, order); // autoconnect // outputs only
3187 Session::new_route_from_template (uint32_t how_many, PresentationInfo::order_t insert_at, const std::string& template_path, const std::string& name_base,
3188 PlaylistDisposition pd)
3192 if (!tree.read (template_path.c_str())) {
3196 return new_route_from_template (how_many, insert_at, *tree.root(), name_base, pd);
3200 Session::new_route_from_template (uint32_t how_many, PresentationInfo::order_t insert_at, XMLNode& node, const std::string& name_base, PlaylistDisposition pd)
3203 uint32_t number = 0;
3204 const uint32_t being_added = how_many;
3205 /* This will prevent the use of any existing XML-provided PBD::ID
3208 Stateful::ForceIDRegeneration force_ids;
3209 IO::disable_connecting ();
3213 /* We're going to modify the node contents a bit so take a
3214 * copy. The node may be re-used when duplicating more than once.
3217 XMLNode node_copy (node);
3222 if (!name_base.empty()) {
3224 /* if we're adding more than one routes, force
3225 * all the names of the new routes to be
3226 * numbered, via the final parameter.
3229 if (!find_route_name (name_base.c_str(), ++number, name, (being_added > 1))) {
3230 fatal << _("Session: UINT_MAX routes? impossible!") << endmsg;
3236 string const route_name = node_copy.property(X_("name"))->value ();
3238 /* generate a new name by adding a number to the end of the template name */
3239 if (!find_route_name (route_name.c_str(), ++number, name, true)) {
3240 fatal << _("Session: UINT_MAX routes? impossible!") << endmsg;
3241 abort(); /*NOTREACHED*/
3245 /* set this name in the XML description that we are about to use */
3247 if (pd == CopyPlaylist) {
3248 XMLNode* ds_node = find_named_node (node_copy, "Diskstream");
3250 const std::string playlist_name = ds_node->property (X_("playlist"))->value ();
3251 boost::shared_ptr<Playlist> playlist = playlists->by_name (playlist_name);
3252 // Use same name as Route::set_name_in_state so playlist copy
3253 // is picked up when creating the Route in XMLRouteFactory below
3254 PlaylistFactory::create (playlist, string_compose ("%1.1", name));
3258 bool rename_playlist = (pd == CopyPlaylist || pd == NewPlaylist);
3260 Route::set_name_in_state (node_copy, name, rename_playlist);
3262 /* trim bitslots from listen sends so that new ones are used */
3263 XMLNodeList children = node_copy.children ();
3264 for (XMLNodeList::iterator i = children.begin(); i != children.end(); ++i) {
3265 if ((*i)->name() == X_("Processor")) {
3266 /* ForceIDRegeneration does not catch the following */
3267 XMLProperty const * role = (*i)->property (X_("role"));
3268 XMLProperty const * type = (*i)->property (X_("type"));
3269 if (role && role->value() == X_("Aux")) {
3270 /* check if the target bus exists.
3271 * we should not save aux-sends in templates.
3273 XMLProperty const * target = (*i)->property (X_("target"));
3275 (*i)->add_property ("type", "dangling-aux-send");
3278 boost::shared_ptr<Route> r = route_by_id (target->value());
3279 if (!r || boost::dynamic_pointer_cast<Track>(r)) {
3280 (*i)->add_property ("type", "dangling-aux-send");
3284 if (role && role->value() == X_("Listen")) {
3285 (*i)->remove_property (X_("bitslot"));
3287 else if (role && (role->value() == X_("Send") || role->value() == X_("Aux"))) {
3289 Delivery::Role xrole;
3290 uint32_t bitslot = 0;
3291 xrole = Delivery::Role (string_2_enum (role->value(), xrole));
3292 std::string name = Send::name_and_id_new_send(*this, xrole, bitslot, false);
3293 snprintf (buf, sizeof (buf), "%" PRIu32, bitslot);
3294 (*i)->remove_property (X_("bitslot"));
3295 (*i)->remove_property (X_("name"));
3296 (*i)->add_property ("bitslot", buf);
3297 (*i)->add_property ("name", name);
3299 else if (type && type->value() == X_("intreturn")) {
3300 (*i)->remove_property (X_("bitslot"));
3301 (*i)->add_property ("ignore-bitslot", "1");
3303 else if (type && type->value() == X_("return")) {
3304 // Return::set_state() generates a new one
3305 (*i)->remove_property (X_("bitslot"));
3307 else if (type && type->value() == X_("port")) {
3308 // PortInsert::set_state() handles the bitslot
3309 (*i)->remove_property (X_("bitslot"));
3310 (*i)->add_property ("ignore-name", "1");
3315 boost::shared_ptr<Route> route (XMLRouteFactory (node_copy, 3000));
3318 error << _("Session: cannot create track/bus from template description") << endmsg;
3322 if (boost::dynamic_pointer_cast<Track>(route)) {
3323 /* force input/output change signals so that the new diskstream
3324 picks up the configuration of the route. During session
3325 loading this normally happens in a different way.
3328 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
3330 IOChange change (IOChange::Type (IOChange::ConfigurationChanged | IOChange::ConnectionsChanged));
3331 change.after = route->input()->n_ports();
3332 route->input()->changed (change, this);
3333 change.after = route->output()->n_ports();
3334 route->output()->changed (change, this);
3337 ret.push_back (route);
3340 catch (failed_constructor &err) {
3341 error << _("Session: could not create new route from template") << endmsg;
3345 catch (AudioEngine::PortRegistrationFailure& pfe) {
3346 error << pfe.what() << endmsg;
3355 StateProtector sp (this);
3356 if (Profile->get_trx()) {
3357 add_routes (ret, false, false, false, insert_at);
3359 add_routes (ret, true, true, false, insert_at);
3361 IO::enable_connecting ();
3368 Session::add_routes (RouteList& new_routes, bool input_auto_connect, bool output_auto_connect, bool save, PresentationInfo::order_t order)
3371 PBD::Unwinder<bool> aip (_adding_routes_in_progress, true);
3372 add_routes_inner (new_routes, input_auto_connect, output_auto_connect, order);
3375 error << _("Adding new tracks/busses failed") << endmsg;
3380 update_latency (true);
3381 update_latency (false);
3386 save_state (_current_snapshot_name);
3389 update_route_record_state ();
3391 RouteAdded (new_routes); /* EMIT SIGNAL */
3395 Session::add_routes_inner (RouteList& new_routes, bool input_auto_connect, bool output_auto_connect, PresentationInfo::order_t order)
3397 ChanCount existing_inputs;
3398 ChanCount existing_outputs;
3402 count_existing_track_channels (existing_inputs, existing_outputs);
3405 RCUWriter<RouteList> writer (routes);
3406 boost::shared_ptr<RouteList> r = writer.get_copy ();
3407 r->insert (r->end(), new_routes.begin(), new_routes.end());
3408 n_routes = r->size();
3410 /* if there is no control out and we're not in the middle of loading,
3411 * resort the graph here. if there is a control out, we will resort
3412 * toward the end of this method. if we are in the middle of loading,
3413 * we will resort when done.
3416 if (!_monitor_out && IO::connecting_legal) {
3417 resort_routes_using (r);
3421 DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("ensure order gap starting at %1 for %2\n", order, new_routes.size()));
3422 ensure_route_presentation_info_gap (order, new_routes.size());
3424 for (RouteList::iterator x = new_routes.begin(); x != new_routes.end(); ++x, ++added) {
3426 boost::weak_ptr<Route> wpr (*x);
3427 boost::shared_ptr<Route> r (*x);
3429 r->solo_control()->Changed.connect_same_thread (*this, boost::bind (&Session::route_solo_changed, this, _1, _2,wpr));
3430 r->solo_isolate_control()->Changed.connect_same_thread (*this, boost::bind (&Session::route_solo_isolated_changed, this, wpr));
3431 r->mute_control()->Changed.connect_same_thread (*this, boost::bind (&Session::route_mute_changed, this));
3433 r->output()->changed.connect_same_thread (*this, boost::bind (&Session::set_worst_io_latencies_x, this, _1, _2));
3434 r->processors_changed.connect_same_thread (*this, boost::bind (&Session::route_processors_changed, this, _1));
3435 r->processor_latency_changed.connect_same_thread (*this, boost::bind (&Session::queue_latency_recompute, this));
3437 if (r->is_master()) {
3441 if (r->is_monitor()) {
3445 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (r);
3447 tr->PlaylistChanged.connect_same_thread (*this, boost::bind (&Session::track_playlist_changed, this, boost::weak_ptr<Track> (tr)));
3448 track_playlist_changed (boost::weak_ptr<Track> (tr));
3449 tr->rec_enable_control()->Changed.connect_same_thread (*this, boost::bind (&Session::update_route_record_state, this));
3451 boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (tr);
3453 mt->StepEditStatusChange.connect_same_thread (*this, boost::bind (&Session::step_edit_status_change, this, _1));
3454 mt->output()->changed.connect_same_thread (*this, boost::bind (&Session::midi_output_change_handler, this, _1, _2, boost::weak_ptr<Route>(mt)));
3455 mt->presentation_info().PropertyChanged.connect_same_thread (*this, boost::bind (&Session::midi_track_presentation_info_changed, this, _1, boost::weak_ptr<MidiTrack>(mt)));
3459 if (!r->presentation_info().special()) {
3461 DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("checking PI state for %1\n", r->name()));
3463 /* presentation info order may already have been set from XML */
3465 if (!r->presentation_info().order_set()) {
3467 if (order == PresentationInfo::max_order) {
3468 /* just add to the end */
3469 r->set_presentation_order (n_routes + added, false);
3470 DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("group order not set, set to NR %1 + %2 = %3\n", n_routes, added, n_routes + added));
3472 r->set_presentation_order (order + added);
3473 DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("group order not set, set to %1 + %2 = %3\n", order, added, order + added));
3476 DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("group order already set to %1\n", r->presentation_info().order()));
3480 #if !defined(__APPLE__) && !defined(__FreeBSD__)
3481 /* clang complains: 'operator<<' should be declared prior to the call site or in an associated namespace of one of its
3482 * arguments std::ostream& operator<<(std::ostream& o, ARDOUR::PresentationInfo const& rid)"
3484 DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("added route %1, group order %2 type %3 (summary: %4)\n",
3486 r->presentation_info().order(),
3487 enum_2_string (r->presentation_info().flags()),
3488 r->presentation_info()));
3492 if (input_auto_connect || output_auto_connect) {
3493 auto_connect_route (r, input_auto_connect, ChanCount (), ChanCount (), existing_inputs, existing_outputs);
3494 existing_inputs += r->n_inputs();
3495 existing_outputs += r->n_outputs();
3501 if (_monitor_out && IO::connecting_legal) {
3502 Glib::Threads::Mutex::Lock lm (_engine.process_lock());
3504 for (RouteList::iterator x = new_routes.begin(); x != new_routes.end(); ++x) {
3505 if ((*x)->is_monitor()) {
3507 } else if ((*x)->is_master()) {
3510 (*x)->enable_monitor_send ();
3515 reassign_track_numbers ();
3519 Session::globally_set_send_gains_to_zero (boost::shared_ptr<Route> dest)
3521 boost::shared_ptr<RouteList> r = routes.reader ();
3522 boost::shared_ptr<Send> s;
3524 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3525 if ((s = (*i)->internal_send_for (dest)) != 0) {
3526 s->amp()->gain_control()->set_value (GAIN_COEFF_ZERO, Controllable::NoGroup);
3532 Session::globally_set_send_gains_to_unity (boost::shared_ptr<Route> dest)
3534 boost::shared_ptr<RouteList> r = routes.reader ();
3535 boost::shared_ptr<Send> s;
3537 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3538 if ((s = (*i)->internal_send_for (dest)) != 0) {
3539 s->amp()->gain_control()->set_value (GAIN_COEFF_UNITY, Controllable::NoGroup);
3545 Session::globally_set_send_gains_from_track(boost::shared_ptr<Route> dest)
3547 boost::shared_ptr<RouteList> r = routes.reader ();
3548 boost::shared_ptr<Send> s;
3550 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3551 if ((s = (*i)->internal_send_for (dest)) != 0) {
3552 s->amp()->gain_control()->set_value ((*i)->gain_control()->get_value(), Controllable::NoGroup);
3557 /** @param include_buses true to add sends to buses and tracks, false for just tracks */
3559 Session::globally_add_internal_sends (boost::shared_ptr<Route> dest, Placement p, bool include_buses)
3561 boost::shared_ptr<RouteList> r = routes.reader ();
3562 boost::shared_ptr<RouteList> t (new RouteList);
3564 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3565 /* no MIDI sends because there are no MIDI busses yet */
3566 if (include_buses || boost::dynamic_pointer_cast<AudioTrack>(*i)) {
3571 add_internal_sends (dest, p, t);
3575 Session::add_internal_sends (boost::shared_ptr<Route> dest, Placement p, boost::shared_ptr<RouteList> senders)
3577 for (RouteList::iterator i = senders->begin(); i != senders->end(); ++i) {
3578 add_internal_send (dest, (*i)->before_processor_for_placement (p), *i);
3583 Session::add_internal_send (boost::shared_ptr<Route> dest, int index, boost::shared_ptr<Route> sender)
3585 add_internal_send (dest, sender->before_processor_for_index (index), sender);
3589 Session::add_internal_send (boost::shared_ptr<Route> dest, boost::shared_ptr<Processor> before, boost::shared_ptr<Route> sender)
3591 if (sender->is_monitor() || sender->is_master() || sender == dest || dest->is_monitor() || dest->is_master()) {
3595 if (!dest->internal_return()) {
3596 dest->add_internal_return ();
3599 sender->add_aux_send (dest, before);
3605 Session::remove_routes (boost::shared_ptr<RouteList> routes_to_remove)
3607 { // RCU Writer scope
3608 PBD::Unwinder<bool> uw_flag (_route_deletion_in_progress, true);
3609 RCUWriter<RouteList> writer (routes);
3610 boost::shared_ptr<RouteList> rs = writer.get_copy ();
3613 for (RouteList::iterator iter = routes_to_remove->begin(); iter != routes_to_remove->end(); ++iter) {
3615 if (*iter == _master_out) {
3619 /* speed up session deletion, don't do the solo dance */
3620 if (0 == (_state_of_the_state & Deletion)) {
3621 (*iter)->solo_control()->set_value (0.0, Controllable::NoGroup);
3626 /* deleting the master out seems like a dumb
3627 idea, but its more of a UI policy issue
3631 if (*iter == _master_out) {
3632 _master_out = boost::shared_ptr<Route> ();
3635 if (*iter == _monitor_out) {
3636 _monitor_out.reset ();
3639 // We need to disconnect the route's inputs and outputs
3641 (*iter)->input()->disconnect (0);
3642 (*iter)->output()->disconnect (0);
3644 /* if the route had internal sends sending to it, remove them */
3645 if ((*iter)->internal_return()) {
3647 boost::shared_ptr<RouteList> r = routes.reader ();
3648 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3649 boost::shared_ptr<Send> s = (*i)->internal_send_for (*iter);
3651 (*i)->remove_processor (s);
3656 /* if the monitoring section had a pointer to this route, remove it */
3657 if (_monitor_out && !(*iter)->is_master() && !(*iter)->is_monitor()) {
3658 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
3659 ProcessorChangeBlocker pcb (this, false);
3660 (*iter)->remove_aux_or_listen (_monitor_out);
3663 boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (*iter);
3664 if (mt && mt->step_editing()) {
3665 if (_step_editors > 0) {
3671 /* writer goes out of scope, forces route list update */
3673 } // end of RCU Writer scope
3675 update_route_solo_state ();
3676 update_latency_compensation ();
3679 /* Re-sort routes to remove the graph's current references to the one that is
3680 * going away, then flush old references out of the graph.
3681 * Wave Tracks: reconnect routes
3684 #ifdef USE_TRACKS_CODE_FEATURES
3685 reconnect_existing_routes(true, false);
3687 routes.flush (); // maybe unsafe, see below.
3691 if (_process_graph && !(_state_of_the_state & Deletion)) {
3692 _process_graph->clear_other_chain ();
3695 /* get rid of it from the dead wood collection in the route list manager */
3696 /* XXX i think this is unsafe as it currently stands, but i am not sure. (pd, october 2nd, 2006) */
3700 /* try to cause everyone to drop their references
3701 * and unregister ports from the backend
3704 for (RouteList::iterator iter = routes_to_remove->begin(); iter != routes_to_remove->end(); ++iter) {
3705 cerr << "Drop references to " << (*iter)->name() << endl;
3706 (*iter)->drop_references ();
3709 if (_state_of_the_state & Deletion) {
3713 PresentationInfo::Change(); /* EMIT SIGNAL */
3715 /* save the new state of the world */
3717 if (save_state (_current_snapshot_name)) {
3718 save_history (_current_snapshot_name);
3721 update_route_record_state ();
3725 Session::remove_route (boost::shared_ptr<Route> route)
3727 boost::shared_ptr<RouteList> rl (new RouteList);
3728 rl->push_back (route);
3733 Session::route_mute_changed ()
3739 Session::route_listen_changed (Controllable::GroupControlDisposition group_override, boost::weak_ptr<Route> wpr)
3741 boost::shared_ptr<Route> route (wpr.lock());
3747 assert (Config->get_solo_control_is_listen_control());
3749 if (route->solo_control()->soloed_by_self_or_masters()) {
3751 if (Config->get_exclusive_solo()) {
3753 RouteGroup* rg = route->route_group ();
3754 const bool group_already_accounted_for = (group_override == Controllable::ForGroup);
3756 boost::shared_ptr<RouteList> r = routes.reader ();
3758 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3759 if ((*i) == route) {
3760 /* already changed */
3764 if ((*i)->solo_isolate_control()->solo_isolated() || !(*i)->can_solo()) {
3765 /* route does not get solo propagated to it */
3769 if ((group_already_accounted_for && (*i)->route_group() && (*i)->route_group() == rg)) {
3770 /* this route is a part of the same solo group as the route
3771 * that was changed. Changing that route did change or will
3772 * change all group members appropriately, so we can ignore it
3777 (*i)->solo_control()->set_value (0.0, Controllable::NoGroup);
3783 } else if (_listen_cnt > 0) {
3790 Session::route_solo_isolated_changed (boost::weak_ptr<Route> wpr)
3792 boost::shared_ptr<Route> route (wpr.lock());
3798 bool send_changed = false;
3800 if (route->solo_isolate_control()->solo_isolated()) {
3801 if (_solo_isolated_cnt == 0) {
3802 send_changed = true;
3804 _solo_isolated_cnt++;
3805 } else if (_solo_isolated_cnt > 0) {
3806 _solo_isolated_cnt--;
3807 if (_solo_isolated_cnt == 0) {
3808 send_changed = true;
3813 IsolatedChanged (); /* EMIT SIGNAL */
3818 Session::route_solo_changed (bool self_solo_changed, Controllable::GroupControlDisposition group_override, boost::weak_ptr<Route> wpr)
3820 DEBUG_TRACE (DEBUG::Solo, string_compose ("route solo change, self = %1, update\n", self_solo_changed));
3822 boost::shared_ptr<Route> route (wpr.lock());
3828 if (Config->get_solo_control_is_listen_control()) {
3829 route_listen_changed (group_override, wpr);
3833 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()));
3835 if (route->solo_control()->transitioned_into_solo() == 0) {
3836 /* route solo changed by upstream/downstream or clear all solo state; not interesting
3839 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()));
3843 boost::shared_ptr<RouteList> r = routes.reader ();
3844 int32_t delta = route->solo_control()->transitioned_into_solo ();
3846 /* the route may be a member of a group that has shared-solo
3847 * semantics. If so, then all members of that group should follow the
3848 * solo of the changed route. But ... this is optional, controlled by a
3849 * Controllable::GroupControlDisposition.
3851 * The first argument to the signal that this method is connected to is the
3852 * GroupControlDisposition value that was used to change solo.
3854 * If the solo change was done with group semantics (either InverseGroup
3855 * (force the entire group to change even if the group shared solo is
3856 * disabled) or UseGroup (use the group, which may or may not have the
3857 * shared solo property enabled)) then as we propagate the change to
3858 * the entire session we should IGNORE THE GROUP that the changed route
3862 RouteGroup* rg = route->route_group ();
3863 const bool group_already_accounted_for = (group_override == Controllable::ForGroup);
3865 DEBUG_TRACE (DEBUG::Solo, string_compose ("propagate to session, group accounted for ? %1\n", group_already_accounted_for));
3867 if (delta == 1 && Config->get_exclusive_solo()) {
3869 /* new solo: disable all other solos, but not the group if its solo-enabled */
3871 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3873 if ((*i) == route) {
3874 /* already changed */
3878 if ((*i)->solo_isolate_control()->solo_isolated() || !(*i)->can_solo()) {
3879 /* route does not get solo propagated to it */
3883 if ((group_already_accounted_for && (*i)->route_group() && (*i)->route_group() == rg)) {
3884 /* this route is a part of the same solo group as the route
3885 * that was changed. Changing that route did change or will
3886 * change all group members appropriately, so we can ignore it
3892 (*i)->solo_control()->set_value (0.0, group_override);
3896 DEBUG_TRACE (DEBUG::Solo, string_compose ("propagate solo change, delta = %1\n", delta));
3898 RouteList uninvolved;
3900 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1\n", route->name()));
3902 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3903 bool via_sends_only;
3904 bool in_signal_flow;
3906 if ((*i) == route) {
3907 /* already changed */
3911 if ((*i)->solo_isolate_control()->solo_isolated() || !(*i)->can_solo()) {
3912 /* route does not get solo propagated to it */
3913 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(),
3918 if ((group_already_accounted_for && (*i)->route_group() && (*i)->route_group() == rg)) {
3919 /* this route is a part of the same solo group as the route
3920 * that was changed. Changing that route did change or will
3921 * change all group members appropriately, so we can ignore it
3927 in_signal_flow = false;
3929 DEBUG_TRACE (DEBUG::Solo, string_compose ("check feed from %1\n", (*i)->name()));
3931 if ((*i)->feeds (route, &via_sends_only)) {
3932 DEBUG_TRACE (DEBUG::Solo, string_compose ("\tthere is a feed from %1\n", (*i)->name()));
3933 if (!via_sends_only) {
3934 if (!route->soloed_by_others_upstream()) {
3935 (*i)->solo_control()->mod_solo_by_others_downstream (delta);
3937 DEBUG_TRACE (DEBUG::Solo, "\talready soloed by others upstream\n");
3940 DEBUG_TRACE (DEBUG::Solo, string_compose ("\tthere is a send-only feed from %1\n", (*i)->name()));
3942 in_signal_flow = true;
3944 DEBUG_TRACE (DEBUG::Solo, string_compose ("\tno feed from %1\n", (*i)->name()));
3947 DEBUG_TRACE (DEBUG::Solo, string_compose ("check feed to %1\n", (*i)->name()));
3949 if (route->feeds (*i, &via_sends_only)) {
3950 /* propagate solo upstream only if routing other than
3951 sends is involved, but do consider the other route
3952 (*i) to be part of the signal flow even if only
3955 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1 feeds %2 via sends only %3 sboD %4 sboU %5\n",
3959 route->soloed_by_others_downstream(),
3960 route->soloed_by_others_upstream()));
3961 if (!via_sends_only) {
3962 //NB. Triggers Invert Push, which handles soloed by downstream
3963 DEBUG_TRACE (DEBUG::Solo, string_compose ("\tmod %1 by %2\n", (*i)->name(), delta));
3964 (*i)->solo_control()->mod_solo_by_others_upstream (delta);
3966 DEBUG_TRACE (DEBUG::Solo, string_compose ("\tfeed to %1 ignored, sends-only\n", (*i)->name()));
3968 in_signal_flow = true;
3970 DEBUG_TRACE (DEBUG::Solo, "\tno feed to\n");
3973 if (!in_signal_flow) {
3974 uninvolved.push_back (*i);
3978 DEBUG_TRACE (DEBUG::Solo, "propagation complete\n");
3980 /* now notify that the mute state of the routes not involved in the signal
3981 pathway of the just-solo-changed route may have altered.
3984 for (RouteList::iterator i = uninvolved.begin(); i != uninvolved.end(); ++i) {
3985 DEBUG_TRACE (DEBUG::Solo, string_compose ("mute change for %1, which neither feeds or is fed by %2\n", (*i)->name(), route->name()));
3986 (*i)->act_on_mute ();
3987 /* Session will emit SoloChanged() after all solo changes are
3988 * complete, which should be used by UIs to update mute status
3994 Session::update_route_solo_state (boost::shared_ptr<RouteList> r)
3996 /* now figure out if anything that matters is soloed (or is "listening")*/
3998 bool something_soloed = false;
3999 bool something_listening = false;
4000 uint32_t listeners = 0;
4001 uint32_t isolated = 0;
4004 r = routes.reader();
4007 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4008 if ((*i)->can_solo()) {
4009 if (Config->get_solo_control_is_listen_control()) {
4010 if ((*i)->solo_control()->soloed_by_self_or_masters()) {
4012 something_listening = true;
4015 (*i)->set_listen (false);
4016 if ((*i)->can_solo() && (*i)->solo_control()->soloed_by_self_or_masters()) {
4017 something_soloed = true;
4022 if ((*i)->solo_isolate_control()->solo_isolated()) {
4027 if (something_soloed != _non_soloed_outs_muted) {
4028 _non_soloed_outs_muted = something_soloed;
4029 SoloActive (_non_soloed_outs_muted); /* EMIT SIGNAL */
4032 if (something_listening != _listening) {
4033 _listening = something_listening;
4034 SoloActive (_listening);
4037 _listen_cnt = listeners;
4039 if (isolated != _solo_isolated_cnt) {
4040 _solo_isolated_cnt = isolated;
4041 IsolatedChanged (); /* EMIT SIGNAL */
4044 DEBUG_TRACE (DEBUG::Solo, string_compose ("solo state updated by session, soloed? %1 listeners %2 isolated %3\n",
4045 something_soloed, listeners, isolated));
4048 SoloChanged (); /* EMIT SIGNAL */
4053 Session::get_stripables (StripableList& sl) const
4055 boost::shared_ptr<RouteList> r = routes.reader ();
4056 sl.insert (sl.end(), r->begin(), r->end());
4058 VCAList v = _vca_manager->vcas ();
4059 sl.insert (sl.end(), v.begin(), v.end());
4062 boost::shared_ptr<RouteList>
4063 Session::get_routes_with_internal_returns() const
4065 boost::shared_ptr<RouteList> r = routes.reader ();
4066 boost::shared_ptr<RouteList> rl (new RouteList);
4068 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4069 if ((*i)->internal_return ()) {
4077 Session::io_name_is_legal (const std::string& name) const
4079 boost::shared_ptr<RouteList> r = routes.reader ();
4081 for (map<string,bool>::const_iterator reserved = reserved_io_names.begin(); reserved != reserved_io_names.end(); ++reserved) {
4082 if (name == reserved->first) {
4083 if (!route_by_name (reserved->first)) {
4084 /* first instance of a reserved name is allowed */
4087 /* all other instances of a reserved name are not allowed */
4092 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4093 if ((*i)->name() == name) {
4097 if ((*i)->has_io_processor_named (name)) {
4106 Session::set_exclusive_input_active (boost::shared_ptr<RouteList> rl, bool onoff, bool flip_others)
4109 vector<string> connections;
4111 /* if we are passed only a single route and we're not told to turn
4112 * others off, then just do the simple thing.
4115 if (flip_others == false && rl->size() == 1) {
4116 boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (rl->front());
4118 mt->set_input_active (onoff);
4123 for (RouteList::iterator rt = rl->begin(); rt != rl->end(); ++rt) {
4125 PortSet& ps ((*rt)->input()->ports());
4127 for (PortSet::iterator p = ps.begin(); p != ps.end(); ++p) {
4128 p->get_connections (connections);
4131 for (vector<string>::iterator s = connections.begin(); s != connections.end(); ++s) {
4132 routes_using_input_from (*s, rl2);
4135 /* scan all relevant routes to see if others are on or off */
4137 bool others_are_already_on = false;
4139 for (RouteList::iterator r = rl2.begin(); r != rl2.end(); ++r) {
4141 boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (*r);
4147 if ((*r) != (*rt)) {
4148 if (mt->input_active()) {
4149 others_are_already_on = true;
4152 /* this one needs changing */
4153 mt->set_input_active (onoff);
4159 /* globally reverse other routes */
4161 for (RouteList::iterator r = rl2.begin(); r != rl2.end(); ++r) {
4162 if ((*r) != (*rt)) {
4163 boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (*r);
4165 mt->set_input_active (!others_are_already_on);
4174 Session::routes_using_input_from (const string& str, RouteList& rl)
4176 boost::shared_ptr<RouteList> r = routes.reader();
4178 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4179 if ((*i)->input()->connected_to (str)) {
4185 boost::shared_ptr<Route>
4186 Session::route_by_name (string name) const
4188 boost::shared_ptr<RouteList> r = routes.reader ();
4190 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4191 if ((*i)->name() == name) {
4196 return boost::shared_ptr<Route> ((Route*) 0);
4199 boost::shared_ptr<Route>
4200 Session::route_by_id (PBD::ID id) const
4202 boost::shared_ptr<RouteList> r = routes.reader ();
4204 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4205 if ((*i)->id() == id) {
4210 return boost::shared_ptr<Route> ((Route*) 0);
4213 boost::shared_ptr<Processor>
4214 Session::processor_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 boost::shared_ptr<Processor> p = (*i)->Route::processor_by_id (id);
4225 return boost::shared_ptr<Processor> ();
4228 boost::shared_ptr<Track>
4229 Session::track_by_diskstream_id (PBD::ID id) const
4231 boost::shared_ptr<RouteList> r = routes.reader ();
4233 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4234 boost::shared_ptr<Track> t = boost::dynamic_pointer_cast<Track> (*i);
4235 if (t && t->using_diskstream_id (id)) {
4240 return boost::shared_ptr<Track> ();
4243 boost::shared_ptr<Route>
4244 Session::get_remote_nth_route (PresentationInfo::order_t n) const
4246 return boost::dynamic_pointer_cast<Route> (get_remote_nth_stripable (n, PresentationInfo::Route));
4249 boost::shared_ptr<Stripable>
4250 Session::get_remote_nth_stripable (PresentationInfo::order_t n, PresentationInfo::Flag flags) const
4253 PresentationInfo::order_t match_cnt = 0;
4255 get_stripables (sl);
4256 sl.sort (Stripable::PresentationOrderSorter());
4258 for (StripableList::const_iterator s = sl.begin(); s != sl.end(); ++s) {
4260 if ((*s)->presentation_info().hidden()) {
4261 /* if the caller didn't explicitly ask for hidden
4262 stripables, ignore hidden ones. This matches
4263 the semantics of the pre-PresentationOrder
4264 "get by RID" logic of Ardour 4.x and earlier.
4266 XXX at some point we should likely reverse
4267 the logic of the flags, because asking for "the
4268 hidden stripables" is not going to be common,
4269 whereas asking for visible ones is normal.
4272 if (! (flags & PresentationInfo::Hidden)) {
4277 if ((*s)->presentation_info().flag_match (flags)) {
4278 if (match_cnt++ == n) {
4284 /* there is no nth stripable that matches the given flags */
4285 return boost::shared_ptr<Stripable>();
4288 boost::shared_ptr<Route>
4289 Session::route_by_selected_count (uint32_t id) const
4291 boost::shared_ptr<RouteList> r = routes.reader ();
4293 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4294 /* NOT IMPLEMENTED */
4297 return boost::shared_ptr<Route> ((Route*) 0);
4300 struct PresentationOrderSorter {
4301 bool operator() (boost::shared_ptr<Stripable> a, boost::shared_ptr<Stripable> b) {
4302 if (a->presentation_info().special() && !b->presentation_info().special()) {
4303 /* a is not ordered, b is; b comes before a */
4305 } else if (!b->presentation_info().order_set() && a->presentation_info().order_set()) {
4306 /* b is not ordered, a is; a comes before b */
4309 return a->presentation_info().order() < b->presentation_info().order();
4315 Session::reassign_track_numbers ()
4319 RouteList r (*(routes.reader ()));
4320 PresentationOrderSorter sorter;
4323 StateProtector sp (this);
4325 for (RouteList::iterator i = r.begin(); i != r.end(); ++i) {
4326 if (boost::dynamic_pointer_cast<Track> (*i)) {
4327 (*i)->set_track_number(++tn);
4329 else if (!(*i)->is_master() && !(*i)->is_monitor() && !(*i)->is_auditioner()) {
4330 (*i)->set_track_number(--bn);
4333 const uint32_t decimals = ceilf (log10f (tn + 1));
4334 const bool decimals_changed = _track_number_decimals != decimals;
4335 _track_number_decimals = decimals;
4337 if (decimals_changed && config.get_track_name_number ()) {
4338 for (RouteList::iterator i = r.begin(); i != r.end(); ++i) {
4339 boost::shared_ptr<Track> t = boost::dynamic_pointer_cast<Track> (*i);
4341 t->resync_track_name();
4344 // trigger GUI re-layout
4345 config.ParameterChanged("track-name-number");
4349 if (DEBUG_ENABLED(DEBUG::OrderKeys)) {
4350 boost::shared_ptr<RouteList> rl = routes.reader ();
4351 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
4352 DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("%1 numbered %2\n", (*i)->name(), (*i)->track_number()));
4360 Session::playlist_region_added (boost::weak_ptr<Region> w)
4362 boost::shared_ptr<Region> r = w.lock ();
4367 /* These are the operations that are currently in progress... */
4368 list<GQuark> curr = _current_trans_quarks;
4371 /* ...and these are the operations during which we want to update
4372 the session range location markers.
4375 ops.push_back (Operations::capture);
4376 ops.push_back (Operations::paste);
4377 ops.push_back (Operations::duplicate_region);
4378 ops.push_back (Operations::insert_file);
4379 ops.push_back (Operations::insert_region);
4380 ops.push_back (Operations::drag_region_brush);
4381 ops.push_back (Operations::region_drag);
4382 ops.push_back (Operations::selection_grab);
4383 ops.push_back (Operations::region_fill);
4384 ops.push_back (Operations::fill_selection);
4385 ops.push_back (Operations::create_region);
4386 ops.push_back (Operations::region_copy);
4387 ops.push_back (Operations::fixed_time_region_copy);
4390 /* See if any of the current operations match the ones that we want */
4392 set_intersection (_current_trans_quarks.begin(), _current_trans_quarks.end(), ops.begin(), ops.end(), back_inserter (in));
4394 /* If so, update the session range markers */
4396 maybe_update_session_range (r->position (), r->last_frame ());
4400 /** Update the session range markers if a is before the current start or
4401 * b is after the current end.
4404 Session::maybe_update_session_range (framepos_t a, framepos_t b)
4406 if (_state_of_the_state & Loading) {
4410 framepos_t session_end_marker_shift_samples = session_end_shift * _nominal_frame_rate;
4412 if (_session_range_location == 0) {
4414 set_session_range_location (a, b + session_end_marker_shift_samples);
4418 if (a < _session_range_location->start()) {
4419 _session_range_location->set_start (a);
4422 if (_session_range_end_is_free && (b > _session_range_location->end())) {
4423 _session_range_location->set_end (b);
4429 Session::set_end_is_free (bool yn)
4431 _session_range_end_is_free = yn;
4435 Session::playlist_ranges_moved (list<Evoral::RangeMove<framepos_t> > const & ranges)
4437 for (list<Evoral::RangeMove<framepos_t> >::const_iterator i = ranges.begin(); i != ranges.end(); ++i) {
4438 maybe_update_session_range (i->to, i->to + i->length);
4443 Session::playlist_regions_extended (list<Evoral::Range<framepos_t> > const & ranges)
4445 for (list<Evoral::Range<framepos_t> >::const_iterator i = ranges.begin(); i != ranges.end(); ++i) {
4446 maybe_update_session_range (i->from, i->to);
4450 /* Region management */
4452 boost::shared_ptr<Region>
4453 Session::find_whole_file_parent (boost::shared_ptr<Region const> child) const
4455 const RegionFactory::RegionMap& regions (RegionFactory::regions());
4456 RegionFactory::RegionMap::const_iterator i;
4457 boost::shared_ptr<Region> region;
4459 Glib::Threads::Mutex::Lock lm (region_lock);
4461 for (i = regions.begin(); i != regions.end(); ++i) {
4465 if (region->whole_file()) {
4467 if (child->source_equivalent (region)) {
4473 return boost::shared_ptr<Region> ();
4477 Session::destroy_sources (list<boost::shared_ptr<Source> > srcs)
4479 set<boost::shared_ptr<Region> > relevant_regions;
4481 for (list<boost::shared_ptr<Source> >::iterator s = srcs.begin(); s != srcs.end(); ++s) {
4482 RegionFactory::get_regions_using_source (*s, relevant_regions);
4485 for (set<boost::shared_ptr<Region> >::iterator r = relevant_regions.begin(); r != relevant_regions.end(); ) {
4486 set<boost::shared_ptr<Region> >::iterator tmp;
4491 playlists->destroy_region (*r);
4492 RegionFactory::map_remove (*r);
4494 (*r)->drop_sources ();
4495 (*r)->drop_references ();
4497 relevant_regions.erase (r);
4502 for (list<boost::shared_ptr<Source> >::iterator s = srcs.begin(); s != srcs.end(); ) {
4505 Glib::Threads::Mutex::Lock ls (source_lock);
4506 /* remove from the main source list */
4507 sources.erase ((*s)->id());
4510 (*s)->mark_for_remove ();
4511 (*s)->drop_references ();
4520 Session::remove_last_capture ()
4522 list<boost::shared_ptr<Source> > srcs;
4524 boost::shared_ptr<RouteList> rl = routes.reader ();
4525 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
4526 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
4531 list<boost::shared_ptr<Source> >& l = tr->last_capture_sources();
4534 srcs.insert (srcs.end(), l.begin(), l.end());
4539 destroy_sources (srcs);
4541 save_state (_current_snapshot_name);
4546 /* Source Management */
4549 Session::add_source (boost::shared_ptr<Source> source)
4551 pair<SourceMap::key_type, SourceMap::mapped_type> entry;
4552 pair<SourceMap::iterator,bool> result;
4554 entry.first = source->id();
4555 entry.second = source;
4558 Glib::Threads::Mutex::Lock lm (source_lock);
4559 result = sources.insert (entry);
4562 if (result.second) {
4564 /* yay, new source */
4566 boost::shared_ptr<FileSource> fs = boost::dynamic_pointer_cast<FileSource> (source);
4569 if (!fs->within_session()) {
4570 ensure_search_path_includes (Glib::path_get_dirname (fs->path()), fs->type());
4576 boost::shared_ptr<AudioFileSource> afs;
4578 if ((afs = boost::dynamic_pointer_cast<AudioFileSource>(source)) != 0) {
4579 if (Config->get_auto_analyse_audio()) {
4580 Analyser::queue_source_for_analysis (source, false);
4584 source->DropReferences.connect_same_thread (*this, boost::bind (&Session::remove_source, this, boost::weak_ptr<Source> (source)));
4589 Session::remove_source (boost::weak_ptr<Source> src)
4591 if (_state_of_the_state & Deletion) {
4595 SourceMap::iterator i;
4596 boost::shared_ptr<Source> source = src.lock();
4603 Glib::Threads::Mutex::Lock lm (source_lock);
4605 if ((i = sources.find (source->id())) != sources.end()) {
4610 if (!(_state_of_the_state & StateOfTheState (InCleanup|Loading))) {
4612 /* save state so we don't end up with a session file
4613 referring to non-existent sources.
4616 save_state (_current_snapshot_name);
4620 boost::shared_ptr<Source>
4621 Session::source_by_id (const PBD::ID& id)
4623 Glib::Threads::Mutex::Lock lm (source_lock);
4624 SourceMap::iterator i;
4625 boost::shared_ptr<Source> source;
4627 if ((i = sources.find (id)) != sources.end()) {
4634 boost::shared_ptr<AudioFileSource>
4635 Session::audio_source_by_path_and_channel (const string& path, uint16_t chn) const
4637 /* Restricted to audio files because only audio sources have channel
4641 Glib::Threads::Mutex::Lock lm (source_lock);
4643 for (SourceMap::const_iterator i = sources.begin(); i != sources.end(); ++i) {
4644 boost::shared_ptr<AudioFileSource> afs
4645 = boost::dynamic_pointer_cast<AudioFileSource>(i->second);
4647 if (afs && afs->path() == path && chn == afs->channel()) {
4652 return boost::shared_ptr<AudioFileSource>();
4655 boost::shared_ptr<MidiSource>
4656 Session::midi_source_by_path (const std::string& path) const
4658 /* Restricted to MIDI files because audio sources require a channel
4659 for unique identification, in addition to a path.
4662 Glib::Threads::Mutex::Lock lm (source_lock);
4664 for (SourceMap::const_iterator s = sources.begin(); s != sources.end(); ++s) {
4665 boost::shared_ptr<MidiSource> ms
4666 = boost::dynamic_pointer_cast<MidiSource>(s->second);
4667 boost::shared_ptr<FileSource> fs
4668 = boost::dynamic_pointer_cast<FileSource>(s->second);
4670 if (ms && fs && fs->path() == path) {
4675 return boost::shared_ptr<MidiSource>();
4679 Session::count_sources_by_origin (const string& path)
4682 Glib::Threads::Mutex::Lock lm (source_lock);
4684 for (SourceMap::iterator i = sources.begin(); i != sources.end(); ++i) {
4685 boost::shared_ptr<FileSource> fs
4686 = boost::dynamic_pointer_cast<FileSource>(i->second);
4688 if (fs && fs->origin() == path) {
4697 peak_file_helper (const string& peak_path, const string& file_path, const string& file_base, bool hash) {
4699 std::string checksum = Glib::Checksum::compute_checksum(Glib::Checksum::CHECKSUM_SHA1, file_path + G_DIR_SEPARATOR + file_base);
4700 return Glib::build_filename (peak_path, checksum + peakfile_suffix);
4702 return Glib::build_filename (peak_path, file_base + peakfile_suffix);
4707 Session::construct_peak_filepath (const string& filepath, const bool in_session, const bool old_peak_name) const
4709 string interchange_dir_string = string (interchange_dir_name) + G_DIR_SEPARATOR;
4711 if (Glib::path_is_absolute (filepath)) {
4713 /* rip the session dir from the audiofile source */
4715 string session_path;
4716 bool in_another_session = true;
4718 if (filepath.find (interchange_dir_string) != string::npos) {
4720 session_path = Glib::path_get_dirname (filepath); /* now ends in audiofiles */
4721 session_path = Glib::path_get_dirname (session_path); /* now ends in session name */
4722 session_path = Glib::path_get_dirname (session_path); /* now ends in interchange */
4723 session_path = Glib::path_get_dirname (session_path); /* now has session path */
4725 /* see if it is within our session */
4727 for (vector<space_and_path>::const_iterator i = session_dirs.begin(); i != session_dirs.end(); ++i) {
4728 if (i->path == session_path) {
4729 in_another_session = false;
4734 in_another_session = false;
4738 if (in_another_session) {
4739 SessionDirectory sd (session_path);
4740 return peak_file_helper (sd.peak_path(), "", Glib::path_get_basename (filepath), !old_peak_name);
4744 /* 1) if file belongs to this session
4745 * it may be a relative path (interchange/...)
4746 * or just basename (session_state, remove source)
4747 * -> just use the basename
4749 std::string filename = Glib::path_get_basename (filepath);
4752 /* 2) if the file is outside our session dir:
4753 * (imported but not copied) add the path for check-summming */
4755 path = Glib::path_get_dirname (filepath);
4758 return peak_file_helper (_session_dir->peak_path(), path, Glib::path_get_basename (filepath), !old_peak_name);
4762 Session::new_audio_source_path_for_embedded (const std::string& path)
4766 * we know that the filename is already unique because it exists
4767 * out in the filesystem.
4769 * However, when we bring it into the session, we could get a
4772 * Eg. two embedded files:
4777 * When merged into session, these collide.
4779 * There will not be a conflict with in-memory sources
4780 * because when the source was created we already picked
4781 * a unique name for it.
4783 * This collision is not likely to be common, but we have to guard
4784 * against it. So, if there is a collision, take the md5 hash of the
4785 * the path, and use that as the filename instead.
4788 SessionDirectory sdir (get_best_session_directory_for_new_audio());
4789 string base = Glib::path_get_basename (path);
4790 string newpath = Glib::build_filename (sdir.sound_path(), base);
4792 if (Glib::file_test (newpath, Glib::FILE_TEST_EXISTS)) {
4796 md5.digestString (path.c_str());
4797 md5.writeToString ();
4798 base = md5.digestChars;
4800 string ext = get_suffix (path);
4807 newpath = Glib::build_filename (sdir.sound_path(), base);
4809 /* if this collides, we're screwed */
4811 if (Glib::file_test (newpath, Glib::FILE_TEST_EXISTS)) {
4812 error << string_compose (_("Merging embedded file %1: name collision AND md5 hash collision!"), path) << endmsg;
4821 /** Return true if there are no audio file sources that use @param name as
4822 * the filename component of their path.
4824 * Return false otherwise.
4826 * This method MUST ONLY be used to check in-session, mono files since it
4827 * hard-codes the channel of the audio file source we are looking for as zero.
4829 * If/when Ardour supports native files in non-mono formats, the logic here
4830 * will need to be revisited.
4833 Session::audio_source_name_is_unique (const string& name)
4835 std::vector<string> sdirs = source_search_path (DataType::AUDIO);
4836 vector<space_and_path>::iterator i;
4837 uint32_t existing = 0;
4839 for (vector<string>::const_iterator i = sdirs.begin(); i != sdirs.end(); ++i) {
4841 /* note that we search *without* the extension so that
4842 we don't end up both "Audio 1-1.wav" and "Audio 1-1.caf"
4843 in the event that this new name is required for
4844 a file format change.
4847 const string spath = *i;
4849 if (matching_unsuffixed_filename_exists_in (spath, name)) {
4854 /* it is possible that we have the path already
4855 * assigned to a source that has not yet been written
4856 * (ie. the write source for a diskstream). we have to
4857 * check this in order to make sure that our candidate
4858 * path isn't used again, because that can lead to
4859 * two Sources point to the same file with different
4860 * notions of their removability.
4864 string possible_path = Glib::build_filename (spath, name);
4866 if (audio_source_by_path_and_channel (possible_path, 0)) {
4872 return (existing == 0);
4876 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)
4879 const string ext = native_header_format_extension (config.get_native_file_header_format(), DataType::AUDIO);
4881 if (Profile->get_trx() && destructive) {
4883 sstr << setfill ('0') << setw (4) << cnt;
4884 sstr << legalized_base;
4886 sstr << legalized_base;
4888 if (take_required || related_exists) {
4900 } else if (nchan > 2) {
4905 /* XXX what? more than 26 channels! */
4916 /** Return a unique name based on \a base for a new internal audio source */
4918 Session::new_audio_source_path (const string& base, uint32_t nchan, uint32_t chan, bool destructive, bool take_required)
4921 string possible_name;
4922 const uint32_t limit = 9999; // arbitrary limit on number of files with the same basic name
4924 bool some_related_source_name_exists = false;
4926 legalized = legalize_for_path (base);
4928 // Find a "version" of the base name that doesn't exist in any of the possible directories.
4930 for (cnt = (destructive ? ++destructive_index : 1); cnt <= limit; ++cnt) {
4932 possible_name = format_audio_source_name (legalized, nchan, chan, destructive, take_required, cnt, some_related_source_name_exists);
4934 if (audio_source_name_is_unique (possible_name)) {
4938 some_related_source_name_exists = true;
4941 error << string_compose(
4942 _("There are already %1 recordings for %2, which I consider too many."),
4943 limit, base) << endmsg;
4945 throw failed_constructor();
4949 /* We've established that the new name does not exist in any session
4950 * directory, so now find out which one we should use for this new
4954 SessionDirectory sdir (get_best_session_directory_for_new_audio());
4956 std::string s = Glib::build_filename (sdir.sound_path(), possible_name);
4961 /** Return a unique name based on `base` for a new internal MIDI source */
4963 Session::new_midi_source_path (const string& base)
4966 char buf[PATH_MAX+1];
4967 const uint32_t limit = 10000;
4969 string possible_path;
4970 string possible_name;
4973 legalized = legalize_for_path (base);
4975 // Find a "version" of the file name that doesn't exist in any of the possible directories.
4976 std::vector<string> sdirs = source_search_path(DataType::MIDI);
4978 /* - the main session folder is the first in the vector.
4979 * - after checking all locations for file-name uniqueness,
4980 * we keep the one from the last iteration as new file name
4981 * - midi files are small and should just be kept in the main session-folder
4983 * -> reverse the array, check main session folder last and use that as location
4986 std::reverse(sdirs.begin(), sdirs.end());
4988 for (cnt = 1; cnt <= limit; ++cnt) {
4990 vector<space_and_path>::iterator i;
4991 uint32_t existing = 0;
4993 for (vector<string>::const_iterator i = sdirs.begin(); i != sdirs.end(); ++i) {
4995 snprintf (buf, sizeof(buf), "%s-%u.mid", legalized.c_str(), cnt);
4996 possible_name = buf;
4998 possible_path = Glib::build_filename (*i, possible_name);
5000 if (Glib::file_test (possible_path, Glib::FILE_TEST_EXISTS)) {
5004 if (midi_source_by_path (possible_path)) {
5009 if (existing == 0) {
5014 error << string_compose(
5015 _("There are already %1 recordings for %2, which I consider too many."),
5016 limit, base) << endmsg;
5022 /* No need to "find best location" for software/app-based RAID, because
5023 MIDI is so small that we always put it in the same place.
5026 return possible_path;
5030 /** Create a new within-session audio source */
5031 boost::shared_ptr<AudioFileSource>
5032 Session::create_audio_source_for_session (size_t n_chans, string const & base, uint32_t chan, bool destructive)
5034 const string path = new_audio_source_path (base, n_chans, chan, destructive, true);
5036 if (!path.empty()) {
5037 return boost::dynamic_pointer_cast<AudioFileSource> (
5038 SourceFactory::createWritable (DataType::AUDIO, *this, path, destructive, frame_rate(), true, true));
5040 throw failed_constructor ();
5044 /** Create a new within-session MIDI source */
5045 boost::shared_ptr<MidiSource>
5046 Session::create_midi_source_for_session (string const & basic_name)
5048 const string path = new_midi_source_path (basic_name);
5050 if (!path.empty()) {
5051 return boost::dynamic_pointer_cast<SMFSource> (
5052 SourceFactory::createWritable (
5053 DataType::MIDI, *this, path, false, frame_rate()));
5055 throw failed_constructor ();
5059 /** Create a new within-session MIDI source */
5060 boost::shared_ptr<MidiSource>
5061 Session::create_midi_source_by_stealing_name (boost::shared_ptr<Track> track)
5063 /* the caller passes in the track the source will be used in,
5064 so that we can keep the numbering sane.
5066 Rationale: a track with the name "Foo" that has had N
5067 captures carried out so far will ALREADY have a write source
5068 named "Foo-N+1.mid" waiting to be used for the next capture.
5070 If we call new_midi_source_name() we will get "Foo-N+2". But
5071 there is no region corresponding to "Foo-N+1", so when
5072 "Foo-N+2" appears in the track, the gap presents the user
5073 with odd behaviour - why did it skip past Foo-N+1?
5075 We could explain this to the user in some odd way, but
5076 instead we rename "Foo-N+1.mid" as "Foo-N+2.mid", and then
5079 If that attempted rename fails, we get "Foo-N+2.mid" anyway.
5082 boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (track);
5084 std::string name = track->steal_write_source_name ();
5087 return boost::shared_ptr<MidiSource>();
5090 /* MIDI files are small, just put them in the first location of the
5091 session source search path.
5094 const string path = Glib::build_filename (source_search_path (DataType::MIDI).front(), name);
5096 return boost::dynamic_pointer_cast<SMFSource> (
5097 SourceFactory::createWritable (
5098 DataType::MIDI, *this, path, false, frame_rate()));
5103 Session::add_playlist (boost::shared_ptr<Playlist> playlist, bool unused)
5105 if (playlist->hidden()) {
5109 playlists->add (playlist);
5112 playlist->release();
5119 Session::remove_playlist (boost::weak_ptr<Playlist> weak_playlist)
5121 if (_state_of_the_state & Deletion) {
5125 boost::shared_ptr<Playlist> playlist (weak_playlist.lock());
5131 playlists->remove (playlist);
5137 Session::set_audition (boost::shared_ptr<Region> r)
5139 pending_audition_region = r;
5140 add_post_transport_work (PostTransportAudition);
5141 _butler->schedule_transport_work ();
5145 Session::audition_playlist ()
5147 SessionEvent* ev = new SessionEvent (SessionEvent::Audition, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
5148 ev->region.reset ();
5154 Session::register_lua_function (
5155 const std::string& name,
5156 const std::string& script,
5157 const LuaScriptParamList& args
5160 Glib::Threads::Mutex::Lock lm (lua_lock);
5162 lua_State* L = lua.getState();
5164 const std::string& bytecode = LuaScripting::get_factory_bytecode (script);
5165 luabridge::LuaRef tbl_arg (luabridge::newTable(L));
5166 for (LuaScriptParamList::const_iterator i = args.begin(); i != args.end(); ++i) {
5167 if ((*i)->optional && !(*i)->is_set) { continue; }
5168 tbl_arg[(*i)->name] = (*i)->value;
5170 (*_lua_add)(name, bytecode, tbl_arg); // throws luabridge::LuaException
5175 Session::unregister_lua_function (const std::string& name)
5177 Glib::Threads::Mutex::Lock lm (lua_lock);
5178 (*_lua_del)(name); // throws luabridge::LuaException
5179 lua.collect_garbage ();
5183 std::vector<std::string>
5184 Session::registered_lua_functions ()
5186 Glib::Threads::Mutex::Lock lm (lua_lock);
5187 std::vector<std::string> rv;
5190 luabridge::LuaRef list ((*_lua_list)());
5191 for (luabridge::Iterator i (list); !i.isNil (); ++i) {
5192 if (!i.key ().isString ()) { assert(0); continue; }
5193 rv.push_back (i.key ().cast<std::string> ());
5195 } catch (luabridge::LuaException const& e) { }
5200 static void _lua_print (std::string s) {
5201 std::cout << "SessionLua: " << s << "\n";
5206 Session::try_run_lua (pframes_t nframes)
5208 if (_n_lua_scripts == 0) return;
5209 Glib::Threads::Mutex::Lock tm (lua_lock, Glib::Threads::TRY_LOCK);
5211 try { (*_lua_run)(nframes); } catch (luabridge::LuaException const& e) { }
5212 lua.collect_garbage_step ();
5217 Session::setup_lua ()
5220 lua.Print.connect (&_lua_print);
5224 "function ArdourSession ()"
5225 " local self = { scripts = {}, instances = {} }"
5227 " local remove = function (n)"
5228 " self.scripts[n] = nil"
5229 " self.instances[n] = nil"
5230 " Session:scripts_changed()" // call back
5233 " local addinternal = function (n, f, a)"
5234 " assert(type(n) == 'string', 'function-name must be string')"
5235 " assert(type(f) == 'function', 'Given script is a not a function')"
5236 " assert(type(a) == 'table' or type(a) == 'nil', 'Given argument is invalid')"
5237 " assert(self.scripts[n] == nil, 'Callback \"'.. n ..'\" already exists.')"
5238 " self.scripts[n] = { ['f'] = f, ['a'] = a }"
5239 " 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"
5240 " 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 }"
5241 " self.instances[n] = load (string.dump(f, true), nil, nil, env)(a)"
5242 " Session:scripts_changed()" // call back
5245 " local add = function (n, b, a)"
5246 " assert(type(b) == 'string', 'ByteCode must be string')"
5247 " load (b)()" // assigns f
5248 " assert(type(f) == 'string', 'Assigned ByteCode must be string')"
5249 " addinternal (n, load(f), a)"
5252 " local run = function (...)"
5253 " for n, s in pairs (self.instances) do"
5254 " local status, err = pcall (s, ...)"
5255 " if not status then"
5256 " print ('fn \"'.. n .. '\": ', err)"
5263 " local cleanup = function ()"
5264 " self.scripts = nil"
5265 " self.instances = nil"
5268 " local list = function ()"
5270 " for n, _ in pairs (self.scripts) do"
5276 " local function basic_serialize (o)"
5277 " if type(o) == \"number\" then"
5278 " return tostring(o)"
5280 " return string.format(\"%q\", o)"
5284 " local function serialize (name, value)"
5285 " local rv = name .. ' = '"
5287 " if type(value) == \"number\" or type(value) == \"string\" or type(value) == \"nil\" then"
5288 " return rv .. basic_serialize(value) .. ' '"
5289 " elseif type(value) == \"table\" then"
5291 " for k,v in pairs(value) do"
5292 " local fieldname = string.format(\"%s[%s]\", name, basic_serialize(k))"
5293 " rv = rv .. serialize(fieldname, v) .. ' '"
5294 " collectgarbage()" // string concatenation allocates a new string :(
5297 " elseif type(value) == \"function\" then"
5298 " return rv .. string.format(\"%q\", string.dump(value, true))"
5300 " error('cannot save a ' .. type(value))"
5305 " local save = function ()"
5306 " return (serialize('scripts', self.scripts))"
5309 " local restore = function (state)"
5310 " self.scripts = {}"
5312 " for n, s in pairs (scripts) do"
5313 " addinternal (n, load(s['f']), s['a'])"
5317 " return { run = run, add = add, remove = remove,"
5318 " list = list, restore = restore, save = save, cleanup = cleanup}"
5321 " sess = ArdourSession ()"
5322 " ArdourSession = nil"
5324 "function ardour () end"
5327 lua_State* L = lua.getState();
5330 luabridge::LuaRef lua_sess = luabridge::getGlobal (L, "sess");
5331 lua.do_command ("sess = nil"); // hide it.
5332 lua.do_command ("collectgarbage()");
5334 _lua_run = new luabridge::LuaRef(lua_sess["run"]);
5335 _lua_add = new luabridge::LuaRef(lua_sess["add"]);
5336 _lua_del = new luabridge::LuaRef(lua_sess["remove"]);
5337 _lua_list = new luabridge::LuaRef(lua_sess["list"]);
5338 _lua_save = new luabridge::LuaRef(lua_sess["save"]);
5339 _lua_load = new luabridge::LuaRef(lua_sess["restore"]);
5340 _lua_cleanup = new luabridge::LuaRef(lua_sess["cleanup"]);
5341 } catch (luabridge::LuaException const& e) {
5342 fatal << string_compose (_("programming error: %1"),
5343 X_("Failed to setup Lua interpreter"))
5345 abort(); /*NOTREACHED*/
5348 LuaBindings::stddef (L);
5349 LuaBindings::common (L);
5350 LuaBindings::dsp (L);
5351 luabridge::push <Session *> (L, this);
5352 lua_setglobal (L, "Session");
5356 Session::scripts_changed ()
5358 assert (!lua_lock.trylock()); // must hold lua_lock
5361 luabridge::LuaRef list ((*_lua_list)());
5363 for (luabridge::Iterator i (list); !i.isNil (); ++i) {
5364 if (!i.key ().isString ()) { assert(0); continue; }
5367 _n_lua_scripts = cnt;
5368 } catch (luabridge::LuaException const& e) {
5369 fatal << string_compose (_("programming error: %1"),
5370 X_("Indexing Lua Session Scripts failed."))
5372 abort(); /*NOTREACHED*/
5377 Session::non_realtime_set_audition ()
5379 assert (pending_audition_region);
5380 auditioner->audition_region (pending_audition_region);
5381 pending_audition_region.reset ();
5382 AuditionActive (true); /* EMIT SIGNAL */
5386 Session::audition_region (boost::shared_ptr<Region> r)
5388 SessionEvent* ev = new SessionEvent (SessionEvent::Audition, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
5394 Session::cancel_audition ()
5399 if (auditioner->auditioning()) {
5400 auditioner->cancel_audition ();
5401 AuditionActive (false); /* EMIT SIGNAL */
5406 Session::RoutePublicOrderSorter::operator() (boost::shared_ptr<Route> a, boost::shared_ptr<Route> b)
5408 if (a->is_monitor()) {
5411 if (b->is_monitor()) {
5414 return a->presentation_info().order() < b->presentation_info().order();
5418 Session::is_auditioning () const
5420 /* can be called before we have an auditioner object */
5422 return auditioner->auditioning();
5429 Session::graph_reordered ()
5431 /* don't do this stuff if we are setting up connections
5432 from a set_state() call or creating new tracks. Ditto for deletion.
5435 if ((_state_of_the_state & (InitialConnecting|Deletion)) || _adding_routes_in_progress || _reconnecting_routes_in_progress || _route_deletion_in_progress) {
5439 /* every track/bus asked for this to be handled but it was deferred because
5440 we were connecting. do it now.
5443 request_input_change_handling ();
5447 /* force all diskstreams to update their capture offset values to
5448 reflect any changes in latencies within the graph.
5451 boost::shared_ptr<RouteList> rl = routes.reader ();
5452 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
5453 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
5455 tr->set_capture_offset ();
5460 /** @return Number of frames that there is disk space available to write,
5463 boost::optional<framecnt_t>
5464 Session::available_capture_duration ()
5466 Glib::Threads::Mutex::Lock lm (space_lock);
5468 if (_total_free_4k_blocks_uncertain) {
5469 return boost::optional<framecnt_t> ();
5472 float sample_bytes_on_disk = 4.0; // keep gcc happy
5474 switch (config.get_native_file_data_format()) {
5476 sample_bytes_on_disk = 4.0;
5480 sample_bytes_on_disk = 3.0;
5484 sample_bytes_on_disk = 2.0;
5488 /* impossible, but keep some gcc versions happy */
5489 fatal << string_compose (_("programming error: %1"),
5490 X_("illegal native file data format"))
5492 abort(); /*NOTREACHED*/
5495 double scale = 4096.0 / sample_bytes_on_disk;
5497 if (_total_free_4k_blocks * scale > (double) max_framecnt) {
5498 return max_framecnt;
5501 return (framecnt_t) floor (_total_free_4k_blocks * scale);
5505 Session::add_bundle (boost::shared_ptr<Bundle> bundle, bool emit_signal)
5508 RCUWriter<BundleList> writer (_bundles);
5509 boost::shared_ptr<BundleList> b = writer.get_copy ();
5510 b->push_back (bundle);
5514 BundleAddedOrRemoved (); /* EMIT SIGNAL */
5521 Session::remove_bundle (boost::shared_ptr<Bundle> bundle)
5523 bool removed = false;
5526 RCUWriter<BundleList> writer (_bundles);
5527 boost::shared_ptr<BundleList> b = writer.get_copy ();
5528 BundleList::iterator i = find (b->begin(), b->end(), bundle);
5530 if (i != b->end()) {
5537 BundleAddedOrRemoved (); /* EMIT SIGNAL */
5543 boost::shared_ptr<Bundle>
5544 Session::bundle_by_name (string name) const
5546 boost::shared_ptr<BundleList> b = _bundles.reader ();
5548 for (BundleList::const_iterator i = b->begin(); i != b->end(); ++i) {
5549 if ((*i)->name() == name) {
5554 return boost::shared_ptr<Bundle> ();
5558 Session::tempo_map_changed (const PropertyChange&)
5562 playlists->update_after_tempo_map_change ();
5564 _locations->apply (*this, &Session::update_locations_after_tempo_map_change);
5570 Session::gui_tempo_map_changed ()
5574 playlists->update_after_tempo_map_change ();
5576 _locations->apply (*this, &Session::update_locations_after_tempo_map_change);
5580 Session::update_locations_after_tempo_map_change (const Locations::LocationList& loc)
5582 for (Locations::LocationList::const_iterator i = loc.begin(); i != loc.end(); ++i) {
5583 (*i)->recompute_frames_from_bbt ();
5587 /** Ensures that all buffers (scratch, send, silent, etc) are allocated for
5588 * the given count with the current block size.
5591 Session::ensure_buffers (ChanCount howmany)
5593 BufferManager::ensure_buffers (howmany, bounce_processing() ? bounce_chunk_size : 0);
5597 Session::ensure_buffer_set(BufferSet& buffers, const ChanCount& count)
5599 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
5600 buffers.ensure_buffers(*t, count.get(*t), _engine.raw_buffer_size(*t));
5605 Session::next_insert_id ()
5607 /* this doesn't really loop forever. just think about it */
5610 for (boost::dynamic_bitset<uint32_t>::size_type n = 1; n < insert_bitset.size(); ++n) {
5611 if (!insert_bitset[n]) {
5612 insert_bitset[n] = true;
5618 /* none available, so resize and try again */
5620 insert_bitset.resize (insert_bitset.size() + 16, false);
5625 Session::next_send_id ()
5627 /* this doesn't really loop forever. just think about it */
5630 for (boost::dynamic_bitset<uint32_t>::size_type n = 1; n < send_bitset.size(); ++n) {
5631 if (!send_bitset[n]) {
5632 send_bitset[n] = true;
5638 /* none available, so resize and try again */
5640 send_bitset.resize (send_bitset.size() + 16, false);
5645 Session::next_aux_send_id ()
5647 /* this doesn't really loop forever. just think about it */
5650 for (boost::dynamic_bitset<uint32_t>::size_type n = 1; n < aux_send_bitset.size(); ++n) {
5651 if (!aux_send_bitset[n]) {
5652 aux_send_bitset[n] = true;
5658 /* none available, so resize and try again */
5660 aux_send_bitset.resize (aux_send_bitset.size() + 16, false);
5665 Session::next_return_id ()
5667 /* this doesn't really loop forever. just think about it */
5670 for (boost::dynamic_bitset<uint32_t>::size_type n = 1; n < return_bitset.size(); ++n) {
5671 if (!return_bitset[n]) {
5672 return_bitset[n] = true;
5678 /* none available, so resize and try again */
5680 return_bitset.resize (return_bitset.size() + 16, false);
5685 Session::mark_send_id (uint32_t id)
5687 if (id >= send_bitset.size()) {
5688 send_bitset.resize (id+16, false);
5690 if (send_bitset[id]) {
5691 warning << string_compose (_("send ID %1 appears to be in use already"), id) << endmsg;
5693 send_bitset[id] = true;
5697 Session::mark_aux_send_id (uint32_t id)
5699 if (id >= aux_send_bitset.size()) {
5700 aux_send_bitset.resize (id+16, false);
5702 if (aux_send_bitset[id]) {
5703 warning << string_compose (_("aux send ID %1 appears to be in use already"), id) << endmsg;
5705 aux_send_bitset[id] = true;
5709 Session::mark_return_id (uint32_t id)
5711 if (id >= return_bitset.size()) {
5712 return_bitset.resize (id+16, false);
5714 if (return_bitset[id]) {
5715 warning << string_compose (_("return ID %1 appears to be in use already"), id) << endmsg;
5717 return_bitset[id] = true;
5721 Session::mark_insert_id (uint32_t id)
5723 if (id >= insert_bitset.size()) {
5724 insert_bitset.resize (id+16, false);
5726 if (insert_bitset[id]) {
5727 warning << string_compose (_("insert ID %1 appears to be in use already"), id) << endmsg;
5729 insert_bitset[id] = true;
5733 Session::unmark_send_id (uint32_t id)
5735 if (id < send_bitset.size()) {
5736 send_bitset[id] = false;
5741 Session::unmark_aux_send_id (uint32_t id)
5743 if (id < aux_send_bitset.size()) {
5744 aux_send_bitset[id] = false;
5749 Session::unmark_return_id (uint32_t id)
5751 if (_state_of_the_state & Deletion) { return; }
5752 if (id < return_bitset.size()) {
5753 return_bitset[id] = false;
5758 Session::unmark_insert_id (uint32_t id)
5760 if (id < insert_bitset.size()) {
5761 insert_bitset[id] = false;
5766 Session::reset_native_file_format ()
5768 boost::shared_ptr<RouteList> rl = routes.reader ();
5770 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
5771 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
5773 /* don't save state as we do this, there's no point
5775 _state_of_the_state = StateOfTheState (_state_of_the_state|InCleanup);
5776 tr->reset_write_sources (false);
5777 _state_of_the_state = StateOfTheState (_state_of_the_state & ~InCleanup);
5783 Session::route_name_unique (string n) const
5785 boost::shared_ptr<RouteList> r = routes.reader ();
5787 for (RouteList::const_iterator i = r->begin(); i != r->end(); ++i) {
5788 if ((*i)->name() == n) {
5797 Session::route_name_internal (string n) const
5799 if (auditioner && auditioner->name() == n) {
5803 if (_click_io && _click_io->name() == n) {
5811 Session::freeze_all (InterThreadInfo& itt)
5813 boost::shared_ptr<RouteList> r = routes.reader ();
5815 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
5817 boost::shared_ptr<Track> t;
5819 if ((t = boost::dynamic_pointer_cast<Track>(*i)) != 0) {
5820 /* XXX this is wrong because itt.progress will keep returning to zero at the start
5830 boost::shared_ptr<Region>
5831 Session::write_one_track (Track& track, framepos_t start, framepos_t end,
5832 bool /*overwrite*/, vector<boost::shared_ptr<Source> >& srcs,
5833 InterThreadInfo& itt,
5834 boost::shared_ptr<Processor> endpoint, bool include_endpoint,
5835 bool for_export, bool for_freeze)
5837 boost::shared_ptr<Region> result;
5838 boost::shared_ptr<Playlist> playlist;
5839 boost::shared_ptr<Source> source;
5840 ChanCount diskstream_channels (track.n_channels());
5841 framepos_t position;
5842 framecnt_t this_chunk;
5844 framepos_t latency_skip;
5846 framepos_t len = end - start;
5847 bool need_block_size_reset = false;
5848 ChanCount const max_proc = track.max_processor_streams ();
5849 string legal_playlist_name;
5850 string possible_path;
5853 error << string_compose (_("Cannot write a range where end <= start (e.g. %1 <= %2)"),
5854 end, start) << endmsg;
5858 diskstream_channels = track.bounce_get_output_streams (diskstream_channels, endpoint,
5859 include_endpoint, for_export, for_freeze);
5861 if (diskstream_channels.n(track.data_type()) < 1) {
5862 error << _("Cannot write a range with no data.") << endmsg;
5866 // block all process callback handling
5868 block_processing ();
5871 // synchronize with AudioEngine::process_callback()
5872 // make sure processing is not currently running
5873 // and processing_blocked() is honored before
5874 // acquiring thread buffers
5875 Glib::Threads::Mutex::Lock lm (_engine.process_lock());
5878 _bounce_processing_active = true;
5880 /* call tree *MUST* hold route_lock */
5882 if ((playlist = track.playlist()) == 0) {
5886 legal_playlist_name = legalize_for_path (playlist->name());
5888 for (uint32_t chan_n = 0; chan_n < diskstream_channels.n(track.data_type()); ++chan_n) {
5890 string base_name = string_compose ("%1-%2-bounce", playlist->name(), chan_n);
5891 string path = ((track.data_type() == DataType::AUDIO)
5892 ? new_audio_source_path (legal_playlist_name, diskstream_channels.n_audio(), chan_n, false, true)
5893 : new_midi_source_path (legal_playlist_name));
5900 source = SourceFactory::createWritable (track.data_type(), *this, path, false, frame_rate());
5903 catch (failed_constructor& err) {
5904 error << string_compose (_("cannot create new file \"%1\" for %2"), path, track.name()) << endmsg;
5908 srcs.push_back (source);
5911 /* tell redirects that care that we are about to use a much larger
5912 * blocksize. this will flush all plugins too, so that they are ready
5913 * to be used for this process.
5916 need_block_size_reset = true;
5917 track.set_block_size (bounce_chunk_size);
5918 _engine.main_thread()->get_buffers ();
5922 latency_skip = track.bounce_get_latency (endpoint, include_endpoint, for_export, for_freeze);
5924 /* create a set of reasonably-sized buffers */
5925 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
5926 buffers.ensure_buffers(*t, max_proc.get(*t), bounce_chunk_size);
5928 buffers.set_count (max_proc);
5930 for (vector<boost::shared_ptr<Source> >::iterator src = srcs.begin(); src != srcs.end(); ++src) {
5931 boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*src);
5932 boost::shared_ptr<MidiSource> ms;
5934 afs->prepare_for_peakfile_writes ();
5935 } else if ((ms = boost::dynamic_pointer_cast<MidiSource>(*src))) {
5936 Source::Lock lock(ms->mutex());
5937 ms->mark_streaming_write_started(lock);
5941 while (to_do && !itt.cancel) {
5943 this_chunk = min (to_do, bounce_chunk_size);
5945 if (track.export_stuff (buffers, start, this_chunk, endpoint, include_endpoint, for_export, for_freeze)) {
5949 start += this_chunk;
5950 to_do -= this_chunk;
5951 itt.progress = (float) (1.0 - ((double) to_do / len));
5953 if (latency_skip >= bounce_chunk_size) {
5954 latency_skip -= bounce_chunk_size;
5958 const framecnt_t current_chunk = this_chunk - latency_skip;
5961 for (vector<boost::shared_ptr<Source> >::iterator src=srcs.begin(); src != srcs.end(); ++src, ++n) {
5962 boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*src);
5963 boost::shared_ptr<MidiSource> ms;
5966 if (afs->write (buffers.get_audio(n).data(latency_skip), current_chunk) != current_chunk) {
5969 } else if ((ms = boost::dynamic_pointer_cast<MidiSource>(*src))) {
5970 Source::Lock lock(ms->mutex());
5972 const MidiBuffer& buf = buffers.get_midi(0);
5973 for (MidiBuffer::const_iterator i = buf.begin(); i != buf.end(); ++i) {
5974 Evoral::Event<framepos_t> ev = *i;
5975 ev.set_time(ev.time() - position);
5976 ms->append_event_frames(lock, ev, ms->timeline_position());
5983 /* post-roll, pick up delayed processor output */
5984 latency_skip = track.bounce_get_latency (endpoint, include_endpoint, for_export, for_freeze);
5986 while (latency_skip && !itt.cancel) {
5987 this_chunk = min (latency_skip, bounce_chunk_size);
5988 latency_skip -= this_chunk;
5990 buffers.silence (this_chunk, 0);
5991 track.bounce_process (buffers, start, this_chunk, endpoint, include_endpoint, for_export, for_freeze);
5994 for (vector<boost::shared_ptr<Source> >::iterator src=srcs.begin(); src != srcs.end(); ++src, ++n) {
5995 boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*src);
5998 if (afs->write (buffers.get_audio(n).data(), this_chunk) != this_chunk) {
6010 xnow = localtime (&now);
6012 for (vector<boost::shared_ptr<Source> >::iterator src=srcs.begin(); src != srcs.end(); ++src) {
6013 boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*src);
6014 boost::shared_ptr<MidiSource> ms;
6017 afs->update_header (position, *xnow, now);
6018 afs->flush_header ();
6019 } else if ((ms = boost::dynamic_pointer_cast<MidiSource>(*src))) {
6020 Source::Lock lock(ms->mutex());
6021 ms->mark_streaming_write_completed(lock);
6025 /* construct a region to represent the bounced material */
6029 plist.add (Properties::start, 0);
6030 plist.add (Properties::length, srcs.front()->length(srcs.front()->timeline_position()));
6031 plist.add (Properties::name, region_name_from_path (srcs.front()->name(), true));
6033 result = RegionFactory::create (srcs, plist);
6039 for (vector<boost::shared_ptr<Source> >::iterator src = srcs.begin(); src != srcs.end(); ++src) {
6040 (*src)->mark_for_remove ();
6041 (*src)->drop_references ();
6045 for (vector<boost::shared_ptr<Source> >::iterator src = srcs.begin(); src != srcs.end(); ++src) {
6046 boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*src);
6049 afs->done_with_peakfile_writes ();
6053 _bounce_processing_active = false;
6055 if (need_block_size_reset) {
6056 _engine.main_thread()->drop_buffers ();
6057 track.set_block_size (get_block_size());
6060 unblock_processing ();
6066 Session::gain_automation_buffer() const
6068 return ProcessThread::gain_automation_buffer ();
6072 Session::trim_automation_buffer() const
6074 return ProcessThread::trim_automation_buffer ();
6078 Session::send_gain_automation_buffer() const
6080 return ProcessThread::send_gain_automation_buffer ();
6084 Session::pan_automation_buffer() const
6086 return ProcessThread::pan_automation_buffer ();
6090 Session::get_silent_buffers (ChanCount count)
6092 return ProcessThread::get_silent_buffers (count);
6096 Session::get_scratch_buffers (ChanCount count, bool silence)
6098 return ProcessThread::get_scratch_buffers (count, silence);
6102 Session::get_noinplace_buffers (ChanCount count)
6104 return ProcessThread::get_noinplace_buffers (count);
6108 Session::get_route_buffers (ChanCount count, bool silence)
6110 return ProcessThread::get_route_buffers (count, silence);
6115 Session::get_mix_buffers (ChanCount count)
6117 return ProcessThread::get_mix_buffers (count);
6121 Session::ntracks () const
6124 boost::shared_ptr<RouteList> r = routes.reader ();
6126 for (RouteList::const_iterator i = r->begin(); i != r->end(); ++i) {
6127 if (boost::dynamic_pointer_cast<Track> (*i)) {
6136 Session::nbusses () const
6139 boost::shared_ptr<RouteList> r = routes.reader ();
6141 for (RouteList::const_iterator i = r->begin(); i != r->end(); ++i) {
6142 if (boost::dynamic_pointer_cast<Track>(*i) == 0) {
6151 Session::add_automation_list(AutomationList *al)
6153 automation_lists[al->id()] = al;
6156 /** @return true if there is at least one record-enabled track, otherwise false */
6158 Session::have_rec_enabled_track () const
6160 return g_atomic_int_get (const_cast<gint*>(&_have_rec_enabled_track)) == 1;
6164 Session::have_rec_disabled_track () const
6166 return g_atomic_int_get (const_cast<gint*>(&_have_rec_disabled_track)) == 1;
6169 /** Update the state of our rec-enabled tracks flag */
6171 Session::update_route_record_state ()
6173 boost::shared_ptr<RouteList> rl = routes.reader ();
6174 RouteList::iterator i = rl->begin();
6175 while (i != rl->end ()) {
6177 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
6178 if (tr && tr->rec_enable_control()->get_value()) {
6185 int const old = g_atomic_int_get (&_have_rec_enabled_track);
6187 g_atomic_int_set (&_have_rec_enabled_track, i != rl->end () ? 1 : 0);
6189 if (g_atomic_int_get (&_have_rec_enabled_track) != old) {
6190 RecordStateChanged (); /* EMIT SIGNAL */
6193 for (i = rl->begin(); i != rl->end (); ++i) {
6194 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
6195 if (tr && !tr->rec_enable_control()->get_value()) {
6200 g_atomic_int_set (&_have_rec_disabled_track, i != rl->end () ? 1 : 0);
6202 bool record_arm_state_changed = (old != g_atomic_int_get (&_have_rec_enabled_track) );
6204 if (record_status() == Recording && record_arm_state_changed ) {
6205 RecordArmStateChanged ();
6211 Session::listen_position_changed ()
6213 ProcessorChangeBlocker pcb (this);
6214 boost::shared_ptr<RouteList> r = routes.reader ();
6215 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6216 (*i)->listen_position_changed ();
6221 Session::solo_control_mode_changed ()
6223 if (soloing() || listening()) {
6225 /* We can't use ::clear_all_solo_state() here because during
6226 session loading at program startup, that will queue a call
6227 to rt_clear_all_solo_state() that will not execute until
6228 AFTER solo states have been established (thus throwing away
6229 the session's saved solo state). So just explicitly turn
6232 set_controls (route_list_to_control_list (get_routes(), &Stripable::solo_control), 0.0, Controllable::NoGroup);
6234 clear_all_solo_state (get_routes());
6239 /** Called when a property of one of our route groups changes */
6241 Session::route_group_property_changed (RouteGroup* rg)
6243 RouteGroupPropertyChanged (rg); /* EMIT SIGNAL */
6246 /** Called when a route is added to one of our route groups */
6248 Session::route_added_to_route_group (RouteGroup* rg, boost::weak_ptr<Route> r)
6250 RouteAddedToRouteGroup (rg, r);
6253 /** Called when a route is removed from one of our route groups */
6255 Session::route_removed_from_route_group (RouteGroup* rg, boost::weak_ptr<Route> r)
6257 update_route_record_state ();
6258 RouteRemovedFromRouteGroup (rg, r); /* EMIT SIGNAL */
6260 if (!rg->has_control_master () && !rg->has_subgroup () && rg->empty()) {
6261 remove_route_group (*rg);
6265 boost::shared_ptr<RouteList>
6266 Session::get_tracks () const
6268 boost::shared_ptr<RouteList> rl = routes.reader ();
6269 boost::shared_ptr<RouteList> tl (new RouteList);
6271 for (RouteList::const_iterator r = rl->begin(); r != rl->end(); ++r) {
6272 if (boost::dynamic_pointer_cast<Track> (*r)) {
6273 if (!(*r)->is_auditioner()) {
6281 boost::shared_ptr<RouteList>
6282 Session::get_routes_with_regions_at (framepos_t const p) const
6284 boost::shared_ptr<RouteList> r = routes.reader ();
6285 boost::shared_ptr<RouteList> rl (new RouteList);
6287 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6288 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
6293 boost::shared_ptr<Playlist> pl = tr->playlist ();
6298 if (pl->has_region_at (p)) {
6307 Session::goto_end ()
6309 if (_session_range_location) {
6310 request_locate (_session_range_location->end(), false);
6312 request_locate (0, false);
6317 Session::goto_start (bool and_roll)
6319 if (_session_range_location) {
6320 request_locate (_session_range_location->start(), and_roll);
6322 request_locate (0, and_roll);
6327 Session::current_start_frame () const
6329 return _session_range_location ? _session_range_location->start() : 0;
6333 Session::current_end_frame () const
6335 return _session_range_location ? _session_range_location->end() : 0;
6339 Session::set_session_range_location (framepos_t start, framepos_t end)
6341 _session_range_location = new Location (*this, start, end, _("session"), Location::IsSessionRange);
6342 _locations->add (_session_range_location);
6346 Session::step_edit_status_change (bool yn)
6352 send = (_step_editors == 0);
6357 send = (_step_editors == 1);
6360 if (_step_editors > 0) {
6366 StepEditStatusChange (val);
6372 Session::start_time_changed (framepos_t old)
6374 /* Update the auto loop range to match the session range
6375 (unless the auto loop range has been changed by the user)
6378 Location* s = _locations->session_range_location ();
6383 Location* l = _locations->auto_loop_location ();
6385 if (l && l->start() == old) {
6386 l->set_start (s->start(), true);
6392 Session::end_time_changed (framepos_t old)
6394 /* Update the auto loop range to match the session range
6395 (unless the auto loop range has been changed by the user)
6398 Location* s = _locations->session_range_location ();
6403 Location* l = _locations->auto_loop_location ();
6405 if (l && l->end() == old) {
6406 l->set_end (s->end(), true);
6411 std::vector<std::string>
6412 Session::source_search_path (DataType type) const
6416 if (session_dirs.size() == 1) {
6418 case DataType::AUDIO:
6419 sp.push_back (_session_dir->sound_path());
6421 case DataType::MIDI:
6422 sp.push_back (_session_dir->midi_path());
6426 for (vector<space_and_path>::const_iterator i = session_dirs.begin(); i != session_dirs.end(); ++i) {
6427 SessionDirectory sdir (i->path);
6429 case DataType::AUDIO:
6430 sp.push_back (sdir.sound_path());
6432 case DataType::MIDI:
6433 sp.push_back (sdir.midi_path());
6439 if (type == DataType::AUDIO) {
6440 const string sound_path_2X = _session_dir->sound_path_2X();
6441 if (Glib::file_test (sound_path_2X, Glib::FILE_TEST_EXISTS|Glib::FILE_TEST_IS_DIR)) {
6442 if (find (sp.begin(), sp.end(), sound_path_2X) == sp.end()) {
6443 sp.push_back (sound_path_2X);
6448 // now check the explicit (possibly user-specified) search path
6451 case DataType::AUDIO:
6452 sp += Searchpath(config.get_audio_search_path ());
6454 case DataType::MIDI:
6455 sp += Searchpath(config.get_midi_search_path ());
6463 Session::ensure_search_path_includes (const string& path, DataType type)
6472 case DataType::AUDIO:
6473 sp += Searchpath(config.get_audio_search_path ());
6475 case DataType::MIDI:
6476 sp += Searchpath (config.get_midi_search_path ());
6480 for (vector<std::string>::iterator i = sp.begin(); i != sp.end(); ++i) {
6481 /* No need to add this new directory if it has the same inode as
6482 an existing one; checking inode rather than name prevents duplicated
6483 directories when we are using symlinks.
6485 On Windows, I think we could just do if (*i == path) here.
6487 if (PBD::equivalent_paths (*i, path)) {
6495 case DataType::AUDIO:
6496 config.set_audio_search_path (sp.to_string());
6498 case DataType::MIDI:
6499 config.set_midi_search_path (sp.to_string());
6505 Session::remove_dir_from_search_path (const string& dir, DataType type)
6510 case DataType::AUDIO:
6511 sp = Searchpath(config.get_audio_search_path ());
6513 case DataType::MIDI:
6514 sp = Searchpath (config.get_midi_search_path ());
6521 case DataType::AUDIO:
6522 config.set_audio_search_path (sp.to_string());
6524 case DataType::MIDI:
6525 config.set_midi_search_path (sp.to_string());
6531 boost::shared_ptr<Speakers>
6532 Session::get_speakers()
6538 Session::unknown_processors () const
6542 boost::shared_ptr<RouteList> r = routes.reader ();
6543 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6544 list<string> t = (*i)->unknown_processors ();
6545 copy (t.begin(), t.end(), back_inserter (p));
6555 Session::update_latency (bool playback)
6558 DEBUG_TRACE (DEBUG::Latency, string_compose ("JACK latency callback: %1\n", (playback ? "PLAYBACK" : "CAPTURE")));
6560 if ((_state_of_the_state & (InitialConnecting|Deletion)) || _adding_routes_in_progress || _route_deletion_in_progress) {
6564 boost::shared_ptr<RouteList> r = routes.reader ();
6565 framecnt_t max_latency = 0;
6568 /* reverse the list so that we work backwards from the last route to run to the first */
6569 RouteList* rl = routes.reader().get();
6570 r.reset (new RouteList (*rl));
6571 reverse (r->begin(), r->end());
6574 /* compute actual latency values for the given direction and store them all in per-port
6575 structures. this will also publish the same values (to JACK) so that computation of latency
6576 for routes can consistently use public latency values.
6579 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6580 max_latency = max (max_latency, (*i)->set_private_port_latencies (playback));
6583 /* because we latency compensate playback, our published playback latencies should
6584 be the same for all output ports - all material played back by ardour has
6585 the same latency, whether its caused by plugins or by latency compensation. since
6586 these may differ from the values computed above, reset all playback port latencies
6590 DEBUG_TRACE (DEBUG::Latency, string_compose ("Set public port latencies to %1\n", max_latency));
6592 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6593 (*i)->set_public_port_latencies (max_latency, playback);
6598 post_playback_latency ();
6602 post_capture_latency ();
6605 DEBUG_TRACE (DEBUG::Latency, "JACK latency callback: DONE\n");
6609 Session::post_playback_latency ()
6611 set_worst_playback_latency ();
6613 boost::shared_ptr<RouteList> r = routes.reader ();
6615 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6616 if (!(*i)->is_auditioner() && ((*i)->active())) {
6617 _worst_track_latency = max (_worst_track_latency, (*i)->update_signal_latency ());
6621 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6622 (*i)->set_latency_compensation (_worst_track_latency);
6627 Session::post_capture_latency ()
6629 set_worst_capture_latency ();
6631 /* reflect any changes in capture latencies into capture offsets
6634 boost::shared_ptr<RouteList> rl = routes.reader();
6635 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
6636 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
6638 tr->set_capture_offset ();
6644 Session::initialize_latencies ()
6647 Glib::Threads::Mutex::Lock lm (_engine.process_lock());
6648 update_latency (false);
6649 update_latency (true);
6652 set_worst_io_latencies ();
6656 Session::set_worst_io_latencies ()
6658 set_worst_playback_latency ();
6659 set_worst_capture_latency ();
6663 Session::set_worst_playback_latency ()
6665 if (_state_of_the_state & (InitialConnecting|Deletion)) {
6669 _worst_output_latency = 0;
6671 if (!_engine.connected()) {
6675 boost::shared_ptr<RouteList> r = routes.reader ();
6677 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6678 _worst_output_latency = max (_worst_output_latency, (*i)->output()->latency());
6681 DEBUG_TRACE (DEBUG::Latency, string_compose ("Worst output latency: %1\n", _worst_output_latency));
6685 Session::set_worst_capture_latency ()
6687 if (_state_of_the_state & (InitialConnecting|Deletion)) {
6691 _worst_input_latency = 0;
6693 if (!_engine.connected()) {
6697 boost::shared_ptr<RouteList> r = routes.reader ();
6699 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6700 _worst_input_latency = max (_worst_input_latency, (*i)->input()->latency());
6703 DEBUG_TRACE (DEBUG::Latency, string_compose ("Worst input latency: %1\n", _worst_input_latency));
6707 Session::update_latency_compensation (bool force_whole_graph)
6709 bool some_track_latency_changed = false;
6711 if (_state_of_the_state & (InitialConnecting|Deletion)) {
6715 DEBUG_TRACE(DEBUG::Latency, "---------------------------- update latency compensation\n\n");
6717 _worst_track_latency = 0;
6719 boost::shared_ptr<RouteList> r = routes.reader ();
6721 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6722 if (!(*i)->is_auditioner() && ((*i)->active())) {
6724 if ((*i)->signal_latency () != (tl = (*i)->update_signal_latency ())) {
6725 some_track_latency_changed = true;
6727 _worst_track_latency = max (tl, _worst_track_latency);
6731 DEBUG_TRACE (DEBUG::Latency, string_compose ("worst signal processing latency: %1 (changed ? %2)\n", _worst_track_latency,
6732 (some_track_latency_changed ? "yes" : "no")));
6734 DEBUG_TRACE(DEBUG::Latency, "---------------------------- DONE update latency compensation\n\n");
6736 if (some_track_latency_changed || force_whole_graph) {
6737 _engine.update_latencies ();
6741 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6742 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
6746 tr->set_capture_offset ();
6751 Session::session_name_is_legal (const string& path)
6753 char illegal_chars[] = { '/', '\\', ':', ';', '\0' };
6755 for (int i = 0; illegal_chars[i]; ++i) {
6756 if (path.find (illegal_chars[i]) != string::npos) {
6757 return illegal_chars[i];
6765 Session::notify_presentation_info_change ()
6767 if (deletion_in_progress()) {
6771 PresentationInfo::Change (); /* EMIT SIGNAL */
6772 reassign_track_numbers();
6774 #ifdef USE_TRACKS_CODE_FEATURES
6775 /* Waves Tracks: for Waves Tracks session it's required to reconnect their IOs
6776 * if track order has been changed by user
6778 reconnect_existing_routes(true, true);
6784 Session::operation_in_progress (GQuark op) const
6786 return (find (_current_trans_quarks.begin(), _current_trans_quarks.end(), op) != _current_trans_quarks.end());
6789 boost::shared_ptr<Port>
6790 Session::ltc_input_port () const
6792 return _ltc_input->nth (0);
6795 boost::shared_ptr<Port>
6796 Session::ltc_output_port () const
6798 return _ltc_output->nth (0);
6802 Session::reconnect_ltc_input ()
6806 string src = Config->get_ltc_source_port();
6808 _ltc_input->disconnect (this);
6810 if (src != _("None") && !src.empty()) {
6811 _ltc_input->nth (0)->connect (src);
6814 if ( ARDOUR::Profile->get_trx () ) {
6815 // Tracks need this signal to update timecode_source_dropdown
6816 MtcOrLtcInputPortChanged (); //emit signal
6822 Session::reconnect_ltc_output ()
6826 string src = Config->get_ltc_output_port();
6828 _ltc_output->disconnect (this);
6830 if (src != _("None") && !src.empty()) {
6831 _ltc_output->nth (0)->connect (src);
6837 Session::set_range_selection (framepos_t start, framepos_t end)
6839 _range_selection = Evoral::Range<framepos_t> (start, end);
6840 #ifdef USE_TRACKS_CODE_FEATURES
6841 follow_playhead_priority ();
6846 Session::set_object_selection (framepos_t start, framepos_t end)
6848 _object_selection = Evoral::Range<framepos_t> (start, end);
6849 #ifdef USE_TRACKS_CODE_FEATURES
6850 follow_playhead_priority ();
6855 Session::clear_range_selection ()
6857 _range_selection = Evoral::Range<framepos_t> (-1,-1);
6858 #ifdef USE_TRACKS_CODE_FEATURES
6859 follow_playhead_priority ();
6864 Session::clear_object_selection ()
6866 _object_selection = Evoral::Range<framepos_t> (-1,-1);
6867 #ifdef USE_TRACKS_CODE_FEATURES
6868 follow_playhead_priority ();
6873 Session::auto_connect_route (boost::shared_ptr<Route> route, bool connect_inputs,
6874 const ChanCount& input_start,
6875 const ChanCount& output_start,
6876 const ChanCount& input_offset,
6877 const ChanCount& output_offset)
6879 Glib::Threads::Mutex::Lock lx (_auto_connect_queue_lock);
6880 _auto_connect_queue.push (AutoConnectRequest (route, connect_inputs,
6881 input_start, output_start,
6882 input_offset, output_offset));
6884 auto_connect_thread_wakeup ();
6888 Session::auto_connect_thread_wakeup ()
6890 if (pthread_mutex_trylock (&_auto_connect_mutex) == 0) {
6891 pthread_cond_signal (&_auto_connect_cond);
6892 pthread_mutex_unlock (&_auto_connect_mutex);
6897 Session::queue_latency_recompute ()
6899 g_atomic_int_inc (&_latency_recompute_pending);
6900 auto_connect_thread_wakeup ();
6904 Session::auto_connect (const AutoConnectRequest& ar)
6906 boost::shared_ptr<Route> route = ar.route.lock();
6908 if (!route) { return; }
6910 if (!IO::connecting_legal) {
6914 /* If both inputs and outputs are auto-connected to physical ports,
6915 * use the max of input and output offsets to ensure auto-connected
6916 * port numbers always match up (e.g. the first audio input and the
6917 * first audio output of the route will have the same physical
6918 * port number). Otherwise just use the lowest input or output
6922 const bool in_out_physical =
6923 (Config->get_input_auto_connect() & AutoConnectPhysical)
6924 && (Config->get_output_auto_connect() & AutoConnectPhysical)
6925 && ar.connect_inputs;
6927 const ChanCount in_offset = in_out_physical
6928 ? ChanCount::max(ar.input_offset, ar.output_offset)
6931 const ChanCount out_offset = in_out_physical
6932 ? ChanCount::max(ar.input_offset, ar.output_offset)
6935 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
6936 vector<string> physinputs;
6937 vector<string> physoutputs;
6940 /* for connecting track inputs we only want MIDI ports marked
6944 get_physical_ports (physinputs, physoutputs, *t, MidiPortMusic);
6946 if (!physinputs.empty() && ar.connect_inputs) {
6947 uint32_t nphysical_in = physinputs.size();
6949 for (uint32_t i = ar.input_start.get(*t); i < route->n_inputs().get(*t) && i < nphysical_in; ++i) {
6952 if (Config->get_input_auto_connect() & AutoConnectPhysical) {
6953 port = physinputs[(in_offset.get(*t) + i) % nphysical_in];
6956 if (!port.empty() && route->input()->connect (route->input()->ports().port(*t, i), port, this)) {
6962 if (!physoutputs.empty()) {
6963 uint32_t nphysical_out = physoutputs.size();
6964 for (uint32_t i = ar.output_start.get(*t); i < route->n_outputs().get(*t); ++i) {
6968 * do not create new connections if we reached the limit of physical outputs
6971 if (!(Config->get_output_auto_connect() & AutoConnectMaster) &&
6972 ARDOUR::Profile->get_trx () &&
6973 ar.output_offset.get(*t) == nphysical_out ) {
6977 if ((*t) == DataType::MIDI && (Config->get_output_auto_connect() & AutoConnectPhysical)) {
6978 port = physoutputs[(out_offset.get(*t) + i) % nphysical_out];
6979 } else if ((*t) == DataType::AUDIO && (Config->get_output_auto_connect() & AutoConnectMaster)) {
6980 /* master bus is audio only */
6981 if (_master_out && _master_out->n_inputs().get(*t) > 0) {
6982 port = _master_out->input()->ports().port(*t,
6983 i % _master_out->input()->n_ports().get(*t))->name();
6987 if (!port.empty() && route->output()->connect (route->output()->ports().port(*t, i), port, this)) {
6996 Session::auto_connect_thread_start ()
6998 if (_ac_thread_active) {
7002 while (!_auto_connect_queue.empty ()) {
7003 _auto_connect_queue.pop ();
7006 _ac_thread_active = true;
7007 if (pthread_create (&_auto_connect_thread, NULL, auto_connect_thread, this)) {
7008 _ac_thread_active = false;
7013 Session::auto_connect_thread_terminate ()
7015 if (!_ac_thread_active) {
7018 _ac_thread_active = false;
7021 Glib::Threads::Mutex::Lock lx (_auto_connect_queue_lock);
7022 while (!_auto_connect_queue.empty ()) {
7023 _auto_connect_queue.pop ();
7027 auto_connect_thread_wakeup ();
7030 pthread_join (_auto_connect_thread, &status);
7034 Session::auto_connect_thread (void *arg)
7036 Session *s = static_cast<Session *>(arg);
7037 s->auto_connect_thread_run ();
7043 Session::auto_connect_thread_run ()
7045 pthread_set_name (X_("autoconnect"));
7046 SessionEvent::create_per_thread_pool (X_("autoconnect"), 1024);
7047 PBD::notify_event_loops_about_thread_creation (pthread_self(), X_("autoconnect"), 1024);
7048 pthread_mutex_lock (&_auto_connect_mutex);
7049 while (_ac_thread_active) {
7051 if (!_auto_connect_queue.empty ()) {
7052 // Why would we need the process lock ??
7053 // A: if ports are added while we're connecting, the backend's iterator may be invalidated:
7054 // graph_order_callback() -> resort_routes() -> direct_feeds_according_to_reality () -> backend::connected_to()
7055 // All ardour-internal backends use a std::vector xxxAudioBackend::find_port()
7056 // We have control over those, but what does jack do?
7057 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
7059 Glib::Threads::Mutex::Lock lx (_auto_connect_queue_lock);
7060 while (!_auto_connect_queue.empty ()) {
7061 const AutoConnectRequest ar (_auto_connect_queue.front());
7062 _auto_connect_queue.pop ();
7069 if (!actively_recording ()) { // might not be needed,
7070 /* this is only used for updating plugin latencies, the
7071 * graph does not change. so it's safe in general.
7073 * .. update_latency_compensation () entails set_capture_offset()
7074 * which calls Diskstream::set_capture_offset () which
7075 * modifies the capture offset... which can be a proplem
7076 * in "prepare_to_stop"
7078 while (g_atomic_int_and (&_latency_recompute_pending, 0)) {
7079 update_latency_compensation ();
7083 AudioEngine::instance()->clear_pending_port_deletions ();
7085 pthread_cond_wait (&_auto_connect_cond, &_auto_connect_mutex);
7087 pthread_mutex_unlock (&_auto_connect_mutex);
7091 Session::cancel_all_solo ()
7095 get_stripables (sl);
7097 set_controls (stripable_list_to_control_list (sl, &Stripable::solo_control), 0.0, Controllable::NoGroup);
7098 clear_all_solo_state (routes.reader());