CImageEncoderPlugin Class Reference

class CImageEncoderPlugin : public CBase

The plugin API for Image Converter Library encoder plugins.

Intended for use by plugin writers only.

Inherits from

Public Member Functions
~CImageEncoderPlugin()
IMPORT_C voidGetExtensionL(TUid, MImageConvExtension *&)
Protected Member Functions
CImageEncoderPlugin()
IMPORT_C TBoolAmInThread()
IMPORT_C voidCleanup()
IMPORT_C TIntCurrentImageSizeL()
IMPORT_C TBufPtr8 &DestinationData()
IMPORT_C voidDoConvert()
IMPORT_C CImageEncoder::TOptionsEncoderOptions()
IMPORT_C voidFinishConvertL()
IMPORT_C const TSize &FrameInfoOverallSizeInPixels()
IMPORT_C voidHandleCustomSyncL(TInt)
IMPORT_C voidHandleProcessFrameResult(TInt, TFrameState)
IMPORT_C CImageWriteCodec *ImageWriteCodec()
IMPORT_C voidInitConvertL()
IMPORT_C voidInitCustomAsyncL(TInt)
IMPORT_C voidNotifyComplete()
IMPORT_C TInt &Position()
voidPrepareEncoderL(const CFrameImageData *)
IMPORT_C voidRequestComplete(TInt)
IMPORT_C voidRequestInitL()
IMPORT_C voidSelfComplete(TInt)
IMPORT_C voidSetImageWriteCodec(CImageWriteCodec *)
IMPORT_C voidSetSelfPending()
IMPORT_C TBoolShouldAbort()
IMPORT_C const CFbsBitmap &Source()
IMPORT_C TInt &StartPosition()
voidUpdateHeaderL()
IMPORT_C TBoolValidSource()
IMPORT_C voidWriteDataL(TInt, const TDesC8 &)
IMPORT_C voidWriteDataPositionIncL(TInt, const TDesC8 &)
Private Member Functions
IMPORT_C voidReservedVirtual1()
IMPORT_C voidReservedVirtual2()
IMPORT_C voidReservedVirtual3()
IMPORT_C voidSetThumbnail(TBool)
TBool ValidProperties()
IMPORT_C voidWriteExifDataL(TRequestStatus *&)
IMPORT_C voidWriteThumbnailL()
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
Private Attributes
CImageEncoderPriv *iProperties

Constructor & Destructor Documentation

CImageEncoderPlugin()

IMPORT_CCImageEncoderPlugin()[protected]

~CImageEncoderPlugin()

IMPORT_C~CImageEncoderPlugin()

Member Functions Documentation

AmInThread()

IMPORT_C TBoolAmInThread()const [protected]

Cleanup()

IMPORT_C voidCleanup()[protected, virtual]

CurrentImageSizeL()

IMPORT_C TIntCurrentImageSizeL()const [protected]

DestinationData()

IMPORT_C TBufPtr8 &DestinationData()[protected]

DoConvert()

IMPORT_C voidDoConvert()[protected, virtual]

EncoderOptions()

IMPORT_C CImageEncoder::TOptionsEncoderOptions()const [protected]

FinishConvertL()

IMPORT_C voidFinishConvertL()[protected]

FrameInfoOverallSizeInPixels()

IMPORT_C const TSize &FrameInfoOverallSizeInPixels()const [protected]

GetExtensionL(TUid, MImageConvExtension *&)

IMPORT_C voidGetExtensionL(TUidaExtUid,
MImageConvExtension *&aExtPtr
)[virtual]

Called by the framework to obtain a pointer to a codec implemented extension.

icl_uids.hrh .

Parameters

TUid aExtUidExtension UID normally prefixed KUidImageConv.
MImageConvExtension *& aExtPtr

HandleCustomSyncL(TInt)

IMPORT_C voidHandleCustomSyncL(TIntaParam)[protected, virtual]

Parameters

TInt aParam

HandleProcessFrameResult(TInt, TFrameState)

IMPORT_C voidHandleProcessFrameResult(TIntaErrCode,
TFrameStateaCodecState
)[protected]

Parameters

TInt aErrCode
TFrameState aCodecState

ImageWriteCodec()

IMPORT_C CImageWriteCodec *ImageWriteCodec()const [protected]

InitConvertL()

IMPORT_C voidInitConvertL()[protected, virtual]

InitCustomAsyncL(TInt)

IMPORT_C voidInitCustomAsyncL(TIntaParam)[protected, virtual]

Parameters

TInt aParam

NotifyComplete()

IMPORT_C voidNotifyComplete()[protected, virtual]

Position()

IMPORT_C TInt &Position()const [protected]

PrepareEncoderL(const CFrameImageData *)

voidPrepareEncoderL(const CFrameImageData *aFrameImageData)[protected, pure virtual]

Allocates the specific codec used for the encoding and passes ownership to the plugin.

This is a pure virtual function that each individual plugin must implement.

An error code indicating if the function call was successful. KErrNone on success, otherwise another of the system-wide error codes.

Parameters

const CFrameImageData * aFrameImageDataThe parameters which can be passed on to the encoding algorithm. This data might be used to determine the exact codec created.

RequestComplete(TInt)

IMPORT_C voidRequestComplete(TIntaReason)[protected]

Parameters

TInt aReason

RequestInitL()

IMPORT_C voidRequestInitL()[protected]

ReservedVirtual1()

IMPORT_C voidReservedVirtual1()[private, virtual]

ReservedVirtual2()

IMPORT_C voidReservedVirtual2()[private, virtual]

ReservedVirtual3()

IMPORT_C voidReservedVirtual3()[private, virtual]

SelfComplete(TInt)

IMPORT_C voidSelfComplete(TIntaReason)[protected]

Parameters

TInt aReason

SetImageWriteCodec(CImageWriteCodec *)

IMPORT_C voidSetImageWriteCodec(CImageWriteCodec *aImageWriteCodec)const [protected]

Parameters

CImageWriteCodec * aImageWriteCodec

SetSelfPending()

IMPORT_C voidSetSelfPending()[protected]

SetThumbnail(TBool)

IMPORT_C voidSetThumbnail(TBoolaDoGenerateThumbnail)[private, virtual]

Parameters

TBool aDoGenerateThumbnail

ShouldAbort()

IMPORT_C TBoolShouldAbort()const [protected]

Source()

IMPORT_C const CFbsBitmap &Source()const [protected]

StartPosition()

IMPORT_C TInt &StartPosition()const [protected]

UpdateHeaderL()

voidUpdateHeaderL()[protected, pure virtual]

May be used to fill in additional fields at the end of the encoding process, which it may not have been possible to do earlier.

This is a pure virtual function that each individual plugin must implement.

ValidProperties()

TBool ValidProperties()const [private]

ValidSource()

IMPORT_C TBoolValidSource()const [protected]

WriteDataL(TInt, const TDesC8 &)

IMPORT_C voidWriteDataL(TIntaPosition,
const TDesC8 &aDes
)[protected]

Parameters

TInt aPosition
const TDesC8 & aDes

WriteDataPositionIncL(TInt, const TDesC8 &)

IMPORT_C voidWriteDataPositionIncL(TIntaPosition,
const TDesC8 &aDes
)[protected]

Parameters

TInt aPosition
const TDesC8 & aDes

WriteExifDataL(TRequestStatus *&)

IMPORT_C voidWriteExifDataL(TRequestStatus *&aScaleCompletionStatus)[private, virtual]

Originally only used by the jpeg codec, but now in use as a generic pre-convert async step

Parameters

TRequestStatus *& aScaleCompletionStatus

WriteThumbnailL()

IMPORT_C voidWriteThumbnailL()[private, virtual]

Member Data Documentation

CImageEncoderPriv * iProperties

CImageEncoderPriv *iProperties[private]
© Nokia 2010.