2 Copyright (C) 1999-2010 Paul Davis
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
26 #include <cstdio> /* sprintf(3) ... grrr */
32 #include <glibmm/threads.h>
33 #include <glibmm/miscutils.h>
34 #include <glibmm/fileutils.h>
36 #include <boost/algorithm/string/erase.hpp>
38 #include "pbd/basename.h"
39 #include "pbd/boost_debug.h"
40 #include "pbd/convert.h"
41 #include "pbd/convert.h"
42 #include "pbd/error.h"
43 #include "pbd/file_utils.h"
45 #include "pbd/search_path.h"
46 #include "pbd/stacktrace.h"
47 #include "pbd/stl_delete.h"
48 #include "pbd/replace_all.h"
49 #include "pbd/unwind.h"
51 #include "ardour/amp.h"
52 #include "ardour/analyser.h"
53 #include "ardour/async_midi_port.h"
54 #include "ardour/audio_buffer.h"
55 #include "ardour/audio_diskstream.h"
56 #include "ardour/audio_port.h"
57 #include "ardour/audio_track.h"
58 #include "ardour/audioengine.h"
59 #include "ardour/audiofilesource.h"
60 #include "ardour/auditioner.h"
61 #include "ardour/buffer_manager.h"
62 #include "ardour/buffer_set.h"
63 #include "ardour/bundle.h"
64 #include "ardour/butler.h"
65 #include "ardour/click.h"
66 #include "ardour/control_protocol_manager.h"
67 #include "ardour/data_type.h"
68 #include "ardour/debug.h"
69 #include "ardour/directory_names.h"
70 #ifdef USE_TRACKS_CODE_FEATURES
71 #include "ardour/engine_state_controller.h"
73 #include "ardour/filename_extensions.h"
74 #include "ardour/gain_control.h"
75 #include "ardour/graph.h"
76 #include "ardour/midiport_manager.h"
77 #include "ardour/scene_changer.h"
78 #include "ardour/midi_patch_manager.h"
79 #include "ardour/midi_track.h"
80 #include "ardour/midi_ui.h"
81 #include "ardour/operations.h"
82 #include "ardour/playlist.h"
83 #include "ardour/plugin.h"
84 #include "ardour/plugin_insert.h"
85 #include "ardour/process_thread.h"
86 #include "ardour/profile.h"
87 #include "ardour/rc_configuration.h"
88 #include "ardour/recent_sessions.h"
89 #include "ardour/region.h"
90 #include "ardour/region_factory.h"
91 #include "ardour/route_graph.h"
92 #include "ardour/route_group.h"
93 #include "ardour/route_sorters.h"
94 #include "ardour/send.h"
95 #include "ardour/session.h"
96 #include "ardour/session_directory.h"
97 #include "ardour/session_playlists.h"
98 #include "ardour/smf_source.h"
99 #include "ardour/source_factory.h"
100 #include "ardour/speakers.h"
101 #include "ardour/tempo.h"
102 #include "ardour/track.h"
103 #include "ardour/user_bundle.h"
104 #include "ardour/utils.h"
106 #include "midi++/port.h"
107 #include "midi++/mmc.h"
111 #include <glibmm/checksum.h>
120 using namespace ARDOUR;
123 bool Session::_disable_all_loaded_plugins = false;
124 bool Session::_bypass_all_loaded_plugins = false;
126 PBD::Signal1<int,uint32_t> Session::AudioEngineSetupRequired;
127 PBD::Signal1<void,std::string> Session::Dialog;
128 PBD::Signal0<int> Session::AskAboutPendingState;
129 PBD::Signal2<int, framecnt_t, framecnt_t> Session::AskAboutSampleRateMismatch;
130 PBD::Signal0<void> Session::SendFeedback;
131 PBD::Signal3<int,Session*,std::string,DataType> Session::MissingFile;
133 PBD::Signal1<void, framepos_t> Session::StartTimeChanged;
134 PBD::Signal1<void, framepos_t> Session::EndTimeChanged;
135 PBD::Signal2<void,std::string, std::string> Session::Exported;
136 PBD::Signal1<int,boost::shared_ptr<Playlist> > Session::AskAboutPlaylistDeletion;
137 PBD::Signal0<void> Session::Quit;
138 PBD::Signal0<void> Session::FeedbackDetected;
139 PBD::Signal0<void> Session::SuccessfulGraphSort;
140 PBD::Signal2<void,std::string,std::string> Session::VersionMismatch;
142 const framecnt_t Session::bounce_chunk_size = 8192;
143 static void clean_up_session_event (SessionEvent* ev) { delete ev; }
144 const SessionEvent::RTeventCallback Session::rt_cleanup (clean_up_session_event);
146 // seconds should be added after the region exceeds end marker
147 #ifdef USE_TRACKS_CODE_FEATURES
148 const uint32_t Session::session_end_shift = 5;
150 const uint32_t Session::session_end_shift = 0;
153 /** @param snapshot_name Snapshot name, without .ardour suffix */
154 Session::Session (AudioEngine &eng,
155 const string& fullpath,
156 const string& snapshot_name,
157 BusProfile* bus_profile,
159 : playlists (new SessionPlaylists)
161 , process_function (&Session::process_with_events)
162 , _bounce_processing_active (false)
163 , waiting_for_sync_offset (false)
164 , _base_frame_rate (0)
165 , _current_frame_rate (0)
166 , _nominal_frame_rate (0)
167 , transport_sub_state (0)
168 , _record_status (Disabled)
169 , _transport_frame (0)
170 , _session_range_location (0)
173 , _transport_speed (0)
174 , _default_transport_speed (1.0)
175 , _last_transport_speed (0)
176 , _target_transport_speed (0.0)
177 , auto_play_legal (false)
178 , _last_slave_transport_frame (0)
179 , maximum_output_latency (0)
180 , _requested_return_frame (-1)
181 , current_block_size (0)
182 , _worst_output_latency (0)
183 , _worst_input_latency (0)
184 , _worst_track_latency (0)
185 , _have_captured (false)
186 , _non_soloed_outs_muted (false)
189 , _solo_isolated_cnt (0)
191 , _was_seamless (Config->get_seamless_loop ())
192 , _under_nsm_control (false)
194 , delta_accumulator_cnt (0)
195 , average_slave_delta (1800) // !!! why 1800 ???
197 , have_first_delta_accumulator (false)
198 , _slave_state (Stopped)
199 , _mtc_active (false)
200 , _ltc_active (false)
201 , post_export_sync (false)
202 , post_export_position (0)
204 , _export_started (false)
205 , _export_rolling (false)
206 , _pre_export_mmc_enabled (false)
207 , _name (snapshot_name)
209 , _send_qf_mtc (false)
210 , _pframes_since_last_mtc (0)
211 , session_midi_feedback (0)
213 , loop_changing (false)
215 , _session_dir (new SessionDirectory (fullpath))
216 , _current_snapshot_name (snapshot_name)
218 , state_was_pending (false)
219 , _state_of_the_state (StateOfTheState(CannotSave|InitialConnecting|Loading))
221 , _save_queued (false)
222 , _last_roll_location (0)
223 , _last_roll_or_reversal_location (0)
224 , _last_record_location (0)
225 , pending_locate_roll (false)
226 , pending_locate_frame (0)
227 , pending_locate_flush (false)
228 , pending_abort (false)
229 , pending_auto_loop (false)
230 , _butler (new Butler (*this))
231 , _post_transport_work (0)
232 , cumulative_rf_motion (0)
234 , _locations (new Locations (*this))
235 , _ignore_skips_updates (false)
236 , _rt_thread_active (false)
237 , _rt_emit_pending (false)
239 , outbound_mtc_timecode_frame (0)
240 , next_quarter_frame_to_send (-1)
241 , _frames_per_timecode_frame (0)
242 , _frames_per_hour (0)
243 , _timecode_frames_per_hour (0)
244 , last_timecode_valid (false)
245 , last_timecode_when (0)
246 , _send_timecode_update (false)
258 , ltc_timecode_offset (0)
259 , ltc_timecode_negative_offset (false)
260 , midi_control_ui (0)
262 , _all_route_group (new RouteGroup (*this, "all"))
263 , routes (new RouteList)
264 , _adding_routes_in_progress (false)
265 , _reconnecting_routes_in_progress (false)
266 , _route_deletion_in_progress (false)
267 , destructive_index (0)
268 , _track_number_decimals(1)
269 , default_fade_steepness (0)
270 , default_fade_msecs (0)
271 , _total_free_4k_blocks (0)
272 , _total_free_4k_blocks_uncertain (false)
273 , no_questions_about_missing_files (false)
276 , _bundles (new BundleList)
277 , _bundle_xml_node (0)
281 , click_emphasis_data (0)
283 , click_emphasis_length (0)
284 , _clicks_cleared (0)
285 , _play_range (false)
286 , _range_selection (-1,-1)
287 , _object_selection (-1,-1)
289 , first_file_data_format_reset (true)
290 , first_file_header_format_reset (true)
291 , have_looped (false)
292 , _have_rec_enabled_track (false)
293 , _have_rec_disabled_track (true)
295 , _suspend_timecode_transmission (0)
296 , _speakers (new Speakers)
298 , ignore_route_processor_changes (false)
305 pthread_mutex_init (&_rt_emit_mutex, 0);
306 pthread_cond_init (&_rt_emit_cond, 0);
308 pre_engine_init (fullpath);
312 Stateful::loading_state_version = CURRENT_SESSION_FILE_VERSION;
314 #ifdef USE_TRACKS_CODE_FEATURES
315 sr = EngineStateController::instance()->get_current_sample_rate();
317 if (ensure_engine (sr)) {
319 throw SessionException (_("Cannot connect to audio/midi engine"));
322 // set samplerate for plugins added early
323 // e.g from templates or MB channelstrip
324 set_block_size (_engine.samples_per_cycle());
325 set_frame_rate (_engine.sample_rate());
327 if (create (mix_template, bus_profile)) {
329 throw SessionException (_("Session initialization failed"));
332 /* if a mix template was provided, then ::create() will
333 * have copied it into the session and we need to load it
334 * so that we have the state ready for ::set_state()
335 * after the engine is started.
337 * Note that we do NOT try to get the sample rate from
338 * the template at this time, though doing so would
339 * be easy if we decided this was an appropriate part
343 if (!mix_template.empty()) {
344 if (load_state (_current_snapshot_name)) {
345 throw SessionException (_("Failed to load template/snapshot state"));
347 store_recent_templates (mix_template);
350 /* load default session properties - if any */
355 if (load_state (_current_snapshot_name)) {
356 throw SessionException (_("Failed to load state"));
359 /* try to get sample rate from XML state so that we
360 * can influence the SR if we set up the audio
365 const XMLProperty* prop;
366 if ((prop = state_tree->root()->property (X_("sample-rate"))) != 0) {
367 sr = atoi (prop->value());
371 if (ensure_engine (sr)) {
373 throw SessionException (_("Cannot connect to audio/midi engine"));
377 if (post_engine_init ()) {
379 throw SessionException (_("Cannot configure audio/midi engine with session parameters"));
382 store_recent_sessions (_name, _path);
384 bool was_dirty = dirty();
386 _state_of_the_state = StateOfTheState (_state_of_the_state & ~Dirty);
388 Config->ParameterChanged.connect_same_thread (*this, boost::bind (&Session::config_changed, this, _1, false));
389 config.ParameterChanged.connect_same_thread (*this, boost::bind (&Session::config_changed, this, _1, true));
392 DirtyChanged (); /* EMIT SIGNAL */
395 StartTimeChanged.connect_same_thread (*this, boost::bind (&Session::start_time_changed, this, _1));
396 EndTimeChanged.connect_same_thread (*this, boost::bind (&Session::end_time_changed, this, _1));
398 emit_thread_start ();
400 /* hook us up to the engine since we are now completely constructed */
402 BootMessage (_("Connect to engine"));
404 _engine.set_session (this);
405 _engine.reset_timebase ();
407 #ifdef USE_TRACKS_CODE_FEATURES
409 EngineStateController::instance()->set_session(this);
412 if ( ARDOUR::Profile->get_trx () ) {
414 /* Waves Tracks: fill session with tracks basing on the amount of inputs.
415 * each available input must have corresponding track when session starts.
418 uint32_t how_many (0);
420 std::vector<std::string> inputs;
421 EngineStateController::instance()->get_physical_audio_inputs(inputs);
423 how_many = inputs.size();
425 list<boost::shared_ptr<AudioTrack> > tracks;
427 // Track names after driver
428 if (Config->get_tracks_auto_naming() == NameAfterDriver) {
429 string track_name = "";
430 for (std::vector<string>::size_type i = 0; i < inputs.size(); ++i) {
432 track_name = inputs[i];
433 replace_all (track_name, "system:capture", "");
435 list<boost::shared_ptr<AudioTrack> > single_track = new_audio_track (1, 1, Normal, 0, 1, track_name);
436 tracks.insert(tracks.begin(), single_track.front());
438 } else { // Default track names
439 tracks = new_audio_track (1, 1, Normal, 0, how_many, string());
442 if (tracks.size() != how_many) {
444 throw failed_constructor ();
453 BootMessage (_("Session loading complete"));
465 Session::ensure_engine (uint32_t desired_sample_rate)
467 if (_engine.current_backend() == 0) {
468 /* backend is unknown ... */
469 boost::optional<int> r = AudioEngineSetupRequired (desired_sample_rate);
470 if (r.get_value_or (-1) != 0) {
473 } else if (_engine.setup_required()) {
474 /* backend is known, but setup is needed */
475 boost::optional<int> r = AudioEngineSetupRequired (desired_sample_rate);
476 if (r.get_value_or (-1) != 0) {
479 } else if (!_engine.running()) {
480 if (_engine.start()) {
485 /* at this point the engine should be running
488 if (!_engine.running()) {
492 return immediately_post_engine ();
497 Session::immediately_post_engine ()
499 /* Do various initializations that should take place directly after we
500 * know that the engine is running, but before we either create a
501 * session or set state for an existing one.
504 if (how_many_dsp_threads () > 1) {
505 /* For now, only create the graph if we are using >1 DSP threads, as
506 it is a bit slower than the old code with 1 thread.
508 _process_graph.reset (new Graph (*this));
511 /* every time we reconnect, recompute worst case output latencies */
513 _engine.Running.connect_same_thread (*this, boost::bind (&Session::initialize_latencies, this));
515 if (synced_to_engine()) {
516 _engine.transport_stop ();
519 if (config.get_jack_time_master()) {
520 _engine.transport_locate (_transport_frame);
524 BootMessage (_("Set up LTC"));
526 BootMessage (_("Set up Click"));
528 BootMessage (_("Set up standard connections"));
532 catch (failed_constructor& err) {
536 /* TODO, connect in different thread. (PortRegisteredOrUnregistered may be in RT context)
538 _engine.PortRegisteredOrUnregistered.connect_same_thread (*this, boost::bind (&Session::setup_bundles, this));
546 vector<void*> debug_pointers;
548 /* if we got to here, leaving pending capture state around
552 remove_pending_capture_state ();
556 _state_of_the_state = StateOfTheState (CannotSave|Deletion);
558 /* disconnect from any and all signals that we are connected to */
562 /* shutdown control surface protocols while we still have ports
563 and the engine to move data to any devices.
566 ControlProtocolManager::instance().drop_protocols ();
568 MIDI::Name::MidiPatchManager::instance().remove_search_path(session_directory().midi_patch_path());
570 _engine.remove_session ();
572 #ifdef USE_TRACKS_CODE_FEATURES
573 EngineStateController::instance()->remove_session();
576 /* deregister all ports - there will be no process or any other
577 * callbacks from the engine any more.
580 Port::PortDrop (); /* EMIT SIGNAL */
584 /* clear history so that no references to objects are held any more */
588 /* clear state tree so that no references to objects are held any more */
593 /* reset dynamic state version back to default */
595 Stateful::loading_state_version = 0;
597 _butler->drop_references ();
601 delete _all_route_group;
603 DEBUG_TRACE (DEBUG::Destruction, "delete route groups\n");
604 for (list<RouteGroup *>::iterator i = _route_groups.begin(); i != _route_groups.end(); ++i) {
608 if (click_data != default_click) {
609 delete [] click_data;
612 if (click_emphasis_data != default_click_emphasis) {
613 delete [] click_emphasis_data;
618 /* need to remove auditioner before monitoring section
619 * otherwise it is re-connected */
622 /* drop references to routes held by the monitoring section
623 * specifically _monitor_out aux/listen references */
624 remove_monitor_section();
626 /* clear out any pending dead wood from RCU managed objects */
631 AudioDiskstream::free_working_buffers();
633 /* tell everyone who is still standing that we're about to die */
636 /* tell everyone to drop references and delete objects as we go */
638 DEBUG_TRACE (DEBUG::Destruction, "delete regions\n");
639 RegionFactory::delete_all_regions ();
641 DEBUG_TRACE (DEBUG::Destruction, "delete routes\n");
643 /* reset these three references to special routes before we do the usual route delete thing */
645 _master_out.reset ();
646 _monitor_out.reset ();
649 RCUWriter<RouteList> writer (routes);
650 boost::shared_ptr<RouteList> r = writer.get_copy ();
652 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
653 DEBUG_TRACE(DEBUG::Destruction, string_compose ("Dropping for route %1 ; pre-ref = %2\n", (*i)->name(), (*i).use_count()));
654 (*i)->drop_references ();
658 /* writer goes out of scope and updates master */
663 DEBUG_TRACE (DEBUG::Destruction, "delete sources\n");
664 Glib::Threads::Mutex::Lock lm (source_lock);
665 for (SourceMap::iterator i = sources.begin(); i != sources.end(); ++i) {
666 DEBUG_TRACE(DEBUG::Destruction, string_compose ("Dropping for source %1 ; pre-ref = %2\n", i->second->name(), i->second.use_count()));
667 i->second->drop_references ();
673 /* not strictly necessary, but doing it here allows the shared_ptr debugging to work */
676 emit_thread_terminate ();
678 pthread_cond_destroy (&_rt_emit_cond);
679 pthread_mutex_destroy (&_rt_emit_mutex);
681 delete _scene_changer; _scene_changer = 0;
682 delete midi_control_ui; midi_control_ui = 0;
684 delete _mmc; _mmc = 0;
685 delete _midi_ports; _midi_ports = 0;
686 delete _locations; _locations = 0;
690 DEBUG_TRACE (DEBUG::Destruction, "Session::destroy() done\n");
692 #ifdef BOOST_SP_ENABLE_DEBUG_HOOKS
693 boost_debug_list_ptrs ();
698 Session::setup_ltc ()
702 _ltc_input.reset (new IO (*this, X_("LTC In"), IO::Input));
703 _ltc_output.reset (new IO (*this, X_("LTC Out"), IO::Output));
705 if (state_tree && (child = find_named_node (*state_tree->root(), X_("LTC In"))) != 0) {
706 _ltc_input->set_state (*(child->children().front()), Stateful::loading_state_version);
709 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
710 _ltc_input->ensure_io (ChanCount (DataType::AUDIO, 1), true, this);
712 reconnect_ltc_input ();
715 if (state_tree && (child = find_named_node (*state_tree->root(), X_("LTC Out"))) != 0) {
716 _ltc_output->set_state (*(child->children().front()), Stateful::loading_state_version);
719 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
720 _ltc_output->ensure_io (ChanCount (DataType::AUDIO, 1), true, this);
722 reconnect_ltc_output ();
725 /* fix up names of LTC ports because we don't want the normal
726 * IO style of NAME/TYPE-{in,out}N
729 _ltc_input->nth (0)->set_name (X_("LTC-in"));
730 _ltc_output->nth (0)->set_name (X_("LTC-out"));
734 Session::setup_click ()
738 boost::shared_ptr<AutomationList> gl (new AutomationList (Evoral::Parameter (GainAutomation)));
739 boost::shared_ptr<GainControl> gain_control = boost::shared_ptr<GainControl> (new GainControl (*this, Evoral::Parameter(GainAutomation), gl));
741 _click_io.reset (new ClickIO (*this, X_("Click")));
742 _click_gain.reset (new Amp (*this, _("Fader"), gain_control, true));
743 _click_gain->activate ();
745 setup_click_state (state_tree->root());
747 setup_click_state (0);
752 Session::setup_click_state (const XMLNode* node)
754 const XMLNode* child = 0;
756 if (node && (child = find_named_node (*node, "Click")) != 0) {
758 /* existing state for Click */
761 if (Stateful::loading_state_version < 3000) {
762 c = _click_io->set_state_2X (*child->children().front(), Stateful::loading_state_version, false);
764 const XMLNodeList& children (child->children());
765 XMLNodeList::const_iterator i = children.begin();
766 if ((c = _click_io->set_state (**i, Stateful::loading_state_version)) == 0) {
768 if (i != children.end()) {
769 c = _click_gain->set_state (**i, Stateful::loading_state_version);
775 _clicking = Config->get_clicking ();
779 error << _("could not setup Click I/O") << endmsg;
786 /* default state for Click: dual-mono to first 2 physical outputs */
789 _engine.get_physical_outputs (DataType::AUDIO, outs);
791 for (uint32_t physport = 0; physport < 2; ++physport) {
792 if (outs.size() > physport) {
793 if (_click_io->add_port (outs[physport], this)) {
794 // relax, even though its an error
799 if (_click_io->n_ports () > ChanCount::ZERO) {
800 _clicking = Config->get_clicking ();
806 Session::setup_bundles ()
810 RCUWriter<BundleList> writer (_bundles);
811 boost::shared_ptr<BundleList> b = writer.get_copy ();
812 for (BundleList::iterator i = b->begin(); i != b->end();) {
813 if (boost::dynamic_pointer_cast<UserBundle>(*i)) {
821 vector<string> inputs[DataType::num_types];
822 vector<string> outputs[DataType::num_types];
823 for (uint32_t i = 0; i < DataType::num_types; ++i) {
824 _engine.get_physical_inputs (DataType (DataType::Symbol (i)), inputs[i]);
825 _engine.get_physical_outputs (DataType (DataType::Symbol (i)), outputs[i]);
828 /* Create a set of Bundle objects that map
829 to the physical I/O currently available. We create both
830 mono and stereo bundles, so that the common cases of mono
831 and stereo tracks get bundles to put in their mixer strip
832 in / out menus. There may be a nicer way of achieving that;
833 it doesn't really scale that well to higher channel counts
836 /* mono output bundles */
838 for (uint32_t np = 0; np < outputs[DataType::AUDIO].size(); ++np) {
840 std::string pn = _engine.get_pretty_name_by_name (outputs[DataType::AUDIO][np]);
842 snprintf (buf, sizeof (buf), _("out %s"), pn.c_str());
844 snprintf (buf, sizeof (buf), _("out %" PRIu32), np+1);
847 boost::shared_ptr<Bundle> c (new Bundle (buf, true));
848 c->add_channel (_("mono"), DataType::AUDIO);
849 c->set_port (0, outputs[DataType::AUDIO][np]);
851 add_bundle (c, false);
854 /* stereo output bundles */
856 for (uint32_t np = 0; np < outputs[DataType::AUDIO].size(); np += 2) {
857 if (np + 1 < outputs[DataType::AUDIO].size()) {
859 snprintf (buf, sizeof(buf), _("out %" PRIu32 "+%" PRIu32), np + 1, np + 2);
860 boost::shared_ptr<Bundle> c (new Bundle (buf, true));
861 c->add_channel (_("L"), DataType::AUDIO);
862 c->set_port (0, outputs[DataType::AUDIO][np]);
863 c->add_channel (_("R"), DataType::AUDIO);
864 c->set_port (1, outputs[DataType::AUDIO][np + 1]);
866 add_bundle (c, false);
870 /* mono input bundles */
872 for (uint32_t np = 0; np < inputs[DataType::AUDIO].size(); ++np) {
874 std::string pn = _engine.get_pretty_name_by_name (inputs[DataType::AUDIO][np]);
876 snprintf (buf, sizeof (buf), _("in %s"), pn.c_str());
878 snprintf (buf, sizeof (buf), _("in %" PRIu32), np+1);
881 boost::shared_ptr<Bundle> c (new Bundle (buf, false));
882 c->add_channel (_("mono"), DataType::AUDIO);
883 c->set_port (0, inputs[DataType::AUDIO][np]);
885 add_bundle (c, false);
888 /* stereo input bundles */
890 for (uint32_t np = 0; np < inputs[DataType::AUDIO].size(); np += 2) {
891 if (np + 1 < inputs[DataType::AUDIO].size()) {
893 snprintf (buf, sizeof(buf), _("in %" PRIu32 "+%" PRIu32), np + 1, np + 2);
895 boost::shared_ptr<Bundle> c (new Bundle (buf, false));
896 c->add_channel (_("L"), DataType::AUDIO);
897 c->set_port (0, inputs[DataType::AUDIO][np]);
898 c->add_channel (_("R"), DataType::AUDIO);
899 c->set_port (1, inputs[DataType::AUDIO][np + 1]);
901 add_bundle (c, false);
905 /* MIDI input bundles */
907 for (uint32_t np = 0; np < inputs[DataType::MIDI].size(); ++np) {
908 string n = inputs[DataType::MIDI][np];
909 std::string pn = _engine.get_pretty_name_by_name (n);
913 boost::erase_first (n, X_("alsa_pcm:"));
915 boost::shared_ptr<Bundle> c (new Bundle (n, false));
916 c->add_channel ("", DataType::MIDI);
917 c->set_port (0, inputs[DataType::MIDI][np]);
918 add_bundle (c, false);
921 /* MIDI output bundles */
923 for (uint32_t np = 0; np < outputs[DataType::MIDI].size(); ++np) {
924 string n = outputs[DataType::MIDI][np];
925 std::string pn = _engine.get_pretty_name_by_name (n);
929 boost::erase_first (n, X_("alsa_pcm:"));
931 boost::shared_ptr<Bundle> c (new Bundle (n, true));
932 c->add_channel ("", DataType::MIDI);
933 c->set_port (0, outputs[DataType::MIDI][np]);
934 add_bundle (c, false);
937 // we trust the backend to only calls us if there's a change
938 BundleAddedOrRemoved (); /* EMIT SIGNAL */
942 Session::auto_connect_master_bus ()
944 if (!_master_out || !Config->get_auto_connect_standard_busses() || _monitor_out) {
948 // Waves Tracks: Do not connect master bas for Tracks if AutoConnectMaster option is not set
949 // In this case it means "Multi Out" output mode
950 if (ARDOUR::Profile->get_trx() && !(Config->get_output_auto_connect() & AutoConnectMaster) ) {
954 /* if requested auto-connect the outputs to the first N physical ports.
957 uint32_t limit = _master_out->n_outputs().n_total();
958 vector<string> outputs[DataType::num_types];
960 for (uint32_t i = 0; i < DataType::num_types; ++i) {
961 _engine.get_physical_outputs (DataType (DataType::Symbol (i)), outputs[i]);
964 for (uint32_t n = 0; n < limit; ++n) {
965 boost::shared_ptr<Port> p = _master_out->output()->nth (n);
967 if (outputs[p->type()].size() > n) {
968 connect_to = outputs[p->type()][n];
971 if (!connect_to.empty() && p->connected_to (connect_to) == false) {
972 if (_master_out->output()->connect (p, connect_to, this)) {
973 error << string_compose (_("cannot connect master output %1 to %2"), n, connect_to)
982 Session::remove_monitor_section ()
984 if (!_monitor_out || Profile->get_trx()) {
988 /* force reversion to Solo-In-Place */
989 Config->set_solo_control_is_listen_control (false);
991 /* if we are auditioning, cancel it ... this is a workaround
992 to a problem (auditioning does not execute the process graph,
993 which is needed to remove routes when using >1 core for processing)
998 /* Hold process lock while doing this so that we don't hear bits and
999 * pieces of audio as we work on each route.
1002 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
1004 /* Connect tracks to monitor section. Note that in an
1005 existing session, the internal sends will already exist, but we want the
1006 routes to notice that they connect to the control out specifically.
1010 boost::shared_ptr<RouteList> r = routes.reader ();
1011 PBD::Unwinder<bool> uw (ignore_route_processor_changes, true);
1013 for (RouteList::iterator x = r->begin(); x != r->end(); ++x) {
1015 if ((*x)->is_monitor()) {
1017 } else if ((*x)->is_master()) {
1020 (*x)->remove_aux_or_listen (_monitor_out);
1025 remove_route (_monitor_out);
1026 auto_connect_master_bus ();
1029 auditioner->connect ();
1031 Config->ParameterChanged ("use-monitor-bus");
1035 Session::add_monitor_section ()
1039 if (_monitor_out || !_master_out || Profile->get_trx()) {
1043 boost::shared_ptr<Route> r (new Route (*this, _("Monitor"), Route::MonitorOut, DataType::AUDIO));
1049 #ifdef BOOST_SP_ENABLE_DEBUG_HOOKS
1050 // boost_debug_shared_ptr_mark_interesting (r.get(), "Route");
1053 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
1054 r->input()->ensure_io (_master_out->output()->n_ports(), false, this);
1055 r->output()->ensure_io (_master_out->output()->n_ports(), false, this);
1057 error << _("Cannot create monitor section. 'Monitor' Port name is not unique.") << endmsg;
1062 add_routes (rl, false, false, false);
1064 assert (_monitor_out);
1066 /* AUDIO ONLY as of june 29th 2009, because listen semantics for anything else
1067 are undefined, at best.
1070 uint32_t limit = _monitor_out->n_inputs().n_audio();
1074 /* connect the inputs to the master bus outputs. this
1075 * represents a separate data feed from the internal sends from
1076 * each route. as of jan 2011, it allows the monitor section to
1077 * conditionally ignore either the internal sends or the normal
1078 * input feed, but we should really find a better way to do
1082 _master_out->output()->disconnect (this);
1084 for (uint32_t n = 0; n < limit; ++n) {
1085 boost::shared_ptr<AudioPort> p = _monitor_out->input()->ports().nth_audio_port (n);
1086 boost::shared_ptr<AudioPort> o = _master_out->output()->ports().nth_audio_port (n);
1089 string connect_to = o->name();
1090 if (_monitor_out->input()->connect (p, connect_to, this)) {
1091 error << string_compose (_("cannot connect control input %1 to %2"), n, connect_to)
1099 /* if monitor section is not connected, connect it to physical outs
1102 if (Config->get_auto_connect_standard_busses() && !_monitor_out->output()->connected ()) {
1104 if (!Config->get_monitor_bus_preferred_bundle().empty()) {
1106 boost::shared_ptr<Bundle> b = bundle_by_name (Config->get_monitor_bus_preferred_bundle());
1109 _monitor_out->output()->connect_ports_to_bundle (b, true, this);
1111 warning << string_compose (_("The preferred I/O for the monitor bus (%1) cannot be found"),
1112 Config->get_monitor_bus_preferred_bundle())
1118 /* Monitor bus is audio only */
1120 vector<string> outputs[DataType::num_types];
1122 for (uint32_t i = 0; i < DataType::num_types; ++i) {
1123 _engine.get_physical_outputs (DataType (DataType::Symbol (i)), outputs[i]);
1126 uint32_t mod = outputs[DataType::AUDIO].size();
1127 uint32_t limit = _monitor_out->n_outputs().get (DataType::AUDIO);
1131 for (uint32_t n = 0; n < limit; ++n) {
1133 boost::shared_ptr<Port> p = _monitor_out->output()->ports().port(DataType::AUDIO, n);
1135 if (outputs[DataType::AUDIO].size() > (n % mod)) {
1136 connect_to = outputs[DataType::AUDIO][n % mod];
1139 if (!connect_to.empty()) {
1140 if (_monitor_out->output()->connect (p, connect_to, this)) {
1141 error << string_compose (
1142 _("cannot connect control output %1 to %2"),
1153 /* Hold process lock while doing this so that we don't hear bits and
1154 * pieces of audio as we work on each route.
1157 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
1159 /* Connect tracks to monitor section. Note that in an
1160 existing session, the internal sends will already exist, but we want the
1161 routes to notice that they connect to the control out specifically.
1165 boost::shared_ptr<RouteList> rls = routes.reader ();
1167 PBD::Unwinder<bool> uw (ignore_route_processor_changes, true);
1169 for (RouteList::iterator x = rls->begin(); x != rls->end(); ++x) {
1171 if ((*x)->is_monitor()) {
1173 } else if ((*x)->is_master()) {
1176 (*x)->enable_monitor_send ();
1181 auditioner->connect ();
1183 Config->ParameterChanged ("use-monitor-bus");
1187 Session::reset_monitor_section ()
1189 /* Process lock should be held by the caller.*/
1191 if (!_monitor_out || Profile->get_trx()) {
1195 uint32_t limit = _master_out->n_outputs().n_audio();
1197 /* connect the inputs to the master bus outputs. this
1198 * represents a separate data feed from the internal sends from
1199 * each route. as of jan 2011, it allows the monitor section to
1200 * conditionally ignore either the internal sends or the normal
1201 * input feed, but we should really find a better way to do
1205 _master_out->output()->disconnect (this);
1206 _monitor_out->output()->disconnect (this);
1208 _monitor_out->input()->ensure_io (_master_out->output()->n_ports(), false, this);
1209 _monitor_out->output()->ensure_io (_master_out->output()->n_ports(), false, this);
1211 for (uint32_t n = 0; n < limit; ++n) {
1212 boost::shared_ptr<AudioPort> p = _monitor_out->input()->ports().nth_audio_port (n);
1213 boost::shared_ptr<AudioPort> o = _master_out->output()->ports().nth_audio_port (n);
1216 string connect_to = o->name();
1217 if (_monitor_out->input()->connect (p, connect_to, this)) {
1218 error << string_compose (_("cannot connect control input %1 to %2"), n, connect_to)
1225 /* connect monitor section to physical outs
1228 if (Config->get_auto_connect_standard_busses()) {
1230 if (!Config->get_monitor_bus_preferred_bundle().empty()) {
1232 boost::shared_ptr<Bundle> b = bundle_by_name (Config->get_monitor_bus_preferred_bundle());
1235 _monitor_out->output()->connect_ports_to_bundle (b, true, this);
1237 warning << string_compose (_("The preferred I/O for the monitor bus (%1) cannot be found"),
1238 Config->get_monitor_bus_preferred_bundle())
1244 /* Monitor bus is audio only */
1246 vector<string> outputs[DataType::num_types];
1248 for (uint32_t i = 0; i < DataType::num_types; ++i) {
1249 _engine.get_physical_outputs (DataType (DataType::Symbol (i)), outputs[i]);
1252 uint32_t mod = outputs[DataType::AUDIO].size();
1253 uint32_t limit = _monitor_out->n_outputs().get (DataType::AUDIO);
1257 for (uint32_t n = 0; n < limit; ++n) {
1259 boost::shared_ptr<Port> p = _monitor_out->output()->ports().port(DataType::AUDIO, n);
1261 if (outputs[DataType::AUDIO].size() > (n % mod)) {
1262 connect_to = outputs[DataType::AUDIO][n % mod];
1265 if (!connect_to.empty()) {
1266 if (_monitor_out->output()->connect (p, connect_to, this)) {
1267 error << string_compose (
1268 _("cannot connect control output %1 to %2"),
1279 /* Connect tracks to monitor section. Note that in an
1280 existing session, the internal sends will already exist, but we want the
1281 routes to notice that they connect to the control out specifically.
1285 boost::shared_ptr<RouteList> rls = routes.reader ();
1287 PBD::Unwinder<bool> uw (ignore_route_processor_changes, true);
1289 for (RouteList::iterator x = rls->begin(); x != rls->end(); ++x) {
1291 if ((*x)->is_monitor()) {
1293 } else if ((*x)->is_master()) {
1296 (*x)->enable_monitor_send ();
1302 Session::hookup_io ()
1304 /* stop graph reordering notifications from
1305 causing resorts, etc.
1308 _state_of_the_state = StateOfTheState (_state_of_the_state | InitialConnecting);
1312 /* we delay creating the auditioner till now because
1313 it makes its own connections to ports.
1317 boost::shared_ptr<Auditioner> a (new Auditioner (*this));
1319 throw failed_constructor ();
1321 a->use_new_diskstream ();
1325 catch (failed_constructor& err) {
1326 warning << _("cannot create Auditioner: no auditioning of regions possible") << endmsg;
1330 /* load bundles, which we may have postponed earlier on */
1331 if (_bundle_xml_node) {
1332 load_bundles (*_bundle_xml_node);
1333 delete _bundle_xml_node;
1336 /* Tell all IO objects to connect themselves together */
1338 IO::enable_connecting ();
1340 /* Now tell all "floating" ports to connect to whatever
1341 they should be connected to.
1344 AudioEngine::instance()->reconnect_ports ();
1346 /* Anyone who cares about input state, wake up and do something */
1348 IOConnectionsComplete (); /* EMIT SIGNAL */
1350 _state_of_the_state = StateOfTheState (_state_of_the_state & ~InitialConnecting);
1352 /* now handle the whole enchilada as if it was one
1353 graph reorder event.
1358 /* update the full solo state, which can't be
1359 correctly determined on a per-route basis, but
1360 needs the global overview that only the session
1364 update_route_solo_state ();
1368 Session::track_playlist_changed (boost::weak_ptr<Track> wp)
1370 boost::shared_ptr<Track> track = wp.lock ();
1375 boost::shared_ptr<Playlist> playlist;
1377 if ((playlist = track->playlist()) != 0) {
1378 playlist->RegionAdded.connect_same_thread (*this, boost::bind (&Session::playlist_region_added, this, _1));
1379 playlist->RangesMoved.connect_same_thread (*this, boost::bind (&Session::playlist_ranges_moved, this, _1));
1380 playlist->RegionsExtended.connect_same_thread (*this, boost::bind (&Session::playlist_regions_extended, this, _1));
1385 Session::record_enabling_legal () const
1387 /* this used to be in here, but survey says.... we don't need to restrict it */
1388 // if (record_status() == Recording) {
1392 if (Config->get_all_safe()) {
1399 Session::set_track_monitor_input_status (bool yn)
1401 boost::shared_ptr<RouteList> rl = routes.reader ();
1402 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
1403 boost::shared_ptr<AudioTrack> tr = boost::dynamic_pointer_cast<AudioTrack> (*i);
1404 if (tr && tr->record_enabled ()) {
1405 //cerr << "switching to input = " << !auto_input << __FILE__ << __LINE__ << endl << endl;
1406 tr->request_input_monitoring (yn);
1412 Session::auto_punch_start_changed (Location* location)
1414 replace_event (SessionEvent::PunchIn, location->start());
1416 if (get_record_enabled() && config.get_punch_in()) {
1417 /* capture start has been changed, so save new pending state */
1418 save_state ("", true);
1423 Session::auto_punch_end_changed (Location* location)
1425 framepos_t when_to_stop = location->end();
1426 // when_to_stop += _worst_output_latency + _worst_input_latency;
1427 replace_event (SessionEvent::PunchOut, when_to_stop);
1431 Session::auto_punch_changed (Location* location)
1433 framepos_t when_to_stop = location->end();
1435 replace_event (SessionEvent::PunchIn, location->start());
1436 //when_to_stop += _worst_output_latency + _worst_input_latency;
1437 replace_event (SessionEvent::PunchOut, when_to_stop);
1440 /** @param loc A loop location.
1441 * @param pos Filled in with the start time of the required fade-out (in session frames).
1442 * @param length Filled in with the length of the required fade-out.
1445 Session::auto_loop_declick_range (Location* loc, framepos_t & pos, framepos_t & length)
1447 pos = max (loc->start(), loc->end() - 64);
1448 length = loc->end() - pos;
1452 Session::auto_loop_changed (Location* location)
1454 replace_event (SessionEvent::AutoLoop, location->end(), location->start());
1457 auto_loop_declick_range (location, dcp, dcl);
1459 if (transport_rolling() && play_loop) {
1461 replace_event (SessionEvent::AutoLoopDeclick, dcp, dcl);
1463 // if (_transport_frame > location->end()) {
1465 if (_transport_frame < location->start() || _transport_frame > location->end()) {
1466 // relocate to beginning of loop
1467 clear_events (SessionEvent::LocateRoll);
1469 request_locate (location->start(), true);
1472 else if (Config->get_seamless_loop() && !loop_changing) {
1474 // schedule a locate-roll to refill the diskstreams at the
1475 // previous loop end
1476 loop_changing = true;
1478 if (location->end() > last_loopend) {
1479 clear_events (SessionEvent::LocateRoll);
1480 SessionEvent *ev = new SessionEvent (SessionEvent::LocateRoll, SessionEvent::Add, last_loopend, last_loopend, 0, true);
1486 clear_events (SessionEvent::AutoLoopDeclick);
1487 clear_events (SessionEvent::AutoLoop);
1490 /* possibly move playhead if not rolling; if we are rolling we'll move
1491 to the loop start on stop if that is appropriate.
1496 if (!transport_rolling() && select_playhead_priority_target (pos)) {
1497 if (pos == location->start()) {
1498 request_locate (pos);
1503 last_loopend = location->end();
1508 Session::set_auto_punch_location (Location* location)
1512 if ((existing = _locations->auto_punch_location()) != 0 && existing != location) {
1513 punch_connections.drop_connections();
1514 existing->set_auto_punch (false, this);
1515 remove_event (existing->start(), SessionEvent::PunchIn);
1516 clear_events (SessionEvent::PunchOut);
1517 auto_punch_location_changed (0);
1522 if (location == 0) {
1526 if (location->end() <= location->start()) {
1527 error << _("Session: you can't use that location for auto punch (start <= end)") << endmsg;
1531 punch_connections.drop_connections ();
1533 location->StartChanged.connect_same_thread (punch_connections, boost::bind (&Session::auto_punch_start_changed, this, location));
1534 location->EndChanged.connect_same_thread (punch_connections, boost::bind (&Session::auto_punch_end_changed, this, location));
1535 location->Changed.connect_same_thread (punch_connections, boost::bind (&Session::auto_punch_changed, this, location));
1537 location->set_auto_punch (true, this);
1539 auto_punch_changed (location);
1541 auto_punch_location_changed (location);
1545 Session::set_session_extents (framepos_t start, framepos_t end)
1548 if ((existing = _locations->session_range_location()) == 0) {
1549 //if there is no existing session, we need to make a new session location (should never happen)
1550 existing = new Location (*this, 0, 0, _("session"), Location::IsSessionRange);
1554 error << _("Session: you can't use that location for session start/end)") << endmsg;
1558 existing->set( start, end );
1564 Session::set_auto_loop_location (Location* location)
1568 if ((existing = _locations->auto_loop_location()) != 0 && existing != location) {
1569 loop_connections.drop_connections ();
1570 existing->set_auto_loop (false, this);
1571 remove_event (existing->end(), SessionEvent::AutoLoop);
1574 auto_loop_declick_range (existing, dcp, dcl);
1575 remove_event (dcp, SessionEvent::AutoLoopDeclick);
1576 auto_loop_location_changed (0);
1581 if (location == 0) {
1585 if (location->end() <= location->start()) {
1586 error << _("You cannot use this location for auto-loop because it has zero or negative length") << endmsg;
1590 last_loopend = location->end();
1592 loop_connections.drop_connections ();
1594 location->StartChanged.connect_same_thread (loop_connections, boost::bind (&Session::auto_loop_changed, this, location));
1595 location->EndChanged.connect_same_thread (loop_connections, boost::bind (&Session::auto_loop_changed, this, location));
1596 location->Changed.connect_same_thread (loop_connections, boost::bind (&Session::auto_loop_changed, this, location));
1597 location->FlagsChanged.connect_same_thread (loop_connections, boost::bind (&Session::auto_loop_changed, this, location));
1599 location->set_auto_loop (true, this);
1601 if (Config->get_loop_is_mode() && play_loop && Config->get_seamless_loop()) {
1602 // set all tracks to use internal looping
1603 boost::shared_ptr<RouteList> rl = routes.reader ();
1604 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
1605 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
1606 if (tr && !tr->hidden()) {
1607 tr->set_loop (location);
1612 /* take care of our stuff first */
1614 auto_loop_changed (location);
1616 /* now tell everyone else */
1618 auto_loop_location_changed (location);
1622 Session::update_marks (Location*)
1628 Session::update_skips (Location* loc, bool consolidate)
1630 if (_ignore_skips_updates) {
1634 Locations::LocationList skips;
1637 PBD::Unwinder<bool> uw (_ignore_skips_updates, true);
1638 consolidate_skips (loc);
1641 sync_locations_to_skips ();
1647 Session::consolidate_skips (Location* loc)
1649 Locations::LocationList all_locations = _locations->list ();
1651 for (Locations::LocationList::iterator l = all_locations.begin(); l != all_locations.end(); ) {
1653 if (!(*l)->is_skip ()) {
1658 /* don't test against self */
1665 switch (Evoral::coverage ((*l)->start(), (*l)->end(), loc->start(), loc->end())) {
1666 case Evoral::OverlapInternal:
1667 case Evoral::OverlapExternal:
1668 case Evoral::OverlapStart:
1669 case Evoral::OverlapEnd:
1670 /* adjust new location to cover existing one */
1671 loc->set_start (min (loc->start(), (*l)->start()));
1672 loc->set_end (max (loc->end(), (*l)->end()));
1673 /* we don't need this one any more */
1674 _locations->remove (*l);
1675 /* the location has been deleted, so remove reference to it in our local list */
1676 l = all_locations.erase (l);
1679 case Evoral::OverlapNone:
1687 Session::sync_locations_to_skips ()
1689 /* This happens asynchronously (in the audioengine thread). After the clear is done, we will call
1690 * Session::_sync_locations_to_skips() from the audioengine thread.
1692 clear_events (SessionEvent::Skip, boost::bind (&Session::_sync_locations_to_skips, this));
1696 Session::_sync_locations_to_skips ()
1698 /* called as a callback after existing Skip events have been cleared from a realtime audioengine thread */
1700 Locations::LocationList const & locs (_locations->list());
1702 for (Locations::LocationList::const_iterator i = locs.begin(); i != locs.end(); ++i) {
1704 Location* location = *i;
1706 if (location->is_skip() && location->is_skipping()) {
1707 SessionEvent* ev = new SessionEvent (SessionEvent::Skip, SessionEvent::Add, location->start(), location->end(), 1.0);
1715 Session::location_added (Location *location)
1717 if (location->is_auto_punch()) {
1718 set_auto_punch_location (location);
1721 if (location->is_auto_loop()) {
1722 set_auto_loop_location (location);
1725 if (location->is_session_range()) {
1726 /* no need for any signal handling or event setting with the session range,
1727 because we keep a direct reference to it and use its start/end directly.
1729 _session_range_location = location;
1732 if (location->is_mark()) {
1733 /* listen for per-location signals that require us to do any * global updates for marks */
1735 location->StartChanged.connect_same_thread (skip_update_connections, boost::bind (&Session::update_marks, this, location));
1736 location->EndChanged.connect_same_thread (skip_update_connections, boost::bind (&Session::update_marks, this, location));
1737 location->Changed.connect_same_thread (skip_update_connections, boost::bind (&Session::update_marks, this, location));
1738 location->FlagsChanged.connect_same_thread (skip_update_connections, boost::bind (&Session::update_marks, this, location));
1741 if (location->is_skip()) {
1742 /* listen for per-location signals that require us to update skip-locate events */
1744 location->StartChanged.connect_same_thread (skip_update_connections, boost::bind (&Session::update_skips, this, location, true));
1745 location->EndChanged.connect_same_thread (skip_update_connections, boost::bind (&Session::update_skips, this, location, true));
1746 location->Changed.connect_same_thread (skip_update_connections, boost::bind (&Session::update_skips, this, location, true));
1747 location->FlagsChanged.connect_same_thread (skip_update_connections, boost::bind (&Session::update_skips, this, location, false));
1749 update_skips (location, true);
1756 Session::location_removed (Location *location)
1758 if (location->is_auto_loop()) {
1759 set_auto_loop_location (0);
1760 set_track_loop (false);
1763 if (location->is_auto_punch()) {
1764 set_auto_punch_location (0);
1767 if (location->is_session_range()) {
1768 /* this is never supposed to happen */
1769 error << _("programming error: session range removed!") << endl;
1772 if (location->is_skip()) {
1774 update_skips (location, false);
1781 Session::locations_changed ()
1783 _locations->apply (*this, &Session::_locations_changed);
1787 Session::_locations_changed (const Locations::LocationList& locations)
1789 /* There was some mass-change in the Locations object.
1791 We might be re-adding a location here but it doesn't actually matter
1792 for all the locations that the Session takes an interest in.
1796 PBD::Unwinder<bool> protect_ignore_skip_updates (_ignore_skips_updates, true);
1797 for (Locations::LocationList::const_iterator i = locations.begin(); i != locations.end(); ++i) {
1798 location_added (*i);
1802 update_skips (NULL, false);
1806 Session::enable_record ()
1808 if (_transport_speed != 0.0 && _transport_speed != 1.0) {
1809 /* no recording at anything except normal speed */
1814 RecordState rs = (RecordState) g_atomic_int_get (&_record_status);
1816 if (rs == Recording) {
1820 if (g_atomic_int_compare_and_exchange (&_record_status, rs, Recording)) {
1822 _last_record_location = _transport_frame;
1823 send_immediate_mmc (MIDI::MachineControlCommand (MIDI::MachineControl::cmdRecordStrobe));
1825 if (Config->get_monitoring_model() == HardwareMonitoring && config.get_auto_input()) {
1826 set_track_monitor_input_status (true);
1829 RecordStateChanged ();
1836 Session::set_all_tracks_record_enabled (bool enable )
1838 boost::shared_ptr<RouteList> rl = routes.reader();
1839 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
1840 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
1842 tr->set_record_enabled (enable, Controllable::NoGroup);
1849 Session::disable_record (bool rt_context, bool force)
1853 if ((rs = (RecordState) g_atomic_int_get (&_record_status)) != Disabled) {
1855 if (!Config->get_latched_record_enable () || force) {
1856 g_atomic_int_set (&_record_status, Disabled);
1857 send_immediate_mmc (MIDI::MachineControlCommand (MIDI::MachineControl::cmdRecordExit));
1859 if (rs == Recording) {
1860 g_atomic_int_set (&_record_status, Enabled);
1864 if (Config->get_monitoring_model() == HardwareMonitoring && config.get_auto_input()) {
1865 set_track_monitor_input_status (false);
1868 RecordStateChanged (); /* emit signal */
1871 remove_pending_capture_state ();
1877 Session::step_back_from_record ()
1879 if (g_atomic_int_compare_and_exchange (&_record_status, Recording, Enabled)) {
1881 if (Config->get_monitoring_model() == HardwareMonitoring && config.get_auto_input()) {
1882 set_track_monitor_input_status (false);
1885 RecordStateChanged (); /* emit signal */
1890 Session::maybe_enable_record ()
1892 if (_step_editors > 0) {
1896 g_atomic_int_set (&_record_status, Enabled);
1898 /* This function is currently called from somewhere other than an RT thread.
1899 This save_state() call therefore doesn't impact anything. Doing it here
1900 means that we save pending state of which sources the next record will use,
1901 which gives us some chance of recovering from a crash during the record.
1904 save_state ("", true);
1906 if (_transport_speed) {
1907 if (!config.get_punch_in()) {
1911 send_immediate_mmc (MIDI::MachineControlCommand (MIDI::MachineControl::cmdRecordPause));
1912 RecordStateChanged (); /* EMIT SIGNAL */
1919 Session::audible_frame () const
1925 offset = worst_playback_latency ();
1927 if (synced_to_engine()) {
1928 /* Note: this is basically just sync-to-JACK */
1929 tf = _engine.transport_frame();
1931 tf = _transport_frame;
1936 if (!non_realtime_work_pending()) {
1940 /* Check to see if we have passed the first guaranteed
1941 audible frame past our last start position. if not,
1942 return that last start point because in terms
1943 of audible frames, we have not moved yet.
1945 `Start position' in this context means the time we last
1946 either started, located, or changed transport direction.
1949 if (_transport_speed > 0.0f) {
1951 if (!play_loop || !have_looped) {
1952 if (tf < _last_roll_or_reversal_location + offset) {
1953 return _last_roll_or_reversal_location;
1961 } else if (_transport_speed < 0.0f) {
1963 /* XXX wot? no backward looping? */
1965 if (tf > _last_roll_or_reversal_location - offset) {
1966 return _last_roll_or_reversal_location;
1978 Session::set_frame_rate (framecnt_t frames_per_second)
1980 /** \fn void Session::set_frame_size(framecnt_t)
1981 the AudioEngine object that calls this guarantees
1982 that it will not be called while we are also in
1983 ::process(). Its fine to do things that block
1987 _base_frame_rate = frames_per_second;
1988 _nominal_frame_rate = frames_per_second;
1993 reset_write_sources (false);
1995 // XXX we need some equivalent to this, somehow
1996 // SndFileSource::setup_standard_crossfades (frames_per_second);
2000 /* XXX need to reset/reinstantiate all LADSPA plugins */
2004 Session::set_block_size (pframes_t nframes)
2006 /* the AudioEngine guarantees
2007 that it will not be called while we are also in
2008 ::process(). It is therefore fine to do things that block
2013 current_block_size = nframes;
2017 boost::shared_ptr<RouteList> r = routes.reader ();
2019 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
2020 (*i)->set_block_size (nframes);
2023 boost::shared_ptr<RouteList> rl = routes.reader ();
2024 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
2025 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
2027 tr->set_block_size (nframes);
2031 set_worst_io_latencies ();
2037 trace_terminal (boost::shared_ptr<Route> r1, boost::shared_ptr<Route> rbase)
2039 boost::shared_ptr<Route> r2;
2041 if (r1->feeds (rbase) && rbase->feeds (r1)) {
2042 info << string_compose(_("feedback loop setup between %1 and %2"), r1->name(), rbase->name()) << endmsg;
2046 /* make a copy of the existing list of routes that feed r1 */
2048 Route::FedBy existing (r1->fed_by());
2050 /* for each route that feeds r1, recurse, marking it as feeding
2054 for (Route::FedBy::iterator i = existing.begin(); i != existing.end(); ++i) {
2055 if (!(r2 = i->r.lock ())) {
2056 /* (*i) went away, ignore it */
2060 /* r2 is a route that feeds r1 which somehow feeds base. mark
2061 base as being fed by r2
2064 rbase->add_fed_by (r2, i->sends_only);
2068 /* 2nd level feedback loop detection. if r1 feeds or is fed by r2,
2072 if (r1->feeds (r2) && r2->feeds (r1)) {
2076 /* now recurse, so that we can mark base as being fed by
2077 all routes that feed r2
2080 trace_terminal (r2, rbase);
2087 Session::resort_routes ()
2089 /* don't do anything here with signals emitted
2090 by Routes during initial setup or while we
2091 are being destroyed.
2094 if (_state_of_the_state & (InitialConnecting | Deletion)) {
2098 if (_route_deletion_in_progress) {
2103 RCUWriter<RouteList> writer (routes);
2104 boost::shared_ptr<RouteList> r = writer.get_copy ();
2105 resort_routes_using (r);
2106 /* writer goes out of scope and forces update */
2110 boost::shared_ptr<RouteList> rl = routes.reader ();
2111 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
2112 DEBUG_TRACE (DEBUG::Graph, string_compose ("%1 fed by ...\n", (*i)->name()));
2114 const Route::FedBy& fb ((*i)->fed_by());
2116 for (Route::FedBy::const_iterator f = fb.begin(); f != fb.end(); ++f) {
2117 boost::shared_ptr<Route> sf = f->r.lock();
2119 DEBUG_TRACE (DEBUG::Graph, string_compose ("\t%1 (sends only ? %2)\n", sf->name(), f->sends_only));
2127 /** This is called whenever we need to rebuild the graph of how we will process
2129 * @param r List of routes, in any order.
2133 Session::resort_routes_using (boost::shared_ptr<RouteList> r)
2135 /* We are going to build a directed graph of our routes;
2136 this is where the edges of that graph are put.
2141 /* Go through all routes doing two things:
2143 * 1. Collect the edges of the route graph. Each of these edges
2144 * is a pair of routes, one of which directly feeds the other
2145 * either by a JACK connection or by an internal send.
2147 * 2. Begin the process of making routes aware of which other
2148 * routes directly or indirectly feed them. This information
2149 * is used by the solo code.
2152 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
2154 /* Clear out the route's list of direct or indirect feeds */
2155 (*i)->clear_fed_by ();
2157 for (RouteList::iterator j = r->begin(); j != r->end(); ++j) {
2159 bool via_sends_only;
2161 /* See if this *j feeds *i according to the current state of the JACK
2162 connections and internal sends.
2164 if ((*j)->direct_feeds_according_to_reality (*i, &via_sends_only)) {
2165 /* add the edge to the graph (part #1) */
2166 edges.add (*j, *i, via_sends_only);
2167 /* tell the route (for part #2) */
2168 (*i)->add_fed_by (*j, via_sends_only);
2173 /* Attempt a topological sort of the route graph */
2174 boost::shared_ptr<RouteList> sorted_routes = topological_sort (r, edges);
2176 if (sorted_routes) {
2177 /* We got a satisfactory topological sort, so there is no feedback;
2180 Note: the process graph rechain does not require a
2181 topologically-sorted list, but hey ho.
2183 if (_process_graph) {
2184 _process_graph->rechain (sorted_routes, edges);
2187 _current_route_graph = edges;
2189 /* Complete the building of the routes' lists of what directly
2190 or indirectly feeds them.
2192 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
2193 trace_terminal (*i, *i);
2196 *r = *sorted_routes;
2199 DEBUG_TRACE (DEBUG::Graph, "Routes resorted, order follows:\n");
2200 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
2201 DEBUG_TRACE (DEBUG::Graph, string_compose ("\t%1 signal order %2\n",
2202 (*i)->name(), (*i)->order_key ()));
2206 SuccessfulGraphSort (); /* EMIT SIGNAL */
2209 /* The topological sort failed, so we have a problem. Tell everyone
2210 and stick to the old graph; this will continue to be processed, so
2211 until the feedback is fixed, what is played back will not quite
2212 reflect what is actually connected. Note also that we do not
2213 do trace_terminal here, as it would fail due to an endless recursion,
2214 so the solo code will think that everything is still connected
2218 FeedbackDetected (); /* EMIT SIGNAL */
2223 /** Find a route name starting with \a base, maybe followed by the
2224 * lowest \a id. \a id will always be added if \a definitely_add_number
2225 * is true on entry; otherwise it will only be added if required
2226 * to make the name unique.
2228 * Names are constructed like e.g. "Audio 3" for base="Audio" and id=3.
2229 * The available route name with the lowest ID will be used, and \a id
2230 * will be set to the ID.
2232 * \return false if a route name could not be found, and \a track_name
2233 * and \a id do not reflect a free route name.
2236 Session::find_route_name (string const & base, uint32_t& id, string& name, bool definitely_add_number)
2238 /* the base may conflict with ports that do not belong to existing
2239 routes, but hidden objects like the click track. So check port names
2240 before anything else.
2243 for (vector<string>::const_iterator reserved = reserved_io_names.begin(); reserved != reserved_io_names.end(); ++reserved) {
2244 if (base == *reserved) {
2245 /* Check if this reserved name already exists, and if
2246 so, disallow it without a numeric suffix.
2248 if (route_by_name (*reserved)) {
2249 definitely_add_number = true;
2258 if (!definitely_add_number && route_by_name (base) == 0) {
2259 /* juse use the base */
2265 name = string_compose ("%1 %2", base, id);
2267 if (route_by_name (name) == 0) {
2273 } while (id < (UINT_MAX-1));
2278 /** Count the total ins and outs of all non-hidden tracks in the session and return them in in and out */
2280 Session::count_existing_track_channels (ChanCount& in, ChanCount& out)
2282 in = ChanCount::ZERO;
2283 out = ChanCount::ZERO;
2285 boost::shared_ptr<RouteList> r = routes.reader ();
2287 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
2288 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
2289 if (tr && !tr->is_auditioner()) {
2290 in += tr->n_inputs();
2291 out += tr->n_outputs();
2297 Session::default_track_name_pattern (DataType t)
2300 case DataType::AUDIO:
2301 if (Profile->get_trx()) {
2308 case DataType::MIDI:
2315 /** Caller must not hold process lock
2316 * @param name_template string to use for the start of the name, or "" to use "MIDI".
2317 * @param instrument plugin info for the instrument to insert pre-fader, if any
2319 list<boost::shared_ptr<MidiTrack> >
2320 Session::new_midi_track (const ChanCount& input, const ChanCount& output, boost::shared_ptr<PluginInfo> instrument,
2321 TrackMode mode, RouteGroup* route_group, uint32_t how_many, string name_template)
2324 uint32_t track_id = 0;
2326 RouteList new_routes;
2327 list<boost::shared_ptr<MidiTrack> > ret;
2329 const string name_pattern = default_track_name_pattern (DataType::MIDI);
2330 bool const use_number = (how_many != 1) || name_template.empty () || (name_template == name_pattern);
2333 if (!find_route_name (name_template.empty() ? _("MIDI") : name_template, ++track_id, track_name, use_number)) {
2334 error << "cannot find name for new midi track" << endmsg;
2338 boost::shared_ptr<MidiTrack> track;
2341 track.reset (new MidiTrack (*this, track_name, Route::Flag (0), mode));
2343 if (track->init ()) {
2347 track->use_new_diskstream();
2349 #ifdef BOOST_SP_ENABLE_DEBUG_HOOKS
2350 // boost_debug_shared_ptr_mark_interesting (track.get(), "Track");
2353 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
2354 if (track->input()->ensure_io (input, false, this)) {
2355 error << "cannot configure " << input << " out configuration for new midi track" << endmsg;
2359 if (track->output()->ensure_io (output, false, this)) {
2360 error << "cannot configure " << output << " out configuration for new midi track" << endmsg;
2365 track->non_realtime_input_change();
2368 route_group->add (track);
2371 track->DiskstreamChanged.connect_same_thread (*this, boost::bind (&Session::resort_routes, this));
2373 if (Config->get_remote_model() == UserOrdered) {
2374 track->set_remote_control_id (next_control_id());
2377 new_routes.push_back (track);
2378 ret.push_back (track);
2380 RouteAddedOrRemoved (true); /* EMIT SIGNAL */
2383 catch (failed_constructor &err) {
2384 error << _("Session: could not create new midi track.") << endmsg;
2388 catch (AudioEngine::PortRegistrationFailure& pfe) {
2390 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;
2398 if (!new_routes.empty()) {
2399 StateProtector sp (this);
2400 if (Profile->get_trx()) {
2401 add_routes (new_routes, false, false, false);
2403 add_routes (new_routes, true, true, false);
2407 for (RouteList::iterator r = new_routes.begin(); r != new_routes.end(); ++r) {
2408 PluginPtr plugin = instrument->load (*this);
2409 boost::shared_ptr<Processor> p (new PluginInsert (*this, plugin));
2410 (*r)->add_processor (p, PreFader);
2420 Session::midi_output_change_handler (IOChange change, void * /*src*/, boost::weak_ptr<Route> wmt)
2422 boost::shared_ptr<Route> midi_track (wmt.lock());
2428 if ((change.type & IOChange::ConfigurationChanged) && Config->get_output_auto_connect() != ManualConnect) {
2430 if (change.after.n_audio() <= change.before.n_audio()) {
2434 /* new audio ports: make sure the audio goes somewhere useful,
2435 unless the user has no-auto-connect selected.
2437 The existing ChanCounts don't matter for this call as they are only
2438 to do with matching input and output indices, and we are only changing
2444 auto_connect_route (midi_track, dummy, dummy, false, false, ChanCount(), change.before);
2448 /** @param connect_inputs true to connect inputs as well as outputs, false to connect just outputs.
2449 * @param input_start Where to start from when auto-connecting inputs; e.g. if this is 0, auto-connect starting from input 0.
2450 * @param output_start As \a input_start, but for outputs.
2453 Session::auto_connect_route (boost::shared_ptr<Route> route, ChanCount& existing_inputs, ChanCount& existing_outputs,
2454 bool with_lock, bool connect_inputs, ChanCount input_start, ChanCount output_start)
2456 if (!IO::connecting_legal) {
2460 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock (), Glib::Threads::NOT_LOCK);
2466 /* If both inputs and outputs are auto-connected to physical ports,
2467 use the max of input and output offsets to ensure auto-connected
2468 port numbers always match up (e.g. the first audio input and the
2469 first audio output of the route will have the same physical
2470 port number). Otherwise just use the lowest input or output
2474 DEBUG_TRACE (DEBUG::Graph,
2475 string_compose("Auto-connect: existing in = %1 out = %2\n",
2476 existing_inputs, existing_outputs));
2478 const bool in_out_physical =
2479 (Config->get_input_auto_connect() & AutoConnectPhysical)
2480 && (Config->get_output_auto_connect() & AutoConnectPhysical)
2483 const ChanCount in_offset = in_out_physical
2484 ? ChanCount::max(existing_inputs, existing_outputs)
2487 const ChanCount out_offset = in_out_physical
2488 ? ChanCount::max(existing_inputs, existing_outputs)
2491 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
2492 vector<string> physinputs;
2493 vector<string> physoutputs;
2495 _engine.get_physical_outputs (*t, physoutputs);
2496 _engine.get_physical_inputs (*t, physinputs);
2498 if (!physinputs.empty() && connect_inputs) {
2499 uint32_t nphysical_in = physinputs.size();
2501 DEBUG_TRACE (DEBUG::Graph,
2502 string_compose("There are %1 physical inputs of type %2\n",
2505 for (uint32_t i = input_start.get(*t); i < route->n_inputs().get(*t) && i < nphysical_in; ++i) {
2508 if (Config->get_input_auto_connect() & AutoConnectPhysical) {
2509 DEBUG_TRACE (DEBUG::Graph,
2510 string_compose("Get index %1 + %2 % %3 = %4\n",
2511 in_offset.get(*t), i, nphysical_in,
2512 (in_offset.get(*t) + i) % nphysical_in));
2513 port = physinputs[(in_offset.get(*t) + i) % nphysical_in];
2516 DEBUG_TRACE (DEBUG::Graph,
2517 string_compose("Connect route %1 IN to %2\n",
2518 route->name(), port));
2520 if (!port.empty() && route->input()->connect (route->input()->ports().port(*t, i), port, this)) {
2524 ChanCount one_added (*t, 1);
2525 existing_inputs += one_added;
2529 if (!physoutputs.empty()) {
2530 uint32_t nphysical_out = physoutputs.size();
2531 for (uint32_t i = output_start.get(*t); i < route->n_outputs().get(*t); ++i) {
2535 * do not create new connections if we reached the limit of physical outputs
2539 if (!(Config->get_output_auto_connect() & AutoConnectMaster) &&
2540 ARDOUR::Profile->get_trx () &&
2541 existing_outputs.get(*t) == nphysical_out ) {
2545 if ((*t) == DataType::MIDI && (Config->get_output_auto_connect() & AutoConnectPhysical)) {
2546 port = physoutputs[(out_offset.get(*t) + i) % nphysical_out];
2547 } else if ((*t) == DataType::AUDIO && (Config->get_output_auto_connect() & AutoConnectMaster)) {
2548 /* master bus is audio only */
2549 if (_master_out && _master_out->n_inputs().get(*t) > 0) {
2550 port = _master_out->input()->ports().port(*t,
2551 i % _master_out->input()->n_ports().get(*t))->name();
2555 DEBUG_TRACE (DEBUG::Graph,
2556 string_compose("Connect route %1 OUT to %2\n",
2557 route->name(), port));
2559 if (!port.empty() && route->output()->connect (route->output()->ports().port(*t, i), port, this)) {
2563 ChanCount one_added (*t, 1);
2564 existing_outputs += one_added;
2570 #ifdef USE_TRACKS_CODE_FEATURES
2573 compare_routes_by_remote_id (const boost::shared_ptr<Route>& route1, const boost::shared_ptr<Route>& route2)
2575 return route1->remote_control_id() < route2->remote_control_id();
2579 Session::reconnect_existing_routes (bool withLock, bool reconnect_master, bool reconnect_inputs, bool reconnect_outputs)
2581 // it is not allowed to perform connection
2582 if (!IO::connecting_legal) {
2586 // if we are deleting routes we will call this once at the end
2587 if (_route_deletion_in_progress) {
2591 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock (), Glib::Threads::NOT_LOCK);
2597 // We need to disconnect the route's inputs and outputs first
2598 // basing on autoconnect configuration
2599 bool reconnectIputs = !(Config->get_input_auto_connect() & ManualConnect) && reconnect_inputs;
2600 bool reconnectOutputs = !(Config->get_output_auto_connect() & ManualConnect) && reconnect_outputs;
2602 ChanCount existing_inputs;
2603 ChanCount existing_outputs;
2604 count_existing_track_channels (existing_inputs, existing_outputs);
2606 //ChanCount inputs = ChanCount::ZERO;
2607 //ChanCount outputs = ChanCount::ZERO;
2609 RouteList existing_routes = *routes.reader ();
2610 existing_routes.sort (compare_routes_by_remote_id);
2613 PBD::Unwinder<bool> protect_ignore_changes (_reconnecting_routes_in_progress, true);
2615 vector<string> physinputs;
2616 vector<string> physoutputs;
2618 EngineStateController::instance()->get_physical_audio_outputs(physoutputs);
2619 EngineStateController::instance()->get_physical_audio_inputs(physinputs);
2621 uint32_t input_n = 0;
2622 uint32_t output_n = 0;
2623 RouteList::iterator rIter = existing_routes.begin();
2624 const AutoConnectOption current_input_auto_connection (Config->get_input_auto_connect());
2625 const AutoConnectOption current_output_auto_connection (Config->get_output_auto_connect());
2626 for (; rIter != existing_routes.end(); ++rIter) {
2627 if (*rIter == _master_out || *rIter == _monitor_out ) {
2631 if (current_output_auto_connection == AutoConnectPhysical) {
2632 (*rIter)->amp()->deactivate();
2633 } else if (current_output_auto_connection == AutoConnectMaster) {
2634 (*rIter)->amp()->activate();
2637 if (reconnectIputs) {
2638 (*rIter)->input()->disconnect (this); //GZ: check this; could be heavy
2640 for (uint32_t route_input_n = 0; route_input_n < (*rIter)->n_inputs().get(DataType::AUDIO); ++route_input_n) {
2642 if (current_input_auto_connection & AutoConnectPhysical) {
2644 if ( input_n == physinputs.size() ) {
2648 string port = physinputs[input_n];
2650 if (port.empty() ) {
2651 error << "Physical Input number "<< input_n << " is unavailable and cannot be connected" << endmsg;
2654 //GZ: check this; could be heavy
2655 (*rIter)->input()->connect ((*rIter)->input()->ports().port(DataType::AUDIO, route_input_n), port, this);
2661 if (reconnectOutputs) {
2663 //normalize route ouptuts: reduce the amount outputs to be equal to the amount of inputs
2664 if (current_output_auto_connection & AutoConnectPhysical) {
2666 //GZ: check this; could be heavy
2667 (*rIter)->output()->disconnect (this);
2668 size_t route_inputs_count = (*rIter)->n_inputs().get(DataType::AUDIO);
2670 //GZ: check this; could be heavy
2671 (*rIter)->output()->ensure_io(ChanCount(DataType::AUDIO, route_inputs_count), false, this );
2673 } else if (current_output_auto_connection & AutoConnectMaster){
2675 if (!reconnect_master) {
2679 //GZ: check this; could be heavy
2680 (*rIter)->output()->disconnect (this);
2683 uint32_t master_inputs_count = _master_out->n_inputs().get(DataType::AUDIO);
2684 (*rIter)->output()->ensure_io(ChanCount(DataType::AUDIO, master_inputs_count), false, this );
2686 error << error << "Master bus is not available" << endmsg;
2691 for (uint32_t route_output_n = 0; route_output_n < (*rIter)->n_outputs().get(DataType::AUDIO); ++route_output_n) {
2692 if (current_output_auto_connection & AutoConnectPhysical) {
2694 if ( output_n == physoutputs.size() ) {
2698 string port = physoutputs[output_n];
2700 if (port.empty() ) {
2701 error << "Physical Output number "<< output_n << " is unavailable and cannot be connected" << endmsg;
2704 //GZ: check this; could be heavy
2705 (*rIter)->output()->connect ((*rIter)->output()->ports().port(DataType::AUDIO, route_output_n), port, this);
2708 } else if (current_output_auto_connection & AutoConnectMaster) {
2710 if ( route_output_n == _master_out->n_inputs().get(DataType::AUDIO) ) {
2714 // connect to master bus
2715 string port = _master_out->input()->ports().port(DataType::AUDIO, route_output_n)->name();
2717 if (port.empty() ) {
2718 error << "MasterBus Input number "<< route_output_n << " is unavailable and cannot be connected" << endmsg;
2722 //GZ: check this; could be heavy
2723 (*rIter)->output()->connect ((*rIter)->output()->ports().port(DataType::AUDIO, route_output_n), port, this);
2729 //auto_connect_route (*rIter, inputs, outputs, false, reconnectIputs);
2732 _master_out->output()->disconnect (this);
2733 auto_connect_master_bus ();
2738 session_routes_reconnected (); /* EMIT SIGNAL */
2742 Session::reconnect_midi_scene_ports(bool inputs)
2746 boost::shared_ptr<MidiPort> scene_in_ptr = scene_in();
2748 scene_in_ptr->disconnect_all ();
2750 std::vector<EngineStateController::MidiPortState> midi_port_states;
2751 EngineStateController::instance()->get_physical_midi_input_states (midi_port_states);
2753 std::vector<EngineStateController::MidiPortState>::iterator state_iter = midi_port_states.begin();
2755 for (; state_iter != midi_port_states.end(); ++state_iter) {
2756 if (state_iter->active && state_iter->available && state_iter->scene_connected) {
2757 scene_in_ptr->connect (state_iter->name);
2764 boost::shared_ptr<MidiPort> scene_out_ptr = scene_out();
2766 if (scene_out_ptr ) {
2767 scene_out_ptr->disconnect_all ();
2769 std::vector<EngineStateController::MidiPortState> midi_port_states;
2770 EngineStateController::instance()->get_physical_midi_output_states (midi_port_states);
2772 std::vector<EngineStateController::MidiPortState>::iterator state_iter = midi_port_states.begin();
2774 for (; state_iter != midi_port_states.end(); ++state_iter) {
2775 if (state_iter->active && state_iter->available && state_iter->scene_connected) {
2776 scene_out_ptr->connect (state_iter->name);
2784 Session::reconnect_mtc_ports ()
2786 boost::shared_ptr<MidiPort> mtc_in_ptr = _midi_ports->mtc_input_port();
2792 mtc_in_ptr->disconnect_all ();
2794 std::vector<EngineStateController::MidiPortState> midi_port_states;
2795 EngineStateController::instance()->get_physical_midi_input_states (midi_port_states);
2797 std::vector<EngineStateController::MidiPortState>::iterator state_iter = midi_port_states.begin();
2799 for (; state_iter != midi_port_states.end(); ++state_iter) {
2800 if (state_iter->available && state_iter->mtc_in) {
2801 mtc_in_ptr->connect (state_iter->name);
2805 if (!_midi_ports->mtc_input_port ()->connected () &&
2806 config.get_external_sync () &&
2807 (Config->get_sync_source () == MTC) ) {
2808 config.set_external_sync (false);
2811 if ( ARDOUR::Profile->get_trx () ) {
2812 // Tracks need this signal to update timecode_source_dropdown
2813 MtcOrLtcInputPortChanged (); //emit signal
2818 Session::reconnect_mmc_ports(bool inputs)
2820 if (inputs ) { // get all enabled midi input ports
2822 boost::shared_ptr<MidiPort> mmc_in_ptr = _midi_ports->mmc_in();
2824 mmc_in_ptr->disconnect_all ();
2825 std::vector<std::string> enabled_midi_inputs;
2826 EngineStateController::instance()->get_physical_midi_inputs (enabled_midi_inputs);
2828 std::vector<std::string>::iterator port_iter = enabled_midi_inputs.begin();
2830 for (; port_iter != enabled_midi_inputs.end(); ++port_iter) {
2831 mmc_in_ptr->connect (*port_iter);
2835 } else { // get all enabled midi output ports
2837 boost::shared_ptr<MidiPort> mmc_out_ptr = _midi_ports->mmc_out();
2839 mmc_out_ptr->disconnect_all ();
2840 std::vector<std::string> enabled_midi_outputs;
2841 EngineStateController::instance()->get_physical_midi_outputs (enabled_midi_outputs);
2843 std::vector<std::string>::iterator port_iter = enabled_midi_outputs.begin();
2845 for (; port_iter != enabled_midi_outputs.end(); ++port_iter) {
2846 mmc_out_ptr->connect (*port_iter);
2854 /** Caller must not hold process lock
2855 * @param name_template string to use for the start of the name, or "" to use "Audio".
2857 list< boost::shared_ptr<AudioTrack> >
2858 Session::new_audio_track (int input_channels, int output_channels, TrackMode mode, RouteGroup* route_group,
2859 uint32_t how_many, string name_template)
2862 uint32_t track_id = 0;
2864 RouteList new_routes;
2865 list<boost::shared_ptr<AudioTrack> > ret;
2867 const string name_pattern = default_track_name_pattern (DataType::AUDIO);
2868 bool const use_number = (how_many != 1) || name_template.empty () || (name_template == name_pattern);
2872 if (!find_route_name (name_template.empty() ? _(name_pattern.c_str()) : name_template, ++track_id, track_name, use_number)) {
2873 error << "cannot find name for new audio track" << endmsg;
2877 boost::shared_ptr<AudioTrack> track;
2880 track.reset (new AudioTrack (*this, track_name, Route::Flag (0), mode));
2882 if (track->init ()) {
2886 if (ARDOUR::Profile->get_trx ()) {
2887 // TRACKS considers it's not a USE CASE, it's
2888 // a piece of behavior of the session model:
2890 // Gain for a newly created route depends on
2891 // the current output_auto_connect mode:
2893 // 0 for Stereo Out mode
2895 if (Config->get_output_auto_connect() & AutoConnectMaster) {
2896 track->set_gain (dB_to_coefficient (0), Controllable::NoGroup);
2900 track->use_new_diskstream();
2902 #ifdef BOOST_SP_ENABLE_DEBUG_HOOKS
2903 // boost_debug_shared_ptr_mark_interesting (track.get(), "Track");
2906 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
2908 if (track->input()->ensure_io (ChanCount(DataType::AUDIO, input_channels), false, this)) {
2909 error << string_compose (
2910 _("cannot configure %1 in/%2 out configuration for new audio track"),
2911 input_channels, output_channels)
2916 if (track->output()->ensure_io (ChanCount(DataType::AUDIO, output_channels), false, this)) {
2917 error << string_compose (
2918 _("cannot configure %1 in/%2 out configuration for new audio track"),
2919 input_channels, output_channels)
2926 route_group->add (track);
2929 track->non_realtime_input_change();
2931 track->DiskstreamChanged.connect_same_thread (*this, boost::bind (&Session::resort_routes, this));
2932 if (Config->get_remote_model() == UserOrdered) {
2933 track->set_remote_control_id (next_control_id());
2936 new_routes.push_back (track);
2937 ret.push_back (track);
2939 RouteAddedOrRemoved (true); /* EMIT SIGNAL */
2942 catch (failed_constructor &err) {
2943 error << _("Session: could not create new audio track.") << endmsg;
2947 catch (AudioEngine::PortRegistrationFailure& pfe) {
2949 error << pfe.what() << endmsg;
2957 if (!new_routes.empty()) {
2958 StateProtector sp (this);
2959 if (Profile->get_trx()) {
2960 add_routes (new_routes, false, false, false);
2962 add_routes (new_routes, true, true, false);
2969 /** Caller must not hold process lock.
2970 * @param name_template string to use for the start of the name, or "" to use "Bus".
2973 Session::new_audio_route (int input_channels, int output_channels, RouteGroup* route_group, uint32_t how_many, string name_template)
2976 uint32_t bus_id = 0;
2980 bool const use_number = (how_many != 1) || name_template.empty () || name_template == _("Bus");
2983 if (!find_route_name (name_template.empty () ? _("Bus") : name_template, ++bus_id, bus_name, use_number)) {
2984 error << "cannot find name for new audio bus" << endmsg;
2989 boost::shared_ptr<Route> bus (new Route (*this, bus_name, Route::Flag(0), DataType::AUDIO));
2995 #ifdef BOOST_SP_ENABLE_DEBUG_HOOKS
2996 // boost_debug_shared_ptr_mark_interesting (bus.get(), "Route");
2999 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
3001 if (bus->input()->ensure_io (ChanCount(DataType::AUDIO, input_channels), false, this)) {
3002 error << string_compose (_("cannot configure %1 in/%2 out configuration for new audio track"),
3003 input_channels, output_channels)
3009 if (bus->output()->ensure_io (ChanCount(DataType::AUDIO, output_channels), false, this)) {
3010 error << string_compose (_("cannot configure %1 in/%2 out configuration for new audio track"),
3011 input_channels, output_channels)
3018 route_group->add (bus);
3020 if (Config->get_remote_model() == UserOrdered) {
3021 bus->set_remote_control_id (next_control_id());
3024 bus->add_internal_return ();
3026 ret.push_back (bus);
3028 RouteAddedOrRemoved (true); /* EMIT SIGNAL */
3034 catch (failed_constructor &err) {
3035 error << _("Session: could not create new audio route.") << endmsg;
3039 catch (AudioEngine::PortRegistrationFailure& pfe) {
3040 error << pfe.what() << endmsg;
3050 StateProtector sp (this);
3051 if (Profile->get_trx()) {
3052 add_routes (ret, false, false, false);
3054 add_routes (ret, false, true, true); // autoconnect // outputs only
3063 Session::new_route_from_template (uint32_t how_many, const std::string& template_path, const std::string& name_base, PlaylistDisposition pd)
3067 if (!tree.read (template_path.c_str())) {
3071 return new_route_from_template (how_many, *tree.root(), name_base, pd);
3075 Session::new_route_from_template (uint32_t how_many, XMLNode& node, const std::string& name_base, PlaylistDisposition pd)
3078 uint32_t control_id;
3079 uint32_t number = 0;
3080 const uint32_t being_added = how_many;
3081 /* This will prevent the use of any existing XML-provided PBD::ID
3084 Stateful::ForceIDRegeneration force_ids;
3085 IO::disable_connecting ();
3087 control_id = next_control_id ();
3091 /* We're going to modify the node contents a bit so take a
3092 * copy. The node may be re-used when duplicating more than once.
3095 XMLNode node_copy (node);
3100 if (!name_base.empty()) {
3102 /* if we're adding more than one routes, force
3103 * all the names of the new routes to be
3104 * numbered, via the final parameter.
3107 if (!find_route_name (name_base.c_str(), ++number, name, (being_added > 1))) {
3108 fatal << _("Session: UINT_MAX routes? impossible!") << endmsg;
3114 string const route_name = node_copy.property(X_("name"))->value ();
3116 /* generate a new name by adding a number to the end of the template name */
3117 if (!find_route_name (route_name.c_str(), ++number, name, true)) {
3118 fatal << _("Session: UINT_MAX routes? impossible!") << endmsg;
3119 abort(); /*NOTREACHED*/
3123 /* set this name in the XML description that we are about to use */
3125 bool rename_playlist;
3128 rename_playlist = true;
3132 rename_playlist = false;
3135 Route::set_name_in_state (node_copy, name, rename_playlist);
3137 /* trim bitslots from listen sends so that new ones are used */
3138 XMLNodeList children = node_copy.children ();
3139 for (XMLNodeList::iterator i = children.begin(); i != children.end(); ++i) {
3140 if ((*i)->name() == X_("Processor")) {
3141 XMLProperty* role = (*i)->property (X_("role"));
3142 if (role && role->value() == X_("Listen")) {
3143 (*i)->remove_property (X_("bitslot"));
3148 boost::shared_ptr<Route> route (XMLRouteFactory (node_copy, 3000));
3151 error << _("Session: cannot create track/bus from template description") << endmsg;
3155 if (boost::dynamic_pointer_cast<Track>(route)) {
3156 /* force input/output change signals so that the new diskstream
3157 picks up the configuration of the route. During session
3158 loading this normally happens in a different way.
3161 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
3163 IOChange change (IOChange::Type (IOChange::ConfigurationChanged | IOChange::ConnectionsChanged));
3164 change.after = route->input()->n_ports();
3165 route->input()->changed (change, this);
3166 change.after = route->output()->n_ports();
3167 route->output()->changed (change, this);
3170 route->set_remote_control_id (control_id);
3173 boost::shared_ptr<Track> track;
3175 if ((track = boost::dynamic_pointer_cast<Track> (route))) {
3178 track->use_new_playlist ();
3181 track->use_copy_playlist ();
3188 ret.push_back (route);
3190 RouteAddedOrRemoved (true); /* EMIT SIGNAL */
3193 catch (failed_constructor &err) {
3194 error << _("Session: could not create new route from template") << endmsg;
3198 catch (AudioEngine::PortRegistrationFailure& pfe) {
3199 error << pfe.what() << endmsg;
3208 StateProtector sp (this);
3209 if (Profile->get_trx()) {
3210 add_routes (ret, false, false, false);
3212 add_routes (ret, true, true, false);
3214 IO::enable_connecting ();
3221 Session::add_routes (RouteList& new_routes, bool input_auto_connect, bool output_auto_connect, bool save)
3224 PBD::Unwinder<bool> aip (_adding_routes_in_progress, true);
3225 add_routes_inner (new_routes, input_auto_connect, output_auto_connect);
3228 error << _("Adding new tracks/busses failed") << endmsg;
3233 update_latency (true);
3234 update_latency (false);
3239 save_state (_current_snapshot_name);
3242 reassign_track_numbers();
3244 update_route_record_state ();
3246 RouteAdded (new_routes); /* EMIT SIGNAL */
3250 Session::add_routes_inner (RouteList& new_routes, bool input_auto_connect, bool output_auto_connect)
3252 ChanCount existing_inputs;
3253 ChanCount existing_outputs;
3254 uint32_t order = next_control_id();
3256 if (_order_hint > -1) {
3257 order = _order_hint;
3261 count_existing_track_channels (existing_inputs, existing_outputs);
3264 RCUWriter<RouteList> writer (routes);
3265 boost::shared_ptr<RouteList> r = writer.get_copy ();
3266 r->insert (r->end(), new_routes.begin(), new_routes.end());
3268 /* if there is no control out and we're not in the middle of loading,
3269 resort the graph here. if there is a control out, we will resort
3270 toward the end of this method. if we are in the middle of loading,
3271 we will resort when done.
3274 if (!_monitor_out && IO::connecting_legal) {
3275 resort_routes_using (r);
3279 for (RouteList::iterator x = new_routes.begin(); x != new_routes.end(); ++x) {
3281 boost::weak_ptr<Route> wpr (*x);
3282 boost::shared_ptr<Route> r (*x);
3284 r->listen_changed.connect_same_thread (*this, boost::bind (&Session::route_listen_changed, this, _1, wpr));
3285 r->solo_changed.connect_same_thread (*this, boost::bind (&Session::route_solo_changed, this, _1, _2, wpr));
3286 r->solo_isolated_changed.connect_same_thread (*this, boost::bind (&Session::route_solo_isolated_changed, this, wpr));
3287 r->mute_changed.connect_same_thread (*this, boost::bind (&Session::route_mute_changed, this));
3288 r->output()->changed.connect_same_thread (*this, boost::bind (&Session::set_worst_io_latencies_x, this, _1, _2));
3289 r->processors_changed.connect_same_thread (*this, boost::bind (&Session::route_processors_changed, this, _1));
3291 if (r->is_master()) {
3295 if (r->is_monitor()) {
3299 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (r);
3301 tr->PlaylistChanged.connect_same_thread (*this, boost::bind (&Session::track_playlist_changed, this, boost::weak_ptr<Track> (tr)));
3302 track_playlist_changed (boost::weak_ptr<Track> (tr));
3303 tr->RecordEnableChanged.connect_same_thread (*this, boost::bind (&Session::update_route_record_state, this));
3305 boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (tr);
3307 mt->StepEditStatusChange.connect_same_thread (*this, boost::bind (&Session::step_edit_status_change, this, _1));
3308 mt->output()->changed.connect_same_thread (*this, boost::bind (&Session::midi_output_change_handler, this, _1, _2, boost::weak_ptr<Route>(mt)));
3313 if (input_auto_connect || output_auto_connect) {
3314 auto_connect_route (r, existing_inputs, existing_outputs, true, input_auto_connect);
3317 /* order keys are a GUI responsibility but we need to set up
3318 reasonable defaults because they also affect the remote control
3319 ID in most situations.
3322 if (!r->has_order_key ()) {
3323 if (r->is_auditioner()) {
3324 /* use an arbitrarily high value */
3325 r->set_order_key (UINT_MAX);
3327 DEBUG_TRACE (DEBUG::OrderKeys, string_compose ("while adding, set %1 to order key %2\n", r->name(), order));
3328 r->set_order_key (order);
3336 if (_monitor_out && IO::connecting_legal) {
3337 Glib::Threads::Mutex::Lock lm (_engine.process_lock());
3339 for (RouteList::iterator x = new_routes.begin(); x != new_routes.end(); ++x) {
3340 if ((*x)->is_monitor()) {
3342 } else if ((*x)->is_master()) {
3345 (*x)->enable_monitor_send ();
3352 Session::globally_set_send_gains_to_zero (boost::shared_ptr<Route> dest)
3354 boost::shared_ptr<RouteList> r = routes.reader ();
3355 boost::shared_ptr<Send> s;
3357 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3358 if ((s = (*i)->internal_send_for (dest)) != 0) {
3359 s->amp()->gain_control()->set_value (GAIN_COEFF_ZERO, Controllable::NoGroup);
3365 Session::globally_set_send_gains_to_unity (boost::shared_ptr<Route> dest)
3367 boost::shared_ptr<RouteList> r = routes.reader ();
3368 boost::shared_ptr<Send> s;
3370 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3371 if ((s = (*i)->internal_send_for (dest)) != 0) {
3372 s->amp()->gain_control()->set_value (GAIN_COEFF_UNITY, Controllable::NoGroup);
3378 Session::globally_set_send_gains_from_track(boost::shared_ptr<Route> dest)
3380 boost::shared_ptr<RouteList> r = routes.reader ();
3381 boost::shared_ptr<Send> s;
3383 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3384 if ((s = (*i)->internal_send_for (dest)) != 0) {
3385 s->amp()->gain_control()->set_value ((*i)->gain_control()->get_value(), Controllable::NoGroup);
3390 /** @param include_buses true to add sends to buses and tracks, false for just tracks */
3392 Session::globally_add_internal_sends (boost::shared_ptr<Route> dest, Placement p, bool include_buses)
3394 boost::shared_ptr<RouteList> r = routes.reader ();
3395 boost::shared_ptr<RouteList> t (new RouteList);
3397 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3398 /* no MIDI sends because there are no MIDI busses yet */
3399 if (include_buses || boost::dynamic_pointer_cast<AudioTrack>(*i)) {
3404 add_internal_sends (dest, p, t);
3408 Session::add_internal_sends (boost::shared_ptr<Route> dest, Placement p, boost::shared_ptr<RouteList> senders)
3410 for (RouteList::iterator i = senders->begin(); i != senders->end(); ++i) {
3411 add_internal_send (dest, (*i)->before_processor_for_placement (p), *i);
3416 Session::add_internal_send (boost::shared_ptr<Route> dest, int index, boost::shared_ptr<Route> sender)
3418 add_internal_send (dest, sender->before_processor_for_index (index), sender);
3422 Session::add_internal_send (boost::shared_ptr<Route> dest, boost::shared_ptr<Processor> before, boost::shared_ptr<Route> sender)
3424 if (sender->is_monitor() || sender->is_master() || sender == dest || dest->is_monitor() || dest->is_master()) {
3428 if (!dest->internal_return()) {
3429 dest->add_internal_return ();
3432 sender->add_aux_send (dest, before);
3439 Session::remove_routes (boost::shared_ptr<RouteList> routes_to_remove)
3441 { // RCU Writer scope
3442 PBD::Unwinder<bool> uw_flag (_route_deletion_in_progress, true);
3443 RCUWriter<RouteList> writer (routes);
3444 boost::shared_ptr<RouteList> rs = writer.get_copy ();
3447 for (RouteList::iterator iter = routes_to_remove->begin(); iter != routes_to_remove->end(); ++iter) {
3449 if (*iter == _master_out) {
3453 (*iter)->set_solo (false, Controllable::NoGroup);
3457 /* deleting the master out seems like a dumb
3458 idea, but its more of a UI policy issue
3462 if (*iter == _master_out) {
3463 _master_out = boost::shared_ptr<Route> ();
3466 if (*iter == _monitor_out) {
3467 _monitor_out.reset ();
3470 // We need to disconnect the route's inputs and outputs
3472 (*iter)->input()->disconnect (0);
3473 (*iter)->output()->disconnect (0);
3475 /* if the route had internal sends sending to it, remove them */
3476 if ((*iter)->internal_return()) {
3478 boost::shared_ptr<RouteList> r = routes.reader ();
3479 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3480 boost::shared_ptr<Send> s = (*i)->internal_send_for (*iter);
3482 (*i)->remove_processor (s);
3487 /* if the monitoring section had a pointer to this route, remove it */
3488 if (_monitor_out && !(*iter)->is_master() && !(*iter)->is_monitor()) {
3489 Glib::Threads::Mutex::Lock lm (AudioEngine::instance()->process_lock ());
3490 PBD::Unwinder<bool> uw (ignore_route_processor_changes, true);
3491 (*iter)->remove_aux_or_listen (_monitor_out);
3494 boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (*iter);
3495 if (mt && mt->step_editing()) {
3496 if (_step_editors > 0) {
3502 /* writer goes out of scope, forces route list update */
3504 } // end of RCU Writer scope
3506 update_route_solo_state ();
3507 RouteAddedOrRemoved (false); /* EMIT SIGNAL */
3508 update_latency_compensation ();
3511 /* Re-sort routes to remove the graph's current references to the one that is
3512 * going away, then flush old references out of the graph.
3513 * Wave Tracks: reconnect routes
3516 #ifdef USE_TRACKS_CODE_FEATURES
3517 reconnect_existing_routes(true, false);
3519 routes.flush (); // maybe unsafe, see below.
3523 if (_process_graph) {
3524 _process_graph->clear_other_chain ();
3527 /* get rid of it from the dead wood collection in the route list manager */
3528 /* XXX i think this is unsafe as it currently stands, but i am not sure. (pd, october 2nd, 2006) */
3532 /* try to cause everyone to drop their references
3533 * and unregister ports from the backend
3536 for (RouteList::iterator iter = routes_to_remove->begin(); iter != routes_to_remove->end(); ++iter) {
3537 (*iter)->drop_references ();
3540 Route::RemoteControlIDChange(); /* EMIT SIGNAL */
3542 /* save the new state of the world */
3544 if (save_state (_current_snapshot_name)) {
3545 save_history (_current_snapshot_name);
3548 reassign_track_numbers();
3549 update_route_record_state ();
3553 Session::remove_route (boost::shared_ptr<Route> route)
3555 boost::shared_ptr<RouteList> rl (new RouteList);
3556 rl->push_back (route);
3561 Session::route_mute_changed ()
3567 Session::route_listen_changed (Controllable::GroupControlDisposition group_override, boost::weak_ptr<Route> wpr)
3569 boost::shared_ptr<Route> route = wpr.lock();
3571 error << string_compose (_("programming error: %1"), X_("invalid route weak ptr passed to route_listen_changed")) << endmsg;
3575 if (route->listening_via_monitor ()) {
3577 if (Config->get_exclusive_solo()) {
3579 RouteGroup* rg = route->route_group ();
3580 const bool group_already_accounted_for = route->use_group (group_override, &RouteGroup::is_solo);
3582 boost::shared_ptr<RouteList> r = routes.reader ();
3584 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3585 if ((*i) == route) {
3586 /* already changed */
3590 if ((*i)->solo_isolated() || (*i)->is_master() || (*i)->is_monitor() || (*i)->is_auditioner()) {
3591 /* route does not get solo propagated to it */
3595 if ((group_already_accounted_for && (*i)->route_group() && (*i)->route_group() == rg)) {
3596 /* this route is a part of the same solo group as the route
3597 * that was changed. Changing that route did change or will
3598 * change all group members appropriately, so we can ignore it
3603 (*i)->set_listen (false, Controllable::NoGroup);
3609 } else if (_listen_cnt > 0) {
3614 update_route_solo_state ();
3617 Session::route_solo_isolated_changed (boost::weak_ptr<Route> wpr)
3619 boost::shared_ptr<Route> route = wpr.lock ();
3622 /* should not happen */
3623 error << string_compose (_("programming error: %1"), X_("invalid route weak ptr passed to route_solo_isolated_changed")) << endmsg;
3627 bool send_changed = false;
3629 if (route->solo_isolated()) {
3630 if (_solo_isolated_cnt == 0) {
3631 send_changed = true;
3633 _solo_isolated_cnt++;
3634 } else if (_solo_isolated_cnt > 0) {
3635 _solo_isolated_cnt--;
3636 if (_solo_isolated_cnt == 0) {
3637 send_changed = true;
3642 IsolatedChanged (); /* EMIT SIGNAL */
3647 Session::route_solo_changed (bool self_solo_change, Controllable::GroupControlDisposition group_override, boost::weak_ptr<Route> wpr)
3649 DEBUG_TRACE (DEBUG::Solo, string_compose ("route solo change, self = %1\n", self_solo_change));
3651 if (!self_solo_change) {
3652 // session doesn't care about changes to soloed-by-others
3656 boost::shared_ptr<Route> route = wpr.lock ();
3659 boost::shared_ptr<RouteList> r = routes.reader ();
3662 if (route->self_soloed()) {
3668 /* the route may be a member of a group that has shared-solo
3669 * semantics. If so, then all members of that group should follow the
3670 * solo of the changed route. But ... this is optional, controlled by a
3671 * Controllable::GroupControlDisposition.
3673 * The first argument to the signal that this method is connected to is the
3674 * GroupControlDisposition value that was used to change solo.
3676 * If the solo change was done with group semantics (either InverseGroup
3677 * (force the entire group to change even if the group shared solo is
3678 * disabled) or UseGroup (use the group, which may or may not have the
3679 * shared solo property enabled)) then as we propagate the change to
3680 * the entire session we should IGNORE THE GROUP that the changed route
3684 RouteGroup* rg = route->route_group ();
3685 const bool group_already_accounted_for = route->use_group (group_override, &RouteGroup::is_solo);
3687 if (delta == 1 && Config->get_exclusive_solo()) {
3689 /* new solo: disable all other solos, but not the group if its solo-enabled */
3691 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3693 if ((*i) == route) {
3694 /* already changed */
3698 if ((*i)->solo_isolated() || (*i)->is_master() || (*i)->is_monitor() || (*i)->is_auditioner()) {
3699 /* route does not get solo propagated to it */
3703 if ((group_already_accounted_for && (*i)->route_group() && (*i)->route_group() == rg)) {
3704 /* this route is a part of the same solo group as the route
3705 * that was changed. Changing that route did change or will
3706 * change all group members appropriately, so we can ignore it
3712 (*i)->set_solo (false, group_override);
3716 DEBUG_TRACE (DEBUG::Solo, string_compose ("propagate solo change, delta = %1\n", delta));
3718 RouteList uninvolved;
3720 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1\n", route->name()));
3722 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3723 bool via_sends_only;
3724 bool in_signal_flow;
3726 if ((*i) == route) {
3727 /* already changed */
3731 if ((*i)->solo_isolated() || (*i)->is_master() || (*i)->is_monitor() || (*i)->is_auditioner()) {
3732 /* route does not get solo propagated to it */
3736 if ((group_already_accounted_for && (*i)->route_group() && (*i)->route_group() == rg)) {
3737 /* this route is a part of the same solo group as the route
3738 * that was changed. Changing that route did change or will
3739 * change all group members appropriately, so we can ignore it
3745 in_signal_flow = false;
3747 DEBUG_TRACE (DEBUG::Solo, string_compose ("check feed from %1\n", (*i)->name()));
3749 if ((*i)->feeds (route, &via_sends_only)) {
3750 DEBUG_TRACE (DEBUG::Solo, string_compose ("\tthere is a feed from %1\n", (*i)->name()));
3751 if (!via_sends_only) {
3752 if (!route->soloed_by_others_upstream()) {
3753 (*i)->mod_solo_by_others_downstream (delta);
3755 DEBUG_TRACE (DEBUG::Solo, "\talready soloed by others upstream\n");
3758 DEBUG_TRACE (DEBUG::Solo, string_compose ("\tthere is a send-only feed from %1\n", (*i)->name()));
3760 in_signal_flow = true;
3762 DEBUG_TRACE (DEBUG::Solo, string_compose ("\tno feed from %1\n", (*i)->name()));
3765 DEBUG_TRACE (DEBUG::Solo, string_compose ("check feed to %1\n", (*i)->name()));
3767 if (route->feeds (*i, &via_sends_only)) {
3768 /* propagate solo upstream only if routing other than
3769 sends is involved, but do consider the other route
3770 (*i) to be part of the signal flow even if only
3773 DEBUG_TRACE (DEBUG::Solo, string_compose ("%1 feeds %2 via sends only %3 sboD %4 sboU %5\n",
3777 route->soloed_by_others_downstream(),
3778 route->soloed_by_others_upstream()));
3779 if (!via_sends_only) {
3780 //NB. Triggers Invert Push, which handles soloed by downstream
3781 DEBUG_TRACE (DEBUG::Solo, string_compose ("\tmod %1 by %2\n", (*i)->name(), delta));
3782 (*i)->mod_solo_by_others_upstream (delta);
3784 DEBUG_TRACE (DEBUG::Solo, string_compose ("\tfeed to %1 ignored, sends-only\n", (*i)->name()));
3786 in_signal_flow = true;
3788 DEBUG_TRACE (DEBUG::Solo, "\tno feed to\n");
3791 if (!in_signal_flow) {
3792 uninvolved.push_back (*i);
3796 DEBUG_TRACE (DEBUG::Solo, "propagation complete\n");
3798 update_route_solo_state (r);
3800 /* now notify that the mute state of the routes not involved in the signal
3801 pathway of the just-solo-changed route may have altered.
3804 for (RouteList::iterator i = uninvolved.begin(); i != uninvolved.end(); ++i) {
3805 DEBUG_TRACE (DEBUG::Solo, string_compose ("mute change for %1, which neither feeds or is fed by %2\n", (*i)->name(), route->name()));
3806 (*i)->act_on_mute ();
3807 (*i)->mute_changed ();
3810 SoloChanged (); /* EMIT SIGNAL */
3815 Session::update_route_solo_state (boost::shared_ptr<RouteList> r)
3817 /* now figure out if anything that matters is soloed (or is "listening")*/
3819 bool something_soloed = false;
3820 bool something_listening = false;
3821 uint32_t listeners = 0;
3822 uint32_t isolated = 0;
3825 r = routes.reader();
3828 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3829 if (!(*i)->is_master() && !(*i)->is_monitor() && !(*i)->is_auditioner() && (*i)->self_soloed()) {
3830 something_soloed = true;
3833 if (!(*i)->is_auditioner() && (*i)->listening_via_monitor()) {
3834 if (Config->get_solo_control_is_listen_control()) {
3836 something_listening = true;
3838 (*i)->set_listen (false, Controllable::NoGroup);
3842 if ((*i)->solo_isolated()) {
3847 if (something_soloed != _non_soloed_outs_muted) {
3848 _non_soloed_outs_muted = something_soloed;
3849 SoloActive (_non_soloed_outs_muted); /* EMIT SIGNAL */
3852 if (something_listening != _listening) {
3853 _listening = something_listening;
3854 SoloActive (_listening);
3857 _listen_cnt = listeners;
3859 if (isolated != _solo_isolated_cnt) {
3860 _solo_isolated_cnt = isolated;
3861 IsolatedChanged (); /* EMIT SIGNAL */
3864 DEBUG_TRACE (DEBUG::Solo, string_compose ("solo state updated by session, soloed? %1 listeners %2 isolated %3\n",
3865 something_soloed, listeners, isolated));
3868 boost::shared_ptr<RouteList>
3869 Session::get_routes_with_internal_returns() const
3871 boost::shared_ptr<RouteList> r = routes.reader ();
3872 boost::shared_ptr<RouteList> rl (new RouteList);
3874 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3875 if ((*i)->internal_return ()) {
3883 Session::io_name_is_legal (const std::string& name)
3885 boost::shared_ptr<RouteList> r = routes.reader ();
3887 for (vector<string>::const_iterator reserved = reserved_io_names.begin(); reserved != reserved_io_names.end(); ++reserved) {
3888 if (name == *reserved) {
3889 if (!route_by_name (*reserved)) {
3890 /* first instance of a reserved name is allowed */
3893 /* all other instances of a reserved name are not allowed */
3898 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3899 if ((*i)->name() == name) {
3903 if ((*i)->has_io_processor_named (name)) {
3912 Session::set_exclusive_input_active (boost::shared_ptr<RouteList> rl, bool onoff, bool flip_others)
3915 vector<string> connections;
3917 /* if we are passed only a single route and we're not told to turn
3918 * others off, then just do the simple thing.
3921 if (flip_others == false && rl->size() == 1) {
3922 boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (rl->front());
3924 mt->set_input_active (onoff);
3929 for (RouteList::iterator rt = rl->begin(); rt != rl->end(); ++rt) {
3931 PortSet& ps ((*rt)->input()->ports());
3933 for (PortSet::iterator p = ps.begin(); p != ps.end(); ++p) {
3934 p->get_connections (connections);
3937 for (vector<string>::iterator s = connections.begin(); s != connections.end(); ++s) {
3938 routes_using_input_from (*s, rl2);
3941 /* scan all relevant routes to see if others are on or off */
3943 bool others_are_already_on = false;
3945 for (RouteList::iterator r = rl2.begin(); r != rl2.end(); ++r) {
3947 boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (*r);
3953 if ((*r) != (*rt)) {
3954 if (mt->input_active()) {
3955 others_are_already_on = true;
3958 /* this one needs changing */
3959 mt->set_input_active (onoff);
3965 /* globally reverse other routes */
3967 for (RouteList::iterator r = rl2.begin(); r != rl2.end(); ++r) {
3968 if ((*r) != (*rt)) {
3969 boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (*r);
3971 mt->set_input_active (!others_are_already_on);
3980 Session::routes_using_input_from (const string& str, RouteList& rl)
3982 boost::shared_ptr<RouteList> r = routes.reader();
3984 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3985 if ((*i)->input()->connected_to (str)) {
3991 boost::shared_ptr<Route>
3992 Session::route_by_name (string name)
3994 boost::shared_ptr<RouteList> r = routes.reader ();
3996 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
3997 if ((*i)->name() == name) {
4002 return boost::shared_ptr<Route> ((Route*) 0);
4005 boost::shared_ptr<Route>
4006 Session::route_by_id (PBD::ID id)
4008 boost::shared_ptr<RouteList> r = routes.reader ();
4010 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4011 if ((*i)->id() == id) {
4016 return boost::shared_ptr<Route> ((Route*) 0);
4019 boost::shared_ptr<Track>
4020 Session::track_by_diskstream_id (PBD::ID id)
4022 boost::shared_ptr<RouteList> r = routes.reader ();
4024 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4025 boost::shared_ptr<Track> t = boost::dynamic_pointer_cast<Track> (*i);
4026 if (t && t->using_diskstream_id (id)) {
4031 return boost::shared_ptr<Track> ();
4034 boost::shared_ptr<Route>
4035 Session::route_by_remote_id (uint32_t id)
4037 boost::shared_ptr<RouteList> r = routes.reader ();
4039 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
4040 if ((*i)->remote_control_id() == id) {
4045 return boost::shared_ptr<Route> ((Route*) 0);
4050 Session::reassign_track_numbers ()
4054 RouteList r (*(routes.reader ()));
4055 SignalOrderRouteSorter sorter;
4058 StateProtector sp (this);
4060 for (RouteList::iterator i = r.begin(); i != r.end(); ++i) {
4061 if (boost::dynamic_pointer_cast<Track> (*i)) {
4062 (*i)->set_track_number(++tn);
4064 else if (!(*i)->is_master() && !(*i)->is_monitor() && !(*i)->is_auditioner()) {
4065 (*i)->set_track_number(--bn);
4068 const uint32_t decimals = ceilf (log10f (tn + 1));
4069 const bool decimals_changed = _track_number_decimals != decimals;
4070 _track_number_decimals = decimals;
4072 if (decimals_changed && config.get_track_name_number ()) {
4073 for (RouteList::iterator i = r.begin(); i != r.end(); ++i) {
4074 boost::shared_ptr<Track> t = boost::dynamic_pointer_cast<Track> (*i);
4076 t->resync_track_name();
4079 // trigger GUI re-layout
4080 config.ParameterChanged("track-name-number");
4085 Session::playlist_region_added (boost::weak_ptr<Region> w)
4087 boost::shared_ptr<Region> r = w.lock ();
4092 /* These are the operations that are currently in progress... */
4093 list<GQuark> curr = _current_trans_quarks;
4096 /* ...and these are the operations during which we want to update
4097 the session range location markers.
4100 ops.push_back (Operations::capture);
4101 ops.push_back (Operations::paste);
4102 ops.push_back (Operations::duplicate_region);
4103 ops.push_back (Operations::insert_file);
4104 ops.push_back (Operations::insert_region);
4105 ops.push_back (Operations::drag_region_brush);
4106 ops.push_back (Operations::region_drag);
4107 ops.push_back (Operations::selection_grab);
4108 ops.push_back (Operations::region_fill);
4109 ops.push_back (Operations::fill_selection);
4110 ops.push_back (Operations::create_region);
4111 ops.push_back (Operations::region_copy);
4112 ops.push_back (Operations::fixed_time_region_copy);
4115 /* See if any of the current operations match the ones that we want */
4117 set_intersection (_current_trans_quarks.begin(), _current_trans_quarks.end(), ops.begin(), ops.end(), back_inserter (in));
4119 /* If so, update the session range markers */
4121 maybe_update_session_range (r->position (), r->last_frame ());
4125 /** Update the session range markers if a is before the current start or
4126 * b is after the current end.
4129 Session::maybe_update_session_range (framepos_t a, framepos_t b)
4131 if (_state_of_the_state & Loading) {
4135 framepos_t session_end_marker_shift_samples = session_end_shift * _nominal_frame_rate;
4137 if (_session_range_location == 0) {
4139 set_session_range_location (a, b + session_end_marker_shift_samples);
4143 if (a < _session_range_location->start()) {
4144 _session_range_location->set_start (a);
4147 if (b > _session_range_location->end()) {
4148 _session_range_location->set_end (b);
4154 Session::playlist_ranges_moved (list<Evoral::RangeMove<framepos_t> > const & ranges)
4156 for (list<Evoral::RangeMove<framepos_t> >::const_iterator i = ranges.begin(); i != ranges.end(); ++i) {
4157 maybe_update_session_range (i->to, i->to + i->length);
4162 Session::playlist_regions_extended (list<Evoral::Range<framepos_t> > const & ranges)
4164 for (list<Evoral::Range<framepos_t> >::const_iterator i = ranges.begin(); i != ranges.end(); ++i) {
4165 maybe_update_session_range (i->from, i->to);
4169 /* Region management */
4171 boost::shared_ptr<Region>
4172 Session::find_whole_file_parent (boost::shared_ptr<Region const> child) const
4174 const RegionFactory::RegionMap& regions (RegionFactory::regions());
4175 RegionFactory::RegionMap::const_iterator i;
4176 boost::shared_ptr<Region> region;
4178 Glib::Threads::Mutex::Lock lm (region_lock);
4180 for (i = regions.begin(); i != regions.end(); ++i) {
4184 if (region->whole_file()) {
4186 if (child->source_equivalent (region)) {
4192 return boost::shared_ptr<Region> ();
4196 Session::destroy_sources (list<boost::shared_ptr<Source> > srcs)
4198 set<boost::shared_ptr<Region> > relevant_regions;
4200 for (list<boost::shared_ptr<Source> >::iterator s = srcs.begin(); s != srcs.end(); ++s) {
4201 RegionFactory::get_regions_using_source (*s, relevant_regions);
4204 for (set<boost::shared_ptr<Region> >::iterator r = relevant_regions.begin(); r != relevant_regions.end(); ) {
4205 set<boost::shared_ptr<Region> >::iterator tmp;
4210 playlists->destroy_region (*r);
4211 RegionFactory::map_remove (*r);
4213 (*r)->drop_sources ();
4214 (*r)->drop_references ();
4216 relevant_regions.erase (r);
4221 for (list<boost::shared_ptr<Source> >::iterator s = srcs.begin(); s != srcs.end(); ) {
4224 Glib::Threads::Mutex::Lock ls (source_lock);
4225 /* remove from the main source list */
4226 sources.erase ((*s)->id());
4229 (*s)->mark_for_remove ();
4230 (*s)->drop_references ();
4239 Session::remove_last_capture ()
4241 list<boost::shared_ptr<Source> > srcs;
4243 boost::shared_ptr<RouteList> rl = routes.reader ();
4244 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
4245 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
4250 list<boost::shared_ptr<Source> >& l = tr->last_capture_sources();
4253 srcs.insert (srcs.end(), l.begin(), l.end());
4258 destroy_sources (srcs);
4260 save_state (_current_snapshot_name);
4265 /* Source Management */
4268 Session::add_source (boost::shared_ptr<Source> source)
4270 pair<SourceMap::key_type, SourceMap::mapped_type> entry;
4271 pair<SourceMap::iterator,bool> result;
4273 entry.first = source->id();
4274 entry.second = source;
4277 Glib::Threads::Mutex::Lock lm (source_lock);
4278 result = sources.insert (entry);
4281 if (result.second) {
4283 /* yay, new source */
4285 boost::shared_ptr<FileSource> fs = boost::dynamic_pointer_cast<FileSource> (source);
4288 if (!fs->within_session()) {
4289 ensure_search_path_includes (Glib::path_get_dirname (fs->path()), fs->type());
4295 boost::shared_ptr<AudioFileSource> afs;
4297 if ((afs = boost::dynamic_pointer_cast<AudioFileSource>(source)) != 0) {
4298 if (Config->get_auto_analyse_audio()) {
4299 Analyser::queue_source_for_analysis (source, false);
4303 source->DropReferences.connect_same_thread (*this, boost::bind (&Session::remove_source, this, boost::weak_ptr<Source> (source)));
4308 Session::remove_source (boost::weak_ptr<Source> src)
4310 if (_state_of_the_state & Deletion) {
4314 SourceMap::iterator i;
4315 boost::shared_ptr<Source> source = src.lock();
4322 Glib::Threads::Mutex::Lock lm (source_lock);
4324 if ((i = sources.find (source->id())) != sources.end()) {
4329 if (!(_state_of_the_state & StateOfTheState (InCleanup|Loading))) {
4331 /* save state so we don't end up with a session file
4332 referring to non-existent sources.
4335 save_state (_current_snapshot_name);
4339 boost::shared_ptr<Source>
4340 Session::source_by_id (const PBD::ID& id)
4342 Glib::Threads::Mutex::Lock lm (source_lock);
4343 SourceMap::iterator i;
4344 boost::shared_ptr<Source> source;
4346 if ((i = sources.find (id)) != sources.end()) {
4353 boost::shared_ptr<AudioFileSource>
4354 Session::audio_source_by_path_and_channel (const string& path, uint16_t chn) const
4356 /* Restricted to audio files because only audio sources have channel
4360 Glib::Threads::Mutex::Lock lm (source_lock);
4362 for (SourceMap::const_iterator i = sources.begin(); i != sources.end(); ++i) {
4363 boost::shared_ptr<AudioFileSource> afs
4364 = boost::dynamic_pointer_cast<AudioFileSource>(i->second);
4366 if (afs && afs->path() == path && chn == afs->channel()) {
4371 return boost::shared_ptr<AudioFileSource>();
4374 boost::shared_ptr<MidiSource>
4375 Session::midi_source_by_path (const std::string& path) const
4377 /* Restricted to MIDI files because audio sources require a channel
4378 for unique identification, in addition to a path.
4381 Glib::Threads::Mutex::Lock lm (source_lock);
4383 for (SourceMap::const_iterator s = sources.begin(); s != sources.end(); ++s) {
4384 boost::shared_ptr<MidiSource> ms
4385 = boost::dynamic_pointer_cast<MidiSource>(s->second);
4386 boost::shared_ptr<FileSource> fs
4387 = boost::dynamic_pointer_cast<FileSource>(s->second);
4389 if (ms && fs && fs->path() == path) {
4394 return boost::shared_ptr<MidiSource>();
4398 Session::count_sources_by_origin (const string& path)
4401 Glib::Threads::Mutex::Lock lm (source_lock);
4403 for (SourceMap::iterator i = sources.begin(); i != sources.end(); ++i) {
4404 boost::shared_ptr<FileSource> fs
4405 = boost::dynamic_pointer_cast<FileSource>(i->second);
4407 if (fs && fs->origin() == path) {
4416 peak_file_helper (const string& peak_path, const string& file_path, const string& file_base, bool hash) {
4418 std::string checksum = Glib::Checksum::compute_checksum(Glib::Checksum::CHECKSUM_SHA1, file_path + G_DIR_SEPARATOR + file_base);
4419 return Glib::build_filename (peak_path, checksum + peakfile_suffix);
4421 return Glib::build_filename (peak_path, file_base + peakfile_suffix);
4426 Session::construct_peak_filepath (const string& filepath, const bool in_session, const bool old_peak_name) const
4428 string interchange_dir_string = string (interchange_dir_name) + G_DIR_SEPARATOR;
4430 if (Glib::path_is_absolute (filepath)) {
4432 /* rip the session dir from the audiofile source */
4434 string session_path;
4435 bool in_another_session = true;
4437 if (filepath.find (interchange_dir_string) != string::npos) {
4439 session_path = Glib::path_get_dirname (filepath); /* now ends in audiofiles */
4440 session_path = Glib::path_get_dirname (session_path); /* now ends in session name */
4441 session_path = Glib::path_get_dirname (session_path); /* now ends in interchange */
4442 session_path = Glib::path_get_dirname (session_path); /* now has session path */
4444 /* see if it is within our session */
4446 for (vector<space_and_path>::const_iterator i = session_dirs.begin(); i != session_dirs.end(); ++i) {
4447 if (i->path == session_path) {
4448 in_another_session = false;
4453 in_another_session = false;
4457 if (in_another_session) {
4458 SessionDirectory sd (session_path);
4459 return peak_file_helper (sd.peak_path(), "", Glib::path_get_basename (filepath), !old_peak_name);
4463 /* 1) if file belongs to this session
4464 * it may be a relative path (interchange/...)
4465 * or just basename (session_state, remove source)
4466 * -> just use the basename
4468 std::string filename = Glib::path_get_basename (filepath);
4471 /* 2) if the file is outside our session dir:
4472 * (imported but not copied) add the path for check-summming */
4474 path = Glib::path_get_dirname (filepath);
4477 return peak_file_helper (_session_dir->peak_path(), path, Glib::path_get_basename (filepath), !old_peak_name);
4481 Session::new_audio_source_path_for_embedded (const std::string& path)
4485 * we know that the filename is already unique because it exists
4486 * out in the filesystem.
4488 * However, when we bring it into the session, we could get a
4491 * Eg. two embedded files:
4496 * When merged into session, these collide.
4498 * There will not be a conflict with in-memory sources
4499 * because when the source was created we already picked
4500 * a unique name for it.
4502 * This collision is not likely to be common, but we have to guard
4503 * against it. So, if there is a collision, take the md5 hash of the
4504 * the path, and use that as the filename instead.
4507 SessionDirectory sdir (get_best_session_directory_for_new_audio());
4508 string base = Glib::path_get_basename (path);
4509 string newpath = Glib::build_filename (sdir.sound_path(), base);
4511 if (Glib::file_test (newpath, Glib::FILE_TEST_EXISTS)) {
4515 md5.digestString (path.c_str());
4516 md5.writeToString ();
4517 base = md5.digestChars;
4519 string ext = get_suffix (path);
4526 newpath = Glib::build_filename (sdir.sound_path(), base);
4528 /* if this collides, we're screwed */
4530 if (Glib::file_test (newpath, Glib::FILE_TEST_EXISTS)) {
4531 error << string_compose (_("Merging embedded file %1: name collision AND md5 hash collision!"), path) << endmsg;
4540 /** Return true if there are no audio file sources that use @param name as
4541 * the filename component of their path.
4543 * Return false otherwise.
4545 * This method MUST ONLY be used to check in-session, mono files since it
4546 * hard-codes the channel of the audio file source we are looking for as zero.
4548 * If/when Ardour supports native files in non-mono formats, the logic here
4549 * will need to be revisited.
4552 Session::audio_source_name_is_unique (const string& name)
4554 std::vector<string> sdirs = source_search_path (DataType::AUDIO);
4555 vector<space_and_path>::iterator i;
4556 uint32_t existing = 0;
4558 for (vector<string>::const_iterator i = sdirs.begin(); i != sdirs.end(); ++i) {
4560 /* note that we search *without* the extension so that
4561 we don't end up both "Audio 1-1.wav" and "Audio 1-1.caf"
4562 in the event that this new name is required for
4563 a file format change.
4566 const string spath = *i;
4568 if (matching_unsuffixed_filename_exists_in (spath, name)) {
4573 /* it is possible that we have the path already
4574 * assigned to a source that has not yet been written
4575 * (ie. the write source for a diskstream). we have to
4576 * check this in order to make sure that our candidate
4577 * path isn't used again, because that can lead to
4578 * two Sources point to the same file with different
4579 * notions of their removability.
4583 string possible_path = Glib::build_filename (spath, name);
4585 if (audio_source_by_path_and_channel (possible_path, 0)) {
4591 return (existing == 0);
4595 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)
4598 const string ext = native_header_format_extension (config.get_native_file_header_format(), DataType::AUDIO);
4600 if (Profile->get_trx() && destructive) {
4602 sstr << setfill ('0') << setw (4) << cnt;
4603 sstr << legalized_base;
4605 sstr << legalized_base;
4607 if (take_required || related_exists) {
4619 } else if (nchan > 2) {
4624 /* XXX what? more than 26 channels! */
4635 /** Return a unique name based on \a base for a new internal audio source */
4637 Session::new_audio_source_path (const string& base, uint32_t nchan, uint32_t chan, bool destructive, bool take_required)
4640 string possible_name;
4641 const uint32_t limit = 9999; // arbitrary limit on number of files with the same basic name
4643 bool some_related_source_name_exists = false;
4645 legalized = legalize_for_path (base);
4647 // Find a "version" of the base name that doesn't exist in any of the possible directories.
4649 for (cnt = (destructive ? ++destructive_index : 1); cnt <= limit; ++cnt) {
4651 possible_name = format_audio_source_name (legalized, nchan, chan, destructive, take_required, cnt, some_related_source_name_exists);
4653 if (audio_source_name_is_unique (possible_name)) {
4657 some_related_source_name_exists = true;
4660 error << string_compose(
4661 _("There are already %1 recordings for %2, which I consider too many."),
4662 limit, base) << endmsg;
4664 throw failed_constructor();
4668 /* We've established that the new name does not exist in any session
4669 * directory, so now find out which one we should use for this new
4673 SessionDirectory sdir (get_best_session_directory_for_new_audio());
4675 std::string s = Glib::build_filename (sdir.sound_path(), possible_name);
4680 /** Return a unique name based on `base` for a new internal MIDI source */
4682 Session::new_midi_source_path (const string& base)
4685 char buf[PATH_MAX+1];
4686 const uint32_t limit = 10000;
4688 string possible_path;
4689 string possible_name;
4692 legalized = legalize_for_path (base);
4694 // Find a "version" of the file name that doesn't exist in any of the possible directories.
4695 std::vector<string> sdirs = source_search_path(DataType::MIDI);
4697 /* - the main session folder is the first in the vector.
4698 * - after checking all locations for file-name uniqueness,
4699 * we keep the one from the last iteration as new file name
4700 * - midi files are small and should just be kept in the main session-folder
4702 * -> reverse the array, check main session folder last and use that as location
4705 std::reverse(sdirs.begin(), sdirs.end());
4707 for (cnt = 1; cnt <= limit; ++cnt) {
4709 vector<space_and_path>::iterator i;
4710 uint32_t existing = 0;
4712 for (vector<string>::const_iterator i = sdirs.begin(); i != sdirs.end(); ++i) {
4714 snprintf (buf, sizeof(buf), "%s-%u.mid", legalized.c_str(), cnt);
4715 possible_name = buf;
4717 possible_path = Glib::build_filename (*i, possible_name);
4719 if (Glib::file_test (possible_path, Glib::FILE_TEST_EXISTS)) {
4723 if (midi_source_by_path (possible_path)) {
4728 if (existing == 0) {
4733 error << string_compose(
4734 _("There are already %1 recordings for %2, which I consider too many."),
4735 limit, base) << endmsg;
4741 /* No need to "find best location" for software/app-based RAID, because
4742 MIDI is so small that we always put it in the same place.
4745 return possible_path;
4749 /** Create a new within-session audio source */
4750 boost::shared_ptr<AudioFileSource>
4751 Session::create_audio_source_for_session (size_t n_chans, string const & base, uint32_t chan, bool destructive)
4753 const string path = new_audio_source_path (base, n_chans, chan, destructive, true);
4755 if (!path.empty()) {
4756 return boost::dynamic_pointer_cast<AudioFileSource> (
4757 SourceFactory::createWritable (DataType::AUDIO, *this, path, destructive, frame_rate(), true, true));
4759 throw failed_constructor ();
4763 /** Create a new within-session MIDI source */
4764 boost::shared_ptr<MidiSource>
4765 Session::create_midi_source_for_session (string const & basic_name)
4767 const string path = new_midi_source_path (basic_name);
4769 if (!path.empty()) {
4770 return boost::dynamic_pointer_cast<SMFSource> (
4771 SourceFactory::createWritable (
4772 DataType::MIDI, *this, path, false, frame_rate()));
4774 throw failed_constructor ();
4778 /** Create a new within-session MIDI source */
4779 boost::shared_ptr<MidiSource>
4780 Session::create_midi_source_by_stealing_name (boost::shared_ptr<Track> track)
4782 /* the caller passes in the track the source will be used in,
4783 so that we can keep the numbering sane.
4785 Rationale: a track with the name "Foo" that has had N
4786 captures carried out so far will ALREADY have a write source
4787 named "Foo-N+1.mid" waiting to be used for the next capture.
4789 If we call new_midi_source_name() we will get "Foo-N+2". But
4790 there is no region corresponding to "Foo-N+1", so when
4791 "Foo-N+2" appears in the track, the gap presents the user
4792 with odd behaviour - why did it skip past Foo-N+1?
4794 We could explain this to the user in some odd way, but
4795 instead we rename "Foo-N+1.mid" as "Foo-N+2.mid", and then
4798 If that attempted rename fails, we get "Foo-N+2.mid" anyway.
4801 boost::shared_ptr<MidiTrack> mt = boost::dynamic_pointer_cast<MidiTrack> (track);
4803 std::string name = track->steal_write_source_name ();
4806 return boost::shared_ptr<MidiSource>();
4809 /* MIDI files are small, just put them in the first location of the
4810 session source search path.
4813 const string path = Glib::build_filename (source_search_path (DataType::MIDI).front(), name);
4815 return boost::dynamic_pointer_cast<SMFSource> (
4816 SourceFactory::createWritable (
4817 DataType::MIDI, *this, path, false, frame_rate()));
4822 Session::add_playlist (boost::shared_ptr<Playlist> playlist, bool unused)
4824 if (playlist->hidden()) {
4828 playlists->add (playlist);
4831 playlist->release();
4838 Session::remove_playlist (boost::weak_ptr<Playlist> weak_playlist)
4840 if (_state_of_the_state & Deletion) {
4844 boost::shared_ptr<Playlist> playlist (weak_playlist.lock());
4850 playlists->remove (playlist);
4856 Session::set_audition (boost::shared_ptr<Region> r)
4858 pending_audition_region = r;
4859 add_post_transport_work (PostTransportAudition);
4860 _butler->schedule_transport_work ();
4864 Session::audition_playlist ()
4866 SessionEvent* ev = new SessionEvent (SessionEvent::Audition, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
4867 ev->region.reset ();
4872 Session::non_realtime_set_audition ()
4874 assert (pending_audition_region);
4875 auditioner->audition_region (pending_audition_region);
4876 pending_audition_region.reset ();
4877 AuditionActive (true); /* EMIT SIGNAL */
4881 Session::audition_region (boost::shared_ptr<Region> r)
4883 SessionEvent* ev = new SessionEvent (SessionEvent::Audition, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
4889 Session::cancel_audition ()
4894 if (auditioner->auditioning()) {
4895 auditioner->cancel_audition ();
4896 AuditionActive (false); /* EMIT SIGNAL */
4901 Session::RoutePublicOrderSorter::operator() (boost::shared_ptr<Route> a, boost::shared_ptr<Route> b)
4903 if (a->is_monitor()) {
4906 if (b->is_monitor()) {
4909 return a->order_key () < b->order_key ();
4913 Session::is_auditioning () const
4915 /* can be called before we have an auditioner object */
4917 return auditioner->auditioning();
4924 Session::graph_reordered ()
4926 /* don't do this stuff if we are setting up connections
4927 from a set_state() call or creating new tracks. Ditto for deletion.
4930 if ((_state_of_the_state & (InitialConnecting|Deletion)) || _adding_routes_in_progress || _reconnecting_routes_in_progress || _route_deletion_in_progress) {
4934 /* every track/bus asked for this to be handled but it was deferred because
4935 we were connecting. do it now.
4938 request_input_change_handling ();
4942 /* force all diskstreams to update their capture offset values to
4943 reflect any changes in latencies within the graph.
4946 boost::shared_ptr<RouteList> rl = routes.reader ();
4947 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
4948 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
4950 tr->set_capture_offset ();
4955 /** @return Number of frames that there is disk space available to write,
4958 boost::optional<framecnt_t>
4959 Session::available_capture_duration ()
4961 Glib::Threads::Mutex::Lock lm (space_lock);
4963 if (_total_free_4k_blocks_uncertain) {
4964 return boost::optional<framecnt_t> ();
4967 float sample_bytes_on_disk = 4.0; // keep gcc happy
4969 switch (config.get_native_file_data_format()) {
4971 sample_bytes_on_disk = 4.0;
4975 sample_bytes_on_disk = 3.0;
4979 sample_bytes_on_disk = 2.0;
4983 /* impossible, but keep some gcc versions happy */
4984 fatal << string_compose (_("programming error: %1"),
4985 X_("illegal native file data format"))
4987 abort(); /*NOTREACHED*/
4990 double scale = 4096.0 / sample_bytes_on_disk;
4992 if (_total_free_4k_blocks * scale > (double) max_framecnt) {
4993 return max_framecnt;
4996 return (framecnt_t) floor (_total_free_4k_blocks * scale);
5000 Session::add_bundle (boost::shared_ptr<Bundle> bundle, bool emit_signal)
5003 RCUWriter<BundleList> writer (_bundles);
5004 boost::shared_ptr<BundleList> b = writer.get_copy ();
5005 b->push_back (bundle);
5009 BundleAddedOrRemoved (); /* EMIT SIGNAL */
5016 Session::remove_bundle (boost::shared_ptr<Bundle> bundle)
5018 bool removed = false;
5021 RCUWriter<BundleList> writer (_bundles);
5022 boost::shared_ptr<BundleList> b = writer.get_copy ();
5023 BundleList::iterator i = find (b->begin(), b->end(), bundle);
5025 if (i != b->end()) {
5032 BundleAddedOrRemoved (); /* EMIT SIGNAL */
5038 boost::shared_ptr<Bundle>
5039 Session::bundle_by_name (string name) const
5041 boost::shared_ptr<BundleList> b = _bundles.reader ();
5043 for (BundleList::const_iterator i = b->begin(); i != b->end(); ++i) {
5044 if ((*i)->name() == name) {
5049 return boost::shared_ptr<Bundle> ();
5053 Session::tempo_map_changed (const PropertyChange&)
5057 playlists->update_after_tempo_map_change ();
5059 _locations->apply (*this, &Session::update_locations_after_tempo_map_change);
5065 Session::update_locations_after_tempo_map_change (const Locations::LocationList& loc)
5067 for (Locations::LocationList::const_iterator i = loc.begin(); i != loc.end(); ++i) {
5068 (*i)->recompute_frames_from_bbt ();
5072 /** Ensures that all buffers (scratch, send, silent, etc) are allocated for
5073 * the given count with the current block size.
5076 Session::ensure_buffers (ChanCount howmany)
5078 BufferManager::ensure_buffers (howmany, bounce_processing() ? bounce_chunk_size : 0);
5082 Session::ensure_buffer_set(BufferSet& buffers, const ChanCount& count)
5084 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
5085 buffers.ensure_buffers(*t, count.get(*t), _engine.raw_buffer_size(*t));
5090 Session::next_insert_id ()
5092 /* this doesn't really loop forever. just think about it */
5095 for (boost::dynamic_bitset<uint32_t>::size_type n = 0; n < insert_bitset.size(); ++n) {
5096 if (!insert_bitset[n]) {
5097 insert_bitset[n] = true;
5103 /* none available, so resize and try again */
5105 insert_bitset.resize (insert_bitset.size() + 16, false);
5110 Session::next_send_id ()
5112 /* this doesn't really loop forever. just think about it */
5115 for (boost::dynamic_bitset<uint32_t>::size_type n = 0; n < send_bitset.size(); ++n) {
5116 if (!send_bitset[n]) {
5117 send_bitset[n] = true;
5123 /* none available, so resize and try again */
5125 send_bitset.resize (send_bitset.size() + 16, false);
5130 Session::next_aux_send_id ()
5132 /* this doesn't really loop forever. just think about it */
5135 for (boost::dynamic_bitset<uint32_t>::size_type n = 0; n < aux_send_bitset.size(); ++n) {
5136 if (!aux_send_bitset[n]) {
5137 aux_send_bitset[n] = true;
5143 /* none available, so resize and try again */
5145 aux_send_bitset.resize (aux_send_bitset.size() + 16, false);
5150 Session::next_return_id ()
5152 /* this doesn't really loop forever. just think about it */
5155 for (boost::dynamic_bitset<uint32_t>::size_type n = 0; n < return_bitset.size(); ++n) {
5156 if (!return_bitset[n]) {
5157 return_bitset[n] = true;
5163 /* none available, so resize and try again */
5165 return_bitset.resize (return_bitset.size() + 16, false);
5170 Session::mark_send_id (uint32_t id)
5172 if (id >= send_bitset.size()) {
5173 send_bitset.resize (id+16, false);
5175 if (send_bitset[id]) {
5176 warning << string_compose (_("send ID %1 appears to be in use already"), id) << endmsg;
5178 send_bitset[id] = true;
5182 Session::mark_aux_send_id (uint32_t id)
5184 if (id >= aux_send_bitset.size()) {
5185 aux_send_bitset.resize (id+16, false);
5187 if (aux_send_bitset[id]) {
5188 warning << string_compose (_("aux send ID %1 appears to be in use already"), id) << endmsg;
5190 aux_send_bitset[id] = true;
5194 Session::mark_return_id (uint32_t id)
5196 if (id >= return_bitset.size()) {
5197 return_bitset.resize (id+16, false);
5199 if (return_bitset[id]) {
5200 warning << string_compose (_("return ID %1 appears to be in use already"), id) << endmsg;
5202 return_bitset[id] = true;
5206 Session::mark_insert_id (uint32_t id)
5208 if (id >= insert_bitset.size()) {
5209 insert_bitset.resize (id+16, false);
5211 if (insert_bitset[id]) {
5212 warning << string_compose (_("insert ID %1 appears to be in use already"), id) << endmsg;
5214 insert_bitset[id] = true;
5218 Session::unmark_send_id (uint32_t id)
5220 if (id < send_bitset.size()) {
5221 send_bitset[id] = false;
5226 Session::unmark_aux_send_id (uint32_t id)
5228 if (id < aux_send_bitset.size()) {
5229 aux_send_bitset[id] = false;
5234 Session::unmark_return_id (uint32_t id)
5236 if (id < return_bitset.size()) {
5237 return_bitset[id] = false;
5242 Session::unmark_insert_id (uint32_t id)
5244 if (id < insert_bitset.size()) {
5245 insert_bitset[id] = false;
5250 Session::reset_native_file_format ()
5252 boost::shared_ptr<RouteList> rl = routes.reader ();
5254 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
5255 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
5257 /* don't save state as we do this, there's no point
5259 _state_of_the_state = StateOfTheState (_state_of_the_state|InCleanup);
5260 tr->reset_write_sources (false);
5261 _state_of_the_state = StateOfTheState (_state_of_the_state & ~InCleanup);
5267 Session::route_name_unique (string n) const
5269 boost::shared_ptr<RouteList> r = routes.reader ();
5271 for (RouteList::const_iterator i = r->begin(); i != r->end(); ++i) {
5272 if ((*i)->name() == n) {
5281 Session::route_name_internal (string n) const
5283 if (auditioner && auditioner->name() == n) {
5287 if (_click_io && _click_io->name() == n) {
5295 Session::freeze_all (InterThreadInfo& itt)
5297 boost::shared_ptr<RouteList> r = routes.reader ();
5299 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
5301 boost::shared_ptr<Track> t;
5303 if ((t = boost::dynamic_pointer_cast<Track>(*i)) != 0) {
5304 /* XXX this is wrong because itt.progress will keep returning to zero at the start
5314 boost::shared_ptr<Region>
5315 Session::write_one_track (Track& track, framepos_t start, framepos_t end,
5316 bool /*overwrite*/, vector<boost::shared_ptr<Source> >& srcs,
5317 InterThreadInfo& itt,
5318 boost::shared_ptr<Processor> endpoint, bool include_endpoint,
5319 bool for_export, bool for_freeze)
5321 boost::shared_ptr<Region> result;
5322 boost::shared_ptr<Playlist> playlist;
5323 boost::shared_ptr<Source> source;
5324 ChanCount diskstream_channels (track.n_channels());
5325 framepos_t position;
5326 framecnt_t this_chunk;
5328 framepos_t latency_skip;
5330 framepos_t len = end - start;
5331 bool need_block_size_reset = false;
5332 ChanCount const max_proc = track.max_processor_streams ();
5333 string legal_playlist_name;
5334 string possible_path;
5337 error << string_compose (_("Cannot write a range where end <= start (e.g. %1 <= %2)"),
5338 end, start) << endmsg;
5342 diskstream_channels = track.bounce_get_output_streams (diskstream_channels, endpoint,
5343 include_endpoint, for_export, for_freeze);
5345 if (diskstream_channels.n(track.data_type()) < 1) {
5346 error << _("Cannot write a range with no data.") << endmsg;
5350 // block all process callback handling
5352 block_processing ();
5355 // synchronize with AudioEngine::process_callback()
5356 // make sure processing is not currently running
5357 // and processing_blocked() is honored before
5358 // acquiring thread buffers
5359 Glib::Threads::Mutex::Lock lm (_engine.process_lock());
5362 _bounce_processing_active = true;
5364 /* call tree *MUST* hold route_lock */
5366 if ((playlist = track.playlist()) == 0) {
5370 legal_playlist_name = legalize_for_path (playlist->name());
5372 for (uint32_t chan_n = 0; chan_n < diskstream_channels.n(track.data_type()); ++chan_n) {
5374 string base_name = string_compose ("%1-%2-bounce", playlist->name(), chan_n);
5375 string path = ((track.data_type() == DataType::AUDIO)
5376 ? new_audio_source_path (legal_playlist_name, diskstream_channels.n_audio(), chan_n, false, true)
5377 : new_midi_source_path (legal_playlist_name));
5384 source = SourceFactory::createWritable (track.data_type(), *this, path, false, frame_rate());
5387 catch (failed_constructor& err) {
5388 error << string_compose (_("cannot create new file \"%1\" for %2"), path, track.name()) << endmsg;
5392 srcs.push_back (source);
5395 /* tell redirects that care that we are about to use a much larger
5396 * blocksize. this will flush all plugins too, so that they are ready
5397 * to be used for this process.
5400 need_block_size_reset = true;
5401 track.set_block_size (bounce_chunk_size);
5402 _engine.main_thread()->get_buffers ();
5406 latency_skip = track.bounce_get_latency (endpoint, include_endpoint, for_export, for_freeze);
5408 /* create a set of reasonably-sized buffers */
5409 for (DataType::iterator t = DataType::begin(); t != DataType::end(); ++t) {
5410 buffers.ensure_buffers(*t, max_proc.get(*t), bounce_chunk_size);
5412 buffers.set_count (max_proc);
5414 for (vector<boost::shared_ptr<Source> >::iterator src = srcs.begin(); src != srcs.end(); ++src) {
5415 boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*src);
5416 boost::shared_ptr<MidiSource> ms;
5418 afs->prepare_for_peakfile_writes ();
5419 } else if ((ms = boost::dynamic_pointer_cast<MidiSource>(*src))) {
5420 Source::Lock lock(ms->mutex());
5421 ms->mark_streaming_write_started(lock);
5425 while (to_do && !itt.cancel) {
5427 this_chunk = min (to_do, bounce_chunk_size);
5429 if (track.export_stuff (buffers, start, this_chunk, endpoint, include_endpoint, for_export, for_freeze)) {
5433 start += this_chunk;
5434 to_do -= this_chunk;
5435 itt.progress = (float) (1.0 - ((double) to_do / len));
5437 if (latency_skip >= bounce_chunk_size) {
5438 latency_skip -= bounce_chunk_size;
5442 const framecnt_t current_chunk = this_chunk - latency_skip;
5445 for (vector<boost::shared_ptr<Source> >::iterator src=srcs.begin(); src != srcs.end(); ++src, ++n) {
5446 boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*src);
5447 boost::shared_ptr<MidiSource> ms;
5450 if (afs->write (buffers.get_audio(n).data(latency_skip), current_chunk) != current_chunk) {
5453 } else if ((ms = boost::dynamic_pointer_cast<MidiSource>(*src))) {
5454 Source::Lock lock(ms->mutex());
5456 const MidiBuffer& buf = buffers.get_midi(0);
5457 for (MidiBuffer::const_iterator i = buf.begin(); i != buf.end(); ++i) {
5458 Evoral::Event<framepos_t> ev = *i;
5459 ev.set_time(ev.time() - position);
5460 ms->append_event_frames(lock, ev, ms->timeline_position());
5467 /* post-roll, pick up delayed processor output */
5468 latency_skip = track.bounce_get_latency (endpoint, include_endpoint, for_export, for_freeze);
5470 while (latency_skip && !itt.cancel) {
5471 this_chunk = min (latency_skip, bounce_chunk_size);
5472 latency_skip -= this_chunk;
5474 buffers.silence (this_chunk, 0);
5475 track.bounce_process (buffers, start, this_chunk, endpoint, include_endpoint, for_export, for_freeze);
5478 for (vector<boost::shared_ptr<Source> >::iterator src=srcs.begin(); src != srcs.end(); ++src, ++n) {
5479 boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*src);
5482 if (afs->write (buffers.get_audio(n).data(), this_chunk) != this_chunk) {
5494 xnow = localtime (&now);
5496 for (vector<boost::shared_ptr<Source> >::iterator src=srcs.begin(); src != srcs.end(); ++src) {
5497 boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*src);
5498 boost::shared_ptr<MidiSource> ms;
5501 afs->update_header (position, *xnow, now);
5502 afs->flush_header ();
5503 } else if ((ms = boost::dynamic_pointer_cast<MidiSource>(*src))) {
5504 Source::Lock lock(ms->mutex());
5505 ms->mark_streaming_write_completed(lock);
5509 /* construct a region to represent the bounced material */
5513 plist.add (Properties::start, 0);
5514 plist.add (Properties::length, srcs.front()->length(srcs.front()->timeline_position()));
5515 plist.add (Properties::name, region_name_from_path (srcs.front()->name(), true));
5517 result = RegionFactory::create (srcs, plist);
5523 for (vector<boost::shared_ptr<Source> >::iterator src = srcs.begin(); src != srcs.end(); ++src) {
5524 (*src)->mark_for_remove ();
5525 (*src)->drop_references ();
5529 for (vector<boost::shared_ptr<Source> >::iterator src = srcs.begin(); src != srcs.end(); ++src) {
5530 boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(*src);
5533 afs->done_with_peakfile_writes ();
5537 _bounce_processing_active = false;
5539 if (need_block_size_reset) {
5540 _engine.main_thread()->drop_buffers ();
5541 track.set_block_size (get_block_size());
5544 unblock_processing ();
5550 Session::gain_automation_buffer() const
5552 return ProcessThread::gain_automation_buffer ();
5556 Session::trim_automation_buffer() const
5558 return ProcessThread::trim_automation_buffer ();
5562 Session::send_gain_automation_buffer() const
5564 return ProcessThread::send_gain_automation_buffer ();
5568 Session::pan_automation_buffer() const
5570 return ProcessThread::pan_automation_buffer ();
5574 Session::get_silent_buffers (ChanCount count)
5576 return ProcessThread::get_silent_buffers (count);
5580 Session::get_scratch_buffers (ChanCount count, bool silence)
5582 return ProcessThread::get_scratch_buffers (count, silence);
5586 Session::get_route_buffers (ChanCount count, bool silence)
5588 return ProcessThread::get_route_buffers (count, silence);
5593 Session::get_mix_buffers (ChanCount count)
5595 return ProcessThread::get_mix_buffers (count);
5599 Session::ntracks () const
5602 boost::shared_ptr<RouteList> r = routes.reader ();
5604 for (RouteList::const_iterator i = r->begin(); i != r->end(); ++i) {
5605 if (boost::dynamic_pointer_cast<Track> (*i)) {
5614 Session::nbusses () const
5617 boost::shared_ptr<RouteList> r = routes.reader ();
5619 for (RouteList::const_iterator i = r->begin(); i != r->end(); ++i) {
5620 if (boost::dynamic_pointer_cast<Track>(*i) == 0) {
5629 Session::add_automation_list(AutomationList *al)
5631 automation_lists[al->id()] = al;
5634 /** @return true if there is at least one record-enabled track, otherwise false */
5636 Session::have_rec_enabled_track () const
5638 return g_atomic_int_get (const_cast<gint*>(&_have_rec_enabled_track)) == 1;
5642 Session::have_rec_disabled_track () const
5644 return g_atomic_int_get (const_cast<gint*>(&_have_rec_disabled_track)) == 1;
5647 /** Update the state of our rec-enabled tracks flag */
5649 Session::update_route_record_state ()
5651 boost::shared_ptr<RouteList> rl = routes.reader ();
5652 RouteList::iterator i = rl->begin();
5653 while (i != rl->end ()) {
5655 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
5656 if (tr && tr->record_enabled ()) {
5663 int const old = g_atomic_int_get (&_have_rec_enabled_track);
5665 g_atomic_int_set (&_have_rec_enabled_track, i != rl->end () ? 1 : 0);
5667 if (g_atomic_int_get (&_have_rec_enabled_track) != old) {
5668 RecordStateChanged (); /* EMIT SIGNAL */
5671 for (i = rl->begin(); i != rl->end (); ++i) {
5672 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
5673 if (tr && !tr->record_enabled ()) {
5678 g_atomic_int_set (&_have_rec_disabled_track, i != rl->end () ? 1 : 0);
5680 bool record_arm_state_changed = (old != g_atomic_int_get (&_have_rec_enabled_track) );
5682 if (record_status() == Recording && record_arm_state_changed ) {
5683 RecordArmStateChanged ();
5689 Session::listen_position_changed ()
5691 boost::shared_ptr<RouteList> r = routes.reader ();
5693 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
5694 (*i)->listen_position_changed ();
5699 Session::solo_control_mode_changed ()
5701 /* cancel all solo or all listen when solo control mode changes */
5704 set_solo (get_routes(), false);
5705 } else if (listening()) {
5706 set_listen (get_routes(), false);
5710 /** Called when a property of one of our route groups changes */
5712 Session::route_group_property_changed (RouteGroup* rg)
5714 RouteGroupPropertyChanged (rg); /* EMIT SIGNAL */
5717 /** Called when a route is added to one of our route groups */
5719 Session::route_added_to_route_group (RouteGroup* rg, boost::weak_ptr<Route> r)
5721 RouteAddedToRouteGroup (rg, r);
5724 /** Called when a route is removed from one of our route groups */
5726 Session::route_removed_from_route_group (RouteGroup* rg, boost::weak_ptr<Route> r)
5728 update_route_record_state ();
5729 RouteRemovedFromRouteGroup (rg, r); /* EMIT SIGNAL */
5732 boost::shared_ptr<RouteList>
5733 Session::get_tracks () const
5735 boost::shared_ptr<RouteList> rl = routes.reader ();
5736 boost::shared_ptr<RouteList> tl (new RouteList);
5738 for (RouteList::const_iterator r = rl->begin(); r != rl->end(); ++r) {
5739 if (boost::dynamic_pointer_cast<Track> (*r)) {
5740 if (!(*r)->is_auditioner()) {
5748 boost::shared_ptr<RouteList>
5749 Session::get_routes_with_regions_at (framepos_t const p) const
5751 boost::shared_ptr<RouteList> r = routes.reader ();
5752 boost::shared_ptr<RouteList> rl (new RouteList);
5754 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
5755 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
5760 boost::shared_ptr<Playlist> pl = tr->playlist ();
5765 if (pl->has_region_at (p)) {
5774 Session::goto_end ()
5776 if (_session_range_location) {
5777 request_locate (_session_range_location->end(), false);
5779 request_locate (0, false);
5784 Session::goto_start ()
5786 if (_session_range_location) {
5787 request_locate (_session_range_location->start(), false);
5789 request_locate (0, false);
5794 Session::current_start_frame () const
5796 return _session_range_location ? _session_range_location->start() : 0;
5800 Session::current_end_frame () const
5802 return _session_range_location ? _session_range_location->end() : 0;
5806 Session::set_session_range_location (framepos_t start, framepos_t end)
5808 _session_range_location = new Location (*this, start, end, _("session"), Location::IsSessionRange);
5809 _locations->add (_session_range_location);
5813 Session::step_edit_status_change (bool yn)
5819 send = (_step_editors == 0);
5824 send = (_step_editors == 1);
5827 if (_step_editors > 0) {
5833 StepEditStatusChange (val);
5839 Session::start_time_changed (framepos_t old)
5841 /* Update the auto loop range to match the session range
5842 (unless the auto loop range has been changed by the user)
5845 Location* s = _locations->session_range_location ();
5850 Location* l = _locations->auto_loop_location ();
5852 if (l && l->start() == old) {
5853 l->set_start (s->start(), true);
5858 Session::end_time_changed (framepos_t old)
5860 /* Update the auto loop range to match the session range
5861 (unless the auto loop range has been changed by the user)
5864 Location* s = _locations->session_range_location ();
5869 Location* l = _locations->auto_loop_location ();
5871 if (l && l->end() == old) {
5872 l->set_end (s->end(), true);
5876 std::vector<std::string>
5877 Session::source_search_path (DataType type) const
5881 if (session_dirs.size() == 1) {
5883 case DataType::AUDIO:
5884 sp.push_back (_session_dir->sound_path());
5886 case DataType::MIDI:
5887 sp.push_back (_session_dir->midi_path());
5891 for (vector<space_and_path>::const_iterator i = session_dirs.begin(); i != session_dirs.end(); ++i) {
5892 SessionDirectory sdir (i->path);
5894 case DataType::AUDIO:
5895 sp.push_back (sdir.sound_path());
5897 case DataType::MIDI:
5898 sp.push_back (sdir.midi_path());
5904 if (type == DataType::AUDIO) {
5905 const string sound_path_2X = _session_dir->sound_path_2X();
5906 if (Glib::file_test (sound_path_2X, Glib::FILE_TEST_EXISTS|Glib::FILE_TEST_IS_DIR)) {
5907 if (find (sp.begin(), sp.end(), sound_path_2X) == sp.end()) {
5908 sp.push_back (sound_path_2X);
5913 // now check the explicit (possibly user-specified) search path
5916 case DataType::AUDIO:
5917 sp += Searchpath(config.get_audio_search_path ());
5919 case DataType::MIDI:
5920 sp += Searchpath(config.get_midi_search_path ());
5928 Session::ensure_search_path_includes (const string& path, DataType type)
5937 case DataType::AUDIO:
5938 sp += Searchpath(config.get_audio_search_path ());
5940 case DataType::MIDI:
5941 sp += Searchpath (config.get_midi_search_path ());
5945 for (vector<std::string>::iterator i = sp.begin(); i != sp.end(); ++i) {
5946 /* No need to add this new directory if it has the same inode as
5947 an existing one; checking inode rather than name prevents duplicated
5948 directories when we are using symlinks.
5950 On Windows, I think we could just do if (*i == path) here.
5952 if (PBD::equivalent_paths (*i, path)) {
5960 case DataType::AUDIO:
5961 config.set_audio_search_path (sp.to_string());
5963 case DataType::MIDI:
5964 config.set_midi_search_path (sp.to_string());
5970 Session::remove_dir_from_search_path (const string& dir, DataType type)
5975 case DataType::AUDIO:
5976 sp = Searchpath(config.get_audio_search_path ());
5978 case DataType::MIDI:
5979 sp = Searchpath (config.get_midi_search_path ());
5986 case DataType::AUDIO:
5987 config.set_audio_search_path (sp.to_string());
5989 case DataType::MIDI:
5990 config.set_midi_search_path (sp.to_string());
5996 boost::shared_ptr<Speakers>
5997 Session::get_speakers()
6003 Session::unknown_processors () const
6007 boost::shared_ptr<RouteList> r = routes.reader ();
6008 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6009 list<string> t = (*i)->unknown_processors ();
6010 copy (t.begin(), t.end(), back_inserter (p));
6020 Session::update_latency (bool playback)
6022 DEBUG_TRACE (DEBUG::Latency, string_compose ("JACK latency callback: %1\n", (playback ? "PLAYBACK" : "CAPTURE")));
6024 if ((_state_of_the_state & (InitialConnecting|Deletion)) || _adding_routes_in_progress) {
6028 boost::shared_ptr<RouteList> r = routes.reader ();
6029 framecnt_t max_latency = 0;
6032 /* reverse the list so that we work backwards from the last route to run to the first */
6033 RouteList* rl = routes.reader().get();
6034 r.reset (new RouteList (*rl));
6035 reverse (r->begin(), r->end());
6038 /* compute actual latency values for the given direction and store them all in per-port
6039 structures. this will also publish the same values (to JACK) so that computation of latency
6040 for routes can consistently use public latency values.
6043 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6044 max_latency = max (max_latency, (*i)->set_private_port_latencies (playback));
6047 /* because we latency compensate playback, our published playback latencies should
6048 be the same for all output ports - all material played back by ardour has
6049 the same latency, whether its caused by plugins or by latency compensation. since
6050 these may differ from the values computed above, reset all playback port latencies
6054 DEBUG_TRACE (DEBUG::Latency, string_compose ("Set public port latencies to %1\n", max_latency));
6056 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6057 (*i)->set_public_port_latencies (max_latency, playback);
6062 post_playback_latency ();
6066 post_capture_latency ();
6069 DEBUG_TRACE (DEBUG::Latency, "JACK latency callback: DONE\n");
6073 Session::post_playback_latency ()
6075 set_worst_playback_latency ();
6077 boost::shared_ptr<RouteList> r = routes.reader ();
6079 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6080 if (!(*i)->is_auditioner() && ((*i)->active())) {
6081 _worst_track_latency = max (_worst_track_latency, (*i)->update_signal_latency ());
6085 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6086 (*i)->set_latency_compensation (_worst_track_latency);
6091 Session::post_capture_latency ()
6093 set_worst_capture_latency ();
6095 /* reflect any changes in capture latencies into capture offsets
6098 boost::shared_ptr<RouteList> rl = routes.reader();
6099 for (RouteList::iterator i = rl->begin(); i != rl->end(); ++i) {
6100 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
6102 tr->set_capture_offset ();
6108 Session::initialize_latencies ()
6111 Glib::Threads::Mutex::Lock lm (_engine.process_lock());
6112 update_latency (false);
6113 update_latency (true);
6116 set_worst_io_latencies ();
6120 Session::set_worst_io_latencies ()
6122 set_worst_playback_latency ();
6123 set_worst_capture_latency ();
6127 Session::set_worst_playback_latency ()
6129 if (_state_of_the_state & (InitialConnecting|Deletion)) {
6133 _worst_output_latency = 0;
6135 if (!_engine.connected()) {
6139 boost::shared_ptr<RouteList> r = routes.reader ();
6141 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6142 _worst_output_latency = max (_worst_output_latency, (*i)->output()->latency());
6145 DEBUG_TRACE (DEBUG::Latency, string_compose ("Worst output latency: %1\n", _worst_output_latency));
6149 Session::set_worst_capture_latency ()
6151 if (_state_of_the_state & (InitialConnecting|Deletion)) {
6155 _worst_input_latency = 0;
6157 if (!_engine.connected()) {
6161 boost::shared_ptr<RouteList> r = routes.reader ();
6163 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6164 _worst_input_latency = max (_worst_input_latency, (*i)->input()->latency());
6167 DEBUG_TRACE (DEBUG::Latency, string_compose ("Worst input latency: %1\n", _worst_input_latency));
6171 Session::update_latency_compensation (bool force_whole_graph)
6173 bool some_track_latency_changed = false;
6175 if (_state_of_the_state & (InitialConnecting|Deletion)) {
6179 DEBUG_TRACE(DEBUG::Latency, "---------------------------- update latency compensation\n\n");
6181 _worst_track_latency = 0;
6183 boost::shared_ptr<RouteList> r = routes.reader ();
6185 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6186 if (!(*i)->is_auditioner() && ((*i)->active())) {
6188 if ((*i)->signal_latency () != (tl = (*i)->update_signal_latency ())) {
6189 some_track_latency_changed = true;
6191 _worst_track_latency = max (tl, _worst_track_latency);
6195 DEBUG_TRACE (DEBUG::Latency, string_compose ("worst signal processing latency: %1 (changed ? %2)\n", _worst_track_latency,
6196 (some_track_latency_changed ? "yes" : "no")));
6198 DEBUG_TRACE(DEBUG::Latency, "---------------------------- DONE update latency compensation\n\n");
6200 if (some_track_latency_changed || force_whole_graph) {
6201 _engine.update_latencies ();
6205 for (RouteList::iterator i = r->begin(); i != r->end(); ++i) {
6206 boost::shared_ptr<Track> tr = boost::dynamic_pointer_cast<Track> (*i);
6210 tr->set_capture_offset ();
6215 Session::session_name_is_legal (const string& path)
6217 char illegal_chars[] = { '/', '\\', ':', ';', '\0' };
6219 for (int i = 0; illegal_chars[i]; ++i) {
6220 if (path.find (illegal_chars[i]) != string::npos) {
6221 return illegal_chars[i];
6229 Session::next_control_id () const
6233 /* the monitor bus remote ID is in a different
6234 * "namespace" than regular routes. its existence doesn't
6235 * affect normal (low) numbered routes.
6242 /* the same about masterbus in Waves Tracks */
6244 if (Profile->get_trx() && _master_out) {
6248 return nroutes() - subtract;
6252 Session::notify_remote_id_change ()
6254 if (deletion_in_progress()) {
6258 switch (Config->get_remote_model()) {
6260 Route::RemoteControlIDChange (); /* EMIT SIGNAL */
6266 #ifdef USE_TRACKS_CODE_FEATURES
6267 /* Waves Tracks: for Waves Tracks session it's required to reconnect their IOs
6268 * if track order has been changed by user
6270 reconnect_existing_routes(true, true);
6276 Session::sync_order_keys ()
6278 if (deletion_in_progress()) {
6282 /* tell everyone that something has happened to the sort keys
6283 and let them sync up with the change(s)
6284 this will give objects that manage the sort order keys the
6285 opportunity to keep them in sync if they wish to.
6288 DEBUG_TRACE (DEBUG::OrderKeys, "Sync Order Keys.\n");
6290 reassign_track_numbers();
6292 Route::SyncOrderKeys (); /* EMIT SIGNAL */
6294 DEBUG_TRACE (DEBUG::OrderKeys, "\tsync done\n");
6298 Session::operation_in_progress (GQuark op) const
6300 return (find (_current_trans_quarks.begin(), _current_trans_quarks.end(), op) != _current_trans_quarks.end());
6303 boost::shared_ptr<Port>
6304 Session::ltc_input_port () const
6306 return _ltc_input->nth (0);
6309 boost::shared_ptr<Port>
6310 Session::ltc_output_port () const
6312 return _ltc_output->nth (0);
6316 Session::reconnect_ltc_input ()
6320 string src = Config->get_ltc_source_port();
6322 _ltc_input->disconnect (this);
6324 if (src != _("None") && !src.empty()) {
6325 _ltc_input->nth (0)->connect (src);
6328 if ( ARDOUR::Profile->get_trx () ) {
6329 // Tracks need this signal to update timecode_source_dropdown
6330 MtcOrLtcInputPortChanged (); //emit signal
6336 Session::reconnect_ltc_output ()
6340 string src = Config->get_ltc_output_port();
6342 _ltc_output->disconnect (this);
6344 if (src != _("None") && !src.empty()) {
6345 _ltc_output->nth (0)->connect (src);
6351 Session::set_range_selection (framepos_t start, framepos_t end)
6353 _range_selection = Evoral::Range<framepos_t> (start, end);
6354 #ifdef USE_TRACKS_CODE_FEATURES
6355 follow_playhead_priority ();
6360 Session::set_object_selection (framepos_t start, framepos_t end)
6362 _object_selection = Evoral::Range<framepos_t> (start, end);
6363 #ifdef USE_TRACKS_CODE_FEATURES
6364 follow_playhead_priority ();
6369 Session::clear_range_selection ()
6371 _range_selection = Evoral::Range<framepos_t> (-1,-1);
6372 #ifdef USE_TRACKS_CODE_FEATURES
6373 follow_playhead_priority ();
6378 Session::clear_object_selection ()
6380 _object_selection = Evoral::Range<framepos_t> (-1,-1);
6381 #ifdef USE_TRACKS_CODE_FEATURES
6382 follow_playhead_priority ();