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 nframes64_t readable_length() const { return _length; }
54 uint32_t n_channels() const { return 1; }
56 virtual nframes_t available_peaks (double zoom) const;
58 /* stopgap until nframes_t becomes nframes64_t. this function is needed by the Readable interface */
60 virtual nframes64_t read (Sample *dst, nframes64_t start, nframes64_t cnt, int channel) const {
61 /* XXX currently ignores channel, assuming that source is always mono, which
62 historically has been true.
64 return read (dst, (nframes_t) start, (nframes_t) cnt);
67 virtual nframes_t read (Sample *dst, nframes_t start, nframes_t cnt) const;
68 virtual nframes_t write (Sample *src, nframes_t cnt);
70 virtual float sample_rate () const = 0;
72 virtual void mark_for_remove() = 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, nframes_t start, nframes_t cnt, double samples_per_visual_peak) const;
86 bool peaks_ready (sigc::slot<void>, sigc::connection&) const;
88 mutable sigc::signal<void> PeaksReady;
89 mutable sigc::signal<void,nframes_t,nframes_t> PeakRangeReady;
91 XMLNode& get_state ();
92 int set_state (const XMLNode&);
94 int rename_peakfile (Glib::ustring newpath);
95 void touch_peakfile ();
97 static void set_build_missing_peakfiles (bool yn) {
98 _build_missing_peakfiles = yn;
101 static void set_build_peakfiles (bool yn) {
102 _build_peakfiles = yn;
105 static bool get_build_peakfiles () {
106 return _build_peakfiles;
109 virtual int setup_peakfile () { return 0; }
111 int prepare_for_peakfile_writes ();
112 void done_with_peakfile_writes (bool done = true);
115 static bool _build_missing_peakfiles;
116 static bool _build_peakfiles;
119 mutable Glib::Mutex _lock;
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, bool force, bool intermediate_peaks_ready_signal);
130 void truncate_peakfile();
132 mutable off_t _peak_byte_max; // modified in compute_and_write_peak()
134 virtual nframes_t read_unlocked (Sample *dst, nframes_t start, nframes_t cnt) const = 0;
135 virtual nframes_t write_unlocked (Sample *dst, nframes_t cnt) = 0;
136 virtual Glib::ustring peak_path(Glib::ustring audio_path) = 0;
137 virtual Glib::ustring find_broken_peakfile (Glib::ustring missing_peak_path, Glib::ustring audio_path) = 0;
139 void update_length (nframes_t pos, nframes_t cnt);
141 virtual int read_peaks_with_fpp (PeakData *peaks, nframes_t npeaks, nframes_t start, nframes_t cnt,
142 double samples_per_visual_peak, nframes_t fpp) const;
144 int compute_and_write_peaks (Sample* buf, nframes_t first_frame, nframes_t cnt, bool force,
145 bool intermediate_peaks_ready_signal, nframes_t frames_per_peak);
149 nframes_t peak_leftover_cnt;
150 nframes_t peak_leftover_size;
151 Sample* peak_leftovers;
152 nframes_t peak_leftover_frame;
154 bool file_changed (Glib::ustring path);
159 #endif /* __ardour_audio_source_h__ */