libs/ardour/ardour/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
  20 #ifndef __ardour_diskstream_h__
  21 #define __ardour_diskstream_h__
  22
  23 #include <string>
  24 #include <queue>
  25 #include <map>
  26 #include <vector>
  27 #include <cmath>
  28 #include <time.h>
  29
  30 #include <boost/utility.hpp>
  31
  32 #include "evoral/types.hpp"
  33
  34 #include "ardour/ardour.h"
  35 #include "ardour/chan_count.h"
  36 #include "ardour/session_object.h"
  37 #include "ardour/libardour_visibility.h"
  38 #include "ardour/types.h"
  39 #include "ardour/utils.h"
  40 #include "ardour/public_diskstream.h"
  41
  42 struct tm;
  43
  44 namespace ARDOUR {
  45
  46 class IO;
  47 class Playlist;
  48 class Processor;
  49 class Source;
  50 class Session;
  51 class Track;
  52 class Location;
  53 class BufferSet;
  54
  55 /** Parent class for classes which can stream data to and from disk.
  56  *  These are used by Tracks to get playback and put recorded data.
  57  */
  58 class LIBARDOUR_API Diskstream : public SessionObject, public PublicDiskstream
  59 {
  60   public:
  61         enum Flag {
  62                 Recordable  = 0x1,
  63                 Hidden      = 0x2,
  64                 Destructive = 0x4,
  65                 NonLayered   = 0x8
  66         };
  67
  68         Diskstream (Session &, const std::string& name, Flag f = Recordable);
  69         Diskstream (Session &, const XMLNode&);
  70         virtual ~Diskstream();
  71
  72         virtual bool set_name (const std::string& str);
  73         virtual bool set_write_source_name (const std::string& str);
  74
  75         std::string write_source_name () const {
  76                 if (_write_source_name.empty()) {
  77                         return name();
  78                 } else {
  79                         return _write_source_name;
  80                 }
  81         }
  82
  83         virtual std::string steal_write_source_name () { return std::string(); }
  84
  85         boost::shared_ptr<ARDOUR::IO> io() const { return _io; }
  86         void set_track (ARDOUR::Track *);
  87
  88         /** @return A number between 0 and 1, where 0 indicates that the playback buffer
  89          *  is dry (ie the disk subsystem could not keep up) and 1 indicates that the
  90          *  buffer is full.
  91          */
  92         virtual float playback_buffer_load() const = 0;
  93         virtual float capture_buffer_load() const = 0;
  94
  95         void set_flag (Flag f)   { _flags = Flag (_flags | f); }
  96         void unset_flag (Flag f) { _flags = Flag (_flags & ~f); }
  97
  98         AlignStyle  alignment_style() const { return _alignment_style; }
  99         AlignChoice alignment_choice() const { return _alignment_choice; }
 100         void       set_align_style (AlignStyle, bool force=false);
 101         void       set_align_choice (AlignChoice a, bool force=false);
 102
 103         framecnt_t roll_delay() const { return _roll_delay; }
 104         void       set_roll_delay (framecnt_t);
 105
 106         bool         record_enabled() const { return g_atomic_int_get (&_record_enabled); }
 107         virtual void set_record_enabled (bool yn) = 0;
 108
 109         bool destructive() const { return _flags & Destructive; }
 110         virtual int set_destructive (bool /*yn*/) { return -1; }
 111         virtual int set_non_layered (bool /*yn*/) { return -1; }
 112         virtual bool can_become_destructive (bool& /*requires_bounce*/) const { return false; }
 113
 114         bool           hidden()      const { return _flags & Hidden; }
 115         bool           recordable()  const { return _flags & Recordable; }
 116         bool           non_layered()  const { return _flags & NonLayered; }
 117         bool           reversed()    const { return _actual_speed < 0.0f; }
 118         double         speed()       const { return _visible_speed; }
 119
 120         virtual void punch_in()  {}
 121         virtual void punch_out() {}
 122
 123         void non_realtime_set_speed ();
 124         virtual void non_realtime_locate (framepos_t /*location*/) {};
 125         virtual void playlist_modified ();
 126
 127         boost::shared_ptr<Playlist> playlist () { return _playlist; }
 128
 129         virtual int use_playlist (boost::shared_ptr<Playlist>);
 130         virtual int use_new_playlist () = 0;
 131         virtual int use_copy_playlist () = 0;
 132
 133         /** @return Start position of currently-running capture (in session frames) */
 134         framepos_t current_capture_start() const { return capture_start_frame; }
 135         framepos_t current_capture_end()   const { return capture_start_frame + capture_captured; }
 136         framepos_t get_capture_start_frame (uint32_t n = 0) const;
 137         framecnt_t get_captured_frames (uint32_t n = 0) const;
 138
 139         ChanCount n_channels() { return _n_channels; }
 140
 141         static framecnt_t disk_read_frames() { return disk_read_chunk_frames; }
 142         static framecnt_t disk_write_frames() { return disk_write_chunk_frames; }
 143         static void set_disk_read_chunk_frames (framecnt_t n) { disk_read_chunk_frames = n; }
 144         static void set_disk_write_chunk_frames (framecnt_t n) { disk_write_chunk_frames = n; }
 145         static framecnt_t default_disk_read_chunk_frames ();
 146         static framecnt_t default_disk_write_chunk_frames ();
 147
 148         /* Stateful */
 149         virtual XMLNode& get_state(void);
 150         virtual int      set_state(const XMLNode&, int version);
 151
 152         virtual void request_input_monitoring (bool) {}
 153         virtual void ensure_input_monitoring (bool) {}
 154
 155         framecnt_t   capture_offset() const { return _capture_offset; }
 156         virtual void set_capture_offset ();
 157
 158         bool slaved() const      { return _slaved; }
 159         void set_slaved(bool yn) { _slaved = yn; }
 160
 161         int set_loop (Location *loc);
 162
 163         std::list<boost::shared_ptr<Source> >& last_capture_sources () { return _last_capture_sources; }
 164
 165         void handle_input_change (IOChange, void *src);
 166
 167         void move_processor_automation (boost::weak_ptr<Processor>,
 168                         std::list<Evoral::RangeMove<framepos_t> > const &);
 169
 170         /** For non-butler contexts (allocates temporary working buffers) */
 171         virtual int do_refill_with_alloc() = 0;
 172         virtual void set_block_size (pframes_t) = 0;
 173
 174         bool pending_overwrite () const {
 175                 return _pending_overwrite;
 176         }
 177
 178         PBD::Signal0<void>            RecordEnableChanged;
 179         PBD::Signal0<void>            SpeedChanged;
 180         PBD::Signal0<void>            ReverseChanged;
 181         /* Emitted when this diskstream is set to use a different playlist */
 182         PBD::Signal0<void>            PlaylistChanged;
 183         PBD::Signal0<void>            AlignmentStyleChanged;
 184         PBD::Signal1<void,Location *> LoopSet;
 185
 186         static PBD::Signal0<void>     DiskOverrun;
 187         static PBD::Signal0<void>     DiskUnderrun;
 188
 189   protected:
 190         friend class Session;
 191         friend class Butler;
 192
 193         /* the Session is the only point of access for these because they require
 194          * that the Session is "inactive" while they are called.
 195          */
 196
 197         virtual void set_pending_overwrite (bool) = 0;
 198         virtual int  overwrite_existing_buffers () = 0;
 199         virtual int  internal_playback_seek (framecnt_t distance) = 0;
 200         virtual int  can_internal_playback_seek (framecnt_t distance) = 0;
 201         virtual void reset_write_sources (bool, bool force = false) = 0;
 202         virtual void non_realtime_input_change () = 0;
 203
 204   protected:
 205         friend class Auditioner;
 206         virtual int  seek (framepos_t which_sample, bool complete_refill = false) = 0;
 207
 208   protected:
 209         friend class Track;
 210
 211     virtual int  process (BufferSet&, framepos_t transport_frame, pframes_t nframes, framecnt_t &, bool need_disk_signal) = 0;
 212     virtual frameoffset_t calculate_playback_distance (pframes_t nframes) = 0;
 213         virtual bool commit  (framecnt_t) = 0;
 214
 215         //private:
 216
 217         enum TransitionType {
 218                 CaptureStart = 0,
 219                 CaptureEnd
 220         };
 221
 222         struct CaptureTransition {
 223                 TransitionType   type;
 224                 framepos_t       capture_val; ///< The start or end file frame position
 225         };
 226
 227         /* The two central butler operations */
 228         virtual int do_flush (RunContext context, bool force = false) = 0;
 229         virtual int do_refill () = 0;
 230
 231         /* XXX fix this redundancy ... */
 232
 233         virtual void playlist_changed (const PBD::PropertyChange&);
 234         virtual void playlist_deleted (boost::weak_ptr<Playlist>);
 235         virtual void playlist_ranges_moved (std::list< Evoral::RangeMove<framepos_t> > const &, bool);
 236
 237         virtual void transport_stopped_wallclock (struct tm&, time_t, bool abort) = 0;
 238         virtual void transport_looped (framepos_t transport_frame) = 0;
 239
 240         struct CaptureInfo {
 241                 framepos_t start;
 242                 framecnt_t frames;
 243         };
 244
 245         virtual int use_new_write_source (uint32_t n=0) = 0;
 246
 247         virtual int find_and_use_playlist (const std::string&) = 0;
 248
 249         virtual void allocate_temporary_buffers () = 0;
 250
 251         virtual bool realtime_set_speed (double, bool global_change);
 252
 253         std::list<boost::shared_ptr<Source> > _last_capture_sources;
 254
 255         virtual int use_pending_capture_data (XMLNode& node) = 0;
 256
 257         virtual void check_record_status (framepos_t transport_frame, bool can_record);
 258         virtual void prepare_record_status (framepos_t /*capture_start_frame*/) {}
 259         virtual void set_align_style_from_io() {}
 260         virtual void setup_destructive_playlist () {}
 261         virtual void use_destructive_playlist () {}
 262         virtual void prepare_to_stop (framepos_t transport_pos, framepos_t audible_frame);
 263
 264         void engage_record_enable ();
 265         void disengage_record_enable ();
 266
 267         virtual bool prep_record_enable () = 0;
 268         virtual bool prep_record_disable () = 0;
 269
 270         void calculate_record_range (
 271                 Evoral::OverlapType ot, framepos_t transport_frame, framecnt_t nframes,
 272                 framecnt_t& rec_nframes, framecnt_t& rec_offset
 273                 );
 274
 275         static framecnt_t disk_read_chunk_frames;
 276         static framecnt_t disk_write_chunk_frames;
 277
 278         std::vector<CaptureInfo*> capture_info;
 279         mutable Glib::Threads::Mutex capture_info_lock;
 280
 281         uint32_t i_am_the_modifier;
 282
 283         boost::shared_ptr<ARDOUR::IO>  _io;
 284         Track*       _track;
 285         ChanCount    _n_channels;
 286
 287         boost::shared_ptr<Playlist> _playlist;
 288
 289         mutable gint _record_enabled;
 290         double       _visible_speed;
 291         double       _actual_speed;
 292         /* items needed for speed change logic */
 293         bool         _buffer_reallocation_required;
 294         bool         _seek_required;
 295
 296         /** Start of currently running capture in session frames */
 297         framepos_t    capture_start_frame;
 298         framecnt_t    capture_captured;
 299         bool          was_recording;
 300         framecnt_t    adjust_capture_position;
 301         framecnt_t   _capture_offset;
 302         /** The number of frames by which this diskstream's output should be delayed
 303             with respect to the transport frame.  This is used for latency compensation.
 304         */
 305         framecnt_t   _roll_delay;
 306         framepos_t    first_recordable_frame;
 307         framepos_t    last_recordable_frame;
 308         int           last_possibly_recording;
 309         AlignStyle   _alignment_style;
 310         AlignChoice  _alignment_choice;
 311         bool         _slaved;
 312         Location*     loop_location;
 313         framepos_t    overwrite_frame;
 314         off_t         overwrite_offset;
 315         bool          _pending_overwrite;
 316         bool          overwrite_queued;
 317         IOChange      input_change_pending;
 318         framecnt_t    wrap_buffer_size;
 319         framecnt_t    speed_buffer_size;
 320
 321         double        _speed;
 322         double        _target_speed;
 323
 324         /** The next frame position that we should be reading from in our playlist */
 325         framepos_t     file_frame;
 326         framepos_t     playback_sample;
 327
 328         bool          in_set_state;
 329
 330         std::string   _write_source_name;
 331
 332         Glib::Threads::Mutex state_lock;
 333
 334         PBD::ScopedConnectionList playlist_connections;
 335
 336         PBD::ScopedConnection ic_connection;
 337
 338         Flag _flags;
 339         XMLNode* deprecated_io_node;
 340
 341         void route_going_away ();
 342 };
 343
 344 }; /* namespace ARDOUR */
 345
 346 #endif /* __ardour_diskstream_h__ */