globally remove all trailing whitespace from ardour code base.
[ardour.git] / libs / ardour / ardour / session.h
index 75b3bd2006c69e1035b859d7c12d5762b03a3f5a..2bc992bb108538dc64b312196ebea422feccb1e8 100644 (file)
@@ -22,6 +22,7 @@
 
 #include "libardour-config.h"
 
+#include <exception>
 #include <list>
 #include <map>
 #include <set>
@@ -139,6 +140,17 @@ class WindowsVSTPlugin;
 
 extern void setup_enum_writer ();
 
+class LIBARDOUR_API SessionException: public std::exception {
+public:
+       explicit SessionException(const std::string msg) : _message(msg) {}
+       virtual ~SessionException() throw() {}
+
+       virtual const char* what() const throw() { return _message.c_str(); }
+
+private:
+       std::string _message;
+};
+
 class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::ScopedConnectionList, public SessionEventManager
 {
   public:
@@ -176,13 +188,22 @@ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::Scop
        bool dirty() const { return _state_of_the_state & Dirty; }
        void set_deletion_in_progress ();
        void clear_deletion_in_progress ();
+       bool reconnection_in_progress() const { return _reconnecting_routes_in_progress; }
        bool deletion_in_progress() const { return _state_of_the_state & Deletion; }
+       bool routes_deletion_in_progress() const { return _route_deletion_in_progress; }
+       bool peaks_cleanup_in_progres() const { return _state_of_the_state & PeakCleanup; }
+
        PBD::Signal0<void> DirtyChanged;
 
+       PBD::Signal1<void, bool> RouteAddedOrRemoved;
+
        const SessionDirectory& session_directory () const { return *(_session_dir.get()); }
 
        static PBD::Signal1<void,std::string> Dialog;
 
+       PBD::Signal0<void> BatchUpdateStart;
+       PBD::Signal0<void> BatchUpdateEnd;
+
        int ensure_subdirs ();
 
        std::string automation_dir () const;  ///< Automation data
@@ -190,9 +211,8 @@ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::Scop
        std::string plugins_dir () const;     ///< Plugin state
        std::string externals_dir () const;   ///< Links to external files
 
-       std::string peak_path (std::string) const;
+       std::string construct_peak_filepath (const std::string& audio_path, const bool in_session = false, const bool old_peak_name = false) const;
 
-       std::string peak_path_from_audio_path (std::string) const;
        bool audio_source_name_is_unique (const std::string& name);
        std::string format_audio_source_name (const std::string& legalized_base, uint32_t nchan, uint32_t chan, bool destructive, bool take_required, uint32_t cnt, bool related_exists);
        std::string new_audio_source_path_for_embedded (const std::string& existing_path);
@@ -211,6 +231,7 @@ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::Scop
        BufferSet& get_mix_buffers (ChanCount count = ChanCount::ZERO);
 
        bool have_rec_enabled_track () const;
+    bool have_rec_disabled_track () const;
 
        bool have_captured() const { return _have_captured; }
 
@@ -289,9 +310,20 @@ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::Scop
 
        PBD::Signal0<void> IOConnectionsComplete;
 
+       /* Timecode status signals */
+       PBD::Signal1<void, bool> MTCSyncStateChanged;
+       PBD::Signal1<void, bool> LTCSyncStateChanged;   
+
        /* Record status signals */
 
-       PBD::Signal0<void> RecordStateChanged;
+       PBD::Signal0<void> RecordStateChanged; /* signals changes in recording state (i.e. are we recording) */
+       /* XXX may 2015: paul says: it isn't clear to me that this has semantics that cannot be inferrred
+          from the previous signal and session state.
+       */
+       PBD::Signal0<void> RecordArmStateChanged; /* signals changes in recording arming */
+
+       /* Emited when session is loaded */
+       PBD::Signal0<void> SessionLoaded;
 
        /* Transport mechanism signals */
 
@@ -328,6 +360,9 @@ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::Scop
        /* Step Editing status changed */
        PBD::Signal1<void,bool> StepEditStatusChange;
 
+       /* Timecode state signals */
+       PBD::Signal0<void> MtcOrLtcInputPortChanged;
+       
        void queue_event (SessionEvent*);
 
        void request_roll_at_and_return (framepos_t start, framepos_t return_to);
@@ -397,8 +432,11 @@ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::Scop
                std::string new_parent_folder;  /* parent folder where new session folder will be created */
                std::string new_name;           /* name of newly saved session */
                bool        switch_to;     /* true if we should be working on newly saved session after save-as; false otherwise */
+               bool        include_media; /* true if the newly saved session should contain references to media */
                bool        copy_media;    /* true if media files (audio, media, etc) should be copied into newly saved session; false otherwise */
                bool        copy_external; /* true if external media should be consolidated into the newly saved session; false otherwise */
+
+               std::string final_session_folder_name; /* filled in by * Session::save_as(), provides full path to newly saved session */
                
                /* emitted as we make progress. 3 arguments passed to signal
                 * handler:
@@ -419,7 +457,7 @@ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::Scop
        };
 
        int save_as (SaveAs&);
-       int save_state (std::string snapshot_name, bool pending = false, bool switch_to_snapshot = false);
+       int save_state (std::string snapshot_name, bool pending = false, bool switch_to_snapshot = false, bool template_only = false);
        int restore_state (std::string snapshot_name);
        int save_template (std::string template_name);
        int save_history (std::string snapshot_name = "");
@@ -427,7 +465,7 @@ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::Scop
        void remove_state (std::string snapshot_name);
        void rename_state (std::string old_name, std::string new_name);
        void remove_pending_capture_state ();
-       int rename (const std::string&, bool after_copy = false);
+       int rename (const std::string&);
        bool get_nsm_state () const { return _under_nsm_control; }
        void set_nsm_state (bool state) { _under_nsm_control = state; }
        bool save_default_options ();
@@ -443,10 +481,10 @@ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::Scop
         *
         * Argument is the snapshot name to use when saving.
         */
-       PBD::Signal1<void,std::string> SaveSessionRequested; 
+       PBD::Signal1<void,std::string> SaveSessionRequested;
 
        /* emitted during a session save to allow other entities to add state, via
-        * extra XML, to the session state 
+        * extra XML, to the session state
         */
        PBD::Signal0<void> SessionSaveUnderway;
 
@@ -468,7 +506,8 @@ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::Scop
                Deletion = 0x4,
                InitialConnecting = 0x8,
                Loading = 0x10,
-               InCleanup = 0x20
+               InCleanup = 0x20,
+               PeakCleanup = 0x40
        };
 
        StateOfTheState state_of_the_state() const { return _state_of_the_state; }
@@ -529,17 +568,21 @@ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::Scop
        std::list<boost::shared_ptr<MidiTrack> > new_midi_track (
                const ChanCount& input, const ChanCount& output,
                boost::shared_ptr<PluginInfo> instrument = boost::shared_ptr<PluginInfo>(),
-               TrackMode mode = Normal, 
+               TrackMode mode = Normal,
                RouteGroup* route_group = 0, uint32_t how_many = 1, std::string name_template = ""
                );
 
-       void   remove_route (boost::shared_ptr<Route>);
-       void   resort_routes ();
-       void   resort_routes_using (boost::shared_ptr<RouteList>);
+       void remove_routes (boost::shared_ptr<RouteList>);
+       void remove_route (boost::shared_ptr<Route>);
+
+       void resort_routes ();
+       void resort_routes_using (boost::shared_ptr<RouteList>);
 
        AudioEngine & engine() { return _engine; }
        AudioEngine const & engine () const { return _engine; }
 
+       static std::string default_track_name_pattern (DataType);
+       
        /* Time */
 
        framepos_t transport_frame () const {return _transport_frame; }
@@ -580,7 +623,9 @@ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::Scop
 
        void   request_sync_source (Slave*);
        bool   synced_to_engine() const { return _slave && config.get_external_sync() && Config->get_sync_source() == Engine; }
-
+       bool   synced_to_mtc () const { return config.get_external_sync() && Config->get_sync_source() == MTC && g_atomic_int_get (const_cast<gint*>(&_mtc_active)); }
+       bool   synced_to_ltc () const { return config.get_external_sync() && Config->get_sync_source() == LTC && g_atomic_int_get (const_cast<gint*>(&_ltc_active)); }
+       
        double transport_speed() const { return _transport_speed; }
        bool   transport_stopped() const { return _transport_speed == 0.0f; }
        bool   transport_rolling() const { return _transport_speed != 0.0f; }
@@ -590,6 +635,9 @@ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::Scop
        TempoMap&       tempo_map()       { return *_tempo_map; }
        const TempoMap& tempo_map() const { return *_tempo_map; }
 
+       unsigned int    get_xrun_count () const {return _xrun_count; }
+       void            reset_xrun_count () {_xrun_count = 0; }
+
        /* region info  */
 
        boost::shared_ptr<Region> find_whole_file_parent (boost::shared_ptr<Region const>) const;
@@ -615,7 +663,9 @@ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::Scop
        void add_source (boost::shared_ptr<Source>);
        void remove_source (boost::weak_ptr<Source>);
 
-       void  cleanup_regions();
+       void cleanup_regions();
+       bool can_cleanup_peakfiles () const;
+       int  cleanup_peakfiles ();
        int  cleanup_sources (CleanupReport&);
        int  cleanup_trash_sources (CleanupReport&);
 
@@ -691,6 +741,7 @@ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::Scop
        void set_mute (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
        void set_listen (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
        void set_record_enabled (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
+       void set_record_safe (boost::shared_ptr<RouteList>, bool yn, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
        void set_solo_isolated (boost::shared_ptr<RouteList>, bool, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
        void set_monitoring (boost::shared_ptr<RouteList>, MonitorChoice, SessionEvent::RTeventCallback after = rt_cleanup, bool group_override = false);
        void set_exclusive_input_active (boost::shared_ptr<RouteList> rt, bool onoff, bool flip_others=false);
@@ -699,9 +750,12 @@ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::Scop
        PBD::Signal0<void> SoloChanged;
        PBD::Signal0<void> IsolatedChanged;
 
+       PBD::Signal0<void> session_routes_reconnected;
+
        /* monitor/master out */
 
        void add_monitor_section ();
+       void reset_monitor_section ();
        void remove_monitor_section ();
 
        boost::shared_ptr<Route> monitor_out() const { return _monitor_out; }
@@ -721,6 +775,12 @@ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::Scop
        static bool get_disable_all_loaded_plugins() {
                return _disable_all_loaded_plugins;
        }
+       static void set_bypass_all_loaded_plugins (bool yn) {
+               _bypass_all_loaded_plugins = yn;
+       }
+       static bool get_bypass_all_loaded_plugins() {
+               return _bypass_all_loaded_plugins;
+       }
 
        uint32_t next_send_id();
        uint32_t next_aux_send_id();
@@ -774,10 +834,7 @@ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::Scop
        void abort_reversible_command ();
        void commit_reversible_command (Command* cmd = 0);
 
-       void add_command (Command *const cmd) {
-               assert (_current_trans);
-               _current_trans->add_command (cmd);
-       }
+       void add_command (Command *const cmd);
 
        /** @return The list of operations that are currently in progress */
        std::list<GQuark> const & current_operations () {
@@ -813,9 +870,18 @@ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::Scop
 
        void maybe_update_session_range (framepos_t, framepos_t);
 
+       /* temporary hacks to allow selection to be pushed from GUI into backend.
+          Whenever we move the selection object into libardour, these will go away.
+        */
+       void set_range_selection (framepos_t start, framepos_t end);
+       void set_object_selection (framepos_t start, framepos_t end);
+       void clear_range_selection ();
+       void clear_object_selection ();
+       
        /* buffers for gain and pan */
 
        gain_t* gain_automation_buffer () const;
+       gain_t* trim_automation_buffer () const;
        gain_t* send_gain_automation_buffer () const;
        pan_t** pan_automation_buffer () const;
 
@@ -964,9 +1030,16 @@ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::Scop
        boost::shared_ptr<MidiPort> midi_clock_input_port () const;
        boost::shared_ptr<MidiPort> mtc_output_port () const;
        boost::shared_ptr<MidiPort> mtc_input_port () const;
-    
+
        MIDI::MachineControl& mmc() { return *_mmc; }
 
+       void reconnect_midi_scene_ports (bool);
+       void reconnect_mtc_ports ();
+       void reconnect_mmc_ports (bool);
+
+       void reconnect_ltc_input ();
+       void reconnect_ltc_output ();
+       
   protected:
        friend class AudioEngine;
        void set_block_size (pframes_t nframes);
@@ -1036,7 +1109,13 @@ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::Scop
        bool                    _writable;
        bool                    _was_seamless;
        bool                    _under_nsm_control;
+       unsigned int            _xrun_count;
 
+       void mtc_status_changed (bool);
+       PBD::ScopedConnection mtc_status_connection;
+       void ltc_status_changed (bool);
+       PBD::ScopedConnection ltc_status_connection;
+       
        void initialize_latencies ();
        void set_worst_io_latencies ();
        void set_worst_playback_latency ();
@@ -1074,6 +1153,8 @@ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::Scop
        bool have_first_delta_accumulator;
 
        SlaveState _slave_state;
+       gint _mtc_active;
+       gint _ltc_active;
        framepos_t slave_wait_end;
 
        void reset_slave_state ();
@@ -1166,6 +1247,7 @@ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::Scop
        gint            _suspend_save; /* atomic */
        volatile bool   _save_queued;
        Glib::Threads::Mutex save_state_lock;
+       Glib::Threads::Mutex peak_cleanup_lock;
 
        int      load_options (const XMLNode&);
        int      load_state (std::string snapshot_name);
@@ -1216,11 +1298,10 @@ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::Scop
 
        void update_skips (Location*, bool consolidate);
        void update_marks (Location* loc);
-       void update_loop (Location* loc);
        void consolidate_skips (Location*);
        void sync_locations_to_skips ();
        void _sync_locations_to_skips ();
-    
+
        PBD::ScopedConnectionList skip_update_connections;
        bool _ignore_skips_updates;
 
@@ -1238,6 +1319,8 @@ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::Scop
        int  post_engine_init ();
        int  immediately_post_engine ();
        void remove_empty_sounds ();
+       
+       void session_loaded ();
 
        void setup_midi_control ();
        int  midi_read (MIDI::Port *);
@@ -1265,6 +1348,21 @@ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::Scop
 
        void *do_work();
 
+       /* Signal Forwarding */
+       void emit_route_signals ();
+       void emit_thread_run ();
+       static void *emit_thread (void *);
+       void emit_thread_start ();
+       void emit_thread_terminate ();
+
+       pthread_t       _rt_emit_thread;
+       bool            _rt_thread_active;
+
+       pthread_mutex_t _rt_emit_mutex;
+       pthread_cond_t  _rt_emit_cond;
+       bool            _rt_emit_pending;
+
+
        /* SessionEventManager interface */
 
        void process_event (SessionEvent*);
@@ -1368,7 +1466,7 @@ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::Scop
        void flush_all_inserts ();
        int  micro_locate (framecnt_t distance);
        void locate (framepos_t, bool with_roll, bool with_flush, bool with_loop=false, bool force=false, bool with_mmc=true);
-       void start_locate (framepos_t, bool with_roll, bool with_flush, bool with_loop=false, bool force=false);
+       void start_locate (framepos_t, bool with_roll, bool with_flush, bool for_loop_enabled=false, bool force=false);
        void force_locate (framepos_t frame, bool with_roll = false);
        void set_track_speed (Track *, double speed);
        void set_transport_speed (double speed, framepos_t destination_frame, bool abort = false, bool clear_state = false, bool as_default = false);
@@ -1385,6 +1483,8 @@ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::Scop
        void engine_halted ();
        void xrun_recovery ();
        void set_track_loop (bool);
+       bool select_playhead_priority_target (framepos_t&);
+       void follow_playhead_priority ();
        
        /* These are synchronous and so can only be called from within the process
         * cycle
@@ -1412,6 +1512,9 @@ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::Scop
        void add_routes (RouteList&, bool input_auto_connect, bool output_auto_connect, bool save);
        void add_routes_inner (RouteList&, bool input_auto_connect, bool output_auto_connect);
        bool _adding_routes_in_progress;
+       bool _reconnecting_routes_in_progress;
+       bool _route_deletion_in_progress;
+
        uint32_t destructive_index;
 
        boost::shared_ptr<Route> XMLRouteFactory (const XMLNode&, int);
@@ -1419,7 +1522,7 @@ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::Scop
 
        void route_processors_changed (RouteProcessorChange);
 
-       bool find_route_name (std::string const &, uint32_t& id, char* name, size_t name_len, bool);
+       bool find_route_name (std::string const &, uint32_t& id, std::string& name, bool);
        void count_existing_track_channels (ChanCount& in, ChanCount& out);
        void auto_connect_route (boost::shared_ptr<Route> route, ChanCount& existing_inputs, ChanCount& existing_outputs,
                                 bool with_lock, bool connect_inputs = true,
@@ -1438,6 +1541,7 @@ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::Scop
        void route_listen_changed (void *src, boost::weak_ptr<Route>);
        void route_mute_changed (void *src);
        void route_solo_changed (bool self_solo_change, void *src, boost::weak_ptr<Route>);
+       void routes_solo_changed (boost::shared_ptr<RouteList> solo_change_routes);
        void route_solo_isolated_changed (void *src, boost::weak_ptr<Route>);
        void update_route_solo_state (boost::shared_ptr<RouteList> r = boost::shared_ptr<RouteList>());
 
@@ -1606,6 +1710,12 @@ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::Scop
        void set_play_range (std::list<AudioRange>&, bool leave_rolling);
        void unset_play_range ();
 
+       /* temporary hacks to allow selection to be pushed from GUI into backend
+          Whenever we move the selection object into libardour, these will go away.
+       */
+       Evoral::Range<framepos_t> _range_selection;
+       Evoral::Range<framepos_t> _object_selection;
+       
        /* main outs */
        uint32_t main_outs;
 
@@ -1645,11 +1755,13 @@ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::Scop
        void set_history_depth (uint32_t depth);
 
        static bool _disable_all_loaded_plugins;
+       static bool _bypass_all_loaded_plugins;
 
        mutable bool have_looped; ///< Used in ::audible_frame(*)
 
-       void update_have_rec_enabled_track ();
+       void update_route_record_state ();
        gint _have_rec_enabled_track;
+       gint _have_rec_disabled_track;
 
        static int ask_about_playlist_deletion (boost::shared_ptr<Playlist>);
 
@@ -1672,12 +1784,13 @@ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::Scop
        void rt_set_listen (boost::shared_ptr<RouteList>, bool yn, bool group_override);
        void rt_set_solo_isolated (boost::shared_ptr<RouteList>, bool yn, bool group_override);
        void rt_set_record_enabled (boost::shared_ptr<RouteList>, bool yn, bool group_override);
+       void rt_set_record_safe (boost::shared_ptr<RouteList>, bool yn, bool group_override);
        void rt_set_monitoring (boost::shared_ptr<RouteList>, MonitorChoice, bool group_override);
 
        /** temporary list of Diskstreams used only during load of 2.X sessions */
        std::list<boost::shared_ptr<Diskstream> > _diskstreams_2X;
 
-       void add_session_range_location (framepos_t, framepos_t);
+       void set_session_range_location (framepos_t, framepos_t);
 
        void setup_midi_machine_control ();
 
@@ -1712,9 +1825,6 @@ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::Scop
        boost::shared_ptr<IO>   _ltc_input;
        boost::shared_ptr<IO>   _ltc_output;
 
-       void reconnect_ltc_input ();
-       void reconnect_ltc_output ();
-
        /* Scene Changing */
        SceneChanger* _scene_changer;
        
@@ -1730,6 +1840,7 @@ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::Scop
        void save_as_bring_callback (uint32_t, uint32_t, std::string);
 
        static int get_session_info_from_path (XMLTree& state_tree, const std::string& xmlpath);
+       static const uint32_t session_end_shift;
 };