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 : public Source, public boost::enable_shared_from_this<ARDOUR::AudioSource>
49 AudioSource (Session&, Glib::ustring name);
50 AudioSource (Session&, const XMLNode&);
51 virtual ~AudioSource ();
53 /* one could argue that this should belong to Source, but other data types
54 generally do not come with a model of "offset along an audio timeline"
55 so its here in AudioSource for now.
58 virtual nframes_t natural_position() const { return 0; }
60 nframes64_t readable_length() const { return _length; }
61 uint32_t n_channels() const { return 1; }
63 virtual nframes_t length() const {
67 virtual nframes_t available_peaks (double zoom) const;
69 /* stopgap until nframes_t becomes nframes64_t. this function is needed by the Readable interface */
71 virtual nframes64_t read (Sample *dst, nframes64_t start, nframes64_t cnt, int channel) const {
72 /* XXX currently ignores channel, assuming that source is always mono, which
73 historically has been true.
75 return read (dst, (nframes_t) start, (nframes_t) cnt);
78 virtual nframes_t read (Sample *dst, nframes_t start, nframes_t cnt) const;
79 virtual nframes_t write (Sample *src, nframes_t cnt);
81 virtual float sample_rate () const = 0;
83 virtual void mark_for_remove() = 0;
84 virtual void mark_streaming_write_completed () {}
86 virtual bool can_truncate_peaks() const { return true; }
88 void set_captured_for (Glib::ustring str) { _captured_for = str; }
89 Glib::ustring captured_for() const { return _captured_for; }
91 uint32_t read_data_count() const { return _read_data_count; }
92 uint32_t write_data_count() const { return _write_data_count; }
94 int read_peaks (PeakData *peaks, nframes_t npeaks, nframes_t start, nframes_t cnt, double samples_per_visual_peak) const;
97 bool peaks_ready (sigc::slot<void>, sigc::connection&) const;
99 mutable sigc::signal<void> PeaksReady;
100 mutable sigc::signal<void,nframes_t,nframes_t> PeakRangeReady;
102 XMLNode& get_state ();
103 int set_state (const XMLNode&);
105 int rename_peakfile (Glib::ustring newpath);
106 void touch_peakfile ();
108 static void set_build_missing_peakfiles (bool yn) {
109 _build_missing_peakfiles = yn;
112 static void set_build_peakfiles (bool yn) {
113 _build_peakfiles = yn;
116 static bool get_build_peakfiles () {
117 return _build_peakfiles;
120 virtual int setup_peakfile () { return 0; }
122 int prepare_for_peakfile_writes ();
123 void done_with_peakfile_writes (bool done = true);
125 AnalysisFeatureList transients;
126 std::string get_transients_path() const;
128 void set_been_analysed (bool yn);
129 bool check_for_analysis_data_on_disk ();
132 static bool _build_missing_peakfiles;
133 static bool _build_peakfiles;
137 mutable Glib::Mutex _lock;
138 mutable Glib::Mutex _peaks_ready_lock;
140 Glib::ustring peakpath;
141 Glib::ustring _captured_for;
143 mutable uint32_t _read_data_count; // modified in read()
144 mutable uint32_t _write_data_count; // modified in write()
146 int initialize_peakfile (bool newfile, Glib::ustring path);
147 int build_peaks_from_scratch ();
148 int compute_and_write_peaks (Sample* buf, nframes_t first_frame, nframes_t cnt, bool force, bool intermediate_peaks_ready_signal);
149 void truncate_peakfile();
151 mutable off_t _peak_byte_max; // modified in compute_and_write_peak()
153 virtual nframes_t read_unlocked (Sample *dst, nframes_t start, nframes_t cnt) const = 0;
154 virtual nframes_t write_unlocked (Sample *dst, nframes_t cnt) = 0;
155 virtual Glib::ustring peak_path(Glib::ustring audio_path) = 0;
156 virtual Glib::ustring find_broken_peakfile (Glib::ustring missing_peak_path, Glib::ustring audio_path) = 0;
158 void update_length (nframes_t pos, nframes_t cnt);
160 virtual int read_peaks_with_fpp (PeakData *peaks, nframes_t npeaks, nframes_t start, nframes_t cnt,
161 double samples_per_visual_peak, nframes_t fpp) const;
163 int compute_and_write_peaks (Sample* buf, nframes_t first_frame, nframes_t cnt, bool force,
164 bool intermediate_peaks_ready_signal, nframes_t frames_per_peak);
166 int load_transients (const std::string&);
170 nframes_t peak_leftover_cnt;
171 nframes_t peak_leftover_size;
172 Sample* peak_leftovers;
173 nframes_t peak_leftover_frame;
175 bool file_changed (Glib::ustring path);
180 #endif /* __ardour_audio_source_h__ */