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"
75 class AudioDiskstream;
77 class AudioFileSource;
87 class ControlProtocolInfo;
111 class SessionDirectory;
112 class SessionMetadata;
113 class SessionPlaylists;
119 extern void setup_enum_writer ();
121 class Session : public PBD::StatefulDestructible, public PBD::ScopedConnectionList, public SessionEventManager
130 /* creating from an XML file */
132 Session (AudioEngine&,
133 const std::string& fullpath,
134 const std::string& snapshot_name,
135 std::string mix_template = "");
137 /* creating a new Session */
139 Session (AudioEngine&,
140 std::string fullpath,
141 std::string snapshot_name,
142 AutoConnectOption input_auto_connect,
143 AutoConnectOption output_auto_connect,
144 uint32_t control_out_channels,
145 uint32_t master_out_channels,
146 uint32_t n_physical_in,
147 uint32_t n_physical_out,
148 nframes_t initial_length);
152 std::string path() const { return _path; }
153 std::string name() const { return _name; }
154 std::string snap_name() const { return _current_snapshot_name; }
155 std::string raid_path () const;
156 bool path_is_within_session (const std::string&);
158 void set_snap_name ();
160 bool writable() const { return _writable; }
163 bool dirty() const { return _state_of_the_state & Dirty; }
164 void set_deletion_in_progress ();
165 void clear_deletion_in_progress ();
166 bool deletion_in_progress() const { return _state_of_the_state & Deletion; }
167 PBD::Signal0<void> DirtyChanged;
169 const SessionDirectory& session_directory () const { return *(_session_dir.get()); }
171 static PBD::Signal0<void> AutoBindingOn;
172 static PBD::Signal0<void> AutoBindingOff;
174 static PBD::Signal1<void,std::string> Dialog;
176 std::string sound_dir (bool with_path = true) const;
177 std::string peak_dir () const;
178 std::string dead_sound_dir () const;
179 std::string automation_dir () const;
180 std::string analysis_dir() const;
182 int ensure_subdirs ();
184 Glib::ustring peak_path (Glib::ustring) const;
186 static std::string change_source_path_by_name (std::string oldpath, std::string oldname, std::string newname, bool destructive);
188 std::string peak_path_from_audio_path (std::string) const;
189 std::string new_audio_source_name (const std::string&, uint32_t nchans, uint32_t chan, bool destructive);
190 std::string new_midi_source_name (const std::string&);
191 std::string new_source_path_from_name (DataType type, const std::string&);
192 RouteList new_route_from_template (uint32_t how_many, const std::string& template_path);
194 void process (nframes_t nframes);
196 BufferSet& get_silent_buffers (ChanCount count = ChanCount::ZERO);
197 BufferSet& get_scratch_buffers (ChanCount count = ChanCount::ZERO);
198 BufferSet& get_mix_buffers (ChanCount count = ChanCount::ZERO);
200 void add_diskstream (boost::shared_ptr<Diskstream>);
201 boost::shared_ptr<Diskstream> diskstream_by_id (const PBD::ID& id);
202 boost::shared_ptr<Diskstream> diskstream_by_name (std::string name);
203 bool have_rec_enabled_diskstream () const;
205 bool have_captured() const { return _have_captured; }
207 void refill_all_diskstream_buffers ();
208 Butler* butler() { return _butler; }
209 void butler_transport_work ();
211 uint32_t get_next_diskstream_id() const { return n_diskstreams(); }
212 uint32_t n_diskstreams() const;
214 void refresh_disk_space ();
216 typedef std::list<boost::shared_ptr<Diskstream> > DiskstreamList;
218 SerializedRCUManager<DiskstreamList>& diskstream_list() { return diskstreams; }
220 int load_routes (const XMLNode&, int);
221 boost::shared_ptr<RouteList> get_routes() const {
222 return routes.reader ();
225 boost::shared_ptr<RouteList> get_routes_with_internal_returns() const;
227 boost::shared_ptr<RouteList> get_routes_with_regions_at (nframes64_t const) const;
229 uint32_t nroutes() const { return routes.reader()->size(); }
230 uint32_t ntracks () const;
231 uint32_t nbusses () const;
233 boost::shared_ptr<BundleList> bundles () {
234 return _bundles.reader ();
237 struct RoutePublicOrderSorter {
238 bool operator() (boost::shared_ptr<Route>, boost::shared_ptr<Route> b);
241 void sync_order_keys (std::string const &);
243 template<class T> void foreach_route (T *obj, void (T::*func)(Route&));
244 template<class T> void foreach_route (T *obj, void (T::*func)(boost::shared_ptr<Route>));
245 template<class T, class A> void foreach_route (T *obj, void (T::*func)(Route&, A), A arg);
247 boost::shared_ptr<Route> route_by_name (std::string);
248 boost::shared_ptr<Route> route_by_id (PBD::ID);
249 boost::shared_ptr<Route> route_by_remote_id (uint32_t id);
251 bool route_name_unique (std::string) const;
252 bool route_name_internal (std::string) const;
254 bool get_record_enabled() const {
255 return (record_status () >= Enabled);
258 RecordState record_status() const {
259 return (RecordState) g_atomic_int_get (&_record_status);
262 bool actively_recording () {
263 return record_status() == Recording;
266 bool record_enabling_legal () const;
267 void maybe_enable_record ();
268 void disable_record (bool rt_context, bool force = false);
269 void step_back_from_record ();
271 void maybe_write_autosave ();
273 /* Proxy signal for region hidden changes */
275 PBD::Signal1<void,boost::shared_ptr<Region> > RegionHiddenChange;
277 /* Emitted when all i/o connections are complete */
279 PBD::Signal0<void> IOConnectionsComplete;
281 /* Record status signals */
283 PBD::Signal0<void> RecordStateChanged;
285 /* Transport mechanism signals */
287 PBD::Signal0<void> TransportStateChange; /* generic */
288 PBD::Signal1<void,nframes64_t> PositionChanged; /* sent after any non-sequential motion */
289 PBD::Signal0<void> DurationChanged;
290 PBD::Signal1<void,nframes64_t> Xrun;
291 PBD::Signal0<void> TransportLooped;
293 /** emitted when a locate has occurred */
294 PBD::Signal0<void> Located;
296 PBD::Signal1<void,RouteList&> RouteAdded;
297 PBD::Signal0<void> RouteGroupChanged;
299 void queue_event (SessionEvent*);
301 void request_roll_at_and_return (nframes_t start, nframes_t return_to);
302 void request_bounded_roll (nframes_t start, nframes_t end);
303 void request_stop (bool abort = false, bool clear_state = false);
304 void request_locate (nframes_t frame, bool with_roll = false);
306 void request_play_loop (bool yn, bool leave_rolling = false);
307 bool get_play_loop () const { return play_loop; }
309 nframes_t last_transport_start() const { return _last_roll_location; }
310 void goto_end () { request_locate (end_location->start(), false);}
311 void goto_start () { request_locate (start_location->start(), false); }
312 void set_session_start (nframes_t start) { start_location->set_start(start); }
313 void set_session_end (nframes_t end) { end_location->set_start(end); config.set_end_marker_is_free (false); }
314 void use_rf_shuttle_speed ();
315 void allow_auto_play (bool yn);
316 void request_transport_speed (double speed);
317 void request_overwrite_buffer (Diskstream*);
318 void request_diskstream_speed (Diskstream&, double speed);
319 void request_input_change_handling ();
321 bool locate_pending() const { return static_cast<bool>(post_transport_work()&PostTransportLocate); }
322 bool transport_locked () const;
326 int remove_region_from_region_list (boost::shared_ptr<Region>);
328 nframes_t get_maximum_extent () const;
329 nframes_t current_end_frame() const { return end_location->start(); }
330 nframes_t current_start_frame() const { return start_location->start(); }
331 /// "actual" sample rate of session, set by current audioengine rate, pullup/down etc.
332 nframes_t frame_rate() const { return _current_frame_rate; }
333 /// "native" sample rate of session, regardless of current audioengine rate, pullup/down etc
334 nframes_t nominal_frame_rate() const { return _nominal_frame_rate; }
335 nframes_t frames_per_hour() const { return _frames_per_hour; }
337 double frames_per_timecode_frame() const { return _frames_per_timecode_frame; }
338 nframes_t timecode_frames_per_hour() const { return _timecode_frames_per_hour; }
340 MIDI::byte get_mtc_timecode_bits() const {
341 return mtc_timecode_bits; /* encoding of SMTPE type for MTC */
344 float timecode_frames_per_second() const;
345 bool timecode_drop_frames() const;
349 Locations *locations() { return &_locations; }
351 PBD::Signal1<void,Location*> auto_loop_location_changed;
352 PBD::Signal1<void,Location*> auto_punch_location_changed;
353 PBD::Signal0<void> locations_modified;
355 void set_auto_punch_location (Location *);
356 void set_auto_loop_location (Location *);
357 int location_name(std::string& result, std::string base = std::string(""));
359 void reset_input_monitor_state ();
361 nframes_t get_block_size() const { return current_block_size; }
362 nframes_t worst_output_latency () const { return _worst_output_latency; }
363 nframes_t worst_input_latency () const { return _worst_input_latency; }
364 nframes_t worst_track_latency () const { return _worst_track_latency; }
366 int save_state (std::string snapshot_name, bool pending = false);
367 int restore_state (std::string snapshot_name);
368 int save_template (std::string template_name);
369 int save_history (std::string snapshot_name = "");
370 int restore_history (std::string snapshot_name);
371 void remove_state (std::string snapshot_name);
372 void rename_state (std::string old_name, std::string new_name);
373 void remove_pending_capture_state ();
375 static int rename_template (std::string old_name, std::string new_name);
376 static int delete_template (std::string name);
378 PBD::Signal1<void,std::string> StateSaved;
379 PBD::Signal0<void> StateReady;
381 std::vector<std::string*>* possible_states() const;
382 static std::vector<std::string*>* possible_states (std::string path);
384 XMLNode& get_state();
385 int set_state(const XMLNode& node, int version); // not idempotent
386 XMLNode& get_template();
388 /// The instant xml file is written to the session directory
389 void add_instant_xml (XMLNode&, bool write_to_config = true);
390 XMLNode* instant_xml (const std::string& str);
392 enum StateOfTheState {
397 InitialConnecting = 0x8,
402 StateOfTheState state_of_the_state() const { return _state_of_the_state; }
404 void add_route_group (RouteGroup *);
405 void remove_route_group (RouteGroup&);
407 RouteGroup *route_group_by_name (std::string);
409 PBD::Signal1<void,RouteGroup*> route_group_added;
410 PBD::Signal0<void> route_group_removed;
412 void foreach_route_group (boost::function<void(RouteGroup*)> f) {
413 for (std::list<RouteGroup *>::iterator i = _route_groups.begin(); i != _route_groups.end(); i++) {
418 /* fundamental operations. duh. */
420 std::list<boost::shared_ptr<AudioTrack> > new_audio_track (
421 int input_channels, int output_channels, TrackMode mode = Normal, RouteGroup* route_group = 0, uint32_t how_many = 1
424 RouteList new_audio_route (bool aux, int input_channels, int output_channels, RouteGroup* route_group, uint32_t how_many);
426 std::list<boost::shared_ptr<MidiTrack> > new_midi_track (
427 TrackMode mode = Normal, RouteGroup* route_group = 0, uint32_t how_many = 1
430 void remove_route (boost::shared_ptr<Route>);
431 void resort_routes ();
432 void resort_routes_using (boost::shared_ptr<RouteList>);
434 void set_remote_control_ids();
436 AudioEngine & engine() { return _engine; }
437 AudioEngine const & engine () const { return _engine; }
444 nframes64_t transport_frame () const {return _transport_frame; }
445 nframes64_t audible_frame () const;
446 nframes64_t requested_return_frame() const { return _requested_return_frame; }
460 void sync_time_vars();
462 void bbt_time (nframes_t when, BBT_Time&);
463 void timecode_to_sample(Timecode::Time& timecode, nframes_t& sample, bool use_offset, bool use_subframes) const;
464 void sample_to_timecode(nframes_t sample, Timecode::Time& timecode, bool use_offset, bool use_subframes) const;
465 void timecode_time (Timecode::Time &);
466 void timecode_time (nframes_t when, Timecode::Time&);
467 void timecode_time_subframes (nframes_t when, Timecode::Time&);
469 void timecode_duration (nframes_t, Timecode::Time&) const;
470 void timecode_duration_string (char *, nframes_t) const;
472 void set_timecode_offset (nframes_t);
473 nframes_t timecode_offset () const { return _timecode_offset; }
474 void set_timecode_offset_negative (bool);
475 bool timecode_offset_negative () const { return _timecode_offset_negative; }
477 nframes_t convert_to_frames_at (nframes_t position, AnyTime const &);
479 static PBD::Signal0<void> StartTimeChanged;
480 static PBD::Signal0<void> EndTimeChanged;
481 static PBD::Signal0<void> TimecodeOffsetChanged;
483 std::vector<SyncSource> get_available_sync_options() const;
484 void request_sync_source (Slave*);
485 bool synced_to_jack() const { return config.get_external_sync() && config.get_sync_source() == JACK; }
487 double transport_speed() const { return _transport_speed; }
488 bool transport_stopped() const { return _transport_speed == 0.0f; }
489 bool transport_rolling() const { return _transport_speed != 0.0f; }
491 void set_silent (bool yn);
492 bool silent () { return _silent; }
494 int jack_slave_sync (nframes_t);
496 TempoMap& tempo_map() { return *_tempo_map; }
498 /// signals the current transport position in frames, bbt and timecode time (in that order)
499 PBD::Signal3<void,const nframes_t&, const BBT_Time&, const Timecode::Time&> tick;
503 void add_regions (std::vector<boost::shared_ptr<Region> >&);
505 PBD::Signal1<void,boost::weak_ptr<Region> > RegionAdded;
506 PBD::Signal1<void,std::vector<boost::weak_ptr<Region> >&> RegionsAdded;
507 PBD::Signal1<void,boost::weak_ptr<Region> > RegionRemoved;
509 int region_name (std::string& result, std::string base = std::string(""), bool newlevel = false);
510 std::string new_region_name (std::string);
511 std::string path_from_region_name (DataType type, std::string name, std::string identifier);
513 boost::shared_ptr<Region> find_whole_file_parent (boost::shared_ptr<Region const>);
515 boost::shared_ptr<Region> XMLRegionFactory (const XMLNode&, bool full);
516 boost::shared_ptr<AudioRegion> XMLAudioRegionFactory (const XMLNode&, bool full);
517 boost::shared_ptr<MidiRegion> XMLMidiRegionFactory (const XMLNode&, bool full);
519 template<class T> void foreach_region (T *obj, void (T::*func)(boost::shared_ptr<Region>));
521 /* source management */
523 void import_audiofiles (ImportStatus&);
524 bool sample_rate_convert (ImportStatus&, std::string infile, std::string& outfile);
525 std::string build_tmp_convert_name (std::string file);
527 boost::shared_ptr<ExportHandler> get_export_handler ();
528 boost::shared_ptr<ExportStatus> get_export_status ();
530 int start_audio_export (nframes_t position, bool realtime);
532 PBD::Signal1<int,nframes_t> ProcessExport;
533 PBD::Signal0<void> ExportReadFinished;
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 PBD::Signal1<void,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 NamedSelection* named_selection_by_name (std::string name);
574 void add_named_selection (NamedSelection *);
575 void remove_named_selection (NamedSelection *);
577 template<class T> void foreach_named_selection (T& obj, void (T::*func)(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 void register_with_memento_command_factory(PBD::ID, PBD::StatefulDestructible*);
735 boost::shared_ptr<IO> click_io() { return _click_io; }
737 /* disk, buffer loads */
739 uint32_t playback_load ();
740 uint32_t capture_load ();
741 uint32_t playback_load_min ();
742 uint32_t capture_load_min ();
744 void reset_playback_load_min ();
745 void reset_capture_load_min ();
749 void request_play_range (std::list<AudioRange>*, bool leave_rolling = false);
750 bool get_play_range () const { return _play_range; }
752 /* buffers for gain and pan */
754 gain_t* gain_automation_buffer () const { return _gain_automation_buffer; }
755 pan_t** pan_automation_buffer () const { return _pan_automation_buffer; }
757 void ensure_buffer_set (BufferSet& buffers, const ChanCount& howmany);
761 static long vst_callback (AEffect* effect,
768 static PBD::Signal0<void> SendFeedback;
772 boost::shared_ptr<PBD::Controllable> controllable_by_id (const PBD::ID&);
774 void add_controllable (boost::shared_ptr<PBD::Controllable>);
775 void remove_controllable (PBD::Controllable*);
777 SessionMetadata & metadata () { return *_metadata; }
779 SessionConfiguration config;
781 bool exporting () const {
785 /* this is a private enum, but setup_enum_writer() needs it,
786 and i can't find a way to give that function
790 enum PostTransportWork {
791 PostTransportStop = 0x1,
792 PostTransportDisableRecord = 0x2,
793 PostTransportPosition = 0x8,
794 PostTransportDidRecord = 0x20,
795 PostTransportDuration = 0x40,
796 PostTransportLocate = 0x80,
797 PostTransportRoll = 0x200,
798 PostTransportAbort = 0x800,
799 PostTransportOverWrite = 0x1000,
800 PostTransportSpeed = 0x2000,
801 PostTransportAudition = 0x4000,
802 PostTransportScrub = 0x8000,
803 PostTransportReverse = 0x10000,
804 PostTransportInputChange = 0x20000,
805 PostTransportCurveRealloc = 0x40000,
806 PostTransportClearSubstate = 0x80000
815 SlaveState slave_state() const { return _slave_state; }
817 boost::shared_ptr<SessionPlaylists> playlists;
820 friend class AudioEngine;
821 void set_block_size (nframes_t nframes);
822 void set_frame_rate (nframes_t nframes);
826 void schedule_curve_reallocation ();
827 void update_latency_compensation (bool, bool);
830 int create (bool& new_session, const std::string& mix_template, nframes_t initial_length);
833 nframes_t compute_initial_length ();
836 PendingDeclickIn = 0x1,
837 PendingDeclickOut = 0x2,
838 StopPendingCapture = 0x4,
839 AutoReturning = 0x10,
840 PendingLocate = 0x20,
841 PendingSetLoop = 0x40
844 /* stuff used in process() should be close together to
848 typedef void (Session::*process_function_type)(nframes_t);
850 AudioEngine& _engine;
851 mutable gint processing_prohibited;
852 process_function_type process_function;
853 process_function_type last_process_function;
854 bool waiting_for_sync_offset;
855 nframes_t _base_frame_rate;
856 nframes_t _current_frame_rate; //this includes video pullup offset
857 nframes_t _nominal_frame_rate; //ignores audioengine setting, "native" SR
858 int transport_sub_state;
859 mutable gint _record_status;
860 volatile nframes64_t _transport_frame;
861 Location* end_location;
862 Location* start_location;
866 // varispeed playback
867 volatile double _transport_speed;
868 double _last_transport_speed;
869 double _target_transport_speed;
870 CubicInterpolation interpolation;
872 bool auto_play_legal;
873 nframes64_t _last_slave_transport_frame;
874 nframes_t maximum_output_latency;
875 volatile nframes64_t _requested_return_frame;
876 BufferSet* _scratch_buffers;
877 BufferSet* _silent_buffers;
878 BufferSet* _mix_buffers;
879 nframes_t current_block_size;
880 nframes_t _worst_output_latency;
881 nframes_t _worst_input_latency;
882 nframes_t _worst_track_latency;
885 float _meter_falloff;
886 bool _non_soloed_outs_muted;
887 uint32_t _listen_cnt;
891 void set_worst_io_latencies ();
892 void set_worst_io_latencies_x (IOChange, void *) {
893 set_worst_io_latencies ();
896 void update_latency_compensation_proxy (void* ignored);
898 void ensure_buffers (ChanCount howmany);
900 void process_scrub (nframes_t);
901 void process_without_events (nframes_t);
902 void process_with_events (nframes_t);
903 void process_audition (nframes_t);
904 void process_export (nframes_t);
905 int process_export_fw (nframes_t);
907 void block_processing() { g_atomic_int_set (&processing_prohibited, 1); }
908 void unblock_processing() { g_atomic_int_set (&processing_prohibited, 0); }
909 bool processing_blocked() const { return g_atomic_int_get (&processing_prohibited); }
913 static const int delta_accumulator_size = 25;
914 int delta_accumulator_cnt;
915 long delta_accumulator[delta_accumulator_size];
916 long average_slave_delta;
918 bool have_first_delta_accumulator;
920 SlaveState _slave_state;
921 nframes_t slave_wait_end;
923 void reset_slave_state ();
924 bool follow_slave (nframes_t);
925 void calculate_moving_average_of_slave_delta(int dir, nframes_t this_delta);
926 void track_slave_state(float slave_speed, nframes_t slave_transport_frame, nframes_t this_delta);
927 void follow_slave_silently(nframes_t nframes, float slave_speed);
929 void switch_to_sync_source (SyncSource); /* !RT context */
930 void drop_sync_source (); /* !RT context */
931 void use_sync_source (Slave*); /* RT context */
933 bool post_export_sync;
934 nframes_t post_export_position;
937 bool _exporting_realtime;
939 boost::shared_ptr<ExportHandler> export_handler;
940 boost::shared_ptr<ExportStatus> export_status;
943 int stop_audio_export ();
944 void finalize_audio_export ();
946 PBD::ScopedConnection export_freewheel_connection;
948 void prepare_diskstreams ();
949 void commit_diskstreams (nframes_t, bool& session_requires_butler);
950 int process_routes (nframes_t);
951 int silent_process_routes (nframes_t);
953 bool get_rec_monitors_input () {
954 if (actively_recording()) {
957 if (config.get_auto_input()) {
965 int get_transport_declick_required () {
966 if (transport_sub_state & PendingDeclickIn) {
967 transport_sub_state &= ~PendingDeclickIn;
969 } else if (transport_sub_state & PendingDeclickOut) {
976 bool maybe_stop (nframes_t limit);
977 bool maybe_sync_start (nframes_t&);
979 void check_declick_out ();
981 MIDI::MachineControl* mmc;
982 MIDI::Port* _mmc_port;
983 MIDI::Port* _mtc_port;
984 MIDI::Port* _midi_port;
985 MIDI::Port* _midi_clock_port;
988 bool session_send_mmc;
989 bool session_send_mtc;
990 bool session_midi_feedback;
993 nframes_t last_loopend;
995 boost::scoped_ptr<SessionDirectory> _session_dir;
998 void when_engine_running ();
999 void graph_reordered ();
1001 std::string _current_snapshot_name;
1003 XMLTree* state_tree;
1004 bool state_was_pending;
1005 StateOfTheState _state_of_the_state;
1008 int load_options (const XMLNode&);
1009 int load_state (std::string snapshot_name);
1011 nframes_t _last_roll_location;
1012 nframes_t _last_record_location;
1014 bool pending_locate_roll;
1015 nframes_t pending_locate_frame;
1016 bool pending_locate_flush;
1018 bool pending_auto_loop;
1022 #if 0 // these should be here, see comments in their other location above
1023 enum PostTransportWork {
1024 PostTransportStop = 0x1,
1025 PostTransportDisableRecord = 0x2,
1026 PostTransportPosition = 0x8,
1027 PostTransportDidRecord = 0x20,
1028 PostTransportDuration = 0x40,
1029 PostTransportLocate = 0x80,
1030 PostTransportRoll = 0x200,
1031 PostTransportAbort = 0x800,
1032 PostTransportOverWrite = 0x1000,
1033 PostTransportSpeed = 0x2000,
1034 PostTransportAudition = 0x4000,
1035 PostTransportScrub = 0x8000,
1036 PostTransportReverse = 0x10000,
1037 PostTransportInputChange = 0x20000,
1038 PostTransportCurveRealloc = 0x40000,
1039 PostTransportClearSubstate = 0x80000
1042 static const PostTransportWork ProcessCannotProceedMask =
1044 PostTransportInputChange|
1046 PostTransportReverse|
1047 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 uint32_t cumulative_rf_motion;
1062 void set_rf_speed (float speed);
1063 void reset_rf_scale (nframes_t frames_moved);
1065 Locations _locations;
1066 void locations_changed ();
1067 void locations_added (Location*);
1068 void handle_locations_changed (Locations::LocationList&);
1070 PBD::ScopedConnectionList punch_connections;
1071 void auto_punch_start_changed (Location *);
1072 void auto_punch_end_changed (Location *);
1073 void auto_punch_changed (Location *);
1075 PBD::ScopedConnectionList loop_connections;
1076 void auto_loop_changed (Location *);
1078 void first_stage_init (std::string path, std::string snapshot_name);
1079 int second_stage_init (bool new_tracks);
1080 void find_current_end ();
1081 void remove_empty_sounds ();
1083 void setup_midi_control ();
1084 int midi_read (MIDI::Port *);
1086 void enable_record ();
1088 void increment_transport_position (uint32_t val) {
1089 if (max_frames - val < _transport_frame) {
1090 _transport_frame = max_frames;
1092 _transport_frame += val;
1096 void decrement_transport_position (uint32_t val) {
1097 if (val < _transport_frame) {
1098 _transport_frame -= val;
1100 _transport_frame = 0;
1104 void post_transport_motion ();
1105 static void *session_loader_thread (void *arg);
1109 /* SessionEventManager interface */
1111 void process_event (SessionEvent*);
1112 void set_next_event ();
1113 void cleanup_event (SessionEvent*,int);
1115 /* MIDI Machine Control */
1117 void deliver_mmc (MIDI::MachineControl::Command, nframes_t);
1119 void spp_start (MIDI::Parser&, nframes_t timestamp);
1120 void spp_continue (MIDI::Parser&, nframes_t timestamp);
1121 void spp_stop (MIDI::Parser&, nframes_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 mmc_buffer[32];
1147 MIDI::byte mtc_msg[16];
1148 MIDI::byte mtc_timecode_bits; /* encoding of SMTPE type for MTC */
1149 MIDI::byte midi_msg[16];
1150 nframes_t outbound_mtc_timecode_frame;
1151 Timecode::Time transmitting_timecode_time;
1152 int next_quarter_frame_to_send;
1154 double _frames_per_timecode_frame; /* has to be floating point because of drop frame */
1155 nframes_t _frames_per_hour;
1156 nframes_t _timecode_frames_per_hour;
1157 nframes_t _timecode_offset;
1158 bool _timecode_offset_negative;
1160 /* cache the most-recently requested time conversions. This helps when we
1161 * have multiple clocks showing the same time (e.g. the transport frame) */
1162 bool last_timecode_valid;
1163 nframes_t last_timecode_when;
1164 Timecode::Time last_timecode;
1166 bool _send_timecode_update; ///< Flag to send a full frame (Timecode) MTC message this cycle
1168 int send_full_time_code(nframes_t nframes);
1169 int send_midi_time_code_for_cycle(nframes_t nframes);
1171 nframes_t adjust_apparent_position (nframes_t frames);
1173 void reset_record_status ();
1175 int no_roll (nframes_t nframes);
1176 int fail_roll (nframes_t nframes);
1178 bool non_realtime_work_pending() const { return static_cast<bool>(post_transport_work()); }
1179 bool process_can_proceed() const { return !(post_transport_work() & ProcessCannotProceedMask); }
1181 MidiControlUI* midi_control_ui;
1183 int start_midi_thread ();
1184 void terminate_midi_thread ();
1186 int use_config_midi_ports ();
1188 void set_play_loop (bool yn);
1189 void unset_play_loop ();
1190 void overwrite_some_buffers (Diskstream*);
1191 void flush_all_inserts ();
1192 int micro_locate (nframes_t distance);
1193 void locate (nframes64_t, bool with_roll, bool with_flush, bool with_loop=false, bool force=false);
1194 void start_locate (nframes64_t, bool with_roll, bool with_flush, bool with_loop=false, bool force=false);
1195 void force_locate (nframes64_t frame, bool with_roll = false);
1196 void set_diskstream_speed (Diskstream*, double speed);
1197 void set_transport_speed (double speed, bool abort = false, bool clear_state = false);
1198 void stop_transport (bool abort = false, bool clear_state = false);
1199 void start_transport ();
1200 void realtime_stop (bool abort, bool clear_state);
1201 void non_realtime_start_scrub ();
1202 void non_realtime_set_speed ();
1203 void non_realtime_locate ();
1204 void non_realtime_stop (bool abort, int entry_request_count, bool& finished);
1205 void non_realtime_overwrite (int entry_request_count, bool& finished);
1206 void post_transport ();
1207 void engine_halted ();
1208 void xrun_recovery ();
1210 TempoMap *_tempo_map;
1211 void tempo_map_changed (Change);
1213 /* edit/mix groups */
1215 int load_route_groups (const XMLNode&, int);
1217 std::list<RouteGroup *> _route_groups;
1221 SerializedRCUManager<DiskstreamList> diskstreams;
1223 int load_diskstreams (const XMLNode&);
1227 SerializedRCUManager<RouteList> routes;
1229 void add_routes (RouteList&, bool save);
1230 uint32_t destructive_index;
1232 boost::shared_ptr<Route> XMLRouteFactory (const XMLNode&, int);
1234 void route_processors_changed (RouteProcessorChange);
1238 bool solo_update_disabled;
1240 void route_listen_changed (void *src, boost::weak_ptr<Route>);
1241 void route_mute_changed (void *src);
1242 void route_solo_changed (void *src, boost::weak_ptr<Route>);
1243 void update_route_solo_state (boost::shared_ptr<RouteList> r = boost::shared_ptr<RouteList>());
1245 void listen_position_changed ();
1246 void solo_control_mode_changed ();
1248 /* REGION MANAGEMENT */
1250 std::map<std::string,uint32_t> region_name_map;
1251 void update_region_name_map (boost::shared_ptr<Region>);
1253 mutable Glib::Mutex region_lock;
1254 typedef std::map<PBD::ID,boost::shared_ptr<Region> > RegionList;
1257 void add_region (boost::shared_ptr<Region>);
1258 void region_changed (Change, boost::weak_ptr<Region>);
1259 void remove_region (boost::weak_ptr<Region>);
1261 int load_regions (const XMLNode& node);
1263 void route_group_changed ();
1267 mutable Glib::Mutex source_lock;
1268 typedef std::map<PBD::ID,boost::shared_ptr<Source> > SourceMap;
1273 SourceMap get_sources() { return sources; }
1276 int load_sources (const XMLNode& node);
1277 XMLNode& get_sources_as_xml ();
1279 boost::shared_ptr<Source> XMLSourceFactory (const XMLNode&);
1283 void remove_playlist (boost::weak_ptr<Playlist>);
1284 void playlist_length_changed ();
1285 void diskstream_playlist_changed (boost::weak_ptr<Diskstream>);
1287 /* NAMED SELECTIONS */
1289 mutable Glib::Mutex named_selection_lock;
1290 typedef std::set<NamedSelection *> NamedSelectionList;
1291 NamedSelectionList named_selections;
1293 int load_named_selections (const XMLNode&);
1295 NamedSelection *named_selection_factory (std::string name);
1296 NamedSelection *XMLNamedSelectionFactory (const XMLNode&);
1298 /* CURVES and AUTOMATION LISTS */
1299 std::map<PBD::ID, AutomationList*> automation_lists;
1301 /* DEFAULT FADE CURVES */
1303 float default_fade_steepness;
1304 float default_fade_msecs;
1308 boost::shared_ptr<Auditioner> auditioner;
1309 void set_audition (boost::shared_ptr<Region>);
1310 void non_realtime_set_audition ();
1311 boost::shared_ptr<Region> pending_audition_region;
1317 int flatten_one_track (AudioTrack&, nframes_t start, nframes_t cnt);
1319 /* INSERT AND SEND MANAGEMENT */
1321 boost::dynamic_bitset<uint32_t> send_bitset;
1322 boost::dynamic_bitset<uint32_t> return_bitset;
1323 boost::dynamic_bitset<uint32_t> insert_bitset;
1325 void add_processor (Processor *);
1326 void remove_processor (Processor *);
1330 struct space_and_path {
1331 uint32_t blocks; /* 4kB blocks */
1339 struct space_and_path_ascending_cmp {
1340 bool operator() (space_and_path a, space_and_path b) {
1341 return a.blocks > b.blocks;
1345 void setup_raid_path (std::string path);
1347 std::vector<space_and_path> session_dirs;
1348 std::vector<space_and_path>::iterator last_rr_session_dir;
1349 uint32_t _total_free_4k_blocks;
1350 Glib::Mutex space_lock;
1352 std::string get_best_session_directory_for_new_source ();
1354 mutable gint _playback_load;
1355 mutable gint _capture_load;
1356 mutable gint _playback_load_min;
1357 mutable gint _capture_load_min;
1361 SerializedRCUManager<BundleList> _bundles;
1362 XMLNode* _bundle_xml_node;
1363 int load_bundles (XMLNode const &);
1365 void reverse_diskstream_buffers ();
1367 UndoHistory _history;
1368 std::stack<UndoTransaction*> _current_trans;
1370 void jack_timebase_callback (jack_transport_state_t, nframes_t, jack_position_t*, int);
1371 int jack_sync_callback (jack_transport_state_t, jack_position_t*);
1372 void reset_jack_connection (jack_client_t* jack);
1373 void process_rtop (SessionEvent*);
1375 XMLNode& state(bool);
1381 boost::shared_ptr<IO> _click_io;
1383 Sample* click_emphasis_data;
1384 nframes_t click_length;
1385 nframes_t click_emphasis_length;
1386 mutable Glib::RWLock click_lock;
1388 static const Sample default_click[];
1389 static const nframes_t default_click_length;
1390 static const Sample default_click_emphasis[];
1391 static const nframes_t default_click_emphasis_length;
1394 void setup_click_sounds (int which);
1395 void clear_clicks ();
1396 void click (nframes_t start, nframes_t nframes);
1398 std::vector<Route*> master_outs;
1400 /* range playback */
1402 std::list<AudioRange> current_audio_range;
1404 void set_play_range (std::list<AudioRange>&, bool leave_rolling);
1405 void unset_play_range ();
1410 boost::shared_ptr<Route> _master_out;
1411 boost::shared_ptr<Route> _control_out;
1413 gain_t* _gain_automation_buffer;
1414 pan_t** _pan_automation_buffer;
1415 void allocate_pan_automation_buffers (nframes_t nframes, uint32_t howmany, bool force);
1416 uint32_t _npan_buffers;
1420 long _vst_callback (VSTPlugin*,
1427 /* number of hardware ports we're using,
1428 based on max (requested,available)
1431 uint32_t n_physical_outputs;
1432 uint32_t n_physical_inputs;
1434 uint32_t n_physical_audio_outputs;
1435 uint32_t n_physical_audio_inputs;
1437 uint32_t n_physical_midi_outputs;
1438 uint32_t n_physical_midi_inputs;
1440 int find_all_sources (std::string path, std::set<std::string>& result);
1441 int find_all_sources_across_snapshots (std::set<std::string>& result, bool exclude_this_snapshot);
1443 typedef std::set<boost::shared_ptr<PBD::Controllable> > Controllables;
1444 Glib::Mutex controllables_lock;
1445 Controllables controllables;
1447 void reset_native_file_format();
1448 bool first_file_data_format_reset;
1449 bool first_file_header_format_reset;
1451 void config_changed (std::string, bool);
1453 XMLNode& get_control_protocol_state ();
1455 void set_history_depth (uint32_t depth);
1456 void sync_order_keys ();
1458 static bool _disable_all_loaded_plugins;
1460 SessionMetadata * _metadata;
1462 mutable bool have_looped; ///< Used in ::audible_frame(*)
1464 void update_have_rec_enabled_diskstream ();
1465 gint _have_rec_enabled_diskstream;
1467 /* realtime "apply to set of routes" operations */
1468 SessionEvent* get_rt_event (boost::shared_ptr<RouteList> rl, bool yn, SessionEvent::RTeventCallback after, bool group_override,
1469 void (Session::*method) (boost::shared_ptr<RouteList>, bool, bool));
1471 void rt_set_solo (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1472 void rt_set_just_one_solo (boost::shared_ptr<RouteList>, bool yn, bool /* ignored*/ );
1473 void rt_set_mute (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1474 void rt_set_listen (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1475 void rt_set_record_enable (boost::shared_ptr<RouteList>, bool yn, bool group_override);
1478 } // namespace ARDOUR
1480 #endif /* __ardour_session_h__ */