AudioParameters Class Reference

#include <audioparameters.h>

List of all members.

Public Types
enum	ByteOrder { LittleEndian = 0, BigEndian }
Public Member Functions
	AudioParameters ()
	AudioParameters (quint32 srate, const ChannelMap &map, Qmmp::AudioFormat format)
	AudioParameters (const AudioParameters &other)
AudioParameters &	operator= (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 <forkotov02@ya.ru>

---

Member Enumeration Documentation

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

(

)

Constructor.

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

Constructs audio settings with the given parameters.

Parameters:

srate	Sampling rate.
map	Channel map.
format	PCM data format.

AudioParameters

(

const AudioParameters &

other

)

Constructs a copy of other.

---

Member Function Documentation

int bitsPerSample

(

)

const

Returns sample size in bits.

static int bitsPerSample

(

Qmmp::AudioFormat

format

)

[static]

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

ByteOrder byteOrder

(

)

const

Returns byte order for selected audio format.

const ChannelMap channelMap

(

)

const

Returns channel map.

int channels

(

)

const

Returns number of channels.

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:

bits	Number of used bits in the sample (precision).
byteOrder	Byte order.

Qmmp::AudioFormat format

(

)

const

Returns pcm format.

int frameSize

(

)

const

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

bool operator!=

(

const AudioParameters &

p

)

const

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

AudioParameters& operator=

(

const AudioParameters &

p

)

Assigns audio parameters p to this parameters.

bool operator==

(

const AudioParameters &

p

)

const

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

quint32 sampleRate

(

)

const

Returns sample rate in Hz.

int sampleSize

(

)

const

Returns sample size in bytes.

static int sampleSize

(

Qmmp::AudioFormat

format

)

[static]

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

const QString toString

(

)

const

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

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().

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:

• /usr/src/RPM/BUILD/qmmp-1.2.6/src/qmmp/audioparameters.h