libs/ardour/ardour/disk_io.h

   1 /*
   2     Copyright (C) 2009-2016 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
  20 #ifndef __ardour_disk_io_h__
  21 #define __ardour_disk_io_h__
  22
  23 #include <vector>
  24 #include <string>
  25 #include <exception>
  26
  27 #include "pbd/ringbufferNPT.h"
  28 #include "pbd/rcu.h"
  29
  30 #include "ardour/interpolation.h"
  31 #include "ardour/processor.h"
  32
  33 namespace ARDOUR {
  34
  35 class AudioFileSource;
  36 class AudioPlaylist;
  37 class Location;
  38 class MidiPlaylist;
  39 class Playlist;
  40 class Route;
  41 class Route;
  42 class Session;
  43
  44 template<typename T> class MidiRingBuffer;
  45
  46 class LIBARDOUR_API DiskIOProcessor : public Processor
  47 {
  48 public:
  49         enum Flag {
  50                 Recordable  = 0x1,
  51                 Hidden      = 0x2,
  52                 Destructive = 0x4,
  53                 NonLayered  = 0x8 // deprecated (kept only for enum compat)
  54         };
  55
  56         static const std::string state_node_name;
  57
  58         DiskIOProcessor (Session&, const std::string& name, Flag f);
  59         virtual ~DiskIOProcessor ();
  60
  61         void set_route (boost::shared_ptr<Route>);
  62         void drop_route ();
  63
  64         static void set_buffering_parameters (BufferingPreset bp);
  65
  66         int set_block_size (pframes_t);
  67         bool configure_io (ChanCount in, ChanCount out);
  68         bool can_support_io_configuration (const ChanCount& in, ChanCount& out);
  69
  70         /** @return A number between 0 and 1, where 0 indicates that the playback/capture buffer
  71          *  is dry (ie the disk subsystem could not keep up) and 1 indicates that the
  72          *  buffer is full.
  73          */
  74         virtual float buffer_load() const = 0;
  75
  76         void set_flag (Flag f)   { _flags = Flag (_flags | f); }
  77         void unset_flag (Flag f) { _flags = Flag (_flags & ~f); }
  78
  79         bool           hidden()      const { return _flags & Hidden; }
  80         bool           recordable()  const { return _flags & Recordable; }
  81
  82         virtual void non_realtime_locate (samplepos_t);
  83
  84         virtual void punch_in()  {}
  85         virtual void punch_out() {}
  86
  87         bool slaved() const      { return _slaved; }
  88         void set_slaved(bool yn) { _slaved = yn; }
  89
  90         PBD::Signal0<void>            SpeedChanged;
  91         PBD::Signal0<void>            ReverseChanged;
  92
  93         int set_state (const XMLNode&, int version);
  94
  95         int add_channel (uint32_t how_many);
  96         int remove_channel (uint32_t how_many);
  97
  98         bool need_butler() const { return _need_butler; }
  99
 100         boost::shared_ptr<Playlist>      get_playlist (DataType dt) const { return _playlists[dt]; }
 101         boost::shared_ptr<MidiPlaylist>  midi_playlist() const;
 102         boost::shared_ptr<AudioPlaylist> audio_playlist() const;
 103
 104         virtual void playlist_modified () {}
 105         virtual int use_playlist (DataType, boost::shared_ptr<Playlist>);
 106
 107         virtual void adjust_buffering() = 0;
 108
 109 protected:
 110         friend class Auditioner;
 111         virtual int  seek (samplepos_t which_sample, bool complete_refill = false) = 0;
 112
 113 protected:
 114         Flag         _flags;
 115         uint32_t      i_am_the_modifier;
 116         double       _actual_speed;
 117         double       _target_speed;
 118         bool         _slaved;
 119         bool          in_set_state;
 120         samplepos_t   playback_sample;
 121         bool         _need_butler;
 122         boost::shared_ptr<Route> _route;
 123
 124         void init ();
 125
 126         Glib::Threads::Mutex state_lock;
 127
 128         static bool get_buffering_presets (BufferingPreset bp,
 129                                            samplecnt_t& read_chunk_size,
 130                                            samplecnt_t& read_buffer_size,
 131                                            samplecnt_t& write_chunk_size,
 132                                            samplecnt_t& write_buffer_size);
 133
 134         enum TransitionType {
 135                 CaptureStart = 0,
 136                 CaptureEnd
 137         };
 138
 139         struct CaptureTransition {
 140                 TransitionType   type;
 141                 samplepos_t       capture_val; ///< The start or end file sample position
 142         };
 143
 144         /** Information about one audio channel, playback or capture
 145          * (depending on the derived class)
 146          */
 147         struct ChannelInfo : public boost::noncopyable {
 148
 149                 ChannelInfo (samplecnt_t buffer_size);
 150                 virtual ~ChannelInfo ();
 151
 152                 /** Ringbuffer for data to be played back.
 153                  * written to in the butler thread, read from in the process thread.
 154                  */
 155                 PBD::RingBufferNPT<Sample>* rbuf;
 156
 157                 /** A ringbuffer for data to be recorded back, written to in the
 158                  * process thread, read from in the butler thread.
 159                  */
 160                 PBD::RingBufferNPT<Sample>* wbuf;
 161                 PBD::RingBufferNPT<Sample>::rw_vector rw_vector;
 162
 163                 /* used only by capture */
 164                 boost::shared_ptr<AudioFileSource> write_source;
 165                 PBD::RingBufferNPT<CaptureTransition>* capture_transition_buf;
 166
 167                 /* used in the butler thread only */
 168                 samplecnt_t curr_capture_cnt;
 169
 170                 virtual void resize (samplecnt_t) = 0;
 171         };
 172
 173         typedef std::vector<ChannelInfo*> ChannelList;
 174         SerializedRCUManager<ChannelList> channels;
 175
 176         virtual int add_channel_to (boost::shared_ptr<ChannelList>, uint32_t how_many) = 0;
 177         int remove_channel_from (boost::shared_ptr<ChannelList>, uint32_t how_many);
 178
 179         boost::shared_ptr<Playlist> _playlists[DataType::num_types];
 180         PBD::ScopedConnectionList playlist_connections;
 181
 182         virtual void playlist_changed (const PBD::PropertyChange&) {}
 183         virtual void playlist_deleted (boost::weak_ptr<Playlist>);
 184         virtual void playlist_ranges_moved (std::list< Evoral::RangeMove<samplepos_t> > const &, bool) {}
 185
 186         /* The MIDI stuff */
 187
 188         MidiRingBuffer<samplepos_t>*  _midi_buf;
 189         gint                         _samples_written_to_ringbuffer;
 190         gint                         _samples_read_from_ringbuffer;
 191
 192         static void get_location_times (const Location* location, samplepos_t* start, samplepos_t* end, samplepos_t* length);
 193 };
 194
 195 } // namespace ARDOUR
 196
 197 #endif /* __ardour_disk_io_h__ */