2 Copyright (C) 2000 Paul Davis
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 #ifndef __ardour_session_h__
21 #define __ardour_session_h__
31 #include <boost/dynamic_bitset.hpp>
32 #include <boost/scoped_ptr.hpp>
33 #include <boost/weak_ptr.hpp>
34 #include <boost/utility.hpp>
36 #include <glibmm/thread.h>
38 #include "pbd/error.h"
40 #include "pbd/statefuldestructible.h"
41 #include "pbd/signals.h"
44 #include "midi++/mmc.h"
45 #include "midi++/types.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/timecode.h"
55 #include "ardour/interpolation.h"
57 #ifdef HAVE_JACK_SESSION
58 #include <jack/session.h>
71 class ControllableDescriptor;
81 class AudioFileSource;
91 class ControlProtocolInfo;
102 class NamedSelection;
115 class SessionDirectory;
116 class SessionMetadata;
117 class SessionPlaylists;
125 extern void setup_enum_writer ();
127 class Session : public PBD::StatefulDestructible, public PBD::ScopedConnectionList, public SessionEventManager
136 /* a new session might have non-empty mix_template, an existing session should always have an empty one.
137 the bus profile can be null if no master out bus is required.
140 Session (AudioEngine&,
141 const std::string& fullpath,
142 const std::string& snapshot_name,
143 BusProfile* bus_profile = 0,
144 std::string mix_template = "");
148 std::string path() const { return _path; }
149 std::string name() const { return _name; }
150 std::string snap_name() const { return _current_snapshot_name; }
151 std::string raid_path () const;
152 bool path_is_within_session (const std::string&);
154 void set_snap_name ();
156 bool writable() const { return _writable; }
159 bool dirty() const { return _state_of_the_state & Dirty; }
160 void set_deletion_in_progress ();
161 void clear_deletion_in_progress ();
162 bool deletion_in_progress() const { return _state_of_the_state & Deletion; }
163 PBD::Signal0<void> DirtyChanged;
165 const SessionDirectory& session_directory () const { return *(_session_dir.get()); }
167 static PBD::Signal0<void> AutoBindingOn;
168 static PBD::Signal0<void> AutoBindingOff;
170 static PBD::Signal1<void,std::string> Dialog;
172 std::string sound_dir (bool with_path = true) const;
173 std::string peak_dir () const;
174 std::string dead_sound_dir () const;
175 std::string automation_dir () const;
176 std::string analysis_dir() const;
178 int ensure_subdirs ();
180 Glib::ustring peak_path (Glib::ustring) const;
182 static std::string change_source_path_by_name (std::string oldpath, std::string oldname, std::string newname, bool destructive);
184 std::string peak_path_from_audio_path (std::string) const;
185 std::string new_audio_source_name (const std::string&, uint32_t nchans, uint32_t chan, bool destructive);
186 std::string new_midi_source_name (const std::string&);
187 std::string new_source_path_from_name (DataType type, const std::string&);
188 RouteList new_route_from_template (uint32_t how_many, const std::string& template_path);
190 void process (nframes_t nframes);
192 BufferSet& get_silent_buffers (ChanCount count = ChanCount::ZERO);
193 BufferSet& get_scratch_buffers (ChanCount count = ChanCount::ZERO);
194 BufferSet& get_mix_buffers (ChanCount count = ChanCount::ZERO);
196 bool have_rec_enabled_track () const;
198 bool have_captured() const { return _have_captured; }
200 void refill_all_track_buffers ();
201 Butler* butler() { return _butler; }
202 void butler_transport_work ();
204 void refresh_disk_space ();
206 int load_diskstreams_2X (XMLNode const &, int);
208 int load_routes (const XMLNode&, int);
209 boost::shared_ptr<RouteList> get_routes() const {
210 return routes.reader ();
213 boost::shared_ptr<RouteList> get_routes_with_internal_returns() const;
215 boost::shared_ptr<RouteList> get_routes_with_regions_at (nframes64_t const) const;
217 uint32_t nroutes() const { return routes.reader()->size(); }
218 uint32_t ntracks () const;
219 uint32_t nbusses () const;
221 boost::shared_ptr<BundleList> bundles () {
222 return _bundles.reader ();
225 struct RoutePublicOrderSorter {
226 bool operator() (boost::shared_ptr<Route>, boost::shared_ptr<Route> b);
229 void sync_order_keys (std::string const &);
231 template<class T> void foreach_route (T *obj, void (T::*func)(Route&));
232 template<class T> void foreach_route (T *obj, void (T::*func)(boost::shared_ptr<Route>));
233 template<class T, class A> void foreach_route (T *obj, void (T::*func)(Route&, A), A arg);
235 bool io_name_is_legal (const std::string&);
236 boost::shared_ptr<Route> route_by_name (std::string);
237 boost::shared_ptr<Route> route_by_id (PBD::ID);
238 boost::shared_ptr<Route> route_by_remote_id (uint32_t id);
240 bool route_name_unique (std::string) const;
241 bool route_name_internal (std::string) const;
243 bool get_record_enabled() const {
244 return (record_status () >= Enabled);
247 RecordState record_status() const {
248 return (RecordState) g_atomic_int_get (&_record_status);
251 bool actively_recording () {
252 return record_status() == Recording;
255 bool record_enabling_legal () const;
256 void maybe_enable_record ();
257 void disable_record (bool rt_context, bool force = false);
258 void step_back_from_record ();
260 void maybe_write_autosave ();
262 /* Emitted when all i/o connections are complete */
264 PBD::Signal0<void> IOConnectionsComplete;
266 /* Record status signals */
268 PBD::Signal0<void> RecordStateChanged;
270 /* Transport mechanism signals */
272 PBD::Signal0<void> TransportStateChange; /* generic */
273 PBD::Signal1<void,nframes64_t> PositionChanged; /* sent after any non-sequential motion */
274 PBD::Signal1<void,nframes64_t> Xrun;
275 PBD::Signal0<void> TransportLooped;
277 /** emitted when a locate has occurred */
278 PBD::Signal0<void> Located;
280 PBD::Signal1<void,RouteList&> RouteAdded;
281 PBD::Signal0<void> RouteGroupChanged;
283 void queue_event (SessionEvent*);
285 void request_roll_at_and_return (nframes_t start, nframes_t return_to);
286 void request_bounded_roll (nframes_t start, nframes_t end);
287 void request_stop (bool abort = false, bool clear_state = false);
288 void request_locate (nframes_t frame, bool with_roll = false);
290 void request_play_loop (bool yn, bool leave_rolling = false);
291 bool get_play_loop () const { return play_loop; }
293 nframes_t last_transport_start() const { return _last_roll_location; }
296 void set_session_start (nframes_t);
297 void set_session_end (nframes_t);
298 void use_rf_shuttle_speed ();
299 void allow_auto_play (bool yn);
300 void request_transport_speed (double speed);
301 void request_overwrite_buffer (Track *);
302 void request_track_speed (Track *, double speed);
303 void request_input_change_handling ();
305 bool locate_pending() const { return static_cast<bool>(post_transport_work()&PostTransportLocate); }
306 bool transport_locked () const;
310 std::pair<nframes_t, nframes_t> get_extent () const;
311 nframes_t current_end_frame () const;
312 nframes_t current_start_frame () const;
313 /// "actual" sample rate of session, set by current audioengine rate, pullup/down etc.
314 nframes_t frame_rate() const { return _current_frame_rate; }
315 /// "native" sample rate of session, regardless of current audioengine rate, pullup/down etc
316 nframes_t nominal_frame_rate() const { return _nominal_frame_rate; }
317 nframes_t frames_per_hour() const { return _frames_per_hour; }
319 double frames_per_timecode_frame() const { return _frames_per_timecode_frame; }
320 nframes_t timecode_frames_per_hour() const { return _timecode_frames_per_hour; }
322 MIDI::byte get_mtc_timecode_bits() const {
323 return mtc_timecode_bits; /* encoding of SMTPE type for MTC */
326 float timecode_frames_per_second() const;
327 bool timecode_drop_frames() const;
331 Locations *locations() { return &_locations; }
333 PBD::Signal1<void,Location*> auto_loop_location_changed;
334 PBD::Signal1<void,Location*> auto_punch_location_changed;
335 PBD::Signal0<void> locations_modified;
337 void set_auto_punch_location (Location *);
338 void set_auto_loop_location (Location *);
339 int location_name(std::string& result, std::string base = std::string(""));
341 void reset_input_monitor_state ();
343 nframes_t get_block_size() const { return current_block_size; }
344 nframes_t worst_output_latency () const { return _worst_output_latency; }
345 nframes_t worst_input_latency () const { return _worst_input_latency; }
346 nframes_t worst_track_latency () const { return _worst_track_latency; }
348 #ifdef HAVE_JACK_SESSION
349 void jack_session_event (jack_session_event_t* event);
351 int save_state (std::string snapshot_name, bool pending = false, bool switch_to_snapshot = false);
352 int restore_state (std::string snapshot_name);
353 int save_template (std::string template_name);
354 int save_history (std::string snapshot_name = "");
355 int restore_history (std::string snapshot_name);
356 void remove_state (std::string snapshot_name);
357 void rename_state (std::string old_name, std::string new_name);
358 void remove_pending_capture_state ();
360 static int rename_template (std::string old_name, std::string new_name);
361 static int delete_template (std::string name);
363 PBD::Signal1<void,std::string> StateSaved;
364 PBD::Signal0<void> StateReady;
366 std::vector<std::string*>* possible_states() const;
367 static std::vector<std::string*>* possible_states (std::string path);
369 XMLNode& get_state();
370 int set_state(const XMLNode& node, int version); // not idempotent
371 XMLNode& get_template();
373 /// The instant xml file is written to the session directory
374 void add_instant_xml (XMLNode&, bool write_to_config = true);
375 XMLNode* instant_xml (const std::string& str);
377 enum StateOfTheState {
382 InitialConnecting = 0x8,
387 StateOfTheState state_of_the_state() const { return _state_of_the_state; }
389 void add_route_group (RouteGroup *);
390 void remove_route_group (RouteGroup&);
392 RouteGroup *route_group_by_name (std::string);
394 PBD::Signal1<void,RouteGroup*> route_group_added;
395 PBD::Signal0<void> route_group_removed;
397 void foreach_route_group (boost::function<void(RouteGroup*)> f) {
398 for (std::list<RouteGroup *>::iterator i = _route_groups.begin(); i != _route_groups.end(); ++i) {
403 /* fundamental operations. duh. */
405 std::list<boost::shared_ptr<AudioTrack> > new_audio_track (
406 int input_channels, int output_channels, TrackMode mode = Normal, RouteGroup* route_group = 0, uint32_t how_many = 1
409 RouteList new_audio_route (bool aux, int input_channels, int output_channels, RouteGroup* route_group, uint32_t how_many);
411 std::list<boost::shared_ptr<MidiTrack> > new_midi_track (
412 TrackMode mode = Normal, RouteGroup* route_group = 0, uint32_t how_many = 1
415 void remove_route (boost::shared_ptr<Route>);
416 void resort_routes ();
417 void resort_routes_using (boost::shared_ptr<RouteList>);
419 void set_remote_control_ids();
421 AudioEngine & engine() { return _engine; }
422 AudioEngine const & engine () const { return _engine; }
426 nframes64_t transport_frame () const {return _transport_frame; }
427 nframes64_t audible_frame () const;
428 nframes64_t requested_return_frame() const { return _requested_return_frame; }
442 void sync_time_vars();
444 void bbt_time (nframes_t when, BBT_Time&);
445 void timecode_to_sample(Timecode::Time& timecode, nframes_t& sample, bool use_offset, bool use_subframes) const;
446 void sample_to_timecode(nframes_t sample, Timecode::Time& timecode, bool use_offset, bool use_subframes) const;
447 void timecode_time (Timecode::Time &);
448 void timecode_time (nframes_t when, Timecode::Time&);
449 void timecode_time_subframes (nframes_t when, Timecode::Time&);
451 void timecode_duration (nframes_t, Timecode::Time&) const;
452 void timecode_duration_string (char *, nframes_t) const;
454 void set_timecode_offset (nframes_t);
455 nframes_t timecode_offset () const { return _timecode_offset; }
456 void set_timecode_offset_negative (bool);
457 bool timecode_offset_negative () const { return _timecode_offset_negative; }
459 nframes_t convert_to_frames_at (nframes_t position, AnyTime const &);
461 static PBD::Signal0<void> StartTimeChanged;
462 static PBD::Signal0<void> EndTimeChanged;
463 static PBD::Signal0<void> TimecodeOffsetChanged;
465 std::vector<SyncSource> get_available_sync_options() const;
466 void request_sync_source (Slave*);
467 bool synced_to_jack() const { return config.get_external_sync() && config.get_sync_source() == JACK; }
469 double transport_speed() const { return _transport_speed; }
470 bool transport_stopped() const { return _transport_speed == 0.0f; }
471 bool transport_rolling() const { return _transport_speed != 0.0f; }
473 void set_silent (bool yn);
474 bool silent () { return _silent; }
476 int jack_slave_sync (nframes_t);
478 TempoMap& tempo_map() { return *_tempo_map; }
480 /// signals the current transport position in frames, bbt and timecode time (in that order)
481 PBD::Signal3<void,const nframes_t&, const BBT_Time&, const Timecode::Time&> tick;
485 boost::shared_ptr<Region> find_whole_file_parent (boost::shared_ptr<Region const>) const;
487 std::string path_from_region_name (DataType type, std::string name, std::string identifier);
489 boost::shared_ptr<Region> XMLRegionFactory (const XMLNode&, bool full);
490 boost::shared_ptr<AudioRegion> XMLAudioRegionFactory (const XMLNode&, bool full);
491 boost::shared_ptr<MidiRegion> XMLMidiRegionFactory (const XMLNode&, bool full);
493 /* source management */
495 void import_audiofiles (ImportStatus&);
496 bool sample_rate_convert (ImportStatus&, std::string infile, std::string& outfile);
497 std::string build_tmp_convert_name (std::string file);
499 boost::shared_ptr<ExportHandler> get_export_handler ();
500 boost::shared_ptr<ExportStatus> get_export_status ();
502 int start_audio_export (nframes_t position, bool realtime);
504 PBD::Signal1<int,nframes_t> ProcessExport;
505 static PBD::Signal2<void,std::string, std::string> Exported;
507 void add_source (boost::shared_ptr<Source>);
508 void remove_source (boost::weak_ptr<Source>);
510 int cleanup_sources (CleanupReport&);
511 int cleanup_trash_sources (CleanupReport&);
513 int destroy_region (boost::shared_ptr<Region>);
514 int destroy_regions (std::list<boost::shared_ptr<Region> >);
516 int remove_last_capture ();
518 /** handlers should return -1 for "stop cleanup",
519 0 for "yes, delete this playlist",
520 1 for "no, don't delete this playlist".
522 static PBD::Signal1<int,boost::shared_ptr<Playlist> > AskAboutPlaylistDeletion;
524 /** handlers should return 0 for "ignore the rate mismatch",
525 !0 for "do not use this session"
527 static PBD::Signal2<int,nframes_t, nframes_t> AskAboutSampleRateMismatch;
529 /** handlers should return !0 for use pending state, 0 for ignore it.
531 static PBD::Signal0<int> AskAboutPendingState;
533 boost::shared_ptr<AudioFileSource> create_audio_source_for_session (size_t, std::string const &, uint32_t, bool);
535 boost::shared_ptr<MidiSource> create_midi_source_for_session (std::string const &);
537 boost::shared_ptr<Source> source_by_id (const PBD::ID&);
538 boost::shared_ptr<Source> source_by_path_and_channel (const Glib::ustring&, uint16_t);
540 void add_playlist (boost::shared_ptr<Playlist>, bool unused = false);
542 /* named selections */
544 boost::shared_ptr<NamedSelection> named_selection_by_name (std::string name);
545 void add_named_selection (boost::shared_ptr<NamedSelection>);
546 void remove_named_selection (boost::shared_ptr<NamedSelection>);
548 template<class T> void foreach_named_selection (T& obj, void (T::*func)(boost::shared_ptr<NamedSelection>));
549 PBD::Signal0<void> NamedSelectionAdded;
550 PBD::Signal0<void> NamedSelectionRemoved;
552 /* Curves and AutomationLists (TODO when they go away) */
553 void add_automation_list(AutomationList*);
557 float get_default_fade_length () const { return default_fade_msecs; }
558 float get_default_fade_steepness () const { return default_fade_steepness; }
559 void set_default_fade (float steepness, float msecs);
563 boost::shared_ptr<Auditioner> the_auditioner() { return auditioner; }
564 void audition_playlist ();
565 void audition_region (boost::shared_ptr<Region>);
566 void cancel_audition ();
567 bool is_auditioning () const;
569 PBD::Signal1<void,bool> AuditionActive;
571 /* flattening stuff */
573 boost::shared_ptr<Region> write_one_track (AudioTrack&, nframes_t start, nframes_t end,
574 bool overwrite, std::vector<boost::shared_ptr<Source> >&, InterThreadInfo& wot,
575 bool enable_processing = true);
576 int freeze_all (InterThreadInfo&);
578 /* session-wide solo/mute/rec-enable */
580 bool soloing() const { return _non_soloed_outs_muted; }
581 bool listening() const { return _listen_cnt > 0; }
582 bool solo_isolated() const { return _solo_isolated_cnt > 0; }
584 static const SessionEvent::RTeventCallback rt_cleanup;
586 void set_solo (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
587 void set_just_one_solo (boost::shared_ptr<Route>, bool, SessionEvent::RTeventCallback after = rt_cleanup);
588 void set_mute (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
589 void set_listen (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
590 void set_record_enable (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
591 void set_solo_isolated (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
593 PBD::Signal1<void,bool> SoloActive;
594 PBD::Signal0<void> SoloChanged;
595 PBD::Signal0<void> IsolatedChanged;
597 /* control/master out */
599 boost::shared_ptr<Route> monitor_out() const { return _monitor_out; }
600 boost::shared_ptr<Route> master_out() const { return _master_out; }
602 void globally_add_internal_sends (boost::shared_ptr<Route> dest, Placement p);
603 void globally_set_send_gains_from_track (boost::shared_ptr<Route> dest);
604 void globally_set_send_gains_to_zero (boost::shared_ptr<Route> dest);
605 void globally_set_send_gains_to_unity (boost::shared_ptr<Route> dest);
606 void add_internal_sends (boost::shared_ptr<Route> dest, Placement p, boost::shared_ptr<RouteList> senders);
608 static void set_disable_all_loaded_plugins (bool yn) {
609 _disable_all_loaded_plugins = yn;
611 static bool get_disable_all_loaded_plugins() {
612 return _disable_all_loaded_plugins;
615 uint32_t next_send_id();
616 uint32_t next_return_id();
617 uint32_t next_insert_id();
618 void mark_send_id (uint32_t);
619 void mark_return_id (uint32_t);
620 void mark_insert_id (uint32_t);
621 void unmark_send_id (uint32_t);
622 void unmark_return_id (uint32_t);
623 void unmark_insert_id (uint32_t);
625 /* s/w "RAID" management */
627 nframes_t available_capture_duration();
631 void add_bundle (boost::shared_ptr<Bundle>);
632 void remove_bundle (boost::shared_ptr<Bundle>);
633 boost::shared_ptr<Bundle> bundle_by_name (std::string) const;
635 PBD::Signal1<void,boost::shared_ptr<Bundle> > BundleAdded;
636 PBD::Signal1<void,boost::shared_ptr<Bundle> > BundleRemoved;
640 void midi_panic(void);
641 int set_mtc_port (std::string port_tag);
642 int set_mmc_port (std::string port_tag);
643 int set_midi_port (std::string port_tag);
644 int set_midi_clock_port (std::string port_tag);
645 MIDI::Port *mtc_port() const { return _mtc_port; }
646 MIDI::Port *mmc_port() const { return _mmc_port; }
647 MIDI::Port *midi_port() const { return _midi_port; }
648 MIDI::Port *midi_clock_port() const { return _midi_clock_port; }
650 PBD::Signal0<void> MTC_PortChanged;
651 PBD::Signal0<void> MMC_PortChanged;
652 PBD::Signal0<void> MIDI_PortChanged;
653 PBD::Signal0<void> MIDIClock_PortChanged;
655 void set_trace_midi_input (bool, MIDI::Port* port = 0);
656 void set_trace_midi_output (bool, MIDI::Port* port = 0);
658 bool get_trace_midi_input(MIDI::Port *port = 0);
659 bool get_trace_midi_output(MIDI::Port *port = 0);
661 void set_mmc_receive_device_id (uint32_t id);
662 void set_mmc_send_device_id (uint32_t id);
666 void start_scrub (nframes_t where);
668 void set_scrub_speed (float);
669 nframes_t scrub_buffer_size() const;
670 PBD::Signal0<void> ScrubReady;
672 /* History (for editors, mixers, UIs etc.) */
674 /** Undo some transactions.
675 * @param n Number of transactions to undo.
677 void undo (uint32_t n) {
681 void redo (uint32_t n) {
685 UndoHistory& history() { return _history; }
687 uint32_t undo_depth() const { return _history.undo_depth(); }
688 uint32_t redo_depth() const { return _history.redo_depth(); }
689 std::string next_undo() const { return _history.next_undo(); }
690 std::string next_redo() const { return _history.next_redo(); }
692 void begin_reversible_command (const std::string& cmd_name);
693 void commit_reversible_command (Command* cmd = 0);
695 UndoTransaction* start_reversible_command (const std::string& cmd_name);
696 void finish_reversible_command (UndoTransaction&);
698 void add_command (Command *const cmd) {
699 assert(!_current_trans.empty ());
700 _current_trans.top()->add_command (cmd);
703 std::map<PBD::ID,PBD::StatefulDestructible*> registry;
705 // these commands are implemented in libs/ardour/session_command.cc
706 Command* memento_command_factory(XMLNode* n);
707 Command* stateful_diff_command_factory (XMLNode *);
708 void register_with_memento_command_factory(PBD::ID, PBD::StatefulDestructible*);
712 boost::shared_ptr<IO> click_io() { return _click_io; }
714 /* disk, buffer loads */
716 uint32_t playback_load ();
717 uint32_t capture_load ();
721 void request_play_range (std::list<AudioRange>*, bool leave_rolling = false);
722 bool get_play_range () const { return _play_range; }
724 /* buffers for gain and pan */
726 gain_t* gain_automation_buffer () const;
727 pan_t** pan_automation_buffer () const;
729 void ensure_buffer_set (BufferSet& buffers, const ChanCount& howmany);
733 static long vst_callback (AEffect* effect,
740 static PBD::Signal0<void> SendFeedback;
744 boost::shared_ptr<PBD::Controllable> controllable_by_id (const PBD::ID&);
745 boost::shared_ptr<PBD::Controllable> controllable_by_descriptor (const PBD::ControllableDescriptor&);
747 void add_controllable (boost::shared_ptr<PBD::Controllable>);
748 void remove_controllable (PBD::Controllable*);
750 SessionMetadata & metadata () { return *_metadata; }
752 SessionConfiguration config;
754 bool exporting () const {
758 /* this is a private enum, but setup_enum_writer() needs it,
759 and i can't find a way to give that function
763 enum PostTransportWork {
764 PostTransportStop = 0x1,
765 PostTransportDisableRecord = 0x2,
766 PostTransportPosition = 0x8,
767 PostTransportDidRecord = 0x20,
768 PostTransportDuration = 0x40,
769 PostTransportLocate = 0x80,
770 PostTransportRoll = 0x200,
771 PostTransportAbort = 0x800,
772 PostTransportOverWrite = 0x1000,
773 PostTransportSpeed = 0x2000,
774 PostTransportAudition = 0x4000,
775 PostTransportScrub = 0x8000,
776 PostTransportReverse = 0x10000,
777 PostTransportInputChange = 0x20000,
778 PostTransportCurveRealloc = 0x40000,
779 PostTransportClearSubstate = 0x80000
788 SlaveState slave_state() const { return _slave_state; }
790 boost::shared_ptr<SessionPlaylists> playlists;
793 friend class AudioEngine;
794 void set_block_size (nframes_t nframes);
795 void set_frame_rate (nframes_t nframes);
799 void schedule_curve_reallocation ();
800 void update_latency_compensation (bool, bool);
803 int create (const std::string& mix_template, BusProfile*);
807 PendingDeclickIn = 0x1,
808 PendingDeclickOut = 0x2,
809 StopPendingCapture = 0x4,
810 AutoReturning = 0x10,
811 PendingLocate = 0x20,
812 PendingSetLoop = 0x40
815 /* stuff used in process() should be close together to
819 typedef void (Session::*process_function_type)(nframes_t);
821 AudioEngine& _engine;
822 mutable gint processing_prohibited;
823 process_function_type process_function;
824 process_function_type last_process_function;
825 bool waiting_for_sync_offset;
826 nframes_t _base_frame_rate;
827 nframes_t _current_frame_rate; //this includes video pullup offset
828 nframes_t _nominal_frame_rate; //ignores audioengine setting, "native" SR
829 int transport_sub_state;
830 mutable gint _record_status;
831 volatile nframes64_t _transport_frame;
832 Location* _session_range_location; ///< session range, or 0 if there is nothing in the session yet
836 // varispeed playback
837 volatile double _transport_speed;
838 double _last_transport_speed;
839 double _target_transport_speed;
840 CubicInterpolation interpolation;
842 bool auto_play_legal;
843 nframes64_t _last_slave_transport_frame;
844 nframes_t maximum_output_latency;
845 volatile nframes64_t _requested_return_frame;
846 nframes_t current_block_size;
847 nframes_t _worst_output_latency;
848 nframes_t _worst_input_latency;
849 nframes_t _worst_track_latency;
852 float _meter_falloff;
853 bool _non_soloed_outs_muted;
854 uint32_t _listen_cnt;
855 uint32_t _solo_isolated_cnt;
859 void set_worst_io_latencies ();
860 void set_worst_io_latencies_x (IOChange, void *) {
861 set_worst_io_latencies ();
864 void update_latency_compensation_proxy (void* ignored);
866 void ensure_buffers (ChanCount howmany = ChanCount::ZERO);
868 void process_scrub (nframes_t);
869 void process_without_events (nframes_t);
870 void process_with_events (nframes_t);
871 void process_audition (nframes_t);
872 void process_export (nframes_t);
873 int process_export_fw (nframes_t);
875 void block_processing() { g_atomic_int_set (&processing_prohibited, 1); }
876 void unblock_processing() { g_atomic_int_set (&processing_prohibited, 0); }
877 bool processing_blocked() const { return g_atomic_int_get (&processing_prohibited); }
879 Glib::Mutex process_thread_lock;
880 std::list<ProcessThread*> process_threads;
884 static const int delta_accumulator_size = 25;
885 int delta_accumulator_cnt;
886 long delta_accumulator[delta_accumulator_size];
887 long average_slave_delta;
889 bool have_first_delta_accumulator;
891 SlaveState _slave_state;
892 nframes_t slave_wait_end;
894 void reset_slave_state ();
895 bool follow_slave (nframes_t);
896 void calculate_moving_average_of_slave_delta(int dir, nframes_t this_delta);
897 void track_slave_state(float slave_speed, nframes_t slave_transport_frame, nframes_t this_delta);
898 void follow_slave_silently(nframes_t nframes, float slave_speed);
900 void switch_to_sync_source (SyncSource); /* !RT context */
901 void drop_sync_source (); /* !RT context */
902 void use_sync_source (Slave*); /* RT context */
904 bool post_export_sync;
905 nframes_t post_export_position;
908 bool _export_rolling;
910 boost::shared_ptr<ExportHandler> export_handler;
911 boost::shared_ptr<ExportStatus> export_status;
914 int stop_audio_export ();
915 void finalize_audio_export ();
917 PBD::ScopedConnection export_freewheel_connection;
919 void get_track_statistics ();
920 int process_routes (nframes_t, bool& need_butler);
921 int silent_process_routes (nframes_t, bool& need_butler);
923 bool get_rec_monitors_input () {
924 if (actively_recording()) {
927 if (config.get_auto_input()) {
935 int get_transport_declick_required () {
936 if (transport_sub_state & PendingDeclickIn) {
937 transport_sub_state &= ~PendingDeclickIn;
939 } else if (transport_sub_state & PendingDeclickOut) {
946 bool maybe_stop (nframes_t limit);
947 bool maybe_sync_start (nframes_t&);
949 void check_declick_out ();
951 MIDI::MachineControl* mmc;
952 MIDI::Port* _mmc_port;
953 MIDI::Port* _mtc_port;
954 MIDI::Port* _midi_port;
955 MIDI::Port* _midi_clock_port;
959 bool session_send_mmc;
960 bool session_send_mtc;
961 bool session_midi_feedback;
964 nframes_t last_loopend;
966 boost::scoped_ptr<SessionDirectory> _session_dir;
969 void when_engine_running ();
970 void graph_reordered ();
972 std::string _current_snapshot_name;
975 bool state_was_pending;
976 StateOfTheState _state_of_the_state;
979 int load_options (const XMLNode&);
980 int load_state (std::string snapshot_name);
982 nframes_t _last_roll_location;
983 nframes_t _last_roll_or_reversal_location;
984 nframes_t _last_record_location;
986 bool pending_locate_roll;
987 nframes_t pending_locate_frame;
988 bool pending_locate_flush;
990 bool pending_auto_loop;
994 #if 0 // these should be here, see comments in their other location above
995 enum PostTransportWork {
996 PostTransportStop = 0x1,
997 PostTransportDisableRecord = 0x2,
998 PostTransportPosition = 0x8,
999 PostTransportDidRecord = 0x20,
1000 PostTransportDuration = 0x40,
1001 PostTransportLocate = 0x80,
1002 PostTransportRoll = 0x200,
1003 PostTransportAbort = 0x800,
1004 PostTransportOverWrite = 0x1000,
1005 PostTransportSpeed = 0x2000,
1006 PostTransportAudition = 0x4000,
1007 PostTransportScrub = 0x8000,
1008 PostTransportReverse = 0x10000,
1009 PostTransportInputChange = 0x20000,
1010 PostTransportCurveRealloc = 0x40000,
1011 PostTransportClearSubstate = 0x80000
1014 static const PostTransportWork ProcessCannotProceedMask =
1016 PostTransportInputChange|
1018 PostTransportReverse|
1019 PostTransportCurveRealloc|
1021 PostTransportAudition|
1022 PostTransportLocate|
1024 PostTransportClearSubstate);
1026 gint _post_transport_work; /* accessed only atomic ops */
1027 PostTransportWork post_transport_work() const { return (PostTransportWork) g_atomic_int_get (&_post_transport_work); }
1028 void set_post_transport_work (PostTransportWork ptw) { g_atomic_int_set (&_post_transport_work, (gint) ptw); }
1029 void add_post_transport_work (PostTransportWork ptw);
1031 uint32_t cumulative_rf_motion;
1034 void set_rf_speed (float speed);
1035 void reset_rf_scale (nframes_t frames_moved);
1037 Locations _locations;
1038 void locations_changed ();
1039 void locations_added (Location*);
1040 void handle_locations_changed (Locations::LocationList&);
1042 PBD::ScopedConnectionList punch_connections;
1043 void auto_punch_start_changed (Location *);
1044 void auto_punch_end_changed (Location *);
1045 void auto_punch_changed (Location *);
1047 PBD::ScopedConnectionList loop_connections;
1048 void auto_loop_changed (Location *);
1050 void first_stage_init (std::string path, std::string snapshot_name);
1051 int second_stage_init ();
1052 void update_session_range_location_marker ();
1053 void remove_empty_sounds ();
1055 void setup_midi_control ();
1056 int midi_read (MIDI::Port *);
1058 void enable_record ();
1060 void increment_transport_position (uint32_t val) {
1061 if (max_frames - val < _transport_frame) {
1062 _transport_frame = max_frames;
1064 _transport_frame += val;
1068 void decrement_transport_position (uint32_t val) {
1069 if (val < _transport_frame) {
1070 _transport_frame -= val;
1072 _transport_frame = 0;
1076 void post_transport_motion ();
1077 static void *session_loader_thread (void *arg);
1081 /* SessionEventManager interface */
1083 void process_event (SessionEvent*);
1084 void set_next_event ();
1085 void cleanup_event (SessionEvent*,int);
1087 /* MIDI Machine Control */
1089 void deliver_mmc (MIDI::MachineControl::Command, nframes_t);
1091 void spp_start (MIDI::Parser&, nframes_t timestamp);
1092 void spp_continue (MIDI::Parser&, nframes_t timestamp);
1093 void spp_stop (MIDI::Parser&, nframes_t timestamp);
1095 void mmc_deferred_play (MIDI::MachineControl &);
1096 void mmc_stop (MIDI::MachineControl &);
1097 void mmc_step (MIDI::MachineControl &, int);
1098 void mmc_pause (MIDI::MachineControl &);
1099 void mmc_record_pause (MIDI::MachineControl &);
1100 void mmc_record_strobe (MIDI::MachineControl &);
1101 void mmc_record_exit (MIDI::MachineControl &);
1102 void mmc_track_record_status (MIDI::MachineControl &, uint32_t track, bool enabled);
1103 void mmc_fast_forward (MIDI::MachineControl &);
1104 void mmc_rewind (MIDI::MachineControl &);
1105 void mmc_locate (MIDI::MachineControl &, const MIDI::byte *);
1106 void mmc_shuttle (MIDI::MachineControl &mmc, float speed, bool forw);
1107 void mmc_record_enable (MIDI::MachineControl &mmc, size_t track, bool enabled);
1109 struct timeval last_mmc_step;
1112 typedef boost::function<bool()> MidiTimeoutCallback;
1113 typedef std::list<MidiTimeoutCallback> MidiTimeoutList;
1115 MidiTimeoutList midi_timeouts;
1116 bool mmc_step_timeout ();
1118 MIDI::byte mmc_buffer[32];
1119 MIDI::byte mtc_msg[16];
1120 MIDI::byte mtc_timecode_bits; /* encoding of SMTPE type for MTC */
1121 MIDI::byte midi_msg[16];
1122 nframes_t outbound_mtc_timecode_frame;
1123 Timecode::Time transmitting_timecode_time;
1124 int next_quarter_frame_to_send;
1126 double _frames_per_timecode_frame; /* has to be floating point because of drop frame */
1127 nframes_t _frames_per_hour;
1128 nframes_t _timecode_frames_per_hour;
1129 nframes_t _timecode_offset;
1130 bool _timecode_offset_negative;
1132 /* cache the most-recently requested time conversions. This helps when we
1133 * have multiple clocks showing the same time (e.g. the transport frame) */
1134 bool last_timecode_valid;
1135 nframes_t last_timecode_when;
1136 Timecode::Time last_timecode;
1138 bool _send_timecode_update; ///< Flag to send a full frame (Timecode) MTC message this cycle
1140 int send_full_time_code(nframes_t nframes);
1141 int send_midi_time_code_for_cycle(nframes_t nframes);
1143 nframes_t adjust_apparent_position (nframes_t frames);
1145 void reset_record_status ();
1147 int no_roll (nframes_t nframes);
1148 int fail_roll (nframes_t nframes);
1150 bool non_realtime_work_pending() const { return static_cast<bool>(post_transport_work()); }
1151 bool process_can_proceed() const { return !(post_transport_work() & ProcessCannotProceedMask); }
1153 MidiControlUI* midi_control_ui;
1155 int start_midi_thread ();
1156 void terminate_midi_thread ();
1158 int use_config_midi_ports ();
1160 void set_play_loop (bool yn);
1161 void unset_play_loop ();
1162 void overwrite_some_buffers (Track *);
1163 void flush_all_inserts ();
1164 int micro_locate (nframes_t distance);
1165 void locate (nframes64_t, bool with_roll, bool with_flush, bool with_loop=false, bool force=false);
1166 void start_locate (nframes64_t, bool with_roll, bool with_flush, bool with_loop=false, bool force=false);
1167 void force_locate (nframes64_t frame, bool with_roll = false);
1168 void set_track_speed (Track *, double speed);
1169 void set_transport_speed (double speed, bool abort = false, bool clear_state = false);
1170 void stop_transport (bool abort = false, bool clear_state = false);
1171 void start_transport ();
1172 void realtime_stop (bool abort, bool clear_state);
1173 void non_realtime_start_scrub ();
1174 void non_realtime_set_speed ();
1175 void non_realtime_locate ();
1176 void non_realtime_stop (bool abort, int entry_request_count, bool& finished);
1177 void non_realtime_overwrite (int entry_request_count, bool& finished);
1178 void post_transport ();
1179 void engine_halted ();
1180 void xrun_recovery ();
1182 TempoMap *_tempo_map;
1183 void tempo_map_changed (const PBD::PropertyChange&);
1185 /* edit/mix groups */
1187 int load_route_groups (const XMLNode&, int);
1189 std::list<RouteGroup *> _route_groups;
1193 boost::shared_ptr<Graph> route_graph;
1195 SerializedRCUManager<RouteList> routes;
1197 void add_routes (RouteList&, bool save);
1198 uint32_t destructive_index;
1200 boost::shared_ptr<Route> XMLRouteFactory (const XMLNode&, int);
1201 boost::shared_ptr<Route> XMLRouteFactory_2X (const XMLNode&, int);
1203 void route_processors_changed (RouteProcessorChange);
1205 bool find_route_name (const char* base, uint32_t& id, char* name, size_t name_len);
1206 void count_existing_route_channels (ChanCount& in, ChanCount& out);
1207 void auto_connect_route (boost::shared_ptr<Route> route,
1208 ChanCount& existing_inputs, ChanCount& existing_outputs);
1212 bool solo_update_disabled;
1214 void route_listen_changed (void *src, boost::weak_ptr<Route>);
1215 void route_mute_changed (void *src);
1216 void route_solo_changed (bool self_solo_change, void *src, boost::weak_ptr<Route>);
1217 void route_solo_isolated_changed (void *src, boost::weak_ptr<Route>);
1218 void update_route_solo_state (boost::shared_ptr<RouteList> r = boost::shared_ptr<RouteList>());
1220 void listen_position_changed ();
1221 void solo_control_mode_changed ();
1223 /* REGION MANAGEMENT */
1225 mutable Glib::Mutex region_lock;
1227 int load_regions (const XMLNode& node);
1229 void route_group_changed ();
1233 mutable Glib::Mutex source_lock;
1234 typedef std::map<PBD::ID,boost::shared_ptr<Source> > SourceMap;
1239 SourceMap get_sources() { return sources; }
1242 int load_sources (const XMLNode& node);
1243 XMLNode& get_sources_as_xml ();
1245 boost::shared_ptr<Source> XMLSourceFactory (const XMLNode&);
1249 void remove_playlist (boost::weak_ptr<Playlist>);
1250 void playlist_length_changed ();
1251 void track_playlist_changed (boost::weak_ptr<Track>);
1253 /* NAMED SELECTIONS */
1255 mutable Glib::Mutex named_selection_lock;
1256 typedef std::set<boost::shared_ptr<NamedSelection> > NamedSelectionList;
1257 NamedSelectionList named_selections;
1259 int load_named_selections (const XMLNode&);
1261 NamedSelection *named_selection_factory (std::string name);
1262 NamedSelection *XMLNamedSelectionFactory (const XMLNode&);
1264 /* CURVES and AUTOMATION LISTS */
1265 std::map<PBD::ID, AutomationList*> automation_lists;
1267 /* DEFAULT FADE CURVES */
1269 float default_fade_steepness;
1270 float default_fade_msecs;
1274 boost::shared_ptr<Auditioner> auditioner;
1275 void set_audition (boost::shared_ptr<Region>);
1276 void non_realtime_set_audition ();
1277 boost::shared_ptr<Region> pending_audition_region;
1283 int flatten_one_track (AudioTrack&, nframes_t start, nframes_t cnt);
1285 /* INSERT AND SEND MANAGEMENT */
1287 boost::dynamic_bitset<uint32_t> send_bitset;
1288 boost::dynamic_bitset<uint32_t> return_bitset;
1289 boost::dynamic_bitset<uint32_t> insert_bitset;
1293 struct space_and_path {
1294 uint32_t blocks; /* 4kB blocks */
1302 struct space_and_path_ascending_cmp {
1303 bool operator() (space_and_path a, space_and_path b) {
1304 return a.blocks > b.blocks;
1308 void setup_raid_path (std::string path);
1310 std::vector<space_and_path> session_dirs;
1311 std::vector<space_and_path>::iterator last_rr_session_dir;
1312 uint32_t _total_free_4k_blocks;
1313 Glib::Mutex space_lock;
1315 std::string get_best_session_directory_for_new_source ();
1317 mutable gint _playback_load;
1318 mutable gint _capture_load;
1322 SerializedRCUManager<BundleList> _bundles;
1323 XMLNode* _bundle_xml_node;
1324 int load_bundles (XMLNode const &);
1326 void reverse_track_buffers ();
1328 UndoHistory _history;
1329 std::stack<UndoTransaction*> _current_trans;
1331 void jack_timebase_callback (jack_transport_state_t, nframes_t, jack_position_t*, int);
1332 int jack_sync_callback (jack_transport_state_t, jack_position_t*);
1333 void reset_jack_connection (jack_client_t* jack);
1334 void process_rtop (SessionEvent*);
1336 XMLNode& state(bool);
1342 boost::shared_ptr<IO> _click_io;
1344 Sample* click_emphasis_data;
1345 nframes_t click_length;
1346 nframes_t click_emphasis_length;
1347 mutable Glib::RWLock click_lock;
1349 static const Sample default_click[];
1350 static const nframes_t default_click_length;
1351 static const Sample default_click_emphasis[];
1352 static const nframes_t default_click_emphasis_length;
1355 void setup_click_sounds (int which);
1356 void clear_clicks ();
1357 void click (nframes_t start, nframes_t nframes);
1359 std::vector<Route*> master_outs;
1361 /* range playback */
1363 std::list<AudioRange> current_audio_range;
1365 void set_play_range (std::list<AudioRange>&, bool leave_rolling);
1366 void unset_play_range ();
1371 boost::shared_ptr<Route> _master_out;
1372 boost::shared_ptr<Route> _monitor_out;
1376 long _vst_callback (VSTPlugin*,
1383 /* number of hardware ports we're using,
1384 based on max (requested,available)
1387 uint32_t n_physical_outputs;
1388 uint32_t n_physical_inputs;
1390 uint32_t n_physical_audio_outputs;
1391 uint32_t n_physical_audio_inputs;
1393 uint32_t n_physical_midi_outputs;
1394 uint32_t n_physical_midi_inputs;
1396 int find_all_sources (std::string path, std::set<std::string>& result);
1397 int find_all_sources_across_snapshots (std::set<std::string>& result, bool exclude_this_snapshot);
1399 typedef std::set<boost::shared_ptr<PBD::Controllable> > Controllables;
1400 Glib::Mutex controllables_lock;
1401 Controllables controllables;
1403 void reset_native_file_format();
1404 bool first_file_data_format_reset;
1405 bool first_file_header_format_reset;
1407 void config_changed (std::string, bool);
1409 XMLNode& get_control_protocol_state ();
1411 void set_history_depth (uint32_t depth);
1412 void sync_order_keys ();
1414 static bool _disable_all_loaded_plugins;
1416 SessionMetadata * _metadata;
1418 mutable bool have_looped; ///< Used in ::audible_frame(*)
1420 void update_have_rec_enabled_track ();
1421 gint _have_rec_enabled_track;
1423 static int ask_about_playlist_deletion (boost::shared_ptr<Playlist>);
1425 /* realtime "apply to set of routes" operations */
1426 SessionEvent* get_rt_event (boost::shared_ptr<RouteList> rl, bool yn, SessionEvent::RTeventCallback after, bool group_override,
1427 void (Session::*method) (boost::shared_ptr<RouteList>, bool, bool));
1429 void rt_set_solo (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1430 void rt_set_just_one_solo (boost::shared_ptr<RouteList>, bool yn, bool /* ignored*/ );
1431 void rt_set_mute (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1432 void rt_set_listen (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1433 void rt_set_solo_isolated (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1434 void rt_set_record_enable (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1436 /** temporary list of Diskstreams used only during load of 2.X sessions */
1437 std::list<boost::shared_ptr<Diskstream> > _diskstreams_2X;
1439 void add_session_range_location (nframes_t, nframes_t);
1442 } // namespace ARDOUR
1444 #endif /* __ardour_session_h__ */