CCamera::CCameraV2Histogram Class Reference

class CCamera::CCameraV2Histogram : public CBase

This class allows the client to get histogram data in a specified format for an image (for example, luminance based histogram, average colour value histogram, etc).

Histogram may be created for still images, video, viewfinders and snapshot. Further different types of histogram may be created for any of the imaging modes.

The data generated can be fed to some exposure based algorithm, or directly displayed on the screen. It also allows the client to get and set the properties of a histogram.

The client selects histogram parameters calling PrepareClientHistogramL or PrepareDirectHistogramL. It can then start and stop receiving notifications from the ECam implementation by calling StartHistogram() and StopHistogram(). The client application using this API shall provide the interfaces: MCaptureImageObserver, MCaptureVideoObserver, MDirectViewFinderObserver and MClientViewFinderObserver in order to receive notifications about direct histogram display or client histogram data availablility.

Implementation shall use MHistogramV2Buffer in order to provide client histogram data.

Note:

This class provides a standardised client interface for the camera histogram. Classes cannot be derived from it.

If the class methods leave, the output type parameter value is not guaranteed to be valid.

Inherits from

  • CCamera::CCameraV2Histogram

Nested Classes and Structures

Public Member Functions
~CCameraV2Histogram()
IMPORT_C voidGetDirectHistogramPropertiesL(TDirectHistogramParameters &)
IMPORT_C voidGetDirectHistogramSupportInfoL(TBool &)
IMPORT_C voidGetHistogramStateL(TBool &)
IMPORT_C voidGetSupportedHistogramsL(TUint &)
IMPORT_C voidPrepareClientHistogramL(THistogramType)
IMPORT_C voidPrepareDirectHistogramL(const TDirectHistogramParameters &)
IMPORT_C voidStartHistogram()
IMPORT_C voidStopHistogram()
IMPORT_C voidUpdateDirectHistogramPropertiesL(const TDirectHistogramParameters &)
Private Member Functions
CCameraV2Histogram(CCamera &)
voidConstructL(const MImplementationFactory &)
IMPORT_C CCamera::CCameraV2Histogram *CreateL(CCamera &, MImplementationFactory &)
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()
Public Member Enumerations
enumTHistogramType {
EHistNone = 0x0000, ELuminance = 0x0001, EAverageRGB = 0x0002, ERedComponent = 0x0004, EBlueComponent = 0x0008, EGreenComponent = 0x0010, EOverExposure = 0x0020, EUnderExposure = 0x0040
}
Private Attributes
MCameraV2Histogram *iImpl
CCamera &iOwner

Constructor & Destructor Documentation

CCameraV2Histogram(CCamera &)

CCameraV2Histogram(CCamera &aOwner)[private]

Parameters

CCamera & aOwner

~CCameraV2Histogram()

IMPORT_C~CCameraV2Histogram()

Member Functions Documentation

ConstructL(const MImplementationFactory &)

voidConstructL(const MImplementationFactory &aImplFactory)[private]

Parameters

const MImplementationFactory & aImplFactory

CreateL(CCamera &, MImplementationFactory &)

IMPORT_C CCamera::CCameraV2Histogram *CreateL(CCamera &aCamera,
MImplementationFactory &aImplFactory
)[private, static]

Parameters

CCamera & aCamera
MImplementationFactory & aImplFactory

GetDirectHistogramPropertiesL(TDirectHistogramParameters &)

IMPORT_C voidGetDirectHistogramPropertiesL(TDirectHistogramParameters &aDirectHistogramParameters)const

Parameters

TDirectHistogramParameters & aDirectHistogramParameters

GetDirectHistogramSupportInfoL(TBool &)

IMPORT_C voidGetDirectHistogramSupportInfoL(TBool &aIsDirectHistogramSupported)const

Parameters

TBool & aIsDirectHistogramSupported

GetHistogramStateL(TBool &)

IMPORT_C voidGetHistogramStateL(TBool &aIsHistogramActive)const

Parameters

TBool & aIsHistogramActive

GetSupportedHistogramsL(TUint &)

IMPORT_C voidGetSupportedHistogramsL(TUint &aSupportedHistogramType)const

Parameters

TUint & aSupportedHistogramType

PrepareClientHistogramL(THistogramType)

IMPORT_C voidPrepareClientHistogramL(THistogramTypeaType)

Parameters

THistogramType aType

PrepareDirectHistogramL(const TDirectHistogramParameters &)

IMPORT_C voidPrepareDirectHistogramL(const TDirectHistogramParameters &aDirectHistogramParameters)

Parameters

const TDirectHistogramParameters & aDirectHistogramParameters

StartHistogram()

IMPORT_C voidStartHistogram()

StopHistogram()

IMPORT_C voidStopHistogram()

UpdateDirectHistogramPropertiesL(const TDirectHistogramParameters &)

IMPORT_C voidUpdateDirectHistogramPropertiesL(const TDirectHistogramParameters &aDirectHistogramParameters)

Parameters

const TDirectHistogramParameters & aDirectHistogramParameters

Member Enumerations Documentation

Enum THistogramType

Supported histogram types. The enumeration list may be extended in future.

Enumerators

EHistNone = 0x0000

No histogram has been specified.

ELuminance = 0x0001

Luminance based histogram.

EAverageRGB = 0x0002

The histogram is based on the average value of all three RGB colour components.

ERedComponent = 0x0004

The histogram is based on the value of the red colour component.

EBlueComponent = 0x0008

The histogram is based on the value of the blue colour component.

EGreenComponent = 0x0010

The histogram is based on the value of the green colour component.

EOverExposure = 0x0020

Qualitative Histogram to mark over exposed parts of image.

EUnderExposure = 0x0040

Qualitative Histogram to mark under exposed parts of image.

Member Data Documentation

MCameraV2Histogram * iImpl

MCameraV2Histogram *iImpl[private]

CCamera & iOwner

CCamera &iOwner[private]
© Nokia 2010.