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 using Glib::ustring;
  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&, ustring name);
  53         AudioSource (Session&, const XMLNode&);
  54         virtual ~AudioSource ();
  55
  56         virtual nframes_t available_peaks (double zoom) const;
  57
  58         virtual nframes_t read (Sample *dst, nframes_t start, nframes_t cnt) const;
  59         virtual nframes_t write (Sample *src, nframes_t cnt);
  60
  61         virtual float sample_rate () const = 0;
  62
  63         virtual void mark_for_remove() = 0;
  64         virtual void mark_streaming_write_completed () {}
  65
  66         virtual bool can_truncate_peaks() const { return true; }
  67
  68         void set_captured_for (ustring str) { _captured_for = str; }
  69         ustring captured_for() const { return _captured_for; }
  70
  71         uint32_t read_data_count() const { return _read_data_count; }
  72         uint32_t write_data_count() const { return _write_data_count; }
  73
  74         virtual int read_peaks (PeakData *peaks, nframes_t npeaks, nframes_t start, nframes_t cnt, double samples_per_unit) const;
  75         int  build_peaks ();
  76         bool peaks_ready (sigc::slot<void>, sigc::connection&) const;
  77
  78         mutable sigc::signal<void>  PeaksReady;
  79         mutable sigc::signal<void,nframes_t,nframes_t>  PeakRangeReady;
  80
  81         XMLNode& get_state ();
  82         int set_state (const XMLNode&);
  83
  84         int rename_peakfile (ustring newpath);
  85         void touch_peakfile ();
  86
  87         static void set_build_missing_peakfiles (bool yn) {
  88                 _build_missing_peakfiles = yn;
  89         }
  90
  91         static void set_build_peakfiles (bool yn) {
  92                 _build_peakfiles = yn;
  93         }
  94
  95         virtual int setup_peakfile () { return 0; }
  96
  97         int prepare_for_peakfile_writes ();
  98         void done_with_peakfile_writes ();
  99
 100   protected:
 101         static bool _build_missing_peakfiles;
 102         static bool _build_peakfiles;
 103
 104         bool                _peaks_built;
 105         mutable Glib::Mutex _lock;
 106         ustring               peakpath;
 107         ustring              _captured_for;
 108
 109         mutable uint32_t _read_data_count;  // modified in read()
 110         mutable uint32_t _write_data_count; // modified in write()
 111
 112         int initialize_peakfile (bool newfile, ustring path);
 113         int build_peaks_from_scratch ();
 114         int compute_and_write_peaks (Sample* buf, nframes_t first_frame, nframes_t cnt, bool force);
 115         void truncate_peakfile();
 116
 117         mutable off_t _peak_byte_max; // modified in compute_and_write_peak()
 118
 119         virtual nframes_t read_unlocked (Sample *dst, nframes_t start, nframes_t cnt) const = 0;
 120         virtual nframes_t write_unlocked (Sample *dst, nframes_t cnt) = 0;
 121         virtual ustring peak_path(ustring audio_path) = 0;
 122         virtual ustring old_peak_path(ustring audio_path) = 0;
 123
 124   private:
 125         int peakfile;
 126         nframes_t peak_leftover_cnt;
 127         nframes_t peak_leftover_size;
 128         Sample* peak_leftovers;
 129         nframes_t peak_leftover_frame;
 130
 131         bool file_changed (ustring path);
 132 };
 133
 134 }
 135
 136 #endif /* __ardour_audio_source_h__ */