add export visibility macros across libardour
[ardour.git] / libs / ardour / ardour / track.h
index ec444e78dc34d5f9c0cb1f0cf21528e06df991e9..2a6d3f7ad4f391c7c07cacb11a532eecb341f25d 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2006 Paul Davis 
+    Copyright (C) 2006 Paul Davis
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
 
 #include <boost/shared_ptr.hpp>
 
-#include <ardour/route.h>
+#include "ardour/interthread_info.h"
+#include "ardour/route.h"
+#include "ardour/public_diskstream.h"
 
 namespace ARDOUR {
 
 class Session;
-class Diskstream;
 class Playlist;
 class RouteGroup;
+class Source;
+class Region;
+class Diskstream;
+class IO;
 
-class Track : public Route
+class LIBARDOUR_API Track : public Route, public PublicDiskstream
 {
   public:
-       Track (Session&, string name, Route::Flag f = Route::Flag (0), TrackMode m = Normal, DataType default_type = DataType::AUDIO);
-
+       Track (Session&, std::string name, Route::Flag f = Route::Flag (0), TrackMode m = Normal, DataType default_type = DataType::AUDIO);
        virtual ~Track ();
-       
-       int set_name (string str, void *src);
 
-       virtual int roll (jack_nframes_t nframes, jack_nframes_t start_frame, jack_nframes_t end_frame, 
-               jack_nframes_t offset, int declick, bool can_record, bool rec_monitors_input) = 0;
-       
-       virtual int no_roll (jack_nframes_t nframes, jack_nframes_t start_frame, jack_nframes_t end_frame, 
-               jack_nframes_t offset, bool state_changing, bool can_record, bool rec_monitors_input) = 0;
+       int init ();
+
+       bool set_name (const std::string& str);
+
+       TrackMode mode () const { return _mode; }
+       virtual int set_mode (TrackMode /*m*/) { return false; }
+       virtual bool can_use_mode (TrackMode /*m*/, bool& /*bounce_required*/) { return false; }
+       PBD::Signal0<void> TrackModeChanged;
+
+       virtual void set_monitoring (MonitorChoice);
+       MonitorChoice monitoring_choice() const { return _monitoring; }
+        MonitorState monitoring_state () const;
+       PBD::Signal0<void> MonitoringChanged;
+
+       MeterState metering_state () const;
        
-       virtual int silent_roll (jack_nframes_t nframes, jack_nframes_t start_frame, jack_nframes_t end_frame, 
-               jack_nframes_t offset, bool can_record, bool rec_monitors_input) = 0;
+       virtual int no_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
+                            bool state_changing);
+
+       int silent_roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
+                        bool& need_butler);
 
-       void toggle_monitor_input ();
+       virtual int roll (pframes_t nframes, framepos_t start_frame, framepos_t end_frame,
+                         int declick, bool& need_butler) = 0;
 
-       virtual bool can_record();
+       bool needs_butler() const { return _needs_butler; }
 
-       boost::shared_ptr<Diskstream> diskstream() const { return _diskstream; }
+       virtual DataType data_type () const = 0;
 
-       virtual int use_diskstream (string name) = 0;
-       virtual int use_diskstream (const PBD::ID& id) = 0;
+       bool can_record();
 
-       TrackMode mode() const { return _mode; }
-       void      set_mode (TrackMode m);
+       void use_new_diskstream ();
+       virtual boost::shared_ptr<Diskstream> create_diskstream() = 0;
+       virtual void set_diskstream (boost::shared_ptr<Diskstream>);
 
-       jack_nframes_t update_total_latency();
-       void           set_latency_delay (jack_nframes_t);
+       void set_latency_compensation (framecnt_t);
 
        enum FreezeState {
                NoFreeze,
@@ -70,89 +85,149 @@ class Track : public Route
        };
 
        FreezeState freeze_state() const;
-       virtual void freeze (InterThreadInfo&) = 0;
+
+       virtual void freeze_me (InterThreadInfo&) = 0;
        virtual void unfreeze () = 0;
 
-       virtual void bounce (InterThreadInfo&) = 0;
-       virtual void bounce_range (jack_nframes_t start, jack_nframes_t end, InterThreadInfo&) = 0;
+       /** @return true if the track can be bounced, or false otherwise.
+        */
+       virtual bool bounceable (boost::shared_ptr<Processor> endpoint, bool include_endpoint) const = 0;
+       virtual boost::shared_ptr<Region> bounce (InterThreadInfo&) = 0;
+       virtual boost::shared_ptr<Region> bounce_range (framepos_t start, framepos_t end, InterThreadInfo&, 
+                                                       boost::shared_ptr<Processor> endpoint, bool include_endpoint) = 0;
+       virtual int export_stuff (BufferSet& bufs, framepos_t start_frame, framecnt_t nframes,
+                                 boost::shared_ptr<Processor> endpoint, bool include_endpoint, bool for_export) = 0;
 
        XMLNode&    get_state();
        XMLNode&    get_template();
-       virtual int set_state(const XMLNode& node) = 0;
+       virtual int set_state (const XMLNode&, int version);
+       static void zero_diskstream_id_in_xml (XMLNode&);
 
-       PBD::Controllable& rec_enable_control() { return _rec_enable_control; }
+       boost::shared_ptr<AutomationControl> rec_enable_control() { return _rec_enable_control; }
 
        bool record_enabled() const;
-       void set_record_enable (bool yn, void *src);
-       
-       void set_meter_point (MeterPoint, void* src);
-       
-       sigc::signal<void> ModeChanged;
-       sigc::signal<void> DiskstreamChanged;
-       sigc::signal<void> FreezeChange;
+       void set_record_enabled (bool yn, void *src);
+       void prep_record_enabled (bool yn, void *src);
+
+       bool using_diskstream_id (PBD::ID) const;
+
+       void set_block_size (pframes_t);
+
+       /* PublicDiskstream interface */
+       boost::shared_ptr<Playlist> playlist ();
+       void request_input_monitoring (bool);
+       void ensure_input_monitoring (bool);
+       bool destructive () const;
+       std::list<boost::shared_ptr<Source> > & last_capture_sources ();
+       void set_capture_offset ();
+       std::list<boost::shared_ptr<Source> > steal_write_sources();
+       void reset_write_sources (bool, bool force = false);
+       float playback_buffer_load () const;
+       float capture_buffer_load () const;
+       int do_refill ();
+       int do_flush (RunContext, bool force = false);
+       void set_pending_overwrite (bool);
+       int seek (framepos_t, bool complete_refill = false);
+       bool hidden () const;
+       int can_internal_playback_seek (framecnt_t);
+       int internal_playback_seek (framecnt_t);
+       void non_realtime_input_change ();
+       void non_realtime_locate (framepos_t);
+       void non_realtime_set_speed ();
+       int overwrite_existing_buffers ();
+       framecnt_t get_captured_frames (uint32_t n = 0) const;
+       int set_loop (Location *);
+       void transport_looped (framepos_t);
+       bool realtime_set_speed (double, bool);
+       void transport_stopped_wallclock (struct tm &, time_t, bool);
+       bool pending_overwrite () const;
+       double speed () const;
+       void prepare_to_stop (framepos_t);
+       void set_slaved (bool);
+       ChanCount n_channels ();
+       framepos_t get_capture_start_frame (uint32_t n = 0) const;
+       AlignStyle alignment_style () const;
+       AlignChoice alignment_choice () const;
+       framepos_t current_capture_start () const;
+       framepos_t current_capture_end () const;
+       void playlist_modified ();
+       int use_playlist (boost::shared_ptr<Playlist>);
+       void set_align_style (AlignStyle, bool force=false);
+       void set_align_choice (AlignChoice, bool force=false);
+       int use_copy_playlist ();
+       int use_new_playlist ();
+       void adjust_playback_buffering ();
+       void adjust_capture_buffering ();
+
+       PBD::Signal0<void> DiskstreamChanged;
+       PBD::Signal0<void> FreezeChange;
+       /* Emitted when our diskstream is set to use a different playlist */
+       PBD::Signal0<void> PlaylistChanged;
+       PBD::Signal0<void> RecordEnableChanged;
+       PBD::Signal0<void> SpeedChanged;
+       PBD::Signal0<void> AlignmentStyleChanged;
 
   protected:
-       Track (Session& sess, const XMLNode& node, DataType default_type = DataType::AUDIO);
+       XMLNode& state (bool full);
 
-       virtual XMLNode& state (bool full) = 0;
-
-       virtual void passthru_silence (jack_nframes_t start_frame, jack_nframes_t end_frame, 
-               jack_nframes_t nframes, jack_nframes_t offset, int declick, bool meter) = 0;
-
-       virtual uint32_t n_process_buffers () = 0;
-       
        boost::shared_ptr<Diskstream> _diskstream;
-       MeterPoint  _saved_meter_point;
-       TrackMode   _mode;
+       MeterPoint    _saved_meter_point;
+       TrackMode     _mode;
+       bool          _needs_butler;
+       MonitorChoice _monitoring;
 
        //private: (FIXME)
-       struct FreezeRecordInsertInfo {
-           FreezeRecordInsertInfo(XMLNode& st, boost::shared_ptr<Insert> ins) 
-                   : state (st), insert (ins) {}
-
-           XMLNode                   state;
-           boost::shared_ptr<Insert> insert;
-           PBD::ID                   id;
-           UndoAction                memento;
+       struct FreezeRecordProcessorInfo {
+               FreezeRecordProcessorInfo(XMLNode& st, boost::shared_ptr<Processor> proc)
+                       : state (st), processor (proc) {}
+
+               XMLNode                      state;
+               boost::shared_ptr<Processor> processor;
+               PBD::ID                      id;
        };
 
        struct FreezeRecord {
-           FreezeRecord()
-               : playlist(0)
-               , have_mementos(false)
-           {}
+               FreezeRecord()
+                       : have_mementos(false)
+               {}
 
-           ~FreezeRecord();
+               ~FreezeRecord();
 
-           Playlist*                       playlist;
-           vector<FreezeRecordInsertInfo*> insert_info;
-           bool                            have_mementos;
-           FreezeState                     state;
+               boost::shared_ptr<Playlist>        playlist;
+               std::vector<FreezeRecordProcessorInfo*> processor_info;
+               bool                               have_mementos;
+               FreezeState                        state;
        };
 
-       struct RecEnableControllable : public PBD::Controllable {
-           RecEnableControllable (Track&);
-           
-           void set_value (float);
-           float get_value (void) const;
+       struct RecEnableControl : public AutomationControl {
+               RecEnableControl (boost::shared_ptr<Track> t);
 
-           Track& track;
-       };
-
-       //virtual void diskstream_record_enable_changed (void *src) = 0;
-       //virtual void diskstream_input_channel_changed (void *src) = 0;
+               void set_value (double);
+               double get_value (void) const;
 
-       //virtual void input_change_handler (void *src) = 0;
+               boost::weak_ptr<Track> track;
+       };
 
        virtual void set_state_part_two () = 0;
 
        FreezeRecord          _freeze_record;
        XMLNode*              pending_state;
-       sigc::connection      recenable_connection;
-       sigc::connection      ic_connection;
-       RecEnableControllable _rec_enable_control;
        bool                  _destructive;
+
+       void maybe_declick (BufferSet&, framecnt_t, int);
+
+       boost::shared_ptr<RecEnableControl> _rec_enable_control;
+       
+       framecnt_t check_initial_delay (framecnt_t nframes, framepos_t&);
+
+private:
+
+       virtual boost::shared_ptr<Diskstream> diskstream_factory (XMLNode const &) = 0;
+       
+       void diskstream_playlist_changed ();
+       void diskstream_record_enable_changed ();
+       void diskstream_speed_changed ();
+       void diskstream_alignment_style_changed ();
 };
 
 }; /* namespace ARDOUR*/