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