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"
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)
183 , _transport_speed (0)
184 , _default_transport_speed (1.0)
185 , _last_transport_speed (0)
186 , _target_transport_speed (0.0)
187 , auto_play_legal (false)
188 , _last_slave_transport_frame (0)
189 , maximum_output_latency (0)
190 , _requested_return_frame (-1)
191 , current_block_size (0)
192 , _worst_output_latency (0)
193 , _worst_input_latency (0)
194 , _worst_track_latency (0)
195 , _have_captured (false)
196 , _non_soloed_outs_muted (false)
199 , _solo_isolated_cnt (0)
201 , _was_seamless (Config->get_seamless_loop ())
202 , _under_nsm_control (false)
204 , delta_accumulator_cnt (0)
205 , average_slave_delta (1800) // !!! why 1800 ???
207 , have_first_delta_accumulator (false)
208 , _slave_state (Stopped)
209 , _mtc_active (false)
210 , _ltc_active (false)
211 , post_export_sync (false)
212 , post_export_position (0)
214 , _export_rolling (false)
215 , _export_preroll (0)
216 , _export_latency (0)
217 , _pre_export_mmc_enabled (false)
218 , _name (snapshot_name)
220 , _send_qf_mtc (false)
221 , _pframes_since_last_mtc (0)
222 , session_midi_feedback (0)
224 , loop_changing (false)
226 , _session_dir (new SessionDirectory (fullpath))
227 , _current_snapshot_name (snapshot_name)
229 , state_was_pending (false)
230 , _state_of_the_state (StateOfTheState(CannotSave|InitialConnecting|Loading))
232 , _save_queued (false)
233 , _last_roll_location (0)
234 , _last_roll_or_reversal_location (0)
235 , _last_record_location (0)
236 , pending_locate_roll (false)
237 , pending_locate_frame (0)
238 , pending_locate_flush (false)
239 , pending_abort (false)
240 , pending_auto_loop (false)
241 , _mempool ("Session", 2097152)
242 , lua (lua_newstate (&PBD::ReallocPool::lalloc, &_mempool))
244 , _butler (new Butler (*this))
245 , _post_transport_work (0)
246 , cumulative_rf_motion (0)
248 , _locations (new Locations (*this))
249 , _ignore_skips_updates (false)
250 , _rt_thread_active (false)
251 , _rt_emit_pending (false)
252 , _ac_thread_active (false)
253 , _latency_recompute_pending (0)
255 , outbound_mtc_timecode_frame (0)
256 , next_quarter_frame_to_send (-1)
257 , _frames_per_timecode_frame (0)
258 , _frames_per_hour (0)
259 , _timecode_frames_per_hour (0)
260 , last_timecode_valid (false)
261 , last_timecode_when (0)
262 , _send_timecode_update (false)
274 , ltc_timecode_offset (0)
275 , ltc_timecode_negative_offset (false)
276 , midi_control_ui (0)
278 , _all_route_group (new RouteGroup (*this, "all"))
279 , routes (new RouteList)
280 , _adding_routes_in_progress (false)
281 , _reconnecting_routes_in_progress (false)
282 , _route_deletion_in_progress (false)
283 , destructive_index (0)
284 , _track_number_decimals(1)
285 , default_fade_steepness (0)
286 , default_fade_msecs (0)
287 , _total_free_4k_blocks (0)
288 , _total_free_4k_blocks_uncertain (false)
289 , no_questions_about_missing_files (false)
292 , _bundles (new BundleList)
293 , _bundle_xml_node (0)
297 , click_emphasis_data (0)
299 , click_emphasis_length (0)
300 , _clicks_cleared (0)
301 , _play_range (false)
302 , _range_selection (-1,-1)
303 , _object_selection (-1,-1)
305 , first_file_data_format_reset (true)
306 , first_file_header_format_reset (true)
307 , have_looped (false)
308 , _have_rec_enabled_track (false)
309 , _have_rec_disabled_track (true)
311 , _suspend_timecode_transmission (0)
312 , _speakers (new Speakers)
313 , ignore_route_processor_changes (false)
318 , _vca_manager (new VCAManager (*this))
322 created_with = string_compose ("%1 %2", PROGRAM_NAME, revision);
324 pthread_mutex_init (&_rt_emit_mutex, 0);
325 pthread_cond_init (&_rt_emit_cond, 0);
327 pthread_mutex_init (&_auto_connect_mutex, 0);
328 pthread_cond_init (&_auto_connect_cond, 0);
330 init_name_id_counter (1); // reset for new sessions, start at 1
331 VCA::set_next_vca_number (1); // reset for new sessions, start at 1
333 pre_engine_init (fullpath);
339 Stateful::loading_state_version = CURRENT_SESSION_FILE_VERSION;
341 #ifdef USE_TRACKS_CODE_FEATURES
342 sr = EngineStateController::instance()->get_current_sample_rate();
344 if (ensure_engine (sr, true)) {
346 throw SessionException (_("Cannot connect to audio/midi engine"));
349 // set samplerate for plugins added early
350 // e.g from templates or MB channelstrip
351 set_block_size (_engine.samples_per_cycle());
352 set_frame_rate (_engine.sample_rate());
354 if (create (mix_template, bus_profile)) {
356 throw SessionException (_("Session initialization failed"));
359 /* if a mix template was provided, then ::create() will
360 * have copied it into the session and we need to load it
361 * so that we have the state ready for ::set_state()
362 * after the engine is started.
364 * Note that we do NOT try to get the sample rate from
365 * the template at this time, though doing so would
366 * be easy if we decided this was an appropriate part
370 if (!mix_template.empty()) {
371 if (load_state (_current_snapshot_name)) {
372 throw SessionException (_("Failed to load template/snapshot state"));
374 store_recent_templates (mix_template);
377 /* load default session properties - if any */
382 if (load_state (_current_snapshot_name)) {
383 throw SessionException (_("Failed to load state"));
386 /* try to get sample rate from XML state so that we
387 * can influence the SR if we set up the audio
392 XMLProperty const * prop;
393 XMLNode const * root (state_tree->root());
394 if ((prop = root->property (X_("sample-rate"))) != 0) {
395 sr = atoi (prop->value());
399 if (ensure_engine (sr, false)) {
401 throw SessionException (_("Cannot connect to audio/midi engine"));
405 if (post_engine_init ()) {
407 throw SessionException (_("Cannot configure audio/midi engine with session parameters"));
410 store_recent_sessions (_name, _path);
412 bool was_dirty = dirty();
414 _state_of_the_state = StateOfTheState (_state_of_the_state & ~Dirty);
416 Config->ParameterChanged.connect_same_thread (*this, boost::bind (&Session::config_changed, this, _1, false));
417 config.ParameterChanged.connect_same_thread (*this, boost::bind (&Session::config_changed, this, _1, true));
420 DirtyChanged (); /* EMIT SIGNAL */
423 StartTimeChanged.connect_same_thread (*this, boost::bind (&Session::start_time_changed, this, _1));
424 EndTimeChanged.connect_same_thread (*this, boost::bind (&Session::end_time_changed, this, _1));
426 emit_thread_start ();
427 auto_connect_thread_start ();
429 /* hook us up to the engine since we are now completely constructed */
431 BootMessage (_("Connect to engine"));
433 _engine.set_session (this);
434 _engine.reset_timebase ();
436 #ifdef USE_TRACKS_CODE_FEATURES
438 EngineStateController::instance()->set_session(this);
441 if ( ARDOUR::Profile->get_trx () ) {
443 /* Waves Tracks: fill session with tracks basing on the amount of inputs.
444 * each available input must have corresponding track when session starts.
447 uint32_t how_many (0);
449 std::vector<std::string> inputs;
450 EngineStateController::instance()->get_physical_audio_inputs(inputs);
452 how_many = inputs.size();
454 list<boost::shared_ptr<AudioTrack> > tracks;
456 // Track names after driver
457 if (Config->get_tracks_auto_naming() == NameAfterDriver) {
458 string track_name = "";
459 for (std::vector<string>::size_type i = 0; i < inputs.size(); ++i) {
461 track_name = inputs[i];
462 replace_all (track_name, "system:capture", "");
464 list<boost::shared_ptr<AudioTrack> > single_track = new_audio_track (1, 1, Normal, 0, 1, track_name);
465 tracks.insert(tracks.begin(), single_track.front());
467 } else { // Default track names
468 tracks = new_audio_track (1, 1, Normal, 0, how_many, string());
471 if (tracks.size() != how_many) {
473 throw failed_constructor ();
482 BootMessage (_("Session loading complete"));
494 Session::next_name_id ()
496 return g_atomic_int_add (&_name_id_counter, 1);
500 Session::name_id_counter ()
502 return g_atomic_int_get (&_name_id_counter);
506 Session::init_name_id_counter (guint n)
508 g_atomic_int_set (&_name_id_counter, n);
512 Session::ensure_engine (uint32_t desired_sample_rate, bool isnew)
514 if (_engine.current_backend() == 0) {
515 /* backend is unknown ... */
516 boost::optional<int> r = AudioEngineSetupRequired (desired_sample_rate);
517 if (r.get_value_or (-1) != 0) {
520 } else if (!isnew && _engine.running() && _engine.sample_rate () == desired_sample_rate) {
522 } else if (_engine.setup_required()) {
523 /* backend is known, but setup is needed */
524 boost::optional<int> r = AudioEngineSetupRequired (desired_sample_rate);
525 if (r.get_value_or (-1) != 0) {
528 } else if (!_engine.running()) {
529 if (_engine.start()) {
534 /* at this point the engine should be running */
536 if (!_engine.running()) {
540 return immediately_post_engine ();
545 Session::immediately_post_engine ()
547 /* Do various initializations that should take place directly after we
548 * know that the engine is running, but before we either create a
549 * session or set state for an existing one.
552 if (how_many_dsp_threads () > 1) {
553 /* For now, only create the graph if we are using >1 DSP threads, as
554 it is a bit slower than the old code with 1 thread.
556 _process_graph.reset (new Graph (*this));
559 /* every time we reconnect, recompute worst case output latencies */
561 _engine.Running.connect_same_thread (*this, boost::bind (&Session::initialize_latencies, this));
563 if (synced_to_engine()) {
564 _engine.transport_stop ();
567 if (config.get_jack_time_master()) {
568 _engine.transport_locate (_transport_frame);
573 BootMessage (_("Set up LTC"));
575 BootMessage (_("Set up Click"));
577 BootMessage (_("Set up standard connections"));
581 catch (failed_constructor& err) {
585 /* TODO, connect in different thread. (PortRegisteredOrUnregistered may be in RT context)
587 _engine.PortRegisteredOrUnregistered.connect_same_thread (*this, boost::bind (&Session::setup_bundles, this));
595 vector<void*> debug_pointers;
597 /* if we got to here, leaving pending capture state around
601 remove_pending_capture_state ();
605 _state_of_the_state = StateOfTheState (CannotSave|Deletion);
607 /* stop autoconnecting */
608 auto_connect_thread_terminate ();
610 /* disconnect from any and all signals that we are connected to */
612 Port::PortSignalDrop (); /* EMIT SIGNAL */
615 /* shutdown control surface protocols while we still have ports
616 and the engine to move data to any devices.
619 ControlProtocolManager::instance().drop_protocols ();
621 MIDI::Name::MidiPatchManager::instance().remove_search_path(session_directory().midi_patch_path());
623 _engine.remove_session ();
625 #ifdef USE_TRACKS_CODE_FEATURES
626 EngineStateController::instance()->remove_session();
629 /* deregister all ports - there will be no process or any other
630 * callbacks from the engine any more.
633 Port::PortDrop (); /* EMIT SIGNAL */
637 /* clear history so that no references to objects are held any more */
641 /* clear state tree so that no references to objects are held any more */
646 // unregister all lua functions, drop held references (if any)
648 lua.do_command ("Session = nil");
656 lua.collect_garbage ();
658 /* reset dynamic state version back to default */
659 Stateful::loading_state_version = 0;
661 _butler->drop_references ();
665 delete _all_route_group;
667 DEBUG_TRACE (DEBUG::Destruction, "delete route groups\n");
668 for (list<RouteGroup *>::iterator i = _route_groups.begin(); i != _route_groups.end(); ++i) {
672 if (click_data != default_click) {
673 delete [] click_data;
676 if (click_emphasis_data != default_click_emphasis) {
677 delete [] click_emphasis_data;
682 /* need to remove auditioner before monitoring section
683 * otherwise it is re-connected */
686 /* drop references to routes held by the monitoring section
687 * specifically _monitor_out aux/listen references */
688 remove_monitor_section();
690 /* clear out any pending dead wood from RCU managed objects */
695 AudioDiskstream::free_working_buffers();
697 /* tell everyone who is still standing that we're about to die */
700 /* tell everyone to drop references and delete objects as we go */
702 DEBUG_TRACE (DEBUG::Destruction, "delete regions\n");
703 RegionFactory::delete_all_regions ();
705 /* Do this early so that VCAs no longer hold references to routes */
707 DEBUG_TRACE (DEBUG::Destruction, "delete vcas\n");
710 DEBUG_TRACE (DEBUG::Destruction, "delete routes\n");
712 /* reset these three references to special routes before we do the usual route delete thing */
714 _master_out.reset ();
715 _monitor_out.reset ();
718 RCUWriter<RouteList> writer (routes);
719 boost::shared_ptr<RouteList> r = writer.get_copy ();
721 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
722 DEBUG_TRACE(DEBUG::Destruction, string_compose ("Dropping for route %1 ; pre-ref = %2\n", (*i)->name(), (*i).use_count()));
723 (*i)->drop_references ();
727 /* writer goes out of scope and updates master */
732 DEBUG_TRACE (DEBUG::Destruction, "delete sources\n");
733 Glib::Threads::Mutex::Lock lm (source_lock);
734 for (SourceMap::iterator i = sources.begin(); i != sources.end(); ++i) {
735 DEBUG_TRACE(DEBUG::Destruction, string_compose ("Dropping for source %1 ; pre-ref = %2\n", i->second->name(), i->second.use_count()));
736 i->second->drop_references ();
742 /* not strictly necessary, but doing it here allows the shared_ptr debugging to work */
745 emit_thread_terminate ();
747 pthread_cond_destroy (&_rt_emit_cond);
748 pthread_mutex_destroy (&_rt_emit_mutex);
750 pthread_cond_destroy (&_auto_connect_cond);
751 pthread_mutex_destroy (&_auto_connect_mutex);
753 delete _scene_changer; _scene_changer = 0;
754 delete midi_control_ui; midi_control_ui = 0;
756 delete _mmc; _mmc = 0;
757 delete _midi_ports; _midi_ports = 0;
758 delete _locations; _locations = 0;
763 /* clear event queue, the session is gone, nobody is interested in
764 * those anymore, but they do leak memory if not removed
766 while (!immediate_events.empty ()) {
767 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
768 SessionEvent *ev = immediate_events.front ();
769 DEBUG_TRACE (DEBUG::SessionEvents, string_compose ("Drop event: %1\n", enum_2_string (ev->type)));
770 immediate_events.pop_front ();
774 case SessionEvent::AutoLoop:
775 case SessionEvent::AutoLoopDeclick:
776 case SessionEvent::Skip:
777 case SessionEvent::PunchIn:
778 case SessionEvent::PunchOut:
779 case SessionEvent::StopOnce:
780 case SessionEvent::RangeStop:
781 case SessionEvent::RangeLocate:
785 case SessionEvent::RealTimeOperation:
792 del = del && !_remove_event (ev);
799 DEBUG_TRACE (DEBUG::Destruction, "Session::destroy() done\n");
801 BOOST_SHOW_POINTERS ();
805 Session::setup_ltc ()
809 _ltc_input.reset (new IO (*this, X_("LTC In"), IO::Input));
810 _ltc_output.reset (new IO (*this, X_("LTC Out"), IO::Output));
812 if (state_tree && (child = find_named_node (*state_tree->root(), X_("LTC In"))) != 0) {
813 _ltc_input->set_state (*(child->children().front()), Stateful::loading_state_version);
816 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
817 _ltc_input->ensure_io (ChanCount (DataType::AUDIO, 1), true, this);
819 reconnect_ltc_input ();
822 if (state_tree && (child = find_named_node (*state_tree->root(), X_("LTC Out"))) != 0) {
823 _ltc_output->set_state (*(child->children().front()), Stateful::loading_state_version);
826 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
827 _ltc_output->ensure_io (ChanCount (DataType::AUDIO, 1), true, this);
829 reconnect_ltc_output ();
832 /* fix up names of LTC ports because we don't want the normal
833 * IO style of NAME/TYPE-{in,out}N
836 _ltc_input->nth (0)->set_name (X_("LTC-in"));
837 _ltc_output->nth (0)->set_name (X_("LTC-out"));
841 Session::setup_click ()
845 boost::shared_ptr<AutomationList> gl (new AutomationList (Evoral::Parameter (GainAutomation)));
846 boost::shared_ptr<GainControl> gain_control = boost::shared_ptr<GainControl> (new GainControl (*this, Evoral::Parameter(GainAutomation), gl));
848 _click_io.reset (new ClickIO (*this, X_("Click")));
849 _click_gain.reset (new Amp (*this, _("Fader"), gain_control, true));
850 _click_gain->activate ();
852 setup_click_state (state_tree->root());
854 setup_click_state (0);
859 Session::setup_click_state (const XMLNode* node)
861 const XMLNode* child = 0;
863 if (node && (child = find_named_node (*node, "Click")) != 0) {
865 /* existing state for Click */
868 if (Stateful::loading_state_version < 3000) {
869 c = _click_io->set_state_2X (*child->children().front(), Stateful::loading_state_version, false);
871 const XMLNodeList& children (child->children());
872 XMLNodeList::const_iterator i = children.begin();
873 if ((c = _click_io->set_state (**i, Stateful::loading_state_version)) == 0) {
875 if (i != children.end()) {
876 c = _click_gain->set_state (**i, Stateful::loading_state_version);
882 _clicking = Config->get_clicking ();
886 error << _("could not setup Click I/O") << endmsg;
893 /* default state for Click: dual-mono to first 2 physical outputs */
896 _engine.get_physical_outputs (DataType::AUDIO, outs);
898 for (uint32_t physport = 0; physport < 2; ++physport) {
899 if (outs.size() > physport) {
900 if (_click_io->add_port (outs[physport], this)) {
901 // relax, even though its an error
906 if (_click_io->n_ports () > ChanCount::ZERO) {
907 _clicking = Config->get_clicking ();
913 Session::setup_bundles ()
917 RCUWriter<BundleList> writer (_bundles);
918 boost::shared_ptr<BundleList> b = writer.get_copy ();
919 for (BundleList::iterator i = b->begin(); i != b->end();) {
920 if (boost::dynamic_pointer_cast<UserBundle>(*i)) {
928 vector<string> inputs[DataType::num_types];
929 vector<string> outputs[DataType::num_types];
930 for (uint32_t i = 0; i < DataType::num_types; ++i) {
931 _engine.get_physical_inputs (DataType (DataType::Symbol (i)), inputs[i]);
932 _engine.get_physical_outputs (DataType (DataType::Symbol (i)), outputs[i]);
935 /* Create a set of Bundle objects that map
936 to the physical I/O currently available. We create both
937 mono and stereo bundles, so that the common cases of mono
938 and stereo tracks get bundles to put in their mixer strip
939 in / out menus. There may be a nicer way of achieving that;
940 it doesn't really scale that well to higher channel counts
943 /* mono output bundles */
945 for (uint32_t np = 0; np < outputs[DataType::AUDIO].size(); ++np) {
947 std::string pn = _engine.get_pretty_name_by_name (outputs[DataType::AUDIO][np]);
949 snprintf (buf, sizeof (buf), _("out %s"), pn.c_str());
951 snprintf (buf, sizeof (buf), _("out %" PRIu32), np+1);
954 boost::shared_ptr<Bundle> c (new Bundle (buf, true));
955 c->add_channel (_("mono"), DataType::AUDIO);
956 c->set_port (0, outputs[DataType::AUDIO][np]);
958 add_bundle (c, false);
961 /* stereo output bundles */
963 for (uint32_t np = 0; np < outputs[DataType::AUDIO].size(); np += 2) {
964 if (np + 1 < outputs[DataType::AUDIO].size()) {
966 snprintf (buf, sizeof(buf), _("out %" PRIu32 "+%" PRIu32), np + 1, np + 2);
967 boost::shared_ptr<Bundle> c (new Bundle (buf, true));
968 c->add_channel (_("L"), DataType::AUDIO);
969 c->set_port (0, outputs[DataType::AUDIO][np]);
970 c->add_channel (_("R"), DataType::AUDIO);
971 c->set_port (1, outputs[DataType::AUDIO][np + 1]);
973 add_bundle (c, false);
977 /* mono input bundles */
979 for (uint32_t np = 0; np < inputs[DataType::AUDIO].size(); ++np) {
981 std::string pn = _engine.get_pretty_name_by_name (inputs[DataType::AUDIO][np]);
983 snprintf (buf, sizeof (buf), _("in %s"), pn.c_str());
985 snprintf (buf, sizeof (buf), _("in %" PRIu32), np+1);
988 boost::shared_ptr<Bundle> c (new Bundle (buf, false));
989 c->add_channel (_("mono"), DataType::AUDIO);
990 c->set_port (0, inputs[DataType::AUDIO][np]);
992 add_bundle (c, false);
995 /* stereo input bundles */
997 for (uint32_t np = 0; np < inputs[DataType::AUDIO].size(); np += 2) {
998 if (np + 1 < inputs[DataType::AUDIO].size()) {
1000 snprintf (buf, sizeof(buf), _("in %" PRIu32 "+%" PRIu32), np + 1, np + 2);
1002 boost::shared_ptr<Bundle> c (new Bundle (buf, false));
1003 c->add_channel (_("L"), DataType::AUDIO);
1004 c->set_port (0, inputs[DataType::AUDIO][np]);
1005 c->add_channel (_("R"), DataType::AUDIO);
1006 c->set_port (1, inputs[DataType::AUDIO][np + 1]);
1008 add_bundle (c, false);
1012 /* MIDI input bundles */
1014 for (uint32_t np = 0; np < inputs[DataType::MIDI].size(); ++np) {
1015 string n = inputs[DataType::MIDI][np];
1016 std::string pn = _engine.get_pretty_name_by_name (n);
1020 boost::erase_first (n, X_("alsa_pcm:"));
1022 boost::shared_ptr<Bundle> c (new Bundle (n, false));
1023 c->add_channel ("", DataType::MIDI);
1024 c->set_port (0, inputs[DataType::MIDI][np]);
1025 add_bundle (c, false);
1028 /* MIDI output bundles */
1030 for (uint32_t np = 0; np < outputs[DataType::MIDI].size(); ++np) {
1031 string n = outputs[DataType::MIDI][np];
1032 std::string pn = _engine.get_pretty_name_by_name (n);
1036 boost::erase_first (n, X_("alsa_pcm:"));
1038 boost::shared_ptr<Bundle> c (new Bundle (n, true));
1039 c->add_channel ("", DataType::MIDI);
1040 c->set_port (0, outputs[DataType::MIDI][np]);
1041 add_bundle (c, false);
1044 // we trust the backend to only calls us if there's a change
1045 BundleAddedOrRemoved (); /* EMIT SIGNAL */
1049 Session::auto_connect_master_bus ()
1051 if (!_master_out || !Config->get_auto_connect_standard_busses() || _monitor_out) {
1055 // Waves Tracks: Do not connect master bas for Tracks if AutoConnectMaster option is not set
1056 // In this case it means "Multi Out" output mode
1057 if (ARDOUR::Profile->get_trx() && !(Config->get_output_auto_connect() & AutoConnectMaster) ) {
1061 /* if requested auto-connect the outputs to the first N physical ports.
1064 uint32_t limit = _master_out->n_outputs().n_total();
1065 vector<string> outputs[DataType::num_types];
1067 for (uint32_t i = 0; i < DataType::num_types; ++i) {
1068 _engine.get_physical_outputs (DataType (DataType::Symbol (i)), outputs[i]);
1071 for (uint32_t n = 0; n < limit; ++n) {
1072 boost::shared_ptr<Port> p = _master_out->output()->nth (n);
1074 if (outputs[p->type()].size() > n) {
1075 connect_to = outputs[p->type()][n];
1078 if (!connect_to.empty() && p->connected_to (connect_to) == false) {
1079 if (_master_out->output()->connect (p, connect_to, this)) {
1080 error << string_compose (_("cannot connect master output %1 to %2"), n, connect_to)
1089 Session::remove_monitor_section ()
1091 if (!_monitor_out || Profile->get_trx()) {
1095 /* force reversion to Solo-In-Place */
1096 Config->set_solo_control_is_listen_control (false);
1098 /* if we are auditioning, cancel it ... this is a workaround
1099 to a problem (auditioning does not execute the process graph,
1100 which is needed to remove routes when using >1 core for processing)
1105 /* Hold process lock while doing this so that we don't hear bits and
1106 * pieces of audio as we work on each route.
1109 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
1111 /* Connect tracks to monitor section. Note that in an
1112 existing session, the internal sends will already exist, but we want the
1113 routes to notice that they connect to the control out specifically.
1117 boost::shared_ptr<RouteList> r = routes.reader ();
1118 PBD::Unwinder<bool> uw (ignore_route_processor_changes, true);
1120 for (RouteList::iterator x = r->begin(); x != r->end(); ++x) {
1122 if ((*x)->is_monitor()) {
1124 } else if ((*x)->is_master()) {
1127 (*x)->remove_aux_or_listen (_monitor_out);
1132 remove_route (_monitor_out);
1133 if (_state_of_the_state & Deletion) {
1137 auto_connect_master_bus ();
1140 auditioner->connect ();
1143 Config->ParameterChanged ("use-monitor-bus");
1147 Session::add_monitor_section ()
1151 if (_monitor_out || !_master_out || Profile->get_trx()) {
1155 boost::shared_ptr<Route> r (new Route (*this, _("Monitor"), PresentationInfo::MonitorOut, DataType::AUDIO));
1161 BOOST_MARK_ROUTE(r);
1164 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
1165 r->input()->ensure_io (_master_out->output()->n_ports(), false, this);
1166 r->output()->ensure_io (_master_out->output()->n_ports(), false, this);
1168 error << _("Cannot create monitor section. 'Monitor' Port name is not unique.") << endmsg;
1173 add_routes (rl, false, false, false, 0);
1175 assert (_monitor_out);
1177 /* AUDIO ONLY as of june 29th 2009, because listen semantics for anything else
1178 are undefined, at best.
1181 uint32_t limit = _monitor_out->n_inputs().n_audio();
1185 /* connect the inputs to the master bus outputs. this
1186 * represents a separate data feed from the internal sends from
1187 * each route. as of jan 2011, it allows the monitor section to
1188 * conditionally ignore either the internal sends or the normal
1189 * input feed, but we should really find a better way to do
1193 _master_out->output()->disconnect (this);
1195 for (uint32_t n = 0; n < limit; ++n) {
1196 boost::shared_ptr<AudioPort> p = _monitor_out->input()->ports().nth_audio_port (n);
1197 boost::shared_ptr<AudioPort> o = _master_out->output()->ports().nth_audio_port (n);
1200 string connect_to = o->name();
1201 if (_monitor_out->input()->connect (p, connect_to, this)) {
1202 error << string_compose (_("cannot connect control input %1 to %2"), n, connect_to)
1210 /* if monitor section is not connected, connect it to physical outs
1213 if ((Config->get_auto_connect_standard_busses () || Profile->get_mixbus ()) && !_monitor_out->output()->connected ()) {
1215 if (!Config->get_monitor_bus_preferred_bundle().empty()) {
1217 boost::shared_ptr<Bundle> b = bundle_by_name (Config->get_monitor_bus_preferred_bundle());
1220 _monitor_out->output()->connect_ports_to_bundle (b, true, this);
1222 warning << string_compose (_("The preferred I/O for the monitor bus (%1) cannot be found"),
1223 Config->get_monitor_bus_preferred_bundle())
1229 /* Monitor bus is audio only */
1231 vector<string> outputs[DataType::num_types];
1233 for (uint32_t i = 0; i < DataType::num_types; ++i) {
1234 _engine.get_physical_outputs (DataType (DataType::Symbol (i)), outputs[i]);
1237 uint32_t mod = outputs[DataType::AUDIO].size();
1238 uint32_t limit = _monitor_out->n_outputs().get (DataType::AUDIO);
1242 for (uint32_t n = 0; n < limit; ++n) {
1244 boost::shared_ptr<Port> p = _monitor_out->output()->ports().port(DataType::AUDIO, n);
1246 if (outputs[DataType::AUDIO].size() > (n % mod)) {
1247 connect_to = outputs[DataType::AUDIO][n % mod];
1250 if (!connect_to.empty()) {
1251 if (_monitor_out->output()->connect (p, connect_to, this)) {
1252 error << string_compose (
1253 _("cannot connect control output %1 to %2"),
1264 /* Hold process lock while doing this so that we don't hear bits and
1265 * pieces of audio as we work on each route.
1268 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
1270 /* Connect tracks to monitor section. Note that in an
1271 existing session, the internal sends will already exist, but we want the
1272 routes to notice that they connect to the control out specifically.
1276 boost::shared_ptr<RouteList> rls = routes.reader ();
1278 PBD::Unwinder<bool> uw (ignore_route_processor_changes, true);
1280 for (RouteList::iterator x = rls->begin(); x != rls->end(); ++x) {
1282 if ((*x)->is_monitor()) {
1284 } else if ((*x)->is_master()) {
1287 (*x)->enable_monitor_send ();
1292 auditioner->connect ();
1294 Config->ParameterChanged ("use-monitor-bus");
1298 Session::reset_monitor_section ()
1300 /* Process lock should be held by the caller.*/
1302 if (!_monitor_out || Profile->get_trx()) {
1306 uint32_t limit = _master_out->n_outputs().n_audio();
1308 /* connect the inputs to the master bus outputs. this
1309 * represents a separate data feed from the internal sends from
1310 * each route. as of jan 2011, it allows the monitor section to
1311 * conditionally ignore either the internal sends or the normal
1312 * input feed, but we should really find a better way to do
1316 _master_out->output()->disconnect (this);
1317 _monitor_out->output()->disconnect (this);
1319 // monitor section follow master bus - except midi
1320 ChanCount mon_chn (_master_out->output()->n_ports());
1321 mon_chn.set_midi (0);
1323 _monitor_out->input()->ensure_io (mon_chn, false, this);
1324 _monitor_out->output()->ensure_io (mon_chn, false, this);
1326 for (uint32_t n = 0; n < limit; ++n) {
1327 boost::shared_ptr<AudioPort> p = _monitor_out->input()->ports().nth_audio_port (n);
1328 boost::shared_ptr<AudioPort> o = _master_out->output()->ports().nth_audio_port (n);
1331 string connect_to = o->name();
1332 if (_monitor_out->input()->connect (p, connect_to, this)) {
1333 error << string_compose (_("cannot connect control input %1 to %2"), n, connect_to)
1340 /* connect monitor section to physical outs
1343 if (Config->get_auto_connect_standard_busses()) {
1345 if (!Config->get_monitor_bus_preferred_bundle().empty()) {
1347 boost::shared_ptr<Bundle> b = bundle_by_name (Config->get_monitor_bus_preferred_bundle());
1350 _monitor_out->output()->connect_ports_to_bundle (b, true, this);
1352 warning << string_compose (_("The preferred I/O for the monitor bus (%1) cannot be found"),
1353 Config->get_monitor_bus_preferred_bundle())
1359 /* Monitor bus is audio only */
1361 vector<string> outputs[DataType::num_types];
1363 for (uint32_t i = 0; i < DataType::num_types; ++i) {
1364 _engine.get_physical_outputs (DataType (DataType::Symbol (i)), outputs[i]);
1367 uint32_t mod = outputs[DataType::AUDIO].size();
1368 uint32_t limit = _monitor_out->n_outputs().get (DataType::AUDIO);
1372 for (uint32_t n = 0; n < limit; ++n) {
1374 boost::shared_ptr<Port> p = _monitor_out->output()->ports().port(DataType::AUDIO, n);
1376 if (outputs[DataType::AUDIO].size() > (n % mod)) {
1377 connect_to = outputs[DataType::AUDIO][n % mod];
1380 if (!connect_to.empty()) {
1381 if (_monitor_out->output()->connect (p, connect_to, this)) {
1382 error << string_compose (
1383 _("cannot connect control output %1 to %2"),
1394 /* Connect tracks to monitor section. Note that in an
1395 existing session, the internal sends will already exist, but we want the
1396 routes to notice that they connect to the control out specifically.
1400 boost::shared_ptr<RouteList> rls = routes.reader ();
1402 PBD::Unwinder<bool> uw (ignore_route_processor_changes, true);
1404 for (RouteList::iterator x = rls->begin(); x != rls->end(); ++x) {
1406 if ((*x)->is_monitor()) {
1408 } else if ((*x)->is_master()) {
1411 (*x)->enable_monitor_send ();
1417 Session::hookup_io ()
1419 /* stop graph reordering notifications from
1420 causing resorts, etc.
1423 _state_of_the_state = StateOfTheState (_state_of_the_state | InitialConnecting);
1427 /* we delay creating the auditioner till now because
1428 it makes its own connections to ports.
1432 boost::shared_ptr<Auditioner> a (new Auditioner (*this));
1434 throw failed_constructor ();
1436 a->use_new_diskstream ();
1440 catch (failed_constructor& err) {
1441 warning << _("cannot create Auditioner: no auditioning of regions possible") << endmsg;
1445 /* load bundles, which we may have postponed earlier on */
1446 if (_bundle_xml_node) {
1447 load_bundles (*_bundle_xml_node);
1448 delete _bundle_xml_node;
1451 /* Tell all IO objects to connect themselves together */
1453 IO::enable_connecting ();
1455 /* Now tell all "floating" ports to connect to whatever
1456 they should be connected to.
1459 AudioEngine::instance()->reconnect_ports ();
1461 /* Anyone who cares about input state, wake up and do something */
1463 IOConnectionsComplete (); /* EMIT SIGNAL */
1465 _state_of_the_state = StateOfTheState (_state_of_the_state & ~InitialConnecting);
1467 /* now handle the whole enchilada as if it was one
1468 graph reorder event.
1473 /* update the full solo state, which can't be
1474 correctly determined on a per-route basis, but
1475 needs the global overview that only the session
1479 update_route_solo_state ();
1483 Session::track_playlist_changed (boost::weak_ptr<Track> wp)
1485 boost::shared_ptr<Track> track = wp.lock ();
1490 boost::shared_ptr<Playlist> playlist;
1492 if ((playlist = track->playlist()) != 0) {
1493 playlist->RegionAdded.connect_same_thread (*this, boost::bind (&Session::playlist_region_added, this, _1));
1494 playlist->RangesMoved.connect_same_thread (*this, boost::bind (&Session::playlist_ranges_moved, this, _1));
1495 playlist->RegionsExtended.connect_same_thread (*this, boost::bind (&Session::playlist_regions_extended, this, _1));
1500 Session::record_enabling_legal () const
1502 /* this used to be in here, but survey says.... we don't need to restrict it */
1503 // if (record_status() == Recording) {
1507 if (Config->get_all_safe()) {
1514 Session::set_track_monitor_input_status (bool yn)
1516 boost::shared_ptr<RouteList> rl = routes.reader ();
1517 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
1518 boost::shared_ptr<AudioTrack> tr = boost::dynamic_pointer_cast<AudioTrack> (*i);
1519 if (tr && tr->rec_enable_control()->get_value()) {
1520 //cerr << "switching to input = " << !auto_input << __FILE__ << __LINE__ << endl << endl;
1521 tr->request_input_monitoring (yn);
1527 Session::auto_punch_start_changed (Location* location)
1529 replace_event (SessionEvent::PunchIn, location->start());
1531 if (get_record_enabled() && config.get_punch_in()) {
1532 /* capture start has been changed, so save new pending state */
1533 save_state ("", true);
1538 Session::auto_punch_end_changed (Location* location)
1540 framepos_t when_to_stop = location->end();
1541 // when_to_stop += _worst_output_latency + _worst_input_latency;
1542 replace_event (SessionEvent::PunchOut, when_to_stop);
1546 Session::auto_punch_changed (Location* location)
1548 framepos_t when_to_stop = location->end();
1550 replace_event (SessionEvent::PunchIn, location->start());
1551 //when_to_stop += _worst_output_latency + _worst_input_latency;
1552 replace_event (SessionEvent::PunchOut, when_to_stop);
1555 /** @param loc A loop location.
1556 * @param pos Filled in with the start time of the required fade-out (in session frames).
1557 * @param length Filled in with the length of the required fade-out.
1560 Session::auto_loop_declick_range (Location* loc, framepos_t & pos, framepos_t & length)
1562 pos = max (loc->start(), loc->end() - 64);
1563 length = loc->end() - pos;
1567 Session::auto_loop_changed (Location* location)
1569 replace_event (SessionEvent::AutoLoop, location->end(), location->start());
1572 auto_loop_declick_range (location, dcp, dcl);
1574 if (transport_rolling() && play_loop) {
1576 replace_event (SessionEvent::AutoLoopDeclick, dcp, dcl);
1578 // if (_transport_frame > location->end()) {
1580 if (_transport_frame < location->start() || _transport_frame > location->end()) {
1581 // relocate to beginning of loop
1582 clear_events (SessionEvent::LocateRoll);
1584 request_locate (location->start(), true);
1587 else if (Config->get_seamless_loop() && !loop_changing) {
1589 // schedule a locate-roll to refill the diskstreams at the
1590 // previous loop end
1591 loop_changing = true;
1593 if (location->end() > last_loopend) {
1594 clear_events (SessionEvent::LocateRoll);
1595 SessionEvent *ev = new SessionEvent (SessionEvent::LocateRoll, SessionEvent::Add, last_loopend, last_loopend, 0, true);
1601 clear_events (SessionEvent::AutoLoopDeclick);
1602 clear_events (SessionEvent::AutoLoop);
1605 /* possibly move playhead if not rolling; if we are rolling we'll move
1606 to the loop start on stop if that is appropriate.
1611 if (!transport_rolling() && select_playhead_priority_target (pos)) {
1612 if (pos == location->start()) {
1613 request_locate (pos);
1618 last_loopend = location->end();
1623 Session::set_auto_punch_location (Location* location)
1627 if ((existing = _locations->auto_punch_location()) != 0 && existing != location) {
1628 punch_connections.drop_connections();
1629 existing->set_auto_punch (false, this);
1630 remove_event (existing->start(), SessionEvent::PunchIn);
1631 clear_events (SessionEvent::PunchOut);
1632 auto_punch_location_changed (0);
1637 if (location == 0) {
1641 if (location->end() <= location->start()) {
1642 error << _("Session: you can't use that location for auto punch (start <= end)") << endmsg;
1646 punch_connections.drop_connections ();
1648 location->StartChanged.connect_same_thread (punch_connections, boost::bind (&Session::auto_punch_start_changed, this, location));
1649 location->EndChanged.connect_same_thread (punch_connections, boost::bind (&Session::auto_punch_end_changed, this, location));
1650 location->Changed.connect_same_thread (punch_connections, boost::bind (&Session::auto_punch_changed, this, location));
1652 location->set_auto_punch (true, this);
1654 auto_punch_changed (location);
1656 auto_punch_location_changed (location);
1660 Session::set_session_extents (framepos_t start, framepos_t end)
1663 if ((existing = _locations->session_range_location()) == 0) {
1664 //if there is no existing session, we need to make a new session location (should never happen)
1665 existing = new Location (*this, 0, 0, _("session"), Location::IsSessionRange);
1669 error << _("Session: you can't use that location for session start/end)") << endmsg;
1673 existing->set( start, end );
1679 Session::set_auto_loop_location (Location* location)
1683 if ((existing = _locations->auto_loop_location()) != 0 && existing != location) {
1684 loop_connections.drop_connections ();
1685 existing->set_auto_loop (false, this);
1686 remove_event (existing->end(), SessionEvent::AutoLoop);
1689 auto_loop_declick_range (existing, dcp, dcl);
1690 remove_event (dcp, SessionEvent::AutoLoopDeclick);
1691 auto_loop_location_changed (0);
1696 if (location == 0) {
1700 if (location->end() <= location->start()) {
1701 error << _("You cannot use this location for auto-loop because it has zero or negative length") << endmsg;
1705 last_loopend = location->end();
1707 loop_connections.drop_connections ();
1709 location->StartChanged.connect_same_thread (loop_connections, boost::bind (&Session::auto_loop_changed, this, location));
1710 location->EndChanged.connect_same_thread (loop_connections, boost::bind (&Session::auto_loop_changed, this, location));
1711 location->Changed.connect_same_thread (loop_connections, boost::bind (&Session::auto_loop_changed, this, location));
1712 location->FlagsChanged.connect_same_thread (loop_connections, boost::bind (&Session::auto_loop_changed, this, location));
1714 location->set_auto_loop (true, this);
1716 if (Config->get_loop_is_mode() && play_loop && Config->get_seamless_loop()) {
1717 // set all tracks to use internal looping
1718 boost::shared_ptr<RouteList> rl = routes.reader ();
1719 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
1720 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
1721 if (tr && !tr->hidden()) {
1722 tr->set_loop (location);
1727 /* take care of our stuff first */
1729 auto_loop_changed (location);
1731 /* now tell everyone else */
1733 auto_loop_location_changed (location);
1737 Session::update_marks (Location*)
1743 Session::update_skips (Location* loc, bool consolidate)
1745 if (_ignore_skips_updates) {
1749 Locations::LocationList skips;
1752 PBD::Unwinder<bool> uw (_ignore_skips_updates, true);
1753 consolidate_skips (loc);
1756 sync_locations_to_skips ();
1762 Session::consolidate_skips (Location* loc)
1764 Locations::LocationList all_locations = _locations->list ();
1766 for (Locations::LocationList::iterator l = all_locations.begin(); l != all_locations.end(); ) {
1768 if (!(*l)->is_skip ()) {
1773 /* don't test against self */
1780 switch (Evoral::coverage ((*l)->start(), (*l)->end(), loc->start(), loc->end())) {
1781 case Evoral::OverlapInternal:
1782 case Evoral::OverlapExternal:
1783 case Evoral::OverlapStart:
1784 case Evoral::OverlapEnd:
1785 /* adjust new location to cover existing one */
1786 loc->set_start (min (loc->start(), (*l)->start()));
1787 loc->set_end (max (loc->end(), (*l)->end()));
1788 /* we don't need this one any more */
1789 _locations->remove (*l);
1790 /* the location has been deleted, so remove reference to it in our local list */
1791 l = all_locations.erase (l);
1794 case Evoral::OverlapNone:
1802 Session::sync_locations_to_skips ()
1804 /* This happens asynchronously (in the audioengine thread). After the clear is done, we will call
1805 * Session::_sync_locations_to_skips() from the audioengine thread.
1807 clear_events (SessionEvent::Skip, boost::bind (&Session::_sync_locations_to_skips, this));
1811 Session::_sync_locations_to_skips ()
1813 /* called as a callback after existing Skip events have been cleared from a realtime audioengine thread */
1815 Locations::LocationList const & locs (_locations->list());
1817 for (Locations::LocationList::const_iterator i = locs.begin(); i != locs.end(); ++i) {
1819 Location* location = *i;
1821 if (location->is_skip() && location->is_skipping()) {
1822 SessionEvent* ev = new SessionEvent (SessionEvent::Skip, SessionEvent::Add, location->start(), location->end(), 1.0);
1830 Session::location_added (Location *location)
1832 if (location->is_auto_punch()) {
1833 set_auto_punch_location (location);
1836 if (location->is_auto_loop()) {
1837 set_auto_loop_location (location);
1840 if (location->is_session_range()) {
1841 /* no need for any signal handling or event setting with the session range,
1842 because we keep a direct reference to it and use its start/end directly.
1844 _session_range_location = location;
1847 if (location->is_mark()) {
1848 /* listen for per-location signals that require us to do any * global updates for marks */
1850 location->StartChanged.connect_same_thread (skip_update_connections, boost::bind (&Session::update_marks, this, location));
1851 location->EndChanged.connect_same_thread (skip_update_connections, boost::bind (&Session::update_marks, this, location));
1852 location->Changed.connect_same_thread (skip_update_connections, boost::bind (&Session::update_marks, this, location));
1853 location->FlagsChanged.connect_same_thread (skip_update_connections, boost::bind (&Session::update_marks, this, location));
1856 if (location->is_skip()) {
1857 /* listen for per-location signals that require us to update skip-locate events */
1859 location->StartChanged.connect_same_thread (skip_update_connections, boost::bind (&Session::update_skips, this, location, true));
1860 location->EndChanged.connect_same_thread (skip_update_connections, boost::bind (&Session::update_skips, this, location, true));
1861 location->Changed.connect_same_thread (skip_update_connections, boost::bind (&Session::update_skips, this, location, true));
1862 location->FlagsChanged.connect_same_thread (skip_update_connections, boost::bind (&Session::update_skips, this, location, false));
1864 update_skips (location, true);
1871 Session::location_removed (Location *location)
1873 if (location->is_auto_loop()) {
1874 set_auto_loop_location (0);
1875 set_track_loop (false);
1878 if (location->is_auto_punch()) {
1879 set_auto_punch_location (0);
1882 if (location->is_session_range()) {
1883 /* this is never supposed to happen */
1884 error << _("programming error: session range removed!") << endl;
1887 if (location->is_skip()) {
1889 update_skips (location, false);
1896 Session::locations_changed ()
1898 _locations->apply (*this, &Session::_locations_changed);
1902 Session::_locations_changed (const Locations::LocationList& locations)
1904 /* There was some mass-change in the Locations object.
1906 We might be re-adding a location here but it doesn't actually matter
1907 for all the locations that the Session takes an interest in.
1911 PBD::Unwinder<bool> protect_ignore_skip_updates (_ignore_skips_updates, true);
1912 for (Locations::LocationList::const_iterator i = locations.begin(); i != locations.end(); ++i) {
1913 location_added (*i);
1917 update_skips (NULL, false);
1921 Session::enable_record ()
1923 if (_transport_speed != 0.0 && _transport_speed != 1.0) {
1924 /* no recording at anything except normal speed */
1929 RecordState rs = (RecordState) g_atomic_int_get (&_record_status);
1931 if (rs == Recording) {
1935 if (g_atomic_int_compare_and_exchange (&_record_status, rs, Recording)) {
1937 _last_record_location = _transport_frame;
1938 send_immediate_mmc (MIDI::MachineControlCommand (MIDI::MachineControl::cmdRecordStrobe));
1940 if (Config->get_monitoring_model() == HardwareMonitoring && config.get_auto_input()) {
1941 set_track_monitor_input_status (true);
1944 RecordStateChanged ();
1951 Session::set_all_tracks_record_enabled (bool enable )
1953 boost::shared_ptr<RouteList> rl = routes.reader();
1954 set_controls (route_list_to_control_list (rl, &Stripable::rec_enable_control), enable, Controllable::NoGroup);
1958 Session::disable_record (bool rt_context, bool force)
1962 if ((rs = (RecordState) g_atomic_int_get (&_record_status)) != Disabled) {
1964 if (!Config->get_latched_record_enable () || force) {
1965 g_atomic_int_set (&_record_status, Disabled);
1966 send_immediate_mmc (MIDI::MachineControlCommand (MIDI::MachineControl::cmdRecordExit));
1968 if (rs == Recording) {
1969 g_atomic_int_set (&_record_status, Enabled);
1973 if (Config->get_monitoring_model() == HardwareMonitoring && config.get_auto_input()) {
1974 set_track_monitor_input_status (false);
1977 RecordStateChanged (); /* emit signal */
1980 remove_pending_capture_state ();
1986 Session::step_back_from_record ()
1988 if (g_atomic_int_compare_and_exchange (&_record_status, Recording, Enabled)) {
1990 if (Config->get_monitoring_model() == HardwareMonitoring && config.get_auto_input()) {
1991 set_track_monitor_input_status (false);
1994 RecordStateChanged (); /* emit signal */
1999 Session::maybe_enable_record ()
2001 if (_step_editors > 0) {
2005 g_atomic_int_set (&_record_status, Enabled);
2007 /* This function is currently called from somewhere other than an RT thread.
2008 This save_state() call therefore doesn't impact anything. Doing it here
2009 means that we save pending state of which sources the next record will use,
2010 which gives us some chance of recovering from a crash during the record.
2013 save_state ("", true);
2015 if (_transport_speed) {
2016 if (!config.get_punch_in()) {
2020 send_immediate_mmc (MIDI::MachineControlCommand (MIDI::MachineControl::cmdRecordPause));
2021 RecordStateChanged (); /* EMIT SIGNAL */
2028 Session::audible_frame () const
2034 offset = worst_playback_latency ();
2036 if (synced_to_engine()) {
2037 /* Note: this is basically just sync-to-JACK */
2038 tf = _engine.transport_frame();
2040 tf = _transport_frame;
2045 if (!non_realtime_work_pending()) {
2049 /* Check to see if we have passed the first guaranteed
2050 audible frame past our last start position. if not,
2051 return that last start point because in terms
2052 of audible frames, we have not moved yet.
2054 `Start position' in this context means the time we last
2055 either started, located, or changed transport direction.
2058 if (_transport_speed > 0.0f) {
2060 if (!play_loop || !have_looped) {
2061 if (tf < _last_roll_or_reversal_location + offset) {
2062 return _last_roll_or_reversal_location;
2070 } else if (_transport_speed < 0.0f) {
2072 /* XXX wot? no backward looping? */
2074 if (tf > _last_roll_or_reversal_location - offset) {
2075 return _last_roll_or_reversal_location;
2087 Session::set_frame_rate (framecnt_t frames_per_second)
2089 /** \fn void Session::set_frame_size(framecnt_t)
2090 the AudioEngine object that calls this guarantees
2091 that it will not be called while we are also in
2092 ::process(). Its fine to do things that block
2096 if (_base_frame_rate == 0) {
2097 _base_frame_rate = frames_per_second;
2099 else if (_base_frame_rate != frames_per_second && frames_per_second != _nominal_frame_rate) {
2100 NotifyAboutSampleRateMismatch (_base_frame_rate, frames_per_second);
2102 _nominal_frame_rate = frames_per_second;
2107 reset_write_sources (false);
2109 // XXX we need some equivalent to this, somehow
2110 // SndFileSource::setup_standard_crossfades (frames_per_second);
2114 /* XXX need to reset/reinstantiate all LADSPA plugins */
2118 Session::set_block_size (pframes_t nframes)
2120 /* the AudioEngine guarantees
2121 that it will not be called while we are also in
2122 ::process(). It is therefore fine to do things that block
2127 current_block_size = nframes;
2131 boost::shared_ptr<RouteList> r = routes.reader ();
2133 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
2134 (*i)->set_block_size (nframes);
2137 boost::shared_ptr<RouteList> rl = routes.reader ();
2138 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
2139 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
2141 tr->set_block_size (nframes);
2145 set_worst_io_latencies ();
2151 trace_terminal (boost::shared_ptr<Route> r1, boost::shared_ptr<Route> rbase)
2153 boost::shared_ptr<Route> r2;
2155 if (r1->feeds (rbase) && rbase->feeds (r1)) {
2156 info << string_compose(_("feedback loop setup between %1 and %2"), r1->name(), rbase->name()) << endmsg;
2160 /* make a copy of the existing list of routes that feed r1 */
2162 Route::FedBy existing (r1->fed_by());
2164 /* for each route that feeds r1, recurse, marking it as feeding
2168 for (Route::FedBy::iterator i = existing.begin(); i != existing.end(); ++i) {
2169 if (!(r2 = i->r.lock ())) {
2170 /* (*i) went away, ignore it */
2174 /* r2 is a route that feeds r1 which somehow feeds base. mark
2175 base as being fed by r2
2178 rbase->add_fed_by (r2, i->sends_only);
2182 /* 2nd level feedback loop detection. if r1 feeds or is fed by r2,
2186 if (r1->feeds (r2) && r2->feeds (r1)) {
2190 /* now recurse, so that we can mark base as being fed by
2191 all routes that feed r2
2194 trace_terminal (r2, rbase);
2201 Session::resort_routes ()
2203 /* don't do anything here with signals emitted
2204 by Routes during initial setup or while we
2205 are being destroyed.
2208 if (_state_of_the_state & (InitialConnecting | Deletion)) {
2212 if (_route_deletion_in_progress) {
2217 RCUWriter<RouteList> writer (routes);
2218 boost::shared_ptr<RouteList> r = writer.get_copy ();
2219 resort_routes_using (r);
2220 /* writer goes out of scope and forces update */
2224 if (DEBUG_ENABLED(DEBUG::Graph)) {
2225 boost::shared_ptr<RouteList> rl = routes.reader ();
2226 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
2227 DEBUG_TRACE (DEBUG::Graph, string_compose ("%1 fed by ...\n", (*i)->name()));
2229 const Route::FedBy& fb ((*i)->fed_by());
2231 for (Route::FedBy::const_iterator f = fb.begin(); f != fb.end(); ++f) {
2232 boost::shared_ptr<Route> sf = f->r.lock();
2234 DEBUG_TRACE (DEBUG::Graph, string_compose ("\t%1 (sends only ? %2)\n", sf->name(), f->sends_only));
2243 /** This is called whenever we need to rebuild the graph of how we will process
2245 * @param r List of routes, in any order.
2249 Session::resort_routes_using (boost::shared_ptr<RouteList> r)
2251 /* We are going to build a directed graph of our routes;
2252 this is where the edges of that graph are put.
2257 /* Go through all routes doing two things:
2259 * 1. Collect the edges of the route graph. Each of these edges
2260 * is a pair of routes, one of which directly feeds the other
2261 * either by a JACK connection or by an internal send.
2263 * 2. Begin the process of making routes aware of which other
2264 * routes directly or indirectly feed them. This information
2265 * is used by the solo code.
2268 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
2270 /* Clear out the route's list of direct or indirect feeds */
2271 (*i)->clear_fed_by ();
2273 for (RouteList::iterator j = r->begin(); j != r->end(); ++j) {
2275 bool via_sends_only;
2277 /* See if this *j feeds *i according to the current state of the JACK
2278 connections and internal sends.
2280 if ((*j)->direct_feeds_according_to_reality (*i, &via_sends_only)) {
2281 /* add the edge to the graph (part #1) */
2282 edges.add (*j, *i, via_sends_only);
2283 /* tell the route (for part #2) */
2284 (*i)->add_fed_by (*j, via_sends_only);
2289 /* Attempt a topological sort of the route graph */
2290 boost::shared_ptr<RouteList> sorted_routes = topological_sort (r, edges);
2292 if (sorted_routes) {
2293 /* We got a satisfactory topological sort, so there is no feedback;
2296 Note: the process graph rechain does not require a
2297 topologically-sorted list, but hey ho.
2299 if (_process_graph) {
2300 _process_graph->rechain (sorted_routes, edges);
2303 _current_route_graph = edges;
2305 /* Complete the building of the routes' lists of what directly
2306 or indirectly feeds them.
2308 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
2309 trace_terminal (*i, *i);
2312 *r = *sorted_routes;
2315 DEBUG_TRACE (DEBUG::Graph, "Routes resorted, order follows:\n");
2316 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
2317 DEBUG_TRACE (DEBUG::Graph, string_compose ("\t%1 presentation order %2\n", (*i)->name(), (*i)->presentation_info().order()));
2321 SuccessfulGraphSort (); /* EMIT SIGNAL */
2324 /* The topological sort failed, so we have a problem. Tell everyone
2325 and stick to the old graph; this will continue to be processed, so
2326 until the feedback is fixed, what is played back will not quite
2327 reflect what is actually connected. Note also that we do not
2328 do trace_terminal here, as it would fail due to an endless recursion,
2329 so the solo code will think that everything is still connected
2333 FeedbackDetected (); /* EMIT SIGNAL */
2338 /** Find a route name starting with \a base, maybe followed by the
2339 * lowest \a id. \a id will always be added if \a definitely_add_number
2340 * is true on entry; otherwise it will only be added if required
2341 * to make the name unique.
2343 * Names are constructed like e.g. "Audio 3" for base="Audio" and id=3.
2344 * The available route name with the lowest ID will be used, and \a id
2345 * will be set to the ID.
2347 * \return false if a route name could not be found, and \a track_name
2348 * and \a id do not reflect a free route name.
2351 Session::find_route_name (string const & base, uint32_t& id, string& name, bool definitely_add_number)
2353 /* the base may conflict with ports that do not belong to existing
2354 routes, but hidden objects like the click track. So check port names
2355 before anything else.
2358 for (vector<string>::const_iterator reserved = reserved_io_names.begin(); reserved != reserved_io_names.end(); ++reserved) {
2359 if (base == *reserved) {
2360 /* Check if this reserved name already exists, and if
2361 so, disallow it without a numeric suffix.
2363 if (route_by_name (*reserved)) {
2364 definitely_add_number = true;
2373 if (!definitely_add_number && route_by_name (base) == 0) {
2374 /* juse use the base */
2380 name = string_compose ("%1 %2", base, id);
2382 if (route_by_name (name) == 0) {
2388 } while (id < (UINT_MAX-1));
2393 /** Count the total ins and outs of all non-hidden tracks in the session and return them in in and out */
2395 Session::count_existing_track_channels (ChanCount& in, ChanCount& out)
2397 in = ChanCount::ZERO;
2398 out = ChanCount::ZERO;
2400 boost::shared_ptr<RouteList> r = routes.reader ();
2402 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
2403 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
2404 if (tr && !tr->is_auditioner()) {
2405 in += tr->n_inputs();
2406 out += tr->n_outputs();
2412 Session::default_track_name_pattern (DataType t)
2415 case DataType::AUDIO:
2416 if (Profile->get_trx()) {
2423 case DataType::MIDI:
2430 /** Caller must not hold process lock
2431 * @param name_template string to use for the start of the name, or "" to use "MIDI".
2432 * @param instrument plugin info for the instrument to insert pre-fader, if any
2434 list<boost::shared_ptr<MidiTrack> >
2435 Session::new_midi_track (const ChanCount& input, const ChanCount& output,
2436 boost::shared_ptr<PluginInfo> instrument, Plugin::PresetRecord* pset,
2437 RouteGroup* route_group, uint32_t how_many, string name_template, PresentationInfo::order_t order,
2441 uint32_t track_id = 0;
2443 RouteList new_routes;
2444 list<boost::shared_ptr<MidiTrack> > ret;
2446 const string name_pattern = default_track_name_pattern (DataType::MIDI);
2447 bool const use_number = (how_many != 1) || name_template.empty () || (name_template == name_pattern);
2450 if (!find_route_name (name_template.empty() ? _("MIDI") : name_template, ++track_id, track_name, use_number)) {
2451 error << "cannot find name for new midi track" << endmsg;
2455 boost::shared_ptr<MidiTrack> track;
2458 track.reset (new MidiTrack (*this, track_name, mode));
2460 if (track->init ()) {
2464 if (Profile->get_mixbus ()) {
2465 track->set_strict_io (true);
2468 track->use_new_diskstream();
2470 BOOST_MARK_TRACK (track);
2473 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
2474 if (track->input()->ensure_io (input, false, this)) {
2475 error << "cannot configure " << input << " out configuration for new midi track" << endmsg;
2479 if (track->output()->ensure_io (output, false, this)) {
2480 error << "cannot configure " << output << " out configuration for new midi track" << endmsg;
2485 track->non_realtime_input_change();
2488 route_group->add (track);
2491 track->DiskstreamChanged.connect_same_thread (*this, boost::bind (&Session::resort_routes, this));
2493 new_routes.push_back (track);
2494 ret.push_back (track);
2497 catch (failed_constructor &err) {
2498 error << _("Session: could not create new midi track.") << endmsg;
2502 catch (AudioEngine::PortRegistrationFailure& pfe) {
2504 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;
2512 if (!new_routes.empty()) {
2513 StateProtector sp (this);
2514 if (Profile->get_trx()) {
2515 add_routes (new_routes, false, false, false, order);
2517 add_routes (new_routes, true, true, false, order);
2521 for (RouteList::iterator r = new_routes.begin(); r != new_routes.end(); ++r) {
2522 PluginPtr plugin = instrument->load (*this);
2524 plugin->load_preset (*pset);
2526 boost::shared_ptr<Processor> p (new PluginInsert (*this, plugin));
2527 (*r)->add_processor (p, PreFader);
2537 Session::new_midi_route (RouteGroup* route_group, uint32_t how_many, string name_template, boost::shared_ptr<PluginInfo> instrument, Plugin::PresetRecord* pset,
2538 PresentationInfo::Flag flag, PresentationInfo::order_t order)
2541 uint32_t bus_id = 0;
2545 bool const use_number = (how_many != 1) || name_template.empty () || name_template == _("Midi Bus");
2548 if (!find_route_name (name_template.empty () ? _("Midi Bus") : name_template, ++bus_id, bus_name, use_number)) {
2549 error << "cannot find name for new midi bus" << endmsg;
2554 boost::shared_ptr<Route> bus (new Route (*this, bus_name, flag, DataType::AUDIO)); // XXX Editor::add_routes is not ready for ARDOUR::DataType::MIDI
2560 if (Profile->get_mixbus ()) {
2561 bus->set_strict_io (true);
2564 BOOST_MARK_ROUTE(bus);
2567 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
2569 if (bus->input()->ensure_io (ChanCount(DataType::MIDI, 1), false, this)) {
2570 error << _("cannot configure new midi bus input") << endmsg;
2575 if (bus->output()->ensure_io (ChanCount(DataType::MIDI, 1), false, this)) {
2576 error << _("cannot configure new midi bus output") << endmsg;
2582 route_group->add (bus);
2585 bus->add_internal_return ();
2586 ret.push_back (bus);
2589 catch (failed_constructor &err) {
2590 error << _("Session: could not create new audio route.") << endmsg;
2594 catch (AudioEngine::PortRegistrationFailure& pfe) {
2595 error << pfe.what() << endmsg;
2605 StateProtector sp (this);
2606 add_routes (ret, false, false, false, order);
2609 for (RouteList::iterator r = ret.begin(); r != ret.end(); ++r) {
2610 PluginPtr plugin = instrument->load (*this);
2612 plugin->load_preset (*pset);
2614 boost::shared_ptr<Processor> p (new PluginInsert (*this, plugin));
2615 (*r)->add_processor (p, PreFader);
2626 Session::midi_output_change_handler (IOChange change, void * /*src*/, boost::weak_ptr<Route> wmt)
2628 boost::shared_ptr<Route> midi_track (wmt.lock());
2634 if ((change.type & IOChange::ConfigurationChanged) && Config->get_output_auto_connect() != ManualConnect) {
2636 if (change.after.n_audio() <= change.before.n_audio()) {
2640 /* new audio ports: make sure the audio goes somewhere useful,
2641 * unless the user has no-auto-connect selected.
2643 * The existing ChanCounts don't matter for this call as they are only
2644 * to do with matching input and output indices, and we are only changing
2647 auto_connect_route (midi_track, false, ChanCount(), change.before);
2651 #ifdef USE_TRACKS_CODE_FEATURES
2654 compare_routes_by_remote_id (const boost::shared_ptr<Route>& route1, const boost::shared_ptr<Route>& route2)
2656 return route1->remote_control_id() < route2->remote_control_id();
2660 Session::reconnect_existing_routes (bool withLock, bool reconnect_master, bool reconnect_inputs, bool reconnect_outputs)
2662 // it is not allowed to perform connection
2663 if (!IO::connecting_legal) {
2667 // if we are deleting routes we will call this once at the end
2668 if (_route_deletion_in_progress) {
2672 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock (), Glib::Threads::NOT_LOCK);
2678 // We need to disconnect the route's inputs and outputs first
2679 // basing on autoconnect configuration
2680 bool reconnectIputs = !(Config->get_input_auto_connect() & ManualConnect) && reconnect_inputs;
2681 bool reconnectOutputs = !(Config->get_output_auto_connect() & ManualConnect) && reconnect_outputs;
2683 ChanCount existing_inputs;
2684 ChanCount existing_outputs;
2685 count_existing_track_channels (existing_inputs, existing_outputs);
2687 //ChanCount inputs = ChanCount::ZERO;
2688 //ChanCount outputs = ChanCount::ZERO;
2690 RouteList existing_routes = *routes.reader ();
2691 existing_routes.sort (compare_routes_by_remote_id);
2694 PBD::Unwinder<bool> protect_ignore_changes (_reconnecting_routes_in_progress, true);
2696 vector<string> physinputs;
2697 vector<string> physoutputs;
2699 EngineStateController::instance()->get_physical_audio_outputs(physoutputs);
2700 EngineStateController::instance()->get_physical_audio_inputs(physinputs);
2702 uint32_t input_n = 0;
2703 uint32_t output_n = 0;
2704 RouteList::iterator rIter = existing_routes.begin();
2705 const AutoConnectOption current_input_auto_connection (Config->get_input_auto_connect());
2706 const AutoConnectOption current_output_auto_connection (Config->get_output_auto_connect());
2707 for (; rIter != existing_routes.end(); ++rIter) {
2708 if (*rIter == _master_out || *rIter == _monitor_out ) {
2712 if (current_output_auto_connection == AutoConnectPhysical) {
2713 (*rIter)->amp()->deactivate();
2714 } else if (current_output_auto_connection == AutoConnectMaster) {
2715 (*rIter)->amp()->activate();
2718 if (reconnectIputs) {
2719 (*rIter)->input()->disconnect (this); //GZ: check this; could be heavy
2721 for (uint32_t route_input_n = 0; route_input_n < (*rIter)->n_inputs().get(DataType::AUDIO); ++route_input_n) {
2723 if (current_input_auto_connection & AutoConnectPhysical) {
2725 if ( input_n == physinputs.size() ) {
2729 string port = physinputs[input_n];
2731 if (port.empty() ) {
2732 error << "Physical Input number "<< input_n << " is unavailable and cannot be connected" << endmsg;
2735 //GZ: check this; could be heavy
2736 (*rIter)->input()->connect ((*rIter)->input()->ports().port(DataType::AUDIO, route_input_n), port, this);
2742 if (reconnectOutputs) {
2744 //normalize route ouptuts: reduce the amount outputs to be equal to the amount of inputs
2745 if (current_output_auto_connection & AutoConnectPhysical) {
2747 //GZ: check this; could be heavy
2748 (*rIter)->output()->disconnect (this);
2749 size_t route_inputs_count = (*rIter)->n_inputs().get(DataType::AUDIO);
2751 //GZ: check this; could be heavy
2752 (*rIter)->output()->ensure_io(ChanCount(DataType::AUDIO, route_inputs_count), false, this );
2754 } else if (current_output_auto_connection & AutoConnectMaster){
2756 if (!reconnect_master) {
2760 //GZ: check this; could be heavy
2761 (*rIter)->output()->disconnect (this);
2764 uint32_t master_inputs_count = _master_out->n_inputs().get(DataType::AUDIO);
2765 (*rIter)->output()->ensure_io(ChanCount(DataType::AUDIO, master_inputs_count), false, this );
2767 error << error << "Master bus is not available" << endmsg;
2772 for (uint32_t route_output_n = 0; route_output_n < (*rIter)->n_outputs().get(DataType::AUDIO); ++route_output_n) {
2773 if (current_output_auto_connection & AutoConnectPhysical) {
2775 if ( output_n == physoutputs.size() ) {
2779 string port = physoutputs[output_n];
2781 if (port.empty() ) {
2782 error << "Physical Output number "<< output_n << " is unavailable and cannot be connected" << endmsg;
2785 //GZ: check this; could be heavy
2786 (*rIter)->output()->connect ((*rIter)->output()->ports().port(DataType::AUDIO, route_output_n), port, this);
2789 } else if (current_output_auto_connection & AutoConnectMaster) {
2791 if ( route_output_n == _master_out->n_inputs().get(DataType::AUDIO) ) {
2795 // connect to master bus
2796 string port = _master_out->input()->ports().port(DataType::AUDIO, route_output_n)->name();
2798 if (port.empty() ) {
2799 error << "MasterBus Input number "<< route_output_n << " is unavailable and cannot be connected" << endmsg;
2803 //GZ: check this; could be heavy
2804 (*rIter)->output()->connect ((*rIter)->output()->ports().port(DataType::AUDIO, route_output_n), port, this);
2811 _master_out->output()->disconnect (this);
2812 auto_connect_master_bus ();
2817 session_routes_reconnected (); /* EMIT SIGNAL */
2821 Session::reconnect_midi_scene_ports(bool inputs)
2825 boost::shared_ptr<MidiPort> scene_in_ptr = scene_in();
2827 scene_in_ptr->disconnect_all ();
2829 std::vector<EngineStateController::MidiPortState> midi_port_states;
2830 EngineStateController::instance()->get_physical_midi_input_states (midi_port_states);
2832 std::vector<EngineStateController::MidiPortState>::iterator state_iter = midi_port_states.begin();
2834 for (; state_iter != midi_port_states.end(); ++state_iter) {
2835 if (state_iter->active && state_iter->available && state_iter->scene_connected) {
2836 scene_in_ptr->connect (state_iter->name);
2843 boost::shared_ptr<MidiPort> scene_out_ptr = scene_out();
2845 if (scene_out_ptr ) {
2846 scene_out_ptr->disconnect_all ();
2848 std::vector<EngineStateController::MidiPortState> midi_port_states;
2849 EngineStateController::instance()->get_physical_midi_output_states (midi_port_states);
2851 std::vector<EngineStateController::MidiPortState>::iterator state_iter = midi_port_states.begin();
2853 for (; state_iter != midi_port_states.end(); ++state_iter) {
2854 if (state_iter->active && state_iter->available && state_iter->scene_connected) {
2855 scene_out_ptr->connect (state_iter->name);
2863 Session::reconnect_mtc_ports ()
2865 boost::shared_ptr<MidiPort> mtc_in_ptr = _midi_ports->mtc_input_port();
2871 mtc_in_ptr->disconnect_all ();
2873 std::vector<EngineStateController::MidiPortState> midi_port_states;
2874 EngineStateController::instance()->get_physical_midi_input_states (midi_port_states);
2876 std::vector<EngineStateController::MidiPortState>::iterator state_iter = midi_port_states.begin();
2878 for (; state_iter != midi_port_states.end(); ++state_iter) {
2879 if (state_iter->available && state_iter->mtc_in) {
2880 mtc_in_ptr->connect (state_iter->name);
2884 if (!_midi_ports->mtc_input_port ()->connected () &&
2885 config.get_external_sync () &&
2886 (Config->get_sync_source () == MTC) ) {
2887 config.set_external_sync (false);
2890 if ( ARDOUR::Profile->get_trx () ) {
2891 // Tracks need this signal to update timecode_source_dropdown
2892 MtcOrLtcInputPortChanged (); //emit signal
2897 Session::reconnect_mmc_ports(bool inputs)
2899 if (inputs ) { // get all enabled midi input ports
2901 boost::shared_ptr<MidiPort> mmc_in_ptr = _midi_ports->mmc_in();
2903 mmc_in_ptr->disconnect_all ();
2904 std::vector<std::string> enabled_midi_inputs;
2905 EngineStateController::instance()->get_physical_midi_inputs (enabled_midi_inputs);
2907 std::vector<std::string>::iterator port_iter = enabled_midi_inputs.begin();
2909 for (; port_iter != enabled_midi_inputs.end(); ++port_iter) {
2910 mmc_in_ptr->connect (*port_iter);
2914 } else { // get all enabled midi output ports
2916 boost::shared_ptr<MidiPort> mmc_out_ptr = _midi_ports->mmc_out();
2918 mmc_out_ptr->disconnect_all ();
2919 std::vector<std::string> enabled_midi_outputs;
2920 EngineStateController::instance()->get_physical_midi_outputs (enabled_midi_outputs);
2922 std::vector<std::string>::iterator port_iter = enabled_midi_outputs.begin();
2924 for (; port_iter != enabled_midi_outputs.end(); ++port_iter) {
2925 mmc_out_ptr->connect (*port_iter);
2934 Session::ensure_route_presentation_info_gap (PresentationInfo::order_t first_new_order, uint32_t how_many)
2936 if (first_new_order == PresentationInfo::max_order) {
2937 /* adding at end, no worries */
2941 /* create a gap in the presentation info to accomodate @param how_many
2945 get_stripables (sl);
2947 for (StripableList::iterator si = sl.begin(); si != sl.end(); ++si) {
2948 boost::shared_ptr<Stripable> s (*si);
2950 if (s->is_monitor() || s->is_auditioner()) {
2954 if (s->presentation_info().order () >= first_new_order) {
2955 s->set_presentation_order (s->presentation_info().order () + how_many);
2960 /** Caller must not hold process lock
2961 * @param name_template string to use for the start of the name, or "" to use "Audio".
2963 list< boost::shared_ptr<AudioTrack> >
2964 Session::new_audio_track (int input_channels, int output_channels, RouteGroup* route_group,
2965 uint32_t how_many, string name_template, PresentationInfo::order_t order,
2969 uint32_t track_id = 0;
2971 RouteList new_routes;
2972 list<boost::shared_ptr<AudioTrack> > ret;
2974 const string name_pattern = default_track_name_pattern (DataType::AUDIO);
2975 bool const use_number = (how_many != 1) || name_template.empty () || (name_template == name_pattern);
2979 if (!find_route_name (name_template.empty() ? _(name_pattern.c_str()) : name_template, ++track_id, track_name, use_number)) {
2980 error << "cannot find name for new audio track" << endmsg;
2984 boost::shared_ptr<AudioTrack> track;
2987 track.reset (new AudioTrack (*this, track_name, mode));
2989 if (track->init ()) {
2993 if (Profile->get_mixbus ()) {
2994 track->set_strict_io (true);
2997 if (ARDOUR::Profile->get_trx ()) {
2998 // TRACKS considers it's not a USE CASE, it's
2999 // a piece of behavior of the session model:
3001 // Gain for a newly created route depends on
3002 // the current output_auto_connect mode:
3004 // 0 for Stereo Out mode
3006 if (Config->get_output_auto_connect() & AutoConnectMaster) {
3007 track->gain_control()->set_value (dB_to_coefficient (0), Controllable::NoGroup);
3011 track->use_new_diskstream();
3013 BOOST_MARK_TRACK (track);
3016 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
3018 if (track->input()->ensure_io (ChanCount(DataType::AUDIO, input_channels), false, this)) {
3019 error << string_compose (
3020 _("cannot configure %1 in/%2 out configuration for new audio track"),
3021 input_channels, output_channels)
3026 if (track->output()->ensure_io (ChanCount(DataType::AUDIO, output_channels), false, this)) {
3027 error << string_compose (
3028 _("cannot configure %1 in/%2 out configuration for new audio track"),
3029 input_channels, output_channels)
3036 route_group->add (track);
3039 track->non_realtime_input_change();
3041 track->DiskstreamChanged.connect_same_thread (*this, boost::bind (&Session::resort_routes, this));
3043 new_routes.push_back (track);
3044 ret.push_back (track);
3047 catch (failed_constructor &err) {
3048 error << _("Session: could not create new audio track.") << endmsg;
3052 catch (AudioEngine::PortRegistrationFailure& pfe) {
3054 error << pfe.what() << endmsg;
3062 if (!new_routes.empty()) {
3063 StateProtector sp (this);
3064 if (Profile->get_trx()) {
3065 add_routes (new_routes, false, false, false, order);
3067 add_routes (new_routes, true, true, false, order);
3074 /** Caller must not hold process lock.
3075 * @param name_template string to use for the start of the name, or "" to use "Bus".
3078 Session::new_audio_route (int input_channels, int output_channels, RouteGroup* route_group, uint32_t how_many, string name_template,
3079 PresentationInfo::Flag flags, PresentationInfo::order_t order)
3082 uint32_t bus_id = 0;
3086 bool const use_number = (how_many != 1) || name_template.empty () || name_template == _("Bus");
3089 if (!find_route_name (name_template.empty () ? _("Bus") : name_template, ++bus_id, bus_name, use_number)) {
3090 error << "cannot find name for new audio bus" << endmsg;
3095 boost::shared_ptr<Route> bus (new Route (*this, bus_name, flags, DataType::AUDIO));
3101 if (Profile->get_mixbus ()) {
3102 bus->set_strict_io (true);
3105 BOOST_MARK_ROUTE(bus);
3108 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
3110 if (bus->input()->ensure_io (ChanCount(DataType::AUDIO, input_channels), false, this)) {
3111 error << string_compose (_("cannot configure %1 in/%2 out configuration for new audio track"),
3112 input_channels, output_channels)
3118 if (bus->output()->ensure_io (ChanCount(DataType::AUDIO, output_channels), false, this)) {
3119 error << string_compose (_("cannot configure %1 in/%2 out configuration for new audio track"),
3120 input_channels, output_channels)
3127 route_group->add (bus);
3130 bus->add_internal_return ();
3131 ret.push_back (bus);
3134 catch (failed_constructor &err) {
3135 error << _("Session: could not create new audio route.") << endmsg;
3139 catch (AudioEngine::PortRegistrationFailure& pfe) {
3140 error << pfe.what() << endmsg;
3150 StateProtector sp (this);
3151 if (Profile->get_trx()) {
3152 add_routes (ret, false, false, false, order);
3154 add_routes (ret, false, true, true, order); // autoconnect // outputs only
3163 Session::new_route_from_template (uint32_t how_many, const std::string& template_path, const std::string& name_base, PlaylistDisposition pd)
3167 if (!tree.read (template_path.c_str())) {
3171 return new_route_from_template (how_many, *tree.root(), name_base, pd);
3175 Session::new_route_from_template (uint32_t how_many, XMLNode& node, const std::string& name_base, PlaylistDisposition pd)
3178 uint32_t number = 0;
3179 const uint32_t being_added = how_many;
3180 /* This will prevent the use of any existing XML-provided PBD::ID
3183 Stateful::ForceIDRegeneration force_ids;
3184 IO::disable_connecting ();
3188 /* We're going to modify the node contents a bit so take a
3189 * copy. The node may be re-used when duplicating more than once.
3192 XMLNode node_copy (node);
3197 if (!name_base.empty()) {
3199 /* if we're adding more than one routes, force
3200 * all the names of the new routes to be
3201 * numbered, via the final parameter.
3204 if (!find_route_name (name_base.c_str(), ++number, name, (being_added > 1))) {
3205 fatal << _("Session: UINT_MAX routes? impossible!") << endmsg;
3211 string const route_name = node_copy.property(X_("name"))->value ();
3213 /* generate a new name by adding a number to the end of the template name */
3214 if (!find_route_name (route_name.c_str(), ++number, name, true)) {
3215 fatal << _("Session: UINT_MAX routes? impossible!") << endmsg;
3216 abort(); /*NOTREACHED*/
3220 /* set this name in the XML description that we are about to use */
3222 bool rename_playlist;
3225 rename_playlist = true;
3230 rename_playlist = false;
3233 Route::set_name_in_state (node_copy, name, rename_playlist);
3235 /* trim bitslots from listen sends so that new ones are used */
3236 XMLNodeList children = node_copy.children ();
3237 for (XMLNodeList::iterator i = children.begin(); i != children.end(); ++i) {
3238 if ((*i)->name() == X_("Processor")) {
3239 /* ForceIDRegeneration does not catch the following */
3240 XMLProperty const * role = (*i)->property (X_("role"));
3241 XMLProperty const * type = (*i)->property (X_("type"));
3242 if (role && role->value() == X_("Aux")) {
3243 /* check if the target bus exists.
3244 * we should not save aux-sends in templates.
3246 XMLProperty const * target = (*i)->property (X_("target"));
3248 (*i)->add_property ("type", "dangling-aux-send");
3251 boost::shared_ptr<Route> r = route_by_id (target->value());
3252 if (!r || boost::dynamic_pointer_cast<Track>(r)) {
3253 (*i)->add_property ("type", "dangling-aux-send");
3257 if (role && role->value() == X_("Listen")) {
3258 (*i)->remove_property (X_("bitslot"));
3260 else if (role && (role->value() == X_("Send") || role->value() == X_("Aux"))) {
3262 Delivery::Role xrole;
3263 uint32_t bitslot = 0;
3264 xrole = Delivery::Role (string_2_enum (role->value(), xrole));
3265 std::string name = Send::name_and_id_new_send(*this, xrole, bitslot, false);
3266 snprintf (buf, sizeof (buf), "%" PRIu32, bitslot);
3267 (*i)->remove_property (X_("bitslot"));
3268 (*i)->remove_property (X_("name"));
3269 (*i)->add_property ("bitslot", buf);
3270 (*i)->add_property ("name", name);
3272 else if (type && type->value() == X_("intreturn")) {
3273 (*i)->remove_property (X_("bitslot"));
3274 (*i)->add_property ("ignore-bitslot", "1");
3276 else if (type && type->value() == X_("return")) {
3277 // Return::set_state() generates a new one
3278 (*i)->remove_property (X_("bitslot"));
3280 else if (type && type->value() == X_("port")) {
3281 // PortInsert::set_state() handles the bitslot
3282 (*i)->remove_property (X_("bitslot"));
3283 (*i)->add_property ("ignore-name", "1");
3288 boost::shared_ptr<Route> route (XMLRouteFactory (node_copy, 3000));
3291 error << _("Session: cannot create track/bus from template description") << endmsg;
3295 if (boost::dynamic_pointer_cast<Track>(route)) {
3296 /* force input/output change signals so that the new diskstream
3297 picks up the configuration of the route. During session
3298 loading this normally happens in a different way.
3301 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
3303 IOChange change (IOChange::Type (IOChange::ConfigurationChanged | IOChange::ConnectionsChanged));
3304 change.after = route->input()->n_ports();
3305 route->input()->changed (change, this);
3306 change.after = route->output()->n_ports();
3307 route->output()->changed (change, this);
3310 boost::shared_ptr<Track> track;
3312 if ((track = boost::dynamic_pointer_cast<Track> (route))) {
3315 track->use_new_playlist ();
3318 track->use_copy_playlist ();
3325 ret.push_back (route);
3328 catch (failed_constructor &err) {
3329 error << _("Session: could not create new route from template") << endmsg;
3333 catch (AudioEngine::PortRegistrationFailure& pfe) {
3334 error << pfe.what() << endmsg;
3343 StateProtector sp (this);
3344 if (Profile->get_trx()) {
3345 add_routes (ret, false, false, false, PresentationInfo::max_order);
3347 add_routes (ret, true, true, false, PresentationInfo::max_order);
3349 IO::enable_connecting ();
3356 Session::add_routes (RouteList& new_routes, bool input_auto_connect, bool output_auto_connect, bool save, PresentationInfo::order_t order)
3359 PBD::Unwinder<bool> aip (_adding_routes_in_progress, true);
3360 add_routes_inner (new_routes, input_auto_connect, output_auto_connect, order);
3363 error << _("Adding new tracks/busses failed") << endmsg;
3368 update_latency (true);
3369 update_latency (false);
3374 save_state (_current_snapshot_name);
3377 update_route_record_state ();
3379 RouteAdded (new_routes); /* EMIT SIGNAL */
3383 Session::add_routes_inner (RouteList& new_routes, bool input_auto_connect, bool output_auto_connect, PresentationInfo::order_t order)
3385 ChanCount existing_inputs;
3386 ChanCount existing_outputs;
3390 count_existing_track_channels (existing_inputs, existing_outputs);
3393 RCUWriter<RouteList> writer (routes);
3394 boost::shared_ptr<RouteList> r = writer.get_copy ();
3395 r->insert (r->end(), new_routes.begin(), new_routes.end());
3396 n_routes = r->size();
3398 /* if there is no control out and we're not in the middle of loading,
3399 * resort the graph here. if there is a control out, we will resort
3400 * toward the end of this method. if we are in the middle of loading,
3401 * we will resort when done.
3404 if (!_monitor_out && IO::connecting_legal) {
3405 resort_routes_using (r);
3409 DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("ensure order gap starting at %1 for %2\n", order, new_routes.size()));
3410 ensure_route_presentation_info_gap (order, new_routes.size());
3412 for (RouteList::iterator x = new_routes.begin(); x != new_routes.end(); ++x, ++added) {
3414 boost::weak_ptr<Route> wpr (*x);
3415 boost::shared_ptr<Route> r (*x);
3417 r->solo_control()->Changed.connect_same_thread (*this, boost::bind (&Session::route_solo_changed, this, _1, _2,wpr));
3418 r->solo_isolate_control()->Changed.connect_same_thread (*this, boost::bind (&Session::route_solo_isolated_changed, this, wpr));
3419 r->mute_control()->Changed.connect_same_thread (*this, boost::bind (&Session::route_mute_changed, this));
3421 r->output()->changed.connect_same_thread (*this, boost::bind (&Session::set_worst_io_latencies_x, this, _1, _2));
3422 r->processors_changed.connect_same_thread (*this, boost::bind (&Session::route_processors_changed, this, _1));
3423 r->processor_latency_changed.connect_same_thread (*this, boost::bind (&Session::queue_latency_recompute, this));
3425 if (r->is_master()) {
3429 if (r->is_monitor()) {
3433 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (r);
3435 tr->PlaylistChanged.connect_same_thread (*this, boost::bind (&Session::track_playlist_changed, this, boost::weak_ptr<Track> (tr)));
3436 track_playlist_changed (boost::weak_ptr<Track> (tr));
3437 tr->rec_enable_control()->Changed.connect_same_thread (*this, boost::bind (&Session::update_route_record_state, this));
3439 boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (tr);
3441 mt->StepEditStatusChange.connect_same_thread (*this, boost::bind (&Session::step_edit_status_change, this, _1));
3442 mt->output()->changed.connect_same_thread (*this, boost::bind (&Session::midi_output_change_handler, this, _1, _2, boost::weak_ptr<Route>(mt)));
3446 if (!r->presentation_info().special()) {
3448 DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("checking PI state for %1\n", r->name()));
3450 /* presentation info order may already have been set from XML */
3452 if (!r->presentation_info().order_set()) {
3454 if (order == PresentationInfo::max_order) {
3455 /* just add to the end */
3456 r->set_presentation_order (n_routes + added, false);
3457 DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("group order not set, set to NR %1 + %2 = %3\n", n_routes, added, n_routes + added));
3459 r->set_presentation_order (order + added);
3460 DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("group order not set, set to %1 + %2 = %3\n", order, added, order + added));
3463 DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("group order already set to %1\n", r->presentation_info().order()));
3467 #if !defined(__APPLE__) && !defined(__FreeBSD__)
3468 /* clang complains: 'operator<<' should be declared prior to the call site or in an associated namespace of one of its
3469 * arguments std::ostream& operator<<(std::ostream& o, ARDOUR::PresentationInfo const& rid)"
3471 DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("added route %1, group order %2 type %3 (summary: %4)\n",
3473 r->presentation_info().order(),
3474 enum_2_string (r->presentation_info().flags()),
3475 r->presentation_info()));
3479 if (input_auto_connect || output_auto_connect) {
3480 auto_connect_route (r, input_auto_connect, ChanCount (), ChanCount (), existing_inputs, existing_outputs);
3481 existing_inputs += r->n_inputs();
3482 existing_outputs += r->n_outputs();
3488 if (_monitor_out && IO::connecting_legal) {
3489 Glib::Threads::Mutex::Lock lm (_engine.process_lock());
3491 for (RouteList::iterator x = new_routes.begin(); x != new_routes.end(); ++x) {
3492 if ((*x)->is_monitor()) {
3494 } else if ((*x)->is_master()) {
3497 (*x)->enable_monitor_send ();
3502 reassign_track_numbers ();
3506 Session::globally_set_send_gains_to_zero (boost::shared_ptr<Route> dest)
3508 boost::shared_ptr<RouteList> r = routes.reader ();
3509 boost::shared_ptr<Send> s;
3511 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3512 if ((s = (*i)->internal_send_for (dest)) != 0) {
3513 s->amp()->gain_control()->set_value (GAIN_COEFF_ZERO, Controllable::NoGroup);
3519 Session::globally_set_send_gains_to_unity (boost::shared_ptr<Route> dest)
3521 boost::shared_ptr<RouteList> r = routes.reader ();
3522 boost::shared_ptr<Send> s;
3524 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3525 if ((s = (*i)->internal_send_for (dest)) != 0) {
3526 s->amp()->gain_control()->set_value (GAIN_COEFF_UNITY, Controllable::NoGroup);
3532 Session::globally_set_send_gains_from_track(boost::shared_ptr<Route> dest)
3534 boost::shared_ptr<RouteList> r = routes.reader ();
3535 boost::shared_ptr<Send> s;
3537 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3538 if ((s = (*i)->internal_send_for (dest)) != 0) {
3539 s->amp()->gain_control()->set_value ((*i)->gain_control()->get_value(), Controllable::NoGroup);
3544 /** @param include_buses true to add sends to buses and tracks, false for just tracks */
3546 Session::globally_add_internal_sends (boost::shared_ptr<Route> dest, Placement p, bool include_buses)
3548 boost::shared_ptr<RouteList> r = routes.reader ();
3549 boost::shared_ptr<RouteList> t (new RouteList);
3551 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3552 /* no MIDI sends because there are no MIDI busses yet */
3553 if (include_buses || boost::dynamic_pointer_cast<AudioTrack>(*i)) {
3558 add_internal_sends (dest, p, t);
3562 Session::add_internal_sends (boost::shared_ptr<Route> dest, Placement p, boost::shared_ptr<RouteList> senders)
3564 for (RouteList::iterator i = senders->begin(); i != senders->end(); ++i) {
3565 add_internal_send (dest, (*i)->before_processor_for_placement (p), *i);
3570 Session::add_internal_send (boost::shared_ptr<Route> dest, int index, boost::shared_ptr<Route> sender)
3572 add_internal_send (dest, sender->before_processor_for_index (index), sender);
3576 Session::add_internal_send (boost::shared_ptr<Route> dest, boost::shared_ptr<Processor> before, boost::shared_ptr<Route> sender)
3578 if (sender->is_monitor() || sender->is_master() || sender == dest || dest->is_monitor() || dest->is_master()) {
3582 if (!dest->internal_return()) {
3583 dest->add_internal_return ();
3586 sender->add_aux_send (dest, before);
3592 Session::remove_routes (boost::shared_ptr<RouteList> routes_to_remove)
3594 { // RCU Writer scope
3595 PBD::Unwinder<bool> uw_flag (_route_deletion_in_progress, true);
3596 RCUWriter<RouteList> writer (routes);
3597 boost::shared_ptr<RouteList> rs = writer.get_copy ();
3600 for (RouteList::iterator iter = routes_to_remove->begin(); iter != routes_to_remove->end(); ++iter) {
3602 if (*iter == _master_out) {
3606 (*iter)->solo_control()->set_value (0.0, Controllable::NoGroup);
3610 /* deleting the master out seems like a dumb
3611 idea, but its more of a UI policy issue
3615 if (*iter == _master_out) {
3616 _master_out = boost::shared_ptr<Route> ();
3619 if (*iter == _monitor_out) {
3620 _monitor_out.reset ();
3623 // We need to disconnect the route's inputs and outputs
3625 (*iter)->input()->disconnect (0);
3626 (*iter)->output()->disconnect (0);
3628 /* if the route had internal sends sending to it, remove them */
3629 if ((*iter)->internal_return()) {
3631 boost::shared_ptr<RouteList> r = routes.reader ();
3632 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3633 boost::shared_ptr<Send> s = (*i)->internal_send_for (*iter);
3635 (*i)->remove_processor (s);
3640 /* if the monitoring section had a pointer to this route, remove it */
3641 if (_monitor_out && !(*iter)->is_master() && !(*iter)->is_monitor()) {
3642 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
3643 PBD::Unwinder<bool> uw (ignore_route_processor_changes, true);
3644 (*iter)->remove_aux_or_listen (_monitor_out);
3647 boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (*iter);
3648 if (mt && mt->step_editing()) {
3649 if (_step_editors > 0) {
3655 /* writer goes out of scope, forces route list update */
3657 } // end of RCU Writer scope
3659 update_route_solo_state ();
3660 update_latency_compensation ();
3663 /* Re-sort routes to remove the graph's current references to the one that is
3664 * going away, then flush old references out of the graph.
3665 * Wave Tracks: reconnect routes
3668 #ifdef USE_TRACKS_CODE_FEATURES
3669 reconnect_existing_routes(true, false);
3671 routes.flush (); // maybe unsafe, see below.
3675 if (_process_graph && !(_state_of_the_state & Deletion)) {
3676 _process_graph->clear_other_chain ();
3679 /* get rid of it from the dead wood collection in the route list manager */
3680 /* XXX i think this is unsafe as it currently stands, but i am not sure. (pd, october 2nd, 2006) */
3684 /* try to cause everyone to drop their references
3685 * and unregister ports from the backend
3688 for (RouteList::iterator iter = routes_to_remove->begin(); iter != routes_to_remove->end(); ++iter) {
3689 (*iter)->drop_references ();
3692 if (_state_of_the_state & Deletion) {
3696 PresentationInfo::Change(); /* EMIT SIGNAL */
3698 /* save the new state of the world */
3700 if (save_state (_current_snapshot_name)) {
3701 save_history (_current_snapshot_name);
3704 update_route_record_state ();
3708 Session::remove_route (boost::shared_ptr<Route> route)
3710 boost::shared_ptr<RouteList> rl (new RouteList);
3711 rl->push_back (route);
3716 Session::route_mute_changed ()
3722 Session::route_listen_changed (Controllable::GroupControlDisposition group_override, boost::weak_ptr<Route> wpr)
3724 boost::shared_ptr<Route> route (wpr.lock());
3730 assert (Config->get_solo_control_is_listen_control());
3732 if (route->solo_control()->soloed_by_self_or_masters()) {
3734 if (Config->get_exclusive_solo()) {
3736 RouteGroup* rg = route->route_group ();
3737 const bool group_already_accounted_for = (group_override == Controllable::ForGroup);
3739 boost::shared_ptr<RouteList> r = routes.reader ();
3741 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3742 if ((*i) == route) {
3743 /* already changed */
3747 if ((*i)->solo_isolate_control()->solo_isolated() || !(*i)->can_solo()) {
3748 /* route does not get solo propagated to it */
3752 if ((group_already_accounted_for && (*i)->route_group() && (*i)->route_group() == rg)) {
3753 /* this route is a part of the same solo group as the route
3754 * that was changed. Changing that route did change or will
3755 * change all group members appropriately, so we can ignore it
3760 (*i)->solo_control()->set_value (0.0, Controllable::NoGroup);
3766 } else if (_listen_cnt > 0) {
3771 update_route_solo_state ();
3775 Session::route_solo_isolated_changed (boost::weak_ptr<Route> wpr)
3777 boost::shared_ptr<Route> route (wpr.lock());
3783 bool send_changed = false;
3785 if (route->solo_isolate_control()->solo_isolated()) {
3786 if (_solo_isolated_cnt == 0) {
3787 send_changed = true;
3789 _solo_isolated_cnt++;
3790 } else if (_solo_isolated_cnt > 0) {
3791 _solo_isolated_cnt--;
3792 if (_solo_isolated_cnt == 0) {
3793 send_changed = true;
3798 IsolatedChanged (); /* EMIT SIGNAL */
3803 Session::route_solo_changed (bool self_solo_changed, Controllable::GroupControlDisposition group_override, boost::weak_ptr<Route> wpr)
3805 DEBUG_TRACE (DEBUG::Solo, string_compose ("route solo change, self = %1\n", self_solo_changed));
3807 boost::shared_ptr<Route> route (wpr.lock());
3813 if (Config->get_solo_control_is_listen_control()) {
3814 route_listen_changed (group_override, wpr);
3818 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()));
3820 if (route->solo_control()->transitioned_into_solo() == 0) {
3821 /* route solo changed by upstream/downstream; not interesting
3824 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()));
3828 if (route->solo_control()->transitioned_into_solo() == 0) {
3829 /* reason for being soloed changed (e.g. master went away, we
3830 * took over the master state), but actual status did
3831 * not. nothing to do.
3833 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1: solo change was change in reason, not status\n", route->name()));
3836 boost::shared_ptr<RouteList> r = routes.reader ();
3837 int32_t delta = route->solo_control()->transitioned_into_solo ();
3839 /* the route may be a member of a group that has shared-solo
3840 * semantics. If so, then all members of that group should follow the
3841 * solo of the changed route. But ... this is optional, controlled by a
3842 * Controllable::GroupControlDisposition.
3844 * The first argument to the signal that this method is connected to is the
3845 * GroupControlDisposition value that was used to change solo.
3847 * If the solo change was done with group semantics (either InverseGroup
3848 * (force the entire group to change even if the group shared solo is
3849 * disabled) or UseGroup (use the group, which may or may not have the
3850 * shared solo property enabled)) then as we propagate the change to
3851 * the entire session we should IGNORE THE GROUP that the changed route
3855 RouteGroup* rg = route->route_group ();
3856 const bool group_already_accounted_for = (group_override == Controllable::ForGroup);
3858 if (delta == 1 && Config->get_exclusive_solo()) {
3860 /* new solo: disable all other solos, but not the group if its solo-enabled */
3862 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3864 if ((*i) == route) {
3865 /* already changed */
3869 if ((*i)->solo_isolate_control()->solo_isolated() || !(*i)->can_solo()) {
3870 /* route does not get solo propagated to it */
3874 if ((group_already_accounted_for && (*i)->route_group() && (*i)->route_group() == rg)) {
3875 /* this route is a part of the same solo group as the route
3876 * that was changed. Changing that route did change or will
3877 * change all group members appropriately, so we can ignore it
3883 (*i)->solo_control()->set_value (0.0, group_override);
3887 DEBUG_TRACE (DEBUG::Solo, string_compose ("propagate solo change, delta = %1\n", delta));
3889 RouteList uninvolved;
3891 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1\n", route->name()));
3893 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3894 bool via_sends_only;
3895 bool in_signal_flow;
3897 if ((*i) == route) {
3898 /* already changed */
3902 if ((*i)->solo_isolate_control()->solo_isolated() || !(*i)->can_solo()) {
3903 /* route does not get solo propagated to it */
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) {
4247 if ((*s)->presentation_info().flag_match (flags)) {
4248 if (match_cnt++ == n) {
4254 /* there is no nth stripable that matches the given flags */
4255 return boost::shared_ptr<Stripable>();
4258 boost::shared_ptr<Route>
4259 Session::route_by_selected_count (uint32_t id) const
4261 boost::shared_ptr<RouteList> r = routes.reader ();
4263 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4264 /* NOT IMPLEMENTED */
4267 return boost::shared_ptr<Route> ((Route*) 0);
4270 struct PresentationOrderSorter {
4271 bool operator() (boost::shared_ptr<Stripable> a, boost::shared_ptr<Stripable> b) {
4272 if (a->presentation_info().special() && !b->presentation_info().special()) {
4273 /* a is not ordered, b is; b comes before a */
4275 } else if (!b->presentation_info().order_set() && a->presentation_info().order_set()) {
4276 /* b is not ordered, a is; a comes before b */
4279 return a->presentation_info().order() < b->presentation_info().order();
4285 Session::reassign_track_numbers ()
4289 RouteList r (*(routes.reader ()));
4290 PresentationOrderSorter sorter;
4293 StateProtector sp (this);
4295 for (RouteList::iterator i = r.begin(); i != r.end(); ++i) {
4296 if (boost::dynamic_pointer_cast<Track> (*i)) {
4297 (*i)->set_track_number(++tn);
4299 else if (!(*i)->is_master() && !(*i)->is_monitor() && !(*i)->is_auditioner()) {
4300 (*i)->set_track_number(--bn);
4303 const uint32_t decimals = ceilf (log10f (tn + 1));
4304 const bool decimals_changed = _track_number_decimals != decimals;
4305 _track_number_decimals = decimals;
4307 if (decimals_changed && config.get_track_name_number ()) {
4308 for (RouteList::iterator i = r.begin(); i != r.end(); ++i) {
4309 boost::shared_ptr<Track> t = boost::dynamic_pointer_cast<Track> (*i);
4311 t->resync_track_name();
4314 // trigger GUI re-layout
4315 config.ParameterChanged("track-name-number");
4319 if (DEBUG_ENABLED(DEBUG::OrderKeys)) {
4320 boost::shared_ptr<RouteList> rl = routes.reader ();
4321 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
4322 DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("%1 numbered %2\n", (*i)->name(), (*i)->track_number()));
4330 Session::playlist_region_added (boost::weak_ptr<Region> w)
4332 boost::shared_ptr<Region> r = w.lock ();
4337 /* These are the operations that are currently in progress... */
4338 list<GQuark> curr = _current_trans_quarks;
4341 /* ...and these are the operations during which we want to update
4342 the session range location markers.
4345 ops.push_back (Operations::capture);
4346 ops.push_back (Operations::paste);
4347 ops.push_back (Operations::duplicate_region);
4348 ops.push_back (Operations::insert_file);
4349 ops.push_back (Operations::insert_region);
4350 ops.push_back (Operations::drag_region_brush);
4351 ops.push_back (Operations::region_drag);
4352 ops.push_back (Operations::selection_grab);
4353 ops.push_back (Operations::region_fill);
4354 ops.push_back (Operations::fill_selection);
4355 ops.push_back (Operations::create_region);
4356 ops.push_back (Operations::region_copy);
4357 ops.push_back (Operations::fixed_time_region_copy);
4360 /* See if any of the current operations match the ones that we want */
4362 set_intersection (_current_trans_quarks.begin(), _current_trans_quarks.end(), ops.begin(), ops.end(), back_inserter (in));
4364 /* If so, update the session range markers */
4366 maybe_update_session_range (r->position (), r->last_frame ());
4370 /** Update the session range markers if a is before the current start or
4371 * b is after the current end.
4374 Session::maybe_update_session_range (framepos_t a, framepos_t b)
4376 if (_state_of_the_state & Loading) {
4380 framepos_t session_end_marker_shift_samples = session_end_shift * _nominal_frame_rate;
4382 if (_session_range_location == 0) {
4384 set_session_range_location (a, b + session_end_marker_shift_samples);
4388 if (a < _session_range_location->start()) {
4389 _session_range_location->set_start (a);
4392 if (b > _session_range_location->end()) {
4393 _session_range_location->set_end (b);
4399 Session::playlist_ranges_moved (list<Evoral::RangeMove<framepos_t> > const & ranges)
4401 for (list<Evoral::RangeMove<framepos_t> >::const_iterator i = ranges.begin(); i != ranges.end(); ++i) {
4402 maybe_update_session_range (i->to, i->to + i->length);
4407 Session::playlist_regions_extended (list<Evoral::Range<framepos_t> > const & ranges)
4409 for (list<Evoral::Range<framepos_t> >::const_iterator i = ranges.begin(); i != ranges.end(); ++i) {
4410 maybe_update_session_range (i->from, i->to);
4414 /* Region management */
4416 boost::shared_ptr<Region>
4417 Session::find_whole_file_parent (boost::shared_ptr<Region const> child) const
4419 const RegionFactory::RegionMap& regions (RegionFactory::regions());
4420 RegionFactory::RegionMap::const_iterator i;
4421 boost::shared_ptr<Region> region;
4423 Glib::Threads::Mutex::Lock lm (region_lock);
4425 for (i = regions.begin(); i != regions.end(); ++i) {
4429 if (region->whole_file()) {
4431 if (child->source_equivalent (region)) {
4437 return boost::shared_ptr<Region> ();
4441 Session::destroy_sources (list<boost::shared_ptr<Source> > srcs)
4443 set<boost::shared_ptr<Region> > relevant_regions;
4445 for (list<boost::shared_ptr<Source> >::iterator s = srcs.begin(); s != srcs.end(); ++s) {
4446 RegionFactory::get_regions_using_source (*s, relevant_regions);
4449 for (set<boost::shared_ptr<Region> >::iterator r = relevant_regions.begin(); r != relevant_regions.end(); ) {
4450 set<boost::shared_ptr<Region> >::iterator tmp;
4455 playlists->destroy_region (*r);
4456 RegionFactory::map_remove (*r);
4458 (*r)->drop_sources ();
4459 (*r)->drop_references ();
4461 relevant_regions.erase (r);
4466 for (list<boost::shared_ptr<Source> >::iterator s = srcs.begin(); s != srcs.end(); ) {
4469 Glib::Threads::Mutex::Lock ls (source_lock);
4470 /* remove from the main source list */
4471 sources.erase ((*s)->id());
4474 (*s)->mark_for_remove ();
4475 (*s)->drop_references ();
4484 Session::remove_last_capture ()
4486 list<boost::shared_ptr<Source> > srcs;
4488 boost::shared_ptr<RouteList> rl = routes.reader ();
4489 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
4490 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
4495 list<boost::shared_ptr<Source> >& l = tr->last_capture_sources();
4498 srcs.insert (srcs.end(), l.begin(), l.end());
4503 destroy_sources (srcs);
4505 save_state (_current_snapshot_name);
4510 /* Source Management */
4513 Session::add_source (boost::shared_ptr<Source> source)
4515 pair<SourceMap::key_type, SourceMap::mapped_type> entry;
4516 pair<SourceMap::iterator,bool> result;
4518 entry.first = source->id();
4519 entry.second = source;
4522 Glib::Threads::Mutex::Lock lm (source_lock);
4523 result = sources.insert (entry);
4526 if (result.second) {
4528 /* yay, new source */
4530 boost::shared_ptr<FileSource> fs = boost::dynamic_pointer_cast<FileSource> (source);
4533 if (!fs->within_session()) {
4534 ensure_search_path_includes (Glib::path_get_dirname (fs->path()), fs->type());
4540 boost::shared_ptr<AudioFileSource> afs;
4542 if ((afs = boost::dynamic_pointer_cast<AudioFileSource>(source)) != 0) {
4543 if (Config->get_auto_analyse_audio()) {
4544 Analyser::queue_source_for_analysis (source, false);
4548 source->DropReferences.connect_same_thread (*this, boost::bind (&Session::remove_source, this, boost::weak_ptr<Source> (source)));
4553 Session::remove_source (boost::weak_ptr<Source> src)
4555 if (_state_of_the_state & Deletion) {
4559 SourceMap::iterator i;
4560 boost::shared_ptr<Source> source = src.lock();
4567 Glib::Threads::Mutex::Lock lm (source_lock);
4569 if ((i = sources.find (source->id())) != sources.end()) {
4574 if (!(_state_of_the_state & StateOfTheState (InCleanup|Loading))) {
4576 /* save state so we don't end up with a session file
4577 referring to non-existent sources.
4580 save_state (_current_snapshot_name);
4584 boost::shared_ptr<Source>
4585 Session::source_by_id (const PBD::ID& id)
4587 Glib::Threads::Mutex::Lock lm (source_lock);
4588 SourceMap::iterator i;
4589 boost::shared_ptr<Source> source;
4591 if ((i = sources.find (id)) != sources.end()) {
4598 boost::shared_ptr<AudioFileSource>
4599 Session::audio_source_by_path_and_channel (const string& path, uint16_t chn) const
4601 /* Restricted to audio files because only audio sources have channel
4605 Glib::Threads::Mutex::Lock lm (source_lock);
4607 for (SourceMap::const_iterator i = sources.begin(); i != sources.end(); ++i) {
4608 boost::shared_ptr<AudioFileSource> afs
4609 = boost::dynamic_pointer_cast<AudioFileSource>(i->second);
4611 if (afs && afs->path() == path && chn == afs->channel()) {
4616 return boost::shared_ptr<AudioFileSource>();
4619 boost::shared_ptr<MidiSource>
4620 Session::midi_source_by_path (const std::string& path) const
4622 /* Restricted to MIDI files because audio sources require a channel
4623 for unique identification, in addition to a path.
4626 Glib::Threads::Mutex::Lock lm (source_lock);
4628 for (SourceMap::const_iterator s = sources.begin(); s != sources.end(); ++s) {
4629 boost::shared_ptr<MidiSource> ms
4630 = boost::dynamic_pointer_cast<MidiSource>(s->second);
4631 boost::shared_ptr<FileSource> fs
4632 = boost::dynamic_pointer_cast<FileSource>(s->second);
4634 if (ms && fs && fs->path() == path) {
4639 return boost::shared_ptr<MidiSource>();
4643 Session::count_sources_by_origin (const string& path)
4646 Glib::Threads::Mutex::Lock lm (source_lock);
4648 for (SourceMap::iterator i = sources.begin(); i != sources.end(); ++i) {
4649 boost::shared_ptr<FileSource> fs
4650 = boost::dynamic_pointer_cast<FileSource>(i->second);
4652 if (fs && fs->origin() == path) {
4661 peak_file_helper (const string& peak_path, const string& file_path, const string& file_base, bool hash) {
4663 std::string checksum = Glib::Checksum::compute_checksum(Glib::Checksum::CHECKSUM_SHA1, file_path + G_DIR_SEPARATOR + file_base);
4664 return Glib::build_filename (peak_path, checksum + peakfile_suffix);
4666 return Glib::build_filename (peak_path, file_base + peakfile_suffix);
4671 Session::construct_peak_filepath (const string& filepath, const bool in_session, const bool old_peak_name) const
4673 string interchange_dir_string = string (interchange_dir_name) + G_DIR_SEPARATOR;
4675 if (Glib::path_is_absolute (filepath)) {
4677 /* rip the session dir from the audiofile source */
4679 string session_path;
4680 bool in_another_session = true;
4682 if (filepath.find (interchange_dir_string) != string::npos) {
4684 session_path = Glib::path_get_dirname (filepath); /* now ends in audiofiles */
4685 session_path = Glib::path_get_dirname (session_path); /* now ends in session name */
4686 session_path = Glib::path_get_dirname (session_path); /* now ends in interchange */
4687 session_path = Glib::path_get_dirname (session_path); /* now has session path */
4689 /* see if it is within our session */
4691 for (vector<space_and_path>::const_iterator i = session_dirs.begin(); i != session_dirs.end(); ++i) {
4692 if (i->path == session_path) {
4693 in_another_session = false;
4698 in_another_session = false;
4702 if (in_another_session) {
4703 SessionDirectory sd (session_path);
4704 return peak_file_helper (sd.peak_path(), "", Glib::path_get_basename (filepath), !old_peak_name);
4708 /* 1) if file belongs to this session
4709 * it may be a relative path (interchange/...)
4710 * or just basename (session_state, remove source)
4711 * -> just use the basename
4713 std::string filename = Glib::path_get_basename (filepath);
4716 /* 2) if the file is outside our session dir:
4717 * (imported but not copied) add the path for check-summming */
4719 path = Glib::path_get_dirname (filepath);
4722 return peak_file_helper (_session_dir->peak_path(), path, Glib::path_get_basename (filepath), !old_peak_name);
4726 Session::new_audio_source_path_for_embedded (const std::string& path)
4730 * we know that the filename is already unique because it exists
4731 * out in the filesystem.
4733 * However, when we bring it into the session, we could get a
4736 * Eg. two embedded files:
4741 * When merged into session, these collide.
4743 * There will not be a conflict with in-memory sources
4744 * because when the source was created we already picked
4745 * a unique name for it.
4747 * This collision is not likely to be common, but we have to guard
4748 * against it. So, if there is a collision, take the md5 hash of the
4749 * the path, and use that as the filename instead.
4752 SessionDirectory sdir (get_best_session_directory_for_new_audio());
4753 string base = Glib::path_get_basename (path);
4754 string newpath = Glib::build_filename (sdir.sound_path(), base);
4756 if (Glib::file_test (newpath, Glib::FILE_TEST_EXISTS)) {
4760 md5.digestString (path.c_str());
4761 md5.writeToString ();
4762 base = md5.digestChars;
4764 string ext = get_suffix (path);
4771 newpath = Glib::build_filename (sdir.sound_path(), base);
4773 /* if this collides, we're screwed */
4775 if (Glib::file_test (newpath, Glib::FILE_TEST_EXISTS)) {
4776 error << string_compose (_("Merging embedded file %1: name collision AND md5 hash collision!"), path) << endmsg;
4785 /** Return true if there are no audio file sources that use @param name as
4786 * the filename component of their path.
4788 * Return false otherwise.
4790 * This method MUST ONLY be used to check in-session, mono files since it
4791 * hard-codes the channel of the audio file source we are looking for as zero.
4793 * If/when Ardour supports native files in non-mono formats, the logic here
4794 * will need to be revisited.
4797 Session::audio_source_name_is_unique (const string& name)
4799 std::vector<string> sdirs = source_search_path (DataType::AUDIO);
4800 vector<space_and_path>::iterator i;
4801 uint32_t existing = 0;
4803 for (vector<string>::const_iterator i = sdirs.begin(); i != sdirs.end(); ++i) {
4805 /* note that we search *without* the extension so that
4806 we don't end up both "Audio 1-1.wav" and "Audio 1-1.caf"
4807 in the event that this new name is required for
4808 a file format change.
4811 const string spath = *i;
4813 if (matching_unsuffixed_filename_exists_in (spath, name)) {
4818 /* it is possible that we have the path already
4819 * assigned to a source that has not yet been written
4820 * (ie. the write source for a diskstream). we have to
4821 * check this in order to make sure that our candidate
4822 * path isn't used again, because that can lead to
4823 * two Sources point to the same file with different
4824 * notions of their removability.
4828 string possible_path = Glib::build_filename (spath, name);
4830 if (audio_source_by_path_and_channel (possible_path, 0)) {
4836 return (existing == 0);
4840 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)
4843 const string ext = native_header_format_extension (config.get_native_file_header_format(), DataType::AUDIO);
4845 if (Profile->get_trx() && destructive) {
4847 sstr << setfill ('0') << setw (4) << cnt;
4848 sstr << legalized_base;
4850 sstr << legalized_base;
4852 if (take_required || related_exists) {
4864 } else if (nchan > 2) {
4869 /* XXX what? more than 26 channels! */
4880 /** Return a unique name based on \a base for a new internal audio source */
4882 Session::new_audio_source_path (const string& base, uint32_t nchan, uint32_t chan, bool destructive, bool take_required)
4885 string possible_name;
4886 const uint32_t limit = 9999; // arbitrary limit on number of files with the same basic name
4888 bool some_related_source_name_exists = false;
4890 legalized = legalize_for_path (base);
4892 // Find a "version" of the base name that doesn't exist in any of the possible directories.
4894 for (cnt = (destructive ? ++destructive_index : 1); cnt <= limit; ++cnt) {
4896 possible_name = format_audio_source_name (legalized, nchan, chan, destructive, take_required, cnt, some_related_source_name_exists);
4898 if (audio_source_name_is_unique (possible_name)) {
4902 some_related_source_name_exists = true;
4905 error << string_compose(
4906 _("There are already %1 recordings for %2, which I consider too many."),
4907 limit, base) << endmsg;
4909 throw failed_constructor();
4913 /* We've established that the new name does not exist in any session
4914 * directory, so now find out which one we should use for this new
4918 SessionDirectory sdir (get_best_session_directory_for_new_audio());
4920 std::string s = Glib::build_filename (sdir.sound_path(), possible_name);
4925 /** Return a unique name based on `base` for a new internal MIDI source */
4927 Session::new_midi_source_path (const string& base)
4930 char buf[PATH_MAX+1];
4931 const uint32_t limit = 10000;
4933 string possible_path;
4934 string possible_name;
4937 legalized = legalize_for_path (base);
4939 // Find a "version" of the file name that doesn't exist in any of the possible directories.
4940 std::vector<string> sdirs = source_search_path(DataType::MIDI);
4942 /* - the main session folder is the first in the vector.
4943 * - after checking all locations for file-name uniqueness,
4944 * we keep the one from the last iteration as new file name
4945 * - midi files are small and should just be kept in the main session-folder
4947 * -> reverse the array, check main session folder last and use that as location
4950 std::reverse(sdirs.begin(), sdirs.end());
4952 for (cnt = 1; cnt <= limit; ++cnt) {
4954 vector<space_and_path>::iterator i;
4955 uint32_t existing = 0;
4957 for (vector<string>::const_iterator i = sdirs.begin(); i != sdirs.end(); ++i) {
4959 snprintf (buf, sizeof(buf), "%s-%u.mid", legalized.c_str(), cnt);
4960 possible_name = buf;
4962 possible_path = Glib::build_filename (*i, possible_name);
4964 if (Glib::file_test (possible_path, Glib::FILE_TEST_EXISTS)) {
4968 if (midi_source_by_path (possible_path)) {
4973 if (existing == 0) {
4978 error << string_compose(
4979 _("There are already %1 recordings for %2, which I consider too many."),
4980 limit, base) << endmsg;
4986 /* No need to "find best location" for software/app-based RAID, because
4987 MIDI is so small that we always put it in the same place.
4990 return possible_path;
4994 /** Create a new within-session audio source */
4995 boost::shared_ptr<AudioFileSource>
4996 Session::create_audio_source_for_session (size_t n_chans, string const & base, uint32_t chan, bool destructive)
4998 const string path = new_audio_source_path (base, n_chans, chan, destructive, true);
5000 if (!path.empty()) {
5001 return boost::dynamic_pointer_cast<AudioFileSource> (
5002 SourceFactory::createWritable (DataType::AUDIO, *this, path, destructive, frame_rate(), true, true));
5004 throw failed_constructor ();
5008 /** Create a new within-session MIDI source */
5009 boost::shared_ptr<MidiSource>
5010 Session::create_midi_source_for_session (string const & basic_name)
5012 const string path = new_midi_source_path (basic_name);
5014 if (!path.empty()) {
5015 return boost::dynamic_pointer_cast<SMFSource> (
5016 SourceFactory::createWritable (
5017 DataType::MIDI, *this, path, false, frame_rate()));
5019 throw failed_constructor ();
5023 /** Create a new within-session MIDI source */
5024 boost::shared_ptr<MidiSource>
5025 Session::create_midi_source_by_stealing_name (boost::shared_ptr<Track> track)
5027 /* the caller passes in the track the source will be used in,
5028 so that we can keep the numbering sane.
5030 Rationale: a track with the name "Foo" that has had N
5031 captures carried out so far will ALREADY have a write source
5032 named "Foo-N+1.mid" waiting to be used for the next capture.
5034 If we call new_midi_source_name() we will get "Foo-N+2". But
5035 there is no region corresponding to "Foo-N+1", so when
5036 "Foo-N+2" appears in the track, the gap presents the user
5037 with odd behaviour - why did it skip past Foo-N+1?
5039 We could explain this to the user in some odd way, but
5040 instead we rename "Foo-N+1.mid" as "Foo-N+2.mid", and then
5043 If that attempted rename fails, we get "Foo-N+2.mid" anyway.
5046 boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (track);
5048 std::string name = track->steal_write_source_name ();
5051 return boost::shared_ptr<MidiSource>();
5054 /* MIDI files are small, just put them in the first location of the
5055 session source search path.
5058 const string path = Glib::build_filename (source_search_path (DataType::MIDI).front(), name);
5060 return boost::dynamic_pointer_cast<SMFSource> (
5061 SourceFactory::createWritable (
5062 DataType::MIDI, *this, path, false, frame_rate()));
5067 Session::add_playlist (boost::shared_ptr<Playlist> playlist, bool unused)
5069 if (playlist->hidden()) {
5073 playlists->add (playlist);
5076 playlist->release();
5083 Session::remove_playlist (boost::weak_ptr<Playlist> weak_playlist)
5085 if (_state_of_the_state & Deletion) {
5089 boost::shared_ptr<Playlist> playlist (weak_playlist.lock());
5095 playlists->remove (playlist);
5101 Session::set_audition (boost::shared_ptr<Region> r)
5103 pending_audition_region = r;
5104 add_post_transport_work (PostTransportAudition);
5105 _butler->schedule_transport_work ();
5109 Session::audition_playlist ()
5111 SessionEvent* ev = new SessionEvent (SessionEvent::Audition, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
5112 ev->region.reset ();
5118 Session::register_lua_function (
5119 const std::string& name,
5120 const std::string& script,
5121 const LuaScriptParamList& args
5124 Glib::Threads::Mutex::Lock lm (lua_lock);
5126 lua_State* L = lua.getState();
5128 const std::string& bytecode = LuaScripting::get_factory_bytecode (script);
5129 luabridge::LuaRef tbl_arg (luabridge::newTable(L));
5130 for (LuaScriptParamList::const_iterator i = args.begin(); i != args.end(); ++i) {
5131 if ((*i)->optional && !(*i)->is_set) { continue; }
5132 tbl_arg[(*i)->name] = (*i)->value;
5134 (*_lua_add)(name, bytecode, tbl_arg); // throws luabridge::LuaException
5139 Session::unregister_lua_function (const std::string& name)
5141 Glib::Threads::Mutex::Lock lm (lua_lock);
5142 (*_lua_del)(name); // throws luabridge::LuaException
5143 lua.collect_garbage ();
5147 std::vector<std::string>
5148 Session::registered_lua_functions ()
5150 Glib::Threads::Mutex::Lock lm (lua_lock);
5151 std::vector<std::string> rv;
5154 luabridge::LuaRef list ((*_lua_list)());
5155 for (luabridge::Iterator i (list); !i.isNil (); ++i) {
5156 if (!i.key ().isString ()) { assert(0); continue; }
5157 rv.push_back (i.key ().cast<std::string> ());
5159 } catch (luabridge::LuaException const& e) { }
5164 static void _lua_print (std::string s) {
5165 std::cout << "SessionLua: " << s << "\n";
5170 Session::try_run_lua (pframes_t nframes)
5172 if (_n_lua_scripts == 0) return;
5173 Glib::Threads::Mutex::Lock tm (lua_lock, Glib::Threads::TRY_LOCK);
5175 try { (*_lua_run)(nframes); } catch (luabridge::LuaException const& e) { }
5176 lua.collect_garbage_step ();
5181 Session::setup_lua ()
5184 lua.Print.connect (&_lua_print);
5188 "function ArdourSession ()"
5189 " local self = { scripts = {}, instances = {} }"
5191 " local remove = function (n)"
5192 " self.scripts[n] = nil"
5193 " self.instances[n] = nil"
5194 " Session:scripts_changed()" // call back
5197 " local addinternal = function (n, f, a)"
5198 " assert(type(n) == 'string', 'function-name must be string')"
5199 " assert(type(f) == 'function', 'Given script is a not a function')"
5200 " assert(type(a) == 'table' or type(a) == 'nil', 'Given argument is invalid')"
5201 " assert(self.scripts[n] == nil, 'Callback \"'.. n ..'\" already exists.')"
5202 " self.scripts[n] = { ['f'] = f, ['a'] = a }"
5203 " 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"
5204 " 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 }"
5205 " self.instances[n] = load (string.dump(f, true), nil, nil, env)(a)"
5206 " Session:scripts_changed()" // call back
5209 " local add = function (n, b, a)"
5210 " assert(type(b) == 'string', 'ByteCode must be string')"
5211 " load (b)()" // assigns f
5212 " assert(type(f) == 'string', 'Assigned ByteCode must be string')"
5213 " addinternal (n, load(f), a)"
5216 " local run = function (...)"
5217 " for n, s in pairs (self.instances) do"
5218 " local status, err = pcall (s, ...)"
5219 " if not status then"
5220 " print ('fn \"'.. n .. '\": ', err)"
5227 " local cleanup = function ()"
5228 " self.scripts = nil"
5229 " self.instances = nil"
5232 " local list = function ()"
5234 " for n, _ in pairs (self.scripts) do"
5240 " local function basic_serialize (o)"
5241 " if type(o) == \"number\" then"
5242 " return tostring(o)"
5244 " return string.format(\"%q\", o)"
5248 " local function serialize (name, value)"
5249 " local rv = name .. ' = '"
5251 " if type(value) == \"number\" or type(value) == \"string\" or type(value) == \"nil\" then"
5252 " return rv .. basic_serialize(value) .. ' '"
5253 " elseif type(value) == \"table\" then"
5255 " for k,v in pairs(value) do"
5256 " local fieldname = string.format(\"%s[%s]\", name, basic_serialize(k))"
5257 " rv = rv .. serialize(fieldname, v) .. ' '"
5258 " collectgarbage()" // string concatenation allocates a new string :(
5261 " elseif type(value) == \"function\" then"
5262 " return rv .. string.format(\"%q\", string.dump(value, true))"
5264 " error('cannot save a ' .. type(value))"
5269 " local save = function ()"
5270 " return (serialize('scripts', self.scripts))"
5273 " local restore = function (state)"
5274 " self.scripts = {}"
5276 " for n, s in pairs (scripts) do"
5277 " addinternal (n, load(s['f']), s['a'])"
5281 " return { run = run, add = add, remove = remove,"
5282 " list = list, restore = restore, save = save, cleanup = cleanup}"
5285 " sess = ArdourSession ()"
5286 " ArdourSession = nil"
5288 "function ardour () end"
5291 lua_State* L = lua.getState();
5294 luabridge::LuaRef lua_sess = luabridge::getGlobal (L, "sess");
5295 lua.do_command ("sess = nil"); // hide it.
5296 lua.do_command ("collectgarbage()");
5298 _lua_run = new luabridge::LuaRef(lua_sess["run"]);
5299 _lua_add = new luabridge::LuaRef(lua_sess["add"]);
5300 _lua_del = new luabridge::LuaRef(lua_sess["remove"]);
5301 _lua_list = new luabridge::LuaRef(lua_sess["list"]);
5302 _lua_save = new luabridge::LuaRef(lua_sess["save"]);
5303 _lua_load = new luabridge::LuaRef(lua_sess["restore"]);
5304 _lua_cleanup = new luabridge::LuaRef(lua_sess["cleanup"]);
5305 } catch (luabridge::LuaException const& e) {
5306 fatal << string_compose (_("programming error: %1"),
5307 X_("Failed to setup Lua interpreter"))
5309 abort(); /*NOTREACHED*/
5312 LuaBindings::stddef (L);
5313 LuaBindings::common (L);
5314 LuaBindings::dsp (L);
5315 luabridge::push <Session *> (L, this);
5316 lua_setglobal (L, "Session");
5320 Session::scripts_changed ()
5322 assert (!lua_lock.trylock()); // must hold lua_lock
5325 luabridge::LuaRef list ((*_lua_list)());
5327 for (luabridge::Iterator i (list); !i.isNil (); ++i) {
5328 if (!i.key ().isString ()) { assert(0); continue; }
5331 _n_lua_scripts = cnt;
5332 } catch (luabridge::LuaException const& e) {
5333 fatal << string_compose (_("programming error: %1"),
5334 X_("Indexing Lua Session Scripts failed."))
5336 abort(); /*NOTREACHED*/
5341 Session::non_realtime_set_audition ()
5343 assert (pending_audition_region);
5344 auditioner->audition_region (pending_audition_region);
5345 pending_audition_region.reset ();
5346 AuditionActive (true); /* EMIT SIGNAL */
5350 Session::audition_region (boost::shared_ptr<Region> r)
5352 SessionEvent* ev = new SessionEvent (SessionEvent::Audition, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
5358 Session::cancel_audition ()
5363 if (auditioner->auditioning()) {
5364 auditioner->cancel_audition ();
5365 AuditionActive (false); /* EMIT SIGNAL */
5370 Session::RoutePublicOrderSorter::operator() (boost::shared_ptr<Route> a, boost::shared_ptr<Route> b)
5372 if (a->is_monitor()) {
5375 if (b->is_monitor()) {
5378 return a->presentation_info().order() < b->presentation_info().order();
5382 Session::is_auditioning () const
5384 /* can be called before we have an auditioner object */
5386 return auditioner->auditioning();
5393 Session::graph_reordered ()
5395 /* don't do this stuff if we are setting up connections
5396 from a set_state() call or creating new tracks. Ditto for deletion.
5399 if ((_state_of_the_state & (InitialConnecting|Deletion)) || _adding_routes_in_progress || _reconnecting_routes_in_progress || _route_deletion_in_progress) {
5403 /* every track/bus asked for this to be handled but it was deferred because
5404 we were connecting. do it now.
5407 request_input_change_handling ();
5411 /* force all diskstreams to update their capture offset values to
5412 reflect any changes in latencies within the graph.
5415 boost::shared_ptr<RouteList> rl = routes.reader ();
5416 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
5417 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
5419 tr->set_capture_offset ();
5424 /** @return Number of frames that there is disk space available to write,
5427 boost::optional<framecnt_t>
5428 Session::available_capture_duration ()
5430 Glib::Threads::Mutex::Lock lm (space_lock);
5432 if (_total_free_4k_blocks_uncertain) {
5433 return boost::optional<framecnt_t> ();
5436 float sample_bytes_on_disk = 4.0; // keep gcc happy
5438 switch (config.get_native_file_data_format()) {
5440 sample_bytes_on_disk = 4.0;
5444 sample_bytes_on_disk = 3.0;
5448 sample_bytes_on_disk = 2.0;
5452 /* impossible, but keep some gcc versions happy */
5453 fatal << string_compose (_("programming error: %1"),
5454 X_("illegal native file data format"))
5456 abort(); /*NOTREACHED*/
5459 double scale = 4096.0 / sample_bytes_on_disk;
5461 if (_total_free_4k_blocks * scale > (double) max_framecnt) {
5462 return max_framecnt;
5465 return (framecnt_t) floor (_total_free_4k_blocks * scale);
5469 Session::add_bundle (boost::shared_ptr<Bundle> bundle, bool emit_signal)
5472 RCUWriter<BundleList> writer (_bundles);
5473 boost::shared_ptr<BundleList> b = writer.get_copy ();
5474 b->push_back (bundle);
5478 BundleAddedOrRemoved (); /* EMIT SIGNAL */
5485 Session::remove_bundle (boost::shared_ptr<Bundle> bundle)
5487 bool removed = false;
5490 RCUWriter<BundleList> writer (_bundles);
5491 boost::shared_ptr<BundleList> b = writer.get_copy ();
5492 BundleList::iterator i = find (b->begin(), b->end(), bundle);
5494 if (i != b->end()) {
5501 BundleAddedOrRemoved (); /* EMIT SIGNAL */
5507 boost::shared_ptr<Bundle>
5508 Session::bundle_by_name (string name) const
5510 boost::shared_ptr<BundleList> b = _bundles.reader ();
5512 for (BundleList::const_iterator i = b->begin(); i != b->end(); ++i) {
5513 if ((*i)->name() == name) {
5518 return boost::shared_ptr<Bundle> ();
5522 Session::tempo_map_changed (const PropertyChange&)
5526 playlists->update_after_tempo_map_change ();
5528 _locations->apply (*this, &Session::update_locations_after_tempo_map_change);
5534 Session::gui_tempo_map_changed ()
5538 playlists->update_after_tempo_map_change ();
5540 _locations->apply (*this, &Session::update_locations_after_tempo_map_change);
5544 Session::update_locations_after_tempo_map_change (const Locations::LocationList& loc)
5546 for (Locations::LocationList::const_iterator i = loc.begin(); i != loc.end(); ++i) {
5547 (*i)->recompute_frames_from_bbt ();
5551 /** Ensures that all buffers (scratch, send, silent, etc) are allocated for
5552 * the given count with the current block size.
5555 Session::ensure_buffers (ChanCount howmany)
5557 BufferManager::ensure_buffers (howmany, bounce_processing() ? bounce_chunk_size : 0);
5561 Session::ensure_buffer_set(BufferSet& buffers, const ChanCount& count)
5563 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
5564 buffers.ensure_buffers(*t, count.get(*t), _engine.raw_buffer_size(*t));
5569 Session::next_insert_id ()
5571 /* this doesn't really loop forever. just think about it */
5574 for (boost::dynamic_bitset<uint32_t>::size_type n = 1; n < insert_bitset.size(); ++n) {
5575 if (!insert_bitset[n]) {
5576 insert_bitset[n] = true;
5582 /* none available, so resize and try again */
5584 insert_bitset.resize (insert_bitset.size() + 16, false);
5589 Session::next_send_id ()
5591 /* this doesn't really loop forever. just think about it */
5594 for (boost::dynamic_bitset<uint32_t>::size_type n = 1; n < send_bitset.size(); ++n) {
5595 if (!send_bitset[n]) {
5596 send_bitset[n] = true;
5602 /* none available, so resize and try again */
5604 send_bitset.resize (send_bitset.size() + 16, false);
5609 Session::next_aux_send_id ()
5611 /* this doesn't really loop forever. just think about it */
5614 for (boost::dynamic_bitset<uint32_t>::size_type n = 1; n < aux_send_bitset.size(); ++n) {
5615 if (!aux_send_bitset[n]) {
5616 aux_send_bitset[n] = true;
5622 /* none available, so resize and try again */
5624 aux_send_bitset.resize (aux_send_bitset.size() + 16, false);
5629 Session::next_return_id ()
5631 /* this doesn't really loop forever. just think about it */
5634 for (boost::dynamic_bitset<uint32_t>::size_type n = 1; n < return_bitset.size(); ++n) {
5635 if (!return_bitset[n]) {
5636 return_bitset[n] = true;
5642 /* none available, so resize and try again */
5644 return_bitset.resize (return_bitset.size() + 16, false);
5649 Session::mark_send_id (uint32_t id)
5651 if (id >= send_bitset.size()) {
5652 send_bitset.resize (id+16, false);
5654 if (send_bitset[id]) {
5655 warning << string_compose (_("send ID %1 appears to be in use already"), id) << endmsg;
5657 send_bitset[id] = true;
5661 Session::mark_aux_send_id (uint32_t id)
5663 if (id >= aux_send_bitset.size()) {
5664 aux_send_bitset.resize (id+16, false);
5666 if (aux_send_bitset[id]) {
5667 warning << string_compose (_("aux send ID %1 appears to be in use already"), id) << endmsg;
5669 aux_send_bitset[id] = true;
5673 Session::mark_return_id (uint32_t id)
5675 if (id >= return_bitset.size()) {
5676 return_bitset.resize (id+16, false);
5678 if (return_bitset[id]) {
5679 warning << string_compose (_("return ID %1 appears to be in use already"), id) << endmsg;
5681 return_bitset[id] = true;
5685 Session::mark_insert_id (uint32_t id)
5687 if (id >= insert_bitset.size()) {
5688 insert_bitset.resize (id+16, false);
5690 if (insert_bitset[id]) {
5691 warning << string_compose (_("insert ID %1 appears to be in use already"), id) << endmsg;
5693 insert_bitset[id] = true;
5697 Session::unmark_send_id (uint32_t id)
5699 if (id < send_bitset.size()) {
5700 send_bitset[id] = false;
5705 Session::unmark_aux_send_id (uint32_t id)
5707 if (id < aux_send_bitset.size()) {
5708 aux_send_bitset[id] = false;
5713 Session::unmark_return_id (uint32_t id)
5715 if (_state_of_the_state & Deletion) { return; }
5716 if (id < return_bitset.size()) {
5717 return_bitset[id] = false;
5722 Session::unmark_insert_id (uint32_t id)
5724 if (id < insert_bitset.size()) {
5725 insert_bitset[id] = false;
5730 Session::reset_native_file_format ()
5732 boost::shared_ptr<RouteList> rl = routes.reader ();
5734 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
5735 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
5737 /* don't save state as we do this, there's no point
5739 _state_of_the_state = StateOfTheState (_state_of_the_state|InCleanup);
5740 tr->reset_write_sources (false);
5741 _state_of_the_state = StateOfTheState (_state_of_the_state & ~InCleanup);
5747 Session::route_name_unique (string n) const
5749 boost::shared_ptr<RouteList> r = routes.reader ();
5751 for (RouteList::const_iterator i = r->begin(); i != r->end(); ++i) {
5752 if ((*i)->name() == n) {
5761 Session::route_name_internal (string n) const
5763 if (auditioner && auditioner->name() == n) {
5767 if (_click_io && _click_io->name() == n) {
5775 Session::freeze_all (InterThreadInfo& itt)
5777 boost::shared_ptr<RouteList> r = routes.reader ();
5779 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
5781 boost::shared_ptr<Track> t;
5783 if ((t = boost::dynamic_pointer_cast<Track>(*i)) != 0) {
5784 /* XXX this is wrong because itt.progress will keep returning to zero at the start
5794 boost::shared_ptr<Region>
5795 Session::write_one_track (Track& track, framepos_t start, framepos_t end,
5796 bool /*overwrite*/, vector<boost::shared_ptr<Source> >& srcs,
5797 InterThreadInfo& itt,
5798 boost::shared_ptr<Processor> endpoint, bool include_endpoint,
5799 bool for_export, bool for_freeze)
5801 boost::shared_ptr<Region> result;
5802 boost::shared_ptr<Playlist> playlist;
5803 boost::shared_ptr<Source> source;
5804 ChanCount diskstream_channels (track.n_channels());
5805 framepos_t position;
5806 framecnt_t this_chunk;
5808 framepos_t latency_skip;
5810 framepos_t len = end - start;
5811 bool need_block_size_reset = false;
5812 ChanCount const max_proc = track.max_processor_streams ();
5813 string legal_playlist_name;
5814 string possible_path;
5817 error << string_compose (_("Cannot write a range where end <= start (e.g. %1 <= %2)"),
5818 end, start) << endmsg;
5822 diskstream_channels = track.bounce_get_output_streams (diskstream_channels, endpoint,
5823 include_endpoint, for_export, for_freeze);
5825 if (diskstream_channels.n(track.data_type()) < 1) {
5826 error << _("Cannot write a range with no data.") << endmsg;
5830 // block all process callback handling
5832 block_processing ();
5835 // synchronize with AudioEngine::process_callback()
5836 // make sure processing is not currently running
5837 // and processing_blocked() is honored before
5838 // acquiring thread buffers
5839 Glib::Threads::Mutex::Lock lm (_engine.process_lock());
5842 _bounce_processing_active = true;
5844 /* call tree *MUST* hold route_lock */
5846 if ((playlist = track.playlist()) == 0) {
5850 legal_playlist_name = legalize_for_path (playlist->name());
5852 for (uint32_t chan_n = 0; chan_n < diskstream_channels.n(track.data_type()); ++chan_n) {
5854 string base_name = string_compose ("%1-%2-bounce", playlist->name(), chan_n);
5855 string path = ((track.data_type() == DataType::AUDIO)
5856 ? new_audio_source_path (legal_playlist_name, diskstream_channels.n_audio(), chan_n, false, true)
5857 : new_midi_source_path (legal_playlist_name));
5864 source = SourceFactory::createWritable (track.data_type(), *this, path, false, frame_rate());
5867 catch (failed_constructor& err) {
5868 error << string_compose (_("cannot create new file \"%1\" for %2"), path, track.name()) << endmsg;
5872 srcs.push_back (source);
5875 /* tell redirects that care that we are about to use a much larger
5876 * blocksize. this will flush all plugins too, so that they are ready
5877 * to be used for this process.
5880 need_block_size_reset = true;
5881 track.set_block_size (bounce_chunk_size);
5882 _engine.main_thread()->get_buffers ();
5886 latency_skip = track.bounce_get_latency (endpoint, include_endpoint, for_export, for_freeze);
5888 /* create a set of reasonably-sized buffers */
5889 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
5890 buffers.ensure_buffers(*t, max_proc.get(*t), bounce_chunk_size);
5892 buffers.set_count (max_proc);
5894 for (vector<boost::shared_ptr<Source> >::iterator src = srcs.begin(); src != srcs.end(); ++src) {
5895 boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*src);
5896 boost::shared_ptr<MidiSource> ms;
5898 afs->prepare_for_peakfile_writes ();
5899 } else if ((ms = boost::dynamic_pointer_cast<MidiSource>(*src))) {
5900 Source::Lock lock(ms->mutex());
5901 ms->mark_streaming_write_started(lock);
5905 while (to_do && !itt.cancel) {
5907 this_chunk = min (to_do, bounce_chunk_size);
5909 if (track.export_stuff (buffers, start, this_chunk, endpoint, include_endpoint, for_export, for_freeze)) {
5913 start += this_chunk;
5914 to_do -= this_chunk;
5915 itt.progress = (float) (1.0 - ((double) to_do / len));
5917 if (latency_skip >= bounce_chunk_size) {
5918 latency_skip -= bounce_chunk_size;
5922 const framecnt_t current_chunk = this_chunk - latency_skip;
5925 for (vector<boost::shared_ptr<Source> >::iterator src=srcs.begin(); src != srcs.end(); ++src, ++n) {
5926 boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*src);
5927 boost::shared_ptr<MidiSource> ms;
5930 if (afs->write (buffers.get_audio(n).data(latency_skip), current_chunk) != current_chunk) {
5933 } else if ((ms = boost::dynamic_pointer_cast<MidiSource>(*src))) {
5934 Source::Lock lock(ms->mutex());
5936 const MidiBuffer& buf = buffers.get_midi(0);
5937 for (MidiBuffer::const_iterator i = buf.begin(); i != buf.end(); ++i) {
5938 Evoral::Event<framepos_t> ev = *i;
5939 ev.set_time(ev.time() - position);
5940 ms->append_event_frames(lock, ev, ms->timeline_position());
5947 /* post-roll, pick up delayed processor output */
5948 latency_skip = track.bounce_get_latency (endpoint, include_endpoint, for_export, for_freeze);
5950 while (latency_skip && !itt.cancel) {
5951 this_chunk = min (latency_skip, bounce_chunk_size);
5952 latency_skip -= this_chunk;
5954 buffers.silence (this_chunk, 0);
5955 track.bounce_process (buffers, start, this_chunk, endpoint, include_endpoint, for_export, for_freeze);
5958 for (vector<boost::shared_ptr<Source> >::iterator src=srcs.begin(); src != srcs.end(); ++src, ++n) {
5959 boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*src);
5962 if (afs->write (buffers.get_audio(n).data(), this_chunk) != this_chunk) {
5974 xnow = localtime (&now);
5976 for (vector<boost::shared_ptr<Source> >::iterator src=srcs.begin(); src != srcs.end(); ++src) {
5977 boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*src);
5978 boost::shared_ptr<MidiSource> ms;
5981 afs->update_header (position, *xnow, now);
5982 afs->flush_header ();
5983 } else if ((ms = boost::dynamic_pointer_cast<MidiSource>(*src))) {
5984 Source::Lock lock(ms->mutex());
5985 ms->mark_streaming_write_completed(lock);
5989 /* construct a region to represent the bounced material */
5993 plist.add (Properties::start, 0);
5994 plist.add (Properties::length, srcs.front()->length(srcs.front()->timeline_position()));
5995 plist.add (Properties::name, region_name_from_path (srcs.front()->name(), true));
5997 result = RegionFactory::create (srcs, plist);
6003 for (vector<boost::shared_ptr<Source> >::iterator src = srcs.begin(); src != srcs.end(); ++src) {
6004 (*src)->mark_for_remove ();
6005 (*src)->drop_references ();
6009 for (vector<boost::shared_ptr<Source> >::iterator src = srcs.begin(); src != srcs.end(); ++src) {
6010 boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*src);
6013 afs->done_with_peakfile_writes ();
6017 _bounce_processing_active = false;
6019 if (need_block_size_reset) {
6020 _engine.main_thread()->drop_buffers ();
6021 track.set_block_size (get_block_size());
6024 unblock_processing ();
6030 Session::gain_automation_buffer() const
6032 return ProcessThread::gain_automation_buffer ();
6036 Session::trim_automation_buffer() const
6038 return ProcessThread::trim_automation_buffer ();
6042 Session::send_gain_automation_buffer() const
6044 return ProcessThread::send_gain_automation_buffer ();
6048 Session::pan_automation_buffer() const
6050 return ProcessThread::pan_automation_buffer ();
6054 Session::get_silent_buffers (ChanCount count)
6056 return ProcessThread::get_silent_buffers (count);
6060 Session::get_scratch_buffers (ChanCount count, bool silence)
6062 return ProcessThread::get_scratch_buffers (count, silence);
6066 Session::get_noinplace_buffers (ChanCount count)
6068 return ProcessThread::get_noinplace_buffers (count);
6072 Session::get_route_buffers (ChanCount count, bool silence)
6074 return ProcessThread::get_route_buffers (count, silence);
6079 Session::get_mix_buffers (ChanCount count)
6081 return ProcessThread::get_mix_buffers (count);
6085 Session::ntracks () const
6088 boost::shared_ptr<RouteList> r = routes.reader ();
6090 for (RouteList::const_iterator i = r->begin(); i != r->end(); ++i) {
6091 if (boost::dynamic_pointer_cast<Track> (*i)) {
6100 Session::nbusses () const
6103 boost::shared_ptr<RouteList> r = routes.reader ();
6105 for (RouteList::const_iterator i = r->begin(); i != r->end(); ++i) {
6106 if (boost::dynamic_pointer_cast<Track>(*i) == 0) {
6115 Session::add_automation_list(AutomationList *al)
6117 automation_lists[al->id()] = al;
6120 /** @return true if there is at least one record-enabled track, otherwise false */
6122 Session::have_rec_enabled_track () const
6124 return g_atomic_int_get (const_cast<gint*>(&_have_rec_enabled_track)) == 1;
6128 Session::have_rec_disabled_track () const
6130 return g_atomic_int_get (const_cast<gint*>(&_have_rec_disabled_track)) == 1;
6133 /** Update the state of our rec-enabled tracks flag */
6135 Session::update_route_record_state ()
6137 boost::shared_ptr<RouteList> rl = routes.reader ();
6138 RouteList::iterator i = rl->begin();
6139 while (i != rl->end ()) {
6141 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
6142 if (tr && tr->rec_enable_control()->get_value()) {
6149 int const old = g_atomic_int_get (&_have_rec_enabled_track);
6151 g_atomic_int_set (&_have_rec_enabled_track, i != rl->end () ? 1 : 0);
6153 if (g_atomic_int_get (&_have_rec_enabled_track) != old) {
6154 RecordStateChanged (); /* EMIT SIGNAL */
6157 for (i = rl->begin(); i != rl->end (); ++i) {
6158 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
6159 if (tr && !tr->rec_enable_control()->get_value()) {
6164 g_atomic_int_set (&_have_rec_disabled_track, i != rl->end () ? 1 : 0);
6166 bool record_arm_state_changed = (old != g_atomic_int_get (&_have_rec_enabled_track) );
6168 if (record_status() == Recording && record_arm_state_changed ) {
6169 RecordArmStateChanged ();
6175 Session::listen_position_changed ()
6177 boost::shared_ptr<RouteList> r = routes.reader ();
6179 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6180 (*i)->listen_position_changed ();
6185 Session::solo_control_mode_changed ()
6187 if (soloing() || listening()) {
6188 /* We can't use ::clear_all_solo_state() here because during
6189 session loading at program startup, that will queue a call
6190 to rt_clear_all_solo_state() that will not execute until
6191 AFTER solo states have been established (thus throwing away
6192 the session's saved solo state). So just explicitly turn
6195 set_controls (route_list_to_control_list (get_routes(), &Stripable::solo_control), 0.0, Controllable::NoGroup);
6199 /** Called when a property of one of our route groups changes */
6201 Session::route_group_property_changed (RouteGroup* rg)
6203 RouteGroupPropertyChanged (rg); /* EMIT SIGNAL */
6206 /** Called when a route is added to one of our route groups */
6208 Session::route_added_to_route_group (RouteGroup* rg, boost::weak_ptr<Route> r)
6210 RouteAddedToRouteGroup (rg, r);
6213 /** Called when a route is removed from one of our route groups */
6215 Session::route_removed_from_route_group (RouteGroup* rg, boost::weak_ptr<Route> r)
6217 update_route_record_state ();
6218 RouteRemovedFromRouteGroup (rg, r); /* EMIT SIGNAL */
6221 boost::shared_ptr<RouteList>
6222 Session::get_tracks () const
6224 boost::shared_ptr<RouteList> rl = routes.reader ();
6225 boost::shared_ptr<RouteList> tl (new RouteList);
6227 for (RouteList::const_iterator r = rl->begin(); r != rl->end(); ++r) {
6228 if (boost::dynamic_pointer_cast<Track> (*r)) {
6229 if (!(*r)->is_auditioner()) {
6237 boost::shared_ptr<RouteList>
6238 Session::get_routes_with_regions_at (framepos_t const p) const
6240 boost::shared_ptr<RouteList> r = routes.reader ();
6241 boost::shared_ptr<RouteList> rl (new RouteList);
6243 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6244 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
6249 boost::shared_ptr<Playlist> pl = tr->playlist ();
6254 if (pl->has_region_at (p)) {
6263 Session::goto_end ()
6265 if (_session_range_location) {
6266 request_locate (_session_range_location->end(), false);
6268 request_locate (0, false);
6273 Session::goto_start ()
6275 if (_session_range_location) {
6276 request_locate (_session_range_location->start(), false);
6278 request_locate (0, false);
6283 Session::current_start_frame () const
6285 return _session_range_location ? _session_range_location->start() : 0;
6289 Session::current_end_frame () const
6291 return _session_range_location ? _session_range_location->end() : 0;
6295 Session::set_session_range_location (framepos_t start, framepos_t end)
6297 _session_range_location = new Location (*this, start, end, _("session"), Location::IsSessionRange);
6298 _locations->add (_session_range_location);
6302 Session::step_edit_status_change (bool yn)
6308 send = (_step_editors == 0);
6313 send = (_step_editors == 1);
6316 if (_step_editors > 0) {
6322 StepEditStatusChange (val);
6328 Session::start_time_changed (framepos_t old)
6330 /* Update the auto loop range to match the session range
6331 (unless the auto loop range has been changed by the user)
6334 Location* s = _locations->session_range_location ();
6339 Location* l = _locations->auto_loop_location ();
6341 if (l && l->start() == old) {
6342 l->set_start (s->start(), true);
6347 Session::end_time_changed (framepos_t old)
6349 /* Update the auto loop range to match the session range
6350 (unless the auto loop range has been changed by the user)
6353 Location* s = _locations->session_range_location ();
6358 Location* l = _locations->auto_loop_location ();
6360 if (l && l->end() == old) {
6361 l->set_end (s->end(), true);
6365 std::vector<std::string>
6366 Session::source_search_path (DataType type) const
6370 if (session_dirs.size() == 1) {
6372 case DataType::AUDIO:
6373 sp.push_back (_session_dir->sound_path());
6375 case DataType::MIDI:
6376 sp.push_back (_session_dir->midi_path());
6380 for (vector<space_and_path>::const_iterator i = session_dirs.begin(); i != session_dirs.end(); ++i) {
6381 SessionDirectory sdir (i->path);
6383 case DataType::AUDIO:
6384 sp.push_back (sdir.sound_path());
6386 case DataType::MIDI:
6387 sp.push_back (sdir.midi_path());
6393 if (type == DataType::AUDIO) {
6394 const string sound_path_2X = _session_dir->sound_path_2X();
6395 if (Glib::file_test (sound_path_2X, Glib::FILE_TEST_EXISTS|Glib::FILE_TEST_IS_DIR)) {
6396 if (find (sp.begin(), sp.end(), sound_path_2X) == sp.end()) {
6397 sp.push_back (sound_path_2X);
6402 // now check the explicit (possibly user-specified) search path
6405 case DataType::AUDIO:
6406 sp += Searchpath(config.get_audio_search_path ());
6408 case DataType::MIDI:
6409 sp += Searchpath(config.get_midi_search_path ());
6417 Session::ensure_search_path_includes (const string& path, DataType type)
6426 case DataType::AUDIO:
6427 sp += Searchpath(config.get_audio_search_path ());
6429 case DataType::MIDI:
6430 sp += Searchpath (config.get_midi_search_path ());
6434 for (vector<std::string>::iterator i = sp.begin(); i != sp.end(); ++i) {
6435 /* No need to add this new directory if it has the same inode as
6436 an existing one; checking inode rather than name prevents duplicated
6437 directories when we are using symlinks.
6439 On Windows, I think we could just do if (*i == path) here.
6441 if (PBD::equivalent_paths (*i, path)) {
6449 case DataType::AUDIO:
6450 config.set_audio_search_path (sp.to_string());
6452 case DataType::MIDI:
6453 config.set_midi_search_path (sp.to_string());
6459 Session::remove_dir_from_search_path (const string& dir, DataType type)
6464 case DataType::AUDIO:
6465 sp = Searchpath(config.get_audio_search_path ());
6467 case DataType::MIDI:
6468 sp = Searchpath (config.get_midi_search_path ());
6475 case DataType::AUDIO:
6476 config.set_audio_search_path (sp.to_string());
6478 case DataType::MIDI:
6479 config.set_midi_search_path (sp.to_string());
6485 boost::shared_ptr<Speakers>
6486 Session::get_speakers()
6492 Session::unknown_processors () const
6496 boost::shared_ptr<RouteList> r = routes.reader ();
6497 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6498 list<string> t = (*i)->unknown_processors ();
6499 copy (t.begin(), t.end(), back_inserter (p));
6509 Session::update_latency (bool playback)
6512 DEBUG_TRACE (DEBUG::Latency, string_compose ("JACK latency callback: %1\n", (playback ? "PLAYBACK" : "CAPTURE")));
6514 if ((_state_of_the_state & (InitialConnecting|Deletion)) || _adding_routes_in_progress || _route_deletion_in_progress) {
6518 boost::shared_ptr<RouteList> r = routes.reader ();
6519 framecnt_t max_latency = 0;
6522 /* reverse the list so that we work backwards from the last route to run to the first */
6523 RouteList* rl = routes.reader().get();
6524 r.reset (new RouteList (*rl));
6525 reverse (r->begin(), r->end());
6528 /* compute actual latency values for the given direction and store them all in per-port
6529 structures. this will also publish the same values (to JACK) so that computation of latency
6530 for routes can consistently use public latency values.
6533 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6534 max_latency = max (max_latency, (*i)->set_private_port_latencies (playback));
6537 /* because we latency compensate playback, our published playback latencies should
6538 be the same for all output ports - all material played back by ardour has
6539 the same latency, whether its caused by plugins or by latency compensation. since
6540 these may differ from the values computed above, reset all playback port latencies
6544 DEBUG_TRACE (DEBUG::Latency, string_compose ("Set public port latencies to %1\n", max_latency));
6546 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6547 (*i)->set_public_port_latencies (max_latency, playback);
6552 post_playback_latency ();
6556 post_capture_latency ();
6559 DEBUG_TRACE (DEBUG::Latency, "JACK latency callback: DONE\n");
6563 Session::post_playback_latency ()
6565 set_worst_playback_latency ();
6567 boost::shared_ptr<RouteList> r = routes.reader ();
6569 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6570 if (!(*i)->is_auditioner() && ((*i)->active())) {
6571 _worst_track_latency = max (_worst_track_latency, (*i)->update_signal_latency ());
6575 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6576 (*i)->set_latency_compensation (_worst_track_latency);
6581 Session::post_capture_latency ()
6583 set_worst_capture_latency ();
6585 /* reflect any changes in capture latencies into capture offsets
6588 boost::shared_ptr<RouteList> rl = routes.reader();
6589 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
6590 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
6592 tr->set_capture_offset ();
6598 Session::initialize_latencies ()
6601 Glib::Threads::Mutex::Lock lm (_engine.process_lock());
6602 update_latency (false);
6603 update_latency (true);
6606 set_worst_io_latencies ();
6610 Session::set_worst_io_latencies ()
6612 set_worst_playback_latency ();
6613 set_worst_capture_latency ();
6617 Session::set_worst_playback_latency ()
6619 if (_state_of_the_state & (InitialConnecting|Deletion)) {
6623 _worst_output_latency = 0;
6625 if (!_engine.connected()) {
6629 boost::shared_ptr<RouteList> r = routes.reader ();
6631 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6632 _worst_output_latency = max (_worst_output_latency, (*i)->output()->latency());
6635 DEBUG_TRACE (DEBUG::Latency, string_compose ("Worst output latency: %1\n", _worst_output_latency));
6639 Session::set_worst_capture_latency ()
6641 if (_state_of_the_state & (InitialConnecting|Deletion)) {
6645 _worst_input_latency = 0;
6647 if (!_engine.connected()) {
6651 boost::shared_ptr<RouteList> r = routes.reader ();
6653 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6654 _worst_input_latency = max (_worst_input_latency, (*i)->input()->latency());
6657 DEBUG_TRACE (DEBUG::Latency, string_compose ("Worst input latency: %1\n", _worst_input_latency));
6661 Session::update_latency_compensation (bool force_whole_graph)
6663 bool some_track_latency_changed = false;
6665 if (_state_of_the_state & (InitialConnecting|Deletion)) {
6669 DEBUG_TRACE(DEBUG::Latency, "---------------------------- update latency compensation\n\n");
6671 _worst_track_latency = 0;
6673 boost::shared_ptr<RouteList> r = routes.reader ();
6675 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6676 if (!(*i)->is_auditioner() && ((*i)->active())) {
6678 if ((*i)->signal_latency () != (tl = (*i)->update_signal_latency ())) {
6679 some_track_latency_changed = true;
6681 _worst_track_latency = max (tl, _worst_track_latency);
6685 DEBUG_TRACE (DEBUG::Latency, string_compose ("worst signal processing latency: %1 (changed ? %2)\n", _worst_track_latency,
6686 (some_track_latency_changed ? "yes" : "no")));
6688 DEBUG_TRACE(DEBUG::Latency, "---------------------------- DONE update latency compensation\n\n");
6690 if (some_track_latency_changed || force_whole_graph) {
6691 _engine.update_latencies ();
6695 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6696 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
6700 tr->set_capture_offset ();
6705 Session::session_name_is_legal (const string& path)
6707 char illegal_chars[] = { '/', '\\', ':', ';', '\0' };
6709 for (int i = 0; illegal_chars[i]; ++i) {
6710 if (path.find (illegal_chars[i]) != string::npos) {
6711 return illegal_chars[i];
6719 Session::notify_presentation_info_change ()
6721 if (deletion_in_progress()) {
6725 PresentationInfo::Change (); /* EMIT SIGNAL */
6726 reassign_track_numbers();
6728 #ifdef USE_TRACKS_CODE_FEATURES
6729 /* Waves Tracks: for Waves Tracks session it's required to reconnect their IOs
6730 * if track order has been changed by user
6732 reconnect_existing_routes(true, true);
6738 Session::operation_in_progress (GQuark op) const
6740 return (find (_current_trans_quarks.begin(), _current_trans_quarks.end(), op) != _current_trans_quarks.end());
6743 boost::shared_ptr<Port>
6744 Session::ltc_input_port () const
6746 return _ltc_input->nth (0);
6749 boost::shared_ptr<Port>
6750 Session::ltc_output_port () const
6752 return _ltc_output->nth (0);
6756 Session::reconnect_ltc_input ()
6760 string src = Config->get_ltc_source_port();
6762 _ltc_input->disconnect (this);
6764 if (src != _("None") && !src.empty()) {
6765 _ltc_input->nth (0)->connect (src);
6768 if ( ARDOUR::Profile->get_trx () ) {
6769 // Tracks need this signal to update timecode_source_dropdown
6770 MtcOrLtcInputPortChanged (); //emit signal
6776 Session::reconnect_ltc_output ()
6780 string src = Config->get_ltc_output_port();
6782 _ltc_output->disconnect (this);
6784 if (src != _("None") && !src.empty()) {
6785 _ltc_output->nth (0)->connect (src);
6791 Session::set_range_selection (framepos_t start, framepos_t end)
6793 _range_selection = Evoral::Range<framepos_t> (start, end);
6794 #ifdef USE_TRACKS_CODE_FEATURES
6795 follow_playhead_priority ();
6800 Session::set_object_selection (framepos_t start, framepos_t end)
6802 _object_selection = Evoral::Range<framepos_t> (start, end);
6803 #ifdef USE_TRACKS_CODE_FEATURES
6804 follow_playhead_priority ();
6809 Session::clear_range_selection ()
6811 _range_selection = Evoral::Range<framepos_t> (-1,-1);
6812 #ifdef USE_TRACKS_CODE_FEATURES
6813 follow_playhead_priority ();
6818 Session::clear_object_selection ()
6820 _object_selection = Evoral::Range<framepos_t> (-1,-1);
6821 #ifdef USE_TRACKS_CODE_FEATURES
6822 follow_playhead_priority ();
6827 Session::auto_connect_route (boost::shared_ptr<Route> route, bool connect_inputs,
6828 const ChanCount& input_start,
6829 const ChanCount& output_start,
6830 const ChanCount& input_offset,
6831 const ChanCount& output_offset)
6833 Glib::Threads::Mutex::Lock lx (_auto_connect_queue_lock);
6834 _auto_connect_queue.push (AutoConnectRequest (route, connect_inputs,
6835 input_start, output_start,
6836 input_offset, output_offset));
6838 if (pthread_mutex_trylock (&_auto_connect_mutex) == 0) {
6839 pthread_cond_signal (&_auto_connect_cond);
6840 pthread_mutex_unlock (&_auto_connect_mutex);
6845 Session::queue_latency_recompute ()
6847 g_atomic_int_inc (&_latency_recompute_pending);
6848 if (pthread_mutex_trylock (&_auto_connect_mutex) == 0) {
6849 pthread_cond_signal (&_auto_connect_cond);
6850 pthread_mutex_unlock (&_auto_connect_mutex);
6855 Session::auto_connect (const AutoConnectRequest& ar)
6857 boost::shared_ptr<Route> route = ar.route.lock();
6859 if (!route) { return; }
6861 if (!IO::connecting_legal) {
6865 /* If both inputs and outputs are auto-connected to physical ports,
6866 * use the max of input and output offsets to ensure auto-connected
6867 * port numbers always match up (e.g. the first audio input and the
6868 * first audio output of the route will have the same physical
6869 * port number). Otherwise just use the lowest input or output
6873 const bool in_out_physical =
6874 (Config->get_input_auto_connect() & AutoConnectPhysical)
6875 && (Config->get_output_auto_connect() & AutoConnectPhysical)
6876 && ar.connect_inputs;
6878 const ChanCount in_offset = in_out_physical
6879 ? ChanCount::max(ar.input_offset, ar.output_offset)
6882 const ChanCount out_offset = in_out_physical
6883 ? ChanCount::max(ar.input_offset, ar.output_offset)
6886 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
6887 vector<string> physinputs;
6888 vector<string> physoutputs;
6890 _engine.get_physical_outputs (*t, physoutputs);
6891 _engine.get_physical_inputs (*t, physinputs);
6893 if (!physinputs.empty() && ar.connect_inputs) {
6894 uint32_t nphysical_in = physinputs.size();
6896 for (uint32_t i = ar.input_start.get(*t); i < route->n_inputs().get(*t) && i < nphysical_in; ++i) {
6899 if (Config->get_input_auto_connect() & AutoConnectPhysical) {
6900 port = physinputs[(in_offset.get(*t) + i) % nphysical_in];
6903 if (!port.empty() && route->input()->connect (route->input()->ports().port(*t, i), port, this)) {
6909 if (!physoutputs.empty()) {
6910 uint32_t nphysical_out = physoutputs.size();
6911 for (uint32_t i = ar.output_start.get(*t); i < route->n_outputs().get(*t); ++i) {
6915 * do not create new connections if we reached the limit of physical outputs
6918 if (!(Config->get_output_auto_connect() & AutoConnectMaster) &&
6919 ARDOUR::Profile->get_trx () &&
6920 ar.output_offset.get(*t) == nphysical_out ) {
6924 if ((*t) == DataType::MIDI && (Config->get_output_auto_connect() & AutoConnectPhysical)) {
6925 port = physoutputs[(out_offset.get(*t) + i) % nphysical_out];
6926 } else if ((*t) == DataType::AUDIO && (Config->get_output_auto_connect() & AutoConnectMaster)) {
6927 /* master bus is audio only */
6928 if (_master_out && _master_out->n_inputs().get(*t) > 0) {
6929 port = _master_out->input()->ports().port(*t,
6930 i % _master_out->input()->n_ports().get(*t))->name();
6934 if (!port.empty() && route->output()->connect (route->output()->ports().port(*t, i), port, this)) {
6943 Session::auto_connect_thread_start ()
6945 if (_ac_thread_active) {
6949 while (!_auto_connect_queue.empty ()) {
6950 _auto_connect_queue.pop ();
6953 _ac_thread_active = true;
6954 if (pthread_create (&_auto_connect_thread, NULL, auto_connect_thread, this)) {
6955 _ac_thread_active = false;
6960 Session::auto_connect_thread_terminate ()
6962 if (!_ac_thread_active) {
6965 _ac_thread_active = false;
6968 Glib::Threads::Mutex::Lock lx (_auto_connect_queue_lock);
6969 while (!_auto_connect_queue.empty ()) {
6970 _auto_connect_queue.pop ();
6974 if (pthread_mutex_lock (&_auto_connect_mutex) == 0) {
6975 pthread_cond_signal (&_auto_connect_cond);
6976 pthread_mutex_unlock (&_auto_connect_mutex);
6980 pthread_join (_auto_connect_thread, &status);
6984 Session::auto_connect_thread (void *arg)
6986 Session *s = static_cast<Session *>(arg);
6987 s->auto_connect_thread_run ();
6993 Session::auto_connect_thread_run ()
6995 pthread_set_name (X_("autoconnect"));
6996 SessionEvent::create_per_thread_pool (X_("autoconnect"), 1024);
6997 PBD::notify_event_loops_about_thread_creation (pthread_self(), X_("autoconnect"), 1024);
6998 pthread_mutex_lock (&_auto_connect_mutex);
6999 while (_ac_thread_active) {
7001 if (!_auto_connect_queue.empty ()) {
7002 // Why would we need the process lock ??
7003 // A: if ports are added while we're connecting, the backend's iterator may be invalidated:
7004 // graph_order_callback() -> resort_routes() -> direct_feeds_according_to_reality () -> backend::connected_to()
7005 // All ardour-internal backends use a std::vector xxxAudioBackend::find_port()
7006 // We have control over those, but what does jack do?
7007 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
7009 Glib::Threads::Mutex::Lock lx (_auto_connect_queue_lock);
7010 while (!_auto_connect_queue.empty ()) {
7011 const AutoConnectRequest ar (_auto_connect_queue.front());
7012 _auto_connect_queue.pop ();
7019 if (!actively_recording ()) { // might not be needed,
7020 /* this is only used for updating plugin latencies, the
7021 * graph does not change. so it's safe in general.
7023 * .. update_latency_compensation () entails set_capture_offset()
7024 * which calls Diskstream::set_capture_offset () which
7025 * modifies the capture offset... which can be a proplem
7026 * in "prepare_to_stop"
7028 while (g_atomic_int_and (&_latency_recompute_pending, 0)) {
7029 update_latency_compensation ();
7033 pthread_cond_wait (&_auto_connect_cond, &_auto_connect_mutex);
7035 pthread_mutex_unlock (&_auto_connect_mutex);