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__
30 #include <boost/dynamic_bitset.hpp>
31 #include <boost/scoped_ptr.hpp>
32 #include <boost/weak_ptr.hpp>
33 #include <boost/utility.hpp>
35 #include <glibmm/thread.h>
37 #include "pbd/error.h"
39 #include "pbd/statefuldestructible.h"
40 #include "pbd/signals.h"
43 #include "midi++/types.h"
45 #include "timecode/time.h"
47 #include "ardour/ardour.h"
48 #include "ardour/click.h"
49 #include "ardour/chan_count.h"
50 #include "ardour/rc_configuration.h"
51 #include "ardour/session_configuration.h"
52 #include "ardour/session_event.h"
53 #include "ardour/location.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 (pframes_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 (framepos_t start, framepos_t return_to);
293 void request_bounded_roll (framepos_t start, framepos_t end);
294 void request_stop (bool abort = false, bool clear_state = false);
295 void request_locate (framepos_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 framepos_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_transport_speed_nonzero (double);
307 void request_overwrite_buffer (Track *);
308 void adjust_playback_buffering();
309 void adjust_capture_buffering();
310 void request_track_speed (Track *, double speed);
311 void request_input_change_handling ();
313 bool locate_pending() const { return static_cast<bool>(post_transport_work()&PostTransportLocate); }
314 bool transport_locked () 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 framecnt_t frame_rate () const { return _current_frame_rate; }
322 /** "native" sample rate of session, regardless of current audioengine rate, pullup/down etc */
323 framecnt_t nominal_frame_rate () const { return _nominal_frame_rate; }
324 framecnt_t frames_per_hour () const { return _frames_per_hour; }
326 double frames_per_timecode_frame() const { return _frames_per_timecode_frame; }
327 framecnt_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 pframes_t get_block_size() const { return current_block_size; }
351 framecnt_t worst_output_latency () const { return _worst_output_latency; }
352 framecnt_t worst_input_latency () const { return _worst_input_latency; }
353 framecnt_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 std::list<RouteGroup*> const & route_groups () const {
412 return _route_groups;
415 /* fundamental operations. duh. */
417 std::list<boost::shared_ptr<AudioTrack> > new_audio_track (
418 int input_channels, int output_channels, TrackMode mode = Normal, RouteGroup* route_group = 0, uint32_t how_many = 1
421 RouteList new_audio_route (int input_channels, int output_channels, RouteGroup* route_group, uint32_t how_many);
423 std::list<boost::shared_ptr<MidiTrack> > new_midi_track (
424 TrackMode mode = Normal, RouteGroup* route_group = 0, uint32_t how_many = 1
427 void remove_route (boost::shared_ptr<Route>);
428 void resort_routes ();
429 void resort_routes_using (boost::shared_ptr<RouteList>);
431 void set_remote_control_ids();
433 AudioEngine & engine() { return _engine; }
434 AudioEngine const & engine () const { return _engine; }
438 framepos_t transport_frame () const {return _transport_frame; }
439 framepos_t audible_frame () const;
440 framepos_t requested_return_frame() const { return _requested_return_frame; }
454 void sync_time_vars();
456 void bbt_time (framepos_t when, Timecode::BBT_Time&);
457 void timecode_to_sample(Timecode::Time& timecode, framepos_t& sample, bool use_offset, bool use_subframes) const;
458 void sample_to_timecode(framepos_t sample, Timecode::Time& timecode, bool use_offset, bool use_subframes) const;
459 void timecode_time (Timecode::Time &);
460 void timecode_time (framepos_t when, Timecode::Time&);
461 void timecode_time_subframes (framepos_t when, Timecode::Time&);
463 void timecode_duration (framecnt_t, Timecode::Time&) const;
464 void timecode_duration_string (char *, framecnt_t) const;
466 framecnt_t convert_to_frames (AnyTime const & position);
467 framecnt_t any_duration_to_frames (framepos_t position, AnyTime const & duration);
469 static PBD::Signal1<void, framepos_t> StartTimeChanged;
470 static PBD::Signal1<void, framepos_t> EndTimeChanged;
472 std::vector<SyncSource> get_available_sync_options() const;
473 void request_sync_source (Slave*);
474 bool synced_to_jack() const { return config.get_external_sync() && config.get_sync_source() == JACK; }
476 double transport_speed() const { return _transport_speed; }
477 bool transport_stopped() const { return _transport_speed == 0.0f; }
478 bool transport_rolling() const { return _transport_speed != 0.0f; }
480 void set_silent (bool yn);
481 bool silent () { return _silent; }
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 framepos_t &, const Timecode::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 (framepos_t position, bool realtime);
509 PBD::Signal1<int, framecnt_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 void cleanup_regions();
516 int cleanup_sources (CleanupReport&);
517 int cleanup_trash_sources (CleanupReport&);
519 int destroy_sources (std::list<boost::shared_ptr<Source> >);
521 int remove_last_capture ();
523 /** handlers should return -1 for "stop cleanup",
524 0 for "yes, delete this playlist",
525 1 for "no, don't delete this playlist".
527 static PBD::Signal1<int,boost::shared_ptr<Playlist> > AskAboutPlaylistDeletion;
529 /** handlers should return 0 for "ignore the rate mismatch",
530 !0 for "do not use this session"
532 static PBD::Signal2<int, framecnt_t, framecnt_t> AskAboutSampleRateMismatch;
534 /** handlers should return !0 for use pending state, 0 for ignore it.
536 static PBD::Signal0<int> AskAboutPendingState;
538 boost::shared_ptr<AudioFileSource> create_audio_source_for_session (
539 size_t, std::string const &, uint32_t, bool destructive, bool as_stub = false);
541 boost::shared_ptr<MidiSource> create_midi_source_for_session (
542 Track*, std::string const &, bool as_stub = false);
544 boost::shared_ptr<Source> source_by_id (const PBD::ID&);
545 boost::shared_ptr<Source> source_by_path_and_channel (const std::string&, uint16_t);
546 uint32_t count_sources_by_origin (const std::string&);
548 void add_playlist (boost::shared_ptr<Playlist>, bool unused = false);
550 /* named selections */
552 boost::shared_ptr<NamedSelection> named_selection_by_name (std::string name);
553 void add_named_selection (boost::shared_ptr<NamedSelection>);
554 void remove_named_selection (boost::shared_ptr<NamedSelection>);
556 template<class T> void foreach_named_selection (T& obj, void (T::*func)(boost::shared_ptr<NamedSelection>));
557 PBD::Signal0<void> NamedSelectionAdded;
558 PBD::Signal0<void> NamedSelectionRemoved;
560 /* Curves and AutomationLists (TODO when they go away) */
561 void add_automation_list(AutomationList*);
565 boost::shared_ptr<Auditioner> the_auditioner() { return auditioner; }
566 void audition_playlist ();
567 void audition_region (boost::shared_ptr<Region>);
568 void cancel_audition ();
569 bool is_auditioning () const;
571 PBD::Signal1<void,bool> AuditionActive;
573 /* flattening stuff */
575 boost::shared_ptr<Region> write_one_track (AudioTrack&, framepos_t start, framepos_t end,
576 bool overwrite, std::vector<boost::shared_ptr<Source> >&, InterThreadInfo& wot,
577 bool enable_processing = true);
578 int freeze_all (InterThreadInfo&);
580 /* session-wide solo/mute/rec-enable */
582 bool soloing() const { return _non_soloed_outs_muted; }
583 bool listening() const { return _listen_cnt > 0; }
584 bool solo_isolated() const { return _solo_isolated_cnt > 0; }
586 static const SessionEvent::RTeventCallback rt_cleanup;
588 void set_solo (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
589 void set_just_one_solo (boost::shared_ptr<Route>, bool, SessionEvent::RTeventCallback after = rt_cleanup);
590 void set_mute (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
591 void set_listen (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
592 void set_record_enabled (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
593 void set_solo_isolated (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
595 PBD::Signal1<void,bool> SoloActive;
596 PBD::Signal0<void> SoloChanged;
597 PBD::Signal0<void> IsolatedChanged;
599 /* control/master out */
601 boost::shared_ptr<Route> monitor_out() const { return _monitor_out; }
602 boost::shared_ptr<Route> master_out() const { return _master_out; }
604 void globally_add_internal_sends (boost::shared_ptr<Route> dest, Placement p, bool);
605 void globally_set_send_gains_from_track (boost::shared_ptr<Route> dest);
606 void globally_set_send_gains_to_zero (boost::shared_ptr<Route> dest);
607 void globally_set_send_gains_to_unity (boost::shared_ptr<Route> dest);
608 void add_internal_sends (boost::shared_ptr<Route> dest, Placement p, boost::shared_ptr<RouteList> senders);
610 static void set_disable_all_loaded_plugins (bool yn) {
611 _disable_all_loaded_plugins = yn;
613 static bool get_disable_all_loaded_plugins() {
614 return _disable_all_loaded_plugins;
617 uint32_t next_send_id();
618 uint32_t next_return_id();
619 uint32_t next_insert_id();
620 void mark_send_id (uint32_t);
621 void mark_return_id (uint32_t);
622 void mark_insert_id (uint32_t);
623 void unmark_send_id (uint32_t);
624 void unmark_return_id (uint32_t);
625 void unmark_insert_id (uint32_t);
627 /* s/w "RAID" management */
629 framecnt_t available_capture_duration();
633 void add_bundle (boost::shared_ptr<Bundle>);
634 void remove_bundle (boost::shared_ptr<Bundle>);
635 boost::shared_ptr<Bundle> bundle_by_name (std::string) const;
637 PBD::Signal1<void,boost::shared_ptr<Bundle> > BundleAdded;
638 PBD::Signal1<void,boost::shared_ptr<Bundle> > BundleRemoved;
642 /* History (for editors, mixers, UIs etc.) */
644 /** Undo some transactions.
645 * @param n Number of transactions to undo.
647 void undo (uint32_t n) {
651 void redo (uint32_t n) {
655 UndoHistory& history() { return _history; }
657 uint32_t undo_depth() const { return _history.undo_depth(); }
658 uint32_t redo_depth() const { return _history.redo_depth(); }
659 std::string next_undo() const { return _history.next_undo(); }
660 std::string next_redo() const { return _history.next_redo(); }
662 void begin_reversible_command (const std::string& cmd_name);
663 void begin_reversible_command (GQuark);
664 void commit_reversible_command (Command* cmd = 0);
666 void add_command (Command *const cmd) {
667 assert (_current_trans);
668 _current_trans->add_command (cmd);
671 /** @return The list of operations that are currently in progress */
672 std::list<GQuark> const & current_operations () {
673 return _current_trans_quarks;
676 void add_commands (std::vector<Command*> const & cmds);
678 std::map<PBD::ID,PBD::StatefulDestructible*> registry;
680 // these commands are implemented in libs/ardour/session_command.cc
681 Command* memento_command_factory(XMLNode* n);
682 Command* stateful_diff_command_factory (XMLNode *);
683 void register_with_memento_command_factory(PBD::ID, PBD::StatefulDestructible*);
687 boost::shared_ptr<IO> click_io() { return _click_io; }
689 /* disk, buffer loads */
691 uint32_t playback_load ();
692 uint32_t capture_load ();
696 void request_play_range (std::list<AudioRange>*, bool leave_rolling = false);
697 bool get_play_range () const { return _play_range; }
699 /* buffers for gain and pan */
701 gain_t* gain_automation_buffer () const;
702 pan_t** pan_automation_buffer () const;
704 void ensure_buffer_set (BufferSet& buffers, const ChanCount& howmany);
708 static long vst_callback (AEffect* effect,
715 static PBD::Signal0<void> SendFeedback;
719 boost::shared_ptr<Speakers> get_speakers ();
723 boost::shared_ptr<PBD::Controllable> controllable_by_id (const PBD::ID&);
724 boost::shared_ptr<PBD::Controllable> controllable_by_descriptor (const PBD::ControllableDescriptor&);
726 void add_controllable (boost::shared_ptr<PBD::Controllable>);
727 void remove_controllable (PBD::Controllable*);
729 boost::shared_ptr<PBD::Controllable> solo_cut_control() const;
731 SessionMetadata & metadata () { return *_metadata; }
733 SessionConfiguration config;
735 bool exporting () const {
739 /* this is a private enum, but setup_enum_writer() needs it,
740 and i can't find a way to give that function
744 enum PostTransportWork {
745 PostTransportStop = 0x1,
746 PostTransportDisableRecord = 0x2,
747 PostTransportPosition = 0x8,
748 PostTransportDidRecord = 0x20,
749 PostTransportDuration = 0x40,
750 PostTransportLocate = 0x80,
751 PostTransportRoll = 0x200,
752 PostTransportAbort = 0x800,
753 PostTransportOverWrite = 0x1000,
754 PostTransportSpeed = 0x2000,
755 PostTransportAudition = 0x4000,
756 PostTransportScrub = 0x8000,
757 PostTransportReverse = 0x10000,
758 PostTransportInputChange = 0x20000,
759 PostTransportCurveRealloc = 0x40000,
760 PostTransportClearSubstate = 0x80000,
761 PostTransportAdjustPlaybackBuffering = 0x100000,
762 PostTransportAdjustCaptureBuffering = 0x200000
771 SlaveState slave_state() const { return _slave_state; }
773 boost::shared_ptr<SessionPlaylists> playlists;
775 void send_mmc_locate (framepos_t);
776 int send_full_time_code (framepos_t);
778 PBD::Signal0<void> RouteOrderKeyChanged;
780 bool step_editing() const { return (_step_editors > 0); }
782 void request_suspend_timecode_transmission ();
783 void request_resume_timecode_transmission ();
784 bool timecode_transmission_suspended () const;
786 std::string source_search_path(DataType) const;
787 void ensure_search_path_includes (const std::string& path, DataType type);
789 std::list<std::string> unknown_processors () const;
791 /* handlers can return an integer value:
792 0: config.set_audio_search_path() or config.set_midi_search_path() was used
793 to modify the search path and we should try to find it again.
794 1: quit entire session load
795 2: as 0, but don't ask about other missing files
796 3: don't ask about other missing files, and just mark this one missing
797 -1: just mark this one missing
798 any other value: as -1
800 static PBD::Signal3<int,Session*,std::string,DataType> MissingFile;
802 /** Emitted when the session wants Ardour to quit */
803 static PBD::Signal0<void> Quit;
806 friend class AudioEngine;
807 void set_block_size (pframes_t nframes);
808 void set_frame_rate (framecnt_t nframes);
812 void schedule_curve_reallocation ();
813 void update_latency_compensation (bool, bool);
816 int create (const std::string& mix_template, BusProfile*);
820 PendingDeclickIn = 0x1,
821 PendingDeclickOut = 0x2,
822 StopPendingCapture = 0x4,
823 PendingLocate = 0x20,
826 /* stuff used in process() should be close together to
830 typedef void (Session::*process_function_type)(pframes_t);
832 AudioEngine& _engine;
833 mutable gint processing_prohibited;
834 process_function_type process_function;
835 process_function_type last_process_function;
836 bool waiting_for_sync_offset;
837 framecnt_t _base_frame_rate;
838 framecnt_t _current_frame_rate; //this includes video pullup offset
839 framecnt_t _nominal_frame_rate; //ignores audioengine setting, "native" SR
840 int transport_sub_state;
841 mutable gint _record_status;
842 framepos_t _transport_frame;
843 Location* _session_range_location; ///< session range, or 0 if there is nothing in the session yet
847 void maybe_update_session_range (framepos_t, framepos_t);
849 // varispeed playback
850 double _transport_speed;
851 double _last_transport_speed;
852 double _target_transport_speed;
853 CubicInterpolation interpolation;
855 bool auto_play_legal;
856 framepos_t _last_slave_transport_frame;
857 framecnt_t maximum_output_latency;
858 framepos_t _requested_return_frame;
859 pframes_t current_block_size;
860 framecnt_t _worst_output_latency;
861 framecnt_t _worst_input_latency;
862 framecnt_t _worst_track_latency;
865 float _meter_falloff;
866 bool _non_soloed_outs_muted;
867 uint32_t _listen_cnt;
868 uint32_t _solo_isolated_cnt;
872 void set_worst_io_latencies ();
873 void set_worst_io_latencies_x (IOChange, void *) {
874 set_worst_io_latencies ();
877 void update_latency_compensation_proxy (void* ignored);
879 void ensure_buffers (ChanCount howmany = ChanCount::ZERO);
881 void process_scrub (pframes_t);
882 void process_without_events (pframes_t);
883 void process_with_events (pframes_t);
884 void process_audition (pframes_t);
885 void process_export (pframes_t);
886 int process_export_fw (pframes_t);
888 void block_processing() { g_atomic_int_set (&processing_prohibited, 1); }
889 void unblock_processing() { g_atomic_int_set (&processing_prohibited, 0); }
890 bool processing_blocked() const { return g_atomic_int_get (&processing_prohibited); }
892 Glib::Mutex process_thread_lock;
893 std::list<ProcessThread*> process_threads;
897 static const int delta_accumulator_size = 25;
898 int delta_accumulator_cnt;
899 int32_t delta_accumulator[delta_accumulator_size];
900 int32_t average_slave_delta;
902 bool have_first_delta_accumulator;
904 SlaveState _slave_state;
905 framepos_t slave_wait_end;
907 void reset_slave_state ();
908 bool follow_slave (pframes_t);
909 void calculate_moving_average_of_slave_delta (int dir, framecnt_t this_delta);
910 void track_slave_state (float slave_speed, framepos_t slave_transport_frame, framecnt_t this_delta);
911 void follow_slave_silently (pframes_t nframes, float slave_speed);
913 void switch_to_sync_source (SyncSource); /* !RT context */
914 void drop_sync_source (); /* !RT context */
915 void use_sync_source (Slave*); /* RT context */
917 bool post_export_sync;
918 framepos_t post_export_position;
921 bool _export_rolling;
923 boost::shared_ptr<ExportHandler> export_handler;
924 boost::shared_ptr<ExportStatus> export_status;
927 int stop_audio_export ();
928 void finalize_audio_export ();
930 PBD::ScopedConnection export_freewheel_connection;
932 void get_track_statistics ();
933 int process_routes (pframes_t, bool& need_butler);
934 int silent_process_routes (pframes_t, bool& need_butler);
936 bool get_rec_monitors_input () {
937 if (actively_recording()) {
940 if (config.get_auto_input()) {
948 int get_transport_declick_required () {
949 if (transport_sub_state & PendingDeclickIn) {
950 transport_sub_state &= ~PendingDeclickIn;
952 } else if (transport_sub_state & PendingDeclickOut) {
959 bool maybe_stop (framepos_t limit);
960 bool maybe_sync_start (pframes_t &);
962 void check_declick_out ();
968 /** Number of process frames since the last MTC output (when sending MTC); used to
969 * know when to send full MTC messages every so often.
971 pframes_t _pframes_since_last_mtc;
972 bool session_midi_feedback;
975 framepos_t last_loopend;
977 boost::scoped_ptr<SessionDirectory> _session_dir;
980 void when_engine_running ();
981 void graph_reordered ();
983 std::string _current_snapshot_name;
986 bool state_was_pending;
987 StateOfTheState _state_of_the_state;
990 int load_options (const XMLNode&);
991 int load_state (std::string snapshot_name);
993 framepos_t _last_roll_location;
994 framepos_t _last_roll_or_reversal_location;
995 framepos_t _last_record_location;
997 bool pending_locate_roll;
998 framepos_t pending_locate_frame;
999 bool pending_locate_flush;
1001 bool pending_auto_loop;
1005 #if 0 // these should be here, see comments in their other location above
1006 enum PostTransportWork {
1007 PostTransportStop = 0x1,
1008 PostTransportDisableRecord = 0x2,
1009 PostTransportPosition = 0x8,
1010 PostTransportDidRecord = 0x20,
1011 PostTransportDuration = 0x40,
1012 PostTransportLocate = 0x80,
1013 PostTransportRoll = 0x200,
1014 PostTransportAbort = 0x800,
1015 PostTransportOverWrite = 0x1000,
1016 PostTransportSpeed = 0x2000,
1017 PostTransportAudition = 0x4000,
1018 PostTransportScrub = 0x8000,
1019 PostTransportReverse = 0x10000,
1020 PostTransportInputChange = 0x20000,
1021 PostTransportCurveRealloc = 0x40000,
1022 PostTransportClearSubstate = 0x80000
1025 static const PostTransportWork ProcessCannotProceedMask =
1027 PostTransportInputChange|
1029 PostTransportReverse|
1030 PostTransportCurveRealloc|
1032 PostTransportAudition|
1033 PostTransportLocate|
1035 PostTransportClearSubstate);
1037 gint _post_transport_work; /* accessed only atomic ops */
1038 PostTransportWork post_transport_work() const { return (PostTransportWork) g_atomic_int_get (&_post_transport_work); }
1039 void set_post_transport_work (PostTransportWork ptw) { g_atomic_int_set (&_post_transport_work, (gint) ptw); }
1040 void add_post_transport_work (PostTransportWork ptw);
1042 void schedule_playback_buffering_adjustment ();
1043 void schedule_capture_buffering_adjustment ();
1045 uint32_t cumulative_rf_motion;
1048 void set_rf_speed (float speed);
1049 void reset_rf_scale (framecnt_t frames_moved);
1051 Locations* _locations;
1052 void locations_changed ();
1053 void locations_added (Location*);
1054 void handle_locations_changed (Locations::LocationList&);
1056 PBD::ScopedConnectionList punch_connections;
1057 void auto_punch_start_changed (Location *);
1058 void auto_punch_end_changed (Location *);
1059 void auto_punch_changed (Location *);
1061 PBD::ScopedConnectionList loop_connections;
1062 void auto_loop_changed (Location *);
1064 void first_stage_init (std::string path, std::string snapshot_name);
1065 int second_stage_init ();
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&, framepos_t timestamp);
1103 void spp_continue (MIDI::Parser&, framepos_t timestamp);
1104 void spp_stop (MIDI::Parser&, framepos_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 framepos_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 framecnt_t _frames_per_hour;
1138 framecnt_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 framepos_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 (framepos_t, framepos_t, pframes_t nframes);
1150 void reset_record_status ();
1152 int no_roll (pframes_t nframes);
1153 int fail_roll (pframes_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 (framecnt_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 track_playlist_changed (boost::weak_ptr<Track>);
1264 void playlist_region_added (boost::weak_ptr<Region>);
1265 void playlist_ranges_moved (std::list<Evoral::RangeMove<framepos_t> > const &);
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&, framepos_t start, framecnt_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 /** current undo transaction, or 0 */
1346 UndoTransaction* _current_trans;
1347 /** GQuarks to describe the reversible commands that are currently in progress.
1348 * These may be nested, in which case more recently-started commands are toward
1349 * the front of the list.
1351 std::list<GQuark> _current_trans_quarks;
1353 void jack_timebase_callback (jack_transport_state_t, pframes_t, jack_position_t*, int);
1354 int jack_sync_callback (jack_transport_state_t, jack_position_t*);
1355 void reset_jack_connection (jack_client_t* jack);
1356 void process_rtop (SessionEvent*);
1358 #ifdef HAVE_JACK_NEW_LATENCY
1359 void update_latency (bool playback);
1362 XMLNode& state(bool);
1368 boost::shared_ptr<IO> _click_io;
1370 Sample* click_emphasis_data;
1371 framecnt_t click_length;
1372 framecnt_t click_emphasis_length;
1373 mutable Glib::RWLock click_lock;
1375 static const Sample default_click[];
1376 static const framecnt_t default_click_length;
1377 static const Sample default_click_emphasis[];
1378 static const framecnt_t default_click_emphasis_length;
1381 void setup_click_sounds (int which);
1382 void clear_clicks ();
1383 void click (framepos_t start, framecnt_t nframes);
1385 std::vector<Route*> master_outs;
1387 /* range playback */
1389 std::list<AudioRange> current_audio_range;
1391 void set_play_range (std::list<AudioRange>&, bool leave_rolling);
1392 void unset_play_range ();
1397 boost::shared_ptr<Route> _master_out;
1398 boost::shared_ptr<Route> _monitor_out;
1402 long _vst_callback (VSTPlugin*,
1409 /* number of hardware ports we're using,
1410 based on max (requested,available)
1413 ChanCount n_physical_outputs;
1414 ChanCount n_physical_inputs;
1416 int find_all_sources (std::string path, std::set<std::string>& result);
1417 int find_all_sources_across_snapshots (std::set<std::string>& result, bool exclude_this_snapshot);
1419 typedef std::set<boost::shared_ptr<PBD::Controllable> > Controllables;
1420 Glib::Mutex controllables_lock;
1421 Controllables controllables;
1423 boost::shared_ptr<PBD::Controllable> _solo_cut_control;
1425 void reset_native_file_format();
1426 bool first_file_data_format_reset;
1427 bool first_file_header_format_reset;
1429 void config_changed (std::string, bool);
1431 XMLNode& get_control_protocol_state ();
1433 void set_history_depth (uint32_t depth);
1434 void sync_order_keys ();
1436 static bool _disable_all_loaded_plugins;
1438 SessionMetadata * _metadata;
1440 mutable bool have_looped; ///< Used in ::audible_frame(*)
1442 void update_have_rec_enabled_track ();
1443 gint _have_rec_enabled_track;
1445 static int ask_about_playlist_deletion (boost::shared_ptr<Playlist>);
1447 /* realtime "apply to set of routes" operations */
1448 SessionEvent* get_rt_event (
1449 boost::shared_ptr<RouteList> rl, bool yn,
1450 SessionEvent::RTeventCallback after, bool group_override,
1451 void (Session::*method) (boost::shared_ptr<RouteList>, bool, bool));
1453 void rt_set_solo (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1454 void rt_set_just_one_solo (boost::shared_ptr<RouteList>, bool yn, bool /* ignored*/ );
1455 void rt_set_mute (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1456 void rt_set_listen (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1457 void rt_set_solo_isolated (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1458 void rt_set_record_enabled (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1460 /** temporary list of Diskstreams used only during load of 2.X sessions */
1461 std::list<boost::shared_ptr<Diskstream> > _diskstreams_2X;
1463 void add_session_range_location (framepos_t, framepos_t);
1465 void setup_midi_machine_control ();
1466 void cleanup_stubfiles ();
1468 void route_order_key_changed ();
1470 void step_edit_status_change (bool);
1471 uint32_t _step_editors;
1473 /** true if timecode transmission by the transport is suspended, otherwise false */
1474 mutable gint _suspend_timecode_transmission;
1476 void update_locations_after_tempo_map_change (Locations::LocationList &);
1478 void start_time_changed (framepos_t);
1479 void end_time_changed (framepos_t);
1481 boost::shared_ptr<Speakers> _speakers;
1484 } // namespace ARDOUR
1486 #endif /* __ardour_session_h__ */