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