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__
31 #include <boost/dynamic_bitset.hpp>
32 #include <boost/scoped_ptr.hpp>
33 #include <boost/weak_ptr.hpp>
34 #include <boost/utility.hpp>
36 #include <glibmm/thread.h>
38 #include "pbd/error.h"
40 #include "pbd/statefuldestructible.h"
41 #include "pbd/signals.h"
44 #include "midi++/types.h"
46 #include "ardour/ardour.h"
47 #include "ardour/click.h"
48 #include "ardour/chan_count.h"
49 #include "ardour/rc_configuration.h"
50 #include "ardour/session_configuration.h"
51 #include "ardour/session_event.h"
52 #include "ardour/location.h"
53 #include "ardour/timecode.h"
54 #include "ardour/interpolation.h"
56 #ifdef HAVE_JACK_SESSION
57 #include <jack/session.h>
72 class ControllableDescriptor;
82 class AudioFileSource;
102 class NamedSelection;
115 class SessionDirectory;
116 class SessionMetadata;
117 class SessionPlaylists;
125 extern void setup_enum_writer ();
127 class Session : public PBD::StatefulDestructible, public PBD::ScopedConnectionList, public SessionEventManager
136 /* a new session might have non-empty mix_template, an existing session should always have an empty one.
137 the bus profile can be null if no master out bus is required.
140 Session (AudioEngine&,
141 const std::string& fullpath,
142 const std::string& snapshot_name,
143 BusProfile* bus_profile = 0,
144 std::string mix_template = "");
148 std::string path() const { return _path; }
149 std::string name() const { return _name; }
150 std::string snap_name() const { return _current_snapshot_name; }
151 std::string raid_path () const;
152 bool path_is_within_session (const std::string&);
154 void set_snap_name ();
156 bool writable() const { return _writable; }
159 bool dirty() const { return _state_of_the_state & Dirty; }
160 void set_deletion_in_progress ();
161 void clear_deletion_in_progress ();
162 bool deletion_in_progress() const { return _state_of_the_state & Deletion; }
163 PBD::Signal0<void> DirtyChanged;
165 const SessionDirectory& session_directory () const { return *(_session_dir.get()); }
167 static PBD::Signal0<void> AutoBindingOn;
168 static PBD::Signal0<void> AutoBindingOff;
170 static PBD::Signal1<void,std::string> Dialog;
172 std::string sound_dir (bool with_path = true) const;
173 std::string peak_dir () const;
174 std::string dead_sound_dir () const;
175 std::string automation_dir () const;
176 std::string analysis_dir() const;
178 int ensure_subdirs ();
180 std::string peak_path (std::string) const;
182 std::string change_source_path_by_name (std::string oldpath, std::string oldname, std::string newname, bool destructive);
184 std::string peak_path_from_audio_path (std::string) const;
185 std::string new_audio_source_name (const std::string&, uint32_t nchans, uint32_t chan, bool destructive);
186 std::string new_midi_source_name (const std::string&);
187 std::string new_source_path_from_name (DataType type, const std::string&, bool as_stub = false);
188 RouteList new_route_from_template (uint32_t how_many, const std::string& template_path);
190 void process (nframes_t nframes);
192 BufferSet& get_silent_buffers (ChanCount count = ChanCount::ZERO);
193 BufferSet& get_scratch_buffers (ChanCount count = ChanCount::ZERO);
194 BufferSet& get_mix_buffers (ChanCount count = ChanCount::ZERO);
196 bool have_rec_enabled_track () const;
198 bool have_captured() const { return _have_captured; }
200 void refill_all_track_buffers ();
201 Butler* butler() { return _butler; }
202 void butler_transport_work ();
204 void refresh_disk_space ();
206 int load_diskstreams_2X (XMLNode const &, int);
208 int load_routes (const XMLNode&, int);
209 boost::shared_ptr<RouteList> get_routes() const {
210 return routes.reader ();
213 boost::shared_ptr<RouteList> get_routes_with_internal_returns() const;
215 boost::shared_ptr<RouteList> get_routes_with_regions_at (framepos_t const) const;
217 uint32_t nroutes() const { return routes.reader()->size(); }
218 uint32_t ntracks () const;
219 uint32_t nbusses () const;
221 boost::shared_ptr<BundleList> bundles () {
222 return _bundles.reader ();
225 struct RoutePublicOrderSorter {
226 bool operator() (boost::shared_ptr<Route>, boost::shared_ptr<Route> b);
229 void sync_order_keys (std::string const &);
231 template<class T> void foreach_route (T *obj, void (T::*func)(Route&));
232 template<class T> void foreach_route (T *obj, void (T::*func)(boost::shared_ptr<Route>));
233 template<class T, class A> void foreach_route (T *obj, void (T::*func)(Route&, A), A arg);
235 bool io_name_is_legal (const std::string&);
236 boost::shared_ptr<Route> route_by_name (std::string);
237 boost::shared_ptr<Route> route_by_id (PBD::ID);
238 boost::shared_ptr<Route> route_by_remote_id (uint32_t id);
240 bool route_name_unique (std::string) const;
241 bool route_name_internal (std::string) const;
243 bool get_record_enabled() const {
244 return (record_status () >= Enabled);
247 RecordState record_status() const {
248 return (RecordState) g_atomic_int_get (&_record_status);
251 bool actively_recording () {
252 return record_status() == Recording;
255 bool record_enabling_legal () const;
256 void maybe_enable_record ();
257 void disable_record (bool rt_context, bool force = false);
258 void step_back_from_record ();
260 void maybe_write_autosave ();
262 /* Emitted when all i/o connections are complete */
264 PBD::Signal0<void> IOConnectionsComplete;
266 /* Record status signals */
268 PBD::Signal0<void> RecordStateChanged;
270 /* Transport mechanism signals */
272 PBD::Signal0<void> TransportStateChange; /* generic */
273 PBD::Signal1<void,framepos_t> PositionChanged; /* sent after any non-sequential motion */
274 PBD::Signal1<void,framepos_t> Xrun;
275 PBD::Signal0<void> TransportLooped;
277 /** emitted when a locate has occurred */
278 PBD::Signal0<void> Located;
280 PBD::Signal1<void,RouteList&> RouteAdded;
281 /** Emitted when anything about any of our route groups changes */
282 PBD::Signal0<void> RouteGroupChanged;
284 /* Step Editing status changed */
285 PBD::Signal1<void,bool> StepEditStatusChange;
287 void queue_event (SessionEvent*);
289 void request_roll_at_and_return (nframes_t start, nframes_t return_to);
290 void request_bounded_roll (nframes_t start, nframes_t end);
291 void request_stop (bool abort = false, bool clear_state = false);
292 void request_locate (nframes_t frame, bool with_roll = false);
294 void request_play_loop (bool yn, bool leave_rolling = false);
295 bool get_play_loop () const { return play_loop; }
297 nframes_t last_transport_start() const { return _last_roll_location; }
300 void use_rf_shuttle_speed ();
301 void allow_auto_play (bool yn);
302 void request_transport_speed (double speed);
303 void request_overwrite_buffer (Track *);
304 void adjust_playback_buffering();
305 void adjust_capture_buffering();
306 void request_track_speed (Track *, double speed);
307 void request_input_change_handling ();
309 bool locate_pending() const { return static_cast<bool>(post_transport_work()&PostTransportLocate); }
310 bool transport_locked () const;
314 std::pair<framepos_t, framepos_t> get_extent () const;
315 framepos_t current_end_frame () const;
316 framepos_t current_start_frame () const;
317 /// "actual" sample rate of session, set by current audioengine rate, pullup/down etc.
318 nframes_t frame_rate() const { return _current_frame_rate; }
319 /// "native" sample rate of session, regardless of current audioengine rate, pullup/down etc
320 nframes_t nominal_frame_rate() const { return _nominal_frame_rate; }
321 nframes_t frames_per_hour() const { return _frames_per_hour; }
323 double frames_per_timecode_frame() const { return _frames_per_timecode_frame; }
324 nframes_t timecode_frames_per_hour() const { return _timecode_frames_per_hour; }
326 MIDI::byte get_mtc_timecode_bits() const {
327 return mtc_timecode_bits; /* encoding of SMTPE type for MTC */
330 float timecode_frames_per_second() const;
331 bool timecode_drop_frames() const;
335 Locations *locations() { return _locations; }
337 PBD::Signal1<void,Location*> auto_loop_location_changed;
338 PBD::Signal1<void,Location*> auto_punch_location_changed;
339 PBD::Signal0<void> locations_modified;
341 void set_auto_punch_location (Location *);
342 void set_auto_loop_location (Location *);
343 int location_name(std::string& result, std::string base = std::string(""));
345 void reset_input_monitor_state ();
347 nframes_t get_block_size() const { return current_block_size; }
348 nframes_t worst_output_latency () const { return _worst_output_latency; }
349 nframes_t worst_input_latency () const { return _worst_input_latency; }
350 nframes_t worst_track_latency () const { return _worst_track_latency; }
352 #ifdef HAVE_JACK_SESSION
353 void jack_session_event (jack_session_event_t* event);
355 int save_state (std::string snapshot_name, bool pending = false, bool switch_to_snapshot = false);
356 int restore_state (std::string snapshot_name);
357 int save_template (std::string template_name);
358 int save_history (std::string snapshot_name = "");
359 int restore_history (std::string snapshot_name);
360 void remove_state (std::string snapshot_name);
361 void rename_state (std::string old_name, std::string new_name);
362 void remove_pending_capture_state ();
364 static int rename_template (std::string old_name, std::string new_name);
365 static int delete_template (std::string name);
367 PBD::Signal1<void,std::string> StateSaved;
368 PBD::Signal0<void> StateReady;
370 std::vector<std::string*>* possible_states() const;
371 static std::vector<std::string*>* possible_states (std::string path);
373 XMLNode& get_state();
374 int set_state(const XMLNode& node, int version); // not idempotent
375 XMLNode& get_template();
377 /// The instant xml file is written to the session directory
378 void add_instant_xml (XMLNode&, bool write_to_config = true);
379 XMLNode* instant_xml (const std::string& str);
381 enum StateOfTheState {
386 InitialConnecting = 0x8,
391 StateOfTheState state_of_the_state() const { return _state_of_the_state; }
393 void add_route_group (RouteGroup *);
394 void remove_route_group (RouteGroup&);
396 RouteGroup* route_group_by_name (std::string);
397 RouteGroup& all_route_group() const;
399 PBD::Signal1<void,RouteGroup*> route_group_added;
400 PBD::Signal0<void> route_group_removed;
402 void foreach_route_group (boost::function<void(RouteGroup*)> f) {
403 for (std::list<RouteGroup *>::iterator i = _route_groups.begin(); i != _route_groups.end(); ++i) {
408 /* fundamental operations. duh. */
410 std::list<boost::shared_ptr<AudioTrack> > new_audio_track (
411 int input_channels, int output_channels, TrackMode mode = Normal, RouteGroup* route_group = 0, uint32_t how_many = 1
414 RouteList new_audio_route (bool aux, int input_channels, int output_channels, RouteGroup* route_group, uint32_t how_many);
416 std::list<boost::shared_ptr<MidiTrack> > new_midi_track (
417 TrackMode mode = Normal, RouteGroup* route_group = 0, uint32_t how_many = 1
420 void remove_route (boost::shared_ptr<Route>);
421 void resort_routes ();
422 void resort_routes_using (boost::shared_ptr<RouteList>);
424 void set_remote_control_ids();
426 AudioEngine & engine() { return _engine; }
427 AudioEngine const & engine () const { return _engine; }
431 framepos_t transport_frame () const {return _transport_frame; }
432 framepos_t audible_frame () const;
433 framepos_t requested_return_frame() const { return _requested_return_frame; }
447 void sync_time_vars();
449 void bbt_time (nframes_t when, BBT_Time&);
450 void timecode_to_sample(Timecode::Time& timecode, framepos_t& sample, bool use_offset, bool use_subframes) const;
451 void sample_to_timecode(framepos_t sample, Timecode::Time& timecode, bool use_offset, bool use_subframes) const;
452 void timecode_time (Timecode::Time &);
453 void timecode_time (nframes_t when, Timecode::Time&);
454 void timecode_time_subframes (nframes_t when, Timecode::Time&);
456 void timecode_duration (framecnt_t, Timecode::Time&) const;
457 void timecode_duration_string (char *, framecnt_t) const;
459 void set_timecode_offset (nframes_t);
460 nframes_t timecode_offset () const { return _timecode_offset; }
461 void set_timecode_offset_negative (bool);
462 bool timecode_offset_negative () const { return _timecode_offset_negative; }
464 nframes_t convert_to_frames_at (nframes_t position, AnyTime const &);
466 static PBD::Signal1<void, framepos_t> StartTimeChanged;
467 static PBD::Signal1<void, framepos_t> EndTimeChanged;
468 static PBD::Signal0<void> TimecodeOffsetChanged;
470 std::vector<SyncSource> get_available_sync_options() const;
471 void request_sync_source (Slave*);
472 bool synced_to_jack() const { return config.get_external_sync() && config.get_sync_source() == JACK; }
474 double transport_speed() const { return _transport_speed; }
475 bool transport_stopped() const { return _transport_speed == 0.0f; }
476 bool transport_rolling() const { return _transport_speed != 0.0f; }
478 void set_silent (bool yn);
479 bool silent () { return _silent; }
481 int jack_slave_sync (nframes_t);
483 TempoMap& tempo_map() { return *_tempo_map; }
485 /// signals the current transport position in frames, bbt and timecode time (in that order)
486 PBD::Signal3<void,const nframes_t&, const BBT_Time&, const Timecode::Time&> tick;
490 boost::shared_ptr<Region> find_whole_file_parent (boost::shared_ptr<Region const>) const;
492 std::string path_from_region_name (DataType type, std::string name, std::string identifier);
494 boost::shared_ptr<Region> XMLRegionFactory (const XMLNode&, bool full);
495 boost::shared_ptr<AudioRegion> XMLAudioRegionFactory (const XMLNode&, bool full);
496 boost::shared_ptr<MidiRegion> XMLMidiRegionFactory (const XMLNode&, bool full);
498 /* source management */
500 void import_audiofiles (ImportStatus&);
501 bool sample_rate_convert (ImportStatus&, std::string infile, std::string& outfile);
502 std::string build_tmp_convert_name (std::string file);
504 boost::shared_ptr<ExportHandler> get_export_handler ();
505 boost::shared_ptr<ExportStatus> get_export_status ();
507 int start_audio_export (nframes_t position, bool realtime);
509 PBD::Signal1<int,nframes_t> ProcessExport;
510 static PBD::Signal2<void,std::string, std::string> Exported;
512 void add_source (boost::shared_ptr<Source>);
513 void remove_source (boost::weak_ptr<Source>);
515 int cleanup_sources (CleanupReport&);
516 int cleanup_trash_sources (CleanupReport&);
518 int destroy_sources (std::list<boost::shared_ptr<Source> >);
520 int remove_last_capture ();
522 /** handlers should return -1 for "stop cleanup",
523 0 for "yes, delete this playlist",
524 1 for "no, don't delete this playlist".
526 static PBD::Signal1<int,boost::shared_ptr<Playlist> > AskAboutPlaylistDeletion;
528 /** handlers should return 0 for "ignore the rate mismatch",
529 !0 for "do not use this session"
531 static PBD::Signal2<int,nframes_t, nframes_t> AskAboutSampleRateMismatch;
533 /** handlers should return !0 for use pending state, 0 for ignore it.
535 static PBD::Signal0<int> AskAboutPendingState;
537 boost::shared_ptr<AudioFileSource> create_audio_source_for_session (size_t, std::string const &, uint32_t,
538 bool destructive, bool as_stub = false);
540 boost::shared_ptr<MidiSource> create_midi_source_for_session (Track*, std::string const &, bool as_stub = false);
542 boost::shared_ptr<Source> source_by_id (const PBD::ID&);
543 boost::shared_ptr<Source> source_by_path_and_channel (const std::string&, uint16_t);
544 uint32_t count_sources_by_origin (const std::string&);
546 void add_playlist (boost::shared_ptr<Playlist>, bool unused = false);
548 /* named selections */
550 boost::shared_ptr<NamedSelection> named_selection_by_name (std::string name);
551 void add_named_selection (boost::shared_ptr<NamedSelection>);
552 void remove_named_selection (boost::shared_ptr<NamedSelection>);
554 template<class T> void foreach_named_selection (T& obj, void (T::*func)(boost::shared_ptr<NamedSelection>));
555 PBD::Signal0<void> NamedSelectionAdded;
556 PBD::Signal0<void> NamedSelectionRemoved;
558 /* Curves and AutomationLists (TODO when they go away) */
559 void add_automation_list(AutomationList*);
563 float get_default_fade_length () const { return default_fade_msecs; }
564 float get_default_fade_steepness () const { return default_fade_steepness; }
565 void set_default_fade (float steepness, float msecs);
569 boost::shared_ptr<Auditioner> the_auditioner() { return auditioner; }
570 void audition_playlist ();
571 void audition_region (boost::shared_ptr<Region>);
572 void cancel_audition ();
573 bool is_auditioning () const;
575 PBD::Signal1<void,bool> AuditionActive;
577 /* flattening stuff */
579 boost::shared_ptr<Region> write_one_track (AudioTrack&, framepos_t start, framepos_t end,
580 bool overwrite, std::vector<boost::shared_ptr<Source> >&, InterThreadInfo& wot,
581 bool enable_processing = true);
582 int freeze_all (InterThreadInfo&);
584 /* session-wide solo/mute/rec-enable */
586 bool soloing() const { return _non_soloed_outs_muted; }
587 bool listening() const { return _listen_cnt > 0; }
588 bool solo_isolated() const { return _solo_isolated_cnt > 0; }
590 static const SessionEvent::RTeventCallback rt_cleanup;
592 void set_solo (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
593 void set_just_one_solo (boost::shared_ptr<Route>, bool, SessionEvent::RTeventCallback after = rt_cleanup);
594 void set_mute (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
595 void set_listen (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
596 void set_record_enabled (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
597 void set_solo_isolated (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
599 PBD::Signal1<void,bool> SoloActive;
600 PBD::Signal0<void> SoloChanged;
601 PBD::Signal0<void> IsolatedChanged;
603 /* control/master out */
605 boost::shared_ptr<Route> monitor_out() const { return _monitor_out; }
606 boost::shared_ptr<Route> master_out() const { return _master_out; }
608 void globally_add_internal_sends (boost::shared_ptr<Route> dest, Placement p);
609 void globally_set_send_gains_from_track (boost::shared_ptr<Route> dest);
610 void globally_set_send_gains_to_zero (boost::shared_ptr<Route> dest);
611 void globally_set_send_gains_to_unity (boost::shared_ptr<Route> dest);
612 void add_internal_sends (boost::shared_ptr<Route> dest, Placement p, boost::shared_ptr<RouteList> senders);
614 static void set_disable_all_loaded_plugins (bool yn) {
615 _disable_all_loaded_plugins = yn;
617 static bool get_disable_all_loaded_plugins() {
618 return _disable_all_loaded_plugins;
621 uint32_t next_send_id();
622 uint32_t next_return_id();
623 uint32_t next_insert_id();
624 void mark_send_id (uint32_t);
625 void mark_return_id (uint32_t);
626 void mark_insert_id (uint32_t);
627 void unmark_send_id (uint32_t);
628 void unmark_return_id (uint32_t);
629 void unmark_insert_id (uint32_t);
631 /* s/w "RAID" management */
633 framecnt_t available_capture_duration();
637 void add_bundle (boost::shared_ptr<Bundle>);
638 void remove_bundle (boost::shared_ptr<Bundle>);
639 boost::shared_ptr<Bundle> bundle_by_name (std::string) const;
641 PBD::Signal1<void,boost::shared_ptr<Bundle> > BundleAdded;
642 PBD::Signal1<void,boost::shared_ptr<Bundle> > BundleRemoved;
648 void start_scrub (nframes_t where);
650 void set_scrub_speed (float);
651 nframes_t scrub_buffer_size() const;
652 PBD::Signal0<void> ScrubReady;
654 /* History (for editors, mixers, UIs etc.) */
656 /** Undo some transactions.
657 * @param n Number of transactions to undo.
659 void undo (uint32_t n) {
663 void redo (uint32_t n) {
667 UndoHistory& history() { return _history; }
669 uint32_t undo_depth() const { return _history.undo_depth(); }
670 uint32_t redo_depth() const { return _history.redo_depth(); }
671 std::string next_undo() const { return _history.next_undo(); }
672 std::string next_redo() const { return _history.next_redo(); }
674 void begin_reversible_command (const std::string& cmd_name);
675 void commit_reversible_command (Command* cmd = 0);
677 UndoTransaction* start_reversible_command (const std::string& cmd_name);
678 void finish_reversible_command (UndoTransaction&);
680 void add_command (Command *const cmd) {
681 assert(!_current_trans.empty ());
682 _current_trans.top()->add_command (cmd);
685 void add_commands (std::vector<Command*> const & cmds);
687 std::map<PBD::ID,PBD::StatefulDestructible*> registry;
689 // these commands are implemented in libs/ardour/session_command.cc
690 Command* memento_command_factory(XMLNode* n);
691 Command* stateful_diff_command_factory (XMLNode *);
692 void register_with_memento_command_factory(PBD::ID, PBD::StatefulDestructible*);
696 boost::shared_ptr<IO> click_io() { return _click_io; }
698 /* disk, buffer loads */
700 uint32_t playback_load ();
701 uint32_t capture_load ();
705 void request_play_range (std::list<AudioRange>*, bool leave_rolling = false);
706 bool get_play_range () const { return _play_range; }
708 /* buffers for gain and pan */
710 gain_t* gain_automation_buffer () const;
711 pan_t** pan_automation_buffer () const;
713 void ensure_buffer_set (BufferSet& buffers, const ChanCount& howmany);
717 static long vst_callback (AEffect* effect,
724 static PBD::Signal0<void> SendFeedback;
728 boost::shared_ptr<PBD::Controllable> controllable_by_id (const PBD::ID&);
729 boost::shared_ptr<PBD::Controllable> controllable_by_descriptor (const PBD::ControllableDescriptor&);
731 void add_controllable (boost::shared_ptr<PBD::Controllable>);
732 void remove_controllable (PBD::Controllable*);
734 SessionMetadata & metadata () { return *_metadata; }
736 SessionConfiguration config;
738 bool exporting () const {
742 /* this is a private enum, but setup_enum_writer() needs it,
743 and i can't find a way to give that function
747 enum PostTransportWork {
748 PostTransportStop = 0x1,
749 PostTransportDisableRecord = 0x2,
750 PostTransportPosition = 0x8,
751 PostTransportDidRecord = 0x20,
752 PostTransportDuration = 0x40,
753 PostTransportLocate = 0x80,
754 PostTransportRoll = 0x200,
755 PostTransportAbort = 0x800,
756 PostTransportOverWrite = 0x1000,
757 PostTransportSpeed = 0x2000,
758 PostTransportAudition = 0x4000,
759 PostTransportScrub = 0x8000,
760 PostTransportReverse = 0x10000,
761 PostTransportInputChange = 0x20000,
762 PostTransportCurveRealloc = 0x40000,
763 PostTransportClearSubstate = 0x80000,
764 PostTransportAdjustPlaybackBuffering = 0x100000,
765 PostTransportAdjustCaptureBuffering = 0x200000
774 SlaveState slave_state() const { return _slave_state; }
776 boost::shared_ptr<SessionPlaylists> playlists;
778 void send_mmc_locate (framepos_t);
779 int send_full_time_code (framepos_t);
781 PBD::Signal0<void> RouteOrderKeyChanged;
783 bool step_editing() const { return (_step_editors > 0); }
785 void request_suspend_timecode_transmission ();
786 void request_resume_timecode_transmission ();
787 bool timecode_transmission_suspended () const;
789 std::string source_search_path(DataType) const;
790 void ensure_search_path_includes (const std::string& path, DataType type);
792 /* handlers can return an integer value:
793 0: config.set_audio_search_path() or config.set_midi_search_path() was used
794 to modify the search path and we should try to find it again.
795 1: quit entire session load
796 2: as 0, but don't ask about other missing files
797 3: don't ask about other missing files, and just mark this one missing
798 -1: just mark this one missing
799 any other value: as -1
801 static PBD::Signal3<int,Session*,std::string,DataType> MissingFile;
803 /** Emitted when the session wants Ardour to quit */
804 static PBD::Signal0<void> Quit;
807 friend class AudioEngine;
808 void set_block_size (nframes_t nframes);
809 void set_frame_rate (nframes_t nframes);
813 void schedule_curve_reallocation ();
814 void update_latency_compensation (bool, bool);
817 int create (const std::string& mix_template, BusProfile*);
821 PendingDeclickIn = 0x1,
822 PendingDeclickOut = 0x2,
823 StopPendingCapture = 0x4,
824 PendingLocate = 0x20,
827 /* stuff used in process() should be close together to
831 typedef void (Session::*process_function_type)(nframes_t);
833 AudioEngine& _engine;
834 mutable gint processing_prohibited;
835 process_function_type process_function;
836 process_function_type last_process_function;
837 bool waiting_for_sync_offset;
838 nframes_t _base_frame_rate;
839 nframes_t _current_frame_rate; //this includes video pullup offset
840 nframes_t _nominal_frame_rate; //ignores audioengine setting, "native" SR
841 int transport_sub_state;
842 mutable gint _record_status;
843 volatile framepos_t _transport_frame;
844 Location* _session_range_location; ///< session range, or 0 if there is nothing in the session yet
848 // varispeed playback
849 volatile double _transport_speed;
850 double _last_transport_speed;
851 double _target_transport_speed;
852 CubicInterpolation interpolation;
854 bool auto_play_legal;
855 framepos_t _last_slave_transport_frame;
856 nframes_t maximum_output_latency;
857 volatile framepos_t _requested_return_frame;
858 nframes_t current_block_size;
859 nframes_t _worst_output_latency;
860 nframes_t _worst_input_latency;
861 nframes_t _worst_track_latency;
864 float _meter_falloff;
865 bool _non_soloed_outs_muted;
866 uint32_t _listen_cnt;
867 uint32_t _solo_isolated_cnt;
871 void set_worst_io_latencies ();
872 void set_worst_io_latencies_x (IOChange, void *) {
873 set_worst_io_latencies ();
876 void update_latency_compensation_proxy (void* ignored);
878 void ensure_buffers (ChanCount howmany = ChanCount::ZERO);
880 void process_scrub (nframes_t);
881 void process_without_events (nframes_t);
882 void process_with_events (nframes_t);
883 void process_audition (nframes_t);
884 void process_export (nframes_t);
885 int process_export_fw (nframes_t);
887 void block_processing() { g_atomic_int_set (&processing_prohibited, 1); }
888 void unblock_processing() { g_atomic_int_set (&processing_prohibited, 0); }
889 bool processing_blocked() const { return g_atomic_int_get (&processing_prohibited); }
891 Glib::Mutex process_thread_lock;
892 std::list<ProcessThread*> process_threads;
896 static const int delta_accumulator_size = 25;
897 int delta_accumulator_cnt;
898 int32_t delta_accumulator[delta_accumulator_size];
899 int32_t average_slave_delta;
901 bool have_first_delta_accumulator;
903 SlaveState _slave_state;
904 nframes_t slave_wait_end;
906 void reset_slave_state ();
907 bool follow_slave (nframes_t);
908 void calculate_moving_average_of_slave_delta(int dir, nframes_t this_delta);
909 void track_slave_state(float slave_speed, nframes_t slave_transport_frame, nframes_t this_delta);
910 void follow_slave_silently(nframes_t nframes, float slave_speed);
912 void switch_to_sync_source (SyncSource); /* !RT context */
913 void drop_sync_source (); /* !RT context */
914 void use_sync_source (Slave*); /* RT context */
916 bool post_export_sync;
917 nframes_t post_export_position;
920 bool _export_rolling;
922 boost::shared_ptr<ExportHandler> export_handler;
923 boost::shared_ptr<ExportStatus> export_status;
926 int stop_audio_export ();
927 void finalize_audio_export ();
929 PBD::ScopedConnection export_freewheel_connection;
931 void get_track_statistics ();
932 int process_routes (nframes_t, bool& need_butler);
933 int silent_process_routes (nframes_t, bool& need_butler);
935 bool get_rec_monitors_input () {
936 if (actively_recording()) {
939 if (config.get_auto_input()) {
947 int get_transport_declick_required () {
948 if (transport_sub_state & PendingDeclickIn) {
949 transport_sub_state &= ~PendingDeclickIn;
951 } else if (transport_sub_state & PendingDeclickOut) {
958 bool maybe_stop (nframes_t limit);
959 bool maybe_sync_start (nframes_t&);
961 void check_declick_out ();
966 bool session_send_mtc;
967 bool session_midi_feedback;
970 nframes_t last_loopend;
972 boost::scoped_ptr<SessionDirectory> _session_dir;
975 void when_engine_running ();
976 void graph_reordered ();
978 std::string _current_snapshot_name;
981 bool state_was_pending;
982 StateOfTheState _state_of_the_state;
985 int load_options (const XMLNode&);
986 int load_state (std::string snapshot_name);
988 nframes_t _last_roll_location;
989 nframes_t _last_roll_or_reversal_location;
990 nframes_t _last_record_location;
992 bool pending_locate_roll;
993 nframes_t pending_locate_frame;
994 bool pending_locate_flush;
996 bool pending_auto_loop;
1000 #if 0 // these should be here, see comments in their other location above
1001 enum PostTransportWork {
1002 PostTransportStop = 0x1,
1003 PostTransportDisableRecord = 0x2,
1004 PostTransportPosition = 0x8,
1005 PostTransportDidRecord = 0x20,
1006 PostTransportDuration = 0x40,
1007 PostTransportLocate = 0x80,
1008 PostTransportRoll = 0x200,
1009 PostTransportAbort = 0x800,
1010 PostTransportOverWrite = 0x1000,
1011 PostTransportSpeed = 0x2000,
1012 PostTransportAudition = 0x4000,
1013 PostTransportScrub = 0x8000,
1014 PostTransportReverse = 0x10000,
1015 PostTransportInputChange = 0x20000,
1016 PostTransportCurveRealloc = 0x40000,
1017 PostTransportClearSubstate = 0x80000
1020 static const PostTransportWork ProcessCannotProceedMask =
1022 PostTransportInputChange|
1024 PostTransportReverse|
1025 PostTransportCurveRealloc|
1027 PostTransportAudition|
1028 PostTransportLocate|
1030 PostTransportClearSubstate);
1032 gint _post_transport_work; /* accessed only atomic ops */
1033 PostTransportWork post_transport_work() const { return (PostTransportWork) g_atomic_int_get (&_post_transport_work); }
1034 void set_post_transport_work (PostTransportWork ptw) { g_atomic_int_set (&_post_transport_work, (gint) ptw); }
1035 void add_post_transport_work (PostTransportWork ptw);
1037 void schedule_playback_buffering_adjustment ();
1038 void schedule_capture_buffering_adjustment ();
1040 uint32_t cumulative_rf_motion;
1043 void set_rf_speed (float speed);
1044 void reset_rf_scale (nframes_t frames_moved);
1046 Locations* _locations;
1047 void locations_changed ();
1048 void locations_added (Location*);
1049 void handle_locations_changed (Locations::LocationList&);
1051 PBD::ScopedConnectionList punch_connections;
1052 void auto_punch_start_changed (Location *);
1053 void auto_punch_end_changed (Location *);
1054 void auto_punch_changed (Location *);
1056 PBD::ScopedConnectionList loop_connections;
1057 void auto_loop_changed (Location *);
1059 void first_stage_init (std::string path, std::string snapshot_name);
1060 int second_stage_init ();
1061 void update_session_range_location_marker ();
1062 void remove_empty_sounds ();
1064 void setup_midi_control ();
1065 int midi_read (MIDI::Port *);
1067 void enable_record ();
1069 void increment_transport_position (framecnt_t val) {
1070 if (max_framepos - val < _transport_frame) {
1071 _transport_frame = max_framepos;
1073 _transport_frame += val;
1077 void decrement_transport_position (framecnt_t val) {
1078 if (val < _transport_frame) {
1079 _transport_frame -= val;
1081 _transport_frame = 0;
1085 void post_transport_motion ();
1086 static void *session_loader_thread (void *arg);
1090 /* SessionEventManager interface */
1092 void process_event (SessionEvent*);
1093 void set_next_event ();
1094 void cleanup_event (SessionEvent*,int);
1096 /* MIDI Machine Control */
1098 void spp_start (MIDI::Parser&, nframes_t timestamp);
1099 void spp_continue (MIDI::Parser&, nframes_t timestamp);
1100 void spp_stop (MIDI::Parser&, nframes_t timestamp);
1102 void mmc_deferred_play (MIDI::MachineControl &);
1103 void mmc_stop (MIDI::MachineControl &);
1104 void mmc_step (MIDI::MachineControl &, int);
1105 void mmc_pause (MIDI::MachineControl &);
1106 void mmc_record_pause (MIDI::MachineControl &);
1107 void mmc_record_strobe (MIDI::MachineControl &);
1108 void mmc_record_exit (MIDI::MachineControl &);
1109 void mmc_track_record_status (MIDI::MachineControl &, uint32_t track, bool enabled);
1110 void mmc_fast_forward (MIDI::MachineControl &);
1111 void mmc_rewind (MIDI::MachineControl &);
1112 void mmc_locate (MIDI::MachineControl &, const MIDI::byte *);
1113 void mmc_shuttle (MIDI::MachineControl &mmc, float speed, bool forw);
1114 void mmc_record_enable (MIDI::MachineControl &mmc, size_t track, bool enabled);
1116 struct timeval last_mmc_step;
1119 typedef boost::function<bool()> MidiTimeoutCallback;
1120 typedef std::list<MidiTimeoutCallback> MidiTimeoutList;
1122 MidiTimeoutList midi_timeouts;
1123 bool mmc_step_timeout ();
1125 MIDI::byte mtc_msg[16];
1126 MIDI::byte mtc_timecode_bits; /* encoding of SMTPE type for MTC */
1127 MIDI::byte midi_msg[16];
1128 nframes_t outbound_mtc_timecode_frame;
1129 Timecode::Time transmitting_timecode_time;
1130 int next_quarter_frame_to_send;
1132 double _frames_per_timecode_frame; /* has to be floating point because of drop frame */
1133 nframes_t _frames_per_hour;
1134 nframes_t _timecode_frames_per_hour;
1135 nframes_t _timecode_offset;
1136 bool _timecode_offset_negative;
1138 /* cache the most-recently requested time conversions. This helps when we
1139 * have multiple clocks showing the same time (e.g. the transport frame) */
1140 bool last_timecode_valid;
1141 nframes_t last_timecode_when;
1142 Timecode::Time last_timecode;
1144 bool _send_timecode_update; ///< Flag to send a full frame (Timecode) MTC message this cycle
1146 int send_midi_time_code_for_cycle(nframes_t nframes);
1148 nframes_t adjust_apparent_position (nframes_t frames);
1150 void reset_record_status ();
1152 int no_roll (nframes_t nframes);
1153 int fail_roll (nframes_t nframes);
1155 bool non_realtime_work_pending() const { return static_cast<bool>(post_transport_work()); }
1156 bool process_can_proceed() const { return !(post_transport_work() & ProcessCannotProceedMask); }
1158 MidiControlUI* midi_control_ui;
1160 int start_midi_thread ();
1161 void terminate_midi_thread ();
1163 void set_play_loop (bool yn);
1164 void unset_play_loop ();
1165 void overwrite_some_buffers (Track *);
1166 void flush_all_inserts ();
1167 int micro_locate (nframes_t distance);
1168 void locate (framepos_t, bool with_roll, bool with_flush, bool with_loop=false, bool force=false, bool with_mmc=true);
1169 void start_locate (framepos_t, bool with_roll, bool with_flush, bool with_loop=false, bool force=false);
1170 void force_locate (framepos_t frame, bool with_roll = false);
1171 void set_track_speed (Track *, double speed);
1172 void set_transport_speed (double speed, bool abort = false, bool clear_state = false);
1173 void stop_transport (bool abort = false, bool clear_state = false);
1174 void start_transport ();
1175 void realtime_stop (bool abort, bool clear_state);
1176 void non_realtime_start_scrub ();
1177 void non_realtime_set_speed ();
1178 void non_realtime_locate ();
1179 void non_realtime_stop (bool abort, int entry_request_count, bool& finished);
1180 void non_realtime_overwrite (int entry_request_count, bool& finished);
1181 void post_transport ();
1182 void engine_halted ();
1183 void xrun_recovery ();
1185 TempoMap *_tempo_map;
1186 void tempo_map_changed (const PBD::PropertyChange&);
1188 /* edit/mix groups */
1190 int load_route_groups (const XMLNode&, int);
1192 std::list<RouteGroup *> _route_groups;
1193 RouteGroup* _all_route_group;
1197 boost::shared_ptr<Graph> route_graph;
1199 SerializedRCUManager<RouteList> routes;
1201 void add_routes (RouteList&, bool save);
1202 uint32_t destructive_index;
1204 boost::shared_ptr<Route> XMLRouteFactory (const XMLNode&, int);
1205 boost::shared_ptr<Route> XMLRouteFactory_2X (const XMLNode&, int);
1207 void route_processors_changed (RouteProcessorChange);
1209 bool find_route_name (const char* base, uint32_t& id, char* name, size_t name_len);
1210 void count_existing_route_channels (ChanCount& in, ChanCount& out);
1211 void auto_connect_route (
1213 ChanCount& existing_inputs,
1214 ChanCount& existing_outputs,
1215 bool connect_inputs = true,
1216 ChanCount input_start = ChanCount (),
1217 ChanCount output_start = ChanCount ()
1222 bool solo_update_disabled;
1224 void route_listen_changed (void *src, boost::weak_ptr<Route>);
1225 void route_mute_changed (void *src);
1226 void route_solo_changed (bool self_solo_change, void *src, boost::weak_ptr<Route>);
1227 void route_solo_isolated_changed (void *src, boost::weak_ptr<Route>);
1228 void update_route_solo_state (boost::shared_ptr<RouteList> r = boost::shared_ptr<RouteList>());
1230 void listen_position_changed ();
1231 void solo_control_mode_changed ();
1233 /* REGION MANAGEMENT */
1235 mutable Glib::Mutex region_lock;
1237 int load_regions (const XMLNode& node);
1239 void route_group_changed ();
1243 mutable Glib::Mutex source_lock;
1246 typedef std::map<PBD::ID,boost::shared_ptr<Source> > SourceMap;
1252 SourceMap get_sources() { return sources; }
1255 int load_sources (const XMLNode& node);
1256 XMLNode& get_sources_as_xml ();
1258 boost::shared_ptr<Source> XMLSourceFactory (const XMLNode&);
1262 void remove_playlist (boost::weak_ptr<Playlist>);
1263 void playlist_length_changed ();
1264 void track_playlist_changed (boost::weak_ptr<Track>);
1266 /* NAMED SELECTIONS */
1268 mutable Glib::Mutex named_selection_lock;
1269 typedef std::set<boost::shared_ptr<NamedSelection> > NamedSelectionList;
1270 NamedSelectionList named_selections;
1272 int load_named_selections (const XMLNode&);
1274 NamedSelection *named_selection_factory (std::string name);
1275 NamedSelection *XMLNamedSelectionFactory (const XMLNode&);
1277 /* CURVES and AUTOMATION LISTS */
1278 std::map<PBD::ID, AutomationList*> automation_lists;
1280 /* DEFAULT FADE CURVES */
1282 float default_fade_steepness;
1283 float default_fade_msecs;
1287 boost::shared_ptr<Auditioner> auditioner;
1288 void set_audition (boost::shared_ptr<Region>);
1289 void non_realtime_set_audition ();
1290 boost::shared_ptr<Region> pending_audition_region;
1296 int flatten_one_track (AudioTrack&, nframes_t start, nframes_t cnt);
1298 /* INSERT AND SEND MANAGEMENT */
1300 boost::dynamic_bitset<uint32_t> send_bitset;
1301 boost::dynamic_bitset<uint32_t> return_bitset;
1302 boost::dynamic_bitset<uint32_t> insert_bitset;
1306 struct space_and_path {
1307 uint32_t blocks; /* 4kB blocks */
1315 struct space_and_path_ascending_cmp {
1316 bool operator() (space_and_path a, space_and_path b) {
1317 return a.blocks > b.blocks;
1321 void setup_raid_path (std::string path);
1323 std::vector<space_and_path> session_dirs;
1324 std::vector<space_and_path>::iterator last_rr_session_dir;
1325 uint32_t _total_free_4k_blocks;
1326 Glib::Mutex space_lock;
1328 bool no_questions_about_missing_files;
1330 std::string get_best_session_directory_for_new_source ();
1332 mutable gint _playback_load;
1333 mutable gint _capture_load;
1337 SerializedRCUManager<BundleList> _bundles;
1338 XMLNode* _bundle_xml_node;
1339 int load_bundles (XMLNode const &);
1341 void reverse_track_buffers ();
1343 UndoHistory _history;
1344 std::stack<UndoTransaction*> _current_trans;
1346 void jack_timebase_callback (jack_transport_state_t, nframes_t, jack_position_t*, int);
1347 int jack_sync_callback (jack_transport_state_t, jack_position_t*);
1348 void reset_jack_connection (jack_client_t* jack);
1349 void process_rtop (SessionEvent*);
1351 XMLNode& state(bool);
1357 boost::shared_ptr<IO> _click_io;
1359 Sample* click_emphasis_data;
1360 nframes_t click_length;
1361 nframes_t click_emphasis_length;
1362 mutable Glib::RWLock click_lock;
1364 static const Sample default_click[];
1365 static const nframes_t default_click_length;
1366 static const Sample default_click_emphasis[];
1367 static const nframes_t default_click_emphasis_length;
1370 void setup_click_sounds (int which);
1371 void clear_clicks ();
1372 void click (nframes_t start, nframes_t nframes);
1374 std::vector<Route*> master_outs;
1376 /* range playback */
1378 std::list<AudioRange> current_audio_range;
1380 void set_play_range (std::list<AudioRange>&, bool leave_rolling);
1381 void unset_play_range ();
1386 boost::shared_ptr<Route> _master_out;
1387 boost::shared_ptr<Route> _monitor_out;
1391 long _vst_callback (VSTPlugin*,
1398 /* number of hardware ports we're using,
1399 based on max (requested,available)
1402 ChanCount n_physical_outputs;
1403 ChanCount n_physical_inputs;
1405 int find_all_sources (std::string path, std::set<std::string>& result);
1406 int find_all_sources_across_snapshots (std::set<std::string>& result, bool exclude_this_snapshot);
1408 typedef std::set<boost::shared_ptr<PBD::Controllable> > Controllables;
1409 Glib::Mutex controllables_lock;
1410 Controllables controllables;
1412 void reset_native_file_format();
1413 bool first_file_data_format_reset;
1414 bool first_file_header_format_reset;
1416 void config_changed (std::string, bool);
1418 XMLNode& get_control_protocol_state ();
1420 void set_history_depth (uint32_t depth);
1421 void sync_order_keys ();
1423 static bool _disable_all_loaded_plugins;
1425 SessionMetadata * _metadata;
1427 mutable bool have_looped; ///< Used in ::audible_frame(*)
1429 void update_have_rec_enabled_track ();
1430 gint _have_rec_enabled_track;
1432 static int ask_about_playlist_deletion (boost::shared_ptr<Playlist>);
1434 /* realtime "apply to set of routes" operations */
1435 SessionEvent* get_rt_event (boost::shared_ptr<RouteList> rl, bool yn, SessionEvent::RTeventCallback after, bool group_override,
1436 void (Session::*method) (boost::shared_ptr<RouteList>, bool, bool));
1438 void rt_set_solo (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1439 void rt_set_just_one_solo (boost::shared_ptr<RouteList>, bool yn, bool /* ignored*/ );
1440 void rt_set_mute (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1441 void rt_set_listen (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1442 void rt_set_solo_isolated (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1443 void rt_set_record_enabled (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1445 /** temporary list of Diskstreams used only during load of 2.X sessions */
1446 std::list<boost::shared_ptr<Diskstream> > _diskstreams_2X;
1448 void add_session_range_location (nframes_t, nframes_t);
1450 void setup_midi_machine_control ();
1451 void cleanup_stubfiles ();
1453 void route_order_key_changed ();
1455 void step_edit_status_change (bool);
1456 uint32_t _step_editors;
1458 /** true if timecode transmission by the transport is suspended, otherwise false */
1459 mutable gint _suspend_timecode_transmission;
1461 void update_locations_after_tempo_map_change (Locations::LocationList &);
1463 void start_time_changed (framepos_t);
1464 void end_time_changed (framepos_t);
1467 } // namespace ARDOUR
1469 #endif /* __ardour_session_h__ */