Move Diskstream ownership to Track, so that Session no longer holds lists of Diskstre...
[ardour.git] / libs / ardour / ardour / audio_diskstream.h
index 9355a3fccbf7a815aa5d2e8eb7f446382c24efb3..6cf064a61d18e713c4fbecac860b01621015db5c 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
     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_diskstream_h__
-#define __ardour_diskstream_h__
+#ifndef __ardour_audio_diskstream_h__
+#define __ardour_audio_diskstream_h__
 
-#include <sigc++/signal.h>
 
 #include <cmath>
 #include <string>
 
 #include <time.h>
 
-#include <pbd/fastlog.h>
-#include <pbd/ringbufferNPT.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/stateful.h>
+#include "ardour/ardour.h"
+#include "ardour/utils.h"
+#include "ardour/diskstream.h"
+#include "ardour/audioplaylist.h"
+#include "ardour/port.h"
+#include "ardour/interpolation.h"
 
 struct tm;
 
@@ -55,77 +51,40 @@ class AudioPlaylist;
 class AudioFileSource;
 class IO;
 
-class AudioDiskstream : public Stateful, public sigc::trackable
-{      
+class AudioDiskstream : public Diskstream
+{
   public:
-       enum Flag {
-               Recordable = 0x1,
-               Hidden = 0x2,
-               Destructive = 0x4
-       };
-
-       AudioDiskstream (Session &, const string& name, Flag f = Recordable);
+       AudioDiskstream (Session &, const std::string& name, Diskstream::Flag f = Recordable);
        AudioDiskstream (Session &, const XMLNode&);
-
-       string name() const { return _name; }
-
-       ARDOUR::IO* io() const { return _io; }
-       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_flag (Flag f) {
-               _flags |= f;
-       }
-
-       void unset_flag (Flag f) {
-               _flags &= ~f;
-       }
-
-       AlignStyle alignment_style() const { return _alignment_style; }
-       void set_align_style (AlignStyle);
-       void set_persistent_align_style (AlignStyle);
-
-       bool hidden() const { return _flags & Hidden; }
-       bool recordable() const { return _flags & Recordable; }
-       bool destructive() const { return _flags & Destructive; }
-
-       void set_destructive (bool yn);
-
-       jack_nframes_t roll_delay() const { return _roll_delay; }
-       void set_roll_delay (jack_nframes_t);
-
-       int set_name (string str, void* src);
-
-       string input_source (uint32_t n=0) const {
-               if (n < channels.size()) {
-                       return channels[n].source ? channels[n].source->name() : "";
+       std::string input_source (uint32_t n=0) const {
+               boost::shared_ptr<ChannelList> c = channels.reader();
+               if (n < c->size()) {
+                       return (*c)[n]->source ? (*c)[n]->source->name() : "";
                } else {
-                       return ""; 
+                       return "";
                }
        }
 
-       Port *input_source_port (uint32_t n=0) const { 
-               if (n < channels.size()) return channels[n].source; return 0; 
+       Port *input_source_port (uint32_t n=0) const {
+               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);
-       bool record_enabled() const { return g_atomic_int_get (&_record_enabled); }
-       void punch_in ();
-       void punch_out ();
+       void set_record_enabled (bool yn);
+       int set_destructive (bool yn);
+       int set_non_layered (bool yn);
+       bool can_become_destructive (bool& requires_bounce) const;
 
-       bool  reversed() const { return _actual_speed < 0.0f; }
-       double speed() const { return _visible_speed; }
-       void set_speed (double);
-
-       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 {
@@ -133,70 +92,43 @@ class AudioDiskstream : public Stateful, public sigc::trackable
                }
        }
 
-       int  use_playlist (AudioPlaylist *);
+       boost::shared_ptr<AudioPlaylist> audio_playlist () { return boost::dynamic_pointer_cast<AudioPlaylist>(_playlist); }
+
+       int use_playlist (boost::shared_ptr<Playlist>);
        int use_new_playlist ();
        int use_copy_playlist ();
 
-       void start_scrub (jack_nframes_t where);
-       void end_scrub ();
-
-       Sample *playback_buffer (uint32_t n=0) {
-               if (n < channels.size())
-                       return channels[n].current_playback_buffer;
-               return 0;
-       }
-       
-       Sample *capture_buffer (uint32_t n=0) {
-               if (n < channels.size())
-                       return channels[n].current_capture_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;
        }
 
-       AudioPlaylist *playlist () { return _playlist; }
-
-       AudioFileSource *write_source (uint32_t n=0) {
-               if (n < channels.size())
-                       return channels[n].write_source;
+       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;
        }
 
-       jack_nframes_t current_capture_start() const { return capture_start_frame; }
-       jack_nframes_t current_capture_end() const { return capture_start_frame + capture_captured; }
-       jack_nframes_t get_capture_start_frame (uint32_t n=0);
-       jack_nframes_t get_captured_frames (uint32_t n=0);
-       
-       uint32_t n_channels() { return _n_channels; }
-
-       int add_channel ();
-       int remove_channel ();
-       
-       static void set_disk_io_chunk_frames (uint32_t n) {
-               disk_io_chunk_frames = n;
+       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>();
        }
 
-       static jack_nframes_t disk_io_frames() { return disk_io_chunk_frames; }
-       
-       sigc::signal<void,void*> record_enable_changed;
-       sigc::signal<void>       speed_changed;
-       sigc::signal<void,void*> reverse_changed;
-       sigc::signal<void>       PlaylistChanged;
-       sigc::signal<void>       AlignmentStyleChanged;
-
-       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 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, int version);
 
        void monitor_input (bool);
 
-       jack_nframes_t capture_offset() const { return _capture_offset; }
-       void           set_capture_offset ();
-
        static void swap_by_ptr (Sample *first, Sample *last) {
                while (first < last) {
                        Sample tmp = *first;
@@ -205,7 +137,7 @@ class AudioDiskstream : public Stateful, public sigc::trackable
                }
        }
 
-       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;
@@ -213,19 +145,7 @@ class AudioDiskstream : public Stateful, public sigc::trackable
                }
        }
 
-       bool slaved() const { return _slaved; }
-       void set_slaved(bool yn) { _slaved = yn; }
-
-       int set_loop (Location *loc);
-       sigc::signal<void,Location *> LoopSet;
-
-       std::list<Region*>& last_capture_regions () {
-               return _last_capture_regions;
-       }
-
-       void handle_input_change (IOChange, void *src);
-
-       id_t id() const { return _id; }
+       CubicInterpolation interpolation;
 
        XMLNode* deprecated_io_node;
 
@@ -237,60 +157,43 @@ class AudioDiskstream : public Stateful, public sigc::trackable
           while they are called.
        */
 
-       void set_pending_overwrite (bool);
+       void set_pending_overwrite(bool);
        int  overwrite_existing_buffers ();
-       void reverse_scrub_buffer (bool to_forward);
-       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 ();
-
-       uint32_t read_data_count() const { return _read_data_count; }
-       uint32_t write_data_count() const { return _write_data_count; }
+       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;
 
-       void prepare ();
-       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);
-       void recover (); /* called if commit will not be called, but process was */
+       int  process (nframes_t transport_frame, nframes_t nframes, bool can_record, bool rec_monitors_input, bool& need_butler);
+       bool commit  (nframes_t nframes);
 
   private:
 
-       /* use unref() to destroy a diskstream */
-
-       ~AudioDiskstream();
-
-       enum TransitionType {
-               CaptureStart = 0,
-               CaptureEnd
-       };
-       
-       struct CaptureTransition {
-
-               TransitionType   type;
-               // the start or end file frame pos
-               jack_nframes_t   capture_val;
-       };
-       
        struct ChannelInfo {
 
+               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;
+               float       peak_power;
 
-               AudioFileSource   *fades_source;
-               AudioFileSource   *write_source;
+               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;
@@ -307,141 +210,70 @@ class AudioDiskstream : public Stateful, public sigc::trackable
 
                RingBufferNPT<CaptureTransition> * capture_transition_buf;
                // the following are used in the butler thread only
-               jack_nframes_t                     curr_capture_cnt;
+               nframes_t                     curr_capture_cnt;
        };
 
-       typedef vector<ChannelInfo> ChannelList;
-
-
-       string            _name;
-       ARDOUR::Session&  _session;
-       ARDOUR::IO*       _io;
-       ChannelList        channels;
-       uint32_t      _n_channels;
-       id_t              _id;
-
-       mutable gint             _record_enabled;
-       AudioPlaylist*           _playlist;
-       double                   _visible_speed;
-       double                   _actual_speed;
-       /* items needed for speed change logic */
-       bool                     _buffer_reallocation_required;
-       bool                     _seek_required;
-       
-       bool                      force_refill;
-       jack_nframes_t            capture_start_frame;
-       jack_nframes_t            capture_captured;
-       bool                      was_recording;
-       jack_nframes_t            adjust_capture_position;
-       jack_nframes_t           _capture_offset;
-       jack_nframes_t           _roll_delay;
-       jack_nframes_t            first_recordable_frame;
-       jack_nframes_t            last_recordable_frame;
-       int                       last_possibly_recording;
-       AlignStyle               _alignment_style;
-       bool                     _scrubbing;
-       bool                     _slaved;
-       bool                     _processed;
-       Location*                 loop_location;
-       jack_nframes_t            overwrite_frame;
-       off_t                     overwrite_offset;
-       bool                      pending_overwrite;
-       bool                      overwrite_queued;
-       IOChange                  input_change_pending;
-       jack_nframes_t            wrap_buffer_size;
-       jack_nframes_t            speed_buffer_size;
-
-       uint64_t                  last_phase;
-       uint64_t                  phi;
-       
-       jack_nframes_t            file_frame;           
-       jack_nframes_t            playback_sample;
-       jack_nframes_t            playback_distance;
-
-       uint32_t                 _read_data_count;
-       uint32_t                 _write_data_count;
-
-       bool                      in_set_state;
-       AlignStyle               _persistent_alignment_style;
-       bool                      first_input_change;
-
-       Glib::Mutex  state_lock;
-
-       jack_nframes_t scrub_start;
-       jack_nframes_t scrub_buffer_size;
-       jack_nframes_t scrub_offset;
-       uint32_t _refcnt;
-
-       sigc::connection ports_created_c;
-       sigc::connection plmod_connection;
-       sigc::connection plstate_connection;
-       sigc::connection plgone_connection;
-
-       /* the two central butler operations */
-
-       int do_flush (char * workbuf, bool force = false);
-       int do_refill (Sample *mixdown_buffer, float *gain_buffer, char *workbuf);
-
-       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);
-
-       uint32_t i_am_the_modifier;
-       
-       /* XXX fix this redundancy ... */
-
-       void playlist_changed (Change);
-       void playlist_modified ();
-       void playlist_deleted (Playlist*);
-       void session_controls_changed (Session::ControlType);
-
-       void finish_capture (bool rec_monitors_input);
-       void clean_up_capture (struct tm&, time_t, bool abort);
-       void transport_stopped (struct tm&, time_t, bool abort);
-
-       struct CaptureInfo {
-           uint32_t start;
-           uint32_t frames;
-       };
+       typedef std::vector<ChannelInfo*> ChannelList;
 
-       vector<CaptureInfo*> capture_info;
-       Glib::Mutex  capture_info_lock;
-       
-       void init (Flag);
+       void process_varispeed_playback(nframes_t nframes, boost::shared_ptr<ChannelList> c);
 
-       void init_channel (ChannelInfo &chan);
-       void destroy_channel (ChannelInfo &chan);
-       
-       static jack_nframes_t disk_io_chunk_frames;
+       /* The two central butler operations */
+       int do_flush (RunContext context, bool force = false);
+       int do_refill () { return _do_refill(_mixdown_buffer, _gain_buffer); }
 
-       int use_new_write_source (uint32_t n=0);
-       int use_new_fade_source (uint32_t n=0);
+       int do_refill_with_alloc ();
 
-       int find_and_use_playlist (const string&);
+       int read (Sample* buf, Sample* mixdown_buffer, float* gain_buffer,
+                       nframes_t& start, nframes_t cnt,
+                       ChannelInfo* channel_info, int channel, bool reversed);
 
-       void allocate_temporary_buffers ();
+       void finish_capture (bool rec_monitors_input, boost::shared_ptr<ChannelList>);
+       void transport_stopped_wallclock (struct tm&, time_t, bool abort);
+       void transport_looped (nframes_t transport_frame);
 
-       unsigned char _flags;
+       void init ();
 
-       int  create_input_port ();
-       int  connect_input_port ();
-       int  seek_unlocked (jack_nframes_t which_sample);
+       void init_channel (ChannelInfo &chan);
+       void destroy_channel (ChannelInfo &chan);
 
-       int ports_created ();
+       int use_new_write_source (uint32_t n=0);
 
-       bool realtime_set_speed (double, bool global_change);
-       void non_realtime_set_speed ();
+       int find_and_use_playlist (const std::string &);
+
+       void allocate_temporary_buffers ();
 
-       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 prepare_record_status(nframes_t capture_start_frame);
        void set_align_style_from_io();
        void setup_destructive_playlist ();
        void use_destructive_playlist ();
+
+       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_diskstream_h__ */
+#endif /* __ardour_audio_diskstream_h__ */