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.
27 #include <cstdio> /* sprintf(3) ... grrr */
33 #include <glibmm/threads.h>
34 #include <glibmm/miscutils.h>
35 #include <glibmm/fileutils.h>
37 #include <boost/algorithm/string/erase.hpp>
39 #include "pbd/basename.h"
40 #include "pbd/boost_debug.h"
41 #include "pbd/convert.h"
42 #include "pbd/convert.h"
43 #include "pbd/error.h"
44 #include "pbd/file_utils.h"
46 #include "pbd/search_path.h"
47 #include "pbd/stacktrace.h"
48 #include "pbd/stl_delete.h"
49 #include "pbd/replace_all.h"
50 #include "pbd/unwind.h"
52 #include "ardour/amp.h"
53 #include "ardour/analyser.h"
54 #include "ardour/async_midi_port.h"
55 #include "ardour/audio_buffer.h"
56 #include "ardour/audio_diskstream.h"
57 #include "ardour/audio_port.h"
58 #include "ardour/audio_track.h"
59 #include "ardour/audioengine.h"
60 #include "ardour/audiofilesource.h"
61 #include "ardour/auditioner.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/graph.h"
76 #include "ardour/midiport_manager.h"
77 #include "ardour/scene_changer.h"
78 #include "ardour/midi_track.h"
79 #include "ardour/midi_ui.h"
80 #include "ardour/operations.h"
81 #include "ardour/playlist.h"
82 #include "ardour/plugin.h"
83 #include "ardour/plugin_insert.h"
84 #include "ardour/process_thread.h"
85 #include "ardour/profile.h"
86 #include "ardour/rc_configuration.h"
87 #include "ardour/recent_sessions.h"
88 #include "ardour/region.h"
89 #include "ardour/region_factory.h"
90 #include "ardour/route_graph.h"
91 #include "ardour/route_group.h"
92 #include "ardour/route_sorters.h"
93 #include "ardour/send.h"
94 #include "ardour/session.h"
95 #include "ardour/session_directory.h"
96 #include "ardour/session_playlists.h"
97 #include "ardour/smf_source.h"
98 #include "ardour/source_factory.h"
99 #include "ardour/speakers.h"
100 #include "ardour/tempo.h"
101 #include "ardour/track.h"
102 #include "ardour/user_bundle.h"
103 #include "ardour/utils.h"
105 #include "midi++/port.h"
106 #include "midi++/mmc.h"
110 #include <glibmm/checksum.h>
119 using namespace ARDOUR;
122 bool Session::_disable_all_loaded_plugins = false;
123 bool Session::_bypass_all_loaded_plugins = false;
125 PBD::Signal1<int,uint32_t> Session::AudioEngineSetupRequired;
126 PBD::Signal1<void,std::string> Session::Dialog;
127 PBD::Signal0<int> Session::AskAboutPendingState;
128 PBD::Signal2<int, framecnt_t, framecnt_t> Session::AskAboutSampleRateMismatch;
129 PBD::Signal0<void> Session::SendFeedback;
130 PBD::Signal3<int,Session*,std::string,DataType> Session::MissingFile;
132 PBD::Signal1<void, framepos_t> Session::StartTimeChanged;
133 PBD::Signal1<void, framepos_t> Session::EndTimeChanged;
134 PBD::Signal2<void,std::string, std::string> Session::Exported;
135 PBD::Signal1<int,boost::shared_ptr<Playlist> > Session::AskAboutPlaylistDeletion;
136 PBD::Signal0<void> Session::Quit;
137 PBD::Signal0<void> Session::FeedbackDetected;
138 PBD::Signal0<void> Session::SuccessfulGraphSort;
139 PBD::Signal2<void,std::string,std::string> Session::VersionMismatch;
141 const framecnt_t Session::bounce_chunk_size = 8192;
142 static void clean_up_session_event (SessionEvent* ev) { delete ev; }
143 const SessionEvent::RTeventCallback Session::rt_cleanup (clean_up_session_event);
145 // seconds should be added after the region exceeds end marker
146 #ifdef USE_TRACKS_CODE_FEATURES
147 const uint32_t Session::session_end_shift = 5;
149 const uint32_t Session::session_end_shift = 0;
152 /** @param snapshot_name Snapshot name, without .ardour suffix */
153 Session::Session (AudioEngine &eng,
154 const string& fullpath,
155 const string& snapshot_name,
156 BusProfile* bus_profile,
158 : playlists (new SessionPlaylists)
160 , process_function (&Session::process_with_events)
161 , _bounce_processing_active (false)
162 , waiting_for_sync_offset (false)
163 , _base_frame_rate (0)
164 , _current_frame_rate (0)
165 , _nominal_frame_rate (0)
166 , transport_sub_state (0)
167 , _record_status (Disabled)
168 , _transport_frame (0)
169 , _session_range_location (0)
172 , _transport_speed (0)
173 , _default_transport_speed (1.0)
174 , _last_transport_speed (0)
175 , _target_transport_speed (0.0)
176 , auto_play_legal (false)
177 , _last_slave_transport_frame (0)
178 , maximum_output_latency (0)
179 , _requested_return_frame (-1)
180 , current_block_size (0)
181 , _worst_output_latency (0)
182 , _worst_input_latency (0)
183 , _worst_track_latency (0)
184 , _have_captured (false)
185 , _non_soloed_outs_muted (false)
187 , _solo_isolated_cnt (0)
189 , _was_seamless (Config->get_seamless_loop ())
190 , _under_nsm_control (false)
192 , delta_accumulator_cnt (0)
193 , average_slave_delta (1800) // !!! why 1800 ???
195 , have_first_delta_accumulator (false)
196 , _slave_state (Stopped)
197 , _mtc_active (false)
198 , _ltc_active (false)
199 , post_export_sync (false)
200 , post_export_position (0)
202 , _export_started (false)
203 , _export_rolling (false)
204 , _pre_export_mmc_enabled (false)
205 , _name (snapshot_name)
207 , _send_qf_mtc (false)
208 , _pframes_since_last_mtc (0)
209 , session_midi_feedback (0)
211 , loop_changing (false)
213 , _session_dir (new SessionDirectory (fullpath))
214 , _current_snapshot_name (snapshot_name)
216 , state_was_pending (false)
217 , _state_of_the_state (StateOfTheState(CannotSave|InitialConnecting|Loading))
219 , _save_queued (false)
220 , _last_roll_location (0)
221 , _last_roll_or_reversal_location (0)
222 , _last_record_location (0)
223 , pending_locate_roll (false)
224 , pending_locate_frame (0)
225 , pending_locate_flush (false)
226 , pending_abort (false)
227 , pending_auto_loop (false)
228 , _butler (new Butler (*this))
229 , _post_transport_work (0)
230 , cumulative_rf_motion (0)
232 , _locations (new Locations (*this))
233 , _ignore_skips_updates (false)
234 , _rt_thread_active (false)
235 , _rt_emit_pending (false)
237 , outbound_mtc_timecode_frame (0)
238 , next_quarter_frame_to_send (-1)
239 , _frames_per_timecode_frame (0)
240 , _frames_per_hour (0)
241 , _timecode_frames_per_hour (0)
242 , last_timecode_valid (false)
243 , last_timecode_when (0)
244 , _send_timecode_update (false)
256 , ltc_timecode_offset (0)
257 , ltc_timecode_negative_offset (false)
258 , midi_control_ui (0)
260 , _all_route_group (new RouteGroup (*this, "all"))
261 , routes (new RouteList)
262 , _adding_routes_in_progress (false)
263 , _reconnecting_routes_in_progress (false)
264 , _route_deletion_in_progress (false)
265 , destructive_index (0)
266 , _track_number_decimals(1)
267 , default_fade_steepness (0)
268 , default_fade_msecs (0)
269 , _total_free_4k_blocks (0)
270 , _total_free_4k_blocks_uncertain (false)
271 , no_questions_about_missing_files (false)
274 , _bundles (new BundleList)
275 , _bundle_xml_node (0)
279 , click_emphasis_data (0)
281 , click_emphasis_length (0)
282 , _clicks_cleared (0)
283 , _play_range (false)
284 , _range_selection (-1,-1)
285 , _object_selection (-1,-1)
287 , first_file_data_format_reset (true)
288 , first_file_header_format_reset (true)
289 , have_looped (false)
290 , _have_rec_enabled_track (false)
291 , _have_rec_disabled_track (true)
293 , _suspend_timecode_transmission (0)
294 , _speakers (new Speakers)
296 , ignore_route_processor_changes (false)
303 pthread_mutex_init (&_rt_emit_mutex, 0);
304 pthread_cond_init (&_rt_emit_cond, 0);
306 pre_engine_init (fullpath);
310 Stateful::loading_state_version = CURRENT_SESSION_FILE_VERSION;
312 #ifdef USE_TRACKS_CODE_FEATURES
313 sr = EngineStateController::instance()->get_current_sample_rate();
315 if (ensure_engine (sr)) {
317 throw SessionException (_("Cannot connect to audio/midi engine"));
320 if (create (mix_template, bus_profile)) {
322 throw SessionException (_("Session initialization failed"));
325 /* if a mix template was provided, then ::create() will
326 * have copied it into the session and we need to load it
327 * so that we have the state ready for ::set_state()
328 * after the engine is started.
330 * Note that we do NOT try to get the sample rate from
331 * the template at this time, though doing so would
332 * be easy if we decided this was an appropriate part
336 if (!mix_template.empty()) {
337 if (load_state (_current_snapshot_name)) {
338 throw SessionException (_("Failed to load template/snapshot state"));
340 store_recent_templates (mix_template);
343 /* load default session properties - if any */
348 if (load_state (_current_snapshot_name)) {
349 throw SessionException (_("Failed to load state"));
352 /* try to get sample rate from XML state so that we
353 * can influence the SR if we set up the audio
358 const XMLProperty* prop;
359 if ((prop = state_tree->root()->property (X_("sample-rate"))) != 0) {
360 sr = atoi (prop->value());
364 if (ensure_engine (sr)) {
366 throw SessionException (_("Cannot connect to audio/midi engine"));
370 if (post_engine_init ()) {
372 throw SessionException (_("Cannot configure audio/midi engine with session parameters"));
375 store_recent_sessions (_name, _path);
377 bool was_dirty = dirty();
379 _state_of_the_state = StateOfTheState (_state_of_the_state & ~Dirty);
381 Config->ParameterChanged.connect_same_thread (*this, boost::bind (&Session::config_changed, this, _1, false));
382 config.ParameterChanged.connect_same_thread (*this, boost::bind (&Session::config_changed, this, _1, true));
385 DirtyChanged (); /* EMIT SIGNAL */
388 StartTimeChanged.connect_same_thread (*this, boost::bind (&Session::start_time_changed, this, _1));
389 EndTimeChanged.connect_same_thread (*this, boost::bind (&Session::end_time_changed, this, _1));
391 emit_thread_start ();
393 /* hook us up to the engine since we are now completely constructed */
395 BootMessage (_("Connect to engine"));
397 _engine.set_session (this);
398 _engine.reset_timebase ();
400 #ifdef USE_TRACKS_CODE_FEATURES
402 EngineStateController::instance()->set_session(this);
405 if ( ARDOUR::Profile->get_trx () ) {
407 /* Waves Tracks: fill session with tracks basing on the amount of inputs.
408 * each available input must have corresponding track when session starts.
411 uint32_t how_many (0);
413 std::vector<std::string> inputs;
414 EngineStateController::instance()->get_physical_audio_inputs(inputs);
416 how_many = inputs.size();
418 list<boost::shared_ptr<AudioTrack> > tracks;
420 // Track names after driver
421 if (Config->get_tracks_auto_naming() == NameAfterDriver) {
422 string track_name = "";
423 for (std::vector<string>::size_type i = 0; i < inputs.size(); ++i) {
425 track_name = inputs[i];
426 replace_all (track_name, "system:capture", "");
428 list<boost::shared_ptr<AudioTrack> > single_track = new_audio_track (1, 1, Normal, 0, 1, track_name);
429 tracks.insert(tracks.begin(), single_track.front());
431 } else { // Default track names
432 tracks = new_audio_track (1, 1, Normal, 0, how_many, string());
435 if (tracks.size() != how_many) {
437 throw failed_constructor ();
446 BootMessage (_("Session loading complete"));
458 Session::ensure_engine (uint32_t desired_sample_rate)
460 if (_engine.current_backend() == 0) {
461 /* backend is unknown ... */
462 boost::optional<int> r = AudioEngineSetupRequired (desired_sample_rate);
463 if (r.get_value_or (-1) != 0) {
466 } else if (_engine.setup_required()) {
467 /* backend is known, but setup is needed */
468 boost::optional<int> r = AudioEngineSetupRequired (desired_sample_rate);
469 if (r.get_value_or (-1) != 0) {
472 } else if (!_engine.running()) {
473 if (_engine.start()) {
478 /* at this point the engine should be running
481 if (!_engine.running()) {
485 return immediately_post_engine ();
490 Session::immediately_post_engine ()
492 /* Do various initializations that should take place directly after we
493 * know that the engine is running, but before we either create a
494 * session or set state for an existing one.
497 if (how_many_dsp_threads () > 1) {
498 /* For now, only create the graph if we are using >1 DSP threads, as
499 it is a bit slower than the old code with 1 thread.
501 _process_graph.reset (new Graph (*this));
504 /* every time we reconnect, recompute worst case output latencies */
506 _engine.Running.connect_same_thread (*this, boost::bind (&Session::initialize_latencies, this));
508 if (synced_to_engine()) {
509 _engine.transport_stop ();
512 if (config.get_jack_time_master()) {
513 _engine.transport_locate (_transport_frame);
517 BootMessage (_("Set up LTC"));
519 BootMessage (_("Set up Click"));
521 BootMessage (_("Set up standard connections"));
525 catch (failed_constructor& err) {
529 /* TODO, connect in different thread. (PortRegisteredOrUnregistered may be in RT context)
531 _engine.PortRegisteredOrUnregistered.connect_same_thread (*this, boost::bind (&Session::setup_bundles, this));
539 vector<void*> debug_pointers;
541 /* if we got to here, leaving pending capture state around
545 remove_pending_capture_state ();
547 _state_of_the_state = StateOfTheState (CannotSave|Deletion);
549 /* disconnect from any and all signals that we are connected to */
553 /* shutdown control surface protocols while we still have ports
554 and the engine to move data to any devices.
557 ControlProtocolManager::instance().drop_protocols ();
559 _engine.remove_session ();
561 #ifdef USE_TRACKS_CODE_FEATURES
562 EngineStateController::instance()->remove_session();
565 /* deregister all ports - there will be no process or any other
566 * callbacks from the engine any more.
569 Port::PortDrop (); /* EMIT SIGNAL */
573 /* clear history so that no references to objects are held any more */
577 /* clear state tree so that no references to objects are held any more */
582 /* reset dynamic state version back to default */
584 Stateful::loading_state_version = 0;
586 _butler->drop_references ();
590 delete _all_route_group;
592 DEBUG_TRACE (DEBUG::Destruction, "delete route groups\n");
593 for (list<RouteGroup *>::iterator i = _route_groups.begin(); i != _route_groups.end(); ++i) {
597 if (click_data != default_click) {
598 delete [] click_data;
601 if (click_emphasis_data != default_click_emphasis) {
602 delete [] click_emphasis_data;
607 /* need to remove auditioner before monitoring section
608 * otherwise it is re-connected */
611 /* drop references to routes held by the monitoring section
612 * specifically _monitor_out aux/listen references */
613 remove_monitor_section();
615 /* clear out any pending dead wood from RCU managed objects */
620 AudioDiskstream::free_working_buffers();
622 /* tell everyone who is still standing that we're about to die */
625 /* tell everyone to drop references and delete objects as we go */
627 DEBUG_TRACE (DEBUG::Destruction, "delete regions\n");
628 RegionFactory::delete_all_regions ();
630 DEBUG_TRACE (DEBUG::Destruction, "delete routes\n");
632 /* reset these three references to special routes before we do the usual route delete thing */
634 _master_out.reset ();
635 _monitor_out.reset ();
638 RCUWriter<RouteList> writer (routes);
639 boost::shared_ptr<RouteList> r = writer.get_copy ();
641 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
642 DEBUG_TRACE(DEBUG::Destruction, string_compose ("Dropping for route %1 ; pre-ref = %2\n", (*i)->name(), (*i).use_count()));
643 (*i)->drop_references ();
647 /* writer goes out of scope and updates master */
652 DEBUG_TRACE (DEBUG::Destruction, "delete sources\n");
653 Glib::Threads::Mutex::Lock lm (source_lock);
654 for (SourceMap::iterator i = sources.begin(); i != sources.end(); ++i) {
655 DEBUG_TRACE(DEBUG::Destruction, string_compose ("Dropping for source %1 ; pre-ref = %2\n", i->second->name(), i->second.use_count()));
656 i->second->drop_references ();
662 /* not strictly necessary, but doing it here allows the shared_ptr debugging to work */
665 emit_thread_terminate ();
667 pthread_cond_destroy (&_rt_emit_cond);
668 pthread_mutex_destroy (&_rt_emit_mutex);
670 delete _scene_changer; _scene_changer = 0;
671 delete midi_control_ui; midi_control_ui = 0;
673 delete _mmc; _mmc = 0;
674 delete _midi_ports; _midi_ports = 0;
675 delete _locations; _locations = 0;
679 DEBUG_TRACE (DEBUG::Destruction, "Session::destroy() done\n");
681 #ifdef BOOST_SP_ENABLE_DEBUG_HOOKS
682 boost_debug_list_ptrs ();
687 Session::setup_ltc ()
691 _ltc_input.reset (new IO (*this, X_("LTC In"), IO::Input));
692 _ltc_output.reset (new IO (*this, X_("LTC Out"), IO::Output));
694 if (state_tree && (child = find_named_node (*state_tree->root(), X_("LTC In"))) != 0) {
695 _ltc_input->set_state (*(child->children().front()), Stateful::loading_state_version);
698 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
699 _ltc_input->ensure_io (ChanCount (DataType::AUDIO, 1), true, this);
701 reconnect_ltc_input ();
704 if (state_tree && (child = find_named_node (*state_tree->root(), X_("LTC Out"))) != 0) {
705 _ltc_output->set_state (*(child->children().front()), Stateful::loading_state_version);
708 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
709 _ltc_output->ensure_io (ChanCount (DataType::AUDIO, 1), true, this);
711 reconnect_ltc_output ();
714 /* fix up names of LTC ports because we don't want the normal
715 * IO style of NAME/TYPE-{in,out}N
718 _ltc_input->nth (0)->set_name (X_("LTC-in"));
719 _ltc_output->nth (0)->set_name (X_("LTC-out"));
723 Session::setup_click ()
726 _click_io.reset (new ClickIO (*this, X_("Click")));
727 _click_gain.reset (new Amp (*this));
728 _click_gain->activate ();
730 setup_click_state (state_tree->root());
732 setup_click_state (0);
737 Session::setup_click_state (const XMLNode* node)
739 const XMLNode* child = 0;
741 if (node && (child = find_named_node (*node, "Click")) != 0) {
743 /* existing state for Click */
746 if (Stateful::loading_state_version < 3000) {
747 c = _click_io->set_state_2X (*child->children().front(), Stateful::loading_state_version, false);
749 const XMLNodeList& children (child->children());
750 XMLNodeList::const_iterator i = children.begin();
751 if ((c = _click_io->set_state (**i, Stateful::loading_state_version)) == 0) {
753 if (i != children.end()) {
754 c = _click_gain->set_state (**i, Stateful::loading_state_version);
760 _clicking = Config->get_clicking ();
764 error << _("could not setup Click I/O") << endmsg;
771 /* default state for Click: dual-mono to first 2 physical outputs */
774 _engine.get_physical_outputs (DataType::AUDIO, outs);
776 for (uint32_t physport = 0; physport < 2; ++physport) {
777 if (outs.size() > physport) {
778 if (_click_io->add_port (outs[physport], this)) {
779 // relax, even though its an error
784 if (_click_io->n_ports () > ChanCount::ZERO) {
785 _clicking = Config->get_clicking ();
791 Session::setup_bundles ()
795 RCUWriter<BundleList> writer (_bundles);
796 boost::shared_ptr<BundleList> b = writer.get_copy ();
797 for (BundleList::iterator i = b->begin(); i != b->end();) {
798 if (boost::dynamic_pointer_cast<UserBundle>(*i)) {
806 vector<string> inputs[DataType::num_types];
807 vector<string> outputs[DataType::num_types];
808 for (uint32_t i = 0; i < DataType::num_types; ++i) {
809 _engine.get_physical_inputs (DataType (DataType::Symbol (i)), inputs[i]);
810 _engine.get_physical_outputs (DataType (DataType::Symbol (i)), outputs[i]);
813 /* Create a set of Bundle objects that map
814 to the physical I/O currently available. We create both
815 mono and stereo bundles, so that the common cases of mono
816 and stereo tracks get bundles to put in their mixer strip
817 in / out menus. There may be a nicer way of achieving that;
818 it doesn't really scale that well to higher channel counts
821 /* mono output bundles */
823 for (uint32_t np = 0; np < outputs[DataType::AUDIO].size(); ++np) {
825 std::string pn = _engine.get_pretty_name_by_name (outputs[DataType::AUDIO][np]);
827 snprintf (buf, sizeof (buf), _("out %s"), pn.c_str());
829 snprintf (buf, sizeof (buf), _("out %" PRIu32), np+1);
832 boost::shared_ptr<Bundle> c (new Bundle (buf, true));
833 c->add_channel (_("mono"), DataType::AUDIO);
834 c->set_port (0, outputs[DataType::AUDIO][np]);
836 add_bundle (c, false);
839 /* stereo output bundles */
841 for (uint32_t np = 0; np < outputs[DataType::AUDIO].size(); np += 2) {
842 if (np + 1 < outputs[DataType::AUDIO].size()) {
844 snprintf (buf, sizeof(buf), _("out %" PRIu32 "+%" PRIu32), np + 1, np + 2);
845 boost::shared_ptr<Bundle> c (new Bundle (buf, true));
846 c->add_channel (_("L"), DataType::AUDIO);
847 c->set_port (0, outputs[DataType::AUDIO][np]);
848 c->add_channel (_("R"), DataType::AUDIO);
849 c->set_port (1, outputs[DataType::AUDIO][np + 1]);
851 add_bundle (c, false);
855 /* mono input bundles */
857 for (uint32_t np = 0; np < inputs[DataType::AUDIO].size(); ++np) {
859 std::string pn = _engine.get_pretty_name_by_name (inputs[DataType::AUDIO][np]);
861 snprintf (buf, sizeof (buf), _("in %s"), pn.c_str());
863 snprintf (buf, sizeof (buf), _("in %" PRIu32), np+1);
866 boost::shared_ptr<Bundle> c (new Bundle (buf, false));
867 c->add_channel (_("mono"), DataType::AUDIO);
868 c->set_port (0, inputs[DataType::AUDIO][np]);
870 add_bundle (c, false);
873 /* stereo input bundles */
875 for (uint32_t np = 0; np < inputs[DataType::AUDIO].size(); np += 2) {
876 if (np + 1 < inputs[DataType::AUDIO].size()) {
878 snprintf (buf, sizeof(buf), _("in %" PRIu32 "+%" PRIu32), np + 1, np + 2);
880 boost::shared_ptr<Bundle> c (new Bundle (buf, false));
881 c->add_channel (_("L"), DataType::AUDIO);
882 c->set_port (0, inputs[DataType::AUDIO][np]);
883 c->add_channel (_("R"), DataType::AUDIO);
884 c->set_port (1, inputs[DataType::AUDIO][np + 1]);
886 add_bundle (c, false);
890 /* MIDI input bundles */
892 for (uint32_t np = 0; np < inputs[DataType::MIDI].size(); ++np) {
893 string n = inputs[DataType::MIDI][np];
894 std::string pn = _engine.get_pretty_name_by_name (n);
898 boost::erase_first (n, X_("alsa_pcm:"));
900 boost::shared_ptr<Bundle> c (new Bundle (n, false));
901 c->add_channel ("", DataType::MIDI);
902 c->set_port (0, inputs[DataType::MIDI][np]);
903 add_bundle (c, false);
906 /* MIDI output bundles */
908 for (uint32_t np = 0; np < outputs[DataType::MIDI].size(); ++np) {
909 string n = outputs[DataType::MIDI][np];
910 std::string pn = _engine.get_pretty_name_by_name (n);
914 boost::erase_first (n, X_("alsa_pcm:"));
916 boost::shared_ptr<Bundle> c (new Bundle (n, true));
917 c->add_channel ("", DataType::MIDI);
918 c->set_port (0, outputs[DataType::MIDI][np]);
919 add_bundle (c, false);
922 // we trust the backend to only calls us if there's a change
923 BundleAddedOrRemoved (); /* EMIT SIGNAL */
927 Session::auto_connect_master_bus ()
929 if (!_master_out || !Config->get_auto_connect_standard_busses() || _monitor_out) {
933 // Waves Tracks: Do not connect master bas for Tracks if AutoConnectMaster option is not set
934 // In this case it means "Multi Out" output mode
935 if (ARDOUR::Profile->get_trx() && !(Config->get_output_auto_connect() & AutoConnectMaster) ) {
939 /* if requested auto-connect the outputs to the first N physical ports.
942 uint32_t limit = _master_out->n_outputs().n_total();
943 vector<string> outputs[DataType::num_types];
945 for (uint32_t i = 0; i < DataType::num_types; ++i) {
946 _engine.get_physical_outputs (DataType (DataType::Symbol (i)), outputs[i]);
949 for (uint32_t n = 0; n < limit; ++n) {
950 boost::shared_ptr<Port> p = _master_out->output()->nth (n);
952 if (outputs[p->type()].size() > n) {
953 connect_to = outputs[p->type()][n];
956 if (!connect_to.empty() && p->connected_to (connect_to) == false) {
957 if (_master_out->output()->connect (p, connect_to, this)) {
958 error << string_compose (_("cannot connect master output %1 to %2"), n, connect_to)
967 Session::remove_monitor_section ()
969 if (!_monitor_out || Profile->get_trx()) {
973 /* force reversion to Solo-In-Place */
974 Config->set_solo_control_is_listen_control (false);
976 /* if we are auditioning, cancel it ... this is a workaround
977 to a problem (auditioning does not execute the process graph,
978 which is needed to remove routes when using >1 core for processing)
983 /* Hold process lock while doing this so that we don't hear bits and
984 * pieces of audio as we work on each route.
987 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
989 /* Connect tracks to monitor section. Note that in an
990 existing session, the internal sends will already exist, but we want the
991 routes to notice that they connect to the control out specifically.
995 boost::shared_ptr<RouteList> r = routes.reader ();
996 PBD::Unwinder<bool> uw (ignore_route_processor_changes, true);
998 for (RouteList::iterator x = r->begin(); x != r->end(); ++x) {
1000 if ((*x)->is_monitor()) {
1002 } else if ((*x)->is_master()) {
1005 (*x)->remove_aux_or_listen (_monitor_out);
1010 remove_route (_monitor_out);
1011 auto_connect_master_bus ();
1014 auditioner->connect ();
1019 Session::add_monitor_section ()
1023 if (_monitor_out || !_master_out || Profile->get_trx()) {
1027 boost::shared_ptr<Route> r (new Route (*this, _("Monitor"), Route::MonitorOut, DataType::AUDIO));
1033 #ifdef BOOST_SP_ENABLE_DEBUG_HOOKS
1034 // boost_debug_shared_ptr_mark_interesting (r.get(), "Route");
1037 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
1038 r->input()->ensure_io (_master_out->output()->n_ports(), false, this);
1039 r->output()->ensure_io (_master_out->output()->n_ports(), false, this);
1041 error << _("Cannot create monitor section. 'Monitor' Port name is not unique.") << endmsg;
1046 add_routes (rl, false, false, false);
1048 assert (_monitor_out);
1050 /* AUDIO ONLY as of june 29th 2009, because listen semantics for anything else
1051 are undefined, at best.
1054 uint32_t limit = _monitor_out->n_inputs().n_audio();
1058 /* connect the inputs to the master bus outputs. this
1059 * represents a separate data feed from the internal sends from
1060 * each route. as of jan 2011, it allows the monitor section to
1061 * conditionally ignore either the internal sends or the normal
1062 * input feed, but we should really find a better way to do
1066 _master_out->output()->disconnect (this);
1068 for (uint32_t n = 0; n < limit; ++n) {
1069 boost::shared_ptr<AudioPort> p = _monitor_out->input()->ports().nth_audio_port (n);
1070 boost::shared_ptr<AudioPort> o = _master_out->output()->ports().nth_audio_port (n);
1073 string connect_to = o->name();
1074 if (_monitor_out->input()->connect (p, connect_to, this)) {
1075 error << string_compose (_("cannot connect control input %1 to %2"), n, connect_to)
1083 /* if monitor section is not connected, connect it to physical outs
1086 if (Config->get_auto_connect_standard_busses() && !_monitor_out->output()->connected ()) {
1088 if (!Config->get_monitor_bus_preferred_bundle().empty()) {
1090 boost::shared_ptr<Bundle> b = bundle_by_name (Config->get_monitor_bus_preferred_bundle());
1093 _monitor_out->output()->connect_ports_to_bundle (b, true, this);
1095 warning << string_compose (_("The preferred I/O for the monitor bus (%1) cannot be found"),
1096 Config->get_monitor_bus_preferred_bundle())
1102 /* Monitor bus is audio only */
1104 vector<string> outputs[DataType::num_types];
1106 for (uint32_t i = 0; i < DataType::num_types; ++i) {
1107 _engine.get_physical_outputs (DataType (DataType::Symbol (i)), outputs[i]);
1110 uint32_t mod = outputs[DataType::AUDIO].size();
1111 uint32_t limit = _monitor_out->n_outputs().get (DataType::AUDIO);
1115 for (uint32_t n = 0; n < limit; ++n) {
1117 boost::shared_ptr<Port> p = _monitor_out->output()->ports().port(DataType::AUDIO, n);
1119 if (outputs[DataType::AUDIO].size() > (n % mod)) {
1120 connect_to = outputs[DataType::AUDIO][n % mod];
1123 if (!connect_to.empty()) {
1124 if (_monitor_out->output()->connect (p, connect_to, this)) {
1125 error << string_compose (
1126 _("cannot connect control output %1 to %2"),
1137 /* Hold process lock while doing this so that we don't hear bits and
1138 * pieces of audio as we work on each route.
1141 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
1143 /* Connect tracks to monitor section. Note that in an
1144 existing session, the internal sends will already exist, but we want the
1145 routes to notice that they connect to the control out specifically.
1149 boost::shared_ptr<RouteList> rls = routes.reader ();
1151 PBD::Unwinder<bool> uw (ignore_route_processor_changes, true);
1153 for (RouteList::iterator x = rls->begin(); x != rls->end(); ++x) {
1155 if ((*x)->is_monitor()) {
1157 } else if ((*x)->is_master()) {
1160 (*x)->enable_monitor_send ();
1165 auditioner->connect ();
1170 Session::reset_monitor_section ()
1172 /* Process lock should be held by the caller.*/
1174 if (!_monitor_out || Profile->get_trx()) {
1178 uint32_t limit = _master_out->n_outputs().n_audio();
1180 /* connect the inputs to the master bus outputs. this
1181 * represents a separate data feed from the internal sends from
1182 * each route. as of jan 2011, it allows the monitor section to
1183 * conditionally ignore either the internal sends or the normal
1184 * input feed, but we should really find a better way to do
1188 _master_out->output()->disconnect (this);
1189 _monitor_out->output()->disconnect (this);
1191 _monitor_out->input()->ensure_io (_master_out->output()->n_ports(), false, this);
1192 _monitor_out->output()->ensure_io (_master_out->output()->n_ports(), false, this);
1194 for (uint32_t n = 0; n < limit; ++n) {
1195 boost::shared_ptr<AudioPort> p = _monitor_out->input()->ports().nth_audio_port (n);
1196 boost::shared_ptr<AudioPort> o = _master_out->output()->ports().nth_audio_port (n);
1199 string connect_to = o->name();
1200 if (_monitor_out->input()->connect (p, connect_to, this)) {
1201 error << string_compose (_("cannot connect control input %1 to %2"), n, connect_to)
1208 /* connect monitor section to physical outs
1211 if (Config->get_auto_connect_standard_busses()) {
1213 if (!Config->get_monitor_bus_preferred_bundle().empty()) {
1215 boost::shared_ptr<Bundle> b = bundle_by_name (Config->get_monitor_bus_preferred_bundle());
1218 _monitor_out->output()->connect_ports_to_bundle (b, true, this);
1220 warning << string_compose (_("The preferred I/O for the monitor bus (%1) cannot be found"),
1221 Config->get_monitor_bus_preferred_bundle())
1227 /* Monitor bus is audio only */
1229 vector<string> outputs[DataType::num_types];
1231 for (uint32_t i = 0; i < DataType::num_types; ++i) {
1232 _engine.get_physical_outputs (DataType (DataType::Symbol (i)), outputs[i]);
1235 uint32_t mod = outputs[DataType::AUDIO].size();
1236 uint32_t limit = _monitor_out->n_outputs().get (DataType::AUDIO);
1240 for (uint32_t n = 0; n < limit; ++n) {
1242 boost::shared_ptr<Port> p = _monitor_out->output()->ports().port(DataType::AUDIO, n);
1244 if (outputs[DataType::AUDIO].size() > (n % mod)) {
1245 connect_to = outputs[DataType::AUDIO][n % mod];
1248 if (!connect_to.empty()) {
1249 if (_monitor_out->output()->connect (p, connect_to, this)) {
1250 error << string_compose (
1251 _("cannot connect control output %1 to %2"),
1262 /* Connect tracks to monitor section. Note that in an
1263 existing session, the internal sends will already exist, but we want the
1264 routes to notice that they connect to the control out specifically.
1268 boost::shared_ptr<RouteList> rls = routes.reader ();
1270 PBD::Unwinder<bool> uw (ignore_route_processor_changes, true);
1272 for (RouteList::iterator x = rls->begin(); x != rls->end(); ++x) {
1274 if ((*x)->is_monitor()) {
1276 } else if ((*x)->is_master()) {
1279 (*x)->enable_monitor_send ();
1285 Session::hookup_io ()
1287 /* stop graph reordering notifications from
1288 causing resorts, etc.
1291 _state_of_the_state = StateOfTheState (_state_of_the_state | InitialConnecting);
1295 /* we delay creating the auditioner till now because
1296 it makes its own connections to ports.
1300 boost::shared_ptr<Auditioner> a (new Auditioner (*this));
1302 throw failed_constructor ();
1304 a->use_new_diskstream ();
1308 catch (failed_constructor& err) {
1309 warning << _("cannot create Auditioner: no auditioning of regions possible") << endmsg;
1313 /* load bundles, which we may have postponed earlier on */
1314 if (_bundle_xml_node) {
1315 load_bundles (*_bundle_xml_node);
1316 delete _bundle_xml_node;
1319 /* Tell all IO objects to connect themselves together */
1321 IO::enable_connecting ();
1323 /* Now tell all "floating" ports to connect to whatever
1324 they should be connected to.
1327 AudioEngine::instance()->reconnect_ports ();
1329 /* Anyone who cares about input state, wake up and do something */
1331 IOConnectionsComplete (); /* EMIT SIGNAL */
1333 _state_of_the_state = StateOfTheState (_state_of_the_state & ~InitialConnecting);
1335 /* now handle the whole enchilada as if it was one
1336 graph reorder event.
1341 /* update the full solo state, which can't be
1342 correctly determined on a per-route basis, but
1343 needs the global overview that only the session
1347 update_route_solo_state ();
1351 Session::track_playlist_changed (boost::weak_ptr<Track> wp)
1353 boost::shared_ptr<Track> track = wp.lock ();
1358 boost::shared_ptr<Playlist> playlist;
1360 if ((playlist = track->playlist()) != 0) {
1361 playlist->RegionAdded.connect_same_thread (*this, boost::bind (&Session::playlist_region_added, this, _1));
1362 playlist->RangesMoved.connect_same_thread (*this, boost::bind (&Session::playlist_ranges_moved, this, _1));
1363 playlist->RegionsExtended.connect_same_thread (*this, boost::bind (&Session::playlist_regions_extended, this, _1));
1368 Session::record_enabling_legal () const
1370 /* this used to be in here, but survey says.... we don't need to restrict it */
1371 // if (record_status() == Recording) {
1375 if (Config->get_all_safe()) {
1382 Session::set_track_monitor_input_status (bool yn)
1384 boost::shared_ptr<RouteList> rl = routes.reader ();
1385 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
1386 boost::shared_ptr<AudioTrack> tr = boost::dynamic_pointer_cast<AudioTrack> (*i);
1387 if (tr && tr->record_enabled ()) {
1388 //cerr << "switching to input = " << !auto_input << __FILE__ << __LINE__ << endl << endl;
1389 tr->request_input_monitoring (yn);
1395 Session::auto_punch_start_changed (Location* location)
1397 replace_event (SessionEvent::PunchIn, location->start());
1399 if (get_record_enabled() && config.get_punch_in()) {
1400 /* capture start has been changed, so save new pending state */
1401 save_state ("", true);
1406 Session::auto_punch_end_changed (Location* location)
1408 framepos_t when_to_stop = location->end();
1409 // when_to_stop += _worst_output_latency + _worst_input_latency;
1410 replace_event (SessionEvent::PunchOut, when_to_stop);
1414 Session::auto_punch_changed (Location* location)
1416 framepos_t when_to_stop = location->end();
1418 replace_event (SessionEvent::PunchIn, location->start());
1419 //when_to_stop += _worst_output_latency + _worst_input_latency;
1420 replace_event (SessionEvent::PunchOut, when_to_stop);
1423 /** @param loc A loop location.
1424 * @param pos Filled in with the start time of the required fade-out (in session frames).
1425 * @param length Filled in with the length of the required fade-out.
1428 Session::auto_loop_declick_range (Location* loc, framepos_t & pos, framepos_t & length)
1430 pos = max (loc->start(), loc->end() - 64);
1431 length = loc->end() - pos;
1435 Session::auto_loop_changed (Location* location)
1437 replace_event (SessionEvent::AutoLoop, location->end(), location->start());
1440 auto_loop_declick_range (location, dcp, dcl);
1442 if (transport_rolling() && play_loop) {
1444 replace_event (SessionEvent::AutoLoopDeclick, dcp, dcl);
1446 // if (_transport_frame > location->end()) {
1448 if (_transport_frame < location->start() || _transport_frame > location->end()) {
1449 // relocate to beginning of loop
1450 clear_events (SessionEvent::LocateRoll);
1452 request_locate (location->start(), true);
1455 else if (Config->get_seamless_loop() && !loop_changing) {
1457 // schedule a locate-roll to refill the diskstreams at the
1458 // previous loop end
1459 loop_changing = true;
1461 if (location->end() > last_loopend) {
1462 clear_events (SessionEvent::LocateRoll);
1463 SessionEvent *ev = new SessionEvent (SessionEvent::LocateRoll, SessionEvent::Add, last_loopend, last_loopend, 0, true);
1469 clear_events (SessionEvent::AutoLoopDeclick);
1470 clear_events (SessionEvent::AutoLoop);
1473 /* possibly move playhead if not rolling; if we are rolling we'll move
1474 to the loop start on stop if that is appropriate.
1479 if (!transport_rolling() && select_playhead_priority_target (pos)) {
1480 if (pos == location->start()) {
1481 request_locate (pos);
1486 last_loopend = location->end();
1491 Session::set_auto_punch_location (Location* location)
1495 if ((existing = _locations->auto_punch_location()) != 0 && existing != location) {
1496 punch_connections.drop_connections();
1497 existing->set_auto_punch (false, this);
1498 remove_event (existing->start(), SessionEvent::PunchIn);
1499 clear_events (SessionEvent::PunchOut);
1500 auto_punch_location_changed (0);
1505 if (location == 0) {
1509 if (location->end() <= location->start()) {
1510 error << _("Session: you can't use that location for auto punch (start <= end)") << endmsg;
1514 punch_connections.drop_connections ();
1516 location->StartChanged.connect_same_thread (punch_connections, boost::bind (&Session::auto_punch_start_changed, this, location));
1517 location->EndChanged.connect_same_thread (punch_connections, boost::bind (&Session::auto_punch_end_changed, this, location));
1518 location->Changed.connect_same_thread (punch_connections, boost::bind (&Session::auto_punch_changed, this, location));
1520 location->set_auto_punch (true, this);
1522 auto_punch_changed (location);
1524 auto_punch_location_changed (location);
1528 Session::set_session_extents (framepos_t start, framepos_t end)
1531 if ((existing = _locations->session_range_location()) == 0) {
1532 //if there is no existing session, we need to make a new session location (should never happen)
1533 existing = new Location (*this, 0, 0, _("session"), Location::IsSessionRange);
1537 error << _("Session: you can't use that location for session start/end)") << endmsg;
1541 existing->set( start, end );
1547 Session::set_auto_loop_location (Location* location)
1551 if ((existing = _locations->auto_loop_location()) != 0 && existing != location) {
1552 loop_connections.drop_connections ();
1553 existing->set_auto_loop (false, this);
1554 remove_event (existing->end(), SessionEvent::AutoLoop);
1557 auto_loop_declick_range (existing, dcp, dcl);
1558 remove_event (dcp, SessionEvent::AutoLoopDeclick);
1559 auto_loop_location_changed (0);
1564 if (location == 0) {
1568 if (location->end() <= location->start()) {
1569 error << _("You cannot use this location for auto-loop because it has zero or negative length") << endmsg;
1573 last_loopend = location->end();
1575 loop_connections.drop_connections ();
1577 location->StartChanged.connect_same_thread (loop_connections, boost::bind (&Session::auto_loop_changed, this, location));
1578 location->EndChanged.connect_same_thread (loop_connections, boost::bind (&Session::auto_loop_changed, this, location));
1579 location->Changed.connect_same_thread (loop_connections, boost::bind (&Session::auto_loop_changed, this, location));
1580 location->FlagsChanged.connect_same_thread (loop_connections, boost::bind (&Session::auto_loop_changed, this, location));
1582 location->set_auto_loop (true, this);
1584 if (Config->get_loop_is_mode() && play_loop && Config->get_seamless_loop()) {
1585 // set all tracks to use internal looping
1586 boost::shared_ptr<RouteList> rl = routes.reader ();
1587 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
1588 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
1589 if (tr && !tr->hidden()) {
1590 tr->set_loop (location);
1595 /* take care of our stuff first */
1597 auto_loop_changed (location);
1599 /* now tell everyone else */
1601 auto_loop_location_changed (location);
1605 Session::update_marks (Location*)
1611 Session::update_skips (Location* loc, bool consolidate)
1613 if (_ignore_skips_updates) {
1617 Locations::LocationList skips;
1620 PBD::Unwinder<bool> uw (_ignore_skips_updates, true);
1621 consolidate_skips (loc);
1624 sync_locations_to_skips ();
1630 Session::consolidate_skips (Location* loc)
1632 Locations::LocationList all_locations = _locations->list ();
1634 for (Locations::LocationList::iterator l = all_locations.begin(); l != all_locations.end(); ) {
1636 if (!(*l)->is_skip ()) {
1641 /* don't test against self */
1648 switch (Evoral::coverage ((*l)->start(), (*l)->end(), loc->start(), loc->end())) {
1649 case Evoral::OverlapInternal:
1650 case Evoral::OverlapExternal:
1651 case Evoral::OverlapStart:
1652 case Evoral::OverlapEnd:
1653 /* adjust new location to cover existing one */
1654 loc->set_start (min (loc->start(), (*l)->start()));
1655 loc->set_end (max (loc->end(), (*l)->end()));
1656 /* we don't need this one any more */
1657 _locations->remove (*l);
1658 /* the location has been deleted, so remove reference to it in our local list */
1659 l = all_locations.erase (l);
1662 case Evoral::OverlapNone:
1670 Session::sync_locations_to_skips ()
1672 /* This happens asynchronously (in the audioengine thread). After the clear is done, we will call
1673 * Session::_sync_locations_to_skips() from the audioengine thread.
1675 clear_events (SessionEvent::Skip, boost::bind (&Session::_sync_locations_to_skips, this));
1679 Session::_sync_locations_to_skips ()
1681 /* called as a callback after existing Skip events have been cleared from a realtime audioengine thread */
1683 Locations::LocationList const & locs (_locations->list());
1685 for (Locations::LocationList::const_iterator i = locs.begin(); i != locs.end(); ++i) {
1687 Location* location = *i;
1689 if (location->is_skip() && location->is_skipping()) {
1690 SessionEvent* ev = new SessionEvent (SessionEvent::Skip, SessionEvent::Add, location->start(), location->end(), 1.0);
1698 Session::location_added (Location *location)
1700 if (location->is_auto_punch()) {
1701 set_auto_punch_location (location);
1704 if (location->is_auto_loop()) {
1705 set_auto_loop_location (location);
1708 if (location->is_session_range()) {
1709 /* no need for any signal handling or event setting with the session range,
1710 because we keep a direct reference to it and use its start/end directly.
1712 _session_range_location = location;
1715 if (location->is_mark()) {
1716 /* listen for per-location signals that require us to do any * global updates for marks */
1718 location->StartChanged.connect_same_thread (skip_update_connections, boost::bind (&Session::update_marks, this, location));
1719 location->EndChanged.connect_same_thread (skip_update_connections, boost::bind (&Session::update_marks, this, location));
1720 location->Changed.connect_same_thread (skip_update_connections, boost::bind (&Session::update_marks, this, location));
1721 location->FlagsChanged.connect_same_thread (skip_update_connections, boost::bind (&Session::update_marks, this, location));
1724 if (location->is_skip()) {
1725 /* listen for per-location signals that require us to update skip-locate events */
1727 location->StartChanged.connect_same_thread (skip_update_connections, boost::bind (&Session::update_skips, this, location, true));
1728 location->EndChanged.connect_same_thread (skip_update_connections, boost::bind (&Session::update_skips, this, location, true));
1729 location->Changed.connect_same_thread (skip_update_connections, boost::bind (&Session::update_skips, this, location, true));
1730 location->FlagsChanged.connect_same_thread (skip_update_connections, boost::bind (&Session::update_skips, this, location, false));
1732 update_skips (location, true);
1739 Session::location_removed (Location *location)
1741 if (location->is_auto_loop()) {
1742 set_auto_loop_location (0);
1743 set_track_loop (false);
1746 if (location->is_auto_punch()) {
1747 set_auto_punch_location (0);
1750 if (location->is_session_range()) {
1751 /* this is never supposed to happen */
1752 error << _("programming error: session range removed!") << endl;
1755 if (location->is_skip()) {
1757 update_skips (location, false);
1764 Session::locations_changed ()
1766 _locations->apply (*this, &Session::_locations_changed);
1770 Session::_locations_changed (const Locations::LocationList& locations)
1772 /* There was some mass-change in the Locations object.
1774 We might be re-adding a location here but it doesn't actually matter
1775 for all the locations that the Session takes an interest in.
1779 PBD::Unwinder<bool> protect_ignore_skip_updates (_ignore_skips_updates, true);
1780 for (Locations::LocationList::const_iterator i = locations.begin(); i != locations.end(); ++i) {
1781 location_added (*i);
1785 update_skips (NULL, false);
1789 Session::enable_record ()
1791 if (_transport_speed != 0.0 && _transport_speed != 1.0) {
1792 /* no recording at anything except normal speed */
1797 RecordState rs = (RecordState) g_atomic_int_get (&_record_status);
1799 if (rs == Recording) {
1803 if (g_atomic_int_compare_and_exchange (&_record_status, rs, Recording)) {
1805 _last_record_location = _transport_frame;
1806 send_immediate_mmc (MIDI::MachineControlCommand (MIDI::MachineControl::cmdRecordStrobe));
1808 if (Config->get_monitoring_model() == HardwareMonitoring && config.get_auto_input()) {
1809 set_track_monitor_input_status (true);
1812 RecordStateChanged ();
1819 Session::disable_record (bool rt_context, bool force)
1823 if ((rs = (RecordState) g_atomic_int_get (&_record_status)) != Disabled) {
1825 if (!Config->get_latched_record_enable () || force) {
1826 g_atomic_int_set (&_record_status, Disabled);
1827 send_immediate_mmc (MIDI::MachineControlCommand (MIDI::MachineControl::cmdRecordExit));
1829 if (rs == Recording) {
1830 g_atomic_int_set (&_record_status, Enabled);
1834 if (Config->get_monitoring_model() == HardwareMonitoring && config.get_auto_input()) {
1835 set_track_monitor_input_status (false);
1838 RecordStateChanged (); /* emit signal */
1841 remove_pending_capture_state ();
1847 Session::step_back_from_record ()
1849 if (g_atomic_int_compare_and_exchange (&_record_status, Recording, Enabled)) {
1851 if (Config->get_monitoring_model() == HardwareMonitoring && config.get_auto_input()) {
1852 set_track_monitor_input_status (false);
1855 RecordStateChanged (); /* emit signal */
1860 Session::maybe_enable_record ()
1862 if (_step_editors > 0) {
1866 g_atomic_int_set (&_record_status, Enabled);
1868 /* This function is currently called from somewhere other than an RT thread.
1869 This save_state() call therefore doesn't impact anything. Doing it here
1870 means that we save pending state of which sources the next record will use,
1871 which gives us some chance of recovering from a crash during the record.
1874 save_state ("", true);
1876 if (_transport_speed) {
1877 if (!config.get_punch_in()) {
1881 send_immediate_mmc (MIDI::MachineControlCommand (MIDI::MachineControl::cmdRecordPause));
1882 RecordStateChanged (); /* EMIT SIGNAL */
1889 Session::audible_frame () const
1895 offset = worst_playback_latency ();
1897 if (synced_to_engine()) {
1898 /* Note: this is basically just sync-to-JACK */
1899 tf = _engine.transport_frame();
1901 tf = _transport_frame;
1906 if (!non_realtime_work_pending()) {
1910 /* Check to see if we have passed the first guaranteed
1911 audible frame past our last start position. if not,
1912 return that last start point because in terms
1913 of audible frames, we have not moved yet.
1915 `Start position' in this context means the time we last
1916 either started, located, or changed transport direction.
1919 if (_transport_speed > 0.0f) {
1921 if (!play_loop || !have_looped) {
1922 if (tf < _last_roll_or_reversal_location + offset) {
1923 return _last_roll_or_reversal_location;
1931 } else if (_transport_speed < 0.0f) {
1933 /* XXX wot? no backward looping? */
1935 if (tf > _last_roll_or_reversal_location - offset) {
1936 return _last_roll_or_reversal_location;
1948 Session::set_frame_rate (framecnt_t frames_per_second)
1950 /** \fn void Session::set_frame_size(framecnt_t)
1951 the AudioEngine object that calls this guarantees
1952 that it will not be called while we are also in
1953 ::process(). Its fine to do things that block
1957 _base_frame_rate = frames_per_second;
1958 _nominal_frame_rate = frames_per_second;
1963 reset_write_sources (false);
1965 // XXX we need some equivalent to this, somehow
1966 // SndFileSource::setup_standard_crossfades (frames_per_second);
1970 /* XXX need to reset/reinstantiate all LADSPA plugins */
1974 Session::set_block_size (pframes_t nframes)
1976 /* the AudioEngine guarantees
1977 that it will not be called while we are also in
1978 ::process(). It is therefore fine to do things that block
1983 current_block_size = nframes;
1987 boost::shared_ptr<RouteList> r = routes.reader ();
1989 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
1990 (*i)->set_block_size (nframes);
1993 boost::shared_ptr<RouteList> rl = routes.reader ();
1994 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
1995 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
1997 tr->set_block_size (nframes);
2001 set_worst_io_latencies ();
2007 trace_terminal (boost::shared_ptr<Route> r1, boost::shared_ptr<Route> rbase)
2009 boost::shared_ptr<Route> r2;
2011 if (r1->feeds (rbase) && rbase->feeds (r1)) {
2012 info << string_compose(_("feedback loop setup between %1 and %2"), r1->name(), rbase->name()) << endmsg;
2016 /* make a copy of the existing list of routes that feed r1 */
2018 Route::FedBy existing (r1->fed_by());
2020 /* for each route that feeds r1, recurse, marking it as feeding
2024 for (Route::FedBy::iterator i = existing.begin(); i != existing.end(); ++i) {
2025 if (!(r2 = i->r.lock ())) {
2026 /* (*i) went away, ignore it */
2030 /* r2 is a route that feeds r1 which somehow feeds base. mark
2031 base as being fed by r2
2034 rbase->add_fed_by (r2, i->sends_only);
2038 /* 2nd level feedback loop detection. if r1 feeds or is fed by r2,
2042 if (r1->feeds (r2) && r2->feeds (r1)) {
2046 /* now recurse, so that we can mark base as being fed by
2047 all routes that feed r2
2050 trace_terminal (r2, rbase);
2057 Session::resort_routes ()
2059 /* don't do anything here with signals emitted
2060 by Routes during initial setup or while we
2061 are being destroyed.
2064 if (_state_of_the_state & (InitialConnecting | Deletion)) {
2069 RCUWriter<RouteList> writer (routes);
2070 boost::shared_ptr<RouteList> r = writer.get_copy ();
2071 resort_routes_using (r);
2072 /* writer goes out of scope and forces update */
2076 boost::shared_ptr<RouteList> rl = routes.reader ();
2077 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
2078 DEBUG_TRACE (DEBUG::Graph, string_compose ("%1 fed by ...\n", (*i)->name()));
2080 const Route::FedBy& fb ((*i)->fed_by());
2082 for (Route::FedBy::const_iterator f = fb.begin(); f != fb.end(); ++f) {
2083 boost::shared_ptr<Route> sf = f->r.lock();
2085 DEBUG_TRACE (DEBUG::Graph, string_compose ("\t%1 (sends only ? %2)\n", sf->name(), f->sends_only));
2093 /** This is called whenever we need to rebuild the graph of how we will process
2095 * @param r List of routes, in any order.
2099 Session::resort_routes_using (boost::shared_ptr<RouteList> r)
2101 /* We are going to build a directed graph of our routes;
2102 this is where the edges of that graph are put.
2107 /* Go through all routes doing two things:
2109 * 1. Collect the edges of the route graph. Each of these edges
2110 * is a pair of routes, one of which directly feeds the other
2111 * either by a JACK connection or by an internal send.
2113 * 2. Begin the process of making routes aware of which other
2114 * routes directly or indirectly feed them. This information
2115 * is used by the solo code.
2118 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
2120 /* Clear out the route's list of direct or indirect feeds */
2121 (*i)->clear_fed_by ();
2123 for (RouteList::iterator j = r->begin(); j != r->end(); ++j) {
2125 bool via_sends_only;
2127 /* See if this *j feeds *i according to the current state of the JACK
2128 connections and internal sends.
2130 if ((*j)->direct_feeds_according_to_reality (*i, &via_sends_only)) {
2131 /* add the edge to the graph (part #1) */
2132 edges.add (*j, *i, via_sends_only);
2133 /* tell the route (for part #2) */
2134 (*i)->add_fed_by (*j, via_sends_only);
2139 /* Attempt a topological sort of the route graph */
2140 boost::shared_ptr<RouteList> sorted_routes = topological_sort (r, edges);
2142 if (sorted_routes) {
2143 /* We got a satisfactory topological sort, so there is no feedback;
2146 Note: the process graph rechain does not require a
2147 topologically-sorted list, but hey ho.
2149 if (_process_graph) {
2150 _process_graph->rechain (sorted_routes, edges);
2153 _current_route_graph = edges;
2155 /* Complete the building of the routes' lists of what directly
2156 or indirectly feeds them.
2158 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
2159 trace_terminal (*i, *i);
2162 *r = *sorted_routes;
2165 DEBUG_TRACE (DEBUG::Graph, "Routes resorted, order follows:\n");
2166 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
2167 DEBUG_TRACE (DEBUG::Graph, string_compose ("\t%1 signal order %2\n",
2168 (*i)->name(), (*i)->order_key ()));
2172 SuccessfulGraphSort (); /* EMIT SIGNAL */
2175 /* The topological sort failed, so we have a problem. Tell everyone
2176 and stick to the old graph; this will continue to be processed, so
2177 until the feedback is fixed, what is played back will not quite
2178 reflect what is actually connected. Note also that we do not
2179 do trace_terminal here, as it would fail due to an endless recursion,
2180 so the solo code will think that everything is still connected
2184 FeedbackDetected (); /* EMIT SIGNAL */
2189 /** Find a route name starting with \a base, maybe followed by the
2190 * lowest \a id. \a id will always be added if \a definitely_add_number
2191 * is true on entry; otherwise it will only be added if required
2192 * to make the name unique.
2194 * Names are constructed like e.g. "Audio 3" for base="Audio" and id=3.
2195 * The available route name with the lowest ID will be used, and \a id
2196 * will be set to the ID.
2198 * \return false if a route name could not be found, and \a track_name
2199 * and \a id do not reflect a free route name.
2202 Session::find_route_name (string const & base, uint32_t& id, string& name, bool definitely_add_number)
2204 /* the base may conflict with ports that do not belong to existing
2205 routes, but hidden objects like the click track. So check port names
2206 before anything else.
2209 for (vector<string>::const_iterator reserved = reserved_io_names.begin(); reserved != reserved_io_names.end(); ++reserved) {
2210 if (base == *reserved) {
2211 definitely_add_number = true;
2219 if (!definitely_add_number && route_by_name (base) == 0) {
2220 /* juse use the base */
2226 name = string_compose ("%1 %2", base, id);
2228 if (route_by_name (name) == 0) {
2234 } while (id < (UINT_MAX-1));
2239 /** Count the total ins and outs of all non-hidden tracks in the session and return them in in and out */
2241 Session::count_existing_track_channels (ChanCount& in, ChanCount& out)
2243 in = ChanCount::ZERO;
2244 out = ChanCount::ZERO;
2246 boost::shared_ptr<RouteList> r = routes.reader ();
2248 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
2249 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
2250 if (tr && !tr->is_auditioner()) {
2251 in += tr->n_inputs();
2252 out += tr->n_outputs();
2258 Session::default_track_name_pattern (DataType t)
2261 case DataType::AUDIO:
2262 if (Profile->get_trx()) {
2269 case DataType::MIDI:
2276 /** Caller must not hold process lock
2277 * @param name_template string to use for the start of the name, or "" to use "MIDI".
2278 * @param instrument plugin info for the instrument to insert pre-fader, if any
2280 list<boost::shared_ptr<MidiTrack> >
2281 Session::new_midi_track (const ChanCount& input, const ChanCount& output, boost::shared_ptr<PluginInfo> instrument,
2282 TrackMode mode, RouteGroup* route_group, uint32_t how_many, string name_template)
2285 uint32_t track_id = 0;
2287 RouteList new_routes;
2288 list<boost::shared_ptr<MidiTrack> > ret;
2290 const string name_pattern = default_track_name_pattern (DataType::MIDI);
2291 bool const use_number = (how_many != 1) || name_template.empty () || (name_template == name_pattern);
2294 if (!find_route_name (name_template.empty() ? _("MIDI") : name_template, ++track_id, track_name, use_number)) {
2295 error << "cannot find name for new midi track" << endmsg;
2299 boost::shared_ptr<MidiTrack> track;
2302 track.reset (new MidiTrack (*this, track_name, Route::Flag (0), mode));
2304 if (track->init ()) {
2308 track->use_new_diskstream();
2310 #ifdef BOOST_SP_ENABLE_DEBUG_HOOKS
2311 // boost_debug_shared_ptr_mark_interesting (track.get(), "Track");
2314 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
2315 if (track->input()->ensure_io (input, false, this)) {
2316 error << "cannot configure " << input << " out configuration for new midi track" << endmsg;
2320 if (track->output()->ensure_io (output, false, this)) {
2321 error << "cannot configure " << output << " out configuration for new midi track" << endmsg;
2326 track->non_realtime_input_change();
2329 route_group->add (track);
2332 track->DiskstreamChanged.connect_same_thread (*this, boost::bind (&Session::resort_routes, this));
2334 if (Config->get_remote_model() == UserOrdered) {
2335 track->set_remote_control_id (next_control_id());
2338 new_routes.push_back (track);
2339 ret.push_back (track);
2341 RouteAddedOrRemoved (true); /* EMIT SIGNAL */
2344 catch (failed_constructor &err) {
2345 error << _("Session: could not create new midi track.") << endmsg;
2349 catch (AudioEngine::PortRegistrationFailure& pfe) {
2351 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;
2359 if (!new_routes.empty()) {
2360 StateProtector sp (this);
2361 if (Profile->get_trx()) {
2362 add_routes (new_routes, false, false, false);
2364 add_routes (new_routes, true, true, false);
2368 for (RouteList::iterator r = new_routes.begin(); r != new_routes.end(); ++r) {
2369 PluginPtr plugin = instrument->load (*this);
2370 boost::shared_ptr<Processor> p (new PluginInsert (*this, plugin));
2371 (*r)->add_processor (p, PreFader);
2381 Session::midi_output_change_handler (IOChange change, void * /*src*/, boost::weak_ptr<Route> wmt)
2383 boost::shared_ptr<Route> midi_track (wmt.lock());
2389 if ((change.type & IOChange::ConfigurationChanged) && Config->get_output_auto_connect() != ManualConnect) {
2391 if (change.after.n_audio() <= change.before.n_audio()) {
2395 /* new audio ports: make sure the audio goes somewhere useful,
2396 unless the user has no-auto-connect selected.
2398 The existing ChanCounts don't matter for this call as they are only
2399 to do with matching input and output indices, and we are only changing
2405 auto_connect_route (midi_track, dummy, dummy, false, false, ChanCount(), change.before);
2409 /** @param connect_inputs true to connect inputs as well as outputs, false to connect just outputs.
2410 * @param input_start Where to start from when auto-connecting inputs; e.g. if this is 0, auto-connect starting from input 0.
2411 * @param output_start As \a input_start, but for outputs.
2414 Session::auto_connect_route (boost::shared_ptr<Route> route, ChanCount& existing_inputs, ChanCount& existing_outputs,
2415 bool with_lock, bool connect_inputs, ChanCount input_start, ChanCount output_start)
2417 if (!IO::connecting_legal) {
2421 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock (), Glib::Threads::NOT_LOCK);
2427 /* If both inputs and outputs are auto-connected to physical ports,
2428 use the max of input and output offsets to ensure auto-connected
2429 port numbers always match up (e.g. the first audio input and the
2430 first audio output of the route will have the same physical
2431 port number). Otherwise just use the lowest input or output
2435 DEBUG_TRACE (DEBUG::Graph,
2436 string_compose("Auto-connect: existing in = %1 out = %2\n",
2437 existing_inputs, existing_outputs));
2439 const bool in_out_physical =
2440 (Config->get_input_auto_connect() & AutoConnectPhysical)
2441 && (Config->get_output_auto_connect() & AutoConnectPhysical)
2444 const ChanCount in_offset = in_out_physical
2445 ? ChanCount::max(existing_inputs, existing_outputs)
2448 const ChanCount out_offset = in_out_physical
2449 ? ChanCount::max(existing_inputs, existing_outputs)
2452 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
2453 vector<string> physinputs;
2454 vector<string> physoutputs;
2456 _engine.get_physical_outputs (*t, physoutputs);
2457 _engine.get_physical_inputs (*t, physinputs);
2459 if (!physinputs.empty() && connect_inputs) {
2460 uint32_t nphysical_in = physinputs.size();
2462 DEBUG_TRACE (DEBUG::Graph,
2463 string_compose("There are %1 physical inputs of type %2\n",
2466 for (uint32_t i = input_start.get(*t); i < route->n_inputs().get(*t) && i < nphysical_in; ++i) {
2469 if (Config->get_input_auto_connect() & AutoConnectPhysical) {
2470 DEBUG_TRACE (DEBUG::Graph,
2471 string_compose("Get index %1 + %2 % %3 = %4\n",
2472 in_offset.get(*t), i, nphysical_in,
2473 (in_offset.get(*t) + i) % nphysical_in));
2474 port = physinputs[(in_offset.get(*t) + i) % nphysical_in];
2477 DEBUG_TRACE (DEBUG::Graph,
2478 string_compose("Connect route %1 IN to %2\n",
2479 route->name(), port));
2481 if (!port.empty() && route->input()->connect (route->input()->ports().port(*t, i), port, this)) {
2485 ChanCount one_added (*t, 1);
2486 existing_inputs += one_added;
2490 if (!physoutputs.empty()) {
2491 uint32_t nphysical_out = physoutputs.size();
2492 for (uint32_t i = output_start.get(*t); i < route->n_outputs().get(*t); ++i) {
2496 * do not create new connections if we reached the limit of physical outputs
2500 if (!(Config->get_output_auto_connect() & AutoConnectMaster) &&
2501 ARDOUR::Profile->get_trx () &&
2502 existing_outputs.get(*t) == nphysical_out ) {
2506 if ((*t) == DataType::MIDI && (Config->get_output_auto_connect() & AutoConnectPhysical)) {
2507 port = physoutputs[(out_offset.get(*t) + i) % nphysical_out];
2508 } else if ((*t) == DataType::AUDIO && (Config->get_output_auto_connect() & AutoConnectMaster)) {
2509 /* master bus is audio only */
2510 if (_master_out && _master_out->n_inputs().get(*t) > 0) {
2511 port = _master_out->input()->ports().port(*t,
2512 i % _master_out->input()->n_ports().get(*t))->name();
2516 DEBUG_TRACE (DEBUG::Graph,
2517 string_compose("Connect route %1 OUT to %2\n",
2518 route->name(), port));
2520 if (!port.empty() && route->output()->connect (route->output()->ports().port(*t, i), port, this)) {
2524 ChanCount one_added (*t, 1);
2525 existing_outputs += one_added;
2531 #ifdef USE_TRACKS_CODE_FEATURES
2534 compare_routes_by_remote_id (const boost::shared_ptr<Route>& route1, const boost::shared_ptr<Route>& route2)
2536 return route1->remote_control_id() < route2->remote_control_id();
2540 Session::reconnect_existing_routes (bool withLock, bool reconnect_master, bool reconnect_inputs, bool reconnect_outputs)
2542 // it is not allowed to perform connection
2543 if (!IO::connecting_legal) {
2547 // if we are deleting routes we will call this once at the end
2548 if (_route_deletion_in_progress) {
2552 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock (), Glib::Threads::NOT_LOCK);
2558 // We need to disconnect the route's inputs and outputs first
2559 // basing on autoconnect configuration
2560 bool reconnectIputs = !(Config->get_input_auto_connect() & ManualConnect) && reconnect_inputs;
2561 bool reconnectOutputs = !(Config->get_output_auto_connect() & ManualConnect) && reconnect_outputs;
2563 ChanCount existing_inputs;
2564 ChanCount existing_outputs;
2565 count_existing_track_channels (existing_inputs, existing_outputs);
2567 //ChanCount inputs = ChanCount::ZERO;
2568 //ChanCount outputs = ChanCount::ZERO;
2570 RouteList existing_routes = *routes.reader ();
2571 existing_routes.sort (compare_routes_by_remote_id);
2574 PBD::Unwinder<bool> protect_ignore_changes (_reconnecting_routes_in_progress, true);
2576 vector<string> physinputs;
2577 vector<string> physoutputs;
2579 EngineStateController::instance()->get_physical_audio_outputs(physoutputs);
2580 EngineStateController::instance()->get_physical_audio_inputs(physinputs);
2582 uint32_t input_n = 0;
2583 uint32_t output_n = 0;
2584 RouteList::iterator rIter = existing_routes.begin();
2585 const AutoConnectOption current_input_auto_connection (Config->get_input_auto_connect());
2586 const AutoConnectOption current_output_auto_connection (Config->get_output_auto_connect());
2587 for (; rIter != existing_routes.end(); ++rIter) {
2588 if (*rIter == _master_out || *rIter == _monitor_out ) {
2592 if (current_output_auto_connection == AutoConnectPhysical) {
2593 (*rIter)->amp()->deactivate();
2594 } else if (current_output_auto_connection == AutoConnectMaster) {
2595 (*rIter)->amp()->activate();
2598 if (reconnectIputs) {
2599 (*rIter)->input()->disconnect (this); //GZ: check this; could be heavy
2601 for (uint32_t route_input_n = 0; route_input_n < (*rIter)->n_inputs().get(DataType::AUDIO); ++route_input_n) {
2603 if (current_input_auto_connection & AutoConnectPhysical) {
2605 if ( input_n == physinputs.size() ) {
2609 string port = physinputs[input_n];
2611 if (port.empty() ) {
2612 error << "Physical Input number "<< input_n << " is unavailable and cannot be connected" << endmsg;
2615 //GZ: check this; could be heavy
2616 (*rIter)->input()->connect ((*rIter)->input()->ports().port(DataType::AUDIO, route_input_n), port, this);
2622 if (reconnectOutputs) {
2624 //normalize route ouptuts: reduce the amount outputs to be equal to the amount of inputs
2625 if (current_output_auto_connection & AutoConnectPhysical) {
2627 //GZ: check this; could be heavy
2628 (*rIter)->output()->disconnect (this);
2629 size_t route_inputs_count = (*rIter)->n_inputs().get(DataType::AUDIO);
2631 //GZ: check this; could be heavy
2632 (*rIter)->output()->ensure_io(ChanCount(DataType::AUDIO, route_inputs_count), false, this );
2634 } else if (current_output_auto_connection & AutoConnectMaster){
2636 if (!reconnect_master) {
2640 //GZ: check this; could be heavy
2641 (*rIter)->output()->disconnect (this);
2644 uint32_t master_inputs_count = _master_out->n_inputs().get(DataType::AUDIO);
2645 (*rIter)->output()->ensure_io(ChanCount(DataType::AUDIO, master_inputs_count), false, this );
2647 error << error << "Master bus is not available" << endmsg;
2652 for (uint32_t route_output_n = 0; route_output_n < (*rIter)->n_outputs().get(DataType::AUDIO); ++route_output_n) {
2653 if (current_output_auto_connection & AutoConnectPhysical) {
2655 if ( output_n == physoutputs.size() ) {
2659 string port = physoutputs[output_n];
2661 if (port.empty() ) {
2662 error << "Physical Output number "<< output_n << " is unavailable and cannot be connected" << endmsg;
2665 //GZ: check this; could be heavy
2666 (*rIter)->output()->connect ((*rIter)->output()->ports().port(DataType::AUDIO, route_output_n), port, this);
2669 } else if (current_output_auto_connection & AutoConnectMaster) {
2671 if ( route_output_n == _master_out->n_inputs().get(DataType::AUDIO) ) {
2675 // connect to master bus
2676 string port = _master_out->input()->ports().port(DataType::AUDIO, route_output_n)->name();
2678 if (port.empty() ) {
2679 error << "MasterBus Input number "<< route_output_n << " is unavailable and cannot be connected" << endmsg;
2683 //GZ: check this; could be heavy
2684 (*rIter)->output()->connect ((*rIter)->output()->ports().port(DataType::AUDIO, route_output_n), port, this);
2690 //auto_connect_route (*rIter, inputs, outputs, false, reconnectIputs);
2693 _master_out->output()->disconnect (this);
2694 auto_connect_master_bus ();
2699 session_routes_reconnected (); /* EMIT SIGNAL */
2703 Session::reconnect_midi_scene_ports(bool inputs)
2707 boost::shared_ptr<MidiPort> scene_in_ptr = scene_in();
2709 scene_in_ptr->disconnect_all ();
2711 std::vector<EngineStateController::MidiPortState> midi_port_states;
2712 EngineStateController::instance()->get_physical_midi_input_states (midi_port_states);
2714 std::vector<EngineStateController::MidiPortState>::iterator state_iter = midi_port_states.begin();
2716 for (; state_iter != midi_port_states.end(); ++state_iter) {
2717 if (state_iter->active && state_iter->available && state_iter->scene_connected) {
2718 scene_in_ptr->connect (state_iter->name);
2725 boost::shared_ptr<MidiPort> scene_out_ptr = scene_out();
2727 if (scene_out_ptr ) {
2728 scene_out_ptr->disconnect_all ();
2730 std::vector<EngineStateController::MidiPortState> midi_port_states;
2731 EngineStateController::instance()->get_physical_midi_output_states (midi_port_states);
2733 std::vector<EngineStateController::MidiPortState>::iterator state_iter = midi_port_states.begin();
2735 for (; state_iter != midi_port_states.end(); ++state_iter) {
2736 if (state_iter->active && state_iter->available && state_iter->scene_connected) {
2737 scene_out_ptr->connect (state_iter->name);
2745 Session::reconnect_mtc_ports ()
2747 boost::shared_ptr<MidiPort> mtc_in_ptr = _midi_ports->mtc_input_port();
2753 mtc_in_ptr->disconnect_all ();
2755 std::vector<EngineStateController::MidiPortState> midi_port_states;
2756 EngineStateController::instance()->get_physical_midi_input_states (midi_port_states);
2758 std::vector<EngineStateController::MidiPortState>::iterator state_iter = midi_port_states.begin();
2760 for (; state_iter != midi_port_states.end(); ++state_iter) {
2761 if (state_iter->available && state_iter->mtc_in) {
2762 mtc_in_ptr->connect (state_iter->name);
2766 if (!_midi_ports->mtc_input_port ()->connected () &&
2767 config.get_external_sync () &&
2768 (Config->get_sync_source () == MTC) ) {
2769 config.set_external_sync (false);
2772 if ( ARDOUR::Profile->get_trx () ) {
2773 // Tracks need this signal to update timecode_source_dropdown
2774 MtcOrLtcInputPortChanged (); //emit signal
2779 Session::reconnect_mmc_ports(bool inputs)
2781 if (inputs ) { // get all enabled midi input ports
2783 boost::shared_ptr<MidiPort> mmc_in_ptr = _midi_ports->mmc_in();
2785 mmc_in_ptr->disconnect_all ();
2786 std::vector<std::string> enabled_midi_inputs;
2787 EngineStateController::instance()->get_physical_midi_inputs (enabled_midi_inputs);
2789 std::vector<std::string>::iterator port_iter = enabled_midi_inputs.begin();
2791 for (; port_iter != enabled_midi_inputs.end(); ++port_iter) {
2792 mmc_in_ptr->connect (*port_iter);
2796 } else { // get all enabled midi output ports
2798 boost::shared_ptr<MidiPort> mmc_out_ptr = _midi_ports->mmc_out();
2800 mmc_out_ptr->disconnect_all ();
2801 std::vector<std::string> enabled_midi_outputs;
2802 EngineStateController::instance()->get_physical_midi_outputs (enabled_midi_outputs);
2804 std::vector<std::string>::iterator port_iter = enabled_midi_outputs.begin();
2806 for (; port_iter != enabled_midi_outputs.end(); ++port_iter) {
2807 mmc_out_ptr->connect (*port_iter);
2815 /** Caller must not hold process lock
2816 * @param name_template string to use for the start of the name, or "" to use "Audio".
2818 list< boost::shared_ptr<AudioTrack> >
2819 Session::new_audio_track (int input_channels, int output_channels, TrackMode mode, RouteGroup* route_group,
2820 uint32_t how_many, string name_template)
2823 uint32_t track_id = 0;
2825 RouteList new_routes;
2826 list<boost::shared_ptr<AudioTrack> > ret;
2828 const string name_pattern = default_track_name_pattern (DataType::AUDIO);
2829 bool const use_number = (how_many != 1) || name_template.empty () || (name_template == name_pattern);
2833 if (!find_route_name (name_template.empty() ? _(name_pattern.c_str()) : name_template, ++track_id, track_name, use_number)) {
2834 error << "cannot find name for new audio track" << endmsg;
2838 boost::shared_ptr<AudioTrack> track;
2841 track.reset (new AudioTrack (*this, track_name, Route::Flag (0), mode));
2843 if (track->init ()) {
2847 if (ARDOUR::Profile->get_trx ()) {
2848 // TRACKS considers it's not a USE CASE, it's
2849 // a piece of behavior of the session model:
2851 // Gain for a newly created route depends on
2852 // the current output_auto_connect mode:
2854 // 0 for Stereo Out mode
2856 if (Config->get_output_auto_connect() & AutoConnectMaster) {
2857 track->set_gain (dB_to_coefficient (0), 0);
2861 track->use_new_diskstream();
2863 #ifdef BOOST_SP_ENABLE_DEBUG_HOOKS
2864 // boost_debug_shared_ptr_mark_interesting (track.get(), "Track");
2867 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
2869 if (track->input()->ensure_io (ChanCount(DataType::AUDIO, input_channels), false, this)) {
2870 error << string_compose (
2871 _("cannot configure %1 in/%2 out configuration for new audio track"),
2872 input_channels, output_channels)
2877 if (track->output()->ensure_io (ChanCount(DataType::AUDIO, output_channels), false, this)) {
2878 error << string_compose (
2879 _("cannot configure %1 in/%2 out configuration for new audio track"),
2880 input_channels, output_channels)
2887 route_group->add (track);
2890 track->non_realtime_input_change();
2892 track->DiskstreamChanged.connect_same_thread (*this, boost::bind (&Session::resort_routes, this));
2893 if (Config->get_remote_model() == UserOrdered) {
2894 track->set_remote_control_id (next_control_id());
2897 new_routes.push_back (track);
2898 ret.push_back (track);
2900 RouteAddedOrRemoved (true); /* EMIT SIGNAL */
2903 catch (failed_constructor &err) {
2904 error << _("Session: could not create new audio track.") << endmsg;
2908 catch (AudioEngine::PortRegistrationFailure& pfe) {
2910 error << pfe.what() << endmsg;
2918 if (!new_routes.empty()) {
2919 StateProtector sp (this);
2920 if (Profile->get_trx()) {
2921 add_routes (new_routes, false, false, false);
2923 add_routes (new_routes, true, true, false);
2930 /** Caller must not hold process lock.
2931 * @param name_template string to use for the start of the name, or "" to use "Bus".
2934 Session::new_audio_route (int input_channels, int output_channels, RouteGroup* route_group, uint32_t how_many, string name_template)
2937 uint32_t bus_id = 0;
2941 bool const use_number = (how_many != 1) || name_template.empty () || name_template == _("Bus");
2944 if (!find_route_name (name_template.empty () ? _("Bus") : name_template, ++bus_id, bus_name, use_number)) {
2945 error << "cannot find name for new audio bus" << endmsg;
2950 boost::shared_ptr<Route> bus (new Route (*this, bus_name, Route::Flag(0), DataType::AUDIO));
2956 #ifdef BOOST_SP_ENABLE_DEBUG_HOOKS
2957 // boost_debug_shared_ptr_mark_interesting (bus.get(), "Route");
2960 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
2962 if (bus->input()->ensure_io (ChanCount(DataType::AUDIO, input_channels), false, this)) {
2963 error << string_compose (_("cannot configure %1 in/%2 out configuration for new audio track"),
2964 input_channels, output_channels)
2970 if (bus->output()->ensure_io (ChanCount(DataType::AUDIO, output_channels), false, this)) {
2971 error << string_compose (_("cannot configure %1 in/%2 out configuration for new audio track"),
2972 input_channels, output_channels)
2979 route_group->add (bus);
2981 if (Config->get_remote_model() == UserOrdered) {
2982 bus->set_remote_control_id (next_control_id());
2985 bus->add_internal_return ();
2987 ret.push_back (bus);
2989 RouteAddedOrRemoved (true); /* EMIT SIGNAL */
2995 catch (failed_constructor &err) {
2996 error << _("Session: could not create new audio route.") << endmsg;
3000 catch (AudioEngine::PortRegistrationFailure& pfe) {
3001 error << pfe.what() << endmsg;
3011 StateProtector sp (this);
3012 if (Profile->get_trx()) {
3013 add_routes (ret, false, false, false);
3015 add_routes (ret, false, true, true); // autoconnect // outputs only
3024 Session::new_route_from_template (uint32_t how_many, const std::string& template_path, const std::string& name_base)
3027 uint32_t control_id;
3029 uint32_t number = 0;
3030 const uint32_t being_added = how_many;
3032 if (!tree.read (template_path.c_str())) {
3036 XMLNode* node = tree.root();
3038 IO::disable_connecting ();
3040 control_id = next_control_id ();
3044 XMLNode node_copy (*node);
3046 /* Remove IDs of everything so that new ones are used */
3047 node_copy.remove_property_recursively (X_("id"));
3052 if (!name_base.empty()) {
3054 /* if we're adding more than one routes, force
3055 * all the names of the new routes to be
3056 * numbered, via the final parameter.
3059 if (!find_route_name (name_base.c_str(), ++number, name, (being_added > 1))) {
3060 fatal << _("Session: UINT_MAX routes? impossible!") << endmsg;
3066 string const route_name = node_copy.property(X_("name"))->value ();
3068 /* generate a new name by adding a number to the end of the template name */
3069 if (!find_route_name (route_name.c_str(), ++number, name, true)) {
3070 fatal << _("Session: UINT_MAX routes? impossible!") << endmsg;
3071 abort(); /*NOTREACHED*/
3075 /* set this name in the XML description that we are about to use */
3076 Route::set_name_in_state (node_copy, name);
3078 /* trim bitslots from listen sends so that new ones are used */
3079 XMLNodeList children = node_copy.children ();
3080 for (XMLNodeList::iterator i = children.begin(); i != children.end(); ++i) {
3081 if ((*i)->name() == X_("Processor")) {
3082 XMLProperty* role = (*i)->property (X_("role"));
3083 if (role && role->value() == X_("Listen")) {
3084 (*i)->remove_property (X_("bitslot"));
3089 boost::shared_ptr<Route> route (XMLRouteFactory (node_copy, 3000));
3092 error << _("Session: cannot create track/bus from template description") << endmsg;
3096 if (boost::dynamic_pointer_cast<Track>(route)) {
3097 /* force input/output change signals so that the new diskstream
3098 picks up the configuration of the route. During session
3099 loading this normally happens in a different way.
3102 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
3104 IOChange change (IOChange::Type (IOChange::ConfigurationChanged | IOChange::ConnectionsChanged));
3105 change.after = route->input()->n_ports();
3106 route->input()->changed (change, this);
3107 change.after = route->output()->n_ports();
3108 route->output()->changed (change, this);
3111 route->set_remote_control_id (control_id);
3114 ret.push_back (route);
3116 RouteAddedOrRemoved (true); /* EMIT SIGNAL */
3119 catch (failed_constructor &err) {
3120 error << _("Session: could not create new route from template") << endmsg;
3124 catch (AudioEngine::PortRegistrationFailure& pfe) {
3125 error << pfe.what() << endmsg;
3134 StateProtector sp (this);
3135 if (Profile->get_trx()) {
3136 add_routes (ret, false, false, false);
3138 add_routes (ret, true, true, false);
3140 IO::enable_connecting ();
3147 Session::add_routes (RouteList& new_routes, bool input_auto_connect, bool output_auto_connect, bool save)
3150 PBD::Unwinder<bool> aip (_adding_routes_in_progress, true);
3151 add_routes_inner (new_routes, input_auto_connect, output_auto_connect);
3154 error << _("Adding new tracks/busses failed") << endmsg;
3159 update_latency (true);
3160 update_latency (false);
3165 save_state (_current_snapshot_name);
3168 reassign_track_numbers();
3170 update_route_record_state ();
3172 RouteAdded (new_routes); /* EMIT SIGNAL */
3176 Session::add_routes_inner (RouteList& new_routes, bool input_auto_connect, bool output_auto_connect)
3178 ChanCount existing_inputs;
3179 ChanCount existing_outputs;
3180 uint32_t order = next_control_id();
3182 if (_order_hint > -1) {
3183 order = _order_hint;
3187 count_existing_track_channels (existing_inputs, existing_outputs);
3190 RCUWriter<RouteList> writer (routes);
3191 boost::shared_ptr<RouteList> r = writer.get_copy ();
3192 r->insert (r->end(), new_routes.begin(), new_routes.end());
3194 /* if there is no control out and we're not in the middle of loading,
3195 resort the graph here. if there is a control out, we will resort
3196 toward the end of this method. if we are in the middle of loading,
3197 we will resort when done.
3200 if (!_monitor_out && IO::connecting_legal) {
3201 resort_routes_using (r);
3205 for (RouteList::iterator x = new_routes.begin(); x != new_routes.end(); ++x) {
3207 boost::weak_ptr<Route> wpr (*x);
3208 boost::shared_ptr<Route> r (*x);
3210 r->listen_changed.connect_same_thread (*this, boost::bind (&Session::route_listen_changed, this, _1, wpr));
3211 r->solo_changed.connect_same_thread (*this, boost::bind (&Session::route_solo_changed, this, _1, _2, wpr));
3212 r->solo_isolated_changed.connect_same_thread (*this, boost::bind (&Session::route_solo_isolated_changed, this, _1, wpr));
3213 r->mute_changed.connect_same_thread (*this, boost::bind (&Session::route_mute_changed, this, _1));
3214 r->output()->changed.connect_same_thread (*this, boost::bind (&Session::set_worst_io_latencies_x, this, _1, _2));
3215 r->processors_changed.connect_same_thread (*this, boost::bind (&Session::route_processors_changed, this, _1));
3217 if (r->is_master()) {
3221 if (r->is_monitor()) {
3225 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (r);
3227 tr->PlaylistChanged.connect_same_thread (*this, boost::bind (&Session::track_playlist_changed, this, boost::weak_ptr<Track> (tr)));
3228 track_playlist_changed (boost::weak_ptr<Track> (tr));
3229 tr->RecordEnableChanged.connect_same_thread (*this, boost::bind (&Session::update_route_record_state, this));
3231 boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (tr);
3233 mt->StepEditStatusChange.connect_same_thread (*this, boost::bind (&Session::step_edit_status_change, this, _1));
3234 mt->output()->changed.connect_same_thread (*this, boost::bind (&Session::midi_output_change_handler, this, _1, _2, boost::weak_ptr<Route>(mt)));
3239 if (input_auto_connect || output_auto_connect) {
3240 auto_connect_route (r, existing_inputs, existing_outputs, true, input_auto_connect);
3243 /* order keys are a GUI responsibility but we need to set up
3244 reasonable defaults because they also affect the remote control
3245 ID in most situations.
3248 if (!r->has_order_key ()) {
3249 if (r->is_auditioner()) {
3250 /* use an arbitrarily high value */
3251 r->set_order_key (UINT_MAX);
3253 DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("while adding, set %1 to order key %2\n", r->name(), order));
3254 r->set_order_key (order);
3262 if (_monitor_out && IO::connecting_legal) {
3263 Glib::Threads::Mutex::Lock lm (_engine.process_lock());
3265 for (RouteList::iterator x = new_routes.begin(); x != new_routes.end(); ++x) {
3266 if ((*x)->is_monitor()) {
3268 } else if ((*x)->is_master()) {
3271 (*x)->enable_monitor_send ();
3278 Session::globally_set_send_gains_to_zero (boost::shared_ptr<Route> dest)
3280 boost::shared_ptr<RouteList> r = routes.reader ();
3281 boost::shared_ptr<Send> s;
3283 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3284 if ((s = (*i)->internal_send_for (dest)) != 0) {
3285 s->amp()->gain_control()->set_value (GAIN_COEFF_ZERO);
3291 Session::globally_set_send_gains_to_unity (boost::shared_ptr<Route> dest)
3293 boost::shared_ptr<RouteList> r = routes.reader ();
3294 boost::shared_ptr<Send> s;
3296 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3297 if ((s = (*i)->internal_send_for (dest)) != 0) {
3298 s->amp()->gain_control()->set_value (GAIN_COEFF_UNITY);
3304 Session::globally_set_send_gains_from_track(boost::shared_ptr<Route> dest)
3306 boost::shared_ptr<RouteList> r = routes.reader ();
3307 boost::shared_ptr<Send> s;
3309 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3310 if ((s = (*i)->internal_send_for (dest)) != 0) {
3311 s->amp()->gain_control()->set_value ((*i)->gain_control()->get_value());
3316 /** @param include_buses true to add sends to buses and tracks, false for just tracks */
3318 Session::globally_add_internal_sends (boost::shared_ptr<Route> dest, Placement p, bool include_buses)
3320 boost::shared_ptr<RouteList> r = routes.reader ();
3321 boost::shared_ptr<RouteList> t (new RouteList);
3323 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3324 /* no MIDI sends because there are no MIDI busses yet */
3325 if (include_buses || boost::dynamic_pointer_cast<AudioTrack>(*i)) {
3330 add_internal_sends (dest, p, t);
3334 Session::add_internal_sends (boost::shared_ptr<Route> dest, Placement p, boost::shared_ptr<RouteList> senders)
3336 for (RouteList::iterator i = senders->begin(); i != senders->end(); ++i) {
3337 add_internal_send (dest, (*i)->before_processor_for_placement (p), *i);
3342 Session::add_internal_send (boost::shared_ptr<Route> dest, int index, boost::shared_ptr<Route> sender)
3344 add_internal_send (dest, sender->before_processor_for_index (index), sender);
3348 Session::add_internal_send (boost::shared_ptr<Route> dest, boost::shared_ptr<Processor> before, boost::shared_ptr<Route> sender)
3350 if (sender->is_monitor() || sender->is_master() || sender == dest || dest->is_monitor() || dest->is_master()) {
3354 if (!dest->internal_return()) {
3355 dest->add_internal_return ();
3358 sender->add_aux_send (dest, before);
3365 Session::remove_routes (boost::shared_ptr<RouteList> routes_to_remove)
3367 PBD::Unwinder<bool> uw_flag (_route_deletion_in_progress, true);
3369 { // RCU Writer scope
3370 RCUWriter<RouteList> writer (routes);
3371 boost::shared_ptr<RouteList> rs = writer.get_copy ();
3374 for (RouteList::iterator iter = routes_to_remove->begin(); iter != routes_to_remove->end(); ++iter) {
3376 if (*iter == _master_out) {
3380 (*iter)->set_solo (false, this);
3384 /* deleting the master out seems like a dumb
3385 idea, but its more of a UI policy issue
3389 if (*iter == _master_out) {
3390 _master_out = boost::shared_ptr<Route> ();
3393 if (*iter == _monitor_out) {
3394 _monitor_out.reset ();
3397 // We need to disconnect the route's inputs and outputs
3399 (*iter)->input()->disconnect (0);
3400 (*iter)->output()->disconnect (0);
3402 /* if the route had internal sends sending to it, remove them */
3403 if ((*iter)->internal_return()) {
3405 boost::shared_ptr<RouteList> r = routes.reader ();
3406 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3407 boost::shared_ptr<Send> s = (*i)->internal_send_for (*iter);
3409 (*i)->remove_processor (s);
3414 /* if the monitoring section had a pointer to this route, remove it */
3415 if (_monitor_out && !(*iter)->is_master() && !(*iter)->is_monitor()) {
3416 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
3417 PBD::Unwinder<bool> uw (ignore_route_processor_changes, true);
3418 (*iter)->remove_aux_or_listen (_monitor_out);
3421 boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (*iter);
3422 if (mt && mt->step_editing()) {
3423 if (_step_editors > 0) {
3429 /* writer goes out of scope, forces route list update */
3431 } // end of RCU Writer scope
3433 update_route_solo_state ();
3434 RouteAddedOrRemoved (false); /* EMIT SIGNAL */
3435 update_latency_compensation ();
3438 /* Re-sort routes to remove the graph's current references to the one that is
3439 * going away, then flush old references out of the graph.
3440 * Wave Tracks: reconnect routes
3443 #ifdef USE_TRACKS_CODE_FEATURES
3444 reconnect_existing_routes(true, false);
3446 routes.flush (); // maybe unsafe, see below.
3450 if (_process_graph) {
3451 _process_graph->clear_other_chain ();
3454 /* get rid of it from the dead wood collection in the route list manager */
3455 /* XXX i think this is unsafe as it currently stands, but i am not sure. (pd, october 2nd, 2006) */
3459 /* try to cause everyone to drop their references
3460 * and unregister ports from the backend
3463 for (RouteList::iterator iter = routes_to_remove->begin(); iter != routes_to_remove->end(); ++iter) {
3464 (*iter)->drop_references ();
3467 Route::RemoteControlIDChange(); /* EMIT SIGNAL */
3469 /* save the new state of the world */
3471 if (save_state (_current_snapshot_name)) {
3472 save_history (_current_snapshot_name);
3475 reassign_track_numbers();
3476 update_route_record_state ();
3480 Session::remove_route (boost::shared_ptr<Route> route)
3482 boost::shared_ptr<RouteList> rl (new RouteList);
3483 rl->push_back (route);
3488 Session::route_mute_changed (void* /*src*/)
3494 Session::route_listen_changed (void* /*src*/, boost::weak_ptr<Route> wpr)
3496 boost::shared_ptr<Route> route = wpr.lock();
3498 error << string_compose (_("programming error: %1"), X_("invalid route weak ptr passed to route_solo_changed")) << endmsg;
3502 if (route->listening_via_monitor ()) {
3504 if (Config->get_exclusive_solo()) {
3505 /* new listen: disable all other listen, except solo-grouped channels */
3506 RouteGroup* rg = route->route_group ();
3507 bool leave_group_alone = (rg && rg->is_active() && rg->is_solo());
3508 boost::shared_ptr<RouteList> r = routes.reader ();
3509 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3510 if ((*i) == route || (*i)->solo_isolated() || (*i)->is_master() || (*i)->is_monitor() || (*i)->is_auditioner() || (leave_group_alone && ((*i)->route_group() == rg))) {
3513 (*i)->set_listen (false, this);
3519 } else if (_listen_cnt > 0) {
3524 update_route_solo_state ();
3527 Session::route_solo_isolated_changed (void* /*src*/, boost::weak_ptr<Route> wpr)
3529 boost::shared_ptr<Route> route = wpr.lock ();
3532 /* should not happen */
3533 error << string_compose (_("programming error: %1"), X_("invalid route weak ptr passed to route_solo_isolated_changed")) << endmsg;
3537 bool send_changed = false;
3539 if (route->solo_isolated()) {
3540 if (_solo_isolated_cnt == 0) {
3541 send_changed = true;
3543 _solo_isolated_cnt++;
3544 } else if (_solo_isolated_cnt > 0) {
3545 _solo_isolated_cnt--;
3546 if (_solo_isolated_cnt == 0) {
3547 send_changed = true;
3552 IsolatedChanged (); /* EMIT SIGNAL */
3557 Session::route_solo_changed (bool self_solo_change, void* /*src*/, boost::weak_ptr<Route> wpr)
3559 DEBUG_TRACE (DEBUG::Solo, string_compose ("route solo change, self = %1\n", self_solo_change));
3561 if (!self_solo_change) {
3562 // session doesn't care about changes to soloed-by-others
3566 boost::shared_ptr<Route> route = wpr.lock ();
3569 boost::shared_ptr<RouteList> r = routes.reader ();
3572 if (route->self_soloed()) {
3578 RouteGroup* rg = route->route_group ();
3579 bool leave_group_alone = (rg && rg->is_active() && rg->is_solo());
3581 if (delta == 1 && Config->get_exclusive_solo()) {
3583 /* new solo: disable all other solos, but not the group if its solo-enabled */
3585 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3586 if ((*i) == route || (*i)->solo_isolated() || (*i)->is_master() || (*i)->is_monitor() || (*i)->is_auditioner() ||
3587 (leave_group_alone && ((*i)->route_group() == rg))) {
3590 (*i)->set_solo (false, this);
3594 DEBUG_TRACE (DEBUG::Solo, string_compose ("propagate solo change, delta = %1\n", delta));
3596 RouteList uninvolved;
3598 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1\n", route->name()));
3600 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3601 bool via_sends_only;
3602 bool in_signal_flow;
3604 if ((*i) == route || (*i)->solo_isolated() || (*i)->is_master() || (*i)->is_monitor() || (*i)->is_auditioner() ||
3605 (leave_group_alone && ((*i)->route_group() == rg))) {
3609 in_signal_flow = false;
3611 DEBUG_TRACE (DEBUG::Solo, string_compose ("check feed from %1\n", (*i)->name()));
3613 if ((*i)->feeds (route, &via_sends_only)) {
3614 DEBUG_TRACE (DEBUG::Solo, string_compose ("\tthere is a feed from %1\n", (*i)->name()));
3615 if (!via_sends_only) {
3616 if (!route->soloed_by_others_upstream()) {
3617 (*i)->mod_solo_by_others_downstream (delta);
3620 DEBUG_TRACE (DEBUG::Solo, string_compose ("\tthere is a send-only feed from %1\n", (*i)->name()));
3622 in_signal_flow = true;
3624 DEBUG_TRACE (DEBUG::Solo, string_compose ("\tno feed from %1\n", (*i)->name()));
3627 DEBUG_TRACE (DEBUG::Solo, string_compose ("check feed to %1\n", (*i)->name()));
3629 if (route->feeds (*i, &via_sends_only)) {
3630 /* propagate solo upstream only if routing other than
3631 sends is involved, but do consider the other route
3632 (*i) to be part of the signal flow even if only
3635 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1 feeds %2 via sends only %3 sboD %4 sboU %5\n",
3639 route->soloed_by_others_downstream(),
3640 route->soloed_by_others_upstream()));
3641 if (!via_sends_only) {
3642 if (!route->soloed_by_others_downstream()) {
3643 DEBUG_TRACE (DEBUG::Solo, string_compose ("\tmod %1 by %2\n", (*i)->name(), delta));
3644 (*i)->mod_solo_by_others_upstream (delta);
3646 DEBUG_TRACE (DEBUG::Solo, "\talready soloed by others downstream\n");
3649 DEBUG_TRACE (DEBUG::Solo, string_compose ("\tfeed to %1 ignored, sends-only\n", (*i)->name()));
3651 in_signal_flow = true;
3653 DEBUG_TRACE (DEBUG::Solo, "\tno feed to\n");
3656 if (!in_signal_flow) {
3657 uninvolved.push_back (*i);
3661 DEBUG_TRACE (DEBUG::Solo, "propagation complete\n");
3663 update_route_solo_state (r);
3665 /* now notify that the mute state of the routes not involved in the signal
3666 pathway of the just-solo-changed route may have altered.
3669 for (RouteList::iterator i = uninvolved.begin(); i != uninvolved.end(); ++i) {
3670 DEBUG_TRACE (DEBUG::Solo, string_compose ("mute change for %1, which neither feeds or is fed by %2\n", (*i)->name(), route->name()));
3671 (*i)->act_on_mute ();
3672 (*i)->mute_changed (this);
3675 SoloChanged (); /* EMIT SIGNAL */
3680 Session::update_route_solo_state (boost::shared_ptr<RouteList> r)
3682 /* now figure out if anything that matters is soloed (or is "listening")*/
3684 bool something_soloed = false;
3685 uint32_t listeners = 0;
3686 uint32_t isolated = 0;
3689 r = routes.reader();
3692 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3693 if (!(*i)->is_master() && !(*i)->is_monitor() && !(*i)->is_auditioner() && (*i)->self_soloed()) {
3694 something_soloed = true;
3697 if (!(*i)->is_auditioner() && (*i)->listening_via_monitor()) {
3698 if (Config->get_solo_control_is_listen_control()) {
3701 (*i)->set_listen (false, this);
3705 if ((*i)->solo_isolated()) {
3710 if (something_soloed != _non_soloed_outs_muted) {
3711 _non_soloed_outs_muted = something_soloed;
3712 SoloActive (_non_soloed_outs_muted); /* EMIT SIGNAL */
3715 _listen_cnt = listeners;
3717 if (isolated != _solo_isolated_cnt) {
3718 _solo_isolated_cnt = isolated;
3719 IsolatedChanged (); /* EMIT SIGNAL */
3722 DEBUG_TRACE (DEBUG::Solo, string_compose ("solo state updated by session, soloed? %1 listeners %2 isolated %3\n",
3723 something_soloed, listeners, isolated));
3726 boost::shared_ptr<RouteList>
3727 Session::get_routes_with_internal_returns() const
3729 boost::shared_ptr<RouteList> r = routes.reader ();
3730 boost::shared_ptr<RouteList> rl (new RouteList);
3732 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3733 if ((*i)->internal_return ()) {
3741 Session::io_name_is_legal (const std::string& name)
3743 boost::shared_ptr<RouteList> r = routes.reader ();
3745 for (vector<string>::const_iterator reserved = reserved_io_names.begin(); reserved != reserved_io_names.end(); ++reserved) {
3746 if (name == *reserved) {
3751 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3752 if ((*i)->name() == name) {
3756 if ((*i)->has_io_processor_named (name)) {
3765 Session::set_exclusive_input_active (boost::shared_ptr<RouteList> rl, bool onoff, bool flip_others)
3768 vector<string> connections;
3770 /* if we are passed only a single route and we're not told to turn
3771 * others off, then just do the simple thing.
3774 if (flip_others == false && rl->size() == 1) {
3775 boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (rl->front());
3777 mt->set_input_active (onoff);
3782 for (RouteList::iterator rt = rl->begin(); rt != rl->end(); ++rt) {
3784 PortSet& ps ((*rt)->input()->ports());
3786 for (PortSet::iterator p = ps.begin(); p != ps.end(); ++p) {
3787 p->get_connections (connections);
3790 for (vector<string>::iterator s = connections.begin(); s != connections.end(); ++s) {
3791 routes_using_input_from (*s, rl2);
3794 /* scan all relevant routes to see if others are on or off */
3796 bool others_are_already_on = false;
3798 for (RouteList::iterator r = rl2.begin(); r != rl2.end(); ++r) {
3800 boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (*r);
3806 if ((*r) != (*rt)) {
3807 if (mt->input_active()) {
3808 others_are_already_on = true;
3811 /* this one needs changing */
3812 mt->set_input_active (onoff);
3818 /* globally reverse other routes */
3820 for (RouteList::iterator r = rl2.begin(); r != rl2.end(); ++r) {
3821 if ((*r) != (*rt)) {
3822 boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (*r);
3824 mt->set_input_active (!others_are_already_on);
3833 Session::routes_using_input_from (const string& str, RouteList& rl)
3835 boost::shared_ptr<RouteList> r = routes.reader();
3837 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3838 if ((*i)->input()->connected_to (str)) {
3844 boost::shared_ptr<Route>
3845 Session::route_by_name (string name)
3847 boost::shared_ptr<RouteList> r = routes.reader ();
3849 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3850 if ((*i)->name() == name) {
3855 return boost::shared_ptr<Route> ((Route*) 0);
3858 boost::shared_ptr<Route>
3859 Session::route_by_id (PBD::ID id)
3861 boost::shared_ptr<RouteList> r = routes.reader ();
3863 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3864 if ((*i)->id() == id) {
3869 return boost::shared_ptr<Route> ((Route*) 0);
3872 boost::shared_ptr<Track>
3873 Session::track_by_diskstream_id (PBD::ID id)
3875 boost::shared_ptr<RouteList> r = routes.reader ();
3877 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3878 boost::shared_ptr<Track> t = boost::dynamic_pointer_cast<Track> (*i);
3879 if (t && t->using_diskstream_id (id)) {
3884 return boost::shared_ptr<Track> ();
3887 boost::shared_ptr<Route>
3888 Session::route_by_remote_id (uint32_t id)
3890 boost::shared_ptr<RouteList> r = routes.reader ();
3892 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3893 if ((*i)->remote_control_id() == id) {
3898 return boost::shared_ptr<Route> ((Route*) 0);
3903 Session::reassign_track_numbers ()
3907 RouteList r (*(routes.reader ()));
3908 SignalOrderRouteSorter sorter;
3911 StateProtector sp (this);
3913 for (RouteList::iterator i = r.begin(); i != r.end(); ++i) {
3914 if (boost::dynamic_pointer_cast<Track> (*i)) {
3915 (*i)->set_track_number(++tn);
3917 else if (!(*i)->is_master() && !(*i)->is_monitor() && !(*i)->is_auditioner()) {
3918 (*i)->set_track_number(--bn);
3921 const uint32_t decimals = ceilf (log10f (tn + 1));
3922 const bool decimals_changed = _track_number_decimals != decimals;
3923 _track_number_decimals = decimals;
3925 if (decimals_changed && config.get_track_name_number ()) {
3926 for (RouteList::iterator i = r.begin(); i != r.end(); ++i) {
3927 boost::shared_ptr<Track> t = boost::dynamic_pointer_cast<Track> (*i);
3929 t->resync_track_name();
3932 // trigger GUI re-layout
3933 config.ParameterChanged("track-name-number");
3938 Session::playlist_region_added (boost::weak_ptr<Region> w)
3940 boost::shared_ptr<Region> r = w.lock ();
3945 /* These are the operations that are currently in progress... */
3946 list<GQuark> curr = _current_trans_quarks;
3949 /* ...and these are the operations during which we want to update
3950 the session range location markers.
3953 ops.push_back (Operations::capture);
3954 ops.push_back (Operations::paste);
3955 ops.push_back (Operations::duplicate_region);
3956 ops.push_back (Operations::insert_file);
3957 ops.push_back (Operations::insert_region);
3958 ops.push_back (Operations::drag_region_brush);
3959 ops.push_back (Operations::region_drag);
3960 ops.push_back (Operations::selection_grab);
3961 ops.push_back (Operations::region_fill);
3962 ops.push_back (Operations::fill_selection);
3963 ops.push_back (Operations::create_region);
3964 ops.push_back (Operations::region_copy);
3965 ops.push_back (Operations::fixed_time_region_copy);
3968 /* See if any of the current operations match the ones that we want */
3970 set_intersection (_current_trans_quarks.begin(), _current_trans_quarks.end(), ops.begin(), ops.end(), back_inserter (in));
3972 /* If so, update the session range markers */
3974 maybe_update_session_range (r->position (), r->last_frame ());
3978 /** Update the session range markers if a is before the current start or
3979 * b is after the current end.
3982 Session::maybe_update_session_range (framepos_t a, framepos_t b)
3984 if (_state_of_the_state & Loading) {
3988 framepos_t session_end_marker_shift_samples = session_end_shift * _nominal_frame_rate;
3990 if (_session_range_location == 0) {
3992 set_session_range_location (a, b + session_end_marker_shift_samples);
3996 if (a < _session_range_location->start()) {
3997 _session_range_location->set_start (a);
4000 if (b > _session_range_location->end()) {
4001 _session_range_location->set_end (b);
4007 Session::playlist_ranges_moved (list<Evoral::RangeMove<framepos_t> > const & ranges)
4009 for (list<Evoral::RangeMove<framepos_t> >::const_iterator i = ranges.begin(); i != ranges.end(); ++i) {
4010 maybe_update_session_range (i->to, i->to + i->length);
4015 Session::playlist_regions_extended (list<Evoral::Range<framepos_t> > const & ranges)
4017 for (list<Evoral::Range<framepos_t> >::const_iterator i = ranges.begin(); i != ranges.end(); ++i) {
4018 maybe_update_session_range (i->from, i->to);
4022 /* Region management */
4024 boost::shared_ptr<Region>
4025 Session::find_whole_file_parent (boost::shared_ptr<Region const> child) const
4027 const RegionFactory::RegionMap& regions (RegionFactory::regions());
4028 RegionFactory::RegionMap::const_iterator i;
4029 boost::shared_ptr<Region> region;
4031 Glib::Threads::Mutex::Lock lm (region_lock);
4033 for (i = regions.begin(); i != regions.end(); ++i) {
4037 if (region->whole_file()) {
4039 if (child->source_equivalent (region)) {
4045 return boost::shared_ptr<Region> ();
4049 Session::destroy_sources (list<boost::shared_ptr<Source> > srcs)
4051 set<boost::shared_ptr<Region> > relevant_regions;
4053 for (list<boost::shared_ptr<Source> >::iterator s = srcs.begin(); s != srcs.end(); ++s) {
4054 RegionFactory::get_regions_using_source (*s, relevant_regions);
4057 for (set<boost::shared_ptr<Region> >::iterator r = relevant_regions.begin(); r != relevant_regions.end(); ) {
4058 set<boost::shared_ptr<Region> >::iterator tmp;
4063 playlists->destroy_region (*r);
4064 RegionFactory::map_remove (*r);
4066 (*r)->drop_sources ();
4067 (*r)->drop_references ();
4069 relevant_regions.erase (r);
4074 for (list<boost::shared_ptr<Source> >::iterator s = srcs.begin(); s != srcs.end(); ) {
4077 Glib::Threads::Mutex::Lock ls (source_lock);
4078 /* remove from the main source list */
4079 sources.erase ((*s)->id());
4082 (*s)->mark_for_remove ();
4083 (*s)->drop_references ();
4092 Session::remove_last_capture ()
4094 list<boost::shared_ptr<Source> > srcs;
4096 boost::shared_ptr<RouteList> rl = routes.reader ();
4097 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
4098 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
4103 list<boost::shared_ptr<Source> >& l = tr->last_capture_sources();
4106 srcs.insert (srcs.end(), l.begin(), l.end());
4111 destroy_sources (srcs);
4113 save_state (_current_snapshot_name);
4118 /* Source Management */
4121 Session::add_source (boost::shared_ptr<Source> source)
4123 pair<SourceMap::key_type, SourceMap::mapped_type> entry;
4124 pair<SourceMap::iterator,bool> result;
4126 entry.first = source->id();
4127 entry.second = source;
4130 Glib::Threads::Mutex::Lock lm (source_lock);
4131 result = sources.insert (entry);
4134 if (result.second) {
4136 /* yay, new source */
4138 boost::shared_ptr<FileSource> fs = boost::dynamic_pointer_cast<FileSource> (source);
4141 if (!fs->within_session()) {
4142 ensure_search_path_includes (Glib::path_get_dirname (fs->path()), fs->type());
4148 boost::shared_ptr<AudioFileSource> afs;
4150 if ((afs = boost::dynamic_pointer_cast<AudioFileSource>(source)) != 0) {
4151 if (Config->get_auto_analyse_audio()) {
4152 Analyser::queue_source_for_analysis (source, false);
4156 source->DropReferences.connect_same_thread (*this, boost::bind (&Session::remove_source, this, boost::weak_ptr<Source> (source)));
4161 Session::remove_source (boost::weak_ptr<Source> src)
4163 if (_state_of_the_state & Deletion) {
4167 SourceMap::iterator i;
4168 boost::shared_ptr<Source> source = src.lock();
4175 Glib::Threads::Mutex::Lock lm (source_lock);
4177 if ((i = sources.find (source->id())) != sources.end()) {
4182 if (!(_state_of_the_state & StateOfTheState (InCleanup|Loading))) {
4184 /* save state so we don't end up with a session file
4185 referring to non-existent sources.
4188 save_state (_current_snapshot_name);
4192 boost::shared_ptr<Source>
4193 Session::source_by_id (const PBD::ID& id)
4195 Glib::Threads::Mutex::Lock lm (source_lock);
4196 SourceMap::iterator i;
4197 boost::shared_ptr<Source> source;
4199 if ((i = sources.find (id)) != sources.end()) {
4206 boost::shared_ptr<AudioFileSource>
4207 Session::audio_source_by_path_and_channel (const string& path, uint16_t chn) const
4209 /* Restricted to audio files because only audio sources have channel
4213 Glib::Threads::Mutex::Lock lm (source_lock);
4215 for (SourceMap::const_iterator i = sources.begin(); i != sources.end(); ++i) {
4216 boost::shared_ptr<AudioFileSource> afs
4217 = boost::dynamic_pointer_cast<AudioFileSource>(i->second);
4219 if (afs && afs->path() == path && chn == afs->channel()) {
4224 return boost::shared_ptr<AudioFileSource>();
4227 boost::shared_ptr<MidiSource>
4228 Session::midi_source_by_path (const std::string& path) const
4230 /* Restricted to MIDI files because audio sources require a channel
4231 for unique identification, in addition to a path.
4234 Glib::Threads::Mutex::Lock lm (source_lock);
4236 for (SourceMap::const_iterator s = sources.begin(); s != sources.end(); ++s) {
4237 boost::shared_ptr<MidiSource> ms
4238 = boost::dynamic_pointer_cast<MidiSource>(s->second);
4239 boost::shared_ptr<FileSource> fs
4240 = boost::dynamic_pointer_cast<FileSource>(s->second);
4242 if (ms && fs && fs->path() == path) {
4247 return boost::shared_ptr<MidiSource>();
4251 Session::count_sources_by_origin (const string& path)
4254 Glib::Threads::Mutex::Lock lm (source_lock);
4256 for (SourceMap::iterator i = sources.begin(); i != sources.end(); ++i) {
4257 boost::shared_ptr<FileSource> fs
4258 = boost::dynamic_pointer_cast<FileSource>(i->second);
4260 if (fs && fs->origin() == path) {
4269 peak_file_helper (const string& peak_path, const string& file_path, const string& file_base, bool hash) {
4271 std::string checksum = Glib::Checksum::compute_checksum(Glib::Checksum::CHECKSUM_SHA1, file_path + G_DIR_SEPARATOR + file_base);
4272 return Glib::build_filename (peak_path, checksum + peakfile_suffix);
4274 return Glib::build_filename (peak_path, file_base + peakfile_suffix);
4279 Session::construct_peak_filepath (const string& filepath, const bool in_session, const bool old_peak_name) const
4281 string interchange_dir_string = string (interchange_dir_name) + G_DIR_SEPARATOR;
4283 if (Glib::path_is_absolute (filepath)) {
4285 /* rip the session dir from the audiofile source */
4287 string session_path;
4288 bool in_another_session = true;
4290 if (filepath.find (interchange_dir_string) != string::npos) {
4292 session_path = Glib::path_get_dirname (filepath); /* now ends in audiofiles */
4293 session_path = Glib::path_get_dirname (session_path); /* now ends in session name */
4294 session_path = Glib::path_get_dirname (session_path); /* now ends in interchange */
4295 session_path = Glib::path_get_dirname (session_path); /* now has session path */
4297 /* see if it is within our session */
4299 for (vector<space_and_path>::const_iterator i = session_dirs.begin(); i != session_dirs.end(); ++i) {
4300 if (i->path == session_path) {
4301 in_another_session = false;
4306 in_another_session = false;
4310 if (in_another_session) {
4311 SessionDirectory sd (session_path);
4312 return peak_file_helper (sd.peak_path(), "", Glib::path_get_basename (filepath), !old_peak_name);
4316 /* 1) if file belongs to this session
4317 * it may be a relative path (interchange/...)
4318 * or just basename (session_state, remove source)
4319 * -> just use the basename
4321 std::string filename = Glib::path_get_basename (filepath);
4324 /* 2) if the file is outside our session dir:
4325 * (imported but not copied) add the path for check-summming */
4327 path = Glib::path_get_dirname (filepath);
4330 return peak_file_helper (_session_dir->peak_path(), path, Glib::path_get_basename (filepath), !old_peak_name);
4334 Session::new_audio_source_path_for_embedded (const std::string& path)
4338 * we know that the filename is already unique because it exists
4339 * out in the filesystem.
4341 * However, when we bring it into the session, we could get a
4344 * Eg. two embedded files:
4349 * When merged into session, these collide.
4351 * There will not be a conflict with in-memory sources
4352 * because when the source was created we already picked
4353 * a unique name for it.
4355 * This collision is not likely to be common, but we have to guard
4356 * against it. So, if there is a collision, take the md5 hash of the
4357 * the path, and use that as the filename instead.
4360 SessionDirectory sdir (get_best_session_directory_for_new_audio());
4361 string base = Glib::path_get_basename (path);
4362 string newpath = Glib::build_filename (sdir.sound_path(), base);
4364 if (Glib::file_test (newpath, Glib::FILE_TEST_EXISTS)) {
4368 md5.digestString (path.c_str());
4369 md5.writeToString ();
4370 base = md5.digestChars;
4372 string ext = get_suffix (path);
4379 newpath = Glib::build_filename (sdir.sound_path(), base);
4381 /* if this collides, we're screwed */
4383 if (Glib::file_test (newpath, Glib::FILE_TEST_EXISTS)) {
4384 error << string_compose (_("Merging embedded file %1: name collision AND md5 hash collision!"), path) << endmsg;
4393 /** Return true if there are no audio file sources that use @param name as
4394 * the filename component of their path.
4396 * Return false otherwise.
4398 * This method MUST ONLY be used to check in-session, mono files since it
4399 * hard-codes the channel of the audio file source we are looking for as zero.
4401 * If/when Ardour supports native files in non-mono formats, the logic here
4402 * will need to be revisited.
4405 Session::audio_source_name_is_unique (const string& name)
4407 std::vector<string> sdirs = source_search_path (DataType::AUDIO);
4408 vector<space_and_path>::iterator i;
4409 uint32_t existing = 0;
4411 for (vector<string>::const_iterator i = sdirs.begin(); i != sdirs.end(); ++i) {
4413 /* note that we search *without* the extension so that
4414 we don't end up both "Audio 1-1.wav" and "Audio 1-1.caf"
4415 in the event that this new name is required for
4416 a file format change.
4419 const string spath = *i;
4421 if (matching_unsuffixed_filename_exists_in (spath, name)) {
4426 /* it is possible that we have the path already
4427 * assigned to a source that has not yet been written
4428 * (ie. the write source for a diskstream). we have to
4429 * check this in order to make sure that our candidate
4430 * path isn't used again, because that can lead to
4431 * two Sources point to the same file with different
4432 * notions of their removability.
4436 string possible_path = Glib::build_filename (spath, name);
4438 if (audio_source_by_path_and_channel (possible_path, 0)) {
4444 return (existing == 0);
4448 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)
4451 const string ext = native_header_format_extension (config.get_native_file_header_format(), DataType::AUDIO);
4453 if (Profile->get_trx() && destructive) {
4455 sstr << setfill ('0') << setw (4) << cnt;
4456 sstr << legalized_base;
4458 sstr << legalized_base;
4460 if (take_required || related_exists) {
4472 } else if (nchan > 2) {
4477 /* XXX what? more than 26 channels! */
4488 /** Return a unique name based on \a base for a new internal audio source */
4490 Session::new_audio_source_path (const string& base, uint32_t nchan, uint32_t chan, bool destructive, bool take_required)
4493 string possible_name;
4494 const uint32_t limit = 9999; // arbitrary limit on number of files with the same basic name
4496 bool some_related_source_name_exists = false;
4498 legalized = legalize_for_path (base);
4500 // Find a "version" of the base name that doesn't exist in any of the possible directories.
4502 for (cnt = (destructive ? ++destructive_index : 1); cnt <= limit; ++cnt) {
4504 possible_name = format_audio_source_name (legalized, nchan, chan, destructive, take_required, cnt, some_related_source_name_exists);
4506 if (audio_source_name_is_unique (possible_name)) {
4510 some_related_source_name_exists = true;
4513 error << string_compose(
4514 _("There are already %1 recordings for %2, which I consider too many."),
4515 limit, base) << endmsg;
4517 throw failed_constructor();
4521 /* We've established that the new name does not exist in any session
4522 * directory, so now find out which one we should use for this new
4526 SessionDirectory sdir (get_best_session_directory_for_new_audio());
4528 std::string s = Glib::build_filename (sdir.sound_path(), possible_name);
4533 /** Return a unique name based on `base` for a new internal MIDI source */
4535 Session::new_midi_source_path (const string& base)
4538 char buf[PATH_MAX+1];
4539 const uint32_t limit = 10000;
4541 string possible_path;
4542 string possible_name;
4545 legalized = legalize_for_path (base);
4547 // Find a "version" of the file name that doesn't exist in any of the possible directories.
4548 std::vector<string> sdirs = source_search_path(DataType::MIDI);
4550 /* - the main session folder is the first in the vector.
4551 * - after checking all locations for file-name uniqueness,
4552 * we keep the one from the last iteration as new file name
4553 * - midi files are small and should just be kept in the main session-folder
4555 * -> reverse the array, check main session folder last and use that as location
4558 std::reverse(sdirs.begin(), sdirs.end());
4560 for (cnt = 1; cnt <= limit; ++cnt) {
4562 vector<space_and_path>::iterator i;
4563 uint32_t existing = 0;
4565 for (vector<string>::const_iterator i = sdirs.begin(); i != sdirs.end(); ++i) {
4567 snprintf (buf, sizeof(buf), "%s-%u.mid", legalized.c_str(), cnt);
4568 possible_name = buf;
4570 possible_path = Glib::build_filename (*i, possible_name);
4572 if (Glib::file_test (possible_path, Glib::FILE_TEST_EXISTS)) {
4576 if (midi_source_by_path (possible_path)) {
4581 if (existing == 0) {
4586 error << string_compose(
4587 _("There are already %1 recordings for %2, which I consider too many."),
4588 limit, base) << endmsg;
4594 /* No need to "find best location" for software/app-based RAID, because
4595 MIDI is so small that we always put it in the same place.
4598 return possible_path;
4602 /** Create a new within-session audio source */
4603 boost::shared_ptr<AudioFileSource>
4604 Session::create_audio_source_for_session (size_t n_chans, string const & base, uint32_t chan, bool destructive)
4606 const string path = new_audio_source_path (base, n_chans, chan, destructive, true);
4608 if (!path.empty()) {
4609 return boost::dynamic_pointer_cast<AudioFileSource> (
4610 SourceFactory::createWritable (DataType::AUDIO, *this, path, destructive, frame_rate(), true, true));
4612 throw failed_constructor ();
4616 /** Create a new within-session MIDI source */
4617 boost::shared_ptr<MidiSource>
4618 Session::create_midi_source_for_session (string const & basic_name)
4620 const string path = new_midi_source_path (basic_name);
4622 if (!path.empty()) {
4623 return boost::dynamic_pointer_cast<SMFSource> (
4624 SourceFactory::createWritable (
4625 DataType::MIDI, *this, path, false, frame_rate()));
4627 throw failed_constructor ();
4631 /** Create a new within-session MIDI source */
4632 boost::shared_ptr<MidiSource>
4633 Session::create_midi_source_by_stealing_name (boost::shared_ptr<Track> track)
4635 /* the caller passes in the track the source will be used in,
4636 so that we can keep the numbering sane.
4638 Rationale: a track with the name "Foo" that has had N
4639 captures carried out so far will ALREADY have a write source
4640 named "Foo-N+1.mid" waiting to be used for the next capture.
4642 If we call new_midi_source_name() we will get "Foo-N+2". But
4643 there is no region corresponding to "Foo-N+1", so when
4644 "Foo-N+2" appears in the track, the gap presents the user
4645 with odd behaviour - why did it skip past Foo-N+1?
4647 We could explain this to the user in some odd way, but
4648 instead we rename "Foo-N+1.mid" as "Foo-N+2.mid", and then
4651 If that attempted rename fails, we get "Foo-N+2.mid" anyway.
4654 boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (track);
4656 std::string name = track->steal_write_source_name ();
4659 return boost::shared_ptr<MidiSource>();
4662 /* MIDI files are small, just put them in the first location of the
4663 session source search path.
4666 const string path = Glib::build_filename (source_search_path (DataType::MIDI).front(), name);
4668 return boost::dynamic_pointer_cast<SMFSource> (
4669 SourceFactory::createWritable (
4670 DataType::MIDI, *this, path, false, frame_rate()));
4675 Session::add_playlist (boost::shared_ptr<Playlist> playlist, bool unused)
4677 if (playlist->hidden()) {
4681 playlists->add (playlist);
4684 playlist->release();
4691 Session::remove_playlist (boost::weak_ptr<Playlist> weak_playlist)
4693 if (_state_of_the_state & Deletion) {
4697 boost::shared_ptr<Playlist> playlist (weak_playlist.lock());
4703 playlists->remove (playlist);
4709 Session::set_audition (boost::shared_ptr<Region> r)
4711 pending_audition_region = r;
4712 add_post_transport_work (PostTransportAudition);
4713 _butler->schedule_transport_work ();
4717 Session::audition_playlist ()
4719 SessionEvent* ev = new SessionEvent (SessionEvent::Audition, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
4720 ev->region.reset ();
4725 Session::non_realtime_set_audition ()
4727 assert (pending_audition_region);
4728 auditioner->audition_region (pending_audition_region);
4729 pending_audition_region.reset ();
4730 AuditionActive (true); /* EMIT SIGNAL */
4734 Session::audition_region (boost::shared_ptr<Region> r)
4736 SessionEvent* ev = new SessionEvent (SessionEvent::Audition, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
4742 Session::cancel_audition ()
4747 if (auditioner->auditioning()) {
4748 auditioner->cancel_audition ();
4749 AuditionActive (false); /* EMIT SIGNAL */
4754 Session::RoutePublicOrderSorter::operator() (boost::shared_ptr<Route> a, boost::shared_ptr<Route> b)
4756 if (a->is_monitor()) {
4759 if (b->is_monitor()) {
4762 return a->order_key () < b->order_key ();
4766 Session::is_auditioning () const
4768 /* can be called before we have an auditioner object */
4770 return auditioner->auditioning();
4777 Session::graph_reordered ()
4779 /* don't do this stuff if we are setting up connections
4780 from a set_state() call or creating new tracks. Ditto for deletion.
4783 if ((_state_of_the_state & (InitialConnecting|Deletion)) || _adding_routes_in_progress || _reconnecting_routes_in_progress || _route_deletion_in_progress) {
4787 /* every track/bus asked for this to be handled but it was deferred because
4788 we were connecting. do it now.
4791 request_input_change_handling ();
4795 /* force all diskstreams to update their capture offset values to
4796 reflect any changes in latencies within the graph.
4799 boost::shared_ptr<RouteList> rl = routes.reader ();
4800 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
4801 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
4803 tr->set_capture_offset ();
4808 /** @return Number of frames that there is disk space available to write,
4811 boost::optional<framecnt_t>
4812 Session::available_capture_duration ()
4814 Glib::Threads::Mutex::Lock lm (space_lock);
4816 if (_total_free_4k_blocks_uncertain) {
4817 return boost::optional<framecnt_t> ();
4820 float sample_bytes_on_disk = 4.0; // keep gcc happy
4822 switch (config.get_native_file_data_format()) {
4824 sample_bytes_on_disk = 4.0;
4828 sample_bytes_on_disk = 3.0;
4832 sample_bytes_on_disk = 2.0;
4836 /* impossible, but keep some gcc versions happy */
4837 fatal << string_compose (_("programming error: %1"),
4838 X_("illegal native file data format"))
4840 abort(); /*NOTREACHED*/
4843 double scale = 4096.0 / sample_bytes_on_disk;
4845 if (_total_free_4k_blocks * scale > (double) max_framecnt) {
4846 return max_framecnt;
4849 return (framecnt_t) floor (_total_free_4k_blocks * scale);
4853 Session::add_bundle (boost::shared_ptr<Bundle> bundle, bool emit_signal)
4856 RCUWriter<BundleList> writer (_bundles);
4857 boost::shared_ptr<BundleList> b = writer.get_copy ();
4858 b->push_back (bundle);
4862 BundleAddedOrRemoved (); /* EMIT SIGNAL */
4869 Session::remove_bundle (boost::shared_ptr<Bundle> bundle)
4871 bool removed = false;
4874 RCUWriter<BundleList> writer (_bundles);
4875 boost::shared_ptr<BundleList> b = writer.get_copy ();
4876 BundleList::iterator i = find (b->begin(), b->end(), bundle);
4878 if (i != b->end()) {
4885 BundleAddedOrRemoved (); /* EMIT SIGNAL */
4891 boost::shared_ptr<Bundle>
4892 Session::bundle_by_name (string name) const
4894 boost::shared_ptr<BundleList> b = _bundles.reader ();
4896 for (BundleList::const_iterator i = b->begin(); i != b->end(); ++i) {
4897 if ((*i)->name() == name) {
4902 return boost::shared_ptr<Bundle> ();
4906 Session::tempo_map_changed (const PropertyChange&)
4910 playlists->update_after_tempo_map_change ();
4912 _locations->apply (*this, &Session::update_locations_after_tempo_map_change);
4918 Session::update_locations_after_tempo_map_change (const Locations::LocationList& loc)
4920 for (Locations::LocationList::const_iterator i = loc.begin(); i != loc.end(); ++i) {
4921 (*i)->recompute_frames_from_bbt ();
4925 /** Ensures that all buffers (scratch, send, silent, etc) are allocated for
4926 * the given count with the current block size.
4929 Session::ensure_buffers (ChanCount howmany)
4931 BufferManager::ensure_buffers (howmany, bounce_processing() ? bounce_chunk_size : 0);
4935 Session::ensure_buffer_set(BufferSet& buffers, const ChanCount& count)
4937 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
4938 buffers.ensure_buffers(*t, count.get(*t), _engine.raw_buffer_size(*t));
4943 Session::next_insert_id ()
4945 /* this doesn't really loop forever. just think about it */
4948 for (boost::dynamic_bitset<uint32_t>::size_type n = 0; n < insert_bitset.size(); ++n) {
4949 if (!insert_bitset[n]) {
4950 insert_bitset[n] = true;
4956 /* none available, so resize and try again */
4958 insert_bitset.resize (insert_bitset.size() + 16, false);
4963 Session::next_send_id ()
4965 /* this doesn't really loop forever. just think about it */
4968 for (boost::dynamic_bitset<uint32_t>::size_type n = 0; n < send_bitset.size(); ++n) {
4969 if (!send_bitset[n]) {
4970 send_bitset[n] = true;
4976 /* none available, so resize and try again */
4978 send_bitset.resize (send_bitset.size() + 16, false);
4983 Session::next_aux_send_id ()
4985 /* this doesn't really loop forever. just think about it */
4988 for (boost::dynamic_bitset<uint32_t>::size_type n = 0; n < aux_send_bitset.size(); ++n) {
4989 if (!aux_send_bitset[n]) {
4990 aux_send_bitset[n] = true;
4996 /* none available, so resize and try again */
4998 aux_send_bitset.resize (aux_send_bitset.size() + 16, false);
5003 Session::next_return_id ()
5005 /* this doesn't really loop forever. just think about it */
5008 for (boost::dynamic_bitset<uint32_t>::size_type n = 0; n < return_bitset.size(); ++n) {
5009 if (!return_bitset[n]) {
5010 return_bitset[n] = true;
5016 /* none available, so resize and try again */
5018 return_bitset.resize (return_bitset.size() + 16, false);
5023 Session::mark_send_id (uint32_t id)
5025 if (id >= send_bitset.size()) {
5026 send_bitset.resize (id+16, false);
5028 if (send_bitset[id]) {
5029 warning << string_compose (_("send ID %1 appears to be in use already"), id) << endmsg;
5031 send_bitset[id] = true;
5035 Session::mark_aux_send_id (uint32_t id)
5037 if (id >= aux_send_bitset.size()) {
5038 aux_send_bitset.resize (id+16, false);
5040 if (aux_send_bitset[id]) {
5041 warning << string_compose (_("aux send ID %1 appears to be in use already"), id) << endmsg;
5043 aux_send_bitset[id] = true;
5047 Session::mark_return_id (uint32_t id)
5049 if (id >= return_bitset.size()) {
5050 return_bitset.resize (id+16, false);
5052 if (return_bitset[id]) {
5053 warning << string_compose (_("return ID %1 appears to be in use already"), id) << endmsg;
5055 return_bitset[id] = true;
5059 Session::mark_insert_id (uint32_t id)
5061 if (id >= insert_bitset.size()) {
5062 insert_bitset.resize (id+16, false);
5064 if (insert_bitset[id]) {
5065 warning << string_compose (_("insert ID %1 appears to be in use already"), id) << endmsg;
5067 insert_bitset[id] = true;
5071 Session::unmark_send_id (uint32_t id)
5073 if (id < send_bitset.size()) {
5074 send_bitset[id] = false;
5079 Session::unmark_aux_send_id (uint32_t id)
5081 if (id < aux_send_bitset.size()) {
5082 aux_send_bitset[id] = false;
5087 Session::unmark_return_id (uint32_t id)
5089 if (id < return_bitset.size()) {
5090 return_bitset[id] = false;
5095 Session::unmark_insert_id (uint32_t id)
5097 if (id < insert_bitset.size()) {
5098 insert_bitset[id] = false;
5103 Session::reset_native_file_format ()
5105 boost::shared_ptr<RouteList> rl = routes.reader ();
5107 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
5108 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
5110 /* don't save state as we do this, there's no point
5112 _state_of_the_state = StateOfTheState (_state_of_the_state|InCleanup);
5113 tr->reset_write_sources (false);
5114 _state_of_the_state = StateOfTheState (_state_of_the_state & ~InCleanup);
5120 Session::route_name_unique (string n) const
5122 boost::shared_ptr<RouteList> r = routes.reader ();
5124 for (RouteList::const_iterator i = r->begin(); i != r->end(); ++i) {
5125 if ((*i)->name() == n) {
5134 Session::route_name_internal (string n) const
5136 if (auditioner && auditioner->name() == n) {
5140 if (_click_io && _click_io->name() == n) {
5148 Session::freeze_all (InterThreadInfo& itt)
5150 boost::shared_ptr<RouteList> r = routes.reader ();
5152 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
5154 boost::shared_ptr<Track> t;
5156 if ((t = boost::dynamic_pointer_cast<Track>(*i)) != 0) {
5157 /* XXX this is wrong because itt.progress will keep returning to zero at the start
5167 boost::shared_ptr<Region>
5168 Session::write_one_track (Track& track, framepos_t start, framepos_t end,
5169 bool /*overwrite*/, vector<boost::shared_ptr<Source> >& srcs,
5170 InterThreadInfo& itt,
5171 boost::shared_ptr<Processor> endpoint, bool include_endpoint,
5172 bool for_export, bool for_freeze)
5174 boost::shared_ptr<Region> result;
5175 boost::shared_ptr<Playlist> playlist;
5176 boost::shared_ptr<Source> source;
5177 ChanCount diskstream_channels (track.n_channels());
5178 framepos_t position;
5179 framecnt_t this_chunk;
5181 framepos_t latency_skip;
5183 framepos_t len = end - start;
5184 bool need_block_size_reset = false;
5185 ChanCount const max_proc = track.max_processor_streams ();
5186 string legal_playlist_name;
5187 string possible_path;
5190 error << string_compose (_("Cannot write a range where end <= start (e.g. %1 <= %2)"),
5191 end, start) << endmsg;
5195 diskstream_channels = track.bounce_get_output_streams (diskstream_channels, endpoint,
5196 include_endpoint, for_export, for_freeze);
5198 if (diskstream_channels.n(track.data_type()) < 1) {
5199 error << _("Cannot write a range with no data.") << endmsg;
5203 // block all process callback handling
5205 block_processing ();
5208 // synchronize with AudioEngine::process_callback()
5209 // make sure processing is not currently running
5210 // and processing_blocked() is honored before
5211 // acquiring thread buffers
5212 Glib::Threads::Mutex::Lock lm (_engine.process_lock());
5215 _bounce_processing_active = true;
5217 /* call tree *MUST* hold route_lock */
5219 if ((playlist = track.playlist()) == 0) {
5223 legal_playlist_name = legalize_for_path (playlist->name());
5225 for (uint32_t chan_n = 0; chan_n < diskstream_channels.n(track.data_type()); ++chan_n) {
5227 string base_name = string_compose ("%1-%2-bounce", playlist->name(), chan_n);
5228 string path = ((track.data_type() == DataType::AUDIO)
5229 ? new_audio_source_path (legal_playlist_name, diskstream_channels.n_audio(), chan_n, false, true)
5230 : new_midi_source_path (legal_playlist_name));
5237 source = SourceFactory::createWritable (track.data_type(), *this, path, false, frame_rate());
5240 catch (failed_constructor& err) {
5241 error << string_compose (_("cannot create new file \"%1\" for %2"), path, track.name()) << endmsg;
5245 srcs.push_back (source);
5248 /* tell redirects that care that we are about to use a much larger
5249 * blocksize. this will flush all plugins too, so that they are ready
5250 * to be used for this process.
5253 need_block_size_reset = true;
5254 track.set_block_size (bounce_chunk_size);
5255 _engine.main_thread()->get_buffers ();
5259 latency_skip = track.bounce_get_latency (endpoint, include_endpoint, for_export, for_freeze);
5261 /* create a set of reasonably-sized buffers */
5262 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
5263 buffers.ensure_buffers(*t, max_proc.get(*t), bounce_chunk_size);
5265 buffers.set_count (max_proc);
5267 for (vector<boost::shared_ptr<Source> >::iterator src = srcs.begin(); src != srcs.end(); ++src) {
5268 boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*src);
5269 boost::shared_ptr<MidiSource> ms;
5271 afs->prepare_for_peakfile_writes ();
5272 } else if ((ms = boost::dynamic_pointer_cast<MidiSource>(*src))) {
5273 Source::Lock lock(ms->mutex());
5274 ms->mark_streaming_write_started(lock);
5278 while (to_do && !itt.cancel) {
5280 this_chunk = min (to_do, bounce_chunk_size);
5282 if (track.export_stuff (buffers, start, this_chunk, endpoint, include_endpoint, for_export, for_freeze)) {
5286 start += this_chunk;
5287 to_do -= this_chunk;
5288 itt.progress = (float) (1.0 - ((double) to_do / len));
5290 if (latency_skip >= bounce_chunk_size) {
5291 latency_skip -= bounce_chunk_size;
5295 const framecnt_t current_chunk = this_chunk - latency_skip;
5298 for (vector<boost::shared_ptr<Source> >::iterator src=srcs.begin(); src != srcs.end(); ++src, ++n) {
5299 boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*src);
5300 boost::shared_ptr<MidiSource> ms;
5303 if (afs->write (buffers.get_audio(n).data(latency_skip), current_chunk) != current_chunk) {
5306 } else if ((ms = boost::dynamic_pointer_cast<MidiSource>(*src))) {
5307 Source::Lock lock(ms->mutex());
5309 const MidiBuffer& buf = buffers.get_midi(0);
5310 for (MidiBuffer::const_iterator i = buf.begin(); i != buf.end(); ++i) {
5311 Evoral::Event<framepos_t> ev = *i;
5312 ev.set_time(ev.time() - position);
5313 ms->append_event_frames(lock, ev, ms->timeline_position());
5320 /* post-roll, pick up delayed processor output */
5321 latency_skip = track.bounce_get_latency (endpoint, include_endpoint, for_export, for_freeze);
5323 while (latency_skip && !itt.cancel) {
5324 this_chunk = min (latency_skip, bounce_chunk_size);
5325 latency_skip -= this_chunk;
5327 buffers.silence (this_chunk, 0);
5328 track.bounce_process (buffers, start, this_chunk, endpoint, include_endpoint, for_export, for_freeze);
5331 for (vector<boost::shared_ptr<Source> >::iterator src=srcs.begin(); src != srcs.end(); ++src, ++n) {
5332 boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*src);
5335 if (afs->write (buffers.get_audio(n).data(), this_chunk) != this_chunk) {
5347 xnow = localtime (&now);
5349 for (vector<boost::shared_ptr<Source> >::iterator src=srcs.begin(); src != srcs.end(); ++src) {
5350 boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*src);
5351 boost::shared_ptr<MidiSource> ms;
5354 afs->update_header (position, *xnow, now);
5355 afs->flush_header ();
5356 } else if ((ms = boost::dynamic_pointer_cast<MidiSource>(*src))) {
5357 Source::Lock lock(ms->mutex());
5358 ms->mark_streaming_write_completed(lock);
5362 /* construct a region to represent the bounced material */
5366 plist.add (Properties::start, 0);
5367 plist.add (Properties::length, srcs.front()->length(srcs.front()->timeline_position()));
5368 plist.add (Properties::name, region_name_from_path (srcs.front()->name(), true));
5370 result = RegionFactory::create (srcs, plist);
5376 for (vector<boost::shared_ptr<Source> >::iterator src = srcs.begin(); src != srcs.end(); ++src) {
5377 (*src)->mark_for_remove ();
5378 (*src)->drop_references ();
5382 for (vector<boost::shared_ptr<Source> >::iterator src = srcs.begin(); src != srcs.end(); ++src) {
5383 boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*src);
5386 afs->done_with_peakfile_writes ();
5390 _bounce_processing_active = false;
5392 if (need_block_size_reset) {
5393 _engine.main_thread()->drop_buffers ();
5394 track.set_block_size (get_block_size());
5397 unblock_processing ();
5403 Session::gain_automation_buffer() const
5405 return ProcessThread::gain_automation_buffer ();
5409 Session::trim_automation_buffer() const
5411 return ProcessThread::trim_automation_buffer ();
5415 Session::send_gain_automation_buffer() const
5417 return ProcessThread::send_gain_automation_buffer ();
5421 Session::pan_automation_buffer() const
5423 return ProcessThread::pan_automation_buffer ();
5427 Session::get_silent_buffers (ChanCount count)
5429 return ProcessThread::get_silent_buffers (count);
5433 Session::get_scratch_buffers (ChanCount count, bool silence)
5435 return ProcessThread::get_scratch_buffers (count, silence);
5439 Session::get_route_buffers (ChanCount count, bool silence)
5441 return ProcessThread::get_route_buffers (count, silence);
5446 Session::get_mix_buffers (ChanCount count)
5448 return ProcessThread::get_mix_buffers (count);
5452 Session::ntracks () const
5455 boost::shared_ptr<RouteList> r = routes.reader ();
5457 for (RouteList::const_iterator i = r->begin(); i != r->end(); ++i) {
5458 if (boost::dynamic_pointer_cast<Track> (*i)) {
5467 Session::nbusses () const
5470 boost::shared_ptr<RouteList> r = routes.reader ();
5472 for (RouteList::const_iterator i = r->begin(); i != r->end(); ++i) {
5473 if (boost::dynamic_pointer_cast<Track>(*i) == 0) {
5482 Session::add_automation_list(AutomationList *al)
5484 automation_lists[al->id()] = al;
5487 /** @return true if there is at least one record-enabled track, otherwise false */
5489 Session::have_rec_enabled_track () const
5491 return g_atomic_int_get (const_cast<gint*>(&_have_rec_enabled_track)) == 1;
5495 Session::have_rec_disabled_track () const
5497 return g_atomic_int_get (const_cast<gint*>(&_have_rec_disabled_track)) == 1;
5500 /** Update the state of our rec-enabled tracks flag */
5502 Session::update_route_record_state ()
5504 boost::shared_ptr<RouteList> rl = routes.reader ();
5505 RouteList::iterator i = rl->begin();
5506 while (i != rl->end ()) {
5508 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
5509 if (tr && tr->record_enabled ()) {
5516 int const old = g_atomic_int_get (&_have_rec_enabled_track);
5518 g_atomic_int_set (&_have_rec_enabled_track, i != rl->end () ? 1 : 0);
5520 if (g_atomic_int_get (&_have_rec_enabled_track) != old) {
5521 RecordStateChanged (); /* EMIT SIGNAL */
5524 for (i = rl->begin(); i != rl->end (); ++i) {
5525 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
5526 if (tr && !tr->record_enabled ()) {
5531 g_atomic_int_set (&_have_rec_disabled_track, i != rl->end () ? 1 : 0);
5533 bool record_arm_state_changed = (old != g_atomic_int_get (&_have_rec_enabled_track) );
5535 if (record_status() == Recording && record_arm_state_changed ) {
5536 RecordArmStateChanged ();
5542 Session::listen_position_changed ()
5544 boost::shared_ptr<RouteList> r = routes.reader ();
5546 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
5547 (*i)->listen_position_changed ();
5552 Session::solo_control_mode_changed ()
5554 /* cancel all solo or all listen when solo control mode changes */
5557 set_solo (get_routes(), false);
5558 } else if (listening()) {
5559 set_listen (get_routes(), false);
5563 /** Called when a property of one of our route groups changes */
5565 Session::route_group_property_changed (RouteGroup* rg)
5567 RouteGroupPropertyChanged (rg); /* EMIT SIGNAL */
5570 /** Called when a route is added to one of our route groups */
5572 Session::route_added_to_route_group (RouteGroup* rg, boost::weak_ptr<Route> r)
5574 RouteAddedToRouteGroup (rg, r);
5577 /** Called when a route is removed from one of our route groups */
5579 Session::route_removed_from_route_group (RouteGroup* rg, boost::weak_ptr<Route> r)
5581 update_route_record_state ();
5582 RouteRemovedFromRouteGroup (rg, r); /* EMIT SIGNAL */
5585 boost::shared_ptr<RouteList>
5586 Session::get_tracks () const
5588 boost::shared_ptr<RouteList> rl = routes.reader ();
5589 boost::shared_ptr<RouteList> tl (new RouteList);
5591 for (RouteList::const_iterator r = rl->begin(); r != rl->end(); ++r) {
5592 if (boost::dynamic_pointer_cast<Track> (*r)) {
5593 if (!(*r)->is_auditioner()) {
5601 boost::shared_ptr<RouteList>
5602 Session::get_routes_with_regions_at (framepos_t const p) const
5604 boost::shared_ptr<RouteList> r = routes.reader ();
5605 boost::shared_ptr<RouteList> rl (new RouteList);
5607 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
5608 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
5613 boost::shared_ptr<Playlist> pl = tr->playlist ();
5618 if (pl->has_region_at (p)) {
5627 Session::goto_end ()
5629 if (_session_range_location) {
5630 request_locate (_session_range_location->end(), false);
5632 request_locate (0, false);
5637 Session::goto_start ()
5639 if (_session_range_location) {
5640 request_locate (_session_range_location->start(), false);
5642 request_locate (0, false);
5647 Session::current_start_frame () const
5649 return _session_range_location ? _session_range_location->start() : 0;
5653 Session::current_end_frame () const
5655 return _session_range_location ? _session_range_location->end() : 0;
5659 Session::set_session_range_location (framepos_t start, framepos_t end)
5661 _session_range_location = new Location (*this, start, end, _("session"), Location::IsSessionRange);
5662 _locations->add (_session_range_location);
5666 Session::step_edit_status_change (bool yn)
5672 send = (_step_editors == 0);
5677 send = (_step_editors == 1);
5680 if (_step_editors > 0) {
5686 StepEditStatusChange (val);
5692 Session::start_time_changed (framepos_t old)
5694 /* Update the auto loop range to match the session range
5695 (unless the auto loop range has been changed by the user)
5698 Location* s = _locations->session_range_location ();
5703 Location* l = _locations->auto_loop_location ();
5705 if (l && l->start() == old) {
5706 l->set_start (s->start(), true);
5711 Session::end_time_changed (framepos_t old)
5713 /* Update the auto loop range to match the session range
5714 (unless the auto loop range has been changed by the user)
5717 Location* s = _locations->session_range_location ();
5722 Location* l = _locations->auto_loop_location ();
5724 if (l && l->end() == old) {
5725 l->set_end (s->end(), true);
5729 std::vector<std::string>
5730 Session::source_search_path (DataType type) const
5734 if (session_dirs.size() == 1) {
5736 case DataType::AUDIO:
5737 sp.push_back (_session_dir->sound_path());
5739 case DataType::MIDI:
5740 sp.push_back (_session_dir->midi_path());
5744 for (vector<space_and_path>::const_iterator i = session_dirs.begin(); i != session_dirs.end(); ++i) {
5745 SessionDirectory sdir (i->path);
5747 case DataType::AUDIO:
5748 sp.push_back (sdir.sound_path());
5750 case DataType::MIDI:
5751 sp.push_back (sdir.midi_path());
5757 if (type == DataType::AUDIO) {
5758 const string sound_path_2X = _session_dir->sound_path_2X();
5759 if (Glib::file_test (sound_path_2X, Glib::FILE_TEST_EXISTS|Glib::FILE_TEST_IS_DIR)) {
5760 if (find (sp.begin(), sp.end(), sound_path_2X) == sp.end()) {
5761 sp.push_back (sound_path_2X);
5766 // now check the explicit (possibly user-specified) search path
5769 case DataType::AUDIO:
5770 sp += Searchpath(config.get_audio_search_path ());
5772 case DataType::MIDI:
5773 sp += Searchpath(config.get_midi_search_path ());
5781 Session::ensure_search_path_includes (const string& path, DataType type)
5790 case DataType::AUDIO:
5791 sp += Searchpath(config.get_audio_search_path ());
5793 case DataType::MIDI:
5794 sp += Searchpath (config.get_midi_search_path ());
5798 for (vector<std::string>::iterator i = sp.begin(); i != sp.end(); ++i) {
5799 /* No need to add this new directory if it has the same inode as
5800 an existing one; checking inode rather than name prevents duplicated
5801 directories when we are using symlinks.
5803 On Windows, I think we could just do if (*i == path) here.
5805 if (PBD::equivalent_paths (*i, path)) {
5813 case DataType::AUDIO:
5814 config.set_audio_search_path (sp.to_string());
5816 case DataType::MIDI:
5817 config.set_midi_search_path (sp.to_string());
5823 Session::remove_dir_from_search_path (const string& dir, DataType type)
5828 case DataType::AUDIO:
5829 sp = Searchpath(config.get_audio_search_path ());
5831 case DataType::MIDI:
5832 sp = Searchpath (config.get_midi_search_path ());
5839 case DataType::AUDIO:
5840 config.set_audio_search_path (sp.to_string());
5842 case DataType::MIDI:
5843 config.set_midi_search_path (sp.to_string());
5849 boost::shared_ptr<Speakers>
5850 Session::get_speakers()
5856 Session::unknown_processors () const
5860 boost::shared_ptr<RouteList> r = routes.reader ();
5861 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
5862 list<string> t = (*i)->unknown_processors ();
5863 copy (t.begin(), t.end(), back_inserter (p));
5873 Session::update_latency (bool playback)
5875 DEBUG_TRACE (DEBUG::Latency, string_compose ("JACK latency callback: %1\n", (playback ? "PLAYBACK" : "CAPTURE")));
5877 if ((_state_of_the_state & (InitialConnecting|Deletion)) || _adding_routes_in_progress) {
5881 boost::shared_ptr<RouteList> r = routes.reader ();
5882 framecnt_t max_latency = 0;
5885 /* reverse the list so that we work backwards from the last route to run to the first */
5886 RouteList* rl = routes.reader().get();
5887 r.reset (new RouteList (*rl));
5888 reverse (r->begin(), r->end());
5891 /* compute actual latency values for the given direction and store them all in per-port
5892 structures. this will also publish the same values (to JACK) so that computation of latency
5893 for routes can consistently use public latency values.
5896 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
5897 max_latency = max (max_latency, (*i)->set_private_port_latencies (playback));
5900 /* because we latency compensate playback, our published playback latencies should
5901 be the same for all output ports - all material played back by ardour has
5902 the same latency, whether its caused by plugins or by latency compensation. since
5903 these may differ from the values computed above, reset all playback port latencies
5907 DEBUG_TRACE (DEBUG::Latency, string_compose ("Set public port latencies to %1\n", max_latency));
5909 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
5910 (*i)->set_public_port_latencies (max_latency, playback);
5915 post_playback_latency ();
5919 post_capture_latency ();
5922 DEBUG_TRACE (DEBUG::Latency, "JACK latency callback: DONE\n");
5926 Session::post_playback_latency ()
5928 set_worst_playback_latency ();
5930 boost::shared_ptr<RouteList> r = routes.reader ();
5932 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
5933 if (!(*i)->is_auditioner() && ((*i)->active())) {
5934 _worst_track_latency = max (_worst_track_latency, (*i)->update_signal_latency ());
5938 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
5939 (*i)->set_latency_compensation (_worst_track_latency);
5944 Session::post_capture_latency ()
5946 set_worst_capture_latency ();
5948 /* reflect any changes in capture latencies into capture offsets
5951 boost::shared_ptr<RouteList> rl = routes.reader();
5952 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
5953 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
5955 tr->set_capture_offset ();
5961 Session::initialize_latencies ()
5964 Glib::Threads::Mutex::Lock lm (_engine.process_lock());
5965 update_latency (false);
5966 update_latency (true);
5969 set_worst_io_latencies ();
5973 Session::set_worst_io_latencies ()
5975 set_worst_playback_latency ();
5976 set_worst_capture_latency ();
5980 Session::set_worst_playback_latency ()
5982 if (_state_of_the_state & (InitialConnecting|Deletion)) {
5986 _worst_output_latency = 0;
5988 if (!_engine.connected()) {
5992 boost::shared_ptr<RouteList> r = routes.reader ();
5994 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
5995 _worst_output_latency = max (_worst_output_latency, (*i)->output()->latency());
5998 DEBUG_TRACE (DEBUG::Latency, string_compose ("Worst output latency: %1\n", _worst_output_latency));
6002 Session::set_worst_capture_latency ()
6004 if (_state_of_the_state & (InitialConnecting|Deletion)) {
6008 _worst_input_latency = 0;
6010 if (!_engine.connected()) {
6014 boost::shared_ptr<RouteList> r = routes.reader ();
6016 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6017 _worst_input_latency = max (_worst_input_latency, (*i)->input()->latency());
6020 DEBUG_TRACE (DEBUG::Latency, string_compose ("Worst input latency: %1\n", _worst_input_latency));
6024 Session::update_latency_compensation (bool force_whole_graph)
6026 bool some_track_latency_changed = false;
6028 if (_state_of_the_state & (InitialConnecting|Deletion)) {
6032 DEBUG_TRACE(DEBUG::Latency, "---------------------------- update latency compensation\n\n");
6034 _worst_track_latency = 0;
6036 boost::shared_ptr<RouteList> r = routes.reader ();
6038 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6039 if (!(*i)->is_auditioner() && ((*i)->active())) {
6041 if ((*i)->signal_latency () != (tl = (*i)->update_signal_latency ())) {
6042 some_track_latency_changed = true;
6044 _worst_track_latency = max (tl, _worst_track_latency);
6048 DEBUG_TRACE (DEBUG::Latency, string_compose ("worst signal processing latency: %1 (changed ? %2)\n", _worst_track_latency,
6049 (some_track_latency_changed ? "yes" : "no")));
6051 DEBUG_TRACE(DEBUG::Latency, "---------------------------- DONE update latency compensation\n\n");
6053 if (some_track_latency_changed || force_whole_graph) {
6054 _engine.update_latencies ();
6058 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6059 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
6063 tr->set_capture_offset ();
6068 Session::session_name_is_legal (const string& path)
6070 char illegal_chars[] = { '/', '\\', ':', ';', '\0' };
6072 for (int i = 0; illegal_chars[i]; ++i) {
6073 if (path.find (illegal_chars[i]) != string::npos) {
6074 return illegal_chars[i];
6082 Session::next_control_id () const
6086 /* the monitor bus remote ID is in a different
6087 * "namespace" than regular routes. its existence doesn't
6088 * affect normal (low) numbered routes.
6095 /* the same about masterbus in Waves Tracks */
6097 if (Profile->get_trx() && _master_out) {
6101 return nroutes() - subtract;
6105 Session::notify_remote_id_change ()
6107 if (deletion_in_progress()) {
6111 switch (Config->get_remote_model()) {
6113 Route::RemoteControlIDChange (); /* EMIT SIGNAL */
6119 #ifdef USE_TRACKS_CODE_FEATURES
6120 /* Waves Tracks: for Waves Tracks session it's required to reconnect their IOs
6121 * if track order has been changed by user
6123 reconnect_existing_routes(true, true);
6129 Session::sync_order_keys ()
6131 if (deletion_in_progress()) {
6135 /* tell everyone that something has happened to the sort keys
6136 and let them sync up with the change(s)
6137 this will give objects that manage the sort order keys the
6138 opportunity to keep them in sync if they wish to.
6141 DEBUG_TRACE (DEBUG::OrderKeys, "Sync Order Keys.\n");
6143 reassign_track_numbers();
6145 Route::SyncOrderKeys (); /* EMIT SIGNAL */
6147 DEBUG_TRACE (DEBUG::OrderKeys, "\tsync done\n");
6151 Session::operation_in_progress (GQuark op) const
6153 return (find (_current_trans_quarks.begin(), _current_trans_quarks.end(), op) != _current_trans_quarks.end());
6156 boost::shared_ptr<Port>
6157 Session::ltc_input_port () const
6159 return _ltc_input->nth (0);
6162 boost::shared_ptr<Port>
6163 Session::ltc_output_port () const
6165 return _ltc_output->nth (0);
6169 Session::reconnect_ltc_input ()
6173 string src = Config->get_ltc_source_port();
6175 _ltc_input->disconnect (this);
6177 if (src != _("None") && !src.empty()) {
6178 _ltc_input->nth (0)->connect (src);
6181 if ( ARDOUR::Profile->get_trx () ) {
6182 // Tracks need this signal to update timecode_source_dropdown
6183 MtcOrLtcInputPortChanged (); //emit signal
6189 Session::reconnect_ltc_output ()
6193 string src = Config->get_ltc_output_port();
6195 _ltc_output->disconnect (this);
6197 if (src != _("None") && !src.empty()) {
6198 _ltc_output->nth (0)->connect (src);
6204 Session::set_range_selection (framepos_t start, framepos_t end)
6206 _range_selection = Evoral::Range<framepos_t> (start, end);
6207 #ifdef USE_TRACKS_CODE_FEATURES
6208 follow_playhead_priority ();
6213 Session::set_object_selection (framepos_t start, framepos_t end)
6215 _object_selection = Evoral::Range<framepos_t> (start, end);
6216 #ifdef USE_TRACKS_CODE_FEATURES
6217 follow_playhead_priority ();
6222 Session::clear_range_selection ()
6224 _range_selection = Evoral::Range<framepos_t> (-1,-1);
6225 #ifdef USE_TRACKS_CODE_FEATURES
6226 follow_playhead_priority ();
6231 Session::clear_object_selection ()
6233 _object_selection = Evoral::Range<framepos_t> (-1,-1);
6234 #ifdef USE_TRACKS_CODE_FEATURES
6235 follow_playhead_priority ();