annotate data/fileio/WavFileReader.h @ 1615:24dc8cb42755 single-point

Rename a number of classes and methods (including Point -> Event); comments
author Chris Cannam
date Thu, 07 Mar 2019 15:44:09 +0000
parents ce185d4dd408
children
rev   line source
Chris@148 1 /* -*- c-basic-offset: 4 indent-tabs-mode: nil -*- vi:set ts=8 sts=4 sw=4: */
Chris@148 2
Chris@148 3 /*
Chris@148 4 Sonic Visualiser
Chris@148 5 An audio file viewer and annotation editor.
Chris@148 6 Centre for Digital Music, Queen Mary, University of London.
Chris@148 7 This file copyright 2006 Chris Cannam.
Chris@148 8
Chris@148 9 This program is free software; you can redistribute it and/or
Chris@148 10 modify it under the terms of the GNU General Public License as
Chris@148 11 published by the Free Software Foundation; either version 2 of the
Chris@148 12 License, or (at your option) any later version. See the file
Chris@148 13 COPYING included with this distribution for more information.
Chris@148 14 */
Chris@148 15
Chris@1348 16 #ifndef SV_WAV_FILE_READER_H
Chris@1348 17 #define SV_WAV_FILE_READER_H
Chris@148 18
Chris@148 19 #include "AudioFileReader.h"
Chris@148 20
Chris@1350 21 #ifdef Q_OS_WIN
Chris@1350 22 #include <windows.h>
Chris@1349 23 #define ENABLE_SNDFILE_WINDOWS_PROTOTYPES 1
Chris@1350 24 #endif
Chris@1349 25
Chris@148 26 #include <sndfile.h>
Chris@148 27 #include <QMutex>
Chris@148 28
Chris@157 29 #include <set>
Chris@157 30
Chris@823 31 /**
Chris@823 32 * Reader for audio files using libsndfile.
Chris@823 33 *
Chris@823 34 * This is typically intended for seekable file types that can be read
Chris@823 35 * directly (e.g. WAV, AIFF etc).
Chris@823 36 *
Chris@823 37 * Compressed files supported by libsndfile (e.g. Ogg, FLAC) should
Chris@823 38 * normally be read using DecodingWavFileReader instead (which decodes
Chris@823 39 * to an intermediate cached file).
Chris@823 40 */
Chris@148 41 class WavFileReader : public AudioFileReader
Chris@148 42 {
Chris@148 43 public:
Chris@1520 44 enum class Normalisation { None, Peak };
Chris@1520 45
Chris@1513 46 WavFileReader(FileSource source,
Chris@1513 47 bool fileUpdating = false,
Chris@1520 48 Normalisation normalise = Normalisation::None);
Chris@148 49 virtual ~WavFileReader();
Chris@148 50
Chris@1580 51 QString getLocation() const override { return m_source.getLocation(); }
Chris@1580 52 QString getError() const override { return m_error; }
Chris@290 53
Chris@1592 54 QString getTitle() const override { return m_title; }
Chris@1592 55 QString getMaker() const override { return m_maker; }
Chris@1592 56
Chris@1580 57 QString getLocalFilename() const override { return m_path; }
Chris@1010 58
Chris@1580 59 bool isQuicklySeekable() const override { return m_seekable; }
Chris@823 60
Chris@148 61 /**
Chris@148 62 * Must be safe to call from multiple threads with different
Chris@148 63 * arguments on the same object at the same time.
Chris@148 64 */
Chris@1580 65 floatvec_t getInterleavedFrames(sv_frame_t start, sv_frame_t count) const override;
Chris@148 66
Chris@290 67 static void getSupportedExtensions(std::set<QString> &extensions);
Chris@316 68 static bool supportsExtension(QString ext);
Chris@316 69 static bool supportsContentType(QString type);
Chris@317 70 static bool supports(FileSource &source);
Chris@157 71
Chris@1580 72 int getDecodeCompletion() const override { return 100; }
Chris@265 73
Chris@1580 74 bool isUpdating() const override { return m_updating; }
Chris@176 75
Chris@175 76 void updateFrameCount();
Chris@176 77 void updateDone();
Chris@175 78
Chris@148 79 protected:
Chris@148 80 SF_INFO m_fileInfo;
Chris@1349 81 SNDFILE *m_file;
Chris@148 82
Chris@317 83 FileSource m_source;
Chris@290 84 QString m_path;
Chris@290 85 QString m_error;
Chris@1592 86 QString m_title;
Chris@1592 87 QString m_maker;
Chris@148 88
Chris@823 89 bool m_seekable;
Chris@823 90
Chris@148 91 mutable QMutex m_mutex;
Chris@1326 92 mutable floatvec_t m_buffer;
Chris@1038 93 mutable sv_frame_t m_lastStart;
Chris@1038 94 mutable sv_frame_t m_lastCount;
Chris@176 95
Chris@1520 96 Normalisation m_normalisation;
Chris@1513 97 float m_max;
Chris@1513 98
Chris@176 99 bool m_updating;
Chris@1513 100
Chris@1513 101 floatvec_t getInterleavedFramesUnnormalised(sv_frame_t start,
Chris@1513 102 sv_frame_t count) const;
Chris@1513 103 float getMax() const;
Chris@148 104 };
Chris@148 105
Chris@148 106 #endif