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"
55 #include "ardour/speakers.h"
57 #ifdef HAVE_JACK_SESSION
58 #include <jack/session.h>
73 class ControllableDescriptor;
83 class AudioFileSource;
103 class NamedSelection;
116 class SessionDirectory;
117 class SessionMetadata;
118 class SessionPlaylists;
127 extern void setup_enum_writer ();
129 class Session : public PBD::StatefulDestructible, public PBD::ScopedConnectionList, public SessionEventManager
138 /* a new session might have non-empty mix_template, an existing session should always have an empty one.
139 the bus profile can be null if no master out bus is required.
142 Session (AudioEngine&,
143 const std::string& fullpath,
144 const std::string& snapshot_name,
145 BusProfile* bus_profile = 0,
146 std::string mix_template = "");
150 std::string path() const { return _path; }
151 std::string name() const { return _name; }
152 std::string snap_name() const { return _current_snapshot_name; }
153 std::string raid_path () const;
154 bool path_is_within_session (const std::string&);
156 void set_snap_name ();
158 bool writable() const { return _writable; }
161 bool dirty() const { return _state_of_the_state & Dirty; }
162 void set_deletion_in_progress ();
163 void clear_deletion_in_progress ();
164 bool deletion_in_progress() const { return _state_of_the_state & Deletion; }
165 PBD::Signal0<void> DirtyChanged;
167 const SessionDirectory& session_directory () const { return *(_session_dir.get()); }
169 static PBD::Signal0<void> AutoBindingOn;
170 static PBD::Signal0<void> AutoBindingOff;
172 static PBD::Signal1<void,std::string> Dialog;
174 std::string sound_dir (bool with_path = true) const;
175 std::string peak_dir () const;
176 std::string dead_sound_dir () const;
177 std::string automation_dir () const;
178 std::string analysis_dir() const;
179 std::string plugins_dir() const;
181 int ensure_subdirs ();
183 std::string peak_path (std::string) const;
185 std::string change_source_path_by_name (std::string oldpath, std::string oldname, std::string newname, bool destructive);
187 std::string peak_path_from_audio_path (std::string) const;
188 std::string new_audio_source_name (const std::string&, uint32_t nchans, uint32_t chan, bool destructive);
189 std::string new_midi_source_name (const std::string&);
190 std::string new_source_path_from_name (DataType type, const std::string&, bool as_stub = false);
191 RouteList new_route_from_template (uint32_t how_many, const std::string& template_path);
193 void process (nframes_t nframes);
195 BufferSet& get_silent_buffers (ChanCount count = ChanCount::ZERO);
196 BufferSet& get_scratch_buffers (ChanCount count = ChanCount::ZERO);
197 BufferSet& get_mix_buffers (ChanCount count = ChanCount::ZERO);
199 bool have_rec_enabled_track () const;
201 bool have_captured() const { return _have_captured; }
203 void refill_all_track_buffers ();
204 Butler* butler() { return _butler; }
205 void butler_transport_work ();
207 void refresh_disk_space ();
209 int load_diskstreams_2X (XMLNode const &, int);
211 int load_routes (const XMLNode&, int);
212 boost::shared_ptr<RouteList> get_routes() const {
213 return routes.reader ();
216 boost::shared_ptr<RouteList> get_routes_with_internal_returns() const;
218 boost::shared_ptr<RouteList> get_routes_with_regions_at (framepos_t const) const;
220 uint32_t nroutes() const { return routes.reader()->size(); }
221 uint32_t ntracks () const;
222 uint32_t nbusses () const;
224 boost::shared_ptr<BundleList> bundles () {
225 return _bundles.reader ();
228 struct RoutePublicOrderSorter {
229 bool operator() (boost::shared_ptr<Route>, boost::shared_ptr<Route> b);
232 void sync_order_keys (std::string const &);
234 template<class T> void foreach_route (T *obj, void (T::*func)(Route&));
235 template<class T> void foreach_route (T *obj, void (T::*func)(boost::shared_ptr<Route>));
236 template<class T, class A> void foreach_route (T *obj, void (T::*func)(Route&, A), A arg);
238 bool io_name_is_legal (const std::string&);
239 boost::shared_ptr<Route> route_by_name (std::string);
240 boost::shared_ptr<Route> route_by_id (PBD::ID);
241 boost::shared_ptr<Route> route_by_remote_id (uint32_t id);
243 bool route_name_unique (std::string) const;
244 bool route_name_internal (std::string) const;
246 bool get_record_enabled() const {
247 return (record_status () >= Enabled);
250 RecordState record_status() const {
251 return (RecordState) g_atomic_int_get (&_record_status);
254 bool actively_recording () {
255 return record_status() == Recording;
258 bool record_enabling_legal () const;
259 void maybe_enable_record ();
260 void disable_record (bool rt_context, bool force = false);
261 void step_back_from_record ();
263 void maybe_write_autosave ();
265 /* Emitted when all i/o connections are complete */
267 PBD::Signal0<void> IOConnectionsComplete;
269 /* Record status signals */
271 PBD::Signal0<void> RecordStateChanged;
273 /* Transport mechanism signals */
275 PBD::Signal0<void> TransportStateChange; /* generic */
276 PBD::Signal1<void,framepos_t> PositionChanged; /* sent after any non-sequential motion */
277 PBD::Signal1<void,framepos_t> Xrun;
278 PBD::Signal0<void> TransportLooped;
280 /** emitted when a locate has occurred */
281 PBD::Signal0<void> Located;
283 PBD::Signal1<void,RouteList&> RouteAdded;
284 /** Emitted when anything about any of our route groups changes */
285 PBD::Signal0<void> RouteGroupChanged;
287 /* Step Editing status changed */
288 PBD::Signal1<void,bool> StepEditStatusChange;
290 void queue_event (SessionEvent*);
292 void request_roll_at_and_return (nframes_t start, nframes_t return_to);
293 void request_bounded_roll (nframes_t start, nframes_t end);
294 void request_stop (bool abort = false, bool clear_state = false);
295 void request_locate (nframes_t frame, bool with_roll = false);
297 void request_play_loop (bool yn, bool leave_rolling = false);
298 bool get_play_loop () const { return play_loop; }
300 nframes_t last_transport_start() const { return _last_roll_location; }
303 void use_rf_shuttle_speed ();
304 void allow_auto_play (bool yn);
305 void request_transport_speed (double speed);
306 void request_overwrite_buffer (Track *);
307 void adjust_playback_buffering();
308 void adjust_capture_buffering();
309 void request_track_speed (Track *, double speed);
310 void request_input_change_handling ();
312 bool locate_pending() const { return static_cast<bool>(post_transport_work()&PostTransportLocate); }
313 bool transport_locked () const;
317 std::pair<framepos_t, framepos_t> get_extent () const;
318 framepos_t current_end_frame () const;
319 framepos_t current_start_frame () const;
320 /// "actual" sample rate of session, set by current audioengine rate, pullup/down etc.
321 nframes_t frame_rate() const { return _current_frame_rate; }
322 /// "native" sample rate of session, regardless of current audioengine rate, pullup/down etc
323 nframes_t nominal_frame_rate() const { return _nominal_frame_rate; }
324 nframes_t frames_per_hour() const { return _frames_per_hour; }
326 double frames_per_timecode_frame() const { return _frames_per_timecode_frame; }
327 nframes_t timecode_frames_per_hour() const { return _timecode_frames_per_hour; }
329 MIDI::byte get_mtc_timecode_bits() const {
330 return mtc_timecode_bits; /* encoding of SMTPE type for MTC */
333 float timecode_frames_per_second() const;
334 bool timecode_drop_frames() const;
338 Locations *locations() { return _locations; }
340 PBD::Signal1<void,Location*> auto_loop_location_changed;
341 PBD::Signal1<void,Location*> auto_punch_location_changed;
342 PBD::Signal0<void> locations_modified;
344 void set_auto_punch_location (Location *);
345 void set_auto_loop_location (Location *);
346 int location_name(std::string& result, std::string base = std::string(""));
348 void reset_input_monitor_state ();
350 nframes_t get_block_size() const { return current_block_size; }
351 nframes_t worst_output_latency () const { return _worst_output_latency; }
352 nframes_t worst_input_latency () const { return _worst_input_latency; }
353 nframes_t worst_track_latency () const { return _worst_track_latency; }
355 #ifdef HAVE_JACK_SESSION
356 void jack_session_event (jack_session_event_t* event);
358 int save_state (std::string snapshot_name, bool pending = false, bool switch_to_snapshot = false);
359 int restore_state (std::string snapshot_name);
360 int save_template (std::string template_name);
361 int save_history (std::string snapshot_name = "");
362 int restore_history (std::string snapshot_name);
363 void remove_state (std::string snapshot_name);
364 void rename_state (std::string old_name, std::string new_name);
365 void remove_pending_capture_state ();
367 static int rename_template (std::string old_name, std::string new_name);
368 static int delete_template (std::string name);
370 PBD::Signal1<void,std::string> StateSaved;
371 PBD::Signal0<void> StateReady;
373 std::vector<std::string*>* possible_states() const;
374 static std::vector<std::string*>* possible_states (std::string path);
376 XMLNode& get_state();
377 int set_state(const XMLNode& node, int version); // not idempotent
378 XMLNode& get_template();
380 /// The instant xml file is written to the session directory
381 void add_instant_xml (XMLNode&, bool write_to_config = true);
382 XMLNode* instant_xml (const std::string& str);
384 enum StateOfTheState {
389 InitialConnecting = 0x8,
394 StateOfTheState state_of_the_state() const { return _state_of_the_state; }
396 void add_route_group (RouteGroup *);
397 void remove_route_group (RouteGroup&);
399 RouteGroup* route_group_by_name (std::string);
400 RouteGroup& all_route_group() const;
402 PBD::Signal1<void,RouteGroup*> route_group_added;
403 PBD::Signal0<void> route_group_removed;
405 void foreach_route_group (boost::function<void(RouteGroup*)> f) {
406 for (std::list<RouteGroup *>::iterator i = _route_groups.begin(); i != _route_groups.end(); ++i) {
411 /* fundamental operations. duh. */
413 std::list<boost::shared_ptr<AudioTrack> > new_audio_track (
414 int input_channels, int output_channels, TrackMode mode = Normal, RouteGroup* route_group = 0, uint32_t how_many = 1
417 RouteList new_audio_route (bool aux, int input_channels, int output_channels, RouteGroup* route_group, uint32_t how_many);
419 std::list<boost::shared_ptr<MidiTrack> > new_midi_track (
420 TrackMode mode = Normal, RouteGroup* route_group = 0, uint32_t how_many = 1
423 void remove_route (boost::shared_ptr<Route>);
424 void resort_routes ();
425 void resort_routes_using (boost::shared_ptr<RouteList>);
427 void set_remote_control_ids();
429 AudioEngine & engine() { return _engine; }
430 AudioEngine const & engine () const { return _engine; }
434 framepos_t transport_frame () const {return _transport_frame; }
435 framepos_t audible_frame () const;
436 framepos_t requested_return_frame() const { return _requested_return_frame; }
450 void sync_time_vars();
452 void bbt_time (nframes_t when, BBT_Time&);
453 void timecode_to_sample(Timecode::Time& timecode, framepos_t& sample, bool use_offset, bool use_subframes) const;
454 void sample_to_timecode(framepos_t sample, Timecode::Time& timecode, bool use_offset, bool use_subframes) const;
455 void timecode_time (Timecode::Time &);
456 void timecode_time (nframes_t when, Timecode::Time&);
457 void timecode_time_subframes (nframes_t when, Timecode::Time&);
459 void timecode_duration (framecnt_t, Timecode::Time&) const;
460 void timecode_duration_string (char *, framecnt_t) const;
462 nframes_t convert_to_frames_at (nframes_t position, AnyTime const &);
464 static PBD::Signal1<void, framepos_t> StartTimeChanged;
465 static PBD::Signal1<void, framepos_t> EndTimeChanged;
467 std::vector<SyncSource> get_available_sync_options() const;
468 void request_sync_source (Slave*);
469 bool synced_to_jack() const { return config.get_external_sync() && config.get_sync_source() == JACK; }
471 double transport_speed() const { return _transport_speed; }
472 bool transport_stopped() const { return _transport_speed == 0.0f; }
473 bool transport_rolling() const { return _transport_speed != 0.0f; }
475 void set_silent (bool yn);
476 bool silent () { return _silent; }
478 int jack_slave_sync (nframes_t);
480 TempoMap& tempo_map() { return *_tempo_map; }
482 /// signals the current transport position in frames, bbt and timecode time (in that order)
483 PBD::Signal3<void,const nframes_t&, const BBT_Time&, const Timecode::Time&> tick;
487 boost::shared_ptr<Region> find_whole_file_parent (boost::shared_ptr<Region const>) const;
489 std::string path_from_region_name (DataType type, std::string name, std::string identifier);
491 boost::shared_ptr<Region> XMLRegionFactory (const XMLNode&, bool full);
492 boost::shared_ptr<AudioRegion> XMLAudioRegionFactory (const XMLNode&, bool full);
493 boost::shared_ptr<MidiRegion> XMLMidiRegionFactory (const XMLNode&, bool full);
495 /* source management */
497 void import_audiofiles (ImportStatus&);
498 bool sample_rate_convert (ImportStatus&, std::string infile, std::string& outfile);
499 std::string build_tmp_convert_name (std::string file);
501 boost::shared_ptr<ExportHandler> get_export_handler ();
502 boost::shared_ptr<ExportStatus> get_export_status ();
504 int start_audio_export (nframes_t position, bool realtime);
506 PBD::Signal1<int,nframes_t> ProcessExport;
507 static PBD::Signal2<void,std::string, std::string> Exported;
509 void add_source (boost::shared_ptr<Source>);
510 void remove_source (boost::weak_ptr<Source>);
512 int cleanup_sources (CleanupReport&);
513 int cleanup_trash_sources (CleanupReport&);
515 int destroy_sources (std::list<boost::shared_ptr<Source> >);
517 int remove_last_capture ();
519 /** handlers should return -1 for "stop cleanup",
520 0 for "yes, delete this playlist",
521 1 for "no, don't delete this playlist".
523 static PBD::Signal1<int,boost::shared_ptr<Playlist> > AskAboutPlaylistDeletion;
525 /** handlers should return 0 for "ignore the rate mismatch",
526 !0 for "do not use this session"
528 static PBD::Signal2<int,nframes_t, nframes_t> AskAboutSampleRateMismatch;
530 /** handlers should return !0 for use pending state, 0 for ignore it.
532 static PBD::Signal0<int> AskAboutPendingState;
534 boost::shared_ptr<AudioFileSource> create_audio_source_for_session (
535 size_t, std::string const &, uint32_t, bool destructive, bool as_stub = false);
537 boost::shared_ptr<MidiSource> create_midi_source_for_session (
538 Track*, std::string const &, bool as_stub = false);
540 boost::shared_ptr<Source> source_by_id (const PBD::ID&);
541 boost::shared_ptr<Source> source_by_path_and_channel (const std::string&, uint16_t);
542 uint32_t count_sources_by_origin (const std::string&);
544 void add_playlist (boost::shared_ptr<Playlist>, bool unused = false);
546 /* named selections */
548 boost::shared_ptr<NamedSelection> named_selection_by_name (std::string name);
549 void add_named_selection (boost::shared_ptr<NamedSelection>);
550 void remove_named_selection (boost::shared_ptr<NamedSelection>);
552 template<class T> void foreach_named_selection (T& obj, void (T::*func)(boost::shared_ptr<NamedSelection>));
553 PBD::Signal0<void> NamedSelectionAdded;
554 PBD::Signal0<void> NamedSelectionRemoved;
556 /* Curves and AutomationLists (TODO when they go away) */
557 void add_automation_list(AutomationList*);
561 float get_default_fade_length () const { return default_fade_msecs; }
562 float get_default_fade_steepness () const { return default_fade_steepness; }
563 void set_default_fade (float steepness, float msecs);
567 boost::shared_ptr<Auditioner> the_auditioner() { return auditioner; }
568 void audition_playlist ();
569 void audition_region (boost::shared_ptr<Region>);
570 void cancel_audition ();
571 bool is_auditioning () const;
573 PBD::Signal1<void,bool> AuditionActive;
575 /* flattening stuff */
577 boost::shared_ptr<Region> write_one_track (AudioTrack&, framepos_t start, framepos_t end,
578 bool overwrite, std::vector<boost::shared_ptr<Source> >&, InterThreadInfo& wot,
579 bool enable_processing = true);
580 int freeze_all (InterThreadInfo&);
582 /* session-wide solo/mute/rec-enable */
584 bool soloing() const { return _non_soloed_outs_muted; }
585 bool listening() const { return _listen_cnt > 0; }
586 bool solo_isolated() const { return _solo_isolated_cnt > 0; }
588 static const SessionEvent::RTeventCallback rt_cleanup;
590 void set_solo (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
591 void set_just_one_solo (boost::shared_ptr<Route>, bool, SessionEvent::RTeventCallback after = rt_cleanup);
592 void set_mute (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
593 void set_listen (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
594 void set_record_enabled (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
595 void set_solo_isolated (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
597 PBD::Signal1<void,bool> SoloActive;
598 PBD::Signal0<void> SoloChanged;
599 PBD::Signal0<void> IsolatedChanged;
601 /* control/master out */
603 boost::shared_ptr<Route> monitor_out() const { return _monitor_out; }
604 boost::shared_ptr<Route> master_out() const { return _master_out; }
606 void globally_add_internal_sends (boost::shared_ptr<Route> dest, Placement p);
607 void globally_set_send_gains_from_track (boost::shared_ptr<Route> dest);
608 void globally_set_send_gains_to_zero (boost::shared_ptr<Route> dest);
609 void globally_set_send_gains_to_unity (boost::shared_ptr<Route> dest);
610 void add_internal_sends (boost::shared_ptr<Route> dest, Placement p, boost::shared_ptr<RouteList> senders);
612 static void set_disable_all_loaded_plugins (bool yn) {
613 _disable_all_loaded_plugins = yn;
615 static bool get_disable_all_loaded_plugins() {
616 return _disable_all_loaded_plugins;
619 uint32_t next_send_id();
620 uint32_t next_return_id();
621 uint32_t next_insert_id();
622 void mark_send_id (uint32_t);
623 void mark_return_id (uint32_t);
624 void mark_insert_id (uint32_t);
625 void unmark_send_id (uint32_t);
626 void unmark_return_id (uint32_t);
627 void unmark_insert_id (uint32_t);
629 /* s/w "RAID" management */
631 framecnt_t available_capture_duration();
635 void add_bundle (boost::shared_ptr<Bundle>);
636 void remove_bundle (boost::shared_ptr<Bundle>);
637 boost::shared_ptr<Bundle> bundle_by_name (std::string) const;
639 PBD::Signal1<void,boost::shared_ptr<Bundle> > BundleAdded;
640 PBD::Signal1<void,boost::shared_ptr<Bundle> > BundleRemoved;
646 void start_scrub (nframes_t where);
648 void set_scrub_speed (float);
649 nframes_t scrub_buffer_size() const;
650 PBD::Signal0<void> ScrubReady;
652 /* History (for editors, mixers, UIs etc.) */
654 /** Undo some transactions.
655 * @param n Number of transactions to undo.
657 void undo (uint32_t n) {
661 void redo (uint32_t n) {
665 UndoHistory& history() { return _history; }
667 uint32_t undo_depth() const { return _history.undo_depth(); }
668 uint32_t redo_depth() const { return _history.redo_depth(); }
669 std::string next_undo() const { return _history.next_undo(); }
670 std::string next_redo() const { return _history.next_redo(); }
672 void begin_reversible_command (const std::string& cmd_name);
673 void commit_reversible_command (Command* cmd = 0);
675 UndoTransaction* start_reversible_command (const std::string& cmd_name);
676 void finish_reversible_command (UndoTransaction&);
678 void add_command (Command *const cmd) {
679 assert(!_current_trans.empty ());
680 _current_trans.top()->add_command (cmd);
683 void add_commands (std::vector<Command*> const & cmds);
685 std::map<PBD::ID,PBD::StatefulDestructible*> registry;
687 // these commands are implemented in libs/ardour/session_command.cc
688 Command* memento_command_factory(XMLNode* n);
689 Command* stateful_diff_command_factory (XMLNode *);
690 void register_with_memento_command_factory(PBD::ID, PBD::StatefulDestructible*);
694 boost::shared_ptr<IO> click_io() { return _click_io; }
696 /* disk, buffer loads */
698 uint32_t playback_load ();
699 uint32_t capture_load ();
703 void request_play_range (std::list<AudioRange>*, bool leave_rolling = false);
704 bool get_play_range () const { return _play_range; }
706 /* buffers for gain and pan */
708 gain_t* gain_automation_buffer () const;
709 pan_t** pan_automation_buffer () const;
711 void ensure_buffer_set (BufferSet& buffers, const ChanCount& howmany);
715 static long vst_callback (AEffect* effect,
722 static PBD::Signal0<void> SendFeedback;
726 Speakers& get_speakers ();
730 boost::shared_ptr<PBD::Controllable> controllable_by_id (const PBD::ID&);
731 boost::shared_ptr<PBD::Controllable> controllable_by_descriptor (const PBD::ControllableDescriptor&);
733 void add_controllable (boost::shared_ptr<PBD::Controllable>);
734 void remove_controllable (PBD::Controllable*);
736 SessionMetadata & metadata () { return *_metadata; }
738 SessionConfiguration config;
740 bool exporting () const {
744 /* this is a private enum, but setup_enum_writer() needs it,
745 and i can't find a way to give that function
749 enum PostTransportWork {
750 PostTransportStop = 0x1,
751 PostTransportDisableRecord = 0x2,
752 PostTransportPosition = 0x8,
753 PostTransportDidRecord = 0x20,
754 PostTransportDuration = 0x40,
755 PostTransportLocate = 0x80,
756 PostTransportRoll = 0x200,
757 PostTransportAbort = 0x800,
758 PostTransportOverWrite = 0x1000,
759 PostTransportSpeed = 0x2000,
760 PostTransportAudition = 0x4000,
761 PostTransportScrub = 0x8000,
762 PostTransportReverse = 0x10000,
763 PostTransportInputChange = 0x20000,
764 PostTransportCurveRealloc = 0x40000,
765 PostTransportClearSubstate = 0x80000,
766 PostTransportAdjustPlaybackBuffering = 0x100000,
767 PostTransportAdjustCaptureBuffering = 0x200000
776 SlaveState slave_state() const { return _slave_state; }
778 boost::shared_ptr<SessionPlaylists> playlists;
780 void send_mmc_locate (framepos_t);
781 int send_full_time_code (framepos_t);
783 PBD::Signal0<void> RouteOrderKeyChanged;
785 bool step_editing() const { return (_step_editors > 0); }
787 void request_suspend_timecode_transmission ();
788 void request_resume_timecode_transmission ();
789 bool timecode_transmission_suspended () const;
791 std::string source_search_path(DataType) const;
792 void ensure_search_path_includes (const std::string& path, DataType type);
794 std::list<std::string> unknown_processors () const;
796 /* handlers can return an integer value:
797 0: config.set_audio_search_path() or config.set_midi_search_path() was used
798 to modify the search path and we should try to find it again.
799 1: quit entire session load
800 2: as 0, but don't ask about other missing files
801 3: don't ask about other missing files, and just mark this one missing
802 -1: just mark this one missing
803 any other value: as -1
805 static PBD::Signal3<int,Session*,std::string,DataType> MissingFile;
807 /** Emitted when the session wants Ardour to quit */
808 static PBD::Signal0<void> Quit;
811 friend class AudioEngine;
812 void set_block_size (nframes_t nframes);
813 void set_frame_rate (nframes_t nframes);
817 void schedule_curve_reallocation ();
818 void update_latency_compensation (bool, bool);
821 int create (const std::string& mix_template, BusProfile*);
825 PendingDeclickIn = 0x1,
826 PendingDeclickOut = 0x2,
827 StopPendingCapture = 0x4,
828 PendingLocate = 0x20,
831 /* stuff used in process() should be close together to
835 typedef void (Session::*process_function_type)(nframes_t);
837 AudioEngine& _engine;
838 mutable gint processing_prohibited;
839 process_function_type process_function;
840 process_function_type last_process_function;
841 bool waiting_for_sync_offset;
842 nframes_t _base_frame_rate;
843 nframes_t _current_frame_rate; //this includes video pullup offset
844 nframes_t _nominal_frame_rate; //ignores audioengine setting, "native" SR
845 int transport_sub_state;
846 mutable gint _record_status;
847 volatile framepos_t _transport_frame;
848 Location* _session_range_location; ///< session range, or 0 if there is nothing in the session yet
852 // varispeed playback
853 volatile double _transport_speed;
854 double _last_transport_speed;
855 double _target_transport_speed;
856 CubicInterpolation interpolation;
858 bool auto_play_legal;
859 framepos_t _last_slave_transport_frame;
860 nframes_t maximum_output_latency;
861 volatile framepos_t _requested_return_frame;
862 nframes_t current_block_size;
863 nframes_t _worst_output_latency;
864 nframes_t _worst_input_latency;
865 nframes_t _worst_track_latency;
868 float _meter_falloff;
869 bool _non_soloed_outs_muted;
870 uint32_t _listen_cnt;
871 uint32_t _solo_isolated_cnt;
875 void set_worst_io_latencies ();
876 void set_worst_io_latencies_x (IOChange, void *) {
877 set_worst_io_latencies ();
880 void update_latency_compensation_proxy (void* ignored);
882 void ensure_buffers (ChanCount howmany = ChanCount::ZERO);
884 void process_scrub (nframes_t);
885 void process_without_events (nframes_t);
886 void process_with_events (nframes_t);
887 void process_audition (nframes_t);
888 void process_export (nframes_t);
889 int process_export_fw (nframes_t);
891 void block_processing() { g_atomic_int_set (&processing_prohibited, 1); }
892 void unblock_processing() { g_atomic_int_set (&processing_prohibited, 0); }
893 bool processing_blocked() const { return g_atomic_int_get (&processing_prohibited); }
895 Glib::Mutex process_thread_lock;
896 std::list<ProcessThread*> process_threads;
900 static const int delta_accumulator_size = 25;
901 int delta_accumulator_cnt;
902 int32_t delta_accumulator[delta_accumulator_size];
903 int32_t average_slave_delta;
905 bool have_first_delta_accumulator;
907 SlaveState _slave_state;
908 nframes_t slave_wait_end;
910 void reset_slave_state ();
911 bool follow_slave (nframes_t);
912 void calculate_moving_average_of_slave_delta(int dir, nframes_t this_delta);
913 void track_slave_state(float slave_speed, nframes_t slave_transport_frame, nframes_t this_delta);
914 void follow_slave_silently(nframes_t nframes, float slave_speed);
916 void switch_to_sync_source (SyncSource); /* !RT context */
917 void drop_sync_source (); /* !RT context */
918 void use_sync_source (Slave*); /* RT context */
920 bool post_export_sync;
921 nframes_t post_export_position;
924 bool _export_rolling;
926 boost::shared_ptr<ExportHandler> export_handler;
927 boost::shared_ptr<ExportStatus> export_status;
930 int stop_audio_export ();
931 void finalize_audio_export ();
933 PBD::ScopedConnection export_freewheel_connection;
935 void get_track_statistics ();
936 int process_routes (nframes_t, bool& need_butler);
937 int silent_process_routes (nframes_t, bool& need_butler);
939 bool get_rec_monitors_input () {
940 if (actively_recording()) {
943 if (config.get_auto_input()) {
951 int get_transport_declick_required () {
952 if (transport_sub_state & PendingDeclickIn) {
953 transport_sub_state &= ~PendingDeclickIn;
955 } else if (transport_sub_state & PendingDeclickOut) {
962 bool maybe_stop (nframes_t limit);
963 bool maybe_sync_start (nframes_t&);
965 void check_declick_out ();
970 bool session_send_mtc;
971 bool session_midi_feedback;
974 nframes_t last_loopend;
976 boost::scoped_ptr<SessionDirectory> _session_dir;
979 void when_engine_running ();
980 void graph_reordered ();
982 std::string _current_snapshot_name;
985 bool state_was_pending;
986 StateOfTheState _state_of_the_state;
989 int load_options (const XMLNode&);
990 int load_state (std::string snapshot_name);
992 nframes_t _last_roll_location;
993 nframes_t _last_roll_or_reversal_location;
994 nframes_t _last_record_location;
996 bool pending_locate_roll;
997 nframes_t pending_locate_frame;
998 bool pending_locate_flush;
1000 bool pending_auto_loop;
1004 #if 0 // these should be here, see comments in their other location above
1005 enum PostTransportWork {
1006 PostTransportStop = 0x1,
1007 PostTransportDisableRecord = 0x2,
1008 PostTransportPosition = 0x8,
1009 PostTransportDidRecord = 0x20,
1010 PostTransportDuration = 0x40,
1011 PostTransportLocate = 0x80,
1012 PostTransportRoll = 0x200,
1013 PostTransportAbort = 0x800,
1014 PostTransportOverWrite = 0x1000,
1015 PostTransportSpeed = 0x2000,
1016 PostTransportAudition = 0x4000,
1017 PostTransportScrub = 0x8000,
1018 PostTransportReverse = 0x10000,
1019 PostTransportInputChange = 0x20000,
1020 PostTransportCurveRealloc = 0x40000,
1021 PostTransportClearSubstate = 0x80000
1024 static const PostTransportWork ProcessCannotProceedMask =
1026 PostTransportInputChange|
1028 PostTransportReverse|
1029 PostTransportCurveRealloc|
1031 PostTransportAudition|
1032 PostTransportLocate|
1034 PostTransportClearSubstate);
1036 gint _post_transport_work; /* accessed only atomic ops */
1037 PostTransportWork post_transport_work() const { return (PostTransportWork) g_atomic_int_get (&_post_transport_work); }
1038 void set_post_transport_work (PostTransportWork ptw) { g_atomic_int_set (&_post_transport_work, (gint) ptw); }
1039 void add_post_transport_work (PostTransportWork ptw);
1041 void schedule_playback_buffering_adjustment ();
1042 void schedule_capture_buffering_adjustment ();
1044 uint32_t cumulative_rf_motion;
1047 void set_rf_speed (float speed);
1048 void reset_rf_scale (nframes_t frames_moved);
1050 Locations* _locations;
1051 void locations_changed ();
1052 void locations_added (Location*);
1053 void handle_locations_changed (Locations::LocationList&);
1055 PBD::ScopedConnectionList punch_connections;
1056 void auto_punch_start_changed (Location *);
1057 void auto_punch_end_changed (Location *);
1058 void auto_punch_changed (Location *);
1060 PBD::ScopedConnectionList loop_connections;
1061 void auto_loop_changed (Location *);
1063 void first_stage_init (std::string path, std::string snapshot_name);
1064 int second_stage_init ();
1065 void update_session_range_location_marker ();
1066 void remove_empty_sounds ();
1068 void setup_midi_control ();
1069 int midi_read (MIDI::Port *);
1071 void enable_record ();
1073 void increment_transport_position (framecnt_t val) {
1074 if (max_framepos - val < _transport_frame) {
1075 _transport_frame = max_framepos;
1077 _transport_frame += val;
1081 void decrement_transport_position (framecnt_t val) {
1082 if (val < _transport_frame) {
1083 _transport_frame -= val;
1085 _transport_frame = 0;
1089 void post_transport_motion ();
1090 static void *session_loader_thread (void *arg);
1094 /* SessionEventManager interface */
1096 void process_event (SessionEvent*);
1097 void set_next_event ();
1098 void cleanup_event (SessionEvent*,int);
1100 /* MIDI Machine Control */
1102 void spp_start (MIDI::Parser&, nframes_t timestamp);
1103 void spp_continue (MIDI::Parser&, nframes_t timestamp);
1104 void spp_stop (MIDI::Parser&, nframes_t timestamp);
1106 void mmc_deferred_play (MIDI::MachineControl &);
1107 void mmc_stop (MIDI::MachineControl &);
1108 void mmc_step (MIDI::MachineControl &, int);
1109 void mmc_pause (MIDI::MachineControl &);
1110 void mmc_record_pause (MIDI::MachineControl &);
1111 void mmc_record_strobe (MIDI::MachineControl &);
1112 void mmc_record_exit (MIDI::MachineControl &);
1113 void mmc_track_record_status (MIDI::MachineControl &, uint32_t track, bool enabled);
1114 void mmc_fast_forward (MIDI::MachineControl &);
1115 void mmc_rewind (MIDI::MachineControl &);
1116 void mmc_locate (MIDI::MachineControl &, const MIDI::byte *);
1117 void mmc_shuttle (MIDI::MachineControl &mmc, float speed, bool forw);
1118 void mmc_record_enable (MIDI::MachineControl &mmc, size_t track, bool enabled);
1120 struct timeval last_mmc_step;
1123 typedef boost::function<bool()> MidiTimeoutCallback;
1124 typedef std::list<MidiTimeoutCallback> MidiTimeoutList;
1126 MidiTimeoutList midi_timeouts;
1127 bool mmc_step_timeout ();
1129 MIDI::byte mtc_msg[16];
1130 MIDI::byte mtc_timecode_bits; /* encoding of SMTPE type for MTC */
1131 MIDI::byte midi_msg[16];
1132 nframes_t outbound_mtc_timecode_frame;
1133 Timecode::Time transmitting_timecode_time;
1134 int next_quarter_frame_to_send;
1136 double _frames_per_timecode_frame; /* has to be floating point because of drop frame */
1137 nframes_t _frames_per_hour;
1138 nframes_t _timecode_frames_per_hour;
1140 /* cache the most-recently requested time conversions. This helps when we
1141 * have multiple clocks showing the same time (e.g. the transport frame) */
1142 bool last_timecode_valid;
1143 nframes_t last_timecode_when;
1144 Timecode::Time last_timecode;
1146 bool _send_timecode_update; ///< Flag to send a full frame (Timecode) MTC message this cycle
1148 int send_midi_time_code_for_cycle(nframes_t nframes);
1150 nframes_t adjust_apparent_position (nframes_t frames);
1152 void reset_record_status ();
1154 int no_roll (nframes_t nframes);
1155 int fail_roll (nframes_t nframes);
1157 bool non_realtime_work_pending() const { return static_cast<bool>(post_transport_work()); }
1158 bool process_can_proceed() const { return !(post_transport_work() & ProcessCannotProceedMask); }
1160 MidiControlUI* midi_control_ui;
1162 int start_midi_thread ();
1163 void terminate_midi_thread ();
1165 void set_play_loop (bool yn);
1166 void unset_play_loop ();
1167 void overwrite_some_buffers (Track *);
1168 void flush_all_inserts ();
1169 int micro_locate (nframes_t distance);
1170 void locate (framepos_t, bool with_roll, bool with_flush, bool with_loop=false, bool force=false, bool with_mmc=true);
1171 void start_locate (framepos_t, bool with_roll, bool with_flush, bool with_loop=false, bool force=false);
1172 void force_locate (framepos_t frame, bool with_roll = false);
1173 void set_track_speed (Track *, double speed);
1174 void set_transport_speed (double speed, bool abort = false, bool clear_state = false);
1175 void stop_transport (bool abort = false, bool clear_state = false);
1176 void start_transport ();
1177 void realtime_stop (bool abort, bool clear_state);
1178 void non_realtime_start_scrub ();
1179 void non_realtime_set_speed ();
1180 void non_realtime_locate ();
1181 void non_realtime_stop (bool abort, int entry_request_count, bool& finished);
1182 void non_realtime_overwrite (int entry_request_count, bool& finished);
1183 void post_transport ();
1184 void engine_halted ();
1185 void xrun_recovery ();
1187 TempoMap *_tempo_map;
1188 void tempo_map_changed (const PBD::PropertyChange&);
1190 /* edit/mix groups */
1192 int load_route_groups (const XMLNode&, int);
1194 std::list<RouteGroup *> _route_groups;
1195 RouteGroup* _all_route_group;
1199 boost::shared_ptr<Graph> route_graph;
1201 SerializedRCUManager<RouteList> routes;
1203 void add_routes (RouteList&, bool save);
1204 uint32_t destructive_index;
1206 boost::shared_ptr<Route> XMLRouteFactory (const XMLNode&, int);
1207 boost::shared_ptr<Route> XMLRouteFactory_2X (const XMLNode&, int);
1209 void route_processors_changed (RouteProcessorChange);
1211 bool find_route_name (const char* base, uint32_t& id, char* name, size_t name_len);
1212 void count_existing_route_channels (ChanCount& in, ChanCount& out);
1213 void auto_connect_route (
1215 ChanCount& existing_inputs,
1216 ChanCount& existing_outputs,
1217 bool connect_inputs = true,
1218 ChanCount input_start = ChanCount (),
1219 ChanCount output_start = ChanCount ()
1224 bool solo_update_disabled;
1226 void route_listen_changed (void *src, boost::weak_ptr<Route>);
1227 void route_mute_changed (void *src);
1228 void route_solo_changed (bool self_solo_change, void *src, boost::weak_ptr<Route>);
1229 void route_solo_isolated_changed (void *src, boost::weak_ptr<Route>);
1230 void update_route_solo_state (boost::shared_ptr<RouteList> r = boost::shared_ptr<RouteList>());
1232 void listen_position_changed ();
1233 void solo_control_mode_changed ();
1235 /* REGION MANAGEMENT */
1237 mutable Glib::Mutex region_lock;
1239 int load_regions (const XMLNode& node);
1241 void route_group_changed ();
1245 mutable Glib::Mutex source_lock;
1248 typedef std::map<PBD::ID,boost::shared_ptr<Source> > SourceMap;
1254 SourceMap get_sources() { return sources; }
1257 int load_sources (const XMLNode& node);
1258 XMLNode& get_sources_as_xml ();
1260 boost::shared_ptr<Source> XMLSourceFactory (const XMLNode&);
1264 void remove_playlist (boost::weak_ptr<Playlist>);
1265 void track_playlist_changed (boost::weak_ptr<Track>);
1267 /* NAMED SELECTIONS */
1269 mutable Glib::Mutex named_selection_lock;
1270 typedef std::set<boost::shared_ptr<NamedSelection> > NamedSelectionList;
1271 NamedSelectionList named_selections;
1273 int load_named_selections (const XMLNode&);
1275 NamedSelection *named_selection_factory (std::string name);
1276 NamedSelection *XMLNamedSelectionFactory (const XMLNode&);
1278 /* CURVES and AUTOMATION LISTS */
1279 std::map<PBD::ID, AutomationList*> automation_lists;
1281 /* DEFAULT FADE CURVES */
1283 float default_fade_steepness;
1284 float default_fade_msecs;
1288 boost::shared_ptr<Auditioner> auditioner;
1289 void set_audition (boost::shared_ptr<Region>);
1290 void non_realtime_set_audition ();
1291 boost::shared_ptr<Region> pending_audition_region;
1297 int flatten_one_track (AudioTrack&, nframes_t start, nframes_t cnt);
1299 /* INSERT AND SEND MANAGEMENT */
1301 boost::dynamic_bitset<uint32_t> send_bitset;
1302 boost::dynamic_bitset<uint32_t> return_bitset;
1303 boost::dynamic_bitset<uint32_t> insert_bitset;
1307 struct space_and_path {
1308 uint32_t blocks; /* 4kB blocks */
1316 struct space_and_path_ascending_cmp {
1317 bool operator() (space_and_path a, space_and_path b) {
1318 return a.blocks > b.blocks;
1322 void setup_raid_path (std::string path);
1324 std::vector<space_and_path> session_dirs;
1325 std::vector<space_and_path>::iterator last_rr_session_dir;
1326 uint32_t _total_free_4k_blocks;
1327 Glib::Mutex space_lock;
1329 bool no_questions_about_missing_files;
1331 std::string get_best_session_directory_for_new_source ();
1333 mutable gint _playback_load;
1334 mutable gint _capture_load;
1338 SerializedRCUManager<BundleList> _bundles;
1339 XMLNode* _bundle_xml_node;
1340 int load_bundles (XMLNode const &);
1342 void reverse_track_buffers ();
1344 UndoHistory _history;
1345 std::stack<UndoTransaction*> _current_trans;
1347 void jack_timebase_callback (jack_transport_state_t, nframes_t, jack_position_t*, int);
1348 int jack_sync_callback (jack_transport_state_t, jack_position_t*);
1349 void reset_jack_connection (jack_client_t* jack);
1350 void process_rtop (SessionEvent*);
1352 XMLNode& state(bool);
1358 boost::shared_ptr<IO> _click_io;
1360 Sample* click_emphasis_data;
1361 nframes_t click_length;
1362 nframes_t click_emphasis_length;
1363 mutable Glib::RWLock click_lock;
1365 static const Sample default_click[];
1366 static const nframes_t default_click_length;
1367 static const Sample default_click_emphasis[];
1368 static const nframes_t default_click_emphasis_length;
1371 void setup_click_sounds (int which);
1372 void clear_clicks ();
1373 void click (nframes_t start, nframes_t nframes);
1375 std::vector<Route*> master_outs;
1377 /* range playback */
1379 std::list<AudioRange> current_audio_range;
1381 void set_play_range (std::list<AudioRange>&, bool leave_rolling);
1382 void unset_play_range ();
1387 boost::shared_ptr<Route> _master_out;
1388 boost::shared_ptr<Route> _monitor_out;
1392 long _vst_callback (VSTPlugin*,
1399 /* number of hardware ports we're using,
1400 based on max (requested,available)
1403 ChanCount n_physical_outputs;
1404 ChanCount n_physical_inputs;
1406 int find_all_sources (std::string path, std::set<std::string>& result);
1407 int find_all_sources_across_snapshots (std::set<std::string>& result, bool exclude_this_snapshot);
1409 typedef std::set<boost::shared_ptr<PBD::Controllable> > Controllables;
1410 Glib::Mutex controllables_lock;
1411 Controllables controllables;
1413 void reset_native_file_format();
1414 bool first_file_data_format_reset;
1415 bool first_file_header_format_reset;
1417 void config_changed (std::string, bool);
1419 XMLNode& get_control_protocol_state ();
1421 void set_history_depth (uint32_t depth);
1422 void sync_order_keys ();
1424 static bool _disable_all_loaded_plugins;
1426 SessionMetadata * _metadata;
1428 mutable bool have_looped; ///< Used in ::audible_frame(*)
1430 void update_have_rec_enabled_track ();
1431 gint _have_rec_enabled_track;
1433 static int ask_about_playlist_deletion (boost::shared_ptr<Playlist>);
1435 /* realtime "apply to set of routes" operations */
1436 SessionEvent* get_rt_event (
1437 boost::shared_ptr<RouteList> rl, bool yn,
1438 SessionEvent::RTeventCallback after, bool group_override,
1439 void (Session::*method) (boost::shared_ptr<RouteList>, bool, bool));
1441 void rt_set_solo (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1442 void rt_set_just_one_solo (boost::shared_ptr<RouteList>, bool yn, bool /* ignored*/ );
1443 void rt_set_mute (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1444 void rt_set_listen (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1445 void rt_set_solo_isolated (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1446 void rt_set_record_enabled (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1448 /** temporary list of Diskstreams used only during load of 2.X sessions */
1449 std::list<boost::shared_ptr<Diskstream> > _diskstreams_2X;
1451 void add_session_range_location (nframes_t, nframes_t);
1453 void setup_midi_machine_control ();
1454 void cleanup_stubfiles ();
1456 void route_order_key_changed ();
1458 void step_edit_status_change (bool);
1459 uint32_t _step_editors;
1461 /** true if timecode transmission by the transport is suspended, otherwise false */
1462 mutable gint _suspend_timecode_transmission;
1464 void update_locations_after_tempo_map_change (Locations::LocationList &);
1466 void start_time_changed (framepos_t);
1467 void end_time_changed (framepos_t);
1469 Speakers* _speakers;
1472 } // namespace ARDOUR
1474 #endif /* __ardour_session_h__ */