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__
23 #include "libardour-config.h"
34 #include <boost/dynamic_bitset.hpp>
35 #include <boost/scoped_ptr.hpp>
36 #include <boost/weak_ptr.hpp>
37 #include <boost/utility.hpp>
39 #include <glibmm/threads.h>
43 #include "pbd/error.h"
44 #include "pbd/event_loop.h"
46 #include "pbd/reallocpool.h"
47 #include "pbd/statefuldestructible.h"
48 #include "pbd/signals.h"
51 #include "lua/luastate.h"
53 #include "evoral/Range.hpp"
55 #include "midi++/types.h"
56 #include "midi++/mmc.h"
58 #include "timecode/time.h"
60 #include "ardour/ardour.h"
61 #include "ardour/chan_count.h"
62 #include "ardour/delivery.h"
63 #include "ardour/interthread_info.h"
64 #include "ardour/luascripting.h"
65 #include "ardour/location.h"
66 #include "ardour/monitor_processor.h"
67 #include "ardour/presentation_info.h"
68 #include "ardour/rc_configuration.h"
69 #include "ardour/session_configuration.h"
70 #include "ardour/session_event.h"
71 #include "ardour/interpolation.h"
72 #include "ardour/plugin.h"
73 #include "ardour/presentation_info.h"
74 #include "ardour/route.h"
75 #include "ardour/route_graph.h"
81 typedef struct _AEffect AEffect;
105 class AudioFileSource;
110 class AutomationList;
116 class ControllableDescriptor;
124 class MidiClockTicker;
126 class MidiPortManager;
146 class SessionDirectory;
147 class SessionMetadata;
148 class SessionPlaylists;
155 class WindowsVSTPlugin;
157 extern void setup_enum_writer ();
159 class LIBARDOUR_API SessionException: public std::exception {
161 explicit SessionException(const std::string msg) : _message(msg) {}
162 virtual ~SessionException() throw() {}
164 virtual const char* what() const throw() { return _message.c_str(); }
167 std::string _message;
170 /** Ardour Session */
171 class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::ScopedConnectionList, public SessionEventManager
175 PendingDeclickIn = 0x1, ///< pending de-click fade-in for start
176 PendingDeclickOut = 0x2, ///< pending de-click fade-out for stop
177 StopPendingCapture = 0x4,
178 PendingLoopDeclickIn = 0x8, ///< pending de-click fade-in at the start of a loop
179 PendingLoopDeclickOut = 0x10, ///< pending de-click fade-out at the end of a loop
180 PendingLocate = 0x20,
190 /* a new session might have non-empty mix_template, an existing session should always have an empty one.
191 the bus profile can be null if no master out bus is required.
194 Session (AudioEngine&,
195 const std::string& fullpath,
196 const std::string& snapshot_name,
197 BusProfile* bus_profile = 0,
198 std::string mix_template = "");
202 static int get_info_from_path (const std::string& xmlpath, float& sample_rate, SampleFormat& data_format, std::string& program_version);
203 static std::string get_snapshot_from_instant (const std::string& session_dir);
205 /** a monotonic counter used for naming user-visible things uniquely
206 * (curently the sidechain port).
207 * Use sparingly to keep the numbers low, prefer PBD::ID for all
208 * internal, not user-visible IDs */
209 static unsigned int next_name_id ();
211 std::string path() const { return _path; }
212 std::string name() const { return _name; }
213 std::string snap_name() const { return _current_snapshot_name; }
214 std::string raid_path () const;
215 bool path_is_within_session (const std::string&);
217 bool writable() const { return _writable; }
220 bool dirty() const { return _state_of_the_state & Dirty; }
221 void set_deletion_in_progress ();
222 void clear_deletion_in_progress ();
223 bool reconnection_in_progress() const { return _reconnecting_routes_in_progress; }
224 bool deletion_in_progress() const { return _state_of_the_state & Deletion; }
225 bool routes_deletion_in_progress() const { return _route_deletion_in_progress; }
226 bool peaks_cleanup_in_progres() const { return _state_of_the_state & PeakCleanup; }
227 bool loading () const { return _state_of_the_state & Loading; }
229 PBD::Signal0<void> DirtyChanged;
231 const SessionDirectory& session_directory () const { return *(_session_dir.get()); }
233 static PBD::Signal1<void,std::string> Dialog;
235 PBD::Signal0<void> BatchUpdateStart;
236 PBD::Signal0<void> BatchUpdateEnd;
238 int ensure_subdirs ();
240 std::string automation_dir () const; ///< Automation data
241 std::string analysis_dir () const; ///< Analysis data
242 std::string plugins_dir () const; ///< Plugin state
243 std::string externals_dir () const; ///< Links to external files
245 std::string construct_peak_filepath (const std::string& audio_path, const bool in_session = false, const bool old_peak_name = false) const;
247 bool audio_source_name_is_unique (const std::string& name);
248 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);
249 std::string new_audio_source_path_for_embedded (const std::string& existing_path);
250 std::string new_audio_source_path (const std::string&, uint32_t nchans, uint32_t chan, bool destructive, bool take_required);
251 std::string new_midi_source_path (const std::string&, bool need_source_lock = true);
252 /** create a new track or bus from a template (XML path)
253 * @param how_many how many tracks or busses to create
254 * @param template_path path to xml template file
255 * @param name name (prefix) of the route to create
256 * @param pd Playlist disposition
257 * @return list of newly created routes
259 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);
260 RouteList new_route_from_template (uint32_t how_many, PresentationInfo::order_t insert_at, XMLNode&, const std::string& name, PlaylistDisposition pd = NewPlaylist);
261 std::vector<std::string> get_paths_for_new_sources (bool allow_replacing, const std::string& import_file_path,
262 uint32_t channels, std::vector<std::string> const & smf_track_names);
264 int bring_all_sources_into_session (boost::function<void(uint32_t,uint32_t,std::string)> callback);
266 void process (pframes_t nframes);
268 BufferSet& get_silent_buffers (ChanCount count = ChanCount::ZERO);
269 BufferSet& get_noinplace_buffers (ChanCount count = ChanCount::ZERO);
270 BufferSet& get_scratch_buffers (ChanCount count = ChanCount::ZERO, bool silence = true);
271 BufferSet& get_route_buffers (ChanCount count = ChanCount::ZERO, bool silence = true);
272 BufferSet& get_mix_buffers (ChanCount count = ChanCount::ZERO);
274 bool have_rec_enabled_track () const;
275 bool have_rec_disabled_track () const;
277 bool have_captured() const { return _have_captured; }
279 void refill_all_track_buffers ();
280 Butler* butler() { return _butler; }
281 void butler_transport_work ();
283 void refresh_disk_space ();
285 int load_routes (const XMLNode&, int);
286 boost::shared_ptr<RouteList> get_routes() const {
287 return routes.reader ();
290 CoreSelection& selection () { return *_selection; }
292 /* because the set of Stripables consists of objects managed
293 * independently, in multiple containers within the Session (or objects
294 * owned by the session), we fill out a list in-place rather than
295 * return a pointer to a copy of the (RCU) managed list, as happens
299 void get_stripables (StripableList&) const;
300 StripableList get_stripables () const;
301 boost::shared_ptr<RouteList> get_tracks() const;
302 boost::shared_ptr<RouteList> get_routes_with_internal_returns() const;
303 boost::shared_ptr<RouteList> get_routes_with_regions_at (framepos_t const) const;
305 uint32_t nstripables (bool with_monitor = false) const;
306 uint32_t nroutes() const { return routes.reader()->size(); }
307 uint32_t ntracks () const;
308 uint32_t nbusses () const;
310 boost::shared_ptr<BundleList> bundles () {
311 return _bundles.reader ();
314 void notify_presentation_info_change ();
316 template<class T> void foreach_route (T *obj, void (T::*func)(Route&), bool sort = true);
317 template<class T> void foreach_route (T *obj, void (T::*func)(boost::shared_ptr<Route>), bool sort = true);
318 template<class T, class A> void foreach_route (T *obj, void (T::*func)(Route&, A), A arg, bool sort = true);
320 static char session_name_is_legal (const std::string&);
321 bool io_name_is_legal (const std::string&) const;
322 boost::shared_ptr<Route> route_by_name (std::string) const;
323 boost::shared_ptr<Route> route_by_id (PBD::ID) const;
324 boost::shared_ptr<Stripable> stripable_by_id (PBD::ID) const;
325 boost::shared_ptr<Stripable> get_remote_nth_stripable (PresentationInfo::order_t n, PresentationInfo::Flag) const;
326 boost::shared_ptr<Route> get_remote_nth_route (PresentationInfo::order_t n) const;
327 boost::shared_ptr<Route> route_by_selected_count (uint32_t cnt) const;
328 void routes_using_input_from (const std::string& str, RouteList& rl);
330 bool route_name_unique (std::string) const;
331 bool route_name_internal (std::string) const;
333 uint32_t track_number_decimals () const {
334 return _track_number_decimals;
337 bool get_record_enabled() const {
338 return (record_status () >= Enabled);
341 RecordState record_status() const {
342 return (RecordState) g_atomic_int_get (&_record_status);
345 bool actively_recording () const {
346 return record_status() == Recording;
349 bool record_enabling_legal () const;
350 void maybe_enable_record (bool rt_context = false);
351 void disable_record (bool rt_context, bool force = false);
352 void step_back_from_record ();
354 void set_all_tracks_record_enabled(bool);
356 void maybe_write_autosave ();
358 /* Emitted when all i/o connections are complete */
360 PBD::Signal0<void> IOConnectionsComplete;
362 /* Timecode status signals */
363 PBD::Signal1<void, bool> MTCSyncStateChanged;
364 PBD::Signal1<void, bool> LTCSyncStateChanged;
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,framepos_t> PositionChanged; /* sent after any non-sequential motion */
389 PBD::Signal1<void,framepos_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 (framepos_t start, framepos_t return_to);
418 void request_bounded_roll (framepos_t start, framepos_t end);
419 void request_stop (bool abort = false, bool clear_state = false);
420 void request_locate (framepos_t frame, bool with_roll = false);
422 void request_play_loop (bool yn, bool leave_rolling = false);
423 bool get_play_loop () const { return play_loop; }
425 framepos_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);
431 void request_transport_speed_nonzero (double, bool as_default = true);
432 void request_overwrite_buffer (boost::shared_ptr<Route>);
433 void adjust_playback_buffering();
434 void adjust_capture_buffering();
435 void request_input_change_handling ();
437 bool locate_pending() const { return static_cast<bool>(post_transport_work()&PostTransportLocate); }
438 bool declick_out_pending() const { return static_cast<bool>(transport_sub_state&(PendingDeclickOut)); }
439 bool transport_locked () const;
443 framepos_t current_end_frame () const;
444 framepos_t current_start_frame () const;
445 /** "actual" sample rate of session, set by current audioengine rate, pullup/down etc. */
446 framecnt_t frame_rate () const { return _current_frame_rate; }
447 /** "native" sample rate of session, regardless of current audioengine rate, pullup/down etc */
448 framecnt_t nominal_frame_rate () const { return _nominal_frame_rate; }
449 framecnt_t frames_per_hour () const { return _frames_per_hour; }
451 double samples_per_timecode_frame() const { return _samples_per_timecode_frame; }
452 framecnt_t timecode_frames_per_hour() const { return _timecode_frames_per_hour; }
454 MIDI::byte get_mtc_timecode_bits() const {
455 return mtc_timecode_bits; /* encoding of SMTPE type for MTC */
458 double timecode_frames_per_second() const;
459 bool timecode_drop_frames() const;
463 Locations *locations() { return _locations; }
465 PBD::Signal1<void,Location*> auto_loop_location_changed;
466 PBD::Signal1<void,Location*> auto_punch_location_changed;
467 PBD::Signal0<void> locations_modified;
469 void set_auto_punch_location (Location *);
470 void set_auto_loop_location (Location *);
471 void set_session_extents (framepos_t start, framepos_t end);
472 bool end_is_free () const { return _session_range_end_is_free; }
473 void set_end_is_free (bool);
474 int location_name(std::string& result, std::string base = std::string(""));
476 pframes_t get_block_size() const { return current_block_size; }
477 framecnt_t worst_output_latency () const { return _worst_output_latency; }
478 framecnt_t worst_input_latency () const { return _worst_input_latency; }
479 framecnt_t worst_track_latency () const { return _worst_track_latency; }
480 framecnt_t worst_playback_latency () const { return _worst_output_latency + _worst_track_latency; }
483 std::string new_parent_folder; /* parent folder where new session folder will be created */
484 std::string new_name; /* name of newly saved session */
485 bool switch_to; /* true if we should be working on newly saved session after save-as; false otherwise */
486 bool include_media; /* true if the newly saved session should contain references to media */
487 bool copy_media; /* true if media files (audio, media, etc) should be copied into newly saved session; false otherwise */
488 bool copy_external; /* true if external media should be consolidated into the newly saved session; false otherwise */
490 std::string final_session_folder_name; /* filled in by * Session::save_as(), provides full path to newly saved session */
492 /* emitted as we make progress. 3 arguments passed to signal
495 * 1: percentage complete measured as a fraction (0-1.0) of
496 * total data copying done.
497 * 2: number of files copied so far
498 * 3: total number of files to copy
500 * Handler should return true for save-as to continue, or false
501 * to stop (and remove all evidence of partial save-as).
503 PBD::Signal3<bool,float,int64_t,int64_t> Progress;
505 /* if save_as() returns non-zero, this string will indicate the reason why.
507 std::string failure_message;
510 int save_as (SaveAs&);
512 * @param snapshot_name name of the session (use an empty string for the current name)
513 * @param pending save a 'recovery', not full state (default: false)
514 * @param switch_to_snapshot switch to given snapshot after saving (default: false)
515 * @param template_only save a session template (default: false)
516 * @return zero on success
518 int save_state (std::string snapshot_name, bool pending = false, bool switch_to_snapshot = false, bool template_only = false);
526 int archive_session (const std::string&, const std::string&, ArchiveEncode compress_audio = FLAC_16BIT, bool only_used_sources = false, Progress* p = 0);
528 int restore_state (std::string snapshot_name);
529 int save_template (const std::string& template_name, const std::string& description = "", bool replace_existing = false);
530 int save_history (std::string snapshot_name = "");
531 int restore_history (std::string snapshot_name);
532 void remove_state (std::string snapshot_name);
533 void rename_state (std::string old_name, std::string new_name);
534 void remove_pending_capture_state ();
535 int rename (const std::string&);
536 bool get_nsm_state () const { return _under_nsm_control; }
537 void set_nsm_state (bool state) { _under_nsm_control = state; }
538 bool save_default_options ();
540 PBD::Signal1<void,std::string> StateSaved;
541 PBD::Signal0<void> StateReady;
543 /* emitted when session needs to be saved due to some internal
544 * event or condition (i.e. not in response to a user request).
546 * Only one object should
547 * connect to this signal and take responsibility.
549 * Argument is the snapshot name to use when saving.
551 PBD::Signal1<void,std::string> SaveSessionRequested;
553 /* emitted during a session save to allow other entities to add state, via
554 * extra XML, to the session state
556 PBD::Signal0<void> SessionSaveUnderway;
558 std::vector<std::string> possible_states() const;
559 static std::vector<std::string> possible_states (std::string path);
561 XMLNode& get_state();
562 int set_state(const XMLNode& node, int version); // not idempotent
563 XMLNode& get_template();
564 bool export_track_state (boost::shared_ptr<RouteList> rl, const std::string& path);
566 /// The instant xml file is written to the session directory
567 void add_instant_xml (XMLNode&, bool write_to_config = true);
568 XMLNode* instant_xml (const std::string& str);
570 enum StateOfTheState {
575 InitialConnecting = 0x8,
581 StateOfTheState state_of_the_state() const { return _state_of_the_state; }
583 class StateProtector {
585 StateProtector (Session* s) : _session (s) {
586 g_atomic_int_inc (&s->_suspend_save);
589 if (g_atomic_int_dec_and_test (&_session->_suspend_save)) {
590 while (_session->_save_queued) {
591 _session->_save_queued = false;
592 _session->save_state ("");
600 class ProcessorChangeBlocker {
602 ProcessorChangeBlocker (Session* s, bool rc = true)
604 , _reconfigure_on_delete (rc)
606 g_atomic_int_inc (&s->_ignore_route_processor_changes);
608 ~ProcessorChangeBlocker () {
609 if (g_atomic_int_dec_and_test (&_session->_ignore_route_processor_changes)) {
610 if (_reconfigure_on_delete) {
611 _session->route_processors_changed (RouteProcessorChange ());
617 bool _reconfigure_on_delete;
620 RouteGroup* new_route_group (const std::string&);
621 void add_route_group (RouteGroup *);
622 void remove_route_group (RouteGroup* rg) { if (rg) remove_route_group (*rg); }
623 void remove_route_group (RouteGroup&);
624 void reorder_route_groups (std::list<RouteGroup*>);
626 RouteGroup* route_group_by_name (std::string);
627 RouteGroup& all_route_group() const;
629 PBD::Signal1<void,RouteGroup*> route_group_added;
630 PBD::Signal0<void> route_group_removed;
631 PBD::Signal0<void> route_groups_reordered;
633 void foreach_route_group (boost::function<void(RouteGroup*)> f) {
634 for (std::list<RouteGroup *>::iterator i = _route_groups.begin(); i != _route_groups.end(); ++i) {
639 std::list<RouteGroup*> const & route_groups () const {
640 return _route_groups;
643 /* fundamental operations. duh. */
645 std::list<boost::shared_ptr<AudioTrack> > new_audio_track (
648 RouteGroup* route_group,
650 std::string name_template,
651 PresentationInfo::order_t order,
652 TrackMode mode = Normal
655 std::list<boost::shared_ptr<MidiTrack> > new_midi_track (
656 const ChanCount& input, const ChanCount& output, bool strict_io,
657 boost::shared_ptr<PluginInfo> instrument,
658 Plugin::PresetRecord* pset,
659 RouteGroup* route_group, uint32_t how_many, std::string name_template,
660 PresentationInfo::order_t,
661 TrackMode mode = Normal
664 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);
665 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);
667 void remove_routes (boost::shared_ptr<RouteList>);
668 void remove_route (boost::shared_ptr<Route>);
670 void resort_routes ();
671 void resort_routes_using (boost::shared_ptr<RouteList>);
673 AudioEngine & engine() { return _engine; }
674 AudioEngine const & engine () const { return _engine; }
676 static std::string default_track_name_pattern (DataType);
680 framepos_t transport_frame () const {return _transport_frame; }
681 framepos_t record_location () const {return _last_record_location; }
682 framepos_t audible_frame (bool* latent_locate = NULL) const;
683 framepos_t requested_return_frame() const { return _requested_return_frame; }
684 void set_requested_return_frame(framepos_t return_to);
698 void sync_time_vars();
700 void bbt_time (framepos_t when, Timecode::BBT_Time&);
701 void timecode_to_sample(Timecode::Time& timecode, framepos_t& sample, bool use_offset, bool use_subframes) const;
702 void sample_to_timecode(framepos_t sample, Timecode::Time& timecode, bool use_offset, bool use_subframes) const;
703 void timecode_time (Timecode::Time &);
704 void timecode_time (framepos_t when, Timecode::Time&);
705 void timecode_time_subframes (framepos_t when, Timecode::Time&);
707 void timecode_duration (framecnt_t, Timecode::Time&) const;
708 void timecode_duration_string (char *, size_t len, framecnt_t) const;
710 framecnt_t convert_to_frames (AnyTime const & position);
711 framecnt_t any_duration_to_frames (framepos_t position, AnyTime const & duration);
713 static PBD::Signal1<void, framepos_t> StartTimeChanged;
714 static PBD::Signal1<void, framepos_t> EndTimeChanged;
716 void request_sync_source (Slave*);
717 bool synced_to_engine() const { return _slave && config.get_external_sync() && Config->get_sync_source() == Engine; }
718 bool synced_to_mtc () const { return config.get_external_sync() && Config->get_sync_source() == MTC && g_atomic_int_get (const_cast<gint*>(&_mtc_active)); }
719 bool synced_to_ltc () const { return config.get_external_sync() && Config->get_sync_source() == LTC && g_atomic_int_get (const_cast<gint*>(&_ltc_active)); }
721 double transport_speed() const { return _count_in_samples > 0 ? 0. : _transport_speed; }
722 bool transport_stopped() const { return _transport_speed == 0.0; }
723 bool transport_rolling() const { return _transport_speed != 0.0 && _count_in_samples == 0; }
725 bool silent () { return _silent; }
727 TempoMap& tempo_map() { return *_tempo_map; }
728 const TempoMap& tempo_map() const { return *_tempo_map; }
730 unsigned int get_xrun_count () const {return _xrun_count; }
731 void reset_xrun_count () {_xrun_count = 0; }
735 boost::shared_ptr<Region> find_whole_file_parent (boost::shared_ptr<Region const>) const;
737 boost::shared_ptr<Region> XMLRegionFactory (const XMLNode&, bool full);
738 boost::shared_ptr<AudioRegion> XMLAudioRegionFactory (const XMLNode&, bool full);
739 boost::shared_ptr<MidiRegion> XMLMidiRegionFactory (const XMLNode&, bool full);
741 /* source management */
743 void import_files (ImportStatus&);
744 bool sample_rate_convert (ImportStatus&, std::string infile, std::string& outfile);
745 std::string build_tmp_convert_name (std::string file);
747 boost::shared_ptr<ExportHandler> get_export_handler ();
748 boost::shared_ptr<ExportStatus> get_export_status ();
750 int start_audio_export (framepos_t position, bool realtime = false, bool region_export = false, bool comensate_master_latency = false);
752 PBD::Signal1<int, framecnt_t> ProcessExport;
753 static PBD::Signal2<void,std::string, std::string> Exported;
755 void add_source (boost::shared_ptr<Source>);
756 void remove_source (boost::weak_ptr<Source>);
758 void cleanup_regions();
759 bool can_cleanup_peakfiles () const;
760 int cleanup_peakfiles ();
761 int cleanup_sources (CleanupReport&);
762 int cleanup_trash_sources (CleanupReport&);
764 int destroy_sources (std::list<boost::shared_ptr<Source> >);
766 int remove_last_capture ();
768 /** handlers should return 0 for "everything OK", and any other value for
769 * "cannot setup audioengine".
771 static PBD::Signal1<int,uint32_t> AudioEngineSetupRequired;
773 /** handlers should return -1 for "stop cleanup",
774 0 for "yes, delete this playlist",
775 1 for "no, don't delete this playlist".
777 static PBD::Signal1<int,boost::shared_ptr<Playlist> > AskAboutPlaylistDeletion;
779 /** handlers should return 0 for "ignore the rate mismatch",
780 !0 for "do not use this session"
782 static PBD::Signal2<int, framecnt_t, framecnt_t> AskAboutSampleRateMismatch;
784 /** non interactive message */
785 static PBD::Signal2<void, framecnt_t, framecnt_t> NotifyAboutSampleRateMismatch;
787 /** handlers should return !0 for use pending state, 0 for ignore it.
789 static PBD::Signal0<int> AskAboutPendingState;
791 boost::shared_ptr<AudioFileSource> create_audio_source_for_session (
792 size_t, std::string const &, uint32_t, bool destructive);
794 boost::shared_ptr<MidiSource> create_midi_source_for_session (std::string const &);
795 boost::shared_ptr<MidiSource> create_midi_source_by_stealing_name (boost::shared_ptr<Track>);
797 boost::shared_ptr<Source> source_by_id (const PBD::ID&);
798 boost::shared_ptr<AudioFileSource> audio_source_by_path_and_channel (const std::string&, uint16_t) const;
799 boost::shared_ptr<MidiSource> midi_source_by_path (const std::string&, bool need_source_lock) const;
800 uint32_t count_sources_by_origin (const std::string&);
802 void add_playlist (boost::shared_ptr<Playlist>, bool unused = false);
804 /* Curves and AutomationLists (TODO when they go away) */
805 void add_automation_list(AutomationList*);
809 boost::shared_ptr<Auditioner> the_auditioner() { return auditioner; }
810 void audition_playlist ();
811 void audition_region (boost::shared_ptr<Region>);
812 void cancel_audition ();
813 bool is_auditioning () const;
815 PBD::Signal1<void,bool> AuditionActive;
818 void register_lua_function (const std::string&, const std::string&, const LuaScriptParamList&);
819 void unregister_lua_function (const std::string& name);
820 std::vector<std::string> registered_lua_functions ();
821 uint32_t registered_lua_function_count () const { return _n_lua_scripts; }
822 void scripts_changed (); // called from lua, updates _n_lua_scripts
824 PBD::Signal0<void> LuaScriptsChanged;
826 /* flattening stuff */
828 boost::shared_ptr<Region> write_one_track (Track&, framepos_t start, framepos_t end,
829 bool overwrite, std::vector<boost::shared_ptr<Source> >&, InterThreadInfo& wot,
830 boost::shared_ptr<Processor> endpoint,
831 bool include_endpoint, bool for_export, bool for_freeze);
832 int freeze_all (InterThreadInfo&);
834 /* session-wide solo/mute/rec-enable */
837 std::vector<boost::weak_ptr<AutomationControl> > cancel_all_mute ();
839 bool soloing() const { return _non_soloed_outs_muted; }
840 bool listening() const { return _listen_cnt > 0; }
841 bool solo_isolated() const { return _solo_isolated_cnt > 0; }
842 void cancel_all_solo ();
844 static const SessionEvent::RTeventCallback rt_cleanup;
846 void clear_all_solo_state (boost::shared_ptr<RouteList>);
848 /* Control-based methods */
850 void set_controls (boost::shared_ptr<ControlList>, double val, PBD::Controllable::GroupControlDisposition);
851 void set_control (boost::shared_ptr<AutomationControl>, double val, PBD::Controllable::GroupControlDisposition);
853 void set_exclusive_input_active (boost::shared_ptr<RouteList> rt, bool onoff, bool flip_others = false);
855 PBD::Signal1<void,bool> SoloActive;
856 PBD::Signal0<void> SoloChanged;
857 PBD::Signal0<void> MuteChanged;
858 PBD::Signal0<void> IsolatedChanged;
859 PBD::Signal0<void> MonitorChanged;
861 PBD::Signal0<void> session_routes_reconnected;
863 /* monitor/master out */
864 int add_master_bus (ChanCount const&);
866 void add_monitor_section ();
867 void reset_monitor_section ();
868 void remove_monitor_section ();
869 bool monitor_active() const { return (_monitor_out && _monitor_out->monitor_control () && _monitor_out->monitor_control ()->monitor_active()); }
871 boost::shared_ptr<Route> monitor_out() const { return _monitor_out; }
872 boost::shared_ptr<Route> master_out() const { return _master_out; }
874 PresentationInfo::order_t master_order_key () const { return _master_out ? _master_out->presentation_info ().order () : -1; }
875 bool ensure_stripable_sort_order ();
877 void globally_add_internal_sends (boost::shared_ptr<Route> dest, Placement p, bool);
878 void globally_set_send_gains_from_track (boost::shared_ptr<Route> dest);
879 void globally_set_send_gains_to_zero (boost::shared_ptr<Route> dest);
880 void globally_set_send_gains_to_unity (boost::shared_ptr<Route> dest);
881 void add_internal_sends (boost::shared_ptr<Route> dest, Placement p, boost::shared_ptr<RouteList> senders);
882 void add_internal_send (boost::shared_ptr<Route>, int, boost::shared_ptr<Route>);
883 void add_internal_send (boost::shared_ptr<Route>, boost::shared_ptr<Processor>, boost::shared_ptr<Route>);
885 static void set_disable_all_loaded_plugins (bool yn) {
886 _disable_all_loaded_plugins = yn;
888 static bool get_disable_all_loaded_plugins() {
889 return _disable_all_loaded_plugins;
891 static void set_bypass_all_loaded_plugins (bool yn) {
892 _bypass_all_loaded_plugins = yn;
894 static bool get_bypass_all_loaded_plugins() {
895 return _bypass_all_loaded_plugins;
898 uint32_t next_send_id();
899 uint32_t next_aux_send_id();
900 uint32_t next_return_id();
901 uint32_t next_insert_id();
902 void mark_send_id (uint32_t);
903 void mark_aux_send_id (uint32_t);
904 void mark_return_id (uint32_t);
905 void mark_insert_id (uint32_t);
906 void unmark_send_id (uint32_t);
907 void unmark_aux_send_id (uint32_t);
908 void unmark_return_id (uint32_t);
909 void unmark_insert_id (uint32_t);
911 /* s/w "RAID" management */
913 boost::optional<framecnt_t> available_capture_duration();
917 void add_bundle (boost::shared_ptr<Bundle>, bool emit_signal = true);
918 void remove_bundle (boost::shared_ptr<Bundle>);
919 boost::shared_ptr<Bundle> bundle_by_name (std::string) const;
921 PBD::Signal0<void> BundleAddedOrRemoved;
925 /* History (for editors, mixers, UIs etc.) */
927 /** Undo some transactions.
928 * @param n Number of transactions to undo.
930 void undo (uint32_t n);
931 /** Redo some transactions.
932 * @param n Number of transactions to undo.
934 void redo (uint32_t n);
936 UndoHistory& history() { return _history; }
938 uint32_t undo_depth() const { return _history.undo_depth(); }
939 uint32_t redo_depth() const { return _history.redo_depth(); }
940 std::string next_undo() const { return _history.next_undo(); }
941 std::string next_redo() const { return _history.next_redo(); }
943 /** begin collecting undo information
945 * This call must always be followed by either
946 * begin_reversible_command() or commit_reversible_command()
948 * @param cmd_name human readable name for the undo operation
950 void begin_reversible_command (const std::string& cmd_name);
951 void begin_reversible_command (GQuark);
952 /** abort an open undo command
953 * This must only be called after begin_reversible_command ()
955 void abort_reversible_command ();
956 /** finalize an undo command and commit pending transactions
958 * This must only be called after begin_reversible_command ()
959 * @param cmd (additional) command to add
961 void commit_reversible_command (Command* cmd = 0);
963 void add_command (Command *const cmd);
965 /** create an StatefulDiffCommand from the given object and add it to the stack.
967 * This function must only be called after begin_reversible_command.
968 * Failing to do so may lead to a crash.
970 * @param sfd the object to diff
971 * @returns the allocated StatefulDiffCommand (already added via add_command)
973 PBD::StatefulDiffCommand* add_stateful_diff_command (boost::shared_ptr<PBD::StatefulDestructible> sfd);
975 /** @return The list of operations that are currently in progress */
976 std::list<GQuark> const & current_operations () {
977 return _current_trans_quarks;
980 bool operation_in_progress (GQuark) const;
982 void add_commands (std::vector<Command*> const & cmds);
984 std::map<PBD::ID,PBD::StatefulDestructible*> registry;
986 // these commands are implemented in libs/ardour/session_command.cc
987 Command* memento_command_factory(XMLNode* n);
988 Command* stateful_diff_command_factory (XMLNode *);
989 void register_with_memento_command_factory(PBD::ID, PBD::StatefulDestructible*);
993 boost::shared_ptr<IO> click_io() { return _click_io; }
994 boost::shared_ptr<Amp> click_gain() { return _click_gain; }
996 /* disk, buffer loads */
998 uint32_t playback_load ();
999 uint32_t capture_load ();
1003 void request_play_range (std::list<AudioRange>*, bool leave_rolling = false);
1004 void request_cancel_play_range ();
1005 bool get_play_range () const { return _play_range; }
1007 void maybe_update_session_range (framepos_t, framepos_t);
1010 framecnt_t preroll_samples (framepos_t) const;
1012 void request_preroll_record_punch (framepos_t start, framecnt_t preroll);
1013 void request_preroll_record_trim (framepos_t start, framecnt_t preroll);
1014 void request_count_in_record ();
1016 framepos_t preroll_record_punch_pos () const { return _preroll_record_punch_pos; }
1017 bool preroll_record_punch_enabled () const { return _preroll_record_punch_pos >= 0; }
1019 framecnt_t preroll_record_trim_len () const { return _preroll_record_trim_len; }
1021 /* temporary hacks to allow selection to be pushed from GUI into backend.
1022 Whenever we move the selection object into libardour, these will go away.
1024 void set_range_selection (framepos_t start, framepos_t end);
1025 void set_object_selection (framepos_t start, framepos_t end);
1026 void clear_range_selection ();
1027 void clear_object_selection ();
1029 /* buffers for gain and pan */
1031 gain_t* gain_automation_buffer () const;
1032 gain_t* trim_automation_buffer () const;
1033 gain_t* send_gain_automation_buffer () const;
1034 gain_t* scratch_automation_buffer () const;
1035 pan_t** pan_automation_buffer () const;
1037 void ensure_buffer_set (BufferSet& buffers, const ChanCount& howmany);
1041 static int vst_current_loading_id;
1042 static const char* vst_can_do_strings[];
1043 static const int vst_can_do_string_count;
1045 static intptr_t vst_callback (
1054 static PBD::Signal0<void> SendFeedback;
1058 boost::shared_ptr<Speakers> get_speakers ();
1062 boost::shared_ptr<Processor> processor_by_id (PBD::ID) const;
1064 boost::shared_ptr<PBD::Controllable> controllable_by_id (const PBD::ID&);
1065 boost::shared_ptr<AutomationControl> automation_control_by_id (const PBD::ID&);
1066 boost::shared_ptr<PBD::Controllable> controllable_by_descriptor (const ARDOUR::ControllableDescriptor&);
1068 void add_controllable (boost::shared_ptr<PBD::Controllable>);
1069 void remove_controllable (PBD::Controllable*);
1071 boost::shared_ptr<PBD::Controllable> solo_cut_control() const;
1073 SessionConfiguration config;
1075 SessionConfiguration* cfg () { return &config; }
1077 bool exporting () const {
1081 bool bounce_processing() const {
1082 return _bounce_processing_active;
1085 /* this is a private enum, but setup_enum_writer() needs it,
1086 and i can't find a way to give that function
1087 friend access. sigh.
1090 enum PostTransportWork {
1091 PostTransportStop = 0x1,
1092 PostTransportDuration = 0x2,
1093 PostTransportLocate = 0x4,
1094 PostTransportRoll = 0x8,
1095 PostTransportAbort = 0x10,
1096 PostTransportOverWrite = 0x20,
1097 PostTransportSpeed = 0x40,
1098 PostTransportAudition = 0x80,
1099 PostTransportReverse = 0x100,
1100 PostTransportInputChange = 0x200,
1101 PostTransportCurveRealloc = 0x400,
1102 PostTransportClearSubstate = 0x800,
1103 PostTransportAdjustPlaybackBuffering = 0x1000,
1104 PostTransportAdjustCaptureBuffering = 0x2000
1113 SlaveState slave_state() const { return _slave_state; }
1114 Slave* slave() const { return _slave; }
1116 boost::shared_ptr<SessionPlaylists> playlists;
1118 void send_mmc_locate (framepos_t);
1119 void queue_full_time_code () { _send_timecode_update = true; }
1120 void queue_song_position_pointer () { /* currently does nothing */ }
1122 bool step_editing() const { return (_step_editors > 0); }
1124 void request_suspend_timecode_transmission ();
1125 void request_resume_timecode_transmission ();
1126 bool timecode_transmission_suspended () const;
1128 std::vector<std::string> source_search_path(DataType) const;
1129 void ensure_search_path_includes (const std::string& path, DataType type);
1130 void remove_dir_from_search_path (const std::string& path, DataType type);
1132 std::list<std::string> unknown_processors () const;
1134 /** Emitted when a feedback cycle has been detected within Ardour's signal
1135 processing path. Until it is fixed (by the user) some (unspecified)
1136 routes will not be run.
1138 static PBD::Signal0<void> FeedbackDetected;
1140 /** Emitted when a graph sort has successfully completed, which means
1141 that it has no feedback cycles.
1143 static PBD::Signal0<void> SuccessfulGraphSort;
1145 /* handlers can return an integer value:
1146 0: config.set_audio_search_path() or config.set_midi_search_path() was used
1147 to modify the search path and we should try to find it again.
1148 1: quit entire session load
1149 2: as 0, but don't ask about other missing files
1150 3: don't ask about other missing files, and just mark this one missing
1151 -1: just mark this one missing
1152 any other value: as -1
1154 static PBD::Signal3<int,Session*,std::string,DataType> MissingFile;
1156 void set_missing_file_replacement (const std::string& mfr) {
1157 _missing_file_replacement = mfr;
1160 /** Emitted when the session wants Ardour to quit */
1161 static PBD::Signal0<void> Quit;
1163 /** Emitted when Ardour is asked to load a session in an older session
1164 * format, and makes a backup copy.
1166 static PBD::Signal2<void,std::string,std::string> VersionMismatch;
1168 SceneChanger* scene_changer() const { return _scene_changer; }
1170 /* asynchronous MIDI control ports */
1172 boost::shared_ptr<Port> midi_input_port () const;
1173 boost::shared_ptr<Port> midi_output_port () const;
1174 boost::shared_ptr<Port> mmc_output_port () const;
1175 boost::shared_ptr<Port> mmc_input_port () const;
1176 boost::shared_ptr<Port> scene_input_port () const;
1177 boost::shared_ptr<Port> scene_output_port () const;
1179 /* synchronous MIDI ports used for synchronization */
1181 boost::shared_ptr<MidiPort> midi_clock_output_port () const;
1182 boost::shared_ptr<MidiPort> midi_clock_input_port () const;
1183 boost::shared_ptr<MidiPort> mtc_output_port () const;
1184 boost::shared_ptr<MidiPort> mtc_input_port () const;
1185 boost::shared_ptr<Port> ltc_input_port() const;
1186 boost::shared_ptr<Port> ltc_output_port() const;
1188 boost::shared_ptr<IO> ltc_input_io() { return _ltc_input; }
1189 boost::shared_ptr<IO> ltc_output_io() { return _ltc_output; }
1191 MIDI::MachineControl& mmc() { return *_mmc; }
1193 void reconnect_midi_scene_ports (bool);
1194 void reconnect_mtc_ports ();
1195 void reconnect_mmc_ports (bool);
1197 void reconnect_ltc_input ();
1198 void reconnect_ltc_output ();
1200 VCAManager& vca_manager() { return *_vca_manager; }
1201 VCAManager* vca_manager_ptr() { return _vca_manager; }
1203 void auto_connect_thread_wakeup ();
1207 friend class AudioEngine;
1208 void set_block_size (pframes_t nframes);
1209 void set_frame_rate (framecnt_t nframes);
1210 #ifdef USE_TRACKS_CODE_FEATURES
1211 void reconnect_existing_routes (bool withLock, bool reconnect_master = true, bool reconnect_inputs = true, bool reconnect_outputs = true);
1216 void schedule_curve_reallocation ();
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 framecnt_t _base_frame_rate; // sample-rate of the session at creation time, "native" SR
1240 framecnt_t _nominal_frame_rate; // overridden by audioengine setting
1241 framecnt_t _current_frame_rate; // this includes video pullup offset
1242 int transport_sub_state;
1243 mutable gint _record_status;
1244 framepos_t _transport_frame;
1245 Location* _session_range_location; ///< session range, or 0 if there is nothing in the session yet
1246 bool _session_range_end_is_free;
1250 // varispeed playback
1251 double _transport_speed;
1252 double _default_transport_speed;
1253 double _last_transport_speed;
1254 double _signalled_varispeed;
1255 double _target_transport_speed;
1256 CubicInterpolation interpolation;
1258 bool auto_play_legal;
1259 framepos_t _last_slave_transport_frame;
1260 framecnt_t maximum_output_latency;
1261 framepos_t _requested_return_frame;
1262 pframes_t current_block_size;
1263 framecnt_t _worst_output_latency;
1264 framecnt_t _worst_input_latency;
1265 framecnt_t _worst_track_latency;
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 mtc_status_changed (bool);
1279 PBD::ScopedConnection mtc_status_connection;
1280 void ltc_status_changed (bool);
1281 PBD::ScopedConnection ltc_status_connection;
1283 void initialize_latencies ();
1284 void set_worst_io_latencies ();
1285 void set_worst_playback_latency ();
1286 void set_worst_capture_latency ();
1287 void set_worst_io_latencies_x (IOChange, void *) {
1288 set_worst_io_latencies ();
1290 void post_capture_latency ();
1291 void post_playback_latency ();
1293 void update_latency_compensation_proxy (void* ignored);
1295 void ensure_buffers (ChanCount howmany = ChanCount::ZERO);
1297 void process_scrub (pframes_t);
1298 void process_without_events (pframes_t);
1299 void process_with_events (pframes_t);
1300 void process_audition (pframes_t);
1301 void process_export (pframes_t);
1302 void process_export_fw (pframes_t);
1304 void block_processing() { g_atomic_int_set (&processing_prohibited, 1); }
1305 void unblock_processing() { g_atomic_int_set (&processing_prohibited, 0); }
1306 bool processing_blocked() const { return g_atomic_int_get (&processing_prohibited); }
1308 static const framecnt_t bounce_chunk_size;
1310 /* slave tracking */
1312 static const int delta_accumulator_size = 25;
1313 int delta_accumulator_cnt;
1314 int32_t delta_accumulator[delta_accumulator_size];
1315 int32_t average_slave_delta;
1317 bool have_first_delta_accumulator;
1319 SlaveState _slave_state;
1322 framepos_t slave_wait_end;
1324 void reset_slave_state ();
1325 bool follow_slave (pframes_t);
1326 void calculate_moving_average_of_slave_delta (int dir, framecnt_t this_delta);
1327 void track_slave_state (float slave_speed, framepos_t slave_transport_frame, framecnt_t this_delta);
1328 void follow_slave_silently (pframes_t nframes, float slave_speed);
1330 void switch_to_sync_source (SyncSource); /* !RT context */
1331 void drop_sync_source (); /* !RT context */
1332 void use_sync_source (Slave*); /* RT context */
1334 bool post_export_sync;
1335 framepos_t post_export_position;
1338 bool _export_rolling;
1339 bool _realtime_export;
1340 bool _region_export;
1341 framepos_t _export_preroll;
1342 framepos_t _export_latency;
1344 boost::shared_ptr<ExportHandler> export_handler;
1345 boost::shared_ptr<ExportStatus> export_status;
1348 int stop_audio_export ();
1349 void finalize_audio_export ();
1350 void finalize_export_internal (bool stop_freewheel);
1351 bool _pre_export_mmc_enabled;
1353 PBD::ScopedConnection export_freewheel_connection;
1355 void get_track_statistics ();
1356 int process_routes (pframes_t, bool& need_butler);
1357 int silent_process_routes (pframes_t, bool& need_butler);
1359 /** @return 1 if there is a pending declick fade-in,
1360 -1 if there is a pending declick fade-out,
1361 0 if there is no pending declick.
1363 int get_transport_declick_required () {
1364 if (transport_sub_state & PendingDeclickIn) {
1365 transport_sub_state &= ~PendingDeclickIn;
1367 } else if (transport_sub_state & PendingDeclickOut) {
1368 /* XXX: not entirely sure why we don't clear this */
1370 } else if (transport_sub_state & PendingLoopDeclickOut) {
1371 /* Return the declick out first ... */
1372 transport_sub_state &= ~PendingLoopDeclickOut;
1374 } else if (transport_sub_state & PendingLoopDeclickIn) {
1375 /* ... then the declick in on the next call */
1376 transport_sub_state &= ~PendingLoopDeclickIn;
1383 bool maybe_stop (framepos_t limit);
1384 bool maybe_sync_start (pframes_t &);
1386 void check_declick_out ();
1392 /** Number of process frames since the last MTC output (when sending MTC); used to
1393 * know when to send full MTC messages every so often.
1395 pframes_t _pframes_since_last_mtc;
1398 framepos_t last_loopend;
1400 boost::scoped_ptr<SessionDirectory> _session_dir;
1403 void graph_reordered ();
1405 /** current snapshot name, without the .ardour suffix */
1406 void set_snapshot_name (const std::string &);
1407 void save_snapshot_name (const std::string &);
1408 std::string _current_snapshot_name;
1410 XMLTree* state_tree;
1411 bool state_was_pending;
1412 StateOfTheState _state_of_the_state;
1414 friend class StateProtector;
1415 gint _suspend_save; /* atomic */
1416 volatile bool _save_queued;
1417 Glib::Threads::Mutex save_state_lock;
1418 Glib::Threads::Mutex peak_cleanup_lock;
1420 int load_options (const XMLNode&);
1421 int load_state (std::string snapshot_name);
1422 static int parse_stateful_loading_version (const std::string&);
1424 framepos_t _last_roll_location;
1425 /** the session frame time at which we last rolled, located, or changed transport direction */
1426 framepos_t _last_roll_or_reversal_location;
1427 framepos_t _last_record_location;
1429 bool pending_locate_roll;
1430 framepos_t pending_locate_frame;
1431 bool pending_locate_flush;
1433 bool pending_auto_loop;
1435 PBD::ReallocPool _mempool;
1437 Glib::Threads::Mutex lua_lock;
1438 luabridge::LuaRef * _lua_run;
1439 luabridge::LuaRef * _lua_add;
1440 luabridge::LuaRef * _lua_del;
1441 luabridge::LuaRef * _lua_list;
1442 luabridge::LuaRef * _lua_load;
1443 luabridge::LuaRef * _lua_save;
1444 luabridge::LuaRef * _lua_cleanup;
1445 uint32_t _n_lua_scripts;
1448 void try_run_lua (pframes_t);
1452 static const PostTransportWork ProcessCannotProceedMask =
1454 PostTransportInputChange|
1455 PostTransportReverse|
1456 PostTransportCurveRealloc|
1457 PostTransportAudition|
1458 PostTransportLocate|
1460 PostTransportClearSubstate);
1462 gint _post_transport_work; /* accessed only atomic ops */
1463 PostTransportWork post_transport_work() const { return (PostTransportWork) g_atomic_int_get (const_cast<gint*>(&_post_transport_work)); }
1464 void set_post_transport_work (PostTransportWork ptw) { g_atomic_int_set (&_post_transport_work, (gint) ptw); }
1465 void add_post_transport_work (PostTransportWork ptw);
1467 void schedule_playback_buffering_adjustment ();
1468 void schedule_capture_buffering_adjustment ();
1470 uint32_t cumulative_rf_motion;
1473 void set_rf_speed (float speed);
1474 void reset_rf_scale (framecnt_t frames_moved);
1476 Locations* _locations;
1477 void location_added (Location*);
1478 void location_removed (Location*);
1479 void locations_changed ();
1480 void _locations_changed (const Locations::LocationList&);
1482 void update_skips (Location*, bool consolidate);
1483 void update_marks (Location* loc);
1484 void consolidate_skips (Location*);
1485 void sync_locations_to_skips ();
1486 void _sync_locations_to_skips ();
1488 PBD::ScopedConnectionList skip_update_connections;
1489 bool _ignore_skips_updates;
1491 PBD::ScopedConnectionList punch_connections;
1492 void auto_punch_start_changed (Location *);
1493 void auto_punch_end_changed (Location *);
1494 void auto_punch_changed (Location *);
1496 PBD::ScopedConnectionList loop_connections;
1497 void auto_loop_changed (Location *);
1498 void auto_loop_declick_range (Location *, framepos_t &, framepos_t &);
1500 int ensure_engine (uint32_t desired_sample_rate, bool);
1501 void pre_engine_init (std::string path);
1502 int post_engine_init ();
1503 int immediately_post_engine ();
1504 void remove_empty_sounds ();
1506 void session_loaded ();
1508 void setup_midi_control ();
1509 int midi_read (MIDI::Port *);
1511 void enable_record ();
1513 void increment_transport_position (framecnt_t val) {
1514 if (max_framepos - val < _transport_frame) {
1515 _transport_frame = max_framepos;
1517 _transport_frame += val;
1521 void decrement_transport_position (framecnt_t val) {
1522 if (val < _transport_frame) {
1523 _transport_frame -= val;
1525 _transport_frame = 0;
1529 void post_transport_motion ();
1530 static void *session_loader_thread (void *arg);
1534 /* Signal Forwarding */
1535 void emit_route_signals ();
1536 void emit_thread_run ();
1537 static void *emit_thread (void *);
1538 void emit_thread_start ();
1539 void emit_thread_terminate ();
1541 pthread_t _rt_emit_thread;
1542 bool _rt_thread_active;
1544 pthread_mutex_t _rt_emit_mutex;
1545 pthread_cond_t _rt_emit_cond;
1546 bool _rt_emit_pending;
1548 /* Auto Connect Thread */
1549 static void *auto_connect_thread (void *);
1550 void auto_connect_thread_run ();
1551 void auto_connect_thread_start ();
1552 void auto_connect_thread_terminate ();
1554 pthread_t _auto_connect_thread;
1555 gint _ac_thread_active;
1556 pthread_mutex_t _auto_connect_mutex;
1557 pthread_cond_t _auto_connect_cond;
1559 struct AutoConnectRequest {
1561 AutoConnectRequest (boost::shared_ptr <Route> r, bool ci,
1562 const ChanCount& is,
1563 const ChanCount& os,
1564 const ChanCount& io,
1565 const ChanCount& oo)
1566 : route (boost::weak_ptr<Route> (r))
1567 , connect_inputs (ci)
1571 , output_offset (oo)
1574 boost::weak_ptr <Route> route;
1575 bool connect_inputs;
1576 ChanCount input_start;
1577 ChanCount output_start;
1578 ChanCount input_offset;
1579 ChanCount output_offset;
1582 typedef std::queue<AutoConnectRequest> AutoConnectQueue;
1583 Glib::Threads::Mutex _auto_connect_queue_lock;
1584 AutoConnectQueue _auto_connect_queue;
1585 guint _latency_recompute_pending;
1587 void get_physical_ports (std::vector<std::string>& inputs, std::vector<std::string>& outputs, DataType type,
1588 MidiPortFlags include = MidiPortFlags (0),
1589 MidiPortFlags exclude = MidiPortFlags (0));
1591 void auto_connect (const AutoConnectRequest&);
1592 void queue_latency_recompute ();
1594 /* SessionEventManager interface */
1596 void process_event (SessionEvent*);
1597 void set_next_event ();
1598 void cleanup_event (SessionEvent*,int);
1600 /* MIDI Machine Control */
1603 void spp_continue ();
1606 void mmc_deferred_play (MIDI::MachineControl &);
1607 void mmc_stop (MIDI::MachineControl &);
1608 void mmc_step (MIDI::MachineControl &, int);
1609 void mmc_pause (MIDI::MachineControl &);
1610 void mmc_record_pause (MIDI::MachineControl &);
1611 void mmc_record_strobe (MIDI::MachineControl &);
1612 void mmc_record_exit (MIDI::MachineControl &);
1613 void mmc_track_record_status (MIDI::MachineControl &, uint32_t track, bool enabled);
1614 void mmc_fast_forward (MIDI::MachineControl &);
1615 void mmc_rewind (MIDI::MachineControl &);
1616 void mmc_locate (MIDI::MachineControl &, const MIDI::byte *);
1617 void mmc_shuttle (MIDI::MachineControl &mmc, float speed, bool forw);
1618 void mmc_record_enable (MIDI::MachineControl &mmc, size_t track, bool enabled);
1620 struct timeval last_mmc_step;
1623 typedef boost::function<bool()> MidiTimeoutCallback;
1624 typedef std::list<MidiTimeoutCallback> MidiTimeoutList;
1626 MidiTimeoutList midi_timeouts;
1627 bool mmc_step_timeout ();
1628 void send_immediate_mmc (MIDI::MachineControlCommand);
1630 MIDI::byte mtc_msg[16];
1631 MIDI::byte mtc_timecode_bits; /* encoding of SMTPE type for MTC */
1632 MIDI::byte midi_msg[16];
1633 double outbound_mtc_timecode_frame;
1634 Timecode::Time transmitting_timecode_time;
1635 int next_quarter_frame_to_send;
1637 double _samples_per_timecode_frame; /* has to be floating point because of drop frame */
1638 framecnt_t _frames_per_hour;
1639 framecnt_t _timecode_frames_per_hour;
1641 /* cache the most-recently requested time conversions. This helps when we
1642 * have multiple clocks showing the same time (e.g. the transport frame) */
1643 bool last_timecode_valid;
1644 framepos_t last_timecode_when;
1645 Timecode::Time last_timecode;
1647 bool _send_timecode_update; ///< Flag to send a full frame (Timecode) MTC message this cycle
1649 int send_midi_time_code_for_cycle (framepos_t, framepos_t, pframes_t nframes);
1651 LTCEncoder* ltc_encoder;
1652 ltcsnd_sample_t* ltc_enc_buf;
1654 Timecode::TimecodeFormat ltc_enc_tcformat;
1655 int32_t ltc_buf_off;
1656 int32_t ltc_buf_len;
1659 int32_t ltc_enc_byte;
1660 framepos_t ltc_enc_pos;
1662 framepos_t ltc_enc_off;
1664 framepos_t ltc_prev_cycle;
1666 framepos_t ltc_timecode_offset;
1667 bool ltc_timecode_negative_offset;
1669 LatencyRange ltc_out_latency;
1671 void ltc_tx_initialize();
1672 void ltc_tx_cleanup();
1673 void ltc_tx_reset();
1674 void ltc_tx_resync_latency();
1675 void ltc_tx_recalculate_position();
1676 void ltc_tx_parse_offset();
1677 void ltc_tx_send_time_code_for_cycle (framepos_t, framepos_t, double, double, pframes_t nframes);
1678 PBD::ScopedConnectionList ltc_tx_connections;
1681 void reset_record_status ();
1683 int no_roll (pframes_t nframes);
1684 int fail_roll (pframes_t nframes);
1686 bool non_realtime_work_pending() const { return static_cast<bool>(post_transport_work()); }
1687 bool process_can_proceed() const { return !(post_transport_work() & ProcessCannotProceedMask); }
1689 MidiControlUI* midi_control_ui;
1691 int start_midi_thread ();
1693 void set_play_loop (bool yn, double speed);
1694 void unset_play_loop ();
1695 void overwrite_some_buffers (Track *);
1696 void flush_all_inserts ();
1697 int micro_locate (framecnt_t distance);
1698 void locate (framepos_t, bool with_roll, bool with_flush, bool with_loop=false, bool force=false, bool with_mmc=true);
1699 void start_locate (framepos_t, bool with_roll, bool with_flush, bool for_loop_enabled=false, bool force=false);
1700 void force_locate (framepos_t frame, bool with_roll = false);
1701 void set_transport_speed (double speed, framepos_t destination_frame, bool abort = false, bool clear_state = false, bool as_default = false);
1702 void stop_transport (bool abort = false, bool clear_state = false);
1703 void start_transport ();
1704 void realtime_stop (bool abort, bool clear_state);
1705 void realtime_locate ();
1706 void non_realtime_start_scrub ();
1707 void non_realtime_set_speed ();
1708 void non_realtime_locate ();
1709 void non_realtime_stop (bool abort, int entry_request_count, bool& finished);
1710 void non_realtime_overwrite (int entry_request_count, bool& finished);
1711 void post_transport ();
1712 void engine_halted ();
1713 void xrun_recovery ();
1714 void set_track_loop (bool);
1715 bool select_playhead_priority_target (framepos_t&);
1716 void follow_playhead_priority ();
1718 /* These are synchronous and so can only be called from within the process
1722 int send_full_time_code (framepos_t, pframes_t nframes);
1723 void send_song_position_pointer (framepos_t);
1725 TempoMap *_tempo_map;
1726 void tempo_map_changed (const PBD::PropertyChange&);
1728 /* edit/mix groups */
1730 int load_route_groups (const XMLNode&, int);
1732 std::list<RouteGroup *> _route_groups;
1733 RouteGroup* _all_route_group;
1737 boost::shared_ptr<Graph> _process_graph;
1739 SerializedRCUManager<RouteList> routes;
1741 void add_routes (RouteList&, bool input_auto_connect, bool output_auto_connect, bool save, PresentationInfo::order_t);
1742 void add_routes_inner (RouteList&, bool input_auto_connect, bool output_auto_connect, PresentationInfo::order_t);
1743 bool _adding_routes_in_progress;
1744 bool _reconnecting_routes_in_progress;
1745 bool _route_deletion_in_progress;
1747 uint32_t destructive_index;
1749 boost::shared_ptr<Route> XMLRouteFactory (const XMLNode&, int);
1750 boost::shared_ptr<Route> XMLRouteFactory_2X (const XMLNode&, int);
1752 void route_processors_changed (RouteProcessorChange);
1754 bool find_route_name (std::string const &, uint32_t& id, std::string& name, bool);
1755 void count_existing_track_channels (ChanCount& in, ChanCount& out);
1756 void auto_connect_route (boost::shared_ptr<Route>, bool, const ChanCount&, const ChanCount&, const ChanCount& io = ChanCount(), const ChanCount& oo = ChanCount());
1757 void midi_output_change_handler (IOChange change, void* /*src*/, boost::weak_ptr<Route> midi_track);
1759 /* track numbering */
1761 void reassign_track_numbers ();
1762 uint32_t _track_number_decimals;
1764 /* solo/mute/notifications */
1766 void route_listen_changed (PBD::Controllable::GroupControlDisposition, boost::weak_ptr<Route>);
1767 void route_mute_changed ();
1768 void route_solo_changed (bool self_solo_change, PBD::Controllable::GroupControlDisposition group_override, boost::weak_ptr<Route>);
1769 void route_solo_isolated_changed (boost::weak_ptr<Route>);
1771 void update_route_solo_state (boost::shared_ptr<RouteList> r = boost::shared_ptr<RouteList>());
1773 void listen_position_changed ();
1774 void solo_control_mode_changed ();
1776 /* REGION MANAGEMENT */
1778 mutable Glib::Threads::Mutex region_lock;
1780 int load_regions (const XMLNode& node);
1781 int load_compounds (const XMLNode& node);
1783 void route_added_to_route_group (RouteGroup *, boost::weak_ptr<Route>);
1784 void route_removed_from_route_group (RouteGroup *, boost::weak_ptr<Route>);
1785 void route_group_property_changed (RouteGroup *);
1789 mutable Glib::Threads::Mutex source_lock;
1792 typedef std::map<PBD::ID,boost::shared_ptr<Source> > SourceMap;
1795 void reset_write_sources (bool mark_write_complete, bool force = false);
1800 int load_sources (const XMLNode& node);
1801 XMLNode& get_sources_as_xml ();
1803 boost::shared_ptr<Source> XMLSourceFactory (const XMLNode&);
1807 void remove_playlist (boost::weak_ptr<Playlist>);
1808 void track_playlist_changed (boost::weak_ptr<Track>);
1809 void playlist_region_added (boost::weak_ptr<Region>);
1810 void playlist_ranges_moved (std::list<Evoral::RangeMove<framepos_t> > const &);
1811 void playlist_regions_extended (std::list<Evoral::Range<framepos_t> > const &);
1813 /* CURVES and AUTOMATION LISTS */
1814 std::map<PBD::ID, AutomationList*> automation_lists;
1816 /* DEFAULT FADE CURVES */
1818 float default_fade_steepness;
1819 float default_fade_msecs;
1823 boost::shared_ptr<Auditioner> auditioner;
1824 void set_audition (boost::shared_ptr<Region>);
1825 void non_realtime_set_audition ();
1826 boost::shared_ptr<Region> pending_audition_region;
1832 int flatten_one_track (AudioTrack&, framepos_t start, framecnt_t cnt);
1834 /* INSERT AND SEND MANAGEMENT */
1836 boost::dynamic_bitset<uint32_t> send_bitset;
1837 boost::dynamic_bitset<uint32_t> aux_send_bitset;
1838 boost::dynamic_bitset<uint32_t> return_bitset;
1839 boost::dynamic_bitset<uint32_t> insert_bitset;
1843 struct space_and_path {
1844 uint32_t blocks; ///< 4kB blocks
1845 bool blocks_unknown; ///< true if blocks is unknown
1850 , blocks_unknown (true)
1854 struct space_and_path_ascending_cmp {
1855 bool operator() (space_and_path a, space_and_path b) {
1856 if (a.blocks_unknown != b.blocks_unknown) {
1857 return !a.blocks_unknown;
1859 return a.blocks > b.blocks;
1863 void setup_raid_path (std::string path);
1865 std::vector<space_and_path> session_dirs;
1866 std::vector<space_and_path>::iterator last_rr_session_dir;
1867 uint32_t _total_free_4k_blocks;
1868 /** If this is true, _total_free_4k_blocks is not definite,
1869 as one or more of the session directories' filesystems
1870 could not report free space.
1872 bool _total_free_4k_blocks_uncertain;
1873 Glib::Threads::Mutex space_lock;
1875 bool no_questions_about_missing_files;
1877 std::string get_best_session_directory_for_new_audio ();
1879 mutable gint _playback_load;
1880 mutable gint _capture_load;
1884 SerializedRCUManager<BundleList> _bundles;
1885 XMLNode* _bundle_xml_node;
1886 int load_bundles (XMLNode const &);
1888 UndoHistory _history;
1889 /** current undo transaction, or 0 */
1890 UndoTransaction* _current_trans;
1891 /** GQuarks to describe the reversible commands that are currently in progress.
1892 * These may be nested, in which case more recently-started commands are toward
1893 * the front of the list.
1895 std::list<GQuark> _current_trans_quarks;
1897 int backend_sync_callback (TransportState, framepos_t);
1899 void process_rtop (SessionEvent*);
1901 void update_latency (bool playback);
1909 XMLNode& state(bool, snapshot_t snapshot_type = NormalSave);
1912 typedef std::list<Click*> Clicks;
1915 bool _click_rec_only;
1916 boost::shared_ptr<IO> _click_io;
1917 boost::shared_ptr<Amp> _click_gain;
1919 Sample* click_emphasis_data;
1920 framecnt_t click_length;
1921 framecnt_t click_emphasis_length;
1922 mutable Glib::Threads::RWLock click_lock;
1924 static const Sample default_click[];
1925 static const framecnt_t default_click_length;
1926 static const Sample default_click_emphasis[];
1927 static const framecnt_t default_click_emphasis_length;
1930 framepos_t _clicks_cleared;
1931 void setup_click_sounds (int which);
1932 void setup_click_sounds (Sample**, Sample const *, framecnt_t*, framecnt_t, std::string const &);
1933 void clear_clicks ();
1934 void click (framepos_t start, framecnt_t nframes);
1935 void run_click (framepos_t start, framecnt_t nframes);
1936 void add_click (framepos_t pos, bool emphasis);
1937 framecnt_t _count_in_samples;
1939 /* range playback */
1941 std::list<AudioRange> current_audio_range;
1943 void set_play_range (std::list<AudioRange>&, bool leave_rolling);
1944 void unset_play_range ();
1946 /* temporary hacks to allow selection to be pushed from GUI into backend
1947 Whenever we move the selection object into libardour, these will go away.
1949 Evoral::Range<framepos_t> _range_selection;
1950 Evoral::Range<framepos_t> _object_selection;
1952 void unset_preroll_record_punch ();
1953 void unset_preroll_record_trim ();
1955 framepos_t _preroll_record_punch_pos;
1956 framecnt_t _preroll_record_trim_len;
1957 bool _count_in_once;
1962 boost::shared_ptr<Route> _master_out;
1963 boost::shared_ptr<Route> _monitor_out;
1965 void auto_connect_master_bus ();
1967 int find_all_sources (std::string path, std::set<std::string>& result);
1968 int find_all_sources_across_snapshots (std::set<std::string>& result, bool exclude_this_snapshot);
1970 typedef std::set<boost::shared_ptr<PBD::Controllable> > Controllables;
1971 Glib::Threads::Mutex controllables_lock;
1972 Controllables controllables;
1974 boost::shared_ptr<PBD::Controllable> _solo_cut_control;
1976 void reset_native_file_format();
1977 bool first_file_data_format_reset;
1978 bool first_file_header_format_reset;
1980 void config_changed (std::string, bool);
1982 XMLNode& get_control_protocol_state ();
1984 void set_history_depth (uint32_t depth);
1986 static bool _disable_all_loaded_plugins;
1987 static bool _bypass_all_loaded_plugins;
1989 mutable bool have_looped; ///< Used in ::audible_frame(*)
1991 void update_route_record_state ();
1992 gint _have_rec_enabled_track;
1993 gint _have_rec_disabled_track;
1995 static int ask_about_playlist_deletion (boost::shared_ptr<Playlist>);
1997 /* realtime "apply to set of routes" operations */
1998 template<typename T> SessionEvent*
1999 get_rt_event (boost::shared_ptr<RouteList> rl, T targ, SessionEvent::RTeventCallback after, PBD::Controllable::GroupControlDisposition group_override,
2000 void (Session::*method) (boost::shared_ptr<RouteList>, T, PBD::Controllable::GroupControlDisposition)) {
2001 SessionEvent* ev = new SessionEvent (SessionEvent::RealTimeOperation, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
2002 ev->rt_slot = boost::bind (method, this, rl, targ, group_override);
2003 ev->rt_return = after;
2004 ev->event_loop = PBD::EventLoop::get_event_loop_for_thread ();
2009 /* specialized version realtime "apply to set of routes" operations */
2010 template<typename T1, typename T2> SessionEvent*
2011 get_rt_event (boost::shared_ptr<RouteList> rl, T1 t1arg, T2 t2arg, SessionEvent::RTeventCallback after, PBD::Controllable::GroupControlDisposition group_override,
2012 void (Session::*method) (boost::shared_ptr<RouteList>, T1, T2, PBD::Controllable::GroupControlDisposition)) {
2013 SessionEvent* ev = new SessionEvent (SessionEvent::RealTimeOperation, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
2014 ev->rt_slot = boost::bind (method, this, rl, t1arg, t2arg, group_override);
2015 ev->rt_return = after;
2016 ev->event_loop = PBD::EventLoop::get_event_loop_for_thread ();
2021 /* specialized version realtime "apply to set of controls" operations */
2022 SessionEvent* get_rt_event (boost::shared_ptr<ControlList> cl, double arg, PBD::Controllable::GroupControlDisposition group_override) {
2023 SessionEvent* ev = new SessionEvent (SessionEvent::RealTimeOperation, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
2024 ev->rt_slot = boost::bind (&Session::rt_set_controls, this, cl, arg, group_override);
2025 ev->rt_return = Session::rt_cleanup;
2026 ev->event_loop = PBD::EventLoop::get_event_loop_for_thread ();
2031 void rt_set_controls (boost::shared_ptr<ControlList>, double val, PBD::Controllable::GroupControlDisposition group_override);
2032 void rt_clear_all_solo_state (boost::shared_ptr<RouteList>, bool yn, PBD::Controllable::GroupControlDisposition group_override);
2034 void set_session_range_location (framepos_t, framepos_t);
2036 void setup_midi_machine_control ();
2038 void step_edit_status_change (bool);
2039 uint32_t _step_editors;
2041 /** true if timecode transmission by the transport is suspended, otherwise false */
2042 mutable gint _suspend_timecode_transmission;
2044 void update_locations_after_tempo_map_change (const Locations::LocationList &);
2046 void start_time_changed (framepos_t);
2047 void end_time_changed (framepos_t);
2049 void set_track_monitor_input_status (bool);
2050 framepos_t compute_stop_limit () const;
2052 boost::shared_ptr<Speakers> _speakers;
2053 void load_nested_sources (const XMLNode& node);
2055 /** The directed graph of routes that is currently being used for audio processing
2056 and solo/mute computations.
2058 GraphEdges _current_route_graph;
2060 void ensure_route_presentation_info_gap (PresentationInfo::order_t, uint32_t gap_size);
2062 friend class ProcessorChangeBlocker;
2063 gint _ignore_route_processor_changes; /* atomic */
2065 MidiClockTicker* midi_clock;
2067 boost::shared_ptr<IO> _ltc_input;
2068 boost::shared_ptr<IO> _ltc_output;
2070 /* Scene Changing */
2071 SceneChanger* _scene_changer;
2073 /* persistent, non-track related MIDI ports */
2074 MidiPortManager* _midi_ports;
2075 MIDI::MachineControl* _mmc;
2078 void setup_click ();
2079 void setup_click_state (const XMLNode*);
2080 void setup_bundles ();
2082 void save_as_bring_callback (uint32_t, uint32_t, std::string);
2084 static const uint32_t session_end_shift;
2086 std::string _template_state_dir;
2088 VCAManager* _vca_manager;
2090 boost::shared_ptr<Route> get_midi_nth_route_by_id (PresentationInfo::order_t n) const;
2092 std::string created_with;
2094 void midi_track_presentation_info_changed (PBD::PropertyChange const &, boost::weak_ptr<MidiTrack>);
2095 void rewire_selected_midi (boost::shared_ptr<MidiTrack>);
2096 void rewire_midi_selection_ports ();
2097 boost::weak_ptr<MidiTrack> current_midi_target;
2099 CoreSelection* _selection;
2103 } // namespace ARDOUR
2105 #endif /* __ardour_session_h__ */