sl@0: #ifndef __IMON_DISPLAY_API_DEFINES_H__
sl@0: #define __IMON_DISPLAY_API_DEFINES_H__
sl@0: 
sl@0: //////////////////////////////////////////////////
sl@0: //////////////////////////////////////////////////
sl@0: //	Enumerations
sl@0: 
sl@0: /**DSPResult
sl@0: @brief	These enumeration values represent the returned result for iMON Display API function calls.\n
sl@0: 			All iMON Display API function calls return one of this result values.\n
sl@0: 			For meaning of each result, refer the comment of each line below*/
sl@0: enum DSPResult
sl@0: {
sl@0: 	DSP_SUCCEEDED = 0,				//// Function Call Succeeded Without Error
sl@0: 	DSP_E_FAIL,						//// Unspecified Failure
sl@0: 	DSP_E_OUTOFMEMORY,				//// Failed to Allocate Necessary Memory
sl@0: 	DSP_E_INVALIDARG,				//// One or More Arguments Are Not Valid
sl@0: 	DSP_E_NOT_INITED,				//// API is Not Initialized
sl@0: 	DSP_E_POINTER,					//// Pointer is Not Valid
sl@0: 
sl@0: 	DSP_S_INITED = 0x1000,			//// API is Initialized
sl@0: 	DSP_S_NOT_INITED,				//// API is Not Initialized
sl@0: 	DSP_S_IN_PLUGIN_MODE,			//// API Can Control iMON Display (Display Plug-in Mode)
sl@0: 	DSP_S_NOT_IN_PLUGIN_MODE,		//// API Can't Control iMON Display
sl@0: };
sl@0: 
sl@0: 
sl@0: /**DSPNInitResult
sl@0: @brief	These enumeration values represent the result status for requesting Display Plug-in Mode to iMON.\n
sl@0: 			iMON Display API notifies one of this result values to the caller application after requesting Display Plug-in Mode to iMON.\n
sl@0: 			For more information, refer the comment of each line below*/
sl@0: enum DSPNInitResult
sl@0: {
sl@0: 	DSPN_SUCCEEDED = 0,				//// Display Plug-in Mode is Initialized Successfully
sl@0: 	DSPN_ERR_IN_USED = 0x0100,		//// Display Plug-in is Already Used by Other Application
sl@0: 	DSPN_ERR_HW_DISCONNECTED,		//// iMON HW is Not Connected
sl@0: 	DSPN_ERR_NOT_SUPPORTED_HW,		//// The Connected iMON HW doesn't Support Display Plug-in
sl@0: 	DSPN_ERR_PLUGIN_DISABLED,		//// Display Plug-in Mode Option is Disabled
sl@0: 	DSPN_ERR_IMON_NO_REPLY,			//// The Latest iMON is Not Installed or iMON Not Running
sl@0: 	DSPN_ERR_UNKNOWN = 0x0200,		//// Unknown Failure
sl@0: };
sl@0: 
sl@0: 
sl@0: /**DSPType
sl@0: @brief	These enumeration values represent display type.\n
sl@0: 			Currently iMON Display API supports VFD and LCD products.*/
sl@0: enum DSPType
sl@0: {
sl@0: 	DSPN_DSP_NONE	= 0,
sl@0: 	DSPN_DSP_VFD	= 0x01,			//// VFD products
sl@0: 	DSPN_DSP_LCD	= 0x02,			//// LCD products
sl@0: };
sl@0: 
sl@0: 
sl@0: /**DSPNotifyCode
sl@0: @brief	These enumeration values represent the notification codes.\n
sl@0: 			iMON Display API will send or post message to the caller application.\n
sl@0: 			The caller application should assign the message and the winodw handle to receivce message with IMON_Display_Init fucntion.\n
sl@0: 			These enumeration values are used with WPARAM parameter of the message.\n 
sl@0: 			For more information, see the explanation of each notification code below*/
sl@0: enum DSPNotifyCode
sl@0: {
sl@0: 	/**DSPNM_PLUGIN_SUCCEED
sl@0: 	@brief	When API succeeds to get the control for the display, API will post caller-specified message with DSPNM_PLUGIN_SUCCEED as WPARAM parameter.\n
sl@0: 				LPARAM represents DSPType. This value can be 0x01 (VFD), 0x02 (LCD) or 0x03 (VFD+LCD).*/
sl@0: 	DSPNM_PLUGIN_SUCCEED = 0,
sl@0: 
sl@0: 	/**DSPNM_PLUGIN_FAILED
sl@0: 	@brief	When API fails to get the control for the display, API will post caller-specified message with DSPNM_PLUGIN_FAILED as WPARAM parameter.\n
sl@0: 				LPARAM represents error code with DSPNResult.*/
sl@0: 	DSPNM_PLUGIN_FAILED,
sl@0: 
sl@0: 	/**DSPNM_IMON_RESTARTED
sl@0: 	@brief	When iMON starts, API will post caller-specified message with DSPNM_IMON_RESTARTED as WPARAM parameter.\n
sl@0: 				LPARAM represents DSPType. This value can be 0 (No Display), 0x01 (VFD), 0x02 (LCD) or 0x03 (VFD+LCD).*/
sl@0: 	DSPNM_IMON_RESTARTED,
sl@0: 
sl@0: 	/**DSPNM_IMON_CLOSED
sl@0: 	@brief	When iMON closed, API will post caller-specified message with DSPNM_IMON_CLOSED as WPARAM parameter.\n
sl@0: 				LPARAM is not used.*/
sl@0: 	DSPNM_IMON_CLOSED,
sl@0: 
sl@0: 	/**DSPNM_HW_CONNECTED
sl@0: 	@brief	When iMON HW newly connected, API will post caller-specified message with DSPNM_HW_CONNECTED as WPARAM parameter.\n
sl@0: 				LPARAM represents DSPType. This value can be 0 (No Display), 0x01 (VFD), 0x02 (LCD) or 0x03 (VFD+LCD).*/
sl@0: 	DSPNM_HW_CONNECTED,
sl@0: 
sl@0: 	/**DSPNM_HW_DISCONNECTED
sl@0: 	@brief	When iMON HW disconnected, API will post caller-specified message with DSPNM_HW_DISCONNECTED as WPARAM parameter.\n
sl@0: 				LPARAM is DSPNResult value, DSPN_ERR_HW_DISCONNECTED.*/
sl@0: 	DSPNM_HW_DISCONNECTED,
sl@0: 
sl@0: 
sl@0: 	/**DSPNM_LCD_TEXT_SCROLL_DONE
sl@0: 	@brief	When iMON LCD finishes scrolling Text, API will post caller-specified message with DSPNM_LCD_TEXT_SCROLL_DONE as WPARAM parameter.\n
sl@0: 				The caller application may need to know when text scroll is finished, for sending next text.\n
sl@0: 				LPARAM is not used.*/
sl@0: 	DSPNM_LCD_TEXT_SCROLL_DONE = 0x1000,
sl@0: };
sl@0: 
sl@0: //////////////////////////////////////////////////
sl@0: //////////////////////////////////////////////////
sl@0: //	Structure
sl@0: 
sl@0: /**DspEqData
sl@0: @brief	This structure contains Equalizer data for 16 bands. 
sl@0: @param	BandData    It represents Equalizer data for 16 bands. Its range is from 0 to 100.*/
sl@0: typedef struct DspEqData
sl@0: {
sl@0: 	int BandData[16];
sl@0: 
sl@0: } DSPEQDATA, *PDSPEQDATA;
sl@0: 
sl@0: #endif	//__IMON_DISPLAY_API_DEFINES_H__