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"
32 #include <boost/dynamic_bitset.hpp>
33 #include <boost/scoped_ptr.hpp>
34 #include <boost/weak_ptr.hpp>
35 #include <boost/utility.hpp>
37 #include <glibmm/threads.h>
41 #include "pbd/error.h"
42 #include "pbd/event_loop.h"
44 #include "pbd/statefuldestructible.h"
45 #include "pbd/signals.h"
48 #include "evoral/types.hpp"
50 #include "midi++/types.h"
51 #include "midi++/mmc.h"
53 #include "timecode/time.h"
55 #include "ardour/ardour.h"
56 #include "ardour/chan_count.h"
57 #include "ardour/delivery.h"
58 #include "ardour/interthread_info.h"
59 #include "ardour/rc_configuration.h"
60 #include "ardour/session_configuration.h"
61 #include "ardour/session_event.h"
62 #include "ardour/location.h"
63 #include "ardour/interpolation.h"
64 #include "ardour/route_graph.h"
70 typedef struct _AEffect AEffect;
80 class ControllableDescriptor;
91 class AudioFileSource;
109 class MidiClockTicker;
111 class MidiPortManager;
130 class SessionDirectory;
131 class SessionMetadata;
132 class SessionPlaylists;
138 class WindowsVSTPlugin;
140 extern void setup_enum_writer ();
142 class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::ScopedConnectionList, public SessionEventManager
151 /* a new session might have non-empty mix_template, an existing session should always have an empty one.
152 the bus profile can be null if no master out bus is required.
155 Session (AudioEngine&,
156 const std::string& fullpath,
157 const std::string& snapshot_name,
158 BusProfile* bus_profile = 0,
159 std::string mix_template = "");
163 static int get_info_from_path (const std::string& xmlpath, float& sample_rate, SampleFormat& data_format);
165 std::string path() const { return _path; }
166 std::string name() const { return _name; }
167 std::string snap_name() const { return _current_snapshot_name; }
168 std::string raid_path () const;
169 bool path_is_within_session (const std::string&);
171 void set_snap_name ();
173 bool writable() const { return _writable; }
176 bool dirty() const { return _state_of_the_state & Dirty; }
177 void set_deletion_in_progress ();
178 void clear_deletion_in_progress ();
179 bool reconnection_in_progress() const { return _reconnecting_routes_in_progress; }
180 bool deletion_in_progress() const { return _state_of_the_state & Deletion; }
181 bool routes_deletion_in_progress() const { return _route_deletion_in_progress; }
183 PBD::Signal0<void> DirtyChanged;
185 PBD::Signal1<void, bool> RouteAddedOrRemoved;
187 const SessionDirectory& session_directory () const { return *(_session_dir.get()); }
189 static PBD::Signal1<void,std::string> Dialog;
191 PBD::Signal0<void> BatchUpdateStart;
192 PBD::Signal0<void> BatchUpdateEnd;
194 int ensure_subdirs ();
196 std::string automation_dir () const; ///< Automation data
197 std::string analysis_dir () const; ///< Analysis data
198 std::string plugins_dir () const; ///< Plugin state
199 std::string externals_dir () const; ///< Links to external files
201 std::string peak_path (std::string) const;
203 std::string peak_path_from_audio_path (std::string) const;
204 bool audio_source_name_is_unique (const std::string& name);
205 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);
206 std::string new_audio_source_path_for_embedded (const std::string& existing_path);
207 std::string new_audio_source_path (const std::string&, uint32_t nchans, uint32_t chan, bool destructive, bool take_required);
208 std::string new_midi_source_path (const std::string&);
209 RouteList new_route_from_template (uint32_t how_many, const std::string& template_path, const std::string& name);
210 std::vector<std::string> get_paths_for_new_sources (bool allow_replacing, const std::string& import_file_path, uint32_t channels);
212 int bring_all_sources_into_session (boost::function<void(uint32_t,uint32_t,std::string)> callback);
214 void process (pframes_t nframes);
216 BufferSet& get_silent_buffers (ChanCount count = ChanCount::ZERO);
217 BufferSet& get_scratch_buffers (ChanCount count = ChanCount::ZERO, bool silence = true );
218 BufferSet& get_route_buffers (ChanCount count = ChanCount::ZERO, bool silence = true);
219 BufferSet& get_mix_buffers (ChanCount count = ChanCount::ZERO);
221 bool have_rec_enabled_track () const;
222 bool have_rec_disabled_track () const;
224 bool have_captured() const { return _have_captured; }
226 void refill_all_track_buffers ();
227 Butler* butler() { return _butler; }
228 void butler_transport_work ();
230 void refresh_disk_space ();
232 int load_diskstreams_2X (XMLNode const &, int);
234 int load_routes (const XMLNode&, int);
235 boost::shared_ptr<RouteList> get_routes() const {
236 return routes.reader ();
239 boost::shared_ptr<RouteList> get_tracks() const;
240 boost::shared_ptr<RouteList> get_routes_with_internal_returns() const;
241 boost::shared_ptr<RouteList> get_routes_with_regions_at (framepos_t const) const;
243 uint32_t nroutes() const { return routes.reader()->size(); }
244 uint32_t ntracks () const;
245 uint32_t nbusses () const;
247 boost::shared_ptr<BundleList> bundles () {
248 return _bundles.reader ();
251 struct LIBARDOUR_API RoutePublicOrderSorter {
252 bool operator() (boost::shared_ptr<Route>, boost::shared_ptr<Route> b);
255 void set_order_hint (int32_t order_hint) {_order_hint = order_hint;};
256 void notify_remote_id_change ();
257 void sync_order_keys ();
259 template<class T> void foreach_route (T *obj, void (T::*func)(Route&), bool sort = true);
260 template<class T> void foreach_route (T *obj, void (T::*func)(boost::shared_ptr<Route>), bool sort = true);
261 template<class T, class A> void foreach_route (T *obj, void (T::*func)(Route&, A), A arg, bool sort = true);
263 static char session_name_is_legal (const std::string&);
264 bool io_name_is_legal (const std::string&);
265 boost::shared_ptr<Route> route_by_name (std::string);
266 boost::shared_ptr<Route> route_by_id (PBD::ID);
267 boost::shared_ptr<Route> route_by_remote_id (uint32_t id);
268 boost::shared_ptr<Track> track_by_diskstream_id (PBD::ID);
269 void routes_using_input_from (const std::string& str, RouteList& rl);
271 bool route_name_unique (std::string) const;
272 bool route_name_internal (std::string) const;
274 uint32_t track_number_decimals () const {
275 return _track_number_decimals;
278 bool get_record_enabled() const {
279 return (record_status () >= Enabled);
282 RecordState record_status() const {
283 return (RecordState) g_atomic_int_get (&_record_status);
286 bool actively_recording () const {
287 return record_status() == Recording;
290 bool record_enabling_legal () const;
291 void maybe_enable_record ();
292 void disable_record (bool rt_context, bool force = false);
293 void step_back_from_record ();
295 void maybe_write_autosave ();
297 /* Emitted when all i/o connections are complete */
299 PBD::Signal0<void> IOConnectionsComplete;
301 /* Timecode status signals */
302 PBD::Signal1<void, bool> MTCSyncStateChanged;
303 PBD::Signal1<void, bool> LTCSyncStateChanged;
305 /* Record status signals */
307 PBD::Signal0<void> RecordStateChanged; /* signals changes in recording state (i.e. are we recording) */
308 /* XXX may 2015: paul says: it isn't clear to me that this has semantics that cannot be inferrred
309 from the previous signal and session state.
311 PBD::Signal0<void> RecordArmStateChanged; /* signals changes in recording arming */
313 /* Emited when session is loaded */
314 PBD::Signal0<void> SessionLoaded;
316 /* Transport mechanism signals */
318 /** Emitted on the following changes in transport state:
319 * - stop (from the butler thread)
320 * - change in whether or not we are looping (from the process thread)
321 * - change in the play range (from the process thread)
322 * - start (from the process thread)
325 PBD::Signal0<void> TransportStateChange;
327 PBD::Signal1<void,framepos_t> PositionChanged; /* sent after any non-sequential motion */
328 PBD::Signal1<void,framepos_t> Xrun;
329 PBD::Signal0<void> TransportLooped;
331 /** emitted when a locate has occurred */
332 PBD::Signal0<void> Located;
334 PBD::Signal1<void,RouteList&> RouteAdded;
335 /** Emitted when a property of one of our route groups changes.
336 * The parameter is the RouteGroup that has changed.
338 PBD::Signal1<void, RouteGroup *> RouteGroupPropertyChanged;
339 /** Emitted when a route is added to one of our route groups.
340 * First parameter is the RouteGroup, second is the route.
342 PBD::Signal2<void, RouteGroup *, boost::weak_ptr<Route> > RouteAddedToRouteGroup;
343 /** Emitted when a route is removed from one of our route groups.
344 * First parameter is the RouteGroup, second is the route.
346 PBD::Signal2<void, RouteGroup *, boost::weak_ptr<Route> > RouteRemovedFromRouteGroup;
348 /* Step Editing status changed */
349 PBD::Signal1<void,bool> StepEditStatusChange;
351 /* Timecode state signals */
352 PBD::Signal0<void> MtcOrLtcInputPortChanged;
354 void queue_event (SessionEvent*);
356 void request_roll_at_and_return (framepos_t start, framepos_t return_to);
357 void request_bounded_roll (framepos_t start, framepos_t end);
358 void request_stop (bool abort = false, bool clear_state = false);
359 void request_locate (framepos_t frame, bool with_roll = false);
361 void request_play_loop (bool yn, bool leave_rolling = false);
362 bool get_play_loop () const { return play_loop; }
364 framepos_t last_transport_start () const { return _last_roll_location; }
367 void use_rf_shuttle_speed ();
368 void allow_auto_play (bool yn);
369 void request_transport_speed (double speed, bool as_default = false);
370 void request_transport_speed_nonzero (double, bool as_default = false);
371 void request_overwrite_buffer (Track *);
372 void adjust_playback_buffering();
373 void adjust_capture_buffering();
374 void request_track_speed (Track *, double speed);
375 void request_input_change_handling ();
377 bool locate_pending() const { return static_cast<bool>(post_transport_work()&PostTransportLocate); }
378 bool transport_locked () const;
382 framepos_t current_end_frame () const;
383 framepos_t current_start_frame () const;
384 /** "actual" sample rate of session, set by current audioengine rate, pullup/down etc. */
385 framecnt_t frame_rate () const { return _current_frame_rate; }
386 /** "native" sample rate of session, regardless of current audioengine rate, pullup/down etc */
387 framecnt_t nominal_frame_rate () const { return _nominal_frame_rate; }
388 framecnt_t frames_per_hour () const { return _frames_per_hour; }
390 double frames_per_timecode_frame() const { return _frames_per_timecode_frame; }
391 framecnt_t timecode_frames_per_hour() const { return _timecode_frames_per_hour; }
393 MIDI::byte get_mtc_timecode_bits() const {
394 return mtc_timecode_bits; /* encoding of SMTPE type for MTC */
397 double timecode_frames_per_second() const;
398 bool timecode_drop_frames() const;
402 Locations *locations() { return _locations; }
404 PBD::Signal1<void,Location*> auto_loop_location_changed;
405 PBD::Signal1<void,Location*> auto_punch_location_changed;
406 PBD::Signal0<void> locations_modified;
408 void set_auto_punch_location (Location *);
409 void set_auto_loop_location (Location *);
410 void set_session_extents (framepos_t start, framepos_t end);
411 int location_name(std::string& result, std::string base = std::string(""));
413 pframes_t get_block_size() const { return current_block_size; }
414 framecnt_t worst_output_latency () const { return _worst_output_latency; }
415 framecnt_t worst_input_latency () const { return _worst_input_latency; }
416 framecnt_t worst_track_latency () const { return _worst_track_latency; }
417 framecnt_t worst_playback_latency () const { return _worst_output_latency + _worst_track_latency; }
420 std::string new_parent_folder; /* parent folder where new session folder will be created */
421 std::string new_name; /* name of newly saved session */
422 bool switch_to; /* true if we should be working on newly saved session after save-as; false otherwise */
423 bool include_media; /* true if the newly saved session should contain references to media */
424 bool copy_media; /* true if media files (audio, media, etc) should be copied into newly saved session; false otherwise */
425 bool copy_external; /* true if external media should be consolidated into the newly saved session; false otherwise */
427 std::string final_session_folder_name; /* filled in by * Session::save_as(), provides full path to newly saved session */
429 /* emitted as we make progress. 3 arguments passed to signal
432 * 1: percentage complete measured as a fraction (0-1.0) of
433 * total data copying done.
434 * 2: number of files copied so far
435 * 3: total number of files to copy
437 * Handler should return true for save-as to continue, or false
438 * to stop (and remove all evidence of partial save-as).
440 PBD::Signal3<bool,float,int64_t,int64_t> Progress;
442 /* if save_as() returns non-zero, this string will indicate the reason why.
444 std::string failure_message;
447 int save_as (SaveAs&);
448 int save_state (std::string snapshot_name, bool pending = false, bool switch_to_snapshot = false, bool template_only = false);
449 int restore_state (std::string snapshot_name);
450 int save_template (std::string template_name);
451 int save_history (std::string snapshot_name = "");
452 int restore_history (std::string snapshot_name);
453 void remove_state (std::string snapshot_name);
454 void rename_state (std::string old_name, std::string new_name);
455 void remove_pending_capture_state ();
456 int rename (const std::string&);
457 bool get_nsm_state () const { return _under_nsm_control; }
458 void set_nsm_state (bool state) { _under_nsm_control = state; }
459 bool save_default_options ();
461 PBD::Signal1<void,std::string> StateSaved;
462 PBD::Signal0<void> StateReady;
464 /* emitted when session needs to be saved due to some internal
465 * event or condition (i.e. not in response to a user request).
467 * Only one object should
468 * connect to this signal and take responsibility.
470 * Argument is the snapshot name to use when saving.
472 PBD::Signal1<void,std::string> SaveSessionRequested;
474 /* emitted during a session save to allow other entities to add state, via
475 * extra XML, to the session state
477 PBD::Signal0<void> SessionSaveUnderway;
479 std::vector<std::string> possible_states() const;
480 static std::vector<std::string> possible_states (std::string path);
482 XMLNode& get_state();
483 int set_state(const XMLNode& node, int version); // not idempotent
484 XMLNode& get_template();
486 /// The instant xml file is written to the session directory
487 void add_instant_xml (XMLNode&, bool write_to_config = true);
488 XMLNode* instant_xml (const std::string& str);
490 enum StateOfTheState {
495 InitialConnecting = 0x8,
500 StateOfTheState state_of_the_state() const { return _state_of_the_state; }
502 class StateProtector {
504 StateProtector (Session* s) : _session (s) {
505 g_atomic_int_inc (&s->_suspend_save);
508 if (g_atomic_int_dec_and_test (&_session->_suspend_save)) {
509 while (_session->_save_queued) {
510 _session->_save_queued = false;
511 _session->save_state ("");
519 void add_route_group (RouteGroup *);
520 void remove_route_group (RouteGroup&);
521 void reorder_route_groups (std::list<RouteGroup*>);
523 RouteGroup* route_group_by_name (std::string);
524 RouteGroup& all_route_group() const;
526 PBD::Signal1<void,RouteGroup*> route_group_added;
527 PBD::Signal0<void> route_group_removed;
528 PBD::Signal0<void> route_groups_reordered;
530 void foreach_route_group (boost::function<void(RouteGroup*)> f) {
531 for (std::list<RouteGroup *>::iterator i = _route_groups.begin(); i != _route_groups.end(); ++i) {
536 std::list<RouteGroup*> const & route_groups () const {
537 return _route_groups;
540 /* fundamental operations. duh. */
542 std::list<boost::shared_ptr<AudioTrack> > new_audio_track (
545 TrackMode mode = Normal,
546 RouteGroup* route_group = 0,
547 uint32_t how_many = 1,
548 std::string name_template = ""
551 RouteList new_audio_route (
552 int input_channels, int output_channels, RouteGroup* route_group, uint32_t how_many, std::string name_template = ""
555 std::list<boost::shared_ptr<MidiTrack> > new_midi_track (
556 const ChanCount& input, const ChanCount& output,
557 boost::shared_ptr<PluginInfo> instrument = boost::shared_ptr<PluginInfo>(),
558 TrackMode mode = Normal,
559 RouteGroup* route_group = 0, uint32_t how_many = 1, std::string name_template = ""
562 void remove_routes (boost::shared_ptr<RouteList>);
563 void remove_route (boost::shared_ptr<Route>);
565 void resort_routes ();
566 void resort_routes_using (boost::shared_ptr<RouteList>);
568 AudioEngine & engine() { return _engine; }
569 AudioEngine const & engine () const { return _engine; }
571 static std::string default_track_name_pattern (DataType);
575 framepos_t transport_frame () const {return _transport_frame; }
576 framepos_t record_location () const {return _last_record_location; }
577 framepos_t audible_frame () const;
578 framepos_t requested_return_frame() const { return _requested_return_frame; }
579 void set_requested_return_frame(framepos_t return_to);
593 void sync_time_vars();
595 void bbt_time (framepos_t when, Timecode::BBT_Time&);
596 void timecode_to_sample(Timecode::Time& timecode, framepos_t& sample, bool use_offset, bool use_subframes) const;
597 void sample_to_timecode(framepos_t sample, Timecode::Time& timecode, bool use_offset, bool use_subframes) const;
598 void timecode_time (Timecode::Time &);
599 void timecode_time (framepos_t when, Timecode::Time&);
600 void timecode_time_subframes (framepos_t when, Timecode::Time&);
602 void timecode_duration (framecnt_t, Timecode::Time&) const;
603 void timecode_duration_string (char *, size_t len, framecnt_t) const;
605 framecnt_t convert_to_frames (AnyTime const & position);
606 framecnt_t any_duration_to_frames (framepos_t position, AnyTime const & duration);
608 static PBD::Signal1<void, framepos_t> StartTimeChanged;
609 static PBD::Signal1<void, framepos_t> EndTimeChanged;
611 void request_sync_source (Slave*);
612 bool synced_to_engine() const { return _slave && config.get_external_sync() && Config->get_sync_source() == Engine; }
613 bool synced_to_mtc () const { return config.get_external_sync() && Config->get_sync_source() == MTC && g_atomic_int_get (const_cast<gint*>(&_mtc_active)); }
614 bool synced_to_ltc () const { return config.get_external_sync() && Config->get_sync_source() == LTC && g_atomic_int_get (const_cast<gint*>(&_ltc_active)); }
616 double transport_speed() const { return _transport_speed; }
617 bool transport_stopped() const { return _transport_speed == 0.0f; }
618 bool transport_rolling() const { return _transport_speed != 0.0f; }
620 bool silent () { return _silent; }
622 TempoMap& tempo_map() { return *_tempo_map; }
623 const TempoMap& tempo_map() const { return *_tempo_map; }
625 unsigned int get_xrun_count () const {return _xrun_count; }
626 void reset_xrun_count () {_xrun_count = 0; }
630 boost::shared_ptr<Region> find_whole_file_parent (boost::shared_ptr<Region const>) const;
632 boost::shared_ptr<Region> XMLRegionFactory (const XMLNode&, bool full);
633 boost::shared_ptr<AudioRegion> XMLAudioRegionFactory (const XMLNode&, bool full);
634 boost::shared_ptr<MidiRegion> XMLMidiRegionFactory (const XMLNode&, bool full);
636 /* source management */
638 void import_files (ImportStatus&);
639 bool sample_rate_convert (ImportStatus&, std::string infile, std::string& outfile);
640 std::string build_tmp_convert_name (std::string file);
642 boost::shared_ptr<ExportHandler> get_export_handler ();
643 boost::shared_ptr<ExportStatus> get_export_status ();
645 int start_audio_export (framepos_t position);
647 PBD::Signal1<int, framecnt_t> ProcessExport;
648 static PBD::Signal2<void,std::string, std::string> Exported;
650 void add_source (boost::shared_ptr<Source>);
651 void remove_source (boost::weak_ptr<Source>);
653 void cleanup_regions();
654 int cleanup_sources (CleanupReport&);
655 int cleanup_trash_sources (CleanupReport&);
657 int destroy_sources (std::list<boost::shared_ptr<Source> >);
659 int remove_last_capture ();
661 /** handlers should return 0 for "everything OK", and any other value for
662 * "cannot setup audioengine".
664 static PBD::Signal1<int,uint32_t> AudioEngineSetupRequired;
666 /** handlers should return -1 for "stop cleanup",
667 0 for "yes, delete this playlist",
668 1 for "no, don't delete this playlist".
670 static PBD::Signal1<int,boost::shared_ptr<Playlist> > AskAboutPlaylistDeletion;
672 /** handlers should return 0 for "ignore the rate mismatch",
673 !0 for "do not use this session"
675 static PBD::Signal2<int, framecnt_t, framecnt_t> AskAboutSampleRateMismatch;
677 /** handlers should return !0 for use pending state, 0 for ignore it.
679 static PBD::Signal0<int> AskAboutPendingState;
681 boost::shared_ptr<AudioFileSource> create_audio_source_for_session (
682 size_t, std::string const &, uint32_t, bool destructive);
684 boost::shared_ptr<MidiSource> create_midi_source_for_session (std::string const &);
685 boost::shared_ptr<MidiSource> create_midi_source_by_stealing_name (boost::shared_ptr<Track>);
687 boost::shared_ptr<Source> source_by_id (const PBD::ID&);
688 boost::shared_ptr<AudioFileSource> audio_source_by_path_and_channel (const std::string&, uint16_t) const;
689 boost::shared_ptr<MidiSource> midi_source_by_path (const std::string&) const;
690 uint32_t count_sources_by_origin (const std::string&);
692 void add_playlist (boost::shared_ptr<Playlist>, bool unused = false);
694 /* Curves and AutomationLists (TODO when they go away) */
695 void add_automation_list(AutomationList*);
699 boost::shared_ptr<Auditioner> the_auditioner() { return auditioner; }
700 void audition_playlist ();
701 void audition_region (boost::shared_ptr<Region>);
702 void cancel_audition ();
703 bool is_auditioning () const;
705 PBD::Signal1<void,bool> AuditionActive;
707 /* flattening stuff */
709 boost::shared_ptr<Region> write_one_track (Track&, framepos_t start, framepos_t end,
710 bool overwrite, std::vector<boost::shared_ptr<Source> >&, InterThreadInfo& wot,
711 boost::shared_ptr<Processor> endpoint,
712 bool include_endpoint, bool for_export, bool for_freeze);
713 int freeze_all (InterThreadInfo&);
715 /* session-wide solo/mute/rec-enable */
717 bool soloing() const { return _non_soloed_outs_muted; }
718 bool listening() const { return _listen_cnt > 0; }
719 bool solo_isolated() const { return _solo_isolated_cnt > 0; }
721 static const SessionEvent::RTeventCallback rt_cleanup;
723 void set_solo (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
724 void set_just_one_solo (boost::shared_ptr<Route>, bool, SessionEvent::RTeventCallback after = rt_cleanup);
725 void cancel_solo_after_disconnect (boost::shared_ptr<Route>, bool upstream, SessionEvent::RTeventCallback after = rt_cleanup);
726 void set_mute (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
727 void set_listen (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
728 void set_record_enabled (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
729 void set_record_safe (boost::shared_ptr<RouteList>, bool yn, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
730 void set_solo_isolated (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
731 void set_monitoring (boost::shared_ptr<RouteList>, MonitorChoice, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
732 void set_exclusive_input_active (boost::shared_ptr<RouteList> rt, bool onoff, bool flip_others=false);
734 PBD::Signal1<void,bool> SoloActive;
735 PBD::Signal0<void> SoloChanged;
736 PBD::Signal0<void> IsolatedChanged;
738 PBD::Signal0<void> session_routes_reconnected;
740 /* monitor/master out */
742 void add_monitor_section ();
743 void reset_monitor_section ();
744 void remove_monitor_section ();
746 boost::shared_ptr<Route> monitor_out() const { return _monitor_out; }
747 boost::shared_ptr<Route> master_out() const { return _master_out; }
749 void globally_add_internal_sends (boost::shared_ptr<Route> dest, Placement p, bool);
750 void globally_set_send_gains_from_track (boost::shared_ptr<Route> dest);
751 void globally_set_send_gains_to_zero (boost::shared_ptr<Route> dest);
752 void globally_set_send_gains_to_unity (boost::shared_ptr<Route> dest);
753 void add_internal_sends (boost::shared_ptr<Route> dest, Placement p, boost::shared_ptr<RouteList> senders);
754 void add_internal_send (boost::shared_ptr<Route>, int, boost::shared_ptr<Route>);
755 void add_internal_send (boost::shared_ptr<Route>, boost::shared_ptr<Processor>, boost::shared_ptr<Route>);
757 static void set_disable_all_loaded_plugins (bool yn) {
758 _disable_all_loaded_plugins = yn;
760 static bool get_disable_all_loaded_plugins() {
761 return _disable_all_loaded_plugins;
764 uint32_t next_send_id();
765 uint32_t next_aux_send_id();
766 uint32_t next_return_id();
767 uint32_t next_insert_id();
768 void mark_send_id (uint32_t);
769 void mark_aux_send_id (uint32_t);
770 void mark_return_id (uint32_t);
771 void mark_insert_id (uint32_t);
772 void unmark_send_id (uint32_t);
773 void unmark_aux_send_id (uint32_t);
774 void unmark_return_id (uint32_t);
775 void unmark_insert_id (uint32_t);
777 /* s/w "RAID" management */
779 boost::optional<framecnt_t> available_capture_duration();
783 void add_bundle (boost::shared_ptr<Bundle>, bool emit_signal = true);
784 void remove_bundle (boost::shared_ptr<Bundle>);
785 boost::shared_ptr<Bundle> bundle_by_name (std::string) const;
787 PBD::Signal0<void> BundleAddedOrRemoved;
791 /* History (for editors, mixers, UIs etc.) */
793 /** Undo some transactions.
794 * @param n Number of transactions to undo.
796 void undo (uint32_t n) {
800 void redo (uint32_t n) {
804 UndoHistory& history() { return _history; }
806 uint32_t undo_depth() const { return _history.undo_depth(); }
807 uint32_t redo_depth() const { return _history.redo_depth(); }
808 std::string next_undo() const { return _history.next_undo(); }
809 std::string next_redo() const { return _history.next_redo(); }
811 void begin_reversible_command (const std::string& cmd_name);
812 void begin_reversible_command (GQuark);
813 void abort_reversible_command ();
814 void commit_reversible_command (Command* cmd = 0);
816 void add_command (Command *const cmd);
818 /** @return The list of operations that are currently in progress */
819 std::list<GQuark> const & current_operations () {
820 return _current_trans_quarks;
823 bool operation_in_progress (GQuark) const;
825 void add_commands (std::vector<Command*> const & cmds);
827 std::map<PBD::ID,PBD::StatefulDestructible*> registry;
829 // these commands are implemented in libs/ardour/session_command.cc
830 Command* memento_command_factory(XMLNode* n);
831 Command* stateful_diff_command_factory (XMLNode *);
832 void register_with_memento_command_factory(PBD::ID, PBD::StatefulDestructible*);
836 boost::shared_ptr<IO> click_io() { return _click_io; }
837 boost::shared_ptr<Amp> click_gain() { return _click_gain; }
839 /* disk, buffer loads */
841 uint32_t playback_load ();
842 uint32_t capture_load ();
846 void request_play_range (std::list<AudioRange>*, bool leave_rolling = false);
847 void request_cancel_play_range ();
848 bool get_play_range () const { return _play_range; }
850 void maybe_update_session_range (framepos_t, framepos_t);
852 /* temporary hacks to allow selection to be pushed from GUI into backend.
853 Whenever we move the selection object into libardour, these will go away.
855 void set_range_selection (framepos_t start, framepos_t end);
856 void set_object_selection (framepos_t start, framepos_t end);
857 void clear_range_selection ();
858 void clear_object_selection ();
860 /* buffers for gain and pan */
862 gain_t* gain_automation_buffer () const;
863 gain_t* trim_automation_buffer () const;
864 gain_t* send_gain_automation_buffer () const;
865 pan_t** pan_automation_buffer () const;
867 void ensure_buffer_set (BufferSet& buffers, const ChanCount& howmany);
871 static int vst_current_loading_id;
872 static const char* vst_can_do_strings[];
873 static const int vst_can_do_string_count;
875 static intptr_t vst_callback (
884 static PBD::Signal0<void> SendFeedback;
888 boost::shared_ptr<Speakers> get_speakers ();
892 boost::shared_ptr<PBD::Controllable> controllable_by_id (const PBD::ID&);
893 boost::shared_ptr<PBD::Controllable> controllable_by_descriptor (const PBD::ControllableDescriptor&);
895 void add_controllable (boost::shared_ptr<PBD::Controllable>);
896 void remove_controllable (PBD::Controllable*);
898 boost::shared_ptr<PBD::Controllable> solo_cut_control() const;
900 SessionConfiguration config;
902 bool exporting () const {
906 bool bounce_processing() const {
907 return _bounce_processing_active;
910 /* this is a private enum, but setup_enum_writer() needs it,
911 and i can't find a way to give that function
915 enum PostTransportWork {
916 PostTransportStop = 0x1,
917 PostTransportDuration = 0x2,
918 PostTransportLocate = 0x4,
919 PostTransportRoll = 0x8,
920 PostTransportAbort = 0x10,
921 PostTransportOverWrite = 0x20,
922 PostTransportSpeed = 0x40,
923 PostTransportAudition = 0x80,
924 PostTransportReverse = 0x100,
925 PostTransportInputChange = 0x200,
926 PostTransportCurveRealloc = 0x400,
927 PostTransportClearSubstate = 0x800,
928 PostTransportAdjustPlaybackBuffering = 0x1000,
929 PostTransportAdjustCaptureBuffering = 0x2000
938 SlaveState slave_state() const { return _slave_state; }
939 Slave* slave() const { return _slave; }
941 boost::shared_ptr<SessionPlaylists> playlists;
943 void send_mmc_locate (framepos_t);
944 void queue_full_time_code () { _send_timecode_update = true; }
945 void queue_song_position_pointer () { /* currently does nothing */ }
947 bool step_editing() const { return (_step_editors > 0); }
949 void request_suspend_timecode_transmission ();
950 void request_resume_timecode_transmission ();
951 bool timecode_transmission_suspended () const;
953 std::vector<std::string> source_search_path(DataType) const;
954 void ensure_search_path_includes (const std::string& path, DataType type);
955 void remove_dir_from_search_path (const std::string& path, DataType type);
957 std::list<std::string> unknown_processors () const;
959 /** Emitted when a feedback cycle has been detected within Ardour's signal
960 processing path. Until it is fixed (by the user) some (unspecified)
961 routes will not be run.
963 static PBD::Signal0<void> FeedbackDetected;
965 /** Emitted when a graph sort has successfully completed, which means
966 that it has no feedback cycles.
968 static PBD::Signal0<void> SuccessfulGraphSort;
970 /* handlers can return an integer value:
971 0: config.set_audio_search_path() or config.set_midi_search_path() was used
972 to modify the search path and we should try to find it again.
973 1: quit entire session load
974 2: as 0, but don't ask about other missing files
975 3: don't ask about other missing files, and just mark this one missing
976 -1: just mark this one missing
977 any other value: as -1
979 static PBD::Signal3<int,Session*,std::string,DataType> MissingFile;
981 /** Emitted when the session wants Ardour to quit */
982 static PBD::Signal0<void> Quit;
984 /** Emitted when Ardour is asked to load a session in an older session
985 * format, and makes a backup copy.
987 static PBD::Signal2<void,std::string,std::string> VersionMismatch;
989 SceneChanger* scene_changer() const { return _scene_changer; }
991 boost::shared_ptr<Port> ltc_input_port() const;
992 boost::shared_ptr<Port> ltc_output_port() const;
994 boost::shared_ptr<IO> ltc_input_io() { return _ltc_input; }
995 boost::shared_ptr<IO> ltc_output_io() { return _ltc_output; }
997 MIDI::Port* midi_input_port () const;
998 MIDI::Port* midi_output_port () const;
999 MIDI::Port* mmc_output_port () const;
1000 MIDI::Port* mmc_input_port () const;
1002 MIDI::Port* scene_input_port () const;
1003 MIDI::Port* scene_output_port () const;
1005 boost::shared_ptr<MidiPort> scene_in () const;
1006 boost::shared_ptr<MidiPort> scene_out () const;
1008 boost::shared_ptr<MidiPort> midi_clock_output_port () const;
1009 boost::shared_ptr<MidiPort> midi_clock_input_port () const;
1010 boost::shared_ptr<MidiPort> mtc_output_port () const;
1011 boost::shared_ptr<MidiPort> mtc_input_port () const;
1013 MIDI::MachineControl& mmc() { return *_mmc; }
1015 void reconnect_midi_scene_ports (bool);
1016 void reconnect_mtc_ports ();
1017 void reconnect_mmc_ports (bool);
1019 void reconnect_ltc_input ();
1020 void reconnect_ltc_output ();
1023 friend class AudioEngine;
1024 void set_block_size (pframes_t nframes);
1025 void set_frame_rate (framecnt_t nframes);
1026 void reconnect_existing_routes (bool withLock, bool reconnect_master = true, bool reconnect_inputs = true, bool reconnect_outputs = true);
1030 void schedule_curve_reallocation ();
1031 void update_latency_compensation (bool force = false);
1034 int create (const std::string& mix_template, BusProfile*);
1038 PendingDeclickIn = 0x1, ///< pending de-click fade-in for start
1039 PendingDeclickOut = 0x2, ///< pending de-click fade-out for stop
1040 StopPendingCapture = 0x4,
1041 PendingLoopDeclickIn = 0x8, ///< pending de-click fade-in at the start of a loop
1042 PendingLoopDeclickOut = 0x10, ///< pending de-click fade-out at the end of a loop
1043 PendingLocate = 0x20,
1046 /* stuff used in process() should be close together to
1050 typedef void (Session::*process_function_type)(pframes_t);
1052 AudioEngine& _engine;
1053 mutable gint processing_prohibited;
1054 process_function_type process_function;
1055 process_function_type last_process_function;
1056 bool _bounce_processing_active;
1057 bool waiting_for_sync_offset;
1058 framecnt_t _base_frame_rate;
1059 framecnt_t _current_frame_rate; //this includes video pullup offset
1060 framecnt_t _nominal_frame_rate; //ignores audioengine setting, "native" SR
1061 int transport_sub_state;
1062 mutable gint _record_status;
1063 framepos_t _transport_frame;
1064 Location* _session_range_location; ///< session range, or 0 if there is nothing in the session yet
1068 // varispeed playback
1069 double _transport_speed;
1070 double _default_transport_speed;
1071 double _last_transport_speed;
1072 double _signalled_varispeed;
1073 double _target_transport_speed;
1074 CubicInterpolation interpolation;
1076 bool auto_play_legal;
1077 framepos_t _last_slave_transport_frame;
1078 framecnt_t maximum_output_latency;
1079 framepos_t _requested_return_frame;
1080 pframes_t current_block_size;
1081 framecnt_t _worst_output_latency;
1082 framecnt_t _worst_input_latency;
1083 framecnt_t _worst_track_latency;
1084 bool _have_captured;
1085 bool _non_soloed_outs_muted;
1086 uint32_t _listen_cnt;
1087 uint32_t _solo_isolated_cnt;
1090 bool _under_nsm_control;
1091 unsigned int _xrun_count;
1093 void mtc_status_changed (bool);
1094 PBD::ScopedConnection mtc_status_connection;
1095 void ltc_status_changed (bool);
1096 PBD::ScopedConnection ltc_status_connection;
1098 void initialize_latencies ();
1099 void set_worst_io_latencies ();
1100 void set_worst_playback_latency ();
1101 void set_worst_capture_latency ();
1102 void set_worst_io_latencies_x (IOChange, void *) {
1103 set_worst_io_latencies ();
1105 void post_capture_latency ();
1106 void post_playback_latency ();
1108 void update_latency_compensation_proxy (void* ignored);
1110 void ensure_buffers (ChanCount howmany = ChanCount::ZERO);
1112 void process_scrub (pframes_t);
1113 void process_without_events (pframes_t);
1114 void process_with_events (pframes_t);
1115 void process_audition (pframes_t);
1116 int process_export (pframes_t);
1117 int process_export_fw (pframes_t);
1119 void block_processing() { g_atomic_int_set (&processing_prohibited, 1); }
1120 void unblock_processing() { g_atomic_int_set (&processing_prohibited, 0); }
1121 bool processing_blocked() const { return g_atomic_int_get (&processing_prohibited); }
1123 static const framecnt_t bounce_chunk_size;
1125 /* slave tracking */
1127 static const int delta_accumulator_size = 25;
1128 int delta_accumulator_cnt;
1129 int32_t delta_accumulator[delta_accumulator_size];
1130 int32_t average_slave_delta;
1132 bool have_first_delta_accumulator;
1134 SlaveState _slave_state;
1137 framepos_t slave_wait_end;
1139 void reset_slave_state ();
1140 bool follow_slave (pframes_t);
1141 void calculate_moving_average_of_slave_delta (int dir, framecnt_t this_delta);
1142 void track_slave_state (float slave_speed, framepos_t slave_transport_frame, framecnt_t this_delta);
1143 void follow_slave_silently (pframes_t nframes, float slave_speed);
1145 void switch_to_sync_source (SyncSource); /* !RT context */
1146 void drop_sync_source (); /* !RT context */
1147 void use_sync_source (Slave*); /* RT context */
1149 bool post_export_sync;
1150 framepos_t post_export_position;
1153 bool _export_started;
1154 bool _export_rolling;
1156 boost::shared_ptr<ExportHandler> export_handler;
1157 boost::shared_ptr<ExportStatus> export_status;
1160 int stop_audio_export ();
1161 void finalize_audio_export ();
1162 void finalize_export_internal (bool stop_freewheel);
1163 bool _pre_export_mmc_enabled;
1165 PBD::ScopedConnection export_freewheel_connection;
1167 void get_track_statistics ();
1168 int process_routes (pframes_t, bool& need_butler);
1169 int silent_process_routes (pframes_t, bool& need_butler);
1171 /** @return 1 if there is a pending declick fade-in,
1172 -1 if there is a pending declick fade-out,
1173 0 if there is no pending declick.
1175 int get_transport_declick_required () {
1176 if (transport_sub_state & PendingDeclickIn) {
1177 transport_sub_state &= ~PendingDeclickIn;
1179 } else if (transport_sub_state & PendingDeclickOut) {
1180 /* XXX: not entirely sure why we don't clear this */
1182 } else if (transport_sub_state & PendingLoopDeclickOut) {
1183 /* Return the declick out first ... */
1184 transport_sub_state &= ~PendingLoopDeclickOut;
1186 } else if (transport_sub_state & PendingLoopDeclickIn) {
1187 /* ... then the declick in on the next call */
1188 transport_sub_state &= ~PendingLoopDeclickIn;
1195 bool maybe_stop (framepos_t limit);
1196 bool maybe_sync_start (pframes_t &);
1198 void check_declick_out ();
1204 /** Number of process frames since the last MTC output (when sending MTC); used to
1205 * know when to send full MTC messages every so often.
1207 pframes_t _pframes_since_last_mtc;
1208 bool session_midi_feedback;
1211 framepos_t last_loopend;
1213 boost::scoped_ptr<SessionDirectory> _session_dir;
1216 void graph_reordered ();
1218 /** current snapshot name, without the .ardour suffix */
1219 std::string _current_snapshot_name;
1221 XMLTree* state_tree;
1222 bool state_was_pending;
1223 StateOfTheState _state_of_the_state;
1225 friend class StateProtector;
1226 gint _suspend_save; /* atomic */
1227 volatile bool _save_queued;
1228 Glib::Threads::Mutex save_state_lock;
1230 int load_options (const XMLNode&);
1231 int load_state (std::string snapshot_name);
1233 framepos_t _last_roll_location;
1234 /** the session frame time at which we last rolled, located, or changed transport direction */
1235 framepos_t _last_roll_or_reversal_location;
1236 framepos_t _last_record_location;
1238 bool pending_locate_roll;
1239 framepos_t pending_locate_frame;
1240 bool pending_locate_flush;
1242 bool pending_auto_loop;
1246 static const PostTransportWork ProcessCannotProceedMask =
1248 PostTransportInputChange|
1250 PostTransportReverse|
1251 PostTransportCurveRealloc|
1252 PostTransportAudition|
1253 PostTransportLocate|
1255 PostTransportClearSubstate);
1257 gint _post_transport_work; /* accessed only atomic ops */
1258 PostTransportWork post_transport_work() const { return (PostTransportWork) g_atomic_int_get (const_cast<gint*>(&_post_transport_work)); }
1259 void set_post_transport_work (PostTransportWork ptw) { g_atomic_int_set (&_post_transport_work, (gint) ptw); }
1260 void add_post_transport_work (PostTransportWork ptw);
1262 void schedule_playback_buffering_adjustment ();
1263 void schedule_capture_buffering_adjustment ();
1265 uint32_t cumulative_rf_motion;
1268 void set_rf_speed (float speed);
1269 void reset_rf_scale (framecnt_t frames_moved);
1271 Locations* _locations;
1272 void location_added (Location*);
1273 void location_removed (Location*);
1274 void locations_changed ();
1275 void _locations_changed (const Locations::LocationList&);
1277 void update_skips (Location*, bool consolidate);
1278 void update_marks (Location* loc);
1279 void consolidate_skips (Location*);
1280 void sync_locations_to_skips ();
1281 void _sync_locations_to_skips ();
1283 PBD::ScopedConnectionList skip_update_connections;
1284 bool _ignore_skips_updates;
1286 PBD::ScopedConnectionList punch_connections;
1287 void auto_punch_start_changed (Location *);
1288 void auto_punch_end_changed (Location *);
1289 void auto_punch_changed (Location *);
1291 PBD::ScopedConnectionList loop_connections;
1292 void auto_loop_changed (Location *);
1293 void auto_loop_declick_range (Location *, framepos_t &, framepos_t &);
1295 int ensure_engine (uint32_t desired_sample_rate);
1296 void pre_engine_init (std::string path);
1297 int post_engine_init ();
1298 int immediately_post_engine ();
1299 void remove_empty_sounds ();
1301 void session_loaded ();
1303 void setup_midi_control ();
1304 int midi_read (MIDI::Port *);
1306 void enable_record ();
1308 void increment_transport_position (framecnt_t val) {
1309 if (max_framepos - val < _transport_frame) {
1310 _transport_frame = max_framepos;
1312 _transport_frame += val;
1316 void decrement_transport_position (framecnt_t val) {
1317 if (val < _transport_frame) {
1318 _transport_frame -= val;
1320 _transport_frame = 0;
1324 void post_transport_motion ();
1325 static void *session_loader_thread (void *arg);
1329 /* Signal Forwarding */
1330 void emit_route_signals ();
1331 void emit_thread_run ();
1332 static void *emit_thread (void *);
1333 void emit_thread_start ();
1334 void emit_thread_terminate ();
1336 pthread_t _rt_emit_thread;
1337 bool _rt_thread_active;
1339 pthread_mutex_t _rt_emit_mutex;
1340 pthread_cond_t _rt_emit_cond;
1341 bool _rt_emit_pending;
1344 /* SessionEventManager interface */
1346 void process_event (SessionEvent*);
1347 void set_next_event ();
1348 void cleanup_event (SessionEvent*,int);
1350 /* MIDI Machine Control */
1353 void spp_continue ();
1356 void mmc_deferred_play (MIDI::MachineControl &);
1357 void mmc_stop (MIDI::MachineControl &);
1358 void mmc_step (MIDI::MachineControl &, int);
1359 void mmc_pause (MIDI::MachineControl &);
1360 void mmc_record_pause (MIDI::MachineControl &);
1361 void mmc_record_strobe (MIDI::MachineControl &);
1362 void mmc_record_exit (MIDI::MachineControl &);
1363 void mmc_track_record_status (MIDI::MachineControl &, uint32_t track, bool enabled);
1364 void mmc_fast_forward (MIDI::MachineControl &);
1365 void mmc_rewind (MIDI::MachineControl &);
1366 void mmc_locate (MIDI::MachineControl &, const MIDI::byte *);
1367 void mmc_shuttle (MIDI::MachineControl &mmc, float speed, bool forw);
1368 void mmc_record_enable (MIDI::MachineControl &mmc, size_t track, bool enabled);
1370 struct timeval last_mmc_step;
1373 typedef boost::function<bool()> MidiTimeoutCallback;
1374 typedef std::list<MidiTimeoutCallback> MidiTimeoutList;
1376 MidiTimeoutList midi_timeouts;
1377 bool mmc_step_timeout ();
1378 void send_immediate_mmc (MIDI::MachineControlCommand);
1380 MIDI::byte mtc_msg[16];
1381 MIDI::byte mtc_timecode_bits; /* encoding of SMTPE type for MTC */
1382 MIDI::byte midi_msg[16];
1383 double outbound_mtc_timecode_frame;
1384 Timecode::Time transmitting_timecode_time;
1385 int next_quarter_frame_to_send;
1387 double _frames_per_timecode_frame; /* has to be floating point because of drop frame */
1388 framecnt_t _frames_per_hour;
1389 framecnt_t _timecode_frames_per_hour;
1391 /* cache the most-recently requested time conversions. This helps when we
1392 * have multiple clocks showing the same time (e.g. the transport frame) */
1393 bool last_timecode_valid;
1394 framepos_t last_timecode_when;
1395 Timecode::Time last_timecode;
1397 bool _send_timecode_update; ///< Flag to send a full frame (Timecode) MTC message this cycle
1399 int send_midi_time_code_for_cycle (framepos_t, framepos_t, pframes_t nframes);
1401 LTCEncoder* ltc_encoder;
1402 ltcsnd_sample_t* ltc_enc_buf;
1404 Timecode::TimecodeFormat ltc_enc_tcformat;
1405 int32_t ltc_buf_off;
1406 int32_t ltc_buf_len;
1409 int32_t ltc_enc_byte;
1410 framepos_t ltc_enc_pos;
1412 framepos_t ltc_enc_off;
1414 framepos_t ltc_prev_cycle;
1416 framepos_t ltc_timecode_offset;
1417 bool ltc_timecode_negative_offset;
1419 LatencyRange ltc_out_latency;
1421 void ltc_tx_initialize();
1422 void ltc_tx_cleanup();
1423 void ltc_tx_reset();
1424 void ltc_tx_resync_latency();
1425 void ltc_tx_recalculate_position();
1426 void ltc_tx_parse_offset();
1427 void ltc_tx_send_time_code_for_cycle (framepos_t, framepos_t, double, double, pframes_t nframes);
1429 void reset_record_status ();
1431 int no_roll (pframes_t nframes);
1432 int fail_roll (pframes_t nframes);
1434 bool non_realtime_work_pending() const { return static_cast<bool>(post_transport_work()); }
1435 bool process_can_proceed() const { return !(post_transport_work() & ProcessCannotProceedMask); }
1437 MidiControlUI* midi_control_ui;
1439 int start_midi_thread ();
1441 void set_play_loop (bool yn, double speed);
1442 void unset_play_loop ();
1443 void overwrite_some_buffers (Track *);
1444 void flush_all_inserts ();
1445 int micro_locate (framecnt_t distance);
1446 void locate (framepos_t, bool with_roll, bool with_flush, bool with_loop=false, bool force=false, bool with_mmc=true);
1447 void start_locate (framepos_t, bool with_roll, bool with_flush, bool with_loop=false, bool force=false);
1448 void force_locate (framepos_t frame, bool with_roll = false);
1449 void set_track_speed (Track *, double speed);
1450 void set_transport_speed (double speed, framepos_t destination_frame, bool abort = false, bool clear_state = false, bool as_default = false);
1451 void stop_transport (bool abort = false, bool clear_state = false);
1452 void start_transport ();
1453 void realtime_stop (bool abort, bool clear_state);
1454 void realtime_locate ();
1455 void non_realtime_start_scrub ();
1456 void non_realtime_set_speed ();
1457 void non_realtime_locate ();
1458 void non_realtime_stop (bool abort, int entry_request_count, bool& finished);
1459 void non_realtime_overwrite (int entry_request_count, bool& finished);
1460 void post_transport ();
1461 void engine_halted ();
1462 void xrun_recovery ();
1463 void set_track_loop (bool);
1464 bool select_playhead_priority_target (framepos_t&);
1465 void follow_playhead_priority ();
1467 /* These are synchronous and so can only be called from within the process
1471 int send_full_time_code (framepos_t, pframes_t nframes);
1472 void send_song_position_pointer (framepos_t);
1474 TempoMap *_tempo_map;
1475 void tempo_map_changed (const PBD::PropertyChange&);
1477 /* edit/mix groups */
1479 int load_route_groups (const XMLNode&, int);
1481 std::list<RouteGroup *> _route_groups;
1482 RouteGroup* _all_route_group;
1486 boost::shared_ptr<Graph> _process_graph;
1488 SerializedRCUManager<RouteList> routes;
1490 void add_routes (RouteList&, bool input_auto_connect, bool output_auto_connect, bool save);
1491 void add_routes_inner (RouteList&, bool input_auto_connect, bool output_auto_connect);
1492 bool _adding_routes_in_progress;
1493 bool _reconnecting_routes_in_progress;
1494 bool _route_deletion_in_progress;
1496 uint32_t destructive_index;
1498 boost::shared_ptr<Route> XMLRouteFactory (const XMLNode&, int);
1499 boost::shared_ptr<Route> XMLRouteFactory_2X (const XMLNode&, int);
1501 void route_processors_changed (RouteProcessorChange);
1503 bool find_route_name (std::string const &, uint32_t& id, std::string& name, bool);
1504 void count_existing_track_channels (ChanCount& in, ChanCount& out);
1505 void auto_connect_route (boost::shared_ptr<Route> route, ChanCount& existing_inputs, ChanCount& existing_outputs,
1506 bool with_lock, bool connect_inputs = true,
1507 ChanCount input_start = ChanCount (), ChanCount output_start = ChanCount ());
1508 void midi_output_change_handler (IOChange change, void* /*src*/, boost::weak_ptr<Route> midi_track);
1510 /* track numbering */
1512 void reassign_track_numbers ();
1513 uint32_t _track_number_decimals;
1517 bool solo_update_disabled;
1519 void route_listen_changed (void *src, boost::weak_ptr<Route>);
1520 void route_mute_changed (void *src);
1521 void route_solo_changed (bool self_solo_change, void *src, boost::weak_ptr<Route>);
1522 void routes_solo_changed (boost::shared_ptr<RouteList> solo_change_routes);
1523 void route_solo_isolated_changed (void *src, boost::weak_ptr<Route>);
1524 void update_route_solo_state (boost::shared_ptr<RouteList> r = boost::shared_ptr<RouteList>());
1526 void listen_position_changed ();
1527 void solo_control_mode_changed ();
1529 /* REGION MANAGEMENT */
1531 mutable Glib::Threads::Mutex region_lock;
1533 int load_regions (const XMLNode& node);
1534 int load_compounds (const XMLNode& node);
1536 void route_added_to_route_group (RouteGroup *, boost::weak_ptr<Route>);
1537 void route_removed_from_route_group (RouteGroup *, boost::weak_ptr<Route>);
1538 void route_group_property_changed (RouteGroup *);
1542 mutable Glib::Threads::Mutex source_lock;
1545 typedef std::map<PBD::ID,boost::shared_ptr<Source> > SourceMap;
1548 void reset_write_sources (bool mark_write_complete, bool force = false);
1553 int load_sources (const XMLNode& node);
1554 XMLNode& get_sources_as_xml ();
1556 boost::shared_ptr<Source> XMLSourceFactory (const XMLNode&);
1560 void remove_playlist (boost::weak_ptr<Playlist>);
1561 void track_playlist_changed (boost::weak_ptr<Track>);
1562 void playlist_region_added (boost::weak_ptr<Region>);
1563 void playlist_ranges_moved (std::list<Evoral::RangeMove<framepos_t> > const &);
1564 void playlist_regions_extended (std::list<Evoral::Range<framepos_t> > const &);
1566 /* CURVES and AUTOMATION LISTS */
1567 std::map<PBD::ID, AutomationList*> automation_lists;
1569 /* DEFAULT FADE CURVES */
1571 float default_fade_steepness;
1572 float default_fade_msecs;
1576 boost::shared_ptr<Auditioner> auditioner;
1577 void set_audition (boost::shared_ptr<Region>);
1578 void non_realtime_set_audition ();
1579 boost::shared_ptr<Region> pending_audition_region;
1585 int flatten_one_track (AudioTrack&, framepos_t start, framecnt_t cnt);
1587 /* INSERT AND SEND MANAGEMENT */
1589 boost::dynamic_bitset<uint32_t> send_bitset;
1590 boost::dynamic_bitset<uint32_t> aux_send_bitset;
1591 boost::dynamic_bitset<uint32_t> return_bitset;
1592 boost::dynamic_bitset<uint32_t> insert_bitset;
1596 struct space_and_path {
1597 uint32_t blocks; ///< 4kB blocks
1598 bool blocks_unknown; ///< true if blocks is unknown
1603 , blocks_unknown (true)
1607 struct space_and_path_ascending_cmp {
1608 bool operator() (space_and_path a, space_and_path b) {
1609 if (a.blocks_unknown != b.blocks_unknown) {
1610 return !a.blocks_unknown;
1612 return a.blocks > b.blocks;
1616 void setup_raid_path (std::string path);
1618 std::vector<space_and_path> session_dirs;
1619 std::vector<space_and_path>::iterator last_rr_session_dir;
1620 uint32_t _total_free_4k_blocks;
1621 /** If this is true, _total_free_4k_blocks is not definite,
1622 as one or more of the session directories' filesystems
1623 could not report free space.
1625 bool _total_free_4k_blocks_uncertain;
1626 Glib::Threads::Mutex space_lock;
1628 bool no_questions_about_missing_files;
1630 std::string get_best_session_directory_for_new_audio ();
1632 mutable gint _playback_load;
1633 mutable gint _capture_load;
1637 SerializedRCUManager<BundleList> _bundles;
1638 XMLNode* _bundle_xml_node;
1639 int load_bundles (XMLNode const &);
1641 UndoHistory _history;
1642 /** current undo transaction, or 0 */
1643 UndoTransaction* _current_trans;
1644 /** GQuarks to describe the reversible commands that are currently in progress.
1645 * These may be nested, in which case more recently-started commands are toward
1646 * the front of the list.
1648 std::list<GQuark> _current_trans_quarks;
1650 int backend_sync_callback (TransportState, framepos_t);
1652 void process_rtop (SessionEvent*);
1654 void update_latency (bool playback);
1656 XMLNode& state(bool);
1659 typedef std::list<Click*> Clicks;
1662 boost::shared_ptr<IO> _click_io;
1663 boost::shared_ptr<Amp> _click_gain;
1665 Sample* click_emphasis_data;
1666 framecnt_t click_length;
1667 framecnt_t click_emphasis_length;
1668 mutable Glib::Threads::RWLock click_lock;
1670 static const Sample default_click[];
1671 static const framecnt_t default_click_length;
1672 static const Sample default_click_emphasis[];
1673 static const framecnt_t default_click_emphasis_length;
1676 framepos_t _clicks_cleared;
1677 void setup_click_sounds (int which);
1678 void setup_click_sounds (Sample**, Sample const *, framecnt_t*, framecnt_t, std::string const &);
1679 void clear_clicks ();
1680 void click (framepos_t start, framecnt_t nframes);
1682 std::vector<Route*> master_outs;
1684 /* range playback */
1686 std::list<AudioRange> current_audio_range;
1688 void set_play_range (std::list<AudioRange>&, bool leave_rolling);
1689 void unset_play_range ();
1691 /* temporary hacks to allow selection to be pushed from GUI into backend
1692 Whenever we move the selection object into libardour, these will go away.
1694 Evoral::Range<framepos_t> _range_selection;
1695 Evoral::Range<framepos_t> _object_selection;
1700 boost::shared_ptr<Route> _master_out;
1701 boost::shared_ptr<Route> _monitor_out;
1703 void auto_connect_master_bus ();
1705 /* Windows VST support */
1707 long _windows_vst_callback (
1716 int find_all_sources (std::string path, std::set<std::string>& result);
1717 int find_all_sources_across_snapshots (std::set<std::string>& result, bool exclude_this_snapshot);
1719 typedef std::set<boost::shared_ptr<PBD::Controllable> > Controllables;
1720 Glib::Threads::Mutex controllables_lock;
1721 Controllables controllables;
1723 boost::shared_ptr<PBD::Controllable> _solo_cut_control;
1725 void reset_native_file_format();
1726 bool first_file_data_format_reset;
1727 bool first_file_header_format_reset;
1729 void config_changed (std::string, bool);
1731 XMLNode& get_control_protocol_state ();
1733 void set_history_depth (uint32_t depth);
1735 static bool _disable_all_loaded_plugins;
1737 mutable bool have_looped; ///< Used in ::audible_frame(*)
1739 void update_route_record_state ();
1740 gint _have_rec_enabled_track;
1741 gint _have_rec_disabled_track;
1743 static int ask_about_playlist_deletion (boost::shared_ptr<Playlist>);
1745 /* realtime "apply to set of routes" operations */
1746 template<typename T> SessionEvent*
1747 get_rt_event (boost::shared_ptr<RouteList> rl, T targ, SessionEvent::RTeventCallback after, bool group_override,
1748 void (Session::*method) (boost::shared_ptr<RouteList>, T, bool)) {
1749 SessionEvent* ev = new SessionEvent (SessionEvent::RealTimeOperation, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
1750 ev->rt_slot = boost::bind (method, this, rl, targ, group_override);
1751 ev->rt_return = after;
1752 ev->event_loop = PBD::EventLoop::get_event_loop_for_thread ();
1757 void rt_cancel_solo_after_disconnect (boost::shared_ptr<RouteList>, bool upstream, bool /* ignored*/ );
1758 void rt_set_solo (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1759 void rt_set_just_one_solo (boost::shared_ptr<RouteList>, bool yn, bool /* ignored*/ );
1760 void rt_set_mute (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1761 void rt_set_listen (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1762 void rt_set_solo_isolated (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1763 void rt_set_record_enabled (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1764 void rt_set_record_safe (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1765 void rt_set_monitoring (boost::shared_ptr<RouteList>, MonitorChoice, bool group_override);
1767 /** temporary list of Diskstreams used only during load of 2.X sessions */
1768 std::list<boost::shared_ptr<Diskstream> > _diskstreams_2X;
1770 void set_session_range_location (framepos_t, framepos_t);
1772 void setup_midi_machine_control ();
1774 void step_edit_status_change (bool);
1775 uint32_t _step_editors;
1777 /** true if timecode transmission by the transport is suspended, otherwise false */
1778 mutable gint _suspend_timecode_transmission;
1780 void update_locations_after_tempo_map_change (const Locations::LocationList &);
1782 void start_time_changed (framepos_t);
1783 void end_time_changed (framepos_t);
1785 void set_track_monitor_input_status (bool);
1786 framepos_t compute_stop_limit () const;
1788 boost::shared_ptr<Speakers> _speakers;
1789 void load_nested_sources (const XMLNode& node);
1791 /** The directed graph of routes that is currently being used for audio processing
1792 and solo/mute computations.
1794 GraphEdges _current_route_graph;
1796 uint32_t next_control_id () const;
1797 int32_t _order_hint;
1798 bool ignore_route_processor_changes;
1800 MidiClockTicker* midi_clock;
1802 boost::shared_ptr<IO> _ltc_input;
1803 boost::shared_ptr<IO> _ltc_output;
1805 /* Scene Changing */
1806 SceneChanger* _scene_changer;
1808 /* persistent, non-track related MIDI ports */
1809 MidiPortManager* _midi_ports;
1810 MIDI::MachineControl* _mmc;
1813 void setup_click ();
1814 void setup_click_state (const XMLNode*);
1815 void setup_bundles ();
1817 void save_as_bring_callback (uint32_t, uint32_t, std::string);
1819 static int get_session_info_from_path (XMLTree& state_tree, const std::string& xmlpath);
1820 static const uint32_t session_end_shift;
1824 } // namespace ARDOUR
1826 #endif /* __ardour_session_h__ */