strawberry-audio-player-win.../3rdparty/taglib/audioproperties.h

121 lines
4.3 KiB
C
Raw Normal View History

2018-05-10 15:29:28 +02:00
/***************************************************************************
copyright : (C) 2002 - 2008 by Scott Wheeler
email : wheeler@kde.org
***************************************************************************/
/***************************************************************************
* This library is free software; you can redistribute it and/or modify *
* it under the terms of the GNU Lesser General Public License version *
* 2.1 as published by the Free Software Foundation. *
* *
* This library 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 *
* Lesser General Public License for more details. *
* *
* You should have received a copy of the GNU Lesser General Public *
* License along with this library; if not, write to the Free Software *
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA *
* 02110-1301 USA *
* *
* Alternatively, this file is available under the Mozilla Public *
* License Version 1.1. You may obtain a copy of the License at *
* http://www.mozilla.org/MPL/ *
***************************************************************************/
#ifndef TAGLIB_AUDIOPROPERTIES_H
#define TAGLIB_AUDIOPROPERTIES_H
#include "taglib_export.h"
2020-06-26 23:30:30 +02:00
#include "tstring.h"
2018-05-10 15:29:28 +02:00
2019-04-26 01:12:42 +02:00
namespace Strawberry_TagLib {
namespace TagLib {
2018-05-10 15:29:28 +02:00
2020-06-13 19:02:42 +02:00
//! A simple, abstract interface to common audio properties
2018-05-10 15:29:28 +02:00
2020-06-13 19:02:42 +02:00
/*!
* The values here are common to most audio formats.
* For more specific, codec dependent values, please see see the subclasses APIs.
* This is meant to compliment the TagLib::File and TagLib::Tag APIs in providing a simple
2018-05-10 15:29:28 +02:00
* interface that is sufficient for most applications.
*/
2020-06-13 19:02:42 +02:00
class TAGLIB_EXPORT AudioProperties {
public:
/*!
* Reading audio properties from a file can sometimes be very time consuming
* and for the most accurate results can often involve reading the entire file.
* Because in many situations speed is critical or the accuracy of the values
* is not particularly important this allows the level of desired accuracy to be set.
*/
2020-06-13 19:02:42 +02:00
enum ReadStyle {
//! Read as little of the file as possible
Fast,
//! Read more of the file and make better values guesses
Average,
//! Read as much of the file as needed to report accurate values
Accurate
};
/*!
* Destroys this AudioProperties instance.
*/
2020-06-13 19:02:42 +02:00
virtual ~AudioProperties();
2018-05-10 15:29:28 +02:00
2020-06-13 19:02:42 +02:00
/*!
* Returns the length of the file in seconds. The length is rounded down to the nearest whole second.
*
* \see lengthInMilliseconds()
*/
virtual int lengthInSeconds() const = 0;
2018-05-10 15:29:28 +02:00
2020-06-13 19:02:42 +02:00
/*!
* Returns the length of the file in milliseconds.
*
* \see lengthInSeconds()
*/
virtual int lengthInMilliseconds() const = 0;
2018-05-10 15:29:28 +02:00
2020-06-13 19:02:42 +02:00
/*!
* Returns the most appropriate bit rate for the file in kb/s. For constant bitrate formats this is simply the bitrate of the file.
* For variable bitrate formats this is either the average or nominal bitrate.
*/
2020-06-13 19:02:42 +02:00
virtual int bitrate() const = 0;
2018-05-10 15:29:28 +02:00
2020-06-13 19:02:42 +02:00
/*!
* Returns the sample rate in Hz.
*/
2020-06-13 19:02:42 +02:00
virtual int sampleRate() const = 0;
2018-05-10 15:29:28 +02:00
2020-06-13 19:02:42 +02:00
/*!
* Returns the number of audio channels.
*/
2020-06-13 19:02:42 +02:00
virtual int channels() const = 0;
2018-05-10 15:29:28 +02:00
/*!
* Returns description of the audio file.
*/
virtual String toString() const;
2020-06-13 19:02:42 +02:00
protected:
/*!
* Construct an audio properties instance.
* This is protected as this class should not be instantiated directly,
* but should be instantiated via its subclasses and can be fetched from the FileRef or File APIs.
*/
2020-06-26 23:30:30 +02:00
explicit AudioProperties();
2018-05-10 15:29:28 +02:00
2020-06-13 19:02:42 +02:00
private:
2020-06-26 23:30:30 +02:00
AudioProperties(const AudioProperties&);
AudioProperties &operator=(const AudioProperties&);
2018-05-10 15:29:28 +02:00
2020-06-13 19:02:42 +02:00
class AudioPropertiesPrivate;
AudioPropertiesPrivate *d;
};
2018-05-10 15:29:28 +02:00
2020-06-13 19:02:42 +02:00
} // namespace TagLib
} // namespace Strawberry_TagLib
2018-05-10 15:29:28 +02:00
#endif