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;
145 class SessionDirectory;
146 class SessionMetadata;
147 class SessionPlaylists;
154 class WindowsVSTPlugin;
156 extern void setup_enum_writer ();
158 class LIBARDOUR_API SessionException: public std::exception {
160 explicit SessionException(const std::string msg) : _message(msg) {}
161 virtual ~SessionException() throw() {}
163 virtual const char* what() const throw() { return _message.c_str(); }
166 std::string _message;
169 /** Ardour Session */
170 class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::ScopedConnectionList, public SessionEventManager
179 /* a new session might have non-empty mix_template, an existing session should always have an empty one.
180 the bus profile can be null if no master out bus is required.
183 Session (AudioEngine&,
184 const std::string& fullpath,
185 const std::string& snapshot_name,
186 BusProfile* bus_profile = 0,
187 std::string mix_template = "");
191 static int get_info_from_path (const std::string& xmlpath, float& sample_rate, SampleFormat& data_format);
192 static std::string get_snapshot_from_instant (const std::string& session_dir);
194 /** a monotonic counter used for naming user-visible things uniquely
195 * (curently the sidechain port).
196 * Use sparingly to keep the numbers low, prefer PBD::ID for all
197 * internal, not user-visible IDs */
198 static unsigned int next_name_id ();
200 std::string path() const { return _path; }
201 std::string name() const { return _name; }
202 std::string snap_name() const { return _current_snapshot_name; }
203 std::string raid_path () const;
204 bool path_is_within_session (const std::string&);
206 bool writable() const { return _writable; }
209 bool dirty() const { return _state_of_the_state & Dirty; }
210 void set_deletion_in_progress ();
211 void clear_deletion_in_progress ();
212 bool reconnection_in_progress() const { return _reconnecting_routes_in_progress; }
213 bool deletion_in_progress() const { return _state_of_the_state & Deletion; }
214 bool routes_deletion_in_progress() const { return _route_deletion_in_progress; }
215 bool peaks_cleanup_in_progres() const { return _state_of_the_state & PeakCleanup; }
216 bool loading () const { return _state_of_the_state & Loading; }
218 PBD::Signal0<void> DirtyChanged;
220 const SessionDirectory& session_directory () const { return *(_session_dir.get()); }
222 static PBD::Signal1<void,std::string> Dialog;
224 PBD::Signal0<void> BatchUpdateStart;
225 PBD::Signal0<void> BatchUpdateEnd;
227 int ensure_subdirs ();
229 std::string automation_dir () const; ///< Automation data
230 std::string analysis_dir () const; ///< Analysis data
231 std::string plugins_dir () const; ///< Plugin state
232 std::string externals_dir () const; ///< Links to external files
234 std::string construct_peak_filepath (const std::string& audio_path, const bool in_session = false, const bool old_peak_name = false) const;
236 bool audio_source_name_is_unique (const std::string& name);
237 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);
238 std::string new_audio_source_path_for_embedded (const std::string& existing_path);
239 std::string new_audio_source_path (const std::string&, uint32_t nchans, uint32_t chan, bool destructive, bool take_required);
240 std::string new_midi_source_path (const std::string&);
241 /** create a new track or bus from a template (XML path)
242 * @param how_many how many tracks or busses to create
243 * @param template_path path to xml template file
244 * @param name name (prefix) of the route to create
245 * @param pd Playlist disposition
246 * @return list of newly created routes
248 RouteList new_route_from_template (uint32_t how_many, const std::string& template_path, const std::string& name, PlaylistDisposition pd = NewPlaylist);
249 RouteList new_route_from_template (uint32_t how_many, XMLNode&, const std::string& name, PlaylistDisposition pd = NewPlaylist);
250 std::vector<std::string> get_paths_for_new_sources (bool allow_replacing, const std::string& import_file_path, uint32_t channels);
252 int bring_all_sources_into_session (boost::function<void(uint32_t,uint32_t,std::string)> callback);
254 void process (pframes_t nframes);
256 BufferSet& get_silent_buffers (ChanCount count = ChanCount::ZERO);
257 BufferSet& get_noinplace_buffers (ChanCount count = ChanCount::ZERO);
258 BufferSet& get_scratch_buffers (ChanCount count = ChanCount::ZERO, bool silence = true);
259 BufferSet& get_route_buffers (ChanCount count = ChanCount::ZERO, bool silence = true);
260 BufferSet& get_mix_buffers (ChanCount count = ChanCount::ZERO);
262 bool have_rec_enabled_track () const;
263 bool have_rec_disabled_track () const;
265 bool have_captured() const { return _have_captured; }
267 void refill_all_track_buffers ();
268 Butler* butler() { return _butler; }
269 void butler_transport_work ();
271 void refresh_disk_space ();
273 int load_diskstreams_2X (XMLNode const &, int);
275 int load_routes (const XMLNode&, int);
276 boost::shared_ptr<RouteList> get_routes() const {
277 return routes.reader ();
280 /* because the set of Stripables consists of objects managed
281 * independently, in multiple containers within the Session (or objects
282 * owned by the session), we fill out a list in-place rather than
283 * return a pointer to a copy of the (RCU) managed list, as happens
287 void get_stripables (StripableList&) const;
288 boost::shared_ptr<RouteList> get_tracks() const;
289 boost::shared_ptr<RouteList> get_routes_with_internal_returns() const;
290 boost::shared_ptr<RouteList> get_routes_with_regions_at (framepos_t const) const;
292 uint32_t nroutes() const { return routes.reader()->size(); }
293 uint32_t ntracks () const;
294 uint32_t nbusses () const;
296 boost::shared_ptr<BundleList> bundles () {
297 return _bundles.reader ();
300 struct LIBARDOUR_API RoutePublicOrderSorter {
301 bool operator() (boost::shared_ptr<Route>, boost::shared_ptr<Route> b);
304 void notify_presentation_info_change ();
306 template<class T> void foreach_route (T *obj, void (T::*func)(Route&), bool sort = true);
307 template<class T> void foreach_route (T *obj, void (T::*func)(boost::shared_ptr<Route>), bool sort = true);
308 template<class T, class A> void foreach_route (T *obj, void (T::*func)(Route&, A), A arg, bool sort = true);
310 static char session_name_is_legal (const std::string&);
311 bool io_name_is_legal (const std::string&) const;
312 boost::shared_ptr<Route> route_by_name (std::string) const;
313 boost::shared_ptr<Route> route_by_id (PBD::ID) const;
314 boost::shared_ptr<Stripable> get_nth_stripable (PresentationInfo::order_t n) const;
315 boost::shared_ptr<Stripable> get_remote_nth_stripable (PresentationInfo::order_t n, PresentationInfo::Flag) const;
316 boost::shared_ptr<Route> get_remote_nth_route (PresentationInfo::order_t n) const;
317 boost::shared_ptr<Route> route_by_selected_count (uint32_t cnt) const;
318 boost::shared_ptr<Track> track_by_diskstream_id (PBD::ID) const;
319 void routes_using_input_from (const std::string& str, RouteList& rl);
321 bool route_name_unique (std::string) const;
322 bool route_name_internal (std::string) const;
324 uint32_t track_number_decimals () const {
325 return _track_number_decimals;
328 bool get_record_enabled() const {
329 return (record_status () >= Enabled);
332 RecordState record_status() const {
333 return (RecordState) g_atomic_int_get (&_record_status);
336 bool actively_recording () const {
337 return record_status() == Recording;
340 bool record_enabling_legal () const;
341 void maybe_enable_record ();
342 void disable_record (bool rt_context, bool force = false);
343 void step_back_from_record ();
345 void set_all_tracks_record_enabled(bool);
347 void maybe_write_autosave ();
349 /* Emitted when all i/o connections are complete */
351 PBD::Signal0<void> IOConnectionsComplete;
353 /* Timecode status signals */
354 PBD::Signal1<void, bool> MTCSyncStateChanged;
355 PBD::Signal1<void, bool> LTCSyncStateChanged;
357 /* Record status signals */
359 PBD::Signal0<void> RecordStateChanged; /* signals changes in recording state (i.e. are we recording) */
360 /* XXX may 2015: paul says: it isn't clear to me that this has semantics that cannot be inferrred
361 from the previous signal and session state.
363 PBD::Signal0<void> RecordArmStateChanged; /* signals changes in recording arming */
365 /* Emited when session is loaded */
366 PBD::Signal0<void> SessionLoaded;
368 /* Transport mechanism signals */
370 /** Emitted on the following changes in transport state:
371 * - stop (from the butler thread)
372 * - change in whether or not we are looping (from the process thread)
373 * - change in the play range (from the process thread)
374 * - start (from the process thread)
377 PBD::Signal0<void> TransportStateChange;
379 PBD::Signal1<void,framepos_t> PositionChanged; /* sent after any non-sequential motion */
380 PBD::Signal1<void,framepos_t> Xrun;
381 PBD::Signal0<void> TransportLooped;
383 /** emitted when a locate has occurred */
384 PBD::Signal0<void> Located;
386 PBD::Signal1<void,RouteList&> RouteAdded;
387 /** Emitted when a property of one of our route groups changes.
388 * The parameter is the RouteGroup that has changed.
390 PBD::Signal1<void, RouteGroup *> RouteGroupPropertyChanged;
391 /** Emitted when a route is added to one of our route groups.
392 * First parameter is the RouteGroup, second is the route.
394 PBD::Signal2<void, RouteGroup *, boost::weak_ptr<Route> > RouteAddedToRouteGroup;
395 /** Emitted when a route is removed from one of our route groups.
396 * First parameter is the RouteGroup, second is the route.
398 PBD::Signal2<void, RouteGroup *, boost::weak_ptr<Route> > RouteRemovedFromRouteGroup;
400 /* Step Editing status changed */
401 PBD::Signal1<void,bool> StepEditStatusChange;
403 /* Timecode state signals */
404 PBD::Signal0<void> MtcOrLtcInputPortChanged;
406 void queue_event (SessionEvent*);
408 void request_roll_at_and_return (framepos_t start, framepos_t return_to);
409 void request_bounded_roll (framepos_t start, framepos_t end);
410 void request_stop (bool abort = false, bool clear_state = false);
411 void request_locate (framepos_t frame, bool with_roll = false);
413 void request_play_loop (bool yn, bool leave_rolling = false);
414 bool get_play_loop () const { return play_loop; }
416 framepos_t last_transport_start () const { return _last_roll_location; }
419 void use_rf_shuttle_speed ();
420 void allow_auto_play (bool yn);
421 void request_transport_speed (double speed, bool as_default = true);
422 void request_transport_speed_nonzero (double, bool as_default = true);
423 void request_overwrite_buffer (Track *);
424 void adjust_playback_buffering();
425 void adjust_capture_buffering();
426 void request_track_speed (Track *, double speed);
427 void request_input_change_handling ();
429 bool locate_pending() const { return static_cast<bool>(post_transport_work()&PostTransportLocate); }
430 bool transport_locked () const;
434 framepos_t current_end_frame () const;
435 framepos_t current_start_frame () const;
436 /** "actual" sample rate of session, set by current audioengine rate, pullup/down etc. */
437 framecnt_t frame_rate () const { return _current_frame_rate; }
438 /** "native" sample rate of session, regardless of current audioengine rate, pullup/down etc */
439 framecnt_t nominal_frame_rate () const { return _nominal_frame_rate; }
440 framecnt_t frames_per_hour () const { return _frames_per_hour; }
442 double frames_per_timecode_frame() const { return _frames_per_timecode_frame; }
443 framecnt_t timecode_frames_per_hour() const { return _timecode_frames_per_hour; }
445 MIDI::byte get_mtc_timecode_bits() const {
446 return mtc_timecode_bits; /* encoding of SMTPE type for MTC */
449 double timecode_frames_per_second() const;
450 bool timecode_drop_frames() const;
454 Locations *locations() { return _locations; }
456 PBD::Signal1<void,Location*> auto_loop_location_changed;
457 PBD::Signal1<void,Location*> auto_punch_location_changed;
458 PBD::Signal0<void> locations_modified;
460 void set_auto_punch_location (Location *);
461 void set_auto_loop_location (Location *);
462 void set_session_extents (framepos_t start, framepos_t end);
463 int location_name(std::string& result, std::string base = std::string(""));
465 pframes_t get_block_size() const { return current_block_size; }
466 framecnt_t worst_output_latency () const { return _worst_output_latency; }
467 framecnt_t worst_input_latency () const { return _worst_input_latency; }
468 framecnt_t worst_track_latency () const { return _worst_track_latency; }
469 framecnt_t worst_playback_latency () const { return _worst_output_latency + _worst_track_latency; }
472 std::string new_parent_folder; /* parent folder where new session folder will be created */
473 std::string new_name; /* name of newly saved session */
474 bool switch_to; /* true if we should be working on newly saved session after save-as; false otherwise */
475 bool include_media; /* true if the newly saved session should contain references to media */
476 bool copy_media; /* true if media files (audio, media, etc) should be copied into newly saved session; false otherwise */
477 bool copy_external; /* true if external media should be consolidated into the newly saved session; false otherwise */
479 std::string final_session_folder_name; /* filled in by * Session::save_as(), provides full path to newly saved session */
481 /* emitted as we make progress. 3 arguments passed to signal
484 * 1: percentage complete measured as a fraction (0-1.0) of
485 * total data copying done.
486 * 2: number of files copied so far
487 * 3: total number of files to copy
489 * Handler should return true for save-as to continue, or false
490 * to stop (and remove all evidence of partial save-as).
492 PBD::Signal3<bool,float,int64_t,int64_t> Progress;
494 /* if save_as() returns non-zero, this string will indicate the reason why.
496 std::string failure_message;
499 int save_as (SaveAs&);
501 * @param snapshot_name name of the session (use an empty string for the current name)
502 * @param pending save a 'recovery', not full state (default: false)
503 * @param switch_to_snapshot switch to given snapshot after saving (default: false)
504 * @param template_only save a session template (default: false)
505 * @return zero on success
507 int save_state (std::string snapshot_name, bool pending = false, bool switch_to_snapshot = false, bool template_only = false);
508 int restore_state (std::string snapshot_name);
509 int save_template (std::string template_name, bool replace_existing = false);
510 int save_history (std::string snapshot_name = "");
511 int restore_history (std::string snapshot_name);
512 void remove_state (std::string snapshot_name);
513 void rename_state (std::string old_name, std::string new_name);
514 void remove_pending_capture_state ();
515 int rename (const std::string&);
516 bool get_nsm_state () const { return _under_nsm_control; }
517 void set_nsm_state (bool state) { _under_nsm_control = state; }
518 bool save_default_options ();
520 PBD::Signal1<void,std::string> StateSaved;
521 PBD::Signal0<void> StateReady;
523 /* emitted when session needs to be saved due to some internal
524 * event or condition (i.e. not in response to a user request).
526 * Only one object should
527 * connect to this signal and take responsibility.
529 * Argument is the snapshot name to use when saving.
531 PBD::Signal1<void,std::string> SaveSessionRequested;
533 /* emitted during a session save to allow other entities to add state, via
534 * extra XML, to the session state
536 PBD::Signal0<void> SessionSaveUnderway;
538 std::vector<std::string> possible_states() const;
539 static std::vector<std::string> possible_states (std::string path);
541 XMLNode& get_state();
542 int set_state(const XMLNode& node, int version); // not idempotent
543 XMLNode& get_template();
545 /// The instant xml file is written to the session directory
546 void add_instant_xml (XMLNode&, bool write_to_config = true);
547 XMLNode* instant_xml (const std::string& str);
549 enum StateOfTheState {
554 InitialConnecting = 0x8,
560 StateOfTheState state_of_the_state() const { return _state_of_the_state; }
562 class StateProtector {
564 StateProtector (Session* s) : _session (s) {
565 g_atomic_int_inc (&s->_suspend_save);
568 if (g_atomic_int_dec_and_test (&_session->_suspend_save)) {
569 while (_session->_save_queued) {
570 _session->_save_queued = false;
571 _session->save_state ("");
579 void add_route_group (RouteGroup *);
580 void remove_route_group (RouteGroup&);
581 void reorder_route_groups (std::list<RouteGroup*>);
583 RouteGroup* route_group_by_name (std::string);
584 RouteGroup& all_route_group() const;
586 PBD::Signal1<void,RouteGroup*> route_group_added;
587 PBD::Signal0<void> route_group_removed;
588 PBD::Signal0<void> route_groups_reordered;
590 void foreach_route_group (boost::function<void(RouteGroup*)> f) {
591 for (std::list<RouteGroup *>::iterator i = _route_groups.begin(); i != _route_groups.end(); ++i) {
596 std::list<RouteGroup*> const & route_groups () const {
597 return _route_groups;
600 /* fundamental operations. duh. */
602 std::list<boost::shared_ptr<AudioTrack> > new_audio_track (
605 RouteGroup* route_group,
607 std::string name_template,
608 PresentationInfo::order_t order,
609 TrackMode mode = Normal
612 std::list<boost::shared_ptr<MidiTrack> > new_midi_track (
613 const ChanCount& input, const ChanCount& output,
614 boost::shared_ptr<PluginInfo> instrument,
615 Plugin::PresetRecord* pset,
616 RouteGroup* route_group, uint32_t how_many, std::string name_template,
617 PresentationInfo::order_t,
618 TrackMode mode = Normal
621 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);
622 RouteList new_midi_route (RouteGroup* route_group, uint32_t how_many, std::string name_template, boost::shared_ptr<PluginInfo> instrument, Plugin::PresetRecord*, PresentationInfo::Flag, PresentationInfo::order_t);
624 void remove_routes (boost::shared_ptr<RouteList>);
625 void remove_route (boost::shared_ptr<Route>);
627 void resort_routes ();
628 void resort_routes_using (boost::shared_ptr<RouteList>);
630 AudioEngine & engine() { return _engine; }
631 AudioEngine const & engine () const { return _engine; }
633 static std::string default_track_name_pattern (DataType);
637 framepos_t transport_frame () const {return _transport_frame; }
638 framepos_t record_location () const {return _last_record_location; }
639 framepos_t audible_frame () const;
640 framepos_t requested_return_frame() const { return _requested_return_frame; }
641 void set_requested_return_frame(framepos_t return_to);
655 void sync_time_vars();
657 void bbt_time (framepos_t when, Timecode::BBT_Time&);
658 void timecode_to_sample(Timecode::Time& timecode, framepos_t& sample, bool use_offset, bool use_subframes) const;
659 void sample_to_timecode(framepos_t sample, Timecode::Time& timecode, bool use_offset, bool use_subframes) const;
660 void timecode_time (Timecode::Time &);
661 void timecode_time (framepos_t when, Timecode::Time&);
662 void timecode_time_subframes (framepos_t when, Timecode::Time&);
664 void timecode_duration (framecnt_t, Timecode::Time&) const;
665 void timecode_duration_string (char *, size_t len, framecnt_t) const;
667 framecnt_t convert_to_frames (AnyTime const & position);
668 framecnt_t any_duration_to_frames (framepos_t position, AnyTime const & duration);
670 static PBD::Signal1<void, framepos_t> StartTimeChanged;
671 static PBD::Signal1<void, framepos_t> EndTimeChanged;
673 void request_sync_source (Slave*);
674 bool synced_to_engine() const { return _slave && config.get_external_sync() && Config->get_sync_source() == Engine; }
675 bool synced_to_mtc () const { return config.get_external_sync() && Config->get_sync_source() == MTC && g_atomic_int_get (const_cast<gint*>(&_mtc_active)); }
676 bool synced_to_ltc () const { return config.get_external_sync() && Config->get_sync_source() == LTC && g_atomic_int_get (const_cast<gint*>(&_ltc_active)); }
678 double transport_speed() const { return _transport_speed; }
679 bool transport_stopped() const { return _transport_speed == 0.0f; }
680 bool transport_rolling() const { return _transport_speed != 0.0f; }
682 bool silent () { return _silent; }
684 TempoMap& tempo_map() { return *_tempo_map; }
685 const TempoMap& tempo_map() const { return *_tempo_map; }
687 unsigned int get_xrun_count () const {return _xrun_count; }
688 void reset_xrun_count () {_xrun_count = 0; }
692 boost::shared_ptr<Region> find_whole_file_parent (boost::shared_ptr<Region const>) const;
694 boost::shared_ptr<Region> XMLRegionFactory (const XMLNode&, bool full);
695 boost::shared_ptr<AudioRegion> XMLAudioRegionFactory (const XMLNode&, bool full);
696 boost::shared_ptr<MidiRegion> XMLMidiRegionFactory (const XMLNode&, bool full);
698 /* source management */
700 void import_files (ImportStatus&);
701 bool sample_rate_convert (ImportStatus&, std::string infile, std::string& outfile);
702 std::string build_tmp_convert_name (std::string file);
704 boost::shared_ptr<ExportHandler> get_export_handler ();
705 boost::shared_ptr<ExportStatus> get_export_status ();
707 int start_audio_export (framepos_t position);
709 PBD::Signal1<int, framecnt_t> ProcessExport;
710 static PBD::Signal2<void,std::string, std::string> Exported;
712 void add_source (boost::shared_ptr<Source>);
713 void remove_source (boost::weak_ptr<Source>);
715 void cleanup_regions();
716 bool can_cleanup_peakfiles () const;
717 int cleanup_peakfiles ();
718 int cleanup_sources (CleanupReport&);
719 int cleanup_trash_sources (CleanupReport&);
721 int destroy_sources (std::list<boost::shared_ptr<Source> >);
723 int remove_last_capture ();
725 /** handlers should return 0 for "everything OK", and any other value for
726 * "cannot setup audioengine".
728 static PBD::Signal1<int,uint32_t> AudioEngineSetupRequired;
730 /** handlers should return -1 for "stop cleanup",
731 0 for "yes, delete this playlist",
732 1 for "no, don't delete this playlist".
734 static PBD::Signal1<int,boost::shared_ptr<Playlist> > AskAboutPlaylistDeletion;
736 /** handlers should return 0 for "ignore the rate mismatch",
737 !0 for "do not use this session"
739 static PBD::Signal2<int, framecnt_t, framecnt_t> AskAboutSampleRateMismatch;
741 /** non interactive message */
742 static PBD::Signal2<void, framecnt_t, framecnt_t> NotifyAboutSampleRateMismatch;
744 /** handlers should return !0 for use pending state, 0 for ignore it.
746 static PBD::Signal0<int> AskAboutPendingState;
748 boost::shared_ptr<AudioFileSource> create_audio_source_for_session (
749 size_t, std::string const &, uint32_t, bool destructive);
751 boost::shared_ptr<MidiSource> create_midi_source_for_session (std::string const &);
752 boost::shared_ptr<MidiSource> create_midi_source_by_stealing_name (boost::shared_ptr<Track>);
754 boost::shared_ptr<Source> source_by_id (const PBD::ID&);
755 boost::shared_ptr<AudioFileSource> audio_source_by_path_and_channel (const std::string&, uint16_t) const;
756 boost::shared_ptr<MidiSource> midi_source_by_path (const std::string&) const;
757 uint32_t count_sources_by_origin (const std::string&);
759 void add_playlist (boost::shared_ptr<Playlist>, bool unused = false);
761 /* Curves and AutomationLists (TODO when they go away) */
762 void add_automation_list(AutomationList*);
766 boost::shared_ptr<Auditioner> the_auditioner() { return auditioner; }
767 void audition_playlist ();
768 void audition_region (boost::shared_ptr<Region>);
769 void cancel_audition ();
770 bool is_auditioning () const;
772 PBD::Signal1<void,bool> AuditionActive;
775 void register_lua_function (const std::string&, const std::string&, const LuaScriptParamList&);
776 void unregister_lua_function (const std::string& name);
777 std::vector<std::string> registered_lua_functions ();
778 uint32_t registered_lua_function_count () const { return _n_lua_scripts; }
779 void scripts_changed (); // called from lua, updates _n_lua_scripts
781 /* flattening stuff */
783 boost::shared_ptr<Region> write_one_track (Track&, framepos_t start, framepos_t end,
784 bool overwrite, std::vector<boost::shared_ptr<Source> >&, InterThreadInfo& wot,
785 boost::shared_ptr<Processor> endpoint,
786 bool include_endpoint, bool for_export, bool for_freeze);
787 int freeze_all (InterThreadInfo&);
789 /* session-wide solo/mute/rec-enable */
791 bool soloing() const { return _non_soloed_outs_muted; }
792 bool listening() const { return _listen_cnt > 0; }
793 bool solo_isolated() const { return _solo_isolated_cnt > 0; }
795 static const SessionEvent::RTeventCallback rt_cleanup;
797 void clear_all_solo_state (boost::shared_ptr<RouteList>);
799 /* Control-based methods */
801 void set_controls (boost::shared_ptr<ControlList>, double val, PBD::Controllable::GroupControlDisposition);
802 void set_control (boost::shared_ptr<AutomationControl>, double val, PBD::Controllable::GroupControlDisposition);
804 void set_exclusive_input_active (boost::shared_ptr<RouteList> rt, bool onoff, bool flip_others = false);
806 PBD::Signal1<void,bool> SoloActive;
807 PBD::Signal0<void> SoloChanged;
808 PBD::Signal0<void> IsolatedChanged;
809 PBD::Signal0<void> MonitorChanged;
811 PBD::Signal0<void> session_routes_reconnected;
813 /* monitor/master out */
815 void add_monitor_section ();
816 void reset_monitor_section ();
817 void remove_monitor_section ();
818 bool monitor_active() const { return (_monitor_out && _monitor_out->monitor_control () && _monitor_out->monitor_control ()->monitor_active()); }
820 boost::shared_ptr<Route> monitor_out() const { return _monitor_out; }
821 boost::shared_ptr<Route> master_out() const { return _master_out; }
823 void globally_add_internal_sends (boost::shared_ptr<Route> dest, Placement p, bool);
824 void globally_set_send_gains_from_track (boost::shared_ptr<Route> dest);
825 void globally_set_send_gains_to_zero (boost::shared_ptr<Route> dest);
826 void globally_set_send_gains_to_unity (boost::shared_ptr<Route> dest);
827 void add_internal_sends (boost::shared_ptr<Route> dest, Placement p, boost::shared_ptr<RouteList> senders);
828 void add_internal_send (boost::shared_ptr<Route>, int, boost::shared_ptr<Route>);
829 void add_internal_send (boost::shared_ptr<Route>, boost::shared_ptr<Processor>, boost::shared_ptr<Route>);
831 static void set_disable_all_loaded_plugins (bool yn) {
832 _disable_all_loaded_plugins = yn;
834 static bool get_disable_all_loaded_plugins() {
835 return _disable_all_loaded_plugins;
837 static void set_bypass_all_loaded_plugins (bool yn) {
838 _bypass_all_loaded_plugins = yn;
840 static bool get_bypass_all_loaded_plugins() {
841 return _bypass_all_loaded_plugins;
844 uint32_t next_send_id();
845 uint32_t next_aux_send_id();
846 uint32_t next_return_id();
847 uint32_t next_insert_id();
848 void mark_send_id (uint32_t);
849 void mark_aux_send_id (uint32_t);
850 void mark_return_id (uint32_t);
851 void mark_insert_id (uint32_t);
852 void unmark_send_id (uint32_t);
853 void unmark_aux_send_id (uint32_t);
854 void unmark_return_id (uint32_t);
855 void unmark_insert_id (uint32_t);
857 /* s/w "RAID" management */
859 boost::optional<framecnt_t> available_capture_duration();
863 void add_bundle (boost::shared_ptr<Bundle>, bool emit_signal = true);
864 void remove_bundle (boost::shared_ptr<Bundle>);
865 boost::shared_ptr<Bundle> bundle_by_name (std::string) const;
867 PBD::Signal0<void> BundleAddedOrRemoved;
871 /* History (for editors, mixers, UIs etc.) */
873 /** Undo some transactions.
874 * @param n Number of transactions to undo.
876 void undo (uint32_t n) {
880 void redo (uint32_t n) {
884 UndoHistory& history() { return _history; }
886 uint32_t undo_depth() const { return _history.undo_depth(); }
887 uint32_t redo_depth() const { return _history.redo_depth(); }
888 std::string next_undo() const { return _history.next_undo(); }
889 std::string next_redo() const { return _history.next_redo(); }
891 /** begin collecting undo information
893 * This call must always be followed by either
894 * begin_reversible_command() or commit_reversible_command()
896 * @param cmd_name human readable name for the undo operation
898 void begin_reversible_command (const std::string& cmd_name);
899 void begin_reversible_command (GQuark);
900 /** abort an open undo command
901 * This must only be called after begin_reversible_command ()
903 void abort_reversible_command ();
904 /** finalize an undo command and commit pending transactions
906 * This must only be called after begin_reversible_command ()
907 * @param cmd (additional) command to add
909 void commit_reversible_command (Command* cmd = 0);
911 void add_command (Command *const cmd);
913 /** create an StatefulDiffCommand from the given object and add it to the stack.
915 * This function must only be called after begin_reversible_command.
916 * Failing to do so may lead to a crash.
918 * @param sfd the object to diff
919 * @returns the allocated StatefulDiffCommand (already added via add_command)
921 PBD::StatefulDiffCommand* add_stateful_diff_command (boost::shared_ptr<PBD::StatefulDestructible> sfd);
923 /** @return The list of operations that are currently in progress */
924 std::list<GQuark> const & current_operations () {
925 return _current_trans_quarks;
928 bool operation_in_progress (GQuark) const;
930 void add_commands (std::vector<Command*> const & cmds);
932 std::map<PBD::ID,PBD::StatefulDestructible*> registry;
934 // these commands are implemented in libs/ardour/session_command.cc
935 Command* memento_command_factory(XMLNode* n);
936 Command* stateful_diff_command_factory (XMLNode *);
937 void register_with_memento_command_factory(PBD::ID, PBD::StatefulDestructible*);
941 boost::shared_ptr<IO> click_io() { return _click_io; }
942 boost::shared_ptr<Amp> click_gain() { return _click_gain; }
944 /* disk, buffer loads */
946 uint32_t playback_load ();
947 uint32_t capture_load ();
951 void request_play_range (std::list<AudioRange>*, bool leave_rolling = false);
952 void request_cancel_play_range ();
953 bool get_play_range () const { return _play_range; }
955 void maybe_update_session_range (framepos_t, framepos_t);
957 /* temporary hacks to allow selection to be pushed from GUI into backend.
958 Whenever we move the selection object into libardour, these will go away.
960 void set_range_selection (framepos_t start, framepos_t end);
961 void set_object_selection (framepos_t start, framepos_t end);
962 void clear_range_selection ();
963 void clear_object_selection ();
965 /* buffers for gain and pan */
967 gain_t* gain_automation_buffer () const;
968 gain_t* trim_automation_buffer () const;
969 gain_t* send_gain_automation_buffer () const;
970 pan_t** pan_automation_buffer () const;
972 void ensure_buffer_set (BufferSet& buffers, const ChanCount& howmany);
976 static int vst_current_loading_id;
977 static const char* vst_can_do_strings[];
978 static const int vst_can_do_string_count;
980 static intptr_t vst_callback (
989 static PBD::Signal0<void> SendFeedback;
993 boost::shared_ptr<Speakers> get_speakers ();
997 boost::shared_ptr<Processor> processor_by_id (PBD::ID) const;
999 boost::shared_ptr<PBD::Controllable> controllable_by_id (const PBD::ID&);
1000 boost::shared_ptr<PBD::Controllable> controllable_by_descriptor (const ARDOUR::ControllableDescriptor&);
1002 void add_controllable (boost::shared_ptr<PBD::Controllable>);
1003 void remove_controllable (PBD::Controllable*);
1005 boost::shared_ptr<PBD::Controllable> solo_cut_control() const;
1007 SessionConfiguration config;
1009 bool exporting () const {
1013 bool bounce_processing() const {
1014 return _bounce_processing_active;
1017 /* this is a private enum, but setup_enum_writer() needs it,
1018 and i can't find a way to give that function
1019 friend access. sigh.
1022 enum PostTransportWork {
1023 PostTransportStop = 0x1,
1024 PostTransportDuration = 0x2,
1025 PostTransportLocate = 0x4,
1026 PostTransportRoll = 0x8,
1027 PostTransportAbort = 0x10,
1028 PostTransportOverWrite = 0x20,
1029 PostTransportSpeed = 0x40,
1030 PostTransportAudition = 0x80,
1031 PostTransportReverse = 0x100,
1032 PostTransportInputChange = 0x200,
1033 PostTransportCurveRealloc = 0x400,
1034 PostTransportClearSubstate = 0x800,
1035 PostTransportAdjustPlaybackBuffering = 0x1000,
1036 PostTransportAdjustCaptureBuffering = 0x2000
1045 SlaveState slave_state() const { return _slave_state; }
1046 Slave* slave() const { return _slave; }
1048 boost::shared_ptr<SessionPlaylists> playlists;
1050 void send_mmc_locate (framepos_t);
1051 void queue_full_time_code () { _send_timecode_update = true; }
1052 void queue_song_position_pointer () { /* currently does nothing */ }
1054 bool step_editing() const { return (_step_editors > 0); }
1056 void request_suspend_timecode_transmission ();
1057 void request_resume_timecode_transmission ();
1058 bool timecode_transmission_suspended () const;
1060 std::vector<std::string> source_search_path(DataType) const;
1061 void ensure_search_path_includes (const std::string& path, DataType type);
1062 void remove_dir_from_search_path (const std::string& path, DataType type);
1064 std::list<std::string> unknown_processors () const;
1066 /** Emitted when a feedback cycle has been detected within Ardour's signal
1067 processing path. Until it is fixed (by the user) some (unspecified)
1068 routes will not be run.
1070 static PBD::Signal0<void> FeedbackDetected;
1072 /** Emitted when a graph sort has successfully completed, which means
1073 that it has no feedback cycles.
1075 static PBD::Signal0<void> SuccessfulGraphSort;
1077 /* handlers can return an integer value:
1078 0: config.set_audio_search_path() or config.set_midi_search_path() was used
1079 to modify the search path and we should try to find it again.
1080 1: quit entire session load
1081 2: as 0, but don't ask about other missing files
1082 3: don't ask about other missing files, and just mark this one missing
1083 -1: just mark this one missing
1084 any other value: as -1
1086 static PBD::Signal3<int,Session*,std::string,DataType> MissingFile;
1088 /** Emitted when the session wants Ardour to quit */
1089 static PBD::Signal0<void> Quit;
1091 /** Emitted when Ardour is asked to load a session in an older session
1092 * format, and makes a backup copy.
1094 static PBD::Signal2<void,std::string,std::string> VersionMismatch;
1096 SceneChanger* scene_changer() const { return _scene_changer; }
1098 /* asynchronous MIDI control ports */
1100 boost::shared_ptr<Port> midi_input_port () const;
1101 boost::shared_ptr<Port> midi_output_port () const;
1102 boost::shared_ptr<Port> mmc_output_port () const;
1103 boost::shared_ptr<Port> mmc_input_port () const;
1104 boost::shared_ptr<Port> scene_input_port () const;
1105 boost::shared_ptr<Port> scene_output_port () const;
1107 /* synchronous MIDI ports used for synchronization */
1109 boost::shared_ptr<MidiPort> midi_clock_output_port () const;
1110 boost::shared_ptr<MidiPort> midi_clock_input_port () const;
1111 boost::shared_ptr<MidiPort> mtc_output_port () const;
1112 boost::shared_ptr<MidiPort> mtc_input_port () const;
1113 boost::shared_ptr<Port> ltc_input_port() const;
1114 boost::shared_ptr<Port> ltc_output_port() const;
1116 boost::shared_ptr<IO> ltc_input_io() { return _ltc_input; }
1117 boost::shared_ptr<IO> ltc_output_io() { return _ltc_output; }
1119 MIDI::MachineControl& mmc() { return *_mmc; }
1121 void reconnect_midi_scene_ports (bool);
1122 void reconnect_mtc_ports ();
1123 void reconnect_mmc_ports (bool);
1125 void reconnect_ltc_input ();
1126 void reconnect_ltc_output ();
1128 VCAManager& vca_manager() { return *_vca_manager; }
1131 friend class AudioEngine;
1132 void set_block_size (pframes_t nframes);
1133 void set_frame_rate (framecnt_t nframes);
1134 #ifdef USE_TRACKS_CODE_FEATURES
1135 void reconnect_existing_routes (bool withLock, bool reconnect_master = true, bool reconnect_inputs = true, bool reconnect_outputs = true);
1140 void schedule_curve_reallocation ();
1141 void update_latency_compensation (bool force = false);
1144 int create (const std::string& mix_template, BusProfile*);
1147 static guint _name_id_counter;
1148 static void init_name_id_counter (guint n);
1149 static unsigned int name_id_counter ();
1152 PendingDeclickIn = 0x1, ///< pending de-click fade-in for start
1153 PendingDeclickOut = 0x2, ///< pending de-click fade-out for stop
1154 StopPendingCapture = 0x4,
1155 PendingLoopDeclickIn = 0x8, ///< pending de-click fade-in at the start of a loop
1156 PendingLoopDeclickOut = 0x10, ///< pending de-click fade-out at the end of a loop
1157 PendingLocate = 0x20,
1160 /* stuff used in process() should be close together to
1164 typedef void (Session::*process_function_type)(pframes_t);
1166 AudioEngine& _engine;
1167 mutable gint processing_prohibited;
1168 process_function_type process_function;
1169 process_function_type last_process_function;
1170 bool _bounce_processing_active;
1171 bool waiting_for_sync_offset;
1172 framecnt_t _base_frame_rate; // sample-rate of the session at creation time, "native" SR
1173 framecnt_t _nominal_frame_rate; // overridden by audioengine setting
1174 framecnt_t _current_frame_rate; // this includes video pullup offset
1175 int transport_sub_state;
1176 mutable gint _record_status;
1177 framepos_t _transport_frame;
1178 Location* _session_range_location; ///< session range, or 0 if there is nothing in the session yet
1182 // varispeed playback
1183 double _transport_speed;
1184 double _default_transport_speed;
1185 double _last_transport_speed;
1186 double _signalled_varispeed;
1187 double _target_transport_speed;
1188 CubicInterpolation interpolation;
1190 bool auto_play_legal;
1191 framepos_t _last_slave_transport_frame;
1192 framecnt_t maximum_output_latency;
1193 framepos_t _requested_return_frame;
1194 pframes_t current_block_size;
1195 framecnt_t _worst_output_latency;
1196 framecnt_t _worst_input_latency;
1197 framecnt_t _worst_track_latency;
1198 bool _have_captured;
1199 bool _non_soloed_outs_muted;
1201 uint32_t _listen_cnt;
1202 uint32_t _solo_isolated_cnt;
1205 bool _under_nsm_control;
1206 unsigned int _xrun_count;
1208 void mtc_status_changed (bool);
1209 PBD::ScopedConnection mtc_status_connection;
1210 void ltc_status_changed (bool);
1211 PBD::ScopedConnection ltc_status_connection;
1213 void initialize_latencies ();
1214 void set_worst_io_latencies ();
1215 void set_worst_playback_latency ();
1216 void set_worst_capture_latency ();
1217 void set_worst_io_latencies_x (IOChange, void *) {
1218 set_worst_io_latencies ();
1220 void post_capture_latency ();
1221 void post_playback_latency ();
1223 void update_latency_compensation_proxy (void* ignored);
1225 void ensure_buffers (ChanCount howmany = ChanCount::ZERO);
1227 void process_scrub (pframes_t);
1228 void process_without_events (pframes_t);
1229 void process_with_events (pframes_t);
1230 void process_audition (pframes_t);
1231 int process_export (pframes_t);
1232 int process_export_fw (pframes_t);
1234 void block_processing() { g_atomic_int_set (&processing_prohibited, 1); }
1235 void unblock_processing() { g_atomic_int_set (&processing_prohibited, 0); }
1236 bool processing_blocked() const { return g_atomic_int_get (&processing_prohibited); }
1238 static const framecnt_t bounce_chunk_size;
1240 /* slave tracking */
1242 static const int delta_accumulator_size = 25;
1243 int delta_accumulator_cnt;
1244 int32_t delta_accumulator[delta_accumulator_size];
1245 int32_t average_slave_delta;
1247 bool have_first_delta_accumulator;
1249 SlaveState _slave_state;
1252 framepos_t slave_wait_end;
1254 void reset_slave_state ();
1255 bool follow_slave (pframes_t);
1256 void calculate_moving_average_of_slave_delta (int dir, framecnt_t this_delta);
1257 void track_slave_state (float slave_speed, framepos_t slave_transport_frame, framecnt_t this_delta);
1258 void follow_slave_silently (pframes_t nframes, float slave_speed);
1260 void switch_to_sync_source (SyncSource); /* !RT context */
1261 void drop_sync_source (); /* !RT context */
1262 void use_sync_source (Slave*); /* RT context */
1264 bool post_export_sync;
1265 framepos_t post_export_position;
1268 bool _export_rolling;
1269 framepos_t _export_preroll;
1271 boost::shared_ptr<ExportHandler> export_handler;
1272 boost::shared_ptr<ExportStatus> export_status;
1275 int stop_audio_export ();
1276 void finalize_audio_export ();
1277 void finalize_export_internal (bool stop_freewheel);
1278 bool _pre_export_mmc_enabled;
1280 PBD::ScopedConnection export_freewheel_connection;
1282 void get_track_statistics ();
1283 int process_routes (pframes_t, bool& need_butler);
1284 int silent_process_routes (pframes_t, bool& need_butler);
1286 /** @return 1 if there is a pending declick fade-in,
1287 -1 if there is a pending declick fade-out,
1288 0 if there is no pending declick.
1290 int get_transport_declick_required () {
1291 if (transport_sub_state & PendingDeclickIn) {
1292 transport_sub_state &= ~PendingDeclickIn;
1294 } else if (transport_sub_state & PendingDeclickOut) {
1295 /* XXX: not entirely sure why we don't clear this */
1297 } else if (transport_sub_state & PendingLoopDeclickOut) {
1298 /* Return the declick out first ... */
1299 transport_sub_state &= ~PendingLoopDeclickOut;
1301 } else if (transport_sub_state & PendingLoopDeclickIn) {
1302 /* ... then the declick in on the next call */
1303 transport_sub_state &= ~PendingLoopDeclickIn;
1310 bool maybe_stop (framepos_t limit);
1311 bool maybe_sync_start (pframes_t &);
1313 void check_declick_out ();
1319 /** Number of process frames since the last MTC output (when sending MTC); used to
1320 * know when to send full MTC messages every so often.
1322 pframes_t _pframes_since_last_mtc;
1323 bool session_midi_feedback;
1326 framepos_t last_loopend;
1328 boost::scoped_ptr<SessionDirectory> _session_dir;
1331 void graph_reordered ();
1333 /** current snapshot name, without the .ardour suffix */
1334 void set_snapshot_name (const std::string &);
1335 void save_snapshot_name (const std::string &);
1336 std::string _current_snapshot_name;
1338 XMLTree* state_tree;
1339 bool state_was_pending;
1340 StateOfTheState _state_of_the_state;
1342 friend class StateProtector;
1343 gint _suspend_save; /* atomic */
1344 volatile bool _save_queued;
1345 Glib::Threads::Mutex save_state_lock;
1346 Glib::Threads::Mutex peak_cleanup_lock;
1348 int load_options (const XMLNode&);
1349 int load_state (std::string snapshot_name);
1351 framepos_t _last_roll_location;
1352 /** the session frame time at which we last rolled, located, or changed transport direction */
1353 framepos_t _last_roll_or_reversal_location;
1354 framepos_t _last_record_location;
1356 bool pending_locate_roll;
1357 framepos_t pending_locate_frame;
1358 bool pending_locate_flush;
1360 bool pending_auto_loop;
1362 PBD::ReallocPool _mempool;
1364 Glib::Threads::Mutex lua_lock;
1365 luabridge::LuaRef * _lua_run;
1366 luabridge::LuaRef * _lua_add;
1367 luabridge::LuaRef * _lua_del;
1368 luabridge::LuaRef * _lua_list;
1369 luabridge::LuaRef * _lua_load;
1370 luabridge::LuaRef * _lua_save;
1371 luabridge::LuaRef * _lua_cleanup;
1372 uint32_t _n_lua_scripts;
1375 void try_run_lua (pframes_t);
1379 static const PostTransportWork ProcessCannotProceedMask =
1381 PostTransportInputChange|
1383 PostTransportReverse|
1384 PostTransportCurveRealloc|
1385 PostTransportAudition|
1386 PostTransportLocate|
1388 PostTransportClearSubstate);
1390 gint _post_transport_work; /* accessed only atomic ops */
1391 PostTransportWork post_transport_work() const { return (PostTransportWork) g_atomic_int_get (const_cast<gint*>(&_post_transport_work)); }
1392 void set_post_transport_work (PostTransportWork ptw) { g_atomic_int_set (&_post_transport_work, (gint) ptw); }
1393 void add_post_transport_work (PostTransportWork ptw);
1395 void schedule_playback_buffering_adjustment ();
1396 void schedule_capture_buffering_adjustment ();
1398 uint32_t cumulative_rf_motion;
1401 void set_rf_speed (float speed);
1402 void reset_rf_scale (framecnt_t frames_moved);
1404 Locations* _locations;
1405 void location_added (Location*);
1406 void location_removed (Location*);
1407 void locations_changed ();
1408 void _locations_changed (const Locations::LocationList&);
1410 void update_skips (Location*, bool consolidate);
1411 void update_marks (Location* loc);
1412 void consolidate_skips (Location*);
1413 void sync_locations_to_skips ();
1414 void _sync_locations_to_skips ();
1416 PBD::ScopedConnectionList skip_update_connections;
1417 bool _ignore_skips_updates;
1419 PBD::ScopedConnectionList punch_connections;
1420 void auto_punch_start_changed (Location *);
1421 void auto_punch_end_changed (Location *);
1422 void auto_punch_changed (Location *);
1424 PBD::ScopedConnectionList loop_connections;
1425 void auto_loop_changed (Location *);
1426 void auto_loop_declick_range (Location *, framepos_t &, framepos_t &);
1428 int ensure_engine (uint32_t desired_sample_rate, bool);
1429 void pre_engine_init (std::string path);
1430 int post_engine_init ();
1431 int immediately_post_engine ();
1432 void remove_empty_sounds ();
1434 void session_loaded ();
1436 void setup_midi_control ();
1437 int midi_read (MIDI::Port *);
1439 void enable_record ();
1441 void increment_transport_position (framecnt_t val) {
1442 if (max_framepos - val < _transport_frame) {
1443 _transport_frame = max_framepos;
1445 _transport_frame += val;
1449 void decrement_transport_position (framecnt_t val) {
1450 if (val < _transport_frame) {
1451 _transport_frame -= val;
1453 _transport_frame = 0;
1457 void post_transport_motion ();
1458 static void *session_loader_thread (void *arg);
1462 /* Signal Forwarding */
1463 void emit_route_signals ();
1464 void emit_thread_run ();
1465 static void *emit_thread (void *);
1466 void emit_thread_start ();
1467 void emit_thread_terminate ();
1469 pthread_t _rt_emit_thread;
1470 bool _rt_thread_active;
1472 pthread_mutex_t _rt_emit_mutex;
1473 pthread_cond_t _rt_emit_cond;
1474 bool _rt_emit_pending;
1476 /* Auto Connect Thread */
1477 static void *auto_connect_thread (void *);
1478 void auto_connect_thread_run ();
1479 void auto_connect_thread_start ();
1480 void auto_connect_thread_terminate ();
1482 pthread_t _auto_connect_thread;
1483 bool _ac_thread_active;
1484 pthread_mutex_t _auto_connect_mutex;
1485 pthread_cond_t _auto_connect_cond;
1487 struct AutoConnectRequest {
1489 AutoConnectRequest (boost::shared_ptr <Route> r, bool ci,
1490 const ChanCount& is,
1491 const ChanCount& os,
1492 const ChanCount& io,
1493 const ChanCount& oo)
1494 : route (boost::weak_ptr<Route> (r))
1495 , connect_inputs (ci)
1499 , output_offset (oo)
1502 boost::weak_ptr <Route> route;
1503 bool connect_inputs;
1504 ChanCount input_start;
1505 ChanCount output_start;
1506 ChanCount input_offset;
1507 ChanCount output_offset;
1510 typedef std::queue<AutoConnectRequest> AutoConnectQueue;
1511 Glib::Threads::Mutex _auto_connect_queue_lock;
1512 AutoConnectQueue _auto_connect_queue;
1514 void auto_connect (const AutoConnectRequest&);
1516 /* SessionEventManager interface */
1518 void process_event (SessionEvent*);
1519 void set_next_event ();
1520 void cleanup_event (SessionEvent*,int);
1522 /* MIDI Machine Control */
1525 void spp_continue ();
1528 void mmc_deferred_play (MIDI::MachineControl &);
1529 void mmc_stop (MIDI::MachineControl &);
1530 void mmc_step (MIDI::MachineControl &, int);
1531 void mmc_pause (MIDI::MachineControl &);
1532 void mmc_record_pause (MIDI::MachineControl &);
1533 void mmc_record_strobe (MIDI::MachineControl &);
1534 void mmc_record_exit (MIDI::MachineControl &);
1535 void mmc_track_record_status (MIDI::MachineControl &, uint32_t track, bool enabled);
1536 void mmc_fast_forward (MIDI::MachineControl &);
1537 void mmc_rewind (MIDI::MachineControl &);
1538 void mmc_locate (MIDI::MachineControl &, const MIDI::byte *);
1539 void mmc_shuttle (MIDI::MachineControl &mmc, float speed, bool forw);
1540 void mmc_record_enable (MIDI::MachineControl &mmc, size_t track, bool enabled);
1542 struct timeval last_mmc_step;
1545 typedef boost::function<bool()> MidiTimeoutCallback;
1546 typedef std::list<MidiTimeoutCallback> MidiTimeoutList;
1548 MidiTimeoutList midi_timeouts;
1549 bool mmc_step_timeout ();
1550 void send_immediate_mmc (MIDI::MachineControlCommand);
1552 MIDI::byte mtc_msg[16];
1553 MIDI::byte mtc_timecode_bits; /* encoding of SMTPE type for MTC */
1554 MIDI::byte midi_msg[16];
1555 double outbound_mtc_timecode_frame;
1556 Timecode::Time transmitting_timecode_time;
1557 int next_quarter_frame_to_send;
1559 double _frames_per_timecode_frame; /* has to be floating point because of drop frame */
1560 framecnt_t _frames_per_hour;
1561 framecnt_t _timecode_frames_per_hour;
1563 /* cache the most-recently requested time conversions. This helps when we
1564 * have multiple clocks showing the same time (e.g. the transport frame) */
1565 bool last_timecode_valid;
1566 framepos_t last_timecode_when;
1567 Timecode::Time last_timecode;
1569 bool _send_timecode_update; ///< Flag to send a full frame (Timecode) MTC message this cycle
1571 int send_midi_time_code_for_cycle (framepos_t, framepos_t, pframes_t nframes);
1573 LTCEncoder* ltc_encoder;
1574 ltcsnd_sample_t* ltc_enc_buf;
1576 Timecode::TimecodeFormat ltc_enc_tcformat;
1577 int32_t ltc_buf_off;
1578 int32_t ltc_buf_len;
1581 int32_t ltc_enc_byte;
1582 framepos_t ltc_enc_pos;
1584 framepos_t ltc_enc_off;
1586 framepos_t ltc_prev_cycle;
1588 framepos_t ltc_timecode_offset;
1589 bool ltc_timecode_negative_offset;
1591 LatencyRange ltc_out_latency;
1593 void ltc_tx_initialize();
1594 void ltc_tx_cleanup();
1595 void ltc_tx_reset();
1596 void ltc_tx_resync_latency();
1597 void ltc_tx_recalculate_position();
1598 void ltc_tx_parse_offset();
1599 void ltc_tx_send_time_code_for_cycle (framepos_t, framepos_t, double, double, pframes_t nframes);
1601 void reset_record_status ();
1603 int no_roll (pframes_t nframes);
1604 int fail_roll (pframes_t nframes);
1606 bool non_realtime_work_pending() const { return static_cast<bool>(post_transport_work()); }
1607 bool process_can_proceed() const { return !(post_transport_work() & ProcessCannotProceedMask); }
1609 MidiControlUI* midi_control_ui;
1611 int start_midi_thread ();
1613 void set_play_loop (bool yn, double speed);
1614 void unset_play_loop ();
1615 void overwrite_some_buffers (Track *);
1616 void flush_all_inserts ();
1617 int micro_locate (framecnt_t distance);
1618 void locate (framepos_t, bool with_roll, bool with_flush, bool with_loop=false, bool force=false, bool with_mmc=true);
1619 void start_locate (framepos_t, bool with_roll, bool with_flush, bool for_loop_enabled=false, bool force=false);
1620 void force_locate (framepos_t frame, bool with_roll = false);
1621 void set_track_speed (Track *, double speed);
1622 void set_transport_speed (double speed, framepos_t destination_frame, bool abort = false, bool clear_state = false, bool as_default = false);
1623 void stop_transport (bool abort = false, bool clear_state = false);
1624 void start_transport ();
1625 void realtime_stop (bool abort, bool clear_state);
1626 void realtime_locate ();
1627 void non_realtime_start_scrub ();
1628 void non_realtime_set_speed ();
1629 void non_realtime_locate ();
1630 void non_realtime_stop (bool abort, int entry_request_count, bool& finished);
1631 void non_realtime_overwrite (int entry_request_count, bool& finished);
1632 void post_transport ();
1633 void engine_halted ();
1634 void xrun_recovery ();
1635 void set_track_loop (bool);
1636 bool select_playhead_priority_target (framepos_t&);
1637 void follow_playhead_priority ();
1639 /* These are synchronous and so can only be called from within the process
1643 int send_full_time_code (framepos_t, pframes_t nframes);
1644 void send_song_position_pointer (framepos_t);
1646 TempoMap *_tempo_map;
1647 void tempo_map_changed (const PBD::PropertyChange&);
1648 void gui_tempo_map_changed ();
1650 /* edit/mix groups */
1652 int load_route_groups (const XMLNode&, int);
1654 std::list<RouteGroup *> _route_groups;
1655 RouteGroup* _all_route_group;
1659 boost::shared_ptr<Graph> _process_graph;
1661 SerializedRCUManager<RouteList> routes;
1663 void add_routes (RouteList&, bool input_auto_connect, bool output_auto_connect, bool save, PresentationInfo::order_t);
1664 void add_routes_inner (RouteList&, bool input_auto_connect, bool output_auto_connect, PresentationInfo::order_t);
1665 bool _adding_routes_in_progress;
1666 bool _reconnecting_routes_in_progress;
1667 bool _route_deletion_in_progress;
1669 uint32_t destructive_index;
1671 boost::shared_ptr<Route> XMLRouteFactory (const XMLNode&, int);
1672 boost::shared_ptr<Route> XMLRouteFactory_2X (const XMLNode&, int);
1674 void route_processors_changed (RouteProcessorChange);
1676 bool find_route_name (std::string const &, uint32_t& id, std::string& name, bool);
1677 void count_existing_track_channels (ChanCount& in, ChanCount& out);
1678 void auto_connect_route (boost::shared_ptr<Route>, bool, const ChanCount&, const ChanCount&, const ChanCount& io = ChanCount(), const ChanCount& oo = ChanCount());
1679 void midi_output_change_handler (IOChange change, void* /*src*/, boost::weak_ptr<Route> midi_track);
1681 /* track numbering */
1683 void reassign_track_numbers ();
1684 uint32_t _track_number_decimals;
1686 /* solo/mute/notifications */
1688 void route_listen_changed (PBD::Controllable::GroupControlDisposition, boost::weak_ptr<Route>);
1689 void route_mute_changed ();
1690 void route_solo_changed (bool self_solo_change, PBD::Controllable::GroupControlDisposition group_override, boost::weak_ptr<Route>);
1691 void route_solo_isolated_changed (boost::weak_ptr<Route>);
1693 void update_route_solo_state (boost::shared_ptr<RouteList> r = boost::shared_ptr<RouteList>());
1695 void listen_position_changed ();
1696 void solo_control_mode_changed ();
1698 /* REGION MANAGEMENT */
1700 mutable Glib::Threads::Mutex region_lock;
1702 int load_regions (const XMLNode& node);
1703 int load_compounds (const XMLNode& node);
1705 void route_added_to_route_group (RouteGroup *, boost::weak_ptr<Route>);
1706 void route_removed_from_route_group (RouteGroup *, boost::weak_ptr<Route>);
1707 void route_group_property_changed (RouteGroup *);
1711 mutable Glib::Threads::Mutex source_lock;
1714 typedef std::map<PBD::ID,boost::shared_ptr<Source> > SourceMap;
1717 void reset_write_sources (bool mark_write_complete, bool force = false);
1722 int load_sources (const XMLNode& node);
1723 XMLNode& get_sources_as_xml ();
1725 boost::shared_ptr<Source> XMLSourceFactory (const XMLNode&);
1729 void remove_playlist (boost::weak_ptr<Playlist>);
1730 void track_playlist_changed (boost::weak_ptr<Track>);
1731 void playlist_region_added (boost::weak_ptr<Region>);
1732 void playlist_ranges_moved (std::list<Evoral::RangeMove<framepos_t> > const &);
1733 void playlist_regions_extended (std::list<Evoral::Range<framepos_t> > const &);
1735 /* CURVES and AUTOMATION LISTS */
1736 std::map<PBD::ID, AutomationList*> automation_lists;
1738 /* DEFAULT FADE CURVES */
1740 float default_fade_steepness;
1741 float default_fade_msecs;
1745 boost::shared_ptr<Auditioner> auditioner;
1746 void set_audition (boost::shared_ptr<Region>);
1747 void non_realtime_set_audition ();
1748 boost::shared_ptr<Region> pending_audition_region;
1754 int flatten_one_track (AudioTrack&, framepos_t start, framecnt_t cnt);
1756 /* INSERT AND SEND MANAGEMENT */
1758 boost::dynamic_bitset<uint32_t> send_bitset;
1759 boost::dynamic_bitset<uint32_t> aux_send_bitset;
1760 boost::dynamic_bitset<uint32_t> return_bitset;
1761 boost::dynamic_bitset<uint32_t> insert_bitset;
1765 struct space_and_path {
1766 uint32_t blocks; ///< 4kB blocks
1767 bool blocks_unknown; ///< true if blocks is unknown
1772 , blocks_unknown (true)
1776 struct space_and_path_ascending_cmp {
1777 bool operator() (space_and_path a, space_and_path b) {
1778 if (a.blocks_unknown != b.blocks_unknown) {
1779 return !a.blocks_unknown;
1781 return a.blocks > b.blocks;
1785 void setup_raid_path (std::string path);
1787 std::vector<space_and_path> session_dirs;
1788 std::vector<space_and_path>::iterator last_rr_session_dir;
1789 uint32_t _total_free_4k_blocks;
1790 /** If this is true, _total_free_4k_blocks is not definite,
1791 as one or more of the session directories' filesystems
1792 could not report free space.
1794 bool _total_free_4k_blocks_uncertain;
1795 Glib::Threads::Mutex space_lock;
1797 bool no_questions_about_missing_files;
1799 std::string get_best_session_directory_for_new_audio ();
1801 mutable gint _playback_load;
1802 mutable gint _capture_load;
1806 SerializedRCUManager<BundleList> _bundles;
1807 XMLNode* _bundle_xml_node;
1808 int load_bundles (XMLNode const &);
1810 UndoHistory _history;
1811 /** current undo transaction, or 0 */
1812 UndoTransaction* _current_trans;
1813 /** GQuarks to describe the reversible commands that are currently in progress.
1814 * These may be nested, in which case more recently-started commands are toward
1815 * the front of the list.
1817 std::list<GQuark> _current_trans_quarks;
1819 int backend_sync_callback (TransportState, framepos_t);
1821 void process_rtop (SessionEvent*);
1823 void update_latency (bool playback);
1825 XMLNode& state(bool);
1828 typedef std::list<Click*> Clicks;
1831 boost::shared_ptr<IO> _click_io;
1832 boost::shared_ptr<Amp> _click_gain;
1834 Sample* click_emphasis_data;
1835 framecnt_t click_length;
1836 framecnt_t click_emphasis_length;
1837 mutable Glib::Threads::RWLock click_lock;
1839 static const Sample default_click[];
1840 static const framecnt_t default_click_length;
1841 static const Sample default_click_emphasis[];
1842 static const framecnt_t default_click_emphasis_length;
1845 framepos_t _clicks_cleared;
1846 void setup_click_sounds (int which);
1847 void setup_click_sounds (Sample**, Sample const *, framecnt_t*, framecnt_t, std::string const &);
1848 void clear_clicks ();
1849 void click (framepos_t start, framecnt_t nframes);
1851 std::vector<Route*> master_outs;
1853 /* range playback */
1855 std::list<AudioRange> current_audio_range;
1857 void set_play_range (std::list<AudioRange>&, bool leave_rolling);
1858 void unset_play_range ();
1860 /* temporary hacks to allow selection to be pushed from GUI into backend
1861 Whenever we move the selection object into libardour, these will go away.
1863 Evoral::Range<framepos_t> _range_selection;
1864 Evoral::Range<framepos_t> _object_selection;
1869 boost::shared_ptr<Route> _master_out;
1870 boost::shared_ptr<Route> _monitor_out;
1872 void auto_connect_master_bus ();
1874 /* Windows VST support */
1876 long _windows_vst_callback (
1885 int find_all_sources (std::string path, std::set<std::string>& result);
1886 int find_all_sources_across_snapshots (std::set<std::string>& result, bool exclude_this_snapshot);
1888 typedef std::set<boost::shared_ptr<PBD::Controllable> > Controllables;
1889 Glib::Threads::Mutex controllables_lock;
1890 Controllables controllables;
1892 boost::shared_ptr<PBD::Controllable> _solo_cut_control;
1894 void reset_native_file_format();
1895 bool first_file_data_format_reset;
1896 bool first_file_header_format_reset;
1898 void config_changed (std::string, bool);
1900 XMLNode& get_control_protocol_state ();
1902 void set_history_depth (uint32_t depth);
1904 static bool _disable_all_loaded_plugins;
1905 static bool _bypass_all_loaded_plugins;
1907 mutable bool have_looped; ///< Used in ::audible_frame(*)
1909 void update_route_record_state ();
1910 gint _have_rec_enabled_track;
1911 gint _have_rec_disabled_track;
1913 static int ask_about_playlist_deletion (boost::shared_ptr<Playlist>);
1915 /* realtime "apply to set of routes" operations */
1916 template<typename T> SessionEvent*
1917 get_rt_event (boost::shared_ptr<RouteList> rl, T targ, SessionEvent::RTeventCallback after, PBD::Controllable::GroupControlDisposition group_override,
1918 void (Session::*method) (boost::shared_ptr<RouteList>, T, PBD::Controllable::GroupControlDisposition)) {
1919 SessionEvent* ev = new SessionEvent (SessionEvent::RealTimeOperation, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
1920 ev->rt_slot = boost::bind (method, this, rl, targ, group_override);
1921 ev->rt_return = after;
1922 ev->event_loop = PBD::EventLoop::get_event_loop_for_thread ();
1927 /* specialized version realtime "apply to set of routes" operations */
1928 template<typename T1, typename T2> SessionEvent*
1929 get_rt_event (boost::shared_ptr<RouteList> rl, T1 t1arg, T2 t2arg, SessionEvent::RTeventCallback after, PBD::Controllable::GroupControlDisposition group_override,
1930 void (Session::*method) (boost::shared_ptr<RouteList>, T1, T2, PBD::Controllable::GroupControlDisposition)) {
1931 SessionEvent* ev = new SessionEvent (SessionEvent::RealTimeOperation, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
1932 ev->rt_slot = boost::bind (method, this, rl, t1arg, t2arg, group_override);
1933 ev->rt_return = after;
1934 ev->event_loop = PBD::EventLoop::get_event_loop_for_thread ();
1939 /* specialized version realtime "apply to set of controls" operations */
1940 SessionEvent* get_rt_event (boost::shared_ptr<ControlList> cl, double arg, PBD::Controllable::GroupControlDisposition group_override) {
1941 SessionEvent* ev = new SessionEvent (SessionEvent::RealTimeOperation, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
1942 ev->rt_slot = boost::bind (&Session::rt_set_controls, this, cl, arg, group_override);
1943 ev->rt_return = Session::rt_cleanup;
1944 ev->event_loop = PBD::EventLoop::get_event_loop_for_thread ();
1949 void rt_set_controls (boost::shared_ptr<ControlList>, double val, PBD::Controllable::GroupControlDisposition group_override);
1950 void rt_clear_all_solo_state (boost::shared_ptr<RouteList>, bool yn, PBD::Controllable::GroupControlDisposition group_override);
1952 /** temporary list of Diskstreams used only during load of 2.X sessions */
1953 std::list<boost::shared_ptr<Diskstream> > _diskstreams_2X;
1955 void set_session_range_location (framepos_t, framepos_t);
1957 void setup_midi_machine_control ();
1959 void step_edit_status_change (bool);
1960 uint32_t _step_editors;
1962 /** true if timecode transmission by the transport is suspended, otherwise false */
1963 mutable gint _suspend_timecode_transmission;
1965 void update_locations_after_tempo_map_change (const Locations::LocationList &);
1967 void start_time_changed (framepos_t);
1968 void end_time_changed (framepos_t);
1970 void set_track_monitor_input_status (bool);
1971 framepos_t compute_stop_limit () const;
1973 boost::shared_ptr<Speakers> _speakers;
1974 void load_nested_sources (const XMLNode& node);
1976 /** The directed graph of routes that is currently being used for audio processing
1977 and solo/mute computations.
1979 GraphEdges _current_route_graph;
1981 void ensure_route_presentation_info_gap (PresentationInfo::order_t, uint32_t gap_size);
1982 bool ignore_route_processor_changes;
1984 MidiClockTicker* midi_clock;
1986 boost::shared_ptr<IO> _ltc_input;
1987 boost::shared_ptr<IO> _ltc_output;
1989 /* Scene Changing */
1990 SceneChanger* _scene_changer;
1992 /* persistent, non-track related MIDI ports */
1993 MidiPortManager* _midi_ports;
1994 MIDI::MachineControl* _mmc;
1997 void setup_click ();
1998 void setup_click_state (const XMLNode*);
1999 void setup_bundles ();
2001 void save_as_bring_callback (uint32_t, uint32_t, std::string);
2003 static int get_session_info_from_path (XMLTree& state_tree, const std::string& xmlpath);
2004 static const uint32_t session_end_shift;
2006 std::string _template_state_dir;
2008 VCAManager* _vca_manager;
2010 boost::shared_ptr<Route> get_midi_nth_route_by_id (PresentationInfo::order_t n) const;
2012 std::string created_with;
2016 } // namespace ARDOUR
2018 #endif /* __ardour_session_h__ */