#include <AUD_LimiterReader.h>

Inheritance diagram for AUD_LimiterReader:

Public Member Functions
	AUD_LimiterReader (AUD_IReader *reader, float start=0, float end=-1)
virtual void	seek (int position)
virtual int	getLength () const
virtual int	getPosition () const
virtual void	read (int &length, sample_t *&buffer)

Detailed Description

This reader limits another reader in start and end sample.

Definition at line 40 of file AUD_LimiterReader.h.

Constructor & Destructor Documentation

AUD_LimiterReader::AUD_LimiterReader	(	AUD_IReader *	reader,
		float	start = `0`,
		float	end = `-1`
	)

Creates a new limiter reader.

Parameters:

reader	The reader to read from.
start	The desired start sample (inclusive).
end	The desired end sample (exklusive), a negative value signals that it should play to the end.

Definition at line 37 of file AUD_LimiterReader.cpp.

References AUD_DEFAULT_BUFFER_SIZE, AUD_IReader::isSeekable(), length(), AUD_EffectReader::m_reader, AUD_IReader::read(), and AUD_IReader::seek().

Member Function Documentation

int AUD_LimiterReader::getLength ( ) const [virtual]

Returns an approximated length of the source in samples. For readers of the type buffer this has to return a correct value!

Returns:: The length as sample count. May be negative if unknown.

See also:: getType

Reimplemented from AUD_EffectReader.

Definition at line 69 of file AUD_LimiterReader.cpp.

References AUD_IReader::getLength(), and AUD_EffectReader::m_reader.

int AUD_LimiterReader::getPosition ( ) const [virtual]

Returns the position of the source as a sample count value.

Returns:: The current position in the source. A negative value indicates that the position is unknown.

Warning:: The value returned doesn't always have to be correct for readers of the stream type, especially after seeking, it must though for the buffer ones.

See also:: getType

Reimplemented from AUD_EffectReader.

Definition at line 77 of file AUD_LimiterReader.cpp.

References AUD_MIN, AUD_IReader::getPosition(), and AUD_EffectReader::m_reader.

void AUD_LimiterReader::read	(	int &	length,
		sample_t *&	buffer
	)		`[virtual]`

Request to read the next length samples out of the source. The buffer for reading has to stay valid until the next call of this method or until the reader is deleted.

Parameters:

[in,out]	length	The count of samples that should be read. Shall contain the real count of samples after reading, in case there were only fewer samples available. A smaller value also indicates the end of the reader.
[out]	buffer	The pointer to the buffer with the samples.

Reimplemented from AUD_EffectReader.

Definition at line 83 of file AUD_LimiterReader.cpp.

References AUD_IReader::getPosition(), AUD_EffectReader::m_reader, and AUD_IReader::read().

void AUD_LimiterReader::seek ( int position ) [virtual]

Seeks to a specific position in the source. This function must work for buffer type readers.

Parameters:

position The position to seek for measured in samples. To get from a given time to the samples you simply have to multiply the time value in seconds with the sample rate of the reader.

Warning:: This may work or not, depending on the actual reader.

See also:: getType

Reimplemented from AUD_EffectReader.

Definition at line 64 of file AUD_LimiterReader.cpp.

References AUD_EffectReader::m_reader, and AUD_IReader::seek().

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation