Constructor for this class.

Destructor for this class.

If using a local file session, it closes it. It also informs ECom that has finished with the decoder instance.

Frees all resources owned by the object prior to its destruction.

Cancels any conversions currently in progress (Cancel is synchronous).

Continue decoding a frame and/or mask after new image data was added to the source file or descriptor and a previous call to Convert() or ContinueConvert() returned KErrUnderflow.

Continue processing image headers after new image data was added to the source file or descriptor.

IsImageHeaderProcessingComplete()

Start decoding an image frame asynchronously.

If the operations completes with KErrUnderflow, then there is insufficient information in the descriptor. In this situation, ContinueConvert() should be called repeatedly until the descriptor has accumulated enough information for ContinueConvert() to complete with KErrNone.It is the responsibility of the caller to ensure that the original data source used to create this decoder object gets enough information. If there is no data available then a caller can ignore this error code and use partially decoded image.

Start decoding an image frame and mask asynchronously.

If the operations completes with KErrUnderflow, then there is insufficient information in the descriptor. In this situation, ContinueConvert() should be called repeatedly until the descriptor has accumulated enough information for ContinueConvert() to complete with KErrNone.It is the responsibility of the caller to ensure that the original data source used to create this decoder object gets enough information. If there is no data available then a caller can ignore this error code and use partially decoded image.

TFrameInfo

Sets up background convert cycle, bypassing Convert() . A call to this will result in a call to the associated CImageDecoderPlugin::InitCustomAsyncL(aParam), which if successful will start background processing. This function uses the same mechanism as Convert() , and therefore cannot be used concurrently. Cancel() etc work as expected.

Note: This function is intended for use by plugin writers only.

Calls CImageDecoderPlugin::HandleCustomSyncL(aParam) that executes user defined plugin specific functions. Subsequent behaviour depends on the CImageDecoderPlugin class.

This function is part of the support for extended codecs for use within classes derived from CImageDecoder .

Note: This function is intended for use by plugin writers only.

CImageDecoderPlugin::HandleCustomSyncL()

Create a construct that can create a decoder and call functions to initialise the decoder with the image data.

Scan a sorted list of decoders for the first one that can decode the image.

Create a decoder for the image in the source buffer. The client supplies a MIME type which will be used to try and select an appropriate plugin decoder. If a decoder is found it is created and then used to scan the beginning of the image file.

Creates a decoder for the image in the source buffer.

If the client supplies an image type (and sub-type, if applicable) or decoder UID, these will be used to try and select an appropriate plugin decoder. If not, then the selection will be done by matching the image header from the buffer. If it finds a decoder, it is created and then used to scan the beginning of the image buffer.

Get the MIME type for a given match string.

Create a construct that can create a decoder and call functions to initialise the decoder with the image data.

Create a construct that can create a decoder and call functions to initialise the decoder with the image data.

Scans a sorted list of decoders for the first one that can decode the image.

Scans a sorted list of decoders for the first one that can decode the image.

Creates a decoder for the image in the named file. The client supplies a MIME type which will be used to try and select an appropriate plugin decoder. If it finds a decoder it creates it and then goes on to use that decoder to scan the beginning of the image file.

Creates a decoder for the image in the named file. If the client supplies an image type (and sub-type, if applicable) or decoder UID, these will be used to try and select an appropriate plugin decoder. If not, then the selection will be done by matching the image header in the file. If it finds a decoder it creates it and then goes on to use that decoder to scan the beginning of the image file.

Create a decoder for the image in the named file. The client supplies a MIME type which will be used to try and select an appropriate plugin decoder. If it finds a decoder it creates it and then goes on to use that decoder to scan the beginning of the image file.

If any file related errors are encountered opening the specified file, this function leaves with an appropriate file related leave code.

Create a decoder for the image in the named file.

If the client supplies an image type (and sub-type, if applicable) or decoder UID, these will be used to try and select an appropriate plugin decoder. If not, then the selection will be done by matching the image header in the file. If it finds a decoder, it will be created and then used to scan the beginning of the image file.

Note: Every image format has two IDs, known as the type and the sub-type (although generally the sub-type is KNullUid). To retrieve a list of supported types and sub-types that can be decoded, use the static functions GetImageTypesL() and GetImageSubTypesL() .

Create a decoder for the image in the named file. The client supplies a MIME type which will be used to try and select an appropriate plugin decoder. If it finds a decoder it creates it and then goes on to use that decoder to scan the beginning of the image file.

Creates a decoder for the image in the named file. If the client supplies an image type (and sub-type, if applicable) or decoder UID, these will be used to try and select an appropriate plugin decoder. If not, then the selection will be done by matching the image header in the file. If it finds a decoder it creates it and then goes on to use that decoder to scan the beginning of the image file.

Create a decoder for the image in the named file. The client supplies a MIME type which will be used to try and select an appropriate plugin decoder. If it finds a decoder it creates it and then goes on to use that decoder to scan the beginning of the image file.

If any file related errors are encountered opening the specified file, this function leaves with an appropriate file related leave code.

Creates a decoder for the image in the named file. If the client supplies an image type (and sub-type, if applicable) or decoder UID, these will be used to try and select an appropriate plugin decoder. If not, then the selection will be done by matching the image header in the file. If it finds a decoder it creates it and then goes on to use that decoder to scan the beginning of the image file.

Create a decoder for the image in the named file. The client supplies a MIME type which will be used to try and select an appropriate plugin decoder. If it finds a decoder it creates it and then goes on to use that decoder to scan the beginning of the image file.

Create a decoder for the image in the named source.

Return a particular comment attached to a given frame of the image.

The desired order of calling methods should be FrameCount() , NumberOfFrameComments() and then FrameCommentL() .

Use FrameCount() to retrieve the number of frames in the image to ensure that a valid aFrameNumber is used.

Use NumberOfFrameComments() to retrieve the number of comments attached to a given frame of the image (as opposed to the whole image),to ensure that a valid aCommentNumber is used.

Ownership of the returned buffer is transferred to the caller.

For further informantion on panic categories, please see the note in CImageDecoder::IsImageHeaderProcessingComplete() .

Return the number of frames in the image being decoded.

This function can be called immediately after the call to create the decoder, thus enabling the caller to know how many frames need to be converted. Client may have to call IsImageHeaderProcessingComplete() & ContinueProcessingHeaders() to ensure all all data is available.

Returns additional plugin specific information on a specified frame.

The plugin specific information usually covers advanced image features such as image quality, advanced colour settings and so on.

Use FrameCount() to determine how many frames are contained in the image before using this function.

Return the frame info for a specified frame of the image.

This function can be called immediately after the call to create the decoder, thus enabling the caller to know about each frame in advance of converting it.

The returned information contains details of the size of the image, the dimensions of the frame, its colour depth and so on. More advanced information may be available for the image using FrameData() .

Use FrameCount() to determine how many frames are contained in the image before using this function.

Return the formatted frame information strings for a specific frame. Ownership is transferred to the caller.

Return the formatted frame information strings for a specific frame and leave it on the cleanup stack.

Ownership is transferred to the caller.

Get the size of the decoded image for the given frame. The calculation will account for any clipping rectangle set, scaling applied through the TImageConvScaler extension and any operation applied through TImageConvOperation . If TImageConvScaler::SetScalingL (.. has been called then the size of the bitmap passed to CImageDecoder::Convert must match the size returned from this function.

Get a list of the file extensions that can be decoded and their corresponding MIME types, based on the currently available decoder plugins.

Ownership of the array is passed to the caller so, before the array goes out of scope in the client, the caller must call ResetAndDestroy() on it to free the entries.

For a given basic image type, get a list of the sub image types that can be decoded, based on the currently available decoder plugins.

Ownership of the array is passed to the caller so, before the array goes out of scope in the client, the caller must call ResetAndDestroy() on it to free the entries.

Get a list of the basic image types that can be decoded, based on the currently available decoder plugins.

Ownership of the array is passed to the caller so, before the array goes out of scope in the client, the caller must call ResetAndDestroy() on it to free the entries.

Gets the implementation information for a specific decoder plugin

Ownership of the implementation information is passed to the caller.

Gets a list of decoder implementations UIDs which have a set of specific capabilities defined by UIDs.

Gets a list of decoder implementations UIDs which have a set of specific capabilities defined by UIDs.

Get the primary MIME type of the decoder that will be used to decode a descriptor. Some file types (like OTA or WBPM), which do not have unique pattern in their header may not be recognised. Such files are not supported by this API

Get the primary MIME type of the decoder that will be used to decode a file. Some file types (like OTA or WBPM), which do not have unique pattern in their header may not be recognised, in case when the source file name doesn't have extension or, extension is not common to that file type. Such files are not supported by this API.

Gets a list of the properties of a specific decoder plugin.

Return a particular comment attached to the image.

Ownership of the returned buffer is transferred to the caller. Use NumberOfImageComments() to determine how many (if any) comments are contained within the image.

For further informantion on panic categories, please see the note in CImageDecoder::IsImageHeaderProcessingComplete() .

Retrieves the image type and sub-type for a given frame of the image that has just been decoded.

For further informantion on panic categories, please see the note in CImageDecoder::IsImageHeaderProcessingComplete() .

Create a list of decoders that support the specified image type.

KUidICLJpegEXIFInterface KUidICLJpegImageFrameInterface

Return the implementation UID of the decoder being used to decode the image.

Return the status of the image.

If the image is incomplete EFalse will be returned. The client should continue to supply more data and call ContinueProcessingHeaders() until ETrue is returned.

Panic categories: Many CImageDecoder functions are dependent upon this function returning ETrue before they can successfully be called. If the client calls one of these dependent functions, then that function call may panic with either the 'ImageConversion' panic category or a decoder plugin specific panic category, for example: 'BMPConvertPlugin', 'GIFConvertPlugin', 'ICOConvertPlugin', 'JPEGConvertPlugin', 'MBMConvertPlugin', 'OTAConvertPlugin', 'PNGConvertPlugin', 'TIFFConvertPlugin', 'WBMPConvertPlugin', 'WMFConvertPlugin'.

Create a list of decoders that support the specified MIME type.

Create a construct object for the specified decoder.

Called internally to create a CImageDecoder and associated iRelay body

This member is internal and not intended for use.

Actual factory function for CImageDecoder - ie. it creates the object Called back plugin - to allow plugin to override if required

This member is internal and not intended for use.

Return the number of comments attached to a given frame of the image (as opposed to the whole image).

Use FrameCount() to retrieve the number of frames in the image to ensure that a valid aFrameNumber is used.

For further informantion on panic categories, please see the note in CImageDecoder::IsImageHeaderProcessingComplete() .

Return the number of comments attached to the image (as opposed to a particular frame).

For further informantion on panic categories, please see the note in CImageDecoder::IsImageHeaderProcessingComplete() .

CImageDecoder::SetClippingRectL() TImageConvScaler TImageConvOperation

Returns associated CImageDecoderPlugin .

Allows the extended CImageDecoder object to talk to its CImageDecoderPlugin equivalent.

Note: This function is intendend for use by plugin writers only.

Optional call from client which may be made on the decoder to allow analysis of image prior to calling Convert.

Should be called once decode is fully set up e.g. clipping rectangle set.

CImageDecoder::Convert

Calculates reduced size of the decoded bitmap based on the input parameters and updates aReducedSize with this value.

Function to calculate the reduction factor based on the input parameters.

Intended for future proofing - will panic if called

Intended for future proofing - will panic if called

Intended for future proofing - will panic if called

Intended for future proofing - will panic if called

Sets the properties for the Image decoder.

Sets the area of interest of the image to be decoded. This function can leave with any of the system-wide error codes.

Set the decoder worker thread priority

TThreadPriority

Set the source image type, this can be any value from TImageType. It can leave with a system wide error. Typical leaves are documented below.

Creates a list of decoders that support the specified file extension.

Flags to control which image is decoded. This can be used when the source file or descriptor contains multiple distinct image sources.

Flags to control how the image is decoded. These can be combined using an OR operation.