libs/ardour/ardour/audio_diskstream.h

   1 /*
   2     Copyright (C) 2000-2006 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17 */
  18
  19 #ifndef __ardour_audio_diskstream_h__
  20 #define __ardour_audio_diskstream_h__
  21
  22
  23 #include <cmath>
  24 #include <string>
  25 #include <queue>
  26 #include <map>
  27 #include <vector>
  28
  29 #include <time.h>
  30
  31 #include <boost/utility.hpp>
  32
  33 #include "pbd/fastlog.h"
  34 #include "pbd/ringbufferNPT.h"
  35 #include "pbd/stateful.h"
  36 #include "pbd/rcu.h"
  37
  38 #include "ardour/ardour.h"
  39 #include "ardour/utils.h"
  40 #include "ardour/diskstream.h"
  41 #include "ardour/audioplaylist.h"
  42 #include "ardour/port.h"
  43 #include "ardour/interpolation.h"
  44
  45 struct tm;
  46
  47 namespace ARDOUR {
  48
  49 class AudioEngine;
  50 class Send;
  51 class Session;
  52 class AudioPlaylist;
  53 class AudioFileSource;
  54 class IO;
  55
  56 class LIBARDOUR_API AudioDiskstream : public Diskstream
  57 {
  58   public:
  59         AudioDiskstream (Session &, const std::string& name, Diskstream::Flag f = Recordable);
  60         AudioDiskstream (Session &, const XMLNode&);
  61         ~AudioDiskstream();
  62
  63         float playback_buffer_load() const;
  64         float capture_buffer_load() const;
  65
  66         std::string input_source (uint32_t n=0) const {
  67                 boost::shared_ptr<ChannelList> c = channels.reader();
  68                 if (n < c->size()) {
  69                         return (*c)[n]->source.name;
  70                 } else {
  71                         return "";
  72                 }
  73         }
  74
  75         void set_record_enabled (bool yn);
  76         void set_record_safe (bool yn);
  77         int set_destructive (bool yn);
  78         int set_non_layered (bool yn);
  79         bool can_become_destructive (bool& requires_bounce) const;
  80
  81         boost::shared_ptr<AudioPlaylist> audio_playlist () { return boost::dynamic_pointer_cast<AudioPlaylist>(_playlist); }
  82
  83         int use_playlist (boost::shared_ptr<Playlist>);
  84         int use_new_playlist ();
  85         int use_copy_playlist ();
  86
  87         Sample *playback_buffer (uint32_t n = 0) {
  88                 boost::shared_ptr<ChannelList> c = channels.reader();
  89                 if (n < c->size())
  90                         return (*c)[n]->current_playback_buffer;
  91                 return 0;
  92         }
  93
  94         Sample *capture_buffer (uint32_t n = 0) {
  95                 boost::shared_ptr<ChannelList> c = channels.reader();
  96                 if (n < c->size())
  97                         return (*c)[n]->current_capture_buffer;
  98                 return 0;
  99         }
 100
 101         boost::shared_ptr<AudioFileSource> write_source (uint32_t n=0) {
 102                 boost::shared_ptr<ChannelList> c = channels.reader();
 103                 if (n < c->size())
 104                         return (*c)[n]->write_source;
 105                 return boost::shared_ptr<AudioFileSource>();
 106         }
 107
 108         int add_channel (uint32_t how_many);
 109         int remove_channel (uint32_t how_many);
 110
 111         bool set_name (std::string const &);
 112         bool set_write_source_name (const std::string& str);
 113
 114         /* stateful */
 115
 116         XMLNode& get_state(void);
 117         int      set_state(const XMLNode& node, int version);
 118
 119         void request_input_monitoring (bool);
 120
 121         static void swap_by_ptr (Sample *first, Sample *last) {
 122                 while (first < last) {
 123                         Sample tmp = *first;
 124                         *first++ = *last;
 125                         *last-- = tmp;
 126                 }
 127         }
 128
 129
 130   protected:
 131         friend class Session;
 132
 133         /* the Session is the only point of access for these
 134            because they require that the Session is "inactive"
 135            while they are called.
 136         */
 137
 138         void set_pending_overwrite(bool);
 139         int  overwrite_existing_buffers ();
 140         void set_block_size (pframes_t);
 141         int  internal_playback_seek (framecnt_t distance);
 142         int  can_internal_playback_seek (framecnt_t distance);
 143         void reset_write_sources (bool, bool force = false);
 144         void non_realtime_input_change ();
 145         void non_realtime_locate (framepos_t location);
 146
 147   protected:
 148         friend class Auditioner;
 149         friend class AudioTrack;
 150         int  seek (framepos_t which_sample, bool complete_refill = false);
 151
 152         int  process (BufferSet&, framepos_t transport_frame, pframes_t nframes, framecnt_t &, bool need_disk_signal);
 153         frameoffset_t calculate_playback_distance (pframes_t nframes);
 154         bool commit  (framecnt_t);
 155
 156   private:
 157         struct ChannelSource {
 158                 std::string name;
 159
 160                 bool is_physical () const;
 161                 void request_input_monitoring (bool) const;
 162         };
 163
 164         /** Information about one of our channels */
 165         struct ChannelInfo : public boost::noncopyable {
 166
 167                 ChannelInfo (framecnt_t playback_buffer_size,
 168                              framecnt_t capture_buffer_size,
 169                              framecnt_t speed_buffer_size,
 170                              framecnt_t wrap_buffer_size);
 171                 ~ChannelInfo ();
 172
 173                 Sample     *playback_wrap_buffer;
 174                 Sample     *capture_wrap_buffer;
 175                 Sample     *speed_buffer;
 176
 177                 boost::shared_ptr<AudioFileSource> write_source;
 178
 179                 /** Information about the Port that our audio data comes from */
 180                 ChannelSource source;
 181
 182                 Sample       *current_capture_buffer;
 183                 Sample       *current_playback_buffer;
 184
 185                 /** A ringbuffer for data to be played back, written to in the
 186                     butler thread, read from in the process thread.
 187                 */
 188                 PBD::RingBufferNPT<Sample> *playback_buf;
 189                 PBD::RingBufferNPT<Sample> *capture_buf;
 190
 191                 Sample* scrub_buffer;
 192                 Sample* scrub_forward_buffer;
 193                 Sample* scrub_reverse_buffer;
 194
 195                 PBD::RingBufferNPT<Sample>::rw_vector playback_vector;
 196                 PBD::RingBufferNPT<Sample>::rw_vector capture_vector;
 197
 198                 PBD::RingBufferNPT<CaptureTransition> * capture_transition_buf;
 199                 // the following are used in the butler thread only
 200                 framecnt_t                     curr_capture_cnt;
 201
 202                 void resize_playback (framecnt_t);
 203                 void resize_capture (framecnt_t);
 204         };
 205
 206         typedef std::vector<ChannelInfo*> ChannelList;
 207
 208         CubicInterpolation interpolation;
 209
 210         /* The two central butler operations */
 211         int do_flush (RunContext context, bool force = false);
 212         int do_refill () { return _do_refill(_mixdown_buffer, _gain_buffer, 0); }
 213
 214
 215         int read (Sample* buf, Sample* mixdown_buffer, float* gain_buffer,
 216                   framepos_t& start, framecnt_t cnt,
 217                   int channel, bool reversed);
 218
 219         void finish_capture (boost::shared_ptr<ChannelList>);
 220         void transport_stopped_wallclock (struct tm&, time_t, bool abort);
 221         void transport_looped (framepos_t transport_frame);
 222
 223         void init ();
 224
 225         void init_channel (ChannelInfo &chan);
 226         void destroy_channel (ChannelInfo &chan);
 227
 228         int use_new_write_source (uint32_t n=0);
 229
 230         int find_and_use_playlist (const std::string &);
 231
 232         void allocate_temporary_buffers ();
 233
 234         int use_pending_capture_data (XMLNode& node);
 235
 236         void get_input_sources ();
 237         void prepare_record_status(framepos_t capture_start_frame);
 238         void set_align_style_from_io();
 239         void setup_destructive_playlist ();
 240         void use_destructive_playlist ();
 241
 242         void adjust_playback_buffering ();
 243         void adjust_capture_buffering ();
 244
 245         bool prep_record_enable ();
 246         bool prep_record_disable ();
 247
 248         // Working buffers for do_refill (butler thread)
 249         static void allocate_working_buffers();
 250         static void free_working_buffers();
 251
 252         static Sample* _mixdown_buffer;
 253         static gain_t* _gain_buffer;
 254
 255         std::vector<boost::shared_ptr<AudioFileSource> > capturing_sources;
 256
 257         SerializedRCUManager<ChannelList> channels;
 258
 259   protected:
 260         int _do_refill_with_alloc (bool one_chunk_only);
 261
 262  /* really */
 263   private:
 264         int _do_refill (Sample *mixdown_buffer, float *gain_buffer, framecnt_t fill_level);
 265
 266         int add_channel_to (boost::shared_ptr<ChannelList>, uint32_t how_many);
 267         int remove_channel_from (boost::shared_ptr<ChannelList>, uint32_t how_many);
 268
 269 };
 270
 271 } // namespace ARDOUR
 272
 273 #endif /* __ardour_audio_diskstream_h__ */