1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
|
/* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */
/*
Sonic Visualiser
An audio file viewer and annotation editor.
Centre for Digital Music, Queen Mary, University of London.
This file copyright 2006 Chris Cannam.
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License as
published by the Free Software Foundation; either version 2 of the
License, or (at your option) any later version. See the file
COPYING included with this distribution for more information.
*/
#ifndef AUDIO_FILE_READER_FACTORY_H
#define AUDIO_FILE_READER_FACTORY_H
#include <QString>
#include "FileSource.h"
#include "base/BaseTypes.h"
namespace sv {
class AudioFileReader;
class ProgressReporter;
class AudioFileReaderFactory
{
public:
/**
* Return the file extensions that we have audio file readers for,
* in a format suitable for use with QFileDialog. For example,
* "*.wav *.aiff *.ogg".
*/
static QString getKnownExtensions();
enum class Normalisation {
/**
* Do not normalise file data.
*/
None,
/**
* Normalise file data to abs(max) == 1.0.
*/
Peak
};
enum class GaplessMode {
/**
* Any encoder delay and padding found in file metadata will
* be compensated for, giving gapless decoding (assuming the
* metadata are correct). This is currently only applicable to
* mp3 files: all other supported files are always gapless
* where the file metadata provides for it. See documentation
* for MP3FileReader::GaplessMode for details of the specific
* implementation.
*/
Gapless,
/**
* No delay compensation will happen and the results will be
* equivalent to the behaviour of audio readers before the
* compensation logic was implemented. This is currently only
* applicable to mp3 files: all other supported files are
* always gapless where the file metadata provides for it. See
* documentation for MP3FileReader::GaplessMode for details of
* the specific implementation.
*/
Gappy
};
enum class ThreadingMode {
/**
* Any necessary decoding will happen synchronously when the
* reader is created.
*/
NotThreaded,
/**
* If the reader supports threaded decoding, it will be used
* and the file will be decoded in a background thread. If the
* reader does not support threaded decoding, behaviour will
* be as for NotThreaded.
*/
Threaded
};
struct Parameters {
/**
* Sample rate to open the file at. If zero (the default), the
* file's native rate will be used. If non-zero, the file will
* be automatically resampled to that rate. You can query
* reader->getNativeRate() if you want to find out whether the
* file needed to be resampled.
*/
sv_samplerate_t targetRate;
/**
* Normalisation to use. The default is Normalisation::None.
*/
Normalisation normalisation;
/**
* Gapless mode to use. The default is GaplessMode::Gapless.
*/
GaplessMode gaplessMode;
/**
* Threading mode. The default is ThreadingMode::NotThreaded.
*/
ThreadingMode threadingMode;
/**
* True if the file is still being written and the frame count
* may change. Not all readers support this.
*/
bool fileUpdating;
Parameters() :
targetRate(0),
normalisation(Normalisation::None),
gaplessMode(GaplessMode::Gapless),
threadingMode(ThreadingMode::NotThreaded),
fileUpdating(false)
{ }
};
/**
* Return an audio file reader initialised to the file at the
* given path, or NULL if no suitable reader for this path is
* available or the file cannot be opened.
*
* If a ProgressReporter is provided, it will be updated with
* progress status. This will only be meaningful if decoding is
* being carried out in non-threaded mode (either because the
* threaded parameter was not supplied or because the specific
* file reader used does not support it); in threaded mode,
* reported progress will jump straight to 100% before threading
* takes over. Caller retains ownership of the reporter object.
*
* Caller owns the returned object and must delete it after use.
*/
static AudioFileReader *createReader(FileSource source,
Parameters parameters,
ProgressReporter *reporter = 0);
/**
* Return true if the given source has a file extension that
* indicates a supported file type. This does not necessarily mean
* that it can be opened; conversely it may theoretically be
* possible to open some files without supported extensions,
* depending on the readers available.
*/
static bool isSupported(FileSource source);
};
} // end namespace sv
#endif
|
