CJPEGImageFrameDecoderPlugin Class Reference

#include <iclexifimageframe.h>

Link against: jpegimageframeplugin.lib

class CJPEGImageFrameDecoderPlugin : public CJPEGExifDecoderPlugin

Inherits from

CJPEGImageFrameDecoderPlugin
- CJPEGExifDecoderPlugin
  - CImageDecoderPlugin
    - CBase

Public Member Functions
	~CJPEGImageFrameDecoderPlugin()
IMPORT_C CImageFrame &	DstImageFrame()
IMPORT_C TUid	FormatCode()
IMPORT_C TInt	FrameNumber()
TInt	RecommendedBufferSize()
void	SetConvertParameters(CImageFrame &, TInt)
void	SetFormatCode(TUid)
IMPORT_C void	SetRecommendedBufferSize(TInt)

Protected Member Functions
	CJPEGImageFrameDecoderPlugin()

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()
	CImageDecoderPlugin::AmInThread()const
	CImageDecoderPlugin::AppendImageData(const TImageDataBlock *)
	CImageDecoderPlugin::AppendImageDataBuffer(const HBufC8 *)
	CImageDecoderPlugin::CImageDecoderPlugin()
	CImageDecoderPlugin::Cleanup()
	CImageDecoderPlugin::DataLength()const
	CImageDecoderPlugin::DecoderOptions()const
	CImageDecoderPlugin::Destination()const
	CImageDecoderPlugin::DestinationMask()const
	CImageDecoderPlugin::DoConvert()
	CImageDecoderPlugin::FrameBlockSize(TInt)const
	CImageDecoderPlugin::FrameCommentL(TInt,TInt)const
	CImageDecoderPlugin::FrameData(TInt)const
	CImageDecoderPlugin::FrameHeaderBlockSize(TInt)const
	CImageDecoderPlugin::FrameInfo(TInt)const
	CImageDecoderPlugin::FrameInfoStringsL(RFs &,TInt)
	CImageDecoderPlugin::GetDestinationSize(TSize &,TInt)
	CImageDecoderPlugin::GetExtensionL(TUid,MImageConvExtension *&)
	CImageDecoderPlugin::HandleCustomSyncL(TInt)
	CImageDecoderPlugin::HandleProcessFrameResult(TInt,TFrameState)
	CImageDecoderPlugin::ImageCommentL(TInt)const
	CImageDecoderPlugin::ImageData(TInt)const
	CImageDecoderPlugin::ImageDataCount()const
	CImageDecoderPlugin::ImageInfo()const
	CImageDecoderPlugin::ImageReadCodec()const
	CImageDecoderPlugin::ImageType(TInt,TUid &,TUid &)const
	CImageDecoderPlugin::InitConvertL()
	CImageDecoderPlugin::InitCustomAsyncL(TInt)
	CImageDecoderPlugin::InsertImageData(const TImageDataBlock *,TInt)
	CImageDecoderPlugin::IsImageHeaderProcessingComplete()const
	CImageDecoderPlugin::NotifyComplete()
	CImageDecoderPlugin::NumberOfFrameComments(TInt)const
	CImageDecoderPlugin::NumberOfFrames()const
	CImageDecoderPlugin::NumberOfImageComments()const
	CImageDecoderPlugin::OpenExtraResourceFileLC(RFs &,const TUid,RResourceFile &)const
	CImageDecoderPlugin::Position()const
	CImageDecoderPlugin::PrepareForProcessFrameL()
	CImageDecoderPlugin::ReadDataL(TInt,TPtrC8 &,TInt)
	CImageDecoderPlugin::ReadFrameHeadersL()
	CImageDecoderPlugin::RemoveImageData(TInt)
	CImageDecoderPlugin::RequestComplete(TInt)
	CImageDecoderPlugin::RequestInitL(TInt)
	CImageDecoderPlugin::ScanDataL()
	CImageDecoderPlugin::SelfComplete(TInt)
	CImageDecoderPlugin::SetClippingRectL(const TRect *)
	CImageDecoderPlugin::SetDataLength(TInt)
	CImageDecoderPlugin::SetImageInfo(const TFrameInfo &)
	CImageDecoderPlugin::SetImageReadCodec(CImageReadCodec *)
	CImageDecoderPlugin::SetPosition(const TInt)
	CImageDecoderPlugin::SetSelfPending()
	CImageDecoderPlugin::SetStartPosition(TInt)
	CImageDecoderPlugin::SetThumbnailData(HBufC8 *)
	CImageDecoderPlugin::ShouldAbort()const
	CImageDecoderPlugin::SourceData()
	CImageDecoderPlugin::SourceLength()const
	CImageDecoderPlugin::StartPosition()const
	CImageDecoderPlugin::ValidDestination()const
	CImageDecoderPlugin::ValidDestinationMask()const
	CImageDecoderPlugin::~CImageDecoderPlugin()
	CJPEGExifDecoderPlugin::ExifMetadata()

Detailed Description

This is the plugin API for Image Converter Library decoder plugins relating to CImageFrames.

It is an extension of the ICL EXIF decoder plugin which provides a container for specific data required to decode a JPEG file or descriptor to a destination of type CImageFrame.

Constructor & Destructor Documentation

CJPEGImageFrameDecoderPlugin ( )

IMPORT_C

CJPEGImageFrameDecoderPlugin

(

)

[protected]

Constructor for the CJPEGImageFrameDecoderPlugin class.

~CJPEGImageFrameDecoderPlugin ( )

IMPORT_C

~CJPEGImageFrameDecoderPlugin

(

)

Destructor for the CJPEGImageFrameDecoderPlugin class.

Member Function Documentation

DstImageFrame ( )

IMPORT_C CImageFrame &

DstImageFrame

(

)

Returns the destination CImageFrame stored in this plugin extension.

Return Value: A reference to the destination CImageFrame.

FormatCode ( )

IMPORT_C TUid

FormatCode

(

)

const

Returns a format code stored in this plugin extension. This format code can be used to calculate the recommended buffer size needed to decode the image and it may not be the format code finally used for decoding.

FrameNumber ( )

IMPORT_C TInt

FrameNumber

(

)

const

Returns the frame number (in a multi-frame image to be decoded) stored in this plugin extension.

Return Value: A frame number.

RecommendedBufferSize ( )

TInt

RecommendedBufferSize

(

)

Returns the recommended buffer size stored in the CImageFrame decoder plugin extension.

SetConvertParameters ( CImageFrame &, TInt )

void	SetConvertParameters	(	CImageFrame &	aDestFrame,
			TInt	aFrameNumber
		)

Sets the destination CImageFrame and the Frame Number in the CImageFrame decoder plugin extension

SetFormatCode ( TUid )

void

SetFormatCode

(

TUid

aFormatCode

)

Sets the format code in the CImageFrame decoder plugin extension

SetRecommendedBufferSize ( TInt )

IMPORT_C void

SetRecommendedBufferSize

(

TInt

aBufferSize

)

Stores in this plugin extension the recommended buffer size to use when decoding the image contained in a file or descriptor.

Parameters
aBufferSize	The recommended buffer size to use, in bytes.