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"
65 #ifdef HAVE_JACK_SESSION
66 #include <jack/session.h>
73 typedef struct _AEffect AEffect;
83 class ControllableDescriptor;
94 class AudioFileSource;
112 class MidiClockTicker;
114 class MidiPortManager;
133 class SessionDirectory;
134 class SessionMetadata;
135 class SessionPlaylists;
141 class WindowsVSTPlugin;
143 extern void setup_enum_writer ();
145 class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::ScopedConnectionList, public SessionEventManager
154 /* a new session might have non-empty mix_template, an existing session should always have an empty one.
155 the bus profile can be null if no master out bus is required.
158 Session (AudioEngine&,
159 const std::string& fullpath,
160 const std::string& snapshot_name,
161 BusProfile* bus_profile = 0,
162 std::string mix_template = "");
166 static int get_info_from_path (const std::string& xmlpath, float& sample_rate, SampleFormat& data_format);
168 std::string path() const { return _path; }
169 std::string name() const { return _name; }
170 std::string snap_name() const { return _current_snapshot_name; }
171 std::string raid_path () const;
172 bool path_is_within_session (const std::string&);
174 void set_snap_name ();
176 bool writable() const { return _writable; }
179 bool dirty() const { return _state_of_the_state & Dirty; }
180 void set_deletion_in_progress ();
181 void clear_deletion_in_progress ();
182 bool deletion_in_progress() const { return _state_of_the_state & Deletion; }
183 PBD::Signal0<void> DirtyChanged;
185 const SessionDirectory& session_directory () const { return *(_session_dir.get()); }
187 static PBD::Signal1<void,std::string> Dialog;
189 int ensure_subdirs ();
191 std::string automation_dir () const; ///< Automation data
192 std::string analysis_dir () const; ///< Analysis data
193 std::string plugins_dir () const; ///< Plugin state
194 std::string externals_dir () const; ///< Links to external files
196 std::string peak_path (std::string) const;
198 std::string peak_path_from_audio_path (std::string) const;
199 bool audio_source_name_is_unique (const std::string& name, uint32_t chan);
200 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);
201 std::string new_audio_source_path_for_embedded (const std::string& existing_path);
202 std::string new_audio_source_path (const std::string&, uint32_t nchans, uint32_t chan, bool destructive, bool take_required);
203 std::string new_midi_source_path (const std::string&);
204 RouteList new_route_from_template (uint32_t how_many, const std::string& template_path, const std::string& name);
205 std::vector<std::string> get_paths_for_new_sources (bool allow_replacing, const std::string& import_file_path, uint32_t channels);
207 int bring_all_sources_into_session (boost::function<void(uint32_t,uint32_t,std::string)> callback);
209 void process (pframes_t nframes);
211 BufferSet& get_silent_buffers (ChanCount count = ChanCount::ZERO);
212 BufferSet& get_scratch_buffers (ChanCount count = ChanCount::ZERO, bool silence = true );
213 BufferSet& get_route_buffers (ChanCount count = ChanCount::ZERO, bool silence = true);
214 BufferSet& get_mix_buffers (ChanCount count = ChanCount::ZERO);
216 bool have_rec_enabled_track () const;
218 bool have_captured() const { return _have_captured; }
220 void refill_all_track_buffers ();
221 Butler* butler() { return _butler; }
222 void butler_transport_work ();
224 void refresh_disk_space ();
226 int load_diskstreams_2X (XMLNode const &, int);
228 int load_routes (const XMLNode&, int);
229 boost::shared_ptr<RouteList> get_routes() const {
230 return routes.reader ();
233 boost::shared_ptr<RouteList> get_tracks() const;
234 boost::shared_ptr<RouteList> get_routes_with_internal_returns() const;
235 boost::shared_ptr<RouteList> get_routes_with_regions_at (framepos_t const) const;
237 uint32_t nroutes() const { return routes.reader()->size(); }
238 uint32_t ntracks () const;
239 uint32_t nbusses () const;
241 boost::shared_ptr<BundleList> bundles () {
242 return _bundles.reader ();
245 struct LIBARDOUR_API RoutePublicOrderSorter {
246 bool operator() (boost::shared_ptr<Route>, boost::shared_ptr<Route> b);
249 void set_order_hint (uint32_t order_hint) {_order_hint = order_hint;};
250 void notify_remote_id_change ();
251 void sync_order_keys ();
253 template<class T> void foreach_route (T *obj, void (T::*func)(Route&));
254 template<class T> void foreach_route (T *obj, void (T::*func)(boost::shared_ptr<Route>));
255 template<class T, class A> void foreach_route (T *obj, void (T::*func)(Route&, A), A arg);
257 static char session_name_is_legal (const std::string&);
258 bool io_name_is_legal (const std::string&);
259 boost::shared_ptr<Route> route_by_name (std::string);
260 boost::shared_ptr<Route> route_by_id (PBD::ID);
261 boost::shared_ptr<Route> route_by_remote_id (uint32_t id);
262 boost::shared_ptr<Track> track_by_diskstream_id (PBD::ID);
263 void routes_using_input_from (const std::string& str, RouteList& rl);
265 bool route_name_unique (std::string) const;
266 bool route_name_internal (std::string) const;
268 uint32_t track_number_decimals () const {
269 return _track_number_decimals;
272 bool get_record_enabled() const {
273 return (record_status () >= Enabled);
276 RecordState record_status() const {
277 return (RecordState) g_atomic_int_get (&_record_status);
280 bool actively_recording () const {
281 return record_status() == Recording;
284 bool record_enabling_legal () const;
285 void maybe_enable_record ();
286 void disable_record (bool rt_context, bool force = false);
287 void step_back_from_record ();
289 void maybe_write_autosave ();
291 /* Emitted when all i/o connections are complete */
293 PBD::Signal0<void> IOConnectionsComplete;
295 /* Record status signals */
297 PBD::Signal0<void> RecordStateChanged;
299 /* Transport mechanism signals */
301 /** Emitted on the following changes in transport state:
302 * - stop (from the butler thread)
303 * - change in whether or not we are looping (from the process thread)
304 * - change in the play range (from the process thread)
305 * - start (from the process thread)
308 PBD::Signal0<void> TransportStateChange;
310 PBD::Signal1<void,framepos_t> PositionChanged; /* sent after any non-sequential motion */
311 PBD::Signal1<void,framepos_t> Xrun;
312 PBD::Signal0<void> TransportLooped;
314 /** emitted when a locate has occurred */
315 PBD::Signal0<void> Located;
317 PBD::Signal1<void,RouteList&> RouteAdded;
318 /** Emitted when a property of one of our route groups changes.
319 * The parameter is the RouteGroup that has changed.
321 PBD::Signal1<void, RouteGroup *> RouteGroupPropertyChanged;
322 /** Emitted when a route is added to one of our route groups.
323 * First parameter is the RouteGroup, second is the route.
325 PBD::Signal2<void, RouteGroup *, boost::weak_ptr<Route> > RouteAddedToRouteGroup;
326 /** Emitted when a route is removed from one of our route groups.
327 * First parameter is the RouteGroup, second is the route.
329 PBD::Signal2<void, RouteGroup *, boost::weak_ptr<Route> > RouteRemovedFromRouteGroup;
331 /* Step Editing status changed */
332 PBD::Signal1<void,bool> StepEditStatusChange;
334 void queue_event (SessionEvent*);
336 void request_roll_at_and_return (framepos_t start, framepos_t return_to);
337 void request_bounded_roll (framepos_t start, framepos_t end);
338 void request_stop (bool abort = false, bool clear_state = false);
339 void request_locate (framepos_t frame, bool with_roll = false);
341 void request_play_loop (bool yn, bool leave_rolling = false);
342 bool get_play_loop () const { return play_loop; }
344 framepos_t last_transport_start () const { return _last_roll_location; }
347 void use_rf_shuttle_speed ();
348 void allow_auto_play (bool yn);
349 void request_transport_speed (double speed, bool as_default = false);
350 void request_transport_speed_nonzero (double, bool as_default = false);
351 void request_overwrite_buffer (Track *);
352 void adjust_playback_buffering();
353 void adjust_capture_buffering();
354 void request_track_speed (Track *, double speed);
355 void request_input_change_handling ();
357 bool locate_pending() const { return static_cast<bool>(post_transport_work()&PostTransportLocate); }
358 bool transport_locked () const;
362 framepos_t current_end_frame () const;
363 framepos_t current_start_frame () const;
364 /** "actual" sample rate of session, set by current audioengine rate, pullup/down etc. */
365 framecnt_t frame_rate () const { return _current_frame_rate; }
366 /** "native" sample rate of session, regardless of current audioengine rate, pullup/down etc */
367 framecnt_t nominal_frame_rate () const { return _nominal_frame_rate; }
368 framecnt_t frames_per_hour () const { return _frames_per_hour; }
370 double frames_per_timecode_frame() const { return _frames_per_timecode_frame; }
371 framecnt_t timecode_frames_per_hour() const { return _timecode_frames_per_hour; }
373 MIDI::byte get_mtc_timecode_bits() const {
374 return mtc_timecode_bits; /* encoding of SMTPE type for MTC */
377 double timecode_frames_per_second() const;
378 bool timecode_drop_frames() const;
382 Locations *locations() { return _locations; }
384 PBD::Signal1<void,Location*> auto_loop_location_changed;
385 PBD::Signal1<void,Location*> auto_punch_location_changed;
386 PBD::Signal0<void> locations_modified;
388 void set_auto_punch_location (Location *);
389 void set_auto_loop_location (Location *);
390 int location_name(std::string& result, std::string base = std::string(""));
392 pframes_t get_block_size() const { return current_block_size; }
393 framecnt_t worst_output_latency () const { return _worst_output_latency; }
394 framecnt_t worst_input_latency () const { return _worst_input_latency; }
395 framecnt_t worst_track_latency () const { return _worst_track_latency; }
396 framecnt_t worst_playback_latency () const { return _worst_output_latency + _worst_track_latency; }
398 int save_state (std::string snapshot_name, bool pending = false, bool switch_to_snapshot = false);
399 int restore_state (std::string snapshot_name);
400 int save_template (std::string template_name);
401 int save_history (std::string snapshot_name = "");
402 int restore_history (std::string snapshot_name);
403 void remove_state (std::string snapshot_name);
404 void rename_state (std::string old_name, std::string new_name);
405 void remove_pending_capture_state ();
406 int rename (const std::string&);
407 bool get_nsm_state () const { return _under_nsm_control; }
408 void set_nsm_state (bool state) { _under_nsm_control = state; }
409 bool save_default_options ();
411 PBD::Signal1<void,std::string> StateSaved;
412 PBD::Signal0<void> StateReady;
413 PBD::Signal0<void> SaveSession;
415 std::vector<std::string> possible_states() const;
416 static std::vector<std::string> possible_states (std::string path);
418 XMLNode& get_state();
419 int set_state(const XMLNode& node, int version); // not idempotent
420 XMLNode& get_template();
422 /// The instant xml file is written to the session directory
423 void add_instant_xml (XMLNode&, bool write_to_config = true);
424 XMLNode* instant_xml (const std::string& str);
426 enum StateOfTheState {
431 InitialConnecting = 0x8,
436 StateOfTheState state_of_the_state() const { return _state_of_the_state; }
438 class StateProtector {
440 StateProtector (Session* s) : _session (s) {
441 g_atomic_int_inc (&s->_suspend_save);
444 if (g_atomic_int_dec_and_test (&_session->_suspend_save)) {
445 while (_session->_save_queued) {
446 _session->_save_queued = false;
447 _session->save_state ("");
455 void add_route_group (RouteGroup *);
456 void remove_route_group (RouteGroup&);
457 void reorder_route_groups (std::list<RouteGroup*>);
459 RouteGroup* route_group_by_name (std::string);
460 RouteGroup& all_route_group() const;
462 PBD::Signal1<void,RouteGroup*> route_group_added;
463 PBD::Signal0<void> route_group_removed;
464 PBD::Signal0<void> route_groups_reordered;
466 void foreach_route_group (boost::function<void(RouteGroup*)> f) {
467 for (std::list<RouteGroup *>::iterator i = _route_groups.begin(); i != _route_groups.end(); ++i) {
472 std::list<RouteGroup*> const & route_groups () const {
473 return _route_groups;
476 /* fundamental operations. duh. */
478 std::list<boost::shared_ptr<AudioTrack> > new_audio_track (
481 TrackMode mode = Normal,
482 RouteGroup* route_group = 0,
483 uint32_t how_many = 1,
484 std::string name_template = ""
487 RouteList new_audio_route (
488 int input_channels, int output_channels, RouteGroup* route_group, uint32_t how_many, std::string name_template = ""
491 std::list<boost::shared_ptr<MidiTrack> > new_midi_track (
492 const ChanCount& input, const ChanCount& output,
493 boost::shared_ptr<PluginInfo> instrument = boost::shared_ptr<PluginInfo>(),
494 TrackMode mode = Normal,
495 RouteGroup* route_group = 0, uint32_t how_many = 1, std::string name_template = ""
498 void remove_route (boost::shared_ptr<Route>);
499 void resort_routes ();
500 void resort_routes_using (boost::shared_ptr<RouteList>);
502 AudioEngine & engine() { return _engine; }
503 AudioEngine const & engine () const { return _engine; }
507 framepos_t transport_frame () const {return _transport_frame; }
508 framepos_t record_location () const {return _last_record_location; }
509 framepos_t audible_frame () const;
510 framepos_t requested_return_frame() const { return _requested_return_frame; }
511 void set_requested_return_frame(framepos_t return_to);
525 void sync_time_vars();
527 void bbt_time (framepos_t when, Timecode::BBT_Time&);
528 void timecode_to_sample(Timecode::Time& timecode, framepos_t& sample, bool use_offset, bool use_subframes) const;
529 void sample_to_timecode(framepos_t sample, Timecode::Time& timecode, bool use_offset, bool use_subframes) const;
530 void timecode_time (Timecode::Time &);
531 void timecode_time (framepos_t when, Timecode::Time&);
532 void timecode_time_subframes (framepos_t when, Timecode::Time&);
534 void timecode_duration (framecnt_t, Timecode::Time&) const;
535 void timecode_duration_string (char *, size_t len, framecnt_t) const;
537 framecnt_t convert_to_frames (AnyTime const & position);
538 framecnt_t any_duration_to_frames (framepos_t position, AnyTime const & duration);
540 static PBD::Signal1<void, framepos_t> StartTimeChanged;
541 static PBD::Signal1<void, framepos_t> EndTimeChanged;
543 void request_sync_source (Slave*);
544 bool synced_to_engine() const { return config.get_external_sync() && Config->get_sync_source() == Engine; }
546 double transport_speed() const { return _transport_speed; }
547 bool transport_stopped() const { return _transport_speed == 0.0f; }
548 bool transport_rolling() const { return _transport_speed != 0.0f; }
550 void set_silent (bool yn);
551 bool silent () { return _silent; }
553 TempoMap& tempo_map() { return *_tempo_map; }
557 boost::shared_ptr<Region> find_whole_file_parent (boost::shared_ptr<Region const>) const;
559 boost::shared_ptr<Region> XMLRegionFactory (const XMLNode&, bool full);
560 boost::shared_ptr<AudioRegion> XMLAudioRegionFactory (const XMLNode&, bool full);
561 boost::shared_ptr<MidiRegion> XMLMidiRegionFactory (const XMLNode&, bool full);
563 /* source management */
565 void import_files (ImportStatus&);
566 bool sample_rate_convert (ImportStatus&, std::string infile, std::string& outfile);
567 std::string build_tmp_convert_name (std::string file);
569 boost::shared_ptr<ExportHandler> get_export_handler ();
570 boost::shared_ptr<ExportStatus> get_export_status ();
572 int start_audio_export (framepos_t position);
574 PBD::Signal1<int, framecnt_t> ProcessExport;
575 static PBD::Signal2<void,std::string, std::string> Exported;
577 void add_source (boost::shared_ptr<Source>);
578 void remove_source (boost::weak_ptr<Source>);
580 void cleanup_regions();
581 int cleanup_sources (CleanupReport&);
582 int cleanup_trash_sources (CleanupReport&);
584 int destroy_sources (std::list<boost::shared_ptr<Source> >);
586 int remove_last_capture ();
588 /** handlers should return 0 for "everything OK", and any other value for
589 * "cannot setup audioengine".
591 static PBD::Signal1<int,uint32_t> AudioEngineSetupRequired;
593 /** handlers should return -1 for "stop cleanup",
594 0 for "yes, delete this playlist",
595 1 for "no, don't delete this playlist".
597 static PBD::Signal1<int,boost::shared_ptr<Playlist> > AskAboutPlaylistDeletion;
599 /** handlers should return 0 for "ignore the rate mismatch",
600 !0 for "do not use this session"
602 static PBD::Signal2<int, framecnt_t, framecnt_t> AskAboutSampleRateMismatch;
604 /** handlers should return !0 for use pending state, 0 for ignore it.
606 static PBD::Signal0<int> AskAboutPendingState;
608 boost::shared_ptr<AudioFileSource> create_audio_source_for_session (
609 size_t, std::string const &, uint32_t, bool destructive);
611 boost::shared_ptr<MidiSource> create_midi_source_for_session (std::string const &);
612 boost::shared_ptr<MidiSource> create_midi_source_by_stealing_name (boost::shared_ptr<Track>);
614 boost::shared_ptr<Source> source_by_id (const PBD::ID&);
615 boost::shared_ptr<AudioFileSource> audio_source_by_path_and_channel (const std::string&, uint16_t) const;
616 boost::shared_ptr<MidiSource> midi_source_by_path (const std::string&) const;
617 uint32_t count_sources_by_origin (const std::string&);
619 void add_playlist (boost::shared_ptr<Playlist>, bool unused = false);
621 /* Curves and AutomationLists (TODO when they go away) */
622 void add_automation_list(AutomationList*);
626 boost::shared_ptr<Auditioner> the_auditioner() { return auditioner; }
627 void audition_playlist ();
628 void audition_region (boost::shared_ptr<Region>);
629 void cancel_audition ();
630 bool is_auditioning () const;
632 PBD::Signal1<void,bool> AuditionActive;
634 /* flattening stuff */
636 boost::shared_ptr<Region> write_one_track (AudioTrack&, framepos_t start, framepos_t end,
637 bool overwrite, std::vector<boost::shared_ptr<Source> >&, InterThreadInfo& wot,
638 boost::shared_ptr<Processor> endpoint,
639 bool include_endpoint, bool for_export, bool for_freeze);
640 int freeze_all (InterThreadInfo&);
642 /* session-wide solo/mute/rec-enable */
644 bool soloing() const { return _non_soloed_outs_muted; }
645 bool listening() const { return _listen_cnt > 0; }
646 bool solo_isolated() const { return _solo_isolated_cnt > 0; }
648 static const SessionEvent::RTeventCallback rt_cleanup;
650 void set_solo (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
651 void set_just_one_solo (boost::shared_ptr<Route>, bool, SessionEvent::RTeventCallback after = rt_cleanup);
652 void cancel_solo_after_disconnect (boost::shared_ptr<Route>, bool upstream, SessionEvent::RTeventCallback after = rt_cleanup);
653 void set_mute (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
654 void set_listen (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
655 void set_record_enabled (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
656 void set_solo_isolated (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
657 void set_monitoring (boost::shared_ptr<RouteList>, MonitorChoice, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
658 void set_exclusive_input_active (boost::shared_ptr<RouteList> rt, bool onoff, bool flip_others=false);
660 PBD::Signal1<void,bool> SoloActive;
661 PBD::Signal0<void> SoloChanged;
662 PBD::Signal0<void> IsolatedChanged;
664 /* monitor/master out */
666 void add_monitor_section ();
667 void remove_monitor_section ();
669 boost::shared_ptr<Route> monitor_out() const { return _monitor_out; }
670 boost::shared_ptr<Route> master_out() const { return _master_out; }
672 void globally_add_internal_sends (boost::shared_ptr<Route> dest, Placement p, bool);
673 void globally_set_send_gains_from_track (boost::shared_ptr<Route> dest);
674 void globally_set_send_gains_to_zero (boost::shared_ptr<Route> dest);
675 void globally_set_send_gains_to_unity (boost::shared_ptr<Route> dest);
676 void add_internal_sends (boost::shared_ptr<Route> dest, Placement p, boost::shared_ptr<RouteList> senders);
677 void add_internal_send (boost::shared_ptr<Route>, int, boost::shared_ptr<Route>);
678 void add_internal_send (boost::shared_ptr<Route>, boost::shared_ptr<Processor>, boost::shared_ptr<Route>);
680 static void set_disable_all_loaded_plugins (bool yn) {
681 _disable_all_loaded_plugins = yn;
683 static bool get_disable_all_loaded_plugins() {
684 return _disable_all_loaded_plugins;
687 uint32_t next_send_id();
688 uint32_t next_aux_send_id();
689 uint32_t next_return_id();
690 uint32_t next_insert_id();
691 void mark_send_id (uint32_t);
692 void mark_aux_send_id (uint32_t);
693 void mark_return_id (uint32_t);
694 void mark_insert_id (uint32_t);
695 void unmark_send_id (uint32_t);
696 void unmark_aux_send_id (uint32_t);
697 void unmark_return_id (uint32_t);
698 void unmark_insert_id (uint32_t);
700 /* s/w "RAID" management */
702 boost::optional<framecnt_t> available_capture_duration();
706 void add_bundle (boost::shared_ptr<Bundle>);
707 void remove_bundle (boost::shared_ptr<Bundle>);
708 boost::shared_ptr<Bundle> bundle_by_name (std::string) const;
710 PBD::Signal1<void,boost::shared_ptr<Bundle> > BundleAdded;
711 PBD::Signal1<void,boost::shared_ptr<Bundle> > BundleRemoved;
715 /* History (for editors, mixers, UIs etc.) */
717 /** Undo some transactions.
718 * @param n Number of transactions to undo.
720 void undo (uint32_t n) {
724 void redo (uint32_t n) {
728 UndoHistory& history() { return _history; }
730 uint32_t undo_depth() const { return _history.undo_depth(); }
731 uint32_t redo_depth() const { return _history.redo_depth(); }
732 std::string next_undo() const { return _history.next_undo(); }
733 std::string next_redo() const { return _history.next_redo(); }
735 void begin_reversible_command (const std::string& cmd_name);
736 void begin_reversible_command (GQuark);
737 void commit_reversible_command (Command* cmd = 0);
739 void add_command (Command *const cmd) {
740 assert (_current_trans);
741 _current_trans->add_command (cmd);
744 /** @return The list of operations that are currently in progress */
745 std::list<GQuark> const & current_operations () {
746 return _current_trans_quarks;
749 bool operation_in_progress (GQuark) const;
751 void add_commands (std::vector<Command*> const & cmds);
753 std::map<PBD::ID,PBD::StatefulDestructible*> registry;
755 // these commands are implemented in libs/ardour/session_command.cc
756 Command* memento_command_factory(XMLNode* n);
757 Command* stateful_diff_command_factory (XMLNode *);
758 void register_with_memento_command_factory(PBD::ID, PBD::StatefulDestructible*);
762 boost::shared_ptr<IO> click_io() { return _click_io; }
763 boost::shared_ptr<Amp> click_gain() { return _click_gain; }
765 /* disk, buffer loads */
767 uint32_t playback_load ();
768 uint32_t capture_load ();
772 void request_play_range (std::list<AudioRange>*, bool leave_rolling = false);
773 void request_cancel_play_range ();
774 bool get_play_range () const { return _play_range; }
776 void maybe_update_session_range (framepos_t, framepos_t);
778 /* buffers for gain and pan */
780 gain_t* gain_automation_buffer () const;
781 gain_t* send_gain_automation_buffer () const;
782 pan_t** pan_automation_buffer () const;
784 void ensure_buffer_set (BufferSet& buffers, const ChanCount& howmany);
788 static int vst_current_loading_id;
789 static const char* vst_can_do_strings[];
790 static const int vst_can_do_string_count;
792 static intptr_t vst_callback (
801 static PBD::Signal0<void> SendFeedback;
805 boost::shared_ptr<Speakers> get_speakers ();
809 boost::shared_ptr<PBD::Controllable> controllable_by_id (const PBD::ID&);
810 boost::shared_ptr<PBD::Controllable> controllable_by_descriptor (const PBD::ControllableDescriptor&);
812 void add_controllable (boost::shared_ptr<PBD::Controllable>);
813 void remove_controllable (PBD::Controllable*);
815 boost::shared_ptr<PBD::Controllable> solo_cut_control() const;
817 SessionConfiguration config;
819 bool exporting () const {
823 bool bounce_processing() const {
824 return _bounce_processing_active;
827 /* this is a private enum, but setup_enum_writer() needs it,
828 and i can't find a way to give that function
832 enum PostTransportWork {
833 PostTransportStop = 0x1,
834 PostTransportDuration = 0x2,
835 PostTransportLocate = 0x4,
836 PostTransportRoll = 0x8,
837 PostTransportAbort = 0x10,
838 PostTransportOverWrite = 0x20,
839 PostTransportSpeed = 0x40,
840 PostTransportAudition = 0x80,
841 PostTransportReverse = 0x100,
842 PostTransportInputChange = 0x200,
843 PostTransportCurveRealloc = 0x400,
844 PostTransportClearSubstate = 0x800,
845 PostTransportAdjustPlaybackBuffering = 0x1000,
846 PostTransportAdjustCaptureBuffering = 0x2000
855 SlaveState slave_state() const { return _slave_state; }
856 Slave* slave() const { return _slave; }
858 boost::shared_ptr<SessionPlaylists> playlists;
860 void send_mmc_locate (framepos_t);
861 void queue_full_time_code () { _send_timecode_update = true; }
862 void queue_song_position_pointer () { /* currently does nothing */ }
864 bool step_editing() const { return (_step_editors > 0); }
866 void request_suspend_timecode_transmission ();
867 void request_resume_timecode_transmission ();
868 bool timecode_transmission_suspended () const;
870 std::vector<std::string> source_search_path(DataType) const;
871 void ensure_search_path_includes (const std::string& path, DataType type);
872 void remove_dir_from_search_path (const std::string& path, DataType type);
874 std::list<std::string> unknown_processors () const;
876 /** Emitted when a feedback cycle has been detected within Ardour's signal
877 processing path. Until it is fixed (by the user) some (unspecified)
878 routes will not be run.
880 static PBD::Signal0<void> FeedbackDetected;
882 /** Emitted when a graph sort has successfully completed, which means
883 that it has no feedback cycles.
885 static PBD::Signal0<void> SuccessfulGraphSort;
887 /* handlers can return an integer value:
888 0: config.set_audio_search_path() or config.set_midi_search_path() was used
889 to modify the search path and we should try to find it again.
890 1: quit entire session load
891 2: as 0, but don't ask about other missing files
892 3: don't ask about other missing files, and just mark this one missing
893 -1: just mark this one missing
894 any other value: as -1
896 static PBD::Signal3<int,Session*,std::string,DataType> MissingFile;
898 /** Emitted when the session wants Ardour to quit */
899 static PBD::Signal0<void> Quit;
901 /** Emitted when Ardour is asked to load a session in an older session
902 * format, and makes a backup copy.
904 static PBD::Signal2<void,std::string,std::string> VersionMismatch;
906 SceneChanger* scene_changer() const { return _scene_changer; }
908 boost::shared_ptr<Port> ltc_input_port() const;
909 boost::shared_ptr<Port> ltc_output_port() const;
911 boost::shared_ptr<IO> ltc_input_io() { return _ltc_input; }
912 boost::shared_ptr<IO> ltc_output_io() { return _ltc_output; }
914 MIDI::Port* midi_input_port () const;
915 MIDI::Port* midi_output_port () const;
916 MIDI::Port* mmc_output_port () const;
917 MIDI::Port* mmc_input_port () const;
919 MIDI::Port* scene_input_port () const;
920 MIDI::Port* scene_output_port () const;
922 boost::shared_ptr<MidiPort> scene_in () const;
923 boost::shared_ptr<MidiPort> scene_out () const;
925 boost::shared_ptr<MidiPort> midi_clock_output_port () const;
926 boost::shared_ptr<MidiPort> midi_clock_input_port () const;
927 boost::shared_ptr<MidiPort> mtc_output_port () const;
928 boost::shared_ptr<MidiPort> mtc_input_port () const;
930 MIDI::MachineControl& mmc() { return *_mmc; }
933 friend class AudioEngine;
934 void set_block_size (pframes_t nframes);
935 void set_frame_rate (framecnt_t nframes);
936 void reconnect_existing_routes (bool withLock, bool reconnect_master = true, bool reconnect_inputs = true, bool reconnect_outputs = true);
940 void schedule_curve_reallocation ();
941 void update_latency_compensation (bool force = false);
944 int create (const std::string& mix_template, BusProfile*);
948 PendingDeclickIn = 0x1, ///< pending de-click fade-in for start
949 PendingDeclickOut = 0x2, ///< pending de-click fade-out for stop
950 StopPendingCapture = 0x4,
951 PendingLoopDeclickIn = 0x8, ///< pending de-click fade-in at the start of a loop
952 PendingLoopDeclickOut = 0x10, ///< pending de-click fade-out at the end of a loop
953 PendingLocate = 0x20,
956 /* stuff used in process() should be close together to
960 typedef void (Session::*process_function_type)(pframes_t);
962 AudioEngine& _engine;
963 mutable gint processing_prohibited;
964 process_function_type process_function;
965 process_function_type last_process_function;
966 bool _bounce_processing_active;
967 bool waiting_for_sync_offset;
968 framecnt_t _base_frame_rate;
969 framecnt_t _current_frame_rate; //this includes video pullup offset
970 framecnt_t _nominal_frame_rate; //ignores audioengine setting, "native" SR
971 int transport_sub_state;
972 mutable gint _record_status;
973 framepos_t _transport_frame;
974 Location* _session_range_location; ///< session range, or 0 if there is nothing in the session yet
978 // varispeed playback
979 double _transport_speed;
980 double _default_transport_speed;
981 double _last_transport_speed;
982 double _target_transport_speed;
983 CubicInterpolation interpolation;
985 bool auto_play_legal;
986 framepos_t _last_slave_transport_frame;
987 framecnt_t maximum_output_latency;
988 framepos_t _requested_return_frame;
989 pframes_t current_block_size;
990 framecnt_t _worst_output_latency;
991 framecnt_t _worst_input_latency;
992 framecnt_t _worst_track_latency;
995 float _meter_falloff;
996 bool _non_soloed_outs_muted;
997 uint32_t _listen_cnt;
998 uint32_t _solo_isolated_cnt;
1001 bool _under_nsm_control;
1003 void initialize_latencies ();
1004 void set_worst_io_latencies ();
1005 void set_worst_playback_latency ();
1006 void set_worst_capture_latency ();
1007 void set_worst_io_latencies_x (IOChange, void *) {
1008 set_worst_io_latencies ();
1010 void post_capture_latency ();
1011 void post_playback_latency ();
1013 void update_latency_compensation_proxy (void* ignored);
1015 void ensure_buffers (ChanCount howmany = ChanCount::ZERO);
1017 void process_scrub (pframes_t);
1018 void process_without_events (pframes_t);
1019 void process_with_events (pframes_t);
1020 void process_audition (pframes_t);
1021 int process_export (pframes_t);
1022 int process_export_fw (pframes_t);
1024 void block_processing() { g_atomic_int_set (&processing_prohibited, 1); }
1025 void unblock_processing() { g_atomic_int_set (&processing_prohibited, 0); }
1026 bool processing_blocked() const { return g_atomic_int_get (&processing_prohibited); }
1028 static const framecnt_t bounce_chunk_size;
1030 /* slave tracking */
1032 static const int delta_accumulator_size = 25;
1033 int delta_accumulator_cnt;
1034 int32_t delta_accumulator[delta_accumulator_size];
1035 int32_t average_slave_delta;
1037 bool have_first_delta_accumulator;
1039 SlaveState _slave_state;
1040 framepos_t slave_wait_end;
1042 void reset_slave_state ();
1043 bool follow_slave (pframes_t);
1044 void calculate_moving_average_of_slave_delta (int dir, framecnt_t this_delta);
1045 void track_slave_state (float slave_speed, framepos_t slave_transport_frame, framecnt_t this_delta);
1046 void follow_slave_silently (pframes_t nframes, float slave_speed);
1048 void switch_to_sync_source (SyncSource); /* !RT context */
1049 void drop_sync_source (); /* !RT context */
1050 void use_sync_source (Slave*); /* RT context */
1052 bool post_export_sync;
1053 framepos_t post_export_position;
1056 bool _export_started;
1057 bool _export_rolling;
1059 boost::shared_ptr<ExportHandler> export_handler;
1060 boost::shared_ptr<ExportStatus> export_status;
1063 int stop_audio_export ();
1064 void finalize_audio_export ();
1065 void finalize_export_internal (bool stop_freewheel);
1066 bool _pre_export_mmc_enabled;
1068 PBD::ScopedConnection export_freewheel_connection;
1070 void get_track_statistics ();
1071 int process_routes (pframes_t, bool& need_butler);
1072 int silent_process_routes (pframes_t, bool& need_butler);
1074 /** @return 1 if there is a pending declick fade-in,
1075 -1 if there is a pending declick fade-out,
1076 0 if there is no pending declick.
1078 int get_transport_declick_required () {
1079 if (transport_sub_state & PendingDeclickIn) {
1080 transport_sub_state &= ~PendingDeclickIn;
1082 } else if (transport_sub_state & PendingDeclickOut) {
1083 /* XXX: not entirely sure why we don't clear this */
1085 } else if (transport_sub_state & PendingLoopDeclickOut) {
1086 /* Return the declick out first ... */
1087 transport_sub_state &= ~PendingLoopDeclickOut;
1089 } else if (transport_sub_state & PendingLoopDeclickIn) {
1090 /* ... then the declick in on the next call */
1091 transport_sub_state &= ~PendingLoopDeclickIn;
1098 bool maybe_stop (framepos_t limit);
1099 bool maybe_sync_start (pframes_t &);
1101 void check_declick_out ();
1107 /** Number of process frames since the last MTC output (when sending MTC); used to
1108 * know when to send full MTC messages every so often.
1110 pframes_t _pframes_since_last_mtc;
1111 bool session_midi_feedback;
1114 framepos_t last_loopend;
1116 boost::scoped_ptr<SessionDirectory> _session_dir;
1119 void graph_reordered ();
1121 /** current snapshot name, without the .ardour suffix */
1122 std::string _current_snapshot_name;
1124 XMLTree* state_tree;
1125 bool state_was_pending;
1126 StateOfTheState _state_of_the_state;
1128 friend class StateProtector;
1129 gint _suspend_save; /* atomic */
1130 volatile bool _save_queued;
1131 Glib::Threads::Mutex save_state_lock;
1133 int load_options (const XMLNode&);
1134 int load_state (std::string snapshot_name);
1136 framepos_t _last_roll_location;
1137 /** the session frame time at which we last rolled, located, or changed transport direction */
1138 framepos_t _last_roll_or_reversal_location;
1139 framepos_t _last_record_location;
1141 bool pending_locate_roll;
1142 framepos_t pending_locate_frame;
1143 bool pending_locate_flush;
1145 bool pending_auto_loop;
1149 static const PostTransportWork ProcessCannotProceedMask =
1151 PostTransportInputChange|
1153 PostTransportReverse|
1154 PostTransportCurveRealloc|
1155 PostTransportAudition|
1156 PostTransportLocate|
1158 PostTransportClearSubstate);
1160 gint _post_transport_work; /* accessed only atomic ops */
1161 PostTransportWork post_transport_work() const { return (PostTransportWork) g_atomic_int_get (const_cast<gint*>(&_post_transport_work)); }
1162 void set_post_transport_work (PostTransportWork ptw) { g_atomic_int_set (&_post_transport_work, (gint) ptw); }
1163 void add_post_transport_work (PostTransportWork ptw);
1165 void schedule_playback_buffering_adjustment ();
1166 void schedule_capture_buffering_adjustment ();
1168 uint32_t cumulative_rf_motion;
1171 void set_rf_speed (float speed);
1172 void reset_rf_scale (framecnt_t frames_moved);
1174 Locations* _locations;
1175 void locations_changed ();
1176 void locations_added (Location*);
1177 void handle_locations_changed (Locations::LocationList&);
1178 void sync_locations_to_skips (Locations::LocationList&);
1180 PBD::ScopedConnectionList punch_connections;
1181 void auto_punch_start_changed (Location *);
1182 void auto_punch_end_changed (Location *);
1183 void auto_punch_changed (Location *);
1185 PBD::ScopedConnectionList loop_connections;
1186 void auto_loop_changed (Location *);
1187 void auto_loop_declick_range (Location *, framepos_t &, framepos_t &);
1189 int ensure_engine (uint32_t desired_sample_rate);
1190 void pre_engine_init (std::string path);
1191 int post_engine_init ();
1192 int immediately_post_engine ();
1193 void remove_empty_sounds ();
1195 void setup_midi_control ();
1196 int midi_read (MIDI::Port *);
1198 void enable_record ();
1200 void increment_transport_position (framecnt_t val) {
1201 if (max_framepos - val < _transport_frame) {
1202 _transport_frame = max_framepos;
1204 _transport_frame += val;
1208 void decrement_transport_position (framecnt_t val) {
1209 if (val < _transport_frame) {
1210 _transport_frame -= val;
1212 _transport_frame = 0;
1216 void post_transport_motion ();
1217 static void *session_loader_thread (void *arg);
1221 /* SessionEventManager interface */
1223 void process_event (SessionEvent*);
1224 void set_next_event ();
1225 void cleanup_event (SessionEvent*,int);
1227 /* MIDI Machine Control */
1230 void spp_continue ();
1233 void mmc_deferred_play (MIDI::MachineControl &);
1234 void mmc_stop (MIDI::MachineControl &);
1235 void mmc_step (MIDI::MachineControl &, int);
1236 void mmc_pause (MIDI::MachineControl &);
1237 void mmc_record_pause (MIDI::MachineControl &);
1238 void mmc_record_strobe (MIDI::MachineControl &);
1239 void mmc_record_exit (MIDI::MachineControl &);
1240 void mmc_track_record_status (MIDI::MachineControl &, uint32_t track, bool enabled);
1241 void mmc_fast_forward (MIDI::MachineControl &);
1242 void mmc_rewind (MIDI::MachineControl &);
1243 void mmc_locate (MIDI::MachineControl &, const MIDI::byte *);
1244 void mmc_shuttle (MIDI::MachineControl &mmc, float speed, bool forw);
1245 void mmc_record_enable (MIDI::MachineControl &mmc, size_t track, bool enabled);
1247 struct timeval last_mmc_step;
1250 typedef boost::function<bool()> MidiTimeoutCallback;
1251 typedef std::list<MidiTimeoutCallback> MidiTimeoutList;
1253 MidiTimeoutList midi_timeouts;
1254 bool mmc_step_timeout ();
1256 MIDI::byte mtc_msg[16];
1257 MIDI::byte mtc_timecode_bits; /* encoding of SMTPE type for MTC */
1258 MIDI::byte midi_msg[16];
1259 double outbound_mtc_timecode_frame;
1260 Timecode::Time transmitting_timecode_time;
1261 int next_quarter_frame_to_send;
1263 double _frames_per_timecode_frame; /* has to be floating point because of drop frame */
1264 framecnt_t _frames_per_hour;
1265 framecnt_t _timecode_frames_per_hour;
1267 /* cache the most-recently requested time conversions. This helps when we
1268 * have multiple clocks showing the same time (e.g. the transport frame) */
1269 bool last_timecode_valid;
1270 framepos_t last_timecode_when;
1271 Timecode::Time last_timecode;
1273 bool _send_timecode_update; ///< Flag to send a full frame (Timecode) MTC message this cycle
1275 int send_midi_time_code_for_cycle (framepos_t, framepos_t, pframes_t nframes);
1277 LTCEncoder* ltc_encoder;
1278 ltcsnd_sample_t* ltc_enc_buf;
1280 Timecode::TimecodeFormat ltc_enc_tcformat;
1281 int32_t ltc_buf_off;
1282 int32_t ltc_buf_len;
1285 int32_t ltc_enc_byte;
1286 framepos_t ltc_enc_pos;
1288 framepos_t ltc_enc_off;
1290 framepos_t ltc_prev_cycle;
1292 framepos_t ltc_timecode_offset;
1293 bool ltc_timecode_negative_offset;
1295 LatencyRange ltc_out_latency;
1297 void ltc_tx_initialize();
1298 void ltc_tx_cleanup();
1299 void ltc_tx_reset();
1300 void ltc_tx_resync_latency();
1301 void ltc_tx_recalculate_position();
1302 void ltc_tx_parse_offset();
1303 void ltc_tx_send_time_code_for_cycle (framepos_t, framepos_t, double, double, pframes_t nframes);
1305 void reset_record_status ();
1307 int no_roll (pframes_t nframes);
1308 int fail_roll (pframes_t nframes);
1310 bool non_realtime_work_pending() const { return static_cast<bool>(post_transport_work()); }
1311 bool process_can_proceed() const { return !(post_transport_work() & ProcessCannotProceedMask); }
1313 MidiControlUI* midi_control_ui;
1315 int start_midi_thread ();
1317 void set_play_loop (bool yn, double speed);
1318 void unset_play_loop ();
1319 void overwrite_some_buffers (Track *);
1320 void flush_all_inserts ();
1321 int micro_locate (framecnt_t distance);
1322 void locate (framepos_t, bool with_roll, bool with_flush, bool with_loop=false, bool force=false, bool with_mmc=true);
1323 void start_locate (framepos_t, bool with_roll, bool with_flush, bool with_loop=false, bool force=false);
1324 void force_locate (framepos_t frame, bool with_roll = false);
1325 void set_track_speed (Track *, double speed);
1326 void set_transport_speed (double speed, framepos_t destination_frame, bool abort = false, bool clear_state = false, bool as_default = false);
1327 void stop_transport (bool abort = false, bool clear_state = false);
1328 void start_transport ();
1329 void realtime_stop (bool abort, bool clear_state);
1330 void realtime_locate ();
1331 void non_realtime_start_scrub ();
1332 void non_realtime_set_speed ();
1333 void non_realtime_locate ();
1334 void non_realtime_stop (bool abort, int entry_request_count, bool& finished);
1335 void non_realtime_overwrite (int entry_request_count, bool& finished);
1336 void post_transport ();
1337 void engine_halted ();
1338 void xrun_recovery ();
1340 /* These are synchronous and so can only be called from within the process
1344 int send_full_time_code (framepos_t, pframes_t nframes);
1345 void send_song_position_pointer (framepos_t);
1347 TempoMap *_tempo_map;
1348 void tempo_map_changed (const PBD::PropertyChange&);
1350 /* edit/mix groups */
1352 int load_route_groups (const XMLNode&, int);
1354 std::list<RouteGroup *> _route_groups;
1355 RouteGroup* _all_route_group;
1359 boost::shared_ptr<Graph> _process_graph;
1361 SerializedRCUManager<RouteList> routes;
1363 void add_routes (RouteList&, bool input_auto_connect, bool output_auto_connect, bool save);
1364 void add_routes_inner (RouteList&, bool input_auto_connect, bool output_auto_connect);
1365 bool _adding_routes_in_progress;
1366 uint32_t destructive_index;
1368 boost::shared_ptr<Route> XMLRouteFactory (const XMLNode&, int);
1369 boost::shared_ptr<Route> XMLRouteFactory_2X (const XMLNode&, int);
1371 void route_processors_changed (RouteProcessorChange);
1373 bool find_route_name (std::string const &, uint32_t& id, char* name, size_t name_len, bool);
1374 void count_existing_track_channels (ChanCount& in, ChanCount& out);
1375 void auto_connect_route (boost::shared_ptr<Route> route, ChanCount& existing_inputs, ChanCount& existing_outputs,
1376 bool with_lock, bool connect_inputs = true,
1377 ChanCount input_start = ChanCount (), ChanCount output_start = ChanCount ());
1378 void midi_output_change_handler (IOChange change, void* /*src*/, boost::weak_ptr<Route> midi_track);
1380 /* track numbering */
1382 void reassign_track_numbers ();
1383 uint32_t _track_number_decimals;
1387 bool solo_update_disabled;
1389 void route_listen_changed (void *src, boost::weak_ptr<Route>);
1390 void route_mute_changed (void *src);
1391 void route_solo_changed (bool self_solo_change, void *src, boost::weak_ptr<Route>);
1392 void route_solo_isolated_changed (void *src, boost::weak_ptr<Route>);
1393 void update_route_solo_state (boost::shared_ptr<RouteList> r = boost::shared_ptr<RouteList>());
1395 void listen_position_changed ();
1396 void solo_control_mode_changed ();
1398 /* REGION MANAGEMENT */
1400 mutable Glib::Threads::Mutex region_lock;
1402 int load_regions (const XMLNode& node);
1403 int load_compounds (const XMLNode& node);
1405 void route_added_to_route_group (RouteGroup *, boost::weak_ptr<Route>);
1406 void route_removed_from_route_group (RouteGroup *, boost::weak_ptr<Route>);
1407 void route_group_property_changed (RouteGroup *);
1411 mutable Glib::Threads::Mutex source_lock;
1414 typedef std::map<PBD::ID,boost::shared_ptr<Source> > SourceMap;
1420 int load_sources (const XMLNode& node);
1421 XMLNode& get_sources_as_xml ();
1423 boost::shared_ptr<Source> XMLSourceFactory (const XMLNode&);
1427 void remove_playlist (boost::weak_ptr<Playlist>);
1428 void track_playlist_changed (boost::weak_ptr<Track>);
1429 void playlist_region_added (boost::weak_ptr<Region>);
1430 void playlist_ranges_moved (std::list<Evoral::RangeMove<framepos_t> > const &);
1431 void playlist_regions_extended (std::list<Evoral::Range<framepos_t> > const &);
1433 /* CURVES and AUTOMATION LISTS */
1434 std::map<PBD::ID, AutomationList*> automation_lists;
1436 /* DEFAULT FADE CURVES */
1438 float default_fade_steepness;
1439 float default_fade_msecs;
1443 boost::shared_ptr<Auditioner> auditioner;
1444 void set_audition (boost::shared_ptr<Region>);
1445 void non_realtime_set_audition ();
1446 boost::shared_ptr<Region> pending_audition_region;
1452 int flatten_one_track (AudioTrack&, framepos_t start, framecnt_t cnt);
1454 /* INSERT AND SEND MANAGEMENT */
1456 boost::dynamic_bitset<uint32_t> send_bitset;
1457 boost::dynamic_bitset<uint32_t> aux_send_bitset;
1458 boost::dynamic_bitset<uint32_t> return_bitset;
1459 boost::dynamic_bitset<uint32_t> insert_bitset;
1463 struct space_and_path {
1464 uint32_t blocks; ///< 4kB blocks
1465 bool blocks_unknown; ///< true if blocks is unknown
1470 , blocks_unknown (true)
1474 struct space_and_path_ascending_cmp {
1475 bool operator() (space_and_path a, space_and_path b) {
1476 if (a.blocks_unknown != b.blocks_unknown) {
1477 return !a.blocks_unknown;
1479 return a.blocks > b.blocks;
1483 void setup_raid_path (std::string path);
1485 std::vector<space_and_path> session_dirs;
1486 std::vector<space_and_path>::iterator last_rr_session_dir;
1487 uint32_t _total_free_4k_blocks;
1488 /** If this is true, _total_free_4k_blocks is not definite,
1489 as one or more of the session directories' filesystems
1490 could not report free space.
1492 bool _total_free_4k_blocks_uncertain;
1493 Glib::Threads::Mutex space_lock;
1495 bool no_questions_about_missing_files;
1497 std::string get_best_session_directory_for_new_audio ();
1499 mutable gint _playback_load;
1500 mutable gint _capture_load;
1504 SerializedRCUManager<BundleList> _bundles;
1505 XMLNode* _bundle_xml_node;
1506 int load_bundles (XMLNode const &);
1508 UndoHistory _history;
1509 /** current undo transaction, or 0 */
1510 UndoTransaction* _current_trans;
1511 /** GQuarks to describe the reversible commands that are currently in progress.
1512 * These may be nested, in which case more recently-started commands are toward
1513 * the front of the list.
1515 std::list<GQuark> _current_trans_quarks;
1517 int backend_sync_callback (TransportState, framepos_t);
1519 void process_rtop (SessionEvent*);
1521 void update_latency (bool playback);
1523 XMLNode& state(bool);
1526 typedef std::list<Click*> Clicks;
1529 boost::shared_ptr<IO> _click_io;
1530 boost::shared_ptr<Amp> _click_gain;
1532 Sample* click_emphasis_data;
1533 framecnt_t click_length;
1534 framecnt_t click_emphasis_length;
1535 mutable Glib::Threads::RWLock click_lock;
1537 static const Sample default_click[];
1538 static const framecnt_t default_click_length;
1539 static const Sample default_click_emphasis[];
1540 static const framecnt_t default_click_emphasis_length;
1543 framepos_t _clicks_cleared;
1544 void setup_click_sounds (int which);
1545 void setup_click_sounds (Sample**, Sample const *, framecnt_t*, framecnt_t, std::string const &);
1546 void clear_clicks ();
1547 void click (framepos_t start, framecnt_t nframes);
1549 std::vector<Route*> master_outs;
1551 /* range playback */
1553 std::list<AudioRange> current_audio_range;
1555 void set_play_range (std::list<AudioRange>&, bool leave_rolling);
1556 void unset_play_range ();
1561 boost::shared_ptr<Route> _master_out;
1562 boost::shared_ptr<Route> _monitor_out;
1564 void auto_connect_master_bus ();
1566 /* Windows VST support */
1568 long _windows_vst_callback (
1577 int find_all_sources (std::string path, std::set<std::string>& result);
1578 int find_all_sources_across_snapshots (std::set<std::string>& result, bool exclude_this_snapshot);
1580 typedef std::set<boost::shared_ptr<PBD::Controllable> > Controllables;
1581 Glib::Threads::Mutex controllables_lock;
1582 Controllables controllables;
1584 boost::shared_ptr<PBD::Controllable> _solo_cut_control;
1586 void reset_native_file_format();
1587 bool first_file_data_format_reset;
1588 bool first_file_header_format_reset;
1590 void config_changed (std::string, bool);
1592 XMLNode& get_control_protocol_state ();
1594 void set_history_depth (uint32_t depth);
1596 static bool _disable_all_loaded_plugins;
1598 mutable bool have_looped; ///< Used in ::audible_frame(*)
1600 void update_have_rec_enabled_track ();
1601 gint _have_rec_enabled_track;
1603 static int ask_about_playlist_deletion (boost::shared_ptr<Playlist>);
1605 /* realtime "apply to set of routes" operations */
1606 template<typename T> SessionEvent*
1607 get_rt_event (boost::shared_ptr<RouteList> rl, T targ, SessionEvent::RTeventCallback after, bool group_override,
1608 void (Session::*method) (boost::shared_ptr<RouteList>, T, bool)) {
1609 SessionEvent* ev = new SessionEvent (SessionEvent::RealTimeOperation, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
1610 ev->rt_slot = boost::bind (method, this, rl, targ, group_override);
1611 ev->rt_return = after;
1612 ev->event_loop = PBD::EventLoop::get_event_loop_for_thread ();
1617 void rt_cancel_solo_after_disconnect (boost::shared_ptr<RouteList>, bool upstream, bool /* ignored*/ );
1618 void rt_set_solo (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1619 void rt_set_just_one_solo (boost::shared_ptr<RouteList>, bool yn, bool /* ignored*/ );
1620 void rt_set_mute (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1621 void rt_set_listen (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1622 void rt_set_solo_isolated (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1623 void rt_set_record_enabled (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1624 void rt_set_monitoring (boost::shared_ptr<RouteList>, MonitorChoice, bool group_override);
1626 /** temporary list of Diskstreams used only during load of 2.X sessions */
1627 std::list<boost::shared_ptr<Diskstream> > _diskstreams_2X;
1629 void add_session_range_location (framepos_t, framepos_t);
1631 void setup_midi_machine_control ();
1633 void step_edit_status_change (bool);
1634 uint32_t _step_editors;
1636 /** true if timecode transmission by the transport is suspended, otherwise false */
1637 mutable gint _suspend_timecode_transmission;
1639 void update_locations_after_tempo_map_change (Locations::LocationList &);
1641 void start_time_changed (framepos_t);
1642 void end_time_changed (framepos_t);
1644 void set_track_monitor_input_status (bool);
1645 framepos_t compute_stop_limit () const;
1647 boost::shared_ptr<Speakers> _speakers;
1648 void load_nested_sources (const XMLNode& node);
1650 /** The directed graph of routes that is currently being used for audio processing
1651 and solo/mute computations.
1653 GraphEdges _current_route_graph;
1655 uint32_t next_control_id () const;
1656 uint32_t _order_hint;
1657 bool ignore_route_processor_changes;
1659 MidiClockTicker* midi_clock;
1661 boost::shared_ptr<IO> _ltc_input;
1662 boost::shared_ptr<IO> _ltc_output;
1664 void reconnect_ltc_input ();
1665 void reconnect_ltc_output ();
1667 /* Scene Changing */
1668 SceneChanger* _scene_changer;
1670 /* persistent, non-track related MIDI ports */
1671 MidiPortManager* _midi_ports;
1672 MIDI::MachineControl* _mmc;
1675 void setup_click ();
1676 void setup_click_state (const XMLNode*);
1677 void setup_bundles ();
1679 static int get_session_info_from_path (XMLTree& state_tree, const std::string& xmlpath);
1683 } // namespace ARDOUR
1685 #endif /* __ardour_session_h__ */