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 class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::ScopedConnectionList, public SessionEventManager
173 /* a new session might have non-empty mix_template, an existing session should always have an empty one.
174 the bus profile can be null if no master out bus is required.
177 Session (AudioEngine&,
178 const std::string& fullpath,
179 const std::string& snapshot_name,
180 BusProfile* bus_profile = 0,
181 std::string mix_template = "");
185 static int get_info_from_path (const std::string& xmlpath, float& sample_rate, SampleFormat& data_format);
186 static std::string get_snapshot_from_instant (const std::string& session_dir);
188 std::string path() const { return _path; }
189 std::string name() const { return _name; }
190 std::string snap_name() const { return _current_snapshot_name; }
191 std::string raid_path () const;
192 bool path_is_within_session (const std::string&);
194 bool writable() const { return _writable; }
197 bool dirty() const { return _state_of_the_state & Dirty; }
198 void set_deletion_in_progress ();
199 void clear_deletion_in_progress ();
200 bool reconnection_in_progress() const { return _reconnecting_routes_in_progress; }
201 bool deletion_in_progress() const { return _state_of_the_state & Deletion; }
202 bool routes_deletion_in_progress() const { return _route_deletion_in_progress; }
203 bool peaks_cleanup_in_progres() const { return _state_of_the_state & PeakCleanup; }
205 PBD::Signal0<void> DirtyChanged;
207 PBD::Signal1<void, bool> RouteAddedOrRemoved;
209 const SessionDirectory& session_directory () const { return *(_session_dir.get()); }
211 static PBD::Signal1<void,std::string> Dialog;
213 PBD::Signal0<void> BatchUpdateStart;
214 PBD::Signal0<void> BatchUpdateEnd;
216 int ensure_subdirs ();
218 std::string automation_dir () const; ///< Automation data
219 std::string analysis_dir () const; ///< Analysis data
220 std::string plugins_dir () const; ///< Plugin state
221 std::string externals_dir () const; ///< Links to external files
223 std::string construct_peak_filepath (const std::string& audio_path, const bool in_session = false, const bool old_peak_name = false) const;
225 bool audio_source_name_is_unique (const std::string& name);
226 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);
227 std::string new_audio_source_path_for_embedded (const std::string& existing_path);
228 std::string new_audio_source_path (const std::string&, uint32_t nchans, uint32_t chan, bool destructive, bool take_required);
229 std::string new_midi_source_path (const std::string&);
230 RouteList new_route_from_template (uint32_t how_many, const std::string& template_path, const std::string& name, PlaylistDisposition pd = NewPlaylist);
231 RouteList new_route_from_template (uint32_t how_many, XMLNode&, const std::string& name, PlaylistDisposition pd = NewPlaylist);
232 std::vector<std::string> get_paths_for_new_sources (bool allow_replacing, const std::string& import_file_path, uint32_t channels);
234 int bring_all_sources_into_session (boost::function<void(uint32_t,uint32_t,std::string)> callback);
236 void process (pframes_t nframes);
238 BufferSet& get_silent_buffers (ChanCount count = ChanCount::ZERO);
239 BufferSet& get_scratch_buffers (ChanCount count = ChanCount::ZERO, bool silence = true );
240 BufferSet& get_route_buffers (ChanCount count = ChanCount::ZERO, bool silence = true);
241 BufferSet& get_mix_buffers (ChanCount count = ChanCount::ZERO);
243 bool have_rec_enabled_track () const;
244 bool have_rec_disabled_track () const;
246 bool have_captured() const { return _have_captured; }
248 void refill_all_track_buffers ();
249 Butler* butler() { return _butler; }
250 void butler_transport_work ();
252 void refresh_disk_space ();
254 int load_diskstreams_2X (XMLNode const &, int);
256 int load_routes (const XMLNode&, int);
257 boost::shared_ptr<RouteList> get_routes() const {
258 return routes.reader ();
261 boost::shared_ptr<RouteList> get_tracks() const;
262 boost::shared_ptr<RouteList> get_routes_with_internal_returns() const;
263 boost::shared_ptr<RouteList> get_routes_with_regions_at (framepos_t const) const;
265 uint32_t nroutes() const { return routes.reader()->size(); }
266 uint32_t ntracks () const;
267 uint32_t nbusses () const;
269 boost::shared_ptr<BundleList> bundles () {
270 return _bundles.reader ();
273 struct LIBARDOUR_API RoutePublicOrderSorter {
274 bool operator() (boost::shared_ptr<Route>, boost::shared_ptr<Route> b);
277 void set_order_hint (int32_t order_hint) {_order_hint = order_hint;};
278 void notify_remote_id_change ();
279 void sync_order_keys ();
281 template<class T> void foreach_route (T *obj, void (T::*func)(Route&), bool sort = true);
282 template<class T> void foreach_route (T *obj, void (T::*func)(boost::shared_ptr<Route>), bool sort = true);
283 template<class T, class A> void foreach_route (T *obj, void (T::*func)(Route&, A), A arg, bool sort = true);
285 static char session_name_is_legal (const std::string&);
286 bool io_name_is_legal (const std::string&);
287 boost::shared_ptr<Route> route_by_name (std::string);
288 boost::shared_ptr<Route> route_by_id (PBD::ID);
289 boost::shared_ptr<Route> route_by_remote_id (uint32_t id);
290 boost::shared_ptr<Route> route_by_selected_count (uint32_t cnt);
291 boost::shared_ptr<Track> track_by_diskstream_id (PBD::ID);
292 void routes_using_input_from (const std::string& str, RouteList& rl);
294 bool route_name_unique (std::string) const;
295 bool route_name_internal (std::string) const;
297 uint32_t track_number_decimals () const {
298 return _track_number_decimals;
301 bool get_record_enabled() const {
302 return (record_status () >= Enabled);
305 RecordState record_status() const {
306 return (RecordState) g_atomic_int_get (&_record_status);
309 bool actively_recording () const {
310 return record_status() == Recording;
313 bool record_enabling_legal () const;
314 void maybe_enable_record ();
315 void disable_record (bool rt_context, bool force = false);
316 void step_back_from_record ();
318 void set_all_tracks_record_enabled(bool);
320 void maybe_write_autosave ();
322 /* Emitted when all i/o connections are complete */
324 PBD::Signal0<void> IOConnectionsComplete;
326 /* Timecode status signals */
327 PBD::Signal1<void, bool> MTCSyncStateChanged;
328 PBD::Signal1<void, bool> LTCSyncStateChanged;
330 /* Record status signals */
332 PBD::Signal0<void> RecordStateChanged; /* signals changes in recording state (i.e. are we recording) */
333 /* XXX may 2015: paul says: it isn't clear to me that this has semantics that cannot be inferrred
334 from the previous signal and session state.
336 PBD::Signal0<void> RecordArmStateChanged; /* signals changes in recording arming */
338 /* Emited when session is loaded */
339 PBD::Signal0<void> SessionLoaded;
341 /* Transport mechanism signals */
343 /** Emitted on the following changes in transport state:
344 * - stop (from the butler thread)
345 * - change in whether or not we are looping (from the process thread)
346 * - change in the play range (from the process thread)
347 * - start (from the process thread)
350 PBD::Signal0<void> TransportStateChange;
352 PBD::Signal1<void,framepos_t> PositionChanged; /* sent after any non-sequential motion */
353 PBD::Signal1<void,framepos_t> Xrun;
354 PBD::Signal0<void> TransportLooped;
356 /** emitted when a locate has occurred */
357 PBD::Signal0<void> Located;
359 PBD::Signal1<void,RouteList&> RouteAdded;
360 /** Emitted when a property of one of our route groups changes.
361 * The parameter is the RouteGroup that has changed.
363 PBD::Signal1<void, RouteGroup *> RouteGroupPropertyChanged;
364 /** Emitted when a route is added to one of our route groups.
365 * First parameter is the RouteGroup, second is the route.
367 PBD::Signal2<void, RouteGroup *, boost::weak_ptr<Route> > RouteAddedToRouteGroup;
368 /** Emitted when a route is removed from one of our route groups.
369 * First parameter is the RouteGroup, second is the route.
371 PBD::Signal2<void, RouteGroup *, boost::weak_ptr<Route> > RouteRemovedFromRouteGroup;
373 /* Step Editing status changed */
374 PBD::Signal1<void,bool> StepEditStatusChange;
376 /* Timecode state signals */
377 PBD::Signal0<void> MtcOrLtcInputPortChanged;
379 void queue_event (SessionEvent*);
381 void request_roll_at_and_return (framepos_t start, framepos_t return_to);
382 void request_bounded_roll (framepos_t start, framepos_t end);
383 void request_stop (bool abort = false, bool clear_state = false);
384 void request_locate (framepos_t frame, bool with_roll = false);
386 void request_play_loop (bool yn, bool leave_rolling = false);
387 bool get_play_loop () const { return play_loop; }
389 framepos_t last_transport_start () const { return _last_roll_location; }
392 void use_rf_shuttle_speed ();
393 void allow_auto_play (bool yn);
394 void request_transport_speed (double speed, bool as_default = true);
395 void request_transport_speed_nonzero (double, bool as_default = true);
396 void request_overwrite_buffer (Track *);
397 void adjust_playback_buffering();
398 void adjust_capture_buffering();
399 void request_track_speed (Track *, double speed);
400 void request_input_change_handling ();
402 bool locate_pending() const { return static_cast<bool>(post_transport_work()&PostTransportLocate); }
403 bool transport_locked () const;
407 framepos_t current_end_frame () const;
408 framepos_t current_start_frame () const;
409 /** "actual" sample rate of session, set by current audioengine rate, pullup/down etc. */
410 framecnt_t frame_rate () const { return _current_frame_rate; }
411 /** "native" sample rate of session, regardless of current audioengine rate, pullup/down etc */
412 framecnt_t nominal_frame_rate () const { return _nominal_frame_rate; }
413 framecnt_t frames_per_hour () const { return _frames_per_hour; }
415 double frames_per_timecode_frame() const { return _frames_per_timecode_frame; }
416 framecnt_t timecode_frames_per_hour() const { return _timecode_frames_per_hour; }
418 MIDI::byte get_mtc_timecode_bits() const {
419 return mtc_timecode_bits; /* encoding of SMTPE type for MTC */
422 double timecode_frames_per_second() const;
423 bool timecode_drop_frames() const;
427 Locations *locations() { return _locations; }
429 PBD::Signal1<void,Location*> auto_loop_location_changed;
430 PBD::Signal1<void,Location*> auto_punch_location_changed;
431 PBD::Signal0<void> locations_modified;
433 void set_auto_punch_location (Location *);
434 void set_auto_loop_location (Location *);
435 void set_session_extents (framepos_t start, framepos_t end);
436 int location_name(std::string& result, std::string base = std::string(""));
438 pframes_t get_block_size() const { return current_block_size; }
439 framecnt_t worst_output_latency () const { return _worst_output_latency; }
440 framecnt_t worst_input_latency () const { return _worst_input_latency; }
441 framecnt_t worst_track_latency () const { return _worst_track_latency; }
442 framecnt_t worst_playback_latency () const { return _worst_output_latency + _worst_track_latency; }
445 std::string new_parent_folder; /* parent folder where new session folder will be created */
446 std::string new_name; /* name of newly saved session */
447 bool switch_to; /* true if we should be working on newly saved session after save-as; false otherwise */
448 bool include_media; /* true if the newly saved session should contain references to media */
449 bool copy_media; /* true if media files (audio, media, etc) should be copied into newly saved session; false otherwise */
450 bool copy_external; /* true if external media should be consolidated into the newly saved session; false otherwise */
452 std::string final_session_folder_name; /* filled in by * Session::save_as(), provides full path to newly saved session */
454 /* emitted as we make progress. 3 arguments passed to signal
457 * 1: percentage complete measured as a fraction (0-1.0) of
458 * total data copying done.
459 * 2: number of files copied so far
460 * 3: total number of files to copy
462 * Handler should return true for save-as to continue, or false
463 * to stop (and remove all evidence of partial save-as).
465 PBD::Signal3<bool,float,int64_t,int64_t> Progress;
467 /* if save_as() returns non-zero, this string will indicate the reason why.
469 std::string failure_message;
472 int save_as (SaveAs&);
473 int save_state (std::string snapshot_name, bool pending = false, bool switch_to_snapshot = false, bool template_only = false);
474 int restore_state (std::string snapshot_name);
475 int save_template (std::string template_name, bool replace_existing = false);
476 int save_history (std::string snapshot_name = "");
477 int restore_history (std::string snapshot_name);
478 void remove_state (std::string snapshot_name);
479 void rename_state (std::string old_name, std::string new_name);
480 void remove_pending_capture_state ();
481 int rename (const std::string&);
482 bool get_nsm_state () const { return _under_nsm_control; }
483 void set_nsm_state (bool state) { _under_nsm_control = state; }
484 bool save_default_options ();
486 PBD::Signal1<void,std::string> StateSaved;
487 PBD::Signal0<void> StateReady;
489 /* emitted when session needs to be saved due to some internal
490 * event or condition (i.e. not in response to a user request).
492 * Only one object should
493 * connect to this signal and take responsibility.
495 * Argument is the snapshot name to use when saving.
497 PBD::Signal1<void,std::string> SaveSessionRequested;
499 /* emitted during a session save to allow other entities to add state, via
500 * extra XML, to the session state
502 PBD::Signal0<void> SessionSaveUnderway;
504 std::vector<std::string> possible_states() const;
505 static std::vector<std::string> possible_states (std::string path);
507 XMLNode& get_state();
508 int set_state(const XMLNode& node, int version); // not idempotent
509 XMLNode& get_template();
511 /// The instant xml file is written to the session directory
512 void add_instant_xml (XMLNode&, bool write_to_config = true);
513 XMLNode* instant_xml (const std::string& str);
515 enum StateOfTheState {
520 InitialConnecting = 0x8,
526 StateOfTheState state_of_the_state() const { return _state_of_the_state; }
528 class StateProtector {
530 StateProtector (Session* s) : _session (s) {
531 g_atomic_int_inc (&s->_suspend_save);
534 if (g_atomic_int_dec_and_test (&_session->_suspend_save)) {
535 while (_session->_save_queued) {
536 _session->_save_queued = false;
537 _session->save_state ("");
545 void add_route_group (RouteGroup *);
546 void remove_route_group (RouteGroup&);
547 void reorder_route_groups (std::list<RouteGroup*>);
549 RouteGroup* route_group_by_name (std::string);
550 RouteGroup& all_route_group() const;
552 PBD::Signal1<void,RouteGroup*> route_group_added;
553 PBD::Signal0<void> route_group_removed;
554 PBD::Signal0<void> route_groups_reordered;
556 void foreach_route_group (boost::function<void(RouteGroup*)> f) {
557 for (std::list<RouteGroup *>::iterator i = _route_groups.begin(); i != _route_groups.end(); ++i) {
562 std::list<RouteGroup*> const & route_groups () const {
563 return _route_groups;
566 /* fundamental operations. duh. */
568 std::list<boost::shared_ptr<AudioTrack> > new_audio_track (
571 TrackMode mode = Normal,
572 RouteGroup* route_group = 0,
573 uint32_t how_many = 1,
574 std::string name_template = ""
577 RouteList new_audio_route (
578 int input_channels, int output_channels, RouteGroup* route_group, uint32_t how_many, std::string name_template = ""
581 std::list<boost::shared_ptr<MidiTrack> > new_midi_track (
582 const ChanCount& input, const ChanCount& output,
583 boost::shared_ptr<PluginInfo> instrument = boost::shared_ptr<PluginInfo>(),
584 TrackMode mode = Normal,
585 RouteGroup* route_group = 0, uint32_t how_many = 1, std::string name_template = ""
588 RouteList new_midi_route (RouteGroup* route_group, uint32_t how_many, std::string name_template = "", boost::shared_ptr<PluginInfo> instrument = boost::shared_ptr<PluginInfo>());
590 void remove_routes (boost::shared_ptr<RouteList>);
591 void remove_route (boost::shared_ptr<Route>);
593 void resort_routes ();
594 void resort_routes_using (boost::shared_ptr<RouteList>);
596 AudioEngine & engine() { return _engine; }
597 AudioEngine const & engine () const { return _engine; }
599 static std::string default_track_name_pattern (DataType);
603 framepos_t transport_frame () const {return _transport_frame; }
604 framepos_t record_location () const {return _last_record_location; }
605 framepos_t audible_frame () const;
606 framepos_t requested_return_frame() const { return _requested_return_frame; }
607 void set_requested_return_frame(framepos_t return_to);
621 void sync_time_vars();
623 void bbt_time (framepos_t when, Timecode::BBT_Time&);
624 void timecode_to_sample(Timecode::Time& timecode, framepos_t& sample, bool use_offset, bool use_subframes) const;
625 void sample_to_timecode(framepos_t sample, Timecode::Time& timecode, bool use_offset, bool use_subframes) const;
626 void timecode_time (Timecode::Time &);
627 void timecode_time (framepos_t when, Timecode::Time&);
628 void timecode_time_subframes (framepos_t when, Timecode::Time&);
630 void timecode_duration (framecnt_t, Timecode::Time&) const;
631 void timecode_duration_string (char *, size_t len, framecnt_t) const;
633 framecnt_t convert_to_frames (AnyTime const & position);
634 framecnt_t any_duration_to_frames (framepos_t position, AnyTime const & duration);
636 static PBD::Signal1<void, framepos_t> StartTimeChanged;
637 static PBD::Signal1<void, framepos_t> EndTimeChanged;
639 void request_sync_source (Slave*);
640 bool synced_to_engine() const { return _slave && config.get_external_sync() && Config->get_sync_source() == Engine; }
641 bool synced_to_mtc () const { return config.get_external_sync() && Config->get_sync_source() == MTC && g_atomic_int_get (const_cast<gint*>(&_mtc_active)); }
642 bool synced_to_ltc () const { return config.get_external_sync() && Config->get_sync_source() == LTC && g_atomic_int_get (const_cast<gint*>(&_ltc_active)); }
644 double transport_speed() const { return _transport_speed; }
645 bool transport_stopped() const { return _transport_speed == 0.0f; }
646 bool transport_rolling() const { return _transport_speed != 0.0f; }
648 bool silent () { return _silent; }
650 TempoMap& tempo_map() { return *_tempo_map; }
651 const TempoMap& tempo_map() const { return *_tempo_map; }
653 unsigned int get_xrun_count () const {return _xrun_count; }
654 void reset_xrun_count () {_xrun_count = 0; }
658 boost::shared_ptr<Region> find_whole_file_parent (boost::shared_ptr<Region const>) const;
660 boost::shared_ptr<Region> XMLRegionFactory (const XMLNode&, bool full);
661 boost::shared_ptr<AudioRegion> XMLAudioRegionFactory (const XMLNode&, bool full);
662 boost::shared_ptr<MidiRegion> XMLMidiRegionFactory (const XMLNode&, bool full);
664 /* source management */
666 void import_files (ImportStatus&);
667 bool sample_rate_convert (ImportStatus&, std::string infile, std::string& outfile);
668 std::string build_tmp_convert_name (std::string file);
670 boost::shared_ptr<ExportHandler> get_export_handler ();
671 boost::shared_ptr<ExportStatus> get_export_status ();
673 int start_audio_export (framepos_t position);
675 PBD::Signal1<int, framecnt_t> ProcessExport;
676 static PBD::Signal2<void,std::string, std::string> Exported;
678 void add_source (boost::shared_ptr<Source>);
679 void remove_source (boost::weak_ptr<Source>);
681 void cleanup_regions();
682 bool can_cleanup_peakfiles () const;
683 int cleanup_peakfiles ();
684 int cleanup_sources (CleanupReport&);
685 int cleanup_trash_sources (CleanupReport&);
687 int destroy_sources (std::list<boost::shared_ptr<Source> >);
689 int remove_last_capture ();
691 /** handlers should return 0 for "everything OK", and any other value for
692 * "cannot setup audioengine".
694 static PBD::Signal1<int,uint32_t> AudioEngineSetupRequired;
696 /** handlers should return -1 for "stop cleanup",
697 0 for "yes, delete this playlist",
698 1 for "no, don't delete this playlist".
700 static PBD::Signal1<int,boost::shared_ptr<Playlist> > AskAboutPlaylistDeletion;
702 /** handlers should return 0 for "ignore the rate mismatch",
703 !0 for "do not use this session"
705 static PBD::Signal2<int, framecnt_t, framecnt_t> AskAboutSampleRateMismatch;
707 /** handlers should return !0 for use pending state, 0 for ignore it.
709 static PBD::Signal0<int> AskAboutPendingState;
711 boost::shared_ptr<AudioFileSource> create_audio_source_for_session (
712 size_t, std::string const &, uint32_t, bool destructive);
714 boost::shared_ptr<MidiSource> create_midi_source_for_session (std::string const &);
715 boost::shared_ptr<MidiSource> create_midi_source_by_stealing_name (boost::shared_ptr<Track>);
717 boost::shared_ptr<Source> source_by_id (const PBD::ID&);
718 boost::shared_ptr<AudioFileSource> audio_source_by_path_and_channel (const std::string&, uint16_t) const;
719 boost::shared_ptr<MidiSource> midi_source_by_path (const std::string&) const;
720 uint32_t count_sources_by_origin (const std::string&);
722 void add_playlist (boost::shared_ptr<Playlist>, bool unused = false);
724 /* Curves and AutomationLists (TODO when they go away) */
725 void add_automation_list(AutomationList*);
729 boost::shared_ptr<Auditioner> the_auditioner() { return auditioner; }
730 void audition_playlist ();
731 void audition_region (boost::shared_ptr<Region>);
732 void cancel_audition ();
733 bool is_auditioning () const;
735 PBD::Signal1<void,bool> AuditionActive;
738 void register_lua_function (const std::string&, const std::string&, const LuaScriptParamList&);
739 void unregister_lua_function (const std::string& name);
740 std::vector<std::string> registered_lua_functions ();
741 uint32_t registered_lua_function_count () const { return _n_lua_scripts; }
742 void scripts_changed (); // called from lua, updates _n_lua_scripts
744 /* flattening stuff */
746 boost::shared_ptr<Region> write_one_track (Track&, framepos_t start, framepos_t end,
747 bool overwrite, std::vector<boost::shared_ptr<Source> >&, InterThreadInfo& wot,
748 boost::shared_ptr<Processor> endpoint,
749 bool include_endpoint, bool for_export, bool for_freeze);
750 int freeze_all (InterThreadInfo&);
752 /* session-wide solo/mute/rec-enable */
754 bool soloing() const { return _non_soloed_outs_muted; }
755 bool listening() const { return _listen_cnt > 0; }
756 bool solo_isolated() const { return _solo_isolated_cnt > 0; }
758 static const SessionEvent::RTeventCallback rt_cleanup;
760 void set_solo (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, PBD::Controllable::GroupControlDisposition group_override = PBD::Controllable::UseGroup);
761 void clear_all_solo_state (boost::shared_ptr<RouteList>);
762 void set_just_one_solo (boost::shared_ptr<Route>, bool, SessionEvent::RTeventCallback after = rt_cleanup);
763 void set_mute (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, PBD::Controllable::GroupControlDisposition group_override = PBD::Controllable::UseGroup);
764 void set_listen (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, PBD::Controllable::GroupControlDisposition group_override = PBD::Controllable::UseGroup);
765 void set_record_enabled (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, PBD::Controllable::GroupControlDisposition group_override = PBD::Controllable::UseGroup);
766 void set_record_safe (boost::shared_ptr<RouteList>, bool yn, SessionEvent::RTeventCallback after = rt_cleanup, PBD::Controllable::GroupControlDisposition group_override = PBD::Controllable::UseGroup);
767 void set_solo_isolated (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, PBD::Controllable::GroupControlDisposition group_override = PBD::Controllable::UseGroup);
768 void set_monitoring (boost::shared_ptr<RouteList>, MonitorChoice, SessionEvent::RTeventCallback after = rt_cleanup, PBD::Controllable::GroupControlDisposition group_override = PBD::Controllable::UseGroup);
769 void set_exclusive_input_active (boost::shared_ptr<RouteList> rt, bool onoff, bool flip_others = false);
771 PBD::Signal1<void,bool> SoloActive;
772 PBD::Signal0<void> SoloChanged;
773 PBD::Signal0<void> IsolatedChanged;
774 PBD::Signal0<void> MonitorChanged;
776 PBD::Signal0<void> session_routes_reconnected;
778 /* monitor/master out */
780 void add_monitor_section ();
781 void reset_monitor_section ();
782 void remove_monitor_section ();
783 bool monitor_active() const { return (_monitor_out && _monitor_out->monitor_control () && _monitor_out->monitor_control ()->monitor_active()); }
785 boost::shared_ptr<Route> monitor_out() const { return _monitor_out; }
786 boost::shared_ptr<Route> master_out() const { return _master_out; }
788 void globally_add_internal_sends (boost::shared_ptr<Route> dest, Placement p, bool);
789 void globally_set_send_gains_from_track (boost::shared_ptr<Route> dest);
790 void globally_set_send_gains_to_zero (boost::shared_ptr<Route> dest);
791 void globally_set_send_gains_to_unity (boost::shared_ptr<Route> dest);
792 void add_internal_sends (boost::shared_ptr<Route> dest, Placement p, boost::shared_ptr<RouteList> senders);
793 void add_internal_send (boost::shared_ptr<Route>, int, boost::shared_ptr<Route>);
794 void add_internal_send (boost::shared_ptr<Route>, boost::shared_ptr<Processor>, boost::shared_ptr<Route>);
796 static void set_disable_all_loaded_plugins (bool yn) {
797 _disable_all_loaded_plugins = yn;
799 static bool get_disable_all_loaded_plugins() {
800 return _disable_all_loaded_plugins;
802 static void set_bypass_all_loaded_plugins (bool yn) {
803 _bypass_all_loaded_plugins = yn;
805 static bool get_bypass_all_loaded_plugins() {
806 return _bypass_all_loaded_plugins;
809 uint32_t next_send_id();
810 uint32_t next_aux_send_id();
811 uint32_t next_return_id();
812 uint32_t next_insert_id();
813 void mark_send_id (uint32_t);
814 void mark_aux_send_id (uint32_t);
815 void mark_return_id (uint32_t);
816 void mark_insert_id (uint32_t);
817 void unmark_send_id (uint32_t);
818 void unmark_aux_send_id (uint32_t);
819 void unmark_return_id (uint32_t);
820 void unmark_insert_id (uint32_t);
822 /* s/w "RAID" management */
824 boost::optional<framecnt_t> available_capture_duration();
828 void add_bundle (boost::shared_ptr<Bundle>, bool emit_signal = true);
829 void remove_bundle (boost::shared_ptr<Bundle>);
830 boost::shared_ptr<Bundle> bundle_by_name (std::string) const;
832 PBD::Signal0<void> BundleAddedOrRemoved;
836 /* History (for editors, mixers, UIs etc.) */
838 /** Undo some transactions.
839 * @param n Number of transactions to undo.
841 void undo (uint32_t n) {
845 void redo (uint32_t n) {
849 UndoHistory& history() { return _history; }
851 uint32_t undo_depth() const { return _history.undo_depth(); }
852 uint32_t redo_depth() const { return _history.redo_depth(); }
853 std::string next_undo() const { return _history.next_undo(); }
854 std::string next_redo() const { return _history.next_redo(); }
856 void begin_reversible_command (const std::string& cmd_name);
857 void begin_reversible_command (GQuark);
858 void abort_reversible_command ();
859 void commit_reversible_command (Command* cmd = 0);
861 void add_command (Command *const cmd);
863 /** @return The list of operations that are currently in progress */
864 std::list<GQuark> const & current_operations () {
865 return _current_trans_quarks;
868 bool operation_in_progress (GQuark) const;
870 void add_commands (std::vector<Command*> const & cmds);
872 std::map<PBD::ID,PBD::StatefulDestructible*> registry;
874 // these commands are implemented in libs/ardour/session_command.cc
875 Command* memento_command_factory(XMLNode* n);
876 Command* stateful_diff_command_factory (XMLNode *);
877 void register_with_memento_command_factory(PBD::ID, PBD::StatefulDestructible*);
881 boost::shared_ptr<IO> click_io() { return _click_io; }
882 boost::shared_ptr<Amp> click_gain() { return _click_gain; }
884 /* disk, buffer loads */
886 uint32_t playback_load ();
887 uint32_t capture_load ();
891 void request_play_range (std::list<AudioRange>*, bool leave_rolling = false);
892 void request_cancel_play_range ();
893 bool get_play_range () const { return _play_range; }
895 void maybe_update_session_range (framepos_t, framepos_t);
897 /* temporary hacks to allow selection to be pushed from GUI into backend.
898 Whenever we move the selection object into libardour, these will go away.
900 void set_range_selection (framepos_t start, framepos_t end);
901 void set_object_selection (framepos_t start, framepos_t end);
902 void clear_range_selection ();
903 void clear_object_selection ();
905 /* buffers for gain and pan */
907 gain_t* gain_automation_buffer () const;
908 gain_t* trim_automation_buffer () const;
909 gain_t* send_gain_automation_buffer () const;
910 pan_t** pan_automation_buffer () const;
912 void ensure_buffer_set (BufferSet& buffers, const ChanCount& howmany);
916 static int vst_current_loading_id;
917 static const char* vst_can_do_strings[];
918 static const int vst_can_do_string_count;
920 static intptr_t vst_callback (
929 static PBD::Signal0<void> SendFeedback;
933 boost::shared_ptr<Speakers> get_speakers ();
937 boost::shared_ptr<Processor> processor_by_id (PBD::ID) const;
939 boost::shared_ptr<PBD::Controllable> controllable_by_id (const PBD::ID&);
940 boost::shared_ptr<PBD::Controllable> controllable_by_descriptor (const PBD::ControllableDescriptor&);
942 void add_controllable (boost::shared_ptr<PBD::Controllable>);
943 void remove_controllable (PBD::Controllable*);
945 boost::shared_ptr<PBD::Controllable> solo_cut_control() const;
947 SessionConfiguration config;
949 bool exporting () const {
953 bool bounce_processing() const {
954 return _bounce_processing_active;
957 /* this is a private enum, but setup_enum_writer() needs it,
958 and i can't find a way to give that function
962 enum PostTransportWork {
963 PostTransportStop = 0x1,
964 PostTransportDuration = 0x2,
965 PostTransportLocate = 0x4,
966 PostTransportRoll = 0x8,
967 PostTransportAbort = 0x10,
968 PostTransportOverWrite = 0x20,
969 PostTransportSpeed = 0x40,
970 PostTransportAudition = 0x80,
971 PostTransportReverse = 0x100,
972 PostTransportInputChange = 0x200,
973 PostTransportCurveRealloc = 0x400,
974 PostTransportClearSubstate = 0x800,
975 PostTransportAdjustPlaybackBuffering = 0x1000,
976 PostTransportAdjustCaptureBuffering = 0x2000
985 SlaveState slave_state() const { return _slave_state; }
986 Slave* slave() const { return _slave; }
988 boost::shared_ptr<SessionPlaylists> playlists;
990 void send_mmc_locate (framepos_t);
991 void queue_full_time_code () { _send_timecode_update = true; }
992 void queue_song_position_pointer () { /* currently does nothing */ }
994 bool step_editing() const { return (_step_editors > 0); }
996 void request_suspend_timecode_transmission ();
997 void request_resume_timecode_transmission ();
998 bool timecode_transmission_suspended () const;
1000 std::vector<std::string> source_search_path(DataType) const;
1001 void ensure_search_path_includes (const std::string& path, DataType type);
1002 void remove_dir_from_search_path (const std::string& path, DataType type);
1004 std::list<std::string> unknown_processors () const;
1006 /** Emitted when a feedback cycle has been detected within Ardour's signal
1007 processing path. Until it is fixed (by the user) some (unspecified)
1008 routes will not be run.
1010 static PBD::Signal0<void> FeedbackDetected;
1012 /** Emitted when a graph sort has successfully completed, which means
1013 that it has no feedback cycles.
1015 static PBD::Signal0<void> SuccessfulGraphSort;
1017 /* handlers can return an integer value:
1018 0: config.set_audio_search_path() or config.set_midi_search_path() was used
1019 to modify the search path and we should try to find it again.
1020 1: quit entire session load
1021 2: as 0, but don't ask about other missing files
1022 3: don't ask about other missing files, and just mark this one missing
1023 -1: just mark this one missing
1024 any other value: as -1
1026 static PBD::Signal3<int,Session*,std::string,DataType> MissingFile;
1028 /** Emitted when the session wants Ardour to quit */
1029 static PBD::Signal0<void> Quit;
1031 /** Emitted when Ardour is asked to load a session in an older session
1032 * format, and makes a backup copy.
1034 static PBD::Signal2<void,std::string,std::string> VersionMismatch;
1036 SceneChanger* scene_changer() const { return _scene_changer; }
1038 /* asynchronous MIDI control ports */
1040 boost::shared_ptr<Port> midi_input_port () const;
1041 boost::shared_ptr<Port> midi_output_port () const;
1042 boost::shared_ptr<Port> mmc_output_port () const;
1043 boost::shared_ptr<Port> mmc_input_port () const;
1044 boost::shared_ptr<Port> scene_input_port () const;
1045 boost::shared_ptr<Port> scene_output_port () const;
1047 /* synchronous MIDI ports used for synchronization */
1049 boost::shared_ptr<MidiPort> midi_clock_output_port () const;
1050 boost::shared_ptr<MidiPort> midi_clock_input_port () const;
1051 boost::shared_ptr<MidiPort> mtc_output_port () const;
1052 boost::shared_ptr<MidiPort> mtc_input_port () const;
1053 boost::shared_ptr<Port> ltc_input_port() const;
1054 boost::shared_ptr<Port> ltc_output_port() const;
1056 boost::shared_ptr<IO> ltc_input_io() { return _ltc_input; }
1057 boost::shared_ptr<IO> ltc_output_io() { return _ltc_output; }
1059 MIDI::MachineControl& mmc() { return *_mmc; }
1061 void reconnect_midi_scene_ports (bool);
1062 void reconnect_mtc_ports ();
1063 void reconnect_mmc_ports (bool);
1065 void reconnect_ltc_input ();
1066 void reconnect_ltc_output ();
1069 friend class AudioEngine;
1070 void set_block_size (pframes_t nframes);
1071 void set_frame_rate (framecnt_t nframes);
1072 void reconnect_existing_routes (bool withLock, bool reconnect_master = true, bool reconnect_inputs = true, bool reconnect_outputs = true);
1076 void schedule_curve_reallocation ();
1077 void update_latency_compensation (bool force = false);
1080 int create (const std::string& mix_template, BusProfile*);
1084 PendingDeclickIn = 0x1, ///< pending de-click fade-in for start
1085 PendingDeclickOut = 0x2, ///< pending de-click fade-out for stop
1086 StopPendingCapture = 0x4,
1087 PendingLoopDeclickIn = 0x8, ///< pending de-click fade-in at the start of a loop
1088 PendingLoopDeclickOut = 0x10, ///< pending de-click fade-out at the end of a loop
1089 PendingLocate = 0x20,
1092 /* stuff used in process() should be close together to
1096 typedef void (Session::*process_function_type)(pframes_t);
1098 AudioEngine& _engine;
1099 mutable gint processing_prohibited;
1100 process_function_type process_function;
1101 process_function_type last_process_function;
1102 bool _bounce_processing_active;
1103 bool waiting_for_sync_offset;
1104 framecnt_t _base_frame_rate;
1105 framecnt_t _current_frame_rate; //this includes video pullup offset
1106 framecnt_t _nominal_frame_rate; //ignores audioengine setting, "native" SR
1107 int transport_sub_state;
1108 mutable gint _record_status;
1109 framepos_t _transport_frame;
1110 Location* _session_range_location; ///< session range, or 0 if there is nothing in the session yet
1114 // varispeed playback
1115 double _transport_speed;
1116 double _default_transport_speed;
1117 double _last_transport_speed;
1118 double _signalled_varispeed;
1119 double _target_transport_speed;
1120 CubicInterpolation interpolation;
1122 bool auto_play_legal;
1123 framepos_t _last_slave_transport_frame;
1124 framecnt_t maximum_output_latency;
1125 framepos_t _requested_return_frame;
1126 pframes_t current_block_size;
1127 framecnt_t _worst_output_latency;
1128 framecnt_t _worst_input_latency;
1129 framecnt_t _worst_track_latency;
1130 bool _have_captured;
1131 bool _non_soloed_outs_muted;
1133 uint32_t _listen_cnt;
1134 uint32_t _solo_isolated_cnt;
1137 bool _under_nsm_control;
1138 unsigned int _xrun_count;
1140 void mtc_status_changed (bool);
1141 PBD::ScopedConnection mtc_status_connection;
1142 void ltc_status_changed (bool);
1143 PBD::ScopedConnection ltc_status_connection;
1145 void initialize_latencies ();
1146 void set_worst_io_latencies ();
1147 void set_worst_playback_latency ();
1148 void set_worst_capture_latency ();
1149 void set_worst_io_latencies_x (IOChange, void *) {
1150 set_worst_io_latencies ();
1152 void post_capture_latency ();
1153 void post_playback_latency ();
1155 void update_latency_compensation_proxy (void* ignored);
1157 void ensure_buffers (ChanCount howmany = ChanCount::ZERO);
1159 void process_scrub (pframes_t);
1160 void process_without_events (pframes_t);
1161 void process_with_events (pframes_t);
1162 void process_audition (pframes_t);
1163 int process_export (pframes_t);
1164 int process_export_fw (pframes_t);
1166 void block_processing() { g_atomic_int_set (&processing_prohibited, 1); }
1167 void unblock_processing() { g_atomic_int_set (&processing_prohibited, 0); }
1168 bool processing_blocked() const { return g_atomic_int_get (&processing_prohibited); }
1170 static const framecnt_t bounce_chunk_size;
1172 /* slave tracking */
1174 static const int delta_accumulator_size = 25;
1175 int delta_accumulator_cnt;
1176 int32_t delta_accumulator[delta_accumulator_size];
1177 int32_t average_slave_delta;
1179 bool have_first_delta_accumulator;
1181 SlaveState _slave_state;
1184 framepos_t slave_wait_end;
1186 void reset_slave_state ();
1187 bool follow_slave (pframes_t);
1188 void calculate_moving_average_of_slave_delta (int dir, framecnt_t this_delta);
1189 void track_slave_state (float slave_speed, framepos_t slave_transport_frame, framecnt_t this_delta);
1190 void follow_slave_silently (pframes_t nframes, float slave_speed);
1192 void switch_to_sync_source (SyncSource); /* !RT context */
1193 void drop_sync_source (); /* !RT context */
1194 void use_sync_source (Slave*); /* RT context */
1196 bool post_export_sync;
1197 framepos_t post_export_position;
1200 bool _export_rolling;
1201 framepos_t _export_preroll;
1203 boost::shared_ptr<ExportHandler> export_handler;
1204 boost::shared_ptr<ExportStatus> export_status;
1207 int stop_audio_export ();
1208 void finalize_audio_export ();
1209 void finalize_export_internal (bool stop_freewheel);
1210 bool _pre_export_mmc_enabled;
1212 PBD::ScopedConnection export_freewheel_connection;
1214 void get_track_statistics ();
1215 int process_routes (pframes_t, bool& need_butler);
1216 int silent_process_routes (pframes_t, bool& need_butler);
1218 /** @return 1 if there is a pending declick fade-in,
1219 -1 if there is a pending declick fade-out,
1220 0 if there is no pending declick.
1222 int get_transport_declick_required () {
1223 if (transport_sub_state & PendingDeclickIn) {
1224 transport_sub_state &= ~PendingDeclickIn;
1226 } else if (transport_sub_state & PendingDeclickOut) {
1227 /* XXX: not entirely sure why we don't clear this */
1229 } else if (transport_sub_state & PendingLoopDeclickOut) {
1230 /* Return the declick out first ... */
1231 transport_sub_state &= ~PendingLoopDeclickOut;
1233 } else if (transport_sub_state & PendingLoopDeclickIn) {
1234 /* ... then the declick in on the next call */
1235 transport_sub_state &= ~PendingLoopDeclickIn;
1242 bool maybe_stop (framepos_t limit);
1243 bool maybe_sync_start (pframes_t &);
1245 void check_declick_out ();
1251 /** Number of process frames since the last MTC output (when sending MTC); used to
1252 * know when to send full MTC messages every so often.
1254 pframes_t _pframes_since_last_mtc;
1255 bool session_midi_feedback;
1258 framepos_t last_loopend;
1260 boost::scoped_ptr<SessionDirectory> _session_dir;
1263 void graph_reordered ();
1265 /** current snapshot name, without the .ardour suffix */
1266 void set_snapshot_name (const std::string &);
1267 void save_snapshot_name (const std::string &);
1268 std::string _current_snapshot_name;
1270 XMLTree* state_tree;
1271 bool state_was_pending;
1272 StateOfTheState _state_of_the_state;
1274 friend class StateProtector;
1275 gint _suspend_save; /* atomic */
1276 volatile bool _save_queued;
1277 Glib::Threads::Mutex save_state_lock;
1278 Glib::Threads::Mutex peak_cleanup_lock;
1280 int load_options (const XMLNode&);
1281 int load_state (std::string snapshot_name);
1283 framepos_t _last_roll_location;
1284 /** the session frame time at which we last rolled, located, or changed transport direction */
1285 framepos_t _last_roll_or_reversal_location;
1286 framepos_t _last_record_location;
1288 bool pending_locate_roll;
1289 framepos_t pending_locate_frame;
1290 bool pending_locate_flush;
1292 bool pending_auto_loop;
1294 PBD::ReallocPool _mempool;
1296 Glib::Threads::Mutex lua_lock;
1297 luabridge::LuaRef * _lua_run;
1298 luabridge::LuaRef * _lua_add;
1299 luabridge::LuaRef * _lua_del;
1300 luabridge::LuaRef * _lua_list;
1301 luabridge::LuaRef * _lua_load;
1302 luabridge::LuaRef * _lua_save;
1303 luabridge::LuaRef * _lua_cleanup;
1304 uint32_t _n_lua_scripts;
1307 void try_run_lua (pframes_t);
1311 static const PostTransportWork ProcessCannotProceedMask =
1313 PostTransportInputChange|
1315 PostTransportReverse|
1316 PostTransportCurveRealloc|
1317 PostTransportAudition|
1318 PostTransportLocate|
1320 PostTransportClearSubstate);
1322 gint _post_transport_work; /* accessed only atomic ops */
1323 PostTransportWork post_transport_work() const { return (PostTransportWork) g_atomic_int_get (const_cast<gint*>(&_post_transport_work)); }
1324 void set_post_transport_work (PostTransportWork ptw) { g_atomic_int_set (&_post_transport_work, (gint) ptw); }
1325 void add_post_transport_work (PostTransportWork ptw);
1327 void schedule_playback_buffering_adjustment ();
1328 void schedule_capture_buffering_adjustment ();
1330 uint32_t cumulative_rf_motion;
1333 void set_rf_speed (float speed);
1334 void reset_rf_scale (framecnt_t frames_moved);
1336 Locations* _locations;
1337 void location_added (Location*);
1338 void location_removed (Location*);
1339 void locations_changed ();
1340 void _locations_changed (const Locations::LocationList&);
1342 void update_skips (Location*, bool consolidate);
1343 void update_marks (Location* loc);
1344 void consolidate_skips (Location*);
1345 void sync_locations_to_skips ();
1346 void _sync_locations_to_skips ();
1348 PBD::ScopedConnectionList skip_update_connections;
1349 bool _ignore_skips_updates;
1351 PBD::ScopedConnectionList punch_connections;
1352 void auto_punch_start_changed (Location *);
1353 void auto_punch_end_changed (Location *);
1354 void auto_punch_changed (Location *);
1356 PBD::ScopedConnectionList loop_connections;
1357 void auto_loop_changed (Location *);
1358 void auto_loop_declick_range (Location *, framepos_t &, framepos_t &);
1360 int ensure_engine (uint32_t desired_sample_rate);
1361 void pre_engine_init (std::string path);
1362 int post_engine_init ();
1363 int immediately_post_engine ();
1364 void remove_empty_sounds ();
1366 void session_loaded ();
1368 void setup_midi_control ();
1369 int midi_read (MIDI::Port *);
1371 void enable_record ();
1373 void increment_transport_position (framecnt_t val) {
1374 if (max_framepos - val < _transport_frame) {
1375 _transport_frame = max_framepos;
1377 _transport_frame += val;
1381 void decrement_transport_position (framecnt_t val) {
1382 if (val < _transport_frame) {
1383 _transport_frame -= val;
1385 _transport_frame = 0;
1389 void post_transport_motion ();
1390 static void *session_loader_thread (void *arg);
1394 /* Signal Forwarding */
1395 void emit_route_signals ();
1396 void emit_thread_run ();
1397 static void *emit_thread (void *);
1398 void emit_thread_start ();
1399 void emit_thread_terminate ();
1401 pthread_t _rt_emit_thread;
1402 bool _rt_thread_active;
1404 pthread_mutex_t _rt_emit_mutex;
1405 pthread_cond_t _rt_emit_cond;
1406 bool _rt_emit_pending;
1409 /* SessionEventManager interface */
1411 void process_event (SessionEvent*);
1412 void set_next_event ();
1413 void cleanup_event (SessionEvent*,int);
1415 /* MIDI Machine Control */
1418 void spp_continue ();
1421 void mmc_deferred_play (MIDI::MachineControl &);
1422 void mmc_stop (MIDI::MachineControl &);
1423 void mmc_step (MIDI::MachineControl &, int);
1424 void mmc_pause (MIDI::MachineControl &);
1425 void mmc_record_pause (MIDI::MachineControl &);
1426 void mmc_record_strobe (MIDI::MachineControl &);
1427 void mmc_record_exit (MIDI::MachineControl &);
1428 void mmc_track_record_status (MIDI::MachineControl &, uint32_t track, bool enabled);
1429 void mmc_fast_forward (MIDI::MachineControl &);
1430 void mmc_rewind (MIDI::MachineControl &);
1431 void mmc_locate (MIDI::MachineControl &, const MIDI::byte *);
1432 void mmc_shuttle (MIDI::MachineControl &mmc, float speed, bool forw);
1433 void mmc_record_enable (MIDI::MachineControl &mmc, size_t track, bool enabled);
1435 struct timeval last_mmc_step;
1438 typedef boost::function<bool()> MidiTimeoutCallback;
1439 typedef std::list<MidiTimeoutCallback> MidiTimeoutList;
1441 MidiTimeoutList midi_timeouts;
1442 bool mmc_step_timeout ();
1443 void send_immediate_mmc (MIDI::MachineControlCommand);
1445 MIDI::byte mtc_msg[16];
1446 MIDI::byte mtc_timecode_bits; /* encoding of SMTPE type for MTC */
1447 MIDI::byte midi_msg[16];
1448 double outbound_mtc_timecode_frame;
1449 Timecode::Time transmitting_timecode_time;
1450 int next_quarter_frame_to_send;
1452 double _frames_per_timecode_frame; /* has to be floating point because of drop frame */
1453 framecnt_t _frames_per_hour;
1454 framecnt_t _timecode_frames_per_hour;
1456 /* cache the most-recently requested time conversions. This helps when we
1457 * have multiple clocks showing the same time (e.g. the transport frame) */
1458 bool last_timecode_valid;
1459 framepos_t last_timecode_when;
1460 Timecode::Time last_timecode;
1462 bool _send_timecode_update; ///< Flag to send a full frame (Timecode) MTC message this cycle
1464 int send_midi_time_code_for_cycle (framepos_t, framepos_t, pframes_t nframes);
1466 LTCEncoder* ltc_encoder;
1467 ltcsnd_sample_t* ltc_enc_buf;
1469 Timecode::TimecodeFormat ltc_enc_tcformat;
1470 int32_t ltc_buf_off;
1471 int32_t ltc_buf_len;
1474 int32_t ltc_enc_byte;
1475 framepos_t ltc_enc_pos;
1477 framepos_t ltc_enc_off;
1479 framepos_t ltc_prev_cycle;
1481 framepos_t ltc_timecode_offset;
1482 bool ltc_timecode_negative_offset;
1484 LatencyRange ltc_out_latency;
1486 void ltc_tx_initialize();
1487 void ltc_tx_cleanup();
1488 void ltc_tx_reset();
1489 void ltc_tx_resync_latency();
1490 void ltc_tx_recalculate_position();
1491 void ltc_tx_parse_offset();
1492 void ltc_tx_send_time_code_for_cycle (framepos_t, framepos_t, double, double, pframes_t nframes);
1494 void reset_record_status ();
1496 int no_roll (pframes_t nframes);
1497 int fail_roll (pframes_t nframes);
1499 bool non_realtime_work_pending() const { return static_cast<bool>(post_transport_work()); }
1500 bool process_can_proceed() const { return !(post_transport_work() & ProcessCannotProceedMask); }
1502 MidiControlUI* midi_control_ui;
1504 int start_midi_thread ();
1506 void set_play_loop (bool yn, double speed);
1507 void unset_play_loop ();
1508 void overwrite_some_buffers (Track *);
1509 void flush_all_inserts ();
1510 int micro_locate (framecnt_t distance);
1511 void locate (framepos_t, bool with_roll, bool with_flush, bool with_loop=false, bool force=false, bool with_mmc=true);
1512 void start_locate (framepos_t, bool with_roll, bool with_flush, bool for_loop_enabled=false, bool force=false);
1513 void force_locate (framepos_t frame, bool with_roll = false);
1514 void set_track_speed (Track *, double speed);
1515 void set_transport_speed (double speed, framepos_t destination_frame, bool abort = false, bool clear_state = false, bool as_default = false);
1516 void stop_transport (bool abort = false, bool clear_state = false);
1517 void start_transport ();
1518 void realtime_stop (bool abort, bool clear_state);
1519 void realtime_locate ();
1520 void non_realtime_start_scrub ();
1521 void non_realtime_set_speed ();
1522 void non_realtime_locate ();
1523 void non_realtime_stop (bool abort, int entry_request_count, bool& finished);
1524 void non_realtime_overwrite (int entry_request_count, bool& finished);
1525 void post_transport ();
1526 void engine_halted ();
1527 void xrun_recovery ();
1528 void set_track_loop (bool);
1529 bool select_playhead_priority_target (framepos_t&);
1530 void follow_playhead_priority ();
1532 /* These are synchronous and so can only be called from within the process
1536 int send_full_time_code (framepos_t, pframes_t nframes);
1537 void send_song_position_pointer (framepos_t);
1539 TempoMap *_tempo_map;
1540 void tempo_map_changed (const PBD::PropertyChange&);
1542 /* edit/mix groups */
1544 int load_route_groups (const XMLNode&, int);
1546 std::list<RouteGroup *> _route_groups;
1547 RouteGroup* _all_route_group;
1551 boost::shared_ptr<Graph> _process_graph;
1553 SerializedRCUManager<RouteList> routes;
1555 void add_routes (RouteList&, bool input_auto_connect, bool output_auto_connect, bool save);
1556 void add_routes_inner (RouteList&, bool input_auto_connect, bool output_auto_connect);
1557 bool _adding_routes_in_progress;
1558 bool _reconnecting_routes_in_progress;
1559 bool _route_deletion_in_progress;
1561 uint32_t destructive_index;
1563 boost::shared_ptr<Route> XMLRouteFactory (const XMLNode&, int);
1564 boost::shared_ptr<Route> XMLRouteFactory_2X (const XMLNode&, int);
1566 void route_processors_changed (RouteProcessorChange);
1568 bool find_route_name (std::string const &, uint32_t& id, std::string& name, bool);
1569 void count_existing_track_channels (ChanCount& in, ChanCount& out);
1570 void auto_connect_route (boost::shared_ptr<Route> route, ChanCount& existing_inputs, ChanCount& existing_outputs,
1571 bool with_lock, bool connect_inputs = true,
1572 ChanCount input_start = ChanCount (), ChanCount output_start = ChanCount ());
1573 void midi_output_change_handler (IOChange change, void* /*src*/, boost::weak_ptr<Route> midi_track);
1575 /* track numbering */
1577 void reassign_track_numbers ();
1578 uint32_t _track_number_decimals;
1582 void route_listen_changed (PBD::Controllable::GroupControlDisposition, boost::weak_ptr<Route>);
1583 void route_mute_changed ();
1584 void route_solo_changed (bool self_solo_change, PBD::Controllable::GroupControlDisposition group_override, boost::weak_ptr<Route>);
1585 void route_solo_isolated_changed (boost::weak_ptr<Route>);
1586 void update_route_solo_state (boost::shared_ptr<RouteList> r = boost::shared_ptr<RouteList>());
1588 void listen_position_changed ();
1589 void solo_control_mode_changed ();
1591 /* REGION MANAGEMENT */
1593 mutable Glib::Threads::Mutex region_lock;
1595 int load_regions (const XMLNode& node);
1596 int load_compounds (const XMLNode& node);
1598 void route_added_to_route_group (RouteGroup *, boost::weak_ptr<Route>);
1599 void route_removed_from_route_group (RouteGroup *, boost::weak_ptr<Route>);
1600 void route_group_property_changed (RouteGroup *);
1604 mutable Glib::Threads::Mutex source_lock;
1607 typedef std::map<PBD::ID,boost::shared_ptr<Source> > SourceMap;
1610 void reset_write_sources (bool mark_write_complete, bool force = false);
1615 int load_sources (const XMLNode& node);
1616 XMLNode& get_sources_as_xml ();
1618 boost::shared_ptr<Source> XMLSourceFactory (const XMLNode&);
1622 void remove_playlist (boost::weak_ptr<Playlist>);
1623 void track_playlist_changed (boost::weak_ptr<Track>);
1624 void playlist_region_added (boost::weak_ptr<Region>);
1625 void playlist_ranges_moved (std::list<Evoral::RangeMove<framepos_t> > const &);
1626 void playlist_regions_extended (std::list<Evoral::Range<framepos_t> > const &);
1628 /* CURVES and AUTOMATION LISTS */
1629 std::map<PBD::ID, AutomationList*> automation_lists;
1631 /* DEFAULT FADE CURVES */
1633 float default_fade_steepness;
1634 float default_fade_msecs;
1638 boost::shared_ptr<Auditioner> auditioner;
1639 void set_audition (boost::shared_ptr<Region>);
1640 void non_realtime_set_audition ();
1641 boost::shared_ptr<Region> pending_audition_region;
1647 int flatten_one_track (AudioTrack&, framepos_t start, framecnt_t cnt);
1649 /* INSERT AND SEND MANAGEMENT */
1651 boost::dynamic_bitset<uint32_t> send_bitset;
1652 boost::dynamic_bitset<uint32_t> aux_send_bitset;
1653 boost::dynamic_bitset<uint32_t> return_bitset;
1654 boost::dynamic_bitset<uint32_t> insert_bitset;
1658 struct space_and_path {
1659 uint32_t blocks; ///< 4kB blocks
1660 bool blocks_unknown; ///< true if blocks is unknown
1665 , blocks_unknown (true)
1669 struct space_and_path_ascending_cmp {
1670 bool operator() (space_and_path a, space_and_path b) {
1671 if (a.blocks_unknown != b.blocks_unknown) {
1672 return !a.blocks_unknown;
1674 return a.blocks > b.blocks;
1678 void setup_raid_path (std::string path);
1680 std::vector<space_and_path> session_dirs;
1681 std::vector<space_and_path>::iterator last_rr_session_dir;
1682 uint32_t _total_free_4k_blocks;
1683 /** If this is true, _total_free_4k_blocks is not definite,
1684 as one or more of the session directories' filesystems
1685 could not report free space.
1687 bool _total_free_4k_blocks_uncertain;
1688 Glib::Threads::Mutex space_lock;
1690 bool no_questions_about_missing_files;
1692 std::string get_best_session_directory_for_new_audio ();
1694 mutable gint _playback_load;
1695 mutable gint _capture_load;
1699 SerializedRCUManager<BundleList> _bundles;
1700 XMLNode* _bundle_xml_node;
1701 int load_bundles (XMLNode const &);
1703 UndoHistory _history;
1704 /** current undo transaction, or 0 */
1705 UndoTransaction* _current_trans;
1706 /** GQuarks to describe the reversible commands that are currently in progress.
1707 * These may be nested, in which case more recently-started commands are toward
1708 * the front of the list.
1710 std::list<GQuark> _current_trans_quarks;
1712 int backend_sync_callback (TransportState, framepos_t);
1714 void process_rtop (SessionEvent*);
1716 void update_latency (bool playback);
1718 XMLNode& state(bool);
1721 typedef std::list<Click*> Clicks;
1724 boost::shared_ptr<IO> _click_io;
1725 boost::shared_ptr<Amp> _click_gain;
1727 Sample* click_emphasis_data;
1728 framecnt_t click_length;
1729 framecnt_t click_emphasis_length;
1730 mutable Glib::Threads::RWLock click_lock;
1732 static const Sample default_click[];
1733 static const framecnt_t default_click_length;
1734 static const Sample default_click_emphasis[];
1735 static const framecnt_t default_click_emphasis_length;
1738 framepos_t _clicks_cleared;
1739 void setup_click_sounds (int which);
1740 void setup_click_sounds (Sample**, Sample const *, framecnt_t*, framecnt_t, std::string const &);
1741 void clear_clicks ();
1742 void click (framepos_t start, framecnt_t nframes);
1744 std::vector<Route*> master_outs;
1746 /* range playback */
1748 std::list<AudioRange> current_audio_range;
1750 void set_play_range (std::list<AudioRange>&, bool leave_rolling);
1751 void unset_play_range ();
1753 /* temporary hacks to allow selection to be pushed from GUI into backend
1754 Whenever we move the selection object into libardour, these will go away.
1756 Evoral::Range<framepos_t> _range_selection;
1757 Evoral::Range<framepos_t> _object_selection;
1762 boost::shared_ptr<Route> _master_out;
1763 boost::shared_ptr<Route> _monitor_out;
1765 void auto_connect_master_bus ();
1767 /* Windows VST support */
1769 long _windows_vst_callback (
1778 int find_all_sources (std::string path, std::set<std::string>& result);
1779 int find_all_sources_across_snapshots (std::set<std::string>& result, bool exclude_this_snapshot);
1781 typedef std::set<boost::shared_ptr<PBD::Controllable> > Controllables;
1782 Glib::Threads::Mutex controllables_lock;
1783 Controllables controllables;
1785 boost::shared_ptr<PBD::Controllable> _solo_cut_control;
1787 void reset_native_file_format();
1788 bool first_file_data_format_reset;
1789 bool first_file_header_format_reset;
1791 void config_changed (std::string, bool);
1793 XMLNode& get_control_protocol_state ();
1795 void set_history_depth (uint32_t depth);
1797 static bool _disable_all_loaded_plugins;
1798 static bool _bypass_all_loaded_plugins;
1800 mutable bool have_looped; ///< Used in ::audible_frame(*)
1802 void update_route_record_state ();
1803 gint _have_rec_enabled_track;
1804 gint _have_rec_disabled_track;
1806 static int ask_about_playlist_deletion (boost::shared_ptr<Playlist>);
1808 /* realtime "apply to set of routes" operations */
1809 template<typename T> SessionEvent*
1810 get_rt_event (boost::shared_ptr<RouteList> rl, T targ, SessionEvent::RTeventCallback after, PBD::Controllable::GroupControlDisposition group_override,
1811 void (Session::*method) (boost::shared_ptr<RouteList>, T, PBD::Controllable::GroupControlDisposition)) {
1812 SessionEvent* ev = new SessionEvent (SessionEvent::RealTimeOperation, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
1813 ev->rt_slot = boost::bind (method, this, rl, targ, group_override);
1814 ev->rt_return = after;
1815 ev->event_loop = PBD::EventLoop::get_event_loop_for_thread ();
1820 void rt_set_solo (boost::shared_ptr<RouteList>, bool yn, PBD::Controllable::GroupControlDisposition group_override);
1821 void rt_clear_all_solo_state (boost::shared_ptr<RouteList>, bool yn, PBD::Controllable::GroupControlDisposition group_override);
1822 void rt_set_just_one_solo (boost::shared_ptr<RouteList>, bool yn, PBD::Controllable::GroupControlDisposition /* ignored*/ );
1823 void rt_set_mute (boost::shared_ptr<RouteList>, bool yn, PBD::Controllable::GroupControlDisposition group_override);
1824 void rt_set_listen (boost::shared_ptr<RouteList>, bool yn, PBD::Controllable::GroupControlDisposition group_override);
1825 void rt_set_solo_isolated (boost::shared_ptr<RouteList>, bool yn, PBD::Controllable::GroupControlDisposition group_override);
1826 void rt_set_record_enabled (boost::shared_ptr<RouteList>, bool yn, PBD::Controllable::GroupControlDisposition group_override);
1827 void rt_set_record_safe (boost::shared_ptr<RouteList>, bool yn, PBD::Controllable::GroupControlDisposition group_override);
1828 void rt_set_monitoring (boost::shared_ptr<RouteList>, MonitorChoice, PBD::Controllable::GroupControlDisposition group_override);
1830 /** temporary list of Diskstreams used only during load of 2.X sessions */
1831 std::list<boost::shared_ptr<Diskstream> > _diskstreams_2X;
1833 void set_session_range_location (framepos_t, framepos_t);
1835 void setup_midi_machine_control ();
1837 void step_edit_status_change (bool);
1838 uint32_t _step_editors;
1840 /** true if timecode transmission by the transport is suspended, otherwise false */
1841 mutable gint _suspend_timecode_transmission;
1843 void update_locations_after_tempo_map_change (const Locations::LocationList &);
1845 void start_time_changed (framepos_t);
1846 void end_time_changed (framepos_t);
1848 void set_track_monitor_input_status (bool);
1849 framepos_t compute_stop_limit () const;
1851 boost::shared_ptr<Speakers> _speakers;
1852 void load_nested_sources (const XMLNode& node);
1854 /** The directed graph of routes that is currently being used for audio processing
1855 and solo/mute computations.
1857 GraphEdges _current_route_graph;
1859 uint32_t next_control_id () const;
1860 int32_t _order_hint;
1861 bool ignore_route_processor_changes;
1863 MidiClockTicker* midi_clock;
1865 boost::shared_ptr<IO> _ltc_input;
1866 boost::shared_ptr<IO> _ltc_output;
1868 /* Scene Changing */
1869 SceneChanger* _scene_changer;
1871 /* persistent, non-track related MIDI ports */
1872 MidiPortManager* _midi_ports;
1873 MIDI::MachineControl* _mmc;
1876 void setup_click ();
1877 void setup_click_state (const XMLNode*);
1878 void setup_bundles ();
1880 void save_as_bring_callback (uint32_t, uint32_t, std::string);
1882 static int get_session_info_from_path (XMLTree& state_tree, const std::string& xmlpath);
1883 static const uint32_t session_end_shift;
1885 std::string _template_state_dir;
1889 } // namespace ARDOUR
1891 #endif /* __ardour_session_h__ */