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 <list>
  24 #include <vector>
  25
  26 #include <boost/shared_ptr.hpp>
  27 #include <boost/enable_shared_from_this.hpp>
  28
  29 #include <time.h>
  30
  31 #include <glibmm/thread.h>
  32 #include <glibmm/ustring.h>
  33
  34 #include <sigc++/signal.h>
  35
  36 #include <ardour/source.h>
  37 #include <ardour/ardour.h>
  38 #include <pbd/stateful.h>
  39 #include <pbd/xml++.h>
  40
  41 using std::list;
  42 using std::vector;
  43
  44 namespace ARDOUR {
  45
  46 const nframes_t frames_per_peak = 256;
  47
  48  class AudioSource : public Source, public boost::enable_shared_from_this<ARDOUR::AudioSource>
  49 {
  50   public:
  51         AudioSource (Session&, Glib::ustring name);
  52         AudioSource (Session&, const XMLNode&);
  53         virtual ~AudioSource ();
  54
  55         /* one could argue that this should belong to Source, but other data types
  56            generally do not come with a model of "offset along an audio timeline"
  57            so its here in AudioSource for now.
  58         */
  59
  60         virtual nframes_t natural_position() const { return 0; }
  61
  62         /* returns the number of items in this `audio_source' */
  63
  64         virtual nframes_t length() const {
  65                 return _length;
  66         }
  67
  68         virtual nframes_t available_peaks (double zoom) const;
  69
  70         virtual nframes_t read (Sample *dst, nframes_t start, nframes_t cnt) const;
  71         virtual nframes_t write (Sample *src, nframes_t cnt);
  72
  73         virtual float sample_rate () const = 0;
  74
  75         virtual void mark_for_remove() = 0;
  76         virtual void mark_streaming_write_completed () {}
  77
  78         virtual bool can_truncate_peaks() const { return true; }
  79
  80         void set_captured_for (Glib::ustring str) { _captured_for = str; }
  81         Glib::ustring captured_for() const { return _captured_for; }
  82
  83         uint32_t read_data_count() const { return _read_data_count; }
  84         uint32_t write_data_count() const { return _write_data_count; }
  85
  86         virtual int read_peaks (PeakData *peaks, nframes_t npeaks, nframes_t start, nframes_t cnt, double samples_per_unit) const;
  87         int  build_peaks ();
  88         bool peaks_ready (sigc::slot<void>, sigc::connection&) const;
  89
  90         mutable sigc::signal<void>  PeaksReady;
  91         mutable sigc::signal<void,nframes_t,nframes_t>  PeakRangeReady;
  92
  93         XMLNode& get_state ();
  94         int set_state (const XMLNode&);
  95
  96         int rename_peakfile (Glib::ustring newpath);
  97         void touch_peakfile ();
  98
  99         static void set_build_missing_peakfiles (bool yn) {
 100                 _build_missing_peakfiles = yn;
 101         }
 102
 103         static void set_build_peakfiles (bool yn) {
 104                 _build_peakfiles = yn;
 105         }
 106
 107         static bool get_build_peakfiles () {
 108                 return _build_peakfiles;
 109         }
 110
 111         virtual int setup_peakfile () { return 0; }
 112
 113         int prepare_for_peakfile_writes ();
 114         void done_with_peakfile_writes (bool done = true);
 115
 116   protected:
 117         static bool _build_missing_peakfiles;
 118         static bool _build_peakfiles;
 119
 120         bool                 _peaks_built;
 121         mutable Glib::Mutex  _lock;
 122         mutable Glib::Mutex  _peaks_ready_lock;
 123         nframes_t            _length;
 124         Glib::ustring               peakpath;
 125         Glib::ustring              _captured_for;
 126
 127         mutable uint32_t _read_data_count;  // modified in read()
 128         mutable uint32_t _write_data_count; // modified in write()
 129
 130         int initialize_peakfile (bool newfile, Glib::ustring path);
 131         int build_peaks_from_scratch ();
 132         int compute_and_write_peaks (Sample* buf, nframes_t first_frame, nframes_t cnt, bool force, bool intermediate_peaks_ready_signal);
 133         void truncate_peakfile();
 134
 135         mutable off_t _peak_byte_max; // modified in compute_and_write_peak()
 136
 137         virtual nframes_t read_unlocked (Sample *dst, nframes_t start, nframes_t cnt) const = 0;
 138         virtual nframes_t write_unlocked (Sample *dst, nframes_t cnt) = 0;
 139         virtual Glib::ustring peak_path(Glib::ustring audio_path) = 0;
 140         virtual Glib::ustring find_broken_peakfile (Glib::ustring missing_peak_path, Glib::ustring audio_path) = 0;
 141
 142         void update_length (nframes_t pos, nframes_t cnt);
 143
 144   private:
 145         int peakfile;
 146         nframes_t peak_leftover_cnt;
 147         nframes_t peak_leftover_size;
 148         Sample* peak_leftovers;
 149         nframes_t peak_leftover_frame;
 150
 151         bool file_changed (Glib::ustring path);
 152 };
 153
 154 }
 155
 156 #endif /* __ardour_audio_source_h__ */