C# SDK Wrapper Silicon Software Runtime

Transcription

1 C# SDK Wrapper Silicon Software Runtime V Documentation

2 Imprint Silicon Software GmbH Steubenstraße Mannheim, Germany Tel.: +49 (0) Fax: +49 (0) Silicon Software GmbH. All rights reserved. Document Version: 1.0 Document Language: en (US) Last Change: March 2017 SiliconSoftware 2 C# SDK Wrapper

3 Contents 1 Introduction Overview Getting Started SDK Wrapping Type Mapping Function Mapping Call back C# Wrapper API List fgrab New defined functions string Fg_getErrorDescription (int ErrorNumber) int Fg_getParameterWith (Fg_Struct Fg, int Parameter, out Value, uint DmaIndex) int Fg_setParameterWith (Fg_Struct Fg, int Parameter, Value, uint DmaIndex) Functions with different arguments gbe Functions with reordered arguments clser Functions with reordered arguments siso_auxport Functions with reordered arguments New defined functions int SisoAuxPortGetPropertyWith (SisoAuxPort handle, string property, out value, uint size) int SisoAuxPortSetPropertyWith (SisoAuxPort handle, string property, value, uint size) siso_genicam SiliconSoftware 3 C# SDK Wrapper

4 3.5.1 Functions with reordered arguments SisoDisplay Functions with different arguments SisoIo.h Functions with reordered arguments Functions with different return data types SiliconSoftware 4 C# SDK Wrapper

5 1 Introduction 1.1 Overview C# SDK Wrapper wraps the SDK functionality into C# API. It is created such that all C SDK functions are wrapped as static functions in one C# class SiSoCsRt. The main usage and function declaration is defined mostly as described in the SDK documentation, the differences are detailed in this document. 1.2 Getting Started The C# SDK Wrapper consists of 2 files; SiSoCsInterface.dll and SiSoCsRt.dll. To get started using the wrapper: Add a reference to SiSoCsInterface.dll in your C# project. Use SiSoCsRt class to access the C# API within your code. Copy SiSoCsRt.dll to your PATH directory before running your program. SiliconSoftware 5 C# SDK Wrapper

6 2 SDK Wrapping 2.1 Type Mapping C data types are mapped to the corresponding C# data types as following: C Data Types C# Data Types int, int32_t int unsigned int, uint32_t uint int64_t long uint64_t, size_t ulong char * string Pointers are either mapped into arrays or ref/out arguments. In/Out function arguments are defined as ref, while the out function arguments are defined as out. For example, int clgetmanufacturerinfo(string manufacturername, ref uint buffersize, out uint version) buffersize is an in/out argument, while version is an out argument. C enums are directly translated into C# enums. C structs are mapped to C# classes, structs fields are either still directly accessible, or via constructors or setters/getters. Void pointers are mapped to different types according to their usage. In many cases, it is mapped to byte[]. 2.2 Function Mapping Each function of the SDK has a corresponding public static function in the class SiSoCsRt. SDK functions that creates a reference to a struct and returns an error code, are modified such that they return the reference directly (or null if an error occurred), and writes back the error code in an out argument. For example, the function Gbe_initBoard is defined as: SDK definition: int Gbe_initBoard(int board, int init_flag, struct BoardHandle** board_handle_ptr); SiliconSoftware 6 C# SDK Wrapper

7 Where the return value is the result error code, and board_handle_ptr is the created reference. C# definition: BoardHandle Gbe_initBoard(int board, int init_flag, out int Where the return value is the created reference, and result errorcode is the error code. 2.3 Call back Each callback function must have the signature of its corresponding delegate. SiSoCallback class includes all declarations of the available function delegates. For example, the following code is used to register an APC handler: FgApcControl apcctrl = new FgApcControl(10000, (uint)(fg_apc_flag.fg_apc_deliver_errors)); apcctrl.setapccallbackfunction(apccallback, null); The function apccallback must have the same signature as SiSoCallback.Fg_ApcFuncDelegate, an example implementation is: static int apccallback(uint imgnr, fg_apc_data userdata) { global_imgnr = (int)(imgnr); return 0; } The declaration of SiSoCallback.Fg_ApcFuncDelegate looks as follows, public delegate int Fg_ApcFuncDelegate(uint imgnr, fg_apc_data userdata); SiliconSoftware 7 C# SDK Wrapper

8 3 C# Wrapper API List Basically the API of the Wrapper is the same as that of the SDK. This chapter contains only the definitions of the functions that are renamed or have different order of arguments. For their usage, as well as for other functions, refer to the SDK documentation. 3.1 fgrab New defined functions string Fg_getErrorDescription (int ErrorNumber) This function replaces both of the following functions: const char *const Fg_getErrorDescription (Fg_Struct *Fg, int ErrorNumber) const char *const geterrordescription (int ErrorNumber) int Fg_getParameterWith (Fg_Struct Fg, int Parameter, out Value, uint DmaIndex) List of overloaded functions that are used to get frame grabber parameters with information of different types. They replace the SDK function Fg_getParameterWithType, according to the passed type as following: FgParamTypes FG_PARAM_TYPE_INT32_T FG_PARAM_TYPE_UINT32_T FG_PARAM_TYPE_INT64_T FG_PARAM_TYPE_UINT64_T FG_PARAM_TYPE_DOUBLE FG_PARAM_TYPE_CHAR_PTR FG_PARAM_TYPE_SIZE_T FG_PARAM_TYPE_STRUCT_- FIELDPARAMACCESS FG_PARAM_TYPE_STRUCT_- FIELDPARAMINT FG_PARAM_TYPE_STRUCT_- C# Wrapper function Fg_getParameterWithInt Fg_getParameterWithUInt Fg_getParameterWithLong Fg_getParameterWithULong Fg_getParameterWithDouble Fg_getParameterWithString Fg_getParameterWithUInt / Fg_getParameterWithULong Fg_getParameterWithIntArray / Fg_getParameterWithUIntArray / Fg_getParameterWithLongArray / Fg_getParameterWithULongArray Fg_getParameterWithFieldParameterInt Fg_getParameterWithFieldParameterDouble SiliconSoftware 8 C# SDK Wrapper

9 FIELDPARAMDOUBLE FG_PARAM_TYPE_COMPLEX_DATATYPE Not implemented int Fg_setParameterWith (Fg_Struct Fg, int Parameter, Value, uint DmaIndex) List of overloaded functions that are used to set frame grabber parameters with information of different types. They replace the SDK function Fg_setParameterWithType, according to the passed type as following: FgParamTypes FG_PARAM_TYPE_INT32_T FG_PARAM_TYPE_UINT32_T FG_PARAM_TYPE_INT64_T FG_PARAM_TYPE_UINT64_T FG_PARAM_TYPE_DOUBLE FG_PARAM_TYPE_CHAR_PTR FG_PARAM_TYPE_SIZE_T FG_PARAM_TYPE_STRUCT_- FIELDPARAMACCESS FG_PARAM_TYPE_STRUCT_- FIELDPARAMINT FG_PARAM_TYPE_STRUCT_- FIELDPARAMDOUBLE FG_PARAM_TYPE_COMPLEX_DATATYPE C# Wrapper function Fg_setParameterWithInt Fg_setParameterWithUInt Fg_setParameterWithLong Fg_setParameterWithULong Fg_setParameterWithDouble Fg_setParameterWithString Fg_setParameterWithUInt / Fg_setParameterWithULong Fg_setParameterWithIntArray / Fg_setParameterWithUIntArray / Fg_setParameterWithLongArray / Fg_setParameterWithULongArray Fg_setParameterWithFieldParameterInt Fg_setParameterWithFieldParameterDouble Not implemented Functions with different arguments C# SDK Wrapper SDK SisoImage Fg_getImagePtr(Fg_Struct Fg, int PicNr, uint DmaIndex) SisoImage Fg_getImagePtrEx(Fg_Struct Fg, int PicNr, uint DmaIndex, dma_mem pmem) void *Fg_getImagePtr(Fg_Struct *Fg, const frameindex_t PicNr, const unsigned int DmaIndex) void *Fg_getImagePtrEx(Fg_Struct *Fg, const frameindex_t PicNr, const unsigned int DmaIndex, dma_mem *pmem) In Fg_getImagePtr and Fg_getImagePtrEx function, the return type is changed from void pointer, which directly represents the image bytes, in the SDK into SisoImage instance. SiliconSoftware 9 C# SDK Wrapper

10 To get again the byte array from SisoImage, the function SisoImage.toByteArray(uint imagesize) can be called. Additionally, it can be used directly with DrawBuffer function. 3.2 gbe Functions with reordered arguments In the following functions, the error code is written into out int errorcode instead of being returned from the function. While the created handle/string is returned from the function instead of being passed as an argument. If an error occurred, errorcode will have a value other than 0, and the return value will be null. C# SDK Wrapper SDK BoardHandle Gbe_initBoard(int board, int init_flag, out int CameraHandle Gbe_getFirstCamera(BoardHandle board_handle, int port, out int CameraHandle Gbe_getCameraByIndex(BoardHandle board_handle, int port, uint index, out int CameraHandle Gbe_getCameraByMac(BoardHandle board_handle, int port, byte[] mac, out int CameraHandle Gbe_getCameraByIp(BoardHandle board_handle, int port, uint ip, out int CameraHandle Gbe_getCameraByUserName(BoardHandle board_handle, int port, string int Gbe_initBoard(int board, int init_flag, struct BoardHandle** board_handle_ptr) int Gbe_getFirstCamera(struct BoardHandle *board_handle, int port, struct CameraHandle **camera_handle_ptr) int Gbe_getCameraByIndex(struct BoardHandle *board_handle, int port, unsigned int index, struct CameraHandle **camera_handle_ptr); int Gbe_getCameraByMac(struct BoardHandle *board_handle, int port, uint8_t mac[6], struct CameraHandle **camera_handle_ptr) int Gbe_getCameraByIp(struct BoardHandle *board_handle, int port, uint32_t ip, struct CameraHandle **camera_handle_ptr) int Gbe_getCameraByUserName(struct BoardHandle *board_handle, int port, char* user_name, struct CameraHandle SiliconSoftware 10 C# SDK Wrapper

11 user_name, out int string Gbe_getStringValue(CameraHandle camera_handle, string name, out int string Gbe_getEnumerationValue(CameraHandle camera_handle, string name, out int **camera_handle_ptr) int Gbe_getStringValue(struct CameraHandle *camera_handle, const char* name, const char** value_ptr) int Gbe_setEnumerationValue(struct CameraHandle *camera_handle, const char* name, const char* value) 3.3 clser Functions with reordered arguments In the following function, the error code is written into out int errorcode instead of being returned from the function. While the created handle is returned from the function instead of being passed as an argument. If an error occurred, errorcode will have a value other than 0, and the return value will be null. C# SDK Wrapper SDK CLSerialRef clserialinit(uint serialindex, out int int clserialinit(unsigned int serialindex, void **serialrefptr) 3.4 siso_auxport Functions with reordered arguments In the following function, the error code is written into out int errorcode instead of being returned from the function. While the created handle is returned from the function instead of being passed as an argument. If an error occurred, errorcode will have a value other than 0, and the return value will be null. C# SDK Wrapper SDK SisoAuxPort SisoAuxPortInit(uint board_id, uint port_num, SisoAuxPortType_Enum type, out int int SisoAuxPortInit(unsigned int board_id, unsigned int port_num, SisoAuxPortType type, SisoAuxPort * handle_ptr) SiliconSoftware 11 C# SDK Wrapper

12 3.4.2 New defined functions int SisoAuxPortGetPropertyWith (SisoAuxPort handle, string property, out value, uint size) List of overloaded functions that are used to get port properties with information of different types. They are replacing the SDK function SisoAuxPortGetProperty, according to the passed type as following: C# Wrapper function SisoAuxPortPropertyType_Enum SisoAuxPortGetPropertyWithInt SISO_AUX_PORT_PROPERTY_TYPE_INT SisoAuxPortGetPropertyWithFloat SISO_AUX_PORT_PROPERTY_TYPE_FLOAT SisoAuxPortGetPropertyWithString SISO_AUX_PORT_PROPERTY_TYPE_STRING SisoAuxPortGetPropertyWithByteArray SISO_AUX_PORT_PROPERTY_TYPE_BINARY int SisoAuxPortSetPropertyWith (SisoAuxPort handle, string property, value, uint size) List of overloaded functions that are used to set port properties with information of different types. They are replacing the SDK function SisoAuxPortSetProperty, according to the passed type as following: C# Wrapper function SisoAuxPortPropertyType_Enum SisoAuxPortSetPropertyWithInt SISO_AUX_PORT_PROPERTY_TYPE_INT SisoAuxPortSetPropertyWithFloat SISO_AUX_PORT_PROPERTY_TYPE_FLOAT SisoAuxPortSetPropertyWithString SISO_AUX_PORT_PROPERTY_TYPE_STRING SisoAuxPortSetPropertyWithByteArray SISO_AUX_PORT_PROPERTY_TYPE_BINARY 3.5 siso_genicam Functions with reordered arguments In the following functions, the error code is written into out int errorcode instead of being returned from the function. While the created handle is returned from the function instead of being passed as an argument. If an error occurred, errorcode will have a value other than 0, and the return value will be null. C# SDK Wrapper SDK SgcBoardHandle Sgc_initBoard(Fg_Struct int Sgc_initBoard(Fg_Struct* fg, int SiliconSoftware 12 C# SDK Wrapper

13 fg, int initflag, out int SgcBoardHandle Sgc_initBoardEx(Fg_Struct fg, uint initflag, uint portmask, uint slavemode, out int SgcCameraHandle Sgc_getCamera(SgcBoardHandle boardhandle, uint port, out int SgcCameraHandle Sgc_getCameraByIndex(SgcBoardHandle boardhandle, uint index, out int SgcConnectionProfile Sgc_LoadConnectionProfile(Fg_Struct fg, string boardconfigurationfilepath, out int string Sgc_getStringValue(SgcCameraHandle camerahandle, string name, out int string Sgc_getEnumerationValueAsString(SgcCamer ahandle camerahandle, string name, out int initflag, SgcBoardHandle** boardhandle) int Sgc_initBoardEx(Fg_Struct* fg, unsigned int initflag, SgcBoardHandle** boardhandle, unsigned int portmask, unsigned int slavemode) int Sgc_getCamera(SgcBoardHandle* boardhandle, const unsigned int port, SgcCameraHandle** camerahandle) int Sgc_getCameraByIndex(SgcBoardHandle* boardhandle, const unsigned int index, SgcCameraHandle** camerahandle) int Sgc_LoadConnectionProfile(Fg_Struct* fg, const char* boardconfigurationfilepath, SgcConnectionProfile** connectionprofileptr) int Sgc_getStringValue(SgcCameraHandle* camerahandle, const char* name, const char** valueptr) int Sgc_getEnumerationValueAsString(SgcCa merahandle* camerahandle, const char* name, const char** valueptr) 3.6 SisoDisplay Functions with different arguments C# SDK Wrapper SDK void DrawBuffer(int nid, SisoImage ulpbuf, int nnr, string cpstr) void DrawBuffer(int nid, const void *ulpbuf, const int nnr, const char *cpstr) SiliconSoftware 13 C# SDK Wrapper

14 In DrawBuffer function, the ulpbuf argument type is changed from void pointer, which directly represents the image bytes, in the SDK into SisoImage instance. SisoImage is created using Fg_getImagePtr and Fg_getImagePtrEx functions. Additionally, SisoImage can be created from byte array using the following constructor: SisoImage(global::System.IntPtr imageptr, uint pixelcount) 3.7 SisoIo.h Functions with reordered arguments In the following functions, the error code is written into out int errorcode instead of being returned from the function. While the created handle is returned from the function instead of being passed as an argument. If an error occurred, errorcode will have a value other than 0, and the return value will be null. C# SDK Wrapper SDK AviRef IoCreateAVIGray(string filename, int width, int height, double fps, out int AviRef IoCreateAVIGrayW(string filename, int width, int height, double fps, out int AviRef IoCreateAVIColor(string filename, int width, int height, double fps, out int AviRef IoCreateAVIColorW(string filename, int width, int height, double fps, out int AviRef IoOpenAVI(string filename, out int width, out int height, out int bitdepth, out int SeqRef IoCreateSeq(string pfilename, int width, int height, int bitdepth, int format, out int SeqRef IoOpenSeq(string pfilename, out int IoCreateAVIGray(void **AviRef, const char *filename, int width, int height, double fps) int IoCreateAVIGrayW(void **AviRef, const LPCWSTR filename, int width, int height, double fps) int IoCreateAVIColor(void **AviRef, const char *filename, int width, int height, double fps) int IoCreateAVIColorW(void **AviRef, const LPCWSTR filename, int width, int height, double fps) int IoOpenAVI(void **AviRef, const char *filename, int *width, int *height, int *bitdepth) int IoCreateSeq(void **SeqRef, const char *pfilename, int width, int height, int bitdepth, int format) int IoOpenSeq(void **SeqRef, const SiliconSoftware 14 C# SDK Wrapper

15 int width, out int height, out int bitdepth, int mode, out int SisoIoImageEngine IoImageOpen(string filename, out int SisoIoImageEngine IoImageOpenEx(string filename, int RGBSequence, out int char *pfilename, int* width, int* height, int* bitdepth, int mode) int IoImageOpen(const char *filename, SisoIoImageEngine **handle) int IoImageOpenEx(const char *filename, SisoIoImageEngine **handle, int RGBSequence) SiliconSoftware 15 C# SDK Wrapper

16 3.7.2 Functions with different return data types In the following functions, the return type is changed from void pointer, which directly represents the image bytes in the SDK, into SisoImage instance. To get again the byte array from SisoImage, the function SisoImage.toByteArray(uint imagesize) can be called. C# SDK Wrapper SDK SisoImage IoReadTiff(string filename, byte[] data, out int width, out int height, out int bitpersample, out int sampleperpixel) SisoImage IoReadTiffW(string filename, byte[] data, out int width, out int height, out int bitpersample, out int sampleperpixel) SisoImage IoReadTiffEx(string filename, byte[] data, out int width, out int height, out int bitpersample, out int sampleperpixel, int RGBSequence) SisoImage IoReadTiffExW(string filename, byte[] data, out int width, out int height, out int bitpersample, out int sampleperpixel, int RGBSequence) SisoImage IoReadBmp(string filename, byte[] data, out int width, out int height, out int bits) void *IoReadTiff(const char *filename, unsigned char**data, int *width, int *height, int *bitpersample, int *sampleperpixel) void *IoReadTiffW(const LPCWSTR filename, unsigned char**data, int *width, int *height, int *bitpersample, int *sampleperpixel) void *IoReadTiffEx(const char *filename, unsigned char**data, int *width, int *height, int *bitpersample, int *sampleperpixel, int RGBSequence) void *IoReadTiffExW(const LPCWSTR filename, unsigned char**data, int *width, int *height, int *bitpersample, int *sampleperpixel, int RGBSequence) void *IoReadBmp(const char *filename,unsigned char **data,int *width,int *height,int *bits) SiliconSoftware 16 C# SDK Wrapper

17 Contact Details SiliconSoftware GmbH Steubenstrasse 46 D Mannheim, Germany Phone: +49(0) Fax: +49(0) info@silicon.software Web: SiliconSoftware Inc. 1 Tara Boulevard, Suite 200 Nashua, NH 03062, USA Phone: Fax: info@silicon.software Web: Disclaimer While every precaution has been taken in the preparation of this manual, Silicon Software GmbH assumes no responsibility for errors or omissions. Silicon Software GmbH reserves the right to change the specification of the product described within this manual and the manual itself at any time without notice and without obligation of Silicon Software GmbH to notify any person of such revisions or changes. Trademarks All trademarks and registered trademarks are the property of their respective owners. Copyright Note Copyright 2017 Silicon Software GmbH. All rights reserved. This document may not in whole or in part, be reproduced, transmitted, transcribed, stored in any electronic medium or machine readable form, or translated into any language or computer language without the prior written consent of Silicon Software GmbH. SiliconSoftware 17 C# SDK Wrapper