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;
125 class MidiClockTicker;
127 class MidiPortManager;
147 class SessionDirectory;
148 class SessionMetadata;
149 class SessionPlaylists;
156 class WindowsVSTPlugin;
158 extern void setup_enum_writer ();
160 class LIBARDOUR_API SessionException: public std::exception {
162 explicit SessionException(const std::string msg) : _message(msg) {}
163 virtual ~SessionException() throw() {}
165 virtual const char* what() const throw() { return _message.c_str(); }
168 std::string _message;
171 /** Ardour Session */
172 class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::ScopedConnectionList, public SessionEventManager
176 PendingDeclickIn = 0x1, ///< pending de-click fade-in for start
177 PendingDeclickOut = 0x2, ///< pending de-click fade-out for stop
178 StopPendingCapture = 0x4,
179 PendingLoopDeclickIn = 0x8, ///< pending de-click fade-in at the start of a loop
180 PendingLoopDeclickOut = 0x10, ///< pending de-click fade-out at the end of a loop
181 PendingLocate = 0x20,
191 /* a new session might have non-empty mix_template, an existing session should always have an empty one.
192 the bus profile can be null if no master out bus is required.
195 Session (AudioEngine&,
196 const std::string& fullpath,
197 const std::string& snapshot_name,
198 BusProfile* bus_profile = 0,
199 std::string mix_template = "");
203 static int get_info_from_path (const std::string& xmlpath, float& sample_rate, SampleFormat& data_format, std::string& program_version);
204 static std::string get_snapshot_from_instant (const std::string& session_dir);
206 /** a monotonic counter used for naming user-visible things uniquely
207 * (curently the sidechain port).
208 * Use sparingly to keep the numbers low, prefer PBD::ID for all
209 * internal, not user-visible IDs */
210 static unsigned int next_name_id ();
212 std::string path() const { return _path; }
213 std::string name() const { return _name; }
214 std::string snap_name() const { return _current_snapshot_name; }
215 std::string raid_path () const;
216 bool path_is_within_session (const std::string&);
218 bool writable() const { return _writable; }
221 bool dirty() const { return _state_of_the_state & Dirty; }
222 void set_deletion_in_progress ();
223 void clear_deletion_in_progress ();
224 bool reconnection_in_progress() const { return _reconnecting_routes_in_progress; }
225 bool deletion_in_progress() const { return _state_of_the_state & Deletion; }
226 bool routes_deletion_in_progress() const { return _route_deletion_in_progress; }
227 bool peaks_cleanup_in_progres() const { return _state_of_the_state & PeakCleanup; }
228 bool loading () const { return _state_of_the_state & Loading; }
230 PBD::Signal0<void> DirtyChanged;
232 const SessionDirectory& session_directory () const { return *(_session_dir.get()); }
234 static PBD::Signal1<void,std::string> Dialog;
236 PBD::Signal0<void> BatchUpdateStart;
237 PBD::Signal0<void> BatchUpdateEnd;
239 int ensure_subdirs ();
241 std::string automation_dir () const; ///< Automation data
242 std::string analysis_dir () const; ///< Analysis data
243 std::string plugins_dir () const; ///< Plugin state
244 std::string externals_dir () const; ///< Links to external files
246 std::string construct_peak_filepath (const std::string& audio_path, const bool in_session = false, const bool old_peak_name = false) const;
248 bool audio_source_name_is_unique (const std::string& name);
249 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);
250 std::string new_audio_source_path_for_embedded (const std::string& existing_path);
251 std::string new_audio_source_path (const std::string&, uint32_t nchans, uint32_t chan, bool destructive, bool take_required);
252 std::string new_midi_source_path (const std::string&, bool need_source_lock = true);
253 /** create a new track or bus from a template (XML path)
254 * @param how_many how many tracks or busses to create
255 * @param template_path path to xml template file
256 * @param name name (prefix) of the route to create
257 * @param pd Playlist disposition
258 * @return list of newly created routes
260 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);
261 RouteList new_route_from_template (uint32_t how_many, PresentationInfo::order_t insert_at, XMLNode&, const std::string& name, PlaylistDisposition pd = NewPlaylist);
262 std::vector<std::string> get_paths_for_new_sources (bool allow_replacing, const std::string& import_file_path,
263 uint32_t channels, std::vector<std::string> const & smf_track_names);
265 int bring_all_sources_into_session (boost::function<void(uint32_t,uint32_t,std::string)> callback);
267 void process (pframes_t nframes);
269 BufferSet& get_silent_buffers (ChanCount count = ChanCount::ZERO);
270 BufferSet& get_noinplace_buffers (ChanCount count = ChanCount::ZERO);
271 BufferSet& get_scratch_buffers (ChanCount count = ChanCount::ZERO, bool silence = true);
272 BufferSet& get_route_buffers (ChanCount count = ChanCount::ZERO, bool silence = true);
273 BufferSet& get_mix_buffers (ChanCount count = ChanCount::ZERO);
275 bool have_rec_enabled_track () const;
276 bool have_rec_disabled_track () const;
278 bool have_captured() const { return _have_captured; }
280 void refill_all_track_buffers ();
281 Butler* butler() { return _butler; }
282 void butler_transport_work ();
284 void refresh_disk_space ();
286 int load_diskstreams_2X (XMLNode const &, int);
288 int load_routes (const XMLNode&, int);
289 boost::shared_ptr<RouteList> get_routes() const {
290 return routes.reader ();
293 CoreSelection& selection () { return *_selection; }
295 /* because the set of Stripables consists of objects managed
296 * independently, in multiple containers within the Session (or objects
297 * owned by the session), we fill out a list in-place rather than
298 * return a pointer to a copy of the (RCU) managed list, as happens
302 void get_stripables (StripableList&) const;
303 StripableList get_stripables () const;
304 boost::shared_ptr<RouteList> get_tracks() const;
305 boost::shared_ptr<RouteList> get_routes_with_internal_returns() const;
306 boost::shared_ptr<RouteList> get_routes_with_regions_at (framepos_t const) const;
308 uint32_t nstripables (bool with_monitor = false) const;
309 uint32_t nroutes() const { return routes.reader()->size(); }
310 uint32_t ntracks () const;
311 uint32_t nbusses () const;
313 boost::shared_ptr<BundleList> bundles () {
314 return _bundles.reader ();
317 void notify_presentation_info_change ();
319 template<class T> void foreach_route (T *obj, void (T::*func)(Route&), bool sort = true);
320 template<class T> void foreach_route (T *obj, void (T::*func)(boost::shared_ptr<Route>), bool sort = true);
321 template<class T, class A> void foreach_route (T *obj, void (T::*func)(Route&, A), A arg, bool sort = true);
323 static char session_name_is_legal (const std::string&);
324 bool io_name_is_legal (const std::string&) const;
325 boost::shared_ptr<Route> route_by_name (std::string) const;
326 boost::shared_ptr<Route> route_by_id (PBD::ID) const;
327 boost::shared_ptr<Stripable> stripable_by_id (PBD::ID) const;
328 boost::shared_ptr<Stripable> get_remote_nth_stripable (PresentationInfo::order_t n, PresentationInfo::Flag) const;
329 boost::shared_ptr<Route> get_remote_nth_route (PresentationInfo::order_t n) const;
330 boost::shared_ptr<Route> route_by_selected_count (uint32_t cnt) const;
331 void routes_using_input_from (const std::string& str, RouteList& rl);
333 bool route_name_unique (std::string) const;
334 bool route_name_internal (std::string) const;
336 uint32_t track_number_decimals () const {
337 return _track_number_decimals;
340 bool get_record_enabled() const {
341 return (record_status () >= Enabled);
344 RecordState record_status() const {
345 return (RecordState) g_atomic_int_get (&_record_status);
348 bool actively_recording () const {
349 return record_status() == Recording;
352 bool record_enabling_legal () const;
353 void maybe_enable_record (bool rt_context = false);
354 void disable_record (bool rt_context, bool force = false);
355 void step_back_from_record ();
357 void set_all_tracks_record_enabled(bool);
359 void maybe_write_autosave ();
361 /* Emitted when all i/o connections are complete */
363 PBD::Signal0<void> IOConnectionsComplete;
365 /* Timecode status signals */
366 PBD::Signal1<void, bool> MTCSyncStateChanged;
367 PBD::Signal1<void, bool> LTCSyncStateChanged;
369 /* Record status signals */
371 PBD::Signal0<void> RecordStateChanged; /* signals changes in recording state (i.e. are we recording) */
372 /* XXX may 2015: paul says: it isn't clear to me that this has semantics that cannot be inferrred
373 from the previous signal and session state.
375 PBD::Signal0<void> RecordArmStateChanged; /* signals changes in recording arming */
377 /* Emited when session is loaded */
378 PBD::Signal0<void> SessionLoaded;
380 /* Transport mechanism signals */
382 /** Emitted on the following changes in transport state:
383 * - stop (from the butler thread)
384 * - change in whether or not we are looping (from the process thread)
385 * - change in the play range (from the process thread)
386 * - start (from the process thread)
389 PBD::Signal0<void> TransportStateChange;
391 PBD::Signal1<void,framepos_t> PositionChanged; /* sent after any non-sequential motion */
392 PBD::Signal1<void,framepos_t> Xrun;
393 PBD::Signal0<void> TransportLooped;
395 /** emitted when a locate has occurred */
396 PBD::Signal0<void> Located;
398 PBD::Signal1<void,RouteList&> RouteAdded;
399 /** Emitted when a property of one of our route groups changes.
400 * The parameter is the RouteGroup that has changed.
402 PBD::Signal1<void, RouteGroup *> RouteGroupPropertyChanged;
403 /** Emitted when a route is added to one of our route groups.
404 * First parameter is the RouteGroup, second is the route.
406 PBD::Signal2<void, RouteGroup *, boost::weak_ptr<Route> > RouteAddedToRouteGroup;
407 /** Emitted when a route is removed from one of our route groups.
408 * First parameter is the RouteGroup, second is the route.
410 PBD::Signal2<void, RouteGroup *, boost::weak_ptr<Route> > RouteRemovedFromRouteGroup;
412 /* Step Editing status changed */
413 PBD::Signal1<void,bool> StepEditStatusChange;
415 /* Timecode state signals */
416 PBD::Signal0<void> MtcOrLtcInputPortChanged;
418 void queue_event (SessionEvent*);
420 void request_roll_at_and_return (framepos_t start, framepos_t return_to);
421 void request_bounded_roll (framepos_t start, framepos_t end);
422 void request_stop (bool abort = false, bool clear_state = false);
423 void request_locate (framepos_t frame, bool with_roll = false);
425 void request_play_loop (bool yn, bool leave_rolling = false);
426 bool get_play_loop () const { return play_loop; }
428 framepos_t last_transport_start () const { return _last_roll_location; }
430 void goto_start (bool and_roll = false);
431 void use_rf_shuttle_speed ();
432 void allow_auto_play (bool yn);
433 void request_transport_speed (double speed, bool as_default = true);
434 void request_transport_speed_nonzero (double, bool as_default = true);
435 void request_overwrite_buffer (Track *);
436 void adjust_playback_buffering();
437 void adjust_capture_buffering();
438 void request_track_speed (Track *, double speed);
439 void request_input_change_handling ();
441 bool locate_pending() const { return static_cast<bool>(post_transport_work()&PostTransportLocate); }
442 bool declick_out_pending() const { return static_cast<bool>(transport_sub_state&(PendingDeclickOut)); }
443 bool transport_locked () const;
447 framepos_t current_end_frame () const;
448 framepos_t current_start_frame () const;
449 /** "actual" sample rate of session, set by current audioengine rate, pullup/down etc. */
450 framecnt_t frame_rate () const { return _current_frame_rate; }
451 /** "native" sample rate of session, regardless of current audioengine rate, pullup/down etc */
452 framecnt_t nominal_frame_rate () const { return _nominal_frame_rate; }
453 framecnt_t frames_per_hour () const { return _frames_per_hour; }
455 double samples_per_timecode_frame() const { return _samples_per_timecode_frame; }
456 framecnt_t timecode_frames_per_hour() const { return _timecode_frames_per_hour; }
458 MIDI::byte get_mtc_timecode_bits() const {
459 return mtc_timecode_bits; /* encoding of SMTPE type for MTC */
462 double timecode_frames_per_second() const;
463 bool timecode_drop_frames() const;
467 Locations *locations() { return _locations; }
469 PBD::Signal1<void,Location*> auto_loop_location_changed;
470 PBD::Signal1<void,Location*> auto_punch_location_changed;
471 PBD::Signal0<void> locations_modified;
473 void set_auto_punch_location (Location *);
474 void set_auto_loop_location (Location *);
475 void set_session_extents (framepos_t start, framepos_t end);
476 bool end_is_free () const { return _session_range_end_is_free; }
477 void set_end_is_free (bool);
478 int location_name(std::string& result, std::string base = std::string(""));
480 pframes_t get_block_size() const { return current_block_size; }
481 framecnt_t worst_output_latency () const { return _worst_output_latency; }
482 framecnt_t worst_input_latency () const { return _worst_input_latency; }
483 framecnt_t worst_track_latency () const { return _worst_track_latency; }
484 framecnt_t worst_playback_latency () const { return _worst_output_latency + _worst_track_latency; }
487 std::string new_parent_folder; /* parent folder where new session folder will be created */
488 std::string new_name; /* name of newly saved session */
489 bool switch_to; /* true if we should be working on newly saved session after save-as; false otherwise */
490 bool include_media; /* true if the newly saved session should contain references to media */
491 bool copy_media; /* true if media files (audio, media, etc) should be copied into newly saved session; false otherwise */
492 bool copy_external; /* true if external media should be consolidated into the newly saved session; false otherwise */
494 std::string final_session_folder_name; /* filled in by * Session::save_as(), provides full path to newly saved session */
496 /* emitted as we make progress. 3 arguments passed to signal
499 * 1: percentage complete measured as a fraction (0-1.0) of
500 * total data copying done.
501 * 2: number of files copied so far
502 * 3: total number of files to copy
504 * Handler should return true for save-as to continue, or false
505 * to stop (and remove all evidence of partial save-as).
507 PBD::Signal3<bool,float,int64_t,int64_t> Progress;
509 /* if save_as() returns non-zero, this string will indicate the reason why.
511 std::string failure_message;
514 int save_as (SaveAs&);
516 * @param snapshot_name name of the session (use an empty string for the current name)
517 * @param pending save a 'recovery', not full state (default: false)
518 * @param switch_to_snapshot switch to given snapshot after saving (default: false)
519 * @param template_only save a session template (default: false)
520 * @return zero on success
522 int save_state (std::string snapshot_name, bool pending = false, bool switch_to_snapshot = false, bool template_only = false);
530 int archive_session (const std::string&, const std::string&, ArchiveEncode compress_audio = FLAC_16BIT, bool only_used_sources = false, Progress* p = 0);
532 int restore_state (std::string snapshot_name);
533 int save_template (const std::string& template_name, const std::string& description = "", bool replace_existing = false);
534 int save_history (std::string snapshot_name = "");
535 int restore_history (std::string snapshot_name);
536 void remove_state (std::string snapshot_name);
537 void rename_state (std::string old_name, std::string new_name);
538 void remove_pending_capture_state ();
539 int rename (const std::string&);
540 bool get_nsm_state () const { return _under_nsm_control; }
541 void set_nsm_state (bool state) { _under_nsm_control = state; }
542 bool save_default_options ();
544 PBD::Signal1<void,std::string> StateSaved;
545 PBD::Signal0<void> StateReady;
547 /* emitted when session needs to be saved due to some internal
548 * event or condition (i.e. not in response to a user request).
550 * Only one object should
551 * connect to this signal and take responsibility.
553 * Argument is the snapshot name to use when saving.
555 PBD::Signal1<void,std::string> SaveSessionRequested;
557 /* emitted during a session save to allow other entities to add state, via
558 * extra XML, to the session state
560 PBD::Signal0<void> SessionSaveUnderway;
562 std::vector<std::string> possible_states() const;
563 static std::vector<std::string> possible_states (std::string path);
565 XMLNode& get_state();
566 int set_state(const XMLNode& node, int version); // not idempotent
567 XMLNode& get_template();
568 bool export_track_state (boost::shared_ptr<RouteList> rl, const std::string& path);
570 /// The instant xml file is written to the session directory
571 void add_instant_xml (XMLNode&, bool write_to_config = true);
572 XMLNode* instant_xml (const std::string& str);
574 enum StateOfTheState {
579 InitialConnecting = 0x8,
585 StateOfTheState state_of_the_state() const { return _state_of_the_state; }
587 class StateProtector {
589 StateProtector (Session* s) : _session (s) {
590 g_atomic_int_inc (&s->_suspend_save);
593 if (g_atomic_int_dec_and_test (&_session->_suspend_save)) {
594 while (_session->_save_queued) {
595 _session->_save_queued = false;
596 _session->save_state ("");
604 class ProcessorChangeBlocker {
606 ProcessorChangeBlocker (Session* s, bool rc = true)
608 , _reconfigure_on_delete (rc)
610 g_atomic_int_inc (&s->_ignore_route_processor_changes);
612 ~ProcessorChangeBlocker () {
613 if (g_atomic_int_dec_and_test (&_session->_ignore_route_processor_changes)) {
614 if (_reconfigure_on_delete) {
615 _session->route_processors_changed (RouteProcessorChange ());
621 bool _reconfigure_on_delete;
624 RouteGroup* new_route_group (const std::string&);
625 void add_route_group (RouteGroup *);
626 void remove_route_group (RouteGroup* rg) { if (rg) remove_route_group (*rg); }
627 void remove_route_group (RouteGroup&);
628 void reorder_route_groups (std::list<RouteGroup*>);
630 RouteGroup* route_group_by_name (std::string);
631 RouteGroup& all_route_group() const;
633 PBD::Signal1<void,RouteGroup*> route_group_added;
634 PBD::Signal0<void> route_group_removed;
635 PBD::Signal0<void> route_groups_reordered;
637 void foreach_route_group (boost::function<void(RouteGroup*)> f) {
638 for (std::list<RouteGroup *>::iterator i = _route_groups.begin(); i != _route_groups.end(); ++i) {
643 std::list<RouteGroup*> const & route_groups () const {
644 return _route_groups;
647 /* fundamental operations. duh. */
649 std::list<boost::shared_ptr<AudioTrack> > new_audio_track (
652 RouteGroup* route_group,
654 std::string name_template,
655 PresentationInfo::order_t order,
656 TrackMode mode = Normal
659 std::list<boost::shared_ptr<MidiTrack> > new_midi_track (
660 const ChanCount& input, const ChanCount& output, bool strict_io,
661 boost::shared_ptr<PluginInfo> instrument,
662 Plugin::PresetRecord* pset,
663 RouteGroup* route_group, uint32_t how_many, std::string name_template,
664 PresentationInfo::order_t,
665 TrackMode mode = Normal
668 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);
669 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);
671 void remove_routes (boost::shared_ptr<RouteList>);
672 void remove_route (boost::shared_ptr<Route>);
674 void resort_routes ();
675 void resort_routes_using (boost::shared_ptr<RouteList>);
677 AudioEngine & engine() { return _engine; }
678 AudioEngine const & engine () const { return _engine; }
680 static std::string default_track_name_pattern (DataType);
684 framepos_t transport_frame () const {return _transport_frame; }
685 framepos_t record_location () const {return _last_record_location; }
686 framepos_t audible_frame (bool* latent_locate = NULL) const;
687 framepos_t requested_return_frame() const { return _requested_return_frame; }
688 void set_requested_return_frame(framepos_t return_to);
702 void sync_time_vars();
704 void bbt_time (framepos_t when, Timecode::BBT_Time&);
705 void timecode_to_sample(Timecode::Time& timecode, framepos_t& sample, bool use_offset, bool use_subframes) const;
706 void sample_to_timecode(framepos_t sample, Timecode::Time& timecode, bool use_offset, bool use_subframes) const;
707 void timecode_time (Timecode::Time &);
708 void timecode_time (framepos_t when, Timecode::Time&);
709 void timecode_time_subframes (framepos_t when, Timecode::Time&);
711 void timecode_duration (framecnt_t, Timecode::Time&) const;
712 void timecode_duration_string (char *, size_t len, framecnt_t) const;
714 framecnt_t convert_to_frames (AnyTime const & position);
715 framecnt_t any_duration_to_frames (framepos_t position, AnyTime const & duration);
717 static PBD::Signal1<void, framepos_t> StartTimeChanged;
718 static PBD::Signal1<void, framepos_t> EndTimeChanged;
720 void request_sync_source (Slave*);
721 bool synced_to_engine() const { return _slave && config.get_external_sync() && Config->get_sync_source() == Engine; }
722 bool synced_to_mtc () const { return config.get_external_sync() && Config->get_sync_source() == MTC && g_atomic_int_get (const_cast<gint*>(&_mtc_active)); }
723 bool synced_to_ltc () const { return config.get_external_sync() && Config->get_sync_source() == LTC && g_atomic_int_get (const_cast<gint*>(&_ltc_active)); }
725 double transport_speed() const { return _count_in_samples > 0 ? 0. : _transport_speed; }
726 bool transport_stopped() const { return _transport_speed == 0.0; }
727 bool transport_rolling() const { return _transport_speed != 0.0 && _count_in_samples == 0; }
729 bool silent () { return _silent; }
731 TempoMap& tempo_map() { return *_tempo_map; }
732 const TempoMap& tempo_map() const { return *_tempo_map; }
734 unsigned int get_xrun_count () const {return _xrun_count; }
735 void reset_xrun_count () {_xrun_count = 0; }
739 boost::shared_ptr<Region> find_whole_file_parent (boost::shared_ptr<Region const>) const;
741 boost::shared_ptr<Region> XMLRegionFactory (const XMLNode&, bool full);
742 boost::shared_ptr<AudioRegion> XMLAudioRegionFactory (const XMLNode&, bool full);
743 boost::shared_ptr<MidiRegion> XMLMidiRegionFactory (const XMLNode&, bool full);
745 /* source management */
747 void import_files (ImportStatus&);
748 bool sample_rate_convert (ImportStatus&, std::string infile, std::string& outfile);
749 std::string build_tmp_convert_name (std::string file);
751 boost::shared_ptr<ExportHandler> get_export_handler ();
752 boost::shared_ptr<ExportStatus> get_export_status ();
754 int start_audio_export (framepos_t position, bool realtime = false, bool region_export = false, bool comensate_master_latency = false);
756 PBD::Signal1<int, framecnt_t> ProcessExport;
757 static PBD::Signal2<void,std::string, std::string> Exported;
759 void add_source (boost::shared_ptr<Source>);
760 void remove_source (boost::weak_ptr<Source>);
762 void cleanup_regions();
763 bool can_cleanup_peakfiles () const;
764 int cleanup_peakfiles ();
765 int cleanup_sources (CleanupReport&);
766 int cleanup_trash_sources (CleanupReport&);
768 int destroy_sources (std::list<boost::shared_ptr<Source> >);
770 int remove_last_capture ();
772 /** handlers should return 0 for "everything OK", and any other value for
773 * "cannot setup audioengine".
775 static PBD::Signal1<int,uint32_t> AudioEngineSetupRequired;
777 /** handlers should return -1 for "stop cleanup",
778 0 for "yes, delete this playlist",
779 1 for "no, don't delete this playlist".
781 static PBD::Signal1<int,boost::shared_ptr<Playlist> > AskAboutPlaylistDeletion;
783 /** handlers should return 0 for "ignore the rate mismatch",
784 !0 for "do not use this session"
786 static PBD::Signal2<int, framecnt_t, framecnt_t> AskAboutSampleRateMismatch;
788 /** non interactive message */
789 static PBD::Signal2<void, framecnt_t, framecnt_t> NotifyAboutSampleRateMismatch;
791 /** handlers should return !0 for use pending state, 0 for ignore it.
793 static PBD::Signal0<int> AskAboutPendingState;
795 boost::shared_ptr<AudioFileSource> create_audio_source_for_session (
796 size_t, std::string const &, uint32_t, bool destructive);
798 boost::shared_ptr<MidiSource> create_midi_source_for_session (std::string const &);
799 boost::shared_ptr<MidiSource> create_midi_source_by_stealing_name (boost::shared_ptr<Track>);
801 boost::shared_ptr<Source> source_by_id (const PBD::ID&);
802 boost::shared_ptr<AudioFileSource> audio_source_by_path_and_channel (const std::string&, uint16_t) const;
803 boost::shared_ptr<MidiSource> midi_source_by_path (const std::string&, bool need_source_lock) const;
804 uint32_t count_sources_by_origin (const std::string&);
806 void add_playlist (boost::shared_ptr<Playlist>, bool unused = false);
808 /* Curves and AutomationLists (TODO when they go away) */
809 void add_automation_list(AutomationList*);
813 boost::shared_ptr<Auditioner> the_auditioner() { return auditioner; }
814 void audition_playlist ();
815 void audition_region (boost::shared_ptr<Region>);
816 void cancel_audition ();
817 bool is_auditioning () const;
819 PBD::Signal1<void,bool> AuditionActive;
822 void register_lua_function (const std::string&, const std::string&, const LuaScriptParamList&);
823 void unregister_lua_function (const std::string& name);
824 std::vector<std::string> registered_lua_functions ();
825 uint32_t registered_lua_function_count () const { return _n_lua_scripts; }
826 void scripts_changed (); // called from lua, updates _n_lua_scripts
828 PBD::Signal0<void> LuaScriptsChanged;
830 /* flattening stuff */
832 boost::shared_ptr<Region> write_one_track (Track&, framepos_t start, framepos_t end,
833 bool overwrite, std::vector<boost::shared_ptr<Source> >&, InterThreadInfo& wot,
834 boost::shared_ptr<Processor> endpoint,
835 bool include_endpoint, bool for_export, bool for_freeze);
836 int freeze_all (InterThreadInfo&);
838 /* session-wide solo/mute/rec-enable */
841 std::vector<boost::weak_ptr<AutomationControl> > cancel_all_mute ();
843 bool soloing() const { return _non_soloed_outs_muted; }
844 bool listening() const { return _listen_cnt > 0; }
845 bool solo_isolated() const { return _solo_isolated_cnt > 0; }
846 void cancel_all_solo ();
848 static const SessionEvent::RTeventCallback rt_cleanup;
850 void clear_all_solo_state (boost::shared_ptr<RouteList>);
852 /* Control-based methods */
854 void set_controls (boost::shared_ptr<ControlList>, double val, PBD::Controllable::GroupControlDisposition);
855 void set_control (boost::shared_ptr<AutomationControl>, double val, PBD::Controllable::GroupControlDisposition);
857 void set_exclusive_input_active (boost::shared_ptr<RouteList> rt, bool onoff, bool flip_others = false);
859 PBD::Signal1<void,bool> SoloActive;
860 PBD::Signal0<void> SoloChanged;
861 PBD::Signal0<void> MuteChanged;
862 PBD::Signal0<void> IsolatedChanged;
863 PBD::Signal0<void> MonitorChanged;
865 PBD::Signal0<void> session_routes_reconnected;
867 /* monitor/master out */
868 int add_master_bus (ChanCount const&);
870 void add_monitor_section ();
871 void reset_monitor_section ();
872 void remove_monitor_section ();
873 bool monitor_active() const { return (_monitor_out && _monitor_out->monitor_control () && _monitor_out->monitor_control ()->monitor_active()); }
875 boost::shared_ptr<Route> monitor_out() const { return _monitor_out; }
876 boost::shared_ptr<Route> master_out() const { return _master_out; }
878 PresentationInfo::order_t master_order_key () const { return _master_out ? _master_out->presentation_info ().order () : -1; }
879 bool ensure_stripable_sort_order ();
881 void globally_add_internal_sends (boost::shared_ptr<Route> dest, Placement p, bool);
882 void globally_set_send_gains_from_track (boost::shared_ptr<Route> dest);
883 void globally_set_send_gains_to_zero (boost::shared_ptr<Route> dest);
884 void globally_set_send_gains_to_unity (boost::shared_ptr<Route> dest);
885 void add_internal_sends (boost::shared_ptr<Route> dest, Placement p, boost::shared_ptr<RouteList> senders);
886 void add_internal_send (boost::shared_ptr<Route>, int, boost::shared_ptr<Route>);
887 void add_internal_send (boost::shared_ptr<Route>, boost::shared_ptr<Processor>, boost::shared_ptr<Route>);
889 static void set_disable_all_loaded_plugins (bool yn) {
890 _disable_all_loaded_plugins = yn;
892 static bool get_disable_all_loaded_plugins() {
893 return _disable_all_loaded_plugins;
895 static void set_bypass_all_loaded_plugins (bool yn) {
896 _bypass_all_loaded_plugins = yn;
898 static bool get_bypass_all_loaded_plugins() {
899 return _bypass_all_loaded_plugins;
902 uint32_t next_send_id();
903 uint32_t next_aux_send_id();
904 uint32_t next_return_id();
905 uint32_t next_insert_id();
906 void mark_send_id (uint32_t);
907 void mark_aux_send_id (uint32_t);
908 void mark_return_id (uint32_t);
909 void mark_insert_id (uint32_t);
910 void unmark_send_id (uint32_t);
911 void unmark_aux_send_id (uint32_t);
912 void unmark_return_id (uint32_t);
913 void unmark_insert_id (uint32_t);
915 /* s/w "RAID" management */
917 boost::optional<framecnt_t> available_capture_duration();
921 void add_bundle (boost::shared_ptr<Bundle>, bool emit_signal = true);
922 void remove_bundle (boost::shared_ptr<Bundle>);
923 boost::shared_ptr<Bundle> bundle_by_name (std::string) const;
925 PBD::Signal0<void> BundleAddedOrRemoved;
929 /* History (for editors, mixers, UIs etc.) */
931 /** Undo some transactions.
932 * @param n Number of transactions to undo.
934 void undo (uint32_t n);
935 /** Redo some transactions.
936 * @param n Number of transactions to undo.
938 void redo (uint32_t n);
940 UndoHistory& history() { return _history; }
942 uint32_t undo_depth() const { return _history.undo_depth(); }
943 uint32_t redo_depth() const { return _history.redo_depth(); }
944 std::string next_undo() const { return _history.next_undo(); }
945 std::string next_redo() const { return _history.next_redo(); }
947 /** begin collecting undo information
949 * This call must always be followed by either
950 * begin_reversible_command() or commit_reversible_command()
952 * @param cmd_name human readable name for the undo operation
954 void begin_reversible_command (const std::string& cmd_name);
955 void begin_reversible_command (GQuark);
956 /** abort an open undo command
957 * This must only be called after begin_reversible_command ()
959 void abort_reversible_command ();
960 /** finalize an undo command and commit pending transactions
962 * This must only be called after begin_reversible_command ()
963 * @param cmd (additional) command to add
965 void commit_reversible_command (Command* cmd = 0);
967 void add_command (Command *const cmd);
969 /** create an StatefulDiffCommand from the given object and add it to the stack.
971 * This function must only be called after begin_reversible_command.
972 * Failing to do so may lead to a crash.
974 * @param sfd the object to diff
975 * @returns the allocated StatefulDiffCommand (already added via add_command)
977 PBD::StatefulDiffCommand* add_stateful_diff_command (boost::shared_ptr<PBD::StatefulDestructible> sfd);
979 /** @return The list of operations that are currently in progress */
980 std::list<GQuark> const & current_operations () {
981 return _current_trans_quarks;
984 bool operation_in_progress (GQuark) const;
986 void add_commands (std::vector<Command*> const & cmds);
988 std::map<PBD::ID,PBD::StatefulDestructible*> registry;
990 // these commands are implemented in libs/ardour/session_command.cc
991 Command* memento_command_factory(XMLNode* n);
992 Command* stateful_diff_command_factory (XMLNode *);
993 void register_with_memento_command_factory(PBD::ID, PBD::StatefulDestructible*);
997 boost::shared_ptr<IO> click_io() { return _click_io; }
998 boost::shared_ptr<Amp> click_gain() { return _click_gain; }
1000 /* disk, buffer loads */
1002 uint32_t playback_load ();
1003 uint32_t capture_load ();
1007 void request_play_range (std::list<AudioRange>*, bool leave_rolling = false);
1008 void request_cancel_play_range ();
1009 bool get_play_range () const { return _play_range; }
1011 void maybe_update_session_range (framepos_t, framepos_t);
1014 framecnt_t preroll_samples (framepos_t) const;
1016 void request_preroll_record_punch (framepos_t start, framecnt_t preroll);
1017 void request_preroll_record_trim (framepos_t start, framecnt_t preroll);
1018 void request_count_in_record ();
1020 framepos_t preroll_record_punch_pos () const { return _preroll_record_punch_pos; }
1021 bool preroll_record_punch_enabled () const { return _preroll_record_punch_pos >= 0; }
1023 framecnt_t preroll_record_trim_len () const { return _preroll_record_trim_len; }
1025 /* temporary hacks to allow selection to be pushed from GUI into backend.
1026 Whenever we move the selection object into libardour, these will go away.
1028 void set_range_selection (framepos_t start, framepos_t end);
1029 void set_object_selection (framepos_t start, framepos_t end);
1030 void clear_range_selection ();
1031 void clear_object_selection ();
1033 /* buffers for gain and pan */
1035 gain_t* gain_automation_buffer () const;
1036 gain_t* trim_automation_buffer () const;
1037 gain_t* send_gain_automation_buffer () const;
1038 gain_t* scratch_automation_buffer () const;
1039 pan_t** pan_automation_buffer () const;
1041 void ensure_buffer_set (BufferSet& buffers, const ChanCount& howmany);
1045 static int vst_current_loading_id;
1046 static const char* vst_can_do_strings[];
1047 static const int vst_can_do_string_count;
1049 static intptr_t vst_callback (
1058 static PBD::Signal0<void> SendFeedback;
1062 boost::shared_ptr<Speakers> get_speakers ();
1066 boost::shared_ptr<Processor> processor_by_id (PBD::ID) const;
1068 boost::shared_ptr<PBD::Controllable> controllable_by_id (const PBD::ID&);
1069 boost::shared_ptr<AutomationControl> automation_control_by_id (const PBD::ID&);
1070 boost::shared_ptr<PBD::Controllable> controllable_by_descriptor (const ARDOUR::ControllableDescriptor&);
1072 void add_controllable (boost::shared_ptr<PBD::Controllable>);
1073 void remove_controllable (PBD::Controllable*);
1075 boost::shared_ptr<PBD::Controllable> solo_cut_control() const;
1077 SessionConfiguration config;
1079 SessionConfiguration* cfg () { return &config; }
1081 bool exporting () const {
1085 bool bounce_processing() const {
1086 return _bounce_processing_active;
1089 /* this is a private enum, but setup_enum_writer() needs it,
1090 and i can't find a way to give that function
1091 friend access. sigh.
1094 enum PostTransportWork {
1095 PostTransportStop = 0x1,
1096 PostTransportDuration = 0x2,
1097 PostTransportLocate = 0x4,
1098 PostTransportRoll = 0x8,
1099 PostTransportAbort = 0x10,
1100 PostTransportOverWrite = 0x20,
1101 PostTransportSpeed = 0x40,
1102 PostTransportAudition = 0x80,
1103 PostTransportReverse = 0x100,
1104 PostTransportInputChange = 0x200,
1105 PostTransportCurveRealloc = 0x400,
1106 PostTransportClearSubstate = 0x800,
1107 PostTransportAdjustPlaybackBuffering = 0x1000,
1108 PostTransportAdjustCaptureBuffering = 0x2000
1117 SlaveState slave_state() const { return _slave_state; }
1118 Slave* slave() const { return _slave; }
1120 boost::shared_ptr<SessionPlaylists> playlists;
1122 void send_mmc_locate (framepos_t);
1123 void queue_full_time_code () { _send_timecode_update = true; }
1124 void queue_song_position_pointer () { /* currently does nothing */ }
1126 bool step_editing() const { return (_step_editors > 0); }
1128 void request_suspend_timecode_transmission ();
1129 void request_resume_timecode_transmission ();
1130 bool timecode_transmission_suspended () const;
1132 std::vector<std::string> source_search_path(DataType) const;
1133 void ensure_search_path_includes (const std::string& path, DataType type);
1134 void remove_dir_from_search_path (const std::string& path, DataType type);
1136 std::list<std::string> unknown_processors () const;
1138 /** Emitted when a feedback cycle has been detected within Ardour's signal
1139 processing path. Until it is fixed (by the user) some (unspecified)
1140 routes will not be run.
1142 static PBD::Signal0<void> FeedbackDetected;
1144 /** Emitted when a graph sort has successfully completed, which means
1145 that it has no feedback cycles.
1147 static PBD::Signal0<void> SuccessfulGraphSort;
1149 /* handlers can return an integer value:
1150 0: config.set_audio_search_path() or config.set_midi_search_path() was used
1151 to modify the search path and we should try to find it again.
1152 1: quit entire session load
1153 2: as 0, but don't ask about other missing files
1154 3: don't ask about other missing files, and just mark this one missing
1155 -1: just mark this one missing
1156 any other value: as -1
1158 static PBD::Signal3<int,Session*,std::string,DataType> MissingFile;
1160 void set_missing_file_replacement (const std::string& mfr) {
1161 _missing_file_replacement = mfr;
1164 /** Emitted when the session wants Ardour to quit */
1165 static PBD::Signal0<void> Quit;
1167 /** Emitted when Ardour is asked to load a session in an older session
1168 * format, and makes a backup copy.
1170 static PBD::Signal2<void,std::string,std::string> VersionMismatch;
1172 SceneChanger* scene_changer() const { return _scene_changer; }
1174 /* asynchronous MIDI control ports */
1176 boost::shared_ptr<Port> midi_input_port () const;
1177 boost::shared_ptr<Port> midi_output_port () const;
1178 boost::shared_ptr<Port> mmc_output_port () const;
1179 boost::shared_ptr<Port> mmc_input_port () const;
1180 boost::shared_ptr<Port> scene_input_port () const;
1181 boost::shared_ptr<Port> scene_output_port () const;
1183 /* synchronous MIDI ports used for synchronization */
1185 boost::shared_ptr<MidiPort> midi_clock_output_port () const;
1186 boost::shared_ptr<MidiPort> midi_clock_input_port () const;
1187 boost::shared_ptr<MidiPort> mtc_output_port () const;
1188 boost::shared_ptr<MidiPort> mtc_input_port () const;
1189 boost::shared_ptr<Port> ltc_input_port() const;
1190 boost::shared_ptr<Port> ltc_output_port() const;
1192 boost::shared_ptr<IO> ltc_input_io() { return _ltc_input; }
1193 boost::shared_ptr<IO> ltc_output_io() { return _ltc_output; }
1195 MIDI::MachineControl& mmc() { return *_mmc; }
1197 void reconnect_midi_scene_ports (bool);
1198 void reconnect_mtc_ports ();
1199 void reconnect_mmc_ports (bool);
1201 void reconnect_ltc_input ();
1202 void reconnect_ltc_output ();
1204 VCAManager& vca_manager() { return *_vca_manager; }
1205 VCAManager* vca_manager_ptr() { return _vca_manager; }
1207 void auto_connect_thread_wakeup ();
1211 friend class AudioEngine;
1212 void set_block_size (pframes_t nframes);
1213 void set_frame_rate (framecnt_t nframes);
1214 #ifdef USE_TRACKS_CODE_FEATURES
1215 void reconnect_existing_routes (bool withLock, bool reconnect_master = true, bool reconnect_inputs = true, bool reconnect_outputs = true);
1220 void schedule_curve_reallocation ();
1221 void update_latency_compensation (bool force = false);
1224 int create (const std::string& mix_template, BusProfile*);
1227 static guint _name_id_counter;
1228 static void init_name_id_counter (guint n);
1229 static unsigned int name_id_counter ();
1231 /* stuff used in process() should be close together to
1235 typedef void (Session::*process_function_type)(pframes_t);
1237 AudioEngine& _engine;
1238 mutable gint processing_prohibited;
1239 process_function_type process_function;
1240 process_function_type last_process_function;
1241 bool _bounce_processing_active;
1242 bool waiting_for_sync_offset;
1243 framecnt_t _base_frame_rate; // sample-rate of the session at creation time, "native" SR
1244 framecnt_t _nominal_frame_rate; // overridden by audioengine setting
1245 framecnt_t _current_frame_rate; // this includes video pullup offset
1246 int transport_sub_state;
1247 mutable gint _record_status;
1248 framepos_t _transport_frame;
1249 Location* _session_range_location; ///< session range, or 0 if there is nothing in the session yet
1250 bool _session_range_end_is_free;
1254 // varispeed playback
1255 double _transport_speed;
1256 double _default_transport_speed;
1257 double _last_transport_speed;
1258 double _signalled_varispeed;
1259 double _target_transport_speed;
1260 CubicInterpolation interpolation;
1262 bool auto_play_legal;
1263 framepos_t _last_slave_transport_frame;
1264 framecnt_t maximum_output_latency;
1265 framepos_t _requested_return_frame;
1266 pframes_t current_block_size;
1267 framecnt_t _worst_output_latency;
1268 framecnt_t _worst_input_latency;
1269 framecnt_t _worst_track_latency;
1270 bool _have_captured;
1271 bool _non_soloed_outs_muted;
1273 uint32_t _listen_cnt;
1274 uint32_t _solo_isolated_cnt;
1277 bool _under_nsm_control;
1278 unsigned int _xrun_count;
1280 std::string _missing_file_replacement;
1282 void mtc_status_changed (bool);
1283 PBD::ScopedConnection mtc_status_connection;
1284 void ltc_status_changed (bool);
1285 PBD::ScopedConnection ltc_status_connection;
1287 void initialize_latencies ();
1288 void set_worst_io_latencies ();
1289 void set_worst_playback_latency ();
1290 void set_worst_capture_latency ();
1291 void set_worst_io_latencies_x (IOChange, void *) {
1292 set_worst_io_latencies ();
1294 void post_capture_latency ();
1295 void post_playback_latency ();
1297 void update_latency_compensation_proxy (void* ignored);
1299 void ensure_buffers (ChanCount howmany = ChanCount::ZERO);
1301 void process_scrub (pframes_t);
1302 void process_without_events (pframes_t);
1303 void process_with_events (pframes_t);
1304 void process_audition (pframes_t);
1305 void process_export (pframes_t);
1306 void process_export_fw (pframes_t);
1308 void block_processing() { g_atomic_int_set (&processing_prohibited, 1); }
1309 void unblock_processing() { g_atomic_int_set (&processing_prohibited, 0); }
1310 bool processing_blocked() const { return g_atomic_int_get (&processing_prohibited); }
1312 static const framecnt_t bounce_chunk_size;
1314 /* slave tracking */
1316 static const int delta_accumulator_size = 25;
1317 int delta_accumulator_cnt;
1318 int32_t delta_accumulator[delta_accumulator_size];
1319 int32_t average_slave_delta;
1321 bool have_first_delta_accumulator;
1323 SlaveState _slave_state;
1326 framepos_t slave_wait_end;
1328 void reset_slave_state ();
1329 bool follow_slave (pframes_t);
1330 void calculate_moving_average_of_slave_delta (int dir, framecnt_t this_delta);
1331 void track_slave_state (float slave_speed, framepos_t slave_transport_frame, framecnt_t this_delta);
1332 void follow_slave_silently (pframes_t nframes, float slave_speed);
1334 void switch_to_sync_source (SyncSource); /* !RT context */
1335 void drop_sync_source (); /* !RT context */
1336 void use_sync_source (Slave*); /* RT context */
1338 bool post_export_sync;
1339 framepos_t post_export_position;
1342 bool _export_rolling;
1343 bool _realtime_export;
1344 bool _region_export;
1345 framepos_t _export_preroll;
1346 framepos_t _export_latency;
1348 boost::shared_ptr<ExportHandler> export_handler;
1349 boost::shared_ptr<ExportStatus> export_status;
1352 int stop_audio_export ();
1353 void finalize_audio_export ();
1354 void finalize_export_internal (bool stop_freewheel);
1355 bool _pre_export_mmc_enabled;
1357 PBD::ScopedConnection export_freewheel_connection;
1359 void get_track_statistics ();
1360 int process_routes (pframes_t, bool& need_butler);
1361 int silent_process_routes (pframes_t, bool& need_butler);
1363 /** @return 1 if there is a pending declick fade-in,
1364 -1 if there is a pending declick fade-out,
1365 0 if there is no pending declick.
1367 int get_transport_declick_required () {
1368 if (transport_sub_state & PendingDeclickIn) {
1369 transport_sub_state &= ~PendingDeclickIn;
1371 } else if (transport_sub_state & PendingDeclickOut) {
1372 /* XXX: not entirely sure why we don't clear this */
1374 } else if (transport_sub_state & PendingLoopDeclickOut) {
1375 /* Return the declick out first ... */
1376 transport_sub_state &= ~PendingLoopDeclickOut;
1378 } else if (transport_sub_state & PendingLoopDeclickIn) {
1379 /* ... then the declick in on the next call */
1380 transport_sub_state &= ~PendingLoopDeclickIn;
1387 bool maybe_stop (framepos_t limit);
1388 bool maybe_sync_start (pframes_t &);
1390 void check_declick_out ();
1396 /** Number of process frames since the last MTC output (when sending MTC); used to
1397 * know when to send full MTC messages every so often.
1399 pframes_t _pframes_since_last_mtc;
1402 framepos_t last_loopend;
1404 boost::scoped_ptr<SessionDirectory> _session_dir;
1407 void graph_reordered ();
1409 /** current snapshot name, without the .ardour suffix */
1410 void set_snapshot_name (const std::string &);
1411 void save_snapshot_name (const std::string &);
1412 std::string _current_snapshot_name;
1414 XMLTree* state_tree;
1415 bool state_was_pending;
1416 StateOfTheState _state_of_the_state;
1418 friend class StateProtector;
1419 gint _suspend_save; /* atomic */
1420 volatile bool _save_queued;
1421 Glib::Threads::Mutex save_state_lock;
1422 Glib::Threads::Mutex peak_cleanup_lock;
1424 int load_options (const XMLNode&);
1425 int load_state (std::string snapshot_name);
1426 static int parse_stateful_loading_version (const std::string&);
1428 framepos_t _last_roll_location;
1429 /** the session frame time at which we last rolled, located, or changed transport direction */
1430 framepos_t _last_roll_or_reversal_location;
1431 framepos_t _last_record_location;
1433 bool pending_locate_roll;
1434 framepos_t pending_locate_frame;
1435 bool pending_locate_flush;
1437 bool pending_auto_loop;
1439 PBD::ReallocPool _mempool;
1441 Glib::Threads::Mutex lua_lock;
1442 luabridge::LuaRef * _lua_run;
1443 luabridge::LuaRef * _lua_add;
1444 luabridge::LuaRef * _lua_del;
1445 luabridge::LuaRef * _lua_list;
1446 luabridge::LuaRef * _lua_load;
1447 luabridge::LuaRef * _lua_save;
1448 luabridge::LuaRef * _lua_cleanup;
1449 uint32_t _n_lua_scripts;
1452 void try_run_lua (pframes_t);
1456 static const PostTransportWork ProcessCannotProceedMask =
1458 PostTransportInputChange|
1459 PostTransportReverse|
1460 PostTransportCurveRealloc|
1461 PostTransportAudition|
1462 PostTransportLocate|
1464 PostTransportClearSubstate);
1466 gint _post_transport_work; /* accessed only atomic ops */
1467 PostTransportWork post_transport_work() const { return (PostTransportWork) g_atomic_int_get (const_cast<gint*>(&_post_transport_work)); }
1468 void set_post_transport_work (PostTransportWork ptw) { g_atomic_int_set (&_post_transport_work, (gint) ptw); }
1469 void add_post_transport_work (PostTransportWork ptw);
1471 void schedule_playback_buffering_adjustment ();
1472 void schedule_capture_buffering_adjustment ();
1474 uint32_t cumulative_rf_motion;
1477 void set_rf_speed (float speed);
1478 void reset_rf_scale (framecnt_t frames_moved);
1480 Locations* _locations;
1481 void location_added (Location*);
1482 void location_removed (Location*);
1483 void locations_changed ();
1484 void _locations_changed (const Locations::LocationList&);
1486 void update_skips (Location*, bool consolidate);
1487 void update_marks (Location* loc);
1488 void consolidate_skips (Location*);
1489 void sync_locations_to_skips ();
1490 void _sync_locations_to_skips ();
1492 PBD::ScopedConnectionList skip_update_connections;
1493 bool _ignore_skips_updates;
1495 PBD::ScopedConnectionList punch_connections;
1496 void auto_punch_start_changed (Location *);
1497 void auto_punch_end_changed (Location *);
1498 void auto_punch_changed (Location *);
1500 PBD::ScopedConnectionList loop_connections;
1501 void auto_loop_changed (Location *);
1502 void auto_loop_declick_range (Location *, framepos_t &, framepos_t &);
1504 int ensure_engine (uint32_t desired_sample_rate, bool);
1505 void pre_engine_init (std::string path);
1506 int post_engine_init ();
1507 int immediately_post_engine ();
1508 void remove_empty_sounds ();
1510 void session_loaded ();
1512 void setup_midi_control ();
1513 int midi_read (MIDI::Port *);
1515 void enable_record ();
1517 void increment_transport_position (framecnt_t val) {
1518 if (max_framepos - val < _transport_frame) {
1519 _transport_frame = max_framepos;
1521 _transport_frame += val;
1525 void decrement_transport_position (framecnt_t val) {
1526 if (val < _transport_frame) {
1527 _transport_frame -= val;
1529 _transport_frame = 0;
1533 void post_transport_motion ();
1534 static void *session_loader_thread (void *arg);
1538 /* Signal Forwarding */
1539 void emit_route_signals ();
1540 void emit_thread_run ();
1541 static void *emit_thread (void *);
1542 void emit_thread_start ();
1543 void emit_thread_terminate ();
1545 pthread_t _rt_emit_thread;
1546 bool _rt_thread_active;
1548 pthread_mutex_t _rt_emit_mutex;
1549 pthread_cond_t _rt_emit_cond;
1550 bool _rt_emit_pending;
1552 /* Auto Connect Thread */
1553 static void *auto_connect_thread (void *);
1554 void auto_connect_thread_run ();
1555 void auto_connect_thread_start ();
1556 void auto_connect_thread_terminate ();
1558 pthread_t _auto_connect_thread;
1559 gint _ac_thread_active;
1560 pthread_mutex_t _auto_connect_mutex;
1561 pthread_cond_t _auto_connect_cond;
1563 struct AutoConnectRequest {
1565 AutoConnectRequest (boost::shared_ptr <Route> r, bool ci,
1566 const ChanCount& is,
1567 const ChanCount& os,
1568 const ChanCount& io,
1569 const ChanCount& oo)
1570 : route (boost::weak_ptr<Route> (r))
1571 , connect_inputs (ci)
1575 , output_offset (oo)
1578 boost::weak_ptr <Route> route;
1579 bool connect_inputs;
1580 ChanCount input_start;
1581 ChanCount output_start;
1582 ChanCount input_offset;
1583 ChanCount output_offset;
1586 typedef std::queue<AutoConnectRequest> AutoConnectQueue;
1587 Glib::Threads::Mutex _auto_connect_queue_lock;
1588 AutoConnectQueue _auto_connect_queue;
1589 guint _latency_recompute_pending;
1591 void get_physical_ports (std::vector<std::string>& inputs, std::vector<std::string>& outputs, DataType type,
1592 MidiPortFlags include = MidiPortFlags (0),
1593 MidiPortFlags exclude = MidiPortFlags (0));
1595 void auto_connect (const AutoConnectRequest&);
1596 void queue_latency_recompute ();
1598 /* SessionEventManager interface */
1600 void process_event (SessionEvent*);
1601 void set_next_event ();
1602 void cleanup_event (SessionEvent*,int);
1604 /* MIDI Machine Control */
1607 void spp_continue ();
1610 void mmc_deferred_play (MIDI::MachineControl &);
1611 void mmc_stop (MIDI::MachineControl &);
1612 void mmc_step (MIDI::MachineControl &, int);
1613 void mmc_pause (MIDI::MachineControl &);
1614 void mmc_record_pause (MIDI::MachineControl &);
1615 void mmc_record_strobe (MIDI::MachineControl &);
1616 void mmc_record_exit (MIDI::MachineControl &);
1617 void mmc_track_record_status (MIDI::MachineControl &, uint32_t track, bool enabled);
1618 void mmc_fast_forward (MIDI::MachineControl &);
1619 void mmc_rewind (MIDI::MachineControl &);
1620 void mmc_locate (MIDI::MachineControl &, const MIDI::byte *);
1621 void mmc_shuttle (MIDI::MachineControl &mmc, float speed, bool forw);
1622 void mmc_record_enable (MIDI::MachineControl &mmc, size_t track, bool enabled);
1624 struct timeval last_mmc_step;
1627 typedef boost::function<bool()> MidiTimeoutCallback;
1628 typedef std::list<MidiTimeoutCallback> MidiTimeoutList;
1630 MidiTimeoutList midi_timeouts;
1631 bool mmc_step_timeout ();
1632 void send_immediate_mmc (MIDI::MachineControlCommand);
1634 MIDI::byte mtc_msg[16];
1635 MIDI::byte mtc_timecode_bits; /* encoding of SMTPE type for MTC */
1636 MIDI::byte midi_msg[16];
1637 double outbound_mtc_timecode_frame;
1638 Timecode::Time transmitting_timecode_time;
1639 int next_quarter_frame_to_send;
1641 double _samples_per_timecode_frame; /* has to be floating point because of drop frame */
1642 framecnt_t _frames_per_hour;
1643 framecnt_t _timecode_frames_per_hour;
1645 /* cache the most-recently requested time conversions. This helps when we
1646 * have multiple clocks showing the same time (e.g. the transport frame) */
1647 bool last_timecode_valid;
1648 framepos_t last_timecode_when;
1649 Timecode::Time last_timecode;
1651 bool _send_timecode_update; ///< Flag to send a full frame (Timecode) MTC message this cycle
1653 int send_midi_time_code_for_cycle (framepos_t, framepos_t, pframes_t nframes);
1655 LTCEncoder* ltc_encoder;
1656 ltcsnd_sample_t* ltc_enc_buf;
1658 Timecode::TimecodeFormat ltc_enc_tcformat;
1659 int32_t ltc_buf_off;
1660 int32_t ltc_buf_len;
1663 int32_t ltc_enc_byte;
1664 framepos_t ltc_enc_pos;
1666 framepos_t ltc_enc_off;
1668 framepos_t ltc_prev_cycle;
1670 framepos_t ltc_timecode_offset;
1671 bool ltc_timecode_negative_offset;
1673 LatencyRange ltc_out_latency;
1675 void ltc_tx_initialize();
1676 void ltc_tx_cleanup();
1677 void ltc_tx_reset();
1678 void ltc_tx_resync_latency();
1679 void ltc_tx_recalculate_position();
1680 void ltc_tx_parse_offset();
1681 void ltc_tx_send_time_code_for_cycle (framepos_t, framepos_t, double, double, pframes_t nframes);
1682 PBD::ScopedConnectionList ltc_tx_connections;
1685 void reset_record_status ();
1687 int no_roll (pframes_t nframes);
1688 int fail_roll (pframes_t nframes);
1690 bool non_realtime_work_pending() const { return static_cast<bool>(post_transport_work()); }
1691 bool process_can_proceed() const { return !(post_transport_work() & ProcessCannotProceedMask); }
1693 MidiControlUI* midi_control_ui;
1695 int start_midi_thread ();
1697 void set_play_loop (bool yn, double speed);
1698 void unset_play_loop ();
1699 void overwrite_some_buffers (Track *);
1700 void flush_all_inserts ();
1701 int micro_locate (framecnt_t distance);
1702 void locate (framepos_t, bool with_roll, bool with_flush, bool with_loop=false, bool force=false, bool with_mmc=true);
1703 void start_locate (framepos_t, bool with_roll, bool with_flush, bool for_loop_enabled=false, bool force=false);
1704 void force_locate (framepos_t frame, bool with_roll = false);
1705 void set_track_speed (Track *, double speed);
1706 void set_transport_speed (double speed, framepos_t destination_frame, bool abort = false, bool clear_state = false, bool as_default = false);
1707 void stop_transport (bool abort = false, bool clear_state = false);
1708 void start_transport ();
1709 void realtime_stop (bool abort, bool clear_state);
1710 void realtime_locate ();
1711 void non_realtime_start_scrub ();
1712 void non_realtime_set_speed ();
1713 void non_realtime_locate ();
1714 void non_realtime_stop (bool abort, int entry_request_count, bool& finished);
1715 void non_realtime_overwrite (int entry_request_count, bool& finished);
1716 void post_transport ();
1717 void engine_halted ();
1718 void xrun_recovery ();
1719 void set_track_loop (bool);
1720 bool select_playhead_priority_target (framepos_t&);
1721 void follow_playhead_priority ();
1723 /* These are synchronous and so can only be called from within the process
1727 int send_full_time_code (framepos_t, pframes_t nframes);
1728 void send_song_position_pointer (framepos_t);
1730 TempoMap *_tempo_map;
1731 void tempo_map_changed (const PBD::PropertyChange&);
1733 /* edit/mix groups */
1735 int load_route_groups (const XMLNode&, int);
1737 std::list<RouteGroup *> _route_groups;
1738 RouteGroup* _all_route_group;
1742 boost::shared_ptr<Graph> _process_graph;
1744 SerializedRCUManager<RouteList> routes;
1746 void add_routes (RouteList&, bool input_auto_connect, bool output_auto_connect, bool save, PresentationInfo::order_t);
1747 void add_routes_inner (RouteList&, bool input_auto_connect, bool output_auto_connect, PresentationInfo::order_t);
1748 bool _adding_routes_in_progress;
1749 bool _reconnecting_routes_in_progress;
1750 bool _route_deletion_in_progress;
1752 uint32_t destructive_index;
1754 boost::shared_ptr<Route> XMLRouteFactory (const XMLNode&, int);
1755 boost::shared_ptr<Route> XMLRouteFactory_2X (const XMLNode&, int);
1757 void route_processors_changed (RouteProcessorChange);
1759 bool find_route_name (std::string const &, uint32_t& id, std::string& name, bool);
1760 void count_existing_track_channels (ChanCount& in, ChanCount& out);
1761 void auto_connect_route (boost::shared_ptr<Route>, bool, const ChanCount&, const ChanCount&, const ChanCount& io = ChanCount(), const ChanCount& oo = ChanCount());
1762 void midi_output_change_handler (IOChange change, void* /*src*/, boost::weak_ptr<Route> midi_track);
1764 /* track numbering */
1766 void reassign_track_numbers ();
1767 uint32_t _track_number_decimals;
1769 /* solo/mute/notifications */
1771 void route_listen_changed (PBD::Controllable::GroupControlDisposition, boost::weak_ptr<Route>);
1772 void route_mute_changed ();
1773 void route_solo_changed (bool self_solo_change, PBD::Controllable::GroupControlDisposition group_override, boost::weak_ptr<Route>);
1774 void route_solo_isolated_changed (boost::weak_ptr<Route>);
1776 void update_route_solo_state (boost::shared_ptr<RouteList> r = boost::shared_ptr<RouteList>());
1778 void listen_position_changed ();
1779 void solo_control_mode_changed ();
1781 /* REGION MANAGEMENT */
1783 mutable Glib::Threads::Mutex region_lock;
1785 int load_regions (const XMLNode& node);
1786 int load_compounds (const XMLNode& node);
1788 void route_added_to_route_group (RouteGroup *, boost::weak_ptr<Route>);
1789 void route_removed_from_route_group (RouteGroup *, boost::weak_ptr<Route>);
1790 void route_group_property_changed (RouteGroup *);
1794 mutable Glib::Threads::Mutex source_lock;
1797 typedef std::map<PBD::ID,boost::shared_ptr<Source> > SourceMap;
1800 void reset_write_sources (bool mark_write_complete, bool force = false);
1805 int load_sources (const XMLNode& node);
1806 XMLNode& get_sources_as_xml ();
1808 boost::shared_ptr<Source> XMLSourceFactory (const XMLNode&);
1812 void remove_playlist (boost::weak_ptr<Playlist>);
1813 void track_playlist_changed (boost::weak_ptr<Track>);
1814 void playlist_region_added (boost::weak_ptr<Region>);
1815 void playlist_ranges_moved (std::list<Evoral::RangeMove<framepos_t> > const &);
1816 void playlist_regions_extended (std::list<Evoral::Range<framepos_t> > const &);
1818 /* CURVES and AUTOMATION LISTS */
1819 std::map<PBD::ID, AutomationList*> automation_lists;
1821 /* DEFAULT FADE CURVES */
1823 float default_fade_steepness;
1824 float default_fade_msecs;
1828 boost::shared_ptr<Auditioner> auditioner;
1829 void set_audition (boost::shared_ptr<Region>);
1830 void non_realtime_set_audition ();
1831 boost::shared_ptr<Region> pending_audition_region;
1837 int flatten_one_track (AudioTrack&, framepos_t start, framecnt_t cnt);
1839 /* INSERT AND SEND MANAGEMENT */
1841 boost::dynamic_bitset<uint32_t> send_bitset;
1842 boost::dynamic_bitset<uint32_t> aux_send_bitset;
1843 boost::dynamic_bitset<uint32_t> return_bitset;
1844 boost::dynamic_bitset<uint32_t> insert_bitset;
1848 struct space_and_path {
1849 uint32_t blocks; ///< 4kB blocks
1850 bool blocks_unknown; ///< true if blocks is unknown
1855 , blocks_unknown (true)
1859 struct space_and_path_ascending_cmp {
1860 bool operator() (space_and_path a, space_and_path b) {
1861 if (a.blocks_unknown != b.blocks_unknown) {
1862 return !a.blocks_unknown;
1864 return a.blocks > b.blocks;
1868 void setup_raid_path (std::string path);
1870 std::vector<space_and_path> session_dirs;
1871 std::vector<space_and_path>::iterator last_rr_session_dir;
1872 uint32_t _total_free_4k_blocks;
1873 /** If this is true, _total_free_4k_blocks is not definite,
1874 as one or more of the session directories' filesystems
1875 could not report free space.
1877 bool _total_free_4k_blocks_uncertain;
1878 Glib::Threads::Mutex space_lock;
1880 bool no_questions_about_missing_files;
1882 std::string get_best_session_directory_for_new_audio ();
1884 mutable gint _playback_load;
1885 mutable gint _capture_load;
1889 SerializedRCUManager<BundleList> _bundles;
1890 XMLNode* _bundle_xml_node;
1891 int load_bundles (XMLNode const &);
1893 UndoHistory _history;
1894 /** current undo transaction, or 0 */
1895 UndoTransaction* _current_trans;
1896 /** GQuarks to describe the reversible commands that are currently in progress.
1897 * These may be nested, in which case more recently-started commands are toward
1898 * the front of the list.
1900 std::list<GQuark> _current_trans_quarks;
1902 int backend_sync_callback (TransportState, framepos_t);
1904 void process_rtop (SessionEvent*);
1906 void update_latency (bool playback);
1914 XMLNode& state(bool, snapshot_t snapshot_type = NormalSave);
1917 typedef std::list<Click*> Clicks;
1920 bool _click_rec_only;
1921 boost::shared_ptr<IO> _click_io;
1922 boost::shared_ptr<Amp> _click_gain;
1924 Sample* click_emphasis_data;
1925 framecnt_t click_length;
1926 framecnt_t click_emphasis_length;
1927 mutable Glib::Threads::RWLock click_lock;
1929 static const Sample default_click[];
1930 static const framecnt_t default_click_length;
1931 static const Sample default_click_emphasis[];
1932 static const framecnt_t default_click_emphasis_length;
1935 framepos_t _clicks_cleared;
1936 void setup_click_sounds (int which);
1937 void setup_click_sounds (Sample**, Sample const *, framecnt_t*, framecnt_t, std::string const &);
1938 void clear_clicks ();
1939 void click (framepos_t start, framecnt_t nframes);
1940 void run_click (framepos_t start, framecnt_t nframes);
1941 void add_click (framepos_t pos, bool emphasis);
1942 framecnt_t _count_in_samples;
1944 /* range playback */
1946 std::list<AudioRange> current_audio_range;
1948 void set_play_range (std::list<AudioRange>&, bool leave_rolling);
1949 void unset_play_range ();
1951 /* temporary hacks to allow selection to be pushed from GUI into backend
1952 Whenever we move the selection object into libardour, these will go away.
1954 Evoral::Range<framepos_t> _range_selection;
1955 Evoral::Range<framepos_t> _object_selection;
1957 void unset_preroll_record_punch ();
1958 void unset_preroll_record_trim ();
1960 framepos_t _preroll_record_punch_pos;
1961 framecnt_t _preroll_record_trim_len;
1962 bool _count_in_once;
1967 boost::shared_ptr<Route> _master_out;
1968 boost::shared_ptr<Route> _monitor_out;
1970 void auto_connect_master_bus ();
1972 int find_all_sources (std::string path, std::set<std::string>& result);
1973 int find_all_sources_across_snapshots (std::set<std::string>& result, bool exclude_this_snapshot);
1975 typedef std::set<boost::shared_ptr<PBD::Controllable> > Controllables;
1976 Glib::Threads::Mutex controllables_lock;
1977 Controllables controllables;
1979 boost::shared_ptr<PBD::Controllable> _solo_cut_control;
1981 void reset_native_file_format();
1982 bool first_file_data_format_reset;
1983 bool first_file_header_format_reset;
1985 void config_changed (std::string, bool);
1987 XMLNode& get_control_protocol_state ();
1989 void set_history_depth (uint32_t depth);
1991 static bool _disable_all_loaded_plugins;
1992 static bool _bypass_all_loaded_plugins;
1994 mutable bool have_looped; ///< Used in ::audible_frame(*)
1996 void update_route_record_state ();
1997 gint _have_rec_enabled_track;
1998 gint _have_rec_disabled_track;
2000 static int ask_about_playlist_deletion (boost::shared_ptr<Playlist>);
2002 /* realtime "apply to set of routes" operations */
2003 template<typename T> SessionEvent*
2004 get_rt_event (boost::shared_ptr<RouteList> rl, T targ, SessionEvent::RTeventCallback after, PBD::Controllable::GroupControlDisposition group_override,
2005 void (Session::*method) (boost::shared_ptr<RouteList>, T, PBD::Controllable::GroupControlDisposition)) {
2006 SessionEvent* ev = new SessionEvent (SessionEvent::RealTimeOperation, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
2007 ev->rt_slot = boost::bind (method, this, rl, targ, group_override);
2008 ev->rt_return = after;
2009 ev->event_loop = PBD::EventLoop::get_event_loop_for_thread ();
2014 /* specialized version realtime "apply to set of routes" operations */
2015 template<typename T1, typename T2> SessionEvent*
2016 get_rt_event (boost::shared_ptr<RouteList> rl, T1 t1arg, T2 t2arg, SessionEvent::RTeventCallback after, PBD::Controllable::GroupControlDisposition group_override,
2017 void (Session::*method) (boost::shared_ptr<RouteList>, T1, T2, PBD::Controllable::GroupControlDisposition)) {
2018 SessionEvent* ev = new SessionEvent (SessionEvent::RealTimeOperation, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
2019 ev->rt_slot = boost::bind (method, this, rl, t1arg, t2arg, group_override);
2020 ev->rt_return = after;
2021 ev->event_loop = PBD::EventLoop::get_event_loop_for_thread ();
2026 /* specialized version realtime "apply to set of controls" operations */
2027 SessionEvent* get_rt_event (boost::shared_ptr<ControlList> cl, double arg, PBD::Controllable::GroupControlDisposition group_override) {
2028 SessionEvent* ev = new SessionEvent (SessionEvent::RealTimeOperation, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
2029 ev->rt_slot = boost::bind (&Session::rt_set_controls, this, cl, arg, group_override);
2030 ev->rt_return = Session::rt_cleanup;
2031 ev->event_loop = PBD::EventLoop::get_event_loop_for_thread ();
2036 void rt_set_controls (boost::shared_ptr<ControlList>, double val, PBD::Controllable::GroupControlDisposition group_override);
2037 void rt_clear_all_solo_state (boost::shared_ptr<RouteList>, bool yn, PBD::Controllable::GroupControlDisposition group_override);
2039 /** temporary list of Diskstreams used only during load of 2.X sessions */
2040 std::list<boost::shared_ptr<Diskstream> > _diskstreams_2X;
2042 void set_session_range_location (framepos_t, framepos_t);
2044 void setup_midi_machine_control ();
2046 void step_edit_status_change (bool);
2047 uint32_t _step_editors;
2049 /** true if timecode transmission by the transport is suspended, otherwise false */
2050 mutable gint _suspend_timecode_transmission;
2052 void update_locations_after_tempo_map_change (const Locations::LocationList &);
2054 void start_time_changed (framepos_t);
2055 void end_time_changed (framepos_t);
2057 void set_track_monitor_input_status (bool);
2058 framepos_t compute_stop_limit () const;
2060 boost::shared_ptr<Speakers> _speakers;
2061 void load_nested_sources (const XMLNode& node);
2063 /** The directed graph of routes that is currently being used for audio processing
2064 and solo/mute computations.
2066 GraphEdges _current_route_graph;
2068 void ensure_route_presentation_info_gap (PresentationInfo::order_t, uint32_t gap_size);
2070 friend class ProcessorChangeBlocker;
2071 gint _ignore_route_processor_changes; /* atomic */
2073 MidiClockTicker* midi_clock;
2075 boost::shared_ptr<IO> _ltc_input;
2076 boost::shared_ptr<IO> _ltc_output;
2078 /* Scene Changing */
2079 SceneChanger* _scene_changer;
2081 /* persistent, non-track related MIDI ports */
2082 MidiPortManager* _midi_ports;
2083 MIDI::MachineControl* _mmc;
2086 void setup_click ();
2087 void setup_click_state (const XMLNode*);
2088 void setup_bundles ();
2090 void save_as_bring_callback (uint32_t, uint32_t, std::string);
2092 static const uint32_t session_end_shift;
2094 std::string _template_state_dir;
2096 VCAManager* _vca_manager;
2098 boost::shared_ptr<Route> get_midi_nth_route_by_id (PresentationInfo::order_t n) const;
2100 std::string created_with;
2102 void midi_track_presentation_info_changed (PBD::PropertyChange const &, boost::weak_ptr<MidiTrack>);
2103 void rewire_selected_midi (boost::shared_ptr<MidiTrack>);
2104 void rewire_midi_selection_ports ();
2105 boost::weak_ptr<MidiTrack> current_midi_target;
2107 CoreSelection* _selection;
2111 } // namespace ARDOUR
2113 #endif /* __ardour_session_h__ */