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"
34 #include <boost/dynamic_bitset.hpp>
35 #include <boost/scoped_ptr.hpp>
36 #include <boost/weak_ptr.hpp>
37 #include <boost/utility.hpp>
39 #include <glibmm/threads.h>
43 #include "pbd/error.h"
44 #include "pbd/event_loop.h"
46 #include "pbd/reallocpool.h"
47 #include "pbd/statefuldestructible.h"
48 #include "pbd/signals.h"
51 #include "lua/luastate.h"
53 #include "evoral/Range.hpp"
55 #include "midi++/types.h"
56 #include "midi++/mmc.h"
58 #include "timecode/time.h"
60 #include "ardour/ardour.h"
61 #include "ardour/chan_count.h"
62 #include "ardour/delivery.h"
63 #include "ardour/interthread_info.h"
64 #include "ardour/luascripting.h"
65 #include "ardour/location.h"
66 #include "ardour/monitor_processor.h"
67 #include "ardour/presentation_info.h"
68 #include "ardour/rc_configuration.h"
69 #include "ardour/session_configuration.h"
70 #include "ardour/session_event.h"
71 #include "ardour/interpolation.h"
72 #include "ardour/plugin.h"
73 #include "ardour/presentation_info.h"
74 #include "ardour/route.h"
75 #include "ardour/route_graph.h"
81 typedef struct _AEffect AEffect;
105 class AudioFileSource;
110 class AutomationList;
116 class ControllableDescriptor;
124 class MidiClockTicker;
126 class MidiPortManager;
146 class SessionDirectory;
147 class SessionMetadata;
148 class SessionPlaylists;
155 class WindowsVSTPlugin;
157 extern void setup_enum_writer ();
159 class LIBARDOUR_API SessionException: public std::exception {
161 explicit SessionException(const std::string msg) : _message(msg) {}
162 virtual ~SessionException() throw() {}
164 virtual const char* what() const throw() { return _message.c_str(); }
167 std::string _message;
170 /** Ardour Session */
171 class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::ScopedConnectionList, public SessionEventManager
175 PendingDeclickIn = 0x1, ///< pending de-click fade-in for start
176 PendingDeclickOut = 0x2, ///< pending de-click fade-out for stop
177 StopPendingCapture = 0x4,
178 PendingLoopDeclickIn = 0x8, ///< pending de-click fade-in at the start of a loop
179 PendingLoopDeclickOut = 0x10, ///< pending de-click fade-out at the end of a loop
180 PendingLocate = 0x20,
190 /* a new session might have non-empty mix_template, an existing session should always have an empty one.
191 the bus profile can be null if no master out bus is required.
194 Session (AudioEngine&,
195 const std::string& fullpath,
196 const std::string& snapshot_name,
197 BusProfile* bus_profile = 0,
198 std::string mix_template = "");
202 static int get_info_from_path (const std::string& xmlpath, float& sample_rate, SampleFormat& data_format);
203 static std::string get_snapshot_from_instant (const std::string& session_dir);
205 /** a monotonic counter used for naming user-visible things uniquely
206 * (curently the sidechain port).
207 * Use sparingly to keep the numbers low, prefer PBD::ID for all
208 * internal, not user-visible IDs */
209 static unsigned int next_name_id ();
211 std::string path() const { return _path; }
212 std::string name() const { return _name; }
213 std::string snap_name() const { return _current_snapshot_name; }
214 std::string raid_path () const;
215 bool path_is_within_session (const std::string&);
217 bool writable() const { return _writable; }
220 bool dirty() const { return _state_of_the_state & Dirty; }
221 void set_deletion_in_progress ();
222 void clear_deletion_in_progress ();
223 bool reconnection_in_progress() const { return _reconnecting_routes_in_progress; }
224 bool deletion_in_progress() const { return _state_of_the_state & Deletion; }
225 bool routes_deletion_in_progress() const { return _route_deletion_in_progress; }
226 bool peaks_cleanup_in_progres() const { return _state_of_the_state & PeakCleanup; }
227 bool loading () const { return _state_of_the_state & Loading; }
229 PBD::Signal0<void> DirtyChanged;
231 const SessionDirectory& session_directory () const { return *(_session_dir.get()); }
233 static PBD::Signal1<void,std::string> Dialog;
235 PBD::Signal0<void> BatchUpdateStart;
236 PBD::Signal0<void> BatchUpdateEnd;
238 int ensure_subdirs ();
240 std::string automation_dir () const; ///< Automation data
241 std::string analysis_dir () const; ///< Analysis data
242 std::string plugins_dir () const; ///< Plugin state
243 std::string externals_dir () const; ///< Links to external files
245 std::string construct_peak_filepath (const std::string& audio_path, const bool in_session = false, const bool old_peak_name = false) const;
247 bool audio_source_name_is_unique (const std::string& name);
248 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);
249 std::string new_audio_source_path_for_embedded (const std::string& existing_path);
250 std::string new_audio_source_path (const std::string&, uint32_t nchans, uint32_t chan, bool destructive, bool take_required);
251 std::string new_midi_source_path (const std::string&);
252 /** create a new track or bus from a template (XML path)
253 * @param how_many how many tracks or busses to create
254 * @param template_path path to xml template file
255 * @param name name (prefix) of the route to create
256 * @param pd Playlist disposition
257 * @return list of newly created routes
259 RouteList new_route_from_template (uint32_t how_many, PresentationInfo::order_t insert_at, const std::string& template_path, const std::string& name, PlaylistDisposition pd = NewPlaylist);
260 RouteList new_route_from_template (uint32_t how_many, PresentationInfo::order_t insert_at, XMLNode&, const std::string& name, PlaylistDisposition pd = NewPlaylist);
261 std::vector<std::string> get_paths_for_new_sources (bool allow_replacing, const std::string& import_file_path, uint32_t channels);
263 int bring_all_sources_into_session (boost::function<void(uint32_t,uint32_t,std::string)> callback);
265 void process (pframes_t nframes);
267 BufferSet& get_silent_buffers (ChanCount count = ChanCount::ZERO);
268 BufferSet& get_noinplace_buffers (ChanCount count = ChanCount::ZERO);
269 BufferSet& get_scratch_buffers (ChanCount count = ChanCount::ZERO, bool silence = true);
270 BufferSet& get_route_buffers (ChanCount count = ChanCount::ZERO, bool silence = true);
271 BufferSet& get_mix_buffers (ChanCount count = ChanCount::ZERO);
273 bool have_rec_enabled_track () const;
274 bool have_rec_disabled_track () const;
276 bool have_captured() const { return _have_captured; }
278 void refill_all_track_buffers ();
279 Butler* butler() { return _butler; }
280 void butler_transport_work ();
282 void refresh_disk_space ();
284 int load_diskstreams_2X (XMLNode const &, int);
286 int load_routes (const XMLNode&, int);
287 boost::shared_ptr<RouteList> get_routes() const {
288 return routes.reader ();
291 /* because the set of Stripables consists of objects managed
292 * independently, in multiple containers within the Session (or objects
293 * owned by the session), we fill out a list in-place rather than
294 * return a pointer to a copy of the (RCU) managed list, as happens
298 void get_stripables (StripableList&) const;
299 boost::shared_ptr<RouteList> get_tracks() const;
300 boost::shared_ptr<RouteList> get_routes_with_internal_returns() const;
301 boost::shared_ptr<RouteList> get_routes_with_regions_at (framepos_t const) const;
303 uint32_t nroutes() const { return routes.reader()->size(); }
304 uint32_t ntracks () const;
305 uint32_t nbusses () const;
307 boost::shared_ptr<BundleList> bundles () {
308 return _bundles.reader ();
311 struct LIBARDOUR_API RoutePublicOrderSorter {
312 bool operator() (boost::shared_ptr<Route>, boost::shared_ptr<Route> b);
315 void notify_presentation_info_change ();
317 template<class T> void foreach_route (T *obj, void (T::*func)(Route&), bool sort = true);
318 template<class T> void foreach_route (T *obj, void (T::*func)(boost::shared_ptr<Route>), bool sort = true);
319 template<class T, class A> void foreach_route (T *obj, void (T::*func)(Route&, A), A arg, bool sort = true);
321 static char session_name_is_legal (const std::string&);
322 bool io_name_is_legal (const std::string&) const;
323 boost::shared_ptr<Route> route_by_name (std::string) const;
324 boost::shared_ptr<Route> route_by_id (PBD::ID) const;
325 boost::shared_ptr<Stripable> get_remote_nth_stripable (PresentationInfo::order_t n, PresentationInfo::Flag) const;
326 boost::shared_ptr<Route> get_remote_nth_route (PresentationInfo::order_t n) const;
327 boost::shared_ptr<Route> route_by_selected_count (uint32_t cnt) const;
328 boost::shared_ptr<Track> track_by_diskstream_id (PBD::ID) const;
329 void routes_using_input_from (const std::string& str, RouteList& rl);
331 bool route_name_unique (std::string) const;
332 bool route_name_internal (std::string) const;
334 uint32_t track_number_decimals () const {
335 return _track_number_decimals;
338 bool get_record_enabled() const {
339 return (record_status () >= Enabled);
342 RecordState record_status() const {
343 return (RecordState) g_atomic_int_get (&_record_status);
346 bool actively_recording () const {
347 return record_status() == Recording;
350 bool record_enabling_legal () const;
351 void maybe_enable_record ();
352 void disable_record (bool rt_context, bool force = false);
353 void step_back_from_record ();
355 void set_all_tracks_record_enabled(bool);
357 void maybe_write_autosave ();
359 /* Emitted when all i/o connections are complete */
361 PBD::Signal0<void> IOConnectionsComplete;
363 /* Timecode status signals */
364 PBD::Signal1<void, bool> MTCSyncStateChanged;
365 PBD::Signal1<void, bool> LTCSyncStateChanged;
367 /* Record status signals */
369 PBD::Signal0<void> RecordStateChanged; /* signals changes in recording state (i.e. are we recording) */
370 /* XXX may 2015: paul says: it isn't clear to me that this has semantics that cannot be inferrred
371 from the previous signal and session state.
373 PBD::Signal0<void> RecordArmStateChanged; /* signals changes in recording arming */
375 /* Emited when session is loaded */
376 PBD::Signal0<void> SessionLoaded;
378 /* Transport mechanism signals */
380 /** Emitted on the following changes in transport state:
381 * - stop (from the butler thread)
382 * - change in whether or not we are looping (from the process thread)
383 * - change in the play range (from the process thread)
384 * - start (from the process thread)
387 PBD::Signal0<void> TransportStateChange;
389 PBD::Signal1<void,framepos_t> PositionChanged; /* sent after any non-sequential motion */
390 PBD::Signal1<void,framepos_t> Xrun;
391 PBD::Signal0<void> TransportLooped;
393 /** emitted when a locate has occurred */
394 PBD::Signal0<void> Located;
396 PBD::Signal1<void,RouteList&> RouteAdded;
397 /** Emitted when a property of one of our route groups changes.
398 * The parameter is the RouteGroup that has changed.
400 PBD::Signal1<void, RouteGroup *> RouteGroupPropertyChanged;
401 /** Emitted when a route is added to one of our route groups.
402 * First parameter is the RouteGroup, second is the route.
404 PBD::Signal2<void, RouteGroup *, boost::weak_ptr<Route> > RouteAddedToRouteGroup;
405 /** Emitted when a route is removed from one of our route groups.
406 * First parameter is the RouteGroup, second is the route.
408 PBD::Signal2<void, RouteGroup *, boost::weak_ptr<Route> > RouteRemovedFromRouteGroup;
410 /* Step Editing status changed */
411 PBD::Signal1<void,bool> StepEditStatusChange;
413 /* Timecode state signals */
414 PBD::Signal0<void> MtcOrLtcInputPortChanged;
416 void queue_event (SessionEvent*);
418 void request_roll_at_and_return (framepos_t start, framepos_t return_to);
419 void request_bounded_roll (framepos_t start, framepos_t end);
420 void request_stop (bool abort = false, bool clear_state = false);
421 void request_locate (framepos_t frame, bool with_roll = false);
423 void request_play_loop (bool yn, bool leave_rolling = false);
424 bool get_play_loop () const { return play_loop; }
426 framepos_t last_transport_start () const { return _last_roll_location; }
429 void use_rf_shuttle_speed ();
430 void allow_auto_play (bool yn);
431 void request_transport_speed (double speed, bool as_default = true);
432 void request_transport_speed_nonzero (double, bool as_default = true);
433 void request_overwrite_buffer (Track *);
434 void adjust_playback_buffering();
435 void adjust_capture_buffering();
436 void request_track_speed (Track *, double speed);
437 void request_input_change_handling ();
439 bool locate_pending() const { return static_cast<bool>(post_transport_work()&PostTransportLocate); }
440 bool declick_out_pending() const { return static_cast<bool>(transport_sub_state&(PendingDeclickOut)); }
441 bool transport_locked () const;
445 framepos_t current_end_frame () const;
446 framepos_t current_start_frame () const;
447 /** "actual" sample rate of session, set by current audioengine rate, pullup/down etc. */
448 framecnt_t frame_rate () const { return _current_frame_rate; }
449 /** "native" sample rate of session, regardless of current audioengine rate, pullup/down etc */
450 framecnt_t nominal_frame_rate () const { return _nominal_frame_rate; }
451 framecnt_t frames_per_hour () const { return _frames_per_hour; }
453 double frames_per_timecode_frame() const { return _frames_per_timecode_frame; }
454 framecnt_t timecode_frames_per_hour() const { return _timecode_frames_per_hour; }
456 MIDI::byte get_mtc_timecode_bits() const {
457 return mtc_timecode_bits; /* encoding of SMTPE type for MTC */
460 double timecode_frames_per_second() const;
461 bool timecode_drop_frames() const;
465 Locations *locations() { return _locations; }
467 PBD::Signal1<void,Location*> auto_loop_location_changed;
468 PBD::Signal1<void,Location*> auto_punch_location_changed;
469 PBD::Signal0<void> locations_modified;
471 void set_auto_punch_location (Location *);
472 void set_auto_loop_location (Location *);
473 void set_session_extents (framepos_t start, framepos_t end);
474 void set_end_is_free (bool);
475 int location_name(std::string& result, std::string base = std::string(""));
477 pframes_t get_block_size() const { return current_block_size; }
478 framecnt_t worst_output_latency () const { return _worst_output_latency; }
479 framecnt_t worst_input_latency () const { return _worst_input_latency; }
480 framecnt_t worst_track_latency () const { return _worst_track_latency; }
481 framecnt_t worst_playback_latency () const { return _worst_output_latency + _worst_track_latency; }
484 std::string new_parent_folder; /* parent folder where new session folder will be created */
485 std::string new_name; /* name of newly saved session */
486 bool switch_to; /* true if we should be working on newly saved session after save-as; false otherwise */
487 bool include_media; /* true if the newly saved session should contain references to media */
488 bool copy_media; /* true if media files (audio, media, etc) should be copied into newly saved session; false otherwise */
489 bool copy_external; /* true if external media should be consolidated into the newly saved session; false otherwise */
491 std::string final_session_folder_name; /* filled in by * Session::save_as(), provides full path to newly saved session */
493 /* emitted as we make progress. 3 arguments passed to signal
496 * 1: percentage complete measured as a fraction (0-1.0) of
497 * total data copying done.
498 * 2: number of files copied so far
499 * 3: total number of files to copy
501 * Handler should return true for save-as to continue, or false
502 * to stop (and remove all evidence of partial save-as).
504 PBD::Signal3<bool,float,int64_t,int64_t> Progress;
506 /* if save_as() returns non-zero, this string will indicate the reason why.
508 std::string failure_message;
511 int save_as (SaveAs&);
513 * @param snapshot_name name of the session (use an empty string for the current name)
514 * @param pending save a 'recovery', not full state (default: false)
515 * @param switch_to_snapshot switch to given snapshot after saving (default: false)
516 * @param template_only save a session template (default: false)
517 * @return zero on success
519 int save_state (std::string snapshot_name, bool pending = false, bool switch_to_snapshot = false, bool template_only = false);
527 int archive_session (const std::string&, const std::string&, ArchiveEncode compress_audio = FLAC_16BIT, Progress* p = 0);
529 int restore_state (std::string snapshot_name);
530 int save_template (std::string template_name, bool replace_existing = false);
531 int save_history (std::string snapshot_name = "");
532 int restore_history (std::string snapshot_name);
533 void remove_state (std::string snapshot_name);
534 void rename_state (std::string old_name, std::string new_name);
535 void remove_pending_capture_state ();
536 int rename (const std::string&);
537 bool get_nsm_state () const { return _under_nsm_control; }
538 void set_nsm_state (bool state) { _under_nsm_control = state; }
539 bool save_default_options ();
541 PBD::Signal1<void,std::string> StateSaved;
542 PBD::Signal0<void> StateReady;
544 /* emitted when session needs to be saved due to some internal
545 * event or condition (i.e. not in response to a user request).
547 * Only one object should
548 * connect to this signal and take responsibility.
550 * Argument is the snapshot name to use when saving.
552 PBD::Signal1<void,std::string> SaveSessionRequested;
554 /* emitted during a session save to allow other entities to add state, via
555 * extra XML, to the session state
557 PBD::Signal0<void> SessionSaveUnderway;
559 std::vector<std::string> possible_states() const;
560 static std::vector<std::string> possible_states (std::string path);
562 XMLNode& get_state();
563 int set_state(const XMLNode& node, int version); // not idempotent
564 XMLNode& get_template();
566 /// The instant xml file is written to the session directory
567 void add_instant_xml (XMLNode&, bool write_to_config = true);
568 XMLNode* instant_xml (const std::string& str);
570 enum StateOfTheState {
575 InitialConnecting = 0x8,
581 StateOfTheState state_of_the_state() const { return _state_of_the_state; }
583 class StateProtector {
585 StateProtector (Session* s) : _session (s) {
586 g_atomic_int_inc (&s->_suspend_save);
589 if (g_atomic_int_dec_and_test (&_session->_suspend_save)) {
590 while (_session->_save_queued) {
591 _session->_save_queued = false;
592 _session->save_state ("");
600 void add_route_group (RouteGroup *);
601 void remove_route_group (RouteGroup&);
602 void reorder_route_groups (std::list<RouteGroup*>);
604 RouteGroup* route_group_by_name (std::string);
605 RouteGroup& all_route_group() const;
607 PBD::Signal1<void,RouteGroup*> route_group_added;
608 PBD::Signal0<void> route_group_removed;
609 PBD::Signal0<void> route_groups_reordered;
611 void foreach_route_group (boost::function<void(RouteGroup*)> f) {
612 for (std::list<RouteGroup *>::iterator i = _route_groups.begin(); i != _route_groups.end(); ++i) {
617 std::list<RouteGroup*> const & route_groups () const {
618 return _route_groups;
621 /* fundamental operations. duh. */
623 std::list<boost::shared_ptr<AudioTrack> > new_audio_track (
626 RouteGroup* route_group,
628 std::string name_template,
629 PresentationInfo::order_t order,
630 TrackMode mode = Normal
633 std::list<boost::shared_ptr<MidiTrack> > new_midi_track (
634 const ChanCount& input, const ChanCount& output,
635 boost::shared_ptr<PluginInfo> instrument,
636 Plugin::PresetRecord* pset,
637 RouteGroup* route_group, uint32_t how_many, std::string name_template,
638 PresentationInfo::order_t,
639 TrackMode mode = Normal
642 RouteList new_audio_route (int input_channels, int output_channels, RouteGroup* route_group, uint32_t how_many, std::string name_template, PresentationInfo::Flag, PresentationInfo::order_t);
643 RouteList new_midi_route (RouteGroup* route_group, uint32_t how_many, std::string name_template, boost::shared_ptr<PluginInfo> instrument, Plugin::PresetRecord*, PresentationInfo::Flag, PresentationInfo::order_t);
645 void remove_routes (boost::shared_ptr<RouteList>);
646 void remove_route (boost::shared_ptr<Route>);
648 void resort_routes ();
649 void resort_routes_using (boost::shared_ptr<RouteList>);
651 AudioEngine & engine() { return _engine; }
652 AudioEngine const & engine () const { return _engine; }
654 static std::string default_track_name_pattern (DataType);
658 framepos_t transport_frame () const {return _transport_frame; }
659 framepos_t record_location () const {return _last_record_location; }
660 framepos_t audible_frame () const;
661 framepos_t requested_return_frame() const { return _requested_return_frame; }
662 void set_requested_return_frame(framepos_t return_to);
676 void sync_time_vars();
678 void bbt_time (framepos_t when, Timecode::BBT_Time&);
679 void timecode_to_sample(Timecode::Time& timecode, framepos_t& sample, bool use_offset, bool use_subframes) const;
680 void sample_to_timecode(framepos_t sample, Timecode::Time& timecode, bool use_offset, bool use_subframes) const;
681 void timecode_time (Timecode::Time &);
682 void timecode_time (framepos_t when, Timecode::Time&);
683 void timecode_time_subframes (framepos_t when, Timecode::Time&);
685 void timecode_duration (framecnt_t, Timecode::Time&) const;
686 void timecode_duration_string (char *, size_t len, framecnt_t) const;
688 framecnt_t convert_to_frames (AnyTime const & position);
689 framecnt_t any_duration_to_frames (framepos_t position, AnyTime const & duration);
691 static PBD::Signal1<void, framepos_t> StartTimeChanged;
692 static PBD::Signal1<void, framepos_t> EndTimeChanged;
694 void request_sync_source (Slave*);
695 bool synced_to_engine() const { return _slave && config.get_external_sync() && Config->get_sync_source() == Engine; }
696 bool synced_to_mtc () const { return config.get_external_sync() && Config->get_sync_source() == MTC && g_atomic_int_get (const_cast<gint*>(&_mtc_active)); }
697 bool synced_to_ltc () const { return config.get_external_sync() && Config->get_sync_source() == LTC && g_atomic_int_get (const_cast<gint*>(&_ltc_active)); }
699 double transport_speed() const { return _transport_speed; }
700 bool transport_stopped() const { return _transport_speed == 0.0; }
701 bool transport_rolling() const { return _transport_speed != 0.0; }
703 bool silent () { return _silent; }
705 TempoMap& tempo_map() { return *_tempo_map; }
706 const TempoMap& tempo_map() const { return *_tempo_map; }
708 unsigned int get_xrun_count () const {return _xrun_count; }
709 void reset_xrun_count () {_xrun_count = 0; }
713 boost::shared_ptr<Region> find_whole_file_parent (boost::shared_ptr<Region const>) const;
715 boost::shared_ptr<Region> XMLRegionFactory (const XMLNode&, bool full);
716 boost::shared_ptr<AudioRegion> XMLAudioRegionFactory (const XMLNode&, bool full);
717 boost::shared_ptr<MidiRegion> XMLMidiRegionFactory (const XMLNode&, bool full);
719 /* source management */
721 void import_files (ImportStatus&);
722 bool sample_rate_convert (ImportStatus&, std::string infile, std::string& outfile);
723 std::string build_tmp_convert_name (std::string file);
725 boost::shared_ptr<ExportHandler> get_export_handler ();
726 boost::shared_ptr<ExportStatus> get_export_status ();
728 int start_audio_export (framepos_t position, bool realtime = false);
730 PBD::Signal1<int, framecnt_t> ProcessExport;
731 static PBD::Signal2<void,std::string, std::string> Exported;
733 void add_source (boost::shared_ptr<Source>);
734 void remove_source (boost::weak_ptr<Source>);
736 void cleanup_regions();
737 bool can_cleanup_peakfiles () const;
738 int cleanup_peakfiles ();
739 int cleanup_sources (CleanupReport&);
740 int cleanup_trash_sources (CleanupReport&);
742 int destroy_sources (std::list<boost::shared_ptr<Source> >);
744 int remove_last_capture ();
746 /** handlers should return 0 for "everything OK", and any other value for
747 * "cannot setup audioengine".
749 static PBD::Signal1<int,uint32_t> AudioEngineSetupRequired;
751 /** handlers should return -1 for "stop cleanup",
752 0 for "yes, delete this playlist",
753 1 for "no, don't delete this playlist".
755 static PBD::Signal1<int,boost::shared_ptr<Playlist> > AskAboutPlaylistDeletion;
757 /** handlers should return 0 for "ignore the rate mismatch",
758 !0 for "do not use this session"
760 static PBD::Signal2<int, framecnt_t, framecnt_t> AskAboutSampleRateMismatch;
762 /** non interactive message */
763 static PBD::Signal2<void, framecnt_t, framecnt_t> NotifyAboutSampleRateMismatch;
765 /** handlers should return !0 for use pending state, 0 for ignore it.
767 static PBD::Signal0<int> AskAboutPendingState;
769 boost::shared_ptr<AudioFileSource> create_audio_source_for_session (
770 size_t, std::string const &, uint32_t, bool destructive);
772 boost::shared_ptr<MidiSource> create_midi_source_for_session (std::string const &);
773 boost::shared_ptr<MidiSource> create_midi_source_by_stealing_name (boost::shared_ptr<Track>);
775 boost::shared_ptr<Source> source_by_id (const PBD::ID&);
776 boost::shared_ptr<AudioFileSource> audio_source_by_path_and_channel (const std::string&, uint16_t) const;
777 boost::shared_ptr<MidiSource> midi_source_by_path (const std::string&) const;
778 uint32_t count_sources_by_origin (const std::string&);
780 void add_playlist (boost::shared_ptr<Playlist>, bool unused = false);
782 /* Curves and AutomationLists (TODO when they go away) */
783 void add_automation_list(AutomationList*);
787 boost::shared_ptr<Auditioner> the_auditioner() { return auditioner; }
788 void audition_playlist ();
789 void audition_region (boost::shared_ptr<Region>);
790 void cancel_audition ();
791 bool is_auditioning () const;
793 PBD::Signal1<void,bool> AuditionActive;
796 void register_lua_function (const std::string&, const std::string&, const LuaScriptParamList&);
797 void unregister_lua_function (const std::string& name);
798 std::vector<std::string> registered_lua_functions ();
799 uint32_t registered_lua_function_count () const { return _n_lua_scripts; }
800 void scripts_changed (); // called from lua, updates _n_lua_scripts
802 /* flattening stuff */
804 boost::shared_ptr<Region> write_one_track (Track&, framepos_t start, framepos_t end,
805 bool overwrite, std::vector<boost::shared_ptr<Source> >&, InterThreadInfo& wot,
806 boost::shared_ptr<Processor> endpoint,
807 bool include_endpoint, bool for_export, bool for_freeze);
808 int freeze_all (InterThreadInfo&);
810 /* session-wide solo/mute/rec-enable */
812 bool soloing() const { return _non_soloed_outs_muted; }
813 bool listening() const { return _listen_cnt > 0; }
814 bool solo_isolated() const { return _solo_isolated_cnt > 0; }
815 void cancel_all_solo ();
817 static const SessionEvent::RTeventCallback rt_cleanup;
819 void clear_all_solo_state (boost::shared_ptr<RouteList>);
821 /* Control-based methods */
823 void set_controls (boost::shared_ptr<ControlList>, double val, PBD::Controllable::GroupControlDisposition);
824 void set_control (boost::shared_ptr<AutomationControl>, double val, PBD::Controllable::GroupControlDisposition);
826 void set_exclusive_input_active (boost::shared_ptr<RouteList> rt, bool onoff, bool flip_others = false);
828 PBD::Signal1<void,bool> SoloActive;
829 PBD::Signal0<void> SoloChanged;
830 PBD::Signal0<void> IsolatedChanged;
831 PBD::Signal0<void> MonitorChanged;
833 PBD::Signal0<void> session_routes_reconnected;
835 /* monitor/master out */
837 void add_monitor_section ();
838 void reset_monitor_section ();
839 void remove_monitor_section ();
840 bool monitor_active() const { return (_monitor_out && _monitor_out->monitor_control () && _monitor_out->monitor_control ()->monitor_active()); }
842 boost::shared_ptr<Route> monitor_out() const { return _monitor_out; }
843 boost::shared_ptr<Route> master_out() const { return _master_out; }
845 void globally_add_internal_sends (boost::shared_ptr<Route> dest, Placement p, bool);
846 void globally_set_send_gains_from_track (boost::shared_ptr<Route> dest);
847 void globally_set_send_gains_to_zero (boost::shared_ptr<Route> dest);
848 void globally_set_send_gains_to_unity (boost::shared_ptr<Route> dest);
849 void add_internal_sends (boost::shared_ptr<Route> dest, Placement p, boost::shared_ptr<RouteList> senders);
850 void add_internal_send (boost::shared_ptr<Route>, int, boost::shared_ptr<Route>);
851 void add_internal_send (boost::shared_ptr<Route>, boost::shared_ptr<Processor>, boost::shared_ptr<Route>);
853 static void set_disable_all_loaded_plugins (bool yn) {
854 _disable_all_loaded_plugins = yn;
856 static bool get_disable_all_loaded_plugins() {
857 return _disable_all_loaded_plugins;
859 static void set_bypass_all_loaded_plugins (bool yn) {
860 _bypass_all_loaded_plugins = yn;
862 static bool get_bypass_all_loaded_plugins() {
863 return _bypass_all_loaded_plugins;
866 uint32_t next_send_id();
867 uint32_t next_aux_send_id();
868 uint32_t next_return_id();
869 uint32_t next_insert_id();
870 void mark_send_id (uint32_t);
871 void mark_aux_send_id (uint32_t);
872 void mark_return_id (uint32_t);
873 void mark_insert_id (uint32_t);
874 void unmark_send_id (uint32_t);
875 void unmark_aux_send_id (uint32_t);
876 void unmark_return_id (uint32_t);
877 void unmark_insert_id (uint32_t);
879 /* s/w "RAID" management */
881 boost::optional<framecnt_t> available_capture_duration();
885 void add_bundle (boost::shared_ptr<Bundle>, bool emit_signal = true);
886 void remove_bundle (boost::shared_ptr<Bundle>);
887 boost::shared_ptr<Bundle> bundle_by_name (std::string) const;
889 PBD::Signal0<void> BundleAddedOrRemoved;
893 /* History (for editors, mixers, UIs etc.) */
895 /** Undo some transactions.
896 * @param n Number of transactions to undo.
898 void undo (uint32_t n);
899 /** Redo some transactions.
900 * @param n Number of transactions to undo.
902 void redo (uint32_t n);
904 UndoHistory& history() { return _history; }
906 uint32_t undo_depth() const { return _history.undo_depth(); }
907 uint32_t redo_depth() const { return _history.redo_depth(); }
908 std::string next_undo() const { return _history.next_undo(); }
909 std::string next_redo() const { return _history.next_redo(); }
911 /** begin collecting undo information
913 * This call must always be followed by either
914 * begin_reversible_command() or commit_reversible_command()
916 * @param cmd_name human readable name for the undo operation
918 void begin_reversible_command (const std::string& cmd_name);
919 void begin_reversible_command (GQuark);
920 /** abort an open undo command
921 * This must only be called after begin_reversible_command ()
923 void abort_reversible_command ();
924 /** finalize an undo command and commit pending transactions
926 * This must only be called after begin_reversible_command ()
927 * @param cmd (additional) command to add
929 void commit_reversible_command (Command* cmd = 0);
931 void add_command (Command *const cmd);
933 /** create an StatefulDiffCommand from the given object and add it to the stack.
935 * This function must only be called after begin_reversible_command.
936 * Failing to do so may lead to a crash.
938 * @param sfd the object to diff
939 * @returns the allocated StatefulDiffCommand (already added via add_command)
941 PBD::StatefulDiffCommand* add_stateful_diff_command (boost::shared_ptr<PBD::StatefulDestructible> sfd);
943 /** @return The list of operations that are currently in progress */
944 std::list<GQuark> const & current_operations () {
945 return _current_trans_quarks;
948 bool operation_in_progress (GQuark) const;
950 void add_commands (std::vector<Command*> const & cmds);
952 std::map<PBD::ID,PBD::StatefulDestructible*> registry;
954 // these commands are implemented in libs/ardour/session_command.cc
955 Command* memento_command_factory(XMLNode* n);
956 Command* stateful_diff_command_factory (XMLNode *);
957 void register_with_memento_command_factory(PBD::ID, PBD::StatefulDestructible*);
961 boost::shared_ptr<IO> click_io() { return _click_io; }
962 boost::shared_ptr<Amp> click_gain() { return _click_gain; }
964 /* disk, buffer loads */
966 uint32_t playback_load ();
967 uint32_t capture_load ();
971 void request_play_range (std::list<AudioRange>*, bool leave_rolling = false);
972 void request_cancel_play_range ();
973 bool get_play_range () const { return _play_range; }
975 void maybe_update_session_range (framepos_t, framepos_t);
977 /* temporary hacks to allow selection to be pushed from GUI into backend.
978 Whenever we move the selection object into libardour, these will go away.
980 void set_range_selection (framepos_t start, framepos_t end);
981 void set_object_selection (framepos_t start, framepos_t end);
982 void clear_range_selection ();
983 void clear_object_selection ();
985 /* buffers for gain and pan */
987 gain_t* gain_automation_buffer () const;
988 gain_t* trim_automation_buffer () const;
989 gain_t* send_gain_automation_buffer () const;
990 pan_t** pan_automation_buffer () const;
992 void ensure_buffer_set (BufferSet& buffers, const ChanCount& howmany);
996 static int vst_current_loading_id;
997 static const char* vst_can_do_strings[];
998 static const int vst_can_do_string_count;
1000 static intptr_t vst_callback (
1009 static PBD::Signal0<void> SendFeedback;
1013 boost::shared_ptr<Speakers> get_speakers ();
1017 boost::shared_ptr<Processor> processor_by_id (PBD::ID) const;
1019 boost::shared_ptr<PBD::Controllable> controllable_by_id (const PBD::ID&);
1020 boost::shared_ptr<PBD::Controllable> controllable_by_descriptor (const ARDOUR::ControllableDescriptor&);
1022 void add_controllable (boost::shared_ptr<PBD::Controllable>);
1023 void remove_controllable (PBD::Controllable*);
1025 boost::shared_ptr<PBD::Controllable> solo_cut_control() const;
1027 SessionConfiguration config;
1029 SessionConfiguration* cfg () { return &config; }
1031 bool exporting () const {
1035 bool bounce_processing() const {
1036 return _bounce_processing_active;
1039 /* this is a private enum, but setup_enum_writer() needs it,
1040 and i can't find a way to give that function
1041 friend access. sigh.
1044 enum PostTransportWork {
1045 PostTransportStop = 0x1,
1046 PostTransportDuration = 0x2,
1047 PostTransportLocate = 0x4,
1048 PostTransportRoll = 0x8,
1049 PostTransportAbort = 0x10,
1050 PostTransportOverWrite = 0x20,
1051 PostTransportSpeed = 0x40,
1052 PostTransportAudition = 0x80,
1053 PostTransportReverse = 0x100,
1054 PostTransportInputChange = 0x200,
1055 PostTransportCurveRealloc = 0x400,
1056 PostTransportClearSubstate = 0x800,
1057 PostTransportAdjustPlaybackBuffering = 0x1000,
1058 PostTransportAdjustCaptureBuffering = 0x2000
1067 SlaveState slave_state() const { return _slave_state; }
1068 Slave* slave() const { return _slave; }
1070 boost::shared_ptr<SessionPlaylists> playlists;
1072 void send_mmc_locate (framepos_t);
1073 void queue_full_time_code () { _send_timecode_update = true; }
1074 void queue_song_position_pointer () { /* currently does nothing */ }
1076 bool step_editing() const { return (_step_editors > 0); }
1078 void request_suspend_timecode_transmission ();
1079 void request_resume_timecode_transmission ();
1080 bool timecode_transmission_suspended () const;
1082 std::vector<std::string> source_search_path(DataType) const;
1083 void ensure_search_path_includes (const std::string& path, DataType type);
1084 void remove_dir_from_search_path (const std::string& path, DataType type);
1086 std::list<std::string> unknown_processors () const;
1088 /** Emitted when a feedback cycle has been detected within Ardour's signal
1089 processing path. Until it is fixed (by the user) some (unspecified)
1090 routes will not be run.
1092 static PBD::Signal0<void> FeedbackDetected;
1094 /** Emitted when a graph sort has successfully completed, which means
1095 that it has no feedback cycles.
1097 static PBD::Signal0<void> SuccessfulGraphSort;
1099 /* handlers can return an integer value:
1100 0: config.set_audio_search_path() or config.set_midi_search_path() was used
1101 to modify the search path and we should try to find it again.
1102 1: quit entire session load
1103 2: as 0, but don't ask about other missing files
1104 3: don't ask about other missing files, and just mark this one missing
1105 -1: just mark this one missing
1106 any other value: as -1
1108 static PBD::Signal3<int,Session*,std::string,DataType> MissingFile;
1110 /** Emitted when the session wants Ardour to quit */
1111 static PBD::Signal0<void> Quit;
1113 /** Emitted when Ardour is asked to load a session in an older session
1114 * format, and makes a backup copy.
1116 static PBD::Signal2<void,std::string,std::string> VersionMismatch;
1118 SceneChanger* scene_changer() const { return _scene_changer; }
1120 /* asynchronous MIDI control ports */
1122 boost::shared_ptr<Port> midi_input_port () const;
1123 boost::shared_ptr<Port> midi_output_port () const;
1124 boost::shared_ptr<Port> mmc_output_port () const;
1125 boost::shared_ptr<Port> mmc_input_port () const;
1126 boost::shared_ptr<Port> scene_input_port () const;
1127 boost::shared_ptr<Port> scene_output_port () const;
1129 /* synchronous MIDI ports used for synchronization */
1131 boost::shared_ptr<MidiPort> midi_clock_output_port () const;
1132 boost::shared_ptr<MidiPort> midi_clock_input_port () const;
1133 boost::shared_ptr<MidiPort> mtc_output_port () const;
1134 boost::shared_ptr<MidiPort> mtc_input_port () const;
1135 boost::shared_ptr<Port> ltc_input_port() const;
1136 boost::shared_ptr<Port> ltc_output_port() const;
1138 boost::shared_ptr<IO> ltc_input_io() { return _ltc_input; }
1139 boost::shared_ptr<IO> ltc_output_io() { return _ltc_output; }
1141 MIDI::MachineControl& mmc() { return *_mmc; }
1143 void reconnect_midi_scene_ports (bool);
1144 void reconnect_mtc_ports ();
1145 void reconnect_mmc_ports (bool);
1147 void reconnect_ltc_input ();
1148 void reconnect_ltc_output ();
1150 VCAManager& vca_manager() { return *_vca_manager; }
1152 bool midi_regions_use_bbt_beats () { return _midi_regions_use_bbt_beats; }
1155 friend class AudioEngine;
1156 void set_block_size (pframes_t nframes);
1157 void set_frame_rate (framecnt_t nframes);
1158 #ifdef USE_TRACKS_CODE_FEATURES
1159 void reconnect_existing_routes (bool withLock, bool reconnect_master = true, bool reconnect_inputs = true, bool reconnect_outputs = true);
1164 void schedule_curve_reallocation ();
1165 void update_latency_compensation (bool force = false);
1168 int create (const std::string& mix_template, BusProfile*);
1171 static guint _name_id_counter;
1172 static void init_name_id_counter (guint n);
1173 static unsigned int name_id_counter ();
1175 /* stuff used in process() should be close together to
1179 typedef void (Session::*process_function_type)(pframes_t);
1181 AudioEngine& _engine;
1182 mutable gint processing_prohibited;
1183 process_function_type process_function;
1184 process_function_type last_process_function;
1185 bool _bounce_processing_active;
1186 bool waiting_for_sync_offset;
1187 framecnt_t _base_frame_rate; // sample-rate of the session at creation time, "native" SR
1188 framecnt_t _nominal_frame_rate; // overridden by audioengine setting
1189 framecnt_t _current_frame_rate; // this includes video pullup offset
1190 int transport_sub_state;
1191 mutable gint _record_status;
1192 framepos_t _transport_frame;
1193 Location* _session_range_location; ///< session range, or 0 if there is nothing in the session yet
1194 bool _session_range_end_is_free;
1198 // varispeed playback
1199 double _transport_speed;
1200 double _default_transport_speed;
1201 double _last_transport_speed;
1202 double _signalled_varispeed;
1203 double _target_transport_speed;
1204 CubicInterpolation interpolation;
1206 bool auto_play_legal;
1207 framepos_t _last_slave_transport_frame;
1208 framecnt_t maximum_output_latency;
1209 framepos_t _requested_return_frame;
1210 pframes_t current_block_size;
1211 framecnt_t _worst_output_latency;
1212 framecnt_t _worst_input_latency;
1213 framecnt_t _worst_track_latency;
1214 bool _have_captured;
1215 bool _non_soloed_outs_muted;
1217 uint32_t _listen_cnt;
1218 uint32_t _solo_isolated_cnt;
1221 bool _under_nsm_control;
1222 unsigned int _xrun_count;
1224 void mtc_status_changed (bool);
1225 PBD::ScopedConnection mtc_status_connection;
1226 void ltc_status_changed (bool);
1227 PBD::ScopedConnection ltc_status_connection;
1229 void initialize_latencies ();
1230 void set_worst_io_latencies ();
1231 void set_worst_playback_latency ();
1232 void set_worst_capture_latency ();
1233 void set_worst_io_latencies_x (IOChange, void *) {
1234 set_worst_io_latencies ();
1236 void post_capture_latency ();
1237 void post_playback_latency ();
1239 void update_latency_compensation_proxy (void* ignored);
1241 void ensure_buffers (ChanCount howmany = ChanCount::ZERO);
1243 void process_scrub (pframes_t);
1244 void process_without_events (pframes_t);
1245 void process_with_events (pframes_t);
1246 void process_audition (pframes_t);
1247 void process_export (pframes_t);
1248 void process_export_fw (pframes_t);
1250 void block_processing() { g_atomic_int_set (&processing_prohibited, 1); }
1251 void unblock_processing() { g_atomic_int_set (&processing_prohibited, 0); }
1252 bool processing_blocked() const { return g_atomic_int_get (&processing_prohibited); }
1254 static const framecnt_t bounce_chunk_size;
1256 /* slave tracking */
1258 static const int delta_accumulator_size = 25;
1259 int delta_accumulator_cnt;
1260 int32_t delta_accumulator[delta_accumulator_size];
1261 int32_t average_slave_delta;
1263 bool have_first_delta_accumulator;
1265 SlaveState _slave_state;
1268 framepos_t slave_wait_end;
1270 void reset_slave_state ();
1271 bool follow_slave (pframes_t);
1272 void calculate_moving_average_of_slave_delta (int dir, framecnt_t this_delta);
1273 void track_slave_state (float slave_speed, framepos_t slave_transport_frame, framecnt_t this_delta);
1274 void follow_slave_silently (pframes_t nframes, float slave_speed);
1276 void switch_to_sync_source (SyncSource); /* !RT context */
1277 void drop_sync_source (); /* !RT context */
1278 void use_sync_source (Slave*); /* RT context */
1280 bool post_export_sync;
1281 framepos_t post_export_position;
1284 bool _export_rolling;
1285 bool _realtime_export;
1286 framepos_t _export_preroll;
1287 framepos_t _export_latency;
1289 boost::shared_ptr<ExportHandler> export_handler;
1290 boost::shared_ptr<ExportStatus> export_status;
1293 int stop_audio_export ();
1294 void finalize_audio_export ();
1295 void finalize_export_internal (bool stop_freewheel);
1296 bool _pre_export_mmc_enabled;
1298 PBD::ScopedConnection export_freewheel_connection;
1300 void get_track_statistics ();
1301 int process_routes (pframes_t, bool& need_butler);
1302 int silent_process_routes (pframes_t, bool& need_butler);
1304 /** @return 1 if there is a pending declick fade-in,
1305 -1 if there is a pending declick fade-out,
1306 0 if there is no pending declick.
1308 int get_transport_declick_required () {
1309 if (transport_sub_state & PendingDeclickIn) {
1310 transport_sub_state &= ~PendingDeclickIn;
1312 } else if (transport_sub_state & PendingDeclickOut) {
1313 /* XXX: not entirely sure why we don't clear this */
1315 } else if (transport_sub_state & PendingLoopDeclickOut) {
1316 /* Return the declick out first ... */
1317 transport_sub_state &= ~PendingLoopDeclickOut;
1319 } else if (transport_sub_state & PendingLoopDeclickIn) {
1320 /* ... then the declick in on the next call */
1321 transport_sub_state &= ~PendingLoopDeclickIn;
1328 bool maybe_stop (framepos_t limit);
1329 bool maybe_sync_start (pframes_t &);
1331 void check_declick_out ();
1337 /** Number of process frames since the last MTC output (when sending MTC); used to
1338 * know when to send full MTC messages every so often.
1340 pframes_t _pframes_since_last_mtc;
1341 bool session_midi_feedback;
1344 framepos_t last_loopend;
1346 boost::scoped_ptr<SessionDirectory> _session_dir;
1349 void graph_reordered ();
1351 /** current snapshot name, without the .ardour suffix */
1352 void set_snapshot_name (const std::string &);
1353 void save_snapshot_name (const std::string &);
1354 std::string _current_snapshot_name;
1356 XMLTree* state_tree;
1357 bool state_was_pending;
1358 StateOfTheState _state_of_the_state;
1360 friend class StateProtector;
1361 gint _suspend_save; /* atomic */
1362 volatile bool _save_queued;
1363 Glib::Threads::Mutex save_state_lock;
1364 Glib::Threads::Mutex peak_cleanup_lock;
1366 int load_options (const XMLNode&);
1367 int load_state (std::string snapshot_name);
1369 framepos_t _last_roll_location;
1370 /** the session frame time at which we last rolled, located, or changed transport direction */
1371 framepos_t _last_roll_or_reversal_location;
1372 framepos_t _last_record_location;
1374 bool pending_locate_roll;
1375 framepos_t pending_locate_frame;
1376 bool pending_locate_flush;
1378 bool pending_auto_loop;
1380 PBD::ReallocPool _mempool;
1382 Glib::Threads::Mutex lua_lock;
1383 luabridge::LuaRef * _lua_run;
1384 luabridge::LuaRef * _lua_add;
1385 luabridge::LuaRef * _lua_del;
1386 luabridge::LuaRef * _lua_list;
1387 luabridge::LuaRef * _lua_load;
1388 luabridge::LuaRef * _lua_save;
1389 luabridge::LuaRef * _lua_cleanup;
1390 uint32_t _n_lua_scripts;
1393 void try_run_lua (pframes_t);
1397 static const PostTransportWork ProcessCannotProceedMask =
1399 PostTransportInputChange|
1401 PostTransportReverse|
1402 PostTransportCurveRealloc|
1403 PostTransportAudition|
1404 PostTransportLocate|
1406 PostTransportClearSubstate);
1408 gint _post_transport_work; /* accessed only atomic ops */
1409 PostTransportWork post_transport_work() const { return (PostTransportWork) g_atomic_int_get (const_cast<gint*>(&_post_transport_work)); }
1410 void set_post_transport_work (PostTransportWork ptw) { g_atomic_int_set (&_post_transport_work, (gint) ptw); }
1411 void add_post_transport_work (PostTransportWork ptw);
1413 void schedule_playback_buffering_adjustment ();
1414 void schedule_capture_buffering_adjustment ();
1416 uint32_t cumulative_rf_motion;
1419 void set_rf_speed (float speed);
1420 void reset_rf_scale (framecnt_t frames_moved);
1422 Locations* _locations;
1423 void location_added (Location*);
1424 void location_removed (Location*);
1425 void locations_changed ();
1426 void _locations_changed (const Locations::LocationList&);
1428 void update_skips (Location*, bool consolidate);
1429 void update_marks (Location* loc);
1430 void consolidate_skips (Location*);
1431 void sync_locations_to_skips ();
1432 void _sync_locations_to_skips ();
1434 PBD::ScopedConnectionList skip_update_connections;
1435 bool _ignore_skips_updates;
1437 PBD::ScopedConnectionList punch_connections;
1438 void auto_punch_start_changed (Location *);
1439 void auto_punch_end_changed (Location *);
1440 void auto_punch_changed (Location *);
1442 PBD::ScopedConnectionList loop_connections;
1443 void auto_loop_changed (Location *);
1444 void auto_loop_declick_range (Location *, framepos_t &, framepos_t &);
1446 int ensure_engine (uint32_t desired_sample_rate, bool);
1447 void pre_engine_init (std::string path);
1448 int post_engine_init ();
1449 int immediately_post_engine ();
1450 void remove_empty_sounds ();
1452 void session_loaded ();
1454 void setup_midi_control ();
1455 int midi_read (MIDI::Port *);
1457 void enable_record ();
1459 void increment_transport_position (framecnt_t val) {
1460 if (max_framepos - val < _transport_frame) {
1461 _transport_frame = max_framepos;
1463 _transport_frame += val;
1467 void decrement_transport_position (framecnt_t val) {
1468 if (val < _transport_frame) {
1469 _transport_frame -= val;
1471 _transport_frame = 0;
1475 void post_transport_motion ();
1476 static void *session_loader_thread (void *arg);
1480 /* Signal Forwarding */
1481 void emit_route_signals ();
1482 void emit_thread_run ();
1483 static void *emit_thread (void *);
1484 void emit_thread_start ();
1485 void emit_thread_terminate ();
1487 pthread_t _rt_emit_thread;
1488 bool _rt_thread_active;
1490 pthread_mutex_t _rt_emit_mutex;
1491 pthread_cond_t _rt_emit_cond;
1492 bool _rt_emit_pending;
1494 /* Auto Connect Thread */
1495 static void *auto_connect_thread (void *);
1496 void auto_connect_thread_run ();
1497 void auto_connect_thread_start ();
1498 void auto_connect_thread_terminate ();
1500 pthread_t _auto_connect_thread;
1501 bool _ac_thread_active;
1502 pthread_mutex_t _auto_connect_mutex;
1503 pthread_cond_t _auto_connect_cond;
1505 struct AutoConnectRequest {
1507 AutoConnectRequest (boost::shared_ptr <Route> r, bool ci,
1508 const ChanCount& is,
1509 const ChanCount& os,
1510 const ChanCount& io,
1511 const ChanCount& oo)
1512 : route (boost::weak_ptr<Route> (r))
1513 , connect_inputs (ci)
1517 , output_offset (oo)
1520 boost::weak_ptr <Route> route;
1521 bool connect_inputs;
1522 ChanCount input_start;
1523 ChanCount output_start;
1524 ChanCount input_offset;
1525 ChanCount output_offset;
1528 typedef std::queue<AutoConnectRequest> AutoConnectQueue;
1529 Glib::Threads::Mutex _auto_connect_queue_lock;
1530 AutoConnectQueue _auto_connect_queue;
1531 guint _latency_recompute_pending;
1533 void auto_connect (const AutoConnectRequest&);
1534 void queue_latency_recompute ();
1536 /* SessionEventManager interface */
1538 void process_event (SessionEvent*);
1539 void set_next_event ();
1540 void cleanup_event (SessionEvent*,int);
1542 /* MIDI Machine Control */
1545 void spp_continue ();
1548 void mmc_deferred_play (MIDI::MachineControl &);
1549 void mmc_stop (MIDI::MachineControl &);
1550 void mmc_step (MIDI::MachineControl &, int);
1551 void mmc_pause (MIDI::MachineControl &);
1552 void mmc_record_pause (MIDI::MachineControl &);
1553 void mmc_record_strobe (MIDI::MachineControl &);
1554 void mmc_record_exit (MIDI::MachineControl &);
1555 void mmc_track_record_status (MIDI::MachineControl &, uint32_t track, bool enabled);
1556 void mmc_fast_forward (MIDI::MachineControl &);
1557 void mmc_rewind (MIDI::MachineControl &);
1558 void mmc_locate (MIDI::MachineControl &, const MIDI::byte *);
1559 void mmc_shuttle (MIDI::MachineControl &mmc, float speed, bool forw);
1560 void mmc_record_enable (MIDI::MachineControl &mmc, size_t track, bool enabled);
1562 struct timeval last_mmc_step;
1565 typedef boost::function<bool()> MidiTimeoutCallback;
1566 typedef std::list<MidiTimeoutCallback> MidiTimeoutList;
1568 MidiTimeoutList midi_timeouts;
1569 bool mmc_step_timeout ();
1570 void send_immediate_mmc (MIDI::MachineControlCommand);
1572 MIDI::byte mtc_msg[16];
1573 MIDI::byte mtc_timecode_bits; /* encoding of SMTPE type for MTC */
1574 MIDI::byte midi_msg[16];
1575 double outbound_mtc_timecode_frame;
1576 Timecode::Time transmitting_timecode_time;
1577 int next_quarter_frame_to_send;
1579 double _frames_per_timecode_frame; /* has to be floating point because of drop frame */
1580 framecnt_t _frames_per_hour;
1581 framecnt_t _timecode_frames_per_hour;
1583 /* cache the most-recently requested time conversions. This helps when we
1584 * have multiple clocks showing the same time (e.g. the transport frame) */
1585 bool last_timecode_valid;
1586 framepos_t last_timecode_when;
1587 Timecode::Time last_timecode;
1589 bool _send_timecode_update; ///< Flag to send a full frame (Timecode) MTC message this cycle
1591 int send_midi_time_code_for_cycle (framepos_t, framepos_t, pframes_t nframes);
1593 LTCEncoder* ltc_encoder;
1594 ltcsnd_sample_t* ltc_enc_buf;
1596 Timecode::TimecodeFormat ltc_enc_tcformat;
1597 int32_t ltc_buf_off;
1598 int32_t ltc_buf_len;
1601 int32_t ltc_enc_byte;
1602 framepos_t ltc_enc_pos;
1604 framepos_t ltc_enc_off;
1606 framepos_t ltc_prev_cycle;
1608 framepos_t ltc_timecode_offset;
1609 bool ltc_timecode_negative_offset;
1611 LatencyRange ltc_out_latency;
1613 void ltc_tx_initialize();
1614 void ltc_tx_cleanup();
1615 void ltc_tx_reset();
1616 void ltc_tx_resync_latency();
1617 void ltc_tx_recalculate_position();
1618 void ltc_tx_parse_offset();
1619 void ltc_tx_send_time_code_for_cycle (framepos_t, framepos_t, double, double, pframes_t nframes);
1621 void reset_record_status ();
1623 int no_roll (pframes_t nframes);
1624 int fail_roll (pframes_t nframes);
1626 bool non_realtime_work_pending() const { return static_cast<bool>(post_transport_work()); }
1627 bool process_can_proceed() const { return !(post_transport_work() & ProcessCannotProceedMask); }
1629 MidiControlUI* midi_control_ui;
1631 int start_midi_thread ();
1633 void set_play_loop (bool yn, double speed);
1634 void unset_play_loop ();
1635 void overwrite_some_buffers (Track *);
1636 void flush_all_inserts ();
1637 int micro_locate (framecnt_t distance);
1638 void locate (framepos_t, bool with_roll, bool with_flush, bool with_loop=false, bool force=false, bool with_mmc=true);
1639 void start_locate (framepos_t, bool with_roll, bool with_flush, bool for_loop_enabled=false, bool force=false);
1640 void force_locate (framepos_t frame, bool with_roll = false);
1641 void set_track_speed (Track *, double speed);
1642 void set_transport_speed (double speed, framepos_t destination_frame, bool abort = false, bool clear_state = false, bool as_default = false);
1643 void stop_transport (bool abort = false, bool clear_state = false);
1644 void start_transport ();
1645 void realtime_stop (bool abort, bool clear_state);
1646 void realtime_locate ();
1647 void non_realtime_start_scrub ();
1648 void non_realtime_set_speed ();
1649 void non_realtime_locate ();
1650 void non_realtime_stop (bool abort, int entry_request_count, bool& finished);
1651 void non_realtime_overwrite (int entry_request_count, bool& finished);
1652 void post_transport ();
1653 void engine_halted ();
1654 void xrun_recovery ();
1655 void set_track_loop (bool);
1656 bool select_playhead_priority_target (framepos_t&);
1657 void follow_playhead_priority ();
1659 /* These are synchronous and so can only be called from within the process
1663 int send_full_time_code (framepos_t, pframes_t nframes);
1664 void send_song_position_pointer (framepos_t);
1666 TempoMap *_tempo_map;
1667 void tempo_map_changed (const PBD::PropertyChange&);
1668 void gui_tempo_map_changed ();
1670 /* edit/mix groups */
1672 int load_route_groups (const XMLNode&, int);
1674 std::list<RouteGroup *> _route_groups;
1675 RouteGroup* _all_route_group;
1679 boost::shared_ptr<Graph> _process_graph;
1681 SerializedRCUManager<RouteList> routes;
1683 void add_routes (RouteList&, bool input_auto_connect, bool output_auto_connect, bool save, PresentationInfo::order_t);
1684 void add_routes_inner (RouteList&, bool input_auto_connect, bool output_auto_connect, PresentationInfo::order_t);
1685 bool _adding_routes_in_progress;
1686 bool _reconnecting_routes_in_progress;
1687 bool _route_deletion_in_progress;
1689 uint32_t destructive_index;
1691 boost::shared_ptr<Route> XMLRouteFactory (const XMLNode&, int);
1692 boost::shared_ptr<Route> XMLRouteFactory_2X (const XMLNode&, int);
1694 void route_processors_changed (RouteProcessorChange);
1696 bool find_route_name (std::string const &, uint32_t& id, std::string& name, bool);
1697 void count_existing_track_channels (ChanCount& in, ChanCount& out);
1698 void auto_connect_route (boost::shared_ptr<Route>, bool, const ChanCount&, const ChanCount&, const ChanCount& io = ChanCount(), const ChanCount& oo = ChanCount());
1699 void midi_output_change_handler (IOChange change, void* /*src*/, boost::weak_ptr<Route> midi_track);
1701 /* track numbering */
1703 void reassign_track_numbers ();
1704 uint32_t _track_number_decimals;
1706 /* solo/mute/notifications */
1708 void route_listen_changed (PBD::Controllable::GroupControlDisposition, boost::weak_ptr<Route>);
1709 void route_mute_changed ();
1710 void route_solo_changed (bool self_solo_change, PBD::Controllable::GroupControlDisposition group_override, boost::weak_ptr<Route>);
1711 void route_solo_isolated_changed (boost::weak_ptr<Route>);
1713 void update_route_solo_state (boost::shared_ptr<RouteList> r = boost::shared_ptr<RouteList>());
1715 void listen_position_changed ();
1716 void solo_control_mode_changed ();
1718 /* REGION MANAGEMENT */
1720 mutable Glib::Threads::Mutex region_lock;
1722 int load_regions (const XMLNode& node);
1723 int load_compounds (const XMLNode& node);
1725 void route_added_to_route_group (RouteGroup *, boost::weak_ptr<Route>);
1726 void route_removed_from_route_group (RouteGroup *, boost::weak_ptr<Route>);
1727 void route_group_property_changed (RouteGroup *);
1731 mutable Glib::Threads::Mutex source_lock;
1734 typedef std::map<PBD::ID,boost::shared_ptr<Source> > SourceMap;
1737 void reset_write_sources (bool mark_write_complete, bool force = false);
1742 int load_sources (const XMLNode& node);
1743 XMLNode& get_sources_as_xml ();
1745 boost::shared_ptr<Source> XMLSourceFactory (const XMLNode&);
1749 void remove_playlist (boost::weak_ptr<Playlist>);
1750 void track_playlist_changed (boost::weak_ptr<Track>);
1751 void playlist_region_added (boost::weak_ptr<Region>);
1752 void playlist_ranges_moved (std::list<Evoral::RangeMove<framepos_t> > const &);
1753 void playlist_regions_extended (std::list<Evoral::Range<framepos_t> > const &);
1755 /* CURVES and AUTOMATION LISTS */
1756 std::map<PBD::ID, AutomationList*> automation_lists;
1758 /* DEFAULT FADE CURVES */
1760 float default_fade_steepness;
1761 float default_fade_msecs;
1765 boost::shared_ptr<Auditioner> auditioner;
1766 void set_audition (boost::shared_ptr<Region>);
1767 void non_realtime_set_audition ();
1768 boost::shared_ptr<Region> pending_audition_region;
1774 int flatten_one_track (AudioTrack&, framepos_t start, framecnt_t cnt);
1776 /* INSERT AND SEND MANAGEMENT */
1778 boost::dynamic_bitset<uint32_t> send_bitset;
1779 boost::dynamic_bitset<uint32_t> aux_send_bitset;
1780 boost::dynamic_bitset<uint32_t> return_bitset;
1781 boost::dynamic_bitset<uint32_t> insert_bitset;
1785 struct space_and_path {
1786 uint32_t blocks; ///< 4kB blocks
1787 bool blocks_unknown; ///< true if blocks is unknown
1792 , blocks_unknown (true)
1796 struct space_and_path_ascending_cmp {
1797 bool operator() (space_and_path a, space_and_path b) {
1798 if (a.blocks_unknown != b.blocks_unknown) {
1799 return !a.blocks_unknown;
1801 return a.blocks > b.blocks;
1805 void setup_raid_path (std::string path);
1807 std::vector<space_and_path> session_dirs;
1808 std::vector<space_and_path>::iterator last_rr_session_dir;
1809 uint32_t _total_free_4k_blocks;
1810 /** If this is true, _total_free_4k_blocks is not definite,
1811 as one or more of the session directories' filesystems
1812 could not report free space.
1814 bool _total_free_4k_blocks_uncertain;
1815 Glib::Threads::Mutex space_lock;
1817 bool no_questions_about_missing_files;
1819 std::string get_best_session_directory_for_new_audio ();
1821 mutable gint _playback_load;
1822 mutable gint _capture_load;
1826 SerializedRCUManager<BundleList> _bundles;
1827 XMLNode* _bundle_xml_node;
1828 int load_bundles (XMLNode const &);
1830 UndoHistory _history;
1831 /** current undo transaction, or 0 */
1832 UndoTransaction* _current_trans;
1833 /** GQuarks to describe the reversible commands that are currently in progress.
1834 * These may be nested, in which case more recently-started commands are toward
1835 * the front of the list.
1837 std::list<GQuark> _current_trans_quarks;
1839 int backend_sync_callback (TransportState, framepos_t);
1841 void process_rtop (SessionEvent*);
1843 void update_latency (bool playback);
1845 XMLNode& state(bool);
1848 typedef std::list<Click*> Clicks;
1851 boost::shared_ptr<IO> _click_io;
1852 boost::shared_ptr<Amp> _click_gain;
1854 Sample* click_emphasis_data;
1855 framecnt_t click_length;
1856 framecnt_t click_emphasis_length;
1857 mutable Glib::Threads::RWLock click_lock;
1859 static const Sample default_click[];
1860 static const framecnt_t default_click_length;
1861 static const Sample default_click_emphasis[];
1862 static const framecnt_t default_click_emphasis_length;
1865 framepos_t _clicks_cleared;
1866 void setup_click_sounds (int which);
1867 void setup_click_sounds (Sample**, Sample const *, framecnt_t*, framecnt_t, std::string const &);
1868 void clear_clicks ();
1869 void click (framepos_t start, framecnt_t nframes);
1871 std::vector<Route*> master_outs;
1873 /* range playback */
1875 std::list<AudioRange> current_audio_range;
1877 void set_play_range (std::list<AudioRange>&, bool leave_rolling);
1878 void unset_play_range ();
1880 /* temporary hacks to allow selection to be pushed from GUI into backend
1881 Whenever we move the selection object into libardour, these will go away.
1883 Evoral::Range<framepos_t> _range_selection;
1884 Evoral::Range<framepos_t> _object_selection;
1889 boost::shared_ptr<Route> _master_out;
1890 boost::shared_ptr<Route> _monitor_out;
1892 void auto_connect_master_bus ();
1894 /* Windows VST support */
1896 long _windows_vst_callback (
1905 int find_all_sources (std::string path, std::set<std::string>& result);
1906 int find_all_sources_across_snapshots (std::set<std::string>& result, bool exclude_this_snapshot);
1908 typedef std::set<boost::shared_ptr<PBD::Controllable> > Controllables;
1909 Glib::Threads::Mutex controllables_lock;
1910 Controllables controllables;
1912 boost::shared_ptr<PBD::Controllable> _solo_cut_control;
1914 void reset_native_file_format();
1915 bool first_file_data_format_reset;
1916 bool first_file_header_format_reset;
1918 void config_changed (std::string, bool);
1920 XMLNode& get_control_protocol_state ();
1922 void set_history_depth (uint32_t depth);
1924 static bool _disable_all_loaded_plugins;
1925 static bool _bypass_all_loaded_plugins;
1927 mutable bool have_looped; ///< Used in ::audible_frame(*)
1929 void update_route_record_state ();
1930 gint _have_rec_enabled_track;
1931 gint _have_rec_disabled_track;
1933 static int ask_about_playlist_deletion (boost::shared_ptr<Playlist>);
1935 /* realtime "apply to set of routes" operations */
1936 template<typename T> SessionEvent*
1937 get_rt_event (boost::shared_ptr<RouteList> rl, T targ, SessionEvent::RTeventCallback after, PBD::Controllable::GroupControlDisposition group_override,
1938 void (Session::*method) (boost::shared_ptr<RouteList>, T, PBD::Controllable::GroupControlDisposition)) {
1939 SessionEvent* ev = new SessionEvent (SessionEvent::RealTimeOperation, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
1940 ev->rt_slot = boost::bind (method, this, rl, targ, group_override);
1941 ev->rt_return = after;
1942 ev->event_loop = PBD::EventLoop::get_event_loop_for_thread ();
1947 /* specialized version realtime "apply to set of routes" operations */
1948 template<typename T1, typename T2> SessionEvent*
1949 get_rt_event (boost::shared_ptr<RouteList> rl, T1 t1arg, T2 t2arg, SessionEvent::RTeventCallback after, PBD::Controllable::GroupControlDisposition group_override,
1950 void (Session::*method) (boost::shared_ptr<RouteList>, T1, T2, PBD::Controllable::GroupControlDisposition)) {
1951 SessionEvent* ev = new SessionEvent (SessionEvent::RealTimeOperation, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
1952 ev->rt_slot = boost::bind (method, this, rl, t1arg, t2arg, group_override);
1953 ev->rt_return = after;
1954 ev->event_loop = PBD::EventLoop::get_event_loop_for_thread ();
1959 /* specialized version realtime "apply to set of controls" operations */
1960 SessionEvent* get_rt_event (boost::shared_ptr<ControlList> cl, double arg, PBD::Controllable::GroupControlDisposition group_override) {
1961 SessionEvent* ev = new SessionEvent (SessionEvent::RealTimeOperation, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
1962 ev->rt_slot = boost::bind (&Session::rt_set_controls, this, cl, arg, group_override);
1963 ev->rt_return = Session::rt_cleanup;
1964 ev->event_loop = PBD::EventLoop::get_event_loop_for_thread ();
1969 void rt_set_controls (boost::shared_ptr<ControlList>, double val, PBD::Controllable::GroupControlDisposition group_override);
1970 void rt_clear_all_solo_state (boost::shared_ptr<RouteList>, bool yn, PBD::Controllable::GroupControlDisposition group_override);
1972 /** temporary list of Diskstreams used only during load of 2.X sessions */
1973 std::list<boost::shared_ptr<Diskstream> > _diskstreams_2X;
1975 void set_session_range_location (framepos_t, framepos_t);
1977 void setup_midi_machine_control ();
1979 void step_edit_status_change (bool);
1980 uint32_t _step_editors;
1982 /** true if timecode transmission by the transport is suspended, otherwise false */
1983 mutable gint _suspend_timecode_transmission;
1985 void update_locations_after_tempo_map_change (const Locations::LocationList &);
1987 void start_time_changed (framepos_t);
1988 void end_time_changed (framepos_t);
1990 void set_track_monitor_input_status (bool);
1991 framepos_t compute_stop_limit () const;
1993 boost::shared_ptr<Speakers> _speakers;
1994 void load_nested_sources (const XMLNode& node);
1996 /** The directed graph of routes that is currently being used for audio processing
1997 and solo/mute computations.
1999 GraphEdges _current_route_graph;
2001 void ensure_route_presentation_info_gap (PresentationInfo::order_t, uint32_t gap_size);
2002 bool ignore_route_processor_changes;
2004 MidiClockTicker* midi_clock;
2006 boost::shared_ptr<IO> _ltc_input;
2007 boost::shared_ptr<IO> _ltc_output;
2009 /* Scene Changing */
2010 SceneChanger* _scene_changer;
2012 /* persistent, non-track related MIDI ports */
2013 MidiPortManager* _midi_ports;
2014 MIDI::MachineControl* _mmc;
2017 void setup_click ();
2018 void setup_click_state (const XMLNode*);
2019 void setup_bundles ();
2021 void save_as_bring_callback (uint32_t, uint32_t, std::string);
2023 static int get_session_info_from_path (XMLTree& state_tree, const std::string& xmlpath);
2024 static const uint32_t session_end_shift;
2026 std::string _template_state_dir;
2028 VCAManager* _vca_manager;
2030 boost::shared_ptr<Route> get_midi_nth_route_by_id (PresentationInfo::order_t n) const;
2032 std::string created_with;
2034 bool _midi_regions_use_bbt_beats;
2038 } // namespace ARDOUR
2040 #endif /* __ardour_session_h__ */