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/Range.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 (const_cast<gint*>(&_record_enabled)); }
 107         bool         record_safe () const { return g_atomic_int_get (const_cast<gint*>(&_record_safe)); }
 108         virtual void set_record_enabled (bool yn) = 0;
 109         virtual void set_record_safe (bool yn) = 0;
 110
 111         bool destructive() const { return _flags & Destructive; }
 112 #ifdef XXX_OLD_DESTRUCTIVE_API_XXX
 113         virtual int set_destructive (bool /*yn*/) { return -1; }
 114         virtual int set_non_layered (bool /*yn*/) { return -1; }
 115         virtual bool can_become_destructive (bool& /*requires_bounce*/) const { return false; }
 116 #endif
 117
 118         bool           hidden()      const { return _flags & Hidden; }
 119         bool           recordable()  const { return _flags & Recordable; }
 120         bool           non_layered() const;  // { return _flags & NonLayered; }
 121         bool           reversed()    const { return _actual_speed < 0.0f; }
 122         double         speed()       const { return _visible_speed; }
 123
 124         virtual void punch_in()  {}
 125         virtual void punch_out() {}
 126
 127         void non_realtime_set_speed ();
 128         virtual void non_realtime_locate (framepos_t /*location*/) {};
 129         virtual void playlist_modified ();
 130
 131         boost::shared_ptr<Playlist> playlist () { return _playlist; }
 132
 133         virtual int use_playlist (boost::shared_ptr<Playlist>);
 134         virtual int use_new_playlist () = 0;
 135         virtual int use_copy_playlist () = 0;
 136
 137         /** @return Start position of currently-running capture (in session frames) */
 138         framepos_t current_capture_start() const { return capture_start_frame; }
 139         framepos_t current_capture_end()   const { return capture_start_frame + capture_captured; }
 140         framepos_t get_capture_start_frame (uint32_t n = 0) const;
 141         framecnt_t get_captured_frames (uint32_t n = 0) const;
 142
 143         ChanCount n_channels() { return _n_channels; }
 144
 145         static framecnt_t disk_read_frames() { return disk_read_chunk_frames; }
 146         static framecnt_t disk_write_frames() { return disk_write_chunk_frames; }
 147         static void set_disk_read_chunk_frames (framecnt_t n) { disk_read_chunk_frames = n; }
 148         static void set_disk_write_chunk_frames (framecnt_t n) { disk_write_chunk_frames = n; }
 149         static framecnt_t default_disk_read_chunk_frames ();
 150         static framecnt_t default_disk_write_chunk_frames ();
 151
 152         static void set_buffering_parameters (BufferingPreset bp);
 153
 154         /* Stateful */
 155         virtual XMLNode& get_state(void);
 156         virtual int      set_state(const XMLNode&, int version);
 157
 158         virtual void request_input_monitoring (bool) {}
 159         virtual void ensure_input_monitoring (bool) {}
 160
 161         framecnt_t   capture_offset() const { return _capture_offset; }
 162         virtual void set_capture_offset ();
 163
 164         bool slaved() const      { return _slaved; }
 165         void set_slaved(bool yn) { _slaved = yn; }
 166
 167         int set_loop (Location *loc);
 168
 169         std::list<boost::shared_ptr<Source> >& last_capture_sources () { return _last_capture_sources; }
 170
 171         void handle_input_change (IOChange, void *src);
 172
 173         void move_processor_automation (boost::weak_ptr<Processor>,
 174                         std::list<Evoral::RangeMove<framepos_t> > const &);
 175
 176         /** For non-butler contexts (allocates temporary working buffers)
 177          *
 178          * This accessible method has a default argument; derived classes
 179          * must inherit the virtual method that we call which does NOT
 180          * have a default argument, to avoid complications with inheritance
 181          */
 182         int do_refill_with_alloc(bool partial_fill = true) {
 183                 return _do_refill_with_alloc (partial_fill);
 184         }
 185         virtual void set_block_size (pframes_t) = 0;
 186
 187         bool pending_overwrite () const {
 188                 return _pending_overwrite;
 189         }
 190
 191         PBD::Signal0<void>            RecordEnableChanged;
 192         PBD::Signal0<void>            RecordSafeChanged;
 193         PBD::Signal0<void>            SpeedChanged;
 194         PBD::Signal0<void>            ReverseChanged;
 195         /* Emitted when this diskstream is set to use a different playlist */
 196         PBD::Signal0<void>            PlaylistChanged;
 197         PBD::Signal0<void>            AlignmentStyleChanged;
 198         PBD::Signal1<void,Location *> LoopSet;
 199
 200         static PBD::Signal0<void>     DiskOverrun;
 201         static PBD::Signal0<void>     DiskUnderrun;
 202
 203   protected:
 204         friend class Session;
 205         friend class Butler;
 206
 207         /* the Session is the only point of access for these because they require
 208          * that the Session is "inactive" while they are called.
 209          */
 210
 211         virtual void set_pending_overwrite (bool) = 0;
 212         virtual int  overwrite_existing_buffers () = 0;
 213         virtual int  internal_playback_seek (framecnt_t distance) = 0;
 214         virtual int  can_internal_playback_seek (framecnt_t distance) = 0;
 215         virtual void reset_write_sources (bool, bool force = false) = 0;
 216         virtual void non_realtime_input_change () = 0;
 217         /* accessible method has default argument, so use standard C++ "trick"
 218            to avoid complications with inheritance, by adding this virtual
 219            method which does NOT have a default argument.
 220         */
 221         virtual int _do_refill_with_alloc (bool partial_fill) = 0;
 222
 223   protected:
 224         friend class Auditioner;
 225         virtual int  seek (framepos_t which_sample, bool complete_refill = false) = 0;
 226
 227   protected:
 228         friend class Track;
 229
 230     virtual int  process (BufferSet&, framepos_t transport_frame, pframes_t nframes, framecnt_t &, bool need_disk_signal) = 0;
 231     virtual frameoffset_t calculate_playback_distance (pframes_t nframes) = 0;
 232         virtual bool commit  (framecnt_t) = 0;
 233
 234         //private:
 235
 236         enum TransitionType {
 237                 CaptureStart = 0,
 238                 CaptureEnd
 239         };
 240
 241         struct CaptureTransition {
 242                 TransitionType   type;
 243                 framepos_t       capture_val; ///< The start or end file frame position
 244         };
 245
 246         /* The two central butler operations */
 247         virtual int do_flush (RunContext context, bool force = false) = 0;
 248         virtual int do_refill () = 0;
 249
 250         /* XXX fix this redundancy ... */
 251
 252         virtual void playlist_changed (const PBD::PropertyChange&);
 253         virtual void playlist_deleted (boost::weak_ptr<Playlist>);
 254         virtual void playlist_ranges_moved (std::list< Evoral::RangeMove<framepos_t> > const &, bool);
 255
 256         virtual void transport_stopped_wallclock (struct tm&, time_t, bool abort) = 0;
 257         virtual void transport_looped (framepos_t transport_frame) = 0;
 258
 259         struct CaptureInfo {
 260                 framepos_t start;
 261                 framecnt_t frames;
 262         };
 263
 264         virtual int use_new_write_source (uint32_t n=0) = 0;
 265
 266         virtual int find_and_use_playlist (const std::string&) = 0;
 267
 268         virtual void allocate_temporary_buffers () = 0;
 269
 270         virtual bool realtime_set_speed (double, bool global_change);
 271
 272         std::list<boost::shared_ptr<Source> > _last_capture_sources;
 273
 274         virtual int use_pending_capture_data (XMLNode& node) = 0;
 275
 276         virtual void check_record_status (framepos_t transport_frame, bool can_record);
 277         virtual void prepare_record_status (framepos_t /*capture_start_frame*/) {}
 278         virtual void set_align_style_from_io() {}
 279         virtual void setup_destructive_playlist () {}
 280         virtual void use_destructive_playlist () {}
 281         virtual void prepare_to_stop (framepos_t transport_pos, framepos_t audible_frame);
 282
 283         void engage_record_enable ();
 284         void disengage_record_enable ();
 285         void engage_record_safe ();
 286         void disengage_record_safe ();
 287
 288         virtual bool prep_record_enable () = 0;
 289         virtual bool prep_record_disable () = 0;
 290
 291         void calculate_record_range (
 292                 Evoral::OverlapType ot, framepos_t transport_frame, framecnt_t nframes,
 293                 framecnt_t& rec_nframes, framecnt_t& rec_offset
 294                 );
 295
 296         static framecnt_t disk_read_chunk_frames;
 297         static framecnt_t disk_write_chunk_frames;
 298
 299         std::vector<CaptureInfo*> capture_info;
 300         mutable Glib::Threads::Mutex capture_info_lock;
 301
 302         uint32_t i_am_the_modifier;
 303
 304         boost::shared_ptr<ARDOUR::IO>  _io;
 305         Track*       _track;
 306         ChanCount    _n_channels;
 307
 308         boost::shared_ptr<Playlist> _playlist;
 309
 310         gint         _record_enabled;
 311         gint         _record_safe;
 312         double       _visible_speed;
 313         double       _actual_speed;
 314         /* items needed for speed change logic */
 315         bool         _buffer_reallocation_required;
 316         bool         _seek_required;
 317
 318         /** Start of currently running capture in session frames */
 319         framepos_t    capture_start_frame;
 320         framecnt_t    capture_captured;
 321         bool          was_recording;
 322         framecnt_t    adjust_capture_position;
 323         framecnt_t   _capture_offset;
 324         /** The number of frames by which this diskstream's output should be delayed
 325             with respect to the transport frame.  This is used for latency compensation.
 326         */
 327         framecnt_t   _roll_delay;
 328         framepos_t    first_recordable_frame;
 329         framepos_t    last_recordable_frame;
 330         int           last_possibly_recording;
 331         AlignStyle   _alignment_style;
 332         AlignChoice  _alignment_choice;
 333         bool         _slaved;
 334         Location*     loop_location;
 335         framepos_t    overwrite_frame;
 336         off_t         overwrite_offset;
 337         bool          _pending_overwrite;
 338         bool          overwrite_queued;
 339         IOChange      input_change_pending;
 340         framecnt_t    wrap_buffer_size;
 341         framecnt_t    speed_buffer_size;
 342
 343         double        _speed;
 344         double        _target_speed;
 345
 346         /** The next frame position that we should be reading from in our playlist */
 347         framepos_t     file_frame;
 348         framepos_t     playback_sample;
 349
 350         bool          in_set_state;
 351
 352         std::string   _write_source_name;
 353
 354         Glib::Threads::Mutex state_lock;
 355
 356         PBD::ScopedConnectionList playlist_connections;
 357
 358         PBD::ScopedConnection ic_connection;
 359
 360         Flag _flags;
 361         XMLNode* deprecated_io_node;
 362
 363         void route_going_away ();
 364
 365         static bool get_buffering_presets (BufferingPreset bp,
 366                                            framecnt_t& read_chunk_size,
 367                                            framecnt_t& read_buffer_size,
 368                                            framecnt_t& write_chunk_size,
 369                                            framecnt_t& write_buffer_size);
 370 };
 371
 372 }; /* namespace ARDOUR */
 373
 374 #endif /* __ardour_diskstream_h__ */