AFCore Class Reference

Core class for AF, acting as a glue between the CPU and the codec. More...

#include <AFCore.h>

Inheritance diagram for AFCore:
AFUncopyable

List of all members.

Public Member Functions

 AFCore ()
 Constructor for AFCore.
virtual BOOL AttachCPU (AFCPU *inCPU)
 Attaches the given CPU to the core.
virtual BOOL AttachCodec (AFCodec *inCodec)
 Attaches the given codec to the core.
virtual BOOL AttachBoard (AFBoard *inBoard)
 Attaches the given board to the core.
virtual BOOL InitI2SBus ()
 Initializes I2S bus both on CPU and on codec.
virtual AFCodecGetCodec ()
 Returns pointer to the codec attached.
virtual AFCPUGetCPU ()
 Returns pointer to the CPU attached.
virtual AFBoardGetBoard ()
 Returns pointer to the board attached.
virtual ~AFCore ()
 Empty destructor for AFCore.

Protected Attributes

AFCPUcpu
AFCodeccodec
AFBoardboard

Detailed Description

Core class for AF, acting as a glue between the CPU and the codec.

The purpose of AFCore class is to glue together CPU and codec, i.e. to take care of all driver configuration details that neither CPU nor the codec would be able to decide about on their own. AFCore does not contain any hardware specific implementation details.

Definition at line 64 of file AFCore.h.


Constructor & Destructor Documentation

AFCore::AFCore (  )  [inline]

Constructor for AFCore.

Empty constructor resetting links to a CPU and a codec.

Definition at line 76 of file AFCore.h.

virtual AFCore::~AFCore (  )  [inline, virtual]

Empty destructor for AFCore.

Destructor: ~AFCore

Definition at line 185 of file AFCore.h.


Member Function Documentation

BOOL AFCore::AttachBoard ( AFBoard inBoard  )  [virtual]

Attaches the given board to the core.

Parameters:
inBoard A pointer to the board (AFBoard type).
Return values:
TRUE Board attach succeeded.
FALSE Board attach failed.

Definition at line 70 of file AFCore.cpp.

BOOL AFCore::AttachCodec ( AFCodec inCodec  )  [virtual]

Attaches the given codec to the core.

Parameters:
inCodec A pointer to the codec (AFCodec type).
Return values:
TRUE Codec attach succeeded.
FALSE Codec attach failed.

Definition at line 54 of file AFCore.cpp.

BOOL AFCore::AttachCPU ( AFCPU inCPU  )  [virtual]

Attaches the given CPU to the core.

Parameters:
inCPU A pointer to the CPU (AFCPU type).
Return values:
TRUE CPU attach succeeded.
FALSE CPU attach failed.

Definition at line 38 of file AFCore.cpp.

virtual AFBoard* AFCore::GetBoard (  )  [inline, virtual]

Returns pointer to the board attached.

Returns:
Pointer to the board attached.

Definition at line 173 of file AFCore.h.

virtual AFCodec* AFCore::GetCodec (  )  [inline, virtual]

Returns pointer to the codec attached.

Returns:
Pointer to the codec attached.

Definition at line 145 of file AFCore.h.

virtual AFCPU* AFCore::GetCPU (  )  [inline, virtual]

Returns pointer to the CPU attached.

Returns:
Pointer to the CPU attached.

Definition at line 159 of file AFCore.h.

BOOL AFCore::InitI2SBus (  )  [virtual]

Initializes I2S bus both on CPU and on codec.

This method finds the highest sample rate that both CPU and codec support (as given by their respective I2SBusCaps) and calls AFCPU::InitI2SBus and AFCodec::InitI2SBus with the aforementioned capability as a parameter.

Return values:
TRUE I2S bus initialization succeeded.
FALSE I2S bus initialization failed (GetLastError for more details).

Definition at line 86 of file AFCore.cpp.


Member Data Documentation

AFBoard* AFCore::board [protected]

Definition at line 189 of file AFCore.h.

AFCodec* AFCore::codec [protected]

Definition at line 188 of file AFCore.h.

AFCPU* AFCore::cpu [protected]

Definition at line 187 of file AFCore.h.


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

Generated on Sun Sep 27 12:36:35 2009 for Audio Framework by  doxygen 1.6.1