StephaneLenclud@9: #ifndef __IMON_DISPLAY_API_H__
StephaneLenclud@9: #define __IMON_DISPLAY_API_H__
StephaneLenclud@9: 
StephaneLenclud@9: ////////////////////////////////////
StephaneLenclud@9: //	includes
StephaneLenclud@9: /** iMONDisplayDefines.h
StephaneLenclud@9: This header file defines several enumerations. Open this file and check the definition and usage of enumerations and structures*/
StephaneLenclud@9: #include "iMONDisplayDefines.h"
StephaneLenclud@9: 
StephaneLenclud@9: #ifdef IMON_DISPLAY_API_EXPORT
StephaneLenclud@9: #define IMONDSPAPI __declspec(dllexport)
StephaneLenclud@9: #else
StephaneLenclud@9: #define IMONDSPAPI __declspec(dllimport)
StephaneLenclud@9: #endif
StephaneLenclud@9: 
StephaneLenclud@9: #ifdef __cplusplus
StephaneLenclud@9: extern "C" 
StephaneLenclud@9: {
StephaneLenclud@9: #endif	//__cplusplus
StephaneLenclud@9: 
StephaneLenclud@9: 	/////////////////////////////////////
StephaneLenclud@9: 	/////	Interfaces
StephaneLenclud@9: 	/**DSPResult IMON_Display_Init(HWND hwndNoti, UINT uMsgNotification)
StephaneLenclud@9: 	@brief	This function should be called to use other functions in iMON Display API.\n 
StephaneLenclud@9: 				When the caller application calls this function, API tries to request Display Plug-in Mode to iMON.
StephaneLenclud@9: 	@param	[in] hwndNoti	API will send/post message to this handle.
StephaneLenclud@9: 	@param	[in] uMsgNotification	API will send/post message to hwndNoti with this message identifier.
StephaneLenclud@9: 	@return	This function will return one of DSPResult enumeration value.\n
StephaneLenclud@9: 				DSP_SUCCEEDED will be returned if succeeded. DSP_E_INVALIDARG or DSP_E_OUTOFMEMORY can be returned when error occurs.*/
StephaneLenclud@9: 	IMONDSPAPI DSPResult IMON_Display_Init(HWND hwndNoti, UINT uMsgNotification);
StephaneLenclud@9: 
StephaneLenclud@9: 	/**DSPResult IMON_Display_Uninit()
StephaneLenclud@9: 	@brief	This function should be called when the caller application need not use this API any more.\n 
StephaneLenclud@9: 				If this function call is missed, iMON can't display other information.\n
StephaneLenclud@9: 	@return	This function will return one of DSPResult enumeration value.\n
StephaneLenclud@9: 				DSP_SUCCEEDED will be returned if succeeded.*/
StephaneLenclud@9: 	IMONDSPAPI DSPResult IMON_Display_Uninit();
StephaneLenclud@9: 
StephaneLenclud@9: 	/**DSPResult IMON_Display_IsInited()
StephaneLenclud@9: 	@brief	This function can be used when the caller application wants to know if API is initialized.\n 
StephaneLenclud@9: 	@return	This function will return one of DSPResult enumeration value.\n
StephaneLenclud@9: 				If API is initialized, this call will return DSP_S_INITED. Otherwise DSP_S_NOT_INITED will be returned.*/
StephaneLenclud@9: 	IMONDSPAPI DSPResult IMON_Display_IsInited();
StephaneLenclud@9: 
StephaneLenclud@9: 	/**DSPResult IMON_Display_IsPluginModeEnabled()
StephaneLenclud@9: 	@brief	This function can be used when the caller application wants to know if API can control iMON display.\n
StephaneLenclud@9: 	@return	This function will return one of DSPResult enumeration value.\n
StephaneLenclud@9: 				If API can control iMON display, this call will return DSP_S_IN_PLUGIN_MODE. Otherwise DSP_S_NOT_IN_PLUGIN_MODE will be returned.*/
StephaneLenclud@9: 	IMONDSPAPI DSPResult IMON_Display_IsPluginModeEnabled();
StephaneLenclud@9: 
StephaneLenclud@9: 
StephaneLenclud@9: 	/**DSPResult IMON_Display_SetVfdText(LPCTSTR lpsz1stLine, LPCTSTR lpsz2ndLine)
StephaneLenclud@9: 	@brief	This function can be used when the caller application wants to display text data on VFD module.\n
StephaneLenclud@9: 	@param	[in] lpsz1stLine	This string data will be displayed on the 1st line of VFD module.\n
StephaneLenclud@9: 									It doesn't support multi-byte character and if string data is longer than 16 characters, it displays 16 characters from the first.\n
StephaneLenclud@9: 	@param	[in] lpsz2ndLine	This string data will be displayed on the 2nd line of VFD module.\n
StephaneLenclud@9: 									It doesn't support multi-byte character and if string data is longer than 16 characters, it displays 16 characters from the first.\n
StephaneLenclud@9: 	@return	This function will return one of DSPResult enumeration value.\n
StephaneLenclud@9: 				DSP_SUCCEEDED will be returned if succeeded. DSP_E_POINTER, DSP_E_NOT_INITED or DSP_E_FAIL can be returned if failed.*/
StephaneLenclud@9: 	IMONDSPAPI DSPResult IMON_Display_SetVfdText(LPCTSTR lpsz1stLine, LPCTSTR lpsz2ndLine);
StephaneLenclud@9: 
StephaneLenclud@9: 	/**DSPResult IMON_Display_SetVfdEqData(PDSPEQDATA pEqData)
StephaneLenclud@9: 	@brief	This function can be used when the caller application wants to display equalizer data on VFD module.\n
StephaneLenclud@9: 	@param	[in] pEqData	Pointer of DSPEQDATA structure. The caller application should fill this structure with the equalizer data for 16 bands.\n
StephaneLenclud@9: 	@return	This function will return one of DSPResult enumeration value.\n
StephaneLenclud@9: 				DSP_SUCCEEDED will be returned if succeeded. DSP_E_POINTER, DSP_E_NOT_INITED or DSP_E_FAIL can be returned if failed.*/
StephaneLenclud@9: 	IMONDSPAPI DSPResult IMON_Display_SetVfdEqData(PDSPEQDATA pEqData);
StephaneLenclud@9: 
StephaneLenclud@9: 
StephaneLenclud@9: 	/**DSPResult IMON_Display_SetLcdText(LPCTSTR lpszText)
StephaneLenclud@9: 	@brief	This function can be used when the caller application wants to display text data on LCD module.\n
StephaneLenclud@9: 	@param	[in] lpszText	This string data will be displayed on the LCD module.\n
StephaneLenclud@9: 									It supports multi-byte character and if string data is longer than display area, it will start to scroll.\n
StephaneLenclud@9: 									When text scrolling is finished, API will notify it with DSPNotifyCode enumeration value, DSPNM_LCD_TEXT_SCROLL_DONE.\n
StephaneLenclud@9: 	@return	This function will return one of DSPResult enumeration value.\n
StephaneLenclud@9: 				DSP_SUCCEEDED will be returned if succeeded. DSP_E_POINTER, DSP_E_NOT_INITED or DSP_E_FAIL can be returned if failed.*/
StephaneLenclud@9: 	IMONDSPAPI DSPResult IMON_Display_SetLcdText(LPCTSTR lpszText);
StephaneLenclud@9: 
StephaneLenclud@9: 	/**DSPResult IMON_Display_SetLcdEqData(PDSPEQDATA pEqDataL, PDSPEQDATA pEqDataR)
StephaneLenclud@9: 	@brief	This function can be used when the caller application wants to display equalizer data on LCD module.\n
StephaneLenclud@9: 	@param	[in] pEqDataL    Pointer of DSPEQDATA structure. This parameter represents equalizer data of left channel.\n
StephaneLenclud@9: 								 The caller application should fill this structure with the equalizer data of left channel for 16 bands.\n
StephaneLenclud@9: 	@param	[in] pEqDataR    Pointer of DSPEQDATA structure. This parameter represents equalizer data of right channel.\n
StephaneLenclud@9: 								 The caller application should fill this structure with the equalizer data of right channel for 16 bands.\n
StephaneLenclud@9: 	@return	This function will return one of DSPResult enumeration value.\n
StephaneLenclud@9: 				DSP_SUCCEEDED will be returned if succeeded. DSP_E_POINTER, DSP_E_NOT_INITED or DSP_E_FAIL can be returned if failed.*/
StephaneLenclud@9: 	IMONDSPAPI DSPResult IMON_Display_SetLcdEqData(PDSPEQDATA pEqDataL, PDSPEQDATA pEqDataR);
StephaneLenclud@9: 
StephaneLenclud@9: 
StephaneLenclud@9: 	/**DSPResult IMON_Display_SetLcdAllIcons(BOOL bOn)
StephaneLenclud@9: 	@brief	This function can be used when the caller application wants to turn on/off all icons on LCD module.\n
StephaneLenclud@9: 	@param	[in] bOn    If this value is TRUE, iMON will turn on all icons. Otherwise, iMON will turn off all icons.\n
StephaneLenclud@9: 	@return	This function will return one of DSPResult enumeration value.\n
StephaneLenclud@9: 				DSP_SUCCEEDED will be returned if succeeded. DSP_E_NOT_INITED or DSP_E_FAIL can be returned if failed.*/
StephaneLenclud@9: 	IMONDSPAPI DSPResult IMON_Display_SetLcdAllIcons(BOOL bOn);
StephaneLenclud@9: 
StephaneLenclud@9: 	/**DSPResult IMON_Display_SetLcdOrangeIcon(BYTE btIconData1, BYTE btIconData2)
StephaneLenclud@9: 	@brief	This function can be used when the caller application wants to turn on/off orange shaped disk icons on the upper left part of LCD module.\n
StephaneLenclud@9: 				Disk icons consist of 8 pieces of orange and orange peel.\n
StephaneLenclud@9: 	@param	[in] btIconData1    Each bit represents one of icons shaped the piece of orange.\n
StephaneLenclud@9: 									MSB is used for the piece placed on top and the remaining bits are for the piece placed in CCW from top.\n
StephaneLenclud@9: 	@param	[in] btIconData2    MSB represents the orange peel shaped icon. Other bits are not used.\n
StephaneLenclud@9: 	@return	This function will return one of DSPResult enumeration value.\n
StephaneLenclud@9: 				DSP_SUCCEEDED will be returned if succeeded. DSP_E_NOT_INITED or DSP_E_FAIL can be returned if failed.*/
StephaneLenclud@9: 	IMONDSPAPI DSPResult IMON_Display_SetLcdOrangeIcon(BYTE btIconData1, BYTE btIconData2);
StephaneLenclud@9: 
StephaneLenclud@9: 	/**DSPResult IMON_Display_SetLcdMediaTypeIcon(BYTE btIconData)
StephaneLenclud@9: 	@brief	This function can be used when the caller application wants to turn on/off media type icons on the upper part of LCD module.\n
StephaneLenclud@9: 	@param	[in] btIconData    Each bit represents one of media type icons. From MSB each bit represents MUSIC, MOVIE, PHOTO, CD/DVD, TV, WEBCASTING and NEWS/WEATHER icon.\n
StephaneLenclud@9: 	@return	This function will return one of DSPResult enumeration value.\n
StephaneLenclud@9: 				DSP_SUCCEEDED will be returned if succeeded. DSP_E_NOT_INITED or DSP_E_FAIL can be returned if failed.*/
StephaneLenclud@9: 	IMONDSPAPI DSPResult IMON_Display_SetLcdMediaTypeIcon(BYTE btIconData);
StephaneLenclud@9: 
StephaneLenclud@9: 	/**DSPResult IMON_Display_SetLcdSpeakerIcon(BYTE btIconData1, BYTE btIconData2)
StephaneLenclud@9: 	@brief	This function can be used when the caller application wants to turn on/off speaker icons on the upper right part of LCD module.\n
StephaneLenclud@9: 	@param	[in] btIconData1    Each bit represents one of speaker icons.\nFrom MSB each bit represents L, C, R, SL, LFE, SR, RL and SPDIF icon.
StephaneLenclud@9: 	@param	[in] btIconData2    MSB represents RR icon. Other bits are not used.\n
StephaneLenclud@9: 	@return	This function will return one of DSPResult enumeration value.\n
StephaneLenclud@9: 				DSP_SUCCEEDED will be returned if succeeded. DSP_E_NOT_INITED or DSP_E_FAIL can be returned if failed.*/
StephaneLenclud@9: 	IMONDSPAPI DSPResult IMON_Display_SetLcdSpeakerIcon(BYTE btIconData1, BYTE btIconData2);
StephaneLenclud@9: 
StephaneLenclud@9: 	/**DSPResult IMON_Display_SetLcdVideoCodecIcon(BYTE btIconData)
StephaneLenclud@9: 	@brief	This function can be used when the caller application wants to turn on/off codec icons for video file on the lower part of LCD module.\n
StephaneLenclud@9: 	@param	[in] btIconData    Each bit represents one of video codec icons. From MSB each bit represents MPG, DIVX, XVID, WMV, MPG, AC3, DTS and WMA icon.\n
StephaneLenclud@9: 	@return	This function will return one of DSPResult enumeration value.\n
StephaneLenclud@9: 				DSP_SUCCEEDED will be returned if succeeded. DSP_E_NOT_INITED or DSP_E_FAIL can be returned if failed.*/
StephaneLenclud@9: 	IMONDSPAPI DSPResult IMON_Display_SetLcdVideoCodecIcon(BYTE btIconData);
StephaneLenclud@9: 
StephaneLenclud@9: 	/**DSPResult IMON_Display_SetLcdAudioCodecIcon(BYTE btIconData)
StephaneLenclud@9: 	@brief	This function can be used when the caller application wants to turn on/off codec icons for audio file on the lower part of LCD module.\n
StephaneLenclud@9: 	@param	[in] btIconData    Each bit represents one of audio codec icons. From MSB each bit represents MP3, OGG, WMA and WAV icon.\n
StephaneLenclud@9: 	@return	This function will return one of DSPResult enumeration value.\n
StephaneLenclud@9: 				DSP_SUCCEEDED will be returned if succeeded. DSP_E_NOT_INITED or DSP_E_FAIL can be returned if failed.*/
StephaneLenclud@9: 	IMONDSPAPI DSPResult IMON_Display_SetLcdAudioCodecIcon(BYTE btIconData);
StephaneLenclud@9: 
StephaneLenclud@9: 	/**DSPResult IMON_Display_SetLcdAspectRatioIcon(BYTE btIconData)
StephaneLenclud@9: 	@brief	This function can be used when the caller application wants to turn on/off aspect ratio icons on the lower right part of LCD module.\n
StephaneLenclud@9: 	@param	[in] btIconData    Each bit represents one of aspect ratio icons. From MSB each bit represents SRC, FIT, TV, HDTV, SCR1 and SCR2 icon.\n
StephaneLenclud@9: 	@return	This function will return one of DSPResult enumeration value.\n
StephaneLenclud@9: 				DSP_SUCCEEDED will be returned if succeeded. DSP_E_NOT_INITED or DSP_E_FAIL can be returned if failed.*/
StephaneLenclud@9: 	IMONDSPAPI DSPResult IMON_Display_SetLcdAspectRatioIcon(BYTE btIconData);
StephaneLenclud@9: 
StephaneLenclud@9: 	/**DSPResult IMON_Display_SetLcdEtcIcon(BYTE btIconData)
StephaneLenclud@9: 	@brief	This function can be used when the caller application wants to turn on/off icons on the lower left part of LCD module.\n
StephaneLenclud@9: 	@param	[in] btIconData    Each bit represents icon. From MSB each bit represents REPEAT, SHUFFLE, ALARM, REC, VOL and TIME icon.\n
StephaneLenclud@9: 	@return	This function will return one of DSPResult enumeration value.\n
StephaneLenclud@9: 				DSP_SUCCEEDED will be returned if succeeded. DSP_E_NOT_INITED or DSP_E_FAIL can be returned if failed.*/
StephaneLenclud@9: 	IMONDSPAPI DSPResult IMON_Display_SetLcdEtcIcon(BYTE btIconData);
StephaneLenclud@9: 
StephaneLenclud@9: 	/**DSPResult IMON_Display_SetLcdProgress(int nCurPos, int nTotal)
StephaneLenclud@9: 	@brief	This function can be used when the caller application wants to display progress bar on the upper and lower left part of text area of LCD module.\n
StephaneLenclud@9: 	@param	[in] nCurPos   It represents the current position of progress bar.\n
StephaneLenclud@9: 	@param	[in] nTotal    It represents the total length of progress bar.\n
StephaneLenclud@9: 	@return	This function will return one of DSPResult enumeration value.\n
StephaneLenclud@9: 				DSP_SUCCEEDED will be returned if succeeded. DSP_E_NOT_INITED or DSP_E_FAIL can be returned if failed.*/
StephaneLenclud@9: 	IMONDSPAPI DSPResult IMON_Display_SetLcdProgress(int nCurPos, int nTotal);
StephaneLenclud@9: 
StephaneLenclud@9: #ifdef __cplusplus
StephaneLenclud@9: }
StephaneLenclud@9: #endif	//__cplusplus
StephaneLenclud@9: 
StephaneLenclud@9: #endif	//__IMON_DISPLAY_API_H__