2 Copyright (C) 2000 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.
20 #ifndef __ardour_session_h__
21 #define __ardour_session_h__
24 #include "libardour-config.h"
36 #include <boost/dynamic_bitset.hpp>
37 #include <boost/scoped_ptr.hpp>
38 #include <boost/weak_ptr.hpp>
39 #include <boost/utility.hpp>
41 #include <glibmm/threads.h>
45 #include "pbd/error.h"
46 #include "pbd/event_loop.h"
47 #include "pbd/file_archive.h"
49 #include "pbd/reallocpool.h"
50 #include "pbd/statefuldestructible.h"
51 #include "pbd/signals.h"
54 #include "lua/luastate.h"
56 #include "evoral/Range.hpp"
58 #include "midi++/types.h"
59 #include "midi++/mmc.h"
61 #include "temporal/time.h"
63 #include "ardour/ardour.h"
64 #include "ardour/chan_count.h"
65 #include "ardour/delivery.h"
66 #include "ardour/interthread_info.h"
67 #include "ardour/luascripting.h"
68 #include "ardour/location.h"
69 #include "ardour/monitor_processor.h"
70 #include "ardour/presentation_info.h"
71 #include "ardour/rc_configuration.h"
72 #include "ardour/session_configuration.h"
73 #include "ardour/session_event.h"
74 #include "ardour/interpolation.h"
75 #include "ardour/plugin.h"
76 #include "ardour/presentation_info.h"
77 #include "ardour/route.h"
78 #include "ardour/route_graph.h"
84 typedef struct _AEffect AEffect;
110 class AudioFileSource;
115 class AutomationList;
128 class MidiClockTicker;
130 class MidiPortManager;
151 class SessionDirectory;
152 class SessionMetadata;
153 class SessionPlaylists;
157 class TransportMaster;
159 class UI_TransportMaster;
161 class WindowsVSTPlugin;
163 extern void setup_enum_writer ();
165 class LIBARDOUR_API SessionException: public std::exception {
167 explicit SessionException(const std::string msg) : _message(msg) {}
168 virtual ~SessionException() throw() {}
170 virtual const char* what() const throw() { return _message.c_str(); }
173 std::string _message;
176 /** Ardour Session */
177 class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::ScopedConnectionList, public SessionEventManager
188 /* a new session might have non-empty mix_template, an existing session should always have an empty one.
189 the bus profile can be null if no master out bus is required.
192 Session (AudioEngine&,
193 const std::string& fullpath,
194 const std::string& snapshot_name,
195 BusProfile* bus_profile = 0,
196 std::string mix_template = "");
200 static int get_info_from_path (const std::string& xmlpath, float& sample_rate, SampleFormat& data_format, std::string& program_version);
201 static std::string get_snapshot_from_instant (const std::string& session_dir);
203 /** a monotonic counter used for naming user-visible things uniquely
204 * (curently the sidechain port).
205 * Use sparingly to keep the numbers low, prefer PBD::ID for all
206 * internal, not user-visible IDs */
207 static unsigned int next_name_id ();
209 std::string path() const { return _path; }
210 std::string name() const { return _name; }
211 std::string snap_name() const { return _current_snapshot_name; }
212 std::string raid_path () const;
213 bool path_is_within_session (const std::string&);
215 bool writable() const { return _writable; }
218 bool dirty() const { return _state_of_the_state & Dirty; }
219 void set_deletion_in_progress ();
220 void clear_deletion_in_progress ();
221 bool reconnection_in_progress() const { return _reconnecting_routes_in_progress; }
222 bool deletion_in_progress() const { return _state_of_the_state & Deletion; }
223 bool routes_deletion_in_progress() const { return _route_deletion_in_progress; }
224 bool peaks_cleanup_in_progres() const { return _state_of_the_state & PeakCleanup; }
225 bool loading () const { return _state_of_the_state & Loading; }
227 PBD::Signal0<void> DirtyChanged;
229 const SessionDirectory& session_directory () const { return *(_session_dir.get()); }
231 static PBD::Signal1<void,std::string> Dialog;
233 PBD::Signal0<void> BatchUpdateStart;
234 PBD::Signal0<void> BatchUpdateEnd;
236 int ensure_subdirs ();
238 std::string automation_dir () const; ///< Automation data
239 std::string analysis_dir () const; ///< Analysis data
240 std::string plugins_dir () const; ///< Plugin state
241 std::string externals_dir () const; ///< Links to external files
243 std::string construct_peak_filepath (const std::string& audio_path, const bool in_session = false, const bool old_peak_name = false) const;
245 bool audio_source_name_is_unique (const std::string& name);
246 std::string format_audio_source_name (const std::string& legalized_base, uint32_t nchan, uint32_t chan, bool destructive, bool take_required, uint32_t cnt, bool related_exists);
247 std::string new_audio_source_path_for_embedded (const std::string& existing_path);
248 std::string new_audio_source_path (const std::string&, uint32_t nchans, uint32_t chan, bool destructive, bool take_required);
249 std::string new_midi_source_path (const std::string&, bool need_source_lock = true);
250 /** create a new track or bus from a template (XML path)
251 * @param how_many how many tracks or busses to create
252 * @param template_path path to xml template file
253 * @param name name (prefix) of the route to create
254 * @param pd Playlist disposition
255 * @return list of newly created routes
257 RouteList new_route_from_template (uint32_t how_many, PresentationInfo::order_t insert_at, const std::string& template_path, const std::string& name, PlaylistDisposition pd = NewPlaylist);
258 RouteList new_route_from_template (uint32_t how_many, PresentationInfo::order_t insert_at, XMLNode&, const std::string& name, PlaylistDisposition pd = NewPlaylist);
259 std::vector<std::string> get_paths_for_new_sources (bool allow_replacing, const std::string& import_file_path,
260 uint32_t channels, std::vector<std::string> const & smf_track_names);
262 int bring_all_sources_into_session (boost::function<void(uint32_t,uint32_t,std::string)> callback);
264 void process (pframes_t nframes);
266 BufferSet& get_silent_buffers (ChanCount count = ChanCount::ZERO);
267 BufferSet& get_noinplace_buffers (ChanCount count = ChanCount::ZERO);
268 BufferSet& get_scratch_buffers (ChanCount count = ChanCount::ZERO, bool silence = true);
269 BufferSet& get_route_buffers (ChanCount count = ChanCount::ZERO, bool silence = true);
270 BufferSet& get_mix_buffers (ChanCount count = ChanCount::ZERO);
272 bool have_rec_enabled_track () const;
273 bool have_rec_disabled_track () const;
275 bool have_captured() const { return _have_captured; }
277 void refill_all_track_buffers ();
278 Butler* butler() { return _butler; }
279 void butler_transport_work ();
281 void refresh_disk_space ();
283 int load_routes (const XMLNode&, int);
284 boost::shared_ptr<RouteList> get_routes() const {
285 return routes.reader ();
288 boost::shared_ptr<RTTaskList> rt_tasklist () { return _rt_tasklist; }
290 RouteList get_routelist (bool mixer_order = false, PresentationInfo::Flag fl = PresentationInfo::MixerRoutes) const;
292 CoreSelection& selection () { return *_selection; }
294 /* because the set of Stripables consists of objects managed
295 * independently, in multiple containers within the Session (or objects
296 * owned by the session), we fill out a list in-place rather than
297 * return a pointer to a copy of the (RCU) managed list, as happens
301 void get_stripables (StripableList&, PresentationInfo::Flag fl = PresentationInfo::MixerStripables) const;
302 StripableList get_stripables () const;
303 boost::shared_ptr<RouteList> get_tracks() const;
304 boost::shared_ptr<RouteList> get_routes_with_internal_returns() const;
305 boost::shared_ptr<RouteList> get_routes_with_regions_at (samplepos_t const) const;
307 boost::shared_ptr<AudioTrack> get_nth_audio_track (int nth) const;
309 uint32_t nstripables (bool with_monitor = false) const;
310 uint32_t nroutes() const { return routes.reader()->size(); }
311 uint32_t ntracks () const;
312 uint32_t nbusses () const;
314 boost::shared_ptr<BundleList> bundles () {
315 return _bundles.reader ();
318 void notify_presentation_info_change ();
320 template<class T> void foreach_route (T *obj, void (T::*func)(Route&), bool sort = true);
321 template<class T> void foreach_route (T *obj, void (T::*func)(boost::shared_ptr<Route>), bool sort = true);
322 template<class T, class A> void foreach_route (T *obj, void (T::*func)(Route&, A), A arg, bool sort = true);
324 static char session_name_is_legal (const std::string&);
325 bool io_name_is_legal (const std::string&) const;
326 boost::shared_ptr<Route> route_by_name (std::string) const;
327 boost::shared_ptr<Route> route_by_id (PBD::ID) const;
328 boost::shared_ptr<Stripable> stripable_by_id (PBD::ID) const;
329 boost::shared_ptr<Stripable> get_remote_nth_stripable (PresentationInfo::order_t n, PresentationInfo::Flag) const;
330 boost::shared_ptr<Route> get_remote_nth_route (PresentationInfo::order_t n) const;
331 boost::shared_ptr<Route> route_by_selected_count (uint32_t cnt) const;
332 void routes_using_input_from (const std::string& str, RouteList& rl);
334 bool route_name_unique (std::string) const;
335 bool route_name_internal (std::string) const;
337 uint32_t track_number_decimals () const {
338 return _track_number_decimals;
341 bool get_record_enabled() const {
342 return (record_status () >= Enabled);
345 RecordState record_status() const {
346 return (RecordState) g_atomic_int_get (&_record_status);
349 bool actively_recording () const {
350 return record_status() == Recording;
353 bool record_enabling_legal () const;
354 void maybe_enable_record (bool rt_context = false);
355 void disable_record (bool rt_context, bool force = false);
356 void step_back_from_record ();
358 void set_all_tracks_record_enabled(bool);
360 void maybe_write_autosave ();
362 /* Emitted when all i/o connections are complete */
364 PBD::Signal0<void> IOConnectionsComplete;
366 /* Record status signals */
368 PBD::Signal0<void> RecordStateChanged; /* signals changes in recording state (i.e. are we recording) */
369 /* XXX may 2015: paul says: it isn't clear to me that this has semantics that cannot be inferrred
370 from the previous signal and session state.
372 PBD::Signal0<void> RecordArmStateChanged; /* signals changes in recording arming */
374 /* Emited when session is loaded */
375 PBD::Signal0<void> SessionLoaded;
377 /* Transport mechanism signals */
379 /** Emitted on the following changes in transport state:
380 * - stop (from the butler thread)
381 * - change in whether or not we are looping (from the process thread)
382 * - change in the play range (from the process thread)
383 * - start (from the process thread)
386 PBD::Signal0<void> TransportStateChange;
388 PBD::Signal1<void,samplepos_t> PositionChanged; /* sent after any non-sequential motion */
389 PBD::Signal1<void,samplepos_t> Xrun;
390 PBD::Signal0<void> TransportLooped;
392 /** emitted when a locate has occurred */
393 PBD::Signal0<void> Located;
395 PBD::Signal1<void,RouteList&> RouteAdded;
396 /** Emitted when a property of one of our route groups changes.
397 * The parameter is the RouteGroup that has changed.
399 PBD::Signal1<void, RouteGroup *> RouteGroupPropertyChanged;
400 /** Emitted when a route is added to one of our route groups.
401 * First parameter is the RouteGroup, second is the route.
403 PBD::Signal2<void, RouteGroup *, boost::weak_ptr<Route> > RouteAddedToRouteGroup;
404 /** Emitted when a route is removed from one of our route groups.
405 * First parameter is the RouteGroup, second is the route.
407 PBD::Signal2<void, RouteGroup *, boost::weak_ptr<Route> > RouteRemovedFromRouteGroup;
409 /* Step Editing status changed */
410 PBD::Signal1<void,bool> StepEditStatusChange;
412 /* Timecode state signals */
413 PBD::Signal0<void> MtcOrLtcInputPortChanged;
415 void queue_event (SessionEvent*);
417 void request_roll_at_and_return (samplepos_t start, samplepos_t return_to);
418 void request_bounded_roll (samplepos_t start, samplepos_t end);
419 void request_stop (bool abort = false, bool clear_state = false, TransportRequestSource origin = TRS_UI);
420 void request_locate (samplepos_t sample, bool with_roll = false, TransportRequestSource origin = TRS_UI);
422 void request_play_loop (bool yn, bool leave_rolling = false);
423 bool get_play_loop () const { return play_loop; }
425 samplepos_t last_transport_start () const { return _last_roll_location; }
427 void goto_start (bool and_roll = false);
428 void use_rf_shuttle_speed ();
429 void allow_auto_play (bool yn);
430 void request_transport_speed (double speed, bool as_default = true, TransportRequestSource origin = TRS_UI);
431 void request_transport_speed_nonzero (double, bool as_default = true, TransportRequestSource origin = TRS_UI);
432 void request_overwrite_buffer (boost::shared_ptr<Route>);
433 void adjust_playback_buffering();
434 void adjust_capture_buffering();
436 bool global_locate_pending() const { return _global_locate_pending; }
437 bool locate_pending() const { return static_cast<bool>(post_transport_work()&PostTransportLocate); }
438 bool transport_locked () const;
442 samplepos_t current_end_sample () const;
443 samplepos_t current_start_sample () const;
444 /** "actual" sample rate of session, set by current audioengine rate, pullup/down etc. */
445 samplecnt_t sample_rate () const { return _current_sample_rate; }
446 /** "native" sample rate of session, regardless of current audioengine rate, pullup/down etc */
447 samplecnt_t nominal_sample_rate () const { return _nominal_sample_rate; }
448 samplecnt_t frames_per_hour () const { return _frames_per_hour; }
450 double samples_per_timecode_frame() const { return _samples_per_timecode_frame; }
451 samplecnt_t timecode_frames_per_hour() const { return _timecode_frames_per_hour; }
453 MIDI::byte get_mtc_timecode_bits() const {
454 return mtc_timecode_bits; /* encoding of SMTPE type for MTC */
457 double timecode_frames_per_second() const;
458 bool timecode_drop_frames() const;
462 Locations *locations() { return _locations; }
464 PBD::Signal1<void,Location*> auto_loop_location_changed;
465 PBD::Signal1<void,Location*> auto_punch_location_changed;
466 PBD::Signal0<void> locations_modified;
468 void set_auto_punch_location (Location *);
469 void set_auto_loop_location (Location *);
470 void set_session_extents (samplepos_t start, samplepos_t end);
471 bool session_range_is_free () const { return _session_range_is_free; }
472 void set_session_range_is_free (bool);
474 pframes_t get_block_size () const { return current_block_size; }
475 samplecnt_t worst_output_latency () const { return _worst_output_latency; }
476 samplecnt_t worst_input_latency () const { return _worst_input_latency; }
477 samplecnt_t worst_route_latency () const { return _worst_route_latency; }
478 samplecnt_t worst_latency_preroll () const;
481 std::string new_parent_folder; /* parent folder where new session folder will be created */
482 std::string new_name; /* name of newly saved session */
483 bool switch_to; /* true if we should be working on newly saved session after save-as; false otherwise */
484 bool include_media; /* true if the newly saved session should contain references to media */
485 bool copy_media; /* true if media files (audio, media, etc) should be copied into newly saved session; false otherwise */
486 bool copy_external; /* true if external media should be consolidated into the newly saved session; false otherwise */
488 std::string final_session_folder_name; /* filled in by * Session::save_as(), provides full path to newly saved session */
490 /* emitted as we make progress. 3 arguments passed to signal
493 * 1: percentage complete measured as a fraction (0-1.0) of
494 * total data copying done.
495 * 2: number of files copied so far
496 * 3: total number of files to copy
498 * Handler should return true for save-as to continue, or false
499 * to stop (and remove all evidence of partial save-as).
501 PBD::Signal3<bool,float,int64_t,int64_t> Progress;
503 /* if save_as() returns non-zero, this string will indicate the reason why.
505 std::string failure_message;
508 int save_as (SaveAs&);
511 * @param snapshot_name name of the session (use an empty string for the current name)
512 * @param pending save a 'recovery', not full state (default: false)
513 * @param switch_to_snapshot switch to given snapshot after saving (default: false)
514 * @param template_only save a session template (default: false)
515 * @return zero on success
517 int save_state (std::string snapshot_name,
518 bool pending = false,
519 bool switch_to_snapshot = false,
520 bool template_only = false,
521 bool for_archive = false,
522 bool only_used_assets = false);
530 int archive_session (const std::string&, const std::string&,
531 ArchiveEncode compress_audio = FLAC_16BIT,
532 PBD::FileArchive::CompressionLevel compression_level = PBD::FileArchive::CompressGood,
533 bool only_used_sources = false,
536 int restore_state (std::string snapshot_name);
537 int save_template (const std::string& template_name, const std::string& description = "", bool replace_existing = false);
538 int save_history (std::string snapshot_name = "");
539 int restore_history (std::string snapshot_name);
540 void remove_state (std::string snapshot_name);
541 void rename_state (std::string old_name, std::string new_name);
542 void remove_pending_capture_state ();
543 int rename (const std::string&);
544 bool get_nsm_state () const { return _under_nsm_control; }
545 void set_nsm_state (bool state) { _under_nsm_control = state; }
546 bool save_default_options ();
548 PBD::Signal1<void,std::string> StateSaved;
549 PBD::Signal0<void> StateReady;
551 /* emitted when session needs to be saved due to some internal
552 * event or condition (i.e. not in response to a user request).
554 * Only one object should
555 * connect to this signal and take responsibility.
557 * Argument is the snapshot name to use when saving.
559 PBD::Signal1<void,std::string> SaveSessionRequested;
561 /* emitted during a session save to allow other entities to add state, via
562 * extra XML, to the session state
564 PBD::Signal0<void> SessionSaveUnderway;
566 std::vector<std::string> possible_states() const;
567 static std::vector<std::string> possible_states (std::string path);
569 bool export_track_state (boost::shared_ptr<RouteList> rl, const std::string& path);
571 /// The instant xml file is written to the session directory
572 void add_instant_xml (XMLNode&, bool write_to_config = true);
573 XMLNode* instant_xml (const std::string& str);
575 enum StateOfTheState {
580 InitialConnecting = 0x8,
586 StateOfTheState state_of_the_state() const { return _state_of_the_state; }
588 class StateProtector {
590 StateProtector (Session* s) : _session (s) {
591 g_atomic_int_inc (&s->_suspend_save);
594 if (g_atomic_int_dec_and_test (&_session->_suspend_save)) {
595 while (_session->_save_queued) {
596 _session->_save_queued = false;
597 _session->save_state ("");
605 class ProcessorChangeBlocker {
607 ProcessorChangeBlocker (Session* s, bool rc = true)
609 , _reconfigure_on_delete (rc)
611 g_atomic_int_inc (&s->_ignore_route_processor_changes);
613 ~ProcessorChangeBlocker () {
614 if (g_atomic_int_dec_and_test (&_session->_ignore_route_processor_changes)) {
615 if (_reconfigure_on_delete) {
616 _session->route_processors_changed (RouteProcessorChange ());
622 bool _reconfigure_on_delete;
625 RouteGroup* new_route_group (const std::string&);
626 void add_route_group (RouteGroup *);
627 void remove_route_group (RouteGroup* rg) { if (rg) remove_route_group (*rg); }
628 void remove_route_group (RouteGroup&);
629 void reorder_route_groups (std::list<RouteGroup*>);
631 RouteGroup* route_group_by_name (std::string);
632 RouteGroup& all_route_group() const;
634 PBD::Signal1<void,RouteGroup*> route_group_added;
635 PBD::Signal0<void> route_group_removed;
636 PBD::Signal0<void> route_groups_reordered;
638 void foreach_route_group (boost::function<void(RouteGroup*)> f) {
639 for (std::list<RouteGroup *>::iterator i = _route_groups.begin(); i != _route_groups.end(); ++i) {
644 std::list<RouteGroup*> const & route_groups () const {
645 return _route_groups;
648 /* fundamental operations. duh. */
650 std::list<boost::shared_ptr<AudioTrack> > new_audio_track (
653 RouteGroup* route_group,
655 std::string name_template,
656 PresentationInfo::order_t order,
657 TrackMode mode = Normal
660 std::list<boost::shared_ptr<MidiTrack> > new_midi_track (
661 const ChanCount& input, const ChanCount& output, bool strict_io,
662 boost::shared_ptr<PluginInfo> instrument,
663 Plugin::PresetRecord* pset,
664 RouteGroup* route_group, uint32_t how_many, std::string name_template,
665 PresentationInfo::order_t,
666 TrackMode mode = Normal
669 RouteList new_audio_route (int input_channels, int output_channels, RouteGroup* route_group, uint32_t how_many, std::string name_template, PresentationInfo::Flag, PresentationInfo::order_t);
670 RouteList new_midi_route (RouteGroup* route_group, uint32_t how_many, std::string name_template, bool strict_io, boost::shared_ptr<PluginInfo> instrument, Plugin::PresetRecord*, PresentationInfo::Flag, PresentationInfo::order_t);
672 void remove_routes (boost::shared_ptr<RouteList>);
673 void remove_route (boost::shared_ptr<Route>);
675 void resort_routes ();
676 void resort_routes_using (boost::shared_ptr<RouteList>);
678 AudioEngine & engine() { return _engine; }
679 AudioEngine const & engine () const { return _engine; }
681 static std::string default_track_name_pattern (DataType);
685 samplepos_t transport_sample () const { return _transport_sample; }
686 samplepos_t record_location () const { return _last_record_location; }
687 samplepos_t audible_sample (bool* latent_locate = NULL) const;
688 samplepos_t requested_return_sample() const { return _requested_return_sample; }
689 void set_requested_return_sample(samplepos_t return_to);
691 bool compute_audible_delta (samplepos_t& pos_and_delta) const;
692 samplecnt_t remaining_latency_preroll () const { return _remaining_latency_preroll; }
706 void sync_time_vars();
708 void bbt_time (samplepos_t when, Timecode::BBT_Time&);
709 void timecode_to_sample(Timecode::Time& timecode, samplepos_t& sample, bool use_offset, bool use_subframes) const;
710 void sample_to_timecode(samplepos_t sample, Timecode::Time& timecode, bool use_offset, bool use_subframes) const;
711 void timecode_time (Timecode::Time &);
712 void timecode_time (samplepos_t when, Timecode::Time&);
713 void timecode_time_subframes (samplepos_t when, Timecode::Time&);
715 void timecode_duration (samplecnt_t, Timecode::Time&) const;
716 void timecode_duration_string (char *, size_t len, samplecnt_t) const;
718 samplecnt_t convert_to_samples (AnyTime const & position);
719 samplecnt_t any_duration_to_samples (samplepos_t position, AnyTime const & duration);
721 static PBD::Signal1<void, samplepos_t> StartTimeChanged;
722 static PBD::Signal1<void, samplepos_t> EndTimeChanged;
724 void request_sync_source (boost::shared_ptr<TransportMaster>);
725 bool synced_to_engine() const;
727 double engine_speed() const { return _engine_speed; }
728 double actual_speed() const {
729 if (_transport_speed > 0) return _engine_speed;
730 if (_transport_speed < 0) return - _engine_speed;
733 double transport_speed() const { return _count_in_samples > 0 ? 0. : _transport_speed; }
734 bool transport_stopped() const { return _transport_speed == 0.0; }
735 bool transport_rolling() const { return _transport_speed != 0.0 && _count_in_samples == 0 && _remaining_latency_preroll == 0; }
737 bool silent () { return _silent; }
739 TempoMap& tempo_map() { return *_tempo_map; }
740 const TempoMap& tempo_map() const { return *_tempo_map; }
741 void maybe_update_tempo_from_midiclock_tempo (float bpm);
743 unsigned int get_xrun_count () const {return _xrun_count; }
744 void reset_xrun_count () {_xrun_count = 0; }
748 boost::shared_ptr<Region> find_whole_file_parent (boost::shared_ptr<Region const>) const;
750 boost::shared_ptr<Region> XMLRegionFactory (const XMLNode&, bool full);
751 boost::shared_ptr<AudioRegion> XMLAudioRegionFactory (const XMLNode&, bool full);
752 boost::shared_ptr<MidiRegion> XMLMidiRegionFactory (const XMLNode&, bool full);
754 /* source management */
756 void import_files (ImportStatus&);
757 bool sample_rate_convert (ImportStatus&, std::string infile, std::string& outfile);
758 std::string build_tmp_convert_name (std::string file);
760 boost::shared_ptr<ExportHandler> get_export_handler ();
761 boost::shared_ptr<ExportStatus> get_export_status ();
763 int start_audio_export (samplepos_t position, bool realtime = false, bool region_export = false);
765 PBD::Signal1<int, samplecnt_t> ProcessExport;
766 static PBD::Signal2<void,std::string, std::string> Exported;
768 void add_source (boost::shared_ptr<Source>);
769 void remove_source (boost::weak_ptr<Source>);
771 void cleanup_regions();
772 bool can_cleanup_peakfiles () const;
773 int cleanup_peakfiles ();
774 int cleanup_sources (CleanupReport&);
775 int cleanup_trash_sources (CleanupReport&);
777 int destroy_sources (std::list<boost::shared_ptr<Source> >);
779 int remove_last_capture ();
781 /** handlers should return 0 for "everything OK", and any other value for
782 * "cannot setup audioengine".
784 static PBD::Signal1<int,uint32_t> AudioEngineSetupRequired;
786 /** handlers should return -1 for "stop cleanup",
787 0 for "yes, delete this playlist",
788 1 for "no, don't delete this playlist".
790 static PBD::Signal1<int,boost::shared_ptr<Playlist> > AskAboutPlaylistDeletion;
792 /** handlers should return 0 for "ignore the rate mismatch",
793 !0 for "do not use this session"
795 static PBD::Signal2<int, samplecnt_t, samplecnt_t> AskAboutSampleRateMismatch;
797 /** non interactive message */
798 static PBD::Signal2<void, samplecnt_t, samplecnt_t> NotifyAboutSampleRateMismatch;
800 /** handlers should return !0 for use pending state, 0 for ignore it.
802 static PBD::Signal0<int> AskAboutPendingState;
804 boost::shared_ptr<AudioFileSource> create_audio_source_for_session (
805 size_t, std::string const &, uint32_t, bool destructive);
807 boost::shared_ptr<MidiSource> create_midi_source_for_session (std::string const &);
808 boost::shared_ptr<MidiSource> create_midi_source_by_stealing_name (boost::shared_ptr<Track>);
810 boost::shared_ptr<Source> source_by_id (const PBD::ID&);
811 boost::shared_ptr<AudioFileSource> audio_source_by_path_and_channel (const std::string&, uint16_t) const;
812 boost::shared_ptr<MidiSource> midi_source_by_path (const std::string&, bool need_source_lock) const;
813 uint32_t count_sources_by_origin (const std::string&);
815 void add_playlist (boost::shared_ptr<Playlist>, bool unused = false);
817 /* Curves and AutomationLists (TODO when they go away) */
818 void add_automation_list(AutomationList*);
822 boost::shared_ptr<Auditioner> the_auditioner() { return auditioner; }
823 void audition_playlist ();
824 void audition_region (boost::shared_ptr<Region>);
825 void cancel_audition ();
826 bool is_auditioning () const;
828 PBD::Signal1<void,bool> AuditionActive;
831 void register_lua_function (const std::string&, const std::string&, const LuaScriptParamList&);
832 void unregister_lua_function (const std::string& name);
833 std::vector<std::string> registered_lua_functions ();
834 uint32_t registered_lua_function_count () const { return _n_lua_scripts; }
835 void scripts_changed (); // called from lua, updates _n_lua_scripts
837 PBD::Signal0<void> LuaScriptsChanged;
839 /* flattening stuff */
841 boost::shared_ptr<Region> write_one_track (Track&, samplepos_t start, samplepos_t end,
842 bool overwrite, std::vector<boost::shared_ptr<Source> >&, InterThreadInfo& wot,
843 boost::shared_ptr<Processor> endpoint,
844 bool include_endpoint, bool for_export, bool for_freeze);
845 int freeze_all (InterThreadInfo&);
847 /* session-wide solo/mute/rec-enable */
850 std::vector<boost::weak_ptr<AutomationControl> > cancel_all_mute ();
852 bool soloing() const { return _non_soloed_outs_muted; }
853 bool listening() const { return _listen_cnt > 0; }
854 bool solo_isolated() const { return _solo_isolated_cnt > 0; }
855 void cancel_all_solo ();
857 bool solo_selection_active();
858 void solo_selection( StripableList&, bool );
860 static const SessionEvent::RTeventCallback rt_cleanup;
862 void clear_all_solo_state (boost::shared_ptr<RouteList>);
864 /* Control-based methods */
866 void set_controls (boost::shared_ptr<ControlList>, double val, PBD::Controllable::GroupControlDisposition);
867 void set_control (boost::shared_ptr<AutomationControl>, double val, PBD::Controllable::GroupControlDisposition);
869 void set_exclusive_input_active (boost::shared_ptr<RouteList> rt, bool onoff, bool flip_others = false);
871 PBD::Signal1<void,bool> SoloActive;
872 PBD::Signal0<void> SoloChanged;
873 PBD::Signal0<void> MuteChanged;
874 PBD::Signal0<void> IsolatedChanged;
875 PBD::Signal0<void> MonitorChanged;
876 PBD::Signal0<void> MonitorBusAddedOrRemoved;
878 PBD::Signal0<void> session_routes_reconnected;
880 /* monitor/master out */
881 int add_master_bus (ChanCount const&);
883 void reset_monitor_section ();
884 bool monitor_active() const { return (_monitor_out && _monitor_out->monitor_control () && _monitor_out->monitor_control ()->monitor_active()); }
886 boost::shared_ptr<Route> monitor_out() const { return _monitor_out; }
887 boost::shared_ptr<Route> master_out() const { return _master_out; }
889 PresentationInfo::order_t master_order_key () const { return _master_out ? _master_out->presentation_info ().order () : -1; }
890 bool ensure_stripable_sort_order ();
892 void globally_add_internal_sends (boost::shared_ptr<Route> dest, Placement p, bool);
893 void globally_set_send_gains_from_track (boost::shared_ptr<Route> dest);
894 void globally_set_send_gains_to_zero (boost::shared_ptr<Route> dest);
895 void globally_set_send_gains_to_unity (boost::shared_ptr<Route> dest);
896 void add_internal_sends (boost::shared_ptr<Route> dest, Placement p, boost::shared_ptr<RouteList> senders);
897 void add_internal_send (boost::shared_ptr<Route>, int, boost::shared_ptr<Route>);
898 void add_internal_send (boost::shared_ptr<Route>, boost::shared_ptr<Processor>, boost::shared_ptr<Route>);
900 static void set_disable_all_loaded_plugins (bool yn) {
901 _disable_all_loaded_plugins = yn;
903 static bool get_disable_all_loaded_plugins() {
904 return _disable_all_loaded_plugins;
906 static void set_bypass_all_loaded_plugins (bool yn) {
907 _bypass_all_loaded_plugins = yn;
909 static bool get_bypass_all_loaded_plugins() {
910 return _bypass_all_loaded_plugins;
913 uint32_t next_send_id();
914 uint32_t next_aux_send_id();
915 uint32_t next_return_id();
916 uint32_t next_insert_id();
917 void mark_send_id (uint32_t);
918 void mark_aux_send_id (uint32_t);
919 void mark_return_id (uint32_t);
920 void mark_insert_id (uint32_t);
921 void unmark_send_id (uint32_t);
922 void unmark_aux_send_id (uint32_t);
923 void unmark_return_id (uint32_t);
924 void unmark_insert_id (uint32_t);
926 /* s/w "RAID" management */
928 boost::optional<samplecnt_t> available_capture_duration();
932 void add_bundle (boost::shared_ptr<Bundle>, bool emit_signal = true);
933 void remove_bundle (boost::shared_ptr<Bundle>);
934 boost::shared_ptr<Bundle> bundle_by_name (std::string) const;
936 PBD::Signal0<void> BundleAddedOrRemoved;
940 /* History (for editors, mixers, UIs etc.) */
942 /** Undo some transactions.
943 * @param n Number of transactions to undo.
945 void undo (uint32_t n);
946 /** Redo some transactions.
947 * @param n Number of transactions to undo.
949 void redo (uint32_t n);
951 UndoHistory& history() { return _history; }
953 uint32_t undo_depth() const { return _history.undo_depth(); }
954 uint32_t redo_depth() const { return _history.redo_depth(); }
955 std::string next_undo() const { return _history.next_undo(); }
956 std::string next_redo() const { return _history.next_redo(); }
958 /** begin collecting undo information
960 * This call must always be followed by either
961 * begin_reversible_command() or commit_reversible_command()
963 * @param cmd_name human readable name for the undo operation
965 void begin_reversible_command (const std::string& cmd_name);
966 void begin_reversible_command (GQuark);
967 /** abort an open undo command
968 * This must only be called after begin_reversible_command ()
970 void abort_reversible_command ();
971 /** finalize an undo command and commit pending transactions
973 * This must only be called after begin_reversible_command ()
974 * @param cmd (additional) command to add
976 void commit_reversible_command (Command* cmd = 0);
978 void add_command (Command *const cmd);
980 /** create an StatefulDiffCommand from the given object and add it to the stack.
982 * This function must only be called after begin_reversible_command.
983 * Failing to do so may lead to a crash.
985 * @param sfd the object to diff
986 * @returns the allocated StatefulDiffCommand (already added via add_command)
988 PBD::StatefulDiffCommand* add_stateful_diff_command (boost::shared_ptr<PBD::StatefulDestructible> sfd);
990 /** @return The list of operations that are currently in progress */
991 std::list<GQuark> const & current_operations () {
992 return _current_trans_quarks;
995 bool operation_in_progress (GQuark) const;
997 void add_commands (std::vector<Command*> const & cmds);
999 std::map<PBD::ID,PBD::StatefulDestructible*> registry;
1001 // these commands are implemented in libs/ardour/session_command.cc
1002 Command* memento_command_factory(XMLNode* n);
1003 Command* stateful_diff_command_factory (XMLNode *);
1004 void register_with_memento_command_factory(PBD::ID, PBD::StatefulDestructible*);
1008 boost::shared_ptr<IO> click_io() { return _click_io; }
1009 boost::shared_ptr<Amp> click_gain() { return _click_gain; }
1011 /* disk, buffer loads */
1013 uint32_t playback_load ();
1014 uint32_t capture_load ();
1018 void request_play_range (std::list<AudioRange>*, bool leave_rolling = false);
1019 void request_cancel_play_range ();
1020 bool get_play_range () const { return _play_range; }
1022 void maybe_update_session_range (samplepos_t, samplepos_t);
1025 samplecnt_t preroll_samples (samplepos_t) const;
1027 void request_preroll_record_trim (samplepos_t start, samplecnt_t preroll);
1028 void request_count_in_record ();
1030 samplecnt_t preroll_record_trim_len () const { return _preroll_record_trim_len; }
1032 /* temporary hacks to allow selection to be pushed from GUI into backend.
1033 Whenever we move the selection object into libardour, these will go away.
1035 void set_range_selection (samplepos_t start, samplepos_t end);
1036 void set_object_selection (samplepos_t start, samplepos_t end);
1037 void clear_range_selection ();
1038 void clear_object_selection ();
1040 /* buffers for gain and pan */
1042 gain_t* gain_automation_buffer () const;
1043 gain_t* trim_automation_buffer () const;
1044 gain_t* send_gain_automation_buffer () const;
1045 gain_t* scratch_automation_buffer () const;
1046 pan_t** pan_automation_buffer () const;
1048 void ensure_buffer_set (BufferSet& buffers, const ChanCount& howmany);
1052 static int vst_current_loading_id;
1053 static const char* vst_can_do_strings[];
1054 static const int vst_can_do_string_count;
1056 static intptr_t vst_callback (
1065 static PBD::Signal0<void> SendFeedback;
1069 boost::shared_ptr<Speakers> get_speakers ();
1073 boost::shared_ptr<Processor> processor_by_id (PBD::ID) const;
1075 boost::shared_ptr<PBD::Controllable> controllable_by_id (const PBD::ID&);
1076 boost::shared_ptr<AutomationControl> automation_control_by_id (const PBD::ID&);
1078 void add_controllable (boost::shared_ptr<PBD::Controllable>);
1079 void remove_controllable (PBD::Controllable*);
1081 boost::shared_ptr<PBD::Controllable> solo_cut_control() const;
1083 SessionConfiguration config;
1085 SessionConfiguration* cfg () { return &config; }
1087 bool exporting () const {
1091 bool bounce_processing() const {
1092 return _bounce_processing_active;
1095 /* this is a private enum, but setup_enum_writer() needs it,
1096 and i can't find a way to give that function
1097 friend access. sigh.
1100 enum PostTransportWork {
1101 PostTransportStop = 0x1,
1102 PostTransportDuration = 0x2,
1103 PostTransportLocate = 0x4,
1104 PostTransportRoll = 0x8,
1105 PostTransportAbort = 0x10,
1106 PostTransportOverWrite = 0x20,
1107 /* PostTransportSpeed = 0x40, */
1108 PostTransportAudition = 0x80,
1109 PostTransportReverse = 0x100,
1110 /* PostTransportInputChange = 0x200, */
1111 /*PostTransportCurveRealloc = 0x400, */
1112 PostTransportClearSubstate = 0x800,
1113 PostTransportAdjustPlaybackBuffering = 0x1000,
1114 PostTransportAdjustCaptureBuffering = 0x2000
1117 boost::shared_ptr<SessionPlaylists> playlists;
1119 void send_mmc_locate (samplepos_t);
1120 void queue_full_time_code () { _send_timecode_update = true; }
1121 void queue_song_position_pointer () { /* currently does nothing */ }
1123 bool step_editing() const { return (_step_editors > 0); }
1125 void request_suspend_timecode_transmission ();
1126 void request_resume_timecode_transmission ();
1127 bool timecode_transmission_suspended () const;
1129 std::vector<std::string> source_search_path(DataType) const;
1130 void ensure_search_path_includes (const std::string& path, DataType type);
1131 void remove_dir_from_search_path (const std::string& path, DataType type);
1133 std::list<std::string> unknown_processors () const;
1135 /** Emitted when a feedback cycle has been detected within Ardour's signal
1136 processing path. Until it is fixed (by the user) some (unspecified)
1137 routes will not be run.
1139 static PBD::Signal0<void> FeedbackDetected;
1141 /** Emitted when a graph sort has successfully completed, which means
1142 that it has no feedback cycles.
1144 static PBD::Signal0<void> SuccessfulGraphSort;
1146 /* handlers can return an integer value:
1147 0: config.set_audio_search_path() or config.set_midi_search_path() was used
1148 to modify the search path and we should try to find it again.
1149 1: quit entire session load
1150 2: as 0, but don't ask about other missing files
1151 3: don't ask about other missing files, and just mark this one missing
1152 -1: just mark this one missing
1153 any other value: as -1
1155 static PBD::Signal3<int,Session*,std::string,DataType> MissingFile;
1157 void set_missing_file_replacement (const std::string& mfr) {
1158 _missing_file_replacement = mfr;
1161 /** Emitted when the session wants Ardour to quit */
1162 static PBD::Signal0<void> Quit;
1164 /** Emitted when Ardour is asked to load a session in an older session
1165 * format, and makes a backup copy.
1167 static PBD::Signal2<void,std::string,std::string> VersionMismatch;
1169 SceneChanger* scene_changer() const { return _scene_changer; }
1171 /* asynchronous MIDI control ports */
1173 boost::shared_ptr<Port> midi_input_port () const;
1174 boost::shared_ptr<Port> midi_output_port () const;
1175 boost::shared_ptr<Port> mmc_output_port () const;
1176 boost::shared_ptr<Port> mmc_input_port () const;
1177 boost::shared_ptr<Port> scene_input_port () const;
1178 boost::shared_ptr<Port> scene_output_port () const;
1180 /* synchronous MIDI ports used for synchronization */
1182 boost::shared_ptr<MidiPort> midi_clock_output_port () const;
1183 boost::shared_ptr<MidiPort> mtc_output_port () const;
1184 boost::shared_ptr<Port> ltc_output_port() const;
1186 boost::shared_ptr<IO> ltc_output_io() { return _ltc_output; }
1188 MIDI::MachineControl& mmc() { return *_mmc; }
1190 void reconnect_midi_scene_ports (bool);
1191 void reconnect_mmc_ports (bool);
1193 void reconnect_ltc_output ();
1195 VCAManager& vca_manager() { return *_vca_manager; }
1196 VCAManager* vca_manager_ptr() { return _vca_manager; }
1198 void auto_connect_thread_wakeup ();
1200 double compute_speed_from_master (pframes_t nframes);
1201 bool transport_master_is_external() const;
1202 bool transport_master_no_external_or_using_engine() const;
1203 boost::shared_ptr<TransportMaster> transport_master() const;
1205 void import_pt (PTFFormat& ptf, ImportStatus& status);
1206 bool import_sndfile_as_region (std::string path, SrcQuality quality, samplepos_t& pos, SourceList& sources, ImportStatus& status);
1209 friend class AudioEngine;
1210 void set_block_size (pframes_t nframes);
1211 void set_sample_rate (samplecnt_t nframes);
1212 #ifdef USE_TRACKS_CODE_FEATURES
1213 void reconnect_existing_routes (bool withLock, bool reconnect_master = true, bool reconnect_inputs = true, bool reconnect_outputs = true);
1217 void update_latency_compensation (bool force = false);
1220 int create (const std::string& mix_template, BusProfile*);
1223 static guint _name_id_counter;
1224 static void init_name_id_counter (guint n);
1225 static unsigned int name_id_counter ();
1227 /* stuff used in process() should be close together to
1231 typedef void (Session::*process_function_type)(pframes_t);
1233 AudioEngine& _engine;
1234 mutable gint processing_prohibited;
1235 process_function_type process_function;
1236 process_function_type last_process_function;
1237 bool _bounce_processing_active;
1238 bool waiting_for_sync_offset;
1239 samplecnt_t _base_sample_rate; // sample-rate of the session at creation time, "native" SR
1240 samplecnt_t _nominal_sample_rate; // overridden by audioengine setting
1241 samplecnt_t _current_sample_rate; // this includes video pullup offset
1242 int transport_sub_state;
1243 mutable gint _record_status;
1244 samplepos_t _transport_sample;
1246 Location* _session_range_location; ///< session range, or 0 if there is nothing in the session yet
1247 bool _session_range_is_free;
1249 samplecnt_t _remaining_latency_preroll;
1251 // varispeed playback -- TODO: move out of session to backend.
1252 double _engine_speed;
1253 double _transport_speed; // only: -1, 0, +1
1254 double _default_transport_speed;
1255 double _last_transport_speed;
1256 double _signalled_varispeed;
1257 double _target_transport_speed;
1259 bool auto_play_legal;
1260 samplepos_t _requested_return_sample;
1261 pframes_t current_block_size;
1262 samplecnt_t _worst_output_latency;
1263 samplecnt_t _worst_input_latency;
1264 samplecnt_t _worst_route_latency;
1265 uint32_t _send_latency_changes;
1266 bool _have_captured;
1267 bool _non_soloed_outs_muted;
1269 uint32_t _listen_cnt;
1270 uint32_t _solo_isolated_cnt;
1273 bool _under_nsm_control;
1274 unsigned int _xrun_count;
1276 std::string _missing_file_replacement;
1278 void add_monitor_section ();
1279 void remove_monitor_section ();
1281 void initialize_latencies ();
1282 void update_latency (bool playback);
1283 bool update_route_latency (bool reverse, bool apply_to_delayline);
1285 void set_worst_io_latencies ();
1286 void set_worst_output_latency ();
1287 void set_worst_input_latency ();
1289 void send_latency_compensation_change ();
1290 void set_worst_io_latencies_x (IOChange, void *);
1292 void ensure_buffers (ChanCount howmany = ChanCount::ZERO);
1294 void process_scrub (pframes_t);
1295 void process_without_events (pframes_t);
1296 void process_with_events (pframes_t);
1297 void process_audition (pframes_t);
1298 void process_export (pframes_t);
1299 void process_export_fw (pframes_t);
1301 void block_processing() { g_atomic_int_set (&processing_prohibited, 1); }
1302 void unblock_processing() { g_atomic_int_set (&processing_prohibited, 0); }
1303 bool processing_blocked() const { return g_atomic_int_get (&processing_prohibited); }
1305 static const samplecnt_t bounce_chunk_size;
1307 /* Transport master DLL */
1309 enum TransportMasterState {
1310 Stopped, /* no incoming or invalid signal/data for master to run with */
1311 Waiting, /* waiting to get full lock on incoming signal/data */
1312 Running /* lock achieved, master is generating meaningful speed & position */
1315 TransportMasterState transport_master_tracking_state;
1316 samplepos_t master_wait_end;
1317 void track_transport_master (float slave_speed, samplepos_t slave_transport_sample);
1318 bool follow_transport_master (pframes_t nframes);
1320 void sync_source_changed (SyncSource, samplepos_t pos, pframes_t cycle_nframes);
1321 void reset_slave_state ();
1323 bool post_export_sync;
1324 samplepos_t post_export_position;
1327 bool _export_rolling;
1328 bool _realtime_export;
1329 bool _region_export;
1330 samplepos_t _export_preroll;
1332 boost::shared_ptr<ExportHandler> export_handler;
1333 boost::shared_ptr<ExportStatus> export_status;
1336 int stop_audio_export ();
1337 void finalize_audio_export ();
1338 void finalize_export_internal (bool stop_freewheel);
1339 bool _pre_export_mmc_enabled;
1341 PBD::ScopedConnection export_freewheel_connection;
1343 void get_track_statistics ();
1344 int process_routes (pframes_t, bool& need_butler);
1345 int silent_process_routes (pframes_t, bool& need_butler);
1347 /** @return 1 if there is a pending declick fade-in,
1348 -1 if there is a pending declick fade-out,
1349 0 if there is no pending declick.
1351 bool maybe_stop (samplepos_t limit);
1352 bool maybe_sync_start (pframes_t &);
1358 /** Number of process samples since the last MTC output (when sending MTC); used to
1359 * know when to send full MTC messages every so often.
1361 pframes_t _pframes_since_last_mtc;
1364 samplepos_t last_loopend;
1366 boost::scoped_ptr<SessionDirectory> _session_dir;
1369 void graph_reordered ();
1371 /** current snapshot name, without the .ardour suffix */
1372 void set_snapshot_name (const std::string &);
1373 void save_snapshot_name (const std::string &);
1374 std::string _current_snapshot_name;
1376 XMLTree* state_tree;
1377 bool state_was_pending;
1378 StateOfTheState _state_of_the_state;
1380 friend class StateProtector;
1381 gint _suspend_save; /* atomic */
1382 volatile bool _save_queued;
1383 Glib::Threads::Mutex save_state_lock;
1384 Glib::Threads::Mutex save_source_lock;
1385 Glib::Threads::Mutex peak_cleanup_lock;
1387 int load_options (const XMLNode&);
1388 int load_state (std::string snapshot_name);
1389 static int parse_stateful_loading_version (const std::string&);
1391 samplepos_t _last_roll_location;
1392 /** the session sample time at which we last rolled, located, or changed transport direction */
1393 samplepos_t _last_roll_or_reversal_location;
1394 samplepos_t _last_record_location;
1397 bool pending_auto_loop;
1399 PBD::ReallocPool _mempool;
1401 Glib::Threads::Mutex lua_lock;
1402 luabridge::LuaRef * _lua_run;
1403 luabridge::LuaRef * _lua_add;
1404 luabridge::LuaRef * _lua_del;
1405 luabridge::LuaRef * _lua_list;
1406 luabridge::LuaRef * _lua_load;
1407 luabridge::LuaRef * _lua_save;
1408 luabridge::LuaRef * _lua_cleanup;
1409 uint32_t _n_lua_scripts;
1412 void try_run_lua (pframes_t);
1416 static const PostTransportWork ProcessCannotProceedMask =
1418 PostTransportReverse|
1419 PostTransportAudition|
1421 PostTransportClearSubstate);
1423 gint _post_transport_work; /* accessed only atomic ops */
1424 PostTransportWork post_transport_work() const { return (PostTransportWork) g_atomic_int_get (const_cast<gint*>(&_post_transport_work)); }
1425 void set_post_transport_work (PostTransportWork ptw) { g_atomic_int_set (&_post_transport_work, (gint) ptw); }
1426 void add_post_transport_work (PostTransportWork ptw);
1428 void schedule_playback_buffering_adjustment ();
1429 void schedule_capture_buffering_adjustment ();
1431 Locations* _locations;
1432 void location_added (Location*);
1433 void location_removed (Location*);
1434 void locations_changed ();
1435 void _locations_changed (const Locations::LocationList&);
1437 void update_skips (Location*, bool consolidate);
1438 void update_marks (Location* loc);
1439 void consolidate_skips (Location*);
1440 void sync_locations_to_skips ();
1441 void _sync_locations_to_skips ();
1443 PBD::ScopedConnectionList skip_update_connections;
1444 bool _ignore_skips_updates;
1446 PBD::ScopedConnectionList punch_connections;
1447 void auto_punch_start_changed (Location *);
1448 void auto_punch_end_changed (Location *);
1449 void auto_punch_changed (Location *);
1451 PBD::ScopedConnectionList loop_connections;
1452 void auto_loop_changed (Location *);
1453 void auto_loop_declick_range (Location *, samplepos_t &, samplepos_t &);
1455 int ensure_engine (uint32_t desired_sample_rate, bool);
1456 void pre_engine_init (std::string path);
1457 int post_engine_init ();
1458 int immediately_post_engine ();
1459 void remove_empty_sounds ();
1461 void session_loaded ();
1463 void setup_midi_control ();
1464 int midi_read (MIDI::Port *);
1466 void enable_record ();
1468 void increment_transport_position (samplecnt_t val) {
1469 if (max_samplepos - val < _transport_sample) {
1470 _transport_sample = max_samplepos;
1472 _transport_sample += val;
1476 void decrement_transport_position (samplecnt_t val) {
1477 if (val < _transport_sample) {
1478 _transport_sample -= val;
1480 _transport_sample = 0;
1484 void post_transport_motion ();
1485 static void *session_loader_thread (void *arg);
1489 /* Signal Forwarding */
1490 void emit_route_signals ();
1491 void emit_thread_run ();
1492 static void *emit_thread (void *);
1493 void emit_thread_start ();
1494 void emit_thread_terminate ();
1496 pthread_t _rt_emit_thread;
1497 bool _rt_thread_active;
1499 pthread_mutex_t _rt_emit_mutex;
1500 pthread_cond_t _rt_emit_cond;
1501 bool _rt_emit_pending;
1503 /* Auto Connect Thread */
1504 static void *auto_connect_thread (void *);
1505 void auto_connect_thread_run ();
1506 void auto_connect_thread_start ();
1507 void auto_connect_thread_terminate ();
1509 pthread_t _auto_connect_thread;
1510 gint _ac_thread_active;
1511 pthread_mutex_t _auto_connect_mutex;
1512 pthread_cond_t _auto_connect_cond;
1514 struct AutoConnectRequest {
1516 AutoConnectRequest (boost::shared_ptr <Route> r, bool ci,
1517 const ChanCount& is,
1518 const ChanCount& os,
1519 const ChanCount& io,
1520 const ChanCount& oo)
1521 : route (boost::weak_ptr<Route> (r))
1522 , connect_inputs (ci)
1526 , output_offset (oo)
1529 boost::weak_ptr <Route> route;
1530 bool connect_inputs;
1531 ChanCount input_start;
1532 ChanCount output_start;
1533 ChanCount input_offset;
1534 ChanCount output_offset;
1537 Glib::Threads::Mutex _update_latency_lock;
1539 typedef std::queue<AutoConnectRequest> AutoConnectQueue;
1540 Glib::Threads::Mutex _auto_connect_queue_lock;
1541 AutoConnectQueue _auto_connect_queue;
1542 guint _latency_recompute_pending;
1544 void get_physical_ports (std::vector<std::string>& inputs, std::vector<std::string>& outputs, DataType type,
1545 MidiPortFlags include = MidiPortFlags (0),
1546 MidiPortFlags exclude = MidiPortFlags (0));
1548 void auto_connect (const AutoConnectRequest&);
1549 void queue_latency_recompute ();
1551 /* SessionEventManager interface */
1553 void process_event (SessionEvent*);
1554 void set_next_event ();
1555 void cleanup_event (SessionEvent*,int);
1557 /* MIDI Machine Control */
1560 void spp_continue ();
1563 void mmc_deferred_play (MIDI::MachineControl &);
1564 void mmc_stop (MIDI::MachineControl &);
1565 void mmc_step (MIDI::MachineControl &, int);
1566 void mmc_pause (MIDI::MachineControl &);
1567 void mmc_record_pause (MIDI::MachineControl &);
1568 void mmc_record_strobe (MIDI::MachineControl &);
1569 void mmc_record_exit (MIDI::MachineControl &);
1570 void mmc_track_record_status (MIDI::MachineControl &, uint32_t track, bool enabled);
1571 void mmc_fast_forward (MIDI::MachineControl &);
1572 void mmc_rewind (MIDI::MachineControl &);
1573 void mmc_locate (MIDI::MachineControl &, const MIDI::byte *);
1574 void mmc_shuttle (MIDI::MachineControl &mmc, float speed, bool forw);
1575 void mmc_record_enable (MIDI::MachineControl &mmc, size_t track, bool enabled);
1577 struct timeval last_mmc_step;
1580 typedef boost::function<bool()> MidiTimeoutCallback;
1581 typedef std::list<MidiTimeoutCallback> MidiTimeoutList;
1583 MidiTimeoutList midi_timeouts;
1584 bool mmc_step_timeout ();
1585 void send_immediate_mmc (MIDI::MachineControlCommand);
1587 MIDI::byte mtc_msg[16];
1588 MIDI::byte mtc_timecode_bits; /* encoding of SMTPE type for MTC */
1589 MIDI::byte midi_msg[16];
1590 double outbound_mtc_timecode_frame;
1591 Timecode::Time transmitting_timecode_time;
1592 int next_quarter_frame_to_send;
1594 double _samples_per_timecode_frame; /* has to be floating point because of drop sample */
1595 samplecnt_t _frames_per_hour;
1596 samplecnt_t _timecode_frames_per_hour;
1598 /* cache the most-recently requested time conversions. This helps when we
1599 * have multiple clocks showing the same time (e.g. the transport sample) */
1600 bool last_timecode_valid;
1601 samplepos_t last_timecode_when;
1602 Timecode::Time last_timecode;
1604 bool _send_timecode_update; ///< Flag to send a full sample (Timecode) MTC message this cycle
1606 int send_midi_time_code_for_cycle (samplepos_t, samplepos_t, pframes_t nframes);
1608 LTCEncoder* ltc_encoder;
1609 ltcsnd_sample_t* ltc_enc_buf;
1611 Timecode::TimecodeFormat ltc_enc_tcformat;
1612 int32_t ltc_buf_off;
1613 int32_t ltc_buf_len;
1616 int32_t ltc_enc_byte;
1617 samplepos_t ltc_enc_pos;
1619 samplepos_t ltc_enc_off;
1621 samplepos_t ltc_prev_cycle;
1623 samplepos_t ltc_timecode_offset;
1624 bool ltc_timecode_negative_offset;
1626 LatencyRange ltc_out_latency;
1628 void ltc_tx_initialize();
1629 void ltc_tx_cleanup();
1630 void ltc_tx_reset();
1631 void ltc_tx_resync_latency();
1632 void ltc_tx_recalculate_position();
1633 void ltc_tx_parse_offset();
1634 void ltc_tx_send_time_code_for_cycle (samplepos_t, samplepos_t, double, double, pframes_t nframes);
1635 PBD::ScopedConnectionList ltc_tx_connections;
1638 void reset_record_status ();
1640 int no_roll (pframes_t nframes);
1641 int fail_roll (pframes_t nframes);
1643 bool non_realtime_work_pending() const { return static_cast<bool>(post_transport_work()); }
1644 bool process_can_proceed() const { return !(post_transport_work() & ProcessCannotProceedMask); }
1646 MidiControlUI* midi_control_ui;
1648 int start_midi_thread ();
1650 bool should_ignore_transport_request (TransportRequestSource, TransportRequestType) const;
1651 bool declick_in_progress () const;
1653 void set_play_loop (bool yn, double speed);
1654 void unset_play_loop ();
1655 void overwrite_some_buffers (Track *);
1656 void flush_all_inserts ();
1657 int micro_locate (samplecnt_t distance);
1658 void locate (samplepos_t, bool with_roll, bool with_flush, bool with_loop=false, bool force=false, bool with_mmc=true);
1659 void start_locate (samplepos_t, bool with_roll, bool with_flush, bool for_loop_enabled=false, bool force=false);
1660 void force_locate (samplepos_t sample, bool with_roll = false);
1661 void set_transport_speed (double speed, samplepos_t destination_sample, bool abort = false, bool clear_state = false, bool as_default = false);
1662 void stop_transport (bool abort = false, bool clear_state = false);
1663 void start_transport ();
1664 void realtime_stop (bool abort, bool clear_state);
1665 void realtime_locate ();
1666 void non_realtime_start_scrub ();
1667 void non_realtime_set_speed ();
1668 void non_realtime_locate ();
1669 void non_realtime_stop (bool abort, int entry_request_count, bool& finished);
1670 void non_realtime_overwrite (int entry_request_count, bool& finished);
1671 void post_transport ();
1672 void engine_halted ();
1673 void xrun_recovery ();
1674 void set_track_loop (bool);
1675 bool select_playhead_priority_target (samplepos_t&);
1676 void follow_playhead_priority ();
1678 /* These are synchronous and so can only be called from within the process
1682 int send_full_time_code (samplepos_t, pframes_t nframes);
1683 void send_song_position_pointer (samplepos_t);
1685 TempoMap *_tempo_map;
1686 void tempo_map_changed (const PBD::PropertyChange&);
1688 /* edit/mix groups */
1690 int load_route_groups (const XMLNode&, int);
1692 std::list<RouteGroup *> _route_groups;
1693 RouteGroup* _all_route_group;
1697 boost::shared_ptr<Graph> _process_graph;
1699 SerializedRCUManager<RouteList> routes;
1701 void add_routes (RouteList&, bool input_auto_connect, bool output_auto_connect, bool save, PresentationInfo::order_t);
1702 void add_routes_inner (RouteList&, bool input_auto_connect, bool output_auto_connect, PresentationInfo::order_t);
1703 bool _adding_routes_in_progress;
1704 bool _reconnecting_routes_in_progress;
1705 bool _route_deletion_in_progress;
1707 uint32_t destructive_index;
1709 boost::shared_ptr<Route> XMLRouteFactory (const XMLNode&, int);
1710 boost::shared_ptr<Route> XMLRouteFactory_2X (const XMLNode&, int);
1711 boost::shared_ptr<Route> XMLRouteFactory_3X (const XMLNode&, int);
1713 void route_processors_changed (RouteProcessorChange);
1715 bool find_route_name (std::string const &, uint32_t& id, std::string& name, bool);
1716 void count_existing_track_channels (ChanCount& in, ChanCount& out);
1717 void auto_connect_route (boost::shared_ptr<Route>, bool, const ChanCount&, const ChanCount&, const ChanCount& io = ChanCount(), const ChanCount& oo = ChanCount());
1718 void midi_output_change_handler (IOChange change, void* /*src*/, boost::weak_ptr<Route> midi_track);
1720 /* track numbering */
1722 void reassign_track_numbers ();
1723 uint32_t _track_number_decimals;
1725 /* solo/mute/notifications */
1727 void route_listen_changed (PBD::Controllable::GroupControlDisposition, boost::weak_ptr<Route>);
1728 void route_mute_changed ();
1729 void route_solo_changed (bool self_solo_change, PBD::Controllable::GroupControlDisposition group_override, boost::weak_ptr<Route>);
1730 void route_solo_isolated_changed (boost::weak_ptr<Route>);
1732 void update_route_solo_state (boost::shared_ptr<RouteList> r = boost::shared_ptr<RouteList>());
1734 void listen_position_changed ();
1735 void solo_control_mode_changed ();
1737 /* REGION MANAGEMENT */
1739 mutable Glib::Threads::Mutex region_lock;
1741 int load_regions (const XMLNode& node);
1742 int load_compounds (const XMLNode& node);
1744 void route_added_to_route_group (RouteGroup *, boost::weak_ptr<Route>);
1745 void route_removed_from_route_group (RouteGroup *, boost::weak_ptr<Route>);
1746 void route_group_property_changed (RouteGroup *);
1750 mutable Glib::Threads::Mutex source_lock;
1753 typedef std::map<PBD::ID,boost::shared_ptr<Source> > SourceMap;
1756 void reset_write_sources (bool mark_write_complete, bool force = false);
1759 int load_sources (const XMLNode& node);
1760 XMLNode& get_sources_as_xml ();
1762 boost::shared_ptr<Source> XMLSourceFactory (const XMLNode&);
1766 void remove_playlist (boost::weak_ptr<Playlist>);
1767 void track_playlist_changed (boost::weak_ptr<Track>);
1768 void playlist_region_added (boost::weak_ptr<Region>);
1769 void playlist_ranges_moved (std::list<Evoral::RangeMove<samplepos_t> > const &);
1770 void playlist_regions_extended (std::list<Evoral::Range<samplepos_t> > const &);
1772 /* CURVES and AUTOMATION LISTS */
1773 std::map<PBD::ID, AutomationList*> automation_lists;
1775 /* DEFAULT FADE CURVES */
1777 float default_fade_steepness;
1778 float default_fade_msecs;
1782 boost::shared_ptr<Auditioner> auditioner;
1783 void set_audition (boost::shared_ptr<Region>);
1784 void non_realtime_set_audition ();
1785 boost::shared_ptr<Region> pending_audition_region;
1791 int flatten_one_track (AudioTrack&, samplepos_t start, samplecnt_t cnt);
1793 /* INSERT AND SEND MANAGEMENT */
1795 boost::dynamic_bitset<uint32_t> send_bitset;
1796 boost::dynamic_bitset<uint32_t> aux_send_bitset;
1797 boost::dynamic_bitset<uint32_t> return_bitset;
1798 boost::dynamic_bitset<uint32_t> insert_bitset;
1802 struct space_and_path {
1803 uint32_t blocks; ///< 4kB blocks
1804 bool blocks_unknown; ///< true if blocks is unknown
1809 , blocks_unknown (true)
1813 struct space_and_path_ascending_cmp {
1814 bool operator() (space_and_path a, space_and_path b) {
1815 if (a.blocks_unknown != b.blocks_unknown) {
1816 return !a.blocks_unknown;
1818 return a.blocks > b.blocks;
1822 void setup_raid_path (std::string path);
1824 std::vector<space_and_path> session_dirs;
1825 std::vector<space_and_path>::iterator last_rr_session_dir;
1826 uint32_t _total_free_4k_blocks;
1827 /** If this is true, _total_free_4k_blocks is not definite,
1828 as one or more of the session directories' filesystems
1829 could not report free space.
1831 bool _total_free_4k_blocks_uncertain;
1832 Glib::Threads::Mutex space_lock;
1834 bool no_questions_about_missing_files;
1836 std::string get_best_session_directory_for_new_audio ();
1838 mutable gint _playback_load;
1839 mutable gint _capture_load;
1843 SerializedRCUManager<BundleList> _bundles;
1844 XMLNode* _bundle_xml_node;
1845 int load_bundles (XMLNode const &);
1847 UndoHistory _history;
1848 /** current undo transaction, or 0 */
1849 UndoTransaction* _current_trans;
1850 /** GQuarks to describe the reversible commands that are currently in progress.
1851 * These may be nested, in which case more recently-started commands are toward
1852 * the front of the list.
1854 std::list<GQuark> _current_trans_quarks;
1856 int backend_sync_callback (TransportState, samplepos_t);
1858 void process_rtop (SessionEvent*);
1866 XMLNode& state (bool save_template,
1867 snapshot_t snapshot_type = NormalSave,
1868 bool only_used_assets = false);
1870 XMLNode& get_state ();
1871 int set_state (const XMLNode& node, int version); // not idempotent
1872 XMLNode& get_template ();
1875 typedef std::list<Click*> Clicks;
1878 bool _click_rec_only;
1879 boost::shared_ptr<IO> _click_io;
1880 boost::shared_ptr<Amp> _click_gain;
1882 Sample* click_emphasis_data;
1883 samplecnt_t click_length;
1884 samplecnt_t click_emphasis_length;
1885 mutable Glib::Threads::RWLock click_lock;
1887 static const Sample default_click[];
1888 static const samplecnt_t default_click_length;
1889 static const Sample default_click_emphasis[];
1890 static const samplecnt_t default_click_emphasis_length;
1893 samplepos_t _clicks_cleared;
1894 void setup_click_sounds (int which);
1895 void setup_click_sounds (Sample**, Sample const *, samplecnt_t*, samplecnt_t, std::string const &);
1896 void clear_clicks ();
1897 void click (samplepos_t start, samplecnt_t nframes);
1898 void run_click (samplepos_t start, samplecnt_t nframes);
1899 void add_click (samplepos_t pos, bool emphasis);
1900 samplecnt_t _count_in_samples;
1902 /* range playback */
1904 std::list<AudioRange> current_audio_range;
1906 void set_play_range (std::list<AudioRange>&, bool leave_rolling);
1907 void unset_play_range ();
1909 /* temporary hacks to allow selection to be pushed from GUI into backend
1910 Whenever we move the selection object into libardour, these will go away.
1912 Evoral::Range<samplepos_t> _range_selection;
1913 Evoral::Range<samplepos_t> _object_selection;
1915 void unset_preroll_record_trim ();
1917 samplecnt_t _preroll_record_trim_len;
1918 bool _count_in_once;
1923 boost::shared_ptr<Route> _master_out;
1924 boost::shared_ptr<Route> _monitor_out;
1926 void auto_connect_master_bus ();
1928 int find_all_sources (std::string path, std::set<std::string>& result);
1929 int find_all_sources_across_snapshots (std::set<std::string>& result, bool exclude_this_snapshot);
1931 typedef std::set<boost::shared_ptr<PBD::Controllable> > Controllables;
1932 Glib::Threads::Mutex controllables_lock;
1933 Controllables controllables;
1935 boost::shared_ptr<PBD::Controllable> _solo_cut_control;
1937 void reset_native_file_format();
1938 bool first_file_data_format_reset;
1939 bool first_file_header_format_reset;
1941 void config_changed (std::string, bool);
1943 XMLNode& get_control_protocol_state ();
1945 void set_history_depth (uint32_t depth);
1947 static bool _disable_all_loaded_plugins;
1948 static bool _bypass_all_loaded_plugins;
1950 mutable bool have_looped; ///< Used in ::audible_sample(*)
1952 void update_route_record_state ();
1953 gint _have_rec_enabled_track;
1954 gint _have_rec_disabled_track;
1956 static int ask_about_playlist_deletion (boost::shared_ptr<Playlist>);
1958 /* realtime "apply to set of routes" operations */
1959 template<typename T> SessionEvent*
1960 get_rt_event (boost::shared_ptr<RouteList> rl, T targ, SessionEvent::RTeventCallback after, PBD::Controllable::GroupControlDisposition group_override,
1961 void (Session::*method) (boost::shared_ptr<RouteList>, T, PBD::Controllable::GroupControlDisposition)) {
1962 SessionEvent* ev = new SessionEvent (SessionEvent::RealTimeOperation, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
1963 ev->rt_slot = boost::bind (method, this, rl, targ, group_override);
1964 ev->rt_return = after;
1965 ev->event_loop = PBD::EventLoop::get_event_loop_for_thread ();
1970 /* specialized version realtime "apply to set of routes" operations */
1971 template<typename T1, typename T2> SessionEvent*
1972 get_rt_event (boost::shared_ptr<RouteList> rl, T1 t1arg, T2 t2arg, SessionEvent::RTeventCallback after, PBD::Controllable::GroupControlDisposition group_override,
1973 void (Session::*method) (boost::shared_ptr<RouteList>, T1, T2, PBD::Controllable::GroupControlDisposition)) {
1974 SessionEvent* ev = new SessionEvent (SessionEvent::RealTimeOperation, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
1975 ev->rt_slot = boost::bind (method, this, rl, t1arg, t2arg, group_override);
1976 ev->rt_return = after;
1977 ev->event_loop = PBD::EventLoop::get_event_loop_for_thread ();
1982 /* specialized version realtime "apply to set of controls" operations */
1983 SessionEvent* get_rt_event (boost::shared_ptr<ControlList> cl, double arg, PBD::Controllable::GroupControlDisposition group_override) {
1984 SessionEvent* ev = new SessionEvent (SessionEvent::RealTimeOperation, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
1985 ev->rt_slot = boost::bind (&Session::rt_set_controls, this, cl, arg, group_override);
1986 ev->rt_return = Session::rt_cleanup;
1987 ev->event_loop = PBD::EventLoop::get_event_loop_for_thread ();
1992 void rt_set_controls (boost::shared_ptr<ControlList>, double val, PBD::Controllable::GroupControlDisposition group_override);
1993 void rt_clear_all_solo_state (boost::shared_ptr<RouteList>, bool yn, PBD::Controllable::GroupControlDisposition group_override);
1995 void set_session_range_location (samplepos_t, samplepos_t);
1997 void setup_midi_machine_control ();
1999 void step_edit_status_change (bool);
2000 uint32_t _step_editors;
2002 /** true if timecode transmission by the transport is suspended, otherwise false */
2003 mutable gint _suspend_timecode_transmission;
2005 void update_locations_after_tempo_map_change (const Locations::LocationList &);
2007 void start_time_changed (samplepos_t);
2008 void end_time_changed (samplepos_t);
2010 void set_track_monitor_input_status (bool);
2011 samplepos_t compute_stop_limit () const;
2013 boost::shared_ptr<Speakers> _speakers;
2014 void load_nested_sources (const XMLNode& node);
2016 /** The directed graph of routes that is currently being used for audio processing
2017 and solo/mute computations.
2019 GraphEdges _current_route_graph;
2021 void ensure_route_presentation_info_gap (PresentationInfo::order_t, uint32_t gap_size);
2023 friend class ProcessorChangeBlocker;
2024 gint _ignore_route_processor_changes; /* atomic */
2026 MidiClockTicker* midi_clock;
2028 boost::shared_ptr<IO> _ltc_output;
2030 boost::shared_ptr<RTTaskList> _rt_tasklist;
2032 /* Scene Changing */
2033 SceneChanger* _scene_changer;
2035 /* persistent, non-track related MIDI ports */
2036 MidiPortManager* _midi_ports;
2037 MIDI::MachineControl* _mmc;
2040 void setup_click ();
2041 void setup_click_state (const XMLNode*);
2042 void setup_bundles ();
2044 void save_as_bring_callback (uint32_t, uint32_t, std::string);
2046 static const uint32_t session_end_shift;
2048 std::string _template_state_dir;
2050 VCAManager* _vca_manager;
2052 boost::shared_ptr<Route> get_midi_nth_route_by_id (PresentationInfo::order_t n) const;
2054 std::string created_with;
2056 void midi_track_presentation_info_changed (PBD::PropertyChange const &, boost::weak_ptr<MidiTrack>);
2057 void rewire_selected_midi (boost::shared_ptr<MidiTrack>);
2058 void rewire_midi_selection_ports ();
2059 boost::weak_ptr<MidiTrack> current_midi_target;
2061 StripableList _soloSelection; //the items that are soloe'd during a solo-selection operation; need to unsolo after the roll
2063 CoreSelection* _selection;
2065 bool _global_locate_pending;
2069 } // namespace ARDOUR
2071 #endif /* __ardour_session_h__ */