Extract program version that a session was created with
[ardour.git] / libs / ardour / ardour / session.h
index 5ec7e99cea0c84e476229db2b52b0fe5b94c404f..562b8a94c2d986b092f7247e186004ed332fa079 100644 (file)
@@ -134,6 +134,7 @@ class PluginInfo;
 class Port;
 class PortInsert;
 class ProcessThread;
+class Progress;
 class Processor;
 class Region;
 class Return;
@@ -169,6 +170,16 @@ private:
 /** Ardour Session */
 class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::ScopedConnectionList, public SessionEventManager
 {
+  private:
+       enum SubState {
+               PendingDeclickIn      = 0x1,  ///< pending de-click fade-in for start
+               PendingDeclickOut     = 0x2,  ///< pending de-click fade-out for stop
+               StopPendingCapture    = 0x4,
+               PendingLoopDeclickIn  = 0x8,  ///< pending de-click fade-in at the start of a loop
+               PendingLoopDeclickOut = 0x10, ///< pending de-click fade-out at the end of a loop
+               PendingLocate         = 0x20,
+       };
+
   public:
        enum RecordState {
                Disabled = 0,
@@ -188,7 +199,7 @@ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::Scop
 
        virtual ~Session ();
 
-       static int get_info_from_path (const std::string& xmlpath, float& sample_rate, SampleFormat& data_format);
+       static int get_info_from_path (const std::string& xmlpath, float& sample_rate, SampleFormat& data_format, std::string& created_version);
        static std::string get_snapshot_from_instant (const std::string& session_dir);
 
        /** a monotonic counter used for naming user-visible things uniquely
@@ -245,9 +256,10 @@ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::Scop
         * @param pd Playlist disposition
         * @return list of newly created routes
         */
-       RouteList new_route_from_template (uint32_t how_many, const std::string& template_path, const std::string& name, PlaylistDisposition pd = NewPlaylist);
-       RouteList new_route_from_template (uint32_t how_many, XMLNode&, const std::string& name, PlaylistDisposition pd = NewPlaylist);
-       std::vector<std::string> get_paths_for_new_sources (bool allow_replacing, const std::string& import_file_path, uint32_t channels);
+       RouteList new_route_from_template (uint32_t how_many, PresentationInfo::order_t insert_at, const std::string& template_path, const std::string& name, PlaylistDisposition pd = NewPlaylist);
+       RouteList new_route_from_template (uint32_t how_many, PresentationInfo::order_t insert_at, XMLNode&, const std::string& name, PlaylistDisposition pd = NewPlaylist);
+       std::vector<std::string> get_paths_for_new_sources (bool allow_replacing, const std::string& import_file_path, 
+                                                           uint32_t channels, std::vector<std::string> const & smf_track_names);
 
        int bring_all_sources_into_session (boost::function<void(uint32_t,uint32_t,std::string)> callback);
 
@@ -311,7 +323,6 @@ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::Scop
        bool io_name_is_legal (const std::string&) const;
        boost::shared_ptr<Route> route_by_name (std::string) const;
        boost::shared_ptr<Route> route_by_id (PBD::ID) const;
-       boost::shared_ptr<Stripable> get_nth_stripable (PresentationInfo::order_t n) const;
        boost::shared_ptr<Stripable> get_remote_nth_stripable (PresentationInfo::order_t n, PresentationInfo::Flag) const;
        boost::shared_ptr<Route> get_remote_nth_route (PresentationInfo::order_t n) const;
        boost::shared_ptr<Route> route_by_selected_count (uint32_t cnt) const;
@@ -338,7 +349,7 @@ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::Scop
        }
 
        bool record_enabling_legal () const;
-       void maybe_enable_record ();
+       void maybe_enable_record (bool rt_context = false);
        void disable_record (bool rt_context, bool force = false);
        void step_back_from_record ();
 
@@ -415,7 +426,7 @@ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::Scop
 
        framepos_t last_transport_start () const { return _last_roll_location; }
        void goto_end ();
-       void goto_start ();
+       void goto_start (bool and_roll = false);
        void use_rf_shuttle_speed ();
        void allow_auto_play (bool yn);
        void request_transport_speed (double speed, bool as_default = true);
@@ -427,6 +438,7 @@ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::Scop
        void request_input_change_handling ();
 
        bool locate_pending() const { return static_cast<bool>(post_transport_work()&PostTransportLocate); }
+       bool declick_out_pending() const { return static_cast<bool>(transport_sub_state&(PendingDeclickOut)); }
        bool transport_locked () const;
 
        int wipe ();
@@ -439,7 +451,7 @@ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::Scop
        framecnt_t nominal_frame_rate () const { return _nominal_frame_rate; }
        framecnt_t frames_per_hour () const { return _frames_per_hour; }
 
-       double frames_per_timecode_frame() const { return _frames_per_timecode_frame; }
+       double samples_per_timecode_frame() const { return _samples_per_timecode_frame; }
        framecnt_t timecode_frames_per_hour() const { return _timecode_frames_per_hour; }
 
        MIDI::byte get_mtc_timecode_bits() const {
@@ -460,6 +472,7 @@ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::Scop
        void set_auto_punch_location (Location *);
        void set_auto_loop_location (Location *);
        void set_session_extents (framepos_t start, framepos_t end);
+       void set_end_is_free (bool);
        int location_name(std::string& result, std::string base = std::string(""));
 
        pframes_t get_block_size()        const { return current_block_size; }
@@ -505,6 +518,15 @@ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::Scop
         * @return zero on success
         */
        int save_state (std::string snapshot_name, bool pending = false, bool switch_to_snapshot = false, bool template_only = false);
+
+       enum ArchiveEncode {
+               NO_ENCODE,
+               FLAC_16BIT,
+               FLAC_24BIT
+       };
+
+       int archive_session (const std::string&, const std::string&, ArchiveEncode compress_audio = FLAC_16BIT, bool only_used_sources = false, Progress* p = 0);
+
        int restore_state (std::string snapshot_name);
        int save_template (std::string template_name, bool replace_existing = false);
        int save_history (std::string snapshot_name = "");
@@ -541,6 +563,7 @@ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::Scop
        XMLNode& get_state();
        int      set_state(const XMLNode& node, int version); // not idempotent
        XMLNode& get_template();
+       bool     export_track_state (boost::shared_ptr<RouteList> rl, const std::string& path);
 
        /// The instant xml file is written to the session directory
        void add_instant_xml (XMLNode&, bool write_to_config = true);
@@ -560,23 +583,45 @@ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::Scop
        StateOfTheState state_of_the_state() const { return _state_of_the_state; }
 
        class StateProtector {
-                                               public:
-               StateProtector (Session* s) : _session (s) {
-                       g_atomic_int_inc (&s->_suspend_save);
-               }
-               ~StateProtector () {
-                       if (g_atomic_int_dec_and_test (&_session->_suspend_save)) {
-                               while (_session->_save_queued) {
-                                       _session->_save_queued = false;
-                                       _session->save_state ("");
+               public:
+                       StateProtector (Session* s) : _session (s) {
+                               g_atomic_int_inc (&s->_suspend_save);
+                       }
+                       ~StateProtector () {
+                               if (g_atomic_int_dec_and_test (&_session->_suspend_save)) {
+                                       while (_session->_save_queued) {
+                                               _session->_save_queued = false;
+                                               _session->save_state ("");
+                                       }
                                }
                        }
-               }
-                                               private:
-               Session * _session;
+               private:
+                       Session * _session;
+       };
+
+       class ProcessorChangeBlocker {
+               public:
+                       ProcessorChangeBlocker (Session* s, bool rc = true)
+                               : _session (s)
+                               , _reconfigure_on_delete (rc)
+                       {
+                               g_atomic_int_inc (&s->_ignore_route_processor_changes);
+                       }
+                       ~ProcessorChangeBlocker () {
+                               if (g_atomic_int_dec_and_test (&_session->_ignore_route_processor_changes)) {
+                                       if (_reconfigure_on_delete) {
+                                               _session->route_processors_changed (RouteProcessorChange ());
+                                       }
+                               }
+                       }
+               private:
+                       Session* _session;
+                       bool _reconfigure_on_delete;
        };
 
+       RouteGroup* new_route_group (const std::string&);
        void add_route_group (RouteGroup *);
+       void remove_route_group (RouteGroup* rg) { if (rg) remove_route_group (*rg); }
        void remove_route_group (RouteGroup&);
        void reorder_route_groups (std::list<RouteGroup*>);
 
@@ -704,7 +749,7 @@ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::Scop
        boost::shared_ptr<ExportHandler> get_export_handler ();
        boost::shared_ptr<ExportStatus> get_export_status ();
 
-       int start_audio_export (framepos_t position);
+       int start_audio_export (framepos_t position, bool realtime = false, bool region_export = false, bool comensate_master_latency = false);
 
        PBD::Signal1<int, framecnt_t> ProcessExport;
        static PBD::Signal2<void,std::string, std::string> Exported;
@@ -791,6 +836,7 @@ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::Scop
        bool soloing() const { return _non_soloed_outs_muted; }
        bool listening() const { return _listen_cnt > 0; }
        bool solo_isolated() const { return _solo_isolated_cnt > 0; }
+       void cancel_all_solo ();
 
        static const SessionEvent::RTeventCallback rt_cleanup;
 
@@ -873,13 +919,11 @@ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::Scop
        /** Undo some transactions.
         * @param n Number of transactions to undo.
         */
-       void undo (uint32_t n) {
-               _history.undo (n);
-       }
-
-       void redo (uint32_t n) {
-               _history.redo (n);
-       }
+       void undo (uint32_t n);
+       /** Redo some transactions.
+        * @param n Number of transactions to undo.
+        */
+       void redo (uint32_t n);
 
        UndoHistory& history() { return _history; }
 
@@ -954,6 +998,17 @@ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::Scop
 
        void maybe_update_session_range (framepos_t, framepos_t);
 
+       /* preroll */
+       framecnt_t preroll_samples (framepos_t) const;
+
+       void request_preroll_record_punch (framepos_t start, framecnt_t preroll);
+       void request_preroll_record_trim (framepos_t start, framecnt_t preroll);
+
+       framepos_t preroll_record_punch_pos () const { return _preroll_record_punch_pos; }
+       bool preroll_record_punch_enabled () const { return _preroll_record_punch_pos >= 0; }
+
+       framecnt_t preroll_record_trim_len () const { return _preroll_record_trim_len; }
+
        /* temporary hacks to allow selection to be pushed from GUI into backend.
           Whenever we move the selection object into libardour, these will go away.
         */
@@ -1006,6 +1061,8 @@ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::Scop
 
        SessionConfiguration config;
 
+       SessionConfiguration* cfg () { return &config; }
+
        bool exporting () const {
                return _exporting;
        }
@@ -1127,6 +1184,9 @@ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::Scop
 
        VCAManager& vca_manager() { return *_vca_manager; }
 
+       void auto_connect_thread_wakeup ();
+
+
   protected:
        friend class AudioEngine;
        void set_block_size (pframes_t nframes);
@@ -1148,15 +1208,6 @@ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::Scop
        static void init_name_id_counter (guint n);
        static unsigned int name_id_counter ();
 
-       enum SubState {
-               PendingDeclickIn      = 0x1,  ///< pending de-click fade-in for start
-               PendingDeclickOut     = 0x2,  ///< pending de-click fade-out for stop
-               StopPendingCapture    = 0x4,
-               PendingLoopDeclickIn  = 0x8,  ///< pending de-click fade-in at the start of a loop
-               PendingLoopDeclickOut = 0x10, ///< pending de-click fade-out at the end of a loop
-               PendingLocate         = 0x20,
-       };
-
        /* stuff used in process() should be close together to
           maximise cache hits
        */
@@ -1176,6 +1227,7 @@ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::Scop
        mutable gint            _record_status;
        framepos_t              _transport_frame;
        Location*               _session_range_location; ///< session range, or 0 if there is nothing in the session yet
+       bool                    _session_range_end_is_free;
        Slave*                  _slave;
        bool                    _silent;
 
@@ -1228,8 +1280,8 @@ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::Scop
        void process_without_events (pframes_t);
        void process_with_events    (pframes_t);
        void process_audition       (pframes_t);
-       int  process_export         (pframes_t);
-       int  process_export_fw      (pframes_t);
+       void process_export         (pframes_t);
+       void process_export_fw      (pframes_t);
 
        void block_processing() { g_atomic_int_set (&processing_prohibited, 1); }
        void unblock_processing() { g_atomic_int_set (&processing_prohibited, 0); }
@@ -1266,7 +1318,10 @@ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::Scop
 
        bool _exporting;
        bool _export_rolling;
+       bool _realtime_export;
+       bool _region_export;
        framepos_t _export_preroll;
+       framepos_t _export_latency;
 
        boost::shared_ptr<ExportHandler> export_handler;
        boost::shared_ptr<ExportStatus>  export_status;
@@ -1320,7 +1375,6 @@ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::Scop
         *  know when to send full MTC messages every so often.
         */
        pframes_t               _pframes_since_last_mtc;
-       bool                     session_midi_feedback;
        bool                     play_loop;
        bool                     loop_changing;
        framepos_t               last_loopend;
@@ -1480,7 +1534,7 @@ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::Scop
        void auto_connect_thread_terminate ();
 
        pthread_t       _auto_connect_thread;
-       bool            _ac_thread_active;
+       gint            _ac_thread_active;
        pthread_mutex_t _auto_connect_mutex;
        pthread_cond_t  _auto_connect_cond;
 
@@ -1510,8 +1564,14 @@ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::Scop
        typedef std::queue<AutoConnectRequest> AutoConnectQueue;
        Glib::Threads::Mutex  _auto_connect_queue_lock;
        AutoConnectQueue _auto_connect_queue;
+       guint _latency_recompute_pending;
+
+       void get_physical_ports (std::vector<std::string>& inputs, std::vector<std::string>& outputs, DataType type,
+                                MidiPortFlags include = MidiPortFlags (0),
+                                MidiPortFlags exclude = MidiPortFlags (0));
 
        void auto_connect (const AutoConnectRequest&);
+       void queue_latency_recompute ();
 
        /* SessionEventManager interface */
 
@@ -1556,7 +1616,7 @@ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::Scop
        Timecode::Time transmitting_timecode_time;
        int next_quarter_frame_to_send;
 
-       double _frames_per_timecode_frame; /* has to be floating point because of drop frame */
+       double _samples_per_timecode_frame; /* has to be floating point because of drop frame */
        framecnt_t _frames_per_hour;
        framecnt_t _timecode_frames_per_hour;
 
@@ -1847,6 +1907,9 @@ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::Scop
        void   setup_click_sounds (Sample**, Sample const *, framecnt_t*, framecnt_t, std::string const &);
        void   clear_clicks ();
        void   click (framepos_t start, framecnt_t nframes);
+       void   run_click (framepos_t start, framecnt_t nframes);
+       void   add_click (framepos_t pos, bool emphasis);
+       framecnt_t _count_in_samples;
 
        std::vector<Route*> master_outs;
 
@@ -1863,6 +1926,12 @@ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::Scop
        Evoral::Range<framepos_t> _range_selection;
        Evoral::Range<framepos_t> _object_selection;
 
+       void unset_preroll_record_punch ();
+       void unset_preroll_record_trim ();
+
+       framepos_t _preroll_record_punch_pos;
+       framecnt_t _preroll_record_trim_len;
+
        /* main outs */
        uint32_t main_outs;
 
@@ -1979,7 +2048,9 @@ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::Scop
        GraphEdges _current_route_graph;
 
        void ensure_route_presentation_info_gap (PresentationInfo::order_t, uint32_t gap_size);
-       bool ignore_route_processor_changes;
+
+       friend class    ProcessorChangeBlocker;
+       gint            _ignore_route_processor_changes; /* atomic */
 
        MidiClockTicker* midi_clock;
 
@@ -2000,7 +2071,6 @@ 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;
 
        std::string _template_state_dir;
@@ -2010,6 +2080,11 @@ class LIBARDOUR_API Session : public PBD::StatefulDestructible, public PBD::Scop
        boost::shared_ptr<Route> get_midi_nth_route_by_id (PresentationInfo::order_t n) const;
 
        std::string created_with;
+
+       void midi_track_presentation_info_changed (PBD::PropertyChange const &, boost::weak_ptr<MidiTrack>);
+       void rewire_selected_midi (boost::shared_ptr<MidiTrack>);
+       void rewire_midi_selection_ports ();
+       boost::weak_ptr<MidiTrack> current_midi_target;
 };