Class CMdaImageUtility

Interface status:

deprecated

7.0s - Replaced by Image Conversion library - no direct equivalent

class CMdaImageUtility : public CActive, private MMdaObjectStateChangeObserver;

Description

Defines the public interface to image conversion.

This class has been deprecated in 7.0s, it's functionality is now part of the Image Converter Library. For more information see CImageEncoder and CImageDecoder.

Clients of the concrete conversion classes call the functions provided by this interface to perform the conversion. The implementation of these functions is provided either by the concrete conversion classes themselves or by private implementation classes.

Derivation

• MMdaObjectStateChangeObserver - ...

• CBase - Base class for all classes to be instantiated on the heap.

• CActive - The core class of the active object abstraction.

• CMdaImageUtility - Defines the public interface to image conversion.

Members

Defined in CMdaImageUtility:

• CancelConvertL()Cancels the conversion operation.
• Close()Closes the open file-based or descriptor-based image.
• ConvertL(CFbsBitmap &,CFbsBitmap &,TInt)Begins the image conversion operation for the specified frame overloaded functio...
• ConvertL(CFbsBitmap &,TInt)Begins the image conversion operation for the specified frame overloaded functio...
• DoCancel()Implements cancellation of an outstanding request.
• DoClose()
• FrameCount()constReturns the number of frames in the image, counting from the first frame in the ...
• FrameInfo(TInt,TFrameInfo &)constRetrieves information about the specified frame.
• ImageUtil_Reserved1()
• ImageUtil_Reserved2()
• ImageUtil_Reserved3()
• ImageUtil_Reserved4()
• MoscoStateChangeEvent(CBase *,TInt,TInt,TInt)
• ~CMdaImageUtility()

Inherited from CActive:

• CActive(TInt)Constructs the active object with the specified priority.
• Cancel()Cancels the wait for completion of an outstanding request.
• Deque()Removes the active object from the active scheduler's list of active objects.
• EPriorityHighA priority higher than EPriorityUserInput.
• EPriorityIdleA low priority, useful for active objects representing background processing.
• EPriorityLowA priority higher than EPriorityIdle but lower than EPriorityStandard.
• EPriorityStandardMost active objects will have this priority.
• EPriorityUserInputA priority higher than EPriorityStandard; useful for active objects handling use...
• Extension_(TUint,TAny *&,TAny *)Extension function
• IsActive()constDetermines whether the active object has a request outstanding.
• IsAdded()constDetermines whether the active object has been added to the active scheduler's li...
• Priority()constGets the priority of the active object.
• RunError(TInt)Handles a leave occurring in the request completion event handler CActive::RunL(...
• RunL()Handles an active object's request completion event.
• SetActive()Indicates that the active object has issued a request and that it is now outstan...
• SetPriority(TInt)Sets the priority of the active object.
• TPriorityDefines standard priorities for active objects.
• iStatusThe request status associated with an asynchronous request.

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

Interface status:

deprecated

Inherited from: CMdaImageUtility

virtual ~CMdaImageUtility();

Description

Interface status:

deprecated

Inherited from: CMdaImageUtility

IMPORT_C virtual void Close();

Description

Closes the open file-based or descriptor-based image.

Any conversion operation in progress is cancelled.

Interface status:

deprecated

Inherited from: CMdaImageUtility

virtual void ConvertL(CFbsBitmap &aBitmap, TInt aFrameNumber=0)=0;

Description

Begins the image conversion operation for the specified frame overloaded function.

The operation is asynchronous. When the conversion operation is complete, successfully or otherwise, the callback function MMdaImageUtilObserver::MiuoConvertComplete(TInt) is called.When converting from a file or descriptor to a bitmap, the operation can complete with KErrUnderflow, if there is insufficient information in the file or descriptor. Typically, this occurs when using the file or descriptor as a cache. In this situation, the conversion operation should be performed repeatedly until the file or descriptor has accumulated enough information for the operation to complete with KErrNone. As much of the image as is present is converted and written to the target bitmap at each call to this function.

Parameters

CFbsBitmap &aBitmap A reference to a bitmap. This may be a source or a target for the conversion process, depending on the concrete conversion class utility being used. TInt aFrameNumber The frame number. This value is relative to zero. For those concrete conversion classes which perform conversion from a bitmap, this value must always be zero. For those concrete conversion classes which perform conversion to a bitmap, this value must be less than the number of frames in the image.

Interface status:

deprecated

Inherited from: CMdaImageUtility

virtual void ConvertL(CFbsBitmap &aBitmap, CFbsBitmap &aMaskBitmap, TInt aFrameNumber=0)=0;

Description

Begins the image conversion operation for the specified frame overloaded function.

The operation is asynchronous. When the conversion operation is complete, successfully or otherwise, the callback function MMdaImageUtilObserver::MiuoConvertComplete(TInt) is called.When converting from a file or descriptor to a bitmap, the operation can complete with KErrUnderflow, if there is insufficient information in the file or descriptor. Typically, this occurs when using the file or descriptor as a cache. In this situation, the conversion operation should be performed repeatedly until the file or descriptor has accumulated enough information for the operation to complete with KErrNone. As much of the image as is present is converted and written to the target bitmap at each call to this function.

Parameters

CFbsBitmap &aBitmap A reference to a bitmap. This may be a source or a target for the conversion process, depending on the concrete conversion class utility being used. CFbsBitmap &aMaskBitmap A source or target mask bitmap, if present. TInt aFrameNumber The frame number. This value is relative to zero. For those concrete conversion classes which perform conversion from a bitmap, this value must always be zero. For those concrete conversion classes which perform conversion to a bitmap, this value must be less than the number of frames in the image.

See also:

• CMdaImageUtility::ConvertL(CFbsBitmap &,TInt)Begins the image conversion operation for the specified frame overloaded functio...
• CFbsBitmapNote that this class is not intended for user derivation. A bitmap managed by th...

Interface status:

deprecated

Inherited from: CMdaImageUtility

virtual void CancelConvertL()=0;

Description

Cancels the conversion operation.

The callback function MMdaImageUtilObserver::MiuoConvertComplete(TInt) is not called.

Interface status:

deprecated

Inherited from: CMdaImageUtility

IMPORT_C virtual void FrameInfo(TInt aFrame, TFrameInfo &aInfo) const;

Description

Retrieves information about the specified frame.

This function should only be called after an existing image has been successfully opened or a new image successfully created.

Parameters

TInt aFrame The frame number. This value is relative to zero. The value must be less than the total number of frames in the image, otherwise the function raises a USER 0 panic TFrameInfo &aInfo A reference to the frame information.

Interface status:

deprecated

Inherited from: CMdaImageUtility

IMPORT_C virtual TInt FrameCount() const;

Description

Returns the number of frames in the image, counting from the first frame in the image, to the next frame to be decoded.

Note: The image conversion utilities do not scan all the image data on calling OpenL(), just the header. Therefore, if, as in the case of an animated gif, there is no frame count in the header, then until all the frames in the image have been decoded, the total frame count is unknown. Initially therefore, CMdaImageUtility::FrameCount()const returns 1, but this increments as each frame is decoded, and the utility reads the next frame's header. Once the last frame has been decoded, all frames are available for access as the information about each frame is stored.

Return value

TInt The number of frames in the image

Interface status:

deprecated

Inherited from: CMdaImageUtility

virtual void ImageUtil_Reserved1();

Description

Interface status:

deprecated

Inherited from: CMdaImageUtility

virtual void ImageUtil_Reserved2();

Description

Interface status:

deprecated

Inherited from: CMdaImageUtility

virtual void ImageUtil_Reserved3();

Description

Interface status:

deprecated

Inherited from: CMdaImageUtility

virtual void ImageUtil_Reserved4();

Description

Interface status:

deprecated

Inherited from: CMdaImageUtility

protected: virtual void DoClose();

Description

Interface status:

deprecated

Inherited from: CMdaImageUtility

protected: virtual void MoscoStateChangeEvent(CBase *aObject, TInt aPreviousState, TInt aCurrentState, TInt aErrorCode);

Description

Parameters

CBase *aObject TInt aPreviousState TInt aCurrentState TInt aErrorCode

Interface status:

deprecated

Inherited from: CMdaImageUtility

protected: virtual void DoCancel();

Description

Implements cancellation of an outstanding request.

This function is called as part of the active object's CActive::Cancel().

It must call the appropriate cancel function offered by the active object's asynchronous service provider. The asynchronous service provider's cancel is expected to act immediately.

CMdaImageUtility::DoCancel() must not wait for event completion; this is handled by CActive::Cancel().

See also:

• CActive::Cancel()Cancels the wait for completion of an outstanding request.