CImageEncoderPlugin Class Reference

Constructor for this class.

Destructor for this class.

Indicates if this encoder is running in a separate thread.

Called when the plugin is destroyed or an encode is cancelled to perform cleanup functions.

This function may be overriden in derived classes in which case the derived class should ensure it calls this version after performing any plugin specific cleanup.

Returns the current size of the encoded image in bytes.

Returns the value to be fed to CImageWriteCodec::ProcessFrameL(), and will be used by codecs that fully override DoConvert().

Performs the encoding process.

This call may be overriden in derived classes. If this is not the case and a custom decode is not performed, the derived class should ensure that this base class's version is called.

Enables getting set of options which has been passed by client during encoder object creation. Plugins should ignore unknown options.

Notifies the framework that the main frame encoding is complete, so it can tidy up. This results in a call to UpdateHeaderL() and then either the descriptor is copied across or the file is closed.

Note: This function is only used if a decoder replaces the DoConvert() call - the default version does this as part of its processing.

Returns the overall size of the image frame in pixels.

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

See also: icl_uids.hrh .

Called as a result of the associated CImageEncoder::CustomSyncL() function being called. Plugins may override this to provide extended commands in CImageEncoder. Default version leaves with KErrNotSupported.

Deals with the result from ProcessFrameL().

This processes the results of the standard ProcessFrameL() call, feeding in the resultant error code from its TRAP and the status result. It will call RequestComplete() or SelfComplete() as appropriate. Note that if no data was created by ProcessFrameL(), HandleProcessFrameResult() assumes that the encoding process is complete. If this is not appropriate, an overloaded DoConvert() should be used to handle it.

Returns the plugin's write codec.

Initialises data structures prior to encoding a frame.

This may be overriden in derived classes in which case the derived class should ensure it calls this version after performing any plugin initialisation.

Called as a result of the associated CImageEncoder::CustomAsync() function being called. If this function finishes normally, then a convert cycle is started - so that DoConvert() will be subsequently started in the background - otherwise, if this function leaves then the error result is immediately signalled back to the caller of CustomAsync().

The default version leaves with KErrNotSupported unless overridden to change this behaviour. Plugins may override this to provide extended commands in CImageEncoder.

Plugin defined actions resulting from a call by RequestComplete().

This function is called when a RequestComplete() is issued indicating that an asynchronous command has finished. Plugins can extend this function to clear any custom command flags.

Returns the current position within the internal data buffer that is being written to.

See also: WriteDataPositionIncL(TInt aPosition,const TDesC8& aDes) WriteDataL(TInt aPosition,const TDesC8& aDes)

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.

This function must be called on completion of encoding the image data.

See also: CImageEncoderPlugin::SelfComplete(TInt aReason)

Forces initialization of data structures prior to decoding a frame.

Must be called at the end of a slice of encoding. If called with KErrNone will cause a repeat call to DoConvert().

See also: CImageEncoderPlugin::RequestComplete(TInt aReason)

Sets the plugin's write codec.

Ownership of the codec is transferred to the plugin.

May be called at the start of a slice of encoding if the encoding is expected to complete asynchronously. This sets the AO in CImageEncoderPriv to active, but does not complete the request.

When the encoding of the slice is complete, there must be a call to SelfComplete()

See also: CImageEncoderPlugin::SelfComplete(TInt aReason)

Indicates if an encode should abort early (ie. following a Cancel).

Note: This function always returns EFalse unless the encoder is running in its own thread.

Returns the bitmap which is being encoded.

Returns the starting position of the internal data buffer of the encoded image that is being written to.

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.

Checks the validity of the bitmap which is being encoded. Returns ETrue if the bitmap is valid, otherwise EFalse.

Writes a descriptor to the internal data buffer of the encoded image without incrementing the position in the buffer, and therefore a call to Position() will return the same value before or after a call to this function.

See also: Position()

Writes a descriptor to the internal data buffer of the encoded image. In addition, the position in the buffer that is written to (obtained with Position()) will be incremented returning aPosition + aDes.Length().

See also: Position()