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