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 Diskstream* diskstream_by_id (const PBD::ID& id);
274 Diskstream* diskstream_by_name (string name);
276 bool have_captured() const { return _have_captured; }
278 void refill_all_diskstream_buffers ();
279 uint32_t diskstream_buffer_size() const { return dstream_buffer_size; }
281 uint32_t get_next_diskstream_id() const { return n_diskstreams(); }
282 uint32_t n_diskstreams() const;
284 typedef list<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_remote_id (uint32_t id);
307 bool route_name_unique (string) const;
309 bool get_record_enabled() const {
310 return (record_status () >= Enabled);
313 RecordState record_status() const {
314 return (RecordState) g_atomic_int_get (&_record_status);
317 bool actively_recording () {
318 return record_status() == Recording;
321 bool record_enabling_legal () const;
322 void maybe_enable_record ();
323 void disable_record (bool rt_context, bool force = false);
324 void step_back_from_record ();
326 sigc::signal<void> going_away;
328 /* Proxy signal for region hidden changes */
330 sigc::signal<void,Region*> RegionHiddenChange;
332 /* Emitted when all i/o connections are complete */
334 sigc::signal<void> IOConnectionsComplete;
336 /* Record status signals */
338 sigc::signal<void> RecordStateChanged;
340 /* Transport mechanism signals */
342 sigc::signal<void> TransportStateChange; /* generic */
343 sigc::signal<void,jack_nframes_t> PositionChanged; /* sent after any non-sequential motion */
344 sigc::signal<void> DurationChanged;
345 sigc::signal<void> HaltOnXrun;
347 sigc::signal<void,boost::shared_ptr<Route> > RouteAdded;
348 sigc::signal<void,Diskstream*> DiskstreamAdded; // FIXME: make a shared_ptr
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);
482 static int rename_template (string old_name, string new_name);
484 static int delete_template (string name);
486 sigc::signal<void,string> StateSaved;
487 sigc::signal<void> StateReady;
489 vector<string*>* possible_states() const;
490 static vector<string*>* possible_states(string path);
492 XMLNode& get_state();
493 int set_state(const XMLNode& node); // not idempotent
494 XMLNode& get_template();
496 void add_instant_xml (XMLNode&, const std::string& dir);
498 enum StateOfTheState {
503 InitialConnecting = 0x8,
508 StateOfTheState state_of_the_state() const { return _state_of_the_state; }
510 RouteGroup* add_edit_group (string);
511 RouteGroup* add_mix_group (string);
513 void remove_edit_group (RouteGroup&);
514 void remove_mix_group (RouteGroup&);
516 RouteGroup *mix_group_by_name (string);
517 RouteGroup *edit_group_by_name (string);
519 sigc::signal<void,RouteGroup*> edit_group_added;
520 sigc::signal<void,RouteGroup*> mix_group_added;
521 sigc::signal<void> edit_group_removed;
522 sigc::signal<void> mix_group_removed;
524 void foreach_edit_group (sigc::slot<void,RouteGroup*> sl) {
525 for (list<RouteGroup *>::iterator i = edit_groups.begin(); i != edit_groups.end(); i++) {
530 void foreach_mix_group (sigc::slot<void,RouteGroup*> sl) {
531 for (list<RouteGroup *>::iterator i = mix_groups.begin(); i != mix_groups.end(); i++) {
536 /* fundamental operations. duh. */
538 boost::shared_ptr<AudioTrack> new_audio_track (int input_channels, int output_channels, TrackMode mode = Normal);
539 boost::shared_ptr<Route> new_audio_route (int input_channels, int output_channels);
541 void remove_route (boost::shared_ptr<Route>);
543 void resort_routes ();
544 void resort_routes_using (boost::shared_ptr<RouteList>);
546 AudioEngine &engine() { return _engine; };
548 /* configuration. there should really be accessors/mutators
552 float meter_hold () { return _meter_hold; }
553 void set_meter_hold (float);
554 sigc::signal<void> MeterHoldChanged;
556 float meter_falloff () { return _meter_falloff; }
557 void set_meter_falloff (float);
558 sigc::signal<void> MeterFalloffChanged;
562 string click_emphasis_sound;
564 bool click_requested;
565 jack_nframes_t over_length_short;
566 jack_nframes_t over_length_long;
567 bool send_midi_timecode;
568 bool send_midi_machine_control;
569 float shuttle_speed_factor;
570 float shuttle_speed_threshold;
572 float smpte_frames_per_second;
573 bool smpte_drop_frames;
579 jack_nframes_t transport_frame () const {return _transport_frame; }
580 jack_nframes_t audible_frame () const;
582 int set_smpte_type (float fps, bool drop_frames);
584 void bbt_time (jack_nframes_t when, BBT_Time&);
585 void smpte_to_sample( SMPTE::Time& smpte, jack_nframes_t& sample, bool use_offset, bool use_subframes ) const;
586 void sample_to_smpte( jack_nframes_t sample, SMPTE::Time& smpte, bool use_offset, bool use_subframes ) const;
587 void smpte_time (SMPTE::Time &);
588 void smpte_time (jack_nframes_t when, SMPTE::Time&);
589 void smpte_time_subframes (jack_nframes_t when, SMPTE::Time&);
591 void smpte_duration (jack_nframes_t, SMPTE::Time&) const;
592 void smpte_duration_string (char *, jack_nframes_t) const;
594 void set_smpte_offset (jack_nframes_t);
595 jack_nframes_t smpte_offset () const { return _smpte_offset; }
596 void set_smpte_offset_negative (bool);
597 bool smpte_offset_negative () const { return _smpte_offset_negative; }
599 jack_nframes_t convert_to_frames_at (jack_nframes_t position, AnyTime&);
601 static sigc::signal<void> SMPTEOffsetChanged;
602 sigc::signal<void> SMPTETypeChanged;
604 void request_slave_source (SlaveSource, jack_nframes_t pos = 0);
605 SlaveSource slave_source() const { return _slave_type; }
606 bool synced_to_jack() const { return _slave_type == JACK; }
607 float transport_speed() const { return _transport_speed; }
608 bool transport_stopped() const { return _transport_speed == 0.0f; }
609 bool transport_rolling() const { return _transport_speed != 0.0f; }
611 int jack_slave_sync (jack_nframes_t);
613 TempoMap& tempo_map() { return *_tempo_map; }
617 sigc::signal<void,AudioRegion *> AudioRegionAdded;
618 sigc::signal<void,AudioRegion *> AudioRegionRemoved;
620 int region_name (string& result, string base = string(""), bool newlevel = false) const;
621 string new_region_name (string);
622 string path_from_region_name (string name, string identifier);
624 AudioRegion* find_whole_file_parent (AudioRegion&);
625 void find_equivalent_playlist_regions (Region&, std::vector<Region*>& result);
627 AudioRegion *XMLRegionFactory (const XMLNode&, bool full);
629 template<class T> void foreach_audio_region (T *obj, void (T::*func)(AudioRegion *));
631 /* source management */
633 struct import_status : public InterThreadInfo {
639 volatile bool freeze;
643 std::vector<AudioRegion*> new_regions;
647 int import_audiofile (import_status&);
648 bool sample_rate_convert (import_status&, string infile, string& outfile);
649 string build_tmp_convert_name (string file);
651 Session::SlaveSource post_export_slave;
652 jack_nframes_t post_export_position;
654 int start_audio_export (ARDOUR::AudioExportSpecification&);
655 int stop_audio_export (ARDOUR::AudioExportSpecification&);
657 void add_audio_source (AudioSource *);
658 void remove_source (Source *);
659 int cleanup_audio_file_source (AudioFileSource&);
661 struct cleanup_report {
662 vector<string> paths;
666 int cleanup_sources (cleanup_report&);
667 int cleanup_trash_sources (cleanup_report&);
669 int destroy_region (Region*);
670 int destroy_regions (list<Region*>);
672 int remove_last_capture ();
674 /* handlers should return -1 for "stop cleanup", 0 for
675 "yes, delete this playlist" and 1 for "no, don't delete
679 sigc::signal<int,ARDOUR::Playlist*> AskAboutPlaylistDeletion;
682 /* handlers should return !0 for use pending state, 0 for
686 static sigc::signal<int> AskAboutPendingState;
688 sigc::signal<void,Source *> SourceAdded;
689 sigc::signal<void,Source *> SourceRemoved;
691 AudioFileSource *create_audio_source_for_session (ARDOUR::AudioDiskstream&, uint32_t which_channel, bool destructive);
693 Source *source_by_id (const PBD::ID&);
695 /* playlist management */
697 Playlist* playlist_by_name (string name);
698 void add_playlist (Playlist *);
699 sigc::signal<void,Playlist*> PlaylistAdded;
700 sigc::signal<void,Playlist*> PlaylistRemoved;
702 uint32_t n_playlists() const;
704 template<class T> void foreach_playlist (T *obj, void (T::*func)(Playlist *));
706 /* named selections */
708 NamedSelection* named_selection_by_name (string name);
709 void add_named_selection (NamedSelection *);
710 void remove_named_selection (NamedSelection *);
712 template<class T> void foreach_named_selection (T& obj, void (T::*func)(NamedSelection&));
713 sigc::signal<void> NamedSelectionAdded;
714 sigc::signal<void> NamedSelectionRemoved;
718 float get_default_fade_length () const { return default_fade_msecs; }
719 float get_default_fade_steepness () const { return default_fade_steepness; }
720 void set_default_fade (float steepness, float msecs);
724 boost::shared_ptr<Auditioner> the_auditioner() { return auditioner; }
725 void audition_playlist ();
726 void audition_region (Region&);
727 void cancel_audition ();
728 bool is_auditioning () const;
730 sigc::signal<void,bool> AuditionActive;
732 /* flattening stuff */
734 int write_one_audio_track (AudioTrack&, jack_nframes_t start, jack_nframes_t cnt, bool overwrite, vector<AudioSource*>&,
735 InterThreadInfo& wot);
736 int freeze (InterThreadInfo&);
738 /* session-wide solo/mute/rec-enable */
745 bool soloing() const { return currently_soloing; }
747 SoloModel solo_model() const { return _solo_model; }
748 void set_solo_model (SoloModel);
750 bool solo_latched() const { return _solo_latched; }
751 void set_solo_latched (bool yn);
753 void set_all_solo (bool);
754 void set_all_mute (bool);
756 sigc::signal<void,bool> SoloActive;
758 void record_disenable_all ();
759 void record_enable_all ();
761 /* control/master out */
763 boost::shared_ptr<IO> control_out() const { return _control_out; }
764 boost::shared_ptr<IO> master_out() const { return _master_out; }
766 /* insert/send management */
768 uint32_t n_port_inserts() const { return _port_inserts.size(); }
769 uint32_t n_plugin_inserts() const { return _plugin_inserts.size(); }
770 uint32_t n_sends() const { return _sends.size(); }
772 string next_send_name();
773 string next_insert_name();
775 /* s/w "RAID" management */
777 jack_nframes_t available_capture_duration();
779 /* I/O Connections */
781 template<class T> void foreach_connection (T *obj, void (T::*func)(Connection *));
782 void add_connection (Connection *);
783 void remove_connection (Connection *);
784 Connection *connection_by_name (string) const;
786 sigc::signal<void,Connection *> ConnectionAdded;
787 sigc::signal<void,Connection *> ConnectionRemoved;
791 int set_mtc_port (string port_tag);
792 int set_mmc_port (string port_tag);
793 int set_midi_port (string port_tag);
794 MIDI::Port *mtc_port() const { return _mtc_port; }
795 MIDI::Port *mmc_port() const { return _mmc_port; }
796 MIDI::Port *midi_port() const { return _midi_port; }
798 sigc::signal<void> MTC_PortChanged;
799 sigc::signal<void> MMC_PortChanged;
800 sigc::signal<void> MIDI_PortChanged;
802 void set_trace_midi_input (bool, MIDI::Port* port = 0);
803 void set_trace_midi_output (bool, MIDI::Port* port = 0);
805 bool get_trace_midi_input(MIDI::Port *port = 0);
806 bool get_trace_midi_output(MIDI::Port *port = 0);
808 void send_midi_message (MIDI::Port * port, MIDI::eventType ev, MIDI::channel_t, MIDI::EventTwoBytes);
810 void deliver_midi (MIDI::Port*, MIDI::byte*, int32_t size);
814 void start_scrub (jack_nframes_t where);
816 void set_scrub_speed (float);
817 jack_nframes_t scrub_buffer_size() const;
818 sigc::signal<void> ScrubReady;
820 /* History (for editors, mixers, UIs etc.) */
822 void undo (uint32_t n) {
825 void redo (uint32_t n) {
829 uint32_t undo_depth() const { return history.undo_depth(); }
830 uint32_t redo_depth() const { return history.redo_depth(); }
831 string next_undo() const { return history.next_undo(); }
832 string next_redo() const { return history.next_redo(); }
834 void begin_reversible_command (string cmd_name);
835 void commit_reversible_command (Command* cmd = 0);
837 void add_command (Command *const cmd) {
838 current_trans.add_command (cmd);
841 // these commands are implemented in libs/ardour/session_command.cc
842 Command *memento_command_factory(XMLNode *n);
843 class GlobalSoloStateCommand : public Command
845 GlobalRouteBooleanState before, after;
849 GlobalSoloStateCommand(Session &, void *src);
852 XMLNode &get_state();
856 class GlobalMuteStateCommand : public Command
858 GlobalRouteBooleanState before, after;
862 GlobalMuteStateCommand(Session &, void *src);
865 XMLNode &get_state();
869 class GlobalRecordEnableStateCommand : public Command
871 GlobalRouteBooleanState before, after;
875 GlobalRecordEnableStateCommand(Session &, void *src);
878 XMLNode &get_state();
882 class GlobalMeteringStateCommand : public Command
884 GlobalRouteMeterState before, after;
888 GlobalMeteringStateCommand(Session &, void *src);
891 XMLNode &get_state();
897 void set_edit_mode (EditMode);
898 EditMode get_edit_mode () const { return _edit_mode; }
902 boost::shared_ptr<IO> click_io() { return _click_io; }
903 void set_clicking (bool yn);
904 bool get_clicking() const;
906 void set_click_sound (string path);
907 void set_click_emphasis_sound (string path);
911 struct TimeStretchRequest {
912 ARDOUR::AudioRegion* region;
913 float fraction; /* session: read ; GUI: write */
914 float progress; /* session: write ; GUI: read */
915 bool running; /* read/write */
916 bool quick_seek; /* GUI: write */
917 bool antialias; /* GUI: write */
919 TimeStretchRequest () : region (0) {}
922 AudioRegion* tempoize_region (TimeStretchRequest&);
924 string raid_path() const;
925 void set_raid_path(string);
927 /* need to call this whenever we change native file formats */
929 void reset_native_file_format();
931 /* disk, buffer loads */
933 uint32_t playback_load ();
934 uint32_t capture_load ();
935 uint32_t playback_load_min ();
936 uint32_t capture_load_min ();
938 void reset_playback_load_min ();
939 void reset_capture_load_min ();
941 float read_data_rate () const;
942 float write_data_rate () const;
946 void set_audio_range (list<AudioRange>&);
947 void set_music_range (list<MusicRange>&);
949 void request_play_range (bool yn);
950 bool get_play_range () const { return _play_range; }
953 typedef vector<string> FavoriteDirs;
955 static int read_favorite_dirs (FavoriteDirs&);
957 static int write_favorite_dirs (FavoriteDirs&);
961 static const char* template_suffix() { return _template_suffix; }
962 static const char* statefile_suffix() { return _statefile_suffix; }
963 static const char* pending_suffix() { return _pending_suffix; }
965 /* buffers for gain and pan */
967 gain_t* gain_automation_buffer () const { return _gain_automation_buffer; }
968 pan_t** pan_automation_buffer() const { return _pan_automation_buffer; }
970 /* buffers for conversion */
979 static long vst_callback (AEffect* effect,
986 typedef float (*compute_peak_t) (Sample *, jack_nframes_t, float);
987 typedef void (*apply_gain_to_buffer_t) (Sample *, jack_nframes_t, float);
988 typedef void (*mix_buffers_with_gain_t) (Sample *, Sample *, jack_nframes_t, float);
989 typedef void (*mix_buffers_no_gain_t) (Sample *, Sample *, jack_nframes_t);
991 static compute_peak_t compute_peak;
992 static apply_gain_to_buffer_t apply_gain_to_buffer;
993 static mix_buffers_with_gain_t mix_buffers_with_gain;
994 static mix_buffers_no_gain_t mix_buffers_no_gain;
996 static sigc::signal<void> SendFeedback;
1000 PBD::Controllable* controllable_by_id (const PBD::ID&);
1003 friend class AudioEngine;
1004 void set_block_size (jack_nframes_t nframes);
1005 void set_frame_rate (jack_nframes_t nframes);
1008 friend class Diskstream;
1009 void stop_butler ();
1010 void wait_till_butler_finished();
1014 void schedule_curve_reallocation ();
1015 void update_latency_compensation (bool, bool);
1018 int create (bool& new_session, string* mix_template, jack_nframes_t initial_length);
1020 static const char* _template_suffix;
1021 static const char* _statefile_suffix;
1022 static const char* _pending_suffix;
1025 PendingDeclickIn = 0x1,
1026 PendingDeclickOut = 0x2,
1027 StopPendingCapture = 0x4,
1028 AutoReturning = 0x10,
1029 PendingLocate = 0x20,
1030 PendingSetLoop = 0x40
1033 /* stuff used in process() should be close together to
1037 typedef void (Session::*process_function_type)(jack_nframes_t);
1039 AudioEngine &_engine;
1040 mutable gint processing_prohibited;
1041 process_function_type process_function;
1042 process_function_type last_process_function;
1043 jack_nframes_t _current_frame_rate;
1044 int transport_sub_state;
1045 mutable gint _record_status;
1046 jack_nframes_t _transport_frame;
1047 Location* end_location;
1048 Location* start_location;
1050 SlaveSource _slave_type;
1051 volatile float _transport_speed;
1052 volatile float _desired_transport_speed;
1053 float _last_transport_speed;
1054 jack_nframes_t _last_slave_transport_frame;
1055 jack_nframes_t maximum_output_latency;
1056 jack_nframes_t last_stop_frame;
1057 vector<Sample *> _passthru_buffers;
1058 vector<Sample *> _silent_buffers;
1059 vector<Sample *> _send_buffers;
1060 jack_nframes_t current_block_size;
1061 jack_nframes_t _worst_output_latency;
1062 jack_nframes_t _worst_input_latency;
1063 jack_nframes_t _worst_track_latency;
1064 bool _have_captured;
1066 float _meter_falloff;
1067 bool _end_location_is_free;
1069 void set_worst_io_latencies ();
1070 void set_worst_io_latencies_x (IOChange asifwecare, void *ignored) {
1071 set_worst_io_latencies ();
1074 void update_latency_compensation_proxy (void* ignored);
1076 void ensure_passthru_buffers (uint32_t howmany);
1078 void process_scrub (jack_nframes_t);
1079 void process_without_events (jack_nframes_t);
1080 void process_with_events (jack_nframes_t);
1081 void process_audition (jack_nframes_t);
1082 int process_export (jack_nframes_t, ARDOUR::AudioExportSpecification*);
1084 /* slave tracking */
1086 static const int delta_accumulator_size = 25;
1087 int delta_accumulator_cnt;
1088 long delta_accumulator[delta_accumulator_size];
1089 long average_slave_delta;
1091 bool have_first_delta_accumulator;
1099 SlaveState slave_state;
1100 jack_nframes_t slave_wait_end;
1102 void reset_slave_state ();
1103 bool follow_slave (jack_nframes_t, jack_nframes_t);
1106 int prepare_to_export (ARDOUR::AudioExportSpecification&);
1108 void prepare_diskstreams ();
1109 void commit_diskstreams (jack_nframes_t, bool& session_requires_butler);
1110 int process_routes (jack_nframes_t, jack_nframes_t);
1111 int silent_process_routes (jack_nframes_t, jack_nframes_t);
1113 bool get_rec_monitors_input () {
1114 if (actively_recording()) {
1125 int get_transport_declick_required () {
1127 if (transport_sub_state & PendingDeclickIn) {
1128 transport_sub_state &= ~PendingDeclickIn;
1130 } else if (transport_sub_state & PendingDeclickOut) {
1137 bool maybe_stop (jack_nframes_t limit) {
1138 if ((_transport_speed > 0.0f && _transport_frame >= limit) || (_transport_speed < 0.0f && _transport_frame == 0)) {
1145 void check_declick_out ();
1147 MIDI::MachineControl* mmc;
1148 MIDI::Port* _mmc_port;
1149 MIDI::Port* _mtc_port;
1150 MIDI::Port* _midi_port;
1153 bool do_not_record_plugins;
1163 jack_nframes_t last_loopend;
1165 bool crossfades_active;
1174 RingBuffer<Event*> pending_events;
1177 void when_engine_running ();
1178 sigc::connection first_time_running;
1179 void graph_reordered ();
1181 string _current_snapshot_name;
1183 XMLTree* state_tree;
1184 bool state_was_pending;
1185 StateOfTheState _state_of_the_state;
1188 int load_options (const XMLNode&);
1189 XMLNode& get_options () const;
1190 int load_state (string snapshot_name);
1192 jack_nframes_t _last_roll_location;
1193 jack_nframes_t _last_record_location;
1194 bool pending_locate_roll;
1195 jack_nframes_t pending_locate_frame;
1197 bool pending_locate_flush;
1199 bool pending_auto_loop;
1201 Sample* butler_mixdown_buffer;
1202 float* butler_gain_buffer;
1203 pthread_t butler_thread;
1204 Glib::Mutex butler_request_lock;
1205 Glib::Cond butler_paused;
1206 bool butler_should_run;
1207 mutable gint butler_should_do_transport_work;
1208 int butler_request_pipe[2];
1210 struct ButlerRequest {
1219 enum PostTransportWork {
1220 PostTransportStop = 0x1,
1221 PostTransportDisableRecord = 0x2,
1222 PostTransportPosition = 0x8,
1223 PostTransportDidRecord = 0x20,
1224 PostTransportDuration = 0x40,
1225 PostTransportLocate = 0x80,
1226 PostTransportRoll = 0x200,
1227 PostTransportAbort = 0x800,
1228 PostTransportOverWrite = 0x1000,
1229 PostTransportSpeed = 0x2000,
1230 PostTransportAudition = 0x4000,
1231 PostTransportScrub = 0x8000,
1232 PostTransportReverse = 0x10000,
1233 PostTransportInputChange = 0x20000,
1234 PostTransportCurveRealloc = 0x40000
1237 static const PostTransportWork ProcessCannotProceedMask =
1238 PostTransportWork (PostTransportInputChange|
1240 PostTransportReverse|
1241 PostTransportCurveRealloc|
1243 PostTransportAudition|
1244 PostTransportLocate|
1247 PostTransportWork post_transport_work;
1249 void summon_butler ();
1250 void schedule_butler_transport_work ();
1251 int start_butler_thread ();
1252 void terminate_butler_thread ();
1253 static void *_butler_thread_work (void *arg);
1254 void* butler_thread_work ();
1256 uint32_t cumulative_rf_motion;
1259 void set_rf_speed (float speed);
1260 void reset_rf_scale (jack_nframes_t frames_moved);
1262 Locations _locations;
1263 void locations_changed ();
1264 void locations_added (Location*);
1265 void handle_locations_changed (Locations::LocationList&);
1267 sigc::connection auto_punch_start_changed_connection;
1268 sigc::connection auto_punch_end_changed_connection;
1269 sigc::connection auto_punch_changed_connection;
1270 void auto_punch_start_changed (Location *);
1271 void auto_punch_end_changed (Location *);
1272 void auto_punch_changed (Location *);
1274 sigc::connection auto_loop_start_changed_connection;
1275 sigc::connection auto_loop_end_changed_connection;
1276 sigc::connection auto_loop_changed_connection;
1277 void auto_loop_changed (Location *);
1279 typedef list<Event *> Events;
1281 Events immediate_events;
1282 Events::iterator next_event;
1284 /* there can only ever be one of each of these */
1286 Event *auto_loop_event;
1287 Event *punch_out_event;
1288 Event *punch_in_event;
1292 void dump_events () const;
1293 void queue_event (Event *ev);
1294 void merge_event (Event*);
1295 void replace_event (Event::Type, jack_nframes_t action_frame, jack_nframes_t target = 0);
1296 bool _replace_event (Event*);
1297 bool _remove_event (Event *);
1298 void _clear_event_type (Event::Type);
1300 void first_stage_init (string path, string snapshot_name);
1301 int second_stage_init (bool new_tracks);
1302 void find_current_end ();
1303 void remove_empty_sounds ();
1305 void setup_midi_control ();
1306 int midi_read (MIDI::Port *);
1308 void enable_record ();
1310 void increment_transport_position (uint32_t val) {
1311 if (max_frames - val < _transport_frame) {
1312 _transport_frame = max_frames;
1314 _transport_frame += val;
1318 void decrement_transport_position (uint32_t val) {
1319 if (val < _transport_frame) {
1320 _transport_frame -= val;
1322 _transport_frame = 0;
1326 void post_transport_motion ();
1327 static void *session_loader_thread (void *arg);
1331 void set_next_event ();
1332 void process_event (Event *);
1334 /* MIDI Machine Control */
1336 void deliver_mmc (MIDI::MachineControl::Command, jack_nframes_t);
1337 void deliver_midi_message (MIDI::Port * port, MIDI::eventType ev, MIDI::channel_t, MIDI::EventTwoBytes);
1338 void deliver_data (MIDI::Port* port, MIDI::byte*, int32_t size);
1340 void spp_start (MIDI::Parser&);
1341 void spp_continue (MIDI::Parser&);
1342 void spp_stop (MIDI::Parser&);
1344 void mmc_deferred_play (MIDI::MachineControl &);
1345 void mmc_stop (MIDI::MachineControl &);
1346 void mmc_step (MIDI::MachineControl &, int);
1347 void mmc_pause (MIDI::MachineControl &);
1348 void mmc_record_pause (MIDI::MachineControl &);
1349 void mmc_record_strobe (MIDI::MachineControl &);
1350 void mmc_record_exit (MIDI::MachineControl &);
1351 void mmc_track_record_status (MIDI::MachineControl &,
1352 uint32_t track, bool enabled);
1353 void mmc_fast_forward (MIDI::MachineControl &);
1354 void mmc_rewind (MIDI::MachineControl &);
1355 void mmc_locate (MIDI::MachineControl &, const MIDI::byte *);
1356 void mmc_shuttle (MIDI::MachineControl &mmc, float speed, bool forw);
1357 void mmc_record_enable (MIDI::MachineControl &mmc, size_t track, bool enabled);
1359 struct timeval last_mmc_step;
1362 typedef sigc::slot<bool> MidiTimeoutCallback;
1363 typedef list<MidiTimeoutCallback> MidiTimeoutList;
1365 MidiTimeoutList midi_timeouts;
1366 bool mmc_step_timeout ();
1368 MIDI::byte mmc_buffer[32];
1369 MIDI::byte mtc_msg[16];
1370 MIDI::byte mtc_smpte_bits; /* encoding of SMTPE type for MTC */
1371 MIDI::byte midi_msg[16];
1372 jack_nframes_t outbound_mtc_smpte_frame;
1373 SMPTE::Time transmitting_smpte_time;
1374 int next_quarter_frame_to_send;
1376 double _frames_per_smpte_frame; /* has to be floating point because of drop frame */
1377 jack_nframes_t _frames_per_hour;
1378 jack_nframes_t _smpte_frames_per_hour;
1379 jack_nframes_t _smpte_offset;
1380 bool _smpte_offset_negative;
1382 /* cache the most-recently requested time conversions.
1383 this helps when we have multiple clocks showing the
1384 same time (e.g. the transport frame)
1387 bool last_smpte_valid;
1388 jack_nframes_t last_smpte_when;
1389 SMPTE::Time last_smpte;
1391 int send_full_time_code ();
1392 int send_midi_time_code ();
1394 void send_full_time_code_in_another_thread ();
1395 void send_midi_time_code_in_another_thread ();
1396 void send_time_code_in_another_thread (bool full);
1397 void send_mmc_in_another_thread (MIDI::MachineControl::Command, jack_nframes_t frame = 0);
1399 jack_nframes_t adjust_apparent_position (jack_nframes_t frames);
1401 void reset_record_status ();
1403 int no_roll (jack_nframes_t nframes, jack_nframes_t offset);
1405 bool non_realtime_work_pending() const { return static_cast<bool>(post_transport_work); }
1406 bool process_can_proceed() const { return !(post_transport_work & ProcessCannotProceedMask); }
1408 struct MIDIRequest {
1421 MIDI::MachineControl::Command mmc_cmd;
1422 jack_nframes_t locate_frame;
1424 // for SendMessage type
1427 MIDI::channel_t chan;
1429 MIDI::EventTwoBytes data;
1440 void *operator new(size_t ignored) {
1441 return pool.alloc ();
1444 void operator delete(void *ptr, size_t size) {
1449 static MultiAllocSingleReleasePool pool;
1452 Glib::Mutex midi_lock;
1453 pthread_t midi_thread;
1454 int midi_request_pipe[2];
1455 mutable gint butler_active;
1456 RingBuffer<MIDIRequest*> midi_requests;
1458 int start_midi_thread ();
1459 void terminate_midi_thread ();
1460 void poke_midi_thread ();
1461 static void *_midi_thread_work (void *arg);
1462 void midi_thread_work ();
1463 void change_midi_ports ();
1464 int use_config_midi_ports ();
1466 bool waiting_to_start;
1468 void set_auto_loop (bool yn);
1469 void overwrite_some_buffers (Diskstream*);
1470 void flush_all_redirects ();
1471 void locate (jack_nframes_t, bool with_roll, bool with_flush, bool with_loop=false);
1472 void start_locate (jack_nframes_t, bool with_roll, bool with_flush, bool with_loop=false);
1473 void force_locate (jack_nframes_t frame, bool with_roll = false);
1474 void set_diskstream_speed (Diskstream*, float speed);
1475 void set_transport_speed (float speed, bool abort = false);
1476 void stop_transport (bool abort = false);
1477 void start_transport ();
1478 void actually_start_transport ();
1479 void realtime_stop (bool abort);
1480 void non_realtime_start_scrub ();
1481 void non_realtime_set_speed ();
1482 void non_realtime_stop (bool abort);
1483 void non_realtime_overwrite ();
1484 void non_realtime_buffer_fill ();
1485 void butler_transport_work ();
1486 void post_transport ();
1487 void engine_halted ();
1488 void xrun_recovery ();
1490 TempoMap *_tempo_map;
1491 void tempo_map_changed (Change);
1493 /* edit/mix groups */
1495 int load_route_groups (const XMLNode&, bool is_edit);
1496 int load_edit_groups (const XMLNode&);
1497 int load_mix_groups (const XMLNode&);
1500 list<RouteGroup *> edit_groups;
1501 list<RouteGroup *> mix_groups;
1505 DiskstreamList diskstreams;
1506 mutable Glib::RWLock diskstream_lock;
1507 uint32_t dstream_buffer_size;
1508 void add_diskstream (Diskstream*);
1509 int load_diskstreams (const XMLNode&);
1513 SerializedRCUManager<RouteList> routes;
1515 void add_route (boost::shared_ptr<Route>);
1516 uint32_t destructive_index;
1518 int load_routes (const XMLNode&);
1519 boost::shared_ptr<Route> XMLRouteFactory (const XMLNode&);
1524 SoloModel _solo_model;
1525 bool solo_update_disabled;
1526 bool currently_soloing;
1528 void route_mute_changed (void *src);
1529 void route_solo_changed (void *src, boost::shared_ptr<Route>);
1530 void catch_up_on_solo ();
1531 void update_route_solo_state ();
1532 void modify_solo_mute (bool, bool);
1533 void strip_portname_for_solo (string& portname);
1535 /* REGION MANAGEMENT */
1537 mutable Glib::Mutex region_lock;
1538 typedef map<PBD::ID,AudioRegion *> AudioRegionList;
1539 AudioRegionList audio_regions;
1541 void region_renamed (Region *);
1542 void region_changed (Change, Region *);
1543 void add_region (Region *);
1544 void remove_region (Region *);
1546 int load_regions (const XMLNode& node);
1550 mutable Glib::Mutex audio_source_lock;
1551 typedef std::map<PBD::ID,AudioSource *> AudioSourceList;
1553 AudioSourceList audio_sources;
1555 int load_sources (const XMLNode& node);
1556 XMLNode& get_sources_as_xml ();
1558 Source *XMLSourceFactory (const XMLNode&);
1562 mutable Glib::Mutex playlist_lock;
1563 typedef set<Playlist *> PlaylistList;
1564 PlaylistList playlists;
1565 PlaylistList unused_playlists;
1567 int load_playlists (const XMLNode&);
1568 int load_unused_playlists (const XMLNode&);
1569 void remove_playlist (Playlist *);
1570 void track_playlist (Playlist *, bool);
1572 Playlist *playlist_factory (string name);
1573 Playlist *XMLPlaylistFactory (const XMLNode&);
1575 void playlist_length_changed (Playlist *);
1576 void diskstream_playlist_changed (Diskstream *);
1578 /* NAMED SELECTIONS */
1580 mutable Glib::Mutex named_selection_lock;
1581 typedef set<NamedSelection *> NamedSelectionList;
1582 NamedSelectionList named_selections;
1584 int load_named_selections (const XMLNode&);
1586 NamedSelection *named_selection_factory (string name);
1587 NamedSelection *XMLNamedSelectionFactory (const XMLNode&);
1589 /* DEFAULT FADE CURVES */
1591 float default_fade_steepness;
1592 float default_fade_msecs;
1596 boost::shared_ptr<Auditioner> auditioner;
1597 void set_audition (AudioRegion*);
1598 void non_realtime_set_audition ();
1599 AudioRegion *pending_audition_region;
1605 int flatten_one_track (AudioTrack&, jack_nframes_t start, jack_nframes_t cnt);
1607 /* INSERT AND SEND MANAGEMENT */
1609 list<PortInsert *> _port_inserts;
1610 list<PluginInsert *> _plugin_inserts;
1611 list<Send *> _sends;
1613 uint32_t insert_cnt;
1615 void add_redirect (Redirect *);
1616 void remove_redirect (Redirect *);
1620 struct space_and_path {
1621 uint32_t blocks; /* 4kB blocks */
1629 struct space_and_path_ascending_cmp {
1630 bool operator() (space_and_path a, space_and_path b) {
1631 return a.blocks > b.blocks;
1635 void setup_raid_path (string path);
1637 vector<space_and_path> session_dirs;
1638 vector<space_and_path>::iterator last_rr_session_dir;
1639 uint32_t _total_free_4k_blocks;
1640 Glib::Mutex space_lock;
1642 static const char* sound_dir_name;
1643 static const char* tape_dir_name;
1644 static const char* dead_sound_dir_name;
1645 static const char* peak_dir_name;
1647 string discover_best_sound_dir (bool destructive = false);
1648 int ensure_sound_dir (string, string&);
1649 void refresh_disk_space ();
1651 mutable gint _playback_load;
1652 mutable gint _capture_load;
1653 mutable gint _playback_load_min;
1654 mutable gint _capture_load_min;
1656 /* I/O Connections */
1658 typedef list<Connection *> ConnectionList;
1659 mutable Glib::Mutex connection_lock;
1660 ConnectionList _connections;
1661 int load_connections (const XMLNode&);
1663 int set_slave_source (SlaveSource, jack_nframes_t);
1665 void reverse_diskstream_buffers ();
1667 UndoHistory history;
1668 UndoTransaction current_trans;
1670 GlobalRouteBooleanState get_global_route_boolean (bool (Route::*method)(void) const);
1671 GlobalRouteMeterState get_global_route_metering ();
1673 void set_global_route_boolean (GlobalRouteBooleanState s, void (Route::*method)(bool, void*), void *arg);
1674 void set_global_route_metering (GlobalRouteMeterState s, void *arg);
1676 void set_global_mute (GlobalRouteBooleanState s, void *src);
1677 void set_global_solo (GlobalRouteBooleanState s, void *src);
1678 void set_global_record_enable (GlobalRouteBooleanState s, void *src);
1680 void jack_timebase_callback (jack_transport_state_t, jack_nframes_t, jack_position_t*, int);
1681 int jack_sync_callback (jack_transport_state_t, jack_position_t*);
1682 void record_enable_change_all (bool yn);
1684 XMLNode& state(bool);
1689 jack_nframes_t start;
1690 jack_nframes_t duration;
1691 jack_nframes_t offset;
1694 Click (jack_nframes_t s, jack_nframes_t d, const Sample *b)
1695 : start (s), duration (d), data (b) { offset = 0; }
1697 void *operator new(size_t ignored) {
1698 return pool.alloc ();
1701 void operator delete(void *ptr, size_t size) {
1709 typedef list<Click*> Clicks;
1713 boost::shared_ptr<IO> _click_io;
1715 Sample* click_emphasis_data;
1716 jack_nframes_t click_length;
1717 jack_nframes_t click_emphasis_length;
1718 mutable Glib::RWLock click_lock;
1720 static const Sample default_click[];
1721 static const jack_nframes_t default_click_length;
1722 static const Sample default_click_emphasis[];
1723 static const jack_nframes_t default_click_emphasis_length;
1726 void setup_click_sounds (int which);
1727 void clear_clicks ();
1728 void click (jack_nframes_t start, jack_nframes_t nframes, jack_nframes_t offset);
1730 vector<Route*> master_outs;
1732 EditMode _edit_mode;
1733 EditMode pending_edit_mode;
1735 /* range playback */
1737 list<AudioRange> current_audio_range;
1739 void set_play_range (bool yn);
1740 void setup_auto_play ();
1745 boost::shared_ptr<IO> _master_out;
1746 boost::shared_ptr<IO> _control_out;
1748 AutoConnectOption input_auto_connect;
1749 AutoConnectOption output_auto_connect;
1751 gain_t* _gain_automation_buffer;
1752 pan_t** _pan_automation_buffer;
1753 void allocate_pan_automation_buffers (jack_nframes_t nframes, uint32_t howmany, bool force);
1754 uint32_t _npan_buffers;
1758 long _vst_callback (VSTPlugin*,
1765 /* number of hardware audio ports we're using,
1766 based on max (requested,available)
1769 uint32_t n_physical_outputs;
1770 uint32_t n_physical_inputs;
1772 void remove_pending_capture_state ();
1774 int find_all_sources (std::string path, std::set<std::string>& result);
1775 int find_all_sources_across_snapshots (std::set<std::string>& result, bool exclude_this_snapshot);
1777 LayerModel layer_model;
1778 CrossfadeModel xfade_model;
1780 typedef std::list<PBD::Controllable*> Controllables;
1781 Glib::Mutex controllables_lock;
1782 Controllables controllables;
1784 void add_controllable (PBD::Controllable*);
1785 void remove_controllable (PBD::Controllable*);
1788 } // namespace ARDOUR
1790 #endif /* __ardour_session_h__ */