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 <glibmm/ustring.h>
  30 #include <boost/function.hpp>
  31
  32 #include "ardour/source.h"
  33 #include "ardour/ardour.h"
  34 #include "pbd/stateful.h"
  35 #include "pbd/xml++.h"
  36
  37 namespace ARDOUR {
  38
  39 class AudioSource : virtual public Source,
  40                 public ARDOUR::Readable,
  41                 public boost::enable_shared_from_this<ARDOUR::AudioSource>
  42 {
  43   public:
  44         AudioSource (Session&, Glib::ustring name);
  45         AudioSource (Session&, const XMLNode&);
  46         virtual ~AudioSource ();
  47
  48         framecnt_t readable_length() const { return _length; }
  49         uint32_t   n_channels()      const { return 1; }
  50
  51         framecnt_t length (framepos_t pos) const;
  52         void      update_length (framepos_t pos, framecnt_t cnt);
  53
  54         virtual framecnt_t available_peaks (double zoom) const;
  55
  56         virtual framecnt_t read (Sample *dst, framepos_t start, framecnt_t cnt, int channel=0) const;
  57         virtual framecnt_t write (Sample *src, framecnt_t cnt);
  58
  59         virtual float sample_rate () const = 0;
  60
  61         virtual void mark_streaming_write_completed () {}
  62
  63         virtual bool can_truncate_peaks() const { return true; }
  64
  65         void set_captured_for (Glib::ustring str) { _captured_for = str; }
  66         Glib::ustring captured_for() const { return _captured_for; }
  67
  68         uint32_t read_data_count() const { return _read_data_count; }
  69         uint32_t write_data_count() const { return _write_data_count; }
  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 (Glib::ustring 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
 100         int prepare_for_peakfile_writes ();
 101         void done_with_peakfile_writes (bool done = true);
 102
 103         /** @return true if the each source sample s must be clamped to -1 < s < 1 */
 104         virtual bool clamped_at_unity () const = 0;
 105
 106   protected:
 107         static bool _build_missing_peakfiles;
 108         static bool _build_peakfiles;
 109
 110         framecnt_t           _length;
 111         bool                 _peaks_built;
 112         mutable Glib::Mutex  _peaks_ready_lock;
 113         Glib::ustring         peakpath;
 114         Glib::ustring        _captured_for;
 115
 116         mutable uint32_t _read_data_count;  // modified in read()
 117         mutable uint32_t _write_data_count; // modified in write()
 118
 119         int initialize_peakfile (bool newfile, Glib::ustring path);
 120         int build_peaks_from_scratch ();
 121         int compute_and_write_peaks (Sample* buf, framepos_t first_frame, framecnt_t cnt,
 122         bool force, bool intermediate_peaks_ready_signal);
 123         void truncate_peakfile();
 124
 125         mutable off_t _peak_byte_max; // modified in compute_and_write_peak()
 126
 127         virtual framecnt_t read_unlocked (Sample *dst, framepos_t start, framecnt_t cnt) const = 0;
 128         virtual framecnt_t write_unlocked (Sample *dst, framecnt_t cnt) = 0;
 129         virtual Glib::ustring peak_path(Glib::ustring audio_path) = 0;
 130         virtual Glib::ustring find_broken_peakfile (Glib::ustring missing_peak_path,
 131                                                     Glib::ustring audio_path) = 0;
 132
 133         virtual int read_peaks_with_fpp (PeakData *peaks,
 134                                          framecnt_t npeaks, framepos_t start, framecnt_t cnt,
 135                                          double samples_per_visual_peak, framecnt_t fpp) const;
 136
 137         int compute_and_write_peaks (Sample* buf, framepos_t first_frame, framecnt_t cnt,
 138                                      bool force, bool intermediate_peaks_ready_signal,
 139                                      framecnt_t frames_per_peak);
 140
 141   private:
 142         int        peakfile;
 143         framecnt_t peak_leftover_cnt;
 144         framecnt_t peak_leftover_size;
 145         Sample*    peak_leftovers;
 146         framepos_t peak_leftover_frame;
 147 };
 148
 149 }
 150
 151 #endif /* __ardour_audio_source_h__ */