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"
33 #include <boost/dynamic_bitset.hpp>
34 #include <boost/scoped_ptr.hpp>
35 #include <boost/weak_ptr.hpp>
36 #include <boost/utility.hpp>
38 #include <glibmm/threads.h>
42 #include "pbd/error.h"
43 #include "pbd/event_loop.h"
45 #include "pbd/statefuldestructible.h"
46 #include "pbd/signals.h"
49 #include "evoral/types.hpp"
51 #include "midi++/types.h"
52 #include "midi++/mmc.h"
54 #include "timecode/time.h"
56 #include "ardour/ardour.h"
57 #include "ardour/chan_count.h"
58 #include "ardour/delivery.h"
59 #include "ardour/interthread_info.h"
60 #include "ardour/location.h"
61 #include "ardour/monitor_processor.h"
62 #include "ardour/rc_configuration.h"
63 #include "ardour/session_configuration.h"
64 #include "ardour/session_event.h"
65 #include "ardour/interpolation.h"
66 #include "ardour/route.h"
67 #include "ardour/route_graph.h"
73 typedef struct _AEffect AEffect;
83 class ControllableDescriptor;
94 class AudioFileSource;
112 class MidiClockTicker;
114 class MidiPortManager;
133 class SessionDirectory;
134 class SessionMetadata;
135 class SessionPlaylists;
141 class WindowsVSTPlugin;
143 extern void setup_enum_writer ();
145 class LIBARDOUR_API SessionException: public std::exception {
147 explicit SessionException(const std::string msg) : _message(msg) {}
148 virtual ~SessionException() throw() {}
150 virtual const char* what() const throw() { return _message.c_str(); }
153 std::string _message;
156 class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::ScopedConnectionList, public SessionEventManager
165 /* a new session might have non-empty mix_template, an existing session should always have an empty one.
166 the bus profile can be null if no master out bus is required.
169 Session (AudioEngine&,
170 const std::string& fullpath,
171 const std::string& snapshot_name,
172 BusProfile* bus_profile = 0,
173 std::string mix_template = "");
177 static int get_info_from_path (const std::string& xmlpath, float& sample_rate, SampleFormat& data_format);
178 static std::string get_snapshot_from_instant (const std::string& session_dir);
180 std::string path() const { return _path; }
181 std::string name() const { return _name; }
182 std::string snap_name() const { return _current_snapshot_name; }
183 std::string raid_path () const;
184 bool path_is_within_session (const std::string&);
186 bool writable() const { return _writable; }
189 bool dirty() const { return _state_of_the_state & Dirty; }
190 void set_deletion_in_progress ();
191 void clear_deletion_in_progress ();
192 bool reconnection_in_progress() const { return _reconnecting_routes_in_progress; }
193 bool deletion_in_progress() const { return _state_of_the_state & Deletion; }
194 bool routes_deletion_in_progress() const { return _route_deletion_in_progress; }
195 bool peaks_cleanup_in_progres() const { return _state_of_the_state & PeakCleanup; }
197 PBD::Signal0<void> DirtyChanged;
199 PBD::Signal1<void, bool> RouteAddedOrRemoved;
201 const SessionDirectory& session_directory () const { return *(_session_dir.get()); }
203 static PBD::Signal1<void,std::string> Dialog;
205 PBD::Signal0<void> BatchUpdateStart;
206 PBD::Signal0<void> BatchUpdateEnd;
208 int ensure_subdirs ();
210 std::string automation_dir () const; ///< Automation data
211 std::string analysis_dir () const; ///< Analysis data
212 std::string plugins_dir () const; ///< Plugin state
213 std::string externals_dir () const; ///< Links to external files
215 std::string construct_peak_filepath (const std::string& audio_path, const bool in_session = false, const bool old_peak_name = false) const;
217 bool audio_source_name_is_unique (const std::string& name);
218 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);
219 std::string new_audio_source_path_for_embedded (const std::string& existing_path);
220 std::string new_audio_source_path (const std::string&, uint32_t nchans, uint32_t chan, bool destructive, bool take_required);
221 std::string new_midi_source_path (const std::string&);
222 RouteList new_route_from_template (uint32_t how_many, const std::string& template_path, const std::string& name, PlaylistDisposition pd = NewPlaylist);
223 RouteList new_route_from_template (uint32_t how_many, XMLNode&, const std::string& name, PlaylistDisposition pd = NewPlaylist);
224 std::vector<std::string> get_paths_for_new_sources (bool allow_replacing, const std::string& import_file_path, uint32_t channels);
226 int bring_all_sources_into_session (boost::function<void(uint32_t,uint32_t,std::string)> callback);
228 void process (pframes_t nframes);
230 BufferSet& get_silent_buffers (ChanCount count = ChanCount::ZERO);
231 BufferSet& get_scratch_buffers (ChanCount count = ChanCount::ZERO, bool silence = true );
232 BufferSet& get_route_buffers (ChanCount count = ChanCount::ZERO, bool silence = true);
233 BufferSet& get_mix_buffers (ChanCount count = ChanCount::ZERO);
235 bool have_rec_enabled_track () const;
236 bool have_rec_disabled_track () const;
238 bool have_captured() const { return _have_captured; }
240 void refill_all_track_buffers ();
241 Butler* butler() { return _butler; }
242 void butler_transport_work ();
244 void refresh_disk_space ();
246 int load_diskstreams_2X (XMLNode const &, int);
248 int load_routes (const XMLNode&, int);
249 boost::shared_ptr<RouteList> get_routes() const {
250 return routes.reader ();
253 boost::shared_ptr<RouteList> get_tracks() const;
254 boost::shared_ptr<RouteList> get_routes_with_internal_returns() const;
255 boost::shared_ptr<RouteList> get_routes_with_regions_at (framepos_t const) const;
257 uint32_t nroutes() const { return routes.reader()->size(); }
258 uint32_t ntracks () const;
259 uint32_t nbusses () const;
261 boost::shared_ptr<BundleList> bundles () {
262 return _bundles.reader ();
265 struct LIBARDOUR_API RoutePublicOrderSorter {
266 bool operator() (boost::shared_ptr<Route>, boost::shared_ptr<Route> b);
269 void set_order_hint (int32_t order_hint) {_order_hint = order_hint;};
270 void notify_remote_id_change ();
271 void sync_order_keys ();
273 template<class T> void foreach_route (T *obj, void (T::*func)(Route&), bool sort = true);
274 template<class T> void foreach_route (T *obj, void (T::*func)(boost::shared_ptr<Route>), bool sort = true);
275 template<class T, class A> void foreach_route (T *obj, void (T::*func)(Route&, A), A arg, bool sort = true);
277 static char session_name_is_legal (const std::string&);
278 bool io_name_is_legal (const std::string&);
279 boost::shared_ptr<Route> route_by_name (std::string);
280 boost::shared_ptr<Route> route_by_id (PBD::ID);
281 boost::shared_ptr<Route> route_by_remote_id (uint32_t id);
282 boost::shared_ptr<Track> track_by_diskstream_id (PBD::ID);
283 void routes_using_input_from (const std::string& str, RouteList& rl);
285 bool route_name_unique (std::string) const;
286 bool route_name_internal (std::string) const;
288 uint32_t track_number_decimals () const {
289 return _track_number_decimals;
292 bool get_record_enabled() const {
293 return (record_status () >= Enabled);
296 RecordState record_status() const {
297 return (RecordState) g_atomic_int_get (&_record_status);
300 bool actively_recording () const {
301 return record_status() == Recording;
304 bool record_enabling_legal () const;
305 void maybe_enable_record ();
306 void disable_record (bool rt_context, bool force = false);
307 void step_back_from_record ();
309 void maybe_write_autosave ();
311 /* Emitted when all i/o connections are complete */
313 PBD::Signal0<void> IOConnectionsComplete;
315 /* Timecode status signals */
316 PBD::Signal1<void, bool> MTCSyncStateChanged;
317 PBD::Signal1<void, bool> LTCSyncStateChanged;
319 /* Record status signals */
321 PBD::Signal0<void> RecordStateChanged; /* signals changes in recording state (i.e. are we recording) */
322 /* XXX may 2015: paul says: it isn't clear to me that this has semantics that cannot be inferrred
323 from the previous signal and session state.
325 PBD::Signal0<void> RecordArmStateChanged; /* signals changes in recording arming */
327 /* Emited when session is loaded */
328 PBD::Signal0<void> SessionLoaded;
330 /* Transport mechanism signals */
332 /** Emitted on the following changes in transport state:
333 * - stop (from the butler thread)
334 * - change in whether or not we are looping (from the process thread)
335 * - change in the play range (from the process thread)
336 * - start (from the process thread)
339 PBD::Signal0<void> TransportStateChange;
341 PBD::Signal1<void,framepos_t> PositionChanged; /* sent after any non-sequential motion */
342 PBD::Signal1<void,framepos_t> Xrun;
343 PBD::Signal0<void> TransportLooped;
345 /** emitted when a locate has occurred */
346 PBD::Signal0<void> Located;
348 PBD::Signal1<void,RouteList&> RouteAdded;
349 /** Emitted when a property of one of our route groups changes.
350 * The parameter is the RouteGroup that has changed.
352 PBD::Signal1<void, RouteGroup *> RouteGroupPropertyChanged;
353 /** Emitted when a route is added to one of our route groups.
354 * First parameter is the RouteGroup, second is the route.
356 PBD::Signal2<void, RouteGroup *, boost::weak_ptr<Route> > RouteAddedToRouteGroup;
357 /** Emitted when a route is removed from one of our route groups.
358 * First parameter is the RouteGroup, second is the route.
360 PBD::Signal2<void, RouteGroup *, boost::weak_ptr<Route> > RouteRemovedFromRouteGroup;
362 /* Step Editing status changed */
363 PBD::Signal1<void,bool> StepEditStatusChange;
365 /* Timecode state signals */
366 PBD::Signal0<void> MtcOrLtcInputPortChanged;
368 void queue_event (SessionEvent*);
370 void request_roll_at_and_return (framepos_t start, framepos_t return_to);
371 void request_bounded_roll (framepos_t start, framepos_t end);
372 void request_stop (bool abort = false, bool clear_state = false);
373 void request_locate (framepos_t frame, bool with_roll = false);
375 void request_play_loop (bool yn, bool leave_rolling = false);
376 bool get_play_loop () const { return play_loop; }
378 framepos_t last_transport_start () const { return _last_roll_location; }
381 void use_rf_shuttle_speed ();
382 void allow_auto_play (bool yn);
383 void request_transport_speed (double speed, bool as_default = true);
384 void request_transport_speed_nonzero (double, bool as_default = true);
385 void request_overwrite_buffer (Track *);
386 void adjust_playback_buffering();
387 void adjust_capture_buffering();
388 void request_track_speed (Track *, double speed);
389 void request_input_change_handling ();
391 bool locate_pending() const { return static_cast<bool>(post_transport_work()&PostTransportLocate); }
392 bool transport_locked () const;
396 framepos_t current_end_frame () const;
397 framepos_t current_start_frame () const;
398 /** "actual" sample rate of session, set by current audioengine rate, pullup/down etc. */
399 framecnt_t frame_rate () const { return _current_frame_rate; }
400 /** "native" sample rate of session, regardless of current audioengine rate, pullup/down etc */
401 framecnt_t nominal_frame_rate () const { return _nominal_frame_rate; }
402 framecnt_t frames_per_hour () const { return _frames_per_hour; }
404 double frames_per_timecode_frame() const { return _frames_per_timecode_frame; }
405 framecnt_t timecode_frames_per_hour() const { return _timecode_frames_per_hour; }
407 MIDI::byte get_mtc_timecode_bits() const {
408 return mtc_timecode_bits; /* encoding of SMTPE type for MTC */
411 double timecode_frames_per_second() const;
412 bool timecode_drop_frames() const;
416 Locations *locations() { return _locations; }
418 PBD::Signal1<void,Location*> auto_loop_location_changed;
419 PBD::Signal1<void,Location*> auto_punch_location_changed;
420 PBD::Signal0<void> locations_modified;
422 void set_auto_punch_location (Location *);
423 void set_auto_loop_location (Location *);
424 void set_session_extents (framepos_t start, framepos_t end);
425 int location_name(std::string& result, std::string base = std::string(""));
427 pframes_t get_block_size() const { return current_block_size; }
428 framecnt_t worst_output_latency () const { return _worst_output_latency; }
429 framecnt_t worst_input_latency () const { return _worst_input_latency; }
430 framecnt_t worst_track_latency () const { return _worst_track_latency; }
431 framecnt_t worst_playback_latency () const { return _worst_output_latency + _worst_track_latency; }
434 std::string new_parent_folder; /* parent folder where new session folder will be created */
435 std::string new_name; /* name of newly saved session */
436 bool switch_to; /* true if we should be working on newly saved session after save-as; false otherwise */
437 bool include_media; /* true if the newly saved session should contain references to media */
438 bool copy_media; /* true if media files (audio, media, etc) should be copied into newly saved session; false otherwise */
439 bool copy_external; /* true if external media should be consolidated into the newly saved session; false otherwise */
441 std::string final_session_folder_name; /* filled in by * Session::save_as(), provides full path to newly saved session */
443 /* emitted as we make progress. 3 arguments passed to signal
446 * 1: percentage complete measured as a fraction (0-1.0) of
447 * total data copying done.
448 * 2: number of files copied so far
449 * 3: total number of files to copy
451 * Handler should return true for save-as to continue, or false
452 * to stop (and remove all evidence of partial save-as).
454 PBD::Signal3<bool,float,int64_t,int64_t> Progress;
456 /* if save_as() returns non-zero, this string will indicate the reason why.
458 std::string failure_message;
461 int save_as (SaveAs&);
462 int save_state (std::string snapshot_name, bool pending = false, bool switch_to_snapshot = false, bool template_only = false);
463 int restore_state (std::string snapshot_name);
464 int save_template (std::string template_name, bool replace_existing = false);
465 int save_history (std::string snapshot_name = "");
466 int restore_history (std::string snapshot_name);
467 void remove_state (std::string snapshot_name);
468 void rename_state (std::string old_name, std::string new_name);
469 void remove_pending_capture_state ();
470 int rename (const std::string&);
471 bool get_nsm_state () const { return _under_nsm_control; }
472 void set_nsm_state (bool state) { _under_nsm_control = state; }
473 bool save_default_options ();
475 PBD::Signal1<void,std::string> StateSaved;
476 PBD::Signal0<void> StateReady;
478 /* emitted when session needs to be saved due to some internal
479 * event or condition (i.e. not in response to a user request).
481 * Only one object should
482 * connect to this signal and take responsibility.
484 * Argument is the snapshot name to use when saving.
486 PBD::Signal1<void,std::string> SaveSessionRequested;
488 /* emitted during a session save to allow other entities to add state, via
489 * extra XML, to the session state
491 PBD::Signal0<void> SessionSaveUnderway;
493 std::vector<std::string> possible_states() const;
494 static std::vector<std::string> possible_states (std::string path);
496 XMLNode& get_state();
497 int set_state(const XMLNode& node, int version); // not idempotent
498 XMLNode& get_template();
500 /// The instant xml file is written to the session directory
501 void add_instant_xml (XMLNode&, bool write_to_config = true);
502 XMLNode* instant_xml (const std::string& str);
504 enum StateOfTheState {
509 InitialConnecting = 0x8,
515 StateOfTheState state_of_the_state() const { return _state_of_the_state; }
517 class StateProtector {
519 StateProtector (Session* s) : _session (s) {
520 g_atomic_int_inc (&s->_suspend_save);
523 if (g_atomic_int_dec_and_test (&_session->_suspend_save)) {
524 while (_session->_save_queued) {
525 _session->_save_queued = false;
526 _session->save_state ("");
534 void add_route_group (RouteGroup *);
535 void remove_route_group (RouteGroup&);
536 void reorder_route_groups (std::list<RouteGroup*>);
538 RouteGroup* route_group_by_name (std::string);
539 RouteGroup& all_route_group() const;
541 PBD::Signal1<void,RouteGroup*> route_group_added;
542 PBD::Signal0<void> route_group_removed;
543 PBD::Signal0<void> route_groups_reordered;
545 void foreach_route_group (boost::function<void(RouteGroup*)> f) {
546 for (std::list<RouteGroup *>::iterator i = _route_groups.begin(); i != _route_groups.end(); ++i) {
551 std::list<RouteGroup*> const & route_groups () const {
552 return _route_groups;
555 /* fundamental operations. duh. */
557 std::list<boost::shared_ptr<AudioTrack> > new_audio_track (
560 TrackMode mode = Normal,
561 RouteGroup* route_group = 0,
562 uint32_t how_many = 1,
563 std::string name_template = ""
566 RouteList new_audio_route (
567 int input_channels, int output_channels, RouteGroup* route_group, uint32_t how_many, std::string name_template = ""
570 std::list<boost::shared_ptr<MidiTrack> > new_midi_track (
571 const ChanCount& input, const ChanCount& output,
572 boost::shared_ptr<PluginInfo> instrument = boost::shared_ptr<PluginInfo>(),
573 TrackMode mode = Normal,
574 RouteGroup* route_group = 0, uint32_t how_many = 1, std::string name_template = ""
577 void remove_routes (boost::shared_ptr<RouteList>);
578 void remove_route (boost::shared_ptr<Route>);
580 void resort_routes ();
581 void resort_routes_using (boost::shared_ptr<RouteList>);
583 AudioEngine & engine() { return _engine; }
584 AudioEngine const & engine () const { return _engine; }
586 static std::string default_track_name_pattern (DataType);
590 framepos_t transport_frame () const {return _transport_frame; }
591 framepos_t record_location () const {return _last_record_location; }
592 framepos_t audible_frame () const;
593 framepos_t requested_return_frame() const { return _requested_return_frame; }
594 void set_requested_return_frame(framepos_t return_to);
608 void sync_time_vars();
610 void bbt_time (framepos_t when, Timecode::BBT_Time&);
611 void timecode_to_sample(Timecode::Time& timecode, framepos_t& sample, bool use_offset, bool use_subframes) const;
612 void sample_to_timecode(framepos_t sample, Timecode::Time& timecode, bool use_offset, bool use_subframes) const;
613 void timecode_time (Timecode::Time &);
614 void timecode_time (framepos_t when, Timecode::Time&);
615 void timecode_time_subframes (framepos_t when, Timecode::Time&);
617 void timecode_duration (framecnt_t, Timecode::Time&) const;
618 void timecode_duration_string (char *, size_t len, framecnt_t) const;
620 framecnt_t convert_to_frames (AnyTime const & position);
621 framecnt_t any_duration_to_frames (framepos_t position, AnyTime const & duration);
623 static PBD::Signal1<void, framepos_t> StartTimeChanged;
624 static PBD::Signal1<void, framepos_t> EndTimeChanged;
626 void request_sync_source (Slave*);
627 bool synced_to_engine() const { return _slave && config.get_external_sync() && Config->get_sync_source() == Engine; }
628 bool synced_to_mtc () const { return config.get_external_sync() && Config->get_sync_source() == MTC && g_atomic_int_get (const_cast<gint*>(&_mtc_active)); }
629 bool synced_to_ltc () const { return config.get_external_sync() && Config->get_sync_source() == LTC && g_atomic_int_get (const_cast<gint*>(&_ltc_active)); }
631 double transport_speed() const { return _transport_speed; }
632 bool transport_stopped() const { return _transport_speed == 0.0f; }
633 bool transport_rolling() const { return _transport_speed != 0.0f; }
635 bool silent () { return _silent; }
637 TempoMap& tempo_map() { return *_tempo_map; }
638 const TempoMap& tempo_map() const { return *_tempo_map; }
640 unsigned int get_xrun_count () const {return _xrun_count; }
641 void reset_xrun_count () {_xrun_count = 0; }
645 boost::shared_ptr<Region> find_whole_file_parent (boost::shared_ptr<Region const>) const;
647 boost::shared_ptr<Region> XMLRegionFactory (const XMLNode&, bool full);
648 boost::shared_ptr<AudioRegion> XMLAudioRegionFactory (const XMLNode&, bool full);
649 boost::shared_ptr<MidiRegion> XMLMidiRegionFactory (const XMLNode&, bool full);
651 /* source management */
653 void import_files (ImportStatus&);
654 bool sample_rate_convert (ImportStatus&, std::string infile, std::string& outfile);
655 std::string build_tmp_convert_name (std::string file);
657 boost::shared_ptr<ExportHandler> get_export_handler ();
658 boost::shared_ptr<ExportStatus> get_export_status ();
660 int start_audio_export (framepos_t position);
662 PBD::Signal1<int, framecnt_t> ProcessExport;
663 static PBD::Signal2<void,std::string, std::string> Exported;
665 void add_source (boost::shared_ptr<Source>);
666 void remove_source (boost::weak_ptr<Source>);
668 void cleanup_regions();
669 bool can_cleanup_peakfiles () const;
670 int cleanup_peakfiles ();
671 int cleanup_sources (CleanupReport&);
672 int cleanup_trash_sources (CleanupReport&);
674 int destroy_sources (std::list<boost::shared_ptr<Source> >);
676 int remove_last_capture ();
678 /** handlers should return 0 for "everything OK", and any other value for
679 * "cannot setup audioengine".
681 static PBD::Signal1<int,uint32_t> AudioEngineSetupRequired;
683 /** handlers should return -1 for "stop cleanup",
684 0 for "yes, delete this playlist",
685 1 for "no, don't delete this playlist".
687 static PBD::Signal1<int,boost::shared_ptr<Playlist> > AskAboutPlaylistDeletion;
689 /** handlers should return 0 for "ignore the rate mismatch",
690 !0 for "do not use this session"
692 static PBD::Signal2<int, framecnt_t, framecnt_t> AskAboutSampleRateMismatch;
694 /** handlers should return !0 for use pending state, 0 for ignore it.
696 static PBD::Signal0<int> AskAboutPendingState;
698 boost::shared_ptr<AudioFileSource> create_audio_source_for_session (
699 size_t, std::string const &, uint32_t, bool destructive);
701 boost::shared_ptr<MidiSource> create_midi_source_for_session (std::string const &);
702 boost::shared_ptr<MidiSource> create_midi_source_by_stealing_name (boost::shared_ptr<Track>);
704 boost::shared_ptr<Source> source_by_id (const PBD::ID&);
705 boost::shared_ptr<AudioFileSource> audio_source_by_path_and_channel (const std::string&, uint16_t) const;
706 boost::shared_ptr<MidiSource> midi_source_by_path (const std::string&) const;
707 uint32_t count_sources_by_origin (const std::string&);
709 void add_playlist (boost::shared_ptr<Playlist>, bool unused = false);
711 /* Curves and AutomationLists (TODO when they go away) */
712 void add_automation_list(AutomationList*);
716 boost::shared_ptr<Auditioner> the_auditioner() { return auditioner; }
717 void audition_playlist ();
718 void audition_region (boost::shared_ptr<Region>);
719 void cancel_audition ();
720 bool is_auditioning () const;
722 PBD::Signal1<void,bool> AuditionActive;
724 /* flattening stuff */
726 boost::shared_ptr<Region> write_one_track (Track&, framepos_t start, framepos_t end,
727 bool overwrite, std::vector<boost::shared_ptr<Source> >&, InterThreadInfo& wot,
728 boost::shared_ptr<Processor> endpoint,
729 bool include_endpoint, bool for_export, bool for_freeze);
730 int freeze_all (InterThreadInfo&);
732 /* session-wide solo/mute/rec-enable */
734 bool soloing() const { return _non_soloed_outs_muted; }
735 bool listening() const { return _listen_cnt > 0; }
736 bool solo_isolated() const { return _solo_isolated_cnt > 0; }
738 static const SessionEvent::RTeventCallback rt_cleanup;
740 void set_solo (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
741 void clear_all_solo_state (boost::shared_ptr<RouteList>);
742 void set_just_one_solo (boost::shared_ptr<Route>, bool, SessionEvent::RTeventCallback after = rt_cleanup);
743 void set_mute (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
744 void set_listen (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
745 void set_record_enabled (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
746 void set_record_safe (boost::shared_ptr<RouteList>, bool yn, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
747 void set_solo_isolated (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
748 void set_monitoring (boost::shared_ptr<RouteList>, MonitorChoice, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
749 void set_exclusive_input_active (boost::shared_ptr<RouteList> rt, bool onoff, bool flip_others=false);
751 PBD::Signal1<void,bool> SoloActive;
752 PBD::Signal0<void> SoloChanged;
753 PBD::Signal0<void> IsolatedChanged;
754 PBD::Signal0<void> MonitorChanged;
756 PBD::Signal0<void> session_routes_reconnected;
758 /* monitor/master out */
760 void add_monitor_section ();
761 void reset_monitor_section ();
762 void remove_monitor_section ();
763 bool monitor_active() const { return (_monitor_out && _monitor_out->monitor_control () && _monitor_out->monitor_control ()->monitor_active()); }
765 boost::shared_ptr<Route> monitor_out() const { return _monitor_out; }
766 boost::shared_ptr<Route> master_out() const { return _master_out; }
768 void globally_add_internal_sends (boost::shared_ptr<Route> dest, Placement p, bool);
769 void globally_set_send_gains_from_track (boost::shared_ptr<Route> dest);
770 void globally_set_send_gains_to_zero (boost::shared_ptr<Route> dest);
771 void globally_set_send_gains_to_unity (boost::shared_ptr<Route> dest);
772 void add_internal_sends (boost::shared_ptr<Route> dest, Placement p, boost::shared_ptr<RouteList> senders);
773 void add_internal_send (boost::shared_ptr<Route>, int, boost::shared_ptr<Route>);
774 void add_internal_send (boost::shared_ptr<Route>, boost::shared_ptr<Processor>, boost::shared_ptr<Route>);
776 static void set_disable_all_loaded_plugins (bool yn) {
777 _disable_all_loaded_plugins = yn;
779 static bool get_disable_all_loaded_plugins() {
780 return _disable_all_loaded_plugins;
782 static void set_bypass_all_loaded_plugins (bool yn) {
783 _bypass_all_loaded_plugins = yn;
785 static bool get_bypass_all_loaded_plugins() {
786 return _bypass_all_loaded_plugins;
789 uint32_t next_send_id();
790 uint32_t next_aux_send_id();
791 uint32_t next_return_id();
792 uint32_t next_insert_id();
793 void mark_send_id (uint32_t);
794 void mark_aux_send_id (uint32_t);
795 void mark_return_id (uint32_t);
796 void mark_insert_id (uint32_t);
797 void unmark_send_id (uint32_t);
798 void unmark_aux_send_id (uint32_t);
799 void unmark_return_id (uint32_t);
800 void unmark_insert_id (uint32_t);
802 /* s/w "RAID" management */
804 boost::optional<framecnt_t> available_capture_duration();
808 void add_bundle (boost::shared_ptr<Bundle>, bool emit_signal = true);
809 void remove_bundle (boost::shared_ptr<Bundle>);
810 boost::shared_ptr<Bundle> bundle_by_name (std::string) const;
812 PBD::Signal0<void> BundleAddedOrRemoved;
816 /* History (for editors, mixers, UIs etc.) */
818 /** Undo some transactions.
819 * @param n Number of transactions to undo.
821 void undo (uint32_t n) {
825 void redo (uint32_t n) {
829 UndoHistory& history() { return _history; }
831 uint32_t undo_depth() const { return _history.undo_depth(); }
832 uint32_t redo_depth() const { return _history.redo_depth(); }
833 std::string next_undo() const { return _history.next_undo(); }
834 std::string next_redo() const { return _history.next_redo(); }
836 void begin_reversible_command (const std::string& cmd_name);
837 void begin_reversible_command (GQuark);
838 void abort_reversible_command ();
839 void commit_reversible_command (Command* cmd = 0);
841 void add_command (Command *const cmd);
843 /** @return The list of operations that are currently in progress */
844 std::list<GQuark> const & current_operations () {
845 return _current_trans_quarks;
848 bool operation_in_progress (GQuark) const;
850 void add_commands (std::vector<Command*> const & cmds);
852 std::map<PBD::ID,PBD::StatefulDestructible*> registry;
854 // these commands are implemented in libs/ardour/session_command.cc
855 Command* memento_command_factory(XMLNode* n);
856 Command* stateful_diff_command_factory (XMLNode *);
857 void register_with_memento_command_factory(PBD::ID, PBD::StatefulDestructible*);
861 boost::shared_ptr<IO> click_io() { return _click_io; }
862 boost::shared_ptr<Amp> click_gain() { return _click_gain; }
864 /* disk, buffer loads */
866 uint32_t playback_load ();
867 uint32_t capture_load ();
871 void request_play_range (std::list<AudioRange>*, bool leave_rolling = false);
872 void request_cancel_play_range ();
873 bool get_play_range () const { return _play_range; }
875 void maybe_update_session_range (framepos_t, framepos_t);
877 /* temporary hacks to allow selection to be pushed from GUI into backend.
878 Whenever we move the selection object into libardour, these will go away.
880 void set_range_selection (framepos_t start, framepos_t end);
881 void set_object_selection (framepos_t start, framepos_t end);
882 void clear_range_selection ();
883 void clear_object_selection ();
885 /* buffers for gain and pan */
887 gain_t* gain_automation_buffer () const;
888 gain_t* trim_automation_buffer () const;
889 gain_t* send_gain_automation_buffer () const;
890 pan_t** pan_automation_buffer () const;
892 void ensure_buffer_set (BufferSet& buffers, const ChanCount& howmany);
896 static int vst_current_loading_id;
897 static const char* vst_can_do_strings[];
898 static const int vst_can_do_string_count;
900 static intptr_t vst_callback (
909 static PBD::Signal0<void> SendFeedback;
913 boost::shared_ptr<Speakers> get_speakers ();
917 boost::shared_ptr<PBD::Controllable> controllable_by_id (const PBD::ID&);
918 boost::shared_ptr<PBD::Controllable> controllable_by_descriptor (const PBD::ControllableDescriptor&);
920 void add_controllable (boost::shared_ptr<PBD::Controllable>);
921 void remove_controllable (PBD::Controllable*);
923 boost::shared_ptr<PBD::Controllable> solo_cut_control() const;
925 SessionConfiguration config;
927 bool exporting () const {
931 bool bounce_processing() const {
932 return _bounce_processing_active;
935 /* this is a private enum, but setup_enum_writer() needs it,
936 and i can't find a way to give that function
940 enum PostTransportWork {
941 PostTransportStop = 0x1,
942 PostTransportDuration = 0x2,
943 PostTransportLocate = 0x4,
944 PostTransportRoll = 0x8,
945 PostTransportAbort = 0x10,
946 PostTransportOverWrite = 0x20,
947 PostTransportSpeed = 0x40,
948 PostTransportAudition = 0x80,
949 PostTransportReverse = 0x100,
950 PostTransportInputChange = 0x200,
951 PostTransportCurveRealloc = 0x400,
952 PostTransportClearSubstate = 0x800,
953 PostTransportAdjustPlaybackBuffering = 0x1000,
954 PostTransportAdjustCaptureBuffering = 0x2000
963 SlaveState slave_state() const { return _slave_state; }
964 Slave* slave() const { return _slave; }
966 boost::shared_ptr<SessionPlaylists> playlists;
968 void send_mmc_locate (framepos_t);
969 void queue_full_time_code () { _send_timecode_update = true; }
970 void queue_song_position_pointer () { /* currently does nothing */ }
972 bool step_editing() const { return (_step_editors > 0); }
974 void request_suspend_timecode_transmission ();
975 void request_resume_timecode_transmission ();
976 bool timecode_transmission_suspended () const;
978 std::vector<std::string> source_search_path(DataType) const;
979 void ensure_search_path_includes (const std::string& path, DataType type);
980 void remove_dir_from_search_path (const std::string& path, DataType type);
982 std::list<std::string> unknown_processors () const;
984 /** Emitted when a feedback cycle has been detected within Ardour's signal
985 processing path. Until it is fixed (by the user) some (unspecified)
986 routes will not be run.
988 static PBD::Signal0<void> FeedbackDetected;
990 /** Emitted when a graph sort has successfully completed, which means
991 that it has no feedback cycles.
993 static PBD::Signal0<void> SuccessfulGraphSort;
995 /* handlers can return an integer value:
996 0: config.set_audio_search_path() or config.set_midi_search_path() was used
997 to modify the search path and we should try to find it again.
998 1: quit entire session load
999 2: as 0, but don't ask about other missing files
1000 3: don't ask about other missing files, and just mark this one missing
1001 -1: just mark this one missing
1002 any other value: as -1
1004 static PBD::Signal3<int,Session*,std::string,DataType> MissingFile;
1006 /** Emitted when the session wants Ardour to quit */
1007 static PBD::Signal0<void> Quit;
1009 /** Emitted when Ardour is asked to load a session in an older session
1010 * format, and makes a backup copy.
1012 static PBD::Signal2<void,std::string,std::string> VersionMismatch;
1014 SceneChanger* scene_changer() const { return _scene_changer; }
1016 /* asynchronous MIDI control ports */
1018 boost::shared_ptr<Port> midi_input_port () const;
1019 boost::shared_ptr<Port> midi_output_port () const;
1020 boost::shared_ptr<Port> mmc_output_port () const;
1021 boost::shared_ptr<Port> mmc_input_port () const;
1022 boost::shared_ptr<Port> scene_input_port () const;
1023 boost::shared_ptr<Port> scene_output_port () const;
1025 /* synchronous MIDI ports used for synchronization */
1027 boost::shared_ptr<MidiPort> midi_clock_output_port () const;
1028 boost::shared_ptr<MidiPort> midi_clock_input_port () const;
1029 boost::shared_ptr<MidiPort> mtc_output_port () const;
1030 boost::shared_ptr<MidiPort> mtc_input_port () const;
1031 boost::shared_ptr<Port> ltc_input_port() const;
1032 boost::shared_ptr<Port> ltc_output_port() const;
1034 boost::shared_ptr<IO> ltc_input_io() { return _ltc_input; }
1035 boost::shared_ptr<IO> ltc_output_io() { return _ltc_output; }
1037 MIDI::MachineControl& mmc() { return *_mmc; }
1039 void reconnect_midi_scene_ports (bool);
1040 void reconnect_mtc_ports ();
1041 void reconnect_mmc_ports (bool);
1043 void reconnect_ltc_input ();
1044 void reconnect_ltc_output ();
1047 friend class AudioEngine;
1048 void set_block_size (pframes_t nframes);
1049 void set_frame_rate (framecnt_t nframes);
1050 void reconnect_existing_routes (bool withLock, bool reconnect_master = true, bool reconnect_inputs = true, bool reconnect_outputs = true);
1054 void schedule_curve_reallocation ();
1055 void update_latency_compensation (bool force = false);
1058 int create (const std::string& mix_template, BusProfile*);
1062 PendingDeclickIn = 0x1, ///< pending de-click fade-in for start
1063 PendingDeclickOut = 0x2, ///< pending de-click fade-out for stop
1064 StopPendingCapture = 0x4,
1065 PendingLoopDeclickIn = 0x8, ///< pending de-click fade-in at the start of a loop
1066 PendingLoopDeclickOut = 0x10, ///< pending de-click fade-out at the end of a loop
1067 PendingLocate = 0x20,
1070 /* stuff used in process() should be close together to
1074 typedef void (Session::*process_function_type)(pframes_t);
1076 AudioEngine& _engine;
1077 mutable gint processing_prohibited;
1078 process_function_type process_function;
1079 process_function_type last_process_function;
1080 bool _bounce_processing_active;
1081 bool waiting_for_sync_offset;
1082 framecnt_t _base_frame_rate;
1083 framecnt_t _current_frame_rate; //this includes video pullup offset
1084 framecnt_t _nominal_frame_rate; //ignores audioengine setting, "native" SR
1085 int transport_sub_state;
1086 mutable gint _record_status;
1087 framepos_t _transport_frame;
1088 Location* _session_range_location; ///< session range, or 0 if there is nothing in the session yet
1092 // varispeed playback
1093 double _transport_speed;
1094 double _default_transport_speed;
1095 double _last_transport_speed;
1096 double _signalled_varispeed;
1097 double _target_transport_speed;
1098 CubicInterpolation interpolation;
1100 bool auto_play_legal;
1101 framepos_t _last_slave_transport_frame;
1102 framecnt_t maximum_output_latency;
1103 framepos_t _requested_return_frame;
1104 pframes_t current_block_size;
1105 framecnt_t _worst_output_latency;
1106 framecnt_t _worst_input_latency;
1107 framecnt_t _worst_track_latency;
1108 bool _have_captured;
1109 bool _non_soloed_outs_muted;
1110 uint32_t _listen_cnt;
1111 uint32_t _solo_isolated_cnt;
1114 bool _under_nsm_control;
1115 unsigned int _xrun_count;
1117 void mtc_status_changed (bool);
1118 PBD::ScopedConnection mtc_status_connection;
1119 void ltc_status_changed (bool);
1120 PBD::ScopedConnection ltc_status_connection;
1122 void initialize_latencies ();
1123 void set_worst_io_latencies ();
1124 void set_worst_playback_latency ();
1125 void set_worst_capture_latency ();
1126 void set_worst_io_latencies_x (IOChange, void *) {
1127 set_worst_io_latencies ();
1129 void post_capture_latency ();
1130 void post_playback_latency ();
1132 void update_latency_compensation_proxy (void* ignored);
1134 void ensure_buffers (ChanCount howmany = ChanCount::ZERO);
1136 void process_scrub (pframes_t);
1137 void process_without_events (pframes_t);
1138 void process_with_events (pframes_t);
1139 void process_audition (pframes_t);
1140 int process_export (pframes_t);
1141 int process_export_fw (pframes_t);
1143 void block_processing() { g_atomic_int_set (&processing_prohibited, 1); }
1144 void unblock_processing() { g_atomic_int_set (&processing_prohibited, 0); }
1145 bool processing_blocked() const { return g_atomic_int_get (&processing_prohibited); }
1147 static const framecnt_t bounce_chunk_size;
1149 /* slave tracking */
1151 static const int delta_accumulator_size = 25;
1152 int delta_accumulator_cnt;
1153 int32_t delta_accumulator[delta_accumulator_size];
1154 int32_t average_slave_delta;
1156 bool have_first_delta_accumulator;
1158 SlaveState _slave_state;
1161 framepos_t slave_wait_end;
1163 void reset_slave_state ();
1164 bool follow_slave (pframes_t);
1165 void calculate_moving_average_of_slave_delta (int dir, framecnt_t this_delta);
1166 void track_slave_state (float slave_speed, framepos_t slave_transport_frame, framecnt_t this_delta);
1167 void follow_slave_silently (pframes_t nframes, float slave_speed);
1169 void switch_to_sync_source (SyncSource); /* !RT context */
1170 void drop_sync_source (); /* !RT context */
1171 void use_sync_source (Slave*); /* RT context */
1173 bool post_export_sync;
1174 framepos_t post_export_position;
1177 bool _export_started;
1178 bool _export_rolling;
1180 boost::shared_ptr<ExportHandler> export_handler;
1181 boost::shared_ptr<ExportStatus> export_status;
1184 int stop_audio_export ();
1185 void finalize_audio_export ();
1186 void finalize_export_internal (bool stop_freewheel);
1187 bool _pre_export_mmc_enabled;
1189 PBD::ScopedConnection export_freewheel_connection;
1191 void get_track_statistics ();
1192 int process_routes (pframes_t, bool& need_butler);
1193 int silent_process_routes (pframes_t, bool& need_butler);
1195 /** @return 1 if there is a pending declick fade-in,
1196 -1 if there is a pending declick fade-out,
1197 0 if there is no pending declick.
1199 int get_transport_declick_required () {
1200 if (transport_sub_state & PendingDeclickIn) {
1201 transport_sub_state &= ~PendingDeclickIn;
1203 } else if (transport_sub_state & PendingDeclickOut) {
1204 /* XXX: not entirely sure why we don't clear this */
1206 } else if (transport_sub_state & PendingLoopDeclickOut) {
1207 /* Return the declick out first ... */
1208 transport_sub_state &= ~PendingLoopDeclickOut;
1210 } else if (transport_sub_state & PendingLoopDeclickIn) {
1211 /* ... then the declick in on the next call */
1212 transport_sub_state &= ~PendingLoopDeclickIn;
1219 bool maybe_stop (framepos_t limit);
1220 bool maybe_sync_start (pframes_t &);
1222 void check_declick_out ();
1228 /** Number of process frames since the last MTC output (when sending MTC); used to
1229 * know when to send full MTC messages every so often.
1231 pframes_t _pframes_since_last_mtc;
1232 bool session_midi_feedback;
1235 framepos_t last_loopend;
1237 boost::scoped_ptr<SessionDirectory> _session_dir;
1240 void graph_reordered ();
1242 /** current snapshot name, without the .ardour suffix */
1243 void set_snapshot_name (const std::string &);
1244 void save_snapshot_name (const std::string &);
1245 std::string _current_snapshot_name;
1247 XMLTree* state_tree;
1248 bool state_was_pending;
1249 StateOfTheState _state_of_the_state;
1251 friend class StateProtector;
1252 gint _suspend_save; /* atomic */
1253 volatile bool _save_queued;
1254 Glib::Threads::Mutex save_state_lock;
1255 Glib::Threads::Mutex peak_cleanup_lock;
1257 int load_options (const XMLNode&);
1258 int load_state (std::string snapshot_name);
1260 framepos_t _last_roll_location;
1261 /** the session frame time at which we last rolled, located, or changed transport direction */
1262 framepos_t _last_roll_or_reversal_location;
1263 framepos_t _last_record_location;
1265 bool pending_locate_roll;
1266 framepos_t pending_locate_frame;
1267 bool pending_locate_flush;
1269 bool pending_auto_loop;
1273 static const PostTransportWork ProcessCannotProceedMask =
1275 PostTransportInputChange|
1277 PostTransportReverse|
1278 PostTransportCurveRealloc|
1279 PostTransportAudition|
1280 PostTransportLocate|
1282 PostTransportClearSubstate);
1284 gint _post_transport_work; /* accessed only atomic ops */
1285 PostTransportWork post_transport_work() const { return (PostTransportWork) g_atomic_int_get (const_cast<gint*>(&_post_transport_work)); }
1286 void set_post_transport_work (PostTransportWork ptw) { g_atomic_int_set (&_post_transport_work, (gint) ptw); }
1287 void add_post_transport_work (PostTransportWork ptw);
1289 void schedule_playback_buffering_adjustment ();
1290 void schedule_capture_buffering_adjustment ();
1292 uint32_t cumulative_rf_motion;
1295 void set_rf_speed (float speed);
1296 void reset_rf_scale (framecnt_t frames_moved);
1298 Locations* _locations;
1299 void location_added (Location*);
1300 void location_removed (Location*);
1301 void locations_changed ();
1302 void _locations_changed (const Locations::LocationList&);
1304 void update_skips (Location*, bool consolidate);
1305 void update_marks (Location* loc);
1306 void consolidate_skips (Location*);
1307 void sync_locations_to_skips ();
1308 void _sync_locations_to_skips ();
1310 PBD::ScopedConnectionList skip_update_connections;
1311 bool _ignore_skips_updates;
1313 PBD::ScopedConnectionList punch_connections;
1314 void auto_punch_start_changed (Location *);
1315 void auto_punch_end_changed (Location *);
1316 void auto_punch_changed (Location *);
1318 PBD::ScopedConnectionList loop_connections;
1319 void auto_loop_changed (Location *);
1320 void auto_loop_declick_range (Location *, framepos_t &, framepos_t &);
1322 int ensure_engine (uint32_t desired_sample_rate);
1323 void pre_engine_init (std::string path);
1324 int post_engine_init ();
1325 int immediately_post_engine ();
1326 void remove_empty_sounds ();
1328 void session_loaded ();
1330 void setup_midi_control ();
1331 int midi_read (MIDI::Port *);
1333 void enable_record ();
1335 void increment_transport_position (framecnt_t val) {
1336 if (max_framepos - val < _transport_frame) {
1337 _transport_frame = max_framepos;
1339 _transport_frame += val;
1343 void decrement_transport_position (framecnt_t val) {
1344 if (val < _transport_frame) {
1345 _transport_frame -= val;
1347 _transport_frame = 0;
1351 void post_transport_motion ();
1352 static void *session_loader_thread (void *arg);
1356 /* Signal Forwarding */
1357 void emit_route_signals ();
1358 void emit_thread_run ();
1359 static void *emit_thread (void *);
1360 void emit_thread_start ();
1361 void emit_thread_terminate ();
1363 pthread_t _rt_emit_thread;
1364 bool _rt_thread_active;
1366 pthread_mutex_t _rt_emit_mutex;
1367 pthread_cond_t _rt_emit_cond;
1368 bool _rt_emit_pending;
1371 /* SessionEventManager interface */
1373 void process_event (SessionEvent*);
1374 void set_next_event ();
1375 void cleanup_event (SessionEvent*,int);
1377 /* MIDI Machine Control */
1380 void spp_continue ();
1383 void mmc_deferred_play (MIDI::MachineControl &);
1384 void mmc_stop (MIDI::MachineControl &);
1385 void mmc_step (MIDI::MachineControl &, int);
1386 void mmc_pause (MIDI::MachineControl &);
1387 void mmc_record_pause (MIDI::MachineControl &);
1388 void mmc_record_strobe (MIDI::MachineControl &);
1389 void mmc_record_exit (MIDI::MachineControl &);
1390 void mmc_track_record_status (MIDI::MachineControl &, uint32_t track, bool enabled);
1391 void mmc_fast_forward (MIDI::MachineControl &);
1392 void mmc_rewind (MIDI::MachineControl &);
1393 void mmc_locate (MIDI::MachineControl &, const MIDI::byte *);
1394 void mmc_shuttle (MIDI::MachineControl &mmc, float speed, bool forw);
1395 void mmc_record_enable (MIDI::MachineControl &mmc, size_t track, bool enabled);
1397 struct timeval last_mmc_step;
1400 typedef boost::function<bool()> MidiTimeoutCallback;
1401 typedef std::list<MidiTimeoutCallback> MidiTimeoutList;
1403 MidiTimeoutList midi_timeouts;
1404 bool mmc_step_timeout ();
1405 void send_immediate_mmc (MIDI::MachineControlCommand);
1407 MIDI::byte mtc_msg[16];
1408 MIDI::byte mtc_timecode_bits; /* encoding of SMTPE type for MTC */
1409 MIDI::byte midi_msg[16];
1410 double outbound_mtc_timecode_frame;
1411 Timecode::Time transmitting_timecode_time;
1412 int next_quarter_frame_to_send;
1414 double _frames_per_timecode_frame; /* has to be floating point because of drop frame */
1415 framecnt_t _frames_per_hour;
1416 framecnt_t _timecode_frames_per_hour;
1418 /* cache the most-recently requested time conversions. This helps when we
1419 * have multiple clocks showing the same time (e.g. the transport frame) */
1420 bool last_timecode_valid;
1421 framepos_t last_timecode_when;
1422 Timecode::Time last_timecode;
1424 bool _send_timecode_update; ///< Flag to send a full frame (Timecode) MTC message this cycle
1426 int send_midi_time_code_for_cycle (framepos_t, framepos_t, pframes_t nframes);
1428 LTCEncoder* ltc_encoder;
1429 ltcsnd_sample_t* ltc_enc_buf;
1431 Timecode::TimecodeFormat ltc_enc_tcformat;
1432 int32_t ltc_buf_off;
1433 int32_t ltc_buf_len;
1436 int32_t ltc_enc_byte;
1437 framepos_t ltc_enc_pos;
1439 framepos_t ltc_enc_off;
1441 framepos_t ltc_prev_cycle;
1443 framepos_t ltc_timecode_offset;
1444 bool ltc_timecode_negative_offset;
1446 LatencyRange ltc_out_latency;
1448 void ltc_tx_initialize();
1449 void ltc_tx_cleanup();
1450 void ltc_tx_reset();
1451 void ltc_tx_resync_latency();
1452 void ltc_tx_recalculate_position();
1453 void ltc_tx_parse_offset();
1454 void ltc_tx_send_time_code_for_cycle (framepos_t, framepos_t, double, double, pframes_t nframes);
1456 void reset_record_status ();
1458 int no_roll (pframes_t nframes);
1459 int fail_roll (pframes_t nframes);
1461 bool non_realtime_work_pending() const { return static_cast<bool>(post_transport_work()); }
1462 bool process_can_proceed() const { return !(post_transport_work() & ProcessCannotProceedMask); }
1464 MidiControlUI* midi_control_ui;
1466 int start_midi_thread ();
1468 void set_play_loop (bool yn, double speed);
1469 void unset_play_loop ();
1470 void overwrite_some_buffers (Track *);
1471 void flush_all_inserts ();
1472 int micro_locate (framecnt_t distance);
1473 void locate (framepos_t, bool with_roll, bool with_flush, bool with_loop=false, bool force=false, bool with_mmc=true);
1474 void start_locate (framepos_t, bool with_roll, bool with_flush, bool for_loop_enabled=false, bool force=false);
1475 void force_locate (framepos_t frame, bool with_roll = false);
1476 void set_track_speed (Track *, double speed);
1477 void set_transport_speed (double speed, framepos_t destination_frame, bool abort = false, bool clear_state = false, bool as_default = false);
1478 void stop_transport (bool abort = false, bool clear_state = false);
1479 void start_transport ();
1480 void realtime_stop (bool abort, bool clear_state);
1481 void realtime_locate ();
1482 void non_realtime_start_scrub ();
1483 void non_realtime_set_speed ();
1484 void non_realtime_locate ();
1485 void non_realtime_stop (bool abort, int entry_request_count, bool& finished);
1486 void non_realtime_overwrite (int entry_request_count, bool& finished);
1487 void post_transport ();
1488 void engine_halted ();
1489 void xrun_recovery ();
1490 void set_track_loop (bool);
1491 bool select_playhead_priority_target (framepos_t&);
1492 void follow_playhead_priority ();
1494 /* These are synchronous and so can only be called from within the process
1498 int send_full_time_code (framepos_t, pframes_t nframes);
1499 void send_song_position_pointer (framepos_t);
1501 TempoMap *_tempo_map;
1502 void tempo_map_changed (const PBD::PropertyChange&);
1504 /* edit/mix groups */
1506 int load_route_groups (const XMLNode&, int);
1508 std::list<RouteGroup *> _route_groups;
1509 RouteGroup* _all_route_group;
1513 boost::shared_ptr<Graph> _process_graph;
1515 SerializedRCUManager<RouteList> routes;
1517 void add_routes (RouteList&, bool input_auto_connect, bool output_auto_connect, bool save);
1518 void add_routes_inner (RouteList&, bool input_auto_connect, bool output_auto_connect);
1519 bool _adding_routes_in_progress;
1520 bool _reconnecting_routes_in_progress;
1521 bool _route_deletion_in_progress;
1523 uint32_t destructive_index;
1525 boost::shared_ptr<Route> XMLRouteFactory (const XMLNode&, int);
1526 boost::shared_ptr<Route> XMLRouteFactory_2X (const XMLNode&, int);
1528 void route_processors_changed (RouteProcessorChange);
1530 bool find_route_name (std::string const &, uint32_t& id, std::string& name, bool);
1531 void count_existing_track_channels (ChanCount& in, ChanCount& out);
1532 void auto_connect_route (boost::shared_ptr<Route> route, ChanCount& existing_inputs, ChanCount& existing_outputs,
1533 bool with_lock, bool connect_inputs = true,
1534 ChanCount input_start = ChanCount (), ChanCount output_start = ChanCount ());
1535 void midi_output_change_handler (IOChange change, void* /*src*/, boost::weak_ptr<Route> midi_track);
1537 /* track numbering */
1539 void reassign_track_numbers ();
1540 uint32_t _track_number_decimals;
1544 void route_listen_changed (bool group_override, boost::weak_ptr<Route>);
1545 void route_mute_changed (void *src);
1546 void route_solo_changed (bool self_solo_change, bool group_override, boost::weak_ptr<Route>);
1547 void route_solo_isolated_changed (void *src, boost::weak_ptr<Route>);
1548 void update_route_solo_state (boost::shared_ptr<RouteList> r = boost::shared_ptr<RouteList>());
1550 void listen_position_changed ();
1551 void solo_control_mode_changed ();
1553 /* REGION MANAGEMENT */
1555 mutable Glib::Threads::Mutex region_lock;
1557 int load_regions (const XMLNode& node);
1558 int load_compounds (const XMLNode& node);
1560 void route_added_to_route_group (RouteGroup *, boost::weak_ptr<Route>);
1561 void route_removed_from_route_group (RouteGroup *, boost::weak_ptr<Route>);
1562 void route_group_property_changed (RouteGroup *);
1566 mutable Glib::Threads::Mutex source_lock;
1569 typedef std::map<PBD::ID,boost::shared_ptr<Source> > SourceMap;
1572 void reset_write_sources (bool mark_write_complete, bool force = false);
1577 int load_sources (const XMLNode& node);
1578 XMLNode& get_sources_as_xml ();
1580 boost::shared_ptr<Source> XMLSourceFactory (const XMLNode&);
1584 void remove_playlist (boost::weak_ptr<Playlist>);
1585 void track_playlist_changed (boost::weak_ptr<Track>);
1586 void playlist_region_added (boost::weak_ptr<Region>);
1587 void playlist_ranges_moved (std::list<Evoral::RangeMove<framepos_t> > const &);
1588 void playlist_regions_extended (std::list<Evoral::Range<framepos_t> > const &);
1590 /* CURVES and AUTOMATION LISTS */
1591 std::map<PBD::ID, AutomationList*> automation_lists;
1593 /* DEFAULT FADE CURVES */
1595 float default_fade_steepness;
1596 float default_fade_msecs;
1600 boost::shared_ptr<Auditioner> auditioner;
1601 void set_audition (boost::shared_ptr<Region>);
1602 void non_realtime_set_audition ();
1603 boost::shared_ptr<Region> pending_audition_region;
1609 int flatten_one_track (AudioTrack&, framepos_t start, framecnt_t cnt);
1611 /* INSERT AND SEND MANAGEMENT */
1613 boost::dynamic_bitset<uint32_t> send_bitset;
1614 boost::dynamic_bitset<uint32_t> aux_send_bitset;
1615 boost::dynamic_bitset<uint32_t> return_bitset;
1616 boost::dynamic_bitset<uint32_t> insert_bitset;
1620 struct space_and_path {
1621 uint32_t blocks; ///< 4kB blocks
1622 bool blocks_unknown; ///< true if blocks is unknown
1627 , blocks_unknown (true)
1631 struct space_and_path_ascending_cmp {
1632 bool operator() (space_and_path a, space_and_path b) {
1633 if (a.blocks_unknown != b.blocks_unknown) {
1634 return !a.blocks_unknown;
1636 return a.blocks > b.blocks;
1640 void setup_raid_path (std::string path);
1642 std::vector<space_and_path> session_dirs;
1643 std::vector<space_and_path>::iterator last_rr_session_dir;
1644 uint32_t _total_free_4k_blocks;
1645 /** If this is true, _total_free_4k_blocks is not definite,
1646 as one or more of the session directories' filesystems
1647 could not report free space.
1649 bool _total_free_4k_blocks_uncertain;
1650 Glib::Threads::Mutex space_lock;
1652 bool no_questions_about_missing_files;
1654 std::string get_best_session_directory_for_new_audio ();
1656 mutable gint _playback_load;
1657 mutable gint _capture_load;
1661 SerializedRCUManager<BundleList> _bundles;
1662 XMLNode* _bundle_xml_node;
1663 int load_bundles (XMLNode const &);
1665 UndoHistory _history;
1666 /** current undo transaction, or 0 */
1667 UndoTransaction* _current_trans;
1668 /** GQuarks to describe the reversible commands that are currently in progress.
1669 * These may be nested, in which case more recently-started commands are toward
1670 * the front of the list.
1672 std::list<GQuark> _current_trans_quarks;
1674 int backend_sync_callback (TransportState, framepos_t);
1676 void process_rtop (SessionEvent*);
1678 void update_latency (bool playback);
1680 XMLNode& state(bool);
1683 typedef std::list<Click*> Clicks;
1686 boost::shared_ptr<IO> _click_io;
1687 boost::shared_ptr<Amp> _click_gain;
1689 Sample* click_emphasis_data;
1690 framecnt_t click_length;
1691 framecnt_t click_emphasis_length;
1692 mutable Glib::Threads::RWLock click_lock;
1694 static const Sample default_click[];
1695 static const framecnt_t default_click_length;
1696 static const Sample default_click_emphasis[];
1697 static const framecnt_t default_click_emphasis_length;
1700 framepos_t _clicks_cleared;
1701 void setup_click_sounds (int which);
1702 void setup_click_sounds (Sample**, Sample const *, framecnt_t*, framecnt_t, std::string const &);
1703 void clear_clicks ();
1704 void click (framepos_t start, framecnt_t nframes);
1706 std::vector<Route*> master_outs;
1708 /* range playback */
1710 std::list<AudioRange> current_audio_range;
1712 void set_play_range (std::list<AudioRange>&, bool leave_rolling);
1713 void unset_play_range ();
1715 /* temporary hacks to allow selection to be pushed from GUI into backend
1716 Whenever we move the selection object into libardour, these will go away.
1718 Evoral::Range<framepos_t> _range_selection;
1719 Evoral::Range<framepos_t> _object_selection;
1724 boost::shared_ptr<Route> _master_out;
1725 boost::shared_ptr<Route> _monitor_out;
1727 void auto_connect_master_bus ();
1729 /* Windows VST support */
1731 long _windows_vst_callback (
1740 int find_all_sources (std::string path, std::set<std::string>& result);
1741 int find_all_sources_across_snapshots (std::set<std::string>& result, bool exclude_this_snapshot);
1743 typedef std::set<boost::shared_ptr<PBD::Controllable> > Controllables;
1744 Glib::Threads::Mutex controllables_lock;
1745 Controllables controllables;
1747 boost::shared_ptr<PBD::Controllable> _solo_cut_control;
1749 void reset_native_file_format();
1750 bool first_file_data_format_reset;
1751 bool first_file_header_format_reset;
1753 void config_changed (std::string, bool);
1755 XMLNode& get_control_protocol_state ();
1757 void set_history_depth (uint32_t depth);
1759 static bool _disable_all_loaded_plugins;
1760 static bool _bypass_all_loaded_plugins;
1762 mutable bool have_looped; ///< Used in ::audible_frame(*)
1764 void update_route_record_state ();
1765 gint _have_rec_enabled_track;
1766 gint _have_rec_disabled_track;
1768 static int ask_about_playlist_deletion (boost::shared_ptr<Playlist>);
1770 /* realtime "apply to set of routes" operations */
1771 template<typename T> SessionEvent*
1772 get_rt_event (boost::shared_ptr<RouteList> rl, T targ, SessionEvent::RTeventCallback after, bool group_override,
1773 void (Session::*method) (boost::shared_ptr<RouteList>, T, bool)) {
1774 SessionEvent* ev = new SessionEvent (SessionEvent::RealTimeOperation, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
1775 ev->rt_slot = boost::bind (method, this, rl, targ, group_override);
1776 ev->rt_return = after;
1777 ev->event_loop = PBD::EventLoop::get_event_loop_for_thread ();
1782 void rt_set_solo (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1783 void rt_clear_all_solo_state (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1784 void rt_set_just_one_solo (boost::shared_ptr<RouteList>, bool yn, bool /* ignored*/ );
1785 void rt_set_mute (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1786 void rt_set_listen (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1787 void rt_set_solo_isolated (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1788 void rt_set_record_enabled (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1789 void rt_set_record_safe (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1790 void rt_set_monitoring (boost::shared_ptr<RouteList>, MonitorChoice, bool group_override);
1792 /** temporary list of Diskstreams used only during load of 2.X sessions */
1793 std::list<boost::shared_ptr<Diskstream> > _diskstreams_2X;
1795 void set_session_range_location (framepos_t, framepos_t);
1797 void setup_midi_machine_control ();
1799 void step_edit_status_change (bool);
1800 uint32_t _step_editors;
1802 /** true if timecode transmission by the transport is suspended, otherwise false */
1803 mutable gint _suspend_timecode_transmission;
1805 void update_locations_after_tempo_map_change (const Locations::LocationList &);
1807 void start_time_changed (framepos_t);
1808 void end_time_changed (framepos_t);
1810 void set_track_monitor_input_status (bool);
1811 framepos_t compute_stop_limit () const;
1813 boost::shared_ptr<Speakers> _speakers;
1814 void load_nested_sources (const XMLNode& node);
1816 /** The directed graph of routes that is currently being used for audio processing
1817 and solo/mute computations.
1819 GraphEdges _current_route_graph;
1821 uint32_t next_control_id () const;
1822 int32_t _order_hint;
1823 bool ignore_route_processor_changes;
1825 MidiClockTicker* midi_clock;
1827 boost::shared_ptr<IO> _ltc_input;
1828 boost::shared_ptr<IO> _ltc_output;
1830 /* Scene Changing */
1831 SceneChanger* _scene_changer;
1833 /* persistent, non-track related MIDI ports */
1834 MidiPortManager* _midi_ports;
1835 MIDI::MachineControl* _mmc;
1838 void setup_click ();
1839 void setup_click_state (const XMLNode*);
1840 void setup_bundles ();
1842 void save_as_bring_callback (uint32_t, uint32_t, std::string);
1844 static int get_session_info_from_path (XMLTree& state_tree, const std::string& xmlpath);
1845 static const uint32_t session_end_shift;
1847 std::string _template_state_dir;
1851 } // namespace ARDOUR
1853 #endif /* __ardour_session_h__ */