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"
33 #include <boost/dynamic_bitset.hpp>
34 #include <boost/scoped_ptr.hpp>
35 #include <boost/weak_ptr.hpp>
36 #include <boost/utility.hpp>
38 #include <glibmm/threads.h>
42 #include "pbd/error.h"
43 #include "pbd/event_loop.h"
45 #include "pbd/statefuldestructible.h"
46 #include "pbd/signals.h"
49 #include "evoral/types.hpp"
51 #include "midi++/types.h"
52 #include "midi++/mmc.h"
54 #include "timecode/time.h"
56 #include "ardour/ardour.h"
57 #include "ardour/chan_count.h"
58 #include "ardour/delivery.h"
59 #include "ardour/interthread_info.h"
60 #include "ardour/rc_configuration.h"
61 #include "ardour/session_configuration.h"
62 #include "ardour/session_event.h"
63 #include "ardour/location.h"
64 #include "ardour/interpolation.h"
65 #include "ardour/route_graph.h"
71 typedef struct _AEffect AEffect;
81 class ControllableDescriptor;
92 class AudioFileSource;
110 class MidiClockTicker;
112 class MidiPortManager;
131 class SessionDirectory;
132 class SessionMetadata;
133 class SessionPlaylists;
139 class WindowsVSTPlugin;
141 extern void setup_enum_writer ();
143 class LIBARDOUR_API SessionException: public std::exception {
145 explicit SessionException(const std::string msg) : _message(msg) {}
146 virtual ~SessionException() throw() {}
148 virtual const char* what() const throw() { return _message.c_str(); }
151 std::string _message;
154 class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::ScopedConnectionList, public SessionEventManager
163 /* a new session might have non-empty mix_template, an existing session should always have an empty one.
164 the bus profile can be null if no master out bus is required.
167 Session (AudioEngine&,
168 const std::string& fullpath,
169 const std::string& snapshot_name,
170 BusProfile* bus_profile = 0,
171 std::string mix_template = "");
175 static int get_info_from_path (const std::string& xmlpath, float& sample_rate, SampleFormat& data_format);
177 std::string path() const { return _path; }
178 std::string name() const { return _name; }
179 std::string snap_name() const { return _current_snapshot_name; }
180 std::string raid_path () const;
181 bool path_is_within_session (const std::string&);
183 void set_snap_name ();
185 bool writable() const { return _writable; }
188 bool dirty() const { return _state_of_the_state & Dirty; }
189 void set_deletion_in_progress ();
190 void clear_deletion_in_progress ();
191 bool reconnection_in_progress() const { return _reconnecting_routes_in_progress; }
192 bool deletion_in_progress() const { return _state_of_the_state & Deletion; }
193 bool routes_deletion_in_progress() const { return _route_deletion_in_progress; }
194 bool peaks_cleanup_in_progres() const { return _state_of_the_state & PeakCleanup; }
196 PBD::Signal0<void> DirtyChanged;
198 PBD::Signal1<void, bool> RouteAddedOrRemoved;
200 const SessionDirectory& session_directory () const { return *(_session_dir.get()); }
202 static PBD::Signal1<void,std::string> Dialog;
204 PBD::Signal0<void> BatchUpdateStart;
205 PBD::Signal0<void> BatchUpdateEnd;
207 int ensure_subdirs ();
209 std::string automation_dir () const; ///< Automation data
210 std::string analysis_dir () const; ///< Analysis data
211 std::string plugins_dir () const; ///< Plugin state
212 std::string externals_dir () const; ///< Links to external files
214 std::string construct_peak_filepath (const std::string& audio_path, const bool in_session = false, const bool old_peak_name = false) const;
216 bool audio_source_name_is_unique (const std::string& name);
217 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);
218 std::string new_audio_source_path_for_embedded (const std::string& existing_path);
219 std::string new_audio_source_path (const std::string&, uint32_t nchans, uint32_t chan, bool destructive, bool take_required);
220 std::string new_midi_source_path (const std::string&);
221 RouteList new_route_from_template (uint32_t how_many, const std::string& template_path, const std::string& name);
222 std::vector<std::string> get_paths_for_new_sources (bool allow_replacing, const std::string& import_file_path, uint32_t channels);
224 int bring_all_sources_into_session (boost::function<void(uint32_t,uint32_t,std::string)> callback);
226 void process (pframes_t nframes);
228 BufferSet& get_silent_buffers (ChanCount count = ChanCount::ZERO);
229 BufferSet& get_scratch_buffers (ChanCount count = ChanCount::ZERO, bool silence = true );
230 BufferSet& get_route_buffers (ChanCount count = ChanCount::ZERO, bool silence = true);
231 BufferSet& get_mix_buffers (ChanCount count = ChanCount::ZERO);
233 bool have_rec_enabled_track () const;
234 bool have_rec_disabled_track () const;
236 bool have_captured() const { return _have_captured; }
238 void refill_all_track_buffers ();
239 Butler* butler() { return _butler; }
240 void butler_transport_work ();
242 void refresh_disk_space ();
244 int load_diskstreams_2X (XMLNode const &, int);
246 int load_routes (const XMLNode&, int);
247 boost::shared_ptr<RouteList> get_routes() const {
248 return routes.reader ();
251 boost::shared_ptr<RouteList> get_tracks() const;
252 boost::shared_ptr<RouteList> get_routes_with_internal_returns() const;
253 boost::shared_ptr<RouteList> get_routes_with_regions_at (framepos_t const) const;
255 uint32_t nroutes() const { return routes.reader()->size(); }
256 uint32_t ntracks () const;
257 uint32_t nbusses () const;
259 boost::shared_ptr<BundleList> bundles () {
260 return _bundles.reader ();
263 struct LIBARDOUR_API RoutePublicOrderSorter {
264 bool operator() (boost::shared_ptr<Route>, boost::shared_ptr<Route> b);
267 void set_order_hint (int32_t order_hint) {_order_hint = order_hint;};
268 void notify_remote_id_change ();
269 void sync_order_keys ();
271 template<class T> void foreach_route (T *obj, void (T::*func)(Route&), bool sort = true);
272 template<class T> void foreach_route (T *obj, void (T::*func)(boost::shared_ptr<Route>), bool sort = true);
273 template<class T, class A> void foreach_route (T *obj, void (T::*func)(Route&, A), A arg, bool sort = true);
275 static char session_name_is_legal (const std::string&);
276 bool io_name_is_legal (const std::string&);
277 boost::shared_ptr<Route> route_by_name (std::string);
278 boost::shared_ptr<Route> route_by_id (PBD::ID);
279 boost::shared_ptr<Route> route_by_remote_id (uint32_t id);
280 boost::shared_ptr<Track> track_by_diskstream_id (PBD::ID);
281 void routes_using_input_from (const std::string& str, RouteList& rl);
283 bool route_name_unique (std::string) const;
284 bool route_name_internal (std::string) const;
286 uint32_t track_number_decimals () const {
287 return _track_number_decimals;
290 bool get_record_enabled() const {
291 return (record_status () >= Enabled);
294 RecordState record_status() const {
295 return (RecordState) g_atomic_int_get (&_record_status);
298 bool actively_recording () const {
299 return record_status() == Recording;
302 bool record_enabling_legal () const;
303 void maybe_enable_record ();
304 void disable_record (bool rt_context, bool force = false);
305 void step_back_from_record ();
307 void maybe_write_autosave ();
309 /* Emitted when all i/o connections are complete */
311 PBD::Signal0<void> IOConnectionsComplete;
313 /* Timecode status signals */
314 PBD::Signal1<void, bool> MTCSyncStateChanged;
315 PBD::Signal1<void, bool> LTCSyncStateChanged;
317 /* Record status signals */
319 PBD::Signal0<void> RecordStateChanged; /* signals changes in recording state (i.e. are we recording) */
320 /* XXX may 2015: paul says: it isn't clear to me that this has semantics that cannot be inferrred
321 from the previous signal and session state.
323 PBD::Signal0<void> RecordArmStateChanged; /* signals changes in recording arming */
325 /* Emited when session is loaded */
326 PBD::Signal0<void> SessionLoaded;
328 /* Transport mechanism signals */
330 /** Emitted on the following changes in transport state:
331 * - stop (from the butler thread)
332 * - change in whether or not we are looping (from the process thread)
333 * - change in the play range (from the process thread)
334 * - start (from the process thread)
337 PBD::Signal0<void> TransportStateChange;
339 PBD::Signal1<void,framepos_t> PositionChanged; /* sent after any non-sequential motion */
340 PBD::Signal1<void,framepos_t> Xrun;
341 PBD::Signal0<void> TransportLooped;
343 /** emitted when a locate has occurred */
344 PBD::Signal0<void> Located;
346 PBD::Signal1<void,RouteList&> RouteAdded;
347 /** Emitted when a property of one of our route groups changes.
348 * The parameter is the RouteGroup that has changed.
350 PBD::Signal1<void, RouteGroup *> RouteGroupPropertyChanged;
351 /** Emitted when a route is added to one of our route groups.
352 * First parameter is the RouteGroup, second is the route.
354 PBD::Signal2<void, RouteGroup *, boost::weak_ptr<Route> > RouteAddedToRouteGroup;
355 /** Emitted when a route is removed from one of our route groups.
356 * First parameter is the RouteGroup, second is the route.
358 PBD::Signal2<void, RouteGroup *, boost::weak_ptr<Route> > RouteRemovedFromRouteGroup;
360 /* Step Editing status changed */
361 PBD::Signal1<void,bool> StepEditStatusChange;
363 /* Timecode state signals */
364 PBD::Signal0<void> MtcOrLtcInputPortChanged;
366 void queue_event (SessionEvent*);
368 void request_roll_at_and_return (framepos_t start, framepos_t return_to);
369 void request_bounded_roll (framepos_t start, framepos_t end);
370 void request_stop (bool abort = false, bool clear_state = false);
371 void request_locate (framepos_t frame, bool with_roll = false);
373 void request_play_loop (bool yn, bool leave_rolling = false);
374 bool get_play_loop () const { return play_loop; }
376 framepos_t last_transport_start () const { return _last_roll_location; }
379 void use_rf_shuttle_speed ();
380 void allow_auto_play (bool yn);
381 void request_transport_speed (double speed, bool as_default = false);
382 void request_transport_speed_nonzero (double, bool as_default = false);
383 void request_overwrite_buffer (Track *);
384 void adjust_playback_buffering();
385 void adjust_capture_buffering();
386 void request_track_speed (Track *, double speed);
387 void request_input_change_handling ();
389 bool locate_pending() const { return static_cast<bool>(post_transport_work()&PostTransportLocate); }
390 bool transport_locked () const;
394 framepos_t current_end_frame () const;
395 framepos_t current_start_frame () const;
396 /** "actual" sample rate of session, set by current audioengine rate, pullup/down etc. */
397 framecnt_t frame_rate () const { return _current_frame_rate; }
398 /** "native" sample rate of session, regardless of current audioengine rate, pullup/down etc */
399 framecnt_t nominal_frame_rate () const { return _nominal_frame_rate; }
400 framecnt_t frames_per_hour () const { return _frames_per_hour; }
402 double frames_per_timecode_frame() const { return _frames_per_timecode_frame; }
403 framecnt_t timecode_frames_per_hour() const { return _timecode_frames_per_hour; }
405 MIDI::byte get_mtc_timecode_bits() const {
406 return mtc_timecode_bits; /* encoding of SMTPE type for MTC */
409 double timecode_frames_per_second() const;
410 bool timecode_drop_frames() const;
414 Locations *locations() { return _locations; }
416 PBD::Signal1<void,Location*> auto_loop_location_changed;
417 PBD::Signal1<void,Location*> auto_punch_location_changed;
418 PBD::Signal0<void> locations_modified;
420 void set_auto_punch_location (Location *);
421 void set_auto_loop_location (Location *);
422 void set_session_extents (framepos_t start, framepos_t end);
423 int location_name(std::string& result, std::string base = std::string(""));
425 pframes_t get_block_size() const { return current_block_size; }
426 framecnt_t worst_output_latency () const { return _worst_output_latency; }
427 framecnt_t worst_input_latency () const { return _worst_input_latency; }
428 framecnt_t worst_track_latency () const { return _worst_track_latency; }
429 framecnt_t worst_playback_latency () const { return _worst_output_latency + _worst_track_latency; }
432 std::string new_parent_folder; /* parent folder where new session folder will be created */
433 std::string new_name; /* name of newly saved session */
434 bool switch_to; /* true if we should be working on newly saved session after save-as; false otherwise */
435 bool include_media; /* true if the newly saved session should contain references to media */
436 bool copy_media; /* true if media files (audio, media, etc) should be copied into newly saved session; false otherwise */
437 bool copy_external; /* true if external media should be consolidated into the newly saved session; false otherwise */
439 std::string final_session_folder_name; /* filled in by * Session::save_as(), provides full path to newly saved session */
441 /* emitted as we make progress. 3 arguments passed to signal
444 * 1: percentage complete measured as a fraction (0-1.0) of
445 * total data copying done.
446 * 2: number of files copied so far
447 * 3: total number of files to copy
449 * Handler should return true for save-as to continue, or false
450 * to stop (and remove all evidence of partial save-as).
452 PBD::Signal3<bool,float,int64_t,int64_t> Progress;
454 /* if save_as() returns non-zero, this string will indicate the reason why.
456 std::string failure_message;
459 int save_as (SaveAs&);
460 int save_state (std::string snapshot_name, bool pending = false, bool switch_to_snapshot = false, bool template_only = false);
461 int restore_state (std::string snapshot_name);
462 int save_template (std::string template_name);
463 int save_history (std::string snapshot_name = "");
464 int restore_history (std::string snapshot_name);
465 void remove_state (std::string snapshot_name);
466 void rename_state (std::string old_name, std::string new_name);
467 void remove_pending_capture_state ();
468 int rename (const std::string&);
469 bool get_nsm_state () const { return _under_nsm_control; }
470 void set_nsm_state (bool state) { _under_nsm_control = state; }
471 bool save_default_options ();
473 PBD::Signal1<void,std::string> StateSaved;
474 PBD::Signal0<void> StateReady;
476 /* emitted when session needs to be saved due to some internal
477 * event or condition (i.e. not in response to a user request).
479 * Only one object should
480 * connect to this signal and take responsibility.
482 * Argument is the snapshot name to use when saving.
484 PBD::Signal1<void,std::string> SaveSessionRequested;
486 /* emitted during a session save to allow other entities to add state, via
487 * extra XML, to the session state
489 PBD::Signal0<void> SessionSaveUnderway;
491 std::vector<std::string> possible_states() const;
492 static std::vector<std::string> possible_states (std::string path);
494 XMLNode& get_state();
495 int set_state(const XMLNode& node, int version); // not idempotent
496 XMLNode& get_template();
498 /// The instant xml file is written to the session directory
499 void add_instant_xml (XMLNode&, bool write_to_config = true);
500 XMLNode* instant_xml (const std::string& str);
502 enum StateOfTheState {
507 InitialConnecting = 0x8,
513 StateOfTheState state_of_the_state() const { return _state_of_the_state; }
515 class StateProtector {
517 StateProtector (Session* s) : _session (s) {
518 g_atomic_int_inc (&s->_suspend_save);
521 if (g_atomic_int_dec_and_test (&_session->_suspend_save)) {
522 while (_session->_save_queued) {
523 _session->_save_queued = false;
524 _session->save_state ("");
532 void add_route_group (RouteGroup *);
533 void remove_route_group (RouteGroup&);
534 void reorder_route_groups (std::list<RouteGroup*>);
536 RouteGroup* route_group_by_name (std::string);
537 RouteGroup& all_route_group() const;
539 PBD::Signal1<void,RouteGroup*> route_group_added;
540 PBD::Signal0<void> route_group_removed;
541 PBD::Signal0<void> route_groups_reordered;
543 void foreach_route_group (boost::function<void(RouteGroup*)> f) {
544 for (std::list<RouteGroup *>::iterator i = _route_groups.begin(); i != _route_groups.end(); ++i) {
549 std::list<RouteGroup*> const & route_groups () const {
550 return _route_groups;
553 /* fundamental operations. duh. */
555 std::list<boost::shared_ptr<AudioTrack> > new_audio_track (
558 TrackMode mode = Normal,
559 RouteGroup* route_group = 0,
560 uint32_t how_many = 1,
561 std::string name_template = ""
564 RouteList new_audio_route (
565 int input_channels, int output_channels, RouteGroup* route_group, uint32_t how_many, std::string name_template = ""
568 std::list<boost::shared_ptr<MidiTrack> > new_midi_track (
569 const ChanCount& input, const ChanCount& output,
570 boost::shared_ptr<PluginInfo> instrument = boost::shared_ptr<PluginInfo>(),
571 TrackMode mode = Normal,
572 RouteGroup* route_group = 0, uint32_t how_many = 1, std::string name_template = ""
575 void remove_routes (boost::shared_ptr<RouteList>);
576 void remove_route (boost::shared_ptr<Route>);
578 void resort_routes ();
579 void resort_routes_using (boost::shared_ptr<RouteList>);
581 AudioEngine & engine() { return _engine; }
582 AudioEngine const & engine () const { return _engine; }
584 static std::string default_track_name_pattern (DataType);
588 framepos_t transport_frame () const {return _transport_frame; }
589 framepos_t record_location () const {return _last_record_location; }
590 framepos_t audible_frame () const;
591 framepos_t requested_return_frame() const { return _requested_return_frame; }
592 void set_requested_return_frame(framepos_t return_to);
606 void sync_time_vars();
608 void bbt_time (framepos_t when, Timecode::BBT_Time&);
609 void timecode_to_sample(Timecode::Time& timecode, framepos_t& sample, bool use_offset, bool use_subframes) const;
610 void sample_to_timecode(framepos_t sample, Timecode::Time& timecode, bool use_offset, bool use_subframes) const;
611 void timecode_time (Timecode::Time &);
612 void timecode_time (framepos_t when, Timecode::Time&);
613 void timecode_time_subframes (framepos_t when, Timecode::Time&);
615 void timecode_duration (framecnt_t, Timecode::Time&) const;
616 void timecode_duration_string (char *, size_t len, framecnt_t) const;
618 framecnt_t convert_to_frames (AnyTime const & position);
619 framecnt_t any_duration_to_frames (framepos_t position, AnyTime const & duration);
621 static PBD::Signal1<void, framepos_t> StartTimeChanged;
622 static PBD::Signal1<void, framepos_t> EndTimeChanged;
624 void request_sync_source (Slave*);
625 bool synced_to_engine() const { return _slave && config.get_external_sync() && Config->get_sync_source() == Engine; }
626 bool synced_to_mtc () const { return config.get_external_sync() && Config->get_sync_source() == MTC && g_atomic_int_get (const_cast<gint*>(&_mtc_active)); }
627 bool synced_to_ltc () const { return config.get_external_sync() && Config->get_sync_source() == LTC && g_atomic_int_get (const_cast<gint*>(&_ltc_active)); }
629 double transport_speed() const { return _transport_speed; }
630 bool transport_stopped() const { return _transport_speed == 0.0f; }
631 bool transport_rolling() const { return _transport_speed != 0.0f; }
633 bool silent () { return _silent; }
635 TempoMap& tempo_map() { return *_tempo_map; }
636 const TempoMap& tempo_map() const { return *_tempo_map; }
638 unsigned int get_xrun_count () const {return _xrun_count; }
639 void reset_xrun_count () {_xrun_count = 0; }
643 boost::shared_ptr<Region> find_whole_file_parent (boost::shared_ptr<Region const>) const;
645 boost::shared_ptr<Region> XMLRegionFactory (const XMLNode&, bool full);
646 boost::shared_ptr<AudioRegion> XMLAudioRegionFactory (const XMLNode&, bool full);
647 boost::shared_ptr<MidiRegion> XMLMidiRegionFactory (const XMLNode&, bool full);
649 /* source management */
651 void import_files (ImportStatus&);
652 bool sample_rate_convert (ImportStatus&, std::string infile, std::string& outfile);
653 std::string build_tmp_convert_name (std::string file);
655 boost::shared_ptr<ExportHandler> get_export_handler ();
656 boost::shared_ptr<ExportStatus> get_export_status ();
658 int start_audio_export (framepos_t position);
660 PBD::Signal1<int, framecnt_t> ProcessExport;
661 static PBD::Signal2<void,std::string, std::string> Exported;
663 void add_source (boost::shared_ptr<Source>);
664 void remove_source (boost::weak_ptr<Source>);
666 void cleanup_regions();
667 bool can_cleanup_peakfiles () const;
668 int cleanup_peakfiles ();
669 int cleanup_sources (CleanupReport&);
670 int cleanup_trash_sources (CleanupReport&);
672 int destroy_sources (std::list<boost::shared_ptr<Source> >);
674 int remove_last_capture ();
676 /** handlers should return 0 for "everything OK", and any other value for
677 * "cannot setup audioengine".
679 static PBD::Signal1<int,uint32_t> AudioEngineSetupRequired;
681 /** handlers should return -1 for "stop cleanup",
682 0 for "yes, delete this playlist",
683 1 for "no, don't delete this playlist".
685 static PBD::Signal1<int,boost::shared_ptr<Playlist> > AskAboutPlaylistDeletion;
687 /** handlers should return 0 for "ignore the rate mismatch",
688 !0 for "do not use this session"
690 static PBD::Signal2<int, framecnt_t, framecnt_t> AskAboutSampleRateMismatch;
692 /** handlers should return !0 for use pending state, 0 for ignore it.
694 static PBD::Signal0<int> AskAboutPendingState;
696 boost::shared_ptr<AudioFileSource> create_audio_source_for_session (
697 size_t, std::string const &, uint32_t, bool destructive);
699 boost::shared_ptr<MidiSource> create_midi_source_for_session (std::string const &);
700 boost::shared_ptr<MidiSource> create_midi_source_by_stealing_name (boost::shared_ptr<Track>);
702 boost::shared_ptr<Source> source_by_id (const PBD::ID&);
703 boost::shared_ptr<AudioFileSource> audio_source_by_path_and_channel (const std::string&, uint16_t) const;
704 boost::shared_ptr<MidiSource> midi_source_by_path (const std::string&) const;
705 uint32_t count_sources_by_origin (const std::string&);
707 void add_playlist (boost::shared_ptr<Playlist>, bool unused = false);
709 /* Curves and AutomationLists (TODO when they go away) */
710 void add_automation_list(AutomationList*);
714 boost::shared_ptr<Auditioner> the_auditioner() { return auditioner; }
715 void audition_playlist ();
716 void audition_region (boost::shared_ptr<Region>);
717 void cancel_audition ();
718 bool is_auditioning () const;
720 PBD::Signal1<void,bool> AuditionActive;
722 /* flattening stuff */
724 boost::shared_ptr<Region> write_one_track (Track&, framepos_t start, framepos_t end,
725 bool overwrite, std::vector<boost::shared_ptr<Source> >&, InterThreadInfo& wot,
726 boost::shared_ptr<Processor> endpoint,
727 bool include_endpoint, bool for_export, bool for_freeze);
728 int freeze_all (InterThreadInfo&);
730 /* session-wide solo/mute/rec-enable */
732 bool soloing() const { return _non_soloed_outs_muted; }
733 bool listening() const { return _listen_cnt > 0; }
734 bool solo_isolated() const { return _solo_isolated_cnt > 0; }
736 static const SessionEvent::RTeventCallback rt_cleanup;
738 void set_solo (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
739 void set_just_one_solo (boost::shared_ptr<Route>, bool, SessionEvent::RTeventCallback after = rt_cleanup);
740 void set_mute (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
741 void set_listen (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
742 void set_record_enabled (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
743 void set_record_safe (boost::shared_ptr<RouteList>, bool yn, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
744 void set_solo_isolated (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
745 void set_monitoring (boost::shared_ptr<RouteList>, MonitorChoice, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
746 void set_exclusive_input_active (boost::shared_ptr<RouteList> rt, bool onoff, bool flip_others=false);
748 PBD::Signal1<void,bool> SoloActive;
749 PBD::Signal0<void> SoloChanged;
750 PBD::Signal0<void> IsolatedChanged;
752 PBD::Signal0<void> session_routes_reconnected;
754 /* monitor/master out */
756 void add_monitor_section ();
757 void reset_monitor_section ();
758 void remove_monitor_section ();
760 boost::shared_ptr<Route> monitor_out() const { return _monitor_out; }
761 boost::shared_ptr<Route> master_out() const { return _master_out; }
763 void globally_add_internal_sends (boost::shared_ptr<Route> dest, Placement p, bool);
764 void globally_set_send_gains_from_track (boost::shared_ptr<Route> dest);
765 void globally_set_send_gains_to_zero (boost::shared_ptr<Route> dest);
766 void globally_set_send_gains_to_unity (boost::shared_ptr<Route> dest);
767 void add_internal_sends (boost::shared_ptr<Route> dest, Placement p, boost::shared_ptr<RouteList> senders);
768 void add_internal_send (boost::shared_ptr<Route>, int, boost::shared_ptr<Route>);
769 void add_internal_send (boost::shared_ptr<Route>, boost::shared_ptr<Processor>, boost::shared_ptr<Route>);
771 static void set_disable_all_loaded_plugins (bool yn) {
772 _disable_all_loaded_plugins = yn;
774 static bool get_disable_all_loaded_plugins() {
775 return _disable_all_loaded_plugins;
777 static void set_bypass_all_loaded_plugins (bool yn) {
778 _bypass_all_loaded_plugins = yn;
780 static bool get_bypass_all_loaded_plugins() {
781 return _bypass_all_loaded_plugins;
784 uint32_t next_send_id();
785 uint32_t next_aux_send_id();
786 uint32_t next_return_id();
787 uint32_t next_insert_id();
788 void mark_send_id (uint32_t);
789 void mark_aux_send_id (uint32_t);
790 void mark_return_id (uint32_t);
791 void mark_insert_id (uint32_t);
792 void unmark_send_id (uint32_t);
793 void unmark_aux_send_id (uint32_t);
794 void unmark_return_id (uint32_t);
795 void unmark_insert_id (uint32_t);
797 /* s/w "RAID" management */
799 boost::optional<framecnt_t> available_capture_duration();
803 void add_bundle (boost::shared_ptr<Bundle>, bool emit_signal = true);
804 void remove_bundle (boost::shared_ptr<Bundle>);
805 boost::shared_ptr<Bundle> bundle_by_name (std::string) const;
807 PBD::Signal0<void> BundleAddedOrRemoved;
811 /* History (for editors, mixers, UIs etc.) */
813 /** Undo some transactions.
814 * @param n Number of transactions to undo.
816 void undo (uint32_t n) {
820 void redo (uint32_t n) {
824 UndoHistory& history() { return _history; }
826 uint32_t undo_depth() const { return _history.undo_depth(); }
827 uint32_t redo_depth() const { return _history.redo_depth(); }
828 std::string next_undo() const { return _history.next_undo(); }
829 std::string next_redo() const { return _history.next_redo(); }
831 void begin_reversible_command (const std::string& cmd_name);
832 void begin_reversible_command (GQuark);
833 void abort_reversible_command ();
834 void commit_reversible_command (Command* cmd = 0);
836 void add_command (Command *const cmd);
838 /** @return The list of operations that are currently in progress */
839 std::list<GQuark> const & current_operations () {
840 return _current_trans_quarks;
843 bool operation_in_progress (GQuark) const;
845 void add_commands (std::vector<Command*> const & cmds);
847 std::map<PBD::ID,PBD::StatefulDestructible*> registry;
849 // these commands are implemented in libs/ardour/session_command.cc
850 Command* memento_command_factory(XMLNode* n);
851 Command* stateful_diff_command_factory (XMLNode *);
852 void register_with_memento_command_factory(PBD::ID, PBD::StatefulDestructible*);
856 boost::shared_ptr<IO> click_io() { return _click_io; }
857 boost::shared_ptr<Amp> click_gain() { return _click_gain; }
859 /* disk, buffer loads */
861 uint32_t playback_load ();
862 uint32_t capture_load ();
866 void request_play_range (std::list<AudioRange>*, bool leave_rolling = false);
867 void request_cancel_play_range ();
868 bool get_play_range () const { return _play_range; }
870 void maybe_update_session_range (framepos_t, framepos_t);
872 /* temporary hacks to allow selection to be pushed from GUI into backend.
873 Whenever we move the selection object into libardour, these will go away.
875 void set_range_selection (framepos_t start, framepos_t end);
876 void set_object_selection (framepos_t start, framepos_t end);
877 void clear_range_selection ();
878 void clear_object_selection ();
880 /* buffers for gain and pan */
882 gain_t* gain_automation_buffer () const;
883 gain_t* trim_automation_buffer () const;
884 gain_t* send_gain_automation_buffer () const;
885 pan_t** pan_automation_buffer () const;
887 void ensure_buffer_set (BufferSet& buffers, const ChanCount& howmany);
891 static int vst_current_loading_id;
892 static const char* vst_can_do_strings[];
893 static const int vst_can_do_string_count;
895 static intptr_t vst_callback (
904 static PBD::Signal0<void> SendFeedback;
908 boost::shared_ptr<Speakers> get_speakers ();
912 boost::shared_ptr<PBD::Controllable> controllable_by_id (const PBD::ID&);
913 boost::shared_ptr<PBD::Controllable> controllable_by_descriptor (const PBD::ControllableDescriptor&);
915 void add_controllable (boost::shared_ptr<PBD::Controllable>);
916 void remove_controllable (PBD::Controllable*);
918 boost::shared_ptr<PBD::Controllable> solo_cut_control() const;
920 SessionConfiguration config;
922 bool exporting () const {
926 bool bounce_processing() const {
927 return _bounce_processing_active;
930 /* this is a private enum, but setup_enum_writer() needs it,
931 and i can't find a way to give that function
935 enum PostTransportWork {
936 PostTransportStop = 0x1,
937 PostTransportDuration = 0x2,
938 PostTransportLocate = 0x4,
939 PostTransportRoll = 0x8,
940 PostTransportAbort = 0x10,
941 PostTransportOverWrite = 0x20,
942 PostTransportSpeed = 0x40,
943 PostTransportAudition = 0x80,
944 PostTransportReverse = 0x100,
945 PostTransportInputChange = 0x200,
946 PostTransportCurveRealloc = 0x400,
947 PostTransportClearSubstate = 0x800,
948 PostTransportAdjustPlaybackBuffering = 0x1000,
949 PostTransportAdjustCaptureBuffering = 0x2000
958 SlaveState slave_state() const { return _slave_state; }
959 Slave* slave() const { return _slave; }
961 boost::shared_ptr<SessionPlaylists> playlists;
963 void send_mmc_locate (framepos_t);
964 void queue_full_time_code () { _send_timecode_update = true; }
965 void queue_song_position_pointer () { /* currently does nothing */ }
967 bool step_editing() const { return (_step_editors > 0); }
969 void request_suspend_timecode_transmission ();
970 void request_resume_timecode_transmission ();
971 bool timecode_transmission_suspended () const;
973 std::vector<std::string> source_search_path(DataType) const;
974 void ensure_search_path_includes (const std::string& path, DataType type);
975 void remove_dir_from_search_path (const std::string& path, DataType type);
977 std::list<std::string> unknown_processors () const;
979 /** Emitted when a feedback cycle has been detected within Ardour's signal
980 processing path. Until it is fixed (by the user) some (unspecified)
981 routes will not be run.
983 static PBD::Signal0<void> FeedbackDetected;
985 /** Emitted when a graph sort has successfully completed, which means
986 that it has no feedback cycles.
988 static PBD::Signal0<void> SuccessfulGraphSort;
990 /* handlers can return an integer value:
991 0: config.set_audio_search_path() or config.set_midi_search_path() was used
992 to modify the search path and we should try to find it again.
993 1: quit entire session load
994 2: as 0, but don't ask about other missing files
995 3: don't ask about other missing files, and just mark this one missing
996 -1: just mark this one missing
997 any other value: as -1
999 static PBD::Signal3<int,Session*,std::string,DataType> MissingFile;
1001 /** Emitted when the session wants Ardour to quit */
1002 static PBD::Signal0<void> Quit;
1004 /** Emitted when Ardour is asked to load a session in an older session
1005 * format, and makes a backup copy.
1007 static PBD::Signal2<void,std::string,std::string> VersionMismatch;
1009 SceneChanger* scene_changer() const { return _scene_changer; }
1011 boost::shared_ptr<Port> ltc_input_port() const;
1012 boost::shared_ptr<Port> ltc_output_port() const;
1014 boost::shared_ptr<IO> ltc_input_io() { return _ltc_input; }
1015 boost::shared_ptr<IO> ltc_output_io() { return _ltc_output; }
1017 MIDI::Port* midi_input_port () const;
1018 MIDI::Port* midi_output_port () const;
1019 MIDI::Port* mmc_output_port () const;
1020 MIDI::Port* mmc_input_port () const;
1022 MIDI::Port* scene_input_port () const;
1023 MIDI::Port* scene_output_port () const;
1025 boost::shared_ptr<MidiPort> scene_in () const;
1026 boost::shared_ptr<MidiPort> scene_out () const;
1028 boost::shared_ptr<MidiPort> midi_clock_output_port () const;
1029 boost::shared_ptr<MidiPort> midi_clock_input_port () const;
1030 boost::shared_ptr<MidiPort> mtc_output_port () const;
1031 boost::shared_ptr<MidiPort> mtc_input_port () const;
1033 MIDI::MachineControl& mmc() { return *_mmc; }
1035 void reconnect_midi_scene_ports (bool);
1036 void reconnect_mtc_ports ();
1037 void reconnect_mmc_ports (bool);
1039 void reconnect_ltc_input ();
1040 void reconnect_ltc_output ();
1043 friend class AudioEngine;
1044 void set_block_size (pframes_t nframes);
1045 void set_frame_rate (framecnt_t nframes);
1046 void reconnect_existing_routes (bool withLock, bool reconnect_master = true, bool reconnect_inputs = true, bool reconnect_outputs = true);
1050 void schedule_curve_reallocation ();
1051 void update_latency_compensation (bool force = false);
1054 int create (const std::string& mix_template, BusProfile*);
1058 PendingDeclickIn = 0x1, ///< pending de-click fade-in for start
1059 PendingDeclickOut = 0x2, ///< pending de-click fade-out for stop
1060 StopPendingCapture = 0x4,
1061 PendingLoopDeclickIn = 0x8, ///< pending de-click fade-in at the start of a loop
1062 PendingLoopDeclickOut = 0x10, ///< pending de-click fade-out at the end of a loop
1063 PendingLocate = 0x20,
1066 /* stuff used in process() should be close together to
1070 typedef void (Session::*process_function_type)(pframes_t);
1072 AudioEngine& _engine;
1073 mutable gint processing_prohibited;
1074 process_function_type process_function;
1075 process_function_type last_process_function;
1076 bool _bounce_processing_active;
1077 bool waiting_for_sync_offset;
1078 framecnt_t _base_frame_rate;
1079 framecnt_t _current_frame_rate; //this includes video pullup offset
1080 framecnt_t _nominal_frame_rate; //ignores audioengine setting, "native" SR
1081 int transport_sub_state;
1082 mutable gint _record_status;
1083 framepos_t _transport_frame;
1084 Location* _session_range_location; ///< session range, or 0 if there is nothing in the session yet
1088 // varispeed playback
1089 double _transport_speed;
1090 double _default_transport_speed;
1091 double _last_transport_speed;
1092 double _signalled_varispeed;
1093 double _target_transport_speed;
1094 CubicInterpolation interpolation;
1096 bool auto_play_legal;
1097 framepos_t _last_slave_transport_frame;
1098 framecnt_t maximum_output_latency;
1099 framepos_t _requested_return_frame;
1100 pframes_t current_block_size;
1101 framecnt_t _worst_output_latency;
1102 framecnt_t _worst_input_latency;
1103 framecnt_t _worst_track_latency;
1104 bool _have_captured;
1105 bool _non_soloed_outs_muted;
1106 uint32_t _listen_cnt;
1107 uint32_t _solo_isolated_cnt;
1110 bool _under_nsm_control;
1111 unsigned int _xrun_count;
1113 void mtc_status_changed (bool);
1114 PBD::ScopedConnection mtc_status_connection;
1115 void ltc_status_changed (bool);
1116 PBD::ScopedConnection ltc_status_connection;
1118 void initialize_latencies ();
1119 void set_worst_io_latencies ();
1120 void set_worst_playback_latency ();
1121 void set_worst_capture_latency ();
1122 void set_worst_io_latencies_x (IOChange, void *) {
1123 set_worst_io_latencies ();
1125 void post_capture_latency ();
1126 void post_playback_latency ();
1128 void update_latency_compensation_proxy (void* ignored);
1130 void ensure_buffers (ChanCount howmany = ChanCount::ZERO);
1132 void process_scrub (pframes_t);
1133 void process_without_events (pframes_t);
1134 void process_with_events (pframes_t);
1135 void process_audition (pframes_t);
1136 int process_export (pframes_t);
1137 int process_export_fw (pframes_t);
1139 void block_processing() { g_atomic_int_set (&processing_prohibited, 1); }
1140 void unblock_processing() { g_atomic_int_set (&processing_prohibited, 0); }
1141 bool processing_blocked() const { return g_atomic_int_get (&processing_prohibited); }
1143 static const framecnt_t bounce_chunk_size;
1145 /* slave tracking */
1147 static const int delta_accumulator_size = 25;
1148 int delta_accumulator_cnt;
1149 int32_t delta_accumulator[delta_accumulator_size];
1150 int32_t average_slave_delta;
1152 bool have_first_delta_accumulator;
1154 SlaveState _slave_state;
1157 framepos_t slave_wait_end;
1159 void reset_slave_state ();
1160 bool follow_slave (pframes_t);
1161 void calculate_moving_average_of_slave_delta (int dir, framecnt_t this_delta);
1162 void track_slave_state (float slave_speed, framepos_t slave_transport_frame, framecnt_t this_delta);
1163 void follow_slave_silently (pframes_t nframes, float slave_speed);
1165 void switch_to_sync_source (SyncSource); /* !RT context */
1166 void drop_sync_source (); /* !RT context */
1167 void use_sync_source (Slave*); /* RT context */
1169 bool post_export_sync;
1170 framepos_t post_export_position;
1173 bool _export_started;
1174 bool _export_rolling;
1176 boost::shared_ptr<ExportHandler> export_handler;
1177 boost::shared_ptr<ExportStatus> export_status;
1180 int stop_audio_export ();
1181 void finalize_audio_export ();
1182 void finalize_export_internal (bool stop_freewheel);
1183 bool _pre_export_mmc_enabled;
1185 PBD::ScopedConnection export_freewheel_connection;
1187 void get_track_statistics ();
1188 int process_routes (pframes_t, bool& need_butler);
1189 int silent_process_routes (pframes_t, bool& need_butler);
1191 /** @return 1 if there is a pending declick fade-in,
1192 -1 if there is a pending declick fade-out,
1193 0 if there is no pending declick.
1195 int get_transport_declick_required () {
1196 if (transport_sub_state & PendingDeclickIn) {
1197 transport_sub_state &= ~PendingDeclickIn;
1199 } else if (transport_sub_state & PendingDeclickOut) {
1200 /* XXX: not entirely sure why we don't clear this */
1202 } else if (transport_sub_state & PendingLoopDeclickOut) {
1203 /* Return the declick out first ... */
1204 transport_sub_state &= ~PendingLoopDeclickOut;
1206 } else if (transport_sub_state & PendingLoopDeclickIn) {
1207 /* ... then the declick in on the next call */
1208 transport_sub_state &= ~PendingLoopDeclickIn;
1215 bool maybe_stop (framepos_t limit);
1216 bool maybe_sync_start (pframes_t &);
1218 void check_declick_out ();
1224 /** Number of process frames since the last MTC output (when sending MTC); used to
1225 * know when to send full MTC messages every so often.
1227 pframes_t _pframes_since_last_mtc;
1228 bool session_midi_feedback;
1231 framepos_t last_loopend;
1233 boost::scoped_ptr<SessionDirectory> _session_dir;
1236 void graph_reordered ();
1238 /** current snapshot name, without the .ardour suffix */
1239 std::string _current_snapshot_name;
1241 XMLTree* state_tree;
1242 bool state_was_pending;
1243 StateOfTheState _state_of_the_state;
1245 friend class StateProtector;
1246 gint _suspend_save; /* atomic */
1247 volatile bool _save_queued;
1248 Glib::Threads::Mutex save_state_lock;
1249 Glib::Threads::Mutex peak_cleanup_lock;
1251 int load_options (const XMLNode&);
1252 int load_state (std::string snapshot_name);
1254 framepos_t _last_roll_location;
1255 /** the session frame time at which we last rolled, located, or changed transport direction */
1256 framepos_t _last_roll_or_reversal_location;
1257 framepos_t _last_record_location;
1259 bool pending_locate_roll;
1260 framepos_t pending_locate_frame;
1261 bool pending_locate_flush;
1263 bool pending_auto_loop;
1267 static const PostTransportWork ProcessCannotProceedMask =
1269 PostTransportInputChange|
1271 PostTransportReverse|
1272 PostTransportCurveRealloc|
1273 PostTransportAudition|
1274 PostTransportLocate|
1276 PostTransportClearSubstate);
1278 gint _post_transport_work; /* accessed only atomic ops */
1279 PostTransportWork post_transport_work() const { return (PostTransportWork) g_atomic_int_get (const_cast<gint*>(&_post_transport_work)); }
1280 void set_post_transport_work (PostTransportWork ptw) { g_atomic_int_set (&_post_transport_work, (gint) ptw); }
1281 void add_post_transport_work (PostTransportWork ptw);
1283 void schedule_playback_buffering_adjustment ();
1284 void schedule_capture_buffering_adjustment ();
1286 uint32_t cumulative_rf_motion;
1289 void set_rf_speed (float speed);
1290 void reset_rf_scale (framecnt_t frames_moved);
1292 Locations* _locations;
1293 void location_added (Location*);
1294 void location_removed (Location*);
1295 void locations_changed ();
1296 void _locations_changed (const Locations::LocationList&);
1298 void update_skips (Location*, bool consolidate);
1299 void update_marks (Location* loc);
1300 void consolidate_skips (Location*);
1301 void sync_locations_to_skips ();
1302 void _sync_locations_to_skips ();
1304 PBD::ScopedConnectionList skip_update_connections;
1305 bool _ignore_skips_updates;
1307 PBD::ScopedConnectionList punch_connections;
1308 void auto_punch_start_changed (Location *);
1309 void auto_punch_end_changed (Location *);
1310 void auto_punch_changed (Location *);
1312 PBD::ScopedConnectionList loop_connections;
1313 void auto_loop_changed (Location *);
1314 void auto_loop_declick_range (Location *, framepos_t &, framepos_t &);
1316 int ensure_engine (uint32_t desired_sample_rate);
1317 void pre_engine_init (std::string path);
1318 int post_engine_init ();
1319 int immediately_post_engine ();
1320 void remove_empty_sounds ();
1322 void session_loaded ();
1324 void setup_midi_control ();
1325 int midi_read (MIDI::Port *);
1327 void enable_record ();
1329 void increment_transport_position (framecnt_t val) {
1330 if (max_framepos - val < _transport_frame) {
1331 _transport_frame = max_framepos;
1333 _transport_frame += val;
1337 void decrement_transport_position (framecnt_t val) {
1338 if (val < _transport_frame) {
1339 _transport_frame -= val;
1341 _transport_frame = 0;
1345 void post_transport_motion ();
1346 static void *session_loader_thread (void *arg);
1350 /* Signal Forwarding */
1351 void emit_route_signals ();
1352 void emit_thread_run ();
1353 static void *emit_thread (void *);
1354 void emit_thread_start ();
1355 void emit_thread_terminate ();
1357 pthread_t _rt_emit_thread;
1358 bool _rt_thread_active;
1360 pthread_mutex_t _rt_emit_mutex;
1361 pthread_cond_t _rt_emit_cond;
1362 bool _rt_emit_pending;
1365 /* SessionEventManager interface */
1367 void process_event (SessionEvent*);
1368 void set_next_event ();
1369 void cleanup_event (SessionEvent*,int);
1371 /* MIDI Machine Control */
1374 void spp_continue ();
1377 void mmc_deferred_play (MIDI::MachineControl &);
1378 void mmc_stop (MIDI::MachineControl &);
1379 void mmc_step (MIDI::MachineControl &, int);
1380 void mmc_pause (MIDI::MachineControl &);
1381 void mmc_record_pause (MIDI::MachineControl &);
1382 void mmc_record_strobe (MIDI::MachineControl &);
1383 void mmc_record_exit (MIDI::MachineControl &);
1384 void mmc_track_record_status (MIDI::MachineControl &, uint32_t track, bool enabled);
1385 void mmc_fast_forward (MIDI::MachineControl &);
1386 void mmc_rewind (MIDI::MachineControl &);
1387 void mmc_locate (MIDI::MachineControl &, const MIDI::byte *);
1388 void mmc_shuttle (MIDI::MachineControl &mmc, float speed, bool forw);
1389 void mmc_record_enable (MIDI::MachineControl &mmc, size_t track, bool enabled);
1391 struct timeval last_mmc_step;
1394 typedef boost::function<bool()> MidiTimeoutCallback;
1395 typedef std::list<MidiTimeoutCallback> MidiTimeoutList;
1397 MidiTimeoutList midi_timeouts;
1398 bool mmc_step_timeout ();
1399 void send_immediate_mmc (MIDI::MachineControlCommand);
1401 MIDI::byte mtc_msg[16];
1402 MIDI::byte mtc_timecode_bits; /* encoding of SMTPE type for MTC */
1403 MIDI::byte midi_msg[16];
1404 double outbound_mtc_timecode_frame;
1405 Timecode::Time transmitting_timecode_time;
1406 int next_quarter_frame_to_send;
1408 double _frames_per_timecode_frame; /* has to be floating point because of drop frame */
1409 framecnt_t _frames_per_hour;
1410 framecnt_t _timecode_frames_per_hour;
1412 /* cache the most-recently requested time conversions. This helps when we
1413 * have multiple clocks showing the same time (e.g. the transport frame) */
1414 bool last_timecode_valid;
1415 framepos_t last_timecode_when;
1416 Timecode::Time last_timecode;
1418 bool _send_timecode_update; ///< Flag to send a full frame (Timecode) MTC message this cycle
1420 int send_midi_time_code_for_cycle (framepos_t, framepos_t, pframes_t nframes);
1422 LTCEncoder* ltc_encoder;
1423 ltcsnd_sample_t* ltc_enc_buf;
1425 Timecode::TimecodeFormat ltc_enc_tcformat;
1426 int32_t ltc_buf_off;
1427 int32_t ltc_buf_len;
1430 int32_t ltc_enc_byte;
1431 framepos_t ltc_enc_pos;
1433 framepos_t ltc_enc_off;
1435 framepos_t ltc_prev_cycle;
1437 framepos_t ltc_timecode_offset;
1438 bool ltc_timecode_negative_offset;
1440 LatencyRange ltc_out_latency;
1442 void ltc_tx_initialize();
1443 void ltc_tx_cleanup();
1444 void ltc_tx_reset();
1445 void ltc_tx_resync_latency();
1446 void ltc_tx_recalculate_position();
1447 void ltc_tx_parse_offset();
1448 void ltc_tx_send_time_code_for_cycle (framepos_t, framepos_t, double, double, pframes_t nframes);
1450 void reset_record_status ();
1452 int no_roll (pframes_t nframes);
1453 int fail_roll (pframes_t nframes);
1455 bool non_realtime_work_pending() const { return static_cast<bool>(post_transport_work()); }
1456 bool process_can_proceed() const { return !(post_transport_work() & ProcessCannotProceedMask); }
1458 MidiControlUI* midi_control_ui;
1460 int start_midi_thread ();
1462 void set_play_loop (bool yn, double speed);
1463 void unset_play_loop ();
1464 void overwrite_some_buffers (Track *);
1465 void flush_all_inserts ();
1466 int micro_locate (framecnt_t distance);
1467 void locate (framepos_t, bool with_roll, bool with_flush, bool with_loop=false, bool force=false, bool with_mmc=true);
1468 void start_locate (framepos_t, bool with_roll, bool with_flush, bool for_loop_enabled=false, bool force=false);
1469 void force_locate (framepos_t frame, bool with_roll = false);
1470 void set_track_speed (Track *, double speed);
1471 void set_transport_speed (double speed, framepos_t destination_frame, bool abort = false, bool clear_state = false, bool as_default = false);
1472 void stop_transport (bool abort = false, bool clear_state = false);
1473 void start_transport ();
1474 void realtime_stop (bool abort, bool clear_state);
1475 void realtime_locate ();
1476 void non_realtime_start_scrub ();
1477 void non_realtime_set_speed ();
1478 void non_realtime_locate ();
1479 void non_realtime_stop (bool abort, int entry_request_count, bool& finished);
1480 void non_realtime_overwrite (int entry_request_count, bool& finished);
1481 void post_transport ();
1482 void engine_halted ();
1483 void xrun_recovery ();
1484 void set_track_loop (bool);
1485 bool select_playhead_priority_target (framepos_t&);
1486 void follow_playhead_priority ();
1488 /* These are synchronous and so can only be called from within the process
1492 int send_full_time_code (framepos_t, pframes_t nframes);
1493 void send_song_position_pointer (framepos_t);
1495 TempoMap *_tempo_map;
1496 void tempo_map_changed (const PBD::PropertyChange&);
1498 /* edit/mix groups */
1500 int load_route_groups (const XMLNode&, int);
1502 std::list<RouteGroup *> _route_groups;
1503 RouteGroup* _all_route_group;
1507 boost::shared_ptr<Graph> _process_graph;
1509 SerializedRCUManager<RouteList> routes;
1511 void add_routes (RouteList&, bool input_auto_connect, bool output_auto_connect, bool save);
1512 void add_routes_inner (RouteList&, bool input_auto_connect, bool output_auto_connect);
1513 bool _adding_routes_in_progress;
1514 bool _reconnecting_routes_in_progress;
1515 bool _route_deletion_in_progress;
1517 uint32_t destructive_index;
1519 boost::shared_ptr<Route> XMLRouteFactory (const XMLNode&, int);
1520 boost::shared_ptr<Route> XMLRouteFactory_2X (const XMLNode&, int);
1522 void route_processors_changed (RouteProcessorChange);
1524 bool find_route_name (std::string const &, uint32_t& id, std::string& name, bool);
1525 void count_existing_track_channels (ChanCount& in, ChanCount& out);
1526 void auto_connect_route (boost::shared_ptr<Route> route, ChanCount& existing_inputs, ChanCount& existing_outputs,
1527 bool with_lock, bool connect_inputs = true,
1528 ChanCount input_start = ChanCount (), ChanCount output_start = ChanCount ());
1529 void midi_output_change_handler (IOChange change, void* /*src*/, boost::weak_ptr<Route> midi_track);
1531 /* track numbering */
1533 void reassign_track_numbers ();
1534 uint32_t _track_number_decimals;
1538 void route_listen_changed (void *src, boost::weak_ptr<Route>);
1539 void route_mute_changed (void *src);
1540 void route_solo_changed (bool self_solo_change, void *src, boost::weak_ptr<Route>);
1541 void route_solo_isolated_changed (void *src, boost::weak_ptr<Route>);
1542 void update_route_solo_state (boost::shared_ptr<RouteList> r = boost::shared_ptr<RouteList>());
1544 void listen_position_changed ();
1545 void solo_control_mode_changed ();
1547 /* REGION MANAGEMENT */
1549 mutable Glib::Threads::Mutex region_lock;
1551 int load_regions (const XMLNode& node);
1552 int load_compounds (const XMLNode& node);
1554 void route_added_to_route_group (RouteGroup *, boost::weak_ptr<Route>);
1555 void route_removed_from_route_group (RouteGroup *, boost::weak_ptr<Route>);
1556 void route_group_property_changed (RouteGroup *);
1560 mutable Glib::Threads::Mutex source_lock;
1563 typedef std::map<PBD::ID,boost::shared_ptr<Source> > SourceMap;
1566 void reset_write_sources (bool mark_write_complete, bool force = false);
1571 int load_sources (const XMLNode& node);
1572 XMLNode& get_sources_as_xml ();
1574 boost::shared_ptr<Source> XMLSourceFactory (const XMLNode&);
1578 void remove_playlist (boost::weak_ptr<Playlist>);
1579 void track_playlist_changed (boost::weak_ptr<Track>);
1580 void playlist_region_added (boost::weak_ptr<Region>);
1581 void playlist_ranges_moved (std::list<Evoral::RangeMove<framepos_t> > const &);
1582 void playlist_regions_extended (std::list<Evoral::Range<framepos_t> > const &);
1584 /* CURVES and AUTOMATION LISTS */
1585 std::map<PBD::ID, AutomationList*> automation_lists;
1587 /* DEFAULT FADE CURVES */
1589 float default_fade_steepness;
1590 float default_fade_msecs;
1594 boost::shared_ptr<Auditioner> auditioner;
1595 void set_audition (boost::shared_ptr<Region>);
1596 void non_realtime_set_audition ();
1597 boost::shared_ptr<Region> pending_audition_region;
1603 int flatten_one_track (AudioTrack&, framepos_t start, framecnt_t cnt);
1605 /* INSERT AND SEND MANAGEMENT */
1607 boost::dynamic_bitset<uint32_t> send_bitset;
1608 boost::dynamic_bitset<uint32_t> aux_send_bitset;
1609 boost::dynamic_bitset<uint32_t> return_bitset;
1610 boost::dynamic_bitset<uint32_t> insert_bitset;
1614 struct space_and_path {
1615 uint32_t blocks; ///< 4kB blocks
1616 bool blocks_unknown; ///< true if blocks is unknown
1621 , blocks_unknown (true)
1625 struct space_and_path_ascending_cmp {
1626 bool operator() (space_and_path a, space_and_path b) {
1627 if (a.blocks_unknown != b.blocks_unknown) {
1628 return !a.blocks_unknown;
1630 return a.blocks > b.blocks;
1634 void setup_raid_path (std::string path);
1636 std::vector<space_and_path> session_dirs;
1637 std::vector<space_and_path>::iterator last_rr_session_dir;
1638 uint32_t _total_free_4k_blocks;
1639 /** If this is true, _total_free_4k_blocks is not definite,
1640 as one or more of the session directories' filesystems
1641 could not report free space.
1643 bool _total_free_4k_blocks_uncertain;
1644 Glib::Threads::Mutex space_lock;
1646 bool no_questions_about_missing_files;
1648 std::string get_best_session_directory_for_new_audio ();
1650 mutable gint _playback_load;
1651 mutable gint _capture_load;
1655 SerializedRCUManager<BundleList> _bundles;
1656 XMLNode* _bundle_xml_node;
1657 int load_bundles (XMLNode const &);
1659 UndoHistory _history;
1660 /** current undo transaction, or 0 */
1661 UndoTransaction* _current_trans;
1662 /** GQuarks to describe the reversible commands that are currently in progress.
1663 * These may be nested, in which case more recently-started commands are toward
1664 * the front of the list.
1666 std::list<GQuark> _current_trans_quarks;
1668 int backend_sync_callback (TransportState, framepos_t);
1670 void process_rtop (SessionEvent*);
1672 void update_latency (bool playback);
1674 XMLNode& state(bool);
1677 typedef std::list<Click*> Clicks;
1680 boost::shared_ptr<IO> _click_io;
1681 boost::shared_ptr<Amp> _click_gain;
1683 Sample* click_emphasis_data;
1684 framecnt_t click_length;
1685 framecnt_t click_emphasis_length;
1686 mutable Glib::Threads::RWLock click_lock;
1688 static const Sample default_click[];
1689 static const framecnt_t default_click_length;
1690 static const Sample default_click_emphasis[];
1691 static const framecnt_t default_click_emphasis_length;
1694 framepos_t _clicks_cleared;
1695 void setup_click_sounds (int which);
1696 void setup_click_sounds (Sample**, Sample const *, framecnt_t*, framecnt_t, std::string const &);
1697 void clear_clicks ();
1698 void click (framepos_t start, framecnt_t nframes);
1700 std::vector<Route*> master_outs;
1702 /* range playback */
1704 std::list<AudioRange> current_audio_range;
1706 void set_play_range (std::list<AudioRange>&, bool leave_rolling);
1707 void unset_play_range ();
1709 /* temporary hacks to allow selection to be pushed from GUI into backend
1710 Whenever we move the selection object into libardour, these will go away.
1712 Evoral::Range<framepos_t> _range_selection;
1713 Evoral::Range<framepos_t> _object_selection;
1718 boost::shared_ptr<Route> _master_out;
1719 boost::shared_ptr<Route> _monitor_out;
1721 void auto_connect_master_bus ();
1723 /* Windows VST support */
1725 long _windows_vst_callback (
1734 int find_all_sources (std::string path, std::set<std::string>& result);
1735 int find_all_sources_across_snapshots (std::set<std::string>& result, bool exclude_this_snapshot);
1737 typedef std::set<boost::shared_ptr<PBD::Controllable> > Controllables;
1738 Glib::Threads::Mutex controllables_lock;
1739 Controllables controllables;
1741 boost::shared_ptr<PBD::Controllable> _solo_cut_control;
1743 void reset_native_file_format();
1744 bool first_file_data_format_reset;
1745 bool first_file_header_format_reset;
1747 void config_changed (std::string, bool);
1749 XMLNode& get_control_protocol_state ();
1751 void set_history_depth (uint32_t depth);
1753 static bool _disable_all_loaded_plugins;
1754 static bool _bypass_all_loaded_plugins;
1756 mutable bool have_looped; ///< Used in ::audible_frame(*)
1758 void update_route_record_state ();
1759 gint _have_rec_enabled_track;
1760 gint _have_rec_disabled_track;
1762 static int ask_about_playlist_deletion (boost::shared_ptr<Playlist>);
1764 /* realtime "apply to set of routes" operations */
1765 template<typename T> SessionEvent*
1766 get_rt_event (boost::shared_ptr<RouteList> rl, T targ, SessionEvent::RTeventCallback after, bool group_override,
1767 void (Session::*method) (boost::shared_ptr<RouteList>, T, bool)) {
1768 SessionEvent* ev = new SessionEvent (SessionEvent::RealTimeOperation, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
1769 ev->rt_slot = boost::bind (method, this, rl, targ, group_override);
1770 ev->rt_return = after;
1771 ev->event_loop = PBD::EventLoop::get_event_loop_for_thread ();
1776 void rt_set_solo (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1777 void rt_set_just_one_solo (boost::shared_ptr<RouteList>, bool yn, bool /* ignored*/ );
1778 void rt_set_mute (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1779 void rt_set_listen (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1780 void rt_set_solo_isolated (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1781 void rt_set_record_enabled (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1782 void rt_set_record_safe (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1783 void rt_set_monitoring (boost::shared_ptr<RouteList>, MonitorChoice, bool group_override);
1785 /** temporary list of Diskstreams used only during load of 2.X sessions */
1786 std::list<boost::shared_ptr<Diskstream> > _diskstreams_2X;
1788 void set_session_range_location (framepos_t, framepos_t);
1790 void setup_midi_machine_control ();
1792 void step_edit_status_change (bool);
1793 uint32_t _step_editors;
1795 /** true if timecode transmission by the transport is suspended, otherwise false */
1796 mutable gint _suspend_timecode_transmission;
1798 void update_locations_after_tempo_map_change (const Locations::LocationList &);
1800 void start_time_changed (framepos_t);
1801 void end_time_changed (framepos_t);
1803 void set_track_monitor_input_status (bool);
1804 framepos_t compute_stop_limit () const;
1806 boost::shared_ptr<Speakers> _speakers;
1807 void load_nested_sources (const XMLNode& node);
1809 /** The directed graph of routes that is currently being used for audio processing
1810 and solo/mute computations.
1812 GraphEdges _current_route_graph;
1814 uint32_t next_control_id () const;
1815 int32_t _order_hint;
1816 bool ignore_route_processor_changes;
1818 MidiClockTicker* midi_clock;
1820 boost::shared_ptr<IO> _ltc_input;
1821 boost::shared_ptr<IO> _ltc_output;
1823 /* Scene Changing */
1824 SceneChanger* _scene_changer;
1826 /* persistent, non-track related MIDI ports */
1827 MidiPortManager* _midi_ports;
1828 MIDI::MachineControl* _mmc;
1831 void setup_click ();
1832 void setup_click_state (const XMLNode*);
1833 void setup_bundles ();
1835 void save_as_bring_callback (uint32_t, uint32_t, std::string);
1837 static int get_session_info_from_path (XMLTree& state_tree, const std::string& xmlpath);
1838 static const uint32_t session_end_shift;
1842 } // namespace ARDOUR
1844 #endif /* __ardour_session_h__ */