os::MediaDecoderStage Class Reference
[The Syllable Media API]

Media decoder stage. More...

Inheritance diagram for os::MediaDecoderStage:

List of all members.

Public Member Functions
	MediaDecoderStage ()
	~MediaDecoderStage ()
uint32	GetPhysicalType ()
	Physical type.
String	GetIdentifier ()
	Identifier.
uint32	GetInputCount ()
	Number of inputs.
uint32	GetInputFormatCount (uint32 nInput)
	Number of input formats.
MediaFormat_s	GetInputFormat (uint32 nInput, uint32 nNum)
	Input format.
uint32	GetOutputCount ()
	Number of outputs.
uint32	GetOutputFormatCount (uint32 nOutput)
MediaFormat_s	GetOutputFormat (uint32 nOutput)
	Output format.
status_t	Initialize ()
	Initializes the stage.
bool	HasInternalBuffer ()
	Internal buffer.
status_t	GetPacket (uint32 nOutput, MediaPacket_s *psPacket)
	Read one packet.
void	SetCodec (MediaCodec *pcCodec)
	Assigns a media codec object to the stage.
Static Public Member Functions
static MediaDecoderStage *	CreateStage ()
	Creates a decoder stage object.

---

Detailed Description

Description:

This media stage object represents a decoder.

Author:

Arno Klenke

---

Constructor & Destructor Documentation

MediaDecoderStage::MediaDecoderStage

(

)

MediaDecoderStage::~MediaDecoderStage

(

)

---

Member Function Documentation

uint32 MediaDecoderStage::GetPhysicalType

(

)

[virtual]

Description:

Returns the physical of the stage.

Author:

Arno Klenke

Reimplemented from os::MediaStage.

String MediaDecoderStage::GetIdentifier

(

)

[virtual]

Description:

Returns the identifier of the object.

Author:

Arno Klenke

Reimplemented from os::MediaStage.

uint32 MediaDecoderStage::GetInputCount

(

)

[virtual]

Description:

Returns the number of inputs.

Author:

Arno Klenke

Reimplemented from os::MediaStage.

uint32 MediaDecoderStage::GetInputFormatCount

(

uint32

nInput

)

[virtual]

Description:

Returns the number of formats of one input.

Parameters:

nInput

- The input.

Author:

Arno Klenke

Reimplemented from os::MediaStage.

MediaFormat_s MediaDecoderStage::GetInputFormat	(	uint32	nInput,
		uint32	nNum
	)			[virtual]

Description:

Returns one input format.

Parameters:

	nInput	- The input.
	nNum	- Input format number.

Author:

Arno Klenke

Reimplemented from os::MediaStage.

uint32 MediaDecoderStage::GetOutputCount

(

)

[virtual]

Description:

Returns the number of outputs.

Author:

Arno Klenke

Reimplemented from os::MediaStage.

uint32 os::MediaDecoderStage::GetOutputFormatCount

(

uint32

nOutput

)

MediaFormat_s MediaDecoderStage::GetOutputFormat

(

uint32

nOutput

)

[virtual]

Description:

Returns the format of one output.

Parameters:

nOutput

- The output.

Author:

Arno Klenke

Reimplemented from os::MediaStage.

status_t MediaDecoderStage::Initialize

(

)

[virtual]

Description:

This method has to be called for every stage object after you have connected all the stages.

Author:

Arno Klenke

Reimplemented from os::MediaStage.

bool MediaDecoderStage::HasInternalBuffer

(

)

[virtual]

Description:

Return whether the data pointer of the packets read with GetPacket() point to internal memory of the stage object.

Author:

Arno Klenke

Reimplemented from os::MediaStage.

status_t MediaDecoderStage::GetPacket	(	uint32	nOutput,
		MediaPacket_s *	psPacket
	)			[virtual]

Description:

Reads one packet from the stage. The stage object will read data from the previous stages if necessary. You normally do not have to call this method directly because the MediaSyncStage takes care of this.

Parameters:

	nOutput	- The output.
	psPacket	- Pointer to a packet.

Author:

Arno Klenke

Reimplemented from os::MediaStage.

void MediaDecoderStage::SetCodec

(

MediaCodec *

pcCodec

)

Description:

Assigns a media codec object to the stage.

Note:

The reference counter of the object is increased.

Parameters:

pcCodec

- The object.

Author:

Arno Klenke

MediaDecoderStage * MediaDecoderStage::CreateStage

(

)

[static]

Description:

Creates a decoder stage object. The object will choose the right codec to convert the data between the input and the output.

Author:

Arno Klenke

---