2 Copyright (C) 1999-2010 Paul Davis
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
26 #include <cstdio> /* sprintf(3) ... grrr */
32 #include <glibmm/threads.h>
33 #include <glibmm/miscutils.h>
34 #include <glibmm/fileutils.h>
36 #include <boost/algorithm/string/erase.hpp>
38 #include "pbd/basename.h"
39 #include "pbd/convert.h"
40 #include "pbd/convert.h"
41 #include "pbd/error.h"
42 #include "pbd/file_utils.h"
44 #include "pbd/pthread_utils.h"
45 #include "pbd/search_path.h"
46 #include "pbd/stacktrace.h"
47 #include "pbd/stl_delete.h"
48 #include "pbd/replace_all.h"
49 #include "pbd/unwind.h"
51 #include "ardour/amp.h"
52 #include "ardour/analyser.h"
53 #include "ardour/async_midi_port.h"
54 #include "ardour/audio_buffer.h"
55 #include "ardour/audio_diskstream.h"
56 #include "ardour/audio_port.h"
57 #include "ardour/audio_track.h"
58 #include "ardour/audioengine.h"
59 #include "ardour/audiofilesource.h"
60 #include "ardour/auditioner.h"
61 #include "ardour/boost_debug.h"
62 #include "ardour/buffer_manager.h"
63 #include "ardour/buffer_set.h"
64 #include "ardour/bundle.h"
65 #include "ardour/butler.h"
66 #include "ardour/click.h"
67 #include "ardour/control_protocol_manager.h"
68 #include "ardour/data_type.h"
69 #include "ardour/debug.h"
70 #include "ardour/directory_names.h"
71 #ifdef USE_TRACKS_CODE_FEATURES
72 #include "ardour/engine_state_controller.h"
74 #include "ardour/filename_extensions.h"
75 #include "ardour/gain_control.h"
76 #include "ardour/graph.h"
77 #include "ardour/luabindings.h"
78 #include "ardour/midiport_manager.h"
79 #include "ardour/scene_changer.h"
80 #include "ardour/midi_patch_manager.h"
81 #include "ardour/midi_track.h"
82 #include "ardour/midi_ui.h"
83 #include "ardour/operations.h"
84 #include "ardour/playlist.h"
85 #include "ardour/plugin.h"
86 #include "ardour/plugin_insert.h"
87 #include "ardour/process_thread.h"
88 #include "ardour/profile.h"
89 #include "ardour/rc_configuration.h"
90 #include "ardour/recent_sessions.h"
91 #include "ardour/region.h"
92 #include "ardour/region_factory.h"
93 #include "ardour/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 , _export_preroll (0)
218 , _export_latency (0)
219 , _pre_export_mmc_enabled (false)
220 , _name (snapshot_name)
222 , _send_qf_mtc (false)
223 , _pframes_since_last_mtc (0)
224 , session_midi_feedback (0)
226 , loop_changing (false)
228 , _session_dir (new SessionDirectory (fullpath))
229 , _current_snapshot_name (snapshot_name)
231 , state_was_pending (false)
232 , _state_of_the_state (StateOfTheState(CannotSave|InitialConnecting|Loading))
234 , _save_queued (false)
235 , _last_roll_location (0)
236 , _last_roll_or_reversal_location (0)
237 , _last_record_location (0)
238 , pending_locate_roll (false)
239 , pending_locate_frame (0)
240 , pending_locate_flush (false)
241 , pending_abort (false)
242 , pending_auto_loop (false)
243 , _mempool ("Session", 2097152)
244 , lua (lua_newstate (&PBD::ReallocPool::lalloc, &_mempool))
246 , _butler (new Butler (*this))
247 , _post_transport_work (0)
248 , cumulative_rf_motion (0)
250 , _locations (new Locations (*this))
251 , _ignore_skips_updates (false)
252 , _rt_thread_active (false)
253 , _rt_emit_pending (false)
254 , _ac_thread_active (false)
255 , _latency_recompute_pending (0)
257 , outbound_mtc_timecode_frame (0)
258 , next_quarter_frame_to_send (-1)
259 , _frames_per_timecode_frame (0)
260 , _frames_per_hour (0)
261 , _timecode_frames_per_hour (0)
262 , last_timecode_valid (false)
263 , last_timecode_when (0)
264 , _send_timecode_update (false)
276 , ltc_timecode_offset (0)
277 , ltc_timecode_negative_offset (false)
278 , midi_control_ui (0)
280 , _all_route_group (new RouteGroup (*this, "all"))
281 , routes (new RouteList)
282 , _adding_routes_in_progress (false)
283 , _reconnecting_routes_in_progress (false)
284 , _route_deletion_in_progress (false)
285 , destructive_index (0)
286 , _track_number_decimals(1)
287 , default_fade_steepness (0)
288 , default_fade_msecs (0)
289 , _total_free_4k_blocks (0)
290 , _total_free_4k_blocks_uncertain (false)
291 , no_questions_about_missing_files (false)
294 , _bundles (new BundleList)
295 , _bundle_xml_node (0)
299 , click_emphasis_data (0)
301 , click_emphasis_length (0)
302 , _clicks_cleared (0)
303 , _play_range (false)
304 , _range_selection (-1,-1)
305 , _object_selection (-1,-1)
307 , first_file_data_format_reset (true)
308 , first_file_header_format_reset (true)
309 , have_looped (false)
310 , _have_rec_enabled_track (false)
311 , _have_rec_disabled_track (true)
313 , _suspend_timecode_transmission (0)
314 , _speakers (new Speakers)
315 , ignore_route_processor_changes (false)
320 , _vca_manager (new VCAManager (*this))
324 created_with = string_compose ("%1 %2", PROGRAM_NAME, revision);
326 pthread_mutex_init (&_rt_emit_mutex, 0);
327 pthread_cond_init (&_rt_emit_cond, 0);
329 pthread_mutex_init (&_auto_connect_mutex, 0);
330 pthread_cond_init (&_auto_connect_cond, 0);
332 init_name_id_counter (1); // reset for new sessions, start at 1
333 VCA::set_next_vca_number (1); // reset for new sessions, start at 1
335 pre_engine_init (fullpath);
341 Stateful::loading_state_version = CURRENT_SESSION_FILE_VERSION;
343 #ifdef USE_TRACKS_CODE_FEATURES
344 sr = EngineStateController::instance()->get_current_sample_rate();
346 if (ensure_engine (sr, true)) {
348 throw SessionException (_("Cannot connect to audio/midi engine"));
351 // set samplerate for plugins added early
352 // e.g from templates or MB channelstrip
353 set_block_size (_engine.samples_per_cycle());
354 set_frame_rate (_engine.sample_rate());
356 if (create (mix_template, bus_profile)) {
358 throw SessionException (_("Session initialization failed"));
361 /* if a mix template was provided, then ::create() will
362 * have copied it into the session and we need to load it
363 * so that we have the state ready for ::set_state()
364 * after the engine is started.
366 * Note that we do NOT try to get the sample rate from
367 * the template at this time, though doing so would
368 * be easy if we decided this was an appropriate part
372 if (!mix_template.empty()) {
373 if (load_state (_current_snapshot_name)) {
374 throw SessionException (_("Failed to load template/snapshot state"));
376 store_recent_templates (mix_template);
379 /* load default session properties - if any */
384 if (load_state (_current_snapshot_name)) {
385 throw SessionException (_("Failed to load state"));
388 /* try to get sample rate from XML state so that we
389 * can influence the SR if we set up the audio
394 XMLProperty const * prop;
395 XMLNode const * root (state_tree->root());
396 if ((prop = root->property (X_("sample-rate"))) != 0) {
397 sr = atoi (prop->value());
401 if (ensure_engine (sr, false)) {
403 throw SessionException (_("Cannot connect to audio/midi engine"));
407 if (post_engine_init ()) {
409 throw SessionException (_("Cannot configure audio/midi engine with session parameters"));
412 store_recent_sessions (_name, _path);
414 bool was_dirty = dirty();
416 _state_of_the_state = StateOfTheState (_state_of_the_state & ~Dirty);
418 Config->ParameterChanged.connect_same_thread (*this, boost::bind (&Session::config_changed, this, _1, false));
419 config.ParameterChanged.connect_same_thread (*this, boost::bind (&Session::config_changed, this, _1, true));
422 DirtyChanged (); /* EMIT SIGNAL */
425 StartTimeChanged.connect_same_thread (*this, boost::bind (&Session::start_time_changed, this, _1));
426 EndTimeChanged.connect_same_thread (*this, boost::bind (&Session::end_time_changed, this, _1));
428 emit_thread_start ();
429 auto_connect_thread_start ();
431 /* hook us up to the engine since we are now completely constructed */
433 BootMessage (_("Connect to engine"));
435 _engine.set_session (this);
436 _engine.reset_timebase ();
438 #ifdef USE_TRACKS_CODE_FEATURES
440 EngineStateController::instance()->set_session(this);
443 if ( ARDOUR::Profile->get_trx () ) {
445 /* Waves Tracks: fill session with tracks basing on the amount of inputs.
446 * each available input must have corresponding track when session starts.
449 uint32_t how_many (0);
451 std::vector<std::string> inputs;
452 EngineStateController::instance()->get_physical_audio_inputs(inputs);
454 how_many = inputs.size();
456 list<boost::shared_ptr<AudioTrack> > tracks;
458 // Track names after driver
459 if (Config->get_tracks_auto_naming() == NameAfterDriver) {
460 string track_name = "";
461 for (std::vector<string>::size_type i = 0; i < inputs.size(); ++i) {
463 track_name = inputs[i];
464 replace_all (track_name, "system:capture", "");
466 list<boost::shared_ptr<AudioTrack> > single_track = new_audio_track (1, 1, Normal, 0, 1, track_name);
467 tracks.insert(tracks.begin(), single_track.front());
469 } else { // Default track names
470 tracks = new_audio_track (1, 1, Normal, 0, how_many, string());
473 if (tracks.size() != how_many) {
475 throw failed_constructor ();
484 BootMessage (_("Session loading complete"));
496 Session::next_name_id ()
498 return g_atomic_int_add (&_name_id_counter, 1);
502 Session::name_id_counter ()
504 return g_atomic_int_get (&_name_id_counter);
508 Session::init_name_id_counter (guint n)
510 g_atomic_int_set (&_name_id_counter, n);
514 Session::ensure_engine (uint32_t desired_sample_rate, bool isnew)
516 if (_engine.current_backend() == 0) {
517 /* backend is unknown ... */
518 boost::optional<int> r = AudioEngineSetupRequired (desired_sample_rate);
519 if (r.get_value_or (-1) != 0) {
522 } else if (!isnew && _engine.running() && _engine.sample_rate () == desired_sample_rate) {
524 } else if (_engine.setup_required()) {
525 /* backend is known, but setup is needed */
526 boost::optional<int> r = AudioEngineSetupRequired (desired_sample_rate);
527 if (r.get_value_or (-1) != 0) {
530 } else if (!_engine.running()) {
531 if (_engine.start()) {
536 /* at this point the engine should be running */
538 if (!_engine.running()) {
542 return immediately_post_engine ();
547 Session::immediately_post_engine ()
549 /* Do various initializations that should take place directly after we
550 * know that the engine is running, but before we either create a
551 * session or set state for an existing one.
554 if (how_many_dsp_threads () > 1) {
555 /* For now, only create the graph if we are using >1 DSP threads, as
556 it is a bit slower than the old code with 1 thread.
558 _process_graph.reset (new Graph (*this));
561 /* every time we reconnect, recompute worst case output latencies */
563 _engine.Running.connect_same_thread (*this, boost::bind (&Session::initialize_latencies, this));
565 if (synced_to_engine()) {
566 _engine.transport_stop ();
569 if (config.get_jack_time_master()) {
570 _engine.transport_locate (_transport_frame);
575 BootMessage (_("Set up LTC"));
577 BootMessage (_("Set up Click"));
579 BootMessage (_("Set up standard connections"));
583 catch (failed_constructor& err) {
587 /* TODO, connect in different thread. (PortRegisteredOrUnregistered may be in RT context)
589 _engine.PortRegisteredOrUnregistered.connect_same_thread (*this, boost::bind (&Session::setup_bundles, this));
597 vector<void*> debug_pointers;
599 /* if we got to here, leaving pending capture state around
603 remove_pending_capture_state ();
607 _state_of_the_state = StateOfTheState (CannotSave|Deletion);
609 /* stop autoconnecting */
610 auto_connect_thread_terminate ();
612 /* disconnect from any and all signals that we are connected to */
614 Port::PortSignalDrop (); /* EMIT SIGNAL */
617 /* shutdown control surface protocols while we still have ports
618 and the engine to move data to any devices.
621 ControlProtocolManager::instance().drop_protocols ();
623 MIDI::Name::MidiPatchManager::instance().remove_search_path(session_directory().midi_patch_path());
625 _engine.remove_session ();
627 #ifdef USE_TRACKS_CODE_FEATURES
628 EngineStateController::instance()->remove_session();
631 /* deregister all ports - there will be no process or any other
632 * callbacks from the engine any more.
635 Port::PortDrop (); /* EMIT SIGNAL */
639 /* clear history so that no references to objects are held any more */
643 /* clear state tree so that no references to objects are held any more */
648 // unregister all lua functions, drop held references (if any)
650 lua.do_command ("Session = nil");
658 lua.collect_garbage ();
660 /* reset dynamic state version back to default */
661 Stateful::loading_state_version = 0;
663 _butler->drop_references ();
667 delete _all_route_group;
669 DEBUG_TRACE (DEBUG::Destruction, "delete route groups\n");
670 for (list<RouteGroup *>::iterator i = _route_groups.begin(); i != _route_groups.end(); ++i) {
674 if (click_data != default_click) {
675 delete [] click_data;
678 if (click_emphasis_data != default_click_emphasis) {
679 delete [] click_emphasis_data;
684 /* need to remove auditioner before monitoring section
685 * otherwise it is re-connected */
688 /* drop references to routes held by the monitoring section
689 * specifically _monitor_out aux/listen references */
690 remove_monitor_section();
692 /* clear out any pending dead wood from RCU managed objects */
697 AudioDiskstream::free_working_buffers();
699 /* tell everyone who is still standing that we're about to die */
702 /* tell everyone to drop references and delete objects as we go */
704 DEBUG_TRACE (DEBUG::Destruction, "delete regions\n");
705 RegionFactory::delete_all_regions ();
707 /* Do this early so that VCAs no longer hold references to routes */
709 DEBUG_TRACE (DEBUG::Destruction, "delete vcas\n");
712 DEBUG_TRACE (DEBUG::Destruction, "delete routes\n");
714 /* reset these three references to special routes before we do the usual route delete thing */
716 _master_out.reset ();
717 _monitor_out.reset ();
720 RCUWriter<RouteList> writer (routes);
721 boost::shared_ptr<RouteList> r = writer.get_copy ();
723 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
724 DEBUG_TRACE(DEBUG::Destruction, string_compose ("Dropping for route %1 ; pre-ref = %2\n", (*i)->name(), (*i).use_count()));
725 (*i)->drop_references ();
729 /* writer goes out of scope and updates master */
734 DEBUG_TRACE (DEBUG::Destruction, "delete sources\n");
735 Glib::Threads::Mutex::Lock lm (source_lock);
736 for (SourceMap::iterator i = sources.begin(); i != sources.end(); ++i) {
737 DEBUG_TRACE(DEBUG::Destruction, string_compose ("Dropping for source %1 ; pre-ref = %2\n", i->second->name(), i->second.use_count()));
738 i->second->drop_references ();
744 /* not strictly necessary, but doing it here allows the shared_ptr debugging to work */
747 emit_thread_terminate ();
749 pthread_cond_destroy (&_rt_emit_cond);
750 pthread_mutex_destroy (&_rt_emit_mutex);
752 pthread_cond_destroy (&_auto_connect_cond);
753 pthread_mutex_destroy (&_auto_connect_mutex);
755 delete _scene_changer; _scene_changer = 0;
756 delete midi_control_ui; midi_control_ui = 0;
758 delete _mmc; _mmc = 0;
759 delete _midi_ports; _midi_ports = 0;
760 delete _locations; _locations = 0;
765 /* clear event queue, the session is gone, nobody is interested in
766 * those anymore, but they do leak memory if not removed
768 while (!immediate_events.empty ()) {
769 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
770 SessionEvent *ev = immediate_events.front ();
771 DEBUG_TRACE (DEBUG::SessionEvents, string_compose ("Drop event: %1\n", enum_2_string (ev->type)));
772 immediate_events.pop_front ();
776 case SessionEvent::AutoLoop:
777 case SessionEvent::AutoLoopDeclick:
778 case SessionEvent::Skip:
779 case SessionEvent::PunchIn:
780 case SessionEvent::PunchOut:
781 case SessionEvent::StopOnce:
782 case SessionEvent::RangeStop:
783 case SessionEvent::RangeLocate:
787 case SessionEvent::RealTimeOperation:
794 del = del && !_remove_event (ev);
801 DEBUG_TRACE (DEBUG::Destruction, "Session::destroy() done\n");
803 BOOST_SHOW_POINTERS ();
807 Session::setup_ltc ()
811 _ltc_input.reset (new IO (*this, X_("LTC In"), IO::Input));
812 _ltc_output.reset (new IO (*this, X_("LTC Out"), IO::Output));
814 if (state_tree && (child = find_named_node (*state_tree->root(), X_("LTC In"))) != 0) {
815 _ltc_input->set_state (*(child->children().front()), Stateful::loading_state_version);
818 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
819 _ltc_input->ensure_io (ChanCount (DataType::AUDIO, 1), true, this);
821 reconnect_ltc_input ();
824 if (state_tree && (child = find_named_node (*state_tree->root(), X_("LTC Out"))) != 0) {
825 _ltc_output->set_state (*(child->children().front()), Stateful::loading_state_version);
828 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
829 _ltc_output->ensure_io (ChanCount (DataType::AUDIO, 1), true, this);
831 reconnect_ltc_output ();
834 /* fix up names of LTC ports because we don't want the normal
835 * IO style of NAME/TYPE-{in,out}N
838 _ltc_input->nth (0)->set_name (X_("LTC-in"));
839 _ltc_output->nth (0)->set_name (X_("LTC-out"));
843 Session::setup_click ()
847 boost::shared_ptr<AutomationList> gl (new AutomationList (Evoral::Parameter (GainAutomation)));
848 boost::shared_ptr<GainControl> gain_control = boost::shared_ptr<GainControl> (new GainControl (*this, Evoral::Parameter(GainAutomation), gl));
850 _click_io.reset (new ClickIO (*this, X_("Click")));
851 _click_gain.reset (new Amp (*this, _("Fader"), gain_control, true));
852 _click_gain->activate ();
854 setup_click_state (state_tree->root());
856 setup_click_state (0);
861 Session::setup_click_state (const XMLNode* node)
863 const XMLNode* child = 0;
865 if (node && (child = find_named_node (*node, "Click")) != 0) {
867 /* existing state for Click */
870 if (Stateful::loading_state_version < 3000) {
871 c = _click_io->set_state_2X (*child->children().front(), Stateful::loading_state_version, false);
873 const XMLNodeList& children (child->children());
874 XMLNodeList::const_iterator i = children.begin();
875 if ((c = _click_io->set_state (**i, Stateful::loading_state_version)) == 0) {
877 if (i != children.end()) {
878 c = _click_gain->set_state (**i, Stateful::loading_state_version);
884 _clicking = Config->get_clicking ();
888 error << _("could not setup Click I/O") << endmsg;
895 /* default state for Click: dual-mono to first 2 physical outputs */
898 _engine.get_physical_outputs (DataType::AUDIO, outs);
900 for (uint32_t physport = 0; physport < 2; ++physport) {
901 if (outs.size() > physport) {
902 if (_click_io->add_port (outs[physport], this)) {
903 // relax, even though its an error
908 if (_click_io->n_ports () > ChanCount::ZERO) {
909 _clicking = Config->get_clicking ();
915 Session::setup_bundles ()
919 RCUWriter<BundleList> writer (_bundles);
920 boost::shared_ptr<BundleList> b = writer.get_copy ();
921 for (BundleList::iterator i = b->begin(); i != b->end();) {
922 if (boost::dynamic_pointer_cast<UserBundle>(*i)) {
930 vector<string> inputs[DataType::num_types];
931 vector<string> outputs[DataType::num_types];
932 for (uint32_t i = 0; i < DataType::num_types; ++i) {
933 _engine.get_physical_inputs (DataType (DataType::Symbol (i)), inputs[i]);
934 _engine.get_physical_outputs (DataType (DataType::Symbol (i)), outputs[i]);
937 /* Create a set of Bundle objects that map
938 to the physical I/O currently available. We create both
939 mono and stereo bundles, so that the common cases of mono
940 and stereo tracks get bundles to put in their mixer strip
941 in / out menus. There may be a nicer way of achieving that;
942 it doesn't really scale that well to higher channel counts
945 /* mono output bundles */
947 for (uint32_t np = 0; np < outputs[DataType::AUDIO].size(); ++np) {
949 std::string pn = _engine.get_pretty_name_by_name (outputs[DataType::AUDIO][np]);
951 snprintf (buf, sizeof (buf), _("out %s"), pn.c_str());
953 snprintf (buf, sizeof (buf), _("out %" PRIu32), np+1);
956 boost::shared_ptr<Bundle> c (new Bundle (buf, true));
957 c->add_channel (_("mono"), DataType::AUDIO);
958 c->set_port (0, outputs[DataType::AUDIO][np]);
960 add_bundle (c, false);
963 /* stereo output bundles */
965 for (uint32_t np = 0; np < outputs[DataType::AUDIO].size(); np += 2) {
966 if (np + 1 < outputs[DataType::AUDIO].size()) {
968 snprintf (buf, sizeof(buf), _("out %" PRIu32 "+%" PRIu32), np + 1, np + 2);
969 boost::shared_ptr<Bundle> c (new Bundle (buf, true));
970 c->add_channel (_("L"), DataType::AUDIO);
971 c->set_port (0, outputs[DataType::AUDIO][np]);
972 c->add_channel (_("R"), DataType::AUDIO);
973 c->set_port (1, outputs[DataType::AUDIO][np + 1]);
975 add_bundle (c, false);
979 /* mono input bundles */
981 for (uint32_t np = 0; np < inputs[DataType::AUDIO].size(); ++np) {
983 std::string pn = _engine.get_pretty_name_by_name (inputs[DataType::AUDIO][np]);
985 snprintf (buf, sizeof (buf), _("in %s"), pn.c_str());
987 snprintf (buf, sizeof (buf), _("in %" PRIu32), np+1);
990 boost::shared_ptr<Bundle> c (new Bundle (buf, false));
991 c->add_channel (_("mono"), DataType::AUDIO);
992 c->set_port (0, inputs[DataType::AUDIO][np]);
994 add_bundle (c, false);
997 /* stereo input bundles */
999 for (uint32_t np = 0; np < inputs[DataType::AUDIO].size(); np += 2) {
1000 if (np + 1 < inputs[DataType::AUDIO].size()) {
1002 snprintf (buf, sizeof(buf), _("in %" PRIu32 "+%" PRIu32), np + 1, np + 2);
1004 boost::shared_ptr<Bundle> c (new Bundle (buf, false));
1005 c->add_channel (_("L"), DataType::AUDIO);
1006 c->set_port (0, inputs[DataType::AUDIO][np]);
1007 c->add_channel (_("R"), DataType::AUDIO);
1008 c->set_port (1, inputs[DataType::AUDIO][np + 1]);
1010 add_bundle (c, false);
1014 /* MIDI input bundles */
1016 for (uint32_t np = 0; np < inputs[DataType::MIDI].size(); ++np) {
1017 string n = inputs[DataType::MIDI][np];
1018 std::string pn = _engine.get_pretty_name_by_name (n);
1022 boost::erase_first (n, X_("alsa_pcm:"));
1024 boost::shared_ptr<Bundle> c (new Bundle (n, false));
1025 c->add_channel ("", DataType::MIDI);
1026 c->set_port (0, inputs[DataType::MIDI][np]);
1027 add_bundle (c, false);
1030 /* MIDI output bundles */
1032 for (uint32_t np = 0; np < outputs[DataType::MIDI].size(); ++np) {
1033 string n = outputs[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, true));
1041 c->add_channel ("", DataType::MIDI);
1042 c->set_port (0, outputs[DataType::MIDI][np]);
1043 add_bundle (c, false);
1046 // we trust the backend to only calls us if there's a change
1047 BundleAddedOrRemoved (); /* EMIT SIGNAL */
1051 Session::auto_connect_master_bus ()
1053 if (!_master_out || !Config->get_auto_connect_standard_busses() || _monitor_out) {
1057 // Waves Tracks: Do not connect master bas for Tracks if AutoConnectMaster option is not set
1058 // In this case it means "Multi Out" output mode
1059 if (ARDOUR::Profile->get_trx() && !(Config->get_output_auto_connect() & AutoConnectMaster) ) {
1063 /* if requested auto-connect the outputs to the first N physical ports.
1066 uint32_t limit = _master_out->n_outputs().n_total();
1067 vector<string> outputs[DataType::num_types];
1069 for (uint32_t i = 0; i < DataType::num_types; ++i) {
1070 _engine.get_physical_outputs (DataType (DataType::Symbol (i)), outputs[i]);
1073 for (uint32_t n = 0; n < limit; ++n) {
1074 boost::shared_ptr<Port> p = _master_out->output()->nth (n);
1076 if (outputs[p->type()].size() > n) {
1077 connect_to = outputs[p->type()][n];
1080 if (!connect_to.empty() && p->connected_to (connect_to) == false) {
1081 if (_master_out->output()->connect (p, connect_to, this)) {
1082 error << string_compose (_("cannot connect master output %1 to %2"), n, connect_to)
1091 Session::remove_monitor_section ()
1093 if (!_monitor_out || Profile->get_trx()) {
1097 /* force reversion to Solo-In-Place */
1098 Config->set_solo_control_is_listen_control (false);
1100 /* if we are auditioning, cancel it ... this is a workaround
1101 to a problem (auditioning does not execute the process graph,
1102 which is needed to remove routes when using >1 core for processing)
1107 /* Hold process lock while doing this so that we don't hear bits and
1108 * pieces of audio as we work on each route.
1111 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
1113 /* Connect tracks to monitor section. Note that in an
1114 existing session, the internal sends will already exist, but we want the
1115 routes to notice that they connect to the control out specifically.
1119 boost::shared_ptr<RouteList> r = routes.reader ();
1120 PBD::Unwinder<bool> uw (ignore_route_processor_changes, true);
1122 for (RouteList::iterator x = r->begin(); x != r->end(); ++x) {
1124 if ((*x)->is_monitor()) {
1126 } else if ((*x)->is_master()) {
1129 (*x)->remove_aux_or_listen (_monitor_out);
1134 remove_route (_monitor_out);
1135 if (_state_of_the_state & Deletion) {
1139 auto_connect_master_bus ();
1142 auditioner->connect ();
1145 Config->ParameterChanged ("use-monitor-bus");
1149 Session::add_monitor_section ()
1153 if (_monitor_out || !_master_out || Profile->get_trx()) {
1157 boost::shared_ptr<Route> r (new Route (*this, _("Monitor"), PresentationInfo::MonitorOut, DataType::AUDIO));
1163 BOOST_MARK_ROUTE(r);
1166 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
1167 r->input()->ensure_io (_master_out->output()->n_ports(), false, this);
1168 r->output()->ensure_io (_master_out->output()->n_ports(), false, this);
1170 error << _("Cannot create monitor section. 'Monitor' Port name is not unique.") << endmsg;
1175 add_routes (rl, false, false, false, 0);
1177 assert (_monitor_out);
1179 /* AUDIO ONLY as of june 29th 2009, because listen semantics for anything else
1180 are undefined, at best.
1183 uint32_t limit = _monitor_out->n_inputs().n_audio();
1187 /* connect the inputs to the master bus outputs. this
1188 * represents a separate data feed from the internal sends from
1189 * each route. as of jan 2011, it allows the monitor section to
1190 * conditionally ignore either the internal sends or the normal
1191 * input feed, but we should really find a better way to do
1195 _master_out->output()->disconnect (this);
1197 for (uint32_t n = 0; n < limit; ++n) {
1198 boost::shared_ptr<AudioPort> p = _monitor_out->input()->ports().nth_audio_port (n);
1199 boost::shared_ptr<AudioPort> o = _master_out->output()->ports().nth_audio_port (n);
1202 string connect_to = o->name();
1203 if (_monitor_out->input()->connect (p, connect_to, this)) {
1204 error << string_compose (_("cannot connect control input %1 to %2"), n, connect_to)
1212 /* if monitor section is not connected, connect it to physical outs
1215 if ((Config->get_auto_connect_standard_busses () || Profile->get_mixbus ()) && !_monitor_out->output()->connected ()) {
1217 if (!Config->get_monitor_bus_preferred_bundle().empty()) {
1219 boost::shared_ptr<Bundle> b = bundle_by_name (Config->get_monitor_bus_preferred_bundle());
1222 _monitor_out->output()->connect_ports_to_bundle (b, true, this);
1224 warning << string_compose (_("The preferred I/O for the monitor bus (%1) cannot be found"),
1225 Config->get_monitor_bus_preferred_bundle())
1231 /* Monitor bus is audio only */
1233 vector<string> outputs[DataType::num_types];
1235 for (uint32_t i = 0; i < DataType::num_types; ++i) {
1236 _engine.get_physical_outputs (DataType (DataType::Symbol (i)), outputs[i]);
1239 uint32_t mod = outputs[DataType::AUDIO].size();
1240 uint32_t limit = _monitor_out->n_outputs().get (DataType::AUDIO);
1244 for (uint32_t n = 0; n < limit; ++n) {
1246 boost::shared_ptr<Port> p = _monitor_out->output()->ports().port(DataType::AUDIO, n);
1248 if (outputs[DataType::AUDIO].size() > (n % mod)) {
1249 connect_to = outputs[DataType::AUDIO][n % mod];
1252 if (!connect_to.empty()) {
1253 if (_monitor_out->output()->connect (p, connect_to, this)) {
1254 error << string_compose (
1255 _("cannot connect control output %1 to %2"),
1266 /* Hold process lock while doing this so that we don't hear bits and
1267 * pieces of audio as we work on each route.
1270 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
1272 /* Connect tracks to monitor section. Note that in an
1273 existing session, the internal sends will already exist, but we want the
1274 routes to notice that they connect to the control out specifically.
1278 boost::shared_ptr<RouteList> rls = routes.reader ();
1280 PBD::Unwinder<bool> uw (ignore_route_processor_changes, true);
1282 for (RouteList::iterator x = rls->begin(); x != rls->end(); ++x) {
1284 if ((*x)->is_monitor()) {
1286 } else if ((*x)->is_master()) {
1289 (*x)->enable_monitor_send ();
1294 auditioner->connect ();
1296 Config->ParameterChanged ("use-monitor-bus");
1300 Session::reset_monitor_section ()
1302 /* Process lock should be held by the caller.*/
1304 if (!_monitor_out || Profile->get_trx()) {
1308 uint32_t limit = _master_out->n_outputs().n_audio();
1310 /* connect the inputs to the master bus outputs. this
1311 * represents a separate data feed from the internal sends from
1312 * each route. as of jan 2011, it allows the monitor section to
1313 * conditionally ignore either the internal sends or the normal
1314 * input feed, but we should really find a better way to do
1318 _master_out->output()->disconnect (this);
1319 _monitor_out->output()->disconnect (this);
1321 // monitor section follow master bus - except midi
1322 ChanCount mon_chn (_master_out->output()->n_ports());
1323 mon_chn.set_midi (0);
1325 _monitor_out->input()->ensure_io (mon_chn, false, this);
1326 _monitor_out->output()->ensure_io (mon_chn, false, this);
1328 for (uint32_t n = 0; n < limit; ++n) {
1329 boost::shared_ptr<AudioPort> p = _monitor_out->input()->ports().nth_audio_port (n);
1330 boost::shared_ptr<AudioPort> o = _master_out->output()->ports().nth_audio_port (n);
1333 string connect_to = o->name();
1334 if (_monitor_out->input()->connect (p, connect_to, this)) {
1335 error << string_compose (_("cannot connect control input %1 to %2"), n, connect_to)
1342 /* connect monitor section to physical outs
1345 if (Config->get_auto_connect_standard_busses()) {
1347 if (!Config->get_monitor_bus_preferred_bundle().empty()) {
1349 boost::shared_ptr<Bundle> b = bundle_by_name (Config->get_monitor_bus_preferred_bundle());
1352 _monitor_out->output()->connect_ports_to_bundle (b, true, this);
1354 warning << string_compose (_("The preferred I/O for the monitor bus (%1) cannot be found"),
1355 Config->get_monitor_bus_preferred_bundle())
1361 /* Monitor bus is audio only */
1363 vector<string> outputs[DataType::num_types];
1365 for (uint32_t i = 0; i < DataType::num_types; ++i) {
1366 _engine.get_physical_outputs (DataType (DataType::Symbol (i)), outputs[i]);
1369 uint32_t mod = outputs[DataType::AUDIO].size();
1370 uint32_t limit = _monitor_out->n_outputs().get (DataType::AUDIO);
1374 for (uint32_t n = 0; n < limit; ++n) {
1376 boost::shared_ptr<Port> p = _monitor_out->output()->ports().port(DataType::AUDIO, n);
1378 if (outputs[DataType::AUDIO].size() > (n % mod)) {
1379 connect_to = outputs[DataType::AUDIO][n % mod];
1382 if (!connect_to.empty()) {
1383 if (_monitor_out->output()->connect (p, connect_to, this)) {
1384 error << string_compose (
1385 _("cannot connect control output %1 to %2"),
1396 /* Connect tracks to monitor section. Note that in an
1397 existing session, the internal sends will already exist, but we want the
1398 routes to notice that they connect to the control out specifically.
1402 boost::shared_ptr<RouteList> rls = routes.reader ();
1404 PBD::Unwinder<bool> uw (ignore_route_processor_changes, true);
1406 for (RouteList::iterator x = rls->begin(); x != rls->end(); ++x) {
1408 if ((*x)->is_monitor()) {
1410 } else if ((*x)->is_master()) {
1413 (*x)->enable_monitor_send ();
1419 Session::hookup_io ()
1421 /* stop graph reordering notifications from
1422 causing resorts, etc.
1425 _state_of_the_state = StateOfTheState (_state_of_the_state | InitialConnecting);
1429 /* we delay creating the auditioner till now because
1430 it makes its own connections to ports.
1434 boost::shared_ptr<Auditioner> a (new Auditioner (*this));
1436 throw failed_constructor ();
1438 a->use_new_diskstream ();
1442 catch (failed_constructor& err) {
1443 warning << _("cannot create Auditioner: no auditioning of regions possible") << endmsg;
1447 /* load bundles, which we may have postponed earlier on */
1448 if (_bundle_xml_node) {
1449 load_bundles (*_bundle_xml_node);
1450 delete _bundle_xml_node;
1453 /* Tell all IO objects to connect themselves together */
1455 IO::enable_connecting ();
1457 /* Now tell all "floating" ports to connect to whatever
1458 they should be connected to.
1461 AudioEngine::instance()->reconnect_ports ();
1463 /* Anyone who cares about input state, wake up and do something */
1465 IOConnectionsComplete (); /* EMIT SIGNAL */
1467 _state_of_the_state = StateOfTheState (_state_of_the_state & ~InitialConnecting);
1469 /* now handle the whole enchilada as if it was one
1470 graph reorder event.
1475 /* update the full solo state, which can't be
1476 correctly determined on a per-route basis, but
1477 needs the global overview that only the session
1481 update_route_solo_state ();
1485 Session::track_playlist_changed (boost::weak_ptr<Track> wp)
1487 boost::shared_ptr<Track> track = wp.lock ();
1492 boost::shared_ptr<Playlist> playlist;
1494 if ((playlist = track->playlist()) != 0) {
1495 playlist->RegionAdded.connect_same_thread (*this, boost::bind (&Session::playlist_region_added, this, _1));
1496 playlist->RangesMoved.connect_same_thread (*this, boost::bind (&Session::playlist_ranges_moved, this, _1));
1497 playlist->RegionsExtended.connect_same_thread (*this, boost::bind (&Session::playlist_regions_extended, this, _1));
1502 Session::record_enabling_legal () const
1504 /* this used to be in here, but survey says.... we don't need to restrict it */
1505 // if (record_status() == Recording) {
1509 if (Config->get_all_safe()) {
1516 Session::set_track_monitor_input_status (bool yn)
1518 boost::shared_ptr<RouteList> rl = routes.reader ();
1519 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
1520 boost::shared_ptr<AudioTrack> tr = boost::dynamic_pointer_cast<AudioTrack> (*i);
1521 if (tr && tr->rec_enable_control()->get_value()) {
1522 //cerr << "switching to input = " << !auto_input << __FILE__ << __LINE__ << endl << endl;
1523 tr->request_input_monitoring (yn);
1529 Session::auto_punch_start_changed (Location* location)
1531 replace_event (SessionEvent::PunchIn, location->start());
1533 if (get_record_enabled() && config.get_punch_in()) {
1534 /* capture start has been changed, so save new pending state */
1535 save_state ("", true);
1540 Session::auto_punch_end_changed (Location* location)
1542 framepos_t when_to_stop = location->end();
1543 // when_to_stop += _worst_output_latency + _worst_input_latency;
1544 replace_event (SessionEvent::PunchOut, when_to_stop);
1548 Session::auto_punch_changed (Location* location)
1550 framepos_t when_to_stop = location->end();
1552 replace_event (SessionEvent::PunchIn, location->start());
1553 //when_to_stop += _worst_output_latency + _worst_input_latency;
1554 replace_event (SessionEvent::PunchOut, when_to_stop);
1557 /** @param loc A loop location.
1558 * @param pos Filled in with the start time of the required fade-out (in session frames).
1559 * @param length Filled in with the length of the required fade-out.
1562 Session::auto_loop_declick_range (Location* loc, framepos_t & pos, framepos_t & length)
1564 pos = max (loc->start(), loc->end() - 64);
1565 length = loc->end() - pos;
1569 Session::auto_loop_changed (Location* location)
1571 replace_event (SessionEvent::AutoLoop, location->end(), location->start());
1574 auto_loop_declick_range (location, dcp, dcl);
1576 if (transport_rolling() && play_loop) {
1578 replace_event (SessionEvent::AutoLoopDeclick, dcp, dcl);
1580 // if (_transport_frame > location->end()) {
1582 if (_transport_frame < location->start() || _transport_frame > location->end()) {
1583 // relocate to beginning of loop
1584 clear_events (SessionEvent::LocateRoll);
1586 request_locate (location->start(), true);
1589 else if (Config->get_seamless_loop() && !loop_changing) {
1591 // schedule a locate-roll to refill the diskstreams at the
1592 // previous loop end
1593 loop_changing = true;
1595 if (location->end() > last_loopend) {
1596 clear_events (SessionEvent::LocateRoll);
1597 SessionEvent *ev = new SessionEvent (SessionEvent::LocateRoll, SessionEvent::Add, last_loopend, last_loopend, 0, true);
1603 clear_events (SessionEvent::AutoLoopDeclick);
1604 clear_events (SessionEvent::AutoLoop);
1607 /* possibly move playhead if not rolling; if we are rolling we'll move
1608 to the loop start on stop if that is appropriate.
1613 if (!transport_rolling() && select_playhead_priority_target (pos)) {
1614 if (pos == location->start()) {
1615 request_locate (pos);
1620 last_loopend = location->end();
1625 Session::set_auto_punch_location (Location* location)
1629 if ((existing = _locations->auto_punch_location()) != 0 && existing != location) {
1630 punch_connections.drop_connections();
1631 existing->set_auto_punch (false, this);
1632 remove_event (existing->start(), SessionEvent::PunchIn);
1633 clear_events (SessionEvent::PunchOut);
1634 auto_punch_location_changed (0);
1639 if (location == 0) {
1643 if (location->end() <= location->start()) {
1644 error << _("Session: you can't use that location for auto punch (start <= end)") << endmsg;
1648 punch_connections.drop_connections ();
1650 location->StartChanged.connect_same_thread (punch_connections, boost::bind (&Session::auto_punch_start_changed, this, location));
1651 location->EndChanged.connect_same_thread (punch_connections, boost::bind (&Session::auto_punch_end_changed, this, location));
1652 location->Changed.connect_same_thread (punch_connections, boost::bind (&Session::auto_punch_changed, this, location));
1654 location->set_auto_punch (true, this);
1656 auto_punch_changed (location);
1658 auto_punch_location_changed (location);
1662 Session::set_session_extents (framepos_t start, framepos_t end)
1665 if ((existing = _locations->session_range_location()) == 0) {
1666 //if there is no existing session, we need to make a new session location (should never happen)
1667 existing = new Location (*this, 0, 0, _("session"), Location::IsSessionRange);
1671 error << _("Session: you can't use that location for session start/end)") << endmsg;
1675 existing->set( start, end );
1681 Session::set_auto_loop_location (Location* location)
1685 if ((existing = _locations->auto_loop_location()) != 0 && existing != location) {
1686 loop_connections.drop_connections ();
1687 existing->set_auto_loop (false, this);
1688 remove_event (existing->end(), SessionEvent::AutoLoop);
1691 auto_loop_declick_range (existing, dcp, dcl);
1692 remove_event (dcp, SessionEvent::AutoLoopDeclick);
1693 auto_loop_location_changed (0);
1698 if (location == 0) {
1702 if (location->end() <= location->start()) {
1703 error << _("You cannot use this location for auto-loop because it has zero or negative length") << endmsg;
1707 last_loopend = location->end();
1709 loop_connections.drop_connections ();
1711 location->StartChanged.connect_same_thread (loop_connections, boost::bind (&Session::auto_loop_changed, this, location));
1712 location->EndChanged.connect_same_thread (loop_connections, boost::bind (&Session::auto_loop_changed, this, location));
1713 location->Changed.connect_same_thread (loop_connections, boost::bind (&Session::auto_loop_changed, this, location));
1714 location->FlagsChanged.connect_same_thread (loop_connections, boost::bind (&Session::auto_loop_changed, this, location));
1716 location->set_auto_loop (true, this);
1718 if (Config->get_loop_is_mode() && play_loop && Config->get_seamless_loop()) {
1719 // set all tracks to use internal looping
1720 boost::shared_ptr<RouteList> rl = routes.reader ();
1721 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
1722 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
1723 if (tr && !tr->hidden()) {
1724 tr->set_loop (location);
1729 /* take care of our stuff first */
1731 auto_loop_changed (location);
1733 /* now tell everyone else */
1735 auto_loop_location_changed (location);
1739 Session::update_marks (Location*)
1745 Session::update_skips (Location* loc, bool consolidate)
1747 if (_ignore_skips_updates) {
1751 Locations::LocationList skips;
1754 PBD::Unwinder<bool> uw (_ignore_skips_updates, true);
1755 consolidate_skips (loc);
1758 sync_locations_to_skips ();
1764 Session::consolidate_skips (Location* loc)
1766 Locations::LocationList all_locations = _locations->list ();
1768 for (Locations::LocationList::iterator l = all_locations.begin(); l != all_locations.end(); ) {
1770 if (!(*l)->is_skip ()) {
1775 /* don't test against self */
1782 switch (Evoral::coverage ((*l)->start(), (*l)->end(), loc->start(), loc->end())) {
1783 case Evoral::OverlapInternal:
1784 case Evoral::OverlapExternal:
1785 case Evoral::OverlapStart:
1786 case Evoral::OverlapEnd:
1787 /* adjust new location to cover existing one */
1788 loc->set_start (min (loc->start(), (*l)->start()));
1789 loc->set_end (max (loc->end(), (*l)->end()));
1790 /* we don't need this one any more */
1791 _locations->remove (*l);
1792 /* the location has been deleted, so remove reference to it in our local list */
1793 l = all_locations.erase (l);
1796 case Evoral::OverlapNone:
1804 Session::sync_locations_to_skips ()
1806 /* This happens asynchronously (in the audioengine thread). After the clear is done, we will call
1807 * Session::_sync_locations_to_skips() from the audioengine thread.
1809 clear_events (SessionEvent::Skip, boost::bind (&Session::_sync_locations_to_skips, this));
1813 Session::_sync_locations_to_skips ()
1815 /* called as a callback after existing Skip events have been cleared from a realtime audioengine thread */
1817 Locations::LocationList const & locs (_locations->list());
1819 for (Locations::LocationList::const_iterator i = locs.begin(); i != locs.end(); ++i) {
1821 Location* location = *i;
1823 if (location->is_skip() && location->is_skipping()) {
1824 SessionEvent* ev = new SessionEvent (SessionEvent::Skip, SessionEvent::Add, location->start(), location->end(), 1.0);
1832 Session::location_added (Location *location)
1834 if (location->is_auto_punch()) {
1835 set_auto_punch_location (location);
1838 if (location->is_auto_loop()) {
1839 set_auto_loop_location (location);
1842 if (location->is_session_range()) {
1843 /* no need for any signal handling or event setting with the session range,
1844 because we keep a direct reference to it and use its start/end directly.
1846 _session_range_location = location;
1849 if (location->is_mark()) {
1850 /* listen for per-location signals that require us to do any * global updates for marks */
1852 location->StartChanged.connect_same_thread (skip_update_connections, boost::bind (&Session::update_marks, this, location));
1853 location->EndChanged.connect_same_thread (skip_update_connections, boost::bind (&Session::update_marks, this, location));
1854 location->Changed.connect_same_thread (skip_update_connections, boost::bind (&Session::update_marks, this, location));
1855 location->FlagsChanged.connect_same_thread (skip_update_connections, boost::bind (&Session::update_marks, this, location));
1858 if (location->is_skip()) {
1859 /* listen for per-location signals that require us to update skip-locate events */
1861 location->StartChanged.connect_same_thread (skip_update_connections, boost::bind (&Session::update_skips, this, location, true));
1862 location->EndChanged.connect_same_thread (skip_update_connections, boost::bind (&Session::update_skips, this, location, true));
1863 location->Changed.connect_same_thread (skip_update_connections, boost::bind (&Session::update_skips, this, location, true));
1864 location->FlagsChanged.connect_same_thread (skip_update_connections, boost::bind (&Session::update_skips, this, location, false));
1866 update_skips (location, true);
1873 Session::location_removed (Location *location)
1875 if (location->is_auto_loop()) {
1876 set_auto_loop_location (0);
1877 set_track_loop (false);
1880 if (location->is_auto_punch()) {
1881 set_auto_punch_location (0);
1884 if (location->is_session_range()) {
1885 /* this is never supposed to happen */
1886 error << _("programming error: session range removed!") << endl;
1889 if (location->is_skip()) {
1891 update_skips (location, false);
1898 Session::locations_changed ()
1900 _locations->apply (*this, &Session::_locations_changed);
1904 Session::_locations_changed (const Locations::LocationList& locations)
1906 /* There was some mass-change in the Locations object.
1908 We might be re-adding a location here but it doesn't actually matter
1909 for all the locations that the Session takes an interest in.
1913 PBD::Unwinder<bool> protect_ignore_skip_updates (_ignore_skips_updates, true);
1914 for (Locations::LocationList::const_iterator i = locations.begin(); i != locations.end(); ++i) {
1915 location_added (*i);
1919 update_skips (NULL, false);
1923 Session::enable_record ()
1925 if (_transport_speed != 0.0 && _transport_speed != 1.0) {
1926 /* no recording at anything except normal speed */
1931 RecordState rs = (RecordState) g_atomic_int_get (&_record_status);
1933 if (rs == Recording) {
1937 if (g_atomic_int_compare_and_exchange (&_record_status, rs, Recording)) {
1939 _last_record_location = _transport_frame;
1940 send_immediate_mmc (MIDI::MachineControlCommand (MIDI::MachineControl::cmdRecordStrobe));
1942 if (Config->get_monitoring_model() == HardwareMonitoring && config.get_auto_input()) {
1943 set_track_monitor_input_status (true);
1946 RecordStateChanged ();
1953 Session::set_all_tracks_record_enabled (bool enable )
1955 boost::shared_ptr<RouteList> rl = routes.reader();
1956 set_controls (route_list_to_control_list (rl, &Stripable::rec_enable_control), enable, Controllable::NoGroup);
1960 Session::disable_record (bool rt_context, bool force)
1964 if ((rs = (RecordState) g_atomic_int_get (&_record_status)) != Disabled) {
1966 if (!Config->get_latched_record_enable () || force) {
1967 g_atomic_int_set (&_record_status, Disabled);
1968 send_immediate_mmc (MIDI::MachineControlCommand (MIDI::MachineControl::cmdRecordExit));
1970 if (rs == Recording) {
1971 g_atomic_int_set (&_record_status, Enabled);
1975 if (Config->get_monitoring_model() == HardwareMonitoring && config.get_auto_input()) {
1976 set_track_monitor_input_status (false);
1979 RecordStateChanged (); /* emit signal */
1982 remove_pending_capture_state ();
1988 Session::step_back_from_record ()
1990 if (g_atomic_int_compare_and_exchange (&_record_status, Recording, Enabled)) {
1992 if (Config->get_monitoring_model() == HardwareMonitoring && config.get_auto_input()) {
1993 set_track_monitor_input_status (false);
1996 RecordStateChanged (); /* emit signal */
2001 Session::maybe_enable_record ()
2003 if (_step_editors > 0) {
2007 g_atomic_int_set (&_record_status, Enabled);
2009 /* This function is currently called from somewhere other than an RT thread.
2010 This save_state() call therefore doesn't impact anything. Doing it here
2011 means that we save pending state of which sources the next record will use,
2012 which gives us some chance of recovering from a crash during the record.
2015 save_state ("", true);
2017 if (_transport_speed) {
2018 if (!config.get_punch_in()) {
2022 send_immediate_mmc (MIDI::MachineControlCommand (MIDI::MachineControl::cmdRecordPause));
2023 RecordStateChanged (); /* EMIT SIGNAL */
2030 Session::audible_frame () const
2034 frameoffset_t offset = worst_playback_latency (); // - _engine.samples_since_cycle_start ();
2035 offset *= transport_speed ();
2037 if (synced_to_engine()) {
2038 /* Note: this is basically just sync-to-JACK */
2039 ret = _engine.transport_frame();
2041 ret = _transport_frame;
2044 if (transport_rolling()) {
2047 /* Check to see if we have passed the first guaranteed
2048 * audible frame past our last start position. if not,
2049 * return that last start point because in terms
2050 * of audible frames, we have not moved yet.
2052 * `Start position' in this context means the time we last
2053 * either started, located, or changed transport direction.
2056 if (_transport_speed > 0.0f) {
2058 if (!play_loop || !have_looped) {
2059 if (ret < _last_roll_or_reversal_location) {
2060 return _last_roll_or_reversal_location;
2064 Location *location = _locations->auto_loop_location();
2065 frameoffset_t lo = location->start() - ret;
2067 ret = location->end () - lo;
2071 } else if (_transport_speed < 0.0f) {
2073 /* XXX wot? no backward looping? */
2075 if (ret > _last_roll_or_reversal_location) {
2076 return _last_roll_or_reversal_location;
2081 return std::max ((framepos_t)0, ret);
2085 Session::set_frame_rate (framecnt_t frames_per_second)
2087 /** \fn void Session::set_frame_size(framecnt_t)
2088 the AudioEngine object that calls this guarantees
2089 that it will not be called while we are also in
2090 ::process(). Its fine to do things that block
2094 if (_base_frame_rate == 0) {
2095 _base_frame_rate = frames_per_second;
2097 else if (_base_frame_rate != frames_per_second && frames_per_second != _nominal_frame_rate) {
2098 NotifyAboutSampleRateMismatch (_base_frame_rate, frames_per_second);
2100 _nominal_frame_rate = frames_per_second;
2105 reset_write_sources (false);
2107 // XXX we need some equivalent to this, somehow
2108 // SndFileSource::setup_standard_crossfades (frames_per_second);
2112 /* XXX need to reset/reinstantiate all LADSPA plugins */
2116 Session::set_block_size (pframes_t nframes)
2118 /* the AudioEngine guarantees
2119 that it will not be called while we are also in
2120 ::process(). It is therefore fine to do things that block
2125 current_block_size = nframes;
2129 boost::shared_ptr<RouteList> r = routes.reader ();
2131 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
2132 (*i)->set_block_size (nframes);
2135 boost::shared_ptr<RouteList> rl = routes.reader ();
2136 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
2137 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
2139 tr->set_block_size (nframes);
2143 set_worst_io_latencies ();
2149 trace_terminal (boost::shared_ptr<Route> r1, boost::shared_ptr<Route> rbase)
2151 boost::shared_ptr<Route> r2;
2153 if (r1->feeds (rbase) && rbase->feeds (r1)) {
2154 info << string_compose(_("feedback loop setup between %1 and %2"), r1->name(), rbase->name()) << endmsg;
2158 /* make a copy of the existing list of routes that feed r1 */
2160 Route::FedBy existing (r1->fed_by());
2162 /* for each route that feeds r1, recurse, marking it as feeding
2166 for (Route::FedBy::iterator i = existing.begin(); i != existing.end(); ++i) {
2167 if (!(r2 = i->r.lock ())) {
2168 /* (*i) went away, ignore it */
2172 /* r2 is a route that feeds r1 which somehow feeds base. mark
2173 base as being fed by r2
2176 rbase->add_fed_by (r2, i->sends_only);
2180 /* 2nd level feedback loop detection. if r1 feeds or is fed by r2,
2184 if (r1->feeds (r2) && r2->feeds (r1)) {
2188 /* now recurse, so that we can mark base as being fed by
2189 all routes that feed r2
2192 trace_terminal (r2, rbase);
2199 Session::resort_routes ()
2201 /* don't do anything here with signals emitted
2202 by Routes during initial setup or while we
2203 are being destroyed.
2206 if (_state_of_the_state & (InitialConnecting | Deletion)) {
2210 if (_route_deletion_in_progress) {
2215 RCUWriter<RouteList> writer (routes);
2216 boost::shared_ptr<RouteList> r = writer.get_copy ();
2217 resort_routes_using (r);
2218 /* writer goes out of scope and forces update */
2222 if (DEBUG_ENABLED(DEBUG::Graph)) {
2223 boost::shared_ptr<RouteList> rl = routes.reader ();
2224 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
2225 DEBUG_TRACE (DEBUG::Graph, string_compose ("%1 fed by ...\n", (*i)->name()));
2227 const Route::FedBy& fb ((*i)->fed_by());
2229 for (Route::FedBy::const_iterator f = fb.begin(); f != fb.end(); ++f) {
2230 boost::shared_ptr<Route> sf = f->r.lock();
2232 DEBUG_TRACE (DEBUG::Graph, string_compose ("\t%1 (sends only ? %2)\n", sf->name(), f->sends_only));
2241 /** This is called whenever we need to rebuild the graph of how we will process
2243 * @param r List of routes, in any order.
2247 Session::resort_routes_using (boost::shared_ptr<RouteList> r)
2249 /* We are going to build a directed graph of our routes;
2250 this is where the edges of that graph are put.
2255 /* Go through all routes doing two things:
2257 * 1. Collect the edges of the route graph. Each of these edges
2258 * is a pair of routes, one of which directly feeds the other
2259 * either by a JACK connection or by an internal send.
2261 * 2. Begin the process of making routes aware of which other
2262 * routes directly or indirectly feed them. This information
2263 * is used by the solo code.
2266 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
2268 /* Clear out the route's list of direct or indirect feeds */
2269 (*i)->clear_fed_by ();
2271 for (RouteList::iterator j = r->begin(); j != r->end(); ++j) {
2273 bool via_sends_only;
2275 /* See if this *j feeds *i according to the current state of the JACK
2276 connections and internal sends.
2278 if ((*j)->direct_feeds_according_to_reality (*i, &via_sends_only)) {
2279 /* add the edge to the graph (part #1) */
2280 edges.add (*j, *i, via_sends_only);
2281 /* tell the route (for part #2) */
2282 (*i)->add_fed_by (*j, via_sends_only);
2287 /* Attempt a topological sort of the route graph */
2288 boost::shared_ptr<RouteList> sorted_routes = topological_sort (r, edges);
2290 if (sorted_routes) {
2291 /* We got a satisfactory topological sort, so there is no feedback;
2294 Note: the process graph rechain does not require a
2295 topologically-sorted list, but hey ho.
2297 if (_process_graph) {
2298 _process_graph->rechain (sorted_routes, edges);
2301 _current_route_graph = edges;
2303 /* Complete the building of the routes' lists of what directly
2304 or indirectly feeds them.
2306 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
2307 trace_terminal (*i, *i);
2310 *r = *sorted_routes;
2313 DEBUG_TRACE (DEBUG::Graph, "Routes resorted, order follows:\n");
2314 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
2315 DEBUG_TRACE (DEBUG::Graph, string_compose ("\t%1 presentation order %2\n", (*i)->name(), (*i)->presentation_info().order()));
2319 SuccessfulGraphSort (); /* EMIT SIGNAL */
2322 /* The topological sort failed, so we have a problem. Tell everyone
2323 and stick to the old graph; this will continue to be processed, so
2324 until the feedback is fixed, what is played back will not quite
2325 reflect what is actually connected. Note also that we do not
2326 do trace_terminal here, as it would fail due to an endless recursion,
2327 so the solo code will think that everything is still connected
2331 FeedbackDetected (); /* EMIT SIGNAL */
2336 /** Find a route name starting with \a base, maybe followed by the
2337 * lowest \a id. \a id will always be added if \a definitely_add_number
2338 * is true on entry; otherwise it will only be added if required
2339 * to make the name unique.
2341 * Names are constructed like e.g. "Audio 3" for base="Audio" and id=3.
2342 * The available route name with the lowest ID will be used, and \a id
2343 * will be set to the ID.
2345 * \return false if a route name could not be found, and \a track_name
2346 * and \a id do not reflect a free route name.
2349 Session::find_route_name (string const & base, uint32_t& id, string& name, bool definitely_add_number)
2351 /* the base may conflict with ports that do not belong to existing
2352 routes, but hidden objects like the click track. So check port names
2353 before anything else.
2356 for (vector<string>::const_iterator reserved = reserved_io_names.begin(); reserved != reserved_io_names.end(); ++reserved) {
2357 if (base == *reserved) {
2358 /* Check if this reserved name already exists, and if
2359 so, disallow it without a numeric suffix.
2361 if (route_by_name (*reserved)) {
2362 definitely_add_number = true;
2371 if (!definitely_add_number && route_by_name (base) == 0) {
2372 /* juse use the base */
2378 name = string_compose ("%1 %2", base, id);
2380 if (route_by_name (name) == 0) {
2386 } while (id < (UINT_MAX-1));
2391 /** Count the total ins and outs of all non-hidden tracks in the session and return them in in and out */
2393 Session::count_existing_track_channels (ChanCount& in, ChanCount& out)
2395 in = ChanCount::ZERO;
2396 out = ChanCount::ZERO;
2398 boost::shared_ptr<RouteList> r = routes.reader ();
2400 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
2401 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
2402 if (tr && !tr->is_auditioner()) {
2403 in += tr->n_inputs();
2404 out += tr->n_outputs();
2410 Session::default_track_name_pattern (DataType t)
2413 case DataType::AUDIO:
2414 if (Profile->get_trx()) {
2421 case DataType::MIDI:
2428 /** Caller must not hold process lock
2429 * @param name_template string to use for the start of the name, or "" to use "MIDI".
2430 * @param instrument plugin info for the instrument to insert pre-fader, if any
2432 list<boost::shared_ptr<MidiTrack> >
2433 Session::new_midi_track (const ChanCount& input, const ChanCount& output,
2434 boost::shared_ptr<PluginInfo> instrument, Plugin::PresetRecord* pset,
2435 RouteGroup* route_group, uint32_t how_many, string name_template, PresentationInfo::order_t order,
2439 uint32_t track_id = 0;
2441 RouteList new_routes;
2442 list<boost::shared_ptr<MidiTrack> > ret;
2444 const string name_pattern = default_track_name_pattern (DataType::MIDI);
2445 bool const use_number = (how_many != 1) || name_template.empty () || (name_template == name_pattern);
2448 if (!find_route_name (name_template.empty() ? _("MIDI") : name_template, ++track_id, track_name, use_number)) {
2449 error << "cannot find name for new midi track" << endmsg;
2453 boost::shared_ptr<MidiTrack> track;
2456 track.reset (new MidiTrack (*this, track_name, mode));
2458 if (track->init ()) {
2462 if (Profile->get_mixbus ()) {
2463 track->set_strict_io (true);
2466 track->use_new_diskstream();
2468 BOOST_MARK_TRACK (track);
2471 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
2472 if (track->input()->ensure_io (input, false, this)) {
2473 error << "cannot configure " << input << " out configuration for new midi track" << endmsg;
2477 if (track->output()->ensure_io (output, false, this)) {
2478 error << "cannot configure " << output << " out configuration for new midi track" << endmsg;
2483 track->non_realtime_input_change();
2486 route_group->add (track);
2489 track->DiskstreamChanged.connect_same_thread (*this, boost::bind (&Session::resort_routes, this));
2491 new_routes.push_back (track);
2492 ret.push_back (track);
2495 catch (failed_constructor &err) {
2496 error << _("Session: could not create new midi track.") << endmsg;
2500 catch (AudioEngine::PortRegistrationFailure& pfe) {
2502 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;
2510 if (!new_routes.empty()) {
2511 StateProtector sp (this);
2512 if (Profile->get_trx()) {
2513 add_routes (new_routes, false, false, false, order);
2515 add_routes (new_routes, true, true, false, order);
2519 for (RouteList::iterator r = new_routes.begin(); r != new_routes.end(); ++r) {
2520 PluginPtr plugin = instrument->load (*this);
2522 plugin->load_preset (*pset);
2524 boost::shared_ptr<Processor> p (new PluginInsert (*this, plugin));
2525 (*r)->add_processor (p, PreFader);
2535 Session::new_midi_route (RouteGroup* route_group, uint32_t how_many, string name_template, boost::shared_ptr<PluginInfo> instrument, Plugin::PresetRecord* pset,
2536 PresentationInfo::Flag flag, PresentationInfo::order_t order)
2539 uint32_t bus_id = 0;
2543 bool const use_number = (how_many != 1) || name_template.empty () || name_template == _("Midi Bus");
2546 if (!find_route_name (name_template.empty () ? _("Midi Bus") : name_template, ++bus_id, bus_name, use_number)) {
2547 error << "cannot find name for new midi bus" << endmsg;
2552 boost::shared_ptr<Route> bus (new Route (*this, bus_name, flag, DataType::AUDIO)); // XXX Editor::add_routes is not ready for ARDOUR::DataType::MIDI
2558 if (Profile->get_mixbus ()) {
2559 bus->set_strict_io (true);
2562 BOOST_MARK_ROUTE(bus);
2565 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
2567 if (bus->input()->ensure_io (ChanCount(DataType::MIDI, 1), false, this)) {
2568 error << _("cannot configure new midi bus input") << endmsg;
2573 if (bus->output()->ensure_io (ChanCount(DataType::MIDI, 1), false, this)) {
2574 error << _("cannot configure new midi bus output") << endmsg;
2580 route_group->add (bus);
2583 bus->add_internal_return ();
2584 ret.push_back (bus);
2587 catch (failed_constructor &err) {
2588 error << _("Session: could not create new audio route.") << endmsg;
2592 catch (AudioEngine::PortRegistrationFailure& pfe) {
2593 error << pfe.what() << endmsg;
2603 StateProtector sp (this);
2604 add_routes (ret, false, false, false, order);
2607 for (RouteList::iterator r = ret.begin(); r != ret.end(); ++r) {
2608 PluginPtr plugin = instrument->load (*this);
2610 plugin->load_preset (*pset);
2612 boost::shared_ptr<Processor> p (new PluginInsert (*this, plugin));
2613 (*r)->add_processor (p, PreFader);
2624 Session::midi_output_change_handler (IOChange change, void * /*src*/, boost::weak_ptr<Route> wmt)
2626 boost::shared_ptr<Route> midi_track (wmt.lock());
2632 if ((change.type & IOChange::ConfigurationChanged) && Config->get_output_auto_connect() != ManualConnect) {
2634 if (change.after.n_audio() <= change.before.n_audio()) {
2638 /* new audio ports: make sure the audio goes somewhere useful,
2639 * unless the user has no-auto-connect selected.
2641 * The existing ChanCounts don't matter for this call as they are only
2642 * to do with matching input and output indices, and we are only changing
2645 auto_connect_route (midi_track, false, ChanCount(), change.before);
2649 #ifdef USE_TRACKS_CODE_FEATURES
2652 compare_routes_by_remote_id (const boost::shared_ptr<Route>& route1, const boost::shared_ptr<Route>& route2)
2654 return route1->remote_control_id() < route2->remote_control_id();
2658 Session::reconnect_existing_routes (bool withLock, bool reconnect_master, bool reconnect_inputs, bool reconnect_outputs)
2660 // it is not allowed to perform connection
2661 if (!IO::connecting_legal) {
2665 // if we are deleting routes we will call this once at the end
2666 if (_route_deletion_in_progress) {
2670 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock (), Glib::Threads::NOT_LOCK);
2676 // We need to disconnect the route's inputs and outputs first
2677 // basing on autoconnect configuration
2678 bool reconnectIputs = !(Config->get_input_auto_connect() & ManualConnect) && reconnect_inputs;
2679 bool reconnectOutputs = !(Config->get_output_auto_connect() & ManualConnect) && reconnect_outputs;
2681 ChanCount existing_inputs;
2682 ChanCount existing_outputs;
2683 count_existing_track_channels (existing_inputs, existing_outputs);
2685 //ChanCount inputs = ChanCount::ZERO;
2686 //ChanCount outputs = ChanCount::ZERO;
2688 RouteList existing_routes = *routes.reader ();
2689 existing_routes.sort (compare_routes_by_remote_id);
2692 PBD::Unwinder<bool> protect_ignore_changes (_reconnecting_routes_in_progress, true);
2694 vector<string> physinputs;
2695 vector<string> physoutputs;
2697 EngineStateController::instance()->get_physical_audio_outputs(physoutputs);
2698 EngineStateController::instance()->get_physical_audio_inputs(physinputs);
2700 uint32_t input_n = 0;
2701 uint32_t output_n = 0;
2702 RouteList::iterator rIter = existing_routes.begin();
2703 const AutoConnectOption current_input_auto_connection (Config->get_input_auto_connect());
2704 const AutoConnectOption current_output_auto_connection (Config->get_output_auto_connect());
2705 for (; rIter != existing_routes.end(); ++rIter) {
2706 if (*rIter == _master_out || *rIter == _monitor_out ) {
2710 if (current_output_auto_connection == AutoConnectPhysical) {
2711 (*rIter)->amp()->deactivate();
2712 } else if (current_output_auto_connection == AutoConnectMaster) {
2713 (*rIter)->amp()->activate();
2716 if (reconnectIputs) {
2717 (*rIter)->input()->disconnect (this); //GZ: check this; could be heavy
2719 for (uint32_t route_input_n = 0; route_input_n < (*rIter)->n_inputs().get(DataType::AUDIO); ++route_input_n) {
2721 if (current_input_auto_connection & AutoConnectPhysical) {
2723 if ( input_n == physinputs.size() ) {
2727 string port = physinputs[input_n];
2729 if (port.empty() ) {
2730 error << "Physical Input number "<< input_n << " is unavailable and cannot be connected" << endmsg;
2733 //GZ: check this; could be heavy
2734 (*rIter)->input()->connect ((*rIter)->input()->ports().port(DataType::AUDIO, route_input_n), port, this);
2740 if (reconnectOutputs) {
2742 //normalize route ouptuts: reduce the amount outputs to be equal to the amount of inputs
2743 if (current_output_auto_connection & AutoConnectPhysical) {
2745 //GZ: check this; could be heavy
2746 (*rIter)->output()->disconnect (this);
2747 size_t route_inputs_count = (*rIter)->n_inputs().get(DataType::AUDIO);
2749 //GZ: check this; could be heavy
2750 (*rIter)->output()->ensure_io(ChanCount(DataType::AUDIO, route_inputs_count), false, this );
2752 } else if (current_output_auto_connection & AutoConnectMaster){
2754 if (!reconnect_master) {
2758 //GZ: check this; could be heavy
2759 (*rIter)->output()->disconnect (this);
2762 uint32_t master_inputs_count = _master_out->n_inputs().get(DataType::AUDIO);
2763 (*rIter)->output()->ensure_io(ChanCount(DataType::AUDIO, master_inputs_count), false, this );
2765 error << error << "Master bus is not available" << endmsg;
2770 for (uint32_t route_output_n = 0; route_output_n < (*rIter)->n_outputs().get(DataType::AUDIO); ++route_output_n) {
2771 if (current_output_auto_connection & AutoConnectPhysical) {
2773 if ( output_n == physoutputs.size() ) {
2777 string port = physoutputs[output_n];
2779 if (port.empty() ) {
2780 error << "Physical Output number "<< output_n << " is unavailable and cannot be connected" << endmsg;
2783 //GZ: check this; could be heavy
2784 (*rIter)->output()->connect ((*rIter)->output()->ports().port(DataType::AUDIO, route_output_n), port, this);
2787 } else if (current_output_auto_connection & AutoConnectMaster) {
2789 if ( route_output_n == _master_out->n_inputs().get(DataType::AUDIO) ) {
2793 // connect to master bus
2794 string port = _master_out->input()->ports().port(DataType::AUDIO, route_output_n)->name();
2796 if (port.empty() ) {
2797 error << "MasterBus Input number "<< route_output_n << " is unavailable and cannot be connected" << endmsg;
2801 //GZ: check this; could be heavy
2802 (*rIter)->output()->connect ((*rIter)->output()->ports().port(DataType::AUDIO, route_output_n), port, this);
2809 _master_out->output()->disconnect (this);
2810 auto_connect_master_bus ();
2815 session_routes_reconnected (); /* EMIT SIGNAL */
2819 Session::reconnect_midi_scene_ports(bool inputs)
2823 boost::shared_ptr<MidiPort> scene_in_ptr = scene_in();
2825 scene_in_ptr->disconnect_all ();
2827 std::vector<EngineStateController::MidiPortState> midi_port_states;
2828 EngineStateController::instance()->get_physical_midi_input_states (midi_port_states);
2830 std::vector<EngineStateController::MidiPortState>::iterator state_iter = midi_port_states.begin();
2832 for (; state_iter != midi_port_states.end(); ++state_iter) {
2833 if (state_iter->active && state_iter->available && state_iter->scene_connected) {
2834 scene_in_ptr->connect (state_iter->name);
2841 boost::shared_ptr<MidiPort> scene_out_ptr = scene_out();
2843 if (scene_out_ptr ) {
2844 scene_out_ptr->disconnect_all ();
2846 std::vector<EngineStateController::MidiPortState> midi_port_states;
2847 EngineStateController::instance()->get_physical_midi_output_states (midi_port_states);
2849 std::vector<EngineStateController::MidiPortState>::iterator state_iter = midi_port_states.begin();
2851 for (; state_iter != midi_port_states.end(); ++state_iter) {
2852 if (state_iter->active && state_iter->available && state_iter->scene_connected) {
2853 scene_out_ptr->connect (state_iter->name);
2861 Session::reconnect_mtc_ports ()
2863 boost::shared_ptr<MidiPort> mtc_in_ptr = _midi_ports->mtc_input_port();
2869 mtc_in_ptr->disconnect_all ();
2871 std::vector<EngineStateController::MidiPortState> midi_port_states;
2872 EngineStateController::instance()->get_physical_midi_input_states (midi_port_states);
2874 std::vector<EngineStateController::MidiPortState>::iterator state_iter = midi_port_states.begin();
2876 for (; state_iter != midi_port_states.end(); ++state_iter) {
2877 if (state_iter->available && state_iter->mtc_in) {
2878 mtc_in_ptr->connect (state_iter->name);
2882 if (!_midi_ports->mtc_input_port ()->connected () &&
2883 config.get_external_sync () &&
2884 (Config->get_sync_source () == MTC) ) {
2885 config.set_external_sync (false);
2888 if ( ARDOUR::Profile->get_trx () ) {
2889 // Tracks need this signal to update timecode_source_dropdown
2890 MtcOrLtcInputPortChanged (); //emit signal
2895 Session::reconnect_mmc_ports(bool inputs)
2897 if (inputs ) { // get all enabled midi input ports
2899 boost::shared_ptr<MidiPort> mmc_in_ptr = _midi_ports->mmc_in();
2901 mmc_in_ptr->disconnect_all ();
2902 std::vector<std::string> enabled_midi_inputs;
2903 EngineStateController::instance()->get_physical_midi_inputs (enabled_midi_inputs);
2905 std::vector<std::string>::iterator port_iter = enabled_midi_inputs.begin();
2907 for (; port_iter != enabled_midi_inputs.end(); ++port_iter) {
2908 mmc_in_ptr->connect (*port_iter);
2912 } else { // get all enabled midi output ports
2914 boost::shared_ptr<MidiPort> mmc_out_ptr = _midi_ports->mmc_out();
2916 mmc_out_ptr->disconnect_all ();
2917 std::vector<std::string> enabled_midi_outputs;
2918 EngineStateController::instance()->get_physical_midi_outputs (enabled_midi_outputs);
2920 std::vector<std::string>::iterator port_iter = enabled_midi_outputs.begin();
2922 for (; port_iter != enabled_midi_outputs.end(); ++port_iter) {
2923 mmc_out_ptr->connect (*port_iter);
2932 Session::ensure_route_presentation_info_gap (PresentationInfo::order_t first_new_order, uint32_t how_many)
2934 if (first_new_order == PresentationInfo::max_order) {
2935 /* adding at end, no worries */
2939 /* create a gap in the presentation info to accomodate @param how_many
2943 get_stripables (sl);
2945 for (StripableList::iterator si = sl.begin(); si != sl.end(); ++si) {
2946 boost::shared_ptr<Stripable> s (*si);
2948 if (s->is_monitor() || s->is_auditioner()) {
2952 if (s->presentation_info().order () >= first_new_order) {
2953 s->set_presentation_order (s->presentation_info().order () + how_many);
2958 /** Caller must not hold process lock
2959 * @param name_template string to use for the start of the name, or "" to use "Audio".
2961 list< boost::shared_ptr<AudioTrack> >
2962 Session::new_audio_track (int input_channels, int output_channels, RouteGroup* route_group,
2963 uint32_t how_many, string name_template, PresentationInfo::order_t order,
2967 uint32_t track_id = 0;
2969 RouteList new_routes;
2970 list<boost::shared_ptr<AudioTrack> > ret;
2972 const string name_pattern = default_track_name_pattern (DataType::AUDIO);
2973 bool const use_number = (how_many != 1) || name_template.empty () || (name_template == name_pattern);
2977 if (!find_route_name (name_template.empty() ? _(name_pattern.c_str()) : name_template, ++track_id, track_name, use_number)) {
2978 error << "cannot find name for new audio track" << endmsg;
2982 boost::shared_ptr<AudioTrack> track;
2985 track.reset (new AudioTrack (*this, track_name, mode));
2987 if (track->init ()) {
2991 if (Profile->get_mixbus ()) {
2992 track->set_strict_io (true);
2995 if (ARDOUR::Profile->get_trx ()) {
2996 // TRACKS considers it's not a USE CASE, it's
2997 // a piece of behavior of the session model:
2999 // Gain for a newly created route depends on
3000 // the current output_auto_connect mode:
3002 // 0 for Stereo Out mode
3004 if (Config->get_output_auto_connect() & AutoConnectMaster) {
3005 track->gain_control()->set_value (dB_to_coefficient (0), Controllable::NoGroup);
3009 track->use_new_diskstream();
3011 BOOST_MARK_TRACK (track);
3014 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
3016 if (track->input()->ensure_io (ChanCount(DataType::AUDIO, input_channels), false, this)) {
3017 error << string_compose (
3018 _("cannot configure %1 in/%2 out configuration for new audio track"),
3019 input_channels, output_channels)
3024 if (track->output()->ensure_io (ChanCount(DataType::AUDIO, output_channels), false, this)) {
3025 error << string_compose (
3026 _("cannot configure %1 in/%2 out configuration for new audio track"),
3027 input_channels, output_channels)
3034 route_group->add (track);
3037 track->non_realtime_input_change();
3039 track->DiskstreamChanged.connect_same_thread (*this, boost::bind (&Session::resort_routes, this));
3041 new_routes.push_back (track);
3042 ret.push_back (track);
3045 catch (failed_constructor &err) {
3046 error << _("Session: could not create new audio track.") << endmsg;
3050 catch (AudioEngine::PortRegistrationFailure& pfe) {
3052 error << pfe.what() << endmsg;
3060 if (!new_routes.empty()) {
3061 StateProtector sp (this);
3062 if (Profile->get_trx()) {
3063 add_routes (new_routes, false, false, false, order);
3065 add_routes (new_routes, true, true, false, order);
3072 /** Caller must not hold process lock.
3073 * @param name_template string to use for the start of the name, or "" to use "Bus".
3076 Session::new_audio_route (int input_channels, int output_channels, RouteGroup* route_group, uint32_t how_many, string name_template,
3077 PresentationInfo::Flag flags, PresentationInfo::order_t order)
3080 uint32_t bus_id = 0;
3084 bool const use_number = (how_many != 1) || name_template.empty () || name_template == _("Bus");
3087 if (!find_route_name (name_template.empty () ? _("Bus") : name_template, ++bus_id, bus_name, use_number)) {
3088 error << "cannot find name for new audio bus" << endmsg;
3093 boost::shared_ptr<Route> bus (new Route (*this, bus_name, flags, DataType::AUDIO));
3099 if (Profile->get_mixbus ()) {
3100 bus->set_strict_io (true);
3103 BOOST_MARK_ROUTE(bus);
3106 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
3108 if (bus->input()->ensure_io (ChanCount(DataType::AUDIO, input_channels), false, this)) {
3109 error << string_compose (_("cannot configure %1 in/%2 out configuration for new audio track"),
3110 input_channels, output_channels)
3116 if (bus->output()->ensure_io (ChanCount(DataType::AUDIO, output_channels), false, this)) {
3117 error << string_compose (_("cannot configure %1 in/%2 out configuration for new audio track"),
3118 input_channels, output_channels)
3125 route_group->add (bus);
3128 bus->add_internal_return ();
3129 ret.push_back (bus);
3132 catch (failed_constructor &err) {
3133 error << _("Session: could not create new audio route.") << endmsg;
3137 catch (AudioEngine::PortRegistrationFailure& pfe) {
3138 error << pfe.what() << endmsg;
3148 StateProtector sp (this);
3149 if (Profile->get_trx()) {
3150 add_routes (ret, false, false, false, order);
3152 add_routes (ret, false, true, true, order); // autoconnect // outputs only
3161 Session::new_route_from_template (uint32_t how_many, const std::string& template_path, const std::string& name_base, PlaylistDisposition pd)
3165 if (!tree.read (template_path.c_str())) {
3169 return new_route_from_template (how_many, *tree.root(), name_base, pd);
3173 Session::new_route_from_template (uint32_t how_many, XMLNode& node, const std::string& name_base, PlaylistDisposition pd)
3176 uint32_t number = 0;
3177 const uint32_t being_added = how_many;
3178 /* This will prevent the use of any existing XML-provided PBD::ID
3181 Stateful::ForceIDRegeneration force_ids;
3182 IO::disable_connecting ();
3186 /* We're going to modify the node contents a bit so take a
3187 * copy. The node may be re-used when duplicating more than once.
3190 XMLNode node_copy (node);
3195 if (!name_base.empty()) {
3197 /* if we're adding more than one routes, force
3198 * all the names of the new routes to be
3199 * numbered, via the final parameter.
3202 if (!find_route_name (name_base.c_str(), ++number, name, (being_added > 1))) {
3203 fatal << _("Session: UINT_MAX routes? impossible!") << endmsg;
3209 string const route_name = node_copy.property(X_("name"))->value ();
3211 /* generate a new name by adding a number to the end of the template name */
3212 if (!find_route_name (route_name.c_str(), ++number, name, true)) {
3213 fatal << _("Session: UINT_MAX routes? impossible!") << endmsg;
3214 abort(); /*NOTREACHED*/
3218 /* set this name in the XML description that we are about to use */
3220 bool rename_playlist;
3223 rename_playlist = true;
3228 rename_playlist = false;
3231 Route::set_name_in_state (node_copy, name, rename_playlist);
3233 /* trim bitslots from listen sends so that new ones are used */
3234 XMLNodeList children = node_copy.children ();
3235 for (XMLNodeList::iterator i = children.begin(); i != children.end(); ++i) {
3236 if ((*i)->name() == X_("Processor")) {
3237 /* ForceIDRegeneration does not catch the following */
3238 XMLProperty const * role = (*i)->property (X_("role"));
3239 XMLProperty const * type = (*i)->property (X_("type"));
3240 if (role && role->value() == X_("Aux")) {
3241 /* check if the target bus exists.
3242 * we should not save aux-sends in templates.
3244 XMLProperty const * target = (*i)->property (X_("target"));
3246 (*i)->add_property ("type", "dangling-aux-send");
3249 boost::shared_ptr<Route> r = route_by_id (target->value());
3250 if (!r || boost::dynamic_pointer_cast<Track>(r)) {
3251 (*i)->add_property ("type", "dangling-aux-send");
3255 if (role && role->value() == X_("Listen")) {
3256 (*i)->remove_property (X_("bitslot"));
3258 else if (role && (role->value() == X_("Send") || role->value() == X_("Aux"))) {
3260 Delivery::Role xrole;
3261 uint32_t bitslot = 0;
3262 xrole = Delivery::Role (string_2_enum (role->value(), xrole));
3263 std::string name = Send::name_and_id_new_send(*this, xrole, bitslot, false);
3264 snprintf (buf, sizeof (buf), "%" PRIu32, bitslot);
3265 (*i)->remove_property (X_("bitslot"));
3266 (*i)->remove_property (X_("name"));
3267 (*i)->add_property ("bitslot", buf);
3268 (*i)->add_property ("name", name);
3270 else if (type && type->value() == X_("intreturn")) {
3271 (*i)->remove_property (X_("bitslot"));
3272 (*i)->add_property ("ignore-bitslot", "1");
3274 else if (type && type->value() == X_("return")) {
3275 // Return::set_state() generates a new one
3276 (*i)->remove_property (X_("bitslot"));
3278 else if (type && type->value() == X_("port")) {
3279 // PortInsert::set_state() handles the bitslot
3280 (*i)->remove_property (X_("bitslot"));
3281 (*i)->add_property ("ignore-name", "1");
3286 boost::shared_ptr<Route> route (XMLRouteFactory (node_copy, 3000));
3289 error << _("Session: cannot create track/bus from template description") << endmsg;
3293 if (boost::dynamic_pointer_cast<Track>(route)) {
3294 /* force input/output change signals so that the new diskstream
3295 picks up the configuration of the route. During session
3296 loading this normally happens in a different way.
3299 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
3301 IOChange change (IOChange::Type (IOChange::ConfigurationChanged | IOChange::ConnectionsChanged));
3302 change.after = route->input()->n_ports();
3303 route->input()->changed (change, this);
3304 change.after = route->output()->n_ports();
3305 route->output()->changed (change, this);
3308 boost::shared_ptr<Track> track;
3310 if ((track = boost::dynamic_pointer_cast<Track> (route))) {
3313 track->use_new_playlist ();
3316 track->use_copy_playlist ();
3323 ret.push_back (route);
3326 catch (failed_constructor &err) {
3327 error << _("Session: could not create new route from template") << endmsg;
3331 catch (AudioEngine::PortRegistrationFailure& pfe) {
3332 error << pfe.what() << endmsg;
3341 StateProtector sp (this);
3342 if (Profile->get_trx()) {
3343 add_routes (ret, false, false, false, PresentationInfo::max_order);
3345 add_routes (ret, true, true, false, PresentationInfo::max_order);
3347 IO::enable_connecting ();
3354 Session::add_routes (RouteList& new_routes, bool input_auto_connect, bool output_auto_connect, bool save, PresentationInfo::order_t order)
3357 PBD::Unwinder<bool> aip (_adding_routes_in_progress, true);
3358 add_routes_inner (new_routes, input_auto_connect, output_auto_connect, order);
3361 error << _("Adding new tracks/busses failed") << endmsg;
3366 update_latency (true);
3367 update_latency (false);
3372 save_state (_current_snapshot_name);
3375 update_route_record_state ();
3377 RouteAdded (new_routes); /* EMIT SIGNAL */
3381 Session::add_routes_inner (RouteList& new_routes, bool input_auto_connect, bool output_auto_connect, PresentationInfo::order_t order)
3383 ChanCount existing_inputs;
3384 ChanCount existing_outputs;
3388 count_existing_track_channels (existing_inputs, existing_outputs);
3391 RCUWriter<RouteList> writer (routes);
3392 boost::shared_ptr<RouteList> r = writer.get_copy ();
3393 r->insert (r->end(), new_routes.begin(), new_routes.end());
3394 n_routes = r->size();
3396 /* if there is no control out and we're not in the middle of loading,
3397 * resort the graph here. if there is a control out, we will resort
3398 * toward the end of this method. if we are in the middle of loading,
3399 * we will resort when done.
3402 if (!_monitor_out && IO::connecting_legal) {
3403 resort_routes_using (r);
3407 DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("ensure order gap starting at %1 for %2\n", order, new_routes.size()));
3408 ensure_route_presentation_info_gap (order, new_routes.size());
3410 for (RouteList::iterator x = new_routes.begin(); x != new_routes.end(); ++x, ++added) {
3412 boost::weak_ptr<Route> wpr (*x);
3413 boost::shared_ptr<Route> r (*x);
3415 r->solo_control()->Changed.connect_same_thread (*this, boost::bind (&Session::route_solo_changed, this, _1, _2,wpr));
3416 r->solo_isolate_control()->Changed.connect_same_thread (*this, boost::bind (&Session::route_solo_isolated_changed, this, wpr));
3417 r->mute_control()->Changed.connect_same_thread (*this, boost::bind (&Session::route_mute_changed, this));
3419 r->output()->changed.connect_same_thread (*this, boost::bind (&Session::set_worst_io_latencies_x, this, _1, _2));
3420 r->processors_changed.connect_same_thread (*this, boost::bind (&Session::route_processors_changed, this, _1));
3421 r->processor_latency_changed.connect_same_thread (*this, boost::bind (&Session::queue_latency_recompute, this));
3423 if (r->is_master()) {
3427 if (r->is_monitor()) {
3431 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (r);
3433 tr->PlaylistChanged.connect_same_thread (*this, boost::bind (&Session::track_playlist_changed, this, boost::weak_ptr<Track> (tr)));
3434 track_playlist_changed (boost::weak_ptr<Track> (tr));
3435 tr->rec_enable_control()->Changed.connect_same_thread (*this, boost::bind (&Session::update_route_record_state, this));
3437 boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (tr);
3439 mt->StepEditStatusChange.connect_same_thread (*this, boost::bind (&Session::step_edit_status_change, this, _1));
3440 mt->output()->changed.connect_same_thread (*this, boost::bind (&Session::midi_output_change_handler, this, _1, _2, boost::weak_ptr<Route>(mt)));
3444 if (!r->presentation_info().special()) {
3446 DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("checking PI state for %1\n", r->name()));
3448 /* presentation info order may already have been set from XML */
3450 if (!r->presentation_info().order_set()) {
3452 if (order == PresentationInfo::max_order) {
3453 /* just add to the end */
3454 r->set_presentation_order (n_routes + added, false);
3455 DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("group order not set, set to NR %1 + %2 = %3\n", n_routes, added, n_routes + added));
3457 r->set_presentation_order (order + added);
3458 DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("group order not set, set to %1 + %2 = %3\n", order, added, order + added));
3461 DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("group order already set to %1\n", r->presentation_info().order()));
3465 #if !defined(__APPLE__) && !defined(__FreeBSD__)
3466 /* clang complains: 'operator<<' should be declared prior to the call site or in an associated namespace of one of its
3467 * arguments std::ostream& operator<<(std::ostream& o, ARDOUR::PresentationInfo const& rid)"
3469 DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("added route %1, group order %2 type %3 (summary: %4)\n",
3471 r->presentation_info().order(),
3472 enum_2_string (r->presentation_info().flags()),
3473 r->presentation_info()));
3477 if (input_auto_connect || output_auto_connect) {
3478 auto_connect_route (r, input_auto_connect, ChanCount (), ChanCount (), existing_inputs, existing_outputs);
3479 existing_inputs += r->n_inputs();
3480 existing_outputs += r->n_outputs();
3486 if (_monitor_out && IO::connecting_legal) {
3487 Glib::Threads::Mutex::Lock lm (_engine.process_lock());
3489 for (RouteList::iterator x = new_routes.begin(); x != new_routes.end(); ++x) {
3490 if ((*x)->is_monitor()) {
3492 } else if ((*x)->is_master()) {
3495 (*x)->enable_monitor_send ();
3500 reassign_track_numbers ();
3504 Session::globally_set_send_gains_to_zero (boost::shared_ptr<Route> dest)
3506 boost::shared_ptr<RouteList> r = routes.reader ();
3507 boost::shared_ptr<Send> s;
3509 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3510 if ((s = (*i)->internal_send_for (dest)) != 0) {
3511 s->amp()->gain_control()->set_value (GAIN_COEFF_ZERO, Controllable::NoGroup);
3517 Session::globally_set_send_gains_to_unity (boost::shared_ptr<Route> dest)
3519 boost::shared_ptr<RouteList> r = routes.reader ();
3520 boost::shared_ptr<Send> s;
3522 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3523 if ((s = (*i)->internal_send_for (dest)) != 0) {
3524 s->amp()->gain_control()->set_value (GAIN_COEFF_UNITY, Controllable::NoGroup);
3530 Session::globally_set_send_gains_from_track(boost::shared_ptr<Route> dest)
3532 boost::shared_ptr<RouteList> r = routes.reader ();
3533 boost::shared_ptr<Send> s;
3535 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3536 if ((s = (*i)->internal_send_for (dest)) != 0) {
3537 s->amp()->gain_control()->set_value ((*i)->gain_control()->get_value(), Controllable::NoGroup);
3542 /** @param include_buses true to add sends to buses and tracks, false for just tracks */
3544 Session::globally_add_internal_sends (boost::shared_ptr<Route> dest, Placement p, bool include_buses)
3546 boost::shared_ptr<RouteList> r = routes.reader ();
3547 boost::shared_ptr<RouteList> t (new RouteList);
3549 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3550 /* no MIDI sends because there are no MIDI busses yet */
3551 if (include_buses || boost::dynamic_pointer_cast<AudioTrack>(*i)) {
3556 add_internal_sends (dest, p, t);
3560 Session::add_internal_sends (boost::shared_ptr<Route> dest, Placement p, boost::shared_ptr<RouteList> senders)
3562 for (RouteList::iterator i = senders->begin(); i != senders->end(); ++i) {
3563 add_internal_send (dest, (*i)->before_processor_for_placement (p), *i);
3568 Session::add_internal_send (boost::shared_ptr<Route> dest, int index, boost::shared_ptr<Route> sender)
3570 add_internal_send (dest, sender->before_processor_for_index (index), sender);
3574 Session::add_internal_send (boost::shared_ptr<Route> dest, boost::shared_ptr<Processor> before, boost::shared_ptr<Route> sender)
3576 if (sender->is_monitor() || sender->is_master() || sender == dest || dest->is_monitor() || dest->is_master()) {
3580 if (!dest->internal_return()) {
3581 dest->add_internal_return ();
3584 sender->add_aux_send (dest, before);
3590 Session::remove_routes (boost::shared_ptr<RouteList> routes_to_remove)
3592 { // RCU Writer scope
3593 PBD::Unwinder<bool> uw_flag (_route_deletion_in_progress, true);
3594 RCUWriter<RouteList> writer (routes);
3595 boost::shared_ptr<RouteList> rs = writer.get_copy ();
3598 for (RouteList::iterator iter = routes_to_remove->begin(); iter != routes_to_remove->end(); ++iter) {
3600 if (*iter == _master_out) {
3604 (*iter)->solo_control()->set_value (0.0, Controllable::NoGroup);
3608 /* deleting the master out seems like a dumb
3609 idea, but its more of a UI policy issue
3613 if (*iter == _master_out) {
3614 _master_out = boost::shared_ptr<Route> ();
3617 if (*iter == _monitor_out) {
3618 _monitor_out.reset ();
3621 // We need to disconnect the route's inputs and outputs
3623 (*iter)->input()->disconnect (0);
3624 (*iter)->output()->disconnect (0);
3626 /* if the route had internal sends sending to it, remove them */
3627 if ((*iter)->internal_return()) {
3629 boost::shared_ptr<RouteList> r = routes.reader ();
3630 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3631 boost::shared_ptr<Send> s = (*i)->internal_send_for (*iter);
3633 (*i)->remove_processor (s);
3638 /* if the monitoring section had a pointer to this route, remove it */
3639 if (_monitor_out && !(*iter)->is_master() && !(*iter)->is_monitor()) {
3640 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
3641 PBD::Unwinder<bool> uw (ignore_route_processor_changes, true);
3642 (*iter)->remove_aux_or_listen (_monitor_out);
3645 boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (*iter);
3646 if (mt && mt->step_editing()) {
3647 if (_step_editors > 0) {
3653 /* writer goes out of scope, forces route list update */
3655 } // end of RCU Writer scope
3657 update_route_solo_state ();
3658 update_latency_compensation ();
3661 /* Re-sort routes to remove the graph's current references to the one that is
3662 * going away, then flush old references out of the graph.
3663 * Wave Tracks: reconnect routes
3666 #ifdef USE_TRACKS_CODE_FEATURES
3667 reconnect_existing_routes(true, false);
3669 routes.flush (); // maybe unsafe, see below.
3673 if (_process_graph && !(_state_of_the_state & Deletion)) {
3674 _process_graph->clear_other_chain ();
3677 /* get rid of it from the dead wood collection in the route list manager */
3678 /* XXX i think this is unsafe as it currently stands, but i am not sure. (pd, october 2nd, 2006) */
3682 /* try to cause everyone to drop their references
3683 * and unregister ports from the backend
3686 for (RouteList::iterator iter = routes_to_remove->begin(); iter != routes_to_remove->end(); ++iter) {
3687 (*iter)->drop_references ();
3690 if (_state_of_the_state & Deletion) {
3694 PresentationInfo::Change(); /* EMIT SIGNAL */
3696 /* save the new state of the world */
3698 if (save_state (_current_snapshot_name)) {
3699 save_history (_current_snapshot_name);
3702 update_route_record_state ();
3706 Session::remove_route (boost::shared_ptr<Route> route)
3708 boost::shared_ptr<RouteList> rl (new RouteList);
3709 rl->push_back (route);
3714 Session::route_mute_changed ()
3720 Session::route_listen_changed (Controllable::GroupControlDisposition group_override, boost::weak_ptr<Route> wpr)
3722 boost::shared_ptr<Route> route (wpr.lock());
3728 assert (Config->get_solo_control_is_listen_control());
3730 if (route->solo_control()->soloed_by_self_or_masters()) {
3732 if (Config->get_exclusive_solo()) {
3734 RouteGroup* rg = route->route_group ();
3735 const bool group_already_accounted_for = (group_override == Controllable::ForGroup);
3737 boost::shared_ptr<RouteList> r = routes.reader ();
3739 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3740 if ((*i) == route) {
3741 /* already changed */
3745 if ((*i)->solo_isolate_control()->solo_isolated() || !(*i)->can_solo()) {
3746 /* route does not get solo propagated to it */
3750 if ((group_already_accounted_for && (*i)->route_group() && (*i)->route_group() == rg)) {
3751 /* this route is a part of the same solo group as the route
3752 * that was changed. Changing that route did change or will
3753 * change all group members appropriately, so we can ignore it
3758 (*i)->solo_control()->set_value (0.0, Controllable::NoGroup);
3764 } else if (_listen_cnt > 0) {
3769 update_route_solo_state ();
3773 Session::route_solo_isolated_changed (boost::weak_ptr<Route> wpr)
3775 boost::shared_ptr<Route> route (wpr.lock());
3781 bool send_changed = false;
3783 if (route->solo_isolate_control()->solo_isolated()) {
3784 if (_solo_isolated_cnt == 0) {
3785 send_changed = true;
3787 _solo_isolated_cnt++;
3788 } else if (_solo_isolated_cnt > 0) {
3789 _solo_isolated_cnt--;
3790 if (_solo_isolated_cnt == 0) {
3791 send_changed = true;
3796 IsolatedChanged (); /* EMIT SIGNAL */
3801 Session::route_solo_changed (bool self_solo_changed, Controllable::GroupControlDisposition group_override, boost::weak_ptr<Route> wpr)
3803 DEBUG_TRACE (DEBUG::Solo, string_compose ("route solo change, self = %1\n", self_solo_changed));
3805 boost::shared_ptr<Route> route (wpr.lock());
3811 if (Config->get_solo_control_is_listen_control()) {
3812 route_listen_changed (group_override, wpr);
3816 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()));
3818 if (route->solo_control()->transitioned_into_solo() == 0) {
3819 /* route solo changed by upstream/downstream; not interesting
3822 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()));
3826 if (route->solo_control()->transitioned_into_solo() == 0) {
3827 /* reason for being soloed changed (e.g. master went away, we
3828 * took over the master state), but actual status did
3829 * not. nothing to do.
3831 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1: solo change was change in reason, not status\n", route->name()));
3834 boost::shared_ptr<RouteList> r = routes.reader ();
3835 int32_t delta = route->solo_control()->transitioned_into_solo ();
3837 /* the route may be a member of a group that has shared-solo
3838 * semantics. If so, then all members of that group should follow the
3839 * solo of the changed route. But ... this is optional, controlled by a
3840 * Controllable::GroupControlDisposition.
3842 * The first argument to the signal that this method is connected to is the
3843 * GroupControlDisposition value that was used to change solo.
3845 * If the solo change was done with group semantics (either InverseGroup
3846 * (force the entire group to change even if the group shared solo is
3847 * disabled) or UseGroup (use the group, which may or may not have the
3848 * shared solo property enabled)) then as we propagate the change to
3849 * the entire session we should IGNORE THE GROUP that the changed route
3853 RouteGroup* rg = route->route_group ();
3854 const bool group_already_accounted_for = (group_override == Controllable::ForGroup);
3856 if (delta == 1 && Config->get_exclusive_solo()) {
3858 /* new solo: disable all other solos, but not the group if its solo-enabled */
3860 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3862 if ((*i) == route) {
3863 /* already changed */
3867 if ((*i)->solo_isolate_control()->solo_isolated() || !(*i)->can_solo()) {
3868 /* route does not get solo propagated to it */
3872 if ((group_already_accounted_for && (*i)->route_group() && (*i)->route_group() == rg)) {
3873 /* this route is a part of the same solo group as the route
3874 * that was changed. Changing that route did change or will
3875 * change all group members appropriately, so we can ignore it
3881 (*i)->solo_control()->set_value (0.0, group_override);
3885 DEBUG_TRACE (DEBUG::Solo, string_compose ("propagate solo change, delta = %1\n", delta));
3887 RouteList uninvolved;
3889 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1\n", route->name()));
3891 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3892 bool via_sends_only;
3893 bool in_signal_flow;
3895 if ((*i) == route) {
3896 /* already changed */
3900 if ((*i)->solo_isolate_control()->solo_isolated() || !(*i)->can_solo()) {
3901 /* route does not get solo propagated to it */
3902 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(),
3907 if ((group_already_accounted_for && (*i)->route_group() && (*i)->route_group() == rg)) {
3908 /* this route is a part of the same solo group as the route
3909 * that was changed. Changing that route did change or will
3910 * change all group members appropriately, so we can ignore it
3916 in_signal_flow = false;
3918 DEBUG_TRACE (DEBUG::Solo, string_compose ("check feed from %1\n", (*i)->name()));
3920 if ((*i)->feeds (route, &via_sends_only)) {
3921 DEBUG_TRACE (DEBUG::Solo, string_compose ("\tthere is a feed from %1\n", (*i)->name()));
3922 if (!via_sends_only) {
3923 if (!route->soloed_by_others_upstream()) {
3924 (*i)->solo_control()->mod_solo_by_others_downstream (delta);
3926 DEBUG_TRACE (DEBUG::Solo, "\talready soloed by others upstream\n");
3929 DEBUG_TRACE (DEBUG::Solo, string_compose ("\tthere is a send-only feed from %1\n", (*i)->name()));
3931 in_signal_flow = true;
3933 DEBUG_TRACE (DEBUG::Solo, string_compose ("\tno feed from %1\n", (*i)->name()));
3936 DEBUG_TRACE (DEBUG::Solo, string_compose ("check feed to %1\n", (*i)->name()));
3938 if (route->feeds (*i, &via_sends_only)) {
3939 /* propagate solo upstream only if routing other than
3940 sends is involved, but do consider the other route
3941 (*i) to be part of the signal flow even if only
3944 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1 feeds %2 via sends only %3 sboD %4 sboU %5\n",
3948 route->soloed_by_others_downstream(),
3949 route->soloed_by_others_upstream()));
3950 if (!via_sends_only) {
3951 //NB. Triggers Invert Push, which handles soloed by downstream
3952 DEBUG_TRACE (DEBUG::Solo, string_compose ("\tmod %1 by %2\n", (*i)->name(), delta));
3953 (*i)->solo_control()->mod_solo_by_others_upstream (delta);
3955 DEBUG_TRACE (DEBUG::Solo, string_compose ("\tfeed to %1 ignored, sends-only\n", (*i)->name()));
3957 in_signal_flow = true;
3959 DEBUG_TRACE (DEBUG::Solo, "\tno feed to\n");
3962 if (!in_signal_flow) {
3963 uninvolved.push_back (*i);
3967 DEBUG_TRACE (DEBUG::Solo, "propagation complete\n");
3969 update_route_solo_state (r);
3971 /* now notify that the mute state of the routes not involved in the signal
3972 pathway of the just-solo-changed route may have altered.
3975 for (RouteList::iterator i = uninvolved.begin(); i != uninvolved.end(); ++i) {
3976 DEBUG_TRACE (DEBUG::Solo, string_compose ("mute change for %1, which neither feeds or is fed by %2\n", (*i)->name(), route->name()));
3977 (*i)->act_on_mute ();
3978 (*i)->mute_control()->Changed (false, Controllable::NoGroup);
3981 SoloChanged (); /* EMIT SIGNAL */
3986 Session::update_route_solo_state (boost::shared_ptr<RouteList> r)
3988 /* now figure out if anything that matters is soloed (or is "listening")*/
3990 bool something_soloed = false;
3991 bool something_listening = false;
3992 uint32_t listeners = 0;
3993 uint32_t isolated = 0;
3996 r = routes.reader();
3999 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4000 if ((*i)->can_solo()) {
4001 if (Config->get_solo_control_is_listen_control()) {
4002 if ((*i)->self_soloed() || (*i)->solo_control()->get_masters_value()) {
4004 something_listening = true;
4007 (*i)->set_listen (false);
4008 if ((*i)->can_solo() && ((*i)->self_soloed() || (*i)->solo_control()->get_masters_value())) {
4009 something_soloed = true;
4014 if ((*i)->solo_isolate_control()->solo_isolated()) {
4019 if (something_soloed != _non_soloed_outs_muted) {
4020 _non_soloed_outs_muted = something_soloed;
4021 SoloActive (_non_soloed_outs_muted); /* EMIT SIGNAL */
4024 if (something_listening != _listening) {
4025 _listening = something_listening;
4026 SoloActive (_listening);
4029 _listen_cnt = listeners;
4031 if (isolated != _solo_isolated_cnt) {
4032 _solo_isolated_cnt = isolated;
4033 IsolatedChanged (); /* EMIT SIGNAL */
4036 DEBUG_TRACE (DEBUG::Solo, string_compose ("solo state updated by session, soloed? %1 listeners %2 isolated %3\n",
4037 something_soloed, listeners, isolated));
4041 Session::get_stripables (StripableList& sl) const
4043 boost::shared_ptr<RouteList> r = routes.reader ();
4044 sl.insert (sl.end(), r->begin(), r->end());
4046 VCAList v = _vca_manager->vcas ();
4047 sl.insert (sl.end(), v.begin(), v.end());
4050 boost::shared_ptr<RouteList>
4051 Session::get_routes_with_internal_returns() const
4053 boost::shared_ptr<RouteList> r = routes.reader ();
4054 boost::shared_ptr<RouteList> rl (new RouteList);
4056 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4057 if ((*i)->internal_return ()) {
4065 Session::io_name_is_legal (const std::string& name) const
4067 boost::shared_ptr<RouteList> r = routes.reader ();
4069 for (vector<string>::const_iterator reserved = reserved_io_names.begin(); reserved != reserved_io_names.end(); ++reserved) {
4070 if (name == *reserved) {
4071 if (!route_by_name (*reserved)) {
4072 /* first instance of a reserved name is allowed */
4075 /* all other instances of a reserved name are not allowed */
4080 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4081 if ((*i)->name() == name) {
4085 if ((*i)->has_io_processor_named (name)) {
4094 Session::set_exclusive_input_active (boost::shared_ptr<RouteList> rl, bool onoff, bool flip_others)
4097 vector<string> connections;
4099 /* if we are passed only a single route and we're not told to turn
4100 * others off, then just do the simple thing.
4103 if (flip_others == false && rl->size() == 1) {
4104 boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (rl->front());
4106 mt->set_input_active (onoff);
4111 for (RouteList::iterator rt = rl->begin(); rt != rl->end(); ++rt) {
4113 PortSet& ps ((*rt)->input()->ports());
4115 for (PortSet::iterator p = ps.begin(); p != ps.end(); ++p) {
4116 p->get_connections (connections);
4119 for (vector<string>::iterator s = connections.begin(); s != connections.end(); ++s) {
4120 routes_using_input_from (*s, rl2);
4123 /* scan all relevant routes to see if others are on or off */
4125 bool others_are_already_on = false;
4127 for (RouteList::iterator r = rl2.begin(); r != rl2.end(); ++r) {
4129 boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (*r);
4135 if ((*r) != (*rt)) {
4136 if (mt->input_active()) {
4137 others_are_already_on = true;
4140 /* this one needs changing */
4141 mt->set_input_active (onoff);
4147 /* globally reverse other routes */
4149 for (RouteList::iterator r = rl2.begin(); r != rl2.end(); ++r) {
4150 if ((*r) != (*rt)) {
4151 boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (*r);
4153 mt->set_input_active (!others_are_already_on);
4162 Session::routes_using_input_from (const string& str, RouteList& rl)
4164 boost::shared_ptr<RouteList> r = routes.reader();
4166 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4167 if ((*i)->input()->connected_to (str)) {
4173 boost::shared_ptr<Route>
4174 Session::route_by_name (string name) const
4176 boost::shared_ptr<RouteList> r = routes.reader ();
4178 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4179 if ((*i)->name() == name) {
4184 return boost::shared_ptr<Route> ((Route*) 0);
4187 boost::shared_ptr<Route>
4188 Session::route_by_id (PBD::ID id) const
4190 boost::shared_ptr<RouteList> r = routes.reader ();
4192 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4193 if ((*i)->id() == id) {
4198 return boost::shared_ptr<Route> ((Route*) 0);
4201 boost::shared_ptr<Processor>
4202 Session::processor_by_id (PBD::ID id) const
4204 boost::shared_ptr<RouteList> r = routes.reader ();
4206 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4207 boost::shared_ptr<Processor> p = (*i)->Route::processor_by_id (id);
4213 return boost::shared_ptr<Processor> ();
4216 boost::shared_ptr<Track>
4217 Session::track_by_diskstream_id (PBD::ID id) const
4219 boost::shared_ptr<RouteList> r = routes.reader ();
4221 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4222 boost::shared_ptr<Track> t = boost::dynamic_pointer_cast<Track> (*i);
4223 if (t && t->using_diskstream_id (id)) {
4228 return boost::shared_ptr<Track> ();
4231 boost::shared_ptr<Route>
4232 Session::get_remote_nth_route (PresentationInfo::order_t n) const
4234 return boost::dynamic_pointer_cast<Route> (get_remote_nth_stripable (n, PresentationInfo::Route));
4237 boost::shared_ptr<Stripable>
4238 Session::get_remote_nth_stripable (PresentationInfo::order_t n, PresentationInfo::Flag flags) const
4241 PresentationInfo::order_t match_cnt = 0;
4243 get_stripables (sl);
4244 sl.sort (Stripable::PresentationOrderSorter());
4246 for (StripableList::const_iterator s = sl.begin(); s != sl.end(); ++s) {
4248 if ((*s)->presentation_info().hidden()) {
4249 /* if the caller didn't explicitly ask for hidden
4250 stripables, ignore hidden ones. This matches
4251 the semantics of the pre-PresentationOrder
4252 "get by RID" logic of Ardour 4.x and earlier.
4254 XXX at some point we should likely reverse
4255 the logic of the flags, because asking for "the
4256 hidden stripables" is not going to be common,
4257 whereas asking for visible ones is normal.
4260 if (! (flags & PresentationInfo::Hidden)) {
4265 if ((*s)->presentation_info().flag_match (flags)) {
4266 if (match_cnt++ == n) {
4272 /* there is no nth stripable that matches the given flags */
4273 return boost::shared_ptr<Stripable>();
4276 boost::shared_ptr<Route>
4277 Session::route_by_selected_count (uint32_t id) const
4279 boost::shared_ptr<RouteList> r = routes.reader ();
4281 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4282 /* NOT IMPLEMENTED */
4285 return boost::shared_ptr<Route> ((Route*) 0);
4288 struct PresentationOrderSorter {
4289 bool operator() (boost::shared_ptr<Stripable> a, boost::shared_ptr<Stripable> b) {
4290 if (a->presentation_info().special() && !b->presentation_info().special()) {
4291 /* a is not ordered, b is; b comes before a */
4293 } else if (!b->presentation_info().order_set() && a->presentation_info().order_set()) {
4294 /* b is not ordered, a is; a comes before b */
4297 return a->presentation_info().order() < b->presentation_info().order();
4303 Session::reassign_track_numbers ()
4307 RouteList r (*(routes.reader ()));
4308 PresentationOrderSorter sorter;
4311 StateProtector sp (this);
4313 for (RouteList::iterator i = r.begin(); i != r.end(); ++i) {
4314 if (boost::dynamic_pointer_cast<Track> (*i)) {
4315 (*i)->set_track_number(++tn);
4317 else if (!(*i)->is_master() && !(*i)->is_monitor() && !(*i)->is_auditioner()) {
4318 (*i)->set_track_number(--bn);
4321 const uint32_t decimals = ceilf (log10f (tn + 1));
4322 const bool decimals_changed = _track_number_decimals != decimals;
4323 _track_number_decimals = decimals;
4325 if (decimals_changed && config.get_track_name_number ()) {
4326 for (RouteList::iterator i = r.begin(); i != r.end(); ++i) {
4327 boost::shared_ptr<Track> t = boost::dynamic_pointer_cast<Track> (*i);
4329 t->resync_track_name();
4332 // trigger GUI re-layout
4333 config.ParameterChanged("track-name-number");
4337 if (DEBUG_ENABLED(DEBUG::OrderKeys)) {
4338 boost::shared_ptr<RouteList> rl = routes.reader ();
4339 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
4340 DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("%1 numbered %2\n", (*i)->name(), (*i)->track_number()));
4348 Session::playlist_region_added (boost::weak_ptr<Region> w)
4350 boost::shared_ptr<Region> r = w.lock ();
4355 /* These are the operations that are currently in progress... */
4356 list<GQuark> curr = _current_trans_quarks;
4359 /* ...and these are the operations during which we want to update
4360 the session range location markers.
4363 ops.push_back (Operations::capture);
4364 ops.push_back (Operations::paste);
4365 ops.push_back (Operations::duplicate_region);
4366 ops.push_back (Operations::insert_file);
4367 ops.push_back (Operations::insert_region);
4368 ops.push_back (Operations::drag_region_brush);
4369 ops.push_back (Operations::region_drag);
4370 ops.push_back (Operations::selection_grab);
4371 ops.push_back (Operations::region_fill);
4372 ops.push_back (Operations::fill_selection);
4373 ops.push_back (Operations::create_region);
4374 ops.push_back (Operations::region_copy);
4375 ops.push_back (Operations::fixed_time_region_copy);
4378 /* See if any of the current operations match the ones that we want */
4380 set_intersection (_current_trans_quarks.begin(), _current_trans_quarks.end(), ops.begin(), ops.end(), back_inserter (in));
4382 /* If so, update the session range markers */
4384 maybe_update_session_range (r->position (), r->last_frame ());
4388 /** Update the session range markers if a is before the current start or
4389 * b is after the current end.
4392 Session::maybe_update_session_range (framepos_t a, framepos_t b)
4394 if (_state_of_the_state & Loading) {
4398 framepos_t session_end_marker_shift_samples = session_end_shift * _nominal_frame_rate;
4400 if (_session_range_location == 0) {
4402 set_session_range_location (a, b + session_end_marker_shift_samples);
4406 if (a < _session_range_location->start()) {
4407 _session_range_location->set_start (a);
4410 if (_session_range_end_is_free && (b > _session_range_location->end())) {
4411 _session_range_location->set_end (b);
4417 Session::set_end_is_free (bool yn)
4419 _session_range_end_is_free = yn;
4423 Session::playlist_ranges_moved (list<Evoral::RangeMove<framepos_t> > const & ranges)
4425 for (list<Evoral::RangeMove<framepos_t> >::const_iterator i = ranges.begin(); i != ranges.end(); ++i) {
4426 maybe_update_session_range (i->to, i->to + i->length);
4431 Session::playlist_regions_extended (list<Evoral::Range<framepos_t> > const & ranges)
4433 for (list<Evoral::Range<framepos_t> >::const_iterator i = ranges.begin(); i != ranges.end(); ++i) {
4434 maybe_update_session_range (i->from, i->to);
4438 /* Region management */
4440 boost::shared_ptr<Region>
4441 Session::find_whole_file_parent (boost::shared_ptr<Region const> child) const
4443 const RegionFactory::RegionMap& regions (RegionFactory::regions());
4444 RegionFactory::RegionMap::const_iterator i;
4445 boost::shared_ptr<Region> region;
4447 Glib::Threads::Mutex::Lock lm (region_lock);
4449 for (i = regions.begin(); i != regions.end(); ++i) {
4453 if (region->whole_file()) {
4455 if (child->source_equivalent (region)) {
4461 return boost::shared_ptr<Region> ();
4465 Session::destroy_sources (list<boost::shared_ptr<Source> > srcs)
4467 set<boost::shared_ptr<Region> > relevant_regions;
4469 for (list<boost::shared_ptr<Source> >::iterator s = srcs.begin(); s != srcs.end(); ++s) {
4470 RegionFactory::get_regions_using_source (*s, relevant_regions);
4473 for (set<boost::shared_ptr<Region> >::iterator r = relevant_regions.begin(); r != relevant_regions.end(); ) {
4474 set<boost::shared_ptr<Region> >::iterator tmp;
4479 playlists->destroy_region (*r);
4480 RegionFactory::map_remove (*r);
4482 (*r)->drop_sources ();
4483 (*r)->drop_references ();
4485 relevant_regions.erase (r);
4490 for (list<boost::shared_ptr<Source> >::iterator s = srcs.begin(); s != srcs.end(); ) {
4493 Glib::Threads::Mutex::Lock ls (source_lock);
4494 /* remove from the main source list */
4495 sources.erase ((*s)->id());
4498 (*s)->mark_for_remove ();
4499 (*s)->drop_references ();
4508 Session::remove_last_capture ()
4510 list<boost::shared_ptr<Source> > srcs;
4512 boost::shared_ptr<RouteList> rl = routes.reader ();
4513 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
4514 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
4519 list<boost::shared_ptr<Source> >& l = tr->last_capture_sources();
4522 srcs.insert (srcs.end(), l.begin(), l.end());
4527 destroy_sources (srcs);
4529 save_state (_current_snapshot_name);
4534 /* Source Management */
4537 Session::add_source (boost::shared_ptr<Source> source)
4539 pair<SourceMap::key_type, SourceMap::mapped_type> entry;
4540 pair<SourceMap::iterator,bool> result;
4542 entry.first = source->id();
4543 entry.second = source;
4546 Glib::Threads::Mutex::Lock lm (source_lock);
4547 result = sources.insert (entry);
4550 if (result.second) {
4552 /* yay, new source */
4554 boost::shared_ptr<FileSource> fs = boost::dynamic_pointer_cast<FileSource> (source);
4557 if (!fs->within_session()) {
4558 ensure_search_path_includes (Glib::path_get_dirname (fs->path()), fs->type());
4564 boost::shared_ptr<AudioFileSource> afs;
4566 if ((afs = boost::dynamic_pointer_cast<AudioFileSource>(source)) != 0) {
4567 if (Config->get_auto_analyse_audio()) {
4568 Analyser::queue_source_for_analysis (source, false);
4572 source->DropReferences.connect_same_thread (*this, boost::bind (&Session::remove_source, this, boost::weak_ptr<Source> (source)));
4577 Session::remove_source (boost::weak_ptr<Source> src)
4579 if (_state_of_the_state & Deletion) {
4583 SourceMap::iterator i;
4584 boost::shared_ptr<Source> source = src.lock();
4591 Glib::Threads::Mutex::Lock lm (source_lock);
4593 if ((i = sources.find (source->id())) != sources.end()) {
4598 if (!(_state_of_the_state & StateOfTheState (InCleanup|Loading))) {
4600 /* save state so we don't end up with a session file
4601 referring to non-existent sources.
4604 save_state (_current_snapshot_name);
4608 boost::shared_ptr<Source>
4609 Session::source_by_id (const PBD::ID& id)
4611 Glib::Threads::Mutex::Lock lm (source_lock);
4612 SourceMap::iterator i;
4613 boost::shared_ptr<Source> source;
4615 if ((i = sources.find (id)) != sources.end()) {
4622 boost::shared_ptr<AudioFileSource>
4623 Session::audio_source_by_path_and_channel (const string& path, uint16_t chn) const
4625 /* Restricted to audio files because only audio sources have channel
4629 Glib::Threads::Mutex::Lock lm (source_lock);
4631 for (SourceMap::const_iterator i = sources.begin(); i != sources.end(); ++i) {
4632 boost::shared_ptr<AudioFileSource> afs
4633 = boost::dynamic_pointer_cast<AudioFileSource>(i->second);
4635 if (afs && afs->path() == path && chn == afs->channel()) {
4640 return boost::shared_ptr<AudioFileSource>();
4643 boost::shared_ptr<MidiSource>
4644 Session::midi_source_by_path (const std::string& path) const
4646 /* Restricted to MIDI files because audio sources require a channel
4647 for unique identification, in addition to a path.
4650 Glib::Threads::Mutex::Lock lm (source_lock);
4652 for (SourceMap::const_iterator s = sources.begin(); s != sources.end(); ++s) {
4653 boost::shared_ptr<MidiSource> ms
4654 = boost::dynamic_pointer_cast<MidiSource>(s->second);
4655 boost::shared_ptr<FileSource> fs
4656 = boost::dynamic_pointer_cast<FileSource>(s->second);
4658 if (ms && fs && fs->path() == path) {
4663 return boost::shared_ptr<MidiSource>();
4667 Session::count_sources_by_origin (const string& path)
4670 Glib::Threads::Mutex::Lock lm (source_lock);
4672 for (SourceMap::iterator i = sources.begin(); i != sources.end(); ++i) {
4673 boost::shared_ptr<FileSource> fs
4674 = boost::dynamic_pointer_cast<FileSource>(i->second);
4676 if (fs && fs->origin() == path) {
4685 peak_file_helper (const string& peak_path, const string& file_path, const string& file_base, bool hash) {
4687 std::string checksum = Glib::Checksum::compute_checksum(Glib::Checksum::CHECKSUM_SHA1, file_path + G_DIR_SEPARATOR + file_base);
4688 return Glib::build_filename (peak_path, checksum + peakfile_suffix);
4690 return Glib::build_filename (peak_path, file_base + peakfile_suffix);
4695 Session::construct_peak_filepath (const string& filepath, const bool in_session, const bool old_peak_name) const
4697 string interchange_dir_string = string (interchange_dir_name) + G_DIR_SEPARATOR;
4699 if (Glib::path_is_absolute (filepath)) {
4701 /* rip the session dir from the audiofile source */
4703 string session_path;
4704 bool in_another_session = true;
4706 if (filepath.find (interchange_dir_string) != string::npos) {
4708 session_path = Glib::path_get_dirname (filepath); /* now ends in audiofiles */
4709 session_path = Glib::path_get_dirname (session_path); /* now ends in session name */
4710 session_path = Glib::path_get_dirname (session_path); /* now ends in interchange */
4711 session_path = Glib::path_get_dirname (session_path); /* now has session path */
4713 /* see if it is within our session */
4715 for (vector<space_and_path>::const_iterator i = session_dirs.begin(); i != session_dirs.end(); ++i) {
4716 if (i->path == session_path) {
4717 in_another_session = false;
4722 in_another_session = false;
4726 if (in_another_session) {
4727 SessionDirectory sd (session_path);
4728 return peak_file_helper (sd.peak_path(), "", Glib::path_get_basename (filepath), !old_peak_name);
4732 /* 1) if file belongs to this session
4733 * it may be a relative path (interchange/...)
4734 * or just basename (session_state, remove source)
4735 * -> just use the basename
4737 std::string filename = Glib::path_get_basename (filepath);
4740 /* 2) if the file is outside our session dir:
4741 * (imported but not copied) add the path for check-summming */
4743 path = Glib::path_get_dirname (filepath);
4746 return peak_file_helper (_session_dir->peak_path(), path, Glib::path_get_basename (filepath), !old_peak_name);
4750 Session::new_audio_source_path_for_embedded (const std::string& path)
4754 * we know that the filename is already unique because it exists
4755 * out in the filesystem.
4757 * However, when we bring it into the session, we could get a
4760 * Eg. two embedded files:
4765 * When merged into session, these collide.
4767 * There will not be a conflict with in-memory sources
4768 * because when the source was created we already picked
4769 * a unique name for it.
4771 * This collision is not likely to be common, but we have to guard
4772 * against it. So, if there is a collision, take the md5 hash of the
4773 * the path, and use that as the filename instead.
4776 SessionDirectory sdir (get_best_session_directory_for_new_audio());
4777 string base = Glib::path_get_basename (path);
4778 string newpath = Glib::build_filename (sdir.sound_path(), base);
4780 if (Glib::file_test (newpath, Glib::FILE_TEST_EXISTS)) {
4784 md5.digestString (path.c_str());
4785 md5.writeToString ();
4786 base = md5.digestChars;
4788 string ext = get_suffix (path);
4795 newpath = Glib::build_filename (sdir.sound_path(), base);
4797 /* if this collides, we're screwed */
4799 if (Glib::file_test (newpath, Glib::FILE_TEST_EXISTS)) {
4800 error << string_compose (_("Merging embedded file %1: name collision AND md5 hash collision!"), path) << endmsg;
4809 /** Return true if there are no audio file sources that use @param name as
4810 * the filename component of their path.
4812 * Return false otherwise.
4814 * This method MUST ONLY be used to check in-session, mono files since it
4815 * hard-codes the channel of the audio file source we are looking for as zero.
4817 * If/when Ardour supports native files in non-mono formats, the logic here
4818 * will need to be revisited.
4821 Session::audio_source_name_is_unique (const string& name)
4823 std::vector<string> sdirs = source_search_path (DataType::AUDIO);
4824 vector<space_and_path>::iterator i;
4825 uint32_t existing = 0;
4827 for (vector<string>::const_iterator i = sdirs.begin(); i != sdirs.end(); ++i) {
4829 /* note that we search *without* the extension so that
4830 we don't end up both "Audio 1-1.wav" and "Audio 1-1.caf"
4831 in the event that this new name is required for
4832 a file format change.
4835 const string spath = *i;
4837 if (matching_unsuffixed_filename_exists_in (spath, name)) {
4842 /* it is possible that we have the path already
4843 * assigned to a source that has not yet been written
4844 * (ie. the write source for a diskstream). we have to
4845 * check this in order to make sure that our candidate
4846 * path isn't used again, because that can lead to
4847 * two Sources point to the same file with different
4848 * notions of their removability.
4852 string possible_path = Glib::build_filename (spath, name);
4854 if (audio_source_by_path_and_channel (possible_path, 0)) {
4860 return (existing == 0);
4864 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)
4867 const string ext = native_header_format_extension (config.get_native_file_header_format(), DataType::AUDIO);
4869 if (Profile->get_trx() && destructive) {
4871 sstr << setfill ('0') << setw (4) << cnt;
4872 sstr << legalized_base;
4874 sstr << legalized_base;
4876 if (take_required || related_exists) {
4888 } else if (nchan > 2) {
4893 /* XXX what? more than 26 channels! */
4904 /** Return a unique name based on \a base for a new internal audio source */
4906 Session::new_audio_source_path (const string& base, uint32_t nchan, uint32_t chan, bool destructive, bool take_required)
4909 string possible_name;
4910 const uint32_t limit = 9999; // arbitrary limit on number of files with the same basic name
4912 bool some_related_source_name_exists = false;
4914 legalized = legalize_for_path (base);
4916 // Find a "version" of the base name that doesn't exist in any of the possible directories.
4918 for (cnt = (destructive ? ++destructive_index : 1); cnt <= limit; ++cnt) {
4920 possible_name = format_audio_source_name (legalized, nchan, chan, destructive, take_required, cnt, some_related_source_name_exists);
4922 if (audio_source_name_is_unique (possible_name)) {
4926 some_related_source_name_exists = true;
4929 error << string_compose(
4930 _("There are already %1 recordings for %2, which I consider too many."),
4931 limit, base) << endmsg;
4933 throw failed_constructor();
4937 /* We've established that the new name does not exist in any session
4938 * directory, so now find out which one we should use for this new
4942 SessionDirectory sdir (get_best_session_directory_for_new_audio());
4944 std::string s = Glib::build_filename (sdir.sound_path(), possible_name);
4949 /** Return a unique name based on `base` for a new internal MIDI source */
4951 Session::new_midi_source_path (const string& base)
4954 char buf[PATH_MAX+1];
4955 const uint32_t limit = 10000;
4957 string possible_path;
4958 string possible_name;
4961 legalized = legalize_for_path (base);
4963 // Find a "version" of the file name that doesn't exist in any of the possible directories.
4964 std::vector<string> sdirs = source_search_path(DataType::MIDI);
4966 /* - the main session folder is the first in the vector.
4967 * - after checking all locations for file-name uniqueness,
4968 * we keep the one from the last iteration as new file name
4969 * - midi files are small and should just be kept in the main session-folder
4971 * -> reverse the array, check main session folder last and use that as location
4974 std::reverse(sdirs.begin(), sdirs.end());
4976 for (cnt = 1; cnt <= limit; ++cnt) {
4978 vector<space_and_path>::iterator i;
4979 uint32_t existing = 0;
4981 for (vector<string>::const_iterator i = sdirs.begin(); i != sdirs.end(); ++i) {
4983 snprintf (buf, sizeof(buf), "%s-%u.mid", legalized.c_str(), cnt);
4984 possible_name = buf;
4986 possible_path = Glib::build_filename (*i, possible_name);
4988 if (Glib::file_test (possible_path, Glib::FILE_TEST_EXISTS)) {
4992 if (midi_source_by_path (possible_path)) {
4997 if (existing == 0) {
5002 error << string_compose(
5003 _("There are already %1 recordings for %2, which I consider too many."),
5004 limit, base) << endmsg;
5010 /* No need to "find best location" for software/app-based RAID, because
5011 MIDI is so small that we always put it in the same place.
5014 return possible_path;
5018 /** Create a new within-session audio source */
5019 boost::shared_ptr<AudioFileSource>
5020 Session::create_audio_source_for_session (size_t n_chans, string const & base, uint32_t chan, bool destructive)
5022 const string path = new_audio_source_path (base, n_chans, chan, destructive, true);
5024 if (!path.empty()) {
5025 return boost::dynamic_pointer_cast<AudioFileSource> (
5026 SourceFactory::createWritable (DataType::AUDIO, *this, path, destructive, frame_rate(), true, true));
5028 throw failed_constructor ();
5032 /** Create a new within-session MIDI source */
5033 boost::shared_ptr<MidiSource>
5034 Session::create_midi_source_for_session (string const & basic_name)
5036 const string path = new_midi_source_path (basic_name);
5038 if (!path.empty()) {
5039 return boost::dynamic_pointer_cast<SMFSource> (
5040 SourceFactory::createWritable (
5041 DataType::MIDI, *this, path, false, frame_rate()));
5043 throw failed_constructor ();
5047 /** Create a new within-session MIDI source */
5048 boost::shared_ptr<MidiSource>
5049 Session::create_midi_source_by_stealing_name (boost::shared_ptr<Track> track)
5051 /* the caller passes in the track the source will be used in,
5052 so that we can keep the numbering sane.
5054 Rationale: a track with the name "Foo" that has had N
5055 captures carried out so far will ALREADY have a write source
5056 named "Foo-N+1.mid" waiting to be used for the next capture.
5058 If we call new_midi_source_name() we will get "Foo-N+2". But
5059 there is no region corresponding to "Foo-N+1", so when
5060 "Foo-N+2" appears in the track, the gap presents the user
5061 with odd behaviour - why did it skip past Foo-N+1?
5063 We could explain this to the user in some odd way, but
5064 instead we rename "Foo-N+1.mid" as "Foo-N+2.mid", and then
5067 If that attempted rename fails, we get "Foo-N+2.mid" anyway.
5070 boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (track);
5072 std::string name = track->steal_write_source_name ();
5075 return boost::shared_ptr<MidiSource>();
5078 /* MIDI files are small, just put them in the first location of the
5079 session source search path.
5082 const string path = Glib::build_filename (source_search_path (DataType::MIDI).front(), name);
5084 return boost::dynamic_pointer_cast<SMFSource> (
5085 SourceFactory::createWritable (
5086 DataType::MIDI, *this, path, false, frame_rate()));
5091 Session::add_playlist (boost::shared_ptr<Playlist> playlist, bool unused)
5093 if (playlist->hidden()) {
5097 playlists->add (playlist);
5100 playlist->release();
5107 Session::remove_playlist (boost::weak_ptr<Playlist> weak_playlist)
5109 if (_state_of_the_state & Deletion) {
5113 boost::shared_ptr<Playlist> playlist (weak_playlist.lock());
5119 playlists->remove (playlist);
5125 Session::set_audition (boost::shared_ptr<Region> r)
5127 pending_audition_region = r;
5128 add_post_transport_work (PostTransportAudition);
5129 _butler->schedule_transport_work ();
5133 Session::audition_playlist ()
5135 SessionEvent* ev = new SessionEvent (SessionEvent::Audition, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
5136 ev->region.reset ();
5142 Session::register_lua_function (
5143 const std::string& name,
5144 const std::string& script,
5145 const LuaScriptParamList& args
5148 Glib::Threads::Mutex::Lock lm (lua_lock);
5150 lua_State* L = lua.getState();
5152 const std::string& bytecode = LuaScripting::get_factory_bytecode (script);
5153 luabridge::LuaRef tbl_arg (luabridge::newTable(L));
5154 for (LuaScriptParamList::const_iterator i = args.begin(); i != args.end(); ++i) {
5155 if ((*i)->optional && !(*i)->is_set) { continue; }
5156 tbl_arg[(*i)->name] = (*i)->value;
5158 (*_lua_add)(name, bytecode, tbl_arg); // throws luabridge::LuaException
5163 Session::unregister_lua_function (const std::string& name)
5165 Glib::Threads::Mutex::Lock lm (lua_lock);
5166 (*_lua_del)(name); // throws luabridge::LuaException
5167 lua.collect_garbage ();
5171 std::vector<std::string>
5172 Session::registered_lua_functions ()
5174 Glib::Threads::Mutex::Lock lm (lua_lock);
5175 std::vector<std::string> rv;
5178 luabridge::LuaRef list ((*_lua_list)());
5179 for (luabridge::Iterator i (list); !i.isNil (); ++i) {
5180 if (!i.key ().isString ()) { assert(0); continue; }
5181 rv.push_back (i.key ().cast<std::string> ());
5183 } catch (luabridge::LuaException const& e) { }
5188 static void _lua_print (std::string s) {
5189 std::cout << "SessionLua: " << s << "\n";
5194 Session::try_run_lua (pframes_t nframes)
5196 if (_n_lua_scripts == 0) return;
5197 Glib::Threads::Mutex::Lock tm (lua_lock, Glib::Threads::TRY_LOCK);
5199 try { (*_lua_run)(nframes); } catch (luabridge::LuaException const& e) { }
5200 lua.collect_garbage_step ();
5205 Session::setup_lua ()
5208 lua.Print.connect (&_lua_print);
5212 "function ArdourSession ()"
5213 " local self = { scripts = {}, instances = {} }"
5215 " local remove = function (n)"
5216 " self.scripts[n] = nil"
5217 " self.instances[n] = nil"
5218 " Session:scripts_changed()" // call back
5221 " local addinternal = function (n, f, a)"
5222 " assert(type(n) == 'string', 'function-name must be string')"
5223 " assert(type(f) == 'function', 'Given script is a not a function')"
5224 " assert(type(a) == 'table' or type(a) == 'nil', 'Given argument is invalid')"
5225 " assert(self.scripts[n] == nil, 'Callback \"'.. n ..'\" already exists.')"
5226 " self.scripts[n] = { ['f'] = f, ['a'] = a }"
5227 " 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"
5228 " 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 }"
5229 " self.instances[n] = load (string.dump(f, true), nil, nil, env)(a)"
5230 " Session:scripts_changed()" // call back
5233 " local add = function (n, b, a)"
5234 " assert(type(b) == 'string', 'ByteCode must be string')"
5235 " load (b)()" // assigns f
5236 " assert(type(f) == 'string', 'Assigned ByteCode must be string')"
5237 " addinternal (n, load(f), a)"
5240 " local run = function (...)"
5241 " for n, s in pairs (self.instances) do"
5242 " local status, err = pcall (s, ...)"
5243 " if not status then"
5244 " print ('fn \"'.. n .. '\": ', err)"
5251 " local cleanup = function ()"
5252 " self.scripts = nil"
5253 " self.instances = nil"
5256 " local list = function ()"
5258 " for n, _ in pairs (self.scripts) do"
5264 " local function basic_serialize (o)"
5265 " if type(o) == \"number\" then"
5266 " return tostring(o)"
5268 " return string.format(\"%q\", o)"
5272 " local function serialize (name, value)"
5273 " local rv = name .. ' = '"
5275 " if type(value) == \"number\" or type(value) == \"string\" or type(value) == \"nil\" then"
5276 " return rv .. basic_serialize(value) .. ' '"
5277 " elseif type(value) == \"table\" then"
5279 " for k,v in pairs(value) do"
5280 " local fieldname = string.format(\"%s[%s]\", name, basic_serialize(k))"
5281 " rv = rv .. serialize(fieldname, v) .. ' '"
5282 " collectgarbage()" // string concatenation allocates a new string :(
5285 " elseif type(value) == \"function\" then"
5286 " return rv .. string.format(\"%q\", string.dump(value, true))"
5288 " error('cannot save a ' .. type(value))"
5293 " local save = function ()"
5294 " return (serialize('scripts', self.scripts))"
5297 " local restore = function (state)"
5298 " self.scripts = {}"
5300 " for n, s in pairs (scripts) do"
5301 " addinternal (n, load(s['f']), s['a'])"
5305 " return { run = run, add = add, remove = remove,"
5306 " list = list, restore = restore, save = save, cleanup = cleanup}"
5309 " sess = ArdourSession ()"
5310 " ArdourSession = nil"
5312 "function ardour () end"
5315 lua_State* L = lua.getState();
5318 luabridge::LuaRef lua_sess = luabridge::getGlobal (L, "sess");
5319 lua.do_command ("sess = nil"); // hide it.
5320 lua.do_command ("collectgarbage()");
5322 _lua_run = new luabridge::LuaRef(lua_sess["run"]);
5323 _lua_add = new luabridge::LuaRef(lua_sess["add"]);
5324 _lua_del = new luabridge::LuaRef(lua_sess["remove"]);
5325 _lua_list = new luabridge::LuaRef(lua_sess["list"]);
5326 _lua_save = new luabridge::LuaRef(lua_sess["save"]);
5327 _lua_load = new luabridge::LuaRef(lua_sess["restore"]);
5328 _lua_cleanup = new luabridge::LuaRef(lua_sess["cleanup"]);
5329 } catch (luabridge::LuaException const& e) {
5330 fatal << string_compose (_("programming error: %1"),
5331 X_("Failed to setup Lua interpreter"))
5333 abort(); /*NOTREACHED*/
5336 LuaBindings::stddef (L);
5337 LuaBindings::common (L);
5338 LuaBindings::dsp (L);
5339 luabridge::push <Session *> (L, this);
5340 lua_setglobal (L, "Session");
5344 Session::scripts_changed ()
5346 assert (!lua_lock.trylock()); // must hold lua_lock
5349 luabridge::LuaRef list ((*_lua_list)());
5351 for (luabridge::Iterator i (list); !i.isNil (); ++i) {
5352 if (!i.key ().isString ()) { assert(0); continue; }
5355 _n_lua_scripts = cnt;
5356 } catch (luabridge::LuaException const& e) {
5357 fatal << string_compose (_("programming error: %1"),
5358 X_("Indexing Lua Session Scripts failed."))
5360 abort(); /*NOTREACHED*/
5365 Session::non_realtime_set_audition ()
5367 assert (pending_audition_region);
5368 auditioner->audition_region (pending_audition_region);
5369 pending_audition_region.reset ();
5370 AuditionActive (true); /* EMIT SIGNAL */
5374 Session::audition_region (boost::shared_ptr<Region> r)
5376 SessionEvent* ev = new SessionEvent (SessionEvent::Audition, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
5382 Session::cancel_audition ()
5387 if (auditioner->auditioning()) {
5388 auditioner->cancel_audition ();
5389 AuditionActive (false); /* EMIT SIGNAL */
5394 Session::RoutePublicOrderSorter::operator() (boost::shared_ptr<Route> a, boost::shared_ptr<Route> b)
5396 if (a->is_monitor()) {
5399 if (b->is_monitor()) {
5402 return a->presentation_info().order() < b->presentation_info().order();
5406 Session::is_auditioning () const
5408 /* can be called before we have an auditioner object */
5410 return auditioner->auditioning();
5417 Session::graph_reordered ()
5419 /* don't do this stuff if we are setting up connections
5420 from a set_state() call or creating new tracks. Ditto for deletion.
5423 if ((_state_of_the_state & (InitialConnecting|Deletion)) || _adding_routes_in_progress || _reconnecting_routes_in_progress || _route_deletion_in_progress) {
5427 /* every track/bus asked for this to be handled but it was deferred because
5428 we were connecting. do it now.
5431 request_input_change_handling ();
5435 /* force all diskstreams to update their capture offset values to
5436 reflect any changes in latencies within the graph.
5439 boost::shared_ptr<RouteList> rl = routes.reader ();
5440 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
5441 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
5443 tr->set_capture_offset ();
5448 /** @return Number of frames that there is disk space available to write,
5451 boost::optional<framecnt_t>
5452 Session::available_capture_duration ()
5454 Glib::Threads::Mutex::Lock lm (space_lock);
5456 if (_total_free_4k_blocks_uncertain) {
5457 return boost::optional<framecnt_t> ();
5460 float sample_bytes_on_disk = 4.0; // keep gcc happy
5462 switch (config.get_native_file_data_format()) {
5464 sample_bytes_on_disk = 4.0;
5468 sample_bytes_on_disk = 3.0;
5472 sample_bytes_on_disk = 2.0;
5476 /* impossible, but keep some gcc versions happy */
5477 fatal << string_compose (_("programming error: %1"),
5478 X_("illegal native file data format"))
5480 abort(); /*NOTREACHED*/
5483 double scale = 4096.0 / sample_bytes_on_disk;
5485 if (_total_free_4k_blocks * scale > (double) max_framecnt) {
5486 return max_framecnt;
5489 return (framecnt_t) floor (_total_free_4k_blocks * scale);
5493 Session::add_bundle (boost::shared_ptr<Bundle> bundle, bool emit_signal)
5496 RCUWriter<BundleList> writer (_bundles);
5497 boost::shared_ptr<BundleList> b = writer.get_copy ();
5498 b->push_back (bundle);
5502 BundleAddedOrRemoved (); /* EMIT SIGNAL */
5509 Session::remove_bundle (boost::shared_ptr<Bundle> bundle)
5511 bool removed = false;
5514 RCUWriter<BundleList> writer (_bundles);
5515 boost::shared_ptr<BundleList> b = writer.get_copy ();
5516 BundleList::iterator i = find (b->begin(), b->end(), bundle);
5518 if (i != b->end()) {
5525 BundleAddedOrRemoved (); /* EMIT SIGNAL */
5531 boost::shared_ptr<Bundle>
5532 Session::bundle_by_name (string name) const
5534 boost::shared_ptr<BundleList> b = _bundles.reader ();
5536 for (BundleList::const_iterator i = b->begin(); i != b->end(); ++i) {
5537 if ((*i)->name() == name) {
5542 return boost::shared_ptr<Bundle> ();
5546 Session::tempo_map_changed (const PropertyChange&)
5550 playlists->update_after_tempo_map_change ();
5552 _locations->apply (*this, &Session::update_locations_after_tempo_map_change);
5558 Session::gui_tempo_map_changed ()
5562 playlists->update_after_tempo_map_change ();
5564 _locations->apply (*this, &Session::update_locations_after_tempo_map_change);
5568 Session::update_locations_after_tempo_map_change (const Locations::LocationList& loc)
5570 for (Locations::LocationList::const_iterator i = loc.begin(); i != loc.end(); ++i) {
5571 (*i)->recompute_frames_from_bbt ();
5575 /** Ensures that all buffers (scratch, send, silent, etc) are allocated for
5576 * the given count with the current block size.
5579 Session::ensure_buffers (ChanCount howmany)
5581 BufferManager::ensure_buffers (howmany, bounce_processing() ? bounce_chunk_size : 0);
5585 Session::ensure_buffer_set(BufferSet& buffers, const ChanCount& count)
5587 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
5588 buffers.ensure_buffers(*t, count.get(*t), _engine.raw_buffer_size(*t));
5593 Session::next_insert_id ()
5595 /* this doesn't really loop forever. just think about it */
5598 for (boost::dynamic_bitset<uint32_t>::size_type n = 1; n < insert_bitset.size(); ++n) {
5599 if (!insert_bitset[n]) {
5600 insert_bitset[n] = true;
5606 /* none available, so resize and try again */
5608 insert_bitset.resize (insert_bitset.size() + 16, false);
5613 Session::next_send_id ()
5615 /* this doesn't really loop forever. just think about it */
5618 for (boost::dynamic_bitset<uint32_t>::size_type n = 1; n < send_bitset.size(); ++n) {
5619 if (!send_bitset[n]) {
5620 send_bitset[n] = true;
5626 /* none available, so resize and try again */
5628 send_bitset.resize (send_bitset.size() + 16, false);
5633 Session::next_aux_send_id ()
5635 /* this doesn't really loop forever. just think about it */
5638 for (boost::dynamic_bitset<uint32_t>::size_type n = 1; n < aux_send_bitset.size(); ++n) {
5639 if (!aux_send_bitset[n]) {
5640 aux_send_bitset[n] = true;
5646 /* none available, so resize and try again */
5648 aux_send_bitset.resize (aux_send_bitset.size() + 16, false);
5653 Session::next_return_id ()
5655 /* this doesn't really loop forever. just think about it */
5658 for (boost::dynamic_bitset<uint32_t>::size_type n = 1; n < return_bitset.size(); ++n) {
5659 if (!return_bitset[n]) {
5660 return_bitset[n] = true;
5666 /* none available, so resize and try again */
5668 return_bitset.resize (return_bitset.size() + 16, false);
5673 Session::mark_send_id (uint32_t id)
5675 if (id >= send_bitset.size()) {
5676 send_bitset.resize (id+16, false);
5678 if (send_bitset[id]) {
5679 warning << string_compose (_("send ID %1 appears to be in use already"), id) << endmsg;
5681 send_bitset[id] = true;
5685 Session::mark_aux_send_id (uint32_t id)
5687 if (id >= aux_send_bitset.size()) {
5688 aux_send_bitset.resize (id+16, false);
5690 if (aux_send_bitset[id]) {
5691 warning << string_compose (_("aux send ID %1 appears to be in use already"), id) << endmsg;
5693 aux_send_bitset[id] = true;
5697 Session::mark_return_id (uint32_t id)
5699 if (id >= return_bitset.size()) {
5700 return_bitset.resize (id+16, false);
5702 if (return_bitset[id]) {
5703 warning << string_compose (_("return ID %1 appears to be in use already"), id) << endmsg;
5705 return_bitset[id] = true;
5709 Session::mark_insert_id (uint32_t id)
5711 if (id >= insert_bitset.size()) {
5712 insert_bitset.resize (id+16, false);
5714 if (insert_bitset[id]) {
5715 warning << string_compose (_("insert ID %1 appears to be in use already"), id) << endmsg;
5717 insert_bitset[id] = true;
5721 Session::unmark_send_id (uint32_t id)
5723 if (id < send_bitset.size()) {
5724 send_bitset[id] = false;
5729 Session::unmark_aux_send_id (uint32_t id)
5731 if (id < aux_send_bitset.size()) {
5732 aux_send_bitset[id] = false;
5737 Session::unmark_return_id (uint32_t id)
5739 if (_state_of_the_state & Deletion) { return; }
5740 if (id < return_bitset.size()) {
5741 return_bitset[id] = false;
5746 Session::unmark_insert_id (uint32_t id)
5748 if (id < insert_bitset.size()) {
5749 insert_bitset[id] = false;
5754 Session::reset_native_file_format ()
5756 boost::shared_ptr<RouteList> rl = routes.reader ();
5758 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
5759 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
5761 /* don't save state as we do this, there's no point
5763 _state_of_the_state = StateOfTheState (_state_of_the_state|InCleanup);
5764 tr->reset_write_sources (false);
5765 _state_of_the_state = StateOfTheState (_state_of_the_state & ~InCleanup);
5771 Session::route_name_unique (string n) const
5773 boost::shared_ptr<RouteList> r = routes.reader ();
5775 for (RouteList::const_iterator i = r->begin(); i != r->end(); ++i) {
5776 if ((*i)->name() == n) {
5785 Session::route_name_internal (string n) const
5787 if (auditioner && auditioner->name() == n) {
5791 if (_click_io && _click_io->name() == n) {
5799 Session::freeze_all (InterThreadInfo& itt)
5801 boost::shared_ptr<RouteList> r = routes.reader ();
5803 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
5805 boost::shared_ptr<Track> t;
5807 if ((t = boost::dynamic_pointer_cast<Track>(*i)) != 0) {
5808 /* XXX this is wrong because itt.progress will keep returning to zero at the start
5818 boost::shared_ptr<Region>
5819 Session::write_one_track (Track& track, framepos_t start, framepos_t end,
5820 bool /*overwrite*/, vector<boost::shared_ptr<Source> >& srcs,
5821 InterThreadInfo& itt,
5822 boost::shared_ptr<Processor> endpoint, bool include_endpoint,
5823 bool for_export, bool for_freeze)
5825 boost::shared_ptr<Region> result;
5826 boost::shared_ptr<Playlist> playlist;
5827 boost::shared_ptr<Source> source;
5828 ChanCount diskstream_channels (track.n_channels());
5829 framepos_t position;
5830 framecnt_t this_chunk;
5832 framepos_t latency_skip;
5834 framepos_t len = end - start;
5835 bool need_block_size_reset = false;
5836 ChanCount const max_proc = track.max_processor_streams ();
5837 string legal_playlist_name;
5838 string possible_path;
5841 error << string_compose (_("Cannot write a range where end <= start (e.g. %1 <= %2)"),
5842 end, start) << endmsg;
5846 diskstream_channels = track.bounce_get_output_streams (diskstream_channels, endpoint,
5847 include_endpoint, for_export, for_freeze);
5849 if (diskstream_channels.n(track.data_type()) < 1) {
5850 error << _("Cannot write a range with no data.") << endmsg;
5854 // block all process callback handling
5856 block_processing ();
5859 // synchronize with AudioEngine::process_callback()
5860 // make sure processing is not currently running
5861 // and processing_blocked() is honored before
5862 // acquiring thread buffers
5863 Glib::Threads::Mutex::Lock lm (_engine.process_lock());
5866 _bounce_processing_active = true;
5868 /* call tree *MUST* hold route_lock */
5870 if ((playlist = track.playlist()) == 0) {
5874 legal_playlist_name = legalize_for_path (playlist->name());
5876 for (uint32_t chan_n = 0; chan_n < diskstream_channels.n(track.data_type()); ++chan_n) {
5878 string base_name = string_compose ("%1-%2-bounce", playlist->name(), chan_n);
5879 string path = ((track.data_type() == DataType::AUDIO)
5880 ? new_audio_source_path (legal_playlist_name, diskstream_channels.n_audio(), chan_n, false, true)
5881 : new_midi_source_path (legal_playlist_name));
5888 source = SourceFactory::createWritable (track.data_type(), *this, path, false, frame_rate());
5891 catch (failed_constructor& err) {
5892 error << string_compose (_("cannot create new file \"%1\" for %2"), path, track.name()) << endmsg;
5896 srcs.push_back (source);
5899 /* tell redirects that care that we are about to use a much larger
5900 * blocksize. this will flush all plugins too, so that they are ready
5901 * to be used for this process.
5904 need_block_size_reset = true;
5905 track.set_block_size (bounce_chunk_size);
5906 _engine.main_thread()->get_buffers ();
5910 latency_skip = track.bounce_get_latency (endpoint, include_endpoint, for_export, for_freeze);
5912 /* create a set of reasonably-sized buffers */
5913 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
5914 buffers.ensure_buffers(*t, max_proc.get(*t), bounce_chunk_size);
5916 buffers.set_count (max_proc);
5918 for (vector<boost::shared_ptr<Source> >::iterator src = srcs.begin(); src != srcs.end(); ++src) {
5919 boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*src);
5920 boost::shared_ptr<MidiSource> ms;
5922 afs->prepare_for_peakfile_writes ();
5923 } else if ((ms = boost::dynamic_pointer_cast<MidiSource>(*src))) {
5924 Source::Lock lock(ms->mutex());
5925 ms->mark_streaming_write_started(lock);
5929 while (to_do && !itt.cancel) {
5931 this_chunk = min (to_do, bounce_chunk_size);
5933 if (track.export_stuff (buffers, start, this_chunk, endpoint, include_endpoint, for_export, for_freeze)) {
5937 start += this_chunk;
5938 to_do -= this_chunk;
5939 itt.progress = (float) (1.0 - ((double) to_do / len));
5941 if (latency_skip >= bounce_chunk_size) {
5942 latency_skip -= bounce_chunk_size;
5946 const framecnt_t current_chunk = this_chunk - latency_skip;
5949 for (vector<boost::shared_ptr<Source> >::iterator src=srcs.begin(); src != srcs.end(); ++src, ++n) {
5950 boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*src);
5951 boost::shared_ptr<MidiSource> ms;
5954 if (afs->write (buffers.get_audio(n).data(latency_skip), current_chunk) != current_chunk) {
5957 } else if ((ms = boost::dynamic_pointer_cast<MidiSource>(*src))) {
5958 Source::Lock lock(ms->mutex());
5960 const MidiBuffer& buf = buffers.get_midi(0);
5961 for (MidiBuffer::const_iterator i = buf.begin(); i != buf.end(); ++i) {
5962 Evoral::Event<framepos_t> ev = *i;
5963 ev.set_time(ev.time() - position);
5964 ms->append_event_frames(lock, ev, ms->timeline_position());
5971 /* post-roll, pick up delayed processor output */
5972 latency_skip = track.bounce_get_latency (endpoint, include_endpoint, for_export, for_freeze);
5974 while (latency_skip && !itt.cancel) {
5975 this_chunk = min (latency_skip, bounce_chunk_size);
5976 latency_skip -= this_chunk;
5978 buffers.silence (this_chunk, 0);
5979 track.bounce_process (buffers, start, this_chunk, endpoint, include_endpoint, for_export, for_freeze);
5982 for (vector<boost::shared_ptr<Source> >::iterator src=srcs.begin(); src != srcs.end(); ++src, ++n) {
5983 boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*src);
5986 if (afs->write (buffers.get_audio(n).data(), this_chunk) != this_chunk) {
5998 xnow = localtime (&now);
6000 for (vector<boost::shared_ptr<Source> >::iterator src=srcs.begin(); src != srcs.end(); ++src) {
6001 boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*src);
6002 boost::shared_ptr<MidiSource> ms;
6005 afs->update_header (position, *xnow, now);
6006 afs->flush_header ();
6007 } else if ((ms = boost::dynamic_pointer_cast<MidiSource>(*src))) {
6008 Source::Lock lock(ms->mutex());
6009 ms->mark_streaming_write_completed(lock);
6013 /* construct a region to represent the bounced material */
6017 plist.add (Properties::start, 0);
6018 plist.add (Properties::length, srcs.front()->length(srcs.front()->timeline_position()));
6019 plist.add (Properties::name, region_name_from_path (srcs.front()->name(), true));
6021 result = RegionFactory::create (srcs, plist);
6027 for (vector<boost::shared_ptr<Source> >::iterator src = srcs.begin(); src != srcs.end(); ++src) {
6028 (*src)->mark_for_remove ();
6029 (*src)->drop_references ();
6033 for (vector<boost::shared_ptr<Source> >::iterator src = srcs.begin(); src != srcs.end(); ++src) {
6034 boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*src);
6037 afs->done_with_peakfile_writes ();
6041 _bounce_processing_active = false;
6043 if (need_block_size_reset) {
6044 _engine.main_thread()->drop_buffers ();
6045 track.set_block_size (get_block_size());
6048 unblock_processing ();
6054 Session::gain_automation_buffer() const
6056 return ProcessThread::gain_automation_buffer ();
6060 Session::trim_automation_buffer() const
6062 return ProcessThread::trim_automation_buffer ();
6066 Session::send_gain_automation_buffer() const
6068 return ProcessThread::send_gain_automation_buffer ();
6072 Session::pan_automation_buffer() const
6074 return ProcessThread::pan_automation_buffer ();
6078 Session::get_silent_buffers (ChanCount count)
6080 return ProcessThread::get_silent_buffers (count);
6084 Session::get_scratch_buffers (ChanCount count, bool silence)
6086 return ProcessThread::get_scratch_buffers (count, silence);
6090 Session::get_noinplace_buffers (ChanCount count)
6092 return ProcessThread::get_noinplace_buffers (count);
6096 Session::get_route_buffers (ChanCount count, bool silence)
6098 return ProcessThread::get_route_buffers (count, silence);
6103 Session::get_mix_buffers (ChanCount count)
6105 return ProcessThread::get_mix_buffers (count);
6109 Session::ntracks () const
6112 boost::shared_ptr<RouteList> r = routes.reader ();
6114 for (RouteList::const_iterator i = r->begin(); i != r->end(); ++i) {
6115 if (boost::dynamic_pointer_cast<Track> (*i)) {
6124 Session::nbusses () const
6127 boost::shared_ptr<RouteList> r = routes.reader ();
6129 for (RouteList::const_iterator i = r->begin(); i != r->end(); ++i) {
6130 if (boost::dynamic_pointer_cast<Track>(*i) == 0) {
6139 Session::add_automation_list(AutomationList *al)
6141 automation_lists[al->id()] = al;
6144 /** @return true if there is at least one record-enabled track, otherwise false */
6146 Session::have_rec_enabled_track () const
6148 return g_atomic_int_get (const_cast<gint*>(&_have_rec_enabled_track)) == 1;
6152 Session::have_rec_disabled_track () const
6154 return g_atomic_int_get (const_cast<gint*>(&_have_rec_disabled_track)) == 1;
6157 /** Update the state of our rec-enabled tracks flag */
6159 Session::update_route_record_state ()
6161 boost::shared_ptr<RouteList> rl = routes.reader ();
6162 RouteList::iterator i = rl->begin();
6163 while (i != rl->end ()) {
6165 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
6166 if (tr && tr->rec_enable_control()->get_value()) {
6173 int const old = g_atomic_int_get (&_have_rec_enabled_track);
6175 g_atomic_int_set (&_have_rec_enabled_track, i != rl->end () ? 1 : 0);
6177 if (g_atomic_int_get (&_have_rec_enabled_track) != old) {
6178 RecordStateChanged (); /* EMIT SIGNAL */
6181 for (i = rl->begin(); i != rl->end (); ++i) {
6182 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
6183 if (tr && !tr->rec_enable_control()->get_value()) {
6188 g_atomic_int_set (&_have_rec_disabled_track, i != rl->end () ? 1 : 0);
6190 bool record_arm_state_changed = (old != g_atomic_int_get (&_have_rec_enabled_track) );
6192 if (record_status() == Recording && record_arm_state_changed ) {
6193 RecordArmStateChanged ();
6199 Session::listen_position_changed ()
6201 boost::shared_ptr<RouteList> r = routes.reader ();
6203 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6204 (*i)->listen_position_changed ();
6209 Session::solo_control_mode_changed ()
6211 if (soloing() || listening()) {
6212 /* We can't use ::clear_all_solo_state() here because during
6213 session loading at program startup, that will queue a call
6214 to rt_clear_all_solo_state() that will not execute until
6215 AFTER solo states have been established (thus throwing away
6216 the session's saved solo state). So just explicitly turn
6219 set_controls (route_list_to_control_list (get_routes(), &Stripable::solo_control), 0.0, Controllable::NoGroup);
6223 /** Called when a property of one of our route groups changes */
6225 Session::route_group_property_changed (RouteGroup* rg)
6227 RouteGroupPropertyChanged (rg); /* EMIT SIGNAL */
6230 /** Called when a route is added to one of our route groups */
6232 Session::route_added_to_route_group (RouteGroup* rg, boost::weak_ptr<Route> r)
6234 RouteAddedToRouteGroup (rg, r);
6237 /** Called when a route is removed from one of our route groups */
6239 Session::route_removed_from_route_group (RouteGroup* rg, boost::weak_ptr<Route> r)
6241 update_route_record_state ();
6242 RouteRemovedFromRouteGroup (rg, r); /* EMIT SIGNAL */
6245 boost::shared_ptr<RouteList>
6246 Session::get_tracks () const
6248 boost::shared_ptr<RouteList> rl = routes.reader ();
6249 boost::shared_ptr<RouteList> tl (new RouteList);
6251 for (RouteList::const_iterator r = rl->begin(); r != rl->end(); ++r) {
6252 if (boost::dynamic_pointer_cast<Track> (*r)) {
6253 if (!(*r)->is_auditioner()) {
6261 boost::shared_ptr<RouteList>
6262 Session::get_routes_with_regions_at (framepos_t const p) const
6264 boost::shared_ptr<RouteList> r = routes.reader ();
6265 boost::shared_ptr<RouteList> rl (new RouteList);
6267 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6268 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
6273 boost::shared_ptr<Playlist> pl = tr->playlist ();
6278 if (pl->has_region_at (p)) {
6287 Session::goto_end ()
6289 if (_session_range_location) {
6290 request_locate (_session_range_location->end(), false);
6292 request_locate (0, false);
6297 Session::goto_start ()
6299 if (_session_range_location) {
6300 request_locate (_session_range_location->start(), false);
6302 request_locate (0, false);
6307 Session::current_start_frame () const
6309 return _session_range_location ? _session_range_location->start() : 0;
6313 Session::current_end_frame () const
6315 return _session_range_location ? _session_range_location->end() : 0;
6319 Session::set_session_range_location (framepos_t start, framepos_t end)
6321 _session_range_location = new Location (*this, start, end, _("session"), Location::IsSessionRange);
6322 _locations->add (_session_range_location);
6326 Session::step_edit_status_change (bool yn)
6332 send = (_step_editors == 0);
6337 send = (_step_editors == 1);
6340 if (_step_editors > 0) {
6346 StepEditStatusChange (val);
6352 Session::start_time_changed (framepos_t old)
6354 /* Update the auto loop range to match the session range
6355 (unless the auto loop range has been changed by the user)
6358 Location* s = _locations->session_range_location ();
6363 Location* l = _locations->auto_loop_location ();
6365 if (l && l->start() == old) {
6366 l->set_start (s->start(), true);
6371 Session::end_time_changed (framepos_t old)
6373 /* Update the auto loop range to match the session range
6374 (unless the auto loop range has been changed by the user)
6377 Location* s = _locations->session_range_location ();
6382 Location* l = _locations->auto_loop_location ();
6384 if (l && l->end() == old) {
6385 l->set_end (s->end(), true);
6389 std::vector<std::string>
6390 Session::source_search_path (DataType type) const
6394 if (session_dirs.size() == 1) {
6396 case DataType::AUDIO:
6397 sp.push_back (_session_dir->sound_path());
6399 case DataType::MIDI:
6400 sp.push_back (_session_dir->midi_path());
6404 for (vector<space_and_path>::const_iterator i = session_dirs.begin(); i != session_dirs.end(); ++i) {
6405 SessionDirectory sdir (i->path);
6407 case DataType::AUDIO:
6408 sp.push_back (sdir.sound_path());
6410 case DataType::MIDI:
6411 sp.push_back (sdir.midi_path());
6417 if (type == DataType::AUDIO) {
6418 const string sound_path_2X = _session_dir->sound_path_2X();
6419 if (Glib::file_test (sound_path_2X, Glib::FILE_TEST_EXISTS|Glib::FILE_TEST_IS_DIR)) {
6420 if (find (sp.begin(), sp.end(), sound_path_2X) == sp.end()) {
6421 sp.push_back (sound_path_2X);
6426 // now check the explicit (possibly user-specified) search path
6429 case DataType::AUDIO:
6430 sp += Searchpath(config.get_audio_search_path ());
6432 case DataType::MIDI:
6433 sp += Searchpath(config.get_midi_search_path ());
6441 Session::ensure_search_path_includes (const string& path, DataType type)
6450 case DataType::AUDIO:
6451 sp += Searchpath(config.get_audio_search_path ());
6453 case DataType::MIDI:
6454 sp += Searchpath (config.get_midi_search_path ());
6458 for (vector<std::string>::iterator i = sp.begin(); i != sp.end(); ++i) {
6459 /* No need to add this new directory if it has the same inode as
6460 an existing one; checking inode rather than name prevents duplicated
6461 directories when we are using symlinks.
6463 On Windows, I think we could just do if (*i == path) here.
6465 if (PBD::equivalent_paths (*i, path)) {
6473 case DataType::AUDIO:
6474 config.set_audio_search_path (sp.to_string());
6476 case DataType::MIDI:
6477 config.set_midi_search_path (sp.to_string());
6483 Session::remove_dir_from_search_path (const string& dir, DataType type)
6488 case DataType::AUDIO:
6489 sp = Searchpath(config.get_audio_search_path ());
6491 case DataType::MIDI:
6492 sp = Searchpath (config.get_midi_search_path ());
6499 case DataType::AUDIO:
6500 config.set_audio_search_path (sp.to_string());
6502 case DataType::MIDI:
6503 config.set_midi_search_path (sp.to_string());
6509 boost::shared_ptr<Speakers>
6510 Session::get_speakers()
6516 Session::unknown_processors () const
6520 boost::shared_ptr<RouteList> r = routes.reader ();
6521 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6522 list<string> t = (*i)->unknown_processors ();
6523 copy (t.begin(), t.end(), back_inserter (p));
6533 Session::update_latency (bool playback)
6536 DEBUG_TRACE (DEBUG::Latency, string_compose ("JACK latency callback: %1\n", (playback ? "PLAYBACK" : "CAPTURE")));
6538 if ((_state_of_the_state & (InitialConnecting|Deletion)) || _adding_routes_in_progress || _route_deletion_in_progress) {
6542 boost::shared_ptr<RouteList> r = routes.reader ();
6543 framecnt_t max_latency = 0;
6546 /* reverse the list so that we work backwards from the last route to run to the first */
6547 RouteList* rl = routes.reader().get();
6548 r.reset (new RouteList (*rl));
6549 reverse (r->begin(), r->end());
6552 /* compute actual latency values for the given direction and store them all in per-port
6553 structures. this will also publish the same values (to JACK) so that computation of latency
6554 for routes can consistently use public latency values.
6557 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6558 max_latency = max (max_latency, (*i)->set_private_port_latencies (playback));
6561 /* because we latency compensate playback, our published playback latencies should
6562 be the same for all output ports - all material played back by ardour has
6563 the same latency, whether its caused by plugins or by latency compensation. since
6564 these may differ from the values computed above, reset all playback port latencies
6568 DEBUG_TRACE (DEBUG::Latency, string_compose ("Set public port latencies to %1\n", max_latency));
6570 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6571 (*i)->set_public_port_latencies (max_latency, playback);
6576 post_playback_latency ();
6580 post_capture_latency ();
6583 DEBUG_TRACE (DEBUG::Latency, "JACK latency callback: DONE\n");
6587 Session::post_playback_latency ()
6589 set_worst_playback_latency ();
6591 boost::shared_ptr<RouteList> r = routes.reader ();
6593 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6594 if (!(*i)->is_auditioner() && ((*i)->active())) {
6595 _worst_track_latency = max (_worst_track_latency, (*i)->update_signal_latency ());
6599 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6600 (*i)->set_latency_compensation (_worst_track_latency);
6605 Session::post_capture_latency ()
6607 set_worst_capture_latency ();
6609 /* reflect any changes in capture latencies into capture offsets
6612 boost::shared_ptr<RouteList> rl = routes.reader();
6613 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
6614 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
6616 tr->set_capture_offset ();
6622 Session::initialize_latencies ()
6625 Glib::Threads::Mutex::Lock lm (_engine.process_lock());
6626 update_latency (false);
6627 update_latency (true);
6630 set_worst_io_latencies ();
6634 Session::set_worst_io_latencies ()
6636 set_worst_playback_latency ();
6637 set_worst_capture_latency ();
6641 Session::set_worst_playback_latency ()
6643 if (_state_of_the_state & (InitialConnecting|Deletion)) {
6647 _worst_output_latency = 0;
6649 if (!_engine.connected()) {
6653 boost::shared_ptr<RouteList> r = routes.reader ();
6655 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6656 _worst_output_latency = max (_worst_output_latency, (*i)->output()->latency());
6659 DEBUG_TRACE (DEBUG::Latency, string_compose ("Worst output latency: %1\n", _worst_output_latency));
6663 Session::set_worst_capture_latency ()
6665 if (_state_of_the_state & (InitialConnecting|Deletion)) {
6669 _worst_input_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_input_latency = max (_worst_input_latency, (*i)->input()->latency());
6681 DEBUG_TRACE (DEBUG::Latency, string_compose ("Worst input latency: %1\n", _worst_input_latency));
6685 Session::update_latency_compensation (bool force_whole_graph)
6687 bool some_track_latency_changed = false;
6689 if (_state_of_the_state & (InitialConnecting|Deletion)) {
6693 DEBUG_TRACE(DEBUG::Latency, "---------------------------- update latency compensation\n\n");
6695 _worst_track_latency = 0;
6697 boost::shared_ptr<RouteList> r = routes.reader ();
6699 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6700 if (!(*i)->is_auditioner() && ((*i)->active())) {
6702 if ((*i)->signal_latency () != (tl = (*i)->update_signal_latency ())) {
6703 some_track_latency_changed = true;
6705 _worst_track_latency = max (tl, _worst_track_latency);
6709 DEBUG_TRACE (DEBUG::Latency, string_compose ("worst signal processing latency: %1 (changed ? %2)\n", _worst_track_latency,
6710 (some_track_latency_changed ? "yes" : "no")));
6712 DEBUG_TRACE(DEBUG::Latency, "---------------------------- DONE update latency compensation\n\n");
6714 if (some_track_latency_changed || force_whole_graph) {
6715 _engine.update_latencies ();
6719 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6720 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
6724 tr->set_capture_offset ();
6729 Session::session_name_is_legal (const string& path)
6731 char illegal_chars[] = { '/', '\\', ':', ';', '\0' };
6733 for (int i = 0; illegal_chars[i]; ++i) {
6734 if (path.find (illegal_chars[i]) != string::npos) {
6735 return illegal_chars[i];
6743 Session::notify_presentation_info_change ()
6745 if (deletion_in_progress()) {
6749 PresentationInfo::Change (); /* EMIT SIGNAL */
6750 reassign_track_numbers();
6752 #ifdef USE_TRACKS_CODE_FEATURES
6753 /* Waves Tracks: for Waves Tracks session it's required to reconnect their IOs
6754 * if track order has been changed by user
6756 reconnect_existing_routes(true, true);
6762 Session::operation_in_progress (GQuark op) const
6764 return (find (_current_trans_quarks.begin(), _current_trans_quarks.end(), op) != _current_trans_quarks.end());
6767 boost::shared_ptr<Port>
6768 Session::ltc_input_port () const
6770 return _ltc_input->nth (0);
6773 boost::shared_ptr<Port>
6774 Session::ltc_output_port () const
6776 return _ltc_output->nth (0);
6780 Session::reconnect_ltc_input ()
6784 string src = Config->get_ltc_source_port();
6786 _ltc_input->disconnect (this);
6788 if (src != _("None") && !src.empty()) {
6789 _ltc_input->nth (0)->connect (src);
6792 if ( ARDOUR::Profile->get_trx () ) {
6793 // Tracks need this signal to update timecode_source_dropdown
6794 MtcOrLtcInputPortChanged (); //emit signal
6800 Session::reconnect_ltc_output ()
6804 string src = Config->get_ltc_output_port();
6806 _ltc_output->disconnect (this);
6808 if (src != _("None") && !src.empty()) {
6809 _ltc_output->nth (0)->connect (src);
6815 Session::set_range_selection (framepos_t start, framepos_t end)
6817 _range_selection = Evoral::Range<framepos_t> (start, end);
6818 #ifdef USE_TRACKS_CODE_FEATURES
6819 follow_playhead_priority ();
6824 Session::set_object_selection (framepos_t start, framepos_t end)
6826 _object_selection = Evoral::Range<framepos_t> (start, end);
6827 #ifdef USE_TRACKS_CODE_FEATURES
6828 follow_playhead_priority ();
6833 Session::clear_range_selection ()
6835 _range_selection = Evoral::Range<framepos_t> (-1,-1);
6836 #ifdef USE_TRACKS_CODE_FEATURES
6837 follow_playhead_priority ();
6842 Session::clear_object_selection ()
6844 _object_selection = Evoral::Range<framepos_t> (-1,-1);
6845 #ifdef USE_TRACKS_CODE_FEATURES
6846 follow_playhead_priority ();
6851 Session::auto_connect_route (boost::shared_ptr<Route> route, bool connect_inputs,
6852 const ChanCount& input_start,
6853 const ChanCount& output_start,
6854 const ChanCount& input_offset,
6855 const ChanCount& output_offset)
6857 Glib::Threads::Mutex::Lock lx (_auto_connect_queue_lock);
6858 _auto_connect_queue.push (AutoConnectRequest (route, connect_inputs,
6859 input_start, output_start,
6860 input_offset, output_offset));
6862 if (pthread_mutex_trylock (&_auto_connect_mutex) == 0) {
6863 pthread_cond_signal (&_auto_connect_cond);
6864 pthread_mutex_unlock (&_auto_connect_mutex);
6869 Session::queue_latency_recompute ()
6871 g_atomic_int_inc (&_latency_recompute_pending);
6872 if (pthread_mutex_trylock (&_auto_connect_mutex) == 0) {
6873 pthread_cond_signal (&_auto_connect_cond);
6874 pthread_mutex_unlock (&_auto_connect_mutex);
6879 Session::auto_connect (const AutoConnectRequest& ar)
6881 boost::shared_ptr<Route> route = ar.route.lock();
6883 if (!route) { return; }
6885 if (!IO::connecting_legal) {
6889 /* If both inputs and outputs are auto-connected to physical ports,
6890 * use the max of input and output offsets to ensure auto-connected
6891 * port numbers always match up (e.g. the first audio input and the
6892 * first audio output of the route will have the same physical
6893 * port number). Otherwise just use the lowest input or output
6897 const bool in_out_physical =
6898 (Config->get_input_auto_connect() & AutoConnectPhysical)
6899 && (Config->get_output_auto_connect() & AutoConnectPhysical)
6900 && ar.connect_inputs;
6902 const ChanCount in_offset = in_out_physical
6903 ? ChanCount::max(ar.input_offset, ar.output_offset)
6906 const ChanCount out_offset = in_out_physical
6907 ? ChanCount::max(ar.input_offset, ar.output_offset)
6910 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
6911 vector<string> physinputs;
6912 vector<string> physoutputs;
6914 _engine.get_physical_outputs (*t, physoutputs);
6915 _engine.get_physical_inputs (*t, physinputs);
6917 if (!physinputs.empty() && ar.connect_inputs) {
6918 uint32_t nphysical_in = physinputs.size();
6920 for (uint32_t i = ar.input_start.get(*t); i < route->n_inputs().get(*t) && i < nphysical_in; ++i) {
6923 if (Config->get_input_auto_connect() & AutoConnectPhysical) {
6924 port = physinputs[(in_offset.get(*t) + i) % nphysical_in];
6927 if (!port.empty() && route->input()->connect (route->input()->ports().port(*t, i), port, this)) {
6933 if (!physoutputs.empty()) {
6934 uint32_t nphysical_out = physoutputs.size();
6935 for (uint32_t i = ar.output_start.get(*t); i < route->n_outputs().get(*t); ++i) {
6939 * do not create new connections if we reached the limit of physical outputs
6942 if (!(Config->get_output_auto_connect() & AutoConnectMaster) &&
6943 ARDOUR::Profile->get_trx () &&
6944 ar.output_offset.get(*t) == nphysical_out ) {
6948 if ((*t) == DataType::MIDI && (Config->get_output_auto_connect() & AutoConnectPhysical)) {
6949 port = physoutputs[(out_offset.get(*t) + i) % nphysical_out];
6950 } else if ((*t) == DataType::AUDIO && (Config->get_output_auto_connect() & AutoConnectMaster)) {
6951 /* master bus is audio only */
6952 if (_master_out && _master_out->n_inputs().get(*t) > 0) {
6953 port = _master_out->input()->ports().port(*t,
6954 i % _master_out->input()->n_ports().get(*t))->name();
6958 if (!port.empty() && route->output()->connect (route->output()->ports().port(*t, i), port, this)) {
6967 Session::auto_connect_thread_start ()
6969 if (_ac_thread_active) {
6973 while (!_auto_connect_queue.empty ()) {
6974 _auto_connect_queue.pop ();
6977 _ac_thread_active = true;
6978 if (pthread_create (&_auto_connect_thread, NULL, auto_connect_thread, this)) {
6979 _ac_thread_active = false;
6984 Session::auto_connect_thread_terminate ()
6986 if (!_ac_thread_active) {
6989 _ac_thread_active = false;
6992 Glib::Threads::Mutex::Lock lx (_auto_connect_queue_lock);
6993 while (!_auto_connect_queue.empty ()) {
6994 _auto_connect_queue.pop ();
6998 if (pthread_mutex_lock (&_auto_connect_mutex) == 0) {
6999 pthread_cond_signal (&_auto_connect_cond);
7000 pthread_mutex_unlock (&_auto_connect_mutex);
7004 pthread_join (_auto_connect_thread, &status);
7008 Session::auto_connect_thread (void *arg)
7010 Session *s = static_cast<Session *>(arg);
7011 s->auto_connect_thread_run ();
7017 Session::auto_connect_thread_run ()
7019 pthread_set_name (X_("autoconnect"));
7020 SessionEvent::create_per_thread_pool (X_("autoconnect"), 1024);
7021 PBD::notify_event_loops_about_thread_creation (pthread_self(), X_("autoconnect"), 1024);
7022 pthread_mutex_lock (&_auto_connect_mutex);
7023 while (_ac_thread_active) {
7025 if (!_auto_connect_queue.empty ()) {
7026 // Why would we need the process lock ??
7027 // A: if ports are added while we're connecting, the backend's iterator may be invalidated:
7028 // graph_order_callback() -> resort_routes() -> direct_feeds_according_to_reality () -> backend::connected_to()
7029 // All ardour-internal backends use a std::vector xxxAudioBackend::find_port()
7030 // We have control over those, but what does jack do?
7031 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
7033 Glib::Threads::Mutex::Lock lx (_auto_connect_queue_lock);
7034 while (!_auto_connect_queue.empty ()) {
7035 const AutoConnectRequest ar (_auto_connect_queue.front());
7036 _auto_connect_queue.pop ();
7043 if (!actively_recording ()) { // might not be needed,
7044 /* this is only used for updating plugin latencies, the
7045 * graph does not change. so it's safe in general.
7047 * .. update_latency_compensation () entails set_capture_offset()
7048 * which calls Diskstream::set_capture_offset () which
7049 * modifies the capture offset... which can be a proplem
7050 * in "prepare_to_stop"
7052 while (g_atomic_int_and (&_latency_recompute_pending, 0)) {
7053 update_latency_compensation ();
7057 pthread_cond_wait (&_auto_connect_cond, &_auto_connect_mutex);
7059 pthread_mutex_unlock (&_auto_connect_mutex);
7063 Session::cancel_all_solo ()
7067 get_stripables (sl);
7069 set_controls (stripable_list_to_control_list (sl, &Stripable::solo_control), 0.0, Controllable::NoGroup);
7070 clear_all_solo_state (routes.reader());