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