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 #include <sigc++/signal.h>
  23
  24 #include <cmath>
  25 #include <string>
  26 #include <queue>
  27 #include <map>
  28 #include <vector>
  29
  30 #include <time.h>
  31
  32 #include <pbd/fastlog.h>
  33 #include <pbd/ringbufferNPT.h>
  34 #include <pbd/stateful.h>
  35
  36 #include <ardour/ardour.h>
  37 #include <ardour/configuration.h>
  38 #include <ardour/session.h>
  39 #include <ardour/route_group.h>
  40 #include <ardour/route.h>
  41 #include <ardour/port.h>
  42 #include <ardour/utils.h>
  43 #include <ardour/diskstream.h>
  44 #include <ardour/audioplaylist.h>
  45
  46 struct tm;
  47
  48 namespace ARDOUR {
  49
  50 class AudioEngine;
  51 class Send;
  52 class Session;
  53 class AudioPlaylist;
  54 class AudioFileSource;
  55 class IO;
  56
  57 class AudioDiskstream : public Diskstream
  58 {
  59   public:
  60         AudioDiskstream (Session &, const string& name, Diskstream::Flag f = Recordable);
  61         AudioDiskstream (Session &, const XMLNode&);
  62         ~AudioDiskstream();
  63
  64         float playback_buffer_load() const;
  65         float capture_buffer_load() const;
  66
  67         string input_source (uint32_t n=0) const {
  68                 if (n < channels.size()) {
  69                         return channels[n].source ? channels[n].source->name() : "";
  70                 } else {
  71                         return "";
  72                 }
  73         }
  74
  75         Port *input_source_port (uint32_t n=0) const {
  76                 if (n < channels.size()) return channels[n].source; return 0;
  77         }
  78
  79         void set_record_enabled (bool yn);
  80         int set_destructive (bool yn);
  81         bool can_become_destructive (bool& requires_bounce) const;
  82
  83         float peak_power(uint32_t n=0) {
  84                 float x = channels[n].peak_power;
  85                 channels[n].peak_power = 0.0f;
  86                 if (x > 0.0f) {
  87                         return 20.0f * fast_log10(x);
  88                 } else {
  89                         return minus_infinity();
  90                 }
  91         }
  92
  93         boost::shared_ptr<AudioPlaylist> audio_playlist () { return boost::dynamic_pointer_cast<AudioPlaylist>(_playlist); }
  94
  95         int use_playlist (boost::shared_ptr<Playlist>);
  96         int use_new_playlist ();
  97         int use_copy_playlist ();
  98
  99         Sample *playback_buffer (uint32_t n=0) {
 100                 if (n < channels.size())
 101                         return channels[n].current_playback_buffer;
 102                 return 0;
 103         }
 104
 105         Sample *capture_buffer (uint32_t n=0) {
 106                 if (n < channels.size())
 107                         return channels[n].current_capture_buffer;
 108                 return 0;
 109         }
 110
 111         boost::shared_ptr<AudioFileSource> write_source (uint32_t n=0) {
 112                 if (n < channels.size())
 113                         return channels[n].write_source;
 114                 return boost::shared_ptr<AudioFileSource>();
 115         }
 116
 117         int add_channel ();
 118         int remove_channel ();
 119
 120
 121         /* stateful */
 122
 123         XMLNode& get_state(void);
 124         int      set_state(const XMLNode& node);
 125
 126         void monitor_input (bool);
 127
 128         static void swap_by_ptr (Sample *first, Sample *last) {
 129                 while (first < last) {
 130                         Sample tmp = *first;
 131                         *first++ = *last;
 132                         *last-- = tmp;
 133                 }
 134         }
 135
 136         static void swap_by_ptr (Sample *first, Sample *last, nframes_t n) {
 137                 while (n--) {
 138                         Sample tmp = *first;
 139                         *first++ = *last;
 140                         *last-- = tmp;
 141                 }
 142         }
 143
 144         XMLNode* deprecated_io_node;
 145
 146   protected:
 147         friend class Session;
 148
 149         /* the Session is the only point of access for these
 150            because they require that the Session is "inactive"
 151            while they are called.
 152         */
 153
 154         void set_pending_overwrite(bool);
 155         int  overwrite_existing_buffers ();
 156         void set_block_size (nframes_t);
 157         int  internal_playback_seek (nframes_t distance);
 158         int  can_internal_playback_seek (nframes_t distance);
 159         int  rename_write_sources ();
 160         void reset_write_sources (bool, bool force = false);
 161         void non_realtime_input_change ();
 162
 163   protected:
 164         friend class Auditioner;
 165         int  seek (nframes_t which_sample, bool complete_refill = false);
 166
 167   protected:
 168         friend class AudioTrack;
 169
 170         int  process (nframes_t transport_frame, nframes_t nframes, nframes_t offset, bool can_record, bool rec_monitors_input);
 171         bool commit  (nframes_t nframes);
 172
 173   private:
 174
 175         struct ChannelInfo {
 176
 177             ChannelInfo ();
 178             ~ChannelInfo ();
 179
 180             void init (nframes_t buffer_size, nframes_t speed_buffer_size, nframes_t wrap_buffer_size);
 181             void release ();
 182
 183             Sample     *playback_wrap_buffer;
 184             Sample     *capture_wrap_buffer;
 185             Sample     *speed_buffer;
 186
 187             float       peak_power;
 188
 189             boost::shared_ptr<AudioFileSource> fades_source;
 190             boost::shared_ptr<AudioFileSource> write_source;
 191
 192             Port         *source;
 193             Sample       *current_capture_buffer;
 194             Sample       *current_playback_buffer;
 195
 196             RingBufferNPT<Sample> *playback_buf;
 197             RingBufferNPT<Sample> *capture_buf;
 198
 199             Sample* scrub_buffer;
 200             Sample* scrub_forward_buffer;
 201             Sample* scrub_reverse_buffer;
 202
 203             RingBufferNPT<Sample>::rw_vector playback_vector;
 204             RingBufferNPT<Sample>::rw_vector capture_vector;
 205
 206             RingBufferNPT<CaptureTransition> * capture_transition_buf;
 207             // the following are used in the butler thread only
 208             nframes_t                     curr_capture_cnt;
 209         };
 210
 211         /* The two central butler operations */
 212         int do_flush (Session::RunContext context, bool force = false);
 213         int do_refill () { return _do_refill(_mixdown_buffer, _gain_buffer); }
 214
 215         int do_refill_with_alloc();
 216
 217         int read (Sample* buf, Sample* mixdown_buffer, float* gain_buffer,
 218                 nframes_t& start, nframes_t cnt,
 219                 ChannelInfo& channel_info, int channel, bool reversed);
 220
 221         void finish_capture (bool rec_monitors_input);
 222         void transport_stopped (struct tm&, time_t, bool abort);
 223
 224         void init (Diskstream::Flag);
 225
 226         void init_channel (ChannelInfo &chan);
 227         void destroy_channel (ChannelInfo &chan);
 228
 229         int use_new_write_source (uint32_t n=0);
 230
 231         int find_and_use_playlist (const string&);
 232
 233         void allocate_temporary_buffers ();
 234
 235         int use_pending_capture_data (XMLNode& node);
 236
 237         void get_input_sources ();
 238         void check_record_status (nframes_t transport_frame, nframes_t nframes, bool can_record);
 239         void set_align_style_from_io();
 240         void setup_destructive_playlist ();
 241         void use_destructive_playlist ();
 242
 243         void engage_record_enable ();
 244         void disengage_record_enable ();
 245
 246         // Working buffers for do_refill (butler thread)
 247         static void allocate_working_buffers();
 248         static void free_working_buffers();
 249
 250         static size_t  _working_buffers_size;
 251         static Sample* _mixdown_buffer;
 252         static gain_t* _gain_buffer;
 253
 254         // Uh, /really/ private? (there should probably be less friends of Diskstream)
 255         int _do_refill (Sample *mixdown_buffer, float *gain_buffer);
 256
 257
 258         std::vector<boost::shared_ptr<AudioFileSource> > capturing_sources;
 259
 260         typedef vector<ChannelInfo> ChannelList;
 261         ChannelList channels;
 262 };
 263
 264 } // namespace ARDOUR
 265
 266 #endif /* __ardour_audio_diskstream_h__ */