/usr/include/echonest5/AudioSummary.h is in libechonest5-dev 2.3.1-0.3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 | /****************************************************************************************
* Copyright (c) 2010-2012 Leo Franchi <lfranchi@kde.org> *
* *
* 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. *
* *
* This program is distributed in the hope that it will be useful, but WITHOUT ANY *
* WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A *
* PARTICULAR PURPOSE. See the GNU General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License along with *
* this program. If not, see <http://www.gnu.org/licenses/>. *
****************************************************************************************/
#ifndef ECHONEST_AUDIOSUMMARY_H
#define ECHONEST_AUDIOSUMMARY_H
#include "echonest_export.h"
#include <QSharedData>
#include <QDebug>
#include "Util.h"
#include "Util.h"
#include "Config.h"
class QNetworkReply;
class QNetworkReply;
class AudioSummaryData;
namespace Echonest{
/**
* This encapsulates the audio summary of an Echo Nest track or song.
*
* It has two batches of data: the more generic acoustic information about the
* song is always populated, and additional detailed information about the song
* such as bars, beats, segments, tatus, and sections, can be fetched as well as
* an additional step.
*
* This class is implicitly shared.
*/
class ECHONEST_EXPORT AudioSummary
{
public:
AudioSummary();
AudioSummary( const AudioSummary& other );
~AudioSummary();
AudioSummary& operator=( const AudioSummary& audio );
int key() const;
void setKey( int key );
/**
* The track's tempo.
*/
qreal tempo() const;
void setTempo( qreal tempo );
/**
* The track's mode.
*/
int mode() const;
void setMode( int mode );
/**
* The track's time signature, or -1 if it there is one, or 1 if it is
* too complex.
*/
int timeSignature() const;
void setTimeSignature( int timeSignature );
/**
* The duration of the song, in msecs.
*/
qreal duration() const;
void setDuration( qreal duration );
/**
* The loudness of the song, in dB.
*/
qreal loudness() const;
void setLoudness( qreal loudness );
/**
* The danceability of this track, from 0 to 1.
*/
qreal danceability() const;
void setDanceability( qreal dance );
/**
* The energy of this song, from 0 to 1.
*/
qreal energy() const;
void setEnergy( qreal energy );
/**
* The acousticness of this song, from 0 to 1.
*/
qreal acousticness() const;
void setAcousticness( qreal acousticness );
/**
* The speechiness of this song, from 0 to 1.
*/
qreal speechiness() const;
void setSpeechiness( qreal speechiness );
/**
* The liveness of this song, from 0 to 1.
*/
qreal liveness() const;
void setLiveness( qreal liveness );
/**
* The valence of this song, from 0 to 1.
*/
qreal valence() const;
void setValence( qreal valence );
/// The following require additional fetching to read ///
/** TODO: implement **/
/**
* If you wish to use any of the more detailed track analysis data,
* use this method to begin the fetch. One the returned QNetworkReply*
* has emitted the finished() signal, call parseFullAnalysis.
*/
QNetworkReply* fetchFullAnalysis() const;
/**
* Parses the result of a fetchFullAnalysis() call. This contains
* information such as mode, fadein/fadeout, confidence metrics,
* and the division of the song into bars, beats, sections, and segments.
*/
void parseFullAnalysis( QNetworkReply* reply ) throw( ParseError );
/// The following methods *ALL REQUIRE THAT parseFullAnalysis be called first*
/**
* How long it took to analyze this track.
*/
qreal analysisTime() const;
void setAnalysisTime( qreal time );
/**
* The version of the analyzer used on this track.
*/
QString analyzerVersion() const;
void setAnalyzerVersion( QString version );
/**
* Detailed status information about the analysis
*/
QString detailedStatus() const;
void setDetailedStatus( const QString& status );
/**
* The status code of the analysis
*/
int analysisStatus() const;
void setAnalysisStatus( int status );
/**
* The timestamp of the analysis.
*/
qreal timestamp() const;
void setTimestamp( qreal timestamp );
/** ECHONEST_EXPORT
* The sample rate of the track.
*/
qreal sampleRate() const;
void setSampleRate( qreal sampleRate );
/**
* The end of the track's fade in in msec.
*/
qreal endOfFadeIn() const;
void setEndOfFadeIn( qreal time );
/**
* The start of the fade out in msec.
*/
qreal startOfFadeOut() const;
void setStartOfFadeOut( qreal time );
/**
* The confidence of the key item.
*/
qreal keyConfidence() const;
void setKeyConfidence( qreal confidence );
/**
* The confidence of the mode item.
*/
qreal modeConfidence() const;
void setModeConfidence( qreal confidence );
/**
* The confidence of the tempo item.
*/
qreal tempoConfidence() const;
void setTempoConfidence( qreal confidence );
/**
* The confidence of the time signature item.
*/
qreal timeSignatureConfidence() const;
void setTimeSignatureConfidence( qreal confidence );
/**
* The number of samples in this track.
*/
qint64 numSamples() const;
void setNumSamples( qint64 num );
/**
* The MD5 of the sample.
*/
QString sampleMD5() const;
void setSampleMD5( const QString& md5 );
/**
* List of bars that are in the track.
*/
BarList bars() const;
void setBars( const BarList& bars );
/**
* List of beats in the track.
*/
BeatList beats() const;
void setBeats( const BeatList& beats );
/**
* List of sections in the track.
*/
SectionList sections() const;
void setSections( const SectionList& sections );
/**
* List of tatums in the track
*/
TatumList tatums() const;
void setTatums( const TatumList& tatums );
/**
* List of segments in the track with associated acoustic data.
*/
SegmentList segments() const;
void setSegments( const SegmentList& segments );
void setAnalysisUrl( const QUrl& analysisUrl );
private:
QSharedDataPointer<AudioSummaryData> d;
};
ECHONEST_EXPORT QDebug operator<<(QDebug d, const Echonest::AudioSummary& summary);
} // namespace
#endif
|