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"
67 class ControllableDescriptor;
76 class AudioDiskstream;
78 class AudioFileSource;
88 class ControlProtocolInfo;
100 class NamedSelection;
112 class SessionDirectory;
113 class SessionMetadata;
114 class SessionPlaylists;
120 extern void setup_enum_writer ();
122 class Session : public PBD::StatefulDestructible, public PBD::ScopedConnectionList, public SessionEventManager
131 /* creating from an XML file */
133 Session (AudioEngine&,
134 const std::string& fullpath,
135 const std::string& snapshot_name,
136 std::string mix_template = "");
138 /* creating a new Session */
140 Session (AudioEngine&,
141 std::string fullpath,
142 std::string snapshot_name,
143 AutoConnectOption input_auto_connect,
144 AutoConnectOption output_auto_connect,
145 uint32_t control_out_channels,
146 uint32_t master_out_channels,
147 uint32_t n_physical_in,
148 uint32_t n_physical_out,
149 nframes_t initial_length);
153 std::string path() const { return _path; }
154 std::string name() const { return _name; }
155 std::string snap_name() const { return _current_snapshot_name; }
156 std::string raid_path () const;
157 bool path_is_within_session (const std::string&);
159 void set_snap_name ();
161 bool writable() const { return _writable; }
164 bool dirty() const { return _state_of_the_state & Dirty; }
165 void set_deletion_in_progress ();
166 void clear_deletion_in_progress ();
167 bool deletion_in_progress() const { return _state_of_the_state & Deletion; }
168 PBD::Signal0<void> DirtyChanged;
170 const SessionDirectory& session_directory () const { return *(_session_dir.get()); }
172 static PBD::Signal0<void> AutoBindingOn;
173 static PBD::Signal0<void> AutoBindingOff;
175 static PBD::Signal1<void,std::string> Dialog;
177 std::string sound_dir (bool with_path = true) const;
178 std::string peak_dir () const;
179 std::string dead_sound_dir () const;
180 std::string automation_dir () const;
181 std::string analysis_dir() const;
183 int ensure_subdirs ();
185 Glib::ustring peak_path (Glib::ustring) const;
187 static std::string change_source_path_by_name (std::string oldpath, std::string oldname, std::string newname, bool destructive);
189 std::string peak_path_from_audio_path (std::string) const;
190 std::string new_audio_source_name (const std::string&, uint32_t nchans, uint32_t chan, bool destructive);
191 std::string new_midi_source_name (const std::string&);
192 std::string new_source_path_from_name (DataType type, const std::string&);
193 RouteList new_route_from_template (uint32_t how_many, const std::string& template_path);
195 void process (nframes_t nframes);
197 BufferSet& get_silent_buffers (ChanCount count = ChanCount::ZERO);
198 BufferSet& get_scratch_buffers (ChanCount count = ChanCount::ZERO);
199 BufferSet& get_mix_buffers (ChanCount count = ChanCount::ZERO);
201 void add_diskstream (boost::shared_ptr<Diskstream>);
202 boost::shared_ptr<Diskstream> diskstream_by_id (const PBD::ID& id);
203 boost::shared_ptr<Diskstream> diskstream_by_name (std::string name);
204 bool have_rec_enabled_diskstream () const;
206 bool have_captured() const { return _have_captured; }
208 void refill_all_diskstream_buffers ();
209 Butler* butler() { return _butler; }
210 void butler_transport_work ();
212 uint32_t get_next_diskstream_id() const { return n_diskstreams(); }
213 uint32_t n_diskstreams() const;
215 void refresh_disk_space ();
217 typedef std::list<boost::shared_ptr<Diskstream> > DiskstreamList;
219 SerializedRCUManager<DiskstreamList>& diskstream_list() { return diskstreams; }
221 int load_routes (const XMLNode&, int);
222 boost::shared_ptr<RouteList> get_routes() const {
223 return routes.reader ();
226 boost::shared_ptr<RouteList> get_routes_with_internal_returns() const;
228 boost::shared_ptr<RouteList> get_routes_with_regions_at (nframes64_t const) const;
230 uint32_t nroutes() const { return routes.reader()->size(); }
231 uint32_t ntracks () const;
232 uint32_t nbusses () const;
234 boost::shared_ptr<BundleList> bundles () {
235 return _bundles.reader ();
238 struct RoutePublicOrderSorter {
239 bool operator() (boost::shared_ptr<Route>, boost::shared_ptr<Route> b);
242 void sync_order_keys (std::string const &);
244 template<class T> void foreach_route (T *obj, void (T::*func)(Route&));
245 template<class T> void foreach_route (T *obj, void (T::*func)(boost::shared_ptr<Route>));
246 template<class T, class A> void foreach_route (T *obj, void (T::*func)(Route&, A), A arg);
248 boost::shared_ptr<Route> route_by_name (std::string);
249 boost::shared_ptr<Route> route_by_id (PBD::ID);
250 boost::shared_ptr<Route> route_by_remote_id (uint32_t id);
252 bool route_name_unique (std::string) const;
253 bool route_name_internal (std::string) const;
255 bool get_record_enabled() const {
256 return (record_status () >= Enabled);
259 RecordState record_status() const {
260 return (RecordState) g_atomic_int_get (&_record_status);
263 bool actively_recording () {
264 return record_status() == Recording;
267 bool record_enabling_legal () const;
268 void maybe_enable_record ();
269 void disable_record (bool rt_context, bool force = false);
270 void step_back_from_record ();
272 void maybe_write_autosave ();
274 /* Proxy signal for region hidden changes */
276 PBD::Signal1<void,boost::shared_ptr<Region> > RegionHiddenChange;
278 /* Emitted when all i/o connections are complete */
280 PBD::Signal0<void> IOConnectionsComplete;
282 /* Record status signals */
284 PBD::Signal0<void> RecordStateChanged;
286 /* Transport mechanism signals */
288 PBD::Signal0<void> TransportStateChange; /* generic */
289 PBD::Signal1<void,nframes64_t> PositionChanged; /* sent after any non-sequential motion */
290 PBD::Signal0<void> DurationChanged;
291 PBD::Signal1<void,nframes64_t> Xrun;
292 PBD::Signal0<void> TransportLooped;
294 /** emitted when a locate has occurred */
295 PBD::Signal0<void> Located;
297 PBD::Signal1<void,RouteList&> RouteAdded;
298 PBD::Signal0<void> RouteGroupChanged;
300 void queue_event (SessionEvent*);
302 void request_roll_at_and_return (nframes_t start, nframes_t return_to);
303 void request_bounded_roll (nframes_t start, nframes_t end);
304 void request_stop (bool abort = false, bool clear_state = false);
305 void request_locate (nframes_t frame, bool with_roll = false);
307 void request_play_loop (bool yn, bool leave_rolling = false);
308 bool get_play_loop () const { return play_loop; }
310 nframes_t last_transport_start() const { return _last_roll_location; }
311 void goto_end () { request_locate (end_location->start(), false);}
312 void goto_start () { request_locate (start_location->start(), false); }
313 void set_session_start (nframes_t start) { start_location->set_start(start); }
314 void set_session_end (nframes_t end) { end_location->set_start(end); config.set_end_marker_is_free (false); }
315 void use_rf_shuttle_speed ();
316 void allow_auto_play (bool yn);
317 void request_transport_speed (double speed);
318 void request_overwrite_buffer (Diskstream*);
319 void request_diskstream_speed (Diskstream&, double speed);
320 void request_input_change_handling ();
322 bool locate_pending() const { return static_cast<bool>(post_transport_work()&PostTransportLocate); }
323 bool transport_locked () const;
327 int remove_region_from_region_list (boost::shared_ptr<Region>);
329 nframes_t get_maximum_extent () const;
330 nframes_t current_end_frame() const { return end_location->start(); }
331 nframes_t current_start_frame() const { return start_location->start(); }
332 /// "actual" sample rate of session, set by current audioengine rate, pullup/down etc.
333 nframes_t frame_rate() const { return _current_frame_rate; }
334 /// "native" sample rate of session, regardless of current audioengine rate, pullup/down etc
335 nframes_t nominal_frame_rate() const { return _nominal_frame_rate; }
336 nframes_t frames_per_hour() const { return _frames_per_hour; }
338 double frames_per_timecode_frame() const { return _frames_per_timecode_frame; }
339 nframes_t timecode_frames_per_hour() const { return _timecode_frames_per_hour; }
341 MIDI::byte get_mtc_timecode_bits() const {
342 return mtc_timecode_bits; /* encoding of SMTPE type for MTC */
345 float timecode_frames_per_second() const;
346 bool timecode_drop_frames() const;
350 Locations *locations() { return &_locations; }
352 PBD::Signal1<void,Location*> auto_loop_location_changed;
353 PBD::Signal1<void,Location*> auto_punch_location_changed;
354 PBD::Signal0<void> locations_modified;
356 void set_auto_punch_location (Location *);
357 void set_auto_loop_location (Location *);
358 int location_name(std::string& result, std::string base = std::string(""));
360 void reset_input_monitor_state ();
362 nframes_t get_block_size() const { return current_block_size; }
363 nframes_t worst_output_latency () const { return _worst_output_latency; }
364 nframes_t worst_input_latency () const { return _worst_input_latency; }
365 nframes_t worst_track_latency () const { return _worst_track_latency; }
367 int save_state (std::string snapshot_name, bool pending = false);
368 int restore_state (std::string snapshot_name);
369 int save_template (std::string template_name);
370 int save_history (std::string snapshot_name = "");
371 int restore_history (std::string snapshot_name);
372 void remove_state (std::string snapshot_name);
373 void rename_state (std::string old_name, std::string new_name);
374 void remove_pending_capture_state ();
376 static int rename_template (std::string old_name, std::string new_name);
377 static int delete_template (std::string name);
379 PBD::Signal1<void,std::string> StateSaved;
380 PBD::Signal0<void> StateReady;
382 std::vector<std::string*>* possible_states() const;
383 static std::vector<std::string*>* possible_states (std::string path);
385 XMLNode& get_state();
386 int set_state(const XMLNode& node, int version); // not idempotent
387 XMLNode& get_template();
389 /// The instant xml file is written to the session directory
390 void add_instant_xml (XMLNode&, bool write_to_config = true);
391 XMLNode* instant_xml (const std::string& str);
393 enum StateOfTheState {
398 InitialConnecting = 0x8,
403 StateOfTheState state_of_the_state() const { return _state_of_the_state; }
405 void add_route_group (RouteGroup *);
406 void remove_route_group (RouteGroup&);
408 RouteGroup *route_group_by_name (std::string);
410 PBD::Signal1<void,RouteGroup*> route_group_added;
411 PBD::Signal0<void> route_group_removed;
413 void foreach_route_group (boost::function<void(RouteGroup*)> f) {
414 for (std::list<RouteGroup *>::iterator i = _route_groups.begin(); i != _route_groups.end(); ++i) {
419 /* fundamental operations. duh. */
421 std::list<boost::shared_ptr<AudioTrack> > new_audio_track (
422 int input_channels, int output_channels, TrackMode mode = Normal, RouteGroup* route_group = 0, uint32_t how_many = 1
425 RouteList new_audio_route (bool aux, int input_channels, int output_channels, RouteGroup* route_group, uint32_t how_many);
427 std::list<boost::shared_ptr<MidiTrack> > new_midi_track (
428 TrackMode mode = Normal, RouteGroup* route_group = 0, uint32_t how_many = 1
431 void remove_route (boost::shared_ptr<Route>);
432 void resort_routes ();
433 void resort_routes_using (boost::shared_ptr<RouteList>);
435 void set_remote_control_ids();
437 AudioEngine & engine() { return _engine; }
438 AudioEngine const & engine () const { return _engine; }
445 nframes64_t transport_frame () const {return _transport_frame; }
446 nframes64_t audible_frame () const;
447 nframes64_t requested_return_frame() const { return _requested_return_frame; }
461 void sync_time_vars();
463 void bbt_time (nframes_t when, BBT_Time&);
464 void timecode_to_sample(Timecode::Time& timecode, nframes_t& sample, bool use_offset, bool use_subframes) const;
465 void sample_to_timecode(nframes_t sample, Timecode::Time& timecode, bool use_offset, bool use_subframes) const;
466 void timecode_time (Timecode::Time &);
467 void timecode_time (nframes_t when, Timecode::Time&);
468 void timecode_time_subframes (nframes_t when, Timecode::Time&);
470 void timecode_duration (nframes_t, Timecode::Time&) const;
471 void timecode_duration_string (char *, nframes_t) const;
473 void set_timecode_offset (nframes_t);
474 nframes_t timecode_offset () const { return _timecode_offset; }
475 void set_timecode_offset_negative (bool);
476 bool timecode_offset_negative () const { return _timecode_offset_negative; }
478 nframes_t convert_to_frames_at (nframes_t position, AnyTime const &);
480 static PBD::Signal0<void> StartTimeChanged;
481 static PBD::Signal0<void> EndTimeChanged;
482 static PBD::Signal0<void> TimecodeOffsetChanged;
484 std::vector<SyncSource> get_available_sync_options() const;
485 void request_sync_source (Slave*);
486 bool synced_to_jack() const { return config.get_external_sync() && config.get_sync_source() == JACK; }
488 double transport_speed() const { return _transport_speed; }
489 bool transport_stopped() const { return _transport_speed == 0.0f; }
490 bool transport_rolling() const { return _transport_speed != 0.0f; }
492 void set_silent (bool yn);
493 bool silent () { return _silent; }
495 int jack_slave_sync (nframes_t);
497 TempoMap& tempo_map() { return *_tempo_map; }
499 /// signals the current transport position in frames, bbt and timecode time (in that order)
500 PBD::Signal3<void,const nframes_t&, const BBT_Time&, const Timecode::Time&> tick;
504 void add_regions (std::vector<boost::shared_ptr<Region> >&);
506 PBD::Signal1<void,boost::weak_ptr<Region> > RegionAdded;
507 PBD::Signal1<void,std::vector<boost::weak_ptr<Region> >&> RegionsAdded;
508 PBD::Signal1<void,boost::weak_ptr<Region> > RegionRemoved;
510 int region_name (std::string& result, std::string base = std::string(""), bool newlevel = false);
511 std::string new_region_name (std::string);
512 std::string path_from_region_name (DataType type, std::string name, std::string identifier);
514 boost::shared_ptr<Region> find_whole_file_parent (boost::shared_ptr<Region const>);
516 boost::shared_ptr<Region> XMLRegionFactory (const XMLNode&, bool full);
517 boost::shared_ptr<AudioRegion> XMLAudioRegionFactory (const XMLNode&, bool full);
518 boost::shared_ptr<MidiRegion> XMLMidiRegionFactory (const XMLNode&, bool full);
520 template<class T> void foreach_region (T *obj, void (T::*func)(boost::shared_ptr<Region>));
522 /* source management */
524 void import_audiofiles (ImportStatus&);
525 bool sample_rate_convert (ImportStatus&, std::string infile, std::string& outfile);
526 std::string build_tmp_convert_name (std::string file);
528 boost::shared_ptr<ExportHandler> get_export_handler ();
529 boost::shared_ptr<ExportStatus> get_export_status ();
531 int start_audio_export (nframes_t position, bool realtime);
533 PBD::Signal1<int,nframes_t> ProcessExport;
534 static PBD::Signal2<void,std::string, std::string> Exported;
536 void add_source (boost::shared_ptr<Source>);
537 void remove_source (boost::weak_ptr<Source>);
539 int cleanup_sources (CleanupReport&);
540 int cleanup_trash_sources (CleanupReport&);
542 int destroy_region (boost::shared_ptr<Region>);
543 int destroy_regions (std::list<boost::shared_ptr<Region> >);
545 int remove_last_capture ();
547 /** handlers should return -1 for "stop cleanup",
548 0 for "yes, delete this playlist",
549 1 for "no, don't delete this playlist".
551 static PBD::Signal1<int,boost::shared_ptr<Playlist> > AskAboutPlaylistDeletion;
553 /** handlers should return 0 for "ignore the rate mismatch",
554 !0 for "do not use this session"
556 static PBD::Signal2<int,nframes_t, nframes_t> AskAboutSampleRateMismatch;
558 /** handlers should return !0 for use pending state, 0 for ignore it.
560 static PBD::Signal0<int> AskAboutPendingState;
562 boost::shared_ptr<AudioFileSource> create_audio_source_for_session (ARDOUR::AudioDiskstream&, uint32_t which_channel, bool destructive);
564 boost::shared_ptr<MidiSource> create_midi_source_for_session (ARDOUR::MidiDiskstream&);
566 boost::shared_ptr<Source> source_by_id (const PBD::ID&);
567 boost::shared_ptr<Source> source_by_path_and_channel (const Glib::ustring&, uint16_t);
569 void add_playlist (boost::shared_ptr<Playlist>, bool unused = false);
571 /* named selections */
573 boost::shared_ptr<NamedSelection> named_selection_by_name (std::string name);
574 void add_named_selection (boost::shared_ptr<NamedSelection>);
575 void remove_named_selection (boost::shared_ptr<NamedSelection>);
577 template<class T> void foreach_named_selection (T& obj, void (T::*func)(boost::shared_ptr<NamedSelection>));
578 PBD::Signal0<void> NamedSelectionAdded;
579 PBD::Signal0<void> NamedSelectionRemoved;
581 /* Curves and AutomationLists (TODO when they go away) */
582 void add_automation_list(AutomationList*);
586 float get_default_fade_length () const { return default_fade_msecs; }
587 float get_default_fade_steepness () const { return default_fade_steepness; }
588 void set_default_fade (float steepness, float msecs);
592 boost::shared_ptr<Auditioner> the_auditioner() { return auditioner; }
593 void audition_playlist ();
594 void audition_region (boost::shared_ptr<Region>);
595 void cancel_audition ();
596 bool is_auditioning () const;
598 PBD::Signal1<void,bool> AuditionActive;
600 /* flattening stuff */
602 boost::shared_ptr<Region> write_one_track (AudioTrack&, nframes_t start, nframes_t end,
603 bool overwrite, std::vector<boost::shared_ptr<Source> >&, InterThreadInfo& wot,
604 bool enable_processing = true);
605 int freeze (InterThreadInfo&);
607 /* session-wide solo/mute/rec-enable */
609 bool soloing() const { return _non_soloed_outs_muted; }
610 bool listening() const { return _listen_cnt > 0; }
612 static const SessionEvent::RTeventCallback rt_cleanup;
614 void set_solo (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
615 void set_just_one_solo (boost::shared_ptr<Route>, bool, SessionEvent::RTeventCallback after = rt_cleanup);
616 void set_mute (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
617 void set_listen (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
618 void set_record_enable (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
620 PBD::Signal1<void,bool> SoloActive;
621 PBD::Signal0<void> SoloChanged;
624 /* control/master out */
626 boost::shared_ptr<Route> control_out() const { return _control_out; }
627 boost::shared_ptr<Route> master_out() const { return _master_out; }
629 void globally_add_internal_sends (boost::shared_ptr<Route> dest, Placement p);
630 void globally_set_send_gains_from_track (boost::shared_ptr<Route> dest);
631 void globally_set_send_gains_to_zero (boost::shared_ptr<Route> dest);
632 void globally_set_send_gains_to_unity (boost::shared_ptr<Route> dest);
633 void add_internal_sends (boost::shared_ptr<Route> dest, Placement p, boost::shared_ptr<RouteList> senders);
635 static void set_disable_all_loaded_plugins (bool yn) {
636 _disable_all_loaded_plugins = yn;
638 static bool get_disable_all_loaded_plugins() {
639 return _disable_all_loaded_plugins;
642 uint32_t next_send_id();
643 uint32_t next_return_id();
644 uint32_t next_insert_id();
645 void mark_send_id (uint32_t);
646 void mark_return_id (uint32_t);
647 void mark_insert_id (uint32_t);
649 /* s/w "RAID" management */
651 nframes_t available_capture_duration();
655 void add_bundle (boost::shared_ptr<Bundle>);
656 void remove_bundle (boost::shared_ptr<Bundle>);
657 boost::shared_ptr<Bundle> bundle_by_name (std::string) const;
659 PBD::Signal1<void,boost::shared_ptr<Bundle> > BundleAdded;
660 PBD::Signal1<void,boost::shared_ptr<Bundle> > BundleRemoved;
664 void midi_panic(void);
665 int set_mtc_port (std::string port_tag);
666 int set_mmc_port (std::string port_tag);
667 int set_midi_port (std::string port_tag);
668 int set_midi_clock_port (std::string port_tag);
669 MIDI::Port *mtc_port() const { return _mtc_port; }
670 MIDI::Port *mmc_port() const { return _mmc_port; }
671 MIDI::Port *midi_port() const { return _midi_port; }
672 MIDI::Port *midi_clock_port() const { return _midi_clock_port; }
674 PBD::Signal0<void> MTC_PortChanged;
675 PBD::Signal0<void> MMC_PortChanged;
676 PBD::Signal0<void> MIDI_PortChanged;
677 PBD::Signal0<void> MIDIClock_PortChanged;
679 void set_trace_midi_input (bool, MIDI::Port* port = 0);
680 void set_trace_midi_output (bool, MIDI::Port* port = 0);
682 bool get_trace_midi_input(MIDI::Port *port = 0);
683 bool get_trace_midi_output(MIDI::Port *port = 0);
685 void set_mmc_receive_device_id (uint32_t id);
686 void set_mmc_send_device_id (uint32_t id);
690 void start_scrub (nframes_t where);
692 void set_scrub_speed (float);
693 nframes_t scrub_buffer_size() const;
694 PBD::Signal0<void> ScrubReady;
696 /* History (for editors, mixers, UIs etc.) */
698 /** Undo some transactions.
699 * @param n Number of transactions to undo.
701 void undo (uint32_t n) {
705 void redo (uint32_t n) {
709 UndoHistory& history() { return _history; }
711 uint32_t undo_depth() const { return _history.undo_depth(); }
712 uint32_t redo_depth() const { return _history.redo_depth(); }
713 std::string next_undo() const { return _history.next_undo(); }
714 std::string next_redo() const { return _history.next_redo(); }
716 void begin_reversible_command (const std::string& cmd_name);
717 void commit_reversible_command (Command* cmd = 0);
719 UndoTransaction* start_reversible_command (const std::string& cmd_name);
720 void finish_reversible_command (UndoTransaction&);
722 void add_command (Command *const cmd) {
723 assert(!_current_trans.empty ());
724 _current_trans.top()->add_command (cmd);
727 std::map<PBD::ID,PBD::StatefulDestructible*> registry;
729 // these commands are implemented in libs/ardour/session_command.cc
730 Command* memento_command_factory(XMLNode* n);
731 Command* stateful_diff_command_factory (XMLNode *);
732 void register_with_memento_command_factory(PBD::ID, PBD::StatefulDestructible*);
736 boost::shared_ptr<IO> click_io() { return _click_io; }
738 /* disk, buffer loads */
740 uint32_t playback_load ();
741 uint32_t capture_load ();
742 uint32_t playback_load_min ();
743 uint32_t capture_load_min ();
745 void reset_playback_load_min ();
746 void reset_capture_load_min ();
750 void request_play_range (std::list<AudioRange>*, bool leave_rolling = false);
751 bool get_play_range () const { return _play_range; }
753 /* buffers for gain and pan */
755 gain_t* gain_automation_buffer () const { return _gain_automation_buffer; }
756 pan_t** pan_automation_buffer () const { return _pan_automation_buffer; }
758 void ensure_buffer_set (BufferSet& buffers, const ChanCount& howmany);
762 static long vst_callback (AEffect* effect,
769 static PBD::Signal0<void> SendFeedback;
773 boost::shared_ptr<PBD::Controllable> controllable_by_id (const PBD::ID&);
774 boost::shared_ptr<PBD::Controllable> controllable_by_descriptor (const PBD::ControllableDescriptor&);
776 void add_controllable (boost::shared_ptr<PBD::Controllable>);
777 void remove_controllable (PBD::Controllable*);
779 SessionMetadata & metadata () { return *_metadata; }
781 SessionConfiguration config;
783 bool exporting () const {
787 /* this is a private enum, but setup_enum_writer() needs it,
788 and i can't find a way to give that function
792 enum PostTransportWork {
793 PostTransportStop = 0x1,
794 PostTransportDisableRecord = 0x2,
795 PostTransportPosition = 0x8,
796 PostTransportDidRecord = 0x20,
797 PostTransportDuration = 0x40,
798 PostTransportLocate = 0x80,
799 PostTransportRoll = 0x200,
800 PostTransportAbort = 0x800,
801 PostTransportOverWrite = 0x1000,
802 PostTransportSpeed = 0x2000,
803 PostTransportAudition = 0x4000,
804 PostTransportScrub = 0x8000,
805 PostTransportReverse = 0x10000,
806 PostTransportInputChange = 0x20000,
807 PostTransportCurveRealloc = 0x40000,
808 PostTransportClearSubstate = 0x80000
817 SlaveState slave_state() const { return _slave_state; }
819 boost::shared_ptr<SessionPlaylists> playlists;
822 friend class AudioEngine;
823 void set_block_size (nframes_t nframes);
824 void set_frame_rate (nframes_t nframes);
828 void schedule_curve_reallocation ();
829 void update_latency_compensation (bool, bool);
832 int create (bool& new_session, const std::string& mix_template, nframes_t initial_length);
835 nframes_t compute_initial_length ();
838 PendingDeclickIn = 0x1,
839 PendingDeclickOut = 0x2,
840 StopPendingCapture = 0x4,
841 AutoReturning = 0x10,
842 PendingLocate = 0x20,
843 PendingSetLoop = 0x40
846 /* stuff used in process() should be close together to
850 typedef void (Session::*process_function_type)(nframes_t);
852 AudioEngine& _engine;
853 mutable gint processing_prohibited;
854 process_function_type process_function;
855 process_function_type last_process_function;
856 bool waiting_for_sync_offset;
857 nframes_t _base_frame_rate;
858 nframes_t _current_frame_rate; //this includes video pullup offset
859 nframes_t _nominal_frame_rate; //ignores audioengine setting, "native" SR
860 int transport_sub_state;
861 mutable gint _record_status;
862 volatile nframes64_t _transport_frame;
863 Location* end_location;
864 Location* start_location;
868 // varispeed playback
869 volatile double _transport_speed;
870 double _last_transport_speed;
871 double _target_transport_speed;
872 CubicInterpolation interpolation;
874 bool auto_play_legal;
875 nframes64_t _last_slave_transport_frame;
876 nframes_t maximum_output_latency;
877 volatile nframes64_t _requested_return_frame;
878 BufferSet* _scratch_buffers;
879 BufferSet* _silent_buffers;
880 BufferSet* _mix_buffers;
881 nframes_t current_block_size;
882 nframes_t _worst_output_latency;
883 nframes_t _worst_input_latency;
884 nframes_t _worst_track_latency;
887 float _meter_falloff;
888 bool _non_soloed_outs_muted;
889 uint32_t _listen_cnt;
893 void set_worst_io_latencies ();
894 void set_worst_io_latencies_x (IOChange, void *) {
895 set_worst_io_latencies ();
898 void update_latency_compensation_proxy (void* ignored);
900 void ensure_buffers (ChanCount howmany);
902 void process_scrub (nframes_t);
903 void process_without_events (nframes_t);
904 void process_with_events (nframes_t);
905 void process_audition (nframes_t);
906 void process_export (nframes_t);
907 int process_export_fw (nframes_t);
909 void block_processing() { g_atomic_int_set (&processing_prohibited, 1); }
910 void unblock_processing() { g_atomic_int_set (&processing_prohibited, 0); }
911 bool processing_blocked() const { return g_atomic_int_get (&processing_prohibited); }
915 static const int delta_accumulator_size = 25;
916 int delta_accumulator_cnt;
917 long delta_accumulator[delta_accumulator_size];
918 long average_slave_delta;
920 bool have_first_delta_accumulator;
922 SlaveState _slave_state;
923 nframes_t slave_wait_end;
925 void reset_slave_state ();
926 bool follow_slave (nframes_t);
927 void calculate_moving_average_of_slave_delta(int dir, nframes_t this_delta);
928 void track_slave_state(float slave_speed, nframes_t slave_transport_frame, nframes_t this_delta);
929 void follow_slave_silently(nframes_t nframes, float slave_speed);
931 void switch_to_sync_source (SyncSource); /* !RT context */
932 void drop_sync_source (); /* !RT context */
933 void use_sync_source (Slave*); /* RT context */
935 bool post_export_sync;
936 nframes_t post_export_position;
939 bool _export_rolling;
941 boost::shared_ptr<ExportHandler> export_handler;
942 boost::shared_ptr<ExportStatus> export_status;
945 int stop_audio_export ();
946 void finalize_audio_export ();
948 PBD::ScopedConnection export_freewheel_connection;
950 void prepare_diskstreams ();
951 void commit_diskstreams (nframes_t, bool& session_requires_butler);
952 int process_routes (nframes_t);
953 int silent_process_routes (nframes_t);
955 bool get_rec_monitors_input () {
956 if (actively_recording()) {
959 if (config.get_auto_input()) {
967 int get_transport_declick_required () {
968 if (transport_sub_state & PendingDeclickIn) {
969 transport_sub_state &= ~PendingDeclickIn;
971 } else if (transport_sub_state & PendingDeclickOut) {
978 bool maybe_stop (nframes_t limit);
979 bool maybe_sync_start (nframes_t&);
981 void check_declick_out ();
983 MIDI::MachineControl* mmc;
984 MIDI::Port* _mmc_port;
985 MIDI::Port* _mtc_port;
986 MIDI::Port* _midi_port;
987 MIDI::Port* _midi_clock_port;
990 bool session_send_mmc;
991 bool session_send_mtc;
992 bool session_midi_feedback;
995 nframes_t last_loopend;
997 boost::scoped_ptr<SessionDirectory> _session_dir;
1000 void when_engine_running ();
1001 void graph_reordered ();
1003 std::string _current_snapshot_name;
1005 XMLTree* state_tree;
1006 bool state_was_pending;
1007 StateOfTheState _state_of_the_state;
1010 int load_options (const XMLNode&);
1011 int load_state (std::string snapshot_name);
1013 nframes_t _last_roll_location;
1014 nframes_t _last_record_location;
1016 bool pending_locate_roll;
1017 nframes_t pending_locate_frame;
1018 bool pending_locate_flush;
1020 bool pending_auto_loop;
1024 #if 0 // these should be here, see comments in their other location above
1025 enum PostTransportWork {
1026 PostTransportStop = 0x1,
1027 PostTransportDisableRecord = 0x2,
1028 PostTransportPosition = 0x8,
1029 PostTransportDidRecord = 0x20,
1030 PostTransportDuration = 0x40,
1031 PostTransportLocate = 0x80,
1032 PostTransportRoll = 0x200,
1033 PostTransportAbort = 0x800,
1034 PostTransportOverWrite = 0x1000,
1035 PostTransportSpeed = 0x2000,
1036 PostTransportAudition = 0x4000,
1037 PostTransportScrub = 0x8000,
1038 PostTransportReverse = 0x10000,
1039 PostTransportInputChange = 0x20000,
1040 PostTransportCurveRealloc = 0x40000,
1041 PostTransportClearSubstate = 0x80000
1044 static const PostTransportWork ProcessCannotProceedMask =
1046 PostTransportInputChange|
1048 PostTransportReverse|
1049 PostTransportCurveRealloc|
1051 PostTransportAudition|
1052 PostTransportLocate|
1054 PostTransportClearSubstate);
1056 gint _post_transport_work; /* accessed only atomic ops */
1057 PostTransportWork post_transport_work() const { return (PostTransportWork) g_atomic_int_get (&_post_transport_work); }
1058 void set_post_transport_work (PostTransportWork ptw) { g_atomic_int_set (&_post_transport_work, (gint) ptw); }
1059 void add_post_transport_work (PostTransportWork ptw);
1061 uint32_t cumulative_rf_motion;
1064 void set_rf_speed (float speed);
1065 void reset_rf_scale (nframes_t frames_moved);
1067 Locations _locations;
1068 void locations_changed ();
1069 void locations_added (Location*);
1070 void handle_locations_changed (Locations::LocationList&);
1072 PBD::ScopedConnectionList punch_connections;
1073 void auto_punch_start_changed (Location *);
1074 void auto_punch_end_changed (Location *);
1075 void auto_punch_changed (Location *);
1077 PBD::ScopedConnectionList loop_connections;
1078 void auto_loop_changed (Location *);
1080 void first_stage_init (std::string path, std::string snapshot_name);
1081 int second_stage_init (bool new_tracks);
1082 void find_current_end ();
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 (uint32_t val) {
1091 if (max_frames - val < _transport_frame) {
1092 _transport_frame = max_frames;
1094 _transport_frame += val;
1098 void decrement_transport_position (uint32_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 deliver_mmc (MIDI::MachineControl::Command, nframes_t);
1121 void spp_start (MIDI::Parser&, nframes_t timestamp);
1122 void spp_continue (MIDI::Parser&, nframes_t timestamp);
1123 void spp_stop (MIDI::Parser&, nframes_t timestamp);
1125 void mmc_deferred_play (MIDI::MachineControl &);
1126 void mmc_stop (MIDI::MachineControl &);
1127 void mmc_step (MIDI::MachineControl &, int);
1128 void mmc_pause (MIDI::MachineControl &);
1129 void mmc_record_pause (MIDI::MachineControl &);
1130 void mmc_record_strobe (MIDI::MachineControl &);
1131 void mmc_record_exit (MIDI::MachineControl &);
1132 void mmc_track_record_status (MIDI::MachineControl &, uint32_t track, bool enabled);
1133 void mmc_fast_forward (MIDI::MachineControl &);
1134 void mmc_rewind (MIDI::MachineControl &);
1135 void mmc_locate (MIDI::MachineControl &, const MIDI::byte *);
1136 void mmc_shuttle (MIDI::MachineControl &mmc, float speed, bool forw);
1137 void mmc_record_enable (MIDI::MachineControl &mmc, size_t track, bool enabled);
1139 struct timeval last_mmc_step;
1142 typedef boost::function<bool()> MidiTimeoutCallback;
1143 typedef std::list<MidiTimeoutCallback> MidiTimeoutList;
1145 MidiTimeoutList midi_timeouts;
1146 bool mmc_step_timeout ();
1148 MIDI::byte mmc_buffer[32];
1149 MIDI::byte mtc_msg[16];
1150 MIDI::byte mtc_timecode_bits; /* encoding of SMTPE type for MTC */
1151 MIDI::byte midi_msg[16];
1152 nframes_t outbound_mtc_timecode_frame;
1153 Timecode::Time transmitting_timecode_time;
1154 int next_quarter_frame_to_send;
1156 double _frames_per_timecode_frame; /* has to be floating point because of drop frame */
1157 nframes_t _frames_per_hour;
1158 nframes_t _timecode_frames_per_hour;
1159 nframes_t _timecode_offset;
1160 bool _timecode_offset_negative;
1162 /* cache the most-recently requested time conversions. This helps when we
1163 * have multiple clocks showing the same time (e.g. the transport frame) */
1164 bool last_timecode_valid;
1165 nframes_t last_timecode_when;
1166 Timecode::Time last_timecode;
1168 bool _send_timecode_update; ///< Flag to send a full frame (Timecode) MTC message this cycle
1170 int send_full_time_code(nframes_t nframes);
1171 int send_midi_time_code_for_cycle(nframes_t nframes);
1173 nframes_t adjust_apparent_position (nframes_t frames);
1175 void reset_record_status ();
1177 int no_roll (nframes_t nframes);
1178 int fail_roll (nframes_t nframes);
1180 bool non_realtime_work_pending() const { return static_cast<bool>(post_transport_work()); }
1181 bool process_can_proceed() const { return !(post_transport_work() & ProcessCannotProceedMask); }
1183 MidiControlUI* midi_control_ui;
1185 int start_midi_thread ();
1186 void terminate_midi_thread ();
1188 int use_config_midi_ports ();
1190 void set_play_loop (bool yn);
1191 void unset_play_loop ();
1192 void overwrite_some_buffers (Diskstream*);
1193 void flush_all_inserts ();
1194 int micro_locate (nframes_t distance);
1195 void locate (nframes64_t, bool with_roll, bool with_flush, bool with_loop=false, bool force=false);
1196 void start_locate (nframes64_t, bool with_roll, bool with_flush, bool with_loop=false, bool force=false);
1197 void force_locate (nframes64_t frame, bool with_roll = false);
1198 void set_diskstream_speed (Diskstream*, double speed);
1199 void set_transport_speed (double speed, bool abort = false, bool clear_state = false);
1200 void stop_transport (bool abort = false, bool clear_state = false);
1201 void start_transport ();
1202 void realtime_stop (bool abort, bool clear_state);
1203 void non_realtime_start_scrub ();
1204 void non_realtime_set_speed ();
1205 void non_realtime_locate ();
1206 void non_realtime_stop (bool abort, int entry_request_count, bool& finished);
1207 void non_realtime_overwrite (int entry_request_count, bool& finished);
1208 void post_transport ();
1209 void engine_halted ();
1210 void xrun_recovery ();
1212 TempoMap *_tempo_map;
1213 void tempo_map_changed (const PBD::PropertyChange&);
1215 /* edit/mix groups */
1217 int load_route_groups (const XMLNode&, int);
1219 std::list<RouteGroup *> _route_groups;
1223 SerializedRCUManager<DiskstreamList> diskstreams;
1225 int load_diskstreams (const XMLNode&);
1229 SerializedRCUManager<RouteList> routes;
1231 void add_routes (RouteList&, bool save);
1232 uint32_t destructive_index;
1234 boost::shared_ptr<Route> XMLRouteFactory (const XMLNode&, int);
1236 void route_processors_changed (RouteProcessorChange);
1240 bool solo_update_disabled;
1242 void route_listen_changed (void *src, boost::weak_ptr<Route>);
1243 void route_mute_changed (void *src);
1244 void route_solo_changed (void *src, boost::weak_ptr<Route>);
1245 void update_route_solo_state (boost::shared_ptr<RouteList> r = boost::shared_ptr<RouteList>());
1247 void listen_position_changed ();
1248 void solo_control_mode_changed ();
1250 /* REGION MANAGEMENT */
1252 std::map<std::string,uint32_t> region_name_map;
1253 void update_region_name_map (boost::shared_ptr<Region>);
1255 mutable Glib::Mutex region_lock;
1256 typedef std::map<PBD::ID,boost::shared_ptr<Region> > RegionList;
1259 void add_region (boost::shared_ptr<Region>);
1260 void region_changed (const PBD::PropertyChange&, boost::weak_ptr<Region>);
1261 void remove_region (boost::weak_ptr<Region>);
1263 int load_regions (const XMLNode& node);
1265 void route_group_changed ();
1269 mutable Glib::Mutex source_lock;
1270 typedef std::map<PBD::ID,boost::shared_ptr<Source> > SourceMap;
1275 SourceMap get_sources() { return sources; }
1278 int load_sources (const XMLNode& node);
1279 XMLNode& get_sources_as_xml ();
1281 boost::shared_ptr<Source> XMLSourceFactory (const XMLNode&);
1285 void remove_playlist (boost::weak_ptr<Playlist>);
1286 void playlist_length_changed ();
1287 void diskstream_playlist_changed (boost::weak_ptr<Diskstream>);
1289 /* NAMED SELECTIONS */
1291 mutable Glib::Mutex named_selection_lock;
1292 typedef std::set<boost::shared_ptr<NamedSelection> > NamedSelectionList;
1293 NamedSelectionList named_selections;
1295 int load_named_selections (const XMLNode&);
1297 NamedSelection *named_selection_factory (std::string name);
1298 NamedSelection *XMLNamedSelectionFactory (const XMLNode&);
1300 /* CURVES and AUTOMATION LISTS */
1301 std::map<PBD::ID, AutomationList*> automation_lists;
1303 /* DEFAULT FADE CURVES */
1305 float default_fade_steepness;
1306 float default_fade_msecs;
1310 boost::shared_ptr<Auditioner> auditioner;
1311 void set_audition (boost::shared_ptr<Region>);
1312 void non_realtime_set_audition ();
1313 boost::shared_ptr<Region> pending_audition_region;
1319 int flatten_one_track (AudioTrack&, nframes_t start, nframes_t cnt);
1321 /* INSERT AND SEND MANAGEMENT */
1323 boost::dynamic_bitset<uint32_t> send_bitset;
1324 boost::dynamic_bitset<uint32_t> return_bitset;
1325 boost::dynamic_bitset<uint32_t> insert_bitset;
1327 void add_processor (Processor *);
1328 void remove_processor (Processor *);
1332 struct space_and_path {
1333 uint32_t blocks; /* 4kB blocks */
1341 struct space_and_path_ascending_cmp {
1342 bool operator() (space_and_path a, space_and_path b) {
1343 return a.blocks > b.blocks;
1347 void setup_raid_path (std::string path);
1349 std::vector<space_and_path> session_dirs;
1350 std::vector<space_and_path>::iterator last_rr_session_dir;
1351 uint32_t _total_free_4k_blocks;
1352 Glib::Mutex space_lock;
1354 std::string get_best_session_directory_for_new_source ();
1356 mutable gint _playback_load;
1357 mutable gint _capture_load;
1358 mutable gint _playback_load_min;
1359 mutable gint _capture_load_min;
1363 SerializedRCUManager<BundleList> _bundles;
1364 XMLNode* _bundle_xml_node;
1365 int load_bundles (XMLNode const &);
1367 void reverse_diskstream_buffers ();
1369 UndoHistory _history;
1370 std::stack<UndoTransaction*> _current_trans;
1372 void jack_timebase_callback (jack_transport_state_t, nframes_t, jack_position_t*, int);
1373 int jack_sync_callback (jack_transport_state_t, jack_position_t*);
1374 void reset_jack_connection (jack_client_t* jack);
1375 void process_rtop (SessionEvent*);
1377 XMLNode& state(bool);
1383 boost::shared_ptr<IO> _click_io;
1385 Sample* click_emphasis_data;
1386 nframes_t click_length;
1387 nframes_t click_emphasis_length;
1388 mutable Glib::RWLock click_lock;
1390 static const Sample default_click[];
1391 static const nframes_t default_click_length;
1392 static const Sample default_click_emphasis[];
1393 static const nframes_t default_click_emphasis_length;
1396 void setup_click_sounds (int which);
1397 void clear_clicks ();
1398 void click (nframes_t start, nframes_t nframes);
1400 std::vector<Route*> master_outs;
1402 /* range playback */
1404 std::list<AudioRange> current_audio_range;
1406 void set_play_range (std::list<AudioRange>&, bool leave_rolling);
1407 void unset_play_range ();
1412 boost::shared_ptr<Route> _master_out;
1413 boost::shared_ptr<Route> _control_out;
1415 gain_t* _gain_automation_buffer;
1416 pan_t** _pan_automation_buffer;
1417 void allocate_pan_automation_buffers (nframes_t nframes, uint32_t howmany, bool force);
1418 uint32_t _npan_buffers;
1422 long _vst_callback (VSTPlugin*,
1429 /* number of hardware ports we're using,
1430 based on max (requested,available)
1433 uint32_t n_physical_outputs;
1434 uint32_t n_physical_inputs;
1436 uint32_t n_physical_audio_outputs;
1437 uint32_t n_physical_audio_inputs;
1439 uint32_t n_physical_midi_outputs;
1440 uint32_t n_physical_midi_inputs;
1442 int find_all_sources (std::string path, std::set<std::string>& result);
1443 int find_all_sources_across_snapshots (std::set<std::string>& result, bool exclude_this_snapshot);
1445 typedef std::set<boost::shared_ptr<PBD::Controllable> > Controllables;
1446 Glib::Mutex controllables_lock;
1447 Controllables controllables;
1449 void reset_native_file_format();
1450 bool first_file_data_format_reset;
1451 bool first_file_header_format_reset;
1453 void config_changed (std::string, bool);
1455 XMLNode& get_control_protocol_state ();
1457 void set_history_depth (uint32_t depth);
1458 void sync_order_keys ();
1460 static bool _disable_all_loaded_plugins;
1462 SessionMetadata * _metadata;
1464 mutable bool have_looped; ///< Used in ::audible_frame(*)
1466 void update_have_rec_enabled_diskstream ();
1467 gint _have_rec_enabled_diskstream;
1469 static int ask_about_playlist_deletion (boost::shared_ptr<Playlist>);
1471 /* realtime "apply to set of routes" operations */
1472 SessionEvent* get_rt_event (boost::shared_ptr<RouteList> rl, bool yn, SessionEvent::RTeventCallback after, bool group_override,
1473 void (Session::*method) (boost::shared_ptr<RouteList>, bool, bool));
1475 void rt_set_solo (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1476 void rt_set_just_one_solo (boost::shared_ptr<RouteList>, bool yn, bool /* ignored*/ );
1477 void rt_set_mute (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1478 void rt_set_listen (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1479 void rt_set_record_enable (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1482 } // namespace ARDOUR
1484 #endif /* __ardour_session_h__ */