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 std::string new_audio_source_name (const std::string&, uint32_t nchans, uint32_t chan, bool destructive);
200 std::string new_midi_source_name (const std::string&);
201 std::string new_source_path_from_name (DataType type, const std::string&);
202 RouteList new_route_from_template (uint32_t how_many, const std::string& template_path, const std::string& name);
204 void process (pframes_t nframes);
206 BufferSet& get_silent_buffers (ChanCount count = ChanCount::ZERO);
207 BufferSet& get_scratch_buffers (ChanCount count = ChanCount::ZERO, bool silence = true );
208 BufferSet& get_route_buffers (ChanCount count = ChanCount::ZERO, bool silence = true);
209 BufferSet& get_mix_buffers (ChanCount count = ChanCount::ZERO);
211 bool have_rec_enabled_track () const;
213 bool have_captured() const { return _have_captured; }
215 void refill_all_track_buffers ();
216 Butler* butler() { return _butler; }
217 void butler_transport_work ();
219 void refresh_disk_space ();
221 int load_diskstreams_2X (XMLNode const &, int);
223 int load_routes (const XMLNode&, int);
224 boost::shared_ptr<RouteList> get_routes() const {
225 return routes.reader ();
228 boost::shared_ptr<RouteList> get_routes_with_internal_returns() const;
230 boost::shared_ptr<RouteList> get_routes_with_regions_at (framepos_t const) const;
232 uint32_t nroutes() const { return routes.reader()->size(); }
233 uint32_t ntracks () const;
234 uint32_t nbusses () const;
236 boost::shared_ptr<BundleList> bundles () {
237 return _bundles.reader ();
240 struct LIBARDOUR_API RoutePublicOrderSorter {
241 bool operator() (boost::shared_ptr<Route>, boost::shared_ptr<Route> b);
244 void set_order_hint (uint32_t order_hint) {_order_hint = order_hint;};
245 void notify_remote_id_change ();
246 void sync_order_keys ();
248 template<class T> void foreach_route (T *obj, void (T::*func)(Route&));
249 template<class T> void foreach_route (T *obj, void (T::*func)(boost::shared_ptr<Route>));
250 template<class T, class A> void foreach_route (T *obj, void (T::*func)(Route&, A), A arg);
252 static char session_name_is_legal (const std::string&);
253 bool io_name_is_legal (const std::string&);
254 boost::shared_ptr<Route> route_by_name (std::string);
255 boost::shared_ptr<Route> route_by_id (PBD::ID);
256 boost::shared_ptr<Route> route_by_remote_id (uint32_t id);
257 boost::shared_ptr<Track> track_by_diskstream_id (PBD::ID);
258 void routes_using_input_from (const std::string& str, RouteList& rl);
260 bool route_name_unique (std::string) const;
261 bool route_name_internal (std::string) const;
263 bool get_record_enabled() const {
264 return (record_status () >= Enabled);
267 RecordState record_status() const {
268 return (RecordState) g_atomic_int_get (&_record_status);
271 bool actively_recording () const {
272 return record_status() == Recording;
275 bool record_enabling_legal () const;
276 void maybe_enable_record ();
277 void disable_record (bool rt_context, bool force = false);
278 void step_back_from_record ();
280 void maybe_write_autosave ();
282 /* Emitted when all i/o connections are complete */
284 PBD::Signal0<void> IOConnectionsComplete;
286 /* Record status signals */
288 PBD::Signal0<void> RecordStateChanged;
290 /* Transport mechanism signals */
292 /** Emitted on the following changes in transport state:
293 * - stop (from the butler thread)
294 * - change in whether or not we are looping (from the process thread)
295 * - change in the play range (from the process thread)
296 * - start (from the process thread)
299 PBD::Signal0<void> TransportStateChange;
301 PBD::Signal1<void,framepos_t> PositionChanged; /* sent after any non-sequential motion */
302 PBD::Signal1<void,framepos_t> Xrun;
303 PBD::Signal0<void> TransportLooped;
305 /** emitted when a locate has occurred */
306 PBD::Signal0<void> Located;
308 PBD::Signal1<void,RouteList&> RouteAdded;
309 /** Emitted when a property of one of our route groups changes.
310 * The parameter is the RouteGroup that has changed.
312 PBD::Signal1<void, RouteGroup *> RouteGroupPropertyChanged;
313 /** Emitted when a route is added to one of our route groups.
314 * First parameter is the RouteGroup, second is the route.
316 PBD::Signal2<void, RouteGroup *, boost::weak_ptr<Route> > RouteAddedToRouteGroup;
317 /** Emitted when a route is removed from one of our route groups.
318 * First parameter is the RouteGroup, second is the route.
320 PBD::Signal2<void, RouteGroup *, boost::weak_ptr<Route> > RouteRemovedFromRouteGroup;
322 /* Step Editing status changed */
323 PBD::Signal1<void,bool> StepEditStatusChange;
325 void queue_event (SessionEvent*);
327 void request_roll_at_and_return (framepos_t start, framepos_t return_to);
328 void request_bounded_roll (framepos_t start, framepos_t end);
329 void request_stop (bool abort = false, bool clear_state = false);
330 void request_locate (framepos_t frame, bool with_roll = false);
332 void request_play_loop (bool yn, bool leave_rolling = false);
333 bool get_play_loop () const { return play_loop; }
335 framepos_t last_transport_start () const { return _last_roll_location; }
338 void use_rf_shuttle_speed ();
339 void allow_auto_play (bool yn);
340 void request_transport_speed (double speed, bool as_default = false);
341 void request_transport_speed_nonzero (double, bool as_default = false);
342 void request_overwrite_buffer (Track *);
343 void adjust_playback_buffering();
344 void adjust_capture_buffering();
345 void request_track_speed (Track *, double speed);
346 void request_input_change_handling ();
348 bool locate_pending() const { return static_cast<bool>(post_transport_work()&PostTransportLocate); }
349 bool transport_locked () const;
353 framepos_t current_end_frame () const;
354 framepos_t current_start_frame () const;
355 /** "actual" sample rate of session, set by current audioengine rate, pullup/down etc. */
356 framecnt_t frame_rate () const { return _current_frame_rate; }
357 /** "native" sample rate of session, regardless of current audioengine rate, pullup/down etc */
358 framecnt_t nominal_frame_rate () const { return _nominal_frame_rate; }
359 framecnt_t frames_per_hour () const { return _frames_per_hour; }
361 double frames_per_timecode_frame() const { return _frames_per_timecode_frame; }
362 framecnt_t timecode_frames_per_hour() const { return _timecode_frames_per_hour; }
364 MIDI::byte get_mtc_timecode_bits() const {
365 return mtc_timecode_bits; /* encoding of SMTPE type for MTC */
368 double timecode_frames_per_second() const;
369 bool timecode_drop_frames() const;
373 Locations *locations() { return _locations; }
375 PBD::Signal1<void,Location*> auto_loop_location_changed;
376 PBD::Signal1<void,Location*> auto_punch_location_changed;
377 PBD::Signal0<void> locations_modified;
379 void set_auto_punch_location (Location *);
380 void set_auto_loop_location (Location *);
381 int location_name(std::string& result, std::string base = std::string(""));
383 pframes_t get_block_size() const { return current_block_size; }
384 framecnt_t worst_output_latency () const { return _worst_output_latency; }
385 framecnt_t worst_input_latency () const { return _worst_input_latency; }
386 framecnt_t worst_track_latency () const { return _worst_track_latency; }
387 framecnt_t worst_playback_latency () const { return _worst_output_latency + _worst_track_latency; }
389 int save_state (std::string snapshot_name, bool pending = false, bool switch_to_snapshot = false);
390 int restore_state (std::string snapshot_name);
391 int save_template (std::string template_name);
392 int save_history (std::string snapshot_name = "");
393 int restore_history (std::string snapshot_name);
394 void remove_state (std::string snapshot_name);
395 void rename_state (std::string old_name, std::string new_name);
396 void remove_pending_capture_state ();
397 int rename (const std::string&);
398 bool get_nsm_state () const { return _under_nsm_control; }
399 void set_nsm_state (bool state) { _under_nsm_control = state; }
401 PBD::Signal1<void,std::string> StateSaved;
402 PBD::Signal0<void> StateReady;
403 PBD::Signal0<void> SaveSession;
405 std::vector<std::string*>* possible_states() const;
406 static std::vector<std::string*>* possible_states (std::string path);
408 XMLNode& get_state();
409 int set_state(const XMLNode& node, int version); // not idempotent
410 XMLNode& get_template();
412 /// The instant xml file is written to the session directory
413 void add_instant_xml (XMLNode&, bool write_to_config = true);
414 XMLNode* instant_xml (const std::string& str);
416 enum StateOfTheState {
421 InitialConnecting = 0x8,
426 StateOfTheState state_of_the_state() const { return _state_of_the_state; }
428 void add_route_group (RouteGroup *);
429 void remove_route_group (RouteGroup&);
430 void reorder_route_groups (std::list<RouteGroup*>);
432 RouteGroup* route_group_by_name (std::string);
433 RouteGroup& all_route_group() const;
435 PBD::Signal1<void,RouteGroup*> route_group_added;
436 PBD::Signal0<void> route_group_removed;
437 PBD::Signal0<void> route_groups_reordered;
439 void foreach_route_group (boost::function<void(RouteGroup*)> f) {
440 for (std::list<RouteGroup *>::iterator i = _route_groups.begin(); i != _route_groups.end(); ++i) {
445 std::list<RouteGroup*> const & route_groups () const {
446 return _route_groups;
449 /* fundamental operations. duh. */
451 std::list<boost::shared_ptr<AudioTrack> > new_audio_track (
454 TrackMode mode = Normal,
455 RouteGroup* route_group = 0,
456 uint32_t how_many = 1,
457 std::string name_template = ""
460 RouteList new_audio_route (
461 int input_channels, int output_channels, RouteGroup* route_group, uint32_t how_many, std::string name_template = ""
464 std::list<boost::shared_ptr<MidiTrack> > new_midi_track (
465 const ChanCount& input, const ChanCount& output,
466 boost::shared_ptr<PluginInfo> instrument = boost::shared_ptr<PluginInfo>(),
467 TrackMode mode = Normal,
468 RouteGroup* route_group = 0, uint32_t how_many = 1, std::string name_template = ""
471 void remove_route (boost::shared_ptr<Route>);
472 void resort_routes ();
473 void resort_routes_using (boost::shared_ptr<RouteList>);
475 AudioEngine & engine() { return _engine; }
476 AudioEngine const & engine () const { return _engine; }
480 framepos_t transport_frame () const {return _transport_frame; }
481 framepos_t audible_frame () const;
482 framepos_t requested_return_frame() const { return _requested_return_frame; }
496 void sync_time_vars();
498 void bbt_time (framepos_t when, Timecode::BBT_Time&);
499 void timecode_to_sample(Timecode::Time& timecode, framepos_t& sample, bool use_offset, bool use_subframes) const;
500 void sample_to_timecode(framepos_t sample, Timecode::Time& timecode, bool use_offset, bool use_subframes) const;
501 void timecode_time (Timecode::Time &);
502 void timecode_time (framepos_t when, Timecode::Time&);
503 void timecode_time_subframes (framepos_t when, Timecode::Time&);
505 void timecode_duration (framecnt_t, Timecode::Time&) const;
506 void timecode_duration_string (char *, size_t len, framecnt_t) const;
508 framecnt_t convert_to_frames (AnyTime const & position);
509 framecnt_t any_duration_to_frames (framepos_t position, AnyTime const & duration);
511 static PBD::Signal1<void, framepos_t> StartTimeChanged;
512 static PBD::Signal1<void, framepos_t> EndTimeChanged;
514 void request_sync_source (Slave*);
515 bool synced_to_engine() const { return config.get_external_sync() && Config->get_sync_source() == Engine; }
517 double transport_speed() const { return _transport_speed; }
518 bool transport_stopped() const { return _transport_speed == 0.0f; }
519 bool transport_rolling() const { return _transport_speed != 0.0f; }
521 void set_silent (bool yn);
522 bool silent () { return _silent; }
524 TempoMap& tempo_map() { return *_tempo_map; }
528 boost::shared_ptr<Region> find_whole_file_parent (boost::shared_ptr<Region const>) const;
530 std::string path_from_region_name (DataType type, std::string name, std::string identifier);
532 boost::shared_ptr<Region> XMLRegionFactory (const XMLNode&, bool full);
533 boost::shared_ptr<AudioRegion> XMLAudioRegionFactory (const XMLNode&, bool full);
534 boost::shared_ptr<MidiRegion> XMLMidiRegionFactory (const XMLNode&, bool full);
536 /* source management */
538 void import_files (ImportStatus&);
539 bool sample_rate_convert (ImportStatus&, std::string infile, std::string& outfile);
540 std::string build_tmp_convert_name (std::string file);
542 boost::shared_ptr<ExportHandler> get_export_handler ();
543 boost::shared_ptr<ExportStatus> get_export_status ();
545 int start_audio_export (framepos_t position);
547 PBD::Signal1<int, framecnt_t> ProcessExport;
548 static PBD::Signal2<void,std::string, std::string> Exported;
550 void add_source (boost::shared_ptr<Source>);
551 void remove_source (boost::weak_ptr<Source>);
553 void cleanup_regions();
554 int cleanup_sources (CleanupReport&);
555 int cleanup_trash_sources (CleanupReport&);
557 int destroy_sources (std::list<boost::shared_ptr<Source> >);
559 int remove_last_capture ();
561 /** handlers should return 0 for "everything OK", and any other value for
562 * "cannot setup audioengine".
564 static PBD::Signal1<int,uint32_t> AudioEngineSetupRequired;
566 /** handlers should return -1 for "stop cleanup",
567 0 for "yes, delete this playlist",
568 1 for "no, don't delete this playlist".
570 static PBD::Signal1<int,boost::shared_ptr<Playlist> > AskAboutPlaylistDeletion;
572 /** handlers should return 0 for "ignore the rate mismatch",
573 !0 for "do not use this session"
575 static PBD::Signal2<int, framecnt_t, framecnt_t> AskAboutSampleRateMismatch;
577 /** handlers should return !0 for use pending state, 0 for ignore it.
579 static PBD::Signal0<int> AskAboutPendingState;
581 boost::shared_ptr<AudioFileSource> create_audio_source_for_session (
582 size_t, std::string const &, uint32_t, bool destructive);
584 boost::shared_ptr<MidiSource> create_midi_source_for_session (std::string const &);
585 boost::shared_ptr<MidiSource> create_midi_source_by_stealing_name (boost::shared_ptr<Track>);
587 boost::shared_ptr<Source> source_by_id (const PBD::ID&);
588 boost::shared_ptr<AudioFileSource> source_by_path_and_channel (const std::string&, uint16_t) const;
589 boost::shared_ptr<MidiSource> source_by_path (const std::string&) const;
590 uint32_t count_sources_by_origin (const std::string&);
592 void add_playlist (boost::shared_ptr<Playlist>, bool unused = false);
594 /* Curves and AutomationLists (TODO when they go away) */
595 void add_automation_list(AutomationList*);
599 boost::shared_ptr<Auditioner> the_auditioner() { return auditioner; }
600 void audition_playlist ();
601 void audition_region (boost::shared_ptr<Region>);
602 void cancel_audition ();
603 bool is_auditioning () const;
605 PBD::Signal1<void,bool> AuditionActive;
607 /* flattening stuff */
609 boost::shared_ptr<Region> write_one_track (AudioTrack&, framepos_t start, framepos_t end,
610 bool overwrite, std::vector<boost::shared_ptr<Source> >&, InterThreadInfo& wot,
611 boost::shared_ptr<Processor> endpoint, bool include_endpoint, bool for_export);
612 int freeze_all (InterThreadInfo&);
614 /* session-wide solo/mute/rec-enable */
616 bool soloing() const { return _non_soloed_outs_muted; }
617 bool listening() const { return _listen_cnt > 0; }
618 bool solo_isolated() const { return _solo_isolated_cnt > 0; }
620 static const SessionEvent::RTeventCallback rt_cleanup;
622 void set_solo (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
623 void set_just_one_solo (boost::shared_ptr<Route>, bool, SessionEvent::RTeventCallback after = rt_cleanup);
624 void cancel_solo_after_disconnect (boost::shared_ptr<Route>, bool upstream, SessionEvent::RTeventCallback after = rt_cleanup);
625 void set_mute (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
626 void set_listen (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
627 void set_record_enabled (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
628 void set_solo_isolated (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
629 void set_monitoring (boost::shared_ptr<RouteList>, MonitorChoice, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
630 void set_exclusive_input_active (boost::shared_ptr<RouteList> rt, bool onoff, bool flip_others=false);
632 PBD::Signal1<void,bool> SoloActive;
633 PBD::Signal0<void> SoloChanged;
634 PBD::Signal0<void> IsolatedChanged;
636 /* monitor/master out */
638 void add_monitor_section ();
639 void remove_monitor_section ();
641 boost::shared_ptr<Route> monitor_out() const { return _monitor_out; }
642 boost::shared_ptr<Route> master_out() const { return _master_out; }
644 void globally_add_internal_sends (boost::shared_ptr<Route> dest, Placement p, bool);
645 void globally_set_send_gains_from_track (boost::shared_ptr<Route> dest);
646 void globally_set_send_gains_to_zero (boost::shared_ptr<Route> dest);
647 void globally_set_send_gains_to_unity (boost::shared_ptr<Route> dest);
648 void add_internal_sends (boost::shared_ptr<Route> dest, Placement p, boost::shared_ptr<RouteList> senders);
649 void add_internal_send (boost::shared_ptr<Route>, int, boost::shared_ptr<Route>);
650 void add_internal_send (boost::shared_ptr<Route>, boost::shared_ptr<Processor>, boost::shared_ptr<Route>);
652 static void set_disable_all_loaded_plugins (bool yn) {
653 _disable_all_loaded_plugins = yn;
655 static bool get_disable_all_loaded_plugins() {
656 return _disable_all_loaded_plugins;
659 uint32_t next_send_id();
660 uint32_t next_aux_send_id();
661 uint32_t next_return_id();
662 uint32_t next_insert_id();
663 void mark_send_id (uint32_t);
664 void mark_aux_send_id (uint32_t);
665 void mark_return_id (uint32_t);
666 void mark_insert_id (uint32_t);
667 void unmark_send_id (uint32_t);
668 void unmark_aux_send_id (uint32_t);
669 void unmark_return_id (uint32_t);
670 void unmark_insert_id (uint32_t);
672 /* s/w "RAID" management */
674 boost::optional<framecnt_t> available_capture_duration();
678 void add_bundle (boost::shared_ptr<Bundle>);
679 void remove_bundle (boost::shared_ptr<Bundle>);
680 boost::shared_ptr<Bundle> bundle_by_name (std::string) const;
682 PBD::Signal1<void,boost::shared_ptr<Bundle> > BundleAdded;
683 PBD::Signal1<void,boost::shared_ptr<Bundle> > BundleRemoved;
687 /* History (for editors, mixers, UIs etc.) */
689 /** Undo some transactions.
690 * @param n Number of transactions to undo.
692 void undo (uint32_t n) {
696 void redo (uint32_t n) {
700 UndoHistory& history() { return _history; }
702 uint32_t undo_depth() const { return _history.undo_depth(); }
703 uint32_t redo_depth() const { return _history.redo_depth(); }
704 std::string next_undo() const { return _history.next_undo(); }
705 std::string next_redo() const { return _history.next_redo(); }
707 void begin_reversible_command (const std::string& cmd_name);
708 void begin_reversible_command (GQuark);
709 void commit_reversible_command (Command* cmd = 0);
711 void add_command (Command *const cmd) {
712 assert (_current_trans);
713 _current_trans->add_command (cmd);
716 /** @return The list of operations that are currently in progress */
717 std::list<GQuark> const & current_operations () {
718 return _current_trans_quarks;
721 bool operation_in_progress (GQuark) const;
723 void add_commands (std::vector<Command*> const & cmds);
725 std::map<PBD::ID,PBD::StatefulDestructible*> registry;
727 // these commands are implemented in libs/ardour/session_command.cc
728 Command* memento_command_factory(XMLNode* n);
729 Command* stateful_diff_command_factory (XMLNode *);
730 void register_with_memento_command_factory(PBD::ID, PBD::StatefulDestructible*);
734 boost::shared_ptr<IO> click_io() { return _click_io; }
735 boost::shared_ptr<Amp> click_gain() { return _click_gain; }
737 /* disk, buffer loads */
739 uint32_t playback_load ();
740 uint32_t capture_load ();
744 void request_play_range (std::list<AudioRange>*, bool leave_rolling = false);
745 bool get_play_range () const { return _play_range; }
747 void maybe_update_session_range (framepos_t, framepos_t);
749 /* buffers for gain and pan */
751 gain_t* gain_automation_buffer () const;
752 gain_t* send_gain_automation_buffer () const;
753 pan_t** pan_automation_buffer () const;
755 void ensure_buffer_set (BufferSet& buffers, const ChanCount& howmany);
759 static int vst_current_loading_id;
760 static const char* vst_can_do_strings[];
761 static const int vst_can_do_string_count;
763 static intptr_t vst_callback (
772 static PBD::Signal0<void> SendFeedback;
776 boost::shared_ptr<Speakers> get_speakers ();
780 boost::shared_ptr<PBD::Controllable> controllable_by_id (const PBD::ID&);
781 boost::shared_ptr<PBD::Controllable> controllable_by_descriptor (const PBD::ControllableDescriptor&);
783 void add_controllable (boost::shared_ptr<PBD::Controllable>);
784 void remove_controllable (PBD::Controllable*);
786 boost::shared_ptr<PBD::Controllable> solo_cut_control() const;
788 SessionConfiguration config;
790 bool exporting () const {
794 /* this is a private enum, but setup_enum_writer() needs it,
795 and i can't find a way to give that function
799 enum PostTransportWork {
800 PostTransportStop = 0x1,
801 PostTransportDuration = 0x2,
802 PostTransportLocate = 0x4,
803 PostTransportRoll = 0x8,
804 PostTransportAbort = 0x10,
805 PostTransportOverWrite = 0x20,
806 PostTransportSpeed = 0x40,
807 PostTransportAudition = 0x80,
808 PostTransportReverse = 0x100,
809 PostTransportInputChange = 0x200,
810 PostTransportCurveRealloc = 0x400,
811 PostTransportClearSubstate = 0x800,
812 PostTransportAdjustPlaybackBuffering = 0x1000,
813 PostTransportAdjustCaptureBuffering = 0x2000
822 SlaveState slave_state() const { return _slave_state; }
823 Slave* slave() const { return _slave; }
825 boost::shared_ptr<SessionPlaylists> playlists;
827 void send_mmc_locate (framepos_t);
828 void queue_full_time_code () { _send_timecode_update = true; }
829 void queue_song_position_pointer () { /* currently does nothing */ }
831 bool step_editing() const { return (_step_editors > 0); }
833 void request_suspend_timecode_transmission ();
834 void request_resume_timecode_transmission ();
835 bool timecode_transmission_suspended () const;
837 std::vector<std::string> source_search_path(DataType) const;
838 void ensure_search_path_includes (const std::string& path, DataType type);
840 std::list<std::string> unknown_processors () const;
842 /** Emitted when a feedback cycle has been detected within Ardour's signal
843 processing path. Until it is fixed (by the user) some (unspecified)
844 routes will not be run.
846 static PBD::Signal0<void> FeedbackDetected;
848 /** Emitted when a graph sort has successfully completed, which means
849 that it has no feedback cycles.
851 static PBD::Signal0<void> SuccessfulGraphSort;
853 /* handlers can return an integer value:
854 0: config.set_audio_search_path() or config.set_midi_search_path() was used
855 to modify the search path and we should try to find it again.
856 1: quit entire session load
857 2: as 0, but don't ask about other missing files
858 3: don't ask about other missing files, and just mark this one missing
859 -1: just mark this one missing
860 any other value: as -1
862 static PBD::Signal3<int,Session*,std::string,DataType> MissingFile;
864 /** Emitted when the session wants Ardour to quit */
865 static PBD::Signal0<void> Quit;
867 /** Emitted when Ardour is asked to load a session in an older session
868 * format, and makes a backup copy.
870 static PBD::Signal2<void,std::string,std::string> VersionMismatch;
872 SceneChanger* scene_changer() const { return _scene_changer; }
874 boost::shared_ptr<Port> ltc_input_port() const;
875 boost::shared_ptr<Port> ltc_output_port() const;
877 boost::shared_ptr<IO> ltc_input_io() { return _ltc_input; }
878 boost::shared_ptr<IO> ltc_output_io() { return _ltc_output; }
880 MIDI::Port* midi_input_port () const;
881 MIDI::Port* midi_output_port () const;
882 MIDI::Port* mmc_output_port () const;
883 MIDI::Port* mmc_input_port () const;
885 MIDI::Port* scene_input_port () const;
886 MIDI::Port* scene_output_port () const;
888 boost::shared_ptr<MidiPort> scene_in () const;
889 boost::shared_ptr<MidiPort> scene_out () const;
891 boost::shared_ptr<MidiPort> midi_clock_output_port () const;
892 boost::shared_ptr<MidiPort> midi_clock_input_port () const;
893 boost::shared_ptr<MidiPort> mtc_output_port () const;
894 boost::shared_ptr<MidiPort> mtc_input_port () const;
896 MIDI::MachineControl& mmc() { return *_mmc; }
899 friend class AudioEngine;
900 void set_block_size (pframes_t nframes);
901 void set_frame_rate (framecnt_t nframes);
905 void schedule_curve_reallocation ();
906 void update_latency_compensation (bool force = false);
909 int create (const std::string& mix_template, BusProfile*);
913 PendingDeclickIn = 0x1, ///< pending de-click fade-in for start
914 PendingDeclickOut = 0x2, ///< pending de-click fade-out for stop
915 StopPendingCapture = 0x4,
916 PendingLoopDeclickIn = 0x8, ///< pending de-click fade-in at the start of a loop
917 PendingLoopDeclickOut = 0x10, ///< pending de-click fade-out at the end of a loop
918 PendingLocate = 0x20,
921 /* stuff used in process() should be close together to
925 typedef void (Session::*process_function_type)(pframes_t);
927 AudioEngine& _engine;
928 mutable gint processing_prohibited;
929 process_function_type process_function;
930 process_function_type last_process_function;
931 bool waiting_for_sync_offset;
932 framecnt_t _base_frame_rate;
933 framecnt_t _current_frame_rate; //this includes video pullup offset
934 framecnt_t _nominal_frame_rate; //ignores audioengine setting, "native" SR
935 int transport_sub_state;
936 mutable gint _record_status;
937 framepos_t _transport_frame;
938 Location* _session_range_location; ///< session range, or 0 if there is nothing in the session yet
942 // varispeed playback
943 double _transport_speed;
944 double _default_transport_speed;
945 double _last_transport_speed;
946 double _target_transport_speed;
947 CubicInterpolation interpolation;
949 bool auto_play_legal;
950 framepos_t _last_slave_transport_frame;
951 framecnt_t maximum_output_latency;
952 framepos_t _requested_return_frame;
953 pframes_t current_block_size;
954 framecnt_t _worst_output_latency;
955 framecnt_t _worst_input_latency;
956 framecnt_t _worst_track_latency;
959 float _meter_falloff;
960 bool _non_soloed_outs_muted;
961 uint32_t _listen_cnt;
962 uint32_t _solo_isolated_cnt;
965 bool _under_nsm_control;
967 void initialize_latencies ();
968 void set_worst_io_latencies ();
969 void set_worst_playback_latency ();
970 void set_worst_capture_latency ();
971 void set_worst_io_latencies_x (IOChange, void *) {
972 set_worst_io_latencies ();
974 void post_capture_latency ();
975 void post_playback_latency ();
977 void update_latency_compensation_proxy (void* ignored);
979 void ensure_buffers (ChanCount howmany = ChanCount::ZERO);
981 void process_scrub (pframes_t);
982 void process_without_events (pframes_t);
983 void process_with_events (pframes_t);
984 void process_audition (pframes_t);
985 int process_export (pframes_t);
986 int process_export_fw (pframes_t);
988 void block_processing() { g_atomic_int_set (&processing_prohibited, 1); }
989 void unblock_processing() { g_atomic_int_set (&processing_prohibited, 0); }
990 bool processing_blocked() const { return g_atomic_int_get (&processing_prohibited); }
994 static const int delta_accumulator_size = 25;
995 int delta_accumulator_cnt;
996 int32_t delta_accumulator[delta_accumulator_size];
997 int32_t average_slave_delta;
999 bool have_first_delta_accumulator;
1001 SlaveState _slave_state;
1002 framepos_t slave_wait_end;
1004 void reset_slave_state ();
1005 bool follow_slave (pframes_t);
1006 void calculate_moving_average_of_slave_delta (int dir, framecnt_t this_delta);
1007 void track_slave_state (float slave_speed, framepos_t slave_transport_frame, framecnt_t this_delta);
1008 void follow_slave_silently (pframes_t nframes, float slave_speed);
1010 void switch_to_sync_source (SyncSource); /* !RT context */
1011 void drop_sync_source (); /* !RT context */
1012 void use_sync_source (Slave*); /* RT context */
1014 bool post_export_sync;
1015 framepos_t post_export_position;
1018 bool _export_started;
1019 bool _export_rolling;
1021 boost::shared_ptr<ExportHandler> export_handler;
1022 boost::shared_ptr<ExportStatus> export_status;
1025 int stop_audio_export ();
1026 void finalize_audio_export ();
1027 void finalize_export_internal (bool stop_freewheel);
1028 bool _pre_export_mmc_enabled;
1030 PBD::ScopedConnection export_freewheel_connection;
1032 void get_track_statistics ();
1033 int process_routes (pframes_t, bool& need_butler);
1034 int silent_process_routes (pframes_t, bool& need_butler);
1036 /** @return 1 if there is a pending declick fade-in,
1037 -1 if there is a pending declick fade-out,
1038 0 if there is no pending declick.
1040 int get_transport_declick_required () {
1041 if (transport_sub_state & PendingDeclickIn) {
1042 transport_sub_state &= ~PendingDeclickIn;
1044 } else if (transport_sub_state & PendingDeclickOut) {
1045 /* XXX: not entirely sure why we don't clear this */
1047 } else if (transport_sub_state & PendingLoopDeclickOut) {
1048 /* Return the declick out first ... */
1049 transport_sub_state &= ~PendingLoopDeclickOut;
1051 } else if (transport_sub_state & PendingLoopDeclickIn) {
1052 /* ... then the declick in on the next call */
1053 transport_sub_state &= ~PendingLoopDeclickIn;
1060 bool maybe_stop (framepos_t limit);
1061 bool maybe_sync_start (pframes_t &);
1063 void check_declick_out ();
1069 /** Number of process frames since the last MTC output (when sending MTC); used to
1070 * know when to send full MTC messages every so often.
1072 pframes_t _pframes_since_last_mtc;
1073 bool session_midi_feedback;
1076 framepos_t last_loopend;
1078 boost::scoped_ptr<SessionDirectory> _session_dir;
1081 void graph_reordered ();
1083 /** current snapshot name, without the .ardour suffix */
1084 std::string _current_snapshot_name;
1086 XMLTree* state_tree;
1087 bool state_was_pending;
1088 StateOfTheState _state_of_the_state;
1091 int load_options (const XMLNode&);
1092 int load_state (std::string snapshot_name);
1094 framepos_t _last_roll_location;
1095 /** the session frame time at which we last rolled, located, or changed transport direction */
1096 framepos_t _last_roll_or_reversal_location;
1097 framepos_t _last_record_location;
1099 bool pending_locate_roll;
1100 framepos_t pending_locate_frame;
1101 bool pending_locate_flush;
1103 bool pending_auto_loop;
1107 static const PostTransportWork ProcessCannotProceedMask =
1109 PostTransportInputChange|
1111 PostTransportReverse|
1112 PostTransportCurveRealloc|
1113 PostTransportAudition|
1114 PostTransportLocate|
1116 PostTransportClearSubstate);
1118 gint _post_transport_work; /* accessed only atomic ops */
1119 PostTransportWork post_transport_work() const { return (PostTransportWork) g_atomic_int_get (const_cast<gint*>(&_post_transport_work)); }
1120 void set_post_transport_work (PostTransportWork ptw) { g_atomic_int_set (&_post_transport_work, (gint) ptw); }
1121 void add_post_transport_work (PostTransportWork ptw);
1123 void schedule_playback_buffering_adjustment ();
1124 void schedule_capture_buffering_adjustment ();
1126 uint32_t cumulative_rf_motion;
1129 void set_rf_speed (float speed);
1130 void reset_rf_scale (framecnt_t frames_moved);
1132 Locations* _locations;
1133 void locations_changed ();
1134 void locations_added (Location*);
1135 void handle_locations_changed (Locations::LocationList&);
1137 PBD::ScopedConnectionList punch_connections;
1138 void auto_punch_start_changed (Location *);
1139 void auto_punch_end_changed (Location *);
1140 void auto_punch_changed (Location *);
1142 PBD::ScopedConnectionList loop_connections;
1143 void auto_loop_changed (Location *);
1144 void auto_loop_declick_range (Location *, framepos_t &, framepos_t &);
1146 int ensure_engine (uint32_t desired_sample_rate);
1147 void pre_engine_init (std::string path);
1148 int post_engine_init ();
1149 int immediately_post_engine ();
1150 void remove_empty_sounds ();
1152 void setup_midi_control ();
1153 int midi_read (MIDI::Port *);
1155 void enable_record ();
1157 void increment_transport_position (framecnt_t val) {
1158 if (max_framepos - val < _transport_frame) {
1159 _transport_frame = max_framepos;
1161 _transport_frame += val;
1165 void decrement_transport_position (framecnt_t val) {
1166 if (val < _transport_frame) {
1167 _transport_frame -= val;
1169 _transport_frame = 0;
1173 void post_transport_motion ();
1174 static void *session_loader_thread (void *arg);
1178 /* SessionEventManager interface */
1180 void process_event (SessionEvent*);
1181 void set_next_event ();
1182 void cleanup_event (SessionEvent*,int);
1184 /* MIDI Machine Control */
1187 void spp_continue ();
1190 void mmc_deferred_play (MIDI::MachineControl &);
1191 void mmc_stop (MIDI::MachineControl &);
1192 void mmc_step (MIDI::MachineControl &, int);
1193 void mmc_pause (MIDI::MachineControl &);
1194 void mmc_record_pause (MIDI::MachineControl &);
1195 void mmc_record_strobe (MIDI::MachineControl &);
1196 void mmc_record_exit (MIDI::MachineControl &);
1197 void mmc_track_record_status (MIDI::MachineControl &, uint32_t track, bool enabled);
1198 void mmc_fast_forward (MIDI::MachineControl &);
1199 void mmc_rewind (MIDI::MachineControl &);
1200 void mmc_locate (MIDI::MachineControl &, const MIDI::byte *);
1201 void mmc_shuttle (MIDI::MachineControl &mmc, float speed, bool forw);
1202 void mmc_record_enable (MIDI::MachineControl &mmc, size_t track, bool enabled);
1204 struct timeval last_mmc_step;
1207 typedef boost::function<bool()> MidiTimeoutCallback;
1208 typedef std::list<MidiTimeoutCallback> MidiTimeoutList;
1210 MidiTimeoutList midi_timeouts;
1211 bool mmc_step_timeout ();
1213 MIDI::byte mtc_msg[16];
1214 MIDI::byte mtc_timecode_bits; /* encoding of SMTPE type for MTC */
1215 MIDI::byte midi_msg[16];
1216 double outbound_mtc_timecode_frame;
1217 Timecode::Time transmitting_timecode_time;
1218 int next_quarter_frame_to_send;
1220 double _frames_per_timecode_frame; /* has to be floating point because of drop frame */
1221 framecnt_t _frames_per_hour;
1222 framecnt_t _timecode_frames_per_hour;
1224 /* cache the most-recently requested time conversions. This helps when we
1225 * have multiple clocks showing the same time (e.g. the transport frame) */
1226 bool last_timecode_valid;
1227 framepos_t last_timecode_when;
1228 Timecode::Time last_timecode;
1230 bool _send_timecode_update; ///< Flag to send a full frame (Timecode) MTC message this cycle
1232 int send_midi_time_code_for_cycle (framepos_t, framepos_t, pframes_t nframes);
1234 LTCEncoder* ltc_encoder;
1235 ltcsnd_sample_t* ltc_enc_buf;
1237 Timecode::TimecodeFormat ltc_enc_tcformat;
1238 int32_t ltc_buf_off;
1239 int32_t ltc_buf_len;
1242 int32_t ltc_enc_byte;
1243 framepos_t ltc_enc_pos;
1245 framepos_t ltc_enc_off;
1247 framepos_t ltc_prev_cycle;
1249 framepos_t ltc_timecode_offset;
1250 bool ltc_timecode_negative_offset;
1252 LatencyRange ltc_out_latency;
1254 void ltc_tx_initialize();
1255 void ltc_tx_cleanup();
1256 void ltc_tx_reset();
1257 void ltc_tx_resync_latency();
1258 void ltc_tx_recalculate_position();
1259 void ltc_tx_parse_offset();
1260 void ltc_tx_send_time_code_for_cycle (framepos_t, framepos_t, double, double, pframes_t nframes);
1262 void reset_record_status ();
1264 int no_roll (pframes_t nframes);
1265 int fail_roll (pframes_t nframes);
1267 bool non_realtime_work_pending() const { return static_cast<bool>(post_transport_work()); }
1268 bool process_can_proceed() const { return !(post_transport_work() & ProcessCannotProceedMask); }
1270 MidiControlUI* midi_control_ui;
1272 int start_midi_thread ();
1274 void set_play_loop (bool yn, double speed);
1275 void unset_play_loop ();
1276 void overwrite_some_buffers (Track *);
1277 void flush_all_inserts ();
1278 int micro_locate (framecnt_t distance);
1279 void locate (framepos_t, bool with_roll, bool with_flush, bool with_loop=false, bool force=false, bool with_mmc=true);
1280 void start_locate (framepos_t, bool with_roll, bool with_flush, bool with_loop=false, bool force=false);
1281 void force_locate (framepos_t frame, bool with_roll = false);
1282 void set_track_speed (Track *, double speed);
1283 void set_transport_speed (double speed, bool abort = false, bool clear_state = false, bool as_default = false);
1284 void stop_transport (bool abort = false, bool clear_state = false);
1285 void start_transport ();
1286 void realtime_stop (bool abort, bool clear_state);
1287 void realtime_locate ();
1288 void non_realtime_start_scrub ();
1289 void non_realtime_set_speed ();
1290 void non_realtime_locate ();
1291 void non_realtime_stop (bool abort, int entry_request_count, bool& finished);
1292 void non_realtime_overwrite (int entry_request_count, bool& finished);
1293 void post_transport ();
1294 void engine_halted ();
1295 void xrun_recovery ();
1297 /* These are synchronous and so can only be called from within the process
1301 int send_full_time_code (framepos_t, pframes_t nframes);
1302 void send_song_position_pointer (framepos_t);
1304 TempoMap *_tempo_map;
1305 void tempo_map_changed (const PBD::PropertyChange&);
1307 /* edit/mix groups */
1309 int load_route_groups (const XMLNode&, int);
1311 std::list<RouteGroup *> _route_groups;
1312 RouteGroup* _all_route_group;
1316 boost::shared_ptr<Graph> _process_graph;
1318 SerializedRCUManager<RouteList> routes;
1320 void add_routes (RouteList&, bool input_auto_connect, bool output_auto_connect, bool save);
1321 void add_routes_inner (RouteList&, bool input_auto_connect, bool output_auto_connect);
1322 bool _adding_routes_in_progress;
1323 uint32_t destructive_index;
1325 boost::shared_ptr<Route> XMLRouteFactory (const XMLNode&, int);
1326 boost::shared_ptr<Route> XMLRouteFactory_2X (const XMLNode&, int);
1328 void route_processors_changed (RouteProcessorChange);
1330 bool find_route_name (std::string const &, uint32_t& id, char* name, size_t name_len, bool);
1331 void count_existing_track_channels (ChanCount& in, ChanCount& out);
1332 void auto_connect_route (boost::shared_ptr<Route> route, ChanCount& existing_inputs, ChanCount& existing_outputs,
1333 bool with_lock, bool connect_inputs = true,
1334 ChanCount input_start = ChanCount (), ChanCount output_start = ChanCount ());
1335 void midi_output_change_handler (IOChange change, void* /*src*/, boost::weak_ptr<Route> midi_track);
1339 bool solo_update_disabled;
1341 void route_listen_changed (void *src, boost::weak_ptr<Route>);
1342 void route_mute_changed (void *src);
1343 void route_solo_changed (bool self_solo_change, void *src, boost::weak_ptr<Route>);
1344 void route_solo_isolated_changed (void *src, boost::weak_ptr<Route>);
1345 void update_route_solo_state (boost::shared_ptr<RouteList> r = boost::shared_ptr<RouteList>());
1347 void listen_position_changed ();
1348 void solo_control_mode_changed ();
1350 /* REGION MANAGEMENT */
1352 mutable Glib::Threads::Mutex region_lock;
1354 int load_regions (const XMLNode& node);
1355 int load_compounds (const XMLNode& node);
1357 void route_added_to_route_group (RouteGroup *, boost::weak_ptr<Route>);
1358 void route_removed_from_route_group (RouteGroup *, boost::weak_ptr<Route>);
1359 void route_group_property_changed (RouteGroup *);
1363 mutable Glib::Threads::Mutex source_lock;
1366 typedef std::map<PBD::ID,boost::shared_ptr<Source> > SourceMap;
1372 int load_sources (const XMLNode& node);
1373 XMLNode& get_sources_as_xml ();
1375 boost::shared_ptr<Source> XMLSourceFactory (const XMLNode&);
1379 void remove_playlist (boost::weak_ptr<Playlist>);
1380 void track_playlist_changed (boost::weak_ptr<Track>);
1381 void playlist_region_added (boost::weak_ptr<Region>);
1382 void playlist_ranges_moved (std::list<Evoral::RangeMove<framepos_t> > const &);
1383 void playlist_regions_extended (std::list<Evoral::Range<framepos_t> > const &);
1385 /* CURVES and AUTOMATION LISTS */
1386 std::map<PBD::ID, AutomationList*> automation_lists;
1388 /* DEFAULT FADE CURVES */
1390 float default_fade_steepness;
1391 float default_fade_msecs;
1395 boost::shared_ptr<Auditioner> auditioner;
1396 void set_audition (boost::shared_ptr<Region>);
1397 void non_realtime_set_audition ();
1398 boost::shared_ptr<Region> pending_audition_region;
1404 int flatten_one_track (AudioTrack&, framepos_t start, framecnt_t cnt);
1406 /* INSERT AND SEND MANAGEMENT */
1408 boost::dynamic_bitset<uint32_t> send_bitset;
1409 boost::dynamic_bitset<uint32_t> aux_send_bitset;
1410 boost::dynamic_bitset<uint32_t> return_bitset;
1411 boost::dynamic_bitset<uint32_t> insert_bitset;
1415 struct space_and_path {
1416 uint32_t blocks; ///< 4kB blocks
1417 bool blocks_unknown; ///< true if blocks is unknown
1422 , blocks_unknown (true)
1426 struct space_and_path_ascending_cmp {
1427 bool operator() (space_and_path a, space_and_path b) {
1428 if (a.blocks_unknown != b.blocks_unknown) {
1429 return !a.blocks_unknown;
1431 return a.blocks > b.blocks;
1435 void setup_raid_path (std::string path);
1437 std::vector<space_and_path> session_dirs;
1438 std::vector<space_and_path>::iterator last_rr_session_dir;
1439 uint32_t _total_free_4k_blocks;
1440 /** If this is true, _total_free_4k_blocks is not definite,
1441 as one or more of the session directories' filesystems
1442 could not report free space.
1444 bool _total_free_4k_blocks_uncertain;
1445 Glib::Threads::Mutex space_lock;
1447 bool no_questions_about_missing_files;
1449 std::string get_best_session_directory_for_new_source ();
1451 mutable gint _playback_load;
1452 mutable gint _capture_load;
1456 SerializedRCUManager<BundleList> _bundles;
1457 XMLNode* _bundle_xml_node;
1458 int load_bundles (XMLNode const &);
1460 UndoHistory _history;
1461 /** current undo transaction, or 0 */
1462 UndoTransaction* _current_trans;
1463 /** GQuarks to describe the reversible commands that are currently in progress.
1464 * These may be nested, in which case more recently-started commands are toward
1465 * the front of the list.
1467 std::list<GQuark> _current_trans_quarks;
1469 int backend_sync_callback (TransportState, framepos_t);
1471 void process_rtop (SessionEvent*);
1473 void update_latency (bool playback);
1475 XMLNode& state(bool);
1478 typedef std::list<Click*> Clicks;
1481 boost::shared_ptr<IO> _click_io;
1482 boost::shared_ptr<Amp> _click_gain;
1484 Sample* click_emphasis_data;
1485 framecnt_t click_length;
1486 framecnt_t click_emphasis_length;
1487 mutable Glib::Threads::RWLock click_lock;
1489 static const Sample default_click[];
1490 static const framecnt_t default_click_length;
1491 static const Sample default_click_emphasis[];
1492 static const framecnt_t default_click_emphasis_length;
1495 framepos_t _clicks_cleared;
1496 void setup_click_sounds (int which);
1497 void setup_click_sounds (Sample**, Sample const *, framecnt_t*, framecnt_t, std::string const &);
1498 void clear_clicks ();
1499 void click (framepos_t start, framecnt_t nframes);
1501 std::vector<Route*> master_outs;
1503 /* range playback */
1505 std::list<AudioRange> current_audio_range;
1507 void set_play_range (std::list<AudioRange>&, bool leave_rolling);
1508 void unset_play_range ();
1513 boost::shared_ptr<Route> _master_out;
1514 boost::shared_ptr<Route> _monitor_out;
1516 void auto_connect_master_bus ();
1518 /* Windows VST support */
1520 long _windows_vst_callback (
1529 int find_all_sources (std::string path, std::set<std::string>& result);
1530 int find_all_sources_across_snapshots (std::set<std::string>& result, bool exclude_this_snapshot);
1532 typedef std::set<boost::shared_ptr<PBD::Controllable> > Controllables;
1533 Glib::Threads::Mutex controllables_lock;
1534 Controllables controllables;
1536 boost::shared_ptr<PBD::Controllable> _solo_cut_control;
1538 void reset_native_file_format();
1539 bool first_file_data_format_reset;
1540 bool first_file_header_format_reset;
1542 void config_changed (std::string, bool);
1544 XMLNode& get_control_protocol_state ();
1546 void set_history_depth (uint32_t depth);
1548 static bool _disable_all_loaded_plugins;
1550 mutable bool have_looped; ///< Used in ::audible_frame(*)
1552 void update_have_rec_enabled_track ();
1553 gint _have_rec_enabled_track;
1555 static int ask_about_playlist_deletion (boost::shared_ptr<Playlist>);
1557 /* realtime "apply to set of routes" operations */
1558 template<typename T> SessionEvent*
1559 get_rt_event (boost::shared_ptr<RouteList> rl, T targ, SessionEvent::RTeventCallback after, bool group_override,
1560 void (Session::*method) (boost::shared_ptr<RouteList>, T, bool)) {
1561 SessionEvent* ev = new SessionEvent (SessionEvent::RealTimeOperation, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
1562 ev->rt_slot = boost::bind (method, this, rl, targ, group_override);
1563 ev->rt_return = after;
1564 ev->event_loop = PBD::EventLoop::get_event_loop_for_thread ();
1569 void rt_cancel_solo_after_disconnect (boost::shared_ptr<RouteList>, bool upstream, bool /* ignored*/ );
1570 void rt_set_solo (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1571 void rt_set_just_one_solo (boost::shared_ptr<RouteList>, bool yn, bool /* ignored*/ );
1572 void rt_set_mute (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1573 void rt_set_listen (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1574 void rt_set_solo_isolated (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1575 void rt_set_record_enabled (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1576 void rt_set_monitoring (boost::shared_ptr<RouteList>, MonitorChoice, bool group_override);
1578 /** temporary list of Diskstreams used only during load of 2.X sessions */
1579 std::list<boost::shared_ptr<Diskstream> > _diskstreams_2X;
1581 void add_session_range_location (framepos_t, framepos_t);
1583 void setup_midi_machine_control ();
1585 void step_edit_status_change (bool);
1586 uint32_t _step_editors;
1588 /** true if timecode transmission by the transport is suspended, otherwise false */
1589 mutable gint _suspend_timecode_transmission;
1591 void update_locations_after_tempo_map_change (Locations::LocationList &);
1593 void start_time_changed (framepos_t);
1594 void end_time_changed (framepos_t);
1596 void set_track_monitor_input_status (bool);
1597 framepos_t compute_stop_limit () const;
1599 boost::shared_ptr<Speakers> _speakers;
1600 void load_nested_sources (const XMLNode& node);
1602 /** The directed graph of routes that is currently being used for audio processing
1603 and solo/mute computations.
1605 GraphEdges _current_route_graph;
1607 uint32_t next_control_id () const;
1608 uint32_t _order_hint;
1609 bool ignore_route_processor_changes;
1611 MidiClockTicker* midi_clock;
1613 boost::shared_ptr<IO> _ltc_input;
1614 boost::shared_ptr<IO> _ltc_output;
1616 void reconnect_ltc_input ();
1617 void reconnect_ltc_output ();
1619 /* Scene Changing */
1620 SceneChanger* _scene_changer;
1622 /* persistent, non-track related MIDI ports */
1623 MidiPortManager* _midi_ports;
1624 MIDI::MachineControl* _mmc;
1627 void setup_click ();
1628 void setup_click_state (const XMLNode*);
1629 void setup_bundles ();
1631 static int get_session_info_from_path (XMLTree& state_tree, const std::string& xmlpath);
1634 } // namespace ARDOUR
1636 #endif /* __ardour_session_h__ */