libs/ardour/ardour/diskstream.h

   1 /*
   2     Copyright (C) 2000 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 FileSource;
  56 class IO;
  57
  58 /* FIXME: There are (obviously) far too many virtual functions in this ATM.
  59  * Just to get things off the ground, they'll be removed. */
  60
  61 class Diskstream : public Stateful, public sigc::trackable
  62 {
  63   public:
  64         enum Flag {
  65                 Recordable = 0x1,
  66                 Hidden = 0x2,
  67                 Destructive = 0x4
  68         };
  69
  70         string name () const { return _name; }
  71         virtual int set_name (string str, void* src);
  72
  73         ARDOUR::IO* io() const { return _io; }
  74         virtual void set_io (ARDOUR::IO& io) = 0;
  75
  76         virtual Diskstream& ref() { _refcnt++; return *this; }
  77         void unref() { if (_refcnt) _refcnt--; if (_refcnt == 0) delete this; }
  78         uint32_t refcnt() const { return _refcnt; }
  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 |= f; }
  84         void unset_flag (Flag f) { _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         jack_nframes_t roll_delay() const { return _roll_delay; }
  91         void set_roll_delay (jack_nframes_t);
  92
  93         bool record_enabled() const { return g_atomic_int_get (&_record_enabled); }
  94         virtual void set_record_enabled (bool yn, void *src) = 0;
  95
  96         bool destructive() const { return _flags & Destructive; }
  97         virtual void set_destructive (bool yn);
  98
  99         const PBD::ID& id()          const { return _id; }
 100         bool           hidden()      const { return _flags & Hidden; }
 101         bool           recordable()  const { return _flags & Recordable; }
 102         bool           reversed()    const { return _actual_speed < 0.0f; }
 103         double         speed()       const { return _visible_speed; }
 104
 105         virtual void punch_in()  {}
 106         virtual void punch_out() {}
 107
 108         virtual void set_speed (double);
 109         virtual void non_realtime_set_speed () = 0;
 110
 111         virtual Playlist *playlist () = 0;
 112         virtual int use_new_playlist () = 0;
 113         virtual int use_playlist (Playlist *) = 0;
 114         virtual int use_copy_playlist () = 0;
 115
 116         virtual void start_scrub (jack_nframes_t where) = 0;
 117         virtual void end_scrub () = 0;
 118
 119         jack_nframes_t current_capture_start() const { return capture_start_frame; }
 120         jack_nframes_t current_capture_end()   const { return capture_start_frame + capture_captured; }
 121         jack_nframes_t get_capture_start_frame (uint32_t n=0);
 122         jack_nframes_t get_captured_frames (uint32_t n=0);
 123
 124         uint32_t n_channels() { return _n_channels; }
 125
 126         static jack_nframes_t disk_io_frames() { return disk_io_chunk_frames; }
 127         static void set_disk_io_chunk_frames (uint32_t n) { disk_io_chunk_frames = n; }
 128
 129         /* Stateful */
 130         virtual XMLNode& get_state(void) = 0;
 131         virtual int      set_state(const XMLNode& node) = 0;
 132
 133         // FIXME: makes sense for all diskstream types?
 134         virtual void monitor_input (bool) {}
 135
 136         jack_nframes_t capture_offset() const { return _capture_offset; }
 137         virtual void   set_capture_offset ();
 138
 139         bool slaved() const      { return _slaved; }
 140         void set_slaved(bool yn) { _slaved = yn; }
 141
 142         virtual int set_loop (Location *loc);
 143         sigc::signal<void,Location *> LoopSet;
 144
 145         std::list<Region*>& last_capture_regions () { return _last_capture_regions; }
 146
 147         virtual void handle_input_change (IOChange, void *src);
 148
 149         sigc::signal<void,void*> RecordEnableChanged;
 150         sigc::signal<void>       SpeedChanged;
 151         sigc::signal<void,void*> ReverseChanged;
 152         sigc::signal<void>       PlaylistChanged;
 153         sigc::signal<void>       AlignmentStyleChanged;
 154
 155         static sigc::signal<void>                DiskOverrun;
 156         static sigc::signal<void>                DiskUnderrun;
 157         static sigc::signal<void,Diskstream*>    DiskstreamCreated; // XXX use a ref with sigc2
 158         //static sigc::signal<void,list<Source*>*> DeleteSources;
 159
 160   protected:
 161         friend class Session;
 162
 163         Diskstream (Session &, const string& name, Flag f = Recordable);
 164         Diskstream (Session &, const XMLNode&);
 165
 166         /* the Session is the only point of access for these
 167            because they require that the Session is "inactive"
 168            while they are called.
 169         */
 170
 171         virtual void set_pending_overwrite (bool) = 0;
 172         virtual int  overwrite_existing_buffers () = 0;
 173         virtual void reverse_scrub_buffer (bool to_forward) = 0;
 174         virtual void set_block_size (jack_nframes_t) = 0;
 175         virtual int  internal_playback_seek (jack_nframes_t distance) = 0;
 176         virtual int  can_internal_playback_seek (jack_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 (jack_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 (jack_nframes_t transport_frame, jack_nframes_t nframes, jack_nframes_t offset, bool can_record, bool rec_monitors_input) = 0;
 193         virtual bool commit  (jack_nframes_t nframes) = 0;
 194         virtual void recover (); /* called if commit will not be called, but process was */
 195
 196         //private:
 197
 198         /* use unref() to destroy a diskstream */
 199         virtual ~Diskstream();
 200
 201         enum TransitionType {
 202                 CaptureStart = 0,
 203                 CaptureEnd
 204         };
 205
 206         struct CaptureTransition {
 207                 TransitionType   type;
 208                 // the start or end file frame pos
 209                 jack_nframes_t   capture_val;
 210         };
 211
 212         /* the two central butler operations */
 213
 214         virtual int do_flush (char * workbuf, bool force = false) = 0;
 215         //int do_refill (Sample *mixdown_buffer, float *gain_buffer, char *workbuf);
 216
 217         virtual int non_realtime_do_refill() = 0;
 218
 219         //int read (Sample* buf, Sample* mixdown_buffer, float* gain_buffer, char * workbuf, jack_nframes_t& start, jack_nframes_t cnt,
 220         //        ChannelInfo& channel_info, int channel, bool reversed);
 221
 222         /* XXX fix this redundancy ... */
 223
 224         virtual void playlist_changed (Change);
 225         virtual void playlist_modified ();
 226         virtual void playlist_deleted (Playlist*) = 0;
 227         virtual void session_controls_changed (Session::ControlType) = 0;
 228
 229         virtual void finish_capture (bool rec_monitors_input) = 0;
 230         virtual void clean_up_capture (struct tm&, time_t, bool abort) = 0;
 231         virtual void transport_stopped (struct tm&, time_t, bool abort) = 0;
 232
 233         struct CaptureInfo {
 234             uint32_t start;
 235             uint32_t frames;
 236         };
 237
 238         virtual void init (Flag);
 239
 240         //void init_channel (ChannelInfo &chan);
 241         //void destroy_channel (ChannelInfo &chan);
 242
 243         virtual int use_new_write_source (uint32_t n=0) = 0;
 244         virtual int use_new_fade_source (uint32_t n=0) = 0;
 245
 246         virtual int find_and_use_playlist (const string&) = 0;
 247
 248         //void allocate_temporary_buffers ();
 249
 250         virtual int  create_input_port () = 0;
 251         virtual int  connect_input_port () = 0;
 252         virtual int  seek_unlocked (jack_nframes_t which_sample) = 0;
 253
 254         virtual int ports_created () = 0;
 255
 256         virtual bool realtime_set_speed (double, bool global_change);
 257         //void non_realtime_set_speed ();
 258
 259         std::list<Region*> _last_capture_regions;
 260         //std::vector<FileSource*> capturing_sources;
 261         virtual int use_pending_capture_data (XMLNode& node) = 0;
 262
 263         virtual void get_input_sources () = 0;
 264         virtual void check_record_status (jack_nframes_t transport_frame, jack_nframes_t nframes, bool can_record) = 0;
 265         //void set_align_style_from_io();
 266         virtual void setup_destructive_playlist () = 0;
 267         //void use_destructive_playlist ();
 268
 269         // Wouldn't hurt for this thing to do on a diet:
 270
 271         static jack_nframes_t disk_io_chunk_frames;
 272         vector<CaptureInfo*>  capture_info;
 273         Glib::Mutex           capture_info_lock;
 274
 275         uint32_t i_am_the_modifier;
 276
 277         string            _name;
 278         ARDOUR::Session&  _session;
 279         ARDOUR::IO*       _io;
 280         uint32_t          _n_channels;
 281         PBD::ID           _id;
 282
 283         mutable gint             _record_enabled;
 284         double                   _visible_speed;
 285         double                   _actual_speed;
 286         /* items needed for speed change logic */
 287         bool                     _buffer_reallocation_required;
 288         bool                     _seek_required;
 289
 290         bool                      force_refill;
 291         jack_nframes_t            capture_start_frame;
 292         jack_nframes_t            capture_captured;
 293         bool                      was_recording;
 294         jack_nframes_t            adjust_capture_position;
 295         jack_nframes_t           _capture_offset;
 296         jack_nframes_t           _roll_delay;
 297         jack_nframes_t            first_recordable_frame;
 298         jack_nframes_t            last_recordable_frame;
 299         int                       last_possibly_recording;
 300         AlignStyle               _alignment_style;
 301         bool                     _scrubbing;
 302         bool                     _slaved;
 303         bool                     _processed;
 304         Location*                 loop_location;
 305         jack_nframes_t            overwrite_frame;
 306         off_t                     overwrite_offset;
 307         bool                      pending_overwrite;
 308         bool                      overwrite_queued;
 309         IOChange                  input_change_pending;
 310         jack_nframes_t            wrap_buffer_size;
 311         jack_nframes_t            speed_buffer_size;
 312
 313         uint64_t                  last_phase;
 314         uint64_t                  phi;
 315
 316         jack_nframes_t            file_frame;
 317         jack_nframes_t            playback_sample;
 318         jack_nframes_t            playback_distance;
 319
 320         uint32_t                 _read_data_count;
 321         uint32_t                 _write_data_count;
 322
 323         bool                      in_set_state;
 324         AlignStyle               _persistent_alignment_style;
 325         bool                      first_input_change;
 326
 327         Glib::Mutex  state_lock;
 328
 329         jack_nframes_t scrub_start;
 330         jack_nframes_t scrub_buffer_size;
 331         jack_nframes_t scrub_offset;
 332
 333         uint32_t _refcnt;
 334
 335         sigc::connection ports_created_c;
 336         sigc::connection plmod_connection;
 337         sigc::connection plstate_connection;
 338         sigc::connection plgone_connection;
 339
 340         unsigned char _flags;
 341
 342 };
 343
 344 }; /* namespace ARDOUR */
 345
 346 #endif /* __ardour_diskstream_h__ */