TimeStretchPitchScaleReader Class Reference

This class reads from another reader and applies time-stretching and pitch scaling. More...

#include <TimeStretchPitchScaleReader.h>

Inheritance diagram for TimeStretchPitchScaleReader:

Public Member Functions
	TimeStretchPitchScaleReader (std::shared_ptr< IReader > reader, double timeRatio, double pitchScale, StretcherQuality quality, bool preserveFormant)
	Creates a new stretcher reader.
virtual void	read (int &length, bool &eos, sample_t *buffer)
	Request to read the next length samples out of the source.
virtual void	seek (int position)
	Seeks to a specific position in the source.
virtual int	getLength () const
	Returns an approximated length of the source in samples.
virtual int	getPosition () const
	Returns the position of the source as a sample count value.
double	getTimeRatio () const
	Retrieves the current time ratio for the stretcher.
void	setTimeRatio (double timeRatio)
	Sets the time ratio for the stretcher.
double	getPitchScale () const
	Retrieves the pitch scale for the stretcher.
void	setPitchScale (double pitchScale)
	Sets the pitch scale for the stretcher.
Public Member Functions inherited from EffectReader
	EffectReader (std::shared_ptr< IReader > reader)
	Creates a new effect reader.
virtual	~EffectReader ()
	Destroys the reader.
virtual bool	isSeekable () const
	Tells whether the source provides seeking functionality or not.
virtual Specs	getSpecs () const
	Returns the specification of the reader.
Public Member Functions inherited from IReader
virtual	~IReader ()
	Destroys the reader.

Protected Member Functions
void	reset ()
	Feeds the number of required zero samples to the stretcher and queries the amount of samples to drop.

Protected Attributes
std::unique_ptr< RubberBandStretcher >	m_stretcher
	Rubberband stretcher.
int	m_position
	The current position.
bool	m_finishedReader
	Whether the reader has reached the end of stream.
Protected Attributes inherited from EffectReader
std::shared_ptr< IReader >	m_reader
	The reader to read from.

Detailed Description

This class reads from another reader and applies time-stretching and pitch scaling.

Constructor & Destructor Documentation

TimeStretchPitchScaleReader()

TimeStretchPitchScaleReader::TimeStretchPitchScaleReader	(	std::shared_ptr< IReader >	reader,
		double	timeRatio,
		double	pitchScale,
		StretcherQuality	quality,
		bool	preserveFormant )

Creates a new stretcher reader.

Parameters

reader	The reader to read from.
timeRatio	The factor by which to stretch or compress time.
pitchScale	The factor by which to adjust the pitch.
quality	The processing quality level of the stretcher.
preserveFormant	Whether to preserve the vocal formants for the stretcher.

Member Function Documentation

getLength()

virtual int TimeStretchPitchScaleReader::getLength ( ) const

virtual

Returns an approximated length of the source in samples.

Returns

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

Reimplemented from EffectReader.

getPitchScale()

double TimeStretchPitchScaleReader::getPitchScale

(

)

const

Retrieves the pitch scale for the stretcher.

Returns

The current pitch scale value.

getPosition()

virtual int TimeStretchPitchScaleReader::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, especially after seeking.

Reimplemented from EffectReader.

getTimeRatio()

double TimeStretchPitchScaleReader::getTimeRatio

(

)

const

Retrieves the current time ratio for the stretcher.

Returns

The current time ratio value.

read()

virtual void TimeStretchPitchScaleReader::read ( int & length, bool & eos, sample_t * buffer )

virtual

Request to read the next length samples out of the source.

The buffer supplied has the needed size.

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]	eos	End of stream, whether the end is reached or not.
[in]	buffer	The pointer to the buffer to read into.

Reimplemented from EffectReader.

Reimplemented in AnimateableTimeStretchPitchScaleReader.

seek()

virtual void TimeStretchPitchScaleReader::seek ( int position )

virtual

Seeks to a specific position in the source.

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.

Reimplemented from EffectReader.

Reimplemented in AnimateableTimeStretchPitchScaleReader.

---

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

• fx/TimeStretchPitchScaleReader.h