ImageProcessor::MImgProcessorPlugin Class Reference

class ImageProcessor::MImgProcessorPlugin

Mixin class for implementation by providers of the Image Processor Plugin.

CImgProcessor

Public Member Functions
voidApplyOperationL(CImgProcessor::TOperation)
TRgb BackgroundColorL()
TInt CalculatePixelBufferSizeL(TSize, TDisplayMode, TUint32)
TInt CalculatePixelBufferSizeL(TSize, const TUid &, TUint32)
TBool CanRedoL()
TBool CanUndoL()
voidCancel()
voidCleanupEffects()
voidCleanupOutput()
voidCreateInputL(CFbsBitmap &)
voidCreateInputL(CImageFrame &)
voidCreateInputL(const TSize &, const TRgb &)
TSize CurrentSizeL()
voidDestroy()
Plugin::MEffect *EffectL(TUid)
TAny *Extension(TUid)
voidInitializeL()
Plugin::MInputInfo *InputInfoL()
voidInputUpdatedL()
Plugin::MOutputInfo *OutputInfoL()
Plugin::MOverlay *OverlayL()
Plugin::MPreview *PreviewL(TInt)
voidProcessL(const TSize &, TBool)
Plugin::MProgressInfo *ProgressInfoL()
voidRedoAllL()
voidRedoL()
voidResetL()
voidSetBackgroundColorL(const TRgb &)
voidSetFileServerSession(RFs &)
voidSetInputL(const TDesC &, const TUid &, const TUid &)
voidSetInputL(RFile &, const TUid &, const TUid &)
voidSetInputL(TMMSource &, const TUid &, const TUid &)
voidSetInputL(const TDesC8 &, const TUid &, const TUid &)
voidSetInputL(const CFbsBitmap &, const CFbsBitmap *)
voidSetInputL(const CImageFrame &)
voidSetInputRectL(const TRect &)
voidSetObserver(MImgProcessorPluginObserver &)
voidSetOptionsL(TUint64)
voidSetOutputL(const TDesC &, const TUid &, const TUid &)
voidSetOutputL(RFile &, const TUid &, const TUid &)
voidSetOutputL(RBuf8 &, const TUid &, const TUid &)
voidSetOutputL(CImageFrame &)
voidSetOutputL(CFbsBitmap &, CFbsBitmap *)
voidSupportedEffectsL(RArray< TUid > &)
voidSupportedInputDisplayModesL(RArray< TDisplayMode > &)
voidSupportedInputFormatsL(RArray< TUid > &)
voidSupportedInputImageFrameFormatsL(RArray< TUid > &)
voidSupportedInputSubFormatsL(TUid, RArray< TUid > &)
TUint SupportedOperations()
TUint64 SupportedOptions()
voidSupportedOutputDisplayModesL(RArray< TDisplayMode > &)
voidSupportedOutputFormatsL(RArray< TUid > &)
voidSupportedOutputImageFrameFormatsL(RArray< TUid > &)
voidSupportedOutputSubFormatsL(TUid, RArray< TUid > &)
voidSupportedOverlayInputDisplayModesL(RArray< TDisplayMode > &)
voidSupportedOverlayInputFormatsL(RArray< TUid > &)
voidSupportedOverlayInputImageFrameFormatsL(RArray< TUid > &)
voidSupportedPreviewOutputDisplayModesL(RArray< TDisplayMode > &)
voidSupportedPreviewOutputImageFrameFormatsL(RArray< TUid > &)
voidUndoAllL()
voidUndoL()

Member Functions Documentation

ApplyOperationL(CImgProcessor::TOperation)

voidApplyOperationL(CImgProcessor::TOperationaOperation)[pure virtual]

Parameters

CImgProcessor::TOperation aOperation

BackgroundColorL()

TRgb BackgroundColorL()const [pure virtual]

A derived class must provide an implementation of this method as defined by CImgProcessor::BackgroundColorL()

CImgProcessor::BackgroundColorL()

CalculatePixelBufferSizeL(TSize, TDisplayMode, TUint32)

TInt CalculatePixelBufferSizeL(TSizeaSizeInPixels,
TDisplayModeaDisplayMode,
TUint32aScanLineLength
)const [pure virtual]

A derived class must provide an implementation of this method as defined by CImgProcessor::CalculatePixelBufferSizeL(TSize aSizeInPixels, TDisplayMode aDisplayMode, TUint32 aScanLineLength)

CImgProcessor::CalculatePixelBufferSizeL(TSize aSizeInPixels, TDisplayMode aDisplayMode, TUint32 aScanLineLength)

Parameters

TSize aSizeInPixels
TDisplayMode aDisplayMode
TUint32 aScanLineLength

CalculatePixelBufferSizeL(TSize, const TUid &, TUint32)

TInt CalculatePixelBufferSizeL(TSizeaSizeInPixels,
const TUid &aFormat,
TUint32aScanLineLength = 0
)const [pure virtual]

A derived class must provide an implementation of this method as defined by CImgProcessor::CalculatePixelBufferSizeL(TSize aSizeInPixels, const TUid& aFormat, TUint32 aScanLineLength = 0)

CImgProcessor::CalculatePixelBufferSizeL(TSize aSizeInPixels, const TUid& aFormat, TUint32 aScanLineLength = 0)

Parameters

TSize aSizeInPixels
const TUid & aFormat
TUint32 aScanLineLength = 0

CanRedoL()

TBool CanRedoL()const [pure virtual]

A derived class must provide an implementation of this method as defined by CImgProcessor::CanRedoL()

CImgProcessor::CanRedoL()

CanUndoL()

TBool CanUndoL()const [pure virtual]

A derived class must provide an implementation of this method as defined by CImgProcessor::CanUndoL()

CImgProcessor::CanUndoL()

Cancel()

voidCancel()[pure virtual]

A derived class must provide an implementation of this method as defined by CImgProcessor::Cancel()

CImgProcessor::Cancel()

CleanupEffects()

voidCleanupEffects()[pure virtual]

A derived class must provide an implementation of this method to clean up effects.

CleanupOutput()

voidCleanupOutput()[pure virtual]

A derived class must provide an implementation of this method to clean up unauthorized output.

CreateInputL(CFbsBitmap &)

voidCreateInputL(CFbsBitmap &aBitmap)[pure virtual]

A derived class must provide an implementation of this method as defined by CImgProcessor::CreateInputL(CFbsBitmap& aBitmap)

CImgProcessor::CreateInputL(CFbsBitmap& aBitmap)

Parameters

CFbsBitmap & aBitmap

CreateInputL(CImageFrame &)

voidCreateInputL(CImageFrame &aPixelBuffer)[pure virtual]

A derived class must provide an implementation of this method as defined by CImgProcessor::CreateInputL(CImageFrame& aPixelBuffer)

CImgProcessor::CreateInputL(CImageFrame& aPixelBuffer)

Parameters

CImageFrame & aPixelBuffer

CreateInputL(const TSize &, const TRgb &)

voidCreateInputL(const TSize &aSize,
const TRgb &aColor
)[pure virtual]

Parameters

const TSize & aSize
const TRgb & aColor

CurrentSizeL()

TSize CurrentSizeL()const [pure virtual]

A derived class must provide an implementation of this method as defined by CImgProcessor::CurrentSizeL()

CImgProcessor::CurrentSizeL()

Destroy()

voidDestroy()[pure virtual]

A derived class must provide an implementation of this method to destroy plugin and release all allocated memory

EffectL(TUid)

Plugin::MEffect *EffectL(TUidaEffectId)[pure virtual]

A derived class must provide an implementation of this method as defined by CImgProcessor::EffectL(TUid aEffectId)

CImgProcessor::EffectL(TUid aEffectId)

Parameters

TUid aEffectId

Extension(TUid)

TAny *Extension(TUidaExtension)[pure virtual]

A derived class must provide an implementation of this method as defined by CImgProcessor::Extension(TUid aExtension)

CImgProcessor::Extension(TUid aExtension)

Parameters

TUid aExtension

InitializeL()

voidInitializeL()[pure virtual]

A derived class must provide an implementation of this method as defined by CImgProcessor::InitializeL()

CImgProcessor::InitializeL()

InputInfoL()

Plugin::MInputInfo *InputInfoL()[pure virtual]

A derived class must provide an implementation of this method as defined by CImgProcessor::InputInfoL()

CImgProcessor::InputInfoL()

InputUpdatedL()

voidInputUpdatedL()[pure virtual]

A derived class must provide an implementation of this method as defined by CImgProcessor::InputUpdatedL()

CImgProcessor::InputUpdatedL()

OutputInfoL()

Plugin::MOutputInfo *OutputInfoL()[pure virtual]

A derived class must provide an implementation of this method as defined by CImgProcessor::OutpputInfoL()

CImgProcessor::OutputInfoL()

OverlayL()

Plugin::MOverlay *OverlayL()[pure virtual]

A derived class must provide an implementation of this method as defined by CImgProcessor::OverlayL()

CImgProcessor::OverlayL()

PreviewL(TInt)

Plugin::MPreview *PreviewL(TIntaPreviewId)[pure virtual]

A derived class must provide an implementation of this method as defined by CImgProcessor::PreviewL(TInt aPreviewId)

CImgProcessor::PreviewL(TInt aPreviewId)

Parameters

TInt aPreviewId

ProcessL(const TSize &, TBool)

voidProcessL(const TSize &aSize,
TBoolaMaintainAspectRatio
)[pure virtual]

Parameters

const TSize & aSize
TBool aMaintainAspectRatio

ProgressInfoL()

Plugin::MProgressInfo *ProgressInfoL()[pure virtual]

A derived class must provide an implementation of this method as defined by CImgProcessor::ProgressInfoL()

CImgProcessor::ProgressInfoL()

RedoAllL()

voidRedoAllL()[pure virtual]

A derived class must provide an implementation of this method as defined by CImgProcessor::RedoAllL()

CImgProcessor::RedoAllL()

RedoL()

voidRedoL()[pure virtual]

A derived class must provide an implementation of this method as defined by CImgProcessor::RedoL()

CImgProcessor::RedoL()

ResetL()

voidResetL()[pure virtual]

A derived class must provide an implementation of this method as defined by CImgProcessor::ResetL()

CImgProcessor::ResetL()

SetBackgroundColorL(const TRgb &)

voidSetBackgroundColorL(const TRgb &aColor)[pure virtual]

A derived class must provide an implementation of this method as defined by CImgProcessor::SetBackgroundColorL(const TRgb& aColor)

CImgProcessor::SetBackgroundColorL(const TRgb& aColor)

Parameters

const TRgb & aColor

SetFileServerSession(RFs &)

voidSetFileServerSession(RFs &aFileServerSession)[pure virtual]

A derived class must provide an implementation of this method as defined by CImgProcessor::SetFileServerSession(RFs& aFileServerSession)

CImgProcessor::SetFileServerSession(RFs& aFileServerSession)

Parameters

RFs & aFileServerSession

SetInputL(const TDesC &, const TUid &, const TUid &)

voidSetInputL(const TDesC &aFilename,
const TUid &aFormat,
const TUid &aSubFormat
)[pure virtual]

Parameters

const TDesC & aFilename
const TUid & aFormat
const TUid & aSubFormat

SetInputL(RFile &, const TUid &, const TUid &)

voidSetInputL(RFile &aFile,
const TUid &aFormat,
const TUid &aSubFormat
)[pure virtual]

Parameters

RFile & aFile
const TUid & aFormat
const TUid & aSubFormat

SetInputL(TMMSource &, const TUid &, const TUid &)

voidSetInputL(TMMSource &aDrmFile,
const TUid &aFormat,
const TUid &aSubFormat
)[pure virtual]

Parameters

TMMSource & aDrmFile
const TUid & aFormat
const TUid & aSubFormat

SetInputL(const TDesC8 &, const TUid &, const TUid &)

voidSetInputL(const TDesC8 &aBuffer,
const TUid &aFormat,
const TUid &aSubFormat
)[pure virtual]

Parameters

const TDesC8 & aBuffer
const TUid & aFormat
const TUid & aSubFormat

SetInputL(const CFbsBitmap &, const CFbsBitmap *)

voidSetInputL(const CFbsBitmap &aBitmap,
const CFbsBitmap *aMask
)[pure virtual]

Parameters

const CFbsBitmap & aBitmap
const CFbsBitmap * aMask

SetInputL(const CImageFrame &)

voidSetInputL(const CImageFrame &aPixelBuffer)[pure virtual]

A derived class must provide an implementation of this method as defined by CImgProcessor::SetInputL(const CImageFrame& aPixelBuffer)

CImgProcessor::SetInputL(const CImageFrame& aPixelBuffer)

Parameters

const CImageFrame & aPixelBuffer

SetInputRectL(const TRect &)

voidSetInputRectL(const TRect &aRect)[pure virtual]

A derived class must provide an implementation of this method as defined by CImgProcessor::SetInputRectL(const TRect& aRect)

CImgProcessor::SetInputRectL(const TRect& aRect)

Parameters

const TRect & aRect

SetObserver(MImgProcessorPluginObserver &)

voidSetObserver(MImgProcessorPluginObserver &aObserver)[pure virtual]

A derived class must provide an implementation of this method as defined by CImgProcessor::SetObserver(MImgProcessorPluginObserver& aObserver)

CImgProcessor::SetObserver(MImgProcessorPluginObserver& aObserver)

Parameters

MImgProcessorPluginObserver & aObserver

SetOptionsL(TUint64)

voidSetOptionsL(TUint64aOptions)[pure virtual]

A derived class must provide an implementation of this method as defined by CImgProcessor::SetOptionsL(TUint64 aOptions)

CImgProcessor::SetOptionsL(TUint64 aOptions)

Parameters

TUint64 aOptions

SetOutputL(const TDesC &, const TUid &, const TUid &)

voidSetOutputL(const TDesC &aFilename,
const TUid &aFormat,
const TUid &aSubFormat
)[pure virtual]

Parameters

const TDesC & aFilename
const TUid & aFormat
const TUid & aSubFormat

SetOutputL(RFile &, const TUid &, const TUid &)

voidSetOutputL(RFile &aFile,
const TUid &aFormat,
const TUid &aSubFormat
)[pure virtual]

Parameters

RFile & aFile
const TUid & aFormat
const TUid & aSubFormat

SetOutputL(RBuf8 &, const TUid &, const TUid &)

voidSetOutputL(RBuf8 &aBuffer,
const TUid &aFormat,
const TUid &aSubFormat
)[pure virtual]

Parameters

RBuf8 & aBuffer
const TUid & aFormat
const TUid & aSubFormat

SetOutputL(CImageFrame &)

voidSetOutputL(CImageFrame &aPixelBuffer)[pure virtual]

A derived class must provide an implementation of this method as defined by CImgProcessor::SetOutputL(CImageFrame& aPixelBuffer)

CImgProcessor::SetOutputL(CImageFrame& aPixelBuffer)

Parameters

CImageFrame & aPixelBuffer

SetOutputL(CFbsBitmap &, CFbsBitmap *)

voidSetOutputL(CFbsBitmap &aBitmap,
CFbsBitmap *aMask
)[pure virtual]

Parameters

CFbsBitmap & aBitmap
CFbsBitmap * aMask

SupportedEffectsL(RArray< TUid > &)

voidSupportedEffectsL(RArray< TUid > &aEffects)const [pure virtual]

A derived class must provide an implementation of this method as defined by CImgProcessor::SupportedEffectsL(RArray<TUid>& aEffects)

CImgProcessor::SupportedEffectsL(RArray<TUid>& aEffects)

Parameters

RArray< TUid > & aEffects

SupportedInputDisplayModesL(RArray< TDisplayMode > &)

voidSupportedInputDisplayModesL(RArray< TDisplayMode > &aDisplayModes)const [pure virtual]

A derived class must provide an implementation of this method as defined by CImgProcessor::SupportedInputDisplayModesL((RArray<TDisplayMode>& aDisplayModes)

CImgProcessor::SupportedInputDisplayModesL((RArray<TDisplayMode>& aDisplayModes)

Parameters

RArray< TDisplayMode > & aDisplayModes

SupportedInputFormatsL(RArray< TUid > &)

voidSupportedInputFormatsL(RArray< TUid > &aFormats)const [pure virtual]

A derived class must provide an implementation of this method as defined by CImgProcessor::SupportedInputFormatsL(RArray<TUid>& aFormats)

CImgProcessor::SupportedInputFormatsL(RArray<TUid>& aFormats)

Parameters

RArray< TUid > & aFormats

SupportedInputImageFrameFormatsL(RArray< TUid > &)

voidSupportedInputImageFrameFormatsL(RArray< TUid > &aFormats)const [pure virtual]

A derived class must provide an implementation of this method as defined by CImgProcessor::SupportedInputImageFrameFormatsL(RArray<TUid>& aFormats)

CImgProcessor::SupportedInputImageFrameFormatsL(RArray<TUid>& aFormats)

Parameters

RArray< TUid > & aFormats

SupportedInputSubFormatsL(TUid, RArray< TUid > &)

voidSupportedInputSubFormatsL(TUidaFormat,
RArray< TUid > &aSubFormats
)const [pure virtual]

A derived class must provide an implementation of this method as defined by CImgProcessor::SupportedInputSubFormatsL(TUid aFormat, RArray<TUid>& aSubFormats)

CImgProcessor::SupportedInputSubFormatsL(TUid aFormat, RArray<TUid>& aSubFormats)

Parameters

TUid aFormat
RArray< TUid > & aSubFormats

SupportedOperations()

TUint SupportedOperations()const [pure virtual]

A derived class must provide an implementation of this method as defined by CImgProcessor::SupportedOperations()

CImgProcessor::SupportedOperations()

SupportedOptions()

TUint64 SupportedOptions()const [pure virtual]

A derived class must provide an implementation of this method as defined by CImgProcessor::SupportedOptions()

CImgProcessor::SupportedOptions()

SupportedOutputDisplayModesL(RArray< TDisplayMode > &)

voidSupportedOutputDisplayModesL(RArray< TDisplayMode > &aDisplayModes)const [pure virtual]

A derived class must provide an implementation of this method as defined by CImgProcessor::SupportedOutputDisplayModesL((RArray<TDisplayMode>& aDisplayModes)

CImgProcessor::SupportedOutputDisplayModesL((RArray<TDisplayMode>& aDisplayModes)

Parameters

RArray< TDisplayMode > & aDisplayModes

SupportedOutputFormatsL(RArray< TUid > &)

voidSupportedOutputFormatsL(RArray< TUid > &aFormats)const [pure virtual]

A derived class must provide an implementation of this method as defined by CImgProcessor::SupportedOutputFormatsL(RArray<TUid>& aFormats)

CImgProcessor::SupportedOutputFormatsL(RArray<TUid>& aFormats)

Parameters

RArray< TUid > & aFormats

SupportedOutputImageFrameFormatsL(RArray< TUid > &)

voidSupportedOutputImageFrameFormatsL(RArray< TUid > &aFormats)const [pure virtual]

A derived class must provide an implementation of this method as defined by CImgProcessor::SupportedOutputImageFrameFormatsL(RArray<TUid>& aFormats

CImgProcessor::SupportedOutputImageFrameFormatsL(RArray<TUid>& aFormats

Parameters

RArray< TUid > & aFormats

SupportedOutputSubFormatsL(TUid, RArray< TUid > &)

voidSupportedOutputSubFormatsL(TUidaFormat,
RArray< TUid > &aSubFormats
)const [pure virtual]

A derived class must provide an implementation of this method as defined by CImgProcessor::SupportedOutputSubFormatsL(TUid aFormat, RArray<TUid>& aSubFormats)

CImgProcessor::SupportedOutputSubFormatsL(TUid aFormat, RArray<TUid>& aSubFormats)

Parameters

TUid aFormat
RArray< TUid > & aSubFormats

SupportedOverlayInputDisplayModesL(RArray< TDisplayMode > &)

voidSupportedOverlayInputDisplayModesL(RArray< TDisplayMode > &aDisplayModes)const [pure virtual]

A derived class must provide an implementation of this method as defined by CImgProcessor::SupportedOverlayInputDisplayModesL(RArray<TDisplayMode>& aDisplayModes)

CImgProcessor::SupportedOverlayInputDisplayModesL(RArray<TDisplayMode>& aDisplayModes)

Parameters

RArray< TDisplayMode > & aDisplayModes

SupportedOverlayInputFormatsL(RArray< TUid > &)

voidSupportedOverlayInputFormatsL(RArray< TUid > &aFormats)const [pure virtual]

A derived class must provide an implementation of this method as defined by CImgProcessor::SupportedOverlayInputFormatsL(RArray<TUid>& aFormats)

CImgProcessor::SupportedOverlayInputFormatsL(RArray<TUid>& aFormats)

Parameters

RArray< TUid > & aFormats

SupportedOverlayInputImageFrameFormatsL(RArray< TUid > &)

voidSupportedOverlayInputImageFrameFormatsL(RArray< TUid > &aFormats)const [pure virtual]

A derived class must provide an implementation of this method as defined by CImgProcessor::SupportedOverlayInputImageFrameFormatsL(RArray<TUid>& aFormats)

CImgProcessor::SupportedOverlayInputImageFrameFormatsL(RArray<TUid>& aFormats)

Parameters

RArray< TUid > & aFormats

SupportedPreviewOutputDisplayModesL(RArray< TDisplayMode > &)

voidSupportedPreviewOutputDisplayModesL(RArray< TDisplayMode > &aDisplayModes)const [pure virtual]

A derived class must provide an implementation of this method as defined by CImgProcessor::SupportedPreviewOutputDisplayModesL(RArray<TDisplayMode>& aDisplayModes)

CImgProcessor::SupportedPreviewOutputDisplayModesL(RArray<TDisplayMode>& aDisplayModes)

Parameters

RArray< TDisplayMode > & aDisplayModes

SupportedPreviewOutputImageFrameFormatsL(RArray< TUid > &)

voidSupportedPreviewOutputImageFrameFormatsL(RArray< TUid > &aFormats)const [pure virtual]

A derived class must provide an implementation of this method as defined by CImgProcessor::SupportedPreviewOutputImageFrameFormatsL(RArray<TUid>& aFormats)

CImgProcessor::SupportedPreviewOutputImageFrameFormatsL(RArray<TUid>& aFormats)

Parameters

RArray< TUid > & aFormats

UndoAllL()

voidUndoAllL()[pure virtual]

A derived class must provide an implementation of this method as defined by CImgProcessor::UndoAllL()

CImgProcessor::UndoAllL()

UndoL()

voidUndoL()[pure virtual]

A derived class must provide an implementation of this method as defined by CImgProcessor::UndoL()

CImgProcessor::UndoL()