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_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&);
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; }
354 framecnt_t worst_playback_latency () const { return _worst_output_latency + _worst_track_latency; }
356 #ifdef HAVE_JACK_SESSION
357 void jack_session_event (jack_session_event_t* event);
359 int save_state (std::string snapshot_name, bool pending = false, bool switch_to_snapshot = false);
360 int restore_state (std::string snapshot_name);
361 int save_template (std::string template_name);
362 int save_history (std::string snapshot_name = "");
363 int restore_history (std::string snapshot_name);
364 void remove_state (std::string snapshot_name);
365 void rename_state (std::string old_name, std::string new_name);
366 void remove_pending_capture_state ();
368 static int rename_template (std::string old_name, std::string new_name);
369 static int delete_template (std::string name);
371 PBD::Signal1<void,std::string> StateSaved;
372 PBD::Signal0<void> StateReady;
374 std::vector<std::string*>* possible_states() const;
375 static std::vector<std::string*>* possible_states (std::string path);
377 XMLNode& get_state();
378 int set_state(const XMLNode& node, int version); // not idempotent
379 XMLNode& get_template();
381 /// The instant xml file is written to the session directory
382 void add_instant_xml (XMLNode&, bool write_to_config = true);
383 XMLNode* instant_xml (const std::string& str);
385 enum StateOfTheState {
390 InitialConnecting = 0x8,
395 StateOfTheState state_of_the_state() const { return _state_of_the_state; }
397 void add_route_group (RouteGroup *);
398 void remove_route_group (RouteGroup&);
400 RouteGroup* route_group_by_name (std::string);
401 RouteGroup& all_route_group() const;
403 PBD::Signal1<void,RouteGroup*> route_group_added;
404 PBD::Signal0<void> route_group_removed;
406 void foreach_route_group (boost::function<void(RouteGroup*)> f) {
407 for (std::list<RouteGroup *>::iterator i = _route_groups.begin(); i != _route_groups.end(); ++i) {
412 std::list<RouteGroup*> const & route_groups () const {
413 return _route_groups;
416 /* fundamental operations. duh. */
418 std::list<boost::shared_ptr<AudioTrack> > new_audio_track (
421 TrackMode mode = Normal,
422 RouteGroup* route_group = 0,
423 uint32_t how_many = 1,
424 std::string name_template = ""
427 RouteList new_audio_route (
428 int input_channels, int output_channels, RouteGroup* route_group, uint32_t how_many, std::string name_template = ""
431 std::list<boost::shared_ptr<MidiTrack> > new_midi_track (
432 TrackMode mode = Normal, RouteGroup* route_group = 0, uint32_t how_many = 1, std::string name_template = ""
435 void remove_route (boost::shared_ptr<Route>);
436 void resort_routes ();
437 void resort_routes_using (boost::shared_ptr<RouteList>);
439 void set_remote_control_ids();
441 AudioEngine & engine() { return _engine; }
442 AudioEngine const & engine () const { return _engine; }
446 framepos_t transport_frame () const {return _transport_frame; }
447 framepos_t audible_frame () const;
448 framepos_t requested_return_frame() const { return _requested_return_frame; }
462 void sync_time_vars();
464 void bbt_time (framepos_t when, Timecode::BBT_Time&);
465 void timecode_to_sample(Timecode::Time& timecode, framepos_t& sample, bool use_offset, bool use_subframes) const;
466 void sample_to_timecode(framepos_t sample, Timecode::Time& timecode, bool use_offset, bool use_subframes) const;
467 void timecode_time (Timecode::Time &);
468 void timecode_time (framepos_t when, Timecode::Time&);
469 void timecode_time_subframes (framepos_t when, Timecode::Time&);
471 void timecode_duration (framecnt_t, Timecode::Time&) const;
472 void timecode_duration_string (char *, framecnt_t) const;
474 framecnt_t convert_to_frames (AnyTime const & position);
475 framecnt_t any_duration_to_frames (framepos_t position, AnyTime const & duration);
477 static PBD::Signal1<void, framepos_t> StartTimeChanged;
478 static PBD::Signal1<void, framepos_t> EndTimeChanged;
480 std::vector<SyncSource> get_available_sync_options() const;
481 void request_sync_source (Slave*);
482 bool synced_to_jack() const { return config.get_external_sync() && config.get_sync_source() == JACK; }
484 double transport_speed() const { return _transport_speed; }
485 bool transport_stopped() const { return _transport_speed == 0.0f; }
486 bool transport_rolling() const { return _transport_speed != 0.0f; }
488 void set_silent (bool yn);
489 bool silent () { return _silent; }
491 TempoMap& tempo_map() { return *_tempo_map; }
493 /// signals the current transport position in frames, bbt and timecode time (in that order)
494 PBD::Signal3<void, const framepos_t &, const Timecode::BBT_Time&, const Timecode::Time&> tick;
498 boost::shared_ptr<Region> find_whole_file_parent (boost::shared_ptr<Region const>) const;
500 std::string path_from_region_name (DataType type, std::string name, std::string identifier);
502 boost::shared_ptr<Region> XMLRegionFactory (const XMLNode&, bool full);
503 boost::shared_ptr<AudioRegion> XMLAudioRegionFactory (const XMLNode&, bool full);
504 boost::shared_ptr<MidiRegion> XMLMidiRegionFactory (const XMLNode&, bool full);
506 /* source management */
508 void import_audiofiles (ImportStatus&);
509 bool sample_rate_convert (ImportStatus&, std::string infile, std::string& outfile);
510 std::string build_tmp_convert_name (std::string file);
512 boost::shared_ptr<ExportHandler> get_export_handler ();
513 boost::shared_ptr<ExportStatus> get_export_status ();
515 int start_audio_export (framepos_t position, bool realtime);
517 PBD::Signal1<int, framecnt_t> ProcessExport;
518 static PBD::Signal2<void,std::string, std::string> Exported;
520 void add_source (boost::shared_ptr<Source>);
521 void remove_source (boost::weak_ptr<Source>);
523 void cleanup_regions();
524 int cleanup_sources (CleanupReport&);
525 int cleanup_trash_sources (CleanupReport&);
527 int destroy_sources (std::list<boost::shared_ptr<Source> >);
529 int remove_last_capture ();
531 /** handlers should return -1 for "stop cleanup",
532 0 for "yes, delete this playlist",
533 1 for "no, don't delete this playlist".
535 static PBD::Signal1<int,boost::shared_ptr<Playlist> > AskAboutPlaylistDeletion;
537 /** handlers should return 0 for "ignore the rate mismatch",
538 !0 for "do not use this session"
540 static PBD::Signal2<int, framecnt_t, framecnt_t> AskAboutSampleRateMismatch;
542 /** handlers should return !0 for use pending state, 0 for ignore it.
544 static PBD::Signal0<int> AskAboutPendingState;
546 boost::shared_ptr<AudioFileSource> create_audio_source_for_session (
547 size_t, std::string const &, uint32_t, bool destructive);
549 boost::shared_ptr<MidiSource> create_midi_source_for_session (
550 Track*, std::string const &);
552 boost::shared_ptr<Source> source_by_id (const PBD::ID&);
553 boost::shared_ptr<Source> source_by_path_and_channel (const std::string&, uint16_t);
554 uint32_t count_sources_by_origin (const std::string&);
556 void add_playlist (boost::shared_ptr<Playlist>, bool unused = false);
558 /* named selections */
560 boost::shared_ptr<NamedSelection> named_selection_by_name (std::string name);
561 void add_named_selection (boost::shared_ptr<NamedSelection>);
562 void remove_named_selection (boost::shared_ptr<NamedSelection>);
564 template<class T> void foreach_named_selection (T& obj, void (T::*func)(boost::shared_ptr<NamedSelection>));
565 PBD::Signal0<void> NamedSelectionAdded;
566 PBD::Signal0<void> NamedSelectionRemoved;
568 /* Curves and AutomationLists (TODO when they go away) */
569 void add_automation_list(AutomationList*);
573 boost::shared_ptr<Auditioner> the_auditioner() { return auditioner; }
574 void audition_playlist ();
575 void audition_region (boost::shared_ptr<Region>);
576 void cancel_audition ();
577 bool is_auditioning () const;
579 PBD::Signal1<void,bool> AuditionActive;
581 /* flattening stuff */
583 boost::shared_ptr<Region> write_one_track (AudioTrack&, framepos_t start, framepos_t end,
584 bool overwrite, std::vector<boost::shared_ptr<Source> >&, InterThreadInfo& wot,
585 bool enable_processing = true);
586 int freeze_all (InterThreadInfo&);
588 /* session-wide solo/mute/rec-enable */
590 bool soloing() const { return _non_soloed_outs_muted; }
591 bool listening() const { return _listen_cnt > 0; }
592 bool solo_isolated() const { return _solo_isolated_cnt > 0; }
594 static const SessionEvent::RTeventCallback rt_cleanup;
596 void set_solo (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
597 void set_just_one_solo (boost::shared_ptr<Route>, bool, SessionEvent::RTeventCallback after = rt_cleanup);
598 void set_mute (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
599 void set_listen (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
600 void set_record_enabled (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
601 void set_solo_isolated (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
603 PBD::Signal1<void,bool> SoloActive;
604 PBD::Signal0<void> SoloChanged;
605 PBD::Signal0<void> IsolatedChanged;
607 /* control/master out */
609 boost::shared_ptr<Route> monitor_out() const { return _monitor_out; }
610 boost::shared_ptr<Route> master_out() const { return _master_out; }
612 void globally_add_internal_sends (boost::shared_ptr<Route> dest, Placement p, bool);
613 void globally_set_send_gains_from_track (boost::shared_ptr<Route> dest);
614 void globally_set_send_gains_to_zero (boost::shared_ptr<Route> dest);
615 void globally_set_send_gains_to_unity (boost::shared_ptr<Route> dest);
616 void add_internal_sends (boost::shared_ptr<Route> dest, Placement p, boost::shared_ptr<RouteList> senders);
618 static void set_disable_all_loaded_plugins (bool yn) {
619 _disable_all_loaded_plugins = yn;
621 static bool get_disable_all_loaded_plugins() {
622 return _disable_all_loaded_plugins;
625 uint32_t next_send_id();
626 uint32_t next_return_id();
627 uint32_t next_insert_id();
628 void mark_send_id (uint32_t);
629 void mark_return_id (uint32_t);
630 void mark_insert_id (uint32_t);
631 void unmark_send_id (uint32_t);
632 void unmark_return_id (uint32_t);
633 void unmark_insert_id (uint32_t);
635 /* s/w "RAID" management */
637 framecnt_t available_capture_duration();
641 void add_bundle (boost::shared_ptr<Bundle>);
642 void remove_bundle (boost::shared_ptr<Bundle>);
643 boost::shared_ptr<Bundle> bundle_by_name (std::string) const;
645 PBD::Signal1<void,boost::shared_ptr<Bundle> > BundleAdded;
646 PBD::Signal1<void,boost::shared_ptr<Bundle> > BundleRemoved;
650 /* History (for editors, mixers, UIs etc.) */
652 /** Undo some transactions.
653 * @param n Number of transactions to undo.
655 void undo (uint32_t n) {
659 void redo (uint32_t n) {
663 UndoHistory& history() { return _history; }
665 uint32_t undo_depth() const { return _history.undo_depth(); }
666 uint32_t redo_depth() const { return _history.redo_depth(); }
667 std::string next_undo() const { return _history.next_undo(); }
668 std::string next_redo() const { return _history.next_redo(); }
670 void begin_reversible_command (const std::string& cmd_name);
671 void begin_reversible_command (GQuark);
672 void commit_reversible_command (Command* cmd = 0);
674 void add_command (Command *const cmd) {
675 assert (_current_trans);
676 _current_trans->add_command (cmd);
679 /** @return The list of operations that are currently in progress */
680 std::list<GQuark> const & current_operations () {
681 return _current_trans_quarks;
684 void add_commands (std::vector<Command*> const & cmds);
686 std::map<PBD::ID,PBD::StatefulDestructible*> registry;
688 // these commands are implemented in libs/ardour/session_command.cc
689 Command* memento_command_factory(XMLNode* n);
690 Command* stateful_diff_command_factory (XMLNode *);
691 void register_with_memento_command_factory(PBD::ID, PBD::StatefulDestructible*);
695 boost::shared_ptr<IO> click_io() { return _click_io; }
697 /* disk, buffer loads */
699 uint32_t playback_load ();
700 uint32_t capture_load ();
704 void request_play_range (std::list<AudioRange>*, bool leave_rolling = false);
705 bool get_play_range () const { return _play_range; }
707 /* buffers for gain and pan */
709 gain_t* gain_automation_buffer () const;
710 pan_t** pan_automation_buffer () const;
712 void ensure_buffer_set (BufferSet& buffers, const ChanCount& howmany);
716 static long vst_callback (AEffect* effect,
723 static PBD::Signal0<void> SendFeedback;
727 boost::shared_ptr<Speakers> get_speakers ();
731 boost::shared_ptr<PBD::Controllable> controllable_by_id (const PBD::ID&);
732 boost::shared_ptr<PBD::Controllable> controllable_by_descriptor (const PBD::ControllableDescriptor&);
734 void add_controllable (boost::shared_ptr<PBD::Controllable>);
735 void remove_controllable (PBD::Controllable*);
737 boost::shared_ptr<PBD::Controllable> solo_cut_control() const;
739 SessionMetadata & metadata () { return *_metadata; }
741 SessionConfiguration config;
743 bool exporting () const {
747 /* this is a private enum, but setup_enum_writer() needs it,
748 and i can't find a way to give that function
752 enum PostTransportWork {
753 PostTransportStop = 0x1,
754 PostTransportDisableRecord = 0x2,
755 PostTransportPosition = 0x8,
756 PostTransportDidRecord = 0x20,
757 PostTransportDuration = 0x40,
758 PostTransportLocate = 0x80,
759 PostTransportRoll = 0x200,
760 PostTransportAbort = 0x800,
761 PostTransportOverWrite = 0x1000,
762 PostTransportSpeed = 0x2000,
763 PostTransportAudition = 0x4000,
764 PostTransportScrub = 0x8000,
765 PostTransportReverse = 0x10000,
766 PostTransportInputChange = 0x20000,
767 PostTransportCurveRealloc = 0x40000,
768 PostTransportClearSubstate = 0x80000,
769 PostTransportAdjustPlaybackBuffering = 0x100000,
770 PostTransportAdjustCaptureBuffering = 0x200000
779 SlaveState slave_state() const { return _slave_state; }
781 boost::shared_ptr<SessionPlaylists> playlists;
783 void send_mmc_locate (framepos_t);
784 int send_full_time_code (framepos_t);
786 PBD::Signal0<void> RouteOrderKeyChanged;
788 bool step_editing() const { return (_step_editors > 0); }
790 void request_suspend_timecode_transmission ();
791 void request_resume_timecode_transmission ();
792 bool timecode_transmission_suspended () const;
794 std::string source_search_path(DataType) const;
795 void ensure_search_path_includes (const std::string& path, DataType type);
797 std::list<std::string> unknown_processors () const;
799 /* handlers can return an integer value:
800 0: config.set_audio_search_path() or config.set_midi_search_path() was used
801 to modify the search path and we should try to find it again.
802 1: quit entire session load
803 2: as 0, but don't ask about other missing files
804 3: don't ask about other missing files, and just mark this one missing
805 -1: just mark this one missing
806 any other value: as -1
808 static PBD::Signal3<int,Session*,std::string,DataType> MissingFile;
810 /** Emitted when the session wants Ardour to quit */
811 static PBD::Signal0<void> Quit;
814 friend class AudioEngine;
815 void set_block_size (pframes_t nframes);
816 void set_frame_rate (framecnt_t nframes);
820 void schedule_curve_reallocation ();
821 void update_latency_compensation (bool, bool);
824 int create (const std::string& mix_template, BusProfile*);
828 PendingDeclickIn = 0x1,
829 PendingDeclickOut = 0x2,
830 StopPendingCapture = 0x4,
831 PendingLocate = 0x20,
834 /* stuff used in process() should be close together to
838 typedef void (Session::*process_function_type)(pframes_t);
840 AudioEngine& _engine;
841 mutable gint processing_prohibited;
842 process_function_type process_function;
843 process_function_type last_process_function;
844 bool waiting_for_sync_offset;
845 framecnt_t _base_frame_rate;
846 framecnt_t _current_frame_rate; //this includes video pullup offset
847 framecnt_t _nominal_frame_rate; //ignores audioengine setting, "native" SR
848 int transport_sub_state;
849 mutable gint _record_status;
850 framepos_t _transport_frame;
851 Location* _session_range_location; ///< session range, or 0 if there is nothing in the session yet
855 void maybe_update_session_range (framepos_t, framepos_t);
857 // varispeed playback
858 double _transport_speed;
859 double _last_transport_speed;
860 double _target_transport_speed;
861 CubicInterpolation interpolation;
863 bool auto_play_legal;
864 framepos_t _last_slave_transport_frame;
865 framecnt_t maximum_output_latency;
866 framepos_t _requested_return_frame;
867 pframes_t current_block_size;
868 framecnt_t _worst_output_latency;
869 framecnt_t _worst_input_latency;
870 framecnt_t _worst_track_latency;
873 float _meter_falloff;
874 bool _non_soloed_outs_muted;
875 uint32_t _listen_cnt;
876 uint32_t _solo_isolated_cnt;
880 void set_worst_io_latencies ();
881 void set_worst_io_latencies_x (IOChange, void *) {
882 set_worst_io_latencies ();
885 void update_latency_compensation_proxy (void* ignored);
887 void ensure_buffers (ChanCount howmany = ChanCount::ZERO);
889 void process_scrub (pframes_t);
890 void process_without_events (pframes_t);
891 void process_with_events (pframes_t);
892 void process_audition (pframes_t);
893 void process_export (pframes_t);
894 int process_export_fw (pframes_t);
896 void block_processing() { g_atomic_int_set (&processing_prohibited, 1); }
897 void unblock_processing() { g_atomic_int_set (&processing_prohibited, 0); }
898 bool processing_blocked() const { return g_atomic_int_get (&processing_prohibited); }
900 Glib::Mutex process_thread_lock;
901 std::list<ProcessThread*> process_threads;
905 static const int delta_accumulator_size = 25;
906 int delta_accumulator_cnt;
907 int32_t delta_accumulator[delta_accumulator_size];
908 int32_t average_slave_delta;
910 bool have_first_delta_accumulator;
912 SlaveState _slave_state;
913 framepos_t slave_wait_end;
915 void reset_slave_state ();
916 bool follow_slave (pframes_t);
917 void calculate_moving_average_of_slave_delta (int dir, framecnt_t this_delta);
918 void track_slave_state (float slave_speed, framepos_t slave_transport_frame, framecnt_t this_delta);
919 void follow_slave_silently (pframes_t nframes, float slave_speed);
921 void switch_to_sync_source (SyncSource); /* !RT context */
922 void drop_sync_source (); /* !RT context */
923 void use_sync_source (Slave*); /* RT context */
925 bool post_export_sync;
926 framepos_t post_export_position;
929 bool _export_rolling;
931 boost::shared_ptr<ExportHandler> export_handler;
932 boost::shared_ptr<ExportStatus> export_status;
935 int stop_audio_export ();
936 void finalize_audio_export ();
938 PBD::ScopedConnection export_freewheel_connection;
940 void get_track_statistics ();
941 int process_routes (pframes_t, bool& need_butler);
942 int silent_process_routes (pframes_t, bool& need_butler);
944 bool get_rec_monitors_input () {
945 if (actively_recording()) {
948 if (config.get_auto_input()) {
956 int get_transport_declick_required () {
957 if (transport_sub_state & PendingDeclickIn) {
958 transport_sub_state &= ~PendingDeclickIn;
960 } else if (transport_sub_state & PendingDeclickOut) {
967 bool maybe_stop (framepos_t limit);
968 bool maybe_sync_start (pframes_t &);
970 void check_declick_out ();
976 /** Number of process frames since the last MTC output (when sending MTC); used to
977 * know when to send full MTC messages every so often.
979 pframes_t _pframes_since_last_mtc;
980 bool session_midi_feedback;
983 framepos_t last_loopend;
985 boost::scoped_ptr<SessionDirectory> _session_dir;
988 void when_engine_running ();
989 void graph_reordered ();
991 std::string _current_snapshot_name;
994 bool state_was_pending;
995 StateOfTheState _state_of_the_state;
998 int load_options (const XMLNode&);
999 int load_state (std::string snapshot_name);
1001 framepos_t _last_roll_location;
1002 framepos_t _last_roll_or_reversal_location;
1003 framepos_t _last_record_location;
1005 bool pending_locate_roll;
1006 framepos_t pending_locate_frame;
1007 bool pending_locate_flush;
1009 bool pending_auto_loop;
1013 #if 0 // these should be here, see comments in their other location above
1014 enum PostTransportWork {
1015 PostTransportStop = 0x1,
1016 PostTransportDisableRecord = 0x2,
1017 PostTransportPosition = 0x8,
1018 PostTransportDidRecord = 0x20,
1019 PostTransportDuration = 0x40,
1020 PostTransportLocate = 0x80,
1021 PostTransportRoll = 0x200,
1022 PostTransportAbort = 0x800,
1023 PostTransportOverWrite = 0x1000,
1024 PostTransportSpeed = 0x2000,
1025 PostTransportAudition = 0x4000,
1026 PostTransportScrub = 0x8000,
1027 PostTransportReverse = 0x10000,
1028 PostTransportInputChange = 0x20000,
1029 PostTransportCurveRealloc = 0x40000,
1030 PostTransportClearSubstate = 0x80000
1033 static const PostTransportWork ProcessCannotProceedMask =
1035 PostTransportInputChange|
1037 PostTransportReverse|
1038 PostTransportCurveRealloc|
1040 PostTransportAudition|
1041 PostTransportLocate|
1043 PostTransportClearSubstate);
1045 gint _post_transport_work; /* accessed only atomic ops */
1046 PostTransportWork post_transport_work() const { return (PostTransportWork) g_atomic_int_get (&_post_transport_work); }
1047 void set_post_transport_work (PostTransportWork ptw) { g_atomic_int_set (&_post_transport_work, (gint) ptw); }
1048 void add_post_transport_work (PostTransportWork ptw);
1050 void schedule_playback_buffering_adjustment ();
1051 void schedule_capture_buffering_adjustment ();
1053 uint32_t cumulative_rf_motion;
1056 void set_rf_speed (float speed);
1057 void reset_rf_scale (framecnt_t frames_moved);
1059 Locations* _locations;
1060 void locations_changed ();
1061 void locations_added (Location*);
1062 void handle_locations_changed (Locations::LocationList&);
1064 PBD::ScopedConnectionList punch_connections;
1065 void auto_punch_start_changed (Location *);
1066 void auto_punch_end_changed (Location *);
1067 void auto_punch_changed (Location *);
1069 PBD::ScopedConnectionList loop_connections;
1070 void auto_loop_changed (Location *);
1072 void first_stage_init (std::string path, std::string snapshot_name);
1073 int second_stage_init ();
1074 void remove_empty_sounds ();
1076 void setup_midi_control ();
1077 int midi_read (MIDI::Port *);
1079 void enable_record ();
1081 void increment_transport_position (framecnt_t val) {
1082 if (max_framepos - val < _transport_frame) {
1083 _transport_frame = max_framepos;
1085 _transport_frame += val;
1089 void decrement_transport_position (framecnt_t val) {
1090 if (val < _transport_frame) {
1091 _transport_frame -= val;
1093 _transport_frame = 0;
1097 void post_transport_motion ();
1098 static void *session_loader_thread (void *arg);
1102 /* SessionEventManager interface */
1104 void process_event (SessionEvent*);
1105 void set_next_event ();
1106 void cleanup_event (SessionEvent*,int);
1108 /* MIDI Machine Control */
1110 void spp_start (MIDI::Parser&, framepos_t timestamp);
1111 void spp_continue (MIDI::Parser&, framepos_t timestamp);
1112 void spp_stop (MIDI::Parser&, framepos_t timestamp);
1114 void mmc_deferred_play (MIDI::MachineControl &);
1115 void mmc_stop (MIDI::MachineControl &);
1116 void mmc_step (MIDI::MachineControl &, int);
1117 void mmc_pause (MIDI::MachineControl &);
1118 void mmc_record_pause (MIDI::MachineControl &);
1119 void mmc_record_strobe (MIDI::MachineControl &);
1120 void mmc_record_exit (MIDI::MachineControl &);
1121 void mmc_track_record_status (MIDI::MachineControl &, uint32_t track, bool enabled);
1122 void mmc_fast_forward (MIDI::MachineControl &);
1123 void mmc_rewind (MIDI::MachineControl &);
1124 void mmc_locate (MIDI::MachineControl &, const MIDI::byte *);
1125 void mmc_shuttle (MIDI::MachineControl &mmc, float speed, bool forw);
1126 void mmc_record_enable (MIDI::MachineControl &mmc, size_t track, bool enabled);
1128 struct timeval last_mmc_step;
1131 typedef boost::function<bool()> MidiTimeoutCallback;
1132 typedef std::list<MidiTimeoutCallback> MidiTimeoutList;
1134 MidiTimeoutList midi_timeouts;
1135 bool mmc_step_timeout ();
1137 MIDI::byte mtc_msg[16];
1138 MIDI::byte mtc_timecode_bits; /* encoding of SMTPE type for MTC */
1139 MIDI::byte midi_msg[16];
1140 framepos_t outbound_mtc_timecode_frame;
1141 Timecode::Time transmitting_timecode_time;
1142 int next_quarter_frame_to_send;
1144 double _frames_per_timecode_frame; /* has to be floating point because of drop frame */
1145 framecnt_t _frames_per_hour;
1146 framecnt_t _timecode_frames_per_hour;
1148 /* cache the most-recently requested time conversions. This helps when we
1149 * have multiple clocks showing the same time (e.g. the transport frame) */
1150 bool last_timecode_valid;
1151 framepos_t last_timecode_when;
1152 Timecode::Time last_timecode;
1154 bool _send_timecode_update; ///< Flag to send a full frame (Timecode) MTC message this cycle
1156 int send_midi_time_code_for_cycle (framepos_t, framepos_t, pframes_t nframes);
1158 void reset_record_status ();
1160 int no_roll (pframes_t nframes);
1161 int fail_roll (pframes_t nframes);
1163 bool non_realtime_work_pending() const { return static_cast<bool>(post_transport_work()); }
1164 bool process_can_proceed() const { return !(post_transport_work() & ProcessCannotProceedMask); }
1166 MidiControlUI* midi_control_ui;
1168 int start_midi_thread ();
1169 void terminate_midi_thread ();
1171 void set_play_loop (bool yn);
1172 void unset_play_loop ();
1173 void overwrite_some_buffers (Track *);
1174 void flush_all_inserts ();
1175 int micro_locate (framecnt_t distance);
1176 void locate (framepos_t, bool with_roll, bool with_flush, bool with_loop=false, bool force=false, bool with_mmc=true);
1177 void start_locate (framepos_t, bool with_roll, bool with_flush, bool with_loop=false, bool force=false);
1178 void force_locate (framepos_t frame, bool with_roll = false);
1179 void set_track_speed (Track *, double speed);
1180 void set_transport_speed (double speed, bool abort = false, bool clear_state = false);
1181 void stop_transport (bool abort = false, bool clear_state = false);
1182 void start_transport ();
1183 void realtime_stop (bool abort, bool clear_state);
1184 void non_realtime_start_scrub ();
1185 void non_realtime_set_speed ();
1186 void non_realtime_locate ();
1187 void non_realtime_stop (bool abort, int entry_request_count, bool& finished);
1188 void non_realtime_overwrite (int entry_request_count, bool& finished);
1189 void post_transport ();
1190 void engine_halted ();
1191 void xrun_recovery ();
1193 TempoMap *_tempo_map;
1194 void tempo_map_changed (const PBD::PropertyChange&);
1196 /* edit/mix groups */
1198 int load_route_groups (const XMLNode&, int);
1200 std::list<RouteGroup *> _route_groups;
1201 RouteGroup* _all_route_group;
1205 boost::shared_ptr<Graph> route_graph;
1207 SerializedRCUManager<RouteList> routes;
1209 void add_routes (RouteList&, bool save);
1210 uint32_t destructive_index;
1212 boost::shared_ptr<Route> XMLRouteFactory (const XMLNode&, int);
1213 boost::shared_ptr<Route> XMLRouteFactory_2X (const XMLNode&, int);
1215 void route_processors_changed (RouteProcessorChange);
1217 bool find_route_name (std::string const &, uint32_t& id, char* name, size_t name_len, bool);
1218 void count_existing_route_channels (ChanCount& in, ChanCount& out);
1219 void auto_connect_route (
1221 ChanCount& existing_inputs,
1222 ChanCount& existing_outputs,
1223 bool connect_inputs = true,
1224 ChanCount input_start = ChanCount (),
1225 ChanCount output_start = ChanCount ()
1230 bool solo_update_disabled;
1232 void route_listen_changed (void *src, boost::weak_ptr<Route>);
1233 void route_mute_changed (void *src);
1234 void route_solo_changed (bool self_solo_change, void *src, boost::weak_ptr<Route>);
1235 void route_solo_isolated_changed (void *src, boost::weak_ptr<Route>);
1236 void update_route_solo_state (boost::shared_ptr<RouteList> r = boost::shared_ptr<RouteList>());
1238 void listen_position_changed ();
1239 void solo_control_mode_changed ();
1241 /* REGION MANAGEMENT */
1243 mutable Glib::Mutex region_lock;
1245 int load_regions (const XMLNode& node);
1247 void route_group_changed ();
1251 mutable Glib::Mutex source_lock;
1254 typedef std::map<PBD::ID,boost::shared_ptr<Source> > SourceMap;
1260 SourceMap get_sources() { return sources; }
1263 int load_sources (const XMLNode& node);
1264 XMLNode& get_sources_as_xml ();
1266 boost::shared_ptr<Source> XMLSourceFactory (const XMLNode&);
1270 void remove_playlist (boost::weak_ptr<Playlist>);
1271 void track_playlist_changed (boost::weak_ptr<Track>);
1272 void playlist_region_added (boost::weak_ptr<Region>);
1273 void playlist_ranges_moved (std::list<Evoral::RangeMove<framepos_t> > const &);
1274 void playlist_regions_extended (std::list<Evoral::Range<framepos_t> > const &);
1276 /* NAMED SELECTIONS */
1278 mutable Glib::Mutex named_selection_lock;
1279 typedef std::set<boost::shared_ptr<NamedSelection> > NamedSelectionList;
1280 NamedSelectionList named_selections;
1282 int load_named_selections (const XMLNode&);
1284 NamedSelection *named_selection_factory (std::string name);
1285 NamedSelection *XMLNamedSelectionFactory (const XMLNode&);
1287 /* CURVES and AUTOMATION LISTS */
1288 std::map<PBD::ID, AutomationList*> automation_lists;
1290 /* DEFAULT FADE CURVES */
1292 float default_fade_steepness;
1293 float default_fade_msecs;
1297 boost::shared_ptr<Auditioner> auditioner;
1298 void set_audition (boost::shared_ptr<Region>);
1299 void non_realtime_set_audition ();
1300 boost::shared_ptr<Region> pending_audition_region;
1306 int flatten_one_track (AudioTrack&, framepos_t start, framecnt_t cnt);
1308 /* INSERT AND SEND MANAGEMENT */
1310 boost::dynamic_bitset<uint32_t> send_bitset;
1311 boost::dynamic_bitset<uint32_t> return_bitset;
1312 boost::dynamic_bitset<uint32_t> insert_bitset;
1316 struct space_and_path {
1317 uint32_t blocks; /* 4kB blocks */
1325 struct space_and_path_ascending_cmp {
1326 bool operator() (space_and_path a, space_and_path b) {
1327 return a.blocks > b.blocks;
1331 void setup_raid_path (std::string path);
1333 std::vector<space_and_path> session_dirs;
1334 std::vector<space_and_path>::iterator last_rr_session_dir;
1335 uint32_t _total_free_4k_blocks;
1336 Glib::Mutex space_lock;
1338 bool no_questions_about_missing_files;
1340 std::string get_best_session_directory_for_new_source ();
1342 mutable gint _playback_load;
1343 mutable gint _capture_load;
1347 SerializedRCUManager<BundleList> _bundles;
1348 XMLNode* _bundle_xml_node;
1349 int load_bundles (XMLNode const &);
1351 void reverse_track_buffers ();
1353 UndoHistory _history;
1354 /** current undo transaction, or 0 */
1355 UndoTransaction* _current_trans;
1356 /** GQuarks to describe the reversible commands that are currently in progress.
1357 * These may be nested, in which case more recently-started commands are toward
1358 * the front of the list.
1360 std::list<GQuark> _current_trans_quarks;
1362 void jack_timebase_callback (jack_transport_state_t, pframes_t, jack_position_t*, int);
1363 int jack_sync_callback (jack_transport_state_t, jack_position_t*);
1364 void reset_jack_connection (jack_client_t* jack);
1365 void process_rtop (SessionEvent*);
1367 #ifdef HAVE_JACK_NEW_LATENCY
1368 void update_latency (bool playback);
1371 XMLNode& state(bool);
1377 boost::shared_ptr<IO> _click_io;
1379 Sample* click_emphasis_data;
1380 framecnt_t click_length;
1381 framecnt_t click_emphasis_length;
1382 mutable Glib::RWLock click_lock;
1384 static const Sample default_click[];
1385 static const framecnt_t default_click_length;
1386 static const Sample default_click_emphasis[];
1387 static const framecnt_t default_click_emphasis_length;
1390 void setup_click_sounds (int which);
1391 void setup_click_sounds (Sample**, Sample const *, framecnt_t*, framecnt_t, std::string const &);
1392 void clear_clicks ();
1393 void click (framepos_t start, framecnt_t nframes);
1395 std::vector<Route*> master_outs;
1397 /* range playback */
1399 std::list<AudioRange> current_audio_range;
1401 void set_play_range (std::list<AudioRange>&, bool leave_rolling);
1402 void unset_play_range ();
1407 boost::shared_ptr<Route> _master_out;
1408 boost::shared_ptr<Route> _monitor_out;
1412 long _vst_callback (VSTPlugin*,
1419 /* number of hardware ports we're using,
1420 based on max (requested,available)
1423 ChanCount n_physical_outputs;
1424 ChanCount n_physical_inputs;
1426 int find_all_sources (std::string path, std::set<std::string>& result);
1427 int find_all_sources_across_snapshots (std::set<std::string>& result, bool exclude_this_snapshot);
1429 typedef std::set<boost::shared_ptr<PBD::Controllable> > Controllables;
1430 Glib::Mutex controllables_lock;
1431 Controllables controllables;
1433 boost::shared_ptr<PBD::Controllable> _solo_cut_control;
1435 void reset_native_file_format();
1436 bool first_file_data_format_reset;
1437 bool first_file_header_format_reset;
1439 void config_changed (std::string, bool);
1441 XMLNode& get_control_protocol_state ();
1443 void set_history_depth (uint32_t depth);
1444 void sync_order_keys ();
1446 static bool _disable_all_loaded_plugins;
1448 SessionMetadata * _metadata;
1450 mutable bool have_looped; ///< Used in ::audible_frame(*)
1452 void update_have_rec_enabled_track ();
1453 gint _have_rec_enabled_track;
1455 static int ask_about_playlist_deletion (boost::shared_ptr<Playlist>);
1457 /* realtime "apply to set of routes" operations */
1458 SessionEvent* get_rt_event (
1459 boost::shared_ptr<RouteList> rl, bool yn,
1460 SessionEvent::RTeventCallback after, bool group_override,
1461 void (Session::*method) (boost::shared_ptr<RouteList>, bool, bool));
1463 void rt_set_solo (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1464 void rt_set_just_one_solo (boost::shared_ptr<RouteList>, bool yn, bool /* ignored*/ );
1465 void rt_set_mute (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1466 void rt_set_listen (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1467 void rt_set_solo_isolated (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1468 void rt_set_record_enabled (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1470 /** temporary list of Diskstreams used only during load of 2.X sessions */
1471 std::list<boost::shared_ptr<Diskstream> > _diskstreams_2X;
1473 void add_session_range_location (framepos_t, framepos_t);
1475 void setup_midi_machine_control ();
1477 void route_order_key_changed ();
1479 void step_edit_status_change (bool);
1480 uint32_t _step_editors;
1482 /** true if timecode transmission by the transport is suspended, otherwise false */
1483 mutable gint _suspend_timecode_transmission;
1485 void update_locations_after_tempo_map_change (Locations::LocationList &);
1487 void start_time_changed (framepos_t);
1488 void end_time_changed (framepos_t);
1490 void set_track_monitor_input_status (bool);
1492 boost::shared_ptr<Speakers> _speakers;
1495 } // namespace ARDOUR
1497 #endif /* __ardour_session_h__ */