MI IQSERVER API

1. SUMMARY¶

1.1. Module Description¶

IQSERVER (Image Quality tuning Server) is used for data transport between tuning tool (IQ Tool) and EVB, including ISP parameter setting, image capture and file upload/download.

1.2. Flow Chart¶

1.3. Keyword¶

• ISP

  Image Signal Processing, used for image noise reduction, color rendering, brightness adjustment, and other functions.

• VPE

  Video Process Engine, used for processing image quality.

• VENC

  Video Encoder, used for encoding YUV stream to H264/H265/Jpeg format bit-stream.

2. API LIST¶

This function module provides the following APIs.

2.1. MI_IQSERVER_Open¶

• Function

  Call this interface to open IQ server.

• Syntax

  MI_S32 MI_IQSERVER_Open(MI_U16 width, MI_U16 height, MI_S32 vpeChn);
  

• Form parameter

  Parameter Name	Description	Input/Output
  width	Sensor width	Input
  height	Sensor height	Input
  vpeChn	VPE channel number	Input

• Return Value

  • MI_IQSERVER_OK: Successful

  • Others: Failed, see error code for details.

• Dependency

  • Head file: mi_iqserver.h

  • Others: libmi_iqserver.a

• Note

  • An IQ server is created based on the VPE number. The IQ server now only supports one instance.

  • When width and height are 0, IQ server will query the sensor resolution.

• Example

  /*declaration*/
  
  MI_S32 s32Ret = 0;
  
  /* open IQSERVER*/
  
  s32Ret = MI_IQSERVER_Open(1920, 1080, 0);
  
  if (MI_IQSERVER_OK != s32Ret)
  
  {
  
      Printf(“open iqserver error:%x\n”, s32Ret);
  
      return s32Ret;
  
  }
  

• Related APIs

  MI_IQSERVER_Close

2.2. MI_IQSERVER_Close¶

• Function

  Call this interface to close IQ server.

• Syntax

  MI_ S32 MI_IQSERVER_Close();
  

• Return Value

  • MI_IQSERVER_OK: Successful.

  • Others: Failed, see error code for details.

• Dependency

  • Head file: mi_iqserver.h

  • Library file: libmi_iqserver.a

• Note

  The number of calls for MI_IQSERVER_Open and MI_IQSERVER_Close must correspond.

• Example

  /*declaration*/
  
  MI_S32 s32Ret = 0;
  
  /* close IQSERVER*/
  
  s32Ret = MI_IQSERVER_Close();
  
  if (MI_IQSERVER_OK != s32Ret)
  
  {
  
      Printf(“close iqserver error:%x\n”, s32Ret);
  
      return s32Ret;
  
  }
  

• Related APIs

  MI_IQSERVER_Open

2.3. MI_IQSERVER_SetDataPath¶

• Function

  Set IQ server data path.

• Syntax

  MI_S32 MI_IQSERVER_SetDataPath(char* path);
  

• Form parameter

  Parameter Name	Description	Input/Output
  path	Path of IQ server data, ending with \0.	Input

• Return Value

  • MI_IQSERVER_OK: Successful.

  • Others: Failed, see error code for details.

• Dependency

  • Head file: mi_iqserver.h

  • Library file: libmi_iqserver.a

• Note

  • You can call this API before MI_IQSERVER_Open.

  • Before calling this API, make sure that the path is accessible and that the data needed by the IQ server is available.

  • Normally, the data needed by the IQ server include isp_api.xml (for use by IQ Tool).

• Example

  /*declaration*/
  
  MI_S32 s32Ret = 0;
  
  char *data_path = “/customer/iqconfig/”;
  
  /* set IQSERVER data path*/
  
  s32Ret = MI_IQSERVER_SetDataPath(data_path);
  
  if (MI_IQSERVER_OK != s32Ret)
  
  {
  
      Printf(“set iqserver data path error:%x\n”, s32Ret);
  
      return s32Ret;
  
  }
  

2.4. MI_IQSERVER_SetCustFunc¶

• Function

  Set user-specified execute function, for IQ server to call it.

• Syntax

  MI_S32 MI_IQSERVER_SetCustFunc(MI_S32(*func)(MI_U16 data_type,
  MI_U32 length, MI_U8 *data));
  

• Form parameter

  Parameter Name	Description	Input/Output
  func	Execute function	Input

• Return Value

  • MI_IQSERVER_OK: Successful.

  • Others: Failed, see error code for details.

• Dependency

  • Head file: mi_iqserver.h

  • Library file: libmi_iqserver.a

• Note

  • Before using this API, define the function with the parameters below:

    1. datatype: type of data, user defined, to distinguish different data.

    2. length: length of data, IQ tool will auto set the value.

    3. data: data address.

    You can do some processing in func with these parameters.

  • By this API, you can add user-defined execute function in IQ server. IQ server will get the data from IQ tool, then call the user-defined function. After that, func will get the data, to implement custom features.

    For example:

    1. Use IQ tool to write firmware, then IQ server calls func to flash firmware.

    2. Use IQ tool to set IR cut, then IQ server calls func to switch IR.

  • Before calling this function, make sure func is executable.

  • Data_type and data come from IQ tool, and length means data length.

  • Data_type can be used to distinguish what function the data is used for. You can define different function for different data.

• Example

  /*declaration*/
  
  MI_S32 s32Ret = 0;
  
  MI_S32 sample_func(MI_U16 data_type, MI_U32 length, MI_U8 *data)
  
  {
  
      printf("call MI_IQSERVER_SetCustFunc() success\n");
  
      printf(“data_type is %d, length:%u, data addr:%p\n”, data_type, length, data);
      //do something
  
      return MI_IQSERVER_OK;
  
  }
  
  /* set IQSERVER custom function*/
  
  s32Ret = MI_IQSERVER_SetCustFunc(sample_func);
  
  if (MI_IQSERVER_OK != s32Ret)
  
  {
  
      Printf(“set iqserver cust func error:%x\n”, s32Ret);
  
      return s32Ret;
  
  }
  

3. ERROR CODE¶

The IQSERVER API error code is as follows: