libs/ardour/ardour/audiosource.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 */
  19
  20 #ifndef __ardour_audio_source_h__
  21 #define __ardour_audio_source_h__
  22
  23 #include <boost/shared_ptr.hpp>
  24 #include <boost/enable_shared_from_this.hpp>
  25
  26 #include <time.h>
  27
  28 #include <glibmm/thread.h>
  29 #include <boost/function.hpp>
  30
  31 #include "ardour/source.h"
  32 #include "ardour/ardour.h"
  33 #include "ardour/readable.h"
  34 #include "pbd/file_manager.h"
  35 #include "pbd/stateful.h"
  36 #include "pbd/xml++.h"
  37
  38 namespace ARDOUR {
  39
  40 class AudioSource : virtual public Source,
  41                 public ARDOUR::Readable,
  42                 public boost::enable_shared_from_this<ARDOUR::AudioSource>
  43 {
  44   public:
  45         AudioSource (Session&, std::string name);
  46         AudioSource (Session&, const XMLNode&);
  47         virtual ~AudioSource ();
  48
  49         framecnt_t readable_length() const { return _length; }
  50         virtual uint32_t n_channels()      const { return 1; }
  51
  52         virtual bool       empty() const;
  53         framecnt_t length (framepos_t pos) const;
  54         void       update_length (framepos_t pos, framecnt_t cnt);
  55
  56         virtual framecnt_t available_peaks (double zoom) const;
  57
  58         virtual framecnt_t read (Sample *dst, framepos_t start, framecnt_t cnt, int channel=0) const;
  59         virtual framecnt_t write (Sample *src, framecnt_t cnt);
  60
  61         virtual float sample_rate () const = 0;
  62
  63         virtual void mark_streaming_write_completed ();
  64
  65         virtual bool can_truncate_peaks() const { return true; }
  66
  67         void set_captured_for (std::string str) { _captured_for = str; }
  68         std::string captured_for() const { return _captured_for; }
  69
  70         uint32_t read_data_count() const { return _read_data_count; }
  71         uint32_t write_data_count() const { return _write_data_count; }
  72         void dec_read_data_count (framecnt_t);
  73
  74         int read_peaks (PeakData *peaks, framecnt_t npeaks,
  75                         framepos_t start, framecnt_t cnt, double samples_per_visual_peak) const;
  76
  77         int  build_peaks ();
  78         bool peaks_ready (boost::function<void()> callWhenReady, PBD::ScopedConnection** connection_created_if_not_ready, PBD::EventLoop* event_loop) const;
  79
  80         mutable PBD::Signal0<void>  PeaksReady;
  81         mutable PBD::Signal2<void,framepos_t,framepos_t>  PeakRangeReady;
  82
  83         XMLNode& get_state ();
  84         int set_state (const XMLNode&, int version);
  85
  86         int rename_peakfile (std::string newpath);
  87         void touch_peakfile ();
  88
  89         static void set_build_missing_peakfiles (bool yn) {
  90                 _build_missing_peakfiles = yn;
  91         }
  92
  93         static void set_build_peakfiles (bool yn) {
  94                 _build_peakfiles = yn;
  95         }
  96
  97         static bool get_build_peakfiles () {
  98                 return _build_peakfiles;
  99         }
 100
 101         virtual int setup_peakfile () { return 0; }
 102
 103         int prepare_for_peakfile_writes ();
 104         void done_with_peakfile_writes (bool done = true);
 105
 106         /** @return true if the each source sample s must be clamped to -1 < s < 1 */
 107         virtual bool clamped_at_unity () const = 0;
 108
 109         static void allocate_working_buffers (framecnt_t framerate);
 110
 111   protected:
 112         static bool _build_missing_peakfiles;
 113         static bool _build_peakfiles;
 114
 115         static size_t _working_buffers_size;
 116
 117         /* these collections of working buffers for supporting
 118            playlist's reading from potentially nested/recursive
 119            sources assume SINGLE THREADED reads by the butler
 120            thread, or a lock around calls that use them.
 121         */
 122
 123         static std::vector<boost::shared_ptr<Sample> > _mixdown_buffers;
 124         static std::vector<boost::shared_ptr<gain_t> > _gain_buffers;
 125         static Glib::StaticMutex    _level_buffer_lock;
 126
 127         static void ensure_buffers_for_level (uint32_t, framecnt_t);
 128         static void ensure_buffers_for_level_locked (uint32_t, framecnt_t);
 129
 130         framecnt_t           _length;
 131         std::string         peakpath;
 132         std::string        _captured_for;
 133
 134         mutable uint32_t _read_data_count;  // modified in read()
 135         mutable uint32_t _write_data_count; // modified in write()
 136
 137         int initialize_peakfile (bool newfile, std::string path);
 138         int build_peaks_from_scratch ();
 139         int compute_and_write_peaks (Sample* buf, framecnt_t first_frame, framecnt_t cnt,
 140         bool force, bool intermediate_peaks_ready_signal);
 141         void truncate_peakfile();
 142
 143         mutable off_t _peak_byte_max; // modified in compute_and_write_peak()
 144
 145         virtual framecnt_t read_unlocked (Sample *dst, framepos_t start, framecnt_t cnt) const = 0;
 146         virtual framecnt_t write_unlocked (Sample *dst, framecnt_t cnt) = 0;
 147         virtual std::string peak_path(std::string audio_path) = 0;
 148         virtual std::string find_broken_peakfile (std::string /* missing_peak_path */,
 149                                                   std::string audio_path) { return peak_path (audio_path); }
 150
 151         virtual int read_peaks_with_fpp (PeakData *peaks,
 152                                          framecnt_t npeaks, framepos_t start, framecnt_t cnt,
 153                                          double samples_per_visual_peak, framecnt_t fpp) const;
 154
 155         int compute_and_write_peaks (Sample* buf, framecnt_t first_frame, framecnt_t cnt,
 156                                      bool force, bool intermediate_peaks_ready_signal,
 157                                      framecnt_t frames_per_peak);
 158
 159   private:
 160         bool _peaks_built;
 161         /** This mutex is used to protect both the _peaks_built
 162          *  variable and also the emission (and handling) of the
 163          *  PeaksReady signal.  Holding the lock when emitting
 164          *  PeaksReady means that _peaks_built cannot be changed
 165          *  during the handling of the signal.
 166          */
 167         mutable Glib::Mutex _peaks_ready_lock;
 168
 169         PBD::FdFileDescriptor* _peakfile_descriptor;
 170         int        _peakfile_fd;
 171         framecnt_t peak_leftover_cnt;
 172         framecnt_t peak_leftover_size;
 173         Sample*    peak_leftovers;
 174         framepos_t peak_leftover_frame;
 175 };
 176
 177 }
 178
 179 #endif /* __ardour_audio_source_h__ */