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/location.h"
  37 #include "ardour/session_object.h"
  38 #include "ardour/types.h"
  39 #include "ardour/utils.h"
  40
  41 struct tm;
  42
  43 namespace ARDOUR {
  44
  45 class IO;
  46 class Playlist;
  47 class Processor;
  48 class Region;
  49 class Route;
  50 class Session;
  51
  52 class Diskstream : public SessionObject, public boost::noncopyable
  53 {
  54   public:
  55         enum Flag {
  56                 Recordable  = 0x1,
  57                 Hidden      = 0x2,
  58                 Destructive = 0x4,
  59                 NonLayered   = 0x8
  60         };
  61
  62         Diskstream (Session &, const std::string& name, Flag f = Recordable);
  63         Diskstream (Session &, const XMLNode&);
  64         virtual ~Diskstream();
  65
  66         bool set_name (const std::string& str);
  67
  68         boost::shared_ptr<ARDOUR::IO> io() const { return _io; }
  69         void set_route (ARDOUR::Route&);
  70
  71         virtual float playback_buffer_load() const = 0;
  72         virtual float capture_buffer_load() const = 0;
  73
  74         void set_flag (Flag f)   { _flags = Flag (_flags | f); }
  75         void unset_flag (Flag f) { _flags = Flag (_flags & ~f); }
  76
  77         AlignStyle alignment_style() const { return _alignment_style; }
  78         void       set_align_style (AlignStyle);
  79         void       set_persistent_align_style (AlignStyle a) { _persistent_alignment_style = a; }
  80
  81         nframes_t roll_delay() const { return _roll_delay; }
  82         void      set_roll_delay (nframes_t);
  83
  84         bool         record_enabled() const { return g_atomic_int_get (&_record_enabled); }
  85         virtual void set_record_enabled (bool yn) = 0;
  86         virtual void get_input_sources () = 0;
  87
  88         bool destructive() const { return _flags & Destructive; }
  89         virtual int set_destructive (bool /*yn*/) { return -1; }
  90         virtual int set_non_layered (bool /*yn*/) { return -1; }
  91         virtual bool can_become_destructive (bool& /*requires_bounce*/) const { return false; }
  92
  93         bool           hidden()      const { return _flags & Hidden; }
  94         bool           recordable()  const { return _flags & Recordable; }
  95         bool           non_layered()  const { return _flags & NonLayered; }
  96         bool           reversed()    const { return _actual_speed < 0.0f; }
  97         double         speed()       const { return _visible_speed; }
  98
  99         virtual void punch_in()  {}
 100         virtual void punch_out() {}
 101
 102         void set_speed (double);
 103         void non_realtime_set_speed ();
 104         virtual void non_realtime_locate (nframes_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         nframes_t current_capture_start() const { return capture_start_frame; }
 114         nframes_t current_capture_end()   const { return capture_start_frame + capture_captured; }
 115         nframes_t get_capture_start_frame (uint32_t n=0);
 116         nframes_t get_captured_frames (uint32_t n=0);
 117
 118         ChanCount n_channels() { return _n_channels; }
 119
 120         static nframes_t disk_io_frames() { return disk_io_chunk_frames; }
 121         static void set_disk_io_chunk_frames (uint32_t n) { disk_io_chunk_frames = n; }
 122
 123         /* Stateful */
 124         virtual XMLNode& get_state(void) = 0;
 125         virtual int      set_state(const XMLNode&, int version) = 0;
 126
 127         virtual void monitor_input (bool) {}
 128
 129         nframes_t    capture_offset() const { return _capture_offset; }
 130         virtual void set_capture_offset ();
 131
 132         bool slaved() const      { return _slaved; }
 133         void set_slaved(bool yn) { _slaved = yn; }
 134
 135         int set_loop (Location *loc);
 136
 137         std::list<boost::shared_ptr<Region> >& last_capture_regions () { return _last_capture_regions; }
 138
 139         void handle_input_change (IOChange, void *src);
 140
 141         void remove_region_from_last_capture (boost::weak_ptr<Region> wregion);
 142
 143         void move_processor_automation (boost::weak_ptr<Processor>,
 144                         std::list< Evoral::RangeMove<nframes_t> > const &);
 145
 146         boost::signals2::signal<void()>            RecordEnableChanged;
 147         boost::signals2::signal<void()>            SpeedChanged;
 148         boost::signals2::signal<void()>            ReverseChanged;
 149         boost::signals2::signal<void()>            PlaylistChanged;
 150         boost::signals2::signal<void()>            AlignmentStyleChanged;
 151         boost::signals2::signal<void(Location *)> LoopSet;
 152
 153         static boost::signals2::signal<void()>     DiskOverrun;
 154         static boost::signals2::signal<void()>     DiskUnderrun;
 155
 156   protected:
 157         friend class Session;
 158         friend class Butler;
 159
 160         /* the Session is the only point of access for these because they require
 161          * that the Session is "inactive" while they are called.
 162          */
 163
 164         virtual void set_pending_overwrite (bool) = 0;
 165         virtual int  overwrite_existing_buffers () = 0;
 166         virtual void set_block_size (nframes_t) = 0;
 167         virtual int  internal_playback_seek (nframes_t distance) = 0;
 168         virtual int  can_internal_playback_seek (nframes_t distance) = 0;
 169         virtual int  rename_write_sources () = 0;
 170         virtual void reset_write_sources (bool, bool force = false) = 0;
 171         virtual void non_realtime_input_change () = 0;
 172
 173         uint32_t read_data_count() const { return _read_data_count; }
 174         uint32_t write_data_count() const { return _write_data_count; }
 175
 176   protected:
 177         friend class Auditioner;
 178         virtual int  seek (nframes_t which_sample, bool complete_refill = false) = 0;
 179
 180   protected:
 181         friend class Track;
 182
 183         virtual void prepare ();
 184         virtual int  process (nframes_t transport_frame, nframes_t nframes, bool can_record, bool rec_monitors_input) = 0;
 185         virtual bool commit  (nframes_t nframes) = 0;
 186         virtual void recover (); /* called if commit will not be called, but process was */
 187
 188         //private:
 189
 190         enum TransitionType {
 191                 CaptureStart = 0,
 192                 CaptureEnd
 193         };
 194
 195         struct CaptureTransition {
 196                 TransitionType   type;
 197                 nframes_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         /** For non-butler contexts (allocates temporary working buffers) */
 205         virtual int do_refill_with_alloc() = 0;
 206
 207         /* XXX fix this redundancy ... */
 208
 209         virtual void playlist_changed (Change);
 210         virtual void playlist_deleted (boost::weak_ptr<Playlist>);
 211         virtual void playlist_ranges_moved (std::list< Evoral::RangeMove<nframes_t> > const &);
 212
 213         virtual void transport_stopped (struct tm&, time_t, bool abort) = 0;
 214         virtual void transport_looped (nframes_t transport_frame) = 0;
 215
 216         struct CaptureInfo {
 217                 uint32_t start;
 218                 uint32_t frames;
 219         };
 220
 221         virtual void init (Flag);
 222
 223         virtual int use_new_write_source (uint32_t n=0) = 0;
 224
 225         virtual int find_and_use_playlist (const std::string&) = 0;
 226
 227         virtual void allocate_temporary_buffers () = 0;
 228
 229         virtual bool realtime_set_speed (double, bool global_change);
 230
 231         std::list<boost::shared_ptr<Region> > _last_capture_regions;
 232
 233         virtual int use_pending_capture_data (XMLNode& node) = 0;
 234
 235         virtual void check_record_status (nframes_t transport_frame, nframes_t nframes, bool can_record);
 236         virtual void prepare_record_status (nframes_t /*capture_start_frame*/) {}
 237         virtual void set_align_style_from_io() {}
 238         virtual void setup_destructive_playlist () {}
 239         virtual void use_destructive_playlist () {}
 240
 241         void calculate_record_range(OverlapType ot, sframes_t transport_frame, nframes_t nframes,
 242                         nframes_t& rec_nframes, nframes_t& rec_offset);
 243
 244         static nframes_t disk_io_chunk_frames;
 245         std::vector<CaptureInfo*>  capture_info;
 246         Glib::Mutex           capture_info_lock;
 247
 248         uint32_t i_am_the_modifier;
 249
 250         boost::shared_ptr<ARDOUR::IO>  _io;
 251         Route*       _route;
 252         ChanCount    _n_channels;
 253
 254         boost::shared_ptr<Playlist> _playlist;
 255
 256         mutable gint _record_enabled;
 257         double       _visible_speed;
 258         double       _actual_speed;
 259         /* items needed for speed change logic */
 260         bool         _buffer_reallocation_required;
 261         bool         _seek_required;
 262
 263         bool          force_refill;
 264         nframes_t     capture_start_frame;
 265         nframes_t     capture_captured;
 266         bool          was_recording;
 267         nframes_t     adjust_capture_position;
 268         nframes_t    _capture_offset;
 269         nframes_t    _roll_delay;
 270         nframes_t     first_recordable_frame;
 271         nframes_t     last_recordable_frame;
 272         int           last_possibly_recording;
 273         AlignStyle   _alignment_style;
 274         bool         _scrubbing;
 275         bool         _slaved;
 276         bool         _processed;
 277         Location*     loop_location;
 278         nframes_t     overwrite_frame;
 279         off_t         overwrite_offset;
 280         bool          pending_overwrite;
 281         bool          overwrite_queued;
 282         IOChange      input_change_pending;
 283         nframes_t     wrap_buffer_size;
 284         nframes_t     speed_buffer_size;
 285
 286         double        _speed;
 287         double        _target_speed;
 288
 289         nframes_t     file_frame;
 290         nframes_t     playback_sample;
 291         nframes_t     playback_distance;
 292         bool          commit_should_unlock;
 293
 294         uint32_t     _read_data_count;
 295         uint32_t     _write_data_count;
 296
 297         bool          in_set_state;
 298         AlignStyle   _persistent_alignment_style;
 299         bool          first_input_change;
 300
 301         Glib::Mutex state_lock;
 302
 303         nframes_t scrub_start;
 304         nframes_t scrub_buffer_size;
 305         nframes_t scrub_offset;
 306
 307         PBD::ScopedConnectionList playlist_connections;
 308
 309         boost::signals2::scoped_connection ic_connection;
 310
 311         Flag _flags;
 312
 313         void route_going_away ();
 314 };
 315
 316 }; /* namespace ARDOUR */
 317
 318 #endif /* __ardour_diskstream_h__ */