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
  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 #include <ardour/stateful.h>
  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         Diskstream (Session &, const string& name, Flag f = Recordable);
  71         Diskstream (Session &, const XMLNode&);
  72
  73         string name () const { return _name; }
  74         virtual int set_name (string str, void* src);
  75
  76         ARDOUR::IO* io() const { return _io; }
  77         virtual void set_io (ARDOUR::IO& io) = 0;
  78
  79         virtual Diskstream& ref() { _refcnt++; return *this; }
  80         void unref() { if (_refcnt) _refcnt--; if (_refcnt == 0) delete this; }
  81         uint32_t refcnt() const { return _refcnt; }
  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         id_t   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
 110         virtual Playlist *playlist () = 0;
 111         virtual int use_new_playlist () = 0;
 112         virtual int use_playlist (Playlist *) = 0;
 113         virtual int use_copy_playlist () = 0;
 114
 115         virtual void start_scrub (jack_nframes_t where) = 0;
 116         virtual void end_scrub () = 0;
 117
 118         jack_nframes_t current_capture_start() const { return capture_start_frame; }
 119         jack_nframes_t current_capture_end()   const { return capture_start_frame + capture_captured; }
 120         jack_nframes_t get_capture_start_frame (uint32_t n=0);
 121         jack_nframes_t get_captured_frames (uint32_t n=0);
 122
 123         uint32_t n_channels() { return _n_channels; }
 124
 125         static jack_nframes_t disk_io_frames() { return disk_io_chunk_frames; }
 126         static void set_disk_io_chunk_frames (uint32_t n) { disk_io_chunk_frames = n; }
 127
 128         /* Stateful */
 129         virtual XMLNode& get_state(void) = 0;
 130         virtual int      set_state(const XMLNode& node) = 0;
 131
 132         jack_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         virtual int set_loop (Location *loc);
 139         sigc::signal<void,Location *> LoopSet;
 140
 141         std::list<Region*>& last_capture_regions () { return _last_capture_regions; }
 142
 143         virtual void handle_input_change (IOChange, void *src);
 144
 145         sigc::signal<void,void*> record_enable_changed;
 146         sigc::signal<void>       speed_changed;
 147         sigc::signal<void,void*> reverse_changed;
 148         sigc::signal<void>       PlaylistChanged;
 149         sigc::signal<void>       AlignmentStyleChanged;
 150
 151         static sigc::signal<void>                DiskOverrun;
 152         static sigc::signal<void>                DiskUnderrun;
 153         static sigc::signal<void,Diskstream*>    DiskstreamCreated; // XXX use a ref with sigc2
 154         //static sigc::signal<void,list<Source*>*> DeleteSources;
 155
 156         XMLNode* deprecated_io_node;
 157
 158   protected:
 159         friend class Session;
 160
 161         /* the Session is the only point of access for these
 162            because they require that the Session is "inactive"
 163            while they are called.
 164         */
 165
 166         virtual void set_pending_overwrite (bool) = 0;
 167         virtual int  overwrite_existing_buffers () = 0;
 168         virtual void reverse_scrub_buffer (bool to_forward) = 0;
 169         //void set_block_size (jack_nframes_t);
 170         virtual int  internal_playback_seek (jack_nframes_t distance) = 0;
 171         virtual int  can_internal_playback_seek (jack_nframes_t distance) = 0;
 172         virtual int  rename_write_sources () = 0;
 173         virtual void reset_write_sources (bool, bool force = false) = 0;
 174         virtual void non_realtime_input_change () = 0;
 175
 176         uint32_t read_data_count() const { return _read_data_count; }
 177         uint32_t write_data_count() const { return _write_data_count; }
 178
 179   protected:
 180         friend class Auditioner;
 181         virtual int  seek (jack_nframes_t which_sample, bool complete_refill = false) = 0;
 182
 183   protected:
 184         friend class Track;
 185
 186         virtual void prepare ();
 187         virtual int  process (jack_nframes_t transport_frame, jack_nframes_t nframes, jack_nframes_t offset, bool can_record, bool rec_monitors_input) = 0;
 188         virtual bool commit  (jack_nframes_t nframes) = 0;
 189         virtual void recover (); /* called if commit will not be called, but process was */
 190
 191         //private:
 192
 193         /* use unref() to destroy a diskstream */
 194         virtual ~Diskstream();
 195
 196         enum TransitionType {
 197                 CaptureStart = 0,
 198                 CaptureEnd
 199         };
 200
 201         struct CaptureTransition {
 202                 TransitionType   type;
 203                 // the start or end file frame pos
 204                 jack_nframes_t   capture_val;
 205         };
 206
 207         /* the two central butler operations */
 208
 209         virtual int do_flush (char * workbuf, bool force = false) = 0;
 210         //int do_refill (Sample *mixdown_buffer, float *gain_buffer, char *workbuf);
 211
 212         virtual int non_realtime_do_refill() = 0;
 213
 214         //int read (Sample* buf, Sample* mixdown_buffer, float* gain_buffer, char * workbuf, jack_nframes_t& start, jack_nframes_t cnt,
 215         //        ChannelInfo& channel_info, int channel, bool reversed);
 216
 217         /* XXX fix this redundancy ... */
 218
 219         virtual void playlist_changed (Change);
 220         virtual void playlist_modified ();
 221         virtual void playlist_deleted (Playlist*) = 0;
 222         virtual void session_controls_changed (Session::ControlType) = 0;
 223
 224         virtual void finish_capture (bool rec_monitors_input) = 0;
 225         virtual void clean_up_capture (struct tm&, time_t, bool abort) = 0;
 226         virtual void transport_stopped (struct tm&, time_t, bool abort) = 0;
 227
 228         struct CaptureInfo {
 229             uint32_t start;
 230             uint32_t frames;
 231         };
 232
 233         virtual void init (Flag);
 234
 235         //void init_channel (ChannelInfo &chan);
 236         //void destroy_channel (ChannelInfo &chan);
 237
 238         virtual int use_new_write_source (uint32_t n=0) = 0;
 239         virtual int use_new_fade_source (uint32_t n=0) = 0;
 240
 241         virtual int find_and_use_playlist (const string&) = 0;
 242
 243         //void allocate_temporary_buffers ();
 244
 245         virtual int  create_input_port () = 0;
 246         virtual int  connect_input_port () = 0;
 247         virtual int  seek_unlocked (jack_nframes_t which_sample) = 0;
 248
 249         virtual int ports_created () = 0;
 250
 251         virtual bool realtime_set_speed (double, bool global_change);
 252         //void non_realtime_set_speed ();
 253
 254         std::list<Region*> _last_capture_regions;
 255         //std::vector<FileSource*> capturing_sources;
 256         virtual int use_pending_capture_data (XMLNode& node) = 0;
 257
 258         virtual void get_input_sources () = 0;
 259         virtual void check_record_status (jack_nframes_t transport_frame, jack_nframes_t nframes, bool can_record) = 0;
 260         //void set_align_style_from_io();
 261         virtual void setup_destructive_playlist () = 0;
 262         //void use_destructive_playlist ();
 263
 264         // Wouldn't hurt for this thing to do on a diet:
 265
 266         static jack_nframes_t disk_io_chunk_frames;
 267         vector<CaptureInfo*>  capture_info;
 268         Glib::Mutex           capture_info_lock;
 269
 270         uint32_t i_am_the_modifier;
 271
 272         string            _name;
 273         ARDOUR::Session&  _session;
 274         ARDOUR::IO*       _io;
 275         uint32_t          _n_channels;
 276         id_t              _id;
 277
 278         mutable gint             _record_enabled;
 279         double                   _visible_speed;
 280         double                   _actual_speed;
 281         /* items needed for speed change logic */
 282         bool                     _buffer_reallocation_required;
 283         bool                     _seek_required;
 284
 285         bool                      force_refill;
 286         jack_nframes_t            capture_start_frame;
 287         jack_nframes_t            capture_captured;
 288         bool                      was_recording;
 289         jack_nframes_t            adjust_capture_position;
 290         jack_nframes_t           _capture_offset;
 291         jack_nframes_t           _roll_delay;
 292         jack_nframes_t            first_recordable_frame;
 293         jack_nframes_t            last_recordable_frame;
 294         int                       last_possibly_recording;
 295         AlignStyle               _alignment_style;
 296         bool                     _scrubbing;
 297         bool                     _slaved;
 298         bool                     _processed;
 299         Location*                 loop_location;
 300         jack_nframes_t            overwrite_frame;
 301         off_t                     overwrite_offset;
 302         bool                      pending_overwrite;
 303         bool                      overwrite_queued;
 304         IOChange                  input_change_pending;
 305         jack_nframes_t            wrap_buffer_size;
 306         jack_nframes_t            speed_buffer_size;
 307
 308         uint64_t                  last_phase;
 309         uint64_t                  phi;
 310
 311         jack_nframes_t            file_frame;
 312         jack_nframes_t            playback_sample;
 313         jack_nframes_t            playback_distance;
 314
 315         uint32_t                 _read_data_count;
 316         uint32_t                 _write_data_count;
 317
 318         bool                      in_set_state;
 319         AlignStyle               _persistent_alignment_style;
 320         bool                      first_input_change;
 321
 322         Glib::Mutex  state_lock;
 323
 324         jack_nframes_t scrub_start;
 325         jack_nframes_t scrub_buffer_size;
 326         jack_nframes_t scrub_offset;
 327
 328         uint32_t _refcnt;
 329
 330         sigc::connection ports_created_c;
 331         sigc::connection plmod_connection;
 332         sigc::connection plstate_connection;
 333         sigc::connection plgone_connection;
 334
 335         unsigned char _flags;
 336
 337 };
 338
 339 }; /* namespace ARDOUR */
 340
 341 #endif /* __ardour_diskstream_h__ */