2 Copyright (C) 2000 Paul Davis
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 #ifndef __ardour_session_h__
21 #define __ardour_session_h__
23 #include "libardour-config.h"
32 #include <boost/dynamic_bitset.hpp>
33 #include <boost/scoped_ptr.hpp>
34 #include <boost/weak_ptr.hpp>
35 #include <boost/utility.hpp>
37 #include <glibmm/thread.h>
39 #include "pbd/error.h"
40 #include "pbd/event_loop.h"
42 #include "pbd/statefuldestructible.h"
43 #include "pbd/signals.h"
46 #include "evoral/types.hpp"
48 #include "midi++/types.h"
50 #include "timecode/time.h"
52 #include "ardour/ardour.h"
53 #include "ardour/chan_count.h"
54 #include "ardour/rc_configuration.h"
55 #include "ardour/session_configuration.h"
56 #include "ardour/session_event.h"
57 #include "ardour/location.h"
58 #include "ardour/interpolation.h"
59 #include "ardour/route_graph.h"
61 #ifdef HAVE_JACK_SESSION
62 #include <jack/session.h>
68 typedef struct _AEffect AEffect;
78 class ControllableDescriptor;
88 class AudioFileSource;
110 class NamedSelection;
123 class SessionDirectory;
124 class SessionMetadata;
125 class SessionPlaylists;
131 class WindowsVSTPlugin;
133 extern void setup_enum_writer ();
135 class Session : public PBD::StatefulDestructible, public PBD::ScopedConnectionList, public SessionEventManager
144 /* a new session might have non-empty mix_template, an existing session should always have an empty one.
145 the bus profile can be null if no master out bus is required.
148 Session (AudioEngine&,
149 const std::string& fullpath,
150 const std::string& snapshot_name,
151 BusProfile* bus_profile = 0,
152 std::string mix_template = "");
156 std::string path() const { return _path; }
157 std::string name() const { return _name; }
158 std::string snap_name() const { return _current_snapshot_name; }
159 std::string raid_path () const;
160 bool path_is_within_session (const std::string&);
162 void set_snap_name ();
164 bool writable() const { return _writable; }
167 bool dirty() const { return _state_of_the_state & Dirty; }
168 void set_deletion_in_progress ();
169 void clear_deletion_in_progress ();
170 bool deletion_in_progress() const { return _state_of_the_state & Deletion; }
171 PBD::Signal0<void> DirtyChanged;
173 const SessionDirectory& session_directory () const { return *(_session_dir.get()); }
175 static PBD::Signal0<void> AutoBindingOn;
176 static PBD::Signal0<void> AutoBindingOff;
178 static PBD::Signal1<void,std::string> Dialog;
180 int ensure_subdirs ();
182 std::string automation_dir () const;
183 std::string analysis_dir() const;
184 std::string plugins_dir() const;
186 std::string peak_path (std::string) const;
188 std::string change_source_path_by_name (std::string oldpath, std::string oldname, std::string newname, bool destructive);
190 std::string peak_path_from_audio_path (std::string) const;
191 std::string new_audio_source_name (const std::string&, uint32_t nchans, uint32_t chan, bool destructive);
192 std::string new_midi_source_name (const std::string&);
193 std::string new_source_path_from_name (DataType type, const std::string&);
194 RouteList new_route_from_template (uint32_t how_many, const std::string& template_path);
196 void process (pframes_t nframes);
198 BufferSet& get_silent_buffers (ChanCount count = ChanCount::ZERO);
199 BufferSet& get_scratch_buffers (ChanCount count = ChanCount::ZERO);
200 BufferSet& get_mix_buffers (ChanCount count = ChanCount::ZERO);
202 bool have_rec_enabled_track () const;
204 bool have_captured() const { return _have_captured; }
206 void refill_all_track_buffers ();
207 Butler* butler() { return _butler; }
208 void butler_transport_work ();
210 void refresh_disk_space ();
212 int load_diskstreams_2X (XMLNode const &, int);
214 int load_routes (const XMLNode&, int);
215 boost::shared_ptr<RouteList> get_routes() const {
216 return routes.reader ();
219 boost::shared_ptr<RouteList> get_routes_with_internal_returns() const;
221 boost::shared_ptr<RouteList> get_routes_with_regions_at (framepos_t const) const;
223 uint32_t nroutes() const { return routes.reader()->size(); }
224 uint32_t ntracks () const;
225 uint32_t nbusses () const;
227 boost::shared_ptr<BundleList> bundles () {
228 return _bundles.reader ();
231 struct RoutePublicOrderSorter {
232 bool operator() (boost::shared_ptr<Route>, boost::shared_ptr<Route> b);
235 void sync_order_keys (std::string const &);
237 template<class T> void foreach_route (T *obj, void (T::*func)(Route&));
238 template<class T> void foreach_route (T *obj, void (T::*func)(boost::shared_ptr<Route>));
239 template<class T, class A> void foreach_route (T *obj, void (T::*func)(Route&, A), A arg);
241 bool io_name_is_legal (const std::string&);
242 boost::shared_ptr<Route> route_by_name (std::string);
243 boost::shared_ptr<Route> route_by_id (PBD::ID);
244 boost::shared_ptr<Route> route_by_remote_id (uint32_t id);
245 void routes_using_input_from (const std::string& str, RouteList& rl);
247 bool route_name_unique (std::string) const;
248 bool route_name_internal (std::string) const;
250 bool get_record_enabled() const {
251 return (record_status () >= Enabled);
254 RecordState record_status() const {
255 return (RecordState) g_atomic_int_get (&_record_status);
258 bool actively_recording () const {
259 return record_status() == Recording;
262 bool record_enabling_legal () const;
263 void maybe_enable_record ();
264 void disable_record (bool rt_context, bool force = false);
265 void step_back_from_record ();
267 void maybe_write_autosave ();
269 /* Emitted when all i/o connections are complete */
271 PBD::Signal0<void> IOConnectionsComplete;
273 /* Record status signals */
275 PBD::Signal0<void> RecordStateChanged;
277 /* Transport mechanism signals */
279 /** Emitted on the following changes in transport state:
280 * - stop (from the butler thread)
281 * - change in whether or not we are looping (from the process thread)
282 * - change in the play range (from the process thread)
283 * - start (from the process thread)
286 PBD::Signal0<void> TransportStateChange;
288 PBD::Signal1<void,framepos_t> PositionChanged; /* sent after any non-sequential motion */
289 PBD::Signal1<void,framepos_t> Xrun;
290 PBD::Signal0<void> TransportLooped;
292 /** emitted when a locate has occurred */
293 PBD::Signal0<void> Located;
295 PBD::Signal1<void,RouteList&> RouteAdded;
296 /** Emitted when a property of one of our route groups changes.
297 * The parameter is the RouteGroup that has changed.
299 PBD::Signal1<void, RouteGroup *> RouteGroupPropertyChanged;
300 /** Emitted when a route is added to one of our route groups.
301 * First parameter is the RouteGroup, second is the route.
303 PBD::Signal2<void, RouteGroup *, boost::weak_ptr<Route> > RouteAddedToRouteGroup;
304 /** Emitted when a route is removed from one of our route groups.
305 * First parameter is the RouteGroup, second is the route.
307 PBD::Signal2<void, RouteGroup *, boost::weak_ptr<Route> > RouteRemovedFromRouteGroup;
309 /* Step Editing status changed */
310 PBD::Signal1<void,bool> StepEditStatusChange;
312 void queue_event (SessionEvent*);
314 void request_roll_at_and_return (framepos_t start, framepos_t return_to);
315 void request_bounded_roll (framepos_t start, framepos_t end);
316 void request_stop (bool abort = false, bool clear_state = false);
317 void request_locate (framepos_t frame, bool with_roll = false);
319 void request_play_loop (bool yn, bool leave_rolling = false);
320 bool get_play_loop () const { return play_loop; }
322 framepos_t last_transport_start () const { return _last_roll_location; }
325 void use_rf_shuttle_speed ();
326 void allow_auto_play (bool yn);
327 void request_transport_speed (double speed);
328 void request_transport_speed_nonzero (double);
329 void request_overwrite_buffer (Track *);
330 void adjust_playback_buffering();
331 void adjust_capture_buffering();
332 void request_track_speed (Track *, double speed);
333 void request_input_change_handling ();
335 bool locate_pending() const { return static_cast<bool>(post_transport_work()&PostTransportLocate); }
336 bool transport_locked () const;
340 framepos_t current_end_frame () const;
341 framepos_t current_start_frame () const;
342 /** "actual" sample rate of session, set by current audioengine rate, pullup/down etc. */
343 framecnt_t frame_rate () const { return _current_frame_rate; }
344 /** "native" sample rate of session, regardless of current audioengine rate, pullup/down etc */
345 framecnt_t nominal_frame_rate () const { return _nominal_frame_rate; }
346 framecnt_t frames_per_hour () const { return _frames_per_hour; }
348 double frames_per_timecode_frame() const { return _frames_per_timecode_frame; }
349 framecnt_t timecode_frames_per_hour() const { return _timecode_frames_per_hour; }
351 MIDI::byte get_mtc_timecode_bits() const {
352 return mtc_timecode_bits; /* encoding of SMTPE type for MTC */
355 float timecode_frames_per_second() const;
356 bool timecode_drop_frames() const;
360 Locations *locations() { return _locations; }
362 PBD::Signal1<void,Location*> auto_loop_location_changed;
363 PBD::Signal1<void,Location*> auto_punch_location_changed;
364 PBD::Signal0<void> locations_modified;
366 void set_auto_punch_location (Location *);
367 void set_auto_loop_location (Location *);
368 int location_name(std::string& result, std::string base = std::string(""));
370 void reset_input_monitor_state ();
372 pframes_t get_block_size() const { return current_block_size; }
373 framecnt_t worst_output_latency () const { return _worst_output_latency; }
374 framecnt_t worst_input_latency () const { return _worst_input_latency; }
375 framecnt_t worst_track_latency () const { return _worst_track_latency; }
376 framecnt_t worst_playback_latency () const { return _worst_output_latency + _worst_track_latency; }
378 #ifdef HAVE_JACK_SESSION
379 void jack_session_event (jack_session_event_t* event);
381 int save_state (std::string snapshot_name, bool pending = false, bool switch_to_snapshot = false);
382 int restore_state (std::string snapshot_name);
383 int save_template (std::string template_name);
384 int save_history (std::string snapshot_name = "");
385 int restore_history (std::string snapshot_name);
386 void remove_state (std::string snapshot_name);
387 void rename_state (std::string old_name, std::string new_name);
388 void remove_pending_capture_state ();
389 int rename (const std::string&);
391 static int rename_template (std::string old_name, std::string new_name);
392 static int delete_template (std::string name);
394 PBD::Signal1<void,std::string> StateSaved;
395 PBD::Signal0<void> StateReady;
397 std::vector<std::string*>* possible_states() const;
398 static std::vector<std::string*>* possible_states (std::string path);
400 XMLNode& get_state();
401 int set_state(const XMLNode& node, int version); // not idempotent
402 XMLNode& get_template();
404 /// The instant xml file is written to the session directory
405 void add_instant_xml (XMLNode&, bool write_to_config = true);
406 XMLNode* instant_xml (const std::string& str);
408 enum StateOfTheState {
413 InitialConnecting = 0x8,
418 StateOfTheState state_of_the_state() const { return _state_of_the_state; }
420 void add_route_group (RouteGroup *);
421 void remove_route_group (RouteGroup&);
422 void reorder_route_groups (std::list<RouteGroup*>);
424 RouteGroup* route_group_by_name (std::string);
425 RouteGroup& all_route_group() const;
427 PBD::Signal1<void,RouteGroup*> route_group_added;
428 PBD::Signal0<void> route_group_removed;
429 PBD::Signal0<void> route_groups_reordered;
431 void foreach_route_group (boost::function<void(RouteGroup*)> f) {
432 for (std::list<RouteGroup *>::iterator i = _route_groups.begin(); i != _route_groups.end(); ++i) {
437 std::list<RouteGroup*> const & route_groups () const {
438 return _route_groups;
441 /* fundamental operations. duh. */
443 std::list<boost::shared_ptr<AudioTrack> > new_audio_track (
446 TrackMode mode = Normal,
447 RouteGroup* route_group = 0,
448 uint32_t how_many = 1,
449 std::string name_template = ""
452 RouteList new_audio_route (
453 int input_channels, int output_channels, RouteGroup* route_group, uint32_t how_many, std::string name_template = ""
456 std::list<boost::shared_ptr<MidiTrack> > new_midi_track (
457 TrackMode mode = Normal, RouteGroup* route_group = 0, uint32_t how_many = 1, std::string name_template = ""
460 void remove_route (boost::shared_ptr<Route>);
461 void resort_routes ();
462 void resort_routes_using (boost::shared_ptr<RouteList>);
464 void set_remote_control_ids();
466 AudioEngine & engine() { return _engine; }
467 AudioEngine const & engine () const { return _engine; }
471 framepos_t transport_frame () const {return _transport_frame; }
472 framepos_t audible_frame () const;
473 framepos_t requested_return_frame() const { return _requested_return_frame; }
487 void sync_time_vars();
489 void bbt_time (framepos_t when, Timecode::BBT_Time&);
490 void timecode_to_sample(Timecode::Time& timecode, framepos_t& sample, bool use_offset, bool use_subframes) const;
491 void sample_to_timecode(framepos_t sample, Timecode::Time& timecode, bool use_offset, bool use_subframes) const;
492 void timecode_time (Timecode::Time &);
493 void timecode_time (framepos_t when, Timecode::Time&);
494 void timecode_time_subframes (framepos_t when, Timecode::Time&);
496 void timecode_duration (framecnt_t, Timecode::Time&) const;
497 void timecode_duration_string (char *, framecnt_t) const;
499 framecnt_t convert_to_frames (AnyTime const & position);
500 framecnt_t any_duration_to_frames (framepos_t position, AnyTime const & duration);
502 static PBD::Signal1<void, framepos_t> StartTimeChanged;
503 static PBD::Signal1<void, framepos_t> EndTimeChanged;
505 std::vector<SyncSource> get_available_sync_options() const;
506 void request_sync_source (Slave*);
507 bool synced_to_jack() const { return config.get_external_sync() && config.get_sync_source() == JACK; }
509 double transport_speed() const { return _transport_speed; }
510 bool transport_stopped() const { return _transport_speed == 0.0f; }
511 bool transport_rolling() const { return _transport_speed != 0.0f; }
513 void set_silent (bool yn);
514 bool silent () { return _silent; }
516 TempoMap& tempo_map() { return *_tempo_map; }
518 /// signals the current transport position in frames, bbt and timecode time (in that order)
519 PBD::Signal3<void, const framepos_t &, const Timecode::BBT_Time&, const Timecode::Time&> tick;
523 boost::shared_ptr<Region> find_whole_file_parent (boost::shared_ptr<Region const>) const;
525 std::string path_from_region_name (DataType type, std::string name, std::string identifier);
527 boost::shared_ptr<Region> XMLRegionFactory (const XMLNode&, bool full);
528 boost::shared_ptr<AudioRegion> XMLAudioRegionFactory (const XMLNode&, bool full);
529 boost::shared_ptr<MidiRegion> XMLMidiRegionFactory (const XMLNode&, bool full);
531 /* source management */
533 void import_audiofiles (ImportStatus&);
534 bool sample_rate_convert (ImportStatus&, std::string infile, std::string& outfile);
535 std::string build_tmp_convert_name (std::string file);
537 boost::shared_ptr<ExportHandler> get_export_handler ();
538 boost::shared_ptr<ExportStatus> get_export_status ();
540 int start_audio_export (framepos_t position, bool realtime);
542 PBD::Signal1<int, framecnt_t> ProcessExport;
543 static PBD::Signal2<void,std::string, std::string> Exported;
545 void add_source (boost::shared_ptr<Source>);
546 void remove_source (boost::weak_ptr<Source>);
548 void cleanup_regions();
549 int cleanup_sources (CleanupReport&);
550 int cleanup_trash_sources (CleanupReport&);
552 int destroy_sources (std::list<boost::shared_ptr<Source> >);
554 int remove_last_capture ();
556 /** handlers should return -1 for "stop cleanup",
557 0 for "yes, delete this playlist",
558 1 for "no, don't delete this playlist".
560 static PBD::Signal1<int,boost::shared_ptr<Playlist> > AskAboutPlaylistDeletion;
562 /** handlers should return 0 for "ignore the rate mismatch",
563 !0 for "do not use this session"
565 static PBD::Signal2<int, framecnt_t, framecnt_t> AskAboutSampleRateMismatch;
567 /** handlers should return !0 for use pending state, 0 for ignore it.
569 static PBD::Signal0<int> AskAboutPendingState;
571 boost::shared_ptr<AudioFileSource> create_audio_source_for_session (
572 size_t, std::string const &, uint32_t, bool destructive);
574 boost::shared_ptr<MidiSource> create_midi_source_for_session (
575 Track*, std::string const &);
577 boost::shared_ptr<Source> source_by_id (const PBD::ID&);
578 boost::shared_ptr<Source> source_by_path_and_channel (const std::string&, uint16_t);
579 uint32_t count_sources_by_origin (const std::string&);
581 void add_playlist (boost::shared_ptr<Playlist>, bool unused = false);
583 /* named selections */
585 boost::shared_ptr<NamedSelection> named_selection_by_name (std::string name);
586 void add_named_selection (boost::shared_ptr<NamedSelection>);
587 void remove_named_selection (boost::shared_ptr<NamedSelection>);
589 template<class T> void foreach_named_selection (T& obj, void (T::*func)(boost::shared_ptr<NamedSelection>));
590 PBD::Signal0<void> NamedSelectionAdded;
591 PBD::Signal0<void> NamedSelectionRemoved;
593 /* Curves and AutomationLists (TODO when they go away) */
594 void add_automation_list(AutomationList*);
598 boost::shared_ptr<Auditioner> the_auditioner() { return auditioner; }
599 void audition_playlist ();
600 void audition_region (boost::shared_ptr<Region>);
601 void cancel_audition ();
602 bool is_auditioning () const;
604 PBD::Signal1<void,bool> AuditionActive;
606 /* flattening stuff */
608 boost::shared_ptr<Region> write_one_track (AudioTrack&, framepos_t start, framepos_t end,
609 bool overwrite, std::vector<boost::shared_ptr<Source> >&, InterThreadInfo& wot,
610 bool enable_processing = true);
611 int freeze_all (InterThreadInfo&);
613 /* session-wide solo/mute/rec-enable */
615 bool soloing() const { return _non_soloed_outs_muted; }
616 bool listening() const { return _listen_cnt > 0; }
617 bool solo_isolated() const { return _solo_isolated_cnt > 0; }
619 static const SessionEvent::RTeventCallback rt_cleanup;
621 void set_solo (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
622 void set_just_one_solo (boost::shared_ptr<Route>, bool, SessionEvent::RTeventCallback after = rt_cleanup);
623 void set_mute (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
624 void set_listen (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
625 void set_record_enabled (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
626 void set_solo_isolated (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
627 void set_exclusive_input_active (boost::shared_ptr<Route> rt, bool others_on);
628 void set_monitoring (boost::shared_ptr<RouteList>, MonitorChoice, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
630 PBD::Signal1<void,bool> SoloActive;
631 PBD::Signal0<void> SoloChanged;
632 PBD::Signal0<void> IsolatedChanged;
634 /* control/master out */
636 boost::shared_ptr<Route> monitor_out() const { return _monitor_out; }
637 boost::shared_ptr<Route> master_out() const { return _master_out; }
639 void globally_add_internal_sends (boost::shared_ptr<Route> dest, Placement p, bool);
640 void globally_set_send_gains_from_track (boost::shared_ptr<Route> dest);
641 void globally_set_send_gains_to_zero (boost::shared_ptr<Route> dest);
642 void globally_set_send_gains_to_unity (boost::shared_ptr<Route> dest);
643 void add_internal_sends (boost::shared_ptr<Route> dest, Placement p, boost::shared_ptr<RouteList> senders);
645 static void set_disable_all_loaded_plugins (bool yn) {
646 _disable_all_loaded_plugins = yn;
648 static bool get_disable_all_loaded_plugins() {
649 return _disable_all_loaded_plugins;
652 uint32_t next_send_id();
653 uint32_t next_return_id();
654 uint32_t next_insert_id();
655 void mark_send_id (uint32_t);
656 void mark_return_id (uint32_t);
657 void mark_insert_id (uint32_t);
658 void unmark_send_id (uint32_t);
659 void unmark_return_id (uint32_t);
660 void unmark_insert_id (uint32_t);
662 /* s/w "RAID" management */
664 framecnt_t available_capture_duration();
668 void add_bundle (boost::shared_ptr<Bundle>);
669 void remove_bundle (boost::shared_ptr<Bundle>);
670 boost::shared_ptr<Bundle> bundle_by_name (std::string) const;
672 PBD::Signal1<void,boost::shared_ptr<Bundle> > BundleAdded;
673 PBD::Signal1<void,boost::shared_ptr<Bundle> > BundleRemoved;
677 /* History (for editors, mixers, UIs etc.) */
679 /** Undo some transactions.
680 * @param n Number of transactions to undo.
682 void undo (uint32_t n) {
686 void redo (uint32_t n) {
690 UndoHistory& history() { return _history; }
692 uint32_t undo_depth() const { return _history.undo_depth(); }
693 uint32_t redo_depth() const { return _history.redo_depth(); }
694 std::string next_undo() const { return _history.next_undo(); }
695 std::string next_redo() const { return _history.next_redo(); }
697 void begin_reversible_command (const std::string& cmd_name);
698 void begin_reversible_command (GQuark);
699 void commit_reversible_command (Command* cmd = 0);
701 void add_command (Command *const cmd) {
702 assert (_current_trans);
703 _current_trans->add_command (cmd);
706 /** @return The list of operations that are currently in progress */
707 std::list<GQuark> const & current_operations () {
708 return _current_trans_quarks;
711 void add_commands (std::vector<Command*> const & cmds);
713 std::map<PBD::ID,PBD::StatefulDestructible*> registry;
715 // these commands are implemented in libs/ardour/session_command.cc
716 Command* memento_command_factory(XMLNode* n);
717 Command* stateful_diff_command_factory (XMLNode *);
718 void register_with_memento_command_factory(PBD::ID, PBD::StatefulDestructible*);
722 boost::shared_ptr<IO> click_io() { return _click_io; }
724 /* disk, buffer loads */
726 uint32_t playback_load ();
727 uint32_t capture_load ();
731 void request_play_range (std::list<AudioRange>*, bool leave_rolling = false);
732 bool get_play_range () const { return _play_range; }
734 /* buffers for gain and pan */
736 gain_t* gain_automation_buffer () const;
737 pan_t** pan_automation_buffer () const;
739 void ensure_buffer_set (BufferSet& buffers, const ChanCount& howmany);
743 static intptr_t vst_callback (
752 static PBD::Signal0<void> SendFeedback;
756 boost::shared_ptr<Speakers> get_speakers ();
760 boost::shared_ptr<PBD::Controllable> controllable_by_id (const PBD::ID&);
761 boost::shared_ptr<PBD::Controllable> controllable_by_descriptor (const PBD::ControllableDescriptor&);
763 void add_controllable (boost::shared_ptr<PBD::Controllable>);
764 void remove_controllable (PBD::Controllable*);
766 boost::shared_ptr<PBD::Controllable> solo_cut_control() const;
768 SessionMetadata & metadata () { return *_metadata; }
770 SessionConfiguration config;
772 bool exporting () const {
776 /* this is a private enum, but setup_enum_writer() needs it,
777 and i can't find a way to give that function
781 enum PostTransportWork {
782 PostTransportStop = 0x1,
783 PostTransportDuration = 0x2,
784 PostTransportLocate = 0x4,
785 PostTransportRoll = 0x8,
786 PostTransportAbort = 0x10,
787 PostTransportOverWrite = 0x20,
788 PostTransportSpeed = 0x40,
789 PostTransportAudition = 0x80,
790 PostTransportReverse = 0x100,
791 PostTransportInputChange = 0x200,
792 PostTransportCurveRealloc = 0x400,
793 PostTransportClearSubstate = 0x800,
794 PostTransportAdjustPlaybackBuffering = 0x1000,
795 PostTransportAdjustCaptureBuffering = 0x2000
804 SlaveState slave_state() const { return _slave_state; }
806 boost::shared_ptr<SessionPlaylists> playlists;
808 void send_mmc_locate (framepos_t);
809 int send_full_time_code (framepos_t);
811 PBD::Signal0<void> RouteOrderKeyChanged;
813 bool step_editing() const { return (_step_editors > 0); }
815 void request_suspend_timecode_transmission ();
816 void request_resume_timecode_transmission ();
817 bool timecode_transmission_suspended () const;
819 std::string source_search_path(DataType) const;
820 void ensure_search_path_includes (const std::string& path, DataType type);
822 std::list<std::string> unknown_processors () const;
824 /** Emitted when a feedback cycle has been detected within Ardour's signal
825 processing path. Until it is fixed (by the user) some (unspecified)
826 routes will not be run.
828 static PBD::Signal0<void> FeedbackDetected;
830 /** Emitted when a graph sort has successfully completed, which means
831 that it has no feedback cycles.
833 static PBD::Signal0<void> SuccessfulGraphSort;
835 /* handlers can return an integer value:
836 0: config.set_audio_search_path() or config.set_midi_search_path() was used
837 to modify the search path and we should try to find it again.
838 1: quit entire session load
839 2: as 0, but don't ask about other missing files
840 3: don't ask about other missing files, and just mark this one missing
841 -1: just mark this one missing
842 any other value: as -1
844 static PBD::Signal3<int,Session*,std::string,DataType> MissingFile;
846 /** Emitted when the session wants Ardour to quit */
847 static PBD::Signal0<void> Quit;
850 friend class AudioEngine;
851 void set_block_size (pframes_t nframes);
852 void set_frame_rate (framecnt_t nframes);
856 void schedule_curve_reallocation ();
857 void update_latency_compensation (bool force = false);
860 int create (const std::string& mix_template, BusProfile*);
864 PendingDeclickIn = 0x1,
865 PendingDeclickOut = 0x2,
866 StopPendingCapture = 0x4,
867 PendingLocate = 0x20,
870 /* stuff used in process() should be close together to
874 typedef void (Session::*process_function_type)(pframes_t);
876 AudioEngine& _engine;
877 mutable gint processing_prohibited;
878 process_function_type process_function;
879 process_function_type last_process_function;
880 bool waiting_for_sync_offset;
881 framecnt_t _base_frame_rate;
882 framecnt_t _current_frame_rate; //this includes video pullup offset
883 framecnt_t _nominal_frame_rate; //ignores audioengine setting, "native" SR
884 int transport_sub_state;
885 mutable gint _record_status;
886 framepos_t _transport_frame;
887 Location* _session_range_location; ///< session range, or 0 if there is nothing in the session yet
891 void maybe_update_session_range (framepos_t, framepos_t);
893 // varispeed playback
894 double _transport_speed;
895 double _last_transport_speed;
896 double _target_transport_speed;
897 CubicInterpolation interpolation;
899 bool auto_play_legal;
900 framepos_t _last_slave_transport_frame;
901 framecnt_t maximum_output_latency;
902 framepos_t _requested_return_frame;
903 pframes_t current_block_size;
904 framecnt_t _worst_output_latency;
905 framecnt_t _worst_input_latency;
906 framecnt_t _worst_track_latency;
909 float _meter_falloff;
910 bool _non_soloed_outs_muted;
911 uint32_t _listen_cnt;
912 uint32_t _solo_isolated_cnt;
916 void initialize_latencies ();
917 void set_worst_io_latencies ();
918 void set_worst_playback_latency ();
919 void set_worst_capture_latency ();
920 void set_worst_io_latencies_x (IOChange, void *) {
921 set_worst_io_latencies ();
923 void post_capture_latency ();
924 void post_playback_latency ();
926 void update_latency_compensation_proxy (void* ignored);
928 void ensure_buffers (ChanCount howmany = ChanCount::ZERO);
930 void process_scrub (pframes_t);
931 void process_without_events (pframes_t);
932 void process_with_events (pframes_t);
933 void process_audition (pframes_t);
934 void process_export (pframes_t);
935 int process_export_fw (pframes_t);
937 void block_processing() { g_atomic_int_set (&processing_prohibited, 1); }
938 void unblock_processing() { g_atomic_int_set (&processing_prohibited, 0); }
939 bool processing_blocked() const { return g_atomic_int_get (&processing_prohibited); }
941 Glib::Mutex process_thread_lock;
942 std::list<ProcessThread*> process_threads;
946 static const int delta_accumulator_size = 25;
947 int delta_accumulator_cnt;
948 int32_t delta_accumulator[delta_accumulator_size];
949 int32_t average_slave_delta;
951 bool have_first_delta_accumulator;
953 SlaveState _slave_state;
954 framepos_t slave_wait_end;
956 void reset_slave_state ();
957 bool follow_slave (pframes_t);
958 void calculate_moving_average_of_slave_delta (int dir, framecnt_t this_delta);
959 void track_slave_state (float slave_speed, framepos_t slave_transport_frame, framecnt_t this_delta);
960 void follow_slave_silently (pframes_t nframes, float slave_speed);
962 void switch_to_sync_source (SyncSource); /* !RT context */
963 void drop_sync_source (); /* !RT context */
964 void use_sync_source (Slave*); /* RT context */
966 bool post_export_sync;
967 framepos_t post_export_position;
970 bool _export_rolling;
972 boost::shared_ptr<ExportHandler> export_handler;
973 boost::shared_ptr<ExportStatus> export_status;
976 int stop_audio_export ();
977 void finalize_audio_export ();
979 PBD::ScopedConnection export_freewheel_connection;
981 void get_track_statistics ();
982 int process_routes (pframes_t, bool& need_butler);
983 int silent_process_routes (pframes_t, bool& need_butler);
985 int get_transport_declick_required () {
986 if (transport_sub_state & PendingDeclickIn) {
987 transport_sub_state &= ~PendingDeclickIn;
989 } else if (transport_sub_state & PendingDeclickOut) {
996 bool maybe_stop (framepos_t limit);
997 bool maybe_sync_start (pframes_t &);
999 void check_declick_out ();
1005 /** Number of process frames since the last MTC output (when sending MTC); used to
1006 * know when to send full MTC messages every so often.
1008 pframes_t _pframes_since_last_mtc;
1009 bool session_midi_feedback;
1012 framepos_t last_loopend;
1014 boost::scoped_ptr<SessionDirectory> _session_dir;
1017 void when_engine_running ();
1018 void graph_reordered ();
1020 /** current snapshot name, without the .ardour suffix */
1021 std::string _current_snapshot_name;
1023 XMLTree* state_tree;
1024 bool state_was_pending;
1025 StateOfTheState _state_of_the_state;
1028 int load_options (const XMLNode&);
1029 int load_state (std::string snapshot_name);
1031 framepos_t _last_roll_location;
1032 framepos_t _last_roll_or_reversal_location;
1033 framepos_t _last_record_location;
1035 bool pending_locate_roll;
1036 framepos_t pending_locate_frame;
1037 bool pending_locate_flush;
1039 bool pending_auto_loop;
1043 static const PostTransportWork ProcessCannotProceedMask =
1045 PostTransportInputChange|
1047 PostTransportReverse|
1048 PostTransportCurveRealloc|
1049 PostTransportAudition|
1050 PostTransportLocate|
1052 PostTransportClearSubstate);
1054 gint _post_transport_work; /* accessed only atomic ops */
1055 PostTransportWork post_transport_work() const { return (PostTransportWork) g_atomic_int_get (&_post_transport_work); }
1056 void set_post_transport_work (PostTransportWork ptw) { g_atomic_int_set (&_post_transport_work, (gint) ptw); }
1057 void add_post_transport_work (PostTransportWork ptw);
1059 void schedule_playback_buffering_adjustment ();
1060 void schedule_capture_buffering_adjustment ();
1062 uint32_t cumulative_rf_motion;
1065 void set_rf_speed (float speed);
1066 void reset_rf_scale (framecnt_t frames_moved);
1068 Locations* _locations;
1069 void locations_changed ();
1070 void locations_added (Location*);
1071 void handle_locations_changed (Locations::LocationList&);
1073 PBD::ScopedConnectionList punch_connections;
1074 void auto_punch_start_changed (Location *);
1075 void auto_punch_end_changed (Location *);
1076 void auto_punch_changed (Location *);
1078 PBD::ScopedConnectionList loop_connections;
1079 void auto_loop_changed (Location *);
1081 void first_stage_init (std::string path, std::string snapshot_name);
1082 int second_stage_init ();
1083 void remove_empty_sounds ();
1085 void setup_midi_control ();
1086 int midi_read (MIDI::Port *);
1088 void enable_record ();
1090 void increment_transport_position (framecnt_t val) {
1091 if (max_framepos - val < _transport_frame) {
1092 _transport_frame = max_framepos;
1094 _transport_frame += val;
1098 void decrement_transport_position (framecnt_t val) {
1099 if (val < _transport_frame) {
1100 _transport_frame -= val;
1102 _transport_frame = 0;
1106 void post_transport_motion ();
1107 static void *session_loader_thread (void *arg);
1111 /* SessionEventManager interface */
1113 void process_event (SessionEvent*);
1114 void set_next_event ();
1115 void cleanup_event (SessionEvent*,int);
1117 /* MIDI Machine Control */
1119 void spp_start (MIDI::Parser&, framepos_t timestamp);
1120 void spp_continue (MIDI::Parser&, framepos_t timestamp);
1121 void spp_stop (MIDI::Parser&, framepos_t timestamp);
1123 void mmc_deferred_play (MIDI::MachineControl &);
1124 void mmc_stop (MIDI::MachineControl &);
1125 void mmc_step (MIDI::MachineControl &, int);
1126 void mmc_pause (MIDI::MachineControl &);
1127 void mmc_record_pause (MIDI::MachineControl &);
1128 void mmc_record_strobe (MIDI::MachineControl &);
1129 void mmc_record_exit (MIDI::MachineControl &);
1130 void mmc_track_record_status (MIDI::MachineControl &, uint32_t track, bool enabled);
1131 void mmc_fast_forward (MIDI::MachineControl &);
1132 void mmc_rewind (MIDI::MachineControl &);
1133 void mmc_locate (MIDI::MachineControl &, const MIDI::byte *);
1134 void mmc_shuttle (MIDI::MachineControl &mmc, float speed, bool forw);
1135 void mmc_record_enable (MIDI::MachineControl &mmc, size_t track, bool enabled);
1137 struct timeval last_mmc_step;
1140 typedef boost::function<bool()> MidiTimeoutCallback;
1141 typedef std::list<MidiTimeoutCallback> MidiTimeoutList;
1143 MidiTimeoutList midi_timeouts;
1144 bool mmc_step_timeout ();
1146 MIDI::byte mtc_msg[16];
1147 MIDI::byte mtc_timecode_bits; /* encoding of SMTPE type for MTC */
1148 MIDI::byte midi_msg[16];
1149 framepos_t outbound_mtc_timecode_frame;
1150 Timecode::Time transmitting_timecode_time;
1151 int next_quarter_frame_to_send;
1153 double _frames_per_timecode_frame; /* has to be floating point because of drop frame */
1154 framecnt_t _frames_per_hour;
1155 framecnt_t _timecode_frames_per_hour;
1157 /* cache the most-recently requested time conversions. This helps when we
1158 * have multiple clocks showing the same time (e.g. the transport frame) */
1159 bool last_timecode_valid;
1160 framepos_t last_timecode_when;
1161 Timecode::Time last_timecode;
1163 bool _send_timecode_update; ///< Flag to send a full frame (Timecode) MTC message this cycle
1165 int send_midi_time_code_for_cycle (framepos_t, framepos_t, pframes_t nframes);
1167 void reset_record_status ();
1169 int no_roll (pframes_t nframes);
1170 int fail_roll (pframes_t nframes);
1172 bool non_realtime_work_pending() const { return static_cast<bool>(post_transport_work()); }
1173 bool process_can_proceed() const { return !(post_transport_work() & ProcessCannotProceedMask); }
1175 MidiControlUI* midi_control_ui;
1177 int start_midi_thread ();
1178 void terminate_midi_thread ();
1180 void set_play_loop (bool yn);
1181 void unset_play_loop ();
1182 void overwrite_some_buffers (Track *);
1183 void flush_all_inserts ();
1184 int micro_locate (framecnt_t distance);
1185 void locate (framepos_t, bool with_roll, bool with_flush, bool with_loop=false, bool force=false, bool with_mmc=true);
1186 void start_locate (framepos_t, bool with_roll, bool with_flush, bool with_loop=false, bool force=false);
1187 void force_locate (framepos_t frame, bool with_roll = false);
1188 void set_track_speed (Track *, double speed);
1189 void set_transport_speed (double speed, bool abort = false, bool clear_state = false);
1190 void stop_transport (bool abort = false, bool clear_state = false);
1191 void start_transport ();
1192 void realtime_stop (bool abort, bool clear_state);
1193 void realtime_locate ();
1194 void non_realtime_start_scrub ();
1195 void non_realtime_set_speed ();
1196 void non_realtime_locate ();
1197 void non_realtime_stop (bool abort, int entry_request_count, bool& finished);
1198 void non_realtime_overwrite (int entry_request_count, bool& finished);
1199 void post_transport ();
1200 void engine_halted ();
1201 void xrun_recovery ();
1203 TempoMap *_tempo_map;
1204 void tempo_map_changed (const PBD::PropertyChange&);
1206 /* edit/mix groups */
1208 int load_route_groups (const XMLNode&, int);
1210 std::list<RouteGroup *> _route_groups;
1211 RouteGroup* _all_route_group;
1215 boost::shared_ptr<Graph> _process_graph;
1217 SerializedRCUManager<RouteList> routes;
1219 void add_routes (RouteList&, bool auto_connect, bool save);
1220 uint32_t destructive_index;
1222 boost::shared_ptr<Route> XMLRouteFactory (const XMLNode&, int);
1223 boost::shared_ptr<Route> XMLRouteFactory_2X (const XMLNode&, int);
1225 void route_processors_changed (RouteProcessorChange);
1227 bool find_route_name (std::string const &, uint32_t& id, char* name, size_t name_len, bool);
1228 void count_existing_track_channels (ChanCount& in, ChanCount& out);
1229 void auto_connect_route (boost::shared_ptr<Route> route, ChanCount& existing_inputs, ChanCount& existing_outputs,
1230 bool with_lock, bool connect_inputs = true,
1231 ChanCount input_start = ChanCount (), ChanCount output_start = ChanCount ());
1232 void midi_output_change_handler (IOChange change, void* /*src*/, boost::weak_ptr<Route> midi_track);
1236 bool solo_update_disabled;
1238 void route_listen_changed (void *src, boost::weak_ptr<Route>);
1239 void route_mute_changed (void *src);
1240 void route_solo_changed (bool self_solo_change, void *src, boost::weak_ptr<Route>);
1241 void route_solo_isolated_changed (void *src, boost::weak_ptr<Route>);
1242 void update_route_solo_state (boost::shared_ptr<RouteList> r = boost::shared_ptr<RouteList>());
1244 void listen_position_changed ();
1245 void solo_control_mode_changed ();
1247 /* REGION MANAGEMENT */
1249 mutable Glib::Mutex region_lock;
1251 int load_regions (const XMLNode& node);
1252 int load_compounds (const XMLNode& node);
1254 void route_added_to_route_group (RouteGroup *, boost::weak_ptr<Route>);
1255 void route_removed_from_route_group (RouteGroup *, boost::weak_ptr<Route>);
1256 void route_group_property_changed (RouteGroup *);
1260 mutable Glib::Mutex source_lock;
1263 typedef std::map<PBD::ID,boost::shared_ptr<Source> > SourceMap;
1269 SourceMap get_sources() { return sources; }
1272 int load_sources (const XMLNode& node);
1273 XMLNode& get_sources_as_xml ();
1275 boost::shared_ptr<Source> XMLSourceFactory (const XMLNode&);
1279 void remove_playlist (boost::weak_ptr<Playlist>);
1280 void track_playlist_changed (boost::weak_ptr<Track>);
1281 void playlist_region_added (boost::weak_ptr<Region>);
1282 void playlist_ranges_moved (std::list<Evoral::RangeMove<framepos_t> > const &);
1283 void playlist_regions_extended (std::list<Evoral::Range<framepos_t> > const &);
1285 /* NAMED SELECTIONS */
1287 mutable Glib::Mutex named_selection_lock;
1288 typedef std::set<boost::shared_ptr<NamedSelection> > NamedSelectionList;
1289 NamedSelectionList named_selections;
1291 int load_named_selections (const XMLNode&);
1293 NamedSelection *named_selection_factory (std::string name);
1294 NamedSelection *XMLNamedSelectionFactory (const XMLNode&);
1296 /* CURVES and AUTOMATION LISTS */
1297 std::map<PBD::ID, AutomationList*> automation_lists;
1299 /* DEFAULT FADE CURVES */
1301 float default_fade_steepness;
1302 float default_fade_msecs;
1306 boost::shared_ptr<Auditioner> auditioner;
1307 void set_audition (boost::shared_ptr<Region>);
1308 void non_realtime_set_audition ();
1309 boost::shared_ptr<Region> pending_audition_region;
1315 int flatten_one_track (AudioTrack&, framepos_t start, framecnt_t cnt);
1317 /* INSERT AND SEND MANAGEMENT */
1319 boost::dynamic_bitset<uint32_t> send_bitset;
1320 boost::dynamic_bitset<uint32_t> return_bitset;
1321 boost::dynamic_bitset<uint32_t> insert_bitset;
1325 struct space_and_path {
1326 uint32_t blocks; /* 4kB blocks */
1334 struct space_and_path_ascending_cmp {
1335 bool operator() (space_and_path a, space_and_path b) {
1336 return a.blocks > b.blocks;
1340 void setup_raid_path (std::string path);
1342 std::vector<space_and_path> session_dirs;
1343 std::vector<space_and_path>::iterator last_rr_session_dir;
1344 uint32_t _total_free_4k_blocks;
1345 Glib::Mutex space_lock;
1347 bool no_questions_about_missing_files;
1349 std::string get_best_session_directory_for_new_source ();
1351 mutable gint _playback_load;
1352 mutable gint _capture_load;
1356 SerializedRCUManager<BundleList> _bundles;
1357 XMLNode* _bundle_xml_node;
1358 int load_bundles (XMLNode const &);
1360 void reverse_track_buffers ();
1362 UndoHistory _history;
1363 /** current undo transaction, or 0 */
1364 UndoTransaction* _current_trans;
1365 /** GQuarks to describe the reversible commands that are currently in progress.
1366 * These may be nested, in which case more recently-started commands are toward
1367 * the front of the list.
1369 std::list<GQuark> _current_trans_quarks;
1371 void jack_timebase_callback (jack_transport_state_t, pframes_t, jack_position_t*, int);
1372 int jack_sync_callback (jack_transport_state_t, jack_position_t*);
1373 void reset_jack_connection (jack_client_t* jack);
1374 void process_rtop (SessionEvent*);
1376 void update_latency (bool playback);
1378 XMLNode& state(bool);
1381 typedef std::list<Click*> Clicks;
1384 boost::shared_ptr<IO> _click_io;
1386 Sample* click_emphasis_data;
1387 framecnt_t click_length;
1388 framecnt_t click_emphasis_length;
1389 mutable Glib::RWLock click_lock;
1391 static const Sample default_click[];
1392 static const framecnt_t default_click_length;
1393 static const Sample default_click_emphasis[];
1394 static const framecnt_t default_click_emphasis_length;
1397 void setup_click_sounds (int which);
1398 void setup_click_sounds (Sample**, Sample const *, framecnt_t*, framecnt_t, std::string const &);
1399 void clear_clicks ();
1400 void click (framepos_t start, framecnt_t nframes);
1402 std::vector<Route*> master_outs;
1404 /* range playback */
1406 std::list<AudioRange> current_audio_range;
1408 void set_play_range (std::list<AudioRange>&, bool leave_rolling);
1409 void unset_play_range ();
1414 boost::shared_ptr<Route> _master_out;
1415 boost::shared_ptr<Route> _monitor_out;
1417 /* Windows VST support */
1419 long _windows_vst_callback (
1428 /* number of hardware ports we're using,
1429 based on max (requested,available)
1432 ChanCount n_physical_outputs;
1433 ChanCount n_physical_inputs;
1435 int find_all_sources (std::string path, std::set<std::string>& result);
1436 int find_all_sources_across_snapshots (std::set<std::string>& result, bool exclude_this_snapshot);
1438 typedef std::set<boost::shared_ptr<PBD::Controllable> > Controllables;
1439 Glib::Mutex controllables_lock;
1440 Controllables controllables;
1442 boost::shared_ptr<PBD::Controllable> _solo_cut_control;
1444 void reset_native_file_format();
1445 bool first_file_data_format_reset;
1446 bool first_file_header_format_reset;
1448 void config_changed (std::string, bool);
1450 XMLNode& get_control_protocol_state ();
1452 void set_history_depth (uint32_t depth);
1453 void sync_order_keys ();
1455 static bool _disable_all_loaded_plugins;
1457 SessionMetadata * _metadata;
1459 mutable bool have_looped; ///< Used in ::audible_frame(*)
1461 void update_have_rec_enabled_track ();
1462 gint _have_rec_enabled_track;
1464 static int ask_about_playlist_deletion (boost::shared_ptr<Playlist>);
1466 /* realtime "apply to set of routes" operations */
1467 template<typename T> SessionEvent*
1468 get_rt_event (boost::shared_ptr<RouteList> rl, T targ, SessionEvent::RTeventCallback after, bool group_override,
1469 void (Session::*method) (boost::shared_ptr<RouteList>, T, bool)) {
1470 SessionEvent* ev = new SessionEvent (SessionEvent::RealTimeOperation, SessionEvent::Add, SessionEvent::Immediate, 0, 0.0);
1471 ev->rt_slot = boost::bind (method, this, rl, targ, group_override);
1472 ev->rt_return = after;
1473 ev->event_loop = PBD::EventLoop::get_event_loop_for_thread ();
1478 void rt_set_solo (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1479 void rt_set_just_one_solo (boost::shared_ptr<RouteList>, bool yn, bool /* ignored*/ );
1480 void rt_set_mute (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1481 void rt_set_listen (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1482 void rt_set_solo_isolated (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1483 void rt_set_record_enabled (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1484 void rt_set_monitoring (boost::shared_ptr<RouteList>, MonitorChoice, bool group_override);
1486 /** temporary list of Diskstreams used only during load of 2.X sessions */
1487 std::list<boost::shared_ptr<Diskstream> > _diskstreams_2X;
1489 void add_session_range_location (framepos_t, framepos_t);
1491 void setup_midi_machine_control ();
1493 void route_order_key_changed ();
1495 void step_edit_status_change (bool);
1496 uint32_t _step_editors;
1498 /** true if timecode transmission by the transport is suspended, otherwise false */
1499 mutable gint _suspend_timecode_transmission;
1501 void update_locations_after_tempo_map_change (Locations::LocationList &);
1503 void start_time_changed (framepos_t);
1504 void end_time_changed (framepos_t);
1506 void set_track_monitor_input_status (bool);
1507 framepos_t compute_stop_limit () const;
1509 boost::shared_ptr<Speakers> _speakers;
1510 void load_nested_sources (const XMLNode& node);
1512 /** The directed graph of routes that is currently being used for audio processing
1513 and solo/mute computations.
1515 GraphEdges _current_route_graph;
1518 } // namespace ARDOUR
1520 #endif /* __ardour_session_h__ */