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__
23 #include <boost/shared_ptr.hpp>
24 #include <boost/enable_shared_from_this.hpp>
28 #include <glibmm/thread.h>
29 #include <glibmm/ustring.h>
30 #include <boost/function.hpp>
32 #include "ardour/source.h"
33 #include "ardour/ardour.h"
34 #include "ardour/readable.h"
35 #include "pbd/stateful.h"
36 #include "pbd/xml++.h"
40 class AudioSource : virtual public Source,
41 public ARDOUR::Readable,
42 public boost::enable_shared_from_this<ARDOUR::AudioSource>
45 AudioSource (Session&, Glib::ustring name);
46 AudioSource (Session&, const XMLNode&);
47 virtual ~AudioSource ();
49 framecnt_t readable_length() const { return _length; }
50 uint32_t n_channels() const { return 1; }
52 framecnt_t length (framepos_t pos) const;
53 void update_length (framepos_t pos, framecnt_t cnt);
55 virtual framecnt_t available_peaks (double zoom) const;
57 virtual framecnt_t read (Sample *dst, framepos_t start, framecnt_t cnt, int channel=0) const;
58 virtual framecnt_t write (Sample *src, framecnt_t cnt);
60 virtual float sample_rate () const = 0;
62 virtual void mark_streaming_write_completed () {}
64 virtual bool can_truncate_peaks() const { return true; }
66 void set_captured_for (Glib::ustring str) { _captured_for = str; }
67 Glib::ustring captured_for() const { return _captured_for; }
69 uint32_t read_data_count() const { return _read_data_count; }
70 uint32_t write_data_count() const { return _write_data_count; }
72 int read_peaks (PeakData *peaks, framecnt_t npeaks,
73 framepos_t start, framecnt_t cnt, double samples_per_visual_peak) const;
76 bool peaks_ready (boost::function<void()> callWhenReady, PBD::ScopedConnection** connection_created_if_not_ready, PBD::EventLoop* event_loop) const;
78 mutable PBD::Signal0<void> PeaksReady;
79 mutable PBD::Signal2<void,framepos_t,framepos_t> PeakRangeReady;
81 XMLNode& get_state ();
82 int set_state (const XMLNode&, int version);
84 int rename_peakfile (Glib::ustring newpath);
85 void touch_peakfile ();
87 static void set_build_missing_peakfiles (bool yn) {
88 _build_missing_peakfiles = yn;
91 static void set_build_peakfiles (bool yn) {
92 _build_peakfiles = yn;
95 static bool get_build_peakfiles () {
96 return _build_peakfiles;
99 virtual int setup_peakfile () { return 0; }
101 int prepare_for_peakfile_writes ();
102 void done_with_peakfile_writes (bool done = true);
104 /** @return true if the each source sample s must be clamped to -1 < s < 1 */
105 virtual bool clamped_at_unity () const = 0;
108 static bool _build_missing_peakfiles;
109 static bool _build_peakfiles;
113 mutable Glib::Mutex _peaks_ready_lock;
114 Glib::ustring peakpath;
115 Glib::ustring _captured_for;
117 mutable uint32_t _read_data_count; // modified in read()
118 mutable uint32_t _write_data_count; // modified in write()
120 int initialize_peakfile (bool newfile, Glib::ustring path);
121 int build_peaks_from_scratch ();
122 int compute_and_write_peaks (Sample* buf, framepos_t first_frame, framecnt_t cnt,
123 bool force, bool intermediate_peaks_ready_signal);
124 void truncate_peakfile();
126 mutable off_t _peak_byte_max; // modified in compute_and_write_peak()
128 virtual framecnt_t read_unlocked (Sample *dst, framepos_t start, framecnt_t cnt) const = 0;
129 virtual framecnt_t write_unlocked (Sample *dst, framecnt_t cnt) = 0;
130 virtual Glib::ustring peak_path(Glib::ustring audio_path) = 0;
131 virtual Glib::ustring find_broken_peakfile (Glib::ustring missing_peak_path,
132 Glib::ustring audio_path) = 0;
134 virtual int read_peaks_with_fpp (PeakData *peaks,
135 framecnt_t npeaks, framepos_t start, framecnt_t cnt,
136 double samples_per_visual_peak, framecnt_t fpp) const;
138 int compute_and_write_peaks (Sample* buf, framepos_t first_frame, framecnt_t cnt,
139 bool force, bool intermediate_peaks_ready_signal,
140 framecnt_t frames_per_peak);
144 framecnt_t peak_leftover_cnt;
145 framecnt_t peak_leftover_size;
146 Sample* peak_leftovers;
147 framepos_t peak_leftover_frame;
152 #endif /* __ardour_audio_source_h__ */