annotate data/fileio/AudioFileReaderFactory.h @ 300:5877d68815c7

* Change WaveFileModel API from getValues(start,end) to getData(start,count). It's much less error-prone to pass in frame counts instead of start/end locations. Should have done this ages ago. This closes #1794563. * Add option to apply a transform to only the selection region, instead of the whole audio. * (to make the above work properly) Add start frame offset to wave models
author Chris Cannam
date Mon, 01 Oct 2007 13:48:38 +0000
parents c022976d18e8
children 3a6725f285d6
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@148 16 #ifndef _AUDIO_FILE_READER_FACTORY_H_
Chris@148 17 #define _AUDIO_FILE_READER_FACTORY_H_
Chris@148 18
Chris@290 19 #include <QString>
Chris@148 20
Chris@148 21 class AudioFileReader;
Chris@148 22
Chris@148 23 class AudioFileReaderFactory
Chris@148 24 {
Chris@148 25 public:
Chris@148 26 /**
Chris@148 27 * Return the file extensions that we have audio file readers for,
Chris@148 28 * in a format suitable for use with QFileDialog. For example,
Chris@148 29 * "*.wav *.aiff *.ogg".
Chris@148 30 */
Chris@290 31 static QString getKnownExtensions();
Chris@148 32
Chris@148 33 /**
Chris@148 34 * Return an audio file reader initialised to the file at the
Chris@148 35 * given path, or NULL if no suitable reader for this path is
Chris@148 36 * available or the file cannot be opened.
Chris@297 37 *
Chris@297 38 * If targetRate is non-zero, the file will be resampled to that
Chris@297 39 * rate (transparently). You can query reader->getNativeRate()
Chris@297 40 * if you want to find out whether the file is being resampled
Chris@297 41 * or not.
Chris@297 42 *
Chris@148 43 * Caller owns the returned object and must delete it after use.
Chris@148 44 */
Chris@297 45 static AudioFileReader *createReader(QString path, size_t targetRate = 0);
Chris@148 46 };
Chris@148 47
Chris@148 48 #endif
Chris@148 49