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"
52 #include "timecode/time.h"
54 #include "ardour/ardour.h"
55 #include "ardour/chan_count.h"
56 #include "ardour/delivery.h"
57 #include "ardour/interthread_info.h"
58 #include "ardour/rc_configuration.h"
59 #include "ardour/session_configuration.h"
60 #include "ardour/session_event.h"
61 #include "ardour/location.h"
62 #include "ardour/interpolation.h"
63 #include "ardour/route_graph.h"
69 typedef struct _AEffect AEffect;
79 class ControllableDescriptor;
90 class AudioFileSource;
108 class MidiClockTicker;
110 class MidiPortManager;
129 class SessionDirectory;
130 class SessionMetadata;
131 class SessionPlaylists;
137 class WindowsVSTPlugin;
139 extern void setup_enum_writer ();
141 class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::ScopedConnectionList, public SessionEventManager
150 /* a new session might have non-empty mix_template, an existing session should always have an empty one.
151 the bus profile can be null if no master out bus is required.
154 Session (AudioEngine&,
155 const std::string& fullpath,
156 const std::string& snapshot_name,
157 BusProfile* bus_profile = 0,
158 std::string mix_template = "");
162 static int get_info_from_path (const std::string& xmlpath, float& sample_rate, SampleFormat& data_format);
164 std::string path() const { return _path; }
165 std::string name() const { return _name; }
166 std::string snap_name() const { return _current_snapshot_name; }
167 std::string raid_path () const;
168 bool path_is_within_session (const std::string&);
170 void set_snap_name ();
172 bool writable() const { return _writable; }
175 bool dirty() const { return _state_of_the_state & Dirty; }
176 void set_deletion_in_progress ();
177 void clear_deletion_in_progress ();
178 bool deletion_in_progress() const { return _state_of_the_state & Deletion; }
179 PBD::Signal0<void> DirtyChanged;
181 const SessionDirectory& session_directory () const { return *(_session_dir.get()); }
183 static PBD::Signal1<void,std::string> Dialog;
185 int ensure_subdirs ();
187 std::string automation_dir () const; ///< Automation data
188 std::string analysis_dir () const; ///< Analysis data
189 std::string plugins_dir () const; ///< Plugin state
190 std::string externals_dir () const; ///< Links to external files
192 std::string peak_path (std::string) const;
194 std::string peak_path_from_audio_path (std::string) const;
195 bool audio_source_name_is_unique (const std::string& name, uint32_t chan);
196 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);
197 std::string new_audio_source_path_for_embedded (const std::string& existing_path);
198 std::string new_audio_source_path (const std::string&, uint32_t nchans, uint32_t chan, bool destructive, bool take_required);
199 std::string new_midi_source_path (const std::string&);
200 RouteList new_route_from_template (uint32_t how_many, const std::string& template_path, const std::string& name);
201 std::vector<std::string> get_paths_for_new_sources (bool allow_replacing, const std::string& import_file_path, uint32_t channels);
203 int bring_all_sources_into_session (boost::function<void(uint32_t,uint32_t,std::string)> callback);
205 void process (pframes_t nframes);
207 BufferSet& get_silent_buffers (ChanCount count = ChanCount::ZERO);
208 BufferSet& get_scratch_buffers (ChanCount count = ChanCount::ZERO, bool silence = true );
209 BufferSet& get_route_buffers (ChanCount count = ChanCount::ZERO, bool silence = true);
210 BufferSet& get_mix_buffers (ChanCount count = ChanCount::ZERO);
212 bool have_rec_enabled_track () const;
214 bool have_captured() const { return _have_captured; }
216 void refill_all_track_buffers ();
217 Butler* butler() { return _butler; }
218 void butler_transport_work ();
220 void refresh_disk_space ();
222 int load_diskstreams_2X (XMLNode const &, int);
224 int load_routes (const XMLNode&, int);
225 boost::shared_ptr<RouteList> get_routes() const {
226 return routes.reader ();
229 boost::shared_ptr<RouteList> get_tracks() const;
230 boost::shared_ptr<RouteList> get_routes_with_internal_returns() const;
231 boost::shared_ptr<RouteList> get_routes_with_regions_at (framepos_t const) const;
233 uint32_t nroutes() const { return routes.reader()->size(); }
234 uint32_t ntracks () const;
235 uint32_t nbusses () const;
237 boost::shared_ptr<BundleList> bundles () {
238 return _bundles.reader ();
241 struct LIBARDOUR_API RoutePublicOrderSorter {
242 bool operator() (boost::shared_ptr<Route>, boost::shared_ptr<Route> b);
245 void set_order_hint (uint32_t order_hint) {_order_hint = order_hint;};
246 void notify_remote_id_change ();
247 void sync_order_keys ();
249 template<class T> void foreach_route (T *obj, void (T::*func)(Route&));
250 template<class T> void foreach_route (T *obj, void (T::*func)(boost::shared_ptr<Route>));
251 template<class T, class A> void foreach_route (T *obj, void (T::*func)(Route&, A), A arg);
253 static char session_name_is_legal (const std::string&);
254 bool io_name_is_legal (const std::string&);
255 boost::shared_ptr<Route> route_by_name (std::string);
256 boost::shared_ptr<Route> route_by_id (PBD::ID);
257 boost::shared_ptr<Route> route_by_remote_id (uint32_t id);
258 boost::shared_ptr<Track> track_by_diskstream_id (PBD::ID);
259 void routes_using_input_from (const std::string& str, RouteList& rl);
261 bool route_name_unique (std::string) const;
262 bool route_name_internal (std::string) const;
264 uint32_t track_number_decimals () const {
265 return _track_number_decimals;
268 bool get_record_enabled() const {
269 return (record_status () >= Enabled);
272 RecordState record_status() const {
273 return (RecordState) g_atomic_int_get (&_record_status);
276 bool actively_recording () const {
277 return record_status() == Recording;
280 bool record_enabling_legal () const;
281 void maybe_enable_record ();
282 void disable_record (bool rt_context, bool force = false);
283 void step_back_from_record ();
285 void maybe_write_autosave ();
287 /* Emitted when all i/o connections are complete */
289 PBD::Signal0<void> IOConnectionsComplete;
291 /* Record status signals */
293 PBD::Signal0<void> RecordStateChanged;
295 /* Transport mechanism signals */
297 /** Emitted on the following changes in transport state:
298 * - stop (from the butler thread)
299 * - change in whether or not we are looping (from the process thread)
300 * - change in the play range (from the process thread)
301 * - start (from the process thread)
304 PBD::Signal0<void> TransportStateChange;
306 PBD::Signal1<void,framepos_t> PositionChanged; /* sent after any non-sequential motion */
307 PBD::Signal1<void,framepos_t> Xrun;
308 PBD::Signal0<void> TransportLooped;
310 /** emitted when a locate has occurred */
311 PBD::Signal0<void> Located;
313 PBD::Signal1<void,RouteList&> RouteAdded;
314 /** Emitted when a property of one of our route groups changes.
315 * The parameter is the RouteGroup that has changed.
317 PBD::Signal1<void, RouteGroup *> RouteGroupPropertyChanged;
318 /** Emitted when a route is added to one of our route groups.
319 * First parameter is the RouteGroup, second is the route.
321 PBD::Signal2<void, RouteGroup *, boost::weak_ptr<Route> > RouteAddedToRouteGroup;
322 /** Emitted when a route is removed from one of our route groups.
323 * First parameter is the RouteGroup, second is the route.
325 PBD::Signal2<void, RouteGroup *, boost::weak_ptr<Route> > RouteRemovedFromRouteGroup;
327 /* Step Editing status changed */
328 PBD::Signal1<void,bool> StepEditStatusChange;
330 void queue_event (SessionEvent*);
332 void request_roll_at_and_return (framepos_t start, framepos_t return_to);
333 void request_bounded_roll (framepos_t start, framepos_t end);
334 void request_stop (bool abort = false, bool clear_state = false);
335 void request_locate (framepos_t frame, bool with_roll = false);
337 void request_play_loop (bool yn, bool leave_rolling = false);
338 bool get_play_loop () const { return play_loop; }
340 framepos_t last_transport_start () const { return _last_roll_location; }
343 void use_rf_shuttle_speed ();
344 void allow_auto_play (bool yn);
345 void request_transport_speed (double speed, bool as_default = false);
346 void request_transport_speed_nonzero (double, bool as_default = false);
347 void request_overwrite_buffer (Track *);
348 void adjust_playback_buffering();
349 void adjust_capture_buffering();
350 void request_track_speed (Track *, double speed);
351 void request_input_change_handling ();
353 bool locate_pending() const { return static_cast<bool>(post_transport_work()&PostTransportLocate); }
354 bool transport_locked () const;
358 framepos_t current_end_frame () const;
359 framepos_t current_start_frame () const;
360 /** "actual" sample rate of session, set by current audioengine rate, pullup/down etc. */
361 framecnt_t frame_rate () const { return _current_frame_rate; }
362 /** "native" sample rate of session, regardless of current audioengine rate, pullup/down etc */
363 framecnt_t nominal_frame_rate () const { return _nominal_frame_rate; }
364 framecnt_t frames_per_hour () const { return _frames_per_hour; }
366 double frames_per_timecode_frame() const { return _frames_per_timecode_frame; }
367 framecnt_t timecode_frames_per_hour() const { return _timecode_frames_per_hour; }
369 MIDI::byte get_mtc_timecode_bits() const {
370 return mtc_timecode_bits; /* encoding of SMTPE type for MTC */
373 double timecode_frames_per_second() const;
374 bool timecode_drop_frames() const;
378 Locations *locations() { return _locations; }
380 PBD::Signal1<void,Location*> auto_loop_location_changed;
381 PBD::Signal1<void,Location*> auto_punch_location_changed;
382 PBD::Signal0<void> locations_modified;
384 void set_auto_punch_location (Location *);
385 void set_auto_loop_location (Location *);
386 int location_name(std::string& result, std::string base = std::string(""));
388 pframes_t get_block_size() const { return current_block_size; }
389 framecnt_t worst_output_latency () const { return _worst_output_latency; }
390 framecnt_t worst_input_latency () const { return _worst_input_latency; }
391 framecnt_t worst_track_latency () const { return _worst_track_latency; }
392 framecnt_t worst_playback_latency () const { return _worst_output_latency + _worst_track_latency; }
394 int save_state (std::string snapshot_name, bool pending = false, bool switch_to_snapshot = false);
395 int restore_state (std::string snapshot_name);
396 int save_template (std::string template_name);
397 int save_history (std::string snapshot_name = "");
398 int restore_history (std::string snapshot_name);
399 void remove_state (std::string snapshot_name);
400 void rename_state (std::string old_name, std::string new_name);
401 void remove_pending_capture_state ();
402 int rename (const std::string&);
403 bool get_nsm_state () const { return _under_nsm_control; }
404 void set_nsm_state (bool state) { _under_nsm_control = state; }
405 bool save_default_options ();
407 PBD::Signal1<void,std::string> StateSaved;
408 PBD::Signal0<void> StateReady;
409 PBD::Signal0<void> SaveSession;
411 std::vector<std::string> possible_states() const;
412 static std::vector<std::string> possible_states (std::string path);
414 XMLNode& get_state();
415 int set_state(const XMLNode& node, int version); // not idempotent
416 XMLNode& get_template();
418 /// The instant xml file is written to the session directory
419 void add_instant_xml (XMLNode&, bool write_to_config = true);
420 XMLNode* instant_xml (const std::string& str);
422 enum StateOfTheState {
427 InitialConnecting = 0x8,
432 StateOfTheState state_of_the_state() const { return _state_of_the_state; }
434 class StateProtector {
436 StateProtector (Session* s) : _session (s) {
437 g_atomic_int_inc (&s->_suspend_save);
440 if (g_atomic_int_dec_and_test (&_session->_suspend_save)) {
441 while (_session->_save_queued) {
442 _session->_save_queued = false;
443 _session->save_state ("");
451 void add_route_group (RouteGroup *);
452 void remove_route_group (RouteGroup&);
453 void reorder_route_groups (std::list<RouteGroup*>);
455 RouteGroup* route_group_by_name (std::string);
456 RouteGroup& all_route_group() const;
458 PBD::Signal1<void,RouteGroup*> route_group_added;
459 PBD::Signal0<void> route_group_removed;
460 PBD::Signal0<void> route_groups_reordered;
462 void foreach_route_group (boost::function<void(RouteGroup*)> f) {
463 for (std::list<RouteGroup *>::iterator i = _route_groups.begin(); i != _route_groups.end(); ++i) {
468 std::list<RouteGroup*> const & route_groups () const {
469 return _route_groups;
472 /* fundamental operations. duh. */
474 std::list<boost::shared_ptr<AudioTrack> > new_audio_track (
477 TrackMode mode = Normal,
478 RouteGroup* route_group = 0,
479 uint32_t how_many = 1,
480 std::string name_template = ""
483 RouteList new_audio_route (
484 int input_channels, int output_channels, RouteGroup* route_group, uint32_t how_many, std::string name_template = ""
487 std::list<boost::shared_ptr<MidiTrack> > new_midi_track (
488 const ChanCount& input, const ChanCount& output,
489 boost::shared_ptr<PluginInfo> instrument = boost::shared_ptr<PluginInfo>(),
490 TrackMode mode = Normal,
491 RouteGroup* route_group = 0, uint32_t how_many = 1, std::string name_template = ""
494 void remove_route (boost::shared_ptr<Route>);
495 void resort_routes ();
496 void resort_routes_using (boost::shared_ptr<RouteList>);
498 AudioEngine & engine() { return _engine; }
499 AudioEngine const & engine () const { return _engine; }
503 framepos_t transport_frame () const {return _transport_frame; }
504 framepos_t record_location () const {return _last_record_location; }
505 framepos_t audible_frame () const;
506 framepos_t requested_return_frame() const { return _requested_return_frame; }
507 void set_requested_return_frame(framepos_t return_to);
521 void sync_time_vars();
523 void bbt_time (framepos_t when, Timecode::BBT_Time&);
524 void timecode_to_sample(Timecode::Time& timecode, framepos_t& sample, bool use_offset, bool use_subframes) const;
525 void sample_to_timecode(framepos_t sample, Timecode::Time& timecode, bool use_offset, bool use_subframes) const;
526 void timecode_time (Timecode::Time &);
527 void timecode_time (framepos_t when, Timecode::Time&);
528 void timecode_time_subframes (framepos_t when, Timecode::Time&);
530 void timecode_duration (framecnt_t, Timecode::Time&) const;
531 void timecode_duration_string (char *, size_t len, framecnt_t) const;
533 framecnt_t convert_to_frames (AnyTime const & position);
534 framecnt_t any_duration_to_frames (framepos_t position, AnyTime const & duration);
536 static PBD::Signal1<void, framepos_t> StartTimeChanged;
537 static PBD::Signal1<void, framepos_t> EndTimeChanged;
539 void request_sync_source (Slave*);
540 bool synced_to_engine() const { return config.get_external_sync() && Config->get_sync_source() == Engine; }
542 double transport_speed() const { return _transport_speed; }
543 bool transport_stopped() const { return _transport_speed == 0.0f; }
544 bool transport_rolling() const { return _transport_speed != 0.0f; }
546 void set_silent (bool yn);
547 bool silent () { return _silent; }
549 TempoMap& tempo_map() { return *_tempo_map; }
553 boost::shared_ptr<Region> find_whole_file_parent (boost::shared_ptr<Region const>) const;
555 boost::shared_ptr<Region> XMLRegionFactory (const XMLNode&, bool full);
556 boost::shared_ptr<AudioRegion> XMLAudioRegionFactory (const XMLNode&, bool full);
557 boost::shared_ptr<MidiRegion> XMLMidiRegionFactory (const XMLNode&, bool full);
559 /* source management */
561 void import_files (ImportStatus&);
562 bool sample_rate_convert (ImportStatus&, std::string infile, std::string& outfile);
563 std::string build_tmp_convert_name (std::string file);
565 boost::shared_ptr<ExportHandler> get_export_handler ();
566 boost::shared_ptr<ExportStatus> get_export_status ();
568 int start_audio_export (framepos_t position);
570 PBD::Signal1<int, framecnt_t> ProcessExport;
571 static PBD::Signal2<void,std::string, std::string> Exported;
573 void add_source (boost::shared_ptr<Source>);
574 void remove_source (boost::weak_ptr<Source>);
576 void cleanup_regions();
577 int cleanup_sources (CleanupReport&);
578 int cleanup_trash_sources (CleanupReport&);
580 int destroy_sources (std::list<boost::shared_ptr<Source> >);
582 int remove_last_capture ();
584 /** handlers should return 0 for "everything OK", and any other value for
585 * "cannot setup audioengine".
587 static PBD::Signal1<int,uint32_t> AudioEngineSetupRequired;
589 /** handlers should return -1 for "stop cleanup",
590 0 for "yes, delete this playlist",
591 1 for "no, don't delete this playlist".
593 static PBD::Signal1<int,boost::shared_ptr<Playlist> > AskAboutPlaylistDeletion;
595 /** handlers should return 0 for "ignore the rate mismatch",
596 !0 for "do not use this session"
598 static PBD::Signal2<int, framecnt_t, framecnt_t> AskAboutSampleRateMismatch;
600 /** handlers should return !0 for use pending state, 0 for ignore it.
602 static PBD::Signal0<int> AskAboutPendingState;
604 boost::shared_ptr<AudioFileSource> create_audio_source_for_session (
605 size_t, std::string const &, uint32_t, bool destructive);
607 boost::shared_ptr<MidiSource> create_midi_source_for_session (std::string const &);
608 boost::shared_ptr<MidiSource> create_midi_source_by_stealing_name (boost::shared_ptr<Track>);
610 boost::shared_ptr<Source> source_by_id (const PBD::ID&);
611 boost::shared_ptr<AudioFileSource> audio_source_by_path_and_channel (const std::string&, uint16_t) const;
612 boost::shared_ptr<MidiSource> midi_source_by_path (const std::string&) const;
613 uint32_t count_sources_by_origin (const std::string&);
615 void add_playlist (boost::shared_ptr<Playlist>, bool unused = false);
617 /* Curves and AutomationLists (TODO when they go away) */
618 void add_automation_list(AutomationList*);
622 boost::shared_ptr<Auditioner> the_auditioner() { return auditioner; }
623 void audition_playlist ();
624 void audition_region (boost::shared_ptr<Region>);
625 void cancel_audition ();
626 bool is_auditioning () const;
628 PBD::Signal1<void,bool> AuditionActive;
630 /* flattening stuff */
632 boost::shared_ptr<Region> write_one_track (AudioTrack&, framepos_t start, framepos_t end,
633 bool overwrite, std::vector<boost::shared_ptr<Source> >&, InterThreadInfo& wot,
634 boost::shared_ptr<Processor> endpoint,
635 bool include_endpoint, bool for_export, bool for_freeze);
636 int freeze_all (InterThreadInfo&);
638 /* session-wide solo/mute/rec-enable */
640 bool soloing() const { return _non_soloed_outs_muted; }
641 bool listening() const { return _listen_cnt > 0; }
642 bool solo_isolated() const { return _solo_isolated_cnt > 0; }
644 static const SessionEvent::RTeventCallback rt_cleanup;
646 void set_solo (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
647 void set_just_one_solo (boost::shared_ptr<Route>, bool, SessionEvent::RTeventCallback after = rt_cleanup);
648 void cancel_solo_after_disconnect (boost::shared_ptr<Route>, bool upstream, SessionEvent::RTeventCallback after = rt_cleanup);
649 void set_mute (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
650 void set_listen (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
651 void set_record_enabled (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
652 void set_solo_isolated (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
653 void set_monitoring (boost::shared_ptr<RouteList>, MonitorChoice, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
654 void set_exclusive_input_active (boost::shared_ptr<RouteList> rt, bool onoff, bool flip_others=false);
656 PBD::Signal1<void,bool> SoloActive;
657 PBD::Signal0<void> SoloChanged;
658 PBD::Signal0<void> IsolatedChanged;
660 /* monitor/master out */
662 void add_monitor_section ();
663 void remove_monitor_section ();
665 boost::shared_ptr<Route> monitor_out() const { return _monitor_out; }
666 boost::shared_ptr<Route> master_out() const { return _master_out; }
668 void globally_add_internal_sends (boost::shared_ptr<Route> dest, Placement p, bool);
669 void globally_set_send_gains_from_track (boost::shared_ptr<Route> dest);
670 void globally_set_send_gains_to_zero (boost::shared_ptr<Route> dest);
671 void globally_set_send_gains_to_unity (boost::shared_ptr<Route> dest);
672 void add_internal_sends (boost::shared_ptr<Route> dest, Placement p, boost::shared_ptr<RouteList> senders);
673 void add_internal_send (boost::shared_ptr<Route>, int, boost::shared_ptr<Route>);
674 void add_internal_send (boost::shared_ptr<Route>, boost::shared_ptr<Processor>, boost::shared_ptr<Route>);
676 static void set_disable_all_loaded_plugins (bool yn) {
677 _disable_all_loaded_plugins = yn;
679 static bool get_disable_all_loaded_plugins() {
680 return _disable_all_loaded_plugins;
683 uint32_t next_send_id();
684 uint32_t next_aux_send_id();
685 uint32_t next_return_id();
686 uint32_t next_insert_id();
687 void mark_send_id (uint32_t);
688 void mark_aux_send_id (uint32_t);
689 void mark_return_id (uint32_t);
690 void mark_insert_id (uint32_t);
691 void unmark_send_id (uint32_t);
692 void unmark_aux_send_id (uint32_t);
693 void unmark_return_id (uint32_t);
694 void unmark_insert_id (uint32_t);
696 /* s/w "RAID" management */
698 boost::optional<framecnt_t> available_capture_duration();
702 void add_bundle (boost::shared_ptr<Bundle>);
703 void remove_bundle (boost::shared_ptr<Bundle>);
704 boost::shared_ptr<Bundle> bundle_by_name (std::string) const;
706 PBD::Signal1<void,boost::shared_ptr<Bundle> > BundleAdded;
707 PBD::Signal1<void,boost::shared_ptr<Bundle> > BundleRemoved;
711 /* History (for editors, mixers, UIs etc.) */
713 /** Undo some transactions.
714 * @param n Number of transactions to undo.
716 void undo (uint32_t n) {
720 void redo (uint32_t n) {
724 UndoHistory& history() { return _history; }
726 uint32_t undo_depth() const { return _history.undo_depth(); }
727 uint32_t redo_depth() const { return _history.redo_depth(); }
728 std::string next_undo() const { return _history.next_undo(); }
729 std::string next_redo() const { return _history.next_redo(); }
731 void begin_reversible_command (const std::string& cmd_name);
732 void begin_reversible_command (GQuark);
733 void commit_reversible_command (Command* cmd = 0);
735 void add_command (Command *const cmd) {
736 assert (_current_trans);
737 _current_trans->add_command (cmd);
740 /** @return The list of operations that are currently in progress */
741 std::list<GQuark> const & current_operations () {
742 return _current_trans_quarks;
745 bool operation_in_progress (GQuark) const;
747 void add_commands (std::vector<Command*> const & cmds);
749 std::map<PBD::ID,PBD::StatefulDestructible*> registry;
751 // these commands are implemented in libs/ardour/session_command.cc
752 Command* memento_command_factory(XMLNode* n);
753 Command* stateful_diff_command_factory (XMLNode *);
754 void register_with_memento_command_factory(PBD::ID, PBD::StatefulDestructible*);
758 boost::shared_ptr<IO> click_io() { return _click_io; }
759 boost::shared_ptr<Amp> click_gain() { return _click_gain; }
761 /* disk, buffer loads */
763 uint32_t playback_load ();
764 uint32_t capture_load ();
768 void request_play_range (std::list<AudioRange>*, bool leave_rolling = false);
769 void request_cancel_play_range ();
770 bool get_play_range () const { return _play_range; }
772 void maybe_update_session_range (framepos_t, framepos_t);
774 /* buffers for gain and pan */
776 gain_t* gain_automation_buffer () const;
777 gain_t* send_gain_automation_buffer () const;
778 pan_t** pan_automation_buffer () const;
780 void ensure_buffer_set (BufferSet& buffers, const ChanCount& howmany);
784 static int vst_current_loading_id;
785 static const char* vst_can_do_strings[];
786 static const int vst_can_do_string_count;
788 static intptr_t vst_callback (
797 static PBD::Signal0<void> SendFeedback;
801 boost::shared_ptr<Speakers> get_speakers ();
805 boost::shared_ptr<PBD::Controllable> controllable_by_id (const PBD::ID&);
806 boost::shared_ptr<PBD::Controllable> controllable_by_descriptor (const PBD::ControllableDescriptor&);
808 void add_controllable (boost::shared_ptr<PBD::Controllable>);
809 void remove_controllable (PBD::Controllable*);
811 boost::shared_ptr<PBD::Controllable> solo_cut_control() const;
813 SessionConfiguration config;
815 bool exporting () const {
819 bool bounce_processing() const {
820 return _bounce_processing_active;
823 /* this is a private enum, but setup_enum_writer() needs it,
824 and i can't find a way to give that function
828 enum PostTransportWork {
829 PostTransportStop = 0x1,
830 PostTransportDuration = 0x2,
831 PostTransportLocate = 0x4,
832 PostTransportRoll = 0x8,
833 PostTransportAbort = 0x10,
834 PostTransportOverWrite = 0x20,
835 PostTransportSpeed = 0x40,
836 PostTransportAudition = 0x80,
837 PostTransportReverse = 0x100,
838 PostTransportInputChange = 0x200,
839 PostTransportCurveRealloc = 0x400,
840 PostTransportClearSubstate = 0x800,
841 PostTransportAdjustPlaybackBuffering = 0x1000,
842 PostTransportAdjustCaptureBuffering = 0x2000
851 SlaveState slave_state() const { return _slave_state; }
852 Slave* slave() const { return _slave; }
854 boost::shared_ptr<SessionPlaylists> playlists;
856 void send_mmc_locate (framepos_t);
857 void queue_full_time_code () { _send_timecode_update = true; }
858 void queue_song_position_pointer () { /* currently does nothing */ }
860 bool step_editing() const { return (_step_editors > 0); }
862 void request_suspend_timecode_transmission ();
863 void request_resume_timecode_transmission ();
864 bool timecode_transmission_suspended () const;
866 std::vector<std::string> source_search_path(DataType) const;
867 void ensure_search_path_includes (const std::string& path, DataType type);
868 void remove_dir_from_search_path (const std::string& path, DataType type);
870 std::list<std::string> unknown_processors () const;
872 /** Emitted when a feedback cycle has been detected within Ardour's signal
873 processing path. Until it is fixed (by the user) some (unspecified)
874 routes will not be run.
876 static PBD::Signal0<void> FeedbackDetected;
878 /** Emitted when a graph sort has successfully completed, which means
879 that it has no feedback cycles.
881 static PBD::Signal0<void> SuccessfulGraphSort;
883 /* handlers can return an integer value:
884 0: config.set_audio_search_path() or config.set_midi_search_path() was used
885 to modify the search path and we should try to find it again.
886 1: quit entire session load
887 2: as 0, but don't ask about other missing files
888 3: don't ask about other missing files, and just mark this one missing
889 -1: just mark this one missing
890 any other value: as -1
892 static PBD::Signal3<int,Session*,std::string,DataType> MissingFile;
894 /** Emitted when the session wants Ardour to quit */
895 static PBD::Signal0<void> Quit;
897 /** Emitted when Ardour is asked to load a session in an older session
898 * format, and makes a backup copy.
900 static PBD::Signal2<void,std::string,std::string> VersionMismatch;
902 SceneChanger* scene_changer() const { return _scene_changer; }
904 boost::shared_ptr<Port> ltc_input_port() const;
905 boost::shared_ptr<Port> ltc_output_port() const;
907 boost::shared_ptr<IO> ltc_input_io() { return _ltc_input; }
908 boost::shared_ptr<IO> ltc_output_io() { return _ltc_output; }
910 MIDI::Port* midi_input_port () const;
911 MIDI::Port* midi_output_port () const;
912 MIDI::Port* mmc_output_port () const;
913 MIDI::Port* mmc_input_port () const;
915 MIDI::Port* scene_input_port () const;
916 MIDI::Port* scene_output_port () const;
918 boost::shared_ptr<MidiPort> scene_in () const;
919 boost::shared_ptr<MidiPort> scene_out () const;
921 boost::shared_ptr<MidiPort> midi_clock_output_port () const;
922 boost::shared_ptr<MidiPort> midi_clock_input_port () const;
923 boost::shared_ptr<MidiPort> mtc_output_port () const;
924 boost::shared_ptr<MidiPort> mtc_input_port () const;
926 MIDI::MachineControl& mmc() { return *_mmc; }
929 friend class AudioEngine;
930 void set_block_size (pframes_t nframes);
931 void set_frame_rate (framecnt_t nframes);
932 void reconnect_existing_routes (bool withLock, bool reconnect_master = true, bool reconnect_inputs = true, bool reconnect_outputs = true);
936 void schedule_curve_reallocation ();
937 void update_latency_compensation (bool force = false);
940 int create (const std::string& mix_template, BusProfile*);
944 PendingDeclickIn = 0x1, ///< pending de-click fade-in for start
945 PendingDeclickOut = 0x2, ///< pending de-click fade-out for stop
946 StopPendingCapture = 0x4,
947 PendingLoopDeclickIn = 0x8, ///< pending de-click fade-in at the start of a loop
948 PendingLoopDeclickOut = 0x10, ///< pending de-click fade-out at the end of a loop
949 PendingLocate = 0x20,
952 /* stuff used in process() should be close together to
956 typedef void (Session::*process_function_type)(pframes_t);
958 AudioEngine& _engine;
959 mutable gint processing_prohibited;
960 process_function_type process_function;
961 process_function_type last_process_function;
962 bool _bounce_processing_active;
963 bool waiting_for_sync_offset;
964 framecnt_t _base_frame_rate;
965 framecnt_t _current_frame_rate; //this includes video pullup offset
966 framecnt_t _nominal_frame_rate; //ignores audioengine setting, "native" SR
967 int transport_sub_state;
968 mutable gint _record_status;
969 framepos_t _transport_frame;
970 Location* _session_range_location; ///< session range, or 0 if there is nothing in the session yet
974 // varispeed playback
975 double _transport_speed;
976 double _default_transport_speed;
977 double _last_transport_speed;
978 double _target_transport_speed;
979 CubicInterpolation interpolation;
981 bool auto_play_legal;
982 framepos_t _last_slave_transport_frame;
983 framecnt_t maximum_output_latency;
984 framepos_t _requested_return_frame;
985 pframes_t current_block_size;
986 framecnt_t _worst_output_latency;
987 framecnt_t _worst_input_latency;
988 framecnt_t _worst_track_latency;
991 float _meter_falloff;
992 bool _non_soloed_outs_muted;
993 uint32_t _listen_cnt;
994 uint32_t _solo_isolated_cnt;
997 bool _under_nsm_control;
999 void initialize_latencies ();
1000 void set_worst_io_latencies ();
1001 void set_worst_playback_latency ();
1002 void set_worst_capture_latency ();
1003 void set_worst_io_latencies_x (IOChange, void *) {
1004 set_worst_io_latencies ();
1006 void post_capture_latency ();
1007 void post_playback_latency ();
1009 void update_latency_compensation_proxy (void* ignored);
1011 void ensure_buffers (ChanCount howmany = ChanCount::ZERO);
1013 void process_scrub (pframes_t);
1014 void process_without_events (pframes_t);
1015 void process_with_events (pframes_t);
1016 void process_audition (pframes_t);
1017 int process_export (pframes_t);
1018 int process_export_fw (pframes_t);
1020 void block_processing() { g_atomic_int_set (&processing_prohibited, 1); }
1021 void unblock_processing() { g_atomic_int_set (&processing_prohibited, 0); }
1022 bool processing_blocked() const { return g_atomic_int_get (&processing_prohibited); }
1024 static const framecnt_t bounce_chunk_size;
1026 /* slave tracking */
1028 static const int delta_accumulator_size = 25;
1029 int delta_accumulator_cnt;
1030 int32_t delta_accumulator[delta_accumulator_size];
1031 int32_t average_slave_delta;
1033 bool have_first_delta_accumulator;
1035 SlaveState _slave_state;
1036 framepos_t slave_wait_end;
1038 void reset_slave_state ();
1039 bool follow_slave (pframes_t);
1040 void calculate_moving_average_of_slave_delta (int dir, framecnt_t this_delta);
1041 void track_slave_state (float slave_speed, framepos_t slave_transport_frame, framecnt_t this_delta);
1042 void follow_slave_silently (pframes_t nframes, float slave_speed);
1044 void switch_to_sync_source (SyncSource); /* !RT context */
1045 void drop_sync_source (); /* !RT context */
1046 void use_sync_source (Slave*); /* RT context */
1048 bool post_export_sync;
1049 framepos_t post_export_position;
1052 bool _export_started;
1053 bool _export_rolling;
1055 boost::shared_ptr<ExportHandler> export_handler;
1056 boost::shared_ptr<ExportStatus> export_status;
1059 int stop_audio_export ();
1060 void finalize_audio_export ();
1061 void finalize_export_internal (bool stop_freewheel);
1062 bool _pre_export_mmc_enabled;
1064 PBD::ScopedConnection export_freewheel_connection;
1066 void get_track_statistics ();
1067 int process_routes (pframes_t, bool& need_butler);
1068 int silent_process_routes (pframes_t, bool& need_butler);
1070 /** @return 1 if there is a pending declick fade-in,
1071 -1 if there is a pending declick fade-out,
1072 0 if there is no pending declick.
1074 int get_transport_declick_required () {
1075 if (transport_sub_state & PendingDeclickIn) {
1076 transport_sub_state &= ~PendingDeclickIn;
1078 } else if (transport_sub_state & PendingDeclickOut) {
1079 /* XXX: not entirely sure why we don't clear this */
1081 } else if (transport_sub_state & PendingLoopDeclickOut) {
1082 /* Return the declick out first ... */
1083 transport_sub_state &= ~PendingLoopDeclickOut;
1085 } else if (transport_sub_state & PendingLoopDeclickIn) {
1086 /* ... then the declick in on the next call */
1087 transport_sub_state &= ~PendingLoopDeclickIn;
1094 bool maybe_stop (framepos_t limit);
1095 bool maybe_sync_start (pframes_t &);
1097 void check_declick_out ();
1103 /** Number of process frames since the last MTC output (when sending MTC); used to
1104 * know when to send full MTC messages every so often.
1106 pframes_t _pframes_since_last_mtc;
1107 bool session_midi_feedback;
1110 framepos_t last_loopend;
1112 boost::scoped_ptr<SessionDirectory> _session_dir;
1115 void graph_reordered ();
1117 /** current snapshot name, without the .ardour suffix */
1118 std::string _current_snapshot_name;
1120 XMLTree* state_tree;
1121 bool state_was_pending;
1122 StateOfTheState _state_of_the_state;
1124 friend class StateProtector;
1125 gint _suspend_save; /* atomic */
1126 volatile bool _save_queued;
1127 Glib::Threads::Mutex save_state_lock;
1129 int load_options (const XMLNode&);
1130 int load_state (std::string snapshot_name);
1132 framepos_t _last_roll_location;
1133 /** the session frame time at which we last rolled, located, or changed transport direction */
1134 framepos_t _last_roll_or_reversal_location;
1135 framepos_t _last_record_location;
1137 bool pending_locate_roll;
1138 framepos_t pending_locate_frame;
1139 bool pending_locate_flush;
1141 bool pending_auto_loop;
1145 static const PostTransportWork ProcessCannotProceedMask =
1147 PostTransportInputChange|
1149 PostTransportReverse|
1150 PostTransportCurveRealloc|
1151 PostTransportAudition|
1152 PostTransportLocate|
1154 PostTransportClearSubstate);
1156 gint _post_transport_work; /* accessed only atomic ops */
1157 PostTransportWork post_transport_work() const { return (PostTransportWork) g_atomic_int_get (const_cast<gint*>(&_post_transport_work)); }
1158 void set_post_transport_work (PostTransportWork ptw) { g_atomic_int_set (&_post_transport_work, (gint) ptw); }
1159 void add_post_transport_work (PostTransportWork ptw);
1161 void schedule_playback_buffering_adjustment ();
1162 void schedule_capture_buffering_adjustment ();
1164 uint32_t cumulative_rf_motion;
1167 void set_rf_speed (float speed);
1168 void reset_rf_scale (framecnt_t frames_moved);
1170 Locations* _locations;
1171 void locations_changed ();
1172 void locations_added (Location*);
1173 void handle_locations_changed (Locations::LocationList&);
1174 void sync_locations_to_skips (Locations::LocationList&);
1176 PBD::ScopedConnectionList punch_connections;
1177 void auto_punch_start_changed (Location *);
1178 void auto_punch_end_changed (Location *);
1179 void auto_punch_changed (Location *);
1181 PBD::ScopedConnectionList loop_connections;
1182 void auto_loop_changed (Location *);
1183 void auto_loop_declick_range (Location *, framepos_t &, framepos_t &);
1185 int ensure_engine (uint32_t desired_sample_rate);
1186 void pre_engine_init (std::string path);
1187 int post_engine_init ();
1188 int immediately_post_engine ();
1189 void remove_empty_sounds ();
1191 void setup_midi_control ();
1192 int midi_read (MIDI::Port *);
1194 void enable_record ();
1196 void increment_transport_position (framecnt_t val) {
1197 if (max_framepos - val < _transport_frame) {
1198 _transport_frame = max_framepos;
1200 _transport_frame += val;
1204 void decrement_transport_position (framecnt_t val) {
1205 if (val < _transport_frame) {
1206 _transport_frame -= val;
1208 _transport_frame = 0;
1212 void post_transport_motion ();
1213 static void *session_loader_thread (void *arg);
1217 /* SessionEventManager interface */
1219 void process_event (SessionEvent*);
1220 void set_next_event ();
1221 void cleanup_event (SessionEvent*,int);
1223 /* MIDI Machine Control */
1226 void spp_continue ();
1229 void mmc_deferred_play (MIDI::MachineControl &);
1230 void mmc_stop (MIDI::MachineControl &);
1231 void mmc_step (MIDI::MachineControl &, int);
1232 void mmc_pause (MIDI::MachineControl &);
1233 void mmc_record_pause (MIDI::MachineControl &);
1234 void mmc_record_strobe (MIDI::MachineControl &);
1235 void mmc_record_exit (MIDI::MachineControl &);
1236 void mmc_track_record_status (MIDI::MachineControl &, uint32_t track, bool enabled);
1237 void mmc_fast_forward (MIDI::MachineControl &);
1238 void mmc_rewind (MIDI::MachineControl &);
1239 void mmc_locate (MIDI::MachineControl &, const MIDI::byte *);
1240 void mmc_shuttle (MIDI::MachineControl &mmc, float speed, bool forw);
1241 void mmc_record_enable (MIDI::MachineControl &mmc, size_t track, bool enabled);
1243 struct timeval last_mmc_step;
1246 typedef boost::function<bool()> MidiTimeoutCallback;
1247 typedef std::list<MidiTimeoutCallback> MidiTimeoutList;
1249 MidiTimeoutList midi_timeouts;
1250 bool mmc_step_timeout ();
1252 MIDI::byte mtc_msg[16];
1253 MIDI::byte mtc_timecode_bits; /* encoding of SMTPE type for MTC */
1254 MIDI::byte midi_msg[16];
1255 double outbound_mtc_timecode_frame;
1256 Timecode::Time transmitting_timecode_time;
1257 int next_quarter_frame_to_send;
1259 double _frames_per_timecode_frame; /* has to be floating point because of drop frame */
1260 framecnt_t _frames_per_hour;
1261 framecnt_t _timecode_frames_per_hour;
1263 /* cache the most-recently requested time conversions. This helps when we
1264 * have multiple clocks showing the same time (e.g. the transport frame) */
1265 bool last_timecode_valid;
1266 framepos_t last_timecode_when;
1267 Timecode::Time last_timecode;
1269 bool _send_timecode_update; ///< Flag to send a full frame (Timecode) MTC message this cycle
1271 int send_midi_time_code_for_cycle (framepos_t, framepos_t, pframes_t nframes);
1273 LTCEncoder* ltc_encoder;
1274 ltcsnd_sample_t* ltc_enc_buf;
1276 Timecode::TimecodeFormat ltc_enc_tcformat;
1277 int32_t ltc_buf_off;
1278 int32_t ltc_buf_len;
1281 int32_t ltc_enc_byte;
1282 framepos_t ltc_enc_pos;
1284 framepos_t ltc_enc_off;
1286 framepos_t ltc_prev_cycle;
1288 framepos_t ltc_timecode_offset;
1289 bool ltc_timecode_negative_offset;
1291 LatencyRange ltc_out_latency;
1293 void ltc_tx_initialize();
1294 void ltc_tx_cleanup();
1295 void ltc_tx_reset();
1296 void ltc_tx_resync_latency();
1297 void ltc_tx_recalculate_position();
1298 void ltc_tx_parse_offset();
1299 void ltc_tx_send_time_code_for_cycle (framepos_t, framepos_t, double, double, pframes_t nframes);
1301 void reset_record_status ();
1303 int no_roll (pframes_t nframes);
1304 int fail_roll (pframes_t nframes);
1306 bool non_realtime_work_pending() const { return static_cast<bool>(post_transport_work()); }
1307 bool process_can_proceed() const { return !(post_transport_work() & ProcessCannotProceedMask); }
1309 MidiControlUI* midi_control_ui;
1311 int start_midi_thread ();
1313 void set_play_loop (bool yn, double speed);
1314 void unset_play_loop ();
1315 void overwrite_some_buffers (Track *);
1316 void flush_all_inserts ();
1317 int micro_locate (framecnt_t distance);
1318 void locate (framepos_t, bool with_roll, bool with_flush, bool with_loop=false, bool force=false, bool with_mmc=true);
1319 void start_locate (framepos_t, bool with_roll, bool with_flush, bool with_loop=false, bool force=false);
1320 void force_locate (framepos_t frame, bool with_roll = false);
1321 void set_track_speed (Track *, double speed);
1322 void set_transport_speed (double speed, framepos_t destination_frame, bool abort = false, bool clear_state = false, bool as_default = false);
1323 void stop_transport (bool abort = false, bool clear_state = false);
1324 void start_transport ();
1325 void realtime_stop (bool abort, bool clear_state);
1326 void realtime_locate ();
1327 void non_realtime_start_scrub ();
1328 void non_realtime_set_speed ();
1329 void non_realtime_locate ();
1330 void non_realtime_stop (bool abort, int entry_request_count, bool& finished);
1331 void non_realtime_overwrite (int entry_request_count, bool& finished);
1332 void post_transport ();
1333 void engine_halted ();
1334 void xrun_recovery ();
1336 /* These are synchronous and so can only be called from within the process
1340 int send_full_time_code (framepos_t, pframes_t nframes);
1341 void send_song_position_pointer (framepos_t);
1343 TempoMap *_tempo_map;
1344 void tempo_map_changed (const PBD::PropertyChange&);
1346 /* edit/mix groups */
1348 int load_route_groups (const XMLNode&, int);
1350 std::list<RouteGroup *> _route_groups;
1351 RouteGroup* _all_route_group;
1355 boost::shared_ptr<Graph> _process_graph;
1357 SerializedRCUManager<RouteList> routes;
1359 void add_routes (RouteList&, bool input_auto_connect, bool output_auto_connect, bool save);
1360 void add_routes_inner (RouteList&, bool input_auto_connect, bool output_auto_connect);
1361 bool _adding_routes_in_progress;
1362 uint32_t destructive_index;
1364 boost::shared_ptr<Route> XMLRouteFactory (const XMLNode&, int);
1365 boost::shared_ptr<Route> XMLRouteFactory_2X (const XMLNode&, int);
1367 void route_processors_changed (RouteProcessorChange);
1369 bool find_route_name (std::string const &, uint32_t& id, char* name, size_t name_len, bool);
1370 void count_existing_track_channels (ChanCount& in, ChanCount& out);
1371 void auto_connect_route (boost::shared_ptr<Route> route, ChanCount& existing_inputs, ChanCount& existing_outputs,
1372 bool with_lock, bool connect_inputs = true,
1373 ChanCount input_start = ChanCount (), ChanCount output_start = ChanCount ());
1374 void midi_output_change_handler (IOChange change, void* /*src*/, boost::weak_ptr<Route> midi_track);
1376 /* track numbering */
1378 void reassign_track_numbers ();
1379 uint32_t _track_number_decimals;
1383 bool solo_update_disabled;
1385 void route_listen_changed (void *src, boost::weak_ptr<Route>);
1386 void route_mute_changed (void *src);
1387 void route_solo_changed (bool self_solo_change, void *src, boost::weak_ptr<Route>);
1388 void route_solo_isolated_changed (void *src, boost::weak_ptr<Route>);
1389 void update_route_solo_state (boost::shared_ptr<RouteList> r = boost::shared_ptr<RouteList>());
1391 void listen_position_changed ();
1392 void solo_control_mode_changed ();
1394 /* REGION MANAGEMENT */
1396 mutable Glib::Threads::Mutex region_lock;
1398 int load_regions (const XMLNode& node);
1399 int load_compounds (const XMLNode& node);
1401 void route_added_to_route_group (RouteGroup *, boost::weak_ptr<Route>);
1402 void route_removed_from_route_group (RouteGroup *, boost::weak_ptr<Route>);
1403 void route_group_property_changed (RouteGroup *);
1407 mutable Glib::Threads::Mutex source_lock;
1410 typedef std::map<PBD::ID,boost::shared_ptr<Source> > SourceMap;
1416 int load_sources (const XMLNode& node);
1417 XMLNode& get_sources_as_xml ();
1419 boost::shared_ptr<Source> XMLSourceFactory (const XMLNode&);
1423 void remove_playlist (boost::weak_ptr<Playlist>);
1424 void track_playlist_changed (boost::weak_ptr<Track>);
1425 void playlist_region_added (boost::weak_ptr<Region>);
1426 void playlist_ranges_moved (std::list<Evoral::RangeMove<framepos_t> > const &);
1427 void playlist_regions_extended (std::list<Evoral::Range<framepos_t> > const &);
1429 /* CURVES and AUTOMATION LISTS */
1430 std::map<PBD::ID, AutomationList*> automation_lists;
1432 /* DEFAULT FADE CURVES */
1434 float default_fade_steepness;
1435 float default_fade_msecs;
1439 boost::shared_ptr<Auditioner> auditioner;
1440 void set_audition (boost::shared_ptr<Region>);
1441 void non_realtime_set_audition ();
1442 boost::shared_ptr<Region> pending_audition_region;
1448 int flatten_one_track (AudioTrack&, framepos_t start, framecnt_t cnt);
1450 /* INSERT AND SEND MANAGEMENT */
1452 boost::dynamic_bitset<uint32_t> send_bitset;
1453 boost::dynamic_bitset<uint32_t> aux_send_bitset;
1454 boost::dynamic_bitset<uint32_t> return_bitset;
1455 boost::dynamic_bitset<uint32_t> insert_bitset;
1459 struct space_and_path {
1460 uint32_t blocks; ///< 4kB blocks
1461 bool blocks_unknown; ///< true if blocks is unknown
1466 , blocks_unknown (true)
1470 struct space_and_path_ascending_cmp {
1471 bool operator() (space_and_path a, space_and_path b) {
1472 if (a.blocks_unknown != b.blocks_unknown) {
1473 return !a.blocks_unknown;
1475 return a.blocks > b.blocks;
1479 void setup_raid_path (std::string path);
1481 std::vector<space_and_path> session_dirs;
1482 std::vector<space_and_path>::iterator last_rr_session_dir;
1483 uint32_t _total_free_4k_blocks;
1484 /** If this is true, _total_free_4k_blocks is not definite,
1485 as one or more of the session directories' filesystems
1486 could not report free space.
1488 bool _total_free_4k_blocks_uncertain;
1489 Glib::Threads::Mutex space_lock;
1491 bool no_questions_about_missing_files;
1493 std::string get_best_session_directory_for_new_audio ();
1495 mutable gint _playback_load;
1496 mutable gint _capture_load;
1500 SerializedRCUManager<BundleList> _bundles;
1501 XMLNode* _bundle_xml_node;
1502 int load_bundles (XMLNode const &);
1504 UndoHistory _history;
1505 /** current undo transaction, or 0 */
1506 UndoTransaction* _current_trans;
1507 /** GQuarks to describe the reversible commands that are currently in progress.
1508 * These may be nested, in which case more recently-started commands are toward
1509 * the front of the list.
1511 std::list<GQuark> _current_trans_quarks;
1513 int backend_sync_callback (TransportState, framepos_t);
1515 void process_rtop (SessionEvent*);
1517 void update_latency (bool playback);
1519 XMLNode& state(bool);
1522 typedef std::list<Click*> Clicks;
1525 boost::shared_ptr<IO> _click_io;
1526 boost::shared_ptr<Amp> _click_gain;
1528 Sample* click_emphasis_data;
1529 framecnt_t click_length;
1530 framecnt_t click_emphasis_length;
1531 mutable Glib::Threads::RWLock click_lock;
1533 static const Sample default_click[];
1534 static const framecnt_t default_click_length;
1535 static const Sample default_click_emphasis[];
1536 static const framecnt_t default_click_emphasis_length;
1539 framepos_t _clicks_cleared;
1540 void setup_click_sounds (int which);
1541 void setup_click_sounds (Sample**, Sample const *, framecnt_t*, framecnt_t, std::string const &);
1542 void clear_clicks ();
1543 void click (framepos_t start, framecnt_t nframes);
1545 std::vector<Route*> master_outs;
1547 /* range playback */
1549 std::list<AudioRange> current_audio_range;
1551 void set_play_range (std::list<AudioRange>&, bool leave_rolling);
1552 void unset_play_range ();
1557 boost::shared_ptr<Route> _master_out;
1558 boost::shared_ptr<Route> _monitor_out;
1560 void auto_connect_master_bus ();
1562 /* Windows VST support */
1564 long _windows_vst_callback (
1573 int find_all_sources (std::string path, std::set<std::string>& result);
1574 int find_all_sources_across_snapshots (std::set<std::string>& result, bool exclude_this_snapshot);
1576 typedef std::set<boost::shared_ptr<PBD::Controllable> > Controllables;
1577 Glib::Threads::Mutex controllables_lock;
1578 Controllables controllables;
1580 boost::shared_ptr<PBD::Controllable> _solo_cut_control;
1582 void reset_native_file_format();
1583 bool first_file_data_format_reset;
1584 bool first_file_header_format_reset;
1586 void config_changed (std::string, bool);
1588 XMLNode& get_control_protocol_state ();
1590 void set_history_depth (uint32_t depth);
1592 static bool _disable_all_loaded_plugins;
1594 mutable bool have_looped; ///< Used in ::audible_frame(*)
1596 void update_have_rec_enabled_track ();
1597 gint _have_rec_enabled_track;
1599 static int ask_about_playlist_deletion (boost::shared_ptr<Playlist>);
1601 /* realtime "apply to set of routes" operations */
1602 template<typename T> SessionEvent*
1603 get_rt_event (boost::shared_ptr<RouteList> rl, T targ, SessionEvent::RTeventCallback after, bool group_override,
1604 void (Session::*method) (boost::shared_ptr<RouteList>, T, bool)) {
1605 SessionEvent* ev = new SessionEvent (SessionEvent::RealTimeOperation, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
1606 ev->rt_slot = boost::bind (method, this, rl, targ, group_override);
1607 ev->rt_return = after;
1608 ev->event_loop = PBD::EventLoop::get_event_loop_for_thread ();
1613 void rt_cancel_solo_after_disconnect (boost::shared_ptr<RouteList>, bool upstream, bool /* ignored*/ );
1614 void rt_set_solo (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1615 void rt_set_just_one_solo (boost::shared_ptr<RouteList>, bool yn, bool /* ignored*/ );
1616 void rt_set_mute (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1617 void rt_set_listen (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1618 void rt_set_solo_isolated (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1619 void rt_set_record_enabled (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1620 void rt_set_monitoring (boost::shared_ptr<RouteList>, MonitorChoice, bool group_override);
1622 /** temporary list of Diskstreams used only during load of 2.X sessions */
1623 std::list<boost::shared_ptr<Diskstream> > _diskstreams_2X;
1625 void add_session_range_location (framepos_t, framepos_t);
1627 void setup_midi_machine_control ();
1629 void step_edit_status_change (bool);
1630 uint32_t _step_editors;
1632 /** true if timecode transmission by the transport is suspended, otherwise false */
1633 mutable gint _suspend_timecode_transmission;
1635 void update_locations_after_tempo_map_change (Locations::LocationList &);
1637 void start_time_changed (framepos_t);
1638 void end_time_changed (framepos_t);
1640 void set_track_monitor_input_status (bool);
1641 framepos_t compute_stop_limit () const;
1643 boost::shared_ptr<Speakers> _speakers;
1644 void load_nested_sources (const XMLNode& node);
1646 /** The directed graph of routes that is currently being used for audio processing
1647 and solo/mute computations.
1649 GraphEdges _current_route_graph;
1651 uint32_t next_control_id () const;
1652 uint32_t _order_hint;
1653 bool ignore_route_processor_changes;
1655 MidiClockTicker* midi_clock;
1657 boost::shared_ptr<IO> _ltc_input;
1658 boost::shared_ptr<IO> _ltc_output;
1660 void reconnect_ltc_input ();
1661 void reconnect_ltc_output ();
1663 /* Scene Changing */
1664 SceneChanger* _scene_changer;
1666 /* persistent, non-track related MIDI ports */
1667 MidiPortManager* _midi_ports;
1668 MIDI::MachineControl* _mmc;
1671 void setup_click ();
1672 void setup_click_state (const XMLNode*);
1673 void setup_bundles ();
1675 static int get_session_info_from_path (XMLTree& state_tree, const std::string& xmlpath);
1679 } // namespace ARDOUR
1681 #endif /* __ardour_session_h__ */