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     $Id: diskstream.h 579 2006-06-12 19:56:37Z essej $
  19 */
  20
  21 #ifndef __ardour_diskstream_h__
  22 #define __ardour_diskstream_h__
  23
  24 #include <sigc++/signal.h>
  25
  26 #include <cmath>
  27 #include <string>
  28 #include <queue>
  29 #include <map>
  30 #include <vector>
  31
  32 #include <time.h>
  33
  34 #include <pbd/fastlog.h>
  35 #include <pbd/ringbufferNPT.h>
  36 #include <pbd/stateful.h>
  37
  38 #include <ardour/ardour.h>
  39 #include <ardour/configuration.h>
  40 #include <ardour/session.h>
  41 #include <ardour/route_group.h>
  42 #include <ardour/route.h>
  43 #include <ardour/port.h>
  44 #include <ardour/utils.h>
  45
  46
  47 struct tm;
  48
  49 namespace ARDOUR {
  50
  51 class AudioEngine;
  52 class Send;
  53 class Session;
  54 class Playlist;
  55 class IO;
  56
  57 class Diskstream : public Stateful, public sigc::trackable
  58 {
  59   public:
  60         enum Flag {
  61                 Recordable = 0x1,
  62                 Hidden = 0x2,
  63                 Destructive = 0x4
  64         };
  65
  66         string      name () const { return _name; }
  67         virtual int set_name (string str);
  68
  69         ARDOUR::IO* io() const { return _io; }
  70         void set_io (ARDOUR::IO& io);
  71
  72         virtual Diskstream& ref() { _refcnt++; return *this; }
  73         void     unref() { if (_refcnt) _refcnt--; if (_refcnt == 0) delete this; }
  74         uint32_t refcnt() const { return _refcnt; }
  75
  76         virtual float playback_buffer_load() const = 0;
  77         virtual float capture_buffer_load() const = 0;
  78
  79         void set_flag (Flag f)   { _flags |= f; }
  80         void unset_flag (Flag f) { _flags &= ~f; }
  81
  82         AlignStyle alignment_style() const { return _alignment_style; }
  83         void       set_align_style (AlignStyle);
  84         void       set_persistent_align_style (AlignStyle a) { _persistent_alignment_style = a; }
  85
  86         jack_nframes_t roll_delay() const { return _roll_delay; }
  87         void           set_roll_delay (jack_nframes_t);
  88
  89         bool         record_enabled() const { return g_atomic_int_get (&_record_enabled); }
  90         virtual void set_record_enabled (bool yn) = 0;
  91
  92         bool destructive() const { return _flags & Destructive; }
  93         virtual void set_destructive (bool yn);
  94
  95         const PBD::ID& id()          const { return _id; }
  96         bool           hidden()      const { return _flags & Hidden; }
  97         bool           recordable()  const { return _flags & Recordable; }
  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
 107         Playlist* playlist () { return _playlist; }
 108
 109         virtual int use_playlist (Playlist *);
 110         virtual int use_new_playlist () = 0;
 111         virtual int use_copy_playlist () = 0;
 112
 113         jack_nframes_t current_capture_start() const { return capture_start_frame; }
 114         jack_nframes_t current_capture_end()   const { return capture_start_frame + capture_captured; }
 115         jack_nframes_t get_capture_start_frame (uint32_t n=0);
 116         jack_nframes_t get_captured_frames (uint32_t n=0);
 117
 118         uint32_t n_channels() { return _n_channels; }
 119
 120         static jack_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& node) = 0;
 126
 127         // FIXME: makes sense for all diskstream types?
 128         virtual void monitor_input (bool) {}
 129
 130         jack_nframes_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<Region*>& last_capture_regions () { return _last_capture_regions; }
 139
 140         void handle_input_change (IOChange, void *src);
 141
 142         sigc::signal<void>            RecordEnableChanged;
 143         sigc::signal<void>            SpeedChanged;
 144         sigc::signal<void>            ReverseChanged;
 145         sigc::signal<void>            PlaylistChanged;
 146         sigc::signal<void>            AlignmentStyleChanged;
 147         sigc::signal<void,Location *> LoopSet;
 148
 149         static sigc::signal<void>                DiskOverrun;
 150         static sigc::signal<void>                DiskUnderrun;
 151         static sigc::signal<void,Diskstream*>    DiskstreamCreated; // XXX use a ref with sigc2
 152         static sigc::signal<void,list<Source*>*> DeleteSources;
 153
 154   protected:
 155         friend class Session;
 156
 157         Diskstream (Session &, const string& name, Flag f = Recordable);
 158         Diskstream (Session &, const XMLNode&);
 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 (jack_nframes_t) = 0;
 167         virtual int  internal_playback_seek (jack_nframes_t distance) = 0;
 168         virtual int  can_internal_playback_seek (jack_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 (jack_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 (jack_nframes_t transport_frame, jack_nframes_t nframes, jack_nframes_t offset, bool can_record, bool rec_monitors_input) = 0;
 185         virtual bool commit  (jack_nframes_t nframes) = 0;
 186         virtual void recover (); /* called if commit will not be called, but process was */
 187
 188         //private:
 189
 190         /** Use unref() to destroy a diskstream */
 191         virtual ~Diskstream();
 192
 193         enum TransitionType {
 194                 CaptureStart = 0,
 195                 CaptureEnd
 196         };
 197
 198         struct CaptureTransition {
 199                 TransitionType   type;
 200                 jack_nframes_t   capture_val; ///< The start or end file frame position
 201         };
 202
 203         /* The two central butler operations */
 204         virtual int do_flush (Session::RunContext context, bool force = false) = 0;
 205         virtual int do_refill () = 0;
 206
 207         /** For non-butler contexts (allocates temporary working buffers) */
 208         virtual int do_refill_with_alloc() = 0;
 209
 210
 211         /* XXX fix this redundancy ... */
 212
 213         virtual void playlist_changed (Change);
 214         virtual void playlist_modified ();
 215         virtual void playlist_deleted (Playlist*);
 216
 217         virtual void finish_capture (bool rec_monitors_input) = 0;
 218         virtual void transport_stopped (struct tm&, time_t, bool abort) = 0;
 219
 220         struct CaptureInfo {
 221             uint32_t start;
 222             uint32_t frames;
 223         };
 224
 225         virtual void init (Flag);
 226
 227         virtual int use_new_write_source (uint32_t n=0) = 0;
 228
 229         virtual int find_and_use_playlist (const string&) = 0;
 230
 231         virtual void allocate_temporary_buffers () = 0;
 232
 233         virtual bool realtime_set_speed (double, bool global_change);
 234
 235         std::list<Region*> _last_capture_regions;
 236         virtual int use_pending_capture_data (XMLNode& node) = 0;
 237
 238         virtual void get_input_sources () = 0;
 239         virtual void check_record_status (jack_nframes_t transport_frame, jack_nframes_t nframes, bool can_record) = 0;
 240         virtual void set_align_style_from_io() {}
 241         virtual void setup_destructive_playlist () = 0;
 242         virtual void use_destructive_playlist () = 0;
 243
 244         static jack_nframes_t disk_io_chunk_frames;
 245         vector<CaptureInfo*>  capture_info;
 246         Glib::Mutex           capture_info_lock;
 247
 248         uint32_t i_am_the_modifier;
 249
 250         string            _name;
 251         ARDOUR::Session&  _session;
 252         ARDOUR::IO*       _io;
 253         uint32_t          _n_channels;
 254         PBD::ID           _id;
 255         Playlist*         _playlist;
 256
 257         mutable gint             _record_enabled;
 258         double                   _visible_speed;
 259         double                   _actual_speed;
 260         /* items needed for speed change logic */
 261         bool                     _buffer_reallocation_required;
 262         bool                     _seek_required;
 263
 264         bool                      force_refill;
 265         jack_nframes_t            capture_start_frame;
 266         jack_nframes_t            capture_captured;
 267         bool                      was_recording;
 268         jack_nframes_t            adjust_capture_position;
 269         jack_nframes_t           _capture_offset;
 270         jack_nframes_t           _roll_delay;
 271         jack_nframes_t            first_recordable_frame;
 272         jack_nframes_t            last_recordable_frame;
 273         int                       last_possibly_recording;
 274         AlignStyle               _alignment_style;
 275         bool                     _scrubbing;
 276         bool                     _slaved;
 277         bool                     _processed;
 278         Location*                 loop_location;
 279         jack_nframes_t            overwrite_frame;
 280         off_t                     overwrite_offset;
 281         bool                      pending_overwrite;
 282         bool                      overwrite_queued;
 283         IOChange                  input_change_pending;
 284         jack_nframes_t            wrap_buffer_size;
 285         jack_nframes_t            speed_buffer_size;
 286
 287         uint64_t                  last_phase;
 288         uint64_t                  phi;
 289
 290         jack_nframes_t            file_frame;
 291         jack_nframes_t            playback_sample;
 292         jack_nframes_t            playback_distance;
 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         jack_nframes_t scrub_start;
 304         jack_nframes_t scrub_buffer_size;
 305         jack_nframes_t scrub_offset;
 306
 307         uint32_t _refcnt;
 308
 309         sigc::connection ports_created_c;
 310         sigc::connection plmod_connection;
 311         sigc::connection plstate_connection;
 312         sigc::connection plgone_connection;
 313
 314         unsigned char _flags;
 315 };
 316
 317 }; /* namespace ARDOUR */
 318
 319 #endif /* __ardour_diskstream_h__ */