WAVE_PCM_EssenceSubParser::ESP_EssenceSource Class Reference

Class for EssenceSource objects for parsing/sourcing MPEG-VES essence. More...

#include <esp_wavepcm.h>

Inheritance diagram for WAVE_PCM_EssenceSubParser::ESP_EssenceSource:

EssenceSubParser::ESP_EssenceSource EssenceSource RefCount IRefCount List of all members.

Public Member Functions

 ESP_EssenceSource (EssenceSubParserPtr TheCaller, FileHandle InFile, UInt32 UseStream, UInt64 Count=1)
 Construct and initialise for essence parsing/sourcing.
virtual size_t GetEssenceDataSize (void)
 Get the size of the essence data in bytes.
virtual DataChunkPtr GetEssenceData (size_t Size=0, size_t MaxSize=0)
 Get the next "installment" of essence data.
virtual bool EndOfItem (void)
 Did the last call to GetEssenceData() return the end of a wrapping item.
virtual int GetBERSize (void)
 Get the preferred BER length size for essence KLVs written from this source, 0 for auto.

Protected Attributes

size_t BytesRemaining
 The number of bytes remaining in a multi-part GetEssenceData, or zero if not part read.

Detailed Description

Class for EssenceSource objects for parsing/sourcing MPEG-VES essence.


Constructor & Destructor Documentation

ESP_EssenceSource ( EssenceSubParserPtr  TheCaller,
FileHandle  InFile,
UInt32  UseStream,
UInt64  Count = 1 
) [inline]

Construct and initialise for essence parsing/sourcing.

Reimplemented from EssenceSubParser::ESP_EssenceSource.


Member Function Documentation

virtual size_t GetEssenceDataSize ( void   )  [inline, virtual]

Get the size of the essence data in bytes.

Note:
There is intentionally no support for an "unknown" response

Implements EssenceSource.

DataChunkPtr GetEssenceData ( size_t  Size = 0,
size_t  MaxSize = 0 
) [virtual]

Get the next "installment" of essence data.

Returns:
Pointer to a data chunk holding the next data or a NULL pointer when no more remains
Note:
If there is more data to come but it is not currently available the return value will be a pointer to an empty data chunk

If Size = 0 the object will decide the size of the chunk to return

On no account will the returned chunk be larger than MaxSize (if MaxSize > 0)

Reimplemented from EssenceSubParser::ESP_EssenceSource.

virtual bool EndOfItem ( void   )  [inline, virtual]

Did the last call to GetEssenceData() return the end of a wrapping item.

Returns:
true if the last call to GetEssenceData() returned an entire wrapping unit.

true if the last call to GetEssenceData() returned the last chunk of a wrapping unit.

true if the last call to GetEssenceData() returned the end of a clip-wrapped clip.

false if there is more data pending for the current wrapping unit.

false if the source is to be clip-wrapped and there is more data pending for the clip

Reimplemented from EssenceSubParser::ESP_EssenceSource.

virtual int GetBERSize ( void   )  [inline, virtual]

Get the preferred BER length size for essence KLVs written from this source, 0 for auto.

Reimplemented from EssenceSource.


Member Data Documentation

size_t BytesRemaining [protected]

The number of bytes remaining in a multi-part GetEssenceData, or zero if not part read.


The documentation for this class was generated from the following files:
Generated on Mon Apr 2 15:20:58 2007 for MXFLib by  doxygen 1.5.1-p1