2 Copyright (C) 2000 Paul Davis
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.
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.
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.
20 #ifndef __ardour_audio_source_h__
21 #define __ardour_audio_source_h__
26 #include <boost/shared_ptr.hpp>
27 #include <boost/enable_shared_from_this.hpp>
31 #include <glibmm/thread.h>
32 #include <glibmm/ustring.h>
34 #include <sigc++/signal.h>
36 #include <ardour/source.h>
37 #include <ardour/ardour.h>
38 #include <pbd/stateful.h>
39 #include <pbd/xml++.h>
46 class AudioSource : virtual public Source,
47 public ARDOUR::Readable,
48 public boost::enable_shared_from_this<ARDOUR::AudioSource>
51 AudioSource (Session&, Glib::ustring name);
52 AudioSource (Session&, const XMLNode&);
53 virtual ~AudioSource ();
55 nframes64_t readable_length() const { return _length; }
56 uint32_t n_channels() const { return 1; }
58 virtual nframes_t available_peaks (double zoom) const;
60 /** Stopgap for Readable until nframes_t becomes nframes64_t. */
61 virtual nframes64_t read (Sample *dst, nframes64_t start, nframes64_t cnt, int channel) const {
62 /* XXX currently ignores channel, assuming that source is always mono, which
63 historically has been true.
65 return read (dst, (nframes_t) start, (nframes_t) cnt);
68 virtual nframes_t read (Sample *dst, nframes_t start, nframes_t cnt) const;
69 virtual nframes_t write (Sample *src, nframes_t cnt);
71 virtual float sample_rate () const = 0;
73 virtual void mark_streaming_write_completed () {}
75 virtual bool can_truncate_peaks() const { return true; }
77 void set_captured_for (Glib::ustring str) { _captured_for = str; }
78 Glib::ustring captured_for() const { return _captured_for; }
80 uint32_t read_data_count() const { return _read_data_count; }
81 uint32_t write_data_count() const { return _write_data_count; }
83 int read_peaks (PeakData *peaks, nframes_t npeaks,
84 nframes_t start, nframes_t cnt, double samples_per_visual_peak) const;
87 bool peaks_ready (sigc::slot<void>, sigc::connection&) const;
89 mutable sigc::signal<void> PeaksReady;
90 mutable sigc::signal<void,nframes_t,nframes_t> PeakRangeReady;
92 XMLNode& get_state ();
93 int set_state (const XMLNode&);
95 int rename_peakfile (Glib::ustring newpath);
96 void touch_peakfile ();
98 static void set_build_missing_peakfiles (bool yn) {
99 _build_missing_peakfiles = yn;
102 static void set_build_peakfiles (bool yn) {
103 _build_peakfiles = yn;
106 static bool get_build_peakfiles () {
107 return _build_peakfiles;
110 virtual int setup_peakfile () { return 0; }
112 int prepare_for_peakfile_writes ();
113 void done_with_peakfile_writes (bool done = true);
116 static bool _build_missing_peakfiles;
117 static bool _build_peakfiles;
120 mutable Glib::Mutex _peaks_ready_lock;
121 Glib::ustring peakpath;
122 Glib::ustring _captured_for;
124 mutable uint32_t _read_data_count; // modified in read()
125 mutable uint32_t _write_data_count; // modified in write()
127 int initialize_peakfile (bool newfile, Glib::ustring path);
128 int build_peaks_from_scratch ();
129 int compute_and_write_peaks (Sample* buf, nframes_t first_frame, nframes_t cnt,
130 bool force, bool intermediate_peaks_ready_signal);
131 void truncate_peakfile();
133 mutable off_t _peak_byte_max; // modified in compute_and_write_peak()
135 virtual nframes_t read_unlocked (Sample *dst, nframes_t start, nframes_t cnt) const = 0;
136 virtual nframes_t write_unlocked (Sample *dst, nframes_t cnt) = 0;
137 virtual Glib::ustring peak_path(Glib::ustring audio_path) = 0;
138 virtual Glib::ustring find_broken_peakfile (Glib::ustring missing_peak_path,
139 Glib::ustring audio_path) = 0;
141 virtual int read_peaks_with_fpp (PeakData *peaks,
142 nframes_t npeaks, nframes_t start, nframes_t cnt,
143 double samples_per_visual_peak, nframes_t fpp) const;
145 int compute_and_write_peaks (Sample* buf, nframes_t first_frame, nframes_t cnt,
146 bool force, bool intermediate_peaks_ready_signal, nframes_t frames_per_peak);
150 nframes_t peak_leftover_cnt;
151 nframes_t peak_leftover_size;
152 Sample* peak_leftovers;
153 nframes_t peak_leftover_frame;
155 bool file_changed (Glib::ustring path);
160 #endif /* __ardour_audio_source_h__ */