Blender  V2.59
Public Member Functions
AUD_ChannelMapperReader Class Reference

#include <AUD_ChannelMapperReader.h>

Inheritance diagram for AUD_ChannelMapperReader:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 AUD_ChannelMapperReader (AUD_IReader *reader, float **mapping)
 ~AUD_ChannelMapperReader ()
virtual AUD_Specs getSpecs () const
virtual void read (int &length, sample_t *&buffer)

Detailed Description

This class maps a sound source's channels to a specific output channel count.

Note:
The input sample format must be float.

Definition at line 42 of file AUD_ChannelMapperReader.h.


Constructor & Destructor Documentation

AUD_ChannelMapperReader::AUD_ChannelMapperReader ( AUD_IReader reader,
float **  mapping 
)

Creates a channel mapper reader.

Parameters:
readerThe reader to map.
mappingThe mapping specification as two dimensional float array.

Definition at line 34 of file AUD_ChannelMapperReader.cpp.

References AUD_Specs::channels, AUD_IReader::getSpecs(), i, and sum().

AUD_ChannelMapperReader::~AUD_ChannelMapperReader ( )

Destroys the reader.

Definition at line 62 of file AUD_ChannelMapperReader.cpp.

References AUD_Specs::channels.


Member Function Documentation

AUD_Specs AUD_ChannelMapperReader::getSpecs ( ) const [virtual]

Returns the specification of the reader.

Returns:
The AUD_Specs structure.

Reimplemented from AUD_EffectReader.

Definition at line 74 of file AUD_ChannelMapperReader.cpp.

void AUD_ChannelMapperReader::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]lengthThe 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]bufferThe pointer to the buffer with the samples.

Reimplemented from AUD_EffectReader.

Definition at line 79 of file AUD_ChannelMapperReader.cpp.

References AUD_SAMPLE_SIZE, AUD_Specs::channels, AUD_Buffer::getBuffer(), AUD_Buffer::getSize(), i, length(), AUD_EffectReader::m_reader, AUD_IReader::read(), AUD_Buffer::resize(), and sum().


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