libs/ardour/ardour/disk_reader.h

   1 /*
   2     Copyright (C) 2009-2016 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_disk_reader_h__
  21 #define __ardour_disk_reader_h__
  22
  23 #include "pbd/i18n.h"
  24
  25 #include "ardour/disk_io.h"
  26 #include "ardour/midi_buffer.h"
  27
  28 namespace ARDOUR
  29 {
  30
  31 class Playlist;
  32 class AudioPlaylist;
  33 class MidiPlaylist;
  34 template<typename T> class MidiRingBuffer;
  35
  36 class LIBARDOUR_API DiskReader : public DiskIOProcessor
  37 {
  38   public:
  39         DiskReader (Session&, std::string const & name, DiskIOProcessor::Flag f = DiskIOProcessor::Flag (0));
  40         ~DiskReader ();
  41
  42         bool set_name (std::string const & str);
  43         std::string display_name() const { return std::string (_("player")); }
  44
  45         static samplecnt_t chunk_samples() { return _chunk_samples; }
  46         static samplecnt_t default_chunk_samples ();
  47         static void set_chunk_samples (samplecnt_t n) { _chunk_samples = n; }
  48
  49         void run (BufferSet& /*bufs*/, samplepos_t /*start_sample*/, samplepos_t /*end_sample*/, double speed, pframes_t /*nframes*/, bool /*result_required*/);
  50         void realtime_handle_transport_stopped ();
  51         void realtime_locate ();
  52         int overwrite_existing_buffers ();
  53         void set_pending_overwrite (bool yn);
  54
  55         virtual XMLNode& state (bool full);
  56         int set_state (const XMLNode&, int version);
  57
  58         PBD::Signal0<void>            AlignmentStyleChanged;
  59
  60         float buffer_load() const;
  61
  62         void move_processor_automation (boost::weak_ptr<Processor>, std::list<Evoral::RangeMove<samplepos_t> > const &);
  63
  64         /* called by the Butler in a non-realtime context */
  65
  66         int do_refill () {
  67                 return refill (_mixdown_buffer, _gain_buffer, 0);
  68         }
  69
  70         /** For non-butler contexts (allocates temporary working buffers)
  71          *
  72          * This accessible method has a default argument; derived classes
  73          * must inherit the virtual method that we call which does NOT
  74          * have a default argument, to avoid complications with inheritance
  75          */
  76         int do_refill_with_alloc (bool partial_fill = true) {
  77                 return _do_refill_with_alloc (partial_fill);
  78         }
  79
  80         bool pending_overwrite () const { return _pending_overwrite; }
  81
  82         // Working buffers for do_refill (butler thread)
  83         static void allocate_working_buffers();
  84         static void free_working_buffers();
  85
  86         void adjust_buffering ();
  87
  88         int can_internal_playback_seek (samplecnt_t distance);
  89         int internal_playback_seek (samplecnt_t distance);
  90         int seek (samplepos_t sample, bool complete_refill = false);
  91
  92         static PBD::Signal0<void> Underrun;
  93
  94         void playlist_modified ();
  95         void reset_tracker ();
  96
  97         static void set_midi_readahead_samples (samplecnt_t samples_ahead) { midi_readahead = samples_ahead; }
  98
  99         static void set_no_disk_output (bool yn);
 100         static bool no_disk_output() { return _no_disk_output; }
 101
 102   protected:
 103         friend class Track;
 104         friend class MidiTrack;
 105
 106         void resolve_tracker (Evoral::EventSink<samplepos_t>& buffer, samplepos_t time);
 107         boost::shared_ptr<MidiBuffer> get_gui_feed_buffer () const;
 108
 109         void playlist_changed (const PBD::PropertyChange&);
 110         int use_playlist (DataType, boost::shared_ptr<Playlist>);
 111         void playlist_ranges_moved (std::list< Evoral::RangeMove<samplepos_t> > const &, bool);
 112
 113   private:
 114         /** The number of samples by which this diskstream's output should be delayed
 115             with respect to the transport sample.  This is used for latency compensation.
 116         */
 117         samplepos_t   overwrite_sample;
 118         off_t         overwrite_offset;
 119         bool          _pending_overwrite;
 120         bool          overwrite_queued;
 121         IOChange      input_change_pending;
 122         samplepos_t   file_sample[DataType::num_types];
 123
 124         int _do_refill_with_alloc (bool partial_fill);
 125
 126         static samplecnt_t _chunk_samples;
 127         static samplecnt_t midi_readahead;
 128         static bool       _no_disk_output;
 129
 130         /* The MIDI stuff */
 131
 132         /** A buffer that we use to put newly-arrived MIDI data in for
 133             the GUI to read (so that it can update itself).
 134         */
 135         MidiBuffer                   _gui_feed_buffer;
 136         mutable Glib::Threads::Mutex _gui_feed_buffer_mutex;
 137
 138         int audio_read (Sample* buf, Sample* mixdown_buffer, float* gain_buffer,
 139                         samplepos_t& start, samplecnt_t cnt,
 140                         int channel, bool reversed);
 141         int midi_read (samplepos_t& start, samplecnt_t cnt, bool reversed);
 142
 143         static Sample* _mixdown_buffer;
 144         static gain_t* _gain_buffer;
 145
 146         int refill (Sample* mixdown_buffer, float* gain_buffer, samplecnt_t fill_level);
 147         int refill_audio (Sample *mixdown_buffer, float *gain_buffer, samplecnt_t fill_level);
 148         int refill_midi ();
 149
 150         sampleoffset_t calculate_playback_distance (pframes_t);
 151
 152         void get_midi_playback (MidiBuffer& dst, samplecnt_t nframes, MonitorState, BufferSet&, double speed, samplecnt_t distance);
 153 };
 154
 155 } // namespace
 156
 157 #endif /* __ardour_disk_reader_h__ */