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
  82         float peak_power(uint32_t n=0) {
  83                 float x = channels[n].peak_power;
  84                 channels[n].peak_power = 0.0f;
  85                 if (x > 0.0f) {
  86                         return 20.0f * fast_log10(x);
  87                 } else {
  88                         return minus_infinity();
  89                 }
  90         }
  91
  92         AudioPlaylist* audio_playlist () { return dynamic_cast<AudioPlaylist*>(_playlist); }
  93
  94         int use_playlist (Playlist *);
  95         int use_new_playlist ();
  96         int use_copy_playlist ();
  97
  98         Sample *playback_buffer (uint32_t n=0) {
  99                 if (n < channels.size())
 100                         return channels[n].current_playback_buffer;
 101                 return 0;
 102         }
 103
 104         Sample *capture_buffer (uint32_t n=0) {
 105                 if (n < channels.size())
 106                         return channels[n].current_capture_buffer;
 107                 return 0;
 108         }
 109
 110         boost::shared_ptr<AudioFileSource> write_source (uint32_t n=0) {
 111                 if (n < channels.size())
 112                         return channels[n].write_source;
 113                 return boost::shared_ptr<AudioFileSource>();
 114         }
 115
 116         int add_channel ();
 117         int remove_channel ();
 118
 119
 120         /* stateful */
 121
 122         XMLNode& get_state(void);
 123         int      set_state(const XMLNode& node);
 124
 125         void monitor_input (bool);
 126
 127         static void swap_by_ptr (Sample *first, Sample *last) {
 128                 while (first < last) {
 129                         Sample tmp = *first;
 130                         *first++ = *last;
 131                         *last-- = tmp;
 132                 }
 133         }
 134
 135         static void swap_by_ptr (Sample *first, Sample *last, nframes_t n) {
 136                 while (n--) {
 137                         Sample tmp = *first;
 138                         *first++ = *last;
 139                         *last-- = tmp;
 140                 }
 141         }
 142
 143         XMLNode* deprecated_io_node;
 144
 145   protected:
 146         friend class Session;
 147
 148         /* the Session is the only point of access for these
 149            because they require that the Session is "inactive"
 150            while they are called.
 151         */
 152
 153         void set_pending_overwrite(bool);
 154         int  overwrite_existing_buffers ();
 155         void set_block_size (nframes_t);
 156         int  internal_playback_seek (nframes_t distance);
 157         int  can_internal_playback_seek (nframes_t distance);
 158         int  rename_write_sources ();
 159         void reset_write_sources (bool, bool force = false);
 160         void non_realtime_input_change ();
 161
 162   protected:
 163         friend class Auditioner;
 164         int  seek (nframes_t which_sample, bool complete_refill = false);
 165
 166   protected:
 167         friend class AudioTrack;
 168
 169         int  process (nframes_t transport_frame, nframes_t nframes, nframes_t offset, bool can_record, bool rec_monitors_input);
 170         bool commit  (nframes_t nframes);
 171
 172   private:
 173
 174         struct ChannelInfo {
 175
 176                 Sample     *playback_wrap_buffer;
 177                 Sample     *capture_wrap_buffer;
 178                 Sample     *speed_buffer;
 179
 180                 float       peak_power;
 181
 182                 boost::shared_ptr<AudioFileSource> fades_source;
 183                 boost::shared_ptr<AudioFileSource> write_source;
 184
 185                 Port         *source;
 186                 Sample       *current_capture_buffer;
 187                 Sample       *current_playback_buffer;
 188
 189                 RingBufferNPT<Sample> *playback_buf;
 190                 RingBufferNPT<Sample> *capture_buf;
 191
 192                 Sample* scrub_buffer;
 193                 Sample* scrub_forward_buffer;
 194                 Sample* scrub_reverse_buffer;
 195
 196                 RingBufferNPT<Sample>::rw_vector playback_vector;
 197                 RingBufferNPT<Sample>::rw_vector capture_vector;
 198
 199                 RingBufferNPT<CaptureTransition> * capture_transition_buf;
 200                 // the following are used in the butler thread only
 201                 nframes_t                     curr_capture_cnt;
 202         };
 203
 204         /* The two central butler operations */
 205         int do_flush (Session::RunContext context, bool force = false);
 206         int do_refill () { return _do_refill(_mixdown_buffer, _gain_buffer); }
 207
 208         int do_refill_with_alloc();
 209
 210         int read (Sample* buf, Sample* mixdown_buffer, float* gain_buffer,
 211                 nframes_t& start, nframes_t cnt,
 212                 ChannelInfo& channel_info, int channel, bool reversed);
 213
 214         void finish_capture (bool rec_monitors_input);
 215         void transport_stopped (struct tm&, time_t, bool abort);
 216
 217         void init (Diskstream::Flag);
 218
 219         void init_channel (ChannelInfo &chan);
 220         void destroy_channel (ChannelInfo &chan);
 221
 222         int use_new_write_source (uint32_t n=0);
 223
 224         int find_and_use_playlist (const string&);
 225
 226         void allocate_temporary_buffers ();
 227
 228         int use_pending_capture_data (XMLNode& node);
 229
 230         void get_input_sources ();
 231         void check_record_status (nframes_t transport_frame, nframes_t nframes, bool can_record);
 232         void set_align_style_from_io();
 233         void setup_destructive_playlist ();
 234         void use_destructive_playlist ();
 235
 236         void engage_record_enable ();
 237         void disengage_record_enable ();
 238
 239         // Working buffers for do_refill (butler thread)
 240         static void allocate_working_buffers();
 241         static void free_working_buffers();
 242
 243         static size_t  _working_buffers_size;
 244         static Sample* _mixdown_buffer;
 245         static gain_t* _gain_buffer;
 246
 247         // Uh, /really/ private? (there should probably be less friends of Diskstream)
 248         int _do_refill (Sample *mixdown_buffer, float *gain_buffer);
 249
 250
 251         std::vector<boost::shared_ptr<AudioFileSource> > capturing_sources;
 252
 253         typedef vector<ChannelInfo> ChannelList;
 254         ChannelList channels;
 255
 256         bool can_become_destructive () const;
 257 };
 258
 259 } // namespace ARDOUR
 260
 261 #endif /* __ardour_audio_diskstream_h__ */