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/reallocpool.h"
46 #include "pbd/statefuldestructible.h"
47 #include "pbd/signals.h"
50 #include "lua/luastate.h"
52 #include "evoral/Range.hpp"
54 #include "midi++/types.h"
55 #include "midi++/mmc.h"
57 #include "timecode/time.h"
59 #include "ardour/ardour.h"
60 #include "ardour/chan_count.h"
61 #include "ardour/delivery.h"
62 #include "ardour/interthread_info.h"
63 #include "ardour/luascripting.h"
64 #include "ardour/location.h"
65 #include "ardour/monitor_processor.h"
66 #include "ardour/rc_configuration.h"
67 #include "ardour/session_configuration.h"
68 #include "ardour/session_event.h"
69 #include "ardour/interpolation.h"
70 #include "ardour/route.h"
71 #include "ardour/route_graph.h"
77 typedef struct _AEffect AEffect;
87 class ControllableDescriptor;
102 class AudioFileSource;
107 class AutomationList;
120 class MidiClockTicker;
122 class MidiPortManager;
141 class SessionDirectory;
142 class SessionMetadata;
143 class SessionPlaylists;
149 class WindowsVSTPlugin;
151 extern void setup_enum_writer ();
153 class LIBARDOUR_API SessionException: public std::exception {
155 explicit SessionException(const std::string msg) : _message(msg) {}
156 virtual ~SessionException() throw() {}
158 virtual const char* what() const throw() { return _message.c_str(); }
161 std::string _message;
164 /** Ardour Session */
165 class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::ScopedConnectionList, public SessionEventManager
174 /* a new session might have non-empty mix_template, an existing session should always have an empty one.
175 the bus profile can be null if no master out bus is required.
178 Session (AudioEngine&,
179 const std::string& fullpath,
180 const std::string& snapshot_name,
181 BusProfile* bus_profile = 0,
182 std::string mix_template = "");
186 static int get_info_from_path (const std::string& xmlpath, float& sample_rate, SampleFormat& data_format);
187 static std::string get_snapshot_from_instant (const std::string& session_dir);
189 /** a monotonic counter used for naming user-visible things uniquely
190 * (curently the sidechain port).
191 * Use sparingly to keep the numbers low, prefer PBD::ID for all
192 * internal, not user-visible IDs */
193 static unsigned int next_name_id ();
195 std::string path() const { return _path; }
196 std::string name() const { return _name; }
197 std::string snap_name() const { return _current_snapshot_name; }
198 std::string raid_path () const;
199 bool path_is_within_session (const std::string&);
201 bool writable() const { return _writable; }
204 bool dirty() const { return _state_of_the_state & Dirty; }
205 void set_deletion_in_progress ();
206 void clear_deletion_in_progress ();
207 bool reconnection_in_progress() const { return _reconnecting_routes_in_progress; }
208 bool deletion_in_progress() const { return _state_of_the_state & Deletion; }
209 bool routes_deletion_in_progress() const { return _route_deletion_in_progress; }
210 bool peaks_cleanup_in_progres() const { return _state_of_the_state & PeakCleanup; }
212 PBD::Signal0<void> DirtyChanged;
214 PBD::Signal1<void, bool> RouteAddedOrRemoved;
216 const SessionDirectory& session_directory () const { return *(_session_dir.get()); }
218 static PBD::Signal1<void,std::string> Dialog;
220 PBD::Signal0<void> BatchUpdateStart;
221 PBD::Signal0<void> BatchUpdateEnd;
223 int ensure_subdirs ();
225 std::string automation_dir () const; ///< Automation data
226 std::string analysis_dir () const; ///< Analysis data
227 std::string plugins_dir () const; ///< Plugin state
228 std::string externals_dir () const; ///< Links to external files
230 std::string construct_peak_filepath (const std::string& audio_path, const bool in_session = false, const bool old_peak_name = false) const;
232 bool audio_source_name_is_unique (const std::string& name);
233 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);
234 std::string new_audio_source_path_for_embedded (const std::string& existing_path);
235 std::string new_audio_source_path (const std::string&, uint32_t nchans, uint32_t chan, bool destructive, bool take_required);
236 std::string new_midi_source_path (const std::string&);
237 /** create a new track or bus from a template (XML path)
238 * @param how_many how many tracks or busses to create
239 * @param template_path path to xml template file
240 * @param name name (prefix) of the route to create
241 * @param pd Playlist disposition
242 * @return list of newly created routes
244 RouteList new_route_from_template (uint32_t how_many, const std::string& template_path, const std::string& name, PlaylistDisposition pd = NewPlaylist);
245 RouteList new_route_from_template (uint32_t how_many, XMLNode&, const std::string& name, PlaylistDisposition pd = NewPlaylist);
246 std::vector<std::string> get_paths_for_new_sources (bool allow_replacing, const std::string& import_file_path, uint32_t channels);
248 int bring_all_sources_into_session (boost::function<void(uint32_t,uint32_t,std::string)> callback);
250 void process (pframes_t nframes);
252 BufferSet& get_silent_buffers (ChanCount count = ChanCount::ZERO);
253 BufferSet& get_noinplace_buffers (ChanCount count = ChanCount::ZERO);
254 BufferSet& get_scratch_buffers (ChanCount count = ChanCount::ZERO, bool silence = true);
255 BufferSet& get_route_buffers (ChanCount count = ChanCount::ZERO, bool silence = true);
256 BufferSet& get_mix_buffers (ChanCount count = ChanCount::ZERO);
258 bool have_rec_enabled_track () const;
259 bool have_rec_disabled_track () const;
261 bool have_captured() const { return _have_captured; }
263 void refill_all_track_buffers ();
264 Butler* butler() { return _butler; }
265 void butler_transport_work ();
267 void refresh_disk_space ();
269 int load_diskstreams_2X (XMLNode const &, int);
271 int load_routes (const XMLNode&, int);
272 boost::shared_ptr<RouteList> get_routes() const {
273 return routes.reader ();
276 boost::shared_ptr<RouteList> get_tracks() const;
277 boost::shared_ptr<RouteList> get_routes_with_internal_returns() const;
278 boost::shared_ptr<RouteList> get_routes_with_regions_at (framepos_t const) const;
280 uint32_t nroutes() const { return routes.reader()->size(); }
281 uint32_t ntracks () const;
282 uint32_t nbusses () const;
284 boost::shared_ptr<BundleList> bundles () {
285 return _bundles.reader ();
288 struct LIBARDOUR_API RoutePublicOrderSorter {
289 bool operator() (boost::shared_ptr<Route>, boost::shared_ptr<Route> b);
292 void set_order_hint (int32_t order_hint) {_order_hint = order_hint;};
293 void notify_remote_id_change ();
294 void sync_order_keys ();
296 template<class T> void foreach_route (T *obj, void (T::*func)(Route&), bool sort = true);
297 template<class T> void foreach_route (T *obj, void (T::*func)(boost::shared_ptr<Route>), bool sort = true);
298 template<class T, class A> void foreach_route (T *obj, void (T::*func)(Route&, A), A arg, bool sort = true);
300 static char session_name_is_legal (const std::string&);
301 bool io_name_is_legal (const std::string&);
302 boost::shared_ptr<Route> route_by_name (std::string);
303 boost::shared_ptr<Route> route_by_id (PBD::ID);
304 boost::shared_ptr<Route> route_by_remote_id (uint32_t id);
305 boost::shared_ptr<Route> route_by_selected_count (uint32_t cnt);
306 boost::shared_ptr<Track> track_by_diskstream_id (PBD::ID);
307 void routes_using_input_from (const std::string& str, RouteList& rl);
309 bool route_name_unique (std::string) const;
310 bool route_name_internal (std::string) const;
312 uint32_t track_number_decimals () const {
313 return _track_number_decimals;
316 bool get_record_enabled() const {
317 return (record_status () >= Enabled);
320 RecordState record_status() const {
321 return (RecordState) g_atomic_int_get (&_record_status);
324 bool actively_recording () const {
325 return record_status() == Recording;
328 bool record_enabling_legal () const;
329 void maybe_enable_record ();
330 void disable_record (bool rt_context, bool force = false);
331 void step_back_from_record ();
333 void set_all_tracks_record_enabled(bool);
335 void maybe_write_autosave ();
337 /* Emitted when all i/o connections are complete */
339 PBD::Signal0<void> IOConnectionsComplete;
341 /* Timecode status signals */
342 PBD::Signal1<void, bool> MTCSyncStateChanged;
343 PBD::Signal1<void, bool> LTCSyncStateChanged;
345 /* Record status signals */
347 PBD::Signal0<void> RecordStateChanged; /* signals changes in recording state (i.e. are we recording) */
348 /* XXX may 2015: paul says: it isn't clear to me that this has semantics that cannot be inferrred
349 from the previous signal and session state.
351 PBD::Signal0<void> RecordArmStateChanged; /* signals changes in recording arming */
353 /* Emited when session is loaded */
354 PBD::Signal0<void> SessionLoaded;
356 /* Transport mechanism signals */
358 /** Emitted on the following changes in transport state:
359 * - stop (from the butler thread)
360 * - change in whether or not we are looping (from the process thread)
361 * - change in the play range (from the process thread)
362 * - start (from the process thread)
365 PBD::Signal0<void> TransportStateChange;
367 PBD::Signal1<void,framepos_t> PositionChanged; /* sent after any non-sequential motion */
368 PBD::Signal1<void,framepos_t> Xrun;
369 PBD::Signal0<void> TransportLooped;
371 /** emitted when a locate has occurred */
372 PBD::Signal0<void> Located;
374 PBD::Signal1<void,RouteList&> RouteAdded;
375 /** Emitted when a property of one of our route groups changes.
376 * The parameter is the RouteGroup that has changed.
378 PBD::Signal1<void, RouteGroup *> RouteGroupPropertyChanged;
379 /** Emitted when a route is added to one of our route groups.
380 * First parameter is the RouteGroup, second is the route.
382 PBD::Signal2<void, RouteGroup *, boost::weak_ptr<Route> > RouteAddedToRouteGroup;
383 /** Emitted when a route is removed from one of our route groups.
384 * First parameter is the RouteGroup, second is the route.
386 PBD::Signal2<void, RouteGroup *, boost::weak_ptr<Route> > RouteRemovedFromRouteGroup;
388 /* Step Editing status changed */
389 PBD::Signal1<void,bool> StepEditStatusChange;
391 /* Timecode state signals */
392 PBD::Signal0<void> MtcOrLtcInputPortChanged;
394 void queue_event (SessionEvent*);
396 void request_roll_at_and_return (framepos_t start, framepos_t return_to);
397 void request_bounded_roll (framepos_t start, framepos_t end);
398 void request_stop (bool abort = false, bool clear_state = false);
399 void request_locate (framepos_t frame, bool with_roll = false);
401 void request_play_loop (bool yn, bool leave_rolling = false);
402 bool get_play_loop () const { return play_loop; }
404 framepos_t last_transport_start () const { return _last_roll_location; }
407 void use_rf_shuttle_speed ();
408 void allow_auto_play (bool yn);
409 void request_transport_speed (double speed, bool as_default = true);
410 void request_transport_speed_nonzero (double, bool as_default = true);
411 void request_overwrite_buffer (Track *);
412 void adjust_playback_buffering();
413 void adjust_capture_buffering();
414 void request_track_speed (Track *, double speed);
415 void request_input_change_handling ();
417 bool locate_pending() const { return static_cast<bool>(post_transport_work()&PostTransportLocate); }
418 bool transport_locked () const;
422 framepos_t current_end_frame () const;
423 framepos_t current_start_frame () const;
424 /** "actual" sample rate of session, set by current audioengine rate, pullup/down etc. */
425 framecnt_t frame_rate () const { return _current_frame_rate; }
426 /** "native" sample rate of session, regardless of current audioengine rate, pullup/down etc */
427 framecnt_t nominal_frame_rate () const { return _nominal_frame_rate; }
428 framecnt_t frames_per_hour () const { return _frames_per_hour; }
430 double frames_per_timecode_frame() const { return _frames_per_timecode_frame; }
431 framecnt_t timecode_frames_per_hour() const { return _timecode_frames_per_hour; }
433 MIDI::byte get_mtc_timecode_bits() const {
434 return mtc_timecode_bits; /* encoding of SMTPE type for MTC */
437 double timecode_frames_per_second() const;
438 bool timecode_drop_frames() const;
442 Locations *locations() { return _locations; }
444 PBD::Signal1<void,Location*> auto_loop_location_changed;
445 PBD::Signal1<void,Location*> auto_punch_location_changed;
446 PBD::Signal0<void> locations_modified;
448 void set_auto_punch_location (Location *);
449 void set_auto_loop_location (Location *);
450 void set_session_extents (framepos_t start, framepos_t end);
451 int location_name(std::string& result, std::string base = std::string(""));
453 pframes_t get_block_size() const { return current_block_size; }
454 framecnt_t worst_output_latency () const { return _worst_output_latency; }
455 framecnt_t worst_input_latency () const { return _worst_input_latency; }
456 framecnt_t worst_track_latency () const { return _worst_track_latency; }
457 framecnt_t worst_playback_latency () const { return _worst_output_latency + _worst_track_latency; }
460 std::string new_parent_folder; /* parent folder where new session folder will be created */
461 std::string new_name; /* name of newly saved session */
462 bool switch_to; /* true if we should be working on newly saved session after save-as; false otherwise */
463 bool include_media; /* true if the newly saved session should contain references to media */
464 bool copy_media; /* true if media files (audio, media, etc) should be copied into newly saved session; false otherwise */
465 bool copy_external; /* true if external media should be consolidated into the newly saved session; false otherwise */
467 std::string final_session_folder_name; /* filled in by * Session::save_as(), provides full path to newly saved session */
469 /* emitted as we make progress. 3 arguments passed to signal
472 * 1: percentage complete measured as a fraction (0-1.0) of
473 * total data copying done.
474 * 2: number of files copied so far
475 * 3: total number of files to copy
477 * Handler should return true for save-as to continue, or false
478 * to stop (and remove all evidence of partial save-as).
480 PBD::Signal3<bool,float,int64_t,int64_t> Progress;
482 /* if save_as() returns non-zero, this string will indicate the reason why.
484 std::string failure_message;
487 int save_as (SaveAs&);
489 * @param snapshot_name name of the session (use an empty string for the current name)
490 * @param pending save a 'recovery', not full state (default: false)
491 * @param switch_to_snapshot switch to given snapshot after saving (default: false)
492 * @param template_only save a session template (default: false)
493 * @return zero on success
495 int save_state (std::string snapshot_name, bool pending = false, bool switch_to_snapshot = false, bool template_only = false);
496 int restore_state (std::string snapshot_name);
497 int save_template (std::string template_name, bool replace_existing = false);
498 int save_history (std::string snapshot_name = "");
499 int restore_history (std::string snapshot_name);
500 void remove_state (std::string snapshot_name);
501 void rename_state (std::string old_name, std::string new_name);
502 void remove_pending_capture_state ();
503 int rename (const std::string&);
504 bool get_nsm_state () const { return _under_nsm_control; }
505 void set_nsm_state (bool state) { _under_nsm_control = state; }
506 bool save_default_options ();
508 PBD::Signal1<void,std::string> StateSaved;
509 PBD::Signal0<void> StateReady;
511 /* emitted when session needs to be saved due to some internal
512 * event or condition (i.e. not in response to a user request).
514 * Only one object should
515 * connect to this signal and take responsibility.
517 * Argument is the snapshot name to use when saving.
519 PBD::Signal1<void,std::string> SaveSessionRequested;
521 /* emitted during a session save to allow other entities to add state, via
522 * extra XML, to the session state
524 PBD::Signal0<void> SessionSaveUnderway;
526 std::vector<std::string> possible_states() const;
527 static std::vector<std::string> possible_states (std::string path);
529 XMLNode& get_state();
530 int set_state(const XMLNode& node, int version); // not idempotent
531 XMLNode& get_template();
533 /// The instant xml file is written to the session directory
534 void add_instant_xml (XMLNode&, bool write_to_config = true);
535 XMLNode* instant_xml (const std::string& str);
537 enum StateOfTheState {
542 InitialConnecting = 0x8,
548 StateOfTheState state_of_the_state() const { return _state_of_the_state; }
550 class StateProtector {
552 StateProtector (Session* s) : _session (s) {
553 g_atomic_int_inc (&s->_suspend_save);
556 if (g_atomic_int_dec_and_test (&_session->_suspend_save)) {
557 while (_session->_save_queued) {
558 _session->_save_queued = false;
559 _session->save_state ("");
567 void add_route_group (RouteGroup *);
568 void remove_route_group (RouteGroup&);
569 void reorder_route_groups (std::list<RouteGroup*>);
571 RouteGroup* route_group_by_name (std::string);
572 RouteGroup& all_route_group() const;
574 PBD::Signal1<void,RouteGroup*> route_group_added;
575 PBD::Signal0<void> route_group_removed;
576 PBD::Signal0<void> route_groups_reordered;
578 void foreach_route_group (boost::function<void(RouteGroup*)> f) {
579 for (std::list<RouteGroup *>::iterator i = _route_groups.begin(); i != _route_groups.end(); ++i) {
584 std::list<RouteGroup*> const & route_groups () const {
585 return _route_groups;
588 /* fundamental operations. duh. */
590 std::list<boost::shared_ptr<AudioTrack> > new_audio_track (
593 TrackMode mode = Normal,
594 RouteGroup* route_group = 0,
595 uint32_t how_many = 1,
596 std::string name_template = ""
599 RouteList new_audio_route (
600 int input_channels, int output_channels, RouteGroup* route_group, uint32_t how_many, std::string name_template = ""
603 std::list<boost::shared_ptr<MidiTrack> > new_midi_track (
604 const ChanCount& input, const ChanCount& output,
605 boost::shared_ptr<PluginInfo> instrument = boost::shared_ptr<PluginInfo>(),
606 TrackMode mode = Normal,
607 RouteGroup* route_group = 0, uint32_t how_many = 1, std::string name_template = ""
610 RouteList new_midi_route (RouteGroup* route_group, uint32_t how_many, std::string name_template = "", boost::shared_ptr<PluginInfo> instrument = boost::shared_ptr<PluginInfo>());
612 void remove_routes (boost::shared_ptr<RouteList>);
613 void remove_route (boost::shared_ptr<Route>);
615 void resort_routes ();
616 void resort_routes_using (boost::shared_ptr<RouteList>);
618 AudioEngine & engine() { return _engine; }
619 AudioEngine const & engine () const { return _engine; }
621 static std::string default_track_name_pattern (DataType);
625 framepos_t transport_frame () const {return _transport_frame; }
626 framepos_t record_location () const {return _last_record_location; }
627 framepos_t audible_frame () const;
628 framepos_t requested_return_frame() const { return _requested_return_frame; }
629 void set_requested_return_frame(framepos_t return_to);
643 void sync_time_vars();
645 void bbt_time (framepos_t when, Timecode::BBT_Time&);
646 void timecode_to_sample(Timecode::Time& timecode, framepos_t& sample, bool use_offset, bool use_subframes) const;
647 void sample_to_timecode(framepos_t sample, Timecode::Time& timecode, bool use_offset, bool use_subframes) const;
648 void timecode_time (Timecode::Time &);
649 void timecode_time (framepos_t when, Timecode::Time&);
650 void timecode_time_subframes (framepos_t when, Timecode::Time&);
652 void timecode_duration (framecnt_t, Timecode::Time&) const;
653 void timecode_duration_string (char *, size_t len, framecnt_t) const;
655 framecnt_t convert_to_frames (AnyTime const & position);
656 framecnt_t any_duration_to_frames (framepos_t position, AnyTime const & duration);
658 static PBD::Signal1<void, framepos_t> StartTimeChanged;
659 static PBD::Signal1<void, framepos_t> EndTimeChanged;
661 void request_sync_source (Slave*);
662 bool synced_to_engine() const { return _slave && config.get_external_sync() && Config->get_sync_source() == Engine; }
663 bool synced_to_mtc () const { return config.get_external_sync() && Config->get_sync_source() == MTC && g_atomic_int_get (const_cast<gint*>(&_mtc_active)); }
664 bool synced_to_ltc () const { return config.get_external_sync() && Config->get_sync_source() == LTC && g_atomic_int_get (const_cast<gint*>(&_ltc_active)); }
666 double transport_speed() const { return _transport_speed; }
667 bool transport_stopped() const { return _transport_speed == 0.0f; }
668 bool transport_rolling() const { return _transport_speed != 0.0f; }
670 bool silent () { return _silent; }
672 TempoMap& tempo_map() { return *_tempo_map; }
673 const TempoMap& tempo_map() const { return *_tempo_map; }
675 unsigned int get_xrun_count () const {return _xrun_count; }
676 void reset_xrun_count () {_xrun_count = 0; }
680 boost::shared_ptr<Region> find_whole_file_parent (boost::shared_ptr<Region const>) const;
682 boost::shared_ptr<Region> XMLRegionFactory (const XMLNode&, bool full);
683 boost::shared_ptr<AudioRegion> XMLAudioRegionFactory (const XMLNode&, bool full);
684 boost::shared_ptr<MidiRegion> XMLMidiRegionFactory (const XMLNode&, bool full);
686 /* source management */
688 void import_files (ImportStatus&);
689 bool sample_rate_convert (ImportStatus&, std::string infile, std::string& outfile);
690 std::string build_tmp_convert_name (std::string file);
692 boost::shared_ptr<ExportHandler> get_export_handler ();
693 boost::shared_ptr<ExportStatus> get_export_status ();
695 int start_audio_export (framepos_t position);
697 PBD::Signal1<int, framecnt_t> ProcessExport;
698 static PBD::Signal2<void,std::string, std::string> Exported;
700 void add_source (boost::shared_ptr<Source>);
701 void remove_source (boost::weak_ptr<Source>);
703 void cleanup_regions();
704 bool can_cleanup_peakfiles () const;
705 int cleanup_peakfiles ();
706 int cleanup_sources (CleanupReport&);
707 int cleanup_trash_sources (CleanupReport&);
709 int destroy_sources (std::list<boost::shared_ptr<Source> >);
711 int remove_last_capture ();
713 /** handlers should return 0 for "everything OK", and any other value for
714 * "cannot setup audioengine".
716 static PBD::Signal1<int,uint32_t> AudioEngineSetupRequired;
718 /** handlers should return -1 for "stop cleanup",
719 0 for "yes, delete this playlist",
720 1 for "no, don't delete this playlist".
722 static PBD::Signal1<int,boost::shared_ptr<Playlist> > AskAboutPlaylistDeletion;
724 /** handlers should return 0 for "ignore the rate mismatch",
725 !0 for "do not use this session"
727 static PBD::Signal2<int, framecnt_t, framecnt_t> AskAboutSampleRateMismatch;
729 /** non interactive message */
730 static PBD::Signal2<void, framecnt_t, framecnt_t> NotifyAboutSampleRateMismatch;
732 /** handlers should return !0 for use pending state, 0 for ignore it.
734 static PBD::Signal0<int> AskAboutPendingState;
736 boost::shared_ptr<AudioFileSource> create_audio_source_for_session (
737 size_t, std::string const &, uint32_t, bool destructive);
739 boost::shared_ptr<MidiSource> create_midi_source_for_session (std::string const &);
740 boost::shared_ptr<MidiSource> create_midi_source_by_stealing_name (boost::shared_ptr<Track>);
742 boost::shared_ptr<Source> source_by_id (const PBD::ID&);
743 boost::shared_ptr<AudioFileSource> audio_source_by_path_and_channel (const std::string&, uint16_t) const;
744 boost::shared_ptr<MidiSource> midi_source_by_path (const std::string&) const;
745 uint32_t count_sources_by_origin (const std::string&);
747 void add_playlist (boost::shared_ptr<Playlist>, bool unused = false);
749 /* Curves and AutomationLists (TODO when they go away) */
750 void add_automation_list(AutomationList*);
754 boost::shared_ptr<Auditioner> the_auditioner() { return auditioner; }
755 void audition_playlist ();
756 void audition_region (boost::shared_ptr<Region>);
757 void cancel_audition ();
758 bool is_auditioning () const;
760 PBD::Signal1<void,bool> AuditionActive;
763 void register_lua_function (const std::string&, const std::string&, const LuaScriptParamList&);
764 void unregister_lua_function (const std::string& name);
765 std::vector<std::string> registered_lua_functions ();
766 uint32_t registered_lua_function_count () const { return _n_lua_scripts; }
767 void scripts_changed (); // called from lua, updates _n_lua_scripts
769 /* flattening stuff */
771 boost::shared_ptr<Region> write_one_track (Track&, framepos_t start, framepos_t end,
772 bool overwrite, std::vector<boost::shared_ptr<Source> >&, InterThreadInfo& wot,
773 boost::shared_ptr<Processor> endpoint,
774 bool include_endpoint, bool for_export, bool for_freeze);
775 int freeze_all (InterThreadInfo&);
777 /* session-wide solo/mute/rec-enable */
779 bool soloing() const { return _non_soloed_outs_muted; }
780 bool listening() const { return _listen_cnt > 0; }
781 bool solo_isolated() const { return _solo_isolated_cnt > 0; }
783 static const SessionEvent::RTeventCallback rt_cleanup;
785 void set_solo (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, PBD::Controllable::GroupControlDisposition group_override = PBD::Controllable::UseGroup);
786 void clear_all_solo_state (boost::shared_ptr<RouteList>);
787 void set_just_one_solo (boost::shared_ptr<Route>, bool, SessionEvent::RTeventCallback after = rt_cleanup);
788 void set_mute (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, PBD::Controllable::GroupControlDisposition group_override = PBD::Controllable::UseGroup);
789 void set_listen (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, PBD::Controllable::GroupControlDisposition group_override = PBD::Controllable::UseGroup);
790 void set_record_enabled (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, PBD::Controllable::GroupControlDisposition group_override = PBD::Controllable::UseGroup);
791 void set_record_safe (boost::shared_ptr<RouteList>, bool yn, SessionEvent::RTeventCallback after = rt_cleanup, PBD::Controllable::GroupControlDisposition group_override = PBD::Controllable::UseGroup);
792 void set_solo_isolated (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, PBD::Controllable::GroupControlDisposition group_override = PBD::Controllable::UseGroup);
793 void set_monitoring (boost::shared_ptr<RouteList>, MonitorChoice, SessionEvent::RTeventCallback after = rt_cleanup, PBD::Controllable::GroupControlDisposition group_override = PBD::Controllable::UseGroup);
794 void set_exclusive_input_active (boost::shared_ptr<RouteList> rt, bool onoff, bool flip_others = false);
796 PBD::Signal1<void,bool> SoloActive;
797 PBD::Signal0<void> SoloChanged;
798 PBD::Signal0<void> IsolatedChanged;
799 PBD::Signal0<void> MonitorChanged;
801 PBD::Signal0<void> session_routes_reconnected;
803 /* monitor/master out */
805 void add_monitor_section ();
806 void reset_monitor_section ();
807 void remove_monitor_section ();
808 bool monitor_active() const { return (_monitor_out && _monitor_out->monitor_control () && _monitor_out->monitor_control ()->monitor_active()); }
810 boost::shared_ptr<Route> monitor_out() const { return _monitor_out; }
811 boost::shared_ptr<Route> master_out() const { return _master_out; }
813 void globally_add_internal_sends (boost::shared_ptr<Route> dest, Placement p, bool);
814 void globally_set_send_gains_from_track (boost::shared_ptr<Route> dest);
815 void globally_set_send_gains_to_zero (boost::shared_ptr<Route> dest);
816 void globally_set_send_gains_to_unity (boost::shared_ptr<Route> dest);
817 void add_internal_sends (boost::shared_ptr<Route> dest, Placement p, boost::shared_ptr<RouteList> senders);
818 void add_internal_send (boost::shared_ptr<Route>, int, boost::shared_ptr<Route>);
819 void add_internal_send (boost::shared_ptr<Route>, boost::shared_ptr<Processor>, boost::shared_ptr<Route>);
821 static void set_disable_all_loaded_plugins (bool yn) {
822 _disable_all_loaded_plugins = yn;
824 static bool get_disable_all_loaded_plugins() {
825 return _disable_all_loaded_plugins;
827 static void set_bypass_all_loaded_plugins (bool yn) {
828 _bypass_all_loaded_plugins = yn;
830 static bool get_bypass_all_loaded_plugins() {
831 return _bypass_all_loaded_plugins;
834 uint32_t next_send_id();
835 uint32_t next_aux_send_id();
836 uint32_t next_return_id();
837 uint32_t next_insert_id();
838 void mark_send_id (uint32_t);
839 void mark_aux_send_id (uint32_t);
840 void mark_return_id (uint32_t);
841 void mark_insert_id (uint32_t);
842 void unmark_send_id (uint32_t);
843 void unmark_aux_send_id (uint32_t);
844 void unmark_return_id (uint32_t);
845 void unmark_insert_id (uint32_t);
847 /* s/w "RAID" management */
849 boost::optional<framecnt_t> available_capture_duration();
853 void add_bundle (boost::shared_ptr<Bundle>, bool emit_signal = true);
854 void remove_bundle (boost::shared_ptr<Bundle>);
855 boost::shared_ptr<Bundle> bundle_by_name (std::string) const;
857 PBD::Signal0<void> BundleAddedOrRemoved;
861 /* History (for editors, mixers, UIs etc.) */
863 /** Undo some transactions.
864 * @param n Number of transactions to undo.
866 void undo (uint32_t n) {
870 void redo (uint32_t n) {
874 UndoHistory& history() { return _history; }
876 uint32_t undo_depth() const { return _history.undo_depth(); }
877 uint32_t redo_depth() const { return _history.redo_depth(); }
878 std::string next_undo() const { return _history.next_undo(); }
879 std::string next_redo() const { return _history.next_redo(); }
881 /** begin collecting undo information
883 * This call must always be followed by either
884 * begin_reversible_command() or commit_reversible_command()
886 * @param cmd_name human readable name for the undo operation
888 void begin_reversible_command (const std::string& cmd_name);
889 void begin_reversible_command (GQuark);
890 /** abort an open undo command
891 * This must only be called after begin_reversible_command ()
893 void abort_reversible_command ();
894 /** finalize an undo command and commit pending transactions
896 * This must only be called after begin_reversible_command ()
897 * @param cmd (additional) command to add
899 void commit_reversible_command (Command* cmd = 0);
901 void add_command (Command *const cmd);
903 /** create an StatefulDiffCommand from the given object and add it to the stack.
905 * This function must only be called after begin_reversible_command.
906 * Failing to do so may lead to a crash.
908 * @param sfd the object to diff
909 * @returns the allocated StatefulDiffCommand (already added via add_command)
911 PBD::StatefulDiffCommand* add_stateful_diff_command (boost::shared_ptr<PBD::StatefulDestructible> sfd);
913 /** @return The list of operations that are currently in progress */
914 std::list<GQuark> const & current_operations () {
915 return _current_trans_quarks;
918 bool operation_in_progress (GQuark) const;
920 void add_commands (std::vector<Command*> const & cmds);
922 std::map<PBD::ID,PBD::StatefulDestructible*> registry;
924 // these commands are implemented in libs/ardour/session_command.cc
925 Command* memento_command_factory(XMLNode* n);
926 Command* stateful_diff_command_factory (XMLNode *);
927 void register_with_memento_command_factory(PBD::ID, PBD::StatefulDestructible*);
931 boost::shared_ptr<IO> click_io() { return _click_io; }
932 boost::shared_ptr<Amp> click_gain() { return _click_gain; }
934 /* disk, buffer loads */
936 uint32_t playback_load ();
937 uint32_t capture_load ();
941 void request_play_range (std::list<AudioRange>*, bool leave_rolling = false);
942 void request_cancel_play_range ();
943 bool get_play_range () const { return _play_range; }
945 void maybe_update_session_range (framepos_t, framepos_t);
947 /* temporary hacks to allow selection to be pushed from GUI into backend.
948 Whenever we move the selection object into libardour, these will go away.
950 void set_range_selection (framepos_t start, framepos_t end);
951 void set_object_selection (framepos_t start, framepos_t end);
952 void clear_range_selection ();
953 void clear_object_selection ();
955 /* buffers for gain and pan */
957 gain_t* gain_automation_buffer () const;
958 gain_t* trim_automation_buffer () const;
959 gain_t* send_gain_automation_buffer () const;
960 pan_t** pan_automation_buffer () const;
962 void ensure_buffer_set (BufferSet& buffers, const ChanCount& howmany);
966 static int vst_current_loading_id;
967 static const char* vst_can_do_strings[];
968 static const int vst_can_do_string_count;
970 static intptr_t vst_callback (
979 static PBD::Signal0<void> SendFeedback;
983 boost::shared_ptr<Speakers> get_speakers ();
987 boost::shared_ptr<Processor> processor_by_id (PBD::ID) const;
989 boost::shared_ptr<PBD::Controllable> controllable_by_id (const PBD::ID&);
990 boost::shared_ptr<PBD::Controllable> controllable_by_descriptor (const PBD::ControllableDescriptor&);
992 void add_controllable (boost::shared_ptr<PBD::Controllable>);
993 void remove_controllable (PBD::Controllable*);
995 boost::shared_ptr<PBD::Controllable> solo_cut_control() const;
997 SessionConfiguration config;
999 bool exporting () const {
1003 bool bounce_processing() const {
1004 return _bounce_processing_active;
1007 /* this is a private enum, but setup_enum_writer() needs it,
1008 and i can't find a way to give that function
1009 friend access. sigh.
1012 enum PostTransportWork {
1013 PostTransportStop = 0x1,
1014 PostTransportDuration = 0x2,
1015 PostTransportLocate = 0x4,
1016 PostTransportRoll = 0x8,
1017 PostTransportAbort = 0x10,
1018 PostTransportOverWrite = 0x20,
1019 PostTransportSpeed = 0x40,
1020 PostTransportAudition = 0x80,
1021 PostTransportReverse = 0x100,
1022 PostTransportInputChange = 0x200,
1023 PostTransportCurveRealloc = 0x400,
1024 PostTransportClearSubstate = 0x800,
1025 PostTransportAdjustPlaybackBuffering = 0x1000,
1026 PostTransportAdjustCaptureBuffering = 0x2000
1035 SlaveState slave_state() const { return _slave_state; }
1036 Slave* slave() const { return _slave; }
1038 boost::shared_ptr<SessionPlaylists> playlists;
1040 void send_mmc_locate (framepos_t);
1041 void queue_full_time_code () { _send_timecode_update = true; }
1042 void queue_song_position_pointer () { /* currently does nothing */ }
1044 bool step_editing() const { return (_step_editors > 0); }
1046 void request_suspend_timecode_transmission ();
1047 void request_resume_timecode_transmission ();
1048 bool timecode_transmission_suspended () const;
1050 std::vector<std::string> source_search_path(DataType) const;
1051 void ensure_search_path_includes (const std::string& path, DataType type);
1052 void remove_dir_from_search_path (const std::string& path, DataType type);
1054 std::list<std::string> unknown_processors () const;
1056 /** Emitted when a feedback cycle has been detected within Ardour's signal
1057 processing path. Until it is fixed (by the user) some (unspecified)
1058 routes will not be run.
1060 static PBD::Signal0<void> FeedbackDetected;
1062 /** Emitted when a graph sort has successfully completed, which means
1063 that it has no feedback cycles.
1065 static PBD::Signal0<void> SuccessfulGraphSort;
1067 /* handlers can return an integer value:
1068 0: config.set_audio_search_path() or config.set_midi_search_path() was used
1069 to modify the search path and we should try to find it again.
1070 1: quit entire session load
1071 2: as 0, but don't ask about other missing files
1072 3: don't ask about other missing files, and just mark this one missing
1073 -1: just mark this one missing
1074 any other value: as -1
1076 static PBD::Signal3<int,Session*,std::string,DataType> MissingFile;
1078 /** Emitted when the session wants Ardour to quit */
1079 static PBD::Signal0<void> Quit;
1081 /** Emitted when Ardour is asked to load a session in an older session
1082 * format, and makes a backup copy.
1084 static PBD::Signal2<void,std::string,std::string> VersionMismatch;
1086 SceneChanger* scene_changer() const { return _scene_changer; }
1088 /* asynchronous MIDI control ports */
1090 boost::shared_ptr<Port> midi_input_port () const;
1091 boost::shared_ptr<Port> midi_output_port () const;
1092 boost::shared_ptr<Port> mmc_output_port () const;
1093 boost::shared_ptr<Port> mmc_input_port () const;
1094 boost::shared_ptr<Port> scene_input_port () const;
1095 boost::shared_ptr<Port> scene_output_port () const;
1097 /* synchronous MIDI ports used for synchronization */
1099 boost::shared_ptr<MidiPort> midi_clock_output_port () const;
1100 boost::shared_ptr<MidiPort> midi_clock_input_port () const;
1101 boost::shared_ptr<MidiPort> mtc_output_port () const;
1102 boost::shared_ptr<MidiPort> mtc_input_port () const;
1103 boost::shared_ptr<Port> ltc_input_port() const;
1104 boost::shared_ptr<Port> ltc_output_port() const;
1106 boost::shared_ptr<IO> ltc_input_io() { return _ltc_input; }
1107 boost::shared_ptr<IO> ltc_output_io() { return _ltc_output; }
1109 MIDI::MachineControl& mmc() { return *_mmc; }
1111 void reconnect_midi_scene_ports (bool);
1112 void reconnect_mtc_ports ();
1113 void reconnect_mmc_ports (bool);
1115 void reconnect_ltc_input ();
1116 void reconnect_ltc_output ();
1119 friend class AudioEngine;
1120 void set_block_size (pframes_t nframes);
1121 void set_frame_rate (framecnt_t nframes);
1122 void reconnect_existing_routes (bool withLock, bool reconnect_master = true, bool reconnect_inputs = true, bool reconnect_outputs = true);
1126 void schedule_curve_reallocation ();
1127 void update_latency_compensation (bool force = false);
1130 int create (const std::string& mix_template, BusProfile*);
1133 static guint _name_id_counter;
1134 static void init_name_id_counter (guint n);
1135 static unsigned int name_id_counter ();
1138 PendingDeclickIn = 0x1, ///< pending de-click fade-in for start
1139 PendingDeclickOut = 0x2, ///< pending de-click fade-out for stop
1140 StopPendingCapture = 0x4,
1141 PendingLoopDeclickIn = 0x8, ///< pending de-click fade-in at the start of a loop
1142 PendingLoopDeclickOut = 0x10, ///< pending de-click fade-out at the end of a loop
1143 PendingLocate = 0x20,
1146 /* stuff used in process() should be close together to
1150 typedef void (Session::*process_function_type)(pframes_t);
1152 AudioEngine& _engine;
1153 mutable gint processing_prohibited;
1154 process_function_type process_function;
1155 process_function_type last_process_function;
1156 bool _bounce_processing_active;
1157 bool waiting_for_sync_offset;
1158 framecnt_t _base_frame_rate; // sample-rate of the session at creation time, "native" SR
1159 framecnt_t _nominal_frame_rate; // overridden by audioengine setting
1160 framecnt_t _current_frame_rate; // this includes video pullup offset
1161 int transport_sub_state;
1162 mutable gint _record_status;
1163 framepos_t _transport_frame;
1164 Location* _session_range_location; ///< session range, or 0 if there is nothing in the session yet
1168 // varispeed playback
1169 double _transport_speed;
1170 double _default_transport_speed;
1171 double _last_transport_speed;
1172 double _signalled_varispeed;
1173 double _target_transport_speed;
1174 CubicInterpolation interpolation;
1176 bool auto_play_legal;
1177 framepos_t _last_slave_transport_frame;
1178 framecnt_t maximum_output_latency;
1179 framepos_t _requested_return_frame;
1180 pframes_t current_block_size;
1181 framecnt_t _worst_output_latency;
1182 framecnt_t _worst_input_latency;
1183 framecnt_t _worst_track_latency;
1184 bool _have_captured;
1185 bool _non_soloed_outs_muted;
1187 uint32_t _listen_cnt;
1188 uint32_t _solo_isolated_cnt;
1191 bool _under_nsm_control;
1192 unsigned int _xrun_count;
1194 void mtc_status_changed (bool);
1195 PBD::ScopedConnection mtc_status_connection;
1196 void ltc_status_changed (bool);
1197 PBD::ScopedConnection ltc_status_connection;
1199 void initialize_latencies ();
1200 void set_worst_io_latencies ();
1201 void set_worst_playback_latency ();
1202 void set_worst_capture_latency ();
1203 void set_worst_io_latencies_x (IOChange, void *) {
1204 set_worst_io_latencies ();
1206 void post_capture_latency ();
1207 void post_playback_latency ();
1209 void update_latency_compensation_proxy (void* ignored);
1211 void ensure_buffers (ChanCount howmany = ChanCount::ZERO);
1213 void process_scrub (pframes_t);
1214 void process_without_events (pframes_t);
1215 void process_with_events (pframes_t);
1216 void process_audition (pframes_t);
1217 int process_export (pframes_t);
1218 int process_export_fw (pframes_t);
1220 void block_processing() { g_atomic_int_set (&processing_prohibited, 1); }
1221 void unblock_processing() { g_atomic_int_set (&processing_prohibited, 0); }
1222 bool processing_blocked() const { return g_atomic_int_get (&processing_prohibited); }
1224 static const framecnt_t bounce_chunk_size;
1226 /* slave tracking */
1228 static const int delta_accumulator_size = 25;
1229 int delta_accumulator_cnt;
1230 int32_t delta_accumulator[delta_accumulator_size];
1231 int32_t average_slave_delta;
1233 bool have_first_delta_accumulator;
1235 SlaveState _slave_state;
1238 framepos_t slave_wait_end;
1240 void reset_slave_state ();
1241 bool follow_slave (pframes_t);
1242 void calculate_moving_average_of_slave_delta (int dir, framecnt_t this_delta);
1243 void track_slave_state (float slave_speed, framepos_t slave_transport_frame, framecnt_t this_delta);
1244 void follow_slave_silently (pframes_t nframes, float slave_speed);
1246 void switch_to_sync_source (SyncSource); /* !RT context */
1247 void drop_sync_source (); /* !RT context */
1248 void use_sync_source (Slave*); /* RT context */
1250 bool post_export_sync;
1251 framepos_t post_export_position;
1254 bool _export_rolling;
1255 framepos_t _export_preroll;
1257 boost::shared_ptr<ExportHandler> export_handler;
1258 boost::shared_ptr<ExportStatus> export_status;
1261 int stop_audio_export ();
1262 void finalize_audio_export ();
1263 void finalize_export_internal (bool stop_freewheel);
1264 bool _pre_export_mmc_enabled;
1266 PBD::ScopedConnection export_freewheel_connection;
1268 void get_track_statistics ();
1269 int process_routes (pframes_t, bool& need_butler);
1270 int silent_process_routes (pframes_t, bool& need_butler);
1272 /** @return 1 if there is a pending declick fade-in,
1273 -1 if there is a pending declick fade-out,
1274 0 if there is no pending declick.
1276 int get_transport_declick_required () {
1277 if (transport_sub_state & PendingDeclickIn) {
1278 transport_sub_state &= ~PendingDeclickIn;
1280 } else if (transport_sub_state & PendingDeclickOut) {
1281 /* XXX: not entirely sure why we don't clear this */
1283 } else if (transport_sub_state & PendingLoopDeclickOut) {
1284 /* Return the declick out first ... */
1285 transport_sub_state &= ~PendingLoopDeclickOut;
1287 } else if (transport_sub_state & PendingLoopDeclickIn) {
1288 /* ... then the declick in on the next call */
1289 transport_sub_state &= ~PendingLoopDeclickIn;
1296 bool maybe_stop (framepos_t limit);
1297 bool maybe_sync_start (pframes_t &);
1299 void check_declick_out ();
1305 /** Number of process frames since the last MTC output (when sending MTC); used to
1306 * know when to send full MTC messages every so often.
1308 pframes_t _pframes_since_last_mtc;
1309 bool session_midi_feedback;
1312 framepos_t last_loopend;
1314 boost::scoped_ptr<SessionDirectory> _session_dir;
1317 void graph_reordered ();
1319 /** current snapshot name, without the .ardour suffix */
1320 void set_snapshot_name (const std::string &);
1321 void save_snapshot_name (const std::string &);
1322 std::string _current_snapshot_name;
1324 XMLTree* state_tree;
1325 bool state_was_pending;
1326 StateOfTheState _state_of_the_state;
1328 friend class StateProtector;
1329 gint _suspend_save; /* atomic */
1330 volatile bool _save_queued;
1331 Glib::Threads::Mutex save_state_lock;
1332 Glib::Threads::Mutex peak_cleanup_lock;
1334 int load_options (const XMLNode&);
1335 int load_state (std::string snapshot_name);
1337 framepos_t _last_roll_location;
1338 /** the session frame time at which we last rolled, located, or changed transport direction */
1339 framepos_t _last_roll_or_reversal_location;
1340 framepos_t _last_record_location;
1342 bool pending_locate_roll;
1343 framepos_t pending_locate_frame;
1344 bool pending_locate_flush;
1346 bool pending_auto_loop;
1348 PBD::ReallocPool _mempool;
1350 Glib::Threads::Mutex lua_lock;
1351 luabridge::LuaRef * _lua_run;
1352 luabridge::LuaRef * _lua_add;
1353 luabridge::LuaRef * _lua_del;
1354 luabridge::LuaRef * _lua_list;
1355 luabridge::LuaRef * _lua_load;
1356 luabridge::LuaRef * _lua_save;
1357 luabridge::LuaRef * _lua_cleanup;
1358 uint32_t _n_lua_scripts;
1361 void try_run_lua (pframes_t);
1365 static const PostTransportWork ProcessCannotProceedMask =
1367 PostTransportInputChange|
1369 PostTransportReverse|
1370 PostTransportCurveRealloc|
1371 PostTransportAudition|
1372 PostTransportLocate|
1374 PostTransportClearSubstate);
1376 gint _post_transport_work; /* accessed only atomic ops */
1377 PostTransportWork post_transport_work() const { return (PostTransportWork) g_atomic_int_get (const_cast<gint*>(&_post_transport_work)); }
1378 void set_post_transport_work (PostTransportWork ptw) { g_atomic_int_set (&_post_transport_work, (gint) ptw); }
1379 void add_post_transport_work (PostTransportWork ptw);
1381 void schedule_playback_buffering_adjustment ();
1382 void schedule_capture_buffering_adjustment ();
1384 uint32_t cumulative_rf_motion;
1387 void set_rf_speed (float speed);
1388 void reset_rf_scale (framecnt_t frames_moved);
1390 Locations* _locations;
1391 void location_added (Location*);
1392 void location_removed (Location*);
1393 void locations_changed ();
1394 void _locations_changed (const Locations::LocationList&);
1396 void update_skips (Location*, bool consolidate);
1397 void update_marks (Location* loc);
1398 void consolidate_skips (Location*);
1399 void sync_locations_to_skips ();
1400 void _sync_locations_to_skips ();
1402 PBD::ScopedConnectionList skip_update_connections;
1403 bool _ignore_skips_updates;
1405 PBD::ScopedConnectionList punch_connections;
1406 void auto_punch_start_changed (Location *);
1407 void auto_punch_end_changed (Location *);
1408 void auto_punch_changed (Location *);
1410 PBD::ScopedConnectionList loop_connections;
1411 void auto_loop_changed (Location *);
1412 void auto_loop_declick_range (Location *, framepos_t &, framepos_t &);
1414 int ensure_engine (uint32_t desired_sample_rate);
1415 void pre_engine_init (std::string path);
1416 int post_engine_init ();
1417 int immediately_post_engine ();
1418 void remove_empty_sounds ();
1420 void session_loaded ();
1422 void setup_midi_control ();
1423 int midi_read (MIDI::Port *);
1425 void enable_record ();
1427 void increment_transport_position (framecnt_t val) {
1428 if (max_framepos - val < _transport_frame) {
1429 _transport_frame = max_framepos;
1431 _transport_frame += val;
1435 void decrement_transport_position (framecnt_t val) {
1436 if (val < _transport_frame) {
1437 _transport_frame -= val;
1439 _transport_frame = 0;
1443 void post_transport_motion ();
1444 static void *session_loader_thread (void *arg);
1448 /* Signal Forwarding */
1449 void emit_route_signals ();
1450 void emit_thread_run ();
1451 static void *emit_thread (void *);
1452 void emit_thread_start ();
1453 void emit_thread_terminate ();
1455 pthread_t _rt_emit_thread;
1456 bool _rt_thread_active;
1458 pthread_mutex_t _rt_emit_mutex;
1459 pthread_cond_t _rt_emit_cond;
1460 bool _rt_emit_pending;
1463 /* SessionEventManager interface */
1465 void process_event (SessionEvent*);
1466 void set_next_event ();
1467 void cleanup_event (SessionEvent*,int);
1469 /* MIDI Machine Control */
1472 void spp_continue ();
1475 void mmc_deferred_play (MIDI::MachineControl &);
1476 void mmc_stop (MIDI::MachineControl &);
1477 void mmc_step (MIDI::MachineControl &, int);
1478 void mmc_pause (MIDI::MachineControl &);
1479 void mmc_record_pause (MIDI::MachineControl &);
1480 void mmc_record_strobe (MIDI::MachineControl &);
1481 void mmc_record_exit (MIDI::MachineControl &);
1482 void mmc_track_record_status (MIDI::MachineControl &, uint32_t track, bool enabled);
1483 void mmc_fast_forward (MIDI::MachineControl &);
1484 void mmc_rewind (MIDI::MachineControl &);
1485 void mmc_locate (MIDI::MachineControl &, const MIDI::byte *);
1486 void mmc_shuttle (MIDI::MachineControl &mmc, float speed, bool forw);
1487 void mmc_record_enable (MIDI::MachineControl &mmc, size_t track, bool enabled);
1489 struct timeval last_mmc_step;
1492 typedef boost::function<bool()> MidiTimeoutCallback;
1493 typedef std::list<MidiTimeoutCallback> MidiTimeoutList;
1495 MidiTimeoutList midi_timeouts;
1496 bool mmc_step_timeout ();
1497 void send_immediate_mmc (MIDI::MachineControlCommand);
1499 MIDI::byte mtc_msg[16];
1500 MIDI::byte mtc_timecode_bits; /* encoding of SMTPE type for MTC */
1501 MIDI::byte midi_msg[16];
1502 double outbound_mtc_timecode_frame;
1503 Timecode::Time transmitting_timecode_time;
1504 int next_quarter_frame_to_send;
1506 double _frames_per_timecode_frame; /* has to be floating point because of drop frame */
1507 framecnt_t _frames_per_hour;
1508 framecnt_t _timecode_frames_per_hour;
1510 /* cache the most-recently requested time conversions. This helps when we
1511 * have multiple clocks showing the same time (e.g. the transport frame) */
1512 bool last_timecode_valid;
1513 framepos_t last_timecode_when;
1514 Timecode::Time last_timecode;
1516 bool _send_timecode_update; ///< Flag to send a full frame (Timecode) MTC message this cycle
1518 int send_midi_time_code_for_cycle (framepos_t, framepos_t, pframes_t nframes);
1520 LTCEncoder* ltc_encoder;
1521 ltcsnd_sample_t* ltc_enc_buf;
1523 Timecode::TimecodeFormat ltc_enc_tcformat;
1524 int32_t ltc_buf_off;
1525 int32_t ltc_buf_len;
1528 int32_t ltc_enc_byte;
1529 framepos_t ltc_enc_pos;
1531 framepos_t ltc_enc_off;
1533 framepos_t ltc_prev_cycle;
1535 framepos_t ltc_timecode_offset;
1536 bool ltc_timecode_negative_offset;
1538 LatencyRange ltc_out_latency;
1540 void ltc_tx_initialize();
1541 void ltc_tx_cleanup();
1542 void ltc_tx_reset();
1543 void ltc_tx_resync_latency();
1544 void ltc_tx_recalculate_position();
1545 void ltc_tx_parse_offset();
1546 void ltc_tx_send_time_code_for_cycle (framepos_t, framepos_t, double, double, pframes_t nframes);
1548 void reset_record_status ();
1550 int no_roll (pframes_t nframes);
1551 int fail_roll (pframes_t nframes);
1553 bool non_realtime_work_pending() const { return static_cast<bool>(post_transport_work()); }
1554 bool process_can_proceed() const { return !(post_transport_work() & ProcessCannotProceedMask); }
1556 MidiControlUI* midi_control_ui;
1558 int start_midi_thread ();
1560 void set_play_loop (bool yn, double speed);
1561 void unset_play_loop ();
1562 void overwrite_some_buffers (Track *);
1563 void flush_all_inserts ();
1564 int micro_locate (framecnt_t distance);
1565 void locate (framepos_t, bool with_roll, bool with_flush, bool with_loop=false, bool force=false, bool with_mmc=true);
1566 void start_locate (framepos_t, bool with_roll, bool with_flush, bool for_loop_enabled=false, bool force=false);
1567 void force_locate (framepos_t frame, bool with_roll = false);
1568 void set_track_speed (Track *, double speed);
1569 void set_transport_speed (double speed, framepos_t destination_frame, bool abort = false, bool clear_state = false, bool as_default = false);
1570 void stop_transport (bool abort = false, bool clear_state = false);
1571 void start_transport ();
1572 void realtime_stop (bool abort, bool clear_state);
1573 void realtime_locate ();
1574 void non_realtime_start_scrub ();
1575 void non_realtime_set_speed ();
1576 void non_realtime_locate ();
1577 void non_realtime_stop (bool abort, int entry_request_count, bool& finished);
1578 void non_realtime_overwrite (int entry_request_count, bool& finished);
1579 void post_transport ();
1580 void engine_halted ();
1581 void xrun_recovery ();
1582 void set_track_loop (bool);
1583 bool select_playhead_priority_target (framepos_t&);
1584 void follow_playhead_priority ();
1586 /* These are synchronous and so can only be called from within the process
1590 int send_full_time_code (framepos_t, pframes_t nframes);
1591 void send_song_position_pointer (framepos_t);
1593 TempoMap *_tempo_map;
1594 void tempo_map_changed (const PBD::PropertyChange&);
1596 /* edit/mix groups */
1598 int load_route_groups (const XMLNode&, int);
1600 std::list<RouteGroup *> _route_groups;
1601 RouteGroup* _all_route_group;
1605 boost::shared_ptr<Graph> _process_graph;
1607 SerializedRCUManager<RouteList> routes;
1609 void add_routes (RouteList&, bool input_auto_connect, bool output_auto_connect, bool save);
1610 void add_routes_inner (RouteList&, bool input_auto_connect, bool output_auto_connect);
1611 bool _adding_routes_in_progress;
1612 bool _reconnecting_routes_in_progress;
1613 bool _route_deletion_in_progress;
1615 uint32_t destructive_index;
1617 boost::shared_ptr<Route> XMLRouteFactory (const XMLNode&, int);
1618 boost::shared_ptr<Route> XMLRouteFactory_2X (const XMLNode&, int);
1620 void route_processors_changed (RouteProcessorChange);
1622 bool find_route_name (std::string const &, uint32_t& id, std::string& name, bool);
1623 void count_existing_track_channels (ChanCount& in, ChanCount& out);
1624 void auto_connect_route (boost::shared_ptr<Route> route, ChanCount& existing_inputs, ChanCount& existing_outputs,
1625 bool with_lock, bool connect_inputs = true,
1626 ChanCount input_start = ChanCount (), ChanCount output_start = ChanCount ());
1627 void midi_output_change_handler (IOChange change, void* /*src*/, boost::weak_ptr<Route> midi_track);
1629 /* track numbering */
1631 void reassign_track_numbers ();
1632 uint32_t _track_number_decimals;
1636 void route_listen_changed (PBD::Controllable::GroupControlDisposition, boost::weak_ptr<Route>);
1637 void route_mute_changed ();
1638 void route_solo_changed (bool self_solo_change, PBD::Controllable::GroupControlDisposition group_override, boost::weak_ptr<Route>);
1639 void route_solo_isolated_changed (boost::weak_ptr<Route>);
1640 void update_route_solo_state (boost::shared_ptr<RouteList> r = boost::shared_ptr<RouteList>());
1642 void listen_position_changed ();
1643 void solo_control_mode_changed ();
1645 /* REGION MANAGEMENT */
1647 mutable Glib::Threads::Mutex region_lock;
1649 int load_regions (const XMLNode& node);
1650 int load_compounds (const XMLNode& node);
1652 void route_added_to_route_group (RouteGroup *, boost::weak_ptr<Route>);
1653 void route_removed_from_route_group (RouteGroup *, boost::weak_ptr<Route>);
1654 void route_group_property_changed (RouteGroup *);
1658 mutable Glib::Threads::Mutex source_lock;
1661 typedef std::map<PBD::ID,boost::shared_ptr<Source> > SourceMap;
1664 void reset_write_sources (bool mark_write_complete, bool force = false);
1669 int load_sources (const XMLNode& node);
1670 XMLNode& get_sources_as_xml ();
1672 boost::shared_ptr<Source> XMLSourceFactory (const XMLNode&);
1676 void remove_playlist (boost::weak_ptr<Playlist>);
1677 void track_playlist_changed (boost::weak_ptr<Track>);
1678 void playlist_region_added (boost::weak_ptr<Region>);
1679 void playlist_ranges_moved (std::list<Evoral::RangeMove<framepos_t> > const &);
1680 void playlist_regions_extended (std::list<Evoral::Range<framepos_t> > const &);
1682 /* CURVES and AUTOMATION LISTS */
1683 std::map<PBD::ID, AutomationList*> automation_lists;
1685 /* DEFAULT FADE CURVES */
1687 float default_fade_steepness;
1688 float default_fade_msecs;
1692 boost::shared_ptr<Auditioner> auditioner;
1693 void set_audition (boost::shared_ptr<Region>);
1694 void non_realtime_set_audition ();
1695 boost::shared_ptr<Region> pending_audition_region;
1701 int flatten_one_track (AudioTrack&, framepos_t start, framecnt_t cnt);
1703 /* INSERT AND SEND MANAGEMENT */
1705 boost::dynamic_bitset<uint32_t> send_bitset;
1706 boost::dynamic_bitset<uint32_t> aux_send_bitset;
1707 boost::dynamic_bitset<uint32_t> return_bitset;
1708 boost::dynamic_bitset<uint32_t> insert_bitset;
1712 struct space_and_path {
1713 uint32_t blocks; ///< 4kB blocks
1714 bool blocks_unknown; ///< true if blocks is unknown
1719 , blocks_unknown (true)
1723 struct space_and_path_ascending_cmp {
1724 bool operator() (space_and_path a, space_and_path b) {
1725 if (a.blocks_unknown != b.blocks_unknown) {
1726 return !a.blocks_unknown;
1728 return a.blocks > b.blocks;
1732 void setup_raid_path (std::string path);
1734 std::vector<space_and_path> session_dirs;
1735 std::vector<space_and_path>::iterator last_rr_session_dir;
1736 uint32_t _total_free_4k_blocks;
1737 /** If this is true, _total_free_4k_blocks is not definite,
1738 as one or more of the session directories' filesystems
1739 could not report free space.
1741 bool _total_free_4k_blocks_uncertain;
1742 Glib::Threads::Mutex space_lock;
1744 bool no_questions_about_missing_files;
1746 std::string get_best_session_directory_for_new_audio ();
1748 mutable gint _playback_load;
1749 mutable gint _capture_load;
1753 SerializedRCUManager<BundleList> _bundles;
1754 XMLNode* _bundle_xml_node;
1755 int load_bundles (XMLNode const &);
1757 UndoHistory _history;
1758 /** current undo transaction, or 0 */
1759 UndoTransaction* _current_trans;
1760 /** GQuarks to describe the reversible commands that are currently in progress.
1761 * These may be nested, in which case more recently-started commands are toward
1762 * the front of the list.
1764 std::list<GQuark> _current_trans_quarks;
1766 int backend_sync_callback (TransportState, framepos_t);
1768 void process_rtop (SessionEvent*);
1770 void update_latency (bool playback);
1772 XMLNode& state(bool);
1775 typedef std::list<Click*> Clicks;
1778 boost::shared_ptr<IO> _click_io;
1779 boost::shared_ptr<Amp> _click_gain;
1781 Sample* click_emphasis_data;
1782 framecnt_t click_length;
1783 framecnt_t click_emphasis_length;
1784 mutable Glib::Threads::RWLock click_lock;
1786 static const Sample default_click[];
1787 static const framecnt_t default_click_length;
1788 static const Sample default_click_emphasis[];
1789 static const framecnt_t default_click_emphasis_length;
1792 framepos_t _clicks_cleared;
1793 void setup_click_sounds (int which);
1794 void setup_click_sounds (Sample**, Sample const *, framecnt_t*, framecnt_t, std::string const &);
1795 void clear_clicks ();
1796 void click (framepos_t start, framecnt_t nframes);
1798 std::vector<Route*> master_outs;
1800 /* range playback */
1802 std::list<AudioRange> current_audio_range;
1804 void set_play_range (std::list<AudioRange>&, bool leave_rolling);
1805 void unset_play_range ();
1807 /* temporary hacks to allow selection to be pushed from GUI into backend
1808 Whenever we move the selection object into libardour, these will go away.
1810 Evoral::Range<framepos_t> _range_selection;
1811 Evoral::Range<framepos_t> _object_selection;
1816 boost::shared_ptr<Route> _master_out;
1817 boost::shared_ptr<Route> _monitor_out;
1819 void auto_connect_master_bus ();
1821 /* Windows VST support */
1823 long _windows_vst_callback (
1832 int find_all_sources (std::string path, std::set<std::string>& result);
1833 int find_all_sources_across_snapshots (std::set<std::string>& result, bool exclude_this_snapshot);
1835 typedef std::set<boost::shared_ptr<PBD::Controllable> > Controllables;
1836 Glib::Threads::Mutex controllables_lock;
1837 Controllables controllables;
1839 boost::shared_ptr<PBD::Controllable> _solo_cut_control;
1841 void reset_native_file_format();
1842 bool first_file_data_format_reset;
1843 bool first_file_header_format_reset;
1845 void config_changed (std::string, bool);
1847 XMLNode& get_control_protocol_state ();
1849 void set_history_depth (uint32_t depth);
1851 static bool _disable_all_loaded_plugins;
1852 static bool _bypass_all_loaded_plugins;
1854 mutable bool have_looped; ///< Used in ::audible_frame(*)
1856 void update_route_record_state ();
1857 gint _have_rec_enabled_track;
1858 gint _have_rec_disabled_track;
1860 static int ask_about_playlist_deletion (boost::shared_ptr<Playlist>);
1862 /* realtime "apply to set of routes" operations */
1863 template<typename T> SessionEvent*
1864 get_rt_event (boost::shared_ptr<RouteList> rl, T targ, SessionEvent::RTeventCallback after, PBD::Controllable::GroupControlDisposition group_override,
1865 void (Session::*method) (boost::shared_ptr<RouteList>, T, PBD::Controllable::GroupControlDisposition)) {
1866 SessionEvent* ev = new SessionEvent (SessionEvent::RealTimeOperation, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
1867 ev->rt_slot = boost::bind (method, this, rl, targ, group_override);
1868 ev->rt_return = after;
1869 ev->event_loop = PBD::EventLoop::get_event_loop_for_thread ();
1874 void rt_set_solo (boost::shared_ptr<RouteList>, bool yn, PBD::Controllable::GroupControlDisposition group_override);
1875 void rt_clear_all_solo_state (boost::shared_ptr<RouteList>, bool yn, PBD::Controllable::GroupControlDisposition group_override);
1876 void rt_set_just_one_solo (boost::shared_ptr<RouteList>, bool yn, PBD::Controllable::GroupControlDisposition /* ignored*/ );
1877 void rt_set_mute (boost::shared_ptr<RouteList>, bool yn, PBD::Controllable::GroupControlDisposition group_override);
1878 void rt_set_listen (boost::shared_ptr<RouteList>, bool yn, PBD::Controllable::GroupControlDisposition group_override);
1879 void rt_set_solo_isolated (boost::shared_ptr<RouteList>, bool yn, PBD::Controllable::GroupControlDisposition group_override);
1880 void rt_set_record_enabled (boost::shared_ptr<RouteList>, bool yn, PBD::Controllable::GroupControlDisposition group_override);
1881 void rt_set_record_safe (boost::shared_ptr<RouteList>, bool yn, PBD::Controllable::GroupControlDisposition group_override);
1882 void rt_set_monitoring (boost::shared_ptr<RouteList>, MonitorChoice, PBD::Controllable::GroupControlDisposition group_override);
1884 /** temporary list of Diskstreams used only during load of 2.X sessions */
1885 std::list<boost::shared_ptr<Diskstream> > _diskstreams_2X;
1887 void set_session_range_location (framepos_t, framepos_t);
1889 void setup_midi_machine_control ();
1891 void step_edit_status_change (bool);
1892 uint32_t _step_editors;
1894 /** true if timecode transmission by the transport is suspended, otherwise false */
1895 mutable gint _suspend_timecode_transmission;
1897 void update_locations_after_tempo_map_change (const Locations::LocationList &);
1899 void start_time_changed (framepos_t);
1900 void end_time_changed (framepos_t);
1902 void set_track_monitor_input_status (bool);
1903 framepos_t compute_stop_limit () const;
1905 boost::shared_ptr<Speakers> _speakers;
1906 void load_nested_sources (const XMLNode& node);
1908 /** The directed graph of routes that is currently being used for audio processing
1909 and solo/mute computations.
1911 GraphEdges _current_route_graph;
1913 uint32_t next_control_id () const;
1914 int32_t _order_hint;
1915 bool ignore_route_processor_changes;
1917 MidiClockTicker* midi_clock;
1919 boost::shared_ptr<IO> _ltc_input;
1920 boost::shared_ptr<IO> _ltc_output;
1922 /* Scene Changing */
1923 SceneChanger* _scene_changer;
1925 /* persistent, non-track related MIDI ports */
1926 MidiPortManager* _midi_ports;
1927 MIDI::MachineControl* _mmc;
1930 void setup_click ();
1931 void setup_click_state (const XMLNode*);
1932 void setup_bundles ();
1934 void save_as_bring_callback (uint32_t, uint32_t, std::string);
1936 static int get_session_info_from_path (XMLTree& state_tree, const std::string& xmlpath);
1937 static const uint32_t session_end_shift;
1939 std::string _template_state_dir;
1943 } // namespace ARDOUR
1945 #endif /* __ardour_session_h__ */