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