PhysicalDevice/Detector/Yuying/DIOS.Dev.FPD.YuyingDR/SDK/include/YuYingAPI.h

#ifndef _YUYING_API_H_
#define _YUYING_API_H_

#include "YuYingDefinition.h"



#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */


	/********************************************************************************************************************
	**********************************************通 用 接 口****************************************************************
	**********************************************************************************************************************/

/*------------ 1、工作流相关函数--------------*/
	/**
	* \brief  初始化函数，必须第一个调用
	* \outDeviceID 输出参数，为设备标识 
	*/
	  int _stdcall   YI_Initialize_FPD_V4(
		const char *ipAddressLocal,
		int iPortLocal,
		const char *ipAddressRemote,
		int iPortRemote,
		char outDeviceID[100]);

//注意：此函数在老版本使用，建议新版本所有本公司平板都使用YI_Initialize_FPD_V4进行初始化
	  int _stdcall YI_Initialize_Wireless_Client_V4(
		const char* ipAddressRemote,
		int iPortRemote,
		char outDeviceID[100]);

	/**
	* \brief 设置平板探测器工作模式
	*/
	  int _stdcall YI_FPD_Set_Work_Mode(const char* sDeviceID, ModeType eModeType);

	/**
	* \brief 停止采集
	* \静态平板探测器：software模式下，且在采集数量大于1时可用。
    * \动态平板探测器：freerun模式下可用。
	*/
	  int _stdcall YI_FPD_Stop_Capture_Image(const char* sDeviceID);

/*------------ 2、读写平板探测器配置相关的函数--------------*/

	// 当前只支持：iSpeedMode 设置为0， iFPDMemoryType设置为1
	  int _stdcall YI_FPD_Get_Configure_Common(const char* sDeviceID, int iFPDMemoryType, YIConfigInfo_Common* configInfo);
	  int _stdcall YI_FPD_Set_Configure_Common(const char* sDeviceID, int iFPDMemoryType, const YIConfigInfo_Common* configInfo);
	  int _stdcall YI_FPD_Get_Configure_SyncOut_Mode(const char* sDeviceID, int iSpeedMode, int iFPDMemoryType,
		YIConfigInfo_SyncOut* configInfo);
	  int _stdcall YI_FPD_Set_Configure_SyncOut_Mode(const char* sDeviceID, int iSpeedMode, int iFPDMemoryType,
		const YIConfigInfo_SyncOut* configInfo);
	/**
	* \brief 重置平板探测器参数，恢复默认值
	*/
	  int _stdcall YI_FPD_Restore_Factory_Settings(const char*  sDeviceID);

/*------------ 3、图像校正相关函数--------------*/

	/**
	* \brief 设置平板探测器对图像做offset
	*/
	  int _stdcall YI_FPD_Subtract_Offset(const char * sDeviceID, bool bValue);


/*------------ 4、回调函数注册函数--------------*/
	/**
	* \brief 注册图像回调函数
	*        YI_ImageReady_Callback_Register，YI_ImageReady_Callback_Register_Ex只能选择一个使用
	*        建议使用YI_ImageReady_Callback_Register_Ex
	* \param  sDeviceID：设备标识
	*         callBackFunc: 回调函数
	* \return
	*/
	  int _stdcall YI_ImageReady_Callback_Register(const char* sDeviceID,
		ImageReadyCallbackFunc callBackFunc);

	  int _stdcall YI_ImageReady_Callback_Register_Ex(const char* sDeviceID,
		  ImageReadyCallbackFuncEx callBackFunc);
	/**
	* \brief  注册平板信息回调函数
	*         YI_SystemInfo_Callback_Register_Ex，YI_SystemInfo_Callback_Register只能选择一个使用
	*         建议使用YI_SystemInfo_Callback_Register_Ex
	* \param  sDeviceID：设备标识
	*         callBackFunc: 回调函数
	* \return
	*/
	  int _stdcall YI_SystemInfo_Callback_Register(const char* sDeviceID,
		SystemInfoCallbackFunc callBackFunc);
		
	  int _stdcall YI_SystemInfo_Callback_Register_Ex(const char* sDeviceID,
		  SystemInfoCallbackFuncEx callBackFunc);

/*------------ 5、帮助函数--------------*/

	/**
	* \brief 获取当前返回图像数据的大小，客户可以根据此数值设置图像缓存大小
	* \param  [out] 图像数据的大小，单位（字节）
	*/
	  int _stdcall YI_Get_Callback_Image_Size(const char* sDeviceID,
		int& iWidth, int& iHeight, int& iBytesOfPerPixel);

	/**
	* \brief 当其他函数返回值为0时，调用此函数获取错误信息
	*/
	  SystemErrorCode  _stdcall YI_GetLastErrorCode();

	/**
	* \brief 设置是否写log文件
	* \param  [in] 保存log文件的文件夹路径
	*/
	  int _stdcall YI_Set_Save_Log_Flag(bool bSave, const char* sFloderPath);


	/**
	* \brief 获取本机所有的v4 ip地址
	* \param iPs 使用时定义char *p=nullptr,以&p作为输入参数。
	*            不需要用户释放。
	* \          p中包含的IPV4地址用分号(;)分隔
	* \return ResultType::Succeed 获取地址成功
	*         ResultType::Failed 获取地址失败
	*/
	  int  _stdcall YI_GetLoacalIPs_V4(char** iPs);

	/**
	* \brief 设置是否需要保存获取到的图像
	* \param  bValue true 保存， false 不保存
	*/
	  int _stdcall YI_Set_Image_Save_State(const char* sDeviceID, bool bValue);

	/**
	* \brief 设置保存图像的路径，如果需要保存图像但是没有设置路径，那么会默认保存到当前目录下
	*/
	  int _stdcall YI_Set_Image_Save_Path(const char* sDeviceID, const char* savePath);

	/**
	* \brief 获取当前平板探测器类型
	* \param iType -1 未知， 0 静态， 1 千兆动态
	*/
	  int _stdcall YI_FPD_Get_FPD_TYPE(const char* sDeviceID, int& iType);

	/**
	* \brief 获取当前平板探测器无效的行列数，左上右下的顺序
	* \param iLeft   左边无效的列数
	* \param iTop    上边无效的行数
	* \param iRight  右边无效的列数
	* \param iBotton 下边无效的行数
	*/
	  int _stdcall YI_FPD_Get_Invalid_Region(const char* sDeviceID, int& iLeft, int& iTop, int& iRight, int& iBottom);
	/**
	* \brief 将配置信息保存到ini文件，以及从ini文件读取配置信息
	* \param sSavePath用户需要确认路径及文件存在
	*/
	  int _stdcall YI_FPD_Write_Configure_Common_To_File(const char* sSavePath, const YIConfigInfo_Common* configInfo);
	  int _stdcall YI_FPD_Read_Configure_Common_From_File(const char* sSavePath, YIConfigInfo_Common* configInfo);
	  int _stdcall YI_FPD_Write_Configure_SyncOut_To_File(const char* sSavePath, int iSpeedMode, const YIConfigInfo_SyncOut* configInfo);
	  int _stdcall YI_FPD_Read_Configure_SyncOut_From_File(const char* sSavePath, int iSpeedMode, YIConfigInfo_SyncOut* configInfo);


	/********************************************************************************************************************
	**********************************************静 态 探 测 器 特 有 接 口*******************************************************
	**********************************************************************************************************************/

/*------------ 1、工作流相关函数--------------*/
	  int _stdcall YI_FPD_Capture_Image(const char* sDeviceID, int iNumber = 1);

	/**
	  * \brief 此函数只在Industry_Mode模式下使用。
	  * \ 注释：调用此函数后，当收到SystemInfoCode::SIC_FPD_IndustryMode_Prepare_Rready提示信息，即可开始曝光，曝光结束以后，调用YI_FPD_Capture_Image获取图像
	  */
	  int _stdcall YI_FPD_Capture_Prepare(const char* sDeviceID);
/*------------ 2、图像校正相关的函数--------------*/

	  int _stdcall YI_Load_Gain_Tmp_File(const char* sDeviceID, const char* sPath);
	  int _stdcall YI_Load_Defect_Tmp_File(const char* sDeviceID, const char* sPath);
	  int _stdcall YI_Load_Offset_Tmp_File(const char* sDeviceID, const char* sPath);
	  int _stdcall YI_Load_AED_Offset_Tmp_File(const char* sDeviceID, const char* sPath);

	  int _stdcall YI_Set_Correct_Type(const char* sDeviceID, int iType);

	/**
	* \brief 直接调用校正模版对指定的raw图像进行校正
	* \param [in/out] pRawData
	* \return
	*/
	  int _stdcall YI_FPD_DO_Correction(
		unsigned short* pRawData, int iWidth, int iHeight, char cType,
		const char* pGainFilePath,
		const char* pDefectFilePath,
		const char* pOffsetFilePath,
		const char* pAEDOffsetFilePaht);


	/********************************************************************************************************************
	**********************************************动 态 探 测 器 特 有 接 口*******************************************************
	**********************************************************************************************************************/
/*------------ 1、工作流相关函数--------------*/
	/**
	* \brief freerun模式下，启动和停止连续采集
	*/
	  int _stdcall YI_FPD_Continual_Capture_Image(const char* sDeviceID);
	  int _stdcall YI_FPD_Stop_Capture_Image(const char* sDeviceID);

	/**
	* \brief sync in模式下使用
	*/
	  int _stdcall YI_FPD_Sync_In_Start(const char* sDeviceID);
	  int _stdcall YI_FPD_Sync_In_Stop(const char* sDeviceID);

	/**
	* \brief 从PC上传校正模板到平板探测器
	* \param [in] iMemoryType 当前只支持输入0 
	* \param [in] pFolderPath 校正模板所在文件夹路径，会将文件夹内的校正模板逐个上传
	* \param [in] callBackFunc 回调函数，用于显示上传进度
	*/
	  int _stdcall YI_Upload_Correct_Files(const char* sDeviceID, 
		int iMemoryType, const char* pFolderPath, ProgressCallbackFunc callBackFunc);

	int _stdcall YI_FPD_Set_Binning_Mode(const char* sDeviceID, BinningModeTypes mode);
	/********************************************************************************************************************
	**********************************************无 线 状 态 下 特 有 接 口***************************************************
	**********************************************************************************************************************/
	/**
	* \brief 在调用初始化函数已经成功的情况下，如果tcp意外断开了，使用此函数重新建立连接
	* \param [in] sDeviceID 设备标识
	* \param [in] ipAddressRemote 服务器端的ip地址
	* \param [in] iPortRemote 服务器端的端口值
	*/
	  int _stdcall YI_FPD_Wifi_Re_Connect(const char* sDeviceID,
		const char *ipAddressRemote,
		int iPortRemote);

	/**
	* \brief 设置/获取无线模块的工作模式
	* \param [in] sDeviceID 设备标识
	* \param [in] iMode 0表示ap模式，1表示sta模式
	*/
	  int _stdcall YI_FPD_Wifi_Set_Work_Mode(const char* sDeviceID, int iMode);
	  int _stdcall YI_FPD_Wifi_Get_Work_Mode(const char* sDeviceID, int& iMode);
	/**
	* \brief 设置无线模块AP模式下，wifi名字
	* \param [in] sDeviceID 设备标识
	*/
	  int _stdcall YI_FPD_Wifi_Set_Name(const char* sDeviceID,
		const char* pName);

	  /**
	  * \brief 无线平板探测器关机
	  * \param [in] sDeviceID 设备标识
	  */
	  int _stdcall YI_FPD_Wifi_Set_Power_Down(const char* sDeviceID);

	/**
	* \brief 设置无线平板探测器IP地址
	* \param [in] sDeviceID 设备标识
	* \param [in] pIpAddress ip地址，比如ip地址是192.168.7.1，那么pIpAddress[0]-[4]分别为192,168,7,1
	*/
	  int _stdcall YI_FPD_Wifi_Set_IP_Address(const char* sDeviceID, int pIpAddress[4]);

	  /**
	  * \brief 设置无线平板探测器IP地址
	  * \param [in] sDeviceID 设备标识
	  * \param [in] pName 路由器的wifi名称
	  * \param [in] pPassword 路由器的wifi密码
	  */
	  int _stdcall YI_FPD_Wifi_Set_Route_Info(const char* sDeviceID, char* pName, char* pPassword);
	  
	   /************************** 多帧叠加相关函数***********************************/
	  /**
	  * 多帧叠加功能说明：
	  * 1 首先调用YI_FPD_Wifi_MFM_Prepare，当返回值为1，并且收到SystemInfoCode::SIC_FPD_MFM_Prepare_Ready提示后，
	  *   再调用YI_FPD_Wifi_MFM_Capture获取图像
	  * 2 获取图像过程中，并且收到SystemInfoCode::SIC_FPD_MultiFrame_Index可以提示进度信息
	  */
	  
	  /**
	  * \brief [多帧叠加相关功能] 准备工作
	  * \param [in] sDeviceID 设备标识
	  */
	  int _stdcall YI_FPD_Wifi_MFM_Prepare(const char* sDeviceID);
	  /**
	  * \brief [多帧叠加相关功能] 开始采集命令，会根据YI_FPD_Wifi_MFM_Set_Config设置的参数来采集相应的帧数。
	  * \param [in] sDeviceID 设备标识
	  */
	  int _stdcall YI_FPD_Wifi_MFM_Capture(const char* sDeviceID);

	  /**
	  * \brief [多帧叠加相关功能] 设置和获取当前多帧叠加相关配置。
	  * \param [in] sDeviceID 设备标识
	  * \note : 设置参数时需要先调用YI_FPD_Wifi_MFM_Get_Config，并且返回值为1，再调用YI_FPD_Wifi_MFM_Set_Config 
	  */
	  int _stdcall YI_FPD_Wifi_MFM_Set_Config(const char* sDeviceID, MFMConfig* type);

	  int _stdcall YI_FPD_Wifi_MFM_Get_Config(const char* sDeviceID, MFMConfig* type);

	/********************************************************************************************************************
	**********************************************SD 卡 操 作 相 关 接 口*****************************************************
	**********************************************************************************************************************/

	/**
	* \brief 设置保存SD卡数据的文件夹路径
	* \param [out] iImgNum 输出当前SD卡存储图像的数量
	*/
	  int _stdcall YI_FPD_SD_Read_Image_Number(const char* sDeviceID,
		int& iImgNum);

	/**
	* \brief 设置读取图像
	* \param [in] pPath 图像保存的路径，指向文件夹
	* \param [in] cCmdType ，pParams 读取图像的参数
	*/
	  int _stdcall YI_FPD_SD_Start_Read(const char* sDeviceID, const char* pPath, 
		char cCmdType = 0x00, char* pParams = nullptr, ProgressCallbackFunc callBackFunc = nullptr);
	  int _stdcall YI_FPD_SD_Clean(const char* sDeviceID);
	  int _stdcall YI_FPD_SD_Stop_Read(const char* sDeviceID);

	  /********************************************************************************************************************
	  **********************************************控 制 盒 相 关 接 口*******************************************************
	  **********************************************************************************************************************/
	  /**
	  * \brief  控制盒初始化函数
	  * \outDeviceID 输出参数，为设备标识
	  */
	  int _stdcall YI_Initialize_ControlBox(
		  const char* comName, char outDeviceID[100]);

	  /**
	  * \brief 把平板探测器和控制盒关联起来
	  */
	  int _stdcall YI_Link_ControBox_To_FPD(const char* fpdDeviceID, const char* cbDeviceID);

	  /**
	  * \brief 设置控制盒在prep+ready模式下的延迟时间，此函数需要在“YI_Link_ControBox_To_FPD”执行成功以后调用
	  * \param [in] sDeviceID   平板探测器的设备标识
	  * \param [in] iDelayTime  延迟时间，单位是毫秒
	  */
	  int _stdcall YI_CB_Set_Prep_Delay_Time(const char* sDeviceID,int iDelayTime);

	
#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif