Camera Functions

Collaboration diagram for Camera Functions:

Functions
IFX_INLINE uint32	IfxCif_Cam_calcMem (uint32 bytes, float32 frames)
IFX_INLINE void	IfxCif_Cam_initPictInfo (IfxCif_Cam_PictureInfo *m, const IfxCif_Cam_MemConfig *mcfg)
IFX_INLINE void	IfxCif_Cam_initPortPins (IfxPort_InputMode inputMode, IfxPort_PadDriver padDriver)
	initializes GPIO Ports for image capturing More...
IFX_INLINE boolean	IfxCif_Cam_isEmulationExtensionAvailable (void)
IFX_INLINE uint32	IfxCif_Cam_yuvMemSize (const IfxCif_Cam *cam)
IFX_INLINE void	IfxCif_Cam_clearFrameReceptionFlag (const IfxCif_Cam *cam)
	Clear the frame reception flag. More...
IFX_INLINE void	IfxCif_Cam_clearJpegEncodingCompleteFlag (const IfxCif_Cam *cam)
	Clear the JPEG encoder completed flag. More...
IFX_INLINE Ifx_AddressValue	IfxCif_Cam_getBbbAddress (const IfxCif_Cam *cam, Ifx_AddressValue cpuAddress)
	Convert the CPU address into BBB address. More...
IFX_INLINE uint32	IfxCif_Cam_getExtraFrameSize (const IfxCif_Cam *cam, IfxCif_ExtraPath z)
	Returns the size (in bytes) of one last acquired extra-path image data. More...
IFX_INLINE const IfxCif_Cam_MemInfo *	IfxCif_Cam_getExtraPathMemInfo (const IfxCif_Cam *cam, IfxCif_ExtraPath z)
IFX_INLINE uint32	IfxCif_Cam_getFrameSize (const IfxCif_Cam *cam)
	Returns the size (in bytes) of last acquired main-path image data. More...
IFX_INLINE uint32	IfxCif_Cam_getJpegEncodedSize (const IfxCif_Cam *cam)
	Returns the size (in bytes) of last encoded main-path image data. More...
IFX_INLINE Ifx_AddressValue	IfxCif_Cam_getLastExtraAddress (const IfxCif_Cam *cam, IfxCif_ExtraPath z)
	Returns the address location of last acquired extra-path image frame data. More...
IFX_INLINE const IfxCif_Cam_MemInfo *	IfxCif_Cam_getLastExtraCaptureInfo (const IfxCif_Cam *cam, IfxCif_ExtraPath z, Ifx_AddressValue *address, uint32 *size)
IFX_INLINE Ifx_AddressValue	IfxCif_Cam_getLastFrameAddress (const IfxCif_Cam *cam)
	Returns the address location of last acquired main-path image frame data. More...
IFX_INLINE const IfxCif_Cam_MemInfo *	IfxCif_Cam_getLastFrameCaptureInfo (const IfxCif_Cam *cam, Ifx_AddressValue *address, uint32 *size)
IFX_INLINE Ifx_AddressValue	IfxCif_Cam_getNextFrameAddress (const IfxCif_Cam *cam)
	Returns the address location of next acquired main-path image frame data. More...
IFX_INLINE Ifx_AddressValue	IfxCif_Cam_getNextJpegFrameAddress (IfxCif_Cam *cam)
	Returns the address location of next acquired JPEG image frame data. More...
IFX_INLINE Ifx_AddressValue	IfxCif_Cam_incrementAddress (const IfxCif_Cam *cam, Ifx_AddressValue address)
	Increment the address related to memory interface of for main-path. The address is wrapped around at the boundary of the allocated RAM size. More...
IFX_INLINE boolean	IfxCif_Cam_isFrameReceptionComplete (const IfxCif_Cam *cam)
	Returns TRUE if JPEG encoding is completed. More...
IFX_INLINE boolean	IfxCif_Cam_isJpegEncodingComplete (const IfxCif_Cam *cam)
IFX_INLINE void	IfxCif_Cam_skipPicture (const IfxCif_Cam *cam)
IFX_EXTERN void	IfxCif_Cam_clearAllFlags (const IfxCif_Cam *cam)
	Clear all CIF module notification flags. More...
IFX_EXTERN void	IfxCif_Cam_disableJpegEncoder (const IfxCif_Cam *cam)
	Disable the JPEG encoder and route the acquisition path accordingly to the 'original' configuration, i.e. RAW or main path. More...
IFX_EXTERN void	IfxCif_Cam_enableJpegEncoder (const IfxCif_Cam *cam)
	Enable the JPEG encoder and route the acquisition path accordingly. More...
IFX_EXTERN const IfxCif_Cam_PictureInfo *	IfxCif_Cam_getExtraPathPictureInfo (const IfxCif_Cam *cam, IfxCif_ExtraPath z)
	Returns pointer to the variable storing picture info of an extra-path. More...
IFX_EXTERN boolean	IfxCif_Cam_getLastJpegEncodingInfo (IfxCif_Cam *cam, Ifx_AddressValue *address, sint32 *size)
	Returns pointer to the memory structure storing last JPEG encoding process. More...
IFX_EXTERN IfxCif_Cam_Status	IfxCif_Cam_init (IfxCif_Cam *cam, const IfxCif_Cam_Config *config, boolean initCam)
	Initialise the CIF, EMEM, PORT, I2C and the camera itself. More...
IFX_EXTERN void	IfxCif_Cam_restartCapture (const IfxCif_Cam *cam, uint8 frames)
	Restart capture by enabling the ISP output. More...
IFX_EXTERN void	IfxCif_Cam_startCapture (const IfxCif_Cam *cam, uint8 frames)
	Start capture by enabling the ISP output and initialising the MI counter. More...
IFX_EXTERN void	IfxCif_Cam_stopCapture (const IfxCif_Cam *cam)
	Stop capture by disabling the ISP output. More...

Detailed Description

Function Documentation

IFX_INLINE uint32 IfxCif_Cam_calcMem	(	uint32	bytes,
		float32	frames
	)

Definition at line 135 of file IfxCif_Cam.c.

IFX_EXTERN void IfxCif_Cam_clearAllFlags

(

const IfxCif_Cam *

cam)

Clear all CIF module notification flags.

Parameters

cam	cam handle

Returns

None

Definition at line 188 of file IfxCif_Cam.c.

IFX_INLINE void IfxCif_Cam_clearFrameReceptionFlag

(

const IfxCif_Cam *

cam)

Clear the frame reception flag.

Parameters

cam	cam handle

Returns

None

Definition at line 437 of file IfxCif_Cam.h.

IFX_INLINE void IfxCif_Cam_clearJpegEncodingCompleteFlag

(

const IfxCif_Cam *

cam)

Clear the JPEG encoder completed flag.

Parameters

cam	cam handle

Returns

None

Definition at line 444 of file IfxCif_Cam.h.

Referenced by IfxCif_Cam_getLastJpegEncodingInfo().

IFX_EXTERN void IfxCif_Cam_disableJpegEncoder

(

const IfxCif_Cam *

cam)

Disable the JPEG encoder and route the acquisition path accordingly to the 'original' configuration, i.e. RAW or main path.

Parameters

cam	cam handle

Returns

None

Definition at line 197 of file IfxCif_Cam.c.

IFX_EXTERN void IfxCif_Cam_enableJpegEncoder

(

const IfxCif_Cam *

cam)

Enable the JPEG encoder and route the acquisition path accordingly.

Parameters

cam	cam handle

Returns

None

Definition at line 213 of file IfxCif_Cam.c.

IFX_INLINE Ifx_AddressValue IfxCif_Cam_getBbbAddress	(	const IfxCif_Cam *	cam,
		Ifx_AddressValue	cpuAddress
	)

Convert the CPU address into BBB address.

Parameters

cam	cam handle
cpuAddress	Address value

Definition at line 451 of file IfxCif_Cam.h.

IFX_INLINE uint32 IfxCif_Cam_getExtraFrameSize	(	const IfxCif_Cam *	cam,
		IfxCif_ExtraPath	z
	)

Returns the size (in bytes) of one last acquired extra-path image data.

Parameters

cam	cam handle
z	Extra path

Definition at line 459 of file IfxCif_Cam.h.

Referenced by IfxCif_Cam_getLastExtraCaptureInfo().

IFX_INLINE const IfxCif_Cam_MemInfo * IfxCif_Cam_getExtraPathMemInfo	(	const IfxCif_Cam *	cam,
		IfxCif_ExtraPath	z
	)

Parameters

cam	cam handle
z	Extra path

Definition at line 481 of file IfxCif_Cam.h.

Referenced by IfxCif_Cam_getLastExtraCaptureInfo().

IFX_EXTERN const IfxCif_Cam_PictureInfo* IfxCif_Cam_getExtraPathPictureInfo	(	const IfxCif_Cam *	cam,
		IfxCif_ExtraPath	z
	)

Returns pointer to the variable storing picture info of an extra-path.

Parameters

cam	cam handle
z	Extra Path

Returns

pointer to the variable storing picture info of an extra-path

Definition at line 222 of file IfxCif_Cam.c.

IFX_INLINE uint32 IfxCif_Cam_getFrameSize

(

const IfxCif_Cam *

cam)

Returns the size (in bytes) of last acquired main-path image data.

Parameters

cam	cam handle

Definition at line 487 of file IfxCif_Cam.h.

Referenced by IfxCif_Cam_getJpegEncodedSize(), and IfxCif_Cam_getLastFrameCaptureInfo().

IFX_INLINE uint32 IfxCif_Cam_getJpegEncodedSize

(

const IfxCif_Cam *

cam)

Returns the size (in bytes) of last encoded main-path image data.

Parameters

cam	cam handle

Definition at line 501 of file IfxCif_Cam.h.

Referenced by IfxCif_Cam_getLastJpegEncodingInfo().

IFX_INLINE Ifx_AddressValue IfxCif_Cam_getLastExtraAddress	(	const IfxCif_Cam *	cam,
		IfxCif_ExtraPath	z
	)

Returns the address location of last acquired extra-path image frame data.

Parameters

cam	cam handle
z	Extra path

Definition at line 510 of file IfxCif_Cam.h.

Referenced by IfxCif_Cam_getLastExtraCaptureInfo().

IFX_INLINE const IfxCif_Cam_MemInfo * IfxCif_Cam_getLastExtraCaptureInfo	(	const IfxCif_Cam *	cam,
		IfxCif_ExtraPath	z,
		Ifx_AddressValue *	address,
		uint32 *	size
	)

Parameters

cam	cam handle
z	Extra path
address	Address Value
size	const IfxCif_Cam_MemInfo *m; *size = IfxCif_Cam_getExtraFrameSize(cam, z); *address = IfxCif_Cam_getLastExtraAddress(cam, z); m = IfxCif_Cam_getExtraPathMemInfo(cam, z); return m;

Definition at line 523 of file IfxCif_Cam.h.

IFX_INLINE Ifx_AddressValue IfxCif_Cam_getLastFrameAddress

(

const IfxCif_Cam *

cam)

Returns the address location of last acquired main-path image frame data.

Parameters

cam	cam handle

Returns

address location of last acquired main-path image frame data

Definition at line 533 of file IfxCif_Cam.h.

Referenced by IfxCif_Cam_getLastFrameCaptureInfo(), and IfxCif_Cam_getLastJpegEncodingInfo().

IFX_INLINE const IfxCif_Cam_MemInfo * IfxCif_Cam_getLastFrameCaptureInfo	(	const IfxCif_Cam *	cam,
		Ifx_AddressValue *	address,
		uint32 *	size
	)

Parameters

cam	cam handle
address	Address value
size	Size

Definition at line 541 of file IfxCif_Cam.h.

IFX_EXTERN boolean IfxCif_Cam_getLastJpegEncodingInfo	(	IfxCif_Cam *	cam,
		Ifx_AddressValue *	address,
		sint32 *	size
	)

Returns pointer to the memory structure storing last JPEG encoding process.

Parameters

cam	cam handle
address	EMEM address which stores the JPEG frame
size	size of JPEG frame

Returns

TRUE if there was new frame encoded, else FALSE

Definition at line 235 of file IfxCif_Cam.c.

IFX_INLINE Ifx_AddressValue IfxCif_Cam_getNextFrameAddress

(

const IfxCif_Cam *

cam)

Returns the address location of next acquired main-path image frame data.

Parameters

cam	cam handle

Definition at line 551 of file IfxCif_Cam.h.

Referenced by IfxCif_Cam_getNextJpegFrameAddress().

IFX_INLINE Ifx_AddressValue IfxCif_Cam_getNextJpegFrameAddress

(

IfxCif_Cam *

cam)

Returns the address location of next acquired JPEG image frame data.

Parameters

cam	cam handle

Definition at line 559 of file IfxCif_Cam.h.

Referenced by IfxCif_Cam_getLastJpegEncodingInfo().

IFX_INLINE Ifx_AddressValue IfxCif_Cam_incrementAddress	(	const IfxCif_Cam *	cam,
		Ifx_AddressValue	address
	)

Increment the address related to memory interface of for main-path. The address is wrapped around at the boundary of the allocated RAM size.

Parameters

cam	cam handle
address	Address value

Definition at line 567 of file IfxCif_Cam.h.

IFX_EXTERN IfxCif_Cam_Status IfxCif_Cam_init	(	IfxCif_Cam *	cam,
		const IfxCif_Cam_Config *	config,
		boolean	initCam
	)

Initialise the CIF, EMEM, PORT, I2C and the camera itself.

Parameters

cam	cam handel
config	configurations structure
initCam	if TRUE camera will be reconfigured, else camera will not be reconfigured.

Definition at line 260 of file IfxCif_Cam.c.

IFX_INLINE void IfxCif_Cam_initPictInfo	(	IfxCif_Cam_PictureInfo *	m,
		const IfxCif_Cam_MemConfig *	mcfg
	)

Returns

None

Definition at line 144 of file IfxCif_Cam.c.

IFX_INLINE void IfxCif_Cam_initPortPins	(	IfxPort_InputMode	inputMode,
		IfxPort_PadDriver	padDriver
	)

initializes GPIO Ports for image capturing

Returns

None

Definition at line 153 of file IfxCif_Cam.c.

Referenced by IfxCif_Cam_init().

IFX_INLINE boolean IfxCif_Cam_isEmulationExtensionAvailable

(

void

)

Definition at line 172 of file IfxCif_Cam.c.

Referenced by IfxCif_Cam_init().

IFX_INLINE boolean IfxCif_Cam_isFrameReceptionComplete

(

const IfxCif_Cam *

cam)

Returns TRUE if JPEG encoding is completed.

Parameters

cam	cam handle

Returns

TRUE if one frame reception is completed

Definition at line 580 of file IfxCif_Cam.h.

IFX_INLINE boolean IfxCif_Cam_isJpegEncodingComplete

(

const IfxCif_Cam *

cam)

Parameters

cam	cam handle

Returns

TRUE if JPEG encoding is completed

Definition at line 588 of file IfxCif_Cam.h.

Referenced by IfxCif_Cam_getLastJpegEncodingInfo().

IFX_EXTERN void IfxCif_Cam_restartCapture	(	const IfxCif_Cam *	cam,
		uint8	frames
	)

Restart capture by enabling the ISP output.

Parameters

cam	cam handle
frames	Number of acquisitions. Set to zero for continuous acquisition

Returns

None

Definition at line 801 of file IfxCif_Cam.c.

IFX_INLINE void IfxCif_Cam_skipPicture

(

const IfxCif_Cam *

cam)

Parameters

cam	cam handle

Returns

None

Definition at line 596 of file IfxCif_Cam.h.

IFX_EXTERN void IfxCif_Cam_startCapture	(	const IfxCif_Cam *	cam,
		uint8	frames
	)

Start capture by enabling the ISP output and initialising the MI counter.

Parameters

cam	cam handle
frames	Number of acquisitions. Set to zero for continuous acquisition

Returns

None

Definition at line 810 of file IfxCif_Cam.c.

IFX_EXTERN void IfxCif_Cam_stopCapture

(

const IfxCif_Cam *

cam)

Stop capture by disabling the ISP output.

Parameters

cam	cam handle

Returns

None

Definition at line 822 of file IfxCif_Cam.c.

IFX_INLINE uint32 IfxCif_Cam_yuvMemSize

(

const IfxCif_Cam *

cam)

Parameters

cam	cam handle

Definition at line 178 of file IfxCif_Cam.c.