2 Copyright (C) 2000 Paul Davis
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 #ifndef __ardour_session_h__
21 #define __ardour_session_h__
23 #include "libardour-config.h"
32 #include <boost/dynamic_bitset.hpp>
33 #include <boost/scoped_ptr.hpp>
34 #include <boost/weak_ptr.hpp>
35 #include <boost/utility.hpp>
37 #include <glibmm/threads.h>
41 #include "pbd/error.h"
42 #include "pbd/event_loop.h"
44 #include "pbd/statefuldestructible.h"
45 #include "pbd/signals.h"
48 #include "evoral/types.hpp"
50 #include "midi++/types.h"
51 #include "midi++/mmc.h"
53 #include "timecode/time.h"
55 #include "ardour/ardour.h"
56 #include "ardour/chan_count.h"
57 #include "ardour/delivery.h"
58 #include "ardour/interthread_info.h"
59 #include "ardour/rc_configuration.h"
60 #include "ardour/session_configuration.h"
61 #include "ardour/session_event.h"
62 #include "ardour/location.h"
63 #include "ardour/interpolation.h"
64 #include "ardour/route_graph.h"
70 typedef struct _AEffect AEffect;
80 class ControllableDescriptor;
91 class AudioFileSource;
109 class MidiClockTicker;
111 class MidiPortManager;
130 class SessionDirectory;
131 class SessionMetadata;
132 class SessionPlaylists;
138 class WindowsVSTPlugin;
140 extern void setup_enum_writer ();
142 class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::ScopedConnectionList, public SessionEventManager
151 /* a new session might have non-empty mix_template, an existing session should always have an empty one.
152 the bus profile can be null if no master out bus is required.
155 Session (AudioEngine&,
156 const std::string& fullpath,
157 const std::string& snapshot_name,
158 BusProfile* bus_profile = 0,
159 std::string mix_template = "");
163 static int get_info_from_path (const std::string& xmlpath, float& sample_rate, SampleFormat& data_format);
165 std::string path() const { return _path; }
166 std::string name() const { return _name; }
167 std::string snap_name() const { return _current_snapshot_name; }
168 std::string raid_path () const;
169 bool path_is_within_session (const std::string&);
171 void set_snap_name ();
173 bool writable() const { return _writable; }
176 bool dirty() const { return _state_of_the_state & Dirty; }
177 void set_deletion_in_progress ();
178 void clear_deletion_in_progress ();
179 bool deletion_in_progress() const { return _state_of_the_state & Deletion; }
180 PBD::Signal0<void> DirtyChanged;
182 const SessionDirectory& session_directory () const { return *(_session_dir.get()); }
184 static PBD::Signal1<void,std::string> Dialog;
186 PBD::Signal0<void> BatchUpdateStart;
187 PBD::Signal0<void> BatchUpdateEnd;
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);
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;
217 bool have_rec_disabled_track () const;
219 bool have_captured() const { return _have_captured; }
221 void refill_all_track_buffers ();
222 Butler* butler() { return _butler; }
223 void butler_transport_work ();
225 void refresh_disk_space ();
227 int load_diskstreams_2X (XMLNode const &, int);
229 int load_routes (const XMLNode&, int);
230 boost::shared_ptr<RouteList> get_routes() const {
231 return routes.reader ();
234 boost::shared_ptr<RouteList> get_tracks() const;
235 boost::shared_ptr<RouteList> get_routes_with_internal_returns() const;
236 boost::shared_ptr<RouteList> get_routes_with_regions_at (framepos_t const) const;
238 uint32_t nroutes() const { return routes.reader()->size(); }
239 uint32_t ntracks () const;
240 uint32_t nbusses () const;
242 boost::shared_ptr<BundleList> bundles () {
243 return _bundles.reader ();
246 struct LIBARDOUR_API RoutePublicOrderSorter {
247 bool operator() (boost::shared_ptr<Route>, boost::shared_ptr<Route> b);
250 void set_order_hint (int32_t order_hint) {_order_hint = order_hint;};
251 void notify_remote_id_change ();
252 void sync_order_keys ();
254 template<class T> void foreach_route (T *obj, void (T::*func)(Route&), bool sort = true);
255 template<class T> void foreach_route (T *obj, void (T::*func)(boost::shared_ptr<Route>), bool sort = true);
256 template<class T, class A> void foreach_route (T *obj, void (T::*func)(Route&, A), A arg, bool sort = true);
258 static char session_name_is_legal (const std::string&);
259 bool io_name_is_legal (const std::string&);
260 boost::shared_ptr<Route> route_by_name (std::string);
261 boost::shared_ptr<Route> route_by_id (PBD::ID);
262 boost::shared_ptr<Route> route_by_remote_id (uint32_t id);
263 boost::shared_ptr<Track> track_by_diskstream_id (PBD::ID);
264 void routes_using_input_from (const std::string& str, RouteList& rl);
266 bool route_name_unique (std::string) const;
267 bool route_name_internal (std::string) const;
269 uint32_t track_number_decimals () const {
270 return _track_number_decimals;
273 bool get_record_enabled() const {
274 return (record_status () >= Enabled);
277 RecordState record_status() const {
278 return (RecordState) g_atomic_int_get (&_record_status);
281 bool actively_recording () const {
282 return record_status() == Recording;
285 bool record_enabling_legal () const;
286 void maybe_enable_record ();
287 void disable_record (bool rt_context, bool force = false);
288 void step_back_from_record ();
290 void maybe_write_autosave ();
292 /* Emitted when all i/o connections are complete */
294 PBD::Signal0<void> IOConnectionsComplete;
296 /* Record status signals */
298 PBD::Signal0<void> RecordStateChanged;
300 /* Transport mechanism signals */
302 /** Emitted on the following changes in transport state:
303 * - stop (from the butler thread)
304 * - change in whether or not we are looping (from the process thread)
305 * - change in the play range (from the process thread)
306 * - start (from the process thread)
309 PBD::Signal0<void> TransportStateChange;
311 PBD::Signal1<void,framepos_t> PositionChanged; /* sent after any non-sequential motion */
312 PBD::Signal1<void,framepos_t> Xrun;
313 PBD::Signal0<void> TransportLooped;
315 /** emitted when a locate has occurred */
316 PBD::Signal0<void> Located;
318 PBD::Signal1<void,RouteList&> RouteAdded;
319 /** Emitted when a property of one of our route groups changes.
320 * The parameter is the RouteGroup that has changed.
322 PBD::Signal1<void, RouteGroup *> RouteGroupPropertyChanged;
323 /** Emitted when a route is added to one of our route groups.
324 * First parameter is the RouteGroup, second is the route.
326 PBD::Signal2<void, RouteGroup *, boost::weak_ptr<Route> > RouteAddedToRouteGroup;
327 /** Emitted when a route is removed from one of our route groups.
328 * First parameter is the RouteGroup, second is the route.
330 PBD::Signal2<void, RouteGroup *, boost::weak_ptr<Route> > RouteRemovedFromRouteGroup;
332 /* Step Editing status changed */
333 PBD::Signal1<void,bool> StepEditStatusChange;
335 void queue_event (SessionEvent*);
337 void request_roll_at_and_return (framepos_t start, framepos_t return_to);
338 void request_bounded_roll (framepos_t start, framepos_t end);
339 void request_stop (bool abort = false, bool clear_state = false);
340 void request_locate (framepos_t frame, bool with_roll = false);
342 void request_play_loop (bool yn, bool leave_rolling = false);
343 bool get_play_loop () const { return play_loop; }
345 framepos_t last_transport_start () const { return _last_roll_location; }
348 void use_rf_shuttle_speed ();
349 void allow_auto_play (bool yn);
350 void request_transport_speed (double speed, bool as_default = false);
351 void request_transport_speed_nonzero (double, bool as_default = false);
352 void request_overwrite_buffer (Track *);
353 void adjust_playback_buffering();
354 void adjust_capture_buffering();
355 void request_track_speed (Track *, double speed);
356 void request_input_change_handling ();
358 bool locate_pending() const { return static_cast<bool>(post_transport_work()&PostTransportLocate); }
359 bool transport_locked () const;
363 framepos_t current_end_frame () const;
364 framepos_t current_start_frame () const;
365 /** "actual" sample rate of session, set by current audioengine rate, pullup/down etc. */
366 framecnt_t frame_rate () const { return _current_frame_rate; }
367 /** "native" sample rate of session, regardless of current audioengine rate, pullup/down etc */
368 framecnt_t nominal_frame_rate () const { return _nominal_frame_rate; }
369 framecnt_t frames_per_hour () const { return _frames_per_hour; }
371 double frames_per_timecode_frame() const { return _frames_per_timecode_frame; }
372 framecnt_t timecode_frames_per_hour() const { return _timecode_frames_per_hour; }
374 MIDI::byte get_mtc_timecode_bits() const {
375 return mtc_timecode_bits; /* encoding of SMTPE type for MTC */
378 double timecode_frames_per_second() const;
379 bool timecode_drop_frames() const;
383 Locations *locations() { return _locations; }
385 PBD::Signal1<void,Location*> auto_loop_location_changed;
386 PBD::Signal1<void,Location*> auto_punch_location_changed;
387 PBD::Signal0<void> locations_modified;
389 void set_auto_punch_location (Location *);
390 void set_auto_loop_location (Location *);
391 void set_session_extents (framepos_t start, framepos_t end);
392 int location_name(std::string& result, std::string base = std::string(""));
394 pframes_t get_block_size() const { return current_block_size; }
395 framecnt_t worst_output_latency () const { return _worst_output_latency; }
396 framecnt_t worst_input_latency () const { return _worst_input_latency; }
397 framecnt_t worst_track_latency () const { return _worst_track_latency; }
398 framecnt_t worst_playback_latency () const { return _worst_output_latency + _worst_track_latency; }
401 std::string new_parent_folder; /* parent folder where new session folder will be created */
402 std::string new_name; /* name of newly saved session */
403 bool switch_to; /* true if we should be working on newly saved session after save-as; false otherwise */
404 bool include_media; /* true if the newly saved session should contain references to media */
405 bool copy_media; /* true if media files (audio, media, etc) should be copied into newly saved session; false otherwise */
406 bool copy_external; /* true if external media should be consolidated into the newly saved session; false otherwise */
408 std::string final_session_folder_name; /* filled in by * Session::save_as(), provides full path to newly saved session */
410 /* emitted as we make progress. 3 arguments passed to signal
413 * 1: percentage complete measured as a fraction (0-1.0) of
414 * total data copying done.
415 * 2: number of files copied so far
416 * 3: total number of files to copy
418 * Handler should return true for save-as to continue, or false
419 * to stop (and remove all evidence of partial save-as).
421 PBD::Signal3<bool,float,int64_t,int64_t> Progress;
423 /* if save_as() returns non-zero, this string will indicate the reason why.
425 std::string failure_message;
428 int save_as (SaveAs&);
429 int save_state (std::string snapshot_name, bool pending = false, bool switch_to_snapshot = false, bool template_only = false);
430 int restore_state (std::string snapshot_name);
431 int save_template (std::string template_name);
432 int save_history (std::string snapshot_name = "");
433 int restore_history (std::string snapshot_name);
434 void remove_state (std::string snapshot_name);
435 void rename_state (std::string old_name, std::string new_name);
436 void remove_pending_capture_state ();
437 int rename (const std::string&);
438 bool get_nsm_state () const { return _under_nsm_control; }
439 void set_nsm_state (bool state) { _under_nsm_control = state; }
440 bool save_default_options ();
442 PBD::Signal1<void,std::string> StateSaved;
443 PBD::Signal0<void> StateReady;
445 /* emitted when session needs to be saved due to some internal
446 * event or condition (i.e. not in response to a user request).
448 * Only one object should
449 * connect to this signal and take responsibility.
451 * Argument is the snapshot name to use when saving.
453 PBD::Signal1<void,std::string> SaveSessionRequested;
455 /* emitted during a session save to allow other entities to add state, via
456 * extra XML, to the session state
458 PBD::Signal0<void> SessionSaveUnderway;
460 std::vector<std::string> possible_states() const;
461 static std::vector<std::string> possible_states (std::string path);
463 XMLNode& get_state();
464 int set_state(const XMLNode& node, int version); // not idempotent
465 XMLNode& get_template();
467 /// The instant xml file is written to the session directory
468 void add_instant_xml (XMLNode&, bool write_to_config = true);
469 XMLNode* instant_xml (const std::string& str);
471 enum StateOfTheState {
476 InitialConnecting = 0x8,
481 StateOfTheState state_of_the_state() const { return _state_of_the_state; }
483 class StateProtector {
485 StateProtector (Session* s) : _session (s) {
486 g_atomic_int_inc (&s->_suspend_save);
489 if (g_atomic_int_dec_and_test (&_session->_suspend_save)) {
490 while (_session->_save_queued) {
491 _session->_save_queued = false;
492 _session->save_state ("");
500 void add_route_group (RouteGroup *);
501 void remove_route_group (RouteGroup&);
502 void reorder_route_groups (std::list<RouteGroup*>);
504 RouteGroup* route_group_by_name (std::string);
505 RouteGroup& all_route_group() const;
507 PBD::Signal1<void,RouteGroup*> route_group_added;
508 PBD::Signal0<void> route_group_removed;
509 PBD::Signal0<void> route_groups_reordered;
511 void foreach_route_group (boost::function<void(RouteGroup*)> f) {
512 for (std::list<RouteGroup *>::iterator i = _route_groups.begin(); i != _route_groups.end(); ++i) {
517 std::list<RouteGroup*> const & route_groups () const {
518 return _route_groups;
521 /* fundamental operations. duh. */
523 std::list<boost::shared_ptr<AudioTrack> > new_audio_track (
526 TrackMode mode = Normal,
527 RouteGroup* route_group = 0,
528 uint32_t how_many = 1,
529 std::string name_template = ""
532 RouteList new_audio_route (
533 int input_channels, int output_channels, RouteGroup* route_group, uint32_t how_many, std::string name_template = ""
536 std::list<boost::shared_ptr<MidiTrack> > new_midi_track (
537 const ChanCount& input, const ChanCount& output,
538 boost::shared_ptr<PluginInfo> instrument = boost::shared_ptr<PluginInfo>(),
539 TrackMode mode = Normal,
540 RouteGroup* route_group = 0, uint32_t how_many = 1, std::string name_template = ""
543 void remove_route (boost::shared_ptr<Route>);
544 void resort_routes ();
545 void resort_routes_using (boost::shared_ptr<RouteList>);
547 AudioEngine & engine() { return _engine; }
548 AudioEngine const & engine () const { return _engine; }
552 framepos_t transport_frame () const {return _transport_frame; }
553 framepos_t record_location () const {return _last_record_location; }
554 framepos_t audible_frame () const;
555 framepos_t requested_return_frame() const { return _requested_return_frame; }
556 void set_requested_return_frame(framepos_t return_to);
570 void sync_time_vars();
572 void bbt_time (framepos_t when, Timecode::BBT_Time&);
573 void timecode_to_sample(Timecode::Time& timecode, framepos_t& sample, bool use_offset, bool use_subframes) const;
574 void sample_to_timecode(framepos_t sample, Timecode::Time& timecode, bool use_offset, bool use_subframes) const;
575 void timecode_time (Timecode::Time &);
576 void timecode_time (framepos_t when, Timecode::Time&);
577 void timecode_time_subframes (framepos_t when, Timecode::Time&);
579 void timecode_duration (framecnt_t, Timecode::Time&) const;
580 void timecode_duration_string (char *, size_t len, framecnt_t) const;
582 framecnt_t convert_to_frames (AnyTime const & position);
583 framecnt_t any_duration_to_frames (framepos_t position, AnyTime const & duration);
585 static PBD::Signal1<void, framepos_t> StartTimeChanged;
586 static PBD::Signal1<void, framepos_t> EndTimeChanged;
588 void request_sync_source (Slave*);
589 bool synced_to_engine() const { return _slave && config.get_external_sync() && Config->get_sync_source() == Engine; }
591 double transport_speed() const { return _transport_speed; }
592 bool transport_stopped() const { return _transport_speed == 0.0f; }
593 bool transport_rolling() const { return _transport_speed != 0.0f; }
595 bool silent () { return _silent; }
597 TempoMap& tempo_map() { return *_tempo_map; }
598 const TempoMap& tempo_map() const { return *_tempo_map; }
600 unsigned int get_xrun_count () const {return _xrun_count; }
601 void reset_xrun_count () {_xrun_count = 0; }
605 boost::shared_ptr<Region> find_whole_file_parent (boost::shared_ptr<Region const>) const;
607 boost::shared_ptr<Region> XMLRegionFactory (const XMLNode&, bool full);
608 boost::shared_ptr<AudioRegion> XMLAudioRegionFactory (const XMLNode&, bool full);
609 boost::shared_ptr<MidiRegion> XMLMidiRegionFactory (const XMLNode&, bool full);
611 /* source management */
613 void import_files (ImportStatus&);
614 bool sample_rate_convert (ImportStatus&, std::string infile, std::string& outfile);
615 std::string build_tmp_convert_name (std::string file);
617 boost::shared_ptr<ExportHandler> get_export_handler ();
618 boost::shared_ptr<ExportStatus> get_export_status ();
620 int start_audio_export (framepos_t position);
622 PBD::Signal1<int, framecnt_t> ProcessExport;
623 static PBD::Signal2<void,std::string, std::string> Exported;
625 void add_source (boost::shared_ptr<Source>);
626 void remove_source (boost::weak_ptr<Source>);
628 void cleanup_regions();
629 int cleanup_sources (CleanupReport&);
630 int cleanup_trash_sources (CleanupReport&);
632 int destroy_sources (std::list<boost::shared_ptr<Source> >);
634 int remove_last_capture ();
636 /** handlers should return 0 for "everything OK", and any other value for
637 * "cannot setup audioengine".
639 static PBD::Signal1<int,uint32_t> AudioEngineSetupRequired;
641 /** handlers should return -1 for "stop cleanup",
642 0 for "yes, delete this playlist",
643 1 for "no, don't delete this playlist".
645 static PBD::Signal1<int,boost::shared_ptr<Playlist> > AskAboutPlaylistDeletion;
647 /** handlers should return 0 for "ignore the rate mismatch",
648 !0 for "do not use this session"
650 static PBD::Signal2<int, framecnt_t, framecnt_t> AskAboutSampleRateMismatch;
652 /** handlers should return !0 for use pending state, 0 for ignore it.
654 static PBD::Signal0<int> AskAboutPendingState;
656 boost::shared_ptr<AudioFileSource> create_audio_source_for_session (
657 size_t, std::string const &, uint32_t, bool destructive);
659 boost::shared_ptr<MidiSource> create_midi_source_for_session (std::string const &);
660 boost::shared_ptr<MidiSource> create_midi_source_by_stealing_name (boost::shared_ptr<Track>);
662 boost::shared_ptr<Source> source_by_id (const PBD::ID&);
663 boost::shared_ptr<AudioFileSource> audio_source_by_path_and_channel (const std::string&, uint16_t) const;
664 boost::shared_ptr<MidiSource> midi_source_by_path (const std::string&) const;
665 uint32_t count_sources_by_origin (const std::string&);
667 void add_playlist (boost::shared_ptr<Playlist>, bool unused = false);
669 /* Curves and AutomationLists (TODO when they go away) */
670 void add_automation_list(AutomationList*);
674 boost::shared_ptr<Auditioner> the_auditioner() { return auditioner; }
675 void audition_playlist ();
676 void audition_region (boost::shared_ptr<Region>);
677 void cancel_audition ();
678 bool is_auditioning () const;
680 PBD::Signal1<void,bool> AuditionActive;
682 /* flattening stuff */
684 boost::shared_ptr<Region> write_one_track (Track&, framepos_t start, framepos_t end,
685 bool overwrite, std::vector<boost::shared_ptr<Source> >&, InterThreadInfo& wot,
686 boost::shared_ptr<Processor> endpoint,
687 bool include_endpoint, bool for_export, bool for_freeze);
688 int freeze_all (InterThreadInfo&);
690 /* session-wide solo/mute/rec-enable */
692 bool soloing() const { return _non_soloed_outs_muted; }
693 bool listening() const { return _listen_cnt > 0; }
694 bool solo_isolated() const { return _solo_isolated_cnt > 0; }
696 static const SessionEvent::RTeventCallback rt_cleanup;
698 void set_solo (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
699 void set_just_one_solo (boost::shared_ptr<Route>, bool, SessionEvent::RTeventCallback after = rt_cleanup);
700 void cancel_solo_after_disconnect (boost::shared_ptr<Route>, bool upstream, SessionEvent::RTeventCallback after = rt_cleanup);
701 void set_mute (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
702 void set_listen (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
703 void set_record_enabled (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
704 void set_record_safe (boost::shared_ptr<RouteList>, bool yn, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
705 void set_solo_isolated (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
706 void set_monitoring (boost::shared_ptr<RouteList>, MonitorChoice, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
707 void set_exclusive_input_active (boost::shared_ptr<RouteList> rt, bool onoff, bool flip_others=false);
709 PBD::Signal1<void,bool> SoloActive;
710 PBD::Signal0<void> SoloChanged;
711 PBD::Signal0<void> IsolatedChanged;
713 /* monitor/master out */
715 void add_monitor_section ();
716 void reset_monitor_section ();
717 void remove_monitor_section ();
719 boost::shared_ptr<Route> monitor_out() const { return _monitor_out; }
720 boost::shared_ptr<Route> master_out() const { return _master_out; }
722 void globally_add_internal_sends (boost::shared_ptr<Route> dest, Placement p, bool);
723 void globally_set_send_gains_from_track (boost::shared_ptr<Route> dest);
724 void globally_set_send_gains_to_zero (boost::shared_ptr<Route> dest);
725 void globally_set_send_gains_to_unity (boost::shared_ptr<Route> dest);
726 void add_internal_sends (boost::shared_ptr<Route> dest, Placement p, boost::shared_ptr<RouteList> senders);
727 void add_internal_send (boost::shared_ptr<Route>, int, boost::shared_ptr<Route>);
728 void add_internal_send (boost::shared_ptr<Route>, boost::shared_ptr<Processor>, boost::shared_ptr<Route>);
730 static void set_disable_all_loaded_plugins (bool yn) {
731 _disable_all_loaded_plugins = yn;
733 static bool get_disable_all_loaded_plugins() {
734 return _disable_all_loaded_plugins;
737 uint32_t next_send_id();
738 uint32_t next_aux_send_id();
739 uint32_t next_return_id();
740 uint32_t next_insert_id();
741 void mark_send_id (uint32_t);
742 void mark_aux_send_id (uint32_t);
743 void mark_return_id (uint32_t);
744 void mark_insert_id (uint32_t);
745 void unmark_send_id (uint32_t);
746 void unmark_aux_send_id (uint32_t);
747 void unmark_return_id (uint32_t);
748 void unmark_insert_id (uint32_t);
750 /* s/w "RAID" management */
752 boost::optional<framecnt_t> available_capture_duration();
756 void add_bundle (boost::shared_ptr<Bundle>, bool emit_signal = true);
757 void remove_bundle (boost::shared_ptr<Bundle>);
758 boost::shared_ptr<Bundle> bundle_by_name (std::string) const;
760 PBD::Signal0<void> BundleAddedOrRemoved;
764 /* History (for editors, mixers, UIs etc.) */
766 /** Undo some transactions.
767 * @param n Number of transactions to undo.
769 void undo (uint32_t n) {
773 void redo (uint32_t n) {
777 UndoHistory& history() { return _history; }
779 uint32_t undo_depth() const { return _history.undo_depth(); }
780 uint32_t redo_depth() const { return _history.redo_depth(); }
781 std::string next_undo() const { return _history.next_undo(); }
782 std::string next_redo() const { return _history.next_redo(); }
784 void begin_reversible_command (const std::string& cmd_name);
785 void begin_reversible_command (GQuark);
786 void abort_reversible_command ();
787 void commit_reversible_command (Command* cmd = 0);
789 void add_command (Command *const cmd) {
790 assert (_current_trans);
791 _current_trans->add_command (cmd);
794 /** @return The list of operations that are currently in progress */
795 std::list<GQuark> const & current_operations () {
796 return _current_trans_quarks;
799 bool operation_in_progress (GQuark) const;
801 void add_commands (std::vector<Command*> const & cmds);
803 std::map<PBD::ID,PBD::StatefulDestructible*> registry;
805 // these commands are implemented in libs/ardour/session_command.cc
806 Command* memento_command_factory(XMLNode* n);
807 Command* stateful_diff_command_factory (XMLNode *);
808 void register_with_memento_command_factory(PBD::ID, PBD::StatefulDestructible*);
812 boost::shared_ptr<IO> click_io() { return _click_io; }
813 boost::shared_ptr<Amp> click_gain() { return _click_gain; }
815 /* disk, buffer loads */
817 uint32_t playback_load ();
818 uint32_t capture_load ();
822 void request_play_range (std::list<AudioRange>*, bool leave_rolling = false);
823 void request_cancel_play_range ();
824 bool get_play_range () const { return _play_range; }
826 void maybe_update_session_range (framepos_t, framepos_t);
828 /* buffers for gain and pan */
830 gain_t* gain_automation_buffer () const;
831 gain_t* trim_automation_buffer () const;
832 gain_t* send_gain_automation_buffer () const;
833 pan_t** pan_automation_buffer () const;
835 void ensure_buffer_set (BufferSet& buffers, const ChanCount& howmany);
839 static int vst_current_loading_id;
840 static const char* vst_can_do_strings[];
841 static const int vst_can_do_string_count;
843 static intptr_t vst_callback (
852 static PBD::Signal0<void> SendFeedback;
856 boost::shared_ptr<Speakers> get_speakers ();
860 boost::shared_ptr<PBD::Controllable> controllable_by_id (const PBD::ID&);
861 boost::shared_ptr<PBD::Controllable> controllable_by_descriptor (const PBD::ControllableDescriptor&);
863 void add_controllable (boost::shared_ptr<PBD::Controllable>);
864 void remove_controllable (PBD::Controllable*);
866 boost::shared_ptr<PBD::Controllable> solo_cut_control() const;
868 SessionConfiguration config;
870 bool exporting () const {
874 bool bounce_processing() const {
875 return _bounce_processing_active;
878 /* this is a private enum, but setup_enum_writer() needs it,
879 and i can't find a way to give that function
883 enum PostTransportWork {
884 PostTransportStop = 0x1,
885 PostTransportDuration = 0x2,
886 PostTransportLocate = 0x4,
887 PostTransportRoll = 0x8,
888 PostTransportAbort = 0x10,
889 PostTransportOverWrite = 0x20,
890 PostTransportSpeed = 0x40,
891 PostTransportAudition = 0x80,
892 PostTransportReverse = 0x100,
893 PostTransportInputChange = 0x200,
894 PostTransportCurveRealloc = 0x400,
895 PostTransportClearSubstate = 0x800,
896 PostTransportAdjustPlaybackBuffering = 0x1000,
897 PostTransportAdjustCaptureBuffering = 0x2000
906 SlaveState slave_state() const { return _slave_state; }
907 Slave* slave() const { return _slave; }
909 boost::shared_ptr<SessionPlaylists> playlists;
911 void send_mmc_locate (framepos_t);
912 void queue_full_time_code () { _send_timecode_update = true; }
913 void queue_song_position_pointer () { /* currently does nothing */ }
915 bool step_editing() const { return (_step_editors > 0); }
917 void request_suspend_timecode_transmission ();
918 void request_resume_timecode_transmission ();
919 bool timecode_transmission_suspended () const;
921 std::vector<std::string> source_search_path(DataType) const;
922 void ensure_search_path_includes (const std::string& path, DataType type);
923 void remove_dir_from_search_path (const std::string& path, DataType type);
925 std::list<std::string> unknown_processors () const;
927 /** Emitted when a feedback cycle has been detected within Ardour's signal
928 processing path. Until it is fixed (by the user) some (unspecified)
929 routes will not be run.
931 static PBD::Signal0<void> FeedbackDetected;
933 /** Emitted when a graph sort has successfully completed, which means
934 that it has no feedback cycles.
936 static PBD::Signal0<void> SuccessfulGraphSort;
938 /* handlers can return an integer value:
939 0: config.set_audio_search_path() or config.set_midi_search_path() was used
940 to modify the search path and we should try to find it again.
941 1: quit entire session load
942 2: as 0, but don't ask about other missing files
943 3: don't ask about other missing files, and just mark this one missing
944 -1: just mark this one missing
945 any other value: as -1
947 static PBD::Signal3<int,Session*,std::string,DataType> MissingFile;
949 /** Emitted when the session wants Ardour to quit */
950 static PBD::Signal0<void> Quit;
952 /** Emitted when Ardour is asked to load a session in an older session
953 * format, and makes a backup copy.
955 static PBD::Signal2<void,std::string,std::string> VersionMismatch;
957 SceneChanger* scene_changer() const { return _scene_changer; }
959 boost::shared_ptr<Port> ltc_input_port() const;
960 boost::shared_ptr<Port> ltc_output_port() const;
962 boost::shared_ptr<IO> ltc_input_io() { return _ltc_input; }
963 boost::shared_ptr<IO> ltc_output_io() { return _ltc_output; }
965 MIDI::Port* midi_input_port () const;
966 MIDI::Port* midi_output_port () const;
967 MIDI::Port* mmc_output_port () const;
968 MIDI::Port* mmc_input_port () const;
970 MIDI::Port* scene_input_port () const;
971 MIDI::Port* scene_output_port () const;
973 boost::shared_ptr<MidiPort> scene_in () const;
974 boost::shared_ptr<MidiPort> scene_out () const;
976 boost::shared_ptr<MidiPort> midi_clock_output_port () const;
977 boost::shared_ptr<MidiPort> midi_clock_input_port () const;
978 boost::shared_ptr<MidiPort> mtc_output_port () const;
979 boost::shared_ptr<MidiPort> mtc_input_port () const;
981 MIDI::MachineControl& mmc() { return *_mmc; }
984 friend class AudioEngine;
985 void set_block_size (pframes_t nframes);
986 void set_frame_rate (framecnt_t nframes);
987 void reconnect_existing_routes (bool withLock, bool reconnect_master = true, bool reconnect_inputs = true, bool reconnect_outputs = true);
991 void schedule_curve_reallocation ();
992 void update_latency_compensation (bool force = false);
995 int create (const std::string& mix_template, BusProfile*);
999 PendingDeclickIn = 0x1, ///< pending de-click fade-in for start
1000 PendingDeclickOut = 0x2, ///< pending de-click fade-out for stop
1001 StopPendingCapture = 0x4,
1002 PendingLoopDeclickIn = 0x8, ///< pending de-click fade-in at the start of a loop
1003 PendingLoopDeclickOut = 0x10, ///< pending de-click fade-out at the end of a loop
1004 PendingLocate = 0x20,
1007 /* stuff used in process() should be close together to
1011 typedef void (Session::*process_function_type)(pframes_t);
1013 AudioEngine& _engine;
1014 mutable gint processing_prohibited;
1015 process_function_type process_function;
1016 process_function_type last_process_function;
1017 bool _bounce_processing_active;
1018 bool waiting_for_sync_offset;
1019 framecnt_t _base_frame_rate;
1020 framecnt_t _current_frame_rate; //this includes video pullup offset
1021 framecnt_t _nominal_frame_rate; //ignores audioengine setting, "native" SR
1022 int transport_sub_state;
1023 mutable gint _record_status;
1024 framepos_t _transport_frame;
1025 Location* _session_range_location; ///< session range, or 0 if there is nothing in the session yet
1029 // varispeed playback
1030 double _transport_speed;
1031 double _default_transport_speed;
1032 double _last_transport_speed;
1033 double _signalled_varispeed;
1034 double _target_transport_speed;
1035 CubicInterpolation interpolation;
1037 bool auto_play_legal;
1038 framepos_t _last_slave_transport_frame;
1039 framecnt_t maximum_output_latency;
1040 framepos_t _requested_return_frame;
1041 pframes_t current_block_size;
1042 framecnt_t _worst_output_latency;
1043 framecnt_t _worst_input_latency;
1044 framecnt_t _worst_track_latency;
1045 bool _have_captured;
1046 bool _non_soloed_outs_muted;
1047 uint32_t _listen_cnt;
1048 uint32_t _solo_isolated_cnt;
1051 bool _under_nsm_control;
1052 unsigned int _xrun_count;
1054 void initialize_latencies ();
1055 void set_worst_io_latencies ();
1056 void set_worst_playback_latency ();
1057 void set_worst_capture_latency ();
1058 void set_worst_io_latencies_x (IOChange, void *) {
1059 set_worst_io_latencies ();
1061 void post_capture_latency ();
1062 void post_playback_latency ();
1064 void update_latency_compensation_proxy (void* ignored);
1066 void ensure_buffers (ChanCount howmany = ChanCount::ZERO);
1068 void process_scrub (pframes_t);
1069 void process_without_events (pframes_t);
1070 void process_with_events (pframes_t);
1071 void process_audition (pframes_t);
1072 int process_export (pframes_t);
1073 int process_export_fw (pframes_t);
1075 void block_processing() { g_atomic_int_set (&processing_prohibited, 1); }
1076 void unblock_processing() { g_atomic_int_set (&processing_prohibited, 0); }
1077 bool processing_blocked() const { return g_atomic_int_get (&processing_prohibited); }
1079 static const framecnt_t bounce_chunk_size;
1081 /* slave tracking */
1083 static const int delta_accumulator_size = 25;
1084 int delta_accumulator_cnt;
1085 int32_t delta_accumulator[delta_accumulator_size];
1086 int32_t average_slave_delta;
1088 bool have_first_delta_accumulator;
1090 SlaveState _slave_state;
1091 framepos_t slave_wait_end;
1093 void reset_slave_state ();
1094 bool follow_slave (pframes_t);
1095 void calculate_moving_average_of_slave_delta (int dir, framecnt_t this_delta);
1096 void track_slave_state (float slave_speed, framepos_t slave_transport_frame, framecnt_t this_delta);
1097 void follow_slave_silently (pframes_t nframes, float slave_speed);
1099 void switch_to_sync_source (SyncSource); /* !RT context */
1100 void drop_sync_source (); /* !RT context */
1101 void use_sync_source (Slave*); /* RT context */
1103 bool post_export_sync;
1104 framepos_t post_export_position;
1107 bool _export_started;
1108 bool _export_rolling;
1110 boost::shared_ptr<ExportHandler> export_handler;
1111 boost::shared_ptr<ExportStatus> export_status;
1114 int stop_audio_export ();
1115 void finalize_audio_export ();
1116 void finalize_export_internal (bool stop_freewheel);
1117 bool _pre_export_mmc_enabled;
1119 PBD::ScopedConnection export_freewheel_connection;
1121 void get_track_statistics ();
1122 int process_routes (pframes_t, bool& need_butler);
1123 int silent_process_routes (pframes_t, bool& need_butler);
1125 /** @return 1 if there is a pending declick fade-in,
1126 -1 if there is a pending declick fade-out,
1127 0 if there is no pending declick.
1129 int get_transport_declick_required () {
1130 if (transport_sub_state & PendingDeclickIn) {
1131 transport_sub_state &= ~PendingDeclickIn;
1133 } else if (transport_sub_state & PendingDeclickOut) {
1134 /* XXX: not entirely sure why we don't clear this */
1136 } else if (transport_sub_state & PendingLoopDeclickOut) {
1137 /* Return the declick out first ... */
1138 transport_sub_state &= ~PendingLoopDeclickOut;
1140 } else if (transport_sub_state & PendingLoopDeclickIn) {
1141 /* ... then the declick in on the next call */
1142 transport_sub_state &= ~PendingLoopDeclickIn;
1149 bool maybe_stop (framepos_t limit);
1150 bool maybe_sync_start (pframes_t &);
1152 void check_declick_out ();
1158 /** Number of process frames since the last MTC output (when sending MTC); used to
1159 * know when to send full MTC messages every so often.
1161 pframes_t _pframes_since_last_mtc;
1162 bool session_midi_feedback;
1165 framepos_t last_loopend;
1167 boost::scoped_ptr<SessionDirectory> _session_dir;
1170 void graph_reordered ();
1172 /** current snapshot name, without the .ardour suffix */
1173 std::string _current_snapshot_name;
1175 XMLTree* state_tree;
1176 bool state_was_pending;
1177 StateOfTheState _state_of_the_state;
1179 friend class StateProtector;
1180 gint _suspend_save; /* atomic */
1181 volatile bool _save_queued;
1182 Glib::Threads::Mutex save_state_lock;
1184 int load_options (const XMLNode&);
1185 int load_state (std::string snapshot_name);
1187 framepos_t _last_roll_location;
1188 /** the session frame time at which we last rolled, located, or changed transport direction */
1189 framepos_t _last_roll_or_reversal_location;
1190 framepos_t _last_record_location;
1192 bool pending_locate_roll;
1193 framepos_t pending_locate_frame;
1194 bool pending_locate_flush;
1196 bool pending_auto_loop;
1200 static const PostTransportWork ProcessCannotProceedMask =
1202 PostTransportInputChange|
1204 PostTransportReverse|
1205 PostTransportCurveRealloc|
1206 PostTransportAudition|
1207 PostTransportLocate|
1209 PostTransportClearSubstate);
1211 gint _post_transport_work; /* accessed only atomic ops */
1212 PostTransportWork post_transport_work() const { return (PostTransportWork) g_atomic_int_get (const_cast<gint*>(&_post_transport_work)); }
1213 void set_post_transport_work (PostTransportWork ptw) { g_atomic_int_set (&_post_transport_work, (gint) ptw); }
1214 void add_post_transport_work (PostTransportWork ptw);
1216 void schedule_playback_buffering_adjustment ();
1217 void schedule_capture_buffering_adjustment ();
1219 uint32_t cumulative_rf_motion;
1222 void set_rf_speed (float speed);
1223 void reset_rf_scale (framecnt_t frames_moved);
1225 Locations* _locations;
1226 void location_added (Location*);
1227 void location_removed (Location*);
1228 void locations_changed ();
1229 void _locations_changed (const Locations::LocationList&);
1231 void update_skips (Location*, bool consolidate);
1232 void update_marks (Location* loc);
1233 void update_loop (Location* loc);
1234 void consolidate_skips (Location*);
1235 void sync_locations_to_skips ();
1236 void _sync_locations_to_skips ();
1238 PBD::ScopedConnectionList skip_update_connections;
1239 bool _ignore_skips_updates;
1241 PBD::ScopedConnectionList punch_connections;
1242 void auto_punch_start_changed (Location *);
1243 void auto_punch_end_changed (Location *);
1244 void auto_punch_changed (Location *);
1246 PBD::ScopedConnectionList loop_connections;
1247 void auto_loop_changed (Location *);
1248 void auto_loop_declick_range (Location *, framepos_t &, framepos_t &);
1250 int ensure_engine (uint32_t desired_sample_rate);
1251 void pre_engine_init (std::string path);
1252 int post_engine_init ();
1253 int immediately_post_engine ();
1254 void remove_empty_sounds ();
1256 void setup_midi_control ();
1257 int midi_read (MIDI::Port *);
1259 void enable_record ();
1261 void increment_transport_position (framecnt_t val) {
1262 if (max_framepos - val < _transport_frame) {
1263 _transport_frame = max_framepos;
1265 _transport_frame += val;
1269 void decrement_transport_position (framecnt_t val) {
1270 if (val < _transport_frame) {
1271 _transport_frame -= val;
1273 _transport_frame = 0;
1277 void post_transport_motion ();
1278 static void *session_loader_thread (void *arg);
1282 /* Signal Forwarding */
1283 void emit_route_signals ();
1284 void emit_thread_run ();
1285 static void *emit_thread (void *);
1286 void emit_thread_start ();
1287 void emit_thread_terminate ();
1289 pthread_t _rt_emit_thread;
1290 bool _rt_thread_active;
1292 pthread_mutex_t _rt_emit_mutex;
1293 pthread_cond_t _rt_emit_cond;
1294 bool _rt_emit_pending;
1297 /* SessionEventManager interface */
1299 void process_event (SessionEvent*);
1300 void set_next_event ();
1301 void cleanup_event (SessionEvent*,int);
1303 /* MIDI Machine Control */
1306 void spp_continue ();
1309 void mmc_deferred_play (MIDI::MachineControl &);
1310 void mmc_stop (MIDI::MachineControl &);
1311 void mmc_step (MIDI::MachineControl &, int);
1312 void mmc_pause (MIDI::MachineControl &);
1313 void mmc_record_pause (MIDI::MachineControl &);
1314 void mmc_record_strobe (MIDI::MachineControl &);
1315 void mmc_record_exit (MIDI::MachineControl &);
1316 void mmc_track_record_status (MIDI::MachineControl &, uint32_t track, bool enabled);
1317 void mmc_fast_forward (MIDI::MachineControl &);
1318 void mmc_rewind (MIDI::MachineControl &);
1319 void mmc_locate (MIDI::MachineControl &, const MIDI::byte *);
1320 void mmc_shuttle (MIDI::MachineControl &mmc, float speed, bool forw);
1321 void mmc_record_enable (MIDI::MachineControl &mmc, size_t track, bool enabled);
1323 struct timeval last_mmc_step;
1326 typedef boost::function<bool()> MidiTimeoutCallback;
1327 typedef std::list<MidiTimeoutCallback> MidiTimeoutList;
1329 MidiTimeoutList midi_timeouts;
1330 bool mmc_step_timeout ();
1331 void send_immediate_mmc (MIDI::MachineControlCommand);
1333 MIDI::byte mtc_msg[16];
1334 MIDI::byte mtc_timecode_bits; /* encoding of SMTPE type for MTC */
1335 MIDI::byte midi_msg[16];
1336 double outbound_mtc_timecode_frame;
1337 Timecode::Time transmitting_timecode_time;
1338 int next_quarter_frame_to_send;
1340 double _frames_per_timecode_frame; /* has to be floating point because of drop frame */
1341 framecnt_t _frames_per_hour;
1342 framecnt_t _timecode_frames_per_hour;
1344 /* cache the most-recently requested time conversions. This helps when we
1345 * have multiple clocks showing the same time (e.g. the transport frame) */
1346 bool last_timecode_valid;
1347 framepos_t last_timecode_when;
1348 Timecode::Time last_timecode;
1350 bool _send_timecode_update; ///< Flag to send a full frame (Timecode) MTC message this cycle
1352 int send_midi_time_code_for_cycle (framepos_t, framepos_t, pframes_t nframes);
1354 LTCEncoder* ltc_encoder;
1355 ltcsnd_sample_t* ltc_enc_buf;
1357 Timecode::TimecodeFormat ltc_enc_tcformat;
1358 int32_t ltc_buf_off;
1359 int32_t ltc_buf_len;
1362 int32_t ltc_enc_byte;
1363 framepos_t ltc_enc_pos;
1365 framepos_t ltc_enc_off;
1367 framepos_t ltc_prev_cycle;
1369 framepos_t ltc_timecode_offset;
1370 bool ltc_timecode_negative_offset;
1372 LatencyRange ltc_out_latency;
1374 void ltc_tx_initialize();
1375 void ltc_tx_cleanup();
1376 void ltc_tx_reset();
1377 void ltc_tx_resync_latency();
1378 void ltc_tx_recalculate_position();
1379 void ltc_tx_parse_offset();
1380 void ltc_tx_send_time_code_for_cycle (framepos_t, framepos_t, double, double, pframes_t nframes);
1382 void reset_record_status ();
1384 int no_roll (pframes_t nframes);
1385 int fail_roll (pframes_t nframes);
1387 bool non_realtime_work_pending() const { return static_cast<bool>(post_transport_work()); }
1388 bool process_can_proceed() const { return !(post_transport_work() & ProcessCannotProceedMask); }
1390 MidiControlUI* midi_control_ui;
1392 int start_midi_thread ();
1394 void set_play_loop (bool yn, double speed);
1395 void unset_play_loop ();
1396 void overwrite_some_buffers (Track *);
1397 void flush_all_inserts ();
1398 int micro_locate (framecnt_t distance);
1399 void locate (framepos_t, bool with_roll, bool with_flush, bool with_loop=false, bool force=false, bool with_mmc=true);
1400 void start_locate (framepos_t, bool with_roll, bool with_flush, bool with_loop=false, bool force=false);
1401 void force_locate (framepos_t frame, bool with_roll = false);
1402 void set_track_speed (Track *, double speed);
1403 void set_transport_speed (double speed, framepos_t destination_frame, bool abort = false, bool clear_state = false, bool as_default = false);
1404 void stop_transport (bool abort = false, bool clear_state = false);
1405 void start_transport ();
1406 void realtime_stop (bool abort, bool clear_state);
1407 void realtime_locate ();
1408 void non_realtime_start_scrub ();
1409 void non_realtime_set_speed ();
1410 void non_realtime_locate ();
1411 void non_realtime_stop (bool abort, int entry_request_count, bool& finished);
1412 void non_realtime_overwrite (int entry_request_count, bool& finished);
1413 void post_transport ();
1414 void engine_halted ();
1415 void xrun_recovery ();
1416 void set_track_loop (bool);
1418 /* These are synchronous and so can only be called from within the process
1422 int send_full_time_code (framepos_t, pframes_t nframes);
1423 void send_song_position_pointer (framepos_t);
1425 TempoMap *_tempo_map;
1426 void tempo_map_changed (const PBD::PropertyChange&);
1428 /* edit/mix groups */
1430 int load_route_groups (const XMLNode&, int);
1432 std::list<RouteGroup *> _route_groups;
1433 RouteGroup* _all_route_group;
1437 boost::shared_ptr<Graph> _process_graph;
1439 SerializedRCUManager<RouteList> routes;
1441 void add_routes (RouteList&, bool input_auto_connect, bool output_auto_connect, bool save);
1442 void add_routes_inner (RouteList&, bool input_auto_connect, bool output_auto_connect);
1443 bool _adding_routes_in_progress;
1444 uint32_t destructive_index;
1446 boost::shared_ptr<Route> XMLRouteFactory (const XMLNode&, int);
1447 boost::shared_ptr<Route> XMLRouteFactory_2X (const XMLNode&, int);
1449 void route_processors_changed (RouteProcessorChange);
1451 bool find_route_name (std::string const &, uint32_t& id, char* name, size_t name_len, bool);
1452 void count_existing_track_channels (ChanCount& in, ChanCount& out);
1453 void auto_connect_route (boost::shared_ptr<Route> route, ChanCount& existing_inputs, ChanCount& existing_outputs,
1454 bool with_lock, bool connect_inputs = true,
1455 ChanCount input_start = ChanCount (), ChanCount output_start = ChanCount ());
1456 void midi_output_change_handler (IOChange change, void* /*src*/, boost::weak_ptr<Route> midi_track);
1458 /* track numbering */
1460 void reassign_track_numbers ();
1461 uint32_t _track_number_decimals;
1465 bool solo_update_disabled;
1467 void route_listen_changed (void *src, boost::weak_ptr<Route>);
1468 void route_mute_changed (void *src);
1469 void route_solo_changed (bool self_solo_change, void *src, boost::weak_ptr<Route>);
1470 void route_solo_isolated_changed (void *src, boost::weak_ptr<Route>);
1471 void update_route_solo_state (boost::shared_ptr<RouteList> r = boost::shared_ptr<RouteList>());
1473 void listen_position_changed ();
1474 void solo_control_mode_changed ();
1476 /* REGION MANAGEMENT */
1478 mutable Glib::Threads::Mutex region_lock;
1480 int load_regions (const XMLNode& node);
1481 int load_compounds (const XMLNode& node);
1483 void route_added_to_route_group (RouteGroup *, boost::weak_ptr<Route>);
1484 void route_removed_from_route_group (RouteGroup *, boost::weak_ptr<Route>);
1485 void route_group_property_changed (RouteGroup *);
1489 mutable Glib::Threads::Mutex source_lock;
1492 typedef std::map<PBD::ID,boost::shared_ptr<Source> > SourceMap;
1495 void reset_write_sources (bool mark_write_complete, bool force = false);
1500 int load_sources (const XMLNode& node);
1501 XMLNode& get_sources_as_xml ();
1503 boost::shared_ptr<Source> XMLSourceFactory (const XMLNode&);
1507 void remove_playlist (boost::weak_ptr<Playlist>);
1508 void track_playlist_changed (boost::weak_ptr<Track>);
1509 void playlist_region_added (boost::weak_ptr<Region>);
1510 void playlist_ranges_moved (std::list<Evoral::RangeMove<framepos_t> > const &);
1511 void playlist_regions_extended (std::list<Evoral::Range<framepos_t> > const &);
1513 /* CURVES and AUTOMATION LISTS */
1514 std::map<PBD::ID, AutomationList*> automation_lists;
1516 /* DEFAULT FADE CURVES */
1518 float default_fade_steepness;
1519 float default_fade_msecs;
1523 boost::shared_ptr<Auditioner> auditioner;
1524 void set_audition (boost::shared_ptr<Region>);
1525 void non_realtime_set_audition ();
1526 boost::shared_ptr<Region> pending_audition_region;
1532 int flatten_one_track (AudioTrack&, framepos_t start, framecnt_t cnt);
1534 /* INSERT AND SEND MANAGEMENT */
1536 boost::dynamic_bitset<uint32_t> send_bitset;
1537 boost::dynamic_bitset<uint32_t> aux_send_bitset;
1538 boost::dynamic_bitset<uint32_t> return_bitset;
1539 boost::dynamic_bitset<uint32_t> insert_bitset;
1543 struct space_and_path {
1544 uint32_t blocks; ///< 4kB blocks
1545 bool blocks_unknown; ///< true if blocks is unknown
1550 , blocks_unknown (true)
1554 struct space_and_path_ascending_cmp {
1555 bool operator() (space_and_path a, space_and_path b) {
1556 if (a.blocks_unknown != b.blocks_unknown) {
1557 return !a.blocks_unknown;
1559 return a.blocks > b.blocks;
1563 void setup_raid_path (std::string path);
1565 std::vector<space_and_path> session_dirs;
1566 std::vector<space_and_path>::iterator last_rr_session_dir;
1567 uint32_t _total_free_4k_blocks;
1568 /** If this is true, _total_free_4k_blocks is not definite,
1569 as one or more of the session directories' filesystems
1570 could not report free space.
1572 bool _total_free_4k_blocks_uncertain;
1573 Glib::Threads::Mutex space_lock;
1575 bool no_questions_about_missing_files;
1577 std::string get_best_session_directory_for_new_audio ();
1579 mutable gint _playback_load;
1580 mutable gint _capture_load;
1584 SerializedRCUManager<BundleList> _bundles;
1585 XMLNode* _bundle_xml_node;
1586 int load_bundles (XMLNode const &);
1588 UndoHistory _history;
1589 /** current undo transaction, or 0 */
1590 UndoTransaction* _current_trans;
1591 /** GQuarks to describe the reversible commands that are currently in progress.
1592 * These may be nested, in which case more recently-started commands are toward
1593 * the front of the list.
1595 std::list<GQuark> _current_trans_quarks;
1597 int backend_sync_callback (TransportState, framepos_t);
1599 void process_rtop (SessionEvent*);
1601 void update_latency (bool playback);
1603 XMLNode& state(bool);
1606 typedef std::list<Click*> Clicks;
1609 boost::shared_ptr<IO> _click_io;
1610 boost::shared_ptr<Amp> _click_gain;
1612 Sample* click_emphasis_data;
1613 framecnt_t click_length;
1614 framecnt_t click_emphasis_length;
1615 mutable Glib::Threads::RWLock click_lock;
1617 static const Sample default_click[];
1618 static const framecnt_t default_click_length;
1619 static const Sample default_click_emphasis[];
1620 static const framecnt_t default_click_emphasis_length;
1623 framepos_t _clicks_cleared;
1624 void setup_click_sounds (int which);
1625 void setup_click_sounds (Sample**, Sample const *, framecnt_t*, framecnt_t, std::string const &);
1626 void clear_clicks ();
1627 void click (framepos_t start, framecnt_t nframes);
1629 std::vector<Route*> master_outs;
1631 /* range playback */
1633 std::list<AudioRange> current_audio_range;
1635 void set_play_range (std::list<AudioRange>&, bool leave_rolling);
1636 void unset_play_range ();
1641 boost::shared_ptr<Route> _master_out;
1642 boost::shared_ptr<Route> _monitor_out;
1644 void auto_connect_master_bus ();
1646 /* Windows VST support */
1648 long _windows_vst_callback (
1657 int find_all_sources (std::string path, std::set<std::string>& result);
1658 int find_all_sources_across_snapshots (std::set<std::string>& result, bool exclude_this_snapshot);
1660 typedef std::set<boost::shared_ptr<PBD::Controllable> > Controllables;
1661 Glib::Threads::Mutex controllables_lock;
1662 Controllables controllables;
1664 boost::shared_ptr<PBD::Controllable> _solo_cut_control;
1666 void reset_native_file_format();
1667 bool first_file_data_format_reset;
1668 bool first_file_header_format_reset;
1670 void config_changed (std::string, bool);
1672 XMLNode& get_control_protocol_state ();
1674 void set_history_depth (uint32_t depth);
1676 static bool _disable_all_loaded_plugins;
1678 mutable bool have_looped; ///< Used in ::audible_frame(*)
1680 void update_have_rec_enabled_track ();
1681 gint _have_rec_enabled_track;
1682 gint _have_rec_disabled_track;
1684 static int ask_about_playlist_deletion (boost::shared_ptr<Playlist>);
1686 /* realtime "apply to set of routes" operations */
1687 template<typename T> SessionEvent*
1688 get_rt_event (boost::shared_ptr<RouteList> rl, T targ, SessionEvent::RTeventCallback after, bool group_override,
1689 void (Session::*method) (boost::shared_ptr<RouteList>, T, bool)) {
1690 SessionEvent* ev = new SessionEvent (SessionEvent::RealTimeOperation, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
1691 ev->rt_slot = boost::bind (method, this, rl, targ, group_override);
1692 ev->rt_return = after;
1693 ev->event_loop = PBD::EventLoop::get_event_loop_for_thread ();
1698 void rt_cancel_solo_after_disconnect (boost::shared_ptr<RouteList>, bool upstream, bool /* ignored*/ );
1699 void rt_set_solo (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1700 void rt_set_just_one_solo (boost::shared_ptr<RouteList>, bool yn, bool /* ignored*/ );
1701 void rt_set_mute (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1702 void rt_set_listen (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1703 void rt_set_solo_isolated (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1704 void rt_set_record_enabled (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1705 void rt_set_record_safe (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1706 void rt_set_monitoring (boost::shared_ptr<RouteList>, MonitorChoice, bool group_override);
1708 /** temporary list of Diskstreams used only during load of 2.X sessions */
1709 std::list<boost::shared_ptr<Diskstream> > _diskstreams_2X;
1711 void add_session_range_location (framepos_t, framepos_t);
1713 void setup_midi_machine_control ();
1715 void step_edit_status_change (bool);
1716 uint32_t _step_editors;
1718 /** true if timecode transmission by the transport is suspended, otherwise false */
1719 mutable gint _suspend_timecode_transmission;
1721 void update_locations_after_tempo_map_change (const Locations::LocationList &);
1723 void start_time_changed (framepos_t);
1724 void end_time_changed (framepos_t);
1726 void set_track_monitor_input_status (bool);
1727 framepos_t compute_stop_limit () const;
1729 boost::shared_ptr<Speakers> _speakers;
1730 void load_nested_sources (const XMLNode& node);
1732 /** The directed graph of routes that is currently being used for audio processing
1733 and solo/mute computations.
1735 GraphEdges _current_route_graph;
1737 uint32_t next_control_id () const;
1738 int32_t _order_hint;
1739 bool ignore_route_processor_changes;
1741 MidiClockTicker* midi_clock;
1743 boost::shared_ptr<IO> _ltc_input;
1744 boost::shared_ptr<IO> _ltc_output;
1746 void reconnect_ltc_input ();
1747 void reconnect_ltc_output ();
1749 /* Scene Changing */
1750 SceneChanger* _scene_changer;
1752 /* persistent, non-track related MIDI ports */
1753 MidiPortManager* _midi_ports;
1754 MIDI::MachineControl* _mmc;
1757 void setup_click ();
1758 void setup_click_state (const XMLNode*);
1759 void setup_bundles ();
1761 void save_as_bring_callback (uint32_t, uint32_t, std::string);
1763 static int get_session_info_from_path (XMLTree& state_tree, const std::string& xmlpath);
1767 } // namespace ARDOUR
1769 #endif /* __ardour_session_h__ */