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