Collaboration diagram for JPEG Encoder Functions:

Functions
IFX_INLINE IfxCif_JpeHeaderGenerationMode	IfxCif_getJpeHeaderGenerationMode (void)
	Function to query the current header generation debug control mode. More...

IFX_INLINE IfxCif_JpeHeaderMode	IfxCif_getJpeHeaderMode (void)
	Function to query the currently set JPE header mode. More...

IFX_INLINE IfxCif_State	IfxCif_getJpeMode (void)
	Function to query the JPE encode mode. More...

IFX_INLINE uint16	IfxCif_getJpeRestartInterval (void)
	Function to query the current restart interval. More...

IFX_INLINE IfxCif_JpeState	IfxCif_getJpeState (void)
	Function to get the current JPEG codec state. More...

IFX_INLINE IfxCif_JpeTableId	IfxCif_getJpeTableId (void)
	Function to query the current JPE Table ID. More...

IFX_INLINE IfxCif_JpegJfifStreamEncoderContinuousMode	IfxCif_getJpegJfifStreamEncoderContinuousMode (void)
	Function to query the current encoder continuous mode. More...

IFX_INLINE IfxCif_JpegPictureEncodingFormat	IfxCif_getJpegPictureEncodingFormat (void)
	Function to query the current picture encoding format. More...

IFX_INLINE void	IfxCif_initJpegEncoder (void)
	Function to immediately start the JPEG encoder. This function has to be called after IfxCif_startJpegJfifStreamEncoder to start the JPEG encoder. More...

IFX_INLINE void	IfxCif_jpeGenerateHeader (void)
	Function to start to generate JPEG stream header. Auto reset after one clock cycle. More...

IFX_INLINE void	IfxCif_setJpeHeaderGenerationMode (IfxCif_JpeHeaderGenerationMode headerGenerationMode)
	Function to set the header generation debug control mode. More...

IFX_INLINE void	IfxCif_setJpeHeaderMode (IfxCif_JpeHeaderMode headerMode)
	Function to set the JPE header mode. More...

IFX_INLINE void	IfxCif_setJpeRestartInterval (uint16 interval)
	Function to set the restart interval. More...

IFX_INLINE void	IfxCif_setJpeTableDataLsb (uint8 data)
	Function to set the JPE Table LSB. More...

IFX_INLINE void	IfxCif_setJpeTableDataMsb (uint8 data)
	Function to set the JPE Table MSB. More...

IFX_INLINE void	IfxCif_setJpeTableId (IfxCif_JpeTableId tableId)
	Function to set the JPE Table ID. More...

IFX_INLINE void	IfxCif_setJpegCodecImageSizes (uint16 hSize, uint16 vSize)
	Function to set the JPEG codec image sizes. More...

IFX_INLINE void	IfxCif_setJpegJfifStreamEncoderContinuousMode (IfxCif_JpegJfifStreamEncoderContinuousMode mode)
	Function to set the stream encoder continuous mode. More...

IFX_INLINE void	IfxCif_setJpegPictureEncodingFormat (IfxCif_JpegPictureEncodingFormat format)
	Function to set the picture encoding format. More...

IFX_INLINE void	IfxCif_startJpegJfifStreamEncoder (void)
	Function to start JFIF stream encoding. Auto reset after one clock cycle. More...

IFX_EXTERN void	IfxCif_clearJpeInterrupt (IfxCif_JpeInterruptSources interruptSource)
	Function to clear an interrupt. More...

IFX_EXTERN uint8	IfxCif_getHuffmanAcTableLength (IfxCif_HuffmanTables table)
	Function to query the currently set Huffman Table length for AC values. More...

IFX_EXTERN IfxCif_State	IfxCif_getHuffmanAcTableSelectorState (IfxCif_HuffmanTables table, IfxCif_HuffmanTableComponents component)
	Function to check if a Huffman Table and a Huffman Table component is enabled for AC values. More...

IFX_EXTERN uint8	IfxCif_getHuffmanDcTableLength (IfxCif_HuffmanTables table)
	Function to query the current Huffman Table length for DC values. More...

IFX_EXTERN IfxCif_State	IfxCif_getHuffmanDcTableSelectorState (IfxCif_HuffmanTables table, IfxCif_HuffmanTableComponents component)
	Function to check if a Huffman Table and a Huffman Table component is enabled for DC values. More...

IFX_EXTERN IfxCif_JpeDebugSignalState	IfxCif_getJpeDebugSignalState (IfxCif_JpeDebugSignalSources source)
	Function to query the state of one JPE debug signal source. More...

IFX_EXTERN IfxCif_State	IfxCif_getJpeInterruptEnableState (IfxCif_JpeInterruptSources interruptSource)
	Function to query the enabled state of an interrupt. More...

IFX_EXTERN IfxCif_JpeQTableSelector	IfxCif_getJpeQTableSelector (IfxCif_JpeQTableSelectorComponents component)
	Function to query the currently selected Q-Table for one component. More...

IFX_EXTERN IfxCif_State	IfxCif_getJpeScalingEnableState (IfxCif_JpeScalingValueSources source)
	Function to query the current enabled state of the scaling of an input value source. More...

IFX_EXTERN uint16	IfxCif_getJpegCodecImageSize (IfxCif_ImageTiers tier)
	Function to query the currently set JPEG codec image size of one tier. More...

IFX_EXTERN IfxCif_InterruptTriggeredState	IfxCif_getMaskedJpeInterruptTriggeredState (IfxCif_JpeInterruptSources interruptSource)
	Function to query the masked state of an interrupt. More...

IFX_EXTERN IfxCif_InterruptTriggeredState	IfxCif_getRawJpeInterruptTriggeredState (IfxCif_JpeInterruptSources interruptSource)
	Function to query the raw state of an interrupt. More...

IFX_EXTERN void	IfxCif_programJpeTable (IfxCif_JpeTableId tableId, const uint8 *tableEntry, uint8 length)

IFX_EXTERN void	IfxCif_setHuffmanAcTableLength (IfxCif_HuffmanTables table, uint8 length)
	Function to set the Huffman Table length for AC values. More...

IFX_EXTERN void	IfxCif_setHuffmanAcTableSelector (IfxCif_HuffmanTables table, IfxCif_HuffmanTableComponents component)
	Function to set the Huffman Table selector for AC Values. More...

IFX_EXTERN void	IfxCif_setHuffmanDcTableLength (IfxCif_HuffmanTables table, uint8 length)
	Function to set the Huffman Table length for DC values. More...

IFX_EXTERN void	IfxCif_setHuffmanDcTableSelector (IfxCif_HuffmanTables table, IfxCif_HuffmanTableComponents component)
	Function to set the Huffman Table selector for DC values. More...

IFX_EXTERN void	IfxCif_setJpeInterruptEnableState (IfxCif_JpeInterruptSources interruptSource, IfxCif_State interruptEnableState)
	Function to enable or disable an interrupt. More...

IFX_EXTERN void	IfxCif_setJpeInterruptRequestBit (IfxCif_JpeInterruptSources interruptSource)
	Function to set an interrupt request bit (does not necessarily trigger an interrupt) More...

IFX_EXTERN void	IfxCif_setJpeQTableSelector (IfxCif_JpeQTableSelectorComponents component, IfxCif_JpeQTableSelector selector)
	Function to set the Q-Table selector for one component. More...

IFX_EXTERN void	IfxCif_setJpeScalingEnableState (IfxCif_JpeScalingValueSources source, IfxCif_State scalingEnable)
	Function to enable or disable scaling of one input value source. More...

IFX_EXTERN void	IfxCif_setJpegCodecImageSize (IfxCif_ImageTiers tier, uint16 size)
	Function to set the JPEG codec image size of one tier. More...

Detailed Description

Function Documentation

IFX_EXTERN void IfxCif_clearJpeInterrupt ( IfxCif_JpeInterruptSources interruptSource)

Function to clear an interrupt.

Parameters

interruptSource Source of the interrupt

Returns: None

Definition at line 135 of file IfxCif.c.

IFX_EXTERN uint8 IfxCif_getHuffmanAcTableLength ( IfxCif_HuffmanTables table)

Function to query the currently set Huffman Table length for AC values.

Parameters

table Huffman Table for which to query the current length

Returns: Current length of Huffman Table

Definition at line 1032 of file IfxCif.c.

IFX_EXTERN IfxCif_State IfxCif_getHuffmanAcTableSelectorState	(	IfxCif_HuffmanTables	table,
		IfxCif_HuffmanTableComponents	component
	)

Function to check if a Huffman Table and a Huffman Table component is enabled for AC values.

Parameters

table	Huffman Table to check
component	Huffman Table component to check

Returns: IfxCif_State_Enabled if the queried Huffman Table and the Huffman Table component is selected, IfxCif_State_Disabled otherwise

Definition at line 1053 of file IfxCif.c.

IFX_EXTERN uint8 IfxCif_getHuffmanDcTableLength ( IfxCif_HuffmanTables table)

Function to query the current Huffman Table length for DC values.

Parameters

table Huffman Table for which to query the current length

Returns: Current length of Huffman Table

Definition at line 1080 of file IfxCif.c.

IFX_EXTERN IfxCif_State IfxCif_getHuffmanDcTableSelectorState	(	IfxCif_HuffmanTables	table,
		IfxCif_HuffmanTableComponents	component
	)

Function to check if a Huffman Table and a Huffman Table component is enabled for DC values.

Parameters

table	Huffman Table to check
component	Huffman Table component to check

Returns: IfxCif_State_Enabled if the queried Huffman Table and the Huffman Table component is selected, IfxCif_State_Disabled otherwise

Definition at line 1101 of file IfxCif.c.

IFX_EXTERN IfxCif_JpeDebugSignalState IfxCif_getJpeDebugSignalState ( IfxCif_JpeDebugSignalSources source)

Function to query the state of one JPE debug signal source.

Parameters

source Signal source for which to query the debug signal state

Returns: IfxCif_JpeDebugSignalState_Inactive if the debug signal is currently inactive, IfxCif_JpeDebugSignalState_Active if the debug signal is currently active

Definition at line 1530 of file IfxCif.c.

IFX_EXTERN uint16 IfxCif_getJpegCodecImageSize ( IfxCif_ImageTiers tier)

Function to query the currently set JPEG codec image size of one tier.

Parameters

tier	Tier for which to query the JPEG codec image size

Returns: Currently set image size for R2B and SGEN blocks

Definition at line 1646 of file IfxCif.c.

IFX_INLINE IfxCif_JpegJfifStreamEncoderContinuousMode IfxCif_getJpegJfifStreamEncoderContinuousMode ( void )

Function to query the current encoder continuous mode.

Returns: Current encoder continuous mode (one member of IfxCif_JpegJfifStreamEncoderContinuousMode)

Definition at line 2597 of file IfxCif.h.

IFX_INLINE IfxCif_JpegPictureEncodingFormat IfxCif_getJpegPictureEncodingFormat ( void )

Function to query the current picture encoding format.

Returns: Current picture encoding format

Definition at line 2603 of file IfxCif.h.

IFX_INLINE IfxCif_JpeHeaderGenerationMode IfxCif_getJpeHeaderGenerationMode ( void )

Function to query the current header generation debug control mode.

Returns: Currently set header generation debug control mode (one member of IfxCif_JpeHeaderGenerationMode)

Definition at line 2561 of file IfxCif.h.

IFX_INLINE IfxCif_JpeHeaderMode IfxCif_getJpeHeaderMode ( void )

Function to query the currently set JPE header mode.

Returns: Currently set JPE header mode (one member of IfxCif_JpeHeaderMode)

Definition at line 2567 of file IfxCif.h.

IFX_EXTERN IfxCif_State IfxCif_getJpeInterruptEnableState ( IfxCif_JpeInterruptSources interruptSource)

Function to query the enabled state of an interrupt.

Parameters

interruptSource Source of the interrupt

Returns: IfxCif_State_Enabled if the interrupt is enabled, IfxCif_State_Disabled if the interrupt is disabled

Definition at line 1563 of file IfxCif.c.

IFX_INLINE IfxCif_State IfxCif_getJpeMode ( void )

Function to query the JPE encode mode.

Returns: Always 1, because this is the encoder only edition

Definition at line 2573 of file IfxCif.h.

IFX_EXTERN IfxCif_JpeQTableSelector IfxCif_getJpeQTableSelector ( IfxCif_JpeQTableSelectorComponents component)

Function to query the currently selected Q-Table for one component.

Parameters

component Component for which to query the currently selected Q-Table

Returns: Currently selected Q-Table

Definition at line 1600 of file IfxCif.c.

IFX_INLINE uint16 IfxCif_getJpeRestartInterval ( void )

Function to query the current restart interval.

Returns: Current restart interval

Definition at line 2579 of file IfxCif.h.

IFX_EXTERN IfxCif_State IfxCif_getJpeScalingEnableState ( IfxCif_JpeScalingValueSources source)

Function to query the current enabled state of the scaling of an input value source.

Parameters

source Input value source for which to query the enabled state

Returns: IfxCif_State_Enabled if scaling is enabled, IfxCif_State_Disabled if scaling is disabled

Definition at line 1625 of file IfxCif.c.

IFX_INLINE IfxCif_JpeState IfxCif_getJpeState ( void )

Function to get the current JPEG codec state.

Returns: IfxCif_JpeState_Busy if the JPEG codec is currently processing, IfxCif_JpeState_Free if the JPEG codec is currently free

Definition at line 2585 of file IfxCif.h.

IFX_INLINE IfxCif_JpeTableId IfxCif_getJpeTableId ( void )

Function to query the current JPE Table ID.

Returns: Current JPE Table ID

Definition at line 2591 of file IfxCif.h.

IFX_EXTERN IfxCif_InterruptTriggeredState IfxCif_getMaskedJpeInterruptTriggeredState ( IfxCif_JpeInterruptSources interruptSource)

Function to query the masked state of an interrupt.

Parameters

interruptSource Source of the interrupt

Returns: IfxCif_InterruptTriggeredState_Triggered if the interrupt request bit is set and the interrupt is enabled, IfxCif_InterruptTriggeredState_Triggered if the interrupt request bit is not set or the interrupt is disabled

Definition at line 1863 of file IfxCif.c.

IFX_EXTERN IfxCif_InterruptTriggeredState IfxCif_getRawJpeInterruptTriggeredState ( IfxCif_JpeInterruptSources interruptSource)

Function to query the raw state of an interrupt.

Parameters

interruptSource Source of the interrupt

Returns: IfxCif_InterruptTriggeredState_Triggered if the interrupt request bit is set, IfxCif_InterruptTriggeredState_NotTriggered if the interrupt request bit is not set

Definition at line 2358 of file IfxCif.c.

IFX_INLINE void IfxCif_initJpegEncoder ( void )

Function to immediately start the JPEG encoder. This function has to be called after IfxCif_startJpegJfifStreamEncoder to start the JPEG encoder.

Returns: None

Definition at line 2714 of file IfxCif.h.

IFX_INLINE void IfxCif_jpeGenerateHeader ( void )

Function to start to generate JPEG stream header. Auto reset after one clock cycle.

Returns: None

Definition at line 2720 of file IfxCif.h.

IFX_EXTERN void IfxCif_programJpeTable	(	IfxCif_JpeTableId	tableId,
		const uint8 *	tableEntry,
		uint8	length
	)

Returns: None

Definition at line 2613 of file IfxCif.c.

IFX_EXTERN void IfxCif_setHuffmanAcTableLength	(	IfxCif_HuffmanTables	table,
		uint8	length
	)

Function to set the Huffman Table length for AC values.

Parameters

table	Huffman Table for which to set the length
length	Length to set

Returns: None

Definition at line 3086 of file IfxCif.c.

Referenced by IfxCif_programJpeTable().

IFX_EXTERN void IfxCif_setHuffmanAcTableSelector	(	IfxCif_HuffmanTables	table,
		IfxCif_HuffmanTableComponents	component
	)

Function to set the Huffman Table selector for AC Values.

Parameters

table	Huffman Table to select
component	Huffman Table component to select

Returns: None

Definition at line 3103 of file IfxCif.c.

IFX_EXTERN void IfxCif_setHuffmanDcTableLength	(	IfxCif_HuffmanTables	table,
		uint8	length
	)

Function to set the Huffman Table length for DC values.

Parameters

table	Huffman Table for which to set the length
length	Length to set

Returns: None

Definition at line 3120 of file IfxCif.c.

Referenced by IfxCif_programJpeTable().

IFX_EXTERN void IfxCif_setHuffmanDcTableSelector	(	IfxCif_HuffmanTables	table,
		IfxCif_HuffmanTableComponents	component
	)

Function to set the Huffman Table selector for DC values.

Parameters

table	Huffman Table to select
component	Huffman Table component to select

Returns: None

Definition at line 3137 of file IfxCif.c.

IFX_EXTERN void IfxCif_setJpegCodecImageSize	(	IfxCif_ImageTiers	tier,
		uint16	size
	)

Function to set the JPEG codec image size of one tier.

Parameters

tier	Tier for which to set the JPEG codec image size
size	Image size for R2B and SGEN blocks

Returns: None

Definition at line 3523 of file IfxCif.c.

IFX_INLINE void IfxCif_setJpegCodecImageSizes	(	uint16	hSize,
		uint16	vSize
	)

Function to set the JPEG codec image sizes.

Parameters

hSize	Image horizontal size
vSize	Image vertical size

Returns: None

Definition at line 2925 of file IfxCif.h.

IFX_INLINE void IfxCif_setJpegJfifStreamEncoderContinuousMode ( IfxCif_JpegJfifStreamEncoderContinuousMode mode)

Function to set the stream encoder continuous mode.

Parameters

mode	Encoder continuous mode to set

Returns: None

Definition at line 2932 of file IfxCif.h.

IFX_INLINE void IfxCif_setJpegPictureEncodingFormat ( IfxCif_JpegPictureEncodingFormat format)

Function to set the picture encoding format.

Parameters

format Encoding format to set

Returns: None

Definition at line 2938 of file IfxCif.h.

IFX_INLINE void IfxCif_setJpeHeaderGenerationMode ( IfxCif_JpeHeaderGenerationMode headerGenerationMode)

Function to set the header generation debug control mode.

Parameters

headerGenerationMode Header generation debug control mode to set

Returns: None

Definition at line 2889 of file IfxCif.h.

IFX_INLINE void IfxCif_setJpeHeaderMode ( IfxCif_JpeHeaderMode headerMode)

Function to set the JPE header mode.

Parameters

headerMode Header mode to set

Returns: None

Definition at line 2895 of file IfxCif.h.

IFX_EXTERN void IfxCif_setJpeInterruptEnableState	(	IfxCif_JpeInterruptSources	interruptSource,
		IfxCif_State	interruptEnableState
	)

Function to enable or disable an interrupt.

Parameters

interruptSource	Source of the interrupt to enable or disable
interruptEnableState	IfxCif_State_Enabled to enable the interrupt, IfxCif_State_Disabled to disable the interrupt

Returns: None

Definition at line 3419 of file IfxCif.c.

IFX_EXTERN void IfxCif_setJpeInterruptRequestBit ( IfxCif_JpeInterruptSources interruptSource)

Function to set an interrupt request bit (does not necessarily trigger an interrupt)

Parameters

interruptSource Source of the interrupt

Returns: None

Definition at line 3452 of file IfxCif.c.

IFX_EXTERN void IfxCif_setJpeQTableSelector	(	IfxCif_JpeQTableSelectorComponents	component,
		IfxCif_JpeQTableSelector	selector
	)

Function to set the Q-Table selector for one component.

Parameters

component	Component for which to select the Q-Table
selector	Q-Table to select

Returns: None

Definition at line 3485 of file IfxCif.c.

IFX_INLINE void IfxCif_setJpeRestartInterval ( uint16 interval)

Function to set the restart interval.

Parameters

interval Restart interval to set

Returns: None

Definition at line 2901 of file IfxCif.h.

IFX_EXTERN void IfxCif_setJpeScalingEnableState	(	IfxCif_JpeScalingValueSources	source,
		IfxCif_State	scalingEnable
	)

Function to enable or disable scaling of one input value source.

Parameters

source	Input value source for which to query the enabled state
scalingEnable	IfxCif_State_Enabled to enable scaling, IfxCif_State_Disabled to disable scaling

Returns: None

Definition at line 3506 of file IfxCif.c.

IFX_INLINE void IfxCif_setJpeTableDataLsb ( uint8 data)

Function to set the JPE Table LSB.

Parameters

data	Value to set for the JPE Table LSB

Returns: None

Definition at line 2907 of file IfxCif.h.

IFX_INLINE void IfxCif_setJpeTableDataMsb ( uint8 data)

Function to set the JPE Table MSB.

Parameters

data	Value to set for the JPE Table MSB

Returns: None

Definition at line 2913 of file IfxCif.h.

IFX_INLINE void IfxCif_setJpeTableId ( IfxCif_JpeTableId tableId)

Function to set the JPE Table ID.

Parameters

tableId tableId Table ID to set

Returns: None

Definition at line 2919 of file IfxCif.h.

IFX_INLINE void IfxCif_startJpegJfifStreamEncoder ( void )

Function to start JFIF stream encoding. Auto reset after one clock cycle.

Returns: None

Definition at line 3013 of file IfxCif.h.