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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
|
/* -*- 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 SV_CSV_FORMAT_H
#define SV_CSV_FORMAT_H
#include <QString>
#include <QStringList>
#include <set>
#include <map>
#include "base/BaseTypes.h"
namespace sv {
class CSVFormat
{
public:
enum ModelType {
OneDimensionalModel,
TwoDimensionalModel,
TwoDimensionalModelWithDuration,
TwoDimensionalModelWithDurationAndPitch,
TwoDimensionalModelWithDurationAndExtent,
ThreeDimensionalModel,
WaveFileModel
};
enum TimingType {
ExplicitTiming,
ImplicitTiming
};
enum TimeUnits {
TimeSeconds,
TimeMilliseconds,
TimeAudioFrames,
TimeWindows,
};
enum ColumnPurpose {
ColumnUnknown,
ColumnStartTime,
ColumnEndTime,
ColumnDuration,
ColumnValue,
ColumnPitch,
ColumnLabel
};
enum HeaderStatus {
HeaderUnknown = 0,
HeaderAbsent = 1,
HeaderPresent = 2
};
enum ColumnQuality {
ColumnNumeric = 1, // No non-numeric values were seen in sample
ColumnIntegral = 2, // All sampled values were integers
ColumnIncreasing = 4, // Sampled values were monotonically increasing
ColumnSmall = 8, // All sampled values had magnitude < 1
ColumnLarge = 16, // Values "quickly" grew to over 1000
ColumnSigned = 32, // Some negative values were seen
ColumnNearEmpty = 64, // Nothing in this column beyond first row
};
typedef unsigned int ColumnQualities;
enum AudioSampleRange {
SampleRangeSigned1 = 0, // -1 .. 1
SampleRangeUnsigned255, // 0 .. 255
SampleRangeSigned32767, // -32768 .. 32767
SampleRangeOther // Other/unknown: Normalise on load
};
CSVFormat() : // arbitrary defaults
m_modelType(TwoDimensionalModel),
m_timingType(ExplicitTiming),
m_timeUnits(TimeSeconds),
m_separator(""),
m_sampleRate(44100),
m_increment(1024),
m_headerStatus(HeaderUnknown),
m_columnCount(0),
m_variableColumnCount(false),
m_audioSampleRange(SampleRangeOther),
m_allowQuoting(true),
m_maxExampleCols(0)
{ }
CSVFormat(QString path); // guess format
/**
* Guess the format of the given CSV file, setting the fields in
* this object accordingly. If the current separator is the empty
* string, the separator character will also be guessed; otherwise
* the current separator will be used. The other properties of
* this object will be set according to guesses from the file.
*
* The properties that are guessed from the file contents are:
* separator, column count, variable-column-count flag, audio
* sample range, timing type, time units, column qualities, column
* purposes, and model type. The sample rate and window size
* cannot be guessed and will not be changed by this function.
* Note also that this function will never guess WaveFileModel for
* the model type.
*
* Return false if there is some fundamental error, e.g. the file
* could not be opened at all. Return true otherwise. Note that
* this function returns true even if the file doesn't appear to
* make much sense as a data format.
*/
bool guessFormatFor(QString path);
ModelType getModelType() const { return m_modelType; }
TimingType getTimingType() const { return m_timingType; }
TimeUnits getTimeUnits() const { return m_timeUnits; }
QString getScaleUnits() const { return m_scaleUnits; }
sv_samplerate_t getSampleRate() const { return m_sampleRate; }
int getIncrement() const { return m_increment; }
int getColumnCount() const { return m_columnCount; }
AudioSampleRange getAudioSampleRange() const { return m_audioSampleRange; }
bool getAllowQuoting() const { return m_allowQuoting; }
HeaderStatus getHeaderStatus() const { return m_headerStatus; }
QChar getSeparator() const {
if (m_separator == "") return ',';
else return m_separator[0];
}
// set rather than QSet to ensure a fixed order
std::set<QChar> getPlausibleSeparators() const {
return m_plausibleSeparators;
}
void setModelType(ModelType t) { m_modelType = t; }
void setTimingType(TimingType t) { m_timingType = t; }
void setTimeUnits(TimeUnits t) { m_timeUnits = t; }
void setScaleUnits(QString u) { m_scaleUnits = u; }
void setSeparator(QChar s) { m_separator = s; }
void setSampleRate(sv_samplerate_t r) { m_sampleRate = r; }
void setIncrement(int s) { m_increment = s; }
void setColumnCount(int c) { m_columnCount = c; }
void setAudioSampleRange(AudioSampleRange r) { m_audioSampleRange = r; }
void setAllowQuoting(bool q) { m_allowQuoting = q; }
void setHeaderStatus(HeaderStatus s) { m_headerStatus = s; }
QList<ColumnPurpose> getColumnPurposes() const;
void setColumnPurposes(QList<ColumnPurpose> cl);
ColumnPurpose getColumnPurpose(int i) const;
void setColumnPurpose(int i, ColumnPurpose p);
// only valid if format has been guessed:
QList<ColumnQualities> getColumnQualities() const;
// only valid if format has been guessed:
QList<QStringList> getExample() const { return m_example; }
int getMaxExampleCols() const { return m_maxExampleCols; }
protected:
ModelType m_modelType;
TimingType m_timingType;
TimeUnits m_timeUnits;
QString m_scaleUnits;
QString m_separator; // "" or a single char - basically QChar option
std::set<QChar> m_plausibleSeparators;
sv_samplerate_t m_sampleRate;
int m_increment;
HeaderStatus m_headerStatus;
int m_columnCount;
bool m_variableColumnCount;
std::map<int, ColumnQualities> m_columnQualities;
std::map<int, ColumnPurpose> m_columnPurposes;
std::map<int, QString> m_columnHeadings;
std::map<int, QString> m_columnPossibleUnits;
std::map<int, float> m_prevValues;
AudioSampleRange m_audioSampleRange;
bool m_allowQuoting;
QList<QStringList> m_example;
int m_maxExampleCols;
void guessSeparator(QString line);
void guessQualities(QString line, int lineno);
void guessPurposes();
void guessAudioSampleRange();
void updateScaleUnits();
};
} // end namespace sv
#endif
|
