Qmmp
Public Types | Public Member Functions | Static Public Member Functions | List of all members
AudioParameters Class Reference

#include <audioparameters.h>

Public Types

enum  ByteOrder { LittleEndian = 0 , BigEndian }
 

Public Member Functions

 AudioParameters ()
 
 AudioParameters (quint32 srate, const ChannelMap &map, Qmmp::AudioFormat format)
 
 AudioParameters (const AudioParameters &other)
 
AudioParametersoperator= (const AudioParameters &p)
 
bool operator== (const AudioParameters &p) const
 
bool operator!= (const AudioParameters &p) const
 
quint32 sampleRate () const
 
int channels () const
 
const ChannelMap channelMap () const
 
Qmmp::AudioFormat format () const
 
int sampleSize () const
 
int frameSize () const
 
int bitsPerSample () const
 
int validBitsPerSample () const
 
ByteOrder byteOrder () const
 
const QString toString () const
 

Static Public Member Functions

static int sampleSize (Qmmp::AudioFormat format)
 
static int bitsPerSample (Qmmp::AudioFormat format)
 
static int validBitsPerSample (Qmmp::AudioFormat format)
 
static Qmmp::AudioFormat findAudioFormat (int bits, ByteOrder byteOrder=LittleEndian)
 

Detailed Description

The AudioParameters class keeps information about audio settings.

Author
Ilya Kotov forko.nosp@m.tov0.nosp@m.2@ya..nosp@m.ru

Member Enumeration Documentation

◆ ByteOrder

enum ByteOrder

Byte order of samples.

Enumerator
LittleEndian 

Samples are in little-endian byte order

BigEndian 

Samples are in big-endian byte order

Constructor & Destructor Documentation

◆ AudioParameters() [1/3]

Constructor.

◆ AudioParameters() [2/3]

AudioParameters ( quint32  srate,
const ChannelMap map,
Qmmp::AudioFormat  format 
)

Constructs audio settings with the given parameters.

Parameters
srateSampling rate.
mapChannel map.
formatPCM data format.

◆ AudioParameters() [3/3]

AudioParameters ( const AudioParameters other)

Constructs a copy of other.

Member Function Documentation

◆ bitsPerSample() [1/2]

int bitsPerSample ( ) const

Returns sample size in bits.

◆ bitsPerSample() [2/2]

static int bitsPerSample ( Qmmp::AudioFormat  format)
static

Returns sample size in bits of the given pcm data format.

◆ byteOrder()

ByteOrder byteOrder ( ) const

Returns byte order for selected audio format.

◆ channelMap()

const ChannelMap channelMap ( ) const

Returns channel map.

◆ channels()

int channels ( ) const

Returns number of channels.

◆ findAudioFormat()

static Qmmp::AudioFormat findAudioFormat ( int  bits,
ByteOrder  byteOrder = LittleEndian 
)
static

Find audio format by number of bits and byte order. Returns Qmmp::UNKNOWN if format is not found.

Parameters
bitsNumber of used bits in the sample (precision).
byteOrderByte order.

◆ format()

Qmmp::AudioFormat format ( ) const

Returns pcm format.

◆ frameSize()

int frameSize ( ) const

Returns the number of bytes required to represent one frame (a sample in each channel) in this format.

◆ operator!=()

bool operator!= ( const AudioParameters p) const

Returns true if parameters p is not equal to this parameters; otherwise returns false.

◆ operator=()

AudioParameters& operator= ( const AudioParameters p)

Assigns audio parameters p to this parameters.

◆ operator==()

bool operator== ( const AudioParameters p) const

Returns true if parameters p is equal to this parameters; otherwise returns false.

◆ sampleRate()

quint32 sampleRate ( ) const

Returns sample rate in Hz.

◆ sampleSize() [1/2]

int sampleSize ( ) const

Returns sample size in bytes.

◆ sampleSize() [2/2]

static int sampleSize ( Qmmp::AudioFormat  format)
static

Returns sample size in bytes of the given pcm data format.

◆ toString()

const QString toString ( ) const

Returns string represention of the audio parameters. May be useful for debug purposes.

◆ validBitsPerSample() [1/2]

int validBitsPerSample ( ) const

Returns the number of used bits in the sample. The value shoud be less or equal to the value returned by bitsPerSample().

◆ validBitsPerSample() [2/2]

static int validBitsPerSample ( Qmmp::AudioFormat  format)
static

Returns the number of used bits in the sample of the given pcm data format.


The documentation for this class was generated from the following file: