Clarify ensure vs. request for JACK monitoring, naming-wise.
[ardour.git] / libs / ardour / ardour / audio_diskstream.h
index 18f8328cfd55cd102621a44a0f7e9cc1b0219bcf..be43142f218b189bc2dcf97f6eb86d708ff55099 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2000-2006 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
@@ -19,7 +19,6 @@
 #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/stateful.h> 
+#include <boost/utility.hpp>
 
-#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 "pbd/fastlog.h"
+#include "pbd/ringbufferNPT.h"
+#include "pbd/stateful.h"
+#include "pbd/rcu.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,75 +54,67 @@ class AudioFileSource;
 class IO;
 
 class AudioDiskstream : public Diskstream
-{      
+{
   public:
-       AudioDiskstream (Session &, const string& name, Diskstream::Flag f = Recordable);
+       AudioDiskstream (Session &, const std::string& name, Diskstream::Flag f = Recordable);
        AudioDiskstream (Session &, const XMLNode&);
        ~AudioDiskstream();
 
-       const PBD::ID& id() const { return _id; }
-
        float playback_buffer_load() const;
        float capture_buffer_load() const;
 
-       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.name;
                } else {
-                       return ""; 
+                       return "";
                }
        }
 
-       Port *input_source_port (uint32_t n=0) const { 
-               if (n < channels.size()) return channels[n].source; return 0; 
-       }
-
        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;
 
-       float peak_power(uint32_t n=0) { 
-               float x = channels[n].peak_power;
-               channels[n].peak_power = 0.0f;
-               if (x > 0.0f) {
-                       return 20.0f * fast_log10(x);
-               } else {
-                       return minus_infinity();
-               }
-       }
-       
-       AudioPlaylist* audio_playlist () { return dynamic_cast<AudioPlaylist*>(_playlist); }
+       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 ();
 
-       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);
+
+       bool set_name (std::string const &);
+
        /* stateful */
 
        XMLNode& get_state(void);
-       int      set_state(const XMLNode& node);
+       int      set_state(const XMLNode& node, int version);
 
-       void monitor_input (bool);
+       void request_jack_monitors_input (bool);
 
        static void swap_by_ptr (Sample *first, Sample *last) {
                while (first < last) {
@@ -133,17 +124,7 @@ class AudioDiskstream : public Diskstream
                }
        }
 
-       static void swap_by_ptr (Sample *first, Sample *last, jack_nframes_t n) {
-               while (n--) {
-                       Sample tmp = *first;
-                       *first++ = *last;
-                       *last-- = tmp;
-               }
-       }
-
-       std::list<Region*>& last_capture_regions () { return _last_capture_regions; }
-
-       XMLNode* deprecated_io_node;
+       CubicInterpolation interpolation;
 
   protected:
        friend class Session;
@@ -155,87 +136,112 @@ class AudioDiskstream : public Diskstream
 
        void set_pending_overwrite(bool);
        int  overwrite_existing_buffers ();
-       void set_block_size (jack_nframes_t);
-       int  internal_playback_seek (jack_nframes_t distance);
-       int  can_internal_playback_seek (jack_nframes_t distance);
-       int  rename_write_sources ();
+       void set_block_size (pframes_t);
+       int  internal_playback_seek (framecnt_t distance);
+       int  can_internal_playback_seek (framecnt_t distance);
+       std::list<boost::shared_ptr<Source> > steal_write_sources();
        void reset_write_sources (bool, bool force = false);
        void non_realtime_input_change ();
+       void non_realtime_locate (framepos_t location);
 
   protected:
        friend class Auditioner;
-       int  seek (jack_nframes_t which_sample, bool complete_refill = false);
+       int  seek (framepos_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 (framepos_t transport_frame, pframes_t nframes, framecnt_t &);
+       bool commit  (framecnt_t);
 
   private:
+       struct ChannelSource {
+               std::string name;
+
+               bool is_physical () const;
+               void request_jack_monitors_input (bool) const;
+       };
 
-       struct ChannelInfo {
+       /** Information about one of our channels */
+       struct ChannelInfo : public boost::noncopyable {
+
+               ChannelInfo (framecnt_t playback_buffer_size,
+                            framecnt_t capture_buffer_size,
+                            framecnt_t speed_buffer_size,
+                            framecnt_t wrap_buffer_size);
+               ~ChannelInfo ();
 
                Sample     *playback_wrap_buffer;
                Sample     *capture_wrap_buffer;
                Sample     *speed_buffer;
 
-               float       peak_power;
+               boost::shared_ptr<AudioFileSource> write_source;
 
-               AudioFileSource   *fades_source;
-               AudioFileSource   *write_source;
+               /** Information about the Port that our audio data comes from */
+               ChannelSource source;
 
-               Port         *source;
                Sample       *current_capture_buffer;
                Sample       *current_playback_buffer;
 
-               RingBufferNPT<Sample> *playback_buf;
-               RingBufferNPT<Sample> *capture_buf;
+               /** A ringbuffer for data to be played back, written to in the
+                   butler thread, read from in the process thread.
+               */
+               PBD::RingBufferNPT<Sample> *playback_buf;
+               PBD::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;
+               PBD::RingBufferNPT<Sample>::rw_vector playback_vector;
+               PBD::RingBufferNPT<Sample>::rw_vector capture_vector;
 
-               RingBufferNPT<CaptureTransition> * capture_transition_buf;
+               PBD::RingBufferNPT<CaptureTransition> * capture_transition_buf;
                // the following are used in the butler thread only
-               jack_nframes_t                     curr_capture_cnt;
+               framecnt_t                     curr_capture_cnt;
+
+               void resize_playback (framecnt_t);
+               void resize_capture (framecnt_t);
        };
 
+       typedef std::vector<ChannelInfo*> ChannelList;
+
        /* The two central butler operations */
-       int do_flush (Session::RunContext context, bool force = false);
+       int do_flush (RunContext context, bool force = false);
        int do_refill () { return _do_refill(_mixdown_buffer, _gain_buffer); }
-       
-       int do_refill_with_alloc();
+
+       int do_refill_with_alloc ();
 
        int read (Sample* buf, Sample* mixdown_buffer, float* gain_buffer,
-               jack_nframes_t& start, jack_nframes_t cnt, 
-               ChannelInfo& channel_info, int channel, bool reversed);
+                 framepos_t& start, framecnt_t cnt,
+                 int channel, bool reversed);
 
-       void finish_capture (bool rec_monitors_input);
-       void transport_stopped (struct tm&, time_t, bool abort);
+       void finish_capture (boost::shared_ptr<ChannelList>);
+       void transport_stopped_wallclock (struct tm&, time_t, bool abort);
+       void transport_looped (framepos_t transport_frame);
 
-       void init (Diskstream::Flag);
+       void init ();
 
        void init_channel (ChannelInfo &chan);
        void destroy_channel (ChannelInfo &chan);
-       
+
        int use_new_write_source (uint32_t n=0);
 
-       int find_and_use_playlist (const string&);
+       int find_and_use_playlist (const std::string &);
 
        void allocate_temporary_buffers ();
 
        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(framepos_t capture_start_frame);
        void set_align_style_from_io();
        void setup_destructive_playlist ();
        void use_destructive_playlist ();
 
+       void adjust_playback_buffering ();
+       void adjust_capture_buffering ();
+
        void engage_record_enable ();
        void disengage_record_enable ();
 
@@ -247,14 +253,17 @@ class AudioDiskstream : public Diskstream
        static Sample* _mixdown_buffer;
        static gain_t* _gain_buffer;
 
-       // Uh, /really/ private? (there should probably be less friends of Diskstream)
+       std::vector<boost::shared_ptr<AudioFileSource> > capturing_sources;
+
+       SerializedRCUManager<ChannelList> channels;
+
+ /* really */
+  private:
        int _do_refill (Sample *mixdown_buffer, float *gain_buffer);
-       
-       
-       std::vector<AudioFileSource*> capturing_sources;
-       
-       typedef vector<ChannelInfo> ChannelList;
-       ChannelList channels;
+
+       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