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