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.
21 #ifndef __ardour_session_h__
22 #define __ardour_session_h__
34 #include <glibmm/thread.h>
36 #include <pbd/error.h>
41 #include <midi++/types.h>
42 #include <midi++/mmc.h>
44 #include <pbd/stateful.h>
46 #include <ardour/ardour.h>
47 #include <ardour/configuration.h>
48 #include <ardour/location.h>
49 #include <ardour/gain.h>
50 #include <ardour/io.h>
70 class AudioDiskstream;
75 class AudioFileSource;
90 class ControlProtocolManager;
92 struct AudioExportSpecification;
101 class Session : public sigc::trackable, public Stateful
105 typedef std::pair<boost::shared_ptr<Route>,bool> RouteBooleanState;
106 typedef vector<RouteBooleanState> GlobalRouteBooleanState;
107 typedef std::pair<boost::shared_ptr<Route>,MeterPoint> RouteMeterState;
108 typedef vector<RouteMeterState> GlobalRouteMeterState;
123 enum AutoConnectOption {
124 AutoConnectPhysical = 0x1,
125 AutoConnectMaster = 0x2
142 InputConfigurationChange,
146 /* only one of each of these events
147 can be queued at any one time
163 jack_nframes_t action_frame;
164 jack_nframes_t target_frame;
170 Session::SlaveSource slave;
174 list<AudioRange> audio_range;
175 list<MusicRange> music_range;
177 Event(Type t, Action a, jack_nframes_t when, jack_nframes_t where, float spd, bool yn = false)
181 target_frame (where),
185 void set_ptr (void* p) {
189 bool before (const Event& other) const {
190 return action_frame < other.action_frame;
193 bool after (const Event& other) const {
194 return action_frame > other.action_frame;
197 static bool compare (const Event *e1, const Event *e2) {
198 return e1->before (*e2);
201 void *operator new (size_t ignored) {
202 return pool.alloc ();
205 void operator delete(void *ptr, size_t size) {
209 static const jack_nframes_t Immediate = 0;
212 static MultiAllocSingleReleasePool pool;
215 /* creating from an XML file */
217 Session (AudioEngine&,
219 string snapshot_name,
220 string* mix_template = 0);
222 /* creating a new Session */
224 Session (AudioEngine&,
226 string snapshot_name,
227 AutoConnectOption input_auto_connect,
228 AutoConnectOption output_auto_connect,
229 uint32_t control_out_channels,
230 uint32_t master_out_channels,
231 uint32_t n_physical_in,
232 uint32_t n_physical_out,
233 jack_nframes_t initial_length);
238 static int find_session (string str, string& path, string& snapshot, bool& isnew);
240 string path() const { return _path; }
241 string name() const { return _name; }
242 string snap_name() const { return _current_snapshot_name; }
244 void set_snap_name ();
248 bool dirty() const { return _state_of_the_state & Dirty; }
249 sigc::signal<void> DirtyChanged;
251 std::string sound_dir () const;
252 std::string tape_dir () const;
253 std::string peak_dir () const;
254 std::string dead_sound_dir () const;
255 std::string automation_dir () const;
257 static string suffixed_search_path (std::string suffix, bool data);
258 static string control_protocol_path ();
259 static string template_path ();
260 static string template_dir ();
261 static void get_template_list (list<string>&);
263 static string change_audio_path_by_name (string oldpath, string oldname, string newname, bool destructive);
264 static string peak_path_from_audio_path (string);
265 string audio_path_from_name (string, uint32_t nchans, uint32_t chan, bool destructive);
267 void process (jack_nframes_t nframes);
269 vector<Sample*>& get_passthru_buffers() { return _passthru_buffers; }
270 vector<Sample*>& get_silent_buffers (uint32_t howmany);
271 vector<Sample*>& get_send_buffers () { return _send_buffers; }
273 void add_diskstream (boost::shared_ptr<Diskstream>);
274 boost::shared_ptr<Diskstream> diskstream_by_id (const PBD::ID& id);
275 boost::shared_ptr<Diskstream> diskstream_by_name (string name);
277 bool have_captured() const { return _have_captured; }
279 void refill_all_diskstream_buffers ();
280 uint32_t diskstream_buffer_size() const { return dstream_buffer_size; }
282 uint32_t get_next_diskstream_id() const { return n_diskstreams(); }
283 uint32_t n_diskstreams() const;
285 typedef std::list<boost::shared_ptr<Diskstream> > DiskstreamList;
286 typedef std::list<boost::shared_ptr<Route> > RouteList;
288 boost::shared_ptr<RouteList> get_routes() const {
289 return routes.reader ();
292 uint32_t nroutes() const { return routes.reader()->size(); }
293 uint32_t ntracks () const;
294 uint32_t nbusses () const;
296 struct RoutePublicOrderSorter {
297 bool operator() (boost::shared_ptr<Route>, boost::shared_ptr<Route> b);
300 template<class T> void foreach_route (T *obj, void (T::*func)(Route&));
301 template<class T> void foreach_route (T *obj, void (T::*func)(boost::shared_ptr<Route>));
302 template<class T, class A> void foreach_route (T *obj, void (T::*func)(Route&, A), A arg);
304 boost::shared_ptr<Route> route_by_name (string);
305 boost::shared_ptr<Route> route_by_id (PBD::ID);
306 boost::shared_ptr<Route> route_by_remote_id (uint32_t id);
308 bool route_name_unique (string) const;
310 bool get_record_enabled() const {
311 return (record_status () >= Enabled);
314 RecordState record_status() const {
315 return (RecordState) g_atomic_int_get (&_record_status);
318 bool actively_recording () {
319 return record_status() == Recording;
322 bool record_enabling_legal () const;
323 void maybe_enable_record ();
324 void disable_record (bool rt_context, bool force = false);
325 void step_back_from_record ();
327 sigc::signal<void> going_away;
329 /* Proxy signal for region hidden changes */
331 sigc::signal<void,Region*> RegionHiddenChange;
333 /* Emitted when all i/o connections are complete */
335 sigc::signal<void> IOConnectionsComplete;
337 /* Record status signals */
339 sigc::signal<void> RecordStateChanged;
341 /* Transport mechanism signals */
343 sigc::signal<void> TransportStateChange; /* generic */
344 sigc::signal<void,jack_nframes_t> PositionChanged; /* sent after any non-sequential motion */
345 sigc::signal<void> DurationChanged;
346 sigc::signal<void> HaltOnXrun;
348 sigc::signal<void,RouteList&> RouteAdded;
350 void request_roll ();
351 void request_bounded_roll (jack_nframes_t start, jack_nframes_t end);
352 void request_stop (bool abort = false);
353 void request_locate (jack_nframes_t frame, bool with_roll = false);
354 void request_auto_loop (bool yn);
355 jack_nframes_t last_transport_start() const { return _last_roll_location; }
356 void goto_end () { request_locate (end_location->start(), false);}
357 void goto_start () { request_locate (start_location->start(), false); }
358 void use_rf_shuttle_speed ();
359 void request_transport_speed (float speed);
360 void request_overwrite_buffer (Diskstream*);
361 void request_diskstream_speed (Diskstream&, float speed);
362 void request_input_change_handling ();
364 bool locate_pending() const { return static_cast<bool>(post_transport_work&PostTransportLocate); }
365 bool transport_locked () const;
369 int remove_region_from_region_list (Region&);
371 jack_nframes_t get_maximum_extent () const;
372 jack_nframes_t current_end_frame() const { return end_location->start(); }
373 jack_nframes_t current_start_frame() const { return start_location->start(); }
374 jack_nframes_t frame_rate() const { return _current_frame_rate; }
375 double frames_per_smpte_frame() const { return _frames_per_smpte_frame; }
376 jack_nframes_t frames_per_hour() const { return _frames_per_hour; }
377 jack_nframes_t smpte_frames_per_hour() const { return _smpte_frames_per_hour; }
381 Locations *locations() { return &_locations; }
383 sigc::signal<void,Location*> auto_loop_location_changed;
384 sigc::signal<void,Location*> auto_punch_location_changed;
385 sigc::signal<void> locations_modified;
387 void set_auto_punch_location (Location *);
388 void set_auto_loop_location (Location *);
418 sigc::signal<void,ControlType> ControlChanged;
420 void set_auto_play (bool yn);
421 void set_auto_return (bool yn);
422 void set_auto_input (bool yn);
423 void reset_input_monitor_state ();
424 void set_input_auto_connect (bool yn);
425 void set_output_auto_connect (AutoConnectOption);
426 void set_punch_in (bool yn);
427 void set_punch_out (bool yn);
428 void set_send_mtc (bool yn);
429 void set_send_mmc (bool yn);
430 void set_mmc_control (bool yn);
431 void set_midi_feedback (bool yn);
432 void set_midi_control (bool yn);
433 void set_do_not_record_plugins (bool yn);
434 void set_crossfades_active (bool yn);
435 void set_seamless_loop (bool yn);
437 bool get_auto_play () const { return auto_play; }
438 bool get_auto_input () const { return auto_input; }
439 bool get_auto_loop () const { return auto_loop; }
440 bool get_seamless_loop () const { return seamless_loop; }
441 bool get_punch_in () const { return punch_in; }
442 bool get_punch_out () const { return punch_out; }
443 bool get_all_safe () const { return all_safe; }
444 bool get_auto_return () const { return auto_return; }
445 bool get_send_mtc () const;
446 bool get_send_mmc () const;
447 bool get_mmc_control () const;
448 bool get_midi_feedback () const;
449 bool get_midi_control () const;
450 bool get_do_not_record_plugins () const { return do_not_record_plugins; }
451 bool get_crossfades_active () const { return crossfades_active; }
453 bool get_input_auto_connect () const;
454 AutoConnectOption get_output_auto_connect () const { return output_auto_connect; }
462 void set_layer_model (LayerModel);
463 LayerModel get_layer_model () const { return layer_model; }
465 void set_xfade_model (CrossfadeModel);
466 CrossfadeModel get_xfade_model () const { return xfade_model; }
468 void add_event (jack_nframes_t action_frame, Event::Type type, jack_nframes_t target_frame = 0);
469 void remove_event (jack_nframes_t frame, Event::Type type);
470 void clear_events (Event::Type type);
472 jack_nframes_t get_block_size() const { return current_block_size; }
473 jack_nframes_t worst_output_latency () const { return _worst_output_latency; }
474 jack_nframes_t worst_input_latency () const { return _worst_input_latency; }
475 jack_nframes_t worst_track_latency () const { return _worst_track_latency; }
477 int save_state (string snapshot_name, bool pending = false);
478 int restore_state (string snapshot_name);
479 int save_template (string template_name);
480 int save_history (string snapshot_name = "");
481 int restore_history (string snapshot_name);
483 static int rename_template (string old_name, string new_name);
485 static int delete_template (string name);
487 sigc::signal<void,string> StateSaved;
488 sigc::signal<void> StateReady;
490 vector<string*>* possible_states() const;
491 static vector<string*>* possible_states(string path);
493 XMLNode& get_state();
494 int set_state(const XMLNode& node); // not idempotent
495 XMLNode& get_template();
497 void add_instant_xml (XMLNode&, const std::string& dir);
499 enum StateOfTheState {
504 InitialConnecting = 0x8,
509 StateOfTheState state_of_the_state() const { return _state_of_the_state; }
511 RouteGroup* add_edit_group (string);
512 RouteGroup* add_mix_group (string);
514 void remove_edit_group (RouteGroup&);
515 void remove_mix_group (RouteGroup&);
517 RouteGroup *mix_group_by_name (string);
518 RouteGroup *edit_group_by_name (string);
520 sigc::signal<void,RouteGroup*> edit_group_added;
521 sigc::signal<void,RouteGroup*> mix_group_added;
522 sigc::signal<void> edit_group_removed;
523 sigc::signal<void> mix_group_removed;
525 void foreach_edit_group (sigc::slot<void,RouteGroup*> sl) {
526 for (list<RouteGroup *>::iterator i = edit_groups.begin(); i != edit_groups.end(); i++) {
531 void foreach_mix_group (sigc::slot<void,RouteGroup*> sl) {
532 for (list<RouteGroup *>::iterator i = mix_groups.begin(); i != mix_groups.end(); i++) {
537 /* fundamental operations. duh. */
539 std::list<boost::shared_ptr<AudioTrack> > new_audio_track (int input_channels, int output_channels, TrackMode mode = Normal, uint32_t how_many = 1);
540 RouteList new_audio_route (int input_channels, int output_channels, uint32_t how_many);
542 void remove_route (boost::shared_ptr<Route>);
544 void resort_routes ();
545 void resort_routes_using (boost::shared_ptr<RouteList>);
547 AudioEngine &engine() { return _engine; };
549 /* configuration. there should really be accessors/mutators
553 float meter_hold () { return _meter_hold; }
554 void set_meter_hold (float);
555 sigc::signal<void> MeterHoldChanged;
557 float meter_falloff () { return _meter_falloff; }
558 void set_meter_falloff (float);
559 sigc::signal<void> MeterFalloffChanged;
563 string click_emphasis_sound;
565 bool click_requested;
566 jack_nframes_t over_length_short;
567 jack_nframes_t over_length_long;
568 bool send_midi_timecode;
569 bool send_midi_machine_control;
570 float shuttle_speed_factor;
571 float shuttle_speed_threshold;
573 float smpte_frames_per_second;
574 bool smpte_drop_frames;
580 jack_nframes_t transport_frame () const {return _transport_frame; }
581 jack_nframes_t audible_frame () const;
583 int set_smpte_type (float fps, bool drop_frames);
585 void bbt_time (jack_nframes_t when, BBT_Time&);
586 void smpte_to_sample( SMPTE::Time& smpte, jack_nframes_t& sample, bool use_offset, bool use_subframes ) const;
587 void sample_to_smpte( jack_nframes_t sample, SMPTE::Time& smpte, bool use_offset, bool use_subframes ) const;
588 void smpte_time (SMPTE::Time &);
589 void smpte_time (jack_nframes_t when, SMPTE::Time&);
590 void smpte_time_subframes (jack_nframes_t when, SMPTE::Time&);
592 void smpte_duration (jack_nframes_t, SMPTE::Time&) const;
593 void smpte_duration_string (char *, jack_nframes_t) const;
595 void set_smpte_offset (jack_nframes_t);
596 jack_nframes_t smpte_offset () const { return _smpte_offset; }
597 void set_smpte_offset_negative (bool);
598 bool smpte_offset_negative () const { return _smpte_offset_negative; }
600 jack_nframes_t convert_to_frames_at (jack_nframes_t position, AnyTime&);
602 static sigc::signal<void> SMPTEOffsetChanged;
603 sigc::signal<void> SMPTETypeChanged;
605 void request_slave_source (SlaveSource, jack_nframes_t pos = 0);
606 SlaveSource slave_source() const { return _slave_type; }
607 bool synced_to_jack() const { return _slave_type == JACK; }
608 float transport_speed() const { return _transport_speed; }
609 bool transport_stopped() const { return _transport_speed == 0.0f; }
610 bool transport_rolling() const { return _transport_speed != 0.0f; }
612 int jack_slave_sync (jack_nframes_t);
614 TempoMap& tempo_map() { return *_tempo_map; }
618 sigc::signal<void,AudioRegion *> AudioRegionAdded;
619 sigc::signal<void,AudioRegion *> AudioRegionRemoved;
621 int region_name (string& result, string base = string(""), bool newlevel = false) const;
622 string new_region_name (string);
623 string path_from_region_name (string name, string identifier);
625 AudioRegion* find_whole_file_parent (AudioRegion&);
626 void find_equivalent_playlist_regions (Region&, std::vector<Region*>& result);
628 AudioRegion *XMLRegionFactory (const XMLNode&, bool full);
630 template<class T> void foreach_audio_region (T *obj, void (T::*func)(AudioRegion *));
632 /* source management */
634 struct import_status : public InterThreadInfo {
640 volatile bool freeze;
644 std::vector<AudioRegion*> new_regions;
648 int import_audiofile (import_status&);
649 bool sample_rate_convert (import_status&, string infile, string& outfile);
650 string build_tmp_convert_name (string file);
652 Session::SlaveSource post_export_slave;
653 jack_nframes_t post_export_position;
655 int start_audio_export (ARDOUR::AudioExportSpecification&);
656 int stop_audio_export (ARDOUR::AudioExportSpecification&);
658 void add_audio_source (AudioSource *);
659 void remove_source (Source *);
660 int cleanup_audio_file_source (AudioFileSource&);
662 struct cleanup_report {
663 vector<string> paths;
667 int cleanup_sources (cleanup_report&);
668 int cleanup_trash_sources (cleanup_report&);
670 int destroy_region (Region*);
671 int destroy_regions (list<Region*>);
673 int remove_last_capture ();
675 /* handlers should return -1 for "stop cleanup", 0 for
676 "yes, delete this playlist" and 1 for "no, don't delete
680 sigc::signal<int,ARDOUR::Playlist*> AskAboutPlaylistDeletion;
683 /* handlers should return !0 for use pending state, 0 for
687 static sigc::signal<int> AskAboutPendingState;
689 sigc::signal<void,Source *> SourceAdded;
690 sigc::signal<void,Source *> SourceRemoved;
692 AudioFileSource *create_audio_source_for_session (ARDOUR::AudioDiskstream&, uint32_t which_channel, bool destructive);
694 Source *source_by_id (const PBD::ID&);
696 /* playlist management */
698 Playlist* playlist_by_name (string name);
699 void add_playlist (Playlist *);
700 sigc::signal<void,Playlist*> PlaylistAdded;
701 sigc::signal<void,Playlist*> PlaylistRemoved;
703 uint32_t n_playlists() const;
705 template<class T> void foreach_playlist (T *obj, void (T::*func)(Playlist *));
707 /* named selections */
709 NamedSelection* named_selection_by_name (string name);
710 void add_named_selection (NamedSelection *);
711 void remove_named_selection (NamedSelection *);
713 template<class T> void foreach_named_selection (T& obj, void (T::*func)(NamedSelection&));
714 sigc::signal<void> NamedSelectionAdded;
715 sigc::signal<void> NamedSelectionRemoved;
717 /* Curves and AutomationLists (TODO when they go away) */
718 void add_curve(Curve*);
719 void add_automation_list(AutomationList*);
723 float get_default_fade_length () const { return default_fade_msecs; }
724 float get_default_fade_steepness () const { return default_fade_steepness; }
725 void set_default_fade (float steepness, float msecs);
729 boost::shared_ptr<Auditioner> the_auditioner() { return auditioner; }
730 void audition_playlist ();
731 void audition_region (Region&);
732 void cancel_audition ();
733 bool is_auditioning () const;
735 sigc::signal<void,bool> AuditionActive;
737 /* flattening stuff */
739 int write_one_audio_track (AudioTrack&, jack_nframes_t start, jack_nframes_t cnt, bool overwrite, vector<AudioSource*>&,
740 InterThreadInfo& wot);
741 int freeze (InterThreadInfo&);
743 /* session-wide solo/mute/rec-enable */
750 bool soloing() const { return currently_soloing; }
752 SoloModel solo_model() const { return _solo_model; }
753 void set_solo_model (SoloModel);
755 bool solo_latched() const { return _solo_latched; }
756 void set_solo_latched (bool yn);
758 void set_all_solo (bool);
759 void set_all_mute (bool);
761 sigc::signal<void,bool> SoloActive;
763 void record_disenable_all ();
764 void record_enable_all ();
766 /* control/master out */
768 boost::shared_ptr<IO> control_out() const { return _control_out; }
769 boost::shared_ptr<IO> master_out() const { return _master_out; }
771 /* insert/send management */
773 uint32_t n_port_inserts() const { return _port_inserts.size(); }
774 uint32_t n_plugin_inserts() const { return _plugin_inserts.size(); }
775 uint32_t n_sends() const { return _sends.size(); }
777 string next_send_name();
778 string next_insert_name();
780 /* s/w "RAID" management */
782 jack_nframes_t available_capture_duration();
784 /* I/O Connections */
786 template<class T> void foreach_connection (T *obj, void (T::*func)(Connection *));
787 void add_connection (Connection *);
788 void remove_connection (Connection *);
789 Connection *connection_by_name (string) const;
791 sigc::signal<void,Connection *> ConnectionAdded;
792 sigc::signal<void,Connection *> ConnectionRemoved;
796 int set_mtc_port (string port_tag);
797 int set_mmc_port (string port_tag);
798 int set_midi_port (string port_tag);
799 MIDI::Port *mtc_port() const { return _mtc_port; }
800 MIDI::Port *mmc_port() const { return _mmc_port; }
801 MIDI::Port *midi_port() const { return _midi_port; }
803 sigc::signal<void> MTC_PortChanged;
804 sigc::signal<void> MMC_PortChanged;
805 sigc::signal<void> MIDI_PortChanged;
807 void set_trace_midi_input (bool, MIDI::Port* port = 0);
808 void set_trace_midi_output (bool, MIDI::Port* port = 0);
810 bool get_trace_midi_input(MIDI::Port *port = 0);
811 bool get_trace_midi_output(MIDI::Port *port = 0);
813 void send_midi_message (MIDI::Port * port, MIDI::eventType ev, MIDI::channel_t, MIDI::EventTwoBytes);
815 void deliver_midi (MIDI::Port*, MIDI::byte*, int32_t size);
819 void start_scrub (jack_nframes_t where);
821 void set_scrub_speed (float);
822 jack_nframes_t scrub_buffer_size() const;
823 sigc::signal<void> ScrubReady;
825 /* History (for editors, mixers, UIs etc.) */
827 void undo (uint32_t n) {
830 void redo (uint32_t n) {
834 uint32_t undo_depth() const { return history.undo_depth(); }
835 uint32_t redo_depth() const { return history.redo_depth(); }
836 string next_undo() const { return history.next_undo(); }
837 string next_redo() const { return history.next_redo(); }
839 void begin_reversible_command (string cmd_name);
840 void commit_reversible_command (Command* cmd = 0);
842 void add_command (Command *const cmd) {
843 current_trans.add_command (cmd);
846 // these commands are implemented in libs/ardour/session_command.cc
847 Command *memento_command_factory(XMLNode *n);
848 void register_with_memento_command_factory(PBD::ID, Stateful *);
849 class GlobalSoloStateCommand : public Command
851 GlobalRouteBooleanState before, after;
855 GlobalSoloStateCommand(Session &, void *src);
858 XMLNode &get_state();
862 class GlobalMuteStateCommand : public Command
864 GlobalRouteBooleanState before, after;
868 GlobalMuteStateCommand(Session &, void *src);
871 XMLNode &get_state();
875 class GlobalRecordEnableStateCommand : public Command
877 GlobalRouteBooleanState before, after;
881 GlobalRecordEnableStateCommand(Session &, void *src);
884 XMLNode &get_state();
888 class GlobalMeteringStateCommand : public Command
890 GlobalRouteMeterState before, after;
894 GlobalMeteringStateCommand(Session &, void *src);
897 XMLNode &get_state();
903 void set_edit_mode (EditMode);
904 EditMode get_edit_mode () const { return _edit_mode; }
908 boost::shared_ptr<IO> click_io() { return _click_io; }
909 void set_clicking (bool yn);
910 bool get_clicking() const;
912 void set_click_sound (string path);
913 void set_click_emphasis_sound (string path);
917 struct TimeStretchRequest {
918 ARDOUR::AudioRegion* region;
919 float fraction; /* session: read ; GUI: write */
920 float progress; /* session: write ; GUI: read */
921 bool running; /* read/write */
922 bool quick_seek; /* GUI: write */
923 bool antialias; /* GUI: write */
925 TimeStretchRequest () : region (0) {}
928 AudioRegion* tempoize_region (TimeStretchRequest&);
930 string raid_path() const;
931 void set_raid_path(string);
933 /* need to call this whenever we change native file formats */
935 void reset_native_file_format();
937 /* disk, buffer loads */
939 uint32_t playback_load ();
940 uint32_t capture_load ();
941 uint32_t playback_load_min ();
942 uint32_t capture_load_min ();
944 void reset_playback_load_min ();
945 void reset_capture_load_min ();
947 float read_data_rate () const;
948 float write_data_rate () const;
952 void set_audio_range (list<AudioRange>&);
953 void set_music_range (list<MusicRange>&);
955 void request_play_range (bool yn);
956 bool get_play_range () const { return _play_range; }
959 typedef vector<string> FavoriteDirs;
961 static int read_favorite_dirs (FavoriteDirs&);
963 static int write_favorite_dirs (FavoriteDirs&);
967 static const char* template_suffix() { return _template_suffix; }
968 static const char* statefile_suffix() { return _statefile_suffix; }
969 static const char* pending_suffix() { return _pending_suffix; }
971 /* buffers for gain and pan */
973 gain_t* gain_automation_buffer () const { return _gain_automation_buffer; }
974 pan_t** pan_automation_buffer() const { return _pan_automation_buffer; }
976 /* buffers for conversion */
985 static long vst_callback (AEffect* effect,
992 typedef float (*compute_peak_t) (Sample *, jack_nframes_t, float);
993 typedef void (*apply_gain_to_buffer_t) (Sample *, jack_nframes_t, float);
994 typedef void (*mix_buffers_with_gain_t) (Sample *, Sample *, jack_nframes_t, float);
995 typedef void (*mix_buffers_no_gain_t) (Sample *, Sample *, jack_nframes_t);
997 static compute_peak_t compute_peak;
998 static apply_gain_to_buffer_t apply_gain_to_buffer;
999 static mix_buffers_with_gain_t mix_buffers_with_gain;
1000 static mix_buffers_no_gain_t mix_buffers_no_gain;
1002 static sigc::signal<void> SendFeedback;
1006 PBD::Controllable* controllable_by_id (const PBD::ID&);
1009 friend class AudioEngine;
1010 void set_block_size (jack_nframes_t nframes);
1011 void set_frame_rate (jack_nframes_t nframes);
1014 friend class Diskstream;
1015 void stop_butler ();
1016 void wait_till_butler_finished();
1020 void schedule_curve_reallocation ();
1021 void update_latency_compensation (bool, bool);
1024 int create (bool& new_session, string* mix_template, jack_nframes_t initial_length);
1026 static const char* _template_suffix;
1027 static const char* _statefile_suffix;
1028 static const char* _pending_suffix;
1031 PendingDeclickIn = 0x1,
1032 PendingDeclickOut = 0x2,
1033 StopPendingCapture = 0x4,
1034 AutoReturning = 0x10,
1035 PendingLocate = 0x20,
1036 PendingSetLoop = 0x40
1039 /* stuff used in process() should be close together to
1043 typedef void (Session::*process_function_type)(jack_nframes_t);
1045 AudioEngine &_engine;
1046 mutable gint processing_prohibited;
1047 process_function_type process_function;
1048 process_function_type last_process_function;
1049 jack_nframes_t _current_frame_rate;
1050 int transport_sub_state;
1051 mutable gint _record_status;
1052 jack_nframes_t _transport_frame;
1053 Location* end_location;
1054 Location* start_location;
1056 SlaveSource _slave_type;
1057 volatile float _transport_speed;
1058 volatile float _desired_transport_speed;
1059 float _last_transport_speed;
1060 jack_nframes_t _last_slave_transport_frame;
1061 jack_nframes_t maximum_output_latency;
1062 jack_nframes_t last_stop_frame;
1063 vector<Sample *> _passthru_buffers;
1064 vector<Sample *> _silent_buffers;
1065 vector<Sample *> _send_buffers;
1066 jack_nframes_t current_block_size;
1067 jack_nframes_t _worst_output_latency;
1068 jack_nframes_t _worst_input_latency;
1069 jack_nframes_t _worst_track_latency;
1070 bool _have_captured;
1072 float _meter_falloff;
1073 bool _end_location_is_free;
1075 void set_worst_io_latencies ();
1076 void set_worst_io_latencies_x (IOChange asifwecare, void *ignored) {
1077 set_worst_io_latencies ();
1080 void update_latency_compensation_proxy (void* ignored);
1082 void ensure_passthru_buffers (uint32_t howmany);
1084 void process_scrub (jack_nframes_t);
1085 void process_without_events (jack_nframes_t);
1086 void process_with_events (jack_nframes_t);
1087 void process_audition (jack_nframes_t);
1088 int process_export (jack_nframes_t, ARDOUR::AudioExportSpecification*);
1090 /* slave tracking */
1092 static const int delta_accumulator_size = 25;
1093 int delta_accumulator_cnt;
1094 long delta_accumulator[delta_accumulator_size];
1095 long average_slave_delta;
1097 bool have_first_delta_accumulator;
1105 SlaveState slave_state;
1106 jack_nframes_t slave_wait_end;
1108 void reset_slave_state ();
1109 bool follow_slave (jack_nframes_t, jack_nframes_t);
1112 int prepare_to_export (ARDOUR::AudioExportSpecification&);
1114 void prepare_diskstreams ();
1115 void commit_diskstreams (jack_nframes_t, bool& session_requires_butler);
1116 int process_routes (jack_nframes_t, jack_nframes_t);
1117 int silent_process_routes (jack_nframes_t, jack_nframes_t);
1119 bool get_rec_monitors_input () {
1120 if (actively_recording()) {
1131 int get_transport_declick_required () {
1133 if (transport_sub_state & PendingDeclickIn) {
1134 transport_sub_state &= ~PendingDeclickIn;
1136 } else if (transport_sub_state & PendingDeclickOut) {
1143 bool maybe_stop (jack_nframes_t limit) {
1144 if ((_transport_speed > 0.0f && _transport_frame >= limit) || (_transport_speed < 0.0f && _transport_frame == 0)) {
1151 void check_declick_out ();
1153 MIDI::MachineControl* mmc;
1154 MIDI::Port* _mmc_port;
1155 MIDI::Port* _mtc_port;
1156 MIDI::Port* _midi_port;
1159 bool do_not_record_plugins;
1169 jack_nframes_t last_loopend;
1171 bool crossfades_active;
1180 RingBuffer<Event*> pending_events;
1183 void when_engine_running ();
1184 sigc::connection first_time_running;
1185 void graph_reordered ();
1187 string _current_snapshot_name;
1189 XMLTree* state_tree;
1190 bool state_was_pending;
1191 StateOfTheState _state_of_the_state;
1194 int load_options (const XMLNode&);
1195 XMLNode& get_options () const;
1196 int load_state (string snapshot_name);
1198 jack_nframes_t _last_roll_location;
1199 jack_nframes_t _last_record_location;
1200 bool pending_locate_roll;
1201 jack_nframes_t pending_locate_frame;
1203 bool pending_locate_flush;
1205 bool pending_auto_loop;
1207 Sample* butler_mixdown_buffer;
1208 float* butler_gain_buffer;
1209 pthread_t butler_thread;
1210 Glib::Mutex butler_request_lock;
1211 Glib::Cond butler_paused;
1212 bool butler_should_run;
1213 mutable gint butler_should_do_transport_work;
1214 int butler_request_pipe[2];
1216 struct ButlerRequest {
1225 enum PostTransportWork {
1226 PostTransportStop = 0x1,
1227 PostTransportDisableRecord = 0x2,
1228 PostTransportPosition = 0x8,
1229 PostTransportDidRecord = 0x20,
1230 PostTransportDuration = 0x40,
1231 PostTransportLocate = 0x80,
1232 PostTransportRoll = 0x200,
1233 PostTransportAbort = 0x800,
1234 PostTransportOverWrite = 0x1000,
1235 PostTransportSpeed = 0x2000,
1236 PostTransportAudition = 0x4000,
1237 PostTransportScrub = 0x8000,
1238 PostTransportReverse = 0x10000,
1239 PostTransportInputChange = 0x20000,
1240 PostTransportCurveRealloc = 0x40000
1243 static const PostTransportWork ProcessCannotProceedMask =
1244 PostTransportWork (PostTransportInputChange|
1246 PostTransportReverse|
1247 PostTransportCurveRealloc|
1249 PostTransportAudition|
1250 PostTransportLocate|
1253 PostTransportWork post_transport_work;
1255 void summon_butler ();
1256 void schedule_butler_transport_work ();
1257 int start_butler_thread ();
1258 void terminate_butler_thread ();
1259 static void *_butler_thread_work (void *arg);
1260 void* butler_thread_work ();
1262 uint32_t cumulative_rf_motion;
1265 void set_rf_speed (float speed);
1266 void reset_rf_scale (jack_nframes_t frames_moved);
1268 Locations _locations;
1269 void locations_changed ();
1270 void locations_added (Location*);
1271 void handle_locations_changed (Locations::LocationList&);
1273 sigc::connection auto_punch_start_changed_connection;
1274 sigc::connection auto_punch_end_changed_connection;
1275 sigc::connection auto_punch_changed_connection;
1276 void auto_punch_start_changed (Location *);
1277 void auto_punch_end_changed (Location *);
1278 void auto_punch_changed (Location *);
1280 sigc::connection auto_loop_start_changed_connection;
1281 sigc::connection auto_loop_end_changed_connection;
1282 sigc::connection auto_loop_changed_connection;
1283 void auto_loop_changed (Location *);
1285 typedef list<Event *> Events;
1287 Events immediate_events;
1288 Events::iterator next_event;
1290 /* there can only ever be one of each of these */
1292 Event *auto_loop_event;
1293 Event *punch_out_event;
1294 Event *punch_in_event;
1298 void dump_events () const;
1299 void queue_event (Event *ev);
1300 void merge_event (Event*);
1301 void replace_event (Event::Type, jack_nframes_t action_frame, jack_nframes_t target = 0);
1302 bool _replace_event (Event*);
1303 bool _remove_event (Event *);
1304 void _clear_event_type (Event::Type);
1306 void first_stage_init (string path, string snapshot_name);
1307 int second_stage_init (bool new_tracks);
1308 void find_current_end ();
1309 void remove_empty_sounds ();
1311 void setup_midi_control ();
1312 int midi_read (MIDI::Port *);
1314 void enable_record ();
1316 void increment_transport_position (uint32_t val) {
1317 if (max_frames - val < _transport_frame) {
1318 _transport_frame = max_frames;
1320 _transport_frame += val;
1324 void decrement_transport_position (uint32_t val) {
1325 if (val < _transport_frame) {
1326 _transport_frame -= val;
1328 _transport_frame = 0;
1332 void post_transport_motion ();
1333 static void *session_loader_thread (void *arg);
1337 void set_next_event ();
1338 void process_event (Event *);
1340 /* MIDI Machine Control */
1342 void deliver_mmc (MIDI::MachineControl::Command, jack_nframes_t);
1343 void deliver_midi_message (MIDI::Port * port, MIDI::eventType ev, MIDI::channel_t, MIDI::EventTwoBytes);
1344 void deliver_data (MIDI::Port* port, MIDI::byte*, int32_t size);
1346 void spp_start (MIDI::Parser&);
1347 void spp_continue (MIDI::Parser&);
1348 void spp_stop (MIDI::Parser&);
1350 void mmc_deferred_play (MIDI::MachineControl &);
1351 void mmc_stop (MIDI::MachineControl &);
1352 void mmc_step (MIDI::MachineControl &, int);
1353 void mmc_pause (MIDI::MachineControl &);
1354 void mmc_record_pause (MIDI::MachineControl &);
1355 void mmc_record_strobe (MIDI::MachineControl &);
1356 void mmc_record_exit (MIDI::MachineControl &);
1357 void mmc_track_record_status (MIDI::MachineControl &,
1358 uint32_t track, bool enabled);
1359 void mmc_fast_forward (MIDI::MachineControl &);
1360 void mmc_rewind (MIDI::MachineControl &);
1361 void mmc_locate (MIDI::MachineControl &, const MIDI::byte *);
1362 void mmc_shuttle (MIDI::MachineControl &mmc, float speed, bool forw);
1363 void mmc_record_enable (MIDI::MachineControl &mmc, size_t track, bool enabled);
1365 struct timeval last_mmc_step;
1368 typedef sigc::slot<bool> MidiTimeoutCallback;
1369 typedef list<MidiTimeoutCallback> MidiTimeoutList;
1371 MidiTimeoutList midi_timeouts;
1372 bool mmc_step_timeout ();
1374 MIDI::byte mmc_buffer[32];
1375 MIDI::byte mtc_msg[16];
1376 MIDI::byte mtc_smpte_bits; /* encoding of SMTPE type for MTC */
1377 MIDI::byte midi_msg[16];
1378 jack_nframes_t outbound_mtc_smpte_frame;
1379 SMPTE::Time transmitting_smpte_time;
1380 int next_quarter_frame_to_send;
1382 double _frames_per_smpte_frame; /* has to be floating point because of drop frame */
1383 jack_nframes_t _frames_per_hour;
1384 jack_nframes_t _smpte_frames_per_hour;
1385 jack_nframes_t _smpte_offset;
1386 bool _smpte_offset_negative;
1388 /* cache the most-recently requested time conversions.
1389 this helps when we have multiple clocks showing the
1390 same time (e.g. the transport frame)
1393 bool last_smpte_valid;
1394 jack_nframes_t last_smpte_when;
1395 SMPTE::Time last_smpte;
1397 int send_full_time_code ();
1398 int send_midi_time_code ();
1400 void send_full_time_code_in_another_thread ();
1401 void send_midi_time_code_in_another_thread ();
1402 void send_time_code_in_another_thread (bool full);
1403 void send_mmc_in_another_thread (MIDI::MachineControl::Command, jack_nframes_t frame = 0);
1405 jack_nframes_t adjust_apparent_position (jack_nframes_t frames);
1407 void reset_record_status ();
1409 int no_roll (jack_nframes_t nframes, jack_nframes_t offset);
1411 bool non_realtime_work_pending() const { return static_cast<bool>(post_transport_work); }
1412 bool process_can_proceed() const { return !(post_transport_work & ProcessCannotProceedMask); }
1414 struct MIDIRequest {
1427 MIDI::MachineControl::Command mmc_cmd;
1428 jack_nframes_t locate_frame;
1430 // for SendMessage type
1433 MIDI::channel_t chan;
1435 MIDI::EventTwoBytes data;
1446 void *operator new(size_t ignored) {
1447 return pool.alloc ();
1450 void operator delete(void *ptr, size_t size) {
1455 static MultiAllocSingleReleasePool pool;
1458 Glib::Mutex midi_lock;
1459 pthread_t midi_thread;
1460 int midi_request_pipe[2];
1461 mutable gint butler_active;
1462 RingBuffer<MIDIRequest*> midi_requests;
1464 int start_midi_thread ();
1465 void terminate_midi_thread ();
1466 void poke_midi_thread ();
1467 static void *_midi_thread_work (void *arg);
1468 void midi_thread_work ();
1469 void change_midi_ports ();
1470 int use_config_midi_ports ();
1472 bool waiting_to_start;
1474 void set_auto_loop (bool yn);
1475 void overwrite_some_buffers (Diskstream*);
1476 void flush_all_redirects ();
1477 void locate (jack_nframes_t, bool with_roll, bool with_flush, bool with_loop=false);
1478 void start_locate (jack_nframes_t, bool with_roll, bool with_flush, bool with_loop=false);
1479 void force_locate (jack_nframes_t frame, bool with_roll = false);
1480 void set_diskstream_speed (Diskstream*, float speed);
1481 void set_transport_speed (float speed, bool abort = false);
1482 void stop_transport (bool abort = false);
1483 void start_transport ();
1484 void actually_start_transport ();
1485 void realtime_stop (bool abort);
1486 void non_realtime_start_scrub ();
1487 void non_realtime_set_speed ();
1488 void non_realtime_stop (bool abort);
1489 void non_realtime_overwrite ();
1490 void non_realtime_buffer_fill ();
1491 void butler_transport_work ();
1492 void post_transport ();
1493 void engine_halted ();
1494 void xrun_recovery ();
1496 TempoMap *_tempo_map;
1497 void tempo_map_changed (Change);
1499 /* edit/mix groups */
1501 int load_route_groups (const XMLNode&, bool is_edit);
1502 int load_edit_groups (const XMLNode&);
1503 int load_mix_groups (const XMLNode&);
1506 list<RouteGroup *> edit_groups;
1507 list<RouteGroup *> mix_groups;
1511 SerializedRCUManager<DiskstreamList> diskstreams;
1513 uint32_t dstream_buffer_size;
1514 int load_diskstreams (const XMLNode&);
1518 SerializedRCUManager<RouteList> routes;
1520 void add_routes (RouteList&, bool save = true);
1521 uint32_t destructive_index;
1523 int load_routes (const XMLNode&);
1524 boost::shared_ptr<Route> XMLRouteFactory (const XMLNode&);
1529 SoloModel _solo_model;
1530 bool solo_update_disabled;
1531 bool currently_soloing;
1533 void route_mute_changed (void *src);
1534 void route_solo_changed (void *src, boost::shared_ptr<Route>);
1535 void catch_up_on_solo ();
1536 void update_route_solo_state ();
1537 void modify_solo_mute (bool, bool);
1538 void strip_portname_for_solo (string& portname);
1540 /* REGION MANAGEMENT */
1542 mutable Glib::Mutex region_lock;
1543 typedef map<PBD::ID,AudioRegion *> AudioRegionList;
1544 AudioRegionList audio_regions;
1546 void region_renamed (Region *);
1547 void region_changed (Change, Region *);
1548 void add_region (Region *);
1549 void remove_region (Region *);
1551 int load_regions (const XMLNode& node);
1555 mutable Glib::Mutex audio_source_lock;
1556 typedef std::map<PBD::ID,AudioSource *> AudioSourceList;
1558 AudioSourceList audio_sources;
1560 int load_sources (const XMLNode& node);
1561 XMLNode& get_sources_as_xml ();
1563 Source *XMLSourceFactory (const XMLNode&);
1567 mutable Glib::Mutex playlist_lock;
1568 typedef set<Playlist *> PlaylistList;
1569 PlaylistList playlists;
1570 PlaylistList unused_playlists;
1572 int load_playlists (const XMLNode&);
1573 int load_unused_playlists (const XMLNode&);
1574 void remove_playlist (Playlist *);
1575 void track_playlist (Playlist *, bool);
1577 Playlist *playlist_factory (string name);
1578 Playlist *XMLPlaylistFactory (const XMLNode&);
1580 void playlist_length_changed (Playlist *);
1581 void diskstream_playlist_changed (boost::shared_ptr<Diskstream>);
1583 /* NAMED SELECTIONS */
1585 mutable Glib::Mutex named_selection_lock;
1586 typedef set<NamedSelection *> NamedSelectionList;
1587 NamedSelectionList named_selections;
1589 int load_named_selections (const XMLNode&);
1591 NamedSelection *named_selection_factory (string name);
1592 NamedSelection *XMLNamedSelectionFactory (const XMLNode&);
1594 /* CURVES and AUTOMATION LISTS */
1595 std::map<PBD::ID, Curve*> curves;
1596 std::map<PBD::ID, AutomationList*> automation_lists;
1598 /* DEFAULT FADE CURVES */
1600 float default_fade_steepness;
1601 float default_fade_msecs;
1605 boost::shared_ptr<Auditioner> auditioner;
1606 void set_audition (AudioRegion*);
1607 void non_realtime_set_audition ();
1608 AudioRegion *pending_audition_region;
1614 int flatten_one_track (AudioTrack&, jack_nframes_t start, jack_nframes_t cnt);
1616 /* INSERT AND SEND MANAGEMENT */
1618 list<PortInsert *> _port_inserts;
1619 list<PluginInsert *> _plugin_inserts;
1620 list<Send *> _sends;
1622 uint32_t insert_cnt;
1624 void add_redirect (Redirect *);
1625 void remove_redirect (Redirect *);
1629 struct space_and_path {
1630 uint32_t blocks; /* 4kB blocks */
1638 struct space_and_path_ascending_cmp {
1639 bool operator() (space_and_path a, space_and_path b) {
1640 return a.blocks > b.blocks;
1644 void setup_raid_path (string path);
1646 vector<space_and_path> session_dirs;
1647 vector<space_and_path>::iterator last_rr_session_dir;
1648 uint32_t _total_free_4k_blocks;
1649 Glib::Mutex space_lock;
1651 static const char* sound_dir_name;
1652 static const char* tape_dir_name;
1653 static const char* dead_sound_dir_name;
1654 static const char* peak_dir_name;
1656 string discover_best_sound_dir (bool destructive = false);
1657 int ensure_sound_dir (string, string&);
1658 void refresh_disk_space ();
1660 mutable gint _playback_load;
1661 mutable gint _capture_load;
1662 mutable gint _playback_load_min;
1663 mutable gint _capture_load_min;
1665 /* I/O Connections */
1667 typedef list<Connection *> ConnectionList;
1668 mutable Glib::Mutex connection_lock;
1669 ConnectionList _connections;
1670 int load_connections (const XMLNode&);
1672 int set_slave_source (SlaveSource, jack_nframes_t);
1674 void reverse_diskstream_buffers ();
1676 UndoHistory history;
1677 UndoTransaction current_trans;
1679 GlobalRouteBooleanState get_global_route_boolean (bool (Route::*method)(void) const);
1680 GlobalRouteMeterState get_global_route_metering ();
1682 void set_global_route_boolean (GlobalRouteBooleanState s, void (Route::*method)(bool, void*), void *arg);
1683 void set_global_route_metering (GlobalRouteMeterState s, void *arg);
1685 void set_global_mute (GlobalRouteBooleanState s, void *src);
1686 void set_global_solo (GlobalRouteBooleanState s, void *src);
1687 void set_global_record_enable (GlobalRouteBooleanState s, void *src);
1689 void jack_timebase_callback (jack_transport_state_t, jack_nframes_t, jack_position_t*, int);
1690 int jack_sync_callback (jack_transport_state_t, jack_position_t*);
1691 void record_enable_change_all (bool yn);
1693 XMLNode& state(bool);
1698 jack_nframes_t start;
1699 jack_nframes_t duration;
1700 jack_nframes_t offset;
1703 Click (jack_nframes_t s, jack_nframes_t d, const Sample *b)
1704 : start (s), duration (d), data (b) { offset = 0; }
1706 void *operator new(size_t ignored) {
1707 return pool.alloc ();
1710 void operator delete(void *ptr, size_t size) {
1718 typedef list<Click*> Clicks;
1722 boost::shared_ptr<IO> _click_io;
1724 Sample* click_emphasis_data;
1725 jack_nframes_t click_length;
1726 jack_nframes_t click_emphasis_length;
1727 mutable Glib::RWLock click_lock;
1729 static const Sample default_click[];
1730 static const jack_nframes_t default_click_length;
1731 static const Sample default_click_emphasis[];
1732 static const jack_nframes_t default_click_emphasis_length;
1735 void setup_click_sounds (int which);
1736 void clear_clicks ();
1737 void click (jack_nframes_t start, jack_nframes_t nframes, jack_nframes_t offset);
1739 vector<Route*> master_outs;
1741 EditMode _edit_mode;
1742 EditMode pending_edit_mode;
1744 /* range playback */
1746 list<AudioRange> current_audio_range;
1748 void set_play_range (bool yn);
1749 void setup_auto_play ();
1754 boost::shared_ptr<IO> _master_out;
1755 boost::shared_ptr<IO> _control_out;
1757 AutoConnectOption input_auto_connect;
1758 AutoConnectOption output_auto_connect;
1760 gain_t* _gain_automation_buffer;
1761 pan_t** _pan_automation_buffer;
1762 void allocate_pan_automation_buffers (jack_nframes_t nframes, uint32_t howmany, bool force);
1763 uint32_t _npan_buffers;
1767 long _vst_callback (VSTPlugin*,
1774 /* number of hardware audio ports we're using,
1775 based on max (requested,available)
1778 uint32_t n_physical_outputs;
1779 uint32_t n_physical_inputs;
1781 void remove_pending_capture_state ();
1783 int find_all_sources (std::string path, std::set<std::string>& result);
1784 int find_all_sources_across_snapshots (std::set<std::string>& result, bool exclude_this_snapshot);
1786 LayerModel layer_model;
1787 CrossfadeModel xfade_model;
1789 typedef std::list<PBD::Controllable*> Controllables;
1790 Glib::Mutex controllables_lock;
1791 Controllables controllables;
1793 void add_controllable (PBD::Controllable*);
1794 void remove_controllable (PBD::Controllable*);
1797 } // namespace ARDOUR
1799 #endif /* __ardour_session_h__ */