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 <boost/utility.hpp>
  33
  34 #include "evoral/types.hpp"
  35
  36 #include "ardour/ardour.h"
  37 #include "ardour/chan_count.h"
  38 #include "ardour/location.h"
  39 #include "ardour/session_object.h"
  40 #include "ardour/types.h"
  41 #include "ardour/utils.h"
  42
  43 struct tm;
  44
  45 namespace ARDOUR {
  46
  47 class IO;
  48 class Playlist;
  49 class Processor;
  50 class Region;
  51 class Route;
  52 class Session;
  53
  54 class Diskstream : public SessionObject, public boost::noncopyable
  55 {
  56   public:
  57         enum Flag {
  58                 Recordable  = 0x1,
  59                 Hidden      = 0x2,
  60                 Destructive = 0x4,
  61                 NonLayered   = 0x8
  62         };
  63
  64         Diskstream (Session &, const std::string& name, Flag f = Recordable);
  65         Diskstream (Session &, const XMLNode&);
  66         virtual ~Diskstream();
  67
  68         bool set_name (const std::string& str);
  69
  70         boost::shared_ptr<ARDOUR::IO> io() const { return _io; }
  71         void set_route (ARDOUR::Route&);
  72
  73         virtual float playback_buffer_load() const = 0;
  74         virtual float capture_buffer_load() const = 0;
  75
  76         void set_flag (Flag f)   { _flags = Flag (_flags | f); }
  77         void unset_flag (Flag f) { _flags = Flag (_flags & ~f); }
  78
  79         AlignStyle alignment_style() const { return _alignment_style; }
  80         void       set_align_style (AlignStyle);
  81         void       set_persistent_align_style (AlignStyle a) { _persistent_alignment_style = a; }
  82
  83         nframes_t roll_delay() const { return _roll_delay; }
  84         void      set_roll_delay (nframes_t);
  85
  86         bool         record_enabled() const { return g_atomic_int_get (&_record_enabled); }
  87         virtual void set_record_enabled (bool yn) = 0;
  88         virtual void get_input_sources () = 0;
  89
  90         bool destructive() const { return _flags & Destructive; }
  91         virtual int set_destructive (bool /*yn*/) { return -1; }
  92         virtual int set_non_layered (bool /*yn*/) { return -1; }
  93         virtual bool can_become_destructive (bool& /*requires_bounce*/) const { return false; }
  94
  95         bool           hidden()      const { return _flags & Hidden; }
  96         bool           recordable()  const { return _flags & Recordable; }
  97         bool           non_layered()  const { return _flags & NonLayered; }
  98         bool           reversed()    const { return _actual_speed < 0.0f; }
  99         double         speed()       const { return _visible_speed; }
 100
 101         virtual void punch_in()  {}
 102         virtual void punch_out() {}
 103
 104         void set_speed (double);
 105         void non_realtime_set_speed ();
 106         virtual void non_realtime_locate (nframes_t /*location*/) {};
 107         virtual void playlist_modified ();
 108
 109         boost::shared_ptr<Playlist> playlist () { return _playlist; }
 110
 111         virtual int use_playlist (boost::shared_ptr<Playlist>);
 112         virtual int use_new_playlist () = 0;
 113         virtual int use_copy_playlist () = 0;
 114
 115         nframes_t current_capture_start() const { return capture_start_frame; }
 116         nframes_t current_capture_end()   const { return capture_start_frame + capture_captured; }
 117         nframes_t get_capture_start_frame (uint32_t n=0);
 118         nframes_t get_captured_frames (uint32_t n=0);
 119
 120         ChanCount n_channels() { return _n_channels; }
 121
 122         static nframes_t disk_io_frames() { return disk_io_chunk_frames; }
 123         static void set_disk_io_chunk_frames (uint32_t n) { disk_io_chunk_frames = n; }
 124
 125         /* Stateful */
 126         virtual XMLNode& get_state(void) = 0;
 127         virtual int      set_state(const XMLNode&, int version) = 0;
 128
 129         virtual void monitor_input (bool) {}
 130
 131         nframes_t    capture_offset() const { return _capture_offset; }
 132         virtual void set_capture_offset ();
 133
 134         bool slaved() const      { return _slaved; }
 135         void set_slaved(bool yn) { _slaved = yn; }
 136
 137         int set_loop (Location *loc);
 138
 139         std::list<boost::shared_ptr<Region> >& last_capture_regions () { return _last_capture_regions; }
 140
 141         void handle_input_change (IOChange, void *src);
 142
 143         void remove_region_from_last_capture (boost::weak_ptr<Region> wregion);
 144
 145         void move_processor_automation (boost::weak_ptr<Processor>,
 146                         std::list< Evoral::RangeMove<nframes_t> > const &);
 147
 148         sigc::signal<void>            RecordEnableChanged;
 149         sigc::signal<void>            SpeedChanged;
 150         sigc::signal<void>            ReverseChanged;
 151         sigc::signal<void>            PlaylistChanged;
 152         sigc::signal<void>            AlignmentStyleChanged;
 153         sigc::signal<void,Location *> LoopSet;
 154
 155         static sigc::signal<void>     DiskOverrun;
 156         static sigc::signal<void>     DiskUnderrun;
 157
 158   protected:
 159         friend class Session;
 160         friend class Butler;
 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, 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 (std::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 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<Region> > _last_capture_regions;
 234
 235         virtual int use_pending_capture_data (XMLNode& node) = 0;
 236
 237         virtual void check_record_status (nframes_t transport_frame, nframes_t nframes, bool can_record);
 238         virtual void prepare_record_status (nframes_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
 243         void calculate_record_range(OverlapType ot, sframes_t transport_frame, nframes_t nframes,
 244                         nframes_t& rec_nframes, nframes_t& rec_offset);
 245
 246         static nframes_t disk_io_chunk_frames;
 247         std::vector<CaptureInfo*>  capture_info;
 248         Glib::Mutex           capture_info_lock;
 249
 250         uint32_t i_am_the_modifier;
 251
 252         boost::shared_ptr<ARDOUR::IO>  _io;
 253         Route*       _route;
 254         ChanCount    _n_channels;
 255
 256         boost::shared_ptr<Playlist> _playlist;
 257
 258         mutable gint _record_enabled;
 259         double       _visible_speed;
 260         double       _actual_speed;
 261         /* items needed for speed change logic */
 262         bool         _buffer_reallocation_required;
 263         bool         _seek_required;
 264
 265         bool          force_refill;
 266         nframes_t     capture_start_frame;
 267         nframes_t     capture_captured;
 268         bool          was_recording;
 269         nframes_t     adjust_capture_position;
 270         nframes_t    _capture_offset;
 271         nframes_t    _roll_delay;
 272         nframes_t     first_recordable_frame;
 273         nframes_t     last_recordable_frame;
 274         int           last_possibly_recording;
 275         AlignStyle   _alignment_style;
 276         bool         _scrubbing;
 277         bool         _slaved;
 278         bool         _processed;
 279         Location*     loop_location;
 280         nframes_t     overwrite_frame;
 281         off_t         overwrite_offset;
 282         bool          pending_overwrite;
 283         bool          overwrite_queued;
 284         IOChange      input_change_pending;
 285         nframes_t     wrap_buffer_size;
 286         nframes_t     speed_buffer_size;
 287
 288         double        _speed;
 289         double        _target_speed;
 290
 291         nframes_t     file_frame;
 292         nframes_t     playback_sample;
 293         nframes_t     playback_distance;
 294         bool          commit_should_unlock;
 295
 296         uint32_t     _read_data_count;
 297         uint32_t     _write_data_count;
 298
 299         bool          in_set_state;
 300         AlignStyle   _persistent_alignment_style;
 301         bool          first_input_change;
 302
 303         Glib::Mutex state_lock;
 304
 305         nframes_t scrub_start;
 306         nframes_t scrub_buffer_size;
 307         nframes_t scrub_offset;
 308
 309         sigc::connection ports_created_c;
 310         sigc::connection plmod_connection;
 311         sigc::connection plgone_connection;
 312         sigc::connection plregion_connection;
 313         sigc::connection ic_connection;
 314
 315         Flag _flags;
 316
 317         void route_going_away ();
 318 };
 319
 320 }; /* namespace ARDOUR */
 321
 322 #endif /* __ardour_diskstream_h__ */