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     $Id: audio_source.h 486 2006-04-27 09:04:24Z pauld $
  19 */
  20
  21 #ifndef __ardour_audio_source_h__
  22 #define __ardour_audio_source_h__
  23
  24 #include <list>
  25 #include <vector>
  26 #include <string>
  27
  28 #include <time.h>
  29
  30 #include <glibmm/thread.h>
  31
  32 #include <sigc++/signal.h>
  33
  34 #include <ardour/source.h>
  35 #include <ardour/ardour.h>
  36 #include <pbd/stateful.h>
  37 #include <pbd/xml++.h>
  38
  39 using std::list;
  40 using std::vector;
  41 using std::string;
  42
  43 namespace ARDOUR {
  44
  45 const jack_nframes_t frames_per_peak = 256;
  46
  47 class AudioSource : public Source
  48 {
  49   public:
  50         AudioSource (string name);
  51         AudioSource (const XMLNode&);
  52         virtual ~AudioSource ();
  53
  54         virtual jack_nframes_t available_peaks (double zoom) const;
  55
  56         virtual jack_nframes_t read (Sample *dst, jack_nframes_t start, jack_nframes_t cnt) const;
  57         virtual jack_nframes_t write (Sample *src, jack_nframes_t cnt);
  58
  59         virtual float sample_rate () const = 0;
  60
  61         virtual void mark_for_remove() = 0;
  62         virtual void mark_streaming_write_completed () {}
  63
  64         void set_captured_for (string str) { _captured_for = str; }
  65         string captured_for() const { return _captured_for; }
  66
  67         uint32_t read_data_count() const { return _read_data_count; }
  68         uint32_t write_data_count() const { return _write_data_count; }
  69
  70         int  read_peaks (PeakData *peaks, jack_nframes_t npeaks, jack_nframes_t start, jack_nframes_t cnt, double samples_per_unit) const;
  71         int  build_peaks ();
  72         bool peaks_ready (sigc::slot<void>, sigc::connection&) const;
  73
  74         static sigc::signal<void,AudioSource*> AudioSourceCreated;
  75
  76         mutable sigc::signal<void>  PeaksReady;
  77         mutable sigc::signal<void,jack_nframes_t,jack_nframes_t>  PeakRangeReady;
  78
  79         XMLNode& get_state ();
  80         int set_state (const XMLNode&);
  81
  82         static int  start_peak_thread ();
  83         static void stop_peak_thread ();
  84
  85         int rename_peakfile (std::string newpath);
  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   protected:
  96         static bool _build_missing_peakfiles;
  97         static bool _build_peakfiles;
  98
  99         bool                _peaks_built;
 100         mutable Glib::Mutex _lock;
 101         bool                 next_peak_clear_should_notify;
 102         string               peakpath;
 103         string              _captured_for;
 104
 105         mutable uint32_t _read_data_count;  // modified in read()
 106         mutable uint32_t _write_data_count; // modified in write()
 107
 108         int initialize_peakfile (bool newfile, string path);
 109         void build_peaks_from_scratch ();
 110
 111         int  do_build_peak (jack_nframes_t, jack_nframes_t);
 112
 113         virtual jack_nframes_t read_unlocked (Sample *dst, jack_nframes_t start, jack_nframes_t cnt) const = 0;
 114         virtual jack_nframes_t write_unlocked (Sample *dst, jack_nframes_t cnt) = 0;
 115         virtual string peak_path(string audio_path) = 0;
 116         virtual string old_peak_path(string audio_path) = 0;
 117
 118         static pthread_t peak_thread;
 119         static bool      have_peak_thread;
 120         static void*     peak_thread_work(void*);
 121
 122         static int peak_request_pipe[2];
 123
 124         struct PeakRequest {
 125             enum Type {
 126                     Build,
 127                     Quit
 128             };
 129         };
 130
 131         static vector<AudioSource*> pending_peak_sources;
 132         static Glib::Mutex* pending_peak_sources_lock;
 133
 134         static void queue_for_peaks (AudioSource&);
 135         static void clear_queue_for_peaks ();
 136
 137         struct PeakBuildRecord {
 138             jack_nframes_t frame;
 139             jack_nframes_t cnt;
 140
 141             PeakBuildRecord (jack_nframes_t f, jack_nframes_t c)
 142                     : frame (f), cnt (c) {}
 143             PeakBuildRecord (const PeakBuildRecord& other) {
 144                     frame = other.frame;
 145                     cnt = other.cnt;
 146             }
 147         };
 148
 149         list<AudioSource::PeakBuildRecord *> pending_peak_builds;
 150
 151   private:
 152         bool file_changed (string path);
 153 };
 154
 155 }
 156
 157 #endif /* __ardour_audio_source_h__ */