Trim include dependency graph, especially for io.h and session.h.
[ardour.git] / libs / ardour / ardour / audio_diskstream.h
index 247939b3782ae4ec4249b7ad367c35deba1df76e..8f081ab58dbca91d8f26888ab674a8546b1d06e9 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2000 Paul Davis 
+    Copyright (C) 2000-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
@@ -14,8 +14,6 @@
     You should have received a copy of the GNU General Public License
     along with this program; if not, write to the Free Software
     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
-
-    $Id: diskstream.h 579 2006-06-12 19:56:37Z essej $
 */
 
 #ifndef __ardour_audio_diskstream_h__
 #include <pbd/fastlog.h>
 #include <pbd/ringbufferNPT.h>
 #include <pbd/stateful.h> 
+#include <pbd/rcu.h> 
 
 #include <ardour/ardour.h>
 #include <ardour/configuration.h>
-#include <ardour/session.h>
-#include <ardour/route_group.h>
-#include <ardour/route.h>
-#include <ardour/port.h>
 #include <ardour/utils.h>
 #include <ardour/diskstream.h>
 #include <ardour/audioplaylist.h>
+#include <ardour/port.h>
 
 struct tm;
 
@@ -61,83 +57,78 @@ class AudioDiskstream : public Diskstream
   public:
        AudioDiskstream (Session &, const string& name, Diskstream::Flag f = Recordable);
        AudioDiskstream (Session &, const XMLNode&);
-
-       void set_io (ARDOUR::IO& io);
-
-       AudioDiskstream& ref() { _refcnt++; return *this; }
-       //void unref() { if (_refcnt) _refcnt--; if (_refcnt == 0) delete this; }
-       //uint32_t refcnt() const { return _refcnt; }
+       ~AudioDiskstream();
 
        float playback_buffer_load() const;
        float capture_buffer_load() const;
 
-       //void set_align_style (AlignStyle);
-       //void set_persistent_align_style (AlignStyle);
-
        string input_source (uint32_t n=0) const {
-               if (n < channels.size()) {
-                       return channels[n].source ? channels[n].source->name() : "";
+               boost::shared_ptr<ChannelList> c = channels.reader();
+               if (n < c->size()) {
+                       return (*c)[n]->source ? (*c)[n]->source->name() : "";
                } else {
                        return ""; 
                }
        }
 
        Port *input_source_port (uint32_t n=0) const { 
-               if (n < channels.size()) return channels[n].source; return 0; 
+               boost::shared_ptr<ChannelList> c = channels.reader();
+               if (n < c->size()) return (*c)[n]->source; return 0; 
        }
 
-       void set_record_enabled (bool yn, void *src);
-       //void set_speed (double);
+       void set_record_enabled (bool yn);
+       int set_destructive (bool yn);
+       bool can_become_destructive (bool& requires_bounce) const;
 
-       float peak_power(uint32_t n=0) { 
-               float x = channels[n].peak_power;
-               channels[n].peak_power = 0.0f;
+       float peak_power(uint32_t n = 0) { 
+               boost::shared_ptr<ChannelList> c = channels.reader();
+               ChannelInfo* chaninfo = (*c)[n];
+               float x = chaninfo->peak_power;
+               chaninfo->peak_power = 0.0f;
                if (x > 0.0f) {
                        return 20.0f * fast_log10(x);
                } else {
                        return minus_infinity();
                }
        }
+       
+       boost::shared_ptr<AudioPlaylist> audio_playlist () { return boost::dynamic_pointer_cast<AudioPlaylist>(_playlist); }
 
-       int use_playlist (Playlist *);
+       int use_playlist (boost::shared_ptr<Playlist>);
        int use_new_playlist ();
        int use_copy_playlist ();
 
-       void start_scrub (jack_nframes_t where) {} // FIXME?
-       void end_scrub () {} // FIXME?
-
-       Playlist *playlist () { return _playlist; }
-
-       Sample *playback_buffer (uint32_t n=0) {
-               if (n < channels.size())
-                       return channels[n].current_playback_buffer;
+       Sample *playback_buffer (uint32_t n = 0) {
+               boost::shared_ptr<ChannelList> c = channels.reader();
+               if (n < c->size())
+                       return (*c)[n]->current_playback_buffer;
                return 0;
        }
        
-       Sample *capture_buffer (uint32_t n=0) {
-               if (n < channels.size())
-                       return channels[n].current_capture_buffer;
+       Sample *capture_buffer (uint32_t n = 0) {
+               boost::shared_ptr<ChannelList> c = channels.reader();
+               if (n < c->size())
+                       return (*c)[n]->current_capture_buffer;
                return 0;
        }
 
-       AudioFileSource *write_source (uint32_t n=0) {
-               if (n < channels.size())
-                       return channels[n].write_source;
-               return 0;
+       boost::shared_ptr<AudioFileSource> write_source (uint32_t n=0) {
+               boost::shared_ptr<ChannelList> c = channels.reader();
+               if (n < c->size())
+                       return (*c)[n]->write_source;
+               return boost::shared_ptr<AudioFileSource>();
        }
 
-       int add_channel ();
-       int remove_channel ();
-       
+       int add_channel (uint32_t how_many);
+       int remove_channel (uint32_t how_many);
        
        /* stateful */
 
        XMLNode& get_state(void);
-       int set_state(const XMLNode& node);
+       int      set_state(const XMLNode& node);
 
        void monitor_input (bool);
 
-       // FIXME: these don't belong here
        static void swap_by_ptr (Sample *first, Sample *last) {
                while (first < last) {
                        Sample tmp = *first;
@@ -146,7 +137,7 @@ class AudioDiskstream : public Diskstream
                }
        }
 
-       static void swap_by_ptr (Sample *first, Sample *last, jack_nframes_t n) {
+       static void swap_by_ptr (Sample *first, Sample *last, nframes_t n) {
                while (n--) {
                        Sample tmp = *first;
                        *first++ = *last;
@@ -154,26 +145,50 @@ class AudioDiskstream : public Diskstream
                }
        }
 
-       //void handle_input_change (IOChange, void *src);
-       
-       //static sigc::signal<void> DiskOverrun;
-       //static sigc::signal<void> DiskUnderrun;
-       //static sigc::signal<void,AudioDiskstream*> AudioDiskstreamCreated;   // XXX use a ref with sigc2
-       static sigc::signal<void,list<AudioFileSource*>*> DeleteSources;
-
-       int set_loop (Location *loc);
-       sigc::signal<void,Location *> LoopSet;
+       XMLNode* deprecated_io_node;
 
-       std::list<Region*>& last_capture_regions () {
-               return _last_capture_regions;
-       }
+       /**
+        * Calculate the playback distance during varispeed playback.
+        * Important for Session::process to know exactly, how many frames
+        * were passed by.
+        */
+       static nframes_t calculate_varispeed_playback_distance(
+                       nframes_t nframes, 
+                       uint64_t& the_last_phase, 
+                       uint64_t& the_phi,
+                       uint64_t& the_target_phi)
+       {
+               // calculate playback distance in the same way 
+               // as in AudioDiskstream::process_varispeed_playback
+               uint64_t    phase = the_last_phase;
+               int64_t     phi_delta;
+               nframes_t   i = 0;
+               
+               const int64_t fractional_part_mask  = 0xFFFFFF;
+               const Sample  binary_scaling_factor = 16777216.0f;
+
+               if (the_phi != the_target_phi) {
+                       phi_delta = ((int64_t)(the_target_phi - the_phi)) / nframes;
+               } else {
+                       phi_delta = 0;
+               }
 
-       void handle_input_change (IOChange, void *src);
+               Sample fractional_phase_part;
 
-       const PBD::ID& id() const { return _id; }
+               i = 0;
+               phase = the_last_phase;
 
-       XMLNode* deprecated_io_node;
+               for (nframes_t outsample = 0; outsample < nframes; ++outsample) {
+                       i = phase >> 24;
+                       fractional_phase_part = (phase & fractional_part_mask) / binary_scaling_factor;
+                       phase += the_phi + phi_delta;
+               }
 
+               the_last_phase = (phase & fractional_part_mask);
+               the_phi = the_target_phi;
+               return i; // + 1;
+       }
+       
   protected:
        friend class Session;
 
@@ -184,127 +199,122 @@ class AudioDiskstream : public Diskstream
 
        void set_pending_overwrite(bool);
        int  overwrite_existing_buffers ();
-       void reverse_scrub_buffer (bool to_forward) {} // FIXME?
-       void set_block_size (jack_nframes_t);
-       int  internal_playback_seek (jack_nframes_t distance);
-       int  can_internal_playback_seek (jack_nframes_t distance);
+       void set_block_size (nframes_t);
+       int  internal_playback_seek (nframes_t distance);
+       int  can_internal_playback_seek (nframes_t distance);
        int  rename_write_sources ();
        void reset_write_sources (bool, bool force = false);
        void non_realtime_input_change ();
+       void non_realtime_locate (nframes_t location);
 
   protected:
        friend class Auditioner;
-       int  seek (jack_nframes_t which_sample, bool complete_refill = false);
+       int  seek (nframes_t which_sample, bool complete_refill = false);
 
   protected:
        friend class AudioTrack;
 
-       int  process (jack_nframes_t transport_frame, jack_nframes_t nframes, jack_nframes_t offset, bool can_record, bool rec_monitors_input);
-       bool commit  (jack_nframes_t nframes);
+       int  process (nframes_t transport_frame, nframes_t nframes, nframes_t offset, bool can_record, bool rec_monitors_input);
+       bool commit  (nframes_t nframes);
 
   private:
 
-       /* use unref() to destroy a diskstream */
-       ~AudioDiskstream();
-
        struct ChannelInfo {
-
-               Sample     *playback_wrap_buffer;
-               Sample     *capture_wrap_buffer;
-               Sample     *speed_buffer;
-
-               float       peak_power;
-
-               AudioFileSource   *fades_source;
-               AudioFileSource   *write_source;
-
-               Port         *source;
-               Sample       *current_capture_buffer;
-               Sample       *current_playback_buffer;
-
-               RingBufferNPT<Sample> *playback_buf;
-               RingBufferNPT<Sample> *capture_buf;
-
-               Sample* scrub_buffer;
-               Sample* scrub_forward_buffer;
-               Sample* scrub_reverse_buffer;
-
-               RingBufferNPT<Sample>::rw_vector playback_vector;
-               RingBufferNPT<Sample>::rw_vector capture_vector;
-
-               RingBufferNPT<CaptureTransition> * capture_transition_buf;
-               // the following are used in the butler thread only
-               jack_nframes_t                     curr_capture_cnt;
+           
+           ChannelInfo (nframes_t buffer_size, nframes_t speed_buffer_size, nframes_t wrap_buffer_size);
+           ~ChannelInfo ();
+
+           Sample     *playback_wrap_buffer;
+           Sample     *capture_wrap_buffer;
+           Sample     *speed_buffer;
+           
+           float       peak_power;
+           
+           boost::shared_ptr<AudioFileSource> fades_source;
+           boost::shared_ptr<AudioFileSource> write_source;
+
+           /// the Port that our audio data comes from
+           Port         *source;
+           Sample       *current_capture_buffer;
+           Sample       *current_playback_buffer;
+           
+           RingBufferNPT<Sample> *playback_buf;
+           RingBufferNPT<Sample> *capture_buf;
+           
+           Sample* scrub_buffer;
+           Sample* scrub_forward_buffer;
+           Sample* scrub_reverse_buffer;
+           
+           RingBufferNPT<Sample>::rw_vector playback_vector;
+           RingBufferNPT<Sample>::rw_vector capture_vector;
+           
+           RingBufferNPT<CaptureTransition> * capture_transition_buf;
+           // the following are used in the butler thread only
+           nframes_t                     curr_capture_cnt;
        };
 
-       typedef vector<ChannelInfo> ChannelList;
-
-       /* the two central butler operations */
+       typedef std::vector<ChannelInfo*> ChannelList;
 
-       int do_flush (char * workbuf, bool force = false);
-       int do_refill (Sample *mixdown_buffer, float *gain_buffer, char *workbuf);
+       void process_varispeed_playback(nframes_t nframes, boost::shared_ptr<ChannelList> c);
        
-       virtual int non_realtime_do_refill() { return do_refill(0, 0, 0); }
-
-       int read (Sample* buf, Sample* mixdown_buffer, float* gain_buffer, char * workbuf, jack_nframes_t& start, jack_nframes_t cnt, 
-                 ChannelInfo& channel_info, int channel, bool reversed);
+       /* The two central butler operations */
+       int do_flush (RunContext context, bool force = false);
+       int do_refill () { return _do_refill(_mixdown_buffer, _gain_buffer); }
+       
+       int do_refill_with_alloc ();
 
-       /* XXX fix this redundancy ... */
+       int read (Sample* buf, Sample* mixdown_buffer, float* gain_buffer,
+                 nframes_t& start, nframes_t cnt, 
+                 ChannelInfo* channel_info, int channel, bool reversed);
 
-       //void playlist_changed (Change);
-       //void playlist_modified ();
-       void playlist_deleted (Playlist*);
-       void session_controls_changed (Session::ControlType) {} // FIXME?
 
-       void finish_capture (bool rec_monitors_input);
-       void clean_up_capture (struct tm&, time_t, bool abort) {} // FIXME?
+       void finish_capture (bool rec_monitors_input, boost::shared_ptr<ChannelList>);
        void transport_stopped (struct tm&, time_t, bool abort);
+       void transport_looped (nframes_t transport_frame);
 
-       struct CaptureInfo {
-           uint32_t start;
-           uint32_t frames;
-       };
-
-       vector<CaptureInfo*> capture_info;
-       Glib::Mutex  capture_info_lock;
-       
        void init (Diskstream::Flag);
 
        void init_channel (ChannelInfo &chan);
        void destroy_channel (ChannelInfo &chan);
        
        int use_new_write_source (uint32_t n=0);
-       int use_new_fade_source (uint32_t n=0) { return 0; } // FIXME?
 
        int find_and_use_playlist (const string&);
 
        void allocate_temporary_buffers ();
 
-       int  create_input_port () { return 0; } // FIXME?
-       int  connect_input_port () { return 0; } // FIXME?
-       int  seek_unlocked (jack_nframes_t which_sample) { return 0; } // FIXME?
-
-       int ports_created () { return 0; } // FIXME?
-
-       //bool realtime_set_speed (double, bool global_change);
-       void non_realtime_set_speed ();
-
-       std::list<Region*> _last_capture_regions;
-       std::vector<AudioFileSource*> capturing_sources;
        int use_pending_capture_data (XMLNode& node);
 
        void get_input_sources ();
-       void check_record_status (jack_nframes_t transport_frame, jack_nframes_t nframes, bool can_record);
+       void check_record_status (nframes_t transport_frame, nframes_t nframes, bool can_record);
        void set_align_style_from_io();
        void setup_destructive_playlist ();
        void use_destructive_playlist ();
 
-       ChannelList    channels;
-       AudioPlaylist* _playlist;
-       void engage_record_enable (void* src);
-       void disengage_record_enable (void* src);
+       void engage_record_enable ();
+       void disengage_record_enable ();
+
+       // Working buffers for do_refill (butler thread)
+       static void allocate_working_buffers();
+       static void free_working_buffers();
+
+       static size_t  _working_buffers_size;
+       static Sample* _mixdown_buffer;
+       static gain_t* _gain_buffer;
+
+       std::vector<boost::shared_ptr<AudioFileSource> > capturing_sources;
+       
+       SerializedRCUManager<ChannelList> channels;
+       
+ /* really */
+  private:
+       int _do_refill (Sample *mixdown_buffer, float *gain_buffer);
+
+       int add_channel_to (boost::shared_ptr<ChannelList>, uint32_t how_many);
+       int remove_channel_from (boost::shared_ptr<ChannelList>, uint32_t how_many);
+
 };
 
-}; /* namespace ARDOUR */
+} // namespace ARDOUR
 
 #endif /* __ardour_audio_diskstream_h__ */