Prevent endless read of silent files
[ardour.git] / libs / ardour / ardour / silentfilesource.h
1 /*
2     Copyright (C) 2007 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 */
19
20 #ifndef __ardour_silentfilesource_h__
21 #define __ardour_silentfilesource_h__
22
23 #include <cstring>
24 #include "ardour/audiofilesource.h"
25
26 namespace ARDOUR {
27
28 class LIBARDOUR_API SilentFileSource : public AudioFileSource {
29 public:
30         int update_header (samplepos_t /*when*/, struct tm&, time_t) { return 0; }
31         int flush_header () { return 0; }
32         float sample_rate () const { return _sample_rate; }
33
34         void set_length (samplecnt_t len) { _length = len; }
35         void flush () {}
36
37         bool destructive() const { return false; }
38         bool can_be_analysed() const { return false; }
39
40         bool clamped_at_unity() const { return false; }
41
42 protected:
43         void close() {}
44         friend class SourceFactory;
45
46         SilentFileSource (Session& s, const XMLNode& x, samplecnt_t len, float srate)
47                 : Source (s, x)
48                 , AudioFileSource (s, x, false)
49                 , _sample_rate(srate)
50         {
51                 _length = len;
52         }
53
54         samplecnt_t read_unlocked (Sample *dst, samplepos_t start, samplecnt_t cnt) const {
55                 cnt = std::min (cnt, _length - start);
56                 memset (dst, 0, sizeof (Sample) * cnt);
57                 return cnt;
58         }
59
60         samplecnt_t write_unlocked (Sample */*dst*/, samplecnt_t /*cnt*/) { return 0; }
61
62         void set_header_timeline_position () {}
63
64         int read_peaks_with_fpp (PeakData *peaks, samplecnt_t npeaks, samplepos_t /*start*/, samplecnt_t /*cnt*/,
65                                  double /*samples_per_pixel*/, samplecnt_t /*fpp*/) const {
66                 memset (peaks, 0, sizeof (PeakData) * npeaks);
67                 return 0;
68         }
69
70         float _sample_rate;
71 };
72
73 } // namespace ARDOUR
74
75 #endif /* __ardour_audiofilesource_h__ */
76